From 335515d3318eef4115f94f1f6f05ec995f2b2260 Mon Sep 17 00:00:00 2001 From: Caleb Fontenot Date: Mon, 15 Jul 2019 09:16:41 -0700 Subject: [PATCH] add files --- Fwd: programming project.eml | 321 + madlibs.py | 83 + python multiplier.py | 4 + python-3.7.4-docs-html/.buildinfo | 4 + .../tzinfo_examples.py | 175 + .../_images/hashlib-blake2-tree.png | Bin 0 -> 11148 bytes .../_images/logging_flow.png | Bin 0 -> 49648 bytes .../_images/pathlib-inheritance.png | Bin 0 -> 6431 bytes .../_images/turtle-star.png | Bin 0 -> 39585 bytes .../_images/win_installer.png | Bin 0 -> 48994 bytes python-3.7.4-docs-html/_sources/about.rst.txt | 39 + python-3.7.4-docs-html/_sources/bugs.rst.txt | 92 + .../_sources/c-api/abstract.rst.txt | 26 + .../_sources/c-api/allocation.rst.txt | 71 + .../_sources/c-api/apiabiversion.rst.txt | 39 + .../_sources/c-api/arg.rst.txt | 676 + .../_sources/c-api/bool.rst.txt | 46 + .../_sources/c-api/buffer.rst.txt | 508 + .../_sources/c-api/bytearray.rst.txt | 87 + .../_sources/c-api/bytes.rst.txt | 205 + .../_sources/c-api/capsule.rst.txt | 157 + .../_sources/c-api/cell.rst.txt | 62 + .../_sources/c-api/code.rst.txt | 48 + .../_sources/c-api/codec.rst.txt | 123 + .../_sources/c-api/complex.rst.txt | 132 + .../_sources/c-api/concrete.rst.txt | 117 + .../_sources/c-api/contextvars.rst.txt | 144 + .../_sources/c-api/conversion.rst.txt | 131 + .../_sources/c-api/coro.rst.txt | 34 + .../_sources/c-api/datetime.rst.txt | 249 + .../_sources/c-api/descriptor.rst.txt | 40 + .../_sources/c-api/dict.rst.txt | 240 + .../_sources/c-api/exceptions.rst.txt | 1032 + .../_sources/c-api/file.rst.txt | 76 + .../_sources/c-api/float.rst.txt | 79 + .../_sources/c-api/function.rst.txt | 108 + .../_sources/c-api/gcsupport.rst.txt | 159 + .../_sources/c-api/gen.rst.txt | 44 + .../_sources/c-api/import.rst.txt | 317 + .../_sources/c-api/index.rst.txt | 26 + .../_sources/c-api/init.rst.txt | 1576 + .../_sources/c-api/intro.rst.txt | 725 + .../_sources/c-api/iter.rst.txt | 46 + .../_sources/c-api/iterator.rst.txt | 50 + .../_sources/c-api/list.rst.txt | 151 + .../_sources/c-api/long.rst.txt | 297 + .../_sources/c-api/mapping.rst.txt | 103 + .../_sources/c-api/marshal.rst.txt | 94 + .../_sources/c-api/memory.rst.txt | 604 + .../_sources/c-api/memoryview.rst.txt | 63 + .../_sources/c-api/method.rst.txt | 100 + .../_sources/c-api/module.rst.txt | 479 + .../_sources/c-api/none.rst.txt | 26 + .../_sources/c-api/number.rst.txt | 283 + .../_sources/c-api/objbuffer.rst.txt | 55 + .../_sources/c-api/object.rst.txt | 451 + .../_sources/c-api/objimpl.rst.txt | 17 + .../_sources/c-api/refcounting.rst.txt | 73 + .../_sources/c-api/reflection.rst.txt | 49 + .../_sources/c-api/sequence.rst.txt | 169 + .../_sources/c-api/set.rst.txt | 166 + .../_sources/c-api/slice.rst.txt | 122 + .../_sources/c-api/stable.rst.txt | 38 + .../_sources/c-api/structures.rst.txt | 376 + .../_sources/c-api/sys.rst.txt | 329 + .../_sources/c-api/tuple.rst.txt | 218 + .../_sources/c-api/type.rst.txt | 118 + .../_sources/c-api/typeobj.rst.txt | 1418 + .../_sources/c-api/unicode.rst.txt | 1726 + .../_sources/c-api/utilities.rst.txt | 21 + .../_sources/c-api/veryhigh.rst.txt | 394 + .../_sources/c-api/weakref.rst.txt | 69 + .../_sources/contents.rst.txt | 31 + .../_sources/copyright.rst.txt | 19 + .../_sources/distributing/index.rst.txt | 176 + .../_sources/distutils/apiref.rst.txt | 2031 ++ .../_sources/distutils/builtdist.rst.txt | 459 + .../_sources/distutils/commandref.rst.txt | 104 + .../_sources/distutils/configfile.rst.txt | 142 + .../_sources/distutils/examples.rst.txt | 338 + .../_sources/distutils/extending.rst.txt | 96 + .../_sources/distutils/index.rst.txt | 40 + .../_sources/distutils/introduction.rst.txt | 212 + .../_sources/distutils/packageindex.rst.txt | 16 + .../_sources/distutils/setupscript.rst.txt | 711 + .../_sources/distutils/sourcedist.rst.txt | 240 + .../_sources/distutils/uploading.rst.txt | 8 + .../_sources/extending/building.rst.txt | 167 + .../_sources/extending/embedding.rst.txt | 336 + .../_sources/extending/extending.rst.txt | 1365 + .../_sources/extending/index.rst.txt | 74 + .../_sources/extending/newtypes.rst.txt | 619 + .../extending/newtypes_tutorial.rst.txt | 897 + .../_sources/extending/windows.rst.txt | 137 + .../_sources/faq/design.rst.txt | 808 + .../_sources/faq/extending.rst.txt | 447 + .../_sources/faq/general.rst.txt | 446 + .../_sources/faq/gui.rst.txt | 159 + .../_sources/faq/index.rst.txt | 17 + .../_sources/faq/installed.rst.txt | 53 + .../_sources/faq/library.rst.txt | 839 + .../_sources/faq/programming.rst.txt | 1903 + .../_sources/faq/windows.rst.txt | 284 + .../_sources/glossary.rst.txt | 1146 + .../_sources/howto/argparse.rst.txt | 765 + .../_sources/howto/clinic.rst.txt | 1734 + .../_sources/howto/cporting.rst.txt | 257 + .../_sources/howto/curses.rst.txt | 552 + .../_sources/howto/descriptor.rst.txt | 443 + .../_sources/howto/functional.rst.txt | 1262 + .../_sources/howto/index.rst.txt | 32 + .../_sources/howto/instrumentation.rst.txt | 427 + .../_sources/howto/ipaddress.rst.txt | 340 + .../_sources/howto/logging-cookbook.rst.txt | 2551 ++ .../_sources/howto/logging.rst.txt | 1103 + .../_sources/howto/pyporting.rst.txt | 452 + .../_sources/howto/regex.rst.txt | 1386 + .../_sources/howto/sockets.rst.txt | 383 + .../_sources/howto/sorting.rst.txt | 293 + .../_sources/howto/unicode.rst.txt | 763 + .../_sources/howto/urllib2.rst.txt | 605 + .../_sources/install/index.rst.txt | 1117 + .../_sources/installing/index.rst.txt | 246 + .../_sources/library/2to3.rst.txt | 474 + .../_sources/library/__future__.rst.txt | 103 + .../_sources/library/__main__.rst.txt | 25 + .../_sources/library/_dummy_thread.rst.txt | 22 + .../_sources/library/_thread.rst.txt | 193 + .../_sources/library/abc.rst.txt | 342 + .../_sources/library/aifc.rst.txt | 239 + .../_sources/library/allos.rst.txt | 29 + .../_sources/library/archiving.rst.txt | 20 + .../_sources/library/argparse.rst.txt | 2089 ++ .../_sources/library/array.rst.txt | 278 + .../_sources/library/ast.rst.txt | 274 + .../_sources/library/asynchat.rst.txt | 213 + .../library/asyncio-api-index.rst.txt | 218 + .../_sources/library/asyncio-dev.rst.txt | 237 + .../library/asyncio-eventloop.rst.txt | 1625 + .../library/asyncio-exceptions.rst.txt | 91 + .../_sources/library/asyncio-future.rst.txt | 250 + .../library/asyncio-llapi-index.rst.txt | 510 + .../library/asyncio-platforms.rst.txt | 106 + .../_sources/library/asyncio-policy.rst.txt | 221 + .../_sources/library/asyncio-protocol.rst.txt | 1041 + .../_sources/library/asyncio-queue.rst.txt | 200 + .../_sources/library/asyncio-stream.rst.txt | 470 + .../library/asyncio-subprocess.rst.txt | 356 + .../_sources/library/asyncio-sync.rst.txt | 332 + .../_sources/library/asyncio-task.rst.txt | 908 + .../_sources/library/asyncio.rst.txt | 93 + .../_sources/library/asyncore.rst.txt | 360 + .../_sources/library/atexit.rst.txt | 112 + .../_sources/library/audioop.rst.txt | 282 + .../_sources/library/base64.rst.txt | 290 + .../_sources/library/bdb.rst.txt | 372 + .../_sources/library/binary.rst.txt | 23 + .../_sources/library/binascii.rst.txt | 194 + .../_sources/library/binhex.rst.txt | 57 + .../_sources/library/bisect.rst.txt | 149 + .../_sources/library/builtins.rst.txt | 42 + .../_sources/library/bz2.rst.txt | 326 + .../_sources/library/calendar.rst.txt | 420 + .../_sources/library/cgi.rst.txt | 545 + .../_sources/library/cgitb.rst.txt | 84 + .../_sources/library/chunk.rst.txt | 137 + .../_sources/library/cmath.rst.txt | 316 + .../_sources/library/cmd.rst.txt | 381 + .../_sources/library/code.rst.txt | 184 + .../_sources/library/codecs.rst.txt | 1502 + .../_sources/library/codeop.rst.txt | 72 + .../_sources/library/collections.abc.rst.txt | 306 + .../_sources/library/collections.rst.txt | 1251 + .../_sources/library/colorsys.rst.txt | 65 + .../_sources/library/compileall.rst.txt | 267 + .../_sources/library/concurrency.rst.txt | 31 + .../library/concurrent.futures.rst.txt | 494 + .../_sources/library/concurrent.rst.txt | 6 + .../_sources/library/configparser.rst.txt | 1314 + .../_sources/library/constants.rst.txt | 100 + .../_sources/library/contextlib.rst.txt | 872 + .../_sources/library/contextvars.rst.txt | 281 + .../_sources/library/copy.rst.txt | 95 + .../_sources/library/copyreg.rst.txt | 65 + .../_sources/library/crypt.rst.txt | 173 + .../_sources/library/crypto.rst.txt | 19 + .../_sources/library/csv.rst.txt | 550 + .../_sources/library/ctypes.rst.txt | 2486 ++ .../_sources/library/curses.ascii.rst.txt | 229 + .../_sources/library/curses.panel.rst.txt | 120 + .../_sources/library/curses.rst.txt | 1835 + .../_sources/library/custominterp.rst.txt | 19 + .../_sources/library/dataclasses.rst.txt | 593 + .../_sources/library/datatypes.rst.txt | 33 + .../_sources/library/datetime.rst.txt | 2285 ++ .../_sources/library/dbm.rst.txt | 375 + .../_sources/library/debug.rst.txt | 18 + .../_sources/library/decimal.rst.txt | 2137 ++ .../_sources/library/development.rst.txt | 29 + .../_sources/library/difflib.rst.txt | 746 + .../_sources/library/dis.rst.txt | 1265 + .../_sources/library/distribution.rst.txt | 15 + .../_sources/library/distutils.rst.txt | 44 + .../_sources/library/doctest.rst.txt | 1868 + .../_sources/library/dummy_threading.rst.txt | 20 + .../_sources/library/email.charset.rst.txt | 247 + .../library/email.compat32-message.rst.txt | 759 + .../library/email.contentmanager.rst.txt | 198 + .../_sources/library/email.encoders.rst.txt | 75 + .../_sources/library/email.errors.rst.txt | 114 + .../_sources/library/email.examples.rst.txt | 67 + .../_sources/library/email.generator.rst.txt | 279 + .../_sources/library/email.header.rst.txt | 205 + .../library/email.headerregistry.rst.txt | 455 + .../_sources/library/email.iterators.rst.txt | 83 + .../_sources/library/email.message.rst.txt | 751 + .../_sources/library/email.mime.rst.txt | 259 + .../_sources/library/email.parser.rst.txt | 320 + .../_sources/library/email.policy.rst.txt | 651 + .../_sources/library/email.rst.txt | 152 + .../_sources/library/email.utils.rst.txt | 218 + .../_sources/library/ensurepip.rst.txt | 133 + .../_sources/library/enum.rst.txt | 1124 + .../_sources/library/errno.rst.txt | 639 + .../_sources/library/exceptions.rst.txt | 748 + .../_sources/library/faulthandler.rst.txt | 172 + .../_sources/library/fcntl.rst.txt | 170 + .../_sources/library/filecmp.rst.txt | 198 + .../_sources/library/fileformats.rst.txt | 17 + .../_sources/library/fileinput.rst.txt | 208 + .../_sources/library/filesys.rst.txt | 39 + .../_sources/library/fnmatch.rst.txt | 102 + .../_sources/library/formatter.rst.txt | 351 + .../_sources/library/fractions.rst.txt | 183 + .../_sources/library/frameworks.rst.txt | 18 + .../_sources/library/ftplib.rst.txt | 442 + .../_sources/library/functional.rst.txt | 15 + .../_sources/library/functions.rst.txt | 1729 + .../_sources/library/functools.rst.txt | 505 + .../_sources/library/gc.rst.txt | 297 + .../_sources/library/getopt.rst.txt | 164 + .../_sources/library/getpass.rst.txt | 51 + .../_sources/library/gettext.rst.txt | 660 + .../_sources/library/glob.rst.txt | 111 + .../_sources/library/grp.rst.txt | 68 + .../_sources/library/gzip.rst.txt | 213 + .../_sources/library/hashlib.rst.txt | 739 + .../_sources/library/heapq.rst.txt | 322 + .../_sources/library/hmac.rst.txt | 138 + .../_sources/library/html.entities.rst.txt | 47 + .../_sources/library/html.parser.rst.txt | 340 + .../_sources/library/html.rst.txt | 39 + .../_sources/library/http.client.rst.txt | 571 + .../_sources/library/http.cookiejar.rst.txt | 760 + .../_sources/library/http.cookies.rst.txt | 286 + .../_sources/library/http.rst.txt | 128 + .../_sources/library/http.server.rst.txt | 472 + .../_sources/library/i18n.rst.txt | 18 + .../_sources/library/idle.rst.txt | 901 + .../_sources/library/imaplib.rst.txt | 609 + .../_sources/library/imghdr.rst.txt | 81 + .../_sources/library/imp.rst.txt | 412 + .../_sources/library/importlib.rst.txt | 1747 + .../_sources/library/index.rst.txt | 79 + .../_sources/library/inspect.rst.txt | 1385 + .../_sources/library/internet.rst.txt | 48 + .../_sources/library/intro.rst.txt | 62 + .../_sources/library/io.rst.txt | 1049 + .../_sources/library/ipaddress.rst.txt | 920 + .../_sources/library/ipc.rst.txt | 28 + .../_sources/library/itertools.rst.txt | 904 + .../_sources/library/json.rst.txt | 731 + .../_sources/library/keyword.rst.txt | 23 + .../_sources/library/language.rst.txt | 28 + .../_sources/library/linecache.rst.txt | 64 + .../_sources/library/locale.rst.txt | 588 + .../_sources/library/logging.config.rst.txt | 818 + .../_sources/library/logging.handlers.rst.txt | 1108 + .../_sources/library/logging.rst.txt | 1280 + .../_sources/library/lzma.rst.txt | 434 + .../_sources/library/macpath.rst.txt | 21 + .../_sources/library/mailbox.rst.txt | 1593 + .../_sources/library/mailcap.rst.txt | 76 + .../_sources/library/markup.rst.txt | 27 + .../_sources/library/marshal.rst.txt | 118 + .../_sources/library/math.rst.txt | 507 + .../_sources/library/mimetypes.rst.txt | 269 + .../_sources/library/misc.rst.txt | 13 + .../_sources/library/mm.rst.txt | 22 + .../_sources/library/mmap.rst.txt | 290 + .../_sources/library/modulefinder.rst.txt | 114 + .../_sources/library/modules.rst.txt | 19 + .../_sources/library/msilib.rst.txt | 563 + .../_sources/library/msvcrt.rst.txt | 154 + .../_sources/library/multiprocessing.rst.txt | 2862 ++ .../_sources/library/netdata.rst.txt | 23 + .../_sources/library/netrc.rst.txt | 90 + .../_sources/library/nis.rst.txt | 65 + .../_sources/library/nntplib.rst.txt | 567 + .../_sources/library/numbers.rst.txt | 223 + .../_sources/library/numeric.rst.txt | 26 + .../_sources/library/operator.rst.txt | 557 + .../_sources/library/optparse.rst.txt | 2037 ++ .../_sources/library/os.path.rst.txt | 462 + .../_sources/library/os.rst.txt | 4197 +++ .../_sources/library/ossaudiodev.rst.txt | 448 + .../_sources/library/othergui.rst.txt | 56 + .../_sources/library/parser.rst.txt | 356 + .../_sources/library/pathlib.rst.txt | 1114 + .../_sources/library/pdb.rst.txt | 536 + .../_sources/library/persistence.rst.txt | 23 + .../_sources/library/pickle.rst.txt | 937 + .../_sources/library/pickletools.rst.txt | 110 + .../_sources/library/pipes.rst.txt | 95 + .../_sources/library/pkgutil.rst.txt | 229 + .../_sources/library/platform.rst.txt | 284 + .../_sources/library/plistlib.rst.txt | 226 + .../_sources/library/poplib.rst.txt | 255 + .../_sources/library/posix.rst.txt | 92 + .../_sources/library/pprint.rst.txt | 374 + .../_sources/library/profile.rst.txt | 669 + .../_sources/library/pty.rst.txt | 114 + .../_sources/library/pwd.rst.txt | 76 + .../_sources/library/py_compile.rst.txt | 138 + .../_sources/library/pyclbr.rst.txt | 153 + .../_sources/library/pydoc.rst.txt | 109 + .../_sources/library/pyexpat.rst.txt | 876 + .../_sources/library/python.rst.txt | 27 + .../_sources/library/queue.rst.txt | 285 + .../_sources/library/quopri.rst.txt | 63 + .../_sources/library/random.rst.txt | 495 + .../_sources/library/re.rst.txt | 1687 + .../_sources/library/readline.rst.txt | 359 + .../_sources/library/reprlib.rst.txt | 163 + .../_sources/library/resource.rst.txt | 350 + .../_sources/library/rlcompleter.rst.txt | 61 + .../_sources/library/runpy.rst.txt | 179 + .../_sources/library/sched.rst.txt | 137 + .../_sources/library/secrets.rst.txt | 198 + .../_sources/library/select.rst.txt | 646 + .../_sources/library/selectors.rst.txt | 277 + .../_sources/library/shelve.rst.txt | 203 + .../_sources/library/shlex.rst.txt | 418 + .../_sources/library/shutil.rst.txt | 659 + .../_sources/library/signal.rst.txt | 529 + .../_sources/library/site.rst.txt | 259 + .../_sources/library/smtpd.rst.txt | 277 + .../_sources/library/smtplib.rst.txt | 586 + .../_sources/library/sndhdr.rst.txt | 51 + .../_sources/library/socket.rst.txt | 1876 + .../_sources/library/socketserver.rst.txt | 660 + .../_sources/library/spwd.rst.txt | 75 + .../_sources/library/sqlite3.rst.txt | 1103 + .../_sources/library/ssl.rst.txt | 2724 ++ .../_sources/library/stat.rst.txt | 427 + .../_sources/library/statistics.rst.txt | 454 + .../_sources/library/stdtypes.rst.txt | 4744 +++ .../_sources/library/string.rst.txt | 845 + .../_sources/library/stringprep.rst.txt | 143 + .../_sources/library/struct.rst.txt | 474 + .../_sources/library/subprocess.rst.txt | 1401 + .../_sources/library/sunau.rst.txt | 276 + .../_sources/library/superseded.rst.txt | 14 + .../_sources/library/symbol.rst.txt | 27 + .../_sources/library/symtable.rst.txt | 188 + .../_sources/library/sys.rst.txt | 1530 + .../_sources/library/sysconfig.rst.txt | 258 + .../_sources/library/syslog.rst.txt | 112 + .../_sources/library/tabnanny.rst.txt | 67 + .../_sources/library/tarfile.rst.txt | 877 + .../_sources/library/telnetlib.rst.txt | 252 + .../_sources/library/tempfile.rst.txt | 333 + .../_sources/library/termios.rst.txt | 105 + .../_sources/library/test.rst.txt | 1406 + .../_sources/library/text.rst.txt | 26 + .../_sources/library/textwrap.rst.txt | 299 + .../_sources/library/threading.rst.txt | 998 + .../_sources/library/time.rst.txt | 887 + .../_sources/library/timeit.rst.txt | 371 + .../_sources/library/tk.rst.txt | 46 + .../_sources/library/tkinter.rst.txt | 863 + .../library/tkinter.scrolledtext.rst.txt | 36 + .../_sources/library/tkinter.tix.rst.txt | 583 + .../_sources/library/tkinter.ttk.rst.txt | 1528 + .../_sources/library/token.rst.txt | 137 + .../_sources/library/tokenize.rst.txt | 269 + .../_sources/library/trace.rst.txt | 213 + .../_sources/library/traceback.rst.txt | 486 + .../_sources/library/tracemalloc.rst.txt | 693 + .../_sources/library/tty.rst.txt | 41 + .../_sources/library/turtle.rst.txt | 2440 ++ .../_sources/library/types.rst.txt | 374 + .../_sources/library/typing.rst.txt | 1143 + .../_sources/library/undoc.rst.txt | 26 + .../_sources/library/unicodedata.rst.txt | 173 + .../library/unittest.mock-examples.rst.txt | 1266 + .../_sources/library/unittest.mock.rst.txt | 2426 ++ .../_sources/library/unittest.rst.txt | 2337 ++ .../_sources/library/unix.rst.txt | 26 + .../_sources/library/urllib.error.rst.txt | 66 + .../_sources/library/urllib.parse.rst.txt | 666 + .../_sources/library/urllib.request.rst.txt | 1586 + .../library/urllib.robotparser.rst.txt | 97 + .../_sources/library/urllib.rst.txt | 15 + .../_sources/library/uu.rst.txt | 66 + .../_sources/library/uuid.rst.txt | 303 + .../_sources/library/venv.rst.txt | 478 + .../_sources/library/warnings.rst.txt | 516 + .../_sources/library/wave.rst.txt | 249 + .../_sources/library/weakref.rst.txt | 578 + .../_sources/library/webbrowser.rst.txt | 218 + .../_sources/library/windows.rst.txt | 15 + .../_sources/library/winreg.rst.txt | 756 + .../_sources/library/winsound.rst.txt | 161 + .../_sources/library/wsgiref.rst.txt | 781 + .../_sources/library/xdrlib.rst.txt | 278 + .../_sources/library/xml.dom.minidom.rst.txt | 243 + .../_sources/library/xml.dom.pulldom.rst.txt | 145 + .../_sources/library/xml.dom.rst.txt | 1033 + .../library/xml.etree.elementtree.rst.txt | 1205 + .../_sources/library/xml.rst.txt | 139 + .../_sources/library/xml.sax.handler.rst.txt | 415 + .../_sources/library/xml.sax.reader.rst.txt | 393 + .../_sources/library/xml.sax.rst.txt | 173 + .../_sources/library/xml.sax.utils.rst.txt | 91 + .../_sources/library/xmlrpc.client.rst.txt | 606 + .../_sources/library/xmlrpc.rst.txt | 12 + .../_sources/library/xmlrpc.server.rst.txt | 445 + .../_sources/library/zipapp.rst.txt | 449 + .../_sources/library/zipfile.rst.txt | 734 + .../_sources/library/zipimport.rst.txt | 167 + .../_sources/library/zlib.rst.txt | 330 + .../_sources/license.rst.txt | 915 + .../_sources/reference/compound_stmts.rst.txt | 853 + .../_sources/reference/datamodel.rst.txt | 2727 ++ .../_sources/reference/executionmodel.rst.txt | 266 + .../_sources/reference/expressions.rst.txt | 1887 + .../_sources/reference/grammar.rst.txt | 7 + .../_sources/reference/import.rst.txt | 1073 + .../_sources/reference/index.rst.txt | 29 + .../_sources/reference/introduction.rst.txt | 132 + .../reference/lexical_analysis.rst.txt | 930 + .../_sources/reference/simple_stmts.rst.txt | 1008 + .../reference/toplevel_components.rst.txt | 107 + .../_sources/tutorial/appendix.rst.txt | 124 + .../_sources/tutorial/appetite.rst.txt | 87 + .../_sources/tutorial/classes.rst.txt | 922 + .../_sources/tutorial/controlflow.rst.txt | 764 + .../_sources/tutorial/datastructures.rst.txt | 712 + .../_sources/tutorial/errors.rst.txt | 414 + .../_sources/tutorial/floatingpoint.rst.txt | 300 + .../_sources/tutorial/index.rst.txt | 60 + .../_sources/tutorial/inputoutput.rst.txt | 503 + .../_sources/tutorial/interactive.rst.txt | 54 + .../_sources/tutorial/interpreter.rst.txt | 162 + .../_sources/tutorial/introduction.rst.txt | 545 + .../_sources/tutorial/modules.rst.txt | 572 + .../_sources/tutorial/stdlib.rst.txt | 340 + .../_sources/tutorial/stdlib2.rst.txt | 405 + .../_sources/tutorial/venv.rst.txt | 210 + .../_sources/tutorial/whatnow.rst.txt | 76 + .../_sources/using/cmdline.rst.txt | 918 + .../_sources/using/index.rst.txt | 19 + .../_sources/using/mac.rst.txt | 183 + .../_sources/using/unix.rst.txt | 147 + .../_sources/using/windows.rst.txt | 1132 + .../_sources/whatsnew/2.0.rst.txt | 1205 + .../_sources/whatsnew/2.1.rst.txt | 794 + .../_sources/whatsnew/2.2.rst.txt | 1269 + .../_sources/whatsnew/2.3.rst.txt | 2086 ++ .../_sources/whatsnew/2.4.rst.txt | 1565 + .../_sources/whatsnew/2.5.rst.txt | 2289 ++ .../_sources/whatsnew/2.6.rst.txt | 3315 ++ .../_sources/whatsnew/2.7.rst.txt | 2799 ++ .../_sources/whatsnew/3.0.rst.txt | 929 + .../_sources/whatsnew/3.1.rst.txt | 552 + .../_sources/whatsnew/3.2.rst.txt | 2739 ++ .../_sources/whatsnew/3.3.rst.txt | 2517 ++ .../_sources/whatsnew/3.4.rst.txt | 2545 ++ .../_sources/whatsnew/3.5.rst.txt | 2574 ++ .../_sources/whatsnew/3.6.rst.txt | 2435 ++ .../_sources/whatsnew/3.7.rst.txt | 2539 ++ .../_sources/whatsnew/changelog.rst.txt | 7 + .../_sources/whatsnew/index.rst.txt | 39 + .../_static/ajax-loader.gif | Bin 0 -> 673 bytes python-3.7.4-docs-html/_static/basic.css | 748 + python-3.7.4-docs-html/_static/classic.css | 266 + .../_static/comment-bright.png | Bin 0 -> 756 bytes .../_static/comment-close.png | Bin 0 -> 829 bytes python-3.7.4-docs-html/_static/comment.png | Bin 0 -> 641 bytes python-3.7.4-docs-html/_static/copybutton.js | 62 + python-3.7.4-docs-html/_static/default.css | 1 + python-3.7.4-docs-html/_static/doctools.js | 314 + .../_static/documentation_options.js | 10 + .../_static/down-pressed.png | Bin 0 -> 222 bytes python-3.7.4-docs-html/_static/down.png | Bin 0 -> 202 bytes python-3.7.4-docs-html/_static/file.png | Bin 0 -> 286 bytes .../_static/jquery-3.2.1.js | 10253 ++++++ python-3.7.4-docs-html/_static/jquery.js | 4 + .../_static/language_data.js | 297 + python-3.7.4-docs-html/_static/minus.png | Bin 0 -> 90 bytes python-3.7.4-docs-html/_static/opensearch.xml | 10 + python-3.7.4-docs-html/_static/plus.png | Bin 0 -> 90 bytes python-3.7.4-docs-html/_static/py.png | Bin 0 -> 695 bytes python-3.7.4-docs-html/_static/pydoctheme.css | 194 + python-3.7.4-docs-html/_static/pygments.css | 69 + python-3.7.4-docs-html/_static/searchtools.js | 505 + python-3.7.4-docs-html/_static/sidebar.js | 193 + python-3.7.4-docs-html/_static/switchers.js | 155 + .../_static/underscore-1.3.1.js | 999 + python-3.7.4-docs-html/_static/underscore.js | 31 + python-3.7.4-docs-html/_static/up-pressed.png | Bin 0 -> 214 bytes python-3.7.4-docs-html/_static/up.png | Bin 0 -> 203 bytes python-3.7.4-docs-html/_static/websupport.js | 808 + python-3.7.4-docs-html/about.html | 210 + python-3.7.4-docs-html/bugs.html | 257 + python-3.7.4-docs-html/c-api/abstract.html | 216 + python-3.7.4-docs-html/c-api/allocation.html | 258 + .../c-api/apiabiversion.html | 231 + python-3.7.4-docs-html/c-api/arg.html | 782 + python-3.7.4-docs-html/c-api/bool.html | 228 + python-3.7.4-docs-html/c-api/buffer.html | 870 + python-3.7.4-docs-html/c-api/bytearray.html | 282 + python-3.7.4-docs-html/c-api/bytes.html | 423 + python-3.7.4-docs-html/c-api/capsule.html | 331 + python-3.7.4-docs-html/c-api/cell.html | 246 + python-3.7.4-docs-html/c-api/code.html | 229 + python-3.7.4-docs-html/c-api/codec.html | 340 + python-3.7.4-docs-html/c-api/complex.html | 326 + python-3.7.4-docs-html/c-api/concrete.html | 332 + python-3.7.4-docs-html/c-api/contextvars.html | 350 + python-3.7.4-docs-html/c-api/conversion.html | 300 + python-3.7.4-docs-html/c-api/coro.html | 215 + python-3.7.4-docs-html/c-api/datetime.html | 463 + python-3.7.4-docs-html/c-api/descriptor.html | 229 + python-3.7.4-docs-html/c-api/dict.html | 439 + python-3.7.4-docs-html/c-api/exceptions.html | 1364 + python-3.7.4-docs-html/c-api/file.html | 251 + python-3.7.4-docs-html/c-api/float.html | 267 + python-3.7.4-docs-html/c-api/function.html | 291 + python-3.7.4-docs-html/c-api/gcsupport.html | 341 + python-3.7.4-docs-html/c-api/gen.html | 227 + python-3.7.4-docs-html/c-api/import.html | 514 + python-3.7.4-docs-html/c-api/index.html | 283 + python-3.7.4-docs-html/c-api/init.html | 1737 + python-3.7.4-docs-html/c-api/intro.html | 803 + python-3.7.4-docs-html/c-api/iter.html | 225 + python-3.7.4-docs-html/c-api/iterator.html | 232 + python-3.7.4-docs-html/c-api/list.html | 342 + python-3.7.4-docs-html/c-api/long.html | 452 + python-3.7.4-docs-html/c-api/mapping.html | 287 + python-3.7.4-docs-html/c-api/marshal.html | 268 + python-3.7.4-docs-html/c-api/memory.html | 814 + python-3.7.4-docs-html/c-api/memoryview.html | 246 + python-3.7.4-docs-html/c-api/method.html | 284 + python-3.7.4-docs-html/c-api/module.html | 709 + python-3.7.4-docs-html/c-api/none.html | 202 + python-3.7.4-docs-html/c-api/number.html | 487 + python-3.7.4-docs-html/c-api/objbuffer.html | 235 + python-3.7.4-docs-html/c-api/object.html | 639 + python-3.7.4-docs-html/c-api/objimpl.html | 196 + python-3.7.4-docs-html/c-api/refcounting.html | 245 + python-3.7.4-docs-html/c-api/reflection.html | 234 + python-3.7.4-docs-html/c-api/sequence.html | 363 + python-3.7.4-docs-html/c-api/set.html | 349 + python-3.7.4-docs-html/c-api/slice.html | 311 + python-3.7.4-docs-html/c-api/stable.html | 207 + python-3.7.4-docs-html/c-api/structures.html | 672 + python-3.7.4-docs-html/c-api/sys.html | 536 + python-3.7.4-docs-html/c-api/tuple.html | 459 + python-3.7.4-docs-html/c-api/type.html | 317 + python-3.7.4-docs-html/c-api/typeobj.html | 1678 + python-3.7.4-docs-html/c-api/unicode.html | 2020 ++ python-3.7.4-docs-html/c-api/utilities.html | 211 + python-3.7.4-docs-html/c-api/veryhigh.html | 597 + python-3.7.4-docs-html/c-api/weakref.html | 252 + python-3.7.4-docs-html/contents.html | 5743 +++ python-3.7.4-docs-html/copyright.html | 187 + .../distributing/index.html | 326 + python-3.7.4-docs-html/distutils/apiref.html | 2095 ++ .../distutils/builtdist.html | 667 + .../distutils/commandref.html | 263 + .../distutils/configfile.html | 294 + .../distutils/examples.html | 489 + .../distutils/extending.html | 262 + python-3.7.4-docs-html/distutils/index.html | 309 + .../distutils/introduction.html | 364 + .../distutils/packageindex.html | 164 + .../distutils/setupscript.html | 886 + .../distutils/sourcedist.html | 403 + .../distutils/uploading.html | 161 + python-3.7.4-docs-html/download.html | 198 + .../extending/building.html | 325 + .../extending/embedding.html | 543 + .../extending/extending.html | 1395 + python-3.7.4-docs-html/extending/index.html | 297 + .../extending/newtypes.html | 828 + .../extending/newtypes_tutorial.html | 1637 + python-3.7.4-docs-html/extending/windows.html | 289 + python-3.7.4-docs-html/faq/design.html | 938 + python-3.7.4-docs-html/faq/extending.html | 601 + python-3.7.4-docs-html/faq/general.html | 572 + python-3.7.4-docs-html/faq/gui.html | 336 + python-3.7.4-docs-html/faq/index.html | 191 + python-3.7.4-docs-html/faq/installed.html | 232 + python-3.7.4-docs-html/faq/library.html | 865 + python-3.7.4-docs-html/faq/programming.html | 1967 + python-3.7.4-docs-html/faq/windows.html | 434 + python-3.7.4-docs-html/genindex-A.html | 1315 + python-3.7.4-docs-html/genindex-B.html | 948 + python-3.7.4-docs-html/genindex-C.html | 2327 ++ python-3.7.4-docs-html/genindex-D.html | 1301 + python-3.7.4-docs-html/genindex-E.html | 1639 + python-3.7.4-docs-html/genindex-F.html | 1345 + python-3.7.4-docs-html/genindex-G.html | 1598 + python-3.7.4-docs-html/genindex-H.html | 777 + python-3.7.4-docs-html/genindex-I.html | 1777 + python-3.7.4-docs-html/genindex-J.html | 251 + python-3.7.4-docs-html/genindex-K.html | 293 + python-3.7.4-docs-html/genindex-L.html | 956 + python-3.7.4-docs-html/genindex-M.html | 1203 + python-3.7.4-docs-html/genindex-N.html | 782 + python-3.7.4-docs-html/genindex-O.html | 867 + python-3.7.4-docs-html/genindex-P.html | 4592 +++ python-3.7.4-docs-html/genindex-Q.html | 264 + python-3.7.4-docs-html/genindex-R.html | 1882 + python-3.7.4-docs-html/genindex-S.html | 2999 ++ python-3.7.4-docs-html/genindex-Symbols.html | 1723 + python-3.7.4-docs-html/genindex-T.html | 1249 + python-3.7.4-docs-html/genindex-U.html | 838 + python-3.7.4-docs-html/genindex-V.html | 363 + python-3.7.4-docs-html/genindex-W.html | 642 + python-3.7.4-docs-html/genindex-X.html | 326 + python-3.7.4-docs-html/genindex-Y.html | 200 + python-3.7.4-docs-html/genindex-Z.html | 243 + python-3.7.4-docs-html/genindex-_.html | 1090 + python-3.7.4-docs-html/genindex-all.html | 29854 ++++++++++++++++ python-3.7.4-docs-html/genindex.html | 184 + python-3.7.4-docs-html/glossary.html | 1132 + python-3.7.4-docs-html/howto/argparse.html | 888 + python-3.7.4-docs-html/howto/clinic.html | 1806 + python-3.7.4-docs-html/howto/cporting.html | 564 + python-3.7.4-docs-html/howto/curses.html | 729 + python-3.7.4-docs-html/howto/descriptor.html | 636 + python-3.7.4-docs-html/howto/functional.html | 1350 + python-3.7.4-docs-html/howto/index.html | 205 + .../howto/instrumentation.html | 598 + python-3.7.4-docs-html/howto/ipaddress.html | 510 + .../howto/logging-cookbook.html | 2589 ++ python-3.7.4-docs-html/howto/logging.html | 1233 + python-3.7.4-docs-html/howto/pyporting.html | 594 + python-3.7.4-docs-html/howto/regex.html | 1564 + python-3.7.4-docs-html/howto/sockets.html | 538 + python-3.7.4-docs-html/howto/sorting.html | 473 + python-3.7.4-docs-html/howto/unicode.html | 878 + python-3.7.4-docs-html/howto/urllib2.html | 770 + python-3.7.4-docs-html/index.html | 223 + python-3.7.4-docs-html/install/index.html | 1293 + python-3.7.4-docs-html/installing/index.html | 399 + python-3.7.4-docs-html/library/2to3.html | 762 + .../library/__future__.html | 308 + python-3.7.4-docs-html/library/__main__.html | 199 + .../library/_dummy_thread.html | 195 + python-3.7.4-docs-html/library/_thread.html | 352 + python-3.7.4-docs-html/library/abc.html | 512 + python-3.7.4-docs-html/library/aifc.html | 426 + python-3.7.4-docs-html/library/allos.html | 420 + python-3.7.4-docs-html/library/archiving.html | 231 + python-3.7.4-docs-html/library/argparse.html | 2240 ++ python-3.7.4-docs-html/library/array.html | 536 + python-3.7.4-docs-html/library/ast.html | 592 + python-3.7.4-docs-html/library/asynchat.html | 405 + .../library/asyncio-api-index.html | 402 + .../library/asyncio-dev.html | 395 + .../library/asyncio-eventloop.html | 1754 + .../library/asyncio-exceptions.html | 276 + .../library/asyncio-future.html | 435 + .../library/asyncio-llapi-index.html | 743 + .../library/asyncio-platforms.html | 277 + .../library/asyncio-policy.html | 413 + .../library/asyncio-protocol.html | 1222 + .../library/asyncio-queue.html | 400 + .../library/asyncio-stream.html | 630 + .../library/asyncio-subprocess.html | 530 + .../library/asyncio-sync.html | 525 + .../library/asyncio-task.html | 1062 + python-3.7.4-docs-html/library/asyncio.html | 256 + python-3.7.4-docs-html/library/asyncore.html | 560 + python-3.7.4-docs-html/library/atexit.html | 289 + python-3.7.4-docs-html/library/audioop.html | 466 + python-3.7.4-docs-html/library/base64.html | 464 + python-3.7.4-docs-html/library/bdb.html | 619 + python-3.7.4-docs-html/library/binary.html | 236 + python-3.7.4-docs-html/library/binascii.html | 379 + python-3.7.4-docs-html/library/binhex.html | 236 + python-3.7.4-docs-html/library/bisect.html | 329 + python-3.7.4-docs-html/library/builtins.html | 216 + python-3.7.4-docs-html/library/bz2.html | 511 + python-3.7.4-docs-html/library/calendar.html | 640 + python-3.7.4-docs-html/library/cgi.html | 676 + python-3.7.4-docs-html/library/cgitb.html | 249 + python-3.7.4-docs-html/library/chunk.html | 324 + python-3.7.4-docs-html/library/cmath.html | 529 + python-3.7.4-docs-html/library/cmd.html | 554 + python-3.7.4-docs-html/library/code.html | 369 + python-3.7.4-docs-html/library/codecs.html | 1948 + python-3.7.4-docs-html/library/codeop.html | 243 + .../library/collections.abc.html | 633 + .../library/collections.html | 1461 + python-3.7.4-docs-html/library/colorsys.html | 243 + .../library/compileall.html | 461 + .../library/concurrency.html | 316 + .../library/concurrent.futures.html | 712 + .../library/concurrent.html | 187 + .../library/configparser.html | 1442 + python-3.7.4-docs-html/library/constants.html | 293 + .../library/contextlib.html | 1053 + .../library/contextvars.html | 489 + python-3.7.4-docs-html/library/copy.html | 258 + python-3.7.4-docs-html/library/copyreg.html | 244 + python-3.7.4-docs-html/library/crypt.html | 353 + python-3.7.4-docs-html/library/crypto.html | 221 + python-3.7.4-docs-html/library/csv.html | 735 + python-3.7.4-docs-html/library/ctypes.html | 2646 ++ .../library/curses.ascii.html | 456 + python-3.7.4-docs-html/library/curses.html | 2441 ++ .../library/curses.panel.html | 309 + .../library/custominterp.html | 197 + .../library/dataclasses.html | 769 + python-3.7.4-docs-html/library/datatypes.html | 320 + python-3.7.4-docs-html/library/datetime.html | 2814 ++ python-3.7.4-docs-html/library/dbm.html | 593 + python-3.7.4-docs-html/library/debug.html | 253 + python-3.7.4-docs-html/library/decimal.html | 2419 ++ .../library/development.html | 350 + python-3.7.4-docs-html/library/difflib.html | 970 + python-3.7.4-docs-html/library/dis.html | 1613 + .../library/distribution.html | 215 + python-3.7.4-docs-html/library/distutils.html | 216 + python-3.7.4-docs-html/library/doctest.html | 1890 + .../library/dummy_threading.html | 194 + .../library/email.charset.html | 386 + .../library/email.compat32-message.html | 921 + .../library/email.contentmanager.html | 386 + .../library/email.encoders.html | 251 + .../library/email.errors.html | 288 + .../library/email.examples.html | 569 + .../library/email.generator.html | 433 + .../library/email.header.html | 364 + .../library/email.headerregistry.html | 696 + python-3.7.4-docs-html/library/email.html | 316 + .../library/email.iterators.html | 246 + .../library/email.message.html | 931 + .../library/email.mime.html | 394 + .../library/email.parser.html | 513 + .../library/email.policy.html | 816 + .../library/email.utils.html | 412 + python-3.7.4-docs-html/library/ensurepip.html | 309 + python-3.7.4-docs-html/library/enum.html | 1328 + python-3.7.4-docs-html/library/errno.html | 936 + .../library/exceptions.html | 1075 + .../library/faulthandler.html | 357 + python-3.7.4-docs-html/library/fcntl.html | 329 + python-3.7.4-docs-html/library/filecmp.html | 392 + .../library/fileformats.html | 223 + python-3.7.4-docs-html/library/fileinput.html | 376 + python-3.7.4-docs-html/library/filesys.html | 247 + python-3.7.4-docs-html/library/fnmatch.html | 280 + python-3.7.4-docs-html/library/formatter.html | 551 + python-3.7.4-docs-html/library/fractions.html | 372 + .../library/frameworks.html | 249 + python-3.7.4-docs-html/library/ftplib.html | 662 + .../library/functional.html | 202 + python-3.7.4-docs-html/library/functions.html | 1915 + python-3.7.4-docs-html/library/functools.html | 675 + python-3.7.4-docs-html/library/gc.html | 489 + python-3.7.4-docs-html/library/getopt.html | 339 + python-3.7.4-docs-html/library/getpass.html | 224 + python-3.7.4-docs-html/library/gettext.html | 843 + python-3.7.4-docs-html/library/glob.html | 276 + python-3.7.4-docs-html/library/grp.html | 262 + python-3.7.4-docs-html/library/gzip.html | 390 + python-3.7.4-docs-html/library/hashlib.html | 919 + python-3.7.4-docs-html/library/heapq.html | 479 + python-3.7.4-docs-html/library/hmac.html | 322 + .../library/html.entities.html | 226 + python-3.7.4-docs-html/library/html.html | 218 + .../library/html.parser.html | 517 + .../library/http.client.html | 775 + .../library/http.cookiejar.html | 932 + .../library/http.cookies.html | 468 + python-3.7.4-docs-html/library/http.html | 490 + .../library/http.server.html | 710 + python-3.7.4-docs-html/library/i18n.html | 215 + python-3.7.4-docs-html/library/idle.html | 950 + python-3.7.4-docs-html/library/imaplib.html | 812 + python-3.7.4-docs-html/library/imghdr.html | 274 + python-3.7.4-docs-html/library/imp.html | 593 + python-3.7.4-docs-html/library/importlib.html | 2105 ++ python-3.7.4-docs-html/library/index.html | 587 + python-3.7.4-docs-html/library/inspect.html | 1801 + python-3.7.4-docs-html/library/internet.html | 397 + python-3.7.4-docs-html/library/intro.html | 235 + python-3.7.4-docs-html/library/io.html | 1304 + python-3.7.4-docs-html/library/ipaddress.html | 1399 + python-3.7.4-docs-html/library/ipc.html | 200 + python-3.7.4-docs-html/library/itertools.html | 1202 + python-3.7.4-docs-html/library/json.html | 908 + python-3.7.4-docs-html/library/keyword.html | 200 + python-3.7.4-docs-html/library/language.html | 245 + python-3.7.4-docs-html/library/linecache.html | 238 + python-3.7.4-docs-html/library/locale.html | 862 + .../library/logging.config.html | 935 + .../library/logging.handlers.html | 1401 + python-3.7.4-docs-html/library/logging.html | 1603 + python-3.7.4-docs-html/library/lzma.html | 627 + python-3.7.4-docs-html/library/macpath.html | 195 + python-3.7.4-docs-html/library/mailbox.html | 2115 ++ python-3.7.4-docs-html/library/mailcap.html | 246 + python-3.7.4-docs-html/library/markup.html | 295 + python-3.7.4-docs-html/library/marshal.html | 284 + python-3.7.4-docs-html/library/math.html | 735 + python-3.7.4-docs-html/library/mimetypes.html | 447 + python-3.7.4-docs-html/library/misc.html | 194 + python-3.7.4-docs-html/library/mm.html | 209 + python-3.7.4-docs-html/library/mmap.html | 471 + .../library/modulefinder.html | 297 + python-3.7.4-docs-html/library/modules.html | 216 + python-3.7.4-docs-html/library/msilib.html | 762 + python-3.7.4-docs-html/library/msvcrt.html | 345 + .../library/multiprocessing.html | 3397 ++ python-3.7.4-docs-html/library/netdata.html | 265 + python-3.7.4-docs-html/library/netrc.html | 271 + python-3.7.4-docs-html/library/nis.html | 232 + python-3.7.4-docs-html/library/nntplib.html | 773 + python-3.7.4-docs-html/library/numbers.html | 420 + python-3.7.4-docs-html/library/numeric.html | 258 + python-3.7.4-docs-html/library/operator.html | 906 + python-3.7.4-docs-html/library/optparse.html | 2047 ++ python-3.7.4-docs-html/library/os.html | 4412 +++ python-3.7.4-docs-html/library/os.path.html | 642 + .../library/ossaudiodev.html | 638 + python-3.7.4-docs-html/library/othergui.html | 228 + python-3.7.4-docs-html/library/parser.html | 510 + python-3.7.4-docs-html/library/pathlib.html | 1428 + python-3.7.4-docs-html/library/pdb.html | 757 + .../library/persistence.html | 257 + python-3.7.4-docs-html/library/pickle.html | 1122 + .../library/pickletools.html | 304 + python-3.7.4-docs-html/library/pipes.html | 274 + python-3.7.4-docs-html/library/pkgutil.html | 398 + python-3.7.4-docs-html/library/platform.html | 473 + python-3.7.4-docs-html/library/plistlib.html | 403 + python-3.7.4-docs-html/library/poplib.html | 437 + python-3.7.4-docs-html/library/posix.html | 259 + python-3.7.4-docs-html/library/pprint.html | 546 + python-3.7.4-docs-html/library/profile.html | 856 + python-3.7.4-docs-html/library/pty.html | 287 + python-3.7.4-docs-html/library/pwd.html | 273 + .../library/py_compile.html | 314 + python-3.7.4-docs-html/library/pyclbr.html | 348 + python-3.7.4-docs-html/library/pydoc.html | 266 + python-3.7.4-docs-html/library/pyexpat.html | 1103 + python-3.7.4-docs-html/library/python.html | 273 + python-3.7.4-docs-html/library/queue.html | 478 + python-3.7.4-docs-html/library/quopri.html | 238 + python-3.7.4-docs-html/library/random.html | 675 + python-3.7.4-docs-html/library/re.html | 1839 + python-3.7.4-docs-html/library/readline.html | 556 + python-3.7.4-docs-html/library/reprlib.html | 353 + python-3.7.4-docs-html/library/resource.html | 592 + .../library/rlcompleter.html | 233 + python-3.7.4-docs-html/library/runpy.html | 331 + python-3.7.4-docs-html/library/sched.html | 318 + python-3.7.4-docs-html/library/secrets.html | 363 + python-3.7.4-docs-html/library/select.html | 966 + python-3.7.4-docs-html/library/selectors.html | 501 + python-3.7.4-docs-html/library/shelve.html | 377 + python-3.7.4-docs-html/library/shlex.html | 598 + python-3.7.4-docs-html/library/shutil.html | 809 + python-3.7.4-docs-html/library/signal.html | 704 + python-3.7.4-docs-html/library/site.html | 420 + python-3.7.4-docs-html/library/smtpd.html | 500 + python-3.7.4-docs-html/library/smtplib.html | 750 + python-3.7.4-docs-html/library/sndhdr.html | 220 + python-3.7.4-docs-html/library/socket.html | 2170 ++ .../library/socketserver.html | 838 + python-3.7.4-docs-html/library/spwd.html | 277 + python-3.7.4-docs-html/library/sqlite3.html | 1729 + python-3.7.4-docs-html/library/ssl.html | 3252 ++ python-3.7.4-docs-html/library/stat.html | 721 + .../library/statistics.html | 613 + python-3.7.4-docs-html/library/stdtypes.html | 4946 +++ python-3.7.4-docs-html/library/string.html | 1054 + .../library/stringprep.html | 330 + python-3.7.4-docs-html/library/struct.html | 737 + .../library/subprocess.html | 1612 + python-3.7.4-docs-html/library/sunau.html | 495 + .../library/superseded.html | 246 + python-3.7.4-docs-html/library/symbol.html | 200 + python-3.7.4-docs-html/library/symtable.html | 429 + python-3.7.4-docs-html/library/sys.html | 1871 + python-3.7.4-docs-html/library/sysconfig.html | 426 + python-3.7.4-docs-html/library/syslog.html | 295 + python-3.7.4-docs-html/library/tabnanny.html | 239 + python-3.7.4-docs-html/library/tarfile.html | 1100 + python-3.7.4-docs-html/library/telnetlib.html | 430 + python-3.7.4-docs-html/library/tempfile.html | 501 + python-3.7.4-docs-html/library/termios.html | 284 + python-3.7.4-docs-html/library/test.html | 1673 + python-3.7.4-docs-html/library/text.html | 246 + python-3.7.4-docs-html/library/textwrap.html | 482 + python-3.7.4-docs-html/library/threading.html | 1151 + python-3.7.4-docs-html/library/time.html | 1147 + python-3.7.4-docs-html/library/timeit.html | 547 + python-3.7.4-docs-html/library/tk.html | 349 + python-3.7.4-docs-html/library/tkinter.html | 1003 + .../library/tkinter.scrolledtext.html | 208 + .../library/tkinter.tix.html | 655 + .../library/tkinter.ttk.html | 2009 ++ python-3.7.4-docs-html/library/token.html | 371 + python-3.7.4-docs-html/library/tokenize.html | 436 + python-3.7.4-docs-html/library/trace.html | 437 + python-3.7.4-docs-html/library/traceback.html | 701 + .../library/tracemalloc.html | 925 + python-3.7.4-docs-html/library/tty.html | 212 + python-3.7.4-docs-html/library/turtle.html | 2925 ++ python-3.7.4-docs-html/library/types.html | 606 + python-3.7.4-docs-html/library/typing.html | 1453 + python-3.7.4-docs-html/library/undoc.html | 206 + .../library/unicodedata.html | 347 + python-3.7.4-docs-html/library/unittest.html | 2665 ++ .../library/unittest.mock-examples.html | 1399 + .../library/unittest.mock.html | 2580 ++ python-3.7.4-docs-html/library/unix.html | 230 + .../library/urllib.error.html | 250 + python-3.7.4-docs-html/library/urllib.html | 192 + .../library/urllib.parse.html | 906 + .../library/urllib.request.html | 1729 + .../library/urllib.robotparser.html | 281 + python-3.7.4-docs-html/library/uu.html | 236 + python-3.7.4-docs-html/library/uuid.html | 517 + python-3.7.4-docs-html/library/venv.html | 780 + python-3.7.4-docs-html/library/warnings.html | 689 + python-3.7.4-docs-html/library/wave.html | 438 + python-3.7.4-docs-html/library/weakref.html | 745 + .../library/webbrowser.html | 449 + python-3.7.4-docs-html/library/windows.html | 220 + python-3.7.4-docs-html/library/winreg.html | 947 + python-3.7.4-docs-html/library/winsound.html | 362 + python-3.7.4-docs-html/library/wsgiref.html | 938 + python-3.7.4-docs-html/library/xdrlib.html | 470 + python-3.7.4-docs-html/library/xml.dom.html | 1289 + .../library/xml.dom.minidom.html | 468 + .../library/xml.dom.pulldom.html | 334 + .../library/xml.etree.elementtree.html | 1446 + python-3.7.4-docs-html/library/xml.html | 340 + .../library/xml.sax.handler.html | 612 + python-3.7.4-docs-html/library/xml.sax.html | 346 + .../library/xml.sax.reader.html | 581 + .../library/xml.sax.utils.html | 266 + .../library/xmlrpc.client.html | 788 + python-3.7.4-docs-html/library/xmlrpc.html | 192 + .../library/xmlrpc.server.html | 626 + python-3.7.4-docs-html/library/zipapp.html | 597 + python-3.7.4-docs-html/library/zipfile.html | 953 + python-3.7.4-docs-html/library/zipimport.html | 349 + python-3.7.4-docs-html/library/zlib.html | 491 + python-3.7.4-docs-html/license.html | 1144 + python-3.7.4-docs-html/objects.inv | Bin 0 -> 103237 bytes python-3.7.4-docs-html/py-modindex.html | 2052 ++ .../reference/compound_stmts.html | 820 + .../reference/datamodel.html | 2440 ++ .../reference/executionmodel.html | 368 + .../reference/expressions.html | 1557 + python-3.7.4-docs-html/reference/grammar.html | 335 + python-3.7.4-docs-html/reference/import.html | 1135 + python-3.7.4-docs-html/reference/index.html | 285 + .../reference/introduction.html | 289 + .../reference/lexical_analysis.html | 940 + .../reference/simple_stmts.html | 903 + .../reference/toplevel_components.html | 248 + python-3.7.4-docs-html/search.html | 144 + python-3.7.4-docs-html/searchindex.js | 1 + python-3.7.4-docs-html/tutorial/appendix.html | 291 + python-3.7.4-docs-html/tutorial/appetite.html | 247 + python-3.7.4-docs-html/tutorial/classes.html | 999 + .../tutorial/controlflow.html | 855 + .../tutorial/datastructures.html | 844 + python-3.7.4-docs-html/tutorial/errors.html | 562 + .../tutorial/floatingpoint.html | 455 + python-3.7.4-docs-html/tutorial/index.html | 391 + .../tutorial/inputoutput.html | 639 + .../tutorial/interactive.html | 224 + .../tutorial/interpreter.html | 320 + .../tutorial/introduction.html | 706 + python-3.7.4-docs-html/tutorial/modules.html | 697 + python-3.7.4-docs-html/tutorial/stdlib.html | 486 + python-3.7.4-docs-html/tutorial/stdlib2.html | 556 + python-3.7.4-docs-html/tutorial/venv.html | 364 + python-3.7.4-docs-html/tutorial/whatnow.html | 243 + python-3.7.4-docs-html/using/cmdline.html | 1124 + python-3.7.4-docs-html/using/index.html | 281 + python-3.7.4-docs-html/using/mac.html | 334 + python-3.7.4-docs-html/using/unix.html | 333 + python-3.7.4-docs-html/using/windows.html | 1237 + python-3.7.4-docs-html/whatsnew/2.0.html | 1224 + python-3.7.4-docs-html/whatsnew/2.1.html | 913 + python-3.7.4-docs-html/whatsnew/2.2.html | 1303 + python-3.7.4-docs-html/whatsnew/2.3.html | 2038 ++ python-3.7.4-docs-html/whatsnew/2.4.html | 1570 + python-3.7.4-docs-html/whatsnew/2.5.html | 2192 ++ python-3.7.4-docs-html/whatsnew/2.6.html | 3171 ++ python-3.7.4-docs-html/whatsnew/2.7.html | 2622 ++ python-3.7.4-docs-html/whatsnew/3.0.html | 975 + python-3.7.4-docs-html/whatsnew/3.1.html | 678 + python-3.7.4-docs-html/whatsnew/3.2.html | 2724 ++ python-3.7.4-docs-html/whatsnew/3.3.html | 2527 ++ python-3.7.4-docs-html/whatsnew/3.4.html | 2332 ++ python-3.7.4-docs-html/whatsnew/3.5.html | 2421 ++ python-3.7.4-docs-html/whatsnew/3.6.html | 2265 ++ python-3.7.4-docs-html/whatsnew/3.7.html | 2356 ++ .../whatsnew/changelog.html | 14343 ++++++++ python-3.7.4-docs-html/whatsnew/index.html | 564 + stories.txt | 2 + storyCount.txt | 1 + test.py | 28 + 1027 files changed, 679464 insertions(+) create mode 100644 Fwd: programming project.eml create mode 100644 madlibs.py create mode 100644 python multiplier.py create mode 100644 python-3.7.4-docs-html/.buildinfo create mode 100644 python-3.7.4-docs-html/_downloads/6bc7a57013e3076d5e194caa123fe59c/tzinfo_examples.py create mode 100644 python-3.7.4-docs-html/_images/hashlib-blake2-tree.png create mode 100644 python-3.7.4-docs-html/_images/logging_flow.png create mode 100644 python-3.7.4-docs-html/_images/pathlib-inheritance.png create mode 100644 python-3.7.4-docs-html/_images/turtle-star.png create mode 100644 python-3.7.4-docs-html/_images/win_installer.png create mode 100644 python-3.7.4-docs-html/_sources/about.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/bugs.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/abstract.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/allocation.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/apiabiversion.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/arg.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/bool.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/buffer.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/bytearray.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/bytes.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/capsule.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/cell.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/code.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/codec.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/complex.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/concrete.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/contextvars.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/conversion.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/coro.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/datetime.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/descriptor.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/dict.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/exceptions.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/file.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/float.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/function.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/gcsupport.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/gen.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/import.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/index.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/init.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/intro.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/iter.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/iterator.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/list.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/long.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/mapping.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/marshal.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/memory.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/memoryview.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/method.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/module.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/none.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/number.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/objbuffer.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/object.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/objimpl.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/refcounting.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/reflection.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/sequence.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/set.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/slice.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/stable.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/structures.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/sys.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/tuple.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/type.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/typeobj.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/unicode.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/utilities.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/veryhigh.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/c-api/weakref.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/contents.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/copyright.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/distributing/index.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/distutils/apiref.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/distutils/builtdist.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/distutils/commandref.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/distutils/configfile.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/distutils/examples.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/distutils/extending.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/distutils/index.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/distutils/introduction.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/distutils/packageindex.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/distutils/setupscript.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/distutils/sourcedist.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/distutils/uploading.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/extending/building.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/extending/embedding.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/extending/extending.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/extending/index.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/extending/newtypes.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/extending/newtypes_tutorial.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/extending/windows.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/faq/design.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/faq/extending.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/faq/general.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/faq/gui.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/faq/index.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/faq/installed.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/faq/library.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/faq/programming.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/faq/windows.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/glossary.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/howto/argparse.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/howto/clinic.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/howto/cporting.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/howto/curses.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/howto/descriptor.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/howto/functional.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/howto/index.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/howto/instrumentation.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/howto/ipaddress.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/howto/logging-cookbook.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/howto/logging.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/howto/pyporting.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/howto/regex.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/howto/sockets.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/howto/sorting.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/howto/unicode.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/howto/urllib2.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/install/index.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/installing/index.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/2to3.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/__future__.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/__main__.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/_dummy_thread.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/_thread.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/abc.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/aifc.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/allos.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/archiving.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/argparse.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/array.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/ast.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/asynchat.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/asyncio-api-index.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/asyncio-dev.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/asyncio-eventloop.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/asyncio-exceptions.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/asyncio-future.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/asyncio-llapi-index.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/asyncio-platforms.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/asyncio-policy.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/asyncio-protocol.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/asyncio-queue.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/asyncio-stream.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/asyncio-subprocess.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/asyncio-sync.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/asyncio-task.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/asyncio.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/asyncore.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/atexit.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/audioop.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/base64.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/bdb.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/binary.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/binascii.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/binhex.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/bisect.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/builtins.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/bz2.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/calendar.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/cgi.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/cgitb.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/chunk.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/cmath.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/cmd.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/code.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/codecs.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/codeop.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/collections.abc.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/collections.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/colorsys.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/compileall.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/concurrency.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/concurrent.futures.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/concurrent.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/configparser.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/constants.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/contextlib.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/contextvars.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/copy.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/copyreg.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/crypt.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/crypto.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/csv.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/ctypes.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/curses.ascii.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/curses.panel.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/curses.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/custominterp.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/dataclasses.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/datatypes.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/datetime.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/dbm.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/debug.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/decimal.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/development.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/difflib.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/dis.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/distribution.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/distutils.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/doctest.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/dummy_threading.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/email.charset.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/email.compat32-message.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/email.contentmanager.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/email.encoders.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/email.errors.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/email.examples.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/email.generator.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/email.header.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/email.headerregistry.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/email.iterators.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/email.message.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/email.mime.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/email.parser.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/email.policy.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/email.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/email.utils.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/ensurepip.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/enum.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/errno.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/exceptions.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/faulthandler.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/fcntl.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/filecmp.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/fileformats.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/fileinput.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/filesys.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/fnmatch.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/formatter.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/fractions.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/frameworks.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/ftplib.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/functional.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/functions.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/functools.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/gc.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/getopt.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/getpass.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/gettext.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/glob.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/grp.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/gzip.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/hashlib.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/heapq.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/hmac.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/html.entities.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/html.parser.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/html.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/http.client.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/http.cookiejar.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/http.cookies.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/http.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/http.server.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/i18n.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/idle.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/imaplib.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/imghdr.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/imp.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/importlib.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/index.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/inspect.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/internet.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/intro.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/io.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/ipaddress.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/ipc.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/itertools.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/json.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/keyword.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/language.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/linecache.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/locale.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/logging.config.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/logging.handlers.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/logging.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/lzma.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/macpath.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/mailbox.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/mailcap.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/markup.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/marshal.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/math.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/mimetypes.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/misc.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/mm.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/mmap.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/modulefinder.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/modules.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/msilib.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/msvcrt.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/multiprocessing.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/netdata.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/netrc.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/nis.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/nntplib.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/numbers.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/numeric.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/operator.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/optparse.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/os.path.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/os.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/ossaudiodev.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/othergui.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/parser.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/pathlib.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/pdb.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/persistence.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/pickle.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/pickletools.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/pipes.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/pkgutil.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/platform.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/plistlib.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/poplib.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/posix.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/pprint.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/profile.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/pty.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/pwd.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/py_compile.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/pyclbr.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/pydoc.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/pyexpat.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/python.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/queue.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/quopri.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/random.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/re.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/readline.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/reprlib.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/resource.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/rlcompleter.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/runpy.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/sched.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/secrets.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/select.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/selectors.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/shelve.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/shlex.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/shutil.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/signal.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/site.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/smtpd.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/smtplib.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/sndhdr.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/socket.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/socketserver.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/spwd.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/sqlite3.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/ssl.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/stat.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/statistics.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/stdtypes.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/string.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/stringprep.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/struct.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/subprocess.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/sunau.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/superseded.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/symbol.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/symtable.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/sys.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/sysconfig.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/syslog.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/tabnanny.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/tarfile.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/telnetlib.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/tempfile.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/termios.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/test.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/text.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/textwrap.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/threading.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/time.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/timeit.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/tk.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/tkinter.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/tkinter.scrolledtext.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/tkinter.tix.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/tkinter.ttk.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/token.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/tokenize.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/trace.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/traceback.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/tracemalloc.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/tty.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/turtle.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/types.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/typing.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/undoc.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/unicodedata.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/unittest.mock-examples.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/unittest.mock.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/unittest.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/unix.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/urllib.error.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/urllib.parse.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/urllib.request.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/urllib.robotparser.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/urllib.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/uu.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/uuid.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/venv.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/warnings.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/wave.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/weakref.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/webbrowser.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/windows.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/winreg.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/winsound.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/wsgiref.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/xdrlib.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/xml.dom.minidom.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/xml.dom.pulldom.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/xml.dom.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/xml.etree.elementtree.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/xml.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/xml.sax.handler.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/xml.sax.reader.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/xml.sax.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/xml.sax.utils.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/xmlrpc.client.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/xmlrpc.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/xmlrpc.server.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/zipapp.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/zipfile.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/zipimport.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/library/zlib.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/license.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/reference/compound_stmts.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/reference/datamodel.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/reference/executionmodel.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/reference/expressions.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/reference/grammar.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/reference/import.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/reference/index.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/reference/introduction.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/reference/lexical_analysis.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/reference/simple_stmts.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/reference/toplevel_components.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/tutorial/appendix.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/tutorial/appetite.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/tutorial/classes.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/tutorial/controlflow.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/tutorial/datastructures.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/tutorial/errors.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/tutorial/floatingpoint.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/tutorial/index.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/tutorial/inputoutput.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/tutorial/interactive.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/tutorial/interpreter.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/tutorial/introduction.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/tutorial/modules.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/tutorial/stdlib.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/tutorial/stdlib2.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/tutorial/venv.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/tutorial/whatnow.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/using/cmdline.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/using/index.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/using/mac.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/using/unix.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/using/windows.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/whatsnew/2.0.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/whatsnew/2.1.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/whatsnew/2.2.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/whatsnew/2.3.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/whatsnew/2.4.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/whatsnew/2.5.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/whatsnew/2.6.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/whatsnew/2.7.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/whatsnew/3.0.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/whatsnew/3.1.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/whatsnew/3.2.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/whatsnew/3.3.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/whatsnew/3.4.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/whatsnew/3.5.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/whatsnew/3.6.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/whatsnew/3.7.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/whatsnew/changelog.rst.txt create mode 100644 python-3.7.4-docs-html/_sources/whatsnew/index.rst.txt create mode 100644 python-3.7.4-docs-html/_static/ajax-loader.gif create mode 100644 python-3.7.4-docs-html/_static/basic.css create mode 100644 python-3.7.4-docs-html/_static/classic.css create mode 100644 python-3.7.4-docs-html/_static/comment-bright.png create mode 100644 python-3.7.4-docs-html/_static/comment-close.png create mode 100644 python-3.7.4-docs-html/_static/comment.png create mode 100644 python-3.7.4-docs-html/_static/copybutton.js create mode 100644 python-3.7.4-docs-html/_static/default.css create mode 100644 python-3.7.4-docs-html/_static/doctools.js create mode 100644 python-3.7.4-docs-html/_static/documentation_options.js create mode 100644 python-3.7.4-docs-html/_static/down-pressed.png create mode 100644 python-3.7.4-docs-html/_static/down.png create mode 100644 python-3.7.4-docs-html/_static/file.png create mode 100644 python-3.7.4-docs-html/_static/jquery-3.2.1.js create mode 100644 python-3.7.4-docs-html/_static/jquery.js create mode 100644 python-3.7.4-docs-html/_static/language_data.js create mode 100644 python-3.7.4-docs-html/_static/minus.png create mode 100644 python-3.7.4-docs-html/_static/opensearch.xml create mode 100644 python-3.7.4-docs-html/_static/plus.png create mode 100644 python-3.7.4-docs-html/_static/py.png create mode 100644 python-3.7.4-docs-html/_static/pydoctheme.css create mode 100644 python-3.7.4-docs-html/_static/pygments.css create mode 100644 python-3.7.4-docs-html/_static/searchtools.js create mode 100644 python-3.7.4-docs-html/_static/sidebar.js create mode 100644 python-3.7.4-docs-html/_static/switchers.js create mode 100644 python-3.7.4-docs-html/_static/underscore-1.3.1.js create mode 100644 python-3.7.4-docs-html/_static/underscore.js create mode 100644 python-3.7.4-docs-html/_static/up-pressed.png create mode 100644 python-3.7.4-docs-html/_static/up.png create mode 100644 python-3.7.4-docs-html/_static/websupport.js create mode 100644 python-3.7.4-docs-html/about.html create mode 100644 python-3.7.4-docs-html/bugs.html create mode 100644 python-3.7.4-docs-html/c-api/abstract.html create mode 100644 python-3.7.4-docs-html/c-api/allocation.html create mode 100644 python-3.7.4-docs-html/c-api/apiabiversion.html create mode 100644 python-3.7.4-docs-html/c-api/arg.html create mode 100644 python-3.7.4-docs-html/c-api/bool.html create mode 100644 python-3.7.4-docs-html/c-api/buffer.html create mode 100644 python-3.7.4-docs-html/c-api/bytearray.html create mode 100644 python-3.7.4-docs-html/c-api/bytes.html create mode 100644 python-3.7.4-docs-html/c-api/capsule.html create mode 100644 python-3.7.4-docs-html/c-api/cell.html create mode 100644 python-3.7.4-docs-html/c-api/code.html create mode 100644 python-3.7.4-docs-html/c-api/codec.html create mode 100644 python-3.7.4-docs-html/c-api/complex.html create mode 100644 python-3.7.4-docs-html/c-api/concrete.html create mode 100644 python-3.7.4-docs-html/c-api/contextvars.html create mode 100644 python-3.7.4-docs-html/c-api/conversion.html create mode 100644 python-3.7.4-docs-html/c-api/coro.html create mode 100644 python-3.7.4-docs-html/c-api/datetime.html create mode 100644 python-3.7.4-docs-html/c-api/descriptor.html create mode 100644 python-3.7.4-docs-html/c-api/dict.html create mode 100644 python-3.7.4-docs-html/c-api/exceptions.html create mode 100644 python-3.7.4-docs-html/c-api/file.html create mode 100644 python-3.7.4-docs-html/c-api/float.html create mode 100644 python-3.7.4-docs-html/c-api/function.html create mode 100644 python-3.7.4-docs-html/c-api/gcsupport.html create mode 100644 python-3.7.4-docs-html/c-api/gen.html create mode 100644 python-3.7.4-docs-html/c-api/import.html create mode 100644 python-3.7.4-docs-html/c-api/index.html create mode 100644 python-3.7.4-docs-html/c-api/init.html create mode 100644 python-3.7.4-docs-html/c-api/intro.html create mode 100644 python-3.7.4-docs-html/c-api/iter.html create mode 100644 python-3.7.4-docs-html/c-api/iterator.html create mode 100644 python-3.7.4-docs-html/c-api/list.html create mode 100644 python-3.7.4-docs-html/c-api/long.html create mode 100644 python-3.7.4-docs-html/c-api/mapping.html create mode 100644 python-3.7.4-docs-html/c-api/marshal.html create mode 100644 python-3.7.4-docs-html/c-api/memory.html create mode 100644 python-3.7.4-docs-html/c-api/memoryview.html create mode 100644 python-3.7.4-docs-html/c-api/method.html create mode 100644 python-3.7.4-docs-html/c-api/module.html create mode 100644 python-3.7.4-docs-html/c-api/none.html create mode 100644 python-3.7.4-docs-html/c-api/number.html create mode 100644 python-3.7.4-docs-html/c-api/objbuffer.html create mode 100644 python-3.7.4-docs-html/c-api/object.html create mode 100644 python-3.7.4-docs-html/c-api/objimpl.html create mode 100644 python-3.7.4-docs-html/c-api/refcounting.html create mode 100644 python-3.7.4-docs-html/c-api/reflection.html create mode 100644 python-3.7.4-docs-html/c-api/sequence.html create mode 100644 python-3.7.4-docs-html/c-api/set.html create mode 100644 python-3.7.4-docs-html/c-api/slice.html create mode 100644 python-3.7.4-docs-html/c-api/stable.html create mode 100644 python-3.7.4-docs-html/c-api/structures.html create mode 100644 python-3.7.4-docs-html/c-api/sys.html create mode 100644 python-3.7.4-docs-html/c-api/tuple.html create mode 100644 python-3.7.4-docs-html/c-api/type.html create mode 100644 python-3.7.4-docs-html/c-api/typeobj.html create mode 100644 python-3.7.4-docs-html/c-api/unicode.html create mode 100644 python-3.7.4-docs-html/c-api/utilities.html create mode 100644 python-3.7.4-docs-html/c-api/veryhigh.html create mode 100644 python-3.7.4-docs-html/c-api/weakref.html create mode 100644 python-3.7.4-docs-html/contents.html create mode 100644 python-3.7.4-docs-html/copyright.html create mode 100644 python-3.7.4-docs-html/distributing/index.html create mode 100644 python-3.7.4-docs-html/distutils/apiref.html create mode 100644 python-3.7.4-docs-html/distutils/builtdist.html create mode 100644 python-3.7.4-docs-html/distutils/commandref.html create mode 100644 python-3.7.4-docs-html/distutils/configfile.html create mode 100644 python-3.7.4-docs-html/distutils/examples.html create mode 100644 python-3.7.4-docs-html/distutils/extending.html create mode 100644 python-3.7.4-docs-html/distutils/index.html create mode 100644 python-3.7.4-docs-html/distutils/introduction.html create mode 100644 python-3.7.4-docs-html/distutils/packageindex.html create mode 100644 python-3.7.4-docs-html/distutils/setupscript.html create mode 100644 python-3.7.4-docs-html/distutils/sourcedist.html create mode 100644 python-3.7.4-docs-html/distutils/uploading.html create mode 100644 python-3.7.4-docs-html/download.html create mode 100644 python-3.7.4-docs-html/extending/building.html create mode 100644 python-3.7.4-docs-html/extending/embedding.html create mode 100644 python-3.7.4-docs-html/extending/extending.html create mode 100644 python-3.7.4-docs-html/extending/index.html create mode 100644 python-3.7.4-docs-html/extending/newtypes.html create mode 100644 python-3.7.4-docs-html/extending/newtypes_tutorial.html create mode 100644 python-3.7.4-docs-html/extending/windows.html create mode 100644 python-3.7.4-docs-html/faq/design.html create mode 100644 python-3.7.4-docs-html/faq/extending.html create mode 100644 python-3.7.4-docs-html/faq/general.html create mode 100644 python-3.7.4-docs-html/faq/gui.html create mode 100644 python-3.7.4-docs-html/faq/index.html create mode 100644 python-3.7.4-docs-html/faq/installed.html create mode 100644 python-3.7.4-docs-html/faq/library.html create mode 100644 python-3.7.4-docs-html/faq/programming.html create mode 100644 python-3.7.4-docs-html/faq/windows.html create mode 100644 python-3.7.4-docs-html/genindex-A.html create mode 100644 python-3.7.4-docs-html/genindex-B.html create mode 100644 python-3.7.4-docs-html/genindex-C.html create mode 100644 python-3.7.4-docs-html/genindex-D.html create mode 100644 python-3.7.4-docs-html/genindex-E.html create mode 100644 python-3.7.4-docs-html/genindex-F.html create mode 100644 python-3.7.4-docs-html/genindex-G.html create mode 100644 python-3.7.4-docs-html/genindex-H.html create mode 100644 python-3.7.4-docs-html/genindex-I.html create mode 100644 python-3.7.4-docs-html/genindex-J.html create mode 100644 python-3.7.4-docs-html/genindex-K.html create mode 100644 python-3.7.4-docs-html/genindex-L.html create mode 100644 python-3.7.4-docs-html/genindex-M.html create mode 100644 python-3.7.4-docs-html/genindex-N.html create mode 100644 python-3.7.4-docs-html/genindex-O.html create mode 100644 python-3.7.4-docs-html/genindex-P.html create mode 100644 python-3.7.4-docs-html/genindex-Q.html create mode 100644 python-3.7.4-docs-html/genindex-R.html create mode 100644 python-3.7.4-docs-html/genindex-S.html create mode 100644 python-3.7.4-docs-html/genindex-Symbols.html create mode 100644 python-3.7.4-docs-html/genindex-T.html create mode 100644 python-3.7.4-docs-html/genindex-U.html create mode 100644 python-3.7.4-docs-html/genindex-V.html create mode 100644 python-3.7.4-docs-html/genindex-W.html create mode 100644 python-3.7.4-docs-html/genindex-X.html create mode 100644 python-3.7.4-docs-html/genindex-Y.html create mode 100644 python-3.7.4-docs-html/genindex-Z.html create mode 100644 python-3.7.4-docs-html/genindex-_.html create mode 100644 python-3.7.4-docs-html/genindex-all.html create mode 100644 python-3.7.4-docs-html/genindex.html create mode 100644 python-3.7.4-docs-html/glossary.html create mode 100644 python-3.7.4-docs-html/howto/argparse.html create mode 100644 python-3.7.4-docs-html/howto/clinic.html create mode 100644 python-3.7.4-docs-html/howto/cporting.html create mode 100644 python-3.7.4-docs-html/howto/curses.html create mode 100644 python-3.7.4-docs-html/howto/descriptor.html create mode 100644 python-3.7.4-docs-html/howto/functional.html create mode 100644 python-3.7.4-docs-html/howto/index.html create mode 100644 python-3.7.4-docs-html/howto/instrumentation.html create mode 100644 python-3.7.4-docs-html/howto/ipaddress.html create mode 100644 python-3.7.4-docs-html/howto/logging-cookbook.html create mode 100644 python-3.7.4-docs-html/howto/logging.html create mode 100644 python-3.7.4-docs-html/howto/pyporting.html create mode 100644 python-3.7.4-docs-html/howto/regex.html create mode 100644 python-3.7.4-docs-html/howto/sockets.html create mode 100644 python-3.7.4-docs-html/howto/sorting.html create mode 100644 python-3.7.4-docs-html/howto/unicode.html create mode 100644 python-3.7.4-docs-html/howto/urllib2.html create mode 100644 python-3.7.4-docs-html/index.html create mode 100644 python-3.7.4-docs-html/install/index.html create mode 100644 python-3.7.4-docs-html/installing/index.html create mode 100644 python-3.7.4-docs-html/library/2to3.html create mode 100644 python-3.7.4-docs-html/library/__future__.html create mode 100644 python-3.7.4-docs-html/library/__main__.html create mode 100644 python-3.7.4-docs-html/library/_dummy_thread.html create mode 100644 python-3.7.4-docs-html/library/_thread.html create mode 100644 python-3.7.4-docs-html/library/abc.html create mode 100644 python-3.7.4-docs-html/library/aifc.html create mode 100644 python-3.7.4-docs-html/library/allos.html create mode 100644 python-3.7.4-docs-html/library/archiving.html create mode 100644 python-3.7.4-docs-html/library/argparse.html create mode 100644 python-3.7.4-docs-html/library/array.html create mode 100644 python-3.7.4-docs-html/library/ast.html create mode 100644 python-3.7.4-docs-html/library/asynchat.html create mode 100644 python-3.7.4-docs-html/library/asyncio-api-index.html create mode 100644 python-3.7.4-docs-html/library/asyncio-dev.html create mode 100644 python-3.7.4-docs-html/library/asyncio-eventloop.html create mode 100644 python-3.7.4-docs-html/library/asyncio-exceptions.html create mode 100644 python-3.7.4-docs-html/library/asyncio-future.html create mode 100644 python-3.7.4-docs-html/library/asyncio-llapi-index.html create mode 100644 python-3.7.4-docs-html/library/asyncio-platforms.html create mode 100644 python-3.7.4-docs-html/library/asyncio-policy.html create mode 100644 python-3.7.4-docs-html/library/asyncio-protocol.html create mode 100644 python-3.7.4-docs-html/library/asyncio-queue.html create mode 100644 python-3.7.4-docs-html/library/asyncio-stream.html create mode 100644 python-3.7.4-docs-html/library/asyncio-subprocess.html create mode 100644 python-3.7.4-docs-html/library/asyncio-sync.html create mode 100644 python-3.7.4-docs-html/library/asyncio-task.html create mode 100644 python-3.7.4-docs-html/library/asyncio.html create mode 100644 python-3.7.4-docs-html/library/asyncore.html create mode 100644 python-3.7.4-docs-html/library/atexit.html create mode 100644 python-3.7.4-docs-html/library/audioop.html create mode 100644 python-3.7.4-docs-html/library/base64.html create mode 100644 python-3.7.4-docs-html/library/bdb.html create mode 100644 python-3.7.4-docs-html/library/binary.html create mode 100644 python-3.7.4-docs-html/library/binascii.html create mode 100644 python-3.7.4-docs-html/library/binhex.html create mode 100644 python-3.7.4-docs-html/library/bisect.html create mode 100644 python-3.7.4-docs-html/library/builtins.html create mode 100644 python-3.7.4-docs-html/library/bz2.html create mode 100644 python-3.7.4-docs-html/library/calendar.html create mode 100644 python-3.7.4-docs-html/library/cgi.html create mode 100644 python-3.7.4-docs-html/library/cgitb.html create mode 100644 python-3.7.4-docs-html/library/chunk.html create mode 100644 python-3.7.4-docs-html/library/cmath.html create mode 100644 python-3.7.4-docs-html/library/cmd.html create mode 100644 python-3.7.4-docs-html/library/code.html create mode 100644 python-3.7.4-docs-html/library/codecs.html create mode 100644 python-3.7.4-docs-html/library/codeop.html create mode 100644 python-3.7.4-docs-html/library/collections.abc.html create mode 100644 python-3.7.4-docs-html/library/collections.html create mode 100644 python-3.7.4-docs-html/library/colorsys.html create mode 100644 python-3.7.4-docs-html/library/compileall.html create mode 100644 python-3.7.4-docs-html/library/concurrency.html create mode 100644 python-3.7.4-docs-html/library/concurrent.futures.html create mode 100644 python-3.7.4-docs-html/library/concurrent.html create mode 100644 python-3.7.4-docs-html/library/configparser.html create mode 100644 python-3.7.4-docs-html/library/constants.html create mode 100644 python-3.7.4-docs-html/library/contextlib.html create mode 100644 python-3.7.4-docs-html/library/contextvars.html create mode 100644 python-3.7.4-docs-html/library/copy.html create mode 100644 python-3.7.4-docs-html/library/copyreg.html create mode 100644 python-3.7.4-docs-html/library/crypt.html create mode 100644 python-3.7.4-docs-html/library/crypto.html create mode 100644 python-3.7.4-docs-html/library/csv.html create mode 100644 python-3.7.4-docs-html/library/ctypes.html create mode 100644 python-3.7.4-docs-html/library/curses.ascii.html create mode 100644 python-3.7.4-docs-html/library/curses.html create mode 100644 python-3.7.4-docs-html/library/curses.panel.html create mode 100644 python-3.7.4-docs-html/library/custominterp.html create mode 100644 python-3.7.4-docs-html/library/dataclasses.html create mode 100644 python-3.7.4-docs-html/library/datatypes.html create mode 100644 python-3.7.4-docs-html/library/datetime.html create mode 100644 python-3.7.4-docs-html/library/dbm.html create mode 100644 python-3.7.4-docs-html/library/debug.html create mode 100644 python-3.7.4-docs-html/library/decimal.html create mode 100644 python-3.7.4-docs-html/library/development.html create mode 100644 python-3.7.4-docs-html/library/difflib.html create mode 100644 python-3.7.4-docs-html/library/dis.html create mode 100644 python-3.7.4-docs-html/library/distribution.html create mode 100644 python-3.7.4-docs-html/library/distutils.html create mode 100644 python-3.7.4-docs-html/library/doctest.html create mode 100644 python-3.7.4-docs-html/library/dummy_threading.html create mode 100644 python-3.7.4-docs-html/library/email.charset.html create mode 100644 python-3.7.4-docs-html/library/email.compat32-message.html create mode 100644 python-3.7.4-docs-html/library/email.contentmanager.html create mode 100644 python-3.7.4-docs-html/library/email.encoders.html create mode 100644 python-3.7.4-docs-html/library/email.errors.html create mode 100644 python-3.7.4-docs-html/library/email.examples.html create mode 100644 python-3.7.4-docs-html/library/email.generator.html create mode 100644 python-3.7.4-docs-html/library/email.header.html create mode 100644 python-3.7.4-docs-html/library/email.headerregistry.html create mode 100644 python-3.7.4-docs-html/library/email.html create mode 100644 python-3.7.4-docs-html/library/email.iterators.html create mode 100644 python-3.7.4-docs-html/library/email.message.html create mode 100644 python-3.7.4-docs-html/library/email.mime.html create mode 100644 python-3.7.4-docs-html/library/email.parser.html create mode 100644 python-3.7.4-docs-html/library/email.policy.html create mode 100644 python-3.7.4-docs-html/library/email.utils.html create mode 100644 python-3.7.4-docs-html/library/ensurepip.html create mode 100644 python-3.7.4-docs-html/library/enum.html create mode 100644 python-3.7.4-docs-html/library/errno.html create mode 100644 python-3.7.4-docs-html/library/exceptions.html create mode 100644 python-3.7.4-docs-html/library/faulthandler.html create mode 100644 python-3.7.4-docs-html/library/fcntl.html create mode 100644 python-3.7.4-docs-html/library/filecmp.html create mode 100644 python-3.7.4-docs-html/library/fileformats.html create mode 100644 python-3.7.4-docs-html/library/fileinput.html create mode 100644 python-3.7.4-docs-html/library/filesys.html create mode 100644 python-3.7.4-docs-html/library/fnmatch.html create mode 100644 python-3.7.4-docs-html/library/formatter.html create mode 100644 python-3.7.4-docs-html/library/fractions.html create mode 100644 python-3.7.4-docs-html/library/frameworks.html create mode 100644 python-3.7.4-docs-html/library/ftplib.html create mode 100644 python-3.7.4-docs-html/library/functional.html create mode 100644 python-3.7.4-docs-html/library/functions.html create mode 100644 python-3.7.4-docs-html/library/functools.html create mode 100644 python-3.7.4-docs-html/library/gc.html create mode 100644 python-3.7.4-docs-html/library/getopt.html create mode 100644 python-3.7.4-docs-html/library/getpass.html create mode 100644 python-3.7.4-docs-html/library/gettext.html create mode 100644 python-3.7.4-docs-html/library/glob.html create mode 100644 python-3.7.4-docs-html/library/grp.html create mode 100644 python-3.7.4-docs-html/library/gzip.html create mode 100644 python-3.7.4-docs-html/library/hashlib.html create mode 100644 python-3.7.4-docs-html/library/heapq.html create mode 100644 python-3.7.4-docs-html/library/hmac.html create mode 100644 python-3.7.4-docs-html/library/html.entities.html create mode 100644 python-3.7.4-docs-html/library/html.html create mode 100644 python-3.7.4-docs-html/library/html.parser.html create mode 100644 python-3.7.4-docs-html/library/http.client.html create mode 100644 python-3.7.4-docs-html/library/http.cookiejar.html create mode 100644 python-3.7.4-docs-html/library/http.cookies.html create mode 100644 python-3.7.4-docs-html/library/http.html create mode 100644 python-3.7.4-docs-html/library/http.server.html create mode 100644 python-3.7.4-docs-html/library/i18n.html create mode 100644 python-3.7.4-docs-html/library/idle.html create mode 100644 python-3.7.4-docs-html/library/imaplib.html create mode 100644 python-3.7.4-docs-html/library/imghdr.html create mode 100644 python-3.7.4-docs-html/library/imp.html create mode 100644 python-3.7.4-docs-html/library/importlib.html create mode 100644 python-3.7.4-docs-html/library/index.html create mode 100644 python-3.7.4-docs-html/library/inspect.html create mode 100644 python-3.7.4-docs-html/library/internet.html create mode 100644 python-3.7.4-docs-html/library/intro.html create mode 100644 python-3.7.4-docs-html/library/io.html create mode 100644 python-3.7.4-docs-html/library/ipaddress.html create mode 100644 python-3.7.4-docs-html/library/ipc.html create mode 100644 python-3.7.4-docs-html/library/itertools.html create mode 100644 python-3.7.4-docs-html/library/json.html create mode 100644 python-3.7.4-docs-html/library/keyword.html create mode 100644 python-3.7.4-docs-html/library/language.html create mode 100644 python-3.7.4-docs-html/library/linecache.html create mode 100644 python-3.7.4-docs-html/library/locale.html create mode 100644 python-3.7.4-docs-html/library/logging.config.html create mode 100644 python-3.7.4-docs-html/library/logging.handlers.html create mode 100644 python-3.7.4-docs-html/library/logging.html create mode 100644 python-3.7.4-docs-html/library/lzma.html create mode 100644 python-3.7.4-docs-html/library/macpath.html create mode 100644 python-3.7.4-docs-html/library/mailbox.html create mode 100644 python-3.7.4-docs-html/library/mailcap.html create mode 100644 python-3.7.4-docs-html/library/markup.html create mode 100644 python-3.7.4-docs-html/library/marshal.html create mode 100644 python-3.7.4-docs-html/library/math.html create mode 100644 python-3.7.4-docs-html/library/mimetypes.html create mode 100644 python-3.7.4-docs-html/library/misc.html create mode 100644 python-3.7.4-docs-html/library/mm.html create mode 100644 python-3.7.4-docs-html/library/mmap.html create mode 100644 python-3.7.4-docs-html/library/modulefinder.html create mode 100644 python-3.7.4-docs-html/library/modules.html create mode 100644 python-3.7.4-docs-html/library/msilib.html create mode 100644 python-3.7.4-docs-html/library/msvcrt.html create mode 100644 python-3.7.4-docs-html/library/multiprocessing.html create mode 100644 python-3.7.4-docs-html/library/netdata.html create mode 100644 python-3.7.4-docs-html/library/netrc.html create mode 100644 python-3.7.4-docs-html/library/nis.html create mode 100644 python-3.7.4-docs-html/library/nntplib.html create mode 100644 python-3.7.4-docs-html/library/numbers.html create mode 100644 python-3.7.4-docs-html/library/numeric.html create mode 100644 python-3.7.4-docs-html/library/operator.html create mode 100644 python-3.7.4-docs-html/library/optparse.html create mode 100644 python-3.7.4-docs-html/library/os.html create mode 100644 python-3.7.4-docs-html/library/os.path.html create mode 100644 python-3.7.4-docs-html/library/ossaudiodev.html create mode 100644 python-3.7.4-docs-html/library/othergui.html create mode 100644 python-3.7.4-docs-html/library/parser.html create mode 100644 python-3.7.4-docs-html/library/pathlib.html create mode 100644 python-3.7.4-docs-html/library/pdb.html create mode 100644 python-3.7.4-docs-html/library/persistence.html create mode 100644 python-3.7.4-docs-html/library/pickle.html create mode 100644 python-3.7.4-docs-html/library/pickletools.html create mode 100644 python-3.7.4-docs-html/library/pipes.html create mode 100644 python-3.7.4-docs-html/library/pkgutil.html create mode 100644 python-3.7.4-docs-html/library/platform.html create mode 100644 python-3.7.4-docs-html/library/plistlib.html create mode 100644 python-3.7.4-docs-html/library/poplib.html create mode 100644 python-3.7.4-docs-html/library/posix.html create mode 100644 python-3.7.4-docs-html/library/pprint.html create mode 100644 python-3.7.4-docs-html/library/profile.html create mode 100644 python-3.7.4-docs-html/library/pty.html create mode 100644 python-3.7.4-docs-html/library/pwd.html create mode 100644 python-3.7.4-docs-html/library/py_compile.html create mode 100644 python-3.7.4-docs-html/library/pyclbr.html create mode 100644 python-3.7.4-docs-html/library/pydoc.html create mode 100644 python-3.7.4-docs-html/library/pyexpat.html create mode 100644 python-3.7.4-docs-html/library/python.html create mode 100644 python-3.7.4-docs-html/library/queue.html create mode 100644 python-3.7.4-docs-html/library/quopri.html create mode 100644 python-3.7.4-docs-html/library/random.html create mode 100644 python-3.7.4-docs-html/library/re.html create mode 100644 python-3.7.4-docs-html/library/readline.html create mode 100644 python-3.7.4-docs-html/library/reprlib.html create mode 100644 python-3.7.4-docs-html/library/resource.html create mode 100644 python-3.7.4-docs-html/library/rlcompleter.html create mode 100644 python-3.7.4-docs-html/library/runpy.html create mode 100644 python-3.7.4-docs-html/library/sched.html create mode 100644 python-3.7.4-docs-html/library/secrets.html create mode 100644 python-3.7.4-docs-html/library/select.html create mode 100644 python-3.7.4-docs-html/library/selectors.html create mode 100644 python-3.7.4-docs-html/library/shelve.html create mode 100644 python-3.7.4-docs-html/library/shlex.html create mode 100644 python-3.7.4-docs-html/library/shutil.html create mode 100644 python-3.7.4-docs-html/library/signal.html create mode 100644 python-3.7.4-docs-html/library/site.html create mode 100644 python-3.7.4-docs-html/library/smtpd.html create mode 100644 python-3.7.4-docs-html/library/smtplib.html create mode 100644 python-3.7.4-docs-html/library/sndhdr.html create mode 100644 python-3.7.4-docs-html/library/socket.html create mode 100644 python-3.7.4-docs-html/library/socketserver.html create mode 100644 python-3.7.4-docs-html/library/spwd.html create mode 100644 python-3.7.4-docs-html/library/sqlite3.html create mode 100644 python-3.7.4-docs-html/library/ssl.html create mode 100644 python-3.7.4-docs-html/library/stat.html create mode 100644 python-3.7.4-docs-html/library/statistics.html create mode 100644 python-3.7.4-docs-html/library/stdtypes.html create mode 100644 python-3.7.4-docs-html/library/string.html create mode 100644 python-3.7.4-docs-html/library/stringprep.html create mode 100644 python-3.7.4-docs-html/library/struct.html create mode 100644 python-3.7.4-docs-html/library/subprocess.html create mode 100644 python-3.7.4-docs-html/library/sunau.html create mode 100644 python-3.7.4-docs-html/library/superseded.html create mode 100644 python-3.7.4-docs-html/library/symbol.html create mode 100644 python-3.7.4-docs-html/library/symtable.html create mode 100644 python-3.7.4-docs-html/library/sys.html create mode 100644 python-3.7.4-docs-html/library/sysconfig.html create mode 100644 python-3.7.4-docs-html/library/syslog.html create mode 100644 python-3.7.4-docs-html/library/tabnanny.html create mode 100644 python-3.7.4-docs-html/library/tarfile.html create mode 100644 python-3.7.4-docs-html/library/telnetlib.html create mode 100644 python-3.7.4-docs-html/library/tempfile.html create mode 100644 python-3.7.4-docs-html/library/termios.html create mode 100644 python-3.7.4-docs-html/library/test.html create mode 100644 python-3.7.4-docs-html/library/text.html create mode 100644 python-3.7.4-docs-html/library/textwrap.html create mode 100644 python-3.7.4-docs-html/library/threading.html create mode 100644 python-3.7.4-docs-html/library/time.html create mode 100644 python-3.7.4-docs-html/library/timeit.html create mode 100644 python-3.7.4-docs-html/library/tk.html create mode 100644 python-3.7.4-docs-html/library/tkinter.html create mode 100644 python-3.7.4-docs-html/library/tkinter.scrolledtext.html create mode 100644 python-3.7.4-docs-html/library/tkinter.tix.html create mode 100644 python-3.7.4-docs-html/library/tkinter.ttk.html create mode 100644 python-3.7.4-docs-html/library/token.html create mode 100644 python-3.7.4-docs-html/library/tokenize.html create mode 100644 python-3.7.4-docs-html/library/trace.html create mode 100644 python-3.7.4-docs-html/library/traceback.html create mode 100644 python-3.7.4-docs-html/library/tracemalloc.html create mode 100644 python-3.7.4-docs-html/library/tty.html create mode 100644 python-3.7.4-docs-html/library/turtle.html create mode 100644 python-3.7.4-docs-html/library/types.html create mode 100644 python-3.7.4-docs-html/library/typing.html create mode 100644 python-3.7.4-docs-html/library/undoc.html create mode 100644 python-3.7.4-docs-html/library/unicodedata.html create mode 100644 python-3.7.4-docs-html/library/unittest.html create mode 100644 python-3.7.4-docs-html/library/unittest.mock-examples.html create mode 100644 python-3.7.4-docs-html/library/unittest.mock.html create mode 100644 python-3.7.4-docs-html/library/unix.html create mode 100644 python-3.7.4-docs-html/library/urllib.error.html create mode 100644 python-3.7.4-docs-html/library/urllib.html create mode 100644 python-3.7.4-docs-html/library/urllib.parse.html create mode 100644 python-3.7.4-docs-html/library/urllib.request.html create mode 100644 python-3.7.4-docs-html/library/urllib.robotparser.html create mode 100644 python-3.7.4-docs-html/library/uu.html create mode 100644 python-3.7.4-docs-html/library/uuid.html create mode 100644 python-3.7.4-docs-html/library/venv.html create mode 100644 python-3.7.4-docs-html/library/warnings.html create mode 100644 python-3.7.4-docs-html/library/wave.html create mode 100644 python-3.7.4-docs-html/library/weakref.html create mode 100644 python-3.7.4-docs-html/library/webbrowser.html create mode 100644 python-3.7.4-docs-html/library/windows.html create mode 100644 python-3.7.4-docs-html/library/winreg.html create mode 100644 python-3.7.4-docs-html/library/winsound.html create mode 100644 python-3.7.4-docs-html/library/wsgiref.html create mode 100644 python-3.7.4-docs-html/library/xdrlib.html create mode 100644 python-3.7.4-docs-html/library/xml.dom.html create mode 100644 python-3.7.4-docs-html/library/xml.dom.minidom.html create mode 100644 python-3.7.4-docs-html/library/xml.dom.pulldom.html create mode 100644 python-3.7.4-docs-html/library/xml.etree.elementtree.html create mode 100644 python-3.7.4-docs-html/library/xml.html create mode 100644 python-3.7.4-docs-html/library/xml.sax.handler.html create mode 100644 python-3.7.4-docs-html/library/xml.sax.html create mode 100644 python-3.7.4-docs-html/library/xml.sax.reader.html create mode 100644 python-3.7.4-docs-html/library/xml.sax.utils.html create mode 100644 python-3.7.4-docs-html/library/xmlrpc.client.html create mode 100644 python-3.7.4-docs-html/library/xmlrpc.html create mode 100644 python-3.7.4-docs-html/library/xmlrpc.server.html create mode 100644 python-3.7.4-docs-html/library/zipapp.html create mode 100644 python-3.7.4-docs-html/library/zipfile.html create mode 100644 python-3.7.4-docs-html/library/zipimport.html create mode 100644 python-3.7.4-docs-html/library/zlib.html create mode 100644 python-3.7.4-docs-html/license.html create mode 100644 python-3.7.4-docs-html/objects.inv create mode 100644 python-3.7.4-docs-html/py-modindex.html create mode 100644 python-3.7.4-docs-html/reference/compound_stmts.html create mode 100644 python-3.7.4-docs-html/reference/datamodel.html create mode 100644 python-3.7.4-docs-html/reference/executionmodel.html create mode 100644 python-3.7.4-docs-html/reference/expressions.html create mode 100644 python-3.7.4-docs-html/reference/grammar.html create mode 100644 python-3.7.4-docs-html/reference/import.html create mode 100644 python-3.7.4-docs-html/reference/index.html create mode 100644 python-3.7.4-docs-html/reference/introduction.html create mode 100644 python-3.7.4-docs-html/reference/lexical_analysis.html create mode 100644 python-3.7.4-docs-html/reference/simple_stmts.html create mode 100644 python-3.7.4-docs-html/reference/toplevel_components.html create mode 100644 python-3.7.4-docs-html/search.html create mode 100644 python-3.7.4-docs-html/searchindex.js create mode 100644 python-3.7.4-docs-html/tutorial/appendix.html create mode 100644 python-3.7.4-docs-html/tutorial/appetite.html create mode 100644 python-3.7.4-docs-html/tutorial/classes.html create mode 100644 python-3.7.4-docs-html/tutorial/controlflow.html create mode 100644 python-3.7.4-docs-html/tutorial/datastructures.html create mode 100644 python-3.7.4-docs-html/tutorial/errors.html create mode 100644 python-3.7.4-docs-html/tutorial/floatingpoint.html create mode 100644 python-3.7.4-docs-html/tutorial/index.html create mode 100644 python-3.7.4-docs-html/tutorial/inputoutput.html create mode 100644 python-3.7.4-docs-html/tutorial/interactive.html create mode 100644 python-3.7.4-docs-html/tutorial/interpreter.html create mode 100644 python-3.7.4-docs-html/tutorial/introduction.html create mode 100644 python-3.7.4-docs-html/tutorial/modules.html create mode 100644 python-3.7.4-docs-html/tutorial/stdlib.html create mode 100644 python-3.7.4-docs-html/tutorial/stdlib2.html create mode 100644 python-3.7.4-docs-html/tutorial/venv.html create mode 100644 python-3.7.4-docs-html/tutorial/whatnow.html create mode 100644 python-3.7.4-docs-html/using/cmdline.html create mode 100644 python-3.7.4-docs-html/using/index.html create mode 100644 python-3.7.4-docs-html/using/mac.html create mode 100644 python-3.7.4-docs-html/using/unix.html create mode 100644 python-3.7.4-docs-html/using/windows.html create mode 100644 python-3.7.4-docs-html/whatsnew/2.0.html create mode 100644 python-3.7.4-docs-html/whatsnew/2.1.html create mode 100644 python-3.7.4-docs-html/whatsnew/2.2.html create mode 100644 python-3.7.4-docs-html/whatsnew/2.3.html create mode 100644 python-3.7.4-docs-html/whatsnew/2.4.html create mode 100644 python-3.7.4-docs-html/whatsnew/2.5.html create mode 100644 python-3.7.4-docs-html/whatsnew/2.6.html create mode 100644 python-3.7.4-docs-html/whatsnew/2.7.html create mode 100644 python-3.7.4-docs-html/whatsnew/3.0.html create mode 100644 python-3.7.4-docs-html/whatsnew/3.1.html create mode 100644 python-3.7.4-docs-html/whatsnew/3.2.html create mode 100644 python-3.7.4-docs-html/whatsnew/3.3.html create mode 100644 python-3.7.4-docs-html/whatsnew/3.4.html create mode 100644 python-3.7.4-docs-html/whatsnew/3.5.html create mode 100644 python-3.7.4-docs-html/whatsnew/3.6.html create mode 100644 python-3.7.4-docs-html/whatsnew/3.7.html create mode 100644 python-3.7.4-docs-html/whatsnew/changelog.html create mode 100644 python-3.7.4-docs-html/whatsnew/index.html create mode 100644 stories.txt create mode 100644 storyCount.txt create mode 100644 test.py diff --git a/Fwd: programming project.eml b/Fwd: programming project.eml new file mode 100644 index 0000000..6705bff --- /dev/null +++ b/Fwd: programming project.eml @@ -0,0 +1,321 @@ +Delivered-To: foley2431@gmail.com +Received: by 2002:a17:90a:62c9:0:0:0:0 with SMTP id k9csp2454751pjs; + Thu, 27 Jun 2019 12:38:59 -0700 (PDT) +X-Received: by 2002:a5d:8c81:: with SMTP id g1mr6741349ion.239.1561664339657; + Thu, 27 Jun 2019 12:38:59 -0700 (PDT) +ARC-Seal: i=1; a=rsa-sha256; t=1561664339; cv=none; + d=google.com; s=arc-20160816; + b=xwzygQkNBl4RrUe3SLUOiKF7PZxhy8sP1WgDrmfbrfYM84V5UEaqNbp3NmvKeJzMwj + /T4ylHAy4x6+qe5E78c+Db+WyrCNwo7MLZgGUm16SXrO4lQRDV2hE2oRep34VzGbywbp + S3vYW2tvMRj2sBT4L+grmerBo4J4HO7bu3fBrCth8xDwgVMFcDWKgEDmJqMTSDcti6Zt + TSiKIQtoLWeoB0w6TC+Xnxx+N3qxBaGStsJ217Atz9mbwF5gy7pQV5ZIlTbFfclgc5pt + bPjqQgr+aLcVpzKRlNNkz1jOlQrhu+Zxkhv1AFBPHrV4ofO7Lrwkp5by0HRj2z9AX+qE + z68Q== +ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; + h=to:subject:message-id:date:from:in-reply-to:references:mime-version + :dkim-signature; + bh=nYbTDDD7FDOcAyeQOYg4aeTL1X63lWkIu4z5s6n/X8M=; + b=BdTBGL/9qyt1R2BsTWA/mSyXmYOWajowJVGQv9paSMx3pmpM3FpYdtQLFSi8vFVBjN + OTA6E6C5DQKxPgrWwAzDD21CoAJtlbVY08b6W4Sy0XU7Oj281/Yufi/DVt0xOVaPAqLd + ASYBVOIvzEFHw8OYouCGmEcEEAYyFxcXuzjVJG9DH6GZrju6ezCjhoVsPZX0pbVn8PGE + wTe2dLrWxw9h6wuTx+KDuXFRuaDy05+naA++h6p6XQSbZDP+Vu7AFKGgF2gBzq9spB67 + R449QrBQsLbKy8zB2XTjVzrfZyHRpTgEmwjvzbOwlNiqikMLnSmw+9O3k7UOWr1PFgtH + YtCw== +ARC-Authentication-Results: i=1; mx.google.com; + dkim=pass header.i=@pediatrictlc-com.20150623.gappssmtp.com header.s=20150623 header.b=RWAkpuKx; + spf=pass (google.com: domain of allison@pediatrictlc.com designates 209.85.220.41 as permitted sender) smtp.mailfrom=allison@pediatrictlc.com +Return-Path: +Received: from mail-sor-f41.google.com (mail-sor-f41.google.com. [209.85.220.41]) + by mx.google.com with SMTPS id h73sor2480973iof.22.2019.06.27.12.38.59 + for + (Google Transport Security); + Thu, 27 Jun 2019 12:38:59 -0700 (PDT) +Received-SPF: pass (google.com: domain of allison@pediatrictlc.com designates 209.85.220.41 as permitted sender) client-ip=209.85.220.41; +Authentication-Results: mx.google.com; + dkim=pass header.i=@pediatrictlc-com.20150623.gappssmtp.com header.s=20150623 header.b=RWAkpuKx; + spf=pass (google.com: domain of allison@pediatrictlc.com designates 209.85.220.41 as permitted sender) smtp.mailfrom=allison@pediatrictlc.com +DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; + d=pediatrictlc-com.20150623.gappssmtp.com; s=20150623; + h=mime-version:references:in-reply-to:from:date:message-id:subject:to; + bh=nYbTDDD7FDOcAyeQOYg4aeTL1X63lWkIu4z5s6n/X8M=; + b=RWAkpuKxnJg6AohdfEJv/tzlDQOwcq0wZECjd1hFreSIf+60mbeCCKkxqotM9Lg+sE + VWYxDCr7091xAXadjxloW/QWmoD3GOU4Tu4heSfooObaiicb7aYmY6dlXVjSCdJEsDxd + 4mr/idEDnQIY1qppCnDDpSpaiA08Me7aIjU4CBIRWMVRH25vWWGYjo3j/kRslTKqSphs + imdHq0vum0BeC+C9Yt8gqJoL51wHCf8hggArH1oHgdToH9eYA2jQB0DG7FTW7zMutalA + UVn/l3B4rR6dOGKbmqo7BXz2mbjl74dEDpEC/9yU4TaY3I40T94EC8CYvHwzr/7r1kEI + Z5EQ== +X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; + d=1e100.net; s=20161025; + h=x-gm-message-state:mime-version:references:in-reply-to:from:date + :message-id:subject:to; + bh=nYbTDDD7FDOcAyeQOYg4aeTL1X63lWkIu4z5s6n/X8M=; + b=dk44IpPiycZmUEXFojs8OUTzsG8QOkHUCD6O+osQaBrUCYRO81FkosO+YWH2ArqgMg + QVSV9kqBr73jeEIC1wLaYPEU9XYs3MIr29B7VRJFUe6A6mUiH48OyekwGvrsL4EI68A8 + cvGO8Pnp5dqiBXMOLofRRZsmikX5XkymHI7S9JuSGxaNT7afgS2IzlcWKI+Qsr6Py4dP + XU5ftImgffmaE3pE26UP8Kp3/QUK7xjjjhxo1DnCThFqiez2qtp65mSWvmH0kdOqq5kO + Z3yf2LZdmNyJobmlQBZRu50yNH25WoPHoXO0tZBJ+zw3lvOztD0S2i2v4D9APx48wWZh + PL6A== +X-Gm-Message-State: APjAAAVQ8Du7W67tJzbWI4CEGdZbTiifWElaj6X90wzWIW+SgV03Sw1w + lDVmGKaNgxECarZphrJ8BjA1nSFD4iDlB6FqsBa91Fwy +X-Google-Smtp-Source: APXvYqwBIap+WFhQUS6PQI4MjFopvdAdUzZTvgT6LsgOFDvc7GvdJiPZMbjWw/nw0MMc8+pVW8ODUXrfuDgx7nYKMPs= +X-Received: by 2002:a6b:6f0e:: with SMTP id k14mr6492400ioc.257.1561664338861; + Thu, 27 Jun 2019 12:38:58 -0700 (PDT) +MIME-Version: 1.0 +References: + +In-Reply-To: +From: Allison LeBouef +Date: Thu, 27 Jun 2019 14:38:46 -0500 +Message-ID: +Subject: Fwd: programming project +To: foley2431@gmail.com +Content-Type: multipart/alternative; boundary="0000000000002d3380058c535034" + +--0000000000002d3380058c535034 +Content-Type: text/plain; charset="UTF-8" +Content-Transfer-Encoding: quoted-printable + +---------- Forwarded message --------- +From: Andy LeGoullon +Date: Thu, Jun 20, 2019 at 12:14 AM +Subject: Re: programming project +To: Allison LeBouef + + +Here's the MadLibs project I give to my students. If Caleb wants to do this +project, have him do as much as he can on his own and then he can email me +with questions when he gets stuck. If he'd rather do some other project +that he thinks up, I could help him with that too. + +Andy + +Programming Project: MadLibs + + + 1. + + Write a MadLibs story containing 10 or so prompts (words you will ask + the user to enter, for example a noun, a country, a snack food, etc). Th= +e + story can be about anything you want: How to catch a fish, how to bake a + cake, what happens during a trip to Disney World, etc. + 2. + + Make a file called madlibs.py. This file will contain all the python + code to play your Madlibs. Add code to this file that does the following= +: + 1. + + Asks the first prompt, for example, "Enter the name of a vegetable" + 2. + + Store the user's entered word in a variable. + 3. + + Repeat these two tasks for all the remaining prompts. + 4. + + Print out the completed MadLibs story, replacing the prompts with the + words stored in the variables. + 3. + + Run your program and make sure it works correctly. + + + +On Fri, Jun 14, 2019 at 9:48 AM Allison LeBouef +wrote: + +> I love Madlibs! I like the idea of getting him to formulate the questions +> he needs to ask too. Let=E2=80=99s try it and see what happens! Thanks so= + much for +> helping me with this +> Allison +> +> Sent from my iPhone +> +> > On Jun 14, 2019, at 8:55 AM, Andy LeGoullon +> wrote: +> > +> > Are you familiar with Madlibs? I was thinking of having Caleb make a +> computer program version of Madlibs as his first project. It's more of an +> intermediate level project, but not impossible for someone starting out a= +nd +> it sounds like he's looking for a challenge. I can give you the project +> details if you think this would work out. +> > +> > He would definitely need some assistance on it at times, but it would +> give him good experience asking for help. I could help him out via +> email/phone. Or I can come in if he is getting very frustrated. Anna know= +s +> Python and may also be willing to help. +> > +> > Andy +> + + +--=20 +Allison LeBouef, LOTR/ OT supervisor +Pediatric Therapy and Learning Center, LLC +108 Energy Pkwy +Lafayette, LA 70508 +(337)504-4244 +fax (337)706-7612 +www.pediatrictlc.com + +*Important Confidentiality Information:* + +The information contained in this transmission may contain privileged and +confidential information, including patient information protected by +federal and state privacy laws. It is intended only for the use of the +person(s) named above. If you are not the intended recipient, any review, +dissemination, distribution, or duplication of this communication is +strictly prohibited. If you are not the intended recipient, please contact +the sender by calling 337-504-4244 <(337)%20504-4244>. Feel free to leave +a voice message stating the sender and the subject line. Please destroy all +copies of the original message. + +Clients: Please note that this is not an encrypted email which means that +the e-mail and any information it contains could be unknowingly +intercepted. Please consider this in all future correspondence. + +--0000000000002d3380058c535034 +Content-Type: text/html; charset="UTF-8" +Content-Transfer-Encoding: quoted-printable + +


---------- Forwarded message ---------
From: Andy LeGoullon <andylegoullon@gmail.com= +>
Date: Thu, Jun 20, 2019 at 12:14 AM
Subject: Re: prog= +ramming project
To: Allison LeBouef <allison@pediatrictlc.com>


Here's the MadLibs project I give to my students. If Caleb wants to= + do this project, have him do as much as he can on his own and then he can = +email me with questions when he gets stuck. If he'd rather do some othe= +r project that he thinks up, I could help him with that too.=C2=A0

= +
Andy

Prog= +ramming Project: MadLibs


  1. Write a MadLibs story containing 10 or so = +prompts (words you will ask the user to enter, for example a noun, a countr= +y, a snack food, etc). The story can be about anything you want: How to cat= +ch a fish, how to bake a cake, what happens during a trip to Disney World, = +etc.

  2. Make a file called madlibs.py. This file will cont= +ain all the python code to play your Madlibs. Add code to this file that do= +es the following:

    1. Asks the first prompt, for example, "En= +ter the name of a vegetable"

    2. = +Store the user's entered word in a variable.

    3. Repeat these two tasks for all the remaining prompts.= +

    4. Print out the completed MadLibs story, r= +eplacing the prompts with the words stored in the variables.

  3. Run your program and make sure it works correct= +ly.



On Fri, Jun 14, 2019 at= + 9:48 AM Allison LeBouef <allison@pediatrictlc.com> wrote:
I love Madlibs! I like the idea of = +getting him to formulate the questions he needs to ask too. Let=E2=80=99s t= +ry it and see what happens! Thanks so much for helping me with this
+Allison
+
+Sent from my iPhone
+
+> On Jun 14, 2019, at 8:55 AM, Andy LeGoullon <andylegoullon@gmail.com> wrot= +e:
+>
+> Are you familiar with Madlibs? I was thinking of having Caleb make a c= +omputer program version of Madlibs as his first project. It's more of a= +n intermediate level project, but not impossible for someone starting out a= +nd it sounds like he's looking for a challenge. I can give you the proj= +ect details if you think this would work out.
+>
+> He would definitely need some assistance on it at times, but it would = +give him good experience asking for help. I could help him out via email/ph= +one. Or I can come in if he is getting very frustrated. Anna knows Python a= +nd may also be willing to help.
+>
+> Andy
+
+


--
Allison LeBouef, LOTR/ OT supervisor
+
Pediatric Therapy and Learning Center, LLC
+
108 Energy Pkwy
+
Lafayette, LA=C2=A0 70508
(337)504-4244
fax (337)7= +06-7612

Important Confidentia= +lity Information:

The information contained in this transmission may= + contain privileged and confidential information, including patient informa= +tion protected by federal and state privacy laws. It is intended only for t= +he use of the person(s) named above. If you are not the intended recipient,= + any review, dissemination, distribution, or duplication of this communicat= +ion is strictly prohibited. If you are not the intended recipient, please c= +ontact the sender by calling=C2=A0337-504-424= +4.=C2=A0 Feel free to leave a voice message stating the sender and the = +subject line. Please destroy all copies of the original message.

Clients: Ple= +ase note that this is not an encrypted email which means that the e-mail an= +d any information it contains could be unknowingly intercepted.=C2=A0 Pleas= +e consider this in all future correspondence.=C2=A0

+ +--0000000000002d3380058c535034-- diff --git a/madlibs.py b/madlibs.py new file mode 100644 index 0000000..f1434ed --- /dev/null +++ b/madlibs.py @@ -0,0 +1,83 @@ +# Toggle me for debugging +debug = 1 + +# Import the libraries we will use +import re +import sys +import random +import platform +import argparse +# check to see if termcolor is installed, we need it for color to xwork +try: + from termcolor import colored +except ImportError: + print("termcolor is not installed! Please install termcolor with" '\n', '\n', "pip install termcolor", '\n','\n'+"Note: You may need to run pip as root") + exit() +if debug == 1: + print("termcolor is installed!") +# If we are on Windows, we need to do a little more to get color to work +if platform.system() == 'Windows': + import os + os.system('color') +# ArgSparce +parser = argparse.ArgumentParser() +parser.add_argument("-s", "--setup", help="Explains how to setup .txt file", action="store_true") +parser.add_argument("-c", "--story", type=int, help="Write story count to file") +args = parser.parse_args() +# convert the integer to a string because pickiness +StoryCount = str(args.story) + +#if statements for ArgSparce + +# line 35 fails if args.story reads as "None", so we need to clear that string if it reads as such. +if args.story == None: + exec('args.story = int(0)') +# args.story should now read as 0 +if args.story > 0: + f = open('storyCount.txt', 'w') + f.write(StoryCount) + f.close() + exit() + print("Writing", StoryCount, "to txt file!") +if args.setup == True: + sys.exit("If you want to include your own MadLibs story, you need to do the following:"+'\n') +# Linux easter egg +if platform.system() == 'Linux': + print('Linux master race! XD') +# Introduce yourself +print (colored("<>", 'red'), '\n' "Built on July 13, 2019") +print("I pull txt files in the directory you place me in for stories!" '\n' '\n' "Run me with the --setup flag for instructions on setting a story up!" '\n') + +# Notify if verbose +if debug == 1: + print("Debug mode is enabled! Being verbose!", '\n') +else: + print('\n') +# Now on to business! +# Load files +f = open('storyCount.txt', 'r') +StoryCount = f.read() +IntStoryCount = int(StoryCount) +print("Detected", IntStoryCount, "stories") +# Count stories + +# Randomly pick what story we will use +story = random.randint(1, IntStoryCount) + +# Alright, let's get the data from stories.txt +f = open('stories.txt', 'r') +# This pulls the title from stories.txt +storyName = f.readline() +# This pulls the story from stories.txt +storyContent = f.readline() +# todo: remove characters from story identifier and make every even number be recognized as a story, and every odd as it's title + + +# Hacky shenanigans +#selectedStoryName = storyName[story - 1] + +# Print current story +print("Current story title is", '"'+storyName+'"') +re.findall( + +print(storyContent) diff --git a/python multiplier.py b/python multiplier.py new file mode 100644 index 0000000..ac5d3b3 --- /dev/null +++ b/python multiplier.py @@ -0,0 +1,4 @@ +x = 5 +for x in range(1000): + x*5 + print(x) diff --git a/python-3.7.4-docs-html/.buildinfo b/python-3.7.4-docs-html/.buildinfo new file mode 100644 index 0000000..d8244ca --- /dev/null +++ b/python-3.7.4-docs-html/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 72ca452eb08562a9e15d01cdfbf2860a +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/python-3.7.4-docs-html/_downloads/6bc7a57013e3076d5e194caa123fe59c/tzinfo_examples.py b/python-3.7.4-docs-html/_downloads/6bc7a57013e3076d5e194caa123fe59c/tzinfo_examples.py new file mode 100644 index 0000000..9b9e32a --- /dev/null +++ b/python-3.7.4-docs-html/_downloads/6bc7a57013e3076d5e194caa123fe59c/tzinfo_examples.py @@ -0,0 +1,175 @@ +from datetime import tzinfo, timedelta, datetime + +ZERO = timedelta(0) +HOUR = timedelta(hours=1) +SECOND = timedelta(seconds=1) + +# A class capturing the platform's idea of local time. +# (May result in wrong values on historical times in +# timezones where UTC offset and/or the DST rules had +# changed in the past.) +import time as _time + +STDOFFSET = timedelta(seconds = -_time.timezone) +if _time.daylight: + DSTOFFSET = timedelta(seconds = -_time.altzone) +else: + DSTOFFSET = STDOFFSET + +DSTDIFF = DSTOFFSET - STDOFFSET + +class LocalTimezone(tzinfo): + + def fromutc(self, dt): + assert dt.tzinfo is self + stamp = (dt - datetime(1970, 1, 1, tzinfo=self)) // SECOND + args = _time.localtime(stamp)[:6] + dst_diff = DSTDIFF // SECOND + # Detect fold + fold = (args == _time.localtime(stamp - dst_diff)) + return datetime(*args, microsecond=dt.microsecond, + tzinfo=self, fold=fold) + + def utcoffset(self, dt): + if self._isdst(dt): + return DSTOFFSET + else: + return STDOFFSET + + def dst(self, dt): + if self._isdst(dt): + return DSTDIFF + else: + return ZERO + + def tzname(self, dt): + return _time.tzname[self._isdst(dt)] + + def _isdst(self, dt): + tt = (dt.year, dt.month, dt.day, + dt.hour, dt.minute, dt.second, + dt.weekday(), 0, 0) + stamp = _time.mktime(tt) + tt = _time.localtime(stamp) + return tt.tm_isdst > 0 + +Local = LocalTimezone() + + +# A complete implementation of current DST rules for major US time zones. + +def first_sunday_on_or_after(dt): + days_to_go = 6 - dt.weekday() + if days_to_go: + dt += timedelta(days_to_go) + return dt + + +# US DST Rules +# +# This is a simplified (i.e., wrong for a few cases) set of rules for US +# DST start and end times. For a complete and up-to-date set of DST rules +# and timezone definitions, visit the Olson Database (or try pytz): +# http://www.twinsun.com/tz/tz-link.htm +# http://sourceforge.net/projects/pytz/ (might not be up-to-date) +# +# In the US, since 2007, DST starts at 2am (standard time) on the second +# Sunday in March, which is the first Sunday on or after Mar 8. +DSTSTART_2007 = datetime(1, 3, 8, 2) +# and ends at 2am (DST time) on the first Sunday of Nov. +DSTEND_2007 = datetime(1, 11, 1, 2) +# From 1987 to 2006, DST used to start at 2am (standard time) on the first +# Sunday in April and to end at 2am (DST time) on the last +# Sunday of October, which is the first Sunday on or after Oct 25. +DSTSTART_1987_2006 = datetime(1, 4, 1, 2) +DSTEND_1987_2006 = datetime(1, 10, 25, 2) +# From 1967 to 1986, DST used to start at 2am (standard time) on the last +# Sunday in April (the one on or after April 24) and to end at 2am (DST time) +# on the last Sunday of October, which is the first Sunday +# on or after Oct 25. +DSTSTART_1967_1986 = datetime(1, 4, 24, 2) +DSTEND_1967_1986 = DSTEND_1987_2006 + +def us_dst_range(year): + # Find start and end times for US DST. For years before 1967, return + # start = end for no DST. + if 2006 < year: + dststart, dstend = DSTSTART_2007, DSTEND_2007 + elif 1986 < year < 2007: + dststart, dstend = DSTSTART_1987_2006, DSTEND_1987_2006 + elif 1966 < year < 1987: + dststart, dstend = DSTSTART_1967_1986, DSTEND_1967_1986 + else: + return (datetime(year, 1, 1), ) * 2 + + start = first_sunday_on_or_after(dststart.replace(year=year)) + end = first_sunday_on_or_after(dstend.replace(year=year)) + return start, end + + +class USTimeZone(tzinfo): + + def __init__(self, hours, reprname, stdname, dstname): + self.stdoffset = timedelta(hours=hours) + self.reprname = reprname + self.stdname = stdname + self.dstname = dstname + + def __repr__(self): + return self.reprname + + def tzname(self, dt): + if self.dst(dt): + return self.dstname + else: + return self.stdname + + def utcoffset(self, dt): + return self.stdoffset + self.dst(dt) + + def dst(self, dt): + if dt is None or dt.tzinfo is None: + # An exception may be sensible here, in one or both cases. + # It depends on how you want to treat them. The default + # fromutc() implementation (called by the default astimezone() + # implementation) passes a datetime with dt.tzinfo is self. + return ZERO + assert dt.tzinfo is self + start, end = us_dst_range(dt.year) + # Can't compare naive to aware objects, so strip the timezone from + # dt first. + dt = dt.replace(tzinfo=None) + if start + HOUR <= dt < end - HOUR: + # DST is in effect. + return HOUR + if end - HOUR <= dt < end: + # Fold (an ambiguous hour): use dt.fold to disambiguate. + return ZERO if dt.fold else HOUR + if start <= dt < start + HOUR: + # Gap (a non-existent hour): reverse the fold rule. + return HOUR if dt.fold else ZERO + # DST is off. + return ZERO + + def fromutc(self, dt): + assert dt.tzinfo is self + start, end = us_dst_range(dt.year) + start = start.replace(tzinfo=self) + end = end.replace(tzinfo=self) + std_time = dt + self.stdoffset + dst_time = std_time + HOUR + if end <= dst_time < end + HOUR: + # Repeated hour + return std_time.replace(fold=1) + if std_time < start or dst_time >= end: + # Standard time + return std_time + if start <= std_time < end - HOUR: + # Daylight saving time + return dst_time + + +Eastern = USTimeZone(-5, "Eastern", "EST", "EDT") +Central = USTimeZone(-6, "Central", "CST", "CDT") +Mountain = USTimeZone(-7, "Mountain", "MST", "MDT") +Pacific = USTimeZone(-8, "Pacific", "PST", "PDT") diff --git a/python-3.7.4-docs-html/_images/hashlib-blake2-tree.png b/python-3.7.4-docs-html/_images/hashlib-blake2-tree.png new file mode 100644 index 0000000000000000000000000000000000000000..010dcbafe7c61d6dd897db31bef617da73006e66 GIT binary patch literal 11148 zcmZ{KWn5HG)G$a(NvX7mfRZZRCEXw)jesB^4NG^Yh@^BQ4bm(~O9+c}Eg-doyTmRF zyX^Ar|9QT=?}vAO=gyp&Gk4C+nR6%3xrzF^YLxex?&IO%QEI5aF~q~ehvOavQUY8_ zs8QHD9^O5azV=&{yZ>*%-re2)4`6V~_1zs7i#^9+(HQI%_70A{yS;_qpl>kf6FB-7 zdwX_=K0u<-P!#s&8j85OxP&9lF0No_aO~OS8WaURfi0chU{0qn$5ZH|@wubxt>cRW z2=w6KwBiambIUgT|>N9FqTE7F{rn z#vwS;|He2ZXX0k>S5@1uzdd71nd69zVMxXZtY>g$Yp^t{|L@SiU=DC|p||8)_i9H+ zM}9kK;73K@kKVDilB|}Q%=+QXeE>-||1+#k2o6`2N3H94WkTBDQeUyKu^< zXwy%^WL~DBT`}Fbd)UcG~ z1drtEu`UU*6}E9rX0byNG4Yl$9dDxt zI-))rM-KRhRrrO(YXo*j1%3|+ta=mBqZZKO8xW@EU;W0nOVPW-%iB}l zd^`bipW0O2BBfkgWL#U#UA3HDY&~5*NjSF%f2bGx&?5e!Md!nNVTY#w8$=wML>-&e z9DPjRn}}M`{4a1@XNy_VyfS;BU_!(EHqP3J+1!whU!R&+-~F+!-wPdT9I)v4cxci+ z&*s1PV9^-@?$B2FqaS~$Y=wL0L1NgB7;lP4Tu z?51DYU9;F-aDYS7*<2G?U1OQwMKW7NGTTNny~6<`BQpctV;X8&N(wqMGRpfTWQ2r7 zxK98VmNJwY@bI4NXuMH;8?g4T@RKLqc+cT%=L^%koT+?U=@sI5pTE1qo4k+cuRYsx zlRsVQQ?WmievtB$>KYTG$o?>elsTHk;+#A{;@gO2xxHhzYAYQfF}IZ4qO5(0;b{?9bpi%t=N?Im}!kSQVw~VCv_{$@!hQs z5498?e5K8WEqq}7!x#^UUKL)v1}ORFEl8h1kI!K-kk%RiWYc(Wi)?vc9|r2Jn;4*L zoGJll08BH(c`R)#faG8+QQYfRR0zQUq|-CGOxB*)ycW;DTKE)>??FCHJ_*V zTcf_e$lLI2uLBAd+48qeE+s`?MRE+XdUW1InrTa#;T<0&on~q%dt6Y`ySy0jHL&%+n}1C1R-m#z*u%n7WBP}{Bk?21 zkf<)I_XuAdjnVvZ$f{ABD9MC07$7(zf3jN8J!|?IELdU3fVWT??H1OaC+u=MPteo` zc{Y6i1Kr)M6!BE^AFl`lS3%?ZQa22Yo4)gM-{DV7dSk2jyhm;a@D=1&sJp^C4$inx zN{oJZPrwvGp*=4E4HajDyBo-wmLNn)e*UV?b5!zO$SK$bXbbgD1A^B_UI z?JQ;Pjh`jKcf1lJ@q1m>+ibaD)%j*<6l$JS72|s{b8%6aAR?vij;aAjA_zWYytHp$ z8{=U)9U0LOKqa6idI`ttHV;kl^80+Aex)VABM0) zeQ75*;?Mx$#QQ=jO#Ktpy~JW+Pj1;o%?#%8J*-oM{J(~O5@+&?PP!1}8vRI2H5DcG zlFd}$*$HSxPewhz7WuEH&|;kP)$$36!GJqjLR3ny7a<|iEc+u$>d$+TrNc1&J2vM$ zwKT@mLeJ^!Qepojpk7>K7^g#%G}XAbt6$+0HNm7A6J~V&eZO&^41d=nVKK7)Qh07l zlkiZk&M=f!Wvjm9*R-NVv4X+sTeXj0fQy1~-i0I&Rr|)}a@)dx{CSe)G?0fYrCTCL z<=m@=@s9}a*P%)N))Ay_yaTI)rqpC^1%4-prf|Z3?Z7*agNx)C5 z*t?ig^KXeY07?Z9)eOdxCG2UK7gZ~U28G}&bi@B>f4c014!)x zv{Z&)mlp(@A*sxz3}D~m+|=WiOeNtG zqoI^{9~GsF{~JCDf7hEdJ;Fs2CWm=9{X5yF7z zIKdS%%=1~B*g`4f+2tHb6kvHc(3_hs5$K91Mf48LqD0_37beL;=w$0b^{I#bH7ufi z_|1D*egxINv~c6{-A$Uq-M^TABv`g$C$73!raO|YvqZ2kQg1aO$W$KA!?*=Z*2-@f={pD7yt52U<)%D@4|MPhM12zQa5c? zn_4gku34e!6c!u3g>RNRI2gs{z(!(bTb}*6gVL>BP}q%b!?RinriBOmNb(^kH9y#R5dqo zQ|hnC-RDo~W(M|c9LVDua|Ah#C{ArgMu{AFEp_HEba_xpE`=?v6;TVP5Go+)aSF@} zk+#IYP5BGGpX^bpo*X`^p4_c{i>~O?r#67`x*p+Qf4D{S5i^pT^V1UTG5X|u>>HRw zF4r@Lm#${vw2vaFsJ>Q+e)7&xf7!0nVmjI_d|>qhtcH)&W*W_506RXJ$C&rY?WGej zi2C{Yi82tCVut$6eq|{y^r9Ae4c^N!+Bnk0ofO4ZPCdJ7?B`goUvXF-H$Ai0?t1oaeA+IVb?fg9~c_iwf-L zGY9%_sUHV80w)7z#m9Pgt!i+>U;z0PD3MowcnAO*-n_SI1x-kkCkBmg`Ld<2WE{5l zVdv6>0zBvtX#=i+1AZ8Oj*P$?p#8r!Cm`n(8~EFfm2^VT_;ULI975~05(s-{0Lxv2 zc=!4jBlrbf&Te{$O9+<3B)v$AcMbtGh_pgi8~9fqk?q~TPOZ<&z+SD=eZqW$@^+S% zryR$u>{C90N6&7jD*)DN3)0;FGJ}nqPSO$Svz*7QB)tN~v{|;U=lrP;5NXk_FpUG4 zPS7LYH^Azp<43Z+U(m^;y5QQx&U|C?(ASBLn>KSY;NTsoy;u3_jJCw~c=vB7J`*}b z(E~p1R#zm+UAFZS$>w+&_WY*?B5hEt3{1DP_Q=0VQ$ylr_5CUMogns==V`WQvZ-IHbV;t$wB#G$ct@0K8-jb+_Hpmc#(HUE zDD9)Yw~Wq{$N_dI6lcAbM9f|RhR^`kl2F{P%qk5$AV z1sUfz)T;y(h7fZu>l)lVcrGkP@7Hd(M={2f7?i#;-PD?Wmh7|6D(bn2mtrZ+B`6jm zI_7f0>MT(A4cG7Z&ZlulNque}RJG<>UI4R&j8#+q?NoX!;l_C^TkqktQsa7VgYKshf_(TvWfu?6f<8LD zH;bJ9dS<6*S9sL&v}Vc>u_L}0{HZ6Ua( zy{$z`4H!Eyo*;?(Q*8Vh3e?+F1O-=1kV)b4mB}^8mz|#K?DJ#2FQd}>k6zS24QCBI z5W+)!x-OL`>tRqiObnuaHT8RC8o}K`+Jyg&AoLdkZiGyhq(Plc#d5$m!94SF5a%?a zXp0bT1Sr`o^ByE<{fQh1y>t3l`WRF^gE_RL={eJxotNK$JU&+xx4S8XE-1sCZXKdY z6P6=37H0KYG?&BPc%4Pr<%%1X*E8o zB>m!c@dj2potT0Y{et zV&dhVf+hG%#aq+P$tKhg;O?~dnm{BpQ5P3c?tI^Nr4~E&Wyyxh{#1E?1de^-y|hA2 z0eU3wHSbj$4}GcP38SuxE-fDAL8bL0M@IsjZ6jVoh1@9fBrYJj{1{2DQd;&$b;X$W+s_|Fpm6RO!rySLe~a%*_dpX1&N&2xI1~Is^>djHL1T{)+>?oRNo{Vvti)V+C$ijfNFz_fJI& zH;c!M2>>NToCnFI{Qe3#Pb4NR%#}Y}a#(MS>NFw0vl}Y1dpTFUjxJV(IZ5FX&1ba8Y_FLCo+{-tMIAW!t@vgN&{q2kU4R z^RFYV?DAV|8`Y*gn>KC&G0@PHEuP;%BVsNc;HNTDamd?LouL^DziS)q9FvE_NIrZzUfmagy$BWd8`9~#O!_brTUDW|r*OKI%@3^1fa`~krKOj;@(l;`g%_dS3@;+A z>3rl)$=YPel_3kq)Q`so(hB$|@}=F3kIi0r&tKYrb@6>C_Y%&{jdJXzW2+hbQY=FG zRI$l#wq7|)zblDi;1sr1lRL!jOE9&5+RV>;16h#26XiwBt}@-X;FB6Rj};5M3sxNP z%UcnwH%-Q7ZMBn_>(G|w^iI!NJGtIrsbbq07ARjoY+DWSI5HoY5c!pR^3r`DUr8_) zWFezFd77}$)S1VFo!-@9O_An1*3E~W3(imUB(Wgskwq<{Kfj1OSOkuf%LBr`w8#0K zfAS9=^#}~}=86R(&Tc6;0^`3U{dzXvfA2sSK2sF(y^x_E$a`n!LlJB1(bjAwN#FkS zQdn|DnSCd4)=pHPI--B)Mo)=g_FD2C)JmK>H#p|ptUPqc<%^ex@an1}eP$%Xa9+GL ze0`hWX#vq*6_=guj!b^&5FS+Y3^Jy|27a-X5c=8f-$S49f!ZyKXXh&u_wN4fIg!7L zmm`~PRWY`4?V)|X_hkp{1N!v$2LFb%X4RoZvf<(7D${_nc$r%xYk+cbBu}?~O%=|T zHv9W`_oh!7tEQ6Yhw=KK1=QH%FLMksRdg4>bL=TM6Lq}}9c^4M5Jwt`zZQev99)(H zgq#<<>Qy+Ll={E)yB*N#wpv>q%i6ofxC_&O)Uw|ka3qgJ`hTJbmk*rvN-3R9_LI;v zK4!ITIwkJk?2_IAU495CW>hAcbC5_S{M15Z11XdK>rr=NQMc+-mh#Oa%M7wFDDUI( zIe6kSCg^sme`6(NmE&zTN>II;2|9NKpATnAG&*)$ zrIhUNhsML`t={pXmX50qp+*m`dh}@J9ZoVFSm1H^aUz)gpP>U;ip3)$V%3+$y9r4P z!R^6sQhr%!gm`|4U#MfJ2Ed}^Cw@HH)Z^*6*AJ!+ZLyR+2Cju_YKMMFN!Unuv{_Q% zng2VJ!JT5d_xOC#OW-wRd9fVasUhstnn@dsoE{p3Qe=7cT~nxjc>bWbd3z*aWQp@0 zAPv&`wgN1CupyN8sNTi~-G+W75y{O{3gXGRcwSC|2runSW2e0T=lpi+Byc=1rCgZv z!L{Gvy(@#2P(_+n!WcC15Q&3eKe5 z6lONQCqyKt@tbzcQ#vpuS~x23WRW3w_8R^3NI20KmZ?Q#2SAVL2lNQDZIsT=*6>|X z)x-6Cd>GWw-gK;Si|2Nnu0+Wp6$yR0gTahG5aG+?d`aa7W$HyfIWLmm;Wl9q^0qnp zmrR8!XAhF!1t`lyD;F4o?=sghmp-Jj5KNV0yj(XuHn52Q*=+pXbJL~2&%hvLpvBut zu(&KBJezFywb~~1`x_;p!{8z4EOTK&fmhE%SuH!Z{zU&(iwJQkffb#DVxUIf{hu`*L$K1aW*WMSZBca&$zj>fZ?Fu8N&!|u#6wZ<%CMi|EEUu8o|M=d$WFP=uo_o^0cS4QF&Kl{z2*QNGK~JQ)U*W1rl0fG17wc%VXLzk{JfMC zXt56+9;U~1j``p+3FTT4-6DOhWL$%!oDDw*>{;yHnTbK9`<5B@E%f0deJs02-sp!d zVdJADK*Jfvg^12<_8u)e_=0fR^KW#!q^aa589i>S-FOhPfJw2xo3;9ACI&~ok$|2J zgbJ?J7-gX=-qf-{hW=iW?gRn&d$z;&(LE4mO+XqSWR=98`eJeaoz}H(js=TxbWoFj zul$Le&|2}3Af5Sz)cO?IO7n6!{%w+XTEM0CWj$?2VPWM}nMm5Y#8O;ngS5dZuw3Mh z%KAJ*Ryg;y5F@_Tto7G1Pd+1s3M~$0|L#J~G-G7LU!G+G~217^_fI2D1oo_Zg5J&Sn+jQiY zy{#uV+R}XyR)oz*;z;c5fa7u4No0xV$Ja%-XI?!Qx58}N!G5#Pu*b68aMJ;j#@Mb4X{TKmgR>V@ zX>8ylO(z6+SbW4(t-y;l-1`Ojlr`(jk&Xqz`Z=){Lk{hs{_~juiD<{Bej+OVKgPh> zpuhZFGP>!?JmsT~=dS;XCVm*hRP7j=B{Tz7cW)Uatf-W!VZN1hL9-V5DV+=N^$G_5 z4CU;u)G-5(zJr~1*$o8RN6>tKeI@ywbFz%zzJ>6XoEHx_H0pGO%F9zOpt<%ocKP-f zN6~zg5S%b_#V7mg`ylU?1#B*lLz%syUfF;7cCi9oVmuG0PxiLv{ecvYGiDvmR>1P^ zWUp-Az1_Qp_a4;T)BFDNmRe5yl1y)5j#OJjatAOH8y}r(Lq5Lm-@j8CE1vAtg?zNL zVB6``9LJ=(yxN1Vc^gj4L@6Gd8^Mh0xh8W!I&Su62dUWni{;NrL*_n1!tCi+bAG)7 z>}m%R0oVH`u(`Yw+)cws;(%_+Irg!uuEc>j<=lNnJOusA&Qxj@8G-2Ek+JbM9}w2B zyo}j5RZ{w=dKEHN%eA3}B9P7WL{t-h^(BIKbzc@o~$t zG#Vd9gg`!yl!m)%1Wm;VMg%^Rrf;LDU=#9*lrovdEHpJPB?N6jn~$<`M_a7MLO!#; z)gSwrvOh8%&yiUIAaXy;hMs_^?z_ld>_)=U5~{T|6sA|N2p_ z#k;Fefg0q~u|`uDd+pj^8&Y$X%@ieqGubO;xsqi?nE})TOrpLj(;R+wkSZbs8;Q@$ zgbwn`o?NO?M~Z32olfE`;rPxjaWbG(nM4KrtL?$vkc%R)4Hb~WpxNTJO(3py-OzRa zNZvLRRL2QvW&h+sEt5D;d?PtL&GQb&S^+X>+93Wosx)UrkkH+vE1$LM@nqwLakbnZ^fuCy zOEWhb+S)o|Rs_+3>!wPJ!+87d9ZT2Qd7gv#y&;%-@8S@gn`hJrh&G6^M8q2@no>4O zcU8sEN1^-oqe^l{ox22 zUCbuDmLcFfKtAbn9rnv^BavnMb}fO6raFf#KMkR5R~6wSDcMn-JK-}v7N<-_J*5y; zV$8G=l0_!a#`rY!=U~fe!ksxGBnfyfmhb-c-@6=S+}D}ODGS!Bg~&ef5J&3140Qzb ze@0o=g&rEUp^UMnt^8~q&MdZSi)7O`8rrnEru#QUJ&A%>)Bw&|V%k2E9Qwb%-XHpm z9cBjXs8|L(z>}py^dCL7+Fv(XRi5`fQT;JM^z4Xx`=;(_NxQ4Ml%y+W?egWgVD7-h zQ+0oL-KZeyZkLE5+LWhenG@tkvB5+#!@iFpTn6_klf|zdB0;7Q{V$8bO=zMEX~2ej z;dRpCC%Hh{Q!q{bk5PovKL>}rnsaybuI25SlZN#!ExIqGlyLZJ2$RrrM)HKh98;Vw`g-$gOaQeRIY{qvlT zcteTp!AKqQa~<3MkfKncnL4c3wA}J7g026-Eyp{xFK!6AQ~zQ*II+YFpx%_1{&L@! zAQGuYVI%dXf29^XSeG7;-`SCo|DJ^IJq=BmByQ*?yuui-M?j_sCF>N|x9q0M+y}l<R(VJIO^nK37M&%LF94SJs&Hv{kb0&55!^1@$v6rSw$P zAWQ1l!d|jI4AS_aL{pmcMu2cFQ|5K%Jw%x5W5a@nahWv$^8VZFgbxs zKPzRF{MUNk)^fGT6&3Mk5R9VSM|vKg1On*^zH=h=RXN7s`EI`NG1fm)=sYx;f281H z^@nUk`uao+GG40Q6en5I3!94Nlx?o2Mcu{xrylNiRHFSff=?ujXuBWqRw@AFAEI=t zGK?64NvegH$;Gx8R0FZReId}XLr!W5_cP-KX%NnfB_L3^J+QGA(P-XD-gU|(!R^8O z-K`YgL2+0)9FJx`wAU_ec!3)g6D3qd^N8IpH@bcaBka1eLjM8a|X$ag?=Z^O{^qXEjKGI5{B46t{eU+kJuJV&z zbEaA#kjpTwXBx=Wu5>YEF_C~1lPLYd*^X(rgATXQUV2+f(xzQSKCPwtH7k6C%kh|X zrT8!m`;n^12nGy3yVVO9#aRnd)1%oMc;CWS$J5){Nc`&&4<1(;`!l8LsCb5}B5wM# z!!7GvBjsdvoli=&Il@0Cw=~s~R%)d)riR9QXVL^y`z)gD0v6d-<{U1R`VCRwUU4b- zoQtM@=?-(*CNTRoqS1j^BY(Cau~%PTC-KvS0n9(nv5B`}&i?%>S#TS%)6DbjoQnJ} z6bM1>6yN9N?zCGU=ZE?L9h_9OJS)q!FV1hj^z)J(1K<9HG(Z0O+G*vVc`nj=SAV9g z@FTtE>R6VZx5$dykjLU}rIzHSRMjh7U3Ie*1$@8A?$r=oW{-w^*2(JTZ=;5iV!iK= zv%QX3xiW_*LKwIRgrDAeeLLEXqE%!k`s)-jOV2~V@G_=I!C2)UY*h0sO#!dZwV}qzuzI}hx z+RjU&tjW%Gik3}ZEB#s~v84+Vl%krk;WGORhMMu0+w1Ke2io=&1M54G`!BNO*^*Ht zbiX+&dEWycf3lnWf@x=x)N|;AKH*DU3hL~IX|F2&wd{5tOdLb z;B#^dV%Mn!uz4WT^kB*h!9lfvq#8gOI5CLl80QJW8QJT>ogq?zPPAshsQ^tFT*o1P0VXcho{$poHUgE)z3(r?y&QjZ4oQ30I!@S@$p2+sw zzh?qiFDUV>;&(!~G%P#TE~{rzT8vF@^w{cjp1tY&{(8+9+1o+CbnAXCNBN*WN^Eh@ zP$xc^i~bq)hO_|;cO;AWR6G|@E1GFuebNsnh`|OhxZQck1@%So-lQHL6YKF2mF8Fm z-iR5%m<(X)b3K)~HDvFR({=Rv8^~(M9ozP*A_?^-di@R1RSRgdbH@ppypb<6#}hZbZq#lr{}_GfC3r0#W8DN@ z!SyN((SN@Zd3MXM?|VnSc(1FIR-=zOuWW$;6o}=-$-D$C%mkjI|5N!$h}m?JZL;PQ zez5BnLD9g@fOW*DV5?zgo4Jm2>YuQ0w1Ma`1@_^(zOSZFq=@>}0edq?ZTeHUCw1sI^dVP&?l9GG}b#d7$`MIC5r z;~%8LkrRZVN|?149251gs9lkEhUL}(wih){Wk0qcmH46V9Erfp73uST&#sE(*!mG6 z9D%N)n=-d89$5dAOr?t@7xTbt`z<{5dc!5jL{i4l?hcJ_WH86OSFd$s`UqLQ9${qO zy)xWo!)AKyabMp!+Q16k&JAHs{ba2Jo4lsP80PopEf$C21A2_U@4vU(D~@E5OTK4{ z5TxY+%@g+&OGFm2fd~@lARqB$b0s1hLoFCTutyffsg}?|j%*nRgtppuVHM$@Hrwky zPhL~E$`bZmok9RC%}3zWntPV`N9gtKMgp4e>cjr`toE}pTs&(cmRau9+LW^QzVUn; zJ`5jWeFidyuHkRRi-zYIplTxmsgZk|_2TSa%O>@+6c)C_^pTDJ1On(a-oYuKjb*-{ z1F)vjCE35&h%4Z`&peJHZ6!~PV!|R6OoNrfFS2v{hh$eV|L*YI!-AN8pxD=H);vmc zJYws`L+)qtysnisdNRD(N$Sh69tZ2@-%cQFL4|qpX4(tzP3*o)QzzSF zH^c=kVb8;jU_3Zwy1slE(#q~^h72ef*@y*EobB+9_zI8^yS#?{Y!8=;RUm*2%l@1x zhHa>q)NM6-(klOCCl!~6r%XP4`5Mjo)+6{0u&7}j7^SfMrdlqPkSjviquc>BXhY$7 zM*w}If4clS)+K{nDpLLdgjamUX3O>a9UPw})<{vQ5nzfCNDF?%?QzM<5jF-NCxgc6^K&|d1EzIv^X>+M_PCjgY z{;P(g2>j=G^(v(exJT47@`{~kVvcE{#RlaKXT4YWI8rx7fd{8SoS;M+$Ox(LdqSyK g_X=0MSMNxwmQOevf=Raj`@v8{MfXjkl5N!g0sb7?1poj5 literal 0 HcmV?d00001 diff --git a/python-3.7.4-docs-html/_images/logging_flow.png b/python-3.7.4-docs-html/_images/logging_flow.png new file mode 100644 index 0000000000000000000000000000000000000000..a88382309a18df821496c27863b17caeb68962f7 GIT binary patch literal 49648 zcmX`SbwCtf_c#oQ0@6|z#xie=@+|%cVD=SK2zJB)_0RaJ1Mq1(v0>XLcDSSdesES3u|N0X6PiZ3kMF9c9lNJHNKL`N<4&3tpi-6$z5dmS}2mwI= zf`CBenBJ@+gn-axFC+0u?VG{TgTh~Psnk`p-FdsRXshz5>})AJougmb(YBsc)~3l( zUu8>a&2Gd3*%epws61@exfF}K>!d4jzq9jop$6>*W1zA0d_-mcCJ{)Cx%u^y_43!M zI{G`Vw7AxUPm$f1zjhe))f;||UbuqZkA}ytQORUJd2C25pGAHf1qqUo-<5bbs2TY2fj>-sg5Z+4E>KK?$^u!39C{e*F*s@Pgsn&5C=L z-=haUIAbkd>m?$p=$~C=G4{Y0z}pDOSX8GA7FjtEY$~PP=l?rzMA^q^KJ!20Wrlix zSt#=GH#hc_Jvm3N+zVHkt1zZbCzlNMP(c*&?Q7%J7WKtI1Y}Bt07DvoV{^$`g+FI= zQcFIap8wGWz_X?~?Ikj7eS{y-@96ZSwCvyl@HZujHP9@(vgU4`{v)E33OURKge(|s zPU~+xit%%wky?}#Z1&k!oM0~JJ^R$l;@c+!j|D`sX zmbYnn{1Byb5<)~1v!V4`C_;n>#b~WFKJbLfmQ@1|@CH?-nr;k26UR_h{>}qxHsr=c zK~4&XQnL?t+Ny>Uc;Hi`ntnV2)06CE{_#1oGHjc83h9|HTj2MC@|Ot%mC4W8Q{#ZmpQ-JW%h=ieQN>S1a@}E|@TmUqy?rA?}#0^O7w$i}@S~jGH zI=_1ofRvA>`a}*~y_5^0Hvu$aO_YW|1J_8S{KPTz3EvD+_Mq@McmP^>P;yD ziV)%$uW4|cVD#p`9}mUOx` zWg^9wUlaqd3nrf!44;LU4|dB_(@GWH8lq%0nb%z(C99BQXFC7XJ>8!x6?^aD1-~p#Z*-$uK?%0nlr|e6#&-1=oLCFcifGc%ZKEn zuX!Gna)jL_a@DVyP5`bb47Cr?>v+g#`9q>Uu#_sz;)3*c3CmZ`PFcR>Cj zZ7;}Y&YJPT?{Ju-E#p!{1a*Z&zs(db_OdeQXnw2rUdFwIA|GtMqN1{~g1YZA?TjxJ zOWj5o*Y9d+_Ew8M?G0Z+&A6N<>sH#?wubojRpnc90TrEdlk3cUfr`^Fv>1JI`Z!w( zA**s!WpA1H?j_w;?G*}lb0iJ>S-SP_J;jC9^5khpI{skiMW~st22=+`Q z_nOL06=tvA5(}ai7NsaO%Ez9!_8c8a6-KYz4upm$5Mvg0q1_4&w9dK zF_(LWm5h{J;ZjBV8_Lgplf+uhLQNdXuu#A{CqIU%`f&orAmG7lc#v@trJJS1Z^Q!)+?;o~S6&Z~RkcFy)Tnw?qEHOAyBxrJEN4-64s~Q< z=4oKJtv`MT;{h;UAX`71YRra;0K5Nx*SNHtpG5N>w_nXZIUZsjPboe1+EhG@BpW`K z1KLGlHWo_pSYvWjoZ|{GH_JKIHVY79$kJRTkM~*c(-V9HPxys4oXRBmF#k8bA76ky z!38?oy}HbdiGw4DsJW2m<(l99naJF%)0>h0MOAUYwe*Nwyd8fJSY7~=uXg_c_i0$c zCK4B~1+NlgXQPq4?Ll)%W7>=`PV$`*x%HV^%2L{odb;Vj+|o3BAjz5zb^=8-Ri+Q^ z)zx0|>`^bI4! z9kbXNWFxM}6k5ybBouyNd(h`OrGtMlqD0;F!{Pm}PByekj2B2=fFT5r1^A;rV_#;R z6jA4!Seei~V>4(LsfI#)kVjDSh*42_Y15h%;aV9w^w+tKAVOO`m}0S;-Bz05LYu@^ ze!wO1Y`glX;FVozr+bc&dE|9PBKp?~u~lc-&swAhRn@)=0$OVydN?=#w1fnDQ($z zcUg}L z24Mkj8Y1iS{d|8MxUM*ku5WBupDdi6E5whA5uBz&PgA>=vTxUVZ%T{QW_QuM9iW2kK*H#;Ifd zSHlhe?Yg!%2|e~YD{okYS;Aa3YmKkVIc8=P?#j1a>CM;F)N>v`%QTe2>3EkeiA|>e zB=GdD;d|PxMHukG#t7l)X2BoJuj6|NYU(Ot=AG4VzGO}4Pb=+TGNctru88#zucz7R z1RlfIe_U^?6pr?%Sn9l-Zf1)UcRycN+E)Lvt4|3!Z`TXnOvx#8PMKG|zKmjxb?Z^^ z&37f3T?V%lw$1xK<%Ikc4Q=9pu6a&QI~$n2VO)sdZ&L*%1$B#0v0t%cm7_UG1)Y{m zc*C0GZtMRRMmJ0K6Su`6n1wQzY6S`2893CDB|9#C@2q$;Pp#CA)qq|)SpzahA3vp6 zB1{RY%@8^ej2?2t1W|x~%5^zd5M1Or4%l~~Qn&H+J^r+RBrAn%zOsxB{0#OSyNB!E z?Sfvml@ftm&}XumbN5>}*Dkx=^(*pc(K|@G1xAa|)}ZQRb7Mhkljsk7a00=?c)Z@j zcqfvEZ!=H!@1b>wC0)F3ZC;+Vbu6>r4IP9Z>Kqr*?bDi`?TyJ}`H;<_H|N#U?Cqz#O$KFw#axn!EAKhsd<}15@^39oJ28b&$Q~hBE+(p!SxJ{tz=_%5HcCeZJZ%b5- zwa~Usf#t#C^tL?6rXo4FE>kFdL!@b)as5{;Sf!Nq(`9#B>*9gXMbf-Pl?efOpTGT5 zj}^b>Bn8VjhFN@eL1Xe7S&97SwpiQ)2b)^PEDKTv72Uj*GeBdTQlaZ%$li*-3nfYru5T~;mB_W3_{t)(CePq zub8-Rsbct#N$|)Hg`DEx7iGp80bzCEf!_;77{V$pqBWY~%wJ$t8=tM0`uOOI+d-tU zITx%`+R`C#typ7F%e8na2R_)l$dv;b`qG6o4np7dLcX>DnkcQHBtTQd#$O6i?XnxR z5ovhw(OYtEzvfV+#}LGC(wqM7a5+~~ry~!t5*cFel9(1@e7xJG&8nhXOO6lTc1MPl zCWx*@EXWCd={=;3#;Lphv+sv8(c7|jFmEt)Y})@hkGl|EnzT{K>ZT0Qig?LLA>A`> z>M9twT;)=-8N40Jv~xOVFvR9k0y+9zpQg>$U0BK)zk)|m^CDT*q8_>Q(!L~$Mt9RG zE5TP0+1<0rFjRKdX4tdWgildC)PPUS#M#_9oTyXJK^XsH!C=}$$!3BPpEJTk69_#C z9q{J8`2yMrE?gfP{^G8Ubn~Jw33^jVp#^y90kr|RayX9Gn)8rOGSh>G=f>ML{hkf<&8*# zYiQTv?Q?ouYE63kC|G8E4JsN<-SSS^+vQa7sc=7IAM5al){iG4LcXRPFEt)b{PTXl z*pzr<-o5vG8=Yn!c|%$p&3WDl;A*)B|9(ieD1n3z(SPf)ske4Eb0iY}0ce9Zl~OZ* z;f<+<=Pd4E+SMXSocx;)cTqRTvnw>}FzAO8S8IzC_mx8*OP8K-6G`?HStG69GQr~G zlJ>QKv}vnem-fr4;X`j9px)4@-|Q4cL{`lvy=8ZHw$r;(eyd>9>fY>#y}c|@NL6gM ztS265WjQh zZr^f4#60#Hp%*rCA&TU~WbP+TT`iWyeUhHcXta_b-({8RUpW zk)X!DHEvG&-CV=A+9BK(UgY?uzf9z0xhdD!iLZ!yvE+g_P@NY|0vh!swKk{u_;8!` z^z?Z0bmzB2fz0#f-;{{YlV69c<(Jj;#ss9;4p5STx{}9=4B4@{ri*aMR~ee;48vCV zN2hYcLKWfTpU|g`GUHj!p72Gt+i*c`zah@=#?UQ;<`s-E z?QQRJSG1tBSvKUNNZ5Ko(MS}yQ69vKPXi=cCN!IW%5O>_Q{J#MohoqE%+DI#zqu@i zlHQ%0bv?;#42dSG)D$)1f~^9*HtpbTUslhoobv-kDQGgI4K|T270i7><%dY6=9v>F69w;US?gKj|k)C#+ zZaefldgNr7AKvPCGq**YECvp{p_slG}pD`kq-X0SS}QB7(c zml&okZC|z}2F1V!v$&Uc9RWp=dw;NpI3N=Ce@9U0@$MJcBeEn?b_wXmYOd*MPJAT3 zV{`aHI@}>iCb@N)Sw5fy^^XbkV0N~Gn|`MR^zW@|7*H*Mw}o;q)l5ccV>i+;(WTDN zwJoXAtK}m{#24Gn)UlFM$nhIfQ>kp7w_fJBc8^}_J81l(nJMA9+S{+g?-(xJ9dqj< zU_Cb&Ybuv_(@z1TnN{O8{$Sda6r|rVKlvU_9AiBC7+2W+8p!;Y=cBEV!I3~RuFRwl zFp_7hLUAZxV4{6;q?r-F{zLIi<7^7w9!Jt#@eb%NMe_k~tbtYY&3lq0fpFE{LrK^4 zqwi~9MtHB_lS@CqpVA(fjm57I-`#=b5M>gVjnFPxC-XN*IT z<7?l!&;3Aw4D?S;mmr`i;)?x_UDn-ph0z@K($5_>RFzgl&jDcSB_6z(Dy3tojP zce=GrM+~*RaALitXO#}S;r{of_-rMU&q>CuYUI7?kz4zo$}oM@VSB*xMhLfn!ZoM1JuR9;Yo{uh`9Z@WP` zgw3^!M^Jdc6e*92<}At6shM{2PECPTM0eL8d^pdVz?7?7weXC6|0;#0j}lS?*zC{> z)9#ZILqJW0_M*x!*f&1ITEO8@y(u?$F`WFGYsJ5E0YgVP|(S`oQ%_3;IrTdN~9h3D= zd@gEPq{(BA$XyK?A^A8m@|Kq_e8TAeN(4ZqcU{~cF%8xGv3D218k7u>nh;$EHt6yiURi)PCq9XOl0gnw7O`UF&*`uVWt(VfjO`2Ie) z@GryoAa}%So=AwOE(*Zn)#>#Dzq8pTKQ#AB*4~^HmWv5je$Y>5GNG4nsV6{+C#z^Z zAChBhyM%F${p~HSXm2*on$r-7%n-(DXqpy~5R>_c0LJT9^dDDSqCZmdb9aEjTx8nod@KCX`|hZrVRrZmrzi?AUe$E+0W=6zkQiPUo^(m;eD*j-TUjqH1#kVOwyxLFSO69es_V3X5}9p}b^hUVUJfBIwe z94UN5umtfUDp--insUCZkv|6rC}xWTVxp=4q(tCx-5+b+2lHRkB-5mxthDrBv@^qs zk)InH21uT^zw8S0(k?XQ>~QF%fKP7Ee*yaY?BrK?^Ep0wt6zn+1pLO5`W zQUJ?lO-^R3DBDA=vJ8h`l_$#F#}S8XY{5ljfQ2BUcX4}5HD4jT)x%u=!PdGiZMa87$AMOj7K~?vKzLjVXO{EDsK7**n`rA~$yhfG_&k4hEH`kmBbnW{ zN7EhSMEkCZstB|nOt~9f#A94CTfc}m(o>ELdQ5~)FW)}1mj`JyxnrZs;DdzmgG_x_ z_AgREGI4?LUAL&SrwN@u9#*1<2ksl+BzOyF)1q$C0nYbczPRcwA{!b1NODI}7jq)B zbzC=2qoO~bxw$k8@|NPfN1@G0rLcCRK04N+zo;0nP#}(nT-_2%N7BNBh)C@PguchF zrn>vdSuO)~PSQMHbSUaSLiFCTsPxRn0sNDCccgKrLyx=wjsDySSw3eSzC_8B2z$BLYOA&>bB5|XL@kvO8A7P>4 zrbPev{$Ep!)^Whir^@Nix)LpRfzm|_9?&T|9_Y8POzd?VdewHp@w;mGWn0HH5c#+g z)PGpTT-j2=RlWN}-?>Us-};brU4ZrvQYx1@#e$toFQpBEnvN6k{6Vj|*m z*5tfGGT6&Wf6M(AkB2YP&rU-<7}ca2s1aIpNz)LaT~@KXhO@M!aN$6dfCMFrfJP3d zl2=pic>i)IWS3-4GJK*?5uoK2XAUJ|IZUfT&iYdtk6QUDhL6QSR#grbYjEc~KzFso zqivjVPQ~oDhbu&k-_A+KAQr}u0Q;m1e^9=YB%N_D=(s+m6jUp4tBKE9NW*sCNNSB5 zEeE$S^zgTXzRkN6tlg&wLq^n(HB08IWB;mjtXqU4#zjIcj3pGscKyj|jiFprz zR6%A+G@!+~J05&Uny-g@5O&#V_b}_$d%)JVS%@ zo1K%_jT)!rV6WFcI>{1sP7SZUUK&JRw;t9tb~}sImLM+VGnuPYYNb+)1{l^v6=*<*Do*yda#3qqrZcE2+10Gl&0u4G`e$6cm8td~vUjQr2!h#d=y$d5d4kq946 zMFO9%OpV)$=>42yLew^{^fs>9xY{y0QPJz@emdIOX7TjQ0^0aB)YqrKbdko@ zhc`mMcpk&U2ES0n4?by(VXs+s!g7@N@33afx?lh0J6X@6XwSRq*Rp@zZU~#D@jS3A+9beu71c3pn5<>$H)}CL zjMTUw)G2L*R$mfatm14`&j$-^8cU4bYD-oFw#Jg-YR587jZK;<{HFl=C+ zhWjdB)|t$Fd@-a04u|MH>=kB>7M~o}efj9nde(QpR>oM2y-!8%$zVQc7QO@YIlO;C zW?r^2Vb>bKK2l!OQ%hj(Q|DHiuf%EA2zXI7ah#u%mh%u=uaP>n@VKPu6z1E{ zu6ZJ|y_qrLT3K_UbKs@<*{6A9;X@`TT0vstY*q_OiJYg1YuvNgq{rUwBbUX^j1UX& z<==n0)R9p_Q_jdLZtD3a6)-$iQzaP5>ds3c?71}`^|q@}DQlnQ>az&iWzuWr5;xzk zBNQ*uN1t5TJ9ez)_DgT(mD8;Ujpj#@wTjwM8~t=hHx{LjrdK#JU&CA5?G-aXkL0=cE*s!nOwK@lQRi)$cz7 zWob!ezmNzPfwKLRQIR*ZmDd+~|a+lxQ!Gxuz1W19YI)oOZ};i@VHR?knU}0lK(kh#{hDRrAia#uIw?!GhJfbe1uXc2tN;c4>Jh;2@mKHgiDR&Z@iKOS5M zl)I)q@KU($5^eW2ezVVBvfoYYa9-fd2)|%YE<_Xd%bx9wwRq0GT(A^UE;T}v`6$N* zZ;A(9%(gd&hw98^C0Xv(oh`K_6(25yd{}TGVa1OR&Vss$eBT?0Y)N`xA z7?a?TP01Z)%(`Rfh{tzY?qUb-Th0i@Vl`qL7t^%C$ap`+#!VXh8ee}a$?Y%EpBWO1 z^r%bwTePhu0T;q2Mx&TYh+gN4r+D(&v(0Scd&Nk+o6)0|d^1kN89#S=+w5urf5a3N z^YihsHy)Ti`!MRH>))>`k%2YK!nJrX1jfACOGixcbHw)Mhw*+Hh@1B_XT0+^(i;^!Q7)9qqXKYU=LkQEWO`8KY-thf!x^2>35@;@G zO830ETx`hvsPszuu0U9};%Xq+I5WsXf_Jwc`5=%{g~r0P>El{B+X6IFc@VC$zJ`{Q z$vLVhjGqJq*}-<|`4kxN&p*w;c=%vlalf!S3*H@w_dRc)VQ`vB_rcOual8HBPGRchtg7x%`aOiJ2}j`gG+3Xa3z`E8Kakn4Atnu_N(GIiuZ$3Rn=&$!+=DG>_VUb=`R(kD6I(tq zBr)zxy|eB7eUno^{c`2ZB`DCtxqNhKox?-A@xpE6O#LsVKteZ6i&GCY^v}1%7%p-&v8T^quWR9VmIcqVP>dnyVXxT{ zk6;*(8f$X1)aha0MLfVtO6SQ*tMKI^o#cwf66;h#bxrq4b&_HC5)Rom;p1@aiwU1{ zrS&D`Re`nR!8P6K`4gRl_X^KtWl+vPucwflSD zT-V`V7!AA1e^GB_$#HwN@dg_0(p+HpzIq(p1kgzz;f3AX0i{~#9Ul+@`&8GdtXmfr zfNFJmNE!&%^1KhuMtJSVv7%jN+D^rvT=+8_+7p(NvP2b*&&@q+@+u;h@*RFVMT)dl zNiun^>&BiuP9&X7wBHtNraq3x7IDlNHFfB)A1vmxKBZcud6(uB?cJ4*;xRvjWKs~+ zyb$&2wRc|!*c=*X4Mh{~Y`P5^&x#q$$t<`XzVtX_VYT;n!c)vZT4$A^cqIu!S$Qbq z5cew-Qop#0Z&xv_W<2f$v_Gp^<%_1Y_lDT(Q1-9)G*V+DEulpB%;#Jz89IB(VPr7) zV%=pd`K>paMc4f@uH4;>#4XbbT})FrF3f7{x^v;1D33>Gewx}lbQ0`;8#@QPdIBdF z-p!$s{oY4g>wgyP4H<}Uu-Y8oanJmDYC{hn&C>a+p(dX!e+*(Q+p$0P-PqY!tl1{Q z{2G*Kffk@Y?b6phCVZo(q7>E9vAJICN9jR7Rh(EQbx<<&1}0oRXF+y-Tro*q%-?Lc z;Ui7)X8(~eW?mV#9(NU-pfvTnpA>|9;OvK>Z|=OzOsuKjF!V}_sraOiM;?REwLLxh zK`s|rHS028duxr+Q%sOE)oIT*y;1-0RrS}=(XE(dE$`~3ny!3#HzvPeU=XZ9rRZ0V zPdsO1DO_l28)pyJ+6@EkIU{PR`;UGN0yS8?zynWbbYO*Va+zxT$+GV{&=#{RIRBc8 zA9Z8C?fU-kpqReVBVxrxcV)N5$(tdgeK_Y{k_mArd)?cLYowGc$YZoq9V!>GfZfkk z(OUVn&R7Gp7~AZ<){7QU{G6Q5;cD#=#i| zwRo8hrN-)IW2M73FA+cQ6QteSPNh%(Mt2wii7ZuT15+ZIathNYbU|=|EQ(#Q413|% zH@H}7gfVkx9%l|}0k4CP{Ec!Wm8P^QE=J_WpU}?F-n#RJbr(y6|K!hJC5EGSfiGom;C5R24RiLybWPV3;b3CbE|+{?Y--F`cjiQ=oI5V-T;#F;sfevyAeQ3sG&G`i>g!4w3i=XRDL6#UF!aoH!7x7u zLWljcJaejI@DlARy?!=v@SFxHT)UonH4pKRCYgWy!6idu0=vCj_m$wv58iauasCBq zQyvSQv9?@5yG^6fzo02?tsZ}8Gb!85)0a6{Th8PJo1Mkmq-!)Er9fjqV}3a}eX`iN znyc631Fd}%i_1kY^|Ih#V2m_7zZdF757Z`pTF7nJA=qr`f6#eXGF(5@@BxvLy`-?p zl^o96V0?Y%{&c+dAocW@f*|-rNO?j+IslOQaM~n7mk)joGyacX^hK=>NZZ#FkSE6{ z*}+@;?i89`U4l(tor`-}a~)T3jKXzHlXiPIk|6V3=C?C4w%sTwZqm_~e}bWBH#fgF z{-1?3o+ge6j*9&A(aEHl@2+fusc%92bY+R#Sjplpq4Y?*oe`hHOsjGr)I1Yr-cpJ_ zFsw2*;V3MhrTN!Q96U(2m**xo*7o>|RptlK_csCGE$j=fgl82SSOur97PQ~o>767~ z5XpB(ke*T(hS+Z!{Buc_AFmRJi?kgjn-ry8TYVF7f^GZHsb5rC4RiJGK5dAg+nZx5 z@)C}r?8XKh%;9E9Y7*EC>}V!dZS8;XC$@uVC*s%CRS(-N1hw;+8?->ROi5~&_%i1g z!H1%fYX;QL;ufU+W$rA=)SEK`Bs+R$DC_C*nnQ=D=%%^BdYKviNFOij%C{F6Yzlx8 zNiMf$#3aRvrZ%E;C!q@%XHMGK(C?#idF!x~*-I?a_FXk4scX@d+D(JEs#u zh~dVWfzT`tseBgQs&r!{A9GANbGg^=9e9s0!{>ZX-@hVfX2+Z)^>m2K{iAZ_hxOpl z8?iYSK84z?Z)Qt7SE5xQnO*gH%@IRT-AnT%TLtc_-0ueLtw;Oh?cHNi! z-n)Wp6YsE(dbM_Oom^%|{+rlcnPuBgTO>(Q;Q1=88PoS@yeH$see#1}w8`?)#hpW4 z8FuIGwr_3rRBKkeT9=CElc4BRVTH%M%QcRhx&ySz#NEg=2Hhz3p9WtQ#(@~Dr_c@G zn#<$YaI$;N)1nW!y&V=#Ku9_m%|{mA)=5_dzv~w&yuap1PSR&90a_cVng_vc_MiF} z@HNYC>~ZcgkWX)XPi}ngH!0>AlFiiV%`4^~uMD5Aesz6Nyh%~?Z=~wi^k$4XYW{K? z4m7c;O;$bfr3wlU_y!Z>h@3g=j?(Lyeg6DX3L_fyoB^AnPuhsYoXJ|)%zm>5mp~pU z4b1KZ)irOO?mr~|c#)@;mYaK7Xz)*L?qqCLg1zuX(-@mhL!;lDPG?n~$S*Ma)yD|_ zVKx+JGt(@zE6t)>vvV#78QuDa^{e}LlPH452V}V#;*Ydl=M_){UH$cZ^eN23L)`^v zpT-A7*lI-zfutLCOH$2p8I(7JR!D~EzE{&5F8$F!Dm!DYw9G4BC?Pyje^72j;P~^0 zI|fp#VOcMZ`>$c%DeYO30#r|bqg-|3NY&`dfz+Yk?^JBGCfeVX%j6>TerSoOU1Axw z?!VZnqpwp%QI^u>CpDwl9UuG~KXXS`Gv6KT#)vBsz6q-}E5r`lo#x_%9LcJ4+Boh% zsM##$viA>6aa{ZS>n}fGpo`z2tHoQ|Q<7SM&YB*?BS2r&J(LV&pOm<1-CFS0%%Sdu zxdikbuYkEXK$E85<6c+(RtzotFc#thc>lYfHtiv&ra!$%HlK87<=L4B5KyDxyo71 zDiyIxVPwWCT-B*;n8j|4ai?g6irC6CRR(89g8ks;_?pgTZhasxCi$PK_N5!xO~!*LlyCC{l}I(9NP=b2DxQ2VVUT}wN#Tts z8o~ol+SGQ&aJp{|5x1!Q?;1hJ97v?GL)rPMsYFbr9@(kS_+IB>L|B+_o12j2a&DW@ zYzHm1Qtw{0;OZBdHk+Hyz1^WYeyx!kmj?&3Lv)`dVXs2BA1mGX zcP=^>gO8e4N4Jw?i>$=q#;bn+_HCV17ONZW_WLa7#DfC%+j$p6l)BkhxECvw99k`U ziMPSNP4M8a?_TL6nll_;!!Y7Yi69n!aCk;|DHJULyCFd z)ryAHa@W|7$#pr)R`p3?;S0RFTU879NIT_R`wcFN8btvV?d!PJw`q`-%wGi70(i<^k`kY&gbE7U0=)EA8GS4!DmlhAvu{z z>^tp>yp4%F;Hhzq{F0>%GMEmOMj6emBt-sBwRlo}BK8XbQp3{x%P%t|aOYs->$+ro z@cy>KN@ww9a$Ni&F9CS5I4xp9-hMPGCJP6PT(&T$Lk1||@`_MW6aHoM>Z!`5C*Zb? zQSYUrSANubY^h^?N!=u5%RFSCZY7O;308Zol%rJXg4!%k=ANA?;5k1x*=_M4o8b85`# zrRwL;-A{ik9V>Vb?W!cR9sjrg!gX-r6Eun}B>RZga|p+KT3X`Th944Jy?*MpZJuNg zT8^501r+nhZOkbwoy~rdH@Y3fK74Ym$h>?XRF-`CS>6#J{3Gxw%5Ik|o_!&lh4qX> zFcc|t5mX9MhpB*ZwVkdP!&1SO=`cQ562X=@TSrVqy8Uhe;x<*xW5q>7xhFODmO>So zchp|O4E2PXW?W7{i&Z|6ZOZ;ANO1{sSV^}5vE;h8!-;mK_;=EL z)SyRVmM!r?cgvB!^57OMk+3HI7{=8@@r!9~ntmtc1H<)2R3-d~=F>+y7`nmx?5*NA zVV>PHRg!uF*)pt5k~G~u`m`@b_`mjZYwlGS?rFGq zY`k*O>u7&%mR4RETTBB_P0~xEZ8s(d8v0eGbBqtD3Cxgh9Q)iil*1p=Y8%Sio2x}K zM2f`u(+Efz%x_n&+6=nM(xzs0UH6vM#&CW%ikg%YHAGbSQS`QEt{7?ZxL=&@_i!or z3R4$gyC!#>?&8djD6Cz5cCZ1%<_n{?ss+3*?!xql?=Yks%7f?vr30sO>?THPo{(qA zWJMS+2gD||sYWNqBNoQpEgnLBUk>V!IWvmf9oE1N?>3TNNkgM1g9J;nQ1nPpxDX87 z1?+9}&xfxbpm(~uvCJBjuFKa7O{Cm_3wpUV!B#~leu2SjEgxKy6O^m;Q}JU zu>hrHq5ae&W&$beons>UhNT6&%gmgFPHpeYC%-_u5AHZ6^4)d!-4%V|%&h>8()%D) z8Y&?iDVg41XyG)-RuCHCY<*cvD>e3NhT(x6a`F!t*_bE{@7@JQpblx?D~6XmrBJBj z{=4&gIcs0#%f{y`6t3NNn2nUwAAQpg zSIJAH+Yfs*gug)O^#;c)8xaPu6X6f%GIvzB4hM65fQc#Ppd)V?)f*pojzk%or#jGm z{1cK3&eoT)6y80b7_uZBTwtb)voD8>IKa|u?gagIPfRN`)}}fBrC4ODtRi_NCtI7v zazuF4E*R8zYnkNvarDZOL^x_E2<&#BlQJITZ>`5?vg&K1^z8GgWVUah16R^^Pv}_)QCmnmIrlua0&dh9Ay=l$Shl%`ds5=dh4<~+49S`vFjGK!4#Ey-*r|Y%HrCaW4 zjd(rcx@c+MYfFMTWhI#8frBodx?!~j%(Xcs+{E5SfZM8Ei1>B0!(0MxoL}If@ATG( z7Ng6GhsBDAKPV!9v!#BsyMGLuar=ssbx;YqvZh=8UFrBy^T1q^y@4Y+wPC8`Fiozj z0Ad^Z6{fT>f3NI14Yb0g0%bIZ-u&f*CN~~ctJ0|+ts6mS0dbCUO{;MR`rGTu{w}zG zqaYFM0ZuZw5lCg%6UP6jX{W;!6P-PCoyYPMAe?1gKD%*$7t^#udi4)_k z`@hvZIPj0Mm7^Eoxm)D28YL1GL0_kNxR?(2B-tze3MPvhp$8P)bVdqek*uWJ4|mr2 zmQU7OR|E=p0lq+>-wd_1J0T}4p4&z1>s#629IpHsfexGO=_Je*dH}gv?z8494RYir zo~=)o`BJ`O^l95h_PyqZ@@Ug#kZ==oD7n07W>k-BNnMM5b)w}>U}#?MPKyd`Yv`|~ z2G1!RYT0pWDb6=!(LcOENu;r`&9m*6Gs!+qP4PT zOT^vn+5x!(YL<|Vgu3+sXOMntb3ps#usMAwkS?eufLpcFycg&`m={b~hJ?^jZ>~<4 zpUep_lFqNL+2aHF)GNKR9#9m;b&1GT<;vKxxE^9t|4SES-7sp}*5dTHF6Te2Ju_T0 zF6HplBKd1KOmpd|-DDCie&KPsn7j)34~lsd&u1*kKMGfu(#oX`?v|N!L4u;7dNllt zs(Y(84a8Y6lIuCG+kTq&rU2>G>@O#ni}uMg&!6YH;xyX@xgOFa=UI+ zm5TrD;}%<7A|;2O4*_k<9pOl$;=lH)A=RAbP(qc0*aIwaHjDcB;%;x#TS*e?7~?yS zxsdQ5Dk13|3T`?9c&{f1>S{g5e#Fu`xm&o5L@ZPS4X%~EgJ$tLVPcvj47cc--BH(E zh!^<>_$(P>6Hk5N$uyoA!%0Rmfg3OWk!#U^jJw{!BTVbmR+5~kb@|~CBgz{An1_)O zVT@}+mH1J)hOjTU%;@dJ-wB_$An=8asO}v@9BEeEypFJ_+!kr@!G$m6 z8g$-g(|s6n%8@6U`#?O1>(>!Kvg-2P`k7GT}Lgw5lWA6%*9@t~uf zE4pu1qp95!=|6F*iTHeUdxc@q2H{HH!t*eEdE`R~$HG8S-vU)CdGT z;;kW`D8Y`+z3fs?1@JHAm5q|B3e0P=pd1$%rjR1NBKDDFAM=;MMSVUj=Z$blm|FIX zRc*(A$P!iclq$&etDJA_25R*yL>Wlzpo8!6QJeMSAe*)(E|X&ruZ&^`B##C zE}W>8vN9E@v2r)Jv;7a!NfWQ^i83rV>ayF{?b$w7Ic_l+2m&_wh}z|c&wnJ5axqx) zFaftT(jU}jpZP2)k`SNi4NOeIB>4Ut?eG`XMk+Q24vZ!P{Y(5KpU2x>w${_`ehNRm zStRR80Y zl+S3hykRxo64d9Z!y=hY(yJGRLm>X=EkM-cerbgw8DY>Q8Rti-2A!JcZ8lL8cn!wk zQ-{Tjpc+>9Ry|JZYxPeRDjj*vK7AR(?T+gq+%F3IpOz7fFv<^p0%%Q87Eo8>(#Psk zm{oa(BAKB2I+qT4bY}>{{4aq|5!>tMwsSp`4$AuI!$|3WQiZ3b2i{n|NyN=@>3%~V z-Gv*y;DdhwoXn`Wq5devF87}4vYSVSe(53o6_*^>i3K~$(eo)@bn|xsoyJIoPB34L zBGhQERK-|iR|9v42R51`^9_s~m&hhfKg5V8I8}FN9~w*rc0Rc$S>^>b_&0k9%%BZ7 zGZd1?^nEpYi|!7l?m8w(991B3|E@8sS)Tw$=c=ywT+K z^V!%Qdcwcr|6%{q97UZRI7IIK;UQuPs?AP9(!{}-34-th0=oPv4>uApOj4vm@MUg5 zN#}Z6+QI+nZ5f3ovG zvyJQYI%#vK<0l7s&l|H3d#yEN%{jks&VO_GWJbI77#Sle z{Dm<$%<<2bBi))+1m;Aa_rEOw;SNh~0h=JkwCbvB>|W&#O`y-G;wUpLFW+VaszqJ( zzWMVT2C7yz`jQGcl{>WHQ^8K7C0XrS?eztYPgqN`6MG1pISlmAc!>De@o7i!Do&C? za=%}}Q@4F=SCEt~X-lE&o%|^D?&Oevvg15juv4f5phL}D%?tngT?-uL%UXec$BwHl zYZr7u3Gdy)G%yoVig)QOzKp=C0&P}Z=TIDw3sD*5S7^`}x;K?IHn+_s1c+!|qijzL zyFW8U6sE!}UFB4#O}RY|6oIDVcOhDceh>xX;?w$i69A!$!C4h7EQIJIkjH|)yOLg> zmzFwW`I=J$lgFq>cjM$$qyCZFVB}a>S{`ZpTj*PsMb#=(*gEcYzKwg!?-~nfiq7!|iK#qOAFl zXr)>V3^00bmK9Z$1KAgjN6{QjJynZ2HUGae^zQ4t;}?UMUuxfR7=m*ZH)j0}^}kKF z4Aui!*#E5u{CEO+q~C&!V6LX=^BKf*ljpmXUS~GEQ`X5;N}4zv6PufXCqkbMa=0LY z8p5cn2ygBt1w5F(YI4X|T|^)CN`d~w0e(A?mz50N42u<$!?uT;EoER!mXndi%mWJ$ zW4go^C~FjL%A^3fMyAQZs46rnbUEM1IVLUi0A??b^V}}2(c{Ja2zxMbbGE7bU&BkF zZh;l_0Y=us;&(-G?KlPJTYHS}vh$<&J7Kp}^iB?S$B?G70;6gm)I^_KMucciPp=OO zCZ5lOGp$;OH3O(78|WL2c};27H$JC3pv()H#6chDzklw2;w=UK_1CDqK9P8q2YI$S zm+QnG<&CV#fe@UIl*uaG)Y@gxHr_w?LfIB0CETItH(q(>KTj`32|71Kp9{$r@~2D5 zJii4@6r+9a46o8u2KPtZoiy%OmvpcPv&A@+ZrViyt%2;(@;5BK z<(TNnC^t_)A=uu?hc|z;9c2XfN3#j0s@u;${+ZTeI)3B7Lr2Qw_|1O0p_=X+DY+|Z zncg1IIdDgiV`Yv3=_T4)2}{g=yHj$+JB~dL<^il2Wz;C|_bO!dA3&83k^}7uUb$kA zUJLKu8DQTiMD(%Gu76v@QN!#k9&Y&lgAVh{7E1pt=MCjSLKBNpwC>DDlqu+nIk_nw z9>K?LIL^Oz6Pj*lx7q|sD_ZrS7M*L7@`+z}lx5iz-}`IyR5L zEQSU7{MZcWWe%X1|5of2bmK(v#(u`4mND5iE^L#=cWvQQepCQG`@&HZm0q#fH#HTI z%Z^=_OWnA!{F%dxc5AN4oja(k5xcd&y;;d#~K^_Sz{d!?TDBR%Dqz}%5T?XGa( zu@TMF3}5WwOQ*BA+kNDR`PB)5`M@=%cIo6q=qke?1d&U>nEt7KRsvBJFXbSE1~>qL zY?!%_a-RaC&rwCU>&bBcH@`Y3+()Og3B}&ojHnq8RGSm-e@0!%+lIS3-c+-R%4rid zm3bDSUnrA<64TlWb?x-65B2c=+cu#}c1lw`S4oIY*&clLDF^&=68Djk*%irj7@_-) zN?4Dqr8#W59h*_pA9I2u$g}|8Ok<=lZ+BZ?MF^85D>>31(>n0Nl1RRLuX0$>7dz^i zWtQKm+Q_GK)Yo}t}x)rUPBFV-XU}`C*c<(av+5p6Yp!_^oqawY&Mcg|LHc$)u*{ua^G`UgJ&y5VsCY2$oKK&S~@5Z6-Q}CN=w&iy| zRTf6g@*7k?&b7_rQVchwPg{89+q3tP=2^cYO|hOER&N{1G-l}icxOx+V@8p#B1htC zVM@#GzD>uW9~1^bBpkQveS$5@K{Z5;KFiZPcCo1{eIuYl$TpK3LdN}32x-UedmCu?#PoQnxNTr>@B5pq zquXLqnFC)%&zUI;DxvhFM-XU2G~eRUE4tqnv~sI?kTe{61F~-Yk1S`?O2PqZn-rRp zwWewNP3PKAfGZ2ZUsxD=%+!0LKjw4q%FsVfmg}I1mtfVqv?<0p_B_P6ZClMY^qR2S zH*Sx=m=3QR&(<7QZK?Y9tfz6N>Rav$AMU+m<+!XSIOI=Oy(a^4FO+*h5`@df{>65T zxyZ&JZIY$_NkZc-IFls)dGYZbhue-szJb;B!AJbM(nR|F#aZ`Hn>u)P_0|PFF~ZxE zSqJUam5@sFyO&ii!OG(Vt(tw0H=MTX6;smql-A4KdrTK!5_kLkTIe71pZESVt1ZfFw@6{8ZiY}I1?}mgJxx(A zJXgG=Jd9vlLelV%45hT^MV1GtiYYZ8BO);IT*+NK?)_yU>J6dx(TnTlOX9$F?m!qf zRT^c1eRk0y)M+CFy146|HT>P5Q~x<}td4;aQ5|>hW9!Z3oA%|K*yT%%P@a+3M&5+Z z84PI`#@-M*-g`4%@;0&FMv|brLa9QOA?7Q98n-&@$@>qA^e5nZu-_aVG`VT~*#A+G z>xDi|;x22y|F$efBP5^4?y=C8CXKnN=YLHDY0Hby;)71zj`IcAk=aK%VoeRFQ(ANA zQd8cMKQ>mEQpIITXH`CA;|?E>p*=j6_|+SD+bf%&YfdLy%KD{}Pfjs)=ewt^;8Y%D zpYRDopS*FFX`EiO;m&krLq%rCRH^33c=aEa8;?MbO(VZcgAgV+49!79g_4`ns0_YxxArQK!u{f!B(YqutyB^-}{3Wtv09lZ*Uec>x{b45;hB6Nal~Jliu= z28}_O%Jqb;O6xXd_Z0y&RUD91X|2uOt20^o514x~c2-Hk^KwzVN9CGP=cFZ0;&>rBXO+(*j_?VFM;Qqf8* zqHQqIj9P6?r?qI`-!xLN+@JV-6KoS>FsHyw5*4HR__JPxE3lcLL1_6~77W6atTt$v zzMXyPD}*!Gi4B;y3?prU{8OzcTkazjByJuHw66D1b!S4Gw9&U6796Px4$L%H`&{4P z!gR5HOSJ%90;3}0hN;zXqk9>o^59Tivr}0rM*emg*Z){{5}P0DzoSdv&GO>(;%%ds z6hu-j;X8Y{I&1l~^CfcFsuvO7oZ-bOyY{`$zJD!f^d3rQcwxu#y{t3UWxk`-ggD2|{yjDP(U|ZZewX|-pkXIMQ+hf37@nJm>x$0n|_ue@> zPk*@B_|8-@oB+@?i66twZGK~^d$J%nHmtFGb5}dcrpby)ZSoOODA40ouSd2`kIN{| zh8_q>x+wikryG;DPagkV3SpFCG|BI-i@H+P17uv5FCS3SeRxKJ1-J@YS8VgO<9{n5 zX87#JFaHLB0krY>>8lc*n)*exZW3FuyCks@@&ntZ7-$8y{@g;|3GJ4|XW9iExbxk- z1-Q4Wyxl(8zeZr>QQP8S6l!fQmb`v%fJpn!Gi#tzYNPJLlsQ~Gle+nhJJYobGp>O9 zH_4tRuLLyx_Ed~wM%k{cGgGMjKv5YqqPKy{M5BT^CV;p8Se^BT=39Zb>~4|i`3qSl zISx5KIbmkfsk;Gw3|PUU@pJkE(x&y2n8g@z*5j~`VdsEq55VLFw^QrGO$|k(YtL|i zqd;b2{Y{5JB(+E-S}6N*S=r2NV#~((l?0MySkJKIzFl8>S~d~;L|gp;+K6&|m?$TK zbB>d24m>K1zO_dUKTg4lP}MKj?qvgQB-y823#BzRO(wiBoqM0t(`!J$5G})+Ryw~- zq#T4E@S54mKC&TsJUuyT&>12`Bmd@fvr9IMr;}!5Lgq-%_i(YxexoD}0Kh*PL zXaKB?b#TWKb$@%ty`}tj`;z&cQJ%}*LU>RIc?0(P^0i*zKKx89-!9FHUBdMMwYzNu zxp-a^e)RfC1N_ddv2Tt0NE-&Jb(OpAn_;A;GzgQ9(0!Q);hPgyy()vTnEH$s`QQNC zFxc(tkpr;>2*nJsuf7AX?bBbnZY5_YJJU5~JTsI%@_=>91eegL4lq`(s$LZm@a6w1 zX#A1o+45VKiC^QxxoKuP5{p^Bdc#8iq&j%eyiI*Si0yyIh*PPK)J|=VE%FmScy^OR z!F0Rn_AG|D<|+MNbBD%K)JONeJU2&643u1bY1UrD81d|C;x+23ms*mzUF!J>@B?rx z>?Dl~c)f5}?glIVgAQ~{!g`?1J_EBgz2Sq*!Efh1;wioHsS}KS6#Koygu7Jc-vM4i zgv9wfq0Gs+TH6{7_!WSIL1WXInv;^rbKkPsbMt}qKLuiO_aOp zDaP8%LG;hgi>7bQEzPHdP?`aet$SVE(OVaH(_oUbG z213{=tgY zg84rB#E{u4@;E3~2G^tBXfJe$lU&Qihjuob?X4{;^(;%+opd6-*-Y+n!8+}hA_(Yl zgQaZ#rflSh)Mg&WW}WGfPJ#dY$t6RM5N!oF*T75`$M#xvB#54e7VcD&m@Qejkc;jn%g%k$k4xzY7f^O6rLp zxAmzK2XKbkhsdtkKLCjGmUEu^B8XqQe;6^Dx<6t%&yd)Zt^Po+2pT9t|6+eos2w-2 zwMCn|$+v%EvTc>gXF~zdqKuTmq`OoFxgBH%V771?SnU}Ykaz9BRC1A6p zPd#91-(CYi(&@uy$RZh?z<&_lS+Rhog1EnfPL%b66MAaFgkWvHh+mjd2;DXmYc`@< zk@^KpBOT(5urL^$dr+>LK#V9YH-B$4|XQC3&yGfEe2 zfAeBLNC_Uzm|Ts(!=A{N@H{V}5sDqfi%N##(y1!WZ4Qm=CzcVg{x^g7!bqXgtAbFIK@sgv*g^HQ7y z=XYkb&W^fY2MsuD5MR>Sn(I(gGTS!Gi^lt5&YCHHBSs=|k7vCKQPmcQnl&&Q5EJIu zN5RPVBLqgrTa(yjgBiMBhSbuJ{nZ>yLhrY{fawYT60fX~pTmPlJhj^`z8E08bq`LGFo%_eljt6C`Kw?#1U zmZyA=7n@xzYiAppuIC*ZZQ>t{*Gg+jS_JcoQqgWl%XMtks=85@J}& z@jdOn7mbdlG_C^kv!s}QH5i-MB35OlZgMR8V7p|7^B|1zC(ufMu;qgaJwMp_*HZR6taSeW*E3E3So>SQF4F7-CNupDr#>4vW;izPNjYGS ztulSS$DRkWE9ANidr|N>X1mX`9d*`XQ|`47UHK#kLm$WlW&H#rao5;*^q{NBnd0lzpZuLHnxpGDfHWaJee@y7K|IaZ z&UtztgvW!Bs(Xh8tp(y0vDu$$YDz`Kv}z7B{?Z)>55eSbWKRzTnMS z)$}7i>ACRXg1})CQS;m>HYxK0i>GPn-)TJn>u`GH*#90*yM?G+S{sPipKB61>!XDq zmU}zVFDm#KS$N-|=Z^~zF+gSj3jm)tH4bGUm95qlT7!@6^gP53cAnx9ekyxTzwOp~ zPL3EWS$z-HE1OvuEAIGM?&+0mVKg}I_jj+u=MX{@l zpT&4pP`-!KGbs;#9kydUuMY;?T=1Aa+?34j>+TU5Qu4UAN@vPJdNB*Sxz19pWcsAlT0?-A|v1mnvMTlDVWw~v8cX7@}O4URPqqH=ihfQ@4zg8kd zv3mso(6JAi+t9$xbYZzdl=p_Y#L>lMY@|uJ)%T+69S2@z4Lj!Mw|GM>#h9%5LSFE` zA-tnpVEO0QwFa*p@LX9%)zO11k-*Y_MyY%vsDuZQ{H-mX_q(P7`cVJ#Lj=J}%_Ck^oy}bO>CCgJ^I!AJg$7k>lM7g2wup%s zfX@gl+{XVboYx(a=$OS*h9#+lX{F~+J^(fZq0~2(+kk#+xT~gB7ciM&ye2Kn3JO?! zElp`Q`F&W0yaCqT@n44ME1;5LH3wzXc&=JqGL~}`@#f}B!Sqk&DPjw6utDK>K!tTF z33xx=Muq8rX_g6?ll(g6O@=BpGnKN~c}pReS^yT1(&uk;S`VqCn&)#Dr)nJVU|i_> z7{OgA(oFQ`CwZijWpfmpEKVHyF2>SKfyet|%u!ohWuI;!Zdw0w*79dls5@HOsSj;b zR%TydgqqOi*Da-lG@n6D1FONtYL7dhy&G3cw1j$Z4Ksgu*knf<>ZNuk&dLp`scbzvPJ()af;8T$sW@j!Mh@J7LVA?y}_P@=9A56nAS zXW`x=%Iz5WU4mxp!4wHbgXq136Qfx~;xP;ooY0Y|L{30I)f}esHS7$DBgE+L+6$za z8gj&+R!>iNrz~QFSlzHtX%U_Vl_lxt*Ef!&w)Je+VZIml+dFyq=6Z|&gM+f9=q1o`QI8+0Spa?yP_~m`igX$yM*pUM zB%+fenv<>E)E}olB?nW&cCaN#lo4Fi#3DPxLkm_c=i#zllgi)_rol~^troU<+=N0M zv+cG=Ig1 z_Z|f5;tisiPld&jbpFjvg1e!z4nBAn4fKbS3~-$s`jxgLH7M<)4NXFS2>IJ$)%|J5 z?K$V?n=L@e&_0xWBLxx^WY+b*JM_(LKF_T8Jho)w*gMOoPYF*VLS#1hI~4-LtKW|B3;*iwR{I58pZAW6bkooN~76d0+2!ZKWNWeO5LL#m>+XiX)}z!tJVH4o<*xT~0sa;)lzem;W_p5(@v z+3O*B^tLc%6!V1(3%PBdP^BCQ4B3u|`bV8xCupYrXBKxy)j9$Y0kT}Pm5-|{N=H|R zIZy3`19w6HFP5hT1&~pU9g{_sVV=Y5+*|EN4`&V!Q*}B92 zTm|`Q)N7HcF?eyjEX8`kO+|N%9o2k-VDnWV)WoXz>7g83MY+bGH-|>FiwrswUxQ-b zzKrrN7%Qrd#RgHgpX7b!g~RbY9nqp%;Z?-^H2zl4K&x^tm7WCvisURcF z-l6Z&jQRHs2i^t2OO6t|H3vO-=a(6J>-+|d-+vtjd%1@FSHMSCj(43b*So55P+Goj zZOLfGJ_P1K(t8EBkxeq`#ewjsZg+Q~6hDc|e;1S5r*bo>;)>sAC(I#RpHS@S-|^x7 zfed^{t(@62p<%Qig)qyJ6Ho;qm^(&*bWV|Tn$LG`9j*D|Qx;HrjqD^PkC6{#pCoD= zZk6y4K+pLPcm|dfP{NNZ+YTZRaC|aFHI?_byCTa_5MY#ni`{9`BuL`u z?oIf8@!jz>c&jZh@ z|7cL1{?5gN^dHyhkx%A*gxArf$VvMMp8F*xPNg4O6r3@XIn~}w%F9h=1%kqq*u1X| zOrJvJiDYBSuHvJ%W`255$CF0gpN4C?>~bTsfKKv!tmvu(oHoiQJpptHH_Dxg(YL2B z7a{7h&LeHVZRpL3_}sIM1xcaxP#L}HUY9I{m!%-7mg1}UMj|=9>Wna-oV}(vsBOSH zO#O~X#ZpbF&G5!@1lkTFOUJ0OfSK+o(2+u!)>O}clx)15l@Wwu&2=dWF}m-n6ZP-f znt&c79otR-2X+3|vya~x7-Wb}%1~7SazK+cGY{_!=ea!CeEHY! z_I`7kllf%}nr^cO5k%_6^pi65Z@%mky&|!1&X8t~Ihq$E_hIE}A}gS9TJGoZFi_MZOi#gAHQg<0mHEp+w~&?Vk<8&}=^pEq9?_ zFOR2Pq{Hpdw(FN_@utLXBh_p1JYbsYN#9VuRG(dxez>xW)@-UtFWVQGpVA?(J2j#; zZp!Evai2I5+;G%}^69L*E6XxRI`ju1q%nV4q)Le!k`Cm`bg;0!WYs&5ala42h48y8 zA#J=KP5#qsMDAmPjDd_q2i%w{zaS4bC2Nvbi+D!-2@arV0#VNk*0)dd{$AuF8n##l zesYK|&PrHP#ck1lq)EFa#|Xt}6tdq}RS(01Ry1tVPNpI$l=*gEC z*g{rXcg@aS|H?%FaaH{}+sJeUsl2gI1T5Q~8Bx4U>G=@zGRajCNtRum&a2*3XYFN2 zctaS0M}JMawv5wCWgx=Z*#6WIgqaoyvE)WiUH{^Q zMw&L>j4qj$<~b3|oynpWmQAxhzkYMZq?B1vdhC&9Dm1?a81Wk`K?);w=hFvX`)=0f zAc98$Dfn^eDIxnBk(X&qbIH~}nj`JPCl7LGD;setiu?8ROP*f&+at_>H5L4W1RrOT zfG0ce-_}UOG*=c5l+YewbQVJ-s497Lq?G-s_gdhMWty(+L%Oz|A)Njbl})AS<|LI6 zSs&EJ0$7^gpvQCm$Jh1nM2DT8wIJrJ_+$2W^lifzx zeHQGh)NkSy{fDFKRmbz)w|JNp5uA9 zACt@j9WLzj6#a5NvoMCJ%*(C|*{wA^xTJW#y>irbW2}m0Z}~2~)q70$Q6FmIpY~&4 zz%pi!!F6u=3d!Z{U)D)q%{1QUR9W;Qum3~f)tO3j0$cT2jAY2*6={nM2@Esd)>`!F zZRO#_OZG5$oiDZ-ET2Uw|D^|g%8HWP%$PXUV%58?E6;*8;U{IbW#-K1g7Wv6t}7I()@su}LyHYRgY)5nL3Za=t= zUpzmT`p}jZj_GJrdlb)q^?SY7hsX(x&7Je97k-rYSCQk^0kll2=lPu!Q#n>vbR6hO zY`~^lzMs|BKpW9cYh)<+f7B?m}KlzWgD547}bZaVMQN!`IyQXE-G`+I*E~? zi#3~DcnPvoInu1SVa`cEGlBKzO{SedLy(xV=9Q(NinAyV3)8^$f650Kg~^tQ+g;~s z3qiKvV|_X2TzrH)C3&7U9l86sD$gRW-XoH2tOg0zFPo&um9~`-v$`Xz#T)mV5jm|= zoYr6ilX}zY#_BVnKmgCJ$HykB32v-9Gn|dy0{H(|WDeL(`~PZue(=x}Rmv_;_50Kx zeKXECa2T+|h<%J=DW#X+*s1GcUJ*1kLbar)7&&XX6s^{sDXBAaOsua865nq$2657+ zvaIcyEIeIEJW!R0T%vb3wW@0A`50fM1nRCTbdwYnMe$aibI5Ow$NV;oxnAt-nmQma z1A!tBHuV`21bxWaQ^KbRd*u0y1VGC_X|Jl%IAQC4I4ILcW}`ZWQp%K!<9_-618u60 z6KP1U=R~ImYH`Esiq3AgN;5LIl9PyjX{yUo(+(F6antV_arlv%r=5m}GVwBW{c7$| zx-F-g@(gyd^w6yK=L7!n_aQA>ZkdlII$z2;(|;Rj3TdOOZ9c3Y696=0hzENv#c$Ib zI>r<4AWL>9YYH|B20$E5qf7N2d^){<^(UyIjn zj%(hUlt8z1f295cYfs#ca(Z3Vti`^r4zbFx)>gPH&XDJ!C+E-eJ^A~Cy01dI?7Ymg zR9-s!op`fke={aL501!JGSwchfZ z8v;NSZtl0;7>$Xo9p#OrHLDj2?LSPi9a^0;CNA2a^%UyrS8GHTIxQ5tMPg>VX*k<2 zWT>y4LXU>h^Uo&A^YEA7seN&&e@U62xML=}aB);$dD_6>h6FpyCaKv!Yxx=6Z7D1T zKxzC$gSoAFladLte>v*y6wx8mjwq%D6tcm4RXebxozMHDBSO*qzA`ON=3~Nhv23t} z#k`N8Nxk=WZIaNrTuEuLl4X&4u6hhf4!sdlMi=3M{%Ek}H_3V+i0#w+AI37itbg4vN z3R7fmpI=d3wRMS^O@JUTPQi)PAZRCy;8qRVg*fCNa9A4bbC^Ot~GW6!RIy9RS)YMRL_%z&X z-MQO|jvqI-W{@(u$ye8zLM~L+D8Szc?HuMRmCGMXcgV)W{sN|x&Q+(l~ zf@j5&Yr~PI9@+*w*2ilb5jhMB));V+KfRu~)X;CqP$WhmRdXt#tM^qV+fSG8Cb19AD{IVnm0OnbsA*~MY0peVCx#v0rc>Z{_U32?gfg=R=V$gmN$tt7FACiiC4GlkMDWJ znF>|%metA%&DS$d8e9LkhWMVoqyjM=mvjAE9;I)ewi@4V@rJ3G@}H0iAvkm{koqB)!mB zWfvmu^_yGRRl?MP_-rbLG;?Yb)i!QDpBe`7W2jgp+cMUu8fxK~a=avin02V)+nLeD z35T${Wj>u2O4%r_DSuogF#>2gy$E26=nXx?`gP&P+ns4qsrK!NSl9g_;- znV-jr?mN@r0oUX?yaI~j(y2#W8-i!;GoDL7D6;$`b1i~Af>n^BT})%xi0O`KqMFyf zeXD;VjlZticK1jwKVIW7K6yd#hYJFQcG}zp|w_x zyT~`u=I%^BGXAJp5UHS&97l)G(4OjFIF!HloK;?EOWW7q8ac_0J>isk7xuf#AuLI+ zWXW9!tv!NNew;07di=Aqo?>~5)9E4i$>zRNR%ZQ<*V?4+Gk)S;f!!awq2J!nWj@DR zruIm_q^G=#8r%QG;%}>3w|~*p_e!1bF7cxP){LdkXg?Gl!Js*;nmZX+IrOR(los=R z`FHf)chHPWy(gBUq708sb@G-4 zA?U$Rn2N$Gh7#m@GL;re!OOGpvmsT?q{Urz9n)HaZ#fHqg8Hemyc-9SNFnL*!9o7z zPsxQAa0*Pi?Y70s%-3bo*<Dl)ZoqdkF*Tt|LY7|HBZ6U%KCp(I z{FG8~hqpxJB=gr^KggAXVHHR5E)w;R5xrdRo|G(jhNh-CveO{pR2JjjQw}NoM5DO* z^Y`;%IRh)$FCl7S!FF&nJArm>LeMRC)Su3wHf*!z0ZtC07alkCQkTCz_N6#qV!7FV z9dAFP4lrUqhD8Zh-%hNy%b2;Z6teI7Y@-~4a`=*8g{KX^PkhOlLOqPH?sImSnG$Cl zmCJj4do{>%s)#YeFJQs&?C$B(qB>8Sz)=4}+e_)L#v;OqD(yFY!rZTU>k{|f@ceWA z_3C})HoWFCs1F%w;PJ#I_o|)vAbovV`TA>*If?|EmI9Hn(O*b89}!-gq5y<8Xi%CQ zv|xrduH2a=Nvyq)wmQ^1=hx_hTL zwrs*o5$8RVyWG0ouUhIAwxwA`s}w(|`G+SH*>?m&a`>;_-i*&pHQXO-r%pCZ?IFc+ z?c+imUlx!rhNrbA1*l%UNuR=&3xY1rmvR}lJlqp1+4$(k{*#LXb|}I+VkyxVhT`SU zNq6{*0#^O(@!GH8ncfHYQJzg=L^PBt{Yc$edh~o$^O1!XIPLoBPD&6Z!be}5=?Nzk zA#655jGdtlP#s475)F?c#|oKht(0XhcWfu&WyoYe;r*_we?thn5MExswy!2Gb-CQA z&LU#Q#d0!v=9hQ&IFlMA*PKQ_9M>LkYE+iMLWVuGXvyB>o#}w-t$NBx@KaQH*kbdS zN__?ri8V)5T+}bVPw@pZ61-Y^yr2k<^rH%TIfZRT-HHqo%zt9Ge*b<_>(bNP`CAhB zq*sQs_^*u;9It;LqkkjOLqW+meylBGkv)A-*OY<=$P~;A_?lo}vqapGCt;k2P2;?4 z6#vQX$HP3$i_Zp(a3v8e^pamre+*(lqaIF9ajmHyfCJAh2ij)?FRT}lK<-m%cH^sU zI!U9^E08R4`PX5X02}}qo|nENMi`Q|uPn~rNn)0u+|?o039iM^tHjTR*pd<+yaQc; zN1uZe9tW3k2&8=RY~$`{%U2xwgp?dHIquU6dn^d0XWjiVE}@v!Kl}mG9_TC?0|$8r zhzRTIjB8@|^oylEiRv6HNTK?U+Vvx}{=^5E%oNui0eCavMUV`aybxRPKo%5fQ1>>A z58G1_$~io%S8x^BzdxxzcRU$4LlMql0vQ7!tlF-rUkR3-F3V(2-mDzl124?J&dQ}x zJOIs6K-P>1Gp1S6SmM@s%*#r$JOI4pbuY>jiU$ZN9PrK#-&ssHm{A5toNJVZF&-De z+bi`WqrhH(@9W_;6qPY}9sy!2K4hDBFg|v!pZ{X%`E$HsCRjmVm4WtVopkaXpRMyf zd#$ar%UQ3Y7Fq9>6+~Q040hAgk6V5R-?#jjGg+~$Sa9LZnq>pglC9)QQIrQMBO~Ij z%ZR^+AV00gj%*v2Ez0#*O2!gPASQKBsImi@6iE#jaekr^-rqf=yYep=7k|iF2n_Ue zrwOvmPWp2p-2U{gziW_Qr3KzJ1>Wc_U#Cu8k=mkGPD|#nck2@y9t3~&LmZbG5rCnS z#a?}<)u91WmbLy)!xi{g*KmIlPm_{!FJeJME|M`%A=!@ zD83*WBpCXf{*)XWeFly#hIa}ERP}zh&(*B~gczW@OKMQwhY)hZv>z^8JF0;6-~r2` zDC<-9$pOA7Q^TIi`@Doe>{S(*HaGjPtw7ap?%{ z7F3em%m|JjQ^iMW!~%_!p9oe}{)72`P2>dAU|WLWgc0Q(BvKS@4^J|(Dr$QJkmVHt z#ZomOf#|-S(sOJ-pR+Apy@r7VTxBc0c3Kh$%F-z8!O_(KG5YIs{eN?rnpiyLkY%s+ zSWpeR^S9&|fZknRu7A*)9HEK@0S<0HC&=P|`mk7lJ}hQ&zHiz)3LwYJUzk%!0)WvT zc*w|F`S&JQSV<8GaXKEnUBiob@IJhh@@0HMU#S55d&N4y2{tO^Lhzv!tc-y$kZxOB ze0WgQ*9l%H6hTc8-VeJ5+}=xc{Kv;vg0;ME{CnKcC)3mc9cILLOa9lV)`9Xn@WvGB zkFiSLKTsh|K}WK%1FN@$5i+6kOqUdqwm1d^5-={Rh0OkJ%&NBuOxyH@a&q9g8u zoibgw-v1Fiz?KNZPDgR2#Z=QjZV0@)JJf1x^T+&W#O{S29+S-nU_=kmPp}LCaRcih zspmdF+9e|^3GvlH3#OM|{*_pWbukO-;Z+#-tXPP1_szO_n z-W4aXvXM}7nDjN1j~Z&=m}8< zXF!!q8}^Gdav%kMzaC7^2}CtdC46IoOB7)7W98;>X zXbU`70NSIgLB1FK$KXc>gN49k-8}Eb_WeB!n%S@>KBeYFFZ&X&+>lLtGouNzl6I$<`Vz}IS204_ou@Uan%{Pv-Q zqvd~x-Fbk1^G$>*h={FlMFJ4Vs-S+TnP<(A`0`|c8D2ul*vx-^dF1)!rWO3@oy(aD z6~#O@>}}}=SZ_TNPP-#Gx5t19=_fVXEd*pir8GF7**4Tyu}KsY+v|7tv$H_5+Q~$q zF?o?C_JV}r`UM@UG!GGcqCL)4z%78JOjRn(!}J)r*`s*hOkr^50XBtoRloxTs;y*_ zTH?So2*vrYgY@wPf;j6mR~FExu_%Be0TIgzu$eUPuJVt2!Ew?*t~|@_?=9U^1o%2W z0k8Y)Yn~OTEPw;)afAN>IcO2Z&Cxj*NIeO<7k;m#9umRJ*geAR%SpT2V#&3{UJwHb z;!0L`gI8wcUg|jrRNu3J2r0(FMVpZecq?3n|InRbKx316?C|gNz}ZF?tNFe0VZ@*; zq4NoI+wFi@H9#zXEM!0a^0$L-MD=G12vZlLGFJjdx#Z`Y6w06`s2NMUY%v||Gs~4b zjx+<-;ucL8ojl$r3>wj>l-vr>WuJYD|NPxEhdY$)njmn1 zk_3usLV<$S+i|uR1UvpLM#3!ht=6D5Nu9XUN<8%x#&q!T)PxU3J8|%Eu_a&wDRnY9 zYC7;8mL>s;z#_E_F375=NR2>&Ia*3%Z~~n(&4Q*d7Y};L$8x1=Y0GLk%8-X|Xi#Iw z*xbGTx!+!@G=enoixnhPH&q4|6kBH{0Uk6z?*-C-nU#FO%NFYIxsLR&E`b?Tv}!|xJg;Z*>D3q#DN1jr>Q^RgNb z1KiLLKNh;RTPdy0AmESp^SMa|LZLFjdpK!LM!ZZhD6tHuD&PeyDv<8gnh0F%fKc;( zN)$HiW{`5ZOr&|-_l6?v)2T!9m~EB}E*BU8eF9Hv**W2KW9>*9vlwV=(o!Re2a^oa z$GqRDuL05sWU zEgmd@-O*5vcFQ}H_EGQ}Sch)xiLXrHv(@;h2Kyekrj4(J=|V@1XnmX z{IFs5DmB$iZE~ae@^dl5r%mE~&!<>L)tj-@1%I~@{px>>{Y=uh}H!RxJXWFuDBzw5H z)zEkTONnOa1kr63W}!Xw(-h&CP1~O>duf0>+595KSro`_6FxFD;Ge&Nl3J?+(vYG1?ChTQM(UV|DA>Y*ki1>uyUWnHG7$4z!9zj=Cq{MuCZ} z=-Ez1@%|hNyen_Sb98ER{OWMkD1R z-FPDdpwNWw7#rA19EnYrX>$NxInWHz@V#w#C+!yLiwPv8Eg(%Jx#H>9sOZ28TWn41 z7cz8w^(*VxZ<{+{oqJ2^w{l;pX{wq|lxD4VI8r&jtJk}A_r23tAHVUVjniL!DCJJL zbU7zU-G0`rI{1lqllcC18P~tD1PY-VhDJD<*a+bGb1Py@9V3A2uq68WLGb-g{YG?1 zkJIrR%rzA&D|-D}@sTa)fxekpcBnj9nmuE<0pd@gXnRg8QclXOQqGqVpW^YO(q|jY zJyJdsz@93p+c?#;@h*XiRkkW%bbCwV>Q* zz)OV)t|^eJfTP4Nq6z*kUQr&TFIK4mXZr3@RaUrx{txdL1K|D2ht$azh^FK~o&*=_ z!k=vhZu!7_MCcO>uyB?T$?h@$_<(zU;GvShRs!Opy3^*z-6S`UTBNRBYo%mTp~I!` zOJaDF&ly5Ymy)>b;mT?U3RK+<1=G)Opz->5=T}}HG}DEu!-yz=i^8l2n49~9#ecm_ zdQ^R_!8wxedWNm%Zp-mrmCyL}sr?V%wDU(Yr@^#)HwsjF_N5mGaY2*p6(75lKc1nv zb@pP~`_sGGHoBYc7HdB-J!rR5CQ4?24f#KO+f*SVmBFPCx-OdY@4Rq@jz_jV%((4R z#%%3hP*adU8-t6>V!+fn~ToTht`{U|(QP%2A$!;dG z|9k!cSQOLJo&z*k31?HxfBow1q2syp_An{xkvd85K7ACgJ=0rHn-nT{T`|1qqPtG5 zLVRdpxalxkDcgUoD^Q$3_YIP0%NQ4#dLaFJ+0DSa&$5O>y_5$r57KZ1a&?xVN!(51 z!^#T$P?uB^Pr|4xp7VNiaAS@bkRVKC_iQEuU*3Ht=OYDq$ta4>VU!}qPl8({<#Y^@%IZUX|A%LEC z>#BklE};()xq;sd00v*Z5w(D+O!Mcto#x|NBdLH;hVl4Ub{bY~M?`2}J#z+qQQ8xk z>Bd5>1q}h6DH`pOXtjUjFn`gk$P2!<%MpWETlXINzik4)`_+L1aLy|NH1o@uhwzuM z1}{+*ek{H2xMdc%;ACR{(d?*bHyX{TjIn`2!F84PN#vIH6RSX1-I3Be+O3RyO(mdQ z1)rm1d;BR(lgJ-_d9QV=eo{!UFYZV2maW5KhIjTX3bhN zbI(1ghLaQ(37nOG*=A)X5V__9BiWUb$u z9Z4ScTs(35x_7+Ns}VmOW~5D;!WCJ*3oWYCm@NlqBE8E8^mdg(OH%PBD}>cL%gqd+ z={lWA2@+g85rXl8B4glCW)~&f>~PRsg8uV-6}remS<1s4iIt>OQ?;N#m5VfA6Y7Vq zS>{t9xA=JY33$?B=EzA*m7`V8@jo;X+%1O?1QN?$FK=V`v(CWabk8^#?&2bLV;^}h z={|=uLVyn0;xdfPAUMT%8@+At!0Y!H3XRvjm)1?*Z<_=!mma;banW4720yfj6gs)E z0z4%v>y6@wu%bX%BEpvO5*OEgEuQ3pHqG!zmVbVv?wu20EV24bZjrQnZDO-xMkHbf zH-bbe4tyyL`u#6=AVyY5J7=&wLs;E(y7#VfMfgc`svwv4dkyNa(20-OG!b&Pp=Qq{54M@9&jb93I0#`cNze|a zR|D;wQ_zi?GX)65|v= zjd{skUz7l0O8~9EaTq+Y?;?yl{DHV`oMx9C!R{g4B4^PVmtgoK{MC)`Mfu zKuWTWDjYmDDQ+ZUHHV-gn`P;;R3TaP?j_ri=$vN|7O^dcpfHFo!Jz9AdSui?(j6W(;%!9*q)$R zvzi%d*{6`!x2E%Jw2l-Jdzy!W$OSu11eRc2(W~P3M<9~(tB_3{u=sCAp@?k(43o@#wd?!4UJL| zgMi$>Y=SqWAy0u~4R(+&Z&*N=tG2OG#NOEV-<5-#Hx&ESj>}7lhLMB$7Q$Frjz#m; zRKcS5_x>Vu8SZCI4Y(cg1KlfqTquQb)!`FHtYkv`2eaJ&h@)|+PC%dC=nEKPv+=Go z3;~QpTTg?wGS_6{gr1BR!a9}QHsr-aw5Je+UX1#x>8*N7m9zIkBVKOCnr|8)lD_ZTwSjM&HTAa zvoN_AhVAF8Y zlBr=57(AeyH8vxO(@+vSDy^XTvC*`|4XNUN(c?^NNO+q-2#Vw>ah#F8(FYw_Jw@cc zcq;*s)5T5|_wwHQz`v{rqd8&Qaq!>-x_^{I4g_yfOgj7-P!BB1f_N)(Q+*rw8 zqf_xoV1HJ`_eV^|-z~p&(^Ss?(arByvvWP1v#+qt=qut$94AREiCT(q%tvdN*W}te zf3HKIr|?81N+rlAz)$_kZxG*L0i&Efl6gri+XO%Sw5?M`$%Yu@wh@vfMZdPkJCP> zi8or>ItdWOHifj*r}=I0G;b1tE=jQsV4iM;dHTXIIoh;f^tt@OiwW&yH9CoJ*@mXG;X>=05Qk#V}i<7 zARLgpXN7a)W6oaV9E&Ey&YjPAM}k{WV@kCL0m%1jP3NH3`MZRG!}Yd(PvX@6hguLo z)47TWEgdthl`znX*P*X}@_!l7?rIUqxIWGh6-coB8hxBS_50{xWS)Us{{SHdwA$)V_!MCcZQGzQC^CI^RV3V! zJ@gth2nnH^i6l$6&$nyZp808~e^@n)WAxsd!mnL|dt;NQ zuc$~x@D#uzT!Z2Kgz>b{^>5cc-TeU z?v&^x#}}8Tl8l(HFcx@M;^BsRf7KnRr_Z-MNu! zd4hLp`=k6)E(-R#t#+=NBDp7&L2R^M$ltk4iQzv4EjoYi9`0aXylrg#t!*JL<>(H& ze3n3s#Vm$12gJ4YWg51H-}?6phX3sNX4mt)A2z6ADb=&Al^%=86dtM|lo-k)4z!zB zE70K^J6XURsY7(@SNyUz`H(1SV3j4_OosTyB?ii-Y^^8Z+c^aSvP0&|M+vCp(mQ+> zKRkRq>-973Xo`AGwJ#`k&-1n*xf9n9o0#9?3J|$8{0vJBa~Q+bEr?Gp>X6M?|F$%7eOK(Tk2E!Q{FUUn9TsT2 zBPp$);2T&O^Jqj@&q_l?i;CEGkvFoPc>nWzxkDPeAEHTFDreWDwWBO9498ujBD5*g zc)E1+(a~5tt6pn_QB0`M)zeIhV&sn1mxkP{g=f^nSLWp-Mg$g>xh2PH&`!vV%StWwl z{b&cArs7^im3NAHxfH|?_>nYy+XQr){j5wu{Oq77+9%GH0k8k9&#L*8FV|@w6Cd^W zzPPt)AtVj<5Ry&%Q3~&oJwmIHrr1(+#ioXa^{#B`+si30r7K!ua?Z zbq|afJU?vCwOop8VQP`gO;N2&%)e06oKjnN zv`5^mpVR3&;xONt7R1rM`eNkekXd?h;A8Sc9DU!SUg?JhA?RXL?XIX+I1D)HEoV?( z4!U8%?V>BT8S&eu#!;Q?xS@21$v2t7$MT4!9f1Q zjuh_LK@a|%aHkY}ovs8l#XiYFires%b=+MM=ueAkE{X74t;JA*5+Ea-Kt@PS!pc-8 zsY2>&RF}I(G3qI5`am-~J5|WoI>1MXI zxpt6~44b;VuXE(^5%WxI%-#M@n;!YqelY>kH$OhUq1DVk>ffRkD9!#1ne+s9EX+=z zLUw|{PFZCEO1n$jW>i+rvFJlix4li9+l#8%Uv_-+Bbv`pU*GyE58y_yc|y#N1FK zaEaCQaUDL+snSZ@%WU4Od_AKn*Lq`uRwTafp{@yu&XE3kV{stV{ijGy))sRqm##{t`i7Q&3!5_Z~ zX5j0I$bU7s0n}1qD zN9O7LklE(4$@Q7#B7+0=a^=UD?)j+~*8=V1^vO^^WcH&>?(x>%IlOd}{9E-T(r)%C znkxCeI=HDmno7?8#3R-BR9b%%bIb^gYceltdLq3^xV_WN|FSfR`t&$_(tl>?3=%$VMqVrJ+UuAHD zKn4FIU5yt-_Q?JSiYMXLR=e;L)zvjVL8?XCN)EEkGC7Sl z0P!^a)|VgsQ%$QsO?5vl8M*b^sa;)j^Bg#%|Jz5#49p+h|N1MwCyT`;r^~koHdrM4 zI2g4S3%xeHVl+&p^V?!_Z}sQs#SEc!OL3}uLakByOA3`fI^@P7+1tR%`E9qh@ijdv zdV!^dwxwUymC&gx0iub4st@Kuo|K~!VsBi%u=!d2^p>;kQ@q)jPGaldpOhHB9lq86 z_lOC~plcGPK8?!ccjcJrlgmFHAq^;X;tgUJ)(E2^@d!B*m57dO9o3SOsGa+5R?ol1 zT6^z$vfRA>Cf^Bw9db=Maaqveu#5+~A4uLve3TH2vN^?;N;sEq-9t}RDtK8XUVU^T zaW|hF2g2KF9=Mn*kSP-)1tF*Fv4a}Ud)AMqSbwcQG93wfsZDPo;Zw>vQ$fEt`dCg} zDszM|d}yXChhjLVI1A@m?3=v!p~ma`oZGegnJ-GBNX5~3jO(r(Rs$m<;dfBhH*%kG z>edkF6j=yWvL*+iBzDOnh^wsZx7ROSw-Ms;i%#Y+k)9cfai1hd_yx{j26OWg45l(P zCT+cdtMGijVe(+AIFqh!Q;U6o_Jw_8XpC0YAyycFL^giEogkZ-j9tDev7Tmn=-Gus zbz`lXmHQ(v+c})p^M*@xXby)bIsfocH^K~@(z!Sh?GUKwJ-~d(14wTihE_xZhlJ6R0iJ3 z=kwV$QAsP3w`~ni26cr~u2iJ7r~SfuShB5F=J+%rr|D%`RQtV@p4cd9I~+?k&!nBL z$yVLJ(E-2&GV+pz)RAwJztt8%ovy6vWob5<-#YiO)vjjBz1}K@)9#MEEH&`P=Y%G| zNbX)WNM=dqlxs5hA$p(h@TQDCZ4kP*$K6rkI(QmyS8}f>`#M$PVK`}MkXg^1)y;}8 zcA&*3u9up}PZd+Ak9&Scj62Bj=265KVNPF}_8v0Hv=8=FTB{Z@a(Q%jNQ;#!G(Pae z38-BnUtz+k691Z=K2ME2@(33mxx0FJk-IV@ofN@}~?_cZ+IC7)fT`Mm#+*l5x@m%zY*tdkR6hh&aOg!1&&G;o1&XVAn z3XBhL1IJL^83+k;DMr-maR~BDb|vt1h-XAIi*H%q@au?%*ffu9j5uPlko;rqZl6d& zd{nzpXbi1-`8)pyPU%wbUQX-AIvEkpP%JHfQ9N!cfn1R=jQJuPIpk<7cClCT7bS+& zb5QqV$ZIkhY@2v@erqN>5g|EK%ah1NT`}%a2O$~y8T)m)POR+2UFGh|T}Eza4Q1Y} z-stluM-Hyt#(9z%f37Lp5ji8KFi!DIAe)^IT3eT-+A1a^NK6#}fd!#|@H5vp;nwvE zk9LuP%UEK;Nr-J|6tR;PPasc|97z>5F-P{$>Sh9^?h8zPuZH6TL^(u}6O%OUY75tW z^Yxsr?gvG_(7bM(A#r*+Jw8rg3J-HkzD00FyFcf&`Dilk3s(0QD8|;+UFCHeljAF8 zX}g0teBCi8w!^1#Yhjhuuj>e5gSKMX%g*uCSORz!1~G!1?C}_Xl(pKR3!4Mz@xKnN z^es`;@6O)z^k4x` zYQTnay>Wg%Ou*CQgCJ(om$3cW?3R}p6FypDBisEt>Cy#RYU2xeXD4RFOC%{Hc(wSS z&2Y6@k_mVozlNXWGbH;3eN^=}e12U1itXO{rdwG<$wq`@t141gWCZRn0Di;)#Ww z%^W2RFd>S9!o^RIZ*GiCe3z1M+N;kv?yK-pew}iAt?|Wi_m10Q@HMQnS*P|5y7B?( z>FI+0^LaTZdo+CXYfa^+D~^x=Wi#i%SOe;i-{hMgkcTy~|Ax>K8`HIPYX8xkBo9Yj zWy$@qM0btIp~{EWCEmAy^9AC9PmrhbaRfXVmXw`d3H-H|erYM3A;@s_hLm^T&A$3e zD&MuLxfiZRoJifx{5ZgajF<-kbv3lZ`V!gCeqC+aM1XXUI7B$WPYQVSO5zwa$NIhKrWd{l81WA z$OUQNwR^mgGxn`ZglWe>6GQ-CAvj*&{fI<~*nM1tu5hznnF(lVGytx%muKF$auFmS zZkelvsB|4@;jZ}WqpigUMAC*;RgYe{&0S;pF&B;_l>m`>Ng8q-%to33lB-P@#c0u_ zd%LCj?weglg>T9UefXa>dn1vRKWhxXo2_az+OB|g5fDLM z_m89#k|CPz>+_Il7Bo6WCO^RJb!r4{;@rUNgTVfy|A$GUEiS;)ke-B8(eV~kfv8~I zWwj$)7=7o4OQm-Ju#C$VzhA>g zwtK=R5*XepcjO}>Slba%j?aRK-Ip#*SIK~MimUiJWETs9COI?>S|AKPT;J`W*RP0# z7bPYKfuMq^m2eVgU_ib0Lb}RGUP|2_b9V*BLOOMH!jt2s$DEfT4jfL{jC?c*rqOgN z&vGCDe!f=}251k+6wPxX`p^$!gJ4*&5q$JIAh8%o_?G&tM3IlEVfaq8|RYI85os$UwspPK8vOu8gpb?AtA95t~M9YOw zA|E*-*#!^XGKYWdX@+DnWspoR_}K4ZRXmOAyN6NMuHJLJn2Z2oT!c_~!rd6EEyuhU z2udlj2T7W-A=xWn;*SGF5>IEHpE9L0AGw^C&%~Z+Qc;#XSJ(t*y5)^p-}w z_=YI1Kr}F8!N>`a;YDH#7qLF$m;st1U6MV>YRGuQ6lok{(fHB}zkBlYCI#ynP?jg-f&B_BYf?Kh-dMxqu2IXPY znC4Y5lo=RGB12Q71T-b%+`9J4aGmn*xHEf;OoKs{dW`ee@s%hv~|(OV>Zx#=47S+e+C$I z@c$|UTmUG=^f3P*NH1<0X^~*=U#_qc-{s{)j!BIF$BFywQ;<_-Zl7Ka1ZZ{5YQ0H* zdi)*em9$Ab=s=2W-YVF<-w0iH=?XUMF&hn+Rpl;Bf;WDz(TtT~Q=thafDO~MnyO{BJGl1ju!ej<7Mgpc_zU;y()Mbzl zU5Kox025~WR+|&~r7ZmN4Bao+>LaD#E$F`W>1p*mAzeG%J(8YW+D4T3-aWXaB%CfL z`L%@Zh0ak3zo5n4`D_j8y{w@WOCKy42k?_3Qfqh%lbS*W)=2%C*9hi#zftx6Xqia* zS3{jFE_K;| zXckFkC=ie2L<|RFiXst2O4FHX2 zE-vDY%r@1xcw2F?!vHzwCetiQ5V3iK*v9B;esh0c;V@rFT1lPf1v*`*DDomhQ3QfmMN zr5lH{JCX8-#h{6c1uG#k`r$Q*mrr=Uz4t zA~lkTUU1dJG1bKZ@sKy)BSyY<7hEdnD$KbO{8-<12wN%q*LR&c)}pN38+qEu4sUa2jYH*F=3X* zXO3FeB6Ge~7@y6XzSr@!C_BXEX`3Zfg`J^sug2WIjxQND!#pwbypgWDGk~68!pXVh zrC#_a-424wd6WNqmyt9*8m)%AwiV^kwkb{WTPJSC_$?9I5u^vC%ZK?Z$Vf9_EDGx= zy?3QHp$-l;%t>afvD{cZT}6KhwO4`mk+r8@=_X>hhGD{&Nudi`Xi`a+h0 zkQ;Ky*KDZy6?dhQcxM17T=oq_{>>m%z(#x#F9{{-2uuHi9{PM;LFHryV-&PpCe6~C ze3bt0AP1k?=?%8dQm)mFG6~h=9JIlksoiyfOzd--UF7)KmyvayLn^^i%fF&o%lT5Q z<93~^dMe2h)6WvLIItOK-Z*!r0%~9;(grZFrD;&y&hq6-JC-NU4D`hKs+T7VP!8N_ zWw*>G%IJ6XKC768TJtEx-bIW9K464E zz_1nleg0x&;VTF#a+yKeF84@6Q@HSb+d$wR=?W-RprxJEpCok z=Rn|VpooZ2f5nS*hl~JGYFP0dUbkC?jcK>S?!} z$|aIs*_cfY4nnVvk1NPhAGxd|t>Nl{SCTyxfDZ2=buE&xqzSQ!lQ&->bK^z8OF891 zK$>UaJNZx(A2OydtjBe2a4vKv7ljfT*9+S-&mo=VPPrO$liOMq|FP#-O1wjF-f-6= zhw4S=k;}!BPwzcvZ-~$0WW87i09H~084@Tt5h4bf<_X1H%(<@!W1a=Q@UCDT8doZ8 z9?V`4h!LIa*->fih+xv3*y!Sogi83%eVsOk?tSj`WX z#xY_p#;o7I{xq{7Azv^{$Q9tbpSz>B@M#JM_X9f0{1u-{du}Qd-q2_9<%PHAkK|>P z)aG^ho@n6j{@%%m-?hK-1X)XQa7)I;-;x-TbWmvA7ON5WXSkz%Tdb#(oYm^$b7Cfc zr!k{a0}}kl_$(hZ3&Quvp~~V_g|YVPWpn$B+TZC)Gq5>wMo9WNW>QHh%*8XEmfzfY z!;^pYj`@{<&JG9Qg=u1kJSjN`VX$U@6GoQlpwxB z$oB24tXG6=KJ$7O^w8x;Y92E5K8?mK%ZnzRMQ>)x=4+0(`H#vcWeg1#RSum##9fa|?ErW@ z(7tL6-2GwPDSBbx4Sl|@i$zu2`}-aP-vH%qhY<*n?kf%2y= z&?QxL01sJ5S=dsW_!V2S)KQGz(gfy-`@it?t|`ts1j%uuNHr;2tHm!%+x@vMsyCi* zjrvaF(Z6z&VdiCo7P;y=KqY9>(?|k?_#rQ{5JK6-5n_bCajk$9Rtt1_{k#i;$zaqU8p$PFC&| zS=U=@KvEXPWo-Y>s^W?1D{LQU#Y1dmd*A)T^hb2F9157mG{^>x1jurdeKc#tmylED zdK6ln95y4b-zcPn84Udhu!nd1*P{hFm{V$%^5hJC%=jdl#val=58!B_P3I$?6VGfS zj(Hvy@K!i(*DdBz&h-a8OhJmQ&20hSQfec)I*L6N+{M7>y1~nQNM;$H0~9Os;G4zYz*<}0-TgmE_iG*stl#E#N8cCJZ z_bamwH$6$ejrg*6rwXQOI|^F4KUB>4=kp+-YZ>*;v@_<6+!x+xQkxYVx)`0U&HjM) z?Je_=5o%GE-<-Q@X(>H+RZyiw$4-to)szVhh7m?V!)?rTR}UwNo|_g2*B(8XO+7*f z3-@<*_Zi?UmVUf4zVFT3%-Ti zdwC*gx8}Qx|%N|;JcFH|pIT~{Xf@2CWMUum(@`PQCAX@7^ z8K~A@%vam}n$Sg>WOlo$WvhhL`lHK|bw2-2%4hLRpE{2;!Yb{t&qRr*$|^$|Fl8L@ zPNXpW1G|>hC_ks&YQ`+t8U5uE-3mD&y+#wv~Y#H6403F)}I$xJj~!f zUIv*>Wf*e|OWbyo7>{o2HK5CU ze4{$P^iH{WVAnS5fr+5^aWV_0177vlqw`nh(yF@p2t7B%ue{|_(o!~Oef@0qGjY2^ zUb)7CTEV?(j^Wh(tApOAPFTfLgPBDF>#l^&aYKz^{Qp%=!>D-%rbaiV`H~z#eF6`c zPP7Yww^(ozH!ceuWIfOWXQQa`rJWu$@d6x{A@E@AyWPNsW82wgM6RG;abU0$Xl8M1 zH+v*r_}~qR(mq3TsWPcjDP1PGg09vJK87`wxY7<*Y=a*~eHIp~BC(Adq3M z;+(dD*WY(rW`2e`wnM1ni1q4TJ7;O_Z5WIS?M{^S2j^n}Hk5+^+cw z#(TD%-fjcBbNI(D;@K^5NxzQxt_;zz1Zxg9PPIK%{%!elbZ@%h$YO`ud-S-1^ejH0 zASLG-+*T_qUX!7{(1V*hqoc)*{*j$E0Tc97%l*xmN(vYvDGX5^U#CuyLs*WOI$}Vx zLa|Oiwp^`UuA=t|V&_bAa2zp659HAL+Z^H!a|MNFkbdzw+P2;TNy?2&;Bsesgwaea;uB4fI9A_x<{o3^B1!cpf9r1$)w?2CcF2bowIU4i@9H19NF^RuBzDP|@_1H?ofP)bg>{eyRZRmxCUO3u)3MUr*t%H6b`E?1-nn zhshmcCXcB}o#e%y9M=0ilNp&eFd0ZjfXSC2`(^?YW}mXe#-khNxqA>!IKrSCxYmFv zGspb=Jp_gAcywhO=Gn=z%6oY(60oe~S^M%H`;?5lNaEx3l!eY}c8rgq|A_VNxmSv~ zCV%%N0xEqfx*)Xs?yInWv73zHW}X$25QZnGxq({Ow^a>|v$rJjJA9l@0&h$rH?IjA z_~hy_eI~%X9hTPv1Oeq4(}kz9V#tS!ChQ)Hy2)nC(?Wx3F$LA5%E9J0{}9^WLeQ#D z9uKwIqQDmGs6=H`EE+Gr%#f$$EHN9Um`3~+L?h;qwVG;N&UGTr;v3MQ{q5kQ-cN*c z7l~0~&MH}W?U|6=FVje~l3x*tOoki#ke=$IJX!ZuyX3Dqmr3JOgJOyqIrDxKwkR` zGFSqh>3Y~Il(}luqjkLpI4XRzDheYU#7h|b03tYi*c4PHgWxK2p9)x;2zdbxp-tRr hhrb6hQha#$p0ltj-d>bN735f4_Ur{p+^B?sMjyGxM2w=6&Xz_ssjuL_gHiprvM~1^@uGnlLp( z0N@fk06?ZpMNUFwH!^`F!2F?(@dJ|j|7_j5b&HhIl`B_B{OZ-Kf3l;crTtH7vazxK z6H!u9BFUF8U;cw!x^#&okdu@1@$vn^|HSzd^N)#&it3N^AO2?xBO~J<6$AqPM=MFb zapMMwv$C>+!C;cW#Kc76baZqi4g>-@IXOuIN%1KtC>R(RNFZsE&O-u8RuaO@%uG5k z$&HtnS3p2OSXh|!3JD1b2m~T0CkKT>Ra8{e)YM=wn2wIl!-o%zjg22aer#c3VPj)s zXJ_Z==;-Y1?B?d?<>lq)=NA+d6dD>D9v&VQ6%`vBn~;!@oSdAVo}QhZotKyQ_U+qu z@7|S{mseL;*VWZEH8r)iwzjvoW3kxo?(V+6zJY;(k&zJ`4u{9%XJ=;#1j5qN(%RbE z=H}+k&d$NX!O6+V#l?mF1+^e4jVLceJtM$nDj)+h8z&F1z%5~r1Vj$1qN<^-Z)9R_ z{RD33;P}i5>F(*}8yFH6854_&PfSWn&w7(vSX5k6R#n^B(%$hI`=zVi&t)z!6i;>O12=I^bo?Va7dgM-7v!=t0)W73IE z&(6-y6T~g60f6gknrioq{U(Xi7a<%6_qyG?kGk$>$>`#PZeD(b5pcS zTqO~{^iIf4BUr%RkV6bAza<{!Ko&Xa{znn~8mLOa3_~hd)p&*ECr$ z6=Xy2?y(a9p&jGcr*^ae30o&OJIQU#&p*T^qAU z4w(>h%;~o{YQmT+ew?J;YS)(XSxnaK=~%s@8AZw@QkLw(W0%Yc^-hWb zyqJFfwazEO6+Sual-6xWdrfgRAw=ePx6983K4z>Kyd86X_)^=h$IQ24i-w0BC-&^B z@v0VK-lRRu>4dxP9@*gCzIq4?%!9G)sV0+3$L$Y;dG7P2+(8r1OYb9w zxcH^=-JZ3n)rh8xeD}76>IW=~T(^hQXy^Y1r``WqL`jU`E-xz!+@Bil^3~%R2A78K zbGP`dop}yGZNtG70QDTZ{N~oZ^jy$|Z?XlrPeXBA1Q2=~%~Xa@4@PqV=Cbz4zwMIe zYs5a>=V~8xJ43PVKO2G$(dD#F`5o>j!L0TZ2+=6mbN9as0PP1rn)(SNa*vQtLo|Ssll37G+z=o-4B^PIr z)w5QQ#X&e1?Q=s1tF_#~Ju`wi`{>5F@ZS7+~3fZ!V+t{OH5M^!s0MEcYT>C-T-+=cqJm~bw--3@c05V3ZE9E1oyF{mdR+s;Q;9MCijd>B6 z;vvvG;p*g*Hk59OJWu}hXuzHuq>bJU;FcI@jElGeP{$2pt@VxqH_b}8f3GpG*UQQQ zLVx#Xazv5~^eW_2KIaNb8LTGjhUI&1udMPW0z-k!w6@S@oCX)g3>o2n; z2=#jP1;jTOLC{aeed5KFLzZJKVsF~wMbjtp*1eb+@pLzKoE%mxVWYb6vHSfSw1+0# zcPTT^o_p#{I`%33RvP1XoTnJH#S_^qPh>zLf;SuAP;e#a@ckT@@pQ)vrMU#UHRIMr z5~B5L;jMnY?ktz4=MAl$@HVM-2&k<(g$0_tK@o<&f#(*+G!QFil%2k0aIJ!|s#m}~ z$QLenRXb|QzI8p5O^VJ}8sFj0Qw^r;jYLk*=lgS7twp!Azx!kn`TfD{b9IVo-3&3L zU|ML;21OQEF5v`=RhO&rby)&SaM7QM_x)!i;rO!$#c)xV=Ub<%zr^bst0CMjF2p_9 zUCZSfVjE|49Ct1M2O{Jetd87*n#}GFAa}sATbPoe&Wz#qv?_cC=~c&Hr$blJN&ShB zMl@6teU<0s5qF2x$BWmDOI+dQ62IQE-a*>+Ff-Hyojcc$u%XEMGeWz)7|sEcD6+T? zWPL$>2iZJ-l-Mu29U+^<`6ha*$RX|GGj$CP8+1~H`0(p7i(z`tPVK{?Y-{joq7Qj# zpd$!7%P48qbgWxXC5jFezlI4>Y%79T_;&DoO~V~5q_n+i02;mWSBsga>gr`ao=SYA zQ!Cg6D-N=Jd)-1f`IutEQd+E@J?y6S%d!Jmls|Z_hy}YiNvl=YA#m+49e6(%@Hnjx zDMHDu$+38e)gvZqUXxXovl|4oE@)i`Ie8~#@)jzAIeQWa5*hS$l?h@La<6qbr3!o8 zsIjKSlTdV26M<3APDVC24r^X}53!Z5G21WI>0)<6*g2p_RfJ_DdtkAtU=hU=oCG*%k5OHX@&d?NGPKQ3usjrEsDJ8$XN zLY}B)s9L}1wDJQ5{Oxl6F`Js4Z0P<%?zHli$WFUzd2MhUh{i}&$EMu)+~5u5H9Y;` zkx5x!wv%ea1M#tSf06mu;;m|x0*mS7zhXb@vp}l~u{+eDF9}a?M?lTP5UE0g+21Jd zBUmCORD5nq(8Qvj=L6;AgFUWDB3}tG-ds|U&jZQ8D19C7wz@OvI6ErCKgN+gl^G>Us9o5>E2@LJm`=#g;hl>C2j8yS{tC@5~wAmN?y1-&^VhicAmCnzAz!vVZYORjy$w6$a|o zgfe`lFQ<_^^!OqX8kooK5(U$On}J?%V0dQygal1owrmTVP$7pD+nn98-( zTVSd2X{iL^1kJ`TFBSSmk5-ENb{r;1L6CBjQu0J0Eer0A1|~st&YJrt(M0XupO1fR z^?bfXZ-!wa-pCRis403;*%l3As?4$<_8z$#S>P#r_oEPd!Oj0Q8Q>vWDGvzZ?F~g| zXJblJo6{FBFNn9Y);_3=B^CTn-{$!E)FH%cUY1HO3&cH7S= zkBz!HoNqQcIyYE%=Cc=XdAHtT&#Kr`jvK9vUAkaV_S1sM$nPk1AxFhf+Pa75Rnc9G z$Kb(-wP3o_LwiD_>u5}uki*PDn@QhEzHGzUjc2~ra7z1}|8#@?FRSX(!@_6*PxnAW zh>s}h6@USP$6b3Y0TyVU3+za%is^FA`?;6jxgjkXyouV#6j!^BGRyz4Bq=Lg-D_wr zq8;7zly(88r~X9YJ1j@dq5b-sKppl#wZi))8#V+JD+QnBEk}vr&w?EgMj=FMdxcNp zW#9<1ADP}Y(tgTe{n1pMJ>{-<`wkp18}I}R;j856VD4Q+2))^d$0|`i58$968)-)9?*KSFD-+?y0>f$7V-SVTPuCAhTK7} z(&b>L4)G6Wr4A9mU%i3yF<|{++}!EF_ipw3&fPWy{xxI;rWrQ>y+QltB(a+ z;l-8boivRz3MW78>HS@H-Ku#=Hm>W1$nn^ z!;w+Xf!AG+^exX~Sdo_UEg!hfU!Nu8a+a*l<`!QOPSoIi#jY2N+YSf2*SEv|P<}kZB<-l=#N3KStJD#q03{4!kz6sfqj0YNH zyCdj71~qSOYe%ZVNqNnutkG5}9~_3Y-8oV_nqeJ~wFn^`1q}JMmf}5kgRu1`bjZ~k z@0V@EN(L+tK})+!YVbm%#)I+BVi5 zR?2u*P-`HkWpa0{m%L!BI)7T*`dQH07YAsTWr|4^m)y}KLSQ^JuhAUAsdRE)u_GR| z&y+G6@Pv@VUuD(ey_HYcwbUe#TBWM?HtD6j_eYtyu#y>4%KO!hQ;HN`yQkj{2DoP4 zJG|TO%U_Fc3;y`?^q5Ct+7hy#(=_h2P*ia$XH08xJ7jrhQ^qp*sB~Hfeo^YnF{@bL znTGt)#bYpj@;OV^HRw2M+%?~QxkyBpH6D2u>EyJu=>&bgsI9v>6R75FGAI|cahA0d z@7niQf%IO9$v$_x+fEp6BRHUR5wR}6eT-VG;+m**c-P$ib*F!#OgBxBtK6TRr_Jqr z?8Jc{Ns#*Si^q8~v6ek+gH2d-5$^}-|r%Ac>Li%)% zSg|>Ku@-WEvfto^NP;NY3LY3dt>i$~W@7&L_4l6<41Pkudd~>HIiA_4Vugtw;Dg!6 zY~IDP%6*Csgqj$h0?ywk&qFxuWgLPv4YD>%o6O%&)CO zzWt_N>9AZnvxBbU)f~)pMx3KX%bO){fD+~}D=7}-GN4Kyg;&t=CtF_Nu522uy^v($ zdZf@VEo)xJ3XUgIu=_I9ERN$}G;n4dP_Io1&Yn`Smr|KkL=8NKV@=-#u2AP2oNrGt ztM`;Mq0&skqua*wvTnw};|QsZB6?`eZc~dl09K}c-7oMhd33XZ)STRR(8_0&h6asv z+dWB9p*PO#NuXHy1znA=?j-^1H_#S0;`RozWO^4qJ-&c8FUx6q47p#M-?phk4hyb) z5>yO{EtKEQ3%wXUDXw=q4y+JK*6l%v+)#lK?p5MlRUyaCsfiGqhhbxHvX^* z$vT`KE)J#S@9}ngE1`=f%c4t#fq(P@&E}Aw0H!+h8d!Bld#Ct8xhKS^} zw+^JK%k5psup4Nuwm<~1kbflZXP{6=CvygMG6Is6oi!l{Sqx1yl$yj9CQ9FpndchM z)~JKsWfLTq(0Fkf;mz86yQ%DiT|jX+v5!~=N$pvPew{A~1TdmGU(G%X%XmsnWiGlb zq|m33t_mcta3y%eL(E3R zxjKuWOz{oGt?i4h{@-pn{q(@_Z#|Brua-1|BAUkG_vN}>0+TgK%58LZZGR7}otOXu z)@Mu;j_O>xYZ3T32d7N+UTy)Y2JN`CCH>cg2F0$oF8YZ^Z|wcv&T`+J{=4~wd35c| zfmJ-du0YHKS$lPIUGP|e<|%l@NhHxP?k)a_dPEwjW!78x)$k@@n1lI^>X1D15CiT1 z0gV$O=ZhREQ#{5(sP+?eY43Wy|JDrkcKyPc^8W0{8Y6f1_kWMnH6Q4yRo=IG`7gf= BxikO( literal 0 HcmV?d00001 diff --git a/python-3.7.4-docs-html/_images/turtle-star.png b/python-3.7.4-docs-html/_images/turtle-star.png new file mode 100644 index 0000000000000000000000000000000000000000..caf36a3ab3a5056ce79d96e4886c0026924abb40 GIT binary patch literal 39585 zcmd3MLz6Cy&h68-ZQHi(-ff$^ZQHi(-L`GpwrzKR?-|_xa0f{ysZ=F{l~mS>P?VQ| zgT{si003}OlA=og#gG3PB=CP8B6j*O0013sDI%gMB_cwo=xAqVX>AGsxC1SxnyV0viPmheH}3Ak+Y$ z;l&FHVnM)YD7I7B3$5z9{cH=knO}G3J^Jpx&&=$cRy_j?-k8ILMAV@Iqykm`#D}pM zYl@PBykZ&zFvkNd1kIe3f~Wie1b1;Z6%c|4dp;x%)qb*{w?LNk3?U!@RR7?jcB*XB z;926F8Kg)hAb%djZWl1Za6 zhWkw~p&K!R>v0(*%KD`l!%v!sk`Z=;eq&5zw24q*-kWuF0{?_*r{`=Vqr=OTnM*Dq ztGgbC=;!;aQ}h_0MQ%v>jDWr1SXVCA=>f-V7iwz=_q{d4ea7?(MhRHRjFYry-6pU3 zNJ#K3OWJ8i{^;Gd<|DU2O7mS+Fxw7{6+o6y)HlK(0<#b7E&xzK+9zJa8$iR{L98`l z4UR*&nLVK$l}!hrw+g-#{aR~N0Y~w`@d$-Y^*6R2V`O1sLkjz~%Y5U>*1qcOS-*uT zJnXd^X928D5Z}Ii-(r8#0L)u}@=e}!mHl7=DPd4b)c?&P;EdAdkDgUpc-JDgz)Q5NMis^1DG+ecLR zp)C8j?i4z(X@eAd;BVC45WbKIeYJa1sDcTK&dJylkft$?LhnVyf0!td{*q85s0LF@ zEEi<{x&HV04`_+=0tGv&v;fP3qzP{W1uya>KWQFk9_$R+nXLn8JG3VbUsNH#*N_sE zEE;G8eQ5Ek;GGDBY>aAeZpg?8@1DCp?=4o8xID>P zGJurdlBGP|Inp_aRq{i$H1TKV^;d5A{5ugTg^GsgROPB2~LIvvPyvL-djExC2#Sa!Ya)s`lR^mGUKz za=mgX%gm&*=%4QVD2XOtc6IbsUMw}pA7uX6$nN_s;&L)uNo zf3^#~qWH(CCb-7$j~ z6s4EBYu(o)R~6Ty7B}gY3zv&nDrt(Xi)jAyR(#KVXoJ=rmLk(L&6_YyVN%Vk2%^?^ z$-6*XPJ`71Pf8f0G;3laUrJu$U0zsso%nSNT~<-e>d?V3+P zgi7=3w0t+oS{Z_s*15PvhUH!>0FDOs9UMHCGma6g4J=sbacH-=2}$Xnjz87&`Apku zqnw*<^KZ{a)58f-ue7%MU(-Var1MAV<0#4%}#L40H{A7Qu}VtsBQr z3a2TwWj0kd7hC)`vDV4f@LF+nD;kqqpVk(Lyj;9mzW;mzL4=AV4>G`m#Qu%79(5c& zmB*IXDU&WkD#d5X^$2|5SRc|n@}7AQimILjPeWHvt_-uvwJO6|rdz5Wy3XkA@T&5v z{tONa8TE`qSBNfaJ;k5ZOJ$B4tT2>w*YvQt`};`l1>u$EF7P`4iuBI9V7V7XxR_s+|6-tZcd>WauS_&U)G3@Bd=Xk2 z(h@2aS`AqV^@(_ct%u29XMNuQH+dsUDSAheN$ikdn2?f?G`XF6tIyvxU?g@EnVZ5* zvs%;DEN!TIP$5%ErrxNY7cn3jB7qn8G4NuZ)<{vLId3|Tf{QT&G(%H^;zr;WZ9YqL z6f?9oiaHWKvN3uSgBRr#O%sW8+Ic7QW_Q4M7&qi6d8hDCI$a7@p-N$ZLX0d2LlF!r zu!W7NO z`bn#QBi7~P(zOa_+lFSG55moR^6+GP zhGU#z;#aAUs_nb+e0Er1_9}XPy?xSgb$@$pJ8+xN3-?t8LmI;j9sc@xd$TUCp22SS z^SknOms(57`3P_?xDgOwly^`XlnLQR@TG*T{!q8n-qa&oZY{AMCbA{+3eSUA!&B%@ z`a5>2|JM72_sqGWSfi__5>PE!>+V2%rSVz2(z~KUt#YF7TaBy&rvjncx~#FhgsaZo zQ;A+9SBb|{e;~RlwVEX7BJLt_dH(!f)>q!7%-|RGQGMFKXuL6f0Qt{qHwsBT;f z-&|ws<7l(q3}F*sle5}gyW6$zd#J_J_&p)_nT27uzQgUe`QdtqH^~EshmLpZ+xqsc zQ)X&Ds9V`7r^~K8y)DzpuJw}hYpuY>K3cjb=%^)-%Yezu%P<>!kv<00hnhqaJf ziRCZ5r^A#_)#dR++F)&PZRx1fZ{knoRrAedqaV-rHdDQ|(Ob;f^wegc+rw?e4ui)o zHx}c&HMQm650M>-_qgS}DuHG{_+MV;oO`g>lDEp8)f2m&-4F9bGqYf8B(D{i{CK3; z2%tS1G(a*Wz(N;*sD0x7U=7ZCdW{tNvpxLacbA=p4uOaOM6CsYbO7#y$cRFef-$UD zg%dOr4V#|E;4X~RmX2;;rxh#~AIe0Xp6U|uCXq+*ukB`GS&U&}(WgPG4RX&&E$8y1 zpBa$`Qlx|c37iFM*f?4L^uzoCOP07n_TX01{O>e{vX|6!0svr8{%1gd%xp{mfDj-h zDx~5LbcF}ujw<##t>-Cx)}2QB1Yhu~hg|$h-~G=YOi@J;3G9!Gim0HXVsIY366iT$ zw-mDH8EF$JWP1+BZx)T07uh(NNYYgr0|(EinXBu`^wi~GFk-xK$!p)_Jjlf4ea5+d z#tujW#KJru9)eyWzNEx!nnm5B02|)+qQf59MS!!jUj#VMxANkD2@wDPB$RQkp&k`C zQDDZDdzSP$DNdlMu&I_T1n9m9a(8rIrBWn~W0F+y^$4goM=e?fRPOC3R4ASI(R&f% zZR@&DCQU{2rgm(Qw3fj0<8hz=ukGSb@^^}eIMHE1cyAhSa#UHl*lW0oJObdJ5}R6a z^FXKT`*=oL;&l|ykHHQR*Y}5e`IscOv_{gz`C<=hJIxmw;Z{U2bP4@ycCf7IvlsK= zLda;IqnwU`IJQk+)PI8bU^|RL5-6MQ2d`pDPPIG@loM~8z%O4c#qnx`tj(U=Mb#b4 zU%K66_&T)HHc+c?=viOmNENa=ufvD|!kN26;D@vE;8_e_U!$JTMHTcEymj0S=^g^K ztj1G=O&66CFg#h(uqFeP8+-F>lrEAfJS9^9P^O|vB<$Vi^T6jACkfX9(>AMyAF`&6 zsKl;X?J4EIIKRz3=Vlv0jkQ0bdg(LKODm%{b_GO?4}UF>r4fnO?o`uV4r|)g-$xeQcy9P(`^E;2q2_$K}CY9P!6|p3e3=`ia}(@6mes#e{hFm z{c4EGI&+Q8z-YkTu?Zfxd_jyE?)C|M+OlP$Ox(uYNk~Y^Vy&G;n}1WlA=r~`|B_5U z>7t~g1wqP<;QYPBrGE7ea0GNxZc%K7w2ka&Q&#?68fhQ+)syG$xExtB@W-DP92%(I zJ$Fo!Y1kW~1!mNdL*oM>(%e2!BVjL#v=2k;C7Cx$;Mmgt4?bS(!-PJ61hpE|_M|1; zK84_MBt9gWoN%|gZGQWn@n9+-P6b(G(0NvcvOAF-k*eB;tHtph^`WVdU+U#r#VTR1 zmIQ32iH5(gtvBfJrXUTsb^Uhy=>Hq@b!c)*4Ojq{D4jw&SO1NW62}gI{49oK@gEw3 zs!uv9$}n#vyfnaX_ms1< z8?G|a4t|$iB-`WOlhmj={jJD@v?uvhs>XfNA$bQ(Vr|tHZFpkD z*bVu9?EK=oT^f;u8077K59a8*wq8~C|Ee*dv*+5FaIO*ZW8b_@Eq6oG4-*S5MFg-& z>^*>~6UuwM9}I7&A4L!(xFZ)LMRKONq!1bTnM0t68XF|w-yq%q?b6ME zm$d(Mp81}4{Yzb^%k1~9)65+}OvZTF3b>Roe3bqSqrcIRlnV#kfzI;(95_V!=m5P@y8&3Rm*zVxs3j2L
  • ZRRRu z9{S)FhJ$)FTl<+Gt1aQ<^ujlPnLA`OAD-UrZ&NXmPI^ux;k84f6)RD-A-=9Fjb2E@ z+jF-x5 zh*Q%5p#3dwX-a!-Cf!ny`$MXprnu@q%v(#<#+FUKctLrM5)igDw?o?c)pAod$UfG> z`;MU8fGEvg(5Ha{F||F|R1aMLCcaf6ckWF_CI{Eq)^zNHjeW)yb>ap%^bR~r)L9YH zeocG>8M=55U@5f0a=w9EYo`K7AS)%9Bs@^}6&Qf8-Aha`OpForA<*Zz!FhP`kOGce zzZLUnesU?RVP!u7QA0<=%)}QUE$rYDfT-$ec>Lgz+OtY&emdXUN%o<>YEgHF=by-N z^>5U?pV#>uu(Xg=!$QaGw->y%8*t)GuRO`XljaD+5J2B*NV*BJMiM3_y3TA@$D$ML z;mw4(up_xxk4!B*2USK&)U-^ewU($gb7iN$7vsAzE_giD+C>-gs*iWl8{w$+)@qpC zCJfwwX1AJRX~W?m##yfL_t$H!Hj~D*_BIq|rjTfk{iE0Yp1Ac$G;lQJo3v~FMOrcR zK@N@v5Gm>RHh9$;!@;2rNSH?dSc&srvioV$Gy`uvyq^HLL{V1y{=0dmD%cS#GfBIu z3}v16Gvq|(Wx48lFich8m;RRH;h7jIA?~BcM|}eq#nu%J)y8lfb-dgjjn?1)V1}MA zqj4a<{t5zYlq?(wZr?SU=Mt%M4l?@3K0DlK@6awnK|d@EK?mIgt5L+CA{|dr%8wuu zf}Pd{$}$b>flv3>n#(u}iCA5ARG7ea)PzI}7bAj)YGU${IE#5ess8q1ObJ z21}!h*8b1he?6})koh>|s44z7F}M9PHh?sAOENOu5Q)haYFqus5UEv$pUurNdFl(^ zG3pAnrubl!yL?WHs-wW5(ce4hbuL-XK%vMX)h&$Ue)y2!p5aKe$jfHF&g^= zBR?=dF-h$Cl{}pLKB}5AIWQnv9jFpKd=f(keW)C6$*$^Xl%#J0=wQPXBc9u6Bpp&? zLz&m}2oU-OoeE~$)y&Qu?jSa`SDm6U4?c3*j6?wI@^8X>(vG&T!l28d0+xuYY zPg?wkEUJUI4my82uKI&<)Pd2WBVW zkfO&6${vN={uTHAHK{pf7_J&2DD;U5kL-Fo!0RKtya?A|s+G97Vx&3{BLnm_L{*?O zxXCopyGv1z(`O*nSULjck_gAYSES{zT7ySysWqT}3^dIMD^dkyF)RWeK+YWYt(yjB zCZ+i(O+49NaJ5GFg_^9NRd?l4VAy61lh{qMBl>j@*F>EXxI(-xz3{WIoS|a*g}l`e zh|Zh+?pkr#ZI4~)iD?&j4{neHsQ-CIwd%{;J+RZj*a-7~W{&7> z0b1)wX2E3J9GK61)AB9~eB1SgVC?Bh(@~y|u08L4yofzOa%KJJx87H$tLb2$CZg&* z85cX0*&+uRZANM=;|}6F`lmfmkB(W3c&aO>GD%My#{(esi#njsTb5?`x_28F;Xf{` z(fldf3LkaHoB7l*`Z{Bu84`SG-e1!D!b3^T2CYITjQz>s?P|k|Ldy`>`e*eW|AIb) zCqqVVWJxGJ9#~2`Ri3pBHf<1h^VJz?G(j0w@rGgg4r|3HmCqyaOC}{ltAgHthg(=x z+sFwyEO%v~n5Jpvr6Q{`bCfx;z!sR7>A&3P9xP4uW>{8iL8=SYNlGsMP#;28Gn;As zy2sV#@n=4#176@PpqaN$M$>_Y9E}gl4Z-RIJ5CB#kprvFmED1j`~85ktqsmtl4YH( z?Csg>lz44o*L@&TqbW@R0XZ+)6|_;p%|+(Vd}{;v5W#&b39h7}qB0lps&2+Rg+hRVU7*&QUgf$tA7?2MA+y^lE(wBio5YbW>SCkLygdAHja zn!R?HsxIn*QMh-pwe76!i14XUtbNUmrSt<|w?^7LaTi@w2Q*6>nO*rwMQmB(t1P*u zRuAh3?#ffyG=`P?Ap^@+6&Au*hzoDDNxe)k0~Bbd`9OIrYf}$3uDVQ)jW&5qeQ`b< zqB+TxLCe&hj|-zH?KBPL&P7QWQNvJIrNwW(j6?mW0$eCTZgef@04E}gx3IiRDjqC+ zHN(nJg{m-=uO+$KJZcScI>QyQxXbe3*&-$Kds;|cQOdVFYA_shgl^Uoqg2Ts-o0Mc z)XY`69MXFydSzkmY52OTRpTsSOoZ$&fWg0wReUx8z^s!8TGvxEQ5Y}WzJ$FlXjeWWs|7H^3 z*iLkNvi%2B8+RwPP=CLMdwO*+M29+hMwGcpi}(tp(Cck-@bPJ=N3^*y53D{hP-y&G z`ZzoW(1j&r^b~~1R6rz@ zX$PoyqtxR)UHnt`vyz%wa;%IRrd7+=@TAk)U2Vb?3GMB(VyU@5e68>gu_xmxt6mO> zu9Z+K=oeAmzKejG0512F8@N}GV{Tr?tDUwm%w4#+cQgcD*adJX8%vu?=UVsiK1fws z|68jqn$A_sG<0NV>vf+jhx-ZSijlZ2NGXP4@0QWdDK=w|zG{v+gaPTaikJYB(>Cy7 zQwPo=X6iGM2P{y28v~RrjhJC6%~K`M&Nd+&#Laql;4ga3DdJlpb?jvC7%kNOAw-kw zU#RHKkZM$yo@(J|3ywc5X^oKjG)D4wBqUM@rW@hF_FFVc^hZ@u_LPsfTR#%vSTYL8 zA1yScGl`-t9WiZEb~@+(8lBIabUsN!ah@cn1fcu$nuF)h08*`M>^z!CRvMHj=4W&P z2P<+cjK8Lc1Xc)wya!oC>=#>D+m%3365Z?(^FkP?9GHKi}k z=`BFlXPAn>c?A7MBuH)e38}ne7wP);ZkWQHdO94BinNf1l#N}44TSYoR6qR zJ8D_jVQ1d_w_k92{Z%@DkM)YH=^w&R5K)^%G2Xygh;RmR3JMeJ9f+@}x?LM>`W`ff zuGsdMQ^-qdJpLzjBt*j=qfjz$dKk+y!70Ql$lg@p;J`gxGZ_P<_6SCv@~FGi>b3F= z!Hqs*Qed^rWH(8F4P?Sm{t z_Gblt1W`W4mKRlD9faK);9r2m-09;FmRzHWz7@ls4EoaYU{Y9JX59Th%lQtlwRH#y z_Ewa*HH?8Ih`P`)ybwf$HENQJf2dAS(e31L(D)Z=B8)p^SQhzjr;PmuTX>dJ7RyFj zE0*vYEJ>VB(rO2PT}~HiA~J3lMff{I_0%iq9#58YB>dtEl&mX`vygo?$dWQN4$R4= z0A70Q=^BugX0D7!q^9WlDo|PLi(&{92G?5$bGGa9>KGnLck@_ve3C^Zncii32}YwN zUb_7qIceD6`I{-^P;b07H-$26_l63R?r-TZq7e^_=jMZo3|JjZEO+lv15S-+dPL=m zR2mVHbNS_kuYFGtKij%*`?_zF^wDgSnJCogra0G|Xpo$^Lq~?mlfcZv>~?Ji2>EmH z@gy0LV8ll~A=)vVIa3$#l|Au#%kU21HE9Om3ec2Vu zp~0ksZu-P^pG@^clzlAz{N)_j=rLgH=j>5iu%A1iP%o@o?G@o?9I#6hWD11#8pfB< zhoTxaH)9p@ zc~Z$#I2H|dGL-R}>VpQFAzkZ<=rBAhwN^HaZfqq@7a8q#EgU=`dv_FwcS3>3@*_lN z*bbcvhGt|{W(rfj5fbuvlO#XOYTg3MmRic5AH`jko3fJbqsZ73BJ|UuErz#SqC9oA z=MOY%CB#YUwQ@>)g>eg}2-`lljR&G!Y|DZgit!Ex+mAdM`!5GvKh=50scc1cFN1F# z_IBtLQrot|eoc3yt;>k#$ME1V&h7~A#YlASs$n&c;^R6QXZ7*fK^Ov2>8uG*4AXK{ z0d91hPWK`6u&D7`!viW$>8*B=&loqFsK@}%NBpjCe4N0YgK3o^2nkjUeFf(mEL5HE z${Z6}b*mKfk%Z}?GuxRysuM+n8| z4dqZv4oI>TRdgzh21q@HAYdqFMF1-xPzrtIv(=|WYVvJrf@rcsLO)i!5QnQ870+f*3{_O z8^WRUohr&*aD~}ONc)e5<0*Vv13%0vT2ODp#{|u#KNZi{b!o-_k(-H;7r--xbH=DmpNwV~xjE7(dC=kAUq+K1`Lug%gKVe!YmawVki zhA%yfdgjsw8dSb}FyjTePQK+3u5f5sYU$ds2l#$GC%$cvOn(VCCWrJE?41Skc%PR>tSNW;AkF1)AD-=M@I-NMYE#E$dKmONdPe<2<$-at z8@kXNfoVw~3CvYsGdRqSRf{qI=~qOM(8MPim2=#LnX7`oPg?Qrs9}fm!UwF(gv0sh zI%Z!iY)KV#c62j_VlTziT(GWB{p)RWFBV@J*a*-Vgr}Nj3I2Js>c6GiXTmffX54(k1^5g&QWSAy! zN$?>#oG_?FHu}Nv95Y#P_k#H)Of#{^NECAr@@A23s!mQ`qsZ`F_?nLjx_LTBxH+6d zUn5hj>1h>2ep>dvOH)W>esVga{rV?xdweXJc?(i?6BFga&*Nri3`cM%@N#G)%e9+13wR3d$+2CN&yhoNxN*i*Mo{!B!7-ki{t7~b4`e2y;>!E(^z0y zukOcA_hi*!r5ESxt7Rb0BX4PNJcrA!aue~~K;ty-+Z%K;{>O2^;C;B@*e$Kks;iU+2 z@k^Zx?lcWypeN?N{8IO4U^T;*IS@6Sw8n!D3?ky+B{7GHn}XaKX7nE?%op0i83)=z zy-EsWh&HY5_bFTEU9xWxTI*(OcLxE2liMp=quf?+8G?D*A#12GgqQn*p0(wSIV0~s zeo!Yz>6de}Uk7pCj2z+)agsfeb7A` z{d>_X$lDZbE-NDY!6%&6AbyMWs@|^VOh2mT&g!+SC4H3|3sMypnJyPA@M~1b3bS## zRWt4%>yqa~18Z&n)>?A86ZNy=Y*2q%8rk6Qbi2i3vJVE%P3%z*Umq1v^RK z{MNVrOZnW*TqJ#58TEM@DCF_EONm1h4gOLv458J*RTEW4YSL9jmk(+DIAkTmHzC_fv(iIPkG5 zaK4I(yIo{{-gEwAa-B7xxFOU|d%<5TV8oZ&XtR4(SXgHm;g(!sBDXFIArSGge-?H) z?}FtrgQB23imaq9R54)-7NVH1(oDKK*c1C4~t~;zp zq&$LIdFkWG3MV}%J4h?4FG{mI$chE4xea339l!#4vlvZTYXRJ{Non~y2RM04VcnZ4 zY`wv>JkpHVB3%Pr>DBb2{4e>h0<+`n_Kqj+xQ9Ff{gM6yM_ z2LoRyup3k-f5P2EcLF(8*&>^wLom&1F0P31X`ER~hv^;U*{QZ3&K>AuZvf zxtgdb(>53sZct(VtoXugt))Pe`N=5YQG*|98MYt9H8<_q{4M~|VOLM%Yooy%}e!@Zi^m(v~XWy7Ye zhor7`&_RR4#^Uc;$f7nmAfbGUB6F>x)4~GMgGV3Qa}eE}ZXfBVn<<*dT)GS5qgiUp zLZy@TYjVEscOMit^T=jrczKX0p>TPbQP4@4wRzKge22otQ-FluwD`rZPY6U@=R0*J7O$ zso++XUOHe^2_o5?lHiOFU5H_pr6(gd{ZG)V+Nq+)v}^p3I8@&0RxA)jjCbokN1{IV z`n&3s2g}cR@z(wlYZ-It{3~(4OA;Ne_-o}1i5sj&xVt>LaWqEaP*__Gs`ZH5Ub~GV zZcd+&6561~cmh?^b%p@nbv%Z(VQR-)nkq$9qjFQEpPt?#`iQf=?W6po06rOmU>}Re ztkpU_v(3!Ex}kI$GGM*TbAU5-i|YigehP5oOC#^DB2EIFQ?xP#rOCS>SEW;;hMbS`yS5H61gZ#A-B*xXEurRzB7F?Dx*~`0q zh9DO#cF4XBF0o7Iad(xH3PSoS@9NpuxSY*4u(C(N1f~ndrP)V3}36wnjxX=CIV0A7+VQ-9_ zP1(aEp;gS49$9P**d0mlL9o(J3M--0LDOn9?zRFEHKxi0sA;Yj*j~oMZqGWL_37vW z-P1wt0zNXB`g3tZoDYoU-yhy|a!=wu?`SYhxTC?I4c%4x7o zDh5@9+7@@-UhC-ffm61=7E~#ex8g0%!h$Vg%3xEigrAu)c?Tq2Q~oGk=-{Vui%8M3 znHk9jB>u<)RZ7k_(wff^vh^Gt6e+2vdwXl-y$NzPWPmp^lxmm5PncF45Hx07bC(IH zQ|I%7Yt&$aj84X-C{@N@y`_BQXmB(0KfjI0I|dp}OgXI<4B4aZlFXIRn`Ex8rjIOE zDx{KbI#}4|t}57?X?5pRi(*~m?QeSnk^8~26W$*=G=A0Bnrj~^!5M^JiKo!Yl+Czb z+K|^5mLaul>{7kjnC8cDxXG#KqI=>z3~5IkOG-043zHk-XKNN~B^B{YdDAX9Z_IIZ z*Zpr0%0S3-tflMq_f|X;REh(KB<^0h%P_wjciXw`FS1i&2LmVTY|Zb*DDfQDqb?4- zuY&;N%e@`8^32yZlNJ*_w@tVTxGV*bTdTekF8fdFNx*DQbal7x-yc&d?w|ZF4)*cc z-AAX=AEj)+i3f2PpKv;A2BdqshQ%L)up1n6WkJkmQQi59Cid7h`lNe6 zNNu@sSsbbC_KM6#pT^+D!)n9dKqNM5S?Do@t0QITzs0@RGRwT2^(gF95y!HlC~euZ z2toBWT=&-!OR$z)jn#Qg;l7DKg|_&2G?HnV{l;DIoAtA@wedqQc0>zSePq|ZFx5m z)|)nihfbqSc6FdpGnowwLt~SWsBjZn=y(uc*V&Qq5A2>;UijaqgN3m%L6{w!_8fzJ z6%*{CuZGKqsYrjiD>aj&=_*@gXN6 z202GAWV`>hi=>Uj$1 zjKn%TN7}uw;B6NSoA~RjT%PRX2e~UCh}|jB5_Fcge?F} zV>$wbM-m0wZ9qa#d(?cDxBz{HjcIg)w@VjXfKlu!f9$@aEp=m+Z+_@8^5!ItT#i zfkap*af!QYe&Ir#z#5BoII7ntZu$Eu5!%IppK0M>FU+oKuU00_9@^53BA4V4MOY{2 z1r)(Lp6kQZ>s5hS!aQ)+?pxvH?4bS*WwAs7PqQh`mQ380b40;W#kE zaoMiupOuaul0LuxoAr;3PlH1mG2Y@rrBAKyfu81tIM-z&97oi>#9M=FS1Ut~9W4#% zG(bzg`eYAA>LO3hn{#SCZpvXPck25w=H|qXd|V1ai=v^z>ng+tK}Z+uOLf2tB(^-1 zCzX7h9Vt*AH+UL2+ot78{0Vc|;GyrNy{?Ifs*u3zxB=JVKi;G&RY=#!1{qAfaIj%I zH7E|bP8sS4Y_J|}xX|tzJa#Ox)ytC0xiDSSbQ{U&Yss8>bmCXa9tG??kG9WQ?_Xh&)K&HajoMvEs*6>*ngSNzgMGQFG9?tlN z;91yMN=^VmuE$Ne!cMW|$B-!G*@$Nh^weAvG_%$#1@j5MD%@z~0Ngw}~ zUjtz^%UmPpC9G#09TOZSZ`QweIKg|4-s<^gFzx=6Z-Zx!A%b% z;%o?EWvb(*yjO7K3A141r=1c=qbFGym|_#Et%lt3mJ(?Hb2fv)#0Go+z|3Ds?J!kL z882JMM`3(E@@DY0L~8QoEBzNilJ!*~^VhH7zuoh^N`IJcdz4s3|Jpbo@`08aKHPh( zVPp#Cg+5S15Y^_@63fCcu1qV_U~2F*Ty4oePhe#-$Q^K@MZm+zeNm(ZzF8^@oLbMv zNb5iJg6b|p5QD^#HD=pAlE4mEc)oeUnCH-Ux=fsmr&%5J)?U6Kwj7H)+qddWK25gr=dBZ4 zo+4py{r+%u?Gz-*RIi*9f}fHk z);emxq)rC@KZc!tEWG>jauoK|TX@98+Zn0xY2zgvGL#(5`caNLy3aixzHLefmz^Lh z4BgJf5a_X7%G;V9Ir`4Dk09A_Beud)n+W#yrQEo1|)>Lp| z@RI&2DJ$-25GaOLHWzD~ihAU1i&T&_$)R0PDc#6XE|P~bX2}k*JSPQJ;Va81SmT5| z;~wXpo8T&H5IVf3xtSwAjB;g~SlW|wNKC2KB~|EUN)k&MYcw>WE?dR!tE^#d!6hI5 z`f>RTe667^oe?tT^=&`y?K8w8t*<8k=R#}nFO7ROcdRXuBu}SN!OFlX^?lRa_xSo} z(uv0gkH)h8H+xbyYhUE$NAoFhhBpuwN``mB$H7%xeW-pSPec2jYU0yplz_Sv&{p!F zg(*XM!h(d3MHHM9H&Q7o0~oqfWr@GW(aINz=B&3lNEBIPJ~SOktB`8a}Cz_Re|#@vQj?O>nXmk;spC z1ZQpIRS$xPZJie{v58JDC(kar#rTBjxC{5*W@6T|cwiSCRHzAOxr*_A+ke1S$;kY> z*-Cm0f7!olt$d}=Vvmo}qkV+mIPe@EG2E%DXNjZvqeKSBCe*hL6wEKdm9&FR4jAtc zBs+@@V5m+S$5C_#2*}0&GFL>z-w^Tbl4dSZ81OT6;ZTjeca1L^V*T^`X4shwIC3un zCeWeN%#sDgq5sM06ebI{E36ug<$^l4c*Xdr^sy^7a7gU@5K=1H>fwyDGDEVQK?#Nt z1|xfn8f;uMHU~~qj=xb|VCe3|hWgaZ4zeWV5))n%3tNsmyWSEyWpr|ZjLTSz881;qJ2h!vo=OE^~J z7K?cppUsRd@k#0WxXnkQmfsi#?SFq0)%DJ_vvo2-8LEZr%;8s=MNff>#5`H6gzqn!Z`eEG7Uj5 ziPpYWT&XMutJF&0mX1B8uKU%hq{8!4)=imo5fbf7&n|V%O%Cx&kJa?R<~-;LIpa&p z({)~KmJOY5R*r`UJ1kvZiMKfu7)|?!QHB!wvJK=0zse;noim-M54EfGHCvaZA-`NeWck*vd&PL zxTOMhVzZ#ACEO~ZAiz!sr+mE!8;yX_w?IBy>07IZ3TtU+5>4asr-iST1d1@ST*W5^ ze%>>{Y6w&k;$>*=E4beA>ddz@GLz} zmnVx|4>vAkBz`@OHZ3Iag>;lv2j!#O-t_G>llsnSR!_Ux%iWwdG9$N-~43!!|&p}y5V6E=I#bigBsciSw7|}#{CX7d5>rz zPs1X{s)rq{6XfrJ&D+LnogT5mXey+lki_M;Y%6X&h2X|vB2GpbNqg)Q%llgt3o|MS9J*q;pb_$6k#tw6@mxp|RX%|U@+<}Sm1l~3NHPci?SP<-NvgXXYL#&=`{(G@t zZ92+c26<&^zz^O?jA2|Zu|!0U_z~FTYxV4K;a^lCNy6{YsGY|AcG@g-qGgivLb?HS zc9(-{=7Zh9Jsg@v=7jcykm&oy(sQG1Ze|xKV0g%*&7#g1prdw{Ul?oc0OIclg(&PI9V&jiL|)O{ zW2peSJ2b5y%aW&IA~6SX%$iToS=@yc^=h?@wJu~Fj3FT|U8|q$&=q8NZ!u$II)Zk3Juu5a?kr?j_5=r{VIy~)@>%N5h{eJr|ox#HK-bKe%3;A zJuO9Ni|P8AvtbbN!Fqo&S6&lLnqr$2S2@UnL=T&{yj`rkn_HgZu@^1=XSYP0f^Rp^5*x=U><(lU+Lm|!mUL6}E3*pv?a zW%z~qWKHaxvkIv%E_^K;3fiO`3v-@Ph}ULOyYIW7c2|(eT9z9Y-6cm=O@19GoX??; zyxyRUV@;qy#i(Df&yS`Mc(2dyOQv#2Fy6jepdPu}6Y&CWXMVQsgD_p#`dja3%1=)) z3>F_K+`u6Znc!YzjP*Y6R!=&Jak6e4BhM;MNzLQoPN3 zty?MrLr3x)?3XLx%;CpK_lJjLK`A%|_^6?SKFa1+rUHd3?<`D22}ihQjjK#ik0@*C-w^VqCaaN{!=B{SL5AezN{mx0s~qCRaUv`FjaTe2y`Z1mUJYG#UBQYLv;}pq1Owe*R4_F}xi$ zM$$HsGjXyMDar{mce;aP0L4iqZx3k&8JonnYdy>}^CjJ+7=COwJn%LDy$hdQn*4wz zVM*aPdH|mY(pdVispqv)NhK2VsvFzl&_<$S2I}k)ibg@!NOe&o9}E-4M&*p)cz@ z8iu}Sfw2DI^~G#ZcM;5SB7m1Q*Wp)qL39CjAV&H40nuLIi*Or(4onV~#2B4XObJNE zsY?FrXkBHw2dv$}g33U6PiWQw0(2)_I=uaf-aeH{l@>3dXb|5|!4}1_VRk;Vi1A|5 zrZP#bE|hPSX1&r%eyoX%rWLxR0Xr1sNv~h1PN3T4RuFO`*9L?pi6F8wOAK)c@ zP2Mq?qcsb}Zr)nFA$3mxhLs`LdaRWVs|3i+iY^i z_gQo@lzOSUgjq%M_=lZ7 zr8b{sVr|LJjLu_9Qzewcr@49i+^_D=bN%=MI+9ncUI>LUU>l=oegy)Zf!xS>2+C|= z^F5$_cb2~roIXKk`HF}m5a0{Jr0*ov=0g#D6^h2OZJ>LTb6 zj^&U5Y!etvXV+1nRuOhp)QC6K&%)+xgFFSr@N#U|S@Fi3Z2DC76u?<;j~0)xw~wgQ zTKQxjB-~*|E5iIgMgQ^;c?0|taae+Kx(%E4GjYHW3?9V+-zck0KMIvS!r7uq zL`D{2fQWk#8O`G3==eT)f?u)h;^HrC=^5+;qCbF--RHV{bH9Z0M=7@A3OjWQns<^% z&L?p+vAY$fA)K4j;<*DO9SYg8jO-wZ`;kHFpBdeiuRE;$SAf5!VBHM3cCO_cqtB5r zM|?9$yw-_)hq1ILwk$xB7Fz9aQXjl*AN`p;1DoZRVOUJns_T3yN|Y2awXaO^xN%5X ze19NS%NO?NV}K8ltERfq%XqCE3Ei-3Wo(ic7mb!R_iuz4%LhrdD_=4i8{`!os}bWt zbU)uDm8^7>7mjZv*#?n-AJxY}m8EZ9`>MF$BMehCbt(USfE1qGj@8CX+K^q@gOeJ` zw+yO^t%7Bo4?5G7zK*_;zLdUKQv7%MnpPzJEFTi5GBncbMz6omh)%NA|pzsXm#eLW4YtrrV^ z6?gYT-m(j1&gyRIrwjMuqr28$(P!zLUa@>G_!zN`mk7I%8g>c* zfh`4Ph6mJd#$KNTS#xL=+Y*V7#5-N#%my44Ph78LeJ86 zC);q|e0Z;TB^wTjWm}oDREVmD*}ik|_Z^&BPx1WA6Bc;(OA(0Py;)rVCH6;-RSeScHz3emK=Vd@1~bAnnW?(cvmb@+@DN=z;| za#oplUIZ|?(FB>uePSq!lvAc7D^eOho~uW3?TbY0YB9Yx+Zv0ngJ=tos#B$7swk@q zvE~1;+jk_E6AxO1IN9g>dUhMj6MM6rc|vxJcGF?!P3ksIs{Q1V#dF4MF^n7f*Cb)UcWU9(HhfMa{#F4Z zE!AB5*awnD)3fMwv#>|Nu1e>iD&r_<*82oNebrgj^gu#LVQg-eARS{ z4mm54Ute0Q`W-qv4R4=Ux%}4s0nELvNCKg1?3bj^pQy`sc_@Qo$x!aEm2~ zoMUsyPdwCL-Dq!7^Qk{}t12f6g;}L@#TG~-UhHB*)+!`p@xxIS2|JAkGGoPacirbQU&!h&-l ztsFb&IllkzqPy1VWS&3~nxuI`W|Mh>HB^Q(mfPo~aAYw>ovxi#{npzydFW{3!GYwr zDp6|gyS%?;GGM==((CHo>O>h!WDPGR|C}FkzD|#C)TF( z5%}u%q}(yRk*p`0kV`9yIR0)HPKaw=)QuvLf7e@{kDv=~s&xiGGmZSX$@tMG$F%=y z+viyFJ=6>J@e5OQI|}YcR=C$LYqh;_i6@NiI{S@h-!(S#gnTKOCukU81Ty(B9a-Gf zh4tU{E7-0SA0tmTwqOZ`b#D_$PExeSW3#NP$s9#pk(1(^@|9!B`i~HoM}CJ*6fDKC z1s&U+mvWr{=ww!GD=iM>(P)IVlo->PVlwif{^mo2`7VmCQ5YXR9%o4o&7oSX)3-XKHl49L0O9o!@R8+F^CF92v2cP{2YAtx&@MDEJ&7lAQAOJ~3 zK~ztcRTZT?80XJ7^OD}W7qACBJmGliasq6zZ^KNk_Ajzi>e`9JEoh&%={q`1i| zf&xf;B7*OUpi7WTeS!^0rs@a4HUL`z?1Tq2s|{_&vWkt80SEF!ojeroM)2{sp{i~U z3sAmN*s@IQ+pQ2%M%F+JVZR!DE;mfc1LeyJzq@SRNx1Y#YI8`OQZgSqdCB}Dk%f-# z04Q(1v;IFq(oA4R%dIFJ%+8VY2ZWy|H%J3J9kl}MMKZONb3Y;tI|`9_>c{n zAjnX3IE|{cD)40cUQs3;XBo4@_%Ed{DTzzKeQ|6WtoVVgj)tPNM}cS#5Re4)lg;*o zt3_B;4i@Rfq6mMk!I^U`dmacb4MEypDNs@+MY6Q`38TAnzmN?K=`U#l5bDzeh&l!d z_aP{^2+jaO4@J;jsmRRyBxj&=lgO@SB`C`oJn|Q9+OqI>S^i?qP?j8G{-%zE(#YSs zrkTgkBeo8d3BF?dFt{HHktf-n3+!AX_y@xMd)O01-VDloU$}LfC0MbT^q^$O&@;*R zuz6sZVtXn)43M9~0dRIXk23Fy@bzX7ABp?{P`!i*t^$Gg*u;hS0f-j1BJ6T~(Zcjq?Wjy13S@;|vxq3VwW!xBzahiI-KmN z;DE34XAvlu6E0nWTR!agVNom#JAKPs8(D*i`i>Pl+_N2E=x@oR<$y)TiPHHXXLiU^ z3?i3_8l1ukut;y^uhMMW0fH0sD4332@Djyhm6N5}|8@geiS-=?-Y$#*#DfE3!vt8q ziT(3PG$RK3F%(P=?RD?=K@N7hD2ohWkpiObK-5K+@JK4Z^o#cs(^5SL=O*QK7{3q*`KkZid@S@gQQI(-DzU-Fh;V^ zDWXJXWKrG_br&M9vX~oCw1n&~qD;&vp6luDCeJ0hJM6Ig8+O14ufHm z2N?3h_(iNts1SF=?ho0-Z`rwr5LzGF^b(6d5xG^i{WN6sWmg`U-=ppY$msk^S2^+E zQQ49&vK!!m0qWIc7viDEaItI#+j~$H&I#kcW!1xk0^-!Dzet>wn(^l1Q z1Y<`G?7n1^guj>Qk_YSDgHma|ZDIgK=Vej(SfmGwOn|5>?BYepU&LuN- za@n#75qnp#7*O1zH9rG+YlM4xp1-{1Jb`hMRt%04CoUvdGJQy>gXwzKuslkT4E1D1iLj)LutA0>4 z3!I9^@gUmhSyg~r6_r&**@_4j6ALXmLDhPuwc{v69FvSwwu}&xT?AA7*EkV;1qvmA z!Tq**!ga#z{4C0sMJ7Vjb;(m^&1qV;t&4Zz;^38(S-tx&N;Ak86WyIZU*mwyA|M*b zhw%`UM+EyqkRa?A!Pj*humX1qv50&ug2qXOh?@`<#j@m(ix45V`G4UMFgT6;fgM06 zLati`rL$q1IMFx;?pIP)7ho$-vl};{N*%HJe>glq^u7a19>bTF*!Qb2T!E_Hm2p35 zO-2exKT5kxIl;cpVVFt&9hQqvFepdMv;Q5yegXJeJct6yyjsdv%b-D+*uNFBdddme z>H=gcr2JWlEstgU4?)9lY12Zxjl;4^+vdeH()x{dPBMNbuIU`|D7x0nq9j zeO62v4*NEMApl|4T0?kynxq*>sJw42{QMrOL37%mcSIgLxED|;GKoSb2qG*!Iqx@Z-HR|xqz)FlVAhXuK?j= zSdDfrHY=@Cni~}B_1r2EwG*NaL*#iDc^hsZ3E)K`kn&aqAR5>?Q>W$egJ4nymtw&+ zA-Fj!SW?dO7vy^3(VfmJh4>R9at%a~h4%>-c?BXKf}hmP+t|vYu7nS08p0@(Cu@|+ zl$Yi}et!tgBZA7Zpil^E$_kby0)Xa^I5iWNf6G>%Av7Y=Tq1fF-3XrsWob5LuB6ei zXEq!d1FX8C1BoW1>3Amg*IgEKQxq%6PG2AZnst1gu53z4LmNMKO7gfOnD~lBkSZGDkxaub0-&Wm$9f`36?6H8g1pYZi+&3mF%pQx6z15SrFz z@j~P`h?<3z#k8TwD>agtAdkw_8hKIJMD}+8J9ks~`N77$@WWs>cLy*P5+Jt?vn6sDakV0tU!44Z+P6&DZ{lomi(TXeD!JjG!4*QR0)K3z1gtIPr|*NjJ4qAE)lT~BKARKB#XEK zud?IEp>9j5rN0_YM6DEMJcyH9c@S;rsuX}iO=U_H z^9h7^XF|yeq@=_hos?0(6FyM-{uX6J*wF}4fo$kO`OynLSw<>p9R-}kftmj?I6$Q zN(*!!)kegwXQ#bk*c8@bK=L$VieD)bPKzj_OtwoAd&DIcai5Av%7iQj&FeSyl?yFl ziWR#7pypsZswpcTvTb`M>lxky>a}uQneN=OD8G&`hs~SWT_gq$s^x~@APA~1Zf$0B z_e(RFie82GjnBIg;lyajrf31O)3&qa$ zP&*H{z9H(|1y4JWG`lhHndZPJW-2INfsiZ^OyQs_vEYU*q@io=b(*!nR#6(DJCOGf z18ljLN1$?9dS@9nX^! zGAFR(cksQQY|2l33$VXi87Az4yA}%qb9Hoh7!!ez}HV-k6qgA>AP|P zoH;6*=a6B1%GuarJIFM=A+4Rs?~yhEN&VAbMsEnt1tFwuCCN{7R-__$kVqlzue3mS z>g*Qz`G=RFGO(?nO!bHCrP$lwK?&0A*guLP8Sr6<@(HGLSJJ znDHC<1>oKRtj`?rswZ2OoyFf5i3yBkm*w)ZBbNzW(s@|*vsf_?_+1emfZ^vMzudQ;#zpTTSs5X{bq>%i6b>|*Ka^u3 zb*1@3E@GV1;7TKOpFdq3e-}SBDakpoB}|#=4YgXqYh%Toy%4z_D1HmYGoh#^1Y#vi z%)*mrU}bu*l(H^_t%zo4&q+liVR^aGbbG=X}3bv{$QyAMzn*R(UJP*D`5otgfoslg%AkB4%nVvQp)_=#pzc2Yt z?K)&KbMPo&GIOY^Wha?9wjWk55UUo*Fh1d2G{0<{KS`EJ>j$*Km_!BI9Dqavgk*z| zAQ4=d1vg@)o9LtHxc~aJL3f}y-;Hwdjfu9dxd+OJ-fZn7xp1am={=CPJ@B~h9dc3l z_ZQBa#z*^E9N1J)7tsOMzW7!LVLko%-@oFqYd~?29~j3cjkb3Vhqb;O#*{FCD9H}Zfg zzD$Nm!lt?CfAW7=PkL=rFnjrbc6mCZ9XEV$^;HENlG}XzDo*al`*_>@@&2Y$aeQ#m zOnqx*nt};aXk|L$;ron6&D$`k57+YJ>D*&ee0>UQJgzSOz5cm~JMg%%57G$To8>d^ zm!nGo4Y9dD_N=O%>Fn6)PwO6q%FqA6zbK6j7&Zqw{*I3Mb@Dq-Cdb$0u5UZaOW$xh z-kML(Cj&;G(Q5F+iJhd2zN+$=-)R~c&juJzm*Xp{60+jpY#L_M!5)Njd|pR$4tBN# zWV8YF_BN;a!rl~hgM!&>kFb9MN~=qX82}rZ;4$VG1sZtr*t#!|9#y%n5ymyeR3kAZGS&7w@&;)8ZdP zGLyDjoVhk}d$U+OiLKZHmsHWp=#hGsY79ra8SHeo85fC zzovM?=7&uAr6-%SQM}U;&K_nP$lvS&X__E+ev#pp@QW2)4a#_bSaFy&EP^B2D_{OD z$dW1`qx7=#%uKP_+0|>7#^=os%6;(kfOs+s^Jh2i~+2_Ufi_o|LP6K68UKU>f z;_pc-Xu+XSCegGGD;f&ZKEob2MK5b(<3JhV!@R1pX{%l6Lw0QvlZQZ#dwlG5X~~?b z>lE2dkUxL|IVtpU57z2U*CD7Qe@XlO;b|auf9wwzk0QjD4`9VA zwlAI>g{0#`jnoTy?v*usMPcixiiA#r7vcw_zgF6%o6WUC+g~9HH+O z1sN32$^N*84Gkv_ zL39&v8Q5{4xY#03Hc^?}I>`w1wkUQ*neD+2eI~x&%qaU$LiVXv}ih9N#6=2ay9Pg|J%C`_$Z3+KXVBwB%y~Q zy(Oab7CM9$Adt`rMT#_0ks??CDGErj&;>yRMHEmZp^6mcCm@2-1W6F-NDUyJ+j;YU z@AhtQ?{4pMfe6I^&4&+}oqbbw_U+u8H{bW3_;m^_9FDRCG%iGexbR=M`f}V$Vqs@^ zmYLOfNiruSRF^9jsMSUCd?=6c>0_uChS}IeVhNZ}h#9poLsGs)d=~>kF?=M9?g^~} zVNgT05Z)m{FOmjfBE@L3WFz!XD5vnW+GkXpj?`|6JFmzLlQRktuAG}@@ zwy)Ah%W>}RabIVQ?EdJVf?`zsIZM1BiB4+~0EhuA%@;H=I=z`J%C1h(3O$?FS7Qak zz0=~*M`BesF{Og&n*$nHVjwmmzQG9H6x+xaMF>)pP=dER;9c8Owyp%?miS|`c(*vw zqm!1UbHpdnVl0j-2um=Ywdl^Fe2`d4Ob_!$5!uUaaSmaSB__uw(Nw--Hu-DsZh{!< z7r9wXs6tVT(L+-s+UCOOM(`^+tb=w%v;ioqF}h_wjOS{7BiB;pFF%ssJnGjL&ZPTO zFutBxJ{0z@lQ;e$%9P)sM}3IRt?cmD=ahlmf0;bkKwFIE76g-9!;xRDV|bGOWPmX9 zh=0B0<#lrHM4tFFyDVfYi)fArrw2{^Y(vu|$@c7(uf(#;NBPm?>}V=GBUo`dp0vRO zLrvdxG=092%}Hd>R@Swu}0db(1Of!P{j;Hx& zI~{zWqD!g%4Q1=RxMPWt6QA#7C7OApn;> zTKO8019c3pq^xxbR&l==jA(;vHhN>!kB{P&4$p=mU`dd`fS^h3pc!dY(4B@E17QP( zn`=$AaLvB49ja#|e~uW+3)kse&%%HvP%Qujaj~i|m7Hb}n@6l@feWy5))KwrYo`3v z5GrLAFNB%VVhIQN=?CO#zEZIK=Nh%yKCjj5-9hpfi3CtLOj#C=(de;jF(?d%b!pVE4|-gCD?D z+n_Hn|N0C8ZF2V(SvS9oyI`8*#~QxMUmR_tu>2*5-JRLV@5M(qjll~@g@~>cW}41T z+oUXCg-}AKNsOA0bcwlw)zws5l*s}p*x%i|9M29Q${2{&^ zx{!t)-`gn{Qz&}*>vpQuG?@0IUHza%J}lJYK;eTZb8^AJHsr|i%ejzH1FF!G7Oa@( z`c7f?7-*1H3*_x~5)L539w({@?D+vB8_Ta3I_!Wum7;)Fi=R<;<}(|_Ow~<=Hpy3+ z@&&pt=1?O5#y5w9J6y;1Z z=vRxPo>#~!+f|is_ChX1X41Q>6&Jt3;Jx_$C@U=zi1r!`GF}RnbRovY=w+)G!oU)Uqog+1TSShoIn8Hm({dMs z80WCZRXuf#;$maP2B9#2pne{x&-KgE0XIrhZh74{C%6fwkqm3>Aj{znc=tA3K4=l? zQWvUbhnhK|d!!g&K`e_j|CTe2b88fzW}*OTf@axaPH#AK+%gT1;=d<_-QngQ@l8w7 zBZvZajo0X!#)3MK5!whX&MIlR#j+fzHvY1yEK?E4D z3q@h)W^J$5Rvs+A>`M`D@r_y%dH&znO}rF_XPoeIKBy2ZH`@KagE$ARO)6)b@05fY z39@=Fh|Qu!&4w8b#jAPg2sXvSqsl4K8-r-0(lCGyM5O{ficv5l{0s&?4PEL`Mx;Uo zj1C(Dz3NJgLWK+YpU59UFr+*!0hR$PtMkfckx)HUOv|Y*^As7XRT;e=5Vov>3MTOy zszFWAs}v+ow}**6@C#}-m4&*qSm$}LP1J4L)j;(uFng%Hdq#Na~H zt{P4eMCXNm&xolNl*Cfz!y(47h2I#>LzD@+6ozHvtlzeC(;0dFnAshabK-}7VrWh} zEgwLOmTq2x%;%m_evB6Lo5S#i(E3?o?nWgrLWcZsq+Ii*L{BNGllGWE-c&ZBZ*q=1 zQS&L=`*ZhRu^eNuPw0$ngkKKU75m4Cu>`h3qzZv;u17-a@^b!UeV<}QZIW2ftNPlm z6fSs30-Rcgk7JcIZbxEFNoZ<~l8%fk-U%1aGu;0{(?as-A#vyp`ii1*fpQ+5;6dde ziHvys3;H}1)Msadv6k&Djx7}d8UfHSi!~m}9aJoa%F}sT9oE%HSW}l(#ON@ zAa99-z|h^X4$R2_#ekjICU!fb7*oP8>plBRV#+#W?rk zxiCfrh?I9lj{u5EjcObZEUw+UQ4abwgr1GWsn5imiV(w*O(_KXSxa@uV~JP#yuNq1 z@gwr6vOAXipralJEnQHy`K*>0Mpcya^`T99TAML6DfL1D3lPAg{?^053b1BAB>3Zp z1nrB8HF(T~f>tPWtSY|iEncuxxq&bhM1HH)G1vx$=7YE}^WRh=-i)LL71M7!plx~R z7_R*62eooJxuS;=9mRkEt0L=)MLXWc1og7QdkK)dA6{rIx`&#t*}BkX!!WZ8!;Sbu zx2FLu0MnK5Hwqnqq9HFXRRiLoaS4nO3-QIouyW$#vdY$i=CdYLD`5<7=xX^T8Pgbk z+mfyxydi$1ni)ckpZ$s@y~mUGvwK`NEy4k`#(pz5Z_y-AVh z?YO-5y`1qJUw;8!W-`GmC;>m)#MJjFE0%@bILVIQm(9uPGpnHW6X^F|d%o{9I(X3| ztzkk{en{|>f3qPISleC}w*~iE`>Zfnu2iUFa zE2rGJ*rJm#8qY5^J#kFSWley?aoUQ1e#G5<@bHM-rAOJ~3K~!(z;c4LZG4W|% zXhy(5XjT-e=cGMl+bZ()9&*7{xov~PPUs=}1Ld?>QXPLZ#M}6b;oXX*!+xm9+)2vLDG&`go=HkBQlx@Np2AD{oxahAfWF#NDu1YYC0CDN*d7f}aho^v7CL zuq17rrtK!d8&T6j3;$&dTS=%x%I`%Nc62gNdCNb%gs4FECj#1+rr(gQYbZF>8jR?j z6D1<8chYSmf&l5K4{``=dMy>2Dkc%FtK{(8P^Wla2MfHzj?)s#t1C1? zLAIcr{kGHK#k7j>avj;Ah^n^{D_Y}D(VQ9usEb60dpdT9sqxySSla>Wglbp-EEf~) zgU3r){TW0Dny)YzQCTkih&oL^h}%Ii$f7EB90bgL4eFVoQBK&j%zo#13e?DI!}i!4 zw?6MJrYyEHy%=5G{A(81c`ztJM;^WXASMrNOSE^CfjJDhgF9e6p2MwtrBI3T?Zc%< z#qM`*KioLes4Y%?BnD(9_{t`i7pW~sTINz!v9LYFmxcOIk# zj-V|p4)S(U8OfolzoulQHc?$OeHe5K6pJdzF$2`b>7X=@g7rzK={1`vG8F0%TlhoI zvLrNH671XzH3Q8j+&(Pc!jB3D#Y3~w&^V7Wt1zDU8gRKbla`F~18%$hp>JjRSF&|r z|I#0f;rwvvQL+2OjnYGHxVcMAMd^qs9~%fE4zCIWg05)`ed@_7*->8xJ3bYIabM{1 z0PCNM_~KPv2VDQb9?I)}Au8XxMn5odaXG|bj7Tmq#-%NZ?%AMUJ^4y|tA^Cd?g20) zR?Zj$?Q@VYbEP^3R=;@zs`{BPGG%`~!kNt(ECy0QR{W>3JGKCWVnn|jvNI_wt?Ax9 zDC-A}3OH%jVcRNXK~!^Lyi2Iz4{vu=B{5h&8)5=IZA`BrE-e^dh?e_)mhTLNsGQKb zu(B)*~7;=fj?CW0)1_b>j z7DmM4X^89{Ba^)}Txghkci$Ui={4Kt$gNOq$#wzfLMLnn~T@r`h zBy48y>I7P}C6J^tml!EhTYW9;uKe0r)+ zh1p9&V01g^*IfMk0v+*oWA;<`)F|3?9{WRmYCI=WHpY_C>iTf{qI5_yv8ErfrmbJ1 zM|KzJ&ZRu5!DvAF*=O{CgoET)X6UQ@3OY0 z!4qm`6BCM=54nd5AI2C`h=wQ#2;h0bQs!fKasEp&EIay((>8X_>-x2FVrhHmRF$yi zsIxz8*ARmg%GP)k*73~6xt5*L@s>#}?gLE%%Z(R#fT&Wub?aQg$ zk2KINLiy5>-LWtsoLa_%2wQ?)#p#LuU{F5@W?ME1mRm5Xn;5AdJX5}B(9j?HSA(Vn zluxa~lDnxO%VYe6)_rN~$MP4?kEV}?hJ_(EzcT+Rt2W7D_NYf34>ZUEgX+n%CmpIk z){D%uLXu>nK{_r|9sEDA0e*prS?HndZ*^2y$%@%(8z%_JN>{@~FO0EgSSI zswC#nGP?VL|vnmIg z!P{|UP}ildTs~i~1=mIZ=3^L4odQgsbA0#u4~FtNl&=aSdm*C1Xx+*N-D+BQu9v@s zPW~7O+lmakT8Tb0i*XR#-c2Z)`RHk^5r(?f#y}Zl+!4LC5`a`H!A+qp!J!pYqC@_` zXwp~O?$clK?Qq<6D4zsET%^2({)Hv}k0!t_MK-r&W_HSpGhAHWEB8GV!uS z1G@x6@OYdP`hZiMjm*E9RI9d z&uQhDU6Bl?0WYI;j^8XR*Y#RiG{oZ-Q8AUyKNa0nJoF2!>Tf zC5*O;E3-{dKPL%tLO}de?u0jG1+DSWDwp{;lUCOtgP+i#K!uo_G?KG&iTp-ly- zn?t-;1Tk$6?I3QsjX!iM2?uu@)O}P%Pc*wj>RK^6991GHzgi(5xB%ab5G&h3_gbj8 zCNt{a(tu5i6CWb_MNHDQ;Jl(UBOV1sRa@BL7*!oH^F*sIvF~g>QA<+`Zp`y$}a{*$hi}>Lb0HpcsaKm;egB` zj_ln;qru}+C~N8BJ}M2f!{otu3$}d)?HxD_w;T`^4BvkPd$uCpSi>hfa3KoWvx1>v zL8y~Q49jcugJy42%s@lfJcP{ioKVd_1CVm6&3Tk(237`gVE+q40cN?<~#=jbwk68=}!=oiRZ4|cm}WoeB6#B1omRnZ&yl%) zZ`HOVKuKu~Q`(>#39{SxY=)Cp40lfp@{U+R;2CA7yVo2dHgzF2<%_N1RI->|f>uYz zjj6^Tgl()6CSJ{sk!oC*KryR5p2&#Zz3G6~=2uLtX)Xu0Q-=rUzwn7r(V<`6#dis! zJ2M~7MW?W~gmLrmTY_FCQ6RRJk;JcT3xKA@v_o7mIKr-&I*vN^tZ3K)6I;+G-jP9Z z8x3uPU~o&Q;;-T;oe7Zs9!lrgVCGx$%n5j<4Mb;G)(0ApsV(nA7a&2fXsUg9o^uG} zS-A*$L_@U@3p~N106mGjBR^=2Fo)%yYiI1;CyU+1@#&&pFs_2g8Rjch#G>{Dpv4oJ z_ui0y9`^pp(d0r*E`aSguXa{e;7Up?^r$UcJform#JWZ(i<>XG@QRh*9|l)N6bgan zZ@bcjL6Z{VmvMvy)*+4IgIGCptU6|~s3Lv6+WDxZRJ<69Kkme8WwWS!Opte!Qc$6> zs(|d@(*C@WR2TXcQ1$UxF6OksHB#e9{G_2~Hu!ZjBKx&Md*%*q@dNN2O1xrpSAE9I z2pc}@3* zw0Cy3GK_0Skgp}PR86JWKZsW4BSyrQTFQ>6aD5e1?Hf}&C!y@S4_z)kMT<9XFtlEf zJNwsBjh@IC4Z4i9toqvO4p+Y?6A+7YR%lT~{;>}qQ5^k*3_-AwTWISLV*eepuseRb z5S2~c>B8ps)$d2^QCXe^Vv0c1Fe}7THxi;j_XHo3GfLzzt%`Fd8QTxBs)=yU(dM;Q zPTV`$g>QYEH<{=g3_YTpu=QTOD71Vg?J(ySWizVHlMjmqCWrOmH za|=-xrymn1V(XIwk=@rkCk9&E5yK+LADEg{c1Kmrq`WYa^q6q^Fdnoy_K0^wpmAO?+PPdKQx*l& zvuts@#w$Nq)cM-M(Dkb@VGtpW7iBZR4hV#8WhVF7I531xTUDTl1M>wcI})J9 z)3Qe+4IYS{z|EZq5Wv+%V+hAgh*;Dc`Gf3_99q*|-p`H%1UVMELL|OXk^udHTGY|F zSGMl9ZNdzKARr-&_Kk@-l~I*};}IW}*EW>Ow(QWpnsp{@?2f+%P%BJ5rGiS_`R5Dy zuO|lm@&p7zog*qbl?86y|0;_Dpk*lspD@RcK<~zgep9v?pn{dJI7Vb3Uu6%Rtnh>= zs2GSY5};u&*h!FzeIs627f!{}JwB&HW4_Oi$%x^kxcS|8y9Ag|+z zfnLa=heftNy@13Uv$bnwb1B)o8I||XPR1qbr-jC>wQ|VgDKun_-SKgjhe78WSOy8X z91kKa6)irPH1lo!kgWNGCa4xhCaNPs41NGDU5mFup??!+8S;mP*d>ZP*Bo&^3QXDQZZOi=|!2uo{yUS`h(PSNe&eFHtF`7+~S4ppedrc?# z`(_!K+KJTjh*EUaT9V#oQht)}Z9M0|8CR>obG2}@D5exfk7W+GZ0{Hg#gDZ1qg8|} zfmj+VNA^)Rw4&27-NJ8W_gQ7dJGxq@g8;+dNdeK^tOKKqiIH;JTlB;_cE{ErKAa9R z$5d55(=}onnDPbfG_;=%gRzaskFW)Ju^Ds@HI~Z}5!oXfOdRMu*(iRXQ=O=6;@#ZN zc;LTK9~ul(UeTWiJ6HGe8c&pW{Xl?IyMP;l>eG0Xy7(PMximsr`2 z+#bErQ*&Rc??o)H1~JBaS>>;msA-W?hKrLk5k~J0TC60u!DW&dQ9Ty0ahu9sFeU~T zjX>0c(*lh22#A0t-02qs{o}!vo#<>sJEo;}eh(x)DJDI;WBDFGsGnba-iJJtIQC1I zH|Pfwss=cJ{2C>K0-{1`U-7|f&@jaL_){gjj+*{3`PDrAq*?Q5Q!=VI%2dj-5dD{o zrw!087+!2_#WfhzOlOe=n3T>sX^=lYc28qqUfqT(tI(34fGc;k7w@m^ZIAw=Wrry8 zePxuCo!v>E)~%y9rr~0H4^rBE^C>O=FJ@KdY0WxjF4x2pRx!7Zc-gVs#!`?_SxhdW z?K^Gl6C;X!Bk4=CQK}h8h!mS%cRCiuThP1!`44kqcl==)TmUBaBK)&sJJ!|)MZj!? zIRv^>tt#_#!V4{EZW2Ey|4Q48+QASYHM7c{n~kPWB0K@Q)PVRr=G{6#4xaM9iT(vj zY1lR6x{t3k6SKQG`VN7{@L&b3Z%a8}7ly^kx=+c(CGMsafh(kTbb#Ne)w7DFeKc=M z=tYb?z1%b6gL@^>HwMfY4c!6|Piw?*STK6Id5% z#M}}DlyG5p1iC@xV0gy7sgn>c6@)V5gAe)y#FGV=-pqxY#Z#QPIIbmolqQS(uB_!$?eh+78 z3obsijZMedSWcVN)6TcV7Zspe9)oSbIS$n+ih;&VT1HH__Qz9s6);MxzHr?vX3`dAl2Q`9W z!y`R0H5i*qQRZWJa_;q6Iked`|E9j_FtMQIK0^WAs#yJ)g@|ZgNCULb2=gB=};KlPw^o6dI&zryFo}14%n625cnO^_A#RZ5VMOF{mNB_#cbD{Hj4MWd&(k3|kW;N_Xgu#gCJWjCX=C9kKO*!ZkZa!!k z@I?mgf?;@DW1xK6&1F1AW@2~vXRGKHK!@k3=T5B#qb-I-=n^q4lmQ)Weo_YF=x|>D z%9WpS&l)b5eXPwZ!Rz17i-yd4GBvO4?@YVcBm0q9{QeF}_C^dXR`x(YjLIsbyEn=b z;~Hsl%x5alEknt~qG>U#C03V#DnSOanPp&j-JRuI6wcR&1r!A7ZbXpokS^&4X%LY9 zE*(oO-5t`+($Xoll)w^8OCu#+%L0;1{&@b4XI{=V*UZ~?W0?CC+H1Mw_p2Lin)5{WDSArNa zgu^G5yOjT%kNAFbL_g|}WyDdAB+@cFJsHncczTmF-iNT%H1DV4n)qDd20RP3!xufK zotpiS7+<_rL|at16NZVovv&j44lw1jJs~LMXgsfL^0P%ARHu(Kc|S@fOIm^_ zjXLVG@>lL(G&dON#e84r;;{p%u%{}Ry>l~`_F^0UErU$oGLQ){>1FfUikhReX6tue1~f#k^m4Z z_b8sq`C+G#TGvK2gE(78t;9Gb)K^3Uboz>Jn!-ruQ}e=KyPP}EuHko5W2BCS?XHk; zi%T^kgMJof?>?D89jXhlUkb<6M@)6n40xHu);WxZrAaE0|@b znpxbOiljx^ZhHuw&#XO)MmD7`i1DGn-z=w|4qxlumWFQ@dl41fVkFT5d<8q>aV=iL zy3F`y4*)sR)I)m9Lrg}fj^lU`ZH*Qbh_yY=(oQk;W&d4BB%_ixM{@I}8 zz|q#WosvsQEhr=2aNS@??!axy)d6pFPA8u=oyHV1!t1mk>miQjMvNc0H=Lhlr?sPxIE9l(GeKfpXpvT63njD z1Xp{#HDfCj%AVIG;CLoaGPqK(ury?$xIbL|cyPG3r^7w4grddCo*j8vb8hH=EK$@S zFWei?(K(6%(-0J_=WyQty^Agr_k$$lwR$8j@y6xHZY*O>%8x0av+)sa-Va{ah21qJ z{@guI033nBXP&b(tlxvA(6R%XJ<1CuWVc8Fc2;~i#jdORd?222gt4B_-H_mt>$X-D zO>~3;vhg*h?JdZ~40qzul)#0jP{8s-g#%}ik}1F3RL>=eMZ?&U1upKCfbaN27fEed z+HUIvJMAcwbr`_qNV#jGB&Wj9lqD+phkI3&@4Ei@TL^RV+U63I^}9Q}bB>!=Nv!&d z%svYwWA@Db7AgjWcTTj``IK_?-dhRO)-|P8e7ioXcjDCZ$kK8+#ZCiJgD!!pFMbLw z2p5gBXtNa|XX-@6^iyHVWUii|Gfr=UwfNmpL}a>lj~jWUaeg`K>EzK~aEY#>pJXtw zGUN4BriVnP-lrXud>8(7!p%b;;lHKkWT*Qfiz9kvZv9E60D4~fB}iM}h{$jH9oLJ# znW1#z94zoy@lrs;C)&b=)Dc9fwOklO?pW-lWcuxi{Fg!Mma~ZoJ09D5xcsVSebg#VRb<@Rd$)oAu%^7;Zk+C@!=X_|?eCrUeUqZX z;g#q>j$t!63MZD~c4XdVhLwkR}gLh51*b!dWEzA`G$_$^Wg|3fcMS zC!VO+Q=SN2!apFY4N0UPDQI|yW^-coJ4({}N6K1qY86jA27|}F`muFRPYfqAdENoh zVT5#3q!=`mXHN&Ha?cjyIIdG>2to@jw-gEIPgVnme|F&Xri~JsO~?9-zOhyh;B(>_ zu3EgoFGyr2vrgVU(JPpoNLs4T^B|AqVM}oVvP4G5aqJfAL&b3SD?zt6#wZC!L%Y^7 z;Nw`wk0g0LQJ$=Z4NRgLC=i>;S1io$%U_>tcrhTTVV+(#L;n=VrM^`jk*n} zc_3MwwnW!xt~deKVqD$Sz6*WP@N4b%8ib`=jl=@sr+;2J22*dZ=V>rM`O7i2Lgs1Q zT(r2fxC8nouMVJVC?l@eBtf7nfopmT#4qQcwV&u(1^sAm3N6e4nA%>xTq@Xa2RXR~ z@WRT5>?m;qBo^YH`;TzNApeZ~Ec8u#%|gT-BwPP$j+)ms4QA||D#s2fh~F(i4XjK& zj4*YCE7p9~OaFBk)NxFc5!IM-Z8^IoD&B-zy*vV)_Qrno3NJ}nPDa-ZXpc5FVOY@} zY#P7S`#f1}au}P}ERO66^vq1w^J(Hwc*;?fn!>wpd}(T{iQk==(4d}=^+~X;Q6qV( z)c<9O8L^9JDb^zR)%#uZ?VJ_aeK-CHm(l12??JY_2JO*{>poqA+5DDhYHhOKuObT+ zHsPD#wD?>@t_SL}NxHHc3!WToR1U8|@)qPNO@g;<;w%lMzKmD14R)5Xe#NGgZP(no z5+D7rvK4jT9OwD=mB&$5PvmVKcos9wa9ZYcB0t(x-}^svnS_?wPjCDTKAZR{9jU!ZF+Zf>CkN+&GZSzPn;C!%-!{{s2^IwY#`os64uIoJCseN!kdrHb4^ei<~@ z*cmqGxxZ7)+b5Ygrip}icguMR+nQO%4GE=|GM-(?sDl6F8&315Mt)HhFQe`CO1Q41 zovEA=_m(83EKfeGDdKQ>FIGfCZtat93)knFJ^9aOhx5@{uXf-*Xv7=68LgF6Yq}~A z9PnIw^5-u%xFOFxnrGsD-FNlVChEnde@Jv-q`YVDId>p0=fuacjWli{yPH$0FB0qh znlHIAmd%nO$1Fe0*8aME)zqvxSFjFm}$2M4lJ*IXA`ruq&+FC9v0H& z3V*6O{{2UpV(n~VW0Sm;zdGI-jIyc0w@D#r^)@-~ny^j-LK8v3%fCRWZXyKCT3Cgt zcc$`${d9%DpWE~5Gy!r(j#4acqlzopo6k8b`(W&5fB(r~M=j6uxxpUEHMHZASYA$5 z<#zoP;KPYBjNLp$P9)wlqsH1fFw+)|raP_YyQe{&tKyoYTb>6{ksNBR)ogAx)Ln75 z3+Tk=JzvkSYk`K~;lHkTqD!Z7Yf`r{;G=F;2&3@nC}79NUFcO$-0`eZFz_1AC^Btd z_Y?fdT8RfJ_r$pm423-9B-i;!@J*!J+WW7FR?sLZp@fGPjWu4LN^X|40haKv{>=`7 z8?)6$5aj7(Qzx@hNe7azl1!ERLebS5ZCLP?j4?x?MEe^y2d=X<8rpDy4+|s^X+5{ROg7|M+O?4Z3}h zh{ox+dTpcab@>XOIIbh2AOjUDODcxP+-a|lg~JnPLz7Ep!D+RaKw?iRsY~a=5Qw-C zL*fKeL+PMFlzTa5hm-qul8IWh7U@#fsRkz2dz-j~qv?o(wNv5`)wsid>*eBcd9*}I zJaWFZLsAtJ*qA!gS{hPpqfe$8%<`lh+8$*aG0>WP+l&X65XE>FBP@JrZ=idt?m3GT zJD36!fnAIvc_#B`4~J`qN*Cbrn6Yni!5e9J)J+Y^v)%UeZs<;504b?O4`$tk(~8eKyi>}W}ohP zO5mN_SfIc7!?4*o}!(! z{L@j*qSLdO;We9MS)(ofPT{?(F{{Y@+R-Efl}`%<<4yCB9@5xE@g-u7deZ|i$S7en z*MQ>FeZ&6#vt{S3P0LNvsvDqN=vW{hcve18tLD8~77qr&phd~iv?1sbyKQmZL0GZp z)mtCy4H##|l9dHXrH19Q{{oghlvwN<+o--d;z zhg4XZUK(DFX9_42;Zc-NJ3{EZNqWs?$0Mlv0jO7QN zcm$~0xyDm;61kJn_>ZDr^==~eulgT|Nn~xciAt<*!RT|<*c8}1SQ%pS%$2dl;@`gP zaUmX&1tYjVD5s&F&oRZa4l;69T(yB=tl@v*Rs0s9raH^<4)>>{@Jh-~$kHKcQc%Gl z&bMV^WFpPRsocem`P1TZfGOQ|RJNk7wJcNVsSRVTLO%90dj_+UMcA-k-B>DjWq&*? zFNV_>?Ut06S{^z3N>VP;kD*7$+>N(fZ;npxtE>E^FitpL&Q$8bMR5BH;1yP${njGi zj;uc9lUP$y?c?aK?H-HL{h)Q?J`ZJCm*0rMr9(j*el7&c?=@K2+SQtU3SqShRVQ*G zBmL$fDm*O9hGC}wM0rY)12|M7$=FP%wjdu@4+ zRiH$*71ZK3r{42b$n4X%@--*q@{h3Dv+cgn3;`$XPN1hd(_y;Pqa8r6_8B&+Hyn0`gh zZThNDD;H6H43vH!$15fVy_--O87|r-9A{|J!2dy+%e^0MsxSCpBf)wl0^@&+NG6XU zHt>3Z9`=DhNo{AnV~CF*mZvhwpTLuhngK%^Y!8Om+-8yU3Cf*b|0D@lPsuDc9-+pb z>bbP6avFhfa(2@NG+u6+iA4TAZJtI07m*Z~9k}F&kjEL~jYiUXs$rEhJH`5DouCGt zVfcwpw%>HeRTDBO3I6gFp17Sd-DnnSIr4Zpm(F)yVHA_J?>2+&A)AfET&BK?nj2QY z*01G&px<2k5gN1Itwep#X_Dq5qZ#&G+6^(G+;Q=@G5*VK^{-qO<#bS~z?G1$Q>^Pf z%=t_&>h{XLMqN`MyA2Fr1cIQc_1j0zDiB0Bqm>Hm#K^Vnni83oxh3{{_)1nf#EvCo zVBqg;%SnG-{(I@Z=iD7D?oYCOB$)Ey?zt#OLvj(l>zt@FvlM!EJNkW=(kq;L3hPIhTlslY54f87ix$!8XZS}siH~f}qDXGTEY{y5j##Ya8iAwyCAUMzd^Wv{crxMszJ!1c9lcD@ zVO0(+`u}dQ=;&WYRAWEiNanBf{{mw~H8$yW)k9NB>R)@e435MePRoDT&ZwPm75~!E z%-l^!DBc7*aVx=jjRkfIp--kyqAO|2pqMc`3Af=_Qf_D-5JuX>n1Aop2mg;I_@*M{CRp-*tWXC2-x;^ZZ53B>qj8E@Y<=AO0~y9-p~y9 z^>aN+s>JC`YP(;(}=m@ z%RcQgJQ?p?YNaS?jc&7=BovACtB=rC98z5@F*aPxr1eD?hTQucDEQ;t+P?P~4|egK zqCSNQjbdk`&~@642;5P^sQLd|-He|X_?L`-r#Nf$i&QIl@x$|?NqYT1KN|9k7WE!Y U;ylQX^VQ2zme-K0`}{5Rf0VPzdH?_b literal 0 HcmV?d00001 diff --git a/python-3.7.4-docs-html/_images/win_installer.png b/python-3.7.4-docs-html/_images/win_installer.png new file mode 100644 index 0000000000000000000000000000000000000000..00c88a830febd622082fae5a2c93657586b96fde GIT binary patch literal 48994 zcmbUIcU03&^FIzJ5ITqz>3G?YCMeP&0l5?lO^{xK6zRQ43stdERHQ=!qDBY-X`vHP z1ZfFK352SYU?5Ur0wI)N@VY+teSgn+{(8V#4H~;{Ib91tKbl|{4tbZVPJtI8;pfZhb=N<>^H&4I~n_vLoQ2W6ju>Pet zh1Dq>a?Lu#-2Z;agL^@4fPj0RejykA+(J%Wxu|qe#qH5$Hvph@_U7Mucf%biyL`hc z;||kY^uDuI%Dw44)jteZPIRRzV=B9z7PMs#2rYW`eMwcG<&nI%0{Z;;*J-M?97EqwFJ(FCEZ0$0hLJSC5Yy-M<0QFhRoktwqo+{#ROBzeah z;SfsBufs7%BW6f8%Rft7He>fU%S)*(BtnyMLGYLO-`Gmu2@I>H5ue}neY3GYdho+{ z0xV0&HU=NdNdI6Yy07(5AN@{4XGr}#HnCK^EZ#7|G@%Tg6S1RL7Z;GCW0C?T; z8PDtbhq$Av-s$_B3HzJ>Qhg(CgYFDc;a2#5%ph#?W~GaOI!A$in~2~k$uX&_f2k~d z^?LdJR_k+stfV~f%H?_26g{Lz9SC>yN~qHQ3H~PVY*&UoaGgcTsFf)OORW85b6D{ z_Sla9GScp+l<#zx@0l&fqkT*}Qa$KsxL=|%I*2X5?Y*w~i*De~;QansM%uZ3WOr;c z4e@^xbqf^j<7{dVWHUQ;7r@KRsGC8yxm&z3({mTluKm{CW|+{ebm>%jHyN;3JrBv* ziM_dJ-W}UWL;S01d>=xhO!J>f0@%!i1p#hFFFCsY+LCWKUz2H_d{JmVt5HMjHj`uD zH-NiVJgkDPb0$#i420+ZU=?gAf6 zFvHrdnIb8rDVm5ESbOWtuN`mv>S`T-rve>vf2~How@SWO6YJHUZnqZw_LYT+kkp*{ z>H@og{_J?7iJm(MPxL~9C%W5WCucqX%p4jsk|2%XT2MwTluC~d{aPq>2br|HBONTY z8nAfwYq6jHXCMi2dolhDY&6{hPgL0SMZpWaW@WrMG;dxv{|deBNtV5KP^|E#kr^MjD~{?*ISrneK6 zS{6(0I;h!hV-S8rwW&=xrZrtKd#^-hmT^sSZyyZ~UzWCn?j-Do(%iE4#>sMuFsLJ~ zc_Gt|$bBHRDtYgxUhP!H^HdFdcvB08Y|}I)*{=MVC5@^3C&S6r1&#eU0HgiQJVb{> z8@m?U5J~%@*z84nH?xt5!ftP3)fiDhyQ{m?s|%Dcho;DN_gFf)S}T@9&Zxr}rC&>h zZ5xfCQC2aO$W+Bv4EkcovK&@byzBW;nQSBdi$fnF)li+(!!D2pqdX_jTpF(9@#qSB z7)4i%VL(lC5z%)1qg?i>fX@Qy%~#Iti58sn?dW^Qk^yQSlGm5jyBx+GC`J0!@oC@d z6<8bgLbjzJQd#SpnaSxhTSnxt!M`cmGvWLNY$jJI$_Utno;F%-g<-wQ`=f6U3BU>E zN3HrA zj?wJ)x&9(wsd#z7?4Sw-!5uI z2Z{(^@-Mek+kIdMrrNMQ?dexol%%?j-83DYnl{1#eG%R^kG#oIvzb<;QP`-)L`;SK z%wQ&SNV}A;^KL8A3g^ZS5k|q{b4%$e&RTX6H0koWCppwf6<~B z9hi4e2`qN8wNxzFDNh?9rakf%L5cN<0$NYGn*iubUYz=%;~SW^qgBs)lP?W_$C zJQl+VhpweTtG7SxGmuu$jfB|N?bLnR2#P5g{=wIiBV>9%5jCq~8$PWzP#o@%k9aCo5o-3W!}fVWl%@zz75@48Ko0}W37eTlv-hnMS2EzO4(d(PgR z*%Qa4w9u-vHH`}pDZ!=_S*oP!QBe%RTrTLXi_fCvqNH3k+NCQb#ufK|eABq#%bi?HQkC+YI z(9pjvmEQ>rhK7lCB|UENdt3VBM~=*1wX)V7 zshzLniWqaI4UW42u_I-P(%NH=kQXZ)(crafs1X_hYdgj08PVCCtZv+;PvmV0j5xU~ zwA)G%!{V|V+Lb+dK^88&1CxM3`9&oF{N{4=vAB=s5%vNf{on@-;thIGRcFicSFgMM zstg(zB6%Np^@-4xS(znQu}#wGoAz|P*T##(a@hr-0uvuI;5uTfL)wx6jol?HBN&Eu zcBK!Kug3KeTEl5SBwZ=Imw>jBPBjW9C~wB=H+L7yJ4lygFBQAo<}f{!;^3eladh`n z&(f^6Y;X?=D%Y<^XuaH_;xsm|*h#*-c+sh}zS|Iw?y%0Ssjf6=u>X|_|Vt;}Dv z&sRmX_q#^Oa1z?GZl`~QyxA&m1${6Tin8->QAs4Fn}Bnc$)#<^e_1kaeeDS~_n*5T z;5pazBWdy5vXs@dvo>?W`2w4@n<2C%V<5hg%Ior>EAOMUN^to4a{?@BkpQV^a0Uc0 zyC$B?ES6!seqB7ji@&yNf2f~u;OH^lyoLP&fx#a9N?kg_oOQ?wvN15G$6{ND^-iLeM+ELL| zBtFTxZNLGKUJRy<IrY+%;G0=TcS44{iA$7L+&Q4dF#z za{b6NiO4^vdr~T|b}v4ftXwd#wdSsgEM@S|#z2ZZCF=O$f4r=yrtI3^fJKJ~QyCEI zQyYr-zTuxQZ8B>?5)$FI2ZP*fx@7*DkLBrPFaKXB^7Q|&&NpA;Nfod)9N*l7=-E^s z%6`x4^mJ{dRIgiES#~|%lJa_nK2cZh7(3OELPSz&D5)sggyjrl2wT71Zq@1;N)wxD zjhs{5UnDnf!dyeC3Uw9Wh#44)sR+fzEVXl43F`bFcvSm`FRFLotc+9R4I$Uk9s1^G zuUA@N(+WGhf-xdUZ=*6R_89zdYyia{UEcJ)lOLW1VRUn9uVQEZ2|Y$vE{DU5yyI>< z$fJyDm)=iyRXR?HhFASyq*ugxSO3Uqqh?P0vY&de+JfSe3@?nw%{On@#8*9cI`A)5 zi&^c|WO-B8dbH|7KVIMyJ@fY=3d*Ffm~uEgQx0zX(=}?)zwSVxnJQQzE;!o{%1~cg7q;ypXBlbGz2IGZI7SY>9W9N5x4Ap+mg$aP`}jXA z)m+6DTF2w6z*)r;7(cu4Vv}cb?aI?$csV%b^EHMtoJW292k{x{8e``lEmC`DBd(Vx zoC$Sn>8WfTwJPrzvDEH;{QS3wiKTWtu4u#<9xeT=`SX8AbN*^mVtdn!c4X>T`ihJt zGxh6;bMD%-&|4z1-cC8>U%MUBqbN8@7<_O-^yWgJvzxSkdlbO-h5rf16*^hE<51?r z?xnS1cWvtDYZQ_eO$2|mb3@i6!3fi+fY7UbqGgT;eg0!t{fdbskp|wE^&DTU)r7=0 zo9f^6VZu-?JDTS#wVUjIo)Bgy1NwdRkd|O~wpN&eH7>y3b7thf--dIajhcPJkw%Fr zn|adoeUrHWCk&&w%szP{gfEF4paJTbrzLvj>)ig&vAj}ZAd0kf86N)cZXDiv9YeLru38&Tw==mC< z@Cs!Zz&Kw2CV=gFYUCgjmrcsOzgMfS!h8>0$LJ1glT`r?e2X7DJL~)cn19p&6+C)u zsXh1kny$D~J6s)b%!!2)s(SFewOf=QbKmG!(gFZnIlElQPmNC(Z21 zV!qcTZdflgoBX>0S&UPOg3}RxyQzYcgTVQLm@Bl)3!;UYr*ieG*J%Fm?^Rc-&5NoCk~gUXx5hG7gclIikG%T@Mlx3MXdto$vvK^u!=uE zZghjC%bi+~2WjNojjDH!%%E|D!jiC4nN?28Y#tGL4zoGfTR&5iEQlEKEz?q=g4mKBZ?v;X>r)tvzc z5;39MI(6b(Lcg{28Y?aS{C@JPI}dz@ro4;~=hdEJ#-}YRzTldbj9L0F!0rr?LS^{4 z*t9X)*m(}yd9Vw||2_L6(mA*xrC59}Ls8#@c+&dl=gep~sGhvr!iRns^uOc?u&rOg z-tjJzX_C*-BQEjo5Aj5jc0<1-J3f}?U*XU~b5IMJ)d2ZR>~JU@=XZ{ml1pbZ>`AzZ zzUxJ+dhTzOOr#1^c-_Sf=Bhc=$4eC%-c;~YbV=j=(4WubzDd2j?WySXA?By%XoOww zYp6-4g;(G#BTuS=a1e`GJqN*84Az>NznYZ4W&o}` zIF2Xl3LC+m0YOxf`cSL9QyH84*K0N}a;HWIPkQJ3VLjZj`I|Rk;RRW0Z#CM@VdT~j zS!r^!eO8{8m4n7-jb=vaNXE5P_yfc6{&$zVc<@w}ELrLpbu2?}yF;-N1~nl+SRj|? zO_VA$GD_vB`6k+Ky_z3cj(WBAXSD5_%_k4}tW*loT~3KZyY~d1h^BMH|D01mxZ3pZ zb-lGdr>s+z?4Lm}zq7JteCi#iE+2uv8P+_2>l)9y#OE%DEZ$>Dxn@)Ox<0VJG>>pz?JM3fFC4+_bkd z)@26tV=28^hz`>!feL8nVTj9h8mTTZ6x)+}oOtspK-FZLoA|xz(X_C3BzS*3Ub=3a zJ>bWNmNo}`-Re2O1b(Fgn5}z9>8tNA?gZPw<4$3Rc}`(WFSrNz1Rud$Y78e)Dcjjd z2|0iB2C?dXo4f9eZ;hL}g1R8}+MWwe$93;JfsV3^-@o9) z>{O-Q2OCTVcPfy+gtzfKKkJqhmTOp^^%~!W-o_>C znUxB?;|6Ohh32S&??PH_GFgH`Bdyx4oB_6XhGnGz7hbFYrHz>#s21;H@E2ay5jZeC z`><7_@%EiGj{HEMjSMRM^JBs|5GSuR=((g$*J$;HEo!*Wb;X7e7OvDR*IMn|6dJ&! zl+anPG-U+iy?H^;HM40E>9aIk`+kNq?$G-Z3gOpMm_VzDzHhv=MVQQ z3+u!`5JDBWAXby1@9rj6a3=!bvv*ikPPq&b&WY_Y$$OW&2H<5QJviT%ZBKDajk&S; zXS*_l#TYXwM}7YrtWdx^tz~=^jC#NIOQ7|~hEeHuP93?;Jk8}9hW1lGZc%-k6J_!3 z%BE*mY!x-FbdJCL8$7z%;cc+03Nm%!Z19-od&?8j6|T#nAA7yMH(mT|C@Kv`Ovjo2 zK;%Btmx)S7O8$$RCzyf%}Gc| zeI(~pKX_743@F9yFbnoWv9@+z6oB8-4n=cX^-Jr9@Xm+|2%duM^W4c*%{_W-xK-%! z_Xlv7v4I)1a&4Kzt9d9qHw zBO}_K!qn=8%8N3i-9fF~Ny7`O@lHWpnQXZEDjh;C%q5o6WnnV)L$T{+Msfb8J-9h( z+WIc5NI|g1zWlN&0sQn@Emy|hUS)*otCjjx>7~k~`!1&g;P3hjN3SLIuC!Pzb*A6{ z6WJTG8Z+l>CD2OmHop^oHJW*Ac1^{>`<9`p*4~;oEY$@{8l%nJgf1^@y+%e+?m|y~ z-WR$~s-=nBjE;BDMu1XLa5j7jqPMIpjOk894rE;2J11V&W4t>E;h& zB+y-?*D_VNbQ0ix5`igeTWn4)p3Ddg@ck9MwI&+ra%XoS&lPs!eH1l!ZBgfEik$cE zdy%QtI*R)FPk&p&nwR?3z7++Az*W1XATbLQlpPbcShVP-lP`9iKDezCv|&G0>GP;T zrXo@1lJ`&bFpZ?CR0nF#cWomL%pl=QdBu#SLb%_)nx74_g0*p1r?IUcfrlsH2VB6jQXh?TI++qjqJ9$F`IoGkS<_}E(h$5&%ojx9M>#-Fy< zSA+LB9y4{vz;gw<5=y^<9LTw<6*8pzb%a~NyO@IIXYa+M>T;XhE(VU&k%An}Q+?|Q zU(T-iq>apaD%@e6B^$>FmKHQ ztCLWCO8K+%!>>Y;78MqTKePf^?%7`BBJI0eUXVR;H6?xf4l?k#NtEw&Fylb{<9pXt z_L3_0HWtNxkBMawtDXbNyL3pZ5oJiage|9Eqx5t4me?kkwEv_nc*DNVTXk)iHW4|| z`m%iH7s)01;*@tR{MeLNk9Q=C<*ntq3@dFk2P^wy#Lr;&C)KaIqG4YXaNKZac^Dhq zmQpr#zXB*83V`nYGNjuL9NQVp{QhEh_Oi=PIX^!#yFnp z*(Ht1-^~AG>5J?~zGV0>efGB>n$AAS1)pjjspwY*T%PlvWah`FU>9=l0=*II#&38| zso!a8J@ojL$I%qJ*{|tGkA*0vgGe>Yxae8=&)2hci-A$ zOJ#eugD^zdRjY?xhd9%z&s@FO_cp-3Z0(~er#OUdG$=%3{h{*{lQp3YpVe(c`~A9# z(5jma(cuCum3=&?X==ppYUP!cgn*INy8S>OF9aC@IOsT7T zKj{a5|+wpX)=<@ux9+jXGR>Qj7b3B>5O5g9+V3cCqB(8Ge9|^}hEai1QN&cI0r=_FZHcX3CeQnt7Qfyz~}a zS375_Sf9+CQm3e<`LFf)YcH!+u5mi9cZvmaz0Js8*!ao#uDWWi38Hq? z|3|mW@k?Pl#}<{i6Ed1%1l?KCoWKY6^uPR#qXGOXbwCqb`jtq(u$F0x`iV8-?ihje z0A---Z@s)6HS%>*6{)h(C=A>qnn`>MTylNK zG9Pr zPg?gX{XD!TO!ICkUya(@Ikez;mm&4m;gIYH5hOUxA+1Fcy3W(CoQ7S8gy~a>tOYPP zC-$^HK-qgWqZAHlLxM<&q;E$wIr4>P<%^VK-XB|LKG;vD|_J zy$B!17N9crDNdrTOO;*f1y8_xbWdsTr4{yMh2v(wEH#E&$v?>V!@LMXD_&_hrCWK6 zg*zqod7G1%R1;Ge?F}Hi9T~Ts$amSKvZ}W3-lhh6=&T|QpUvpGA|VIFA)SHB~O>4LwMD_2W*6-_SYIo^tnI?UartkV%-T7#QFeU|6QXQ|p^k>L2#W;% zfW)=6-ac!;GD&Cut&|5vdjRhY1?C;`4=IPE6*cYujyw!ECc&xd3= zkjdBVh=fvPp*i(yTuD9K-^%%z!?t-{o@4)%cUT1nP+!gI@Z?e7;0X51wDJCzCve>P z=0)k0Qz4iDKhSgA6l?t6zQs0B7R@=#ANYDRNb(F6X z%Q+XlXzmM=uABp|SkAn95YEF7EvP3gcx=4^$6xUM`Hy(@IOPge%$gOuf^!lvN#6Rd zBmZ4zdi<@ou@Lp(_I(i zp|;fgbB=NEv~C6CP(SBN(yX!54RKfxy~NTFbL6_%fIXzvu~TvIe+1fxd(M#=2x$Zv zm)R{R81KpssxHkx|Iy&vPr5)Gzoq9SP!nf{zI*6Peg>Y+^#5v(9C&Wmb2TG9x2qOa zM^t9Z&_U!V%`+ikh@U=K)u+;95o26WhS3!MbPBtU%GYmR9x-D`*esU^hqd=Q(oIhZ z?7Q{nPTM<%<)z}wxm}M8q<%^03W8)7$M-F9=P#f`o7aCw#uppdwpQ*p>tV1QmqXsI$z5Pvu-ZR$r-s2FZRz+c zqlGKlO(5Lr?l^P?fZK{NhG|4UG@cSYDb5xsB5v-mS4L_pJr~M`pOm&~Gl1q)1{;4^Be-aA27pSE2sq{5`Sp*e54 zo?aF{pQVJW!u3y|}`Ei*>xoo%gdsg=ss8VVoWoOFCH zY5NMz>b+VVILcVU#Y#eUHT!+42&?z^vVSYNhsQtLt-OS)q0p~_mDznF1NCl_O|4$F zznu}W*wb`eVI_QH=KGJ(k2L@F7n#xMOtrdVfQjCOsU3Q+2Cb2qTBreHc?{`=EgRg% zXyijuwQEl8(bVnWpEh}G4iQ>MDP6U6))(xoRB4#cA-usv-LF+65@=vNox zg93e(cGHc{s3>luEdrmBmxj%Zvl?Qs3YrgWi zb-O1*9HS86wHGMPIyj49*6WXFpN(YHVnLMsN61*g?u1W21PxR;Y5rmkjqgPa7PiqV z&dI1zDWEmp-*(#jqVFh;B)M5UN}IP%v+LMQjoN*$hoBW%Z2wNpqxWcY1#O-Pu4B4K zw~Ch7M=1C2rw6;Oj^$Po!EG^iGf_H+;At2rt)7q@W^@-HrZf7MaqUrqW5kF>o=dH7 zKQ?2}x~E~+w$OSs1~SuFako|It`4|D?xI8KJUST?BEgC8Zi`MD&Lb_Vw1oWZxhu8L zd9yZi$I2UoF;5nulthgNL5)~Gj zzmXkQF!A%xS!9$7u=c&sl2GHKa!SM@;k{v=rJ7nCbxJJ^mEVZQJ#$VnZntMs1B$)qEOp`3 zB`*v(CZhQBN>cJyhNS%`c4`(f`h?gx60%|FW;07DJ%>-jqCz;On9<1??6i#75P!wm zNCJr54ahbLn(AxY`dPI zO-a#%4(-k@7e2$#)3#Ky%%UIk!qwV%=28}Zd9JXmOL9B9L@G5HsbD|!tG~8S#Y|F1 zYGR`%H^j(!#y6raZRkQrE#V#v{;HRdQA1;yq9jrAZj^!{oG`q8=Yom4bY6hjoz#MD zP43d)-ZgGGeHUL}mfEoa8gxCBe~7M$pHv+GO0vS8gSUL33?ap2rvgh}#y zbY>V$87o3Qi^QiZCK7yo}2WOIb{Pw%enT<@OCe z${;@vj4&U@+!=R&s~ri(EWCVgpFZ}$ZaO|twLI_%O5C9MG~umxymN#HwtU+A9=Z8? z?-^eg(p!uDT8+XU?Z;3qJ*N1~m~}DL;|gWxdSF3UYOHHHdYkmoW9H{%O2%`{uhJQ;p#+2x5FBSEs-yJG6 z9d|G5+Z$kvWxAs>y|s@~Z>t!xf|+;RWyeR29>C(Pklz{CSJP>?RDPY|r~%4|b$- z1A{3Ft{RO5>yt^Ixc-6VQ(okmH{Uh1t|W-$#;|e<`fq~40a7r&A+tuxzSUG`x)S;u$C2%N)7qd^Q+HIwd$>WZ|K;XLVJ9Np(U4 zahK7@s}u{1%h2}hatm*z2EO*3aSQUYUnnv{<%`}P<$Yhat!{;ptxlQaHgx;)GO?aG zY4Z881yvBzvMAPtjb^0jj$7`0|Ik?&<7h#Rt=?6Cy2TUAKLHs?A;cDLN8~|<8zvLs z*>&Rjr3C-xd-T+%CwN~sAK$X;VkB4j2gphno&{x1=$(kNACa3~QaKP&Z7I9$YrZY# zcU!gk6=m~R*B?Jm3KDd9{x)2J$`0`o%ZnOl^DY8c^lN`6x%M(dG^J}9rUbjc1afyY zFI;Qd{^>uMsUet}ab*}Y$Cxq|VfnQ_iHhB}Y_W>?ZjxVF^YrRQZ_B<7FD=8R09-f3 zir36vge41EUvKO4gH(&$J2o&M|JQD7qwZ}buIxLw(1bSCB-km__18bsH`%|I_zRRd zO9G4iDCV7PW;x)?uwd+KNLqik%;Uvk4JD}_YwDo8d% z=6laC0_@>s)H)YnSiX_1hB{mSM&zDyA_0c*u@pM?foBmE1+Xq-?;Jz6`f$x&IFP!0DM(WH!J-LE$0Wv{k zS$Ae=4cnC@%a3Jz$Y!F-R;1H4U*TH{%ZFLJ>iUh(JMyk!AFOOHxw|b^-pN|zu-|~? zB^a`D%_@*&+Cm%%l6vuUZhKeY;U37UZuY_g*Lj z=2p`=+Fl3G)F52GSt^xjRGw43?-;Q&3@-@kwC`z;(O4a-ag#uV^ltt3FR;07wzZ^- zY5!)Md9ZkKOAzp|(>1Jtq){KcV1ONcrO#f)#Lt}FURNmKQPim{U0Fh{>ANa`qP_#4 zR|M75+;mfXU&TSo@jI5Ac|LzM#cQV(?3nX$LPkX*MOBKcPhN()@9N7kIuHe(7mZ0l4OY z%e%lUYD8ya;?naIpDlxjLM>)~)xYY7=52Zs|4k2XtR=^>Jpo9Igb^|P7d){ns&4Ve zsm=(7Q_n=4&A@vXGX#H-Z%dFYr&2Lm>*V~6hRaGAM({p;a$!&Az2<5d|H4QsrcWo) zDbK3w6=~WpR9qd8R!C3W+7S0}^cvc+Zb_k@%iIl`M*99Ik2H@vU4Jy$^&`;P%%;$c zJ!vRNtu8DkBGuDT*Mg@{JwYUpoF1R<;+K{NCL1(hL~m%(e&0i&J53MF*N%GJ-V0nh z#Bl3XUl7jaVh3CB}QL1IS=t+%KebC zR8}k77r`lO7Erl_rSc>BADyHLwE=%S2nZPulCFT$U6~vEQh@9m-HQlc>za zrt0lh(#JEYU|*>;p+oQ}Z`|DJy|Yk}U`x_qmHhIK=Sw-b$Y@-ikkjc74=g7i@+bdI zig=Eoka|hWN_9n3Wn2>=fQW>n4aL@L?GyBY$RM-Ph7s_6h-6->M%UY2KSy6jXSX=z zPMNwz2ipc#?7^b62&!qg(p4WUNw`V+52e6ao=Jd|?h_}F(;W$B$FS4)D`*DyK(@ES zufsT(y1A;EcstqPm@#)ddNDlXx}NjuB&OkYT2QKIS9e!#*5&z^Hv;j9m9;4vEG-+`wl#R|_6n~f2O_cdg97> zZeXFOHCJsV!_VIUUcY?!MBMA|?m(wE8eVqKH3Yn)+wH)RZe1uv+pWzT_(Gj-A^ml@ z!Ab+Msd|3qnF+Ij|H6AsFfzyg9kOcsPDRYK5!z7nLO#+LX=tdiTD^A9BCc0udzUN} zH2SxY?zvJ>!7y@@>Ivf}P9m+D64dinTzX;++ozf>vCw_w#n1KP_zU;GXsBwCw8{@x z2O|`A)tn7Z*|_-XoMcrWNaifqQmd5tsSY9GB4b@$#-M?ej=3`8T%SI!O$cB@LM0bF zQl34P%YHp_zN^{GszCDZH-=gS)Ogxl8SpOQl|p4>tCv+n{-(`VAsHQ4i#uG!5fGPA zZUQP8d#t4ANUR^Hg_->>irDLpL!$)_zC=J!8GV1=#zO(08m#F3+R_s}< zv=uiPO#pax+1CDEDvAGeO)ajAaTGA>!e;nhcot5*1;GrXAb~y{i9JUAyVeVLFOr*@ zMa;b0#wWwN=7;N_b-TQ49cJC|62TuXhxpia|6Me>{MnZX9Psr2J_jSdtnIKJ$vjQKl0C+!s{Gwv|F)zbJ4~lN_ z98zOnYAy#tKtNw zbTLNgf66b1oe+~Er;mwyT{APyE@*pMRcIEF?PB}!t)m^SKeVk_H*;6$f)+9oD825L z)*z$EqgnY6{*MLZ1M(05j8eJ1QdJ|npeMGIRPNQTl|nMGDqJZqE5ehXJ0S-!o?k;ZntXBagJbhk_6$Vo8OLp#-|5~^$dvm`x%9k(Z- zJzJ&Y;ytBYN9P_q_#u3TyZ>X3{0j@?o@^M6%lQ(mmQhgqZ{d#<&*$TGNB66xl8n=F z!zx)~yj#L`;Msti5TN^t*m8}Dyj=c#ajdWL?f;0))7@Q{U+Ja|f^^sJ;jMP*RM-hC z_HWU4IvL(`iv9moA{7&nE%(rdyrSb~I2r{V3Us$3T=fX^u*%sbTHpQ`YuY>OnWkA` ze?I)UQx(VQN=pbwcFlKNxJ&i_t;TcW#J_<7KOE!mUk3jF?(SMKfq6B0?^5*sGjG={ z?+q}0%tfmy6R8QG+N1t?vf^zlqMbzsJU*uj-rJgsYU(@DRf3yK_%~``-9EmOD-bD*}q$G;fBtoC4@i*d>c_XWkhof<0ir@7y74s`xor(K9g z#*q^0LH+!Bz{3z~4n8F2cV(B=0an7Y0{d%m5_sQyt=ykmBmSQYv zxhc#!b|nRy!F-jt{#q>+sqyz=7G9@$;y+-d@l%40UrQnoF#C$O#C zJF786N#1Qw<8iqNW}4%K$f?~DH7G)_=HUQ$VXikt9f#T+WTBSb4xXi*#5H}Ljo`dk zR1L!Q3WBR5N3{HGVf}*Gcf5H)0_uUR_7JzExRr|NcWGI)f@F7H1pYq#i3BFnq!0(% zlW5|H^VP+%-bYQ|+RyTDspQRh$0Ghui^t&{4+WII`$_u#|{4%OuO5 zpHCzuC@{A&c}V0kC)119u_0QX^ zi@7ZRLwHz7Dkx)W0u}c(;?=G%Hh6-pK$v-j<$T&$9cRp7T~55sV_u8dGl#MX zhHU%}rzjUhe|ZU)Pup875S-s)ebJ|H&?om9*-=5#!O)Q7Cj#)Ep}s@PpMf z3XfHj$NMQ|RyqvN-Wu3e(c?eJZgM=A|DeJhu83%#Toeu8IF_NZHorMs7w_)- zC0H&12P)X=Oq&|)TfWj(&C$V~zhW?Zw*~M@wPzFB+T6H#46(#=tQWsHZO>ycigy32 zJr;{3El7yf3GGW*$Ge}9h3WWM7WzN>^pbp>@>S_ya6ic5aNgs!r)6~CN)8_JU7&K(o9Lux102~Ir z?6||J?pbVj$P%m^E#&l6hO~#aNZTA7j*Z@&491hsDMs8(>c{Wq%~WlFj$MUT#LSTu z?O|PNFwgSh6yZNq8xN=+UppSs6P-$J6r7m?kX+I#rddFLx?d$B?pPX-Bt8&vc#R*x zef&BAbOmS}XQnH=^qM21j0K#1|?MFK2~soui6DnKNb6`=!|CNE(DG*MPsY zl;s#iAZsW_yixGYJa7zD85SGbobdnI-!>fmOA>|0@IW}Ah<~N>#1*zjBIoTcycIb7 zwgByv9vNp25M>?}gOEzJ+wLbB)6+*XC(P}djj(C&<47m=*R}+p0P9>;JTHWf=i0fO<^Qs-(sl#{{)wz_b_=a`_NvVen#_L zfN-4MUHcvUo-auIA18@t(+uQ-cZ+Au20x=V+z#LxV`U!S&0l;_&EGVKHSeZy;YYCj-Yjr88T3w9F?`? zu5{8zw`O}Q@l8y`0W!Xcg>Ta}c*0iyUR~ean$kgtU76k)x$!vYgzCaET~b!ea+=%P zyzu4d_j5<1jW3Y|28M2(|H!peX;MH}2EDHjXNs{u1iaTZW91FJn&Z-Gy05}$?#ay? z zSl#4Lsdi=3a=RaU_mr@PfscP$L)HUo{lNxEXRYp3*2kQCLC+>e+PUG6!%nEL^ArWM zYcCK3t@89!`g(t@$;=*4W_v1f+FaZcLOXJ!lvVOKQMqXO zi~G&WYO(MB)-)Ycw{W5_t!1x44DnOGh$^^CQCqa$_8B_9v>fl~*isgYIXco7tk1Dz zl%s!F<9e!Mk3={Ig%)cY(@JHN&4KoGp?6~7d$-W6V?Xq=h_-u}{r6;4R#QFbvp&;w zK&0KgTw*m_Ir@D49N)SIR#$qB>oBi6$K%pvOAT|0fDf=*7j$yf2w8fezDHyZls%ss znlJ#nvLGcj)6dw!Qr%d5C9}54Oay^U#gfH>R*sJpRx}$quz!heYGljSpS=lNwcJde zl?fPbj_UeYnJYuPr<{6oZxYL4+S%=r+SkqUVnhc{yof}RGMhW7;vk^ep0b0CQ@LXH z_fi@g`uyMdQ;Q0#L3npWvm0&rjG8|!Jq?Omw_P8$Y~wo2_9P<1Y<9dn!HiS<1oDJQ zyt{piD?&WMxTixd?FXo0_yNpZs?Z#^Irus@dgtsSA-bPX=D2~44&*9`hO-W&y0ND@ z+teJDr3p^>(Mpli`ul%fSQ)X<#pHh$p7%|C`8rrtF1y7gn;Y)^bzU{P=_nB$q*}KK z%bQ|78FggIwCW&|it9y92b%Ax`~^D_{d42{Uk!A?k#Zf~hf#t@DBGv*0Q03E;RM#2 zsajU3rhUZc)?NS57<#$CjZP?oCUR8+nGe;IBH7h-Y8Cpln+IGdoS$@WGd$JZT6pQ| z{iLzsi%%@T&f{E4O_dXxKs1?ta9$+Z~g5bH|Jp^Rl3Dv$Z$%JrCU zGGmSO#0RNt(&fN^o1~>j2R6m)obptyiqB)40&55Hh zDs}2OF39OsgRq!r?zLgr^Qe#O!a=Q)J3@jd-Bd#HuzOK?Ehk*=SV`eoMxyzY#bY?P zrp*G&r-%F#<_f5<3kSeYg#19y+9Vn=M)%8=QHXpJfAr6M_V~+d+&jQ$>p~g;*|oDt z)^X{Y#BnnNh~GPJiz^i|m^In9J`LNfftynYaj_I4c%g1A;t6-P$y7O!OPdKzxmylW z1!PUwTC-0#hLd^K3k0>(&HOrL(*D8~jiv@oZ-f))&|eNx73rbDM5N^>To1sV(UNBZ zX1pz`R+;T)w22+CrJ;-5nQ!qY`!%@~^0B`Fypz=RBIjD%#>Abz)OOZacIZ&Rx2(qd zwCeb~3#J9cZpA0Q8)_&7(}NHjebl7fBqEY!XsnZ-6?^mWgRZf{j#lP-le>D#jsH34 z_%%_5A~2_=j>H3k4QvIdwEepAG)OcIJd+=L$`nvyVH*DzDpTM}65fZ?5B3rjn0%^M`Hf_L6`134I0>uxP4&W)+8tjsU8kQq$*V+(rW+#DG4|t3PGip1Q?`AmnMo3lp-CZgbq>?44||i z-S1`Q-nsMr_3;VkJ$0|O*Is)RmZ=Rf3i%gyzzg18JNyf9{1>PIE2w}F$Ftxs`lbwo zY&rZq+{RV(k_Apdz}<{7p2b}1Z?qyKs_j_wg^uX5JY$ErHfqd_n?&YbnJa>z}U(3#B4f-gj=)aS^o0h}nL)U*=eS;%lX4?W6(uMQj&@~w- z_OI?5Clt&ndb`hBe6dHe3bAb0=z`wp-u)Hh?VyTzCHbr*=(Kf1d#Rcj5 z73QEAqr=r(vso2j;^h+jMd%yZPp^f~xW2}}6_o$e{)jfq8pe9^UT+wEa8Xq`ISOnR0~ z@j?CBODT zSt3^?F6YJf{3tx2Zm!|@>%+#qrPagpCWlKx#XDxNV)jEib77aRPLk`_o^L$lS}3a+ zA4r}5S(uB24cEqh2&kWr858~Lml(Xd%MwZ?T>6+WyU7F4TUKu(KE1~_( zk!qnx(>``k7o?Bnv5X3$S^d;_KVsr?{(hweJUlj+<;9OYC7S+CaT(J$ zkK8sUNrzR_yC1hGne8Go*ZD@smBoc$AGK&kc+~FWg&fM7R)3aRW*?}OjAZZ5k5Jf; z_eLnsbhM^hhZ2q#_r&GgHeWRt4DR{i9fE&T_T;iwrjp1F81$N>=Gwkt^9;&Et33%8 zcl>PRlgjKyGST^XCBP7Mku2v{zV~yIPhS6b{EqUAykGSj9H{1CU?(j5*K&0fj{k#{ z69hCiemNX%O}mrL5~k%@vK}D{S$3-^ool`TF?A{tVnhKM;O`Q<9$;@AEPhcaW-)xQ z>xnWIYPK(4F=#T+-pbz(4^W*OKXf>HtV@U)FTQU{#{C zeQre`vk%?>`j8dcP@?0)%^m!U}zj zux{mAFLk2G+DIy@v~9LuukXm|%UnaANBwvtdEu7;o5ra*_}S%F;< z#ty`0hpp4>y=P>uWrw$O-?Y3$mp=?n7%#@k1VW6c`Sv+C+1duKHQ8nxPHAg!txwTQ z9TtSvN0}ao+B_P18c0)Lvia`T^nQ@l(9gZ^@wvq%RDol?{+o-DVa@_)*q45-}Bm8vz5a9?NeT z^T)q?l((cNDGTii1wA4unMYI)2{%vs+%*7~+*j^jw*5>M(fN(a9ivj;;G*rY72jtw zBaeTjAL|$N#uAAQIu$d&S6T3hb+i0GeopLf>7+E!D|r7@`PgR>Us0SY`V1C#cvK_S zc``+Fd;2Ti<^O$}wdDr(%H%@y7;wfB`&A?t#fO+anUj-AZ0VJKGEh;+u%i;PqMj@9!IbL z^jfffvVU8seXX}T-E1wROhvI-2DLmp<3*~%3T0X~%aA1}C@AcLn&0#;un%%>EU}@- zv$sRBd(Ri7{Y!oLe;o{yMt%!5ZlJ!#53ZyJTtRUkTJ?um!V+$Ib+;&tIEaqQo@{u& zV0-G;Pc8KTOI@W<-GNviK!oYB9=3a~0|+6>Yy%DZgw#@e!;$lzhOZU~0WKt%)PK?} z^2|*NFMBf2m{BtXAkFl;td-*fRC?&zP)uET%@^)|)_k4O(C9C3jyBi=VUZgh4P`@b zKJT+XdRa26R+6Qc*M@d+j%dWREqw7An9dw0!JrX|fyr&TLjkkaHA%7Nv2OPv)i`*8xBozz#egVMVHct)-)K-Llbe~;E3c+A8bE(FE;Nv&q@jLcLzwP}xN`EeA{X_%RF8Z_Hp3ZL8 zrsbo&<3sgwYG!p~M6`5*rhTH_#H;y+H5@q@_bejXFJ3hvpNGq$+>Pk79BPbn`1%@l zKVHBlZ>F&zioDq1Eo~g4<+Bs}^>?f5q-#t_94@ge1nW_LJF?G%b%a=hojz1^!WjZz z$`bGZAl%I6LcZrWyDobkwL2X5ssxDXJnCQ{#-Qkzd*;R?Uc!kC@;$!k2ovdSzl%z< zV#Z4>I2m&(>|4sPj`os~jqOrTNc6A4akR_r53hy}XtIvy$l_{yI!7~^sM9|5-$uD2 zUmy)-t-NoQ&4vX>^H}fk1}`i(`(5Nly$Bv7XEr^m-G6xODR73YxW`LQ{8dkr`fRHN z_xX^-J&X9fxBPM3+e3Ob_;X;~0x9B|%sy*-?X!-z3I*nI)0r-)Qhwqi%HhCkSk7B7 zPx~WPdt|h9dLsFK*_7)c)%NF5>{z^y{+P4iY632?3Vx$Qp7>B_usuhy+@jB-IQ5DD z`rT#hY=#~%8E{(sq0`{i7^5Z)$>W=x5u}$y!{|OqLhLDE9` z7^9I>mn`}MnZ!_rpl+TD+bD~Xs*At1HI&w`>?QbG#}8$ChJ9W$KNgClIm;hzN|_yb z=)-ekDR_@PWP@H|Sj{7Bk0n9Iw%wwSC5{OiIB9FrSr$;LJ-lM6VO()adHhY24b{+Q{?}l76uJDS&z~;G z9YIVeo}tCPWS<;Uq*r0lbKj3ju1SdCXA|FcLG`At8a2SPH9GISKGmW(*Fd|xD7pC) zs30wiSRIK`%h@|A68LEqs}Z?hHKLU2pe+=@1}@BUs+ng(L!Lx^K6EsVGU?(yZF5Qk zbCZz7ZQ!K%RP4oTIqEdCMEFFRcRg2LW9wR89>mz=ngBT19<-F)5I=H6$BfW^67nZ9 zqa^SFaOcg5te5@;$?(9>^wu{Ww2v$?2#wPcMtiu46C_oK)7g<{QIloVhMej^?e+jW z+9blg$5%0bS}Ki`rBlX8JD{vqiq*3*Dl3jGv~CSOf%+48Ju3dfchE6LsL z4O7!;ue>5KWLs7}Iv6buGKp^0dq-;wCYmp=g2_xdTytSR8MG&&n=)#dgH6`M4*iec zzjpa~*taj`!h{2YQRBybBdq;i7=yXNsp;eZW;Ok)Vz`Iqi4Ky zn)h3@eSxUa*lws)b>aYcnBz@-QjT{uS@4Qy7QZ)J2?35i> zxh65oqwVH>+hSUIAb%*GEfa7$vHN@ArzR(J<87@P%Cwgh+&+p4E)wCd9 z^{4e$P=+7AT0oY}*)igd?@paO-Wmw;*~Ct>mAfO4Hec2gTl{-e#*#cLC4WMIPc>%J z*f@#Mo7grquA=Wx9vR0TyIlCF`rd|Aj1AtYJ^v=Tm!+Vy!N{VI8-OHHT%Is>e z{Q95F2fzV{%kzNeFbo+sD@h^Cv@~b-sw0ZaJ!uq&h0vU~Y_N!Sv-)NSzzK)}V`Qlr z5@pBUzkVTvTh^nzrNEZvRs&!NsUhks$fqHlGrm`^EqCx;(;>5hiD*xb_4pE)FY7I8 zcze`C6e3Bm1{CWhT6yz+Z7<5XmE`Ck z#|t~3_2xp3I)2~;H1<@^H)+KB@kYnQzCqsszJ7_%vr8Ov@~*f%Hacvj`PoZ;>hY(? z1?w~NkeH|&<#K^(zj?oDpr$2P_Dk3ghOds9Ywfv;iqHIOjk(lm>CrU0po3EHtMVpV z8|Xjg$C=e7XwDF%4qBPDGyF!gdAZT51CYruF|q&nd5F?>L{ z(Do?-Lr51F^!BbU^f!@a7PtXwIdD`!8}=(#lBD@OTJ^$kQ--5yWf|3=*$<64y{b7D`a+ z=H6CnEfE3GD4Fl*GX{|-N7{(a=w#cYjqtAIsqXjMwwfQs-d&qGXTp5FxR9Ot#zVL| z1pQQd*wj)paPZmezh=M;1cHOII4|Xa*}#mI9NmbE1I0~IOm&27JvRiLTi6`Gyty!2 z4HFO8+%xhg+w3Pelt&l*b;L6KnX)bhT$_U{2aF=jWYK03`=hB3r9a&br&oShRW4aU zS1v8R)To+4L;$*Hvr!L(rRKpu={o_fU*4>E%o&E+YF^&9f0bJRwpAT zI$_W$XN<@szfMqxCm>JJ3d)g+Y(lNN?Es4o95!Rf$+a!Sp|O$39x>NCcSnhsM#O;3 ziFOrq_Bx0{d$Ztw4ptt6@f-(&19Zi#BH2I~qiCahe+$-3HCt!(RGnS;64AqTFFEY) z8m;*l1aTNOXbGhI0A3VgygA>(@Z7yp5@0H3=zt9_OQ#XJfZ8&4X4W9n_XE{OwvX(E zLS?S}do_7mgflD*FPYGut)UaFL?^$8_ETKm`roeLp~ySyGEt-SdVGql?wR2kan^I` zR&b9K-piJzcUfUBi$x8S|FTurtjMF{Jh>!}&y1{?u4tHujPTHi@ z_pMWLvSG`4=N9M2zzi#Gz*Hh86cpXGx-e$MkASQ)Mg;RLpX9@hS#a+jmS{z}oNQRv zt`o|N7qc}0a1AFnrT-~h>qZ0dG~B=%{`^(m2SqxwoExPBi0q z_>`hsVYa_(ZOLP!9DS3^=`nFe%s6XlJnYwJVzxkl5!fi~?!cYWAiQeuHU5(X{3Q=H zV7)gB~68s~CI6b^G zwF3eN?$v*-0FAE`;9m;hxHfl}-cYU8f1f0CNGwPc^u?0EBv0{p<%%?D!1R$m@Q#d* zXuXRVlZa@$?M89#LOhN5eDqOh*Ognt0}Z=RNSr+@?$9*SB<(x@{};g)As(@x_>)o= zP z*@Maum3{D}(BB|0cSH3+>-V(RQ2G0Xmm?_SFv9~^N<$XkLu|kUV(Z(|V&FBWm7skQ zWlRvQh_d%?vc>b{+%_(uNri9%qR{N&+VEJg2A#rSt4Aq|YH`m^DL}_yJii%z?a}4G z@=sn7?Wl9hmoPy3m@zBnNguGrClAs<2-!pFDLJ_>08e-H{`md1_w9S3`5s-hud(6t z!7`O?!y^cPtCM)D{25Aa%e2XZnw1LY?5f=$rFGo#peR7Ms_Y*lYf7IN=P~rN@FK28 zHM8)c?;oW1T8}apTDH(i@ET1vy$ktLbd1Ysy@x58yXy6fOP!vl25s4AQf&_Eu!7rmPgL*k4{c^Pk~VEOwXJ ziLTv2^(>UCP)^eW|?vAz%4@SGtvbRK2#()B|YmZs7taK(V6j$D0pjlCL+x~3ix2DfLkT!u}KUQFyh>_85}o;9@3@9*cQ zmL~Wi{|H*X8;9#IiX}sT_5ZB%h;L6w)mCf%HY3|Ha7ZLRT23qW>4G(B>1UG5&YmNu zDF^rHA#G9uUH`f=LHdsk9WTGoz2ke`ll~P%(Uo}9x-?;}tE6g-q`hYShUW6Js4zG! z*!sJ}(WJ+go<5M;1}eMpp{`=H?iH8^+dRH~V4N9-D>aALj>gCqB+kycWYO0l=Q6Me zUskGtgi&aJzqhoF4vV)Lc#R7$=SIiIiZTQuvlrT0zu(1%2+7dEX$~6?j#(L}!j!N+ zt8JNw*CzMl1%*TUOq!Lw1!FceIZ9$9P-qu)vh3`Oj9qf$`pc2tGfH2EvB*o_*OQM& zJO*n<`kjZZZJWzkuHrDfLbj{)MJ z+hnIUuJr*K3k*Xbh(U}VJrMDjxeaiH4xPK=c>diPS5g*}Q>TFz{pBKYdubFX(Q@?% zK>qHLRqFRhHs1XW=zi1n{~QvUflgz8!HGSxOnq9i-64>idssgLi|EVLCi3dO*eY8Y zwaeUjUmah8dG`rdaYvDu;@|tey~=1|v@zjq_57VjLw!D9Yt`n*Tnr+0Z&;>3VvXbl zfzfplT<8n_aTq3$in5wpQN;DkjnYQ1Pixk;xo5v_`myh@FIAyZ`$O& zgvHn8`mc6TXCx!PYLmT|)AT#)F0H&cxeI)MpPoR!*LvWYJk^LJ$=YcL&!?~ z+@5VM=tg>IUo=|DUJ1uv{-Hd+T!i?w|z&Mx%8l@5cmL z)!XQ%(HV5M4hP>F3he zw?wSg3kcakQG^#Vjv@nJK&Nv!);Z7|C82f09jZIE`LcS3T^D!n$7SiPRa>wL z)9&7LnES%BI&^jg%}cmRkmC^93|>ng8wf8Za9{ z#1c9;Ks5{hz&%!^Gmv|{-R5U;3--NZtOpYgjupNZ*v0AyP8qJY@TSD(C4jt;Z73G? zhmVc4oA*{b9L9d#nhjHoTwc*ctw5JoL7L!;HhmaFSa#;lRJBETQ^fbiBD*>9hr}YS z$R%w;XNol?;J6{Et3~DWGqX!XuDJ{P&`fAZR+1iSR==Cx_)19lqnZ#JIj8xx{?sX* zvAQ+g)UXv5(i`2$_9?yJGmWOr0%~(gCPFO*g{0u@->;~8N&;VMyn5du{Y+VV29LAO z6>OzXrN!(*{y- zAA-}mBHS4MO0V%^Q0D`@gDHAfY8he{*9S}vKRv`=CF9GmcgPsjRe_HFDwlT#fvYQx zU-tO&>%!tER&rO2VbK>#QrBSl*zhHDyW_k0I~lh-c3WTQTrM#zwfA_VDZ5_des?xX zMuq!2i!6`~H3M)66UY(#T$ml<_#F8`n5IPb?gp%&w?*4VH+IvhD~e+x*$gI8?QB2n z5#brz>E{Lo^H3)kw7(~|Y+V?D(W!6r0LlceF_Lwl_LzShg1^Iii+E9$T ze^ElYV4FXq0O@-pQuaC8gRbDa%eI)Flw9^TVKdpU7#4EyHTKC(hOs&Gr7e!I86 zZSv51FUib#$#=zb$*5|guSI>F7B@%HH#}}r6OMU zm23{BRM@;J%--Y@>JY!?SPD&3K+Oz1{8yyk&mzjiJjQ$-M2}(eT0M2W(or|u!uZaS zs}+BU8&|1G$JrOL3lcFqj}}0NZY61rw?bmu{InNo)r(g!WR4RI>yaaA3kr z(MWOL9InVj^5~<^9#S2T2PCs_7HL7Y|+^G@D zy^t`Og0j&(Ta}@w_Q1Ux<=T;FY%k(z#he|osBx!edhl@4JcH8}?SZL%yt^S?{sewmbB zvEA>7l66Z|y7FMm)2h%6>Wp(Rj5M5iq|;*MS=Ky;+X#q{y~kgnaP(atw|~0;zwy*G z0w~PmDTSW^qv~CijPbzhh&1V6(2zdJ<0nAzc=w&2Ee;L2j(c}bDB5+1H6z>o9CYZ! zID-VOa25N3C+3=ygxbI$;kmGW$a04z=(5&9s~eOu5(7=+SvqG}WqfIEH8C>+%{M2x z8@4$Z@Y4OSQvtBMsLXKwU~N=)f@Mo$!-{o4le$sg)iv9;tq=5lq!dlRcd*o6X0e0T zl^}JP#LCp^3P0NN44Uv_2K77R<~Yho;dr?YcF>j_sI_shY)DY52x1F&x#&JKw?~Kn zL5!Z@{z@V`jD}O6D>O76jHJDlEuLtOEQ#cL?6D>j*7yil@k=T0URFdORiXIS50bj7 zJ%gqc5sRAK816ggj%pG)o;Nv4qcmF&XLs)t)6bmyl}KOiY#xrUUEo(IwXC4)vdL~0 zCEpf4ttd>sqwGyb^qv?t1DiLB#}QP-!2>#%rr~sdV(jZE=*sWvRLHY}vSO=jb+)Qo z(|m|ACkkEGDwnZN7lAX}V0X}Ri(XqHe2f$m+y?@PNVPDk<$BMSbWUQ#zSKn=7fuPQ zhCi3CNPeY?vvFG54E=V<`PAG}U|~=W8_k=kN>OGnkFi92uTYOKgV(4~Jvbheg#0|w z5e)XDRDCvA)X4L!$J4)lwMa;}pV`nm8VX`n;kKB}YzWNOzgQ4mSWw2U<7Xt=F%0># z>z8XSJ5eWKZ0w8&1&eklAM>x7k?yqSSE(kzq*{sCiqM{I-uG-~{ng5fzvAmQJRG!| zNA~^$b;?El#9YRJsMZ{pS=N%=&W&;CX&o$bq)7;gSuRw*6;r<_eaa*$yKG*fn$EXK zuEQkDiMwAa*HS0@{o(#}4ob>*p4l_VTZpgAxSAb97Gua=A^ZZL27OnQpwilF#+$z;s>DIP!DjI5R z&^~bOl*UiuKbicli{J=*vv&1|bvcx{?;@|ipL=um8uG{;5H~X1 zf;m(f_RajhkW}^cI#$s^Gvepnq&L0QL1EE>G{oGmqeW@IwaIST9uAq!&UYAyfGP{5 z#{o(LF>s2F0d`cmJm5d(B|L90rJUibjB6^Y=TK9?t z({g*BiS)6ruiN2Kmt9zuowf33G%7;Rvhyri3@FQK)7-r*4s%8RfHHKn`cd{7n6j2YczgB0@FL{Kzs! z)f_OkZn<26&!Q+*MM_(4fZ}rZwkPX#TLsrK^kntX3QrH^V7OVo)ukbqpmk`|**no& zp5~fO_IA#3I0DM|@Ffz;k1BO2@v6`TJlaQqPoC4|I4_?QhoM7UUTZz&%7=DCi$^gX zv`X1adv)m=(q#6!s4S$_a2ce_C=3_l_LPxoperApV)JfQy`RQ6cPq89mSFP;vFsq+ zU|7ml=cCyq^5%A#oX@<$vSESUKrBq(x}zerOQT<-#oA8<&vz{bse6Ggz%b?sc{$W4m$jewP&|~#;bk|Q8TV3&J;-*sa;T zQPSUftlPL@>`}3VU3h||w0yDF87AzKpc(tJ;vG}`awO}LP`D~GF;B}6G27%MCJ~MAaOG{do-3-Xc#HT$aU+gS-n0PkXHoH%)N{7z-YN9ku3bQn zRz@SPeIdYd&i~7llZ%RZNu4K*y>_e3l6;Mf+X;?vI|qH+wsB8*=^H$m_y-RK2p-kj zN`8jMQGY+J%x5bp%}RTFT)41I;9626`*zpb+$m{PNUhr2@ucCrHG5#y&n}HDRV`b1 z<$lEF7_j72D^)VlM0fs^dN^VdUJwr>r4_L0kC{)S>|bG(7QZiz1;L}q9^DFmG*V-p z4_IUWEDM#%qbJ?bY|2FnHnKh4Q}%iX>-WQ&Iaqz}P>ER63t3UAzO=$|0*0X=8gL7r za7MDi1e#4)^z)}BQXxn2xz(4V5dBN1&Lnds8X(J2YE-^NXpN*!h;kF@O>nYB$Ke=} z=l%4|K_giks1pL1L^PKbFdb;WCc13lJJPk##J)fJXgYdB1~({;rUf|beUk)>{=J1z z3HESbGjHv)xqe?NRQ(48w_fVhaT*A9tq%3^48P=3tGXqiFf4HKZzCw)<>eMGG{+f6 zDKHI~5sl!j1X-WI0%D6wrT65M=S*Vs&w#Elyxiv)DSgG{_;iE^!dtiaCoZ&&$yUB0 zUGqVX50X+&&y9iD^hayodRjwaYZQRxYUJ0jht}kH9!yRjW@5Me*1lOG z>M>pZL}6s2*@E)gc5Z}L47I=1-4mby?>itxcfYAGGBOM5mH2gI{izO!WjELTw#e{1)mt`r%Ln#Wbc@^!?_r^LFzuGFx4&2bn zp_u}Q^6m&WXMvR~&;ZM&Lb%iexc799O~dalpMj#XHmv>NmN;=NQ`$oCh(0+fm=Y^u zPqtQAyyw7i15Wi^Xvh@0qNB?P-O$^i4qE&ilabS9*TkMA+{s~3>YFUO&w{hS>+TTcUj(9O2` z3Op?=8+WKUy8?AJ5LinKoA_!ZWGB99N?cVd8DHfpX`~o`^q0mT?+ZaGUv9A+{BO+0 zx-@6cfKIV%y*us^awdE;V-f?=*FEF*eQPW`F?Md%^nrtdA4_{rRcnnONE9i}zOm|| zy*SJ)2%A^0QDQ^&9!>al7FYTIFlV2-I`>?74E(K7sQbn4w%u>BNY<|>iOwe-jfxr| zoV$36_Vz`F2Gz}&4Z5s-9)ub(z_#b(WI@A9)|JX0qC_$`f4>}AIJ=}Sp`3RQ_RxJO zlG3L*@a|FT32OHwj_ z9o`a6xNLH{ao-X16qFyGU(@SVEaasiP6atb^{8)#y6~Iw4Dkj{aAJ^A>-{h8m~{0C zG<0Ii1#UC;93+wYLOsS~A&C&1F5S@%-`X?SBElBcVL{kro{3F&r$)RN-IYm8I? zN@;-%r1RPdK?4HQh!Zf5(c$1Hj=GMb!sqLvv8pK=BQDq7WaiA^^xCv}Y0%-sm?|eM zR4(nN4OLu~<`xBbhBt<}^fKoIO4K37w9Sl<{aK+817&=m^=jGo1^7F<8e#T*3=gum zBz%V(x&md!Oh-fJzRCL!8m044M;Zo$8;sxjzk!nTszd`wV>^6M=?j|!o;ku|?k$9#AT^)OMc#ddPJY!x z(As#~tV2C2CyYf>2l-MQ%ZVvO(E_%;j#I?i!;z2+N|9yvop5q?=gMyT!)vOz31p=4 zD0Lwi7E~7M)U}w;T3r#0v!aZ>!Bqt|S!8z@P^fJromNx(2_-N12 zo{Q3&yO3(e4{EV|A+o%@Uvs431>y8>>!)*?NMhK%_uQ>}ZtMqnpY{@j&xsB@-c$XD z#6)_Guz0^ty5g3|li>MH_2Nh-Eej%I<8^twnYvJPUt~tTBkLCLt=jLwn<0kbMR~W# zNei!K0o(srWai|=RxS#!tGX>>gao=mMI&`eLtJI=!aBC|@bBQN91~bm!C(KVC&&;u zSXuWj`?_xw3qnLs4}1y2mONtAD15QL5DxR0?DfzYHDfu-lI=eVdS}|Is5l!9Z(~#G3dy zw1xOG$Pfh8jd6?$Z@KpPG_?bAw(gmW!`yWTisaC>Z1sx9*{GMor)bm=TnBtHK|9|K zg!W%m)8a3}@Ja&W12H27C?KTSff-R?-cB%~)s?Wel|KTt%}GxGWSXP zP^9}+?h@=#7)vKe@~E?T#qI;!|HcE*HU6~pQJh_f%THoyMWm$Z2{}d^kkc*C_bdBV zQ_VgIKRtd1#(y!mgEW!jamo(eA4vH%8OB>a;pb+>PhFK3OGvea^uNkV(CoD$GZZcG zNFe*TOm1XhH9HCxEclO#h#|sfrNzC5%}7~;3D!{&qk%&zBd`%$^i8`=Z=+&E zO)roH(p|PE!L}Cp?~J_?jm@d^Y2kCamFFut!se{crrp1O<3;Wc3qP8T>J`_1&p^}h zQ;Np?(|fja*B40e-0Xc)nyRdx8K1${m+;%LPrNo09s|{9I#A`wm%Dm0{k4A#w^s#J zxd}1GkuPSK_-ZF5DjrZ$F>tErIWJF)URfF?^tRm7`wk{=jx!S5^R*mGYWgipDr?y7 zqW>+0Qi9eXzz7gCgpmL-adZGdUd-9D+t$qGYOiwXYbikZx+bm(_Z$s1`42fD=itp} zM7c6oCg1uO$vL;vwktoR=9bZG8B~$pOpd0ZlC2ack#WQ*bvuUr;`p~YFM@EXQz=e0 zo7dTJqC4RBsfylc)bFIs@H&wEL8zCB{_GUK-BdHM=A{|ZIrtXpjljV_yT5}SFEapQ z0MQgcMHr-w5L_!=M^kFa-xHEgam40a{^*1`OF~Nrm*pFQYNh&Jxh zJ1aEM3~tp)BjP@r=6n+U~#aHrgIqT3(a8IUF@6?ABKX z2vIkvgH4-l+Uk(otD@Kcl)+Z`4O_uJ*os7YdweUPy|XiZTS!-bk2leFT+(tw@ko9z z)ClPnIH=!Hx#?jzkI`J~o^D|FYmi;aYsN;0qvbpDk)0jMJH<4Nm_8o4YDL2j{)GJO+kWW0%G3WRk4Xcu&JM_kD zry;vZQ#GSEXUeg#B&!8^K*t|g3V-{Nj5oe-lBeCT(AEk=c`Cw+tkM_qjE({hG&4}T zAFgDfO#a1 zDmhoiA1vogjSdAAK$OlO>U-ya3&^H;Y3lRdxIOkGXXzb zi7I*Q9fdn%F{(R(eXc*t?W6!xDr%fQV4GuJi0blNY^Whdh2!+< z_Ee~=i-Bz0TW9E{>Aa;txP(3Dv-cg?8 zvL?Vi)xJE()o&S?1QvI^8i-EzS9oAQZD>OG80?_vjJ}0#Z$jK601BrThXB?KjQj_Qe(}D?*xtw?zYU|fRa38(um=#+az?WO2|CpL! z$XEtIJn!Y96h(!&?z3MYb+mR6dBmCJ`$8r(eT%0x==}Vd(EhCF$-X^89nT-wFWJJ* zV%bqs5HD=F!|tUro}LI=BReyHr%ip(Qickk?%=i{eo)2ssQ)vXLV_^Fk+xgV{Cvq`|O<;tGpayzfrCx;u02(l(+MF&EbW zedXyhc@-aiyvNygixAuMZ2Mk@c;o{et=C)c9*sQng}c};Fk)>J`9PzFrR5J%b{WYg z{D-n+qd-DT6u*rNVv)YF=te!E7;~Tch3%5 z8#10dFTq(VPrr5V)Vl$CLlp(~AcExbYt~b;KpTn7~GA!~8vo z(0Qne4>$mR4O7^sUr)J%E-a@Z<59LW1TPXF<^6JKxk&w9r*XWVCN;^U;r{%8n>3!7 z#GRf-XO}s0eQ|9H9$ztAt+Y5t^D zTud;z3J**R0Xc!vD6~$<^*d2^kBu5=TfcHjb=a;*mwbe3_T56A4W zsf6I$9gTij{zhgwT&FaQk+sziKGO4~hL;N<-!zTtk9xHI^9P6db>tb;uUNMxf%$~# zUBO~#KF5S0r(!d>m~6SHJDs60EtFGK*vWP-HfY|J;k7IB(tMhbO>f~HZm)=s*AX|h zj=pfWl-lk=X-uH^DoLj=0N?NM9@bDZx8?w`^01d#y|pd+}6rKU6bx-YFf zV0!o}b(c|29jmX|K-aK%-iIj%G0uVZjyAE4{@h@T&4;-fLHg8x`u~AqRELR28R6>r zb_Kr1bwb^}tcj+?;eV$3Oe3QPMr}ujwX~+-(u+7M&p^m>3;lJ;>fS&Z+VD4j7`Eq> zYJf!@uS6O~_F}wPt?z@SP`9vP1zacDA!8uP-& zQzhZ@bYvH$zC_pfr6hzk%JozpWRNiriO`5i)`UEG+#}_RXBcC7&}Uu2{h$5e--7xg z)6>a&_7vf{Njjz|Fis~>UW#N*HwenR_=5SSXd1JT!6{+UD=Ao5sP8z0#BrYuBc@G7 zX`~J{29`p($b`S=KQL@A#D40N59>A27dtsMbVH1V{tU&UvIhYsv6F|KvXACwE*BuS zTt%v#unEZdcVNGr6M5`kUD)(AT6l9Tz4-k>w{_jv4QaBvqFRe(4?3neWj8_~Jqk3W zQreZY|NZxOf9P9sfIqtTK)pL8Wn5QVkiE58=SJEZs(@pD$s+=Acu;;($bG}x!9%6$ ztcTq2->jfU8Veq!j$zJbr-j#crTe&vFZW1eYqfX&{9hx`RvBN)J*d}S+=T;#Yi;(& z;D3zG9`RHTCoYBPfFC@x(Q1*PCT)35-u#VP31~d2=Nxgt2k#CaE-s|9JN-SifMFR! zbq15~<~Hh>#RYN;XdLn$eJe+aMtljizt_i@Dp0BwYDF#-Y}oTWT#m2aE2TDlID!q` zCN}=~Tq0fmzVUs7On+ZsT<8!%78eZmAs6cGmFH3KP&z6;LbNCvw=?YeXWG#rsms~$yVw@p{~>`r?SHu z)Ts$#m9Md7f)anSJbe@2RO^RrQyGiP8ISHhh{)ec{MGc`{1D(sNjcgETDz@7CC%$! zZH#EM)f^_bo6RrH%!IAkm6ZJOI3;c__}Rp4M4L={J@e;~h9NVP>qQ0D+bH?(qW2@k=GaMF&RYvt#~OZaQo6#P zHwDsX7Wh~ZN7TAtPBvg;$QyfG{-K|fzpWAMt%|nN-fO{AN45*X_R-q@RR1KC`jrOB zg$}G-@g??OLV_q!{jW(Y)zmTIDC`WMw}OK;TKJvk*o0dN!p;%%CXSMzHiS#W8+cpg zh>wq&GyaOtB_3|&uc>gU>VBT>e4uSg*F?KDWsC?Ns{qe@%_8$+s_mwsfArDP-%h~j;F0428Zd)-#iP!>%lSDa6rC7~5qWW=89*b_MQw5V4wPksJHo{ZZh3e(#DL<; z_4sS5s{e?v&y5F7VNZa^z+lYNQi;nI`^gz-xx1yAFcC9Q|8bA2MDFnWWKbP}%jb`N zSPROaoOQs>YOyQJ8PB4sf{-FqGAF9+N|Nv39v%hfD?aopoe2xlQd8lUhdZ-raUXdg zcl=lV!`rcdhsO#nuvy-omK?bB?X)B9u{pz{sXjlIl}FW)$@*p9opH}5RH96db(AQO zeY1sFwsWHWyX_9PiEs&I88F&Ll`)%Vj|k&4w<{nn^>5R2{ApC{2}=Sxm99Fd*@U=# z4#;`B7YBU70wZUI?|MLj#he-MtuhCA628p6af%G|RUCUEH$0+S3d2$W4mUja8FG<)-1uI%jTME(i#gFugjAb$U zbu3?uwJ;K1`1$eMkGcnjtXEjTqj!f0W)xxR8ZUGoo1+=so72Nz&QaWt{O!tSu`kR? z1#s>r|5-2cwfYkMJ}WP_mCc>wlM5KD3mBAQpp}e=8z0j>=|a$jjxW^-x22P7z?tuR zjj|kX6Ecvug%B^pF9B_EEDG2glvO#pv_op0y58}6Cl;Tp`D#zoT&=v-H2@e$kz$@~ z^Y)p}O+D`AE7C&kEyWA%$D+RF108-mlfd_-FPK|0C*IusUTl498iZ@`S%PThdgnPj z$?c;27=T|hC(ZCS)!{O4&TeXqkOq>)w<~a;?Xd#o2|%4;sh%5v^0%4Tz}I&$Vx`Fj z1S7{TZ4l#qX7x^8ek$cTw>aX$6FA^LcChUdHZLED7O(2!wlY`I-{&*~h8WOT3)BYx z$juEl2xnCHsJwHT^nXoVXIN89*G)p`y(tI+77SISN(oIAQ4~;mM~ZZiY7j#8s&o`- z0trYb6agW0gHoghl+cApiw2O65ZZUR*Zba&fABoyOlIcn*|YZAYkgApt7wL7}~g_0yQoH~1bgwiPnuoAgEQge1b zyANdJE%vpX4W3bJT&Smg3>hAwSCavqdROzyHqzsV;D&-m(=XF&cj&cTOxHX>rL&M6 z`$@L^x4wF>u@R&SQsHBpVsX0)h396|BOeqVW&n*gYA37DQUJJ4s{WSKucPw!*fwA_ zD3a4%eE0(>j}mI^W&Xz#CgE2^Lgcb@Gj-#!v^ z4z@%xoy=$CM4tNNUm>ZKJyz9M5yb0*t|#aM<4H)A2GRLLVj2nM3T=XqbgZnp^HFM% z`kLn!>lD}90Y54{wtv!c38J@COTHay@}T=h7{ygr#nMDm-h>;XKNQ4rVQ@SoRkrOR zeKycv26}@JC7*sZlXZ~Vnb=ZGau(QM$lEfHS^ag;iVdrl{2SER1Jw07*Qj>Gb%|0R zg+MxdPB|QgiQ`4gyHwEH+vA{l3QX#!xCYmiY64GB!4ydJA)3GHuAi|=kh>6Y6#1(? znd>ay{#BFJ1juRi-<)~>WYKW6tZif6)>?IcSHb9?2 zt%D8BiWfWrb231(Q4>wcGsz*yIsN0Ep+B0ZwHm;(vVx#LpjkK}9Phc83OTP7?_`H3 zo8`!M_EM%qg1R+rcS`cI8v#}4ESI7__?aIbCd%W^ERi!}fP(1roSFl;^S=4Ov>0gt zb2B12rJs3hS!3l8<W_wxLY}lRWCx|x{53$2 z$(p*qN(I9Xn2!&~Tml^87n22V9l0!74*c~ecLao+nGljL)vN}y`q-q5Neeq8B`W7h z7PH0Ox@;uQz)tKdje*!zOFLun{GML8%!@)E6GihI@hk5ao+sa*Im3o}26%X}as*&U zsk1L&M=m^4>-ltTMe7P_<0;_!j(;v-6_#@E>2-jF zs9sw`NG6E^V%ZSg4n`4z)MBB{9HYhNZP(H~YYm1M)szfVS3^r?23F6-n$!L!Ugh3p zzKfRRRaX;5cU(|{#=qjk01%lGAp=GWB}x*Ds&Q->Cb~{wW8WnvNjeb?Rv>zmV!^7$ zf`Q$}g#k4s7tS)7(;BZ^-|!u}*&!Zb(Mx@{EP|~vu7^VRsFg8*UlriPyvJW;qBLnq z=EIqPoIsL#x+-UTzc)$QlTL>zgbn@h@W1WXZM)O@+96dtK{d=gxcMRQ){$-kVO@xw z4Y~zQvM9*EOy%4pLr=%R)TCBYrWl^&>0!$I=%P1GzZ{EaJ5_Q_TU;Arn4K}nUe#>4 zUv!}|@;f-&yXyJ#=qEE@c?B`FK{^aLH5D(VW>_MlC#m;5TVYNaDK zv2@-&NE}5^1gY7vu|a=TTfTroz#3%bE6{6zOXId_^Tbar zUOOXx2ggBAQ*-LZbOgCOuN72e57GmRE}Y>J_|m67ZNI91M{Z4M2;{$`j(7dh-i3Ks z;KyT?3cd9FO|LX=bdXN&~83 zJRqJ?lGRpi&D;@}hoCSD$!p62P6cwT5mJ{-l-wU74AQV;y|6L&L0({8HJrCMfj&|j ze!=n$H`1858`jQuj)LtB{?KcEKoiv9X5qawGqOq!UawW+PLfmD!SU>2KNDcbmz0#; z0}MM|=PEqC17NI&t^14hF1p88ex;1s{KAW3)PGm3;)14@#)20f9)DTdUD;9a4k(LQ zayL({eV&S)&A_pUK*=CwoF29#;ts%mQm1l?>}+N&E3D2*<^eo1WVmnY^#HO%Mh`<~ z-%YrFYA?CNvLP#2XRHWMdhS(4!UvEaye${cUYE_jAfA1C_@+4S!B$O#WR}RKFqA>~ z(EIH+>1#b2d`il@ug()M7Np;O5i9NB0Q6WuBjS6k9xQjy$$5UO+8XFjQt%ty|J~KH zXJIEba4%-h;2z3f;3mbpy>ru|-Ay9FVUA(}6zhv_R3IQoh^A&?4*O>ZTk*VQMj7gI z-b;q&mfQGuV;}PHL02cEqK$N~Nl>Y#TDTS^ld#^0KrT(_)uA!=UPUN+SOB%(K)9nn3 zu5*6bJvaF+??`x_c`hl`ZIYBBc;0RE-bnp&a&p}nA%Px?m8p=J7T?$wnruo>K8tcg zhfVO4L;HP1?UFNGD~PG5bHYL%gZQ+bIT5y8W~17r3NkY6;$1pjyILO{MY_|4;_l__ zaw9aI$iD}>0r9|;ol^r6nJz;kwE5Vz@X!h!E|vCGfy$1LmJ9NHJ_peL%;$gqV5iAv zq8gMO3UYpGuyKE}G z>BlGGNjYzijDqRU=i0Jf@0=Kc=)Fm)x)d6c;z1sx!cHgwhF1xKpwjNSxNXKa52n6( z)uQLeVvpIoE8}y=BB~-sMn{1Qy1FDQobv!|#=HAP%@S$*@L9Vfj?D!MmAzB9M#m2U zK#SmC=EocylVi4Xbc#PQ&6N1ZnlOjtScM3QDhhYrnTrA+fezu8qOn-ZWp-tiHU9dJ z*7eP_ogwj0I`vKy<#hzR3$KF@?XA8TSTZ)oQ^lqF@iY+ON(;|GYfF%MUvB zA(v%qJ(z4pq@Mp7tPr7osGvOA%rIV|_JtPYgobNeRN|}mFi`^EzQbgfVJd4Fw&5;e zzh`{Gcjz}@OFFP8M@vS9Y;+sS>Q}Q?1n!{hD-Xnm@@j2`#Y|LI27tBv1E+&T*r1>V zn(LW(Kgi2cS_benp(GhhQlu`0tx}C=EFWdI6J5Y$$8l5D2gqkKdRHD#WsnLimzQhG z!L#T3)`!uKGu0CrIW>D8&U;+JAvwj?EALhQJ(p-v;WZ(S=wkz|uc76g23>yz7x~BbC+oFC3Dgv>NQMHDDXg)t4 zn#u{tL{2U>umWOnv`sF5i-E1Vj{d*u8baf|20gLr z6+HrCmu}p%nEQ6o)jx+lJzp=Wgm8cR9E|N&aBDy6M2i=uzUSiL0ZOi_-H4&CZRgNB zJ|i;ls{}iag&Pgi;(znNvH#k>>a01|0z@P=>SUfDRCM6$c1a3^A$_3|#2pE{Qf`B9 zfwXcZfPRZ$I`j%yk1WD??WZnW{H+HjNs-9s-7HPQ)OrFwptrE&?wIVx{%K@u4M;zD z@V~u|iD^W#Ffj;Za(6vU;oNoT_4F*w*u)2(*fcW1WlVrD*UkGS=jB&zn?H1$tkbFP`)TU16Y!X{Rv|J$9Q zTp?CKMc@tSyye9E`?s>~I5B61oNO^U;TP96L_GUTFQGR*ycRe=rMBW=Y`4`YUHDKp z0b?BrCJ#vVek5$pGo;l}{iV`(g?%B!A|5f}@ZaX4jtCc6>r%tS`BD}3b1p{SodP*+ z`Zs}6S|bg}B1_+eHbAe#3w$|rn|x~sQ8(scv;pm-8dY1j+LEQa)Mk{PWFqO{o1>y& z^v=I{=Sg;@FH}sp5pKv9O&#e0zTUy82Q=QvsAo)vq$UT3Czpea9oY5FlS;DAFe(yy z0G|74o@t=4he>N$b_y!v;MZqBJ$d&6|M=nByu$uj^(*TND#X20Q6$uV1CLNO;RfrJ z+uXmI@x+c*#8Hq(SR3;)Qjd6luv_i0_Ek@7Ck|AAG8^p?-E*@4+)Wlg1oY+$Gu0*{ zgf%9jI_HxkNk4u+CMz`IWHp>=@H=g94~%cq!<$yuxk4uL{(BI0mIlfzicx}Z(8H^S zQ%gcfI`qga8e( zyzp3VKwz6e?f)-o`1z!+Q@d1b)R7idT#xK`qS*nJ`gYgaYVg3N(^bO{1TI4)Qqa=W z6=Z#NdqN%0nj^uGXl}UzRTe~kr9td`|0?juCgY^Q&qV&|3l`Z=R{$4HX}EIcNurxV zmMmu`GAw^?8GFtC(3Lm@f3{RRT4&0%I7@wHdrvRt+%fgiGbbhR>c_0Zeuuv6+db|7svG??~n z;J5!?3h@M-nN{s;@IA0IpjcX_!$I4=o|M>nwPp)rdq_TLZ?wCQ9sID=bacy$mLIG) z!6WF7ZfIy54y0$HTctL&Rll2{XRGemToO7!;VpHB4jp9T=;?>s=ZPN}HP2p0O z3p1g;>ikf=iW=n&d`36z@^)vk?Yg0QR<2y-vx)x~7s09;9BWW9d@8$*6f$N~D%%_7l4wWARVpAWFlQeDv(!AdK5r6MUU9!NJ>52k z0r4eqj4oGx_h8!=xk3)M*}knNcV66F_(3{72sX2@MMuKJ~~K!_RhL6xqLQRA`OK0>PYeUMiT# zb<@t%*MaWa7n1@T$YAaGPrIzDWANtd61dxUp!&_d&TufEt{^>#K~0IK)0j`ZUW&5g zZGJfTSk-&`B|(ZOos{?kqw*X1bGT^C9QP4 zw{xrf*U}k4eb$NyH$fb1?Pb>>Ssq|5T=EzlYM9Cd8ocU>-Q)|0;r9tcX`z5n zZFgH>g5`=9v3rW^!kXhkvW!7DNd`j<+V9<1tz(4mNx+iKY4IR*Hy@FAV)Hf>m8Cmw_K z7q9UaH}5-)GDX5ZSX^A2Pd!jXRJ72eGNn)d_c|4ssDN8Tf>kwPpwDVa+5qMw4({;n zNM8M!FYtq_{gqS&Vv*3_n-7@wLpT$$w`b zV6ucjv~xJzxnCi}U#95cIIckDg2hoKl_tv3y~r=AmF65C;JB@FRf66Jrizsq7qS2@s_KlosPedO2b@*+z@v2+B|8JU|ZA$KF zlvKhYEaSAGIaB_7cqt}8M7|h0^5Xj@n*6Df-L->*>hTuUuQBrJzdpCEmT}_whgqz| zXx2i=B}K}zbsHNOpLl!{Mx?GNew6YvRK-+NAVFSvX~b^NKx9NnjoWw#^Wb6(Y0;G0 zvjXAOY32Xl^p*LOi)3mkw|Lp8u8UGVeP83-Z9HC|axm0hZSlA)fL0ceAZr)ylm>8K>#%*1gHLisPeu9_yrz&-wtkL4O34TH6A9Y-*sH&z9AW)vDsgVuu<3_mdAGQ-I+ZD z)GIgtO~8P<2@P1cP6LK3F}|<Y89fI19uV7f4!21!uA2Hha>XNl?cTWLuR;>?^?&!R7GX&ssnDb9Yl_%54; zTzfwny7Aq%ZxK5xsvdZpxk#uWe{$zlU7MFhVLz1pe)JN@ zY1a7Tl-%q|A+2M$H^x-L(j=;+=ARNS5Z=uLhJl_D_CY8plQ2l@hkVvPOp~v@#wAhu zLEs99UA3^F1KUmbzK40aBYN`CjTW@6q-SEJs|e3$MtwSU-R%Rk*9_lEt|AX7fCt9@ z9|c4X64^+YhSP1?J?_mizH4$lS`;Xy>5@NF!R<9gl+1>p65Hnbb@Q{QR1cvQ5R=&y zL6HjZY;H3c)iEj>fSnKwUizy_NakZ+&qNQqA^~tLE79Ao`rD}KZ-SsG;Aj&dlw?T^ zKfg_hyA=Le&C>%|b+CRJw=RYLa>F;hvn%uYQkbmuR246c-w_8INvIgX{SZV@^fD!h zPPG`6?{e3Fi#vQS(SnVCJcQ#c9u2?OKUQPk~IdkR_$wXB;CT)9Or3!Md4nA~w z4EnI!a^HUUs|;~(K1y(GgBQOEn4Y$CZ~@)$X`?ymI}R-qjlN{eQ9}i_ZdMoFq0dy; zf62{>4X**+qw4eY@ajrSl1FqN3d!WM5um+Q5dS=ZONy#8^4kpNy z`d|B!(H}#$@drdoTC5Br^syjZeLIzbrG6HFe=R(QOCM${^>W5@};X}AzwOkXg#FYov+MY<<_J~%^52U{JkFK2! z;8GZeqqk#Vl3t+8?I)@6(NUWPk@?@{O9**tq!FM?Y&oWc13@ytQ!TT^;yt_$SMg8leU>)hs6b#1e z^6$K7WY!X@xS)RFBf5%;`i)Y;!E>1fII7&MmE1$%PP@EuRcYDJdIVX~;NL;+DX=!` zwRi^r7#gS7=r2N^@r-d@vF`!FuydkRMN@AsrOLd!73S+IZ!|+~LDf=_kz%gqO!*P@ z*hXY+8Dua>M@RE0E+Ddftn&2ePON8)6W@}r70>f@EjI?lbm;yHrgAr?^7G8_6)A)s zGCAHy3t71M#?UYER;#$l^SKI9(mGSXrZGmG6*AS8kF3yL_S+A+!jrcsJmP5bYO6#P$@{~CU`6N(A*^Zh zD^>wJVGf>`%{izzh;2Qz+*sLj7C0v4`O^#pT1MIhPF^+`4n2J{TZ034XC*|s+0HP? z1-}r;MCcwCygv!pA#6*7Ty@fTBWWpD>z0i&Zwi+~L0w_kS7+JNVwCq)-&}j& z4WYeN^^N+J-U}L!Jl}ZjuIQgdXua1?`%Y}1H9eC(>$+og?WsxeM571ccM018Ye`#E@oG>cF`=MwDCC;{OM$=9=0g|ho$&HCt z$A)JSYCvT!VS=3pd@Uk}>}L(_KXpbnsczlc`d;Uf@7Ka79i7TMtfCsPMis+FcL8r3 zIoFPw-!x;XliY9AgkG=TTHyMkIcdiC|@l)Lx*B*o=mB!jC*?cNPb zCo2;fJ|a(VvfOA;+`@!>)|0H-R#kSv#M-)3fuN~&YT_jcwT8ot^*SS4Y_>*yd z6`Sd`yrWIeR0N!lDL2^#H@Oa5zl{dH2$JL~Wq>I!q;nGvFah+5x3YoCzh*9(I$j#^)7WvajLSv$rMo3=KR1Hj zY9q1vzfF#WLDWXDOj;@!|0i1g-i>atKHFI>ls0(3=QzugjZ&h)w3!#hvtlHE`$5=k zbg@P2l^KB-aq~(;LHsH=-M1^hdv!JZ;^PMMrT`=5ZBj7Ae=`dj9Xqsvy>X^mG~8g` z?&dywkkJ?nic59gnF@`i4=Ce-T$f&e;Ia^ zJmZ!)GZ(bVEY-7UvM-xfIY6X`e><#l=fJgWx-jp8b3AILM7Xl5Sry&*+U~6^HPU6> z1rV_=xJFs0i9m=>Ha}d_{Sw&RrbH#TCk620>;xR!-s!Hzq1U+(8@Rhb80fc%=MpJJ zDNjISh3}NM05IUGN8^je*_3w5SZDonE};gD5f3VONx|_$NsM>}Wd|)6x)0bTfgIo-K8;AQUJk z+=q?@9r7M*1Q3yW=VOrE7{v*9~7;yMX$R09@+Fm<3uQ(J`KL<=ZN5d{RO@FVP;RBE zJ??Y(&|rh~m{V3{vMW)m^7cqBxlq*Ovuwq}cINK{D4ct>Kkyr1+|}pZHcDn)h-E?H z1noo=q5SSEZl7Me#u^0e{lYq9^gW7L_vek8CsJ%3{&DJE=J$z3R1{1)2SrZ5^K#b zCzh813Nna<{c8~*}|yp{ar2jw2K5K{Lp|!Os5Q&V?IwSyRto zr&mH)j22ZC_o90(1T#Y8xcAq%R2{si{>Hfu_*OpbkUxCeOMQ$a(I6lX4gysY*o3KU zKKwqqT44jAUsDHt4~3uYoWM~P0xcgtoY`IaK$#$@AHNK1e)65sHmP52?zNBMw>Brn zrxV(WPys;MOo%IIxP04cW~adBu;g@7XKRe{z&XMDevzd2ws%Ftu*z=5@su5GY0dAw zTevD8lEE%=Yd-gDQdmZjN&>|@b+u@PRNSogZFT;%SEv+n*@Axq4xC6Aqe%5qTnLCK zZlXXp&4g8bYfT$y_G717OIhLhoNql?{5%%X*b?Ui57%9R=)^~Ko9^sy6{%-;nZ{Ab z^iLMrt=h+aci&v?VcX@LISv>H%sRtL)#yv*o7vELClqJ!?gjO;YTQf7@JxsM84jn`#4cI*xUFg^ zj1owOl%zMz@Xb{ZTMO$6ipr1!QHD8CrrGoG?yAgaZp6cs3Cx)wqr@2kNM5=o?x8FDtEUTfDFL$Y31!mI{6mwT$)iU6Q# zRhP0028_mWv9^g~66Oavm$d+|Iw%i7)9@^NbHCE(q~j}iB~FuX?j4zT@^e9JdTg=6 zB6JOjk8ORh-Dnyzd6KaBBQb{nc{AX>^eD~83OpvghfwBXGgE`(y839syK7jsqKEw< z-)HMCNVVd~-2f^~+2vLk-d3pll*aHWMm@03VovM(dpFJ3?^;sz4bxkUYrpfDinHB3 zCx03NQ7(J!s!}HXD1$-8km!t7^NX%}hVvT@(kJY$C)lDV(zQ0n9*3qnWgFE*l2kr; zZ!6I&pnsQ!e*4|Aq3O8>Uw4L6Kdt4yt65-j5j-@;GB%`_MSg}$mf4oabxf5OwZuIT zt~C)nt3Jo;J<56f(fhEoxtiW11-%|Zsl)j3Nlz)C9(1kfk9jD#128}4IP`dnmV3#U z0;b#&tNeHr9sB4~BM0bEkULZ1-?vo<9c{PGkZzvoPing;KeXHgfI5L6YND{k*8A>3WC`u%c_ z>{d3jbxxiUv14~hL+?~h^)q3UsS&g~zk4kClU~AC1oeEmw^Lg9a2#Q2wEXrC>1AS3 zy2DlNN?Y6h1Fhxap1oV!L8GKogw;`%n|Y(OgvBp$nTgJyYS$%umES+4!Z%OsH4`vy zp5?aN&1>FAL6vSxmSzX7qySI!CUTYOkb?cC^3K!LH1kQk`x;yt(TVrb4xe{4pcMgx zM#|}mK=$-yeo;kaH}Ps;X84JVR|AuguXqz+6?ULOi-P-KXR5Mz8Hb*W1Bn*rXXAaU z@dv{R0C`}f>dkEl62oruG3R8iXXXVi2B;{jCpQL}!_dagT z1?KVm-p`o{Am@$Sms4te?-B@{ai!>(u1V1sVgYc@sdia_df8=7b<{-MK5ThG*L4Y<}&}yavj`O#PoFVTZ zM0wL$Q%h-wGj1fDLqu2)>A0~c*3*&*Ce_Lw15QA>YjMCG|1x6|Qsl zGMYHhUB$zuU3_mWhX#534t>!Uso9Cn z-QhNs$9#-!<#j=_+qyjC_4?!lij@*2}=-v zV2 z@=#wORU>KEM8XCPN{#_RJhk7v0vwbqQaS3XQ%8+>68Us^eGK^|nFxYTOzV z#viJ_yN9wycuC1g;sNvXzxSle|0P>=quSb)1TWx|R(tOV728q_h zBfC79OZLiUU&B5FxnBZc6YFDZ26RjgwaaV7vF_V>Ij2ecMZrdzU7T5}nC%iUZ(kEk zj(pj3c-xX^yhf!?%VV-vr4CxXZg3vkv~tfR=IX7?i%v>E>h8H@cY5h3#&V_K`R4wi z8_lkaP~o1NczwQVuJJ-G`2FLb>sK26XlD|#|uv6h5&)3JZ?ii!D6Td z*fyg4Ry&9yGbg0$^{3(bLc${LfLJ|GY|Kbbnd%Z zrc~l9;XDAJp-3ntMX$#p$o-U@{R*QPH4^kz!=Q?tKf0^bu$ep?Q)pjBe(UZDF+Z7> zzf9uPrx0@kQRqAXYdUxm@1=+mt5Uq7)rE8+CRWj9}k@ zW>nkBR6Z@-8KZghrBJQ?o$VqUuJl8vDWHd==~0IL2l6+@ZR!gjN6#Bl1IjQSYZ4&> zZJaKS>J}QGP4+>#6JtdQ_?pr(GkbemLPxrpAZZxe{Uu1|#<%`K)oIrb z${eFeu9W6*7!hU%Wdlm5FSzp*>xMZKsiUQ}ojPt}^!$>#31z-JOT4;DD2KR zyI(M79;$t(M#z1t5FE=*Eisg49yFC4c6Ln=>FDfC1rU_v4DtZj}h&Y}lil z`Mx(vpQG07!ng>{tdgkb+Wl^k@Ts0R4cV`||M%wUuVg?7ESKzrN$s%;AMbZxoSRnd zW=2t6ZsR1vwb$a3x&e*m=`Uq}8+HSSmBrdY^ZbXTgYoW=DUP*+yzX$4px#3t4wI+6 z4{q{oTqn}Er4skX?<{6GqpB={+bvAJ+6wl9N-i^{pJsU@R5DQW4_Bj>xR>_oSa+<_ z33n_Pq_7sE2V^6+bbM)Mr(4@<)`GzLeYZ);tQ#peN~~fn|7EL4B0{}3!d@OYThPq6 zy;XnJck{~j^<&|I*s;5}f_bgocG7q~yt2aqH^1#9lxlYTx~*mvSm))rRhPESyxsts zf!l{4|M&07w6S#n^0j045`cIcz$i9XsQx!E*h@9iI5G{E{CA&VZ}mWt#oGL4_S8et zW;W$$z!N)8jq<6Lje^Ax=`%)fveRD9IQ0QX4?wPBvTkK_sXe52b+xQKFqPQglW8s1 z#(AxP^RhQq3(NEwcPD)RP~wB{D*EP%dBQ>sD12*nwmDREBtWU(YD79wz*I~mTwPd7*OnL)Tnx^ z?YOn>i}f?C;WE;#L#SID=AZ}>Ol~^WcR$EKpRhB|r@&c6ukb(-k?_}z-OJaULtY^P zSKj7+8)|??jJo*DgO~0LwVJsX;3p31`Kl-UwEDU@TkYSEuS;{_VK#{xx4X*2k{b2X zuIbzleu{^)XDxtsxG=$=6O$t{K%5V*S%9gpTw zTZ_Y>pClF2WNTr^s8O@M zrBHy6KT+!ZRA2RHMYqegA*iR?Ol=nmKjco(f@n^Pb5BEQ6}o z$0^ZdBVZi~w@o0$E?AnJ>PrF-hW{DA&9e&_g4tzA5#ZCV$3N~P)d8)iLHp9@Y6-dh z^E9c^mkZ}TdW8K`n-TUMj%O}Hey~05SqJ@D!-a-OowX=++r4yoN70>a* z{_JzXMBNJUhRXSmQKkH4S#ef+e@16h=YHq8?vV;-O7e?}yZ`>N!u<|R>V9qXpWnOY eG6FidkHdTr&`%e5iZCGH=hh9q>lN4RBL5F-C*C;# literal 0 HcmV?d00001 diff --git a/python-3.7.4-docs-html/_sources/about.rst.txt b/python-3.7.4-docs-html/_sources/about.rst.txt new file mode 100644 index 0000000..3ea311f --- /dev/null +++ b/python-3.7.4-docs-html/_sources/about.rst.txt @@ -0,0 +1,39 @@ +===================== +About these documents +===================== + + +These documents are generated from `reStructuredText`_ sources by `Sphinx`_, a +document processor specifically written for the Python documentation. + +.. _reStructuredText: http://docutils.sourceforge.net/rst.html +.. _Sphinx: http://sphinx-doc.org/ + +.. In the online version of these documents, you can submit comments and suggest + changes directly on the documentation pages. + +Development of the documentation and its toolchain is an entirely volunteer +effort, just like Python itself. If you want to contribute, please take a +look at the :ref:`reporting-bugs` page for information on how to do so. New +volunteers are always welcome! + +Many thanks go to: + +* Fred L. Drake, Jr., the creator of the original Python documentation toolset + and writer of much of the content; +* the `Docutils `_ project for creating + reStructuredText and the Docutils suite; +* Fredrik Lundh for his `Alternative Python Reference + `_ project from which Sphinx got many good + ideas. + + +Contributors to the Python Documentation +---------------------------------------- + +Many people have contributed to the Python language, the Python standard +library, and the Python documentation. See :source:`Misc/ACKS` in the Python +source distribution for a partial list of contributors. + +It is only with the input and contributions of the Python community +that Python has such wonderful documentation -- Thank You! diff --git a/python-3.7.4-docs-html/_sources/bugs.rst.txt b/python-3.7.4-docs-html/_sources/bugs.rst.txt new file mode 100644 index 0000000..c449ba2 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/bugs.rst.txt @@ -0,0 +1,92 @@ +.. _reporting-bugs: + +***************** +Dealing with Bugs +***************** + +Python is a mature programming language which has established a reputation for +stability. In order to maintain this reputation, the developers would like to +know of any deficiencies you find in Python. + +It can be sometimes faster to fix bugs yourself and contribute patches to +Python as it streamlines the process and involves less people. Learn how to +:ref:`contribute `. + +Documentation bugs +================== + +If you find a bug in this documentation or would like to propose an improvement, +please submit a bug report on the :ref:`tracker `. If you +have a suggestion on how to fix it, include that as well. + +If you're short on time, you can also email documentation bug reports to +docs@python.org (behavioral bugs can be sent to python-list@python.org). +'docs@' is a mailing list run by volunteers; your request will be noticed, +though it may take a while to be processed. + +.. seealso:: + `Documentation bugs`_ on the Python issue tracker + +.. _using-the-tracker: + +Using the Python issue tracker +============================== + +Bug reports for Python itself should be submitted via the Python Bug Tracker +(https://bugs.python.org/). The bug tracker offers a Web form which allows +pertinent information to be entered and submitted to the developers. + +The first step in filing a report is to determine whether the problem has +already been reported. The advantage in doing so, aside from saving the +developers time, is that you learn what has been done to fix it; it may be that +the problem has already been fixed for the next release, or additional +information is needed (in which case you are welcome to provide it if you can!). +To do this, search the bug database using the search box on the top of the page. + +If the problem you're reporting is not already in the bug tracker, go back to +the Python Bug Tracker and log in. If you don't already have a tracker account, +select the "Register" link or, if you use OpenID, one of the OpenID provider +logos in the sidebar. It is not possible to submit a bug report anonymously. + +Being now logged in, you can submit a bug. Select the "Create New" link in the +sidebar to open the bug reporting form. + +The submission form has a number of fields. For the "Title" field, enter a +*very* short description of the problem; less than ten words is good. In the +"Type" field, select the type of your problem; also select the "Component" and +"Versions" to which the bug relates. + +In the "Comment" field, describe the problem in detail, including what you +expected to happen and what did happen. Be sure to include whether any +extension modules were involved, and what hardware and software platform you +were using (including version information as appropriate). + +Each bug report will be assigned to a developer who will determine what needs to +be done to correct the problem. You will receive an update each time action is +taken on the bug. + + +.. seealso:: + + `How to Report Bugs Effectively `_ + Article which goes into some detail about how to create a useful bug report. + This describes what kind of information is useful and why it is useful. + + `Bug Writing Guidelines `_ + Information about writing a good bug report. Some of this is specific to the + Mozilla project, but describes general good practices. + +.. _contributing-to-python: + +Getting started contributing to Python yourself +=============================================== + +Beyond just reporting bugs that you find, you are also welcome to submit +patches to fix them. You can find more information on how to get started +patching Python in the `Python Developer's Guide`_. If you have questions, +the `core-mentorship mailing list`_ is a friendly place to get answers to +any and all questions pertaining to the process of fixing issues in Python. + +.. _Documentation bugs: https://bugs.python.org/issue?@filter=status&@filter=components&components=4&status=1&@columns=id,activity,title,status&@sort=-activity +.. _Python Developer's Guide: https://devguide.python.org/ +.. _core-mentorship mailing list: https://mail.python.org/mailman3/lists/core-mentorship.python.org/ diff --git a/python-3.7.4-docs-html/_sources/c-api/abstract.rst.txt b/python-3.7.4-docs-html/_sources/c-api/abstract.rst.txt new file mode 100644 index 0000000..ad53881 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/abstract.rst.txt @@ -0,0 +1,26 @@ +.. highlightlang:: c + +.. _abstract: + +********************** +Abstract Objects Layer +********************** + +The functions in this chapter interact with Python objects regardless of their +type, or with wide classes of object types (e.g. all numerical types, or all +sequence types). When used on object types for which they do not apply, they +will raise a Python exception. + +It is not possible to use these functions on objects that are not properly +initialized, such as a list object that has been created by :c:func:`PyList_New`, +but whose items have not been set to some non-\ ``NULL`` value yet. + +.. toctree:: + + object.rst + number.rst + sequence.rst + mapping.rst + iter.rst + buffer.rst + objbuffer.rst diff --git a/python-3.7.4-docs-html/_sources/c-api/allocation.rst.txt b/python-3.7.4-docs-html/_sources/c-api/allocation.rst.txt new file mode 100644 index 0000000..c5e548d --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/allocation.rst.txt @@ -0,0 +1,71 @@ +.. highlightlang:: c + +.. _allocating-objects: + +Allocating Objects on the Heap +============================== + + +.. c:function:: PyObject* _PyObject_New(PyTypeObject *type) + + +.. c:function:: PyVarObject* _PyObject_NewVar(PyTypeObject *type, Py_ssize_t size) + + +.. c:function:: PyObject* PyObject_Init(PyObject *op, PyTypeObject *type) + + Initialize a newly-allocated object *op* with its type and initial + reference. Returns the initialized object. If *type* indicates that the + object participates in the cyclic garbage detector, it is added to the + detector's set of observed objects. Other fields of the object are not + affected. + + +.. c:function:: PyVarObject* PyObject_InitVar(PyVarObject *op, PyTypeObject *type, Py_ssize_t size) + + This does everything :c:func:`PyObject_Init` does, and also initializes the + length information for a variable-size object. + + +.. c:function:: TYPE* PyObject_New(TYPE, PyTypeObject *type) + + Allocate a new Python object using the C structure type *TYPE* and the + Python type object *type*. Fields not defined by the Python object header + are not initialized; the object's reference count will be one. The size of + the memory allocation is determined from the :c:member:`~PyTypeObject.tp_basicsize` field of + the type object. + + +.. c:function:: TYPE* PyObject_NewVar(TYPE, PyTypeObject *type, Py_ssize_t size) + + Allocate a new Python object using the C structure type *TYPE* and the + Python type object *type*. Fields not defined by the Python object header + are not initialized. The allocated memory allows for the *TYPE* structure + plus *size* fields of the size given by the :c:member:`~PyTypeObject.tp_itemsize` field of + *type*. This is useful for implementing objects like tuples, which are + able to determine their size at construction time. Embedding the array of + fields into the same allocation decreases the number of allocations, + improving the memory management efficiency. + + +.. c:function:: void PyObject_Del(void *op) + + Releases memory allocated to an object using :c:func:`PyObject_New` or + :c:func:`PyObject_NewVar`. This is normally called from the + :c:member:`~PyTypeObject.tp_dealloc` handler specified in the object's type. The fields of + the object should not be accessed after this call as the memory is no + longer a valid Python object. + + +.. c:var:: PyObject _Py_NoneStruct + + Object which is visible in Python as ``None``. This should only be accessed + using the :c:macro:`Py_None` macro, which evaluates to a pointer to this + object. + + +.. seealso:: + + :c:func:`PyModule_Create` + To allocate and create extension modules. + diff --git a/python-3.7.4-docs-html/_sources/c-api/apiabiversion.rst.txt b/python-3.7.4-docs-html/_sources/c-api/apiabiversion.rst.txt new file mode 100644 index 0000000..890a038 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/apiabiversion.rst.txt @@ -0,0 +1,39 @@ +.. highlightlang:: c + +.. _apiabiversion: + +*********************** +API and ABI Versioning +*********************** + +``PY_VERSION_HEX`` is the Python version number encoded in a single integer. + +For example if the ``PY_VERSION_HEX`` is set to ``0x030401a2``, the underlying +version information can be found by treating it as a 32 bit number in +the following manner: + + +-------+-------------------------+------------------------------------------------+ + | Bytes | Bits (big endian order) | Meaning | + +=======+=========================+================================================+ + | ``1`` | ``1-8`` | ``PY_MAJOR_VERSION`` (the ``3`` in | + | | | ``3.4.1a2``) | + +-------+-------------------------+------------------------------------------------+ + | ``2`` | ``9-16`` | ``PY_MINOR_VERSION`` (the ``4`` in | + | | | ``3.4.1a2``) | + +-------+-------------------------+------------------------------------------------+ + | ``3`` | ``17-24`` | ``PY_MICRO_VERSION`` (the ``1`` in | + | | | ``3.4.1a2``) | + +-------+-------------------------+------------------------------------------------+ + | ``4`` | ``25-28`` | ``PY_RELEASE_LEVEL`` (``0xA`` for alpha, | + | | | ``0xB`` for beta, ``0xC`` for release | + | | | candidate and ``0xF`` for final), in this | + | | | case it is alpha. | + +-------+-------------------------+------------------------------------------------+ + | | ``29-32`` | ``PY_RELEASE_SERIAL`` (the ``2`` in | + | | | ``3.4.1a2``, zero for final releases) | + +-------+-------------------------+------------------------------------------------+ + +Thus ``3.4.1a2`` is hexversion ``0x030401a2``. + +All the given macros are defined in :source:`Include/patchlevel.h`. + diff --git a/python-3.7.4-docs-html/_sources/c-api/arg.rst.txt b/python-3.7.4-docs-html/_sources/c-api/arg.rst.txt new file mode 100644 index 0000000..b41130e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/arg.rst.txt @@ -0,0 +1,676 @@ +.. highlightlang:: c + +.. _arg-parsing: + +Parsing arguments and building values +===================================== + +These functions are useful when creating your own extensions functions and +methods. Additional information and examples are available in +:ref:`extending-index`. + +The first three of these functions described, :c:func:`PyArg_ParseTuple`, +:c:func:`PyArg_ParseTupleAndKeywords`, and :c:func:`PyArg_Parse`, all use *format +strings* which are used to tell the function about the expected arguments. The +format strings use the same syntax for each of these functions. + +----------------- +Parsing arguments +----------------- + +A format string consists of zero or more "format units." A format unit +describes one Python object; it is usually a single character or a parenthesized +sequence of format units. With a few exceptions, a format unit that is not a +parenthesized sequence normally corresponds to a single address argument to +these functions. In the following description, the quoted form is the format +unit; the entry in (round) parentheses is the Python object type that matches +the format unit; and the entry in [square] brackets is the type of the C +variable(s) whose address should be passed. + +Strings and buffers +------------------- + +These formats allow accessing an object as a contiguous chunk of memory. +You don't have to provide raw storage for the returned unicode or bytes +area. + +In general, when a format sets a pointer to a buffer, the buffer is +managed by the corresponding Python object, and the buffer shares +the lifetime of this object. You won't have to release any memory yourself. +The only exceptions are ``es``, ``es#``, ``et`` and ``et#``. + +However, when a :c:type:`Py_buffer` structure gets filled, the underlying +buffer is locked so that the caller can subsequently use the buffer even +inside a :c:type:`Py_BEGIN_ALLOW_THREADS` block without the risk of mutable data +being resized or destroyed. As a result, **you have to call** +:c:func:`PyBuffer_Release` after you have finished processing the data (or +in any early abort case). + +Unless otherwise stated, buffers are not NUL-terminated. + +Some formats require a read-only :term:`bytes-like object`, and set a +pointer instead of a buffer structure. They work by checking that +the object's :c:member:`PyBufferProcs.bf_releasebuffer` field is *NULL*, +which disallows mutable objects such as :class:`bytearray`. + +.. note:: + + For all ``#`` variants of formats (``s#``, ``y#``, etc.), the type of + the length argument (int or :c:type:`Py_ssize_t`) is controlled by + defining the macro :c:macro:`PY_SSIZE_T_CLEAN` before including + :file:`Python.h`. If the macro was defined, length is a + :c:type:`Py_ssize_t` rather than an :c:type:`int`. This behavior will change + in a future Python version to only support :c:type:`Py_ssize_t` and + drop :c:type:`int` support. It is best to always define :c:macro:`PY_SSIZE_T_CLEAN`. + + +``s`` (:class:`str`) [const char \*] + Convert a Unicode object to a C pointer to a character string. + A pointer to an existing string is stored in the character pointer + variable whose address you pass. The C string is NUL-terminated. + The Python string must not contain embedded null code points; if it does, + a :exc:`ValueError` exception is raised. Unicode objects are converted + to C strings using ``'utf-8'`` encoding. If this conversion fails, a + :exc:`UnicodeError` is raised. + + .. note:: + This format does not accept :term:`bytes-like objects + `. If you want to accept + filesystem paths and convert them to C character strings, it is + preferable to use the ``O&`` format with :c:func:`PyUnicode_FSConverter` + as *converter*. + + .. versionchanged:: 3.5 + Previously, :exc:`TypeError` was raised when embedded null code points + were encountered in the Python string. + +``s*`` (:class:`str` or :term:`bytes-like object`) [Py_buffer] + This format accepts Unicode objects as well as bytes-like objects. + It fills a :c:type:`Py_buffer` structure provided by the caller. + In this case the resulting C string may contain embedded NUL bytes. + Unicode objects are converted to C strings using ``'utf-8'`` encoding. + +``s#`` (:class:`str`, read-only :term:`bytes-like object`) [const char \*, int or :c:type:`Py_ssize_t`] + Like ``s*``, except that it doesn't accept mutable objects. + The result is stored into two C variables, + the first one a pointer to a C string, the second one its length. + The string may contain embedded null bytes. Unicode objects are converted + to C strings using ``'utf-8'`` encoding. + +``z`` (:class:`str` or ``None``) [const char \*] + Like ``s``, but the Python object may also be ``None``, in which case the C + pointer is set to *NULL*. + +``z*`` (:class:`str`, :term:`bytes-like object` or ``None``) [Py_buffer] + Like ``s*``, but the Python object may also be ``None``, in which case the + ``buf`` member of the :c:type:`Py_buffer` structure is set to *NULL*. + +``z#`` (:class:`str`, read-only :term:`bytes-like object` or ``None``) [const char \*, int] + Like ``s#``, but the Python object may also be ``None``, in which case the C + pointer is set to *NULL*. + +``y`` (read-only :term:`bytes-like object`) [const char \*] + This format converts a bytes-like object to a C pointer to a character + string; it does not accept Unicode objects. The bytes buffer must not + contain embedded null bytes; if it does, a :exc:`ValueError` + exception is raised. + + .. versionchanged:: 3.5 + Previously, :exc:`TypeError` was raised when embedded null bytes were + encountered in the bytes buffer. + +``y*`` (:term:`bytes-like object`) [Py_buffer] + This variant on ``s*`` doesn't accept Unicode objects, only + bytes-like objects. **This is the recommended way to accept + binary data.** + +``y#`` (read-only :term:`bytes-like object`) [const char \*, int] + This variant on ``s#`` doesn't accept Unicode objects, only bytes-like + objects. + +``S`` (:class:`bytes`) [PyBytesObject \*] + Requires that the Python object is a :class:`bytes` object, without + attempting any conversion. Raises :exc:`TypeError` if the object is not + a bytes object. The C variable may also be declared as :c:type:`PyObject\*`. + +``Y`` (:class:`bytearray`) [PyByteArrayObject \*] + Requires that the Python object is a :class:`bytearray` object, without + attempting any conversion. Raises :exc:`TypeError` if the object is not + a :class:`bytearray` object. The C variable may also be declared as :c:type:`PyObject\*`. + +``u`` (:class:`str`) [const Py_UNICODE \*] + Convert a Python Unicode object to a C pointer to a NUL-terminated buffer of + Unicode characters. You must pass the address of a :c:type:`Py_UNICODE` + pointer variable, which will be filled with the pointer to an existing + Unicode buffer. Please note that the width of a :c:type:`Py_UNICODE` + character depends on compilation options (it is either 16 or 32 bits). + The Python string must not contain embedded null code points; if it does, + a :exc:`ValueError` exception is raised. + + .. versionchanged:: 3.5 + Previously, :exc:`TypeError` was raised when embedded null code points + were encountered in the Python string. + + .. deprecated-removed:: 3.3 4.0 + Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using + :c:func:`PyUnicode_AsWideCharString`. + +``u#`` (:class:`str`) [const Py_UNICODE \*, int] + This variant on ``u`` stores into two C variables, the first one a pointer to a + Unicode data buffer, the second one its length. This variant allows + null code points. + + .. deprecated-removed:: 3.3 4.0 + Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using + :c:func:`PyUnicode_AsWideCharString`. + +``Z`` (:class:`str` or ``None``) [const Py_UNICODE \*] + Like ``u``, but the Python object may also be ``None``, in which case the + :c:type:`Py_UNICODE` pointer is set to *NULL*. + + .. deprecated-removed:: 3.3 4.0 + Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using + :c:func:`PyUnicode_AsWideCharString`. + +``Z#`` (:class:`str` or ``None``) [const Py_UNICODE \*, int] + Like ``u#``, but the Python object may also be ``None``, in which case the + :c:type:`Py_UNICODE` pointer is set to *NULL*. + + .. deprecated-removed:: 3.3 4.0 + Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using + :c:func:`PyUnicode_AsWideCharString`. + +``U`` (:class:`str`) [PyObject \*] + Requires that the Python object is a Unicode object, without attempting + any conversion. Raises :exc:`TypeError` if the object is not a Unicode + object. The C variable may also be declared as :c:type:`PyObject\*`. + +``w*`` (read-write :term:`bytes-like object`) [Py_buffer] + This format accepts any object which implements the read-write buffer + interface. It fills a :c:type:`Py_buffer` structure provided by the caller. + The buffer may contain embedded null bytes. The caller have to call + :c:func:`PyBuffer_Release` when it is done with the buffer. + +``es`` (:class:`str`) [const char \*encoding, char \*\*buffer] + This variant on ``s`` is used for encoding Unicode into a character buffer. + It only works for encoded data without embedded NUL bytes. + + This format requires two arguments. The first is only used as input, and + must be a :c:type:`const char\*` which points to the name of an encoding as a + NUL-terminated string, or *NULL*, in which case ``'utf-8'`` encoding is used. + An exception is raised if the named encoding is not known to Python. The + second argument must be a :c:type:`char\*\*`; the value of the pointer it + references will be set to a buffer with the contents of the argument text. + The text will be encoded in the encoding specified by the first argument. + + :c:func:`PyArg_ParseTuple` will allocate a buffer of the needed size, copy the + encoded data into this buffer and adjust *\*buffer* to reference the newly + allocated storage. The caller is responsible for calling :c:func:`PyMem_Free` to + free the allocated buffer after use. + +``et`` (:class:`str`, :class:`bytes` or :class:`bytearray`) [const char \*encoding, char \*\*buffer] + Same as ``es`` except that byte string objects are passed through without + recoding them. Instead, the implementation assumes that the byte string object uses + the encoding passed in as parameter. + +``es#`` (:class:`str`) [const char \*encoding, char \*\*buffer, int \*buffer_length] + This variant on ``s#`` is used for encoding Unicode into a character buffer. + Unlike the ``es`` format, this variant allows input data which contains NUL + characters. + + It requires three arguments. The first is only used as input, and must be a + :c:type:`const char\*` which points to the name of an encoding as a + NUL-terminated string, or *NULL*, in which case ``'utf-8'`` encoding is used. + An exception is raised if the named encoding is not known to Python. The + second argument must be a :c:type:`char\*\*`; the value of the pointer it + references will be set to a buffer with the contents of the argument text. + The text will be encoded in the encoding specified by the first argument. + The third argument must be a pointer to an integer; the referenced integer + will be set to the number of bytes in the output buffer. + + There are two modes of operation: + + If *\*buffer* points a *NULL* pointer, the function will allocate a buffer of + the needed size, copy the encoded data into this buffer and set *\*buffer* to + reference the newly allocated storage. The caller is responsible for calling + :c:func:`PyMem_Free` to free the allocated buffer after usage. + + If *\*buffer* points to a non-*NULL* pointer (an already allocated buffer), + :c:func:`PyArg_ParseTuple` will use this location as the buffer and interpret the + initial value of *\*buffer_length* as the buffer size. It will then copy the + encoded data into the buffer and NUL-terminate it. If the buffer is not large + enough, a :exc:`ValueError` will be set. + + In both cases, *\*buffer_length* is set to the length of the encoded data + without the trailing NUL byte. + +``et#`` (:class:`str`, :class:`bytes` or :class:`bytearray`) [const char \*encoding, char \*\*buffer, int \*buffer_length] + Same as ``es#`` except that byte string objects are passed through without recoding + them. Instead, the implementation assumes that the byte string object uses the + encoding passed in as parameter. + +Numbers +------- + +``b`` (:class:`int`) [unsigned char] + Convert a nonnegative Python integer to an unsigned tiny int, stored in a C + :c:type:`unsigned char`. + +``B`` (:class:`int`) [unsigned char] + Convert a Python integer to a tiny int without overflow checking, stored in a C + :c:type:`unsigned char`. + +``h`` (:class:`int`) [short int] + Convert a Python integer to a C :c:type:`short int`. + +``H`` (:class:`int`) [unsigned short int] + Convert a Python integer to a C :c:type:`unsigned short int`, without overflow + checking. + +``i`` (:class:`int`) [int] + Convert a Python integer to a plain C :c:type:`int`. + +``I`` (:class:`int`) [unsigned int] + Convert a Python integer to a C :c:type:`unsigned int`, without overflow + checking. + +``l`` (:class:`int`) [long int] + Convert a Python integer to a C :c:type:`long int`. + +``k`` (:class:`int`) [unsigned long] + Convert a Python integer to a C :c:type:`unsigned long` without + overflow checking. + +``L`` (:class:`int`) [long long] + Convert a Python integer to a C :c:type:`long long`. + +``K`` (:class:`int`) [unsigned long long] + Convert a Python integer to a C :c:type:`unsigned long long` + without overflow checking. + +``n`` (:class:`int`) [Py_ssize_t] + Convert a Python integer to a C :c:type:`Py_ssize_t`. + +``c`` (:class:`bytes` or :class:`bytearray` of length 1) [char] + Convert a Python byte, represented as a :class:`bytes` or + :class:`bytearray` object of length 1, to a C :c:type:`char`. + + .. versionchanged:: 3.3 + Allow :class:`bytearray` objects. + +``C`` (:class:`str` of length 1) [int] + Convert a Python character, represented as a :class:`str` object of + length 1, to a C :c:type:`int`. + +``f`` (:class:`float`) [float] + Convert a Python floating point number to a C :c:type:`float`. + +``d`` (:class:`float`) [double] + Convert a Python floating point number to a C :c:type:`double`. + +``D`` (:class:`complex`) [Py_complex] + Convert a Python complex number to a C :c:type:`Py_complex` structure. + +Other objects +------------- + +``O`` (object) [PyObject \*] + Store a Python object (without any conversion) in a C object pointer. The C + program thus receives the actual object that was passed. The object's reference + count is not increased. The pointer stored is not *NULL*. + +``O!`` (object) [*typeobject*, PyObject \*] + Store a Python object in a C object pointer. This is similar to ``O``, but + takes two C arguments: the first is the address of a Python type object, the + second is the address of the C variable (of type :c:type:`PyObject\*`) into which + the object pointer is stored. If the Python object does not have the required + type, :exc:`TypeError` is raised. + +.. _o_ampersand: + +``O&`` (object) [*converter*, *anything*] + Convert a Python object to a C variable through a *converter* function. This + takes two arguments: the first is a function, the second is the address of a C + variable (of arbitrary type), converted to :c:type:`void \*`. The *converter* + function in turn is called as follows:: + + status = converter(object, address); + + where *object* is the Python object to be converted and *address* is the + :c:type:`void\*` argument that was passed to the :c:func:`PyArg_Parse\*` function. + The returned *status* should be ``1`` for a successful conversion and ``0`` if + the conversion has failed. When the conversion fails, the *converter* function + should raise an exception and leave the content of *address* unmodified. + + If the *converter* returns ``Py_CLEANUP_SUPPORTED``, it may get called a + second time if the argument parsing eventually fails, giving the converter a + chance to release any memory that it had already allocated. In this second + call, the *object* parameter will be NULL; *address* will have the same value + as in the original call. + + .. versionchanged:: 3.1 + ``Py_CLEANUP_SUPPORTED`` was added. + +``p`` (:class:`bool`) [int] + Tests the value passed in for truth (a boolean **p**\ redicate) and converts + the result to its equivalent C true/false integer value. + Sets the int to ``1`` if the expression was true and ``0`` if it was false. + This accepts any valid Python value. See :ref:`truth` for more + information about how Python tests values for truth. + + .. versionadded:: 3.3 + +``(items)`` (:class:`tuple`) [*matching-items*] + The object must be a Python sequence whose length is the number of format units + in *items*. The C arguments must correspond to the individual format units in + *items*. Format units for sequences may be nested. + +It is possible to pass "long" integers (integers whose value exceeds the +platform's :const:`LONG_MAX`) however no proper range checking is done --- the +most significant bits are silently truncated when the receiving field is too +small to receive the value (actually, the semantics are inherited from downcasts +in C --- your mileage may vary). + +A few other characters have a meaning in a format string. These may not occur +inside nested parentheses. They are: + +``|`` + Indicates that the remaining arguments in the Python argument list are optional. + The C variables corresponding to optional arguments should be initialized to + their default value --- when an optional argument is not specified, + :c:func:`PyArg_ParseTuple` does not touch the contents of the corresponding C + variable(s). + +``$`` + :c:func:`PyArg_ParseTupleAndKeywords` only: + Indicates that the remaining arguments in the Python argument list are + keyword-only. Currently, all keyword-only arguments must also be optional + arguments, so ``|`` must always be specified before ``$`` in the format + string. + + .. versionadded:: 3.3 + +``:`` + The list of format units ends here; the string after the colon is used as the + function name in error messages (the "associated value" of the exception that + :c:func:`PyArg_ParseTuple` raises). + +``;`` + The list of format units ends here; the string after the semicolon is used as + the error message *instead* of the default error message. ``:`` and ``;`` + mutually exclude each other. + +Note that any Python object references which are provided to the caller are +*borrowed* references; do not decrement their reference count! + +Additional arguments passed to these functions must be addresses of variables +whose type is determined by the format string; these are used to store values +from the input tuple. There are a few cases, as described in the list of format +units above, where these parameters are used as input values; they should match +what is specified for the corresponding format unit in that case. + +For the conversion to succeed, the *arg* object must match the format +and the format must be exhausted. On success, the +:c:func:`PyArg_Parse\*` functions return true, otherwise they return +false and raise an appropriate exception. When the +:c:func:`PyArg_Parse\*` functions fail due to conversion failure in one +of the format units, the variables at the addresses corresponding to that +and the following format units are left untouched. + +API Functions +------------- + +.. c:function:: int PyArg_ParseTuple(PyObject *args, const char *format, ...) + + Parse the parameters of a function that takes only positional parameters into + local variables. Returns true on success; on failure, it returns false and + raises the appropriate exception. + + +.. c:function:: int PyArg_VaParse(PyObject *args, const char *format, va_list vargs) + + Identical to :c:func:`PyArg_ParseTuple`, except that it accepts a va_list rather + than a variable number of arguments. + + +.. c:function:: int PyArg_ParseTupleAndKeywords(PyObject *args, PyObject *kw, const char *format, char *keywords[], ...) + + Parse the parameters of a function that takes both positional and keyword + parameters into local variables. The *keywords* argument is a + *NULL*-terminated array of keyword parameter names. Empty names denote + :ref:`positional-only parameters `. + Returns true on success; on failure, it returns false and raises the + appropriate exception. + + .. versionchanged:: 3.6 + Added support for :ref:`positional-only parameters + `. + + +.. c:function:: int PyArg_VaParseTupleAndKeywords(PyObject *args, PyObject *kw, const char *format, char *keywords[], va_list vargs) + + Identical to :c:func:`PyArg_ParseTupleAndKeywords`, except that it accepts a + va_list rather than a variable number of arguments. + + +.. c:function:: int PyArg_ValidateKeywordArguments(PyObject *) + + Ensure that the keys in the keywords argument dictionary are strings. This + is only needed if :c:func:`PyArg_ParseTupleAndKeywords` is not used, since the + latter already does this check. + + .. versionadded:: 3.2 + + +.. XXX deprecated, will be removed +.. c:function:: int PyArg_Parse(PyObject *args, const char *format, ...) + + Function used to deconstruct the argument lists of "old-style" functions --- + these are functions which use the :const:`METH_OLDARGS` parameter parsing + method, which has been removed in Python 3. This is not recommended for use + in parameter parsing in new code, and most code in the standard interpreter + has been modified to no longer use this for that purpose. It does remain a + convenient way to decompose other tuples, however, and may continue to be + used for that purpose. + + +.. c:function:: int PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...) + + A simpler form of parameter retrieval which does not use a format string to + specify the types of the arguments. Functions which use this method to retrieve + their parameters should be declared as :const:`METH_VARARGS` in function or + method tables. The tuple containing the actual parameters should be passed as + *args*; it must actually be a tuple. The length of the tuple must be at least + *min* and no more than *max*; *min* and *max* may be equal. Additional + arguments must be passed to the function, each of which should be a pointer to a + :c:type:`PyObject\*` variable; these will be filled in with the values from + *args*; they will contain borrowed references. The variables which correspond + to optional parameters not given by *args* will not be filled in; these should + be initialized by the caller. This function returns true on success and false if + *args* is not a tuple or contains the wrong number of elements; an exception + will be set if there was a failure. + + This is an example of the use of this function, taken from the sources for the + :mod:`_weakref` helper module for weak references:: + + static PyObject * + weakref_ref(PyObject *self, PyObject *args) + { + PyObject *object; + PyObject *callback = NULL; + PyObject *result = NULL; + + if (PyArg_UnpackTuple(args, "ref", 1, 2, &object, &callback)) { + result = PyWeakref_NewRef(object, callback); + } + return result; + } + + The call to :c:func:`PyArg_UnpackTuple` in this example is entirely equivalent to + this call to :c:func:`PyArg_ParseTuple`:: + + PyArg_ParseTuple(args, "O|O:ref", &object, &callback) + + +--------------- +Building values +--------------- + +.. c:function:: PyObject* Py_BuildValue(const char *format, ...) + + Create a new value based on a format string similar to those accepted by the + :c:func:`PyArg_Parse\*` family of functions and a sequence of values. Returns + the value or *NULL* in the case of an error; an exception will be raised if + *NULL* is returned. + + :c:func:`Py_BuildValue` does not always build a tuple. It builds a tuple only if + its format string contains two or more format units. If the format string is + empty, it returns ``None``; if it contains exactly one format unit, it returns + whatever object is described by that format unit. To force it to return a tuple + of size 0 or one, parenthesize the format string. + + When memory buffers are passed as parameters to supply data to build objects, as + for the ``s`` and ``s#`` formats, the required data is copied. Buffers provided + by the caller are never referenced by the objects created by + :c:func:`Py_BuildValue`. In other words, if your code invokes :c:func:`malloc` + and passes the allocated memory to :c:func:`Py_BuildValue`, your code is + responsible for calling :c:func:`free` for that memory once + :c:func:`Py_BuildValue` returns. + + In the following description, the quoted form is the format unit; the entry in + (round) parentheses is the Python object type that the format unit will return; + and the entry in [square] brackets is the type of the C value(s) to be passed. + + The characters space, tab, colon and comma are ignored in format strings (but + not within format units such as ``s#``). This can be used to make long format + strings a tad more readable. + + ``s`` (:class:`str` or ``None``) [const char \*] + Convert a null-terminated C string to a Python :class:`str` object using ``'utf-8'`` + encoding. If the C string pointer is *NULL*, ``None`` is used. + + ``s#`` (:class:`str` or ``None``) [const char \*, int] + Convert a C string and its length to a Python :class:`str` object using ``'utf-8'`` + encoding. If the C string pointer is *NULL*, the length is ignored and + ``None`` is returned. + + ``y`` (:class:`bytes`) [const char \*] + This converts a C string to a Python :class:`bytes` object. If the C + string pointer is *NULL*, ``None`` is returned. + + ``y#`` (:class:`bytes`) [const char \*, int] + This converts a C string and its lengths to a Python object. If the C + string pointer is *NULL*, ``None`` is returned. + + ``z`` (:class:`str` or ``None``) [const char \*] + Same as ``s``. + + ``z#`` (:class:`str` or ``None``) [const char \*, int] + Same as ``s#``. + + ``u`` (:class:`str`) [const wchar_t \*] + Convert a null-terminated :c:type:`wchar_t` buffer of Unicode (UTF-16 or UCS-4) + data to a Python Unicode object. If the Unicode buffer pointer is *NULL*, + ``None`` is returned. + + ``u#`` (:class:`str`) [const wchar_t \*, int] + Convert a Unicode (UTF-16 or UCS-4) data buffer and its length to a Python + Unicode object. If the Unicode buffer pointer is *NULL*, the length is ignored + and ``None`` is returned. + + ``U`` (:class:`str` or ``None``) [const char \*] + Same as ``s``. + + ``U#`` (:class:`str` or ``None``) [const char \*, int] + Same as ``s#``. + + ``i`` (:class:`int`) [int] + Convert a plain C :c:type:`int` to a Python integer object. + + ``b`` (:class:`int`) [char] + Convert a plain C :c:type:`char` to a Python integer object. + + ``h`` (:class:`int`) [short int] + Convert a plain C :c:type:`short int` to a Python integer object. + + ``l`` (:class:`int`) [long int] + Convert a C :c:type:`long int` to a Python integer object. + + ``B`` (:class:`int`) [unsigned char] + Convert a C :c:type:`unsigned char` to a Python integer object. + + ``H`` (:class:`int`) [unsigned short int] + Convert a C :c:type:`unsigned short int` to a Python integer object. + + ``I`` (:class:`int`) [unsigned int] + Convert a C :c:type:`unsigned int` to a Python integer object. + + ``k`` (:class:`int`) [unsigned long] + Convert a C :c:type:`unsigned long` to a Python integer object. + + ``L`` (:class:`int`) [long long] + Convert a C :c:type:`long long` to a Python integer object. + + ``K`` (:class:`int`) [unsigned long long] + Convert a C :c:type:`unsigned long long` to a Python integer object. + + ``n`` (:class:`int`) [Py_ssize_t] + Convert a C :c:type:`Py_ssize_t` to a Python integer. + + ``c`` (:class:`bytes` of length 1) [char] + Convert a C :c:type:`int` representing a byte to a Python :class:`bytes` object of + length 1. + + ``C`` (:class:`str` of length 1) [int] + Convert a C :c:type:`int` representing a character to Python :class:`str` + object of length 1. + + ``d`` (:class:`float`) [double] + Convert a C :c:type:`double` to a Python floating point number. + + ``f`` (:class:`float`) [float] + Convert a C :c:type:`float` to a Python floating point number. + + ``D`` (:class:`complex`) [Py_complex \*] + Convert a C :c:type:`Py_complex` structure to a Python complex number. + + ``O`` (object) [PyObject \*] + Pass a Python object untouched (except for its reference count, which is + incremented by one). If the object passed in is a *NULL* pointer, it is assumed + that this was caused because the call producing the argument found an error and + set an exception. Therefore, :c:func:`Py_BuildValue` will return *NULL* but won't + raise an exception. If no exception has been raised yet, :exc:`SystemError` is + set. + + ``S`` (object) [PyObject \*] + Same as ``O``. + + ``N`` (object) [PyObject \*] + Same as ``O``, except it doesn't increment the reference count on the object. + Useful when the object is created by a call to an object constructor in the + argument list. + + ``O&`` (object) [*converter*, *anything*] + Convert *anything* to a Python object through a *converter* function. The + function is called with *anything* (which should be compatible with :c:type:`void + \*`) as its argument and should return a "new" Python object, or *NULL* if an + error occurred. + + ``(items)`` (:class:`tuple`) [*matching-items*] + Convert a sequence of C values to a Python tuple with the same number of items. + + ``[items]`` (:class:`list`) [*matching-items*] + Convert a sequence of C values to a Python list with the same number of items. + + ``{items}`` (:class:`dict`) [*matching-items*] + Convert a sequence of C values to a Python dictionary. Each pair of consecutive + C values adds one item to the dictionary, serving as key and value, + respectively. + + If there is an error in the format string, the :exc:`SystemError` exception is + set and *NULL* returned. + +.. c:function:: PyObject* Py_VaBuildValue(const char *format, va_list vargs) + + Identical to :c:func:`Py_BuildValue`, except that it accepts a va_list + rather than a variable number of arguments. diff --git a/python-3.7.4-docs-html/_sources/c-api/bool.rst.txt b/python-3.7.4-docs-html/_sources/c-api/bool.rst.txt new file mode 100644 index 0000000..a9fb342 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/bool.rst.txt @@ -0,0 +1,46 @@ +.. highlightlang:: c + +.. _boolobjects: + +Boolean Objects +--------------- + +Booleans in Python are implemented as a subclass of integers. There are only +two booleans, :const:`Py_False` and :const:`Py_True`. As such, the normal +creation and deletion functions don't apply to booleans. The following macros +are available, however. + + +.. c:function:: int PyBool_Check(PyObject *o) + + Return true if *o* is of type :c:data:`PyBool_Type`. + + +.. c:var:: PyObject* Py_False + + The Python ``False`` object. This object has no methods. It needs to be + treated just like any other object with respect to reference counts. + + +.. c:var:: PyObject* Py_True + + The Python ``True`` object. This object has no methods. It needs to be treated + just like any other object with respect to reference counts. + + +.. c:macro:: Py_RETURN_FALSE + + Return :const:`Py_False` from a function, properly incrementing its reference + count. + + +.. c:macro:: Py_RETURN_TRUE + + Return :const:`Py_True` from a function, properly incrementing its reference + count. + + +.. c:function:: PyObject* PyBool_FromLong(long v) + + Return a new reference to :const:`Py_True` or :const:`Py_False` depending on the + truth value of *v*. diff --git a/python-3.7.4-docs-html/_sources/c-api/buffer.rst.txt b/python-3.7.4-docs-html/_sources/c-api/buffer.rst.txt new file mode 100644 index 0000000..c7c1e3c --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/buffer.rst.txt @@ -0,0 +1,508 @@ +.. highlightlang:: c + +.. index:: + single: buffer protocol + single: buffer interface; (see buffer protocol) + single: buffer object; (see buffer protocol) + +.. _bufferobjects: + +Buffer Protocol +--------------- + +.. sectionauthor:: Greg Stein +.. sectionauthor:: Benjamin Peterson +.. sectionauthor:: Stefan Krah + + +Certain objects available in Python wrap access to an underlying memory +array or *buffer*. Such objects include the built-in :class:`bytes` and +:class:`bytearray`, and some extension types like :class:`array.array`. +Third-party libraries may define their own types for special purposes, such +as image processing or numeric analysis. + +While each of these types have their own semantics, they share the common +characteristic of being backed by a possibly large memory buffer. It is +then desirable, in some situations, to access that buffer directly and +without intermediate copying. + +Python provides such a facility at the C level in the form of the :ref:`buffer +protocol `. This protocol has two sides: + +.. index:: single: PyBufferProcs + +- on the producer side, a type can export a "buffer interface" which allows + objects of that type to expose information about their underlying buffer. + This interface is described in the section :ref:`buffer-structs`; + +- on the consumer side, several means are available to obtain a pointer to + the raw underlying data of an object (for example a method parameter). + +Simple objects such as :class:`bytes` and :class:`bytearray` expose their +underlying buffer in byte-oriented form. Other forms are possible; for example, +the elements exposed by an :class:`array.array` can be multi-byte values. + +An example consumer of the buffer interface is the :meth:`~io.BufferedIOBase.write` +method of file objects: any object that can export a series of bytes through +the buffer interface can be written to a file. While :meth:`write` only +needs read-only access to the internal contents of the object passed to it, +other methods such as :meth:`~io.BufferedIOBase.readinto` need write access +to the contents of their argument. The buffer interface allows objects to +selectively allow or reject exporting of read-write and read-only buffers. + +There are two ways for a consumer of the buffer interface to acquire a buffer +over a target object: + +* call :c:func:`PyObject_GetBuffer` with the right parameters; + +* call :c:func:`PyArg_ParseTuple` (or one of its siblings) with one of the + ``y*``, ``w*`` or ``s*`` :ref:`format codes `. + +In both cases, :c:func:`PyBuffer_Release` must be called when the buffer +isn't needed anymore. Failure to do so could lead to various issues such as +resource leaks. + + +.. _buffer-structure: + +Buffer structure +================ + +Buffer structures (or simply "buffers") are useful as a way to expose the +binary data from another object to the Python programmer. They can also be +used as a zero-copy slicing mechanism. Using their ability to reference a +block of memory, it is possible to expose any data to the Python programmer +quite easily. The memory could be a large, constant array in a C extension, +it could be a raw block of memory for manipulation before passing to an +operating system library, or it could be used to pass around structured data +in its native, in-memory format. + +Contrary to most data types exposed by the Python interpreter, buffers +are not :c:type:`PyObject` pointers but rather simple C structures. This +allows them to be created and copied very simply. When a generic wrapper +around a buffer is needed, a :ref:`memoryview ` object +can be created. + +For short instructions how to write an exporting object, see +:ref:`Buffer Object Structures `. For obtaining +a buffer, see :c:func:`PyObject_GetBuffer`. + +.. c:type:: Py_buffer + + .. c:member:: void \*buf + + A pointer to the start of the logical structure described by the buffer + fields. This can be any location within the underlying physical memory + block of the exporter. For example, with negative :c:member:`~Py_buffer.strides` + the value may point to the end of the memory block. + + For :term:`contiguous` arrays, the value points to the beginning of + the memory block. + + .. c:member:: void \*obj + + A new reference to the exporting object. The reference is owned by + the consumer and automatically decremented and set to *NULL* by + :c:func:`PyBuffer_Release`. The field is the equivalent of the return + value of any standard C-API function. + + As a special case, for *temporary* buffers that are wrapped by + :c:func:`PyMemoryView_FromBuffer` or :c:func:`PyBuffer_FillInfo` + this field is *NULL*. In general, exporting objects MUST NOT + use this scheme. + + .. c:member:: Py_ssize_t len + + ``product(shape) * itemsize``. For contiguous arrays, this is the length + of the underlying memory block. For non-contiguous arrays, it is the length + that the logical structure would have if it were copied to a contiguous + representation. + + Accessing ``((char *)buf)[0] up to ((char *)buf)[len-1]`` is only valid + if the buffer has been obtained by a request that guarantees contiguity. In + most cases such a request will be :c:macro:`PyBUF_SIMPLE` or :c:macro:`PyBUF_WRITABLE`. + + .. c:member:: int readonly + + An indicator of whether the buffer is read-only. This field is controlled + by the :c:macro:`PyBUF_WRITABLE` flag. + + .. c:member:: Py_ssize_t itemsize + + Item size in bytes of a single element. Same as the value of :func:`struct.calcsize` + called on non-NULL :c:member:`~Py_buffer.format` values. + + Important exception: If a consumer requests a buffer without the + :c:macro:`PyBUF_FORMAT` flag, :c:member:`~Py_buffer.format` will + be set to *NULL*, but :c:member:`~Py_buffer.itemsize` still has + the value for the original format. + + If :c:member:`~Py_buffer.shape` is present, the equality + ``product(shape) * itemsize == len`` still holds and the consumer + can use :c:member:`~Py_buffer.itemsize` to navigate the buffer. + + If :c:member:`~Py_buffer.shape` is *NULL* as a result of a :c:macro:`PyBUF_SIMPLE` + or a :c:macro:`PyBUF_WRITABLE` request, the consumer must disregard + :c:member:`~Py_buffer.itemsize` and assume ``itemsize == 1``. + + .. c:member:: const char \*format + + A *NUL* terminated string in :mod:`struct` module style syntax describing + the contents of a single item. If this is *NULL*, ``"B"`` (unsigned bytes) + is assumed. + + This field is controlled by the :c:macro:`PyBUF_FORMAT` flag. + + .. c:member:: int ndim + + The number of dimensions the memory represents as an n-dimensional array. + If it is ``0``, :c:member:`~Py_buffer.buf` points to a single item representing + a scalar. In this case, :c:member:`~Py_buffer.shape`, :c:member:`~Py_buffer.strides` + and :c:member:`~Py_buffer.suboffsets` MUST be *NULL*. + + The macro :c:macro:`PyBUF_MAX_NDIM` limits the maximum number of dimensions + to 64. Exporters MUST respect this limit, consumers of multi-dimensional + buffers SHOULD be able to handle up to :c:macro:`PyBUF_MAX_NDIM` dimensions. + + .. c:member:: Py_ssize_t \*shape + + An array of :c:type:`Py_ssize_t` of length :c:member:`~Py_buffer.ndim` + indicating the shape of the memory as an n-dimensional array. Note that + ``shape[0] * ... * shape[ndim-1] * itemsize`` MUST be equal to + :c:member:`~Py_buffer.len`. + + Shape values are restricted to ``shape[n] >= 0``. The case + ``shape[n] == 0`` requires special attention. See `complex arrays`_ + for further information. + + The shape array is read-only for the consumer. + + .. c:member:: Py_ssize_t \*strides + + An array of :c:type:`Py_ssize_t` of length :c:member:`~Py_buffer.ndim` + giving the number of bytes to skip to get to a new element in each + dimension. + + Stride values can be any integer. For regular arrays, strides are + usually positive, but a consumer MUST be able to handle the case + ``strides[n] <= 0``. See `complex arrays`_ for further information. + + The strides array is read-only for the consumer. + + .. c:member:: Py_ssize_t \*suboffsets + + An array of :c:type:`Py_ssize_t` of length :c:member:`~Py_buffer.ndim`. + If ``suboffsets[n] >= 0``, the values stored along the nth dimension are + pointers and the suboffset value dictates how many bytes to add to each + pointer after de-referencing. A suboffset value that is negative + indicates that no de-referencing should occur (striding in a contiguous + memory block). + + If all suboffsets are negative (i.e. no de-referencing is needed), then + this field must be NULL (the default value). + + This type of array representation is used by the Python Imaging Library + (PIL). See `complex arrays`_ for further information how to access elements + of such an array. + + The suboffsets array is read-only for the consumer. + + .. c:member:: void \*internal + + This is for use internally by the exporting object. For example, this + might be re-cast as an integer by the exporter and used to store flags + about whether or not the shape, strides, and suboffsets arrays must be + freed when the buffer is released. The consumer MUST NOT alter this + value. + +.. _buffer-request-types: + +Buffer request types +==================== + +Buffers are usually obtained by sending a buffer request to an exporting +object via :c:func:`PyObject_GetBuffer`. Since the complexity of the logical +structure of the memory can vary drastically, the consumer uses the *flags* +argument to specify the exact buffer type it can handle. + +All :c:data:`Py_buffer` fields are unambiguously defined by the request +type. + +request-independent fields +~~~~~~~~~~~~~~~~~~~~~~~~~~ +The following fields are not influenced by *flags* and must always be filled in +with the correct values: :c:member:`~Py_buffer.obj`, :c:member:`~Py_buffer.buf`, +:c:member:`~Py_buffer.len`, :c:member:`~Py_buffer.itemsize`, :c:member:`~Py_buffer.ndim`. + + +readonly, format +~~~~~~~~~~~~~~~~ + + .. c:macro:: PyBUF_WRITABLE + + Controls the :c:member:`~Py_buffer.readonly` field. If set, the exporter + MUST provide a writable buffer or else report failure. Otherwise, the + exporter MAY provide either a read-only or writable buffer, but the choice + MUST be consistent for all consumers. + + .. c:macro:: PyBUF_FORMAT + + Controls the :c:member:`~Py_buffer.format` field. If set, this field MUST + be filled in correctly. Otherwise, this field MUST be *NULL*. + + +:c:macro:`PyBUF_WRITABLE` can be \|'d to any of the flags in the next section. +Since :c:macro:`PyBUF_SIMPLE` is defined as 0, :c:macro:`PyBUF_WRITABLE` +can be used as a stand-alone flag to request a simple writable buffer. + +:c:macro:`PyBUF_FORMAT` can be \|'d to any of the flags except :c:macro:`PyBUF_SIMPLE`. +The latter already implies format ``B`` (unsigned bytes). + + +shape, strides, suboffsets +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The flags that control the logical structure of the memory are listed +in decreasing order of complexity. Note that each flag contains all bits +of the flags below it. + +.. tabularcolumns:: |p{0.35\linewidth}|l|l|l| + ++-----------------------------+-------+---------+------------+ +| Request | shape | strides | suboffsets | ++=============================+=======+=========+============+ +| .. c:macro:: PyBUF_INDIRECT | yes | yes | if needed | ++-----------------------------+-------+---------+------------+ +| .. c:macro:: PyBUF_STRIDES | yes | yes | NULL | ++-----------------------------+-------+---------+------------+ +| .. c:macro:: PyBUF_ND | yes | NULL | NULL | ++-----------------------------+-------+---------+------------+ +| .. c:macro:: PyBUF_SIMPLE | NULL | NULL | NULL | ++-----------------------------+-------+---------+------------+ + + +.. index:: contiguous, C-contiguous, Fortran contiguous + +contiguity requests +~~~~~~~~~~~~~~~~~~~ + +C or Fortran :term:`contiguity ` can be explicitly requested, +with and without stride information. Without stride information, the buffer +must be C-contiguous. + +.. tabularcolumns:: |p{0.35\linewidth}|l|l|l|l| + ++-----------------------------------+-------+---------+------------+--------+ +| Request | shape | strides | suboffsets | contig | ++===================================+=======+=========+============+========+ +| .. c:macro:: PyBUF_C_CONTIGUOUS | yes | yes | NULL | C | ++-----------------------------------+-------+---------+------------+--------+ +| .. c:macro:: PyBUF_F_CONTIGUOUS | yes | yes | NULL | F | ++-----------------------------------+-------+---------+------------+--------+ +| .. c:macro:: PyBUF_ANY_CONTIGUOUS | yes | yes | NULL | C or F | ++-----------------------------------+-------+---------+------------+--------+ +| .. c:macro:: PyBUF_ND | yes | NULL | NULL | C | ++-----------------------------------+-------+---------+------------+--------+ + + +compound requests +~~~~~~~~~~~~~~~~~ + +All possible requests are fully defined by some combination of the flags in +the previous section. For convenience, the buffer protocol provides frequently +used combinations as single flags. + +In the following table *U* stands for undefined contiguity. The consumer would +have to call :c:func:`PyBuffer_IsContiguous` to determine contiguity. + +.. tabularcolumns:: |p{0.35\linewidth}|l|l|l|l|l|l| + ++-------------------------------+-------+---------+------------+--------+----------+--------+ +| Request | shape | strides | suboffsets | contig | readonly | format | ++===============================+=======+=========+============+========+==========+========+ +| .. c:macro:: PyBUF_FULL | yes | yes | if needed | U | 0 | yes | ++-------------------------------+-------+---------+------------+--------+----------+--------+ +| .. c:macro:: PyBUF_FULL_RO | yes | yes | if needed | U | 1 or 0 | yes | ++-------------------------------+-------+---------+------------+--------+----------+--------+ +| .. c:macro:: PyBUF_RECORDS | yes | yes | NULL | U | 0 | yes | ++-------------------------------+-------+---------+------------+--------+----------+--------+ +| .. c:macro:: PyBUF_RECORDS_RO | yes | yes | NULL | U | 1 or 0 | yes | ++-------------------------------+-------+---------+------------+--------+----------+--------+ +| .. c:macro:: PyBUF_STRIDED | yes | yes | NULL | U | 0 | NULL | ++-------------------------------+-------+---------+------------+--------+----------+--------+ +| .. c:macro:: PyBUF_STRIDED_RO | yes | yes | NULL | U | 1 or 0 | NULL | ++-------------------------------+-------+---------+------------+--------+----------+--------+ +| .. c:macro:: PyBUF_CONTIG | yes | NULL | NULL | C | 0 | NULL | ++-------------------------------+-------+---------+------------+--------+----------+--------+ +| .. c:macro:: PyBUF_CONTIG_RO | yes | NULL | NULL | C | 1 or 0 | NULL | ++-------------------------------+-------+---------+------------+--------+----------+--------+ + + +Complex arrays +============== + +NumPy-style: shape and strides +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The logical structure of NumPy-style arrays is defined by :c:member:`~Py_buffer.itemsize`, +:c:member:`~Py_buffer.ndim`, :c:member:`~Py_buffer.shape` and :c:member:`~Py_buffer.strides`. + +If ``ndim == 0``, the memory location pointed to by :c:member:`~Py_buffer.buf` is +interpreted as a scalar of size :c:member:`~Py_buffer.itemsize`. In that case, +both :c:member:`~Py_buffer.shape` and :c:member:`~Py_buffer.strides` are *NULL*. + +If :c:member:`~Py_buffer.strides` is *NULL*, the array is interpreted as +a standard n-dimensional C-array. Otherwise, the consumer must access an +n-dimensional array as follows: + + ``ptr = (char *)buf + indices[0] * strides[0] + ... + indices[n-1] * strides[n-1]`` + ``item = *((typeof(item) *)ptr);`` + + +As noted above, :c:member:`~Py_buffer.buf` can point to any location within +the actual memory block. An exporter can check the validity of a buffer with +this function: + +.. code-block:: python + + def verify_structure(memlen, itemsize, ndim, shape, strides, offset): + """Verify that the parameters represent a valid array within + the bounds of the allocated memory: + char *mem: start of the physical memory block + memlen: length of the physical memory block + offset: (char *)buf - mem + """ + if offset % itemsize: + return False + if offset < 0 or offset+itemsize > memlen: + return False + if any(v % itemsize for v in strides): + return False + + if ndim <= 0: + return ndim == 0 and not shape and not strides + if 0 in shape: + return True + + imin = sum(strides[j]*(shape[j]-1) for j in range(ndim) + if strides[j] <= 0) + imax = sum(strides[j]*(shape[j]-1) for j in range(ndim) + if strides[j] > 0) + + return 0 <= offset+imin and offset+imax+itemsize <= memlen + + +PIL-style: shape, strides and suboffsets +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In addition to the regular items, PIL-style arrays can contain pointers +that must be followed in order to get to the next element in a dimension. +For example, the regular three-dimensional C-array ``char v[2][2][3]`` can +also be viewed as an array of 2 pointers to 2 two-dimensional arrays: +``char (*v[2])[2][3]``. In suboffsets representation, those two pointers +can be embedded at the start of :c:member:`~Py_buffer.buf`, pointing +to two ``char x[2][3]`` arrays that can be located anywhere in memory. + + +Here is a function that returns a pointer to the element in an N-D array +pointed to by an N-dimensional index when there are both non-NULL strides +and suboffsets:: + + void *get_item_pointer(int ndim, void *buf, Py_ssize_t *strides, + Py_ssize_t *suboffsets, Py_ssize_t *indices) { + char *pointer = (char*)buf; + int i; + for (i = 0; i < ndim; i++) { + pointer += strides[i] * indices[i]; + if (suboffsets[i] >=0 ) { + pointer = *((char**)pointer) + suboffsets[i]; + } + } + return (void*)pointer; + } + + +Buffer-related functions +======================== + +.. c:function:: int PyObject_CheckBuffer(PyObject *obj) + + Return ``1`` if *obj* supports the buffer interface otherwise ``0``. When ``1`` is + returned, it doesn't guarantee that :c:func:`PyObject_GetBuffer` will + succeed. This function always succeeds. + + +.. c:function:: int PyObject_GetBuffer(PyObject *exporter, Py_buffer *view, int flags) + + Send a request to *exporter* to fill in *view* as specified by *flags*. + If the exporter cannot provide a buffer of the exact type, it MUST raise + :c:data:`PyExc_BufferError`, set :c:member:`view->obj` to *NULL* and + return ``-1``. + + On success, fill in *view*, set :c:member:`view->obj` to a new reference + to *exporter* and return 0. In the case of chained buffer providers + that redirect requests to a single object, :c:member:`view->obj` MAY + refer to this object instead of *exporter* (See :ref:`Buffer Object Structures `). + + Successful calls to :c:func:`PyObject_GetBuffer` must be paired with calls + to :c:func:`PyBuffer_Release`, similar to :c:func:`malloc` and :c:func:`free`. + Thus, after the consumer is done with the buffer, :c:func:`PyBuffer_Release` + must be called exactly once. + + +.. c:function:: void PyBuffer_Release(Py_buffer *view) + + Release the buffer *view* and decrement the reference count for + :c:member:`view->obj`. This function MUST be called when the buffer + is no longer being used, otherwise reference leaks may occur. + + It is an error to call this function on a buffer that was not obtained via + :c:func:`PyObject_GetBuffer`. + + +.. c:function:: Py_ssize_t PyBuffer_SizeFromFormat(const char *) + + Return the implied :c:data:`~Py_buffer.itemsize` from :c:data:`~Py_buffer.format`. + This function is not yet implemented. + + +.. c:function:: int PyBuffer_IsContiguous(Py_buffer *view, char order) + + Return ``1`` if the memory defined by the *view* is C-style (*order* is + ``'C'``) or Fortran-style (*order* is ``'F'``) :term:`contiguous` or either one + (*order* is ``'A'``). Return ``0`` otherwise. This function always succeeds. + + +.. c:function:: int PyBuffer_ToContiguous(void *buf, Py_buffer *src, Py_ssize_t len, char order) + + Copy *len* bytes from *src* to its contiguous representation in *buf*. + *order* can be ``'C'`` or ``'F'`` (for C-style or Fortran-style ordering). + ``0`` is returned on success, ``-1`` on error. + + This function fails if *len* != *src->len*. + + +.. c:function:: void PyBuffer_FillContiguousStrides(int ndims, Py_ssize_t *shape, Py_ssize_t *strides, int itemsize, char order) + + Fill the *strides* array with byte-strides of a :term:`contiguous` (C-style if + *order* is ``'C'`` or Fortran-style if *order* is ``'F'``) array of the + given shape with the given number of bytes per element. + + +.. c:function:: int PyBuffer_FillInfo(Py_buffer *view, PyObject *exporter, void *buf, Py_ssize_t len, int readonly, int flags) + + Handle buffer requests for an exporter that wants to expose *buf* of size *len* + with writability set according to *readonly*. *buf* is interpreted as a sequence + of unsigned bytes. + + The *flags* argument indicates the request type. This function always fills in + *view* as specified by flags, unless *buf* has been designated as read-only + and :c:macro:`PyBUF_WRITABLE` is set in *flags*. + + On success, set :c:member:`view->obj` to a new reference to *exporter* and + return 0. Otherwise, raise :c:data:`PyExc_BufferError`, set + :c:member:`view->obj` to *NULL* and return ``-1``; + + If this function is used as part of a :ref:`getbufferproc `, + *exporter* MUST be set to the exporting object and *flags* must be passed + unmodified. Otherwise, *exporter* MUST be NULL. diff --git a/python-3.7.4-docs-html/_sources/c-api/bytearray.rst.txt b/python-3.7.4-docs-html/_sources/c-api/bytearray.rst.txt new file mode 100644 index 0000000..41b6e3c --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/bytearray.rst.txt @@ -0,0 +1,87 @@ +.. highlightlang:: c + +.. _bytearrayobjects: + +Byte Array Objects +------------------ + +.. index:: object: bytearray + + +.. c:type:: PyByteArrayObject + + This subtype of :c:type:`PyObject` represents a Python bytearray object. + + +.. c:var:: PyTypeObject PyByteArray_Type + + This instance of :c:type:`PyTypeObject` represents the Python bytearray type; + it is the same object as :class:`bytearray` in the Python layer. + + +Type check macros +^^^^^^^^^^^^^^^^^ + +.. c:function:: int PyByteArray_Check(PyObject *o) + + Return true if the object *o* is a bytearray object or an instance of a + subtype of the bytearray type. + + +.. c:function:: int PyByteArray_CheckExact(PyObject *o) + + Return true if the object *o* is a bytearray object, but not an instance of a + subtype of the bytearray type. + + +Direct API functions +^^^^^^^^^^^^^^^^^^^^ + +.. c:function:: PyObject* PyByteArray_FromObject(PyObject *o) + + Return a new bytearray object from any object, *o*, that implements the + :ref:`buffer protocol `. + + .. XXX expand about the buffer protocol, at least somewhere + + +.. c:function:: PyObject* PyByteArray_FromStringAndSize(const char *string, Py_ssize_t len) + + Create a new bytearray object from *string* and its length, *len*. On + failure, *NULL* is returned. + + +.. c:function:: PyObject* PyByteArray_Concat(PyObject *a, PyObject *b) + + Concat bytearrays *a* and *b* and return a new bytearray with the result. + + +.. c:function:: Py_ssize_t PyByteArray_Size(PyObject *bytearray) + + Return the size of *bytearray* after checking for a *NULL* pointer. + + +.. c:function:: char* PyByteArray_AsString(PyObject *bytearray) + + Return the contents of *bytearray* as a char array after checking for a + *NULL* pointer. The returned array always has an extra + null byte appended. + + +.. c:function:: int PyByteArray_Resize(PyObject *bytearray, Py_ssize_t len) + + Resize the internal buffer of *bytearray* to *len*. + +Macros +^^^^^^ + +These macros trade safety for speed and they don't check pointers. + +.. c:function:: char* PyByteArray_AS_STRING(PyObject *bytearray) + + Macro version of :c:func:`PyByteArray_AsString`. + + +.. c:function:: Py_ssize_t PyByteArray_GET_SIZE(PyObject *bytearray) + + Macro version of :c:func:`PyByteArray_Size`. diff --git a/python-3.7.4-docs-html/_sources/c-api/bytes.rst.txt b/python-3.7.4-docs-html/_sources/c-api/bytes.rst.txt new file mode 100644 index 0000000..5b9ebf6 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/bytes.rst.txt @@ -0,0 +1,205 @@ +.. highlightlang:: c + +.. _bytesobjects: + +Bytes Objects +------------- + +These functions raise :exc:`TypeError` when expecting a bytes parameter and are +called with a non-bytes parameter. + +.. index:: object: bytes + + +.. c:type:: PyBytesObject + + This subtype of :c:type:`PyObject` represents a Python bytes object. + + +.. c:var:: PyTypeObject PyBytes_Type + + This instance of :c:type:`PyTypeObject` represents the Python bytes type; it + is the same object as :class:`bytes` in the Python layer. + + +.. c:function:: int PyBytes_Check(PyObject *o) + + Return true if the object *o* is a bytes object or an instance of a subtype + of the bytes type. + + +.. c:function:: int PyBytes_CheckExact(PyObject *o) + + Return true if the object *o* is a bytes object, but not an instance of a + subtype of the bytes type. + + +.. c:function:: PyObject* PyBytes_FromString(const char *v) + + Return a new bytes object with a copy of the string *v* as value on success, + and *NULL* on failure. The parameter *v* must not be *NULL*; it will not be + checked. + + +.. c:function:: PyObject* PyBytes_FromStringAndSize(const char *v, Py_ssize_t len) + + Return a new bytes object with a copy of the string *v* as value and length + *len* on success, and *NULL* on failure. If *v* is *NULL*, the contents of + the bytes object are uninitialized. + + +.. c:function:: PyObject* PyBytes_FromFormat(const char *format, ...) + + Take a C :c:func:`printf`\ -style *format* string and a variable number of + arguments, calculate the size of the resulting Python bytes object and return + a bytes object with the values formatted into it. The variable arguments + must be C types and must correspond exactly to the format characters in the + *format* string. The following format characters are allowed: + + .. % XXX: This should be exactly the same as the table in PyErr_Format. + .. % One should just refer to the other. + .. % XXX: The descriptions for %zd and %zu are wrong, but the truth is complicated + .. % because not all compilers support the %z width modifier -- we fake it + .. % when necessary via interpolating PY_FORMAT_SIZE_T. + + .. tabularcolumns:: |l|l|L| + + +-------------------+---------------+--------------------------------+ + | Format Characters | Type | Comment | + +===================+===============+================================+ + | :attr:`%%` | *n/a* | The literal % character. | + +-------------------+---------------+--------------------------------+ + | :attr:`%c` | int | A single byte, | + | | | represented as a C int. | + +-------------------+---------------+--------------------------------+ + | :attr:`%d` | int | Equivalent to | + | | | ``printf("%d")``. [1]_ | + +-------------------+---------------+--------------------------------+ + | :attr:`%u` | unsigned int | Equivalent to | + | | | ``printf("%u")``. [1]_ | + +-------------------+---------------+--------------------------------+ + | :attr:`%ld` | long | Equivalent to | + | | | ``printf("%ld")``. [1]_ | + +-------------------+---------------+--------------------------------+ + | :attr:`%lu` | unsigned long | Equivalent to | + | | | ``printf("%lu")``. [1]_ | + +-------------------+---------------+--------------------------------+ + | :attr:`%zd` | Py_ssize_t | Equivalent to | + | | | ``printf("%zd")``. [1]_ | + +-------------------+---------------+--------------------------------+ + | :attr:`%zu` | size_t | Equivalent to | + | | | ``printf("%zu")``. [1]_ | + +-------------------+---------------+--------------------------------+ + | :attr:`%i` | int | Equivalent to | + | | | ``printf("%i")``. [1]_ | + +-------------------+---------------+--------------------------------+ + | :attr:`%x` | int | Equivalent to | + | | | ``printf("%x")``. [1]_ | + +-------------------+---------------+--------------------------------+ + | :attr:`%s` | const char\* | A null-terminated C character | + | | | array. | + +-------------------+---------------+--------------------------------+ + | :attr:`%p` | const void\* | The hex representation of a C | + | | | pointer. Mostly equivalent to | + | | | ``printf("%p")`` except that | + | | | it is guaranteed to start with | + | | | the literal ``0x`` regardless | + | | | of what the platform's | + | | | ``printf`` yields. | + +-------------------+---------------+--------------------------------+ + + An unrecognized format character causes all the rest of the format string to be + copied as-is to the result object, and any extra arguments discarded. + + .. [1] For integer specifiers (d, u, ld, lu, zd, zu, i, x): the 0-conversion + flag has effect even when a precision is given. + + +.. c:function:: PyObject* PyBytes_FromFormatV(const char *format, va_list vargs) + + Identical to :c:func:`PyBytes_FromFormat` except that it takes exactly two + arguments. + + +.. c:function:: PyObject* PyBytes_FromObject(PyObject *o) + + Return the bytes representation of object *o* that implements the buffer + protocol. + + +.. c:function:: Py_ssize_t PyBytes_Size(PyObject *o) + + Return the length of the bytes in bytes object *o*. + + +.. c:function:: Py_ssize_t PyBytes_GET_SIZE(PyObject *o) + + Macro form of :c:func:`PyBytes_Size` but without error checking. + + +.. c:function:: char* PyBytes_AsString(PyObject *o) + + Return a pointer to the contents of *o*. The pointer + refers to the internal buffer of *o*, which consists of ``len(o) + 1`` + bytes. The last byte in the buffer is always null, regardless of + whether there are any other null bytes. The data must not be + modified in any way, unless the object was just created using + ``PyBytes_FromStringAndSize(NULL, size)``. It must not be deallocated. If + *o* is not a bytes object at all, :c:func:`PyBytes_AsString` returns *NULL* + and raises :exc:`TypeError`. + + +.. c:function:: char* PyBytes_AS_STRING(PyObject *string) + + Macro form of :c:func:`PyBytes_AsString` but without error checking. + + +.. c:function:: int PyBytes_AsStringAndSize(PyObject *obj, char **buffer, Py_ssize_t *length) + + Return the null-terminated contents of the object *obj* + through the output variables *buffer* and *length*. + + If *length* is *NULL*, the bytes object + may not contain embedded null bytes; + if it does, the function returns ``-1`` and a :exc:`ValueError` is raised. + + The buffer refers to an internal buffer of *obj*, which includes an + additional null byte at the end (not counted in *length*). The data + must not be modified in any way, unless the object was just created using + ``PyBytes_FromStringAndSize(NULL, size)``. It must not be deallocated. If + *obj* is not a bytes object at all, :c:func:`PyBytes_AsStringAndSize` + returns ``-1`` and raises :exc:`TypeError`. + + .. versionchanged:: 3.5 + Previously, :exc:`TypeError` was raised when embedded null bytes were + encountered in the bytes object. + + +.. c:function:: void PyBytes_Concat(PyObject **bytes, PyObject *newpart) + + Create a new bytes object in *\*bytes* containing the contents of *newpart* + appended to *bytes*; the caller will own the new reference. The reference to + the old value of *bytes* will be stolen. If the new object cannot be + created, the old reference to *bytes* will still be discarded and the value + of *\*bytes* will be set to *NULL*; the appropriate exception will be set. + + +.. c:function:: void PyBytes_ConcatAndDel(PyObject **bytes, PyObject *newpart) + + Create a new bytes object in *\*bytes* containing the contents of *newpart* + appended to *bytes*. This version decrements the reference count of + *newpart*. + + +.. c:function:: int _PyBytes_Resize(PyObject **bytes, Py_ssize_t newsize) + + A way to resize a bytes object even though it is "immutable". Only use this + to build up a brand new bytes object; don't use this if the bytes may already + be known in other parts of the code. It is an error to call this function if + the refcount on the input bytes object is not one. Pass the address of an + existing bytes object as an lvalue (it may be written into), and the new size + desired. On success, *\*bytes* holds the resized bytes object and ``0`` is + returned; the address in *\*bytes* may differ from its input value. If the + reallocation fails, the original bytes object at *\*bytes* is deallocated, + *\*bytes* is set to *NULL*, :exc:`MemoryError` is set, and ``-1`` is + returned. diff --git a/python-3.7.4-docs-html/_sources/c-api/capsule.rst.txt b/python-3.7.4-docs-html/_sources/c-api/capsule.rst.txt new file mode 100644 index 0000000..8eb6695 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/capsule.rst.txt @@ -0,0 +1,157 @@ +.. highlightlang:: c + +.. _capsules: + +Capsules +-------- + +.. index:: object: Capsule + +Refer to :ref:`using-capsules` for more information on using these objects. + +.. versionadded:: 3.1 + + +.. c:type:: PyCapsule + + This subtype of :c:type:`PyObject` represents an opaque value, useful for C + extension modules who need to pass an opaque value (as a :c:type:`void\*` + pointer) through Python code to other C code. It is often used to make a C + function pointer defined in one module available to other modules, so the + regular import mechanism can be used to access C APIs defined in dynamically + loaded modules. + + +.. c:type:: PyCapsule_Destructor + + The type of a destructor callback for a capsule. Defined as:: + + typedef void (*PyCapsule_Destructor)(PyObject *); + + See :c:func:`PyCapsule_New` for the semantics of PyCapsule_Destructor + callbacks. + + +.. c:function:: int PyCapsule_CheckExact(PyObject *p) + + Return true if its argument is a :c:type:`PyCapsule`. + + +.. c:function:: PyObject* PyCapsule_New(void *pointer, const char *name, PyCapsule_Destructor destructor) + + Create a :c:type:`PyCapsule` encapsulating the *pointer*. The *pointer* + argument may not be *NULL*. + + On failure, set an exception and return *NULL*. + + The *name* string may either be *NULL* or a pointer to a valid C string. If + non-*NULL*, this string must outlive the capsule. (Though it is permitted to + free it inside the *destructor*.) + + If the *destructor* argument is not *NULL*, it will be called with the + capsule as its argument when it is destroyed. + + If this capsule will be stored as an attribute of a module, the *name* should + be specified as ``modulename.attributename``. This will enable other modules + to import the capsule using :c:func:`PyCapsule_Import`. + + +.. c:function:: void* PyCapsule_GetPointer(PyObject *capsule, const char *name) + + Retrieve the *pointer* stored in the capsule. On failure, set an exception + and return *NULL*. + + The *name* parameter must compare exactly to the name stored in the capsule. + If the name stored in the capsule is *NULL*, the *name* passed in must also + be *NULL*. Python uses the C function :c:func:`strcmp` to compare capsule + names. + + +.. c:function:: PyCapsule_Destructor PyCapsule_GetDestructor(PyObject *capsule) + + Return the current destructor stored in the capsule. On failure, set an + exception and return *NULL*. + + It is legal for a capsule to have a *NULL* destructor. This makes a *NULL* + return code somewhat ambiguous; use :c:func:`PyCapsule_IsValid` or + :c:func:`PyErr_Occurred` to disambiguate. + + +.. c:function:: void* PyCapsule_GetContext(PyObject *capsule) + + Return the current context stored in the capsule. On failure, set an + exception and return *NULL*. + + It is legal for a capsule to have a *NULL* context. This makes a *NULL* + return code somewhat ambiguous; use :c:func:`PyCapsule_IsValid` or + :c:func:`PyErr_Occurred` to disambiguate. + + +.. c:function:: const char* PyCapsule_GetName(PyObject *capsule) + + Return the current name stored in the capsule. On failure, set an exception + and return *NULL*. + + It is legal for a capsule to have a *NULL* name. This makes a *NULL* return + code somewhat ambiguous; use :c:func:`PyCapsule_IsValid` or + :c:func:`PyErr_Occurred` to disambiguate. + + +.. c:function:: void* PyCapsule_Import(const char *name, int no_block) + + Import a pointer to a C object from a capsule attribute in a module. The + *name* parameter should specify the full name to the attribute, as in + ``module.attribute``. The *name* stored in the capsule must match this + string exactly. If *no_block* is true, import the module without blocking + (using :c:func:`PyImport_ImportModuleNoBlock`). If *no_block* is false, + import the module conventionally (using :c:func:`PyImport_ImportModule`). + + Return the capsule's internal *pointer* on success. On failure, set an + exception and return *NULL*. + + +.. c:function:: int PyCapsule_IsValid(PyObject *capsule, const char *name) + + Determines whether or not *capsule* is a valid capsule. A valid capsule is + non-*NULL*, passes :c:func:`PyCapsule_CheckExact`, has a non-*NULL* pointer + stored in it, and its internal name matches the *name* parameter. (See + :c:func:`PyCapsule_GetPointer` for information on how capsule names are + compared.) + + In other words, if :c:func:`PyCapsule_IsValid` returns a true value, calls to + any of the accessors (any function starting with :c:func:`PyCapsule_Get`) are + guaranteed to succeed. + + Return a nonzero value if the object is valid and matches the name passed in. + Return ``0`` otherwise. This function will not fail. + + +.. c:function:: int PyCapsule_SetContext(PyObject *capsule, void *context) + + Set the context pointer inside *capsule* to *context*. + + Return ``0`` on success. Return nonzero and set an exception on failure. + + +.. c:function:: int PyCapsule_SetDestructor(PyObject *capsule, PyCapsule_Destructor destructor) + + Set the destructor inside *capsule* to *destructor*. + + Return ``0`` on success. Return nonzero and set an exception on failure. + + +.. c:function:: int PyCapsule_SetName(PyObject *capsule, const char *name) + + Set the name inside *capsule* to *name*. If non-*NULL*, the name must + outlive the capsule. If the previous *name* stored in the capsule was not + *NULL*, no attempt is made to free it. + + Return ``0`` on success. Return nonzero and set an exception on failure. + + +.. c:function:: int PyCapsule_SetPointer(PyObject *capsule, void *pointer) + + Set the void pointer inside *capsule* to *pointer*. The pointer may not be + *NULL*. + + Return ``0`` on success. Return nonzero and set an exception on failure. diff --git a/python-3.7.4-docs-html/_sources/c-api/cell.rst.txt b/python-3.7.4-docs-html/_sources/c-api/cell.rst.txt new file mode 100644 index 0000000..427259c --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/cell.rst.txt @@ -0,0 +1,62 @@ +.. highlightlang:: c + +.. _cell-objects: + +Cell Objects +------------ + +"Cell" objects are used to implement variables referenced by multiple scopes. +For each such variable, a cell object is created to store the value; the local +variables of each stack frame that references the value contains a reference to +the cells from outer scopes which also use that variable. When the value is +accessed, the value contained in the cell is used instead of the cell object +itself. This de-referencing of the cell object requires support from the +generated byte-code; these are not automatically de-referenced when accessed. +Cell objects are not likely to be useful elsewhere. + + +.. c:type:: PyCellObject + + The C structure used for cell objects. + + +.. c:var:: PyTypeObject PyCell_Type + + The type object corresponding to cell objects. + + +.. c:function:: int PyCell_Check(ob) + + Return true if *ob* is a cell object; *ob* must not be *NULL*. + + +.. c:function:: PyObject* PyCell_New(PyObject *ob) + + Create and return a new cell object containing the value *ob*. The parameter may + be *NULL*. + + +.. c:function:: PyObject* PyCell_Get(PyObject *cell) + + Return the contents of the cell *cell*. + + +.. c:function:: PyObject* PyCell_GET(PyObject *cell) + + Return the contents of the cell *cell*, but without checking that *cell* is + non-*NULL* and a cell object. + + +.. c:function:: int PyCell_Set(PyObject *cell, PyObject *value) + + Set the contents of the cell object *cell* to *value*. This releases the + reference to any current content of the cell. *value* may be *NULL*. *cell* + must be non-*NULL*; if it is not a cell object, ``-1`` will be returned. On + success, ``0`` will be returned. + + +.. c:function:: void PyCell_SET(PyObject *cell, PyObject *value) + + Sets the value of the cell object *cell* to *value*. No reference counts are + adjusted, and no checks are made for safety; *cell* must be non-*NULL* and must + be a cell object. diff --git a/python-3.7.4-docs-html/_sources/c-api/code.rst.txt b/python-3.7.4-docs-html/_sources/c-api/code.rst.txt new file mode 100644 index 0000000..10d89f2 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/code.rst.txt @@ -0,0 +1,48 @@ +.. highlightlang:: c + +.. _codeobjects: + +.. index:: object; code, code object + +Code Objects +------------ + +.. sectionauthor:: Jeffrey Yasskin + +Code objects are a low-level detail of the CPython implementation. +Each one represents a chunk of executable code that hasn't yet been +bound into a function. + +.. c:type:: PyCodeObject + + The C structure of the objects used to describe code objects. The + fields of this type are subject to change at any time. + + +.. c:var:: PyTypeObject PyCode_Type + + This is an instance of :c:type:`PyTypeObject` representing the Python + :class:`code` type. + + +.. c:function:: int PyCode_Check(PyObject *co) + + Return true if *co* is a :class:`code` object. + +.. c:function:: int PyCode_GetNumFree(PyCodeObject *co) + + Return the number of free variables in *co*. + +.. c:function:: PyCodeObject* PyCode_New(int argcount, int kwonlyargcount, int nlocals, int stacksize, int flags, PyObject *code, PyObject *consts, PyObject *names, PyObject *varnames, PyObject *freevars, PyObject *cellvars, PyObject *filename, PyObject *name, int firstlineno, PyObject *lnotab) + + Return a new code object. If you need a dummy code object to + create a frame, use :c:func:`PyCode_NewEmpty` instead. Calling + :c:func:`PyCode_New` directly can bind you to a precise Python + version since the definition of the bytecode changes often. + + +.. c:function:: PyCodeObject* PyCode_NewEmpty(const char *filename, const char *funcname, int firstlineno) + + Return a new empty code object with the specified filename, + function name, and first line number. It is illegal to + :func:`exec` or :func:`eval` the resulting code object. diff --git a/python-3.7.4-docs-html/_sources/c-api/codec.rst.txt b/python-3.7.4-docs-html/_sources/c-api/codec.rst.txt new file mode 100644 index 0000000..c55f199 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/codec.rst.txt @@ -0,0 +1,123 @@ +.. _codec-registry: + +Codec registry and support functions +==================================== + +.. c:function:: int PyCodec_Register(PyObject *search_function) + + Register a new codec search function. + + As side effect, this tries to load the :mod:`encodings` package, if not yet + done, to make sure that it is always first in the list of search functions. + +.. c:function:: int PyCodec_KnownEncoding(const char *encoding) + + Return ``1`` or ``0`` depending on whether there is a registered codec for + the given *encoding*. This function always succeeds. + +.. c:function:: PyObject* PyCodec_Encode(PyObject *object, const char *encoding, const char *errors) + + Generic codec based encoding API. + + *object* is passed through the encoder function found for the given + *encoding* using the error handling method defined by *errors*. *errors* may + be *NULL* to use the default method defined for the codec. Raises a + :exc:`LookupError` if no encoder can be found. + +.. c:function:: PyObject* PyCodec_Decode(PyObject *object, const char *encoding, const char *errors) + + Generic codec based decoding API. + + *object* is passed through the decoder function found for the given + *encoding* using the error handling method defined by *errors*. *errors* may + be *NULL* to use the default method defined for the codec. Raises a + :exc:`LookupError` if no encoder can be found. + + +Codec lookup API +---------------- + +In the following functions, the *encoding* string is looked up converted to all +lower-case characters, which makes encodings looked up through this mechanism +effectively case-insensitive. If no codec is found, a :exc:`KeyError` is set +and *NULL* returned. + +.. c:function:: PyObject* PyCodec_Encoder(const char *encoding) + + Get an encoder function for the given *encoding*. + +.. c:function:: PyObject* PyCodec_Decoder(const char *encoding) + + Get a decoder function for the given *encoding*. + +.. c:function:: PyObject* PyCodec_IncrementalEncoder(const char *encoding, const char *errors) + + Get an :class:`~codecs.IncrementalEncoder` object for the given *encoding*. + +.. c:function:: PyObject* PyCodec_IncrementalDecoder(const char *encoding, const char *errors) + + Get an :class:`~codecs.IncrementalDecoder` object for the given *encoding*. + +.. c:function:: PyObject* PyCodec_StreamReader(const char *encoding, PyObject *stream, const char *errors) + + Get a :class:`~codecs.StreamReader` factory function for the given *encoding*. + +.. c:function:: PyObject* PyCodec_StreamWriter(const char *encoding, PyObject *stream, const char *errors) + + Get a :class:`~codecs.StreamWriter` factory function for the given *encoding*. + + +Registry API for Unicode encoding error handlers +------------------------------------------------ + +.. c:function:: int PyCodec_RegisterError(const char *name, PyObject *error) + + Register the error handling callback function *error* under the given *name*. + This callback function will be called by a codec when it encounters + unencodable characters/undecodable bytes and *name* is specified as the error + parameter in the call to the encode/decode function. + + The callback gets a single argument, an instance of + :exc:`UnicodeEncodeError`, :exc:`UnicodeDecodeError` or + :exc:`UnicodeTranslateError` that holds information about the problematic + sequence of characters or bytes and their offset in the original string (see + :ref:`unicodeexceptions` for functions to extract this information). The + callback must either raise the given exception, or return a two-item tuple + containing the replacement for the problematic sequence, and an integer + giving the offset in the original string at which encoding/decoding should be + resumed. + + Return ``0`` on success, ``-1`` on error. + +.. c:function:: PyObject* PyCodec_LookupError(const char *name) + + Lookup the error handling callback function registered under *name*. As a + special case *NULL* can be passed, in which case the error handling callback + for "strict" will be returned. + +.. c:function:: PyObject* PyCodec_StrictErrors(PyObject *exc) + + Raise *exc* as an exception. + +.. c:function:: PyObject* PyCodec_IgnoreErrors(PyObject *exc) + + Ignore the unicode error, skipping the faulty input. + +.. c:function:: PyObject* PyCodec_ReplaceErrors(PyObject *exc) + + Replace the unicode encode error with ``?`` or ``U+FFFD``. + +.. c:function:: PyObject* PyCodec_XMLCharRefReplaceErrors(PyObject *exc) + + Replace the unicode encode error with XML character references. + +.. c:function:: PyObject* PyCodec_BackslashReplaceErrors(PyObject *exc) + + Replace the unicode encode error with backslash escapes (``\x``, ``\u`` and + ``\U``). + +.. c:function:: PyObject* PyCodec_NameReplaceErrors(PyObject *exc) + + Replace the unicode encode error with ``\N{...}`` escapes. + + .. versionadded:: 3.5 diff --git a/python-3.7.4-docs-html/_sources/c-api/complex.rst.txt b/python-3.7.4-docs-html/_sources/c-api/complex.rst.txt new file mode 100644 index 0000000..fc63b57 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/complex.rst.txt @@ -0,0 +1,132 @@ +.. highlightlang:: c + +.. _complexobjects: + +Complex Number Objects +---------------------- + +.. index:: object: complex number + +Python's complex number objects are implemented as two distinct types when +viewed from the C API: one is the Python object exposed to Python programs, and +the other is a C structure which represents the actual complex number value. +The API provides functions for working with both. + + +Complex Numbers as C Structures +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Note that the functions which accept these structures as parameters and return +them as results do so *by value* rather than dereferencing them through +pointers. This is consistent throughout the API. + + +.. c:type:: Py_complex + + The C structure which corresponds to the value portion of a Python complex + number object. Most of the functions for dealing with complex number objects + use structures of this type as input or output values, as appropriate. It is + defined as:: + + typedef struct { + double real; + double imag; + } Py_complex; + + +.. c:function:: Py_complex _Py_c_sum(Py_complex left, Py_complex right) + + Return the sum of two complex numbers, using the C :c:type:`Py_complex` + representation. + + +.. c:function:: Py_complex _Py_c_diff(Py_complex left, Py_complex right) + + Return the difference between two complex numbers, using the C + :c:type:`Py_complex` representation. + + +.. c:function:: Py_complex _Py_c_neg(Py_complex complex) + + Return the negation of the complex number *complex*, using the C + :c:type:`Py_complex` representation. + + +.. c:function:: Py_complex _Py_c_prod(Py_complex left, Py_complex right) + + Return the product of two complex numbers, using the C :c:type:`Py_complex` + representation. + + +.. c:function:: Py_complex _Py_c_quot(Py_complex dividend, Py_complex divisor) + + Return the quotient of two complex numbers, using the C :c:type:`Py_complex` + representation. + + If *divisor* is null, this method returns zero and sets + :c:data:`errno` to :c:data:`EDOM`. + + +.. c:function:: Py_complex _Py_c_pow(Py_complex num, Py_complex exp) + + Return the exponentiation of *num* by *exp*, using the C :c:type:`Py_complex` + representation. + + If *num* is null and *exp* is not a positive real number, + this method returns zero and sets :c:data:`errno` to :c:data:`EDOM`. + + +Complex Numbers as Python Objects +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + +.. c:type:: PyComplexObject + + This subtype of :c:type:`PyObject` represents a Python complex number object. + + +.. c:var:: PyTypeObject PyComplex_Type + + This instance of :c:type:`PyTypeObject` represents the Python complex number + type. It is the same object as :class:`complex` in the Python layer. + + +.. c:function:: int PyComplex_Check(PyObject *p) + + Return true if its argument is a :c:type:`PyComplexObject` or a subtype of + :c:type:`PyComplexObject`. + + +.. c:function:: int PyComplex_CheckExact(PyObject *p) + + Return true if its argument is a :c:type:`PyComplexObject`, but not a subtype of + :c:type:`PyComplexObject`. + + +.. c:function:: PyObject* PyComplex_FromCComplex(Py_complex v) + + Create a new Python complex number object from a C :c:type:`Py_complex` value. + + +.. c:function:: PyObject* PyComplex_FromDoubles(double real, double imag) + + Return a new :c:type:`PyComplexObject` object from *real* and *imag*. + + +.. c:function:: double PyComplex_RealAsDouble(PyObject *op) + + Return the real part of *op* as a C :c:type:`double`. + + +.. c:function:: double PyComplex_ImagAsDouble(PyObject *op) + + Return the imaginary part of *op* as a C :c:type:`double`. + + +.. c:function:: Py_complex PyComplex_AsCComplex(PyObject *op) + + Return the :c:type:`Py_complex` value of the complex number *op*. + + If *op* is not a Python complex number object but has a :meth:`__complex__` + method, this method will first be called to convert *op* to a Python complex + number object. Upon failure, this method returns ``-1.0`` as a real value. diff --git a/python-3.7.4-docs-html/_sources/c-api/concrete.rst.txt b/python-3.7.4-docs-html/_sources/c-api/concrete.rst.txt new file mode 100644 index 0000000..9558a4a --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/concrete.rst.txt @@ -0,0 +1,117 @@ +.. highlightlang:: c + + +.. _concrete: + +********************** +Concrete Objects Layer +********************** + +The functions in this chapter are specific to certain Python object types. +Passing them an object of the wrong type is not a good idea; if you receive an +object from a Python program and you are not sure that it has the right type, +you must perform a type check first; for example, to check that an object is a +dictionary, use :c:func:`PyDict_Check`. The chapter is structured like the +"family tree" of Python object types. + +.. warning:: + + While the functions described in this chapter carefully check the type of the + objects which are passed in, many of them do not check for *NULL* being passed + instead of a valid object. Allowing *NULL* to be passed in can cause memory + access violations and immediate termination of the interpreter. + + +.. _fundamental: + +Fundamental Objects +=================== + +This section describes Python type objects and the singleton object ``None``. + +.. toctree:: + + type.rst + none.rst + + +.. _numericobjects: + +Numeric Objects +=============== + +.. index:: object: numeric + +.. toctree:: + + long.rst + bool.rst + float.rst + complex.rst + + +.. _sequenceobjects: + +Sequence Objects +================ + +.. index:: object: sequence + +Generic operations on sequence objects were discussed in the previous chapter; +this section deals with the specific kinds of sequence objects that are +intrinsic to the Python language. + +.. XXX sort out unicode, str, bytes and bytearray + +.. toctree:: + + bytes.rst + bytearray.rst + unicode.rst + tuple.rst + list.rst + + +.. _mapobjects: + +Container Objects +================= + +.. index:: object: mapping + +.. toctree:: + + dict.rst + set.rst + + +.. _otherobjects: + +Function Objects +================ + +.. toctree:: + + function.rst + method.rst + cell.rst + code.rst + + +Other Objects +============= + +.. toctree:: + + file.rst + module.rst + iterator.rst + descriptor.rst + slice.rst + memoryview.rst + weakref.rst + capsule.rst + gen.rst + coro.rst + contextvars.rst + datetime.rst diff --git a/python-3.7.4-docs-html/_sources/c-api/contextvars.rst.txt b/python-3.7.4-docs-html/_sources/c-api/contextvars.rst.txt new file mode 100644 index 0000000..c344c8d --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/contextvars.rst.txt @@ -0,0 +1,144 @@ +.. highlightlang:: c + +.. _contextvarsobjects: + +Context Variables Objects +------------------------- + +.. _contextvarsobjects_pointertype_change: +.. versionchanged:: 3.7.1 + + .. note:: + + In Python 3.7.1 the signatures of all context variables + C APIs were **changed** to use :c:type:`PyObject` pointers instead + of :c:type:`PyContext`, :c:type:`PyContextVar`, and + :c:type:`PyContextToken`, e.g.:: + + // in 3.7.0: + PyContext *PyContext_New(void); + + // in 3.7.1+: + PyObject *PyContext_New(void); + + See :issue:`34762` for more details. + + +.. versionadded:: 3.7 + +This section details the public C API for the :mod:`contextvars` module. + +.. c:type:: PyContext + + The C structure used to represent a :class:`contextvars.Context` + object. + +.. c:type:: PyContextVar + + The C structure used to represent a :class:`contextvars.ContextVar` + object. + +.. c:type:: PyContextToken + + The C structure used to represent a :class:`contextvars.Token` object. + +.. c:var:: PyTypeObject PyContext_Type + + The type object representing the *context* type. + +.. c:var:: PyTypeObject PyContextVar_Type + + The type object representing the *context variable* type. + +.. c:var:: PyTypeObject PyContextToken_Type + + The type object representing the *context variable token* type. + + +Type-check macros: + +.. c:function:: int PyContext_CheckExact(PyObject *o) + + Return true if *o* is of type :c:data:`PyContext_Type`. *o* must not be + *NULL*. This function always succeeds. + +.. c:function:: int PyContextVar_CheckExact(PyObject *o) + + Return true if *o* is of type :c:data:`PyContextVar_Type`. *o* must not be + *NULL*. This function always succeeds. + +.. c:function:: int PyContextToken_CheckExact(PyObject *o) + + Return true if *o* is of type :c:data:`PyContextToken_Type`. + *o* must not be *NULL*. This function always succeeds. + + +Context object management functions: + +.. c:function:: PyObject *PyContext_New(void) + + Create a new empty context object. Returns ``NULL`` if an error + has occurred. + +.. c:function:: PyObject *PyContext_Copy(PyObject *ctx) + + Create a shallow copy of the passed *ctx* context object. + Returns ``NULL`` if an error has occurred. + +.. c:function:: PyObject *PyContext_CopyCurrent(void) + + Create a shallow copy of the current thread context. + Returns ``NULL`` if an error has occurred. + +.. c:function:: int PyContext_Enter(PyObject *ctx) + + Set *ctx* as the current context for the current thread. + Returns ``0`` on success, and ``-1`` on error. + +.. c:function:: int PyContext_Exit(PyObject *ctx) + + Deactivate the *ctx* context and restore the previous context as the + current context for the current thread. Returns ``0`` on success, + and ``-1`` on error. + +.. c:function:: int PyContext_ClearFreeList() + + Clear the context variable free list. Return the total number of + freed items. This function always succeeds. + + +Context variable functions: + +.. c:function:: PyObject *PyContextVar_New(const char *name, PyObject *def) + + Create a new ``ContextVar`` object. The *name* parameter is used + for introspection and debug purposes. The *def* parameter may optionally + specify the default value for the context variable. If an error has + occurred, this function returns ``NULL``. + +.. c:function:: int PyContextVar_Get(PyObject *var, PyObject *default_value, PyObject **value) + + Get the value of a context variable. Returns ``-1`` if an error has + occurred during lookup, and ``0`` if no error occurred, whether or not + a value was found. + + If the context variable was found, *value* will be a pointer to it. + If the context variable was *not* found, *value* will point to: + + - *default_value*, if not ``NULL``; + - the default value of *var*, if not ``NULL``; + - ``NULL`` + + If the value was found, the function will create a new reference to it. + +.. c:function:: PyObject *PyContextVar_Set(PyObject *var, PyObject *value) + + Set the value of *var* to *value* in the current context. Returns a + pointer to a :c:type:`PyObject` object, or ``NULL`` if an error + has occurred. + +.. c:function:: int PyContextVar_Reset(PyObject *var, PyObject *token) + + Reset the state of the *var* context variable to that it was in before + :c:func:`PyContextVar_Set` that returned the *token* was called. + This function returns ``0`` on success and ``-1`` on error. diff --git a/python-3.7.4-docs-html/_sources/c-api/conversion.rst.txt b/python-3.7.4-docs-html/_sources/c-api/conversion.rst.txt new file mode 100644 index 0000000..c46722d --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/conversion.rst.txt @@ -0,0 +1,131 @@ +.. highlightlang:: c + +.. _string-conversion: + +String conversion and formatting +================================ + +Functions for number conversion and formatted string output. + + +.. c:function:: int PyOS_snprintf(char *str, size_t size, const char *format, ...) + + Output not more than *size* bytes to *str* according to the format string + *format* and the extra arguments. See the Unix man page :manpage:`snprintf(2)`. + + +.. c:function:: int PyOS_vsnprintf(char *str, size_t size, const char *format, va_list va) + + Output not more than *size* bytes to *str* according to the format string + *format* and the variable argument list *va*. Unix man page + :manpage:`vsnprintf(2)`. + +:c:func:`PyOS_snprintf` and :c:func:`PyOS_vsnprintf` wrap the Standard C library +functions :c:func:`snprintf` and :c:func:`vsnprintf`. Their purpose is to +guarantee consistent behavior in corner cases, which the Standard C functions do +not. + +The wrappers ensure that *str*[*size*-1] is always ``'\0'`` upon return. They +never write more than *size* bytes (including the trailing ``'\0'``) into str. +Both functions require that ``str != NULL``, ``size > 0`` and ``format != +NULL``. + +If the platform doesn't have :c:func:`vsnprintf` and the buffer size needed to +avoid truncation exceeds *size* by more than 512 bytes, Python aborts with a +*Py_FatalError*. + +The return value (*rv*) for these functions should be interpreted as follows: + +* When ``0 <= rv < size``, the output conversion was successful and *rv* + characters were written to *str* (excluding the trailing ``'\0'`` byte at + *str*[*rv*]). + +* When ``rv >= size``, the output conversion was truncated and a buffer with + ``rv + 1`` bytes would have been needed to succeed. *str*[*size*-1] is ``'\0'`` + in this case. + +* When ``rv < 0``, "something bad happened." *str*[*size*-1] is ``'\0'`` in + this case too, but the rest of *str* is undefined. The exact cause of the error + depends on the underlying platform. + +The following functions provide locale-independent string to number conversions. + + +.. c:function:: double PyOS_string_to_double(const char *s, char **endptr, PyObject *overflow_exception) + + Convert a string ``s`` to a :c:type:`double`, raising a Python + exception on failure. The set of accepted strings corresponds to + the set of strings accepted by Python's :func:`float` constructor, + except that ``s`` must not have leading or trailing whitespace. + The conversion is independent of the current locale. + + If ``endptr`` is ``NULL``, convert the whole string. Raise + :exc:`ValueError` and return ``-1.0`` if the string is not a valid + representation of a floating-point number. + + If endptr is not ``NULL``, convert as much of the string as + possible and set ``*endptr`` to point to the first unconverted + character. If no initial segment of the string is the valid + representation of a floating-point number, set ``*endptr`` to point + to the beginning of the string, raise ValueError, and return + ``-1.0``. + + If ``s`` represents a value that is too large to store in a float + (for example, ``"1e500"`` is such a string on many platforms) then + if ``overflow_exception`` is ``NULL`` return ``Py_HUGE_VAL`` (with + an appropriate sign) and don't set any exception. Otherwise, + ``overflow_exception`` must point to a Python exception object; + raise that exception and return ``-1.0``. In both cases, set + ``*endptr`` to point to the first character after the converted value. + + If any other error occurs during the conversion (for example an + out-of-memory error), set the appropriate Python exception and + return ``-1.0``. + + .. versionadded:: 3.1 + + +.. c:function:: char* PyOS_double_to_string(double val, char format_code, int precision, int flags, int *ptype) + + Convert a :c:type:`double` *val* to a string using supplied + *format_code*, *precision*, and *flags*. + + *format_code* must be one of ``'e'``, ``'E'``, ``'f'``, ``'F'``, + ``'g'``, ``'G'`` or ``'r'``. For ``'r'``, the supplied *precision* + must be 0 and is ignored. The ``'r'`` format code specifies the + standard :func:`repr` format. + + *flags* can be zero or more of the values *Py_DTSF_SIGN*, + *Py_DTSF_ADD_DOT_0*, or *Py_DTSF_ALT*, or-ed together: + + * *Py_DTSF_SIGN* means to always precede the returned string with a sign + character, even if *val* is non-negative. + + * *Py_DTSF_ADD_DOT_0* means to ensure that the returned string will not look + like an integer. + + * *Py_DTSF_ALT* means to apply "alternate" formatting rules. See the + documentation for the :c:func:`PyOS_snprintf` ``'#'`` specifier for + details. + + If *ptype* is non-NULL, then the value it points to will be set to one of + *Py_DTST_FINITE*, *Py_DTST_INFINITE*, or *Py_DTST_NAN*, signifying that + *val* is a finite number, an infinite number, or not a number, respectively. + + The return value is a pointer to *buffer* with the converted string or + *NULL* if the conversion failed. The caller is responsible for freeing the + returned string by calling :c:func:`PyMem_Free`. + + .. versionadded:: 3.1 + + +.. c:function:: int PyOS_stricmp(const char *s1, const char *s2) + + Case insensitive comparison of strings. The function works almost + identically to :c:func:`strcmp` except that it ignores the case. + + +.. c:function:: int PyOS_strnicmp(const char *s1, const char *s2, Py_ssize_t size) + + Case insensitive comparison of strings. The function works almost + identically to :c:func:`strncmp` except that it ignores the case. diff --git a/python-3.7.4-docs-html/_sources/c-api/coro.rst.txt b/python-3.7.4-docs-html/_sources/c-api/coro.rst.txt new file mode 100644 index 0000000..2fe50b5 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/coro.rst.txt @@ -0,0 +1,34 @@ +.. highlightlang:: c + +.. _coro-objects: + +Coroutine Objects +----------------- + +.. versionadded:: 3.5 + +Coroutine objects are what functions declared with an ``async`` keyword +return. + + +.. c:type:: PyCoroObject + + The C structure used for coroutine objects. + + +.. c:var:: PyTypeObject PyCoro_Type + + The type object corresponding to coroutine objects. + + +.. c:function:: int PyCoro_CheckExact(PyObject *ob) + + Return true if *ob*'s type is *PyCoro_Type*; *ob* must not be *NULL*. + + +.. c:function:: PyObject* PyCoro_New(PyFrameObject *frame, PyObject *name, PyObject *qualname) + + Create and return a new coroutine object based on the *frame* object, + with ``__name__`` and ``__qualname__`` set to *name* and *qualname*. + A reference to *frame* is stolen by this function. The *frame* argument + must not be *NULL*. diff --git a/python-3.7.4-docs-html/_sources/c-api/datetime.rst.txt b/python-3.7.4-docs-html/_sources/c-api/datetime.rst.txt new file mode 100644 index 0000000..77b1b21 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/datetime.rst.txt @@ -0,0 +1,249 @@ +.. highlightlang:: c + +.. _datetimeobjects: + +DateTime Objects +---------------- + +Various date and time objects are supplied by the :mod:`datetime` module. +Before using any of these functions, the header file :file:`datetime.h` must be +included in your source (note that this is not included by :file:`Python.h`), +and the macro :c:macro:`PyDateTime_IMPORT` must be invoked, usually as part of +the module initialisation function. The macro puts a pointer to a C structure +into a static variable, :c:data:`PyDateTimeAPI`, that is used by the following +macros. + +Macro for access to the UTC singleton: + +.. c:var:: PyObject* PyDateTime_TimeZone_UTC + + Returns the time zone singleton representing UTC, the same object as + :attr:`datetime.timezone.utc`. + + .. versionadded:: 3.7 + + +Type-check macros: + +.. c:function:: int PyDate_Check(PyObject *ob) + + Return true if *ob* is of type :c:data:`PyDateTime_DateType` or a subtype of + :c:data:`PyDateTime_DateType`. *ob* must not be *NULL*. + + +.. c:function:: int PyDate_CheckExact(PyObject *ob) + + Return true if *ob* is of type :c:data:`PyDateTime_DateType`. *ob* must not be + *NULL*. + + +.. c:function:: int PyDateTime_Check(PyObject *ob) + + Return true if *ob* is of type :c:data:`PyDateTime_DateTimeType` or a subtype of + :c:data:`PyDateTime_DateTimeType`. *ob* must not be *NULL*. + + +.. c:function:: int PyDateTime_CheckExact(PyObject *ob) + + Return true if *ob* is of type :c:data:`PyDateTime_DateTimeType`. *ob* must not + be *NULL*. + + +.. c:function:: int PyTime_Check(PyObject *ob) + + Return true if *ob* is of type :c:data:`PyDateTime_TimeType` or a subtype of + :c:data:`PyDateTime_TimeType`. *ob* must not be *NULL*. + + +.. c:function:: int PyTime_CheckExact(PyObject *ob) + + Return true if *ob* is of type :c:data:`PyDateTime_TimeType`. *ob* must not be + *NULL*. + + +.. c:function:: int PyDelta_Check(PyObject *ob) + + Return true if *ob* is of type :c:data:`PyDateTime_DeltaType` or a subtype of + :c:data:`PyDateTime_DeltaType`. *ob* must not be *NULL*. + + +.. c:function:: int PyDelta_CheckExact(PyObject *ob) + + Return true if *ob* is of type :c:data:`PyDateTime_DeltaType`. *ob* must not be + *NULL*. + + +.. c:function:: int PyTZInfo_Check(PyObject *ob) + + Return true if *ob* is of type :c:data:`PyDateTime_TZInfoType` or a subtype of + :c:data:`PyDateTime_TZInfoType`. *ob* must not be *NULL*. + + +.. c:function:: int PyTZInfo_CheckExact(PyObject *ob) + + Return true if *ob* is of type :c:data:`PyDateTime_TZInfoType`. *ob* must not be + *NULL*. + + +Macros to create objects: + +.. c:function:: PyObject* PyDate_FromDate(int year, int month, int day) + + Return a :class:`datetime.date` object with the specified year, month and day. + + +.. c:function:: PyObject* PyDateTime_FromDateAndTime(int year, int month, int day, int hour, int minute, int second, int usecond) + + Return a :class:`datetime.datetime` object with the specified year, month, day, hour, + minute, second and microsecond. + + +.. c:function:: PyObject* PyDateTime_FromDateAndTimeAndFold(int year, int month, int day, int hour, int minute, int second, int usecond, int fold) + + Return a :class:`datetime.datetime` object with the specified year, month, day, hour, + minute, second, microsecond and fold. + + .. versionadded:: 3.6 + + +.. c:function:: PyObject* PyTime_FromTime(int hour, int minute, int second, int usecond) + + Return a :class:`datetime.time` object with the specified hour, minute, second and + microsecond. + + +.. c:function:: PyObject* PyTime_FromTimeAndFold(int hour, int minute, int second, int usecond, int fold) + + Return a :class:`datetime.time` object with the specified hour, minute, second, + microsecond and fold. + + .. versionadded:: 3.6 + + +.. c:function:: PyObject* PyDelta_FromDSU(int days, int seconds, int useconds) + + Return a :class:`datetime.timedelta` object representing the given number + of days, seconds and microseconds. Normalization is performed so that the + resulting number of microseconds and seconds lie in the ranges documented for + :class:`datetime.timedelta` objects. + +.. c:function:: PyObject* PyTimeZone_FromOffset(PyDateTime_DeltaType* offset) + + Return a :class:`datetime.timezone` object with an unnamed fixed offset + represented by the *offset* argument. + + .. versionadded:: 3.7 + +.. c:function:: PyObject* PyTimeZone_FromOffsetAndName(PyDateTime_DeltaType* offset, PyUnicode* name) + + Return a :class:`datetime.timezone` object with a fixed offset represented + by the *offset* argument and with tzname *name*. + + .. versionadded:: 3.7 + + +Macros to extract fields from date objects. The argument must be an instance of +:c:data:`PyDateTime_Date`, including subclasses (such as +:c:data:`PyDateTime_DateTime`). The argument must not be *NULL*, and the type is +not checked: + +.. c:function:: int PyDateTime_GET_YEAR(PyDateTime_Date *o) + + Return the year, as a positive int. + + +.. c:function:: int PyDateTime_GET_MONTH(PyDateTime_Date *o) + + Return the month, as an int from 1 through 12. + + +.. c:function:: int PyDateTime_GET_DAY(PyDateTime_Date *o) + + Return the day, as an int from 1 through 31. + + +Macros to extract fields from datetime objects. The argument must be an +instance of :c:data:`PyDateTime_DateTime`, including subclasses. The argument +must not be *NULL*, and the type is not checked: + +.. c:function:: int PyDateTime_DATE_GET_HOUR(PyDateTime_DateTime *o) + + Return the hour, as an int from 0 through 23. + + +.. c:function:: int PyDateTime_DATE_GET_MINUTE(PyDateTime_DateTime *o) + + Return the minute, as an int from 0 through 59. + + +.. c:function:: int PyDateTime_DATE_GET_SECOND(PyDateTime_DateTime *o) + + Return the second, as an int from 0 through 59. + + +.. c:function:: int PyDateTime_DATE_GET_MICROSECOND(PyDateTime_DateTime *o) + + Return the microsecond, as an int from 0 through 999999. + + +Macros to extract fields from time objects. The argument must be an instance of +:c:data:`PyDateTime_Time`, including subclasses. The argument must not be *NULL*, +and the type is not checked: + +.. c:function:: int PyDateTime_TIME_GET_HOUR(PyDateTime_Time *o) + + Return the hour, as an int from 0 through 23. + + +.. c:function:: int PyDateTime_TIME_GET_MINUTE(PyDateTime_Time *o) + + Return the minute, as an int from 0 through 59. + + +.. c:function:: int PyDateTime_TIME_GET_SECOND(PyDateTime_Time *o) + + Return the second, as an int from 0 through 59. + + +.. c:function:: int PyDateTime_TIME_GET_MICROSECOND(PyDateTime_Time *o) + + Return the microsecond, as an int from 0 through 999999. + + +Macros to extract fields from time delta objects. The argument must be an +instance of :c:data:`PyDateTime_Delta`, including subclasses. The argument must +not be *NULL*, and the type is not checked: + +.. c:function:: int PyDateTime_DELTA_GET_DAYS(PyDateTime_Delta *o) + + Return the number of days, as an int from -999999999 to 999999999. + + .. versionadded:: 3.3 + + +.. c:function:: int PyDateTime_DELTA_GET_SECONDS(PyDateTime_Delta *o) + + Return the number of seconds, as an int from 0 through 86399. + + .. versionadded:: 3.3 + + +.. c:function:: int PyDateTime_DELTA_GET_MICROSECONDS(PyDateTime_Delta *o) + + Return the number of microseconds, as an int from 0 through 999999. + + .. versionadded:: 3.3 + + +Macros for the convenience of modules implementing the DB API: + +.. c:function:: PyObject* PyDateTime_FromTimestamp(PyObject *args) + + Create and return a new :class:`datetime.datetime` object given an argument + tuple suitable for passing to :meth:`datetime.datetime.fromtimestamp()`. + + +.. c:function:: PyObject* PyDate_FromTimestamp(PyObject *args) + + Create and return a new :class:`datetime.date` object given an argument + tuple suitable for passing to :meth:`datetime.date.fromtimestamp()`. diff --git a/python-3.7.4-docs-html/_sources/c-api/descriptor.rst.txt b/python-3.7.4-docs-html/_sources/c-api/descriptor.rst.txt new file mode 100644 index 0000000..c8f6fa5 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/descriptor.rst.txt @@ -0,0 +1,40 @@ +.. highlightlang:: c + +.. _descriptor-objects: + +Descriptor Objects +------------------ + +"Descriptors" are objects that describe some attribute of an object. They are +found in the dictionary of type objects. + +.. XXX document these! + +.. c:var:: PyTypeObject PyProperty_Type + + The type object for the built-in descriptor types. + + +.. c:function:: PyObject* PyDescr_NewGetSet(PyTypeObject *type, struct PyGetSetDef *getset) + + +.. c:function:: PyObject* PyDescr_NewMember(PyTypeObject *type, struct PyMemberDef *meth) + + +.. c:function:: PyObject* PyDescr_NewMethod(PyTypeObject *type, struct PyMethodDef *meth) + + +.. c:function:: PyObject* PyDescr_NewWrapper(PyTypeObject *type, struct wrapperbase *wrapper, void *wrapped) + + +.. c:function:: PyObject* PyDescr_NewClassMethod(PyTypeObject *type, PyMethodDef *method) + + +.. c:function:: int PyDescr_IsData(PyObject *descr) + + Return true if the descriptor objects *descr* describes a data attribute, or + false if it describes a method. *descr* must be a descriptor object; there is + no error checking. + + +.. c:function:: PyObject* PyWrapper_New(PyObject *, PyObject *) diff --git a/python-3.7.4-docs-html/_sources/c-api/dict.rst.txt b/python-3.7.4-docs-html/_sources/c-api/dict.rst.txt new file mode 100644 index 0000000..0ced5a5 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/dict.rst.txt @@ -0,0 +1,240 @@ +.. highlightlang:: c + +.. _dictobjects: + +Dictionary Objects +------------------ + +.. index:: object: dictionary + + +.. c:type:: PyDictObject + + This subtype of :c:type:`PyObject` represents a Python dictionary object. + + +.. c:var:: PyTypeObject PyDict_Type + + This instance of :c:type:`PyTypeObject` represents the Python dictionary + type. This is the same object as :class:`dict` in the Python layer. + + +.. c:function:: int PyDict_Check(PyObject *p) + + Return true if *p* is a dict object or an instance of a subtype of the dict + type. + + +.. c:function:: int PyDict_CheckExact(PyObject *p) + + Return true if *p* is a dict object, but not an instance of a subtype of + the dict type. + + +.. c:function:: PyObject* PyDict_New() + + Return a new empty dictionary, or *NULL* on failure. + + +.. c:function:: PyObject* PyDictProxy_New(PyObject *mapping) + + Return a :class:`types.MappingProxyType` object for a mapping which + enforces read-only behavior. This is normally used to create a view to + prevent modification of the dictionary for non-dynamic class types. + + +.. c:function:: void PyDict_Clear(PyObject *p) + + Empty an existing dictionary of all key-value pairs. + + +.. c:function:: int PyDict_Contains(PyObject *p, PyObject *key) + + Determine if dictionary *p* contains *key*. If an item in *p* is matches + *key*, return ``1``, otherwise return ``0``. On error, return ``-1``. + This is equivalent to the Python expression ``key in p``. + + +.. c:function:: PyObject* PyDict_Copy(PyObject *p) + + Return a new dictionary that contains the same key-value pairs as *p*. + + +.. c:function:: int PyDict_SetItem(PyObject *p, PyObject *key, PyObject *val) + + Insert *value* into the dictionary *p* with a key of *key*. *key* must be + :term:`hashable`; if it isn't, :exc:`TypeError` will be raised. Return + ``0`` on success or ``-1`` on failure. + + +.. c:function:: int PyDict_SetItemString(PyObject *p, const char *key, PyObject *val) + + .. index:: single: PyUnicode_FromString() + + Insert *value* into the dictionary *p* using *key* as a key. *key* should + be a :c:type:`const char\*`. The key object is created using + ``PyUnicode_FromString(key)``. Return ``0`` on success or ``-1`` on + failure. + + +.. c:function:: int PyDict_DelItem(PyObject *p, PyObject *key) + + Remove the entry in dictionary *p* with key *key*. *key* must be hashable; + if it isn't, :exc:`TypeError` is raised. Return ``0`` on success or ``-1`` + on failure. + + +.. c:function:: int PyDict_DelItemString(PyObject *p, const char *key) + + Remove the entry in dictionary *p* which has a key specified by the string + *key*. Return ``0`` on success or ``-1`` on failure. + + +.. c:function:: PyObject* PyDict_GetItem(PyObject *p, PyObject *key) + + Return the object from dictionary *p* which has a key *key*. Return *NULL* + if the key *key* is not present, but *without* setting an exception. + + Note that exceptions which occur while calling :meth:`__hash__` and + :meth:`__eq__` methods will get suppressed. + To get error reporting use :c:func:`PyDict_GetItemWithError()` instead. + + +.. c:function:: PyObject* PyDict_GetItemWithError(PyObject *p, PyObject *key) + + Variant of :c:func:`PyDict_GetItem` that does not suppress + exceptions. Return *NULL* **with** an exception set if an exception + occurred. Return *NULL* **without** an exception set if the key + wasn't present. + + +.. c:function:: PyObject* PyDict_GetItemString(PyObject *p, const char *key) + + This is the same as :c:func:`PyDict_GetItem`, but *key* is specified as a + :c:type:`const char\*`, rather than a :c:type:`PyObject\*`. + + Note that exceptions which occur while calling :meth:`__hash__` and + :meth:`__eq__` methods and creating a temporary string object + will get suppressed. + To get error reporting use :c:func:`PyDict_GetItemWithError()` instead. + + +.. c:function:: PyObject* PyDict_SetDefault(PyObject *p, PyObject *key, PyObject *defaultobj) + + This is the same as the Python-level :meth:`dict.setdefault`. If present, it + returns the value corresponding to *key* from the dictionary *p*. If the key + is not in the dict, it is inserted with value *defaultobj* and *defaultobj* + is returned. This function evaluates the hash function of *key* only once, + instead of evaluating it independently for the lookup and the insertion. + + .. versionadded:: 3.4 + +.. c:function:: PyObject* PyDict_Items(PyObject *p) + + Return a :c:type:`PyListObject` containing all the items from the dictionary. + + +.. c:function:: PyObject* PyDict_Keys(PyObject *p) + + Return a :c:type:`PyListObject` containing all the keys from the dictionary. + + +.. c:function:: PyObject* PyDict_Values(PyObject *p) + + Return a :c:type:`PyListObject` containing all the values from the dictionary + *p*. + + +.. c:function:: Py_ssize_t PyDict_Size(PyObject *p) + + .. index:: builtin: len + + Return the number of items in the dictionary. This is equivalent to + ``len(p)`` on a dictionary. + + +.. c:function:: int PyDict_Next(PyObject *p, Py_ssize_t *ppos, PyObject **pkey, PyObject **pvalue) + + Iterate over all key-value pairs in the dictionary *p*. The + :c:type:`Py_ssize_t` referred to by *ppos* must be initialized to ``0`` + prior to the first call to this function to start the iteration; the + function returns true for each pair in the dictionary, and false once all + pairs have been reported. The parameters *pkey* and *pvalue* should either + point to :c:type:`PyObject\*` variables that will be filled in with each key + and value, respectively, or may be *NULL*. Any references returned through + them are borrowed. *ppos* should not be altered during iteration. Its + value represents offsets within the internal dictionary structure, and + since the structure is sparse, the offsets are not consecutive. + + For example:: + + PyObject *key, *value; + Py_ssize_t pos = 0; + + while (PyDict_Next(self->dict, &pos, &key, &value)) { + /* do something interesting with the values... */ + ... + } + + The dictionary *p* should not be mutated during iteration. It is safe to + modify the values of the keys as you iterate over the dictionary, but only + so long as the set of keys does not change. For example:: + + PyObject *key, *value; + Py_ssize_t pos = 0; + + while (PyDict_Next(self->dict, &pos, &key, &value)) { + long i = PyLong_AsLong(value); + if (i == -1 && PyErr_Occurred()) { + return -1; + } + PyObject *o = PyLong_FromLong(i + 1); + if (o == NULL) + return -1; + if (PyDict_SetItem(self->dict, key, o) < 0) { + Py_DECREF(o); + return -1; + } + Py_DECREF(o); + } + + +.. c:function:: int PyDict_Merge(PyObject *a, PyObject *b, int override) + + Iterate over mapping object *b* adding key-value pairs to dictionary *a*. + *b* may be a dictionary, or any object supporting :c:func:`PyMapping_Keys` + and :c:func:`PyObject_GetItem`. If *override* is true, existing pairs in *a* + will be replaced if a matching key is found in *b*, otherwise pairs will + only be added if there is not a matching key in *a*. Return ``0`` on + success or ``-1`` if an exception was raised. + + +.. c:function:: int PyDict_Update(PyObject *a, PyObject *b) + + This is the same as ``PyDict_Merge(a, b, 1)`` in C, and is similar to + ``a.update(b)`` in Python except that :c:func:`PyDict_Update` doesn't fall + back to the iterating over a sequence of key value pairs if the second + argument has no "keys" attribute. Return ``0`` on success or ``-1`` if an + exception was raised. + + +.. c:function:: int PyDict_MergeFromSeq2(PyObject *a, PyObject *seq2, int override) + + Update or merge into dictionary *a*, from the key-value pairs in *seq2*. + *seq2* must be an iterable object producing iterable objects of length 2, + viewed as key-value pairs. In case of duplicate keys, the last wins if + *override* is true, else the first wins. Return ``0`` on success or ``-1`` + if an exception was raised. Equivalent Python (except for the return + value):: + + def PyDict_MergeFromSeq2(a, seq2, override): + for key, value in seq2: + if override or key not in a: + a[key] = value + + +.. c:function:: int PyDict_ClearFreeList() + + Clear the free list. Return the total number of freed items. + + .. versionadded:: 3.3 diff --git a/python-3.7.4-docs-html/_sources/c-api/exceptions.rst.txt b/python-3.7.4-docs-html/_sources/c-api/exceptions.rst.txt new file mode 100644 index 0000000..14ca2b4 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/exceptions.rst.txt @@ -0,0 +1,1032 @@ +.. highlightlang:: c + + +.. _exceptionhandling: + +****************** +Exception Handling +****************** + +The functions described in this chapter will let you handle and raise Python +exceptions. It is important to understand some of the basics of Python +exception handling. It works somewhat like the POSIX :c:data:`errno` variable: +there is a global indicator (per thread) of the last error that occurred. Most +C API functions don't clear this on success, but will set it to indicate the +cause of the error on failure. Most C API functions also return an error +indicator, usually *NULL* if they are supposed to return a pointer, or ``-1`` +if they return an integer (exception: the :c:func:`PyArg_\*` functions +return ``1`` for success and ``0`` for failure). + +Concretely, the error indicator consists of three object pointers: the +exception's type, the exception's value, and the traceback object. Any +of those pointers can be NULL if non-set (although some combinations are +forbidden, for example you can't have a non-NULL traceback if the exception +type is NULL). + +When a function must fail because some function it called failed, it generally +doesn't set the error indicator; the function it called already set it. It is +responsible for either handling the error and clearing the exception or +returning after cleaning up any resources it holds (such as object references or +memory allocations); it should *not* continue normally if it is not prepared to +handle the error. If returning due to an error, it is important to indicate to +the caller that an error has been set. If the error is not handled or carefully +propagated, additional calls into the Python/C API may not behave as intended +and may fail in mysterious ways. + +.. note:: + The error indicator is **not** the result of :func:`sys.exc_info()`. + The former corresponds to an exception that is not yet caught (and is + therefore still propagating), while the latter returns an exception after + it is caught (and has therefore stopped propagating). + + +Printing and clearing +===================== + + +.. c:function:: void PyErr_Clear() + + Clear the error indicator. If the error indicator is not set, there is no + effect. + + +.. c:function:: void PyErr_PrintEx(int set_sys_last_vars) + + Print a standard traceback to ``sys.stderr`` and clear the error indicator. + **Unless** the error is a ``SystemExit``. In that case the no traceback + is printed and Python process will exit with the error code specified by + the ``SystemExit`` instance. + + Call this function **only** when the error indicator is set. Otherwise it + will cause a fatal error! + + If *set_sys_last_vars* is nonzero, the variables :data:`sys.last_type`, + :data:`sys.last_value` and :data:`sys.last_traceback` will be set to the + type, value and traceback of the printed exception, respectively. + + +.. c:function:: void PyErr_Print() + + Alias for ``PyErr_PrintEx(1)``. + + +.. c:function:: void PyErr_WriteUnraisable(PyObject *obj) + + This utility function prints a warning message to ``sys.stderr`` when an + exception has been set but it is impossible for the interpreter to actually + raise the exception. It is used, for example, when an exception occurs in an + :meth:`__del__` method. + + The function is called with a single argument *obj* that identifies the context + in which the unraisable exception occurred. If possible, + the repr of *obj* will be printed in the warning message. + + An exception must be set when calling this function. + + +Raising exceptions +================== + +These functions help you set the current thread's error indicator. +For convenience, some of these functions will always return a +NULL pointer for use in a ``return`` statement. + + +.. c:function:: void PyErr_SetString(PyObject *type, const char *message) + + This is the most common way to set the error indicator. The first argument + specifies the exception type; it is normally one of the standard exceptions, + e.g. :c:data:`PyExc_RuntimeError`. You need not increment its reference count. + The second argument is an error message; it is decoded from ``'utf-8``'. + + +.. c:function:: void PyErr_SetObject(PyObject *type, PyObject *value) + + This function is similar to :c:func:`PyErr_SetString` but lets you specify an + arbitrary Python object for the "value" of the exception. + + +.. c:function:: PyObject* PyErr_Format(PyObject *exception, const char *format, ...) + + This function sets the error indicator and returns *NULL*. *exception* + should be a Python exception class. The *format* and subsequent + parameters help format the error message; they have the same meaning and + values as in :c:func:`PyUnicode_FromFormat`. *format* is an ASCII-encoded + string. + + +.. c:function:: PyObject* PyErr_FormatV(PyObject *exception, const char *format, va_list vargs) + + Same as :c:func:`PyErr_Format`, but taking a :c:type:`va_list` argument rather + than a variable number of arguments. + + .. versionadded:: 3.5 + + +.. c:function:: void PyErr_SetNone(PyObject *type) + + This is a shorthand for ``PyErr_SetObject(type, Py_None)``. + + +.. c:function:: int PyErr_BadArgument() + + This is a shorthand for ``PyErr_SetString(PyExc_TypeError, message)``, where + *message* indicates that a built-in operation was invoked with an illegal + argument. It is mostly for internal use. + + +.. c:function:: PyObject* PyErr_NoMemory() + + This is a shorthand for ``PyErr_SetNone(PyExc_MemoryError)``; it returns *NULL* + so an object allocation function can write ``return PyErr_NoMemory();`` when it + runs out of memory. + + +.. c:function:: PyObject* PyErr_SetFromErrno(PyObject *type) + + .. index:: single: strerror() + + This is a convenience function to raise an exception when a C library function + has returned an error and set the C variable :c:data:`errno`. It constructs a + tuple object whose first item is the integer :c:data:`errno` value and whose + second item is the corresponding error message (gotten from :c:func:`strerror`), + and then calls ``PyErr_SetObject(type, object)``. On Unix, when the + :c:data:`errno` value is :const:`EINTR`, indicating an interrupted system call, + this calls :c:func:`PyErr_CheckSignals`, and if that set the error indicator, + leaves it set to that. The function always returns *NULL*, so a wrapper + function around a system call can write ``return PyErr_SetFromErrno(type);`` + when the system call returns an error. + + +.. c:function:: PyObject* PyErr_SetFromErrnoWithFilenameObject(PyObject *type, PyObject *filenameObject) + + Similar to :c:func:`PyErr_SetFromErrno`, with the additional behavior that if + *filenameObject* is not *NULL*, it is passed to the constructor of *type* as + a third parameter. In the case of :exc:`OSError` exception, + this is used to define the :attr:`filename` attribute of the + exception instance. + + +.. c:function:: PyObject* PyErr_SetFromErrnoWithFilenameObjects(PyObject *type, PyObject *filenameObject, PyObject *filenameObject2) + + Similar to :c:func:`PyErr_SetFromErrnoWithFilenameObject`, but takes a second + filename object, for raising errors when a function that takes two filenames + fails. + + .. versionadded:: 3.4 + + +.. c:function:: PyObject* PyErr_SetFromErrnoWithFilename(PyObject *type, const char *filename) + + Similar to :c:func:`PyErr_SetFromErrnoWithFilenameObject`, but the filename + is given as a C string. *filename* is decoded from the filesystem encoding + (:func:`os.fsdecode`). + + +.. c:function:: PyObject* PyErr_SetFromWindowsErr(int ierr) + + This is a convenience function to raise :exc:`WindowsError`. If called with + *ierr* of :c:data:`0`, the error code returned by a call to :c:func:`GetLastError` + is used instead. It calls the Win32 function :c:func:`FormatMessage` to retrieve + the Windows description of error code given by *ierr* or :c:func:`GetLastError`, + then it constructs a tuple object whose first item is the *ierr* value and whose + second item is the corresponding error message (gotten from + :c:func:`FormatMessage`), and then calls ``PyErr_SetObject(PyExc_WindowsError, + object)``. This function always returns *NULL*. + + .. availability:: Windows. + + +.. c:function:: PyObject* PyErr_SetExcFromWindowsErr(PyObject *type, int ierr) + + Similar to :c:func:`PyErr_SetFromWindowsErr`, with an additional parameter + specifying the exception type to be raised. + + .. availability:: Windows. + + +.. c:function:: PyObject* PyErr_SetFromWindowsErrWithFilename(int ierr, const char *filename) + + Similar to :c:func:`PyErr_SetFromWindowsErrWithFilenameObject`, but the + filename is given as a C string. *filename* is decoded from the filesystem + encoding (:func:`os.fsdecode`). + + .. availability:: Windows. + + +.. c:function:: PyObject* PyErr_SetExcFromWindowsErrWithFilenameObject(PyObject *type, int ierr, PyObject *filename) + + Similar to :c:func:`PyErr_SetFromWindowsErrWithFilenameObject`, with an + additional parameter specifying the exception type to be raised. + + .. availability:: Windows. + + +.. c:function:: PyObject* PyErr_SetExcFromWindowsErrWithFilenameObjects(PyObject *type, int ierr, PyObject *filename, PyObject *filename2) + + Similar to :c:func:`PyErr_SetExcFromWindowsErrWithFilenameObject`, + but accepts a second filename object. + + .. availability:: Windows. + + .. versionadded:: 3.4 + + +.. c:function:: PyObject* PyErr_SetExcFromWindowsErrWithFilename(PyObject *type, int ierr, const char *filename) + + Similar to :c:func:`PyErr_SetFromWindowsErrWithFilename`, with an additional + parameter specifying the exception type to be raised. + + .. availability:: Windows. + + +.. c:function:: PyObject* PyErr_SetImportError(PyObject *msg, PyObject *name, PyObject *path) + + This is a convenience function to raise :exc:`ImportError`. *msg* will be + set as the exception's message string. *name* and *path*, both of which can + be ``NULL``, will be set as the :exc:`ImportError`'s respective ``name`` + and ``path`` attributes. + + .. versionadded:: 3.3 + + +.. c:function:: void PyErr_SyntaxLocationObject(PyObject *filename, int lineno, int col_offset) + + Set file, line, and offset information for the current exception. If the + current exception is not a :exc:`SyntaxError`, then it sets additional + attributes, which make the exception printing subsystem think the exception + is a :exc:`SyntaxError`. + + .. versionadded:: 3.4 + + +.. c:function:: void PyErr_SyntaxLocationEx(const char *filename, int lineno, int col_offset) + + Like :c:func:`PyErr_SyntaxLocationObject`, but *filename* is a byte string + decoded from the filesystem encoding (:func:`os.fsdecode`). + + .. versionadded:: 3.2 + + +.. c:function:: void PyErr_SyntaxLocation(const char *filename, int lineno) + + Like :c:func:`PyErr_SyntaxLocationEx`, but the col_offset parameter is + omitted. + + +.. c:function:: void PyErr_BadInternalCall() + + This is a shorthand for ``PyErr_SetString(PyExc_SystemError, message)``, + where *message* indicates that an internal operation (e.g. a Python/C API + function) was invoked with an illegal argument. It is mostly for internal + use. + + +Issuing warnings +================ + +Use these functions to issue warnings from C code. They mirror similar +functions exported by the Python :mod:`warnings` module. They normally +print a warning message to *sys.stderr*; however, it is +also possible that the user has specified that warnings are to be turned into +errors, and in that case they will raise an exception. It is also possible that +the functions raise an exception because of a problem with the warning machinery. +The return value is ``0`` if no exception is raised, or ``-1`` if an exception +is raised. (It is not possible to determine whether a warning message is +actually printed, nor what the reason is for the exception; this is +intentional.) If an exception is raised, the caller should do its normal +exception handling (for example, :c:func:`Py_DECREF` owned references and return +an error value). + +.. c:function:: int PyErr_WarnEx(PyObject *category, const char *message, Py_ssize_t stack_level) + + Issue a warning message. The *category* argument is a warning category (see + below) or *NULL*; the *message* argument is a UTF-8 encoded string. *stack_level* is a + positive number giving a number of stack frames; the warning will be issued from + the currently executing line of code in that stack frame. A *stack_level* of 1 + is the function calling :c:func:`PyErr_WarnEx`, 2 is the function above that, + and so forth. + + Warning categories must be subclasses of :c:data:`PyExc_Warning`; + :c:data:`PyExc_Warning` is a subclass of :c:data:`PyExc_Exception`; + the default warning category is :c:data:`PyExc_RuntimeWarning`. The standard + Python warning categories are available as global variables whose names are + enumerated at :ref:`standardwarningcategories`. + + For information about warning control, see the documentation for the + :mod:`warnings` module and the :option:`-W` option in the command line + documentation. There is no C API for warning control. + +.. c:function:: PyObject* PyErr_SetImportErrorSubclass(PyObject *exception, PyObject *msg, PyObject *name, PyObject *path) + + Much like :c:func:`PyErr_SetImportError` but this function allows for + specifying a subclass of :exc:`ImportError` to raise. + + .. versionadded:: 3.6 + + +.. c:function:: int PyErr_WarnExplicitObject(PyObject *category, PyObject *message, PyObject *filename, int lineno, PyObject *module, PyObject *registry) + + Issue a warning message with explicit control over all warning attributes. This + is a straightforward wrapper around the Python function + :func:`warnings.warn_explicit`, see there for more information. The *module* + and *registry* arguments may be set to *NULL* to get the default effect + described there. + + .. versionadded:: 3.4 + + +.. c:function:: int PyErr_WarnExplicit(PyObject *category, const char *message, const char *filename, int lineno, const char *module, PyObject *registry) + + Similar to :c:func:`PyErr_WarnExplicitObject` except that *message* and + *module* are UTF-8 encoded strings, and *filename* is decoded from the + filesystem encoding (:func:`os.fsdecode`). + + +.. c:function:: int PyErr_WarnFormat(PyObject *category, Py_ssize_t stack_level, const char *format, ...) + + Function similar to :c:func:`PyErr_WarnEx`, but use + :c:func:`PyUnicode_FromFormat` to format the warning message. *format* is + an ASCII-encoded string. + + .. versionadded:: 3.2 + + +.. c:function:: int PyErr_ResourceWarning(PyObject *source, Py_ssize_t stack_level, const char *format, ...) + + Function similar to :c:func:`PyErr_WarnFormat`, but *category* is + :exc:`ResourceWarning` and pass *source* to :func:`warnings.WarningMessage`. + + .. versionadded:: 3.6 + + +Querying the error indicator +============================ + +.. c:function:: PyObject* PyErr_Occurred() + + Test whether the error indicator is set. If set, return the exception *type* + (the first argument to the last call to one of the :c:func:`PyErr_Set\*` + functions or to :c:func:`PyErr_Restore`). If not set, return *NULL*. You do not + own a reference to the return value, so you do not need to :c:func:`Py_DECREF` + it. + + .. note:: + + Do not compare the return value to a specific exception; use + :c:func:`PyErr_ExceptionMatches` instead, shown below. (The comparison could + easily fail since the exception may be an instance instead of a class, in the + case of a class exception, or it may be a subclass of the expected exception.) + + +.. c:function:: int PyErr_ExceptionMatches(PyObject *exc) + + Equivalent to ``PyErr_GivenExceptionMatches(PyErr_Occurred(), exc)``. This + should only be called when an exception is actually set; a memory access + violation will occur if no exception has been raised. + + +.. c:function:: int PyErr_GivenExceptionMatches(PyObject *given, PyObject *exc) + + Return true if the *given* exception matches the exception type in *exc*. If + *exc* is a class object, this also returns true when *given* is an instance + of a subclass. If *exc* is a tuple, all exception types in the tuple (and + recursively in subtuples) are searched for a match. + + +.. c:function:: void PyErr_Fetch(PyObject **ptype, PyObject **pvalue, PyObject **ptraceback) + + Retrieve the error indicator into three variables whose addresses are passed. + If the error indicator is not set, set all three variables to *NULL*. If it is + set, it will be cleared and you own a reference to each object retrieved. The + value and traceback object may be *NULL* even when the type object is not. + + .. note:: + + This function is normally only used by code that needs to catch exceptions or + by code that needs to save and restore the error indicator temporarily, e.g.:: + + { + PyObject *type, *value, *traceback; + PyErr_Fetch(&type, &value, &traceback); + + /* ... code that might produce other errors ... */ + + PyErr_Restore(type, value, traceback); + } + + +.. c:function:: void PyErr_Restore(PyObject *type, PyObject *value, PyObject *traceback) + + Set the error indicator from the three objects. If the error indicator is + already set, it is cleared first. If the objects are *NULL*, the error + indicator is cleared. Do not pass a *NULL* type and non-*NULL* value or + traceback. The exception type should be a class. Do not pass an invalid + exception type or value. (Violating these rules will cause subtle problems + later.) This call takes away a reference to each object: you must own a + reference to each object before the call and after the call you no longer own + these references. (If you don't understand this, don't use this function. I + warned you.) + + .. note:: + + This function is normally only used by code that needs to save and restore the + error indicator temporarily. Use :c:func:`PyErr_Fetch` to save the current + error indicator. + + +.. c:function:: void PyErr_NormalizeException(PyObject**exc, PyObject**val, PyObject**tb) + + Under certain circumstances, the values returned by :c:func:`PyErr_Fetch` below + can be "unnormalized", meaning that ``*exc`` is a class object but ``*val`` is + not an instance of the same class. This function can be used to instantiate + the class in that case. If the values are already normalized, nothing happens. + The delayed normalization is implemented to improve performance. + + .. note:: + + This function *does not* implicitly set the ``__traceback__`` + attribute on the exception value. If setting the traceback + appropriately is desired, the following additional snippet is needed:: + + if (tb != NULL) { + PyException_SetTraceback(val, tb); + } + + +.. c:function:: void PyErr_GetExcInfo(PyObject **ptype, PyObject **pvalue, PyObject **ptraceback) + + Retrieve the exception info, as known from ``sys.exc_info()``. This refers + to an exception that was *already caught*, not to an exception that was + freshly raised. Returns new references for the three objects, any of which + may be *NULL*. Does not modify the exception info state. + + .. note:: + + This function is not normally used by code that wants to handle exceptions. + Rather, it can be used when code needs to save and restore the exception + state temporarily. Use :c:func:`PyErr_SetExcInfo` to restore or clear the + exception state. + + .. versionadded:: 3.3 + + +.. c:function:: void PyErr_SetExcInfo(PyObject *type, PyObject *value, PyObject *traceback) + + Set the exception info, as known from ``sys.exc_info()``. This refers + to an exception that was *already caught*, not to an exception that was + freshly raised. This function steals the references of the arguments. + To clear the exception state, pass *NULL* for all three arguments. + For general rules about the three arguments, see :c:func:`PyErr_Restore`. + + .. note:: + + This function is not normally used by code that wants to handle exceptions. + Rather, it can be used when code needs to save and restore the exception + state temporarily. Use :c:func:`PyErr_GetExcInfo` to read the exception + state. + + .. versionadded:: 3.3 + + +Signal Handling +=============== + + +.. c:function:: int PyErr_CheckSignals() + + .. index:: + module: signal + single: SIGINT + single: KeyboardInterrupt (built-in exception) + + This function interacts with Python's signal handling. It checks whether a + signal has been sent to the processes and if so, invokes the corresponding + signal handler. If the :mod:`signal` module is supported, this can invoke a + signal handler written in Python. In all cases, the default effect for + :const:`SIGINT` is to raise the :exc:`KeyboardInterrupt` exception. If an + exception is raised the error indicator is set and the function returns ``-1``; + otherwise the function returns ``0``. The error indicator may or may not be + cleared if it was previously set. + + +.. c:function:: void PyErr_SetInterrupt() + + .. index:: + single: SIGINT + single: KeyboardInterrupt (built-in exception) + + Simulate the effect of a :const:`SIGINT` signal arriving. The next time + :c:func:`PyErr_CheckSignals` is called, the Python signal handler for + :const:`SIGINT` will be called. + + If :const:`SIGINT` isn't handled by Python (it was set to + :data:`signal.SIG_DFL` or :data:`signal.SIG_IGN`), this function does + nothing. + +.. c:function:: int PySignal_SetWakeupFd(int fd) + + This utility function specifies a file descriptor to which the signal number + is written as a single byte whenever a signal is received. *fd* must be + non-blocking. It returns the previous such file descriptor. + + The value ``-1`` disables the feature; this is the initial state. + This is equivalent to :func:`signal.set_wakeup_fd` in Python, but without any + error checking. *fd* should be a valid file descriptor. The function should + only be called from the main thread. + + .. versionchanged:: 3.5 + On Windows, the function now also supports socket handles. + + +Exception Classes +================= + +.. c:function:: PyObject* PyErr_NewException(const char *name, PyObject *base, PyObject *dict) + + This utility function creates and returns a new exception class. The *name* + argument must be the name of the new exception, a C string of the form + ``module.classname``. The *base* and *dict* arguments are normally *NULL*. + This creates a class object derived from :exc:`Exception` (accessible in C as + :c:data:`PyExc_Exception`). + + The :attr:`__module__` attribute of the new class is set to the first part (up + to the last dot) of the *name* argument, and the class name is set to the last + part (after the last dot). The *base* argument can be used to specify alternate + base classes; it can either be only one class or a tuple of classes. The *dict* + argument can be used to specify a dictionary of class variables and methods. + + +.. c:function:: PyObject* PyErr_NewExceptionWithDoc(const char *name, const char *doc, PyObject *base, PyObject *dict) + + Same as :c:func:`PyErr_NewException`, except that the new exception class can + easily be given a docstring: If *doc* is non-*NULL*, it will be used as the + docstring for the exception class. + + .. versionadded:: 3.2 + + +Exception Objects +================= + +.. c:function:: PyObject* PyException_GetTraceback(PyObject *ex) + + Return the traceback associated with the exception as a new reference, as + accessible from Python through :attr:`__traceback__`. If there is no + traceback associated, this returns *NULL*. + + +.. c:function:: int PyException_SetTraceback(PyObject *ex, PyObject *tb) + + Set the traceback associated with the exception to *tb*. Use ``Py_None`` to + clear it. + + +.. c:function:: PyObject* PyException_GetContext(PyObject *ex) + + Return the context (another exception instance during whose handling *ex* was + raised) associated with the exception as a new reference, as accessible from + Python through :attr:`__context__`. If there is no context associated, this + returns *NULL*. + + +.. c:function:: void PyException_SetContext(PyObject *ex, PyObject *ctx) + + Set the context associated with the exception to *ctx*. Use *NULL* to clear + it. There is no type check to make sure that *ctx* is an exception instance. + This steals a reference to *ctx*. + + +.. c:function:: PyObject* PyException_GetCause(PyObject *ex) + + Return the cause (either an exception instance, or :const:`None`, + set by ``raise ... from ...``) associated with the exception as a new + reference, as accessible from Python through :attr:`__cause__`. + + +.. c:function:: void PyException_SetCause(PyObject *ex, PyObject *cause) + + Set the cause associated with the exception to *cause*. Use *NULL* to clear + it. There is no type check to make sure that *cause* is either an exception + instance or :const:`None`. This steals a reference to *cause*. + + :attr:`__suppress_context__` is implicitly set to ``True`` by this function. + + +.. _unicodeexceptions: + +Unicode Exception Objects +========================= + +The following functions are used to create and modify Unicode exceptions from C. + +.. c:function:: PyObject* PyUnicodeDecodeError_Create(const char *encoding, const char *object, Py_ssize_t length, Py_ssize_t start, Py_ssize_t end, const char *reason) + + Create a :class:`UnicodeDecodeError` object with the attributes *encoding*, + *object*, *length*, *start*, *end* and *reason*. *encoding* and *reason* are + UTF-8 encoded strings. + +.. c:function:: PyObject* PyUnicodeEncodeError_Create(const char *encoding, const Py_UNICODE *object, Py_ssize_t length, Py_ssize_t start, Py_ssize_t end, const char *reason) + + Create a :class:`UnicodeEncodeError` object with the attributes *encoding*, + *object*, *length*, *start*, *end* and *reason*. *encoding* and *reason* are + UTF-8 encoded strings. + +.. c:function:: PyObject* PyUnicodeTranslateError_Create(const Py_UNICODE *object, Py_ssize_t length, Py_ssize_t start, Py_ssize_t end, const char *reason) + + Create a :class:`UnicodeTranslateError` object with the attributes *object*, + *length*, *start*, *end* and *reason*. *reason* is a UTF-8 encoded string. + +.. c:function:: PyObject* PyUnicodeDecodeError_GetEncoding(PyObject *exc) + PyObject* PyUnicodeEncodeError_GetEncoding(PyObject *exc) + + Return the *encoding* attribute of the given exception object. + +.. c:function:: PyObject* PyUnicodeDecodeError_GetObject(PyObject *exc) + PyObject* PyUnicodeEncodeError_GetObject(PyObject *exc) + PyObject* PyUnicodeTranslateError_GetObject(PyObject *exc) + + Return the *object* attribute of the given exception object. + +.. c:function:: int PyUnicodeDecodeError_GetStart(PyObject *exc, Py_ssize_t *start) + int PyUnicodeEncodeError_GetStart(PyObject *exc, Py_ssize_t *start) + int PyUnicodeTranslateError_GetStart(PyObject *exc, Py_ssize_t *start) + + Get the *start* attribute of the given exception object and place it into + *\*start*. *start* must not be *NULL*. Return ``0`` on success, ``-1`` on + failure. + +.. c:function:: int PyUnicodeDecodeError_SetStart(PyObject *exc, Py_ssize_t start) + int PyUnicodeEncodeError_SetStart(PyObject *exc, Py_ssize_t start) + int PyUnicodeTranslateError_SetStart(PyObject *exc, Py_ssize_t start) + + Set the *start* attribute of the given exception object to *start*. Return + ``0`` on success, ``-1`` on failure. + +.. c:function:: int PyUnicodeDecodeError_GetEnd(PyObject *exc, Py_ssize_t *end) + int PyUnicodeEncodeError_GetEnd(PyObject *exc, Py_ssize_t *end) + int PyUnicodeTranslateError_GetEnd(PyObject *exc, Py_ssize_t *end) + + Get the *end* attribute of the given exception object and place it into + *\*end*. *end* must not be *NULL*. Return ``0`` on success, ``-1`` on + failure. + +.. c:function:: int PyUnicodeDecodeError_SetEnd(PyObject *exc, Py_ssize_t end) + int PyUnicodeEncodeError_SetEnd(PyObject *exc, Py_ssize_t end) + int PyUnicodeTranslateError_SetEnd(PyObject *exc, Py_ssize_t end) + + Set the *end* attribute of the given exception object to *end*. Return ``0`` + on success, ``-1`` on failure. + +.. c:function:: PyObject* PyUnicodeDecodeError_GetReason(PyObject *exc) + PyObject* PyUnicodeEncodeError_GetReason(PyObject *exc) + PyObject* PyUnicodeTranslateError_GetReason(PyObject *exc) + + Return the *reason* attribute of the given exception object. + +.. c:function:: int PyUnicodeDecodeError_SetReason(PyObject *exc, const char *reason) + int PyUnicodeEncodeError_SetReason(PyObject *exc, const char *reason) + int PyUnicodeTranslateError_SetReason(PyObject *exc, const char *reason) + + Set the *reason* attribute of the given exception object to *reason*. Return + ``0`` on success, ``-1`` on failure. + + +Recursion Control +================= + +These two functions provide a way to perform safe recursive calls at the C +level, both in the core and in extension modules. They are needed if the +recursive code does not necessarily invoke Python code (which tracks its +recursion depth automatically). + +.. c:function:: int Py_EnterRecursiveCall(const char *where) + + Marks a point where a recursive C-level call is about to be performed. + + If :const:`USE_STACKCHECK` is defined, this function checks if the OS + stack overflowed using :c:func:`PyOS_CheckStack`. In this is the case, it + sets a :exc:`MemoryError` and returns a nonzero value. + + The function then checks if the recursion limit is reached. If this is the + case, a :exc:`RecursionError` is set and a nonzero value is returned. + Otherwise, zero is returned. + + *where* should be a string such as ``" in instance check"`` to be + concatenated to the :exc:`RecursionError` message caused by the recursion + depth limit. + +.. c:function:: void Py_LeaveRecursiveCall() + + Ends a :c:func:`Py_EnterRecursiveCall`. Must be called once for each + *successful* invocation of :c:func:`Py_EnterRecursiveCall`. + +Properly implementing :c:member:`~PyTypeObject.tp_repr` for container types requires +special recursion handling. In addition to protecting the stack, +:c:member:`~PyTypeObject.tp_repr` also needs to track objects to prevent cycles. The +following two functions facilitate this functionality. Effectively, +these are the C equivalent to :func:`reprlib.recursive_repr`. + +.. c:function:: int Py_ReprEnter(PyObject *object) + + Called at the beginning of the :c:member:`~PyTypeObject.tp_repr` implementation to + detect cycles. + + If the object has already been processed, the function returns a + positive integer. In that case the :c:member:`~PyTypeObject.tp_repr` implementation + should return a string object indicating a cycle. As examples, + :class:`dict` objects return ``{...}`` and :class:`list` objects + return ``[...]``. + + The function will return a negative integer if the recursion limit + is reached. In that case the :c:member:`~PyTypeObject.tp_repr` implementation should + typically return ``NULL``. + + Otherwise, the function returns zero and the :c:member:`~PyTypeObject.tp_repr` + implementation can continue normally. + +.. c:function:: void Py_ReprLeave(PyObject *object) + + Ends a :c:func:`Py_ReprEnter`. Must be called once for each + invocation of :c:func:`Py_ReprEnter` that returns zero. + + +.. _standardexceptions: + +Standard Exceptions +=================== + +All standard Python exceptions are available as global variables whose names are +``PyExc_`` followed by the Python exception name. These have the type +:c:type:`PyObject\*`; they are all class objects. For completeness, here are all +the variables: + +.. index:: + single: PyExc_BaseException + single: PyExc_Exception + single: PyExc_ArithmeticError + single: PyExc_AssertionError + single: PyExc_AttributeError + single: PyExc_BlockingIOError + single: PyExc_BrokenPipeError + single: PyExc_BufferError + single: PyExc_ChildProcessError + single: PyExc_ConnectionAbortedError + single: PyExc_ConnectionError + single: PyExc_ConnectionRefusedError + single: PyExc_ConnectionResetError + single: PyExc_EOFError + single: PyExc_FileExistsError + single: PyExc_FileNotFoundError + single: PyExc_FloatingPointError + single: PyExc_GeneratorExit + single: PyExc_ImportError + single: PyExc_IndentationError + single: PyExc_IndexError + single: PyExc_InterruptedError + single: PyExc_IsADirectoryError + single: PyExc_KeyError + single: PyExc_KeyboardInterrupt + single: PyExc_LookupError + single: PyExc_MemoryError + single: PyExc_ModuleNotFoundError + single: PyExc_NameError + single: PyExc_NotADirectoryError + single: PyExc_NotImplementedError + single: PyExc_OSError + single: PyExc_OverflowError + single: PyExc_PermissionError + single: PyExc_ProcessLookupError + single: PyExc_RecursionError + single: PyExc_ReferenceError + single: PyExc_RuntimeError + single: PyExc_StopAsyncIteration + single: PyExc_StopIteration + single: PyExc_SyntaxError + single: PyExc_SystemError + single: PyExc_SystemExit + single: PyExc_TabError + single: PyExc_TimeoutError + single: PyExc_TypeError + single: PyExc_UnboundLocalError + single: PyExc_UnicodeDecodeError + single: PyExc_UnicodeEncodeError + single: PyExc_UnicodeError + single: PyExc_UnicodeTranslateError + single: PyExc_ValueError + single: PyExc_ZeroDivisionError + ++-----------------------------------------+---------------------------------+----------+ +| C Name | Python Name | Notes | ++=========================================+=================================+==========+ +| :c:data:`PyExc_BaseException` | :exc:`BaseException` | \(1) | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_Exception` | :exc:`Exception` | \(1) | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_ArithmeticError` | :exc:`ArithmeticError` | \(1) | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_AssertionError` | :exc:`AssertionError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_AttributeError` | :exc:`AttributeError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_BlockingIOError` | :exc:`BlockingIOError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_BrokenPipeError` | :exc:`BrokenPipeError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_BufferError` | :exc:`BufferError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_ChildProcessError` | :exc:`ChildProcessError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_ConnectionAbortedError` | :exc:`ConnectionAbortedError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_ConnectionError` | :exc:`ConnectionError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_ConnectionRefusedError` | :exc:`ConnectionRefusedError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_ConnectionResetError` | :exc:`ConnectionResetError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_EOFError` | :exc:`EOFError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_FileExistsError` | :exc:`FileExistsError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_FileNotFoundError` | :exc:`FileNotFoundError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_FloatingPointError` | :exc:`FloatingPointError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_GeneratorExit` | :exc:`GeneratorExit` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_ImportError` | :exc:`ImportError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_IndentationError` | :exc:`IndentationError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_IndexError` | :exc:`IndexError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_InterruptedError` | :exc:`InterruptedError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_IsADirectoryError` | :exc:`IsADirectoryError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_KeyError` | :exc:`KeyError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_KeyboardInterrupt` | :exc:`KeyboardInterrupt` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_LookupError` | :exc:`LookupError` | \(1) | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_MemoryError` | :exc:`MemoryError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_ModuleNotFoundError` | :exc:`ModuleNotFoundError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_NameError` | :exc:`NameError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_NotADirectoryError` | :exc:`NotADirectoryError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_NotImplementedError` | :exc:`NotImplementedError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_OSError` | :exc:`OSError` | \(1) | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_OverflowError` | :exc:`OverflowError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_PermissionError` | :exc:`PermissionError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_ProcessLookupError` | :exc:`ProcessLookupError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_RecursionError` | :exc:`RecursionError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_ReferenceError` | :exc:`ReferenceError` | \(2) | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_RuntimeError` | :exc:`RuntimeError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_StopAsyncIteration` | :exc:`StopAsyncIteration` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_StopIteration` | :exc:`StopIteration` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_SyntaxError` | :exc:`SyntaxError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_SystemError` | :exc:`SystemError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_SystemExit` | :exc:`SystemExit` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_TabError` | :exc:`TabError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_TimeoutError` | :exc:`TimeoutError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_TypeError` | :exc:`TypeError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_UnboundLocalError` | :exc:`UnboundLocalError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_UnicodeDecodeError` | :exc:`UnicodeDecodeError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_UnicodeEncodeError` | :exc:`UnicodeEncodeError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_UnicodeError` | :exc:`UnicodeError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_UnicodeTranslateError` | :exc:`UnicodeTranslateError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_ValueError` | :exc:`ValueError` | | ++-----------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_ZeroDivisionError` | :exc:`ZeroDivisionError` | | ++-----------------------------------------+---------------------------------+----------+ + +.. versionadded:: 3.3 + :c:data:`PyExc_BlockingIOError`, :c:data:`PyExc_BrokenPipeError`, + :c:data:`PyExc_ChildProcessError`, :c:data:`PyExc_ConnectionError`, + :c:data:`PyExc_ConnectionAbortedError`, :c:data:`PyExc_ConnectionRefusedError`, + :c:data:`PyExc_ConnectionResetError`, :c:data:`PyExc_FileExistsError`, + :c:data:`PyExc_FileNotFoundError`, :c:data:`PyExc_InterruptedError`, + :c:data:`PyExc_IsADirectoryError`, :c:data:`PyExc_NotADirectoryError`, + :c:data:`PyExc_PermissionError`, :c:data:`PyExc_ProcessLookupError` + and :c:data:`PyExc_TimeoutError` were introduced following :pep:`3151`. + +.. versionadded:: 3.5 + :c:data:`PyExc_StopAsyncIteration` and :c:data:`PyExc_RecursionError`. + +.. versionadded:: 3.6 + :c:data:`PyExc_ModuleNotFoundError`. + +These are compatibility aliases to :c:data:`PyExc_OSError`: + +.. index:: + single: PyExc_EnvironmentError + single: PyExc_IOError + single: PyExc_WindowsError + ++-------------------------------------+----------+ +| C Name | Notes | ++=====================================+==========+ +| :c:data:`PyExc_EnvironmentError` | | ++-------------------------------------+----------+ +| :c:data:`PyExc_IOError` | | ++-------------------------------------+----------+ +| :c:data:`PyExc_WindowsError` | \(3) | ++-------------------------------------+----------+ + +.. versionchanged:: 3.3 + These aliases used to be separate exception types. + +Notes: + +(1) + This is a base class for other standard exceptions. + +(2) + This is the same as :exc:`weakref.ReferenceError`. + +(3) + Only defined on Windows; protect code that uses this by testing that the + preprocessor macro ``MS_WINDOWS`` is defined. + +.. _standardwarningcategories: + +Standard Warning Categories +=========================== + +All standard Python warning categories are available as global variables whose +names are ``PyExc_`` followed by the Python exception name. These have the type +:c:type:`PyObject\*`; they are all class objects. For completeness, here are all +the variables: + +.. index:: + single: PyExc_Warning + single: PyExc_BytesWarning + single: PyExc_DeprecationWarning + single: PyExc_FutureWarning + single: PyExc_ImportWarning + single: PyExc_PendingDeprecationWarning + single: PyExc_ResourceWarning + single: PyExc_RuntimeWarning + single: PyExc_SyntaxWarning + single: PyExc_UnicodeWarning + single: PyExc_UserWarning + ++------------------------------------------+---------------------------------+----------+ +| C Name | Python Name | Notes | ++==========================================+=================================+==========+ +| :c:data:`PyExc_Warning` | :exc:`Warning` | \(1) | ++------------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_BytesWarning` | :exc:`BytesWarning` | | ++------------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_DeprecationWarning` | :exc:`DeprecationWarning` | | ++------------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_FutureWarning` | :exc:`FutureWarning` | | ++------------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_ImportWarning` | :exc:`ImportWarning` | | ++------------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_PendingDeprecationWarning`| :exc:`PendingDeprecationWarning`| | ++------------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_ResourceWarning` | :exc:`ResourceWarning` | | ++------------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_RuntimeWarning` | :exc:`RuntimeWarning` | | ++------------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_SyntaxWarning` | :exc:`SyntaxWarning` | | ++------------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_UnicodeWarning` | :exc:`UnicodeWarning` | | ++------------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_UserWarning` | :exc:`UserWarning` | | ++------------------------------------------+---------------------------------+----------+ + +.. versionadded:: 3.2 + :c:data:`PyExc_ResourceWarning`. + +Notes: + +(1) + This is a base class for other standard warning categories. diff --git a/python-3.7.4-docs-html/_sources/c-api/file.rst.txt b/python-3.7.4-docs-html/_sources/c-api/file.rst.txt new file mode 100644 index 0000000..6f2ecee --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/file.rst.txt @@ -0,0 +1,76 @@ +.. highlightlang:: c + +.. _fileobjects: + +File Objects +------------ + +.. index:: object: file + +These APIs are a minimal emulation of the Python 2 C API for built-in file +objects, which used to rely on the buffered I/O (:c:type:`FILE\*`) support +from the C standard library. In Python 3, files and streams use the new +:mod:`io` module, which defines several layers over the low-level unbuffered +I/O of the operating system. The functions described below are +convenience C wrappers over these new APIs, and meant mostly for internal +error reporting in the interpreter; third-party code is advised to access +the :mod:`io` APIs instead. + + +.. c:function:: PyFile_FromFd(int fd, const char *name, const char *mode, int buffering, const char *encoding, const char *errors, const char *newline, int closefd) + + Create a Python file object from the file descriptor of an already + opened file *fd*. The arguments *name*, *encoding*, *errors* and *newline* + can be *NULL* to use the defaults; *buffering* can be *-1* to use the + default. *name* is ignored and kept for backward compatibility. Return + *NULL* on failure. For a more comprehensive description of the arguments, + please refer to the :func:`io.open` function documentation. + + .. warning:: + + Since Python streams have their own buffering layer, mixing them with + OS-level file descriptors can produce various issues (such as unexpected + ordering of data). + + .. versionchanged:: 3.2 + Ignore *name* attribute. + + +.. c:function:: int PyObject_AsFileDescriptor(PyObject *p) + + Return the file descriptor associated with *p* as an :c:type:`int`. If the + object is an integer, its value is returned. If not, the + object's :meth:`~io.IOBase.fileno` method is called if it exists; the + method must return an integer, which is returned as the file descriptor + value. Sets an exception and returns ``-1`` on failure. + + +.. c:function:: PyObject* PyFile_GetLine(PyObject *p, int n) + + .. index:: single: EOFError (built-in exception) + + Equivalent to ``p.readline([n])``, this function reads one line from the + object *p*. *p* may be a file object or any object with a + :meth:`~io.IOBase.readline` + method. If *n* is ``0``, exactly one line is read, regardless of the length of + the line. If *n* is greater than ``0``, no more than *n* bytes will be read + from the file; a partial line can be returned. In both cases, an empty string + is returned if the end of the file is reached immediately. If *n* is less than + ``0``, however, one line is read regardless of length, but :exc:`EOFError` is + raised if the end of the file is reached immediately. + + +.. c:function:: int PyFile_WriteObject(PyObject *obj, PyObject *p, int flags) + + .. index:: single: Py_PRINT_RAW + + Write object *obj* to file object *p*. The only supported flag for *flags* is + :const:`Py_PRINT_RAW`; if given, the :func:`str` of the object is written + instead of the :func:`repr`. Return ``0`` on success or ``-1`` on failure; the + appropriate exception will be set. + + +.. c:function:: int PyFile_WriteString(const char *s, PyObject *p) + + Write string *s* to file object *p*. Return ``0`` on success or ``-1`` on + failure; the appropriate exception will be set. diff --git a/python-3.7.4-docs-html/_sources/c-api/float.rst.txt b/python-3.7.4-docs-html/_sources/c-api/float.rst.txt new file mode 100644 index 0000000..27a75e3 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/float.rst.txt @@ -0,0 +1,79 @@ +.. highlightlang:: c + +.. _floatobjects: + +Floating Point Objects +---------------------- + +.. index:: object: floating point + + +.. c:type:: PyFloatObject + + This subtype of :c:type:`PyObject` represents a Python floating point object. + + +.. c:var:: PyTypeObject PyFloat_Type + + This instance of :c:type:`PyTypeObject` represents the Python floating point + type. This is the same object as :class:`float` in the Python layer. + + +.. c:function:: int PyFloat_Check(PyObject *p) + + Return true if its argument is a :c:type:`PyFloatObject` or a subtype of + :c:type:`PyFloatObject`. + + +.. c:function:: int PyFloat_CheckExact(PyObject *p) + + Return true if its argument is a :c:type:`PyFloatObject`, but not a subtype of + :c:type:`PyFloatObject`. + + +.. c:function:: PyObject* PyFloat_FromString(PyObject *str) + + Create a :c:type:`PyFloatObject` object based on the string value in *str*, or + *NULL* on failure. + + +.. c:function:: PyObject* PyFloat_FromDouble(double v) + + Create a :c:type:`PyFloatObject` object from *v*, or *NULL* on failure. + + +.. c:function:: double PyFloat_AsDouble(PyObject *pyfloat) + + Return a C :c:type:`double` representation of the contents of *pyfloat*. If + *pyfloat* is not a Python floating point object but has a :meth:`__float__` + method, this method will first be called to convert *pyfloat* into a float. + This method returns ``-1.0`` upon failure, so one should call + :c:func:`PyErr_Occurred` to check for errors. + + +.. c:function:: double PyFloat_AS_DOUBLE(PyObject *pyfloat) + + Return a C :c:type:`double` representation of the contents of *pyfloat*, but + without error checking. + + +.. c:function:: PyObject* PyFloat_GetInfo(void) + + Return a structseq instance which contains information about the + precision, minimum and maximum values of a float. It's a thin wrapper + around the header file :file:`float.h`. + + +.. c:function:: double PyFloat_GetMax() + + Return the maximum representable finite float *DBL_MAX* as C :c:type:`double`. + + +.. c:function:: double PyFloat_GetMin() + + Return the minimum normalized positive float *DBL_MIN* as C :c:type:`double`. + +.. c:function:: int PyFloat_ClearFreeList() + + Clear the float free list. Return the number of items that could not + be freed. diff --git a/python-3.7.4-docs-html/_sources/c-api/function.rst.txt b/python-3.7.4-docs-html/_sources/c-api/function.rst.txt new file mode 100644 index 0000000..17279c7 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/function.rst.txt @@ -0,0 +1,108 @@ +.. highlightlang:: c + +.. _function-objects: + +Function Objects +---------------- + +.. index:: object: function + +There are a few functions specific to Python functions. + + +.. c:type:: PyFunctionObject + + The C structure used for functions. + + +.. c:var:: PyTypeObject PyFunction_Type + + .. index:: single: MethodType (in module types) + + This is an instance of :c:type:`PyTypeObject` and represents the Python function + type. It is exposed to Python programmers as ``types.FunctionType``. + + +.. c:function:: int PyFunction_Check(PyObject *o) + + Return true if *o* is a function object (has type :c:data:`PyFunction_Type`). + The parameter must not be *NULL*. + + +.. c:function:: PyObject* PyFunction_New(PyObject *code, PyObject *globals) + + Return a new function object associated with the code object *code*. *globals* + must be a dictionary with the global variables accessible to the function. + + The function's docstring and name are retrieved from the code object. *__module__* + is retrieved from *globals*. The argument defaults, annotations and closure are + set to *NULL*. *__qualname__* is set to the same value as the function's name. + + +.. c:function:: PyObject* PyFunction_NewWithQualName(PyObject *code, PyObject *globals, PyObject *qualname) + + As :c:func:`PyFunction_New`, but also allows setting the function object's + ``__qualname__`` attribute. *qualname* should be a unicode object or NULL; + if NULL, the ``__qualname__`` attribute is set to the same value as its + ``__name__`` attribute. + + .. versionadded:: 3.3 + + +.. c:function:: PyObject* PyFunction_GetCode(PyObject *op) + + Return the code object associated with the function object *op*. + + +.. c:function:: PyObject* PyFunction_GetGlobals(PyObject *op) + + Return the globals dictionary associated with the function object *op*. + + +.. c:function:: PyObject* PyFunction_GetModule(PyObject *op) + + Return the *__module__* attribute of the function object *op*. This is normally + a string containing the module name, but can be set to any other object by + Python code. + + +.. c:function:: PyObject* PyFunction_GetDefaults(PyObject *op) + + Return the argument default values of the function object *op*. This can be a + tuple of arguments or *NULL*. + + +.. c:function:: int PyFunction_SetDefaults(PyObject *op, PyObject *defaults) + + Set the argument default values for the function object *op*. *defaults* must be + *Py_None* or a tuple. + + Raises :exc:`SystemError` and returns ``-1`` on failure. + + +.. c:function:: PyObject* PyFunction_GetClosure(PyObject *op) + + Return the closure associated with the function object *op*. This can be *NULL* + or a tuple of cell objects. + + +.. c:function:: int PyFunction_SetClosure(PyObject *op, PyObject *closure) + + Set the closure associated with the function object *op*. *closure* must be + *Py_None* or a tuple of cell objects. + + Raises :exc:`SystemError` and returns ``-1`` on failure. + + +.. c:function:: PyObject *PyFunction_GetAnnotations(PyObject *op) + + Return the annotations of the function object *op*. This can be a + mutable dictionary or *NULL*. + + +.. c:function:: int PyFunction_SetAnnotations(PyObject *op, PyObject *annotations) + + Set the annotations for the function object *op*. *annotations* + must be a dictionary or *Py_None*. + + Raises :exc:`SystemError` and returns ``-1`` on failure. diff --git a/python-3.7.4-docs-html/_sources/c-api/gcsupport.rst.txt b/python-3.7.4-docs-html/_sources/c-api/gcsupport.rst.txt new file mode 100644 index 0000000..472cd93 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/gcsupport.rst.txt @@ -0,0 +1,159 @@ +.. highlightlang:: c + +.. _supporting-cycle-detection: + +Supporting Cyclic Garbage Collection +==================================== + +Python's support for detecting and collecting garbage which involves circular +references requires support from object types which are "containers" for other +objects which may also be containers. Types which do not store references to +other objects, or which only store references to atomic types (such as numbers +or strings), do not need to provide any explicit support for garbage +collection. + +To create a container type, the :c:member:`~PyTypeObject.tp_flags` field of the type object must +include the :const:`Py_TPFLAGS_HAVE_GC` and provide an implementation of the +:c:member:`~PyTypeObject.tp_traverse` handler. If instances of the type are mutable, a +:c:member:`~PyTypeObject.tp_clear` implementation must also be provided. + + +.. data:: Py_TPFLAGS_HAVE_GC + :noindex: + + Objects with a type with this flag set must conform with the rules + documented here. For convenience these objects will be referred to as + container objects. + +Constructors for container types must conform to two rules: + +#. The memory for the object must be allocated using :c:func:`PyObject_GC_New` + or :c:func:`PyObject_GC_NewVar`. + +#. Once all the fields which may contain references to other containers are + initialized, it must call :c:func:`PyObject_GC_Track`. + + +.. c:function:: TYPE* PyObject_GC_New(TYPE, PyTypeObject *type) + + Analogous to :c:func:`PyObject_New` but for container objects with the + :const:`Py_TPFLAGS_HAVE_GC` flag set. + + +.. c:function:: TYPE* PyObject_GC_NewVar(TYPE, PyTypeObject *type, Py_ssize_t size) + + Analogous to :c:func:`PyObject_NewVar` but for container objects with the + :const:`Py_TPFLAGS_HAVE_GC` flag set. + + +.. c:function:: TYPE* PyObject_GC_Resize(TYPE, PyVarObject *op, Py_ssize_t newsize) + + Resize an object allocated by :c:func:`PyObject_NewVar`. Returns the + resized object or *NULL* on failure. *op* must not be tracked by the collector yet. + + +.. c:function:: void PyObject_GC_Track(PyObject *op) + + Adds the object *op* to the set of container objects tracked by the + collector. The collector can run at unexpected times so objects must be + valid while being tracked. This should be called once all the fields + followed by the :c:member:`~PyTypeObject.tp_traverse` handler become valid, usually near the + end of the constructor. + + +.. c:function:: void _PyObject_GC_TRACK(PyObject *op) + + A macro version of :c:func:`PyObject_GC_Track`. It should not be used for + extension modules. + + .. deprecated:: 3.6 + This macro is removed from Python 3.8. + +Similarly, the deallocator for the object must conform to a similar pair of +rules: + +#. Before fields which refer to other containers are invalidated, + :c:func:`PyObject_GC_UnTrack` must be called. + +#. The object's memory must be deallocated using :c:func:`PyObject_GC_Del`. + + +.. c:function:: void PyObject_GC_Del(void *op) + + Releases memory allocated to an object using :c:func:`PyObject_GC_New` or + :c:func:`PyObject_GC_NewVar`. + + +.. c:function:: void PyObject_GC_UnTrack(void *op) + + Remove the object *op* from the set of container objects tracked by the + collector. Note that :c:func:`PyObject_GC_Track` can be called again on + this object to add it back to the set of tracked objects. The deallocator + (:c:member:`~PyTypeObject.tp_dealloc` handler) should call this for the object before any of + the fields used by the :c:member:`~PyTypeObject.tp_traverse` handler become invalid. + + +.. c:function:: void _PyObject_GC_UNTRACK(PyObject *op) + + A macro version of :c:func:`PyObject_GC_UnTrack`. It should not be used for + extension modules. + + .. deprecated:: 3.6 + This macro is removed from Python 3.8. + +The :c:member:`~PyTypeObject.tp_traverse` handler accepts a function parameter of this type: + + +.. c:type:: int (*visitproc)(PyObject *object, void *arg) + + Type of the visitor function passed to the :c:member:`~PyTypeObject.tp_traverse` handler. + The function should be called with an object to traverse as *object* and + the third parameter to the :c:member:`~PyTypeObject.tp_traverse` handler as *arg*. The + Python core uses several visitor functions to implement cyclic garbage + detection; it's not expected that users will need to write their own + visitor functions. + +The :c:member:`~PyTypeObject.tp_traverse` handler must have the following type: + + +.. c:type:: int (*traverseproc)(PyObject *self, visitproc visit, void *arg) + + Traversal function for a container object. Implementations must call the + *visit* function for each object directly contained by *self*, with the + parameters to *visit* being the contained object and the *arg* value passed + to the handler. The *visit* function must not be called with a *NULL* + object argument. If *visit* returns a non-zero value that value should be + returned immediately. + +To simplify writing :c:member:`~PyTypeObject.tp_traverse` handlers, a :c:func:`Py_VISIT` macro is +provided. In order to use this macro, the :c:member:`~PyTypeObject.tp_traverse` implementation +must name its arguments exactly *visit* and *arg*: + + +.. c:function:: void Py_VISIT(PyObject *o) + + If *o* is not *NULL*, call the *visit* callback, with arguments *o* + and *arg*. If *visit* returns a non-zero value, then return it. + Using this macro, :c:member:`~PyTypeObject.tp_traverse` handlers + look like:: + + static int + my_traverse(Noddy *self, visitproc visit, void *arg) + { + Py_VISIT(self->foo); + Py_VISIT(self->bar); + return 0; + } + +The :c:member:`~PyTypeObject.tp_clear` handler must be of the :c:type:`inquiry` type, or *NULL* +if the object is immutable. + + +.. c:type:: int (*inquiry)(PyObject *self) + + Drop references that may have created reference cycles. Immutable objects + do not have to define this method since they can never directly create + reference cycles. Note that the object must still be valid after calling + this method (don't just call :c:func:`Py_DECREF` on a reference). The + collector will call this method if it detects that this object is involved + in a reference cycle. diff --git a/python-3.7.4-docs-html/_sources/c-api/gen.rst.txt b/python-3.7.4-docs-html/_sources/c-api/gen.rst.txt new file mode 100644 index 0000000..1efbae4 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/gen.rst.txt @@ -0,0 +1,44 @@ +.. highlightlang:: c + +.. _gen-objects: + +Generator Objects +----------------- + +Generator objects are what Python uses to implement generator iterators. They +are normally created by iterating over a function that yields values, rather +than explicitly calling :c:func:`PyGen_New` or :c:func:`PyGen_NewWithQualName`. + + +.. c:type:: PyGenObject + + The C structure used for generator objects. + + +.. c:var:: PyTypeObject PyGen_Type + + The type object corresponding to generator objects. + + +.. c:function:: int PyGen_Check(PyObject *ob) + + Return true if *ob* is a generator object; *ob* must not be *NULL*. + + +.. c:function:: int PyGen_CheckExact(PyObject *ob) + + Return true if *ob*'s type is *PyGen_Type*; *ob* must not be *NULL*. + + +.. c:function:: PyObject* PyGen_New(PyFrameObject *frame) + + Create and return a new generator object based on the *frame* object. + A reference to *frame* is stolen by this function. The argument must not be + *NULL*. + +.. c:function:: PyObject* PyGen_NewWithQualName(PyFrameObject *frame, PyObject *name, PyObject *qualname) + + Create and return a new generator object based on the *frame* object, + with ``__name__`` and ``__qualname__`` set to *name* and *qualname*. + A reference to *frame* is stolen by this function. The *frame* argument + must not be *NULL*. diff --git a/python-3.7.4-docs-html/_sources/c-api/import.rst.txt b/python-3.7.4-docs-html/_sources/c-api/import.rst.txt new file mode 100644 index 0000000..8cdc256 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/import.rst.txt @@ -0,0 +1,317 @@ +.. highlightlang:: c + +.. _importing: + +Importing Modules +================= + + +.. c:function:: PyObject* PyImport_ImportModule(const char *name) + + .. index:: + single: package variable; __all__ + single: __all__ (package variable) + single: modules (in module sys) + + This is a simplified interface to :c:func:`PyImport_ImportModuleEx` below, + leaving the *globals* and *locals* arguments set to *NULL* and *level* set + to 0. When the *name* + argument contains a dot (when it specifies a submodule of a package), the + *fromlist* argument is set to the list ``['*']`` so that the return value is the + named module rather than the top-level package containing it as would otherwise + be the case. (Unfortunately, this has an additional side effect when *name* in + fact specifies a subpackage instead of a submodule: the submodules specified in + the package's ``__all__`` variable are loaded.) Return a new reference to the + imported module, or *NULL* with an exception set on failure. A failing + import of a module doesn't leave the module in :data:`sys.modules`. + + This function always uses absolute imports. + + +.. c:function:: PyObject* PyImport_ImportModuleNoBlock(const char *name) + + This function is a deprecated alias of :c:func:`PyImport_ImportModule`. + + .. versionchanged:: 3.3 + This function used to fail immediately when the import lock was held + by another thread. In Python 3.3 though, the locking scheme switched + to per-module locks for most purposes, so this function's special + behaviour isn't needed anymore. + + +.. c:function:: PyObject* PyImport_ImportModuleEx(const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist) + + .. index:: builtin: __import__ + + Import a module. This is best described by referring to the built-in Python + function :func:`__import__`. + + The return value is a new reference to the imported module or top-level + package, or *NULL* with an exception set on failure. Like for + :func:`__import__`, the return value when a submodule of a package was + requested is normally the top-level package, unless a non-empty *fromlist* + was given. + + Failing imports remove incomplete module objects, like with + :c:func:`PyImport_ImportModule`. + + +.. c:function:: PyObject* PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level) + + Import a module. This is best described by referring to the built-in Python + function :func:`__import__`, as the standard :func:`__import__` function calls + this function directly. + + The return value is a new reference to the imported module or top-level package, + or *NULL* with an exception set on failure. Like for :func:`__import__`, + the return value when a submodule of a package was requested is normally the + top-level package, unless a non-empty *fromlist* was given. + + .. versionadded:: 3.3 + + +.. c:function:: PyObject* PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level) + + Similar to :c:func:`PyImport_ImportModuleLevelObject`, but the name is a + UTF-8 encoded string instead of a Unicode object. + + .. versionchanged:: 3.3 + Negative values for *level* are no longer accepted. + +.. c:function:: PyObject* PyImport_Import(PyObject *name) + + This is a higher-level interface that calls the current "import hook + function" (with an explicit *level* of 0, meaning absolute import). It + invokes the :func:`__import__` function from the ``__builtins__`` of the + current globals. This means that the import is done using whatever import + hooks are installed in the current environment. + + This function always uses absolute imports. + + +.. c:function:: PyObject* PyImport_ReloadModule(PyObject *m) + + Reload a module. Return a new reference to the reloaded module, or *NULL* with + an exception set on failure (the module still exists in this case). + + +.. c:function:: PyObject* PyImport_AddModuleObject(PyObject *name) + + Return the module object corresponding to a module name. The *name* argument + may be of the form ``package.module``. First check the modules dictionary if + there's one there, and if not, create a new one and insert it in the modules + dictionary. Return *NULL* with an exception set on failure. + + .. note:: + + This function does not load or import the module; if the module wasn't already + loaded, you will get an empty module object. Use :c:func:`PyImport_ImportModule` + or one of its variants to import a module. Package structures implied by a + dotted name for *name* are not created if not already present. + + .. versionadded:: 3.3 + + +.. c:function:: PyObject* PyImport_AddModule(const char *name) + + Similar to :c:func:`PyImport_AddModuleObject`, but the name is a UTF-8 + encoded string instead of a Unicode object. + + +.. c:function:: PyObject* PyImport_ExecCodeModule(const char *name, PyObject *co) + + .. index:: builtin: compile + + Given a module name (possibly of the form ``package.module``) and a code object + read from a Python bytecode file or obtained from the built-in function + :func:`compile`, load the module. Return a new reference to the module object, + or *NULL* with an exception set if an error occurred. *name* + is removed from :attr:`sys.modules` in error cases, even if *name* was already + in :attr:`sys.modules` on entry to :c:func:`PyImport_ExecCodeModule`. Leaving + incompletely initialized modules in :attr:`sys.modules` is dangerous, as imports of + such modules have no way to know that the module object is an unknown (and + probably damaged with respect to the module author's intents) state. + + The module's :attr:`__spec__` and :attr:`__loader__` will be set, if + not set already, with the appropriate values. The spec's loader will + be set to the module's ``__loader__`` (if set) and to an instance of + :class:`SourceFileLoader` otherwise. + + The module's :attr:`__file__` attribute will be set to the code object's + :c:member:`co_filename`. If applicable, :attr:`__cached__` will also + be set. + + This function will reload the module if it was already imported. See + :c:func:`PyImport_ReloadModule` for the intended way to reload a module. + + If *name* points to a dotted name of the form ``package.module``, any package + structures not already created will still not be created. + + See also :c:func:`PyImport_ExecCodeModuleEx` and + :c:func:`PyImport_ExecCodeModuleWithPathnames`. + + +.. c:function:: PyObject* PyImport_ExecCodeModuleEx(const char *name, PyObject *co, const char *pathname) + + Like :c:func:`PyImport_ExecCodeModule`, but the :attr:`__file__` attribute of + the module object is set to *pathname* if it is non-``NULL``. + + See also :c:func:`PyImport_ExecCodeModuleWithPathnames`. + + +.. c:function:: PyObject* PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname, PyObject *cpathname) + + Like :c:func:`PyImport_ExecCodeModuleEx`, but the :attr:`__cached__` + attribute of the module object is set to *cpathname* if it is + non-``NULL``. Of the three functions, this is the preferred one to use. + + .. versionadded:: 3.3 + + +.. c:function:: PyObject* PyImport_ExecCodeModuleWithPathnames(const char *name, PyObject *co, const char *pathname, const char *cpathname) + + Like :c:func:`PyImport_ExecCodeModuleObject`, but *name*, *pathname* and + *cpathname* are UTF-8 encoded strings. Attempts are also made to figure out + what the value for *pathname* should be from *cpathname* if the former is + set to ``NULL``. + + .. versionadded:: 3.2 + .. versionchanged:: 3.3 + Uses :func:`imp.source_from_cache()` in calculating the source path if + only the bytecode path is provided. + + +.. c:function:: long PyImport_GetMagicNumber() + + Return the magic number for Python bytecode files (a.k.a. :file:`.pyc` file). + The magic number should be present in the first four bytes of the bytecode + file, in little-endian byte order. Returns ``-1`` on error. + + .. versionchanged:: 3.3 + Return value of ``-1`` upon failure. + + +.. c:function:: const char * PyImport_GetMagicTag() + + Return the magic tag string for :pep:`3147` format Python bytecode file + names. Keep in mind that the value at ``sys.implementation.cache_tag`` is + authoritative and should be used instead of this function. + + .. versionadded:: 3.2 + +.. c:function:: PyObject* PyImport_GetModuleDict() + + Return the dictionary used for the module administration (a.k.a. + ``sys.modules``). Note that this is a per-interpreter variable. + +.. c:function:: PyObject* PyImport_GetModule(PyObject *name) + + Return the already imported module with the given name. If the + module has not been imported yet then returns NULL but does not set + an error. Returns NULL and sets an error if the lookup failed. + + .. versionadded:: 3.7 + +.. c:function:: PyObject* PyImport_GetImporter(PyObject *path) + + Return a finder object for a :data:`sys.path`/:attr:`pkg.__path__` item + *path*, possibly by fetching it from the :data:`sys.path_importer_cache` + dict. If it wasn't yet cached, traverse :data:`sys.path_hooks` until a hook + is found that can handle the path item. Return ``None`` if no hook could; + this tells our caller that the :term:`path based finder` could not find a + finder for this path item. Cache the result in :data:`sys.path_importer_cache`. + Return a new reference to the finder object. + + +.. c:function:: void _PyImport_Init() + + Initialize the import mechanism. For internal use only. + + +.. c:function:: void PyImport_Cleanup() + + Empty the module table. For internal use only. + + +.. c:function:: void _PyImport_Fini() + + Finalize the import mechanism. For internal use only. + + +.. c:function:: int PyImport_ImportFrozenModuleObject(PyObject *name) + + Load a frozen module named *name*. Return ``1`` for success, ``0`` if the + module is not found, and ``-1`` with an exception set if the initialization + failed. To access the imported module on a successful load, use + :c:func:`PyImport_ImportModule`. (Note the misnomer --- this function would + reload the module if it was already imported.) + + .. versionadded:: 3.3 + + .. versionchanged:: 3.4 + The ``__file__`` attribute is no longer set on the module. + + +.. c:function:: int PyImport_ImportFrozenModule(const char *name) + + Similar to :c:func:`PyImport_ImportFrozenModuleObject`, but the name is a + UTF-8 encoded string instead of a Unicode object. + + +.. c:type:: struct _frozen + + .. index:: single: freeze utility + + This is the structure type definition for frozen module descriptors, as + generated by the :program:`freeze` utility (see :file:`Tools/freeze/` in the + Python source distribution). Its definition, found in :file:`Include/import.h`, + is:: + + struct _frozen { + const char *name; + const unsigned char *code; + int size; + }; + + +.. c:var:: const struct _frozen* PyImport_FrozenModules + + This pointer is initialized to point to an array of :c:type:`struct _frozen` + records, terminated by one whose members are all *NULL* or zero. When a frozen + module is imported, it is searched in this table. Third-party code could play + tricks with this to provide a dynamically created collection of frozen modules. + + +.. c:function:: int PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void)) + + Add a single module to the existing table of built-in modules. This is a + convenience wrapper around :c:func:`PyImport_ExtendInittab`, returning ``-1`` if + the table could not be extended. The new module can be imported by the name + *name*, and uses the function *initfunc* as the initialization function called + on the first attempted import. This should be called before + :c:func:`Py_Initialize`. + + +.. c:type:: struct _inittab + + Structure describing a single entry in the list of built-in modules. Each of + these structures gives the name and initialization function for a module built + into the interpreter. The name is an ASCII encoded string. Programs which + embed Python may use an array of these structures in conjunction with + :c:func:`PyImport_ExtendInittab` to provide additional built-in modules. + The structure is defined in :file:`Include/import.h` as:: + + struct _inittab { + const char *name; /* ASCII encoded string */ + PyObject* (*initfunc)(void); + }; + + +.. c:function:: int PyImport_ExtendInittab(struct _inittab *newtab) + + Add a collection of modules to the table of built-in modules. The *newtab* + array must end with a sentinel entry which contains *NULL* for the :attr:`name` + field; failure to provide the sentinel value can result in a memory fault. + Returns ``0`` on success or ``-1`` if insufficient memory could be allocated to + extend the internal table. In the event of failure, no modules are added to the + internal table. This should be called before :c:func:`Py_Initialize`. diff --git a/python-3.7.4-docs-html/_sources/c-api/index.rst.txt b/python-3.7.4-docs-html/_sources/c-api/index.rst.txt new file mode 100644 index 0000000..3bfbaf4 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/index.rst.txt @@ -0,0 +1,26 @@ +.. _c-api-index: + +################################## + Python/C API Reference Manual +################################## + +This manual documents the API used by C and C++ programmers who want to write +extension modules or embed Python. It is a companion to :ref:`extending-index`, +which describes the general principles of extension writing but does not +document the API functions in detail. + +.. toctree:: + :maxdepth: 2 + + intro.rst + stable.rst + veryhigh.rst + refcounting.rst + exceptions.rst + utilities.rst + abstract.rst + concrete.rst + init.rst + memory.rst + objimpl.rst + apiabiversion.rst diff --git a/python-3.7.4-docs-html/_sources/c-api/init.rst.txt b/python-3.7.4-docs-html/_sources/c-api/init.rst.txt new file mode 100644 index 0000000..93fcfe6 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/init.rst.txt @@ -0,0 +1,1576 @@ +.. highlightlang:: c + + +.. _initialization: + +***************************************** +Initialization, Finalization, and Threads +***************************************** + +.. _pre-init-safe: + +Before Python Initialization +============================ + +In an application embedding Python, the :c:func:`Py_Initialize` function must +be called before using any other Python/C API functions; with the exception of +a few functions and the :ref:`global configuration variables +`. + +The following functions can be safely called before Python is initialized: + +* Configuration functions: + + * :c:func:`PyImport_AppendInittab` + * :c:func:`PyImport_ExtendInittab` + * :c:func:`PyInitFrozenExtensions` + * :c:func:`PyMem_SetAllocator` + * :c:func:`PyMem_SetupDebugHooks` + * :c:func:`PyObject_SetArenaAllocator` + * :c:func:`Py_SetPath` + * :c:func:`Py_SetProgramName` + * :c:func:`Py_SetPythonHome` + * :c:func:`Py_SetStandardStreamEncoding` + * :c:func:`PySys_AddWarnOption` + * :c:func:`PySys_AddXOption` + * :c:func:`PySys_ResetWarnOptions` + +* Informative functions: + + * :c:func:`Py_IsInitialized` + * :c:func:`PyMem_GetAllocator` + * :c:func:`PyObject_GetArenaAllocator` + * :c:func:`Py_GetBuildInfo` + * :c:func:`Py_GetCompiler` + * :c:func:`Py_GetCopyright` + * :c:func:`Py_GetPlatform` + * :c:func:`Py_GetVersion` + +* Utilities: + + * :c:func:`Py_DecodeLocale` + +* Memory allocators: + + * :c:func:`PyMem_RawMalloc` + * :c:func:`PyMem_RawRealloc` + * :c:func:`PyMem_RawCalloc` + * :c:func:`PyMem_RawFree` + +.. note:: + + The following functions **should not be called** before + :c:func:`Py_Initialize`: :c:func:`Py_EncodeLocale`, :c:func:`Py_GetPath`, + :c:func:`Py_GetPrefix`, :c:func:`Py_GetExecPrefix`, + :c:func:`Py_GetProgramFullPath`, :c:func:`Py_GetPythonHome`, + :c:func:`Py_GetProgramName` and :c:func:`PyEval_InitThreads`. + + +.. _global-conf-vars: + +Global configuration variables +============================== + +Python has variables for the global configuration to control different features +and options. By default, these flags are controlled by :ref:`command line +options `. + +When a flag is set by an option, the value of the flag is the number of times +that the option was set. For example, ``-b`` sets :c:data:`Py_BytesWarningFlag` +to 1 and ``-bb`` sets :c:data:`Py_BytesWarningFlag` to 2. + +.. c:var:: Py_BytesWarningFlag + + Issue a warning when comparing :class:`bytes` or :class:`bytearray` with + :class:`str` or :class:`bytes` with :class:`int`. Issue an error if greater + or equal to ``2``. + + Set by the :option:`-b` option. + +.. c:var:: Py_DebugFlag + + Turn on parser debugging output (for expert only, depending on compilation + options). + + Set by the :option:`-d` option and the :envvar:`PYTHONDEBUG` environment + variable. + +.. c:var:: Py_DontWriteBytecodeFlag + + If set to non-zero, Python won't try to write ``.pyc`` files on the + import of source modules. + + Set by the :option:`-B` option and the :envvar:`PYTHONDONTWRITEBYTECODE` + environment variable. + +.. c:var:: Py_FrozenFlag + + Suppress error messages when calculating the module search path in + :c:func:`Py_GetPath`. + + Private flag used by ``_freeze_importlib`` and ``frozenmain`` programs. + +.. c:var:: Py_HashRandomizationFlag + + Set to ``1`` if the :envvar:`PYTHONHASHSEED` environment variable is set to + a non-empty string. + + If the flag is non-zero, read the :envvar:`PYTHONHASHSEED` environment + variable to initialize the secret hash seed. + +.. c:var:: Py_IgnoreEnvironmentFlag + + Ignore all :envvar:`PYTHON*` environment variables, e.g. + :envvar:`PYTHONPATH` and :envvar:`PYTHONHOME`, that might be set. + + Set by the :option:`-E` and :option:`-I` options. + +.. c:var:: Py_InspectFlag + + When a script is passed as first argument or the :option:`-c` option is used, + enter interactive mode after executing the script or the command, even when + :data:`sys.stdin` does not appear to be a terminal. + + Set by the :option:`-i` option and the :envvar:`PYTHONINSPECT` environment + variable. + +.. c:var:: Py_InteractiveFlag + + Set by the :option:`-i` option. + +.. c:var:: Py_IsolatedFlag + + Run Python in isolated mode. In isolated mode :data:`sys.path` contains + neither the script's directory nor the user's site-packages directory. + + Set by the :option:`-I` option. + + .. versionadded:: 3.4 + +.. c:var:: Py_LegacyWindowsFSEncodingFlag + + If the flag is non-zero, use the ``mbcs`` encoding instead of the UTF-8 + encoding for the filesystem encoding. + + Set to ``1`` if the :envvar:`PYTHONLEGACYWINDOWSFSENCODING` environment + variable is set to a non-empty string. + + See :pep:`529` for more details. + + .. availability:: Windows. + +.. c:var:: Py_LegacyWindowsStdioFlag + + If the flag is non-zero, use :class:`io.FileIO` instead of + :class:`WindowsConsoleIO` for :mod:`sys` standard streams. + + Set to ``1`` if the :envvar:`PYTHONLEGACYWINDOWSSTDIO` environment + variable is set to a non-empty string. + + See :pep:`528` for more details. + + .. availability:: Windows. + +.. c:var:: Py_NoSiteFlag + + Disable the import of the module :mod:`site` and the site-dependent + manipulations of :data:`sys.path` that it entails. Also disable these + manipulations if :mod:`site` is explicitly imported later (call + :func:`site.main` if you want them to be triggered). + + Set by the :option:`-S` option. + +.. c:var:: Py_NoUserSiteDirectory + + Don't add the :data:`user site-packages directory ` to + :data:`sys.path`. + + Set by the :option:`-s` and :option:`-I` options, and the + :envvar:`PYTHONNOUSERSITE` environment variable. + +.. c:var:: Py_OptimizeFlag + + Set by the :option:`-O` option and the :envvar:`PYTHONOPTIMIZE` environment + variable. + +.. c:var:: Py_QuietFlag + + Don't display the copyright and version messages even in interactive mode. + + Set by the :option:`-q` option. + + .. versionadded:: 3.2 + +.. c:var:: Py_UnbufferedStdioFlag + + Force the stdout and stderr streams to be unbuffered. + + Set by the :option:`-u` option and the :envvar:`PYTHONUNBUFFERED` + environment variable. + +.. c:var:: Py_VerboseFlag + + Print a message each time a module is initialized, showing the place + (filename or built-in module) from which it is loaded. If greater or equal + to ``2``, print a message for each file that is checked for when + searching for a module. Also provides information on module cleanup at exit. + + Set by the :option:`-v` option and the :envvar:`PYTHONVERBOSE` environment + variable. + + +Initializing and finalizing the interpreter +=========================================== + + +.. c:function:: void Py_Initialize() + + .. index:: + single: Py_SetProgramName() + single: PyEval_InitThreads() + single: modules (in module sys) + single: path (in module sys) + module: builtins + module: __main__ + module: sys + triple: module; search; path + single: PySys_SetArgv() + single: PySys_SetArgvEx() + single: Py_FinalizeEx() + + Initialize the Python interpreter. In an application embedding Python, + this should be called before using any other Python/C API functions; see + :ref:`Before Python Initialization ` for the few exceptions. + + This initializes + the table of loaded modules (``sys.modules``), and creates the fundamental + modules :mod:`builtins`, :mod:`__main__` and :mod:`sys`. It also initializes + the module search path (``sys.path``). It does not set ``sys.argv``; use + :c:func:`PySys_SetArgvEx` for that. This is a no-op when called for a second time + (without calling :c:func:`Py_FinalizeEx` first). There is no return value; it is a + fatal error if the initialization fails. + + .. note:: + On Windows, changes the console mode from ``O_TEXT`` to ``O_BINARY``, which will + also affect non-Python uses of the console using the C Runtime. + + +.. c:function:: void Py_InitializeEx(int initsigs) + + This function works like :c:func:`Py_Initialize` if *initsigs* is ``1``. If + *initsigs* is ``0``, it skips initialization registration of signal handlers, which + might be useful when Python is embedded. + + +.. c:function:: int Py_IsInitialized() + + Return true (nonzero) when the Python interpreter has been initialized, false + (zero) if not. After :c:func:`Py_FinalizeEx` is called, this returns false until + :c:func:`Py_Initialize` is called again. + + +.. c:function:: int Py_FinalizeEx() + + Undo all initializations made by :c:func:`Py_Initialize` and subsequent use of + Python/C API functions, and destroy all sub-interpreters (see + :c:func:`Py_NewInterpreter` below) that were created and not yet destroyed since + the last call to :c:func:`Py_Initialize`. Ideally, this frees all memory + allocated by the Python interpreter. This is a no-op when called for a second + time (without calling :c:func:`Py_Initialize` again first). Normally the + return value is ``0``. If there were errors during finalization + (flushing buffered data), ``-1`` is returned. + + This function is provided for a number of reasons. An embedding application + might want to restart Python without having to restart the application itself. + An application that has loaded the Python interpreter from a dynamically + loadable library (or DLL) might want to free all memory allocated by Python + before unloading the DLL. During a hunt for memory leaks in an application a + developer might want to free all memory allocated by Python before exiting from + the application. + + **Bugs and caveats:** The destruction of modules and objects in modules is done + in random order; this may cause destructors (:meth:`__del__` methods) to fail + when they depend on other objects (even functions) or modules. Dynamically + loaded extension modules loaded by Python are not unloaded. Small amounts of + memory allocated by the Python interpreter may not be freed (if you find a leak, + please report it). Memory tied up in circular references between objects is not + freed. Some memory allocated by extension modules may not be freed. Some + extensions may not work properly if their initialization routine is called more + than once; this can happen if an application calls :c:func:`Py_Initialize` and + :c:func:`Py_FinalizeEx` more than once. + + .. versionadded:: 3.6 + + +.. c:function:: void Py_Finalize() + + This is a backwards-compatible version of :c:func:`Py_FinalizeEx` that + disregards the return value. + + +Process-wide parameters +======================= + + +.. c:function:: int Py_SetStandardStreamEncoding(const char *encoding, const char *errors) + + .. index:: + single: Py_Initialize() + single: main() + triple: stdin; stdout; sdterr + + This function should be called before :c:func:`Py_Initialize`, if it is + called at all. It specifies which encoding and error handling to use + with standard IO, with the same meanings as in :func:`str.encode`. + + It overrides :envvar:`PYTHONIOENCODING` values, and allows embedding code + to control IO encoding when the environment variable does not work. + + ``encoding`` and/or ``errors`` may be NULL to use + :envvar:`PYTHONIOENCODING` and/or default values (depending on other + settings). + + Note that :data:`sys.stderr` always uses the "backslashreplace" error + handler, regardless of this (or any other) setting. + + If :c:func:`Py_FinalizeEx` is called, this function will need to be called + again in order to affect subsequent calls to :c:func:`Py_Initialize`. + + Returns ``0`` if successful, a nonzero value on error (e.g. calling after the + interpreter has already been initialized). + + .. versionadded:: 3.4 + + +.. c:function:: void Py_SetProgramName(const wchar_t *name) + + .. index:: + single: Py_Initialize() + single: main() + single: Py_GetPath() + + This function should be called before :c:func:`Py_Initialize` is called for + the first time, if it is called at all. It tells the interpreter the value + of the ``argv[0]`` argument to the :c:func:`main` function of the program + (converted to wide characters). + This is used by :c:func:`Py_GetPath` and some other functions below to find + the Python run-time libraries relative to the interpreter executable. The + default value is ``'python'``. The argument should point to a + zero-terminated wide character string in static storage whose contents will not + change for the duration of the program's execution. No code in the Python + interpreter will change the contents of this storage. + + Use :c:func:`Py_DecodeLocale` to decode a bytes string to get a + :c:type:`wchar_*` string. + + +.. c:function:: wchar* Py_GetProgramName() + + .. index:: single: Py_SetProgramName() + + Return the program name set with :c:func:`Py_SetProgramName`, or the default. + The returned string points into static storage; the caller should not modify its + value. + + +.. c:function:: wchar_t* Py_GetPrefix() + + Return the *prefix* for installed platform-independent files. This is derived + through a number of complicated rules from the program name set with + :c:func:`Py_SetProgramName` and some environment variables; for example, if the + program name is ``'/usr/local/bin/python'``, the prefix is ``'/usr/local'``. The + returned string points into static storage; the caller should not modify its + value. This corresponds to the :makevar:`prefix` variable in the top-level + :file:`Makefile` and the ``--prefix`` argument to the :program:`configure` + script at build time. The value is available to Python code as ``sys.prefix``. + It is only useful on Unix. See also the next function. + + +.. c:function:: wchar_t* Py_GetExecPrefix() + + Return the *exec-prefix* for installed platform-*dependent* files. This is + derived through a number of complicated rules from the program name set with + :c:func:`Py_SetProgramName` and some environment variables; for example, if the + program name is ``'/usr/local/bin/python'``, the exec-prefix is + ``'/usr/local'``. The returned string points into static storage; the caller + should not modify its value. This corresponds to the :makevar:`exec_prefix` + variable in the top-level :file:`Makefile` and the ``--exec-prefix`` + argument to the :program:`configure` script at build time. The value is + available to Python code as ``sys.exec_prefix``. It is only useful on Unix. + + Background: The exec-prefix differs from the prefix when platform dependent + files (such as executables and shared libraries) are installed in a different + directory tree. In a typical installation, platform dependent files may be + installed in the :file:`/usr/local/plat` subtree while platform independent may + be installed in :file:`/usr/local`. + + Generally speaking, a platform is a combination of hardware and software + families, e.g. Sparc machines running the Solaris 2.x operating system are + considered the same platform, but Intel machines running Solaris 2.x are another + platform, and Intel machines running Linux are yet another platform. Different + major revisions of the same operating system generally also form different + platforms. Non-Unix operating systems are a different story; the installation + strategies on those systems are so different that the prefix and exec-prefix are + meaningless, and set to the empty string. Note that compiled Python bytecode + files are platform independent (but not independent from the Python version by + which they were compiled!). + + System administrators will know how to configure the :program:`mount` or + :program:`automount` programs to share :file:`/usr/local` between platforms + while having :file:`/usr/local/plat` be a different filesystem for each + platform. + + +.. c:function:: wchar_t* Py_GetProgramFullPath() + + .. index:: + single: Py_SetProgramName() + single: executable (in module sys) + + Return the full program name of the Python executable; this is computed as a + side-effect of deriving the default module search path from the program name + (set by :c:func:`Py_SetProgramName` above). The returned string points into + static storage; the caller should not modify its value. The value is available + to Python code as ``sys.executable``. + + +.. c:function:: wchar_t* Py_GetPath() + + .. index:: + triple: module; search; path + single: path (in module sys) + single: Py_SetPath() + + Return the default module search path; this is computed from the program name + (set by :c:func:`Py_SetProgramName` above) and some environment variables. + The returned string consists of a series of directory names separated by a + platform dependent delimiter character. The delimiter character is ``':'`` + on Unix and Mac OS X, ``';'`` on Windows. The returned string points into + static storage; the caller should not modify its value. The list + :data:`sys.path` is initialized with this value on interpreter startup; it + can be (and usually is) modified later to change the search path for loading + modules. + + .. XXX should give the exact rules + + +.. c:function:: void Py_SetPath(const wchar_t *) + + .. index:: + triple: module; search; path + single: path (in module sys) + single: Py_GetPath() + + Set the default module search path. If this function is called before + :c:func:`Py_Initialize`, then :c:func:`Py_GetPath` won't attempt to compute a + default search path but uses the one provided instead. This is useful if + Python is embedded by an application that has full knowledge of the location + of all modules. The path components should be separated by the platform + dependent delimiter character, which is ``':'`` on Unix and Mac OS X, ``';'`` + on Windows. + + This also causes :data:`sys.executable` to be set only to the raw program + name (see :c:func:`Py_SetProgramName`) and for :data:`sys.prefix` and + :data:`sys.exec_prefix` to be empty. It is up to the caller to modify these + if required after calling :c:func:`Py_Initialize`. + + Use :c:func:`Py_DecodeLocale` to decode a bytes string to get a + :c:type:`wchar_*` string. + + The path argument is copied internally, so the caller may free it after the + call completes. + + +.. c:function:: const char* Py_GetVersion() + + Return the version of this Python interpreter. This is a string that looks + something like :: + + "3.0a5+ (py3k:63103M, May 12 2008, 00:53:55) \n[GCC 4.2.3]" + + .. index:: single: version (in module sys) + + The first word (up to the first space character) is the current Python version; + the first three characters are the major and minor version separated by a + period. The returned string points into static storage; the caller should not + modify its value. The value is available to Python code as :data:`sys.version`. + + +.. c:function:: const char* Py_GetPlatform() + + .. index:: single: platform (in module sys) + + Return the platform identifier for the current platform. On Unix, this is + formed from the "official" name of the operating system, converted to lower + case, followed by the major revision number; e.g., for Solaris 2.x, which is + also known as SunOS 5.x, the value is ``'sunos5'``. On Mac OS X, it is + ``'darwin'``. On Windows, it is ``'win'``. The returned string points into + static storage; the caller should not modify its value. The value is available + to Python code as ``sys.platform``. + + +.. c:function:: const char* Py_GetCopyright() + + Return the official copyright string for the current Python version, for example + + ``'Copyright 1991-1995 Stichting Mathematisch Centrum, Amsterdam'`` + + .. index:: single: copyright (in module sys) + + The returned string points into static storage; the caller should not modify its + value. The value is available to Python code as ``sys.copyright``. + + +.. c:function:: const char* Py_GetCompiler() + + Return an indication of the compiler used to build the current Python version, + in square brackets, for example:: + + "[GCC 2.7.2.2]" + + .. index:: single: version (in module sys) + + The returned string points into static storage; the caller should not modify its + value. The value is available to Python code as part of the variable + ``sys.version``. + + +.. c:function:: const char* Py_GetBuildInfo() + + Return information about the sequence number and build date and time of the + current Python interpreter instance, for example :: + + "#67, Aug 1 1997, 22:34:28" + + .. index:: single: version (in module sys) + + The returned string points into static storage; the caller should not modify its + value. The value is available to Python code as part of the variable + ``sys.version``. + + +.. c:function:: void PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath) + + .. index:: + single: main() + single: Py_FatalError() + single: argv (in module sys) + + Set :data:`sys.argv` based on *argc* and *argv*. These parameters are + similar to those passed to the program's :c:func:`main` function with the + difference that the first entry should refer to the script file to be + executed rather than the executable hosting the Python interpreter. If there + isn't a script that will be run, the first entry in *argv* can be an empty + string. If this function fails to initialize :data:`sys.argv`, a fatal + condition is signalled using :c:func:`Py_FatalError`. + + If *updatepath* is zero, this is all the function does. If *updatepath* + is non-zero, the function also modifies :data:`sys.path` according to the + following algorithm: + + - If the name of an existing script is passed in ``argv[0]``, the absolute + path of the directory where the script is located is prepended to + :data:`sys.path`. + - Otherwise (that is, if *argc* is ``0`` or ``argv[0]`` doesn't point + to an existing file name), an empty string is prepended to + :data:`sys.path`, which is the same as prepending the current working + directory (``"."``). + + Use :c:func:`Py_DecodeLocale` to decode a bytes string to get a + :c:type:`wchar_*` string. + + .. note:: + It is recommended that applications embedding the Python interpreter + for purposes other than executing a single script pass ``0`` as *updatepath*, + and update :data:`sys.path` themselves if desired. + See `CVE-2008-5983 `_. + + On versions before 3.1.3, you can achieve the same effect by manually + popping the first :data:`sys.path` element after having called + :c:func:`PySys_SetArgv`, for example using:: + + PyRun_SimpleString("import sys; sys.path.pop(0)\n"); + + .. versionadded:: 3.1.3 + + .. XXX impl. doesn't seem consistent in allowing ``0``/``NULL`` for the params; + check w/ Guido. + + +.. c:function:: void PySys_SetArgv(int argc, wchar_t **argv) + + This function works like :c:func:`PySys_SetArgvEx` with *updatepath* set + to ``1`` unless the :program:`python` interpreter was started with the + :option:`-I`. + + Use :c:func:`Py_DecodeLocale` to decode a bytes string to get a + :c:type:`wchar_*` string. + + .. versionchanged:: 3.4 The *updatepath* value depends on :option:`-I`. + + +.. c:function:: void Py_SetPythonHome(const wchar_t *home) + + Set the default "home" directory, that is, the location of the standard + Python libraries. See :envvar:`PYTHONHOME` for the meaning of the + argument string. + + The argument should point to a zero-terminated character string in static + storage whose contents will not change for the duration of the program's + execution. No code in the Python interpreter will change the contents of + this storage. + + Use :c:func:`Py_DecodeLocale` to decode a bytes string to get a + :c:type:`wchar_*` string. + + +.. c:function:: w_char* Py_GetPythonHome() + + Return the default "home", that is, the value set by a previous call to + :c:func:`Py_SetPythonHome`, or the value of the :envvar:`PYTHONHOME` + environment variable if it is set. + + +.. _threads: + +Thread State and the Global Interpreter Lock +============================================ + +.. index:: + single: global interpreter lock + single: interpreter lock + single: lock, interpreter + +The Python interpreter is not fully thread-safe. In order to support +multi-threaded Python programs, there's a global lock, called the :term:`global +interpreter lock` or :term:`GIL`, that must be held by the current thread before +it can safely access Python objects. Without the lock, even the simplest +operations could cause problems in a multi-threaded program: for example, when +two threads simultaneously increment the reference count of the same object, the +reference count could end up being incremented only once instead of twice. + +.. index:: single: setswitchinterval() (in module sys) + +Therefore, the rule exists that only the thread that has acquired the +:term:`GIL` may operate on Python objects or call Python/C API functions. +In order to emulate concurrency of execution, the interpreter regularly +tries to switch threads (see :func:`sys.setswitchinterval`). The lock is also +released around potentially blocking I/O operations like reading or writing +a file, so that other Python threads can run in the meantime. + +.. index:: + single: PyThreadState + single: PyThreadState + +The Python interpreter keeps some thread-specific bookkeeping information +inside a data structure called :c:type:`PyThreadState`. There's also one +global variable pointing to the current :c:type:`PyThreadState`: it can +be retrieved using :c:func:`PyThreadState_Get`. + +Releasing the GIL from extension code +------------------------------------- + +Most extension code manipulating the :term:`GIL` has the following simple +structure:: + + Save the thread state in a local variable. + Release the global interpreter lock. + ... Do some blocking I/O operation ... + Reacquire the global interpreter lock. + Restore the thread state from the local variable. + +This is so common that a pair of macros exists to simplify it:: + + Py_BEGIN_ALLOW_THREADS + ... Do some blocking I/O operation ... + Py_END_ALLOW_THREADS + +.. index:: + single: Py_BEGIN_ALLOW_THREADS + single: Py_END_ALLOW_THREADS + +The :c:macro:`Py_BEGIN_ALLOW_THREADS` macro opens a new block and declares a +hidden local variable; the :c:macro:`Py_END_ALLOW_THREADS` macro closes the +block. + +The block above expands to the following code:: + + PyThreadState *_save; + + _save = PyEval_SaveThread(); + ... Do some blocking I/O operation ... + PyEval_RestoreThread(_save); + +.. index:: + single: PyEval_RestoreThread() + single: PyEval_SaveThread() + +Here is how these functions work: the global interpreter lock is used to protect the pointer to the +current thread state. When releasing the lock and saving the thread state, +the current thread state pointer must be retrieved before the lock is released +(since another thread could immediately acquire the lock and store its own thread +state in the global variable). Conversely, when acquiring the lock and restoring +the thread state, the lock must be acquired before storing the thread state +pointer. + +.. note:: + Calling system I/O functions is the most common use case for releasing + the GIL, but it can also be useful before calling long-running computations + which don't need access to Python objects, such as compression or + cryptographic functions operating over memory buffers. For example, the + standard :mod:`zlib` and :mod:`hashlib` modules release the GIL when + compressing or hashing data. + + +.. _gilstate: + +Non-Python created threads +-------------------------- + +When threads are created using the dedicated Python APIs (such as the +:mod:`threading` module), a thread state is automatically associated to them +and the code showed above is therefore correct. However, when threads are +created from C (for example by a third-party library with its own thread +management), they don't hold the GIL, nor is there a thread state structure +for them. + +If you need to call Python code from these threads (often this will be part +of a callback API provided by the aforementioned third-party library), +you must first register these threads with the interpreter by +creating a thread state data structure, then acquiring the GIL, and finally +storing their thread state pointer, before you can start using the Python/C +API. When you are done, you should reset the thread state pointer, release +the GIL, and finally free the thread state data structure. + +The :c:func:`PyGILState_Ensure` and :c:func:`PyGILState_Release` functions do +all of the above automatically. The typical idiom for calling into Python +from a C thread is:: + + PyGILState_STATE gstate; + gstate = PyGILState_Ensure(); + + /* Perform Python actions here. */ + result = CallSomeFunction(); + /* evaluate result or handle exception */ + + /* Release the thread. No Python API allowed beyond this point. */ + PyGILState_Release(gstate); + +Note that the :c:func:`PyGILState_\*` functions assume there is only one global +interpreter (created automatically by :c:func:`Py_Initialize`). Python +supports the creation of additional interpreters (using +:c:func:`Py_NewInterpreter`), but mixing multiple interpreters and the +:c:func:`PyGILState_\*` API is unsupported. + +Another important thing to note about threads is their behaviour in the face +of the C :c:func:`fork` call. On most systems with :c:func:`fork`, after a +process forks only the thread that issued the fork will exist. That also +means any locks held by other threads will never be released. Python solves +this for :func:`os.fork` by acquiring the locks it uses internally before +the fork, and releasing them afterwards. In addition, it resets any +:ref:`lock-objects` in the child. When extending or embedding Python, there +is no way to inform Python of additional (non-Python) locks that need to be +acquired before or reset after a fork. OS facilities such as +:c:func:`pthread_atfork` would need to be used to accomplish the same thing. +Additionally, when extending or embedding Python, calling :c:func:`fork` +directly rather than through :func:`os.fork` (and returning to or calling +into Python) may result in a deadlock by one of Python's internal locks +being held by a thread that is defunct after the fork. +:c:func:`PyOS_AfterFork_Child` tries to reset the necessary locks, but is not +always able to. + + +High-level API +-------------- + +These are the most commonly used types and functions when writing C extension +code, or when embedding the Python interpreter: + +.. c:type:: PyInterpreterState + + This data structure represents the state shared by a number of cooperating + threads. Threads belonging to the same interpreter share their module + administration and a few other internal items. There are no public members in + this structure. + + Threads belonging to different interpreters initially share nothing, except + process state like available memory, open file descriptors and such. The global + interpreter lock is also shared by all threads, regardless of to which + interpreter they belong. + + +.. c:type:: PyThreadState + + This data structure represents the state of a single thread. The only public + data member is :c:type:`PyInterpreterState \*`:attr:`interp`, which points to + this thread's interpreter state. + + +.. c:function:: void PyEval_InitThreads() + + .. index:: + single: PyEval_AcquireThread() + single: PyEval_ReleaseThread() + single: PyEval_SaveThread() + single: PyEval_RestoreThread() + + Initialize and acquire the global interpreter lock. It should be called in the + main thread before creating a second thread or engaging in any other thread + operations such as ``PyEval_ReleaseThread(tstate)``. It is not needed before + calling :c:func:`PyEval_SaveThread` or :c:func:`PyEval_RestoreThread`. + + This is a no-op when called for a second time. + + .. versionchanged:: 3.7 + This function is now called by :c:func:`Py_Initialize()`, so you don't + have to call it yourself anymore. + + .. versionchanged:: 3.2 + This function cannot be called before :c:func:`Py_Initialize()` anymore. + + .. index:: module: _thread + + +.. c:function:: int PyEval_ThreadsInitialized() + + Returns a non-zero value if :c:func:`PyEval_InitThreads` has been called. This + function can be called without holding the GIL, and therefore can be used to + avoid calls to the locking API when running single-threaded. + + .. versionchanged:: 3.7 + The :term:`GIL` is now initialized by :c:func:`Py_Initialize()`. + + +.. c:function:: PyThreadState* PyEval_SaveThread() + + Release the global interpreter lock (if it has been created and thread + support is enabled) and reset the thread state to *NULL*, returning the + previous thread state (which is not *NULL*). If the lock has been created, + the current thread must have acquired it. + + +.. c:function:: void PyEval_RestoreThread(PyThreadState *tstate) + + Acquire the global interpreter lock (if it has been created and thread + support is enabled) and set the thread state to *tstate*, which must not be + *NULL*. If the lock has been created, the current thread must not have + acquired it, otherwise deadlock ensues. + + .. note:: + Calling this function from a thread when the runtime is finalizing + will terminate the thread, even if the thread was not created by Python. + You can use :c:func:`_Py_IsFinalizing` or :func:`sys.is_finalizing` to + check if the interpreter is in process of being finalized before calling + this function to avoid unwanted termination. + +.. c:function:: PyThreadState* PyThreadState_Get() + + Return the current thread state. The global interpreter lock must be held. + When the current thread state is *NULL*, this issues a fatal error (so that + the caller needn't check for *NULL*). + + +.. c:function:: PyThreadState* PyThreadState_Swap(PyThreadState *tstate) + + Swap the current thread state with the thread state given by the argument + *tstate*, which may be *NULL*. The global interpreter lock must be held + and is not released. + + +.. c:function:: void PyEval_ReInitThreads() + + This function is called from :c:func:`PyOS_AfterFork_Child` to ensure + that newly created child processes don't hold locks referring to threads + which are not running in the child process. + + +The following functions use thread-local storage, and are not compatible +with sub-interpreters: + +.. c:function:: PyGILState_STATE PyGILState_Ensure() + + Ensure that the current thread is ready to call the Python C API regardless + of the current state of Python, or of the global interpreter lock. This may + be called as many times as desired by a thread as long as each call is + matched with a call to :c:func:`PyGILState_Release`. In general, other + thread-related APIs may be used between :c:func:`PyGILState_Ensure` and + :c:func:`PyGILState_Release` calls as long as the thread state is restored to + its previous state before the Release(). For example, normal usage of the + :c:macro:`Py_BEGIN_ALLOW_THREADS` and :c:macro:`Py_END_ALLOW_THREADS` macros is + acceptable. + + The return value is an opaque "handle" to the thread state when + :c:func:`PyGILState_Ensure` was called, and must be passed to + :c:func:`PyGILState_Release` to ensure Python is left in the same state. Even + though recursive calls are allowed, these handles *cannot* be shared - each + unique call to :c:func:`PyGILState_Ensure` must save the handle for its call + to :c:func:`PyGILState_Release`. + + When the function returns, the current thread will hold the GIL and be able + to call arbitrary Python code. Failure is a fatal error. + + .. note:: + Calling this function from a thread when the runtime is finalizing + will terminate the thread, even if the thread was not created by Python. + You can use :c:func:`_Py_IsFinalizing` or :func:`sys.is_finalizing` to + check if the interpreter is in process of being finalized before calling + this function to avoid unwanted termination. + +.. c:function:: void PyGILState_Release(PyGILState_STATE) + + Release any resources previously acquired. After this call, Python's state will + be the same as it was prior to the corresponding :c:func:`PyGILState_Ensure` call + (but generally this state will be unknown to the caller, hence the use of the + GILState API). + + Every call to :c:func:`PyGILState_Ensure` must be matched by a call to + :c:func:`PyGILState_Release` on the same thread. + + +.. c:function:: PyThreadState* PyGILState_GetThisThreadState() + + Get the current thread state for this thread. May return ``NULL`` if no + GILState API has been used on the current thread. Note that the main thread + always has such a thread-state, even if no auto-thread-state call has been + made on the main thread. This is mainly a helper/diagnostic function. + + +.. c:function:: int PyGILState_Check() + + Return ``1`` if the current thread is holding the GIL and ``0`` otherwise. + This function can be called from any thread at any time. + Only if it has had its Python thread state initialized and currently is + holding the GIL will it return ``1``. + This is mainly a helper/diagnostic function. It can be useful + for example in callback contexts or memory allocation functions when + knowing that the GIL is locked can allow the caller to perform sensitive + actions or otherwise behave differently. + + .. versionadded:: 3.4 + + +The following macros are normally used without a trailing semicolon; look for +example usage in the Python source distribution. + + +.. c:macro:: Py_BEGIN_ALLOW_THREADS + + This macro expands to ``{ PyThreadState *_save; _save = PyEval_SaveThread();``. + Note that it contains an opening brace; it must be matched with a following + :c:macro:`Py_END_ALLOW_THREADS` macro. See above for further discussion of this + macro. + + +.. c:macro:: Py_END_ALLOW_THREADS + + This macro expands to ``PyEval_RestoreThread(_save); }``. Note that it contains + a closing brace; it must be matched with an earlier + :c:macro:`Py_BEGIN_ALLOW_THREADS` macro. See above for further discussion of + this macro. + + +.. c:macro:: Py_BLOCK_THREADS + + This macro expands to ``PyEval_RestoreThread(_save);``: it is equivalent to + :c:macro:`Py_END_ALLOW_THREADS` without the closing brace. + + +.. c:macro:: Py_UNBLOCK_THREADS + + This macro expands to ``_save = PyEval_SaveThread();``: it is equivalent to + :c:macro:`Py_BEGIN_ALLOW_THREADS` without the opening brace and variable + declaration. + + +Low-level API +------------- + +All of the following functions must be called after :c:func:`Py_Initialize`. + +.. versionchanged:: 3.7 + :c:func:`Py_Initialize()` now initializes the :term:`GIL`. + + +.. c:function:: PyInterpreterState* PyInterpreterState_New() + + Create a new interpreter state object. The global interpreter lock need not + be held, but may be held if it is necessary to serialize calls to this + function. + + +.. c:function:: void PyInterpreterState_Clear(PyInterpreterState *interp) + + Reset all information in an interpreter state object. The global interpreter + lock must be held. + + +.. c:function:: void PyInterpreterState_Delete(PyInterpreterState *interp) + + Destroy an interpreter state object. The global interpreter lock need not be + held. The interpreter state must have been reset with a previous call to + :c:func:`PyInterpreterState_Clear`. + + +.. c:function:: PyThreadState* PyThreadState_New(PyInterpreterState *interp) + + Create a new thread state object belonging to the given interpreter object. + The global interpreter lock need not be held, but may be held if it is + necessary to serialize calls to this function. + + +.. c:function:: void PyThreadState_Clear(PyThreadState *tstate) + + Reset all information in a thread state object. The global interpreter lock + must be held. + + +.. c:function:: void PyThreadState_Delete(PyThreadState *tstate) + + Destroy a thread state object. The global interpreter lock need not be held. + The thread state must have been reset with a previous call to + :c:func:`PyThreadState_Clear`. + + +.. c:function:: PY_INT64_T PyInterpreterState_GetID(PyInterpreterState *interp) + + Return the interpreter's unique ID. If there was any error in doing + so then ``-1`` is returned and an error is set. + + .. versionadded:: 3.7 + + +.. c:function:: PyObject* PyThreadState_GetDict() + + Return a dictionary in which extensions can store thread-specific state + information. Each extension should use a unique key to use to store state in + the dictionary. It is okay to call this function when no current thread state + is available. If this function returns *NULL*, no exception has been raised and + the caller should assume no current thread state is available. + + +.. c:function:: int PyThreadState_SetAsyncExc(unsigned long id, PyObject *exc) + + Asynchronously raise an exception in a thread. The *id* argument is the thread + id of the target thread; *exc* is the exception object to be raised. This + function does not steal any references to *exc*. To prevent naive misuse, you + must write your own C extension to call this. Must be called with the GIL held. + Returns the number of thread states modified; this is normally one, but will be + zero if the thread id isn't found. If *exc* is :const:`NULL`, the pending + exception (if any) for the thread is cleared. This raises no exceptions. + + .. versionchanged:: 3.7 + The type of the *id* parameter changed from :c:type:`long` to + :c:type:`unsigned long`. + +.. c:function:: void PyEval_AcquireThread(PyThreadState *tstate) + + Acquire the global interpreter lock and set the current thread state to + *tstate*, which should not be *NULL*. The lock must have been created earlier. + If this thread already has the lock, deadlock ensues. + + :c:func:`PyEval_RestoreThread` is a higher-level function which is always + available (even when threads have not been initialized). + + +.. c:function:: void PyEval_ReleaseThread(PyThreadState *tstate) + + Reset the current thread state to *NULL* and release the global interpreter + lock. The lock must have been created earlier and must be held by the current + thread. The *tstate* argument, which must not be *NULL*, is only used to check + that it represents the current thread state --- if it isn't, a fatal error is + reported. + + :c:func:`PyEval_SaveThread` is a higher-level function which is always + available (even when threads have not been initialized). + + +.. c:function:: void PyEval_AcquireLock() + + Acquire the global interpreter lock. The lock must have been created earlier. + If this thread already has the lock, a deadlock ensues. + + .. deprecated:: 3.2 + This function does not update the current thread state. Please use + :c:func:`PyEval_RestoreThread` or :c:func:`PyEval_AcquireThread` + instead. + + +.. c:function:: void PyEval_ReleaseLock() + + Release the global interpreter lock. The lock must have been created earlier. + + .. deprecated:: 3.2 + This function does not update the current thread state. Please use + :c:func:`PyEval_SaveThread` or :c:func:`PyEval_ReleaseThread` + instead. + + +.. _sub-interpreter-support: + +Sub-interpreter support +======================= + +While in most uses, you will only embed a single Python interpreter, there +are cases where you need to create several independent interpreters in the +same process and perhaps even in the same thread. Sub-interpreters allow +you to do that. You can switch between sub-interpreters using the +:c:func:`PyThreadState_Swap` function. You can create and destroy them +using the following functions: + + +.. c:function:: PyThreadState* Py_NewInterpreter() + + .. index:: + module: builtins + module: __main__ + module: sys + single: stdout (in module sys) + single: stderr (in module sys) + single: stdin (in module sys) + + Create a new sub-interpreter. This is an (almost) totally separate environment + for the execution of Python code. In particular, the new interpreter has + separate, independent versions of all imported modules, including the + fundamental modules :mod:`builtins`, :mod:`__main__` and :mod:`sys`. The + table of loaded modules (``sys.modules``) and the module search path + (``sys.path``) are also separate. The new environment has no ``sys.argv`` + variable. It has new standard I/O stream file objects ``sys.stdin``, + ``sys.stdout`` and ``sys.stderr`` (however these refer to the same underlying + file descriptors). + + The return value points to the first thread state created in the new + sub-interpreter. This thread state is made in the current thread state. + Note that no actual thread is created; see the discussion of thread states + below. If creation of the new interpreter is unsuccessful, *NULL* is + returned; no exception is set since the exception state is stored in the + current thread state and there may not be a current thread state. (Like all + other Python/C API functions, the global interpreter lock must be held before + calling this function and is still held when it returns; however, unlike most + other Python/C API functions, there needn't be a current thread state on + entry.) + + .. index:: + single: Py_FinalizeEx() + single: Py_Initialize() + + Extension modules are shared between (sub-)interpreters as follows: the first + time a particular extension is imported, it is initialized normally, and a + (shallow) copy of its module's dictionary is squirreled away. When the same + extension is imported by another (sub-)interpreter, a new module is initialized + and filled with the contents of this copy; the extension's ``init`` function is + not called. Note that this is different from what happens when an extension is + imported after the interpreter has been completely re-initialized by calling + :c:func:`Py_FinalizeEx` and :c:func:`Py_Initialize`; in that case, the extension's + ``initmodule`` function *is* called again. + + .. index:: single: close() (in module os) + + +.. c:function:: void Py_EndInterpreter(PyThreadState *tstate) + + .. index:: single: Py_FinalizeEx() + + Destroy the (sub-)interpreter represented by the given thread state. The given + thread state must be the current thread state. See the discussion of thread + states below. When the call returns, the current thread state is *NULL*. All + thread states associated with this interpreter are destroyed. (The global + interpreter lock must be held before calling this function and is still held + when it returns.) :c:func:`Py_FinalizeEx` will destroy all sub-interpreters that + haven't been explicitly destroyed at that point. + + +Bugs and caveats +---------------- + +Because sub-interpreters (and the main interpreter) are part of the same +process, the insulation between them isn't perfect --- for example, using +low-level file operations like :func:`os.close` they can +(accidentally or maliciously) affect each other's open files. Because of the +way extensions are shared between (sub-)interpreters, some extensions may not +work properly; this is especially likely when the extension makes use of +(static) global variables, or when the extension manipulates its module's +dictionary after its initialization. It is possible to insert objects created +in one sub-interpreter into a namespace of another sub-interpreter; this should +be done with great care to avoid sharing user-defined functions, methods, +instances or classes between sub-interpreters, since import operations executed +by such objects may affect the wrong (sub-)interpreter's dictionary of loaded +modules. + +Also note that combining this functionality with :c:func:`PyGILState_\*` APIs +is delicate, because these APIs assume a bijection between Python thread states +and OS-level threads, an assumption broken by the presence of sub-interpreters. +It is highly recommended that you don't switch sub-interpreters between a pair +of matching :c:func:`PyGILState_Ensure` and :c:func:`PyGILState_Release` calls. +Furthermore, extensions (such as :mod:`ctypes`) using these APIs to allow calling +of Python code from non-Python created threads will probably be broken when using +sub-interpreters. + + +Asynchronous Notifications +========================== + +A mechanism is provided to make asynchronous notifications to the main +interpreter thread. These notifications take the form of a function +pointer and a void pointer argument. + + +.. c:function:: int Py_AddPendingCall(int (*func)(void *), void *arg) + + .. index:: single: Py_AddPendingCall() + + Schedule a function to be called from the main interpreter thread. On + success, ``0`` is returned and *func* is queued for being called in the + main thread. On failure, ``-1`` is returned without setting any exception. + + When successfully queued, *func* will be *eventually* called from the + main interpreter thread with the argument *arg*. It will be called + asynchronously with respect to normally running Python code, but with + both these conditions met: + + * on a :term:`bytecode` boundary; + * with the main thread holding the :term:`global interpreter lock` + (*func* can therefore use the full C API). + + *func* must return ``0`` on success, or ``-1`` on failure with an exception + set. *func* won't be interrupted to perform another asynchronous + notification recursively, but it can still be interrupted to switch + threads if the global interpreter lock is released. + + This function doesn't need a current thread state to run, and it doesn't + need the global interpreter lock. + + .. warning:: + This is a low-level function, only useful for very special cases. + There is no guarantee that *func* will be called as quick as + possible. If the main thread is busy executing a system call, + *func* won't be called before the system call returns. This + function is generally **not** suitable for calling Python code from + arbitrary C threads. Instead, use the :ref:`PyGILState API`. + + .. versionadded:: 3.1 + +.. _profiling: + +Profiling and Tracing +===================== + +.. sectionauthor:: Fred L. Drake, Jr. + + +The Python interpreter provides some low-level support for attaching profiling +and execution tracing facilities. These are used for profiling, debugging, and +coverage analysis tools. + +This C interface allows the profiling or tracing code to avoid the overhead of +calling through Python-level callable objects, making a direct C function call +instead. The essential attributes of the facility have not changed; the +interface allows trace functions to be installed per-thread, and the basic +events reported to the trace function are the same as had been reported to the +Python-level trace functions in previous versions. + + +.. c:type:: int (*Py_tracefunc)(PyObject *obj, PyFrameObject *frame, int what, PyObject *arg) + + The type of the trace function registered using :c:func:`PyEval_SetProfile` and + :c:func:`PyEval_SetTrace`. The first parameter is the object passed to the + registration function as *obj*, *frame* is the frame object to which the event + pertains, *what* is one of the constants :const:`PyTrace_CALL`, + :const:`PyTrace_EXCEPTION`, :const:`PyTrace_LINE`, :const:`PyTrace_RETURN`, + :const:`PyTrace_C_CALL`, :const:`PyTrace_C_EXCEPTION`, :const:`PyTrace_C_RETURN`, + or :const:`PyTrace_OPCODE`, and *arg* depends on the value of *what*: + + +------------------------------+--------------------------------------+ + | Value of *what* | Meaning of *arg* | + +==============================+======================================+ + | :const:`PyTrace_CALL` | Always :c:data:`Py_None`. | + +------------------------------+--------------------------------------+ + | :const:`PyTrace_EXCEPTION` | Exception information as returned by | + | | :func:`sys.exc_info`. | + +------------------------------+--------------------------------------+ + | :const:`PyTrace_LINE` | Always :c:data:`Py_None`. | + +------------------------------+--------------------------------------+ + | :const:`PyTrace_RETURN` | Value being returned to the caller, | + | | or *NULL* if caused by an exception. | + +------------------------------+--------------------------------------+ + | :const:`PyTrace_C_CALL` | Function object being called. | + +------------------------------+--------------------------------------+ + | :const:`PyTrace_C_EXCEPTION` | Function object being called. | + +------------------------------+--------------------------------------+ + | :const:`PyTrace_C_RETURN` | Function object being called. | + +------------------------------+--------------------------------------+ + | :const:`PyTrace_OPCODE` | Always :c:data:`Py_None`. | + +------------------------------+--------------------------------------+ + +.. c:var:: int PyTrace_CALL + + The value of the *what* parameter to a :c:type:`Py_tracefunc` function when a new + call to a function or method is being reported, or a new entry into a generator. + Note that the creation of the iterator for a generator function is not reported + as there is no control transfer to the Python bytecode in the corresponding + frame. + + +.. c:var:: int PyTrace_EXCEPTION + + The value of the *what* parameter to a :c:type:`Py_tracefunc` function when an + exception has been raised. The callback function is called with this value for + *what* when after any bytecode is processed after which the exception becomes + set within the frame being executed. The effect of this is that as exception + propagation causes the Python stack to unwind, the callback is called upon + return to each frame as the exception propagates. Only trace functions receives + these events; they are not needed by the profiler. + + +.. c:var:: int PyTrace_LINE + + The value passed as the *what* parameter to a :c:type:`Py_tracefunc` function + (but not a profiling function) when a line-number event is being reported. + It may be disabled for a frame by setting :attr:`f_trace_lines` to *0* on that frame. + + +.. c:var:: int PyTrace_RETURN + + The value for the *what* parameter to :c:type:`Py_tracefunc` functions when a + call is about to return. + + +.. c:var:: int PyTrace_C_CALL + + The value for the *what* parameter to :c:type:`Py_tracefunc` functions when a C + function is about to be called. + + +.. c:var:: int PyTrace_C_EXCEPTION + + The value for the *what* parameter to :c:type:`Py_tracefunc` functions when a C + function has raised an exception. + + +.. c:var:: int PyTrace_C_RETURN + + The value for the *what* parameter to :c:type:`Py_tracefunc` functions when a C + function has returned. + + +.. c:var:: int PyTrace_OPCODE + + The value for the *what* parameter to :c:type:`Py_tracefunc` functions (but not + profiling functions) when a new opcode is about to be executed. This event is + not emitted by default: it must be explicitly requested by setting + :attr:`f_trace_opcodes` to *1* on the frame. + + +.. c:function:: void PyEval_SetProfile(Py_tracefunc func, PyObject *obj) + + Set the profiler function to *func*. The *obj* parameter is passed to the + function as its first parameter, and may be any Python object, or *NULL*. If + the profile function needs to maintain state, using a different value for *obj* + for each thread provides a convenient and thread-safe place to store it. The + profile function is called for all monitored events except :const:`PyTrace_LINE` + :const:`PyTrace_OPCODE` and :const:`PyTrace_EXCEPTION`. + + +.. c:function:: void PyEval_SetTrace(Py_tracefunc func, PyObject *obj) + + Set the tracing function to *func*. This is similar to + :c:func:`PyEval_SetProfile`, except the tracing function does receive line-number + events and per-opcode events, but does not receive any event related to C function + objects being called. Any trace function registered using :c:func:`PyEval_SetTrace` + will not receive :const:`PyTrace_C_CALL`, :const:`PyTrace_C_EXCEPTION` or + :const:`PyTrace_C_RETURN` as a value for the *what* parameter. + +.. _advanced-debugging: + +Advanced Debugger Support +========================= + +.. sectionauthor:: Fred L. Drake, Jr. + + +These functions are only intended to be used by advanced debugging tools. + + +.. c:function:: PyInterpreterState* PyInterpreterState_Head() + + Return the interpreter state object at the head of the list of all such objects. + + +.. c:function:: PyInterpreterState* PyInterpreterState_Main() + + Return the main interpreter state object. + + +.. c:function:: PyInterpreterState* PyInterpreterState_Next(PyInterpreterState *interp) + + Return the next interpreter state object after *interp* from the list of all + such objects. + + +.. c:function:: PyThreadState * PyInterpreterState_ThreadHead(PyInterpreterState *interp) + + Return the pointer to the first :c:type:`PyThreadState` object in the list of + threads associated with the interpreter *interp*. + + +.. c:function:: PyThreadState* PyThreadState_Next(PyThreadState *tstate) + + Return the next thread state object after *tstate* from the list of all such + objects belonging to the same :c:type:`PyInterpreterState` object. + + +.. _thread-local-storage: + +Thread Local Storage Support +============================ + +.. sectionauthor:: Masayuki Yamamoto + +The Python interpreter provides low-level support for thread-local storage +(TLS) which wraps the underlying native TLS implementation to support the +Python-level thread local storage API (:class:`threading.local`). The +CPython C level APIs are similar to those offered by pthreads and Windows: +use a thread key and functions to associate a :c:type:`void\*` value per +thread. + +The GIL does *not* need to be held when calling these functions; they supply +their own locking. + +Note that :file:`Python.h` does not include the declaration of the TLS APIs, +you need to include :file:`pythread.h` to use thread-local storage. + +.. note:: + None of these API functions handle memory management on behalf of the + :c:type:`void\*` values. You need to allocate and deallocate them yourself. + If the :c:type:`void\*` values happen to be :c:type:`PyObject\*`, these + functions don't do refcount operations on them either. + +.. _thread-specific-storage-api: + +Thread Specific Storage (TSS) API +--------------------------------- + +TSS API is introduced to supersede the use of the existing TLS API within the +CPython interpreter. This API uses a new type :c:type:`Py_tss_t` instead of +:c:type:`int` to represent thread keys. + +.. versionadded:: 3.7 + +.. seealso:: "A New C-API for Thread-Local Storage in CPython" (:pep:`539`) + + +.. c:type:: Py_tss_t + + This data structure represents the state of a thread key, the definition of + which may depend on the underlying TLS implementation, and it has an + internal field representing the key's initialization state. There are no + public members in this structure. + + When :ref:`Py_LIMITED_API ` is not defined, static allocation of + this type by :c:macro:`Py_tss_NEEDS_INIT` is allowed. + + +.. c:macro:: Py_tss_NEEDS_INIT + + This macro expands to the initializer for :c:type:`Py_tss_t` variables. + Note that this macro won't be defined with :ref:`Py_LIMITED_API `. + + +Dynamic Allocation +~~~~~~~~~~~~~~~~~~ + +Dynamic allocation of the :c:type:`Py_tss_t`, required in extension modules +built with :ref:`Py_LIMITED_API `, where static allocation of this type +is not possible due to its implementation being opaque at build time. + + +.. c:function:: Py_tss_t* PyThread_tss_alloc() + + Return a value which is the same state as a value initialized with + :c:macro:`Py_tss_NEEDS_INIT`, or *NULL* in the case of dynamic allocation + failure. + + +.. c:function:: void PyThread_tss_free(Py_tss_t *key) + + Free the given *key* allocated by :c:func:`PyThread_tss_alloc`, after + first calling :c:func:`PyThread_tss_delete` to ensure any associated + thread locals have been unassigned. This is a no-op if the *key* + argument is `NULL`. + + .. note:: + A freed key becomes a dangling pointer, you should reset the key to + `NULL`. + + +Methods +~~~~~~~ + +The parameter *key* of these functions must not be *NULL*. Moreover, the +behaviors of :c:func:`PyThread_tss_set` and :c:func:`PyThread_tss_get` are +undefined if the given :c:type:`Py_tss_t` has not been initialized by +:c:func:`PyThread_tss_create`. + + +.. c:function:: int PyThread_tss_is_created(Py_tss_t *key) + + Return a non-zero value if the given :c:type:`Py_tss_t` has been initialized + by :c:func:`PyThread_tss_create`. + + +.. c:function:: int PyThread_tss_create(Py_tss_t *key) + + Return a zero value on successful initialization of a TSS key. The behavior + is undefined if the value pointed to by the *key* argument is not + initialized by :c:macro:`Py_tss_NEEDS_INIT`. This function can be called + repeatedly on the same key -- calling it on an already initialized key is a + no-op and immediately returns success. + + +.. c:function:: void PyThread_tss_delete(Py_tss_t *key) + + Destroy a TSS key to forget the values associated with the key across all + threads, and change the key's initialization state to uninitialized. A + destroyed key is able to be initialized again by + :c:func:`PyThread_tss_create`. This function can be called repeatedly on + the same key -- calling it on an already destroyed key is a no-op. + + +.. c:function:: int PyThread_tss_set(Py_tss_t *key, void *value) + + Return a zero value to indicate successfully associating a :c:type:`void\*` + value with a TSS key in the current thread. Each thread has a distinct + mapping of the key to a :c:type:`void\*` value. + + +.. c:function:: void* PyThread_tss_get(Py_tss_t *key) + + Return the :c:type:`void\*` value associated with a TSS key in the current + thread. This returns *NULL* if no value is associated with the key in the + current thread. + + +.. _thread-local-storage-api: + +Thread Local Storage (TLS) API +------------------------------ + +.. deprecated:: 3.7 + This API is superseded by + :ref:`Thread Specific Storage (TSS) API `. + +.. note:: + This version of the API does not support platforms where the native TLS key + is defined in a way that cannot be safely cast to ``int``. On such platforms, + :c:func:`PyThread_create_key` will return immediately with a failure status, + and the other TLS functions will all be no-ops on such platforms. + +Due to the compatibility problem noted above, this version of the API should not +be used in new code. + +.. c:function:: int PyThread_create_key() +.. c:function:: void PyThread_delete_key(int key) +.. c:function:: int PyThread_set_key_value(int key, void *value) +.. c:function:: void* PyThread_get_key_value(int key) +.. c:function:: void PyThread_delete_key_value(int key) +.. c:function:: void PyThread_ReInitTLS() + diff --git a/python-3.7.4-docs-html/_sources/c-api/intro.rst.txt b/python-3.7.4-docs-html/_sources/c-api/intro.rst.txt new file mode 100644 index 0000000..330871b --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/intro.rst.txt @@ -0,0 +1,725 @@ +.. highlightlang:: c + + +.. _api-intro: + +************ +Introduction +************ + +The Application Programmer's Interface to Python gives C and C++ programmers +access to the Python interpreter at a variety of levels. The API is equally +usable from C++, but for brevity it is generally referred to as the Python/C +API. There are two fundamentally different reasons for using the Python/C API. +The first reason is to write *extension modules* for specific purposes; these +are C modules that extend the Python interpreter. This is probably the most +common use. The second reason is to use Python as a component in a larger +application; this technique is generally referred to as :dfn:`embedding` Python +in an application. + +Writing an extension module is a relatively well-understood process, where a +"cookbook" approach works well. There are several tools that automate the +process to some extent. While people have embedded Python in other +applications since its early existence, the process of embedding Python is +less straightforward than writing an extension. + +Many API functions are useful independent of whether you're embedding or +extending Python; moreover, most applications that embed Python will need to +provide a custom extension as well, so it's probably a good idea to become +familiar with writing an extension before attempting to embed Python in a real +application. + + +Coding standards +================ + +If you're writing C code for inclusion in CPython, you **must** follow the +guidelines and standards defined in :PEP:`7`. These guidelines apply +regardless of the version of Python you are contributing to. Following these +conventions is not necessary for your own third party extension modules, +unless you eventually expect to contribute them to Python. + + +.. _api-includes: + +Include Files +============= + +All function, type and macro definitions needed to use the Python/C API are +included in your code by the following line:: + + #define PY_SSIZE_T_CLEAN + #include + +This implies inclusion of the following standard headers: ````, +````, ````, ````, ```` and ```` +(if available). + +.. note:: + + Since Python may define some pre-processor definitions which affect the standard + headers on some systems, you *must* include :file:`Python.h` before any standard + headers are included. + + It is recommended to always define ``PY_SSIZE_T_CLEAN`` before including + ``Python.h``. See :ref:`arg-parsing` for a description of this macro. + +All user visible names defined by Python.h (except those defined by the included +standard headers) have one of the prefixes ``Py`` or ``_Py``. Names beginning +with ``_Py`` are for internal use by the Python implementation and should not be +used by extension writers. Structure member names do not have a reserved prefix. + +**Important:** user code should never define names that begin with ``Py`` or +``_Py``. This confuses the reader, and jeopardizes the portability of the user +code to future Python versions, which may define additional names beginning with +one of these prefixes. + +The header files are typically installed with Python. On Unix, these are +located in the directories :file:`{prefix}/include/pythonversion/` and +:file:`{exec_prefix}/include/pythonversion/`, where :envvar:`prefix` and +:envvar:`exec_prefix` are defined by the corresponding parameters to Python's +:program:`configure` script and *version* is +``'%d.%d' % sys.version_info[:2]``. On Windows, the headers are installed +in :file:`{prefix}/include`, where :envvar:`prefix` is the installation +directory specified to the installer. + +To include the headers, place both directories (if different) on your compiler's +search path for includes. Do *not* place the parent directories on the search +path and then use ``#include ``; this will break on +multi-platform builds since the platform independent headers under +:envvar:`prefix` include the platform specific headers from +:envvar:`exec_prefix`. + +C++ users should note that though the API is defined entirely using C, the +header files do properly declare the entry points to be ``extern "C"``, so there +is no need to do anything special to use the API from C++. + + +Useful macros +============= + +Several useful macros are defined in the Python header files. Many are +defined closer to where they are useful (e.g. :c:macro:`Py_RETURN_NONE`). +Others of a more general utility are defined here. This is not necessarily a +complete listing. + +.. c:macro:: Py_UNREACHABLE() + + Use this when you have a code path that you do not expect to be reached. + For example, in the ``default:`` clause in a ``switch`` statement for which + all possible values are covered in ``case`` statements. Use this in places + where you might be tempted to put an ``assert(0)`` or ``abort()`` call. + + .. versionadded:: 3.7 + +.. c:macro:: Py_ABS(x) + + Return the absolute value of ``x``. + + .. versionadded:: 3.3 + +.. c:macro:: Py_MIN(x, y) + + Return the minimum value between ``x`` and ``y``. + + .. versionadded:: 3.3 + +.. c:macro:: Py_MAX(x, y) + + Return the maximum value between ``x`` and ``y``. + + .. versionadded:: 3.3 + +.. c:macro:: Py_STRINGIFY(x) + + Convert ``x`` to a C string. E.g. ``Py_STRINGIFY(123)`` returns + ``"123"``. + + .. versionadded:: 3.4 + +.. c:macro:: Py_MEMBER_SIZE(type, member) + + Return the size of a structure (``type``) ``member`` in bytes. + + .. versionadded:: 3.6 + +.. c:macro:: Py_CHARMASK(c) + + Argument must be a character or an integer in the range [-128, 127] or [0, + 255]. This macro returns ``c`` cast to an ``unsigned char``. + +.. c:macro:: Py_GETENV(s) + + Like ``getenv(s)``, but returns *NULL* if :option:`-E` was passed on the + command line (i.e. if ``Py_IgnoreEnvironmentFlag`` is set). + +.. c:macro:: Py_UNUSED(arg) + + Use this for unused arguments in a function definition to silence compiler + warnings, e.g. ``PyObject* func(PyObject *Py_UNUSED(ignored))``. + + .. versionadded:: 3.4 + + +.. _api-objects: + +Objects, Types and Reference Counts +=================================== + +.. index:: object: type + +Most Python/C API functions have one or more arguments as well as a return value +of type :c:type:`PyObject\*`. This type is a pointer to an opaque data type +representing an arbitrary Python object. Since all Python object types are +treated the same way by the Python language in most situations (e.g., +assignments, scope rules, and argument passing), it is only fitting that they +should be represented by a single C type. Almost all Python objects live on the +heap: you never declare an automatic or static variable of type +:c:type:`PyObject`, only pointer variables of type :c:type:`PyObject\*` can be +declared. The sole exception are the type objects; since these must never be +deallocated, they are typically static :c:type:`PyTypeObject` objects. + +All Python objects (even Python integers) have a :dfn:`type` and a +:dfn:`reference count`. An object's type determines what kind of object it is +(e.g., an integer, a list, or a user-defined function; there are many more as +explained in :ref:`types`). For each of the well-known types there is a macro +to check whether an object is of that type; for instance, ``PyList_Check(a)`` is +true if (and only if) the object pointed to by *a* is a Python list. + + +.. _api-refcounts: + +Reference Counts +---------------- + +The reference count is important because today's computers have a finite (and +often severely limited) memory size; it counts how many different places there +are that have a reference to an object. Such a place could be another object, +or a global (or static) C variable, or a local variable in some C function. +When an object's reference count becomes zero, the object is deallocated. If +it contains references to other objects, their reference count is decremented. +Those other objects may be deallocated in turn, if this decrement makes their +reference count become zero, and so on. (There's an obvious problem with +objects that reference each other here; for now, the solution is "don't do +that.") + +.. index:: + single: Py_INCREF() + single: Py_DECREF() + +Reference counts are always manipulated explicitly. The normal way is to use +the macro :c:func:`Py_INCREF` to increment an object's reference count by one, +and :c:func:`Py_DECREF` to decrement it by one. The :c:func:`Py_DECREF` macro +is considerably more complex than the incref one, since it must check whether +the reference count becomes zero and then cause the object's deallocator to be +called. The deallocator is a function pointer contained in the object's type +structure. The type-specific deallocator takes care of decrementing the +reference counts for other objects contained in the object if this is a compound +object type, such as a list, as well as performing any additional finalization +that's needed. There's no chance that the reference count can overflow; at +least as many bits are used to hold the reference count as there are distinct +memory locations in virtual memory (assuming ``sizeof(Py_ssize_t) >= sizeof(void*)``). +Thus, the reference count increment is a simple operation. + +It is not necessary to increment an object's reference count for every local +variable that contains a pointer to an object. In theory, the object's +reference count goes up by one when the variable is made to point to it and it +goes down by one when the variable goes out of scope. However, these two +cancel each other out, so at the end the reference count hasn't changed. The +only real reason to use the reference count is to prevent the object from being +deallocated as long as our variable is pointing to it. If we know that there +is at least one other reference to the object that lives at least as long as +our variable, there is no need to increment the reference count temporarily. +An important situation where this arises is in objects that are passed as +arguments to C functions in an extension module that are called from Python; +the call mechanism guarantees to hold a reference to every argument for the +duration of the call. + +However, a common pitfall is to extract an object from a list and hold on to it +for a while without incrementing its reference count. Some other operation might +conceivably remove the object from the list, decrementing its reference count +and possible deallocating it. The real danger is that innocent-looking +operations may invoke arbitrary Python code which could do this; there is a code +path which allows control to flow back to the user from a :c:func:`Py_DECREF`, so +almost any operation is potentially dangerous. + +A safe approach is to always use the generic operations (functions whose name +begins with ``PyObject_``, ``PyNumber_``, ``PySequence_`` or ``PyMapping_``). +These operations always increment the reference count of the object they return. +This leaves the caller with the responsibility to call :c:func:`Py_DECREF` when +they are done with the result; this soon becomes second nature. + + +.. _api-refcountdetails: + +Reference Count Details +^^^^^^^^^^^^^^^^^^^^^^^ + +The reference count behavior of functions in the Python/C API is best explained +in terms of *ownership of references*. Ownership pertains to references, never +to objects (objects are not owned: they are always shared). "Owning a +reference" means being responsible for calling Py_DECREF on it when the +reference is no longer needed. Ownership can also be transferred, meaning that +the code that receives ownership of the reference then becomes responsible for +eventually decref'ing it by calling :c:func:`Py_DECREF` or :c:func:`Py_XDECREF` +when it's no longer needed---or passing on this responsibility (usually to its +caller). When a function passes ownership of a reference on to its caller, the +caller is said to receive a *new* reference. When no ownership is transferred, +the caller is said to *borrow* the reference. Nothing needs to be done for a +borrowed reference. + +Conversely, when a calling function passes in a reference to an object, there +are two possibilities: the function *steals* a reference to the object, or it +does not. *Stealing a reference* means that when you pass a reference to a +function, that function assumes that it now owns that reference, and you are not +responsible for it any longer. + +.. index:: + single: PyList_SetItem() + single: PyTuple_SetItem() + +Few functions steal references; the two notable exceptions are +:c:func:`PyList_SetItem` and :c:func:`PyTuple_SetItem`, which steal a reference +to the item (but not to the tuple or list into which the item is put!). These +functions were designed to steal a reference because of a common idiom for +populating a tuple or list with newly created objects; for example, the code to +create the tuple ``(1, 2, "three")`` could look like this (forgetting about +error handling for the moment; a better way to code this is shown below):: + + PyObject *t; + + t = PyTuple_New(3); + PyTuple_SetItem(t, 0, PyLong_FromLong(1L)); + PyTuple_SetItem(t, 1, PyLong_FromLong(2L)); + PyTuple_SetItem(t, 2, PyUnicode_FromString("three")); + +Here, :c:func:`PyLong_FromLong` returns a new reference which is immediately +stolen by :c:func:`PyTuple_SetItem`. When you want to keep using an object +although the reference to it will be stolen, use :c:func:`Py_INCREF` to grab +another reference before calling the reference-stealing function. + +Incidentally, :c:func:`PyTuple_SetItem` is the *only* way to set tuple items; +:c:func:`PySequence_SetItem` and :c:func:`PyObject_SetItem` refuse to do this +since tuples are an immutable data type. You should only use +:c:func:`PyTuple_SetItem` for tuples that you are creating yourself. + +Equivalent code for populating a list can be written using :c:func:`PyList_New` +and :c:func:`PyList_SetItem`. + +However, in practice, you will rarely use these ways of creating and populating +a tuple or list. There's a generic function, :c:func:`Py_BuildValue`, that can +create most common objects from C values, directed by a :dfn:`format string`. +For example, the above two blocks of code could be replaced by the following +(which also takes care of the error checking):: + + PyObject *tuple, *list; + + tuple = Py_BuildValue("(iis)", 1, 2, "three"); + list = Py_BuildValue("[iis]", 1, 2, "three"); + +It is much more common to use :c:func:`PyObject_SetItem` and friends with items +whose references you are only borrowing, like arguments that were passed in to +the function you are writing. In that case, their behaviour regarding reference +counts is much saner, since you don't have to increment a reference count so you +can give a reference away ("have it be stolen"). For example, this function +sets all items of a list (actually, any mutable sequence) to a given item:: + + int + set_all(PyObject *target, PyObject *item) + { + Py_ssize_t i, n; + + n = PyObject_Length(target); + if (n < 0) + return -1; + for (i = 0; i < n; i++) { + PyObject *index = PyLong_FromSsize_t(i); + if (!index) + return -1; + if (PyObject_SetItem(target, index, item) < 0) { + Py_DECREF(index); + return -1; + } + Py_DECREF(index); + } + return 0; + } + +.. index:: single: set_all() + +The situation is slightly different for function return values. While passing +a reference to most functions does not change your ownership responsibilities +for that reference, many functions that return a reference to an object give +you ownership of the reference. The reason is simple: in many cases, the +returned object is created on the fly, and the reference you get is the only +reference to the object. Therefore, the generic functions that return object +references, like :c:func:`PyObject_GetItem` and :c:func:`PySequence_GetItem`, +always return a new reference (the caller becomes the owner of the reference). + +It is important to realize that whether you own a reference returned by a +function depends on which function you call only --- *the plumage* (the type of +the object passed as an argument to the function) *doesn't enter into it!* +Thus, if you extract an item from a list using :c:func:`PyList_GetItem`, you +don't own the reference --- but if you obtain the same item from the same list +using :c:func:`PySequence_GetItem` (which happens to take exactly the same +arguments), you do own a reference to the returned object. + +.. index:: + single: PyList_GetItem() + single: PySequence_GetItem() + +Here is an example of how you could write a function that computes the sum of +the items in a list of integers; once using :c:func:`PyList_GetItem`, and once +using :c:func:`PySequence_GetItem`. :: + + long + sum_list(PyObject *list) + { + Py_ssize_t i, n; + long total = 0, value; + PyObject *item; + + n = PyList_Size(list); + if (n < 0) + return -1; /* Not a list */ + for (i = 0; i < n; i++) { + item = PyList_GetItem(list, i); /* Can't fail */ + if (!PyLong_Check(item)) continue; /* Skip non-integers */ + value = PyLong_AsLong(item); + if (value == -1 && PyErr_Occurred()) + /* Integer too big to fit in a C long, bail out */ + return -1; + total += value; + } + return total; + } + +.. index:: single: sum_list() + +:: + + long + sum_sequence(PyObject *sequence) + { + Py_ssize_t i, n; + long total = 0, value; + PyObject *item; + n = PySequence_Length(sequence); + if (n < 0) + return -1; /* Has no length */ + for (i = 0; i < n; i++) { + item = PySequence_GetItem(sequence, i); + if (item == NULL) + return -1; /* Not a sequence, or other failure */ + if (PyLong_Check(item)) { + value = PyLong_AsLong(item); + Py_DECREF(item); + if (value == -1 && PyErr_Occurred()) + /* Integer too big to fit in a C long, bail out */ + return -1; + total += value; + } + else { + Py_DECREF(item); /* Discard reference ownership */ + } + } + return total; + } + +.. index:: single: sum_sequence() + + +.. _api-types: + +Types +----- + +There are few other data types that play a significant role in the Python/C +API; most are simple C types such as :c:type:`int`, :c:type:`long`, +:c:type:`double` and :c:type:`char\*`. A few structure types are used to +describe static tables used to list the functions exported by a module or the +data attributes of a new object type, and another is used to describe the value +of a complex number. These will be discussed together with the functions that +use them. + + +.. _api-exceptions: + +Exceptions +========== + +The Python programmer only needs to deal with exceptions if specific error +handling is required; unhandled exceptions are automatically propagated to the +caller, then to the caller's caller, and so on, until they reach the top-level +interpreter, where they are reported to the user accompanied by a stack +traceback. + +.. index:: single: PyErr_Occurred() + +For C programmers, however, error checking always has to be explicit. All +functions in the Python/C API can raise exceptions, unless an explicit claim is +made otherwise in a function's documentation. In general, when a function +encounters an error, it sets an exception, discards any object references that +it owns, and returns an error indicator. If not documented otherwise, this +indicator is either *NULL* or ``-1``, depending on the function's return type. +A few functions return a Boolean true/false result, with false indicating an +error. Very few functions return no explicit error indicator or have an +ambiguous return value, and require explicit testing for errors with +:c:func:`PyErr_Occurred`. These exceptions are always explicitly documented. + +.. index:: + single: PyErr_SetString() + single: PyErr_Clear() + +Exception state is maintained in per-thread storage (this is equivalent to +using global storage in an unthreaded application). A thread can be in one of +two states: an exception has occurred, or not. The function +:c:func:`PyErr_Occurred` can be used to check for this: it returns a borrowed +reference to the exception type object when an exception has occurred, and +*NULL* otherwise. There are a number of functions to set the exception state: +:c:func:`PyErr_SetString` is the most common (though not the most general) +function to set the exception state, and :c:func:`PyErr_Clear` clears the +exception state. + +The full exception state consists of three objects (all of which can be +*NULL*): the exception type, the corresponding exception value, and the +traceback. These have the same meanings as the Python result of +``sys.exc_info()``; however, they are not the same: the Python objects represent +the last exception being handled by a Python :keyword:`try` ... +:keyword:`except` statement, while the C level exception state only exists while +an exception is being passed on between C functions until it reaches the Python +bytecode interpreter's main loop, which takes care of transferring it to +``sys.exc_info()`` and friends. + +.. index:: single: exc_info() (in module sys) + +Note that starting with Python 1.5, the preferred, thread-safe way to access the +exception state from Python code is to call the function :func:`sys.exc_info`, +which returns the per-thread exception state for Python code. Also, the +semantics of both ways to access the exception state have changed so that a +function which catches an exception will save and restore its thread's exception +state so as to preserve the exception state of its caller. This prevents common +bugs in exception handling code caused by an innocent-looking function +overwriting the exception being handled; it also reduces the often unwanted +lifetime extension for objects that are referenced by the stack frames in the +traceback. + +As a general principle, a function that calls another function to perform some +task should check whether the called function raised an exception, and if so, +pass the exception state on to its caller. It should discard any object +references that it owns, and return an error indicator, but it should *not* set +another exception --- that would overwrite the exception that was just raised, +and lose important information about the exact cause of the error. + +.. index:: single: sum_sequence() + +A simple example of detecting exceptions and passing them on is shown in the +:c:func:`sum_sequence` example above. It so happens that this example doesn't +need to clean up any owned references when it detects an error. The following +example function shows some error cleanup. First, to remind you why you like +Python, we show the equivalent Python code:: + + def incr_item(dict, key): + try: + item = dict[key] + except KeyError: + item = 0 + dict[key] = item + 1 + +.. index:: single: incr_item() + +Here is the corresponding C code, in all its glory:: + + int + incr_item(PyObject *dict, PyObject *key) + { + /* Objects all initialized to NULL for Py_XDECREF */ + PyObject *item = NULL, *const_one = NULL, *incremented_item = NULL; + int rv = -1; /* Return value initialized to -1 (failure) */ + + item = PyObject_GetItem(dict, key); + if (item == NULL) { + /* Handle KeyError only: */ + if (!PyErr_ExceptionMatches(PyExc_KeyError)) + goto error; + + /* Clear the error and use zero: */ + PyErr_Clear(); + item = PyLong_FromLong(0L); + if (item == NULL) + goto error; + } + const_one = PyLong_FromLong(1L); + if (const_one == NULL) + goto error; + + incremented_item = PyNumber_Add(item, const_one); + if (incremented_item == NULL) + goto error; + + if (PyObject_SetItem(dict, key, incremented_item) < 0) + goto error; + rv = 0; /* Success */ + /* Continue with cleanup code */ + + error: + /* Cleanup code, shared by success and failure path */ + + /* Use Py_XDECREF() to ignore NULL references */ + Py_XDECREF(item); + Py_XDECREF(const_one); + Py_XDECREF(incremented_item); + + return rv; /* -1 for error, 0 for success */ + } + +.. index:: single: incr_item() + +.. index:: + single: PyErr_ExceptionMatches() + single: PyErr_Clear() + single: Py_XDECREF() + +This example represents an endorsed use of the ``goto`` statement in C! +It illustrates the use of :c:func:`PyErr_ExceptionMatches` and +:c:func:`PyErr_Clear` to handle specific exceptions, and the use of +:c:func:`Py_XDECREF` to dispose of owned references that may be *NULL* (note the +``'X'`` in the name; :c:func:`Py_DECREF` would crash when confronted with a +*NULL* reference). It is important that the variables used to hold owned +references are initialized to *NULL* for this to work; likewise, the proposed +return value is initialized to ``-1`` (failure) and only set to success after +the final call made is successful. + + +.. _api-embedding: + +Embedding Python +================ + +The one important task that only embedders (as opposed to extension writers) of +the Python interpreter have to worry about is the initialization, and possibly +the finalization, of the Python interpreter. Most functionality of the +interpreter can only be used after the interpreter has been initialized. + +.. index:: + single: Py_Initialize() + module: builtins + module: __main__ + module: sys + triple: module; search; path + single: path (in module sys) + +The basic initialization function is :c:func:`Py_Initialize`. This initializes +the table of loaded modules, and creates the fundamental modules +:mod:`builtins`, :mod:`__main__`, and :mod:`sys`. It also +initializes the module search path (``sys.path``). + +.. index:: single: PySys_SetArgvEx() + +:c:func:`Py_Initialize` does not set the "script argument list" (``sys.argv``). +If this variable is needed by Python code that will be executed later, it must +be set explicitly with a call to ``PySys_SetArgvEx(argc, argv, updatepath)`` +after the call to :c:func:`Py_Initialize`. + +On most systems (in particular, on Unix and Windows, although the details are +slightly different), :c:func:`Py_Initialize` calculates the module search path +based upon its best guess for the location of the standard Python interpreter +executable, assuming that the Python library is found in a fixed location +relative to the Python interpreter executable. In particular, it looks for a +directory named :file:`lib/python{X.Y}` relative to the parent directory +where the executable named :file:`python` is found on the shell command search +path (the environment variable :envvar:`PATH`). + +For instance, if the Python executable is found in +:file:`/usr/local/bin/python`, it will assume that the libraries are in +:file:`/usr/local/lib/python{X.Y}`. (In fact, this particular path is also +the "fallback" location, used when no executable file named :file:`python` is +found along :envvar:`PATH`.) The user can override this behavior by setting the +environment variable :envvar:`PYTHONHOME`, or insert additional directories in +front of the standard path by setting :envvar:`PYTHONPATH`. + +.. index:: + single: Py_SetProgramName() + single: Py_GetPath() + single: Py_GetPrefix() + single: Py_GetExecPrefix() + single: Py_GetProgramFullPath() + +The embedding application can steer the search by calling +``Py_SetProgramName(file)`` *before* calling :c:func:`Py_Initialize`. Note that +:envvar:`PYTHONHOME` still overrides this and :envvar:`PYTHONPATH` is still +inserted in front of the standard path. An application that requires total +control has to provide its own implementation of :c:func:`Py_GetPath`, +:c:func:`Py_GetPrefix`, :c:func:`Py_GetExecPrefix`, and +:c:func:`Py_GetProgramFullPath` (all defined in :file:`Modules/getpath.c`). + +.. index:: single: Py_IsInitialized() + +Sometimes, it is desirable to "uninitialize" Python. For instance, the +application may want to start over (make another call to +:c:func:`Py_Initialize`) or the application is simply done with its use of +Python and wants to free memory allocated by Python. This can be accomplished +by calling :c:func:`Py_FinalizeEx`. The function :c:func:`Py_IsInitialized` returns +true if Python is currently in the initialized state. More information about +these functions is given in a later chapter. Notice that :c:func:`Py_FinalizeEx` +does *not* free all memory allocated by the Python interpreter, e.g. memory +allocated by extension modules currently cannot be released. + + +.. _api-debugging: + +Debugging Builds +================ + +Python can be built with several macros to enable extra checks of the +interpreter and extension modules. These checks tend to add a large amount of +overhead to the runtime so they are not enabled by default. + +A full list of the various types of debugging builds is in the file +:file:`Misc/SpecialBuilds.txt` in the Python source distribution. Builds are +available that support tracing of reference counts, debugging the memory +allocator, or low-level profiling of the main interpreter loop. Only the most +frequently-used builds will be described in the remainder of this section. + +Compiling the interpreter with the :c:macro:`Py_DEBUG` macro defined produces +what is generally meant by "a debug build" of Python. :c:macro:`Py_DEBUG` is +enabled in the Unix build by adding ``--with-pydebug`` to the +:file:`./configure` command. It is also implied by the presence of the +not-Python-specific :c:macro:`_DEBUG` macro. When :c:macro:`Py_DEBUG` is enabled +in the Unix build, compiler optimization is disabled. + +In addition to the reference count debugging described below, the following +extra checks are performed: + +* Extra checks are added to the object allocator. + +* Extra checks are added to the parser and compiler. + +* Downcasts from wide types to narrow types are checked for loss of information. + +* A number of assertions are added to the dictionary and set implementations. + In addition, the set object acquires a :meth:`test_c_api` method. + +* Sanity checks of the input arguments are added to frame creation. + +* The storage for ints is initialized with a known invalid pattern to catch + reference to uninitialized digits. + +* Low-level tracing and extra exception checking are added to the runtime + virtual machine. + +* Extra checks are added to the memory arena implementation. + +* Extra debugging is added to the thread module. + +There may be additional checks not mentioned here. + +Defining :c:macro:`Py_TRACE_REFS` enables reference tracing. When defined, a +circular doubly linked list of active objects is maintained by adding two extra +fields to every :c:type:`PyObject`. Total allocations are tracked as well. Upon +exit, all existing references are printed. (In interactive mode this happens +after every statement run by the interpreter.) Implied by :c:macro:`Py_DEBUG`. + +Please refer to :file:`Misc/SpecialBuilds.txt` in the Python source distribution +for more detailed information. + diff --git a/python-3.7.4-docs-html/_sources/c-api/iter.rst.txt b/python-3.7.4-docs-html/_sources/c-api/iter.rst.txt new file mode 100644 index 0000000..2ba444d --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/iter.rst.txt @@ -0,0 +1,46 @@ +.. highlightlang:: c + +.. _iterator: + +Iterator Protocol +================= + +There are two functions specifically for working with iterators. + +.. c:function:: int PyIter_Check(PyObject *o) + + Return true if the object *o* supports the iterator protocol. + + +.. c:function:: PyObject* PyIter_Next(PyObject *o) + + Return the next value from the iteration *o*. The object must be an iterator + (it is up to the caller to check this). If there are no remaining values, + returns *NULL* with no exception set. If an error occurs while retrieving + the item, returns *NULL* and passes along the exception. + +To write a loop which iterates over an iterator, the C code should look +something like this:: + + PyObject *iterator = PyObject_GetIter(obj); + PyObject *item; + + if (iterator == NULL) { + /* propagate error */ + } + + while (item = PyIter_Next(iterator)) { + /* do something with item */ + ... + /* release reference when done */ + Py_DECREF(item); + } + + Py_DECREF(iterator); + + if (PyErr_Occurred()) { + /* propagate error */ + } + else { + /* continue doing useful work */ + } diff --git a/python-3.7.4-docs-html/_sources/c-api/iterator.rst.txt b/python-3.7.4-docs-html/_sources/c-api/iterator.rst.txt new file mode 100644 index 0000000..82cb4eb --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/iterator.rst.txt @@ -0,0 +1,50 @@ +.. highlightlang:: c + +.. _iterator-objects: + +Iterator Objects +---------------- + +Python provides two general-purpose iterator objects. The first, a sequence +iterator, works with an arbitrary sequence supporting the :meth:`__getitem__` +method. The second works with a callable object and a sentinel value, calling +the callable for each item in the sequence, and ending the iteration when the +sentinel value is returned. + + +.. c:var:: PyTypeObject PySeqIter_Type + + Type object for iterator objects returned by :c:func:`PySeqIter_New` and the + one-argument form of the :func:`iter` built-in function for built-in sequence + types. + + +.. c:function:: int PySeqIter_Check(op) + + Return true if the type of *op* is :c:data:`PySeqIter_Type`. + + +.. c:function:: PyObject* PySeqIter_New(PyObject *seq) + + Return an iterator that works with a general sequence object, *seq*. The + iteration ends when the sequence raises :exc:`IndexError` for the subscripting + operation. + + +.. c:var:: PyTypeObject PyCallIter_Type + + Type object for iterator objects returned by :c:func:`PyCallIter_New` and the + two-argument form of the :func:`iter` built-in function. + + +.. c:function:: int PyCallIter_Check(op) + + Return true if the type of *op* is :c:data:`PyCallIter_Type`. + + +.. c:function:: PyObject* PyCallIter_New(PyObject *callable, PyObject *sentinel) + + Return a new iterator. The first parameter, *callable*, can be any Python + callable object that can be called with no parameters; each call to it should + return the next item in the iteration. When *callable* returns a value equal to + *sentinel*, the iteration will be terminated. diff --git a/python-3.7.4-docs-html/_sources/c-api/list.rst.txt b/python-3.7.4-docs-html/_sources/c-api/list.rst.txt new file mode 100644 index 0000000..a5cd634 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/list.rst.txt @@ -0,0 +1,151 @@ +.. highlightlang:: c + +.. _listobjects: + +List Objects +------------ + +.. index:: object: list + + +.. c:type:: PyListObject + + This subtype of :c:type:`PyObject` represents a Python list object. + + +.. c:var:: PyTypeObject PyList_Type + + This instance of :c:type:`PyTypeObject` represents the Python list type. + This is the same object as :class:`list` in the Python layer. + + +.. c:function:: int PyList_Check(PyObject *p) + + Return true if *p* is a list object or an instance of a subtype of the list + type. + + +.. c:function:: int PyList_CheckExact(PyObject *p) + + Return true if *p* is a list object, but not an instance of a subtype of + the list type. + + +.. c:function:: PyObject* PyList_New(Py_ssize_t len) + + Return a new list of length *len* on success, or *NULL* on failure. + + .. note:: + + If *len* is greater than zero, the returned list object's items are + set to ``NULL``. Thus you cannot use abstract API functions such as + :c:func:`PySequence_SetItem` or expose the object to Python code before + setting all items to a real object with :c:func:`PyList_SetItem`. + + +.. c:function:: Py_ssize_t PyList_Size(PyObject *list) + + .. index:: builtin: len + + Return the length of the list object in *list*; this is equivalent to + ``len(list)`` on a list object. + + +.. c:function:: Py_ssize_t PyList_GET_SIZE(PyObject *list) + + Macro form of :c:func:`PyList_Size` without error checking. + + +.. c:function:: PyObject* PyList_GetItem(PyObject *list, Py_ssize_t index) + + Return the object at position *index* in the list pointed to by *list*. The + position must be non-negative; indexing from the end of the list is not + supported. If *index* is out of bounds (<0 or >=len(list)), + return *NULL* and set an :exc:`IndexError` exception. + + +.. c:function:: PyObject* PyList_GET_ITEM(PyObject *list, Py_ssize_t i) + + Macro form of :c:func:`PyList_GetItem` without error checking. + + +.. c:function:: int PyList_SetItem(PyObject *list, Py_ssize_t index, PyObject *item) + + Set the item at index *index* in list to *item*. Return ``0`` on success + or ``-1`` on failure. + + .. note:: + + This function "steals" a reference to *item* and discards a reference to + an item already in the list at the affected position. + + +.. c:function:: void PyList_SET_ITEM(PyObject *list, Py_ssize_t i, PyObject *o) + + Macro form of :c:func:`PyList_SetItem` without error checking. This is + normally only used to fill in new lists where there is no previous content. + + .. note:: + + This macro "steals" a reference to *item*, and, unlike + :c:func:`PyList_SetItem`, does *not* discard a reference to any item that + is being replaced; any reference in *list* at position *i* will be + leaked. + + +.. c:function:: int PyList_Insert(PyObject *list, Py_ssize_t index, PyObject *item) + + Insert the item *item* into list *list* in front of index *index*. Return + ``0`` if successful; return ``-1`` and set an exception if unsuccessful. + Analogous to ``list.insert(index, item)``. + + +.. c:function:: int PyList_Append(PyObject *list, PyObject *item) + + Append the object *item* at the end of list *list*. Return ``0`` if + successful; return ``-1`` and set an exception if unsuccessful. Analogous + to ``list.append(item)``. + + +.. c:function:: PyObject* PyList_GetSlice(PyObject *list, Py_ssize_t low, Py_ssize_t high) + + Return a list of the objects in *list* containing the objects *between* *low* + and *high*. Return *NULL* and set an exception if unsuccessful. Analogous + to ``list[low:high]``. Negative indices, as when slicing from Python, are not + supported. + + +.. c:function:: int PyList_SetSlice(PyObject *list, Py_ssize_t low, Py_ssize_t high, PyObject *itemlist) + + Set the slice of *list* between *low* and *high* to the contents of + *itemlist*. Analogous to ``list[low:high] = itemlist``. The *itemlist* may + be *NULL*, indicating the assignment of an empty list (slice deletion). + Return ``0`` on success, ``-1`` on failure. Negative indices, as when + slicing from Python, are not supported. + + +.. c:function:: int PyList_Sort(PyObject *list) + + Sort the items of *list* in place. Return ``0`` on success, ``-1`` on + failure. This is equivalent to ``list.sort()``. + + +.. c:function:: int PyList_Reverse(PyObject *list) + + Reverse the items of *list* in place. Return ``0`` on success, ``-1`` on + failure. This is the equivalent of ``list.reverse()``. + + +.. c:function:: PyObject* PyList_AsTuple(PyObject *list) + + .. index:: builtin: tuple + + Return a new tuple object containing the contents of *list*; equivalent to + ``tuple(list)``. + + +.. c:function:: int PyList_ClearFreeList() + + Clear the free list. Return the total number of freed items. + + .. versionadded:: 3.3 diff --git a/python-3.7.4-docs-html/_sources/c-api/long.rst.txt b/python-3.7.4-docs-html/_sources/c-api/long.rst.txt new file mode 100644 index 0000000..71144f1 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/long.rst.txt @@ -0,0 +1,297 @@ +.. highlightlang:: c + +.. _longobjects: + +Integer Objects +--------------- + +.. index:: object: long integer + object: integer + +All integers are implemented as "long" integer objects of arbitrary size. + +On error, most ``PyLong_As*`` APIs return ``(return type)-1`` which cannot be +distinguished from a number. Use :c:func:`PyErr_Occurred` to disambiguate. + +.. c:type:: PyLongObject + + This subtype of :c:type:`PyObject` represents a Python integer object. + + +.. c:var:: PyTypeObject PyLong_Type + + This instance of :c:type:`PyTypeObject` represents the Python integer type. + This is the same object as :class:`int` in the Python layer. + + +.. c:function:: int PyLong_Check(PyObject *p) + + Return true if its argument is a :c:type:`PyLongObject` or a subtype of + :c:type:`PyLongObject`. + + +.. c:function:: int PyLong_CheckExact(PyObject *p) + + Return true if its argument is a :c:type:`PyLongObject`, but not a subtype of + :c:type:`PyLongObject`. + + +.. c:function:: PyObject* PyLong_FromLong(long v) + + Return a new :c:type:`PyLongObject` object from *v*, or *NULL* on failure. + + The current implementation keeps an array of integer objects for all integers + between ``-5`` and ``256``, when you create an int in that range you actually + just get back a reference to the existing object. So it should be possible to + change the value of ``1``. I suspect the behaviour of Python in this case is + undefined. :-) + + +.. c:function:: PyObject* PyLong_FromUnsignedLong(unsigned long v) + + Return a new :c:type:`PyLongObject` object from a C :c:type:`unsigned long`, or + *NULL* on failure. + + +.. c:function:: PyObject* PyLong_FromSsize_t(Py_ssize_t v) + + Return a new :c:type:`PyLongObject` object from a C :c:type:`Py_ssize_t`, or + *NULL* on failure. + + +.. c:function:: PyObject* PyLong_FromSize_t(size_t v) + + Return a new :c:type:`PyLongObject` object from a C :c:type:`size_t`, or + *NULL* on failure. + + +.. c:function:: PyObject* PyLong_FromLongLong(long long v) + + Return a new :c:type:`PyLongObject` object from a C :c:type:`long long`, or *NULL* + on failure. + + +.. c:function:: PyObject* PyLong_FromUnsignedLongLong(unsigned long long v) + + Return a new :c:type:`PyLongObject` object from a C :c:type:`unsigned long long`, + or *NULL* on failure. + + +.. c:function:: PyObject* PyLong_FromDouble(double v) + + Return a new :c:type:`PyLongObject` object from the integer part of *v*, or + *NULL* on failure. + + +.. c:function:: PyObject* PyLong_FromString(const char *str, char **pend, int base) + + Return a new :c:type:`PyLongObject` based on the string value in *str*, which + is interpreted according to the radix in *base*. If *pend* is non-*NULL*, + *\*pend* will point to the first character in *str* which follows the + representation of the number. If *base* is ``0``, *str* is interpreted using + the :ref:`integers` definition; in this case, leading zeros in a + non-zero decimal number raises a :exc:`ValueError`. If *base* is not ``0``, + it must be between ``2`` and ``36``, inclusive. Leading spaces and single + underscores after a base specifier and between digits are ignored. If there + are no digits, :exc:`ValueError` will be raised. + + +.. c:function:: PyObject* PyLong_FromUnicode(Py_UNICODE *u, Py_ssize_t length, int base) + + Convert a sequence of Unicode digits to a Python integer value. The Unicode + string is first encoded to a byte string using :c:func:`PyUnicode_EncodeDecimal` + and then converted using :c:func:`PyLong_FromString`. + + .. deprecated-removed:: 3.3 4.0 + Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using + :c:func:`PyLong_FromUnicodeObject`. + + +.. c:function:: PyObject* PyLong_FromUnicodeObject(PyObject *u, int base) + + Convert a sequence of Unicode digits in the string *u* to a Python integer + value. The Unicode string is first encoded to a byte string using + :c:func:`PyUnicode_EncodeDecimal` and then converted using + :c:func:`PyLong_FromString`. + + .. versionadded:: 3.3 + + +.. c:function:: PyObject* PyLong_FromVoidPtr(void *p) + + Create a Python integer from the pointer *p*. The pointer value can be + retrieved from the resulting value using :c:func:`PyLong_AsVoidPtr`. + + +.. XXX alias PyLong_AS_LONG (for now) +.. c:function:: long PyLong_AsLong(PyObject *obj) + + .. index:: + single: LONG_MAX + single: OverflowError (built-in exception) + + Return a C :c:type:`long` representation of *obj*. If *obj* is not an + instance of :c:type:`PyLongObject`, first call its :meth:`__int__` method + (if present) to convert it to a :c:type:`PyLongObject`. + + Raise :exc:`OverflowError` if the value of *obj* is out of range for a + :c:type:`long`. + + Returns ``-1`` on error. Use :c:func:`PyErr_Occurred` to disambiguate. + + +.. c:function:: long PyLong_AsLongAndOverflow(PyObject *obj, int *overflow) + + Return a C :c:type:`long` representation of *obj*. If *obj* is not an + instance of :c:type:`PyLongObject`, first call its :meth:`__int__` method + (if present) to convert it to a :c:type:`PyLongObject`. + + If the value of *obj* is greater than :const:`LONG_MAX` or less than + :const:`LONG_MIN`, set *\*overflow* to ``1`` or ``-1``, respectively, and + return ``-1``; otherwise, set *\*overflow* to ``0``. If any other exception + occurs set *\*overflow* to ``0`` and return ``-1`` as usual. + + Returns ``-1`` on error. Use :c:func:`PyErr_Occurred` to disambiguate. + + +.. c:function:: long long PyLong_AsLongLong(PyObject *obj) + + .. index:: + single: OverflowError (built-in exception) + + Return a C :c:type:`long long` representation of *obj*. If *obj* is not an + instance of :c:type:`PyLongObject`, first call its :meth:`__int__` method + (if present) to convert it to a :c:type:`PyLongObject`. + + Raise :exc:`OverflowError` if the value of *obj* is out of range for a + :c:type:`long`. + + Returns ``-1`` on error. Use :c:func:`PyErr_Occurred` to disambiguate. + + +.. c:function:: long long PyLong_AsLongLongAndOverflow(PyObject *obj, int *overflow) + + Return a C :c:type:`long long` representation of *obj*. If *obj* is not an + instance of :c:type:`PyLongObject`, first call its :meth:`__int__` method + (if present) to convert it to a :c:type:`PyLongObject`. + + If the value of *obj* is greater than :const:`PY_LLONG_MAX` or less than + :const:`PY_LLONG_MIN`, set *\*overflow* to ``1`` or ``-1``, respectively, + and return ``-1``; otherwise, set *\*overflow* to ``0``. If any other + exception occurs set *\*overflow* to ``0`` and return ``-1`` as usual. + + Returns ``-1`` on error. Use :c:func:`PyErr_Occurred` to disambiguate. + + .. versionadded:: 3.2 + + +.. c:function:: Py_ssize_t PyLong_AsSsize_t(PyObject *pylong) + + .. index:: + single: PY_SSIZE_T_MAX + single: OverflowError (built-in exception) + + Return a C :c:type:`Py_ssize_t` representation of *pylong*. *pylong* must + be an instance of :c:type:`PyLongObject`. + + Raise :exc:`OverflowError` if the value of *pylong* is out of range for a + :c:type:`Py_ssize_t`. + + Returns ``-1`` on error. Use :c:func:`PyErr_Occurred` to disambiguate. + + +.. c:function:: unsigned long PyLong_AsUnsignedLong(PyObject *pylong) + + .. index:: + single: ULONG_MAX + single: OverflowError (built-in exception) + + Return a C :c:type:`unsigned long` representation of *pylong*. *pylong* + must be an instance of :c:type:`PyLongObject`. + + Raise :exc:`OverflowError` if the value of *pylong* is out of range for a + :c:type:`unsigned long`. + + Returns ``(unsigned long)-1`` on error. + Use :c:func:`PyErr_Occurred` to disambiguate. + + +.. c:function:: size_t PyLong_AsSize_t(PyObject *pylong) + + .. index:: + single: SIZE_MAX + single: OverflowError (built-in exception) + + Return a C :c:type:`size_t` representation of *pylong*. *pylong* must be + an instance of :c:type:`PyLongObject`. + + Raise :exc:`OverflowError` if the value of *pylong* is out of range for a + :c:type:`size_t`. + + Returns ``(size_t)-1`` on error. + Use :c:func:`PyErr_Occurred` to disambiguate. + + +.. c:function:: unsigned long long PyLong_AsUnsignedLongLong(PyObject *pylong) + + .. index:: + single: OverflowError (built-in exception) + + Return a C :c:type:`unsigned long long` representation of *pylong*. *pylong* + must be an instance of :c:type:`PyLongObject`. + + Raise :exc:`OverflowError` if the value of *pylong* is out of range for an + :c:type:`unsigned long long`. + + Returns ``(unsigned long long)-1`` on error. + Use :c:func:`PyErr_Occurred` to disambiguate. + + .. versionchanged:: 3.1 + A negative *pylong* now raises :exc:`OverflowError`, not :exc:`TypeError`. + + +.. c:function:: unsigned long PyLong_AsUnsignedLongMask(PyObject *obj) + + Return a C :c:type:`unsigned long` representation of *obj*. If *obj* + is not an instance of :c:type:`PyLongObject`, first call its :meth:`__int__` + method (if present) to convert it to a :c:type:`PyLongObject`. + + If the value of *obj* is out of range for an :c:type:`unsigned long`, + return the reduction of that value modulo ``ULONG_MAX + 1``. + + Returns ``(unsigned long)-1`` on error. Use :c:func:`PyErr_Occurred` to + disambiguate. + + +.. c:function:: unsigned long long PyLong_AsUnsignedLongLongMask(PyObject *obj) + + Return a C :c:type:`unsigned long long` representation of *obj*. If *obj* + is not an instance of :c:type:`PyLongObject`, first call its :meth:`__int__` + method (if present) to convert it to a :c:type:`PyLongObject`. + + If the value of *obj* is out of range for an :c:type:`unsigned long long`, + return the reduction of that value modulo ``PY_ULLONG_MAX + 1``. + + Returns ``(unsigned long long)-1`` on error. Use :c:func:`PyErr_Occurred` + to disambiguate. + + +.. c:function:: double PyLong_AsDouble(PyObject *pylong) + + Return a C :c:type:`double` representation of *pylong*. *pylong* must be + an instance of :c:type:`PyLongObject`. + + Raise :exc:`OverflowError` if the value of *pylong* is out of range for a + :c:type:`double`. + + Returns ``-1.0`` on error. Use :c:func:`PyErr_Occurred` to disambiguate. + + +.. c:function:: void* PyLong_AsVoidPtr(PyObject *pylong) + + Convert a Python integer *pylong* to a C :c:type:`void` pointer. + If *pylong* cannot be converted, an :exc:`OverflowError` will be raised. This + is only assured to produce a usable :c:type:`void` pointer for values created + with :c:func:`PyLong_FromVoidPtr`. + + Returns *NULL* on error. Use :c:func:`PyErr_Occurred` to disambiguate. diff --git a/python-3.7.4-docs-html/_sources/c-api/mapping.rst.txt b/python-3.7.4-docs-html/_sources/c-api/mapping.rst.txt new file mode 100644 index 0000000..e37dec9 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/mapping.rst.txt @@ -0,0 +1,103 @@ +.. highlightlang:: c + +.. _mapping: + +Mapping Protocol +================ + +See also :c:func:`PyObject_GetItem`, :c:func:`PyObject_SetItem` and +:c:func:`PyObject_DelItem`. + + +.. c:function:: int PyMapping_Check(PyObject *o) + + Return ``1`` if the object provides mapping protocol or supports slicing, + and ``0`` otherwise. Note that it returns ``1`` for Python classes with + a :meth:`__getitem__` method since in general case it is impossible to + determine what the type of keys it supports. This function always + succeeds. + + +.. c:function:: Py_ssize_t PyMapping_Size(PyObject *o) + Py_ssize_t PyMapping_Length(PyObject *o) + + .. index:: builtin: len + + Returns the number of keys in object *o* on success, and ``-1`` on failure. + This is equivalent to the Python expression ``len(o)``. + + +.. c:function:: PyObject* PyMapping_GetItemString(PyObject *o, const char *key) + + Return element of *o* corresponding to the string *key* or *NULL* on failure. + This is the equivalent of the Python expression ``o[key]``. + See also :c:func:`PyObject_GetItem`. + + +.. c:function:: int PyMapping_SetItemString(PyObject *o, const char *key, PyObject *v) + + Map the string *key* to the value *v* in object *o*. Returns ``-1`` on + failure. This is the equivalent of the Python statement ``o[key] = v``. + See also :c:func:`PyObject_SetItem`. + + +.. c:function:: int PyMapping_DelItem(PyObject *o, PyObject *key) + + Remove the mapping for the object *key* from the object *o*. Return ``-1`` + on failure. This is equivalent to the Python statement ``del o[key]``. + This is an alias of :c:func:`PyObject_DelItem`. + + +.. c:function:: int PyMapping_DelItemString(PyObject *o, const char *key) + + Remove the mapping for the string *key* from the object *o*. Return ``-1`` + on failure. This is equivalent to the Python statement ``del o[key]``. + + +.. c:function:: int PyMapping_HasKey(PyObject *o, PyObject *key) + + Return ``1`` if the mapping object has the key *key* and ``0`` otherwise. + This is equivalent to the Python expression ``key in o``. + This function always succeeds. + + Note that exceptions which occur while calling the :meth:`__getitem__` + method will get suppressed. + To get error reporting use :c:func:`PyObject_GetItem()` instead. + + +.. c:function:: int PyMapping_HasKeyString(PyObject *o, const char *key) + + Return ``1`` if the mapping object has the key *key* and ``0`` otherwise. + This is equivalent to the Python expression ``key in o``. + This function always succeeds. + + Note that exceptions which occur while calling the :meth:`__getitem__` + method and creating a temporary string object will get suppressed. + To get error reporting use :c:func:`PyMapping_GetItemString()` instead. + + +.. c:function:: PyObject* PyMapping_Keys(PyObject *o) + + On success, return a list of the keys in object *o*. On failure, return + *NULL*. + + .. versionchanged:: 3.7 + Previously, the function returned a list or a tuple. + + +.. c:function:: PyObject* PyMapping_Values(PyObject *o) + + On success, return a list of the values in object *o*. On failure, return + *NULL*. + + .. versionchanged:: 3.7 + Previously, the function returned a list or a tuple. + + +.. c:function:: PyObject* PyMapping_Items(PyObject *o) + + On success, return a list of the items in object *o*, where each item is a + tuple containing a key-value pair. On failure, return *NULL*. + + .. versionchanged:: 3.7 + Previously, the function returned a list or a tuple. diff --git a/python-3.7.4-docs-html/_sources/c-api/marshal.rst.txt b/python-3.7.4-docs-html/_sources/c-api/marshal.rst.txt new file mode 100644 index 0000000..17ec621 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/marshal.rst.txt @@ -0,0 +1,94 @@ +.. highlightlang:: c + +.. _marshalling-utils: + +Data marshalling support +======================== + +These routines allow C code to work with serialized objects using the same +data format as the :mod:`marshal` module. There are functions to write data +into the serialization format, and additional functions that can be used to +read the data back. Files used to store marshalled data must be opened in +binary mode. + +Numeric values are stored with the least significant byte first. + +The module supports two versions of the data format: version 0 is the +historical version, version 1 shares interned strings in the file, and upon +unmarshalling. Version 2 uses a binary format for floating point numbers. +*Py_MARSHAL_VERSION* indicates the current file format (currently 2). + + +.. c:function:: void PyMarshal_WriteLongToFile(long value, FILE *file, int version) + + Marshal a :c:type:`long` integer, *value*, to *file*. This will only write + the least-significant 32 bits of *value*; regardless of the size of the + native :c:type:`long` type. *version* indicates the file format. + + +.. c:function:: void PyMarshal_WriteObjectToFile(PyObject *value, FILE *file, int version) + + Marshal a Python object, *value*, to *file*. + *version* indicates the file format. + + +.. c:function:: PyObject* PyMarshal_WriteObjectToString(PyObject *value, int version) + + Return a bytes object containing the marshalled representation of *value*. + *version* indicates the file format. + + +The following functions allow marshalled values to be read back in. + + +.. c:function:: long PyMarshal_ReadLongFromFile(FILE *file) + + Return a C :c:type:`long` from the data stream in a :c:type:`FILE\*` opened + for reading. Only a 32-bit value can be read in using this function, + regardless of the native size of :c:type:`long`. + + On error, sets the appropriate exception (:exc:`EOFError`) and returns + ``-1``. + + +.. c:function:: int PyMarshal_ReadShortFromFile(FILE *file) + + Return a C :c:type:`short` from the data stream in a :c:type:`FILE\*` opened + for reading. Only a 16-bit value can be read in using this function, + regardless of the native size of :c:type:`short`. + + On error, sets the appropriate exception (:exc:`EOFError`) and returns + ``-1``. + + +.. c:function:: PyObject* PyMarshal_ReadObjectFromFile(FILE *file) + + Return a Python object from the data stream in a :c:type:`FILE\*` opened for + reading. + + On error, sets the appropriate exception (:exc:`EOFError`, :exc:`ValueError` + or :exc:`TypeError`) and returns *NULL*. + + +.. c:function:: PyObject* PyMarshal_ReadLastObjectFromFile(FILE *file) + + Return a Python object from the data stream in a :c:type:`FILE\*` opened for + reading. Unlike :c:func:`PyMarshal_ReadObjectFromFile`, this function + assumes that no further objects will be read from the file, allowing it to + aggressively load file data into memory so that the de-serialization can + operate from data in memory rather than reading a byte at a time from the + file. Only use these variant if you are certain that you won't be reading + anything else from the file. + + On error, sets the appropriate exception (:exc:`EOFError`, :exc:`ValueError` + or :exc:`TypeError`) and returns *NULL*. + + +.. c:function:: PyObject* PyMarshal_ReadObjectFromString(const char *data, Py_ssize_t len) + + Return a Python object from the data stream in a byte buffer + containing *len* bytes pointed to by *data*. + + On error, sets the appropriate exception (:exc:`EOFError`, :exc:`ValueError` + or :exc:`TypeError`) and returns *NULL*. + diff --git a/python-3.7.4-docs-html/_sources/c-api/memory.rst.txt b/python-3.7.4-docs-html/_sources/c-api/memory.rst.txt new file mode 100644 index 0000000..01f7f42 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/memory.rst.txt @@ -0,0 +1,604 @@ +.. highlightlang:: c + + +.. _memory: + +***************** +Memory Management +***************** + +.. sectionauthor:: Vladimir Marangozov + + + +.. _memoryoverview: + +Overview +======== + +Memory management in Python involves a private heap containing all Python +objects and data structures. The management of this private heap is ensured +internally by the *Python memory manager*. The Python memory manager has +different components which deal with various dynamic storage management aspects, +like sharing, segmentation, preallocation or caching. + +At the lowest level, a raw memory allocator ensures that there is enough room in +the private heap for storing all Python-related data by interacting with the +memory manager of the operating system. On top of the raw memory allocator, +several object-specific allocators operate on the same heap and implement +distinct memory management policies adapted to the peculiarities of every object +type. For example, integer objects are managed differently within the heap than +strings, tuples or dictionaries because integers imply different storage +requirements and speed/space tradeoffs. The Python memory manager thus delegates +some of the work to the object-specific allocators, but ensures that the latter +operate within the bounds of the private heap. + +It is important to understand that the management of the Python heap is +performed by the interpreter itself and that the user has no control over it, +even if they regularly manipulate object pointers to memory blocks inside that +heap. The allocation of heap space for Python objects and other internal +buffers is performed on demand by the Python memory manager through the Python/C +API functions listed in this document. + +.. index:: + single: malloc() + single: calloc() + single: realloc() + single: free() + +To avoid memory corruption, extension writers should never try to operate on +Python objects with the functions exported by the C library: :c:func:`malloc`, +:c:func:`calloc`, :c:func:`realloc` and :c:func:`free`. This will result in mixed +calls between the C allocator and the Python memory manager with fatal +consequences, because they implement different algorithms and operate on +different heaps. However, one may safely allocate and release memory blocks +with the C library allocator for individual purposes, as shown in the following +example:: + + PyObject *res; + char *buf = (char *) malloc(BUFSIZ); /* for I/O */ + + if (buf == NULL) + return PyErr_NoMemory(); + ...Do some I/O operation involving buf... + res = PyBytes_FromString(buf); + free(buf); /* malloc'ed */ + return res; + +In this example, the memory request for the I/O buffer is handled by the C +library allocator. The Python memory manager is involved only in the allocation +of the bytes object returned as a result. + +In most situations, however, it is recommended to allocate memory from the +Python heap specifically because the latter is under control of the Python +memory manager. For example, this is required when the interpreter is extended +with new object types written in C. Another reason for using the Python heap is +the desire to *inform* the Python memory manager about the memory needs of the +extension module. Even when the requested memory is used exclusively for +internal, highly-specific purposes, delegating all memory requests to the Python +memory manager causes the interpreter to have a more accurate image of its +memory footprint as a whole. Consequently, under certain circumstances, the +Python memory manager may or may not trigger appropriate actions, like garbage +collection, memory compaction or other preventive procedures. Note that by using +the C library allocator as shown in the previous example, the allocated memory +for the I/O buffer escapes completely the Python memory manager. + +.. seealso:: + + The :envvar:`PYTHONMALLOC` environment variable can be used to configure + the memory allocators used by Python. + + The :envvar:`PYTHONMALLOCSTATS` environment variable can be used to print + statistics of the :ref:`pymalloc memory allocator ` every time a + new pymalloc object arena is created, and on shutdown. + + +Raw Memory Interface +==================== + +The following function sets are wrappers to the system allocator. These +functions are thread-safe, the :term:`GIL ` does not +need to be held. + +The :ref:`default raw memory allocator ` uses +the following functions: :c:func:`malloc`, :c:func:`calloc`, :c:func:`realloc` +and :c:func:`free`; call ``malloc(1)`` (or ``calloc(1, 1)``) when requesting +zero bytes. + +.. versionadded:: 3.4 + +.. c:function:: void* PyMem_RawMalloc(size_t n) + + Allocates *n* bytes and returns a pointer of type :c:type:`void\*` to the + allocated memory, or *NULL* if the request fails. + + Requesting zero bytes returns a distinct non-*NULL* pointer if possible, as + if ``PyMem_RawMalloc(1)`` had been called instead. The memory will not have + been initialized in any way. + + +.. c:function:: void* PyMem_RawCalloc(size_t nelem, size_t elsize) + + Allocates *nelem* elements each whose size in bytes is *elsize* and returns + a pointer of type :c:type:`void\*` to the allocated memory, or *NULL* if the + request fails. The memory is initialized to zeros. + + Requesting zero elements or elements of size zero bytes returns a distinct + non-*NULL* pointer if possible, as if ``PyMem_RawCalloc(1, 1)`` had been + called instead. + + .. versionadded:: 3.5 + + +.. c:function:: void* PyMem_RawRealloc(void *p, size_t n) + + Resizes the memory block pointed to by *p* to *n* bytes. The contents will + be unchanged to the minimum of the old and the new sizes. + + If *p* is *NULL*, the call is equivalent to ``PyMem_RawMalloc(n)``; else if + *n* is equal to zero, the memory block is resized but is not freed, and the + returned pointer is non-*NULL*. + + Unless *p* is *NULL*, it must have been returned by a previous call to + :c:func:`PyMem_RawMalloc`, :c:func:`PyMem_RawRealloc` or + :c:func:`PyMem_RawCalloc`. + + If the request fails, :c:func:`PyMem_RawRealloc` returns *NULL* and *p* + remains a valid pointer to the previous memory area. + + +.. c:function:: void PyMem_RawFree(void *p) + + Frees the memory block pointed to by *p*, which must have been returned by a + previous call to :c:func:`PyMem_RawMalloc`, :c:func:`PyMem_RawRealloc` or + :c:func:`PyMem_RawCalloc`. Otherwise, or if ``PyMem_RawFree(p)`` has been + called before, undefined behavior occurs. + + If *p* is *NULL*, no operation is performed. + + +.. _memoryinterface: + +Memory Interface +================ + +The following function sets, modeled after the ANSI C standard, but specifying +behavior when requesting zero bytes, are available for allocating and releasing +memory from the Python heap. + +The :ref:`default memory allocator ` uses the +:ref:`pymalloc memory allocator `. + +.. warning:: + + The :term:`GIL ` must be held when using these + functions. + +.. versionchanged:: 3.6 + + The default allocator is now pymalloc instead of system :c:func:`malloc`. + +.. c:function:: void* PyMem_Malloc(size_t n) + + Allocates *n* bytes and returns a pointer of type :c:type:`void\*` to the + allocated memory, or *NULL* if the request fails. + + Requesting zero bytes returns a distinct non-*NULL* pointer if possible, as + if ``PyMem_Malloc(1)`` had been called instead. The memory will not have + been initialized in any way. + + +.. c:function:: void* PyMem_Calloc(size_t nelem, size_t elsize) + + Allocates *nelem* elements each whose size in bytes is *elsize* and returns + a pointer of type :c:type:`void\*` to the allocated memory, or *NULL* if the + request fails. The memory is initialized to zeros. + + Requesting zero elements or elements of size zero bytes returns a distinct + non-*NULL* pointer if possible, as if ``PyMem_Calloc(1, 1)`` had been called + instead. + + .. versionadded:: 3.5 + + +.. c:function:: void* PyMem_Realloc(void *p, size_t n) + + Resizes the memory block pointed to by *p* to *n* bytes. The contents will be + unchanged to the minimum of the old and the new sizes. + + If *p* is *NULL*, the call is equivalent to ``PyMem_Malloc(n)``; else if *n* + is equal to zero, the memory block is resized but is not freed, and the + returned pointer is non-*NULL*. + + Unless *p* is *NULL*, it must have been returned by a previous call to + :c:func:`PyMem_Malloc`, :c:func:`PyMem_Realloc` or :c:func:`PyMem_Calloc`. + + If the request fails, :c:func:`PyMem_Realloc` returns *NULL* and *p* remains + a valid pointer to the previous memory area. + + +.. c:function:: void PyMem_Free(void *p) + + Frees the memory block pointed to by *p*, which must have been returned by a + previous call to :c:func:`PyMem_Malloc`, :c:func:`PyMem_Realloc` or + :c:func:`PyMem_Calloc`. Otherwise, or if ``PyMem_Free(p)`` has been called + before, undefined behavior occurs. + + If *p* is *NULL*, no operation is performed. + +The following type-oriented macros are provided for convenience. Note that +*TYPE* refers to any C type. + + +.. c:function:: TYPE* PyMem_New(TYPE, size_t n) + + Same as :c:func:`PyMem_Malloc`, but allocates ``(n * sizeof(TYPE))`` bytes of + memory. Returns a pointer cast to :c:type:`TYPE\*`. The memory will not have + been initialized in any way. + + +.. c:function:: TYPE* PyMem_Resize(void *p, TYPE, size_t n) + + Same as :c:func:`PyMem_Realloc`, but the memory block is resized to ``(n * + sizeof(TYPE))`` bytes. Returns a pointer cast to :c:type:`TYPE\*`. On return, + *p* will be a pointer to the new memory area, or *NULL* in the event of + failure. + + This is a C preprocessor macro; *p* is always reassigned. Save the original + value of *p* to avoid losing memory when handling errors. + + +.. c:function:: void PyMem_Del(void *p) + + Same as :c:func:`PyMem_Free`. + +In addition, the following macro sets are provided for calling the Python memory +allocator directly, without involving the C API functions listed above. However, +note that their use does not preserve binary compatibility across Python +versions and is therefore deprecated in extension modules. + +* ``PyMem_MALLOC(size)`` +* ``PyMem_NEW(type, size)`` +* ``PyMem_REALLOC(ptr, size)`` +* ``PyMem_RESIZE(ptr, type, size)`` +* ``PyMem_FREE(ptr)`` +* ``PyMem_DEL(ptr)`` + + +Object allocators +================= + +The following function sets, modeled after the ANSI C standard, but specifying +behavior when requesting zero bytes, are available for allocating and releasing +memory from the Python heap. + +The :ref:`default object allocator ` uses the +:ref:`pymalloc memory allocator `. + +.. warning:: + + The :term:`GIL ` must be held when using these + functions. + +.. c:function:: void* PyObject_Malloc(size_t n) + + Allocates *n* bytes and returns a pointer of type :c:type:`void\*` to the + allocated memory, or *NULL* if the request fails. + + Requesting zero bytes returns a distinct non-*NULL* pointer if possible, as + if ``PyObject_Malloc(1)`` had been called instead. The memory will not have + been initialized in any way. + + +.. c:function:: void* PyObject_Calloc(size_t nelem, size_t elsize) + + Allocates *nelem* elements each whose size in bytes is *elsize* and returns + a pointer of type :c:type:`void\*` to the allocated memory, or *NULL* if the + request fails. The memory is initialized to zeros. + + Requesting zero elements or elements of size zero bytes returns a distinct + non-*NULL* pointer if possible, as if ``PyObject_Calloc(1, 1)`` had been called + instead. + + .. versionadded:: 3.5 + + +.. c:function:: void* PyObject_Realloc(void *p, size_t n) + + Resizes the memory block pointed to by *p* to *n* bytes. The contents will be + unchanged to the minimum of the old and the new sizes. + + If *p* is *NULL*, the call is equivalent to ``PyObject_Malloc(n)``; else if *n* + is equal to zero, the memory block is resized but is not freed, and the + returned pointer is non-*NULL*. + + Unless *p* is *NULL*, it must have been returned by a previous call to + :c:func:`PyObject_Malloc`, :c:func:`PyObject_Realloc` or :c:func:`PyObject_Calloc`. + + If the request fails, :c:func:`PyObject_Realloc` returns *NULL* and *p* remains + a valid pointer to the previous memory area. + + +.. c:function:: void PyObject_Free(void *p) + + Frees the memory block pointed to by *p*, which must have been returned by a + previous call to :c:func:`PyObject_Malloc`, :c:func:`PyObject_Realloc` or + :c:func:`PyObject_Calloc`. Otherwise, or if ``PyObject_Free(p)`` has been called + before, undefined behavior occurs. + + If *p* is *NULL*, no operation is performed. + + +.. _default-memory-allocators: + +Default Memory Allocators +========================= + +Default memory allocators: + +=============================== ==================== ================== ===================== ==================== +Configuration Name PyMem_RawMalloc PyMem_Malloc PyObject_Malloc +=============================== ==================== ================== ===================== ==================== +Release build ``"pymalloc"`` ``malloc`` ``pymalloc`` ``pymalloc`` +Debug build ``"pymalloc_debug"`` ``malloc`` + debug ``pymalloc`` + debug ``pymalloc`` + debug +Release build, without pymalloc ``"malloc"`` ``malloc`` ``malloc`` ``malloc`` +Debug build, without pymalloc ``"malloc_debug"`` ``malloc`` + debug ``malloc`` + debug ``malloc`` + debug +=============================== ==================== ================== ===================== ==================== + +Legend: + +* Name: value for :envvar:`PYTHONMALLOC` environment variable +* ``malloc``: system allocators from the standard C library, C functions: + :c:func:`malloc`, :c:func:`calloc`, :c:func:`realloc` and :c:func:`free` +* ``pymalloc``: :ref:`pymalloc memory allocator ` +* "+ debug": with debug hooks installed by :c:func:`PyMem_SetupDebugHooks` + + +Customize Memory Allocators +=========================== + +.. versionadded:: 3.4 + +.. c:type:: PyMemAllocatorEx + + Structure used to describe a memory block allocator. The structure has + four fields: + + +----------------------------------------------------------+---------------------------------------+ + | Field | Meaning | + +==========================================================+=======================================+ + | ``void *ctx`` | user context passed as first argument | + +----------------------------------------------------------+---------------------------------------+ + | ``void* malloc(void *ctx, size_t size)`` | allocate a memory block | + +----------------------------------------------------------+---------------------------------------+ + | ``void* calloc(void *ctx, size_t nelem, size_t elsize)`` | allocate a memory block initialized | + | | with zeros | + +----------------------------------------------------------+---------------------------------------+ + | ``void* realloc(void *ctx, void *ptr, size_t new_size)`` | allocate or resize a memory block | + +----------------------------------------------------------+---------------------------------------+ + | ``void free(void *ctx, void *ptr)`` | free a memory block | + +----------------------------------------------------------+---------------------------------------+ + + .. versionchanged:: 3.5 + The :c:type:`PyMemAllocator` structure was renamed to + :c:type:`PyMemAllocatorEx` and a new ``calloc`` field was added. + + +.. c:type:: PyMemAllocatorDomain + + Enum used to identify an allocator domain. Domains: + + .. c:var:: PYMEM_DOMAIN_RAW + + Functions: + + * :c:func:`PyMem_RawMalloc` + * :c:func:`PyMem_RawRealloc` + * :c:func:`PyMem_RawCalloc` + * :c:func:`PyMem_RawFree` + + .. c:var:: PYMEM_DOMAIN_MEM + + Functions: + + * :c:func:`PyMem_Malloc`, + * :c:func:`PyMem_Realloc` + * :c:func:`PyMem_Calloc` + * :c:func:`PyMem_Free` + + .. c:var:: PYMEM_DOMAIN_OBJ + + Functions: + + * :c:func:`PyObject_Malloc` + * :c:func:`PyObject_Realloc` + * :c:func:`PyObject_Calloc` + * :c:func:`PyObject_Free` + +.. c:function:: void PyMem_GetAllocator(PyMemAllocatorDomain domain, PyMemAllocatorEx *allocator) + + Get the memory block allocator of the specified domain. + + +.. c:function:: void PyMem_SetAllocator(PyMemAllocatorDomain domain, PyMemAllocatorEx *allocator) + + Set the memory block allocator of the specified domain. + + The new allocator must return a distinct non-NULL pointer when requesting + zero bytes. + + For the :c:data:`PYMEM_DOMAIN_RAW` domain, the allocator must be + thread-safe: the :term:`GIL ` is not held when the + allocator is called. + + If the new allocator is not a hook (does not call the previous allocator), + the :c:func:`PyMem_SetupDebugHooks` function must be called to reinstall the + debug hooks on top on the new allocator. + + +.. c:function:: void PyMem_SetupDebugHooks(void) + + Setup hooks to detect bugs in the Python memory allocator functions. + + Newly allocated memory is filled with the byte ``0xCD`` (``CLEANBYTE``), + freed memory is filled with the byte ``0xDD`` (``DEADBYTE``). Memory blocks + are surrounded by "forbidden bytes" (``FORBIDDENBYTE``: byte ``0xFD``). + + Runtime checks: + + - Detect API violations, ex: :c:func:`PyObject_Free` called on a buffer + allocated by :c:func:`PyMem_Malloc` + - Detect write before the start of the buffer (buffer underflow) + - Detect write after the end of the buffer (buffer overflow) + - Check that the :term:`GIL ` is held when + allocator functions of :c:data:`PYMEM_DOMAIN_OBJ` (ex: + :c:func:`PyObject_Malloc`) and :c:data:`PYMEM_DOMAIN_MEM` (ex: + :c:func:`PyMem_Malloc`) domains are called + + On error, the debug hooks use the :mod:`tracemalloc` module to get the + traceback where a memory block was allocated. The traceback is only + displayed if :mod:`tracemalloc` is tracing Python memory allocations and the + memory block was traced. + + These hooks are :ref:`installed by default ` if + Python is compiled in debug + mode. The :envvar:`PYTHONMALLOC` environment variable can be used to install + debug hooks on a Python compiled in release mode. + + .. versionchanged:: 3.6 + This function now also works on Python compiled in release mode. + On error, the debug hooks now use :mod:`tracemalloc` to get the traceback + where a memory block was allocated. The debug hooks now also check + if the GIL is held when functions of :c:data:`PYMEM_DOMAIN_OBJ` and + :c:data:`PYMEM_DOMAIN_MEM` domains are called. + + .. versionchanged:: 3.7.3 + Byte patterns ``0xCB`` (``CLEANBYTE``), ``0xDB`` (``DEADBYTE``) and + ``0xFB`` (``FORBIDDENBYTE``) have been replaced with ``0xCD``, ``0xDD`` + and ``0xFD`` to use the same values than Windows CRT debug ``malloc()`` + and ``free()``. + + +.. _pymalloc: + +The pymalloc allocator +====================== + +Python has a *pymalloc* allocator optimized for small objects (smaller or equal +to 512 bytes) with a short lifetime. It uses memory mappings called "arenas" +with a fixed size of 256 KiB. It falls back to :c:func:`PyMem_RawMalloc` and +:c:func:`PyMem_RawRealloc` for allocations larger than 512 bytes. + +*pymalloc* is the :ref:`default allocator ` of the +:c:data:`PYMEM_DOMAIN_MEM` (ex: :c:func:`PyMem_Malloc`) and +:c:data:`PYMEM_DOMAIN_OBJ` (ex: :c:func:`PyObject_Malloc`) domains. + +The arena allocator uses the following functions: + +* :c:func:`VirtualAlloc` and :c:func:`VirtualFree` on Windows, +* :c:func:`mmap` and :c:func:`munmap` if available, +* :c:func:`malloc` and :c:func:`free` otherwise. + +Customize pymalloc Arena Allocator +---------------------------------- + +.. versionadded:: 3.4 + +.. c:type:: PyObjectArenaAllocator + + Structure used to describe an arena allocator. The structure has + three fields: + + +--------------------------------------------------+---------------------------------------+ + | Field | Meaning | + +==================================================+=======================================+ + | ``void *ctx`` | user context passed as first argument | + +--------------------------------------------------+---------------------------------------+ + | ``void* alloc(void *ctx, size_t size)`` | allocate an arena of size bytes | + +--------------------------------------------------+---------------------------------------+ + | ``void free(void *ctx, size_t size, void *ptr)`` | free an arena | + +--------------------------------------------------+---------------------------------------+ + +.. c:function:: PyObject_GetArenaAllocator(PyObjectArenaAllocator *allocator) + + Get the arena allocator. + +.. c:function:: PyObject_SetArenaAllocator(PyObjectArenaAllocator *allocator) + + Set the arena allocator. + + +tracemalloc C API +================= + +.. versionadded:: 3.7 + +.. c:function: int PyTraceMalloc_Track(unsigned int domain, uintptr_t ptr, size_t size) + + Track an allocated memory block in the :mod:`tracemalloc` module. + + Return ``0`` on success, return ``-1`` on error (failed to allocate memory to + store the trace). Return ``-2`` if tracemalloc is disabled. + + If memory block is already tracked, update the existing trace. + +.. c:function: int PyTraceMalloc_Untrack(unsigned int domain, uintptr_t ptr) + + Untrack an allocated memory block in the :mod:`tracemalloc` module. + Do nothing if the block was not tracked. + + Return ``-2`` if tracemalloc is disabled, otherwise return ``0``. + + +.. _memoryexamples: + +Examples +======== + +Here is the example from section :ref:`memoryoverview`, rewritten so that the +I/O buffer is allocated from the Python heap by using the first function set:: + + PyObject *res; + char *buf = (char *) PyMem_Malloc(BUFSIZ); /* for I/O */ + + if (buf == NULL) + return PyErr_NoMemory(); + /* ...Do some I/O operation involving buf... */ + res = PyBytes_FromString(buf); + PyMem_Free(buf); /* allocated with PyMem_Malloc */ + return res; + +The same code using the type-oriented function set:: + + PyObject *res; + char *buf = PyMem_New(char, BUFSIZ); /* for I/O */ + + if (buf == NULL) + return PyErr_NoMemory(); + /* ...Do some I/O operation involving buf... */ + res = PyBytes_FromString(buf); + PyMem_Del(buf); /* allocated with PyMem_New */ + return res; + +Note that in the two examples above, the buffer is always manipulated via +functions belonging to the same set. Indeed, it is required to use the same +memory API family for a given memory block, so that the risk of mixing different +allocators is reduced to a minimum. The following code sequence contains two +errors, one of which is labeled as *fatal* because it mixes two different +allocators operating on different heaps. :: + + char *buf1 = PyMem_New(char, BUFSIZ); + char *buf2 = (char *) malloc(BUFSIZ); + char *buf3 = (char *) PyMem_Malloc(BUFSIZ); + ... + PyMem_Del(buf3); /* Wrong -- should be PyMem_Free() */ + free(buf2); /* Right -- allocated via malloc() */ + free(buf1); /* Fatal -- should be PyMem_Del() */ + +In addition to the functions aimed at handling raw memory blocks from the Python +heap, objects in Python are allocated and released with :c:func:`PyObject_New`, +:c:func:`PyObject_NewVar` and :c:func:`PyObject_Del`. + +These will be explained in the next chapter on defining and implementing new +object types in C. + diff --git a/python-3.7.4-docs-html/_sources/c-api/memoryview.rst.txt b/python-3.7.4-docs-html/_sources/c-api/memoryview.rst.txt new file mode 100644 index 0000000..9f6bfd7 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/memoryview.rst.txt @@ -0,0 +1,63 @@ +.. highlightlang:: c + +.. _memoryview-objects: + +.. index:: + object: memoryview + +MemoryView objects +------------------ + +A :class:`memoryview` object exposes the C level :ref:`buffer interface +` as a Python object which can then be passed around like +any other object. + + +.. c:function:: PyObject *PyMemoryView_FromObject(PyObject *obj) + + Create a memoryview object from an object that provides the buffer interface. + If *obj* supports writable buffer exports, the memoryview object will be + read/write, otherwise it may be either read-only or read/write at the + discretion of the exporter. + +.. c:function:: PyObject *PyMemoryView_FromMemory(char *mem, Py_ssize_t size, int flags) + + Create a memoryview object using *mem* as the underlying buffer. + *flags* can be one of :c:macro:`PyBUF_READ` or :c:macro:`PyBUF_WRITE`. + + .. versionadded:: 3.3 + +.. c:function:: PyObject *PyMemoryView_FromBuffer(Py_buffer *view) + + Create a memoryview object wrapping the given buffer structure *view*. + For simple byte buffers, :c:func:`PyMemoryView_FromMemory` is the preferred + function. + +.. c:function:: PyObject *PyMemoryView_GetContiguous(PyObject *obj, int buffertype, char order) + + Create a memoryview object to a :term:`contiguous` chunk of memory (in either + 'C' or 'F'ortran *order*) from an object that defines the buffer + interface. If memory is contiguous, the memoryview object points to the + original memory. Otherwise, a copy is made and the memoryview points to a + new bytes object. + + +.. c:function:: int PyMemoryView_Check(PyObject *obj) + + Return true if the object *obj* is a memoryview object. It is not + currently allowed to create subclasses of :class:`memoryview`. + + +.. c:function:: Py_buffer *PyMemoryView_GET_BUFFER(PyObject *mview) + + Return a pointer to the memoryview's private copy of the exporter's buffer. + *mview* **must** be a memoryview instance; this macro doesn't check its type, + you must do it yourself or you will risk crashes. + +.. c:function:: Py_buffer *PyMemoryView_GET_BASE(PyObject *mview) + + Return either a pointer to the exporting object that the memoryview is based + on or *NULL* if the memoryview has been created by one of the functions + :c:func:`PyMemoryView_FromMemory` or :c:func:`PyMemoryView_FromBuffer`. + *mview* **must** be a memoryview instance. + diff --git a/python-3.7.4-docs-html/_sources/c-api/method.rst.txt b/python-3.7.4-docs-html/_sources/c-api/method.rst.txt new file mode 100644 index 0000000..7a2a84f --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/method.rst.txt @@ -0,0 +1,100 @@ +.. highlightlang:: c + +.. _instancemethod-objects: + +Instance Method Objects +----------------------- + +.. index:: object: instancemethod + +An instance method is a wrapper for a :c:data:`PyCFunction` and the new way +to bind a :c:data:`PyCFunction` to a class object. It replaces the former call +``PyMethod_New(func, NULL, class)``. + + +.. c:var:: PyTypeObject PyInstanceMethod_Type + + This instance of :c:type:`PyTypeObject` represents the Python instance + method type. It is not exposed to Python programs. + + +.. c:function:: int PyInstanceMethod_Check(PyObject *o) + + Return true if *o* is an instance method object (has type + :c:data:`PyInstanceMethod_Type`). The parameter must not be *NULL*. + + +.. c:function:: PyObject* PyInstanceMethod_New(PyObject *func) + + Return a new instance method object, with *func* being any callable object + *func* is the function that will be called when the instance method is + called. + + +.. c:function:: PyObject* PyInstanceMethod_Function(PyObject *im) + + Return the function object associated with the instance method *im*. + + +.. c:function:: PyObject* PyInstanceMethod_GET_FUNCTION(PyObject *im) + + Macro version of :c:func:`PyInstanceMethod_Function` which avoids error checking. + + +.. _method-objects: + +Method Objects +-------------- + +.. index:: object: method + +Methods are bound function objects. Methods are always bound to an instance of +a user-defined class. Unbound methods (methods bound to a class object) are +no longer available. + + +.. c:var:: PyTypeObject PyMethod_Type + + .. index:: single: MethodType (in module types) + + This instance of :c:type:`PyTypeObject` represents the Python method type. This + is exposed to Python programs as ``types.MethodType``. + + +.. c:function:: int PyMethod_Check(PyObject *o) + + Return true if *o* is a method object (has type :c:data:`PyMethod_Type`). The + parameter must not be *NULL*. + + +.. c:function:: PyObject* PyMethod_New(PyObject *func, PyObject *self) + + Return a new method object, with *func* being any callable object and *self* + the instance the method should be bound. *func* is the function that will + be called when the method is called. *self* must not be *NULL*. + + +.. c:function:: PyObject* PyMethod_Function(PyObject *meth) + + Return the function object associated with the method *meth*. + + +.. c:function:: PyObject* PyMethod_GET_FUNCTION(PyObject *meth) + + Macro version of :c:func:`PyMethod_Function` which avoids error checking. + + +.. c:function:: PyObject* PyMethod_Self(PyObject *meth) + + Return the instance associated with the method *meth*. + + +.. c:function:: PyObject* PyMethod_GET_SELF(PyObject *meth) + + Macro version of :c:func:`PyMethod_Self` which avoids error checking. + + +.. c:function:: int PyMethod_ClearFreeList() + + Clear the free list. Return the total number of freed items. + diff --git a/python-3.7.4-docs-html/_sources/c-api/module.rst.txt b/python-3.7.4-docs-html/_sources/c-api/module.rst.txt new file mode 100644 index 0000000..017b656 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/module.rst.txt @@ -0,0 +1,479 @@ +.. highlightlang:: c + +.. _moduleobjects: + +Module Objects +-------------- + +.. index:: object: module + + +.. c:var:: PyTypeObject PyModule_Type + + .. index:: single: ModuleType (in module types) + + This instance of :c:type:`PyTypeObject` represents the Python module type. This + is exposed to Python programs as ``types.ModuleType``. + + +.. c:function:: int PyModule_Check(PyObject *p) + + Return true if *p* is a module object, or a subtype of a module object. + + +.. c:function:: int PyModule_CheckExact(PyObject *p) + + Return true if *p* is a module object, but not a subtype of + :c:data:`PyModule_Type`. + + +.. c:function:: PyObject* PyModule_NewObject(PyObject *name) + + .. index:: + single: __name__ (module attribute) + single: __doc__ (module attribute) + single: __file__ (module attribute) + single: __package__ (module attribute) + single: __loader__ (module attribute) + + Return a new module object with the :attr:`__name__` attribute set to *name*. + The module's :attr:`__name__`, :attr:`__doc__`, :attr:`__package__`, and + :attr:`__loader__` attributes are filled in (all but :attr:`__name__` are set + to ``None``); the caller is responsible for providing a :attr:`__file__` + attribute. + + .. versionadded:: 3.3 + + .. versionchanged:: 3.4 + :attr:`__package__` and :attr:`__loader__` are set to ``None``. + + +.. c:function:: PyObject* PyModule_New(const char *name) + + Similar to :c:func:`PyModule_NewObject`, but the name is a UTF-8 encoded + string instead of a Unicode object. + + +.. c:function:: PyObject* PyModule_GetDict(PyObject *module) + + .. index:: single: __dict__ (module attribute) + + Return the dictionary object that implements *module*'s namespace; this object + is the same as the :attr:`~object.__dict__` attribute of the module object. + If *module* is not a module object (or a subtype of a module object), + :exc:`SystemError` is raised and *NULL* is returned. + + It is recommended extensions use other :c:func:`PyModule_\*` and + :c:func:`PyObject_\*` functions rather than directly manipulate a module's + :attr:`~object.__dict__`. + + +.. c:function:: PyObject* PyModule_GetNameObject(PyObject *module) + + .. index:: + single: __name__ (module attribute) + single: SystemError (built-in exception) + + Return *module*'s :attr:`__name__` value. If the module does not provide one, + or if it is not a string, :exc:`SystemError` is raised and *NULL* is returned. + + .. versionadded:: 3.3 + + +.. c:function:: const char* PyModule_GetName(PyObject *module) + + Similar to :c:func:`PyModule_GetNameObject` but return the name encoded to + ``'utf-8'``. + +.. c:function:: void* PyModule_GetState(PyObject *module) + + Return the "state" of the module, that is, a pointer to the block of memory + allocated at module creation time, or *NULL*. See + :c:member:`PyModuleDef.m_size`. + + +.. c:function:: PyModuleDef* PyModule_GetDef(PyObject *module) + + Return a pointer to the :c:type:`PyModuleDef` struct from which the module was + created, or *NULL* if the module wasn't created from a definition. + + +.. c:function:: PyObject* PyModule_GetFilenameObject(PyObject *module) + + .. index:: + single: __file__ (module attribute) + single: SystemError (built-in exception) + + Return the name of the file from which *module* was loaded using *module*'s + :attr:`__file__` attribute. If this is not defined, or if it is not a + unicode string, raise :exc:`SystemError` and return *NULL*; otherwise return + a reference to a Unicode object. + + .. versionadded:: 3.2 + + +.. c:function:: const char* PyModule_GetFilename(PyObject *module) + + Similar to :c:func:`PyModule_GetFilenameObject` but return the filename + encoded to 'utf-8'. + + .. deprecated:: 3.2 + :c:func:`PyModule_GetFilename` raises :c:type:`UnicodeEncodeError` on + unencodable filenames, use :c:func:`PyModule_GetFilenameObject` instead. + + +.. _initializing-modules: + +Initializing C modules +^^^^^^^^^^^^^^^^^^^^^^ + +Modules objects are usually created from extension modules (shared libraries +which export an initialization function), or compiled-in modules +(where the initialization function is added using :c:func:`PyImport_AppendInittab`). +See :ref:`building` or :ref:`extending-with-embedding` for details. + +The initialization function can either pass a module definition instance +to :c:func:`PyModule_Create`, and return the resulting module object, +or request "multi-phase initialization" by returning the definition struct itself. + +.. c:type:: PyModuleDef + + The module definition struct, which holds all information needed to create + a module object. There is usually only one statically initialized variable + of this type for each module. + + .. c:member:: PyModuleDef_Base m_base + + Always initialize this member to :const:`PyModuleDef_HEAD_INIT`. + + .. c:member:: const char *m_name + + Name for the new module. + + .. c:member:: const char *m_doc + + Docstring for the module; usually a docstring variable created with + :c:func:`PyDoc_STRVAR` is used. + + .. c:member:: Py_ssize_t m_size + + Module state may be kept in a per-module memory area that can be + retrieved with :c:func:`PyModule_GetState`, rather than in static globals. + This makes modules safe for use in multiple sub-interpreters. + + This memory area is allocated based on *m_size* on module creation, + and freed when the module object is deallocated, after the + :c:member:`m_free` function has been called, if present. + + Setting ``m_size`` to ``-1`` means that the module does not support + sub-interpreters, because it has global state. + + Setting it to a non-negative value means that the module can be + re-initialized and specifies the additional amount of memory it requires + for its state. Non-negative ``m_size`` is required for multi-phase + initialization. + + See :PEP:`3121` for more details. + + .. c:member:: PyMethodDef* m_methods + + A pointer to a table of module-level functions, described by + :c:type:`PyMethodDef` values. Can be *NULL* if no functions are present. + + .. c:member:: PyModuleDef_Slot* m_slots + + An array of slot definitions for multi-phase initialization, terminated by + a ``{0, NULL}`` entry. + When using single-phase initialization, *m_slots* must be *NULL*. + + .. versionchanged:: 3.5 + + Prior to version 3.5, this member was always set to *NULL*, + and was defined as: + + .. c:member:: inquiry m_reload + + .. c:member:: traverseproc m_traverse + + A traversal function to call during GC traversal of the module object, or + *NULL* if not needed. This function may be called before module state + is allocated (:c:func:`PyModule_GetState()` may return `NULL`), + and before the :c:member:`Py_mod_exec` function is executed. + + .. c:member:: inquiry m_clear + + A clear function to call during GC clearing of the module object, or + *NULL* if not needed. This function may be called before module state + is allocated (:c:func:`PyModule_GetState()` may return `NULL`), + and before the :c:member:`Py_mod_exec` function is executed. + + .. c:member:: freefunc m_free + + A function to call during deallocation of the module object, or *NULL* if + not needed. This function may be called before module state + is allocated (:c:func:`PyModule_GetState()` may return `NULL`), + and before the :c:member:`Py_mod_exec` function is executed. + +Single-phase initialization +........................... + +The module initialization function may create and return the module object +directly. This is referred to as "single-phase initialization", and uses one +of the following two module creation functions: + +.. c:function:: PyObject* PyModule_Create(PyModuleDef *def) + + Create a new module object, given the definition in *def*. This behaves + like :c:func:`PyModule_Create2` with *module_api_version* set to + :const:`PYTHON_API_VERSION`. + + +.. c:function:: PyObject* PyModule_Create2(PyModuleDef *def, int module_api_version) + + Create a new module object, given the definition in *def*, assuming the + API version *module_api_version*. If that version does not match the version + of the running interpreter, a :exc:`RuntimeWarning` is emitted. + + .. note:: + + Most uses of this function should be using :c:func:`PyModule_Create` + instead; only use this if you are sure you need it. + +Before it is returned from in the initialization function, the resulting module +object is typically populated using functions like :c:func:`PyModule_AddObject`. + +.. _multi-phase-initialization: + +Multi-phase initialization +.......................... + +An alternate way to specify extensions is to request "multi-phase initialization". +Extension modules created this way behave more like Python modules: the +initialization is split between the *creation phase*, when the module object +is created, and the *execution phase*, when it is populated. +The distinction is similar to the :py:meth:`__new__` and :py:meth:`__init__` methods +of classes. + +Unlike modules created using single-phase initialization, these modules are not +singletons: if the *sys.modules* entry is removed and the module is re-imported, +a new module object is created, and the old module is subject to normal garbage +collection -- as with Python modules. +By default, multiple modules created from the same definition should be +independent: changes to one should not affect the others. +This means that all state should be specific to the module object (using e.g. +using :c:func:`PyModule_GetState`), or its contents (such as the module's +:attr:`__dict__` or individual classes created with :c:func:`PyType_FromSpec`). + +All modules created using multi-phase initialization are expected to support +:ref:`sub-interpreters `. Making sure multiple modules +are independent is typically enough to achieve this. + +To request multi-phase initialization, the initialization function +(PyInit_modulename) returns a :c:type:`PyModuleDef` instance with non-empty +:c:member:`~PyModuleDef.m_slots`. Before it is returned, the ``PyModuleDef`` +instance must be initialized with the following function: + +.. c:function:: PyObject* PyModuleDef_Init(PyModuleDef *def) + + Ensures a module definition is a properly initialized Python object that + correctly reports its type and reference count. + + Returns *def* cast to ``PyObject*``, or *NULL* if an error occurred. + + .. versionadded:: 3.5 + +The *m_slots* member of the module definition must point to an array of +``PyModuleDef_Slot`` structures: + +.. c:type:: PyModuleDef_Slot + + .. c:member:: int slot + + A slot ID, chosen from the available values explained below. + + .. c:member:: void* value + + Value of the slot, whose meaning depends on the slot ID. + + .. versionadded:: 3.5 + +The *m_slots* array must be terminated by a slot with id 0. + +The available slot types are: + +.. c:var:: Py_mod_create + + Specifies a function that is called to create the module object itself. + The *value* pointer of this slot must point to a function of the signature: + + .. c:function:: PyObject* create_module(PyObject *spec, PyModuleDef *def) + + The function receives a :py:class:`~importlib.machinery.ModuleSpec` + instance, as defined in :PEP:`451`, and the module definition. + It should return a new module object, or set an error + and return *NULL*. + + This function should be kept minimal. In particular, it should not + call arbitrary Python code, as trying to import the same module again may + result in an infinite loop. + + Multiple ``Py_mod_create`` slots may not be specified in one module + definition. + + If ``Py_mod_create`` is not specified, the import machinery will create + a normal module object using :c:func:`PyModule_New`. The name is taken from + *spec*, not the definition, to allow extension modules to dynamically adjust + to their place in the module hierarchy and be imported under different + names through symlinks, all while sharing a single module definition. + + There is no requirement for the returned object to be an instance of + :c:type:`PyModule_Type`. Any type can be used, as long as it supports + setting and getting import-related attributes. + However, only ``PyModule_Type`` instances may be returned if the + ``PyModuleDef`` has non-*NULL* ``m_traverse``, ``m_clear``, + ``m_free``; non-zero ``m_size``; or slots other than ``Py_mod_create``. + +.. c:var:: Py_mod_exec + + Specifies a function that is called to *execute* the module. + This is equivalent to executing the code of a Python module: typically, + this function adds classes and constants to the module. + The signature of the function is: + + .. c:function:: int exec_module(PyObject* module) + + If multiple ``Py_mod_exec`` slots are specified, they are processed in the + order they appear in the *m_slots* array. + +See :PEP:`489` for more details on multi-phase initialization. + +Low-level module creation functions +................................... + +The following functions are called under the hood when using multi-phase +initialization. They can be used directly, for example when creating module +objects dynamically. Note that both ``PyModule_FromDefAndSpec`` and +``PyModule_ExecDef`` must be called to fully initialize a module. + +.. c:function:: PyObject * PyModule_FromDefAndSpec(PyModuleDef *def, PyObject *spec) + + Create a new module object, given the definition in *module* and the + ModuleSpec *spec*. This behaves like :c:func:`PyModule_FromDefAndSpec2` + with *module_api_version* set to :const:`PYTHON_API_VERSION`. + + .. versionadded:: 3.5 + +.. c:function:: PyObject * PyModule_FromDefAndSpec2(PyModuleDef *def, PyObject *spec, int module_api_version) + + Create a new module object, given the definition in *module* and the + ModuleSpec *spec*, assuming the API version *module_api_version*. + If that version does not match the version of the running interpreter, + a :exc:`RuntimeWarning` is emitted. + + .. note:: + + Most uses of this function should be using :c:func:`PyModule_FromDefAndSpec` + instead; only use this if you are sure you need it. + + .. versionadded:: 3.5 + +.. c:function:: int PyModule_ExecDef(PyObject *module, PyModuleDef *def) + + Process any execution slots (:c:data:`Py_mod_exec`) given in *def*. + + .. versionadded:: 3.5 + +.. c:function:: int PyModule_SetDocString(PyObject *module, const char *docstring) + + Set the docstring for *module* to *docstring*. + This function is called automatically when creating a module from + ``PyModuleDef``, using either ``PyModule_Create`` or + ``PyModule_FromDefAndSpec``. + + .. versionadded:: 3.5 + +.. c:function:: int PyModule_AddFunctions(PyObject *module, PyMethodDef *functions) + + Add the functions from the *NULL* terminated *functions* array to *module*. + Refer to the :c:type:`PyMethodDef` documentation for details on individual + entries (due to the lack of a shared module namespace, module level + "functions" implemented in C typically receive the module as their first + parameter, making them similar to instance methods on Python classes). + This function is called automatically when creating a module from + ``PyModuleDef``, using either ``PyModule_Create`` or + ``PyModule_FromDefAndSpec``. + + .. versionadded:: 3.5 + +Support functions +................. + +The module initialization function (if using single phase initialization) or +a function called from a module execution slot (if using multi-phase +initialization), can use the following functions to help initialize the module +state: + +.. c:function:: int PyModule_AddObject(PyObject *module, const char *name, PyObject *value) + + Add an object to *module* as *name*. This is a convenience function which can + be used from the module's initialization function. This steals a reference to + *value*. Return ``-1`` on error, ``0`` on success. + +.. c:function:: int PyModule_AddIntConstant(PyObject *module, const char *name, long value) + + Add an integer constant to *module* as *name*. This convenience function can be + used from the module's initialization function. Return ``-1`` on error, ``0`` on + success. + + +.. c:function:: int PyModule_AddStringConstant(PyObject *module, const char *name, const char *value) + + Add a string constant to *module* as *name*. This convenience function can be + used from the module's initialization function. The string *value* must be + *NULL*-terminated. Return ``-1`` on error, ``0`` on success. + + +.. c:function:: int PyModule_AddIntMacro(PyObject *module, macro) + + Add an int constant to *module*. The name and the value are taken from + *macro*. For example ``PyModule_AddIntMacro(module, AF_INET)`` adds the int + constant *AF_INET* with the value of *AF_INET* to *module*. + Return ``-1`` on error, ``0`` on success. + + +.. c:function:: int PyModule_AddStringMacro(PyObject *module, macro) + + Add a string constant to *module*. + + +Module lookup +^^^^^^^^^^^^^ + +Single-phase initialization creates singleton modules that can be looked up +in the context of the current interpreter. This allows the module object to be +retrieved later with only a reference to the module definition. + +These functions will not work on modules created using multi-phase initialization, +since multiple such modules can be created from a single definition. + +.. c:function:: PyObject* PyState_FindModule(PyModuleDef *def) + + Returns the module object that was created from *def* for the current interpreter. + This method requires that the module object has been attached to the interpreter state with + :c:func:`PyState_AddModule` beforehand. In case the corresponding module object is not + found or has not been attached to the interpreter state yet, it returns *NULL*. + +.. c:function:: int PyState_AddModule(PyObject *module, PyModuleDef *def) + + Attaches the module object passed to the function to the interpreter state. This allows + the module object to be accessible via :c:func:`PyState_FindModule`. + + Only effective on modules created using single-phase initialization. + + .. versionadded:: 3.3 + +.. c:function:: int PyState_RemoveModule(PyModuleDef *def) + + Removes the module object created from *def* from the interpreter state. + + .. versionadded:: 3.3 diff --git a/python-3.7.4-docs-html/_sources/c-api/none.rst.txt b/python-3.7.4-docs-html/_sources/c-api/none.rst.txt new file mode 100644 index 0000000..45568fe --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/none.rst.txt @@ -0,0 +1,26 @@ +.. highlightlang:: c + +.. _noneobject: + +The ``None`` Object +------------------- + +.. index:: object: None + +Note that the :c:type:`PyTypeObject` for ``None`` is not directly exposed in the +Python/C API. Since ``None`` is a singleton, testing for object identity (using +``==`` in C) is sufficient. There is no :c:func:`PyNone_Check` function for the +same reason. + + +.. c:var:: PyObject* Py_None + + The Python ``None`` object, denoting lack of value. This object has no methods. + It needs to be treated just like any other object with respect to reference + counts. + + +.. c:macro:: Py_RETURN_NONE + + Properly handle returning :c:data:`Py_None` from within a C function (that is, + increment the reference count of ``None`` and return it.) diff --git a/python-3.7.4-docs-html/_sources/c-api/number.rst.txt b/python-3.7.4-docs-html/_sources/c-api/number.rst.txt new file mode 100644 index 0000000..296b21c --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/number.rst.txt @@ -0,0 +1,283 @@ +.. highlightlang:: c + +.. _number: + +Number Protocol +=============== + + +.. c:function:: int PyNumber_Check(PyObject *o) + + Returns ``1`` if the object *o* provides numeric protocols, and false otherwise. + This function always succeeds. + + +.. c:function:: PyObject* PyNumber_Add(PyObject *o1, PyObject *o2) + + Returns the result of adding *o1* and *o2*, or *NULL* on failure. This is the + equivalent of the Python expression ``o1 + o2``. + + +.. c:function:: PyObject* PyNumber_Subtract(PyObject *o1, PyObject *o2) + + Returns the result of subtracting *o2* from *o1*, or *NULL* on failure. This is + the equivalent of the Python expression ``o1 - o2``. + + +.. c:function:: PyObject* PyNumber_Multiply(PyObject *o1, PyObject *o2) + + Returns the result of multiplying *o1* and *o2*, or *NULL* on failure. This is + the equivalent of the Python expression ``o1 * o2``. + + +.. c:function:: PyObject* PyNumber_MatrixMultiply(PyObject *o1, PyObject *o2) + + Returns the result of matrix multiplication on *o1* and *o2*, or *NULL* on + failure. This is the equivalent of the Python expression ``o1 @ o2``. + + .. versionadded:: 3.5 + + +.. c:function:: PyObject* PyNumber_FloorDivide(PyObject *o1, PyObject *o2) + + Return the floor of *o1* divided by *o2*, or *NULL* on failure. This is + equivalent to the "classic" division of integers. + + +.. c:function:: PyObject* PyNumber_TrueDivide(PyObject *o1, PyObject *o2) + + Return a reasonable approximation for the mathematical value of *o1* divided by + *o2*, or *NULL* on failure. The return value is "approximate" because binary + floating point numbers are approximate; it is not possible to represent all real + numbers in base two. This function can return a floating point value when + passed two integers. + + +.. c:function:: PyObject* PyNumber_Remainder(PyObject *o1, PyObject *o2) + + Returns the remainder of dividing *o1* by *o2*, or *NULL* on failure. This is + the equivalent of the Python expression ``o1 % o2``. + + +.. c:function:: PyObject* PyNumber_Divmod(PyObject *o1, PyObject *o2) + + .. index:: builtin: divmod + + See the built-in function :func:`divmod`. Returns *NULL* on failure. This is + the equivalent of the Python expression ``divmod(o1, o2)``. + + +.. c:function:: PyObject* PyNumber_Power(PyObject *o1, PyObject *o2, PyObject *o3) + + .. index:: builtin: pow + + See the built-in function :func:`pow`. Returns *NULL* on failure. This is the + equivalent of the Python expression ``pow(o1, o2, o3)``, where *o3* is optional. + If *o3* is to be ignored, pass :c:data:`Py_None` in its place (passing *NULL* for + *o3* would cause an illegal memory access). + + +.. c:function:: PyObject* PyNumber_Negative(PyObject *o) + + Returns the negation of *o* on success, or *NULL* on failure. This is the + equivalent of the Python expression ``-o``. + + +.. c:function:: PyObject* PyNumber_Positive(PyObject *o) + + Returns *o* on success, or *NULL* on failure. This is the equivalent of the + Python expression ``+o``. + + +.. c:function:: PyObject* PyNumber_Absolute(PyObject *o) + + .. index:: builtin: abs + + Returns the absolute value of *o*, or *NULL* on failure. This is the equivalent + of the Python expression ``abs(o)``. + + +.. c:function:: PyObject* PyNumber_Invert(PyObject *o) + + Returns the bitwise negation of *o* on success, or *NULL* on failure. This is + the equivalent of the Python expression ``~o``. + + +.. c:function:: PyObject* PyNumber_Lshift(PyObject *o1, PyObject *o2) + + Returns the result of left shifting *o1* by *o2* on success, or *NULL* on + failure. This is the equivalent of the Python expression ``o1 << o2``. + + +.. c:function:: PyObject* PyNumber_Rshift(PyObject *o1, PyObject *o2) + + Returns the result of right shifting *o1* by *o2* on success, or *NULL* on + failure. This is the equivalent of the Python expression ``o1 >> o2``. + + +.. c:function:: PyObject* PyNumber_And(PyObject *o1, PyObject *o2) + + Returns the "bitwise and" of *o1* and *o2* on success and *NULL* on failure. + This is the equivalent of the Python expression ``o1 & o2``. + + +.. c:function:: PyObject* PyNumber_Xor(PyObject *o1, PyObject *o2) + + Returns the "bitwise exclusive or" of *o1* by *o2* on success, or *NULL* on + failure. This is the equivalent of the Python expression ``o1 ^ o2``. + + +.. c:function:: PyObject* PyNumber_Or(PyObject *o1, PyObject *o2) + + Returns the "bitwise or" of *o1* and *o2* on success, or *NULL* on failure. + This is the equivalent of the Python expression ``o1 | o2``. + + +.. c:function:: PyObject* PyNumber_InPlaceAdd(PyObject *o1, PyObject *o2) + + Returns the result of adding *o1* and *o2*, or *NULL* on failure. The operation + is done *in-place* when *o1* supports it. This is the equivalent of the Python + statement ``o1 += o2``. + + +.. c:function:: PyObject* PyNumber_InPlaceSubtract(PyObject *o1, PyObject *o2) + + Returns the result of subtracting *o2* from *o1*, or *NULL* on failure. The + operation is done *in-place* when *o1* supports it. This is the equivalent of + the Python statement ``o1 -= o2``. + + +.. c:function:: PyObject* PyNumber_InPlaceMultiply(PyObject *o1, PyObject *o2) + + Returns the result of multiplying *o1* and *o2*, or *NULL* on failure. The + operation is done *in-place* when *o1* supports it. This is the equivalent of + the Python statement ``o1 *= o2``. + + +.. c:function:: PyObject* PyNumber_InPlaceMatrixMultiply(PyObject *o1, PyObject *o2) + + Returns the result of matrix multiplication on *o1* and *o2*, or *NULL* on + failure. The operation is done *in-place* when *o1* supports it. This is + the equivalent of the Python statement ``o1 @= o2``. + + .. versionadded:: 3.5 + + +.. c:function:: PyObject* PyNumber_InPlaceFloorDivide(PyObject *o1, PyObject *o2) + + Returns the mathematical floor of dividing *o1* by *o2*, or *NULL* on failure. + The operation is done *in-place* when *o1* supports it. This is the equivalent + of the Python statement ``o1 //= o2``. + + +.. c:function:: PyObject* PyNumber_InPlaceTrueDivide(PyObject *o1, PyObject *o2) + + Return a reasonable approximation for the mathematical value of *o1* divided by + *o2*, or *NULL* on failure. The return value is "approximate" because binary + floating point numbers are approximate; it is not possible to represent all real + numbers in base two. This function can return a floating point value when + passed two integers. The operation is done *in-place* when *o1* supports it. + + +.. c:function:: PyObject* PyNumber_InPlaceRemainder(PyObject *o1, PyObject *o2) + + Returns the remainder of dividing *o1* by *o2*, or *NULL* on failure. The + operation is done *in-place* when *o1* supports it. This is the equivalent of + the Python statement ``o1 %= o2``. + + +.. c:function:: PyObject* PyNumber_InPlacePower(PyObject *o1, PyObject *o2, PyObject *o3) + + .. index:: builtin: pow + + See the built-in function :func:`pow`. Returns *NULL* on failure. The operation + is done *in-place* when *o1* supports it. This is the equivalent of the Python + statement ``o1 **= o2`` when o3 is :c:data:`Py_None`, or an in-place variant of + ``pow(o1, o2, o3)`` otherwise. If *o3* is to be ignored, pass :c:data:`Py_None` + in its place (passing *NULL* for *o3* would cause an illegal memory access). + + +.. c:function:: PyObject* PyNumber_InPlaceLshift(PyObject *o1, PyObject *o2) + + Returns the result of left shifting *o1* by *o2* on success, or *NULL* on + failure. The operation is done *in-place* when *o1* supports it. This is the + equivalent of the Python statement ``o1 <<= o2``. + + +.. c:function:: PyObject* PyNumber_InPlaceRshift(PyObject *o1, PyObject *o2) + + Returns the result of right shifting *o1* by *o2* on success, or *NULL* on + failure. The operation is done *in-place* when *o1* supports it. This is the + equivalent of the Python statement ``o1 >>= o2``. + + +.. c:function:: PyObject* PyNumber_InPlaceAnd(PyObject *o1, PyObject *o2) + + Returns the "bitwise and" of *o1* and *o2* on success and *NULL* on failure. The + operation is done *in-place* when *o1* supports it. This is the equivalent of + the Python statement ``o1 &= o2``. + + +.. c:function:: PyObject* PyNumber_InPlaceXor(PyObject *o1, PyObject *o2) + + Returns the "bitwise exclusive or" of *o1* by *o2* on success, or *NULL* on + failure. The operation is done *in-place* when *o1* supports it. This is the + equivalent of the Python statement ``o1 ^= o2``. + + +.. c:function:: PyObject* PyNumber_InPlaceOr(PyObject *o1, PyObject *o2) + + Returns the "bitwise or" of *o1* and *o2* on success, or *NULL* on failure. The + operation is done *in-place* when *o1* supports it. This is the equivalent of + the Python statement ``o1 |= o2``. + + +.. c:function:: PyObject* PyNumber_Long(PyObject *o) + + .. index:: builtin: int + + Returns the *o* converted to an integer object on success, or *NULL* on + failure. This is the equivalent of the Python expression ``int(o)``. + + +.. c:function:: PyObject* PyNumber_Float(PyObject *o) + + .. index:: builtin: float + + Returns the *o* converted to a float object on success, or *NULL* on failure. + This is the equivalent of the Python expression ``float(o)``. + + +.. c:function:: PyObject* PyNumber_Index(PyObject *o) + + Returns the *o* converted to a Python int on success or *NULL* with a + :exc:`TypeError` exception raised on failure. + + +.. c:function:: PyObject* PyNumber_ToBase(PyObject *n, int base) + + Returns the integer *n* converted to base *base* as a string. The *base* + argument must be one of 2, 8, 10, or 16. For base 2, 8, or 16, the + returned string is prefixed with a base marker of ``'0b'``, ``'0o'``, or + ``'0x'``, respectively. If *n* is not a Python int, it is converted with + :c:func:`PyNumber_Index` first. + + +.. c:function:: Py_ssize_t PyNumber_AsSsize_t(PyObject *o, PyObject *exc) + + Returns *o* converted to a Py_ssize_t value if *o* can be interpreted as an + integer. If the call fails, an exception is raised and ``-1`` is returned. + + If *o* can be converted to a Python int but the attempt to + convert to a Py_ssize_t value would raise an :exc:`OverflowError`, then the + *exc* argument is the type of exception that will be raised (usually + :exc:`IndexError` or :exc:`OverflowError`). If *exc* is *NULL*, then the + exception is cleared and the value is clipped to *PY_SSIZE_T_MIN* for a negative + integer or *PY_SSIZE_T_MAX* for a positive integer. + + +.. c:function:: int PyIndex_Check(PyObject *o) + + Returns ``1`` if *o* is an index integer (has the nb_index slot of the + tp_as_number structure filled in), and ``0`` otherwise. + This function always succeeds. diff --git a/python-3.7.4-docs-html/_sources/c-api/objbuffer.rst.txt b/python-3.7.4-docs-html/_sources/c-api/objbuffer.rst.txt new file mode 100644 index 0000000..3572564 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/objbuffer.rst.txt @@ -0,0 +1,55 @@ +.. highlightlang:: c + +Old Buffer Protocol +------------------- + +.. deprecated:: 3.0 + +These functions were part of the "old buffer protocol" API in Python 2. +In Python 3, this protocol doesn't exist anymore but the functions are still +exposed to ease porting 2.x code. They act as a compatibility wrapper +around the :ref:`new buffer protocol `, but they don't give +you control over the lifetime of the resources acquired when a buffer is +exported. + +Therefore, it is recommended that you call :c:func:`PyObject_GetBuffer` +(or the ``y*`` or ``w*`` :ref:`format codes ` with the +:c:func:`PyArg_ParseTuple` family of functions) to get a buffer view over +an object, and :c:func:`PyBuffer_Release` when the buffer view can be released. + + +.. c:function:: int PyObject_AsCharBuffer(PyObject *obj, const char **buffer, Py_ssize_t *buffer_len) + + Returns a pointer to a read-only memory location usable as character-based + input. The *obj* argument must support the single-segment character buffer + interface. On success, returns ``0``, sets *buffer* to the memory location + and *buffer_len* to the buffer length. Returns ``-1`` and sets a + :exc:`TypeError` on error. + + +.. c:function:: int PyObject_AsReadBuffer(PyObject *obj, const void **buffer, Py_ssize_t *buffer_len) + + Returns a pointer to a read-only memory location containing arbitrary data. + The *obj* argument must support the single-segment readable buffer + interface. On success, returns ``0``, sets *buffer* to the memory location + and *buffer_len* to the buffer length. Returns ``-1`` and sets a + :exc:`TypeError` on error. + + +.. c:function:: int PyObject_CheckReadBuffer(PyObject *o) + + Returns ``1`` if *o* supports the single-segment readable buffer interface. + Otherwise returns ``0``. This function always succeeds. + + Note that this function tries to get and release a buffer, and exceptions + which occur while calling corresponding functions will get suppressed. + To get error reporting use :c:func:`PyObject_GetBuffer()` instead. + + +.. c:function:: int PyObject_AsWriteBuffer(PyObject *obj, void **buffer, Py_ssize_t *buffer_len) + + Returns a pointer to a writable memory location. The *obj* argument must + support the single-segment, character buffer interface. On success, + returns ``0``, sets *buffer* to the memory location and *buffer_len* to the + buffer length. Returns ``-1`` and sets a :exc:`TypeError` on error. + diff --git a/python-3.7.4-docs-html/_sources/c-api/object.rst.txt b/python-3.7.4-docs-html/_sources/c-api/object.rst.txt new file mode 100644 index 0000000..c09d97a --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/object.rst.txt @@ -0,0 +1,451 @@ +.. highlightlang:: c + +.. _object: + +Object Protocol +=============== + + +.. c:var:: PyObject* Py_NotImplemented + + The ``NotImplemented`` singleton, used to signal that an operation is + not implemented for the given type combination. + + +.. c:macro:: Py_RETURN_NOTIMPLEMENTED + + Properly handle returning :c:data:`Py_NotImplemented` from within a C + function (that is, increment the reference count of NotImplemented and + return it). + + +.. c:function:: int PyObject_Print(PyObject *o, FILE *fp, int flags) + + Print an object *o*, on file *fp*. Returns ``-1`` on error. The flags argument + is used to enable certain printing options. The only option currently supported + is :const:`Py_PRINT_RAW`; if given, the :func:`str` of the object is written + instead of the :func:`repr`. + + +.. c:function:: int PyObject_HasAttr(PyObject *o, PyObject *attr_name) + + Returns ``1`` if *o* has the attribute *attr_name*, and ``0`` otherwise. This + is equivalent to the Python expression ``hasattr(o, attr_name)``. This function + always succeeds. + + Note that exceptions which occur while calling :meth:`__getattr__` and + :meth:`__getattribute__` methods will get suppressed. + To get error reporting use :c:func:`PyObject_GetAttr()` instead. + + +.. c:function:: int PyObject_HasAttrString(PyObject *o, const char *attr_name) + + Returns ``1`` if *o* has the attribute *attr_name*, and ``0`` otherwise. This + is equivalent to the Python expression ``hasattr(o, attr_name)``. This function + always succeeds. + + Note that exceptions which occur while calling :meth:`__getattr__` and + :meth:`__getattribute__` methods and creating a temporary string object + will get suppressed. + To get error reporting use :c:func:`PyObject_GetAttrString()` instead. + + +.. c:function:: PyObject* PyObject_GetAttr(PyObject *o, PyObject *attr_name) + + Retrieve an attribute named *attr_name* from object *o*. Returns the attribute + value on success, or *NULL* on failure. This is the equivalent of the Python + expression ``o.attr_name``. + + +.. c:function:: PyObject* PyObject_GetAttrString(PyObject *o, const char *attr_name) + + Retrieve an attribute named *attr_name* from object *o*. Returns the attribute + value on success, or *NULL* on failure. This is the equivalent of the Python + expression ``o.attr_name``. + + +.. c:function:: PyObject* PyObject_GenericGetAttr(PyObject *o, PyObject *name) + + Generic attribute getter function that is meant to be put into a type + object's ``tp_getattro`` slot. It looks for a descriptor in the dictionary + of classes in the object's MRO as well as an attribute in the object's + :attr:`~object.__dict__` (if present). As outlined in :ref:`descriptors`, + data descriptors take preference over instance attributes, while non-data + descriptors don't. Otherwise, an :exc:`AttributeError` is raised. + + +.. c:function:: int PyObject_SetAttr(PyObject *o, PyObject *attr_name, PyObject *v) + + Set the value of the attribute named *attr_name*, for object *o*, to the value + *v*. Raise an exception and return ``-1`` on failure; + return ``0`` on success. This is the equivalent of the Python statement + ``o.attr_name = v``. + + If *v* is *NULL*, the attribute is deleted, however this feature is + deprecated in favour of using :c:func:`PyObject_DelAttr`. + + +.. c:function:: int PyObject_SetAttrString(PyObject *o, const char *attr_name, PyObject *v) + + Set the value of the attribute named *attr_name*, for object *o*, to the value + *v*. Raise an exception and return ``-1`` on failure; + return ``0`` on success. This is the equivalent of the Python statement + ``o.attr_name = v``. + + If *v* is *NULL*, the attribute is deleted, however this feature is + deprecated in favour of using :c:func:`PyObject_DelAttrString`. + + +.. c:function:: int PyObject_GenericSetAttr(PyObject *o, PyObject *name, PyObject *value) + + Generic attribute setter and deleter function that is meant + to be put into a type object's :c:member:`~PyTypeObject.tp_setattro` + slot. It looks for a data descriptor in the + dictionary of classes in the object's MRO, and if found it takes preference + over setting or deleting the attribute in the instance dictionary. Otherwise, the + attribute is set or deleted in the object's :attr:`~object.__dict__` (if present). + On success, ``0`` is returned, otherwise an :exc:`AttributeError` + is raised and ``-1`` is returned. + + +.. c:function:: int PyObject_DelAttr(PyObject *o, PyObject *attr_name) + + Delete attribute named *attr_name*, for object *o*. Returns ``-1`` on failure. + This is the equivalent of the Python statement ``del o.attr_name``. + + +.. c:function:: int PyObject_DelAttrString(PyObject *o, const char *attr_name) + + Delete attribute named *attr_name*, for object *o*. Returns ``-1`` on failure. + This is the equivalent of the Python statement ``del o.attr_name``. + + +.. c:function:: PyObject* PyObject_GenericGetDict(PyObject *o, void *context) + + A generic implementation for the getter of a ``__dict__`` descriptor. It + creates the dictionary if necessary. + + .. versionadded:: 3.3 + + +.. c:function:: int PyObject_GenericSetDict(PyObject *o, void *context) + + A generic implementation for the setter of a ``__dict__`` descriptor. This + implementation does not allow the dictionary to be deleted. + + .. versionadded:: 3.3 + + +.. c:function:: PyObject* PyObject_RichCompare(PyObject *o1, PyObject *o2, int opid) + + Compare the values of *o1* and *o2* using the operation specified by *opid*, + which must be one of :const:`Py_LT`, :const:`Py_LE`, :const:`Py_EQ`, + :const:`Py_NE`, :const:`Py_GT`, or :const:`Py_GE`, corresponding to ``<``, + ``<=``, ``==``, ``!=``, ``>``, or ``>=`` respectively. This is the equivalent of + the Python expression ``o1 op o2``, where ``op`` is the operator corresponding + to *opid*. Returns the value of the comparison on success, or *NULL* on failure. + + +.. c:function:: int PyObject_RichCompareBool(PyObject *o1, PyObject *o2, int opid) + + Compare the values of *o1* and *o2* using the operation specified by *opid*, + which must be one of :const:`Py_LT`, :const:`Py_LE`, :const:`Py_EQ`, + :const:`Py_NE`, :const:`Py_GT`, or :const:`Py_GE`, corresponding to ``<``, + ``<=``, ``==``, ``!=``, ``>``, or ``>=`` respectively. Returns ``-1`` on error, + ``0`` if the result is false, ``1`` otherwise. This is the equivalent of the + Python expression ``o1 op o2``, where ``op`` is the operator corresponding to + *opid*. + +.. note:: + If *o1* and *o2* are the same object, :c:func:`PyObject_RichCompareBool` + will always return ``1`` for :const:`Py_EQ` and ``0`` for :const:`Py_NE`. + +.. c:function:: PyObject* PyObject_Repr(PyObject *o) + + .. index:: builtin: repr + + Compute a string representation of object *o*. Returns the string + representation on success, *NULL* on failure. This is the equivalent of the + Python expression ``repr(o)``. Called by the :func:`repr` built-in function. + + .. versionchanged:: 3.4 + This function now includes a debug assertion to help ensure that it + does not silently discard an active exception. + +.. c:function:: PyObject* PyObject_ASCII(PyObject *o) + + .. index:: builtin: ascii + + As :c:func:`PyObject_Repr`, compute a string representation of object *o*, but + escape the non-ASCII characters in the string returned by + :c:func:`PyObject_Repr` with ``\x``, ``\u`` or ``\U`` escapes. This generates + a string similar to that returned by :c:func:`PyObject_Repr` in Python 2. + Called by the :func:`ascii` built-in function. + + .. index:: string; PyObject_Str (C function) + + +.. c:function:: PyObject* PyObject_Str(PyObject *o) + + Compute a string representation of object *o*. Returns the string + representation on success, *NULL* on failure. This is the equivalent of the + Python expression ``str(o)``. Called by the :func:`str` built-in function + and, therefore, by the :func:`print` function. + + .. versionchanged:: 3.4 + This function now includes a debug assertion to help ensure that it + does not silently discard an active exception. + +.. c:function:: PyObject* PyObject_Bytes(PyObject *o) + + .. index:: builtin: bytes + + Compute a bytes representation of object *o*. *NULL* is returned on + failure and a bytes object on success. This is equivalent to the Python + expression ``bytes(o)``, when *o* is not an integer. Unlike ``bytes(o)``, + a TypeError is raised when *o* is an integer instead of a zero-initialized + bytes object. + + +.. c:function:: int PyObject_IsSubclass(PyObject *derived, PyObject *cls) + + Return ``1`` if the class *derived* is identical to or derived from the class + *cls*, otherwise return ``0``. In case of an error, return ``-1``. + + If *cls* is a tuple, the check will be done against every entry in *cls*. + The result will be ``1`` when at least one of the checks returns ``1``, + otherwise it will be ``0``. + + If *cls* has a :meth:`~class.__subclasscheck__` method, it will be called to + determine the subclass status as described in :pep:`3119`. Otherwise, + *derived* is a subclass of *cls* if it is a direct or indirect subclass, + i.e. contained in ``cls.__mro__``. + + Normally only class objects, i.e. instances of :class:`type` or a derived + class, are considered classes. However, objects can override this by having + a :attr:`__bases__` attribute (which must be a tuple of base classes). + + +.. c:function:: int PyObject_IsInstance(PyObject *inst, PyObject *cls) + + Return ``1`` if *inst* is an instance of the class *cls* or a subclass of + *cls*, or ``0`` if not. On error, returns ``-1`` and sets an exception. + + If *cls* is a tuple, the check will be done against every entry in *cls*. + The result will be ``1`` when at least one of the checks returns ``1``, + otherwise it will be ``0``. + + If *cls* has a :meth:`~class.__instancecheck__` method, it will be called to + determine the subclass status as described in :pep:`3119`. Otherwise, *inst* + is an instance of *cls* if its class is a subclass of *cls*. + + An instance *inst* can override what is considered its class by having a + :attr:`__class__` attribute. + + An object *cls* can override if it is considered a class, and what its base + classes are, by having a :attr:`__bases__` attribute (which must be a tuple + of base classes). + + +.. c:function:: int PyCallable_Check(PyObject *o) + + Determine if the object *o* is callable. Return ``1`` if the object is callable + and ``0`` otherwise. This function always succeeds. + + +.. c:function:: PyObject* PyObject_Call(PyObject *callable, PyObject *args, PyObject *kwargs) + + Call a callable Python object *callable*, with arguments given by the + tuple *args*, and named arguments given by the dictionary *kwargs*. + + *args* must not be *NULL*, use an empty tuple if no arguments are needed. + If no named arguments are needed, *kwargs* can be *NULL*. + + Return the result of the call on success, or raise an exception and return + *NULL* on failure. + + This is the equivalent of the Python expression: + ``callable(*args, **kwargs)``. + + +.. c:function:: PyObject* PyObject_CallObject(PyObject *callable, PyObject *args) + + Call a callable Python object *callable*, with arguments given by the + tuple *args*. If no arguments are needed, then *args* can be *NULL*. + + Return the result of the call on success, or raise an exception and return + *NULL* on failure. + + This is the equivalent of the Python expression: ``callable(*args)``. + + +.. c:function:: PyObject* PyObject_CallFunction(PyObject *callable, const char *format, ...) + + Call a callable Python object *callable*, with a variable number of C arguments. + The C arguments are described using a :c:func:`Py_BuildValue` style format + string. The format can be *NULL*, indicating that no arguments are provided. + + Return the result of the call on success, or raise an exception and return + *NULL* on failure. + + This is the equivalent of the Python expression: ``callable(*args)``. + + Note that if you only pass :c:type:`PyObject \*` args, + :c:func:`PyObject_CallFunctionObjArgs` is a faster alternative. + + .. versionchanged:: 3.4 + The type of *format* was changed from ``char *``. + + +.. c:function:: PyObject* PyObject_CallMethod(PyObject *obj, const char *name, const char *format, ...) + + Call the method named *name* of object *obj* with a variable number of C + arguments. The C arguments are described by a :c:func:`Py_BuildValue` format + string that should produce a tuple. + + The format can be *NULL*, indicating that no arguments are provided. + + Return the result of the call on success, or raise an exception and return + *NULL* on failure. + + This is the equivalent of the Python expression: + ``obj.name(arg1, arg2, ...)``. + + Note that if you only pass :c:type:`PyObject \*` args, + :c:func:`PyObject_CallMethodObjArgs` is a faster alternative. + + .. versionchanged:: 3.4 + The types of *name* and *format* were changed from ``char *``. + + +.. c:function:: PyObject* PyObject_CallFunctionObjArgs(PyObject *callable, ..., NULL) + + Call a callable Python object *callable*, with a variable number of + :c:type:`PyObject\*` arguments. The arguments are provided as a variable number + of parameters followed by *NULL*. + + Return the result of the call on success, or raise an exception and return + *NULL* on failure. + + This is the equivalent of the Python expression: + ``callable(arg1, arg2, ...)``. + + +.. c:function:: PyObject* PyObject_CallMethodObjArgs(PyObject *obj, PyObject *name, ..., NULL) + + Calls a method of the Python object *obj*, where the name of the method is given as a + Python string object in *name*. It is called with a variable number of + :c:type:`PyObject\*` arguments. The arguments are provided as a variable number + of parameters followed by *NULL*. + + Return the result of the call on success, or raise an exception and return + *NULL* on failure. + + +.. c:function:: Py_hash_t PyObject_Hash(PyObject *o) + + .. index:: builtin: hash + + Compute and return the hash value of an object *o*. On failure, return ``-1``. + This is the equivalent of the Python expression ``hash(o)``. + + .. versionchanged:: 3.2 + The return type is now Py_hash_t. This is a signed integer the same size + as Py_ssize_t. + + +.. c:function:: Py_hash_t PyObject_HashNotImplemented(PyObject *o) + + Set a :exc:`TypeError` indicating that ``type(o)`` is not hashable and return ``-1``. + This function receives special treatment when stored in a ``tp_hash`` slot, + allowing a type to explicitly indicate to the interpreter that it is not + hashable. + + +.. c:function:: int PyObject_IsTrue(PyObject *o) + + Returns ``1`` if the object *o* is considered to be true, and ``0`` otherwise. + This is equivalent to the Python expression ``not not o``. On failure, return + ``-1``. + + +.. c:function:: int PyObject_Not(PyObject *o) + + Returns ``0`` if the object *o* is considered to be true, and ``1`` otherwise. + This is equivalent to the Python expression ``not o``. On failure, return + ``-1``. + + +.. c:function:: PyObject* PyObject_Type(PyObject *o) + + .. index:: builtin: type + + When *o* is non-*NULL*, returns a type object corresponding to the object type + of object *o*. On failure, raises :exc:`SystemError` and returns *NULL*. This + is equivalent to the Python expression ``type(o)``. This function increments the + reference count of the return value. There's really no reason to use this + function instead of the common expression ``o->ob_type``, which returns a + pointer of type :c:type:`PyTypeObject\*`, except when the incremented reference + count is needed. + + +.. c:function:: int PyObject_TypeCheck(PyObject *o, PyTypeObject *type) + + Return true if the object *o* is of type *type* or a subtype of *type*. Both + parameters must be non-*NULL*. + + +.. c:function:: Py_ssize_t PyObject_Size(PyObject *o) + Py_ssize_t PyObject_Length(PyObject *o) + + .. index:: builtin: len + + Return the length of object *o*. If the object *o* provides either the sequence + and mapping protocols, the sequence length is returned. On error, ``-1`` is + returned. This is the equivalent to the Python expression ``len(o)``. + + +.. c:function:: Py_ssize_t PyObject_LengthHint(PyObject *o, Py_ssize_t default) + + Return an estimated length for the object *o*. First try to return its + actual length, then an estimate using :meth:`~object.__length_hint__`, and + finally return the default value. On error return ``-1``. This is the + equivalent to the Python expression ``operator.length_hint(o, default)``. + + .. versionadded:: 3.4 + + +.. c:function:: PyObject* PyObject_GetItem(PyObject *o, PyObject *key) + + Return element of *o* corresponding to the object *key* or *NULL* on failure. + This is the equivalent of the Python expression ``o[key]``. + + +.. c:function:: int PyObject_SetItem(PyObject *o, PyObject *key, PyObject *v) + + Map the object *key* to the value *v*. Raise an exception and + return ``-1`` on failure; return ``0`` on success. This is the + equivalent of the Python statement ``o[key] = v``. + + +.. c:function:: int PyObject_DelItem(PyObject *o, PyObject *key) + + Remove the mapping for the object *key* from the object *o*. Return ``-1`` + on failure. This is equivalent to the Python statement ``del o[key]``. + + +.. c:function:: PyObject* PyObject_Dir(PyObject *o) + + This is equivalent to the Python expression ``dir(o)``, returning a (possibly + empty) list of strings appropriate for the object argument, or *NULL* if there + was an error. If the argument is *NULL*, this is like the Python ``dir()``, + returning the names of the current locals; in this case, if no execution frame + is active then *NULL* is returned but :c:func:`PyErr_Occurred` will return false. + + +.. c:function:: PyObject* PyObject_GetIter(PyObject *o) + + This is equivalent to the Python expression ``iter(o)``. It returns a new + iterator for the object argument, or the object itself if the object is already + an iterator. Raises :exc:`TypeError` and returns *NULL* if the object cannot be + iterated. diff --git a/python-3.7.4-docs-html/_sources/c-api/objimpl.rst.txt b/python-3.7.4-docs-html/_sources/c-api/objimpl.rst.txt new file mode 100644 index 0000000..7023e51 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/objimpl.rst.txt @@ -0,0 +1,17 @@ +.. highlightlang:: c + +.. _newtypes: + +***************************** +Object Implementation Support +***************************** + +This chapter describes the functions, types, and macros used when defining new +object types. + +.. toctree:: + + allocation.rst + structures.rst + typeobj.rst + gcsupport.rst diff --git a/python-3.7.4-docs-html/_sources/c-api/refcounting.rst.txt b/python-3.7.4-docs-html/_sources/c-api/refcounting.rst.txt new file mode 100644 index 0000000..4f512ec --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/refcounting.rst.txt @@ -0,0 +1,73 @@ +.. highlightlang:: c + + +.. _countingrefs: + +****************** +Reference Counting +****************** + +The macros in this section are used for managing reference counts of Python +objects. + + +.. c:function:: void Py_INCREF(PyObject *o) + + Increment the reference count for object *o*. The object must not be *NULL*; if + you aren't sure that it isn't *NULL*, use :c:func:`Py_XINCREF`. + + +.. c:function:: void Py_XINCREF(PyObject *o) + + Increment the reference count for object *o*. The object may be *NULL*, in + which case the macro has no effect. + + +.. c:function:: void Py_DECREF(PyObject *o) + + Decrement the reference count for object *o*. The object must not be *NULL*; if + you aren't sure that it isn't *NULL*, use :c:func:`Py_XDECREF`. If the reference + count reaches zero, the object's type's deallocation function (which must not be + *NULL*) is invoked. + + .. warning:: + + The deallocation function can cause arbitrary Python code to be invoked (e.g. + when a class instance with a :meth:`__del__` method is deallocated). While + exceptions in such code are not propagated, the executed code has free access to + all Python global variables. This means that any object that is reachable from + a global variable should be in a consistent state before :c:func:`Py_DECREF` is + invoked. For example, code to delete an object from a list should copy a + reference to the deleted object in a temporary variable, update the list data + structure, and then call :c:func:`Py_DECREF` for the temporary variable. + + +.. c:function:: void Py_XDECREF(PyObject *o) + + Decrement the reference count for object *o*. The object may be *NULL*, in + which case the macro has no effect; otherwise the effect is the same as for + :c:func:`Py_DECREF`, and the same warning applies. + + +.. c:function:: void Py_CLEAR(PyObject *o) + + Decrement the reference count for object *o*. The object may be *NULL*, in + which case the macro has no effect; otherwise the effect is the same as for + :c:func:`Py_DECREF`, except that the argument is also set to *NULL*. The warning + for :c:func:`Py_DECREF` does not apply with respect to the object passed because + the macro carefully uses a temporary variable and sets the argument to *NULL* + before decrementing its reference count. + + It is a good idea to use this macro whenever decrementing the value of a + variable that might be traversed during garbage collection. + + +The following functions are for runtime dynamic embedding of Python: +``Py_IncRef(PyObject *o)``, ``Py_DecRef(PyObject *o)``. They are +simply exported function versions of :c:func:`Py_XINCREF` and +:c:func:`Py_XDECREF`, respectively. + +The following functions or macros are only for use within the interpreter core: +:c:func:`_Py_Dealloc`, :c:func:`_Py_ForgetReference`, :c:func:`_Py_NewReference`, +as well as the global variable :c:data:`_Py_RefTotal`. + diff --git a/python-3.7.4-docs-html/_sources/c-api/reflection.rst.txt b/python-3.7.4-docs-html/_sources/c-api/reflection.rst.txt new file mode 100644 index 0000000..9689365 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/reflection.rst.txt @@ -0,0 +1,49 @@ +.. highlightlang:: c + +.. _reflection: + +Reflection +========== + +.. c:function:: PyObject* PyEval_GetBuiltins() + + Return a dictionary of the builtins in the current execution frame, + or the interpreter of the thread state if no frame is currently executing. + + +.. c:function:: PyObject* PyEval_GetLocals() + + Return a dictionary of the local variables in the current execution frame, + or *NULL* if no frame is currently executing. + + +.. c:function:: PyObject* PyEval_GetGlobals() + + Return a dictionary of the global variables in the current execution frame, + or *NULL* if no frame is currently executing. + + +.. c:function:: PyFrameObject* PyEval_GetFrame() + + Return the current thread state's frame, which is *NULL* if no frame is + currently executing. + + +.. c:function:: int PyFrame_GetLineNumber(PyFrameObject *frame) + + Return the line number that *frame* is currently executing. + + +.. c:function:: const char* PyEval_GetFuncName(PyObject *func) + + Return the name of *func* if it is a function, class or instance object, else the + name of *func*\s type. + + +.. c:function:: const char* PyEval_GetFuncDesc(PyObject *func) + + Return a description string, depending on the type of *func*. + Return values include "()" for functions and methods, " constructor", + " instance", and " object". Concatenated with the result of + :c:func:`PyEval_GetFuncName`, the result will be a description of + *func*. diff --git a/python-3.7.4-docs-html/_sources/c-api/sequence.rst.txt b/python-3.7.4-docs-html/_sources/c-api/sequence.rst.txt new file mode 100644 index 0000000..6d22f35 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/sequence.rst.txt @@ -0,0 +1,169 @@ +.. highlightlang:: c + +.. _sequence: + +Sequence Protocol +================= + + +.. c:function:: int PySequence_Check(PyObject *o) + + Return ``1`` if the object provides sequence protocol, and ``0`` otherwise. + Note that it returns ``1`` for Python classes with a :meth:`__getitem__` + method unless they are :class:`dict` subclasses since in general case it + is impossible to determine what the type of keys it supports. This + function always succeeds. + + +.. c:function:: Py_ssize_t PySequence_Size(PyObject *o) + Py_ssize_t PySequence_Length(PyObject *o) + + .. index:: builtin: len + + Returns the number of objects in sequence *o* on success, and ``-1`` on + failure. This is equivalent to the Python expression ``len(o)``. + + +.. c:function:: PyObject* PySequence_Concat(PyObject *o1, PyObject *o2) + + Return the concatenation of *o1* and *o2* on success, and *NULL* on failure. + This is the equivalent of the Python expression ``o1 + o2``. + + +.. c:function:: PyObject* PySequence_Repeat(PyObject *o, Py_ssize_t count) + + Return the result of repeating sequence object *o* *count* times, or *NULL* on + failure. This is the equivalent of the Python expression ``o * count``. + + +.. c:function:: PyObject* PySequence_InPlaceConcat(PyObject *o1, PyObject *o2) + + Return the concatenation of *o1* and *o2* on success, and *NULL* on failure. + The operation is done *in-place* when *o1* supports it. This is the equivalent + of the Python expression ``o1 += o2``. + + +.. c:function:: PyObject* PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count) + + Return the result of repeating sequence object *o* *count* times, or *NULL* on + failure. The operation is done *in-place* when *o* supports it. This is the + equivalent of the Python expression ``o *= count``. + + +.. c:function:: PyObject* PySequence_GetItem(PyObject *o, Py_ssize_t i) + + Return the *i*\ th element of *o*, or *NULL* on failure. This is the equivalent of + the Python expression ``o[i]``. + + +.. c:function:: PyObject* PySequence_GetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2) + + Return the slice of sequence object *o* between *i1* and *i2*, or *NULL* on + failure. This is the equivalent of the Python expression ``o[i1:i2]``. + + +.. c:function:: int PySequence_SetItem(PyObject *o, Py_ssize_t i, PyObject *v) + + Assign object *v* to the *i*\ th element of *o*. Raise an exception + and return ``-1`` on failure; return ``0`` on success. This + is the equivalent of the Python statement ``o[i] = v``. This function *does + not* steal a reference to *v*. + + If *v* is *NULL*, the element is deleted, however this feature is + deprecated in favour of using :c:func:`PySequence_DelItem`. + + +.. c:function:: int PySequence_DelItem(PyObject *o, Py_ssize_t i) + + Delete the *i*\ th element of object *o*. Returns ``-1`` on failure. This is the + equivalent of the Python statement ``del o[i]``. + + +.. c:function:: int PySequence_SetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2, PyObject *v) + + Assign the sequence object *v* to the slice in sequence object *o* from *i1* to + *i2*. This is the equivalent of the Python statement ``o[i1:i2] = v``. + + +.. c:function:: int PySequence_DelSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2) + + Delete the slice in sequence object *o* from *i1* to *i2*. Returns ``-1`` on + failure. This is the equivalent of the Python statement ``del o[i1:i2]``. + + +.. c:function:: Py_ssize_t PySequence_Count(PyObject *o, PyObject *value) + + Return the number of occurrences of *value* in *o*, that is, return the number + of keys for which ``o[key] == value``. On failure, return ``-1``. This is + equivalent to the Python expression ``o.count(value)``. + + +.. c:function:: int PySequence_Contains(PyObject *o, PyObject *value) + + Determine if *o* contains *value*. If an item in *o* is equal to *value*, + return ``1``, otherwise return ``0``. On error, return ``-1``. This is + equivalent to the Python expression ``value in o``. + + +.. c:function:: Py_ssize_t PySequence_Index(PyObject *o, PyObject *value) + + Return the first index *i* for which ``o[i] == value``. On error, return + ``-1``. This is equivalent to the Python expression ``o.index(value)``. + + +.. c:function:: PyObject* PySequence_List(PyObject *o) + + Return a list object with the same contents as the sequence or iterable *o*, + or *NULL* on failure. The returned list is guaranteed to be new. This is + equivalent to the Python expression ``list(o)``. + + +.. c:function:: PyObject* PySequence_Tuple(PyObject *o) + + .. index:: builtin: tuple + + Return a tuple object with the same contents as the sequence or iterable *o*, + or *NULL* on failure. If *o* is a tuple, a new reference will be returned, + otherwise a tuple will be constructed with the appropriate contents. This is + equivalent to the Python expression ``tuple(o)``. + + +.. c:function:: PyObject* PySequence_Fast(PyObject *o, const char *m) + + Return the sequence or iterable *o* as a list, unless it is already a tuple or list, in + which case *o* is returned. Use :c:func:`PySequence_Fast_GET_ITEM` to access + the members of the result. Returns *NULL* on failure. If the object is not + a sequence or iterable, raises :exc:`TypeError` with *m* as the message text. + + +.. c:function:: Py_ssize_t PySequence_Fast_GET_SIZE(PyObject *o) + + Returns the length of *o*, assuming that *o* was returned by + :c:func:`PySequence_Fast` and that *o* is not *NULL*. The size can also be + gotten by calling :c:func:`PySequence_Size` on *o*, but + :c:func:`PySequence_Fast_GET_SIZE` is faster because it can assume *o* is a list + or tuple. + + +.. c:function:: PyObject* PySequence_Fast_GET_ITEM(PyObject *o, Py_ssize_t i) + + Return the *i*\ th element of *o*, assuming that *o* was returned by + :c:func:`PySequence_Fast`, *o* is not *NULL*, and that *i* is within bounds. + + +.. c:function:: PyObject** PySequence_Fast_ITEMS(PyObject *o) + + Return the underlying array of PyObject pointers. Assumes that *o* was returned + by :c:func:`PySequence_Fast` and *o* is not *NULL*. + + Note, if a list gets resized, the reallocation may relocate the items array. + So, only use the underlying array pointer in contexts where the sequence + cannot change. + + +.. c:function:: PyObject* PySequence_ITEM(PyObject *o, Py_ssize_t i) + + Return the *i*\ th element of *o* or *NULL* on failure. Macro form of + :c:func:`PySequence_GetItem` but without checking that + :c:func:`PySequence_Check` on *o* is true and without adjustment for negative + indices. diff --git a/python-3.7.4-docs-html/_sources/c-api/set.rst.txt b/python-3.7.4-docs-html/_sources/c-api/set.rst.txt new file mode 100644 index 0000000..64b6dde --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/set.rst.txt @@ -0,0 +1,166 @@ +.. highlightlang:: c + +.. _setobjects: + +Set Objects +----------- + +.. sectionauthor:: Raymond D. Hettinger + + +.. index:: + object: set + object: frozenset + +This section details the public API for :class:`set` and :class:`frozenset` +objects. Any functionality not listed below is best accessed using the either +the abstract object protocol (including :c:func:`PyObject_CallMethod`, +:c:func:`PyObject_RichCompareBool`, :c:func:`PyObject_Hash`, +:c:func:`PyObject_Repr`, :c:func:`PyObject_IsTrue`, :c:func:`PyObject_Print`, and +:c:func:`PyObject_GetIter`) or the abstract number protocol (including +:c:func:`PyNumber_And`, :c:func:`PyNumber_Subtract`, :c:func:`PyNumber_Or`, +:c:func:`PyNumber_Xor`, :c:func:`PyNumber_InPlaceAnd`, +:c:func:`PyNumber_InPlaceSubtract`, :c:func:`PyNumber_InPlaceOr`, and +:c:func:`PyNumber_InPlaceXor`). + + +.. c:type:: PySetObject + + This subtype of :c:type:`PyObject` is used to hold the internal data for both + :class:`set` and :class:`frozenset` objects. It is like a :c:type:`PyDictObject` + in that it is a fixed size for small sets (much like tuple storage) and will + point to a separate, variable sized block of memory for medium and large sized + sets (much like list storage). None of the fields of this structure should be + considered public and are subject to change. All access should be done through + the documented API rather than by manipulating the values in the structure. + + +.. c:var:: PyTypeObject PySet_Type + + This is an instance of :c:type:`PyTypeObject` representing the Python + :class:`set` type. + + +.. c:var:: PyTypeObject PyFrozenSet_Type + + This is an instance of :c:type:`PyTypeObject` representing the Python + :class:`frozenset` type. + +The following type check macros work on pointers to any Python object. Likewise, +the constructor functions work with any iterable Python object. + + +.. c:function:: int PySet_Check(PyObject *p) + + Return true if *p* is a :class:`set` object or an instance of a subtype. + +.. c:function:: int PyFrozenSet_Check(PyObject *p) + + Return true if *p* is a :class:`frozenset` object or an instance of a + subtype. + +.. c:function:: int PyAnySet_Check(PyObject *p) + + Return true if *p* is a :class:`set` object, a :class:`frozenset` object, or an + instance of a subtype. + + +.. c:function:: int PyAnySet_CheckExact(PyObject *p) + + Return true if *p* is a :class:`set` object or a :class:`frozenset` object but + not an instance of a subtype. + + +.. c:function:: int PyFrozenSet_CheckExact(PyObject *p) + + Return true if *p* is a :class:`frozenset` object but not an instance of a + subtype. + + +.. c:function:: PyObject* PySet_New(PyObject *iterable) + + Return a new :class:`set` containing objects returned by the *iterable*. The + *iterable* may be *NULL* to create a new empty set. Return the new set on + success or *NULL* on failure. Raise :exc:`TypeError` if *iterable* is not + actually iterable. The constructor is also useful for copying a set + (``c=set(s)``). + + +.. c:function:: PyObject* PyFrozenSet_New(PyObject *iterable) + + Return a new :class:`frozenset` containing objects returned by the *iterable*. + The *iterable* may be *NULL* to create a new empty frozenset. Return the new + set on success or *NULL* on failure. Raise :exc:`TypeError` if *iterable* is + not actually iterable. + + +The following functions and macros are available for instances of :class:`set` +or :class:`frozenset` or instances of their subtypes. + + +.. c:function:: Py_ssize_t PySet_Size(PyObject *anyset) + + .. index:: builtin: len + + Return the length of a :class:`set` or :class:`frozenset` object. Equivalent to + ``len(anyset)``. Raises a :exc:`PyExc_SystemError` if *anyset* is not a + :class:`set`, :class:`frozenset`, or an instance of a subtype. + + +.. c:function:: Py_ssize_t PySet_GET_SIZE(PyObject *anyset) + + Macro form of :c:func:`PySet_Size` without error checking. + + +.. c:function:: int PySet_Contains(PyObject *anyset, PyObject *key) + + Return ``1`` if found, ``0`` if not found, and ``-1`` if an error is encountered. Unlike + the Python :meth:`__contains__` method, this function does not automatically + convert unhashable sets into temporary frozensets. Raise a :exc:`TypeError` if + the *key* is unhashable. Raise :exc:`PyExc_SystemError` if *anyset* is not a + :class:`set`, :class:`frozenset`, or an instance of a subtype. + + +.. c:function:: int PySet_Add(PyObject *set, PyObject *key) + + Add *key* to a :class:`set` instance. Also works with :class:`frozenset` + instances (like :c:func:`PyTuple_SetItem` it can be used to fill-in the values + of brand new frozensets before they are exposed to other code). Return ``0`` on + success or ``-1`` on failure. Raise a :exc:`TypeError` if the *key* is + unhashable. Raise a :exc:`MemoryError` if there is no room to grow. Raise a + :exc:`SystemError` if *set* is not an instance of :class:`set` or its + subtype. + + +The following functions are available for instances of :class:`set` or its +subtypes but not for instances of :class:`frozenset` or its subtypes. + + +.. c:function:: int PySet_Discard(PyObject *set, PyObject *key) + + Return ``1`` if found and removed, ``0`` if not found (no action taken), and ``-1`` if an + error is encountered. Does not raise :exc:`KeyError` for missing keys. Raise a + :exc:`TypeError` if the *key* is unhashable. Unlike the Python :meth:`~set.discard` + method, this function does not automatically convert unhashable sets into + temporary frozensets. Raise :exc:`PyExc_SystemError` if *set* is not an + instance of :class:`set` or its subtype. + + +.. c:function:: PyObject* PySet_Pop(PyObject *set) + + Return a new reference to an arbitrary object in the *set*, and removes the + object from the *set*. Return *NULL* on failure. Raise :exc:`KeyError` if the + set is empty. Raise a :exc:`SystemError` if *set* is not an instance of + :class:`set` or its subtype. + + +.. c:function:: int PySet_Clear(PyObject *set) + + Empty an existing set of all elements. + + +.. c:function:: int PySet_ClearFreeList() + + Clear the free list. Return the total number of freed items. + + .. versionadded:: 3.3 diff --git a/python-3.7.4-docs-html/_sources/c-api/slice.rst.txt b/python-3.7.4-docs-html/_sources/c-api/slice.rst.txt new file mode 100644 index 0000000..8ad9a29 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/slice.rst.txt @@ -0,0 +1,122 @@ +.. highlightlang:: c + +.. _slice-objects: + +Slice Objects +------------- + + +.. c:var:: PyTypeObject PySlice_Type + + The type object for slice objects. This is the same as :class:`slice` in the + Python layer. + + +.. c:function:: int PySlice_Check(PyObject *ob) + + Return true if *ob* is a slice object; *ob* must not be *NULL*. + + +.. c:function:: PyObject* PySlice_New(PyObject *start, PyObject *stop, PyObject *step) + + Return a new slice object with the given values. The *start*, *stop*, and + *step* parameters are used as the values of the slice object attributes of + the same names. Any of the values may be *NULL*, in which case the + ``None`` will be used for the corresponding attribute. Return *NULL* if + the new object could not be allocated. + + +.. c:function:: int PySlice_GetIndices(PyObject *slice, Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step) + + Retrieve the start, stop and step indices from the slice object *slice*, + assuming a sequence of length *length*. Treats indices greater than + *length* as errors. + + Returns ``0`` on success and ``-1`` on error with no exception set (unless one of + the indices was not :const:`None` and failed to be converted to an integer, + in which case ``-1`` is returned with an exception set). + + You probably do not want to use this function. + + .. versionchanged:: 3.2 + The parameter type for the *slice* parameter was ``PySliceObject*`` + before. + + +.. c:function:: int PySlice_GetIndicesEx(PyObject *slice, Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step, Py_ssize_t *slicelength) + + Usable replacement for :c:func:`PySlice_GetIndices`. Retrieve the start, + stop, and step indices from the slice object *slice* assuming a sequence of + length *length*, and store the length of the slice in *slicelength*. Out + of bounds indices are clipped in a manner consistent with the handling of + normal slices. + + Returns ``0`` on success and ``-1`` on error with exception set. + + .. note:: + This function is considered not safe for resizable sequences. + Its invocation should be replaced by a combination of + :c:func:`PySlice_Unpack` and :c:func:`PySlice_AdjustIndices` where :: + + if (PySlice_GetIndicesEx(slice, length, &start, &stop, &step, &slicelength) < 0) { + // return error + } + + is replaced by :: + + if (PySlice_Unpack(slice, &start, &stop, &step) < 0) { + // return error + } + slicelength = PySlice_AdjustIndices(length, &start, &stop, step); + + .. versionchanged:: 3.2 + The parameter type for the *slice* parameter was ``PySliceObject*`` + before. + + .. versionchanged:: 3.6.1 + If ``Py_LIMITED_API`` is not set or set to the value between ``0x03050400`` + and ``0x03060000`` (not including) or ``0x03060100`` or higher + :c:func:`!PySlice_GetIndicesEx` is implemented as a macro using + :c:func:`!PySlice_Unpack` and :c:func:`!PySlice_AdjustIndices`. + Arguments *start*, *stop* and *step* are evaluated more than once. + + .. deprecated:: 3.6.1 + If ``Py_LIMITED_API`` is set to the value less than ``0x03050400`` or + between ``0x03060000`` and ``0x03060100`` (not including) + :c:func:`!PySlice_GetIndicesEx` is a deprecated function. + + +.. c:function:: int PySlice_Unpack(PyObject *slice, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step) + + Extract the start, stop and step data members from a slice object as + C integers. Silently reduce values larger than ``PY_SSIZE_T_MAX`` to + ``PY_SSIZE_T_MAX``, silently boost the start and stop values less than + ``PY_SSIZE_T_MIN`` to ``PY_SSIZE_T_MIN``, and silently boost the step + values less than ``-PY_SSIZE_T_MAX`` to ``-PY_SSIZE_T_MAX``. + + Return ``-1`` on error, ``0`` on success. + + .. versionadded:: 3.6.1 + + +.. c:function:: Py_ssize_t PySlice_AdjustIndices(Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t step) + + Adjust start/end slice indices assuming a sequence of the specified length. + Out of bounds indices are clipped in a manner consistent with the handling + of normal slices. + + Return the length of the slice. Always successful. Doesn't call Python + code. + + .. versionadded:: 3.6.1 + + +Ellipsis Object +--------------- + + +.. c:var:: PyObject *Py_Ellipsis + + The Python ``Ellipsis`` object. This object has no methods. It needs to be + treated just like any other object with respect to reference counts. Like + :c:data:`Py_None` it is a singleton object. diff --git a/python-3.7.4-docs-html/_sources/c-api/stable.rst.txt b/python-3.7.4-docs-html/_sources/c-api/stable.rst.txt new file mode 100644 index 0000000..5b771dd --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/stable.rst.txt @@ -0,0 +1,38 @@ +.. highlightlang:: c + +.. _stable: + +*********************************** +Stable Application Binary Interface +*********************************** + +Traditionally, the C API of Python will change with every release. Most changes +will be source-compatible, typically by only adding API, rather than changing +existing API or removing API (although some interfaces do get removed after +being deprecated first). + +Unfortunately, the API compatibility does not extend to binary compatibility +(the ABI). The reason is primarily the evolution of struct definitions, where +addition of a new field, or changing the type of a field, might not break the +API, but can break the ABI. As a consequence, extension modules need to be +recompiled for every Python release (although an exception is possible on Unix +when none of the affected interfaces are used). In addition, on Windows, +extension modules link with a specific pythonXY.dll and need to be recompiled to +link with a newer one. + +Since Python 3.2, a subset of the API has been declared to guarantee a stable +ABI. Extension modules wishing to use this API (called "limited API") need to +define ``Py_LIMITED_API``. A number of interpreter details then become hidden +from the extension module; in return, a module is built that works on any 3.x +version (x>=2) without recompilation. + +In some cases, the stable ABI needs to be extended with new functions. +Extension modules wishing to use these new APIs need to set ``Py_LIMITED_API`` +to the ``PY_VERSION_HEX`` value (see :ref:`apiabiversion`) of the minimum Python +version they want to support (e.g. ``0x03030000`` for Python 3.3). Such modules +will work on all subsequent Python releases, but fail to load (because of +missing symbols) on the older releases. + +As of Python 3.2, the set of functions available to the limited API is +documented in :pep:`384`. In the C API documentation, API elements that are not +part of the limited API are marked as "Not part of the limited API." diff --git a/python-3.7.4-docs-html/_sources/c-api/structures.rst.txt b/python-3.7.4-docs-html/_sources/c-api/structures.rst.txt new file mode 100644 index 0000000..274beee --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/structures.rst.txt @@ -0,0 +1,376 @@ +.. highlightlang:: c + +.. _common-structs: + +Common Object Structures +======================== + +There are a large number of structures which are used in the definition of +object types for Python. This section describes these structures and how they +are used. + +All Python objects ultimately share a small number of fields at the beginning +of the object's representation in memory. These are represented by the +:c:type:`PyObject` and :c:type:`PyVarObject` types, which are defined, in turn, +by the expansions of some macros also used, whether directly or indirectly, in +the definition of all other Python objects. + + +.. c:type:: PyObject + + All object types are extensions of this type. This is a type which + contains the information Python needs to treat a pointer to an object as an + object. In a normal "release" build, it contains only the object's + reference count and a pointer to the corresponding type object. + Nothing is actually declared to be a :c:type:`PyObject`, but every pointer + to a Python object can be cast to a :c:type:`PyObject*`. Access to the + members must be done by using the macros :c:macro:`Py_REFCNT` and + :c:macro:`Py_TYPE`. + + +.. c:type:: PyVarObject + + This is an extension of :c:type:`PyObject` that adds the :attr:`ob_size` + field. This is only used for objects that have some notion of *length*. + This type does not often appear in the Python/C API. + Access to the members must be done by using the macros + :c:macro:`Py_REFCNT`, :c:macro:`Py_TYPE`, and :c:macro:`Py_SIZE`. + + +.. c:macro:: PyObject_HEAD + + This is a macro used when declaring new types which represent objects + without a varying length. The PyObject_HEAD macro expands to:: + + PyObject ob_base; + + See documentation of :c:type:`PyObject` above. + + +.. c:macro:: PyObject_VAR_HEAD + + This is a macro used when declaring new types which represent objects + with a length that varies from instance to instance. + The PyObject_VAR_HEAD macro expands to:: + + PyVarObject ob_base; + + See documentation of :c:type:`PyVarObject` above. + + +.. c:macro:: Py_TYPE(o) + + This macro is used to access the :attr:`ob_type` member of a Python object. + It expands to:: + + (((PyObject*)(o))->ob_type) + + +.. c:macro:: Py_REFCNT(o) + + This macro is used to access the :attr:`ob_refcnt` member of a Python + object. + It expands to:: + + (((PyObject*)(o))->ob_refcnt) + + +.. c:macro:: Py_SIZE(o) + + This macro is used to access the :attr:`ob_size` member of a Python object. + It expands to:: + + (((PyVarObject*)(o))->ob_size) + + +.. c:macro:: PyObject_HEAD_INIT(type) + + This is a macro which expands to initialization values for a new + :c:type:`PyObject` type. This macro expands to:: + + _PyObject_EXTRA_INIT + 1, type, + + +.. c:macro:: PyVarObject_HEAD_INIT(type, size) + + This is a macro which expands to initialization values for a new + :c:type:`PyVarObject` type, including the :attr:`ob_size` field. + This macro expands to:: + + _PyObject_EXTRA_INIT + 1, type, size, + + +.. c:type:: PyCFunction + + Type of the functions used to implement most Python callables in C. + Functions of this type take two :c:type:`PyObject\*` parameters and return + one such value. If the return value is *NULL*, an exception shall have + been set. If not *NULL*, the return value is interpreted as the return + value of the function as exposed in Python. The function must return a new + reference. + + +.. c:type:: PyCFunctionWithKeywords + + Type of the functions used to implement Python callables in C + with signature :const:`METH_VARARGS | METH_KEYWORDS`. + + +.. c:type:: _PyCFunctionFast + + Type of the functions used to implement Python callables in C + with signature :const:`METH_FASTCALL`. + + +.. c:type:: _PyCFunctionFastWithKeywords + + Type of the functions used to implement Python callables in C + with signature :const:`METH_FASTCALL | METH_KEYWORDS`. + + +.. c:type:: PyMethodDef + + Structure used to describe a method of an extension type. This structure has + four fields: + + +------------------+---------------+-------------------------------+ + | Field | C Type | Meaning | + +==================+===============+===============================+ + | :attr:`ml_name` | const char \* | name of the method | + +------------------+---------------+-------------------------------+ + | :attr:`ml_meth` | PyCFunction | pointer to the C | + | | | implementation | + +------------------+---------------+-------------------------------+ + | :attr:`ml_flags` | int | flag bits indicating how the | + | | | call should be constructed | + +------------------+---------------+-------------------------------+ + | :attr:`ml_doc` | const char \* | points to the contents of the | + | | | docstring | + +------------------+---------------+-------------------------------+ + +The :attr:`ml_meth` is a C function pointer. The functions may be of different +types, but they always return :c:type:`PyObject\*`. If the function is not of +the :c:type:`PyCFunction`, the compiler will require a cast in the method table. +Even though :c:type:`PyCFunction` defines the first parameter as +:c:type:`PyObject\*`, it is common that the method implementation uses the +specific C type of the *self* object. + +The :attr:`ml_flags` field is a bitfield which can include the following flags. +The individual flags indicate either a calling convention or a binding +convention. + +There are four basic calling conventions for positional arguments +and two of them can be combined with :const:`METH_KEYWORDS` to support +also keyword arguments. So there are a total of 6 calling conventions: + +.. data:: METH_VARARGS + + This is the typical calling convention, where the methods have the type + :c:type:`PyCFunction`. The function expects two :c:type:`PyObject\*` values. + The first one is the *self* object for methods; for module functions, it is + the module object. The second parameter (often called *args*) is a tuple + object representing all arguments. This parameter is typically processed + using :c:func:`PyArg_ParseTuple` or :c:func:`PyArg_UnpackTuple`. + + +.. data:: METH_VARARGS | METH_KEYWORDS + + Methods with these flags must be of type :c:type:`PyCFunctionWithKeywords`. + The function expects three parameters: *self*, *args*, *kwargs* where + *kwargs* is a dictionary of all the keyword arguments or possibly *NULL* + if there are no keyword arguments. The parameters are typically processed + using :c:func:`PyArg_ParseTupleAndKeywords`. + + +.. data:: METH_FASTCALL + + Fast calling convention supporting only positional arguments. + The methods have the type :c:type:`_PyCFunctionFast`. + The first parameter is *self*, the second parameter is a C array + of :c:type:`PyObject\*` values indicating the arguments and the third + parameter is the number of arguments (the length of the array). + + This is not part of the :ref:`limited API `. + + .. versionadded:: 3.7 + + +.. data:: METH_FASTCALL | METH_KEYWORDS + + Extension of :const:`METH_FASTCALL` supporting also keyword arguments, + with methods of type :c:type:`_PyCFunctionFastWithKeywords`. + Keyword arguments are passed the same way as in the vectorcall protocol: + there is an additional fourth :c:type:`PyObject\*` parameter + which is a tuple representing the names of the keyword arguments + or possibly *NULL* if there are no keywords. The values of the keyword + arguments are stored in the *args* array, after the positional arguments. + + This is not part of the :ref:`limited API `. + + .. versionadded:: 3.7 + + +.. data:: METH_NOARGS + + Methods without parameters don't need to check whether arguments are given if + they are listed with the :const:`METH_NOARGS` flag. They need to be of type + :c:type:`PyCFunction`. The first parameter is typically named *self* and will + hold a reference to the module or object instance. In all cases the second + parameter will be *NULL*. + + +.. data:: METH_O + + Methods with a single object argument can be listed with the :const:`METH_O` + flag, instead of invoking :c:func:`PyArg_ParseTuple` with a ``"O"`` argument. + They have the type :c:type:`PyCFunction`, with the *self* parameter, and a + :c:type:`PyObject\*` parameter representing the single argument. + + +These two constants are not used to indicate the calling convention but the +binding when use with methods of classes. These may not be used for functions +defined for modules. At most one of these flags may be set for any given +method. + + +.. data:: METH_CLASS + + .. index:: builtin: classmethod + + The method will be passed the type object as the first parameter rather + than an instance of the type. This is used to create *class methods*, + similar to what is created when using the :func:`classmethod` built-in + function. + + +.. data:: METH_STATIC + + .. index:: builtin: staticmethod + + The method will be passed *NULL* as the first parameter rather than an + instance of the type. This is used to create *static methods*, similar to + what is created when using the :func:`staticmethod` built-in function. + +One other constant controls whether a method is loaded in place of another +definition with the same method name. + + +.. data:: METH_COEXIST + + The method will be loaded in place of existing definitions. Without + *METH_COEXIST*, the default is to skip repeated definitions. Since slot + wrappers are loaded before the method table, the existence of a + *sq_contains* slot, for example, would generate a wrapped method named + :meth:`__contains__` and preclude the loading of a corresponding + PyCFunction with the same name. With the flag defined, the PyCFunction + will be loaded in place of the wrapper object and will co-exist with the + slot. This is helpful because calls to PyCFunctions are optimized more + than wrapper object calls. + + +.. c:type:: PyMemberDef + + Structure which describes an attribute of a type which corresponds to a C + struct member. Its fields are: + + +------------------+---------------+-------------------------------+ + | Field | C Type | Meaning | + +==================+===============+===============================+ + | :attr:`name` | const char \* | name of the member | + +------------------+---------------+-------------------------------+ + | :attr:`!type` | int | the type of the member in the | + | | | C struct | + +------------------+---------------+-------------------------------+ + | :attr:`offset` | Py_ssize_t | the offset in bytes that the | + | | | member is located on the | + | | | type's object struct | + +------------------+---------------+-------------------------------+ + | :attr:`flags` | int | flag bits indicating if the | + | | | field should be read-only or | + | | | writable | + +------------------+---------------+-------------------------------+ + | :attr:`doc` | const char \* | points to the contents of the | + | | | docstring | + +------------------+---------------+-------------------------------+ + + :attr:`!type` can be one of many ``T_`` macros corresponding to various C + types. When the member is accessed in Python, it will be converted to the + equivalent Python type. + + =============== ================== + Macro name C type + =============== ================== + T_SHORT short + T_INT int + T_LONG long + T_FLOAT float + T_DOUBLE double + T_STRING const char \* + T_OBJECT PyObject \* + T_OBJECT_EX PyObject \* + T_CHAR char + T_BYTE char + T_UBYTE unsigned char + T_UINT unsigned int + T_USHORT unsigned short + T_ULONG unsigned long + T_BOOL char + T_LONGLONG long long + T_ULONGLONG unsigned long long + T_PYSSIZET Py_ssize_t + =============== ================== + + :c:macro:`T_OBJECT` and :c:macro:`T_OBJECT_EX` differ in that + :c:macro:`T_OBJECT` returns ``None`` if the member is *NULL* and + :c:macro:`T_OBJECT_EX` raises an :exc:`AttributeError`. Try to use + :c:macro:`T_OBJECT_EX` over :c:macro:`T_OBJECT` because :c:macro:`T_OBJECT_EX` + handles use of the :keyword:`del` statement on that attribute more correctly + than :c:macro:`T_OBJECT`. + + :attr:`flags` can be ``0`` for write and read access or :c:macro:`READONLY` for + read-only access. Using :c:macro:`T_STRING` for :attr:`type` implies + :c:macro:`READONLY`. :c:macro:`T_STRING` data is interpreted as UTF-8. + Only :c:macro:`T_OBJECT` and :c:macro:`T_OBJECT_EX` + members can be deleted. (They are set to *NULL*). + + +.. c:type:: PyGetSetDef + + Structure to define property-like access for a type. See also description of + the :c:member:`PyTypeObject.tp_getset` slot. + + +-------------+------------------+-----------------------------------+ + | Field | C Type | Meaning | + +=============+==================+===================================+ + | name | const char \* | attribute name | + +-------------+------------------+-----------------------------------+ + | get | getter | C Function to get the attribute | + +-------------+------------------+-----------------------------------+ + | set | setter | optional C function to set or | + | | | delete the attribute, if omitted | + | | | the attribute is readonly | + +-------------+------------------+-----------------------------------+ + | doc | const char \* | optional docstring | + +-------------+------------------+-----------------------------------+ + | closure | void \* | optional function pointer, | + | | | providing additional data for | + | | | getter and setter | + +-------------+------------------+-----------------------------------+ + + The ``get`` function takes one :c:type:`PyObject\*` parameter (the + instance) and a function pointer (the associated ``closure``):: + + typedef PyObject *(*getter)(PyObject *, void *); + + It should return a new reference on success or *NULL* with a set exception + on failure. + + ``set`` functions take two :c:type:`PyObject\*` parameters (the instance and + the value to be set) and a function pointer (the associated ``closure``):: + + typedef int (*setter)(PyObject *, PyObject *, void *); + + In case the attribute should be deleted the second parameter is *NULL*. + Should return ``0`` on success or ``-1`` with a set exception on failure. diff --git a/python-3.7.4-docs-html/_sources/c-api/sys.rst.txt b/python-3.7.4-docs-html/_sources/c-api/sys.rst.txt new file mode 100644 index 0000000..994509a --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/sys.rst.txt @@ -0,0 +1,329 @@ +.. highlightlang:: c + +.. _os: + +Operating System Utilities +========================== + +.. c:function:: PyObject* PyOS_FSPath(PyObject *path) + + Return the file system representation for *path*. If the object is a + :class:`str` or :class:`bytes` object, then its reference count is + incremented. If the object implements the :class:`os.PathLike` interface, + then :meth:`~os.PathLike.__fspath__` is returned as long as it is a + :class:`str` or :class:`bytes` object. Otherwise :exc:`TypeError` is raised + and ``NULL`` is returned. + + .. versionadded:: 3.6 + + +.. c:function:: int Py_FdIsInteractive(FILE *fp, const char *filename) + + Return true (nonzero) if the standard I/O file *fp* with name *filename* is + deemed interactive. This is the case for files for which ``isatty(fileno(fp))`` + is true. If the global flag :c:data:`Py_InteractiveFlag` is true, this function + also returns true if the *filename* pointer is *NULL* or if the name is equal to + one of the strings ``''`` or ``'???'``. + + +.. c:function:: void PyOS_BeforeFork() + + Function to prepare some internal state before a process fork. This + should be called before calling :c:func:`fork` or any similar function + that clones the current process. + Only available on systems where :c:func:`fork` is defined. + + .. versionadded:: 3.7 + + +.. c:function:: void PyOS_AfterFork_Parent() + + Function to update some internal state after a process fork. This + should be called from the parent process after calling :c:func:`fork` + or any similar function that clones the current process, regardless + of whether process cloning was successful. + Only available on systems where :c:func:`fork` is defined. + + .. versionadded:: 3.7 + + +.. c:function:: void PyOS_AfterFork_Child() + + Function to update internal interpreter state after a process fork. + This must be called from the child process after calling :c:func:`fork`, + or any similar function that clones the current process, if there is + any chance the process will call back into the Python interpreter. + Only available on systems where :c:func:`fork` is defined. + + .. versionadded:: 3.7 + + .. seealso:: + :func:`os.register_at_fork` allows registering custom Python functions + to be called by :c:func:`PyOS_BeforeFork()`, + :c:func:`PyOS_AfterFork_Parent` and :c:func:`PyOS_AfterFork_Child`. + + +.. c:function:: void PyOS_AfterFork() + + Function to update some internal state after a process fork; this should be + called in the new process if the Python interpreter will continue to be used. + If a new executable is loaded into the new process, this function does not need + to be called. + + .. deprecated:: 3.7 + This function is superseded by :c:func:`PyOS_AfterFork_Child()`. + + +.. c:function:: int PyOS_CheckStack() + + Return true when the interpreter runs out of stack space. This is a reliable + check, but is only available when :const:`USE_STACKCHECK` is defined (currently + on Windows using the Microsoft Visual C++ compiler). :const:`USE_STACKCHECK` + will be defined automatically; you should never change the definition in your + own code. + + +.. c:function:: PyOS_sighandler_t PyOS_getsig(int i) + + Return the current signal handler for signal *i*. This is a thin wrapper around + either :c:func:`sigaction` or :c:func:`signal`. Do not call those functions + directly! :c:type:`PyOS_sighandler_t` is a typedef alias for :c:type:`void + (\*)(int)`. + + +.. c:function:: PyOS_sighandler_t PyOS_setsig(int i, PyOS_sighandler_t h) + + Set the signal handler for signal *i* to be *h*; return the old signal handler. + This is a thin wrapper around either :c:func:`sigaction` or :c:func:`signal`. Do + not call those functions directly! :c:type:`PyOS_sighandler_t` is a typedef + alias for :c:type:`void (\*)(int)`. + +.. c:function:: wchar_t* Py_DecodeLocale(const char* arg, size_t *size) + + Decode a byte string from the locale encoding with the :ref:`surrogateescape + error handler `: undecodable bytes are decoded as + characters in range U+DC80..U+DCFF. If a byte sequence can be decoded as a + surrogate character, escape the bytes using the surrogateescape error + handler instead of decoding them. + + Encoding, highest priority to lowest priority: + + * ``UTF-8`` on macOS and Android; + * ``UTF-8`` if the Python UTF-8 mode is enabled; + * ``ASCII`` if the ``LC_CTYPE`` locale is ``"C"``, + ``nl_langinfo(CODESET)`` returns the ``ASCII`` encoding (or an alias), + and :c:func:`mbstowcs` and :c:func:`wcstombs` functions uses the + ``ISO-8859-1`` encoding. + * the current locale encoding. + + Return a pointer to a newly allocated wide character string, use + :c:func:`PyMem_RawFree` to free the memory. If size is not ``NULL``, write + the number of wide characters excluding the null character into ``*size`` + + Return ``NULL`` on decoding error or memory allocation error. If *size* is + not ``NULL``, ``*size`` is set to ``(size_t)-1`` on memory error or set to + ``(size_t)-2`` on decoding error. + + Decoding errors should never happen, unless there is a bug in the C + library. + + Use the :c:func:`Py_EncodeLocale` function to encode the character string + back to a byte string. + + .. seealso:: + + The :c:func:`PyUnicode_DecodeFSDefaultAndSize` and + :c:func:`PyUnicode_DecodeLocaleAndSize` functions. + + .. versionadded:: 3.5 + + .. versionchanged:: 3.7 + The function now uses the UTF-8 encoding in the UTF-8 mode. + + +.. c:function:: char* Py_EncodeLocale(const wchar_t *text, size_t *error_pos) + + Encode a wide character string to the locale encoding with the + :ref:`surrogateescape error handler `: surrogate characters + in the range U+DC80..U+DCFF are converted to bytes 0x80..0xFF. + + Encoding, highest priority to lowest priority: + + * ``UTF-8`` on macOS and Android; + * ``UTF-8`` if the Python UTF-8 mode is enabled; + * ``ASCII`` if the ``LC_CTYPE`` locale is ``"C"``, + ``nl_langinfo(CODESET)`` returns the ``ASCII`` encoding (or an alias), + and :c:func:`mbstowcs` and :c:func:`wcstombs` functions uses the + ``ISO-8859-1`` encoding. + * the current locale encoding. + + The function uses the UTF-8 encoding in the Python UTF-8 mode. + + Return a pointer to a newly allocated byte string, use :c:func:`PyMem_Free` + to free the memory. Return ``NULL`` on encoding error or memory allocation + error + + If error_pos is not ``NULL``, ``*error_pos`` is set to ``(size_t)-1`` on + success, or set to the index of the invalid character on encoding error. + + Use the :c:func:`Py_DecodeLocale` function to decode the bytes string back + to a wide character string. + + .. versionchanged:: 3.7 + The function now uses the UTF-8 encoding in the UTF-8 mode. + + .. seealso:: + + The :c:func:`PyUnicode_EncodeFSDefault` and + :c:func:`PyUnicode_EncodeLocale` functions. + + .. versionadded:: 3.5 + + .. versionchanged:: 3.7 + The function now supports the UTF-8 mode. + + +.. _systemfunctions: + +System Functions +================ + +These are utility functions that make functionality from the :mod:`sys` module +accessible to C code. They all work with the current interpreter thread's +:mod:`sys` module's dict, which is contained in the internal thread state structure. + +.. c:function:: PyObject *PySys_GetObject(const char *name) + + Return the object *name* from the :mod:`sys` module or *NULL* if it does + not exist, without setting an exception. + +.. c:function:: int PySys_SetObject(const char *name, PyObject *v) + + Set *name* in the :mod:`sys` module to *v* unless *v* is *NULL*, in which + case *name* is deleted from the sys module. Returns ``0`` on success, ``-1`` + on error. + +.. c:function:: void PySys_ResetWarnOptions() + + Reset :data:`sys.warnoptions` to an empty list. This function may be + called prior to :c:func:`Py_Initialize`. + +.. c:function:: void PySys_AddWarnOption(const wchar_t *s) + + Append *s* to :data:`sys.warnoptions`. This function must be called prior + to :c:func:`Py_Initialize` in order to affect the warnings filter list. + +.. c:function:: void PySys_AddWarnOptionUnicode(PyObject *unicode) + + Append *unicode* to :data:`sys.warnoptions`. + + Note: this function is not currently usable from outside the CPython + implementation, as it must be called prior to the implicit import of + :mod:`warnings` in :c:func:`Py_Initialize` to be effective, but can't be + called until enough of the runtime has been initialized to permit the + creation of Unicode objects. + +.. c:function:: void PySys_SetPath(const wchar_t *path) + + Set :data:`sys.path` to a list object of paths found in *path* which should + be a list of paths separated with the platform's search path delimiter + (``:`` on Unix, ``;`` on Windows). + +.. c:function:: void PySys_WriteStdout(const char *format, ...) + + Write the output string described by *format* to :data:`sys.stdout`. No + exceptions are raised, even if truncation occurs (see below). + + *format* should limit the total size of the formatted output string to + 1000 bytes or less -- after 1000 bytes, the output string is truncated. + In particular, this means that no unrestricted "%s" formats should occur; + these should be limited using "%.s" where is a decimal number + calculated so that plus the maximum size of other formatted text does not + exceed 1000 bytes. Also watch out for "%f", which can print hundreds of + digits for very large numbers. + + If a problem occurs, or :data:`sys.stdout` is unset, the formatted message + is written to the real (C level) *stdout*. + +.. c:function:: void PySys_WriteStderr(const char *format, ...) + + As :c:func:`PySys_WriteStdout`, but write to :data:`sys.stderr` or *stderr* + instead. + +.. c:function:: void PySys_FormatStdout(const char *format, ...) + + Function similar to PySys_WriteStdout() but format the message using + :c:func:`PyUnicode_FromFormatV` and don't truncate the message to an + arbitrary length. + + .. versionadded:: 3.2 + +.. c:function:: void PySys_FormatStderr(const char *format, ...) + + As :c:func:`PySys_FormatStdout`, but write to :data:`sys.stderr` or *stderr* + instead. + + .. versionadded:: 3.2 + +.. c:function:: void PySys_AddXOption(const wchar_t *s) + + Parse *s* as a set of :option:`-X` options and add them to the current + options mapping as returned by :c:func:`PySys_GetXOptions`. This function + may be called prior to :c:func:`Py_Initialize`. + + .. versionadded:: 3.2 + +.. c:function:: PyObject *PySys_GetXOptions() + + Return the current dictionary of :option:`-X` options, similarly to + :data:`sys._xoptions`. On error, *NULL* is returned and an exception is + set. + + .. versionadded:: 3.2 + + +.. _processcontrol: + +Process Control +=============== + + +.. c:function:: void Py_FatalError(const char *message) + + .. index:: single: abort() + + Print a fatal error message and kill the process. No cleanup is performed. + This function should only be invoked when a condition is detected that would + make it dangerous to continue using the Python interpreter; e.g., when the + object administration appears to be corrupted. On Unix, the standard C library + function :c:func:`abort` is called which will attempt to produce a :file:`core` + file. + + +.. c:function:: void Py_Exit(int status) + + .. index:: + single: Py_FinalizeEx() + single: exit() + + Exit the current process. This calls :c:func:`Py_FinalizeEx` and then calls the + standard C library function ``exit(status)``. If :c:func:`Py_FinalizeEx` + indicates an error, the exit status is set to 120. + + .. versionchanged:: 3.6 + Errors from finalization no longer ignored. + + +.. c:function:: int Py_AtExit(void (*func) ()) + + .. index:: + single: Py_FinalizeEx() + single: cleanup functions + + Register a cleanup function to be called by :c:func:`Py_FinalizeEx`. The cleanup + function will be called with no arguments and should return no value. At most + 32 cleanup functions can be registered. When the registration is successful, + :c:func:`Py_AtExit` returns ``0``; on failure, it returns ``-1``. The cleanup + function registered last is called first. Each cleanup function will be called + at most once. Since Python's internal finalization will have completed before + the cleanup function, no Python APIs should be called by *func*. diff --git a/python-3.7.4-docs-html/_sources/c-api/tuple.rst.txt b/python-3.7.4-docs-html/_sources/c-api/tuple.rst.txt new file mode 100644 index 0000000..20bf9f0 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/tuple.rst.txt @@ -0,0 +1,218 @@ +.. highlightlang:: c + +.. _tupleobjects: + +Tuple Objects +------------- + +.. index:: object: tuple + + +.. c:type:: PyTupleObject + + This subtype of :c:type:`PyObject` represents a Python tuple object. + + +.. c:var:: PyTypeObject PyTuple_Type + + This instance of :c:type:`PyTypeObject` represents the Python tuple type; it + is the same object as :class:`tuple` in the Python layer. + + +.. c:function:: int PyTuple_Check(PyObject *p) + + Return true if *p* is a tuple object or an instance of a subtype of the tuple + type. + + +.. c:function:: int PyTuple_CheckExact(PyObject *p) + + Return true if *p* is a tuple object, but not an instance of a subtype of the + tuple type. + + +.. c:function:: PyObject* PyTuple_New(Py_ssize_t len) + + Return a new tuple object of size *len*, or *NULL* on failure. + + +.. c:function:: PyObject* PyTuple_Pack(Py_ssize_t n, ...) + + Return a new tuple object of size *n*, or *NULL* on failure. The tuple values + are initialized to the subsequent *n* C arguments pointing to Python objects. + ``PyTuple_Pack(2, a, b)`` is equivalent to ``Py_BuildValue("(OO)", a, b)``. + + +.. c:function:: Py_ssize_t PyTuple_Size(PyObject *p) + + Take a pointer to a tuple object, and return the size of that tuple. + + +.. c:function:: Py_ssize_t PyTuple_GET_SIZE(PyObject *p) + + Return the size of the tuple *p*, which must be non-*NULL* and point to a tuple; + no error checking is performed. + + +.. c:function:: PyObject* PyTuple_GetItem(PyObject *p, Py_ssize_t pos) + + Return the object at position *pos* in the tuple pointed to by *p*. If *pos* is + out of bounds, return *NULL* and sets an :exc:`IndexError` exception. + + +.. c:function:: PyObject* PyTuple_GET_ITEM(PyObject *p, Py_ssize_t pos) + + Like :c:func:`PyTuple_GetItem`, but does no checking of its arguments. + + +.. c:function:: PyObject* PyTuple_GetSlice(PyObject *p, Py_ssize_t low, Py_ssize_t high) + + Take a slice of the tuple pointed to by *p* from *low* to *high* and return it + as a new tuple. + + +.. c:function:: int PyTuple_SetItem(PyObject *p, Py_ssize_t pos, PyObject *o) + + Insert a reference to object *o* at position *pos* of the tuple pointed to by + *p*. Return ``0`` on success. + + .. note:: + + This function "steals" a reference to *o*. + + +.. c:function:: void PyTuple_SET_ITEM(PyObject *p, Py_ssize_t pos, PyObject *o) + + Like :c:func:`PyTuple_SetItem`, but does no error checking, and should *only* be + used to fill in brand new tuples. + + .. note:: + + This function "steals" a reference to *o*. + + +.. c:function:: int _PyTuple_Resize(PyObject **p, Py_ssize_t newsize) + + Can be used to resize a tuple. *newsize* will be the new length of the tuple. + Because tuples are *supposed* to be immutable, this should only be used if there + is only one reference to the object. Do *not* use this if the tuple may already + be known to some other part of the code. The tuple will always grow or shrink + at the end. Think of this as destroying the old tuple and creating a new one, + only more efficiently. Returns ``0`` on success. Client code should never + assume that the resulting value of ``*p`` will be the same as before calling + this function. If the object referenced by ``*p`` is replaced, the original + ``*p`` is destroyed. On failure, returns ``-1`` and sets ``*p`` to *NULL*, and + raises :exc:`MemoryError` or :exc:`SystemError`. + + +.. c:function:: int PyTuple_ClearFreeList() + + Clear the free list. Return the total number of freed items. + + +Struct Sequence Objects +----------------------- + +Struct sequence objects are the C equivalent of :func:`~collections.namedtuple` +objects, i.e. a sequence whose items can also be accessed through attributes. +To create a struct sequence, you first have to create a specific struct sequence +type. + +.. c:function:: PyTypeObject* PyStructSequence_NewType(PyStructSequence_Desc *desc) + + Create a new struct sequence type from the data in *desc*, described below. Instances + of the resulting type can be created with :c:func:`PyStructSequence_New`. + + +.. c:function:: void PyStructSequence_InitType(PyTypeObject *type, PyStructSequence_Desc *desc) + + Initializes a struct sequence type *type* from *desc* in place. + + +.. c:function:: int PyStructSequence_InitType2(PyTypeObject *type, PyStructSequence_Desc *desc) + + The same as ``PyStructSequence_InitType``, but returns ``0`` on success and ``-1`` on + failure. + + .. versionadded:: 3.4 + + +.. c:type:: PyStructSequence_Desc + + Contains the meta information of a struct sequence type to create. + + +-------------------+------------------------------+------------------------------------+ + | Field | C Type | Meaning | + +===================+==============================+====================================+ + | ``name`` | ``const char *`` | name of the struct sequence type | + +-------------------+------------------------------+------------------------------------+ + | ``doc`` | ``const char *`` | pointer to docstring for the type | + | | | or NULL to omit | + +-------------------+------------------------------+------------------------------------+ + | ``fields`` | ``PyStructSequence_Field *`` | pointer to *NULL*-terminated array | + | | | with field names of the new type | + +-------------------+------------------------------+------------------------------------+ + | ``n_in_sequence`` | ``int`` | number of fields visible to the | + | | | Python side (if used as tuple) | + +-------------------+------------------------------+------------------------------------+ + + +.. c:type:: PyStructSequence_Field + + Describes a field of a struct sequence. As a struct sequence is modeled as a + tuple, all fields are typed as :c:type:`PyObject\*`. The index in the + :attr:`fields` array of the :c:type:`PyStructSequence_Desc` determines which + field of the struct sequence is described. + + +-----------+------------------+--------------------------------------+ + | Field | C Type | Meaning | + +===========+==================+======================================+ + | ``name`` | ``const char *`` | name for the field or *NULL* to end | + | | | the list of named fields, set to | + | | | PyStructSequence_UnnamedField to | + | | | leave unnamed | + +-----------+------------------+--------------------------------------+ + | ``doc`` | ``const char *`` | field docstring or *NULL* to omit | + +-----------+------------------+--------------------------------------+ + + +.. c:var:: char* PyStructSequence_UnnamedField + + Special value for a field name to leave it unnamed. + + +.. c:function:: PyObject* PyStructSequence_New(PyTypeObject *type) + + Creates an instance of *type*, which must have been created with + :c:func:`PyStructSequence_NewType`. + + +.. c:function:: PyObject* PyStructSequence_GetItem(PyObject *p, Py_ssize_t pos) + + Return the object at position *pos* in the struct sequence pointed to by *p*. + No bounds checking is performed. + + +.. c:function:: PyObject* PyStructSequence_GET_ITEM(PyObject *p, Py_ssize_t pos) + + Macro equivalent of :c:func:`PyStructSequence_GetItem`. + + +.. c:function:: void PyStructSequence_SetItem(PyObject *p, Py_ssize_t pos, PyObject *o) + + Sets the field at index *pos* of the struct sequence *p* to value *o*. Like + :c:func:`PyTuple_SET_ITEM`, this should only be used to fill in brand new + instances. + + .. note:: + + This function "steals" a reference to *o*. + + +.. c:function:: void PyStructSequence_SET_ITEM(PyObject *p, Py_ssize_t *pos, PyObject *o) + + Macro equivalent of :c:func:`PyStructSequence_SetItem`. + + .. note:: + + This function "steals" a reference to *o*. diff --git a/python-3.7.4-docs-html/_sources/c-api/type.rst.txt b/python-3.7.4-docs-html/_sources/c-api/type.rst.txt new file mode 100644 index 0000000..4dfd53f --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/type.rst.txt @@ -0,0 +1,118 @@ +.. highlightlang:: c + +.. _typeobjects: + +Type Objects +------------ + +.. index:: object: type + + +.. c:type:: PyTypeObject + + The C structure of the objects used to describe built-in types. + + +.. c:var:: PyObject* PyType_Type + + This is the type object for type objects; it is the same object as + :class:`type` in the Python layer. + + +.. c:function:: int PyType_Check(PyObject *o) + + Return true if the object *o* is a type object, including instances of types + derived from the standard type object. Return false in all other cases. + + +.. c:function:: int PyType_CheckExact(PyObject *o) + + Return true if the object *o* is a type object, but not a subtype of the + standard type object. Return false in all other cases. + + +.. c:function:: unsigned int PyType_ClearCache() + + Clear the internal lookup cache. Return the current version tag. + +.. c:function:: unsigned long PyType_GetFlags(PyTypeObject* type) + + Return the :c:member:`~PyTypeObject.tp_flags` member of *type*. This function is primarily + meant for use with `Py_LIMITED_API`; the individual flag bits are + guaranteed to be stable across Python releases, but access to + :c:member:`~PyTypeObject.tp_flags` itself is not part of the limited API. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.4 + The return type is now ``unsigned long`` rather than ``long``. + + +.. c:function:: void PyType_Modified(PyTypeObject *type) + + Invalidate the internal lookup cache for the type and all of its + subtypes. This function must be called after any manual + modification of the attributes or base classes of the type. + + +.. c:function:: int PyType_HasFeature(PyTypeObject *o, int feature) + + Return true if the type object *o* sets the feature *feature*. Type features + are denoted by single bit flags. + + +.. c:function:: int PyType_IS_GC(PyTypeObject *o) + + Return true if the type object includes support for the cycle detector; this + tests the type flag :const:`Py_TPFLAGS_HAVE_GC`. + + +.. c:function:: int PyType_IsSubtype(PyTypeObject *a, PyTypeObject *b) + + Return true if *a* is a subtype of *b*. + + This function only checks for actual subtypes, which means that + :meth:`~class.__subclasscheck__` is not called on *b*. Call + :c:func:`PyObject_IsSubclass` to do the same check that :func:`issubclass` + would do. + + +.. c:function:: PyObject* PyType_GenericAlloc(PyTypeObject *type, Py_ssize_t nitems) + + Generic handler for the :c:member:`~PyTypeObject.tp_alloc` slot of a type object. Use + Python's default memory allocation mechanism to allocate a new instance and + initialize all its contents to *NULL*. + +.. c:function:: PyObject* PyType_GenericNew(PyTypeObject *type, PyObject *args, PyObject *kwds) + + Generic handler for the :c:member:`~PyTypeObject.tp_new` slot of a type object. Create a + new instance using the type's :c:member:`~PyTypeObject.tp_alloc` slot. + +.. c:function:: int PyType_Ready(PyTypeObject *type) + + Finalize a type object. This should be called on all type objects to finish + their initialization. This function is responsible for adding inherited slots + from a type's base class. Return ``0`` on success, or return ``-1`` and sets an + exception on error. + +.. c:function:: PyObject* PyType_FromSpec(PyType_Spec *spec) + + Creates and returns a heap type object from the *spec* passed to the function. + +.. c:function:: PyObject* PyType_FromSpecWithBases(PyType_Spec *spec, PyObject *bases) + + Creates and returns a heap type object from the *spec*. In addition to that, + the created heap type contains all types contained by the *bases* tuple as base + types. This allows the caller to reference other heap types as base types. + + .. versionadded:: 3.3 + +.. c:function:: void* PyType_GetSlot(PyTypeObject *type, int slot) + + Return the function pointer stored in the given slot. If the + result is *NULL*, this indicates that either the slot is *NULL*, + or that the function was called with invalid parameters. + Callers will typically cast the result pointer into the appropriate + function type. + + .. versionadded:: 3.4 diff --git a/python-3.7.4-docs-html/_sources/c-api/typeobj.rst.txt b/python-3.7.4-docs-html/_sources/c-api/typeobj.rst.txt new file mode 100644 index 0000000..532508e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/typeobj.rst.txt @@ -0,0 +1,1418 @@ +.. highlightlang:: c + +.. _type-structs: + +Type Objects +============ + +Perhaps one of the most important structures of the Python object system is the +structure that defines a new type: the :c:type:`PyTypeObject` structure. Type +objects can be handled using any of the :c:func:`PyObject_\*` or +:c:func:`PyType_\*` functions, but do not offer much that's interesting to most +Python applications. These objects are fundamental to how objects behave, so +they are very important to the interpreter itself and to any extension module +that implements new types. + +Type objects are fairly large compared to most of the standard types. The reason +for the size is that each type object stores a large number of values, mostly C +function pointers, each of which implements a small part of the type's +functionality. The fields of the type object are examined in detail in this +section. The fields will be described in the order in which they occur in the +structure. + +Typedefs: unaryfunc, binaryfunc, ternaryfunc, inquiry, intargfunc, +intintargfunc, intobjargproc, intintobjargproc, objobjargproc, destructor, +freefunc, printfunc, getattrfunc, getattrofunc, setattrfunc, setattrofunc, +reprfunc, hashfunc + +The structure definition for :c:type:`PyTypeObject` can be found in +:file:`Include/object.h`. For convenience of reference, this repeats the +definition found there: + +.. literalinclude:: ../includes/typestruct.h + + +The type object structure extends the :c:type:`PyVarObject` structure. The +:attr:`ob_size` field is used for dynamic types (created by :func:`type_new`, +usually called from a class statement). Note that :c:data:`PyType_Type` (the +metatype) initializes :c:member:`~PyTypeObject.tp_itemsize`, which means that its instances (i.e. +type objects) *must* have the :attr:`ob_size` field. + + +.. c:member:: PyObject* PyObject._ob_next + PyObject* PyObject._ob_prev + + These fields are only present when the macro ``Py_TRACE_REFS`` is defined. + Their initialization to *NULL* is taken care of by the ``PyObject_HEAD_INIT`` + macro. For statically allocated objects, these fields always remain *NULL*. + For dynamically allocated objects, these two fields are used to link the object + into a doubly-linked list of *all* live objects on the heap. This could be used + for various debugging purposes; currently the only use is to print the objects + that are still alive at the end of a run when the environment variable + :envvar:`PYTHONDUMPREFS` is set. + + These fields are not inherited by subtypes. + + +.. c:member:: Py_ssize_t PyObject.ob_refcnt + + This is the type object's reference count, initialized to ``1`` by the + ``PyObject_HEAD_INIT`` macro. Note that for statically allocated type objects, + the type's instances (objects whose :attr:`ob_type` points back to the type) do + *not* count as references. But for dynamically allocated type objects, the + instances *do* count as references. + + This field is not inherited by subtypes. + + +.. c:member:: PyTypeObject* PyObject.ob_type + + This is the type's type, in other words its metatype. It is initialized by the + argument to the ``PyObject_HEAD_INIT`` macro, and its value should normally be + ``&PyType_Type``. However, for dynamically loadable extension modules that must + be usable on Windows (at least), the compiler complains that this is not a valid + initializer. Therefore, the convention is to pass *NULL* to the + ``PyObject_HEAD_INIT`` macro and to initialize this field explicitly at the + start of the module's initialization function, before doing anything else. This + is typically done like this:: + + Foo_Type.ob_type = &PyType_Type; + + This should be done before any instances of the type are created. + :c:func:`PyType_Ready` checks if :attr:`ob_type` is *NULL*, and if so, + initializes it to the :attr:`ob_type` field of the base class. + :c:func:`PyType_Ready` will not change this field if it is non-zero. + + This field is inherited by subtypes. + + +.. c:member:: Py_ssize_t PyVarObject.ob_size + + For statically allocated type objects, this should be initialized to zero. For + dynamically allocated type objects, this field has a special internal meaning. + + This field is not inherited by subtypes. + + +.. c:member:: const char* PyTypeObject.tp_name + + Pointer to a NUL-terminated string containing the name of the type. For types + that are accessible as module globals, the string should be the full module + name, followed by a dot, followed by the type name; for built-in types, it + should be just the type name. If the module is a submodule of a package, the + full package name is part of the full module name. For example, a type named + :class:`T` defined in module :mod:`M` in subpackage :mod:`Q` in package :mod:`P` + should have the :c:member:`~PyTypeObject.tp_name` initializer ``"P.Q.M.T"``. + + For dynamically allocated type objects, this should just be the type name, and + the module name explicitly stored in the type dict as the value for key + ``'__module__'``. + + For statically allocated type objects, the tp_name field should contain a dot. + Everything before the last dot is made accessible as the :attr:`__module__` + attribute, and everything after the last dot is made accessible as the + :attr:`~definition.__name__` attribute. + + If no dot is present, the entire :c:member:`~PyTypeObject.tp_name` field is made accessible as the + :attr:`~definition.__name__` attribute, and the :attr:`__module__` attribute is undefined + (unless explicitly set in the dictionary, as explained above). This means your + type will be impossible to pickle. Additionally, it will not be listed in + module documentations created with pydoc. + + This field is not inherited by subtypes. + + +.. c:member:: Py_ssize_t PyTypeObject.tp_basicsize + Py_ssize_t PyTypeObject.tp_itemsize + + These fields allow calculating the size in bytes of instances of the type. + + There are two kinds of types: types with fixed-length instances have a zero + :c:member:`~PyTypeObject.tp_itemsize` field, types with variable-length instances have a non-zero + :c:member:`~PyTypeObject.tp_itemsize` field. For a type with fixed-length instances, all + instances have the same size, given in :c:member:`~PyTypeObject.tp_basicsize`. + + For a type with variable-length instances, the instances must have an + :attr:`ob_size` field, and the instance size is :c:member:`~PyTypeObject.tp_basicsize` plus N + times :c:member:`~PyTypeObject.tp_itemsize`, where N is the "length" of the object. The value of + N is typically stored in the instance's :attr:`ob_size` field. There are + exceptions: for example, ints use a negative :attr:`ob_size` to indicate a + negative number, and N is ``abs(ob_size)`` there. Also, the presence of an + :attr:`ob_size` field in the instance layout doesn't mean that the instance + structure is variable-length (for example, the structure for the list type has + fixed-length instances, yet those instances have a meaningful :attr:`ob_size` + field). + + The basic size includes the fields in the instance declared by the macro + :c:macro:`PyObject_HEAD` or :c:macro:`PyObject_VAR_HEAD` (whichever is used to + declare the instance struct) and this in turn includes the :attr:`_ob_prev` and + :attr:`_ob_next` fields if they are present. This means that the only correct + way to get an initializer for the :c:member:`~PyTypeObject.tp_basicsize` is to use the + ``sizeof`` operator on the struct used to declare the instance layout. + The basic size does not include the GC header size. + + These fields are inherited separately by subtypes. If the base type has a + non-zero :c:member:`~PyTypeObject.tp_itemsize`, it is generally not safe to set + :c:member:`~PyTypeObject.tp_itemsize` to a different non-zero value in a subtype (though this + depends on the implementation of the base type). + + A note about alignment: if the variable items require a particular alignment, + this should be taken care of by the value of :c:member:`~PyTypeObject.tp_basicsize`. Example: + suppose a type implements an array of ``double``. :c:member:`~PyTypeObject.tp_itemsize` is + ``sizeof(double)``. It is the programmer's responsibility that + :c:member:`~PyTypeObject.tp_basicsize` is a multiple of ``sizeof(double)`` (assuming this is the + alignment requirement for ``double``). + + +.. c:member:: destructor PyTypeObject.tp_dealloc + + A pointer to the instance destructor function. This function must be defined + unless the type guarantees that its instances will never be deallocated (as is + the case for the singletons ``None`` and ``Ellipsis``). + + The destructor function is called by the :c:func:`Py_DECREF` and + :c:func:`Py_XDECREF` macros when the new reference count is zero. At this point, + the instance is still in existence, but there are no references to it. The + destructor function should free all references which the instance owns, free all + memory buffers owned by the instance (using the freeing function corresponding + to the allocation function used to allocate the buffer), and finally (as its + last action) call the type's :c:member:`~PyTypeObject.tp_free` function. If the type is not + subtypable (doesn't have the :const:`Py_TPFLAGS_BASETYPE` flag bit set), it is + permissible to call the object deallocator directly instead of via + :c:member:`~PyTypeObject.tp_free`. The object deallocator should be the one used to allocate the + instance; this is normally :c:func:`PyObject_Del` if the instance was allocated + using :c:func:`PyObject_New` or :c:func:`PyObject_VarNew`, or + :c:func:`PyObject_GC_Del` if the instance was allocated using + :c:func:`PyObject_GC_New` or :c:func:`PyObject_GC_NewVar`. + + This field is inherited by subtypes. + + +.. c:member:: printfunc PyTypeObject.tp_print + + Reserved slot, formerly used for print formatting in Python 2.x. + + +.. c:member:: getattrfunc PyTypeObject.tp_getattr + + An optional pointer to the get-attribute-string function. + + This field is deprecated. When it is defined, it should point to a function + that acts the same as the :c:member:`~PyTypeObject.tp_getattro` function, but taking a C string + instead of a Python string object to give the attribute name. The signature is :: + + PyObject * tp_getattr(PyObject *o, char *attr_name); + + This field is inherited by subtypes together with :c:member:`~PyTypeObject.tp_getattro`: a subtype + inherits both :c:member:`~PyTypeObject.tp_getattr` and :c:member:`~PyTypeObject.tp_getattro` from its base type when + the subtype's :c:member:`~PyTypeObject.tp_getattr` and :c:member:`~PyTypeObject.tp_getattro` are both *NULL*. + + +.. c:member:: setattrfunc PyTypeObject.tp_setattr + + An optional pointer to the function for setting and deleting attributes. + + This field is deprecated. When it is defined, it should point to a function + that acts the same as the :c:member:`~PyTypeObject.tp_setattro` function, but taking a C string + instead of a Python string object to give the attribute name. The signature is :: + + PyObject * tp_setattr(PyObject *o, char *attr_name, PyObject *v); + + The *v* argument is set to *NULL* to delete the attribute. + This field is inherited by subtypes together with :c:member:`~PyTypeObject.tp_setattro`: a subtype + inherits both :c:member:`~PyTypeObject.tp_setattr` and :c:member:`~PyTypeObject.tp_setattro` from its base type when + the subtype's :c:member:`~PyTypeObject.tp_setattr` and :c:member:`~PyTypeObject.tp_setattro` are both *NULL*. + + +.. c:member:: PyAsyncMethods* tp_as_async + + Pointer to an additional structure that contains fields relevant only to + objects which implement :term:`awaitable` and :term:`asynchronous iterator` + protocols at the C-level. See :ref:`async-structs` for details. + + .. versionadded:: 3.5 + Formerly known as ``tp_compare`` and ``tp_reserved``. + + +.. c:member:: reprfunc PyTypeObject.tp_repr + + .. index:: builtin: repr + + An optional pointer to a function that implements the built-in function + :func:`repr`. + + The signature is the same as for :c:func:`PyObject_Repr`; it must return a string + or a Unicode object. Ideally, this function should return a string that, when + passed to :func:`eval`, given a suitable environment, returns an object with the + same value. If this is not feasible, it should return a string starting with + ``'<'`` and ending with ``'>'`` from which both the type and the value of the + object can be deduced. + + When this field is not set, a string of the form ``<%s object at %p>`` is + returned, where ``%s`` is replaced by the type name, and ``%p`` by the object's + memory address. + + This field is inherited by subtypes. + +.. c:member:: PyNumberMethods* tp_as_number + + Pointer to an additional structure that contains fields relevant only to + objects which implement the number protocol. These fields are documented in + :ref:`number-structs`. + + The :c:member:`~PyTypeObject.tp_as_number` field is not inherited, but the contained fields are + inherited individually. + + +.. c:member:: PySequenceMethods* tp_as_sequence + + Pointer to an additional structure that contains fields relevant only to + objects which implement the sequence protocol. These fields are documented + in :ref:`sequence-structs`. + + The :c:member:`~PyTypeObject.tp_as_sequence` field is not inherited, but the contained fields + are inherited individually. + + +.. c:member:: PyMappingMethods* tp_as_mapping + + Pointer to an additional structure that contains fields relevant only to + objects which implement the mapping protocol. These fields are documented in + :ref:`mapping-structs`. + + The :c:member:`~PyTypeObject.tp_as_mapping` field is not inherited, but the contained fields + are inherited individually. + + +.. c:member:: hashfunc PyTypeObject.tp_hash + + .. index:: builtin: hash + + An optional pointer to a function that implements the built-in function + :func:`hash`. + + The signature is the same as for :c:func:`PyObject_Hash`; it must return a + value of the type Py_hash_t. The value ``-1`` should not be returned as a + normal return value; when an error occurs during the computation of the hash + value, the function should set an exception and return ``-1``. + + This field can be set explicitly to :c:func:`PyObject_HashNotImplemented` to + block inheritance of the hash method from a parent type. This is interpreted + as the equivalent of ``__hash__ = None`` at the Python level, causing + ``isinstance(o, collections.Hashable)`` to correctly return ``False``. Note + that the converse is also true - setting ``__hash__ = None`` on a class at + the Python level will result in the ``tp_hash`` slot being set to + :c:func:`PyObject_HashNotImplemented`. + + When this field is not set, an attempt to take the hash of the + object raises :exc:`TypeError`. + + This field is inherited by subtypes together with + :c:member:`~PyTypeObject.tp_richcompare`: a subtype inherits both of + :c:member:`~PyTypeObject.tp_richcompare` and :c:member:`~PyTypeObject.tp_hash`, when the subtype's + :c:member:`~PyTypeObject.tp_richcompare` and :c:member:`~PyTypeObject.tp_hash` are both *NULL*. + + +.. c:member:: ternaryfunc PyTypeObject.tp_call + + An optional pointer to a function that implements calling the object. This + should be *NULL* if the object is not callable. The signature is the same as + for :c:func:`PyObject_Call`. + + This field is inherited by subtypes. + + +.. c:member:: reprfunc PyTypeObject.tp_str + + An optional pointer to a function that implements the built-in operation + :func:`str`. (Note that :class:`str` is a type now, and :func:`str` calls the + constructor for that type. This constructor calls :c:func:`PyObject_Str` to do + the actual work, and :c:func:`PyObject_Str` will call this handler.) + + The signature is the same as for :c:func:`PyObject_Str`; it must return a string + or a Unicode object. This function should return a "friendly" string + representation of the object, as this is the representation that will be used, + among other things, by the :func:`print` function. + + When this field is not set, :c:func:`PyObject_Repr` is called to return a string + representation. + + This field is inherited by subtypes. + + +.. c:member:: getattrofunc PyTypeObject.tp_getattro + + An optional pointer to the get-attribute function. + + The signature is the same as for :c:func:`PyObject_GetAttr`. It is usually + convenient to set this field to :c:func:`PyObject_GenericGetAttr`, which + implements the normal way of looking for object attributes. + + This field is inherited by subtypes together with :c:member:`~PyTypeObject.tp_getattr`: a subtype + inherits both :c:member:`~PyTypeObject.tp_getattr` and :c:member:`~PyTypeObject.tp_getattro` from its base type when + the subtype's :c:member:`~PyTypeObject.tp_getattr` and :c:member:`~PyTypeObject.tp_getattro` are both *NULL*. + + +.. c:member:: setattrofunc PyTypeObject.tp_setattro + + An optional pointer to the function for setting and deleting attributes. + + The signature is the same as for :c:func:`PyObject_SetAttr`, but setting + *v* to *NULL* to delete an attribute must be supported. It is usually + convenient to set this field to :c:func:`PyObject_GenericSetAttr`, which + implements the normal way of setting object attributes. + + This field is inherited by subtypes together with :c:member:`~PyTypeObject.tp_setattr`: a subtype + inherits both :c:member:`~PyTypeObject.tp_setattr` and :c:member:`~PyTypeObject.tp_setattro` from its base type when + the subtype's :c:member:`~PyTypeObject.tp_setattr` and :c:member:`~PyTypeObject.tp_setattro` are both *NULL*. + + +.. c:member:: PyBufferProcs* PyTypeObject.tp_as_buffer + + Pointer to an additional structure that contains fields relevant only to objects + which implement the buffer interface. These fields are documented in + :ref:`buffer-structs`. + + The :c:member:`~PyTypeObject.tp_as_buffer` field is not inherited, but the contained fields are + inherited individually. + + +.. c:member:: unsigned long PyTypeObject.tp_flags + + This field is a bit mask of various flags. Some flags indicate variant + semantics for certain situations; others are used to indicate that certain + fields in the type object (or in the extension structures referenced via + :c:member:`~PyTypeObject.tp_as_number`, :c:member:`~PyTypeObject.tp_as_sequence`, :c:member:`~PyTypeObject.tp_as_mapping`, and + :c:member:`~PyTypeObject.tp_as_buffer`) that were historically not always present are valid; if + such a flag bit is clear, the type fields it guards must not be accessed and + must be considered to have a zero or *NULL* value instead. + + Inheritance of this field is complicated. Most flag bits are inherited + individually, i.e. if the base type has a flag bit set, the subtype inherits + this flag bit. The flag bits that pertain to extension structures are strictly + inherited if the extension structure is inherited, i.e. the base type's value of + the flag bit is copied into the subtype together with a pointer to the extension + structure. The :const:`Py_TPFLAGS_HAVE_GC` flag bit is inherited together with + the :c:member:`~PyTypeObject.tp_traverse` and :c:member:`~PyTypeObject.tp_clear` fields, i.e. if the + :const:`Py_TPFLAGS_HAVE_GC` flag bit is clear in the subtype and the + :c:member:`~PyTypeObject.tp_traverse` and :c:member:`~PyTypeObject.tp_clear` fields in the subtype exist and have + *NULL* values. + + The following bit masks are currently defined; these can be ORed together using + the ``|`` operator to form the value of the :c:member:`~PyTypeObject.tp_flags` field. The macro + :c:func:`PyType_HasFeature` takes a type and a flags value, *tp* and *f*, and + checks whether ``tp->tp_flags & f`` is non-zero. + + + .. data:: Py_TPFLAGS_HEAPTYPE + + This bit is set when the type object itself is allocated on the heap. In this + case, the :attr:`ob_type` field of its instances is considered a reference to + the type, and the type object is INCREF'ed when a new instance is created, and + DECREF'ed when an instance is destroyed (this does not apply to instances of + subtypes; only the type referenced by the instance's ob_type gets INCREF'ed or + DECREF'ed). + + + .. data:: Py_TPFLAGS_BASETYPE + + This bit is set when the type can be used as the base type of another type. If + this bit is clear, the type cannot be subtyped (similar to a "final" class in + Java). + + + .. data:: Py_TPFLAGS_READY + + This bit is set when the type object has been fully initialized by + :c:func:`PyType_Ready`. + + + .. data:: Py_TPFLAGS_READYING + + This bit is set while :c:func:`PyType_Ready` is in the process of initializing + the type object. + + + .. data:: Py_TPFLAGS_HAVE_GC + + This bit is set when the object supports garbage collection. If this bit + is set, instances must be created using :c:func:`PyObject_GC_New` and + destroyed using :c:func:`PyObject_GC_Del`. More information in section + :ref:`supporting-cycle-detection`. This bit also implies that the + GC-related fields :c:member:`~PyTypeObject.tp_traverse` and :c:member:`~PyTypeObject.tp_clear` are present in + the type object. + + + .. data:: Py_TPFLAGS_DEFAULT + + This is a bitmask of all the bits that pertain to the existence of certain + fields in the type object and its extension structures. Currently, it includes + the following bits: :const:`Py_TPFLAGS_HAVE_STACKLESS_EXTENSION`, + :const:`Py_TPFLAGS_HAVE_VERSION_TAG`. + + + .. data:: Py_TPFLAGS_LONG_SUBCLASS + .. data:: Py_TPFLAGS_LIST_SUBCLASS + .. data:: Py_TPFLAGS_TUPLE_SUBCLASS + .. data:: Py_TPFLAGS_BYTES_SUBCLASS + .. data:: Py_TPFLAGS_UNICODE_SUBCLASS + .. data:: Py_TPFLAGS_DICT_SUBCLASS + .. data:: Py_TPFLAGS_BASE_EXC_SUBCLASS + .. data:: Py_TPFLAGS_TYPE_SUBCLASS + + These flags are used by functions such as + :c:func:`PyLong_Check` to quickly determine if a type is a subclass + of a built-in type; such specific checks are faster than a generic + check, like :c:func:`PyObject_IsInstance`. Custom types that inherit + from built-ins should have their :c:member:`~PyTypeObject.tp_flags` + set appropriately, or the code that interacts with such types + will behave differently depending on what kind of check is used. + + + .. data:: Py_TPFLAGS_HAVE_FINALIZE + + This bit is set when the :c:member:`~PyTypeObject.tp_finalize` slot is present in the + type structure. + + .. versionadded:: 3.4 + + +.. c:member:: const char* PyTypeObject.tp_doc + + An optional pointer to a NUL-terminated C string giving the docstring for this + type object. This is exposed as the :attr:`__doc__` attribute on the type and + instances of the type. + + This field is *not* inherited by subtypes. + + +.. c:member:: traverseproc PyTypeObject.tp_traverse + + An optional pointer to a traversal function for the garbage collector. This is + only used if the :const:`Py_TPFLAGS_HAVE_GC` flag bit is set. More information + about Python's garbage collection scheme can be found in section + :ref:`supporting-cycle-detection`. + + The :c:member:`~PyTypeObject.tp_traverse` pointer is used by the garbage collector to detect + reference cycles. A typical implementation of a :c:member:`~PyTypeObject.tp_traverse` function + simply calls :c:func:`Py_VISIT` on each of the instance's members that are Python + objects. For example, this is function :c:func:`local_traverse` from the + :mod:`_thread` extension module:: + + static int + local_traverse(localobject *self, visitproc visit, void *arg) + { + Py_VISIT(self->args); + Py_VISIT(self->kw); + Py_VISIT(self->dict); + return 0; + } + + Note that :c:func:`Py_VISIT` is called only on those members that can participate + in reference cycles. Although there is also a ``self->key`` member, it can only + be *NULL* or a Python string and therefore cannot be part of a reference cycle. + + On the other hand, even if you know a member can never be part of a cycle, as a + debugging aid you may want to visit it anyway just so the :mod:`gc` module's + :func:`~gc.get_referents` function will include it. + + Note that :c:func:`Py_VISIT` requires the *visit* and *arg* parameters to + :c:func:`local_traverse` to have these specific names; don't name them just + anything. + + This field is inherited by subtypes together with :c:member:`~PyTypeObject.tp_clear` and the + :const:`Py_TPFLAGS_HAVE_GC` flag bit: the flag bit, :c:member:`~PyTypeObject.tp_traverse`, and + :c:member:`~PyTypeObject.tp_clear` are all inherited from the base type if they are all zero in + the subtype. + + +.. c:member:: inquiry PyTypeObject.tp_clear + + An optional pointer to a clear function for the garbage collector. This is only + used if the :const:`Py_TPFLAGS_HAVE_GC` flag bit is set. + + The :c:member:`~PyTypeObject.tp_clear` member function is used to break reference cycles in cyclic + garbage detected by the garbage collector. Taken together, all :c:member:`~PyTypeObject.tp_clear` + functions in the system must combine to break all reference cycles. This is + subtle, and if in any doubt supply a :c:member:`~PyTypeObject.tp_clear` function. For example, + the tuple type does not implement a :c:member:`~PyTypeObject.tp_clear` function, because it's + possible to prove that no reference cycle can be composed entirely of tuples. + Therefore the :c:member:`~PyTypeObject.tp_clear` functions of other types must be sufficient to + break any cycle containing a tuple. This isn't immediately obvious, and there's + rarely a good reason to avoid implementing :c:member:`~PyTypeObject.tp_clear`. + + Implementations of :c:member:`~PyTypeObject.tp_clear` should drop the instance's references to + those of its members that may be Python objects, and set its pointers to those + members to *NULL*, as in the following example:: + + static int + local_clear(localobject *self) + { + Py_CLEAR(self->key); + Py_CLEAR(self->args); + Py_CLEAR(self->kw); + Py_CLEAR(self->dict); + return 0; + } + + The :c:func:`Py_CLEAR` macro should be used, because clearing references is + delicate: the reference to the contained object must not be decremented until + after the pointer to the contained object is set to *NULL*. This is because + decrementing the reference count may cause the contained object to become trash, + triggering a chain of reclamation activity that may include invoking arbitrary + Python code (due to finalizers, or weakref callbacks, associated with the + contained object). If it's possible for such code to reference *self* again, + it's important that the pointer to the contained object be *NULL* at that time, + so that *self* knows the contained object can no longer be used. The + :c:func:`Py_CLEAR` macro performs the operations in a safe order. + + Because the goal of :c:member:`~PyTypeObject.tp_clear` functions is to break reference cycles, + it's not necessary to clear contained objects like Python strings or Python + integers, which can't participate in reference cycles. On the other hand, it may + be convenient to clear all contained Python objects, and write the type's + :c:member:`~PyTypeObject.tp_dealloc` function to invoke :c:member:`~PyTypeObject.tp_clear`. + + More information about Python's garbage collection scheme can be found in + section :ref:`supporting-cycle-detection`. + + This field is inherited by subtypes together with :c:member:`~PyTypeObject.tp_traverse` and the + :const:`Py_TPFLAGS_HAVE_GC` flag bit: the flag bit, :c:member:`~PyTypeObject.tp_traverse`, and + :c:member:`~PyTypeObject.tp_clear` are all inherited from the base type if they are all zero in + the subtype. + + +.. c:member:: richcmpfunc PyTypeObject.tp_richcompare + + An optional pointer to the rich comparison function, whose signature is + ``PyObject *tp_richcompare(PyObject *a, PyObject *b, int op)``. The first + parameter is guaranteed to be an instance of the type that is defined + by :c:type:`PyTypeObject`. + + The function should return the result of the comparison (usually ``Py_True`` + or ``Py_False``). If the comparison is undefined, it must return + ``Py_NotImplemented``, if another error occurred it must return ``NULL`` and + set an exception condition. + + .. note:: + + If you want to implement a type for which only a limited set of + comparisons makes sense (e.g. ``==`` and ``!=``, but not ``<`` and + friends), directly raise :exc:`TypeError` in the rich comparison function. + + This field is inherited by subtypes together with :c:member:`~PyTypeObject.tp_hash`: + a subtype inherits :c:member:`~PyTypeObject.tp_richcompare` and :c:member:`~PyTypeObject.tp_hash` when + the subtype's :c:member:`~PyTypeObject.tp_richcompare` and :c:member:`~PyTypeObject.tp_hash` are both + *NULL*. + + The following constants are defined to be used as the third argument for + :c:member:`~PyTypeObject.tp_richcompare` and for :c:func:`PyObject_RichCompare`: + + +----------------+------------+ + | Constant | Comparison | + +================+============+ + | :const:`Py_LT` | ``<`` | + +----------------+------------+ + | :const:`Py_LE` | ``<=`` | + +----------------+------------+ + | :const:`Py_EQ` | ``==`` | + +----------------+------------+ + | :const:`Py_NE` | ``!=`` | + +----------------+------------+ + | :const:`Py_GT` | ``>`` | + +----------------+------------+ + | :const:`Py_GE` | ``>=`` | + +----------------+------------+ + + The following macro is defined to ease writing rich comparison functions: + + .. c:function:: PyObject *Py_RETURN_RICHCOMPARE(VAL_A, VAL_B, int op) + + Return ``Py_True`` or ``Py_False`` from the function, depending on the + result of a comparison. + VAL_A and VAL_B must be orderable by C comparison operators (for example, + they may be C ints or floats). The third argument specifies the requested + operation, as for :c:func:`PyObject_RichCompare`. + + The return value's reference count is properly incremented. + + On error, sets an exception and returns NULL from the function. + + .. versionadded:: 3.7 + + +.. c:member:: Py_ssize_t PyTypeObject.tp_weaklistoffset + + If the instances of this type are weakly referenceable, this field is greater + than zero and contains the offset in the instance structure of the weak + reference list head (ignoring the GC header, if present); this offset is used by + :c:func:`PyObject_ClearWeakRefs` and the :c:func:`PyWeakref_\*` functions. The + instance structure needs to include a field of type :c:type:`PyObject\*` which is + initialized to *NULL*. + + Do not confuse this field with :c:member:`~PyTypeObject.tp_weaklist`; that is the list head for + weak references to the type object itself. + + This field is inherited by subtypes, but see the rules listed below. A subtype + may override this offset; this means that the subtype uses a different weak + reference list head than the base type. Since the list head is always found via + :c:member:`~PyTypeObject.tp_weaklistoffset`, this should not be a problem. + + When a type defined by a class statement has no :attr:`~object.__slots__` declaration, + and none of its base types are weakly referenceable, the type is made weakly + referenceable by adding a weak reference list head slot to the instance layout + and setting the :c:member:`~PyTypeObject.tp_weaklistoffset` of that slot's offset. + + When a type's :attr:`__slots__` declaration contains a slot named + :attr:`__weakref__`, that slot becomes the weak reference list head for + instances of the type, and the slot's offset is stored in the type's + :c:member:`~PyTypeObject.tp_weaklistoffset`. + + When a type's :attr:`__slots__` declaration does not contain a slot named + :attr:`__weakref__`, the type inherits its :c:member:`~PyTypeObject.tp_weaklistoffset` from its + base type. + +.. c:member:: getiterfunc PyTypeObject.tp_iter + + An optional pointer to a function that returns an iterator for the object. Its + presence normally signals that the instances of this type are iterable (although + sequences may be iterable without this function). + + This function has the same signature as :c:func:`PyObject_GetIter`. + + This field is inherited by subtypes. + + +.. c:member:: iternextfunc PyTypeObject.tp_iternext + + An optional pointer to a function that returns the next item in an iterator. + When the iterator is exhausted, it must return *NULL*; a :exc:`StopIteration` + exception may or may not be set. When another error occurs, it must return + *NULL* too. Its presence signals that the instances of this type are + iterators. + + Iterator types should also define the :c:member:`~PyTypeObject.tp_iter` function, and that + function should return the iterator instance itself (not a new iterator + instance). + + This function has the same signature as :c:func:`PyIter_Next`. + + This field is inherited by subtypes. + + +.. c:member:: struct PyMethodDef* PyTypeObject.tp_methods + + An optional pointer to a static *NULL*-terminated array of :c:type:`PyMethodDef` + structures, declaring regular methods of this type. + + For each entry in the array, an entry is added to the type's dictionary (see + :c:member:`~PyTypeObject.tp_dict` below) containing a method descriptor. + + This field is not inherited by subtypes (methods are inherited through a + different mechanism). + + +.. c:member:: struct PyMemberDef* PyTypeObject.tp_members + + An optional pointer to a static *NULL*-terminated array of :c:type:`PyMemberDef` + structures, declaring regular data members (fields or slots) of instances of + this type. + + For each entry in the array, an entry is added to the type's dictionary (see + :c:member:`~PyTypeObject.tp_dict` below) containing a member descriptor. + + This field is not inherited by subtypes (members are inherited through a + different mechanism). + + +.. c:member:: struct PyGetSetDef* PyTypeObject.tp_getset + + An optional pointer to a static *NULL*-terminated array of :c:type:`PyGetSetDef` + structures, declaring computed attributes of instances of this type. + + For each entry in the array, an entry is added to the type's dictionary (see + :c:member:`~PyTypeObject.tp_dict` below) containing a getset descriptor. + + This field is not inherited by subtypes (computed attributes are inherited + through a different mechanism). + + +.. c:member:: PyTypeObject* PyTypeObject.tp_base + + An optional pointer to a base type from which type properties are inherited. At + this level, only single inheritance is supported; multiple inheritance require + dynamically creating a type object by calling the metatype. + + This field is not inherited by subtypes (obviously), but it defaults to + ``&PyBaseObject_Type`` (which to Python programmers is known as the type + :class:`object`). + + +.. c:member:: PyObject* PyTypeObject.tp_dict + + The type's dictionary is stored here by :c:func:`PyType_Ready`. + + This field should normally be initialized to *NULL* before PyType_Ready is + called; it may also be initialized to a dictionary containing initial attributes + for the type. Once :c:func:`PyType_Ready` has initialized the type, extra + attributes for the type may be added to this dictionary only if they don't + correspond to overloaded operations (like :meth:`__add__`). + + This field is not inherited by subtypes (though the attributes defined in here + are inherited through a different mechanism). + + .. warning:: + + It is not safe to use :c:func:`PyDict_SetItem` on or otherwise modify + :c:member:`~PyTypeObject.tp_dict` with the dictionary C-API. + + +.. c:member:: descrgetfunc PyTypeObject.tp_descr_get + + An optional pointer to a "descriptor get" function. + + The function signature is :: + + PyObject * tp_descr_get(PyObject *self, PyObject *obj, PyObject *type); + + .. XXX explain. + + This field is inherited by subtypes. + + +.. c:member:: descrsetfunc PyTypeObject.tp_descr_set + + An optional pointer to a function for setting and deleting + a descriptor's value. + + The function signature is :: + + int tp_descr_set(PyObject *self, PyObject *obj, PyObject *value); + + The *value* argument is set to *NULL* to delete the value. + This field is inherited by subtypes. + + .. XXX explain. + + +.. c:member:: Py_ssize_t PyTypeObject.tp_dictoffset + + If the instances of this type have a dictionary containing instance variables, + this field is non-zero and contains the offset in the instances of the type of + the instance variable dictionary; this offset is used by + :c:func:`PyObject_GenericGetAttr`. + + Do not confuse this field with :c:member:`~PyTypeObject.tp_dict`; that is the dictionary for + attributes of the type object itself. + + If the value of this field is greater than zero, it specifies the offset from + the start of the instance structure. If the value is less than zero, it + specifies the offset from the *end* of the instance structure. A negative + offset is more expensive to use, and should only be used when the instance + structure contains a variable-length part. This is used for example to add an + instance variable dictionary to subtypes of :class:`str` or :class:`tuple`. Note + that the :c:member:`~PyTypeObject.tp_basicsize` field should account for the dictionary added to + the end in that case, even though the dictionary is not included in the basic + object layout. On a system with a pointer size of 4 bytes, + :c:member:`~PyTypeObject.tp_dictoffset` should be set to ``-4`` to indicate that the dictionary is + at the very end of the structure. + + The real dictionary offset in an instance can be computed from a negative + :c:member:`~PyTypeObject.tp_dictoffset` as follows:: + + dictoffset = tp_basicsize + abs(ob_size)*tp_itemsize + tp_dictoffset + if dictoffset is not aligned on sizeof(void*): + round up to sizeof(void*) + + where :c:member:`~PyTypeObject.tp_basicsize`, :c:member:`~PyTypeObject.tp_itemsize` and :c:member:`~PyTypeObject.tp_dictoffset` are + taken from the type object, and :attr:`ob_size` is taken from the instance. The + absolute value is taken because ints use the sign of :attr:`ob_size` to + store the sign of the number. (There's never a need to do this calculation + yourself; it is done for you by :c:func:`_PyObject_GetDictPtr`.) + + This field is inherited by subtypes, but see the rules listed below. A subtype + may override this offset; this means that the subtype instances store the + dictionary at a difference offset than the base type. Since the dictionary is + always found via :c:member:`~PyTypeObject.tp_dictoffset`, this should not be a problem. + + When a type defined by a class statement has no :attr:`~object.__slots__` declaration, + and none of its base types has an instance variable dictionary, a dictionary + slot is added to the instance layout and the :c:member:`~PyTypeObject.tp_dictoffset` is set to + that slot's offset. + + When a type defined by a class statement has a :attr:`__slots__` declaration, + the type inherits its :c:member:`~PyTypeObject.tp_dictoffset` from its base type. + + (Adding a slot named :attr:`~object.__dict__` to the :attr:`__slots__` declaration does + not have the expected effect, it just causes confusion. Maybe this should be + added as a feature just like :attr:`__weakref__` though.) + + +.. c:member:: initproc PyTypeObject.tp_init + + An optional pointer to an instance initialization function. + + This function corresponds to the :meth:`__init__` method of classes. Like + :meth:`__init__`, it is possible to create an instance without calling + :meth:`__init__`, and it is possible to reinitialize an instance by calling its + :meth:`__init__` method again. + + The function signature is :: + + int tp_init(PyObject *self, PyObject *args, PyObject *kwds) + + The self argument is the instance to be initialized; the *args* and *kwds* + arguments represent positional and keyword arguments of the call to + :meth:`__init__`. + + The :c:member:`~PyTypeObject.tp_init` function, if not *NULL*, is called when an instance is + created normally by calling its type, after the type's :c:member:`~PyTypeObject.tp_new` function + has returned an instance of the type. If the :c:member:`~PyTypeObject.tp_new` function returns an + instance of some other type that is not a subtype of the original type, no + :c:member:`~PyTypeObject.tp_init` function is called; if :c:member:`~PyTypeObject.tp_new` returns an instance of a + subtype of the original type, the subtype's :c:member:`~PyTypeObject.tp_init` is called. + + This field is inherited by subtypes. + + +.. c:member:: allocfunc PyTypeObject.tp_alloc + + An optional pointer to an instance allocation function. + + The function signature is :: + + PyObject *tp_alloc(PyTypeObject *self, Py_ssize_t nitems) + + The purpose of this function is to separate memory allocation from memory + initialization. It should return a pointer to a block of memory of adequate + length for the instance, suitably aligned, and initialized to zeros, but with + :attr:`ob_refcnt` set to ``1`` and :attr:`ob_type` set to the type argument. If + the type's :c:member:`~PyTypeObject.tp_itemsize` is non-zero, the object's :attr:`ob_size` field + should be initialized to *nitems* and the length of the allocated memory block + should be ``tp_basicsize + nitems*tp_itemsize``, rounded up to a multiple of + ``sizeof(void*)``; otherwise, *nitems* is not used and the length of the block + should be :c:member:`~PyTypeObject.tp_basicsize`. + + Do not use this function to do any other instance initialization, not even to + allocate additional memory; that should be done by :c:member:`~PyTypeObject.tp_new`. + + This field is inherited by static subtypes, but not by dynamic subtypes + (subtypes created by a class statement); in the latter, this field is always set + to :c:func:`PyType_GenericAlloc`, to force a standard heap allocation strategy. + That is also the recommended value for statically defined types. + + +.. c:member:: newfunc PyTypeObject.tp_new + + An optional pointer to an instance creation function. + + If this function is *NULL* for a particular type, that type cannot be called to + create new instances; presumably there is some other way to create instances, + like a factory function. + + The function signature is :: + + PyObject *tp_new(PyTypeObject *subtype, PyObject *args, PyObject *kwds) + + The subtype argument is the type of the object being created; the *args* and + *kwds* arguments represent positional and keyword arguments of the call to the + type. Note that subtype doesn't have to equal the type whose :c:member:`~PyTypeObject.tp_new` + function is called; it may be a subtype of that type (but not an unrelated + type). + + The :c:member:`~PyTypeObject.tp_new` function should call ``subtype->tp_alloc(subtype, nitems)`` + to allocate space for the object, and then do only as much further + initialization as is absolutely necessary. Initialization that can safely be + ignored or repeated should be placed in the :c:member:`~PyTypeObject.tp_init` handler. A good + rule of thumb is that for immutable types, all initialization should take place + in :c:member:`~PyTypeObject.tp_new`, while for mutable types, most initialization should be + deferred to :c:member:`~PyTypeObject.tp_init`. + + This field is inherited by subtypes, except it is not inherited by static types + whose :c:member:`~PyTypeObject.tp_base` is *NULL* or ``&PyBaseObject_Type``. + + +.. c:member:: destructor PyTypeObject.tp_free + + An optional pointer to an instance deallocation function. Its signature is + :c:type:`freefunc`:: + + void tp_free(void *) + + An initializer that is compatible with this signature is :c:func:`PyObject_Free`. + + This field is inherited by static subtypes, but not by dynamic subtypes + (subtypes created by a class statement); in the latter, this field is set to a + deallocator suitable to match :c:func:`PyType_GenericAlloc` and the value of the + :const:`Py_TPFLAGS_HAVE_GC` flag bit. + + +.. c:member:: inquiry PyTypeObject.tp_is_gc + + An optional pointer to a function called by the garbage collector. + + The garbage collector needs to know whether a particular object is collectible + or not. Normally, it is sufficient to look at the object's type's + :c:member:`~PyTypeObject.tp_flags` field, and check the :const:`Py_TPFLAGS_HAVE_GC` flag bit. But + some types have a mixture of statically and dynamically allocated instances, and + the statically allocated instances are not collectible. Such types should + define this function; it should return ``1`` for a collectible instance, and + ``0`` for a non-collectible instance. The signature is :: + + int tp_is_gc(PyObject *self) + + (The only example of this are types themselves. The metatype, + :c:data:`PyType_Type`, defines this function to distinguish between statically + and dynamically allocated types.) + + This field is inherited by subtypes. + + +.. c:member:: PyObject* PyTypeObject.tp_bases + + Tuple of base types. + + This is set for types created by a class statement. It should be *NULL* for + statically defined types. + + This field is not inherited. + + +.. c:member:: PyObject* PyTypeObject.tp_mro + + Tuple containing the expanded set of base types, starting with the type itself + and ending with :class:`object`, in Method Resolution Order. + + This field is not inherited; it is calculated fresh by :c:func:`PyType_Ready`. + + +.. c:member:: destructor PyTypeObject.tp_finalize + + An optional pointer to an instance finalization function. Its signature is + :c:type:`destructor`:: + + void tp_finalize(PyObject *) + + If :c:member:`~PyTypeObject.tp_finalize` is set, the interpreter calls it once when + finalizing an instance. It is called either from the garbage + collector (if the instance is part of an isolated reference cycle) or + just before the object is deallocated. Either way, it is guaranteed + to be called before attempting to break reference cycles, ensuring + that it finds the object in a sane state. + + :c:member:`~PyTypeObject.tp_finalize` should not mutate the current exception status; + therefore, a recommended way to write a non-trivial finalizer is:: + + static void + local_finalize(PyObject *self) + { + PyObject *error_type, *error_value, *error_traceback; + + /* Save the current exception, if any. */ + PyErr_Fetch(&error_type, &error_value, &error_traceback); + + /* ... */ + + /* Restore the saved exception. */ + PyErr_Restore(error_type, error_value, error_traceback); + } + + For this field to be taken into account (even through inheritance), + you must also set the :const:`Py_TPFLAGS_HAVE_FINALIZE` flags bit. + + This field is inherited by subtypes. + + .. versionadded:: 3.4 + + .. seealso:: "Safe object finalization" (:pep:`442`) + + +.. c:member:: PyObject* PyTypeObject.tp_cache + + Unused. Not inherited. Internal use only. + + +.. c:member:: PyObject* PyTypeObject.tp_subclasses + + List of weak references to subclasses. Not inherited. Internal use only. + + +.. c:member:: PyObject* PyTypeObject.tp_weaklist + + Weak reference list head, for weak references to this type object. Not + inherited. Internal use only. + +The remaining fields are only defined if the feature test macro +:const:`COUNT_ALLOCS` is defined, and are for internal use only. They are +documented here for completeness. None of these fields are inherited by +subtypes. + + +.. c:member:: Py_ssize_t PyTypeObject.tp_allocs + + Number of allocations. + + +.. c:member:: Py_ssize_t PyTypeObject.tp_frees + + Number of frees. + + +.. c:member:: Py_ssize_t PyTypeObject.tp_maxalloc + + Maximum simultaneously allocated objects. + + +.. c:member:: PyTypeObject* PyTypeObject.tp_next + + Pointer to the next type object with a non-zero :c:member:`~PyTypeObject.tp_allocs` field. + +Also, note that, in a garbage collected Python, tp_dealloc may be called from +any Python thread, not just the thread which created the object (if the object +becomes part of a refcount cycle, that cycle might be collected by a garbage +collection on any thread). This is not a problem for Python API calls, since +the thread on which tp_dealloc is called will own the Global Interpreter Lock +(GIL). However, if the object being destroyed in turn destroys objects from some +other C or C++ library, care should be taken to ensure that destroying those +objects on the thread which called tp_dealloc will not violate any assumptions +of the library. + + +.. _number-structs: + +Number Object Structures +======================== + +.. sectionauthor:: Amaury Forgeot d'Arc + + +.. c:type:: PyNumberMethods + + This structure holds pointers to the functions which an object uses to + implement the number protocol. Each function is used by the function of + similar name documented in the :ref:`number` section. + + Here is the structure definition:: + + typedef struct { + binaryfunc nb_add; + binaryfunc nb_subtract; + binaryfunc nb_multiply; + binaryfunc nb_remainder; + binaryfunc nb_divmod; + ternaryfunc nb_power; + unaryfunc nb_negative; + unaryfunc nb_positive; + unaryfunc nb_absolute; + inquiry nb_bool; + unaryfunc nb_invert; + binaryfunc nb_lshift; + binaryfunc nb_rshift; + binaryfunc nb_and; + binaryfunc nb_xor; + binaryfunc nb_or; + unaryfunc nb_int; + void *nb_reserved; + unaryfunc nb_float; + + binaryfunc nb_inplace_add; + binaryfunc nb_inplace_subtract; + binaryfunc nb_inplace_multiply; + binaryfunc nb_inplace_remainder; + ternaryfunc nb_inplace_power; + binaryfunc nb_inplace_lshift; + binaryfunc nb_inplace_rshift; + binaryfunc nb_inplace_and; + binaryfunc nb_inplace_xor; + binaryfunc nb_inplace_or; + + binaryfunc nb_floor_divide; + binaryfunc nb_true_divide; + binaryfunc nb_inplace_floor_divide; + binaryfunc nb_inplace_true_divide; + + unaryfunc nb_index; + + binaryfunc nb_matrix_multiply; + binaryfunc nb_inplace_matrix_multiply; + } PyNumberMethods; + + .. note:: + + Binary and ternary functions must check the type of all their operands, + and implement the necessary conversions (at least one of the operands is + an instance of the defined type). If the operation is not defined for the + given operands, binary and ternary functions must return + ``Py_NotImplemented``, if another error occurred they must return ``NULL`` + and set an exception. + + .. note:: + + The :c:data:`nb_reserved` field should always be ``NULL``. It + was previously called :c:data:`nb_long`, and was renamed in + Python 3.0.1. + + +.. _mapping-structs: + +Mapping Object Structures +========================= + +.. sectionauthor:: Amaury Forgeot d'Arc + + +.. c:type:: PyMappingMethods + + This structure holds pointers to the functions which an object uses to + implement the mapping protocol. It has three members: + +.. c:member:: lenfunc PyMappingMethods.mp_length + + This function is used by :c:func:`PyMapping_Size` and + :c:func:`PyObject_Size`, and has the same signature. This slot may be set to + *NULL* if the object has no defined length. + +.. c:member:: binaryfunc PyMappingMethods.mp_subscript + + This function is used by :c:func:`PyObject_GetItem` and + :c:func:`PySequence_GetSlice`, and has the same signature as + :c:func:`!PyObject_GetItem`. This slot must be filled for the + :c:func:`PyMapping_Check` function to return ``1``, it can be *NULL* + otherwise. + +.. c:member:: objobjargproc PyMappingMethods.mp_ass_subscript + + This function is used by :c:func:`PyObject_SetItem`, + :c:func:`PyObject_DelItem`, :c:func:`PyObject_SetSlice` and + :c:func:`PyObject_DelSlice`. It has the same signature as + :c:func:`!PyObject_SetItem`, but *v* can also be set to *NULL* to delete + an item. If this slot is *NULL*, the object does not support item + assignment and deletion. + + +.. _sequence-structs: + +Sequence Object Structures +========================== + +.. sectionauthor:: Amaury Forgeot d'Arc + + +.. c:type:: PySequenceMethods + + This structure holds pointers to the functions which an object uses to + implement the sequence protocol. + +.. c:member:: lenfunc PySequenceMethods.sq_length + + This function is used by :c:func:`PySequence_Size` and + :c:func:`PyObject_Size`, and has the same signature. It is also used for + handling negative indices via the :c:member:`~PySequenceMethods.sq_item` + and the :c:member:`~PySequenceMethods.sq_ass_item` slots. + +.. c:member:: binaryfunc PySequenceMethods.sq_concat + + This function is used by :c:func:`PySequence_Concat` and has the same + signature. It is also used by the ``+`` operator, after trying the numeric + addition via the :c:member:`~PyNumberMethods.nb_add` slot. + +.. c:member:: ssizeargfunc PySequenceMethods.sq_repeat + + This function is used by :c:func:`PySequence_Repeat` and has the same + signature. It is also used by the ``*`` operator, after trying numeric + multiplication via the :c:member:`~PyNumberMethods.nb_multiply` slot. + +.. c:member:: ssizeargfunc PySequenceMethods.sq_item + + This function is used by :c:func:`PySequence_GetItem` and has the same + signature. It is also used by :c:func:`PyObject_GetItem`, after trying + the subscription via the :c:member:`~PyMappingMethods.mp_subscript` slot. + This slot must be filled for the :c:func:`PySequence_Check` + function to return ``1``, it can be *NULL* otherwise. + + Negative indexes are handled as follows: if the :attr:`sq_length` slot is + filled, it is called and the sequence length is used to compute a positive + index which is passed to :attr:`sq_item`. If :attr:`sq_length` is *NULL*, + the index is passed as is to the function. + +.. c:member:: ssizeobjargproc PySequenceMethods.sq_ass_item + + This function is used by :c:func:`PySequence_SetItem` and has the same + signature. It is also used by :c:func:`PyObject_SetItem` and + :c:func:`PyObject_DelItem`, after trying the item assignment and deletion + via the :c:member:`~PyMappingMethods.mp_ass_subscript` slot. + This slot may be left to *NULL* if the object does not support + item assignment and deletion. + +.. c:member:: objobjproc PySequenceMethods.sq_contains + + This function may be used by :c:func:`PySequence_Contains` and has the same + signature. This slot may be left to *NULL*, in this case + :c:func:`!PySequence_Contains` simply traverses the sequence until it + finds a match. + +.. c:member:: binaryfunc PySequenceMethods.sq_inplace_concat + + This function is used by :c:func:`PySequence_InPlaceConcat` and has the same + signature. It should modify its first operand, and return it. This slot + may be left to *NULL*, in this case :c:func:`!PySequence_InPlaceConcat` + will fall back to :c:func:`PySequence_Concat`. It is also used by the + augmented assignment ``+=``, after trying numeric in-place addition + via the :c:member:`~PyNumberMethods.nb_inplace_add` slot. + +.. c:member:: ssizeargfunc PySequenceMethods.sq_inplace_repeat + + This function is used by :c:func:`PySequence_InPlaceRepeat` and has the same + signature. It should modify its first operand, and return it. This slot + may be left to *NULL*, in this case :c:func:`!PySequence_InPlaceRepeat` + will fall back to :c:func:`PySequence_Repeat`. It is also used by the + augmented assignment ``*=``, after trying numeric in-place multiplication + via the :c:member:`~PyNumberMethods.nb_inplace_multiply` slot. + + +.. _buffer-structs: + +Buffer Object Structures +======================== + +.. sectionauthor:: Greg J. Stein +.. sectionauthor:: Benjamin Peterson +.. sectionauthor:: Stefan Krah + +.. c:type:: PyBufferProcs + + This structure holds pointers to the functions required by the + :ref:`Buffer protocol `. The protocol defines how + an exporter object can expose its internal data to consumer objects. + +.. c:member:: getbufferproc PyBufferProcs.bf_getbuffer + + The signature of this function is:: + + int (PyObject *exporter, Py_buffer *view, int flags); + + Handle a request to *exporter* to fill in *view* as specified by *flags*. + Except for point (3), an implementation of this function MUST take these + steps: + + (1) Check if the request can be met. If not, raise :c:data:`PyExc_BufferError`, + set :c:data:`view->obj` to *NULL* and return ``-1``. + + (2) Fill in the requested fields. + + (3) Increment an internal counter for the number of exports. + + (4) Set :c:data:`view->obj` to *exporter* and increment :c:data:`view->obj`. + + (5) Return ``0``. + + If *exporter* is part of a chain or tree of buffer providers, two main + schemes can be used: + + * Re-export: Each member of the tree acts as the exporting object and + sets :c:data:`view->obj` to a new reference to itself. + + * Redirect: The buffer request is redirected to the root object of the + tree. Here, :c:data:`view->obj` will be a new reference to the root + object. + + The individual fields of *view* are described in section + :ref:`Buffer structure `, the rules how an exporter + must react to specific requests are in section + :ref:`Buffer request types `. + + All memory pointed to in the :c:type:`Py_buffer` structure belongs to + the exporter and must remain valid until there are no consumers left. + :c:member:`~Py_buffer.format`, :c:member:`~Py_buffer.shape`, + :c:member:`~Py_buffer.strides`, :c:member:`~Py_buffer.suboffsets` + and :c:member:`~Py_buffer.internal` + are read-only for the consumer. + + :c:func:`PyBuffer_FillInfo` provides an easy way of exposing a simple + bytes buffer while dealing correctly with all request types. + + :c:func:`PyObject_GetBuffer` is the interface for the consumer that + wraps this function. + +.. c:member:: releasebufferproc PyBufferProcs.bf_releasebuffer + + The signature of this function is:: + + void (PyObject *exporter, Py_buffer *view); + + Handle a request to release the resources of the buffer. If no resources + need to be released, :c:member:`PyBufferProcs.bf_releasebuffer` may be + *NULL*. Otherwise, a standard implementation of this function will take + these optional steps: + + (1) Decrement an internal counter for the number of exports. + + (2) If the counter is ``0``, free all memory associated with *view*. + + The exporter MUST use the :c:member:`~Py_buffer.internal` field to keep + track of buffer-specific resources. This field is guaranteed to remain + constant, while a consumer MAY pass a copy of the original buffer as the + *view* argument. + + + This function MUST NOT decrement :c:data:`view->obj`, since that is + done automatically in :c:func:`PyBuffer_Release` (this scheme is + useful for breaking reference cycles). + + + :c:func:`PyBuffer_Release` is the interface for the consumer that + wraps this function. + + +.. _async-structs: + + +Async Object Structures +======================= + +.. sectionauthor:: Yury Selivanov + +.. versionadded:: 3.5 + +.. c:type:: PyAsyncMethods + + This structure holds pointers to the functions required to implement + :term:`awaitable` and :term:`asynchronous iterator` objects. + + Here is the structure definition:: + + typedef struct { + unaryfunc am_await; + unaryfunc am_aiter; + unaryfunc am_anext; + } PyAsyncMethods; + +.. c:member:: unaryfunc PyAsyncMethods.am_await + + The signature of this function is:: + + PyObject *am_await(PyObject *self) + + The returned object must be an iterator, i.e. :c:func:`PyIter_Check` must + return ``1`` for it. + + This slot may be set to *NULL* if an object is not an :term:`awaitable`. + +.. c:member:: unaryfunc PyAsyncMethods.am_aiter + + The signature of this function is:: + + PyObject *am_aiter(PyObject *self) + + Must return an :term:`awaitable` object. See :meth:`__anext__` for details. + + This slot may be set to *NULL* if an object does not implement + asynchronous iteration protocol. + +.. c:member:: unaryfunc PyAsyncMethods.am_anext + + The signature of this function is:: + + PyObject *am_anext(PyObject *self) + + Must return an :term:`awaitable` object. See :meth:`__anext__` for details. + This slot may be set to *NULL*. diff --git a/python-3.7.4-docs-html/_sources/c-api/unicode.rst.txt b/python-3.7.4-docs-html/_sources/c-api/unicode.rst.txt new file mode 100644 index 0000000..1d724a3 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/unicode.rst.txt @@ -0,0 +1,1726 @@ +.. highlightlang:: c + +.. _unicodeobjects: + +Unicode Objects and Codecs +-------------------------- + +.. sectionauthor:: Marc-André Lemburg +.. sectionauthor:: Georg Brandl + +Unicode Objects +^^^^^^^^^^^^^^^ + +Since the implementation of :pep:`393` in Python 3.3, Unicode objects internally +use a variety of representations, in order to allow handling the complete range +of Unicode characters while staying memory efficient. There are special cases +for strings where all code points are below 128, 256, or 65536; otherwise, code +points must be below 1114112 (which is the full Unicode range). + +:c:type:`Py_UNICODE*` and UTF-8 representations are created on demand and cached +in the Unicode object. The :c:type:`Py_UNICODE*` representation is deprecated +and inefficient; it should be avoided in performance- or memory-sensitive +situations. + +Due to the transition between the old APIs and the new APIs, Unicode objects +can internally be in two states depending on how they were created: + +* "canonical" Unicode objects are all objects created by a non-deprecated + Unicode API. They use the most efficient representation allowed by the + implementation. + +* "legacy" Unicode objects have been created through one of the deprecated + APIs (typically :c:func:`PyUnicode_FromUnicode`) and only bear the + :c:type:`Py_UNICODE*` representation; you will have to call + :c:func:`PyUnicode_READY` on them before calling any other API. + + +Unicode Type +"""""""""""" + +These are the basic Unicode object types used for the Unicode implementation in +Python: + +.. c:type:: Py_UCS4 + Py_UCS2 + Py_UCS1 + + These types are typedefs for unsigned integer types wide enough to contain + characters of 32 bits, 16 bits and 8 bits, respectively. When dealing with + single Unicode characters, use :c:type:`Py_UCS4`. + + .. versionadded:: 3.3 + + +.. c:type:: Py_UNICODE + + This is a typedef of :c:type:`wchar_t`, which is a 16-bit type or 32-bit type + depending on the platform. + + .. versionchanged:: 3.3 + In previous versions, this was a 16-bit type or a 32-bit type depending on + whether you selected a "narrow" or "wide" Unicode version of Python at + build time. + + +.. c:type:: PyASCIIObject + PyCompactUnicodeObject + PyUnicodeObject + + These subtypes of :c:type:`PyObject` represent a Python Unicode object. In + almost all cases, they shouldn't be used directly, since all API functions + that deal with Unicode objects take and return :c:type:`PyObject` pointers. + + .. versionadded:: 3.3 + + +.. c:var:: PyTypeObject PyUnicode_Type + + This instance of :c:type:`PyTypeObject` represents the Python Unicode type. It + is exposed to Python code as ``str``. + + +The following APIs are really C macros and can be used to do fast checks and to +access internal read-only data of Unicode objects: + +.. c:function:: int PyUnicode_Check(PyObject *o) + + Return true if the object *o* is a Unicode object or an instance of a Unicode + subtype. + + +.. c:function:: int PyUnicode_CheckExact(PyObject *o) + + Return true if the object *o* is a Unicode object, but not an instance of a + subtype. + + +.. c:function:: int PyUnicode_READY(PyObject *o) + + Ensure the string object *o* is in the "canonical" representation. This is + required before using any of the access macros described below. + + .. XXX expand on when it is not required + + Returns ``0`` on success and ``-1`` with an exception set on failure, which in + particular happens if memory allocation fails. + + .. versionadded:: 3.3 + + +.. c:function:: Py_ssize_t PyUnicode_GET_LENGTH(PyObject *o) + + Return the length of the Unicode string, in code points. *o* has to be a + Unicode object in the "canonical" representation (not checked). + + .. versionadded:: 3.3 + + +.. c:function:: Py_UCS1* PyUnicode_1BYTE_DATA(PyObject *o) + Py_UCS2* PyUnicode_2BYTE_DATA(PyObject *o) + Py_UCS4* PyUnicode_4BYTE_DATA(PyObject *o) + + Return a pointer to the canonical representation cast to UCS1, UCS2 or UCS4 + integer types for direct character access. No checks are performed if the + canonical representation has the correct character size; use + :c:func:`PyUnicode_KIND` to select the right macro. Make sure + :c:func:`PyUnicode_READY` has been called before accessing this. + + .. versionadded:: 3.3 + + +.. c:macro:: PyUnicode_WCHAR_KIND + PyUnicode_1BYTE_KIND + PyUnicode_2BYTE_KIND + PyUnicode_4BYTE_KIND + + Return values of the :c:func:`PyUnicode_KIND` macro. + + .. versionadded:: 3.3 + + +.. c:function:: int PyUnicode_KIND(PyObject *o) + + Return one of the PyUnicode kind constants (see above) that indicate how many + bytes per character this Unicode object uses to store its data. *o* has to + be a Unicode object in the "canonical" representation (not checked). + + .. XXX document "0" return value? + + .. versionadded:: 3.3 + + +.. c:function:: void* PyUnicode_DATA(PyObject *o) + + Return a void pointer to the raw Unicode buffer. *o* has to be a Unicode + object in the "canonical" representation (not checked). + + .. versionadded:: 3.3 + + +.. c:function:: void PyUnicode_WRITE(int kind, void *data, Py_ssize_t index, \ + Py_UCS4 value) + + Write into a canonical representation *data* (as obtained with + :c:func:`PyUnicode_DATA`). This macro does not do any sanity checks and is + intended for usage in loops. The caller should cache the *kind* value and + *data* pointer as obtained from other macro calls. *index* is the index in + the string (starts at 0) and *value* is the new code point value which should + be written to that location. + + .. versionadded:: 3.3 + + +.. c:function:: Py_UCS4 PyUnicode_READ(int kind, void *data, Py_ssize_t index) + + Read a code point from a canonical representation *data* (as obtained with + :c:func:`PyUnicode_DATA`). No checks or ready calls are performed. + + .. versionadded:: 3.3 + + +.. c:function:: Py_UCS4 PyUnicode_READ_CHAR(PyObject *o, Py_ssize_t index) + + Read a character from a Unicode object *o*, which must be in the "canonical" + representation. This is less efficient than :c:func:`PyUnicode_READ` if you + do multiple consecutive reads. + + .. versionadded:: 3.3 + + +.. c:function:: PyUnicode_MAX_CHAR_VALUE(PyObject *o) + + Return the maximum code point that is suitable for creating another string + based on *o*, which must be in the "canonical" representation. This is + always an approximation but more efficient than iterating over the string. + + .. versionadded:: 3.3 + + +.. c:function:: int PyUnicode_ClearFreeList() + + Clear the free list. Return the total number of freed items. + + +.. c:function:: Py_ssize_t PyUnicode_GET_SIZE(PyObject *o) + + Return the size of the deprecated :c:type:`Py_UNICODE` representation, in + code units (this includes surrogate pairs as 2 units). *o* has to be a + Unicode object (not checked). + + .. deprecated-removed:: 3.3 4.0 + Part of the old-style Unicode API, please migrate to using + :c:func:`PyUnicode_GET_LENGTH`. + + +.. c:function:: Py_ssize_t PyUnicode_GET_DATA_SIZE(PyObject *o) + + Return the size of the deprecated :c:type:`Py_UNICODE` representation in + bytes. *o* has to be a Unicode object (not checked). + + .. deprecated-removed:: 3.3 4.0 + Part of the old-style Unicode API, please migrate to using + :c:func:`PyUnicode_GET_LENGTH`. + + +.. c:function:: Py_UNICODE* PyUnicode_AS_UNICODE(PyObject *o) + const char* PyUnicode_AS_DATA(PyObject *o) + + Return a pointer to a :c:type:`Py_UNICODE` representation of the object. The + returned buffer is always terminated with an extra null code point. It + may also contain embedded null code points, which would cause the string + to be truncated when used in most C functions. The ``AS_DATA`` form + casts the pointer to :c:type:`const char *`. The *o* argument has to be + a Unicode object (not checked). + + .. versionchanged:: 3.3 + This macro is now inefficient -- because in many cases the + :c:type:`Py_UNICODE` representation does not exist and needs to be created + -- and can fail (return *NULL* with an exception set). Try to port the + code to use the new :c:func:`PyUnicode_nBYTE_DATA` macros or use + :c:func:`PyUnicode_WRITE` or :c:func:`PyUnicode_READ`. + + .. deprecated-removed:: 3.3 4.0 + Part of the old-style Unicode API, please migrate to using the + :c:func:`PyUnicode_nBYTE_DATA` family of macros. + + +Unicode Character Properties +"""""""""""""""""""""""""""" + +Unicode provides many different character properties. The most often needed ones +are available through these macros which are mapped to C functions depending on +the Python configuration. + + +.. c:function:: int Py_UNICODE_ISSPACE(Py_UNICODE ch) + + Return ``1`` or ``0`` depending on whether *ch* is a whitespace character. + + +.. c:function:: int Py_UNICODE_ISLOWER(Py_UNICODE ch) + + Return ``1`` or ``0`` depending on whether *ch* is a lowercase character. + + +.. c:function:: int Py_UNICODE_ISUPPER(Py_UNICODE ch) + + Return ``1`` or ``0`` depending on whether *ch* is an uppercase character. + + +.. c:function:: int Py_UNICODE_ISTITLE(Py_UNICODE ch) + + Return ``1`` or ``0`` depending on whether *ch* is a titlecase character. + + +.. c:function:: int Py_UNICODE_ISLINEBREAK(Py_UNICODE ch) + + Return ``1`` or ``0`` depending on whether *ch* is a linebreak character. + + +.. c:function:: int Py_UNICODE_ISDECIMAL(Py_UNICODE ch) + + Return ``1`` or ``0`` depending on whether *ch* is a decimal character. + + +.. c:function:: int Py_UNICODE_ISDIGIT(Py_UNICODE ch) + + Return ``1`` or ``0`` depending on whether *ch* is a digit character. + + +.. c:function:: int Py_UNICODE_ISNUMERIC(Py_UNICODE ch) + + Return ``1`` or ``0`` depending on whether *ch* is a numeric character. + + +.. c:function:: int Py_UNICODE_ISALPHA(Py_UNICODE ch) + + Return ``1`` or ``0`` depending on whether *ch* is an alphabetic character. + + +.. c:function:: int Py_UNICODE_ISALNUM(Py_UNICODE ch) + + Return ``1`` or ``0`` depending on whether *ch* is an alphanumeric character. + + +.. c:function:: int Py_UNICODE_ISPRINTABLE(Py_UNICODE ch) + + Return ``1`` or ``0`` depending on whether *ch* is a printable character. + Nonprintable characters are those characters defined in the Unicode character + database as "Other" or "Separator", excepting the ASCII space (0x20) which is + considered printable. (Note that printable characters in this context are + those which should not be escaped when :func:`repr` is invoked on a string. + It has no bearing on the handling of strings written to :data:`sys.stdout` or + :data:`sys.stderr`.) + + +These APIs can be used for fast direct character conversions: + + +.. c:function:: Py_UNICODE Py_UNICODE_TOLOWER(Py_UNICODE ch) + + Return the character *ch* converted to lower case. + + .. deprecated:: 3.3 + This function uses simple case mappings. + + +.. c:function:: Py_UNICODE Py_UNICODE_TOUPPER(Py_UNICODE ch) + + Return the character *ch* converted to upper case. + + .. deprecated:: 3.3 + This function uses simple case mappings. + + +.. c:function:: Py_UNICODE Py_UNICODE_TOTITLE(Py_UNICODE ch) + + Return the character *ch* converted to title case. + + .. deprecated:: 3.3 + This function uses simple case mappings. + + +.. c:function:: int Py_UNICODE_TODECIMAL(Py_UNICODE ch) + + Return the character *ch* converted to a decimal positive integer. Return + ``-1`` if this is not possible. This macro does not raise exceptions. + + +.. c:function:: int Py_UNICODE_TODIGIT(Py_UNICODE ch) + + Return the character *ch* converted to a single digit integer. Return ``-1`` if + this is not possible. This macro does not raise exceptions. + + +.. c:function:: double Py_UNICODE_TONUMERIC(Py_UNICODE ch) + + Return the character *ch* converted to a double. Return ``-1.0`` if this is not + possible. This macro does not raise exceptions. + + +These APIs can be used to work with surrogates: + +.. c:macro:: Py_UNICODE_IS_SURROGATE(ch) + + Check if *ch* is a surrogate (``0xD800 <= ch <= 0xDFFF``). + +.. c:macro:: Py_UNICODE_IS_HIGH_SURROGATE(ch) + + Check if *ch* is a high surrogate (``0xD800 <= ch <= 0xDBFF``). + +.. c:macro:: Py_UNICODE_IS_LOW_SURROGATE(ch) + + Check if *ch* is a low surrogate (``0xDC00 <= ch <= 0xDFFF``). + +.. c:macro:: Py_UNICODE_JOIN_SURROGATES(high, low) + + Join two surrogate characters and return a single Py_UCS4 value. + *high* and *low* are respectively the leading and trailing surrogates in a + surrogate pair. + + +Creating and accessing Unicode strings +"""""""""""""""""""""""""""""""""""""" + +To create Unicode objects and access their basic sequence properties, use these +APIs: + +.. c:function:: PyObject* PyUnicode_New(Py_ssize_t size, Py_UCS4 maxchar) + + Create a new Unicode object. *maxchar* should be the true maximum code point + to be placed in the string. As an approximation, it can be rounded up to the + nearest value in the sequence 127, 255, 65535, 1114111. + + This is the recommended way to allocate a new Unicode object. Objects + created using this function are not resizable. + + .. versionadded:: 3.3 + + +.. c:function:: PyObject* PyUnicode_FromKindAndData(int kind, const void *buffer, \ + Py_ssize_t size) + + Create a new Unicode object with the given *kind* (possible values are + :c:macro:`PyUnicode_1BYTE_KIND` etc., as returned by + :c:func:`PyUnicode_KIND`). The *buffer* must point to an array of *size* + units of 1, 2 or 4 bytes per character, as given by the kind. + + .. versionadded:: 3.3 + + +.. c:function:: PyObject* PyUnicode_FromStringAndSize(const char *u, Py_ssize_t size) + + Create a Unicode object from the char buffer *u*. The bytes will be + interpreted as being UTF-8 encoded. The buffer is copied into the new + object. If the buffer is not *NULL*, the return value might be a shared + object, i.e. modification of the data is not allowed. + + If *u* is *NULL*, this function behaves like :c:func:`PyUnicode_FromUnicode` + with the buffer set to *NULL*. This usage is deprecated in favor of + :c:func:`PyUnicode_New`. + + +.. c:function:: PyObject *PyUnicode_FromString(const char *u) + + Create a Unicode object from a UTF-8 encoded null-terminated char buffer + *u*. + + +.. c:function:: PyObject* PyUnicode_FromFormat(const char *format, ...) + + Take a C :c:func:`printf`\ -style *format* string and a variable number of + arguments, calculate the size of the resulting Python Unicode string and return + a string with the values formatted into it. The variable arguments must be C + types and must correspond exactly to the format characters in the *format* + ASCII-encoded string. The following format characters are allowed: + + .. % This should be exactly the same as the table in PyErr_Format. + .. % The descriptions for %zd and %zu are wrong, but the truth is complicated + .. % because not all compilers support the %z width modifier -- we fake it + .. % when necessary via interpolating PY_FORMAT_SIZE_T. + .. % Similar comments apply to the %ll width modifier and + + .. tabularcolumns:: |l|l|L| + + +-------------------+---------------------+--------------------------------+ + | Format Characters | Type | Comment | + +===================+=====================+================================+ + | :attr:`%%` | *n/a* | The literal % character. | + +-------------------+---------------------+--------------------------------+ + | :attr:`%c` | int | A single character, | + | | | represented as a C int. | + +-------------------+---------------------+--------------------------------+ + | :attr:`%d` | int | Equivalent to | + | | | ``printf("%d")``. [1]_ | + +-------------------+---------------------+--------------------------------+ + | :attr:`%u` | unsigned int | Equivalent to | + | | | ``printf("%u")``. [1]_ | + +-------------------+---------------------+--------------------------------+ + | :attr:`%ld` | long | Equivalent to | + | | | ``printf("%ld")``. [1]_ | + +-------------------+---------------------+--------------------------------+ + | :attr:`%li` | long | Equivalent to | + | | | ``printf("%li")``. [1]_ | + +-------------------+---------------------+--------------------------------+ + | :attr:`%lu` | unsigned long | Equivalent to | + | | | ``printf("%lu")``. [1]_ | + +-------------------+---------------------+--------------------------------+ + | :attr:`%lld` | long long | Equivalent to | + | | | ``printf("%lld")``. [1]_ | + +-------------------+---------------------+--------------------------------+ + | :attr:`%lli` | long long | Equivalent to | + | | | ``printf("%lli")``. [1]_ | + +-------------------+---------------------+--------------------------------+ + | :attr:`%llu` | unsigned long long | Equivalent to | + | | | ``printf("%llu")``. [1]_ | + +-------------------+---------------------+--------------------------------+ + | :attr:`%zd` | Py_ssize_t | Equivalent to | + | | | ``printf("%zd")``. [1]_ | + +-------------------+---------------------+--------------------------------+ + | :attr:`%zi` | Py_ssize_t | Equivalent to | + | | | ``printf("%zi")``. [1]_ | + +-------------------+---------------------+--------------------------------+ + | :attr:`%zu` | size_t | Equivalent to | + | | | ``printf("%zu")``. [1]_ | + +-------------------+---------------------+--------------------------------+ + | :attr:`%i` | int | Equivalent to | + | | | ``printf("%i")``. [1]_ | + +-------------------+---------------------+--------------------------------+ + | :attr:`%x` | int | Equivalent to | + | | | ``printf("%x")``. [1]_ | + +-------------------+---------------------+--------------------------------+ + | :attr:`%s` | const char\* | A null-terminated C character | + | | | array. | + +-------------------+---------------------+--------------------------------+ + | :attr:`%p` | const void\* | The hex representation of a C | + | | | pointer. Mostly equivalent to | + | | | ``printf("%p")`` except that | + | | | it is guaranteed to start with | + | | | the literal ``0x`` regardless | + | | | of what the platform's | + | | | ``printf`` yields. | + +-------------------+---------------------+--------------------------------+ + | :attr:`%A` | PyObject\* | The result of calling | + | | | :func:`ascii`. | + +-------------------+---------------------+--------------------------------+ + | :attr:`%U` | PyObject\* | A Unicode object. | + +-------------------+---------------------+--------------------------------+ + | :attr:`%V` | PyObject\*, | A Unicode object (which may be | + | | const char\* | *NULL*) and a null-terminated | + | | | C character array as a second | + | | | parameter (which will be used, | + | | | if the first parameter is | + | | | *NULL*). | + +-------------------+---------------------+--------------------------------+ + | :attr:`%S` | PyObject\* | The result of calling | + | | | :c:func:`PyObject_Str`. | + +-------------------+---------------------+--------------------------------+ + | :attr:`%R` | PyObject\* | The result of calling | + | | | :c:func:`PyObject_Repr`. | + +-------------------+---------------------+--------------------------------+ + + An unrecognized format character causes all the rest of the format string to be + copied as-is to the result string, and any extra arguments discarded. + + .. note:: + The width formatter unit is number of characters rather than bytes. + The precision formatter unit is number of bytes for ``"%s"`` and + ``"%V"`` (if the ``PyObject*`` argument is NULL), and a number of + characters for ``"%A"``, ``"%U"``, ``"%S"``, ``"%R"`` and ``"%V"`` + (if the ``PyObject*`` argument is not NULL). + + .. [1] For integer specifiers (d, u, ld, li, lu, lld, lli, llu, zd, zi, + zu, i, x): the 0-conversion flag has effect even when a precision is given. + + .. versionchanged:: 3.2 + Support for ``"%lld"`` and ``"%llu"`` added. + + .. versionchanged:: 3.3 + Support for ``"%li"``, ``"%lli"`` and ``"%zi"`` added. + + .. versionchanged:: 3.4 + Support width and precision formatter for ``"%s"``, ``"%A"``, ``"%U"``, + ``"%V"``, ``"%S"``, ``"%R"`` added. + + +.. c:function:: PyObject* PyUnicode_FromFormatV(const char *format, va_list vargs) + + Identical to :c:func:`PyUnicode_FromFormat` except that it takes exactly two + arguments. + + +.. c:function:: PyObject* PyUnicode_FromEncodedObject(PyObject *obj, \ + const char *encoding, const char *errors) + + Decode an encoded object *obj* to a Unicode object. + + :class:`bytes`, :class:`bytearray` and other + :term:`bytes-like objects ` + are decoded according to the given *encoding* and using the error handling + defined by *errors*. Both can be *NULL* to have the interface use the default + values (see :ref:`builtincodecs` for details). + + All other objects, including Unicode objects, cause a :exc:`TypeError` to be + set. + + The API returns *NULL* if there was an error. The caller is responsible for + decref'ing the returned objects. + + +.. c:function:: Py_ssize_t PyUnicode_GetLength(PyObject *unicode) + + Return the length of the Unicode object, in code points. + + .. versionadded:: 3.3 + + +.. c:function:: Py_ssize_t PyUnicode_CopyCharacters(PyObject *to, \ + Py_ssize_t to_start, \ + PyObject *from, \ + Py_ssize_t from_start, \ + Py_ssize_t how_many) + + Copy characters from one Unicode object into another. This function performs + character conversion when necessary and falls back to :c:func:`memcpy` if + possible. Returns ``-1`` and sets an exception on error, otherwise returns + the number of copied characters. + + .. versionadded:: 3.3 + + +.. c:function:: Py_ssize_t PyUnicode_Fill(PyObject *unicode, Py_ssize_t start, \ + Py_ssize_t length, Py_UCS4 fill_char) + + Fill a string with a character: write *fill_char* into + ``unicode[start:start+length]``. + + Fail if *fill_char* is bigger than the string maximum character, or if the + string has more than 1 reference. + + Return the number of written character, or return ``-1`` and raise an + exception on error. + + .. versionadded:: 3.3 + + +.. c:function:: int PyUnicode_WriteChar(PyObject *unicode, Py_ssize_t index, \ + Py_UCS4 character) + + Write a character to a string. The string must have been created through + :c:func:`PyUnicode_New`. Since Unicode strings are supposed to be immutable, + the string must not be shared, or have been hashed yet. + + This function checks that *unicode* is a Unicode object, that the index is + not out of bounds, and that the object can be modified safely (i.e. that it + its reference count is one). + + .. versionadded:: 3.3 + + +.. c:function:: Py_UCS4 PyUnicode_ReadChar(PyObject *unicode, Py_ssize_t index) + + Read a character from a string. This function checks that *unicode* is a + Unicode object and the index is not out of bounds, in contrast to the macro + version :c:func:`PyUnicode_READ_CHAR`. + + .. versionadded:: 3.3 + + +.. c:function:: PyObject* PyUnicode_Substring(PyObject *str, Py_ssize_t start, \ + Py_ssize_t end) + + Return a substring of *str*, from character index *start* (included) to + character index *end* (excluded). Negative indices are not supported. + + .. versionadded:: 3.3 + + +.. c:function:: Py_UCS4* PyUnicode_AsUCS4(PyObject *u, Py_UCS4 *buffer, \ + Py_ssize_t buflen, int copy_null) + + Copy the string *u* into a UCS4 buffer, including a null character, if + *copy_null* is set. Returns *NULL* and sets an exception on error (in + particular, a :exc:`SystemError` if *buflen* is smaller than the length of + *u*). *buffer* is returned on success. + + .. versionadded:: 3.3 + + +.. c:function:: Py_UCS4* PyUnicode_AsUCS4Copy(PyObject *u) + + Copy the string *u* into a new UCS4 buffer that is allocated using + :c:func:`PyMem_Malloc`. If this fails, *NULL* is returned with a + :exc:`MemoryError` set. The returned buffer always has an extra + null code point appended. + + .. versionadded:: 3.3 + + +Deprecated Py_UNICODE APIs +"""""""""""""""""""""""""" + +.. deprecated-removed:: 3.3 4.0 + +These API functions are deprecated with the implementation of :pep:`393`. +Extension modules can continue using them, as they will not be removed in Python +3.x, but need to be aware that their use can now cause performance and memory hits. + + +.. c:function:: PyObject* PyUnicode_FromUnicode(const Py_UNICODE *u, Py_ssize_t size) + + Create a Unicode object from the Py_UNICODE buffer *u* of the given size. *u* + may be *NULL* which causes the contents to be undefined. It is the user's + responsibility to fill in the needed data. The buffer is copied into the new + object. + + If the buffer is not *NULL*, the return value might be a shared object. + Therefore, modification of the resulting Unicode object is only allowed when + *u* is *NULL*. + + If the buffer is *NULL*, :c:func:`PyUnicode_READY` must be called once the + string content has been filled before using any of the access macros such as + :c:func:`PyUnicode_KIND`. + + Please migrate to using :c:func:`PyUnicode_FromKindAndData`, + :c:func:`PyUnicode_FromWideChar` or :c:func:`PyUnicode_New`. + + +.. c:function:: Py_UNICODE* PyUnicode_AsUnicode(PyObject *unicode) + + Return a read-only pointer to the Unicode object's internal + :c:type:`Py_UNICODE` buffer, or *NULL* on error. This will create the + :c:type:`Py_UNICODE*` representation of the object if it is not yet + available. The buffer is always terminated with an extra null code point. + Note that the resulting :c:type:`Py_UNICODE` string may also contain + embedded null code points, which would cause the string to be truncated when + used in most C functions. + + Please migrate to using :c:func:`PyUnicode_AsUCS4`, + :c:func:`PyUnicode_AsWideChar`, :c:func:`PyUnicode_ReadChar` or similar new + APIs. + + +.. c:function:: PyObject* PyUnicode_TransformDecimalToASCII(Py_UNICODE *s, Py_ssize_t size) + + Create a Unicode object by replacing all decimal digits in + :c:type:`Py_UNICODE` buffer of the given *size* by ASCII digits 0--9 + according to their decimal value. Return *NULL* if an exception occurs. + + +.. c:function:: Py_UNICODE* PyUnicode_AsUnicodeAndSize(PyObject *unicode, Py_ssize_t *size) + + Like :c:func:`PyUnicode_AsUnicode`, but also saves the :c:func:`Py_UNICODE` + array length (excluding the extra null terminator) in *size*. + Note that the resulting :c:type:`Py_UNICODE*` string + may contain embedded null code points, which would cause the string to be + truncated when used in most C functions. + + .. versionadded:: 3.3 + + +.. c:function:: Py_UNICODE* PyUnicode_AsUnicodeCopy(PyObject *unicode) + + Create a copy of a Unicode string ending with a null code point. Return *NULL* + and raise a :exc:`MemoryError` exception on memory allocation failure, + otherwise return a new allocated buffer (use :c:func:`PyMem_Free` to free + the buffer). Note that the resulting :c:type:`Py_UNICODE*` string may + contain embedded null code points, which would cause the string to be + truncated when used in most C functions. + + .. versionadded:: 3.2 + + Please migrate to using :c:func:`PyUnicode_AsUCS4Copy` or similar new APIs. + + +.. c:function:: Py_ssize_t PyUnicode_GetSize(PyObject *unicode) + + Return the size of the deprecated :c:type:`Py_UNICODE` representation, in + code units (this includes surrogate pairs as 2 units). + + Please migrate to using :c:func:`PyUnicode_GetLength`. + + +.. c:function:: PyObject* PyUnicode_FromObject(PyObject *obj) + + Copy an instance of a Unicode subtype to a new true Unicode object if + necessary. If *obj* is already a true Unicode object (not a subtype), + return the reference with incremented refcount. + + Objects other than Unicode or its subtypes will cause a :exc:`TypeError`. + + +Locale Encoding +""""""""""""""" + +The current locale encoding can be used to decode text from the operating +system. + +.. c:function:: PyObject* PyUnicode_DecodeLocaleAndSize(const char *str, \ + Py_ssize_t len, \ + const char *errors) + + Decode a string from UTF-8 on Android, or from the current locale encoding + on other platforms. The supported + error handlers are ``"strict"`` and ``"surrogateescape"`` + (:pep:`383`). The decoder uses ``"strict"`` error handler if + *errors* is ``NULL``. *str* must end with a null character but + cannot contain embedded null characters. + + Use :c:func:`PyUnicode_DecodeFSDefaultAndSize` to decode a string from + :c:data:`Py_FileSystemDefaultEncoding` (the locale encoding read at + Python startup). + + This function ignores the Python UTF-8 mode. + + .. seealso:: + + The :c:func:`Py_DecodeLocale` function. + + .. versionadded:: 3.3 + + .. versionchanged:: 3.7 + The function now also uses the current locale encoding for the + ``surrogateescape`` error handler, except on Android. Previously, :c:func:`Py_DecodeLocale` + was used for the ``surrogateescape``, and the current locale encoding was + used for ``strict``. + + +.. c:function:: PyObject* PyUnicode_DecodeLocale(const char *str, const char *errors) + + Similar to :c:func:`PyUnicode_DecodeLocaleAndSize`, but compute the string + length using :c:func:`strlen`. + + .. versionadded:: 3.3 + + +.. c:function:: PyObject* PyUnicode_EncodeLocale(PyObject *unicode, const char *errors) + + Encode a Unicode object to UTF-8 on Android, or to the current locale + encoding on other platforms. The + supported error handlers are ``"strict"`` and ``"surrogateescape"`` + (:pep:`383`). The encoder uses ``"strict"`` error handler if + *errors* is ``NULL``. Return a :class:`bytes` object. *unicode* cannot + contain embedded null characters. + + Use :c:func:`PyUnicode_EncodeFSDefault` to encode a string to + :c:data:`Py_FileSystemDefaultEncoding` (the locale encoding read at + Python startup). + + This function ignores the Python UTF-8 mode. + + .. seealso:: + + The :c:func:`Py_EncodeLocale` function. + + .. versionadded:: 3.3 + + .. versionchanged:: 3.7 + The function now also uses the current locale encoding for the + ``surrogateescape`` error handler, except on Android. Previously, + :c:func:`Py_EncodeLocale` + was used for the ``surrogateescape``, and the current locale encoding was + used for ``strict``. + + +File System Encoding +"""""""""""""""""""" + +To encode and decode file names and other environment strings, +:c:data:`Py_FileSystemDefaultEncoding` should be used as the encoding, and +:c:data:`Py_FileSystemDefaultEncodeErrors` should be used as the error handler +(:pep:`383` and :pep:`529`). To encode file names to :class:`bytes` during +argument parsing, the ``"O&"`` converter should be used, passing +:c:func:`PyUnicode_FSConverter` as the conversion function: + +.. c:function:: int PyUnicode_FSConverter(PyObject* obj, void* result) + + ParseTuple converter: encode :class:`str` objects -- obtained directly or + through the :class:`os.PathLike` interface -- to :class:`bytes` using + :c:func:`PyUnicode_EncodeFSDefault`; :class:`bytes` objects are output as-is. + *result* must be a :c:type:`PyBytesObject*` which must be released when it is + no longer used. + + .. versionadded:: 3.1 + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + +To decode file names to :class:`str` during argument parsing, the ``"O&"`` +converter should be used, passing :c:func:`PyUnicode_FSDecoder` as the +conversion function: + +.. c:function:: int PyUnicode_FSDecoder(PyObject* obj, void* result) + + ParseTuple converter: decode :class:`bytes` objects -- obtained either + directly or indirectly through the :class:`os.PathLike` interface -- to + :class:`str` using :c:func:`PyUnicode_DecodeFSDefaultAndSize`; :class:`str` + objects are output as-is. *result* must be a :c:type:`PyUnicodeObject*` which + must be released when it is no longer used. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. c:function:: PyObject* PyUnicode_DecodeFSDefaultAndSize(const char *s, Py_ssize_t size) + + Decode a string using :c:data:`Py_FileSystemDefaultEncoding` and the + :c:data:`Py_FileSystemDefaultEncodeErrors` error handler. + + If :c:data:`Py_FileSystemDefaultEncoding` is not set, fall back to the + locale encoding. + + :c:data:`Py_FileSystemDefaultEncoding` is initialized at startup from the + locale encoding and cannot be modified later. If you need to decode a string + from the current locale encoding, use + :c:func:`PyUnicode_DecodeLocaleAndSize`. + + .. seealso:: + + The :c:func:`Py_DecodeLocale` function. + + .. versionchanged:: 3.6 + Use :c:data:`Py_FileSystemDefaultEncodeErrors` error handler. + + +.. c:function:: PyObject* PyUnicode_DecodeFSDefault(const char *s) + + Decode a null-terminated string using :c:data:`Py_FileSystemDefaultEncoding` + and the :c:data:`Py_FileSystemDefaultEncodeErrors` error handler. + + If :c:data:`Py_FileSystemDefaultEncoding` is not set, fall back to the + locale encoding. + + Use :c:func:`PyUnicode_DecodeFSDefaultAndSize` if you know the string length. + + .. versionchanged:: 3.6 + Use :c:data:`Py_FileSystemDefaultEncodeErrors` error handler. + + +.. c:function:: PyObject* PyUnicode_EncodeFSDefault(PyObject *unicode) + + Encode a Unicode object to :c:data:`Py_FileSystemDefaultEncoding` with the + :c:data:`Py_FileSystemDefaultEncodeErrors` error handler, and return + :class:`bytes`. Note that the resulting :class:`bytes` object may contain + null bytes. + + If :c:data:`Py_FileSystemDefaultEncoding` is not set, fall back to the + locale encoding. + + :c:data:`Py_FileSystemDefaultEncoding` is initialized at startup from the + locale encoding and cannot be modified later. If you need to encode a string + to the current locale encoding, use :c:func:`PyUnicode_EncodeLocale`. + + .. seealso:: + + The :c:func:`Py_EncodeLocale` function. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.6 + Use :c:data:`Py_FileSystemDefaultEncodeErrors` error handler. + +wchar_t Support +""""""""""""""" + +:c:type:`wchar_t` support for platforms which support it: + +.. c:function:: PyObject* PyUnicode_FromWideChar(const wchar_t *w, Py_ssize_t size) + + Create a Unicode object from the :c:type:`wchar_t` buffer *w* of the given *size*. + Passing ``-1`` as the *size* indicates that the function must itself compute the length, + using wcslen. + Return *NULL* on failure. + + +.. c:function:: Py_ssize_t PyUnicode_AsWideChar(PyObject *unicode, wchar_t *w, Py_ssize_t size) + + Copy the Unicode object contents into the :c:type:`wchar_t` buffer *w*. At most + *size* :c:type:`wchar_t` characters are copied (excluding a possibly trailing + null termination character). Return the number of :c:type:`wchar_t` characters + copied or ``-1`` in case of an error. Note that the resulting :c:type:`wchar_t*` + string may or may not be null-terminated. It is the responsibility of the caller + to make sure that the :c:type:`wchar_t*` string is null-terminated in case this is + required by the application. Also, note that the :c:type:`wchar_t*` string + might contain null characters, which would cause the string to be truncated + when used with most C functions. + + +.. c:function:: wchar_t* PyUnicode_AsWideCharString(PyObject *unicode, Py_ssize_t *size) + + Convert the Unicode object to a wide character string. The output string + always ends with a null character. If *size* is not *NULL*, write the number + of wide characters (excluding the trailing null termination character) into + *\*size*. Note that the resulting :c:type:`wchar_t` string might contain + null characters, which would cause the string to be truncated when used with + most C functions. If *size* is *NULL* and the :c:type:`wchar_t*` string + contains null characters a :exc:`ValueError` is raised. + + Returns a buffer allocated by :c:func:`PyMem_Alloc` (use + :c:func:`PyMem_Free` to free it) on success. On error, returns *NULL* + and *\*size* is undefined. Raises a :exc:`MemoryError` if memory allocation + is failed. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.7 + Raises a :exc:`ValueError` if *size* is *NULL* and the :c:type:`wchar_t*` + string contains null characters. + + +.. _builtincodecs: + +Built-in Codecs +^^^^^^^^^^^^^^^ + +Python provides a set of built-in codecs which are written in C for speed. All of +these codecs are directly usable via the following functions. + +Many of the following APIs take two arguments encoding and errors, and they +have the same semantics as the ones of the built-in :func:`str` string object +constructor. + +Setting encoding to *NULL* causes the default encoding to be used +which is ASCII. The file system calls should use +:c:func:`PyUnicode_FSConverter` for encoding file names. This uses the +variable :c:data:`Py_FileSystemDefaultEncoding` internally. This +variable should be treated as read-only: on some systems, it will be a +pointer to a static string, on others, it will change at run-time +(such as when the application invokes setlocale). + +Error handling is set by errors which may also be set to *NULL* meaning to use +the default handling defined for the codec. Default error handling for all +built-in codecs is "strict" (:exc:`ValueError` is raised). + +The codecs all use a similar interface. Only deviation from the following +generic ones are documented for simplicity. + + +Generic Codecs +"""""""""""""" + +These are the generic codec APIs: + + +.. c:function:: PyObject* PyUnicode_Decode(const char *s, Py_ssize_t size, \ + const char *encoding, const char *errors) + + Create a Unicode object by decoding *size* bytes of the encoded string *s*. + *encoding* and *errors* have the same meaning as the parameters of the same name + in the :func:`str` built-in function. The codec to be used is looked up + using the Python codec registry. Return *NULL* if an exception was raised by + the codec. + + +.. c:function:: PyObject* PyUnicode_AsEncodedString(PyObject *unicode, \ + const char *encoding, const char *errors) + + Encode a Unicode object and return the result as Python bytes object. + *encoding* and *errors* have the same meaning as the parameters of the same + name in the Unicode :meth:`~str.encode` method. The codec to be used is looked up + using the Python codec registry. Return *NULL* if an exception was raised by + the codec. + + +.. c:function:: PyObject* PyUnicode_Encode(const Py_UNICODE *s, Py_ssize_t size, \ + const char *encoding, const char *errors) + + Encode the :c:type:`Py_UNICODE` buffer *s* of the given *size* and return a Python + bytes object. *encoding* and *errors* have the same meaning as the + parameters of the same name in the Unicode :meth:`~str.encode` method. The codec + to be used is looked up using the Python codec registry. Return *NULL* if an + exception was raised by the codec. + + .. deprecated-removed:: 3.3 4.0 + Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using + :c:func:`PyUnicode_AsEncodedString`. + + +UTF-8 Codecs +"""""""""""" + +These are the UTF-8 codec APIs: + + +.. c:function:: PyObject* PyUnicode_DecodeUTF8(const char *s, Py_ssize_t size, const char *errors) + + Create a Unicode object by decoding *size* bytes of the UTF-8 encoded string + *s*. Return *NULL* if an exception was raised by the codec. + + +.. c:function:: PyObject* PyUnicode_DecodeUTF8Stateful(const char *s, Py_ssize_t size, \ + const char *errors, Py_ssize_t *consumed) + + If *consumed* is *NULL*, behave like :c:func:`PyUnicode_DecodeUTF8`. If + *consumed* is not *NULL*, trailing incomplete UTF-8 byte sequences will not be + treated as an error. Those bytes will not be decoded and the number of bytes + that have been decoded will be stored in *consumed*. + + +.. c:function:: PyObject* PyUnicode_AsUTF8String(PyObject *unicode) + + Encode a Unicode object using UTF-8 and return the result as Python bytes + object. Error handling is "strict". Return *NULL* if an exception was + raised by the codec. + + +.. c:function:: const char* PyUnicode_AsUTF8AndSize(PyObject *unicode, Py_ssize_t *size) + + Return a pointer to the UTF-8 encoding of the Unicode object, and + store the size of the encoded representation (in bytes) in *size*. The + *size* argument can be *NULL*; in this case no size will be stored. The + returned buffer always has an extra null byte appended (not included in + *size*), regardless of whether there are any other null code points. + + In the case of an error, *NULL* is returned with an exception set and no + *size* is stored. + + This caches the UTF-8 representation of the string in the Unicode object, and + subsequent calls will return a pointer to the same buffer. The caller is not + responsible for deallocating the buffer. + + .. versionadded:: 3.3 + + .. versionchanged:: 3.7 + The return type is now ``const char *`` rather of ``char *``. + + +.. c:function:: const char* PyUnicode_AsUTF8(PyObject *unicode) + + As :c:func:`PyUnicode_AsUTF8AndSize`, but does not store the size. + + .. versionadded:: 3.3 + + .. versionchanged:: 3.7 + The return type is now ``const char *`` rather of ``char *``. + + +.. c:function:: PyObject* PyUnicode_EncodeUTF8(const Py_UNICODE *s, Py_ssize_t size, const char *errors) + + Encode the :c:type:`Py_UNICODE` buffer *s* of the given *size* using UTF-8 and + return a Python bytes object. Return *NULL* if an exception was raised by + the codec. + + .. deprecated-removed:: 3.3 4.0 + Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using + :c:func:`PyUnicode_AsUTF8String`, :c:func:`PyUnicode_AsUTF8AndSize` or + :c:func:`PyUnicode_AsEncodedString`. + + +UTF-32 Codecs +""""""""""""" + +These are the UTF-32 codec APIs: + + +.. c:function:: PyObject* PyUnicode_DecodeUTF32(const char *s, Py_ssize_t size, \ + const char *errors, int *byteorder) + + Decode *size* bytes from a UTF-32 encoded buffer string and return the + corresponding Unicode object. *errors* (if non-*NULL*) defines the error + handling. It defaults to "strict". + + If *byteorder* is non-*NULL*, the decoder starts decoding using the given byte + order:: + + *byteorder == -1: little endian + *byteorder == 0: native order + *byteorder == 1: big endian + + If ``*byteorder`` is zero, and the first four bytes of the input data are a + byte order mark (BOM), the decoder switches to this byte order and the BOM is + not copied into the resulting Unicode string. If ``*byteorder`` is ``-1`` or + ``1``, any byte order mark is copied to the output. + + After completion, *\*byteorder* is set to the current byte order at the end + of input data. + + If *byteorder* is *NULL*, the codec starts in native order mode. + + Return *NULL* if an exception was raised by the codec. + + +.. c:function:: PyObject* PyUnicode_DecodeUTF32Stateful(const char *s, Py_ssize_t size, \ + const char *errors, int *byteorder, Py_ssize_t *consumed) + + If *consumed* is *NULL*, behave like :c:func:`PyUnicode_DecodeUTF32`. If + *consumed* is not *NULL*, :c:func:`PyUnicode_DecodeUTF32Stateful` will not treat + trailing incomplete UTF-32 byte sequences (such as a number of bytes not divisible + by four) as an error. Those bytes will not be decoded and the number of bytes + that have been decoded will be stored in *consumed*. + + +.. c:function:: PyObject* PyUnicode_AsUTF32String(PyObject *unicode) + + Return a Python byte string using the UTF-32 encoding in native byte + order. The string always starts with a BOM mark. Error handling is "strict". + Return *NULL* if an exception was raised by the codec. + + +.. c:function:: PyObject* PyUnicode_EncodeUTF32(const Py_UNICODE *s, Py_ssize_t size, \ + const char *errors, int byteorder) + + Return a Python bytes object holding the UTF-32 encoded value of the Unicode + data in *s*. Output is written according to the following byte order:: + + byteorder == -1: little endian + byteorder == 0: native byte order (writes a BOM mark) + byteorder == 1: big endian + + If byteorder is ``0``, the output string will always start with the Unicode BOM + mark (U+FEFF). In the other two modes, no BOM mark is prepended. + + If *Py_UNICODE_WIDE* is not defined, surrogate pairs will be output + as a single code point. + + Return *NULL* if an exception was raised by the codec. + + .. deprecated-removed:: 3.3 4.0 + Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using + :c:func:`PyUnicode_AsUTF32String` or :c:func:`PyUnicode_AsEncodedString`. + + +UTF-16 Codecs +""""""""""""" + +These are the UTF-16 codec APIs: + + +.. c:function:: PyObject* PyUnicode_DecodeUTF16(const char *s, Py_ssize_t size, \ + const char *errors, int *byteorder) + + Decode *size* bytes from a UTF-16 encoded buffer string and return the + corresponding Unicode object. *errors* (if non-*NULL*) defines the error + handling. It defaults to "strict". + + If *byteorder* is non-*NULL*, the decoder starts decoding using the given byte + order:: + + *byteorder == -1: little endian + *byteorder == 0: native order + *byteorder == 1: big endian + + If ``*byteorder`` is zero, and the first two bytes of the input data are a + byte order mark (BOM), the decoder switches to this byte order and the BOM is + not copied into the resulting Unicode string. If ``*byteorder`` is ``-1`` or + ``1``, any byte order mark is copied to the output (where it will result in + either a ``\ufeff`` or a ``\ufffe`` character). + + After completion, *\*byteorder* is set to the current byte order at the end + of input data. + + If *byteorder* is *NULL*, the codec starts in native order mode. + + Return *NULL* if an exception was raised by the codec. + + +.. c:function:: PyObject* PyUnicode_DecodeUTF16Stateful(const char *s, Py_ssize_t size, \ + const char *errors, int *byteorder, Py_ssize_t *consumed) + + If *consumed* is *NULL*, behave like :c:func:`PyUnicode_DecodeUTF16`. If + *consumed* is not *NULL*, :c:func:`PyUnicode_DecodeUTF16Stateful` will not treat + trailing incomplete UTF-16 byte sequences (such as an odd number of bytes or a + split surrogate pair) as an error. Those bytes will not be decoded and the + number of bytes that have been decoded will be stored in *consumed*. + + +.. c:function:: PyObject* PyUnicode_AsUTF16String(PyObject *unicode) + + Return a Python byte string using the UTF-16 encoding in native byte + order. The string always starts with a BOM mark. Error handling is "strict". + Return *NULL* if an exception was raised by the codec. + + +.. c:function:: PyObject* PyUnicode_EncodeUTF16(const Py_UNICODE *s, Py_ssize_t size, \ + const char *errors, int byteorder) + + Return a Python bytes object holding the UTF-16 encoded value of the Unicode + data in *s*. Output is written according to the following byte order:: + + byteorder == -1: little endian + byteorder == 0: native byte order (writes a BOM mark) + byteorder == 1: big endian + + If byteorder is ``0``, the output string will always start with the Unicode BOM + mark (U+FEFF). In the other two modes, no BOM mark is prepended. + + If *Py_UNICODE_WIDE* is defined, a single :c:type:`Py_UNICODE` value may get + represented as a surrogate pair. If it is not defined, each :c:type:`Py_UNICODE` + values is interpreted as a UCS-2 character. + + Return *NULL* if an exception was raised by the codec. + + .. deprecated-removed:: 3.3 4.0 + Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using + :c:func:`PyUnicode_AsUTF16String` or :c:func:`PyUnicode_AsEncodedString`. + + +UTF-7 Codecs +"""""""""""" + +These are the UTF-7 codec APIs: + + +.. c:function:: PyObject* PyUnicode_DecodeUTF7(const char *s, Py_ssize_t size, const char *errors) + + Create a Unicode object by decoding *size* bytes of the UTF-7 encoded string + *s*. Return *NULL* if an exception was raised by the codec. + + +.. c:function:: PyObject* PyUnicode_DecodeUTF7Stateful(const char *s, Py_ssize_t size, \ + const char *errors, Py_ssize_t *consumed) + + If *consumed* is *NULL*, behave like :c:func:`PyUnicode_DecodeUTF7`. If + *consumed* is not *NULL*, trailing incomplete UTF-7 base-64 sections will not + be treated as an error. Those bytes will not be decoded and the number of + bytes that have been decoded will be stored in *consumed*. + + +.. c:function:: PyObject* PyUnicode_EncodeUTF7(const Py_UNICODE *s, Py_ssize_t size, \ + int base64SetO, int base64WhiteSpace, const char *errors) + + Encode the :c:type:`Py_UNICODE` buffer of the given size using UTF-7 and + return a Python bytes object. Return *NULL* if an exception was raised by + the codec. + + If *base64SetO* is nonzero, "Set O" (punctuation that has no otherwise + special meaning) will be encoded in base-64. If *base64WhiteSpace* is + nonzero, whitespace will be encoded in base-64. Both are set to zero for the + Python "utf-7" codec. + + .. deprecated-removed:: 3.3 4.0 + Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using + :c:func:`PyUnicode_AsEncodedString`. + + +Unicode-Escape Codecs +""""""""""""""""""""" + +These are the "Unicode Escape" codec APIs: + + +.. c:function:: PyObject* PyUnicode_DecodeUnicodeEscape(const char *s, \ + Py_ssize_t size, const char *errors) + + Create a Unicode object by decoding *size* bytes of the Unicode-Escape encoded + string *s*. Return *NULL* if an exception was raised by the codec. + + +.. c:function:: PyObject* PyUnicode_AsUnicodeEscapeString(PyObject *unicode) + + Encode a Unicode object using Unicode-Escape and return the result as a + bytes object. Error handling is "strict". Return *NULL* if an exception was + raised by the codec. + + +.. c:function:: PyObject* PyUnicode_EncodeUnicodeEscape(const Py_UNICODE *s, Py_ssize_t size) + + Encode the :c:type:`Py_UNICODE` buffer of the given *size* using Unicode-Escape and + return a bytes object. Return *NULL* if an exception was raised by the codec. + + .. deprecated-removed:: 3.3 4.0 + Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using + :c:func:`PyUnicode_AsUnicodeEscapeString`. + + +Raw-Unicode-Escape Codecs +""""""""""""""""""""""""" + +These are the "Raw Unicode Escape" codec APIs: + + +.. c:function:: PyObject* PyUnicode_DecodeRawUnicodeEscape(const char *s, \ + Py_ssize_t size, const char *errors) + + Create a Unicode object by decoding *size* bytes of the Raw-Unicode-Escape + encoded string *s*. Return *NULL* if an exception was raised by the codec. + + +.. c:function:: PyObject* PyUnicode_AsRawUnicodeEscapeString(PyObject *unicode) + + Encode a Unicode object using Raw-Unicode-Escape and return the result as + a bytes object. Error handling is "strict". Return *NULL* if an exception + was raised by the codec. + + +.. c:function:: PyObject* PyUnicode_EncodeRawUnicodeEscape(const Py_UNICODE *s, \ + Py_ssize_t size) + + Encode the :c:type:`Py_UNICODE` buffer of the given *size* using Raw-Unicode-Escape + and return a bytes object. Return *NULL* if an exception was raised by the codec. + + .. deprecated-removed:: 3.3 4.0 + Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using + :c:func:`PyUnicode_AsRawUnicodeEscapeString` or + :c:func:`PyUnicode_AsEncodedString`. + + +Latin-1 Codecs +"""""""""""""" + +These are the Latin-1 codec APIs: Latin-1 corresponds to the first 256 Unicode +ordinals and only these are accepted by the codecs during encoding. + + +.. c:function:: PyObject* PyUnicode_DecodeLatin1(const char *s, Py_ssize_t size, const char *errors) + + Create a Unicode object by decoding *size* bytes of the Latin-1 encoded string + *s*. Return *NULL* if an exception was raised by the codec. + + +.. c:function:: PyObject* PyUnicode_AsLatin1String(PyObject *unicode) + + Encode a Unicode object using Latin-1 and return the result as Python bytes + object. Error handling is "strict". Return *NULL* if an exception was + raised by the codec. + + +.. c:function:: PyObject* PyUnicode_EncodeLatin1(const Py_UNICODE *s, Py_ssize_t size, const char *errors) + + Encode the :c:type:`Py_UNICODE` buffer of the given *size* using Latin-1 and + return a Python bytes object. Return *NULL* if an exception was raised by + the codec. + + .. deprecated-removed:: 3.3 4.0 + Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using + :c:func:`PyUnicode_AsLatin1String` or + :c:func:`PyUnicode_AsEncodedString`. + + +ASCII Codecs +"""""""""""" + +These are the ASCII codec APIs. Only 7-bit ASCII data is accepted. All other +codes generate errors. + + +.. c:function:: PyObject* PyUnicode_DecodeASCII(const char *s, Py_ssize_t size, const char *errors) + + Create a Unicode object by decoding *size* bytes of the ASCII encoded string + *s*. Return *NULL* if an exception was raised by the codec. + + +.. c:function:: PyObject* PyUnicode_AsASCIIString(PyObject *unicode) + + Encode a Unicode object using ASCII and return the result as Python bytes + object. Error handling is "strict". Return *NULL* if an exception was + raised by the codec. + + +.. c:function:: PyObject* PyUnicode_EncodeASCII(const Py_UNICODE *s, Py_ssize_t size, const char *errors) + + Encode the :c:type:`Py_UNICODE` buffer of the given *size* using ASCII and + return a Python bytes object. Return *NULL* if an exception was raised by + the codec. + + .. deprecated-removed:: 3.3 4.0 + Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using + :c:func:`PyUnicode_AsASCIIString` or + :c:func:`PyUnicode_AsEncodedString`. + + +Character Map Codecs +"""""""""""""""""""" + +This codec is special in that it can be used to implement many different codecs +(and this is in fact what was done to obtain most of the standard codecs +included in the :mod:`encodings` package). The codec uses mapping to encode and +decode characters. The mapping objects provided must support the +:meth:`__getitem__` mapping interface; dictionaries and sequences work well. + +These are the mapping codec APIs: + +.. c:function:: PyObject* PyUnicode_DecodeCharmap(const char *data, Py_ssize_t size, \ + PyObject *mapping, const char *errors) + + Create a Unicode object by decoding *size* bytes of the encoded string *s* + using the given *mapping* object. Return *NULL* if an exception was raised + by the codec. + + If *mapping* is *NULL*, Latin-1 decoding will be applied. Else + *mapping* must map bytes ordinals (integers in the range from 0 to 255) + to Unicode strings, integers (which are then interpreted as Unicode + ordinals) or ``None``. Unmapped data bytes -- ones which cause a + :exc:`LookupError`, as well as ones which get mapped to ``None``, + ``0xFFFE`` or ``'\ufffe'``, are treated as undefined mappings and cause + an error. + + +.. c:function:: PyObject* PyUnicode_AsCharmapString(PyObject *unicode, PyObject *mapping) + + Encode a Unicode object using the given *mapping* object and return the + result as a bytes object. Error handling is "strict". Return *NULL* if an + exception was raised by the codec. + + The *mapping* object must map Unicode ordinal integers to bytes objects, + integers in the range from 0 to 255 or ``None``. Unmapped character + ordinals (ones which cause a :exc:`LookupError`) as well as mapped to + ``None`` are treated as "undefined mapping" and cause an error. + + +.. c:function:: PyObject* PyUnicode_EncodeCharmap(const Py_UNICODE *s, Py_ssize_t size, \ + PyObject *mapping, const char *errors) + + Encode the :c:type:`Py_UNICODE` buffer of the given *size* using the given + *mapping* object and return the result as a bytes object. Return *NULL* if + an exception was raised by the codec. + + .. deprecated-removed:: 3.3 4.0 + Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using + :c:func:`PyUnicode_AsCharmapString` or + :c:func:`PyUnicode_AsEncodedString`. + + +The following codec API is special in that maps Unicode to Unicode. + +.. c:function:: PyObject* PyUnicode_Translate(PyObject *unicode, \ + PyObject *mapping, const char *errors) + + Translate a Unicode object using the given *mapping* object and return the + resulting Unicode object. Return *NULL* if an exception was raised by the + codec. + + The *mapping* object must map Unicode ordinal integers to Unicode strings, + integers (which are then interpreted as Unicode ordinals) or ``None`` + (causing deletion of the character). Unmapped character ordinals (ones + which cause a :exc:`LookupError`) are left untouched and are copied as-is. + + +.. c:function:: PyObject* PyUnicode_TranslateCharmap(const Py_UNICODE *s, Py_ssize_t size, \ + PyObject *mapping, const char *errors) + + Translate a :c:type:`Py_UNICODE` buffer of the given *size* by applying a + character *mapping* table to it and return the resulting Unicode object. + Return *NULL* when an exception was raised by the codec. + + .. deprecated-removed:: 3.3 4.0 + Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using + :c:func:`PyUnicode_Translate`. or :ref:`generic codec based API + ` + + +MBCS codecs for Windows +""""""""""""""""""""""" + +These are the MBCS codec APIs. They are currently only available on Windows and +use the Win32 MBCS converters to implement the conversions. Note that MBCS (or +DBCS) is a class of encodings, not just one. The target encoding is defined by +the user settings on the machine running the codec. + +.. c:function:: PyObject* PyUnicode_DecodeMBCS(const char *s, Py_ssize_t size, const char *errors) + + Create a Unicode object by decoding *size* bytes of the MBCS encoded string *s*. + Return *NULL* if an exception was raised by the codec. + + +.. c:function:: PyObject* PyUnicode_DecodeMBCSStateful(const char *s, Py_ssize_t size, \ + const char *errors, Py_ssize_t *consumed) + + If *consumed* is *NULL*, behave like :c:func:`PyUnicode_DecodeMBCS`. If + *consumed* is not *NULL*, :c:func:`PyUnicode_DecodeMBCSStateful` will not decode + trailing lead byte and the number of bytes that have been decoded will be stored + in *consumed*. + + +.. c:function:: PyObject* PyUnicode_AsMBCSString(PyObject *unicode) + + Encode a Unicode object using MBCS and return the result as Python bytes + object. Error handling is "strict". Return *NULL* if an exception was + raised by the codec. + + +.. c:function:: PyObject* PyUnicode_EncodeCodePage(int code_page, PyObject *unicode, const char *errors) + + Encode the Unicode object using the specified code page and return a Python + bytes object. Return *NULL* if an exception was raised by the codec. Use + :c:data:`CP_ACP` code page to get the MBCS encoder. + + .. versionadded:: 3.3 + + +.. c:function:: PyObject* PyUnicode_EncodeMBCS(const Py_UNICODE *s, Py_ssize_t size, const char *errors) + + Encode the :c:type:`Py_UNICODE` buffer of the given *size* using MBCS and return + a Python bytes object. Return *NULL* if an exception was raised by the + codec. + + .. deprecated-removed:: 3.3 4.0 + Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using + :c:func:`PyUnicode_AsMBCSString`, :c:func:`PyUnicode_EncodeCodePage` or + :c:func:`PyUnicode_AsEncodedString`. + + +Methods & Slots +""""""""""""""" + + +.. _unicodemethodsandslots: + +Methods and Slot Functions +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following APIs are capable of handling Unicode objects and strings on input +(we refer to them as strings in the descriptions) and return Unicode objects or +integers as appropriate. + +They all return *NULL* or ``-1`` if an exception occurs. + + +.. c:function:: PyObject* PyUnicode_Concat(PyObject *left, PyObject *right) + + Concat two strings giving a new Unicode string. + + +.. c:function:: PyObject* PyUnicode_Split(PyObject *s, PyObject *sep, Py_ssize_t maxsplit) + + Split a string giving a list of Unicode strings. If *sep* is *NULL*, splitting + will be done at all whitespace substrings. Otherwise, splits occur at the given + separator. At most *maxsplit* splits will be done. If negative, no limit is + set. Separators are not included in the resulting list. + + +.. c:function:: PyObject* PyUnicode_Splitlines(PyObject *s, int keepend) + + Split a Unicode string at line breaks, returning a list of Unicode strings. + CRLF is considered to be one line break. If *keepend* is ``0``, the Line break + characters are not included in the resulting strings. + + +.. c:function:: PyObject* PyUnicode_Translate(PyObject *str, PyObject *table, \ + const char *errors) + + Translate a string by applying a character mapping table to it and return the + resulting Unicode object. + + The mapping table must map Unicode ordinal integers to Unicode ordinal integers + or ``None`` (causing deletion of the character). + + Mapping tables need only provide the :meth:`__getitem__` interface; dictionaries + and sequences work well. Unmapped character ordinals (ones which cause a + :exc:`LookupError`) are left untouched and are copied as-is. + + *errors* has the usual meaning for codecs. It may be *NULL* which indicates to + use the default error handling. + + +.. c:function:: PyObject* PyUnicode_Join(PyObject *separator, PyObject *seq) + + Join a sequence of strings using the given *separator* and return the resulting + Unicode string. + + +.. c:function:: Py_ssize_t PyUnicode_Tailmatch(PyObject *str, PyObject *substr, \ + Py_ssize_t start, Py_ssize_t end, int direction) + + Return ``1`` if *substr* matches ``str[start:end]`` at the given tail end + (*direction* == ``-1`` means to do a prefix match, *direction* == ``1`` a suffix match), + ``0`` otherwise. Return ``-1`` if an error occurred. + + +.. c:function:: Py_ssize_t PyUnicode_Find(PyObject *str, PyObject *substr, \ + Py_ssize_t start, Py_ssize_t end, int direction) + + Return the first position of *substr* in ``str[start:end]`` using the given + *direction* (*direction* == ``1`` means to do a forward search, *direction* == ``-1`` a + backward search). The return value is the index of the first match; a value of + ``-1`` indicates that no match was found, and ``-2`` indicates that an error + occurred and an exception has been set. + + +.. c:function:: Py_ssize_t PyUnicode_FindChar(PyObject *str, Py_UCS4 ch, \ + Py_ssize_t start, Py_ssize_t end, int direction) + + Return the first position of the character *ch* in ``str[start:end]`` using + the given *direction* (*direction* == ``1`` means to do a forward search, + *direction* == ``-1`` a backward search). The return value is the index of the + first match; a value of ``-1`` indicates that no match was found, and ``-2`` + indicates that an error occurred and an exception has been set. + + .. versionadded:: 3.3 + + .. versionchanged:: 3.7 + *start* and *end* are now adjusted to behave like ``str[start:end]``. + + +.. c:function:: Py_ssize_t PyUnicode_Count(PyObject *str, PyObject *substr, \ + Py_ssize_t start, Py_ssize_t end) + + Return the number of non-overlapping occurrences of *substr* in + ``str[start:end]``. Return ``-1`` if an error occurred. + + +.. c:function:: PyObject* PyUnicode_Replace(PyObject *str, PyObject *substr, \ + PyObject *replstr, Py_ssize_t maxcount) + + Replace at most *maxcount* occurrences of *substr* in *str* with *replstr* and + return the resulting Unicode object. *maxcount* == ``-1`` means replace all + occurrences. + + +.. c:function:: int PyUnicode_Compare(PyObject *left, PyObject *right) + + Compare two strings and return ``-1``, ``0``, ``1`` for less than, equal, and greater than, + respectively. + + This function returns ``-1`` upon failure, so one should call + :c:func:`PyErr_Occurred` to check for errors. + + +.. c:function:: int PyUnicode_CompareWithASCIIString(PyObject *uni, const char *string) + + Compare a Unicode object, *uni*, with *string* and return ``-1``, ``0``, ``1`` for less + than, equal, and greater than, respectively. It is best to pass only + ASCII-encoded strings, but the function interprets the input string as + ISO-8859-1 if it contains non-ASCII characters. + + This function does not raise exceptions. + + +.. c:function:: PyObject* PyUnicode_RichCompare(PyObject *left, PyObject *right, int op) + + Rich compare two Unicode strings and return one of the following: + + * ``NULL`` in case an exception was raised + * :const:`Py_True` or :const:`Py_False` for successful comparisons + * :const:`Py_NotImplemented` in case the type combination is unknown + + Possible values for *op* are :const:`Py_GT`, :const:`Py_GE`, :const:`Py_EQ`, + :const:`Py_NE`, :const:`Py_LT`, and :const:`Py_LE`. + + +.. c:function:: PyObject* PyUnicode_Format(PyObject *format, PyObject *args) + + Return a new string object from *format* and *args*; this is analogous to + ``format % args``. + + +.. c:function:: int PyUnicode_Contains(PyObject *container, PyObject *element) + + Check whether *element* is contained in *container* and return true or false + accordingly. + + *element* has to coerce to a one element Unicode string. ``-1`` is returned + if there was an error. + + +.. c:function:: void PyUnicode_InternInPlace(PyObject **string) + + Intern the argument *\*string* in place. The argument must be the address of a + pointer variable pointing to a Python Unicode string object. If there is an + existing interned string that is the same as *\*string*, it sets *\*string* to + it (decrementing the reference count of the old string object and incrementing + the reference count of the interned string object), otherwise it leaves + *\*string* alone and interns it (incrementing its reference count). + (Clarification: even though there is a lot of talk about reference counts, think + of this function as reference-count-neutral; you own the object after the call + if and only if you owned it before the call.) + + +.. c:function:: PyObject* PyUnicode_InternFromString(const char *v) + + A combination of :c:func:`PyUnicode_FromString` and + :c:func:`PyUnicode_InternInPlace`, returning either a new Unicode string + object that has been interned, or a new ("owned") reference to an earlier + interned string object with the same value. diff --git a/python-3.7.4-docs-html/_sources/c-api/utilities.rst.txt b/python-3.7.4-docs-html/_sources/c-api/utilities.rst.txt new file mode 100644 index 0000000..d4484fb --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/utilities.rst.txt @@ -0,0 +1,21 @@ +.. highlightlang:: c + +.. _utilities: + +********* +Utilities +********* + +The functions in this chapter perform various utility tasks, ranging from +helping C code be more portable across platforms, using Python modules from C, +and parsing function arguments and constructing Python values from C values. + +.. toctree:: + + sys.rst + import.rst + marshal.rst + arg.rst + conversion.rst + reflection.rst + codec.rst diff --git a/python-3.7.4-docs-html/_sources/c-api/veryhigh.rst.txt b/python-3.7.4-docs-html/_sources/c-api/veryhigh.rst.txt new file mode 100644 index 0000000..317093e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/veryhigh.rst.txt @@ -0,0 +1,394 @@ +.. highlightlang:: c + + +.. _veryhigh: + +************************* +The Very High Level Layer +************************* + +The functions in this chapter will let you execute Python source code given in a +file or a buffer, but they will not let you interact in a more detailed way with +the interpreter. + +Several of these functions accept a start symbol from the grammar as a +parameter. The available start symbols are :const:`Py_eval_input`, +:const:`Py_file_input`, and :const:`Py_single_input`. These are described +following the functions which accept them as parameters. + +Note also that several of these functions take :c:type:`FILE\*` parameters. One +particular issue which needs to be handled carefully is that the :c:type:`FILE` +structure for different C libraries can be different and incompatible. Under +Windows (at least), it is possible for dynamically linked extensions to actually +use different libraries, so care should be taken that :c:type:`FILE\*` parameters +are only passed to these functions if it is certain that they were created by +the same library that the Python runtime is using. + + +.. c:function:: int Py_Main(int argc, wchar_t **argv) + + The main program for the standard interpreter. This is made available for + programs which embed Python. The *argc* and *argv* parameters should be + prepared exactly as those which are passed to a C program's :c:func:`main` + function (converted to wchar_t according to the user's locale). It is + important to note that the argument list may be modified (but the contents of + the strings pointed to by the argument list are not). The return value will + be ``0`` if the interpreter exits normally (i.e., without an exception), + ``1`` if the interpreter exits due to an exception, or ``2`` if the parameter + list does not represent a valid Python command line. + + Note that if an otherwise unhandled :exc:`SystemExit` is raised, this + function will not return ``1``, but exit the process, as long as + ``Py_InspectFlag`` is not set. + + +.. c:function:: int PyRun_AnyFile(FILE *fp, const char *filename) + + This is a simplified interface to :c:func:`PyRun_AnyFileExFlags` below, leaving + *closeit* set to ``0`` and *flags* set to *NULL*. + + +.. c:function:: int PyRun_AnyFileFlags(FILE *fp, const char *filename, PyCompilerFlags *flags) + + This is a simplified interface to :c:func:`PyRun_AnyFileExFlags` below, leaving + the *closeit* argument set to ``0``. + + +.. c:function:: int PyRun_AnyFileEx(FILE *fp, const char *filename, int closeit) + + This is a simplified interface to :c:func:`PyRun_AnyFileExFlags` below, leaving + the *flags* argument set to *NULL*. + + +.. c:function:: int PyRun_AnyFileExFlags(FILE *fp, const char *filename, int closeit, PyCompilerFlags *flags) + + If *fp* refers to a file associated with an interactive device (console or + terminal input or Unix pseudo-terminal), return the value of + :c:func:`PyRun_InteractiveLoop`, otherwise return the result of + :c:func:`PyRun_SimpleFile`. *filename* is decoded from the filesystem + encoding (:func:`sys.getfilesystemencoding`). If *filename* is *NULL*, this + function uses ``"???"`` as the filename. + + +.. c:function:: int PyRun_SimpleString(const char *command) + + This is a simplified interface to :c:func:`PyRun_SimpleStringFlags` below, + leaving the *PyCompilerFlags\** argument set to NULL. + + +.. c:function:: int PyRun_SimpleStringFlags(const char *command, PyCompilerFlags *flags) + + Executes the Python source code from *command* in the :mod:`__main__` module + according to the *flags* argument. If :mod:`__main__` does not already exist, it + is created. Returns ``0`` on success or ``-1`` if an exception was raised. If + there was an error, there is no way to get the exception information. For the + meaning of *flags*, see below. + + Note that if an otherwise unhandled :exc:`SystemExit` is raised, this + function will not return ``-1``, but exit the process, as long as + ``Py_InspectFlag`` is not set. + + +.. c:function:: int PyRun_SimpleFile(FILE *fp, const char *filename) + + This is a simplified interface to :c:func:`PyRun_SimpleFileExFlags` below, + leaving *closeit* set to ``0`` and *flags* set to *NULL*. + + +.. c:function:: int PyRun_SimpleFileEx(FILE *fp, const char *filename, int closeit) + + This is a simplified interface to :c:func:`PyRun_SimpleFileExFlags` below, + leaving *flags* set to *NULL*. + + +.. c:function:: int PyRun_SimpleFileExFlags(FILE *fp, const char *filename, int closeit, PyCompilerFlags *flags) + + Similar to :c:func:`PyRun_SimpleStringFlags`, but the Python source code is read + from *fp* instead of an in-memory string. *filename* should be the name of + the file, it is decoded from the filesystem encoding + (:func:`sys.getfilesystemencoding`). If *closeit* is true, the file is + closed before PyRun_SimpleFileExFlags returns. + + .. note:: + On Windows, *fp* should be opened as binary mode (e.g. ``fopen(filename, "rb")``. + Otherwise, Python may not handle script file with LF line ending correctly. + + +.. c:function:: int PyRun_InteractiveOne(FILE *fp, const char *filename) + + This is a simplified interface to :c:func:`PyRun_InteractiveOneFlags` below, + leaving *flags* set to *NULL*. + + +.. c:function:: int PyRun_InteractiveOneFlags(FILE *fp, const char *filename, PyCompilerFlags *flags) + + Read and execute a single statement from a file associated with an + interactive device according to the *flags* argument. The user will be + prompted using ``sys.ps1`` and ``sys.ps2``. *filename* is decoded from the + filesystem encoding (:func:`sys.getfilesystemencoding`). + + Returns ``0`` when the input was + executed successfully, ``-1`` if there was an exception, or an error code + from the :file:`errcode.h` include file distributed as part of Python if + there was a parse error. (Note that :file:`errcode.h` is not included by + :file:`Python.h`, so must be included specifically if needed.) + + +.. c:function:: int PyRun_InteractiveLoop(FILE *fp, const char *filename) + + This is a simplified interface to :c:func:`PyRun_InteractiveLoopFlags` below, + leaving *flags* set to *NULL*. + + +.. c:function:: int PyRun_InteractiveLoopFlags(FILE *fp, const char *filename, PyCompilerFlags *flags) + + Read and execute statements from a file associated with an interactive device + until EOF is reached. The user will be prompted using ``sys.ps1`` and + ``sys.ps2``. *filename* is decoded from the filesystem encoding + (:func:`sys.getfilesystemencoding`). Returns ``0`` at EOF or a negative + number upon failure. + + +.. c:var:: int (*PyOS_InputHook)(void) + + Can be set to point to a function with the prototype + ``int func(void)``. The function will be called when Python's + interpreter prompt is about to become idle and wait for user input + from the terminal. The return value is ignored. Overriding this + hook can be used to integrate the interpreter's prompt with other + event loops, as done in the :file:`Modules/_tkinter.c` in the + Python source code. + + +.. c:var:: char* (*PyOS_ReadlineFunctionPointer)(FILE *, FILE *, const char *) + + Can be set to point to a function with the prototype + ``char *func(FILE *stdin, FILE *stdout, char *prompt)``, + overriding the default function used to read a single line of input + at the interpreter's prompt. The function is expected to output + the string *prompt* if it's not *NULL*, and then read a line of + input from the provided standard input file, returning the + resulting string. For example, The :mod:`readline` module sets + this hook to provide line-editing and tab-completion features. + + The result must be a string allocated by :c:func:`PyMem_RawMalloc` or + :c:func:`PyMem_RawRealloc`, or *NULL* if an error occurred. + + .. versionchanged:: 3.4 + The result must be allocated by :c:func:`PyMem_RawMalloc` or + :c:func:`PyMem_RawRealloc`, instead of being allocated by + :c:func:`PyMem_Malloc` or :c:func:`PyMem_Realloc`. + + +.. c:function:: struct _node* PyParser_SimpleParseString(const char *str, int start) + + This is a simplified interface to + :c:func:`PyParser_SimpleParseStringFlagsFilename` below, leaving *filename* set + to *NULL* and *flags* set to ``0``. + + +.. c:function:: struct _node* PyParser_SimpleParseStringFlags( const char *str, int start, int flags) + + This is a simplified interface to + :c:func:`PyParser_SimpleParseStringFlagsFilename` below, leaving *filename* set + to *NULL*. + + +.. c:function:: struct _node* PyParser_SimpleParseStringFlagsFilename( const char *str, const char *filename, int start, int flags) + + Parse Python source code from *str* using the start token *start* according to + the *flags* argument. The result can be used to create a code object which can + be evaluated efficiently. This is useful if a code fragment must be evaluated + many times. *filename* is decoded from the filesystem encoding + (:func:`sys.getfilesystemencoding`). + + +.. c:function:: struct _node* PyParser_SimpleParseFile(FILE *fp, const char *filename, int start) + + This is a simplified interface to :c:func:`PyParser_SimpleParseFileFlags` below, + leaving *flags* set to ``0``. + + +.. c:function:: struct _node* PyParser_SimpleParseFileFlags(FILE *fp, const char *filename, int start, int flags) + + Similar to :c:func:`PyParser_SimpleParseStringFlagsFilename`, but the Python + source code is read from *fp* instead of an in-memory string. + + +.. c:function:: PyObject* PyRun_String(const char *str, int start, PyObject *globals, PyObject *locals) + + This is a simplified interface to :c:func:`PyRun_StringFlags` below, leaving + *flags* set to *NULL*. + + +.. c:function:: PyObject* PyRun_StringFlags(const char *str, int start, PyObject *globals, PyObject *locals, PyCompilerFlags *flags) + + Execute Python source code from *str* in the context specified by the + objects *globals* and *locals* with the compiler flags specified by + *flags*. *globals* must be a dictionary; *locals* can be any object + that implements the mapping protocol. The parameter *start* specifies + the start token that should be used to parse the source code. + + Returns the result of executing the code as a Python object, or *NULL* if an + exception was raised. + + +.. c:function:: PyObject* PyRun_File(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals) + + This is a simplified interface to :c:func:`PyRun_FileExFlags` below, leaving + *closeit* set to ``0`` and *flags* set to *NULL*. + + +.. c:function:: PyObject* PyRun_FileEx(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, int closeit) + + This is a simplified interface to :c:func:`PyRun_FileExFlags` below, leaving + *flags* set to *NULL*. + + +.. c:function:: PyObject* PyRun_FileFlags(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, PyCompilerFlags *flags) + + This is a simplified interface to :c:func:`PyRun_FileExFlags` below, leaving + *closeit* set to ``0``. + + +.. c:function:: PyObject* PyRun_FileExFlags(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, int closeit, PyCompilerFlags *flags) + + Similar to :c:func:`PyRun_StringFlags`, but the Python source code is read from + *fp* instead of an in-memory string. *filename* should be the name of the file, + it is decoded from the filesystem encoding (:func:`sys.getfilesystemencoding`). + If *closeit* is true, the file is closed before :c:func:`PyRun_FileExFlags` + returns. + + +.. c:function:: PyObject* Py_CompileString(const char *str, const char *filename, int start) + + This is a simplified interface to :c:func:`Py_CompileStringFlags` below, leaving + *flags* set to *NULL*. + + +.. c:function:: PyObject* Py_CompileStringFlags(const char *str, const char *filename, int start, PyCompilerFlags *flags) + + This is a simplified interface to :c:func:`Py_CompileStringExFlags` below, with + *optimize* set to ``-1``. + + +.. c:function:: PyObject* Py_CompileStringObject(const char *str, PyObject *filename, int start, PyCompilerFlags *flags, int optimize) + + Parse and compile the Python source code in *str*, returning the resulting code + object. The start token is given by *start*; this can be used to constrain the + code which can be compiled and should be :const:`Py_eval_input`, + :const:`Py_file_input`, or :const:`Py_single_input`. The filename specified by + *filename* is used to construct the code object and may appear in tracebacks or + :exc:`SyntaxError` exception messages. This returns *NULL* if the code + cannot be parsed or compiled. + + The integer *optimize* specifies the optimization level of the compiler; a + value of ``-1`` selects the optimization level of the interpreter as given by + :option:`-O` options. Explicit levels are ``0`` (no optimization; + ``__debug__`` is true), ``1`` (asserts are removed, ``__debug__`` is false) + or ``2`` (docstrings are removed too). + + .. versionadded:: 3.4 + + +.. c:function:: PyObject* Py_CompileStringExFlags(const char *str, const char *filename, int start, PyCompilerFlags *flags, int optimize) + + Like :c:func:`Py_CompileStringObject`, but *filename* is a byte string + decoded from the filesystem encoding (:func:`os.fsdecode`). + + .. versionadded:: 3.2 + +.. c:function:: PyObject* PyEval_EvalCode(PyObject *co, PyObject *globals, PyObject *locals) + + This is a simplified interface to :c:func:`PyEval_EvalCodeEx`, with just + the code object, and global and local variables. The other arguments are + set to *NULL*. + + +.. c:function:: PyObject* PyEval_EvalCodeEx(PyObject *co, PyObject *globals, PyObject *locals, PyObject *const *args, int argcount, PyObject *const *kws, int kwcount, PyObject *const *defs, int defcount, PyObject *kwdefs, PyObject *closure) + + Evaluate a precompiled code object, given a particular environment for its + evaluation. This environment consists of a dictionary of global variables, + a mapping object of local variables, arrays of arguments, keywords and + defaults, a dictionary of default values for :ref:`keyword-only + ` arguments and a closure tuple of cells. + + +.. c:type:: PyFrameObject + + The C structure of the objects used to describe frame objects. The + fields of this type are subject to change at any time. + + +.. c:function:: PyObject* PyEval_EvalFrame(PyFrameObject *f) + + Evaluate an execution frame. This is a simplified interface to + :c:func:`PyEval_EvalFrameEx`, for backward compatibility. + + +.. c:function:: PyObject* PyEval_EvalFrameEx(PyFrameObject *f, int throwflag) + + This is the main, unvarnished function of Python interpretation. It is + literally 2000 lines long. The code object associated with the execution + frame *f* is executed, interpreting bytecode and executing calls as needed. + The additional *throwflag* parameter can mostly be ignored - if true, then + it causes an exception to immediately be thrown; this is used for the + :meth:`~generator.throw` methods of generator objects. + + .. versionchanged:: 3.4 + This function now includes a debug assertion to help ensure that it + does not silently discard an active exception. + + +.. c:function:: int PyEval_MergeCompilerFlags(PyCompilerFlags *cf) + + This function changes the flags of the current evaluation frame, and returns + true on success, false on failure. + + +.. c:var:: int Py_eval_input + + .. index:: single: Py_CompileString() + + The start symbol from the Python grammar for isolated expressions; for use with + :c:func:`Py_CompileString`. + + +.. c:var:: int Py_file_input + + .. index:: single: Py_CompileString() + + The start symbol from the Python grammar for sequences of statements as read + from a file or other source; for use with :c:func:`Py_CompileString`. This is + the symbol to use when compiling arbitrarily long Python source code. + + +.. c:var:: int Py_single_input + + .. index:: single: Py_CompileString() + + The start symbol from the Python grammar for a single statement; for use with + :c:func:`Py_CompileString`. This is the symbol used for the interactive + interpreter loop. + + +.. c:type:: struct PyCompilerFlags + + This is the structure used to hold compiler flags. In cases where code is only + being compiled, it is passed as ``int flags``, and in cases where code is being + executed, it is passed as ``PyCompilerFlags *flags``. In this case, ``from + __future__ import`` can modify *flags*. + + Whenever ``PyCompilerFlags *flags`` is *NULL*, :attr:`cf_flags` is treated as + equal to ``0``, and any modification due to ``from __future__ import`` is + discarded. :: + + struct PyCompilerFlags { + int cf_flags; + } + + +.. c:var:: int CO_FUTURE_DIVISION + + This bit can be set in *flags* to cause division operator ``/`` to be + interpreted as "true division" according to :pep:`238`. diff --git a/python-3.7.4-docs-html/_sources/c-api/weakref.rst.txt b/python-3.7.4-docs-html/_sources/c-api/weakref.rst.txt new file mode 100644 index 0000000..6cb3e33 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/c-api/weakref.rst.txt @@ -0,0 +1,69 @@ +.. highlightlang:: c + +.. _weakrefobjects: + +Weak Reference Objects +---------------------- + +Python supports *weak references* as first-class objects. There are two +specific object types which directly implement weak references. The first is a +simple reference object, and the second acts as a proxy for the original object +as much as it can. + + +.. c:function:: int PyWeakref_Check(ob) + + Return true if *ob* is either a reference or proxy object. + + +.. c:function:: int PyWeakref_CheckRef(ob) + + Return true if *ob* is a reference object. + + +.. c:function:: int PyWeakref_CheckProxy(ob) + + Return true if *ob* is a proxy object. + + +.. c:function:: PyObject* PyWeakref_NewRef(PyObject *ob, PyObject *callback) + + Return a weak reference object for the object *ob*. This will always return + a new reference, but is not guaranteed to create a new object; an existing + reference object may be returned. The second parameter, *callback*, can be a + callable object that receives notification when *ob* is garbage collected; it + should accept a single parameter, which will be the weak reference object + itself. *callback* may also be ``None`` or *NULL*. If *ob* is not a + weakly-referencable object, or if *callback* is not callable, ``None``, or + *NULL*, this will return *NULL* and raise :exc:`TypeError`. + + +.. c:function:: PyObject* PyWeakref_NewProxy(PyObject *ob, PyObject *callback) + + Return a weak reference proxy object for the object *ob*. This will always + return a new reference, but is not guaranteed to create a new object; an + existing proxy object may be returned. The second parameter, *callback*, can + be a callable object that receives notification when *ob* is garbage + collected; it should accept a single parameter, which will be the weak + reference object itself. *callback* may also be ``None`` or *NULL*. If *ob* + is not a weakly-referencable object, or if *callback* is not callable, + ``None``, or *NULL*, this will return *NULL* and raise :exc:`TypeError`. + + +.. c:function:: PyObject* PyWeakref_GetObject(PyObject *ref) + + Return the referenced object from a weak reference, *ref*. If the referent is + no longer live, returns :const:`Py_None`. + + .. note:: + + This function returns a **borrowed reference** to the referenced object. + This means that you should always call :c:func:`Py_INCREF` on the object + except if you know that it cannot be destroyed while you are still + using it. + + +.. c:function:: PyObject* PyWeakref_GET_OBJECT(PyObject *ref) + + Similar to :c:func:`PyWeakref_GetObject`, but implemented as a macro that does no + error checking. diff --git a/python-3.7.4-docs-html/_sources/contents.rst.txt b/python-3.7.4-docs-html/_sources/contents.rst.txt new file mode 100644 index 0000000..8690de7 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/contents.rst.txt @@ -0,0 +1,31 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + Python Documentation contents +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +.. toctree:: + + whatsnew/index.rst + tutorial/index.rst + using/index.rst + reference/index.rst + library/index.rst + extending/index.rst + c-api/index.rst + distributing/index.rst + installing/index.rst + howto/index.rst + faq/index.rst + glossary.rst + + about.rst + bugs.rst + copyright.rst + license.rst + +.. to include legacy packaging docs in build + +.. toctree:: + :hidden: + + distutils/index.rst + install/index.rst diff --git a/python-3.7.4-docs-html/_sources/copyright.rst.txt b/python-3.7.4-docs-html/_sources/copyright.rst.txt new file mode 100644 index 0000000..393a1f0 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/copyright.rst.txt @@ -0,0 +1,19 @@ +********* +Copyright +********* + +Python and this documentation is: + +Copyright © 2001-2019 Python Software Foundation. All rights reserved. + +Copyright © 2000 BeOpen.com. All rights reserved. + +Copyright © 1995-2000 Corporation for National Research Initiatives. All rights +reserved. + +Copyright © 1991-1995 Stichting Mathematisch Centrum. All rights reserved. + +------- + +See :ref:`history-and-license` for complete license and permissions information. + diff --git a/python-3.7.4-docs-html/_sources/distributing/index.rst.txt b/python-3.7.4-docs-html/_sources/distributing/index.rst.txt new file mode 100644 index 0000000..2e46c7a --- /dev/null +++ b/python-3.7.4-docs-html/_sources/distributing/index.rst.txt @@ -0,0 +1,176 @@ +.. _distributing-index: + +############################### + Distributing Python Modules +############################### + +:Email: distutils-sig@python.org + + +As a popular open source development project, Python has an active +supporting community of contributors and users that also make their software +available for other Python developers to use under open source license terms. + +This allows Python users to share and collaborate effectively, benefiting +from the solutions others have already created to common (and sometimes +even rare!) problems, as well as potentially contributing their own +solutions to the common pool. + +This guide covers the distribution part of the process. For a guide to +installing other Python projects, refer to the +:ref:`installation guide `. + +.. note:: + + For corporate and other institutional users, be aware that many + organisations have their own policies around using and contributing to + open source software. Please take such policies into account when making + use of the distribution and installation tools provided with Python. + + +Key terms +========= + +* the `Python Packaging Index `__ is a public + repository of open source licensed packages made available for use by + other Python users +* the `Python Packaging Authority + `__ are the group of + developers and documentation authors responsible for the maintenance and + evolution of the standard packaging tools and the associated metadata and + file format standards. They maintain a variety of tools, documentation + and issue trackers on both `GitHub `__ and + `BitBucket `__. +* :mod:`distutils` is the original build and distribution system first added + to the Python standard library in 1998. While direct use of :mod:`distutils` + is being phased out, it still laid the foundation for the current packaging + and distribution infrastructure, and it not only remains part of the + standard library, but its name lives on in other ways (such as the name + of the mailing list used to coordinate Python packaging standards + development). +* `setuptools`_ is a (largely) drop-in replacement for :mod:`distutils` first + published in 2004. Its most notable addition over the unmodified + :mod:`distutils` tools was the ability to declare dependencies on other + packages. It is currently recommended as a more regularly updated + alternative to :mod:`distutils` that offers consistent support for more + recent packaging standards across a wide range of Python versions. +* `wheel`_ (in this context) is a project that adds the ``bdist_wheel`` + command to :mod:`distutils`/`setuptools`_. This produces a cross platform + binary packaging format (called "wheels" or "wheel files" and defined in + :pep:`427`) that allows Python libraries, even those including binary + extensions, to be installed on a system without needing to be built + locally. + +.. _setuptools: https://setuptools.readthedocs.io/en/latest/ +.. _wheel: https://wheel.readthedocs.io/ + +Open source licensing and collaboration +======================================= + +In most parts of the world, software is automatically covered by copyright. +This means that other developers require explicit permission to copy, use, +modify and redistribute the software. + +Open source licensing is a way of explicitly granting such permission in a +relatively consistent way, allowing developers to share and collaborate +efficiently by making common solutions to various problems freely available. +This leaves many developers free to spend more time focusing on the problems +that are relatively unique to their specific situation. + +The distribution tools provided with Python are designed to make it +reasonably straightforward for developers to make their own contributions +back to that common pool of software if they choose to do so. + +The same distribution tools can also be used to distribute software within +an organisation, regardless of whether that software is published as open +source software or not. + + +Installing the tools +==================== + +The standard library does not include build tools that support modern +Python packaging standards, as the core development team has found that it +is important to have standard tools that work consistently, even on older +versions of Python. + +The currently recommended build and distribution tools can be installed +by invoking the ``pip`` module at the command line:: + + python -m pip install setuptools wheel twine + +.. note:: + + For POSIX users (including Mac OS X and Linux users), these instructions + assume the use of a :term:`virtual environment`. + + For Windows users, these instructions assume that the option to + adjust the system PATH environment variable was selected when installing + Python. + +The Python Packaging User Guide includes more details on the `currently +recommended tools`_. + +.. _currently recommended tools: https://packaging.python.org/guides/tool-recommendations/#packaging-tool-recommendations + +.. index:: + single: Python Package Index (PyPI) + single: PyPI; (see Python Package Index (PyPI)) + +.. _publishing-python-packages: + +Reading the Python Packaging User Guide +======================================= + +The Python Packaging User Guide covers the various key steps and elements +involved in creating and publishing a project: + +* `Project structure`_ +* `Building and packaging the project`_ +* `Uploading the project to the Python Packaging Index`_ + +.. _Project structure: \ + https://packaging.python.org/tutorials/distributing-packages/ +.. _Building and packaging the project: \ + https://packaging.python.org/tutorials/distributing-packages/#packaging-your-project +.. _Uploading the project to the Python Packaging Index: \ + https://packaging.python.org/tutorials/distributing-packages/#uploading-your-project-to-pypi + + +How do I...? +============ + +These are quick answers or links for some common tasks. + +... choose a name for my project? +--------------------------------- + +This isn't an easy topic, but here are a few tips: + +* check the Python Packaging Index to see if the name is already in use +* check popular hosting sites like GitHub, BitBucket, etc to see if there + is already a project with that name +* check what comes up in a web search for the name you're considering +* avoid particularly common words, especially ones with multiple meanings, + as they can make it difficult for users to find your software when + searching for it + + +... create and distribute binary extensions? +-------------------------------------------- + +This is actually quite a complex topic, with a variety of alternatives +available depending on exactly what you're aiming to achieve. See the +Python Packaging User Guide for more information and recommendations. + +.. seealso:: + + `Python Packaging User Guide: Binary Extensions + `__ + +.. other topics: + + Once the Development & Deployment part of PPUG is fleshed out, some of + those sections should be linked from new questions here (most notably, + we should have a question about avoiding depending on PyPI that links to + https://packaging.python.org/en/latest/mirrors/) diff --git a/python-3.7.4-docs-html/_sources/distutils/apiref.rst.txt b/python-3.7.4-docs-html/_sources/distutils/apiref.rst.txt new file mode 100644 index 0000000..8efeffb --- /dev/null +++ b/python-3.7.4-docs-html/_sources/distutils/apiref.rst.txt @@ -0,0 +1,2031 @@ +.. _api-reference: + +************* +API Reference +************* + + +:mod:`distutils.core` --- Core Distutils functionality +====================================================== + +.. module:: distutils.core + :synopsis: The core Distutils functionality + + +The :mod:`distutils.core` module is the only module that needs to be installed +to use the Distutils. It provides the :func:`setup` (which is called from the +setup script). Indirectly provides the :class:`distutils.dist.Distribution` and +:class:`distutils.cmd.Command` class. + + +.. function:: setup(arguments) + + The basic do-everything function that does most everything you could ever ask + for from a Distutils method. + + The setup function takes a large number of arguments. These are laid out in the + following table. + + .. tabularcolumns:: |l|L|L| + + +--------------------+--------------------------------+-------------------------------------------------------------+ + | argument name | value | type | + +====================+================================+=============================================================+ + | *name* | The name of the package | a string | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *version* | The version number of the | a string | + | | package; see | | + | | :mod:`distutils.version` | | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *description* | A single line describing the | a string | + | | package | | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *long_description* | Longer description of the | a string | + | | package | | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *author* | The name of the package author | a string | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *author_email* | The email address of the | a string | + | | package author | | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *maintainer* | The name of the current | a string | + | | maintainer, if different from | | + | | the author. Note that if | | + | | the maintainer is provided, | | + | | distutils will use it as the | | + | | author in :file:`PKG-INFO` | | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *maintainer_email* | The email address of the | a string | + | | current maintainer, if | | + | | different from the author | | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *url* | A URL for the package | a string | + | | (homepage) | | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *download_url* | A URL to download the package | a string | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *packages* | A list of Python packages that | a list of strings | + | | distutils will manipulate | | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *py_modules* | A list of Python modules that | a list of strings | + | | distutils will manipulate | | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *scripts* | A list of standalone script | a list of strings | + | | files to be built and | | + | | installed | | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *ext_modules* | A list of Python extensions to | a list of instances of | + | | be built | :class:`distutils.core.Extension` | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *classifiers* | A list of categories for the | a list of strings; valid classifiers are listed on `PyPI | + | | package | `_. | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *distclass* | the :class:`Distribution` | a subclass of | + | | class to use | :class:`distutils.core.Distribution` | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *script_name* | The name of the setup.py | a string | + | | script - defaults to | | + | | ``sys.argv[0]`` | | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *script_args* | Arguments to supply to the | a list of strings | + | | setup script | | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *options* | default options for the setup | a dictionary | + | | script | | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *license* | The license for the package | a string | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *keywords* | Descriptive meta-data, see | a list of strings or a comma-separated string | + | | :pep:`314` | | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *platforms* | | a list of strings or a comma-separated string | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *cmdclass* | A mapping of command names to | a dictionary | + | | :class:`Command` subclasses | | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *data_files* | A list of data files to | a list | + | | install | | + +--------------------+--------------------------------+-------------------------------------------------------------+ + | *package_dir* | A mapping of package to | a dictionary | + | | directory names | | + +--------------------+--------------------------------+-------------------------------------------------------------+ + + + +.. function:: run_setup(script_name[, script_args=None, stop_after='run']) + + Run a setup script in a somewhat controlled environment, and return the + :class:`distutils.dist.Distribution` instance that drives things. This is + useful if you need to find out the distribution meta-data (passed as keyword + args from *script* to :func:`setup`), or the contents of the config files or + command-line. + + *script_name* is a file that will be read and run with :func:`exec`. ``sys.argv[0]`` + will be replaced with *script* for the duration of the call. *script_args* is a + list of strings; if supplied, ``sys.argv[1:]`` will be replaced by *script_args* + for the duration of the call. + + *stop_after* tells :func:`setup` when to stop processing; possible values: + + .. tabularcolumns:: |l|L| + + +---------------+---------------------------------------------+ + | value | description | + +===============+=============================================+ + | *init* | Stop after the :class:`Distribution` | + | | instance has been created and populated | + | | with the keyword arguments to :func:`setup` | + +---------------+---------------------------------------------+ + | *config* | Stop after config files have been parsed | + | | (and their data stored in the | + | | :class:`Distribution` instance) | + +---------------+---------------------------------------------+ + | *commandline* | Stop after the command-line | + | | (``sys.argv[1:]`` or *script_args*) have | + | | been parsed (and the data stored in the | + | | :class:`Distribution` instance.) | + +---------------+---------------------------------------------+ + | *run* | Stop after all commands have been run (the | + | | same as if :func:`setup` had been called | + | | in the usual way). This is the default | + | | value. | + +---------------+---------------------------------------------+ + +In addition, the :mod:`distutils.core` module exposed a number of classes that +live elsewhere. + +* :class:`~distutils.extension.Extension` from :mod:`distutils.extension` + +* :class:`~distutils.cmd.Command` from :mod:`distutils.cmd` + +* :class:`~distutils.dist.Distribution` from :mod:`distutils.dist` + +A short description of each of these follows, but see the relevant module for +the full reference. + + +.. class:: Extension + + The Extension class describes a single C or C++ extension module in a setup + script. It accepts the following keyword arguments in its constructor: + + .. tabularcolumns:: |l|L|l| + + +------------------------+--------------------------------+---------------------------+ + | argument name | value | type | + +========================+================================+===========================+ + | *name* | the full name of the | a string | + | | extension, including any | | + | | packages --- ie. *not* a | | + | | filename or pathname, but | | + | | Python dotted name | | + +------------------------+--------------------------------+---------------------------+ + | *sources* | list of source filenames, | a list of strings | + | | relative to the distribution | | + | | root (where the setup script | | + | | lives), in Unix form | | + | | (slash-separated) for | | + | | portability. | | + | | Source files may be C, C++, | | + | | SWIG (.i), platform-specific | | + | | resource files, or whatever | | + | | else is recognized by the | | + | | :command:`build_ext` command | | + | | as source for a Python | | + | | extension. | | + +------------------------+--------------------------------+---------------------------+ + | *include_dirs* | list of directories to search | a list of strings | + | | for C/C++ header files (in | | + | | Unix form for portability) | | + +------------------------+--------------------------------+---------------------------+ + | *define_macros* | list of macros to define; each | a list of tuples | + | | macro is defined using a | | + | | 2-tuple ``(name, value)``, | | + | | where *value* is | | + | | either the string to define it | | + | | to or ``None`` to define it | | + | | without a particular value | | + | | (equivalent of ``#define FOO`` | | + | | in source or :option:`!-DFOO` | | + | | on Unix C compiler command | | + | | line) | | + +------------------------+--------------------------------+---------------------------+ + | *undef_macros* | list of macros to undefine | a list of strings | + | | explicitly | | + +------------------------+--------------------------------+---------------------------+ + | *library_dirs* | list of directories to search | a list of strings | + | | for C/C++ libraries at link | | + | | time | | + +------------------------+--------------------------------+---------------------------+ + | *libraries* | list of library names (not | a list of strings | + | | filenames or paths) to link | | + | | against | | + +------------------------+--------------------------------+---------------------------+ + | *runtime_library_dirs* | list of directories to search | a list of strings | + | | for C/C++ libraries at run | | + | | time (for shared extensions, | | + | | this is when the extension is | | + | | loaded) | | + +------------------------+--------------------------------+---------------------------+ + | *extra_objects* | list of extra files to link | a list of strings | + | | with (eg. object files not | | + | | implied by 'sources', static | | + | | library that must be | | + | | explicitly specified, binary | | + | | resource files, etc.) | | + +------------------------+--------------------------------+---------------------------+ + | *extra_compile_args* | any extra platform- and | a list of strings | + | | compiler-specific information | | + | | to use when compiling the | | + | | source files in 'sources'. For | | + | | platforms and compilers where | | + | | a command line makes sense, | | + | | this is typically a list of | | + | | command-line arguments, but | | + | | for other platforms it could | | + | | be anything. | | + +------------------------+--------------------------------+---------------------------+ + | *extra_link_args* | any extra platform- and | a list of strings | + | | compiler-specific information | | + | | to use when linking object | | + | | files together to create the | | + | | extension (or to create a new | | + | | static Python interpreter). | | + | | Similar interpretation as for | | + | | 'extra_compile_args'. | | + +------------------------+--------------------------------+---------------------------+ + | *export_symbols* | list of symbols to be exported | a list of strings | + | | from a shared extension. Not | | + | | used on all platforms, and not | | + | | generally necessary for Python | | + | | extensions, which typically | | + | | export exactly one symbol: | | + | | ``init`` + extension_name. | | + +------------------------+--------------------------------+---------------------------+ + | *depends* | list of files that the | a list of strings | + | | extension depends on | | + +------------------------+--------------------------------+---------------------------+ + | *language* | extension language (i.e. | a string | + | | ``'c'``, ``'c++'``, | | + | | ``'objc'``). Will be detected | | + | | from the source extensions if | | + | | not provided. | | + +------------------------+--------------------------------+---------------------------+ + | *optional* | specifies that a build failure | a boolean | + | | in the extension should not | | + | | abort the build process, but | | + | | simply skip the extension. | | + +------------------------+--------------------------------+---------------------------+ + + +.. class:: Distribution + + A :class:`Distribution` describes how to build, install and package up a Python + software package. + + See the :func:`setup` function for a list of keyword arguments accepted by the + Distribution constructor. :func:`setup` creates a Distribution instance. + + .. versionchanged:: 3.7 + :class:`~distutils.core.Distribution` now warns if ``classifiers``, + ``keywords`` and ``platforms`` fields are not specified as a list or + a string. + +.. class:: Command + + A :class:`Command` class (or rather, an instance of one of its subclasses) + implement a single distutils command. + + +:mod:`distutils.ccompiler` --- CCompiler base class +=================================================== + +.. module:: distutils.ccompiler + :synopsis: Abstract CCompiler class + + +This module provides the abstract base class for the :class:`CCompiler` +classes. A :class:`CCompiler` instance can be used for all the compile and +link steps needed to build a single project. Methods are provided to set +options for the compiler --- macro definitions, include directories, link path, +libraries and the like. + +This module provides the following functions. + + +.. function:: gen_lib_options(compiler, library_dirs, runtime_library_dirs, libraries) + + Generate linker options for searching library directories and linking with + specific libraries. *libraries* and *library_dirs* are, respectively, lists of + library names (not filenames!) and search directories. Returns a list of + command-line options suitable for use with some compiler (depending on the two + format strings passed in). + + +.. function:: gen_preprocess_options(macros, include_dirs) + + Generate C pre-processor options (:option:`!-D`, :option:`!-U`, :option:`!-I`) as + used by at least two types of compilers: the typical Unix compiler and Visual + C++. *macros* is the usual thing, a list of 1- or 2-tuples, where ``(name,)`` + means undefine (:option:`!-U`) macro *name*, and ``(name, value)`` means define + (:option:`!-D`) macro *name* to *value*. *include_dirs* is just a list of + directory names to be added to the header file search path (:option:`!-I`). + Returns a list of command-line options suitable for either Unix compilers or + Visual C++. + + +.. function:: get_default_compiler(osname, platform) + + Determine the default compiler to use for the given platform. + + *osname* should be one of the standard Python OS names (i.e. the ones returned + by ``os.name``) and *platform* the common value returned by ``sys.platform`` for + the platform in question. + + The default values are ``os.name`` and ``sys.platform`` in case the parameters + are not given. + + +.. function:: new_compiler(plat=None, compiler=None, verbose=0, dry_run=0, force=0) + + Factory function to generate an instance of some CCompiler subclass for the + supplied platform/compiler combination. *plat* defaults to ``os.name`` (eg. + ``'posix'``, ``'nt'``), and *compiler* defaults to the default compiler for + that platform. Currently only ``'posix'`` and ``'nt'`` are supported, and the + default compilers are "traditional Unix interface" (:class:`UnixCCompiler` + class) and Visual C++ (:class:`MSVCCompiler` class). Note that it's perfectly + possible to ask for a Unix compiler object under Windows, and a Microsoft + compiler object under Unix---if you supply a value for *compiler*, *plat* is + ignored. + + .. % Is the posix/nt only thing still true? Mac OS X seems to work, and + .. % returns a UnixCCompiler instance. How to document this... hmm. + + +.. function:: show_compilers() + + Print list of available compilers (used by the :option:`!--help-compiler` options + to :command:`build`, :command:`build_ext`, :command:`build_clib`). + + +.. class:: CCompiler([verbose=0, dry_run=0, force=0]) + + The abstract base class :class:`CCompiler` defines the interface that must be + implemented by real compiler classes. The class also has some utility methods + used by several compiler classes. + + The basic idea behind a compiler abstraction class is that each instance can be + used for all the compile/link steps in building a single project. Thus, + attributes common to all of those compile and link steps --- include + directories, macros to define, libraries to link against, etc. --- are + attributes of the compiler instance. To allow for variability in how individual + files are treated, most of those attributes may be varied on a per-compilation + or per-link basis. + + The constructor for each subclass creates an instance of the Compiler object. + Flags are *verbose* (show verbose output), *dry_run* (don't actually execute the + steps) and *force* (rebuild everything, regardless of dependencies). All of + these flags default to ``0`` (off). Note that you probably don't want to + instantiate :class:`CCompiler` or one of its subclasses directly - use the + :func:`distutils.CCompiler.new_compiler` factory function instead. + + The following methods allow you to manually alter compiler options for the + instance of the Compiler class. + + + .. method:: CCompiler.add_include_dir(dir) + + Add *dir* to the list of directories that will be searched for header files. + The compiler is instructed to search directories in the order in which they are + supplied by successive calls to :meth:`add_include_dir`. + + + .. method:: CCompiler.set_include_dirs(dirs) + + Set the list of directories that will be searched to *dirs* (a list of strings). + Overrides any preceding calls to :meth:`add_include_dir`; subsequent calls to + :meth:`add_include_dir` add to the list passed to :meth:`set_include_dirs`. + This does not affect any list of standard include directories that the compiler + may search by default. + + + .. method:: CCompiler.add_library(libname) + + Add *libname* to the list of libraries that will be included in all links driven + by this compiler object. Note that *libname* should \*not\* be the name of a + file containing a library, but the name of the library itself: the actual + filename will be inferred by the linker, the compiler, or the compiler class + (depending on the platform). + + The linker will be instructed to link against libraries in the order they were + supplied to :meth:`add_library` and/or :meth:`set_libraries`. It is perfectly + valid to duplicate library names; the linker will be instructed to link against + libraries as many times as they are mentioned. + + + .. method:: CCompiler.set_libraries(libnames) + + Set the list of libraries to be included in all links driven by this compiler + object to *libnames* (a list of strings). This does not affect any standard + system libraries that the linker may include by default. + + + .. method:: CCompiler.add_library_dir(dir) + + Add *dir* to the list of directories that will be searched for libraries + specified to :meth:`add_library` and :meth:`set_libraries`. The linker will be + instructed to search for libraries in the order they are supplied to + :meth:`add_library_dir` and/or :meth:`set_library_dirs`. + + + .. method:: CCompiler.set_library_dirs(dirs) + + Set the list of library search directories to *dirs* (a list of strings). This + does not affect any standard library search path that the linker may search by + default. + + + .. method:: CCompiler.add_runtime_library_dir(dir) + + Add *dir* to the list of directories that will be searched for shared libraries + at runtime. + + + .. method:: CCompiler.set_runtime_library_dirs(dirs) + + Set the list of directories to search for shared libraries at runtime to *dirs* + (a list of strings). This does not affect any standard search path that the + runtime linker may search by default. + + + .. method:: CCompiler.define_macro(name[, value=None]) + + Define a preprocessor macro for all compilations driven by this compiler object. + The optional parameter *value* should be a string; if it is not supplied, then + the macro will be defined without an explicit value and the exact outcome + depends on the compiler used. + + .. XXX true? does ANSI say anything about this? + + + .. method:: CCompiler.undefine_macro(name) + + Undefine a preprocessor macro for all compilations driven by this compiler + object. If the same macro is defined by :meth:`define_macro` and + undefined by :meth:`undefine_macro` the last call takes precedence + (including multiple redefinitions or undefinitions). If the macro is + redefined/undefined on a per-compilation basis (ie. in the call to + :meth:`compile`), then that takes precedence. + + + .. method:: CCompiler.add_link_object(object) + + Add *object* to the list of object files (or analogues, such as explicitly named + library files or the output of "resource compilers") to be included in every + link driven by this compiler object. + + + .. method:: CCompiler.set_link_objects(objects) + + Set the list of object files (or analogues) to be included in every link to + *objects*. This does not affect any standard object files that the linker may + include by default (such as system libraries). + + The following methods implement methods for autodetection of compiler options, + providing some functionality similar to GNU :program:`autoconf`. + + + .. method:: CCompiler.detect_language(sources) + + Detect the language of a given file, or list of files. Uses the instance + attributes :attr:`language_map` (a dictionary), and :attr:`language_order` (a + list) to do the job. + + + .. method:: CCompiler.find_library_file(dirs, lib[, debug=0]) + + Search the specified list of directories for a static or shared library file + *lib* and return the full path to that file. If *debug* is true, look for a + debugging version (if that makes sense on the current platform). Return + ``None`` if *lib* wasn't found in any of the specified directories. + + + .. method:: CCompiler.has_function(funcname [, includes=None, include_dirs=None, libraries=None, library_dirs=None]) + + Return a boolean indicating whether *funcname* is supported on the current + platform. The optional arguments can be used to augment the compilation + environment by providing additional include files and paths and libraries and + paths. + + + .. method:: CCompiler.library_dir_option(dir) + + Return the compiler option to add *dir* to the list of directories searched for + libraries. + + + .. method:: CCompiler.library_option(lib) + + Return the compiler option to add *lib* to the list of libraries linked into the + shared library or executable. + + + .. method:: CCompiler.runtime_library_dir_option(dir) + + Return the compiler option to add *dir* to the list of directories searched for + runtime libraries. + + + .. method:: CCompiler.set_executables(**args) + + Define the executables (and options for them) that will be run to perform the + various stages of compilation. The exact set of executables that may be + specified here depends on the compiler class (via the 'executables' class + attribute), but most will have: + + +--------------+------------------------------------------+ + | attribute | description | + +==============+==========================================+ + | *compiler* | the C/C++ compiler | + +--------------+------------------------------------------+ + | *linker_so* | linker used to create shared objects and | + | | libraries | + +--------------+------------------------------------------+ + | *linker_exe* | linker used to create binary executables | + +--------------+------------------------------------------+ + | *archiver* | static library creator | + +--------------+------------------------------------------+ + + On platforms with a command-line (Unix, DOS/Windows), each of these is a string + that will be split into executable name and (optional) list of arguments. + (Splitting the string is done similarly to how Unix shells operate: words are + delimited by spaces, but quotes and backslashes can override this. See + :func:`distutils.util.split_quoted`.) + + The following methods invoke stages in the build process. + + + .. method:: CCompiler.compile(sources[, output_dir=None, macros=None, include_dirs=None, debug=0, extra_preargs=None, extra_postargs=None, depends=None]) + + Compile one or more source files. Generates object files (e.g. transforms a + :file:`.c` file to a :file:`.o` file.) + + *sources* must be a list of filenames, most likely C/C++ files, but in reality + anything that can be handled by a particular compiler and compiler class (eg. + :class:`MSVCCompiler` can handle resource files in *sources*). Return a list of + object filenames, one per source filename in *sources*. Depending on the + implementation, not all source files will necessarily be compiled, but all + corresponding object filenames will be returned. + + If *output_dir* is given, object files will be put under it, while retaining + their original path component. That is, :file:`foo/bar.c` normally compiles to + :file:`foo/bar.o` (for a Unix implementation); if *output_dir* is *build*, then + it would compile to :file:`build/foo/bar.o`. + + *macros*, if given, must be a list of macro definitions. A macro definition is + either a ``(name, value)`` 2-tuple or a ``(name,)`` 1-tuple. The former defines + a macro; if the value is ``None``, the macro is defined without an explicit + value. The 1-tuple case undefines a macro. Later + definitions/redefinitions/undefinitions take precedence. + + *include_dirs*, if given, must be a list of strings, the directories to add to + the default include file search path for this compilation only. + + *debug* is a boolean; if true, the compiler will be instructed to output debug + symbols in (or alongside) the object file(s). + + *extra_preargs* and *extra_postargs* are implementation-dependent. On platforms + that have the notion of a command-line (e.g. Unix, DOS/Windows), they are most + likely lists of strings: extra command-line arguments to prepend/append to the + compiler command line. On other platforms, consult the implementation class + documentation. In any event, they are intended as an escape hatch for those + occasions when the abstract compiler framework doesn't cut the mustard. + + *depends*, if given, is a list of filenames that all targets depend on. If a + source file is older than any file in depends, then the source file will be + recompiled. This supports dependency tracking, but only at a coarse + granularity. + + Raises :exc:`CompileError` on failure. + + + .. method:: CCompiler.create_static_lib(objects, output_libname[, output_dir=None, debug=0, target_lang=None]) + + Link a bunch of stuff together to create a static library file. The "bunch of + stuff" consists of the list of object files supplied as *objects*, the extra + object files supplied to :meth:`add_link_object` and/or + :meth:`set_link_objects`, the libraries supplied to :meth:`add_library` and/or + :meth:`set_libraries`, and the libraries supplied as *libraries* (if any). + + *output_libname* should be a library name, not a filename; the filename will be + inferred from the library name. *output_dir* is the directory where the library + file will be put. + + .. XXX defaults to what? + + *debug* is a boolean; if true, debugging information will be included in the + library (note that on most platforms, it is the compile step where this matters: + the *debug* flag is included here just for consistency). + + *target_lang* is the target language for which the given objects are being + compiled. This allows specific linkage time treatment of certain languages. + + Raises :exc:`LibError` on failure. + + + .. method:: CCompiler.link(target_desc, objects, output_filename[, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None, target_lang=None]) + + Link a bunch of stuff together to create an executable or shared library file. + + The "bunch of stuff" consists of the list of object files supplied as *objects*. + *output_filename* should be a filename. If *output_dir* is supplied, + *output_filename* is relative to it (i.e. *output_filename* can provide + directory components if needed). + + *libraries* is a list of libraries to link against. These are library names, + not filenames, since they're translated into filenames in a platform-specific + way (eg. *foo* becomes :file:`libfoo.a` on Unix and :file:`foo.lib` on + DOS/Windows). However, they can include a directory component, which means the + linker will look in that specific directory rather than searching all the normal + locations. + + *library_dirs*, if supplied, should be a list of directories to search for + libraries that were specified as bare library names (ie. no directory + component). These are on top of the system default and those supplied to + :meth:`add_library_dir` and/or :meth:`set_library_dirs`. *runtime_library_dirs* + is a list of directories that will be embedded into the shared library and used + to search for other shared libraries that \*it\* depends on at run-time. (This + may only be relevant on Unix.) + + *export_symbols* is a list of symbols that the shared library will export. + (This appears to be relevant only on Windows.) + + *debug* is as for :meth:`compile` and :meth:`create_static_lib`, with the + slight distinction that it actually matters on most platforms (as opposed to + :meth:`create_static_lib`, which includes a *debug* flag mostly for form's + sake). + + *extra_preargs* and *extra_postargs* are as for :meth:`compile` (except of + course that they supply command-line arguments for the particular linker being + used). + + *target_lang* is the target language for which the given objects are being + compiled. This allows specific linkage time treatment of certain languages. + + Raises :exc:`LinkError` on failure. + + + .. method:: CCompiler.link_executable(objects, output_progname[, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, debug=0, extra_preargs=None, extra_postargs=None, target_lang=None]) + + Link an executable. *output_progname* is the name of the file executable, while + *objects* are a list of object filenames to link in. Other arguments are as for + the :meth:`link` method. + + + .. method:: CCompiler.link_shared_lib(objects, output_libname[, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None, target_lang=None]) + + Link a shared library. *output_libname* is the name of the output library, + while *objects* is a list of object filenames to link in. Other arguments are + as for the :meth:`link` method. + + + .. method:: CCompiler.link_shared_object(objects, output_filename[, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None, target_lang=None]) + + Link a shared object. *output_filename* is the name of the shared object that + will be created, while *objects* is a list of object filenames to link in. + Other arguments are as for the :meth:`link` method. + + + .. method:: CCompiler.preprocess(source[, output_file=None, macros=None, include_dirs=None, extra_preargs=None, extra_postargs=None]) + + Preprocess a single C/C++ source file, named in *source*. Output will be written + to file named *output_file*, or *stdout* if *output_file* not supplied. + *macros* is a list of macro definitions as for :meth:`compile`, which will + augment the macros set with :meth:`define_macro` and :meth:`undefine_macro`. + *include_dirs* is a list of directory names that will be added to the default + list, in the same way as :meth:`add_include_dir`. + + Raises :exc:`PreprocessError` on failure. + + The following utility methods are defined by the :class:`CCompiler` class, for + use by the various concrete subclasses. + + + .. method:: CCompiler.executable_filename(basename[, strip_dir=0, output_dir='']) + + Returns the filename of the executable for the given *basename*. Typically for + non-Windows platforms this is the same as the basename, while Windows will get + a :file:`.exe` added. + + + .. method:: CCompiler.library_filename(libname[, lib_type='static', strip_dir=0, output_dir='']) + + Returns the filename for the given library name on the current platform. On Unix + a library with *lib_type* of ``'static'`` will typically be of the form + :file:`liblibname.a`, while a *lib_type* of ``'dynamic'`` will be of the form + :file:`liblibname.so`. + + + .. method:: CCompiler.object_filenames(source_filenames[, strip_dir=0, output_dir='']) + + Returns the name of the object files for the given source files. + *source_filenames* should be a list of filenames. + + + .. method:: CCompiler.shared_object_filename(basename[, strip_dir=0, output_dir='']) + + Returns the name of a shared object file for the given file name *basename*. + + + .. method:: CCompiler.execute(func, args[, msg=None, level=1]) + + Invokes :func:`distutils.util.execute`. This method invokes a Python function + *func* with the given arguments *args*, after logging and taking into account + the *dry_run* flag. + + + .. method:: CCompiler.spawn(cmd) + + Invokes :func:`distutils.util.spawn`. This invokes an external process to run + the given command. + + + .. method:: CCompiler.mkpath(name[, mode=511]) + + Invokes :func:`distutils.dir_util.mkpath`. This creates a directory and any + missing ancestor directories. + + + .. method:: CCompiler.move_file(src, dst) + + Invokes :meth:`distutils.file_util.move_file`. Renames *src* to *dst*. + + + .. method:: CCompiler.announce(msg[, level=1]) + + Write a message using :func:`distutils.log.debug`. + + + .. method:: CCompiler.warn(msg) + + Write a warning message *msg* to standard error. + + + .. method:: CCompiler.debug_print(msg) + + If the *debug* flag is set on this :class:`CCompiler` instance, print *msg* to + standard output, otherwise do nothing. + +.. % \subsection{Compiler-specific modules} +.. % +.. % The following modules implement concrete subclasses of the abstract +.. % \class{CCompiler} class. They should not be instantiated directly, but should +.. % be created using \function{distutils.ccompiler.new_compiler()} factory +.. % function. + + +:mod:`distutils.unixccompiler` --- Unix C Compiler +================================================== + +.. module:: distutils.unixccompiler + :synopsis: UNIX C Compiler + + +This module provides the :class:`UnixCCompiler` class, a subclass of +:class:`CCompiler` that handles the typical Unix-style command-line C compiler: + +* macros defined with :option:`!-Dname[=value]` + +* macros undefined with :option:`!-Uname` + +* include search directories specified with :option:`!-Idir` + +* libraries specified with :option:`!-llib` + +* library search directories specified with :option:`!-Ldir` + +* compile handled by :program:`cc` (or similar) executable with :option:`!-c` + option: compiles :file:`.c` to :file:`.o` + +* link static library handled by :program:`ar` command (possibly with + :program:`ranlib`) + +* link shared library handled by :program:`cc` :option:`!-shared` + + +:mod:`distutils.msvccompiler` --- Microsoft Compiler +==================================================== + +.. module:: distutils.msvccompiler + :synopsis: Microsoft Compiler + +.. XXX: This is *waaaaay* out of date! + +This module provides :class:`MSVCCompiler`, an implementation of the abstract +:class:`CCompiler` class for Microsoft Visual Studio. Typically, extension +modules need to be compiled with the same compiler that was used to compile +Python. For Python 2.3 and earlier, the compiler was Visual Studio 6. For Python +2.4 and 2.5, the compiler is Visual Studio .NET 2003. + +:class:`MSVCCompiler` will normally choose the right compiler, linker etc. on +its own. To override this choice, the environment variables *DISTUTILS_USE_SDK* +and *MSSdk* must be both set. *MSSdk* indicates that the current environment has +been setup by the SDK's ``SetEnv.Cmd`` script, or that the environment variables +had been registered when the SDK was installed; *DISTUTILS_USE_SDK* indicates +that the distutils user has made an explicit choice to override the compiler +selection by :class:`MSVCCompiler`. + + +:mod:`distutils.bcppcompiler` --- Borland Compiler +================================================== + +.. module:: distutils.bcppcompiler + + +This module provides :class:`BorlandCCompiler`, a subclass of the abstract +:class:`CCompiler` class for the Borland C++ compiler. + + +:mod:`distutils.cygwincompiler` --- Cygwin Compiler +=================================================== + +.. module:: distutils.cygwinccompiler + + +This module provides the :class:`CygwinCCompiler` class, a subclass of +:class:`UnixCCompiler` that handles the Cygwin port of the GNU C compiler to +Windows. It also contains the Mingw32CCompiler class which handles the mingw32 +port of GCC (same as cygwin in no-cygwin mode). + + +:mod:`distutils.archive_util` --- Archiving utilities +====================================================== + +.. module:: distutils.archive_util + :synopsis: Utility functions for creating archive files (tarballs, zip files, ...) + + +This module provides a few functions for creating archive files, such as +tarballs or zipfiles. + + +.. function:: make_archive(base_name, format[, root_dir=None, base_dir=None, verbose=0, dry_run=0]) + + Create an archive file (eg. ``zip`` or ``tar``). *base_name* is the name of + the file to create, minus any format-specific extension; *format* is the + archive format: one of ``zip``, ``tar``, ``gztar``, ``bztar``, ``xztar``, or + ``ztar``. *root_dir* is a directory that will be the root directory of the + archive; ie. we typically ``chdir`` into *root_dir* before creating the + archive. *base_dir* is the directory where we start archiving from; ie. + *base_dir* will be the common prefix of all files and directories in the + archive. *root_dir* and *base_dir* both default to the current directory. + Returns the name of the archive file. + + .. versionchanged:: 3.5 + Added support for the ``xztar`` format. + + +.. function:: make_tarball(base_name, base_dir[, compress='gzip', verbose=0, dry_run=0]) + + 'Create an (optional compressed) archive as a tar file from all files in and + under *base_dir*. *compress* must be ``'gzip'`` (the default), + ``'bzip2'``, ``'xz'``, ``'compress'``, or ``None``. For the ``'compress'`` + method the compression utility named by :program:`compress` must be on the + default program search path, so this is probably Unix-specific. The output + tar file will be named :file:`base_dir.tar`, possibly plus the appropriate + compression extension (``.gz``, ``.bz2``, ``.xz`` or ``.Z``). Return the + output filename. + + .. versionchanged:: 3.5 + Added support for the ``xz`` compression. + + +.. function:: make_zipfile(base_name, base_dir[, verbose=0, dry_run=0]) + + Create a zip file from all files in and under *base_dir*. The output zip file + will be named *base_name* + :file:`.zip`. Uses either the :mod:`zipfile` Python + module (if available) or the InfoZIP :file:`zip` utility (if installed and + found on the default search path). If neither tool is available, raises + :exc:`DistutilsExecError`. Returns the name of the output zip file. + + +:mod:`distutils.dep_util` --- Dependency checking +================================================= + +.. module:: distutils.dep_util + :synopsis: Utility functions for simple dependency checking + + +This module provides functions for performing simple, timestamp-based +dependency of files and groups of files; also, functions based entirely on such +timestamp dependency analysis. + + +.. function:: newer(source, target) + + Return true if *source* exists and is more recently modified than *target*, or + if *source* exists and *target* doesn't. Return false if both exist and *target* + is the same age or newer than *source*. Raise :exc:`DistutilsFileError` if + *source* does not exist. + + +.. function:: newer_pairwise(sources, targets) + + Walk two filename lists in parallel, testing if each source is newer than its + corresponding target. Return a pair of lists (*sources*, *targets*) where + source is newer than target, according to the semantics of :func:`newer`. + + .. % % equivalent to a listcomp... + + +.. function:: newer_group(sources, target[, missing='error']) + + Return true if *target* is out-of-date with respect to any file listed in + *sources*. In other words, if *target* exists and is newer than every file in + *sources*, return false; otherwise return true. *missing* controls what we do + when a source file is missing; the default (``'error'``) is to blow up with an + :exc:`OSError` from inside :func:`os.stat`; if it is ``'ignore'``, we silently + drop any missing source files; if it is ``'newer'``, any missing source files + make us assume that *target* is out-of-date (this is handy in "dry-run" mode: + it'll make you pretend to carry out commands that wouldn't work because inputs + are missing, but that doesn't matter because you're not actually going to run + the commands). + + +:mod:`distutils.dir_util` --- Directory tree operations +======================================================= + +.. module:: distutils.dir_util + :synopsis: Utility functions for operating on directories and directory trees + + +This module provides functions for operating on directories and trees of +directories. + + +.. function:: mkpath(name[, mode=0o777, verbose=0, dry_run=0]) + + Create a directory and any missing ancestor directories. If the directory + already exists (or if *name* is the empty string, which means the current + directory, which of course exists), then do nothing. Raise + :exc:`DistutilsFileError` if unable to create some directory along the way (eg. + some sub-path exists, but is a file rather than a directory). If *verbose* is + true, print a one-line summary of each mkdir to stdout. Return the list of + directories actually created. + + +.. function:: create_tree(base_dir, files[, mode=0o777, verbose=0, dry_run=0]) + + Create all the empty directories under *base_dir* needed to put *files* there. + *base_dir* is just the name of a directory which doesn't necessarily exist + yet; *files* is a list of filenames to be interpreted relative to *base_dir*. + *base_dir* + the directory portion of every file in *files* will be created if + it doesn't already exist. *mode*, *verbose* and *dry_run* flags are as for + :func:`mkpath`. + + +.. function:: copy_tree(src, dst[, preserve_mode=1, preserve_times=1, preserve_symlinks=0, update=0, verbose=0, dry_run=0]) + + Copy an entire directory tree *src* to a new location *dst*. Both *src* and + *dst* must be directory names. If *src* is not a directory, raise + :exc:`DistutilsFileError`. If *dst* does not exist, it is created with + :func:`mkpath`. The end result of the copy is that every file in *src* is + copied to *dst*, and directories under *src* are recursively copied to *dst*. + Return the list of files that were copied or might have been copied, using their + output name. The return value is unaffected by *update* or *dry_run*: it is + simply the list of all files under *src*, with the names changed to be under + *dst*. + + *preserve_mode* and *preserve_times* are the same as for + :func:`distutils.file_util.copy_file`; note that they only apply to + regular files, not to + directories. If *preserve_symlinks* is true, symlinks will be copied as + symlinks (on platforms that support them!); otherwise (the default), the + destination of the symlink will be copied. *update* and *verbose* are the same + as for :func:`copy_file`. + + Files in *src* that begin with :file:`.nfs` are skipped (more information on + these files is available in answer D2 of the `NFS FAQ page + `_). + + .. versionchanged:: 3.3.1 + NFS files are ignored. + +.. function:: remove_tree(directory[, verbose=0, dry_run=0]) + + Recursively remove *directory* and all files and directories underneath it. Any + errors are ignored (apart from being reported to ``sys.stdout`` if *verbose* is + true). + + +:mod:`distutils.file_util` --- Single file operations +===================================================== + +.. module:: distutils.file_util + :synopsis: Utility functions for operating on single files + + +This module contains some utility functions for operating on individual files. + + +.. function:: copy_file(src, dst[, preserve_mode=1, preserve_times=1, update=0, link=None, verbose=0, dry_run=0]) + + Copy file *src* to *dst*. If *dst* is a directory, then *src* is copied there + with the same name; otherwise, it must be a filename. (If the file exists, it + will be ruthlessly clobbered.) If *preserve_mode* is true (the default), the + file's mode (type and permission bits, or whatever is analogous on the + current platform) is copied. If *preserve_times* is true (the default), the + last-modified and last-access times are copied as well. If *update* is true, + *src* will only be copied if *dst* does not exist, or if *dst* does exist but + is older than *src*. + + *link* allows you to make hard links (using :func:`os.link`) or symbolic links + (using :func:`os.symlink`) instead of copying: set it to ``'hard'`` or + ``'sym'``; if it is ``None`` (the default), files are copied. Don't set *link* + on systems that don't support it: :func:`copy_file` doesn't check if hard or + symbolic linking is available. It uses :func:`_copy_file_contents` to copy file + contents. + + Return a tuple ``(dest_name, copied)``: *dest_name* is the actual name of the + output file, and *copied* is true if the file was copied (or would have been + copied, if *dry_run* true). + + .. % XXX if the destination file already exists, we clobber it if + .. % copying, but blow up if linking. Hmmm. And I don't know what + .. % macostools.copyfile() does. Should definitely be consistent, and + .. % should probably blow up if destination exists and we would be + .. % changing it (ie. it's not already a hard/soft link to src OR + .. % (not update) and (src newer than dst)). + + +.. function:: move_file(src, dst[, verbose, dry_run]) + + Move file *src* to *dst*. If *dst* is a directory, the file will be moved into + it with the same name; otherwise, *src* is just renamed to *dst*. Returns the + new full name of the file. + + .. warning:: + + Handles cross-device moves on Unix using :func:`copy_file`. What about + other systems? + + +.. function:: write_file(filename, contents) + + Create a file called *filename* and write *contents* (a sequence of strings + without line terminators) to it. + + +:mod:`distutils.util` --- Miscellaneous other utility functions +=============================================================== + +.. module:: distutils.util + :synopsis: Miscellaneous other utility functions + + +This module contains other assorted bits and pieces that don't fit into any +other utility module. + + +.. function:: get_platform() + + Return a string that identifies the current platform. This is used mainly to + distinguish platform-specific build directories and platform-specific built + distributions. Typically includes the OS name and version and the + architecture (as supplied by 'os.uname()'), although the exact information + included depends on the OS; e.g., on Linux, the kernel version isn't + particularly important. + + Examples of returned values: + + * ``linux-i586`` + * ``linux-alpha`` + * ``solaris-2.6-sun4u`` + + For non-POSIX platforms, currently just returns ``sys.platform``. + + For Mac OS X systems the OS version reflects the minimal version on which + binaries will run (that is, the value of ``MACOSX_DEPLOYMENT_TARGET`` + during the build of Python), not the OS version of the current system. + + For universal binary builds on Mac OS X the architecture value reflects + the universal binary status instead of the architecture of the current + processor. For 32-bit universal binaries the architecture is ``fat``, + for 64-bit universal binaries the architecture is ``fat64``, and + for 4-way universal binaries the architecture is ``universal``. Starting + from Python 2.7 and Python 3.2 the architecture ``fat3`` is used for + a 3-way universal build (ppc, i386, x86_64) and ``intel`` is used for + a universal build with the i386 and x86_64 architectures + + Examples of returned values on Mac OS X: + + * ``macosx-10.3-ppc`` + + * ``macosx-10.3-fat`` + + * ``macosx-10.5-universal`` + + * ``macosx-10.6-intel`` + + +.. function:: convert_path(pathname) + + Return 'pathname' as a name that will work on the native filesystem, i.e. split + it on '/' and put it back together again using the current directory separator. + Needed because filenames in the setup script are always supplied in Unix style, + and have to be converted to the local convention before we can actually use them + in the filesystem. Raises :exc:`ValueError` on non-Unix-ish systems if + *pathname* either starts or ends with a slash. + + +.. function:: change_root(new_root, pathname) + + Return *pathname* with *new_root* prepended. If *pathname* is relative, this is + equivalent to ``os.path.join(new_root,pathname)`` Otherwise, it requires making + *pathname* relative and then joining the two, which is tricky on DOS/Windows. + + +.. function:: check_environ() + + Ensure that 'os.environ' has all the environment variables we guarantee that + users can use in config files, command-line options, etc. Currently this + includes: + + * :envvar:`HOME` - user's home directory (Unix only) + * :envvar:`PLAT` - description of the current platform, including hardware and + OS (see :func:`get_platform`) + + +.. function:: subst_vars(s, local_vars) + + Perform shell/Perl-style variable substitution on *s*. Every occurrence of + ``$`` followed by a name is considered a variable, and variable is substituted + by the value found in the *local_vars* dictionary, or in ``os.environ`` if it's + not in *local_vars*. *os.environ* is first checked/augmented to guarantee that + it contains certain values: see :func:`check_environ`. Raise :exc:`ValueError` + for any variables not found in either *local_vars* or ``os.environ``. + + Note that this is not a fully-fledged string interpolation function. A valid + ``$variable`` can consist only of upper and lower case letters, numbers and an + underscore. No { } or ( ) style quoting is available. + + +.. function:: split_quoted(s) + + Split a string up according to Unix shell-like rules for quotes and backslashes. + In short: words are delimited by spaces, as long as those spaces are not escaped + by a backslash, or inside a quoted string. Single and double quotes are + equivalent, and the quote characters can be backslash-escaped. The backslash is + stripped from any two-character escape sequence, leaving only the escaped + character. The quote characters are stripped from any quoted string. Returns a + list of words. + + .. % Should probably be moved into the standard library. + + +.. function:: execute(func, args[, msg=None, verbose=0, dry_run=0]) + + Perform some action that affects the outside world (for instance, writing to the + filesystem). Such actions are special because they are disabled by the + *dry_run* flag. This method takes care of all that bureaucracy for you; all + you have to do is supply the function to call and an argument tuple for it (to + embody the "external action" being performed), and an optional message to print. + + +.. function:: strtobool(val) + + Convert a string representation of truth to true (1) or false (0). + + True values are ``y``, ``yes``, ``t``, ``true``, ``on`` and ``1``; false values + are ``n``, ``no``, ``f``, ``false``, ``off`` and ``0``. Raises + :exc:`ValueError` if *val* is anything else. + + +.. function:: byte_compile(py_files[, optimize=0, force=0, prefix=None, base_dir=None, verbose=1, dry_run=0, direct=None]) + + Byte-compile a collection of Python source files to :file:`.pyc` files in a + :file:`__pycache__` subdirectory (see :pep:`3147` and :pep:`488`). + *py_files* is a list of files to compile; any files that don't end in + :file:`.py` are silently skipped. *optimize* must be one of the following: + + * ``0`` - don't optimize + * ``1`` - normal optimization (like ``python -O``) + * ``2`` - extra optimization (like ``python -OO``) + + If *force* is true, all files are recompiled regardless of timestamps. + + The source filename encoded in each :term:`bytecode` file defaults to the filenames + listed in *py_files*; you can modify these with *prefix* and *basedir*. + *prefix* is a string that will be stripped off of each source filename, and + *base_dir* is a directory name that will be prepended (after *prefix* is + stripped). You can supply either or both (or neither) of *prefix* and + *base_dir*, as you wish. + + If *dry_run* is true, doesn't actually do anything that would affect the + filesystem. + + Byte-compilation is either done directly in this interpreter process with the + standard :mod:`py_compile` module, or indirectly by writing a temporary script + and executing it. Normally, you should let :func:`byte_compile` figure out to + use direct compilation or not (see the source for details). The *direct* flag + is used by the script generated in indirect mode; unless you know what you're + doing, leave it set to ``None``. + + .. versionchanged:: 3.2.3 + Create ``.pyc`` files with an :func:`import magic tag + ` in their name, in a :file:`__pycache__` subdirectory + instead of files without tag in the current directory. + + .. versionchanged:: 3.5 + Create ``.pyc`` files according to :pep:`488`. + + +.. function:: rfc822_escape(header) + + Return a version of *header* escaped for inclusion in an :rfc:`822` header, by + ensuring there are 8 spaces space after each newline. Note that it does no other + modification of the string. + + .. % this _can_ be replaced + +.. % \subsection{Distutils objects} + + +:mod:`distutils.dist` --- The Distribution class +================================================ + +.. module:: distutils.dist + :synopsis: Provides the Distribution class, which represents the module distribution being + built/installed/distributed + + +This module provides the :class:`~distutils.core.Distribution` class, which +represents the module distribution being built/installed/distributed. + + +:mod:`distutils.extension` --- The Extension class +================================================== + +.. module:: distutils.extension + :synopsis: Provides the Extension class, used to describe C/C++ extension modules in setup + scripts + + +This module provides the :class:`Extension` class, used to describe C/C++ +extension modules in setup scripts. + +.. % \subsection{Ungrouped modules} +.. % The following haven't been moved into a more appropriate section yet. + + +:mod:`distutils.debug` --- Distutils debug mode +=============================================== + +.. module:: distutils.debug + :synopsis: Provides the debug flag for distutils + + +This module provides the DEBUG flag. + + +:mod:`distutils.errors` --- Distutils exceptions +================================================ + +.. module:: distutils.errors + :synopsis: Provides standard distutils exceptions + + +Provides exceptions used by the Distutils modules. Note that Distutils modules +may raise standard exceptions; in particular, SystemExit is usually raised for +errors that are obviously the end-user's fault (eg. bad command-line arguments). + +This module is safe to use in ``from ... import *`` mode; it only exports +symbols whose names start with ``Distutils`` and end with ``Error``. + + +:mod:`distutils.fancy_getopt` --- Wrapper around the standard getopt module +=========================================================================== + +.. module:: distutils.fancy_getopt + :synopsis: Additional getopt functionality + + +This module provides a wrapper around the standard :mod:`getopt` module that +provides the following additional features: + +* short and long options are tied together + +* options have help strings, so :func:`fancy_getopt` could potentially create a + complete usage summary + +* options set attributes of a passed-in object + +* boolean options can have "negative aliases" --- eg. if :option:`!--quiet` is + the "negative alias" of :option:`!--verbose`, then :option:`!--quiet` on the + command line sets *verbose* to false. + +.. function:: fancy_getopt(options, negative_opt, object, args) + + Wrapper function. *options* is a list of ``(long_option, short_option, + help_string)`` 3-tuples as described in the constructor for + :class:`FancyGetopt`. *negative_opt* should be a dictionary mapping option names + to option names, both the key and value should be in the *options* list. + *object* is an object which will be used to store values (see the :meth:`getopt` + method of the :class:`FancyGetopt` class). *args* is the argument list. Will use + ``sys.argv[1:]`` if you pass ``None`` as *args*. + + +.. function:: wrap_text(text, width) + + Wraps *text* to less than *width* wide. + + +.. class:: FancyGetopt([option_table=None]) + + The option_table is a list of 3-tuples: ``(long_option, short_option, + help_string)`` + + If an option takes an argument, its *long_option* should have ``'='`` appended; + *short_option* should just be a single character, no ``':'`` in any case. + *short_option* should be ``None`` if a *long_option* doesn't have a + corresponding *short_option*. All option tuples must have long options. + +The :class:`FancyGetopt` class provides the following methods: + + +.. method:: FancyGetopt.getopt([args=None, object=None]) + + Parse command-line options in args. Store as attributes on *object*. + + If *args* is ``None`` or not supplied, uses ``sys.argv[1:]``. If *object* is + ``None`` or not supplied, creates a new :class:`OptionDummy` instance, stores + option values there, and returns a tuple ``(args, object)``. If *object* is + supplied, it is modified in place and :func:`getopt` just returns *args*; in + both cases, the returned *args* is a modified copy of the passed-in *args* list, + which is left untouched. + + .. % and args returned are? + + +.. method:: FancyGetopt.get_option_order() + + Returns the list of ``(option, value)`` tuples processed by the previous run of + :meth:`getopt` Raises :exc:`RuntimeError` if :meth:`getopt` hasn't been called + yet. + + +.. method:: FancyGetopt.generate_help([header=None]) + + Generate help text (a list of strings, one per suggested line of output) from + the option table for this :class:`FancyGetopt` object. + + If supplied, prints the supplied *header* at the top of the help. + + +:mod:`distutils.filelist` --- The FileList class +================================================ + +.. module:: distutils.filelist + :synopsis: The FileList class, used for poking about the file system and + building lists of files. + + +This module provides the :class:`FileList` class, used for poking about the +filesystem and building lists of files. + + +:mod:`distutils.log` --- Simple PEP 282-style logging +===================================================== + +.. module:: distutils.log + :synopsis: A simple logging mechanism, 282-style + + +:mod:`distutils.spawn` --- Spawn a sub-process +============================================== + +.. module:: distutils.spawn + :synopsis: Provides the spawn() function + + +This module provides the :func:`spawn` function, a front-end to various +platform-specific functions for launching another program in a sub-process. +Also provides :func:`find_executable` to search the path for a given executable +name. + + +:mod:`distutils.sysconfig` --- System configuration information +=============================================================== + +.. module:: distutils.sysconfig + :synopsis: Low-level access to configuration information of the Python interpreter. +.. moduleauthor:: Fred L. Drake, Jr. +.. moduleauthor:: Greg Ward +.. sectionauthor:: Fred L. Drake, Jr. + + +The :mod:`distutils.sysconfig` module provides access to Python's low-level +configuration information. The specific configuration variables available +depend heavily on the platform and configuration. The specific variables depend +on the build process for the specific version of Python being run; the variables +are those found in the :file:`Makefile` and configuration header that are +installed with Python on Unix systems. The configuration header is called +:file:`pyconfig.h` for Python versions starting with 2.2, and :file:`config.h` +for earlier versions of Python. + +Some additional functions are provided which perform some useful manipulations +for other parts of the :mod:`distutils` package. + + +.. data:: PREFIX + + The result of ``os.path.normpath(sys.prefix)``. + + +.. data:: EXEC_PREFIX + + The result of ``os.path.normpath(sys.exec_prefix)``. + + +.. function:: get_config_var(name) + + Return the value of a single variable. This is equivalent to + ``get_config_vars().get(name)``. + + +.. function:: get_config_vars(...) + + Return a set of variable definitions. If there are no arguments, this returns a + dictionary mapping names of configuration variables to values. If arguments are + provided, they should be strings, and the return value will be a sequence giving + the associated values. If a given name does not have a corresponding value, + ``None`` will be included for that variable. + + +.. function:: get_config_h_filename() + + Return the full path name of the configuration header. For Unix, this will be + the header generated by the :program:`configure` script; for other platforms the + header will have been supplied directly by the Python source distribution. The + file is a platform-specific text file. + + +.. function:: get_makefile_filename() + + Return the full path name of the :file:`Makefile` used to build Python. For + Unix, this will be a file generated by the :program:`configure` script; the + meaning for other platforms will vary. The file is a platform-specific text + file, if it exists. This function is only useful on POSIX platforms. + + +.. function:: get_python_inc([plat_specific[, prefix]]) + + Return the directory for either the general or platform-dependent C include + files. If *plat_specific* is true, the platform-dependent include directory is + returned; if false or omitted, the platform-independent directory is returned. + If *prefix* is given, it is used as either the prefix instead of + :const:`PREFIX`, or as the exec-prefix instead of :const:`EXEC_PREFIX` if + *plat_specific* is true. + + +.. function:: get_python_lib([plat_specific[, standard_lib[, prefix]]]) + + Return the directory for either the general or platform-dependent library + installation. If *plat_specific* is true, the platform-dependent include + directory is returned; if false or omitted, the platform-independent directory + is returned. If *prefix* is given, it is used as either the prefix instead of + :const:`PREFIX`, or as the exec-prefix instead of :const:`EXEC_PREFIX` if + *plat_specific* is true. If *standard_lib* is true, the directory for the + standard library is returned rather than the directory for the installation of + third-party extensions. + +The following function is only intended for use within the :mod:`distutils` +package. + + +.. function:: customize_compiler(compiler) + + Do any platform-specific customization of a + :class:`distutils.ccompiler.CCompiler` instance. + + This function is only needed on Unix at this time, but should be called + consistently to support forward-compatibility. It inserts the information that + varies across Unix flavors and is stored in Python's :file:`Makefile`. This + information includes the selected compiler, compiler and linker options, and the + extension used by the linker for shared objects. + +This function is even more special-purpose, and should only be used from +Python's own build procedures. + + +.. function:: set_python_build() + + Inform the :mod:`distutils.sysconfig` module that it is being used as part of + the build process for Python. This changes a lot of relative locations for + files, allowing them to be located in the build area rather than in an installed + Python. + + +:mod:`distutils.text_file` --- The TextFile class +================================================= + +.. module:: distutils.text_file + :synopsis: provides the TextFile class, a simple interface to text files + + +This module provides the :class:`TextFile` class, which gives an interface to +text files that (optionally) takes care of stripping comments, ignoring blank +lines, and joining lines with backslashes. + + +.. class:: TextFile([filename=None, file=None, **options]) + + This class provides a file-like object that takes care of all the things you + commonly want to do when processing a text file that has some line-by-line + syntax: strip comments (as long as ``#`` is your comment character), skip blank + lines, join adjacent lines by escaping the newline (ie. backslash at end of + line), strip leading and/or trailing whitespace. All of these are optional and + independently controllable. + + The class provides a :meth:`warn` method so you can generate warning messages + that report physical line number, even if the logical line in question spans + multiple physical lines. Also provides :meth:`unreadline` for implementing + line-at-a-time lookahead. + + :class:`TextFile` instances are create with either *filename*, *file*, or both. + :exc:`RuntimeError` is raised if both are ``None``. *filename* should be a + string, and *file* a file object (or something that provides :meth:`readline` + and :meth:`close` methods). It is recommended that you supply at least + *filename*, so that :class:`TextFile` can include it in warning messages. If + *file* is not supplied, :class:`TextFile` creates its own using the + :func:`open` built-in function. + + The options are all boolean, and affect the values returned by :meth:`readline` + + .. tabularcolumns:: |l|L|l| + + +------------------+--------------------------------+---------+ + | option name | description | default | + +==================+================================+=========+ + | *strip_comments* | strip from ``'#'`` to | true | + | | end-of-line, as well as any | | + | | whitespace leading up to the | | + | | ``'#'``\ ---unless it is | | + | | escaped by a backslash | | + +------------------+--------------------------------+---------+ + | *lstrip_ws* | strip leading whitespace from | false | + | | each line before returning it | | + +------------------+--------------------------------+---------+ + | *rstrip_ws* | strip trailing whitespace | true | + | | (including line terminator!) | | + | | from each line before | | + | | returning it. | | + +------------------+--------------------------------+---------+ + | *skip_blanks* | skip lines that are empty | true | + | | \*after\* stripping comments | | + | | and whitespace. (If both | | + | | lstrip_ws and rstrip_ws are | | + | | false, then some lines may | | + | | consist of solely whitespace: | | + | | these will \*not\* be skipped, | | + | | even if *skip_blanks* is | | + | | true.) | | + +------------------+--------------------------------+---------+ + | *join_lines* | if a backslash is the last | false | + | | non-newline character on a | | + | | line after stripping comments | | + | | and whitespace, join the | | + | | following line to it to form | | + | | one logical line; if N | | + | | consecutive lines end with a | | + | | backslash, then N+1 physical | | + | | lines will be joined to form | | + | | one logical line. | | + +------------------+--------------------------------+---------+ + | *collapse_join* | strip leading whitespace from | false | + | | lines that are joined to their | | + | | predecessor; only matters if | | + | | ``(join_lines and not | | + | | lstrip_ws)`` | | + +------------------+--------------------------------+---------+ + + Note that since *rstrip_ws* can strip the trailing newline, the semantics of + :meth:`readline` must differ from those of the built-in file object's + :meth:`readline` method! In particular, :meth:`readline` returns ``None`` for + end-of-file: an empty string might just be a blank line (or an all-whitespace + line), if *rstrip_ws* is true but *skip_blanks* is not. + + + .. method:: TextFile.open(filename) + + Open a new file *filename*. This overrides any *file* or *filename* + constructor arguments. + + + .. method:: TextFile.close() + + Close the current file and forget everything we know about it (including the + filename and the current line number). + + + .. method:: TextFile.warn(msg[,line=None]) + + Print (to stderr) a warning message tied to the current logical line in the + current file. If the current logical line in the file spans multiple physical + lines, the warning refers to the whole range, such as ``"lines 3-5"``. If + *line* is supplied, it overrides the current line number; it may be a list or + tuple to indicate a range of physical lines, or an integer for a single + physical line. + + + .. method:: TextFile.readline() + + Read and return a single logical line from the current file (or from an internal + buffer if lines have previously been "unread" with :meth:`unreadline`). If the + *join_lines* option is true, this may involve reading multiple physical lines + concatenated into a single string. Updates the current line number, so calling + :meth:`warn` after :meth:`readline` emits a warning about the physical line(s) + just read. Returns ``None`` on end-of-file, since the empty string can occur + if *rstrip_ws* is true but *strip_blanks* is not. + + + .. method:: TextFile.readlines() + + Read and return the list of all logical lines remaining in the current file. + This updates the current line number to the last line of the file. + + + .. method:: TextFile.unreadline(line) + + Push *line* (a string) onto an internal buffer that will be checked by future + :meth:`readline` calls. Handy for implementing a parser with line-at-a-time + lookahead. Note that lines that are "unread" with :meth:`unreadline` are not + subsequently re-cleansed (whitespace stripped, or whatever) when read with + :meth:`readline`. If multiple calls are made to :meth:`unreadline` before a call + to :meth:`readline`, the lines will be returned most in most recent first order. + + +:mod:`distutils.version` --- Version number classes +=================================================== + +.. module:: distutils.version + :synopsis: implements classes that represent module version numbers. + + +.. % todo +.. % \section{Distutils Commands} +.. % +.. % This part of Distutils implements the various Distutils commands, such +.. % as \code{build}, \code{install} \&c. Each command is implemented as a +.. % separate module, with the command name as the name of the module. + + +:mod:`distutils.cmd` --- Abstract base class for Distutils commands +=================================================================== + +.. module:: distutils.cmd + :synopsis: This module provides the abstract base class Command. This class + is subclassed by the modules in the distutils.command subpackage. + + +This module supplies the abstract base class :class:`Command`. + + +.. class:: Command(dist) + + Abstract base class for defining command classes, the "worker bees" of the + Distutils. A useful analogy for command classes is to think of them as + subroutines with local variables called *options*. The options are declared + in :meth:`initialize_options` and defined (given their final values) in + :meth:`finalize_options`, both of which must be defined by every command + class. The distinction between the two is necessary because option values + might come from the outside world (command line, config file, ...), and any + options dependent on other options must be computed after these outside + influences have been processed --- hence :meth:`finalize_options`. The body + of the subroutine, where it does all its work based on the values of its + options, is the :meth:`run` method, which must also be implemented by every + command class. + + The class constructor takes a single argument *dist*, a + :class:`~distutils.core.Distribution` instance. + + +Creating a new Distutils command +================================ + +This section outlines the steps to create a new Distutils command. + +A new command lives in a module in the :mod:`distutils.command` package. There +is a sample template in that directory called :file:`command_template`. Copy +this file to a new module with the same name as the new command you're +implementing. This module should implement a class with the same name as the +module (and the command). So, for instance, to create the command +``peel_banana`` (so that users can run ``setup.py peel_banana``), you'd copy +:file:`command_template` to :file:`distutils/command/peel_banana.py`, then edit +it so that it's implementing the class :class:`peel_banana`, a subclass of +:class:`distutils.cmd.Command`. + +Subclasses of :class:`Command` must define the following methods. + +.. method:: Command.initialize_options() + + Set default values for all the options that this command supports. Note that + these defaults may be overridden by other commands, by the setup script, by + config files, or by the command-line. Thus, this is not the place to code + dependencies between options; generally, :meth:`initialize_options` + implementations are just a bunch of ``self.foo = None`` assignments. + + +.. method:: Command.finalize_options() + + Set final values for all the options that this command supports. This is + always called as late as possible, ie. after any option assignments from the + command-line or from other commands have been done. Thus, this is the place + to code option dependencies: if *foo* depends on *bar*, then it is safe to + set *foo* from *bar* as long as *foo* still has the same value it was + assigned in :meth:`initialize_options`. + + +.. method:: Command.run() + + A command's raison d'etre: carry out the action it exists to perform, controlled + by the options initialized in :meth:`initialize_options`, customized by other + commands, the setup script, the command-line, and config files, and finalized in + :meth:`finalize_options`. All terminal output and filesystem interaction should + be done by :meth:`run`. + + +.. attribute:: Command.sub_commands + + *sub_commands* formalizes the notion of a "family" of commands, + e.g. ``install`` as the parent with sub-commands ``install_lib``, + ``install_headers``, etc. The parent of a family of commands defines + *sub_commands* as a class attribute; it's a list of 2-tuples ``(command_name, + predicate)``, with *command_name* a string and *predicate* a function, a + string or ``None``. *predicate* is a method of the parent command that + determines whether the corresponding command is applicable in the current + situation. (E.g. ``install_headers`` is only applicable if we have any C + header files to install.) If *predicate* is ``None``, that command is always + applicable. + + *sub_commands* is usually defined at the *end* of a class, because + predicates can be methods of the class, so they must already have been + defined. The canonical example is the :command:`install` command. + + +:mod:`distutils.command` --- Individual Distutils commands +========================================================== + +.. module:: distutils.command + :synopsis: This subpackage contains one module for each standard Distutils command. + + +.. % \subsubsection{Individual Distutils commands} +.. % todo + + +:mod:`distutils.command.bdist` --- Build a binary installer +=========================================================== + +.. module:: distutils.command.bdist + :synopsis: Build a binary installer for a package + + +.. % todo + + +:mod:`distutils.command.bdist_packager` --- Abstract base class for packagers +============================================================================= + +.. module:: distutils.command.bdist_packager + :synopsis: Abstract base class for packagers + + +.. % todo + + +:mod:`distutils.command.bdist_dumb` --- Build a "dumb" installer +================================================================ + +.. module:: distutils.command.bdist_dumb + :synopsis: Build a "dumb" installer - a simple archive of files + + +.. % todo + + +:mod:`distutils.command.bdist_msi` --- Build a Microsoft Installer binary package +================================================================================= + +.. module:: distutils.command.bdist_msi + :synopsis: Build a binary distribution as a Windows MSI file + +.. class:: bdist_msi + + Builds a `Windows Installer`_ (.msi) binary package. + + .. _Windows Installer: https://msdn.microsoft.com/en-us/library/cc185688(VS.85).aspx + + In most cases, the ``bdist_msi`` installer is a better choice than the + ``bdist_wininst`` installer, because it provides better support for + Win64 platforms, allows administrators to perform non-interactive + installations, and allows installation through group policies. + + +:mod:`distutils.command.bdist_rpm` --- Build a binary distribution as a Redhat RPM and SRPM +=========================================================================================== + +.. module:: distutils.command.bdist_rpm + :synopsis: Build a binary distribution as a Redhat RPM and SRPM + + +.. % todo + + +:mod:`distutils.command.bdist_wininst` --- Build a Windows installer +==================================================================== + +.. module:: distutils.command.bdist_wininst + :synopsis: Build a Windows installer + + +.. % todo + + +:mod:`distutils.command.sdist` --- Build a source distribution +============================================================== + +.. module:: distutils.command.sdist + :synopsis: Build a source distribution + + +.. % todo + + +:mod:`distutils.command.build` --- Build all files of a package +=============================================================== + +.. module:: distutils.command.build + :synopsis: Build all files of a package + + +.. % todo + + +:mod:`distutils.command.build_clib` --- Build any C libraries in a package +========================================================================== + +.. module:: distutils.command.build_clib + :synopsis: Build any C libraries in a package + + +.. % todo + + +:mod:`distutils.command.build_ext` --- Build any extensions in a package +======================================================================== + +.. module:: distutils.command.build_ext + :synopsis: Build any extensions in a package + + +.. % todo + + +:mod:`distutils.command.build_py` --- Build the .py/.pyc files of a package +=========================================================================== + +.. module:: distutils.command.build_py + :synopsis: Build the .py/.pyc files of a package + + +.. class:: build_py + +.. class:: build_py_2to3 + + Alternative implementation of build_py which also runs the + 2to3 conversion library on each .py file that is going to be + installed. To use this in a setup.py file for a distribution + 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 + except ImportError: + from distutils.command.build_py import build_py + + to your setup.py, and later:: + + cmdclass = {'build_py': build_py} + + to the invocation of setup(). + + +:mod:`distutils.command.build_scripts` --- Build the scripts of a package +========================================================================= + +.. module:: distutils.command.build_scripts + :synopsis: Build the scripts of a package + + +.. % todo + + +:mod:`distutils.command.clean` --- Clean a package build area +============================================================= + +.. module:: distutils.command.clean + :synopsis: Clean a package build area + +This command removes the temporary files created by :command:`build` +and its subcommands, like intermediary compiled object files. With +the ``--all`` option, the complete build directory will be removed. + +Extension modules built :ref:`in place ` +will not be cleaned, as they are not in the build directory. + + +:mod:`distutils.command.config` --- Perform package configuration +================================================================= + +.. module:: distutils.command.config + :synopsis: Perform package configuration + + +.. % todo + + +:mod:`distutils.command.install` --- Install a package +====================================================== + +.. module:: distutils.command.install + :synopsis: Install a package + + +.. % todo + + +:mod:`distutils.command.install_data` --- Install data files from a package +=========================================================================== + +.. module:: distutils.command.install_data + :synopsis: Install data files from a package + + +.. % todo + + +:mod:`distutils.command.install_headers` --- Install C/C++ header files from a package +====================================================================================== + +.. module:: distutils.command.install_headers + :synopsis: Install C/C++ header files from a package + + +.. % todo + + +:mod:`distutils.command.install_lib` --- Install library files from a package +============================================================================= + +.. module:: distutils.command.install_lib + :synopsis: Install library files from a package + + +.. % todo + + +:mod:`distutils.command.install_scripts` --- Install script files from a package +================================================================================ + +.. module:: distutils.command.install_scripts + :synopsis: Install script files from a package + + +.. % todo + + +:mod:`distutils.command.register` --- Register a module with the Python Package Index +===================================================================================== + +.. module:: distutils.command.register + :synopsis: Register a module with the Python Package Index + + +The ``register`` command registers the package with the Python Package Index. +This is described in more detail in :pep:`301`. + +.. % todo + + +:mod:`distutils.command.check` --- Check the meta-data of a package +=================================================================== + +.. module:: distutils.command.check + :synopsis: Check the metadata of a package + + +The ``check`` command performs some tests on the meta-data of a package. +For example, it verifies that all required meta-data are provided as +the arguments passed to the :func:`setup` function. + +.. % todo diff --git a/python-3.7.4-docs-html/_sources/distutils/builtdist.rst.txt b/python-3.7.4-docs-html/_sources/distutils/builtdist.rst.txt new file mode 100644 index 0000000..0a83f8b --- /dev/null +++ b/python-3.7.4-docs-html/_sources/distutils/builtdist.rst.txt @@ -0,0 +1,459 @@ +.. _built-dist: + +**************************** +Creating Built Distributions +**************************** + +A "built distribution" is what you're probably used to thinking of either as a +"binary package" or an "installer" (depending on your background). It's not +necessarily binary, though, because it might contain only Python source code +and/or byte-code; and we don't call it a package, because that word is already +spoken for in Python. (And "installer" is a term specific to the world of +mainstream desktop systems.) + +A built distribution is how you make life as easy as possible for installers of +your module distribution: for users of RPM-based Linux systems, it's a binary +RPM; for Windows users, it's an executable installer; for Debian-based Linux +users, it's a Debian package; and so forth. Obviously, no one person will be +able to create built distributions for every platform under the sun, so the +Distutils are designed to enable module developers to concentrate on their +specialty---writing code and creating source distributions---while an +intermediary species called *packagers* springs up to turn source distributions +into built distributions for as many platforms as there are packagers. + +Of course, the module developer could be their own packager; or the packager could +be a volunteer "out there" somewhere who has access to a platform which the +original developer does not; or it could be software periodically grabbing new +source distributions and turning them into built distributions for as many +platforms as the software has access to. Regardless of who they are, a packager +uses the setup script and the :command:`bdist` command family to generate built +distributions. + +As a simple example, if I run the following command in the Distutils source +tree:: + + python setup.py bdist + +then the Distutils builds my module distribution (the Distutils itself in this +case), does a "fake" installation (also in the :file:`build` directory), and +creates the default type of built distribution for my platform. The default +format for built distributions is a "dumb" tar file on Unix, and a simple +executable installer on Windows. (That tar file is considered "dumb" because it +has to be unpacked in a specific location to work.) + +Thus, the above command on a Unix system creates +:file:`Distutils-1.0.{plat}.tar.gz`; unpacking this tarball from the right place +installs the Distutils just as though you had downloaded the source distribution +and run ``python setup.py install``. (The "right place" is either the root of +the filesystem or Python's :file:`{prefix}` directory, depending on the options +given to the :command:`bdist_dumb` command; the default is to make dumb +distributions relative to :file:`{prefix}`.) + +Obviously, for pure Python distributions, this isn't any simpler than just +running ``python setup.py install``\ ---but for non-pure distributions, which +include extensions that would need to be compiled, it can mean the difference +between someone being able to use your extensions or not. And creating "smart" +built distributions, such as an RPM package or an executable installer for +Windows, is far more convenient for users even if your distribution doesn't +include any extensions. + +The :command:`bdist` command has a :option:`!--formats` option, similar to the +:command:`sdist` command, which you can use to select the types of built +distribution to generate: for example, :: + + python setup.py bdist --format=zip + +would, when run on a Unix system, create +:file:`Distutils-1.0.{plat}.zip`\ ---again, this archive would be unpacked +from the root directory to install the Distutils. + +The available formats for built distributions are: + ++-------------+------------------------------+---------+ +| Format | Description | Notes | ++=============+==============================+=========+ +| ``gztar`` | gzipped tar file | \(1) | +| | (:file:`.tar.gz`) | | ++-------------+------------------------------+---------+ +| ``bztar`` | bzipped tar file | | +| | (:file:`.tar.bz2`) | | ++-------------+------------------------------+---------+ +| ``xztar`` | xzipped tar file | | +| | (:file:`.tar.xz`) | | ++-------------+------------------------------+---------+ +| ``ztar`` | compressed tar file | \(3) | +| | (:file:`.tar.Z`) | | ++-------------+------------------------------+---------+ +| ``tar`` | tar file (:file:`.tar`) | | ++-------------+------------------------------+---------+ +| ``zip`` | zip file (:file:`.zip`) | (2),(4) | ++-------------+------------------------------+---------+ +| ``rpm`` | RPM | \(5) | ++-------------+------------------------------+---------+ +| ``pkgtool`` | Solaris :program:`pkgtool` | | ++-------------+------------------------------+---------+ +| ``sdux`` | HP-UX :program:`swinstall` | | ++-------------+------------------------------+---------+ +| ``wininst`` | self-extracting ZIP file for | \(4) | +| | Windows | | ++-------------+------------------------------+---------+ +| ``msi`` | Microsoft Installer. | | ++-------------+------------------------------+---------+ + +.. versionchanged:: 3.5 + Added support for the ``xztar`` format. + + +Notes: + +(1) + default on Unix + +(2) + default on Windows + +(3) + requires external :program:`compress` utility. + +(4) + requires either external :program:`zip` utility or :mod:`zipfile` module (part + of the standard Python library since Python 1.6) + +(5) + requires external :program:`rpm` utility, version 3.0.4 or better (use ``rpm + --version`` to find out which version you have) + +You don't have to use the :command:`bdist` command with the :option:`!--formats` +option; you can also use the command that directly implements the format you're +interested in. Some of these :command:`bdist` "sub-commands" actually generate +several similar formats; for instance, the :command:`bdist_dumb` command +generates all the "dumb" archive formats (``tar``, ``gztar``, ``bztar``, +``xztar``, ``ztar``, and ``zip``), and :command:`bdist_rpm` generates both +binary and source RPMs. The :command:`bdist` sub-commands, and the formats +generated by each, are: + ++--------------------------+-------------------------------------+ +| Command | Formats | ++==========================+=====================================+ +| :command:`bdist_dumb` | tar, gztar, bztar, xztar, ztar, zip | ++--------------------------+-------------------------------------+ +| :command:`bdist_rpm` | rpm, srpm | ++--------------------------+-------------------------------------+ +| :command:`bdist_wininst` | wininst | ++--------------------------+-------------------------------------+ +| :command:`bdist_msi` | msi | ++--------------------------+-------------------------------------+ + +The following sections give details on the individual :command:`bdist_\*` +commands. + + +.. .. _creating-dumb: + +.. Creating dumb built distributions +.. ================================= + +.. XXX Need to document absolute vs. prefix-relative packages here, but first + I have to implement it! + + +.. _creating-rpms: + +Creating RPM packages +===================== + +The RPM format is used by many popular Linux distributions, including Red Hat, +SuSE, and Mandrake. If one of these (or any of the other RPM-based Linux +distributions) is your usual environment, creating RPM packages for other users +of that same distribution is trivial. Depending on the complexity of your module +distribution and differences between Linux distributions, you may also be able +to create RPMs that work on different RPM-based distributions. + +The usual way to create an RPM of your module distribution is to run the +:command:`bdist_rpm` command:: + + python setup.py bdist_rpm + +or the :command:`bdist` command with the :option:`!--format` option:: + + python setup.py bdist --formats=rpm + +The former allows you to specify RPM-specific options; the latter allows you to +easily specify multiple formats in one run. If you need to do both, you can +explicitly specify multiple :command:`bdist_\*` commands and their options:: + + python setup.py bdist_rpm --packager="John Doe " \ + bdist_wininst --target-version="2.0" + +Creating RPM packages is driven by a :file:`.spec` file, much as using the +Distutils is driven by the setup script. To make your life easier, the +:command:`bdist_rpm` command normally creates a :file:`.spec` file based on the +information you supply in the setup script, on the command line, and in any +Distutils configuration files. Various options and sections in the +:file:`.spec` file are derived from options in the setup script as follows: + ++------------------------------------------+----------------------------------------------+ +| RPM :file:`.spec` file option or section | Distutils setup script option | ++==========================================+==============================================+ +| Name | ``name`` | ++------------------------------------------+----------------------------------------------+ +| Summary (in preamble) | ``description`` | ++------------------------------------------+----------------------------------------------+ +| Version | ``version`` | ++------------------------------------------+----------------------------------------------+ +| Vendor | ``author`` and ``author_email``, | +| | or --- & ``maintainer`` and | +| | ``maintainer_email`` | ++------------------------------------------+----------------------------------------------+ +| Copyright | ``license`` | ++------------------------------------------+----------------------------------------------+ +| Url | ``url`` | ++------------------------------------------+----------------------------------------------+ +| %description (section) | ``long_description`` | ++------------------------------------------+----------------------------------------------+ + +Additionally, there are many options in :file:`.spec` files that don't have +corresponding options in the setup script. Most of these are handled through +options to the :command:`bdist_rpm` command as follows: + ++-------------------------------+-----------------------------+-------------------------+ +| RPM :file:`.spec` file option | :command:`bdist_rpm` option | default value | +| or section | | | ++===============================+=============================+=========================+ +| Release | ``release`` | "1" | ++-------------------------------+-----------------------------+-------------------------+ +| Group | ``group`` | "Development/Libraries" | ++-------------------------------+-----------------------------+-------------------------+ +| Vendor | ``vendor`` | (see above) | ++-------------------------------+-----------------------------+-------------------------+ +| Packager | ``packager`` | (none) | ++-------------------------------+-----------------------------+-------------------------+ +| Provides | ``provides`` | (none) | ++-------------------------------+-----------------------------+-------------------------+ +| Requires | ``requires`` | (none) | ++-------------------------------+-----------------------------+-------------------------+ +| Conflicts | ``conflicts`` | (none) | ++-------------------------------+-----------------------------+-------------------------+ +| Obsoletes | ``obsoletes`` | (none) | ++-------------------------------+-----------------------------+-------------------------+ +| Distribution | ``distribution_name`` | (none) | ++-------------------------------+-----------------------------+-------------------------+ +| BuildRequires | ``build_requires`` | (none) | ++-------------------------------+-----------------------------+-------------------------+ +| Icon | ``icon`` | (none) | ++-------------------------------+-----------------------------+-------------------------+ + +Obviously, supplying even a few of these options on the command-line would be +tedious and error-prone, so it's usually best to put them in the setup +configuration file, :file:`setup.cfg`\ ---see section :ref:`setup-config`. If +you distribute or package many Python module distributions, you might want to +put options that apply to all of them in your personal Distutils configuration +file (:file:`~/.pydistutils.cfg`). If you want to temporarily disable +this file, you can pass the :option:`!--no-user-cfg` option to :file:`setup.py`. + +There are three steps to building a binary RPM package, all of which are +handled automatically by the Distutils: + +#. create a :file:`.spec` file, which describes the package (analogous to the + Distutils setup script; in fact, much of the information in the setup script + winds up in the :file:`.spec` file) + +#. create the source RPM + +#. create the "binary" RPM (which may or may not contain binary code, depending + on whether your module distribution contains Python extensions) + +Normally, RPM bundles the last two steps together; when you use the Distutils, +all three steps are typically bundled together. + +If you wish, you can separate these three steps. You can use the +:option:`!--spec-only` option to make :command:`bdist_rpm` just create the +:file:`.spec` file and exit; in this case, the :file:`.spec` file will be +written to the "distribution directory"---normally :file:`dist/`, but +customizable with the :option:`!--dist-dir` option. (Normally, the :file:`.spec` +file winds up deep in the "build tree," in a temporary directory created by +:command:`bdist_rpm`.) + +.. % \XXX{this isn't implemented yet---is it needed?!} +.. % You can also specify a custom \file{.spec} file with the +.. % \longprogramopt{spec-file} option; used in conjunction with +.. % \longprogramopt{spec-only}, this gives you an opportunity to customize +.. % the \file{.spec} file manually: +.. % +.. % \ begin{verbatim} +.. % > python setup.py bdist_rpm --spec-only +.. % # ...edit dist/FooBar-1.0.spec +.. % > python setup.py bdist_rpm --spec-file=dist/FooBar-1.0.spec +.. % \ end{verbatim} +.. % +.. % (Although a better way to do this is probably to override the standard +.. % \command{bdist\_rpm} command with one that writes whatever else you want +.. % to the \file{.spec} file.) + + +.. _creating-wininst: + +Creating Windows Installers +=========================== + +Executable installers are the natural format for binary distributions on +Windows. They display a nice graphical user interface, display some information +about the module distribution to be installed taken from the metadata in the +setup script, let the user select a few options, and start or cancel the +installation. + +Since the metadata is taken from the setup script, creating Windows installers +is usually as easy as running:: + + python setup.py bdist_wininst + +or the :command:`bdist` command with the :option:`!--formats` option:: + + python setup.py bdist --formats=wininst + +If you have a pure module distribution (only containing pure Python modules and +packages), the resulting installer will be version independent and have a name +like :file:`foo-1.0.win32.exe`. Note that creating ``wininst`` binary +distributions in only supported on Windows systems. + +If you have a non-pure distribution, the extensions can only be created on a +Windows platform, and will be Python version dependent. The installer filename +will reflect this and now has the form :file:`foo-1.0.win32-py2.0.exe`. You +have to create a separate installer for every Python version you want to +support. + +The installer will try to compile pure modules into :term:`bytecode` after installation +on the target system in normal and optimizing mode. If you don't want this to +happen for some reason, you can run the :command:`bdist_wininst` command with +the :option:`!--no-target-compile` and/or the :option:`!--no-target-optimize` +option. + +By default the installer will display the cool "Python Powered" logo when it is +run, but you can also supply your own 152x261 bitmap which must be a Windows +:file:`.bmp` file with the :option:`!--bitmap` option. + +The installer will also display a large title on the desktop background window +when it is run, which is constructed from the name of your distribution and the +version number. This can be changed to another text by using the +:option:`!--title` option. + +The installer file will be written to the "distribution directory" --- normally +:file:`dist/`, but customizable with the :option:`!--dist-dir` option. + +.. _cross-compile-windows: + +Cross-compiling on Windows +========================== + +Starting with Python 2.6, distutils is capable of cross-compiling between +Windows platforms. In practice, this means that with the correct tools +installed, you can use a 32bit version of Windows to create 64bit extensions +and vice-versa. + +To build for an alternate platform, specify the :option:`!--plat-name` option +to the build command. Valid values are currently 'win32', and 'win-amd64'. +For example, on a 32bit version of Windows, you could execute:: + + python setup.py build --plat-name=win-amd64 + +to build a 64bit version of your extension. The Windows Installers also +support this option, so the command:: + + python setup.py build --plat-name=win-amd64 bdist_wininst + +would create a 64bit installation executable on your 32bit version of Windows. + +To cross-compile, you must download the Python source code and cross-compile +Python itself for the platform you are targeting - it is not possible from a +binary installation of Python (as the .lib etc file for other platforms are +not included.) In practice, this means the user of a 32 bit operating +system will need to use Visual Studio 2008 to open the +:file:`PCbuild/PCbuild.sln` solution in the Python source tree and build the +"x64" configuration of the 'pythoncore' project before cross-compiling +extensions is possible. + +Note that by default, Visual Studio 2008 does not install 64bit compilers or +tools. You may need to reexecute the Visual Studio setup process and select +these tools (using Control Panel->[Add/Remove] Programs is a convenient way to +check or modify your existing install.) + +.. _postinstallation-script: + +The Postinstallation script +--------------------------- + +Starting with Python 2.3, a postinstallation script can be specified with the +:option:`!--install-script` option. The basename of the script must be +specified, and the script filename must also be listed in the scripts argument +to the setup function. + +This script will be run at installation time on the target system after all the +files have been copied, with ``argv[1]`` set to :option:`!-install`, and again at +uninstallation time before the files are removed with ``argv[1]`` set to +:option:`!-remove`. + +The installation script runs embedded in the windows installer, every output +(``sys.stdout``, ``sys.stderr``) is redirected into a buffer and will be +displayed in the GUI after the script has finished. + +Some functions especially useful in this context are available as additional +built-in functions in the installation script. + + +.. function:: directory_created(path) + file_created(path) + + These functions should be called when a directory or file is created by the + postinstall script at installation time. It will register *path* with the + uninstaller, so that it will be removed when the distribution is uninstalled. + To be safe, directories are only removed if they are empty. + + +.. function:: get_special_folder_path(csidl_string) + + This function can be used to retrieve special folder locations on Windows like + the Start Menu or the Desktop. It returns the full path to the folder. + *csidl_string* must be one of the following strings:: + + "CSIDL_APPDATA" + + "CSIDL_COMMON_STARTMENU" + "CSIDL_STARTMENU" + + "CSIDL_COMMON_DESKTOPDIRECTORY" + "CSIDL_DESKTOPDIRECTORY" + + "CSIDL_COMMON_STARTUP" + "CSIDL_STARTUP" + + "CSIDL_COMMON_PROGRAMS" + "CSIDL_PROGRAMS" + + "CSIDL_FONTS" + + If the folder cannot be retrieved, :exc:`OSError` is raised. + + Which folders are available depends on the exact Windows version, and probably + also the configuration. For details refer to Microsoft's documentation of the + :c:func:`SHGetSpecialFolderPath` function. + + +.. function:: create_shortcut(target, description, filename[, arguments[, workdir[, iconpath[, iconindex]]]]) + + This function creates a shortcut. *target* is the path to the program to be + started by the shortcut. *description* is the description of the shortcut. + *filename* is the title of the shortcut that the user will see. *arguments* + specifies the command line arguments, if any. *workdir* is the working directory + for the program. *iconpath* is the file containing the icon for the shortcut, + and *iconindex* is the index of the icon in the file *iconpath*. Again, for + details consult the Microsoft documentation for the :class:`IShellLink` + interface. + + +Vista User Access Control (UAC) +=============================== + +Starting with Python 2.6, bdist_wininst supports a :option:`!--user-access-control` +option. The default is 'none' (meaning no UAC handling is done), and other +valid values are 'auto' (meaning prompt for UAC elevation if Python was +installed for all users) and 'force' (meaning always prompt for elevation). diff --git a/python-3.7.4-docs-html/_sources/distutils/commandref.rst.txt b/python-3.7.4-docs-html/_sources/distutils/commandref.rst.txt new file mode 100644 index 0000000..6a2ac96 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/distutils/commandref.rst.txt @@ -0,0 +1,104 @@ +.. _reference: + +***************** +Command Reference +***************** + +.. % \section{Building modules: the \protect\command{build} command family} +.. % \label{build-cmds} +.. % \subsubsection{\protect\command{build}} +.. % \label{build-cmd} +.. % \subsubsection{\protect\command{build\_py}} +.. % \label{build-py-cmd} +.. % \subsubsection{\protect\command{build\_ext}} +.. % \label{build-ext-cmd} +.. % \subsubsection{\protect\command{build\_clib}} +.. % \label{build-clib-cmd} + + +.. _install-cmd: + +Installing modules: the :command:`install` command family +========================================================= + +The install command ensures that the build commands have been run and then runs +the subcommands :command:`install_lib`, :command:`install_data` and +:command:`install_scripts`. + +.. % \subsubsection{\protect\command{install\_lib}} +.. % \label{install-lib-cmd} + + +.. _install-data-cmd: + +:command:`install_data` +----------------------- + +This command installs all data files provided with the distribution. + + +.. _install-scripts-cmd: + +:command:`install_scripts` +-------------------------- + +This command installs all (Python) scripts in the distribution. + +.. % \subsection{Cleaning up: the \protect\command{clean} command} +.. % \label{clean-cmd} + + +.. _sdist-cmd: + +Creating a source distribution: the :command:`sdist` command +============================================================ + +.. XXX fragment moved down from above: needs context! + +The manifest template commands are: + ++-------------------------------------------+-----------------------------------------------+ +| Command | Description | ++===========================================+===============================================+ +| :command:`include pat1 pat2 ...` | include all files matching any of the listed | +| | patterns | ++-------------------------------------------+-----------------------------------------------+ +| :command:`exclude pat1 pat2 ...` | exclude all files matching any of the listed | +| | patterns | ++-------------------------------------------+-----------------------------------------------+ +| :command:`recursive-include dir pat1 pat2 | include all files under *dir* matching any of | +| ...` | the listed patterns | ++-------------------------------------------+-----------------------------------------------+ +| :command:`recursive-exclude dir pat1 pat2 | exclude all files under *dir* matching any of | +| ...` | the listed patterns | ++-------------------------------------------+-----------------------------------------------+ +| :command:`global-include pat1 pat2 ...` | include all files anywhere in the source tree | +| | matching --- & any of the listed patterns | ++-------------------------------------------+-----------------------------------------------+ +| :command:`global-exclude pat1 pat2 ...` | exclude all files anywhere in the source tree | +| | matching --- & any of the listed patterns | ++-------------------------------------------+-----------------------------------------------+ +| :command:`prune dir` | exclude all files under *dir* | ++-------------------------------------------+-----------------------------------------------+ +| :command:`graft dir` | include all files under *dir* | ++-------------------------------------------+-----------------------------------------------+ + +The patterns here are Unix-style "glob" patterns: ``*`` matches any sequence of +regular filename characters, ``?`` matches any single regular filename +character, and ``[range]`` matches any of the characters in *range* (e.g., +``a-z``, ``a-zA-Z``, ``a-f0-9_.``). The definition of "regular filename +character" is platform-specific: on Unix it is anything except slash; on Windows +anything except backslash or colon. + +.. XXX Windows support not there yet + +.. % \section{Creating a built distribution: the +.. % \protect\command{bdist} command family} +.. % \label{bdist-cmds} + +.. % \subsection{\protect\command{bdist}} +.. % \subsection{\protect\command{bdist\_dumb}} +.. % \subsection{\protect\command{bdist\_rpm}} +.. % \subsection{\protect\command{bdist\_wininst}} + + diff --git a/python-3.7.4-docs-html/_sources/distutils/configfile.rst.txt b/python-3.7.4-docs-html/_sources/distutils/configfile.rst.txt new file mode 100644 index 0000000..0874d05 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/distutils/configfile.rst.txt @@ -0,0 +1,142 @@ +.. _setup-config: + +************************************ +Writing the Setup Configuration File +************************************ + +Often, it's not possible to write down everything needed to build a distribution +*a priori*: you may need to get some information from the user, or from the +user's system, in order to proceed. As long as that information is fairly +simple---a list of directories to search for C header files or libraries, for +example---then providing a configuration file, :file:`setup.cfg`, for users to +edit is a cheap and easy way to solicit it. Configuration files also let you +provide default values for any command option, which the installer can then +override either on the command-line or by editing the config file. + +The setup configuration file is a useful middle-ground between the setup +script---which, ideally, would be opaque to installers [#]_---and the command-line to +the setup script, which is outside of your control and entirely up to the +installer. In fact, :file:`setup.cfg` (and any other Distutils configuration +files present on the target system) are processed after the contents of the +setup script, but before the command-line. This has several useful +consequences: + +.. % (If you have more advanced needs, such as determining which extensions +.. % to build based on what capabilities are present on the target system, +.. % then you need the Distutils ``auto-configuration'' facility. This +.. % started to appear in Distutils 0.9 but, as of this writing, isn't mature +.. % or stable enough yet for real-world use.) + +* installers can override some of what you put in :file:`setup.py` by editing + :file:`setup.cfg` + +* you can provide non-standard defaults for options that are not easily set in + :file:`setup.py` + +* installers can override anything in :file:`setup.cfg` using the command-line + options to :file:`setup.py` + +The basic syntax of the configuration file is simple: + +.. code-block:: ini + + [command] + option=value + ... + +where *command* is one of the Distutils commands (e.g. :command:`build_py`, +:command:`install`), and *option* is one of the options that command supports. +Any number of options can be supplied for each command, and any number of +command sections can be included in the file. Blank lines are ignored, as are +comments, which run from a ``'#'`` character until the end of the line. Long +option values can be split across multiple lines simply by indenting the +continuation lines. + +You can find out the list of options supported by a particular command with the +universal :option:`!--help` option, e.g. + +.. code-block:: shell-session + + $ python setup.py --help build_ext + [...] + Options for 'build_ext' command: + --build-lib (-b) directory for compiled extension modules + --build-temp (-t) directory for temporary files (build by-products) + --inplace (-i) ignore build-lib and put compiled extensions into the + source directory alongside your pure Python modules + --include-dirs (-I) list of directories to search for header files + --define (-D) C preprocessor macros to define + --undef (-U) C preprocessor macros to undefine + --swig-opts list of SWIG command line options + [...] + +Note that an option spelled :option:`!--foo-bar` on the command-line is spelled +``foo_bar`` in configuration files. + +.. _distutils-build-ext-inplace: + +For example, say you want your extensions to be built "in-place"---that is, you +have an extension :mod:`pkg.ext`, and you want the compiled extension file +(:file:`ext.so` on Unix, say) to be put in the same source directory as your +pure Python modules :mod:`pkg.mod1` and :mod:`pkg.mod2`. You can always use the +:option:`!--inplace` option on the command-line to ensure this: + +.. code-block:: sh + + python setup.py build_ext --inplace + +But this requires that you always specify the :command:`build_ext` command +explicitly, and remember to provide :option:`!--inplace`. An easier way is to +"set and forget" this option, by encoding it in :file:`setup.cfg`, the +configuration file for this distribution: + +.. code-block:: ini + + [build_ext] + inplace=1 + +This will affect all builds of this module distribution, whether or not you +explicitly specify :command:`build_ext`. If you include :file:`setup.cfg` in +your source distribution, it will also affect end-user builds---which is +probably a bad idea for this option, since always building extensions in-place +would break installation of the module distribution. In certain peculiar cases, +though, modules are built right in their installation directory, so this is +conceivably a useful ability. (Distributing extensions that expect to be built +in their installation directory is almost always a bad idea, though.) + +Another example: certain commands take a lot of options that don't change from +run to run; for example, :command:`bdist_rpm` needs to know everything required +to generate a "spec" file for creating an RPM distribution. Some of this +information comes from the setup script, and some is automatically generated by +the Distutils (such as the list of files installed). But some of it has to be +supplied as options to :command:`bdist_rpm`, which would be very tedious to do +on the command-line for every run. Hence, here is a snippet from the Distutils' +own :file:`setup.cfg`: + +.. code-block:: ini + + [bdist_rpm] + release = 1 + packager = Greg Ward + doc_files = CHANGES.txt + README.txt + USAGE.txt + doc/ + examples/ + +Note that the ``doc_files`` option is simply a whitespace-separated string +split across multiple lines for readability. + + +.. seealso:: + + :ref:`inst-config-syntax` in "Installing Python Modules" + More information on the configuration files is available in the manual for + system administrators. + + +.. rubric:: Footnotes + +.. [#] This ideal probably won't be achieved until auto-configuration is fully + supported by the Distutils. + diff --git a/python-3.7.4-docs-html/_sources/distutils/examples.rst.txt b/python-3.7.4-docs-html/_sources/distutils/examples.rst.txt new file mode 100644 index 0000000..4e2761d --- /dev/null +++ b/python-3.7.4-docs-html/_sources/distutils/examples.rst.txt @@ -0,0 +1,338 @@ +.. _examples: + +******** +Examples +******** + +This chapter provides a number of basic examples to help get started with +distutils. Additional information about using distutils can be found in the +Distutils Cookbook. + + +.. seealso:: + + `Distutils Cookbook `_ + Collection of recipes showing how to achieve more control over distutils. + + +.. _pure-mod: + +Pure Python distribution (by module) +==================================== + +If you're just distributing a couple of modules, especially if they don't live +in a particular package, you can specify them individually using the +``py_modules`` option in the setup script. + +In the simplest case, you'll have two files to worry about: a setup script and +the single module you're distributing, :file:`foo.py` in this example:: + + / + setup.py + foo.py + +(In all diagrams in this section, ** will refer to the distribution root +directory.) A minimal setup script to describe this situation would be:: + + from distutils.core import setup + setup(name='foo', + version='1.0', + py_modules=['foo'], + ) + +Note that the name of the distribution is specified independently with the +``name`` option, and there's no rule that says it has to be the same as +the name of the sole module in the distribution (although that's probably a good +convention to follow). However, the distribution name is used to generate +filenames, so you should stick to letters, digits, underscores, and hyphens. + +Since ``py_modules`` is a list, you can of course specify multiple +modules, eg. if you're distributing modules :mod:`foo` and :mod:`bar`, your +setup might look like this:: + + / + setup.py + foo.py + bar.py + +and the setup script might be :: + + from distutils.core import setup + setup(name='foobar', + version='1.0', + py_modules=['foo', 'bar'], + ) + +You can put module source files into another directory, but if you have enough +modules to do that, it's probably easier to specify modules by package rather +than listing them individually. + + +.. _pure-pkg: + +Pure Python distribution (by package) +===================================== + +If you have more than a couple of modules to distribute, especially if they are +in multiple packages, it's probably easier to specify whole packages rather than +individual modules. This works even if your modules are not in a package; you +can just tell the Distutils to process modules from the root package, and that +works the same as any other package (except that you don't have to have an +:file:`__init__.py` file). + +The setup script from the last example could also be written as :: + + from distutils.core import setup + setup(name='foobar', + version='1.0', + packages=[''], + ) + +(The empty string stands for the root package.) + +If those two files are moved into a subdirectory, but remain in the root +package, e.g.:: + + / + setup.py + src/ foo.py + bar.py + +then you would still specify the root package, but you have to tell the +Distutils where source files in the root package live:: + + from distutils.core import setup + setup(name='foobar', + version='1.0', + package_dir={'': 'src'}, + packages=[''], + ) + +More typically, though, you will want to distribute multiple modules in the same +package (or in sub-packages). For example, if the :mod:`foo` and :mod:`bar` +modules belong in package :mod:`foobar`, one way to layout your source tree is +:: + + / + setup.py + foobar/ + __init__.py + foo.py + bar.py + +This is in fact the default layout expected by the Distutils, and the one that +requires the least work to describe in your setup script:: + + from distutils.core import setup + setup(name='foobar', + version='1.0', + packages=['foobar'], + ) + +If you want to put modules in directories not named for their package, then you +need to use the ``package_dir`` option again. For example, if the +:file:`src` directory holds modules in the :mod:`foobar` package:: + + / + setup.py + src/ + __init__.py + foo.py + bar.py + +an appropriate setup script would be :: + + from distutils.core import setup + setup(name='foobar', + version='1.0', + package_dir={'foobar': 'src'}, + packages=['foobar'], + ) + +Or, you might put modules from your main package right in the distribution +root:: + + / + setup.py + __init__.py + foo.py + bar.py + +in which case your setup script would be :: + + from distutils.core import setup + setup(name='foobar', + version='1.0', + package_dir={'foobar': ''}, + packages=['foobar'], + ) + +(The empty string also stands for the current directory.) + +If you have sub-packages, they must be explicitly listed in ``packages``, +but any entries in ``package_dir`` automatically extend to sub-packages. +(In other words, the Distutils does *not* scan your source tree, trying to +figure out which directories correspond to Python packages by looking for +:file:`__init__.py` files.) Thus, if the default layout grows a sub-package:: + + / + setup.py + foobar/ + __init__.py + foo.py + bar.py + subfoo/ + __init__.py + blah.py + +then the corresponding setup script would be :: + + from distutils.core import setup + setup(name='foobar', + version='1.0', + packages=['foobar', 'foobar.subfoo'], + ) + + +.. _single-ext: + +Single extension module +======================= + +Extension modules are specified using the ``ext_modules`` option. +``package_dir`` has no effect on where extension source files are found; +it only affects the source for pure Python modules. The simplest case, a +single extension module in a single C source file, is:: + + / + setup.py + foo.c + +If the :mod:`foo` extension belongs in the root package, the setup script for +this could be :: + + from distutils.core import setup + from distutils.extension import Extension + setup(name='foobar', + version='1.0', + ext_modules=[Extension('foo', ['foo.c'])], + ) + +If the extension actually belongs in a package, say :mod:`foopkg`, then + +With exactly the same source tree layout, this extension can be put in the +:mod:`foopkg` package simply by changing the name of the extension:: + + from distutils.core import setup + from distutils.extension import Extension + setup(name='foobar', + version='1.0', + ext_modules=[Extension('foopkg.foo', ['foo.c'])], + ) + +Checking a package +================== + +The ``check`` command allows you to verify if your package meta-data +meet the minimum requirements to build a distribution. + +To run it, just call it using your :file:`setup.py` script. If something is +missing, ``check`` will display a warning. + +Let's take an example with a simple script:: + + from distutils.core import setup + + setup(name='foobar') + +Running the ``check`` command will display some warnings: + +.. code-block:: shell-session + + $ python setup.py check + running check + warning: check: missing required meta-data: version, url + warning: check: missing meta-data: either (author and author_email) or + (maintainer and maintainer_email) must be supplied + + +If you use the reStructuredText syntax in the ``long_description`` field and +`docutils`_ is installed you can check if the syntax is fine with the +``check`` command, using the ``restructuredtext`` option. + +For example, if the :file:`setup.py` script is changed like this:: + + from distutils.core import setup + + desc = """\ + My description + ============== + + This is the description of the ``foobar`` package. + """ + + setup(name='foobar', version='1', author='tarek', + author_email='tarek@ziade.org', + url='http://example.com', long_description=desc) + +Where the long description is broken, ``check`` will be able to detect it +by using the :mod:`docutils` parser: + +.. code-block:: shell-session + + $ python setup.py check --restructuredtext + running check + warning: check: Title underline too short. (line 2) + warning: check: Could not finish the parsing. + +Reading the metadata +===================== + +The :func:`distutils.core.setup` function provides a command-line interface +that allows you to query the metadata fields of a project through the +``setup.py`` script of a given project: + +.. code-block:: shell-session + + $ python setup.py --name + distribute + +This call reads the ``name`` metadata by running the +:func:`distutils.core.setup` function. Although, when a source or binary +distribution is created with Distutils, the metadata fields are written +in a static file called :file:`PKG-INFO`. When a Distutils-based project is +installed in Python, the :file:`PKG-INFO` file is copied alongside the modules +and packages of the distribution under :file:`NAME-VERSION-pyX.X.egg-info`, +where ``NAME`` is the name of the project, ``VERSION`` its version as defined +in the Metadata, and ``pyX.X`` the major and minor version of Python like +``2.7`` or ``3.2``. + +You can read back this static file, by using the +:class:`distutils.dist.DistributionMetadata` class and its +:func:`read_pkg_file` method:: + + >>> from distutils.dist import DistributionMetadata + >>> metadata = DistributionMetadata() + >>> metadata.read_pkg_file(open('distribute-0.6.8-py2.7.egg-info')) + >>> metadata.name + 'distribute' + >>> metadata.version + '0.6.8' + >>> metadata.description + 'Easily download, build, install, upgrade, and uninstall Python packages' + +Notice that the class can also be instantiated with a metadata file path to +loads its values:: + + >>> pkg_info_path = 'distribute-0.6.8-py2.7.egg-info' + >>> DistributionMetadata(pkg_info_path).name + 'distribute' + + +.. % \section{Multiple extension modules} +.. % \label{multiple-ext} + +.. % \section{Putting it all together} + + +.. _docutils: http://docutils.sourceforge.net diff --git a/python-3.7.4-docs-html/_sources/distutils/extending.rst.txt b/python-3.7.4-docs-html/_sources/distutils/extending.rst.txt new file mode 100644 index 0000000..501fd7c --- /dev/null +++ b/python-3.7.4-docs-html/_sources/distutils/extending.rst.txt @@ -0,0 +1,96 @@ +.. _extending-distutils: + +******************* +Extending Distutils +******************* + +Distutils can be extended in various ways. Most extensions take the form of new +commands or replacements for existing commands. New commands may be written to +support new types of platform-specific packaging, for example, while +replacements for existing commands may be made to modify details of how the +command operates on a package. + +Most extensions of the distutils are made within :file:`setup.py` scripts that +want to modify existing commands; many simply add a few file extensions that +should be copied into packages in addition to :file:`.py` files as a +convenience. + +Most distutils command implementations are subclasses of the +:class:`distutils.cmd.Command` class. New commands may directly inherit from +:class:`Command`, while replacements often derive from :class:`Command` +indirectly, directly subclassing the command they are replacing. Commands are +required to derive from :class:`Command`. + +.. % \section{Extending existing commands} +.. % \label{extend-existing} + +.. % \section{Writing new commands} +.. % \label{new-commands} +.. % \XXX{Would an uninstall command be a good example here?} + + +Integrating new commands +======================== + +There are different ways to integrate new command implementations into +distutils. The most difficult is to lobby for the inclusion of the new features +in distutils itself, and wait for (and require) a version of Python that +provides that support. This is really hard for many reasons. + +The most common, and possibly the most reasonable for most needs, is to include +the new implementations with your :file:`setup.py` script, and cause the +:func:`distutils.core.setup` function use them:: + + from distutils.command.build_py import build_py as _build_py + from distutils.core import setup + + class build_py(_build_py): + """Specialized Python source builder.""" + + # implement whatever needs to be different... + + setup(cmdclass={'build_py': build_py}, + ...) + +This approach is most valuable if the new implementations must be used to use a +particular package, as everyone interested in the package will need to have the +new command implementation. + +Beginning with Python 2.4, a third option is available, intended to allow new +commands to be added which can support existing :file:`setup.py` scripts without +requiring modifications to the Python installation. This is expected to allow +third-party extensions to provide support for additional packaging systems, but +the commands can be used for anything distutils commands can be used for. A new +configuration option, ``command_packages`` (command-line option +:option:`!--command-packages`), can be used to specify additional packages to be +searched for modules implementing commands. Like all distutils options, this +can be specified on the command line or in a configuration file. This option +can only be set in the ``[global]`` section of a configuration file, or before +any commands on the command line. If set in a configuration file, it can be +overridden from the command line; setting it to an empty string on the command +line causes the default to be used. This should never be set in a configuration +file provided with a package. + +This new option can be used to add any number of packages to the list of +packages searched for command implementations; multiple package names should be +separated by commas. When not specified, the search is only performed in the +:mod:`distutils.command` package. When :file:`setup.py` is run with the option +``--command-packages distcmds,buildcmds``, however, the packages +:mod:`distutils.command`, :mod:`distcmds`, and :mod:`buildcmds` will be searched +in that order. New commands are expected to be implemented in modules of the +same name as the command by classes sharing the same name. Given the example +command line option above, the command :command:`bdist_openpkg` could be +implemented by the class :class:`distcmds.bdist_openpkg.bdist_openpkg` or +:class:`buildcmds.bdist_openpkg.bdist_openpkg`. + + +Adding new distribution types +============================= + +Commands that create distributions (files in the :file:`dist/` directory) need +to add ``(command, filename)`` pairs to ``self.distribution.dist_files`` so that +:command:`upload` can upload it to PyPI. The *filename* in the pair contains no +path information, only the name of the file itself. In dry-run mode, pairs +should still be added to represent what would have been created. + + diff --git a/python-3.7.4-docs-html/_sources/distutils/index.rst.txt b/python-3.7.4-docs-html/_sources/distutils/index.rst.txt new file mode 100644 index 0000000..aaf4536 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/distutils/index.rst.txt @@ -0,0 +1,40 @@ +.. _distutils-index: + +############################################## + Distributing Python Modules (Legacy version) +############################################## + +:Authors: Greg Ward, Anthony Baxter +:Email: distutils-sig@python.org + +.. seealso:: + + :ref:`distributing-index` + The up to date module distribution documentations + +This document describes the Python Distribution Utilities ("Distutils") from +the module developer's point of view, describing how to use the Distutils to +make Python modules and extensions easily available to a wider audience with +very little overhead for build/release/install mechanics. + +.. note:: + + This guide only covers the basic tools for building and distributing + extensions that are provided as part of this version of Python. Third party + tools offer easier to use and more secure alternatives. Refer to the `quick + recommendations section `__ + in the Python Packaging User Guide for more information. + +.. toctree:: + :maxdepth: 2 + :numbered: + + introduction.rst + setupscript.rst + configfile.rst + sourcedist.rst + builtdist.rst + examples.rst + extending.rst + commandref.rst + apiref.rst diff --git a/python-3.7.4-docs-html/_sources/distutils/introduction.rst.txt b/python-3.7.4-docs-html/_sources/distutils/introduction.rst.txt new file mode 100644 index 0000000..7721484 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/distutils/introduction.rst.txt @@ -0,0 +1,212 @@ +.. _distutils-intro: + +**************************** +An Introduction to Distutils +**************************** + +This document covers using the Distutils to distribute your Python modules, +concentrating on the role of developer/distributor: if you're looking for +information on installing Python modules, you should refer to the +:ref:`install-index` chapter. + + +.. _distutils-concepts: + +Concepts & Terminology +====================== + +Using the Distutils is quite simple, both for module developers and for +users/administrators installing third-party modules. As a developer, your +responsibilities (apart from writing solid, well-documented and well-tested +code, of course!) are: + +* write a setup script (:file:`setup.py` by convention) + +* (optional) write a setup configuration file + +* create a source distribution + +* (optional) create one or more built (binary) distributions + +Each of these tasks is covered in this document. + +Not all module developers have access to a multitude of platforms, so it's not +always feasible to expect them to create a multitude of built distributions. It +is hoped that a class of intermediaries, called *packagers*, will arise to +address this need. Packagers will take source distributions released by module +developers, build them on one or more platforms, and release the resulting built +distributions. Thus, users on the most popular platforms will be able to +install most popular Python module distributions in the most natural way for +their platform, without having to run a single setup script or compile a line of +code. + + +.. _distutils-simple-example: + +A Simple Example +================ + +The setup script is usually quite simple, although since it's written in Python, +there are no arbitrary limits to what you can do with it, though you should be +careful about putting arbitrarily expensive operations in your setup script. +Unlike, say, Autoconf-style configure scripts, the setup script may be run +multiple times in the course of building and installing your module +distribution. + +If all you want to do is distribute a module called :mod:`foo`, contained in a +file :file:`foo.py`, then your setup script can be as simple as this:: + + from distutils.core import setup + setup(name='foo', + version='1.0', + py_modules=['foo'], + ) + +Some observations: + +* most information that you supply to the Distutils is supplied as keyword + arguments to the :func:`setup` function + +* those keyword arguments fall into two categories: package metadata (name, + version number) and information about what's in the package (a list of pure + Python modules, in this case) + +* modules are specified by module name, not filename (the same will hold true + for packages and extensions) + +* it's recommended that you supply a little more metadata, in particular your + name, email address and a URL for the project (see section :ref:`setup-script` + for an example) + +To create a source distribution for this module, you would create a setup +script, :file:`setup.py`, containing the above code, and run this command from a +terminal:: + + python setup.py sdist + +For Windows, open a command prompt window (:menuselection:`Start --> +Accessories`) and change the command to:: + + setup.py sdist + +:command:`sdist` will create an archive file (e.g., tarball on Unix, ZIP file on Windows) +containing your setup script :file:`setup.py`, and your module :file:`foo.py`. +The archive file will be named :file:`foo-1.0.tar.gz` (or :file:`.zip`), and +will unpack into a directory :file:`foo-1.0`. + +If an end-user wishes to install your :mod:`foo` module, all they have to do is +download :file:`foo-1.0.tar.gz` (or :file:`.zip`), unpack it, and---from the +:file:`foo-1.0` directory---run :: + + python setup.py install + +which will ultimately copy :file:`foo.py` to the appropriate directory for +third-party modules in their Python installation. + +This simple example demonstrates some fundamental concepts of the Distutils. +First, both developers and installers have the same basic user interface, i.e. +the setup script. The difference is which Distutils *commands* they use: the +:command:`sdist` command is almost exclusively for module developers, while +:command:`install` is more often for installers (although most developers will +want to install their own code occasionally). + +If you want to make things really easy for your users, you can create one or +more built distributions for them. For instance, if you are running on a +Windows machine, and want to make things easy for other Windows users, you can +create an executable installer (the most appropriate type of built distribution +for this platform) with the :command:`bdist_wininst` command. For example:: + + python setup.py bdist_wininst + +will create an executable installer, :file:`foo-1.0.win32.exe`, in the current +directory. + +Other useful built distribution formats are RPM, implemented by the +:command:`bdist_rpm` command, Solaris :program:`pkgtool` +(:command:`bdist_pkgtool`), and HP-UX :program:`swinstall` +(:command:`bdist_sdux`). For example, the following command will create an RPM +file called :file:`foo-1.0.noarch.rpm`:: + + python setup.py bdist_rpm + +(The :command:`bdist_rpm` command uses the :command:`rpm` executable, therefore +this has to be run on an RPM-based system such as Red Hat Linux, SuSE Linux, or +Mandrake Linux.) + +You can find out what distribution formats are available at any time by running +:: + + python setup.py bdist --help-formats + + +.. _python-terms: + +General Python terminology +========================== + +If you're reading this document, you probably have a good idea of what modules, +extensions, and so forth are. Nevertheless, just to be sure that everyone is +operating from a common starting point, we offer the following glossary of +common Python terms: + +module + the basic unit of code reusability in Python: a block of code imported by some + other code. Three types of modules concern us here: pure Python modules, + extension modules, and packages. + +pure Python module + a module written in Python and contained in a single :file:`.py` file (and + possibly associated :file:`.pyc` files). Sometimes referred to as a + "pure module." + +extension module + a module written in the low-level language of the Python implementation: C/C++ + for Python, Java for Jython. Typically contained in a single dynamically + loadable pre-compiled file, e.g. a shared object (:file:`.so`) file for Python + extensions on Unix, a DLL (given the :file:`.pyd` extension) for Python + extensions on Windows, or a Java class file for Jython extensions. (Note that + currently, the Distutils only handles C/C++ extensions for Python.) + +package + a module that contains other modules; typically contained in a directory in the + filesystem and distinguished from other directories by the presence of a file + :file:`__init__.py`. + +root package + the root of the hierarchy of packages. (This isn't really a package, since it + doesn't have an :file:`__init__.py` file. But we have to call it something.) + The vast majority of the standard library is in the root package, as are many + small, standalone third-party modules that don't belong to a larger module + collection. Unlike regular packages, modules in the root package can be found in + many directories: in fact, every directory listed in ``sys.path`` contributes + modules to the root package. + + +.. _distutils-term: + +Distutils-specific terminology +============================== + +The following terms apply more specifically to the domain of distributing Python +modules using the Distutils: + +module distribution + a collection of Python modules distributed together as a single downloadable + resource and meant to be installed *en masse*. Examples of some well-known + module distributions are NumPy, SciPy, Pillow, + or mxBase. (This would be called a *package*, except that term is + already taken in the Python context: a single module distribution may contain + zero, one, or many Python packages.) + +pure module distribution + a module distribution that contains only pure Python modules and packages. + Sometimes referred to as a "pure distribution." + +non-pure module distribution + a module distribution that contains at least one extension module. Sometimes + referred to as a "non-pure distribution." + +distribution root + the top-level directory of your source tree (or source distribution); the + directory where :file:`setup.py` exists. Generally :file:`setup.py` will be + run from this directory. diff --git a/python-3.7.4-docs-html/_sources/distutils/packageindex.rst.txt b/python-3.7.4-docs-html/_sources/distutils/packageindex.rst.txt new file mode 100644 index 0000000..ccb9a59 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/distutils/packageindex.rst.txt @@ -0,0 +1,16 @@ +:orphan: + +.. _package-index: + +******************************* +The Python Package Index (PyPI) +******************************* + +The `Python Package Index (PyPI)`_ stores metadata describing distributions +packaged with distutils and other publishing tools, as well the distribution +archives themselves. + +References to up to date PyPI documentation can be found at +:ref:`publishing-python-packages`. + +.. _Python Package Index (PyPI): https://pypi.org diff --git a/python-3.7.4-docs-html/_sources/distutils/setupscript.rst.txt b/python-3.7.4-docs-html/_sources/distutils/setupscript.rst.txt new file mode 100644 index 0000000..1f99f62 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/distutils/setupscript.rst.txt @@ -0,0 +1,711 @@ +.. _setup-script: + +************************ +Writing the Setup Script +************************ + +The setup script is the centre of all activity in building, distributing, and +installing modules using the Distutils. The main purpose of the setup script is +to describe your module distribution to the Distutils, so that the various +commands that operate on your modules do the right thing. As we saw in section +:ref:`distutils-simple-example` above, the setup script consists mainly of a call to +:func:`setup`, and most information supplied to the Distutils by the module +developer is supplied as keyword arguments to :func:`setup`. + +Here's a slightly more involved example, which we'll follow for the next couple +of sections: the Distutils' own setup script. (Keep in mind that although the +Distutils are included with Python 1.6 and later, they also have an independent +existence so that Python 1.5.2 users can use them to install other module +distributions. The Distutils' own setup script, shown here, is used to install +the package into Python 1.5.2.) :: + + #!/usr/bin/env python + + from distutils.core import setup + + setup(name='Distutils', + version='1.0', + description='Python Distribution Utilities', + author='Greg Ward', + author_email='gward@python.net', + url='https://www.python.org/sigs/distutils-sig/', + packages=['distutils', 'distutils.command'], + ) + +There are only two differences between this and the trivial one-file +distribution presented in section :ref:`distutils-simple-example`: more metadata, and the +specification of pure Python modules by package, rather than by module. This is +important since the Distutils consist of a couple of dozen modules split into +(so far) two packages; an explicit list of every module would be tedious to +generate and difficult to maintain. For more information on the additional +meta-data, see section :ref:`meta-data`. + +Note that any pathnames (files or directories) supplied in the setup script +should be written using the Unix convention, i.e. slash-separated. The +Distutils will take care of converting this platform-neutral representation into +whatever is appropriate on your current platform before actually using the +pathname. This makes your setup script portable across operating systems, which +of course is one of the major goals of the Distutils. In this spirit, all +pathnames in this document are slash-separated. + +This, of course, only applies to pathnames given to Distutils functions. If +you, for example, use standard Python functions such as :func:`glob.glob` or +:func:`os.listdir` to specify files, you should be careful to write portable +code instead of hardcoding path separators:: + + glob.glob(os.path.join('mydir', 'subdir', '*.html')) + os.listdir(os.path.join('mydir', 'subdir')) + + +.. _listing-packages: + +Listing whole packages +====================== + +The ``packages`` option tells the Distutils to process (build, distribute, +install, etc.) all pure Python modules found in each package mentioned in the +``packages`` list. In order to do this, of course, there has to be a +correspondence between package names and directories in the filesystem. The +default correspondence is the most obvious one, i.e. package :mod:`distutils` is +found in the directory :file:`distutils` relative to the distribution root. +Thus, when you say ``packages = ['foo']`` in your setup script, you are +promising that the Distutils will find a file :file:`foo/__init__.py` (which +might be spelled differently on your system, but you get the idea) relative to +the directory where your setup script lives. If you break this promise, the +Distutils will issue a warning but still process the broken package anyway. + +If you use a different convention to lay out your source directory, that's no +problem: you just have to supply the ``package_dir`` option to tell the +Distutils about your convention. For example, say you keep all Python source +under :file:`lib`, so that modules in the "root package" (i.e., not in any +package at all) are in :file:`lib`, modules in the :mod:`foo` package are in +:file:`lib/foo`, and so forth. Then you would put :: + + package_dir = {'': 'lib'} + +in your setup script. The keys to this dictionary are package names, and an +empty package name stands for the root package. The values are directory names +relative to your distribution root. In this case, when you say ``packages = +['foo']``, you are promising that the file :file:`lib/foo/__init__.py` exists. + +Another possible convention is to put the :mod:`foo` package right in +:file:`lib`, the :mod:`foo.bar` package in :file:`lib/bar`, etc. This would be +written in the setup script as :: + + package_dir = {'foo': 'lib'} + +A ``package: dir`` entry in the ``package_dir`` dictionary implicitly +applies to all packages below *package*, so the :mod:`foo.bar` case is +automatically handled here. In this example, having ``packages = ['foo', +'foo.bar']`` tells the Distutils to look for :file:`lib/__init__.py` and +:file:`lib/bar/__init__.py`. (Keep in mind that although ``package_dir`` +applies recursively, you must explicitly list all packages in +``packages``: the Distutils will *not* recursively scan your source tree +looking for any directory with an :file:`__init__.py` file.) + + +.. _listing-modules: + +Listing individual modules +========================== + +For a small module distribution, you might prefer to list all modules rather +than listing packages---especially the case of a single module that goes in the +"root package" (i.e., no package at all). This simplest case was shown in +section :ref:`distutils-simple-example`; here is a slightly more involved example:: + + py_modules = ['mod1', 'pkg.mod2'] + +This describes two modules, one of them in the "root" package, the other in the +:mod:`pkg` package. Again, the default package/directory layout implies that +these two modules can be found in :file:`mod1.py` and :file:`pkg/mod2.py`, and +that :file:`pkg/__init__.py` exists as well. And again, you can override the +package/directory correspondence using the ``package_dir`` option. + + +.. _describing-extensions: + +Describing extension modules +============================ + +Just as writing Python extension modules is a bit more complicated than writing +pure Python modules, describing them to the Distutils is a bit more complicated. +Unlike pure modules, it's not enough just to list modules or packages and expect +the Distutils to go out and find the right files; you have to specify the +extension name, source file(s), and any compile/link requirements (include +directories, libraries to link with, etc.). + +.. XXX read over this section + +All of this is done through another keyword argument to :func:`setup`, the +``ext_modules`` option. ``ext_modules`` is just a list of +:class:`~distutils.core.Extension` instances, each of which describes a +single extension module. +Suppose your distribution includes a single extension, called :mod:`foo` and +implemented by :file:`foo.c`. If no additional instructions to the +compiler/linker are needed, describing this extension is quite simple:: + + Extension('foo', ['foo.c']) + +The :class:`Extension` class can be imported from :mod:`distutils.core` along +with :func:`setup`. Thus, the setup script for a module distribution that +contains only this one extension and nothing else might be:: + + from distutils.core import setup, Extension + setup(name='foo', + version='1.0', + ext_modules=[Extension('foo', ['foo.c'])], + ) + +The :class:`Extension` class (actually, the underlying extension-building +machinery implemented by the :command:`build_ext` command) supports a great deal +of flexibility in describing Python extensions, which is explained in the +following sections. + + +Extension names and packages +---------------------------- + +The first argument to the :class:`~distutils.core.Extension` constructor is +always the name of the extension, including any package names. For example, :: + + Extension('foo', ['src/foo1.c', 'src/foo2.c']) + +describes an extension that lives in the root package, while :: + + Extension('pkg.foo', ['src/foo1.c', 'src/foo2.c']) + +describes the same extension in the :mod:`pkg` package. The source files and +resulting object code are identical in both cases; the only difference is where +in the filesystem (and therefore where in Python's namespace hierarchy) the +resulting extension lives. + +If you have a number of extensions all in the same package (or all under the +same base package), use the ``ext_package`` keyword argument to +:func:`setup`. For example, :: + + setup(..., + ext_package='pkg', + ext_modules=[Extension('foo', ['foo.c']), + Extension('subpkg.bar', ['bar.c'])], + ) + +will compile :file:`foo.c` to the extension :mod:`pkg.foo`, and :file:`bar.c` to +:mod:`pkg.subpkg.bar`. + + +Extension source files +---------------------- + +The second argument to the :class:`~distutils.core.Extension` constructor is +a list of source +files. Since the Distutils currently only support C, C++, and Objective-C +extensions, these are normally C/C++/Objective-C source files. (Be sure to use +appropriate extensions to distinguish C++ source files: :file:`.cc` and +:file:`.cpp` seem to be recognized by both Unix and Windows compilers.) + +However, you can also include SWIG interface (:file:`.i`) files in the list; the +:command:`build_ext` command knows how to deal with SWIG extensions: it will run +SWIG on the interface file and compile the resulting C/C++ file into your +extension. + +.. XXX SWIG support is rough around the edges and largely untested! + +This warning notwithstanding, options to SWIG can be currently passed like +this:: + + setup(..., + ext_modules=[Extension('_foo', ['foo.i'], + swig_opts=['-modern', '-I../include'])], + py_modules=['foo'], + ) + +Or on the commandline like this:: + + > python setup.py build_ext --swig-opts="-modern -I../include" + +On some platforms, you can include non-source files that are processed by the +compiler and included in your extension. Currently, this just means Windows +message text (:file:`.mc`) files and resource definition (:file:`.rc`) files for +Visual C++. These will be compiled to binary resource (:file:`.res`) files and +linked into the executable. + + +Preprocessor options +-------------------- + +Three optional arguments to :class:`~distutils.core.Extension` will help if +you need to specify include directories to search or preprocessor macros to +define/undefine: ``include_dirs``, ``define_macros``, and ``undef_macros``. + +For example, if your extension requires header files in the :file:`include` +directory under your distribution root, use the ``include_dirs`` option:: + + Extension('foo', ['foo.c'], include_dirs=['include']) + +You can specify absolute directories there; if you know that your extension will +only be built on Unix systems with X11R6 installed to :file:`/usr`, you can get +away with :: + + Extension('foo', ['foo.c'], include_dirs=['/usr/include/X11']) + +You should avoid this sort of non-portable usage if you plan to distribute your +code: it's probably better to write C code like :: + + #include + +If you need to include header files from some other Python extension, you can +take advantage of the fact that header files are installed in a consistent way +by the Distutils :command:`install_headers` command. For example, the Numerical +Python header files are installed (on a standard Unix installation) to +:file:`/usr/local/include/python1.5/Numerical`. (The exact location will differ +according to your platform and Python installation.) Since the Python include +directory---\ :file:`/usr/local/include/python1.5` in this case---is always +included in the search path when building Python extensions, the best approach +is to write C code like :: + + #include + +If you must put the :file:`Numerical` include directory right into your header +search path, though, you can find that directory using the Distutils +:mod:`distutils.sysconfig` module:: + + from distutils.sysconfig import get_python_inc + incdir = os.path.join(get_python_inc(plat_specific=1), 'Numerical') + setup(..., + Extension(..., include_dirs=[incdir]), + ) + +Even though this is quite portable---it will work on any Python installation, +regardless of platform---it's probably easier to just write your C code in the +sensible way. + +You can define and undefine pre-processor macros with the ``define_macros`` and +``undef_macros`` options. ``define_macros`` takes a list of ``(name, value)`` +tuples, where ``name`` is the name of the macro to define (a string) and +``value`` is its value: either a string or ``None``. (Defining a macro ``FOO`` +to ``None`` is the equivalent of a bare ``#define FOO`` in your C source: with +most compilers, this sets ``FOO`` to the string ``1``.) ``undef_macros`` is +just a list of macros to undefine. + +For example:: + + Extension(..., + define_macros=[('NDEBUG', '1'), + ('HAVE_STRFTIME', None)], + undef_macros=['HAVE_FOO', 'HAVE_BAR']) + +is the equivalent of having this at the top of every C source file:: + + #define NDEBUG 1 + #define HAVE_STRFTIME + #undef HAVE_FOO + #undef HAVE_BAR + + +Library options +--------------- + +You can also specify the libraries to link against when building your extension, +and the directories to search for those libraries. The ``libraries`` option is +a list of libraries to link against, ``library_dirs`` is a list of directories +to search for libraries at link-time, and ``runtime_library_dirs`` is a list of +directories to search for shared (dynamically loaded) libraries at run-time. + +For example, if you need to link against libraries known to be in the standard +library search path on target systems :: + + Extension(..., + libraries=['gdbm', 'readline']) + +If you need to link with libraries in a non-standard location, you'll have to +include the location in ``library_dirs``:: + + Extension(..., + library_dirs=['/usr/X11R6/lib'], + libraries=['X11', 'Xt']) + +(Again, this sort of non-portable construct should be avoided if you intend to +distribute your code.) + +.. XXX Should mention clib libraries here or somewhere else! + + +Other options +------------- + +There are still some other options which can be used to handle special cases. + +The ``optional`` option is a boolean; if it is true, +a build failure in the extension will not abort the build process, but +instead simply not install the failing extension. + +The ``extra_objects`` option is a list of object files to be passed to the +linker. These files must not have extensions, as the default extension for the +compiler is used. + +``extra_compile_args`` and ``extra_link_args`` can be used to +specify additional command line options for the respective compiler and linker +command lines. + +``export_symbols`` is only useful on Windows. It can contain a list of +symbols (functions or variables) to be exported. This option is not needed when +building compiled extensions: Distutils will automatically add ``initmodule`` +to the list of exported symbols. + +The ``depends`` option is a list of files that the extension depends on +(for example header files). The build command will call the compiler on the +sources to rebuild extension if any on this files has been modified since the +previous build. + +Relationships between Distributions and Packages +================================================ + +A distribution may relate to packages in three specific ways: + +#. It can require packages or modules. + +#. It can provide packages or modules. + +#. It can obsolete packages or modules. + +These relationships can be specified using keyword arguments to the +:func:`distutils.core.setup` function. + +Dependencies on other Python modules and packages can be specified by supplying +the *requires* keyword argument to :func:`setup`. The value must be a list of +strings. Each string specifies a package that is required, and optionally what +versions are sufficient. + +To specify that any version of a module or package is required, the string +should consist entirely of the module or package name. Examples include +``'mymodule'`` and ``'xml.parsers.expat'``. + +If specific versions are required, a sequence of qualifiers can be supplied in +parentheses. Each qualifier may consist of a comparison operator and a version +number. The accepted comparison operators are:: + + < > == + <= >= != + +These can be combined by using multiple qualifiers separated by commas (and +optional whitespace). In this case, all of the qualifiers must be matched; a +logical AND is used to combine the evaluations. + +Let's look at a bunch of examples: + ++-------------------------+----------------------------------------------+ +| Requires Expression | Explanation | ++=========================+==============================================+ +| ``==1.0`` | Only version ``1.0`` is compatible | ++-------------------------+----------------------------------------------+ +| ``>1.0, !=1.5.1, <2.0`` | Any version after ``1.0`` and before ``2.0`` | +| | is compatible, except ``1.5.1`` | ++-------------------------+----------------------------------------------+ + +Now that we can specify dependencies, we also need to be able to specify what we +provide that other distributions can require. This is done using the *provides* +keyword argument to :func:`setup`. The value for this keyword is a list of +strings, each of which names a Python module or package, and optionally +identifies the version. If the version is not specified, it is assumed to match +that of the distribution. + +Some examples: + ++---------------------+----------------------------------------------+ +| Provides Expression | Explanation | ++=====================+==============================================+ +| ``mypkg`` | Provide ``mypkg``, using the distribution | +| | version | ++---------------------+----------------------------------------------+ +| ``mypkg (1.1)`` | Provide ``mypkg`` version 1.1, regardless of | +| | the distribution version | ++---------------------+----------------------------------------------+ + +A package can declare that it obsoletes other packages using the *obsoletes* +keyword argument. The value for this is similar to that of the *requires* +keyword: a list of strings giving module or package specifiers. Each specifier +consists of a module or package name optionally followed by one or more version +qualifiers. Version qualifiers are given in parentheses after the module or +package name. + +The versions identified by the qualifiers are those that are obsoleted by the +distribution being described. If no qualifiers are given, all versions of the +named module or package are understood to be obsoleted. + +.. _distutils-installing-scripts: + +Installing Scripts +================== + +So far we have been dealing with pure and non-pure Python modules, which are +usually not run by themselves but imported by scripts. + +Scripts are files containing Python source code, intended to be started from the +command line. Scripts don't require Distutils to do anything very complicated. +The only clever feature is that if the first line of the script starts with +``#!`` and contains the word "python", the Distutils will adjust the first line +to refer to the current interpreter location. By default, it is replaced with +the current interpreter location. The :option:`!--executable` (or :option:`!-e`) +option will allow the interpreter path to be explicitly overridden. + +The ``scripts`` option simply is a list of files to be handled in this +way. From the PyXML setup script:: + + setup(..., + scripts=['scripts/xmlproc_parse', 'scripts/xmlproc_val'] + ) + +.. versionchanged:: 3.1 + All the scripts will also be added to the ``MANIFEST`` file if no template is + provided. See :ref:`manifest`. + + +.. _distutils-installing-package-data: + +Installing Package Data +======================= + +Often, additional files need to be installed into a package. These files are +often data that's closely related to the package's implementation, or text files +containing documentation that might be of interest to programmers using the +package. These files are called :dfn:`package data`. + +Package data can be added to packages using the ``package_data`` keyword +argument to the :func:`setup` function. The value must be a mapping from +package name to a list of relative path names that should be copied into the +package. The paths are interpreted as relative to the directory containing the +package (information from the ``package_dir`` mapping is used if appropriate); +that is, the files are expected to be part of the package in the source +directories. They may contain glob patterns as well. + +The path names may contain directory portions; any necessary directories will be +created in the installation. + +For example, if a package should contain a subdirectory with several data files, +the files can be arranged like this in the source tree:: + + setup.py + src/ + mypkg/ + __init__.py + module.py + data/ + tables.dat + spoons.dat + forks.dat + +The corresponding call to :func:`setup` might be:: + + setup(..., + packages=['mypkg'], + package_dir={'mypkg': 'src/mypkg'}, + package_data={'mypkg': ['data/*.dat']}, + ) + + +.. versionchanged:: 3.1 + All the files that match ``package_data`` will be added to the ``MANIFEST`` + file if no template is provided. See :ref:`manifest`. + + +.. _distutils-additional-files: + +Installing Additional Files +=========================== + +The ``data_files`` option can be used to specify additional files needed +by the module distribution: configuration files, message catalogs, data files, +anything which doesn't fit in the previous categories. + +``data_files`` specifies a sequence of (*directory*, *files*) pairs in the +following way:: + + setup(..., + data_files=[('bitmaps', ['bm/b1.gif', 'bm/b2.gif']), + ('config', ['cfg/data.cfg'])], + ) + +Each (*directory*, *files*) pair in the sequence specifies the installation +directory and the files to install there. + +Each file name in *files* is interpreted relative to the :file:`setup.py` +script at the top of the package source distribution. Note that you can +specify the directory where the data files will be installed, but you cannot +rename the data files themselves. + +The *directory* should be a relative path. It is interpreted relative to the +installation prefix (Python's ``sys.prefix`` for system installations; +``site.USER_BASE`` for user installations). Distutils allows *directory* to be +an absolute installation path, but this is discouraged since it is +incompatible with the wheel packaging format. No directory information from +*files* is used to determine the final location of the installed file; only +the name of the file is used. + +You can specify the ``data_files`` options as a simple sequence of files +without specifying a target directory, but this is not recommended, and the +:command:`install` command will print a warning in this case. To install data +files directly in the target directory, an empty string should be given as the +directory. + +.. versionchanged:: 3.1 + All the files that match ``data_files`` will be added to the ``MANIFEST`` + file if no template is provided. See :ref:`manifest`. + + +.. _meta-data: + +Additional meta-data +==================== + +The setup script may include additional meta-data beyond the name and version. +This information includes: + ++----------------------+---------------------------+-----------------+--------+ +| Meta-Data | Description | Value | Notes | ++======================+===========================+=================+========+ +| ``name`` | name of the package | short string | \(1) | ++----------------------+---------------------------+-----------------+--------+ +| ``version`` | version of this release | short string | (1)(2) | ++----------------------+---------------------------+-----------------+--------+ +| ``author`` | package author's name | short string | \(3) | ++----------------------+---------------------------+-----------------+--------+ +| ``author_email`` | email address of the | email address | \(3) | +| | package author | | | ++----------------------+---------------------------+-----------------+--------+ +| ``maintainer`` | package maintainer's name | short string | \(3) | ++----------------------+---------------------------+-----------------+--------+ +| ``maintainer_email`` | email address of the | email address | \(3) | +| | package maintainer | | | ++----------------------+---------------------------+-----------------+--------+ +| ``url`` | home page for the package | URL | \(1) | ++----------------------+---------------------------+-----------------+--------+ +| ``description`` | short, summary | short string | | +| | description of the | | | +| | package | | | ++----------------------+---------------------------+-----------------+--------+ +| ``long_description`` | longer description of the | long string | \(4) | +| | package | | | ++----------------------+---------------------------+-----------------+--------+ +| ``download_url`` | location where the | URL | | +| | package may be downloaded | | | ++----------------------+---------------------------+-----------------+--------+ +| ``classifiers`` | a list of classifiers | list of strings | (6)(7) | ++----------------------+---------------------------+-----------------+--------+ +| ``platforms`` | a list of platforms | list of strings | (6)(8) | ++----------------------+---------------------------+-----------------+--------+ +| ``keywords`` | a list of keywords | list of strings | (6)(8) | ++----------------------+---------------------------+-----------------+--------+ +| ``license`` | license for the package | short string | \(5) | ++----------------------+---------------------------+-----------------+--------+ + +Notes: + +(1) + These fields are required. + +(2) + It is recommended that versions take the form *major.minor[.patch[.sub]]*. + +(3) + Either the author or the maintainer must be identified. If maintainer is + provided, distutils lists it as the author in :file:`PKG-INFO`. + +(4) + The ``long_description`` field is used by PyPI when you publish a package, + to build its project page. + +(5) + The ``license`` field is a text indicating the license covering the + package where the license is not a selection from the "License" Trove + classifiers. See the ``Classifier`` field. Notice that + there's a ``licence`` distribution option which is deprecated but still + acts as an alias for ``license``. + +(6) + This field must be a list. + +(7) + The valid classifiers are listed on + `PyPI `_. + +(8) + To preserve backward compatibility, this field also accepts a string. If + you pass a comma-separated string ``'foo, bar'``, it will be converted to + ``['foo', 'bar']``, Otherwise, it will be converted to a list of one + string. + +'short string' + A single line of text, not more than 200 characters. + +'long string' + Multiple lines of plain text in reStructuredText format (see + http://docutils.sourceforge.net/). + +'list of strings' + See below. + +Encoding the version information is an art in itself. Python packages generally +adhere to the version format *major.minor[.patch][sub]*. The major number is 0 +for initial, experimental releases of software. It is incremented for releases +that represent major milestones in a package. The minor number is incremented +when important new features are added to the package. The patch number +increments when bug-fix releases are made. Additional trailing version +information is sometimes used to indicate sub-releases. These are +"a1,a2,...,aN" (for alpha releases, where functionality and API may change), +"b1,b2,...,bN" (for beta releases, which only fix bugs) and "pr1,pr2,...,prN" +(for final pre-release release testing). Some examples: + +0.1.0 + the first, experimental release of a package + +1.0.1a2 + the second alpha release of the first patch version of 1.0 + +``classifiers`` must be specified in a list:: + + setup(..., + classifiers=[ + 'Development Status :: 4 - Beta', + 'Environment :: Console', + 'Environment :: Web Environment', + 'Intended Audience :: End Users/Desktop', + 'Intended Audience :: Developers', + 'Intended Audience :: System Administrators', + 'License :: OSI Approved :: Python Software Foundation License', + 'Operating System :: MacOS :: MacOS X', + 'Operating System :: Microsoft :: Windows', + 'Operating System :: POSIX', + 'Programming Language :: Python', + 'Topic :: Communications :: Email', + 'Topic :: Office/Business', + 'Topic :: Software Development :: Bug Tracking', + ], + ) + +.. versionchanged:: 3.7 + :class:`~distutils.core.setup` now warns when ``classifiers``, ``keywords`` + or ``platforms`` fields are not specified as a list or a string. + +.. _debug-setup-script: + +Debugging the setup script +========================== + +Sometimes things go wrong, and the setup script doesn't do what the developer +wants. + +Distutils catches any exceptions when running the setup script, and print a +simple error message before the script is terminated. The motivation for this +behaviour is to not confuse administrators who don't know much about Python and +are trying to install a package. If they get a big long traceback from deep +inside the guts of Distutils, they may think the package or the Python +installation is broken because they don't read all the way down to the bottom +and see that it's a permission problem. + +On the other hand, this doesn't help the developer to find the cause of the +failure. For this purpose, the :envvar:`DISTUTILS_DEBUG` environment variable can be set +to anything except an empty string, and distutils will now print detailed +information about what it is doing, dump the full traceback when an exception +occurs, and print the whole command line when an external program (like a C +compiler) fails. diff --git a/python-3.7.4-docs-html/_sources/distutils/sourcedist.rst.txt b/python-3.7.4-docs-html/_sources/distutils/sourcedist.rst.txt new file mode 100644 index 0000000..0ac8ef4 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/distutils/sourcedist.rst.txt @@ -0,0 +1,240 @@ +.. _source-dist: + +****************************** +Creating a Source Distribution +****************************** + +As shown in section :ref:`distutils-simple-example`, you use the :command:`sdist` command +to create a source distribution. In the simplest case, :: + + python setup.py sdist + +(assuming you haven't specified any :command:`sdist` options in the setup script +or config file), :command:`sdist` creates the archive of the default format for +the current platform. The default format is a gzip'ed tar file +(:file:`.tar.gz`) on Unix, and ZIP file on Windows. + +You can specify as many formats as you like using the :option:`!--formats` +option, for example:: + + python setup.py sdist --formats=gztar,zip + +to create a gzipped tarball and a zip file. The available formats are: + ++-----------+-------------------------+---------+ +| Format | Description | Notes | ++===========+=========================+=========+ +| ``zip`` | zip file (:file:`.zip`) | (1),(3) | ++-----------+-------------------------+---------+ +| ``gztar`` | gzip'ed tar file | \(2) | +| | (:file:`.tar.gz`) | | ++-----------+-------------------------+---------+ +| ``bztar`` | bzip2'ed tar file | | +| | (:file:`.tar.bz2`) | | ++-----------+-------------------------+---------+ +| ``xztar`` | xz'ed tar file | | +| | (:file:`.tar.xz`) | | ++-----------+-------------------------+---------+ +| ``ztar`` | compressed tar file | \(4) | +| | (:file:`.tar.Z`) | | ++-----------+-------------------------+---------+ +| ``tar`` | tar file (:file:`.tar`) | | ++-----------+-------------------------+---------+ + +.. versionchanged:: 3.5 + Added support for the ``xztar`` format. + +Notes: + +(1) + default on Windows + +(2) + default on Unix + +(3) + requires either external :program:`zip` utility or :mod:`zipfile` module (part + of the standard Python library since Python 1.6) + +(4) + requires the :program:`compress` program. Notice that this format is now + pending for deprecation and will be removed in the future versions of Python. + +When using any ``tar`` format (``gztar``, ``bztar``, ``xztar``, ``ztar`` or +``tar``), under Unix you can specify the ``owner`` and ``group`` names +that will be set for each member of the archive. + +For example, if you want all files of the archive to be owned by root:: + + python setup.py sdist --owner=root --group=root + + +.. _manifest: + +Specifying the files to distribute +================================== + +If you don't supply an explicit list of files (or instructions on how to +generate one), the :command:`sdist` command puts a minimal default set into the +source distribution: + +* all Python source files implied by the ``py_modules`` and + ``packages`` options + +* all C source files mentioned in the ``ext_modules`` or + ``libraries`` options + + .. XXX getting C library sources currently broken---no + :meth:`get_source_files` method in :file:`build_clib.py`! + +* scripts identified by the ``scripts`` option + See :ref:`distutils-installing-scripts`. + +* anything that looks like a test script: :file:`test/test\*.py` (currently, the + Distutils don't do anything with test scripts except include them in source + distributions, but in the future there will be a standard for testing Python + module distributions) + +* Any of the standard README files (:file:`README`, :file:`README.txt`, + or :file:`README.rst`), :file:`setup.py` (or whatever you called your setup + script), and :file:`setup.cfg`. + +* all files that matches the ``package_data`` metadata. + See :ref:`distutils-installing-package-data`. + +* all files that matches the ``data_files`` metadata. + See :ref:`distutils-additional-files`. + +Sometimes this is enough, but usually you will want to specify additional files +to distribute. The typical way to do this is to write a *manifest template*, +called :file:`MANIFEST.in` by default. The manifest template is just a list of +instructions for how to generate your manifest file, :file:`MANIFEST`, which is +the exact list of files to include in your source distribution. The +:command:`sdist` command processes this template and generates a manifest based +on its instructions and what it finds in the filesystem. + +If you prefer to roll your own manifest file, the format is simple: one filename +per line, regular files (or symlinks to them) only. If you do supply your own +:file:`MANIFEST`, you must specify everything: the default set of files +described above does not apply in this case. + +.. versionchanged:: 3.1 + An existing generated :file:`MANIFEST` will be regenerated without + :command:`sdist` comparing its modification time to the one of + :file:`MANIFEST.in` or :file:`setup.py`. + +.. versionchanged:: 3.1.3 + :file:`MANIFEST` files start with a comment indicating they are generated. + Files without this comment are not overwritten or removed. + +.. versionchanged:: 3.2.2 + :command:`sdist` will read a :file:`MANIFEST` file if no :file:`MANIFEST.in` + exists, like it used to do. + +.. versionchanged:: 3.7 + :file:`README.rst` is now included in the list of distutils standard READMEs. + + +The manifest template has one command per line, where each command specifies a +set of files to include or exclude from the source distribution. For an +example, again we turn to the Distutils' own manifest template: + +.. code-block:: none + + include *.txt + recursive-include examples *.txt *.py + prune examples/sample?/build + +The meanings should be fairly clear: include all files in the distribution root +matching :file:`\*.txt`, all files anywhere under the :file:`examples` directory +matching :file:`\*.txt` or :file:`\*.py`, and exclude all directories matching +:file:`examples/sample?/build`. All of this is done *after* the standard +include set, so you can exclude files from the standard set with explicit +instructions in the manifest template. (Or, you can use the +:option:`!--no-defaults` option to disable the standard set entirely.) There are +several other commands available in the manifest template mini-language; see +section :ref:`sdist-cmd`. + +The order of commands in the manifest template matters: initially, we have the +list of default files as described above, and each command in the template adds +to or removes from that list of files. Once we have fully processed the +manifest template, we remove files that should not be included in the source +distribution: + +* all files in the Distutils "build" tree (default :file:`build/`) + +* all files in directories named :file:`RCS`, :file:`CVS`, :file:`.svn`, + :file:`.hg`, :file:`.git`, :file:`.bzr` or :file:`_darcs` + +Now we have our complete list of files, which is written to the manifest for +future reference, and then used to build the source distribution archive(s). + +You can disable the default set of included files with the +:option:`!--no-defaults` option, and you can disable the standard exclude set +with :option:`!--no-prune`. + +Following the Distutils' own manifest template, let's trace how the +:command:`sdist` command builds the list of files to include in the Distutils +source distribution: + +#. include all Python source files in the :file:`distutils` and + :file:`distutils/command` subdirectories (because packages corresponding to + those two directories were mentioned in the ``packages`` option in the + setup script---see section :ref:`setup-script`) + +#. include :file:`README.txt`, :file:`setup.py`, and :file:`setup.cfg` (standard + files) + +#. include :file:`test/test\*.py` (standard files) + +#. include :file:`\*.txt` in the distribution root (this will find + :file:`README.txt` a second time, but such redundancies are weeded out later) + +#. include anything matching :file:`\*.txt` or :file:`\*.py` in the sub-tree + under :file:`examples`, + +#. exclude all files in the sub-trees starting at directories matching + :file:`examples/sample?/build`\ ---this may exclude files included by the + previous two steps, so it's important that the ``prune`` command in the manifest + template comes after the ``recursive-include`` command + +#. exclude the entire :file:`build` tree, and any :file:`RCS`, :file:`CVS`, + :file:`.svn`, :file:`.hg`, :file:`.git`, :file:`.bzr` and :file:`_darcs` + directories + +Just like in the setup script, file and directory names in the manifest template +should always be slash-separated; the Distutils will take care of converting +them to the standard representation on your platform. That way, the manifest +template is portable across operating systems. + + +.. _manifest-options: + +Manifest-related options +======================== + +The normal course of operations for the :command:`sdist` command is as follows: + +* if the manifest file (:file:`MANIFEST` by default) exists and the first line + does not have a comment indicating it is generated from :file:`MANIFEST.in`, + then it is used as is, unaltered + +* if the manifest file doesn't exist or has been previously automatically + generated, read :file:`MANIFEST.in` and create the manifest + +* if neither :file:`MANIFEST` nor :file:`MANIFEST.in` exist, create a manifest + with just the default file set + +* use the list of files now in :file:`MANIFEST` (either just generated or read + in) to create the source distribution archive(s) + +There are a couple of options that modify this behaviour. First, use the +:option:`!--no-defaults` and :option:`!--no-prune` to disable the standard +"include" and "exclude" sets. + +Second, you might just want to (re)generate the manifest, but not create a source +distribution:: + + python setup.py sdist --manifest-only + +:option:`!-o` is a shortcut for :option:`!--manifest-only`. diff --git a/python-3.7.4-docs-html/_sources/distutils/uploading.rst.txt b/python-3.7.4-docs-html/_sources/distutils/uploading.rst.txt new file mode 100644 index 0000000..4c391ca --- /dev/null +++ b/python-3.7.4-docs-html/_sources/distutils/uploading.rst.txt @@ -0,0 +1,8 @@ +:orphan: + +*************************************** +Uploading Packages to the Package Index +*************************************** + +References to up to date PyPI documentation can be found at +:ref:`publishing-python-packages`. diff --git a/python-3.7.4-docs-html/_sources/extending/building.rst.txt b/python-3.7.4-docs-html/_sources/extending/building.rst.txt new file mode 100644 index 0000000..9fe12c2 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/extending/building.rst.txt @@ -0,0 +1,167 @@ +.. highlightlang:: c + +.. _building: + +***************************** +Building C and C++ Extensions +***************************** + +A C extension for CPython is a shared library (e.g. a ``.so`` file on Linux, +``.pyd`` on Windows), which exports an *initialization function*. + +To be importable, the shared library must be available on :envvar:`PYTHONPATH`, +and must be named after the module name, with an appropriate extension. +When using distutils, the correct filename is generated automatically. + +The initialization function has the signature: + +.. c:function:: PyObject* PyInit_modulename(void) + +It returns either a fully-initialized module, or a :c:type:`PyModuleDef` +instance. See :ref:`initializing-modules` for details. + +.. highlightlang:: python + +For modules with ASCII-only names, the function must be named +``PyInit_``, with ```` replaced by the name of the +module. When using :ref:`multi-phase-initialization`, non-ASCII module names +are allowed. In this case, the initialization function name is +``PyInitU_``, with ```` encoded using Python's +*punycode* encoding with hyphens replaced by underscores. In Python:: + + def initfunc_name(name): + try: + suffix = b'_' + name.encode('ascii') + except UnicodeEncodeError: + suffix = b'U_' + name.encode('punycode').replace(b'-', b'_') + return b'PyInit' + suffix + +It is possible to export multiple modules from a single shared library by +defining multiple initialization functions. However, importing them requires +using symbolic links or a custom importer, because by default only the +function corresponding to the filename is found. +See the *"Multiple modules in one library"* section in :pep:`489` for details. + + +.. highlightlang:: c + +Building C and C++ Extensions with distutils +============================================ + +.. sectionauthor:: Martin v. Löwis + +Extension modules can be built using distutils, which is included in Python. +Since distutils also supports creation of binary packages, users don't +necessarily need a compiler and distutils to install the extension. + +A distutils package contains a driver script, :file:`setup.py`. This is a plain +Python file, which, in the most simple case, could look like this: + +.. code-block:: python3 + + from distutils.core import setup, Extension + + module1 = Extension('demo', + sources = ['demo.c']) + + setup (name = 'PackageName', + version = '1.0', + description = 'This is a demo package', + ext_modules = [module1]) + + +With this :file:`setup.py`, and a file :file:`demo.c`, running :: + + python setup.py build + +will compile :file:`demo.c`, and produce an extension module named ``demo`` in +the :file:`build` directory. Depending on the system, the module file will end +up in a subdirectory :file:`build/lib.system`, and may have a name like +:file:`demo.so` or :file:`demo.pyd`. + +In the :file:`setup.py`, all execution is performed by calling the ``setup`` +function. This takes a variable number of keyword arguments, of which the +example above uses only a subset. Specifically, the example specifies +meta-information to build packages, and it specifies the contents of the +package. Normally, a package will contain additional modules, like Python +source modules, documentation, subpackages, etc. Please refer to the distutils +documentation in :ref:`distutils-index` to learn more about the features of +distutils; this section explains building extension modules only. + +It is common to pre-compute arguments to :func:`setup`, to better structure the +driver script. In the example above, the ``ext_modules`` argument to +:func:`~distutils.core.setup` is a list of extension modules, each of which is +an instance of +the :class:`~distutils.extension.Extension`. In the example, the instance +defines an extension named ``demo`` which is build by compiling a single source +file, :file:`demo.c`. + +In many cases, building an extension is more complex, since additional +preprocessor defines and libraries may be needed. This is demonstrated in the +example below. + +.. code-block:: python3 + + from distutils.core import setup, Extension + + module1 = Extension('demo', + define_macros = [('MAJOR_VERSION', '1'), + ('MINOR_VERSION', '0')], + include_dirs = ['/usr/local/include'], + libraries = ['tcl83'], + library_dirs = ['/usr/local/lib'], + sources = ['demo.c']) + + setup (name = 'PackageName', + version = '1.0', + description = 'This is a demo package', + author = 'Martin v. Loewis', + author_email = 'martin@v.loewis.de', + url = 'https://docs.python.org/extending/building', + long_description = ''' + This is really just a demo package. + ''', + ext_modules = [module1]) + + +In this example, :func:`~distutils.core.setup` is called with additional +meta-information, which +is recommended when distribution packages have to be built. For the extension +itself, it specifies preprocessor defines, include directories, library +directories, and libraries. Depending on the compiler, distutils passes this +information in different ways to the compiler. For example, on Unix, this may +result in the compilation commands :: + + gcc -DNDEBUG -g -O3 -Wall -Wstrict-prototypes -fPIC -DMAJOR_VERSION=1 -DMINOR_VERSION=0 -I/usr/local/include -I/usr/local/include/python2.2 -c demo.c -o build/temp.linux-i686-2.2/demo.o + + gcc -shared build/temp.linux-i686-2.2/demo.o -L/usr/local/lib -ltcl83 -o build/lib.linux-i686-2.2/demo.so + +These lines are for demonstration purposes only; distutils users should trust +that distutils gets the invocations right. + + +.. _distributing: + +Distributing your extension modules +=================================== + +When an extension has been successfully build, there are three ways to use it. + +End-users will typically want to install the module, they do so by running :: + + python setup.py install + +Module maintainers should produce source packages; to do so, they run :: + + python setup.py sdist + +In some cases, additional files need to be included in a source distribution; +this is done through a :file:`MANIFEST.in` file; see :ref:`manifest` for details. + +If the source distribution has been build successfully, maintainers can also +create binary distributions. Depending on the platform, one of the following +commands can be used to do so. :: + + python setup.py bdist_wininst + python setup.py bdist_rpm + python setup.py bdist_dumb diff --git a/python-3.7.4-docs-html/_sources/extending/embedding.rst.txt b/python-3.7.4-docs-html/_sources/extending/embedding.rst.txt new file mode 100644 index 0000000..13d83b7 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/extending/embedding.rst.txt @@ -0,0 +1,336 @@ +.. highlightlang:: c + + +.. _embedding: + +*************************************** +Embedding Python in Another Application +*************************************** + +The previous chapters discussed how to extend Python, that is, how to extend the +functionality of Python by attaching a library of C functions to it. It is also +possible to do it the other way around: enrich your C/C++ application by +embedding Python in it. Embedding provides your application with the ability to +implement some of the functionality of your application in Python rather than C +or C++. This can be used for many purposes; one example would be to allow users +to tailor the application to their needs by writing some scripts in Python. You +can also use it yourself if some of the functionality can be written in Python +more easily. + +Embedding Python is similar to extending it, but not quite. The difference is +that when you extend Python, the main program of the application is still the +Python interpreter, while if you embed Python, the main program may have nothing +to do with Python --- instead, some parts of the application occasionally call +the Python interpreter to run some Python code. + +So if you are embedding Python, you are providing your own main program. One of +the things this main program has to do is initialize the Python interpreter. At +the very least, you have to call the function :c:func:`Py_Initialize`. There are +optional calls to pass command line arguments to Python. Then later you can +call the interpreter from any part of the application. + +There are several different ways to call the interpreter: you can pass a string +containing Python statements to :c:func:`PyRun_SimpleString`, or you can pass a +stdio file pointer and a file name (for identification in error messages only) +to :c:func:`PyRun_SimpleFile`. You can also call the lower-level operations +described in the previous chapters to construct and use Python objects. + + +.. seealso:: + + :ref:`c-api-index` + The details of Python's C interface are given in this manual. A great deal of + necessary information can be found here. + + +.. _high-level-embedding: + +Very High Level Embedding +========================= + +The simplest form of embedding Python is the use of the very high level +interface. This interface is intended to execute a Python script without needing +to interact with the application directly. This can for example be used to +perform some operation on a file. :: + + #define PY_SSIZE_T_CLEAN + #include + + int + main(int argc, char *argv[]) + { + wchar_t *program = Py_DecodeLocale(argv[0], NULL); + if (program == NULL) { + fprintf(stderr, "Fatal error: cannot decode argv[0]\n"); + exit(1); + } + Py_SetProgramName(program); /* optional but recommended */ + Py_Initialize(); + PyRun_SimpleString("from time import time,ctime\n" + "print('Today is', ctime(time()))\n"); + if (Py_FinalizeEx() < 0) { + exit(120); + } + PyMem_RawFree(program); + return 0; + } + +The :c:func:`Py_SetProgramName` function should be called before +:c:func:`Py_Initialize` to inform the interpreter about paths to Python run-time +libraries. Next, the Python interpreter is initialized with +:c:func:`Py_Initialize`, followed by the execution of a hard-coded Python script +that prints the date and time. Afterwards, the :c:func:`Py_FinalizeEx` call shuts +the interpreter down, followed by the end of the program. In a real program, +you may want to get the Python script from another source, perhaps a text-editor +routine, a file, or a database. Getting the Python code from a file can better +be done by using the :c:func:`PyRun_SimpleFile` function, which saves you the +trouble of allocating memory space and loading the file contents. + + +.. _lower-level-embedding: + +Beyond Very High Level Embedding: An overview +============================================= + +The high level interface gives you the ability to execute arbitrary pieces of +Python code from your application, but exchanging data values is quite +cumbersome to say the least. If you want that, you should use lower level calls. +At the cost of having to write more C code, you can achieve almost anything. + +It should be noted that extending Python and embedding Python is quite the same +activity, despite the different intent. Most topics discussed in the previous +chapters are still valid. To show this, consider what the extension code from +Python to C really does: + +#. Convert data values from Python to C, + +#. Perform a function call to a C routine using the converted values, and + +#. Convert the data values from the call from C to Python. + +When embedding Python, the interface code does: + +#. Convert data values from C to Python, + +#. Perform a function call to a Python interface routine using the converted + values, and + +#. Convert the data values from the call from Python to C. + +As you can see, the data conversion steps are simply swapped to accommodate the +different direction of the cross-language transfer. The only difference is the +routine that you call between both data conversions. When extending, you call a +C routine, when embedding, you call a Python routine. + +This chapter will not discuss how to convert data from Python to C and vice +versa. Also, proper use of references and dealing with errors is assumed to be +understood. Since these aspects do not differ from extending the interpreter, +you can refer to earlier chapters for the required information. + + +.. _pure-embedding: + +Pure Embedding +============== + +The first program aims to execute a function in a Python script. Like in the +section about the very high level interface, the Python interpreter does not +directly interact with the application (but that will change in the next +section). + +The code to run a function defined in a Python script is: + +.. literalinclude:: ../includes/run-func.c + + +This code loads a Python script using ``argv[1]``, and calls the function named +in ``argv[2]``. Its integer arguments are the other values of the ``argv`` +array. If you :ref:`compile and link ` this program (let's call +the finished executable :program:`call`), and use it to execute a Python +script, such as: + +.. code-block:: python + + def multiply(a,b): + print("Will compute", a, "times", b) + c = 0 + for i in range(0, a): + c = c + b + return c + +then the result should be: + +.. code-block:: shell-session + + $ call multiply multiply 3 2 + Will compute 3 times 2 + Result of call: 6 + +Although the program is quite large for its functionality, most of the code is +for data conversion between Python and C, and for error reporting. The +interesting part with respect to embedding Python starts with :: + + Py_Initialize(); + pName = PyUnicode_DecodeFSDefault(argv[1]); + /* Error checking of pName left out */ + pModule = PyImport_Import(pName); + +After initializing the interpreter, the script is loaded using +:c:func:`PyImport_Import`. This routine needs a Python string as its argument, +which is constructed using the :c:func:`PyUnicode_FromString` data conversion +routine. :: + + pFunc = PyObject_GetAttrString(pModule, argv[2]); + /* pFunc is a new reference */ + + if (pFunc && PyCallable_Check(pFunc)) { + ... + } + Py_XDECREF(pFunc); + +Once the script is loaded, the name we're looking for is retrieved using +:c:func:`PyObject_GetAttrString`. If the name exists, and the object returned is +callable, you can safely assume that it is a function. The program then +proceeds by constructing a tuple of arguments as normal. The call to the Python +function is then made with:: + + pValue = PyObject_CallObject(pFunc, pArgs); + +Upon return of the function, ``pValue`` is either *NULL* or it contains a +reference to the return value of the function. Be sure to release the reference +after examining the value. + + +.. _extending-with-embedding: + +Extending Embedded Python +========================= + +Until now, the embedded Python interpreter had no access to functionality from +the application itself. The Python API allows this by extending the embedded +interpreter. That is, the embedded interpreter gets extended with routines +provided by the application. While it sounds complex, it is not so bad. Simply +forget for a while that the application starts the Python interpreter. Instead, +consider the application to be a set of subroutines, and write some glue code +that gives Python access to those routines, just like you would write a normal +Python extension. For example:: + + static int numargs=0; + + /* Return the number of arguments of the application command line */ + static PyObject* + emb_numargs(PyObject *self, PyObject *args) + { + if(!PyArg_ParseTuple(args, ":numargs")) + return NULL; + return PyLong_FromLong(numargs); + } + + static PyMethodDef EmbMethods[] = { + {"numargs", emb_numargs, METH_VARARGS, + "Return the number of arguments received by the process."}, + {NULL, NULL, 0, NULL} + }; + + static PyModuleDef EmbModule = { + PyModuleDef_HEAD_INIT, "emb", NULL, -1, EmbMethods, + NULL, NULL, NULL, NULL + }; + + static PyObject* + PyInit_emb(void) + { + return PyModule_Create(&EmbModule); + } + +Insert the above code just above the :c:func:`main` function. Also, insert the +following two statements before the call to :c:func:`Py_Initialize`:: + + numargs = argc; + PyImport_AppendInittab("emb", &PyInit_emb); + +These two lines initialize the ``numargs`` variable, and make the +:func:`emb.numargs` function accessible to the embedded Python interpreter. +With these extensions, the Python script can do things like + +.. code-block:: python + + import emb + print("Number of arguments", emb.numargs()) + +In a real application, the methods will expose an API of the application to +Python. + +.. TODO: threads, code examples do not really behave well if errors happen + (what to watch out for) + + +.. _embeddingincplusplus: + +Embedding Python in C++ +======================= + +It is also possible to embed Python in a C++ program; precisely how this is done +will depend on the details of the C++ system used; in general you will need to +write the main program in C++, and use the C++ compiler to compile and link your +program. There is no need to recompile Python itself using C++. + + +.. _compiling: + +Compiling and Linking under Unix-like systems +============================================= + +It is not necessarily trivial to find the right flags to pass to your +compiler (and linker) in order to embed the Python interpreter into your +application, particularly because Python needs to load library modules +implemented as C dynamic extensions (:file:`.so` files) linked against +it. + +To find out the required compiler and linker flags, you can execute the +:file:`python{X.Y}-config` script which is generated as part of the +installation process (a :file:`python3-config` script may also be +available). This script has several options, of which the following will +be directly useful to you: + +* ``pythonX.Y-config --cflags`` will give you the recommended flags when + compiling: + + .. code-block:: shell-session + + $ /opt/bin/python3.4-config --cflags + -I/opt/include/python3.4m -I/opt/include/python3.4m -DNDEBUG -g -fwrapv -O3 -Wall -Wstrict-prototypes + +* ``pythonX.Y-config --ldflags`` will give you the recommended flags when + linking: + + .. code-block:: shell-session + + $ /opt/bin/python3.4-config --ldflags + -L/opt/lib/python3.4/config-3.4m -lpthread -ldl -lutil -lm -lpython3.4m -Xlinker -export-dynamic + +.. note:: + To avoid confusion between several Python installations (and especially + between the system Python and your own compiled Python), it is recommended + that you use the absolute path to :file:`python{X.Y}-config`, as in the above + example. + +If this procedure doesn't work for you (it is not guaranteed to work for +all Unix-like platforms; however, we welcome :ref:`bug reports `) +you will have to read your system's documentation about dynamic linking and/or +examine Python's :file:`Makefile` (use :func:`sysconfig.get_makefile_filename` +to find its location) and compilation +options. In this case, the :mod:`sysconfig` module is a useful tool to +programmatically extract the configuration values that you will want to +combine together. For example: + +.. code-block:: pycon + + >>> import sysconfig + >>> sysconfig.get_config_var('LIBS') + '-lpthread -ldl -lutil' + >>> sysconfig.get_config_var('LINKFORSHARED') + '-Xlinker -export-dynamic' + + +.. XXX similar documentation for Windows missing diff --git a/python-3.7.4-docs-html/_sources/extending/extending.rst.txt b/python-3.7.4-docs-html/_sources/extending/extending.rst.txt new file mode 100644 index 0000000..afed3aa --- /dev/null +++ b/python-3.7.4-docs-html/_sources/extending/extending.rst.txt @@ -0,0 +1,1365 @@ +.. highlightlang:: c + + +.. _extending-intro: + +****************************** +Extending Python with C or C++ +****************************** + +It is quite easy to add new built-in modules to Python, if you know how to +program in C. Such :dfn:`extension modules` can do two things that can't be +done directly in Python: they can implement new built-in object types, and they +can call C library functions and system calls. + +To support extensions, the Python API (Application Programmers Interface) +defines a set of functions, macros and variables that provide access to most +aspects of the Python run-time system. The Python API is incorporated in a C +source file by including the header ``"Python.h"``. + +The compilation of an extension module depends on its intended use as well as on +your system setup; details are given in later chapters. + +.. note:: + + The C extension interface is specific to CPython, and extension modules do + not work on other Python implementations. In many cases, it is possible to + avoid writing C extensions and preserve portability to other implementations. + For example, if your use case is calling C library functions or system calls, + you should consider using the :mod:`ctypes` module or the `cffi + `_ library rather than writing + custom C code. + These modules let you write Python code to interface with C code and are more + portable between implementations of Python than writing and compiling a C + extension module. + + +.. _extending-simpleexample: + +A Simple Example +================ + +Let's create an extension module called ``spam`` (the favorite food of Monty +Python fans...) and let's say we want to create a Python interface to the C +library function :c:func:`system` [#]_. This function takes a null-terminated +character string as argument and returns an integer. We want this function to +be callable from Python as follows: + +.. code-block:: pycon + + >>> import spam + >>> status = spam.system("ls -l") + +Begin by creating a file :file:`spammodule.c`. (Historically, if a module is +called ``spam``, the C file containing its implementation is called +:file:`spammodule.c`; if the module name is very long, like ``spammify``, the +module name can be just :file:`spammify.c`.) + +The first two lines of our file can be:: + + #define PY_SSIZE_T_CLEAN + #include + +which pulls in the Python API (you can add a comment describing the purpose of +the module and a copyright notice if you like). + +.. note:: + + Since Python may define some pre-processor definitions which affect the standard + headers on some systems, you *must* include :file:`Python.h` before any standard + headers are included. + + It is recommended to always define ``PY_SSIZE_T_CLEAN`` before including + ``Python.h``. See :ref:`parsetuple` for a description of this macro. + +All user-visible symbols defined by :file:`Python.h` have a prefix of ``Py`` or +``PY``, except those defined in standard header files. For convenience, and +since they are used extensively by the Python interpreter, ``"Python.h"`` +includes a few standard header files: ````, ````, +````, and ````. If the latter header file does not exist on +your system, it declares the functions :c:func:`malloc`, :c:func:`free` and +:c:func:`realloc` directly. + +The next thing we add to our module file is the C function that will be called +when the Python expression ``spam.system(string)`` is evaluated (we'll see +shortly how it ends up being called):: + + static PyObject * + spam_system(PyObject *self, PyObject *args) + { + const char *command; + int sts; + + if (!PyArg_ParseTuple(args, "s", &command)) + return NULL; + sts = system(command); + return PyLong_FromLong(sts); + } + +There is a straightforward translation from the argument list in Python (for +example, the single expression ``"ls -l"``) to the arguments passed to the C +function. The C function always has two arguments, conventionally named *self* +and *args*. + +The *self* argument points to the module object for module-level functions; +for a method it would point to the object instance. + +The *args* argument will be a pointer to a Python tuple object containing the +arguments. Each item of the tuple corresponds to an argument in the call's +argument list. The arguments are Python objects --- in order to do anything +with them in our C function we have to convert them to C values. The function +:c:func:`PyArg_ParseTuple` in the Python API checks the argument types and +converts them to C values. It uses a template string to determine the required +types of the arguments as well as the types of the C variables into which to +store the converted values. More about this later. + +:c:func:`PyArg_ParseTuple` returns true (nonzero) if all arguments have the right +type and its components have been stored in the variables whose addresses are +passed. It returns false (zero) if an invalid argument list was passed. In the +latter case it also raises an appropriate exception so the calling function can +return *NULL* immediately (as we saw in the example). + + +.. _extending-errors: + +Intermezzo: Errors and Exceptions +================================= + +An important convention throughout the Python interpreter is the following: when +a function fails, it should set an exception condition and return an error value +(usually a *NULL* pointer). Exceptions are stored in a static global variable +inside the interpreter; if this variable is *NULL* no exception has occurred. A +second global variable stores the "associated value" of the exception (the +second argument to :keyword:`raise`). A third variable contains the stack +traceback in case the error originated in Python code. These three variables +are the C equivalents of the result in Python of :meth:`sys.exc_info` (see the +section on module :mod:`sys` in the Python Library Reference). It is important +to know about them to understand how errors are passed around. + +The Python API defines a number of functions to set various types of exceptions. + +The most common one is :c:func:`PyErr_SetString`. Its arguments are an exception +object and a C string. The exception object is usually a predefined object like +:c:data:`PyExc_ZeroDivisionError`. The C string indicates the cause of the error +and is converted to a Python string object and stored as the "associated value" +of the exception. + +Another useful function is :c:func:`PyErr_SetFromErrno`, which only takes an +exception argument and constructs the associated value by inspection of the +global variable :c:data:`errno`. The most general function is +:c:func:`PyErr_SetObject`, which takes two object arguments, the exception and +its associated value. You don't need to :c:func:`Py_INCREF` the objects passed +to any of these functions. + +You can test non-destructively whether an exception has been set with +:c:func:`PyErr_Occurred`. This returns the current exception object, or *NULL* +if no exception has occurred. You normally don't need to call +:c:func:`PyErr_Occurred` to see whether an error occurred in a function call, +since you should be able to tell from the return value. + +When a function *f* that calls another function *g* detects that the latter +fails, *f* should itself return an error value (usually *NULL* or ``-1``). It +should *not* call one of the :c:func:`PyErr_\*` functions --- one has already +been called by *g*. *f*'s caller is then supposed to also return an error +indication to *its* caller, again *without* calling :c:func:`PyErr_\*`, and so on +--- the most detailed cause of the error was already reported by the function +that first detected it. Once the error reaches the Python interpreter's main +loop, this aborts the currently executing Python code and tries to find an +exception handler specified by the Python programmer. + +(There are situations where a module can actually give a more detailed error +message by calling another :c:func:`PyErr_\*` function, and in such cases it is +fine to do so. As a general rule, however, this is not necessary, and can cause +information about the cause of the error to be lost: most operations can fail +for a variety of reasons.) + +To ignore an exception set by a function call that failed, the exception +condition must be cleared explicitly by calling :c:func:`PyErr_Clear`. The only +time C code should call :c:func:`PyErr_Clear` is if it doesn't want to pass the +error on to the interpreter but wants to handle it completely by itself +(possibly by trying something else, or pretending nothing went wrong). + +Every failing :c:func:`malloc` call must be turned into an exception --- the +direct caller of :c:func:`malloc` (or :c:func:`realloc`) must call +:c:func:`PyErr_NoMemory` and return a failure indicator itself. All the +object-creating functions (for example, :c:func:`PyLong_FromLong`) already do +this, so this note is only relevant to those who call :c:func:`malloc` directly. + +Also note that, with the important exception of :c:func:`PyArg_ParseTuple` and +friends, functions that return an integer status usually return a positive value +or zero for success and ``-1`` for failure, like Unix system calls. + +Finally, be careful to clean up garbage (by making :c:func:`Py_XDECREF` or +:c:func:`Py_DECREF` calls for objects you have already created) when you return +an error indicator! + +The choice of which exception to raise is entirely yours. There are predeclared +C objects corresponding to all built-in Python exceptions, such as +:c:data:`PyExc_ZeroDivisionError`, which you can use directly. Of course, you +should choose exceptions wisely --- don't use :c:data:`PyExc_TypeError` to mean +that a file couldn't be opened (that should probably be :c:data:`PyExc_IOError`). +If something's wrong with the argument list, the :c:func:`PyArg_ParseTuple` +function usually raises :c:data:`PyExc_TypeError`. If you have an argument whose +value must be in a particular range or must satisfy other conditions, +:c:data:`PyExc_ValueError` is appropriate. + +You can also define a new exception that is unique to your module. For this, you +usually declare a static object variable at the beginning of your file:: + + static PyObject *SpamError; + +and initialize it in your module's initialization function (:c:func:`PyInit_spam`) +with an exception object (leaving out the error checking for now):: + + PyMODINIT_FUNC + PyInit_spam(void) + { + PyObject *m; + + m = PyModule_Create(&spammodule); + if (m == NULL) + return NULL; + + SpamError = PyErr_NewException("spam.error", NULL, NULL); + Py_INCREF(SpamError); + PyModule_AddObject(m, "error", SpamError); + return m; + } + +Note that the Python name for the exception object is :exc:`spam.error`. The +:c:func:`PyErr_NewException` function may create a class with the base class +being :exc:`Exception` (unless another class is passed in instead of *NULL*), +described in :ref:`bltin-exceptions`. + +Note also that the :c:data:`SpamError` variable retains a reference to the newly +created exception class; this is intentional! Since the exception could be +removed from the module by external code, an owned reference to the class is +needed to ensure that it will not be discarded, causing :c:data:`SpamError` to +become a dangling pointer. Should it become a dangling pointer, C code which +raises the exception could cause a core dump or other unintended side effects. + +We discuss the use of ``PyMODINIT_FUNC`` as a function return type later in this +sample. + +The :exc:`spam.error` exception can be raised in your extension module using a +call to :c:func:`PyErr_SetString` as shown below:: + + static PyObject * + spam_system(PyObject *self, PyObject *args) + { + const char *command; + int sts; + + if (!PyArg_ParseTuple(args, "s", &command)) + return NULL; + sts = system(command); + if (sts < 0) { + PyErr_SetString(SpamError, "System command failed"); + return NULL; + } + return PyLong_FromLong(sts); + } + + +.. _backtoexample: + +Back to the Example +=================== + +Going back to our example function, you should now be able to understand this +statement:: + + if (!PyArg_ParseTuple(args, "s", &command)) + return NULL; + +It returns *NULL* (the error indicator for functions returning object pointers) +if an error is detected in the argument list, relying on the exception set by +:c:func:`PyArg_ParseTuple`. Otherwise the string value of the argument has been +copied to the local variable :c:data:`command`. This is a pointer assignment and +you are not supposed to modify the string to which it points (so in Standard C, +the variable :c:data:`command` should properly be declared as ``const char +*command``). + +The next statement is a call to the Unix function :c:func:`system`, passing it +the string we just got from :c:func:`PyArg_ParseTuple`:: + + sts = system(command); + +Our :func:`spam.system` function must return the value of :c:data:`sts` as a +Python object. This is done using the function :c:func:`PyLong_FromLong`. :: + + return PyLong_FromLong(sts); + +In this case, it will return an integer object. (Yes, even integers are objects +on the heap in Python!) + +If you have a C function that returns no useful argument (a function returning +:c:type:`void`), the corresponding Python function must return ``None``. You +need this idiom to do so (which is implemented by the :c:macro:`Py_RETURN_NONE` +macro):: + + Py_INCREF(Py_None); + return Py_None; + +:c:data:`Py_None` is the C name for the special Python object ``None``. It is a +genuine Python object rather than a *NULL* pointer, which means "error" in most +contexts, as we have seen. + + +.. _methodtable: + +The Module's Method Table and Initialization Function +===================================================== + +I promised to show how :c:func:`spam_system` is called from Python programs. +First, we need to list its name and address in a "method table":: + + static PyMethodDef SpamMethods[] = { + ... + {"system", spam_system, METH_VARARGS, + "Execute a shell command."}, + ... + {NULL, NULL, 0, NULL} /* Sentinel */ + }; + +Note the third entry (``METH_VARARGS``). This is a flag telling the interpreter +the calling convention to be used for the C function. It should normally always +be ``METH_VARARGS`` or ``METH_VARARGS | METH_KEYWORDS``; a value of ``0`` means +that an obsolete variant of :c:func:`PyArg_ParseTuple` is used. + +When using only ``METH_VARARGS``, the function should expect the Python-level +parameters to be passed in as a tuple acceptable for parsing via +:c:func:`PyArg_ParseTuple`; more information on this function is provided below. + +The :const:`METH_KEYWORDS` bit may be set in the third field if keyword +arguments should be passed to the function. In this case, the C function should +accept a third ``PyObject *`` parameter which will be a dictionary of keywords. +Use :c:func:`PyArg_ParseTupleAndKeywords` to parse the arguments to such a +function. + +The method table must be referenced in the module definition structure:: + + static struct PyModuleDef spammodule = { + PyModuleDef_HEAD_INIT, + "spam", /* name of module */ + spam_doc, /* module documentation, may be NULL */ + -1, /* size of per-interpreter state of the module, + or -1 if the module keeps state in global variables. */ + SpamMethods + }; + +This structure, in turn, must be passed to the interpreter in the module's +initialization function. The initialization function must be named +:c:func:`PyInit_name`, where *name* is the name of the module, and should be the +only non-\ ``static`` item defined in the module file:: + + PyMODINIT_FUNC + PyInit_spam(void) + { + return PyModule_Create(&spammodule); + } + +Note that PyMODINIT_FUNC declares the function as ``PyObject *`` return type, +declares any special linkage declarations required by the platform, and for C++ +declares the function as ``extern "C"``. + +When the Python program imports module :mod:`spam` for the first time, +:c:func:`PyInit_spam` is called. (See below for comments about embedding Python.) +It calls :c:func:`PyModule_Create`, which returns a module object, and +inserts built-in function objects into the newly created module based upon the +table (an array of :c:type:`PyMethodDef` structures) found in the module definition. +:c:func:`PyModule_Create` returns a pointer to the module object +that it creates. It may abort with a fatal error for +certain errors, or return *NULL* if the module could not be initialized +satisfactorily. The init function must return the module object to its caller, +so that it then gets inserted into ``sys.modules``. + +When embedding Python, the :c:func:`PyInit_spam` function is not called +automatically unless there's an entry in the :c:data:`PyImport_Inittab` table. +To add the module to the initialization table, use :c:func:`PyImport_AppendInittab`, +optionally followed by an import of the module:: + + int + main(int argc, char *argv[]) + { + wchar_t *program = Py_DecodeLocale(argv[0], NULL); + if (program == NULL) { + fprintf(stderr, "Fatal error: cannot decode argv[0]\n"); + exit(1); + } + + /* Add a built-in module, before Py_Initialize */ + PyImport_AppendInittab("spam", PyInit_spam); + + /* Pass argv[0] to the Python interpreter */ + Py_SetProgramName(program); + + /* Initialize the Python interpreter. Required. */ + Py_Initialize(); + + /* Optionally import the module; alternatively, + import can be deferred until the embedded script + imports it. */ + PyImport_ImportModule("spam"); + + ... + + PyMem_RawFree(program); + return 0; + } + +.. note:: + + Removing entries from ``sys.modules`` or importing compiled modules into + multiple interpreters within a process (or following a :c:func:`fork` without an + intervening :c:func:`exec`) can create problems for some extension modules. + Extension module authors should exercise caution when initializing internal data + structures. + +A more substantial example module is included in the Python source distribution +as :file:`Modules/xxmodule.c`. This file may be used as a template or simply +read as an example. + +.. note:: + + Unlike our ``spam`` example, ``xxmodule`` uses *multi-phase initialization* + (new in Python 3.5), where a PyModuleDef structure is returned from + ``PyInit_spam``, and creation of the module is left to the import machinery. + For details on multi-phase initialization, see :PEP:`489`. + + +.. _compilation: + +Compilation and Linkage +======================= + +There are two more things to do before you can use your new extension: compiling +and linking it with the Python system. If you use dynamic loading, the details +may depend on the style of dynamic loading your system uses; see the chapters +about building extension modules (chapter :ref:`building`) and additional +information that pertains only to building on Windows (chapter +:ref:`building-on-windows`) for more information about this. + +If you can't use dynamic loading, or if you want to make your module a permanent +part of the Python interpreter, you will have to change the configuration setup +and rebuild the interpreter. Luckily, this is very simple on Unix: just place +your file (:file:`spammodule.c` for example) in the :file:`Modules/` directory +of an unpacked source distribution, add a line to the file +:file:`Modules/Setup.local` describing your file: + +.. code-block:: sh + + spam spammodule.o + +and rebuild the interpreter by running :program:`make` in the toplevel +directory. You can also run :program:`make` in the :file:`Modules/` +subdirectory, but then you must first rebuild :file:`Makefile` there by running +':program:`make` Makefile'. (This is necessary each time you change the +:file:`Setup` file.) + +If your module requires additional libraries to link with, these can be listed +on the line in the configuration file as well, for instance: + +.. code-block:: sh + + spam spammodule.o -lX11 + + +.. _callingpython: + +Calling Python Functions from C +=============================== + +So far we have concentrated on making C functions callable from Python. The +reverse is also useful: calling Python functions from C. This is especially the +case for libraries that support so-called "callback" functions. If a C +interface makes use of callbacks, the equivalent Python often needs to provide a +callback mechanism to the Python programmer; the implementation will require +calling the Python callback functions from a C callback. Other uses are also +imaginable. + +Fortunately, the Python interpreter is easily called recursively, and there is a +standard interface to call a Python function. (I won't dwell on how to call the +Python parser with a particular string as input --- if you're interested, have a +look at the implementation of the :option:`-c` command line option in +:file:`Modules/main.c` from the Python source code.) + +Calling a Python function is easy. First, the Python program must somehow pass +you the Python function object. You should provide a function (or some other +interface) to do this. When this function is called, save a pointer to the +Python function object (be careful to :c:func:`Py_INCREF` it!) in a global +variable --- or wherever you see fit. For example, the following function might +be part of a module definition:: + + static PyObject *my_callback = NULL; + + static PyObject * + my_set_callback(PyObject *dummy, PyObject *args) + { + PyObject *result = NULL; + PyObject *temp; + + if (PyArg_ParseTuple(args, "O:set_callback", &temp)) { + if (!PyCallable_Check(temp)) { + PyErr_SetString(PyExc_TypeError, "parameter must be callable"); + return NULL; + } + Py_XINCREF(temp); /* Add a reference to new callback */ + Py_XDECREF(my_callback); /* Dispose of previous callback */ + my_callback = temp; /* Remember new callback */ + /* Boilerplate to return "None" */ + Py_INCREF(Py_None); + result = Py_None; + } + return result; + } + +This function must be registered with the interpreter using the +:const:`METH_VARARGS` flag; this is described in section :ref:`methodtable`. The +:c:func:`PyArg_ParseTuple` function and its arguments are documented in section +:ref:`parsetuple`. + +The macros :c:func:`Py_XINCREF` and :c:func:`Py_XDECREF` increment/decrement the +reference count of an object and are safe in the presence of *NULL* pointers +(but note that *temp* will not be *NULL* in this context). More info on them +in section :ref:`refcounts`. + +.. index:: single: PyObject_CallObject() + +Later, when it is time to call the function, you call the C function +:c:func:`PyObject_CallObject`. This function has two arguments, both pointers to +arbitrary Python objects: the Python function, and the argument list. The +argument list must always be a tuple object, whose length is the number of +arguments. To call the Python function with no arguments, pass in NULL, or +an empty tuple; to call it with one argument, pass a singleton tuple. +:c:func:`Py_BuildValue` returns a tuple when its format string consists of zero +or more format codes between parentheses. For example:: + + int arg; + PyObject *arglist; + PyObject *result; + ... + arg = 123; + ... + /* Time to call the callback */ + arglist = Py_BuildValue("(i)", arg); + result = PyObject_CallObject(my_callback, arglist); + Py_DECREF(arglist); + +:c:func:`PyObject_CallObject` returns a Python object pointer: this is the return +value of the Python function. :c:func:`PyObject_CallObject` is +"reference-count-neutral" with respect to its arguments. In the example a new +tuple was created to serve as the argument list, which is +:c:func:`Py_DECREF`\ -ed immediately after the :c:func:`PyObject_CallObject` +call. + +The return value of :c:func:`PyObject_CallObject` is "new": either it is a brand +new object, or it is an existing object whose reference count has been +incremented. So, unless you want to save it in a global variable, you should +somehow :c:func:`Py_DECREF` the result, even (especially!) if you are not +interested in its value. + +Before you do this, however, it is important to check that the return value +isn't *NULL*. If it is, the Python function terminated by raising an exception. +If the C code that called :c:func:`PyObject_CallObject` is called from Python, it +should now return an error indication to its Python caller, so the interpreter +can print a stack trace, or the calling Python code can handle the exception. +If this is not possible or desirable, the exception should be cleared by calling +:c:func:`PyErr_Clear`. For example:: + + if (result == NULL) + return NULL; /* Pass error back */ + ...use result... + Py_DECREF(result); + +Depending on the desired interface to the Python callback function, you may also +have to provide an argument list to :c:func:`PyObject_CallObject`. In some cases +the argument list is also provided by the Python program, through the same +interface that specified the callback function. It can then be saved and used +in the same manner as the function object. In other cases, you may have to +construct a new tuple to pass as the argument list. The simplest way to do this +is to call :c:func:`Py_BuildValue`. For example, if you want to pass an integral +event code, you might use the following code:: + + PyObject *arglist; + ... + arglist = Py_BuildValue("(l)", eventcode); + result = PyObject_CallObject(my_callback, arglist); + Py_DECREF(arglist); + if (result == NULL) + return NULL; /* Pass error back */ + /* Here maybe use the result */ + Py_DECREF(result); + +Note the placement of ``Py_DECREF(arglist)`` immediately after the call, before +the error check! Also note that strictly speaking this code is not complete: +:c:func:`Py_BuildValue` may run out of memory, and this should be checked. + +You may also call a function with keyword arguments by using +:c:func:`PyObject_Call`, which supports arguments and keyword arguments. As in +the above example, we use :c:func:`Py_BuildValue` to construct the dictionary. :: + + PyObject *dict; + ... + dict = Py_BuildValue("{s:i}", "name", val); + result = PyObject_Call(my_callback, NULL, dict); + Py_DECREF(dict); + if (result == NULL) + return NULL; /* Pass error back */ + /* Here maybe use the result */ + Py_DECREF(result); + + +.. _parsetuple: + +Extracting Parameters in Extension Functions +============================================ + +.. index:: single: PyArg_ParseTuple() + +The :c:func:`PyArg_ParseTuple` function is declared as follows:: + + int PyArg_ParseTuple(PyObject *arg, const char *format, ...); + +The *arg* argument must be a tuple object containing an argument list passed +from Python to a C function. The *format* argument must be a format string, +whose syntax is explained in :ref:`arg-parsing` in the Python/C API Reference +Manual. The remaining arguments must be addresses of variables whose type is +determined by the format string. + +Note that while :c:func:`PyArg_ParseTuple` checks that the Python arguments have +the required types, it cannot check the validity of the addresses of C variables +passed to the call: if you make mistakes there, your code will probably crash or +at least overwrite random bits in memory. So be careful! + +Note that any Python object references which are provided to the caller are +*borrowed* references; do not decrement their reference count! + +Some example calls:: + + #define PY_SSIZE_T_CLEAN /* Make "s#" use Py_ssize_t rather than int. */ + #include + +:: + + int ok; + int i, j; + long k, l; + const char *s; + Py_ssize_t size; + + ok = PyArg_ParseTuple(args, ""); /* No arguments */ + /* Python call: f() */ + +:: + + ok = PyArg_ParseTuple(args, "s", &s); /* A string */ + /* Possible Python call: f('whoops!') */ + +:: + + ok = PyArg_ParseTuple(args, "lls", &k, &l, &s); /* Two longs and a string */ + /* Possible Python call: f(1, 2, 'three') */ + +:: + + ok = PyArg_ParseTuple(args, "(ii)s#", &i, &j, &s, &size); + /* A pair of ints and a string, whose size is also returned */ + /* Possible Python call: f((1, 2), 'three') */ + +:: + + { + const char *file; + const char *mode = "r"; + int bufsize = 0; + ok = PyArg_ParseTuple(args, "s|si", &file, &mode, &bufsize); + /* A string, and optionally another string and an integer */ + /* Possible Python calls: + f('spam') + f('spam', 'w') + f('spam', 'wb', 100000) */ + } + +:: + + { + int left, top, right, bottom, h, v; + ok = PyArg_ParseTuple(args, "((ii)(ii))(ii)", + &left, &top, &right, &bottom, &h, &v); + /* A rectangle and a point */ + /* Possible Python call: + f(((0, 0), (400, 300)), (10, 10)) */ + } + +:: + + { + Py_complex c; + ok = PyArg_ParseTuple(args, "D:myfunction", &c); + /* a complex, also providing a function name for errors */ + /* Possible Python call: myfunction(1+2j) */ + } + + +.. _parsetupleandkeywords: + +Keyword Parameters for Extension Functions +========================================== + +.. index:: single: PyArg_ParseTupleAndKeywords() + +The :c:func:`PyArg_ParseTupleAndKeywords` function is declared as follows:: + + int PyArg_ParseTupleAndKeywords(PyObject *arg, PyObject *kwdict, + const char *format, char *kwlist[], ...); + +The *arg* and *format* parameters are identical to those of the +:c:func:`PyArg_ParseTuple` function. The *kwdict* parameter is the dictionary of +keywords received as the third parameter from the Python runtime. The *kwlist* +parameter is a *NULL*-terminated list of strings which identify the parameters; +the names are matched with the type information from *format* from left to +right. On success, :c:func:`PyArg_ParseTupleAndKeywords` returns true, otherwise +it returns false and raises an appropriate exception. + +.. note:: + + Nested tuples cannot be parsed when using keyword arguments! Keyword parameters + passed in which are not present in the *kwlist* will cause :exc:`TypeError` to + be raised. + +.. index:: single: Philbrick, Geoff + +Here is an example module which uses keywords, based on an example by Geoff +Philbrick (philbrick@hks.com):: + + #define PY_SSIZE_T_CLEAN /* Make "s#" use Py_ssize_t rather than int. */ + #include + + static PyObject * + keywdarg_parrot(PyObject *self, PyObject *args, PyObject *keywds) + { + int voltage; + const char *state = "a stiff"; + const char *action = "voom"; + const char *type = "Norwegian Blue"; + + static char *kwlist[] = {"voltage", "state", "action", "type", NULL}; + + if (!PyArg_ParseTupleAndKeywords(args, keywds, "i|sss", kwlist, + &voltage, &state, &action, &type)) + return NULL; + + printf("-- This parrot wouldn't %s if you put %i Volts through it.\n", + action, voltage); + printf("-- Lovely plumage, the %s -- It's %s!\n", type, state); + + Py_RETURN_NONE; + } + + static PyMethodDef keywdarg_methods[] = { + /* The cast of the function is necessary since PyCFunction values + * only take two PyObject* parameters, and keywdarg_parrot() takes + * three. + */ + {"parrot", (PyCFunction)keywdarg_parrot, METH_VARARGS | METH_KEYWORDS, + "Print a lovely skit to standard output."}, + {NULL, NULL, 0, NULL} /* sentinel */ + }; + + static struct PyModuleDef keywdargmodule = { + PyModuleDef_HEAD_INIT, + "keywdarg", + NULL, + -1, + keywdarg_methods + }; + + PyMODINIT_FUNC + PyInit_keywdarg(void) + { + return PyModule_Create(&keywdargmodule); + } + + +.. _buildvalue: + +Building Arbitrary Values +========================= + +This function is the counterpart to :c:func:`PyArg_ParseTuple`. It is declared +as follows:: + + PyObject *Py_BuildValue(const char *format, ...); + +It recognizes a set of format units similar to the ones recognized by +:c:func:`PyArg_ParseTuple`, but the arguments (which are input to the function, +not output) must not be pointers, just values. It returns a new Python object, +suitable for returning from a C function called from Python. + +One difference with :c:func:`PyArg_ParseTuple`: while the latter requires its +first argument to be a tuple (since Python argument lists are always represented +as tuples internally), :c:func:`Py_BuildValue` does not always build a tuple. It +builds a tuple only if its format string contains two or more format units. If +the format string is empty, it returns ``None``; if it contains exactly one +format unit, it returns whatever object is described by that format unit. To +force it to return a tuple of size 0 or one, parenthesize the format string. + +Examples (to the left the call, to the right the resulting Python value): + +.. code-block:: none + + Py_BuildValue("") None + Py_BuildValue("i", 123) 123 + Py_BuildValue("iii", 123, 456, 789) (123, 456, 789) + Py_BuildValue("s", "hello") 'hello' + Py_BuildValue("y", "hello") b'hello' + Py_BuildValue("ss", "hello", "world") ('hello', 'world') + Py_BuildValue("s#", "hello", 4) 'hell' + Py_BuildValue("y#", "hello", 4) b'hell' + Py_BuildValue("()") () + Py_BuildValue("(i)", 123) (123,) + Py_BuildValue("(ii)", 123, 456) (123, 456) + Py_BuildValue("(i,i)", 123, 456) (123, 456) + Py_BuildValue("[i,i]", 123, 456) [123, 456] + Py_BuildValue("{s:i,s:i}", + "abc", 123, "def", 456) {'abc': 123, 'def': 456} + Py_BuildValue("((ii)(ii)) (ii)", + 1, 2, 3, 4, 5, 6) (((1, 2), (3, 4)), (5, 6)) + + +.. _refcounts: + +Reference Counts +================ + +In languages like C or C++, the programmer is responsible for dynamic allocation +and deallocation of memory on the heap. In C, this is done using the functions +:c:func:`malloc` and :c:func:`free`. In C++, the operators ``new`` and +``delete`` are used with essentially the same meaning and we'll restrict +the following discussion to the C case. + +Every block of memory allocated with :c:func:`malloc` should eventually be +returned to the pool of available memory by exactly one call to :c:func:`free`. +It is important to call :c:func:`free` at the right time. If a block's address +is forgotten but :c:func:`free` is not called for it, the memory it occupies +cannot be reused until the program terminates. This is called a :dfn:`memory +leak`. On the other hand, if a program calls :c:func:`free` for a block and then +continues to use the block, it creates a conflict with re-use of the block +through another :c:func:`malloc` call. This is called :dfn:`using freed memory`. +It has the same bad consequences as referencing uninitialized data --- core +dumps, wrong results, mysterious crashes. + +Common causes of memory leaks are unusual paths through the code. For instance, +a function may allocate a block of memory, do some calculation, and then free +the block again. Now a change in the requirements for the function may add a +test to the calculation that detects an error condition and can return +prematurely from the function. It's easy to forget to free the allocated memory +block when taking this premature exit, especially when it is added later to the +code. Such leaks, once introduced, often go undetected for a long time: the +error exit is taken only in a small fraction of all calls, and most modern +machines have plenty of virtual memory, so the leak only becomes apparent in a +long-running process that uses the leaking function frequently. Therefore, it's +important to prevent leaks from happening by having a coding convention or +strategy that minimizes this kind of errors. + +Since Python makes heavy use of :c:func:`malloc` and :c:func:`free`, it needs a +strategy to avoid memory leaks as well as the use of freed memory. The chosen +method is called :dfn:`reference counting`. The principle is simple: every +object contains a counter, which is incremented when a reference to the object +is stored somewhere, and which is decremented when a reference to it is deleted. +When the counter reaches zero, the last reference to the object has been deleted +and the object is freed. + +An alternative strategy is called :dfn:`automatic garbage collection`. +(Sometimes, reference counting is also referred to as a garbage collection +strategy, hence my use of "automatic" to distinguish the two.) The big +advantage of automatic garbage collection is that the user doesn't need to call +:c:func:`free` explicitly. (Another claimed advantage is an improvement in speed +or memory usage --- this is no hard fact however.) The disadvantage is that for +C, there is no truly portable automatic garbage collector, while reference +counting can be implemented portably (as long as the functions :c:func:`malloc` +and :c:func:`free` are available --- which the C Standard guarantees). Maybe some +day a sufficiently portable automatic garbage collector will be available for C. +Until then, we'll have to live with reference counts. + +While Python uses the traditional reference counting implementation, it also +offers a cycle detector that works to detect reference cycles. This allows +applications to not worry about creating direct or indirect circular references; +these are the weakness of garbage collection implemented using only reference +counting. Reference cycles consist of objects which contain (possibly indirect) +references to themselves, so that each object in the cycle has a reference count +which is non-zero. Typical reference counting implementations are not able to +reclaim the memory belonging to any objects in a reference cycle, or referenced +from the objects in the cycle, even though there are no further references to +the cycle itself. + +The cycle detector is able to detect garbage cycles and can reclaim them. +The :mod:`gc` module exposes a way to run the detector (the +:func:`~gc.collect` function), as well as configuration +interfaces and the ability to disable the detector at runtime. The cycle +detector is considered an optional component; though it is included by default, +it can be disabled at build time using the :option:`!--without-cycle-gc` option +to the :program:`configure` script on Unix platforms (including Mac OS X). If +the cycle detector is disabled in this way, the :mod:`gc` module will not be +available. + + +.. _refcountsinpython: + +Reference Counting in Python +---------------------------- + +There are two macros, ``Py_INCREF(x)`` and ``Py_DECREF(x)``, which handle the +incrementing and decrementing of the reference count. :c:func:`Py_DECREF` also +frees the object when the count reaches zero. For flexibility, it doesn't call +:c:func:`free` directly --- rather, it makes a call through a function pointer in +the object's :dfn:`type object`. For this purpose (and others), every object +also contains a pointer to its type object. + +The big question now remains: when to use ``Py_INCREF(x)`` and ``Py_DECREF(x)``? +Let's first introduce some terms. Nobody "owns" an object; however, you can +:dfn:`own a reference` to an object. An object's reference count is now defined +as the number of owned references to it. The owner of a reference is +responsible for calling :c:func:`Py_DECREF` when the reference is no longer +needed. Ownership of a reference can be transferred. There are three ways to +dispose of an owned reference: pass it on, store it, or call :c:func:`Py_DECREF`. +Forgetting to dispose of an owned reference creates a memory leak. + +It is also possible to :dfn:`borrow` [#]_ a reference to an object. The +borrower of a reference should not call :c:func:`Py_DECREF`. The borrower must +not hold on to the object longer than the owner from which it was borrowed. +Using a borrowed reference after the owner has disposed of it risks using freed +memory and should be avoided completely [#]_. + +The advantage of borrowing over owning a reference is that you don't need to +take care of disposing of the reference on all possible paths through the code +--- in other words, with a borrowed reference you don't run the risk of leaking +when a premature exit is taken. The disadvantage of borrowing over owning is +that there are some subtle situations where in seemingly correct code a borrowed +reference can be used after the owner from which it was borrowed has in fact +disposed of it. + +A borrowed reference can be changed into an owned reference by calling +:c:func:`Py_INCREF`. This does not affect the status of the owner from which the +reference was borrowed --- it creates a new owned reference, and gives full +owner responsibilities (the new owner must dispose of the reference properly, as +well as the previous owner). + + +.. _ownershiprules: + +Ownership Rules +--------------- + +Whenever an object reference is passed into or out of a function, it is part of +the function's interface specification whether ownership is transferred with the +reference or not. + +Most functions that return a reference to an object pass on ownership with the +reference. In particular, all functions whose function it is to create a new +object, such as :c:func:`PyLong_FromLong` and :c:func:`Py_BuildValue`, pass +ownership to the receiver. Even if the object is not actually new, you still +receive ownership of a new reference to that object. For instance, +:c:func:`PyLong_FromLong` maintains a cache of popular values and can return a +reference to a cached item. + +Many functions that extract objects from other objects also transfer ownership +with the reference, for instance :c:func:`PyObject_GetAttrString`. The picture +is less clear, here, however, since a few common routines are exceptions: +:c:func:`PyTuple_GetItem`, :c:func:`PyList_GetItem`, :c:func:`PyDict_GetItem`, and +:c:func:`PyDict_GetItemString` all return references that you borrow from the +tuple, list or dictionary. + +The function :c:func:`PyImport_AddModule` also returns a borrowed reference, even +though it may actually create the object it returns: this is possible because an +owned reference to the object is stored in ``sys.modules``. + +When you pass an object reference into another function, in general, the +function borrows the reference from you --- if it needs to store it, it will use +:c:func:`Py_INCREF` to become an independent owner. There are exactly two +important exceptions to this rule: :c:func:`PyTuple_SetItem` and +:c:func:`PyList_SetItem`. These functions take over ownership of the item passed +to them --- even if they fail! (Note that :c:func:`PyDict_SetItem` and friends +don't take over ownership --- they are "normal.") + +When a C function is called from Python, it borrows references to its arguments +from the caller. The caller owns a reference to the object, so the borrowed +reference's lifetime is guaranteed until the function returns. Only when such a +borrowed reference must be stored or passed on, it must be turned into an owned +reference by calling :c:func:`Py_INCREF`. + +The object reference returned from a C function that is called from Python must +be an owned reference --- ownership is transferred from the function to its +caller. + + +.. _thinice: + +Thin Ice +-------- + +There are a few situations where seemingly harmless use of a borrowed reference +can lead to problems. These all have to do with implicit invocations of the +interpreter, which can cause the owner of a reference to dispose of it. + +The first and most important case to know about is using :c:func:`Py_DECREF` on +an unrelated object while borrowing a reference to a list item. For instance:: + + void + bug(PyObject *list) + { + PyObject *item = PyList_GetItem(list, 0); + + PyList_SetItem(list, 1, PyLong_FromLong(0L)); + PyObject_Print(item, stdout, 0); /* BUG! */ + } + +This function first borrows a reference to ``list[0]``, then replaces +``list[1]`` with the value ``0``, and finally prints the borrowed reference. +Looks harmless, right? But it's not! + +Let's follow the control flow into :c:func:`PyList_SetItem`. The list owns +references to all its items, so when item 1 is replaced, it has to dispose of +the original item 1. Now let's suppose the original item 1 was an instance of a +user-defined class, and let's further suppose that the class defined a +:meth:`__del__` method. If this class instance has a reference count of 1, +disposing of it will call its :meth:`__del__` method. + +Since it is written in Python, the :meth:`__del__` method can execute arbitrary +Python code. Could it perhaps do something to invalidate the reference to +``item`` in :c:func:`bug`? You bet! Assuming that the list passed into +:c:func:`bug` is accessible to the :meth:`__del__` method, it could execute a +statement to the effect of ``del list[0]``, and assuming this was the last +reference to that object, it would free the memory associated with it, thereby +invalidating ``item``. + +The solution, once you know the source of the problem, is easy: temporarily +increment the reference count. The correct version of the function reads:: + + void + no_bug(PyObject *list) + { + PyObject *item = PyList_GetItem(list, 0); + + Py_INCREF(item); + PyList_SetItem(list, 1, PyLong_FromLong(0L)); + PyObject_Print(item, stdout, 0); + Py_DECREF(item); + } + +This is a true story. An older version of Python contained variants of this bug +and someone spent a considerable amount of time in a C debugger to figure out +why his :meth:`__del__` methods would fail... + +The second case of problems with a borrowed reference is a variant involving +threads. Normally, multiple threads in the Python interpreter can't get in each +other's way, because there is a global lock protecting Python's entire object +space. However, it is possible to temporarily release this lock using the macro +:c:macro:`Py_BEGIN_ALLOW_THREADS`, and to re-acquire it using +:c:macro:`Py_END_ALLOW_THREADS`. This is common around blocking I/O calls, to +let other threads use the processor while waiting for the I/O to complete. +Obviously, the following function has the same problem as the previous one:: + + void + bug(PyObject *list) + { + PyObject *item = PyList_GetItem(list, 0); + Py_BEGIN_ALLOW_THREADS + ...some blocking I/O call... + Py_END_ALLOW_THREADS + PyObject_Print(item, stdout, 0); /* BUG! */ + } + + +.. _nullpointers: + +NULL Pointers +------------- + +In general, functions that take object references as arguments do not expect you +to pass them *NULL* pointers, and will dump core (or cause later core dumps) if +you do so. Functions that return object references generally return *NULL* only +to indicate that an exception occurred. The reason for not testing for *NULL* +arguments is that functions often pass the objects they receive on to other +function --- if each function were to test for *NULL*, there would be a lot of +redundant tests and the code would run more slowly. + +It is better to test for *NULL* only at the "source:" when a pointer that may be +*NULL* is received, for example, from :c:func:`malloc` or from a function that +may raise an exception. + +The macros :c:func:`Py_INCREF` and :c:func:`Py_DECREF` do not check for *NULL* +pointers --- however, their variants :c:func:`Py_XINCREF` and :c:func:`Py_XDECREF` +do. + +The macros for checking for a particular object type (``Pytype_Check()``) don't +check for *NULL* pointers --- again, there is much code that calls several of +these in a row to test an object against various different expected types, and +this would generate redundant tests. There are no variants with *NULL* +checking. + +The C function calling mechanism guarantees that the argument list passed to C +functions (``args`` in the examples) is never *NULL* --- in fact it guarantees +that it is always a tuple [#]_. + +It is a severe error to ever let a *NULL* pointer "escape" to the Python user. + +.. Frank Stajano: + A pedagogically buggy example, along the lines of the previous listing, would + be helpful here -- showing in more concrete terms what sort of actions could + cause the problem. I can't very well imagine it from the description. + + +.. _cplusplus: + +Writing Extensions in C++ +========================= + +It is possible to write extension modules in C++. Some restrictions apply. If +the main program (the Python interpreter) is compiled and linked by the C +compiler, global or static objects with constructors cannot be used. This is +not a problem if the main program is linked by the C++ compiler. Functions that +will be called by the Python interpreter (in particular, module initialization +functions) have to be declared using ``extern "C"``. It is unnecessary to +enclose the Python header files in ``extern "C" {...}`` --- they use this form +already if the symbol ``__cplusplus`` is defined (all recent C++ compilers +define this symbol). + + +.. _using-capsules: + +Providing a C API for an Extension Module +========================================= + +.. sectionauthor:: Konrad Hinsen + + +Many extension modules just provide new functions and types to be used from +Python, but sometimes the code in an extension module can be useful for other +extension modules. For example, an extension module could implement a type +"collection" which works like lists without order. Just like the standard Python +list type has a C API which permits extension modules to create and manipulate +lists, this new collection type should have a set of C functions for direct +manipulation from other extension modules. + +At first sight this seems easy: just write the functions (without declaring them +``static``, of course), provide an appropriate header file, and document +the C API. And in fact this would work if all extension modules were always +linked statically with the Python interpreter. When modules are used as shared +libraries, however, the symbols defined in one module may not be visible to +another module. The details of visibility depend on the operating system; some +systems use one global namespace for the Python interpreter and all extension +modules (Windows, for example), whereas others require an explicit list of +imported symbols at module link time (AIX is one example), or offer a choice of +different strategies (most Unices). And even if symbols are globally visible, +the module whose functions one wishes to call might not have been loaded yet! + +Portability therefore requires not to make any assumptions about symbol +visibility. This means that all symbols in extension modules should be declared +``static``, except for the module's initialization function, in order to +avoid name clashes with other extension modules (as discussed in section +:ref:`methodtable`). And it means that symbols that *should* be accessible from +other extension modules must be exported in a different way. + +Python provides a special mechanism to pass C-level information (pointers) from +one extension module to another one: Capsules. A Capsule is a Python data type +which stores a pointer (:c:type:`void \*`). Capsules can only be created and +accessed via their C API, but they can be passed around like any other Python +object. In particular, they can be assigned to a name in an extension module's +namespace. Other extension modules can then import this module, retrieve the +value of this name, and then retrieve the pointer from the Capsule. + +There are many ways in which Capsules can be used to export the C API of an +extension module. Each function could get its own Capsule, or all C API pointers +could be stored in an array whose address is published in a Capsule. And the +various tasks of storing and retrieving the pointers can be distributed in +different ways between the module providing the code and the client modules. + +Whichever method you choose, it's important to name your Capsules properly. +The function :c:func:`PyCapsule_New` takes a name parameter +(:c:type:`const char \*`); you're permitted to pass in a *NULL* name, but +we strongly encourage you to specify a name. Properly named Capsules provide +a degree of runtime type-safety; there is no feasible way to tell one unnamed +Capsule from another. + +In particular, Capsules used to expose C APIs should be given a name following +this convention:: + + modulename.attributename + +The convenience function :c:func:`PyCapsule_Import` makes it easy to +load a C API provided via a Capsule, but only if the Capsule's name +matches this convention. This behavior gives C API users a high degree +of certainty that the Capsule they load contains the correct C API. + +The following example demonstrates an approach that puts most of the burden on +the writer of the exporting module, which is appropriate for commonly used +library modules. It stores all C API pointers (just one in the example!) in an +array of :c:type:`void` pointers which becomes the value of a Capsule. The header +file corresponding to the module provides a macro that takes care of importing +the module and retrieving its C API pointers; client modules only have to call +this macro before accessing the C API. + +The exporting module is a modification of the :mod:`spam` module from section +:ref:`extending-simpleexample`. The function :func:`spam.system` does not call +the C library function :c:func:`system` directly, but a function +:c:func:`PySpam_System`, which would of course do something more complicated in +reality (such as adding "spam" to every command). This function +:c:func:`PySpam_System` is also exported to other extension modules. + +The function :c:func:`PySpam_System` is a plain C function, declared +``static`` like everything else:: + + static int + PySpam_System(const char *command) + { + return system(command); + } + +The function :c:func:`spam_system` is modified in a trivial way:: + + static PyObject * + spam_system(PyObject *self, PyObject *args) + { + const char *command; + int sts; + + if (!PyArg_ParseTuple(args, "s", &command)) + return NULL; + sts = PySpam_System(command); + return PyLong_FromLong(sts); + } + +In the beginning of the module, right after the line :: + + #include + +two more lines must be added:: + + #define SPAM_MODULE + #include "spammodule.h" + +The ``#define`` is used to tell the header file that it is being included in the +exporting module, not a client module. Finally, the module's initialization +function must take care of initializing the C API pointer array:: + + PyMODINIT_FUNC + PyInit_spam(void) + { + PyObject *m; + static void *PySpam_API[PySpam_API_pointers]; + PyObject *c_api_object; + + m = PyModule_Create(&spammodule); + if (m == NULL) + return NULL; + + /* Initialize the C API pointer array */ + PySpam_API[PySpam_System_NUM] = (void *)PySpam_System; + + /* Create a Capsule containing the API pointer array's address */ + c_api_object = PyCapsule_New((void *)PySpam_API, "spam._C_API", NULL); + + if (c_api_object != NULL) + PyModule_AddObject(m, "_C_API", c_api_object); + return m; + } + +Note that ``PySpam_API`` is declared ``static``; otherwise the pointer +array would disappear when :func:`PyInit_spam` terminates! + +The bulk of the work is in the header file :file:`spammodule.h`, which looks +like this:: + + #ifndef Py_SPAMMODULE_H + #define Py_SPAMMODULE_H + #ifdef __cplusplus + extern "C" { + #endif + + /* Header file for spammodule */ + + /* C API functions */ + #define PySpam_System_NUM 0 + #define PySpam_System_RETURN int + #define PySpam_System_PROTO (const char *command) + + /* Total number of C API pointers */ + #define PySpam_API_pointers 1 + + + #ifdef SPAM_MODULE + /* This section is used when compiling spammodule.c */ + + static PySpam_System_RETURN PySpam_System PySpam_System_PROTO; + + #else + /* This section is used in modules that use spammodule's API */ + + static void **PySpam_API; + + #define PySpam_System \ + (*(PySpam_System_RETURN (*)PySpam_System_PROTO) PySpam_API[PySpam_System_NUM]) + + /* Return -1 on error, 0 on success. + * PyCapsule_Import will set an exception if there's an error. + */ + static int + import_spam(void) + { + PySpam_API = (void **)PyCapsule_Import("spam._C_API", 0); + return (PySpam_API != NULL) ? 0 : -1; + } + + #endif + + #ifdef __cplusplus + } + #endif + + #endif /* !defined(Py_SPAMMODULE_H) */ + +All that a client module must do in order to have access to the function +:c:func:`PySpam_System` is to call the function (or rather macro) +:c:func:`import_spam` in its initialization function:: + + PyMODINIT_FUNC + PyInit_client(void) + { + PyObject *m; + + m = PyModule_Create(&clientmodule); + if (m == NULL) + return NULL; + if (import_spam() < 0) + return NULL; + /* additional initialization can happen here */ + return m; + } + +The main disadvantage of this approach is that the file :file:`spammodule.h` is +rather complicated. However, the basic structure is the same for each function +that is exported, so it has to be learned only once. + +Finally it should be mentioned that Capsules offer additional functionality, +which is especially useful for memory allocation and deallocation of the pointer +stored in a Capsule. The details are described in the Python/C API Reference +Manual in the section :ref:`capsules` and in the implementation of Capsules (files +:file:`Include/pycapsule.h` and :file:`Objects/pycapsule.c` in the Python source +code distribution). + +.. rubric:: Footnotes + +.. [#] An interface for this function already exists in the standard module :mod:`os` + --- it was chosen as a simple and straightforward example. + +.. [#] The metaphor of "borrowing" a reference is not completely correct: the owner + still has a copy of the reference. + +.. [#] Checking that the reference count is at least 1 **does not work** --- the + reference count itself could be in freed memory and may thus be reused for + another object! + +.. [#] These guarantees don't hold when you use the "old" style calling convention --- + this is still found in much existing code. diff --git a/python-3.7.4-docs-html/_sources/extending/index.rst.txt b/python-3.7.4-docs-html/_sources/extending/index.rst.txt new file mode 100644 index 0000000..0994e3e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/extending/index.rst.txt @@ -0,0 +1,74 @@ +.. _extending-index: + +################################################## + Extending and Embedding the Python Interpreter +################################################## + +This document describes how to write modules in C or C++ to extend the Python +interpreter with new modules. Those modules can not only define new functions +but also new object types and their methods. The document also describes how +to embed the Python interpreter in another application, for use as an extension +language. Finally, it shows how to compile and link extension modules so that +they can be loaded dynamically (at run time) into the interpreter, if the +underlying operating system supports this feature. + +This document assumes basic knowledge about Python. For an informal +introduction to the language, see :ref:`tutorial-index`. :ref:`reference-index` +gives a more formal definition of the language. :ref:`library-index` documents +the existing object types, functions and modules (both built-in and written in +Python) that give the language its wide application range. + +For a detailed description of the whole Python/C API, see the separate +:ref:`c-api-index`. + + +Recommended third party tools +============================= + +This guide only covers the basic tools for creating extensions provided +as part of this version of CPython. Third party tools like +`Cython `_, `cffi `_, +`SWIG `_ and `Numba `_ +offer both simpler and more sophisticated approaches to creating C and C++ +extensions for Python. + +.. seealso:: + + `Python Packaging User Guide: Binary Extensions `_ + The Python Packaging User Guide not only covers several available + tools that simplify the creation of binary extensions, but also + discusses the various reasons why creating an extension module may be + desirable in the first place. + + +Creating extensions without third party tools +============================================= + +This section of the guide covers creating C and C++ extensions without +assistance from third party tools. It is intended primarily for creators +of those tools, rather than being a recommended way to create your own +C extensions. + +.. toctree:: + :maxdepth: 2 + :numbered: + + extending.rst + newtypes_tutorial.rst + newtypes.rst + building.rst + windows.rst + +Embedding the CPython runtime in a larger application +===================================================== + +Sometimes, rather than creating an extension that runs inside the Python +interpreter as the main application, it is desirable to instead embed +the CPython runtime inside a larger application. This section covers +some of the details involved in doing that successfully. + +.. toctree:: + :maxdepth: 2 + :numbered: + + embedding.rst diff --git a/python-3.7.4-docs-html/_sources/extending/newtypes.rst.txt b/python-3.7.4-docs-html/_sources/extending/newtypes.rst.txt new file mode 100644 index 0000000..d0d2ec1 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/extending/newtypes.rst.txt @@ -0,0 +1,619 @@ +.. highlightlang:: c + +***************************************** +Defining Extension Types: Assorted Topics +***************************************** + +.. _dnt-type-methods: + +This section aims to give a quick fly-by on the various type methods you can +implement and what they do. + +Here is the definition of :c:type:`PyTypeObject`, with some fields only used in +debug builds omitted: + +.. literalinclude:: ../includes/typestruct.h + + +Now that's a *lot* of methods. Don't worry too much though -- if you have +a type you want to define, the chances are very good that you will only +implement a handful of these. + +As you probably expect by now, we're going to go over this and give more +information about the various handlers. We won't go in the order they are +defined in the structure, because there is a lot of historical baggage that +impacts the ordering of the fields. It's often easiest to find an example +that includes the fields you need and then change the values to suit your new +type. :: + + const char *tp_name; /* For printing */ + +The name of the type -- as mentioned in the previous chapter, this will appear in +various places, almost entirely for diagnostic purposes. Try to choose something +that will be helpful in such a situation! :: + + Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */ + +These fields tell the runtime how much memory to allocate when new objects of +this type are created. Python has some built-in support for variable length +structures (think: strings, tuples) which is where the :c:member:`~PyTypeObject.tp_itemsize` field +comes in. This will be dealt with later. :: + + const char *tp_doc; + +Here you can put a string (or its address) that you want returned when the +Python script references ``obj.__doc__`` to retrieve the doc string. + +Now we come to the basic type methods -- the ones most extension types will +implement. + + +Finalization and De-allocation +------------------------------ + +.. index:: + single: object; deallocation + single: deallocation, object + single: object; finalization + single: finalization, of objects + +:: + + destructor tp_dealloc; + +This function is called when the reference count of the instance of your type is +reduced to zero and the Python interpreter wants to reclaim it. If your type +has memory to free or other clean-up to perform, you can put it here. The +object itself needs to be freed here as well. Here is an example of this +function:: + + static void + newdatatype_dealloc(newdatatypeobject *obj) + { + free(obj->obj_UnderlyingDatatypePtr); + Py_TYPE(obj)->tp_free(obj); + } + +.. index:: + single: PyErr_Fetch() + single: PyErr_Restore() + +One important requirement of the deallocator function is that it leaves any +pending exceptions alone. This is important since deallocators are frequently +called as the interpreter unwinds the Python stack; when the stack is unwound +due to an exception (rather than normal returns), nothing is done to protect the +deallocators from seeing that an exception has already been set. Any actions +which a deallocator performs which may cause additional Python code to be +executed may detect that an exception has been set. This can lead to misleading +errors from the interpreter. The proper way to protect against this is to save +a pending exception before performing the unsafe action, and restoring it when +done. This can be done using the :c:func:`PyErr_Fetch` and +:c:func:`PyErr_Restore` functions:: + + static void + my_dealloc(PyObject *obj) + { + MyObject *self = (MyObject *) obj; + PyObject *cbresult; + + if (self->my_callback != NULL) { + PyObject *err_type, *err_value, *err_traceback; + + /* This saves the current exception state */ + PyErr_Fetch(&err_type, &err_value, &err_traceback); + + cbresult = PyObject_CallObject(self->my_callback, NULL); + if (cbresult == NULL) + PyErr_WriteUnraisable(self->my_callback); + else + Py_DECREF(cbresult); + + /* This restores the saved exception state */ + PyErr_Restore(err_type, err_value, err_traceback); + + Py_DECREF(self->my_callback); + } + Py_TYPE(obj)->tp_free((PyObject*)self); + } + +.. note:: + There are limitations to what you can safely do in a deallocator function. + First, if your type supports garbage collection (using :c:member:`~PyTypeObject.tp_traverse` + and/or :c:member:`~PyTypeObject.tp_clear`), some of the object's members can have been + cleared or finalized by the time :c:member:`~PyTypeObject.tp_dealloc` is called. Second, in + :c:member:`~PyTypeObject.tp_dealloc`, your object is in an unstable state: its reference + count is equal to zero. Any call to a non-trivial object or API (as in the + example above) might end up calling :c:member:`~PyTypeObject.tp_dealloc` again, causing a + double free and a crash. + + Starting with Python 3.4, it is recommended not to put any complex + finalization code in :c:member:`~PyTypeObject.tp_dealloc`, and instead use the new + :c:member:`~PyTypeObject.tp_finalize` type method. + + .. seealso:: + :pep:`442` explains the new finalization scheme. + +.. index:: + single: string; object representation + builtin: repr + +Object Presentation +------------------- + +In Python, there are two ways to generate a textual representation of an object: +the :func:`repr` function, and the :func:`str` function. (The :func:`print` +function just calls :func:`str`.) These handlers are both optional. + +:: + + reprfunc tp_repr; + reprfunc tp_str; + +The :c:member:`~PyTypeObject.tp_repr` handler should return a string object containing a +representation of the instance for which it is called. Here is a simple +example:: + + static PyObject * + newdatatype_repr(newdatatypeobject * obj) + { + return PyUnicode_FromFormat("Repr-ified_newdatatype{{size:%d}}", + obj->obj_UnderlyingDatatypePtr->size); + } + +If no :c:member:`~PyTypeObject.tp_repr` handler is specified, the interpreter will supply a +representation that uses the type's :c:member:`~PyTypeObject.tp_name` and a uniquely-identifying +value for the object. + +The :c:member:`~PyTypeObject.tp_str` handler is to :func:`str` what the :c:member:`~PyTypeObject.tp_repr` handler +described above is to :func:`repr`; that is, it is called when Python code calls +:func:`str` on an instance of your object. Its implementation is very similar +to the :c:member:`~PyTypeObject.tp_repr` function, but the resulting string is intended for human +consumption. If :c:member:`~PyTypeObject.tp_str` is not specified, the :c:member:`~PyTypeObject.tp_repr` handler is +used instead. + +Here is a simple example:: + + static PyObject * + newdatatype_str(newdatatypeobject * obj) + { + return PyUnicode_FromFormat("Stringified_newdatatype{{size:%d}}", + obj->obj_UnderlyingDatatypePtr->size); + } + + + +Attribute Management +-------------------- + +For every object which can support attributes, the corresponding type must +provide the functions that control how the attributes are resolved. There needs +to be a function which can retrieve attributes (if any are defined), and another +to set attributes (if setting attributes is allowed). Removing an attribute is +a special case, for which the new value passed to the handler is *NULL*. + +Python supports two pairs of attribute handlers; a type that supports attributes +only needs to implement the functions for one pair. The difference is that one +pair takes the name of the attribute as a :c:type:`char\*`, while the other +accepts a :c:type:`PyObject\*`. Each type can use whichever pair makes more +sense for the implementation's convenience. :: + + getattrfunc tp_getattr; /* char * version */ + setattrfunc tp_setattr; + /* ... */ + getattrofunc tp_getattro; /* PyObject * version */ + setattrofunc tp_setattro; + +If accessing attributes of an object is always a simple operation (this will be +explained shortly), there are generic implementations which can be used to +provide the :c:type:`PyObject\*` version of the attribute management functions. +The actual need for type-specific attribute handlers almost completely +disappeared starting with Python 2.2, though there are many examples which have +not been updated to use some of the new generic mechanism that is available. + + +.. _generic-attribute-management: + +Generic Attribute Management +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Most extension types only use *simple* attributes. So, what makes the +attributes simple? There are only a couple of conditions that must be met: + +#. The name of the attributes must be known when :c:func:`PyType_Ready` is + called. + +#. No special processing is needed to record that an attribute was looked up or + set, nor do actions need to be taken based on the value. + +Note that this list does not place any restrictions on the values of the +attributes, when the values are computed, or how relevant data is stored. + +When :c:func:`PyType_Ready` is called, it uses three tables referenced by the +type object to create :term:`descriptor`\s which are placed in the dictionary of the +type object. Each descriptor controls access to one attribute of the instance +object. Each of the tables is optional; if all three are *NULL*, instances of +the type will only have attributes that are inherited from their base type, and +should leave the :c:member:`~PyTypeObject.tp_getattro` and :c:member:`~PyTypeObject.tp_setattro` fields *NULL* as +well, allowing the base type to handle attributes. + +The tables are declared as three fields of the type object:: + + struct PyMethodDef *tp_methods; + struct PyMemberDef *tp_members; + struct PyGetSetDef *tp_getset; + +If :c:member:`~PyTypeObject.tp_methods` is not *NULL*, it must refer to an array of +:c:type:`PyMethodDef` structures. Each entry in the table is an instance of this +structure:: + + typedef struct PyMethodDef { + const char *ml_name; /* method name */ + PyCFunction ml_meth; /* implementation function */ + int ml_flags; /* flags */ + const char *ml_doc; /* docstring */ + } PyMethodDef; + +One entry should be defined for each method provided by the type; no entries are +needed for methods inherited from a base type. One additional entry is needed +at the end; it is a sentinel that marks the end of the array. The +:attr:`ml_name` field of the sentinel must be *NULL*. + +The second table is used to define attributes which map directly to data stored +in the instance. A variety of primitive C types are supported, and access may +be read-only or read-write. The structures in the table are defined as:: + + typedef struct PyMemberDef { + const char *name; + int type; + int offset; + int flags; + const char *doc; + } PyMemberDef; + +For each entry in the table, a :term:`descriptor` will be constructed and added to the +type which will be able to extract a value from the instance structure. The +:attr:`type` field should contain one of the type codes defined in the +:file:`structmember.h` header; the value will be used to determine how to +convert Python values to and from C values. The :attr:`flags` field is used to +store flags which control how the attribute can be accessed. + +The following flag constants are defined in :file:`structmember.h`; they may be +combined using bitwise-OR. + ++---------------------------+----------------------------------------------+ +| Constant | Meaning | ++===========================+==============================================+ +| :const:`READONLY` | Never writable. | ++---------------------------+----------------------------------------------+ +| :const:`READ_RESTRICTED` | Not readable in restricted mode. | ++---------------------------+----------------------------------------------+ +| :const:`WRITE_RESTRICTED` | Not writable in restricted mode. | ++---------------------------+----------------------------------------------+ +| :const:`RESTRICTED` | Not readable or writable in restricted mode. | ++---------------------------+----------------------------------------------+ + +.. index:: + single: READONLY + single: READ_RESTRICTED + single: WRITE_RESTRICTED + single: RESTRICTED + +An interesting advantage of using the :c:member:`~PyTypeObject.tp_members` table to build +descriptors that are used at runtime is that any attribute defined this way can +have an associated doc string simply by providing the text in the table. An +application can use the introspection API to retrieve the descriptor from the +class object, and get the doc string using its :attr:`__doc__` attribute. + +As with the :c:member:`~PyTypeObject.tp_methods` table, a sentinel entry with a :attr:`name` value +of *NULL* is required. + +.. XXX Descriptors need to be explained in more detail somewhere, but not here. + + Descriptor objects have two handler functions which correspond to the + \member{tp_getattro} and \member{tp_setattro} handlers. The + \method{__get__()} handler is a function which is passed the descriptor, + instance, and type objects, and returns the value of the attribute, or it + returns \NULL{} and sets an exception. The \method{__set__()} handler is + passed the descriptor, instance, type, and new value; + + +Type-specific Attribute Management +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +For simplicity, only the :c:type:`char\*` version will be demonstrated here; the +type of the name parameter is the only difference between the :c:type:`char\*` +and :c:type:`PyObject\*` flavors of the interface. This example effectively does +the same thing as the generic example above, but does not use the generic +support added in Python 2.2. It explains how the handler functions are +called, so that if you do need to extend their functionality, you'll understand +what needs to be done. + +The :c:member:`~PyTypeObject.tp_getattr` handler is called when the object requires an attribute +look-up. It is called in the same situations where the :meth:`__getattr__` +method of a class would be called. + +Here is an example:: + + static PyObject * + newdatatype_getattr(newdatatypeobject *obj, char *name) + { + if (strcmp(name, "data") == 0) + { + return PyLong_FromLong(obj->data); + } + + PyErr_Format(PyExc_AttributeError, + "'%.50s' object has no attribute '%.400s'", + tp->tp_name, name); + return NULL; + } + +The :c:member:`~PyTypeObject.tp_setattr` handler is called when the :meth:`__setattr__` or +:meth:`__delattr__` method of a class instance would be called. When an +attribute should be deleted, the third parameter will be *NULL*. Here is an +example that simply raises an exception; if this were really all you wanted, the +:c:member:`~PyTypeObject.tp_setattr` handler should be set to *NULL*. :: + + static int + newdatatype_setattr(newdatatypeobject *obj, char *name, PyObject *v) + { + PyErr_Format(PyExc_RuntimeError, "Read-only attribute: %s", name); + return -1; + } + +Object Comparison +----------------- + +:: + + richcmpfunc tp_richcompare; + +The :c:member:`~PyTypeObject.tp_richcompare` handler is called when comparisons are needed. It is +analogous to the :ref:`rich comparison methods `, like +:meth:`__lt__`, and also called by :c:func:`PyObject_RichCompare` and +:c:func:`PyObject_RichCompareBool`. + +This function is called with two Python objects and the operator as arguments, +where the operator is one of ``Py_EQ``, ``Py_NE``, ``Py_LE``, ``Py_GT``, +``Py_LT`` or ``Py_GT``. It should compare the two objects with respect to the +specified operator and return ``Py_True`` or ``Py_False`` if the comparison is +successful, ``Py_NotImplemented`` to indicate that comparison is not +implemented and the other object's comparison method should be tried, or *NULL* +if an exception was set. + +Here is a sample implementation, for a datatype that is considered equal if the +size of an internal pointer is equal:: + + static PyObject * + newdatatype_richcmp(PyObject *obj1, PyObject *obj2, int op) + { + PyObject *result; + int c, size1, size2; + + /* code to make sure that both arguments are of type + newdatatype omitted */ + + size1 = obj1->obj_UnderlyingDatatypePtr->size; + size2 = obj2->obj_UnderlyingDatatypePtr->size; + + switch (op) { + case Py_LT: c = size1 < size2; break; + case Py_LE: c = size1 <= size2; break; + case Py_EQ: c = size1 == size2; break; + case Py_NE: c = size1 != size2; break; + case Py_GT: c = size1 > size2; break; + case Py_GE: c = size1 >= size2; break; + } + result = c ? Py_True : Py_False; + Py_INCREF(result); + return result; + } + + +Abstract Protocol Support +------------------------- + +Python supports a variety of *abstract* 'protocols;' the specific interfaces +provided to use these interfaces are documented in :ref:`abstract`. + + +A number of these abstract interfaces were defined early in the development of +the Python implementation. In particular, the number, mapping, and sequence +protocols have been part of Python since the beginning. Other protocols have +been added over time. For protocols which depend on several handler routines +from the type implementation, the older protocols have been defined as optional +blocks of handlers referenced by the type object. For newer protocols there are +additional slots in the main type object, with a flag bit being set to indicate +that the slots are present and should be checked by the interpreter. (The flag +bit does not indicate that the slot values are non-*NULL*. The flag may be set +to indicate the presence of a slot, but a slot may still be unfilled.) :: + + PyNumberMethods *tp_as_number; + PySequenceMethods *tp_as_sequence; + PyMappingMethods *tp_as_mapping; + +If you wish your object to be able to act like a number, a sequence, or a +mapping object, then you place the address of a structure that implements the C +type :c:type:`PyNumberMethods`, :c:type:`PySequenceMethods`, or +:c:type:`PyMappingMethods`, respectively. It is up to you to fill in this +structure with appropriate values. You can find examples of the use of each of +these in the :file:`Objects` directory of the Python source distribution. :: + + hashfunc tp_hash; + +This function, if you choose to provide it, should return a hash number for an +instance of your data type. Here is a simple example:: + + static Py_hash_t + newdatatype_hash(newdatatypeobject *obj) + { + Py_hash_t result; + result = obj->some_size + 32767 * obj->some_number; + if (result == -1) + result = -2; + return result; + } + +:c:type:`Py_hash_t` is a signed integer type with a platform-varying width. +Returning ``-1`` from :c:member:`~PyTypeObject.tp_hash` indicates an error, +which is why you should be careful to avoid returning it when hash computation +is successful, as seen above. + +:: + + ternaryfunc tp_call; + +This function is called when an instance of your data type is "called", for +example, if ``obj1`` is an instance of your data type and the Python script +contains ``obj1('hello')``, the :c:member:`~PyTypeObject.tp_call` handler is invoked. + +This function takes three arguments: + +#. *self* is the instance of the data type which is the subject of the call. + If the call is ``obj1('hello')``, then *self* is ``obj1``. + +#. *args* is a tuple containing the arguments to the call. You can use + :c:func:`PyArg_ParseTuple` to extract the arguments. + +#. *kwds* is a dictionary of keyword arguments that were passed. If this is + non-*NULL* and you support keyword arguments, use + :c:func:`PyArg_ParseTupleAndKeywords` to extract the arguments. If you + do not want to support keyword arguments and this is non-*NULL*, raise a + :exc:`TypeError` with a message saying that keyword arguments are not supported. + +Here is a toy ``tp_call`` implementation:: + + static PyObject * + newdatatype_call(newdatatypeobject *self, PyObject *args, PyObject *kwds) + { + PyObject *result; + const char *arg1; + const char *arg2; + const char *arg3; + + if (!PyArg_ParseTuple(args, "sss:call", &arg1, &arg2, &arg3)) { + return NULL; + } + result = PyUnicode_FromFormat( + "Returning -- value: [%d] arg1: [%s] arg2: [%s] arg3: [%s]\n", + obj->obj_UnderlyingDatatypePtr->size, + arg1, arg2, arg3); + return result; + } + +:: + + /* Iterators */ + getiterfunc tp_iter; + iternextfunc tp_iternext; + +These functions provide support for the iterator protocol. Both handlers +take exactly one parameter, the instance for which they are being called, +and return a new reference. In the case of an error, they should set an +exception and return *NULL*. :c:member:`~PyTypeObject.tp_iter` corresponds +to the Python :meth:`__iter__` method, while :c:member:`~PyTypeObject.tp_iternext` +corresponds to the Python :meth:`~iterator.__next__` method. + +Any :term:`iterable` object must implement the :c:member:`~PyTypeObject.tp_iter` +handler, which must return an :term:`iterator` object. Here the same guidelines +apply as for Python classes: + +* For collections (such as lists and tuples) which can support multiple + independent iterators, a new iterator should be created and returned by + each call to :c:member:`~PyTypeObject.tp_iter`. +* Objects which can only be iterated over once (usually due to side effects of + iteration, such as file objects) can implement :c:member:`~PyTypeObject.tp_iter` + by returning a new reference to themselves -- and should also therefore + implement the :c:member:`~PyTypeObject.tp_iternext` handler. + +Any :term:`iterator` object should implement both :c:member:`~PyTypeObject.tp_iter` +and :c:member:`~PyTypeObject.tp_iternext`. An iterator's +:c:member:`~PyTypeObject.tp_iter` handler should return a new reference +to the iterator. Its :c:member:`~PyTypeObject.tp_iternext` handler should +return a new reference to the next object in the iteration, if there is one. +If the iteration has reached the end, :c:member:`~PyTypeObject.tp_iternext` +may return *NULL* without setting an exception, or it may set +:exc:`StopIteration` *in addition* to returning *NULL*; avoiding +the exception can yield slightly better performance. If an actual error +occurs, :c:member:`~PyTypeObject.tp_iternext` should always set an exception +and return *NULL*. + + +.. _weakref-support: + +Weak Reference Support +---------------------- + +One of the goals of Python's weak reference implementation is to allow any type +to participate in the weak reference mechanism without incurring the overhead on +performance-critical objects (such as numbers). + +.. seealso:: + Documentation for the :mod:`weakref` module. + +For an object to be weakly referencable, the extension type must do two things: + +#. Include a :c:type:`PyObject\*` field in the C object structure dedicated to + the weak reference mechanism. The object's constructor should leave it + *NULL* (which is automatic when using the default + :c:member:`~PyTypeObject.tp_alloc`). + +#. Set the :c:member:`~PyTypeObject.tp_weaklistoffset` type member + to the offset of the aforementioned field in the C object structure, + so that the interpreter knows how to access and modify that field. + +Concretely, here is how a trivial object structure would be augmented +with the required field:: + + typedef struct { + PyObject_HEAD + PyObject *weakreflist; /* List of weak references */ + } TrivialObject; + +And the corresponding member in the statically-declared type object:: + + static PyTypeObject TrivialType = { + PyVarObject_HEAD_INIT(NULL, 0) + /* ... other members omitted for brevity ... */ + .tp_weaklistoffset = offsetof(TrivialObject, weakreflist), + }; + +The only further addition is that ``tp_dealloc`` needs to clear any weak +references (by calling :c:func:`PyObject_ClearWeakRefs`) if the field is +non-*NULL*:: + + static void + Trivial_dealloc(TrivialObject *self) + { + /* Clear weakrefs first before calling any destructors */ + if (self->weakreflist != NULL) + PyObject_ClearWeakRefs((PyObject *) self); + /* ... remainder of destruction code omitted for brevity ... */ + Py_TYPE(self)->tp_free((PyObject *) self); + } + + +More Suggestions +---------------- + +In order to learn how to implement any specific method for your new data type, +get the :term:`CPython` source code. Go to the :file:`Objects` directory, +then search the C source files for ``tp_`` plus the function you want +(for example, ``tp_richcompare``). You will find examples of the function +you want to implement. + +When you need to verify that an object is a concrete instance of the type you +are implementing, use the :c:func:`PyObject_TypeCheck` function. A sample of +its use might be something like the following:: + + if (!PyObject_TypeCheck(some_object, &MyType)) { + PyErr_SetString(PyExc_TypeError, "arg #1 not a mything"); + return NULL; + } + +.. seealso:: + Download CPython source releases. + https://www.python.org/downloads/source/ + + The CPython project on GitHub, where the CPython source code is developed. + https://github.com/python/cpython diff --git a/python-3.7.4-docs-html/_sources/extending/newtypes_tutorial.rst.txt b/python-3.7.4-docs-html/_sources/extending/newtypes_tutorial.rst.txt new file mode 100644 index 0000000..07c2ef7 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/extending/newtypes_tutorial.rst.txt @@ -0,0 +1,897 @@ +.. highlightlang:: c + +.. _defining-new-types: + +********************************** +Defining Extension Types: Tutorial +********************************** + +.. sectionauthor:: Michael Hudson +.. sectionauthor:: Dave Kuhlman +.. sectionauthor:: Jim Fulton + + +Python allows the writer of a C extension module to define new types that +can be manipulated from Python code, much like the built-in :class:`str` +and :class:`list` types. The code for all extension types follows a +pattern, but there are some details that you need to understand before you +can get started. This document is a gentle introduction to the topic. + + +.. _dnt-basics: + +The Basics +========== + +The :term:`CPython` runtime sees all Python objects as variables of type +:c:type:`PyObject\*`, which serves as a "base type" for all Python objects. +The :c:type:`PyObject` structure itself only contains the object's +:term:`reference count` and a pointer to the object's "type object". +This is where the action is; the type object determines which (C) functions +get called by the interpreter when, for instance, an attribute gets looked up +on an object, a method called, or it is multiplied by another object. These +C functions are called "type methods". + +So, if you want to define a new extension type, you need to create a new type +object. + +This sort of thing can only be explained by example, so here's a minimal, but +complete, module that defines a new type named :class:`Custom` inside a C +extension module :mod:`custom`: + +.. note:: + What we're showing here is the traditional way of defining *static* + extension types. It should be adequate for most uses. The C API also + allows defining heap-allocated extension types using the + :c:func:`PyType_FromSpec` function, which isn't covered in this tutorial. + +.. literalinclude:: ../includes/custom.c + +Now that's quite a bit to take in at once, but hopefully bits will seem familiar +from the previous chapter. This file defines three things: + +#. What a :class:`Custom` **object** contains: this is the ``CustomObject`` + struct, which is allocated once for each :class:`Custom` instance. +#. How the :class:`Custom` **type** behaves: this is the ``CustomType`` struct, + which defines a set of flags and function pointers that the interpreter + inspects when specific operations are requested. +#. How to initialize the :mod:`custom` module: this is the ``PyInit_custom`` + function and the associated ``custommodule`` struct. + +The first bit is:: + + typedef struct { + PyObject_HEAD + } CustomObject; + +This is what a Custom object will contain. ``PyObject_HEAD`` is mandatory +at the start of each object struct and defines a field called ``ob_base`` +of type :c:type:`PyObject`, containing a pointer to a type object and a +reference count (these can be accessed using the macros :c:macro:`Py_REFCNT` +and :c:macro:`Py_TYPE` respectively). The reason for the macro is to +abstract away the layout and to enable additional fields in debug builds. + +.. note:: + There is no semicolon above after the :c:macro:`PyObject_HEAD` macro. + Be wary of adding one by accident: some compilers will complain. + +Of course, objects generally store additional data besides the standard +``PyObject_HEAD`` boilerplate; for example, here is the definition for +standard Python floats:: + + typedef struct { + PyObject_HEAD + double ob_fval; + } PyFloatObject; + +The second bit is the definition of the type object. :: + + static PyTypeObject CustomType = { + PyVarObject_HEAD_INIT(NULL, 0) + .tp_name = "custom.Custom", + .tp_doc = "Custom objects", + .tp_basicsize = sizeof(CustomObject), + .tp_itemsize = 0, + .tp_flags = Py_TPFLAGS_DEFAULT, + .tp_new = PyType_GenericNew, + }; + +.. note:: + We recommend using C99-style designated initializers as above, to + avoid listing all the :c:type:`PyTypeObject` fields that you don't care + about and also to avoid caring about the fields' declaration order. + +The actual definition of :c:type:`PyTypeObject` in :file:`object.h` has +many more :ref:`fields ` than the definition above. The +remaining fields will be filled with zeros by the C compiler, and it's +common practice to not specify them explicitly unless you need them. + +We're going to pick it apart, one field at a time:: + + PyVarObject_HEAD_INIT(NULL, 0) + +This line is mandatory boilerplate to initialize the ``ob_base`` +field mentioned above. :: + + .tp_name = "custom.Custom", + +The name of our type. This will appear in the default textual representation of +our objects and in some error messages, for example: + +.. code-block:: pycon + + >>> "" + custom.Custom() + Traceback (most recent call last): + File "", line 1, in + TypeError: can only concatenate str (not "custom.Custom") to str + +Note that the name is a dotted name that includes both the module name and the +name of the type within the module. The module in this case is :mod:`custom` and +the type is :class:`Custom`, so we set the type name to :class:`custom.Custom`. +Using the real dotted import path is important to make your type compatible +with the :mod:`pydoc` and :mod:`pickle` modules. :: + + .tp_basicsize = sizeof(CustomObject), + .tp_itemsize = 0, + +This is so that Python knows how much memory to allocate when creating +new :class:`Custom` instances. :c:member:`~PyTypeObject.tp_itemsize` is +only used for variable-sized objects and should otherwise be zero. + +.. note:: + + If you want your type to be subclassable from Python, and your type has the same + :c:member:`~PyTypeObject.tp_basicsize` as its base type, you may have problems with multiple + inheritance. A Python subclass of your type will have to list your type first + in its :attr:`~class.__bases__`, or else it will not be able to call your type's + :meth:`__new__` method without getting an error. You can avoid this problem by + ensuring that your type has a larger value for :c:member:`~PyTypeObject.tp_basicsize` than its + base type does. Most of the time, this will be true anyway, because either your + base type will be :class:`object`, or else you will be adding data members to + your base type, and therefore increasing its size. + +We set the class flags to :const:`Py_TPFLAGS_DEFAULT`. :: + + .tp_flags = Py_TPFLAGS_DEFAULT, + +All types should include this constant in their flags. It enables all of the +members defined until at least Python 3.3. If you need further members, +you will need to OR the corresponding flags. + +We provide a doc string for the type in :c:member:`~PyTypeObject.tp_doc`. :: + + .tp_doc = "Custom objects", + +To enable object creation, we have to provide a :c:member:`~PyTypeObject.tp_new` +handler. This is the equivalent of the Python method :meth:`__new__`, but +has to be specified explicitly. In this case, we can just use the default +implementation provided by the API function :c:func:`PyType_GenericNew`. :: + + .tp_new = PyType_GenericNew, + +Everything else in the file should be familiar, except for some code in +:c:func:`PyInit_custom`:: + + if (PyType_Ready(&CustomType) < 0) + return; + +This initializes the :class:`Custom` type, filling in a number of members +to the appropriate default values, including :attr:`ob_type` that we initially +set to *NULL*. :: + + PyModule_AddObject(m, "Custom", (PyObject *) &CustomType); + +This adds the type to the module dictionary. This allows us to create +:class:`Custom` instances by calling the :class:`Custom` class: + +.. code-block:: pycon + + >>> import custom + >>> mycustom = custom.Custom() + +That's it! All that remains is to build it; put the above code in a file called +:file:`custom.c` and: + +.. code-block:: python + + from distutils.core import setup, Extension + setup(name="custom", version="1.0", + ext_modules=[Extension("custom", ["custom.c"])]) + +in a file called :file:`setup.py`; then typing + +.. code-block:: shell-session + + $ python setup.py build + +at a shell should produce a file :file:`custom.so` in a subdirectory; move to +that directory and fire up Python --- you should be able to ``import custom`` and +play around with Custom objects. + +That wasn't so hard, was it? + +Of course, the current Custom type is pretty uninteresting. It has no data and +doesn't do anything. It can't even be subclassed. + +.. note:: + While this documentation showcases the standard :mod:`distutils` module + for building C extensions, it is recommended in real-world use cases to + use the newer and better-maintained ``setuptools`` library. Documentation + on how to do this is out of scope for this document and can be found in + the `Python Packaging User's Guide `_. + + +Adding data and methods to the Basic example +============================================ + +Let's extend the basic example to add some data and methods. Let's also make +the type usable as a base class. We'll create a new module, :mod:`custom2` that +adds these capabilities: + +.. literalinclude:: ../includes/custom2.c + + +This version of the module has a number of changes. + +We've added an extra include:: + + #include + +This include provides declarations that we use to handle attributes, as +described a bit later. + +The :class:`Custom` type now has three data attributes in its C struct, +*first*, *last*, and *number*. The *first* and *last* variables are Python +strings containing first and last names. The *number* attribute is a C integer. + +The object structure is updated accordingly:: + + typedef struct { + PyObject_HEAD + PyObject *first; /* first name */ + PyObject *last; /* last name */ + int number; + } CustomObject; + +Because we now have data to manage, we have to be more careful about object +allocation and deallocation. At a minimum, we need a deallocation method:: + + static void + Custom_dealloc(CustomObject *self) + { + Py_XDECREF(self->first); + Py_XDECREF(self->last); + Py_TYPE(self)->tp_free((PyObject *) self); + } + +which is assigned to the :c:member:`~PyTypeObject.tp_dealloc` member:: + + .tp_dealloc = (destructor) Custom_dealloc, + +This method first clears the reference counts of the two Python attributes. +:c:func:`Py_XDECREF` correctly handles the case where its argument is +*NULL* (which might happen here if ``tp_new`` failed midway). It then +calls the :c:member:`~PyTypeObject.tp_free` member of the object's type +(computed by ``Py_TYPE(self)``) to free the object's memory. Note that +the object's type might not be :class:`CustomType`, because the object may +be an instance of a subclass. + +.. note:: + The explicit cast to ``destructor`` above is needed because we defined + ``Custom_dealloc`` to take a ``CustomObject *`` argument, but the ``tp_dealloc`` + function pointer expects to receive a ``PyObject *`` argument. Otherwise, + the compiler will emit a warning. This is object-oriented polymorphism, + in C! + +We want to make sure that the first and last names are initialized to empty +strings, so we provide a ``tp_new`` implementation:: + + static PyObject * + Custom_new(PyTypeObject *type, PyObject *args, PyObject *kwds) + { + CustomObject *self; + self = (CustomObject *) type->tp_alloc(type, 0); + if (self != NULL) { + self->first = PyUnicode_FromString(""); + if (self->first == NULL) { + Py_DECREF(self); + return NULL; + } + self->last = PyUnicode_FromString(""); + if (self->last == NULL) { + Py_DECREF(self); + return NULL; + } + self->number = 0; + } + return (PyObject *) self; + } + +and install it in the :c:member:`~PyTypeObject.tp_new` member:: + + .tp_new = Custom_new, + +The ``tp_new`` handler is responsible for creating (as opposed to initializing) +objects of the type. It is exposed in Python as the :meth:`__new__` method. +It is not required to define a ``tp_new`` member, and indeed many extension +types will simply reuse :c:func:`PyType_GenericNew` as done in the first +version of the ``Custom`` type above. In this case, we use the ``tp_new`` +handler to initialize the ``first`` and ``last`` attributes to non-*NULL* +default values. + +``tp_new`` is passed the type being instantiated (not necessarily ``CustomType``, +if a subclass is instantiated) and any arguments passed when the type was +called, and is expected to return the instance created. ``tp_new`` handlers +always accept positional and keyword arguments, but they often ignore the +arguments, leaving the argument handling to initializer (a.k.a. ``tp_init`` +in C or ``__init__`` in Python) methods. + +.. note:: + ``tp_new`` shouldn't call ``tp_init`` explicitly, as the interpreter + will do it itself. + +The ``tp_new`` implementation calls the :c:member:`~PyTypeObject.tp_alloc` +slot to allocate memory:: + + self = (CustomObject *) type->tp_alloc(type, 0); + +Since memory allocation may fail, we must check the :c:member:`~PyTypeObject.tp_alloc` +result against *NULL* before proceeding. + +.. note:: + We didn't fill the :c:member:`~PyTypeObject.tp_alloc` slot ourselves. Rather + :c:func:`PyType_Ready` fills it for us by inheriting it from our base class, + which is :class:`object` by default. Most types use the default allocation + strategy. + +.. note:: + If you are creating a co-operative :c:member:`~PyTypeObject.tp_new` (one + that calls a base type's :c:member:`~PyTypeObject.tp_new` or :meth:`__new__`), + you must *not* try to determine what method to call using method resolution + order at runtime. Always statically determine what type you are going to + call, and call its :c:member:`~PyTypeObject.tp_new` directly, or via + ``type->tp_base->tp_new``. If you do not do this, Python subclasses of your + type that also inherit from other Python-defined classes may not work correctly. + (Specifically, you may not be able to create instances of such subclasses + without getting a :exc:`TypeError`.) + +We also define an initialization function which accepts arguments to provide +initial values for our instance:: + + static int + Custom_init(CustomObject *self, PyObject *args, PyObject *kwds) + { + static char *kwlist[] = {"first", "last", "number", NULL}; + PyObject *first = NULL, *last = NULL, *tmp; + + if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OOi", kwlist, + &first, &last, + &self->number)) + return -1; + + if (first) { + tmp = self->first; + Py_INCREF(first); + self->first = first; + Py_XDECREF(tmp); + } + if (last) { + tmp = self->last; + Py_INCREF(last); + self->last = last; + Py_XDECREF(tmp); + } + return 0; + } + +by filling the :c:member:`~PyTypeObject.tp_init` slot. :: + + .tp_init = (initproc) Custom_init, + +The :c:member:`~PyTypeObject.tp_init` slot is exposed in Python as the +:meth:`__init__` method. It is used to initialize an object after it's +created. Initializers always accept positional and keyword arguments, +and they should return either ``0`` on success or ``-1`` on error. + +Unlike the ``tp_new`` handler, there is no guarantee that ``tp_init`` +is called at all (for example, the :mod:`pickle` module by default +doesn't call :meth:`__init__` on unpickled instances). It can also be +called multiple times. Anyone can call the :meth:`__init__` method on +our objects. For this reason, we have to be extra careful when assigning +the new attribute values. We might be tempted, for example to assign the +``first`` member like this:: + + if (first) { + Py_XDECREF(self->first); + Py_INCREF(first); + self->first = first; + } + +But this would be risky. Our type doesn't restrict the type of the +``first`` member, so it could be any kind of object. It could have a +destructor that causes code to be executed that tries to access the +``first`` member; or that destructor could release the +:term:`Global interpreter Lock` and let arbitrary code run in other +threads that accesses and modifies our object. + +To be paranoid and protect ourselves against this possibility, we almost +always reassign members before decrementing their reference counts. When +don't we have to do this? + +* when we absolutely know that the reference count is greater than 1; + +* when we know that deallocation of the object [#]_ will neither release + the :term:`GIL` nor cause any calls back into our type's code; + +* when decrementing a reference count in a :c:member:`~PyTypeObject.tp_dealloc` + handler on a type which doesn't support cyclic garbage collection [#]_. + +We want to expose our instance variables as attributes. There are a +number of ways to do that. The simplest way is to define member definitions:: + + static PyMemberDef Custom_members[] = { + {"first", T_OBJECT_EX, offsetof(CustomObject, first), 0, + "first name"}, + {"last", T_OBJECT_EX, offsetof(CustomObject, last), 0, + "last name"}, + {"number", T_INT, offsetof(CustomObject, number), 0, + "custom number"}, + {NULL} /* Sentinel */ + }; + +and put the definitions in the :c:member:`~PyTypeObject.tp_members` slot:: + + .tp_members = Custom_members, + +Each member definition has a member name, type, offset, access flags and +documentation string. See the :ref:`Generic-Attribute-Management` section +below for details. + +A disadvantage of this approach is that it doesn't provide a way to restrict the +types of objects that can be assigned to the Python attributes. We expect the +first and last names to be strings, but any Python objects can be assigned. +Further, the attributes can be deleted, setting the C pointers to *NULL*. Even +though we can make sure the members are initialized to non-*NULL* values, the +members can be set to *NULL* if the attributes are deleted. + +We define a single method, :meth:`Custom.name()`, that outputs the objects name as the +concatenation of the first and last names. :: + + static PyObject * + Custom_name(CustomObject *self) + { + if (self->first == NULL) { + PyErr_SetString(PyExc_AttributeError, "first"); + return NULL; + } + if (self->last == NULL) { + PyErr_SetString(PyExc_AttributeError, "last"); + return NULL; + } + return PyUnicode_FromFormat("%S %S", self->first, self->last); + } + +The method is implemented as a C function that takes a :class:`Custom` (or +:class:`Custom` subclass) instance as the first argument. Methods always take an +instance as the first argument. Methods often take positional and keyword +arguments as well, but in this case we don't take any and don't need to accept +a positional argument tuple or keyword argument dictionary. This method is +equivalent to the Python method: + +.. code-block:: python + + def name(self): + return "%s %s" % (self.first, self.last) + +Note that we have to check for the possibility that our :attr:`first` and +:attr:`last` members are *NULL*. This is because they can be deleted, in which +case they are set to *NULL*. It would be better to prevent deletion of these +attributes and to restrict the attribute values to be strings. We'll see how to +do that in the next section. + +Now that we've defined the method, we need to create an array of method +definitions:: + + static PyMethodDef Custom_methods[] = { + {"name", (PyCFunction) Custom_name, METH_NOARGS, + "Return the name, combining the first and last name" + }, + {NULL} /* Sentinel */ + }; + +(note that we used the :const:`METH_NOARGS` flag to indicate that the method +is expecting no arguments other than *self*) + +and assign it to the :c:member:`~PyTypeObject.tp_methods` slot:: + + .tp_methods = Custom_methods, + +Finally, we'll make our type usable as a base class for subclassing. We've +written our methods carefully so far so that they don't make any assumptions +about the type of the object being created or used, so all we need to do is +to add the :const:`Py_TPFLAGS_BASETYPE` to our class flag definition:: + + .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, + +We rename :c:func:`PyInit_custom` to :c:func:`PyInit_custom2`, update the +module name in the :c:type:`PyModuleDef` struct, and update the full class +name in the :c:type:`PyTypeObject` struct. + +Finally, we update our :file:`setup.py` file to build the new module: + +.. code-block:: python + + from distutils.core import setup, Extension + setup(name="custom", version="1.0", + ext_modules=[ + Extension("custom", ["custom.c"]), + Extension("custom2", ["custom2.c"]), + ]) + + +Providing finer control over data attributes +============================================ + +In this section, we'll provide finer control over how the :attr:`first` and +:attr:`last` attributes are set in the :class:`Custom` example. In the previous +version of our module, the instance variables :attr:`first` and :attr:`last` +could be set to non-string values or even deleted. We want to make sure that +these attributes always contain strings. + +.. literalinclude:: ../includes/custom3.c + + +To provide greater control, over the :attr:`first` and :attr:`last` attributes, +we'll use custom getter and setter functions. Here are the functions for +getting and setting the :attr:`first` attribute:: + + static PyObject * + Custom_getfirst(CustomObject *self, void *closure) + { + Py_INCREF(self->first); + return self->first; + } + + static int + Custom_setfirst(CustomObject *self, PyObject *value, void *closure) + { + PyObject *tmp; + if (value == NULL) { + PyErr_SetString(PyExc_TypeError, "Cannot delete the first attribute"); + return -1; + } + if (!PyUnicode_Check(value)) { + PyErr_SetString(PyExc_TypeError, + "The first attribute value must be a string"); + return -1; + } + tmp = self->first; + Py_INCREF(value); + self->first = value; + Py_DECREF(tmp); + return 0; + } + +The getter function is passed a :class:`Custom` object and a "closure", which is +a void pointer. In this case, the closure is ignored. (The closure supports an +advanced usage in which definition data is passed to the getter and setter. This +could, for example, be used to allow a single set of getter and setter functions +that decide the attribute to get or set based on data in the closure.) + +The setter function is passed the :class:`Custom` object, the new value, and the +closure. The new value may be *NULL*, in which case the attribute is being +deleted. In our setter, we raise an error if the attribute is deleted or if its +new value is not a string. + +We create an array of :c:type:`PyGetSetDef` structures:: + + static PyGetSetDef Custom_getsetters[] = { + {"first", (getter) Custom_getfirst, (setter) Custom_setfirst, + "first name", NULL}, + {"last", (getter) Custom_getlast, (setter) Custom_setlast, + "last name", NULL}, + {NULL} /* Sentinel */ + }; + +and register it in the :c:member:`~PyTypeObject.tp_getset` slot:: + + .tp_getset = Custom_getsetters, + +The last item in a :c:type:`PyGetSetDef` structure is the "closure" mentioned +above. In this case, we aren't using a closure, so we just pass *NULL*. + +We also remove the member definitions for these attributes:: + + static PyMemberDef Custom_members[] = { + {"number", T_INT, offsetof(CustomObject, number), 0, + "custom number"}, + {NULL} /* Sentinel */ + }; + +We also need to update the :c:member:`~PyTypeObject.tp_init` handler to only +allow strings [#]_ to be passed:: + + static int + Custom_init(CustomObject *self, PyObject *args, PyObject *kwds) + { + static char *kwlist[] = {"first", "last", "number", NULL}; + PyObject *first = NULL, *last = NULL, *tmp; + + if (!PyArg_ParseTupleAndKeywords(args, kwds, "|UUi", kwlist, + &first, &last, + &self->number)) + return -1; + + if (first) { + tmp = self->first; + Py_INCREF(first); + self->first = first; + Py_DECREF(tmp); + } + if (last) { + tmp = self->last; + Py_INCREF(last); + self->last = last; + Py_DECREF(tmp); + } + return 0; + } + +With these changes, we can assure that the ``first`` and ``last`` members are +never *NULL* so we can remove checks for *NULL* values in almost all cases. +This means that most of the :c:func:`Py_XDECREF` calls can be converted to +:c:func:`Py_DECREF` calls. The only place we can't change these calls is in +the ``tp_dealloc`` implementation, where there is the possibility that the +initialization of these members failed in ``tp_new``. + +We also rename the module initialization function and module name in the +initialization function, as we did before, and we add an extra definition to the +:file:`setup.py` file. + + +Supporting cyclic garbage collection +==================================== + +Python has a :term:`cyclic garbage collector (GC) ` that +can identify unneeded objects even when their reference counts are not zero. +This can happen when objects are involved in cycles. For example, consider: + +.. code-block:: pycon + + >>> l = [] + >>> l.append(l) + >>> del l + +In this example, we create a list that contains itself. When we delete it, it +still has a reference from itself. Its reference count doesn't drop to zero. +Fortunately, Python's cyclic garbage collector will eventually figure out that +the list is garbage and free it. + +In the second version of the :class:`Custom` example, we allowed any kind of +object to be stored in the :attr:`first` or :attr:`last` attributes [#]_. +Besides, in the second and third versions, we allowed subclassing +:class:`Custom`, and subclasses may add arbitrary attributes. For any of +those two reasons, :class:`Custom` objects can participate in cycles: + +.. code-block:: pycon + + >>> import custom3 + >>> class Derived(custom3.Custom): pass + ... + >>> n = Derived() + >>> n.some_attribute = n + +To allow a :class:`Custom` instance participating in a reference cycle to +be properly detected and collected by the cyclic GC, our :class:`Custom` type +needs to fill two additional slots and to enable a flag that enables these slots: + +.. literalinclude:: ../includes/custom4.c + + +First, the traversal method lets the cyclic GC know about subobjects that could +participate in cycles:: + + static int + Custom_traverse(CustomObject *self, visitproc visit, void *arg) + { + int vret; + if (self->first) { + vret = visit(self->first, arg); + if (vret != 0) + return vret; + } + if (self->last) { + vret = visit(self->last, arg); + if (vret != 0) + return vret; + } + return 0; + } + +For each subobject that can participate in cycles, we need to call the +:c:func:`visit` function, which is passed to the traversal method. The +:c:func:`visit` function takes as arguments the subobject and the extra argument +*arg* passed to the traversal method. It returns an integer value that must be +returned if it is non-zero. + +Python provides a :c:func:`Py_VISIT` macro that automates calling visit +functions. With :c:func:`Py_VISIT`, we can minimize the amount of boilerplate +in ``Custom_traverse``:: + + static int + Custom_traverse(CustomObject *self, visitproc visit, void *arg) + { + Py_VISIT(self->first); + Py_VISIT(self->last); + return 0; + } + +.. note:: + The :c:member:`~PyTypeObject.tp_traverse` implementation must name its + arguments exactly *visit* and *arg* in order to use :c:func:`Py_VISIT`. + +Second, we need to provide a method for clearing any subobjects that can +participate in cycles:: + + static int + Custom_clear(CustomObject *self) + { + Py_CLEAR(self->first); + Py_CLEAR(self->last); + return 0; + } + +Notice the use of the :c:func:`Py_CLEAR` macro. It is the recommended and safe +way to clear data attributes of arbitrary types while decrementing +their reference counts. If you were to call :c:func:`Py_XDECREF` instead +on the attribute before setting it to *NULL*, there is a possibility +that the attribute's destructor would call back into code that reads the +attribute again (*especially* if there is a reference cycle). + +.. note:: + You could emulate :c:func:`Py_CLEAR` by writing:: + + PyObject *tmp; + tmp = self->first; + self->first = NULL; + Py_XDECREF(tmp); + + Nevertheless, it is much easier and less error-prone to always + use :c:func:`Py_CLEAR` when deleting an attribute. Don't + try to micro-optimize at the expense of robustness! + +The deallocator ``Custom_dealloc`` may call arbitrary code when clearing +attributes. It means the circular GC can be triggered inside the function. +Since the GC assumes reference count is not zero, we need to untrack the object +from the GC by calling :c:func:`PyObject_GC_UnTrack` before clearing members. +Here is our reimplemented deallocator using :c:func:`PyObject_GC_UnTrack` +and ``Custom_clear``:: + + static void + Custom_dealloc(CustomObject *self) + { + PyObject_GC_UnTrack(self); + Custom_clear(self); + Py_TYPE(self)->tp_free((PyObject *) self); + } + +Finally, we add the :const:`Py_TPFLAGS_HAVE_GC` flag to the class flags:: + + .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, + +That's pretty much it. If we had written custom :c:member:`~PyTypeObject.tp_alloc` or +:c:member:`~PyTypeObject.tp_free` handlers, we'd need to modify them for cyclic +garbage collection. Most extensions will use the versions automatically provided. + + +Subclassing other types +======================= + +It is possible to create new extension types that are derived from existing +types. It is easiest to inherit from the built in types, since an extension can +easily use the :c:type:`PyTypeObject` it needs. It can be difficult to share +these :c:type:`PyTypeObject` structures between extension modules. + +In this example we will create a :class:`SubList` type that inherits from the +built-in :class:`list` type. The new type will be completely compatible with +regular lists, but will have an additional :meth:`increment` method that +increases an internal counter: + +.. code-block:: pycon + + >>> import sublist + >>> s = sublist.SubList(range(3)) + >>> s.extend(s) + >>> print(len(s)) + 6 + >>> print(s.increment()) + 1 + >>> print(s.increment()) + 2 + +.. literalinclude:: ../includes/sublist.c + + +As you can see, the source code closely resembles the :class:`Custom` examples in +previous sections. We will break down the main differences between them. :: + + typedef struct { + PyListObject list; + int state; + } SubListObject; + +The primary difference for derived type objects is that the base type's +object structure must be the first value. The base type will already include +the :c:func:`PyObject_HEAD` at the beginning of its structure. + +When a Python object is a :class:`SubList` instance, its ``PyObject *`` pointer +can be safely cast to both ``PyListObject *`` and ``SubListObject *``:: + + static int + SubList_init(SubListObject *self, PyObject *args, PyObject *kwds) + { + if (PyList_Type.tp_init((PyObject *) self, args, kwds) < 0) + return -1; + self->state = 0; + return 0; + } + +We see above how to call through to the :attr:`__init__` method of the base +type. + +This pattern is important when writing a type with custom +:c:member:`~PyTypeObject.tp_new` and :c:member:`~PyTypeObject.tp_dealloc` +members. The :c:member:`~PyTypeObject.tp_new` handler should not actually +create the memory for the object with its :c:member:`~PyTypeObject.tp_alloc`, +but let the base class handle it by calling its own :c:member:`~PyTypeObject.tp_new`. + +The :c:type:`PyTypeObject` struct supports a :c:member:`~PyTypeObject.tp_base` +specifying the type's concrete base class. Due to cross-platform compiler +issues, you can't fill that field directly with a reference to +:c:type:`PyList_Type`; it should be done later in the module initialization +function:: + + PyMODINIT_FUNC + PyInit_sublist(void) + { + PyObject* m; + SubListType.tp_base = &PyList_Type; + if (PyType_Ready(&SubListType) < 0) + return NULL; + + m = PyModule_Create(&sublistmodule); + if (m == NULL) + return NULL; + + Py_INCREF(&SubListType); + PyModule_AddObject(m, "SubList", (PyObject *) &SubListType); + return m; + } + +Before calling :c:func:`PyType_Ready`, the type structure must have the +:c:member:`~PyTypeObject.tp_base` slot filled in. When we are deriving an +existing type, it is not necessary to fill out the :c:member:`~PyTypeObject.tp_alloc` +slot with :c:func:`PyType_GenericNew` -- the allocation function from the base +type will be inherited. + +After that, calling :c:func:`PyType_Ready` and adding the type object to the +module is the same as with the basic :class:`Custom` examples. + + +.. rubric:: Footnotes + +.. [#] This is true when we know that the object is a basic type, like a string or a + float. + +.. [#] We relied on this in the :c:member:`~PyTypeObject.tp_dealloc` handler + in this example, because our type doesn't support garbage collection. + +.. [#] We now know that the first and last members are strings, so perhaps we + could be less careful about decrementing their reference counts, however, + we accept instances of string subclasses. Even though deallocating normal + strings won't call back into our objects, we can't guarantee that deallocating + an instance of a string subclass won't call back into our objects. + +.. [#] Also, even with our attributes restricted to strings instances, the user + could pass arbitrary :class:`str` subclasses and therefore still create + reference cycles. diff --git a/python-3.7.4-docs-html/_sources/extending/windows.rst.txt b/python-3.7.4-docs-html/_sources/extending/windows.rst.txt new file mode 100644 index 0000000..67bdd47 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/extending/windows.rst.txt @@ -0,0 +1,137 @@ +.. highlightlang:: c + + +.. _building-on-windows: + +**************************************** +Building C and C++ Extensions on Windows +**************************************** + +This chapter briefly explains how to create a Windows extension module for +Python using Microsoft Visual C++, and follows with more detailed background +information on how it works. The explanatory material is useful for both the +Windows programmer learning to build Python extensions and the Unix programmer +interested in producing software which can be successfully built on both Unix +and Windows. + +Module authors are encouraged to use the distutils approach for building +extension modules, instead of the one described in this section. You will still +need the C compiler that was used to build Python; typically Microsoft Visual +C++. + +.. note:: + + This chapter mentions a number of filenames that include an encoded Python + version number. These filenames are represented with the version number shown + as ``XY``; in practice, ``'X'`` will be the major version number and ``'Y'`` + will be the minor version number of the Python release you're working with. For + example, if you are using Python 2.2.1, ``XY`` will actually be ``22``. + + +.. _win-cookbook: + +A Cookbook Approach +=================== + +There are two approaches to building extension modules on Windows, just as there +are on Unix: use the :mod:`distutils` package to control the build process, or +do things manually. The distutils approach works well for most extensions; +documentation on using :mod:`distutils` to build and package extension modules +is available in :ref:`distutils-index`. If you find you really need to do +things manually, it may be instructive to study the project file for the +:source:`winsound ` standard library module. + + +.. _dynamic-linking: + +Differences Between Unix and Windows +==================================== + +.. sectionauthor:: Chris Phoenix + + +Unix and Windows use completely different paradigms for run-time loading of +code. Before you try to build a module that can be dynamically loaded, be aware +of how your system works. + +In Unix, a shared object (:file:`.so`) file contains code to be used by the +program, and also the names of functions and data that it expects to find in the +program. When the file is joined to the program, all references to those +functions and data in the file's code are changed to point to the actual +locations in the program where the functions and data are placed in memory. +This is basically a link operation. + +In Windows, a dynamic-link library (:file:`.dll`) file has no dangling +references. Instead, an access to functions or data goes through a lookup +table. So the DLL code does not have to be fixed up at runtime to refer to the +program's memory; instead, the code already uses the DLL's lookup table, and the +lookup table is modified at runtime to point to the functions and data. + +In Unix, there is only one type of library file (:file:`.a`) which contains code +from several object files (:file:`.o`). During the link step to create a shared +object file (:file:`.so`), the linker may find that it doesn't know where an +identifier is defined. The linker will look for it in the object files in the +libraries; if it finds it, it will include all the code from that object file. + +In Windows, there are two types of library, a static library and an import +library (both called :file:`.lib`). A static library is like a Unix :file:`.a` +file; it contains code to be included as necessary. An import library is +basically used only to reassure the linker that a certain identifier is legal, +and will be present in the program when the DLL is loaded. So the linker uses +the information from the import library to build the lookup table for using +identifiers that are not included in the DLL. When an application or a DLL is +linked, an import library may be generated, which will need to be used for all +future DLLs that depend on the symbols in the application or DLL. + +Suppose you are building two dynamic-load modules, B and C, which should share +another block of code A. On Unix, you would *not* pass :file:`A.a` to the +linker for :file:`B.so` and :file:`C.so`; that would cause it to be included +twice, so that B and C would each have their own copy. In Windows, building +:file:`A.dll` will also build :file:`A.lib`. You *do* pass :file:`A.lib` to the +linker for B and C. :file:`A.lib` does not contain code; it just contains +information which will be used at runtime to access A's code. + +In Windows, using an import library is sort of like using ``import spam``; it +gives you access to spam's names, but does not create a separate copy. On Unix, +linking with a library is more like ``from spam import *``; it does create a +separate copy. + + +.. _win-dlls: + +Using DLLs in Practice +====================== + +.. sectionauthor:: Chris Phoenix + + +Windows Python is built in Microsoft Visual C++; using other compilers may or +may not work (though Borland seems to). The rest of this section is MSVC++ +specific. + +When creating DLLs in Windows, you must pass :file:`pythonXY.lib` to the linker. +To build two DLLs, spam and ni (which uses C functions found in spam), you could +use these commands:: + + cl /LD /I/python/include spam.c ../libs/pythonXY.lib + cl /LD /I/python/include ni.c spam.lib ../libs/pythonXY.lib + +The first command created three files: :file:`spam.obj`, :file:`spam.dll` and +:file:`spam.lib`. :file:`Spam.dll` does not contain any Python functions (such +as :c:func:`PyArg_ParseTuple`), but it does know how to find the Python code +thanks to :file:`pythonXY.lib`. + +The second command created :file:`ni.dll` (and :file:`.obj` and :file:`.lib`), +which knows how to find the necessary functions from spam, and also from the +Python executable. + +Not every identifier is exported to the lookup table. If you want any other +modules (including Python) to be able to see your identifiers, you have to say +``_declspec(dllexport)``, as in ``void _declspec(dllexport) initspam(void)`` or +``PyObject _declspec(dllexport) *NiGetSpamData(void)``. + +Developer Studio will throw in a lot of import libraries that you do not really +need, adding about 100K to your executable. To get rid of them, use the Project +Settings dialog, Link tab, to specify *ignore default libraries*. Add the +correct :file:`msvcrtxx.lib` to the list of libraries. + diff --git a/python-3.7.4-docs-html/_sources/faq/design.rst.txt b/python-3.7.4-docs-html/_sources/faq/design.rst.txt new file mode 100644 index 0000000..e2d63a0 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/faq/design.rst.txt @@ -0,0 +1,808 @@ +====================== +Design and History FAQ +====================== + +.. only:: html + + .. contents:: + + +Why does Python use indentation for grouping of statements? +----------------------------------------------------------- + +Guido van Rossum believes that using indentation for grouping is extremely +elegant and contributes a lot to the clarity of the average Python program. +Most people learn to love this feature after a while. + +Since there are no begin/end brackets there cannot be a disagreement between +grouping perceived by the parser and the human reader. Occasionally C +programmers will encounter a fragment of code like this:: + + if (x <= y) + x++; + y--; + z++; + +Only the ``x++`` statement is executed if the condition is true, but the +indentation leads you to believe otherwise. Even experienced C programmers will +sometimes stare at it a long time wondering why ``y`` is being decremented even +for ``x > y``. + +Because there are no begin/end brackets, Python is much less prone to +coding-style conflicts. In C there are many different ways to place the braces. +If you're used to reading and writing code that uses one style, you will feel at +least slightly uneasy when reading (or being required to write) another style. + +Many coding styles place begin/end brackets on a line by themselves. This makes +programs considerably longer and wastes valuable screen space, making it harder +to get a good overview of a program. Ideally, a function should fit on one +screen (say, 20--30 lines). 20 lines of Python can do a lot more work than 20 +lines of C. This is not solely due to the lack of begin/end brackets -- the +lack of declarations and the high-level data types are also responsible -- but +the indentation-based syntax certainly helps. + + +Why am I getting strange results with simple arithmetic operations? +------------------------------------------------------------------- + +See the next question. + + +Why are floating-point calculations so inaccurate? +-------------------------------------------------- + +Users are often surprised by results like this:: + + >>> 1.2 - 1.0 + 0.19999999999999996 + +and think it is a bug in Python. It's not. This has little to do with Python, +and much more to do with how the underlying platform handles floating-point +numbers. + +The :class:`float` type in CPython uses a C ``double`` for storage. A +:class:`float` object's value is stored in binary floating-point with a fixed +precision (typically 53 bits) and Python uses C operations, which in turn rely +on the hardware implementation in the processor, to perform floating-point +operations. This means that as far as floating-point operations are concerned, +Python behaves like many popular languages including C and Java. + +Many numbers that can be written easily in decimal notation cannot be expressed +exactly in binary floating-point. For example, after:: + + >>> x = 1.2 + +the value stored for ``x`` is a (very good) approximation to the decimal value +``1.2``, but is not exactly equal to it. On a typical machine, the actual +stored value is:: + + 1.0011001100110011001100110011001100110011001100110011 (binary) + +which is exactly:: + + 1.1999999999999999555910790149937383830547332763671875 (decimal) + +The typical precision of 53 bits provides Python floats with 15--16 +decimal digits of accuracy. + +For a fuller explanation, please see the :ref:`floating point arithmetic +` chapter in the Python tutorial. + + +Why are Python strings immutable? +--------------------------------- + +There are several advantages. + +One is performance: knowing that a string is immutable means we can allocate +space for it at creation time, and the storage requirements are fixed and +unchanging. This is also one of the reasons for the distinction between tuples +and lists. + +Another advantage is that strings in Python are considered as "elemental" as +numbers. No amount of activity will change the value 8 to anything else, and in +Python, no amount of activity will change the string "eight" to anything else. + + +.. _why-self: + +Why must 'self' be used explicitly in method definitions and calls? +------------------------------------------------------------------- + +The idea was borrowed from Modula-3. It turns out to be very useful, for a +variety of reasons. + +First, it's more obvious that you are using a method or instance attribute +instead of a local variable. Reading ``self.x`` or ``self.meth()`` makes it +absolutely clear that an instance variable or method is used even if you don't +know the class definition by heart. In C++, you can sort of tell by the lack of +a local variable declaration (assuming globals are rare or easily recognizable) +-- but in Python, there are no local variable declarations, so you'd have to +look up the class definition to be sure. Some C++ and Java coding standards +call for instance attributes to have an ``m_`` prefix, so this explicitness is +still useful in those languages, too. + +Second, it means that no special syntax is necessary if you want to explicitly +reference or call the method from a particular class. In C++, if you want to +use a method from a base class which is overridden in a derived class, you have +to use the ``::`` operator -- in Python you can write +``baseclass.methodname(self, )``. This is particularly useful +for :meth:`__init__` methods, and in general in cases where a derived class +method wants to extend the base class method of the same name and thus has to +call the base class method somehow. + +Finally, for instance variables it solves a syntactic problem with assignment: +since local variables in Python are (by definition!) those variables to which a +value is assigned in a function body (and that aren't explicitly declared +global), there has to be some way to tell the interpreter that an assignment was +meant to assign to an instance variable instead of to a local variable, and it +should preferably be syntactic (for efficiency reasons). C++ does this through +declarations, but Python doesn't have declarations and it would be a pity having +to introduce them just for this purpose. Using the explicit ``self.var`` solves +this nicely. Similarly, for using instance variables, having to write +``self.var`` means that references to unqualified names inside a method don't +have to search the instance's directories. To put it another way, local +variables and instance variables live in two different namespaces, and you need +to tell Python which namespace to use. + + +Why can't I use an assignment in an expression? +----------------------------------------------- + +Many people used to C or Perl complain that they want to use this C idiom: + +.. code-block:: c + + while (line = readline(f)) { + // do something with line + } + +where in Python you're forced to write this:: + + while True: + line = f.readline() + if not line: + break + ... # 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: + +.. code-block:: c + + if (x = 0) { + // error handling + } + else { + // code that only works for nonzero x + } + +The error is a simple typo: ``x = 0``, which assigns 0 to the variable ``x``, +was written while the comparison ``x == 0`` is certainly what was intended. + +Many alternatives have been proposed. Most are hacks that save some typing but +use arbitrary or cryptic syntax or keywords, and fail the simple criterion for +language change proposals: it should intuitively suggest the proper meaning to a +human reader who has not yet been introduced to the construct. + +An interesting phenomenon is that most experienced Python programmers recognize +the ``while True`` idiom and don't seem to be missing the assignment in +expression construct much; it's only newcomers who express a strong desire to +add this to the language. + +There's an alternative way of spelling this that seems attractive but is +generally less robust than the "while True" solution:: + + line = f.readline() + while line: + ... # do something with line... + line = f.readline() + +The problem with this is that if you change your mind about exactly how you get +the next line (e.g. you want to change it into ``sys.stdin.readline()``) you +have to remember to change two places in your program -- the second occurrence +is hidden at the bottom of the loop. + +The best approach is to use iterators, making it possible to loop through +objects using the ``for`` statement. For example, :term:`file objects +` support the iterator protocol, so you can write simply:: + + for line in f: + ... # do something with line... + + + +Why does Python use methods for some functionality (e.g. list.index()) but functions for other (e.g. len(list))? +---------------------------------------------------------------------------------------------------------------- + +As Guido said: + + (a) For some operations, prefix notation just reads better than + postfix -- prefix (and infix!) operations have a long tradition in + mathematics which likes notations where the visuals help the + mathematician thinking about a problem. Compare the easy with which we + rewrite a formula like x*(a+b) into x*a + x*b to the clumsiness of + doing the same thing using a raw OO notation. + + (b) When I read code that says len(x) I *know* that it is asking for + the length of something. This tells me two things: the result is an + integer, and the argument is some kind of container. To the contrary, + when I read x.len(), I have to already know that x is some kind of + container implementing an interface or inheriting from a class that + has a standard len(). Witness the confusion we occasionally have when + a class that is not implementing a mapping has a get() or keys() + method, or something that isn't a file has a write() method. + + -- https://mail.python.org/pipermail/python-3000/2006-November/004643.html + + +Why is join() a string method instead of a list or tuple method? +---------------------------------------------------------------- + +Strings became much more like other standard types starting in Python 1.6, when +methods were added which give the same functionality that has always been +available using the functions of the string module. Most of these new methods +have been widely accepted, but the one which appears to make some programmers +feel uncomfortable is:: + + ", ".join(['1', '2', '4', '8', '16']) + +which gives the result:: + + "1, 2, 4, 8, 16" + +There are two common arguments against this usage. + +The first runs along the lines of: "It looks really ugly using a method of a +string literal (string constant)", to which the answer is that it might, but a +string literal is just a fixed value. If the methods are to be allowed on names +bound to strings there is no logical reason to make them unavailable on +literals. + +The second objection is typically cast as: "I am really telling a sequence to +join its members together with a string constant". Sadly, you aren't. For some +reason there seems to be much less difficulty with having :meth:`~str.split` as +a string method, since in that case it is easy to see that :: + + "1, 2, 4, 8, 16".split(", ") + +is an instruction to a string literal to return the substrings delimited by the +given separator (or, by default, arbitrary runs of white space). + +:meth:`~str.join` is a string method because in using it you are telling the +separator string to iterate over a sequence of strings and insert itself between +adjacent elements. This method can be used with any argument which obeys the +rules for sequence objects, including any new classes you might define yourself. +Similar methods exist for bytes and bytearray objects. + + +How fast are exceptions? +------------------------ + +A try/except block is extremely efficient if no exceptions are raised. Actually +catching an exception is expensive. In versions of Python prior to 2.0 it was +common to use this idiom:: + + try: + value = mydict[key] + except KeyError: + mydict[key] = getvalue(key) + value = mydict[key] + +This only made sense when you expected the dict to have the key almost all the +time. If that wasn't the case, you coded it like this:: + + if key in mydict: + value = mydict[key] + else: + value = mydict[key] = getvalue(key) + +For this specific case, you could also use ``value = dict.setdefault(key, +getvalue(key))``, but only if the ``getvalue()`` call is cheap enough because it +is evaluated in all cases. + + +Why isn't there a switch or case statement in Python? +----------------------------------------------------- + +You can do this easily enough with a sequence of ``if... elif... elif... else``. +There have been some proposals for switch statement syntax, but there is no +consensus (yet) on whether and how to do range tests. See :pep:`275` for +complete details and the current status. + +For cases where you need to choose from a very large number of possibilities, +you can create a dictionary mapping case values to functions to call. For +example:: + + def function_1(...): + ... + + functions = {'a': function_1, + 'b': function_2, + 'c': self.method_1, ...} + + func = functions[value] + func() + +For calling methods on objects, you can simplify yet further by using the +:func:`getattr` built-in to retrieve methods with a particular name:: + + def visit_a(self, ...): + ... + ... + + def dispatch(self, value): + method_name = 'visit_' + str(value) + method = getattr(self, method_name) + method() + +It's suggested that you use a prefix for the method names, such as ``visit_`` in +this example. Without such a prefix, if values are coming from an untrusted +source, an attacker would be able to call any method on your object. + + +Can't you emulate threads in the interpreter instead of relying on an OS-specific thread implementation? +-------------------------------------------------------------------------------------------------------- + +Answer 1: Unfortunately, the interpreter pushes at least one C stack frame for +each Python stack frame. Also, extensions can call back into Python at almost +random moments. Therefore, a complete threads implementation requires thread +support for C. + +Answer 2: Fortunately, there is `Stackless Python `_, +which has a completely redesigned interpreter loop that avoids the C stack. + + +Why can't lambda expressions contain statements? +------------------------------------------------ + +Python lambda expressions cannot contain statements because Python's syntactic +framework can't handle statements nested inside expressions. However, in +Python, this is not a serious problem. Unlike lambda forms in other languages, +where they add functionality, Python lambdas are only a shorthand notation if +you're too lazy to define a function. + +Functions are already first class objects in Python, and can be declared in a +local scope. Therefore the only advantage of using a lambda instead of a +locally-defined function is that you don't need to invent a name for the +function -- but that's just a local variable to which the function object (which +is exactly the same type of object that a lambda expression yields) is assigned! + + +Can Python be compiled to machine code, C or some other language? +----------------------------------------------------------------- + +`Cython `_ compiles a modified version of Python with +optional annotations into C extensions. `Nuitka `_ is +an up-and-coming compiler of Python into C++ code, aiming to support the full +Python language. For compiling to Java you can consider +`VOC `_. + + +How does Python manage memory? +------------------------------ + +The details of Python memory management depend on the implementation. The +standard implementation of Python, :term:`CPython`, uses reference counting to +detect inaccessible objects, and another mechanism to collect reference cycles, +periodically executing a cycle detection algorithm which looks for inaccessible +cycles and deletes the objects involved. The :mod:`gc` module provides functions +to perform a garbage collection, obtain debugging statistics, and tune the +collector's parameters. + +Other implementations (such as `Jython `_ or +`PyPy `_), however, can rely on a different mechanism +such as a full-blown garbage collector. This difference can cause some +subtle porting problems if your Python code depends on the behavior of the +reference counting implementation. + +In some Python implementations, the following code (which is fine in CPython) +will probably run out of file descriptors:: + + for file in very_long_list_of_files: + f = open(file) + c = f.read(1) + +Indeed, using CPython's reference counting and destructor scheme, each new +assignment to *f* closes the previous file. With a traditional GC, however, +those file objects will only get collected (and closed) at varying and possibly +long intervals. + +If you want to write code that will work with any Python implementation, +you should explicitly close the file or use the :keyword:`with` statement; +this will work regardless of memory management scheme:: + + for file in very_long_list_of_files: + with open(file) as f: + c = f.read(1) + + +Why doesn't CPython use a more traditional garbage collection scheme? +--------------------------------------------------------------------- + +For one thing, this is not a C standard feature and hence it's not portable. +(Yes, we know about the Boehm GC library. It has bits of assembler code for +*most* common platforms, not for all of them, and although it is mostly +transparent, it isn't completely transparent; patches are required to get +Python to work with it.) + +Traditional GC also becomes a problem when Python is embedded into other +applications. While in a standalone Python it's fine to replace the standard +malloc() and free() with versions provided by the GC library, an application +embedding Python may want to have its *own* substitute for malloc() and free(), +and may not want Python's. Right now, CPython works with anything that +implements malloc() and free() properly. + + +Why isn't all memory freed when CPython exits? +---------------------------------------------- + +Objects referenced from the global namespaces of Python modules are not always +deallocated when Python exits. This may happen if there are circular +references. There are also certain bits of memory that are allocated by the C +library that are impossible to free (e.g. a tool like Purify will complain about +these). Python is, however, aggressive about cleaning up memory on exit and +does try to destroy every single object. + +If you want to force Python to delete certain things on deallocation use the +:mod:`atexit` module to run a function that will force those deletions. + + +Why are there separate tuple and list data types? +------------------------------------------------- + +Lists and tuples, while similar in many respects, are generally used in +fundamentally different ways. Tuples can be thought of as being similar to +Pascal records or C structs; they're small collections of related data which may +be of different types which are operated on as a group. For example, a +Cartesian coordinate is appropriately represented as a tuple of two or three +numbers. + +Lists, on the other hand, are more like arrays in other languages. They tend to +hold a varying number of objects all of which have the same type and which are +operated on one-by-one. For example, ``os.listdir('.')`` returns a list of +strings representing the files in the current directory. Functions which +operate on this output would generally not break if you added another file or +two to the directory. + +Tuples are immutable, meaning that once a tuple has been created, you can't +replace any of its elements with a new value. Lists are mutable, meaning that +you can always change a list's elements. Only immutable elements can be used as +dictionary keys, and hence only tuples and not lists can be used as keys. + + +How are lists implemented in CPython? +------------------------------------- + +CPython's lists are really variable-length arrays, not Lisp-style linked lists. +The implementation uses a contiguous array of references to other objects, and +keeps a pointer to this array and the array's length in a list head structure. + +This makes indexing a list ``a[i]`` an operation whose cost is independent of +the size of the list or the value of the index. + +When items are appended or inserted, the array of references is resized. Some +cleverness is applied to improve the performance of appending items repeatedly; +when the array must be grown, some extra space is allocated so the next few +times don't require an actual resize. + + +How are dictionaries implemented in CPython? +-------------------------------------------- + +CPython's dictionaries are implemented as resizable hash tables. Compared to +B-trees, this gives better performance for lookup (the most common operation by +far) under most circumstances, and the implementation is simpler. + +Dictionaries work by computing a hash code for each key stored in the dictionary +using the :func:`hash` built-in function. The hash code varies widely depending +on the key and a per-process seed; for example, "Python" could hash to +-539294296 while "python", a string that differs by a single bit, could hash +to 1142331976. The hash code is then used to calculate a location in an +internal array where the value will be stored. Assuming that you're storing +keys that all have different hash values, this means that dictionaries take +constant time -- O(1), in Big-O notation -- to retrieve a key. + + +Why must dictionary keys be immutable? +-------------------------------------- + +The hash table implementation of dictionaries uses a hash value calculated from +the key value to find the key. If the key were a mutable object, its value +could change, and thus its hash could also change. But since whoever changes +the key object can't tell that it was being used as a dictionary key, it can't +move the entry around in the dictionary. Then, when you try to look up the same +object in the dictionary it won't be found because its hash value is different. +If you tried to look up the old value it wouldn't be found either, because the +value of the object found in that hash bin would be different. + +If you want a dictionary indexed with a list, simply convert the list to a tuple +first; the function ``tuple(L)`` creates a tuple with the same entries as the +list ``L``. Tuples are immutable and can therefore be used as dictionary keys. + +Some unacceptable solutions that have been proposed: + +- Hash lists by their address (object ID). This doesn't work because if you + construct a new list with the same value it won't be found; e.g.:: + + mydict = {[1, 2]: '12'} + print(mydict[[1, 2]]) + + would raise a :exc:`KeyError` exception because the id of the ``[1, 2]`` used in the + second line differs from that in the first line. In other words, dictionary + keys should be compared using ``==``, not using :keyword:`is`. + +- Make a copy when using a list as a key. This doesn't work because the list, + being a mutable object, could contain a reference to itself, and then the + copying code would run into an infinite loop. + +- Allow lists as keys but tell the user not to modify them. This would allow a + class of hard-to-track bugs in programs when you forgot or modified a list by + accident. It also invalidates an important invariant of dictionaries: every + value in ``d.keys()`` is usable as a key of the dictionary. + +- Mark lists as read-only once they are used as a dictionary key. The problem + is that it's not just the top-level object that could change its value; you + could use a tuple containing a list as a key. Entering anything as a key into + a dictionary would require marking all objects reachable from there as + read-only -- and again, self-referential objects could cause an infinite loop. + +There is a trick to get around this if you need to, but use it at your own risk: +You can wrap a mutable structure inside a class instance which has both a +:meth:`__eq__` and a :meth:`__hash__` method. You must then make sure that the +hash value for all such wrapper objects that reside in a dictionary (or other +hash based structure), remain fixed while the object is in the dictionary (or +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 + for i, el in enumerate(l): + try: + result = result + (hash(el) % 9999999) * 1001 + i + except Exception: + result = (result % 7777777) + i * 333 + return result + +Note that the hash computation is complicated by the possibility that some +members of the list may be unhashable and also by the possibility of arithmetic +overflow. + +Furthermore it must always be the case that if ``o1 == o2`` (ie ``o1.__eq__(o2) +is True``) then ``hash(o1) == hash(o2)`` (ie, ``o1.__hash__() == o2.__hash__()``), +regardless of whether the object is in a dictionary or not. If you fail to meet +these restrictions dictionaries and other hash based structures will misbehave. + +In the case of ListWrapper, whenever the wrapper object is in a dictionary the +wrapped list must not change to avoid anomalies. Don't do this unless you are +prepared to think hard about the requirements and the consequences of not +meeting them correctly. Consider yourself warned. + + +Why doesn't list.sort() return the sorted list? +----------------------------------------------- + +In situations where performance matters, making a copy of the list just to sort +it would be wasteful. Therefore, :meth:`list.sort` sorts the list in place. In +order to remind you of that fact, it does not return the sorted list. This way, +you won't be fooled into accidentally overwriting a list when you need a sorted +copy but also need to keep the unsorted version around. + +If you want to return a new list, use the built-in :func:`sorted` function +instead. This function creates a new list from a provided iterable, sorts +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]... + + +How do you specify and enforce an interface spec in Python? +----------------------------------------------------------- + +An interface specification for a module as provided by languages such as C++ and +Java describes the prototypes for the methods and functions of the module. Many +feel that compile-time enforcement of interface specifications helps in the +construction of large programs. + +Python 2.6 adds an :mod:`abc` module that lets you define Abstract Base Classes +(ABCs). You can then use :func:`isinstance` and :func:`issubclass` to check +whether an instance or a class implements a particular ABC. The +:mod:`collections.abc` module defines a set of useful ABCs such as +:class:`~collections.abc.Iterable`, :class:`~collections.abc.Container`, and +:class:`~collections.abc.MutableMapping`. + +For Python, many of the advantages of interface specifications can be obtained +by an appropriate test discipline for components. There is also a tool, +PyChecker, which can be used to find problems due to subclassing. + +A good test suite for a module can both provide a regression test and serve as a +module interface specification and a set of examples. Many Python modules can +be run as a script to provide a simple "self test." Even modules which use +complex external interfaces can often be tested in isolation using trivial +"stub" emulations of the external interface. The :mod:`doctest` and +:mod:`unittest` modules or third-party test frameworks can be used to construct +exhaustive test suites that exercise every line of code in a module. + +An appropriate testing discipline can help build large complex applications in +Python as well as having interface specifications would. In fact, it can be +better because an interface specification cannot test certain properties of a +program. For example, the :meth:`append` method is expected to add new elements +to the end of some internal list; an interface specification cannot test that +your :meth:`append` implementation will actually do this correctly, but it's +trivial to check this property in a test suite. + +Writing test suites is very helpful, and you might want to design your code with +an eye to making it easily tested. One increasingly popular technique, +test-directed development, calls for writing parts of the test suite first, +before you write any of the actual code. Of course Python allows you to be +sloppy and not write test cases at all. + + +Why is there no goto? +--------------------- + +You can use exceptions to provide a "structured goto" that even works across +function calls. Many feel that exceptions can conveniently emulate all +reasonable uses of the "go" or "goto" constructs of C, Fortran, and other +languages. For example:: + + class label(Exception): pass # declare a label + + try: + ... + if condition: raise label() # goto label + ... + except label: # where to goto + pass + ... + +This doesn't allow you to jump into the middle of a loop, but that's usually +considered an abuse of goto anyway. Use sparingly. + + +Why can't raw strings (r-strings) end with a backslash? +------------------------------------------------------- + +More precisely, they can't end with an odd number of backslashes: the unpaired +backslash at the end escapes the closing quote character, leaving an +unterminated string. + +Raw strings were designed to ease creating input for processors (chiefly regular +expression engines) that want to do their own backslash escape processing. Such +processors consider an unmatched trailing backslash to be an error anyway, so +raw strings disallow that. In return, they allow you to pass on the string +quote character by escaping it with a backslash. These rules work well when +r-strings are used for their intended purpose. + +If you're trying to build Windows pathnames, note that all Windows system calls +accept forward slashes too:: + + f = open("/mydir/file.txt") # works fine! + +If you're trying to build a pathname for a DOS command, try e.g. one of :: + + dir = r"\this\is\my\dos\dir" "\\" + dir = r"\this\is\my\dos\dir\ "[:-1] + dir = "\\this\\is\\my\\dos\\dir\\" + + +Why doesn't Python have a "with" statement for attribute assignments? +--------------------------------------------------------------------- + +Python has a 'with' statement that wraps the execution of a block, calling code +on the entrance and exit from the block. Some language have a construct that +looks like this:: + + with obj: + a = 1 # equivalent to obj.a = 1 + total = total + 1 # obj.total = obj.total + 1 + +In Python, such a construct would be ambiguous. + +Other languages, such as Object Pascal, Delphi, and C++, use static types, so +it's possible to know, in an unambiguous way, what member is being assigned +to. This is the main point of static typing -- the compiler *always* knows the +scope of every variable at compile time. + +Python uses dynamic types. It is impossible to know in advance which attribute +will be referenced at runtime. Member attributes may be added or removed from +objects on the fly. This makes it impossible to know, from a simple reading, +what attribute is being referenced: a local one, a global one, or a member +attribute? + +For instance, take the following incomplete snippet:: + + def foo(a): + with a: + print(x) + +The snippet assumes that "a" must have a member attribute called "x". However, +there is nothing in Python that tells the interpreter this. What should happen +if "a" is, let us say, an integer? If there is a global variable named "x", +will it be used inside the with block? As you see, the dynamic nature of Python +makes such choices much harder. + +The primary benefit of "with" and similar language features (reduction of code +volume) can, however, easily be achieved in Python by assignment. Instead of:: + + function(args).mydict[index][index].a = 21 + function(args).mydict[index][index].b = 42 + function(args).mydict[index][index].c = 63 + +write this:: + + ref = function(args).mydict[index][index] + ref.a = 21 + ref.b = 42 + ref.c = 63 + +This also has the side-effect of increasing execution speed because name +bindings are resolved at run-time in Python, and the second version only needs +to perform the resolution once. + + +Why are colons required for the if/while/def/class statements? +-------------------------------------------------------------- + +The colon is required primarily to enhance readability (one of the results of +the experimental ABC language). Consider this:: + + if a == b + print(a) + +versus :: + + if a == b: + print(a) + +Notice how the second one is slightly easier to read. Notice further how a +colon sets off the example in this FAQ answer; it's a standard usage in English. + +Another minor reason is that the colon makes it easier for editors with syntax +highlighting; they can look for colons to decide when indentation needs to be +increased instead of having to do a more elaborate parsing of the program text. + + +Why does Python allow commas at the end of lists and tuples? +------------------------------------------------------------ + +Python lets you add a trailing comma at the end of lists, tuples, and +dictionaries:: + + [1, 2, 3,] + ('a', 'b', 'c',) + d = { + "A": [1, 5], + "B": [6, 7], # last trailing comma is optional but good style + } + + +There are several reasons to allow this. + +When you have a literal value for a list, tuple, or dictionary spread across +multiple lines, it's easier to add more elements because you don't have to +remember to add a comma to the previous line. The lines can also be reordered +without creating a syntax error. + +Accidentally omitting the comma can lead to errors that are hard to diagnose. +For example:: + + x = [ + "fee", + "fie" + "foo", + "fum" + ] + +This list looks like it has four elements, but it actually contains three: +"fee", "fiefoo" and "fum". Always adding the comma avoids this source of error. + +Allowing the trailing comma may also make programmatic code generation easier. diff --git a/python-3.7.4-docs-html/_sources/faq/extending.rst.txt b/python-3.7.4-docs-html/_sources/faq/extending.rst.txt new file mode 100644 index 0000000..2ad2765 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/faq/extending.rst.txt @@ -0,0 +1,447 @@ +======================= +Extending/Embedding FAQ +======================= + +.. only:: html + + .. contents:: + +.. highlight:: c + + +.. XXX need review for Python 3. + + +Can I create my own functions in C? +----------------------------------- + +Yes, you can create built-in modules containing functions, variables, exceptions +and even new types in C. This is explained in the document +:ref:`extending-index`. + +Most intermediate or advanced Python books will also cover this topic. + + +Can I create my own functions in C++? +------------------------------------- + +Yes, using the C compatibility features found in C++. Place ``extern "C" { +... }`` around the Python include files and put ``extern "C"`` before each +function that is going to be called by the Python interpreter. Global or static +C++ objects with constructors are probably not a good idea. + + +.. _c-wrapper-software: + +Writing C is hard; are there any alternatives? +---------------------------------------------- + +There are a number of alternatives to writing your own C extensions, depending +on what you're trying to do. + +.. XXX make sure these all work + +`Cython `_ and its relative `Pyrex +`_ are compilers +that accept a slightly modified form of Python and generate the corresponding +C code. Cython and Pyrex make it possible to write an extension without having +to learn Python's C API. + +If you need to interface to some C or C++ library for which no Python extension +currently exists, you can try wrapping the library's data types and functions +with a tool such as `SWIG `_. `SIP +`__, `CXX +`_ `Boost +`_, or `Weave +`_ are also +alternatives for wrapping C++ libraries. + + +How can I execute arbitrary Python statements from C? +----------------------------------------------------- + +The highest-level function to do this is :c:func:`PyRun_SimpleString` which takes +a single string argument to be executed in the context of the module +``__main__`` and returns ``0`` for success and ``-1`` when an exception occurred +(including :exc:`SyntaxError`). If you want more control, use +:c:func:`PyRun_String`; see the source for :c:func:`PyRun_SimpleString` in +``Python/pythonrun.c``. + + +How can I evaluate an arbitrary Python expression from C? +--------------------------------------------------------- + +Call the function :c:func:`PyRun_String` from the previous question with the +start symbol :c:data:`Py_eval_input`; it parses an expression, evaluates it and +returns its value. + + +How do I extract C values from a Python object? +----------------------------------------------- + +That depends on the object's type. If it's a tuple, :c:func:`PyTuple_Size` +returns its length and :c:func:`PyTuple_GetItem` returns the item at a specified +index. Lists have similar functions, :c:func:`PyListSize` and +:c:func:`PyList_GetItem`. + +For bytes, :c:func:`PyBytes_Size` returns its length and +:c:func:`PyBytes_AsStringAndSize` provides a pointer to its value and its +length. Note that Python bytes objects may contain null bytes so C's +:c:func:`strlen` should not be used. + +To test the type of an object, first make sure it isn't *NULL*, and then use +:c:func:`PyBytes_Check`, :c:func:`PyTuple_Check`, :c:func:`PyList_Check`, etc. + +There is also a high-level API to Python objects which is provided by the +so-called 'abstract' interface -- read ``Include/abstract.h`` for further +details. It allows interfacing with any kind of Python sequence using calls +like :c:func:`PySequence_Length`, :c:func:`PySequence_GetItem`, etc. as well +as many other useful protocols such as numbers (:c:func:`PyNumber_Index` et +al.) and mappings in the PyMapping APIs. + + +How do I use Py_BuildValue() to create a tuple of arbitrary length? +------------------------------------------------------------------- + +You can't. Use :c:func:`PyTuple_Pack` instead. + + +How do I call an object's method from C? +---------------------------------------- + +The :c:func:`PyObject_CallMethod` function can be used to call an arbitrary +method of an object. The parameters are the object, the name of the method to +call, a format string like that used with :c:func:`Py_BuildValue`, and the +argument values:: + + PyObject * + PyObject_CallMethod(PyObject *object, const char *method_name, + const char *arg_format, ...); + +This works for any object that has methods -- whether built-in or user-defined. +You are responsible for eventually :c:func:`Py_DECREF`\ 'ing the return value. + +To call, e.g., a file object's "seek" method with arguments 10, 0 (assuming the +file object pointer is "f"):: + + res = PyObject_CallMethod(f, "seek", "(ii)", 10, 0); + if (res == NULL) { + ... an exception occurred ... + } + else { + Py_DECREF(res); + } + +Note that since :c:func:`PyObject_CallObject` *always* wants a tuple for the +argument list, to call a function without arguments, pass "()" for the format, +and to call a function with one argument, surround the argument in parentheses, +e.g. "(i)". + + +How do I catch the output from PyErr_Print() (or anything that prints to stdout/stderr)? +---------------------------------------------------------------------------------------- + +In Python code, define an object that supports the ``write()`` method. Assign +this object to :data:`sys.stdout` and :data:`sys.stderr`. Call print_error, or +just allow the standard traceback mechanism to work. Then, the output will go +wherever your ``write()`` method sends it. + +The easiest way to do this is to use the :class:`io.StringIO` class: + +.. code-block:: pycon + + >>> import io, sys + >>> sys.stdout = io.StringIO() + >>> print('foo') + >>> print('hello world!') + >>> sys.stderr.write(sys.stdout.getvalue()) + foo + hello world! + +A custom object to do the same would look like this: + +.. code-block:: pycon + + >>> import io, sys + >>> class StdoutCatcher(io.TextIOBase): + ... def __init__(self): + ... self.data = [] + ... def write(self, stuff): + ... self.data.append(stuff) + ... + >>> import sys + >>> sys.stdout = StdoutCatcher() + >>> print('foo') + >>> print('hello world!') + >>> sys.stderr.write(''.join(sys.stdout.data)) + foo + hello world! + + +How do I access a module written in Python from C? +-------------------------------------------------- + +You can get a pointer to the module object as follows:: + + module = PyImport_ImportModule(""); + +If the module hasn't been imported yet (i.e. it is not yet present in +:data:`sys.modules`), this initializes the module; otherwise it simply returns +the value of ``sys.modules[""]``. Note that it doesn't enter the +module into any namespace -- it only ensures it has been initialized and is +stored in :data:`sys.modules`. + +You can then access the module's attributes (i.e. any name defined in the +module) as follows:: + + attr = PyObject_GetAttrString(module, ""); + +Calling :c:func:`PyObject_SetAttrString` to assign to variables in the module +also works. + + +How do I interface to C++ objects from Python? +---------------------------------------------- + +Depending on your requirements, there are many approaches. To do this manually, +begin by reading :ref:`the "Extending and Embedding" document +`. Realize that for the Python run-time system, there isn't a +whole lot of difference between C and C++ -- so the strategy of building a new +Python type around a C structure (pointer) type will also work for C++ objects. + +For C++ libraries, see :ref:`c-wrapper-software`. + + +I added a module using the Setup file and the make fails; why? +-------------------------------------------------------------- + +Setup must end in a newline, if there is no newline there, the build process +fails. (Fixing this requires some ugly shell script hackery, and this bug is so +minor that it doesn't seem worth the effort.) + + +How do I debug an extension? +---------------------------- + +When using GDB with dynamically loaded extensions, you can't set a breakpoint in +your extension until your extension is loaded. + +In your ``.gdbinit`` file (or interactively), add the command: + +.. code-block:: none + + br _PyImport_LoadDynamicModule + +Then, when you run GDB: + +.. code-block:: shell-session + + $ gdb /local/bin/python + gdb) run myscript.py + gdb) continue # repeat until your extension is loaded + gdb) finish # so that your extension is loaded + gdb) br myfunction.c:50 + gdb) continue + +I want to compile a Python module on my Linux system, but some files are missing. Why? +-------------------------------------------------------------------------------------- + +Most packaged versions of Python don't include the +:file:`/usr/lib/python2.{x}/config/` directory, which contains various files +required for compiling Python extensions. + +For Red Hat, install the python-devel RPM to get the necessary files. + +For Debian, run ``apt-get install python-dev``. + + +How do I tell "incomplete input" from "invalid input"? +------------------------------------------------------ + +Sometimes you want to emulate the Python interactive interpreter's behavior, +where it gives you a continuation prompt when the input is incomplete (e.g. you +typed the start of an "if" statement or you didn't close your parentheses or +triple string quotes), but it gives you a syntax error message immediately when +the input is invalid. + +In Python you can use the :mod:`codeop` module, which approximates the parser's +behavior sufficiently. IDLE uses this, for example. + +The easiest way to do it in C is to call :c:func:`PyRun_InteractiveLoop` (perhaps +in a separate thread) and let the Python interpreter handle the input for +you. You can also set the :c:func:`PyOS_ReadlineFunctionPointer` to point at your +custom input function. See ``Modules/readline.c`` and ``Parser/myreadline.c`` +for more hints. + +However sometimes you have to run the embedded Python interpreter in the same +thread as your rest application and you can't allow the +:c:func:`PyRun_InteractiveLoop` to stop while waiting for user input. The one +solution then is to call :c:func:`PyParser_ParseString` and test for ``e.error`` +equal to ``E_EOF``, which means the input is incomplete. Here's a sample code +fragment, untested, inspired by code from Alex Farber:: + + #define PY_SSIZE_T_CLEAN + #include + #include + #include + #include + #include + #include + + int testcomplete(char *code) + /* code should end in \n */ + /* return -1 for error, 0 for incomplete, 1 for complete */ + { + node *n; + perrdetail e; + + n = PyParser_ParseString(code, &_PyParser_Grammar, + Py_file_input, &e); + if (n == NULL) { + if (e.error == E_EOF) + return 0; + return -1; + } + + PyNode_Free(n); + return 1; + } + +Another solution is trying to compile the received string with +:c:func:`Py_CompileString`. If it compiles without errors, try to execute the +returned code object by calling :c:func:`PyEval_EvalCode`. Otherwise save the +input for later. If the compilation fails, find out if it's an error or just +more input is required - by extracting the message string from the exception +tuple and comparing it to the string "unexpected EOF while parsing". Here is a +complete example using the GNU readline library (you may want to ignore +**SIGINT** while calling readline()):: + + #include + #include + + #define PY_SSIZE_T_CLEAN + #include + #include + #include + #include + + int main (int argc, char* argv[]) + { + int i, j, done = 0; /* lengths of line, code */ + char ps1[] = ">>> "; + char ps2[] = "... "; + char *prompt = ps1; + char *msg, *line, *code = NULL; + PyObject *src, *glb, *loc; + PyObject *exc, *val, *trb, *obj, *dum; + + Py_Initialize (); + loc = PyDict_New (); + glb = PyDict_New (); + PyDict_SetItemString (glb, "__builtins__", PyEval_GetBuiltins ()); + + while (!done) + { + line = readline (prompt); + + if (NULL == line) /* Ctrl-D pressed */ + { + done = 1; + } + else + { + i = strlen (line); + + if (i > 0) + add_history (line); /* save non-empty lines */ + + if (NULL == code) /* nothing in code yet */ + j = 0; + else + j = strlen (code); + + code = realloc (code, i + j + 2); + if (NULL == code) /* out of memory */ + exit (1); + + if (0 == j) /* code was empty, so */ + code[0] = '\0'; /* keep strncat happy */ + + strncat (code, line, i); /* append line to code */ + code[i + j] = '\n'; /* append '\n' to code */ + code[i + j + 1] = '\0'; + + src = Py_CompileString (code, "", Py_single_input); + + if (NULL != src) /* compiled just fine - */ + { + if (ps1 == prompt || /* ">>> " or */ + '\n' == code[i + j - 1]) /* "... " and double '\n' */ + { /* so execute it */ + dum = PyEval_EvalCode (src, glb, loc); + Py_XDECREF (dum); + Py_XDECREF (src); + free (code); + code = NULL; + if (PyErr_Occurred ()) + PyErr_Print (); + prompt = ps1; + } + } /* syntax error or E_EOF? */ + else if (PyErr_ExceptionMatches (PyExc_SyntaxError)) + { + PyErr_Fetch (&exc, &val, &trb); /* clears exception! */ + + if (PyArg_ParseTuple (val, "sO", &msg, &obj) && + !strcmp (msg, "unexpected EOF while parsing")) /* E_EOF */ + { + Py_XDECREF (exc); + Py_XDECREF (val); + Py_XDECREF (trb); + prompt = ps2; + } + else /* some other syntax error */ + { + PyErr_Restore (exc, val, trb); + PyErr_Print (); + free (code); + code = NULL; + prompt = ps1; + } + } + else /* some non-syntax error */ + { + PyErr_Print (); + free (code); + code = NULL; + prompt = ps1; + } + + free (line); + } + } + + Py_XDECREF(glb); + Py_XDECREF(loc); + Py_Finalize(); + exit(0); + } + + +How do I find undefined g++ symbols __builtin_new or __pure_virtual? +-------------------------------------------------------------------- + +To dynamically load g++ extension modules, you must recompile Python, relink it +using g++ (change LINKCC in the Python Modules Makefile), and link your +extension module using g++ (e.g., ``g++ -shared -o mymodule.so mymodule.o``). + + +Can I create an object class with some methods implemented in C and others in Python (e.g. through inheritance)? +---------------------------------------------------------------------------------------------------------------- + +Yes, you can inherit from built-in classes such as :class:`int`, :class:`list`, +:class:`dict`, etc. + +The Boost Python Library (BPL, http://www.boost.org/libs/python/doc/index.html) +provides a way of doing this from C++ (i.e. you can inherit from an extension +class written in C++ using the BPL). diff --git a/python-3.7.4-docs-html/_sources/faq/general.rst.txt b/python-3.7.4-docs-html/_sources/faq/general.rst.txt new file mode 100644 index 0000000..3ef553e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/faq/general.rst.txt @@ -0,0 +1,446 @@ +:tocdepth: 2 + +================== +General Python FAQ +================== + +.. only:: html + + .. contents:: + + +General Information +=================== + +What is Python? +--------------- + +Python is an interpreted, interactive, object-oriented programming language. It +incorporates modules, exceptions, dynamic typing, very high level dynamic data +types, and classes. Python combines remarkable power with very clear syntax. +It has interfaces to many system calls and libraries, as well as to various +window systems, and is extensible in C or C++. It is also usable as an +extension language for applications that need a programmable interface. +Finally, Python is portable: it runs on many Unix variants, on the Mac, and on +Windows 2000 and later. + +To find out more, start with :ref:`tutorial-index`. The `Beginner's Guide to +Python `_ links to other +introductory tutorials and resources for learning Python. + + +What is the Python Software Foundation? +--------------------------------------- + +The Python Software Foundation is an independent non-profit organization that +holds the copyright on Python versions 2.1 and newer. The PSF's mission is to +advance open source technology related to the Python programming language and to +publicize the use of Python. The PSF's home page is at +https://www.python.org/psf/. + +Donations to the PSF are tax-exempt in the US. If you use Python and find it +helpful, please contribute via `the PSF donation page +`_. + + +Are there copyright restrictions on the use of Python? +------------------------------------------------------ + +You can do anything you want with the source, as long as you leave the +copyrights in and display those copyrights in any documentation about Python +that you produce. If you honor the copyright rules, it's OK to use Python for +commercial use, to sell copies of Python in source or binary form (modified or +unmodified), or to sell products that incorporate Python in some form. We would +still like to know about all commercial use of Python, of course. + +See `the PSF license page `_ to find further +explanations and a link to the full text of the license. + +The Python logo is trademarked, and in certain cases permission is required to +use it. Consult `the Trademark Usage Policy +`__ for more information. + + +Why was Python created in the first place? +------------------------------------------ + +Here's a *very* brief summary of what started it all, written by Guido van +Rossum: + + I had extensive experience with implementing an interpreted language in the + ABC group at CWI, and from working with this group I had learned a lot about + language design. This is the origin of many Python features, including the + use of indentation for statement grouping and the inclusion of + very-high-level data types (although the details are all different in + Python). + + I had a number of gripes about the ABC language, but also liked many of its + features. It was impossible to extend the ABC language (or its + implementation) to remedy my complaints -- in fact its lack of extensibility + was one of its biggest problems. I had some experience with using Modula-2+ + and talked with the designers of Modula-3 and read the Modula-3 report. + Modula-3 is the origin of the syntax and semantics used for exceptions, and + some other Python features. + + I was working in the Amoeba distributed operating system group at CWI. We + needed a better way to do system administration than by writing either C + programs or Bourne shell scripts, since Amoeba had its own system call + interface which wasn't easily accessible from the Bourne shell. My + experience with error handling in Amoeba made me acutely aware of the + importance of exceptions as a programming language feature. + + It occurred to me that a scripting language with a syntax like ABC but with + access to the Amoeba system calls would fill the need. I realized that it + would be foolish to write an Amoeba-specific language, so I decided that I + needed a language that was generally extensible. + + During the 1989 Christmas holidays, I had a lot of time on my hand, so I + decided to give it a try. During the next year, while still mostly working + on it in my own time, Python was used in the Amoeba project with increasing + success, and the feedback from colleagues made me add many early + improvements. + + In February 1991, after just over a year of development, I decided to post to + USENET. The rest is in the ``Misc/HISTORY`` file. + + +What is Python good for? +------------------------ + +Python is a high-level general-purpose programming language that can be applied +to many different classes of problems. + +The language comes with a large standard library that covers areas such as +string processing (regular expressions, Unicode, calculating differences between +files), Internet protocols (HTTP, FTP, SMTP, XML-RPC, POP, IMAP, CGI +programming), software engineering (unit testing, logging, profiling, parsing +Python code), and operating system interfaces (system calls, filesystems, TCP/IP +sockets). Look at the table of contents for :ref:`library-index` to get an idea +of what's available. A wide variety of third-party extensions are also +available. Consult `the Python Package Index `_ to +find packages of interest to you. + + +How does the Python version numbering scheme work? +-------------------------------------------------- + +Python versions are numbered A.B.C or A.B. A is the major version number -- it +is only incremented for really major changes in the language. B is the minor +version number, incremented for less earth-shattering changes. C is the +micro-level -- it is incremented for each bugfix release. See :pep:`6` for more +information about bugfix releases. + +Not all releases are bugfix releases. In the run-up to a new major release, a +series of development releases are made, denoted as alpha, beta, or release +candidate. Alphas are early releases in which interfaces aren't yet finalized; +it's not unexpected to see an interface change between two alpha releases. +Betas are more stable, preserving existing interfaces but possibly adding new +modules, and release candidates are frozen, making no changes except as needed +to fix critical bugs. + +Alpha, beta and release candidate versions have an additional suffix. The +suffix for an alpha version is "aN" for some small number N, the suffix for a +beta version is "bN" for some small number N, and the suffix for a release +candidate version is "cN" for some small number N. In other words, all versions +labeled 2.0aN precede the versions labeled 2.0bN, which precede versions labeled +2.0cN, and *those* precede 2.0. + +You may also find version numbers with a "+" suffix, e.g. "2.2+". These are +unreleased versions, built directly from the CPython development repository. In +practice, after a final minor release is made, the version is incremented to the +next minor version, which becomes the "a0" version, e.g. "2.4a0". + +See also the documentation for :data:`sys.version`, :data:`sys.hexversion`, and +:data:`sys.version_info`. + + +How do I obtain a copy of the Python source? +-------------------------------------------- + +The latest Python source distribution is always available from python.org, at +https://www.python.org/downloads/. The latest development sources can be obtained +at https://github.com/python/cpython/. + +The source distribution is a gzipped tar file containing the complete C source, +Sphinx-formatted documentation, Python library modules, example programs, and +several useful pieces of freely distributable software. The source will compile +and run out of the box on most UNIX platforms. + +Consult the `Getting Started section of the Python Developer's Guide +`__ for more +information on getting the source code and compiling it. + + +How do I get documentation on Python? +------------------------------------- + +.. XXX mention py3k + +The standard documentation for the current stable version of Python is available +at https://docs.python.org/3/. PDF, plain text, and downloadable HTML versions are +also available at https://docs.python.org/3/download.html. + +The documentation is written in reStructuredText and processed by `the Sphinx +documentation tool `__. The reStructuredText source for +the documentation is part of the Python source distribution. + + +I've never programmed before. Is there a Python tutorial? +--------------------------------------------------------- + +There are numerous tutorials and books available. The standard documentation +includes :ref:`tutorial-index`. + +Consult `the Beginner's Guide `_ to +find information for beginning Python programmers, including lists of tutorials. + + +Is there a newsgroup or mailing list devoted to Python? +------------------------------------------------------- + +There is a newsgroup, :newsgroup:`comp.lang.python`, and a mailing list, +`python-list `_. The +newsgroup and mailing list are gatewayed into each other -- if you can read news +it's unnecessary to subscribe to the mailing list. +:newsgroup:`comp.lang.python` is high-traffic, receiving hundreds of postings +every day, and Usenet readers are often more able to cope with this volume. + +Announcements of new software releases and events can be found in +comp.lang.python.announce, a low-traffic moderated list that receives about five +postings per day. It's available as `the python-announce mailing list +`_. + +More info about other mailing lists and newsgroups +can be found at https://www.python.org/community/lists/. + + +How do I get a beta test version of Python? +------------------------------------------- + +Alpha and beta releases are available from https://www.python.org/downloads/. All +releases are announced on the comp.lang.python and comp.lang.python.announce +newsgroups and on the Python home page at https://www.python.org/; an RSS feed of +news is available. + +You can also access the development version of Python through Git. See +`The Python Developer's Guide `_ for details. + + +How do I submit bug reports and patches for Python? +--------------------------------------------------- + +To report a bug or submit a patch, please use the Roundup installation at +https://bugs.python.org/. + +You must have a Roundup account to report bugs; this makes it possible for us to +contact you if we have follow-up questions. It will also enable Roundup to send +you updates as we act on your bug. If you had previously used SourceForge to +report bugs to Python, you can obtain your Roundup password through Roundup's +`password reset procedure `_. + +For more information on how Python is developed, consult `the Python Developer's +Guide `_. + + +Are there any published articles about Python that I can reference? +------------------------------------------------------------------- + +It's probably best to cite your favorite book about Python. + +The very first article about Python was written in 1991 and is now quite +outdated. + + Guido van Rossum and Jelke de Boer, "Interactively Testing Remote Servers + Using the Python Programming Language", CWI Quarterly, Volume 4, Issue 4 + (December 1991), Amsterdam, pp 283--303. + + +Are there any books on Python? +------------------------------ + +Yes, there are many, and more are being published. See the python.org wiki at +https://wiki.python.org/moin/PythonBooks for a list. + +You can also search online bookstores for "Python" and filter out the Monty +Python references; or perhaps search for "Python" and "language". + + +Where in the world is www.python.org located? +--------------------------------------------- + +The Python project's infrastructure is located all over the world and is managed +by the Python Infrastructure Team. Details `here `__. + + +Why is it called Python? +------------------------ + +When he began implementing Python, Guido van Rossum was also reading the +published scripts from `"Monty Python's Flying Circus" +`__, a BBC comedy series from the 1970s. Van Rossum +thought he needed a name that was short, unique, and slightly mysterious, so he +decided to call the language Python. + + +Do I have to like "Monty Python's Flying Circus"? +------------------------------------------------- + +No, but it helps. :) + + +Python in the real world +======================== + +How stable is Python? +--------------------- + +Very stable. New, stable releases have been coming out roughly every 6 to 18 +months since 1991, and this seems likely to continue. Currently there are +usually around 18 months between major releases. + +The developers issue "bugfix" releases of older versions, so the stability of +existing releases gradually improves. Bugfix releases, indicated by a third +component of the version number (e.g. 3.5.3, 3.6.2), are managed for stability; +only fixes for known problems are included in a bugfix release, and it's +guaranteed that interfaces will remain the same throughout a series of bugfix +releases. + +The latest stable releases can always be found on the `Python download page +`_. There are two production-ready versions +of Python: 2.x and 3.x. The recommended version is 3.x, which is supported by +most widely used libraries. Although 2.x is still widely used, `it will not +be maintained after January 1, 2020 `_. + +How many people are using Python? +--------------------------------- + +There are probably tens of thousands of users, though it's difficult to obtain +an exact count. + +Python is available for free download, so there are no sales figures, and it's +available from many different sites and packaged with many Linux distributions, +so download statistics don't tell the whole story either. + +The comp.lang.python newsgroup is very active, but not all Python users post to +the group or even read it. + + +Have any significant projects been done in Python? +-------------------------------------------------- + +See https://www.python.org/about/success for a list of projects that use Python. +Consulting the proceedings for `past Python conferences +`_ will reveal contributions from many +different companies and organizations. + +High-profile Python projects include `the Mailman mailing list manager +`_ and `the Zope application server +`_. Several Linux distributions, most notably `Red Hat +`_, have written part or all of their installer and +system administration software in Python. Companies that use Python internally +include Google, Yahoo, and Lucasfilm Ltd. + + +What new developments are expected for Python in the future? +------------------------------------------------------------ + +See https://www.python.org/dev/peps/ for the Python Enhancement Proposals +(PEPs). PEPs are design documents describing a suggested new feature for Python, +providing a concise technical specification and a rationale. Look for a PEP +titled "Python X.Y Release Schedule", where X.Y is a version that hasn't been +publicly released yet. + +New development is discussed on `the python-dev mailing list +`_. + + +Is it reasonable to propose incompatible changes to Python? +----------------------------------------------------------- + +In general, no. There are already millions of lines of Python code around the +world, so any change in the language that invalidates more than a very small +fraction of existing programs has to be frowned upon. Even if you can provide a +conversion program, there's still the problem of updating all documentation; +many books have been written about Python, and we don't want to invalidate them +all at a single stroke. + +Providing a gradual upgrade path is necessary if a feature has to be changed. +:pep:`5` describes the procedure followed for introducing backward-incompatible +changes while minimizing disruption for users. + + +Is Python a good language for beginning programmers? +---------------------------------------------------- + +Yes. + +It is still common to start students with a procedural and statically typed +language such as Pascal, C, or a subset of C++ or Java. Students may be better +served by learning Python as their first language. Python has a very simple and +consistent syntax and a large standard library and, most importantly, using +Python in a beginning programming course lets students concentrate on important +programming skills such as problem decomposition and data type design. With +Python, students can be quickly introduced to basic concepts such as loops and +procedures. They can probably even work with user-defined objects in their very +first course. + +For a student who has never programmed before, using a statically typed language +seems unnatural. It presents additional complexity that the student must master +and slows the pace of the course. The students are trying to learn to think +like a computer, decompose problems, design consistent interfaces, and +encapsulate data. While learning to use a statically typed language is +important in the long term, it is not necessarily the best topic to address in +the students' first programming course. + +Many other aspects of Python make it a good first language. Like Java, Python +has a large standard library so that students can be assigned programming +projects very early in the course that *do* something. Assignments aren't +restricted to the standard four-function calculator and check balancing +programs. By using the standard library, students can gain the satisfaction of +working on realistic applications as they learn the fundamentals of programming. +Using the standard library also teaches students about code reuse. Third-party +modules such as PyGame are also helpful in extending the students' reach. + +Python's interactive interpreter enables students to test language features +while they're programming. They can keep a window with the interpreter running +while they enter their program's source in another window. If they can't +remember the methods for a list, they can do something like this:: + + >>> L = [] + >>> dir(L) # doctest: +NORMALIZE_WHITESPACE + ['__add__', '__class__', '__contains__', '__delattr__', '__delitem__', + '__dir__', '__doc__', '__eq__', '__format__', '__ge__', + '__getattribute__', '__getitem__', '__gt__', '__hash__', '__iadd__', + '__imul__', '__init__', '__iter__', '__le__', '__len__', '__lt__', + '__mul__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', + '__repr__', '__reversed__', '__rmul__', '__setattr__', '__setitem__', + '__sizeof__', '__str__', '__subclasshook__', 'append', 'clear', + 'copy', 'count', 'extend', 'index', 'insert', 'pop', 'remove', + 'reverse', 'sort'] + >>> [d for d in dir(L) if '__' not in d] + ['append', 'clear', 'copy', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort'] + + >>> help(L.append) + Help on built-in function append: + + append(...) + L.append(object) -> None -- append object to end + + >>> L.append(1) + >>> L + [1] + +With the interpreter, documentation is never far from the student as they are +programming. + +There are also good IDEs for Python. IDLE is a cross-platform IDE for Python +that is written in Python using Tkinter. PythonWin is a Windows-specific IDE. +Emacs users will be happy to know that there is a very good Python mode for +Emacs. All of these programming environments provide syntax highlighting, +auto-indenting, and access to the interactive interpreter while coding. Consult +`the Python wiki `_ for a full list +of Python editing environments. + +If you want to discuss Python's use in education, you may be interested in +joining `the edu-sig mailing list +`_. diff --git a/python-3.7.4-docs-html/_sources/faq/gui.rst.txt b/python-3.7.4-docs-html/_sources/faq/gui.rst.txt new file mode 100644 index 0000000..781da46 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/faq/gui.rst.txt @@ -0,0 +1,159 @@ +:tocdepth: 2 + +========================== +Graphic User Interface FAQ +========================== + +.. only:: html + + .. contents:: + +.. XXX need review for Python 3. + + +General GUI Questions +===================== + +What platform-independent GUI toolkits exist for Python? +======================================================== + +Depending on what platform(s) you are aiming at, there are several. Some +of them haven't been ported to Python 3 yet. At least `Tkinter`_ and `Qt`_ +are known to be Python 3-compatible. + +.. XXX check links + +Tkinter +------- + +Standard builds of Python include an object-oriented interface to the Tcl/Tk +widget set, called :ref:`tkinter `. This is probably the easiest to +install (since it comes included with most +`binary distributions `_ of Python) and use. +For more info about Tk, including pointers to the source, see the +`Tcl/Tk home page `_. Tcl/Tk is fully portable to the +Mac OS X, Windows, and Unix platforms. + +wxWidgets +--------- + +wxWidgets (https://www.wxwidgets.org) is a free, portable GUI class +library written in C++ that provides a native look and feel on a +number of platforms, with Windows, Mac OS X, GTK, X11, all listed as +current stable targets. Language bindings are available for a number +of languages including Python, Perl, Ruby, etc. + +`wxPython `_ is the Python binding for +wxwidgets. While it often lags slightly behind the official wxWidgets +releases, it also offers a number of features via pure Python +extensions that are not available in other language bindings. There +is an active wxPython user and developer community. + +Both wxWidgets and wxPython are free, open source, software with +permissive licences that allow their use in commercial products as +well as in freeware or shareware. + + +Qt +--- + +There are bindings available for the Qt toolkit (using either `PyQt +`_ or `PySide +`_) and for KDE (`PyKDE4 `__). +PyQt is currently more mature than PySide, but you must buy a PyQt license from +`Riverbank Computing `_ +if you want to write proprietary applications. PySide is free for all applications. + +Qt 4.5 upwards is licensed under the LGPL license; also, commercial licenses +are available from `The Qt Company `_. + +Gtk+ +---- + +The `GObject introspection bindings `_ +for Python allow you to write GTK+ 3 applications. There is also a +`Python GTK+ 3 Tutorial `_. + +The older PyGtk bindings for the `Gtk+ 2 toolkit `_ have +been implemented by James Henstridge; see . + +Kivy +---- + +`Kivy `_ is a cross-platform GUI library supporting both +desktop operating systems (Windows, macOS, Linux) and mobile devices (Android, +iOS). It is written in Python and Cython, and can use a range of windowing +backends. + +Kivy is free and open source software distributed under the MIT license. + +FLTK +---- + +Python bindings for `the FLTK toolkit `_, a simple yet +powerful and mature cross-platform windowing system, are available from `the +PyFLTK project `_. + +OpenGL +------ + +For OpenGL bindings, see `PyOpenGL `_. + + +What platform-specific GUI toolkits exist for Python? +======================================================== + +By installing the `PyObjc Objective-C bridge +`_, Python programs can use Mac OS X's +Cocoa libraries. + +:ref:`Pythonwin ` by Mark Hammond includes an interface to the +Microsoft Foundation Classes and a Python programming environment +that's written mostly in Python using the MFC classes. + + +Tkinter questions +================= + +How do I freeze Tkinter applications? +------------------------------------- + +Freeze is a tool to create stand-alone applications. When freezing Tkinter +applications, the applications will not be truly stand-alone, as the application +will still need the Tcl and Tk libraries. + +One solution is to ship the application with the Tcl and Tk libraries, and point +to them at run-time using the :envvar:`TCL_LIBRARY` and :envvar:`TK_LIBRARY` +environment variables. + +To get truly stand-alone applications, the Tcl scripts that form the library +have to be integrated into the application as well. One tool supporting that is +SAM (stand-alone modules), which is part of the Tix distribution +(http://tix.sourceforge.net/). + +Build Tix with SAM enabled, perform the appropriate call to +:c:func:`Tclsam_init`, etc. inside Python's +:file:`Modules/tkappinit.c`, and link with libtclsam and libtksam (you +might include the Tix libraries as well). + + +Can I have Tk events handled while waiting for I/O? +--------------------------------------------------- + +On platforms other than Windows, yes, and you don't even +need threads! But you'll have to restructure your I/O +code a bit. Tk has the equivalent of Xt's :c:func:`XtAddInput()` call, which allows you +to register a callback function which will be called from the Tk mainloop when +I/O is possible on a file descriptor. See :ref:`tkinter-file-handlers`. + + +I can't get key bindings to work in Tkinter: why? +------------------------------------------------- + +An often-heard complaint is that event handlers bound to events with the +:meth:`bind` method don't get handled even when the appropriate key is pressed. + +The most common cause is that the widget to which the binding applies doesn't +have "keyboard focus". Check out the Tk documentation for the focus command. +Usually a widget is given the keyboard focus by clicking in it (but not for +labels; see the takefocus option). diff --git a/python-3.7.4-docs-html/_sources/faq/index.rst.txt b/python-3.7.4-docs-html/_sources/faq/index.rst.txt new file mode 100644 index 0000000..46ed3db --- /dev/null +++ b/python-3.7.4-docs-html/_sources/faq/index.rst.txt @@ -0,0 +1,17 @@ +.. _faq-index: + +################################### + Python Frequently Asked Questions +################################### + +.. toctree:: + :maxdepth: 1 + + general.rst + programming.rst + design.rst + library.rst + extending.rst + windows.rst + gui.rst + installed.rst diff --git a/python-3.7.4-docs-html/_sources/faq/installed.rst.txt b/python-3.7.4-docs-html/_sources/faq/installed.rst.txt new file mode 100644 index 0000000..4229653 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/faq/installed.rst.txt @@ -0,0 +1,53 @@ +============================================= +"Why is Python Installed on my Computer?" FAQ +============================================= + +What is Python? +--------------- + +Python is a programming language. It's used for many different applications. +It's used in some high schools and colleges as an introductory programming +language because Python is easy to learn, but it's also used by professional +software developers at places such as Google, NASA, and Lucasfilm Ltd. + +If you wish to learn more about Python, start with the `Beginner's Guide to +Python `_. + + +Why is Python installed on my machine? +-------------------------------------- + +If you find Python installed on your system but don't remember installing it, +there are several possible ways it could have gotten there. + +* Perhaps another user on the computer wanted to learn programming and installed + it; you'll have to figure out who's been using the machine and might have + installed it. +* A third-party application installed on the machine might have been written in + Python and included a Python installation. There are many such applications, + from GUI programs to network servers and administrative scripts. +* Some Windows machines also have Python installed. At this writing we're aware + of computers from Hewlett-Packard and Compaq that include Python. Apparently + some of HP/Compaq's administrative tools are written in Python. +* Many Unix-compatible operating systems, such as Mac OS X and some Linux + distributions, have Python installed by default; it's included in the base + installation. + + +Can I delete Python? +-------------------- + +That depends on where Python came from. + +If someone installed it deliberately, you can remove it without hurting +anything. On Windows, use the Add/Remove Programs icon in the Control Panel. + +If Python was installed by a third-party application, you can also remove it, +but that application will no longer work. You should use that application's +uninstaller rather than removing Python directly. + +If Python came with your operating system, removing it is not recommended. If +you remove it, whatever tools were written in Python will no longer run, and +some of them might be important to you. Reinstalling the whole system would +then be required to fix things again. + diff --git a/python-3.7.4-docs-html/_sources/faq/library.rst.txt b/python-3.7.4-docs-html/_sources/faq/library.rst.txt new file mode 100644 index 0000000..ab92a87 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/faq/library.rst.txt @@ -0,0 +1,839 @@ +:tocdepth: 2 + +========================= +Library and Extension FAQ +========================= + +.. only:: html + + .. contents:: + +General Library Questions +========================= + +How do I find a module or application to perform task X? +-------------------------------------------------------- + +Check :ref:`the Library Reference ` to see if there's a relevant +standard library module. (Eventually you'll learn what's in the standard +library and will be able to skip this step.) + +For third-party packages, search the `Python Package Index +`_ or try `Google `_ or +another Web search engine. Searching for "Python" plus a keyword or two for +your topic of interest will usually find something helpful. + + +Where is the math.py (socket.py, regex.py, etc.) source file? +------------------------------------------------------------- + +If you can't find a source file for a module it may be a built-in or +dynamically loaded module implemented in C, C++ or other compiled language. +In this case you may not have the source file or it may be something like +:file:`mathmodule.c`, somewhere in a C source directory (not on the Python Path). + +There are (at least) three kinds of modules in Python: + +1) modules written in Python (.py); +2) modules written in C and dynamically loaded (.dll, .pyd, .so, .sl, etc); +3) modules written in C and linked with the interpreter; to get a list of these, + type:: + + import sys + print(sys.builtin_module_names) + + +How do I make a Python script executable on Unix? +------------------------------------------------- + +You need to do two things: the script file's mode must be executable and the +first line must begin with ``#!`` followed by the path of the Python +interpreter. + +The first is done by executing ``chmod +x scriptfile`` or perhaps ``chmod 755 +scriptfile``. + +The second can be done in a number of ways. The most straightforward way is to +write :: + + #!/usr/local/bin/python + +as the very first line of your file, using the pathname for where the Python +interpreter is installed on your platform. + +If you would like the script to be independent of where the Python interpreter +lives, you can use the :program:`env` program. Almost all Unix variants support +the following, assuming the Python interpreter is in a directory on the user's +:envvar:`PATH`:: + + #!/usr/bin/env python + +*Don't* do this for CGI scripts. The :envvar:`PATH` variable for CGI scripts is +often very minimal, so you need to use the actual absolute pathname of the +interpreter. + +Occasionally, a user's environment is so full that the :program:`/usr/bin/env` +program fails; or there's no env program at all. In that case, you can try the +following hack (due to Alex Rezinsky): + +.. code-block:: sh + + #! /bin/sh + """:" + exec python $0 ${1+"$@"} + """ + +The minor disadvantage is that this defines the script's __doc__ string. +However, you can fix that by adding :: + + __doc__ = """...Whatever...""" + + + +Is there a curses/termcap package for Python? +--------------------------------------------- + +.. XXX curses *is* built by default, isn't it? + +For Unix variants: The standard Python source distribution comes with a curses +module in the :source:`Modules` subdirectory, though it's not compiled by default. +(Note that this is not available in the Windows distribution -- there is no +curses module for Windows.) + +The :mod:`curses` module supports basic curses features as well as many additional +functions from ncurses and SYSV curses such as colour, alternative character set +support, pads, and mouse support. This means the module isn't compatible with +operating systems that only have BSD curses, but there don't seem to be any +currently maintained OSes that fall into this category. + +For Windows: use `the consolelib module +`_. + + +Is there an equivalent to C's onexit() in Python? +------------------------------------------------- + +The :mod:`atexit` module provides a register function that is similar to C's +:c:func:`onexit`. + + +Why don't my signal handlers work? +---------------------------------- + +The most common problem is that the signal handler is declared with the wrong +argument list. It is called as :: + + handler(signum, frame) + +so it should be declared with two arguments:: + + def handler(signum, frame): + ... + + +Common tasks +============ + +How do I test a Python program or component? +-------------------------------------------- + +Python comes with two testing frameworks. The :mod:`doctest` module finds +examples in the docstrings for a module and runs them, comparing the output with +the expected output given in the docstring. + +The :mod:`unittest` module is a fancier testing framework modelled on Java and +Smalltalk testing frameworks. + +To make testing easier, you should use good modular design in your program. +Your program should have almost all functionality +encapsulated in either functions or class methods -- and this sometimes has the +surprising and delightful effect of making the program run faster (because local +variable accesses are faster than global accesses). Furthermore the program +should avoid depending on mutating global variables, since this makes testing +much more difficult to do. + +The "global main logic" of your program may be as simple as :: + + if __name__ == "__main__": + main_logic() + +at the bottom of the main module of your program. + +Once your program is organized as a tractable collection of functions and class +behaviours you should write test functions that exercise the behaviours. A test +suite that automates a sequence of tests can be associated with each module. +This sounds like a lot of work, but since Python is so terse and flexible it's +surprisingly easy. You can make coding much more pleasant and fun by writing +your test functions in parallel with the "production code", since this makes it +easy to find bugs and even design flaws earlier. + +"Support modules" that are not intended to be the main module of a program may +include a self-test of the module. :: + + if __name__ == "__main__": + self_test() + +Even programs that interact with complex external interfaces may be tested when +the external interfaces are unavailable by using "fake" interfaces implemented +in Python. + + +How do I create documentation from doc strings? +----------------------------------------------- + +The :mod:`pydoc` module can create HTML from the doc strings in your Python +source code. An alternative for creating API documentation purely from +docstrings is `epydoc `_. `Sphinx +`_ can also include docstring content. + + +How do I get a single keypress at a time? +----------------------------------------- + +For Unix variants there are several solutions. It's straightforward to do this +using curses, but curses is a fairly large module to learn. + +.. XXX this doesn't work out of the box, some IO expert needs to check why + + Here's a solution without curses:: + + import termios, fcntl, sys, os + fd = sys.stdin.fileno() + + oldterm = termios.tcgetattr(fd) + newattr = termios.tcgetattr(fd) + newattr[3] = newattr[3] & ~termios.ICANON & ~termios.ECHO + termios.tcsetattr(fd, termios.TCSANOW, newattr) + + oldflags = fcntl.fcntl(fd, fcntl.F_GETFL) + fcntl.fcntl(fd, fcntl.F_SETFL, oldflags | os.O_NONBLOCK) + + try: + while True: + try: + c = sys.stdin.read(1) + print("Got character", repr(c)) + except OSError: + pass + finally: + termios.tcsetattr(fd, termios.TCSAFLUSH, oldterm) + fcntl.fcntl(fd, fcntl.F_SETFL, oldflags) + + You need the :mod:`termios` and the :mod:`fcntl` module for any of this to + work, and I've only tried it on Linux, though it should work elsewhere. In + this code, characters are read and printed one at a time. + + :func:`termios.tcsetattr` turns off stdin's echoing and disables canonical + mode. :func:`fcntl.fnctl` is used to obtain stdin's file descriptor flags + and modify them for non-blocking mode. Since reading stdin when it is empty + results in an :exc:`OSError`, this error is caught and ignored. + + .. versionchanged:: 3.3 + *sys.stdin.read* used to raise :exc:`IOError`. Starting from Python 3.3 + :exc:`IOError` is alias for :exc:`OSError`. + + +Threads +======= + +How do I program using threads? +------------------------------- + +Be sure to use the :mod:`threading` module and not the :mod:`_thread` module. +The :mod:`threading` module builds convenient abstractions on top of the +low-level primitives provided by the :mod:`_thread` module. + +Aahz has a set of slides from his threading tutorial that are helpful; see +http://www.pythoncraft.com/OSCON2001/. + + +None of my threads seem to run: why? +------------------------------------ + +As soon as the main thread exits, all threads are killed. Your main thread is +running too quickly, giving the threads no time to do any work. + +A simple fix is to add a sleep to the end of the program that's long enough for +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(10): + T = threading.Thread(target=thread_task, args=(str(i), i)) + T.start() + + time.sleep(10) # <---------------------------! + +But now (on many platforms) the threads don't run in parallel, but appear to run +sequentially, one at a time! The reason is that the OS thread scheduler doesn't +start a new thread until the previous thread is blocked. + +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(10): + T = threading.Thread(target=thread_task, args=(str(i), i)) + T.start() + + time.sleep(10) + +Instead of trying to guess a good delay value for :func:`time.sleep`, +it's better to use some kind of semaphore mechanism. One idea is to use the +:mod:`queue` module to create a queue object, let each thread append a token to +the queue when it finishes, and let the main thread read as many tokens from the +queue as there are threads. + + +How do I parcel out work among a bunch of worker threads? +--------------------------------------------------------- + +The easiest way is to use the new :mod:`concurrent.futures` module, +especially the :mod:`~concurrent.futures.ThreadPoolExecutor` class. + +Or, if you want fine control over the dispatching algorithm, you can write +your own logic manually. Use the :mod:`queue` module to create a queue +containing a list of jobs. The :class:`~queue.Queue` class maintains a +list of objects and has a ``.put(obj)`` method that adds items to the queue and +a ``.get()`` method to return them. The class will take care of the locking +necessary to ensure that each job is handed out exactly once. + +Here's a trivial example:: + + import threading, queue, time + + # The worker thread gets jobs off the queue. When the queue is empty, it + # assumes there will be no more work and exits. + # (Realistically workers will run until terminated.) + def worker(): + print('Running worker') + time.sleep(0.1) + while True: + try: + arg = q.get(block=False) + except queue.Empty: + print('Worker', threading.currentThread(), end=' ') + print('queue empty') + break + else: + print('Worker', threading.currentThread(), end=' ') + print('running with argument', arg) + time.sleep(0.5) + + # Create queue + q = queue.Queue() + + # Start a pool of 5 workers + for i in range(5): + t = threading.Thread(target=worker, name='worker %i' % (i+1)) + t.start() + + # Begin adding work to the queue + for i in range(50): + q.put(i) + + # Give threads time to run + print('Main thread sleeping') + time.sleep(5) + +When run, this will produce the following output: + +.. code-block:: none + + Running worker + Running worker + Running worker + Running worker + Running worker + Main thread sleeping + Worker running with argument 0 + Worker running with argument 1 + Worker running with argument 2 + Worker running with argument 3 + Worker running with argument 4 + Worker running with argument 5 + ... + +Consult the module's documentation for more details; the :class:`~queue.Queue` +class provides a featureful interface. + + +What kinds of global value mutation are thread-safe? +---------------------------------------------------- + +A :term:`global interpreter lock` (GIL) is used internally to ensure that only one +thread runs in the Python VM at a time. In general, Python offers to switch +among threads only between bytecode instructions; how frequently it switches can +be set via :func:`sys.setswitchinterval`. Each bytecode instruction and +therefore all the C implementation code reached from each instruction is +therefore atomic from the point of view of a Python program. + +In theory, this means an exact accounting requires an exact understanding of the +PVM bytecode implementation. In practice, it means that operations on shared +variables of built-in data types (ints, lists, dicts, etc) that "look atomic" +really are. + +For example, the following operations are all atomic (L, L1, L2 are lists, D, +D1, D2 are dicts, x, y are objects, i, j are ints):: + + L.append(x) + L1.extend(L2) + x = L[i] + x = L.pop() + L1[i:j] = L2 + L.sort() + x = y + x.field = y + D[x] = y + D1.update(D2) + D.keys() + +These aren't:: + + i = i+1 + L.append(L[-1]) + L[i] = L[j] + D[x] = D[x] + 1 + +Operations that replace other objects may invoke those other objects' +:meth:`__del__` method when their reference count reaches zero, and that can +affect things. This is especially true for the mass updates to dictionaries and +lists. When in doubt, use a mutex! + + +Can't we get rid of the Global Interpreter Lock? +------------------------------------------------ + +.. XXX link to dbeazley's talk about GIL? + +The :term:`global interpreter lock` (GIL) is often seen as a hindrance to Python's +deployment on high-end multiprocessor server machines, because a multi-threaded +Python program effectively only uses one CPU, due to the insistence that +(almost) all Python code can only run while the GIL is held. + +Back in the days of Python 1.5, Greg Stein actually implemented a comprehensive +patch set (the "free threading" patches) that removed the GIL and replaced it +with fine-grained locking. Adam Olsen recently did a similar experiment +in his `python-safethread `_ +project. Unfortunately, both experiments exhibited a sharp drop in single-thread +performance (at least 30% slower), due to the amount of fine-grained locking +necessary to compensate for the removal of the GIL. + +This doesn't mean that you can't make good use of Python on multi-CPU machines! +You just have to be creative with dividing the work up between multiple +*processes* rather than multiple *threads*. The +:class:`~concurrent.futures.ProcessPoolExecutor` class in the new +:mod:`concurrent.futures` module provides an easy way of doing so; the +:mod:`multiprocessing` module provides a lower-level API in case you want +more control over dispatching of tasks. + +Judicious use of C extensions will also help; if you use a C extension to +perform a time-consuming task, the extension can release the GIL while the +thread of execution is in the C code and allow other threads to get some work +done. Some standard library modules such as :mod:`zlib` and :mod:`hashlib` +already do this. + +It has been suggested that the GIL should be a per-interpreter-state lock rather +than truly global; interpreters then wouldn't be able to share objects. +Unfortunately, this isn't likely to happen either. It would be a tremendous +amount of work, because many object implementations currently have global state. +For example, small integers and short strings are cached; these caches would +have to be moved to the interpreter state. Other object types have their own +free list; these free lists would have to be moved to the interpreter state. +And so on. + +And I doubt that it can even be done in finite time, because the same problem +exists for 3rd party extensions. It is likely that 3rd party extensions are +being written at a faster rate than you can convert them to store all their +global state in the interpreter state. + +And finally, once you have multiple interpreters not sharing any state, what +have you gained over running each interpreter in a separate process? + + +Input and Output +================ + +How do I delete a file? (And other file questions...) +----------------------------------------------------- + +Use ``os.remove(filename)`` or ``os.unlink(filename)``; for documentation, see +the :mod:`os` module. The two functions are identical; :func:`~os.unlink` is simply +the name of the Unix system call for this function. + +To remove a directory, use :func:`os.rmdir`; use :func:`os.mkdir` to create one. +``os.makedirs(path)`` will create any intermediate directories in ``path`` that +don't exist. ``os.removedirs(path)`` will remove intermediate directories as +long as they're empty; if you want to delete an entire directory tree and its +contents, use :func:`shutil.rmtree`. + +To rename a file, use ``os.rename(old_path, new_path)``. + +To truncate a file, open it using ``f = open(filename, "rb+")``, and use +``f.truncate(offset)``; offset defaults to the current seek position. There's +also ``os.ftruncate(fd, offset)`` for files opened with :func:`os.open`, where +*fd* is the file descriptor (a small integer). + +The :mod:`shutil` module also contains a number of functions to work on files +including :func:`~shutil.copyfile`, :func:`~shutil.copytree`, and +:func:`~shutil.rmtree`. + + +How do I copy a file? +--------------------- + +The :mod:`shutil` module contains a :func:`~shutil.copyfile` function. Note +that on MacOS 9 it doesn't copy the resource fork and Finder info. + + +How do I read (or write) binary data? +------------------------------------- + +To read or write complex binary data formats, it's best to use the :mod:`struct` +module. It allows you to take a string containing binary data (usually numbers) +and convert it to Python objects; and vice versa. + +For example, the following code reads two 2-byte integers and one 4-byte integer +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) + +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 +string. + +For data that is more regular (e.g. a homogeneous list of ints or floats), +you can also use the :mod:`array` module. + +.. note:: + + To read and write binary data, it is mandatory to open the file in + binary mode (here, passing ``"rb"`` to :func:`open`). If you use + ``"r"`` instead (the default), the file will be open in text mode + and ``f.read()`` will return :class:`str` objects rather than + :class:`bytes` objects. + + +I can't seem to use os.read() on a pipe created with os.popen(); why? +--------------------------------------------------------------------- + +:func:`os.read` is a low-level function which takes a file descriptor, a small +integer representing the opened file. :func:`os.popen` creates a high-level +file object, the same type returned by the built-in :func:`open` function. +Thus, to read *n* bytes from a pipe *p* created with :func:`os.popen`, you need to +use ``p.read(n)``. + + +.. XXX update to use subprocess. See the :ref:`subprocess-replacements` section. + + How do I run a subprocess with pipes connected to both input and output? + ------------------------------------------------------------------------ + + Use the :mod:`popen2` module. For example:: + + import popen2 + fromchild, tochild = popen2.popen2("command") + tochild.write("input\n") + tochild.flush() + output = fromchild.readline() + + Warning: in general it is unwise to do this because you can easily cause a + deadlock where your process is blocked waiting for output from the child + while the child is blocked waiting for input from you. This can be caused + by the parent expecting the child to output more text than it does or + by data being stuck in stdio buffers due to lack of flushing. + The Python parent can of course explicitly flush the data it sends to the + child before it reads any output, but if the child is a naive C program it + may have been written to never explicitly flush its output, even if it is + interactive, since flushing is normally automatic. + + Note that a deadlock is also possible if you use :func:`popen3` to read + stdout and stderr. If one of the two is too large for the internal buffer + (increasing the buffer size does not help) and you ``read()`` the other one + first, there is a deadlock, too. + + Note on a bug in popen2: unless your program calls ``wait()`` or + ``waitpid()``, finished child processes are never removed, and eventually + calls to popen2 will fail because of a limit on the number of child + processes. Calling :func:`os.waitpid` with the :data:`os.WNOHANG` option can + prevent this; a good place to insert such a call would be before calling + ``popen2`` again. + + In many cases, all you really need is to run some data through a command and + get the result back. Unless the amount of data is very large, the easiest + way to do this is to write it to a temporary file and run the command with + that temporary file as input. The standard module :mod:`tempfile` exports a + :func:`~tempfile.mktemp` function to generate unique temporary file names. :: + + import tempfile + import os + + class Popen3: + """ + This is a deadlock-safe version of popen that returns + an object with errorlevel, out (a string) and err (a string). + (capturestderr may not work under windows.) + Example: print(Popen3('grep spam','\n\nhere spam\n\n').out) + """ + def __init__(self,command,input=None,capturestderr=None): + outfile=tempfile.mktemp() + command="( %s ) > %s" % (command,outfile) + if input: + infile=tempfile.mktemp() + open(infile,"w").write(input) + command=command+" <"+infile + if capturestderr: + errfile=tempfile.mktemp() + command=command+" 2>"+errfile + self.errorlevel=os.system(command) >> 8 + self.out=open(outfile,"r").read() + os.remove(outfile) + if input: + os.remove(infile) + if capturestderr: + self.err=open(errfile,"r").read() + os.remove(errfile) + + Note that many interactive programs (e.g. vi) don't work well with pipes + substituted for standard input and output. You will have to use pseudo ttys + ("ptys") instead of pipes. Or you can use a Python interface to Don Libes' + "expect" library. A Python extension that interfaces to expect is called + "expy" and available from http://expectpy.sourceforge.net. A pure Python + solution that works like expect is `pexpect + `_. + + +How do I access the serial (RS232) port? +---------------------------------------- + +For Win32, POSIX (Linux, BSD, etc.), Jython: + + http://pyserial.sourceforge.net + +For Unix, see a Usenet post by Mitch Chapman: + + https://groups.google.com/groups?selm=34A04430.CF9@ohioee.com + + +Why doesn't closing sys.stdout (stdin, stderr) really close it? +--------------------------------------------------------------- + +Python :term:`file objects ` are a high-level layer of +abstraction on low-level C file descriptors. + +For most file objects you create in Python via the built-in :func:`open` +function, ``f.close()`` marks the Python file object as being closed from +Python's point of view, and also arranges to close the underlying C file +descriptor. This also happens automatically in ``f``'s destructor, when +``f`` becomes garbage. + +But stdin, stdout and stderr are treated specially by Python, because of the +special status also given to them by C. Running ``sys.stdout.close()`` marks +the Python-level file object as being closed, but does *not* close the +associated C file descriptor. + +To close the underlying C file descriptor for one of these three, you should +first be sure that's what you really want to do (e.g., you may confuse +extension modules trying to do I/O). If it is, use :func:`os.close`:: + + os.close(stdin.fileno()) + os.close(stdout.fileno()) + os.close(stderr.fileno()) + +Or you can use the numeric constants 0, 1 and 2, respectively. + + +Network/Internet Programming +============================ + +What WWW tools are there for Python? +------------------------------------ + +See the chapters titled :ref:`internet` and :ref:`netdata` in the Library +Reference Manual. Python has many modules that will help you build server-side +and client-side web systems. + +.. XXX check if wiki page is still up to date + +A summary of available frameworks is maintained by Paul Boddie at +https://wiki.python.org/moin/WebProgramming\ . + +Cameron Laird maintains a useful set of pages about Python web technologies at +http://phaseit.net/claird/comp.lang.python/web_python. + + +How can I mimic CGI form submission (METHOD=POST)? +-------------------------------------------------- + +I would like to retrieve web pages that are the result of POSTing a form. Is +there existing code that would let me do this easily? + +Yes. Here's a simple example that uses urllib.request:: + + #!/usr/local/bin/python + + import urllib.request + + # build the query string + qs = "First=Josephine&MI=Q&Last=Public" + + # 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: + msg, hdrs = req.read(), req.info() + +Note that in general for percent-encoded POST operations, query strings must be +quoted using :func:`urllib.parse.urlencode`. For example, to send +``name=Guy Steele, Jr.``:: + + >>> import urllib.parse + >>> urllib.parse.urlencode({'name': 'Guy Steele, Jr.'}) + 'name=Guy+Steele%2C+Jr.' + +.. seealso:: :ref:`urllib-howto` for extensive examples. + + +What module should I use to help with generating HTML? +------------------------------------------------------ + +.. XXX add modern template languages + +You can find a collection of useful links on the `Web Programming wiki page +`_. + + +How do I send mail from a Python script? +---------------------------------------- + +Use the standard library module :mod:`smtplib`. + +Here's a very simple interactive mail sender that uses it. This method will +work on any host that supports an SMTP listener. :: + + import sys, smtplib + + fromaddr = input("From: ") + toaddrs = input("To: ").split(',') + print("Enter message, end with ^D:") + msg = '' + while True: + line = sys.stdin.readline() + if not line: + break + msg += line + + # The actual mail send + server = smtplib.SMTP('localhost') + server.sendmail(fromaddr, toaddrs, msg) + server.quit() + +A Unix-only alternative uses sendmail. The location of the sendmail program +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:: + + 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") + p.write("\n") # blank line separating headers from body + p.write("Some text\n") + p.write("some more text\n") + sts = p.close() + if sts != 0: + print("Sendmail exit status", sts) + + +How do I avoid blocking in the connect() method of a socket? +------------------------------------------------------------ + +The :mod:`select` module is commonly used to help with asynchronous I/O on +sockets. + +To prevent the TCP connect from blocking, you can set the socket to non-blocking +mode. Then when you do the ``connect()``, you will either connect immediately +(unlikely) or get an exception that contains the error number as ``.errno``. +``errno.EINPROGRESS`` indicates that the connection is in progress, but hasn't +finished yet. Different OSes will return different values, so you're going to +have to check what's returned on your system. + +You can use the ``connect_ex()`` method to avoid creating an exception. It will +just return the errno value. To poll, you can call ``connect_ex()`` again later +-- ``0`` or ``errno.EISCONN`` indicate that you're connected -- or you can pass this +socket to select to check if it's writable. + +.. note:: + The :mod:`asyncore` module presents a framework-like approach to the problem + of writing non-blocking networking code. + The third-party `Twisted `_ library is + a popular and feature-rich alternative. + + +Databases +========= + +Are there any interfaces to database packages in Python? +-------------------------------------------------------- + +Yes. + +Interfaces to disk-based hashes such as :mod:`DBM ` and :mod:`GDBM +` are also included with standard Python. There is also the +:mod:`sqlite3` module, which provides a lightweight disk-based relational +database. + +Support for most relational databases is available. See the +`DatabaseProgramming wiki page +`_ for details. + + +How do you implement persistent objects in Python? +-------------------------------------------------- + +The :mod:`pickle` library module solves this in a very general way (though you +still can't store things like open files, sockets or windows), and the +:mod:`shelve` library module uses pickle and (g)dbm to create persistent +mappings containing arbitrary Python objects. + + +Mathematics and Numerics +======================== + +How do I generate random numbers in Python? +------------------------------------------- + +The standard module :mod:`random` implements a random number generator. Usage +is simple:: + + import random + random.random() + +This returns a random floating point number in the range [0, 1). + +There are also many other specialized generators in this module, such as: + +* ``randrange(a, b)`` chooses an integer in the range [a, b). +* ``uniform(a, b)`` chooses a floating point number in the range [a, b). +* ``normalvariate(mean, sdev)`` samples the normal (Gaussian) distribution. + +Some higher-level functions operate on sequences directly, such as: + +* ``choice(S)`` chooses random element from a given sequence +* ``shuffle(L)`` shuffles a list in-place, i.e. permutes it randomly + +There's also a ``Random`` class you can instantiate to create independent +multiple random number generators. diff --git a/python-3.7.4-docs-html/_sources/faq/programming.rst.txt b/python-3.7.4-docs-html/_sources/faq/programming.rst.txt new file mode 100644 index 0000000..f14e8cc --- /dev/null +++ b/python-3.7.4-docs-html/_sources/faq/programming.rst.txt @@ -0,0 +1,1903 @@ +:tocdepth: 2 + +=============== +Programming FAQ +=============== + +.. only:: html + + .. contents:: + +General Questions +================= + +Is there a source code level debugger with breakpoints, single-stepping, etc.? +------------------------------------------------------------------------------ + +Yes. + +Several debuggers for Python are described below, and the built-in function +:func:`breakpoint` allows you to drop into any of them. + +The pdb module is a simple but adequate console-mode debugger for Python. It is +part of the standard Python library, and is :mod:`documented in the Library +Reference Manual `. You can also write your own debugger by using the code +for pdb as an example. + +The IDLE interactive development environment, which is part of the standard +Python distribution (normally available as Tools/scripts/idle), includes a +graphical debugger. + +PythonWin is a Python IDE that includes a GUI debugger based on pdb. The +Pythonwin debugger colors breakpoints and has quite a few cool features such as +debugging non-Pythonwin programs. Pythonwin is available as part of the `Python +for Windows Extensions `__ project and +as a part of the ActivePython distribution (see +https://www.activestate.com/activepython\ ). + +`Boa Constructor `_ is an IDE and GUI +builder that uses wxWidgets. It offers visual frame creation and manipulation, +an object inspector, many views on the source like object browsers, inheritance +hierarchies, doc string generated html documentation, an advanced debugger, +integrated help, and Zope support. + +`Eric `_ is an IDE built on PyQt +and the Scintilla editing component. + +Pydb is a version of the standard Python debugger pdb, modified for use with DDD +(Data Display Debugger), a popular graphical debugger front end. Pydb can be +found at http://bashdb.sourceforge.net/pydb/ and DDD can be found at +https://www.gnu.org/software/ddd. + +There are a number of commercial Python IDEs that include graphical debuggers. +They include: + +* Wing IDE (https://wingware.com/) +* Komodo IDE (https://komodoide.com/) +* PyCharm (https://www.jetbrains.com/pycharm/) + + +Is there a tool to help find bugs or perform static analysis? +------------------------------------------------------------- + +Yes. + +PyChecker is a static analysis tool that finds bugs in Python source code and +warns about code complexity and style. You can get PyChecker from +http://pychecker.sourceforge.net/. + +`Pylint `_ is another tool that checks +if a module satisfies a coding standard, and also makes it possible to write +plug-ins to add a custom feature. In addition to the bug checking that +PyChecker performs, Pylint offers some additional features such as checking line +length, whether variable names are well-formed according to your coding +standard, whether declared interfaces are fully implemented, and more. +https://docs.pylint.org/ provides a full list of Pylint's features. + +Static type checkers such as `Mypy `_, +`Pyre `_, and +`Pytype `_ can check type hints in Python +source code. + + +How can I create a stand-alone binary from a Python script? +----------------------------------------------------------- + +You don't need the ability to compile Python to C code if all you want is a +stand-alone program that users can download and run without having to install +the Python distribution first. There are a number of tools that determine the +set of modules required by a program and bind these modules together with a +Python binary to produce a single executable. + +One is to use the freeze tool, which is included in the Python source tree as +``Tools/freeze``. It converts Python byte code to C arrays; a C compiler you can +embed all your modules into a new program, which is then linked with the +standard Python modules. + +It works by scanning your source recursively for import statements (in both +forms) and looking for the modules in the standard Python path as well as in the +source directory (for built-in modules). It then turns the bytecode for modules +written in Python into C code (array initializers that can be turned into code +objects using the marshal module) and creates a custom-made config file that +only contains those built-in modules which are actually used in the program. It +then compiles the generated C code and links it with the rest of the Python +interpreter to form a self-contained binary which acts exactly like your script. + +Obviously, freeze requires a C compiler. There are several other utilities +which don't. One is Thomas Heller's py2exe (Windows only) at + + http://www.py2exe.org/ + +Another tool is Anthony Tuininga's `cx_Freeze `_. + + +Are there coding standards or a style guide for Python programs? +---------------------------------------------------------------- + +Yes. The coding style required for standard library modules is documented as +:pep:`8`. + + +Core Language +============= + +Why am I getting an UnboundLocalError when the variable has a value? +-------------------------------------------------------------------- + +It can be a surprise to get the UnboundLocalError in previously working +code when it is modified by adding an assignment statement somewhere in +the body of a function. + +This code: + + >>> x = 10 + >>> def bar(): + ... print(x) + >>> bar() + 10 + +works, but this code: + + >>> x = 10 + >>> def foo(): + ... print(x) + ... x += 1 + +results in an UnboundLocalError: + + >>> foo() + Traceback (most recent call last): + ... + UnboundLocalError: local variable 'x' referenced before assignment + +This is because when you make an assignment to a variable in a scope, that +variable becomes local to that scope and shadows any similarly named variable +in the outer scope. Since the last statement in foo assigns a new value to +``x``, the compiler recognizes it as a local variable. Consequently when the +earlier ``print(x)`` attempts to print the uninitialized local variable and +an error results. + +In the example above you can access the outer scope variable by declaring it +global: + + >>> x = 10 + >>> def foobar(): + ... global x + ... print(x) + ... x += 1 + >>> foobar() + 10 + +This explicit declaration is required in order to remind you that (unlike the +superficially analogous situation with class and instance variables) you are +actually modifying the value of the variable in the outer scope: + + >>> print(x) + 11 + +You can do a similar thing in a nested scope using the :keyword:`nonlocal` +keyword: + + >>> def foo(): + ... x = 10 + ... def bar(): + ... nonlocal x + ... print(x) + ... x += 1 + ... bar() + ... print(x) + >>> foo() + 10 + 11 + + +What are the rules for local and global variables in Python? +------------------------------------------------------------ + +In Python, variables that are only referenced inside a function are implicitly +global. If a variable is assigned a value anywhere within the function's body, +it's assumed to be a local unless explicitly declared as global. + +Though a bit surprising at first, a moment's consideration explains this. On +one hand, requiring :keyword:`global` for assigned variables provides a bar +against unintended side-effects. On the other hand, if ``global`` was required +for all global references, you'd be using ``global`` all the time. You'd have +to declare as global every reference to a built-in function or to a component of +an imported module. This clutter would defeat the usefulness of the ``global`` +declaration for identifying side-effects. + + +Why do lambdas defined in a loop with different values all return the same result? +---------------------------------------------------------------------------------- + +Assume you use a for loop to define a few different lambdas (or even plain +functions), e.g.:: + + >>> squares = [] + >>> for x in range(5): + ... 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``, +``4``, ``9``, and ``16``. However, when you actually try you will see that +they all return ``16``:: + + >>> squares[2]() + 16 + >>> squares[4]() + 16 + +This happens because ``x`` is not local to the lambdas, but is defined in +the outer scope, and it is accessed when the lambda is called --- not when it +is defined. At the end of the loop, the value of ``x`` is ``4``, so all the +functions now return ``4**2``, i.e. ``16``. You can also verify this by +changing the value of ``x`` and see how the results of the lambdas change:: + + >>> x = 8 + >>> squares[2]() + 64 + +In order to avoid this, you need to save the values in variables local to the +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) + +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 +that point in the loop. This means that the value of ``n`` will be ``0`` +in the first lambda, ``1`` in the second, ``2`` in the third, and so on. +Therefore each lambda will now return the correct result:: + + >>> squares[2]() + 4 + >>> squares[4]() + 16 + +Note that this behaviour is not peculiar to lambdas, but applies to regular +functions too. + + +How do I share global variables across modules? +------------------------------------------------ + +The canonical way to share information across modules within a single program is +to create a special module (often called config or cfg). Just import the config +module in all modules of your application; the module then becomes available as +a global name. Because there is only one instance of each module, any changes +made to the module object get reflected everywhere. For example: + +config.py:: + + x = 0 # Default value of the 'x' configuration setting + +mod.py:: + + import config + config.x = 1 + +main.py:: + + import config + import mod + print(config.x) + +Note that using a module is also the basis for implementing the Singleton design +pattern, for the same reason. + + +What are the "best practices" for using import in a module? +----------------------------------------------------------- + +In general, don't use ``from modulename import *``. Doing so clutters the +importer's namespace, and makes it much harder for linters to detect undefined +names. + +Import modules at the top of a file. Doing so makes it clear what other modules +your code requires and avoids questions of whether the module name is in scope. +Using one import per line makes it easy to add and delete module imports, but +using multiple imports per line uses less screen space. + +It's good practice if you import modules in the following order: + +1. standard library modules -- e.g. ``sys``, ``os``, ``getopt``, ``re`` +2. third-party library modules (anything installed in Python's site-packages + directory) -- e.g. mx.DateTime, ZODB, PIL.Image, etc. +3. locally-developed modules + +It is sometimes necessary to move imports to a function or class to avoid +problems with circular imports. Gordon McMillan says: + + Circular imports are fine where both modules use the "import " form + of import. They fail when the 2nd module wants to grab a name out of the + first ("from module import name") and the import is at the top level. That's + because names in the 1st are not yet available, because the first module is + busy importing the 2nd. + +In this case, if the second module is only used in one function, then the import +can easily be moved into that function. By the time the import is called, the +first module will have finished initializing, and the second module can do its +import. + +It may also be necessary to move imports out of the top level of code if some of +the modules are platform-specific. In that case, it may not even be possible to +import all of the modules at the top of the file. In this case, importing the +correct modules in the corresponding platform-specific code is a good option. + +Only move imports into a local scope, such as inside a function definition, if +it's necessary to solve a problem such as avoiding a circular import or are +trying to reduce the initialization time of a module. This technique is +especially helpful if many of the imports are unnecessary depending on how the +program executes. You may also want to move imports into a function if the +modules are only ever used in that function. Note that loading a module the +first time may be expensive because of the one time initialization of the +module, but loading a module multiple times is virtually free, costing only a +couple of dictionary lookups. Even if the module name has gone out of scope, +the module is probably available in :data:`sys.modules`. + + +Why are default values shared between objects? +---------------------------------------------- + +This type of bug commonly bites neophyte programmers. Consider this function:: + + def foo(mydict={}): # Danger: shared reference to one dict for all calls + ... compute something ... + mydict[key] = value + return mydict + +The first time you call this function, ``mydict`` contains a single item. The +second time, ``mydict`` contains two items because when ``foo()`` begins +executing, ``mydict`` starts out with an item already in it. + +It is often expected that a function call creates new objects for default +values. This is not what happens. Default values are created exactly once, when +the function is defined. If that object is changed, like the dictionary in this +example, subsequent calls to the function will refer to this changed object. + +By definition, immutable objects such as numbers, strings, tuples, and ``None``, +are safe from change. Changes to mutable objects such as dictionaries, lists, +and class instances can lead to confusion. + +Because of this feature, it is good programming practice to not use mutable +objects as default values. Instead, use ``None`` as the default value and +inside the function, check if the parameter is ``None`` and create a new +list/dictionary/whatever if it is. For example, don't write:: + + def foo(mydict={}): + ... + +but:: + + def foo(mydict=None): + if mydict is None: + mydict = {} # create a new dict for local namespace + +This feature can be useful. When you have a function that's time-consuming to +compute, a common technique is to cache the parameters and the resulting value +of each call to the function, and return the cached value if the same value is +requested again. This is called "memoizing", and can be implemented like this:: + + # Callers can only provide two parameters and optionally pass _cache by keyword + def expensive(arg1, arg2, *, _cache={}): + if (arg1, arg2) in _cache: + return _cache[(arg1, arg2)] + + # Calculate the value + result = ... expensive computation ... + _cache[(arg1, arg2)] = result # Store result in the cache + return result + +You could use a global variable containing a dictionary instead of the default +value; it's a matter of taste. + + +How can I pass optional or keyword parameters from one function to another? +--------------------------------------------------------------------------- + +Collect the arguments using the ``*`` and ``**`` specifiers in the function's +parameter list; this gives you the positional arguments as a tuple and the +keyword arguments as a dictionary. You can then pass these arguments when +calling another function by using ``*`` and ``**``:: + + def f(x, *args, **kwargs): + ... + kwargs['width'] = '14.3c' + ... + g(x, *args, **kwargs) + + +.. index:: + single: argument; difference from parameter + single: parameter; difference from argument + +.. _faq-argument-vs-parameter: + +What is the difference between arguments and parameters? +-------------------------------------------------------- + +:term:`Parameters ` are defined by the names that appear in a +function definition, whereas :term:`arguments ` are the values +actually passed to a function when calling it. Parameters define what types of +arguments a function can accept. For example, given the function definition:: + + def func(foo, bar=None, **kwargs): + pass + +*foo*, *bar* and *kwargs* are parameters of ``func``. However, when calling +``func``, for example:: + + func(42, bar=314, extra=somevar) + +the values ``42``, ``314``, and ``somevar`` are arguments. + + +Why did changing list 'y' also change list 'x'? +------------------------------------------------ + +If you wrote code like:: + + >>> x = [] + >>> y = x + >>> y.append(10) + >>> y + [10] + >>> x + [10] + +you might be wondering why appending an element to ``y`` changed ``x`` too. + +There are two factors that produce this result: + +1) Variables are simply names that refer to objects. Doing ``y = x`` doesn't + create a copy of the list -- it creates a new variable ``y`` that refers to + the same object ``x`` refers to. This means that there is only one object + (the list), and both ``x`` and ``y`` refer to it. +2) Lists are :term:`mutable`, which means that you can change their content. + +After the call to :meth:`~list.append`, the content of the mutable object has +changed from ``[]`` to ``[10]``. Since both the variables refer to the same +object, using either name accesses the modified value ``[10]``. + +If we instead assign an immutable object to ``x``:: + + >>> x = 5 # ints are immutable + >>> y = x + >>> x = x + 1 # 5 can't be mutated, we are creating a new object here + >>> x + 6 + >>> y + 5 + +we can see that in this case ``x`` and ``y`` are not equal anymore. This is +because integers are :term:`immutable`, and when we do ``x = x + 1`` we are not +mutating the int ``5`` by incrementing its value; instead, we are creating a +new object (the int ``6``) and assigning it to ``x`` (that is, changing which +object ``x`` refers to). After this assignment we have two objects (the ints +``6`` and ``5``) and two variables that refer to them (``x`` now refers to +``6`` but ``y`` still refers to ``5``). + +Some operations (for example ``y.append(10)`` and ``y.sort()``) mutate the +object, whereas superficially similar operations (for example ``y = y + [10]`` +and ``sorted(y)``) create a new object. In general in Python (and in all cases +in the standard library) a method that mutates an object will return ``None`` +to help avoid getting the two types of operations confused. So if you +mistakenly write ``y.sort()`` thinking it will give you a sorted copy of ``y``, +you'll instead end up with ``None``, which will likely cause your program to +generate an easily diagnosed error. + +However, there is one class of operations where the same operation sometimes +has different behaviors with different types: the augmented assignment +operators. For example, ``+=`` mutates lists but not tuples or ints (``a_list ++= [1, 2, 3]`` is equivalent to ``a_list.extend([1, 2, 3])`` and mutates +``a_list``, whereas ``some_tuple += (1, 2, 3)`` and ``some_int += 1`` create +new objects). + +In other words: + +* If we have a mutable object (:class:`list`, :class:`dict`, :class:`set`, + etc.), we can use some specific operations to mutate it and all the variables + that refer to it will see the change. +* If we have an immutable object (:class:`str`, :class:`int`, :class:`tuple`, + etc.), all the variables that refer to it will always see the same value, + but operations that transform that value into a new value always return a new + object. + +If you want to know if two variables refer to the same object or not, you can +use the :keyword:`is` operator, or the built-in function :func:`id`. + + +How do I write a function with output parameters (call by reference)? +--------------------------------------------------------------------- + +Remember that arguments are passed by assignment in Python. Since assignment +just creates references to objects, there's no alias between an argument name in +the caller and callee, and so no call-by-reference per se. You can achieve the +desired effect in a number of ways. + +1) By returning a tuple of the results:: + + def func2(a, b): + a = 'new-value' # a and b are local names + b = b + 1 # assigned to new objects + return a, b # return new values + + x, y = 'old-value', 99 + x, y = func2(x, y) + print(x, y) # output: new-value 100 + + This is almost always the clearest solution. + +2) By using global variables. This isn't thread-safe, and is not recommended. + +3) By passing a mutable (changeable in-place) object:: + + def func1(a): + a[0] = 'new-value' # 'a' references a mutable list + a[1] = a[1] + 1 # changes a shared object + + args = ['old-value', 99] + func1(args) + print(args[0], args[1]) # output: new-value 100 + +4) By passing in a dictionary that gets mutated:: + + def func3(args): + args['a'] = 'new-value' # args is a mutable dictionary + args['b'] = args['b'] + 1 # change it in-place + + args = {'a': 'old-value', 'b': 99} + func3(args) + print(args['a'], args['b']) + +5) Or bundle up values in a class instance:: + + class callByRef: + def __init__(self, **args): + for (key, value) in args.items(): + setattr(self, key, value) + + def func4(args): + args.a = 'new-value' # args is a mutable callByRef + args.b = args.b + 1 # change object in-place + + args = callByRef(a='old-value', b=99) + func4(args) + print(args.a, args.b) + + + There's almost never a good reason to get this complicated. + +Your best choice is to return a tuple containing the multiple results. + + +How do you make a higher order function in Python? +-------------------------------------------------- + +You have two choices: you can use nested scopes or you can use callable objects. +For example, suppose you wanted to define ``linear(a,b)`` which returns a +function ``f(x)`` that computes the value ``a*x+b``. Using nested scopes:: + + def linear(a, b): + def result(x): + return a * x + b + return result + +Or using a callable object:: + + class linear: + + def __init__(self, a, b): + self.a, self.b = a, b + + def __call__(self, x): + return self.a * x + self.b + +In both cases, :: + + taxes = linear(0.3, 2) + +gives a callable object where ``taxes(10e6) == 0.3 * 10e6 + 2``. + +The callable object approach has the disadvantage that it is a bit slower and +results in slightly longer code. However, note that a collection of callables +can share their signature via inheritance:: + + class exponential(linear): + # __init__ inherited + def __call__(self, x): + return self.a * (x ** self.b) + +Object can encapsulate state for several methods:: + + class counter: + + value = 0 + + def set(self, x): + self.value = x + + def up(self): + self.value = self.value + 1 + + def down(self): + self.value = self.value - 1 + + count = counter() + inc, dec, reset = count.up, count.down, count.set + +Here ``inc()``, ``dec()`` and ``reset()`` act like functions which share the +same counting variable. + + +How do I copy an object in Python? +---------------------------------- + +In general, try :func:`copy.copy` or :func:`copy.deepcopy` for the general case. +Not all objects can be copied, but most can. + +Some objects can be copied more easily. Dictionaries have a :meth:`~dict.copy` +method:: + + newdict = olddict.copy() + +Sequences can be copied by slicing:: + + new_l = l[:] + + +How can I find the methods or attributes of an object? +------------------------------------------------------ + +For an instance x of a user-defined class, ``dir(x)`` returns an alphabetized +list of the names containing the instance attributes and methods and attributes +defined by its class. + + +How can my code discover the name of an object? +----------------------------------------------- + +Generally speaking, it can't, because objects don't really have names. +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) + <__main__.A object at 0x16D07CC> + >>> print(a) + <__main__.A object at 0x16D07CC> + +Arguably the class has a name: even though it is bound to two names and invoked +through the name B the created instance is still reported as an instance of +class A. However, it is impossible to say whether the instance's name is a or +b, since both names are bound to the same value. + +Generally speaking it should not be necessary for your code to "know the names" +of particular values. Unless you are deliberately writing introspective +programs, this is usually an indication that a change of approach might be +beneficial. + +In comp.lang.python, Fredrik Lundh once gave an excellent analogy in answer to +this question: + + The same way as you get the name of that cat you found on your porch: the cat + (object) itself cannot tell you its name, and it doesn't really care -- so + the only way to find out what it's called is to ask all your neighbours + (namespaces) if it's their cat (object)... + + ....and don't be surprised if you'll find that it's known by many names, or + no name at all! + + +What's up with the comma operator's precedence? +----------------------------------------------- + +Comma is not an operator in Python. Consider this session:: + + >>> "a" in "b", "a" + (False, 'a') + +Since the comma is not an operator, but a separator between expressions the +above is evaluated as if you had entered:: + + ("a" in "b"), "a" + +not:: + + "a" in ("b", "a") + +The same is true of the various assignment operators (``=``, ``+=`` etc). They +are not truly operators but syntactic delimiters in assignment statements. + + +Is there an equivalent of C's "?:" ternary operator? +---------------------------------------------------- + +Yes, there is. The syntax is as follows:: + + [on_true] if [expression] else [on_false] + + x, y = 50, 25 + small = x if x < y else y + +Before this syntax was introduced in Python 2.5, a common idiom was to use +logical operators:: + + [expression] and [on_true] or [on_false] + +However, this idiom is unsafe, as it can give wrong results when *on_true* +has a false boolean value. Therefore, it is always better to use +the ``... if ... else ...`` form. + + +Is it possible to write obfuscated one-liners in Python? +-------------------------------------------------------- + +Yes. Usually this is done by nesting :keyword:`lambda` within +:keyword:`!lambda`. See the following three examples, due to Ulf Bartelt:: + + from functools import reduce + + # Primes < 1000 + print(list(filter(None,map(lambda y:y*reduce(lambda x,y:x*y!=0, + map(lambda x,y=y:y%x,range(2,int(pow(y,0.5)+1))),1),range(2,1000))))) + + # First 10 Fibonacci numbers + print(list(map(lambda x,f=lambda x,f:(f(x-1,f)+f(x-2,f)) if x>1 else 1: + f(x,f), range(10)))) + + # Mandelbrot set + print((lambda Ru,Ro,Iu,Io,IM,Sx,Sy:reduce(lambda x,y:x+y,map(lambda y, + Iu=Iu,Io=Io,Ru=Ru,Ro=Ro,Sy=Sy,L=lambda yc,Iu=Iu,Io=Io,Ru=Ru,Ro=Ro,i=IM, + Sx=Sx,Sy=Sy:reduce(lambda x,y:x+y,map(lambda x,xc=Ru,yc=yc,Ru=Ru,Ro=Ro, + i=i,Sx=Sx,F=lambda xc,yc,x,y,k,f=lambda xc,yc,x,y,k,f:(k<=0)or (x*x+y*y + >=4.0) or 1+f(xc,yc,x*x-y*y+xc,2.0*x*y+yc,k-1,f):f(xc,yc,x,y,k,f):chr( + 64+F(Ru+x*(Ro-Ru)/Sx,yc,0,0,i)),range(Sx))):L(Iu+y*(Io-Iu)/Sy),range(Sy + ))))(-2.1, 0.7, -1.2, 1.2, 30, 80, 24)) + # \___ ___/ \___ ___/ | | |__ lines on screen + # V V | |______ columns on screen + # | | |__________ maximum of "iterations" + # | |_________________ range on y axis + # |____________________________ range on x axis + +Don't try this at home, kids! + + +.. _faq-positional-only-arguments: + +What does the slash(/) in the parameter list of a function mean? +---------------------------------------------------------------- + +A slash in the argument list of a function denotes that the parameters prior to +it are positional-only. Positional-only parameters are the ones without an +externally-usable name. Upon calling a function that accepts positional-only +parameters, arguments are mapped to parameters based solely on their position. +For example, :func:`pow` is a function that accepts positional-only parameters. +Its documentation looks like this:: + + >>> help(pow) + Help on built-in function pow in module builtins: + + pow(x, y, z=None, /) + Equivalent to x**y (with two arguments) or x**y % z (with three arguments) + + Some types, such as ints, are able to use a more efficient algorithm when + invoked using the three argument form. + +The slash at the end of the parameter list means that all three parameters are +positional-only. Thus, calling :func:`pow` with keyword aguments would lead to +an error:: + + >>> pow(x=3, y=4) + Traceback (most recent call last): + File "", line 1, in + TypeError: pow() takes no keyword arguments + +Note that as of this writing this is only documentational and no valid syntax +in Python, although there is :pep:`570`, which proposes a syntax for +position-only parameters in Python. + + +Numbers and strings +=================== + +How do I specify hexadecimal and octal integers? +------------------------------------------------ + +To specify an octal digit, precede the octal value with a zero, and then a lower +or uppercase "o". For example, to set the variable "a" to the octal value "10" +(8 in decimal), type:: + + >>> a = 0o10 + >>> a + 8 + +Hexadecimal is just as easy. Simply precede the hexadecimal number with a zero, +and then a lower or uppercase "x". Hexadecimal digits can be specified in lower +or uppercase. For example, in the Python interpreter:: + + >>> a = 0xa5 + >>> a + 165 + >>> b = 0XB2 + >>> b + 178 + + +Why does -22 // 10 return -3? +----------------------------- + +It's primarily driven by the desire that ``i % j`` have the same sign as ``j``. +If you want that, and also want:: + + i == (i // j) * j + (i % j) + +then integer division has to return the floor. C also requires that identity to +hold, and then compilers that truncate ``i // j`` need to make ``i % j`` have +the same sign as ``i``. + +There are few real use cases for ``i % j`` when ``j`` is negative. When ``j`` +is positive, there are many, and in virtually all of them it's more useful for +``i % j`` to be ``>= 0``. If the clock says 10 now, what did it say 200 hours +ago? ``-190 % 12 == 2`` is useful; ``-190 % 12 == -10`` is a bug waiting to +bite. + + +How do I convert a string to a number? +-------------------------------------- + +For integers, use the built-in :func:`int` type constructor, e.g. ``int('144') +== 144``. Similarly, :func:`float` converts to floating-point, +e.g. ``float('144') == 144.0``. + +By default, these interpret the number as decimal, so that ``int('0144') == +144`` and ``int('0x144')`` raises :exc:`ValueError`. ``int(string, base)`` takes +the base to convert from as a second optional argument, so ``int('0x144', 16) == +324``. If the base is specified as 0, the number is interpreted using Python's +rules: a leading '0o' indicates octal, and '0x' indicates a hex number. + +Do not use the built-in function :func:`eval` if all you need is to convert +strings to numbers. :func:`eval` will be significantly slower and it presents a +security risk: someone could pass you a Python expression that might have +unwanted side effects. For example, someone could pass +``__import__('os').system("rm -rf $HOME")`` which would erase your home +directory. + +:func:`eval` also has the effect of interpreting numbers as Python expressions, +so that e.g. ``eval('09')`` gives a syntax error because Python does not allow +leading '0' in a decimal number (except '0'). + + +How do I convert a number to a string? +-------------------------------------- + +To convert, e.g., the number 144 to the string '144', use the built-in type +constructor :func:`str`. If you want a hexadecimal or octal representation, use +the built-in functions :func:`hex` or :func:`oct`. For fancy formatting, see +the :ref:`f-strings` and :ref:`formatstrings` sections, +e.g. ``"{:04d}".format(144)`` yields +``'0144'`` and ``"{:.3f}".format(1.0/3.0)`` yields ``'0.333'``. + + +How do I modify a string in place? +---------------------------------- + +You can't, because strings are immutable. In most situations, you should +simply construct a new string from the various parts you want to assemble +it from. However, if you need an object with the ability to modify in-place +unicode data, try using an :class:`io.StringIO` object or the :mod:`array` +module:: + + >>> import io + >>> s = "Hello, world" + >>> sio = io.StringIO(s) + >>> sio.getvalue() + 'Hello, world' + >>> sio.seek(7) + 7 + >>> sio.write("there!") + 6 + >>> sio.getvalue() + 'Hello, there!' + + >>> import array + >>> a = array.array('u', s) + >>> print(a) + array('u', 'Hello, world') + >>> a[0] = 'y' + >>> print(a) + array('u', 'yello, world') + >>> a.tounicode() + 'yello, world' + + +How do I use strings to call functions/methods? +----------------------------------------------- + +There are various techniques. + +* The best is to use a dictionary that maps strings to functions. The primary + advantage of this technique is that the strings do not need to match the names + of the functions. This is also the primary technique used to emulate a case + construct:: + + def a(): + pass + + def b(): + pass + + dispatch = {'go': a, 'stop': b} # Note lack of parens for funcs + + dispatch[get_input()]() # Note trailing parens to call function + +* Use the built-in function :func:`getattr`:: + + import foo + getattr(foo, 'bar')() + + Note that :func:`getattr` works on any object, including classes, class + instances, modules, and so on. + + This is used in several places in the standard library, like this:: + + class Foo: + def do_foo(self): + ... + + def do_bar(self): + ... + + f = getattr(foo_instance, 'do_' + opname) + f() + + +* Use :func:`locals` or :func:`eval` to resolve the function name:: + + def myFunc(): + print("hello") + + fname = "myFunc" + + f = locals()[fname] + f() + + f = eval(fname) + f() + + Note: Using :func:`eval` is slow and dangerous. If you don't have absolute + control over the contents of the string, someone could pass a string that + resulted in an arbitrary function being executed. + +Is there an equivalent to Perl's chomp() for removing trailing newlines from strings? +------------------------------------------------------------------------------------- + +You can use ``S.rstrip("\r\n")`` to remove all occurrences of any line +terminator from the end of the string ``S`` without removing other trailing +whitespace. If the string ``S`` represents more than one line, with several +empty lines at the end, the line terminators for all the blank lines will +be removed:: + + >>> lines = ("line 1 \r\n" + ... "\r\n" + ... "\r\n") + >>> lines.rstrip("\n\r") + 'line 1 ' + +Since this is typically only desired when reading text one line at a time, using +``S.rstrip()`` this way works well. + + +Is there a scanf() or sscanf() equivalent? +------------------------------------------ + +Not as such. + +For simple input parsing, the easiest approach is usually to split the line into +whitespace-delimited words using the :meth:`~str.split` method of string objects +and then convert decimal strings to numeric values using :func:`int` or +:func:`float`. ``split()`` supports an optional "sep" parameter which is useful +if the line uses something other than whitespace as a separator. + +For more complicated input parsing, regular expressions are more powerful +than C's :c:func:`sscanf` and better suited for the task. + + +What does 'UnicodeDecodeError' or 'UnicodeEncodeError' error mean? +------------------------------------------------------------------- + +See the :ref:`unicode-howto`. + + +Performance +=========== + +My program is too slow. How do I speed it up? +--------------------------------------------- + +That's a tough one, in general. First, here are a list of things to +remember before diving further: + +* Performance characteristics vary across Python implementations. This FAQ + focusses on :term:`CPython`. +* Behaviour can vary across operating systems, especially when talking about + I/O or multi-threading. +* You should always find the hot spots in your program *before* attempting to + optimize any code (see the :mod:`profile` module). +* Writing benchmark scripts will allow you to iterate quickly when searching + for improvements (see the :mod:`timeit` module). +* It is highly recommended to have good code coverage (through unit testing + or any other technique) before potentially introducing regressions hidden + in sophisticated optimizations. + +That being said, there are many tricks to speed up Python code. Here are +some general principles which go a long way towards reaching acceptable +performance levels: + +* Making your algorithms faster (or changing to faster ones) can yield + much larger benefits than trying to sprinkle micro-optimization tricks + all over your code. + +* Use the right data structures. Study documentation for the :ref:`bltin-types` + and the :mod:`collections` module. + +* When the standard library provides a primitive for doing something, it is + likely (although not guaranteed) to be faster than any alternative you + may come up with. This is doubly true for primitives written in C, such + as builtins and some extension types. For example, be sure to use + either the :meth:`list.sort` built-in method or the related :func:`sorted` + function to do sorting (and see the :ref:`sortinghowto` for examples + of moderately advanced usage). + +* Abstractions tend to create indirections and force the interpreter to work + more. If the levels of indirection outweigh the amount of useful work + done, your program will be slower. You should avoid excessive abstraction, + especially under the form of tiny functions or methods (which are also often + detrimental to readability). + +If you have reached the limit of what pure Python can allow, there are tools +to take you further away. For example, `Cython `_ can +compile a slightly modified version of Python code into a C extension, and +can be used on many different platforms. Cython can take advantage of +compilation (and optional type annotations) to make your code significantly +faster than when interpreted. If you are confident in your C programming +skills, you can also :ref:`write a C extension module ` +yourself. + +.. seealso:: + The wiki page devoted to `performance tips + `_. + +.. _efficient_string_concatenation: + +What is the most efficient way to concatenate many strings together? +-------------------------------------------------------------------- + +:class:`str` and :class:`bytes` objects are immutable, therefore concatenating +many strings together is inefficient as each concatenation creates a new +object. In the general case, the total runtime cost is quadratic in the +total string length. + +To accumulate many :class:`str` objects, the recommended idiom is to place +them into a list and call :meth:`str.join` at the end:: + + chunks = [] + for s in my_strings: + chunks.append(s) + result = ''.join(chunks) + +(another reasonably efficient idiom is to use :class:`io.StringIO`) + +To accumulate many :class:`bytes` objects, the recommended idiom is to extend +a :class:`bytearray` object using in-place concatenation (the ``+=`` operator):: + + result = bytearray() + for b in my_bytes_objects: + result += b + + +Sequences (Tuples/Lists) +======================== + +How do I convert between tuples and lists? +------------------------------------------ + +The type constructor ``tuple(seq)`` converts any sequence (actually, any +iterable) into a tuple with the same items in the same order. + +For example, ``tuple([1, 2, 3])`` yields ``(1, 2, 3)`` and ``tuple('abc')`` +yields ``('a', 'b', 'c')``. If the argument is a tuple, it does not make a copy +but returns the same object, so it is cheap to call :func:`tuple` when you +aren't sure that an object is already a tuple. + +The type constructor ``list(seq)`` converts any sequence or iterable into a list +with the same items in the same order. For example, ``list((1, 2, 3))`` yields +``[1, 2, 3]`` and ``list('abc')`` yields ``['a', 'b', 'c']``. If the argument +is a list, it makes a copy just like ``seq[:]`` would. + + +What's a negative index? +------------------------ + +Python sequences are indexed with positive numbers and negative numbers. For +positive numbers 0 is the first index 1 is the second index and so forth. For +negative indices -1 is the last index and -2 is the penultimate (next to last) +index and so forth. Think of ``seq[-n]`` as the same as ``seq[len(seq)-n]``. + +Using negative indices can be very convenient. For example ``S[:-1]`` is all of +the string except for its last character, which is useful for removing the +trailing newline from a string. + + +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 ... + +This won't touch your original sequence, but build a new copy with reversed +order to iterate over. + +With Python 2.3, you can use an extended slice syntax:: + + for x in sequence[::-1]: + ... # do something with x ... + + +How do you remove duplicates from a list? +----------------------------------------- + +See the Python Cookbook for a long discussion of many ways to do this: + + https://code.activestate.com/recipes/52560/ + +If you don't mind reordering the list, sort it and then scan from the end of the +list, deleting duplicates as you go:: + + if mylist: + mylist.sort() + last = mylist[-1] + for i in range(len(mylist)-2, -1, -1): + if last == mylist[i]: + del mylist[i] + else: + last = mylist[i] + +If all elements of the list may be used as set keys (i.e. they are all +:term:`hashable`) this is often faster :: + + mylist = list(set(mylist)) + +This converts the list into a set, thereby removing duplicates, and then back +into a list. + + +How do you make an array in Python? +----------------------------------- + +Use a list:: + + ["this", 1, "is", "an", "array"] + +Lists are equivalent to C or Pascal arrays in their time complexity; the primary +difference is that a Python list can contain objects of many different types. + +The ``array`` module also provides methods for creating arrays of fixed types +with compact representations, but they are slower to index than lists. Also +note that the Numeric extensions and others define array-like structures with +various characteristics as well. + +To get Lisp-style linked lists, you can emulate cons cells using tuples:: + + lisp_list = ("like", ("this", ("example", None) ) ) + +If mutability is desired, you could use lists instead of tuples. Here the +analogue of lisp car is ``lisp_list[0]`` and the analogue of cdr is +``lisp_list[1]``. Only do this if you're sure you really need to, because it's +usually a lot slower than using Python lists. + + +.. _faq-multidimensional-list: + +How do I create a multidimensional list? +---------------------------------------- + +You probably tried to make a multidimensional array like this:: + + >>> A = [[None] * 2] * 3 + +This looks correct if you print it: + +.. testsetup:: + + A = [[None] * 2] * 3 + +.. doctest:: + + >>> A + [[None, None], [None, None], [None, None]] + +But when you assign a value, it shows up in multiple places: + +.. testsetup:: + + A = [[None] * 2] * 3 + +.. doctest:: + + >>> A[0][0] = 5 + >>> A + [[5, None], [5, None], [5, None]] + +The reason is that replicating a list with ``*`` doesn't create copies, it only +creates references to the existing objects. The ``*3`` creates a list +containing 3 references to the same list of length two. Changes to one row will +show in all rows, which is almost certainly not what you want. + +The suggested approach is to create a list of the desired length first and then +fill in each element with a newly created list:: + + A = [None] * 3 + for i in range(3): + A[i] = [None] * 2 + +This generates a list containing 3 different lists of length two. You can also +use a list comprehension:: + + w, h = 2, 3 + A = [[None] * w for i in range(h)] + +Or, you can use an extension that provides a matrix datatype; `NumPy +`_ is the best known. + + +How do I apply a method to a sequence of objects? +------------------------------------------------- + +Use a list comprehension:: + + result = [obj.method() for obj in mylist] + +.. _faq-augmented-assignment-tuple-error: + +Why does a_tuple[i] += ['item'] raise an exception when the addition works? +--------------------------------------------------------------------------- + +This is because of a combination of the fact that augmented assignment +operators are *assignment* operators, and the difference between mutable and +immutable objects in Python. + +This discussion applies in general when augmented assignment operators are +applied to elements of a tuple that point to mutable objects, but we'll use +a ``list`` and ``+=`` as our exemplar. + +If you wrote:: + + >>> a_tuple = (1, 2) + >>> a_tuple[0] += 1 + Traceback (most recent call last): + ... + TypeError: 'tuple' object does not support item assignment + +The reason for the exception should be immediately clear: ``1`` is added to the +object ``a_tuple[0]`` points to (``1``), producing the result object, ``2``, +but when we attempt to assign the result of the computation, ``2``, to element +``0`` of the tuple, we get an error because we can't change what an element of +a tuple points to. + +Under the covers, what this augmented assignment statement is doing is +approximately this:: + + >>> result = a_tuple[0] + 1 + >>> a_tuple[0] = result + Traceback (most recent call last): + ... + TypeError: 'tuple' object does not support item assignment + +It is the assignment part of the operation that produces the error, since a +tuple is immutable. + +When you write something like:: + + >>> a_tuple = (['foo'], 'bar') + >>> a_tuple[0] += ['item'] + Traceback (most recent call last): + ... + TypeError: 'tuple' object does not support item assignment + +The exception is a bit more surprising, and even more surprising is the fact +that even though there was an error, the append worked:: + + >>> a_tuple[0] + ['foo', 'item'] + +To see why this happens, you need to know that (a) if an object implements an +``__iadd__`` magic method, it gets called when the ``+=`` augmented assignment +is executed, and its return value is what gets used in the assignment statement; +and (b) for lists, ``__iadd__`` is equivalent to calling ``extend`` on the list +and returning the list. That's why we say that for lists, ``+=`` is a +"shorthand" for ``list.extend``:: + + >>> a_list = [] + >>> a_list += [1] + >>> a_list + [1] + +This is equivalent to:: + + >>> result = a_list.__iadd__([1]) + >>> a_list = result + +The object pointed to by a_list has been mutated, and the pointer to the +mutated object is assigned back to ``a_list``. The end result of the +assignment is a no-op, since it is a pointer to the same object that ``a_list`` +was previously pointing to, but the assignment still happens. + +Thus, in our tuple example what is happening is equivalent to:: + + >>> result = a_tuple[0].__iadd__(['item']) + >>> a_tuple[0] = result + Traceback (most recent call last): + ... + TypeError: 'tuple' object does not support item assignment + +The ``__iadd__`` succeeds, and thus the list is extended, but even though +``result`` points to the same object that ``a_tuple[0]`` already points to, +that final assignment still results in an error, because tuples are immutable. + + +I want to do a complicated sort: can you do a Schwartzian Transform in Python? +------------------------------------------------------------------------------ + +The technique, attributed to Randal Schwartz of the Perl community, sorts the +elements of a list by a metric which maps each element to its "sort value". In +Python, use the ``key`` argument for the :meth:`list.sort` method:: + + Isorted = L[:] + Isorted.sort(key=lambda s: int(s[10:15])) + + +How can I sort one list by values from another list? +---------------------------------------------------- + +Merge them into an iterator of tuples, sort the resulting list, and then pick +out the element you want. :: + + >>> list1 = ["what", "I'm", "sorting", "by"] + >>> list2 = ["something", "else", "to", "sort"] + >>> pairs = zip(list1, list2) + >>> pairs = sorted(pairs) + >>> pairs + [("I'm", 'else'), ('by', 'sort'), ('sorting', 'to'), ('what', 'something')] + >>> result = [x[1] for x in pairs] + >>> result + ['else', 'sort', 'to', 'something'] + + +An alternative for the last step is:: + + >>> result = [] + >>> for p in pairs: result.append(p[1]) + +If you find this more legible, you might prefer to use this instead of the final +list comprehension. However, it is almost twice as slow for long lists. Why? +First, the ``append()`` operation has to reallocate memory, and while it uses +some tricks to avoid doing that each time, it still has to do it occasionally, +and that costs quite a bit. Second, the expression "result.append" requires an +extra attribute lookup, and third, there's a speed reduction from having to make +all those function calls. + + +Objects +======= + +What is a class? +---------------- + +A class is the particular object type created by executing a class statement. +Class objects are used as templates to create instance objects, which embody +both the data (attributes) and code (methods) specific to a datatype. + +A class can be based on one or more other classes, called its base class(es). It +then inherits the attributes and methods of its base classes. This allows an +object model to be successively refined by inheritance. You might have a +generic ``Mailbox`` class that provides basic accessor methods for a mailbox, +and subclasses such as ``MboxMailbox``, ``MaildirMailbox``, ``OutlookMailbox`` +that handle various specific mailbox formats. + + +What is a method? +----------------- + +A method is a function on some object ``x`` that you normally call as +``x.name(arguments...)``. Methods are defined as functions inside the class +definition:: + + class C: + def meth(self, arg): + return arg * 2 + self.attribute + + +What is self? +------------- + +Self is merely a conventional name for the first argument of a method. A method +defined as ``meth(self, a, b, c)`` should be called as ``x.meth(a, b, c)`` for +some instance ``x`` of the class in which the definition occurs; the called +method will think it is called as ``meth(x, a, b, c)``. + +See also :ref:`why-self`. + + +How do I check if an object is an instance of a given class or of a subclass of it? +----------------------------------------------------------------------------------- + +Use the built-in function ``isinstance(obj, cls)``. You can check if an object +is an instance of any of a number of classes by providing a tuple instead of a +single class, e.g. ``isinstance(obj, (class1, class2, ...))``, and can also +check whether an object is one of Python's built-in types, e.g. +``isinstance(obj, str)`` or ``isinstance(obj, (int, float, complex))``. + +Note that most programs do not use :func:`isinstance` on user-defined classes +very often. If you are developing the classes yourself, a more proper +object-oriented style is to define methods on the classes that encapsulate a +particular behaviour, instead of checking the object's class and doing a +different thing based on what class it is. For example, if you have a function +that does something:: + + def search(obj): + if isinstance(obj, Mailbox): + ... # code to search a mailbox + elif isinstance(obj, Document): + ... # code to search a document + elif ... + +A better approach is to define a ``search()`` method on all the classes and just +call it:: + + class Mailbox: + def search(self): + ... # code to search a mailbox + + class Document: + def search(self): + ... # code to search a document + + obj.search() + + +What is delegation? +------------------- + +Delegation is an object oriented technique (also called a design pattern). +Let's say you have an object ``x`` and want to change the behaviour of just one +of its methods. You can create a new class that provides a new implementation +of the method you're interested in changing and delegates all other methods to +the corresponding method of ``x``. + +Python programmers can easily implement delegation. For example, the following +class implements a class that behaves like a file but converts all written data +to uppercase:: + + class UpperOut: + + def __init__(self, outfile): + self._outfile = outfile + + def write(self, s): + self._outfile.write(s.upper()) + + def __getattr__(self, name): + return getattr(self._outfile, name) + +Here the ``UpperOut`` class redefines the ``write()`` method to convert the +argument string to uppercase before calling the underlying +``self.__outfile.write()`` method. All other methods are delegated to the +underlying ``self.__outfile`` object. The delegation is accomplished via the +``__getattr__`` method; consult :ref:`the language reference ` +for more information about controlling attribute access. + +Note that for more general cases delegation can get trickier. When attributes +must be set as well as retrieved, the class must define a :meth:`__setattr__` +method too, and it must do so carefully. The basic implementation of +:meth:`__setattr__` is roughly equivalent to the following:: + + class X: + ... + def __setattr__(self, name, value): + self.__dict__[name] = value + ... + +Most :meth:`__setattr__` implementations must modify ``self.__dict__`` to store +local state for self without causing an infinite recursion. + + +How do I call a method defined in a base class from a derived class that overrides it? +-------------------------------------------------------------------------------------- + +Use the built-in :func:`super` function:: + + class Derived(Base): + def meth(self): + super(Derived, self).meth() + +For version prior to 3.0, you may be using classic classes: For a class +definition such as ``class Derived(Base): ...`` you can call method ``meth()`` +defined in ``Base`` (or one of ``Base``'s base classes) as ``Base.meth(self, +arguments...)``. Here, ``Base.meth`` is an unbound method, so you need to +provide the ``self`` argument. + + +How can I organize my code to make it easier to change the base class? +---------------------------------------------------------------------- + +You could define an alias for the base class, assign the real base class to it +before your class definition, and use the alias throughout your class. Then all +you have to change is the value assigned to the alias. Incidentally, this trick +is also handy if you want to decide dynamically (e.g. depending on availability +of resources) which base class to use. Example:: + + BaseAlias = + + class Derived(BaseAlias): + def meth(self): + BaseAlias.meth(self) + ... + + +How do I create static class data and static class methods? +----------------------------------------------------------- + +Both static data and static methods (in the sense of C++ or Java) are supported +in Python. + +For static data, simply define a class attribute. To assign a new value to the +attribute, you have to explicitly use the class name in the assignment:: + + class C: + count = 0 # number of times C.__init__ called + + def __init__(self): + C.count = C.count + 1 + + def getcount(self): + return C.count # or return self.count + +``c.count`` also refers to ``C.count`` for any ``c`` such that ``isinstance(c, +C)`` holds, unless overridden by ``c`` itself or by some class on the base-class +search path from ``c.__class__`` back to ``C``. + +Caution: within a method of C, an assignment like ``self.count = 42`` creates a +new and unrelated instance named "count" in ``self``'s own dict. Rebinding of a +class-static data name must always specify the class whether inside a method or +not:: + + C.count = 314 + +Static methods are possible:: + + class C: + @staticmethod + def static(arg1, arg2, arg3): + # No 'self' parameter! + ... + +However, a far more straightforward way to get the effect of a static method is +via a simple module-level function:: + + def getcount(): + return C.count + +If your code is structured so as to define one class (or tightly related class +hierarchy) per module, this supplies the desired encapsulation. + + +How can I overload constructors (or methods) in Python? +------------------------------------------------------- + +This answer actually applies to all methods, but the question usually comes up +first in the context of constructors. + +In C++ you'd write + +.. code-block:: c + + class C { + C() { cout << "No arguments\n"; } + C(int i) { cout << "Argument is " << i << "\n"; } + } + +In Python you have to write a single constructor that catches all cases using +default arguments. For example:: + + class C: + def __init__(self, i=None): + if i is None: + print("No arguments") + else: + print("Argument is", i) + +This is not entirely equivalent, but close enough in practice. + +You could also try a variable-length argument list, e.g. :: + + def __init__(self, *args): + ... + +The same approach works for all method definitions. + + +I try to use __spam and I get an error about _SomeClassName__spam. +------------------------------------------------------------------ + +Variable names with double leading underscores are "mangled" to provide a simple +but effective way to define class private variables. Any identifier of the form +``__spam`` (at least two leading underscores, at most one trailing underscore) +is textually replaced with ``_classname__spam``, where ``classname`` is the +current class name with any leading underscores stripped. + +This doesn't guarantee privacy: an outside user can still deliberately access +the "_classname__spam" attribute, and private values are visible in the object's +``__dict__``. Many Python programmers never bother to use private variable +names at all. + + +My class defines __del__ but it is not called when I delete the object. +----------------------------------------------------------------------- + +There are several possible reasons for this. + +The del statement does not necessarily call :meth:`__del__` -- it simply +decrements the object's reference count, and if this reaches zero +:meth:`__del__` is called. + +If your data structures contain circular links (e.g. a tree where each child has +a parent reference and each parent has a list of children) the reference counts +will never go back to zero. Once in a while Python runs an algorithm to detect +such cycles, but the garbage collector might run some time after the last +reference to your data structure vanishes, so your :meth:`__del__` method may be +called at an inconvenient and random time. This is inconvenient if you're trying +to reproduce a problem. Worse, the order in which object's :meth:`__del__` +methods are executed is arbitrary. You can run :func:`gc.collect` to force a +collection, but there *are* pathological cases where objects will never be +collected. + +Despite the cycle collector, it's still a good idea to define an explicit +``close()`` method on objects to be called whenever you're done with them. The +``close()`` method can then remove attributes that refer to subobjects. Don't +call :meth:`__del__` directly -- :meth:`__del__` should call ``close()`` and +``close()`` should make sure that it can be called more than once for the same +object. + +Another way to avoid cyclical references is to use the :mod:`weakref` module, +which allows you to point to objects without incrementing their reference count. +Tree data structures, for instance, should use weak references for their parent +and sibling references (if they need them!). + +.. XXX relevant for Python 3? + + If the object has ever been a local variable in a function that caught an + expression in an except clause, chances are that a reference to the object + still exists in that function's stack frame as contained in the stack trace. + Normally, calling :func:`sys.exc_clear` will take care of this by clearing + the last recorded exception. + +Finally, if your :meth:`__del__` method raises an exception, a warning message +is printed to :data:`sys.stderr`. + + +How do I get a list of all instances of a given class? +------------------------------------------------------ + +Python does not keep track of all instances of a class (or of a built-in type). +You can program the class's constructor to keep track of all instances by +keeping a list of weak references to each instance. + + +Why does the result of ``id()`` appear to be not unique? +-------------------------------------------------------- + +The :func:`id` builtin returns an integer that is guaranteed to be unique during +the lifetime of the object. Since in CPython, this is the object's memory +address, it happens frequently that after an object is deleted from memory, the +next freshly created object is allocated at the same position in memory. This +is illustrated by this example: + +>>> id(1000) # doctest: +SKIP +13901272 +>>> id(2000) # doctest: +SKIP +13901272 + +The two ids belong to different integer objects that are created before, and +deleted immediately after execution of the ``id()`` call. To be sure that +objects whose id you want to examine are still alive, create another reference +to the object: + +>>> a = 1000; b = 2000 +>>> id(a) # doctest: +SKIP +13901272 +>>> id(b) # doctest: +SKIP +13891296 + + +Modules +======= + +How do I create a .pyc file? +---------------------------- + +When a module is imported for the first time (or when the source file has +changed since the current compiled file was created) a ``.pyc`` file containing +the compiled code should be created in a ``__pycache__`` subdirectory of the +directory containing the ``.py`` file. The ``.pyc`` file will have a +filename that starts with the same name as the ``.py`` file, and ends with +``.pyc``, with a middle component that depends on the particular ``python`` +binary that created it. (See :pep:`3147` for details.) + +One reason that a ``.pyc`` file may not be created is a permissions problem +with the directory containing the source file, meaning that the ``__pycache__`` +subdirectory cannot be created. This can happen, for example, if you develop as +one user but run as another, such as if you are testing with a web server. + +Unless the :envvar:`PYTHONDONTWRITEBYTECODE` environment variable is set, +creation of a .pyc file is automatic if you're importing a module and Python +has the ability (permissions, free space, etc...) to create a ``__pycache__`` +subdirectory and write the compiled module to that subdirectory. + +Running Python on a top level script is not considered an import and no +``.pyc`` will be created. For example, if you have a top-level module +``foo.py`` that imports another module ``xyz.py``, when you run ``foo`` (by +typing ``python foo.py`` as a shell command), a ``.pyc`` will be created for +``xyz`` because ``xyz`` is imported, but no ``.pyc`` file will be created for +``foo`` since ``foo.py`` isn't being imported. + +If you need to create a ``.pyc`` file for ``foo`` -- that is, to create a +``.pyc`` file for a module that is not imported -- you can, using the +:mod:`py_compile` and :mod:`compileall` modules. + +The :mod:`py_compile` module can manually compile any module. One way is to use +the ``compile()`` function in that module interactively:: + + >>> import py_compile + >>> py_compile.compile('foo.py') # doctest: +SKIP + +This will write the ``.pyc`` to a ``__pycache__`` subdirectory in the same +location as ``foo.py`` (or you can override that with the optional parameter +``cfile``). + +You can also automatically compile all files in a directory or directories using +the :mod:`compileall` module. You can do it from the shell prompt by running +``compileall.py`` and providing the path of a directory containing Python files +to compile:: + + python -m compileall . + + +How do I find the current module name? +-------------------------------------- + +A module can find out its own module name by looking at the predefined global +variable ``__name__``. If this has the value ``'__main__'``, the program is +running as a script. Many modules that are usually used by importing them also +provide a command-line interface or a self-test, and only execute this code +after checking ``__name__``:: + + def main(): + print('Running test...') + ... + + if __name__ == '__main__': + main() + + +How can I have modules that mutually import each other? +------------------------------------------------------- + +Suppose you have the following modules: + +foo.py:: + + from bar import bar_var + foo_var = 1 + +bar.py:: + + from foo import foo_var + bar_var = 2 + +The problem is that the interpreter will perform the following steps: + +* main imports foo +* Empty globals for foo are created +* foo is compiled and starts executing +* foo imports bar +* Empty globals for bar are created +* bar is compiled and starts executing +* bar imports foo (which is a no-op since there already is a module named foo) +* bar.foo_var = foo.foo_var + +The last step fails, because Python isn't done with interpreting ``foo`` yet and +the global symbol dictionary for ``foo`` is still empty. + +The same thing happens when you use ``import foo``, and then try to access +``foo.foo_var`` in global code. + +There are (at least) three possible workarounds for this problem. + +Guido van Rossum recommends avoiding all uses of ``from import ...``, +and placing all code inside functions. Initializations of global variables and +class variables should use constants or built-in functions only. This means +everything from an imported module is referenced as ``.``. + +Jim Roskind suggests performing steps in the following order in each module: + +* exports (globals, functions, and classes that don't need imported base + classes) +* ``import`` statements +* active code (including globals that are initialized from imported values). + +van Rossum doesn't like this approach much because the imports appear in a +strange place, but it does work. + +Matthias Urlichs recommends restructuring your code so that the recursive import +is not necessary in the first place. + +These solutions are not mutually exclusive. + + +__import__('x.y.z') returns ; how do I get z? +--------------------------------------------------------- + +Consider using the convenience function :func:`~importlib.import_module` from +:mod:`importlib` instead:: + + z = importlib.import_module('x.y.z') + + +When I edit an imported module and reimport it, the changes don't show up. Why does this happen? +------------------------------------------------------------------------------------------------- + +For reasons of efficiency as well as consistency, Python only reads the module +file on the first time a module is imported. If it didn't, in a program +consisting of many modules where each one imports the same basic module, the +basic module would be parsed and re-parsed many times. To force re-reading of a +changed module, do this:: + + import importlib + import modname + importlib.reload(modname) + +Warning: this technique is not 100% fool-proof. In particular, modules +containing statements like :: + + from modname import some_objects + +will continue to work with the old version of the imported objects. If the +module contains class definitions, existing class instances will *not* be +updated to use the new class definition. This can result in the following +paradoxical behaviour:: + + >>> import importlib + >>> import cls + >>> c = cls.C() # Create an instance of C + >>> importlib.reload(cls) + + >>> isinstance(c, cls.C) # isinstance is false?!? + False + +The nature of the problem is made clear if you print out the "identity" of the +class objects:: + + >>> hex(id(c.__class__)) + '0x7352a0' + >>> hex(id(cls.C)) + '0x4198d0' diff --git a/python-3.7.4-docs-html/_sources/faq/windows.rst.txt b/python-3.7.4-docs-html/_sources/faq/windows.rst.txt new file mode 100644 index 0000000..a92ec1b --- /dev/null +++ b/python-3.7.4-docs-html/_sources/faq/windows.rst.txt @@ -0,0 +1,284 @@ +:tocdepth: 2 + +.. highlightlang:: none + +.. _windows-faq: + +===================== +Python on Windows FAQ +===================== + +.. only:: html + + .. contents:: + +.. XXX need review for Python 3. + XXX need review for Windows Vista/Seven? + +.. _faq-run-program-under-windows: + + +How do I run a Python program under Windows? +-------------------------------------------- + +This is not necessarily a straightforward question. If you are already familiar +with running programs from the Windows command line then everything will seem +obvious; otherwise, you might need a little more guidance. + +Unless you use some sort of integrated development environment, you will end up +*typing* Windows commands into what is variously referred to as a "DOS window" +or "Command prompt window". Usually you can create such a window from your +search bar by searching for ``cmd``. You should be able to recognize +when you have started such a window because you will see a Windows "command +prompt", which usually looks like this: + +.. code-block:: doscon + + C:\> + +The letter may be different, and there might be other things after it, so you +might just as easily see something like: + +.. code-block:: doscon + + D:\YourName\Projects\Python> + +depending on how your computer has been set up and what else you have recently +done with it. Once you have started such a window, you are well on the way to +running Python programs. + +You need to realize that your Python scripts have to be processed by another +program called the Python *interpreter*. The interpreter reads your script, +compiles it into bytecodes, and then executes the bytecodes to run your +program. So, how do you arrange for the interpreter to handle your Python? + +First, you need to make sure that your command window recognises the word +"py" as an instruction to start the interpreter. If you have opened a +command window, you should try entering the command ``py`` and hitting +return: + +.. code-block:: doscon + + C:\Users\YourName> py + +You should then see something like: + +.. code-block:: pycon + + Python 3.6.4 (v3.6.4:d48eceb, Dec 19 2017, 06:04:45) [MSC v.1900 32 bit (Intel)] on win32 + Type "help", "copyright", "credits" or "license" for more information. + >>> + +You have started the interpreter in "interactive mode". That means you can enter +Python statements or expressions interactively and have them executed or +evaluated while you wait. This is one of Python's strongest features. Check it +by entering a few expressions of your choice and seeing the results: + +.. code-block:: pycon + + >>> print("Hello") + Hello + >>> "Hello" * 3 + 'HelloHelloHello' + +Many people use the interactive mode as a convenient yet highly programmable +calculator. When you want to end your interactive Python session, +call the :func:`exit` function or hold the :kbd:`Ctrl` key down +while you enter a :kbd:`Z`, then hit the ":kbd:`Enter`" key to get +back to your Windows command prompt. + +You may also find that you have a Start-menu entry such as :menuselection:`Start +--> Programs --> Python 3.x --> Python (command line)` that results in you +seeing the ``>>>`` prompt in a new window. If so, the window will disappear +after you call the :func:`exit` function or enter the :kbd:`Ctrl-Z` +character; Windows is running a single "python" +command in the window, and closes it when you terminate the interpreter. + +Now that we know the ``py`` command is recognized, you can give your +Python script to it. You'll have to give either an absolute or a +relative path to the Python script. Let's say your Python script is +located in your desktop and is named ``hello.py``, and your command +prompt is nicely opened in your home directory so you're seeing something +similar to:: + + C:\Users\YourName> + +So now you'll ask the ``py`` command to give your script to Python by +typing ``py`` followed by your script path:: + + + C:\Users\YourName> py Desktop\hello.py + hello + +How do I make Python scripts executable? +---------------------------------------- + +On Windows, the standard Python installer already associates the .py +extension with a file type (Python.File) and gives that file type an open +command that runs the interpreter (``D:\Program Files\Python\python.exe "%1" +%*``). This is enough to make scripts executable from the command prompt as +'foo.py'. If you'd rather be able to execute the script by simple typing 'foo' +with no extension you need to add .py to the PATHEXT environment variable. + +Why does Python sometimes take so long to start? +------------------------------------------------ + +Usually Python starts very quickly on Windows, but occasionally there are bug +reports that Python suddenly begins to take a long time to start up. This is +made even more puzzling because Python will work fine on other Windows systems +which appear to be configured identically. + +The problem may be caused by a misconfiguration of virus checking software on +the problem machine. Some virus scanners have been known to introduce startup +overhead of two orders of magnitude when the scanner is configured to monitor +all reads from the filesystem. Try checking the configuration of virus scanning +software on your systems to ensure that they are indeed configured identically. +McAfee, when configured to scan all file system read activity, is a particular +offender. + + +How do I make an executable from a Python script? +------------------------------------------------- + +See `cx_Freeze `_ for a distutils extension +that allows you to create console and GUI executables from Python code. +`py2exe `_, the most popular extension for building +Python 2.x-based executables, does not yet support Python 3 but a version that +does is in development. + + +Is a ``*.pyd`` file the same as a DLL? +-------------------------------------- + +Yes, .pyd files are dll's, but there are a few differences. If you have a DLL +named ``foo.pyd``, then it must have a function ``PyInit_foo()``. You can then +write Python "import foo", and Python will search for foo.pyd (as well as +foo.py, foo.pyc) and if it finds it, will attempt to call ``PyInit_foo()`` to +initialize it. You do not link your .exe with foo.lib, as that would cause +Windows to require the DLL to be present. + +Note that the search path for foo.pyd is PYTHONPATH, not the same as the path +that Windows uses to search for foo.dll. Also, foo.pyd need not be present to +run your program, whereas if you linked your program with a dll, the dll is +required. Of course, foo.pyd is required if you want to say ``import foo``. In +a DLL, linkage is declared in the source code with ``__declspec(dllexport)``. +In a .pyd, linkage is defined in a list of available functions. + + +How can I embed Python into a Windows application? +-------------------------------------------------- + +Embedding the Python interpreter in a Windows app can be summarized as follows: + +1. Do _not_ build Python into your .exe file directly. On Windows, Python must + be a DLL to handle importing modules that are themselves DLL's. (This is the + first key undocumented fact.) Instead, link to :file:`python{NN}.dll`; it is + typically installed in ``C:\Windows\System``. *NN* is the Python version, a + number such as "33" for Python 3.3. + + You can link to Python in two different ways. Load-time linking means + linking against :file:`python{NN}.lib`, while run-time linking means linking + against :file:`python{NN}.dll`. (General note: :file:`python{NN}.lib` is the + so-called "import lib" corresponding to :file:`python{NN}.dll`. It merely + defines symbols for the linker.) + + Run-time linking greatly simplifies link options; everything happens at run + time. Your code must load :file:`python{NN}.dll` using the Windows + ``LoadLibraryEx()`` routine. The code must also use access routines and data + in :file:`python{NN}.dll` (that is, Python's C API's) using pointers obtained + by the Windows ``GetProcAddress()`` routine. Macros can make using these + pointers transparent to any C code that calls routines in Python's C API. + + Borland note: convert :file:`python{NN}.lib` to OMF format using Coff2Omf.exe + first. + + .. XXX what about static linking? + +2. If you use SWIG, it is easy to create a Python "extension module" that will + make the app's data and methods available to Python. SWIG will handle just + about all the grungy details for you. The result is C code that you link + *into* your .exe file (!) You do _not_ have to create a DLL file, and this + also simplifies linking. + +3. SWIG will create an init function (a C function) whose name depends on the + name of the extension module. For example, if the name of the module is leo, + the init function will be called initleo(). If you use SWIG shadow classes, + as you should, the init function will be called initleoc(). This initializes + a mostly hidden helper class used by the shadow class. + + The reason you can link the C code in step 2 into your .exe file is that + calling the initialization function is equivalent to importing the module + into Python! (This is the second key undocumented fact.) + +4. In short, you can use the following code to initialize the Python interpreter + with your extension module. + + .. code-block:: c + + #include "python.h" + ... + Py_Initialize(); // Initialize Python. + initmyAppc(); // Initialize (import) the helper class. + PyRun_SimpleString("import myApp"); // Import the shadow class. + +5. There are two problems with Python's C API which will become apparent if you + use a compiler other than MSVC, the compiler used to build pythonNN.dll. + + Problem 1: The so-called "Very High Level" functions that take FILE * + arguments will not work in a multi-compiler environment because each + compiler's notion of a struct FILE will be different. From an implementation + standpoint these are very _low_ level functions. + + Problem 2: SWIG generates the following code when generating wrappers to void + functions: + + .. code-block:: c + + Py_INCREF(Py_None); + _resultobj = Py_None; + return _resultobj; + + Alas, Py_None is a macro that expands to a reference to a complex data + structure called _Py_NoneStruct inside pythonNN.dll. Again, this code will + fail in a mult-compiler environment. Replace such code by: + + .. code-block:: c + + return Py_BuildValue(""); + + It may be possible to use SWIG's ``%typemap`` command to make the change + automatically, though I have not been able to get this to work (I'm a + complete SWIG newbie). + +6. Using a Python shell script to put up a Python interpreter window from inside + your Windows app is not a good idea; the resulting window will be independent + of your app's windowing system. Rather, you (or the wxPythonWindow class) + should create a "native" interpreter window. It is easy to connect that + window to the Python interpreter. You can redirect Python's i/o to _any_ + object that supports read and write, so all you need is a Python object + (defined in your extension module) that contains read() and write() methods. + +How do I keep editors from inserting tabs into my Python source? +---------------------------------------------------------------- + +The FAQ does not recommend using tabs, and the Python style guide, :pep:`8`, +recommends 4 spaces for distributed Python code; this is also the Emacs +python-mode default. + +Under any editor, mixing tabs and spaces is a bad idea. MSVC is no different in +this respect, and is easily configured to use spaces: Take :menuselection:`Tools +--> Options --> Tabs`, and for file type "Default" set "Tab size" and "Indent +size" to 4, and select the "Insert spaces" radio button. + +Python raises :exc:`IndentationError` or :exc:`TabError` if mixed tabs +and spaces are causing problems in leading whitespace. +You may also run the :mod:`tabnanny` module to check a directory tree +in batch mode. + + +How do I check for a keypress without blocking? +----------------------------------------------- + +Use the msvcrt module. This is a standard Windows-specific extension module. +It defines a function ``kbhit()`` which checks whether a keyboard hit is +present, and ``getch()`` which gets one character without echoing it. diff --git a/python-3.7.4-docs-html/_sources/glossary.rst.txt b/python-3.7.4-docs-html/_sources/glossary.rst.txt new file mode 100644 index 0000000..df6f6b6 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/glossary.rst.txt @@ -0,0 +1,1146 @@ +.. _glossary: + +******** +Glossary +******** + +.. if you add new entries, keep the alphabetical sorting! + +.. glossary:: + + ``>>>`` + The default Python prompt of the interactive shell. Often seen for code + examples which can be executed interactively in the interpreter. + + ``...`` + The default Python prompt of the interactive shell when entering the + code for an indented code block, when within a pair of matching left and + right delimiters (parentheses, square brackets, curly braces or triple + quotes), or after specifying a decorator. + + 2to3 + A tool that tries to convert Python 2.x code to Python 3.x code by + handling most of the incompatibilities which can be detected by parsing the + source and traversing the parse tree. + + 2to3 is available in the standard library as :mod:`lib2to3`; a standalone + entry point is provided as :file:`Tools/scripts/2to3`. See + :ref:`2to3-reference`. + + abstract base class + Abstract base classes complement :term:`duck-typing` by + providing a way to define interfaces when other techniques like + :func:`hasattr` would be clumsy or subtly wrong (for example with + :ref:`magic methods `). ABCs introduce virtual + subclasses, which are classes that don't inherit from a class but are + still recognized by :func:`isinstance` and :func:`issubclass`; see the + :mod:`abc` module documentation. Python comes with many built-in ABCs for + data structures (in the :mod:`collections.abc` module), numbers (in the + :mod:`numbers` module), streams (in the :mod:`io` module), import finders + and loaders (in the :mod:`importlib.abc` module). You can create your own + ABCs with the :mod:`abc` module. + + annotation + A label associated with a variable, a class + attribute or a function parameter or return value, + used by convention as a :term:`type hint`. + + Annotations of local variables cannot be accessed at runtime, but + annotations of global variables, class attributes, and functions + are stored in the :attr:`__annotations__` + special attribute of modules, classes, and functions, + respectively. + + See :term:`variable annotation`, :term:`function annotation`, :pep:`484` + and :pep:`526`, which describe this functionality. + + argument + A value passed to a :term:`function` (or :term:`method`) when calling the + function. There are two kinds of argument: + + * :dfn:`keyword argument`: an argument preceded by an identifier (e.g. + ``name=``) in a function call or passed as a value in a dictionary + preceded by ``**``. For example, ``3`` and ``5`` are both keyword + arguments in the following calls to :func:`complex`:: + + complex(real=3, imag=5) + complex(**{'real': 3, 'imag': 5}) + + * :dfn:`positional argument`: an argument that is not a keyword argument. + Positional arguments can appear at the beginning of an argument list + and/or be passed as elements of an :term:`iterable` preceded by ``*``. + For example, ``3`` and ``5`` are both positional arguments in the + following calls:: + + complex(3, 5) + complex(*(3, 5)) + + Arguments are assigned to the named local variables in a function body. + See the :ref:`calls` section for the rules governing this assignment. + Syntactically, any expression can be used to represent an argument; the + evaluated value is assigned to the local variable. + + See also the :term:`parameter` glossary entry, the FAQ question on + :ref:`the difference between arguments and parameters + `, and :pep:`362`. + + asynchronous context manager + An object which controls the environment seen in an + :keyword:`async with` statement by defining :meth:`__aenter__` and + :meth:`__aexit__` methods. Introduced by :pep:`492`. + + asynchronous generator + A function which returns an :term:`asynchronous generator iterator`. It + looks like a coroutine function defined with :keyword:`async def` except + that it contains :keyword:`yield` expressions for producing a series of + values usable in an :keyword:`async for` loop. + + Usually refers to an asynchronous generator function, but may refer to an + *asynchronous generator iterator* in some contexts. In cases where the + intended meaning isn't clear, using the full terms avoids ambiguity. + + An asynchronous generator function may contain :keyword:`await` + expressions as well as :keyword:`async for`, and :keyword:`async with` + statements. + + asynchronous generator iterator + An object created by a :term:`asynchronous generator` function. + + This is an :term:`asynchronous iterator` which when called using the + :meth:`__anext__` method returns an awaitable object which will execute + the body of the asynchronous generator function until the next + :keyword:`yield` expression. + + Each :keyword:`yield` temporarily suspends processing, remembering the + location execution state (including local variables and pending + try-statements). When the *asynchronous generator iterator* effectively + resumes with another awaitable returned by :meth:`__anext__`, it + picks up where it left off. See :pep:`492` and :pep:`525`. + + asynchronous iterable + An object, that can be used in an :keyword:`async for` statement. + Must return an :term:`asynchronous iterator` from its + :meth:`__aiter__` method. Introduced by :pep:`492`. + + asynchronous iterator + An object that implements the :meth:`__aiter__` and :meth:`__anext__` + methods. ``__anext__`` must return an :term:`awaitable` object. + :keyword:`async for` resolves the awaitables returned by an asynchronous + iterator's :meth:`__anext__` method until it raises a + :exc:`StopAsyncIteration` exception. Introduced by :pep:`492`. + + attribute + A value associated with an object which is referenced by name using + dotted expressions. For example, if an object *o* has an attribute + *a* it would be referenced as *o.a*. + + awaitable + An object that can be used in an :keyword:`await` expression. Can be + a :term:`coroutine` or an object with an :meth:`__await__` method. + See also :pep:`492`. + + BDFL + Benevolent Dictator For Life, a.k.a. `Guido van Rossum + `_, Python's creator. + + binary file + A :term:`file object` able to read and write + :term:`bytes-like objects `. + Examples of binary files are files opened in binary mode (``'rb'``, + ``'wb'`` or ``'rb+'``), :data:`sys.stdin.buffer`, + :data:`sys.stdout.buffer`, and instances of :class:`io.BytesIO` and + :class:`gzip.GzipFile`. + + See also :term:`text file` for a file object able to read and write + :class:`str` objects. + + bytes-like object + An object that supports the :ref:`bufferobjects` and can + export a C-:term:`contiguous` buffer. This includes all :class:`bytes`, + :class:`bytearray`, and :class:`array.array` objects, as well as many + common :class:`memoryview` objects. Bytes-like objects can + be used for various operations that work with binary data; these include + compression, saving to a binary file, and sending over a socket. + + Some operations need the binary data to be mutable. The documentation + often refers to these as "read-write bytes-like objects". Example + mutable buffer objects include :class:`bytearray` and a + :class:`memoryview` of a :class:`bytearray`. + Other operations require the binary data to be stored in + immutable objects ("read-only bytes-like objects"); examples + of these include :class:`bytes` and a :class:`memoryview` + of a :class:`bytes` object. + + bytecode + Python source code is compiled into bytecode, the internal representation + of a Python program in the CPython interpreter. The bytecode is also + cached in ``.pyc`` files so that executing the same file is + faster the second time (recompilation from source to bytecode can be + avoided). This "intermediate language" is said to run on a + :term:`virtual machine` that executes the machine code corresponding to + each bytecode. Do note that bytecodes are not expected to work between + different Python virtual machines, nor to be stable between Python + releases. + + A list of bytecode instructions can be found in the documentation for + :ref:`the dis module `. + + class + A template for creating user-defined objects. Class definitions + normally contain method definitions which operate on instances of the + class. + + class variable + A variable defined in a class and intended to be modified only at + class level (i.e., not in an instance of the class). + + coercion + The implicit conversion of an instance of one type to another during an + operation which involves two arguments of the same type. For example, + ``int(3.15)`` converts the floating point number to the integer ``3``, but + in ``3+4.5``, each argument is of a different type (one int, one float), + and both must be converted to the same type before they can be added or it + will raise a :exc:`TypeError`. Without coercion, all arguments of even + compatible types would have to be normalized to the same value by the + programmer, e.g., ``float(3)+4.5`` rather than just ``3+4.5``. + + complex number + An extension of the familiar real number system in which all numbers are + expressed as a sum of a real part and an imaginary part. Imaginary + numbers are real multiples of the imaginary unit (the square root of + ``-1``), often written ``i`` in mathematics or ``j`` in + engineering. Python has built-in support for complex numbers, which are + written with this latter notation; the imaginary part is written with a + ``j`` suffix, e.g., ``3+1j``. To get access to complex equivalents of the + :mod:`math` module, use :mod:`cmath`. Use of complex numbers is a fairly + advanced mathematical feature. If you're not aware of a need for them, + it's almost certain you can safely ignore them. + + context manager + An object which controls the environment seen in a :keyword:`with` + statement by defining :meth:`__enter__` and :meth:`__exit__` methods. + See :pep:`343`. + + context variable + A variable which can have different values depending on its context. + This is similar to Thread-Local Storage in which each execution + thread may have a different value for a variable. However, with context + variables, there may be several contexts in one execution thread and the + main usage for context variables is to keep track of variables in + concurrent asynchronous tasks. + See :mod:`contextvars`. + + contiguous + .. index:: C-contiguous, Fortran contiguous + + A buffer is considered contiguous exactly if it is either + *C-contiguous* or *Fortran contiguous*. Zero-dimensional buffers are + C and Fortran contiguous. In one-dimensional arrays, the items + must be laid out in memory next to each other, in order of + increasing indexes starting from zero. In multidimensional + C-contiguous arrays, the last index varies the fastest when + visiting items in order of memory address. However, in + Fortran contiguous arrays, the first index varies the fastest. + + coroutine + Coroutines is a more generalized form of subroutines. Subroutines are + entered at one point and exited at another point. Coroutines can be + entered, exited, and resumed at many different points. They can be + implemented with the :keyword:`async def` statement. See also + :pep:`492`. + + coroutine function + A function which returns a :term:`coroutine` object. A coroutine + function may be defined with the :keyword:`async def` statement, + and may contain :keyword:`await`, :keyword:`async for`, and + :keyword:`async with` keywords. These were introduced + by :pep:`492`. + + CPython + The canonical implementation of the Python programming language, as + distributed on `python.org `_. The term "CPython" + is used when necessary to distinguish this implementation from others + such as Jython or IronPython. + + decorator + A function returning another function, usually applied as a function + transformation using the ``@wrapper`` syntax. Common examples for + decorators are :func:`classmethod` and :func:`staticmethod`. + + The decorator syntax is merely syntactic sugar, the following two + function definitions are semantically equivalent:: + + def f(...): + ... + f = staticmethod(f) + + @staticmethod + def f(...): + ... + + The same concept exists for classes, but is less commonly used there. See + the documentation for :ref:`function definitions ` and + :ref:`class definitions ` for more about decorators. + + descriptor + Any object which defines the methods :meth:`__get__`, :meth:`__set__`, or + :meth:`__delete__`. When a class attribute is a descriptor, its special + binding behavior is triggered upon attribute lookup. Normally, using + *a.b* to get, set or delete an attribute looks up the object named *b* in + the class dictionary for *a*, but if *b* is a descriptor, the respective + descriptor method gets called. Understanding descriptors is a key to a + deep understanding of Python because they are the basis for many features + including functions, methods, properties, class methods, static methods, + and reference to super classes. + + For more information about descriptors' methods, see :ref:`descriptors`. + + dictionary + An associative array, where arbitrary keys are mapped to values. The + keys can be any object with :meth:`__hash__` and :meth:`__eq__` methods. + Called a hash in Perl. + + dictionary view + The objects returned from :meth:`dict.keys`, :meth:`dict.values`, and + :meth:`dict.items` are called dictionary views. They provide a dynamic + view on the dictionary’s entries, which means that when the dictionary + changes, the view reflects these changes. To force the + dictionary view to become a full list use ``list(dictview)``. See + :ref:`dict-views`. + + docstring + A string literal which appears as the first expression in a class, + function or module. While ignored when the suite is executed, it is + recognized by the compiler and put into the :attr:`__doc__` attribute + of the enclosing class, function or module. Since it is available via + introspection, it is the canonical place for documentation of the + object. + + duck-typing + A programming style which does not look at an object's type to determine + if it has the right interface; instead, the method or attribute is simply + called or used ("If it looks like a duck and quacks like a duck, it + must be a duck.") By emphasizing interfaces rather than specific types, + well-designed code improves its flexibility by allowing polymorphic + substitution. Duck-typing avoids tests using :func:`type` or + :func:`isinstance`. (Note, however, that duck-typing can be complemented + with :term:`abstract base classes `.) Instead, it + typically employs :func:`hasattr` tests or :term:`EAFP` programming. + + EAFP + Easier to ask for forgiveness than permission. This common Python coding + style assumes the existence of valid keys or attributes and catches + exceptions if the assumption proves false. This clean and fast style is + characterized by the presence of many :keyword:`try` and :keyword:`except` + statements. The technique contrasts with the :term:`LBYL` style + common to many other languages such as C. + + expression + A piece of syntax which can be evaluated to some value. In other words, + an expression is an accumulation of expression elements like literals, + names, attribute access, operators or function calls which all return a + value. In contrast to many other languages, not all language constructs + are expressions. There are also :term:`statement`\s which cannot be used + as expressions, such as :keyword:`while`. Assignments are also statements, + not expressions. + + extension module + A module written in C or C++, using Python's C API to interact with the + core and with user code. + + f-string + String literals prefixed with ``'f'`` or ``'F'`` are commonly called + "f-strings" which is short for + :ref:`formatted string literals `. See also :pep:`498`. + + file object + An object exposing a file-oriented API (with methods such as + :meth:`read()` or :meth:`write()`) to an underlying resource. Depending + on the way it was created, a file object can mediate access to a real + on-disk file or to another type of storage or communication device + (for example standard input/output, in-memory buffers, sockets, pipes, + etc.). File objects are also called :dfn:`file-like objects` or + :dfn:`streams`. + + There are actually three categories of file objects: raw + :term:`binary files `, buffered + :term:`binary files ` and :term:`text files `. + Their interfaces are defined in the :mod:`io` module. The canonical + way to create a file object is by using the :func:`open` function. + + file-like object + A synonym for :term:`file object`. + + finder + An object that tries to find the :term:`loader` for a module that is + being imported. + + Since Python 3.3, there are two types of finder: :term:`meta path finders + ` for use with :data:`sys.meta_path`, and :term:`path + entry finders ` for use with :data:`sys.path_hooks`. + + See :pep:`302`, :pep:`420` and :pep:`451` for much more detail. + + floor division + Mathematical division that rounds down to nearest integer. The floor + division operator is ``//``. For example, the expression ``11 // 4`` + evaluates to ``2`` in contrast to the ``2.75`` returned by float true + division. Note that ``(-11) // 4`` is ``-3`` because that is ``-2.75`` + rounded *downward*. See :pep:`238`. + + function + A series of statements which returns some value to a caller. It can also + be passed zero or more :term:`arguments ` which may be used in + the execution of the body. See also :term:`parameter`, :term:`method`, + and the :ref:`function` section. + + function annotation + An :term:`annotation` of a function parameter or return value. + + Function annotations are usually used for + :term:`type hints `: for example, this function is expected to take two + :class:`int` arguments and is also expected to have an :class:`int` + return value:: + + def sum_two_numbers(a: int, b: int) -> int: + return a + b + + Function annotation syntax is explained in section :ref:`function`. + + See :term:`variable annotation` and :pep:`484`, + which describe this functionality. + + __future__ + A pseudo-module which programmers can use to enable new language features + which are not compatible with the current interpreter. + + By importing the :mod:`__future__` module and evaluating its variables, + you can see when a new feature was first added to the language and when it + becomes the default:: + + >>> import __future__ + >>> __future__.division + _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192) + + garbage collection + The process of freeing memory when it is not used anymore. Python + performs garbage collection via reference counting and a cyclic garbage + collector that is able to detect and break reference cycles. The + garbage collector can be controlled using the :mod:`gc` module. + + .. index:: single: generator + + generator + A function which returns a :term:`generator iterator`. It looks like a + normal function except that it contains :keyword:`yield` expressions + for producing a series of values usable in a for-loop or that can be + retrieved one at a time with the :func:`next` function. + + Usually refers to a generator function, but may refer to a + *generator iterator* in some contexts. In cases where the intended + meaning isn't clear, using the full terms avoids ambiguity. + + generator iterator + An object created by a :term:`generator` function. + + Each :keyword:`yield` temporarily suspends processing, remembering the + location execution state (including local variables and pending + try-statements). When the *generator iterator* resumes, it picks up where + it left off (in contrast to functions which start fresh on every + invocation). + + .. index:: single: generator expression + + generator expression + An expression that returns an iterator. It looks like a normal expression + followed by a :keyword:`!for` clause defining a loop variable, range, + and an optional :keyword:`!if` clause. The combined expression + generates values for an enclosing function:: + + >>> sum(i*i for i in range(10)) # sum of squares 0, 1, 4, ... 81 + 285 + + generic function + A function composed of multiple functions implementing the same operation + for different types. Which implementation should be used during a call is + determined by the dispatch algorithm. + + See also the :term:`single dispatch` glossary entry, the + :func:`functools.singledispatch` decorator, and :pep:`443`. + + + GIL + See :term:`global interpreter lock`. + + global interpreter lock + The mechanism used by the :term:`CPython` interpreter to assure that + only one thread executes Python :term:`bytecode` at a time. + This simplifies the CPython implementation by making the object model + (including critical built-in types such as :class:`dict`) implicitly + safe against concurrent access. Locking the entire interpreter + makes it easier for the interpreter to be multi-threaded, at the + expense of much of the parallelism afforded by multi-processor + machines. + + However, some extension modules, either standard or third-party, + are designed so as to release the GIL when doing computationally-intensive + tasks such as compression or hashing. Also, the GIL is always released + when doing I/O. + + Past efforts to create a "free-threaded" interpreter (one which locks + shared data at a much finer granularity) have not been successful + because performance suffered in the common single-processor case. It + is believed that overcoming this performance issue would make the + implementation much more complicated and therefore costlier to maintain. + + + hash-based pyc + A bytecode cache file that uses the hash rather than the last-modified + time of the corresponding source file to determine its validity. See + :ref:`pyc-invalidation`. + + hashable + An object is *hashable* if it has a hash value which never changes during + its lifetime (it needs a :meth:`__hash__` method), and can be compared to + other objects (it needs an :meth:`__eq__` method). Hashable objects which + compare equal must have the same hash value. + + Hashability makes an object usable as a dictionary key and a set member, + because these data structures use the hash value internally. + + Most of Python's immutable built-in objects are hashable; mutable + containers (such as lists or dictionaries) are not; immutable + containers (such as tuples and frozensets) are only hashable if + their elements are hashable. Objects which are + instances of user-defined classes are hashable by default. They all + compare unequal (except with themselves), and their hash value is derived + from their :func:`id`. + + IDLE + An Integrated Development Environment for Python. IDLE is a basic editor + and interpreter environment which ships with the standard distribution of + Python. + + immutable + An object with a fixed value. Immutable objects include numbers, strings and + tuples. Such an object cannot be altered. A new object has to + be created if a different value has to be stored. They play an important + role in places where a constant hash value is needed, for example as a key + in a dictionary. + + import path + A list of locations (or :term:`path entries `) that are + searched by the :term:`path based finder` for modules to import. During + import, this list of locations usually comes from :data:`sys.path`, but + for subpackages it may also come from the parent package's ``__path__`` + attribute. + + importing + The process by which Python code in one module is made available to + Python code in another module. + + importer + An object that both finds and loads a module; both a + :term:`finder` and :term:`loader` object. + + interactive + Python has an interactive interpreter which means you can enter + statements and expressions at the interpreter prompt, immediately + execute them and see their results. Just launch ``python`` with no + arguments (possibly by selecting it from your computer's main + menu). It is a very powerful way to test out new ideas or inspect + modules and packages (remember ``help(x)``). + + interpreted + Python is an interpreted language, as opposed to a compiled one, + though the distinction can be blurry because of the presence of the + bytecode compiler. This means that source files can be run directly + without explicitly creating an executable which is then run. + Interpreted languages typically have a shorter development/debug cycle + than compiled ones, though their programs generally also run more + slowly. See also :term:`interactive`. + + interpreter shutdown + When asked to shut down, the Python interpreter enters a special phase + where it gradually releases all allocated resources, such as modules + and various critical internal structures. It also makes several calls + to the :term:`garbage collector `. This can trigger + the execution of code in user-defined destructors or weakref callbacks. + Code executed during the shutdown phase can encounter various + exceptions as the resources it relies on may not function anymore + (common examples are library modules or the warnings machinery). + + The main reason for interpreter shutdown is that the ``__main__`` module + or the script being run has finished executing. + + iterable + An object capable of returning its members one at a time. Examples of + iterables include all sequence types (such as :class:`list`, :class:`str`, + and :class:`tuple`) and some non-sequence types like :class:`dict`, + :term:`file objects `, and objects of any classes you define + with an :meth:`__iter__` method or with a :meth:`__getitem__` method + that implements :term:`Sequence` semantics. + + Iterables can be + used in a :keyword:`for` loop and in many other places where a sequence is + needed (:func:`zip`, :func:`map`, ...). When an iterable object is passed + as an argument to the built-in function :func:`iter`, it returns an + iterator for the object. This iterator is good for one pass over the set + of values. When using iterables, it is usually not necessary to call + :func:`iter` or deal with iterator objects yourself. The ``for`` + statement does that automatically for you, creating a temporary unnamed + variable to hold the iterator for the duration of the loop. See also + :term:`iterator`, :term:`sequence`, and :term:`generator`. + + iterator + An object representing a stream of data. Repeated calls to the iterator's + :meth:`~iterator.__next__` method (or passing it to the built-in function + :func:`next`) return successive items in the stream. When no more data + are available a :exc:`StopIteration` exception is raised instead. At this + point, the iterator object is exhausted and any further calls to its + :meth:`__next__` method just raise :exc:`StopIteration` again. Iterators + are required to have an :meth:`__iter__` method that returns the iterator + object itself so every iterator is also iterable and may be used in most + places where other iterables are accepted. One notable exception is code + which attempts multiple iteration passes. A container object (such as a + :class:`list`) produces a fresh new iterator each time you pass it to the + :func:`iter` function or use it in a :keyword:`for` loop. Attempting this + with an iterator will just return the same exhausted iterator object used + in the previous iteration pass, making it appear like an empty container. + + More information can be found in :ref:`typeiter`. + + key function + A key function or collation function is a callable that returns a value + used for sorting or ordering. For example, :func:`locale.strxfrm` is + used to produce a sort key that is aware of locale specific sort + conventions. + + A number of tools in Python accept key functions to control how elements + are ordered or grouped. They include :func:`min`, :func:`max`, + :func:`sorted`, :meth:`list.sort`, :func:`heapq.merge`, + :func:`heapq.nsmallest`, :func:`heapq.nlargest`, and + :func:`itertools.groupby`. + + There are several ways to create a key function. For example. the + :meth:`str.lower` method can serve as a key function for case insensitive + sorts. Alternatively, a key function can be built from a + :keyword:`lambda` expression such as ``lambda r: (r[0], r[2])``. Also, + the :mod:`operator` module provides three key function constructors: + :func:`~operator.attrgetter`, :func:`~operator.itemgetter`, and + :func:`~operator.methodcaller`. See the :ref:`Sorting HOW TO + ` for examples of how to create and use key functions. + + keyword argument + See :term:`argument`. + + lambda + An anonymous inline function consisting of a single :term:`expression` + which is evaluated when the function is called. The syntax to create + a lambda function is ``lambda [parameters]: expression`` + + LBYL + Look before you leap. This coding style explicitly tests for + pre-conditions before making calls or lookups. This style contrasts with + the :term:`EAFP` approach and is characterized by the presence of many + :keyword:`if` statements. + + In a multi-threaded environment, the LBYL approach can risk introducing a + race condition between "the looking" and "the leaping". For example, the + code, ``if key in mapping: return mapping[key]`` can fail if another + thread removes *key* from *mapping* after the test, but before the lookup. + This issue can be solved with locks or by using the EAFP approach. + + list + A built-in Python :term:`sequence`. Despite its name it is more akin + to an array in other languages than to a linked list since access to + elements is O(1). + + list comprehension + A compact way to process all or part of the elements in a sequence and + return a list with the results. ``result = ['{:#04x}'.format(x) for x in + range(256) if x % 2 == 0]`` generates a list of strings containing + even hex numbers (0x..) in the range from 0 to 255. The :keyword:`if` + clause is optional. If omitted, all elements in ``range(256)`` are + processed. + + loader + An object that loads a module. It must define a method named + :meth:`load_module`. A loader is typically returned by a + :term:`finder`. See :pep:`302` for details and + :class:`importlib.abc.Loader` for an :term:`abstract base class`. + + magic method + .. index:: pair: magic; method + + An informal synonym for :term:`special method`. + + mapping + A container object that supports arbitrary key lookups and implements the + methods specified in the :class:`~collections.abc.Mapping` or + :class:`~collections.abc.MutableMapping` + :ref:`abstract base classes `. Examples + include :class:`dict`, :class:`collections.defaultdict`, + :class:`collections.OrderedDict` and :class:`collections.Counter`. + + meta path finder + A :term:`finder` returned by a search of :data:`sys.meta_path`. Meta path + finders are related to, but different from :term:`path entry finders + `. + + See :class:`importlib.abc.MetaPathFinder` for the methods that meta path + finders implement. + + metaclass + The class of a class. Class definitions create a class name, a class + dictionary, and a list of base classes. The metaclass is responsible for + taking those three arguments and creating the class. Most object oriented + programming languages provide a default implementation. What makes Python + special is that it is possible to create custom metaclasses. Most users + never need this tool, but when the need arises, metaclasses can provide + powerful, elegant solutions. They have been used for logging attribute + access, adding thread-safety, tracking object creation, implementing + singletons, and many other tasks. + + More information can be found in :ref:`metaclasses`. + + method + A function which is defined inside a class body. If called as an attribute + of an instance of that class, the method will get the instance object as + its first :term:`argument` (which is usually called ``self``). + See :term:`function` and :term:`nested scope`. + + method resolution order + Method Resolution Order is the order in which base classes are searched + for a member during lookup. See `The Python 2.3 Method Resolution Order + `_ for details of the + algorithm used by the Python interpreter since the 2.3 release. + + module + An object that serves as an organizational unit of Python code. Modules + have a namespace containing arbitrary Python objects. Modules are loaded + into Python by the process of :term:`importing`. + + See also :term:`package`. + + module spec + A namespace containing the import-related information used to load a + module. An instance of :class:`importlib.machinery.ModuleSpec`. + + MRO + See :term:`method resolution order`. + + mutable + Mutable objects can change their value but keep their :func:`id`. See + also :term:`immutable`. + + named tuple + Any tuple-like class whose indexable elements are also accessible using + named attributes (for example, :func:`time.localtime` returns a + tuple-like object where the *year* is accessible either with an + index such as ``t[0]`` or with a named attribute like ``t.tm_year``). + + A named tuple can be a built-in type such as :class:`time.struct_time`, + or it can be created with a regular class definition. A full featured + named tuple can also be created with the factory function + :func:`collections.namedtuple`. The latter approach automatically + provides extra features such as a self-documenting representation like + ``Employee(name='jones', title='programmer')``. + + namespace + The place where a variable is stored. Namespaces are implemented as + dictionaries. There are the local, global and built-in namespaces as well + as nested namespaces in objects (in methods). Namespaces support + modularity by preventing naming conflicts. For instance, the functions + :func:`builtins.open <.open>` and :func:`os.open` are distinguished by + their namespaces. Namespaces also aid readability and maintainability by + making it clear which module implements a function. For instance, writing + :func:`random.seed` or :func:`itertools.islice` makes it clear that those + functions are implemented by the :mod:`random` and :mod:`itertools` + modules, respectively. + + namespace package + A :pep:`420` :term:`package` which serves only as a container for + subpackages. Namespace packages may have no physical representation, + and specifically are not like a :term:`regular package` because they + have no ``__init__.py`` file. + + See also :term:`module`. + + nested scope + The ability to refer to a variable in an enclosing definition. For + instance, a function defined inside another function can refer to + variables in the outer function. Note that nested scopes by default work + only for reference and not for assignment. Local variables both read and + write in the innermost scope. Likewise, global variables read and write + to the global namespace. The :keyword:`nonlocal` allows writing to outer + scopes. + + new-style class + Old name for the flavor of classes now used for all class objects. In + earlier Python versions, only new-style classes could use Python's newer, + versatile features like :attr:`~object.__slots__`, descriptors, + properties, :meth:`__getattribute__`, class methods, and static methods. + + object + Any data with state (attributes or value) and defined behavior + (methods). Also the ultimate base class of any :term:`new-style + class`. + + package + A Python :term:`module` which can contain submodules or recursively, + subpackages. Technically, a package is a Python module with an + ``__path__`` attribute. + + See also :term:`regular package` and :term:`namespace package`. + + parameter + A named entity in a :term:`function` (or method) definition that + specifies an :term:`argument` (or in some cases, arguments) that the + function can accept. There are five kinds of parameter: + + * :dfn:`positional-or-keyword`: specifies an argument that can be passed + either :term:`positionally ` or as a :term:`keyword argument + `. This is the default kind of parameter, for example *foo* + and *bar* in the following:: + + def func(foo, bar=None): ... + + .. _positional-only_parameter: + + * :dfn:`positional-only`: specifies an argument that can be supplied only + by position. Python has no syntax for defining positional-only + parameters. However, some built-in functions have positional-only + parameters (e.g. :func:`abs`). + + .. _keyword-only_parameter: + + * :dfn:`keyword-only`: specifies an argument that can be supplied only + by keyword. Keyword-only parameters can be defined by including a + single var-positional parameter or bare ``*`` in the parameter list + of the function definition before them, for example *kw_only1* and + *kw_only2* in the following:: + + def func(arg, *, kw_only1, kw_only2): ... + + * :dfn:`var-positional`: specifies that an arbitrary sequence of + positional arguments can be provided (in addition to any positional + arguments already accepted by other parameters). Such a parameter can + be defined by prepending the parameter name with ``*``, for example + *args* in the following:: + + def func(*args, **kwargs): ... + + * :dfn:`var-keyword`: specifies that arbitrarily many keyword arguments + can be provided (in addition to any keyword arguments already accepted + by other parameters). Such a parameter can be defined by prepending + the parameter name with ``**``, for example *kwargs* in the example + above. + + Parameters can specify both optional and required arguments, as well as + default values for some optional arguments. + + See also the :term:`argument` glossary entry, the FAQ question on + :ref:`the difference between arguments and parameters + `, the :class:`inspect.Parameter` class, the + :ref:`function` section, and :pep:`362`. + + path entry + A single location on the :term:`import path` which the :term:`path + based finder` consults to find modules for importing. + + path entry finder + A :term:`finder` returned by a callable on :data:`sys.path_hooks` + (i.e. a :term:`path entry hook`) which knows how to locate modules given + a :term:`path entry`. + + See :class:`importlib.abc.PathEntryFinder` for the methods that path entry + finders implement. + + path entry hook + A callable on the :data:`sys.path_hook` list which returns a :term:`path + entry finder` if it knows how to find modules on a specific :term:`path + entry`. + + path based finder + One of the default :term:`meta path finders ` which + searches an :term:`import path` for modules. + + path-like object + An object representing a file system path. A path-like object is either + a :class:`str` or :class:`bytes` object representing a path, or an object + implementing the :class:`os.PathLike` protocol. An object that supports + the :class:`os.PathLike` protocol can be converted to a :class:`str` or + :class:`bytes` file system path by calling the :func:`os.fspath` function; + :func:`os.fsdecode` and :func:`os.fsencode` can be used to guarantee a + :class:`str` or :class:`bytes` result instead, respectively. Introduced + by :pep:`519`. + + PEP + Python Enhancement Proposal. A PEP is a design document + providing information to the Python community, or describing a new + feature for Python or its processes or environment. PEPs should + provide a concise technical specification and a rationale for proposed + features. + + PEPs are intended to be the primary mechanisms for proposing major new + features, for collecting community input on an issue, and for documenting + the design decisions that have gone into Python. The PEP author is + responsible for building consensus within the community and documenting + dissenting opinions. + + See :pep:`1`. + + portion + A set of files in a single directory (possibly stored in a zip file) + that contribute to a namespace package, as defined in :pep:`420`. + + positional argument + See :term:`argument`. + + provisional API + A provisional API is one which has been deliberately excluded from + the standard library's backwards compatibility guarantees. While major + changes to such interfaces are not expected, as long as they are marked + provisional, backwards incompatible changes (up to and including removal + of the interface) may occur if deemed necessary by core developers. Such + changes will not be made gratuitously -- they will occur only if serious + fundamental flaws are uncovered that were missed prior to the inclusion + of the API. + + Even for provisional APIs, backwards incompatible changes are seen as + a "solution of last resort" - every attempt will still be made to find + a backwards compatible resolution to any identified problems. + + This process allows the standard library to continue to evolve over + time, without locking in problematic design errors for extended periods + of time. See :pep:`411` for more details. + + provisional package + See :term:`provisional API`. + + Python 3000 + Nickname for the Python 3.x release line (coined long ago when the + release of version 3 was something in the distant future.) This is also + abbreviated "Py3k". + + Pythonic + An idea or piece of code which closely follows the most common idioms + of the Python language, rather than implementing code using concepts + common to other languages. For example, a common idiom in Python is + to loop over all elements of an iterable using a :keyword:`for` + statement. Many other languages don't have this type of construct, so + people unfamiliar with Python sometimes use a numerical counter instead:: + + for i in range(len(food)): + print(food[i]) + + As opposed to the cleaner, Pythonic method:: + + for piece in food: + print(piece) + + qualified name + A dotted name showing the "path" from a module's global scope to a + class, function or method defined in that module, as defined in + :pep:`3155`. For top-level functions and classes, the qualified name + is the same as the object's name:: + + >>> class C: + ... class D: + ... def meth(self): + ... pass + ... + >>> C.__qualname__ + 'C' + >>> C.D.__qualname__ + 'C.D' + >>> C.D.meth.__qualname__ + 'C.D.meth' + + When used to refer to modules, the *fully qualified name* means the + entire dotted path to the module, including any parent packages, + e.g. ``email.mime.text``:: + + >>> import email.mime.text + >>> email.mime.text.__name__ + 'email.mime.text' + + reference count + The number of references to an object. When the reference count of an + object drops to zero, it is deallocated. Reference counting is + generally not visible to Python code, but it is a key element of the + :term:`CPython` implementation. The :mod:`sys` module defines a + :func:`~sys.getrefcount` function that programmers can call to return the + reference count for a particular object. + + regular package + A traditional :term:`package`, such as a directory containing an + ``__init__.py`` file. + + See also :term:`namespace package`. + + __slots__ + A declaration inside a class that saves memory by pre-declaring space for + instance attributes and eliminating instance dictionaries. Though + popular, the technique is somewhat tricky to get right and is best + reserved for rare cases where there are large numbers of instances in a + memory-critical application. + + sequence + An :term:`iterable` which supports efficient element access using integer + indices via the :meth:`__getitem__` special method and defines a + :meth:`__len__` method that returns the length of the sequence. + Some built-in sequence types are :class:`list`, :class:`str`, + :class:`tuple`, and :class:`bytes`. Note that :class:`dict` also + supports :meth:`__getitem__` and :meth:`__len__`, but is considered a + mapping rather than a sequence because the lookups use arbitrary + :term:`immutable` keys rather than integers. + + The :class:`collections.abc.Sequence` abstract base class + defines a much richer interface that goes beyond just + :meth:`__getitem__` and :meth:`__len__`, adding :meth:`count`, + :meth:`index`, :meth:`__contains__`, and + :meth:`__reversed__`. Types that implement this expanded + interface can be registered explicitly using + :func:`~abc.register`. + + single dispatch + A form of :term:`generic function` dispatch where the implementation is + chosen based on the type of a single argument. + + slice + An object usually containing a portion of a :term:`sequence`. A slice is + created using the subscript notation, ``[]`` with colons between numbers + when several are given, such as in ``variable_name[1:3:5]``. The bracket + (subscript) notation uses :class:`slice` objects internally. + + special method + .. index:: pair: special; method + + A method that is called implicitly by Python to execute a certain + operation on a type, such as addition. Such methods have names starting + and ending with double underscores. Special methods are documented in + :ref:`specialnames`. + + statement + A statement is part of a suite (a "block" of code). A statement is either + an :term:`expression` or one of several constructs with a keyword, such + as :keyword:`if`, :keyword:`while` or :keyword:`for`. + + struct sequence + A tuple with named elements. Struct sequences expose an interface similar + to :term:`named tuple` in that elements can be accessed either by + index or as an attribute. However, they do not have any of the named tuple + methods like :meth:`~collections.somenamedtuple._make` or + :meth:`~collections.somenamedtuple._asdict`. Examples of struct sequences + include :data:`sys.float_info` and the return value of :func:`os.stat`. + + text encoding + A codec which encodes Unicode strings to bytes. + + text file + A :term:`file object` able to read and write :class:`str` objects. + Often, a text file actually accesses a byte-oriented datastream + and handles the :term:`text encoding` automatically. + Examples of text files are files opened in text mode (``'r'`` or ``'w'``), + :data:`sys.stdin`, :data:`sys.stdout`, and instances of + :class:`io.StringIO`. + + See also :term:`binary file` for a file object able to read and write + :term:`bytes-like objects `. + + triple-quoted string + A string which is bound by three instances of either a quotation mark + (") or an apostrophe ('). While they don't provide any functionality + not available with single-quoted strings, they are useful for a number + of reasons. They allow you to include unescaped single and double + quotes within a string and they can span multiple lines without the + use of the continuation character, making them especially useful when + writing docstrings. + + type + The type of a Python object determines what kind of object it is; every + object has a type. An object's type is accessible as its + :attr:`~instance.__class__` attribute or can be retrieved with + ``type(obj)``. + + type alias + A synonym for a type, created by assigning the type to an identifier. + + Type aliases are useful for simplifying :term:`type hints `. + For example:: + + from typing import List, Tuple + + def remove_gray_shades( + colors: List[Tuple[int, int, int]]) -> List[Tuple[int, int, int]]: + pass + + could be made more readable like this:: + + from typing import List, Tuple + + Color = Tuple[int, int, int] + + def remove_gray_shades(colors: List[Color]) -> List[Color]: + pass + + See :mod:`typing` and :pep:`484`, which describe this functionality. + + type hint + An :term:`annotation` that specifies the expected type for a variable, a class + attribute, or a function parameter or return value. + + Type hints are optional and are not enforced by Python but + they are useful to static type analysis tools, and aid IDEs with code + completion and refactoring. + + Type hints of global variables, class attributes, and functions, + but not local variables, can be accessed using + :func:`typing.get_type_hints`. + + See :mod:`typing` and :pep:`484`, which describe this functionality. + + universal newlines + A manner of interpreting text streams in which all of the following are + recognized as ending a line: the Unix end-of-line convention ``'\n'``, + the Windows convention ``'\r\n'``, and the old Macintosh convention + ``'\r'``. See :pep:`278` and :pep:`3116`, as well as + :func:`bytes.splitlines` for an additional use. + + variable annotation + An :term:`annotation` of a variable or a class attribute. + + When annotating a variable or a class attribute, assignment is optional:: + + class C: + field: 'annotation' + + Variable annotations are usually used for + :term:`type hints `: for example this variable is expected to take + :class:`int` values:: + + count: int = 0 + + Variable annotation syntax is explained in section :ref:`annassign`. + + See :term:`function annotation`, :pep:`484` + and :pep:`526`, which describe this functionality. + + virtual environment + A cooperatively isolated runtime environment that allows Python users + and applications to install and upgrade Python distribution packages + without interfering with the behaviour of other Python applications + running on the same system. + + See also :mod:`venv`. + + virtual machine + A computer defined entirely in software. Python's virtual machine + executes the :term:`bytecode` emitted by the bytecode compiler. + + Zen of Python + Listing of Python design principles and philosophies that are helpful in + understanding and using the language. The listing can be found by typing + "``import this``" at the interactive prompt. diff --git a/python-3.7.4-docs-html/_sources/howto/argparse.rst.txt b/python-3.7.4-docs-html/_sources/howto/argparse.rst.txt new file mode 100644 index 0000000..e78a022 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/howto/argparse.rst.txt @@ -0,0 +1,765 @@ +***************** +Argparse Tutorial +***************** + +:author: Tshepang Lekhonkhobe + +.. _argparse-tutorial: + +This tutorial is intended to be a gentle introduction to :mod:`argparse`, the +recommended command-line parsing module in the Python standard library. + +.. note:: + + There are two other modules that fulfill the same task, namely + :mod:`getopt` (an equivalent for :c:func:`getopt` from the C + language) and the deprecated :mod:`optparse`. + Note also that :mod:`argparse` is based on :mod:`optparse`, + and therefore very similar in terms of usage. + + +Concepts +======== + +Let's show the sort of functionality that we are going to explore in this +introductory tutorial by making use of the :command:`ls` command: + +.. code-block:: shell-session + + $ ls + cpython devguide prog.py pypy rm-unused-function.patch + $ ls pypy + ctypes_configure demo dotviewer include lib_pypy lib-python ... + $ ls -l + total 20 + drwxr-xr-x 19 wena wena 4096 Feb 18 18:51 cpython + drwxr-xr-x 4 wena wena 4096 Feb 8 12:04 devguide + -rwxr-xr-x 1 wena wena 535 Feb 19 00:05 prog.py + drwxr-xr-x 14 wena wena 4096 Feb 7 00:59 pypy + -rw-r--r-- 1 wena wena 741 Feb 18 01:01 rm-unused-function.patch + $ ls --help + Usage: ls [OPTION]... [FILE]... + List information about the FILEs (the current directory by default). + Sort entries alphabetically if none of -cftuvSUX nor --sort is specified. + ... + +A few concepts we can learn from the four commands: + +* The :command:`ls` command is useful when run without any options at all. It defaults + to displaying the contents of the current directory. + +* If we want beyond what it provides by default, we tell it a bit more. In + this case, we want it to display a different directory, ``pypy``. + What we did is specify what is known as a positional argument. It's named so + because the program should know what to do with the value, solely based on + where it appears on the command line. This concept is more relevant + to a command like :command:`cp`, whose most basic usage is ``cp SRC DEST``. + The first position is *what you want copied,* and the second + position is *where you want it copied to*. + +* Now, say we want to change behaviour of the program. In our example, + we display more info for each file instead of just showing the file names. + The ``-l`` in that case is known as an optional argument. + +* That's a snippet of the help text. It's very useful in that you can + come across a program you have never used before, and can figure out + how it works simply by reading its help text. + + +The basics +========== + +Let us start with a very simple example which does (almost) nothing:: + + import argparse + parser = argparse.ArgumentParser() + parser.parse_args() + +Following is a result of running the code: + +.. code-block:: shell-session + + $ python3 prog.py + $ python3 prog.py --help + usage: prog.py [-h] + + optional arguments: + -h, --help show this help message and exit + $ python3 prog.py --verbose + usage: prog.py [-h] + prog.py: error: unrecognized arguments: --verbose + $ python3 prog.py foo + usage: prog.py [-h] + prog.py: error: unrecognized arguments: foo + +Here is what is happening: + +* Running the script without any options results in nothing displayed to + stdout. Not so useful. + +* The second one starts to display the usefulness of the :mod:`argparse` + module. We have done almost nothing, but already we get a nice help message. + +* The ``--help`` option, which can also be shortened to ``-h``, is the only + option we get for free (i.e. no need to specify it). Specifying anything + else results in an error. But even then, we do get a useful usage message, + also for free. + + +Introducing Positional arguments +================================ + +An example:: + + import argparse + parser = argparse.ArgumentParser() + parser.add_argument("echo") + args = parser.parse_args() + print(args.echo) + +And running the code: + +.. code-block:: shell-session + + $ python3 prog.py + usage: prog.py [-h] echo + prog.py: error: the following arguments are required: echo + $ python3 prog.py --help + usage: prog.py [-h] echo + + positional arguments: + echo + + optional arguments: + -h, --help show this help message and exit + $ python3 prog.py foo + foo + +Here is what's happening: + +* We've added the :meth:`add_argument` method, which is what we use to specify + which command-line options the program is willing to accept. In this case, + I've named it ``echo`` so that it's in line with its function. + +* Calling our program now requires us to specify an option. + +* The :meth:`parse_args` method actually returns some data from the + options specified, in this case, ``echo``. + +* The variable is some form of 'magic' that :mod:`argparse` performs for free + (i.e. no need to specify which variable that value is stored in). + You will also notice that its name matches the string argument given + to the method, ``echo``. + +Note however that, although the help display looks nice and all, it currently +is not as helpful as it can be. For example we see that we got ``echo`` as a +positional argument, but we don't know what it does, other than by guessing or +by reading the source code. So, let's make it a bit more useful:: + + import argparse + parser = argparse.ArgumentParser() + parser.add_argument("echo", help="echo the string you use here") + args = parser.parse_args() + print(args.echo) + +And we get: + +.. code-block:: shell-session + + $ python3 prog.py -h + usage: prog.py [-h] echo + + positional arguments: + echo echo the string you use here + + optional arguments: + -h, --help show this help message and exit + +Now, how about doing something even more useful:: + + import argparse + parser = argparse.ArgumentParser() + parser.add_argument("square", help="display a square of a given number") + args = parser.parse_args() + print(args.square**2) + +Following is a result of running the code: + +.. code-block:: shell-session + + $ python3 prog.py 4 + Traceback (most recent call last): + File "prog.py", line 5, in + print(args.square**2) + TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int' + +That didn't go so well. That's because :mod:`argparse` treats the options we +give it as strings, unless we tell it otherwise. So, let's tell +:mod:`argparse` to treat that input as an integer:: + + import argparse + parser = argparse.ArgumentParser() + parser.add_argument("square", help="display a square of a given number", + type=int) + args = parser.parse_args() + print(args.square**2) + +Following is a result of running the code: + +.. code-block:: shell-session + + $ python3 prog.py 4 + 16 + $ python3 prog.py four + usage: prog.py [-h] square + prog.py: error: argument square: invalid int value: 'four' + +That went well. The program now even helpfully quits on bad illegal input +before proceeding. + + +Introducing Optional arguments +============================== + +So far we have been playing with positional arguments. Let us +have a look on how to add optional ones:: + + import argparse + parser = argparse.ArgumentParser() + parser.add_argument("--verbosity", help="increase output verbosity") + args = parser.parse_args() + if args.verbosity: + print("verbosity turned on") + +And the output: + +.. code-block:: shell-session + + $ python3 prog.py --verbosity 1 + verbosity turned on + $ python3 prog.py + $ python3 prog.py --help + usage: prog.py [-h] [--verbosity VERBOSITY] + + optional arguments: + -h, --help show this help message and exit + --verbosity VERBOSITY + increase output verbosity + $ python3 prog.py --verbosity + usage: prog.py [-h] [--verbosity VERBOSITY] + prog.py: error: argument --verbosity: expected one argument + +Here is what is happening: + +* The program is written so as to display something when ``--verbosity`` is + specified and display nothing when not. + +* To show that the option is actually optional, there is no error when running + the program without it. Note that by default, if an optional argument isn't + used, the relevant variable, in this case :attr:`args.verbosity`, is + given ``None`` as a value, which is the reason it fails the truth + test of the :keyword:`if` statement. + +* The help message is a bit different. + +* When using the ``--verbosity`` option, one must also specify some value, + any value. + +The above example accepts arbitrary integer values for ``--verbosity``, but for +our simple program, only two values are actually useful, ``True`` or ``False``. +Let's modify the code accordingly:: + + import argparse + parser = argparse.ArgumentParser() + parser.add_argument("--verbose", help="increase output verbosity", + action="store_true") + args = parser.parse_args() + if args.verbose: + print("verbosity turned on") + +And the output: + +.. code-block:: shell-session + + $ python3 prog.py --verbose + verbosity turned on + $ python3 prog.py --verbose 1 + usage: prog.py [-h] [--verbose] + prog.py: error: unrecognized arguments: 1 + $ python3 prog.py --help + usage: prog.py [-h] [--verbose] + + optional arguments: + -h, --help show this help message and exit + --verbose increase output verbosity + +Here is what is happening: + +* The option is now more of a flag than something that requires a value. + We even changed the name of the option to match that idea. + Note that we now specify a new keyword, ``action``, and give it the value + ``"store_true"``. This means that, if the option is specified, + assign the value ``True`` to :data:`args.verbose`. + Not specifying it implies ``False``. + +* It complains when you specify a value, in true spirit of what flags + actually are. + +* Notice the different help text. + + +Short options +------------- + +If you are familiar with command line usage, +you will notice that I haven't yet touched on the topic of short +versions of the options. It's quite simple:: + + import argparse + parser = argparse.ArgumentParser() + parser.add_argument("-v", "--verbose", help="increase output verbosity", + action="store_true") + args = parser.parse_args() + if args.verbose: + print("verbosity turned on") + +And here goes: + +.. code-block:: shell-session + + $ python3 prog.py -v + verbosity turned on + $ python3 prog.py --help + usage: prog.py [-h] [-v] + + optional arguments: + -h, --help show this help message and exit + -v, --verbose increase output verbosity + +Note that the new ability is also reflected in the help text. + + +Combining Positional and Optional arguments +=========================================== + +Our program keeps growing in complexity:: + + import argparse + parser = argparse.ArgumentParser() + parser.add_argument("square", type=int, + help="display a square of a given number") + parser.add_argument("-v", "--verbose", action="store_true", + help="increase output verbosity") + args = parser.parse_args() + answer = args.square**2 + if args.verbose: + print("the square of {} equals {}".format(args.square, answer)) + else: + print(answer) + +And now the output: + +.. code-block:: shell-session + + $ python3 prog.py + usage: prog.py [-h] [-v] square + prog.py: error: the following arguments are required: square + $ python3 prog.py 4 + 16 + $ python3 prog.py 4 --verbose + the square of 4 equals 16 + $ python3 prog.py --verbose 4 + the square of 4 equals 16 + +* We've brought back a positional argument, hence the complaint. + +* Note that the order does not matter. + +How about we give this program of ours back the ability to have +multiple verbosity values, and actually get to use them:: + + import argparse + parser = argparse.ArgumentParser() + parser.add_argument("square", type=int, + help="display a square of a given number") + parser.add_argument("-v", "--verbosity", type=int, + help="increase output verbosity") + args = parser.parse_args() + answer = args.square**2 + if args.verbosity == 2: + print("the square of {} equals {}".format(args.square, answer)) + elif args.verbosity == 1: + print("{}^2 == {}".format(args.square, answer)) + else: + print(answer) + +And the output: + +.. code-block:: shell-session + + $ python3 prog.py 4 + 16 + $ python3 prog.py 4 -v + usage: prog.py [-h] [-v VERBOSITY] square + prog.py: error: argument -v/--verbosity: expected one argument + $ python3 prog.py 4 -v 1 + 4^2 == 16 + $ python3 prog.py 4 -v 2 + the square of 4 equals 16 + $ python3 prog.py 4 -v 3 + 16 + +These all look good except the last one, which exposes a bug in our program. +Let's fix it by restricting the values the ``--verbosity`` option can accept:: + + import argparse + parser = argparse.ArgumentParser() + parser.add_argument("square", type=int, + help="display a square of a given number") + parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2], + help="increase output verbosity") + args = parser.parse_args() + answer = args.square**2 + if args.verbosity == 2: + print("the square of {} equals {}".format(args.square, answer)) + elif args.verbosity == 1: + print("{}^2 == {}".format(args.square, answer)) + else: + print(answer) + +And the output: + +.. code-block:: shell-session + + $ python3 prog.py 4 -v 3 + usage: prog.py [-h] [-v {0,1,2}] square + prog.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2) + $ python3 prog.py 4 -h + usage: prog.py [-h] [-v {0,1,2}] square + + positional arguments: + square display a square of a given number + + optional arguments: + -h, --help show this help message and exit + -v {0,1,2}, --verbosity {0,1,2} + increase output verbosity + +Note that the change also reflects both in the error message as well as the +help string. + +Now, let's use a different approach of playing with verbosity, which is pretty +common. It also matches the way the CPython executable handles its own +verbosity argument (check the output of ``python --help``):: + + import argparse + parser = argparse.ArgumentParser() + parser.add_argument("square", type=int, + help="display the square of a given number") + parser.add_argument("-v", "--verbosity", action="count", + help="increase output verbosity") + args = parser.parse_args() + answer = args.square**2 + if args.verbosity == 2: + print("the square of {} equals {}".format(args.square, answer)) + elif args.verbosity == 1: + print("{}^2 == {}".format(args.square, answer)) + else: + print(answer) + +We have introduced another action, "count", +to count the number of occurrences of a specific optional arguments: + +.. code-block:: shell-session + + $ python3 prog.py 4 + 16 + $ python3 prog.py 4 -v + 4^2 == 16 + $ python3 prog.py 4 -vv + the square of 4 equals 16 + $ python3 prog.py 4 --verbosity --verbosity + the square of 4 equals 16 + $ python3 prog.py 4 -v 1 + usage: prog.py [-h] [-v] square + prog.py: error: unrecognized arguments: 1 + $ python3 prog.py 4 -h + usage: prog.py [-h] [-v] square + + positional arguments: + square display a square of a given number + + optional arguments: + -h, --help show this help message and exit + -v, --verbosity increase output verbosity + $ python3 prog.py 4 -vvv + 16 + +* Yes, it's now more of a flag (similar to ``action="store_true"``) in the + previous version of our script. That should explain the complaint. + +* It also behaves similar to "store_true" action. + +* Now here's a demonstration of what the "count" action gives. You've probably + seen this sort of usage before. + +* And if you don't specify the ``-v`` flag, that flag is considered to have + ``None`` value. + +* As should be expected, specifying the long form of the flag, we should get + the same output. + +* Sadly, our help output isn't very informative on the new ability our script + has acquired, but that can always be fixed by improving the documentation for + our script (e.g. via the ``help`` keyword argument). + +* That last output exposes a bug in our program. + + +Let's fix:: + + import argparse + parser = argparse.ArgumentParser() + parser.add_argument("square", type=int, + help="display a square of a given number") + parser.add_argument("-v", "--verbosity", action="count", + help="increase output verbosity") + args = parser.parse_args() + answer = args.square**2 + + # bugfix: replace == with >= + if args.verbosity >= 2: + print("the square of {} equals {}".format(args.square, answer)) + elif args.verbosity >= 1: + print("{}^2 == {}".format(args.square, answer)) + else: + print(answer) + +And this is what it gives: + +.. code-block:: shell-session + + $ python3 prog.py 4 -vvv + the square of 4 equals 16 + $ python3 prog.py 4 -vvvv + the square of 4 equals 16 + $ python3 prog.py 4 + Traceback (most recent call last): + File "prog.py", line 11, in + if args.verbosity >= 2: + TypeError: '>=' not supported between instances of 'NoneType' and 'int' + + +* First output went well, and fixes the bug we had before. + That is, we want any value >= 2 to be as verbose as possible. + +* Third output not so good. + +Let's fix that bug:: + + import argparse + parser = argparse.ArgumentParser() + parser.add_argument("square", type=int, + help="display a square of a given number") + parser.add_argument("-v", "--verbosity", action="count", default=0, + help="increase output verbosity") + args = parser.parse_args() + answer = args.square**2 + if args.verbosity >= 2: + print("the square of {} equals {}".format(args.square, answer)) + elif args.verbosity >= 1: + print("{}^2 == {}".format(args.square, answer)) + else: + print(answer) + +We've just introduced yet another keyword, ``default``. +We've set it to ``0`` in order to make it comparable to the other int values. +Remember that by default, +if an optional argument isn't specified, +it gets the ``None`` value, and that cannot be compared to an int value +(hence the :exc:`TypeError` exception). + +And: + +.. code-block:: shell-session + + $ python3 prog.py 4 + 16 + +You can go quite far just with what we've learned so far, +and we have only scratched the surface. +The :mod:`argparse` module is very powerful, +and we'll explore a bit more of it before we end this tutorial. + + +Getting a little more advanced +============================== + +What if we wanted to expand our tiny program to perform other powers, +not just squares:: + + import argparse + parser = argparse.ArgumentParser() + parser.add_argument("x", type=int, help="the base") + parser.add_argument("y", type=int, help="the exponent") + parser.add_argument("-v", "--verbosity", action="count", default=0) + args = parser.parse_args() + answer = args.x**args.y + if args.verbosity >= 2: + print("{} to the power {} equals {}".format(args.x, args.y, answer)) + elif args.verbosity >= 1: + print("{}^{} == {}".format(args.x, args.y, answer)) + else: + print(answer) + +Output: + +.. code-block:: shell-session + + $ python3 prog.py + usage: prog.py [-h] [-v] x y + prog.py: error: the following arguments are required: x, y + $ python3 prog.py -h + usage: prog.py [-h] [-v] x y + + positional arguments: + x the base + y the exponent + + optional arguments: + -h, --help show this help message and exit + -v, --verbosity + $ python3 prog.py 4 2 -v + 4^2 == 16 + + +Notice that so far we've been using verbosity level to *change* the text +that gets displayed. The following example instead uses verbosity level +to display *more* text instead:: + + import argparse + parser = argparse.ArgumentParser() + parser.add_argument("x", type=int, help="the base") + parser.add_argument("y", type=int, help="the exponent") + parser.add_argument("-v", "--verbosity", action="count", default=0) + args = parser.parse_args() + answer = args.x**args.y + if args.verbosity >= 2: + print("Running '{}'".format(__file__)) + if args.verbosity >= 1: + print("{}^{} == ".format(args.x, args.y), end="") + print(answer) + +Output: + +.. code-block:: shell-session + + $ python3 prog.py 4 2 + 16 + $ python3 prog.py 4 2 -v + 4^2 == 16 + $ python3 prog.py 4 2 -vv + Running 'prog.py' + 4^2 == 16 + + +Conflicting options +------------------- + +So far, we have been working with two methods of an +:class:`argparse.ArgumentParser` instance. Let's introduce a third one, +:meth:`add_mutually_exclusive_group`. It allows for us to specify options that +conflict with each other. Let's also change the rest of the program so that +the new functionality makes more sense: +we'll introduce the ``--quiet`` option, +which will be the opposite of the ``--verbose`` one:: + + import argparse + + parser = argparse.ArgumentParser() + group = parser.add_mutually_exclusive_group() + group.add_argument("-v", "--verbose", action="store_true") + group.add_argument("-q", "--quiet", action="store_true") + parser.add_argument("x", type=int, help="the base") + parser.add_argument("y", type=int, help="the exponent") + args = parser.parse_args() + answer = args.x**args.y + + if args.quiet: + print(answer) + elif args.verbose: + print("{} to the power {} equals {}".format(args.x, args.y, answer)) + else: + print("{}^{} == {}".format(args.x, args.y, answer)) + +Our program is now simpler, and we've lost some functionality for the sake of +demonstration. Anyways, here's the output: + +.. code-block:: shell-session + + $ python3 prog.py 4 2 + 4^2 == 16 + $ python3 prog.py 4 2 -q + 16 + $ python3 prog.py 4 2 -v + 4 to the power 2 equals 16 + $ python3 prog.py 4 2 -vq + usage: prog.py [-h] [-v | -q] x y + prog.py: error: argument -q/--quiet: not allowed with argument -v/--verbose + $ python3 prog.py 4 2 -v --quiet + usage: prog.py [-h] [-v | -q] x y + prog.py: error: argument -q/--quiet: not allowed with argument -v/--verbose + +That should be easy to follow. I've added that last output so you can see the +sort of flexibility you get, i.e. mixing long form options with short form +ones. + +Before we conclude, you probably want to tell your users the main purpose of +your program, just in case they don't know:: + + import argparse + + parser = argparse.ArgumentParser(description="calculate X to the power of Y") + group = parser.add_mutually_exclusive_group() + group.add_argument("-v", "--verbose", action="store_true") + group.add_argument("-q", "--quiet", action="store_true") + parser.add_argument("x", type=int, help="the base") + parser.add_argument("y", type=int, help="the exponent") + args = parser.parse_args() + answer = args.x**args.y + + if args.quiet: + print(answer) + elif args.verbose: + print("{} to the power {} equals {}".format(args.x, args.y, answer)) + else: + print("{}^{} == {}".format(args.x, args.y, answer)) + +Note that slight difference in the usage text. Note the ``[-v | -q]``, +which tells us that we can either use ``-v`` or ``-q``, +but not both at the same time: + +.. code-block:: shell-session + + $ python3 prog.py --help + usage: prog.py [-h] [-v | -q] x y + + calculate X to the power of Y + + positional arguments: + x the base + y the exponent + + optional arguments: + -h, --help show this help message and exit + -v, --verbose + -q, --quiet + + +Conclusion +========== + +The :mod:`argparse` module offers a lot more than shown here. +Its docs are quite detailed and thorough, and full of examples. +Having gone through this tutorial, you should easily digest them +without feeling overwhelmed. diff --git a/python-3.7.4-docs-html/_sources/howto/clinic.rst.txt b/python-3.7.4-docs-html/_sources/howto/clinic.rst.txt new file mode 100644 index 0000000..695fbb1 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/howto/clinic.rst.txt @@ -0,0 +1,1734 @@ +.. highlightlang:: c + +********************** +Argument Clinic How-To +********************** + +:author: Larry Hastings + + +.. topic:: Abstract + + Argument Clinic is a preprocessor for CPython C files. + Its purpose is to automate all the boilerplate involved + with writing argument parsing code for "builtins". + This document shows you how to convert your first C + function to work with Argument Clinic, and then introduces + some advanced topics on Argument Clinic usage. + + Currently Argument Clinic is considered internal-only + for CPython. Its use is not supported for files outside + CPython, and no guarantees are made regarding backwards + compatibility for future versions. In other words: if you + maintain an external C extension for CPython, you're welcome + to experiment with Argument Clinic in your own code. But the + version of Argument Clinic that ships with the next version + of CPython *could* be totally incompatible and break all your code. + +The Goals Of Argument Clinic +============================ + +Argument Clinic's primary goal +is to take over responsibility for all argument parsing code +inside CPython. This means that, when you convert a function +to work with Argument Clinic, that function should no longer +do any of its own argument parsing—the code generated by +Argument Clinic should be a "black box" to you, where CPython +calls in at the top, and your code gets called at the bottom, +with ``PyObject *args`` (and maybe ``PyObject *kwargs``) +magically converted into the C variables and types you need. + +In order for Argument Clinic to accomplish its primary goal, +it must be easy to use. Currently, working with CPython's +argument parsing library is a chore, requiring maintaining +redundant information in a surprising number of places. +When you use Argument Clinic, you don't have to repeat yourself. + +Obviously, no one would want to use Argument Clinic unless +it's solving their problem—and without creating new problems of +its own. +So it's paramount that Argument Clinic generate correct code. +It'd be nice if the code was faster, too, but at the very least +it should not introduce a major speed regression. (Eventually Argument +Clinic *should* make a major speedup possible—we could +rewrite its code generator to produce tailor-made argument +parsing code, rather than calling the general-purpose CPython +argument parsing library. That would make for the fastest +argument parsing possible!) + +Additionally, Argument Clinic must be flexible enough to +work with any approach to argument parsing. Python has +some functions with some very strange parsing behaviors; +Argument Clinic's goal is to support all of them. + +Finally, the original motivation for Argument Clinic was +to provide introspection "signatures" for CPython builtins. +It used to be, the introspection query functions would throw +an exception if you passed in a builtin. With Argument +Clinic, that's a thing of the past! + +One idea you should keep in mind, as you work with +Argument Clinic: the more information you give it, the +better job it'll be able to do. +Argument Clinic is admittedly relatively simple right +now. But as it evolves it will get more sophisticated, +and it should be able to do many interesting and smart +things with all the information you give it. + + +Basic Concepts And Usage +======================== + +Argument Clinic ships with CPython; you'll find it in ``Tools/clinic/clinic.py``. +If you run that script, specifying a C file as an argument: + +.. code-block:: shell-session + + $ python3 Tools/clinic/clinic.py foo.c + +Argument Clinic will scan over the file looking for lines that +look exactly like this: + +.. code-block:: none + + /*[clinic input] + +When it finds one, it reads everything up to a line that looks +exactly like this: + +.. code-block:: none + + [clinic start generated code]*/ + +Everything in between these two lines is input for Argument Clinic. +All of these lines, including the beginning and ending comment +lines, are collectively called an Argument Clinic "block". + +When Argument Clinic parses one of these blocks, it +generates output. This output is rewritten into the C file +immediately after the block, followed by a comment containing a checksum. +The Argument Clinic block now looks like this: + +.. code-block:: none + + /*[clinic input] + ... clinic input goes here ... + [clinic start generated code]*/ + ... clinic output goes here ... + /*[clinic end generated code: checksum=...]*/ + +If you run Argument Clinic on the same file a second time, Argument Clinic +will discard the old output and write out the new output with a fresh checksum +line. However, if the input hasn't changed, the output won't change either. + +You should never modify the output portion of an Argument Clinic block. Instead, +change the input until it produces the output you want. (That's the purpose of the +checksum—to detect if someone changed the output, as these edits would be lost +the next time Argument Clinic writes out fresh output.) + +For the sake of clarity, here's the terminology we'll use with Argument Clinic: + +* The first line of the comment (``/*[clinic input]``) is the *start line*. +* The last line of the initial comment (``[clinic start generated code]*/``) is the *end line*. +* The last line (``/*[clinic end generated code: checksum=...]*/``) is the *checksum line*. +* In between the start line and the end line is the *input*. +* In between the end line and the checksum line is the *output*. +* All the text collectively, from the start line to the checksum line inclusively, + is the *block*. (A block that hasn't been successfully processed by Argument + Clinic yet doesn't have output or a checksum line, but it's still considered + a block.) + + +Converting Your First Function +============================== + +The best way to get a sense of how Argument Clinic works is to +convert a function to work with it. Here, then, are the bare +minimum steps you'd need to follow to convert a function to +work with Argument Clinic. Note that for code you plan to +check in to CPython, you really should take the conversion farther, +using some of the advanced concepts you'll see later on in +the document (like "return converters" and "self converters"). +But we'll keep it simple for this walkthrough so you can learn. + +Let's dive in! + +0. Make sure you're working with a freshly updated checkout + of the CPython trunk. + +1. Find a Python builtin that calls either :c:func:`PyArg_ParseTuple` + or :c:func:`PyArg_ParseTupleAndKeywords`, and hasn't been converted + to work with Argument Clinic yet. + For my example I'm using ``_pickle.Pickler.dump()``. + +2. If the call to the ``PyArg_Parse`` function uses any of the + following format units: + + .. code-block:: none + + O& + O! + es + es# + et + et# + + or if it has multiple calls to :c:func:`PyArg_ParseTuple`, + you should choose a different function. Argument Clinic *does* + support all of these scenarios. But these are advanced + topics—let's do something simpler for your first function. + + Also, if the function has multiple calls to :c:func:`PyArg_ParseTuple` + or :c:func:`PyArg_ParseTupleAndKeywords` where it supports different + types for the same argument, or if the function uses something besides + PyArg_Parse functions to parse its arguments, it probably + isn't suitable for conversion to Argument Clinic. Argument Clinic + doesn't support generic functions or polymorphic parameters. + +3. Add the following boilerplate above the function, creating our block:: + + /*[clinic input] + [clinic start generated code]*/ + +4. Cut the docstring and paste it in between the ``[clinic]`` lines, + removing all the junk that makes it a properly quoted C string. + When you're done you should have just the text, based at the left + margin, with no line wider than 80 characters. + (Argument Clinic will preserve indents inside the docstring.) + + If the old docstring had a first line that looked like a function + signature, throw that line away. (The docstring doesn't need it + anymore—when you use ``help()`` on your builtin in the future, + the first line will be built automatically based on the function's + signature.) + + Sample:: + + /*[clinic input] + Write a pickled representation of obj to the open file. + [clinic start generated code]*/ + +5. If your docstring doesn't have a "summary" line, Argument Clinic will + complain. So let's make sure it has one. The "summary" line should + be a paragraph consisting of a single 80-column line + at the beginning of the docstring. + + (Our example docstring consists solely of a summary line, so the sample + code doesn't have to change for this step.) + +6. Above the docstring, enter the name of the function, followed + by a blank line. This should be the Python name of the function, + and should be the full dotted path + to the function—it should start with the name of the module, + include any sub-modules, and if the function is a method on + a class it should include the class name too. + + Sample:: + + /*[clinic input] + _pickle.Pickler.dump + + Write a pickled representation of obj to the open file. + [clinic start generated code]*/ + +7. If this is the first time that module or class has been used with Argument + Clinic in this C file, + you must declare the module and/or class. Proper Argument Clinic hygiene + prefers declaring these in a separate block somewhere near the + top of the C file, in the same way that include files and statics go at + the top. (In our sample code we'll just show the two blocks next to + each other.) + + The name of the class and module should be the same as the one + seen by Python. Check the name defined in the :c:type:`PyModuleDef` + or :c:type:`PyTypeObject` as appropriate. + + When you declare a class, you must also specify two aspects of its type + in C: the type declaration you'd use for a pointer to an instance of + this class, and a pointer to the :c:type:`PyTypeObject` for this class. + + Sample:: + + /*[clinic input] + module _pickle + class _pickle.Pickler "PicklerObject *" "&Pickler_Type" + [clinic start generated code]*/ + + /*[clinic input] + _pickle.Pickler.dump + + Write a pickled representation of obj to the open file. + [clinic start generated code]*/ + + + + +8. Declare each of the parameters to the function. Each parameter + should get its own line. All the parameter lines should be + indented from the function name and the docstring. + + The general form of these parameter lines is as follows: + + .. code-block:: none + + name_of_parameter: converter + + If the parameter has a default value, add that after the + converter: + + .. code-block:: none + + name_of_parameter: converter = default_value + + Argument Clinic's support for "default values" is quite sophisticated; + please see :ref:`the section below on default values ` + for more information. + + Add a blank line below the parameters. + + What's a "converter"? It establishes both the type + of the variable used in C, and the method to convert the Python + value into a C value at runtime. + For now you're going to use what's called a "legacy converter"—a + convenience syntax intended to make porting old code into Argument + Clinic easier. + + For each parameter, copy the "format unit" for that + parameter from the ``PyArg_Parse()`` format argument and + specify *that* as its converter, as a quoted + string. ("format unit" is the formal name for the one-to-three + character substring of the ``format`` parameter that tells + the argument parsing function what the type of the variable + is and how to convert it. For more on format units please + see :ref:`arg-parsing`.) + + For multicharacter format units like ``z#``, use the + entire two-or-three character string. + + Sample:: + + /*[clinic input] + module _pickle + class _pickle.Pickler "PicklerObject *" "&Pickler_Type" + [clinic start generated code]*/ + + /*[clinic input] + _pickle.Pickler.dump + + obj: 'O' + + Write a pickled representation of obj to the open file. + [clinic start generated code]*/ + +9. If your function has ``|`` in the format string, meaning some + parameters have default values, you can ignore it. Argument + Clinic infers which parameters are optional based on whether + or not they have default values. + + If your function has ``$`` in the format string, meaning it + takes keyword-only arguments, specify ``*`` on a line by + itself before the first keyword-only argument, indented the + same as the parameter lines. + + (``_pickle.Pickler.dump`` has neither, so our sample is unchanged.) + + +10. If the existing C function calls :c:func:`PyArg_ParseTuple` + (as opposed to :c:func:`PyArg_ParseTupleAndKeywords`), then all its + arguments are positional-only. + + To mark all parameters as positional-only in Argument Clinic, + add a ``/`` on a line by itself after the last parameter, + indented the same as the parameter lines. + + Currently this is all-or-nothing; either all parameters are + positional-only, or none of them are. (In the future Argument + Clinic may relax this restriction.) + + Sample:: + + /*[clinic input] + module _pickle + class _pickle.Pickler "PicklerObject *" "&Pickler_Type" + [clinic start generated code]*/ + + /*[clinic input] + _pickle.Pickler.dump + + obj: 'O' + / + + Write a pickled representation of obj to the open file. + [clinic start generated code]*/ + +11. It's helpful to write a per-parameter docstring for each parameter. + But per-parameter docstrings are optional; you can skip this step + if you prefer. + + Here's how to add a per-parameter docstring. The first line + of the per-parameter docstring must be indented further than the + parameter definition. The left margin of this first line establishes + the left margin for the whole per-parameter docstring; all the text + you write will be outdented by this amount. You can write as much + text as you like, across multiple lines if you wish. + + Sample:: + + /*[clinic input] + module _pickle + class _pickle.Pickler "PicklerObject *" "&Pickler_Type" + [clinic start generated code]*/ + + /*[clinic input] + _pickle.Pickler.dump + + obj: 'O' + The object to be pickled. + / + + Write a pickled representation of obj to the open file. + [clinic start generated code]*/ + +12. Save and close the file, then run ``Tools/clinic/clinic.py`` on + it. With luck everything worked---your block now has output, and + a ``.c.h`` file has been generated! Reopen the file in your + text editor to see:: + + /*[clinic input] + _pickle.Pickler.dump + + obj: 'O' + The object to be pickled. + / + + Write a pickled representation of obj to the open file. + [clinic start generated code]*/ + + static PyObject * + _pickle_Pickler_dump(PicklerObject *self, PyObject *obj) + /*[clinic end generated code: output=87ecad1261e02ac7 input=552eb1c0f52260d9]*/ + + Obviously, if Argument Clinic didn't produce any output, it's because + it found an error in your input. Keep fixing your errors and retrying + until Argument Clinic processes your file without complaint. + + For readability, most of the glue code has been generated to a ``.c.h`` + file. You'll need to include that in your original ``.c`` file, + typically right after the clinic module block:: + + #include "clinic/_pickle.c.h" + +13. Double-check that the argument-parsing code Argument Clinic generated + looks basically the same as the existing code. + + First, ensure both places use the same argument-parsing function. + The existing code must call either + :c:func:`PyArg_ParseTuple` or :c:func:`PyArg_ParseTupleAndKeywords`; + ensure that the code generated by Argument Clinic calls the + *exact* same function. + + Second, the format string passed in to :c:func:`PyArg_ParseTuple` or + :c:func:`PyArg_ParseTupleAndKeywords` should be *exactly* the same + as the hand-written one in the existing function, up to the colon + or semi-colon. + + (Argument Clinic always generates its format strings + with a ``:`` followed by the name of the function. If the + existing code's format string ends with ``;``, to provide + usage help, this change is harmless—don't worry about it.) + + Third, for parameters whose format units require two arguments + (like a length variable, or an encoding string, or a pointer + to a conversion function), ensure that the second argument is + *exactly* the same between the two invocations. + + Fourth, inside the output portion of the block you'll find a preprocessor + macro defining the appropriate static :c:type:`PyMethodDef` structure for + this builtin:: + + #define __PICKLE_PICKLER_DUMP_METHODDEF \ + {"dump", (PyCFunction)__pickle_Pickler_dump, METH_O, __pickle_Pickler_dump__doc__}, + + This static structure should be *exactly* the same as the existing static + :c:type:`PyMethodDef` structure for this builtin. + + If any of these items differ in *any way*, + adjust your Argument Clinic function specification and rerun + ``Tools/clinic/clinic.py`` until they *are* the same. + + +14. Notice that the last line of its output is the declaration + of your "impl" function. This is where the builtin's implementation goes. + Delete the existing prototype of the function you're modifying, but leave + the opening curly brace. Now delete its argument parsing code and the + declarations of all the variables it dumps the arguments into. + Notice how the Python arguments are now arguments to this impl function; + if the implementation used different names for these variables, fix it. + + Let's reiterate, just because it's kind of weird. Your code should now + look like this:: + + static return_type + your_function_impl(...) + /*[clinic end generated code: checksum=...]*/ + { + ... + + Argument Clinic generated the checksum line and the function prototype just + above it. You should write the opening (and closing) curly braces for the + function, and the implementation inside. + + Sample:: + + /*[clinic input] + module _pickle + class _pickle.Pickler "PicklerObject *" "&Pickler_Type" + [clinic start generated code]*/ + /*[clinic end generated code: checksum=da39a3ee5e6b4b0d3255bfef95601890afd80709]*/ + + /*[clinic input] + _pickle.Pickler.dump + + obj: 'O' + The object to be pickled. + / + + Write a pickled representation of obj to the open file. + [clinic start generated code]*/ + + PyDoc_STRVAR(__pickle_Pickler_dump__doc__, + "Write a pickled representation of obj to the open file.\n" + "\n" + ... + static PyObject * + _pickle_Pickler_dump_impl(PicklerObject *self, PyObject *obj) + /*[clinic end generated code: checksum=3bd30745bf206a48f8b576a1da3d90f55a0a4187]*/ + { + /* Check whether the Pickler was initialized correctly (issue3664). + Developers often forget to call __init__() in their subclasses, which + would trigger a segfault without this check. */ + if (self->write == NULL) { + PyErr_Format(PicklingError, + "Pickler.__init__() was not called by %s.__init__()", + Py_TYPE(self)->tp_name); + return NULL; + } + + if (_Pickler_ClearBuffer(self) < 0) + return NULL; + + ... + +15. Remember the macro with the :c:type:`PyMethodDef` structure for this + function? Find the existing :c:type:`PyMethodDef` structure for this + function and replace it with a reference to the macro. (If the builtin + is at module scope, this will probably be very near the end of the file; + if the builtin is a class method, this will probably be below but relatively + near to the implementation.) + + Note that the body of the macro contains a trailing comma. So when you + replace the existing static :c:type:`PyMethodDef` structure with the macro, + *don't* add a comma to the end. + + Sample:: + + static struct PyMethodDef Pickler_methods[] = { + __PICKLE_PICKLER_DUMP_METHODDEF + __PICKLE_PICKLER_CLEAR_MEMO_METHODDEF + {NULL, NULL} /* sentinel */ + }; + + +16. Compile, then run the relevant portions of the regression-test suite. + This change should not introduce any new compile-time warnings or errors, + and there should be no externally-visible change to Python's behavior. + + Well, except for one difference: ``inspect.signature()`` run on your function + should now provide a valid signature! + + Congratulations, you've ported your first function to work with Argument Clinic! + +Advanced Topics +=============== + +Now that you've had some experience working with Argument Clinic, it's time +for some advanced topics. + + +Symbolic default values +----------------------- + +The default value you provide for a parameter can't be any arbitrary +expression. Currently the following are explicitly supported: + +* Numeric constants (integer and float) +* String constants +* ``True``, ``False``, and ``None`` +* Simple symbolic constants like ``sys.maxsize``, which must + start with the name of the module + +In case you're curious, this is implemented in ``from_builtin()`` +in ``Lib/inspect.py``. + +(In the future, this may need to get even more elaborate, +to allow full expressions like ``CONSTANT - 1``.) + + +Renaming the C functions and variables generated by Argument Clinic +------------------------------------------------------------------- + +Argument Clinic automatically names the functions it generates for you. +Occasionally this may cause a problem, if the generated name collides with +the name of an existing C function. There's an easy solution: override the names +used for the C functions. Just add the keyword ``"as"`` +to your function declaration line, followed by the function name you wish to use. +Argument Clinic will use that function name for the base (generated) function, +then add ``"_impl"`` to the end and use that for the name of the impl function. + +For example, if we wanted to rename the C function names generated for +``pickle.Pickler.dump``, it'd look like this:: + + /*[clinic input] + pickle.Pickler.dump as pickler_dumper + + ... + +The base function would now be named ``pickler_dumper()``, +and the impl function would now be named ``pickler_dumper_impl()``. + + +Similarly, you may have a problem where you want to give a parameter +a specific Python name, but that name may be inconvenient in C. Argument +Clinic allows you to give a parameter different names in Python and in C, +using the same ``"as"`` syntax:: + + /*[clinic input] + pickle.Pickler.dump + + obj: object + file as file_obj: object + protocol: object = NULL + * + fix_imports: bool = True + +Here, the name used in Python (in the signature and the ``keywords`` +array) would be ``file``, but the C variable would be named ``file_obj``. + +You can use this to rename the ``self`` parameter too! + + +Converting functions using PyArg_UnpackTuple +-------------------------------------------- + +To convert a function parsing its arguments with :c:func:`PyArg_UnpackTuple`, +simply write out all the arguments, specifying each as an ``object``. You +may specify the ``type`` argument to cast the type as appropriate. All +arguments should be marked positional-only (add a ``/`` on a line by itself +after the last argument). + +Currently the generated code will use :c:func:`PyArg_ParseTuple`, but this +will change soon. + +Optional Groups +--------------- + +Some legacy functions have a tricky approach to parsing their arguments: +they count the number of positional arguments, then use a ``switch`` statement +to call one of several different :c:func:`PyArg_ParseTuple` calls depending on +how many positional arguments there are. (These functions cannot accept +keyword-only arguments.) This approach was used to simulate optional +arguments back before :c:func:`PyArg_ParseTupleAndKeywords` was created. + +While functions using this approach can often be converted to +use :c:func:`PyArg_ParseTupleAndKeywords`, optional arguments, and default values, +it's not always possible. Some of these legacy functions have +behaviors :c:func:`PyArg_ParseTupleAndKeywords` doesn't directly support. +The most obvious example is the builtin function ``range()``, which has +an optional argument on the *left* side of its required argument! +Another example is ``curses.window.addch()``, which has a group of two +arguments that must always be specified together. (The arguments are +called ``x`` and ``y``; if you call the function passing in ``x``, +you must also pass in ``y``—and if you don't pass in ``x`` you may not +pass in ``y`` either.) + +In any case, the goal of Argument Clinic is to support argument parsing +for all existing CPython builtins without changing their semantics. +Therefore Argument Clinic supports +this alternate approach to parsing, using what are called *optional groups*. +Optional groups are groups of arguments that must all be passed in together. +They can be to the left or the right of the required arguments. They +can *only* be used with positional-only parameters. + +.. note:: Optional groups are *only* intended for use when converting + functions that make multiple calls to :c:func:`PyArg_ParseTuple`! + Functions that use *any* other approach for parsing arguments + should *almost never* be converted to Argument Clinic using + optional groups. Functions using optional groups currently + cannot have accurate signatures in Python, because Python just + doesn't understand the concept. Please avoid using optional + groups wherever possible. + +To specify an optional group, add a ``[`` on a line by itself before +the parameters you wish to group together, and a ``]`` on a line by itself +after these parameters. As an example, here's how ``curses.window.addch`` +uses optional groups to make the first two parameters and the last +parameter optional:: + + /*[clinic input] + + curses.window.addch + + [ + x: int + X-coordinate. + y: int + Y-coordinate. + ] + + ch: object + Character to add. + + [ + attr: long + Attributes for the character. + ] + / + + ... + + +Notes: + +* For every optional group, one additional parameter will be passed into the + impl function representing the group. The parameter will be an int named + ``group_{direction}_{number}``, + where ``{direction}`` is either ``right`` or ``left`` depending on whether the group + is before or after the required parameters, and ``{number}`` is a monotonically + increasing number (starting at 1) indicating how far away the group is from + the required parameters. When the impl is called, this parameter will be set + to zero if this group was unused, and set to non-zero if this group was used. + (By used or unused, I mean whether or not the parameters received arguments + in this invocation.) + +* If there are no required arguments, the optional groups will behave + as if they're to the right of the required arguments. + +* In the case of ambiguity, the argument parsing code + favors parameters on the left (before the required parameters). + +* Optional groups can only contain positional-only parameters. + +* Optional groups are *only* intended for legacy code. Please do not + use optional groups for new code. + + +Using real Argument Clinic converters, instead of "legacy converters" +--------------------------------------------------------------------- + +To save time, and to minimize how much you need to learn +to achieve your first port to Argument Clinic, the walkthrough above tells +you to use "legacy converters". "Legacy converters" are a convenience, +designed explicitly to make porting existing code to Argument Clinic +easier. And to be clear, their use is acceptable when porting code for +Python 3.4. + +However, in the long term we probably want all our blocks to +use Argument Clinic's real syntax for converters. Why? A couple +reasons: + +* The proper converters are far easier to read and clearer in their intent. +* There are some format units that are unsupported as "legacy converters", + because they require arguments, and the legacy converter syntax doesn't + support specifying arguments. +* In the future we may have a new argument parsing library that isn't + restricted to what :c:func:`PyArg_ParseTuple` supports; this flexibility + won't be available to parameters using legacy converters. + +Therefore, if you don't mind a little extra effort, please use the normal +converters instead of legacy converters. + +In a nutshell, the syntax for Argument Clinic (non-legacy) converters +looks like a Python function call. However, if there are no explicit +arguments to the function (all functions take their default values), +you may omit the parentheses. Thus ``bool`` and ``bool()`` are exactly +the same converters. + +All arguments to Argument Clinic converters are keyword-only. +All Argument Clinic converters accept the following arguments: + + ``c_default`` + The default value for this parameter when defined in C. + Specifically, this will be the initializer for the variable declared + in the "parse function". See :ref:`the section on default values ` + for how to use this. + Specified as a string. + + ``annotation`` + The annotation value for this parameter. Not currently supported, + because PEP 8 mandates that the Python library may not use + annotations. + +In addition, some converters accept additional arguments. Here is a list +of these arguments, along with their meanings: + + ``accept`` + A set of Python types (and possibly pseudo-types); + this restricts the allowable Python argument to values of these types. + (This is not a general-purpose facility; as a rule it only supports + specific lists of types as shown in the legacy converter table.) + + To accept ``None``, add ``NoneType`` to this set. + + ``bitwise`` + Only supported for unsigned integers. The native integer value of this + Python argument will be written to the parameter without any range checking, + even for negative values. + + ``converter`` + Only supported by the ``object`` converter. Specifies the name of a + :ref:`C "converter function" ` + to use to convert this object to a native type. + + ``encoding`` + Only supported for strings. Specifies the encoding to use when converting + this string from a Python str (Unicode) value into a C ``char *`` value. + + + ``subclass_of`` + Only supported for the ``object`` converter. Requires that the Python + value be a subclass of a Python type, as expressed in C. + + ``type`` + Only supported for the ``object`` and ``self`` converters. Specifies + the C type that will be used to declare the variable. Default value is + ``"PyObject *"``. + + ``zeroes`` + Only supported for strings. If true, embedded NUL bytes (``'\\0'``) are + permitted inside the value. The length of the string will be passed in + to the impl function, just after the string parameter, as a parameter named + ``_length``. + +Please note, not every possible combination of arguments will work. +Usually these arguments are implemented by specific ``PyArg_ParseTuple`` +*format units*, with specific behavior. For example, currently you cannot +call ``unsigned_short`` without also specifying ``bitwise=True``. +Although it's perfectly reasonable to think this would work, these semantics don't +map to any existing format unit. So Argument Clinic doesn't support it. (Or, at +least, not yet.) + +Below is a table showing the mapping of legacy converters into real +Argument Clinic converters. On the left is the legacy converter, +on the right is the text you'd replace it with. + +========= ================================================================================= +``'B'`` ``unsigned_char(bitwise=True)`` +``'b'`` ``unsigned_char`` +``'c'`` ``char`` +``'C'`` ``int(accept={str})`` +``'d'`` ``double`` +``'D'`` ``Py_complex`` +``'es'`` ``str(encoding='name_of_encoding')`` +``'es#'`` ``str(encoding='name_of_encoding', zeroes=True)`` +``'et'`` ``str(encoding='name_of_encoding', accept={bytes, bytearray, str})`` +``'et#'`` ``str(encoding='name_of_encoding', accept={bytes, bytearray, str}, zeroes=True)`` +``'f'`` ``float`` +``'h'`` ``short`` +``'H'`` ``unsigned_short(bitwise=True)`` +``'i'`` ``int`` +``'I'`` ``unsigned_int(bitwise=True)`` +``'k'`` ``unsigned_long(bitwise=True)`` +``'K'`` ``unsigned_long_long(bitwise=True)`` +``'l'`` ``long`` +``'L'`` ``long long`` +``'n'`` ``Py_ssize_t`` +``'O'`` ``object`` +``'O!'`` ``object(subclass_of='&PySomething_Type')`` +``'O&'`` ``object(converter='name_of_c_function')`` +``'p'`` ``bool`` +``'S'`` ``PyBytesObject`` +``'s'`` ``str`` +``'s#'`` ``str(zeroes=True)`` +``'s*'`` ``Py_buffer(accept={buffer, str})`` +``'U'`` ``unicode`` +``'u'`` ``Py_UNICODE`` +``'u#'`` ``Py_UNICODE(zeroes=True)`` +``'w*'`` ``Py_buffer(accept={rwbuffer})`` +``'Y'`` ``PyByteArrayObject`` +``'y'`` ``str(accept={bytes})`` +``'y#'`` ``str(accept={robuffer}, zeroes=True)`` +``'y*'`` ``Py_buffer`` +``'Z'`` ``Py_UNICODE(accept={str, NoneType})`` +``'Z#'`` ``Py_UNICODE(accept={str, NoneType}, zeroes=True)`` +``'z'`` ``str(accept={str, NoneType})`` +``'z#'`` ``str(accept={str, NoneType}, zeroes=True)`` +``'z*'`` ``Py_buffer(accept={buffer, str, NoneType})`` +========= ================================================================================= + +As an example, here's our sample ``pickle.Pickler.dump`` using the proper +converter:: + + /*[clinic input] + pickle.Pickler.dump + + obj: object + The object to be pickled. + / + + Write a pickled representation of obj to the open file. + [clinic start generated code]*/ + +Argument Clinic will show you all the converters it has +available. For each converter it'll show you all the parameters +it accepts, along with the default value for each parameter. +Just run ``Tools/clinic/clinic.py --converters`` to see the full list. + +Py_buffer +--------- + +When using the ``Py_buffer`` converter +(or the ``'s*'``, ``'w*'``, ``'*y'``, or ``'z*'`` legacy converters), +you *must* not call :c:func:`PyBuffer_Release` on the provided buffer. +Argument Clinic generates code that does it for you (in the parsing function). + + + +Advanced converters +------------------- + +Remember those format units you skipped for your first +time because they were advanced? Here's how to handle those too. + +The trick is, all those format units take arguments—either +conversion functions, or types, or strings specifying an encoding. +(But "legacy converters" don't support arguments. That's why we +skipped them for your first function.) The argument you specified +to the format unit is now an argument to the converter; this +argument is either ``converter`` (for ``O&``), ``subclass_of`` (for ``O!``), +or ``encoding`` (for all the format units that start with ``e``). + +When using ``subclass_of``, you may also want to use the other +custom argument for ``object()``: ``type``, which lets you set the type +actually used for the parameter. For example, if you want to ensure +that the object is a subclass of ``PyUnicode_Type``, you probably want +to use the converter ``object(type='PyUnicodeObject *', subclass_of='&PyUnicode_Type')``. + +One possible problem with using Argument Clinic: it takes away some possible +flexibility for the format units starting with ``e``. When writing a +``PyArg_Parse`` call by hand, you could theoretically decide at runtime what +encoding string to pass in to :c:func:`PyArg_ParseTuple`. But now this string must +be hard-coded at Argument-Clinic-preprocessing-time. This limitation is deliberate; +it made supporting this format unit much easier, and may allow for future optimizations. +This restriction doesn't seem unreasonable; CPython itself always passes in static +hard-coded encoding strings for parameters whose format units start with ``e``. + + +.. _default_values: + +Parameter default values +------------------------ + +Default values for parameters can be any of a number of values. +At their simplest, they can be string, int, or float literals: + +.. code-block:: none + + foo: str = "abc" + bar: int = 123 + bat: float = 45.6 + +They can also use any of Python's built-in constants: + +.. code-block:: none + + yep: bool = True + nope: bool = False + nada: object = None + +There's also special support for a default value of ``NULL``, and +for simple expressions, documented in the following sections. + + +The ``NULL`` default value +-------------------------- + +For string and object parameters, you can set them to ``None`` to indicate +that there's no default. However, that means the C variable will be +initialized to ``Py_None``. For convenience's sakes, there's a special +value called ``NULL`` for just this reason: from Python's perspective it +behaves like a default value of ``None``, but the C variable is initialized +with ``NULL``. + +Expressions specified as default values +--------------------------------------- + +The default value for a parameter can be more than just a literal value. +It can be an entire expression, using math operators and looking up attributes +on objects. However, this support isn't exactly simple, because of some +non-obvious semantics. + +Consider the following example: + +.. code-block:: none + + foo: Py_ssize_t = sys.maxsize - 1 + +``sys.maxsize`` can have different values on different platforms. Therefore +Argument Clinic can't simply evaluate that expression locally and hard-code it +in C. So it stores the default in such a way that it will get evaluated at +runtime, when the user asks for the function's signature. + +What namespace is available when the expression is evaluated? It's evaluated +in the context of the module the builtin came from. So, if your module has an +attribute called "``max_widgets``", you may simply use it: + +.. code-block:: none + + foo: Py_ssize_t = max_widgets + +If the symbol isn't found in the current module, it fails over to looking in +``sys.modules``. That's how it can find ``sys.maxsize`` for example. (Since you +don't know in advance what modules the user will load into their interpreter, +it's best to restrict yourself to modules that are preloaded by Python itself.) + +Evaluating default values only at runtime means Argument Clinic can't compute +the correct equivalent C default value. So you need to tell it explicitly. +When you use an expression, you must also specify the equivalent expression +in C, using the ``c_default`` parameter to the converter: + +.. code-block:: none + + foo: Py_ssize_t(c_default="PY_SSIZE_T_MAX - 1") = sys.maxsize - 1 + +Another complication: Argument Clinic can't know in advance whether or not the +expression you supply is valid. It parses it to make sure it looks legal, but +it can't *actually* know. You must be very careful when using expressions to +specify values that are guaranteed to be valid at runtime! + +Finally, because expressions must be representable as static C values, there +are many restrictions on legal expressions. Here's a list of Python features +you're not permitted to use: + +* Function calls. +* Inline if statements (``3 if foo else 5``). +* Automatic sequence unpacking (``*[1, 2, 3]``). +* List/set/dict comprehensions and generator expressions. +* Tuple/list/set/dict literals. + + + +Using a return converter +------------------------ + +By default the impl function Argument Clinic generates for you returns ``PyObject *``. +But your C function often computes some C type, then converts it into the ``PyObject *`` +at the last moment. Argument Clinic handles converting your inputs from Python types +into native C types—why not have it convert your return value from a native C type +into a Python type too? + +That's what a "return converter" does. It changes your impl function to return +some C type, then adds code to the generated (non-impl) function to handle converting +that value into the appropriate ``PyObject *``. + +The syntax for return converters is similar to that of parameter converters. +You specify the return converter like it was a return annotation on the +function itself. Return converters behave much the same as parameter converters; +they take arguments, the arguments are all keyword-only, and if you're not changing +any of the default arguments you can omit the parentheses. + +(If you use both ``"as"`` *and* a return converter for your function, +the ``"as"`` should come before the return converter.) + +There's one additional complication when using return converters: how do you +indicate an error has occurred? Normally, a function returns a valid (non-``NULL``) +pointer for success, and ``NULL`` for failure. But if you use an integer return converter, +all integers are valid. How can Argument Clinic detect an error? Its solution: each return +converter implicitly looks for a special value that indicates an error. If you return +that value, and an error has been set (``PyErr_Occurred()`` returns a true +value), then the generated code will propagate the error. Otherwise it will +encode the value you return like normal. + +Currently Argument Clinic supports only a few return converters: + +.. code-block:: none + + bool + int + unsigned int + long + unsigned int + size_t + Py_ssize_t + float + double + DecodeFSDefault + +None of these take parameters. For the first three, return -1 to indicate +error. For ``DecodeFSDefault``, the return type is ``const char *``; return a NULL +pointer to indicate an error. + +(There's also an experimental ``NoneType`` converter, which lets you +return ``Py_None`` on success or ``NULL`` on failure, without having +to increment the reference count on ``Py_None``. I'm not sure it adds +enough clarity to be worth using.) + +To see all the return converters Argument Clinic supports, along with +their parameters (if any), +just run ``Tools/clinic/clinic.py --converters`` for the full list. + + +Cloning existing functions +-------------------------- + +If you have a number of functions that look similar, you may be able to +use Clinic's "clone" feature. When you clone an existing function, +you reuse: + +* its parameters, including + + * their names, + + * their converters, with all parameters, + + * their default values, + + * their per-parameter docstrings, + + * their *kind* (whether they're positional only, + positional or keyword, or keyword only), and + +* its return converter. + +The only thing not copied from the original function is its docstring; +the syntax allows you to specify a new docstring. + +Here's the syntax for cloning a function:: + + /*[clinic input] + module.class.new_function [as c_basename] = module.class.existing_function + + Docstring for new_function goes here. + [clinic start generated code]*/ + +(The functions can be in different modules or classes. I wrote +``module.class`` in the sample just to illustrate that you must +use the full path to *both* functions.) + +Sorry, there's no syntax for partially-cloning a function, or cloning a function +then modifying it. Cloning is an all-or nothing proposition. + +Also, the function you are cloning from must have been previously defined +in the current file. + +Calling Python code +------------------- + +The rest of the advanced topics require you to write Python code +which lives inside your C file and modifies Argument Clinic's +runtime state. This is simple: you simply define a Python block. + +A Python block uses different delimiter lines than an Argument +Clinic function block. It looks like this:: + + /*[python input] + # python code goes here + [python start generated code]*/ + +All the code inside the Python block is executed at the +time it's parsed. All text written to stdout inside the block +is redirected into the "output" after the block. + +As an example, here's a Python block that adds a static integer +variable to the C code:: + + /*[python input] + print('static int __ignored_unused_variable__ = 0;') + [python start generated code]*/ + static int __ignored_unused_variable__ = 0; + /*[python checksum:...]*/ + + +Using a "self converter" +------------------------ + +Argument Clinic automatically adds a "self" parameter for you +using a default converter. It automatically sets the ``type`` +of this parameter to the "pointer to an instance" you specified +when you declared the type. However, you can override +Argument Clinic's converter and specify one yourself. +Just add your own ``self`` parameter as the first parameter in a +block, and ensure that its converter is an instance of +``self_converter`` or a subclass thereof. + +What's the point? This lets you override the type of ``self``, +or give it a different default name. + +How do you specify the custom type you want to cast ``self`` to? +If you only have one or two functions with the same type for ``self``, +you can directly use Argument Clinic's existing ``self`` converter, +passing in the type you want to use as the ``type`` parameter:: + + /*[clinic input] + + _pickle.Pickler.dump + + self: self(type="PicklerObject *") + obj: object + / + + Write a pickled representation of the given object to the open file. + [clinic start generated code]*/ + +On the other hand, if you have a lot of functions that will use the same +type for ``self``, it's best to create your own converter, subclassing +``self_converter`` but overwriting the ``type`` member:: + + /*[python input] + class PicklerObject_converter(self_converter): + type = "PicklerObject *" + [python start generated code]*/ + + /*[clinic input] + + _pickle.Pickler.dump + + self: PicklerObject + obj: object + / + + Write a pickled representation of the given object to the open file. + [clinic start generated code]*/ + + + +Writing a custom converter +-------------------------- + +As we hinted at in the previous section... you can write your own converters! +A converter is simply a Python class that inherits from ``CConverter``. +The main purpose of a custom converter is if you have a parameter using +the ``O&`` format unit—parsing this parameter means calling +a :c:func:`PyArg_ParseTuple` "converter function". + +Your converter class should be named ``*something*_converter``. +If the name follows this convention, then your converter class +will be automatically registered with Argument Clinic; its name +will be the name of your class with the ``_converter`` suffix +stripped off. (This is accomplished with a metaclass.) + +You shouldn't subclass ``CConverter.__init__``. Instead, you should +write a ``converter_init()`` function. ``converter_init()`` +always accepts a ``self`` parameter; after that, all additional +parameters *must* be keyword-only. Any arguments passed in to +the converter in Argument Clinic will be passed along to your +``converter_init()``. + +There are some additional members of ``CConverter`` you may wish +to specify in your subclass. Here's the current list: + +``type`` + The C type to use for this variable. + ``type`` should be a Python string specifying the type, e.g. ``int``. + If this is a pointer type, the type string should end with ``' *'``. + +``default`` + The Python default value for this parameter, as a Python value. + Or the magic value ``unspecified`` if there is no default. + +``py_default`` + ``default`` as it should appear in Python code, + as a string. + Or ``None`` if there is no default. + +``c_default`` + ``default`` as it should appear in C code, + as a string. + Or ``None`` if there is no default. + +``c_ignored_default`` + The default value used to initialize the C variable when + there is no default, but not specifying a default may + result in an "uninitialized variable" warning. This can + easily happen when using option groups—although + properly-written code will never actually use this value, + the variable does get passed in to the impl, and the + C compiler will complain about the "use" of the + uninitialized value. This value should always be a + non-empty string. + +``converter`` + The name of the C converter function, as a string. + +``impl_by_reference`` + A boolean value. If true, + Argument Clinic will add a ``&`` in front of the name of + the variable when passing it into the impl function. + +``parse_by_reference`` + A boolean value. If true, + Argument Clinic will add a ``&`` in front of the name of + the variable when passing it into :c:func:`PyArg_ParseTuple`. + + +Here's the simplest example of a custom converter, from ``Modules/zlibmodule.c``:: + + /*[python input] + + class ssize_t_converter(CConverter): + type = 'Py_ssize_t' + converter = 'ssize_t_converter' + + [python start generated code]*/ + /*[python end generated code: output=da39a3ee5e6b4b0d input=35521e4e733823c7]*/ + +This block adds a converter to Argument Clinic named ``ssize_t``. Parameters +declared as ``ssize_t`` will be declared as type ``Py_ssize_t``, and will +be parsed by the ``'O&'`` format unit, which will call the +``ssize_t_converter`` converter function. ``ssize_t`` variables +automatically support default values. + +More sophisticated custom converters can insert custom C code to +handle initialization and cleanup. +You can see more examples of custom converters in the CPython +source tree; grep the C files for the string ``CConverter``. + +Writing a custom return converter +--------------------------------- + +Writing a custom return converter is much like writing +a custom converter. Except it's somewhat simpler, because return +converters are themselves much simpler. + +Return converters must subclass ``CReturnConverter``. +There are no examples yet of custom return converters, +because they are not widely used yet. If you wish to +write your own return converter, please read ``Tools/clinic/clinic.py``, +specifically the implementation of ``CReturnConverter`` and +all its subclasses. + +METH_O and METH_NOARGS +---------------------------------------------- + +To convert a function using ``METH_O``, make sure the function's +single argument is using the ``object`` converter, and mark the +arguments as positional-only:: + + /*[clinic input] + meth_o_sample + + argument: object + / + [clinic start generated code]*/ + + +To convert a function using ``METH_NOARGS``, just don't specify +any arguments. + +You can still use a self converter, a return converter, and specify +a ``type`` argument to the object converter for ``METH_O``. + +tp_new and tp_init functions +---------------------------------------------- + +You can convert ``tp_new`` and ``tp_init`` functions. Just name +them ``__new__`` or ``__init__`` as appropriate. Notes: + +* The function name generated for ``__new__`` doesn't end in ``__new__`` + like it would by default. It's just the name of the class, converted + into a valid C identifier. + +* No ``PyMethodDef`` ``#define`` is generated for these functions. + +* ``__init__`` functions return ``int``, not ``PyObject *``. + +* Use the docstring as the class docstring. + +* Although ``__new__`` and ``__init__`` functions must always + accept both the ``args`` and ``kwargs`` objects, when converting + you may specify any signature for these functions that you like. + (If your function doesn't support keywords, the parsing function + generated will throw an exception if it receives any.) + +Changing and redirecting Clinic's output +---------------------------------------- + +It can be inconvenient to have Clinic's output interspersed with +your conventional hand-edited C code. Luckily, Clinic is configurable: +you can buffer up its output for printing later (or earlier!), or write +its output to a separate file. You can also add a prefix or suffix to +every line of Clinic's generated output. + +While changing Clinic's output in this manner can be a boon to readability, +it may result in Clinic code using types before they are defined, or +your code attempting to use Clinic-generated code before it is defined. +These problems can be easily solved by rearranging the declarations in your file, +or moving where Clinic's generated code goes. (This is why the default behavior +of Clinic is to output everything into the current block; while many people +consider this hampers readability, it will never require rearranging your +code to fix definition-before-use problems.) + +Let's start with defining some terminology: + +*field* + A field, in this context, is a subsection of Clinic's output. + For example, the ``#define`` for the ``PyMethodDef`` structure + is a field, called ``methoddef_define``. Clinic has seven + different fields it can output per function definition: + + .. code-block:: none + + docstring_prototype + docstring_definition + methoddef_define + impl_prototype + parser_prototype + parser_definition + impl_definition + + All the names are of the form ``"_"``, + where ``""`` is the semantic object represented (the parsing function, + the impl function, the docstring, or the methoddef structure) and ``""`` + represents what kind of statement the field is. Field names that end in + ``"_prototype"`` + represent forward declarations of that thing, without the actual body/data + of the thing; field names that end in ``"_definition"`` represent the actual + definition of the thing, with the body/data of the thing. (``"methoddef"`` + is special, it's the only one that ends with ``"_define"``, representing that + it's a preprocessor #define.) + +*destination* + A destination is a place Clinic can write output to. There are + five built-in destinations: + + ``block`` + The default destination: printed in the output section of + the current Clinic block. + + ``buffer`` + A text buffer where you can save text for later. Text sent + here is appended to the end of any existing text. It's an + error to have any text left in the buffer when Clinic finishes + processing a file. + + ``file`` + A separate "clinic file" that will be created automatically by Clinic. + The filename chosen for the file is ``{basename}.clinic{extension}``, + where ``basename`` and ``extension`` were assigned the output + from ``os.path.splitext()`` run on the current file. (Example: + the ``file`` destination for ``_pickle.c`` would be written to + ``_pickle.clinic.c``.) + + **Important: When using a** ``file`` **destination, you** + *must check in* **the generated file!** + + ``two-pass`` + A buffer like ``buffer``. However, a two-pass buffer can only + be dumped once, and it prints out all text sent to it during + all processing, even from Clinic blocks *after* the dumping point. + + ``suppress`` + The text is suppressed—thrown away. + + +Clinic defines five new directives that let you reconfigure its output. + +The first new directive is ``dump``: + +.. code-block:: none + + dump + +This dumps the current contents of the named destination into the output of +the current block, and empties it. This only works with ``buffer`` and +``two-pass`` destinations. + +The second new directive is ``output``. The most basic form of ``output`` +is like this: + +.. code-block:: none + + output + +This tells Clinic to output *field* to *destination*. ``output`` also +supports a special meta-destination, called ``everything``, which tells +Clinic to output *all* fields to that *destination*. + +``output`` has a number of other functions: + +.. code-block:: none + + output push + output pop + output preset + + +``output push`` and ``output pop`` allow you to push and pop +configurations on an internal configuration stack, so that you +can temporarily modify the output configuration, then easily restore +the previous configuration. Simply push before your change to save +the current configuration, then pop when you wish to restore the +previous configuration. + +``output preset`` sets Clinic's output to one of several built-in +preset configurations, as follows: + + ``block`` + Clinic's original starting configuration. Writes everything + immediately after the input block. + + Suppress the ``parser_prototype`` + and ``docstring_prototype``, write everything else to ``block``. + + ``file`` + Designed to write everything to the "clinic file" that it can. + You then ``#include`` this file near the top of your file. + You may need to rearrange your file to make this work, though + usually this just means creating forward declarations for various + ``typedef`` and ``PyTypeObject`` definitions. + + Suppress the ``parser_prototype`` + and ``docstring_prototype``, write the ``impl_definition`` to + ``block``, and write everything else to ``file``. + + The default filename is ``"{dirname}/clinic/{basename}.h"``. + + ``buffer`` + Save up most of the output from Clinic, to be written into + your file near the end. For Python files implementing modules + or builtin types, it's recommended that you dump the buffer + just above the static structures for your module or + builtin type; these are normally very near the end. Using + ``buffer`` may require even more editing than ``file``, if + your file has static ``PyMethodDef`` arrays defined in the + middle of the file. + + Suppress the ``parser_prototype``, ``impl_prototype``, + and ``docstring_prototype``, write the ``impl_definition`` to + ``block``, and write everything else to ``file``. + + ``two-pass`` + Similar to the ``buffer`` preset, but writes forward declarations to + the ``two-pass`` buffer, and definitions to the ``buffer``. + This is similar to the ``buffer`` preset, but may require + less editing than ``buffer``. Dump the ``two-pass`` buffer + near the top of your file, and dump the ``buffer`` near + the end just like you would when using the ``buffer`` preset. + + Suppresses the ``impl_prototype``, write the ``impl_definition`` + to ``block``, write ``docstring_prototype``, ``methoddef_define``, + and ``parser_prototype`` to ``two-pass``, write everything else + to ``buffer``. + + ``partial-buffer`` + Similar to the ``buffer`` preset, but writes more things to ``block``, + only writing the really big chunks of generated code to ``buffer``. + This avoids the definition-before-use problem of ``buffer`` completely, + at the small cost of having slightly more stuff in the block's output. + Dump the ``buffer`` near the end, just like you would when using + the ``buffer`` preset. + + Suppresses the ``impl_prototype``, write the ``docstring_definition`` + and ``parser_definition`` to ``buffer``, write everything else to ``block``. + +The third new directive is ``destination``: + +.. code-block:: none + + destination [...] + +This performs an operation on the destination named ``name``. + +There are two defined subcommands: ``new`` and ``clear``. + +The ``new`` subcommand works like this: + +.. code-block:: none + + destination new + +This creates a new destination with name ```` and type ````. + +There are five destination types: + + ``suppress`` + Throws the text away. + + ``block`` + Writes the text to the current block. This is what Clinic + originally did. + + ``buffer`` + A simple text buffer, like the "buffer" builtin destination above. + + ``file`` + A text file. The file destination takes an extra argument, + a template to use for building the filename, like so: + + destination new + + The template can use three strings internally that will be replaced + by bits of the filename: + + {path} + The full path to the file, including directory and full filename. + {dirname} + The name of the directory the file is in. + {basename} + Just the name of the file, not including the directory. + {basename_root} + Basename with the extension clipped off + (everything up to but not including the last '.'). + {basename_extension} + The last '.' and everything after it. If the basename + does not contain a period, this will be the empty string. + + If there are no periods in the filename, {basename} and {filename} + are the same, and {extension} is empty. "{basename}{extension}" + is always exactly the same as "{filename}"." + + ``two-pass`` + A two-pass buffer, like the "two-pass" builtin destination above. + + +The ``clear`` subcommand works like this: + +.. code-block:: none + + destination clear + +It removes all the accumulated text up to this point in the destination. +(I don't know what you'd need this for, but I thought maybe it'd be +useful while someone's experimenting.) + +The fourth new directive is ``set``: + +.. code-block:: none + + set line_prefix "string" + set line_suffix "string" + +``set`` lets you set two internal variables in Clinic. +``line_prefix`` is a string that will be prepended to every line of Clinic's output; +``line_suffix`` is a string that will be appended to every line of Clinic's output. + +Both of these support two format strings: + + ``{block comment start}`` + Turns into the string ``/*``, the start-comment text sequence for C files. + + ``{block comment end}`` + Turns into the string ``*/``, the end-comment text sequence for C files. + +The final new directive is one you shouldn't need to use directly, +called ``preserve``: + +.. code-block:: none + + preserve + +This tells Clinic that the current contents of the output should be kept, unmodified. +This is used internally by Clinic when dumping output into ``file`` files; wrapping +it in a Clinic block lets Clinic use its existing checksum functionality to ensure +the file was not modified by hand before it gets overwritten. + + +The #ifdef trick +---------------------------------------------- + +If you're converting a function that isn't available on all platforms, +there's a trick you can use to make life a little easier. The existing +code probably looks like this:: + + #ifdef HAVE_FUNCTIONNAME + static module_functionname(...) + { + ... + } + #endif /* HAVE_FUNCTIONNAME */ + +And then in the ``PyMethodDef`` structure at the bottom the existing code +will have: + +.. code-block:: none + + #ifdef HAVE_FUNCTIONNAME + {'functionname', ... }, + #endif /* HAVE_FUNCTIONNAME */ + +In this scenario, you should enclose the body of your impl function inside the ``#ifdef``, +like so:: + + #ifdef HAVE_FUNCTIONNAME + /*[clinic input] + module.functionname + ... + [clinic start generated code]*/ + static module_functionname(...) + { + ... + } + #endif /* HAVE_FUNCTIONNAME */ + +Then, remove those three lines from the ``PyMethodDef`` structure, +replacing them with the macro Argument Clinic generated: + +.. code-block:: none + + MODULE_FUNCTIONNAME_METHODDEF + +(You can find the real name for this macro inside the generated code. +Or you can calculate it yourself: it's the name of your function as defined +on the first line of your block, but with periods changed to underscores, +uppercased, and ``"_METHODDEF"`` added to the end.) + +Perhaps you're wondering: what if ``HAVE_FUNCTIONNAME`` isn't defined? +The ``MODULE_FUNCTIONNAME_METHODDEF`` macro won't be defined either! + +Here's where Argument Clinic gets very clever. It actually detects that the +Argument Clinic block might be deactivated by the ``#ifdef``. When that +happens, it generates a little extra code that looks like this:: + + #ifndef MODULE_FUNCTIONNAME_METHODDEF + #define MODULE_FUNCTIONNAME_METHODDEF + #endif /* !defined(MODULE_FUNCTIONNAME_METHODDEF) */ + +That means the macro always works. If the function is defined, this turns +into the correct structure, including the trailing comma. If the function is +undefined, this turns into nothing. + +However, this causes one ticklish problem: where should Argument Clinic put this +extra code when using the "block" output preset? It can't go in the output block, +because that could be deactivated by the ``#ifdef``. (That's the whole point!) + +In this situation, Argument Clinic writes the extra code to the "buffer" destination. +This may mean that you get a complaint from Argument Clinic: + +.. code-block:: none + + Warning in file "Modules/posixmodule.c" on line 12357: + Destination buffer 'buffer' not empty at end of file, emptying. + +When this happens, just open your file, find the ``dump buffer`` block that +Argument Clinic added to your file (it'll be at the very bottom), then +move it above the ``PyMethodDef`` structure where that macro is used. + + + +Using Argument Clinic in Python files +------------------------------------- + +It's actually possible to use Argument Clinic to preprocess Python files. +There's no point to using Argument Clinic blocks, of course, as the output +wouldn't make any sense to the Python interpreter. But using Argument Clinic +to run Python blocks lets you use Python as a Python preprocessor! + +Since Python comments are different from C comments, Argument Clinic +blocks embedded in Python files look slightly different. They look like this: + +.. code-block:: python3 + + #/*[python input] + #print("def foo(): pass") + #[python start generated code]*/ + def foo(): pass + #/*[python checksum:...]*/ diff --git a/python-3.7.4-docs-html/_sources/howto/cporting.rst.txt b/python-3.7.4-docs-html/_sources/howto/cporting.rst.txt new file mode 100644 index 0000000..7cacb0a --- /dev/null +++ b/python-3.7.4-docs-html/_sources/howto/cporting.rst.txt @@ -0,0 +1,257 @@ +.. highlightlang:: c + +.. _cporting-howto: + +************************************* +Porting Extension Modules to Python 3 +************************************* + +:author: Benjamin Peterson + + +.. topic:: Abstract + + Although changing the C-API was not one of Python 3's objectives, + the many Python-level changes made leaving Python 2's API intact + impossible. In fact, some changes such as :func:`int` and + :func:`long` unification are more obvious on the C level. This + document endeavors to document incompatibilities and how they can + be worked around. + + +Conditional compilation +======================= + +The easiest way to compile only some code for Python 3 is to check +if :c:macro:`PY_MAJOR_VERSION` is greater than or equal to 3. :: + + #if PY_MAJOR_VERSION >= 3 + #define IS_PY3K + #endif + +API functions that are not present can be aliased to their equivalents within +conditional blocks. + + +Changes to Object APIs +====================== + +Python 3 merged together some types with similar functions while cleanly +separating others. + + +str/unicode Unification +----------------------- + +Python 3's :func:`str` type is equivalent to Python 2's :func:`unicode`; the C +functions are called ``PyUnicode_*`` for both. The old 8-bit string type has become +:func:`bytes`, with C functions called ``PyBytes_*``. Python 2.6 and later provide a compatibility header, +:file:`bytesobject.h`, mapping ``PyBytes`` names to ``PyString`` ones. For best +compatibility with Python 3, :c:type:`PyUnicode` should be used for textual data and +:c:type:`PyBytes` for binary data. It's also important to remember that +:c:type:`PyBytes` and :c:type:`PyUnicode` in Python 3 are not interchangeable like +:c:type:`PyString` and :c:type:`PyUnicode` are in Python 2. The following example +shows best practices with regards to :c:type:`PyUnicode`, :c:type:`PyString`, +and :c:type:`PyBytes`. :: + + #include "stdlib.h" + #include "Python.h" + #include "bytesobject.h" + + /* text example */ + static PyObject * + say_hello(PyObject *self, PyObject *args) { + PyObject *name, *result; + + if (!PyArg_ParseTuple(args, "U:say_hello", &name)) + return NULL; + + result = PyUnicode_FromFormat("Hello, %S!", name); + return result; + } + + /* just a forward */ + static char * do_encode(PyObject *); + + /* bytes example */ + static PyObject * + encode_object(PyObject *self, PyObject *args) { + char *encoded; + PyObject *result, *myobj; + + if (!PyArg_ParseTuple(args, "O:encode_object", &myobj)) + return NULL; + + encoded = do_encode(myobj); + if (encoded == NULL) + return NULL; + result = PyBytes_FromString(encoded); + free(encoded); + return result; + } + + +long/int Unification +-------------------- + +Python 3 has only one integer type, :func:`int`. But it actually +corresponds to Python 2's :func:`long` type—the :func:`int` type +used in Python 2 was removed. In the C-API, ``PyInt_*`` functions +are replaced by their ``PyLong_*`` equivalents. + + +Module initialization and state +=============================== + +Python 3 has a revamped extension module initialization system. (See +:pep:`3121`.) Instead of storing module state in globals, they should +be stored in an interpreter specific structure. Creating modules that +act correctly in both Python 2 and Python 3 is tricky. The following +simple example demonstrates how. :: + + #include "Python.h" + + struct module_state { + PyObject *error; + }; + + #if PY_MAJOR_VERSION >= 3 + #define GETSTATE(m) ((struct module_state*)PyModule_GetState(m)) + #else + #define GETSTATE(m) (&_state) + static struct module_state _state; + #endif + + static PyObject * + error_out(PyObject *m) { + struct module_state *st = GETSTATE(m); + PyErr_SetString(st->error, "something bad happened"); + return NULL; + } + + static PyMethodDef myextension_methods[] = { + {"error_out", (PyCFunction)error_out, METH_NOARGS, NULL}, + {NULL, NULL} + }; + + #if PY_MAJOR_VERSION >= 3 + + static int myextension_traverse(PyObject *m, visitproc visit, void *arg) { + Py_VISIT(GETSTATE(m)->error); + return 0; + } + + static int myextension_clear(PyObject *m) { + Py_CLEAR(GETSTATE(m)->error); + return 0; + } + + + static struct PyModuleDef moduledef = { + PyModuleDef_HEAD_INIT, + "myextension", + NULL, + sizeof(struct module_state), + myextension_methods, + NULL, + myextension_traverse, + myextension_clear, + NULL + }; + + #define INITERROR return NULL + + PyMODINIT_FUNC + PyInit_myextension(void) + + #else + #define INITERROR return + + void + initmyextension(void) + #endif + { + #if PY_MAJOR_VERSION >= 3 + PyObject *module = PyModule_Create(&moduledef); + #else + PyObject *module = Py_InitModule("myextension", myextension_methods); + #endif + + if (module == NULL) + INITERROR; + struct module_state *st = GETSTATE(module); + + st->error = PyErr_NewException("myextension.Error", NULL, NULL); + if (st->error == NULL) { + Py_DECREF(module); + INITERROR; + } + + #if PY_MAJOR_VERSION >= 3 + return module; + #endif + } + + +CObject replaced with Capsule +============================= + +The :c:type:`Capsule` object was introduced in Python 3.1 and 2.7 to replace +:c:type:`CObject`. CObjects were useful, +but the :c:type:`CObject` API was problematic: it didn't permit distinguishing +between valid CObjects, which allowed mismatched CObjects to crash the +interpreter, and some of its APIs relied on undefined behavior in C. +(For further reading on the rationale behind Capsules, please see :issue:`5630`.) + +If you're currently using CObjects, and you want to migrate to 3.1 or newer, +you'll need to switch to Capsules. +:c:type:`CObject` was deprecated in 3.1 and 2.7 and completely removed in +Python 3.2. If you only support 2.7, or 3.1 and above, you +can simply switch to :c:type:`Capsule`. If you need to support Python 3.0, +or versions of Python earlier than 2.7, +you'll have to support both CObjects and Capsules. +(Note that Python 3.0 is no longer supported, and it is not recommended +for production use.) + +The following example header file :file:`capsulethunk.h` may +solve the problem for you. Simply write your code against the +:c:type:`Capsule` API and include this header file after +:file:`Python.h`. Your code will automatically use Capsules +in versions of Python with Capsules, and switch to CObjects +when Capsules are unavailable. + +:file:`capsulethunk.h` simulates Capsules using CObjects. However, +:c:type:`CObject` provides no place to store the capsule's "name". As a +result the simulated :c:type:`Capsule` objects created by :file:`capsulethunk.h` +behave slightly differently from real Capsules. Specifically: + + * The name parameter passed in to :c:func:`PyCapsule_New` is ignored. + + * The name parameter passed in to :c:func:`PyCapsule_IsValid` and + :c:func:`PyCapsule_GetPointer` is ignored, and no error checking + of the name is performed. + + * :c:func:`PyCapsule_GetName` always returns NULL. + + * :c:func:`PyCapsule_SetName` always raises an exception and + returns failure. (Since there's no way to store a name + in a CObject, noisy failure of :c:func:`PyCapsule_SetName` + was deemed preferable to silent failure here. If this is + inconvenient, feel free to modify your local + copy as you see fit.) + +You can find :file:`capsulethunk.h` in the Python source distribution +as :source:`Doc/includes/capsulethunk.h`. We also include it here for +your convenience: + +.. literalinclude:: ../includes/capsulethunk.h + + + +Other options +============= + +If you are writing a new extension module, you might consider `Cython +`_. It translates a Python-like language to C. The +extension modules it creates are compatible with Python 3 and Python 2. + diff --git a/python-3.7.4-docs-html/_sources/howto/curses.rst.txt b/python-3.7.4-docs-html/_sources/howto/curses.rst.txt new file mode 100644 index 0000000..cc4b478 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/howto/curses.rst.txt @@ -0,0 +1,552 @@ +.. _curses-howto: + +********************************** + Curses Programming with Python +********************************** + +:Author: A.M. Kuchling, Eric S. Raymond +:Release: 2.04 + + +.. topic:: Abstract + + This document describes how to use the :mod:`curses` extension + module to control text-mode displays. + + +What is curses? +=============== + +The curses library supplies a terminal-independent screen-painting and +keyboard-handling facility for text-based terminals; such terminals +include VT100s, the Linux console, and the simulated terminal provided +by various programs. Display terminals support various control codes +to perform common operations such as moving the cursor, scrolling the +screen, and erasing areas. Different terminals use widely differing +codes, and often have their own minor quirks. + +In a world of graphical displays, one might ask "why bother"? It's +true that character-cell display terminals are an obsolete technology, +but there are niches in which being able to do fancy things with them +are still valuable. One niche is on small-footprint or embedded +Unixes that don't run an X server. Another is tools such as OS +installers and kernel configurators that may have to run before any +graphical support is available. + +The curses library provides fairly basic functionality, providing the +programmer with an abstraction of a display containing multiple +non-overlapping windows of text. The contents of a window can be +changed in various ways---adding text, erasing it, changing its +appearance---and the curses library will figure out what control codes +need to be sent to the terminal to produce the right output. curses +doesn't provide many user-interface concepts such as buttons, checkboxes, +or dialogs; if you need such features, consider a user interface library such as +`Urwid `_. + +The curses library was originally written for BSD Unix; the later System V +versions of Unix from AT&T added many enhancements and new functions. BSD curses +is no longer maintained, having been replaced by ncurses, which is an +open-source implementation of the AT&T interface. If you're using an +open-source Unix such as Linux or FreeBSD, your system almost certainly uses +ncurses. Since most current commercial Unix versions are based on System V +code, all the functions described here will probably be available. The older +versions of curses carried by some proprietary Unixes may not support +everything, though. + +The Windows version of Python doesn't include the :mod:`curses` +module. A ported version called `UniCurses +`_ is available. You could +also try `the Console module `_ +written by Fredrik Lundh, which doesn't +use the same API as curses but provides cursor-addressable text output +and full support for mouse and keyboard input. + + +The Python curses module +------------------------ + +The Python module is a fairly simple wrapper over the C functions provided by +curses; if you're already familiar with curses programming in C, it's really +easy to transfer that knowledge to Python. The biggest difference is that the +Python interface makes things simpler by merging different C functions such as +:c:func:`addstr`, :c:func:`mvaddstr`, and :c:func:`mvwaddstr` into a single +:meth:`~curses.window.addstr` method. You'll see this covered in more +detail later. + +This HOWTO is an introduction to writing text-mode programs with curses +and Python. It doesn't attempt to be a complete guide to the curses API; for +that, see the Python library guide's section on ncurses, and the C manual pages +for ncurses. It will, however, give you the basic ideas. + + +Starting and ending a curses application +======================================== + +Before doing anything, curses must be initialized. This is done by +calling the :func:`~curses.initscr` function, which will determine the +terminal type, send any required setup codes to the terminal, and +create various internal data structures. If successful, +:func:`initscr` returns a window object representing the entire +screen; this is usually called ``stdscr`` after the name of the +corresponding C variable. :: + + import curses + stdscr = curses.initscr() + +Usually curses applications turn off automatic echoing of keys to the +screen, in order to be able to read keys and only display them under +certain circumstances. This requires calling the +:func:`~curses.noecho` function. :: + + curses.noecho() + +Applications will also commonly need to react to keys instantly, +without requiring the Enter key to be pressed; this is called cbreak +mode, as opposed to the usual buffered input mode. :: + + curses.cbreak() + +Terminals usually return special keys, such as the cursor keys or navigation +keys such as Page Up and Home, as a multibyte escape sequence. While you could +write your application to expect such sequences and process them accordingly, +curses can do it for you, returning a special value such as +:const:`curses.KEY_LEFT`. To get curses to do the job, you'll have to enable +keypad mode. :: + + stdscr.keypad(True) + +Terminating a curses application is much easier than starting one. You'll need +to call:: + + curses.nocbreak() + stdscr.keypad(False) + curses.echo() + +to reverse the curses-friendly terminal settings. Then call the +:func:`~curses.endwin` function to restore the terminal to its original +operating mode. :: + + curses.endwin() + +A common problem when debugging a curses application is to get your terminal +messed up when the application dies without restoring the terminal to its +previous state. In Python this commonly happens when your code is buggy and +raises an uncaught exception. Keys are no longer echoed to the screen when +you type them, for example, which makes using the shell difficult. + +In Python you can avoid these complications and make debugging much easier by +importing the :func:`curses.wrapper` function and using it like this:: + + from curses import wrapper + + def main(stdscr): + # Clear screen + stdscr.clear() + + # This raises ZeroDivisionError when i == 10. + for i in range(0, 11): + v = i-10 + stdscr.addstr(i, 0, '10 divided by {} is {}'.format(v, 10/v)) + + stdscr.refresh() + stdscr.getkey() + + wrapper(main) + +The :func:`~curses.wrapper` function takes a callable object and does the +initializations described above, also initializing colors if color +support is present. :func:`wrapper` then runs your provided callable. +Once the callable returns, :func:`wrapper` will restore the original +state of the terminal. The callable is called inside a +:keyword:`try`...\ :keyword:`except` that catches exceptions, restores +the state of the terminal, and then re-raises the exception. Therefore +your terminal won't be left in a funny state on exception and you'll be +able to read the exception's message and traceback. + + +Windows and Pads +================ + +Windows are the basic abstraction in curses. A window object represents a +rectangular area of the screen, and supports methods to display text, +erase it, allow the user to input strings, and so forth. + +The ``stdscr`` object returned by the :func:`~curses.initscr` function is a +window object that covers the entire screen. Many programs may need +only this single window, but you might wish to divide the screen into +smaller windows, in order to redraw or clear them separately. The +:func:`~curses.newwin` function creates a new window of a given size, +returning the new window object. :: + + begin_x = 20; begin_y = 7 + height = 5; width = 40 + win = curses.newwin(height, width, begin_y, begin_x) + +Note that the coordinate system used in curses is unusual. +Coordinates are always passed in the order *y,x*, and the top-left +corner of a window is coordinate (0,0). This breaks the normal +convention for handling coordinates where the *x* coordinate comes +first. This is an unfortunate difference from most other computer +applications, but it's been part of curses since it was first written, +and it's too late to change things now. + +Your application can determine the size of the screen by using the +:data:`curses.LINES` and :data:`curses.COLS` variables to obtain the *y* and +*x* sizes. Legal coordinates will then extend from ``(0,0)`` to +``(curses.LINES - 1, curses.COLS - 1)``. + +When you call a method to display or erase text, the effect doesn't +immediately show up on the display. Instead you must call the +:meth:`~curses.window.refresh` method of window objects to update the +screen. + +This is because curses was originally written with slow 300-baud +terminal connections in mind; with these terminals, minimizing the +time required to redraw the screen was very important. Instead curses +accumulates changes to the screen and displays them in the most +efficient manner when you call :meth:`refresh`. For example, if your +program displays some text in a window and then clears the window, +there's no need to send the original text because they're never +visible. + +In practice, explicitly telling curses to redraw a window doesn't +really complicate programming with curses much. Most programs go into a flurry +of activity, and then pause waiting for a keypress or some other action on the +part of the user. All you have to do is to be sure that the screen has been +redrawn before pausing to wait for user input, by first calling +``stdscr.refresh()`` or the :meth:`refresh` method of some other relevant +window. + +A pad is a special case of a window; it can be larger than the actual display +screen, and only a portion of the pad displayed at a time. Creating a pad +requires the pad's height and width, while refreshing a pad requires giving the +coordinates of the on-screen area where a subsection of the pad will be +displayed. :: + + pad = curses.newpad(100, 100) + # These loops fill the pad with letters; addch() is + # explained in the next section + for y in range(0, 99): + for x in range(0, 99): + pad.addch(y,x, ord('a') + (x*x+y*y) % 26) + + # Displays a section of the pad in the middle of the screen. + # (0,0) : coordinate of upper-left corner of pad area to display. + # (5,5) : coordinate of upper-left corner of window area to be filled + # with pad content. + # (20, 75) : coordinate of lower-right corner of window area to be + # : filled with pad content. + pad.refresh( 0,0, 5,5, 20,75) + +The :meth:`refresh` call displays a section of the pad in the rectangle +extending from coordinate (5,5) to coordinate (20,75) on the screen; the upper +left corner of the displayed section is coordinate (0,0) on the pad. Beyond +that difference, pads are exactly like ordinary windows and support the same +methods. + +If you have multiple windows and pads on screen there is a more +efficient way to update the screen and prevent annoying screen flicker +as each part of the screen gets updated. :meth:`refresh` actually +does two things: + +1) Calls the :meth:`~curses.window.noutrefresh` method of each window + to update an underlying data structure representing the desired + state of the screen. +2) Calls the function :func:`~curses.doupdate` function to change the + physical screen to match the desired state recorded in the data structure. + +Instead you can call :meth:`noutrefresh` on a number of windows to +update the data structure, and then call :func:`doupdate` to update +the screen. + + +Displaying Text +=============== + +From a C programmer's point of view, curses may sometimes look like a +twisty maze of functions, all subtly different. For example, +:c:func:`addstr` displays a string at the current cursor location in +the ``stdscr`` window, while :c:func:`mvaddstr` moves to a given y,x +coordinate first before displaying the string. :c:func:`waddstr` is just +like :c:func:`addstr`, but allows specifying a window to use instead of +using ``stdscr`` by default. :c:func:`mvwaddstr` allows specifying both +a window and a coordinate. + +Fortunately the Python interface hides all these details. ``stdscr`` +is a window object like any other, and methods such as +:meth:`~curses.window.addstr` accept multiple argument forms. Usually there +are four different forms. + ++---------------------------------+-----------------------------------------------+ +| Form | Description | ++=================================+===============================================+ +| *str* or *ch* | Display the string *str* or character *ch* at | +| | the current position | ++---------------------------------+-----------------------------------------------+ +| *str* or *ch*, *attr* | Display the string *str* or character *ch*, | +| | using attribute *attr* at the current | +| | position | ++---------------------------------+-----------------------------------------------+ +| *y*, *x*, *str* or *ch* | Move to position *y,x* within the window, and | +| | display *str* or *ch* | ++---------------------------------+-----------------------------------------------+ +| *y*, *x*, *str* or *ch*, *attr* | Move to position *y,x* within the window, and | +| | display *str* or *ch*, using attribute *attr* | ++---------------------------------+-----------------------------------------------+ + +Attributes allow displaying text in highlighted forms such as boldface, +underline, reverse code, or in color. They'll be explained in more detail in +the next subsection. + + +The :meth:`~curses.window.addstr` method takes a Python string or +bytestring as the value to be displayed. The contents of bytestrings +are sent to the terminal as-is. Strings are encoded to bytes using +the value of the window's :attr:`encoding` attribute; this defaults to +the default system encoding as returned by +:func:`locale.getpreferredencoding`. + +The :meth:`~curses.window.addch` methods take a character, which can be +either a string of length 1, a bytestring of length 1, or an integer. + +Constants are provided for extension characters; these constants are +integers greater than 255. For example, :const:`ACS_PLMINUS` is a +/- +symbol, and :const:`ACS_ULCORNER` is the upper left corner of a box +(handy for drawing borders). You can also use the appropriate Unicode +character. + +Windows remember where the cursor was left after the last operation, so if you +leave out the *y,x* coordinates, the string or character will be displayed +wherever the last operation left off. You can also move the cursor with the +``move(y,x)`` method. Because some terminals always display a flashing cursor, +you may want to ensure that the cursor is positioned in some location where it +won't be distracting; it can be confusing to have the cursor blinking at some +apparently random location. + +If your application doesn't need a blinking cursor at all, you can +call ``curs_set(False)`` to make it invisible. For compatibility +with older curses versions, there's a ``leaveok(bool)`` function +that's a synonym for :func:`~curses.curs_set`. When *bool* is true, the +curses library will attempt to suppress the flashing cursor, and you +won't need to worry about leaving it in odd locations. + + +Attributes and Color +-------------------- + +Characters can be displayed in different ways. Status lines in a text-based +application are commonly shown in reverse video, or a text viewer may need to +highlight certain words. curses supports this by allowing you to specify an +attribute for each cell on the screen. + +An attribute is an integer, each bit representing a different +attribute. You can try to display text with multiple attribute bits +set, but curses doesn't guarantee that all the possible combinations +are available, or that they're all visually distinct. That depends on +the ability of the terminal being used, so it's safest to stick to the +most commonly available attributes, listed here. + ++----------------------+--------------------------------------+ +| Attribute | Description | ++======================+======================================+ +| :const:`A_BLINK` | Blinking text | ++----------------------+--------------------------------------+ +| :const:`A_BOLD` | Extra bright or bold text | ++----------------------+--------------------------------------+ +| :const:`A_DIM` | Half bright text | ++----------------------+--------------------------------------+ +| :const:`A_REVERSE` | Reverse-video text | ++----------------------+--------------------------------------+ +| :const:`A_STANDOUT` | The best highlighting mode available | ++----------------------+--------------------------------------+ +| :const:`A_UNDERLINE` | Underlined text | ++----------------------+--------------------------------------+ + +So, to display a reverse-video status line on the top line of the screen, you +could code:: + + stdscr.addstr(0, 0, "Current mode: Typing mode", + curses.A_REVERSE) + stdscr.refresh() + +The curses library also supports color on those terminals that provide it. The +most common such terminal is probably the Linux console, followed by color +xterms. + +To use color, you must call the :func:`~curses.start_color` function soon +after calling :func:`~curses.initscr`, to initialize the default color set +(the :func:`curses.wrapper` function does this automatically). Once that's +done, the :func:`~curses.has_colors` function returns TRUE if the terminal +in use can +actually display color. (Note: curses uses the American spelling 'color', +instead of the Canadian/British spelling 'colour'. If you're used to the +British spelling, you'll have to resign yourself to misspelling it for the sake +of these functions.) + +The curses library maintains a finite number of color pairs, containing a +foreground (or text) color and a background color. You can get the attribute +value corresponding to a color pair with the :func:`~curses.color_pair` +function; this can be bitwise-OR'ed with other attributes such as +:const:`A_REVERSE`, but again, such combinations are not guaranteed to work +on all terminals. + +An example, which displays a line of text using color pair 1:: + + stdscr.addstr("Pretty text", curses.color_pair(1)) + stdscr.refresh() + +As I said before, a color pair consists of a foreground and background color. +The ``init_pair(n, f, b)`` function changes the definition of color pair *n*, to +foreground color f and background color b. Color pair 0 is hard-wired to white +on black, and cannot be changed. + +Colors are numbered, and :func:`start_color` initializes 8 basic +colors when it activates color mode. They are: 0:black, 1:red, +2:green, 3:yellow, 4:blue, 5:magenta, 6:cyan, and 7:white. The :mod:`curses` +module defines named constants for each of these colors: +:const:`curses.COLOR_BLACK`, :const:`curses.COLOR_RED`, and so forth. + +Let's put all this together. To change color 1 to red text on a white +background, you would call:: + + curses.init_pair(1, curses.COLOR_RED, curses.COLOR_WHITE) + +When you change a color pair, any text already displayed using that color pair +will change to the new colors. You can also display new text in this color +with:: + + stdscr.addstr(0,0, "RED ALERT!", curses.color_pair(1)) + +Very fancy terminals can change the definitions of the actual colors to a given +RGB value. This lets you change color 1, which is usually red, to purple or +blue or any other color you like. Unfortunately, the Linux console doesn't +support this, so I'm unable to try it out, and can't provide any examples. You +can check if your terminal can do this by calling +:func:`~curses.can_change_color`, which returns ``True`` if the capability is +there. If you're lucky enough to have such a talented terminal, consult your +system's man pages for more information. + + +User Input +========== + +The C curses library offers only very simple input mechanisms. Python's +:mod:`curses` module adds a basic text-input widget. (Other libraries +such as `Urwid `_ have more extensive +collections of widgets.) + +There are two methods for getting input from a window: + +* :meth:`~curses.window.getch` refreshes the screen and then waits for + the user to hit a key, displaying the key if :func:`~curses.echo` has been + called earlier. You can optionally specify a coordinate to which + the cursor should be moved before pausing. + +* :meth:`~curses.window.getkey` does the same thing but converts the + integer to a string. Individual characters are returned as + 1-character strings, and special keys such as function keys return + longer strings containing a key name such as ``KEY_UP`` or ``^G``. + +It's possible to not wait for the user using the +:meth:`~curses.window.nodelay` window method. After ``nodelay(True)``, +:meth:`getch` and :meth:`getkey` for the window become +non-blocking. To signal that no input is ready, :meth:`getch` returns +``curses.ERR`` (a value of -1) and :meth:`getkey` raises an exception. +There's also a :func:`~curses.halfdelay` function, which can be used to (in +effect) set a timer on each :meth:`getch`; if no input becomes +available within a specified delay (measured in tenths of a second), +curses raises an exception. + +The :meth:`getch` method returns an integer; if it's between 0 and 255, it +represents the ASCII code of the key pressed. Values greater than 255 are +special keys such as Page Up, Home, or the cursor keys. You can compare the +value returned to constants such as :const:`curses.KEY_PPAGE`, +:const:`curses.KEY_HOME`, or :const:`curses.KEY_LEFT`. The main loop of +your program may look something like this:: + + while True: + c = stdscr.getch() + if c == ord('p'): + PrintDocument() + elif c == ord('q'): + break # Exit the while loop + elif c == curses.KEY_HOME: + x = y = 0 + +The :mod:`curses.ascii` module supplies ASCII class membership functions that +take either integer or 1-character string arguments; these may be useful in +writing more readable tests for such loops. It also supplies +conversion functions that take either integer or 1-character-string arguments +and return the same type. For example, :func:`curses.ascii.ctrl` returns the +control character corresponding to its argument. + +There's also a method to retrieve an entire string, +:meth:`~curses.window.getstr`. It isn't used very often, because its +functionality is quite limited; the only editing keys available are +the backspace key and the Enter key, which terminates the string. It +can optionally be limited to a fixed number of characters. :: + + curses.echo() # Enable echoing of characters + + # Get a 15-character string, with the cursor on the top line + s = stdscr.getstr(0,0, 15) + +The :mod:`curses.textpad` module supplies a text box that supports an +Emacs-like set of keybindings. Various methods of the +:class:`~curses.textpad.Textbox` class support editing with input +validation and gathering the edit results either with or without +trailing spaces. Here's an example:: + + import curses + from curses.textpad import Textbox, rectangle + + def main(stdscr): + stdscr.addstr(0, 0, "Enter IM message: (hit Ctrl-G to send)") + + editwin = curses.newwin(5,30, 2,1) + rectangle(stdscr, 1,0, 1+5+1, 1+30+1) + stdscr.refresh() + + box = Textbox(editwin) + + # Let the user edit until Ctrl-G is struck. + box.edit() + + # Get resulting contents + message = box.gather() + +See the library documentation on :mod:`curses.textpad` for more details. + + +For More Information +==================== + +This HOWTO doesn't cover some advanced topics, such as reading the +contents of the screen or capturing mouse events from an xterm +instance, but the Python library page for the :mod:`curses` module is now +reasonably complete. You should browse it next. + +If you're in doubt about the detailed behavior of the curses +functions, consult the manual pages for your curses implementation, +whether it's ncurses or a proprietary Unix vendor's. The manual pages +will document any quirks, and provide complete lists of all the +functions, attributes, and :const:`ACS_\*` characters available to +you. + +Because the curses API is so large, some functions aren't supported in +the Python interface. Often this isn't because they're difficult to +implement, but because no one has needed them yet. Also, Python +doesn't yet support the menu library associated with ncurses. +Patches adding support for these would be welcome; see +`the Python Developer's Guide `_ to +learn more about submitting patches to Python. + +* `Writing Programs with NCURSES `_: + a lengthy tutorial for C programmers. +* `The ncurses man page `_ +* `The ncurses FAQ `_ +* `"Use curses... don't swear" `_: + video of a PyCon 2013 talk on controlling terminals using curses or Urwid. +* `"Console Applications with Urwid" `_: + video of a PyCon CA 2012 talk demonstrating some applications written using + Urwid. diff --git a/python-3.7.4-docs-html/_sources/howto/descriptor.rst.txt b/python-3.7.4-docs-html/_sources/howto/descriptor.rst.txt new file mode 100644 index 0000000..3d1da5a --- /dev/null +++ b/python-3.7.4-docs-html/_sources/howto/descriptor.rst.txt @@ -0,0 +1,443 @@ +====================== +Descriptor HowTo Guide +====================== + +:Author: Raymond Hettinger +:Contact: + +.. Contents:: + +Abstract +-------- + +Defines descriptors, summarizes the protocol, and shows how descriptors are +called. Examines a custom descriptor and several built-in Python descriptors +including functions, properties, static methods, and class methods. Shows how +each works by giving a pure Python equivalent and a sample application. + +Learning about descriptors not only provides access to a larger toolset, it +creates a deeper understanding of how Python works and an appreciation for the +elegance of its design. + + +Definition and Introduction +--------------------------- + +In general, a descriptor is an object attribute with "binding behavior", one +whose attribute access has been overridden by methods in the descriptor +protocol. Those methods are :meth:`__get__`, :meth:`__set__`, and +:meth:`__delete__`. If any of those methods are defined for an object, it is +said to be a descriptor. + +The default behavior for attribute access is to get, set, or delete the +attribute from an object's dictionary. For instance, ``a.x`` has a lookup chain +starting with ``a.__dict__['x']``, then ``type(a).__dict__['x']``, and +continuing through the base classes of ``type(a)`` excluding metaclasses. If the +looked-up value is an object defining one of the descriptor methods, then Python +may override the default behavior and invoke the descriptor method instead. +Where this occurs in the precedence chain depends on which descriptor methods +were defined. + +Descriptors are a powerful, general purpose protocol. They are the mechanism +behind properties, methods, static methods, class methods, and :func:`super()`. +They are used throughout Python itself to implement the new style classes +introduced in version 2.2. Descriptors simplify the underlying C-code and offer +a flexible set of new tools for everyday Python programs. + + +Descriptor Protocol +------------------- + +``descr.__get__(self, obj, type=None) -> value`` + +``descr.__set__(self, obj, value) -> None`` + +``descr.__delete__(self, obj) -> None`` + +That is all there is to it. Define any of these methods and an object is +considered a descriptor and can override default behavior upon being looked up +as an attribute. + +If an object defines both :meth:`__get__` and :meth:`__set__`, it is considered +a data descriptor. Descriptors that only define :meth:`__get__` are called +non-data descriptors (they are typically used for methods but other uses are +possible). + +Data and non-data descriptors differ in how overrides are calculated with +respect to entries in an instance's dictionary. If an instance's dictionary +has an entry with the same name as a data descriptor, the data descriptor +takes precedence. If an instance's dictionary has an entry with the same +name as a non-data descriptor, the dictionary entry takes precedence. + +To make a read-only data descriptor, define both :meth:`__get__` and +:meth:`__set__` with the :meth:`__set__` raising an :exc:`AttributeError` when +called. Defining the :meth:`__set__` method with an exception raising +placeholder is enough to make it a data descriptor. + + +Invoking Descriptors +-------------------- + +A descriptor can be called directly by its method name. For example, +``d.__get__(obj)``. + +Alternatively, it is more common for a descriptor to be invoked automatically +upon attribute access. For example, ``obj.d`` looks up ``d`` in the dictionary +of ``obj``. If ``d`` defines the method :meth:`__get__`, then ``d.__get__(obj)`` +is invoked according to the precedence rules listed below. + +The details of invocation depend on whether ``obj`` is an object or a class. + +For objects, the machinery is in :meth:`object.__getattribute__` which +transforms ``b.x`` into ``type(b).__dict__['x'].__get__(b, type(b))``. The +implementation works through a precedence chain that gives data descriptors +priority over instance variables, instance variables priority over non-data +descriptors, and assigns lowest priority to :meth:`__getattr__` if provided. +The full C implementation can be found in :c:func:`PyObject_GenericGetAttr()` in +:source:`Objects/object.c`. + +For classes, the machinery is in :meth:`type.__getattribute__` which transforms +``B.x`` into ``B.__dict__['x'].__get__(None, B)``. In pure Python, it looks +like:: + + def __getattribute__(self, key): + "Emulate type_getattro() in Objects/typeobject.c" + v = object.__getattribute__(self, key) + if hasattr(v, '__get__'): + return v.__get__(None, self) + return v + +The important points to remember are: + +* descriptors are invoked by the :meth:`__getattribute__` method +* overriding :meth:`__getattribute__` prevents automatic descriptor calls +* :meth:`object.__getattribute__` and :meth:`type.__getattribute__` make + different calls to :meth:`__get__`. +* data descriptors always override instance dictionaries. +* non-data descriptors may be overridden by instance dictionaries. + +The object returned by ``super()`` also has a custom :meth:`__getattribute__` +method for invoking descriptors. The call ``super(B, obj).m()`` searches +``obj.__class__.__mro__`` for the base class ``A`` immediately following ``B`` +and then returns ``A.__dict__['m'].__get__(obj, B)``. If not a descriptor, +``m`` is returned unchanged. If not in the dictionary, ``m`` reverts to a +search using :meth:`object.__getattribute__`. + +The implementation details are in :c:func:`super_getattro()` in +:source:`Objects/typeobject.c`. and a pure Python equivalent can be found in +`Guido's Tutorial`_. + +.. _`Guido's Tutorial`: https://www.python.org/download/releases/2.2.3/descrintro/#cooperation + +The details above show that the mechanism for descriptors is embedded in the +:meth:`__getattribute__()` methods for :class:`object`, :class:`type`, and +:func:`super`. Classes inherit this machinery when they derive from +:class:`object` or if they have a meta-class providing similar functionality. +Likewise, classes can turn-off descriptor invocation by overriding +:meth:`__getattribute__()`. + + +Descriptor Example +------------------ + +The following code creates a class whose objects are data descriptors which +print a message for each get or set. Overriding :meth:`__getattribute__` is +alternate approach that could do this for every attribute. However, this +descriptor is useful for monitoring just a few chosen attributes:: + + class RevealAccess(object): + """A data descriptor that sets and returns values + normally and prints a message logging their access. + """ + + def __init__(self, initval=None, name='var'): + self.val = initval + self.name = name + + def __get__(self, obj, objtype): + print('Retrieving', self.name) + return self.val + + def __set__(self, obj, val): + print('Updating', self.name) + self.val = val + + >>> class MyClass(object): + ... x = RevealAccess(10, 'var "x"') + ... y = 5 + ... + >>> m = MyClass() + >>> m.x + Retrieving var "x" + 10 + >>> m.x = 20 + Updating var "x" + >>> m.x + Retrieving var "x" + 20 + >>> m.y + 5 + +The protocol is simple and offers exciting possibilities. Several use cases are +so common that they have been packaged into individual function calls. +Properties, bound methods, static methods, and class methods are all +based on the descriptor protocol. + + +Properties +---------- + +Calling :func:`property` is a succinct way of building a data descriptor that +triggers function calls upon access to an attribute. Its signature is:: + + property(fget=None, fset=None, fdel=None, doc=None) -> property attribute + +The documentation shows a typical use to define a managed attribute ``x``:: + + class C(object): + def getx(self): return self.__x + def setx(self, value): self.__x = value + def delx(self): del self.__x + x = property(getx, setx, delx, "I'm the 'x' property.") + +To see how :func:`property` is implemented in terms of the descriptor protocol, +here is a pure Python equivalent:: + + class Property(object): + "Emulate PyProperty_Type() in Objects/descrobject.c" + + def __init__(self, fget=None, fset=None, fdel=None, doc=None): + self.fget = fget + self.fset = fset + self.fdel = fdel + if doc is None and fget is not None: + doc = fget.__doc__ + self.__doc__ = doc + + def __get__(self, obj, objtype=None): + if obj is None: + return self + if self.fget is None: + raise AttributeError("unreadable attribute") + return self.fget(obj) + + def __set__(self, obj, value): + if self.fset is None: + raise AttributeError("can't set attribute") + self.fset(obj, value) + + def __delete__(self, obj): + if self.fdel is None: + raise AttributeError("can't delete attribute") + self.fdel(obj) + + def getter(self, fget): + return type(self)(fget, self.fset, self.fdel, self.__doc__) + + def setter(self, fset): + return type(self)(self.fget, fset, self.fdel, self.__doc__) + + def deleter(self, fdel): + return type(self)(self.fget, self.fset, fdel, self.__doc__) + +The :func:`property` builtin helps whenever a user interface has granted +attribute access and then subsequent changes require the intervention of a +method. + +For instance, a spreadsheet class may grant access to a cell value through +``Cell('b10').value``. Subsequent improvements to the program require the cell +to be recalculated on every access; however, the programmer does not want to +affect existing client code accessing the attribute directly. The solution is +to wrap access to the value attribute in a property data descriptor:: + + class Cell(object): + . . . + def getvalue(self): + "Recalculate the cell before returning value" + self.recalc() + return self._value + value = property(getvalue) + + +Functions and Methods +--------------------- + +Python's object oriented features are built upon a function based environment. +Using non-data descriptors, the two are merged seamlessly. + +Class dictionaries store methods as functions. In a class definition, methods +are written using :keyword:`def` or :keyword:`lambda`, the usual tools for +creating functions. Methods only differ from regular functions in that the +first argument is reserved for the object instance. By Python convention, the +instance reference is called *self* but may be called *this* or any other +variable name. + +To support method calls, functions include the :meth:`__get__` method for +binding methods during attribute access. This means that all functions are +non-data descriptors which return bound methods when they are invoked from an +object. In pure Python, it works like this:: + + class Function(object): + . . . + def __get__(self, obj, objtype=None): + "Simulate func_descr_get() in Objects/funcobject.c" + if obj is None: + return self + return types.MethodType(self, obj) + +Running the interpreter shows how the function descriptor works in practice:: + + >>> class D(object): + ... def f(self, x): + ... return x + ... + >>> d = D() + + # Access through the class dictionary does not invoke __get__. + # It just returns the underlying function object. + >>> D.__dict__['f'] + + + # Dotted access from a class calls __get__() which just returns + # the underlying function unchanged. + >>> D.f + + + # The function has a __qualname__ attribute to support introspection + >>> D.f.__qualname__ + 'D.f' + + # Dotted access from an instance calls __get__() which returns the + # function wrapped in a bound method object + >>> d.f + > + + # Internally, the bound method stores the underlying function, + # the bound instance, and the class of the bound instance. + >>> d.f.__func__ + + >>> d.f.__self__ + <__main__.D object at 0x1012e1f98> + >>> d.f.__class__ + + + +Static Methods and Class Methods +-------------------------------- + +Non-data descriptors provide a simple mechanism for variations on the usual +patterns of binding functions into methods. + +To recap, functions have a :meth:`__get__` method so that they can be converted +to a method when accessed as attributes. The non-data descriptor transforms an +``obj.f(*args)`` call into ``f(obj, *args)``. Calling ``klass.f(*args)`` +becomes ``f(*args)``. + +This chart summarizes the binding and its two most useful variants: + + +-----------------+----------------------+------------------+ + | Transformation | Called from an | Called from a | + | | Object | Class | + +=================+======================+==================+ + | function | f(obj, \*args) | f(\*args) | + +-----------------+----------------------+------------------+ + | staticmethod | f(\*args) | f(\*args) | + +-----------------+----------------------+------------------+ + | classmethod | f(type(obj), \*args) | f(klass, \*args) | + +-----------------+----------------------+------------------+ + +Static methods return the underlying function without changes. Calling either +``c.f`` or ``C.f`` is the equivalent of a direct lookup into +``object.__getattribute__(c, "f")`` or ``object.__getattribute__(C, "f")``. As a +result, the function becomes identically accessible from either an object or a +class. + +Good candidates for static methods are methods that do not reference the +``self`` variable. + +For instance, a statistics package may include a container class for +experimental data. The class provides normal methods for computing the average, +mean, median, and other descriptive statistics that depend on the data. However, +there may be useful functions which are conceptually related but do not depend +on the data. For instance, ``erf(x)`` is handy conversion routine that comes up +in statistical work but does not directly depend on a particular dataset. +It can be called either from an object or the class: ``s.erf(1.5) --> .9332`` or +``Sample.erf(1.5) --> .9332``. + +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) + ... + >>> E.f(3) + 3 + >>> E().f(3) + 3 + +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" + + def __init__(self, f): + self.f = 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) + ... + >>> print(E.f(3)) + ('E', 3) + >>> print(E().f(3)) + ('E', 3) + + +This behavior is useful whenever the function only needs to have a class +reference and does not care about any underlying data. One use for classmethods +is to create alternate class constructors. In Python 2.3, the classmethod +:func:`dict.fromkeys` creates a new dictionary from a list of keys. The pure +Python equivalent is:: + + class Dict(object): + . . . + def fromkeys(klass, iterable, value=None): + "Emulate dict_fromkeys() in Objects/dictobject.c" + d = klass() + for key in iterable: + d[key] = value + return d + fromkeys = classmethod(fromkeys) + +Now a new dictionary of unique keys can be constructed like this:: + + >>> Dict.fromkeys('abracadabra') + {'a': None, 'r': None, 'b': None, 'c': None, 'd': None} + +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" + + 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 + diff --git a/python-3.7.4-docs-html/_sources/howto/functional.rst.txt b/python-3.7.4-docs-html/_sources/howto/functional.rst.txt new file mode 100644 index 0000000..f8f2aac --- /dev/null +++ b/python-3.7.4-docs-html/_sources/howto/functional.rst.txt @@ -0,0 +1,1262 @@ +******************************** + Functional Programming HOWTO +******************************** + +:Author: A. M. Kuchling +:Release: 0.32 + +In this document, we'll take a tour of Python's features suitable for +implementing programs in a functional style. After an introduction to the +concepts of functional programming, we'll look at language features such as +:term:`iterator`\s and :term:`generator`\s and relevant library modules such as +:mod:`itertools` and :mod:`functools`. + + +Introduction +============ + +This section explains the basic concept of functional programming; if +you're just interested in learning about Python language features, +skip to the next section on :ref:`functional-howto-iterators`. + +Programming languages support decomposing problems in several different ways: + +* Most programming languages are **procedural**: programs are lists of + instructions that tell the computer what to do with the program's input. C, + Pascal, and even Unix shells are procedural languages. + +* In **declarative** languages, you write a specification that describes the + problem to be solved, and the language implementation figures out how to + perform the computation efficiently. SQL is the declarative language you're + most likely to be familiar with; a SQL query describes the data set you want + to retrieve, and the SQL engine decides whether to scan tables or use indexes, + which subclauses should be performed first, etc. + +* **Object-oriented** programs manipulate collections of objects. Objects have + internal state and support methods that query or modify this internal state in + some way. Smalltalk and Java are object-oriented languages. C++ and Python + are languages that support object-oriented programming, but don't force the + use of object-oriented features. + +* **Functional** programming decomposes a problem into a set of functions. + Ideally, functions only take inputs and produce outputs, and don't have any + internal state that affects the output produced for a given input. Well-known + functional languages include the ML family (Standard ML, OCaml, and other + variants) and Haskell. + +The designers of some computer languages choose to emphasize one +particular approach to programming. This often makes it difficult to +write programs that use a different approach. Other languages are +multi-paradigm languages that support several different approaches. +Lisp, C++, and Python are multi-paradigm; you can write programs or +libraries that are largely procedural, object-oriented, or functional +in all of these languages. In a large program, different sections +might be written using different approaches; the GUI might be +object-oriented while the processing logic is procedural or +functional, for example. + +In a functional program, input flows through a set of functions. Each function +operates on its input and produces some output. Functional style discourages +functions with side effects that modify internal state or make other changes +that aren't visible in the function's return value. Functions that have no side +effects at all are called **purely functional**. Avoiding side effects means +not using data structures that get updated as a program runs; every function's +output must only depend on its input. + +Some languages are very strict about purity and don't even have assignment +statements such as ``a=3`` or ``c = a + b``, but it's difficult to avoid all +side effects. Printing to the screen or writing to a disk file are side +effects, for example. For example, in Python a call to the :func:`print` or +:func:`time.sleep` function both return no useful value; they're only called for +their side effects of sending some text to the screen or pausing execution for a +second. + +Python programs written in functional style usually won't go to the extreme of +avoiding all I/O or all assignments; instead, they'll provide a +functional-appearing interface but will use non-functional features internally. +For example, the implementation of a function will still use assignments to +local variables, but won't modify global variables or have other side effects. + +Functional programming can be considered the opposite of object-oriented +programming. Objects are little capsules containing some internal state along +with a collection of method calls that let you modify this state, and programs +consist of making the right set of state changes. Functional programming wants +to avoid state changes as much as possible and works with data flowing between +functions. In Python you might combine the two approaches by writing functions +that take and return instances representing objects in your application (e-mail +messages, transactions, etc.). + +Functional design may seem like an odd constraint to work under. Why should you +avoid objects and side effects? There are theoretical and practical advantages +to the functional style: + +* Formal provability. +* Modularity. +* Composability. +* Ease of debugging and testing. + + +Formal provability +------------------ + +A theoretical benefit is that it's easier to construct a mathematical proof that +a functional program is correct. + +For a long time researchers have been interested in finding ways to +mathematically prove programs correct. This is different from testing a program +on numerous inputs and concluding that its output is usually correct, or reading +a program's source code and concluding that the code looks right; the goal is +instead a rigorous proof that a program produces the right result for all +possible inputs. + +The technique used to prove programs correct is to write down **invariants**, +properties of the input data and of the program's variables that are always +true. For each line of code, you then show that if invariants X and Y are true +**before** the line is executed, the slightly different invariants X' and Y' are +true **after** the line is executed. This continues until you reach the end of +the program, at which point the invariants should match the desired conditions +on the program's output. + +Functional programming's avoidance of assignments arose because assignments are +difficult to handle with this technique; assignments can break invariants that +were true before the assignment without producing any new invariants that can be +propagated onward. + +Unfortunately, proving programs correct is largely impractical and not relevant +to Python software. Even trivial programs require proofs that are several pages +long; the proof of correctness for a moderately complicated program would be +enormous, and few or none of the programs you use daily (the Python interpreter, +your XML parser, your web browser) could be proven correct. Even if you wrote +down or generated a proof, there would then be the question of verifying the +proof; maybe there's an error in it, and you wrongly believe you've proved the +program correct. + + +Modularity +---------- + +A more practical benefit of functional programming is that it forces you to +break apart your problem into small pieces. Programs are more modular as a +result. It's easier to specify and write a small function that does one thing +than a large function that performs a complicated transformation. Small +functions are also easier to read and to check for errors. + + +Ease of debugging and testing +----------------------------- + +Testing and debugging a functional-style program is easier. + +Debugging is simplified because functions are generally small and clearly +specified. When a program doesn't work, each function is an interface point +where you can check that the data are correct. You can look at the intermediate +inputs and outputs to quickly isolate the function that's responsible for a bug. + +Testing is easier because each function is a potential subject for a unit test. +Functions don't depend on system state that needs to be replicated before +running a test; instead you only have to synthesize the right input and then +check that the output matches expectations. + + +Composability +------------- + +As you work on a functional-style program, you'll write a number of functions +with varying inputs and outputs. Some of these functions will be unavoidably +specialized to a particular application, but others will be useful in a wide +variety of programs. For example, a function that takes a directory path and +returns all the XML files in the directory, or a function that takes a filename +and returns its contents, can be applied to many different situations. + +Over time you'll form a personal library of utilities. Often you'll assemble +new programs by arranging existing functions in a new configuration and writing +a few functions specialized for the current task. + + +.. _functional-howto-iterators: + +Iterators +========= + +I'll start by looking at a Python language feature that's an important +foundation for writing functional-style programs: iterators. + +An iterator is an object representing a stream of data; this object returns the +data one element at a time. A Python iterator must support a method called +:meth:`~iterator.__next__` that takes no arguments and always returns the next +element of the stream. If there are no more elements in the stream, +:meth:`~iterator.__next__` must raise the :exc:`StopIteration` exception. +Iterators don't have to be finite, though; it's perfectly reasonable to write +an iterator that produces an infinite stream of data. + +The built-in :func:`iter` function takes an arbitrary object and tries to return +an iterator that will return the object's contents or elements, raising +:exc:`TypeError` if the object doesn't support iteration. Several of Python's +built-in data types support iteration, the most common being lists and +dictionaries. An object is called :term:`iterable` if you can get an iterator +for it. + +You can experiment with the iteration interface manually: + + >>> L = [1, 2, 3] + >>> it = iter(L) + >>> it #doctest: +ELLIPSIS + <...iterator object at ...> + >>> it.__next__() # same as next(it) + 1 + >>> next(it) + 2 + >>> next(it) + 3 + >>> next(it) + Traceback (most recent call last): + File "", line 1, in + StopIteration + >>> + +Python expects iterable objects in several different contexts, the most +important being the :keyword:`for` statement. In the statement ``for X in Y``, +Y must be an iterator or some object for which :func:`iter` can create an +iterator. These two statements are equivalent:: + + + for i in iter(obj): + print(i) + + for i in obj: + print(i) + +Iterators can be materialized as lists or tuples by using the :func:`list` or +:func:`tuple` constructor functions: + + >>> L = [1, 2, 3] + >>> iterator = iter(L) + >>> t = tuple(iterator) + >>> t + (1, 2, 3) + +Sequence unpacking also supports iterators: if you know an iterator will return +N elements, you can unpack them into an N-tuple: + + >>> L = [1, 2, 3] + >>> iterator = iter(L) + >>> a, b, c = iterator + >>> a, b, c + (1, 2, 3) + +Built-in functions such as :func:`max` and :func:`min` can take a single +iterator argument and will return the largest or smallest element. The ``"in"`` +and ``"not in"`` operators also support iterators: ``X in iterator`` is true if +X is found in the stream returned by the iterator. You'll run into obvious +problems if the iterator is infinite; :func:`max`, :func:`min` +will never return, and if the element X never appears in the stream, the +``"in"`` and ``"not in"`` operators won't return either. + +Note that you can only go forward in an iterator; there's no way to get the +previous element, reset the iterator, or make a copy of it. Iterator objects +can optionally provide these additional capabilities, but the iterator protocol +only specifies the :meth:`~iterator.__next__` method. Functions may therefore +consume all of the iterator's output, and if you need to do something different +with the same stream, you'll have to create a new iterator. + + + +Data Types That Support Iterators +--------------------------------- + +We've already seen how lists and tuples support iterators. In fact, any Python +sequence type, such as strings, will automatically support creation of an +iterator. + +Calling :func:`iter` on a dictionary returns an iterator that will loop over the +dictionary's keys:: + + >>> m = {'Jan': 1, 'Feb': 2, 'Mar': 3, 'Apr': 4, 'May': 5, 'Jun': 6, + ... 'Jul': 7, 'Aug': 8, 'Sep': 9, 'Oct': 10, 'Nov': 11, 'Dec': 12} + >>> for key in m: + ... print(key, m[key]) + Jan 1 + Feb 2 + Mar 3 + Apr 4 + May 5 + Jun 6 + Jul 7 + Aug 8 + Sep 9 + Oct 10 + Nov 11 + Dec 12 + +Note that starting with Python 3.7, dictionary iteration order is guaranteed +to be the same as the insertion order. In earlier versions, the behaviour was +unspecified and could vary between implementations. + +Applying :func:`iter` to a dictionary always loops over the keys, but +dictionaries have methods that return other iterators. If you want to iterate +over values or key/value pairs, you can explicitly call the +:meth:`~dict.values` or :meth:`~dict.items` methods to get an appropriate +iterator. + +The :func:`dict` constructor can accept an iterator that returns a finite stream +of ``(key, value)`` tuples: + + >>> L = [('Italy', 'Rome'), ('France', 'Paris'), ('US', 'Washington DC')] + >>> dict(iter(L)) + {'Italy': 'Rome', 'France': 'Paris', 'US': 'Washington DC'} + +Files also support iteration by calling the :meth:`~io.TextIOBase.readline` +method until there are no more lines in the file. This means you can read each +line of a file like this:: + + for line in file: + # do something for each line + ... + +Sets can take their contents from an iterable and let you iterate over the set's +elements:: + + S = {2, 3, 5, 7, 11, 13} + for i in S: + print(i) + + + +Generator expressions and list comprehensions +============================================= + +Two common operations on an iterator's output are 1) performing some operation +for every element, 2) selecting a subset of elements that meet some condition. +For example, given a list of strings, you might want to strip off trailing +whitespace from each line or extract all the strings containing a given +substring. + +List comprehensions and generator expressions (short form: "listcomps" and +"genexps") are a concise notation for such operations, borrowed from the +functional programming language Haskell (https://www.haskell.org/). You can strip +all the whitespace from a stream of strings with the following code:: + + line_list = [' line 1\n', 'line 2 \n', ...] + + # Generator expression -- returns iterator + stripped_iter = (line.strip() for line in line_list) + + # List comprehension -- returns list + stripped_list = [line.strip() for line in line_list] + +You can select only certain elements by adding an ``"if"`` condition:: + + stripped_list = [line.strip() for line in line_list + if line != ""] + +With a list comprehension, you get back a Python list; ``stripped_list`` is a +list containing the resulting lines, not an iterator. Generator expressions +return an iterator that computes the values as necessary, not needing to +materialize all the values at once. This means that list comprehensions aren't +useful if you're working with iterators that return an infinite stream or a very +large amount of data. Generator expressions are preferable in these situations. + +Generator expressions are surrounded by parentheses ("()") and list +comprehensions are surrounded by square brackets ("[]"). Generator expressions +have the form:: + + ( expression for expr in sequence1 + if condition1 + for expr2 in sequence2 + if condition2 + for expr3 in sequence3 ... + if condition3 + for exprN in sequenceN + if conditionN ) + +Again, for a list comprehension only the outside brackets are different (square +brackets instead of parentheses). + +The elements of the generated output will be the successive values of +``expression``. The ``if`` clauses are all optional; if present, ``expression`` +is only evaluated and added to the result when ``condition`` is true. + +Generator expressions always have to be written inside parentheses, but the +parentheses signalling a function call also count. If you want to create an +iterator that will be immediately passed to a function you can write:: + + obj_total = sum(obj.count for obj in list_all_objects()) + +The ``for...in`` clauses contain the sequences to be iterated over. The +sequences do not have to be the same length, because they are iterated over from +left to right, **not** in parallel. For each element in ``sequence1``, +``sequence2`` is looped over from the beginning. ``sequence3`` is then looped +over for each resulting pair of elements from ``sequence1`` and ``sequence2``. + +To put it another way, a list comprehension or generator expression is +equivalent to the following Python code:: + + for expr1 in sequence1: + if not (condition1): + continue # Skip this element + for expr2 in sequence2: + if not (condition2): + continue # Skip this element + ... + for exprN in sequenceN: + if not (conditionN): + continue # Skip this element + + # 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 +lengths of all the sequences. If you have two lists of length 3, the output +list is 9 elements long: + + >>> seq1 = 'abc' + >>> seq2 = (1, 2, 3) + >>> [(x, y) for x in seq1 for y in seq2] #doctest: +NORMALIZE_WHITESPACE + [('a', 1), ('a', 2), ('a', 3), + ('b', 1), ('b', 2), ('b', 3), + ('c', 1), ('c', 2), ('c', 3)] + +To avoid introducing an ambiguity into Python's grammar, if ``expression`` is +creating a tuple, it must be surrounded with parentheses. The first list +comprehension below is a syntax error, while the second one is correct:: + + # Syntax error + [x, y for x in seq1 for y in seq2] + # Correct + [(x, y) for x in seq1 for y in seq2] + + +Generators +========== + +Generators are a special class of functions that simplify the task of writing +iterators. Regular functions compute a value and return it, but generators +return an iterator that returns a stream of values. + +You're doubtless familiar with how regular function calls work in Python or C. +When you call a function, it gets a private namespace where its local variables +are created. When the function reaches a ``return`` statement, the local +variables are destroyed and the value is returned to the caller. A later call +to the same function creates a new private namespace and a fresh set of local +variables. But, what if the local variables weren't thrown away on exiting a +function? What if you could later resume the function where it left off? This +is what generators provide; they can be thought of as resumable functions. + +Here's the simplest example of a generator function: + + >>> def generate_ints(N): + ... for i in range(N): + ... yield i + +Any function containing a :keyword:`yield` keyword is a generator function; +this is detected by Python's :term:`bytecode` compiler which compiles the +function specially as a result. + +When you call a generator function, it doesn't return a single value; instead it +returns a generator object that supports the iterator protocol. On executing +the ``yield`` expression, the generator outputs the value of ``i``, similar to a +``return`` statement. The big difference between ``yield`` and a ``return`` +statement is that on reaching a ``yield`` the generator's state of execution is +suspended and local variables are preserved. On the next call to the +generator's :meth:`~generator.__next__` method, the function will resume +executing. + +Here's a sample usage of the ``generate_ints()`` generator: + + >>> gen = generate_ints(3) + >>> gen #doctest: +ELLIPSIS + + >>> next(gen) + 0 + >>> next(gen) + 1 + >>> next(gen) + 2 + >>> next(gen) + Traceback (most recent call last): + File "stdin", line 1, in + File "stdin", line 2, in generate_ints + StopIteration + +You could equally write ``for i in generate_ints(5)``, or ``a, b, c = +generate_ints(3)``. + +Inside a generator function, ``return value`` causes ``StopIteration(value)`` +to be raised from the :meth:`~generator.__next__` method. Once this happens, or +the bottom of the function is reached, the procession of values ends and the +generator cannot yield any further values. + +You could achieve the effect of generators manually by writing your own class +and storing all the local variables of the generator as instance variables. For +example, returning a list of integers could be done by setting ``self.count`` to +0, and having the :meth:`~iterator.__next__` method increment ``self.count`` and +return it. +However, for a moderately complicated generator, writing a corresponding class +can be much messier. + +The test suite included with Python's library, +:source:`Lib/test/test_generators.py`, contains +a number of more interesting examples. Here's one generator that implements an +in-order traversal of a tree using generators recursively. :: + + # A recursive generator that generates Tree leaves in in-order. + def inorder(t): + if t: + for x in inorder(t.left): + yield x + + yield t.label + + for x in inorder(t.right): + yield x + +Two other examples in ``test_generators.py`` produce solutions for the N-Queens +problem (placing N queens on an NxN chess board so that no queen threatens +another) and the Knight's Tour (finding a route that takes a knight to every +square of an NxN chessboard without visiting any square twice). + + + +Passing values into a generator +------------------------------- + +In Python 2.4 and earlier, generators only produced output. Once a generator's +code was invoked to create an iterator, there was no way to pass any new +information into the function when its execution is resumed. You could hack +together this ability by making the generator look at a global variable or by +passing in some mutable object that callers then modify, but these approaches +are messy. + +In Python 2.5 there's a simple way to pass values into a generator. +:keyword:`yield` became an expression, returning a value that can be assigned to +a variable or otherwise operated on:: + + val = (yield i) + +I recommend that you **always** put parentheses around a ``yield`` expression +when you're doing something with the returned value, as in the above example. +The parentheses aren't always necessary, but it's easier to always add them +instead of having to remember when they're needed. + +(:pep:`342` explains the exact rules, which are that a ``yield``-expression must +always be parenthesized except when it occurs at the top-level expression on the +right-hand side of an assignment. This means you can write ``val = yield i`` +but have to use parentheses when there's an operation, as in ``val = (yield i) ++ 12``.) + +Values are sent into a generator by calling its :meth:`send(value) +` method. This method resumes the generator's code and the +``yield`` expression returns the specified value. If the regular +:meth:`~generator.__next__` method is called, the ``yield`` returns ``None``. + +Here's a simple counter that increments by 1 and allows changing the value of +the internal counter. + +.. testcode:: + + def counter(maximum): + i = 0 + while i < maximum: + val = (yield i) + # If value provided, change counter + if val is not None: + i = val + else: + i += 1 + +And here's an example of changing the counter: + + >>> it = counter(10) #doctest: +SKIP + >>> next(it) #doctest: +SKIP + 0 + >>> next(it) #doctest: +SKIP + 1 + >>> it.send(8) #doctest: +SKIP + 8 + >>> next(it) #doctest: +SKIP + 9 + >>> next(it) #doctest: +SKIP + Traceback (most recent call last): + File "t.py", line 15, in + it.next() + StopIteration + +Because ``yield`` will often be returning ``None``, you should always check for +this case. Don't just use its value in expressions unless you're sure that the +:meth:`~generator.send` method will be the only method used to resume your +generator function. + +In addition to :meth:`~generator.send`, there are two other methods on +generators: + +* :meth:`throw(type, value=None, traceback=None) ` is used to + raise an exception inside the generator; the exception is raised by the + ``yield`` expression where the generator's execution is paused. + +* :meth:`~generator.close` raises a :exc:`GeneratorExit` exception inside the + generator to terminate the iteration. On receiving this exception, the + generator's code must either raise :exc:`GeneratorExit` or + :exc:`StopIteration`; catching the exception and doing anything else is + illegal and will trigger a :exc:`RuntimeError`. :meth:`~generator.close` + will also be called by Python's garbage collector when the generator is + garbage-collected. + + If you need to run cleanup code when a :exc:`GeneratorExit` occurs, I suggest + using a ``try: ... finally:`` suite instead of catching :exc:`GeneratorExit`. + +The cumulative effect of these changes is to turn generators from one-way +producers of information into both producers and consumers. + +Generators also become **coroutines**, a more generalized form of subroutines. +Subroutines are entered at one point and exited at another point (the top of the +function, and a ``return`` statement), but coroutines can be entered, exited, +and resumed at many different points (the ``yield`` statements). + + +Built-in functions +================== + +Let's look in more detail at built-in functions often used with iterators. + +Two of Python's built-in functions, :func:`map` and :func:`filter` duplicate the +features of generator expressions: + +:func:`map(f, iterA, iterB, ...) ` returns an iterator over the sequence + ``f(iterA[0], iterB[0]), f(iterA[1], iterB[1]), f(iterA[2], iterB[2]), ...``. + + >>> def upper(s): + ... return s.upper() + + >>> list(map(upper, ['sentence', 'fragment'])) + ['SENTENCE', 'FRAGMENT'] + >>> [upper(s) for s in ['sentence', 'fragment']] + ['SENTENCE', 'FRAGMENT'] + +You can of course achieve the same effect with a list comprehension. + +:func:`filter(predicate, iter) ` returns an iterator over all the +sequence elements that meet a certain condition, and is similarly duplicated by +list comprehensions. A **predicate** is a function that returns the truth +value of some condition; for use with :func:`filter`, the predicate must take a +single value. + + >>> def is_even(x): + ... return (x % 2) == 0 + + >>> list(filter(is_even, range(10))) + [0, 2, 4, 6, 8] + + +This can also be written as a list comprehension: + + >>> list(x for x in range(10) if is_even(x)) + [0, 2, 4, 6, 8] + + +:func:`enumerate(iter, start=0) ` counts off the elements in the +iterable returning 2-tuples containing the count (from *start*) and +each element. :: + + >>> for item in enumerate(['subject', 'verb', 'object']): + ... print(item) + (0, 'subject') + (1, 'verb') + (2, 'object') + +:func:`enumerate` is often used when looping through a list and recording the +indexes at which certain conditions are met:: + + f = open('data.txt', 'r') + for i, line in enumerate(f): + if line.strip() == '': + print('Blank line at line #%i' % i) + +:func:`sorted(iterable, key=None, reverse=False) ` collects all the +elements of the iterable into a list, sorts the list, and returns the sorted +result. The *key* and *reverse* arguments are passed through to the +constructed list's :meth:`~list.sort` method. :: + + >>> import random + >>> # Generate 8 random numbers between [0, 10000) + >>> rand_list = random.sample(range(10000), 8) + >>> rand_list #doctest: +SKIP + [769, 7953, 9828, 6431, 8442, 9878, 6213, 2207] + >>> sorted(rand_list) #doctest: +SKIP + [769, 2207, 6213, 6431, 7953, 8442, 9828, 9878] + >>> sorted(rand_list, reverse=True) #doctest: +SKIP + [9878, 9828, 8442, 7953, 6431, 6213, 2207, 769] + +(For a more detailed discussion of sorting, see the :ref:`sortinghowto`.) + + +The :func:`any(iter) ` and :func:`all(iter) ` built-ins look at the +truth values of an iterable's contents. :func:`any` returns ``True`` if any element +in the iterable is a true value, and :func:`all` returns ``True`` if all of the +elements are true values: + + >>> any([0, 1, 0]) + True + >>> any([0, 0, 0]) + False + >>> any([1, 1, 1]) + True + >>> all([0, 1, 0]) + False + >>> all([0, 0, 0]) + False + >>> all([1, 1, 1]) + True + + +:func:`zip(iterA, iterB, ...) ` takes one element from each iterable and +returns them in a tuple:: + + zip(['a', 'b', 'c'], (1, 2, 3)) => + ('a', 1), ('b', 2), ('c', 3) + +It doesn't construct an in-memory list and exhaust all the input iterators +before returning; instead tuples are constructed and returned only if they're +requested. (The technical term for this behaviour is `lazy evaluation +`__.) + +This iterator is intended to be used with iterables that are all of the same +length. If the iterables are of different lengths, the resulting stream will be +the same length as the shortest iterable. :: + + zip(['a', 'b'], (1, 2, 3)) => + ('a', 1), ('b', 2) + +You should avoid doing this, though, because an element may be taken from the +longer iterators and discarded. This means you can't go on to use the iterators +further because you risk skipping a discarded element. + + +The itertools module +==================== + +The :mod:`itertools` module contains a number of commonly-used iterators as well +as functions for combining several iterators. This section will introduce the +module's contents by showing small examples. + +The module's functions fall into a few broad classes: + +* Functions that create a new iterator based on an existing iterator. +* Functions for treating an iterator's elements as function arguments. +* Functions for selecting portions of an iterator's output. +* A function for grouping an iterator's output. + +Creating new iterators +---------------------- + +:func:`itertools.count(start, step) ` returns an infinite +stream of evenly spaced values. You can optionally supply the starting number, +which defaults to 0, and the interval between numbers, which defaults to 1:: + + itertools.count() => + 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, ... + itertools.count(10) => + 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, ... + itertools.count(10, 5) => + 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, ... + +:func:`itertools.cycle(iter) ` saves a copy of the contents of +a provided iterable and returns a new iterator that returns its elements from +first to last. The new iterator will repeat these elements infinitely. :: + + itertools.cycle([1, 2, 3, 4, 5]) => + 1, 2, 3, 4, 5, 1, 2, 3, 4, 5, ... + +:func:`itertools.repeat(elem, [n]) ` returns the provided +element *n* times, or returns the element endlessly if *n* is not provided. :: + + itertools.repeat('abc') => + abc, abc, abc, abc, abc, abc, abc, abc, abc, abc, ... + itertools.repeat('abc', 5) => + abc, abc, abc, abc, abc + +:func:`itertools.chain(iterA, iterB, ...) ` takes an arbitrary +number of iterables as input, and returns all the elements of the first +iterator, then all the elements of the second, and so on, until all of the +iterables have been exhausted. :: + + itertools.chain(['a', 'b', 'c'], (1, 2, 3)) => + a, b, c, 1, 2, 3 + +:func:`itertools.islice(iter, [start], stop, [step]) ` returns +a stream that's a slice of the iterator. With a single *stop* argument, it +will return the first *stop* elements. If you supply a starting index, you'll +get *stop-start* elements, and if you supply a value for *step*, elements +will be skipped accordingly. Unlike Python's string and list slicing, you can't +use negative values for *start*, *stop*, or *step*. :: + + itertools.islice(range(10), 8) => + 0, 1, 2, 3, 4, 5, 6, 7 + itertools.islice(range(10), 2, 8) => + 2, 3, 4, 5, 6, 7 + itertools.islice(range(10), 2, 8, 2) => + 2, 4, 6 + +:func:`itertools.tee(iter, [n]) ` replicates an iterator; it +returns *n* independent iterators that will all return the contents of the +source iterator. +If you don't supply a value for *n*, the default is 2. Replicating iterators +requires saving some of the contents of the source iterator, so this can consume +significant memory if the iterator is large and one of the new iterators is +consumed more than the others. :: + + itertools.tee( itertools.count() ) => + iterA, iterB + + where iterA -> + 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, ... + + and iterB -> + 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, ... + + +Calling functions on elements +----------------------------- + +The :mod:`operator` module contains a set of functions corresponding to Python's +operators. Some examples are :func:`operator.add(a, b) ` (adds +two values), :func:`operator.ne(a, b) ` (same as ``a != b``), and +:func:`operator.attrgetter('id') ` +(returns a callable that fetches the ``.id`` attribute). + +:func:`itertools.starmap(func, iter) ` assumes that the +iterable will return a stream of tuples, and calls *func* using these tuples as +the arguments:: + + itertools.starmap(os.path.join, + [('/bin', 'python'), ('/usr', 'bin', 'java'), + ('/usr', 'bin', 'perl'), ('/usr', 'bin', 'ruby')]) + => + /bin/python, /usr/bin/java, /usr/bin/perl, /usr/bin/ruby + + +Selecting elements +------------------ + +Another group of functions chooses a subset of an iterator's elements based on a +predicate. + +:func:`itertools.filterfalse(predicate, iter) ` is the +opposite of :func:`filter`, returning all elements for which the predicate +returns false:: + + itertools.filterfalse(is_even, itertools.count()) => + 1, 3, 5, 7, 9, 11, 13, 15, ... + +:func:`itertools.takewhile(predicate, iter) ` returns +elements for as long as the predicate returns true. Once the predicate returns +false, the iterator will signal the end of its results. :: + + def less_than_10(x): + return x < 10 + + itertools.takewhile(less_than_10, itertools.count()) => + 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 + + itertools.takewhile(is_even, itertools.count()) => + 0 + +:func:`itertools.dropwhile(predicate, iter) ` discards +elements while the predicate returns true, and then returns the rest of the +iterable's results. :: + + itertools.dropwhile(less_than_10, itertools.count()) => + 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, ... + + itertools.dropwhile(is_even, itertools.count()) => + 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, ... + +:func:`itertools.compress(data, selectors) ` takes two +iterators and returns only those elements of *data* for which the corresponding +element of *selectors* is true, stopping whenever either one is exhausted:: + + itertools.compress([1, 2, 3, 4, 5], [True, True, False, False, True]) => + 1, 2, 5 + + +Combinatoric functions +---------------------- + +The :func:`itertools.combinations(iterable, r) ` +returns an iterator giving all possible *r*-tuple combinations of the +elements contained in *iterable*. :: + + itertools.combinations([1, 2, 3, 4, 5], 2) => + (1, 2), (1, 3), (1, 4), (1, 5), + (2, 3), (2, 4), (2, 5), + (3, 4), (3, 5), + (4, 5) + + itertools.combinations([1, 2, 3, 4, 5], 3) => + (1, 2, 3), (1, 2, 4), (1, 2, 5), (1, 3, 4), (1, 3, 5), (1, 4, 5), + (2, 3, 4), (2, 3, 5), (2, 4, 5), + (3, 4, 5) + +The elements within each tuple remain in the same order as +*iterable* returned them. For example, the number 1 is always before +2, 3, 4, or 5 in the examples above. A similar function, +:func:`itertools.permutations(iterable, r=None) `, +removes this constraint on the order, returning all possible +arrangements of length *r*:: + + itertools.permutations([1, 2, 3, 4, 5], 2) => + (1, 2), (1, 3), (1, 4), (1, 5), + (2, 1), (2, 3), (2, 4), (2, 5), + (3, 1), (3, 2), (3, 4), (3, 5), + (4, 1), (4, 2), (4, 3), (4, 5), + (5, 1), (5, 2), (5, 3), (5, 4) + + itertools.permutations([1, 2, 3, 4, 5]) => + (1, 2, 3, 4, 5), (1, 2, 3, 5, 4), (1, 2, 4, 3, 5), + ... + (5, 4, 3, 2, 1) + +If you don't supply a value for *r* the length of the iterable is used, +meaning that all the elements are permuted. + +Note that these functions produce all of the possible combinations by +position and don't require that the contents of *iterable* are unique:: + + itertools.permutations('aba', 3) => + ('a', 'b', 'a'), ('a', 'a', 'b'), ('b', 'a', 'a'), + ('b', 'a', 'a'), ('a', 'a', 'b'), ('a', 'b', 'a') + +The identical tuple ``('a', 'a', 'b')`` occurs twice, but the two 'a' +strings came from different positions. + +The :func:`itertools.combinations_with_replacement(iterable, r) ` +function relaxes a different constraint: elements can be repeated +within a single tuple. Conceptually an element is selected for the +first position of each tuple and then is replaced before the second +element is selected. :: + + itertools.combinations_with_replacement([1, 2, 3, 4, 5], 2) => + (1, 1), (1, 2), (1, 3), (1, 4), (1, 5), + (2, 2), (2, 3), (2, 4), (2, 5), + (3, 3), (3, 4), (3, 5), + (4, 4), (4, 5), + (5, 5) + + +Grouping elements +----------------- + +The last function I'll discuss, :func:`itertools.groupby(iter, key_func=None) +`, is the most complicated. ``key_func(elem)`` is a function +that can compute a key value for each element returned by the iterable. If you +don't supply a key function, the key is simply each element itself. + +:func:`~itertools.groupby` collects all the consecutive elements from the +underlying iterable that have the same key value, and returns a stream of +2-tuples containing a key value and an iterator for the elements with that key. + +:: + + city_list = [('Decatur', 'AL'), ('Huntsville', 'AL'), ('Selma', 'AL'), + ('Anchorage', 'AK'), ('Nome', 'AK'), + ('Flagstaff', 'AZ'), ('Phoenix', 'AZ'), ('Tucson', 'AZ'), + ... + ] + + def get_state(city_state): + return city_state[1] + + itertools.groupby(city_list, get_state) => + ('AL', iterator-1), + ('AK', iterator-2), + ('AZ', iterator-3), ... + + where + iterator-1 => + ('Decatur', 'AL'), ('Huntsville', 'AL'), ('Selma', 'AL') + iterator-2 => + ('Anchorage', 'AK'), ('Nome', 'AK') + iterator-3 => + ('Flagstaff', 'AZ'), ('Phoenix', 'AZ'), ('Tucson', 'AZ') + +:func:`~itertools.groupby` assumes that the underlying iterable's contents will +already be sorted based on the key. Note that the returned iterators also use +the underlying iterable, so you have to consume the results of iterator-1 before +requesting iterator-2 and its corresponding key. + + +The functools module +==================== + +The :mod:`functools` module in Python 2.5 contains some higher-order functions. +A **higher-order function** takes one or more functions as input and returns a +new function. The most useful tool in this module is the +:func:`functools.partial` function. + +For programs written in a functional style, you'll sometimes want to construct +variants of existing functions that have some of the parameters filled in. +Consider a Python function ``f(a, b, c)``; you may wish to create a new function +``g(b, c)`` that's equivalent to ``f(1, b, c)``; you're filling in a value for +one of ``f()``'s parameters. This is called "partial function application". + +The constructor for :func:`~functools.partial` takes the arguments +``(function, arg1, arg2, ..., kwarg1=value1, kwarg2=value2)``. The resulting +object is callable, so you can just call it to invoke ``function`` with the +filled-in arguments. + +Here's a small but realistic example:: + + import functools + + def log(message, subsystem): + """Write the contents of 'message' to the specified subsystem.""" + print('%s: %s' % (subsystem, message)) + ... + + server_log = functools.partial(log, subsystem='server') + server_log('Unable to open socket') + +:func:`functools.reduce(func, iter, [initial_value]) ` +cumulatively performs an operation on all the iterable's elements and, +therefore, can't be applied to infinite iterables. *func* must be a function +that takes two elements and returns a single value. :func:`functools.reduce` +takes the first two elements A and B returned by the iterator and calculates +``func(A, B)``. It then requests the third element, C, calculates +``func(func(A, B), C)``, combines this result with the fourth element returned, +and continues until the iterable is exhausted. If the iterable returns no +values at all, a :exc:`TypeError` exception is raised. If the initial value is +supplied, it's used as a starting point and ``func(initial_value, A)`` is the +first calculation. :: + + >>> import operator, functools + >>> functools.reduce(operator.concat, ['A', 'BB', 'C']) + 'ABBC' + >>> functools.reduce(operator.concat, []) + Traceback (most recent call last): + ... + TypeError: reduce() of empty sequence with no initial value + >>> functools.reduce(operator.mul, [1, 2, 3], 1) + 6 + >>> functools.reduce(operator.mul, [], 1) + 1 + +If you use :func:`operator.add` with :func:`functools.reduce`, you'll add up all the +elements of the iterable. This case is so common that there's a special +built-in called :func:`sum` to compute it: + + >>> import functools, operator + >>> functools.reduce(operator.add, [1, 2, 3, 4], 0) + 10 + >>> sum([1, 2, 3, 4]) + 10 + >>> sum([]) + 0 + +For many uses of :func:`functools.reduce`, though, it can be clearer to just +write the obvious :keyword:`for` loop:: + + import functools + # Instead of: + product = functools.reduce(operator.mul, [1, 2, 3], 1) + + # You can write: + product = 1 + for i in [1, 2, 3]: + product *= i + +A related function is :func:`itertools.accumulate(iterable, func=operator.add) +`. It performs the same calculation, but instead of +returning only the final result, :func:`accumulate` returns an iterator that +also yields each partial result:: + + itertools.accumulate([1, 2, 3, 4, 5]) => + 1, 3, 6, 10, 15 + + itertools.accumulate([1, 2, 3, 4, 5], operator.mul) => + 1, 2, 6, 24, 120 + + +The operator module +------------------- + +The :mod:`operator` module was mentioned earlier. It contains a set of +functions corresponding to Python's operators. These functions are often useful +in functional-style code because they save you from writing trivial functions +that perform a single operation. + +Some of the functions in this module are: + +* Math operations: ``add()``, ``sub()``, ``mul()``, ``floordiv()``, ``abs()``, ... +* Logical operations: ``not_()``, ``truth()``. +* Bitwise operations: ``and_()``, ``or_()``, ``invert()``. +* Comparisons: ``eq()``, ``ne()``, ``lt()``, ``le()``, ``gt()``, and ``ge()``. +* Object identity: ``is_()``, ``is_not()``. + +Consult the operator module's documentation for a complete list. + + +Small functions and the lambda expression +========================================= + +When writing functional-style programs, you'll often need little functions that +act as predicates or that combine elements in some way. + +If there's a Python built-in or a module function that's suitable, you don't +need to define a new function at all:: + + stripped_lines = [line.strip() for line in lines] + existing_files = filter(os.path.exists, file_list) + +If the function you need doesn't exist, you need to write it. One way to write +small functions is to use the :keyword:`lambda` expression. ``lambda`` takes a +number of parameters and an expression combining these parameters, and creates +an anonymous function that returns the value of the expression:: + + adder = lambda x, y: x+y + + print_assign = lambda name, value: name + '=' + str(value) + +An alternative is to just use the ``def`` statement and define a function in the +usual way:: + + def adder(x, y): + return x + y + + def print_assign(name, value): + return name + '=' + str(value) + +Which alternative is preferable? That's a style question; my usual course is to +avoid using ``lambda``. + +One reason for my preference is that ``lambda`` is quite limited in the +functions it can define. The result has to be computable as a single +expression, which means you can't have multiway ``if... elif... else`` +comparisons or ``try... except`` statements. If you try to do too much in a +``lambda`` statement, you'll end up with an overly complicated expression that's +hard to read. Quick, what's the following code doing? :: + + import functools + total = functools.reduce(lambda a, b: (0, a[1] + b[1]), items)[1] + +You can figure it out, but it takes time to disentangle the expression to figure +out what's going on. Using a short nested ``def`` statements makes things a +little bit better:: + + import functools + def combine(a, b): + return 0, a[1] + b[1] + + total = functools.reduce(combine, items)[1] + +But it would be best of all if I had simply used a ``for`` loop:: + + total = 0 + for a, b in items: + total += b + +Or the :func:`sum` built-in and a generator expression:: + + total = sum(b for a, b in items) + +Many uses of :func:`functools.reduce` are clearer when written as ``for`` loops. + +Fredrik Lundh once suggested the following set of rules for refactoring uses of +``lambda``: + +1. Write a lambda function. +2. Write a comment explaining what the heck that lambda does. +3. Study the comment for a while, and think of a name that captures the essence + of the comment. +4. Convert the lambda to a def statement, using that name. +5. Remove the comment. + +I really like these rules, but you're free to disagree +about whether this lambda-free style is better. + + +Revision History and Acknowledgements +===================================== + +The author would like to thank the following people for offering suggestions, +corrections and assistance with various drafts of this article: Ian Bicking, +Nick Coghlan, Nick Efford, Raymond Hettinger, Jim Jewett, Mike Krell, Leandro +Lameiro, Jussi Salmela, Collin Winter, Blake Winton. + +Version 0.1: posted June 30 2006. + +Version 0.11: posted July 1 2006. Typo fixes. + +Version 0.2: posted July 10 2006. Merged genexp and listcomp sections into one. +Typo fixes. + +Version 0.21: Added more references suggested on the tutor mailing list. + +Version 0.30: Adds a section on the ``functional`` module written by Collin +Winter; adds short section on the operator module; a few other edits. + + +References +========== + +General +------- + +**Structure and Interpretation of Computer Programs**, by Harold Abelson and +Gerald Jay Sussman with Julie Sussman. Full text at +https://mitpress.mit.edu/sicp/. In this classic textbook of computer science, +chapters 2 and 3 discuss the use of sequences and streams to organize the data +flow inside a program. The book uses Scheme for its examples, but many of the +design approaches described in these chapters are applicable to functional-style +Python code. + +http://www.defmacro.org/ramblings/fp.html: A general introduction to functional +programming that uses Java examples and has a lengthy historical introduction. + +https://en.wikipedia.org/wiki/Functional_programming: General Wikipedia entry +describing functional programming. + +https://en.wikipedia.org/wiki/Coroutine: Entry for coroutines. + +https://en.wikipedia.org/wiki/Currying: Entry for the concept of currying. + +Python-specific +--------------- + +http://gnosis.cx/TPiP/: The first chapter of David Mertz's book +:title-reference:`Text Processing in Python` discusses functional programming +for text processing, in the section titled "Utilizing Higher-Order Functions in +Text Processing". + +Mertz also wrote a 3-part series of articles on functional programming +for IBM's DeveloperWorks site; see +`part 1 `__, +`part 2 `__, and +`part 3 `__, + + +Python documentation +-------------------- + +Documentation for the :mod:`itertools` module. + +Documentation for the :mod:`functools` module. + +Documentation for the :mod:`operator` module. + +:pep:`289`: "Generator Expressions" + +:pep:`342`: "Coroutines via Enhanced Generators" describes the new generator +features in Python 2.5. + +.. comment + + Handy little function for printing part of an iterator -- used + while writing this document. + + import itertools + def print_iter(it): + slice = itertools.islice(it, 10) + for elem in slice[:-1]: + sys.stdout.write(str(elem)) + sys.stdout.write(', ') + print(elem[-1]) diff --git a/python-3.7.4-docs-html/_sources/howto/index.rst.txt b/python-3.7.4-docs-html/_sources/howto/index.rst.txt new file mode 100644 index 0000000..593341c --- /dev/null +++ b/python-3.7.4-docs-html/_sources/howto/index.rst.txt @@ -0,0 +1,32 @@ +*************** + Python HOWTOs +*************** + +Python HOWTOs are documents that cover a single, specific topic, +and attempt to cover it fairly completely. Modelled on the Linux +Documentation Project's HOWTO collection, this collection is an +effort to foster documentation that's more detailed than the +Python Library Reference. + +Currently, the HOWTOs are: + +.. toctree:: + :maxdepth: 1 + + pyporting.rst + cporting.rst + curses.rst + descriptor.rst + functional.rst + logging.rst + logging-cookbook.rst + regex.rst + sockets.rst + sorting.rst + unicode.rst + urllib2.rst + argparse.rst + ipaddress.rst + clinic.rst + instrumentation.rst + diff --git a/python-3.7.4-docs-html/_sources/howto/instrumentation.rst.txt b/python-3.7.4-docs-html/_sources/howto/instrumentation.rst.txt new file mode 100644 index 0000000..50cde35 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/howto/instrumentation.rst.txt @@ -0,0 +1,427 @@ +.. highlight:: shell-session + +.. _instrumentation: + +=============================================== +Instrumenting CPython with DTrace and SystemTap +=============================================== + +:author: David Malcolm +:author: Łukasz Langa + +DTrace and SystemTap are monitoring tools, each providing a way to inspect +what the processes on a computer system are doing. They both use +domain-specific languages allowing a user to write scripts which: + + - filter which processes are to be observed + - gather data from the processes of interest + - generate reports on the data + +As of Python 3.6, CPython can be built with embedded "markers", also +known as "probes", that can be observed by a DTrace or SystemTap script, +making it easier to monitor what the CPython processes on a system are +doing. + +.. impl-detail:: + + DTrace markers are implementation details of the CPython interpreter. + No guarantees are made about probe compatibility between versions of + CPython. DTrace scripts can stop working or work incorrectly without + warning when changing CPython versions. + + +Enabling the static markers +--------------------------- + +macOS comes with built-in support for DTrace. On Linux, in order to +build CPython with the embedded markers for SystemTap, the SystemTap +development tools must be installed. + +On a Linux machine, this can be done via:: + + $ yum install systemtap-sdt-devel + +or:: + + $ sudo apt-get install systemtap-sdt-dev + + +CPython must then be configured ``--with-dtrace``: + +.. code-block:: none + + checking for --with-dtrace... yes + +On macOS, you can list available DTrace probes by running a Python +process in the background and listing all probes made available by the +Python provider:: + + $ python3.6 -q & + $ sudo dtrace -l -P python$! # or: dtrace -l -m python3.6 + + ID PROVIDER MODULE FUNCTION NAME + 29564 python18035 python3.6 _PyEval_EvalFrameDefault function-entry + 29565 python18035 python3.6 dtrace_function_entry function-entry + 29566 python18035 python3.6 _PyEval_EvalFrameDefault function-return + 29567 python18035 python3.6 dtrace_function_return function-return + 29568 python18035 python3.6 collect gc-done + 29569 python18035 python3.6 collect gc-start + 29570 python18035 python3.6 _PyEval_EvalFrameDefault line + 29571 python18035 python3.6 maybe_dtrace_line line + +On Linux, you can verify if the SystemTap static markers are present in +the built binary by seeing if it contains a ".note.stapsdt" section. + +:: + + $ readelf -S ./python | grep .note.stapsdt + [30] .note.stapsdt NOTE 0000000000000000 00308d78 + +If you've built Python as a shared library (with --enable-shared), you +need to look instead within the shared library. For example:: + + $ readelf -S libpython3.3dm.so.1.0 | grep .note.stapsdt + [29] .note.stapsdt NOTE 0000000000000000 00365b68 + +Sufficiently modern readelf can print the metadata:: + + $ readelf -n ./python + + Displaying notes found at file offset 0x00000254 with length 0x00000020: + Owner Data size Description + GNU 0x00000010 NT_GNU_ABI_TAG (ABI version tag) + OS: Linux, ABI: 2.6.32 + + Displaying notes found at file offset 0x00000274 with length 0x00000024: + Owner Data size Description + GNU 0x00000014 NT_GNU_BUILD_ID (unique build ID bitstring) + Build ID: df924a2b08a7e89f6e11251d4602022977af2670 + + Displaying notes found at file offset 0x002d6c30 with length 0x00000144: + Owner Data size Description + stapsdt 0x00000031 NT_STAPSDT (SystemTap probe descriptors) + Provider: python + Name: gc__start + Location: 0x00000000004371c3, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6bf6 + Arguments: -4@%ebx + stapsdt 0x00000030 NT_STAPSDT (SystemTap probe descriptors) + Provider: python + Name: gc__done + Location: 0x00000000004374e1, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6bf8 + Arguments: -8@%rax + stapsdt 0x00000045 NT_STAPSDT (SystemTap probe descriptors) + Provider: python + Name: function__entry + Location: 0x000000000053db6c, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6be8 + Arguments: 8@%rbp 8@%r12 -4@%eax + stapsdt 0x00000046 NT_STAPSDT (SystemTap probe descriptors) + Provider: python + Name: function__return + Location: 0x000000000053dba8, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6bea + Arguments: 8@%rbp 8@%r12 -4@%eax + +The above metadata contains information for SystemTap describing how it +can patch strategically-placed machine code instructions to enable the +tracing hooks used by a SystemTap script. + + +Static DTrace probes +-------------------- + +The following example DTrace script can be used to show the call/return +hierarchy of a Python script, only tracing within the invocation of +a function called "start". In other words, import-time function +invocations are not going to be listed: + +.. code-block:: none + + self int indent; + + python$target:::function-entry + /copyinstr(arg1) == "start"/ + { + self->trace = 1; + } + + python$target:::function-entry + /self->trace/ + { + printf("%d\t%*s:", timestamp, 15, probename); + printf("%*s", self->indent, ""); + printf("%s:%s:%d\n", basename(copyinstr(arg0)), copyinstr(arg1), arg2); + self->indent++; + } + + python$target:::function-return + /self->trace/ + { + self->indent--; + printf("%d\t%*s:", timestamp, 15, probename); + printf("%*s", self->indent, ""); + printf("%s:%s:%d\n", basename(copyinstr(arg0)), copyinstr(arg1), arg2); + } + + python$target:::function-return + /copyinstr(arg1) == "start"/ + { + self->trace = 0; + } + +It can be invoked like this:: + + $ sudo dtrace -q -s call_stack.d -c "python3.6 script.py" + +The output looks like this: + +.. code-block:: none + + 156641360502280 function-entry:call_stack.py:start:23 + 156641360518804 function-entry: call_stack.py:function_1:1 + 156641360532797 function-entry: call_stack.py:function_3:9 + 156641360546807 function-return: call_stack.py:function_3:10 + 156641360563367 function-return: call_stack.py:function_1:2 + 156641360578365 function-entry: call_stack.py:function_2:5 + 156641360591757 function-entry: call_stack.py:function_1:1 + 156641360605556 function-entry: call_stack.py:function_3:9 + 156641360617482 function-return: call_stack.py:function_3:10 + 156641360629814 function-return: call_stack.py:function_1:2 + 156641360642285 function-return: call_stack.py:function_2:6 + 156641360656770 function-entry: call_stack.py:function_3:9 + 156641360669707 function-return: call_stack.py:function_3:10 + 156641360687853 function-entry: call_stack.py:function_4:13 + 156641360700719 function-return: call_stack.py:function_4:14 + 156641360719640 function-entry: call_stack.py:function_5:18 + 156641360732567 function-return: call_stack.py:function_5:21 + 156641360747370 function-return:call_stack.py:start:28 + + +Static SystemTap markers +------------------------ + +The low-level way to use the SystemTap integration is to use the static +markers directly. This requires you to explicitly state the binary file +containing them. + +For example, this SystemTap script can be used to show the call/return +hierarchy of a Python script: + +.. code-block:: none + + probe process("python").mark("function__entry") { + filename = user_string($arg1); + funcname = user_string($arg2); + lineno = $arg3; + + printf("%s => %s in %s:%d\\n", + thread_indent(1), funcname, filename, lineno); + } + + probe process("python").mark("function__return") { + filename = user_string($arg1); + funcname = user_string($arg2); + lineno = $arg3; + + printf("%s <= %s in %s:%d\\n", + thread_indent(-1), funcname, filename, lineno); + } + +It can be invoked like this:: + + $ stap \ + show-call-hierarchy.stp \ + -c "./python test.py" + +The output looks like this: + +.. code-block:: none + + 11408 python(8274): => __contains__ in Lib/_abcoll.py:362 + 11414 python(8274): => __getitem__ in Lib/os.py:425 + 11418 python(8274): => encode in Lib/os.py:490 + 11424 python(8274): <= encode in Lib/os.py:493 + 11428 python(8274): <= __getitem__ in Lib/os.py:426 + 11433 python(8274): <= __contains__ in Lib/_abcoll.py:366 + +where the columns are: + + - time in microseconds since start of script + + - name of executable + + - PID of process + +and the remainder indicates the call/return hierarchy as the script executes. + +For a `--enable-shared` build of CPython, the markers are contained within the +libpython shared library, and the probe's dotted path needs to reflect this. For +example, this line from the above example: + +.. code-block:: none + + probe process("python").mark("function__entry") { + +should instead read: + +.. code-block:: none + + probe process("python").library("libpython3.6dm.so.1.0").mark("function__entry") { + +(assuming a debug build of CPython 3.6) + + +Available static markers +------------------------ + +.. I'm reusing the "c:function" type for markers + +.. c:function:: function__entry(str filename, str funcname, int lineno) + + This marker indicates that execution of a Python function has begun. + It is only triggered for pure-Python (bytecode) functions. + + The filename, function name, and line number are provided back to the + tracing script as positional arguments, which must be accessed using + ``$arg1``, ``$arg2``, ``$arg3``: + + * ``$arg1`` : ``(const char *)`` filename, accessible using ``user_string($arg1)`` + + * ``$arg2`` : ``(const char *)`` function name, accessible using + ``user_string($arg2)`` + + * ``$arg3`` : ``int`` line number + +.. c:function:: function__return(str filename, str funcname, int lineno) + + This marker is the converse of :c:func:`function__entry`, and indicates that + execution of a Python function has ended (either via ``return``, or via an + exception). It is only triggered for pure-Python (bytecode) functions. + + The arguments are the same as for :c:func:`function__entry` + +.. c:function:: line(str filename, str funcname, int lineno) + + This marker indicates a Python line is about to be executed. It is + the equivalent of line-by-line tracing with a Python profiler. It is + not triggered within C functions. + + The arguments are the same as for :c:func:`function__entry`. + +.. c:function:: gc__start(int generation) + + Fires when the Python interpreter starts a garbage collection cycle. + ``arg0`` is the generation to scan, like :func:`gc.collect()`. + +.. c:function:: gc__done(long collected) + + Fires when the Python interpreter finishes a garbage collection + cycle. ``arg0`` is the number of collected objects. + +.. c:function:: import__find__load__start(str modulename) + + Fires before :mod:`importlib` attempts to find and load the module. + ``arg0`` is the module name. + + .. versionadded:: 3.7 + +.. c:function:: import__find__load__done(str modulename, int found) + + Fires after :mod:`importlib`'s find_and_load function is called. + ``arg0`` is the module name, ``arg1`` indicates if module was + successfully loaded. + + .. versionadded:: 3.7 + + +SystemTap Tapsets +----------------- + +The higher-level way to use the SystemTap integration is to use a "tapset": +SystemTap's equivalent of a library, which hides some of the lower-level +details of the static markers. + +Here is a tapset file, based on a non-shared build of CPython: + +.. code-block:: none + + /* + Provide a higher-level wrapping around the function__entry and + function__return markers: + \*/ + probe python.function.entry = process("python").mark("function__entry") + { + filename = user_string($arg1); + funcname = user_string($arg2); + lineno = $arg3; + frameptr = $arg4 + } + probe python.function.return = process("python").mark("function__return") + { + filename = user_string($arg1); + funcname = user_string($arg2); + lineno = $arg3; + frameptr = $arg4 + } + +If this file is installed in SystemTap's tapset directory (e.g. +``/usr/share/systemtap/tapset``), then these additional probepoints become +available: + +.. c:function:: python.function.entry(str filename, str funcname, int lineno, frameptr) + + This probe point indicates that execution of a Python function has begun. + It is only triggered for pure-Python (bytecode) functions. + +.. c:function:: python.function.return(str filename, str funcname, int lineno, frameptr) + + This probe point is the converse of :c:func:`python.function.return`, and + indicates that execution of a Python function has ended (either via + ``return``, or via an exception). It is only triggered for pure-Python + (bytecode) functions. + + +Examples +-------- +This SystemTap script uses the tapset above to more cleanly implement the +example given above of tracing the Python function-call hierarchy, without +needing to directly name the static markers: + +.. code-block:: none + + probe python.function.entry + { + printf("%s => %s in %s:%d\n", + thread_indent(1), funcname, filename, lineno); + } + + probe python.function.return + { + printf("%s <= %s in %s:%d\n", + thread_indent(-1), funcname, filename, lineno); + } + + +The following script uses the tapset above to provide a top-like view of all +running CPython code, showing the top 20 most frequently-entered bytecode +frames, each second, across the whole system: + +.. code-block:: none + + global fn_calls; + + probe python.function.entry + { + fn_calls[pid(), filename, funcname, lineno] += 1; + } + + probe timer.ms(1000) { + printf("\033[2J\033[1;1H") /* clear screen \*/ + printf("%6s %80s %6s %30s %6s\n", + "PID", "FILENAME", "LINE", "FUNCTION", "CALLS") + foreach ([pid, filename, funcname, lineno] in fn_calls- limit 20) { + printf("%6d %80s %6d %30s %6d\n", + pid, filename, lineno, funcname, + fn_calls[pid, filename, funcname, lineno]); + } + delete fn_calls; + } + diff --git a/python-3.7.4-docs-html/_sources/howto/ipaddress.rst.txt b/python-3.7.4-docs-html/_sources/howto/ipaddress.rst.txt new file mode 100644 index 0000000..452e367 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/howto/ipaddress.rst.txt @@ -0,0 +1,340 @@ +.. testsetup:: + + import ipaddress + +.. _ipaddress-howto: + +*************************************** +An introduction to the ipaddress module +*************************************** + +:author: Peter Moody +:author: Nick Coghlan + +.. topic:: Overview + + This document aims to provide a gentle introduction to the + :mod:`ipaddress` module. It is aimed primarily at users that aren't + already familiar with IP networking terminology, but may also be useful + to network engineers wanting an overview of how :mod:`ipaddress` + represents IP network addressing concepts. + + +Creating Address/Network/Interface objects +========================================== + +Since :mod:`ipaddress` is a module for inspecting and manipulating IP addresses, +the first thing you'll want to do is create some objects. You can use +:mod:`ipaddress` to create objects from strings and integers. + + +A Note on IP Versions +--------------------- + +For readers that aren't particularly familiar with IP addressing, it's +important to know that the Internet Protocol is currently in the process +of moving from version 4 of the protocol to version 6. This transition is +occurring largely because version 4 of the protocol doesn't provide enough +addresses to handle the needs of the whole world, especially given the +increasing number of devices with direct connections to the internet. + +Explaining the details of the differences between the two versions of the +protocol is beyond the scope of this introduction, but readers need to at +least be aware that these two versions exist, and it will sometimes be +necessary to force the use of one version or the other. + + +IP Host Addresses +----------------- + +Addresses, often referred to as "host addresses" are the most basic unit +when working with IP addressing. The simplest way to create addresses is +to use the :func:`ipaddress.ip_address` factory function, which automatically +determines whether to create an IPv4 or IPv6 address based on the passed in +value: + + >>> ipaddress.ip_address('192.0.2.1') + IPv4Address('192.0.2.1') + >>> ipaddress.ip_address('2001:DB8::1') + IPv6Address('2001:db8::1') + +Addresses can also be created directly from integers. Values that will +fit within 32 bits are assumed to be IPv4 addresses:: + + >>> ipaddress.ip_address(3221225985) + IPv4Address('192.0.2.1') + >>> ipaddress.ip_address(42540766411282592856903984951653826561) + IPv6Address('2001:db8::1') + +To force the use of IPv4 or IPv6 addresses, the relevant classes can be +invoked directly. This is particularly useful to force creation of IPv6 +addresses for small integers:: + + >>> ipaddress.ip_address(1) + IPv4Address('0.0.0.1') + >>> ipaddress.IPv4Address(1) + IPv4Address('0.0.0.1') + >>> ipaddress.IPv6Address(1) + IPv6Address('::1') + + +Defining Networks +----------------- + +Host addresses are usually grouped together into IP networks, so +:mod:`ipaddress` provides a way to create, inspect and manipulate network +definitions. IP network objects are constructed from strings that define the +range of host addresses that are part of that network. The simplest form +for that information is a "network address/network prefix" pair, where the +prefix defines the number of leading bits that are compared to determine +whether or not an address is part of the network and the network address +defines the expected value of those bits. + +As for addresses, a factory function is provided that determines the correct +IP version automatically:: + + >>> ipaddress.ip_network('192.0.2.0/24') + IPv4Network('192.0.2.0/24') + >>> ipaddress.ip_network('2001:db8::0/96') + IPv6Network('2001:db8::/96') + +Network objects cannot have any host bits set. The practical effect of this +is that ``192.0.2.1/24`` does not describe a network. Such definitions are +referred to as interface objects since the ip-on-a-network notation is +commonly used to describe network interfaces of a computer on a given network +and are described further in the next section. + +By default, attempting to create a network object with host bits set will +result in :exc:`ValueError` being raised. To request that the +additional bits instead be coerced to zero, the flag ``strict=False`` can +be passed to the constructor:: + + >>> ipaddress.ip_network('192.0.2.1/24') + Traceback (most recent call last): + ... + ValueError: 192.0.2.1/24 has host bits set + >>> ipaddress.ip_network('192.0.2.1/24', strict=False) + IPv4Network('192.0.2.0/24') + +While the string form offers significantly more flexibility, networks can +also be defined with integers, just like host addresses. In this case, the +network is considered to contain only the single address identified by the +integer, so the network prefix includes the entire network address:: + + >>> ipaddress.ip_network(3221225984) + IPv4Network('192.0.2.0/32') + >>> ipaddress.ip_network(42540766411282592856903984951653826560) + IPv6Network('2001:db8::/128') + +As with addresses, creation of a particular kind of network can be forced +by calling the class constructor directly instead of using the factory +function. + + +Host Interfaces +--------------- + +As mentioned just above, if you need to describe an address on a particular +network, neither the address nor the network classes are sufficient. +Notation like ``192.0.2.1/24`` is commonly used by network engineers and the +people who write tools for firewalls and routers as shorthand for "the host +``192.0.2.1`` on the network ``192.0.2.0/24``", Accordingly, :mod:`ipaddress` +provides a set of hybrid classes that associate an address with a particular +network. The interface for creation is identical to that for defining network +objects, except that the address portion isn't constrained to being a network +address. + + >>> ipaddress.ip_interface('192.0.2.1/24') + IPv4Interface('192.0.2.1/24') + >>> ipaddress.ip_interface('2001:db8::1/96') + IPv6Interface('2001:db8::1/96') + +Integer inputs are accepted (as with networks), and use of a particular IP +version can be forced by calling the relevant constructor directly. + + +Inspecting Address/Network/Interface Objects +============================================ + +You've gone to the trouble of creating an IPv(4|6)(Address|Network|Interface) +object, so you probably want to get information about it. :mod:`ipaddress` +tries to make doing this easy and intuitive. + +Extracting the IP version:: + + >>> addr4 = ipaddress.ip_address('192.0.2.1') + >>> addr6 = ipaddress.ip_address('2001:db8::1') + >>> addr6.version + 6 + >>> addr4.version + 4 + +Obtaining the network from an interface:: + + >>> host4 = ipaddress.ip_interface('192.0.2.1/24') + >>> host4.network + IPv4Network('192.0.2.0/24') + >>> host6 = ipaddress.ip_interface('2001:db8::1/96') + >>> host6.network + IPv6Network('2001:db8::/96') + +Finding out how many individual addresses are in a network:: + + >>> net4 = ipaddress.ip_network('192.0.2.0/24') + >>> net4.num_addresses + 256 + >>> net6 = ipaddress.ip_network('2001:db8::0/96') + >>> net6.num_addresses + 4294967296 + +Iterating through the "usable" addresses on a network:: + + >>> net4 = ipaddress.ip_network('192.0.2.0/24') + >>> for x in net4.hosts(): + ... print(x) # doctest: +ELLIPSIS + 192.0.2.1 + 192.0.2.2 + 192.0.2.3 + 192.0.2.4 + ... + 192.0.2.252 + 192.0.2.253 + 192.0.2.254 + + +Obtaining the netmask (i.e. set bits corresponding to the network prefix) or +the hostmask (any bits that are not part of the netmask): + + >>> net4 = ipaddress.ip_network('192.0.2.0/24') + >>> net4.netmask + IPv4Address('255.255.255.0') + >>> net4.hostmask + IPv4Address('0.0.0.255') + >>> net6 = ipaddress.ip_network('2001:db8::0/96') + >>> net6.netmask + IPv6Address('ffff:ffff:ffff:ffff:ffff:ffff::') + >>> net6.hostmask + IPv6Address('::ffff:ffff') + + +Exploding or compressing the address:: + + >>> addr6.exploded + '2001:0db8:0000:0000:0000:0000:0000:0001' + >>> addr6.compressed + '2001:db8::1' + >>> net6.exploded + '2001:0db8:0000:0000:0000:0000:0000:0000/96' + >>> net6.compressed + '2001:db8::/96' + +While IPv4 doesn't support explosion or compression, the associated objects +still provide the relevant properties so that version neutral code can +easily ensure the most concise or most verbose form is used for IPv6 +addresses while still correctly handling IPv4 addresses. + + +Networks as lists of Addresses +============================== + +It's sometimes useful to treat networks as lists. This means it is possible +to index them like this:: + + >>> net4[1] + IPv4Address('192.0.2.1') + >>> net4[-1] + IPv4Address('192.0.2.255') + >>> net6[1] + IPv6Address('2001:db8::1') + >>> net6[-1] + IPv6Address('2001:db8::ffff:ffff') + + +It also means that network objects lend themselves to using the list +membership test syntax like this:: + + if address in network: + # do something + +Containment testing is done efficiently based on the network prefix:: + + >>> addr4 = ipaddress.ip_address('192.0.2.1') + >>> addr4 in ipaddress.ip_network('192.0.2.0/24') + True + >>> addr4 in ipaddress.ip_network('192.0.3.0/24') + False + + +Comparisons +=========== + +:mod:`ipaddress` provides some simple, hopefully intuitive ways to compare +objects, where it makes sense:: + + >>> ipaddress.ip_address('192.0.2.1') < ipaddress.ip_address('192.0.2.2') + True + +A :exc:`TypeError` exception is raised if you try to compare objects of +different versions or different types. + + +Using IP Addresses with other modules +===================================== + +Other modules that use IP addresses (such as :mod:`socket`) usually won't +accept objects from this module directly. Instead, they must be coerced to +an integer or string that the other module will accept:: + + >>> addr4 = ipaddress.ip_address('192.0.2.1') + >>> str(addr4) + '192.0.2.1' + >>> int(addr4) + 3221225985 + + +Getting more detail when instance creation fails +================================================ + +When creating address/network/interface objects using the version-agnostic +factory functions, any errors will be reported as :exc:`ValueError` with +a generic error message that simply says the passed in value was not +recognized as an object of that type. The lack of a specific error is +because it's necessary to know whether the value is *supposed* to be IPv4 +or IPv6 in order to provide more detail on why it has been rejected. + +To support use cases where it is useful to have access to this additional +detail, the individual class constructors actually raise the +:exc:`ValueError` subclasses :exc:`ipaddress.AddressValueError` and +:exc:`ipaddress.NetmaskValueError` to indicate exactly which part of +the definition failed to parse correctly. + +The error messages are significantly more detailed when using the +class constructors directly. For example:: + + >>> ipaddress.ip_address("192.168.0.256") + Traceback (most recent call last): + ... + ValueError: '192.168.0.256' does not appear to be an IPv4 or IPv6 address + >>> ipaddress.IPv4Address("192.168.0.256") + Traceback (most recent call last): + ... + ipaddress.AddressValueError: Octet 256 (> 255) not permitted in '192.168.0.256' + + >>> ipaddress.ip_network("192.168.0.1/64") + Traceback (most recent call last): + ... + ValueError: '192.168.0.1/64' does not appear to be an IPv4 or IPv6 network + >>> ipaddress.IPv4Network("192.168.0.1/64") + Traceback (most recent call last): + ... + ipaddress.NetmaskValueError: '64' is not a valid netmask + +However, both of the module specific exceptions have :exc:`ValueError` as their +parent class, so if you're not concerned with the particular type of error, +you can still write code like the following:: + + try: + network = ipaddress.IPv4Network(address) + except ValueError: + print('address/netmask is invalid for IPv4:', address) + diff --git a/python-3.7.4-docs-html/_sources/howto/logging-cookbook.rst.txt b/python-3.7.4-docs-html/_sources/howto/logging-cookbook.rst.txt new file mode 100644 index 0000000..105ae5e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/howto/logging-cookbook.rst.txt @@ -0,0 +1,2551 @@ +.. _logging-cookbook: + +================ +Logging Cookbook +================ + +:Author: Vinay Sajip + +This page contains a number of recipes related to logging, which have been found +useful in the past. + +.. currentmodule:: logging + +Using logging in multiple modules +--------------------------------- + +Multiple calls to ``logging.getLogger('someLogger')`` return a reference to the +same logger object. This is true not only within the same module, but also +across modules as long as it is in the same Python interpreter process. It is +true for references to the same object; additionally, application code can +define and configure a parent logger in one module and create (but not +configure) a child logger in a separate module, and all logger calls to the +child will pass up to the parent. Here is a main module:: + + import logging + import auxiliary_module + + # create logger with 'spam_application' + logger = logging.getLogger('spam_application') + logger.setLevel(logging.DEBUG) + # create file handler which logs even debug messages + fh = logging.FileHandler('spam.log') + fh.setLevel(logging.DEBUG) + # create console handler with a higher log level + ch = logging.StreamHandler() + ch.setLevel(logging.ERROR) + # create formatter and add it to the handlers + formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') + fh.setFormatter(formatter) + ch.setFormatter(formatter) + # add the handlers to the logger + logger.addHandler(fh) + logger.addHandler(ch) + + logger.info('creating an instance of auxiliary_module.Auxiliary') + a = auxiliary_module.Auxiliary() + logger.info('created an instance of auxiliary_module.Auxiliary') + logger.info('calling auxiliary_module.Auxiliary.do_something') + a.do_something() + logger.info('finished auxiliary_module.Auxiliary.do_something') + logger.info('calling auxiliary_module.some_function()') + auxiliary_module.some_function() + logger.info('done with auxiliary_module.some_function()') + +Here is the auxiliary module:: + + import logging + + # create logger + module_logger = logging.getLogger('spam_application.auxiliary') + + class Auxiliary: + 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 + self.logger.info('done doing something') + + def some_function(): + module_logger.info('received a call to "some_function"') + +The output looks like this: + +.. code-block:: none + + 2005-03-23 23:47:11,663 - spam_application - INFO - + creating an instance of auxiliary_module.Auxiliary + 2005-03-23 23:47:11,665 - spam_application.auxiliary.Auxiliary - INFO - + creating an instance of Auxiliary + 2005-03-23 23:47:11,665 - spam_application - INFO - + created an instance of auxiliary_module.Auxiliary + 2005-03-23 23:47:11,668 - spam_application - INFO - + calling auxiliary_module.Auxiliary.do_something + 2005-03-23 23:47:11,668 - spam_application.auxiliary.Auxiliary - INFO - + doing something + 2005-03-23 23:47:11,669 - spam_application.auxiliary.Auxiliary - INFO - + done doing something + 2005-03-23 23:47:11,670 - spam_application - INFO - + finished auxiliary_module.Auxiliary.do_something + 2005-03-23 23:47:11,671 - spam_application - INFO - + calling auxiliary_module.some_function() + 2005-03-23 23:47:11,672 - spam_application.auxiliary - INFO - + received a call to 'some_function' + 2005-03-23 23:47:11,673 - spam_application - INFO - + done with auxiliary_module.some_function() + +Logging from multiple threads +----------------------------- + +Logging from multiple threads requires no special effort. The following example +shows logging from the main (initial) thread and another thread:: + + import logging + import threading + import time + + def worker(arg): + while not arg['stop']: + logging.debug('Hi from myfunc') + time.sleep(0.5) + + def main(): + logging.basicConfig(level=logging.DEBUG, format='%(relativeCreated)6d %(threadName)s %(message)s') + info = {'stop': False} + thread = threading.Thread(target=worker, args=(info,)) + thread.start() + while True: + try: + logging.debug('Hello from main') + time.sleep(0.75) + except KeyboardInterrupt: + info['stop'] = True + break + thread.join() + + if __name__ == '__main__': + main() + +When run, the script should print something like the following: + +.. code-block:: none + + 0 Thread-1 Hi from myfunc + 3 MainThread Hello from main + 505 Thread-1 Hi from myfunc + 755 MainThread Hello from main + 1007 Thread-1 Hi from myfunc + 1507 MainThread Hello from main + 1508 Thread-1 Hi from myfunc + 2010 Thread-1 Hi from myfunc + 2258 MainThread Hello from main + 2512 Thread-1 Hi from myfunc + 3009 MainThread Hello from main + 3013 Thread-1 Hi from myfunc + 3515 Thread-1 Hi from myfunc + 3761 MainThread Hello from main + 4017 Thread-1 Hi from myfunc + 4513 MainThread Hello from main + 4518 Thread-1 Hi from myfunc + +This shows the logging output interspersed as one might expect. This approach +works for more threads than shown here, of course. + +Multiple handlers and formatters +-------------------------------- + +Loggers are plain Python objects. The :meth:`~Logger.addHandler` method has no +minimum or maximum quota for the number of handlers you may add. Sometimes it +will be beneficial for an application to log all messages of all severities to a +text file while simultaneously logging errors or above to the console. To set +this up, simply configure the appropriate handlers. The logging calls in the +application code will remain unchanged. Here is a slight modification to the +previous simple module-based configuration example:: + + import logging + + logger = logging.getLogger('simple_example') + logger.setLevel(logging.DEBUG) + # create file handler which logs even debug messages + fh = logging.FileHandler('spam.log') + fh.setLevel(logging.DEBUG) + # create console handler with a higher log level + ch = logging.StreamHandler() + ch.setLevel(logging.ERROR) + # create formatter and add it to the handlers + formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') + ch.setFormatter(formatter) + fh.setFormatter(formatter) + # add the handlers to logger + logger.addHandler(ch) + logger.addHandler(fh) + + # 'application' code + logger.debug('debug message') + logger.info('info message') + logger.warning('warn message') + logger.error('error message') + logger.critical('critical message') + +Notice that the 'application' code does not care about multiple handlers. All +that changed was the addition and configuration of a new handler named *fh*. + +The ability to create new handlers with higher- or lower-severity filters can be +very helpful when writing and testing an application. Instead of using many +``print`` statements for debugging, use ``logger.debug``: Unlike the print +statements, which you will have to delete or comment out later, the logger.debug +statements can remain intact in the source code and remain dormant until you +need them again. At that time, the only change that needs to happen is to +modify the severity level of the logger and/or handler to debug. + +.. _multiple-destinations: + +Logging to multiple destinations +-------------------------------- + +Let's say you want to log to console and file with different message formats and +in differing circumstances. Say you want to log messages with levels of DEBUG +and higher to file, and those messages at level INFO and higher to the console. +Let's also assume that the file should contain timestamps, but the console +messages should not. Here's how you can achieve this:: + + import logging + + # set up logging to file - see previous section for more details + logging.basicConfig(level=logging.DEBUG, + format='%(asctime)s %(name)-12s %(levelname)-8s %(message)s', + datefmt='%m-%d %H:%M', + filename='/temp/myapp.log', + filemode='w') + # define a Handler which writes INFO messages or higher to the sys.stderr + console = logging.StreamHandler() + console.setLevel(logging.INFO) + # set a format which is simpler for console use + formatter = logging.Formatter('%(name)-12s: %(levelname)-8s %(message)s') + # tell the handler to use this format + console.setFormatter(formatter) + # add the handler to the root logger + logging.getLogger('').addHandler(console) + + # Now, we can log to the root logger, or any other logger. First the root... + logging.info('Jackdaws love my big sphinx of quartz.') + + # Now, define a couple of other loggers which might represent areas in your + # application: + + logger1 = logging.getLogger('myapp.area1') + logger2 = logging.getLogger('myapp.area2') + + logger1.debug('Quick zephyrs blow, vexing daft Jim.') + logger1.info('How quickly daft jumping zebras vex.') + logger2.warning('Jail zesty vixen who grabbed pay from quack.') + logger2.error('The five boxing wizards jump quickly.') + +When you run this, on the console you will see + +.. code-block:: none + + root : INFO Jackdaws love my big sphinx of quartz. + myapp.area1 : INFO How quickly daft jumping zebras vex. + myapp.area2 : WARNING Jail zesty vixen who grabbed pay from quack. + myapp.area2 : ERROR The five boxing wizards jump quickly. + +and in the file you will see something like + +.. code-block:: none + + 10-22 22:19 root INFO Jackdaws love my big sphinx of quartz. + 10-22 22:19 myapp.area1 DEBUG Quick zephyrs blow, vexing daft Jim. + 10-22 22:19 myapp.area1 INFO How quickly daft jumping zebras vex. + 10-22 22:19 myapp.area2 WARNING Jail zesty vixen who grabbed pay from quack. + 10-22 22:19 myapp.area2 ERROR The five boxing wizards jump quickly. + +As you can see, the DEBUG message only shows up in the file. The other messages +are sent to both destinations. + +This example uses console and file handlers, but you can use any number and +combination of handlers you choose. + + +Configuration server example +---------------------------- + +Here is an example of a module using the logging configuration server:: + + import logging + import logging.config + import time + import os + + # read initial config file + logging.config.fileConfig('logging.conf') + + # create and start listener on port 9999 + t = logging.config.listen(9999) + t.start() + + logger = logging.getLogger('simpleExample') + + try: + # loop through logging calls to see the difference + # new configurations make, until Ctrl+C is pressed + while True: + logger.debug('debug message') + logger.info('info message') + logger.warning('warn message') + logger.error('error message') + logger.critical('critical message') + time.sleep(5) + except KeyboardInterrupt: + # cleanup + logging.config.stopListening() + t.join() + +And here is a script that takes a filename and sends that file to the server, +properly preceded with the binary-encoded length, as the new logging +configuration:: + + #!/usr/bin/env python + import socket, sys, struct + + with open(sys.argv[1], 'rb') as f: + data_to_send = f.read() + + HOST = 'localhost' + PORT = 9999 + s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + print('connecting...') + s.connect((HOST, PORT)) + print('sending config...') + s.send(struct.pack('>L', len(data_to_send))) + s.send(data_to_send) + s.close() + print('complete') + + +Dealing with handlers that block +-------------------------------- + +.. currentmodule:: logging.handlers + +Sometimes you have to get your logging handlers to do their work without +blocking the thread you're logging from. This is common in Web applications, +though of course it also occurs in other scenarios. + +A common culprit which demonstrates sluggish behaviour is the +:class:`SMTPHandler`: sending emails can take a long time, for a +number of reasons outside the developer's control (for example, a poorly +performing mail or network infrastructure). But almost any network-based +handler can block: Even a :class:`SocketHandler` operation may do a +DNS query under the hood which is too slow (and this query can be deep in the +socket library code, below the Python layer, and outside your control). + +One solution is to use a two-part approach. For the first part, attach only a +:class:`QueueHandler` to those loggers which are accessed from +performance-critical threads. They simply write to their queue, which can be +sized to a large enough capacity or initialized with no upper bound to their +size. The write to the queue will typically be accepted quickly, though you +will probably need to catch the :exc:`queue.Full` exception as a precaution +in your code. If you are a library developer who has performance-critical +threads in their code, be sure to document this (together with a suggestion to +attach only ``QueueHandlers`` to your loggers) for the benefit of other +developers who will use your code. + +The second part of the solution is :class:`QueueListener`, which has been +designed as the counterpart to :class:`QueueHandler`. A +:class:`QueueListener` is very simple: it's passed a queue and some handlers, +and it fires up an internal thread which listens to its queue for LogRecords +sent from ``QueueHandlers`` (or any other source of ``LogRecords``, for that +matter). The ``LogRecords`` are removed from the queue and passed to the +handlers for processing. + +The advantage of having a separate :class:`QueueListener` class is that you +can use the same instance to service multiple ``QueueHandlers``. This is more +resource-friendly than, say, having threaded versions of the existing handler +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 + queue_handler = QueueHandler(que) + handler = logging.StreamHandler() + listener = QueueListener(que, handler) + root = logging.getLogger() + root.addHandler(queue_handler) + formatter = logging.Formatter('%(threadName)s: %(message)s') + handler.setFormatter(formatter) + listener.start() + # The log output will display the thread which generated + # the event (the main thread) rather than the internal + # thread which monitors the internal queue. This is what + # you want to happen. + root.warning('Look out!') + listener.stop() + +which, when run, will produce: + +.. code-block:: none + + MainThread: Look out! + +.. versionchanged:: 3.5 + Prior to Python 3.5, the :class:`QueueListener` always passed every message + received from the queue to every handler it was initialized with. (This was + because it was assumed that level filtering was all done on the other side, + where the queue is filled.) From 3.5 onwards, this behaviour can be changed + by passing a keyword argument ``respect_handler_level=True`` to the + listener's constructor. When this is done, the listener compares the level + of each message with the handler's level, and only passes a message to a + handler if it's appropriate to do so. + +.. _network-logging: + +Sending and receiving logging events across a network +----------------------------------------------------- + +Let's say you want to send logging events across a network, and handle them at +the receiving end. A simple way of doing this is attaching a +:class:`SocketHandler` instance to the root logger at the sending end:: + + import logging, logging.handlers + + rootLogger = logging.getLogger('') + rootLogger.setLevel(logging.DEBUG) + socketHandler = logging.handlers.SocketHandler('localhost', + logging.handlers.DEFAULT_TCP_LOGGING_PORT) + # don't bother with a formatter, since a socket handler sends the event as + # an unformatted pickle + rootLogger.addHandler(socketHandler) + + # Now, we can log to the root logger, or any other logger. First the root... + logging.info('Jackdaws love my big sphinx of quartz.') + + # Now, define a couple of other loggers which might represent areas in your + # application: + + logger1 = logging.getLogger('myapp.area1') + logger2 = logging.getLogger('myapp.area2') + + logger1.debug('Quick zephyrs blow, vexing daft Jim.') + logger1.info('How quickly daft jumping zebras vex.') + logger2.warning('Jail zesty vixen who grabbed pay from quack.') + logger2.error('The five boxing wizards jump quickly.') + +At the receiving end, you can set up a receiver using the :mod:`socketserver` +module. Here is a basic working example:: + + import pickle + import logging + import logging.handlers + import socketserver + import struct + + + class LogRecordStreamHandler(socketserver.StreamRequestHandler): + """Handler for a streaming logging request. + + This basically logs the record using whatever logging policy is + configured locally. + """ + + def handle(self): + """ + Handle multiple requests - each expected to be a 4-byte length, + followed by the LogRecord in pickle format. Logs the record + according to whatever policy is configured locally. + """ + while True: + chunk = self.connection.recv(4) + if len(chunk) < 4: + break + slen = struct.unpack('>L', chunk)[0] + chunk = self.connection.recv(slen) + while len(chunk) < slen: + chunk = chunk + self.connection.recv(slen - len(chunk)) + obj = self.unPickle(chunk) + record = logging.makeLogRecord(obj) + self.handleLogRecord(record) + + def unPickle(self, data): + return pickle.loads(data) + + def handleLogRecord(self, record): + # if a name is specified, we use the named logger rather than the one + # implied by the record. + if self.server.logname is not None: + name = self.server.logname + else: + name = record.name + logger = logging.getLogger(name) + # N.B. EVERY record gets logged. This is because Logger.handle + # is normally called AFTER logger-level filtering. If you want + # to do filtering, do it at the client end to save wasting + # cycles and network bandwidth! + logger.handle(record) + + class LogRecordSocketReceiver(socketserver.ThreadingTCPServer): + """ + Simple TCP socket-based logging receiver suitable for testing. + """ + + allow_reuse_address = True + + def __init__(self, host='localhost', + port=logging.handlers.DEFAULT_TCP_LOGGING_PORT, + handler=LogRecordStreamHandler): + socketserver.ThreadingTCPServer.__init__(self, (host, port), handler) + self.abort = 0 + self.timeout = 1 + self.logname = None + + def serve_until_stopped(self): + import select + abort = 0 + while not abort: + rd, wr, ex = select.select([self.socket.fileno()], + [], [], + self.timeout) + if rd: + self.handle_request() + abort = self.abort + + def main(): + logging.basicConfig( + format='%(relativeCreated)5d %(name)-15s %(levelname)-8s %(message)s') + tcpserver = LogRecordSocketReceiver() + print('About to start TCP server...') + tcpserver.serve_until_stopped() + + if __name__ == '__main__': + main() + +First run the server, and then the client. On the client side, nothing is +printed on the console; on the server side, you should see something like: + +.. code-block:: none + + About to start TCP server... + 59 root INFO Jackdaws love my big sphinx of quartz. + 59 myapp.area1 DEBUG Quick zephyrs blow, vexing daft Jim. + 69 myapp.area1 INFO How quickly daft jumping zebras vex. + 69 myapp.area2 WARNING Jail zesty vixen who grabbed pay from quack. + 69 myapp.area2 ERROR The five boxing wizards jump quickly. + +Note that there are some security issues with pickle in some scenarios. If +these affect you, you can use an alternative serialization scheme by overriding +the :meth:`~handlers.SocketHandler.makePickle` method and implementing your +alternative there, as well as adapting the above script to use your alternative +serialization. + + +.. _context-info: + +Adding contextual information to your logging output +---------------------------------------------------- + +Sometimes you want logging output to contain contextual information in +addition to the parameters passed to the logging call. For example, in a +networked application, it may be desirable to log client-specific information +in the log (e.g. remote client's username, or IP address). Although you could +use the *extra* parameter to achieve this, it's not always convenient to pass +the information in this way. While it might be tempting to create +:class:`Logger` instances on a per-connection basis, this is not a good idea +because these instances are not garbage collected. While this is not a problem +in practice, when the number of :class:`Logger` instances is dependent on the +level of granularity you want to use in logging an application, it could +be hard to manage if the number of :class:`Logger` instances becomes +effectively unbounded. + + +Using LoggerAdapters to impart contextual information +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +An easy way in which you can pass contextual information to be output along +with logging event information is to use the :class:`LoggerAdapter` class. +This class is designed to look like a :class:`Logger`, so that you can call +:meth:`debug`, :meth:`info`, :meth:`warning`, :meth:`error`, +:meth:`exception`, :meth:`critical` and :meth:`log`. These methods have the +same signatures as their counterparts in :class:`Logger`, so you can use the +two types of instances interchangeably. + +When you create an instance of :class:`LoggerAdapter`, you pass it a +:class:`Logger` instance and a dict-like object which contains your contextual +information. When you call one of the logging methods on an instance of +:class:`LoggerAdapter`, it delegates the call to the underlying instance of +:class:`Logger` passed to its constructor, and arranges to pass the contextual +information in the delegated call. Here's a snippet from the code of +:class:`LoggerAdapter`:: + + def debug(self, msg, *args, **kwargs): + """ + Delegate a debug call to the underlying logger, after adding + contextual information from this adapter instance. + """ + msg, kwargs = self.process(msg, kwargs) + self.logger.debug(msg, *args, **kwargs) + +The :meth:`~LoggerAdapter.process` method of :class:`LoggerAdapter` is where the +contextual information is added to the logging output. It's passed the message +and keyword arguments of the logging call, and it passes back (potentially) +modified versions of these to use in the call to the underlying logger. The +default implementation of this method leaves the message alone, but inserts +an 'extra' key in the keyword argument whose value is the dict-like object +passed to the constructor. Of course, if you had passed an 'extra' keyword +argument in the call to the adapter, it will be silently overwritten. + +The advantage of using 'extra' is that the values in the dict-like object are +merged into the :class:`LogRecord` instance's __dict__, allowing you to use +customized strings with your :class:`Formatter` instances which know about +the keys of the dict-like object. If you need a different method, e.g. if you +want to prepend or append the contextual information to the message string, +you just need to subclass :class:`LoggerAdapter` and override +:meth:`~LoggerAdapter.process` to do what you need. Here is a simple example:: + + class CustomAdapter(logging.LoggerAdapter): + """ + This example adapter expects the passed in dict-like object to have a + 'connid' key, whose value in brackets is prepended to the log message. + """ + def process(self, msg, kwargs): + return '[%s] %s' % (self.extra['connid'], msg), kwargs + +which you can use like this:: + + logger = logging.getLogger(__name__) + adapter = CustomAdapter(logger, {'connid': some_conn_id}) + +Then any events that you log to the adapter will have the value of +``some_conn_id`` prepended to the log messages. + +Using objects other than dicts to pass contextual information +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You don't need to pass an actual dict to a :class:`LoggerAdapter` - you could +pass an instance of a class which implements ``__getitem__`` and ``__iter__`` so +that it looks like a dict to logging. This would be useful if you want to +generate values dynamically (whereas the values in a dict would be constant). + + +.. _filters-contextual: + +Using Filters to impart contextual information +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +You can also add contextual information to log output using a user-defined +:class:`Filter`. ``Filter`` instances are allowed to modify the ``LogRecords`` +passed to them, including adding additional attributes which can then be output +using a suitable format string, or if needed a custom :class:`Formatter`. + +For example in a web application, the request being processed (or at least, +the interesting parts of it) can be stored in a threadlocal +(:class:`threading.local`) variable, and then accessed from a ``Filter`` to +add, say, information from the request - say, the remote IP address and remote +user's username - to the ``LogRecord``, using the attribute names 'ip' and +'user' as in the ``LoggerAdapter`` example above. In that case, the same format +string can be used to get similar output to that shown above. Here's an example +script:: + + import logging + from random import choice + + class ContextFilter(logging.Filter): + """ + This is a filter which injects contextual information into the log. + + Rather than use actual contextual information, we just use random + data in this demo. + """ + + USERS = ['jim', 'fred', 'sheila'] + IPS = ['123.231.231.123', '127.0.0.1', '192.168.0.1'] + + def filter(self, record): + + record.ip = choice(ContextFilter.IPS) + record.user = choice(ContextFilter.USERS) + 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') + +which, when run, produces something like: + +.. code-block:: none + + 2010-09-06 22:38:15,292 a.b.c DEBUG IP: 123.231.231.123 User: fred A debug message + 2010-09-06 22:38:15,300 a.b.c INFO IP: 192.168.0.1 User: sheila An info message with some parameters + 2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 127.0.0.1 User: sheila A message at CRITICAL level with 2 parameters + 2010-09-06 22:38:15,300 d.e.f ERROR IP: 127.0.0.1 User: jim A message at ERROR level with 2 parameters + 2010-09-06 22:38:15,300 d.e.f DEBUG IP: 127.0.0.1 User: sheila A message at DEBUG level with 2 parameters + 2010-09-06 22:38:15,300 d.e.f ERROR IP: 123.231.231.123 User: fred A message at ERROR level with 2 parameters + 2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 192.168.0.1 User: jim A message at CRITICAL level with 2 parameters + 2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 127.0.0.1 User: sheila A message at CRITICAL level with 2 parameters + 2010-09-06 22:38:15,300 d.e.f DEBUG IP: 192.168.0.1 User: jim A message at DEBUG level with 2 parameters + 2010-09-06 22:38:15,301 d.e.f ERROR IP: 127.0.0.1 User: sheila A message at ERROR level with 2 parameters + 2010-09-06 22:38:15,301 d.e.f DEBUG IP: 123.231.231.123 User: fred A message at DEBUG level with 2 parameters + 2010-09-06 22:38:15,301 d.e.f INFO IP: 123.231.231.123 User: fred A message at INFO level with 2 parameters + + +.. _multiple-processes: + +Logging to a single file from multiple processes +------------------------------------------------ + +Although logging is thread-safe, and logging to a single file from multiple +threads in a single process *is* supported, logging to a single file from +*multiple processes* is *not* supported, because there is no standard way to +serialize access to a single file across multiple processes in Python. If you +need to log to a single file from multiple processes, one way of doing this is +to have all the processes log to a :class:`~handlers.SocketHandler`, and have a +separate process which implements a socket server which reads from the socket +and logs to file. (If you prefer, you can dedicate one thread in one of the +existing processes to perform this function.) +:ref:`This section ` documents this approach in more detail and +includes a working socket receiver which can be used as a starting point for you +to adapt in your own applications. + +If you are using a recent version of Python which includes the +:mod:`multiprocessing` module, you could write your own handler which uses the +:class:`~multiprocessing.Lock` class from this module to serialize access to the +file from your processes. The existing :class:`FileHandler` and subclasses do +not make use of :mod:`multiprocessing` at present, though they may do so in the +future. Note that at present, the :mod:`multiprocessing` module does not provide +working lock functionality on all platforms (see +https://bugs.python.org/issue3770). + +.. currentmodule:: logging.handlers + +Alternatively, you can use a ``Queue`` and a :class:`QueueHandler` to send +all logging events to one of the processes in your multi-process application. +The following example script demonstrates how you can do this; in the example +a separate listener process listens for events sent by other processes and logs +them according to its own logging configuration. Although the example only +demonstrates one way of doing it (for example, you may want to use a listener +thread rather than a separate listener process -- the implementation would be +analogous) it does allow for completely different logging configurations for +the listener and the other processes in your application, and can be used as +the basis for code meeting your own specific requirements:: + + # You'll need these imports in your own code + import logging + import logging.handlers + import multiprocessing + + # Next two import lines for this demo only + from random import choice, random + import time + + # + # Because you'll want to define the logging configurations for listener and workers, the + # listener and worker process functions take a configurer parameter which is a callable + # for configuring logging for that process. These functions are also passed the queue, + # which they use for communication. + # + # In practice, you can configure the listener however you want, but note that in this + # simple example, the listener does not apply level or filter logic to received records. + # In practice, you would probably want to do this logic in the worker processes, to avoid + # sending events which would be filtered out between processes. + # + # The size of the rotated files is made small so you can see the results easily. + def listener_configurer(): + root = logging.getLogger() + h = logging.handlers.RotatingFileHandler('mptest.log', 'a', 300, 10) + f = logging.Formatter('%(asctime)s %(processName)-10s %(name)s %(levelname)-8s %(message)s') + h.setFormatter(f) + root.addHandler(h) + + # This is the listener process top-level loop: wait for logging events + # (LogRecords)on the queue and handle them, quit when you get a None for a + # LogRecord. + def listener_process(queue, configurer): + configurer() + while True: + try: + record = queue.get() + 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! + except Exception: + import sys, traceback + print('Whoops! Problem:', file=sys.stderr) + traceback.print_exc(file=sys.stderr) + + # Arrays used for random selections in this demo + + LEVELS = [logging.DEBUG, logging.INFO, logging.WARNING, + logging.ERROR, logging.CRITICAL] + + LOGGERS = ['a.b.c', 'd.e.f'] + + MESSAGES = [ + 'Random message #1', + 'Random message #2', + 'Random message #3', + ] + + # The worker configuration is done at the start of the worker process run. + # 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 + root = logging.getLogger() + root.addHandler(h) + # 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. + # The print messages are just so you know it's doing something! + def worker_process(queue, configurer): + configurer(queue) + name = multiprocessing.current_process().name + print('Worker started: %s' % name) + for i in range(10): + time.sleep(random()) + logger = logging.getLogger(choice(LOGGERS)) + level = choice(LEVELS) + message = choice(MESSAGES) + logger.log(level, message) + print('Worker finished: %s' % name) + + # Here's where the demo gets orchestrated. Create the queue, create and start + # the listener, create ten workers and start them, wait for them to finish, + # then send a None to the queue to tell the listener to finish. + def main(): + queue = multiprocessing.Queue(-1) + listener = multiprocessing.Process(target=listener_process, + args=(queue, listener_configurer)) + listener.start() + workers = [] + for i in range(10): + worker = multiprocessing.Process(target=worker_process, + args=(queue, worker_configurer)) + workers.append(worker) + worker.start() + for w in workers: + w.join() + queue.put_nowait(None) + listener.join() + + if __name__ == '__main__': + main() + +A variant of the above script keeps the logging in the main process, in a +separate thread:: + + import logging + import logging.config + import logging.handlers + from multiprocessing import Process, Queue + import random + import threading + import time + + def logger_thread(q): + while True: + record = q.get() + if record is None: + break + logger = logging.getLogger(record.name) + logger.handle(record) + + + def worker_process(q): + qh = logging.handlers.QueueHandler(q) + root = logging.getLogger() + root.setLevel(logging.DEBUG) + root.addHandler(qh) + levels = [logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR, + logging.CRITICAL] + loggers = ['foo', 'foo.bar', 'foo.bar.baz', + 'spam', 'spam.ham', 'spam.ham.eggs'] + for i in range(100): + lvl = random.choice(levels) + logger = logging.getLogger(random.choice(loggers)) + logger.log(lvl, 'Message no. %d', i) + + if __name__ == '__main__': + q = Queue() + d = { + 'version': 1, + 'formatters': { + 'detailed': { + 'class': 'logging.Formatter', + 'format': '%(asctime)s %(name)-15s %(levelname)-8s %(processName)-10s %(message)s' + } + }, + 'handlers': { + 'console': { + 'class': 'logging.StreamHandler', + 'level': 'INFO', + }, + 'file': { + 'class': 'logging.FileHandler', + 'filename': 'mplog.log', + 'mode': 'w', + 'formatter': 'detailed', + }, + 'foofile': { + 'class': 'logging.FileHandler', + 'filename': 'mplog-foo.log', + 'mode': 'w', + 'formatter': 'detailed', + }, + 'errors': { + 'class': 'logging.FileHandler', + 'filename': 'mplog-errors.log', + 'mode': 'w', + 'level': 'ERROR', + 'formatter': 'detailed', + }, + }, + 'loggers': { + 'foo': { + 'handlers': ['foofile'] + } + }, + 'root': { + 'level': 'DEBUG', + 'handlers': ['console', 'file', 'errors'] + }, + } + workers = [] + for i in range(5): + wp = Process(target=worker_process, name='worker %d' % (i + 1), args=(q,)) + workers.append(wp) + wp.start() + logging.config.dictConfig(d) + lp = threading.Thread(target=logger_thread, args=(q,)) + lp.start() + # At this point, the main process could do some useful work of its own + # Once it's done that, it can wait for the workers to terminate... + for wp in workers: + wp.join() + # And now tell the logging thread to finish up, too + q.put(None) + lp.join() + +This variant shows how you can e.g. apply configuration for particular loggers +- e.g. the ``foo`` logger has a special handler which stores all events in the +``foo`` subsystem in a file ``mplog-foo.log``. This will be used by the logging +machinery in the main process (even though the logging events are generated in +the worker processes) to direct the messages to the appropriate destinations. + +Using file rotation +------------------- + +.. sectionauthor:: Doug Hellmann, Vinay Sajip (changes) +.. (see ) + +Sometimes you want to let a log file grow to a certain size, then open a new +file and log to that. You may want to keep a certain number of these files, and +when that many files have been created, rotate the files so that the number of +files and the size of the files both remain bounded. For this usage pattern, the +logging package provides a :class:`~handlers.RotatingFileHandler`:: + + import glob + import logging + import logging.handlers + + LOG_FILENAME = 'logging_rotatingfile_example.out' + + # Set up a specific logger with our desired output level + my_logger = logging.getLogger('MyLogger') + my_logger.setLevel(logging.DEBUG) + + # Add the log message handler to the logger + handler = logging.handlers.RotatingFileHandler( + LOG_FILENAME, maxBytes=20, backupCount=5) + + my_logger.addHandler(handler) + + # Log some messages + for i in range(20): + my_logger.debug('i = %d' % i) + + # See what files are created + logfiles = glob.glob('%s*' % LOG_FILENAME) + + for filename in logfiles: + print(filename) + +The result should be 6 separate files, each with part of the log history for the +application: + +.. code-block:: none + + logging_rotatingfile_example.out + logging_rotatingfile_example.out.1 + logging_rotatingfile_example.out.2 + logging_rotatingfile_example.out.3 + logging_rotatingfile_example.out.4 + logging_rotatingfile_example.out.5 + +The most current file is always :file:`logging_rotatingfile_example.out`, +and each time it reaches the size limit it is renamed with the suffix +``.1``. Each of the existing backup files is renamed to increment the suffix +(``.1`` becomes ``.2``, etc.) and the ``.6`` file is erased. + +Obviously this example sets the log length much too small as an extreme +example. You would want to set *maxBytes* to an appropriate value. + +.. _format-styles: + +Use of alternative formatting styles +------------------------------------ + +When logging was added to the Python standard library, the only way of +formatting messages with variable content was to use the %-formatting +method. Since then, Python has gained two new formatting approaches: +:class:`string.Template` (added in Python 2.4) and :meth:`str.format` +(added in Python 2.6). + +Logging (as of 3.2) provides improved support for these two additional +formatting styles. The :class:`Formatter` class been enhanced to take an +additional, optional keyword parameter named ``style``. This defaults to +``'%'``, but other possible values are ``'{'`` and ``'$'``, which correspond +to the other two formatting styles. Backwards compatibility is maintained by +default (as you would expect), but by explicitly specifying a style parameter, +you get the ability to specify format strings which work with +:meth:`str.format` or :class:`string.Template`. Here's an example console +session to show the possibilities: + +.. code-block:: pycon + + >>> import logging + >>> root = logging.getLogger() + >>> root.setLevel(logging.DEBUG) + >>> handler = logging.StreamHandler() + >>> bf = logging.Formatter('{asctime} {name} {levelname:8s} {message}', + ... style='{') + >>> handler.setFormatter(bf) + >>> root.addHandler(handler) + >>> logger = logging.getLogger('foo.bar') + >>> logger.debug('This is a DEBUG message') + 2010-10-28 15:11:55,341 foo.bar DEBUG This is a DEBUG message + >>> logger.critical('This is a CRITICAL message') + 2010-10-28 15:12:11,526 foo.bar CRITICAL This is a CRITICAL message + >>> df = logging.Formatter('$asctime $name ${levelname} $message', + ... style='$') + >>> handler.setFormatter(df) + >>> logger.debug('This is a DEBUG message') + 2010-10-28 15:13:06,924 foo.bar DEBUG This is a DEBUG message + >>> logger.critical('This is a CRITICAL message') + 2010-10-28 15:13:11,494 foo.bar CRITICAL This is a CRITICAL message + >>> + +Note that the formatting of logging messages for final output to logs is +completely independent of how an individual logging message is constructed. +That can still use %-formatting, as shown here:: + + >>> logger.error('This is an%s %s %s', 'other,', 'ERROR,', 'message') + 2010-10-28 15:19:29,833 foo.bar ERROR This is another, ERROR, message + >>> + +Logging calls (``logger.debug()``, ``logger.info()`` etc.) only take +positional parameters for the actual logging message itself, with keyword +parameters used only for determining options for how to handle the actual +logging call (e.g. the ``exc_info`` keyword parameter to indicate that +traceback information should be logged, or the ``extra`` keyword parameter +to indicate additional contextual information to be added to the log). So +you cannot directly make logging calls using :meth:`str.format` or +:class:`string.Template` syntax, because internally the logging package +uses %-formatting to merge the format string and the variable arguments. +There would be no changing this while preserving backward compatibility, since +all logging calls which are out there in existing code will be using %-format +strings. + +There is, however, a way that you can use {}- and $- formatting to construct +your individual log messages. Recall that for a message you can use an +arbitrary object as a message format string, and that the logging package will +call ``str()`` on that object to get the actual format string. Consider the +following two classes:: + + class BraceMessage: + def __init__(self, fmt, *args, **kwargs): + self.fmt = fmt + self.args = args + self.kwargs = kwargs + + def __str__(self): + return self.fmt.format(*self.args, **self.kwargs) + + class DollarMessage: + def __init__(self, fmt, **kwargs): + self.fmt = fmt + self.kwargs = kwargs + + def __str__(self): + from string import Template + return Template(self.fmt).substitute(**self.kwargs) + +Either of these can be used in place of a format string, to allow {}- or +$-formatting to be used to build the actual "message" part which appears in the +formatted log output in place of "%(message)s" or "{message}" or "$message". +It's a little unwieldy to use the class names whenever you want to log +something, but it's quite palatable if you use an alias such as __ (double +underscore --- not to be confused with _, the single underscore used as a +synonym/alias for :func:`gettext.gettext` or its brethren). + +The above classes are not included in Python, though they're easy enough to +copy and paste into your own code. They can be used as follows (assuming that +they're declared in a module called ``wherever``): + +.. code-block:: pycon + + >>> from wherever import BraceMessage as __ + >>> print(__('Message with {0} {name}', 2, name='placeholders')) + Message with 2 placeholders + >>> class Point: pass + ... + >>> p = Point() + >>> p.x = 0.5 + >>> p.y = 0.5 + >>> print(__('Message with coordinates: ({point.x:.2f}, {point.y:.2f})', + ... point=p)) + Message with coordinates: (0.50, 0.50) + >>> from wherever import DollarMessage as __ + >>> print(__('Message with $num $what', num=2, what='placeholders')) + Message with 2 placeholders + >>> + +While the above examples use ``print()`` to show how the formatting works, you +would of course use ``logger.debug()`` or similar to actually log using this +approach. + +One thing to note is that you pay no significant performance penalty with this +approach: the actual formatting happens not when you make the logging call, but +when (and if) the logged message is actually about to be output to a log by a +handler. So the only slightly unusual thing which might trip you up is that the +parentheses go around the format string and the arguments, not just the format +string. That's because the __ notation is just syntax sugar for a constructor +call to one of the XXXMessage classes. + +If you prefer, you can use a :class:`LoggerAdapter` to achieve a similar effect +to the above, as in the following example:: + + import logging + + class Message(object): + def __init__(self, fmt, args): + self.fmt = fmt + self.args = args + + def __str__(self): + return self.fmt.format(*self.args) + + class StyleAdapter(logging.LoggerAdapter): + def __init__(self, logger, extra=None): + super(StyleAdapter, self).__init__(logger, extra or {}) + + def log(self, level, msg, *args, **kwargs): + if self.isEnabledFor(level): + msg, kwargs = self.process(msg, kwargs) + self.logger._log(level, Message(msg, args), (), **kwargs) + + logger = StyleAdapter(logging.getLogger(__name__)) + + def main(): + logger.debug('Hello, {}', 'world!') + + if __name__ == '__main__': + logging.basicConfig(level=logging.DEBUG) + main() + +The above script should log the message ``Hello, world!`` when run with +Python 3.2 or later. + + +.. currentmodule:: logging + +.. _custom-logrecord: + +Customizing ``LogRecord`` +------------------------- + +Every logging event is represented by a :class:`LogRecord` instance. +When an event is logged and not filtered out by a logger's level, a +:class:`LogRecord` is created, populated with information about the event and +then passed to the handlers for that logger (and its ancestors, up to and +including the logger where further propagation up the hierarchy is disabled). +Before Python 3.2, there were only two places where this creation was done: + +* :meth:`Logger.makeRecord`, which is called in the normal process of + logging an event. This invoked :class:`LogRecord` directly to create an + instance. +* :func:`makeLogRecord`, which is called with a dictionary containing + attributes to be added to the LogRecord. This is typically invoked when a + suitable dictionary has been received over the network (e.g. in pickle form + via a :class:`~handlers.SocketHandler`, or in JSON form via an + :class:`~handlers.HTTPHandler`). + +This has usually meant that if you need to do anything special with a +:class:`LogRecord`, you've had to do one of the following. + +* Create your own :class:`Logger` subclass, which overrides + :meth:`Logger.makeRecord`, and set it using :func:`~logging.setLoggerClass` + before any loggers that you care about are instantiated. +* Add a :class:`Filter` to a logger or handler, which does the + necessary special manipulation you need when its + :meth:`~Filter.filter` method is called. + +The first approach would be a little unwieldy in the scenario where (say) +several different libraries wanted to do different things. Each would attempt +to set its own :class:`Logger` subclass, and the one which did this last would +win. + +The second approach works reasonably well for many cases, but does not allow +you to e.g. use a specialized subclass of :class:`LogRecord`. Library +developers can set a suitable filter on their loggers, but they would have to +remember to do this every time they introduced a new logger (which they would +do simply by adding new packages or modules and doing :: + + logger = logging.getLogger(__name__) + +at module level). It's probably one too many things to think about. Developers +could also add the filter to a :class:`~logging.NullHandler` attached to their +top-level logger, but this would not be invoked if an application developer +attached a handler to a lower-level library logger --- so output from that +handler would not reflect the intentions of the library developer. + +In Python 3.2 and later, :class:`~logging.LogRecord` creation is done through a +factory, which you can specify. The factory is just a callable you can set with +:func:`~logging.setLogRecordFactory`, and interrogate with +:func:`~logging.getLogRecordFactory`. The factory is invoked with the same +signature as the :class:`~logging.LogRecord` constructor, as :class:`LogRecord` +is the default setting for the factory. + +This approach allows a custom factory to control all aspects of LogRecord +creation. For example, you could return a subclass, or just add some additional +attributes to the record once created, using a pattern similar to this:: + + old_factory = logging.getLogRecordFactory() + + def record_factory(*args, **kwargs): + record = old_factory(*args, **kwargs) + record.custom_attribute = 0xdecafbad + return record + + logging.setLogRecordFactory(record_factory) + +This pattern allows different libraries to chain factories together, and as +long as they don't overwrite each other's attributes or unintentionally +overwrite the attributes provided as standard, there should be no surprises. +However, it should be borne in mind that each link in the chain adds run-time +overhead to all logging operations, and the technique should only be used when +the use of a :class:`Filter` does not provide the desired result. + + +.. _zeromq-handlers: + +Subclassing QueueHandler - a ZeroMQ example +------------------------------------------- + +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 + + ctx = zmq.Context() + 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): + self.queue.send_json(record.__dict__) + + + handler = ZeroMQSocketHandler(sock) + + +Of course there are other ways of organizing this, for example passing in the +data needed by the handler to create the socket:: + + class ZeroMQSocketHandler(QueueHandler): + def __init__(self, uri, socktype=zmq.PUB, ctx=None): + self.ctx = ctx or zmq.Context() + socket = zmq.Socket(self.ctx, socktype) + socket.bind(uri) + super().__init__(socket) + + def enqueue(self, record): + self.queue.send_json(record.__dict__) + + def close(self): + self.queue.close() + + +Subclassing QueueListener - a ZeroMQ example +-------------------------------------------- + +You can also subclass :class:`QueueListener` to get messages from other kinds +of queues, for example a ZeroMQ 'subscribe' socket. Here's an example:: + + class ZeroMQSocketListener(QueueListener): + def __init__(self, uri, *handlers, **kwargs): + self.ctx = kwargs.get('ctx') or zmq.Context() + socket = zmq.Socket(self.ctx, zmq.SUB) + socket.setsockopt_string(zmq.SUBSCRIBE, '') # subscribe to everything + socket.connect(uri) + super().__init__(socket, *handlers, **kwargs) + + def dequeue(self): + msg = self.queue.recv_json() + return logging.makeLogRecord(msg) + + +.. seealso:: + + Module :mod:`logging` + API reference for the logging module. + + Module :mod:`logging.config` + Configuration API for the logging module. + + Module :mod:`logging.handlers` + Useful handlers included with the logging module. + + :ref:`A basic logging tutorial ` + + :ref:`A more advanced logging tutorial ` + + +An example dictionary-based configuration +----------------------------------------- + +Below is an example of a logging configuration dictionary - it's taken from +the `documentation on the Django project `_. +This dictionary is passed to :func:`~config.dictConfig` to put the configuration into effect:: + + LOGGING = { + 'version': 1, + 'disable_existing_loggers': True, + 'formatters': { + 'verbose': { + 'format': '%(levelname)s %(asctime)s %(module)s %(process)d %(thread)d %(message)s' + }, + 'simple': { + 'format': '%(levelname)s %(message)s' + }, + }, + 'filters': { + 'special': { + '()': 'project.logging.SpecialFilter', + 'foo': 'bar', + } + }, + 'handlers': { + 'null': { + 'level':'DEBUG', + 'class':'django.utils.log.NullHandler', + }, + 'console':{ + 'level':'DEBUG', + 'class':'logging.StreamHandler', + 'formatter': 'simple' + }, + 'mail_admins': { + 'level': 'ERROR', + 'class': 'django.utils.log.AdminEmailHandler', + 'filters': ['special'] + } + }, + 'loggers': { + 'django': { + 'handlers':['null'], + 'propagate': True, + 'level':'INFO', + }, + 'django.request': { + 'handlers': ['mail_admins'], + 'level': 'ERROR', + 'propagate': False, + }, + 'myproject.custom': { + 'handlers': ['console', 'mail_admins'], + 'level': 'INFO', + 'filters': ['special'] + } + } + } + +For more information about this configuration, you can see the `relevant +section `_ +of the Django documentation. + +.. _cookbook-rotator-namer: + +Using a rotator and namer to customize log rotation processing +-------------------------------------------------------------- + +An example of how you can define a namer and rotator is given in the following +snippet, which shows zlib-based compression of the log file:: + + def namer(name): + return name + ".gz" + + def rotator(source, dest): + with open(source, "rb") as sf: + data = sf.read() + compressed = zlib.compress(data, 9) + with open(dest, "wb") as df: + df.write(compressed) + os.remove(source) + + rh = logging.handlers.RotatingFileHandler(...) + rh.rotator = rotator + rh.namer = namer + +These are not "true" .gz files, as they are bare compressed data, with no +"container" such as you’d find in an actual gzip file. This snippet is just +for illustration purposes. + +A more elaborate multiprocessing example +---------------------------------------- + +The following working example shows how logging can be used with multiprocessing +using configuration files. The configurations are fairly simple, but serve to +illustrate how more complex ones could be implemented in a real multiprocessing +scenario. + +In the example, the main process spawns a listener process and some worker +processes. Each of the main process, the listener and the workers have three +separate configurations (the workers all share the same configuration). We can +see logging in the main process, how the workers log to a QueueHandler and how +the listener implements a QueueListener and a more complex logging +configuration, and arranges to dispatch events received via the queue to the +handlers specified in the configuration. Note that these configurations are +purely illustrative, but you should be able to adapt this example to your own +scenario. + +Here's the script - the docstrings and the comments hopefully explain how it +works:: + + import logging + import logging.config + import logging.handlers + from multiprocessing import Process, Queue, Event, current_process + import os + import random + import time + + class MyHandler: + """ + A simple handler for logging events. It runs in the listener process and + dispatches events to loggers based on the name in the received record, + which then get dispatched, by the logging system, to the handlers + configured for those loggers. + """ + def handle(self, record): + logger = logging.getLogger(record.name) + # The process name is transformed just to show that it's the listener + # doing the logging to files and console + record.processName = '%s (for %s)' % (current_process().name, record.processName) + logger.handle(record) + + def listener_process(q, stop_event, config): + """ + This could be done in the main process, but is just done in a separate + process for illustrative purposes. + + This initialises logging according to the specified configuration, + starts the listener and waits for the main process to signal completion + via the event. The listener is then stopped, and the process exits. + """ + logging.config.dictConfig(config) + listener = logging.handlers.QueueListener(q, MyHandler()) + listener.start() + if os.name == 'posix': + # On POSIX, the setup logger will have been configured in the + # parent process, but should have been disabled following the + # dictConfig call. + # On Windows, since fork isn't used, the setup logger won't + # exist in the child, so it would be created and the message + # would appear - hence the "if posix" clause. + logger = logging.getLogger('setup') + logger.critical('Should not appear, because of disabled logger ...') + stop_event.wait() + listener.stop() + + def worker_process(config): + """ + A number of these are spawned for the purpose of illustration. In + practice, they could be a heterogeneous bunch of processes rather than + ones which are identical to each other. + + This initialises logging according to the specified configuration, + and logs a hundred messages with random levels to randomly selected + loggers. + + A small sleep is added to allow other processes a chance to run. This + is not strictly needed, but it mixes the output from the different + processes a bit more than if it's left out. + """ + logging.config.dictConfig(config) + levels = [logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR, + logging.CRITICAL] + loggers = ['foo', 'foo.bar', 'foo.bar.baz', + 'spam', 'spam.ham', 'spam.ham.eggs'] + if os.name == 'posix': + # On POSIX, the setup logger will have been configured in the + # parent process, but should have been disabled following the + # dictConfig call. + # On Windows, since fork isn't used, the setup logger won't + # exist in the child, so it would be created and the message + # would appear - hence the "if posix" clause. + logger = logging.getLogger('setup') + logger.critical('Should not appear, because of disabled logger ...') + for i in range(100): + lvl = random.choice(levels) + logger = logging.getLogger(random.choice(loggers)) + logger.log(lvl, 'Message no. %d', i) + time.sleep(0.01) + + def main(): + q = Queue() + # The main process gets a simple configuration which prints to the console. + config_initial = { + 'version': 1, + 'formatters': { + 'detailed': { + 'class': 'logging.Formatter', + 'format': '%(asctime)s %(name)-15s %(levelname)-8s %(processName)-10s %(message)s' + } + }, + 'handlers': { + 'console': { + 'class': 'logging.StreamHandler', + 'level': 'INFO', + }, + }, + 'root': { + 'level': 'DEBUG', + 'handlers': ['console'] + }, + } + # The worker process configuration is just a QueueHandler attached to the + # root logger, which allows all messages to be sent to the queue. + # We disable existing loggers to disable the "setup" logger used in the + # parent process. This is needed on POSIX because the logger will + # be there in the child following a fork(). + config_worker = { + 'version': 1, + 'disable_existing_loggers': True, + 'handlers': { + 'queue': { + 'class': 'logging.handlers.QueueHandler', + 'queue': q, + }, + }, + 'root': { + 'level': 'DEBUG', + 'handlers': ['queue'] + }, + } + # The listener process configuration shows that the full flexibility of + # logging configuration is available to dispatch events to handlers however + # you want. + # We disable existing loggers to disable the "setup" logger used in the + # parent process. This is needed on POSIX because the logger will + # be there in the child following a fork(). + config_listener = { + 'version': 1, + 'disable_existing_loggers': True, + 'formatters': { + 'detailed': { + 'class': 'logging.Formatter', + 'format': '%(asctime)s %(name)-15s %(levelname)-8s %(processName)-10s %(message)s' + }, + 'simple': { + 'class': 'logging.Formatter', + 'format': '%(name)-15s %(levelname)-8s %(processName)-10s %(message)s' + } + }, + 'handlers': { + 'console': { + 'class': 'logging.StreamHandler', + 'level': 'INFO', + 'formatter': 'simple', + }, + 'file': { + 'class': 'logging.FileHandler', + 'filename': 'mplog.log', + 'mode': 'w', + 'formatter': 'detailed', + }, + 'foofile': { + 'class': 'logging.FileHandler', + 'filename': 'mplog-foo.log', + 'mode': 'w', + 'formatter': 'detailed', + }, + 'errors': { + 'class': 'logging.FileHandler', + 'filename': 'mplog-errors.log', + 'mode': 'w', + 'level': 'ERROR', + 'formatter': 'detailed', + }, + }, + 'loggers': { + 'foo': { + 'handlers': ['foofile'] + } + }, + 'root': { + 'level': 'DEBUG', + 'handlers': ['console', 'file', 'errors'] + }, + } + # Log some initial events, just to show that logging in the parent works + # normally. + logging.config.dictConfig(config_initial) + logger = logging.getLogger('setup') + logger.info('About to create workers ...') + workers = [] + for i in range(5): + wp = Process(target=worker_process, name='worker %d' % (i + 1), + args=(config_worker,)) + workers.append(wp) + wp.start() + logger.info('Started worker: %s', wp.name) + logger.info('About to create listener ...') + stop_event = Event() + lp = Process(target=listener_process, name='listener', + args=(q, stop_event, config_listener)) + lp.start() + logger.info('Started listener') + # We now hang around for the workers to finish their work. + for wp in workers: + wp.join() + # Workers all done, listening can now stop. + # Logging in the parent still works normally. + logger.info('Telling listener to stop ...') + stop_event.set() + lp.join() + logger.info('All done.') + + if __name__ == '__main__': + main() + + +Inserting a BOM into messages sent to a SysLogHandler +----------------------------------------------------- + +:rfc:`5424` requires that a +Unicode message be sent to a syslog daemon as a set of bytes which have the +following structure: an optional pure-ASCII component, followed by a UTF-8 Byte +Order Mark (BOM), followed by Unicode encoded using UTF-8. (See the +:rfc:`relevant section of the specification <5424#section-6>`.) + +In Python 3.1, code was added to +:class:`~logging.handlers.SysLogHandler` to insert a BOM into the message, but +unfortunately, it was implemented incorrectly, with the BOM appearing at the +beginning of the message and hence not allowing any pure-ASCII component to +appear before it. + +As this behaviour is broken, the incorrect BOM insertion code is being removed +from Python 3.2.4 and later. However, it is not being replaced, and if you +want to produce :rfc:`5424`-compliant messages which include a BOM, an optional +pure-ASCII sequence before it and arbitrary Unicode after it, encoded using +UTF-8, then you need to do the following: + +#. Attach a :class:`~logging.Formatter` instance to your + :class:`~logging.handlers.SysLogHandler` instance, with a format string + such as:: + + 'ASCII section\ufeffUnicode section' + + The Unicode code point U+FEFF, when encoded using UTF-8, will be + encoded as a UTF-8 BOM -- the byte-string ``b'\xef\xbb\xbf'``. + +#. Replace the ASCII section with whatever placeholders you like, but make sure + that the data that appears in there after substitution is always ASCII (that + way, it will remain unchanged after UTF-8 encoding). + +#. Replace the Unicode section with whatever placeholders you like; if the data + which appears there after substitution contains characters outside the ASCII + range, that's fine -- it will be encoded using UTF-8. + +The formatted message *will* be encoded using UTF-8 encoding by +``SysLogHandler``. If you follow the above rules, you should be able to produce +:rfc:`5424`-compliant messages. If you don't, logging may not complain, but your +messages will not be RFC 5424-compliant, and your syslog daemon may complain. + + +Implementing structured logging +------------------------------- + +Although most logging messages are intended for reading by humans, and thus not +readily machine-parseable, there might be circumstances where you want to output +messages in a structured format which *is* capable of being parsed by a program +(without needing complex regular expressions to parse the log message). This is +straightforward to achieve using the logging package. There are a number of +ways in which this could be achieved, but the following is a simple approach +which uses JSON to serialise the event in a machine-parseable manner:: + + import json + import logging + + class StructuredMessage(object): + def __init__(self, message, **kwargs): + self.message = message + self.kwargs = kwargs + + def __str__(self): + return '%s >>> %s' % (self.message, json.dumps(self.kwargs)) + + _ = StructuredMessage # optional, to improve readability + + logging.basicConfig(level=logging.INFO, format='%(message)s') + logging.info(_('message 1', foo='bar', bar='baz', num=123, fnum=123.456)) + +If the above script is run, it prints: + +.. code-block:: none + + message 1 >>> {"fnum": 123.456, "num": 123, "bar": "baz", "foo": "bar"} + +Note that the order of items might be different according to the version of +Python used. + +If you need more specialised processing, you can use a custom JSON encoder, +as in the following complete example:: + + from __future__ import unicode_literals + + import json + import logging + + # This next bit is to ensure the script runs unchanged on 2.x and 3.x + try: + unicode + except NameError: + unicode = str + + class Encoder(json.JSONEncoder): + def default(self, o): + if isinstance(o, set): + return tuple(o) + elif isinstance(o, unicode): + return o.encode('unicode_escape').decode('ascii') + return super(Encoder, self).default(o) + + class StructuredMessage(object): + def __init__(self, message, **kwargs): + self.message = message + self.kwargs = kwargs + + def __str__(self): + s = Encoder().encode(self.kwargs) + return '%s >>> %s' % (self.message, s) + + _ = StructuredMessage # optional, to improve readability + + def main(): + logging.basicConfig(level=logging.INFO, format='%(message)s') + logging.info(_('message 1', set_value={1, 2, 3}, snowman='\u2603')) + + if __name__ == '__main__': + main() + +When the above script is run, it prints: + +.. code-block:: none + + message 1 >>> {"snowman": "\u2603", "set_value": [1, 2, 3]} + +Note that the order of items might be different according to the version of +Python used. + + +.. _custom-handlers: + +.. currentmodule:: logging.config + +Customizing handlers with :func:`dictConfig` +-------------------------------------------- + +There are times when you want to customize logging handlers in particular ways, +and if you use :func:`dictConfig` you may be able to do this without +subclassing. As an example, consider that you may want to set the ownership of a +log file. On POSIX, this is easily done using :func:`shutil.chown`, but the file +handlers in the stdlib don't offer built-in support. You can customize handler +creation using a plain function such as:: + + def owned_file_handler(filename, mode='a', encoding=None, owner=None): + if owner: + if not os.path.exists(filename): + open(filename, 'a').close() + shutil.chown(filename, *owner) + return logging.FileHandler(filename, mode, encoding) + +You can then specify, in a logging configuration passed to :func:`dictConfig`, +that a logging handler be created by calling this function:: + + LOGGING = { + 'version': 1, + 'disable_existing_loggers': False, + 'formatters': { + 'default': { + 'format': '%(asctime)s %(levelname)s %(name)s %(message)s' + }, + }, + 'handlers': { + 'file':{ + # The values below are popped from this dictionary and + # used to create the handler, set the handler's level and + # its formatter. + '()': owned_file_handler, + 'level':'DEBUG', + 'formatter': 'default', + # The values below are passed to the handler creator callable + # as keyword arguments. + 'owner': ['pulse', 'pulse'], + 'filename': 'chowntest.log', + 'mode': 'w', + 'encoding': 'utf-8', + }, + }, + 'root': { + 'handlers': ['file'], + 'level': 'DEBUG', + }, + } + +In this example I am setting the ownership using the ``pulse`` user and group, +just for the purposes of illustration. Putting it together into a working +script, ``chowntest.py``:: + + import logging, logging.config, os, shutil + + def owned_file_handler(filename, mode='a', encoding=None, owner=None): + if owner: + if not os.path.exists(filename): + open(filename, 'a').close() + shutil.chown(filename, *owner) + return logging.FileHandler(filename, mode, encoding) + + LOGGING = { + 'version': 1, + 'disable_existing_loggers': False, + 'formatters': { + 'default': { + 'format': '%(asctime)s %(levelname)s %(name)s %(message)s' + }, + }, + 'handlers': { + 'file':{ + # The values below are popped from this dictionary and + # used to create the handler, set the handler's level and + # its formatter. + '()': owned_file_handler, + 'level':'DEBUG', + 'formatter': 'default', + # The values below are passed to the handler creator callable + # as keyword arguments. + 'owner': ['pulse', 'pulse'], + 'filename': 'chowntest.log', + 'mode': 'w', + 'encoding': 'utf-8', + }, + }, + 'root': { + 'handlers': ['file'], + 'level': 'DEBUG', + }, + } + + logging.config.dictConfig(LOGGING) + logger = logging.getLogger('mylogger') + logger.debug('A debug message') + +To run this, you will probably need to run as ``root``: + +.. code-block:: shell-session + + $ sudo python3.3 chowntest.py + $ cat chowntest.log + 2013-11-05 09:34:51,128 DEBUG mylogger A debug message + $ ls -l chowntest.log + -rw-r--r-- 1 pulse pulse 55 2013-11-05 09:34 chowntest.log + +Note that this example uses Python 3.3 because that's where :func:`shutil.chown` +makes an appearance. This approach should work with any Python version that +supports :func:`dictConfig` - namely, Python 2.7, 3.2 or later. With pre-3.3 +versions, you would need to implement the actual ownership change using e.g. +:func:`os.chown`. + +In practice, the handler-creating function may be in a utility module somewhere +in your project. Instead of the line in the configuration:: + + '()': owned_file_handler, + +you could use e.g.:: + + '()': 'ext://project.util.owned_file_handler', + +where ``project.util`` can be replaced with the actual name of the package +where the function resides. In the above working script, using +``'ext://__main__.owned_file_handler'`` should work. Here, the actual callable +is resolved by :func:`dictConfig` from the ``ext://`` specification. + +This example hopefully also points the way to how you could implement other +types of file change - e.g. setting specific POSIX permission bits - in the +same way, using :func:`os.chmod`. + +Of course, the approach could also be extended to types of handler other than a +:class:`~logging.FileHandler` - for example, one of the rotating file handlers, +or a different type of handler altogether. + + +.. currentmodule:: logging + +.. _formatting-styles: + +Using particular formatting styles throughout your application +-------------------------------------------------------------- + +In Python 3.2, the :class:`~logging.Formatter` gained a ``style`` keyword +parameter which, while defaulting to ``%`` for backward compatibility, allowed +the specification of ``{`` or ``$`` to support the formatting approaches +supported by :meth:`str.format` and :class:`string.Template`. Note that this +governs the formatting of logging messages for final output to logs, and is +completely orthogonal to how an individual logging message is constructed. + +Logging calls (:meth:`~Logger.debug`, :meth:`~Logger.info` etc.) only take +positional parameters for the actual logging message itself, with keyword +parameters used only for determining options for how to handle the logging call +(e.g. the ``exc_info`` keyword parameter to indicate that traceback information +should be logged, or the ``extra`` keyword parameter to indicate additional +contextual information to be added to the log). So you cannot directly make +logging calls using :meth:`str.format` or :class:`string.Template` syntax, +because internally the logging package uses %-formatting to merge the format +string and the variable arguments. There would no changing this while preserving +backward compatibility, since all logging calls which are out there in existing +code will be using %-format strings. + +There have been suggestions to associate format styles with specific loggers, +but that approach also runs into backward compatibility problems because any +existing code could be using a given logger name and using %-formatting. + +For logging to work interoperably between any third-party libraries and your +code, decisions about formatting need to be made at the level of the +individual logging call. This opens up a couple of ways in which alternative +formatting styles can be accommodated. + + +Using LogRecord factories +^^^^^^^^^^^^^^^^^^^^^^^^^ + +In Python 3.2, along with the :class:`~logging.Formatter` changes mentioned +above, the logging package gained the ability to allow users to set their own +:class:`LogRecord` subclasses, using the :func:`setLogRecordFactory` function. +You can use this to set your own subclass of :class:`LogRecord`, which does the +Right Thing by overriding the :meth:`~LogRecord.getMessage` method. The base +class implementation of this method is where the ``msg % args`` formatting +happens, and where you can substitute your alternate formatting; however, you +should be careful to support all formatting styles and allow %-formatting as +the default, to ensure interoperability with other code. Care should also be +taken to call ``str(self.msg)``, just as the base implementation does. + +Refer to the reference documentation on :func:`setLogRecordFactory` and +:class:`LogRecord` for more information. + + +Using custom message objects +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +There is another, perhaps simpler way that you can use {}- and $- formatting to +construct your individual log messages. You may recall (from +:ref:`arbitrary-object-messages`) that when logging you can use an arbitrary +object as a message format string, and that the logging package will call +:func:`str` on that object to get the actual format string. Consider the +following two classes:: + + class BraceMessage(object): + def __init__(self, fmt, *args, **kwargs): + self.fmt = fmt + self.args = args + self.kwargs = kwargs + + def __str__(self): + return self.fmt.format(*self.args, **self.kwargs) + + class DollarMessage(object): + def __init__(self, fmt, **kwargs): + self.fmt = fmt + self.kwargs = kwargs + + def __str__(self): + from string import Template + return Template(self.fmt).substitute(**self.kwargs) + +Either of these can be used in place of a format string, to allow {}- or +$-formatting to be used to build the actual "message" part which appears in the +formatted log output in place of “%(message)s” or “{message}” or “$message”. +If you find it a little unwieldy to use the class names whenever you want to log +something, you can make it more palatable if you use an alias such as ``M`` or +``_`` for the message (or perhaps ``__``, if you are using ``_`` for +localization). + +Examples of this approach are given below. Firstly, formatting with +:meth:`str.format`:: + + >>> __ = BraceMessage + >>> print(__('Message with {0} {1}', 2, 'placeholders')) + Message with 2 placeholders + >>> class Point: pass + ... + >>> p = Point() + >>> p.x = 0.5 + >>> p.y = 0.5 + >>> print(__('Message with coordinates: ({point.x:.2f}, {point.y:.2f})', point=p)) + Message with coordinates: (0.50, 0.50) + +Secondly, formatting with :class:`string.Template`:: + + >>> __ = DollarMessage + >>> print(__('Message with $num $what', num=2, what='placeholders')) + Message with 2 placeholders + >>> + +One thing to note is that you pay no significant performance penalty with this +approach: the actual formatting happens not when you make the logging call, but +when (and if) the logged message is actually about to be output to a log by a +handler. So the only slightly unusual thing which might trip you up is that the +parentheses go around the format string and the arguments, not just the format +string. That’s because the __ notation is just syntax sugar for a constructor +call to one of the ``XXXMessage`` classes shown above. + + +.. _filters-dictconfig: + +.. currentmodule:: logging.config + +Configuring filters with :func:`dictConfig` +------------------------------------------- + +You *can* configure filters using :func:`~logging.config.dictConfig`, though it +might not be obvious at first glance how to do it (hence this recipe). Since +:class:`~logging.Filter` is the only filter class included in the standard +library, and it is unlikely to cater to many requirements (it's only there as a +base class), you will typically need to define your own :class:`~logging.Filter` +subclass with an overridden :meth:`~logging.Filter.filter` method. To do this, +specify the ``()`` key in the configuration dictionary for the filter, +specifying a callable which will be used to create the filter (a class is the +most obvious, but you can provide any callable which returns a +:class:`~logging.Filter` instance). Here is a complete example:: + + import logging + import logging.config + import sys + + class MyFilter(logging.Filter): + def __init__(self, param=None): + self.param = param + + def filter(self, record): + if self.param is None: + allow = True + else: + allow = self.param not in record.msg + if allow: + record.msg = 'changed: ' + record.msg + return allow + + LOGGING = { + 'version': 1, + 'filters': { + 'myfilter': { + '()': MyFilter, + 'param': 'noshow', + } + }, + 'handlers': { + 'console': { + 'class': 'logging.StreamHandler', + 'filters': ['myfilter'] + } + }, + 'root': { + 'level': 'DEBUG', + 'handlers': ['console'] + }, + } + + if __name__ == '__main__': + logging.config.dictConfig(LOGGING) + logging.debug('hello') + logging.debug('hello - noshow') + +This example shows how you can pass configuration data to the callable which +constructs the instance, in the form of keyword parameters. When run, the above +script will print: + +.. code-block:: none + + changed: hello + +which shows that the filter is working as configured. + +A couple of extra points to note: + +* If you can't refer to the callable directly in the configuration (e.g. if it + lives in a different module, and you can't import it directly where the + configuration dictionary is), you can use the form ``ext://...`` as described + in :ref:`logging-config-dict-externalobj`. For example, you could have used + the text ``'ext://__main__.MyFilter'`` instead of ``MyFilter`` in the above + example. + +* As well as for filters, this technique can also be used to configure custom + handlers and formatters. See :ref:`logging-config-dict-userdef` for more + information on how logging supports using user-defined objects in its + configuration, and see the other cookbook recipe :ref:`custom-handlers` above. + + +.. _custom-format-exception: + +Customized exception formatting +------------------------------- + +There might be times when you want to do customized exception formatting - for +argument's sake, let's say you want exactly one line per logged event, even +when exception information is present. You can do this with a custom formatter +class, as shown in the following example:: + + import logging + + class OneLineExceptionFormatter(logging.Formatter): + def formatException(self, exc_info): + """ + 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 + + def format(self, record): + s = super(OneLineExceptionFormatter, self).format(record) + if record.exc_text: + s = s.replace('\n', '') + '|' + return s + + def configure_logging(): + fh = logging.FileHandler('output.txt', 'w') + f = OneLineExceptionFormatter('%(asctime)s|%(levelname)s|%(message)s|', + '%d/%m/%Y %H:%M:%S') + fh.setFormatter(f) + root = logging.getLogger() + root.setLevel(logging.DEBUG) + root.addHandler(fh) + + def main(): + configure_logging() + logging.info('Sample message') + try: + x = 1 / 0 + except ZeroDivisionError as e: + logging.exception('ZeroDivisionError: %s', e) + + if __name__ == '__main__': + main() + +When run, this produces a file with exactly two lines: + +.. code-block:: none + + 28/01/2015 07:21:23|INFO|Sample message| + 28/01/2015 07:21:23|ERROR|ZeroDivisionError: integer division or modulo by zero|'Traceback (most recent call last):\n File "logtest7.py", line 30, in main\n x = 1 / 0\nZeroDivisionError: integer division or modulo by zero'| + +While the above treatment is simplistic, it points the way to how exception +information can be formatted to your liking. The :mod:`traceback` module may be +helpful for more specialized needs. + +.. _spoken-messages: + +Speaking logging messages +------------------------- + +There might be situations when it is desirable to have logging messages rendered +in an audible rather than a visible format. This is easy to do if you have +text-to-speech (TTS) functionality available in your system, even if it doesn't have +a Python binding. Most TTS systems have a command line program you can run, and +this can be invoked from a handler using :mod:`subprocess`. It's assumed here +that TTS command line programs won't expect to interact with users or take a +long time to complete, and that the frequency of logged messages will be not so +high as to swamp the user with messages, and that it's acceptable to have the +messages spoken one at a time rather than concurrently, The example implementation +below waits for one message to be spoken before the next is processed, and this +might cause other handlers to be kept waiting. Here is a short example showing +the approach, which assumes that the ``espeak`` TTS package is available:: + + import logging + import subprocess + import sys + + class TTSHandler(logging.Handler): + def emit(self, record): + msg = self.format(record) + # Speak slowly in a female English voice + cmd = ['espeak', '-s150', '-ven+f3', msg] + p = subprocess.Popen(cmd, stdout=subprocess.PIPE, + stderr=subprocess.STDOUT) + # wait for the program to finish + p.communicate() + + def configure_logging(): + h = TTSHandler() + root = logging.getLogger() + root.addHandler(h) + # the default formatter just returns the message + root.setLevel(logging.DEBUG) + + def main(): + logging.info('Hello') + logging.debug('Goodbye') + + if __name__ == '__main__': + configure_logging() + sys.exit(main()) + +When run, this script should say "Hello" and then "Goodbye" in a female voice. + +The above approach can, of course, be adapted to other TTS systems and even +other systems altogether which can process messages via external programs run +from a command line. + + +.. _buffered-logging: + +Buffering logging messages and outputting them conditionally +------------------------------------------------------------ + +There might be situations where you want to log messages in a temporary area +and only output them if a certain condition occurs. For example, you may want to +start logging debug events in a function, and if the function completes without +errors, you don't want to clutter the log with the collected debug information, +but if there is an error, you want all the debug information to be output as well +as the error. + +Here is an example which shows how you could do this using a decorator for your +functions where you want logging to behave this way. It makes use of the +:class:`logging.handlers.MemoryHandler`, which allows buffering of logged events +until some condition occurs, at which point the buffered events are ``flushed`` +- passed to another handler (the ``target`` handler) for processing. By default, +the ``MemoryHandler`` flushed when its buffer gets filled up or an event whose +level is greater than or equal to a specified threshold is seen. You can use this +recipe with a more specialised subclass of ``MemoryHandler`` if you want custom +flushing behavior. + +The example script has a simple function, ``foo``, which just cycles through +all the logging levels, writing to ``sys.stderr`` to say what level it's about +to log at, and then actually logging a message at that level. You can pass a +parameter to ``foo`` which, if true, will log at ERROR and CRITICAL levels - +otherwise, it only logs at DEBUG, INFO and WARNING levels. + +The script just arranges to decorate ``foo`` with a decorator which will do the +conditional logging that's required. The decorator takes a logger as a parameter +and attaches a memory handler for the duration of the call to the decorated +function. The decorator can be additionally parameterised using a target handler, +a level at which flushing should occur, and a capacity for the buffer (number of +records buffered). These default to a :class:`~logging.StreamHandler` which +writes to ``sys.stderr``, ``logging.ERROR`` and ``100`` respectively. + +Here's the script:: + + import logging + from logging.handlers import MemoryHandler + import sys + + logger = logging.getLogger(__name__) + logger.addHandler(logging.NullHandler()) + + def log_if_errors(logger, target_handler=None, flush_level=None, capacity=None): + if target_handler is None: + target_handler = logging.StreamHandler() + if flush_level is None: + flush_level = logging.ERROR + if capacity is None: + capacity = 100 + handler = MemoryHandler(capacity, flushLevel=flush_level, target=target_handler) + + def decorator(fn): + def wrapper(*args, **kwargs): + logger.addHandler(handler) + try: + return fn(*args, **kwargs) + except Exception: + logger.exception('call failed') + raise + finally: + super(MemoryHandler, handler).flush() + logger.removeHandler(handler) + return wrapper + + return decorator + + def write_line(s): + sys.stderr.write('%s\n' % s) + + def foo(fail=False): + write_line('about to log at DEBUG ...') + logger.debug('Actually logged at DEBUG') + write_line('about to log at INFO ...') + logger.info('Actually logged at INFO') + write_line('about to log at WARNING ...') + logger.warning('Actually logged at WARNING') + if fail: + write_line('about to log at ERROR ...') + logger.error('Actually logged at ERROR') + write_line('about to log at CRITICAL ...') + logger.critical('Actually logged at CRITICAL') + return fail + + decorated_foo = log_if_errors(logger)(foo) + + if __name__ == '__main__': + logger.setLevel(logging.DEBUG) + write_line('Calling undecorated foo with False') + assert not foo(False) + write_line('Calling undecorated foo with True') + assert foo(True) + write_line('Calling decorated foo with False') + assert not decorated_foo(False) + write_line('Calling decorated foo with True') + assert decorated_foo(True) + +When this script is run, the following output should be observed: + +.. code-block:: none + + Calling undecorated foo with False + about to log at DEBUG ... + about to log at INFO ... + about to log at WARNING ... + Calling undecorated foo with True + about to log at DEBUG ... + about to log at INFO ... + about to log at WARNING ... + about to log at ERROR ... + about to log at CRITICAL ... + Calling decorated foo with False + about to log at DEBUG ... + about to log at INFO ... + about to log at WARNING ... + Calling decorated foo with True + about to log at DEBUG ... + about to log at INFO ... + about to log at WARNING ... + about to log at ERROR ... + Actually logged at DEBUG + Actually logged at INFO + Actually logged at WARNING + Actually logged at ERROR + about to log at CRITICAL ... + Actually logged at CRITICAL + +As you can see, actual logging output only occurs when an event is logged whose +severity is ERROR or greater, but in that case, any previous events at lower +severities are also logged. + +You can of course use the conventional means of decoration:: + + @log_if_errors(logger) + def foo(fail=False): + ... + + +.. _utc-formatting: + +Formatting times using UTC (GMT) via configuration +-------------------------------------------------- + +Sometimes you want to format times using UTC, which can be done using a class +such as `UTCFormatter`, shown below:: + + import logging + import time + + class UTCFormatter(logging.Formatter): + converter = time.gmtime + +and you can then use the ``UTCFormatter`` in your code instead of +:class:`~logging.Formatter`. If you want to do that via configuration, you can +use the :func:`~logging.config.dictConfig` API with an approach illustrated by +the following complete example:: + + import logging + import logging.config + import time + + class UTCFormatter(logging.Formatter): + converter = time.gmtime + + LOGGING = { + 'version': 1, + 'disable_existing_loggers': False, + 'formatters': { + 'utc': { + '()': UTCFormatter, + 'format': '%(asctime)s %(message)s', + }, + 'local': { + 'format': '%(asctime)s %(message)s', + } + }, + 'handlers': { + 'console1': { + 'class': 'logging.StreamHandler', + 'formatter': 'utc', + }, + 'console2': { + 'class': 'logging.StreamHandler', + 'formatter': 'local', + }, + }, + 'root': { + 'handlers': ['console1', 'console2'], + } + } + + if __name__ == '__main__': + logging.config.dictConfig(LOGGING) + logging.warning('The local time is %s', time.asctime()) + +When this script is run, it should print something like: + +.. code-block:: none + + 2015-10-17 12:53:29,501 The local time is Sat Oct 17 13:53:29 2015 + 2015-10-17 13:53:29,501 The local time is Sat Oct 17 13:53:29 2015 + +showing how the time is formatted both as local time and UTC, one for each +handler. + + +.. _context-manager: + +Using a context manager for selective logging +--------------------------------------------- + +There are times when it would be useful to temporarily change the logging +configuration and revert it back after doing something. For this, a context +manager is the most obvious way of saving and restoring the logging context. +Here is a simple example of such a context manager, which allows you to +optionally change the logging level and add a logging handler purely in the +scope of the context manager:: + + import logging + import sys + + class LoggingContext(object): + def __init__(self, logger, level=None, handler=None, close=True): + self.logger = logger + self.level = level + self.handler = handler + self.close = close + + def __enter__(self): + if self.level is not None: + self.old_level = self.logger.level + self.logger.setLevel(self.level) + if self.handler: + self.logger.addHandler(self.handler) + + def __exit__(self, et, ev, tb): + if self.level is not None: + self.logger.setLevel(self.old_level) + if self.handler: + self.logger.removeHandler(self.handler) + if self.handler and self.close: + self.handler.close() + # implicit return of None => don't swallow exceptions + +If you specify a level value, the logger's level is set to that value in the +scope of the with block covered by the context manager. If you specify a +handler, it is added to the logger on entry to the block and removed on exit +from the block. You can also ask the manager to close the handler for you on +block exit - you could do this if you don't need the handler any more. + +To illustrate how it works, we can add the following block of code to the +above:: + + if __name__ == '__main__': + logger = logging.getLogger('foo') + logger.addHandler(logging.StreamHandler()) + logger.setLevel(logging.INFO) + logger.info('1. This should appear just once on stderr.') + logger.debug('2. This should not appear.') + with LoggingContext(logger, level=logging.DEBUG): + logger.debug('3. This should appear once on stderr.') + logger.debug('4. This should not appear.') + h = logging.StreamHandler(sys.stdout) + with LoggingContext(logger, level=logging.DEBUG, handler=h, close=True): + logger.debug('5. This should appear twice - once on stderr and once on stdout.') + logger.info('6. This should appear just once on stderr.') + logger.debug('7. This should not appear.') + +We initially set the logger's level to ``INFO``, so message #1 appears and +message #2 doesn't. We then change the level to ``DEBUG`` temporarily in the +following ``with`` block, and so message #3 appears. After the block exits, the +logger's level is restored to ``INFO`` and so message #4 doesn't appear. In the +next ``with`` block, we set the level to ``DEBUG`` again but also add a handler +writing to ``sys.stdout``. Thus, message #5 appears twice on the console (once +via ``stderr`` and once via ``stdout``). After the ``with`` statement's +completion, the status is as it was before so message #6 appears (like message +#1) whereas message #7 doesn't (just like message #2). + +If we run the resulting script, the result is as follows: + +.. code-block:: shell-session + + $ python logctx.py + 1. This should appear just once on stderr. + 3. This should appear once on stderr. + 5. This should appear twice - once on stderr and once on stdout. + 5. This should appear twice - once on stderr and once on stdout. + 6. This should appear just once on stderr. + +If we run it again, but pipe ``stderr`` to ``/dev/null``, we see the following, +which is the only message written to ``stdout``: + +.. code-block:: shell-session + + $ python logctx.py 2>/dev/null + 5. This should appear twice - once on stderr and once on stdout. + +Once again, but piping ``stdout`` to ``/dev/null``, we get: + +.. code-block:: shell-session + + $ python logctx.py >/dev/null + 1. This should appear just once on stderr. + 3. This should appear once on stderr. + 5. This should appear twice - once on stderr and once on stdout. + 6. This should appear just once on stderr. + +In this case, the message #5 printed to ``stdout`` doesn't appear, as expected. + +Of course, the approach described here can be generalised, for example to attach +logging filters temporarily. Note that the above code works in Python 2 as well +as Python 3. diff --git a/python-3.7.4-docs-html/_sources/howto/logging.rst.txt b/python-3.7.4-docs-html/_sources/howto/logging.rst.txt new file mode 100644 index 0000000..7a68ca8 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/howto/logging.rst.txt @@ -0,0 +1,1103 @@ +============= +Logging HOWTO +============= + +:Author: Vinay Sajip + +.. _logging-basic-tutorial: + +.. currentmodule:: logging + +Basic Logging Tutorial +---------------------- + +Logging is a means of tracking events that happen when some software runs. The +software's developer adds logging calls to their code to indicate that certain +events have occurred. An event is described by a descriptive message which can +optionally contain variable data (i.e. data that is potentially different for +each occurrence of the event). Events also have an importance which the +developer ascribes to the event; the importance can also be called the *level* +or *severity*. + +When to use logging +^^^^^^^^^^^^^^^^^^^ + +Logging provides a set of convenience functions for simple logging usage. These +are :func:`debug`, :func:`info`, :func:`warning`, :func:`error` and +:func:`critical`. To determine when to use logging, see the table below, which +states, for each of a set of common tasks, the best tool to use for it. + ++-------------------------------------+--------------------------------------+ +| Task you want to perform | The best tool for the task | ++=====================================+======================================+ +| Display console output for ordinary | :func:`print` | +| usage of a command line script or | | +| program | | ++-------------------------------------+--------------------------------------+ +| Report events that occur during | :func:`logging.info` (or | +| normal operation of a program (e.g. | :func:`logging.debug` for very | +| for status monitoring or fault | detailed output for diagnostic | +| investigation) | purposes) | ++-------------------------------------+--------------------------------------+ +| Issue a warning regarding a | :func:`warnings.warn` in library | +| particular runtime event | code if the issue is avoidable and | +| | the client application should be | +| | modified to eliminate the warning | +| | | +| | :func:`logging.warning` if there is | +| | nothing the client application can do| +| | about the situation, but the event | +| | should still be noted | ++-------------------------------------+--------------------------------------+ +| Report an error regarding a | Raise an exception | +| particular runtime event | | ++-------------------------------------+--------------------------------------+ +| Report suppression of an error | :func:`logging.error`, | +| without raising an exception (e.g. | :func:`logging.exception` or | +| error handler in a long-running | :func:`logging.critical` as | +| server process) | appropriate for the specific error | +| | and application domain | ++-------------------------------------+--------------------------------------+ + +The logging functions are named after the level or severity of the events +they are used to track. The standard levels and their applicability are +described below (in increasing order of severity): + +.. tabularcolumns:: |l|L| + ++--------------+---------------------------------------------+ +| Level | When it's used | ++==============+=============================================+ +| ``DEBUG`` | Detailed information, typically of interest | +| | only when diagnosing problems. | ++--------------+---------------------------------------------+ +| ``INFO`` | Confirmation that things are working as | +| | expected. | ++--------------+---------------------------------------------+ +| ``WARNING`` | An indication that something unexpected | +| | happened, or indicative of some problem in | +| | the near future (e.g. 'disk space low'). | +| | The software is still working as expected. | ++--------------+---------------------------------------------+ +| ``ERROR`` | Due to a more serious problem, the software | +| | has not been able to perform some function. | ++--------------+---------------------------------------------+ +| ``CRITICAL`` | A serious error, indicating that the program| +| | itself may be unable to continue running. | ++--------------+---------------------------------------------+ + +The default level is ``WARNING``, which means that only events of this level +and above will be tracked, unless the logging package is configured to do +otherwise. + +Events that are tracked can be handled in different ways. The simplest way of +handling tracked events is to print them to the console. Another common way +is to write them to a disk file. + + +.. _howto-minimal-example: + +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 + +If you type these lines into a script and run it, you'll see: + +.. code-block:: none + + WARNING:root:Watch out! + +printed out on the console. The ``INFO`` message doesn't appear because the +default level is ``WARNING``. The printed message includes the indication of +the level and the description of the event provided in the logging call, i.e. +'Watch out!'. Don't worry about the 'root' part for now: it will be explained +later. The actual output can be formatted quite flexibly if you need that; +formatting options will also be explained later. + + +Logging to a file +^^^^^^^^^^^^^^^^^ + +A very common situation is that of recording logging events in a file, so let's +look at that next. Be sure to try the following in a newly-started Python +interpreter, and don't just continue from the session described above:: + + import logging + logging.basicConfig(filename='example.log',level=logging.DEBUG) + logging.debug('This message should go to the log file') + logging.info('So should this') + logging.warning('And this, too') + +And now if we open the file and look at what we have, we should find the log +messages: + +.. code-block:: none + + DEBUG:root:This message should go to the log file + INFO:root:So should this + WARNING:root:And this, too + +This example also shows how you can set the logging level which acts as the +threshold for tracking. In this case, because we set the threshold to +``DEBUG``, all of the messages were printed. + +If you want to set the logging level from a command-line option such as: + +.. code-block:: none + + --log=INFO + +and you have the value of the parameter passed for ``--log`` in some variable +*loglevel*, you can use:: + + getattr(logging, loglevel.upper()) + +to get the value which you'll pass to :func:`basicConfig` via the *level* +argument. You may want to error check any user input value, perhaps as in the +following example:: + + # assuming loglevel is bound to the string value obtained from the + # command line argument. Convert to upper case to allow the user to + # specify --log=DEBUG or --log=debug + numeric_level = getattr(logging, loglevel.upper(), None) + if not isinstance(numeric_level, int): + raise ValueError('Invalid log level: %s' % loglevel) + logging.basicConfig(level=numeric_level, ...) + +The call to :func:`basicConfig` should come *before* any calls to :func:`debug`, +:func:`info` etc. As it's intended as a one-off simple configuration facility, +only the first call will actually do anything: subsequent calls are effectively +no-ops. + +If you run the above script several times, the messages from successive runs +are appended to the file *example.log*. If you want each run to start afresh, +not remembering the messages from earlier runs, you can specify the *filemode* +argument, by changing the call in the above example to:: + + logging.basicConfig(filename='example.log', filemode='w', level=logging.DEBUG) + +The output will be the same as before, but the log file is no longer appended +to, so the messages from earlier runs are lost. + + +Logging from multiple modules +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If your program consists of multiple modules, here's an example of how you +could organize logging in it:: + + # myapp.py + import logging + import mylib + + def main(): + logging.basicConfig(filename='myapp.log', level=logging.INFO) + logging.info('Started') + mylib.do_something() + logging.info('Finished') + + if __name__ == '__main__': + main() + +:: + + # mylib.py + import logging + + def do_something(): + logging.info('Doing something') + +If you run *myapp.py*, you should see this in *myapp.log*: + +.. code-block:: none + + INFO:root:Started + INFO:root:Doing something + INFO:root:Finished + +which is hopefully what you were expecting to see. You can generalize this to +multiple modules, using the pattern in *mylib.py*. Note that for this simple +usage pattern, you won't know, by looking in the log file, *where* in your +application your messages came from, apart from looking at the event +description. If you want to track the location of your messages, you'll need +to refer to the documentation beyond the tutorial level -- see +:ref:`logging-advanced-tutorial`. + + +Logging variable data +^^^^^^^^^^^^^^^^^^^^^ + +To log variable data, use a format string for the event description message and +append the variable data as arguments. For example:: + + import logging + logging.warning('%s before you %s', 'Look', 'leap!') + +will display: + +.. code-block:: none + + WARNING:root:Look before you leap! + +As you can see, merging of variable data into the event description message +uses the old, %-style of string formatting. This is for backwards +compatibility: the logging package pre-dates newer formatting options such as +:meth:`str.format` and :class:`string.Template`. These newer formatting +options *are* supported, but exploring them is outside the scope of this +tutorial: see :ref:`formatting-styles` for more information. + + +Changing the format of displayed messages +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To change the format which is used to display messages, you need to +specify the format you want to use:: + + import logging + logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG) + logging.debug('This message should appear on the console') + logging.info('So should this') + logging.warning('And this, too') + +which would print: + +.. code-block:: none + + DEBUG:This message should appear on the console + INFO:So should this + WARNING:And this, too + +Notice that the 'root' which appeared in earlier examples has disappeared. For +a full set of things that can appear in format strings, you can refer to the +documentation for :ref:`logrecord-attributes`, but for simple usage, you just +need the *levelname* (severity), *message* (event description, including +variable data) and perhaps to display when the event occurred. This is +described in the next section. + + +Displaying the date/time in messages +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To display the date and time of an event, you would place '%(asctime)s' in +your format string:: + + import logging + logging.basicConfig(format='%(asctime)s %(message)s') + logging.warning('is when this event was logged.') + +which should print something like this: + +.. code-block:: none + + 2010-12-12 11:41:42,612 is when this event was logged. + +The default format for date/time display (shown above) is like ISO8601 or +:rfc:`3339`. If you need more control over the formatting of the date/time, provide +a *datefmt* argument to ``basicConfig``, as in this example:: + + import logging + logging.basicConfig(format='%(asctime)s %(message)s', datefmt='%m/%d/%Y %I:%M:%S %p') + logging.warning('is when this event was logged.') + +which would display something like this: + +.. code-block:: none + + 12/12/2010 11:46:36 AM is when this event was logged. + +The format of the *datefmt* argument is the same as supported by +:func:`time.strftime`. + + +Next Steps +^^^^^^^^^^ + +That concludes the basic tutorial. It should be enough to get you up and +running with logging. There's a lot more that the logging package offers, but +to get the best out of it, you'll need to invest a little more of your time in +reading the following sections. If you're ready for that, grab some of your +favourite beverage and carry on. + +If your logging needs are simple, then use the above examples to incorporate +logging into your own scripts, and if you run into problems or don't +understand something, please post a question on the comp.lang.python Usenet +group (available at https://groups.google.com/forum/#!forum/comp.lang.python) and you +should receive help before too long. + +Still here? You can carry on reading the next few sections, which provide a +slightly more advanced/in-depth tutorial than the basic one above. After that, +you can take a look at the :ref:`logging-cookbook`. + +.. _logging-advanced-tutorial: + + +Advanced Logging Tutorial +------------------------- + +The logging library takes a modular approach and offers several categories +of components: loggers, handlers, filters, and formatters. + +* Loggers expose the interface that application code directly uses. +* Handlers send the log records (created by loggers) to the appropriate + destination. +* Filters provide a finer grained facility for determining which log records + to output. +* Formatters specify the layout of log records in the final output. + +Log event information is passed between loggers, handlers, filters and +formatters in a :class:`LogRecord` instance. + +Logging is performed by calling methods on instances of the :class:`Logger` +class (hereafter called :dfn:`loggers`). Each instance has a name, and they are +conceptually arranged in a namespace hierarchy using dots (periods) as +separators. For example, a logger named 'scan' is the parent of loggers +'scan.text', 'scan.html' and 'scan.pdf'. Logger names can be anything you want, +and indicate the area of an application in which a logged message originates. + +A good convention to use when naming loggers is to use a module-level logger, +in each module which uses logging, named as follows:: + + logger = logging.getLogger(__name__) + +This means that logger names track the package/module hierarchy, and it's +intuitively obvious where events are logged just from the logger name. + +The root of the hierarchy of loggers is called the root logger. That's the +logger used by the functions :func:`debug`, :func:`info`, :func:`warning`, +:func:`error` and :func:`critical`, which just call the same-named method of +the root logger. The functions and the methods have the same signatures. The +root logger's name is printed as 'root' in the logged output. + +It is, of course, possible to log messages to different destinations. Support +is included in the package for writing log messages to files, HTTP GET/POST +locations, email via SMTP, generic sockets, queues, or OS-specific logging +mechanisms such as syslog or the Windows NT event log. Destinations are served +by :dfn:`handler` classes. You can create your own log destination class if +you have special requirements not met by any of the built-in handler classes. + +By default, no destination is set for any logging messages. You can specify +a destination (such as console or file) by using :func:`basicConfig` as in the +tutorial examples. If you call the functions :func:`debug`, :func:`info`, +:func:`warning`, :func:`error` and :func:`critical`, they will check to see +if no destination is set; and if one is not set, they will set a destination +of the console (``sys.stderr``) and a default format for the displayed +message before delegating to the root logger to do the actual message output. + +The default format set by :func:`basicConfig` for messages is: + +.. code-block:: none + + severity:logger name:message + +You can change this by passing a format string to :func:`basicConfig` with the +*format* keyword argument. For all options regarding how a format string is +constructed, see :ref:`formatter-objects`. + +Logging Flow +^^^^^^^^^^^^ + +The flow of log event information in loggers and handlers is illustrated in the +following diagram. + +.. image:: logging_flow.png + +Loggers +^^^^^^^ + +:class:`Logger` objects have a threefold job. First, they expose several +methods to application code so that applications can log messages at runtime. +Second, logger objects determine which log messages to act upon based upon +severity (the default filtering facility) or filter objects. Third, logger +objects pass along relevant log messages to all interested log handlers. + +The most widely used methods on logger objects fall into two categories: +configuration and message sending. + +These are the most common configuration methods: + +* :meth:`Logger.setLevel` specifies the lowest-severity log message a logger + will handle, where debug is the lowest built-in severity level and critical + is the highest built-in severity. For example, if the severity level is + INFO, the logger will handle only INFO, WARNING, ERROR, and CRITICAL messages + and will ignore DEBUG messages. + +* :meth:`Logger.addHandler` and :meth:`Logger.removeHandler` add and remove + handler objects from the logger object. Handlers are covered in more detail + in :ref:`handler-basic`. + +* :meth:`Logger.addFilter` and :meth:`Logger.removeFilter` add and remove filter + objects from the logger object. Filters are covered in more detail in + :ref:`filter`. + +You don't need to always call these methods on every logger you create. See the +last two paragraphs in this section. + +With the logger object configured, the following methods create log messages: + +* :meth:`Logger.debug`, :meth:`Logger.info`, :meth:`Logger.warning`, + :meth:`Logger.error`, and :meth:`Logger.critical` all create log records with + a message and a level that corresponds to their respective method names. The + message is actually a format string, which may contain the standard string + substitution syntax of ``%s``, ``%d``, ``%f``, and so on. The + rest of their arguments is a list of objects that correspond with the + substitution fields in the message. With regard to ``**kwargs``, the + logging methods care only about a keyword of ``exc_info`` and use it to + determine whether to log exception information. + +* :meth:`Logger.exception` creates a log message similar to + :meth:`Logger.error`. The difference is that :meth:`Logger.exception` dumps a + stack trace along with it. Call this method only from an exception handler. + +* :meth:`Logger.log` takes a log level as an explicit argument. This is a + little more verbose for logging messages than using the log level convenience + methods listed above, but this is how to log at custom log levels. + +:func:`getLogger` returns a reference to a logger instance with the specified +name if it is provided, or ``root`` if not. The names are period-separated +hierarchical structures. Multiple calls to :func:`getLogger` with the same name +will return a reference to the same logger object. Loggers that are further +down in the hierarchical list are children of loggers higher up in the list. +For example, given a logger with a name of ``foo``, loggers with names of +``foo.bar``, ``foo.bar.baz``, and ``foo.bam`` are all descendants of ``foo``. + +Loggers have a concept of *effective level*. If a level is not explicitly set +on a logger, the level of its parent is used instead as its effective level. +If the parent has no explicit level set, *its* parent is examined, and so on - +all ancestors are searched until an explicitly set level is found. The root +logger always has an explicit level set (``WARNING`` by default). When deciding +whether to process an event, the effective level of the logger is used to +determine whether the event is passed to the logger's handlers. + +Child loggers propagate messages up to the handlers associated with their +ancestor loggers. Because of this, it is unnecessary to define and configure +handlers for all the loggers an application uses. It is sufficient to +configure handlers for a top-level logger and create child loggers as needed. +(You can, however, turn off propagation by setting the *propagate* +attribute of a logger to ``False``.) + + +.. _handler-basic: + +Handlers +^^^^^^^^ + +:class:`~logging.Handler` objects are responsible for dispatching the +appropriate log messages (based on the log messages' severity) to the handler's +specified destination. :class:`Logger` objects can add zero or more handler +objects to themselves with an :meth:`~Logger.addHandler` method. As an example +scenario, an application may want to send all log messages to a log file, all +log messages of error or higher to stdout, and all messages of critical to an +email address. This scenario requires three individual handlers where each +handler is responsible for sending messages of a specific severity to a specific +location. + +The standard library includes quite a few handler types (see +:ref:`useful-handlers`); the tutorials use mainly :class:`StreamHandler` and +:class:`FileHandler` in its examples. + +There are very few methods in a handler for application developers to concern +themselves with. The only handler methods that seem relevant for application +developers who are using the built-in handler objects (that is, not creating +custom handlers) are the following configuration methods: + +* The :meth:`~Handler.setLevel` method, just as in logger objects, specifies the + lowest severity that will be dispatched to the appropriate destination. Why + are there two :func:`setLevel` methods? The level set in the logger + determines which severity of messages it will pass to its handlers. The level + set in each handler determines which messages that handler will send on. + +* :meth:`~Handler.setFormatter` selects a Formatter object for this handler to + use. + +* :meth:`~Handler.addFilter` and :meth:`~Handler.removeFilter` respectively + configure and deconfigure filter objects on handlers. + +Application code should not directly instantiate and use instances of +:class:`Handler`. Instead, the :class:`Handler` class is a base class that +defines the interface that all handlers should have and establishes some +default behavior that child classes can use (or override). + + +Formatters +^^^^^^^^^^ + +Formatter objects configure the final order, structure, and contents of the log +message. Unlike the base :class:`logging.Handler` class, application code may +instantiate formatter classes, although you could likely subclass the formatter +if your application needs special behavior. The constructor takes three +optional arguments -- a message format string, a date format string and a style +indicator. + +.. method:: logging.Formatter.__init__(fmt=None, datefmt=None, style='%') + +If there is no message format string, the default is to use the +raw message. If there is no date format string, the default date format is: + +.. code-block:: none + + %Y-%m-%d %H:%M:%S + +with the milliseconds tacked on at the end. The ``style`` is one of `%`, '{' +or '$'. If one of these is not specified, then '%' will be used. + +If the ``style`` is '%', the message format string uses +``%()s`` styled string substitution; the possible keys are +documented in :ref:`logrecord-attributes`. If the style is '{', the message +format string is assumed to be compatible with :meth:`str.format` (using +keyword arguments), while if the style is '$' then the message format string +should conform to what is expected by :meth:`string.Template.substitute`. + +.. versionchanged:: 3.2 + Added the ``style`` parameter. + +The following message format string will log the time in a human-readable +format, the severity of the message, and the contents of the message, in that +order:: + + '%(asctime)s - %(levelname)s - %(message)s' + +Formatters use a user-configurable function to convert the creation time of a +record to a tuple. By default, :func:`time.localtime` is used; to change this +for a particular formatter instance, set the ``converter`` attribute of the +instance to a function with the same signature as :func:`time.localtime` or +:func:`time.gmtime`. To change it for all formatters, for example if you want +all logging times to be shown in GMT, set the ``converter`` attribute in the +Formatter class (to ``time.gmtime`` for GMT display). + + +Configuring Logging +^^^^^^^^^^^^^^^^^^^ + +.. currentmodule:: logging.config + +Programmers can configure logging in three ways: + +1. Creating loggers, handlers, and formatters explicitly using Python + code that calls the configuration methods listed above. +2. Creating a logging config file and reading it using the :func:`fileConfig` + function. +3. Creating a dictionary of configuration information and passing it + to the :func:`dictConfig` function. + +For the reference documentation on the last two options, see +:ref:`logging-config-api`. The following example configures a very simple +logger, a console handler, and a simple formatter using Python code:: + + import logging + + # create logger + logger = logging.getLogger('simple_example') + logger.setLevel(logging.DEBUG) + + # create console handler and set level to debug + ch = logging.StreamHandler() + ch.setLevel(logging.DEBUG) + + # create formatter + formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') + + # add formatter to ch + ch.setFormatter(formatter) + + # add ch to logger + logger.addHandler(ch) + + # 'application' code + logger.debug('debug message') + logger.info('info message') + logger.warning('warn message') + logger.error('error message') + logger.critical('critical message') + +Running this module from the command line produces the following output: + +.. code-block:: shell-session + + $ python simple_logging_module.py + 2005-03-19 15:10:26,618 - simple_example - DEBUG - debug message + 2005-03-19 15:10:26,620 - simple_example - INFO - info message + 2005-03-19 15:10:26,695 - simple_example - WARNING - warn message + 2005-03-19 15:10:26,697 - simple_example - ERROR - error message + 2005-03-19 15:10:26,773 - simple_example - CRITICAL - critical message + +The following Python module creates a logger, handler, and formatter nearly +identical to those in the example listed above, with the only difference being +the names of the objects:: + + import logging + import logging.config + + logging.config.fileConfig('logging.conf') + + # create logger + logger = logging.getLogger('simpleExample') + + # 'application' code + logger.debug('debug message') + logger.info('info message') + logger.warning('warn message') + logger.error('error message') + logger.critical('critical message') + +Here is the logging.conf file: + +.. code-block:: ini + + [loggers] + keys=root,simpleExample + + [handlers] + keys=consoleHandler + + [formatters] + keys=simpleFormatter + + [logger_root] + level=DEBUG + handlers=consoleHandler + + [logger_simpleExample] + level=DEBUG + handlers=consoleHandler + qualname=simpleExample + propagate=0 + + [handler_consoleHandler] + class=StreamHandler + level=DEBUG + formatter=simpleFormatter + args=(sys.stdout,) + + [formatter_simpleFormatter] + format=%(asctime)s - %(name)s - %(levelname)s - %(message)s + datefmt= + +The output is nearly identical to that of the non-config-file-based example: + +.. code-block:: shell-session + + $ python simple_logging_config.py + 2005-03-19 15:38:55,977 - simpleExample - DEBUG - debug message + 2005-03-19 15:38:55,979 - simpleExample - INFO - info message + 2005-03-19 15:38:56,054 - simpleExample - WARNING - warn message + 2005-03-19 15:38:56,055 - simpleExample - ERROR - error message + 2005-03-19 15:38:56,130 - simpleExample - CRITICAL - critical message + +You can see that the config file approach has a few advantages over the Python +code approach, mainly separation of configuration and code and the ability of +noncoders to easily modify the logging properties. + +.. warning:: The :func:`fileConfig` function takes a default parameter, + ``disable_existing_loggers``, which defaults to ``True`` for reasons of + backward compatibility. This may or may not be what you want, since it + will cause any non-root loggers existing before the :func:`fileConfig` + call to be disabled unless they (or an ancestor) are explicitly named in + the configuration. Please refer to the reference documentation for more + information, and specify ``False`` for this parameter if you wish. + + The dictionary passed to :func:`dictConfig` can also specify a Boolean + value with key ``disable_existing_loggers``, which if not specified + explicitly in the dictionary also defaults to being interpreted as + ``True``. This leads to the logger-disabling behaviour described above, + which may not be what you want - in which case, provide the key + explicitly with a value of ``False``. + + +.. currentmodule:: logging + +Note that the class names referenced in config files need to be either relative +to the logging module, or absolute values which can be resolved using normal +import mechanisms. Thus, you could use either +:class:`~logging.handlers.WatchedFileHandler` (relative to the logging module) or +``mypackage.mymodule.MyHandler`` (for a class defined in package ``mypackage`` +and module ``mymodule``, where ``mypackage`` is available on the Python import +path). + +In Python 3.2, a new means of configuring logging has been introduced, using +dictionaries to hold configuration information. This provides a superset of the +functionality of the config-file-based approach outlined above, and is the +recommended configuration method for new applications and deployments. Because +a Python dictionary is used to hold configuration information, and since you +can populate that dictionary using different means, you have more options for +configuration. For example, you can use a configuration file in JSON format, +or, if you have access to YAML processing functionality, a file in YAML +format, to populate the configuration dictionary. Or, of course, you can +construct the dictionary in Python code, receive it in pickled form over a +socket, or use whatever approach makes sense for your application. + +Here's an example of the same configuration as above, in YAML format for +the new dictionary-based approach: + +.. code-block:: yaml + + version: 1 + formatters: + simple: + format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s' + handlers: + console: + class: logging.StreamHandler + level: DEBUG + formatter: simple + stream: ext://sys.stdout + loggers: + simpleExample: + level: DEBUG + handlers: [console] + propagate: no + root: + level: DEBUG + handlers: [console] + +For more information about logging using a dictionary, see +:ref:`logging-config-api`. + +What happens if no configuration is provided +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If no logging configuration is provided, it is possible to have a situation +where a logging event needs to be output, but no handlers can be found to +output the event. The behaviour of the logging package in these +circumstances is dependent on the Python version. + +For versions of Python prior to 3.2, the behaviour is as follows: + +* If *logging.raiseExceptions* is ``False`` (production mode), the event is + silently dropped. + +* If *logging.raiseExceptions* is ``True`` (development mode), a message + 'No handlers could be found for logger X.Y.Z' is printed once. + +In Python 3.2 and later, the behaviour is as follows: + +* The event is output using a 'handler of last resort', stored in + ``logging.lastResort``. This internal handler is not associated with any + logger, and acts like a :class:`~logging.StreamHandler` which writes the + event description message to the current value of ``sys.stderr`` (therefore + respecting any redirections which may be in effect). No formatting is + done on the message - just the bare event description message is printed. + The handler's level is set to ``WARNING``, so all events at this and + greater severities will be output. + +To obtain the pre-3.2 behaviour, ``logging.lastResort`` can be set to ``None``. + +.. _library-config: + +Configuring Logging for a Library +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +When developing a library which uses logging, you should take care to +document how the library uses logging - for example, the names of loggers +used. Some consideration also needs to be given to its logging configuration. +If the using application does not use logging, and library code makes logging +calls, then (as described in the previous section) events of severity +``WARNING`` and greater will be printed to ``sys.stderr``. This is regarded as +the best default behaviour. + +If for some reason you *don't* want these messages printed in the absence of +any logging configuration, you can attach a do-nothing handler to the top-level +logger for your library. This avoids the message being printed, since a handler +will always be found for the library's events: it just doesn't produce any +output. If the library user configures logging for application use, presumably +that configuration will add some handlers, and if levels are suitably +configured then logging calls made in library code will send output to those +handlers, as normal. + +A do-nothing handler is included in the logging package: +:class:`~logging.NullHandler` (since Python 3.1). An instance of this handler +could be added to the top-level logger of the logging namespace used by the +library (*if* you want to prevent your library's logged events being output to +``sys.stderr`` in the absence of logging configuration). If all logging by a +library *foo* is done using loggers with names matching 'foo.x', 'foo.x.y', +etc. then the code:: + + import logging + logging.getLogger('foo').addHandler(logging.NullHandler()) + +should have the desired effect. If an organisation produces a number of +libraries, then the logger name specified can be 'orgname.foo' rather than +just 'foo'. + +.. note:: It is strongly advised that you *do not add any handlers other + than* :class:`~logging.NullHandler` *to your library's loggers*. This is + because the configuration of handlers is the prerogative of the application + developer who uses your library. The application developer knows their + target audience and what handlers are most appropriate for their + application: if you add handlers 'under the hood', you might well interfere + with their ability to carry out unit tests and deliver logs which suit their + requirements. + + +Logging Levels +-------------- + +The numeric values of logging levels are given in the following table. These are +primarily of interest if you want to define your own levels, and need them to +have specific values relative to the predefined levels. If you define a level +with the same numeric value, it overwrites the predefined value; the predefined +name is lost. + ++--------------+---------------+ +| Level | Numeric value | ++==============+===============+ +| ``CRITICAL`` | 50 | ++--------------+---------------+ +| ``ERROR`` | 40 | ++--------------+---------------+ +| ``WARNING`` | 30 | ++--------------+---------------+ +| ``INFO`` | 20 | ++--------------+---------------+ +| ``DEBUG`` | 10 | ++--------------+---------------+ +| ``NOTSET`` | 0 | ++--------------+---------------+ + +Levels can also be associated with loggers, being set either by the developer or +through loading a saved logging configuration. When a logging method is called +on a logger, the logger compares its own level with the level associated with +the method call. If the logger's level is higher than the method call's, no +logging message is actually generated. This is the basic mechanism controlling +the verbosity of logging output. + +Logging messages are encoded as instances of the :class:`~logging.LogRecord` +class. When a logger decides to actually log an event, a +:class:`~logging.LogRecord` instance is created from the logging message. + +Logging messages are subjected to a dispatch mechanism through the use of +:dfn:`handlers`, which are instances of subclasses of the :class:`Handler` +class. Handlers are responsible for ensuring that a logged message (in the form +of a :class:`LogRecord`) ends up in a particular location (or set of locations) +which is useful for the target audience for that message (such as end users, +support desk staff, system administrators, developers). Handlers are passed +:class:`LogRecord` instances intended for particular destinations. Each logger +can have zero, one or more handlers associated with it (via the +:meth:`~Logger.addHandler` method of :class:`Logger`). In addition to any +handlers directly associated with a logger, *all handlers associated with all +ancestors of the logger* are called to dispatch the message (unless the +*propagate* flag for a logger is set to a false value, at which point the +passing to ancestor handlers stops). + +Just as for loggers, handlers can have levels associated with them. A handler's +level acts as a filter in the same way as a logger's level does. If a handler +decides to actually dispatch an event, the :meth:`~Handler.emit` method is used +to send the message to its destination. Most user-defined subclasses of +:class:`Handler` will need to override this :meth:`~Handler.emit`. + +.. _custom-levels: + +Custom Levels +^^^^^^^^^^^^^ + +Defining your own levels is possible, but should not be necessary, as the +existing levels have been chosen on the basis of practical experience. +However, if you are convinced that you need custom levels, great care should +be exercised when doing this, and it is possibly *a very bad idea to define +custom levels if you are developing a library*. That's because if multiple +library authors all define their own custom levels, there is a chance that +the logging output from such multiple libraries used together will be +difficult for the using developer to control and/or interpret, because a +given numeric value might mean different things for different libraries. + +.. _useful-handlers: + +Useful Handlers +--------------- + +In addition to the base :class:`Handler` class, many useful subclasses are +provided: + +#. :class:`StreamHandler` instances send messages to streams (file-like + objects). + +#. :class:`FileHandler` instances send messages to disk files. + +#. :class:`~handlers.BaseRotatingHandler` is the base class for handlers that + rotate log files at a certain point. It is not meant to be instantiated + directly. Instead, use :class:`~handlers.RotatingFileHandler` or + :class:`~handlers.TimedRotatingFileHandler`. + +#. :class:`~handlers.RotatingFileHandler` instances send messages to disk + files, with support for maximum log file sizes and log file rotation. + +#. :class:`~handlers.TimedRotatingFileHandler` instances send messages to + disk files, rotating the log file at certain timed intervals. + +#. :class:`~handlers.SocketHandler` instances send messages to TCP/IP + sockets. Since 3.4, Unix domain sockets are also supported. + +#. :class:`~handlers.DatagramHandler` instances send messages to UDP + sockets. Since 3.4, Unix domain sockets are also supported. + +#. :class:`~handlers.SMTPHandler` instances send messages to a designated + email address. + +#. :class:`~handlers.SysLogHandler` instances send messages to a Unix + syslog daemon, possibly on a remote machine. + +#. :class:`~handlers.NTEventLogHandler` instances send messages to a + Windows NT/2000/XP event log. + +#. :class:`~handlers.MemoryHandler` instances send messages to a buffer + in memory, which is flushed whenever specific criteria are met. + +#. :class:`~handlers.HTTPHandler` instances send messages to an HTTP + server using either ``GET`` or ``POST`` semantics. + +#. :class:`~handlers.WatchedFileHandler` instances watch the file they are + logging to. If the file changes, it is closed and reopened using the file + name. This handler is only useful on Unix-like systems; Windows does not + support the underlying mechanism used. + +#. :class:`~handlers.QueueHandler` instances send messages to a queue, such as + those implemented in the :mod:`queue` or :mod:`multiprocessing` modules. + +#. :class:`NullHandler` instances do nothing with error messages. They are used + by library developers who want to use logging, but want to avoid the 'No + handlers could be found for logger XXX' message which can be displayed if + the library user has not configured logging. See :ref:`library-config` for + more information. + +.. versionadded:: 3.1 + The :class:`NullHandler` class. + +.. versionadded:: 3.2 + The :class:`~handlers.QueueHandler` class. + +The :class:`NullHandler`, :class:`StreamHandler` and :class:`FileHandler` +classes are defined in the core logging package. The other handlers are +defined in a sub-module, :mod:`logging.handlers`. (There is also another +sub-module, :mod:`logging.config`, for configuration functionality.) + +Logged messages are formatted for presentation through instances of the +:class:`Formatter` class. They are initialized with a format string suitable for +use with the % operator and a dictionary. + +For formatting multiple messages in a batch, instances of +:class:`~handlers.BufferingFormatter` can be used. In addition to the format +string (which is applied to each message in the batch), there is provision for +header and trailer format strings. + +When filtering based on logger level and/or handler level is not enough, +instances of :class:`Filter` can be added to both :class:`Logger` and +:class:`Handler` instances (through their :meth:`~Handler.addFilter` method). +Before deciding to process a message further, both loggers and handlers consult +all their filters for permission. If any filter returns a false value, the +message is not processed further. + +The basic :class:`Filter` functionality allows filtering by specific logger +name. If this feature is used, messages sent to the named logger and its +children are allowed through the filter, and all others dropped. + + +.. _logging-exceptions: + +Exceptions raised during logging +-------------------------------- + +The logging package is designed to swallow exceptions which occur while logging +in production. This is so that errors which occur while handling logging events +- such as logging misconfiguration, network or other similar errors - do not +cause the application using logging to terminate prematurely. + +:class:`SystemExit` and :class:`KeyboardInterrupt` exceptions are never +swallowed. Other exceptions which occur during the :meth:`~Handler.emit` method +of a :class:`Handler` subclass are passed to its :meth:`~Handler.handleError` +method. + +The default implementation of :meth:`~Handler.handleError` in :class:`Handler` +checks to see if a module-level variable, :data:`raiseExceptions`, is set. If +set, a traceback is printed to :data:`sys.stderr`. If not set, the exception is +swallowed. + +.. note:: The default value of :data:`raiseExceptions` is ``True``. This is + because during development, you typically want to be notified of any + exceptions that occur. It's advised that you set :data:`raiseExceptions` to + ``False`` for production usage. + +.. currentmodule:: logging + +.. _arbitrary-object-messages: + +Using arbitrary objects as messages +----------------------------------- + +In the preceding sections and examples, it has been assumed that the message +passed when logging the event is a string. However, this is not the only +possibility. You can pass an arbitrary object as a message, and its +:meth:`~object.__str__` method will be called when the logging system needs to +convert it to a string representation. In fact, if you want to, you can avoid +computing a string representation altogether - for example, the +:class:`~handlers.SocketHandler` emits an event by pickling it and sending it +over the wire. + + +Optimization +------------ + +Formatting of message arguments is deferred until it cannot be avoided. +However, computing the arguments passed to the logging method can also be +expensive, and you may want to avoid doing it if the logger will just throw +away your event. To decide what to do, you can call the +:meth:`~Logger.isEnabledFor` method which takes a level argument and returns +true if the event would be created by the Logger for that level of call. +You can write code like this:: + + if logger.isEnabledFor(logging.DEBUG): + logger.debug('Message with %s, %s', expensive_func1(), + expensive_func2()) + +so that if the logger's threshold is set above ``DEBUG``, the calls to +:func:`expensive_func1` and :func:`expensive_func2` are never made. + +.. note:: In some cases, :meth:`~Logger.isEnabledFor` can itself be more + expensive than you'd like (e.g. for deeply nested loggers where an explicit + level is only set high up in the logger hierarchy). In such cases (or if you + want to avoid calling a method in tight loops), you can cache the result of a + call to :meth:`~Logger.isEnabledFor` in a local or instance variable, and use + that instead of calling the method each time. Such a cached value would only + need to be recomputed when the logging configuration changes dynamically + while the application is running (which is not all that common). + +There are other optimizations which can be made for specific applications which +need more precise control over what logging information is collected. Here's a +list of things you can do to avoid processing during logging which you don't +need: + ++-----------------------------------------------+----------------------------------------+ +| What you don't want to collect | How to avoid collecting it | ++===============================================+========================================+ +| Information about where calls were made from. | Set ``logging._srcfile`` to ``None``. | +| | This avoids calling | +| | :func:`sys._getframe`, which may help | +| | to speed up your code in environments | +| | like PyPy (which can't speed up code | +| | that uses :func:`sys._getframe`), if | +| | and when PyPy supports Python 3.x. | ++-----------------------------------------------+----------------------------------------+ +| Threading information. | Set ``logging.logThreads`` to ``0``. | ++-----------------------------------------------+----------------------------------------+ +| Process information. | Set ``logging.logProcesses`` to ``0``. | ++-----------------------------------------------+----------------------------------------+ + +Also note that the core logging module only includes the basic handlers. If +you don't import :mod:`logging.handlers` and :mod:`logging.config`, they won't +take up any memory. + +.. seealso:: + + Module :mod:`logging` + API reference for the logging module. + + Module :mod:`logging.config` + Configuration API for the logging module. + + Module :mod:`logging.handlers` + Useful handlers included with the logging module. + + :ref:`A logging cookbook ` diff --git a/python-3.7.4-docs-html/_sources/howto/pyporting.rst.txt b/python-3.7.4-docs-html/_sources/howto/pyporting.rst.txt new file mode 100644 index 0000000..3be6bb3 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/howto/pyporting.rst.txt @@ -0,0 +1,452 @@ +.. _pyporting-howto: + +********************************* +Porting Python 2 Code to Python 3 +********************************* + +:author: Brett Cannon + +.. topic:: Abstract + + With Python 3 being the future of Python while Python 2 is still in active + use, it is good to have your project available for both major releases of + Python. This guide is meant to help you figure out how best to support both + Python 2 & 3 simultaneously. + + If you are looking to port an extension module instead of pure Python code, + please see :ref:`cporting-howto`. + + If you would like to read one core Python developer's take on why Python 3 + came into existence, you can read Nick Coghlan's `Python 3 Q & A`_ or + Brett Cannon's `Why Python 3 exists`_. + + For help with porting, you can email the python-porting_ mailing list with + questions. + +The Short Explanation +===================== + +To make your project be single-source Python 2/3 compatible, the basic steps +are: + +#. Only worry about supporting Python 2.7 +#. Make sure you have good test coverage (coverage.py_ can help; + ``pip install coverage``) +#. Learn the differences between Python 2 & 3 +#. Use Futurize_ (or Modernize_) to update your code (e.g. ``pip install future``) +#. Use Pylint_ to help make sure you don't regress on your Python 3 support + (``pip install pylint``) +#. Use caniusepython3_ to find out which of your dependencies are blocking your + use of Python 3 (``pip install caniusepython3``) +#. Once your dependencies are no longer blocking you, use continuous integration + to make sure you stay compatible with Python 2 & 3 (tox_ can help test + against multiple versions of Python; ``pip install tox``) +#. Consider using optional static type checking to make sure your type usage + works in both Python 2 & 3 (e.g. use mypy_ to check your typing under both + Python 2 & Python 3). + + +Details +======= + +A key point about supporting Python 2 & 3 simultaneously is that you can start +**today**! Even if your dependencies are not supporting Python 3 yet that does +not mean you can't modernize your code **now** to support Python 3. Most changes +required to support Python 3 lead to cleaner code using newer practices even in +Python 2 code. + +Another key point is that modernizing your Python 2 code to also support +Python 3 is largely automated for you. While you might have to make some API +decisions thanks to Python 3 clarifying text data versus binary data, the +lower-level work is now mostly done for you and thus can at least benefit from +the automated changes immediately. + +Keep those key points in mind while you read on about the details of porting +your code to support Python 2 & 3 simultaneously. + + +Drop support for Python 2.6 and older +------------------------------------- + +While you can make Python 2.5 work with Python 3, it is **much** easier if you +only have to work with Python 2.7. If dropping Python 2.5 is not an +option then the six_ project can help you support Python 2.5 & 3 simultaneously +(``pip install six``). Do realize, though, that nearly all the projects listed +in this HOWTO will not be available to you. + +If you are able to skip Python 2.5 and older, then the required changes +to your code should continue to look and feel like idiomatic Python code. At +worst you will have to use a function instead of a method in some instances or +have to import a function instead of using a built-in one, but otherwise the +overall transformation should not feel foreign to you. + +But you should aim for only supporting Python 2.7. Python 2.6 is no longer +freely supported and thus is not receiving bugfixes. This means **you** will have +to work around any issues you come across with Python 2.6. There are also some +tools mentioned in this HOWTO which do not support Python 2.6 (e.g., Pylint_), +and this will become more commonplace as time goes on. It will simply be easier +for you if you only support the versions of Python that you have to support. + + +Make sure you specify the proper version support in your ``setup.py`` file +-------------------------------------------------------------------------- + +In your ``setup.py`` file you should have the proper `trove classifier`_ +specifying what versions of Python you support. As your project does not support +Python 3 yet you should at least have +``Programming Language :: Python :: 2 :: Only`` specified. Ideally you should +also specify each major/minor version of Python that you do support, e.g. +``Programming Language :: Python :: 2.7``. + + +Have good test coverage +----------------------- + +Once you have your code supporting the oldest version of Python 2 you want it +to, you will want to make sure your test suite has good coverage. A good rule of +thumb is that if you want to be confident enough in your test suite that any +failures that appear after having tools rewrite your code are actual bugs in the +tools and not in your code. If you want a number to aim for, try to get over 80% +coverage (and don't feel bad if you find it hard to get better than 90% +coverage). If you don't already have a tool to measure test coverage then +coverage.py_ is recommended. + + +Learn the differences between Python 2 & 3 +------------------------------------------- + +Once you have your code well-tested you are ready to begin porting your code to +Python 3! But to fully understand how your code is going to change and what +you want to look out for while you code, you will want to learn what changes +Python 3 makes in terms of Python 2. Typically the two best ways of doing that +is reading the `"What's New"`_ doc for each release of Python 3 and the +`Porting to Python 3`_ book (which is free online). There is also a handy +`cheat sheet`_ from the Python-Future project. + + +Update your code +---------------- + +Once you feel like you know what is different in Python 3 compared to Python 2, +it's time to update your code! You have a choice between two tools in porting +your code automatically: Futurize_ and Modernize_. Which tool you choose will +depend on how much like Python 3 you want your code to be. Futurize_ does its +best to make Python 3 idioms and practices exist in Python 2, e.g. backporting +the ``bytes`` type from Python 3 so that you have semantic parity between the +major versions of Python. Modernize_, +on the other hand, is more conservative and targets a Python 2/3 subset of +Python, directly relying on six_ to help provide compatibility. As Python 3 is +the future, it might be best to consider Futurize to begin adjusting to any new +practices that Python 3 introduces which you are not accustomed to yet. + +Regardless of which tool you choose, they will update your code to run under +Python 3 while staying compatible with the version of Python 2 you started with. +Depending on how conservative you want to be, you may want to run the tool over +your test suite first and visually inspect the diff to make sure the +transformation is accurate. After you have transformed your test suite and +verified that all the tests still pass as expected, then you can transform your +application code knowing that any tests which fail is a translation failure. + +Unfortunately the tools can't automate everything to make your code work under +Python 3 and so there are a handful of things you will need to update manually +to get full Python 3 support (which of these steps are necessary vary between +the tools). Read the documentation for the tool you choose to use to see what it +fixes by default and what it can do optionally to know what will (not) be fixed +for you and what you may have to fix on your own (e.g. using ``io.open()`` over +the built-in ``open()`` function is off by default in Modernize). Luckily, +though, there are only a couple of things to watch out for which can be +considered large issues that may be hard to debug if not watched for. + + +Division +++++++++ + +In Python 3, ``5 / 2 == 2.5`` and not ``2``; all division between ``int`` values +result in a ``float``. This change has actually been planned since Python 2.2 +which was released in 2002. Since then users have been encouraged to add +``from __future__ import division`` to any and all files which use the ``/`` and +``//`` operators or to be running the interpreter with the ``-Q`` flag. If you +have not been doing this then you will need to go through your code and do two +things: + +#. Add ``from __future__ import division`` to your files +#. Update any division operator as necessary to either use ``//`` to use floor + division or continue using ``/`` and expect a float + +The reason that ``/`` isn't simply translated to ``//`` automatically is that if +an object defines a ``__truediv__`` method but not ``__floordiv__`` then your +code would begin to fail (e.g. a user-defined class that uses ``/`` to +signify some operation but not ``//`` for the same thing or at all). + + +Text versus binary data ++++++++++++++++++++++++ + +In Python 2 you could use the ``str`` type for both text and binary data. +Unfortunately this confluence of two different concepts could lead to brittle +code which sometimes worked for either kind of data, sometimes not. It also +could lead to confusing APIs if people didn't explicitly state that something +that accepted ``str`` accepted either text or binary data instead of one +specific type. This complicated the situation especially for anyone supporting +multiple languages as APIs wouldn't bother explicitly supporting ``unicode`` +when they claimed text data support. + +To make the distinction between text and binary data clearer and more +pronounced, Python 3 did what most languages created in the age of the internet +have done and made text and binary data distinct types that cannot blindly be +mixed together (Python predates widespread access to the internet). For any code +that deals only with text or only binary data, this separation doesn't pose an +issue. But for code that has to deal with both, it does mean you might have to +now care about when you are using text compared to binary data, which is why +this cannot be entirely automated. + +To start, you will need to decide which APIs take text and which take binary +(it is **highly** recommended you don't design APIs that can take both due to +the difficulty of keeping the code working; as stated earlier it is difficult to +do well). In Python 2 this means making sure the APIs that take text can work +with ``unicode`` and those that work with binary data work with the +``bytes`` type from Python 3 (which is a subset of ``str`` in Python 2 and acts +as an alias for ``bytes`` type in Python 2). Usually the biggest issue is +realizing which methods exist on which types in Python 2 & 3 simultaneously +(for text that's ``unicode`` in Python 2 and ``str`` in Python 3, for binary +that's ``str``/``bytes`` in Python 2 and ``bytes`` in Python 3). The following +table lists the **unique** methods of each data type across Python 2 & 3 +(e.g., the ``decode()`` method is usable on the equivalent binary data type in +either Python 2 or 3, but it can't be used by the textual data type consistently +between Python 2 and 3 because ``str`` in Python 3 doesn't have the method). Do +note that as of Python 3.5 the ``__mod__`` method was added to the bytes type. + +======================== ===================== +**Text data** **Binary data** +------------------------ --------------------- +\ decode +------------------------ --------------------- +encode +------------------------ --------------------- +format +------------------------ --------------------- +isdecimal +------------------------ --------------------- +isnumeric +======================== ===================== + +Making the distinction easier to handle can be accomplished by encoding and +decoding between binary data and text at the edge of your code. This means that +when you receive text in binary data, you should immediately decode it. And if +your code needs to send text as binary data then encode it as late as possible. +This allows your code to work with only text internally and thus eliminates +having to keep track of what type of data you are working with. + +The next issue is making sure you know whether the string literals in your code +represent text or binary data. You should add a ``b`` prefix to any +literal that presents binary data. For text you should add a ``u`` prefix to +the text literal. (there is a :mod:`__future__` import to force all unspecified +literals to be Unicode, but usage has shown it isn't as effective as adding a +``b`` or ``u`` prefix to all literals explicitly) + +As part of this dichotomy you also need to be careful about opening files. +Unless you have been working on Windows, there is a chance you have not always +bothered to add the ``b`` mode when opening a binary file (e.g., ``rb`` for +binary reading). Under Python 3, binary files and text files are clearly +distinct and mutually incompatible; see the :mod:`io` module for details. +Therefore, you **must** make a decision of whether a file will be used for +binary access (allowing binary data to be read and/or written) or textual access +(allowing text data to be read and/or written). You should also use :func:`io.open` +for opening files instead of the built-in :func:`open` function as the :mod:`io` +module is consistent from Python 2 to 3 while the built-in :func:`open` function +is not (in Python 3 it's actually :func:`io.open`). Do not bother with the +outdated practice of using :func:`codecs.open` as that's only necessary for +keeping compatibility with Python 2.5. + +The constructors of both ``str`` and ``bytes`` have different semantics for the +same arguments between Python 2 & 3. Passing an integer to ``bytes`` in Python 2 +will give you the string representation of the integer: ``bytes(3) == '3'``. +But in Python 3, an integer argument to ``bytes`` will give you a bytes object +as long as the integer specified, filled with null bytes: +``bytes(3) == b'\x00\x00\x00'``. A similar worry is necessary when passing a +bytes object to ``str``. In Python 2 you just get the bytes object back: +``str(b'3') == b'3'``. But in Python 3 you get the string representation of the +bytes object: ``str(b'3') == "b'3'"``. + +Finally, the indexing of binary data requires careful handling (slicing does +**not** require any special handling). In Python 2, +``b'123'[1] == b'2'`` while in Python 3 ``b'123'[1] == 50``. Because binary data +is simply a collection of binary numbers, Python 3 returns the integer value for +the byte you index on. But in Python 2 because ``bytes == str``, indexing +returns a one-item slice of bytes. The six_ project has a function +named ``six.indexbytes()`` which will return an integer like in Python 3: +``six.indexbytes(b'123', 1)``. + +To summarize: + +#. Decide which of your APIs take text and which take binary data +#. Make sure that your code that works with text also works with ``unicode`` and + code for binary data works with ``bytes`` in Python 2 (see the table above + for what methods you cannot use for each type) +#. Mark all binary literals with a ``b`` prefix, textual literals with a ``u`` + prefix +#. Decode binary data to text as soon as possible, encode text as binary data as + late as possible +#. Open files using :func:`io.open` and make sure to specify the ``b`` mode when + appropriate +#. Be careful when indexing into binary data + + +Use feature detection instead of version detection +++++++++++++++++++++++++++++++++++++++++++++++++++ + +Inevitably you will have code that has to choose what to do based on what +version of Python is running. The best way to do this is with feature detection +of whether the version of Python you're running under supports what you need. +If for some reason that doesn't work then you should make the version check be +against Python 2 and not Python 3. To help explain this, let's look at an +example. + +Let's pretend that you need access to a feature of importlib_ that +is available in Python's standard library since Python 3.3 and available for +Python 2 through importlib2_ on PyPI. You might be tempted to write code to +access e.g. the ``importlib.abc`` module by doing the following:: + + import sys + + if sys.version_info[0] == 3: + from importlib import abc + else: + from importlib2 import abc + +The problem with this code is what happens when Python 4 comes out? It would +be better to treat Python 2 as the exceptional case instead of Python 3 and +assume that future Python versions will be more compatible with Python 3 than +Python 2:: + + import sys + + if sys.version_info[0] > 2: + from importlib import abc + else: + from importlib2 import abc + +The best solution, though, is to do no version detection at all and instead rely +on feature detection. That avoids any potential issues of getting the version +detection wrong and helps keep you future-compatible:: + + try: + from importlib import abc + except ImportError: + from importlib2 import abc + + +Prevent compatibility regressions +--------------------------------- + +Once you have fully translated your code to be compatible with Python 3, you +will want to make sure your code doesn't regress and stop working under +Python 3. This is especially true if you have a dependency which is blocking you +from actually running under Python 3 at the moment. + +To help with staying compatible, any new modules you create should have +at least the following block of code at the top of it:: + + from __future__ import absolute_import + from __future__ import division + from __future__ import print_function + +You can also run Python 2 with the ``-3`` flag to be warned about various +compatibility issues your code triggers during execution. If you turn warnings +into errors with ``-Werror`` then you can make sure that you don't accidentally +miss a warning. + +You can also use the Pylint_ project and its ``--py3k`` flag to lint your code +to receive warnings when your code begins to deviate from Python 3 +compatibility. This also prevents you from having to run Modernize_ or Futurize_ +over your code regularly to catch compatibility regressions. This does require +you only support Python 2.7 and Python 3.4 or newer as that is Pylint's +minimum Python version support. + + +Check which dependencies block your transition +---------------------------------------------- + +**After** you have made your code compatible with Python 3 you should begin to +care about whether your dependencies have also been ported. The caniusepython3_ +project was created to help you determine which projects +-- directly or indirectly -- are blocking you from supporting Python 3. There +is both a command-line tool as well as a web interface at +https://caniusepython3.com. + +The project also provides code which you can integrate into your test suite so +that you will have a failing test when you no longer have dependencies blocking +you from using Python 3. This allows you to avoid having to manually check your +dependencies and to be notified quickly when you can start running on Python 3. + + +Update your ``setup.py`` file to denote Python 3 compatibility +-------------------------------------------------------------- + +Once your code works under Python 3, you should update the classifiers in +your ``setup.py`` to contain ``Programming Language :: Python :: 3`` and to not +specify sole Python 2 support. This will tell anyone using your code that you +support Python 2 **and** 3. Ideally you will also want to add classifiers for +each major/minor version of Python you now support. + + +Use continuous integration to stay compatible +--------------------------------------------- + +Once you are able to fully run under Python 3 you will want to make sure your +code always works under both Python 2 & 3. Probably the best tool for running +your tests under multiple Python interpreters is tox_. You can then integrate +tox with your continuous integration system so that you never accidentally break +Python 2 or 3 support. + +You may also want to use the ``-bb`` flag with the Python 3 interpreter to +trigger an exception when you are comparing bytes to strings or bytes to an int +(the latter is available starting in Python 3.5). By default type-differing +comparisons simply return ``False``, but if you made a mistake in your +separation of text/binary data handling or indexing on bytes you wouldn't easily +find the mistake. This flag will raise an exception when these kinds of +comparisons occur, making the mistake much easier to track down. + +And that's mostly it! At this point your code base is compatible with both +Python 2 and 3 simultaneously. Your testing will also be set up so that you +don't accidentally break Python 2 or 3 compatibility regardless of which version +you typically run your tests under while developing. + + +Consider using optional static type checking +-------------------------------------------- + +Another way to help port your code is to use a static type checker like +mypy_ or pytype_ on your code. These tools can be used to analyze your code as +if it's being run under Python 2, then you can run the tool a second time as if +your code is running under Python 3. By running a static type checker twice like +this you can discover if you're e.g. misusing binary data type in one version +of Python compared to another. If you add optional type hints to your code you +can also explicitly state whether your APIs use textual or binary data, helping +to make sure everything functions as expected in both versions of Python. + + +.. _2to3: https://docs.python.org/3/library/2to3.html +.. _caniusepython3: https://pypi.org/project/caniusepython3 +.. _cheat sheet: http://python-future.org/compatible_idioms.html +.. _coverage.py: https://pypi.org/project/coverage +.. _Futurize: http://python-future.org/automatic_conversion.html +.. _importlib: https://docs.python.org/3/library/importlib.html#module-importlib +.. _importlib2: https://pypi.org/project/importlib2 +.. _Modernize: https://python-modernize.readthedocs.io/ +.. _mypy: http://mypy-lang.org/ +.. _Porting to Python 3: http://python3porting.com/ +.. _Pylint: https://pypi.org/project/pylint + +.. _Python 3 Q & A: https://ncoghlan-devs-python-notes.readthedocs.io/en/latest/python3/questions_and_answers.html + +.. _pytype: https://github.com/google/pytype +.. _python-future: http://python-future.org/ +.. _python-porting: https://mail.python.org/mailman/listinfo/python-porting +.. _six: https://pypi.org/project/six +.. _tox: https://pypi.org/project/tox +.. _trove classifier: https://pypi.org/classifiers + +.. _"What's New": https://docs.python.org/3/whatsnew/index.html + +.. _Why Python 3 exists: https://snarky.ca/why-python-3-exists diff --git a/python-3.7.4-docs-html/_sources/howto/regex.rst.txt b/python-3.7.4-docs-html/_sources/howto/regex.rst.txt new file mode 100644 index 0000000..d385d99 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/howto/regex.rst.txt @@ -0,0 +1,1386 @@ +.. _regex-howto: + +**************************** + Regular Expression HOWTO +**************************** + +:Author: A.M. Kuchling + +.. TODO: + Document lookbehind assertions + Better way of displaying a RE, a string, and what it matches + Mention optional argument to match.groups() + Unicode (at least a reference) + + +.. topic:: Abstract + + This document is an introductory tutorial to using regular expressions in Python + with the :mod:`re` module. It provides a gentler introduction than the + corresponding section in the Library Reference. + + +Introduction +============ + +Regular expressions (called REs, or regexes, or regex patterns) are essentially +a tiny, highly specialized programming language embedded inside Python and made +available through the :mod:`re` module. Using this little language, you specify +the rules for the set of possible strings that you want to match; this set might +contain English sentences, or e-mail addresses, or TeX commands, or anything you +like. You can then ask questions such as "Does this string match the pattern?", +or "Is there a match for the pattern anywhere in this string?". You can also +use REs to modify a string or to split it apart in various ways. + +Regular expression patterns are compiled into a series of bytecodes which are +then executed by a matching engine written in C. For advanced use, it may be +necessary to pay careful attention to how the engine will execute a given RE, +and write the RE in a certain way in order to produce bytecode that runs faster. +Optimization isn't covered in this document, because it requires that you have a +good understanding of the matching engine's internals. + +The regular expression language is relatively small and restricted, so not all +possible string processing tasks can be done using regular expressions. There +are also tasks that *can* be done with regular expressions, but the expressions +turn out to be very complicated. In these cases, you may be better off writing +Python code to do the processing; while Python code will be slower than an +elaborate regular expression, it will also probably be more understandable. + + +Simple Patterns +=============== + +We'll start by learning about the simplest possible regular expressions. Since +regular expressions are used to operate on strings, we'll begin with the most +common task: matching characters. + +For a detailed explanation of the computer science underlying regular +expressions (deterministic and non-deterministic finite automata), you can refer +to almost any textbook on writing compilers. + + +Matching Characters +------------------- + +Most letters and characters will simply match themselves. For example, the +regular expression ``test`` will match the string ``test`` exactly. (You can +enable a case-insensitive mode that would let this RE match ``Test`` or ``TEST`` +as well; more about this later.) + +There are exceptions to this rule; some characters are special +:dfn:`metacharacters`, and don't match themselves. Instead, they signal that +some out-of-the-ordinary thing should be matched, or they affect other portions +of the RE by repeating them or changing their meaning. Much of this document is +devoted to discussing various metacharacters and what they do. + +Here's a complete list of the metacharacters; their meanings will be discussed +in the rest of this HOWTO. + +.. code-block:: none + + . ^ $ * + ? { } [ ] \ | ( ) + +The first metacharacters we'll look at are ``[`` and ``]``. They're used for +specifying a character class, which is a set of characters that you wish to +match. Characters can be listed individually, or a range of characters can be +indicated by giving two characters and separating them by a ``'-'``. For +example, ``[abc]`` will match any of the characters ``a``, ``b``, or ``c``; this +is the same as ``[a-c]``, which uses a range to express the same set of +characters. If you wanted to match only lowercase letters, your RE would be +``[a-z]``. + +Metacharacters are not active inside classes. For example, ``[akm$]`` will +match any of the characters ``'a'``, ``'k'``, ``'m'``, or ``'$'``; ``'$'`` is +usually a metacharacter, but inside a character class it's stripped of its +special nature. + +You can match the characters not listed within the class by :dfn:`complementing` +the set. This is indicated by including a ``'^'`` as the first character of the +class. For example, ``[^5]`` will match any character except ``'5'``. If the +caret appears elsewhere in a character class, it does not have special meaning. +For example: ``[5^]`` will match either a ``'5'`` or a ``'^'``. + +Perhaps the most important metacharacter is the backslash, ``\``. As in Python +string literals, the backslash can be followed by various characters to signal +various special sequences. It's also used to escape all the metacharacters so +you can still match them in patterns; for example, if you need to match a ``[`` +or ``\``, you can precede them with a backslash to remove their special +meaning: ``\[`` or ``\\``. + +Some of the special sequences beginning with ``'\'`` represent +predefined sets of characters that are often useful, such as the set +of digits, the set of letters, or the set of anything that isn't +whitespace. + +Let's take an example: ``\w`` matches any alphanumeric character. If +the regex pattern is expressed in bytes, this is equivalent to the +class ``[a-zA-Z0-9_]``. If the regex pattern is a string, ``\w`` will +match all the characters marked as letters in the Unicode database +provided by the :mod:`unicodedata` module. You can use the more +restricted definition of ``\w`` in a string pattern by supplying the +:const:`re.ASCII` flag when compiling the regular expression. + +The following list of special sequences isn't complete. For a complete +list of sequences and expanded class definitions for Unicode string +patterns, see the last part of :ref:`Regular Expression Syntax +` in the Standard Library reference. In general, the +Unicode versions match any character that's in the appropriate +category in the Unicode database. + +``\d`` + Matches any decimal digit; this is equivalent to the class ``[0-9]``. + +``\D`` + Matches any non-digit character; this is equivalent to the class ``[^0-9]``. + +``\s`` + Matches any whitespace character; this is equivalent to the class ``[ + \t\n\r\f\v]``. + +``\S`` + Matches any non-whitespace character; this is equivalent to the class ``[^ + \t\n\r\f\v]``. + +``\w`` + Matches any alphanumeric character; this is equivalent to the class + ``[a-zA-Z0-9_]``. + +``\W`` + Matches any non-alphanumeric character; this is equivalent to the class + ``[^a-zA-Z0-9_]``. + +These sequences can be included inside a character class. For example, +``[\s,.]`` is a character class that will match any whitespace character, or +``','`` or ``'.'``. + +The final metacharacter in this section is ``.``. It matches anything except a +newline character, and there's an alternate mode (:const:`re.DOTALL`) where it will +match even a newline. ``.`` is often used where you want to match "any +character". + + +Repeating Things +---------------- + +Being able to match varying sets of characters is the first thing regular +expressions can do that isn't already possible with the methods available on +strings. However, if that was the only additional capability of regexes, they +wouldn't be much of an advance. Another capability is that you can specify that +portions of the RE must be repeated a certain number of times. + +The first metacharacter for repeating things that we'll look at is ``*``. ``*`` +doesn't match the literal character ``'*'``; instead, it specifies that the +previous character can be matched zero or more times, instead of exactly once. + +For example, ``ca*t`` will match ``'ct'`` (0 ``'a'`` characters), ``'cat'`` (1 ``'a'``), +``'caaat'`` (3 ``'a'`` characters), and so forth. + +Repetitions such as ``*`` are :dfn:`greedy`; when repeating a RE, the matching +engine will try to repeat it as many times as possible. If later portions of the +pattern don't match, the matching engine will then back up and try again with +fewer repetitions. + +A step-by-step example will make this more obvious. Let's consider the +expression ``a[bcd]*b``. This matches the letter ``'a'``, zero or more letters +from the class ``[bcd]``, and finally ends with a ``'b'``. Now imagine matching +this RE against the string ``'abcbd'``. + ++------+-----------+---------------------------------+ +| Step | Matched | Explanation | ++======+===========+=================================+ +| 1 | ``a`` | The ``a`` in the RE matches. | ++------+-----------+---------------------------------+ +| 2 | ``abcbd`` | The engine matches ``[bcd]*``, | +| | | going as far as it can, which | +| | | is to the end of the string. | ++------+-----------+---------------------------------+ +| 3 | *Failure* | The engine tries to match | +| | | ``b``, but the current position | +| | | is at the end of the string, so | +| | | it fails. | ++------+-----------+---------------------------------+ +| 4 | ``abcb`` | Back up, so that ``[bcd]*`` | +| | | matches one less character. | ++------+-----------+---------------------------------+ +| 5 | *Failure* | Try ``b`` again, but the | +| | | current position is at the last | +| | | character, which is a ``'d'``. | ++------+-----------+---------------------------------+ +| 6 | ``abc`` | Back up again, so that | +| | | ``[bcd]*`` is only matching | +| | | ``bc``. | ++------+-----------+---------------------------------+ +| 6 | ``abcb`` | Try ``b`` again. This time | +| | | the character at the | +| | | current position is ``'b'``, so | +| | | it succeeds. | ++------+-----------+---------------------------------+ + +The end of the RE has now been reached, and it has matched ``'abcb'``. This +demonstrates how the matching engine goes as far as it can at first, and if no +match is found it will then progressively back up and retry the rest of the RE +again and again. It will back up until it has tried zero matches for +``[bcd]*``, and if that subsequently fails, the engine will conclude that the +string doesn't match the RE at all. + +Another repeating metacharacter is ``+``, which matches one or more times. Pay +careful attention to the difference between ``*`` and ``+``; ``*`` matches +*zero* or more times, so whatever's being repeated may not be present at all, +while ``+`` requires at least *one* occurrence. To use a similar example, +``ca+t`` will match ``'cat'`` (1 ``'a'``), ``'caaat'`` (3 ``'a'``\ s), but won't +match ``'ct'``. + +There are two more repeating qualifiers. The question mark character, ``?``, +matches either once or zero times; you can think of it as marking something as +being optional. For example, ``home-?brew`` matches either ``'homebrew'`` or +``'home-brew'``. + +The most complicated repeated qualifier is ``{m,n}``, where *m* and *n* are +decimal integers. This qualifier means there must be at least *m* repetitions, +and at most *n*. For example, ``a/{1,3}b`` will match ``'a/b'``, ``'a//b'``, and +``'a///b'``. It won't match ``'ab'``, which has no slashes, or ``'a////b'``, which +has four. + +You can omit either *m* or *n*; in that case, a reasonable value is assumed for +the missing value. Omitting *m* is interpreted as a lower limit of 0, while +omitting *n* results in an upper bound of infinity. + +Readers of a reductionist bent may notice that the three other qualifiers can +all be expressed using this notation. ``{0,}`` is the same as ``*``, ``{1,}`` +is equivalent to ``+``, and ``{0,1}`` is the same as ``?``. It's better to use +``*``, ``+``, or ``?`` when you can, simply because they're shorter and easier +to read. + + +Using Regular Expressions +========================= + +Now that we've looked at some simple regular expressions, how do we actually use +them in Python? The :mod:`re` module provides an interface to the regular +expression engine, allowing you to compile REs into objects and then perform +matches with them. + + +Compiling Regular Expressions +----------------------------- + +Regular expressions are compiled into pattern objects, which have +methods for various operations such as searching for pattern matches or +performing string substitutions. :: + + >>> import re + >>> p = re.compile('ab*') + >>> p + re.compile('ab*') + +:func:`re.compile` also accepts an optional *flags* argument, used to enable +various special features and syntax variations. We'll go over the available +settings later, but for now a single example will do:: + + >>> p = re.compile('ab*', re.IGNORECASE) + +The RE is passed to :func:`re.compile` as a string. REs are handled as strings +because regular expressions aren't part of the core Python language, and no +special syntax was created for expressing them. (There are applications that +don't need REs at all, so there's no need to bloat the language specification by +including them.) Instead, the :mod:`re` module is simply a C extension module +included with Python, just like the :mod:`socket` or :mod:`zlib` modules. + +Putting REs in strings keeps the Python language simpler, but has one +disadvantage which is the topic of the next section. + + +.. _the-backslash-plague: + +The Backslash Plague +-------------------- + +As stated earlier, regular expressions use the backslash character (``'\'``) to +indicate special forms or to allow special characters to be used without +invoking their special meaning. This conflicts with Python's usage of the same +character for the same purpose in string literals. + +Let's say you want to write a RE that matches the string ``\section``, which +might be found in a LaTeX file. To figure out what to write in the program +code, start with the desired string to be matched. Next, you must escape any +backslashes and other metacharacters by preceding them with a backslash, +resulting in the string ``\\section``. The resulting string that must be passed +to :func:`re.compile` must be ``\\section``. However, to express this as a +Python string literal, both backslashes must be escaped *again*. + ++-------------------+------------------------------------------+ +| Characters | Stage | ++===================+==========================================+ +| ``\section`` | Text string to be matched | ++-------------------+------------------------------------------+ +| ``\\section`` | Escaped backslash for :func:`re.compile` | ++-------------------+------------------------------------------+ +| ``"\\\\section"`` | Escaped backslashes for a string literal | ++-------------------+------------------------------------------+ + +In short, to match a literal backslash, one has to write ``'\\\\'`` as the RE +string, because the regular expression must be ``\\``, and each backslash must +be expressed as ``\\`` inside a regular Python string literal. In REs that +feature backslashes repeatedly, this leads to lots of repeated backslashes and +makes the resulting strings difficult to understand. + +The solution is to use Python's raw string notation for regular expressions; +backslashes are not handled in any special way in a string literal prefixed with +``'r'``, so ``r"\n"`` is a two-character string containing ``'\'`` and ``'n'``, +while ``"\n"`` is a one-character string containing a newline. Regular +expressions will often be written in Python code using this raw string notation. + +In addition, special escape sequences that are valid in regular expressions, +but not valid as Python string literals, now result in a +:exc:`DeprecationWarning` and will eventually become a :exc:`SyntaxError`, +which means the sequences will be invalid if raw string notation or escaping +the backslashes isn't used. + + ++-------------------+------------------+ +| Regular String | Raw string | ++===================+==================+ +| ``"ab*"`` | ``r"ab*"`` | ++-------------------+------------------+ +| ``"\\\\section"`` | ``r"\\section"`` | ++-------------------+------------------+ +| ``"\\w+\\s+\\1"`` | ``r"\w+\s+\1"`` | ++-------------------+------------------+ + + +Performing Matches +------------------ + +Once you have an object representing a compiled regular expression, what do you +do with it? Pattern objects have several methods and attributes. +Only the most significant ones will be covered here; consult the :mod:`re` docs +for a complete listing. + ++------------------+-----------------------------------------------+ +| Method/Attribute | Purpose | ++==================+===============================================+ +| ``match()`` | Determine if the RE matches at the beginning | +| | of the string. | ++------------------+-----------------------------------------------+ +| ``search()`` | Scan through a string, looking for any | +| | location where this RE matches. | ++------------------+-----------------------------------------------+ +| ``findall()`` | Find all substrings where the RE matches, and | +| | returns them as a list. | ++------------------+-----------------------------------------------+ +| ``finditer()`` | Find all substrings where the RE matches, and | +| | returns them as an :term:`iterator`. | ++------------------+-----------------------------------------------+ + +:meth:`~re.Pattern.match` and :meth:`~re.Pattern.search` return ``None`` if no match can be found. If +they're successful, a :ref:`match object ` instance is returned, +containing information about the match: where it starts and ends, the substring +it matched, and more. + +You can learn about this by interactively experimenting with the :mod:`re` +module. If you have :mod:`tkinter` available, you may also want to look at +:source:`Tools/demo/redemo.py`, a demonstration program included with the +Python distribution. It allows you to enter REs and strings, and displays +whether the RE matches or fails. :file:`redemo.py` can be quite useful when +trying to debug a complicated RE. + +This HOWTO uses the standard Python interpreter for its examples. First, run the +Python interpreter, import the :mod:`re` module, and compile a RE:: + + >>> import re + >>> p = re.compile('[a-z]+') + >>> p + re.compile('[a-z]+') + +Now, you can try matching various strings against the RE ``[a-z]+``. An empty +string shouldn't match at all, since ``+`` means 'one or more repetitions'. +:meth:`~re.Pattern.match` should return ``None`` in this case, which will cause the +interpreter to print no output. You can explicitly print the result of +:meth:`!match` to make this clear. :: + + >>> p.match("") + >>> print(p.match("")) + None + +Now, let's try it on a string that it should match, such as ``tempo``. In this +case, :meth:`~re.Pattern.match` will return a :ref:`match object `, so you +should store the result in a variable for later use. :: + + >>> m = p.match('tempo') + >>> m + + +Now you can query the :ref:`match object ` for information +about the matching string. Match object instances +also have several methods and attributes; the most important ones are: + ++------------------+--------------------------------------------+ +| Method/Attribute | Purpose | ++==================+============================================+ +| ``group()`` | Return the string matched by the RE | ++------------------+--------------------------------------------+ +| ``start()`` | Return the starting position of the match | ++------------------+--------------------------------------------+ +| ``end()`` | Return the ending position of the match | ++------------------+--------------------------------------------+ +| ``span()`` | Return a tuple containing the (start, end) | +| | positions of the match | ++------------------+--------------------------------------------+ + +Trying these methods will soon clarify their meaning:: + + >>> m.group() + 'tempo' + >>> m.start(), m.end() + (0, 5) + >>> m.span() + (0, 5) + +:meth:`~re.Match.group` returns the substring that was matched by the RE. :meth:`~re.Match.start` +and :meth:`~re.Match.end` return the starting and ending index of the match. :meth:`~re.Match.span` +returns both start and end indexes in a single tuple. Since the :meth:`~re.Pattern.match` +method only checks if the RE matches at the start of a string, :meth:`!start` +will always be zero. However, the :meth:`~re.Pattern.search` method of patterns +scans through the string, so the match may not start at zero in that +case. :: + + >>> print(p.match('::: message')) + None + >>> m = p.search('::: message'); print(m) + + >>> m.group() + 'message' + >>> m.span() + (4, 11) + +In actual programs, the most common style is to store the +:ref:`match object ` in a variable, and then check if it was +``None``. This usually looks like:: + + p = re.compile( ... ) + m = p.match( 'string goes here' ) + if m: + print('Match found: ', m.group()) + else: + print('No match') + +Two pattern methods return all of the matches for a pattern. +:meth:`~re.Pattern.findall` returns a list of matching strings:: + + >>> p = re.compile(r'\d+') + >>> p.findall('12 drummers drumming, 11 pipers piping, 10 lords a-leaping') + ['12', '11', '10'] + +The ``r`` prefix, making the literal a raw string literal, is needed in this +example because escape sequences in a normal "cooked" string literal that are +not recognized by Python, as opposed to regular expressions, now result in a +:exc:`DeprecationWarning` and will eventually become a :exc:`SyntaxError`. See +:ref:`the-backslash-plague`. + +:meth:`~re.Pattern.findall` has to create the entire list before it can be returned as the +result. The :meth:`~re.Pattern.finditer` method returns a sequence of +:ref:`match object ` instances as an :term:`iterator`:: + + >>> iterator = p.finditer('12 drummers drumming, 11 ... 10 ...') + >>> iterator #doctest: +ELLIPSIS + + >>> for match in iterator: + ... print(match.span()) + ... + (0, 2) + (22, 24) + (29, 31) + + +Module-Level Functions +---------------------- + +You don't have to create a pattern object and call its methods; the +:mod:`re` module also provides top-level functions called :func:`~re.match`, +:func:`~re.search`, :func:`~re.findall`, :func:`~re.sub`, and so forth. These functions +take the same arguments as the corresponding pattern method with +the RE string added as the first argument, and still return either ``None`` or a +:ref:`match object ` instance. :: + + >>> print(re.match(r'From\s+', 'Fromage amk')) + None + >>> re.match(r'From\s+', 'From amk Thu May 14 19:12:10 1998') #doctest: +ELLIPSIS + + +Under the hood, these functions simply create a pattern object for you +and call the appropriate method on it. They also store the compiled +object in a cache, so future calls using the same RE won't need to +parse the pattern again and again. + +Should you use these module-level functions, or should you get the +pattern and call its methods yourself? If you're accessing a regex +within a loop, pre-compiling it will save a few function calls. +Outside of loops, there's not much difference thanks to the internal +cache. + + +Compilation Flags +----------------- + +Compilation flags let you modify some aspects of how regular expressions work. +Flags are available in the :mod:`re` module under two names, a long name such as +:const:`IGNORECASE` and a short, one-letter form such as :const:`I`. (If you're +familiar with Perl's pattern modifiers, the one-letter forms use the same +letters; the short form of :const:`re.VERBOSE` is :const:`re.X`, for example.) +Multiple flags can be specified by bitwise OR-ing them; ``re.I | re.M`` sets +both the :const:`I` and :const:`M` flags, for example. + +Here's a table of the available flags, followed by a more detailed explanation +of each one. + ++---------------------------------+--------------------------------------------+ +| Flag | Meaning | ++=================================+============================================+ +| :const:`ASCII`, :const:`A` | Makes several escapes like ``\w``, ``\b``, | +| | ``\s`` and ``\d`` match only on ASCII | +| | characters with the respective property. | ++---------------------------------+--------------------------------------------+ +| :const:`DOTALL`, :const:`S` | Make ``.`` match any character, including | +| | newlines. | ++---------------------------------+--------------------------------------------+ +| :const:`IGNORECASE`, :const:`I` | Do case-insensitive matches. | ++---------------------------------+--------------------------------------------+ +| :const:`LOCALE`, :const:`L` | Do a locale-aware match. | ++---------------------------------+--------------------------------------------+ +| :const:`MULTILINE`, :const:`M` | Multi-line matching, affecting ``^`` and | +| | ``$``. | ++---------------------------------+--------------------------------------------+ +| :const:`VERBOSE`, :const:`X` | Enable verbose REs, which can be organized | +| (for 'extended') | more cleanly and understandably. | ++---------------------------------+--------------------------------------------+ + + +.. data:: I + IGNORECASE + :noindex: + + Perform case-insensitive matching; character class and literal strings will + match letters by ignoring case. For example, ``[A-Z]`` will match lowercase + letters, too. Full Unicode matching also works unless the :const:`ASCII` + flag is used to disable non-ASCII matches. When the Unicode patterns + ``[a-z]`` or ``[A-Z]`` are used in combination with the :const:`IGNORECASE` + flag, they will match the 52 ASCII letters and 4 additional non-ASCII + letters: 'İ' (U+0130, Latin capital letter I with dot above), 'ı' (U+0131, + Latin small letter dotless i), 'ſ' (U+017F, Latin small letter long s) and + 'K' (U+212A, Kelvin sign). ``Spam`` will match ``'Spam'``, ``'spam'``, + ``'spAM'``, or ``'ſpam'`` (the latter is matched only in Unicode mode). + This lowercasing doesn't take the current locale into account; + it will if you also set the :const:`LOCALE` flag. + + +.. data:: L + LOCALE + :noindex: + + Make ``\w``, ``\W``, ``\b``, ``\B`` and case-insensitive matching dependent + on the current locale instead of the Unicode database. + + Locales are a feature of the C library intended to help in writing programs + that take account of language differences. For example, if you're + processing encoded French text, you'd want to be able to write ``\w+`` to + match words, but ``\w`` only matches the character class ``[A-Za-z]`` in + bytes patterns; it won't match bytes corresponding to ``é`` or ``ç``. + If your system is configured properly and a French locale is selected, + certain C functions will tell the program that the byte corresponding to + ``é`` should also be considered a letter. + Setting the :const:`LOCALE` flag when compiling a regular expression will cause + the resulting compiled object to use these C functions for ``\w``; this is + slower, but also enables ``\w+`` to match French words as you'd expect. + The use of this flag is discouraged in Python 3 as the locale mechanism + is very unreliable, it only handles one "culture" at a time, and it only + works with 8-bit locales. Unicode matching is already enabled by default + in Python 3 for Unicode (str) patterns, and it is able to handle different + locales/languages. + + +.. data:: M + MULTILINE + :noindex: + + (``^`` and ``$`` haven't been explained yet; they'll be introduced in section + :ref:`more-metacharacters`.) + + Usually ``^`` matches only at the beginning of the string, and ``$`` matches + only at the end of the string and immediately before the newline (if any) at the + end of the string. When this flag is specified, ``^`` matches at the beginning + of the string and at the beginning of each line within the string, immediately + following each newline. Similarly, the ``$`` metacharacter matches either at + the end of the string and at the end of each line (immediately preceding each + newline). + + +.. data:: S + DOTALL + :noindex: + + Makes the ``'.'`` special character match any character at all, including a + newline; without this flag, ``'.'`` will match anything *except* a newline. + + +.. data:: A + ASCII + :noindex: + + Make ``\w``, ``\W``, ``\b``, ``\B``, ``\s`` and ``\S`` perform ASCII-only + matching instead of full Unicode matching. This is only meaningful for + Unicode patterns, and is ignored for byte patterns. + + +.. data:: X + VERBOSE + :noindex: + + This flag allows you to write regular expressions that are more readable by + granting you more flexibility in how you can format them. When this flag has + been specified, whitespace within the RE string is ignored, except when the + whitespace is in a character class or preceded by an unescaped backslash; this + lets you organize and indent the RE more clearly. This flag also lets you put + comments within a RE that will be ignored by the engine; comments are marked by + a ``'#'`` that's neither in a character class or preceded by an unescaped + backslash. + + For example, here's a RE that uses :const:`re.VERBOSE`; see how much easier it + is to read? :: + + charref = re.compile(r""" + &[#] # Start of a numeric entity reference + ( + 0[0-7]+ # Octal form + | [0-9]+ # Decimal form + | x[0-9a-fA-F]+ # Hexadecimal form + ) + ; # Trailing semicolon + """, re.VERBOSE) + + Without the verbose setting, the RE would look like this:: + + charref = re.compile("&#(0[0-7]+" + "|[0-9]+" + "|x[0-9a-fA-F]+);") + + In the above example, Python's automatic concatenation of string literals has + been used to break up the RE into smaller pieces, but it's still more difficult + to understand than the version using :const:`re.VERBOSE`. + + +More Pattern Power +================== + +So far we've only covered a part of the features of regular expressions. In +this section, we'll cover some new metacharacters, and how to use groups to +retrieve portions of the text that was matched. + + +.. _more-metacharacters: + +More Metacharacters +------------------- + +There are some metacharacters that we haven't covered yet. Most of them will be +covered in this section. + +Some of the remaining metacharacters to be discussed are :dfn:`zero-width +assertions`. They don't cause the engine to advance through the string; +instead, they consume no characters at all, and simply succeed or fail. For +example, ``\b`` is an assertion that the current position is located at a word +boundary; the position isn't changed by the ``\b`` at all. This means that +zero-width assertions should never be repeated, because if they match once at a +given location, they can obviously be matched an infinite number of times. + +``|`` + Alternation, or the "or" operator. If *A* and *B* are regular expressions, + ``A|B`` will match any string that matches either *A* or *B*. ``|`` has very + low precedence in order to make it work reasonably when you're alternating + multi-character strings. ``Crow|Servo`` will match either ``'Crow'`` or ``'Servo'``, + not ``'Cro'``, a ``'w'`` or an ``'S'``, and ``'ervo'``. + + To match a literal ``'|'``, use ``\|``, or enclose it inside a character class, + as in ``[|]``. + +``^`` + Matches at the beginning of lines. Unless the :const:`MULTILINE` flag has been + set, this will only match at the beginning of the string. In :const:`MULTILINE` + mode, this also matches immediately after each newline within the string. + + For example, if you wish to match the word ``From`` only at the beginning of a + line, the RE to use is ``^From``. :: + + >>> print(re.search('^From', 'From Here to Eternity')) #doctest: +ELLIPSIS + + >>> print(re.search('^From', 'Reciting From Memory')) + None + + To match a literal ``'^'``, use ``\^``. + +``$`` + Matches at the end of a line, which is defined as either the end of the string, + or any location followed by a newline character. :: + + >>> print(re.search('}$', '{block}')) #doctest: +ELLIPSIS + + >>> print(re.search('}$', '{block} ')) + None + >>> print(re.search('}$', '{block}\n')) #doctest: +ELLIPSIS + + + To match a literal ``'$'``, use ``\$`` or enclose it inside a character class, + as in ``[$]``. + +``\A`` + Matches only at the start of the string. When not in :const:`MULTILINE` mode, + ``\A`` and ``^`` are effectively the same. In :const:`MULTILINE` mode, they're + different: ``\A`` still matches only at the beginning of the string, but ``^`` + may match at any location inside the string that follows a newline character. + +``\Z`` + Matches only at the end of the string. + +``\b`` + Word boundary. This is a zero-width assertion that matches only at the + beginning or end of a word. A word is defined as a sequence of alphanumeric + characters, so the end of a word is indicated by whitespace or a + non-alphanumeric character. + + The following example matches ``class`` only when it's a complete word; it won't + match when it's contained inside another word. :: + + >>> p = re.compile(r'\bclass\b') + >>> print(p.search('no class at all')) + + >>> print(p.search('the declassified algorithm')) + None + >>> print(p.search('one subclass is')) + None + + There are two subtleties you should remember when using this special sequence. + First, this is the worst collision between Python's string literals and regular + expression sequences. In Python's string literals, ``\b`` is the backspace + character, ASCII value 8. If you're not using raw strings, then Python will + convert the ``\b`` to a backspace, and your RE won't match as you expect it to. + The following example looks the same as our previous RE, but omits the ``'r'`` + in front of the RE string. :: + + >>> p = re.compile('\bclass\b') + >>> print(p.search('no class at all')) + None + >>> print(p.search('\b' + 'class' + '\b')) + + + Second, inside a character class, where there's no use for this assertion, + ``\b`` represents the backspace character, for compatibility with Python's + string literals. + +``\B`` + Another zero-width assertion, this is the opposite of ``\b``, only matching when + the current position is not at a word boundary. + + +Grouping +-------- + +Frequently you need to obtain more information than just whether the RE matched +or not. Regular expressions are often used to dissect strings by writing a RE +divided into several subgroups which match different components of interest. +For example, an RFC-822 header line is divided into a header name and a value, +separated by a ``':'``, like this: + +.. code-block:: none + + From: author@example.com + User-Agent: Thunderbird 1.5.0.9 (X11/20061227) + MIME-Version: 1.0 + To: editor@example.com + +This can be handled by writing a regular expression which matches an entire +header line, and has one group which matches the header name, and another group +which matches the header's value. + +Groups are marked by the ``'('``, ``')'`` metacharacters. ``'('`` and ``')'`` +have much the same meaning as they do in mathematical expressions; they group +together the expressions contained inside them, and you can repeat the contents +of a group with a repeating qualifier, such as ``*``, ``+``, ``?``, or +``{m,n}``. For example, ``(ab)*`` will match zero or more repetitions of +``ab``. :: + + >>> p = re.compile('(ab)*') + >>> print(p.match('ababababab').span()) + (0, 10) + +Groups indicated with ``'('``, ``')'`` also capture the starting and ending +index of the text that they match; this can be retrieved by passing an argument +to :meth:`~re.Match.group`, :meth:`~re.Match.start`, :meth:`~re.Match.end`, and +:meth:`~re.Match.span`. Groups are +numbered starting with 0. Group 0 is always present; it's the whole RE, so +:ref:`match object ` methods all have group 0 as their default +argument. Later we'll see how to express groups that don't capture the span +of text that they match. :: + + >>> p = re.compile('(a)b') + >>> m = p.match('ab') + >>> m.group() + 'ab' + >>> m.group(0) + 'ab' + +Subgroups are numbered from left to right, from 1 upward. Groups can be nested; +to determine the number, just count the opening parenthesis characters, going +from left to right. :: + + >>> p = re.compile('(a(b)c)d') + >>> m = p.match('abcd') + >>> m.group(0) + 'abcd' + >>> m.group(1) + 'abc' + >>> m.group(2) + 'b' + +:meth:`~re.Match.group` can be passed multiple group numbers at a time, in which case it +will return a tuple containing the corresponding values for those groups. :: + + >>> m.group(2,1,2) + ('b', 'abc', 'b') + +The :meth:`~re.Match.groups` method returns a tuple containing the strings for all the +subgroups, from 1 up to however many there are. :: + + >>> m.groups() + ('abc', 'b') + +Backreferences in a pattern allow you to specify that the contents of an earlier +capturing group must also be found at the current location in the string. For +example, ``\1`` will succeed if the exact contents of group 1 can be found at +the current position, and fails otherwise. Remember that Python's string +literals also use a backslash followed by numbers to allow including arbitrary +characters in a string, so be sure to use a raw string when incorporating +backreferences in a RE. + +For example, the following RE detects doubled words in a string. :: + + >>> p = re.compile(r'\b(\w+)\s+\1\b') + >>> p.search('Paris in the the spring').group() + 'the the' + +Backreferences like this aren't often useful for just searching through a string +--- there are few text formats which repeat data in this way --- but you'll soon +find out that they're *very* useful when performing string substitutions. + + +Non-capturing and Named Groups +------------------------------ + +Elaborate REs may use many groups, both to capture substrings of interest, and +to group and structure the RE itself. In complex REs, it becomes difficult to +keep track of the group numbers. There are two features which help with this +problem. Both of them use a common syntax for regular expression extensions, so +we'll look at that first. + +Perl 5 is well known for its powerful additions to standard regular expressions. +For these new features the Perl developers couldn't choose new single-keystroke metacharacters +or new special sequences beginning with ``\`` without making Perl's regular +expressions confusingly different from standard REs. If they chose ``&`` as a +new metacharacter, for example, old expressions would be assuming that ``&`` was +a regular character and wouldn't have escaped it by writing ``\&`` or ``[&]``. + +The solution chosen by the Perl developers was to use ``(?...)`` as the +extension syntax. ``?`` immediately after a parenthesis was a syntax error +because the ``?`` would have nothing to repeat, so this didn't introduce any +compatibility problems. The characters immediately after the ``?`` indicate +what extension is being used, so ``(?=foo)`` is one thing (a positive lookahead +assertion) and ``(?:foo)`` is something else (a non-capturing group containing +the subexpression ``foo``). + +Python supports several of Perl's extensions and adds an extension +syntax to Perl's extension syntax. If the first character after the +question mark is a ``P``, you know that it's an extension that's +specific to Python. + +Now that we've looked at the general extension syntax, we can return +to the features that simplify working with groups in complex REs. + +Sometimes you'll want to use a group to denote a part of a regular expression, +but aren't interested in retrieving the group's contents. You can make this fact +explicit by using a non-capturing group: ``(?:...)``, where you can replace the +``...`` with any other regular expression. :: + + >>> m = re.match("([abc])+", "abc") + >>> m.groups() + ('c',) + >>> m = re.match("(?:[abc])+", "abc") + >>> m.groups() + () + +Except for the fact that you can't retrieve the contents of what the group +matched, a non-capturing group behaves exactly the same as a capturing group; +you can put anything inside it, repeat it with a repetition metacharacter such +as ``*``, and nest it within other groups (capturing or non-capturing). +``(?:...)`` is particularly useful when modifying an existing pattern, since you +can add new groups without changing how all the other groups are numbered. It +should be mentioned that there's no performance difference in searching between +capturing and non-capturing groups; neither form is any faster than the other. + +A more significant feature is named groups: instead of referring to them by +numbers, groups can be referenced by a name. + +The syntax for a named group is one of the Python-specific extensions: +``(?P...)``. *name* is, obviously, the name of the group. Named groups +behave exactly like capturing groups, and additionally associate a name +with a group. The :ref:`match object ` methods that deal with +capturing groups all accept either integers that refer to the group by number +or strings that contain the desired group's name. Named groups are still +given numbers, so you can retrieve information about a group in two ways:: + + >>> p = re.compile(r'(?P\b\w+\b)') + >>> m = p.search( '(((( Lots of punctuation )))' ) + >>> m.group('word') + 'Lots' + >>> m.group(1) + 'Lots' + +Named groups are handy because they let you use easily-remembered names, instead +of having to remember numbers. Here's an example RE from the :mod:`imaplib` +module:: + + InternalDate = re.compile(r'INTERNALDATE "' + r'(?P[ 123][0-9])-(?P[A-Z][a-z][a-z])-' + r'(?P[0-9][0-9][0-9][0-9])' + r' (?P[0-9][0-9]):(?P[0-9][0-9]):(?P[0-9][0-9])' + r' (?P[-+])(?P[0-9][0-9])(?P[0-9][0-9])' + r'"') + +It's obviously much easier to retrieve ``m.group('zonem')``, instead of having +to remember to retrieve group 9. + +The syntax for backreferences in an expression such as ``(...)\1`` refers to the +number of the group. There's naturally a variant that uses the group name +instead of the number. This is another Python extension: ``(?P=name)`` indicates +that the contents of the group called *name* should again be matched at the +current point. The regular expression for finding doubled words, +``\b(\w+)\s+\1\b`` can also be written as ``\b(?P\w+)\s+(?P=word)\b``:: + + >>> p = re.compile(r'\b(?P\w+)\s+(?P=word)\b') + >>> p.search('Paris in the the spring').group() + 'the the' + + +Lookahead Assertions +-------------------- + +Another zero-width assertion is the lookahead assertion. Lookahead assertions +are available in both positive and negative form, and look like this: + +``(?=...)`` + Positive lookahead assertion. This succeeds if the contained regular + expression, represented here by ``...``, successfully matches at the current + location, and fails otherwise. But, once the contained expression has been + tried, the matching engine doesn't advance at all; the rest of the pattern is + tried right where the assertion started. + +``(?!...)`` + Negative lookahead assertion. This is the opposite of the positive assertion; + it succeeds if the contained expression *doesn't* match at the current position + in the string. + +To make this concrete, let's look at a case where a lookahead is useful. +Consider a simple pattern to match a filename and split it apart into a base +name and an extension, separated by a ``.``. For example, in ``news.rc``, +``news`` is the base name, and ``rc`` is the filename's extension. + +The pattern to match this is quite simple: + +``.*[.].*$`` + +Notice that the ``.`` needs to be treated specially because it's a +metacharacter, so it's inside a character class to only match that +specific character. Also notice the trailing ``$``; this is added to +ensure that all the rest of the string must be included in the +extension. This regular expression matches ``foo.bar`` and +``autoexec.bat`` and ``sendmail.cf`` and ``printers.conf``. + +Now, consider complicating the problem a bit; what if you want to match +filenames where the extension is not ``bat``? Some incorrect attempts: + +``.*[.][^b].*$`` The first attempt above tries to exclude ``bat`` by requiring +that the first character of the extension is not a ``b``. This is wrong, +because the pattern also doesn't match ``foo.bar``. + +``.*[.]([^b]..|.[^a].|..[^t])$`` + +The expression gets messier when you try to patch up the first solution by +requiring one of the following cases to match: the first character of the +extension isn't ``b``; the second character isn't ``a``; or the third character +isn't ``t``. This accepts ``foo.bar`` and rejects ``autoexec.bat``, but it +requires a three-letter extension and won't accept a filename with a two-letter +extension such as ``sendmail.cf``. We'll complicate the pattern again in an +effort to fix it. + +``.*[.]([^b].?.?|.[^a]?.?|..?[^t]?)$`` + +In the third attempt, the second and third letters are all made optional in +order to allow matching extensions shorter than three characters, such as +``sendmail.cf``. + +The pattern's getting really complicated now, which makes it hard to read and +understand. Worse, if the problem changes and you want to exclude both ``bat`` +and ``exe`` as extensions, the pattern would get even more complicated and +confusing. + +A negative lookahead cuts through all this confusion: + +``.*[.](?!bat$)[^.]*$`` The negative lookahead means: if the expression ``bat`` +doesn't match at this point, try the rest of the pattern; if ``bat$`` does +match, the whole pattern will fail. The trailing ``$`` is required to ensure +that something like ``sample.batch``, where the extension only starts with +``bat``, will be allowed. The ``[^.]*`` makes sure that the pattern works +when there are multiple dots in the filename. + +Excluding another filename extension is now easy; simply add it as an +alternative inside the assertion. The following pattern excludes filenames that +end in either ``bat`` or ``exe``: + +``.*[.](?!bat$|exe$)[^.]*$`` + + +Modifying Strings +================= + +Up to this point, we've simply performed searches against a static string. +Regular expressions are also commonly used to modify strings in various ways, +using the following pattern methods: + ++------------------+-----------------------------------------------+ +| Method/Attribute | Purpose | ++==================+===============================================+ +| ``split()`` | Split the string into a list, splitting it | +| | wherever the RE matches | ++------------------+-----------------------------------------------+ +| ``sub()`` | Find all substrings where the RE matches, and | +| | replace them with a different string | ++------------------+-----------------------------------------------+ +| ``subn()`` | Does the same thing as :meth:`!sub`, but | +| | returns the new string and the number of | +| | replacements | ++------------------+-----------------------------------------------+ + + +Splitting Strings +----------------- + +The :meth:`~re.Pattern.split` method of a pattern splits a string apart +wherever the RE matches, returning a list of the pieces. It's similar to the +:meth:`~str.split` method of strings but provides much more generality in the +delimiters that you can split by; string :meth:`!split` only supports splitting by +whitespace or by a fixed string. As you'd expect, there's a module-level +:func:`re.split` function, too. + + +.. method:: .split(string [, maxsplit=0]) + :noindex: + + Split *string* by the matches of the regular expression. If capturing + parentheses are used in the RE, then their contents will also be returned as + part of the resulting list. If *maxsplit* is nonzero, at most *maxsplit* splits + are performed. + +You can limit the number of splits made, by passing a value for *maxsplit*. +When *maxsplit* is nonzero, at most *maxsplit* splits will be made, and the +remainder of the string is returned as the final element of the list. In the +following example, the delimiter is any sequence of non-alphanumeric characters. +:: + + >>> p = re.compile(r'\W+') + >>> p.split('This is a test, short and sweet, of split().') + ['This', 'is', 'a', 'test', 'short', 'and', 'sweet', 'of', 'split', ''] + >>> p.split('This is a test, short and sweet, of split().', 3) + ['This', 'is', 'a', 'test, short and sweet, of split().'] + +Sometimes you're not only interested in what the text between delimiters is, but +also need to know what the delimiter was. If capturing parentheses are used in +the RE, then their values are also returned as part of the list. Compare the +following calls:: + + >>> p = re.compile(r'\W+') + >>> p2 = re.compile(r'(\W+)') + >>> p.split('This... is a test.') + ['This', 'is', 'a', 'test', ''] + >>> p2.split('This... is a test.') + ['This', '... ', 'is', ' ', 'a', ' ', 'test', '.', ''] + +The module-level function :func:`re.split` adds the RE to be used as the first +argument, but is otherwise the same. :: + + >>> re.split(r'[\W]+', 'Words, words, words.') + ['Words', 'words', 'words', ''] + >>> re.split(r'([\W]+)', 'Words, words, words.') + ['Words', ', ', 'words', ', ', 'words', '.', ''] + >>> re.split(r'[\W]+', 'Words, words, words.', 1) + ['Words', 'words, words.'] + + +Search and Replace +------------------ + +Another common task is to find all the matches for a pattern, and replace them +with a different string. The :meth:`~re.Pattern.sub` method takes a replacement value, +which can be either a string or a function, and the string to be processed. + +.. method:: .sub(replacement, string[, count=0]) + :noindex: + + Returns the string obtained by replacing the leftmost non-overlapping + occurrences of the RE in *string* by the replacement *replacement*. If the + pattern isn't found, *string* is returned unchanged. + + The optional argument *count* is the maximum number of pattern occurrences to be + replaced; *count* must be a non-negative integer. The default value of 0 means + to replace all occurrences. + +Here's a simple example of using the :meth:`~re.Pattern.sub` method. It replaces colour +names with the word ``colour``:: + + >>> 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) + 'colour socks and red shoes' + +The :meth:`~re.Pattern.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') + ('colour socks and colour shoes', 2) + >>> 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 empty match. +:: + + >>> p = re.compile('x*') + >>> p.sub('-', 'abxd') + '-a-b--d-' + +If *replacement* is a string, any backslash escapes in it are processed. That +is, ``\n`` is converted to a single newline character, ``\r`` is converted to a +carriage return, and so forth. Unknown escapes such as ``\&`` are left alone. +Backreferences, such as ``\6``, are replaced with the substring matched by the +corresponding group in the RE. This lets you incorporate portions of the +original text in the resulting replacement string. + +This example matches the word ``section`` followed by a string enclosed in +``{``, ``}``, and changes ``section`` to ``subsection``:: + + >>> p = re.compile('section{ ( [^}]* ) }', re.VERBOSE) + >>> p.sub(r'subsection{\1}','section{First} section{second}') + 'subsection{First} subsection{second}' + +There's also a syntax for referring to named groups as defined by the +``(?P...)`` syntax. ``\g`` will use the substring matched by the +group named ``name``, and ``\g`` uses the corresponding group number. +``\g<2>`` is therefore equivalent to ``\2``, but isn't ambiguous in a +replacement string such as ``\g<2>0``. (``\20`` would be interpreted as a +reference to group 20, not a reference to group 2 followed by the literal +character ``'0'``.) The following substitutions are all equivalent, but use all +three variations of the replacement string. :: + + >>> p = re.compile('section{ (?P [^}]* ) }', re.VERBOSE) + >>> p.sub(r'subsection{\1}','section{First}') + 'subsection{First}' + >>> p.sub(r'subsection{\g<1>}','section{First}') + 'subsection{First}' + >>> p.sub(r'subsection{\g}','section{First}') + 'subsection{First}' + +*replacement* can also be a function, which gives you even more control. If +*replacement* is a function, the function is called for every non-overlapping +occurrence of *pattern*. On each call, the function is passed a +:ref:`match object ` argument for the match and can use this +information to compute the desired replacement string and return it. + +In the following example, the replacement function translates decimals into +hexadecimal:: + + >>> def hexrepl(match): + ... "Return the hex string for a decimal number" + ... value = int(match.group()) + ... return hex(value) + ... + >>> p = re.compile(r'\d+') + >>> p.sub(hexrepl, 'Call 65490 for printing, 49152 for user code.') + 'Call 0xffd2 for printing, 0xc000 for user code.' + +When using the module-level :func:`re.sub` function, the pattern is passed as +the first argument. The pattern may be provided as an object or as a string; if +you need to specify regular expression flags, you must either use a +pattern object as the first parameter, or use embedded modifiers in the +pattern string, e.g. ``sub("(?i)b+", "x", "bbbb BBBB")`` returns ``'x x'``. + + +Common Problems +=============== + +Regular expressions are a powerful tool for some applications, but in some ways +their behaviour isn't intuitive and at times they don't behave the way you may +expect them to. This section will point out some of the most common pitfalls. + + +Use String Methods +------------------ + +Sometimes using the :mod:`re` module is a mistake. If you're matching a fixed +string, or a single character class, and you're not using any :mod:`re` features +such as the :const:`~re.IGNORECASE` flag, then the full power of regular expressions +may not be required. Strings have several methods for performing operations with +fixed strings and they're usually much faster, because the implementation is a +single small C loop that's been optimized for the purpose, instead of the large, +more generalized regular expression engine. + +One example might be replacing a single fixed string with another one; for +example, you might replace ``word`` with ``deed``. :func:`re.sub` seems like the +function to use for this, but consider the :meth:`~str.replace` method. Note that +:meth:`!replace` will also replace ``word`` inside words, turning ``swordfish`` +into ``sdeedfish``, but the naive RE ``word`` would have done that, too. (To +avoid performing the substitution on parts of words, the pattern would have to +be ``\bword\b``, in order to require that ``word`` have a word boundary on +either side. This takes the job beyond :meth:`!replace`'s abilities.) + +Another common task is deleting every occurrence of a single character from a +string or replacing it with another single character. You might do this with +something like ``re.sub('\n', ' ', S)``, but :meth:`~str.translate` is capable of +doing both tasks and will be faster than any regular expression operation can +be. + +In short, before turning to the :mod:`re` module, consider whether your problem +can be solved with a faster and simpler string method. + + +match() versus search() +----------------------- + +The :func:`~re.match` function only checks if the RE matches at the beginning of the +string while :func:`~re.search` will scan forward through the string for a match. +It's important to keep this distinction in mind. Remember, :func:`!match` will +only report a successful match which will start at 0; if the match wouldn't +start at zero, :func:`!match` will *not* report it. :: + + >>> print(re.match('super', 'superstition').span()) + (0, 5) + >>> print(re.match('super', 'insuperable')) + None + +On the other hand, :func:`~re.search` will scan forward through the string, +reporting the first match it finds. :: + + >>> print(re.search('super', 'superstition').span()) + (0, 5) + >>> print(re.search('super', 'insuperable').span()) + (2, 7) + +Sometimes you'll be tempted to keep using :func:`re.match`, and just add ``.*`` +to the front of your RE. Resist this temptation and use :func:`re.search` +instead. The regular expression compiler does some analysis of REs in order to +speed up the process of looking for a match. One such analysis figures out what +the first character of a match must be; for example, a pattern starting with +``Crow`` must match starting with a ``'C'``. The analysis lets the engine +quickly scan through the string looking for the starting character, only trying +the full match if a ``'C'`` is found. + +Adding ``.*`` defeats this optimization, requiring scanning to the end of the +string and then backtracking to find a match for the rest of the RE. Use +:func:`re.search` instead. + + +Greedy versus Non-Greedy +------------------------ + +When repeating a regular expression, as in ``a*``, the resulting action is to +consume as much of the pattern as possible. This fact often bites you when +you're trying to match a pair of balanced delimiters, such as the angle brackets +surrounding an HTML tag. The naive pattern for matching a single HTML tag +doesn't work because of the greedy nature of ``.*``. :: + + >>> s = 'Title' + >>> len(s) + 32 + >>> print(re.match('<.*>', s).span()) + (0, 32) + >>> print(re.match('<.*>', s).group()) + Title + +The RE matches the ``'<'`` in ``''``, and the ``.*`` consumes the rest of +the string. There's still more left in the RE, though, and the ``>`` can't +match at the end of the string, so the regular expression engine has to +backtrack character by character until it finds a match for the ``>``. The +final match extends from the ``'<'`` in ``''`` to the ``'>'`` in +``''``, which isn't what you want. + +In this case, the solution is to use the non-greedy qualifiers ``*?``, ``+?``, +``??``, or ``{m,n}?``, which match as *little* text as possible. In the above +example, the ``'>'`` is tried immediately after the first ``'<'`` matches, and +when it fails, the engine advances a character at a time, retrying the ``'>'`` +at every step. This produces just the right result:: + + >>> print(re.match('<.*?>', s).group()) + + +(Note that parsing HTML or XML with regular expressions is painful. +Quick-and-dirty patterns will handle common cases, but HTML and XML have special +cases that will break the obvious regular expression; by the time you've written +a regular expression that handles all of the possible cases, the patterns will +be *very* complicated. Use an HTML or XML parser module for such tasks.) + + +Using re.VERBOSE +---------------- + +By now you've probably noticed that regular expressions are a very compact +notation, but they're not terribly readable. REs of moderate complexity can +become lengthy collections of backslashes, parentheses, and metacharacters, +making them difficult to read and understand. + +For such REs, specifying the :const:`re.VERBOSE` flag when compiling the regular +expression can be helpful, because it allows you to format the regular +expression more clearly. + +The ``re.VERBOSE`` flag has several effects. Whitespace in the regular +expression that *isn't* inside a character class is ignored. This means that an +expression such as ``dog | cat`` is equivalent to the less readable ``dog|cat``, +but ``[a b]`` will still match the characters ``'a'``, ``'b'``, or a space. In +addition, you can also put comments inside a RE; comments extend from a ``#`` +character to the next newline. When used with triple-quoted strings, this +enables REs to be formatted more neatly:: + + pat = re.compile(r""" + \s* # Skip leading whitespace + (?P
    [^:]+) # Header name + \s* : # Whitespace, and a colon + (?P.*?) # The header's value -- *? used to + # lose the following trailing whitespace + \s*$ # Trailing whitespace to end-of-line + """, re.VERBOSE) + +This is far more readable than:: + + pat = re.compile(r"\s*(?P
    [^:]+)\s*:(?P.*?)\s*$") + + +Feedback +======== + +Regular expressions are a complicated topic. Did this document help you +understand them? Were there parts that were unclear, or Problems you +encountered that weren't covered here? If so, please send suggestions for +improvements to the author. + +The most complete book on regular expressions is almost certainly Jeffrey +Friedl's Mastering Regular Expressions, published by O'Reilly. Unfortunately, +it exclusively concentrates on Perl and Java's flavours of regular expressions, +and doesn't contain any Python material at all, so it won't be useful as a +reference for programming in Python. (The first edition covered Python's +now-removed :mod:`!regex` module, which won't help you much.) Consider checking +it out from your library. diff --git a/python-3.7.4-docs-html/_sources/howto/sockets.rst.txt b/python-3.7.4-docs-html/_sources/howto/sockets.rst.txt new file mode 100644 index 0000000..bc71d85 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/howto/sockets.rst.txt @@ -0,0 +1,383 @@ +.. _socket-howto: + +**************************** + Socket Programming HOWTO +**************************** + +:Author: Gordon McMillan + + +.. topic:: Abstract + + Sockets are used nearly everywhere, but are one of the most severely + misunderstood technologies around. This is a 10,000 foot overview of sockets. + It's not really a tutorial - you'll still have work to do in getting things + operational. It doesn't cover the fine points (and there are a lot of them), but + I hope it will give you enough background to begin using them decently. + + +Sockets +======= + +I'm only going to talk about INET (i.e. IPv4) sockets, but they account for at least 99% of +the sockets in use. And I'll only talk about STREAM (i.e. TCP) sockets - unless you really +know what you're doing (in which case this HOWTO isn't for you!), you'll get +better behavior and performance from a STREAM socket than anything else. I will +try to clear up the mystery of what a socket is, as well as some hints on how to +work with blocking and non-blocking sockets. But I'll start by talking about +blocking sockets. You'll need to know how they work before dealing with +non-blocking sockets. + +Part of the trouble with understanding these things is that "socket" can mean a +number of subtly different things, depending on context. So first, let's make a +distinction between a "client" socket - an endpoint of a conversation, and a +"server" socket, which is more like a switchboard operator. The client +application (your browser, for example) uses "client" sockets exclusively; the +web server it's talking to uses both "server" sockets and "client" sockets. + + +History +------- + +Of the various forms of :abbr:`IPC (Inter Process Communication)`, +sockets are by far the most popular. On any given platform, there are +likely to be other forms of IPC that are faster, but for +cross-platform communication, sockets are about the only game in town. + +They were invented in Berkeley as part of the BSD flavor of Unix. They spread +like wildfire with the Internet. With good reason --- the combination of sockets +with INET makes talking to arbitrary machines around the world unbelievably easy +(at least compared to other schemes). + + +Creating a Socket +================= + +Roughly speaking, when you clicked on the link that brought you to this page, +your browser did something like the following:: + + # create an INET, STREAMing socket + s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + # now connect to the web server on port 80 - the normal http port + s.connect(("www.python.org", 80)) + +When the ``connect`` completes, the socket ``s`` can be used to send +in a request for the text of the page. The same socket will read the +reply, and then be destroyed. That's right, destroyed. Client sockets +are normally only used for one exchange (or a small set of sequential +exchanges). + +What happens in the web server is a bit more complex. First, the web server +creates a "server socket":: + + # create an INET, STREAMing socket + serversocket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + # bind the socket to a public host, and a well-known port + serversocket.bind((socket.gethostname(), 80)) + # become a server socket + serversocket.listen(5) + +A couple things to notice: we used ``socket.gethostname()`` so that the socket +would be visible to the outside world. If we had used ``s.bind(('localhost', +80))`` or ``s.bind(('127.0.0.1', 80))`` we would still have a "server" socket, +but one that was only visible within the same machine. ``s.bind(('', 80))`` +specifies that the socket is reachable by any address the machine happens to +have. + +A second thing to note: low number ports are usually reserved for "well known" +services (HTTP, SNMP etc). If you're playing around, use a nice high number (4 +digits). + +Finally, the argument to ``listen`` tells the socket library that we want it to +queue up as many as 5 connect requests (the normal max) before refusing outside +connections. If the rest of the code is written properly, that should be plenty. + +Now that we have a "server" socket, listening on port 80, we can enter the +mainloop of the web server:: + + while True: + # accept connections from outside + (clientsocket, address) = serversocket.accept() + # now do something with the clientsocket + # in this case, we'll pretend this is a threaded server + ct = client_thread(clientsocket) + ct.run() + +There's actually 3 general ways in which this loop could work - dispatching a +thread to handle ``clientsocket``, create a new process to handle +``clientsocket``, or restructure this app to use non-blocking sockets, and +multiplex between our "server" socket and any active ``clientsocket``\ s using +``select``. More about that later. The important thing to understand now is +this: this is *all* a "server" socket does. It doesn't send any data. It doesn't +receive any data. It just produces "client" sockets. Each ``clientsocket`` is +created in response to some *other* "client" socket doing a ``connect()`` to the +host and port we're bound to. As soon as we've created that ``clientsocket``, we +go back to listening for more connections. The two "clients" are free to chat it +up - they are using some dynamically allocated port which will be recycled when +the conversation ends. + + +IPC +--- + +If you need fast IPC between two processes on one machine, you should look into +pipes or shared memory. If you do decide to use AF_INET sockets, bind the +"server" socket to ``'localhost'``. On most platforms, this will take a +shortcut around a couple of layers of network code and be quite a bit faster. + +.. seealso:: + The :mod:`multiprocessing` integrates cross-platform IPC into a higher-level + API. + + +Using a Socket +============== + +The first thing to note, is that the web browser's "client" socket and the web +server's "client" socket are identical beasts. That is, this is a "peer to peer" +conversation. Or to put it another way, *as the designer, you will have to +decide what the rules of etiquette are for a conversation*. Normally, the +``connect``\ ing socket starts the conversation, by sending in a request, or +perhaps a signon. But that's a design decision - it's not a rule of sockets. + +Now there are two sets of verbs to use for communication. You can use ``send`` +and ``recv``, or you can transform your client socket into a file-like beast and +use ``read`` and ``write``. The latter is the way Java presents its sockets. +I'm not going to talk about it here, except to warn you that you need to use +``flush`` on sockets. These are buffered "files", and a common mistake is to +``write`` something, and then ``read`` for a reply. Without a ``flush`` in +there, you may wait forever for the reply, because the request may still be in +your output buffer. + +Now we come to the major stumbling block of sockets - ``send`` and ``recv`` operate +on the network buffers. They do not necessarily handle all the bytes you hand +them (or expect from them), because their major focus is handling the network +buffers. In general, they return when the associated network buffers have been +filled (``send``) or emptied (``recv``). They then tell you how many bytes they +handled. It is *your* responsibility to call them again until your message has +been completely dealt with. + +When a ``recv`` returns 0 bytes, it means the other side has closed (or is in +the process of closing) the connection. You will not receive any more data on +this connection. Ever. You may be able to send data successfully; I'll talk +more about this later. + +A protocol like HTTP uses a socket for only one transfer. The client sends a +request, then reads a reply. That's it. The socket is discarded. This means that +a client can detect the end of the reply by receiving 0 bytes. + +But if you plan to reuse your socket for further transfers, you need to realize +that *there is no* :abbr:`EOT (End of Transfer)` *on a socket.* I repeat: if a socket +``send`` or ``recv`` returns after handling 0 bytes, the connection has been +broken. If the connection has *not* been broken, you may wait on a ``recv`` +forever, because the socket will *not* tell you that there's nothing more to +read (for now). Now if you think about that a bit, you'll come to realize a +fundamental truth of sockets: *messages must either be fixed length* (yuck), *or +be delimited* (shrug), *or indicate how long they are* (much better), *or end by +shutting down the connection*. The choice is entirely yours, (but some ways are +righter than others). + +Assuming you don't want to end the connection, the simplest solution is a fixed +length message:: + + class MySocket: + """demonstration class only + - coded for clarity, not efficiency + """ + + def __init__(self, sock=None): + if sock is None: + self.sock = socket.socket( + socket.AF_INET, socket.SOCK_STREAM) + else: + self.sock = sock + + def connect(self, host, port): + self.sock.connect((host, port)) + + def mysend(self, msg): + totalsent = 0 + while totalsent < MSGLEN: + sent = self.sock.send(msg[totalsent:]) + if sent == 0: + raise RuntimeError("socket connection broken") + totalsent = totalsent + sent + + def myreceive(self): + chunks = [] + bytes_recd = 0 + while bytes_recd < MSGLEN: + chunk = self.sock.recv(min(MSGLEN - bytes_recd, 2048)) + if chunk == b'': + raise RuntimeError("socket connection broken") + chunks.append(chunk) + bytes_recd = bytes_recd + len(chunk) + return b''.join(chunks) + +The sending code here is usable for almost any messaging scheme - in Python you +send strings, and you can use ``len()`` to determine its length (even if it has +embedded ``\0`` characters). It's mostly the receiving code that gets more +complex. (And in C, it's not much worse, except you can't use ``strlen`` if the +message has embedded ``\0``\ s.) + +The easiest enhancement is to make the first character of the message an +indicator of message type, and have the type determine the length. Now you have +two ``recv``\ s - the first to get (at least) that first character so you can +look up the length, and the second in a loop to get the rest. If you decide to +go the delimited route, you'll be receiving in some arbitrary chunk size, (4096 +or 8192 is frequently a good match for network buffer sizes), and scanning what +you've received for a delimiter. + +One complication to be aware of: if your conversational protocol allows multiple +messages to be sent back to back (without some kind of reply), and you pass +``recv`` an arbitrary chunk size, you may end up reading the start of a +following message. You'll need to put that aside and hold onto it, until it's +needed. + +Prefixing the message with its length (say, as 5 numeric characters) gets more +complex, because (believe it or not), you may not get all 5 characters in one +``recv``. In playing around, you'll get away with it; but in high network loads, +your code will very quickly break unless you use two ``recv`` loops - the first +to determine the length, the second to get the data part of the message. Nasty. +This is also when you'll discover that ``send`` does not always manage to get +rid of everything in one pass. And despite having read this, you will eventually +get bit by it! + +In the interests of space, building your character, (and preserving my +competitive position), these enhancements are left as an exercise for the +reader. Lets move on to cleaning up. + + +Binary Data +----------- + +It is perfectly possible to send binary data over a socket. The major problem is +that not all machines use the same formats for binary data. For example, a +Motorola chip will represent a 16 bit integer with the value 1 as the two hex +bytes 00 01. Intel and DEC, however, are byte-reversed - that same 1 is 01 00. +Socket libraries have calls for converting 16 and 32 bit integers - ``ntohl, +htonl, ntohs, htons`` where "n" means *network* and "h" means *host*, "s" means +*short* and "l" means *long*. Where network order is host order, these do +nothing, but where the machine is byte-reversed, these swap the bytes around +appropriately. + +In these days of 32 bit machines, the ascii representation of binary data is +frequently smaller than the binary representation. That's because a surprising +amount of the time, all those longs have the value 0, or maybe 1. The string "0" +would be two bytes, while binary is four. Of course, this doesn't fit well with +fixed-length messages. Decisions, decisions. + + +Disconnecting +============= + +Strictly speaking, you're supposed to use ``shutdown`` on a socket before you +``close`` it. The ``shutdown`` is an advisory to the socket at the other end. +Depending on the argument you pass it, it can mean "I'm not going to send +anymore, but I'll still listen", or "I'm not listening, good riddance!". Most +socket libraries, however, are so used to programmers neglecting to use this +piece of etiquette that normally a ``close`` is the same as ``shutdown(); +close()``. So in most situations, an explicit ``shutdown`` is not needed. + +One way to use ``shutdown`` effectively is in an HTTP-like exchange. The client +sends a request and then does a ``shutdown(1)``. This tells the server "This +client is done sending, but can still receive." The server can detect "EOF" by +a receive of 0 bytes. It can assume it has the complete request. The server +sends a reply. If the ``send`` completes successfully then, indeed, the client +was still receiving. + +Python takes the automatic shutdown a step further, and says that when a socket +is garbage collected, it will automatically do a ``close`` if it's needed. But +relying on this is a very bad habit. If your socket just disappears without +doing a ``close``, the socket at the other end may hang indefinitely, thinking +you're just being slow. *Please* ``close`` your sockets when you're done. + + +When Sockets Die +---------------- + +Probably the worst thing about using blocking sockets is what happens when the +other side comes down hard (without doing a ``close``). Your socket is likely to +hang. TCP is a reliable protocol, and it will wait a long, long time +before giving up on a connection. If you're using threads, the entire thread is +essentially dead. There's not much you can do about it. As long as you aren't +doing something dumb, like holding a lock while doing a blocking read, the +thread isn't really consuming much in the way of resources. Do *not* try to kill +the thread - part of the reason that threads are more efficient than processes +is that they avoid the overhead associated with the automatic recycling of +resources. In other words, if you do manage to kill the thread, your whole +process is likely to be screwed up. + + +Non-blocking Sockets +==================== + +If you've understood the preceding, you already know most of what you need to +know about the mechanics of using sockets. You'll still use the same calls, in +much the same ways. It's just that, if you do it right, your app will be almost +inside-out. + +In Python, you use ``socket.setblocking(0)`` to make it non-blocking. In C, it's +more complex, (for one thing, you'll need to choose between the BSD flavor +``O_NONBLOCK`` and the almost indistinguishable Posix flavor ``O_NDELAY``, which +is completely different from ``TCP_NODELAY``), but it's the exact same idea. You +do this after creating the socket, but before using it. (Actually, if you're +nuts, you can switch back and forth.) + +The major mechanical difference is that ``send``, ``recv``, ``connect`` and +``accept`` can return without having done anything. You have (of course) a +number of choices. You can check return code and error codes and generally drive +yourself crazy. If you don't believe me, try it sometime. Your app will grow +large, buggy and suck CPU. So let's skip the brain-dead solutions and do it +right. + +Use ``select``. + +In C, coding ``select`` is fairly complex. In Python, it's a piece of cake, but +it's close enough to the C version that if you understand ``select`` in Python, +you'll have little trouble with it in C:: + + ready_to_read, ready_to_write, in_error = \ + select.select( + potential_readers, + potential_writers, + potential_errs, + timeout) + +You pass ``select`` three lists: the first contains all sockets that you might +want to try reading; the second all the sockets you might want to try writing +to, and the last (normally left empty) those that you want to check for errors. +You should note that a socket can go into more than one list. The ``select`` +call is blocking, but you can give it a timeout. This is generally a sensible +thing to do - give it a nice long timeout (say a minute) unless you have good +reason to do otherwise. + +In return, you will get three lists. They contain the sockets that are actually +readable, writable and in error. Each of these lists is a subset (possibly +empty) of the corresponding list you passed in. + +If a socket is in the output readable list, you can be +as-close-to-certain-as-we-ever-get-in-this-business that a ``recv`` on that +socket will return *something*. Same idea for the writable list. You'll be able +to send *something*. Maybe not all you want to, but *something* is better than +nothing. (Actually, any reasonably healthy socket will return as writable - it +just means outbound network buffer space is available.) + +If you have a "server" socket, put it in the potential_readers list. If it comes +out in the readable list, your ``accept`` will (almost certainly) work. If you +have created a new socket to ``connect`` to someone else, put it in the +potential_writers list. If it shows up in the writable list, you have a decent +chance that it has connected. + +Actually, ``select`` can be handy even with blocking sockets. It's one way of +determining whether you will block - the socket returns as readable when there's +something in the buffers. However, this still doesn't help with the problem of +determining whether the other end is done, or just busy with something else. + +**Portability alert**: On Unix, ``select`` works both with the sockets and +files. Don't try this on Windows. On Windows, ``select`` works with sockets +only. Also note that in C, many of the more advanced socket options are done +differently on Windows. In fact, on Windows I usually use threads (which work +very, very well) with my sockets. + + diff --git a/python-3.7.4-docs-html/_sources/howto/sorting.rst.txt b/python-3.7.4-docs-html/_sources/howto/sorting.rst.txt new file mode 100644 index 0000000..1280446 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/howto/sorting.rst.txt @@ -0,0 +1,293 @@ +.. _sortinghowto: + +Sorting HOW TO +************** + +:Author: Andrew Dalke and Raymond Hettinger +:Release: 0.1 + + +Python lists have a built-in :meth:`list.sort` method that modifies the list +in-place. There is also a :func:`sorted` built-in function that builds a new +sorted list from an iterable. + +In this document, we explore the various techniques for sorting data using Python. + + +Sorting Basics +============== + +A simple ascending sort is very easy: just call the :func:`sorted` function. It +returns a new sorted list:: + + >>> sorted([5, 2, 3, 1, 4]) + [1, 2, 3, 4, 5] + +You can also use the :meth:`list.sort` method. It modifies the list +in-place (and returns ``None`` to avoid confusion). Usually it's less convenient +than :func:`sorted` - but if you don't need the original list, it's slightly +more efficient. + + >>> a = [5, 2, 3, 1, 4] + >>> a.sort() + >>> a + [1, 2, 3, 4, 5] + +Another difference is that the :meth:`list.sort` method is only defined for +lists. In contrast, the :func:`sorted` function accepts any iterable. + + >>> sorted({1: 'D', 2: 'B', 3: 'B', 4: 'E', 5: 'A'}) + [1, 2, 3, 4, 5] + +Key Functions +============= + +Both :meth:`list.sort` and :func:`sorted` have a *key* parameter to specify a +function to be called on each list element prior to making comparisons. + +For example, here's a case-insensitive string comparison: + + >>> sorted("This is a test string from Andrew".split(), key=str.lower) + ['a', 'Andrew', 'from', 'is', 'string', 'test', 'This'] + +The value of the *key* parameter should be a function that takes a single argument +and returns a key to use for sorting purposes. This technique is fast because +the key function is called exactly once for each input record. + +A common pattern is to sort complex objects using some of the object's indices +as keys. For example: + + >>> student_tuples = [ + ... ('john', 'A', 15), + ... ('jane', 'B', 12), + ... ('dave', 'B', 10), + ... ] + >>> sorted(student_tuples, key=lambda student: student[2]) # sort by age + [('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)] + +The same technique works for objects with named attributes. For example: + + >>> class Student: + ... def __init__(self, name, grade, age): + ... self.name = name + ... self.grade = grade + ... self.age = age + ... def __repr__(self): + ... return repr((self.name, self.grade, self.age)) + + >>> student_objects = [ + ... Student('john', 'A', 15), + ... Student('jane', 'B', 12), + ... Student('dave', 'B', 10), + ... ] + >>> sorted(student_objects, key=lambda student: student.age) # sort by age + [('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)] + +Operator Module Functions +========================= + +The key-function patterns shown above are very common, so Python provides +convenience functions to make accessor functions easier and faster. The +:mod:`operator` module has :func:`~operator.itemgetter`, +:func:`~operator.attrgetter`, and a :func:`~operator.methodcaller` function. + +Using those functions, the above examples become simpler and faster: + + >>> from operator import itemgetter, attrgetter + + >>> sorted(student_tuples, key=itemgetter(2)) + [('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)] + + >>> sorted(student_objects, key=attrgetter('age')) + [('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)] + +The operator module functions allow multiple levels of sorting. For example, to +sort by *grade* then by *age*: + + >>> sorted(student_tuples, key=itemgetter(1,2)) + [('john', 'A', 15), ('dave', 'B', 10), ('jane', 'B', 12)] + + >>> sorted(student_objects, key=attrgetter('grade', 'age')) + [('john', 'A', 15), ('dave', 'B', 10), ('jane', 'B', 12)] + +Ascending and Descending +======================== + +Both :meth:`list.sort` and :func:`sorted` accept a *reverse* parameter with a +boolean value. This is used to flag descending sorts. For example, to get the +student data in reverse *age* order: + + >>> sorted(student_tuples, key=itemgetter(2), reverse=True) + [('john', 'A', 15), ('jane', 'B', 12), ('dave', 'B', 10)] + + >>> sorted(student_objects, key=attrgetter('age'), reverse=True) + [('john', 'A', 15), ('jane', 'B', 12), ('dave', 'B', 10)] + +Sort Stability and Complex Sorts +================================ + +Sorts are guaranteed to be `stable +`_\. That means that +when multiple records have the same key, their original order is preserved. + + >>> data = [('red', 1), ('blue', 1), ('red', 2), ('blue', 2)] + >>> sorted(data, key=itemgetter(0)) + [('blue', 1), ('blue', 2), ('red', 1), ('red', 2)] + +Notice how the two records for *blue* retain their original order so that +``('blue', 1)`` is guaranteed to precede ``('blue', 2)``. + +This wonderful property lets you build complex sorts in a series of sorting +steps. For example, to sort the student data by descending *grade* and then +ascending *age*, do the *age* sort first and then sort again using *grade*: + + >>> s = sorted(student_objects, key=attrgetter('age')) # sort on secondary key + >>> sorted(s, key=attrgetter('grade'), reverse=True) # now sort on primary key, descending + [('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)] + +The `Timsort `_ algorithm used in Python +does multiple sorts efficiently because it can take advantage of any ordering +already present in a dataset. + +The Old Way Using Decorate-Sort-Undecorate +========================================== + +This idiom is called Decorate-Sort-Undecorate after its three steps: + +* First, the initial list is decorated with new values that control the sort order. + +* Second, the decorated list is sorted. + +* Finally, the decorations are removed, creating a list that contains only the + initial values in the new order. + +For example, to sort the student data by *grade* using the DSU approach: + + >>> decorated = [(student.grade, i, student) for i, student in enumerate(student_objects)] + >>> decorated.sort() + >>> [student for grade, i, student in decorated] # undecorate + [('john', 'A', 15), ('jane', 'B', 12), ('dave', 'B', 10)] + +This idiom works because tuples are compared lexicographically; the first items +are compared; if they are the same then the second items are compared, and so +on. + +It is not strictly necessary in all cases to include the index *i* in the +decorated list, but including it gives two benefits: + +* The sort is stable -- if two items have the same key, their order will be + preserved in the sorted list. + +* The original items do not have to be comparable because the ordering of the + decorated tuples will be determined by at most the first two items. So for + example the original list could contain complex numbers which cannot be sorted + directly. + +Another name for this idiom is +`Schwartzian transform `_\, +after Randal L. Schwartz, who popularized it among Perl programmers. + +Now that Python sorting provides key-functions, this technique is not often needed. + + +The Old Way Using the *cmp* Parameter +===================================== + +Many constructs given in this HOWTO assume Python 2.4 or later. Before that, +there was no :func:`sorted` builtin and :meth:`list.sort` took no keyword +arguments. Instead, all of the Py2.x versions supported a *cmp* parameter to +handle user specified comparison functions. + +In Py3.0, the *cmp* parameter was removed entirely (as part of a larger effort to +simplify and unify the language, eliminating the conflict between rich +comparisons and the :meth:`__cmp__` magic method). + +In Py2.x, sort allowed an optional function which can be called for doing the +comparisons. That function should take two arguments to be compared and then +return a negative value for less-than, return zero if they are equal, or return +a positive value for greater-than. For example, we can do: + + >>> def numeric_compare(x, y): + ... return x - y + >>> sorted([5, 2, 4, 1, 3], cmp=numeric_compare) # doctest: +SKIP + [1, 2, 3, 4, 5] + +Or you can reverse the order of comparison with: + + >>> def reverse_numeric(x, y): + ... return y - x + >>> sorted([5, 2, 4, 1, 3], cmp=reverse_numeric) # doctest: +SKIP + [5, 4, 3, 2, 1] + +When porting code from Python 2.x to 3.x, the situation can arise when you have +the user supplying a comparison function and you need to convert that to a key +function. The following wrapper makes that easy to do:: + + def cmp_to_key(mycmp): + 'Convert a cmp= function into a key= function' + class K: + def __init__(self, obj, *args): + self.obj = obj + def __lt__(self, other): + return mycmp(self.obj, other.obj) < 0 + def __gt__(self, other): + return mycmp(self.obj, other.obj) > 0 + def __eq__(self, other): + return mycmp(self.obj, other.obj) == 0 + def __le__(self, other): + return mycmp(self.obj, other.obj) <= 0 + def __ge__(self, other): + return mycmp(self.obj, other.obj) >= 0 + def __ne__(self, other): + return mycmp(self.obj, other.obj) != 0 + return K + +To convert to a key function, just wrap the old comparison function: + +.. testsetup:: + + from functools import cmp_to_key + +.. doctest:: + + >>> sorted([5, 2, 4, 1, 3], key=cmp_to_key(reverse_numeric)) + [5, 4, 3, 2, 1] + +In Python 3.2, the :func:`functools.cmp_to_key` function was added to the +:mod:`functools` module in the standard library. + +Odd and Ends +============ + +* For locale aware sorting, use :func:`locale.strxfrm` for a key function or + :func:`locale.strcoll` for a comparison function. + +* The *reverse* parameter still maintains sort stability (so that records with + equal keys retain the original order). Interestingly, that effect can be + simulated without the parameter by using the builtin :func:`reversed` function + twice: + + >>> data = [('red', 1), ('blue', 1), ('red', 2), ('blue', 2)] + >>> standard_way = sorted(data, key=itemgetter(0), reverse=True) + >>> double_reversed = list(reversed(sorted(reversed(data), key=itemgetter(0)))) + >>> assert standard_way == double_reversed + >>> standard_way + [('red', 1), ('red', 2), ('blue', 1), ('blue', 2)] + +* The sort routines are guaranteed to use :meth:`__lt__` when making comparisons + between two objects. So, it is easy to add a standard sort order to a class by + defining an :meth:`__lt__` method:: + + >>> Student.__lt__ = lambda self, other: self.age < other.age + >>> sorted(student_objects) + [('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)] + +* Key functions need not depend directly on the objects being sorted. A key + function can also access external resources. For instance, if the student grades + are stored in a dictionary, they can be used to sort a separate list of student + names: + + >>> students = ['dave', 'john', 'jane'] + >>> newgrades = {'john': 'F', 'jane':'A', 'dave': 'C'} + >>> sorted(students, key=newgrades.__getitem__) + ['jane', 'dave', 'john'] diff --git a/python-3.7.4-docs-html/_sources/howto/unicode.rst.txt b/python-3.7.4-docs-html/_sources/howto/unicode.rst.txt new file mode 100644 index 0000000..d4b1b2a --- /dev/null +++ b/python-3.7.4-docs-html/_sources/howto/unicode.rst.txt @@ -0,0 +1,763 @@ +.. _unicode-howto: + +***************** + Unicode HOWTO +***************** + +:Release: 1.12 + +This HOWTO discusses Python's support for the Unicode specification +for representing textual data, and explains various problems that +people commonly encounter when trying to work with Unicode. + + +Introduction to Unicode +======================= + +Definitions +----------- + +Today's programs need to be able to handle a wide variety of +characters. Applications are often internationalized to display +messages and output in a variety of user-selectable languages; the +same program might need to output an error message in English, French, +Japanese, Hebrew, or Russian. Web content can be written in any of +these languages and can also include a variety of emoji symbols. +Python's string type uses the Unicode Standard for representing +characters, which lets Python programs work with all these different +possible characters. + +Unicode (https://www.unicode.org/) is a specification that aims to +list every character used by human languages and give each character +its own unique code. The Unicode specifications are continually +revised and updated to add new languages and symbols. + +A **character** is the smallest possible component of a text. 'A', 'B', 'C', +etc., are all different characters. So are 'È' and 'Í'. Characters vary +depending on the language or context you're talking +about. For example, there's a character for "Roman Numeral One", 'Ⅰ', that's +separate from the uppercase letter 'I'. They'll usually look the same, +but these are two different characters that have different meanings. + +The Unicode standard describes how characters are represented by +**code points**. A code point value is an integer in the range 0 to +0x10FFFF (about 1.1 million values, with some 110 thousand assigned so +far). In the standard and in this document, a code point is written +using the notation ``U+265E`` to mean the character with value +``0x265e`` (9,822 in decimal). + +The Unicode standard contains a lot of tables listing characters and +their corresponding code points: + +.. code-block:: none + + 0061 'a'; LATIN SMALL LETTER A + 0062 'b'; LATIN SMALL LETTER B + 0063 'c'; LATIN SMALL LETTER C + ... + 007B '{'; LEFT CURLY BRACKET + ... + 2167 'Ⅶ': ROMAN NUMERAL EIGHT + 2168 'Ⅸ': ROMAN NUMERAL NINE + ... + 265E '♞': BLACK CHESS KNIGHT + 265F '♟': BLACK CHESS PAWN + ... + 1F600 '😀': GRINNING FACE + 1F609 '😉': WINKING FACE + ... + +Strictly, these definitions imply that it's meaningless to say 'this is +character ``U+265E``'. ``U+265E`` is a code point, which represents some particular +character; in this case, it represents the character 'BLACK CHESS KNIGHT', +'♞'. In +informal contexts, this distinction between code points and characters will +sometimes be forgotten. + +A character is represented on a screen or on paper by a set of graphical +elements that's called a **glyph**. The glyph for an uppercase A, for example, +is two diagonal strokes and a horizontal stroke, though the exact details will +depend on the font being used. Most Python code doesn't need to worry about +glyphs; figuring out the correct glyph to display is generally the job of a GUI +toolkit or a terminal's font renderer. + + +Encodings +--------- + +To summarize the previous section: a Unicode string is a sequence of +code points, which are numbers from 0 through ``0x10FFFF`` (1,114,111 +decimal). This sequence of code points needs to be represented in +memory as a set of **code units**, and **code units** are then mapped +to 8-bit bytes. The rules for translating a Unicode string into a +sequence of bytes are called a **character encoding**, or just +an **encoding**. + +The first encoding you might think of is using 32-bit integers as the +code unit, and then using the CPU's representation of 32-bit integers. +In this representation, the string "Python" might look like this: + +.. code-block:: none + + P y t h o n + 0x50 00 00 00 79 00 00 00 74 00 00 00 68 00 00 00 6f 00 00 00 6e 00 00 00 + 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 + +This representation is straightforward but using it presents a number of +problems. + +1. It's not portable; different processors order the bytes differently. + +2. It's very wasteful of space. In most texts, the majority of the code points + are less than 127, or less than 255, so a lot of space is occupied by ``0x00`` + bytes. The above string takes 24 bytes compared to the 6 bytes needed for an + ASCII representation. Increased RAM usage doesn't matter too much (desktop + computers have gigabytes of RAM, and strings aren't usually that large), but + expanding our usage of disk and network bandwidth by a factor of 4 is + intolerable. + +3. It's not compatible with existing C functions such as ``strlen()``, so a new + family of wide string functions would need to be used. + +Therefore this encoding isn't used very much, and people instead choose other +encodings that are more efficient and convenient, such as UTF-8. + +UTF-8 is one of the most commonly used encodings, and Python often +defaults to using it. UTF stands for "Unicode Transformation Format", +and the '8' means that 8-bit values are used in the encoding. (There +are also UTF-16 and UTF-32 encodings, but they are less frequently +used than UTF-8.) UTF-8 uses the following rules: + +1. If the code point is < 128, it's represented by the corresponding byte value. +2. If the code point is >= 128, it's turned into a sequence of two, three, or + four bytes, where each byte of the sequence is between 128 and 255. + +UTF-8 has several convenient properties: + +1. It can handle any Unicode code point. +2. A Unicode string is turned into a sequence of bytes that contains embedded + zero bytes only where they represent the null character (U+0000). This means + that UTF-8 strings can be processed by C functions such as ``strcpy()`` and sent + through protocols that can't handle zero bytes for anything other than + end-of-string markers. +3. A string of ASCII text is also valid UTF-8 text. +4. UTF-8 is fairly compact; the majority of commonly used characters can be + represented with one or two bytes. +5. If bytes are corrupted or lost, it's possible to determine the start of the + next UTF-8-encoded code point and resynchronize. It's also unlikely that + random 8-bit data will look like valid UTF-8. +6. UTF-8 is a byte oriented encoding. The encoding specifies that each + character is represented by a specific sequence of one or more bytes. This + avoids the byte-ordering issues that can occur with integer and word oriented + encodings, like UTF-16 and UTF-32, where the sequence of bytes varies depending + on the hardware on which the string was encoded. + + +References +---------- + +The `Unicode Consortium site `_ has character charts, a +glossary, and PDF versions of the Unicode specification. Be prepared for some +difficult reading. `A chronology `_ of the +origin and development of Unicode is also available on the site. + +On the Computerphile Youtube channel, Tom Scott briefly +`discusses the history of Unicode and UTF-8 ` +(9 minutes 36 seconds). + +To help understand the standard, Jukka Korpela has written `an introductory +guide `_ to reading the +Unicode character tables. + +Another `good introductory article `_ +was written by Joel Spolsky. +If this introduction didn't make things clear to you, you should try +reading this alternate article before continuing. + +Wikipedia entries are often helpful; see the entries for "`character encoding +`_" and `UTF-8 +`_, for example. + + +Python's Unicode Support +======================== + +Now that you've learned the rudiments of Unicode, we can look at Python's +Unicode features. + +The String Type +--------------- + +Since Python 3.0, the language's :class:`str` type contains Unicode +characters, meaning any string created using ``"unicode rocks!"``, ``'unicode +rocks!'``, or the triple-quoted string syntax is stored as Unicode. + +The default encoding for Python source code is UTF-8, so you can simply +include a Unicode character in a string literal:: + + try: + with open('/tmp/input.txt', 'r') as f: + ... + except OSError: + # 'File not found' error message. + print("Fichier non trouvé") + +Side note: Python 3 also supports using Unicode characters in identifiers:: + + répertoire = "/tmp/records.log" + with open(répertoire, "w") as f: + f.write("test\n") + +If you can't enter a particular character in your editor or want to +keep the source code ASCII-only for some reason, you can also use +escape sequences in string literals. (Depending on your system, +you may see the actual capital-delta glyph instead of a \u escape.) :: + + >>> "\N{GREEK CAPITAL LETTER DELTA}" # Using the character name + '\u0394' + >>> "\u0394" # Using a 16-bit hex value + '\u0394' + >>> "\U00000394" # Using a 32-bit hex value + '\u0394' + +In addition, one can create a string using the :func:`~bytes.decode` method of +:class:`bytes`. This method takes an *encoding* argument, such as ``UTF-8``, +and optionally an *errors* argument. + +The *errors* argument specifies the response when the input string can't be +converted according to the encoding's rules. Legal values for this argument are +``'strict'`` (raise a :exc:`UnicodeDecodeError` exception), ``'replace'`` (use +``U+FFFD``, ``REPLACEMENT CHARACTER``), ``'ignore'`` (just leave the +character out of the Unicode result), or ``'backslashreplace'`` (inserts a +``\xNN`` escape sequence). +The following examples show the differences:: + + >>> b'\x80abc'.decode("utf-8", "strict") #doctest: +NORMALIZE_WHITESPACE + Traceback (most recent call last): + ... + UnicodeDecodeError: 'utf-8' codec can't decode byte 0x80 in position 0: + invalid start byte + >>> b'\x80abc'.decode("utf-8", "replace") + '\ufffdabc' + >>> b'\x80abc'.decode("utf-8", "backslashreplace") + '\\x80abc' + >>> b'\x80abc'.decode("utf-8", "ignore") + 'abc' + +Encodings are specified as strings containing the encoding's name. Python +comes with roughly 100 different encodings; see the Python Library Reference at +:ref:`standard-encodings` for a list. Some encodings have multiple names; for +example, ``'latin-1'``, ``'iso_8859_1'`` and ``'8859``' are all synonyms for +the same encoding. + +One-character Unicode strings can also be created with the :func:`chr` +built-in function, which takes integers and returns a Unicode string of length 1 +that contains the corresponding code point. The reverse operation is the +built-in :func:`ord` function that takes a one-character Unicode string and +returns the code point value:: + + >>> chr(57344) + '\ue000' + >>> ord('\ue000') + 57344 + +Converting to Bytes +------------------- + +The opposite method of :meth:`bytes.decode` is :meth:`str.encode`, +which returns a :class:`bytes` representation of the Unicode string, encoded in the +requested *encoding*. + +The *errors* parameter is the same as the parameter of the +:meth:`~bytes.decode` method but supports a few more possible handlers. As well as +``'strict'``, ``'ignore'``, and ``'replace'`` (which in this case +inserts a question mark instead of the unencodable character), there is +also ``'xmlcharrefreplace'`` (inserts an XML character reference), +``backslashreplace`` (inserts a ``\uNNNN`` escape sequence) and +``namereplace`` (inserts a ``\N{...}`` escape sequence). + +The following example shows the different results:: + + >>> u = chr(40960) + 'abcd' + chr(1972) + >>> u.encode('utf-8') + b'\xea\x80\x80abcd\xde\xb4' + >>> u.encode('ascii') #doctest: +NORMALIZE_WHITESPACE + Traceback (most recent call last): + ... + UnicodeEncodeError: 'ascii' codec can't encode character '\ua000' in + position 0: ordinal not in range(128) + >>> u.encode('ascii', 'ignore') + b'abcd' + >>> u.encode('ascii', 'replace') + b'?abcd?' + >>> u.encode('ascii', 'xmlcharrefreplace') + b'ꀀabcd޴' + >>> u.encode('ascii', 'backslashreplace') + b'\\ua000abcd\\u07b4' + >>> u.encode('ascii', 'namereplace') + b'\\N{YI SYLLABLE IT}abcd\\u07b4' + +The low-level routines for registering and accessing the available +encodings are found in the :mod:`codecs` module. Implementing new +encodings also requires understanding the :mod:`codecs` module. +However, the encoding and decoding functions returned by this module +are usually more low-level than is comfortable, and writing new encodings +is a specialized task, so the module won't be covered in this HOWTO. + + +Unicode Literals in Python Source Code +-------------------------------------- + +In Python source code, specific Unicode code points can be written using the +``\u`` escape sequence, which is followed by four hex digits giving the code +point. The ``\U`` escape sequence is similar, but expects eight hex digits, +not four:: + + >>> s = "a\xac\u1234\u20ac\U00008000" + ... # ^^^^ two-digit hex escape + ... # ^^^^^^ four-digit Unicode escape + ... # ^^^^^^^^^^ eight-digit Unicode escape + >>> [ord(c) for c in s] + [97, 172, 4660, 8364, 32768] + +Using escape sequences for code points greater than 127 is fine in small doses, +but becomes an annoyance if you're using many accented characters, as you would +in a program with messages in French or some other accent-using language. You +can also assemble strings using the :func:`chr` built-in function, but this is +even more tedious. + +Ideally, you'd want to be able to write literals in your language's natural +encoding. You could then edit Python source code with your favorite editor +which would display the accented characters naturally, and have the right +characters used at runtime. + +Python supports writing source code in UTF-8 by default, but you can use almost +any encoding if you declare the encoding being used. This is done by including +a special comment as either the first or second line of the source file:: + + #!/usr/bin/env python + # -*- coding: latin-1 -*- + + u = 'abcdé' + print(ord(u[-1])) + +The syntax is inspired by Emacs's notation for specifying variables local to a +file. Emacs supports many different variables, but Python only supports +'coding'. The ``-*-`` symbols indicate to Emacs that the comment is special; +they have no significance to Python but are a convention. Python looks for +``coding: name`` or ``coding=name`` in the comment. + +If you don't include such a comment, the default encoding used will be UTF-8 as +already mentioned. See also :pep:`263` for more information. + + +Unicode Properties +------------------ + +The Unicode specification includes a database of information about +code points. For each defined code point, the information includes +the character's name, its category, the numeric value if applicable +(for characters representing numeric concepts such as the Roman +numerals, fractions such as one-third and four-fifths, etc.). There +are also display-related properties, such as how to use the code point +in bidirectional text. + +The following program displays some information about several characters, and +prints the numeric value of one particular character:: + + import unicodedata + + u = chr(233) + chr(0x0bf2) + chr(3972) + chr(6000) + chr(13231) + + for i, c in enumerate(u): + print(i, '%04x' % ord(c), unicodedata.category(c), end=" ") + print(unicodedata.name(c)) + + # Get numeric value of second character + print(unicodedata.numeric(u[1])) + +When run, this prints: + +.. code-block:: none + + 0 00e9 Ll LATIN SMALL LETTER E WITH ACUTE + 1 0bf2 No TAMIL NUMBER ONE THOUSAND + 2 0f84 Mn TIBETAN MARK HALANTA + 3 1770 Lo TAGBANWA LETTER SA + 4 33af So SQUARE RAD OVER S SQUARED + 1000.0 + +The category codes are abbreviations describing the nature of the character. +These are grouped into categories such as "Letter", "Number", "Punctuation", or +"Symbol", which in turn are broken up into subcategories. To take the codes +from the above output, ``'Ll'`` means 'Letter, lowercase', ``'No'`` means +"Number, other", ``'Mn'`` is "Mark, nonspacing", and ``'So'`` is "Symbol, +other". See +`the General Category Values section of the Unicode Character Database documentation `_ for a +list of category codes. + + +Comparing Strings +----------------- + +Unicode adds some complication to comparing strings, because the same +set of characters can be represented by different sequences of code +points. For example, a letter like 'ê' can be represented as a single +code point U+00EA, or as U+0065 U+0302, which is the code point for +'e' followed by a code point for 'COMBINING CIRCUMFLEX ACCENT'. These +will produce the same output when printed, but one is a string of +length 1 and the other is of length 2. + +One tool for a case-insensitive comparison is the +:meth:`~str.casefold` string method that converts a string to a +case-insensitive form following an algorithm described by the Unicode +Standard. This algorithm has special handling for characters such as +the German letter 'ß' (code point U+00DF), which becomes the pair of +lowercase letters 'ss'. + +:: + + >>> street = 'Gürzenichstraße' + >>> street.casefold() + 'gürzenichstrasse' + +A second tool is the :mod:`unicodedata` module's +:func:`~unicodedata.normalize` function that converts strings to one +of several normal forms, where letters followed by a combining +character are replaced with single characters. :func:`normalize` can +be used to perform string comparisons that won't falsely report +inequality if two strings use combining characters differently: + +:: + + import unicodedata + + def compare_strs(s1, s2): + def NFD(s): + return unicodedata.normalize('NFD', s) + + return NFD(s1) == NFD(s2) + + single_char = 'ê' + multiple_chars = '\N{LATIN SMALL LETTER E}\N{COMBINING CIRCUMFLEX ACCENT}' + print('length of first string=', len(single_char)) + print('length of second string=', len(multiple_chars)) + print(compare_strs(single_char, multiple_chars)) + +When run, this outputs: + +.. code-block:: shell-session + + $ python3 compare-strs.py + length of first string= 1 + length of second string= 2 + True + +The first argument to the :func:`~unicodedata.normalize` function is a +string giving the desired normalization form, which can be one of +'NFC', 'NFKC', 'NFD', and 'NFKD'. + +The Unicode Standard also specifies how to do caseless comparisons:: + + import unicodedata + + def compare_caseless(s1, s2): + def NFD(s): + return unicodedata.normalize('NFD', s) + + return NFD(NFD(s1).casefold()) == NFD(NFD(s2).casefold()) + + # Example usage + single_char = 'ê' + multiple_chars = '\N{LATIN CAPITAL LETTER E}\N{COMBINING CIRCUMFLEX ACCENT}' + + print(compare_caseless(single_char, multiple_chars)) + +This will print ``True``. (Why is :func:`NFD` invoked twice? Because +there are a few characters that make :meth:`casefold` return a +non-normalized string, so the result needs to be normalized again. See +section 3.13 of the Unicode Standard for a discussion and an example.) + + +Unicode Regular Expressions +--------------------------- + +The regular expressions supported by the :mod:`re` module can be provided +either as bytes or strings. Some of the special character sequences such as +``\d`` and ``\w`` have different meanings depending on whether +the pattern is supplied as bytes or a string. For example, +``\d`` will match the characters ``[0-9]`` in bytes but +in strings will match any character that's in the ``'Nd'`` category. + +The string in this example has the number 57 written in both Thai and +Arabic numerals:: + + import re + p = re.compile(r'\d+') + + s = "Over \u0e55\u0e57 57 flavours" + m = p.search(s) + print(repr(m.group())) + +When executed, ``\d+`` will match the Thai numerals and print them +out. If you supply the :const:`re.ASCII` flag to +:func:`~re.compile`, ``\d+`` will match the substring "57" instead. + +Similarly, ``\w`` matches a wide variety of Unicode characters but +only ``[a-zA-Z0-9_]`` in bytes or if :const:`re.ASCII` is supplied, +and ``\s`` will match either Unicode whitespace characters or +``[ \t\n\r\f\v]``. + + +References +---------- + +.. comment should these be mentioned earlier, e.g. at the start of the "introduction to Unicode" first section? + +Some good alternative discussions of Python's Unicode support are: + +* `Processing Text Files in Python 3 `_, by Nick Coghlan. +* `Pragmatic Unicode `_, a PyCon 2012 presentation by Ned Batchelder. + +The :class:`str` type is described in the Python library reference at +:ref:`textseq`. + +The documentation for the :mod:`unicodedata` module. + +The documentation for the :mod:`codecs` module. + +Marc-André Lemburg gave `a presentation titled "Python and Unicode" (PDF slides) +`_ at +EuroPython 2002. The slides are an excellent overview of the design of Python +2's Unicode features (where the Unicode string type is called ``unicode`` and +literals start with ``u``). + + +Reading and Writing Unicode Data +================================ + +Once you've written some code that works with Unicode data, the next problem is +input/output. How do you get Unicode strings into your program, and how do you +convert Unicode into a form suitable for storage or transmission? + +It's possible that you may not need to do anything depending on your input +sources and output destinations; you should check whether the libraries used in +your application support Unicode natively. XML parsers often return Unicode +data, for example. Many relational databases also support Unicode-valued +columns and can return Unicode values from an SQL query. + +Unicode data is usually converted to a particular encoding before it gets +written to disk or sent over a socket. It's possible to do all the work +yourself: open a file, read an 8-bit bytes object from it, and convert the bytes +with ``bytes.decode(encoding)``. However, the manual approach is not recommended. + +One problem is the multi-byte nature of encodings; one Unicode character can be +represented by several bytes. If you want to read the file in arbitrary-sized +chunks (say, 1024 or 4096 bytes), you need to write error-handling code to catch the case +where only part of the bytes encoding a single Unicode character are read at the +end of a chunk. One solution would be to read the entire file into memory and +then perform the decoding, but that prevents you from working with files that +are extremely large; if you need to read a 2 GiB file, you need 2 GiB of RAM. +(More, really, since for at least a moment you'd need to have both the encoded +string and its Unicode version in memory.) + +The solution would be to use the low-level decoding interface to catch the case +of partial coding sequences. The work of implementing this has already been +done for you: the built-in :func:`open` function can return a file-like object +that assumes the file's contents are in a specified encoding and accepts Unicode +parameters for methods such as :meth:`~io.TextIOBase.read` and +:meth:`~io.TextIOBase.write`. This works through :func:`open`\'s *encoding* and +*errors* parameters which are interpreted just like those in :meth:`str.encode` +and :meth:`bytes.decode`. + +Reading Unicode from a file is therefore simple:: + + with open('unicode.txt', encoding='utf-8') as f: + for line in f: + print(repr(line)) + +It's also possible to open files in update mode, allowing both reading and +writing:: + + with open('test', encoding='utf-8', mode='w+') as f: + f.write('\u4500 blah blah blah\n') + f.seek(0) + print(repr(f.readline()[:1])) + +The Unicode character ``U+FEFF`` is used as a byte-order mark (BOM), and is often +written as the first character of a file in order to assist with autodetection +of the file's byte ordering. Some encodings, such as UTF-16, expect a BOM to be +present at the start of a file; when such an encoding is used, the BOM will be +automatically written as the first character and will be silently dropped when +the file is read. There are variants of these encodings, such as 'utf-16-le' +and 'utf-16-be' for little-endian and big-endian encodings, that specify one +particular byte ordering and don't skip the BOM. + +In some areas, it is also convention to use a "BOM" at the start of UTF-8 +encoded files; the name is misleading since UTF-8 is not byte-order dependent. +The mark simply announces that the file is encoded in UTF-8. For reading such +files, use the 'utf-8-sig' codec to automatically skip the mark if present. + + +Unicode filenames +----------------- + +Most of the operating systems in common use today support filenames +that contain arbitrary Unicode characters. Usually this is +implemented by converting the Unicode string into some encoding that +varies depending on the system. Today Python is converging on using +UTF-8: Python on MacOS has used UTF-8 for several versions, and Python +3.6 switched to using UTF-8 on Windows as well. On Unix systems, +there will only be a filesystem encoding if you've set the ``LANG`` or +``LC_CTYPE`` environment variables; if you haven't, the default +encoding is again UTF-8. + +The :func:`sys.getfilesystemencoding` function returns the encoding to use on +your current system, in case you want to do the encoding manually, but there's +not much reason to bother. When opening a file for reading or writing, you can +usually just provide the Unicode string as the filename, and it will be +automatically converted to the right encoding for you:: + + filename = 'filename\u4500abc' + with open(filename, 'w') as f: + f.write('blah\n') + +Functions in the :mod:`os` module such as :func:`os.stat` will also accept Unicode +filenames. + +The :func:`os.listdir` function returns filenames, which raises an issue: should it return +the Unicode version of filenames, or should it return bytes containing +the encoded versions? :func:`os.listdir` can do both, depending on whether you +provided the directory path as bytes or a Unicode string. If you pass a +Unicode string as the path, filenames will be decoded using the filesystem's +encoding and a list of Unicode strings will be returned, while passing a byte +path will return the filenames as bytes. For example, +assuming the default filesystem encoding is UTF-8, running the following +program:: + + fn = 'filename\u4500abc' + f = open(fn, 'w') + f.close() + + import os + print(os.listdir(b'.')) + print(os.listdir('.')) + +will produce the following output: + +.. code-block:: shell-session + + $ python listdir-test.py + [b'filename\xe4\x94\x80abc', ...] + ['filename\u4500abc', ...] + +The first list contains UTF-8-encoded filenames, and the second list contains +the Unicode versions. + +Note that on most occasions, you should can just stick with using +Unicode with these APIs. The bytes APIs should only be used on +systems where undecodable file names can be present; that's +pretty much only Unix systems now. + + +Tips for Writing Unicode-aware Programs +--------------------------------------- + +This section provides some suggestions on writing software that deals with +Unicode. + +The most important tip is: + + Software should only work with Unicode strings internally, decoding the input + data as soon as possible and encoding the output only at the end. + +If you attempt to write processing functions that accept both Unicode and byte +strings, you will find your program vulnerable to bugs wherever you combine the +two different kinds of strings. There is no automatic encoding or decoding: if +you do e.g. ``str + bytes``, a :exc:`TypeError` will be raised. + +When using data coming from a web browser or some other untrusted source, a +common technique is to check for illegal characters in a string before using the +string in a generated command line or storing it in a database. If you're doing +this, be careful to check the decoded string, not the encoded bytes data; +some encodings may have interesting properties, such as not being bijective +or not being fully ASCII-compatible. This is especially true if the input +data also specifies the encoding, since the attacker can then choose a +clever way to hide malicious text in the encoded bytestream. + + +Converting Between File Encodings +''''''''''''''''''''''''''''''''' + +The :class:`~codecs.StreamRecoder` class can transparently convert between +encodings, taking a stream that returns data in encoding #1 +and behaving like a stream returning data in encoding #2. + +For example, if you have an input file *f* that's in Latin-1, you +can wrap it with a :class:`~codecs.StreamRecoder` to return bytes encoded in +UTF-8:: + + new_f = codecs.StreamRecoder(f, + # en/decoder: used by read() to encode its results and + # by write() to decode its input. + codecs.getencoder('utf-8'), codecs.getdecoder('utf-8'), + + # reader/writer: used to read and write to the stream. + codecs.getreader('latin-1'), codecs.getwriter('latin-1') ) + + +Files in an Unknown Encoding +'''''''''''''''''''''''''''' + +What can you do if you need to make a change to a file, but don't know +the file's encoding? If you know the encoding is ASCII-compatible and +only want to examine or modify the ASCII parts, you can open the file +with the ``surrogateescape`` error handler:: + + with open(fname, 'r', encoding="ascii", errors="surrogateescape") as f: + data = f.read() + + # make changes to the string 'data' + + with open(fname + '.new', 'w', + encoding="ascii", errors="surrogateescape") as f: + f.write(data) + +The ``surrogateescape`` error handler will decode any non-ASCII bytes +as code points in a special range running from U+DC80 to +U+DCFF. These code points will then turn back into the +same bytes when the ``surrogateescape`` error handler is used to +encode the data and write it back out. + + +References +---------- + +One section of `Mastering Python 3 Input/Output +`_, +a PyCon 2010 talk by David Beazley, discusses text processing and binary data handling. + +The `PDF slides for Marc-André Lemburg's presentation "Writing Unicode-aware +Applications in Python" +`_ +discuss questions of character encodings as well as how to internationalize +and localize an application. These slides cover Python 2.x only. + +`The Guts of Unicode in Python +`_ +is a PyCon 2013 talk by Benjamin Peterson that discusses the internal Unicode +representation in Python 3.3. + + +Acknowledgements +================ + +The initial draft of this document was written by Andrew Kuchling. +It has since been revised further by Alexander Belopolsky, Georg Brandl, +Andrew Kuchling, and Ezio Melotti. + +Thanks to the following people who have noted errors or offered +suggestions on this article: Éric Araujo, Nicholas Bastin, Nick +Coghlan, Marius Gedminas, Kent Johnson, Ken Krugler, Marc-André +Lemburg, Martin von Löwis, Terry J. Reedy, Serhiy Storchaka, +Eryk Sun, Chad Whitacre, Graham Wideman. diff --git a/python-3.7.4-docs-html/_sources/howto/urllib2.rst.txt b/python-3.7.4-docs-html/_sources/howto/urllib2.rst.txt new file mode 100644 index 0000000..046a88a --- /dev/null +++ b/python-3.7.4-docs-html/_sources/howto/urllib2.rst.txt @@ -0,0 +1,605 @@ +.. _urllib-howto: + +*********************************************************** + HOWTO Fetch Internet Resources Using The urllib Package +*********************************************************** + +:Author: `Michael Foord `_ + +.. note:: + + There is a French translation of an earlier revision of this + HOWTO, available at `urllib2 - Le Manuel manquant + `_. + + + +Introduction +============ + +.. sidebar:: Related Articles + + You may also find useful the following article on fetching web resources + with Python: + + * `Basic Authentication `_ + + A tutorial on *Basic Authentication*, with examples in Python. + +**urllib.request** is a Python module for fetching URLs +(Uniform Resource Locators). It offers a very simple interface, in the form of +the *urlopen* function. This is capable of fetching URLs using a variety of +different protocols. It also offers a slightly more complex interface for +handling common situations - like basic authentication, cookies, proxies and so +on. These are provided by objects called handlers and openers. + +urllib.request supports fetching URLs for many "URL schemes" (identified by the string +before the ``":"`` in URL - for example ``"ftp"`` is the URL scheme of +``"ftp://python.org/"``) using their associated network protocols (e.g. FTP, HTTP). +This tutorial focuses on the most common case, HTTP. + +For straightforward situations *urlopen* is very easy to use. But as soon as you +encounter errors or non-trivial cases when opening HTTP URLs, you will need some +understanding of the HyperText Transfer Protocol. The most comprehensive and +authoritative reference to HTTP is :rfc:`2616`. This is a technical document and +not intended to be easy to read. This HOWTO aims to illustrate using *urllib*, +with enough detail about HTTP to help you through. It is not intended to replace +the :mod:`urllib.request` docs, but is supplementary to them. + + +Fetching URLs +============= + +The simplest way to use urllib.request is as follows:: + + import urllib.request + with urllib.request.urlopen('http://python.org/') as response: + html = response.read() + +If you wish to retrieve a resource via URL and store it in a temporary +location, you can do so via the :func:`shutil.copyfileobj` and +:func:`tempfile.NamedTemporaryFile` functions:: + + import shutil + import tempfile + import urllib.request + + with urllib.request.urlopen('http://python.org/') as response: + with tempfile.NamedTemporaryFile(delete=False) as tmp_file: + shutil.copyfileobj(response, tmp_file) + + with open(tmp_file.name) as html: + pass + +Many uses of urllib will be that simple (note that instead of an 'http:' URL we +could have used a URL starting with 'ftp:', 'file:', etc.). However, it's the +purpose of this tutorial to explain the more complicated cases, concentrating on +HTTP. + +HTTP is based on requests and responses - the client makes requests and servers +send responses. urllib.request mirrors this with a ``Request`` object which represents +the HTTP request you are making. In its simplest form you create a Request +object that specifies the URL you want to fetch. Calling ``urlopen`` with this +Request object returns a response object for the URL requested. This response is +a file-like object, which means you can for example call ``.read()`` on the +response:: + + import urllib.request + + req = urllib.request.Request('http://www.voidspace.org.uk') + with urllib.request.urlopen(req) as response: + the_page = response.read() + +Note that urllib.request makes use of the same Request interface to handle all URL +schemes. For example, you can make an FTP request like so:: + + req = urllib.request.Request('ftp://example.com/') + +In the case of HTTP, there are two extra things that Request objects allow you +to do: First, you can pass data to be sent to the server. Second, you can pass +extra information ("metadata") *about* the data or the about request itself, to +the server - this information is sent as HTTP "headers". Let's look at each of +these in turn. + +Data +---- + +Sometimes you want to send data to a URL (often the URL will refer to a CGI +(Common Gateway Interface) script or other web application). With HTTP, +this is often done using what's known as a **POST** request. This is often what +your browser does when you submit a HTML form that you filled in on the web. Not +all POSTs have to come from forms: you can use a POST to transmit arbitrary data +to your own application. In the common case of HTML forms, the data needs to be +encoded in a standard way, and then passed to the Request object as the ``data`` +argument. The encoding is done using a function from the :mod:`urllib.parse` +library. :: + + import urllib.parse + import urllib.request + + url = 'http://www.someserver.com/cgi-bin/register.cgi' + values = {'name' : 'Michael Foord', + 'location' : 'Northampton', + 'language' : 'Python' } + + data = urllib.parse.urlencode(values) + data = data.encode('ascii') # data should be bytes + req = urllib.request.Request(url, data) + with urllib.request.urlopen(req) as response: + the_page = response.read() + +Note that other encodings are sometimes required (e.g. for file upload from HTML +forms - see `HTML Specification, Form Submission +`_ for more +details). + +If you do not pass the ``data`` argument, urllib uses a **GET** request. One +way in which GET and POST requests differ is that POST requests often have +"side-effects": they change the state of the system in some way (for example by +placing an order with the website for a hundredweight of tinned spam to be +delivered to your door). Though the HTTP standard makes it clear that POSTs are +intended to *always* cause side-effects, and GET requests *never* to cause +side-effects, nothing prevents a GET request from having side-effects, nor a +POST requests from having no side-effects. Data can also be passed in an HTTP +GET request by encoding it in the URL itself. + +This is done as follows:: + + >>> import urllib.request + >>> import urllib.parse + >>> data = {} + >>> data['name'] = 'Somebody Here' + >>> data['location'] = 'Northampton' + >>> data['language'] = 'Python' + >>> url_values = urllib.parse.urlencode(data) + >>> print(url_values) # The order may differ from below. #doctest: +SKIP + name=Somebody+Here&language=Python&location=Northampton + >>> url = 'http://www.example.com/example.cgi' + >>> full_url = url + '?' + url_values + >>> data = urllib.request.urlopen(full_url) + +Notice that the full URL is created by adding a ``?`` to the URL, followed by +the encoded values. + +Headers +------- + +We'll discuss here one particular HTTP header, to illustrate how to add headers +to your HTTP request. + +Some websites [#]_ dislike being browsed by programs, or send different versions +to different browsers [#]_. By default urllib identifies itself as +``Python-urllib/x.y`` (where ``x`` and ``y`` are the major and minor version +numbers of the Python release, +e.g. ``Python-urllib/2.5``), which may confuse the site, or just plain +not work. The way a browser identifies itself is through the +``User-Agent`` header [#]_. When you create a Request object you can +pass a dictionary of headers in. The following example makes the same +request as above, but identifies itself as a version of Internet +Explorer [#]_. :: + + import urllib.parse + import urllib.request + + 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} + + data = urllib.parse.urlencode(values) + data = data.encode('ascii') + req = urllib.request.Request(url, data, headers) + with urllib.request.urlopen(req) as response: + the_page = response.read() + +The response also has two useful methods. See the section on `info and geturl`_ +which comes after we have a look at what happens when things go wrong. + + +Handling Exceptions +=================== + +*urlopen* raises :exc:`URLError` when it cannot handle a response (though as +usual with Python APIs, built-in exceptions such as :exc:`ValueError`, +:exc:`TypeError` etc. may also be raised). + +:exc:`HTTPError` is the subclass of :exc:`URLError` raised in the specific case of +HTTP URLs. + +The exception classes are exported from the :mod:`urllib.error` module. + +URLError +-------- + +Often, URLError is raised because there is no network connection (no route to +the specified server), or the specified server doesn't exist. In this case, the +exception raised will have a 'reason' attribute, which is a tuple containing an +error code and a text error message. + +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 + ... + (4, 'getaddrinfo failed') + + +HTTPError +--------- + +Every HTTP response from the server contains a numeric "status code". Sometimes +the status code indicates that the server is unable to fulfil the request. The +default handlers will handle some of these responses for you (for example, if +the response is a "redirection" that requests the client fetch the document from +a different URL, urllib will handle that for you). For those it can't handle, +urlopen will raise an :exc:`HTTPError`. Typical errors include '404' (page not +found), '403' (request forbidden), and '401' (authentication required). + +See section 10 of :rfc:`2616` for a reference on all the HTTP error codes. + +The :exc:`HTTPError` instance raised will have an integer 'code' attribute, which +corresponds to the error sent by the server. + +Error Codes +~~~~~~~~~~~ + +Because the default handlers handle redirects (codes in the 300 range), and +codes in the 100--299 range indicate success, you will usually only see error +codes in the 400--599 range. + +:attr:`http.server.BaseHTTPRequestHandler.responses` is a useful dictionary of +response codes in that shows all the response codes used by :rfc:`2616`. The +dictionary is reproduced here for convenience :: + + # Table mapping response codes to messages; entries have the + # form {code: (shortmessage, longmessage)}. + responses = { + 100: ('Continue', 'Request received, please continue'), + 101: ('Switching Protocols', + 'Switching to new protocol; obey Upgrade header'), + + 200: ('OK', 'Request fulfilled, document follows'), + 201: ('Created', 'Document created, URL follows'), + 202: ('Accepted', + 'Request accepted, processing continues off-line'), + 203: ('Non-Authoritative Information', 'Request fulfilled from cache'), + 204: ('No Content', 'Request fulfilled, nothing follows'), + 205: ('Reset Content', 'Clear input form for further input.'), + 206: ('Partial Content', 'Partial content follows.'), + + 300: ('Multiple Choices', + 'Object has several resources -- see URI list'), + 301: ('Moved Permanently', 'Object moved permanently -- see URI list'), + 302: ('Found', 'Object moved temporarily -- see URI list'), + 303: ('See Other', 'Object moved -- see Method and URL list'), + 304: ('Not Modified', + 'Document has not changed since given time'), + 305: ('Use Proxy', + 'You must use proxy specified in Location to access this ' + 'resource.'), + 307: ('Temporary Redirect', + 'Object moved temporarily -- see URI list'), + + 400: ('Bad Request', + 'Bad request syntax or unsupported method'), + 401: ('Unauthorized', + 'No permission -- see authorization schemes'), + 402: ('Payment Required', + 'No payment -- see charging schemes'), + 403: ('Forbidden', + 'Request forbidden -- authorization will not help'), + 404: ('Not Found', 'Nothing matches the given URI'), + 405: ('Method Not Allowed', + 'Specified method is invalid for this server.'), + 406: ('Not Acceptable', 'URI not available in preferred format.'), + 407: ('Proxy Authentication Required', 'You must authenticate with ' + 'this proxy before proceeding.'), + 408: ('Request Timeout', 'Request timed out; try again later.'), + 409: ('Conflict', 'Request conflict.'), + 410: ('Gone', + 'URI no longer exists and has been permanently removed.'), + 411: ('Length Required', 'Client must specify Content-Length.'), + 412: ('Precondition Failed', 'Precondition in headers is false.'), + 413: ('Request Entity Too Large', 'Entity is too large.'), + 414: ('Request-URI Too Long', 'URI is too long.'), + 415: ('Unsupported Media Type', 'Entity body in unsupported format.'), + 416: ('Requested Range Not Satisfiable', + 'Cannot satisfy request range.'), + 417: ('Expectation Failed', + 'Expect condition could not be satisfied.'), + + 500: ('Internal Server Error', 'Server got itself in trouble'), + 501: ('Not Implemented', + 'Server does not support this operation'), + 502: ('Bad Gateway', 'Invalid responses from another server/proxy.'), + 503: ('Service Unavailable', + 'The server cannot process the request due to a high load'), + 504: ('Gateway Timeout', + 'The gateway server did not receive a timely response'), + 505: ('HTTP Version Not Supported', 'Cannot fulfill request.'), + } + +When an error is raised the server responds by returning an HTTP error code +*and* an error page. You can use the :exc:`HTTPError` instance as a response on the +page returned. This means that as well as the code attribute, it also has read, +geturl, and info, methods as returned by the ``urllib.response`` module:: + + >>> req = urllib.request.Request('http://www.python.org/fish.html') + >>> try: + ... urllib.request.urlopen(req) + ... except urllib.error.HTTPError as e: + ... print(e.code) + ... print(e.read()) #doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE + ... + 404 + b'\n\n\nPage Not Found\n + ... + +Wrapping it Up +-------------- + +So if you want to be prepared for :exc:`HTTPError` *or* :exc:`URLError` there are two +basic approaches. I prefer the second approach. + +Number 1 +~~~~~~~~ + +:: + + + from urllib.request import Request, urlopen + from urllib.error import URLError, HTTPError + req = Request(someurl) + try: + response = urlopen(req) + except HTTPError as e: + print('The server couldn\'t fulfill the request.') + print('Error code: ', e.code) + except URLError as e: + print('We failed to reach a server.') + print('Reason: ', e.reason) + else: + # everything is fine + + +.. note:: + + The ``except HTTPError`` *must* come first, otherwise ``except URLError`` + will *also* catch an :exc:`HTTPError`. + +Number 2 +~~~~~~~~ + +:: + + from urllib.request import Request, urlopen + from urllib.error import URLError + req = Request(someurl) + try: + response = urlopen(req) + except URLError as e: + if hasattr(e, 'reason'): + print('We failed to reach a server.') + print('Reason: ', e.reason) + elif hasattr(e, 'code'): + print('The server couldn\'t fulfill the request.') + print('Error code: ', e.code) + else: + # everything is fine + + +info and geturl +=============== + +The response returned by urlopen (or the :exc:`HTTPError` instance) has two +useful methods :meth:`info` and :meth:`geturl` and is defined in the module +:mod:`urllib.response`.. + +**geturl** - this returns the real URL of the page fetched. This is useful +because ``urlopen`` (or the opener object used) may have followed a +redirect. The URL of the page fetched may not be the same as the URL requested. + +**info** - this returns a dictionary-like object that describes the page +fetched, particularly the headers sent by the server. It is currently an +:class:`http.client.HTTPMessage` instance. + +Typical headers include 'Content-length', 'Content-type', and so on. See the +`Quick Reference to HTTP Headers `_ +for a useful listing of HTTP headers with brief explanations of their meaning +and use. + + +Openers and Handlers +==================== + +When you fetch a URL you use an opener (an instance of the perhaps +confusingly-named :class:`urllib.request.OpenerDirector`). Normally we have been using +the default opener - via ``urlopen`` - but you can create custom +openers. Openers use handlers. All the "heavy lifting" is done by the +handlers. Each handler knows how to open URLs for a particular URL scheme (http, +ftp, etc.), or how to handle an aspect of URL opening, for example HTTP +redirections or HTTP cookies. + +You will want to create openers if you want to fetch URLs with specific handlers +installed, for example to get an opener that handles cookies, or to get an +opener that does not handle redirections. + +To create an opener, instantiate an ``OpenerDirector``, and then call +``.add_handler(some_handler_instance)`` repeatedly. + +Alternatively, you can use ``build_opener``, which is a convenience function for +creating opener objects with a single function call. ``build_opener`` adds +several handlers by default, but provides a quick way to add more and/or +override the default handlers. + +Other sorts of handlers you might want to can handle proxies, authentication, +and other common but slightly specialised situations. + +``install_opener`` can be used to make an ``opener`` object the (global) default +opener. This means that calls to ``urlopen`` will use the opener you have +installed. + +Opener objects have an ``open`` method, which can be called directly to fetch +urls in the same way as the ``urlopen`` function: there's no need to call +``install_opener``, except as a convenience. + + +Basic Authentication +==================== + +To illustrate creating and installing a handler we will use the +``HTTPBasicAuthHandler``. For a more detailed discussion of this subject -- +including an explanation of how Basic Authentication works - see the `Basic +Authentication Tutorial +`_. + +When authentication is required, the server sends a header (as well as the 401 +error code) requesting authentication. This specifies the authentication scheme +and a 'realm'. The header looks like: ``WWW-Authenticate: SCHEME +realm="REALM"``. + +e.g. + +.. code-block:: none + + WWW-Authenticate: Basic realm="cPanel Users" + + +The client should then retry the request with the appropriate name and password +for the realm included as a header in the request. This is 'basic +authentication'. In order to simplify this process we can create an instance of +``HTTPBasicAuthHandler`` and an opener to use this handler. + +The ``HTTPBasicAuthHandler`` uses an object called a password manager to handle +the mapping of URLs and realms to passwords and usernames. If you know what the +realm is (from the authentication header sent by the server), then you can use a +``HTTPPasswordMgr``. Frequently one doesn't care what the realm is. In that +case, it is convenient to use ``HTTPPasswordMgrWithDefaultRealm``. This allows +you to specify a default username and password for a URL. This will be supplied +in the absence of you providing an alternative combination for a specific +realm. We indicate this by providing ``None`` as the realm argument to the +``add_password`` method. + +The top-level URL is the first URL that requires authentication. URLs "deeper" +than the URL you pass to .add_password() will also match. :: + + # create a password manager + password_mgr = urllib.request.HTTPPasswordMgrWithDefaultRealm() + + # Add the username and password. + # If we knew the realm, we could use it instead of None. + top_level_url = "http://example.com/foo/" + password_mgr.add_password(None, top_level_url, username, password) + + handler = urllib.request.HTTPBasicAuthHandler(password_mgr) + + # create "opener" (OpenerDirector instance) + opener = urllib.request.build_opener(handler) + + # use the opener to fetch a URL + opener.open(a_url) + + # Install the opener. + # Now all calls to urllib.request.urlopen use our opener. + urllib.request.install_opener(opener) + +.. note:: + + In the above example we only supplied our ``HTTPBasicAuthHandler`` to + ``build_opener``. By default openers have the handlers for normal situations + -- ``ProxyHandler`` (if a proxy setting such as an :envvar:`http_proxy` + environment variable is set), ``UnknownHandler``, ``HTTPHandler``, + ``HTTPDefaultErrorHandler``, ``HTTPRedirectHandler``, ``FTPHandler``, + ``FileHandler``, ``DataHandler``, ``HTTPErrorProcessor``. + +``top_level_url`` is in fact *either* a full URL (including the 'http:' scheme +component and the hostname and optionally the port number) +e.g. ``"http://example.com/"`` *or* an "authority" (i.e. the hostname, +optionally including the port number) e.g. ``"example.com"`` or ``"example.com:8080"`` +(the latter example includes a port number). The authority, if present, must +NOT contain the "userinfo" component - for example ``"joe:password@example.com"`` is +not correct. + + +Proxies +======= + +**urllib** will auto-detect your proxy settings and use those. This is through +the ``ProxyHandler``, which is part of the normal handler chain when a proxy +setting is detected. Normally that's a good thing, but there are occasions +when it may not be helpful [#]_. One way to do this is to setup our own +``ProxyHandler``, with no proxies defined. This is done using similar steps to +setting up a `Basic Authentication`_ handler: :: + + >>> proxy_support = urllib.request.ProxyHandler({}) + >>> opener = urllib.request.build_opener(proxy_support) + >>> urllib.request.install_opener(opener) + +.. note:: + + Currently ``urllib.request`` *does not* support fetching of ``https`` locations + through a proxy. However, this can be enabled by extending urllib.request as + shown in the recipe [#]_. + +.. note:: + + ``HTTP_PROXY`` will be ignored if a variable ``REQUEST_METHOD`` is set; see + the documentation on :func:`~urllib.request.getproxies`. + + +Sockets and Layers +================== + +The Python support for fetching resources from the web is layered. urllib uses +the :mod:`http.client` library, which in turn uses the socket library. + +As of Python 2.3 you can specify how long a socket should wait for a response +before timing out. This can be useful in applications which have to fetch web +pages. By default the socket module has *no timeout* and can hang. Currently, +the socket timeout is not exposed at the http.client or urllib.request levels. +However, you can set the default timeout globally for all sockets using :: + + import socket + import urllib.request + + # timeout in seconds + timeout = 10 + socket.setdefaulttimeout(timeout) + + # this call to urllib.request.urlopen now uses the default timeout + # we have set in the socket module + req = urllib.request.Request('http://www.voidspace.org.uk') + response = urllib.request.urlopen(req) + + +------- + + +Footnotes +========= + +This document was reviewed and revised by John Lee. + +.. [#] Google for example. +.. [#] Browser sniffing is a very bad practice for website design - building + sites using web standards is much more sensible. Unfortunately a lot of + sites still send different versions to different browsers. +.. [#] The user agent for MSIE 6 is + *'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)'* +.. [#] For details of more HTTP request headers, see + `Quick Reference to HTTP Headers`_. +.. [#] In my case I have to use a proxy to access the internet at work. If you + attempt to fetch *localhost* URLs through this proxy it blocks them. IE + is set to use the proxy, which urllib picks up on. In order to test + scripts with a localhost server, I have to prevent urllib from using + the proxy. +.. [#] urllib opener for SSL proxy (CONNECT method): `ASPN Cookbook Recipe + `_. + diff --git a/python-3.7.4-docs-html/_sources/install/index.rst.txt b/python-3.7.4-docs-html/_sources/install/index.rst.txt new file mode 100644 index 0000000..f6a8cd6 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/install/index.rst.txt @@ -0,0 +1,1117 @@ +.. highlightlang:: none + +.. _install-index: + +******************************************** + Installing Python Modules (Legacy version) +******************************************** + +:Author: Greg Ward + +.. TODO: Fill in XXX comments + +.. seealso:: + + :ref:`installing-index` + The up to date module installation documentations + +.. The audience for this document includes people who don't know anything + about Python and aren't about to learn the language just in order to + install and maintain it for their users, i.e. system administrators. + Thus, I have to be sure to explain the basics at some point: + sys.path and PYTHONPATH at least. Should probably give pointers to + other docs on "import site", PYTHONSTARTUP, PYTHONHOME, etc. + + Finally, it might be useful to include all the material from my "Care + and Feeding of a Python Installation" talk in here somewhere. Yow! + +This document describes the Python Distribution Utilities ("Distutils") from the +end-user's point-of-view, describing how to extend the capabilities of a +standard Python installation by building and installing third-party Python +modules and extensions. + + +.. note:: + + This guide only covers the basic tools for building and distributing + extensions that are provided as part of this version of Python. Third party + tools offer easier to use and more secure alternatives. Refer to the `quick + recommendations section `__ + in the Python Packaging User Guide for more information. + + +.. _inst-intro: + + +Introduction +============ + +Although Python's extensive standard library covers many programming needs, +there often comes a time when you need to add some new functionality to your +Python installation in the form of third-party modules. This might be necessary +to support your own programming, or to support an application that you want to +use and that happens to be written in Python. + +In the past, there has been little support for adding third-party modules to an +existing Python installation. With the introduction of the Python Distribution +Utilities (Distutils for short) in Python 2.0, this changed. + +This document is aimed primarily at the people who need to install third-party +Python modules: end-users and system administrators who just need to get some +Python application running, and existing Python programmers who want to add some +new goodies to their toolbox. You don't need to know Python to read this +document; there will be some brief forays into using Python's interactive mode +to explore your installation, but that's it. If you're looking for information +on how to distribute your own Python modules so that others may use them, see +the :ref:`distutils-index` manual. :ref:`debug-setup-script` may also be of +interest. + + +.. _inst-trivial-install: + +Best case: trivial installation +------------------------------- + +In the best case, someone will have prepared a special version of the module +distribution you want to install that is targeted specifically at your platform +and is installed just like any other software on your platform. For example, +the module developer might make an executable installer available for Windows +users, an RPM package for users of RPM-based Linux systems (Red Hat, SuSE, +Mandrake, and many others), a Debian package for users of Debian-based Linux +systems, and so forth. + +In that case, you would download the installer appropriate to your platform and +do the obvious thing with it: run it if it's an executable installer, ``rpm +--install`` it if it's an RPM, etc. You don't need to run Python or a setup +script, you don't need to compile anything---you might not even need to read any +instructions (although it's always a good idea to do so anyway). + +Of course, things will not always be that easy. You might be interested in a +module distribution that doesn't have an easy-to-use installer for your +platform. In that case, you'll have to start with the source distribution +released by the module's author/maintainer. Installing from a source +distribution is not too hard, as long as the modules are packaged in the +standard way. The bulk of this document is about building and installing +modules from standard source distributions. + + +.. _inst-new-standard: + +The new standard: Distutils +--------------------------- + +If you download a module source distribution, you can tell pretty quickly if it +was packaged and distributed in the standard way, i.e. using the Distutils. +First, the distribution's name and version number will be featured prominently +in the name of the downloaded archive, e.g. :file:`foo-1.0.tar.gz` or +:file:`widget-0.9.7.zip`. Next, the archive will unpack into a similarly-named +directory: :file:`foo-1.0` or :file:`widget-0.9.7`. Additionally, the +distribution will contain a setup script :file:`setup.py`, and a file named +:file:`README.txt` or possibly just :file:`README`, which should explain that +building and installing the module distribution is a simple matter of running +one command from a terminal:: + + python setup.py install + +For Windows, this command should be run from a command prompt window +(:menuselection:`Start --> Accessories`):: + + setup.py install + +If all these things are true, then you already know how to build and install the +modules you've just downloaded: Run the command above. Unless you need to +install things in a non-standard way or customize the build process, you don't +really need this manual. Or rather, the above command is everything you need to +get out of this manual. + + +.. _inst-standard-install: + +Standard Build and Install +========================== + +As described in section :ref:`inst-new-standard`, building and installing a module +distribution using the Distutils is usually one simple command to run from a +terminal:: + + python setup.py install + + +.. _inst-platform-variations: + +Platform variations +------------------- + +You should always run the setup command from the distribution root directory, +i.e. the top-level subdirectory that the module source distribution unpacks +into. For example, if you've just downloaded a module source distribution +:file:`foo-1.0.tar.gz` onto a Unix system, the normal thing to do is:: + + gunzip -c foo-1.0.tar.gz | tar xf - # unpacks into directory foo-1.0 + cd foo-1.0 + python setup.py install + +On Windows, you'd probably download :file:`foo-1.0.zip`. If you downloaded the +archive file to :file:`C:\\Temp`, then it would unpack into +:file:`C:\\Temp\\foo-1.0`; you can use either an archive manipulator with a +graphical user interface (such as WinZip) or a command-line tool (such as +:program:`unzip` or :program:`pkunzip`) to unpack the archive. Then, open a +command prompt window and run:: + + cd c:\Temp\foo-1.0 + python setup.py install + + +.. _inst-splitting-up: + +Splitting the job up +-------------------- + +Running ``setup.py install`` builds and installs all modules in one run. If you +prefer to work incrementally---especially useful if you want to customize the +build process, or if things are going wrong---you can use the setup script to do +one thing at a time. This is particularly helpful when the build and install +will be done by different users---for example, you might want to build a module +distribution and hand it off to a system administrator for installation (or do +it yourself, with super-user privileges). + +For example, you can build everything in one step, and then install everything +in a second step, by invoking the setup script twice:: + + python setup.py build + python setup.py install + +If you do this, you will notice that running the :command:`install` command +first runs the :command:`build` command, which---in this case---quickly notices +that it has nothing to do, since everything in the :file:`build` directory is +up-to-date. + +You may not need this ability to break things down often if all you do is +install modules downloaded off the 'net, but it's very handy for more advanced +tasks. If you get into distributing your own Python modules and extensions, +you'll run lots of individual Distutils commands on their own. + + +.. _inst-how-build-works: + +How building works +------------------ + +As implied above, the :command:`build` command is responsible for putting the +files to install into a *build directory*. By default, this is :file:`build` +under the distribution root; if you're excessively concerned with speed, or want +to keep the source tree pristine, you can change the build directory with the +:option:`!--build-base` option. For example:: + + python setup.py build --build-base=/path/to/pybuild/foo-1.0 + +(Or you could do this permanently with a directive in your system or personal +Distutils configuration file; see section :ref:`inst-config-files`.) Normally, this +isn't necessary. + +The default layout for the build tree is as follows:: + + --- build/ --- lib/ + or + --- build/ --- lib./ + temp./ + +where ```` expands to a brief description of the current OS/hardware +platform and Python version. The first form, with just a :file:`lib` directory, +is used for "pure module distributions"---that is, module distributions that +include only pure Python modules. If a module distribution contains any +extensions (modules written in C/C++), then the second form, with two ```` +directories, is used. In that case, the :file:`temp.{plat}` directory holds +temporary files generated by the compile/link process that don't actually get +installed. In either case, the :file:`lib` (or :file:`lib.{plat}`) directory +contains all Python modules (pure Python and extensions) that will be installed. + +In the future, more directories will be added to handle Python scripts, +documentation, binary executables, and whatever else is needed to handle the job +of installing Python modules and applications. + + +.. _inst-how-install-works: + +How installation works +---------------------- + +After the :command:`build` command runs (whether you run it explicitly, or the +:command:`install` command does it for you), the work of the :command:`install` +command is relatively simple: all it has to do is copy everything under +:file:`build/lib` (or :file:`build/lib.{plat}`) to your chosen installation +directory. + +If you don't choose an installation directory---i.e., if you just run ``setup.py +install``\ ---then the :command:`install` command installs to the standard +location for third-party Python modules. This location varies by platform and +by how you built/installed Python itself. On Unix (and Mac OS X, which is also +Unix-based), it also depends on whether the module distribution being installed +is pure Python or contains extensions ("non-pure"): + +.. tabularcolumns:: |l|l|l|l| + ++-----------------+-----------------------------------------------------+--------------------------------------------------+-------+ +| Platform | Standard installation location | Default value | Notes | ++=================+=====================================================+==================================================+=======+ +| Unix (pure) | :file:`{prefix}/lib/python{X.Y}/site-packages` | :file:`/usr/local/lib/python{X.Y}/site-packages` | \(1) | ++-----------------+-----------------------------------------------------+--------------------------------------------------+-------+ +| Unix (non-pure) | :file:`{exec-prefix}/lib/python{X.Y}/site-packages` | :file:`/usr/local/lib/python{X.Y}/site-packages` | \(1) | ++-----------------+-----------------------------------------------------+--------------------------------------------------+-------+ +| Windows | :file:`{prefix}\\Lib\\site-packages` | :file:`C:\\Python{XY}\\Lib\\site-packages` | \(2) | ++-----------------+-----------------------------------------------------+--------------------------------------------------+-------+ + +Notes: + +(1) + Most Linux distributions include Python as a standard part of the system, so + :file:`{prefix}` and :file:`{exec-prefix}` are usually both :file:`/usr` on + Linux. If you build Python yourself on Linux (or any Unix-like system), the + default :file:`{prefix}` and :file:`{exec-prefix}` are :file:`/usr/local`. + +(2) + The default installation directory on Windows was :file:`C:\\Program + Files\\Python` under Python 1.6a1, 1.5.2, and earlier. + +:file:`{prefix}` and :file:`{exec-prefix}` stand for the directories that Python +is installed to, and where it finds its libraries at run-time. They are always +the same under Windows, and very often the same under Unix and Mac OS X. You +can find out what your Python installation uses for :file:`{prefix}` and +:file:`{exec-prefix}` by running Python in interactive mode and typing a few +simple commands. Under Unix, just type ``python`` at the shell prompt. Under +Windows, choose :menuselection:`Start --> Programs --> Python X.Y --> +Python (command line)`. Once the interpreter is started, you type Python code +at the prompt. For example, on my Linux system, I type the three Python +statements shown below, and get the output as shown, to find out my +:file:`{prefix}` and :file:`{exec-prefix}`: + +.. code-block:: pycon + + Python 2.4 (#26, Aug 7 2004, 17:19:02) + Type "help", "copyright", "credits" or "license" for more information. + >>> import sys + >>> sys.prefix + '/usr' + >>> sys.exec_prefix + '/usr' + +A few other placeholders are used in this document: :file:`{X.Y}` stands for the +version of Python, for example ``3.2``; :file:`{abiflags}` will be replaced by +the value of :data:`sys.abiflags` or the empty string for platforms which don't +define ABI flags; :file:`{distname}` will be replaced by the name of the module +distribution being installed. Dots and capitalization are important in the +paths; for example, a value that uses ``python3.2`` on UNIX will typically use +``Python32`` on Windows. + +If you don't want to install modules to the standard location, or if you don't +have permission to write there, then you need to read about alternate +installations in section :ref:`inst-alt-install`. If you want to customize your +installation directories more heavily, see section :ref:`inst-custom-install` on +custom installations. + + +.. _inst-alt-install: + +Alternate Installation +====================== + +Often, it is necessary or desirable to install modules to a location other than +the standard location for third-party Python modules. For example, on a Unix +system you might not have permission to write to the standard third-party module +directory. Or you might wish to try out a module before making it a standard +part of your local Python installation. This is especially true when upgrading +a distribution already present: you want to make sure your existing base of +scripts still works with the new version before actually upgrading. + +The Distutils :command:`install` command is designed to make installing module +distributions to an alternate location simple and painless. The basic idea is +that you supply a base directory for the installation, and the +:command:`install` command picks a set of directories (called an *installation +scheme*) under this base directory in which to install files. The details +differ across platforms, so read whichever of the following sections applies to +you. + +Note that the various alternate installation schemes are mutually exclusive: you +can pass ``--user``, or ``--home``, or ``--prefix`` and ``--exec-prefix``, or +``--install-base`` and ``--install-platbase``, but you can't mix from these +groups. + + +.. _inst-alt-install-user: + +Alternate installation: the user scheme +--------------------------------------- + +This scheme is designed to be the most convenient solution for users that don't +have write permission to the global site-packages directory or don't want to +install into it. It is enabled with a simple option:: + + python setup.py install --user + +Files will be installed into subdirectories of :data:`site.USER_BASE` (written +as :file:`{userbase}` hereafter). This scheme installs pure Python modules and +extension modules in the same location (also known as :data:`site.USER_SITE`). +Here are the values for UNIX, including Mac OS X: + +=============== =========================================================== +Type of file Installation directory +=============== =========================================================== +modules :file:`{userbase}/lib/python{X.Y}/site-packages` +scripts :file:`{userbase}/bin` +data :file:`{userbase}` +C headers :file:`{userbase}/include/python{X.Y}{abiflags}/{distname}` +=============== =========================================================== + +And here are the values used on Windows: + +=============== =========================================================== +Type of file Installation directory +=============== =========================================================== +modules :file:`{userbase}\\Python{XY}\\site-packages` +scripts :file:`{userbase}\\Python{XY}\\Scripts` +data :file:`{userbase}` +C headers :file:`{userbase}\\Python{XY}\\Include\\{distname}` +=============== =========================================================== + +The advantage of using this scheme compared to the other ones described below is +that the user site-packages directory is under normal conditions always included +in :data:`sys.path` (see :mod:`site` for more information), which means that +there is no additional step to perform after running the :file:`setup.py` script +to finalize the installation. + +The :command:`build_ext` command also has a ``--user`` option to add +:file:`{userbase}/include` to the compiler search path for header files and +:file:`{userbase}/lib` to the compiler search path for libraries as well as to +the runtime search path for shared C libraries (rpath). + + +.. _inst-alt-install-home: + +Alternate installation: the home scheme +--------------------------------------- + +The idea behind the "home scheme" is that you build and maintain a personal +stash of Python modules. This scheme's name is derived from the idea of a +"home" directory on Unix, since it's not unusual for a Unix user to make their +home directory have a layout similar to :file:`/usr/` or :file:`/usr/local/`. +This scheme can be used by anyone, regardless of the operating system they +are installing for. + +Installing a new module distribution is as simple as :: + + python setup.py install --home= + +where you can supply any directory you like for the :option:`!--home` option. On +Unix, lazy typists can just type a tilde (``~``); the :command:`install` command +will expand this to your home directory:: + + python setup.py install --home=~ + +To make Python find the distributions installed with this scheme, you may have +to :ref:`modify Python's search path ` or edit +:mod:`sitecustomize` (see :mod:`site`) to call :func:`site.addsitedir` or edit +:data:`sys.path`. + +The :option:`!--home` option defines the installation base directory. Files are +installed to the following directories under the installation base as follows: + +=============== =========================================================== +Type of file Installation directory +=============== =========================================================== +modules :file:`{home}/lib/python` +scripts :file:`{home}/bin` +data :file:`{home}` +C headers :file:`{home}/include/python/{distname}` +=============== =========================================================== + +(Mentally replace slashes with backslashes if you're on Windows.) + + +.. _inst-alt-install-prefix-unix: + +Alternate installation: Unix (the prefix scheme) +------------------------------------------------ + +The "prefix scheme" is useful when you wish to use one Python installation to +perform the build/install (i.e., to run the setup script), but install modules +into the third-party module directory of a different Python installation (or +something that looks like a different Python installation). If this sounds a +trifle unusual, it is---that's why the user and home schemes come before. However, +there are at least two known cases where the prefix scheme will be useful. + +First, consider that many Linux distributions put Python in :file:`/usr`, rather +than the more traditional :file:`/usr/local`. This is entirely appropriate, +since in those cases Python is part of "the system" rather than a local add-on. +However, if you are installing Python modules from source, you probably want +them to go in :file:`/usr/local/lib/python2.{X}` rather than +:file:`/usr/lib/python2.{X}`. This can be done with :: + + /usr/bin/python setup.py install --prefix=/usr/local + +Another possibility is a network filesystem where the name used to write to a +remote directory is different from the name used to read it: for example, the +Python interpreter accessed as :file:`/usr/local/bin/python` might search for +modules in :file:`/usr/local/lib/python2.{X}`, but those modules would have to +be installed to, say, :file:`/mnt/{@server}/export/lib/python2.{X}`. This could +be done with :: + + /usr/local/bin/python setup.py install --prefix=/mnt/@server/export + +In either case, the :option:`!--prefix` option defines the installation base, and +the :option:`!--exec-prefix` option defines the platform-specific installation +base, which is used for platform-specific files. (Currently, this just means +non-pure module distributions, but could be expanded to C libraries, binary +executables, etc.) If :option:`!--exec-prefix` is not supplied, it defaults to +:option:`!--prefix`. Files are installed as follows: + +================= ========================================================== +Type of file Installation directory +================= ========================================================== +Python modules :file:`{prefix}/lib/python{X.Y}/site-packages` +extension modules :file:`{exec-prefix}/lib/python{X.Y}/site-packages` +scripts :file:`{prefix}/bin` +data :file:`{prefix}` +C headers :file:`{prefix}/include/python{X.Y}{abiflags}/{distname}` +================= ========================================================== + +There is no requirement that :option:`!--prefix` or :option:`!--exec-prefix` +actually point to an alternate Python installation; if the directories listed +above do not already exist, they are created at installation time. + +Incidentally, the real reason the prefix scheme is important is simply that a +standard Unix installation uses the prefix scheme, but with :option:`!--prefix` +and :option:`!--exec-prefix` supplied by Python itself as ``sys.prefix`` and +``sys.exec_prefix``. Thus, you might think you'll never use the prefix scheme, +but every time you run ``python setup.py install`` without any other options, +you're using it. + +Note that installing extensions to an alternate Python installation has no +effect on how those extensions are built: in particular, the Python header files +(:file:`Python.h` and friends) installed with the Python interpreter used to run +the setup script will be used in compiling extensions. It is your +responsibility to ensure that the interpreter used to run extensions installed +in this way is compatible with the interpreter used to build them. The best way +to do this is to ensure that the two interpreters are the same version of Python +(possibly different builds, or possibly copies of the same build). (Of course, +if your :option:`!--prefix` and :option:`!--exec-prefix` don't even point to an +alternate Python installation, this is immaterial.) + + +.. _inst-alt-install-prefix-windows: + +Alternate installation: Windows (the prefix scheme) +--------------------------------------------------- + +Windows has no concept of a user's home directory, and since the standard Python +installation under Windows is simpler than under Unix, the :option:`!--prefix` +option has traditionally been used to install additional packages in separate +locations on Windows. :: + + python setup.py install --prefix="\Temp\Python" + +to install modules to the :file:`\\Temp\\Python` directory on the current drive. + +The installation base is defined by the :option:`!--prefix` option; the +:option:`!--exec-prefix` option is not supported under Windows, which means that +pure Python modules and extension modules are installed into the same location. +Files are installed as follows: + +=============== ========================================================== +Type of file Installation directory +=============== ========================================================== +modules :file:`{prefix}\\Lib\\site-packages` +scripts :file:`{prefix}\\Scripts` +data :file:`{prefix}` +C headers :file:`{prefix}\\Include\\{distname}` +=============== ========================================================== + + +.. _inst-custom-install: + +Custom Installation +=================== + +Sometimes, the alternate installation schemes described in section +:ref:`inst-alt-install` just don't do what you want. You might want to tweak just +one or two directories while keeping everything under the same base directory, +or you might want to completely redefine the installation scheme. In either +case, you're creating a *custom installation scheme*. + +To create a custom installation scheme, you start with one of the alternate +schemes and override some of the installation directories used for the various +types of files, using these options: + +====================== ======================= +Type of file Override option +====================== ======================= +Python modules ``--install-purelib`` +extension modules ``--install-platlib`` +all modules ``--install-lib`` +scripts ``--install-scripts`` +data ``--install-data`` +C headers ``--install-headers`` +====================== ======================= + +These override options can be relative, absolute, +or explicitly defined in terms of one of the installation base directories. +(There are two installation base directories, and they are normally the +same---they only differ when you use the Unix "prefix scheme" and supply +different ``--prefix`` and ``--exec-prefix`` options; using ``--install-lib`` +will override values computed or given for ``--install-purelib`` and +``--install-platlib``, and is recommended for schemes that don't make a +difference between Python and extension modules.) + +For example, say you're installing a module distribution to your home directory +under Unix---but you want scripts to go in :file:`~/scripts` rather than +:file:`~/bin`. As you might expect, you can override this directory with the +:option:`!--install-scripts` option; in this case, it makes most sense to supply +a relative path, which will be interpreted relative to the installation base +directory (your home directory, in this case):: + + python setup.py install --home=~ --install-scripts=scripts + +Another Unix example: suppose your Python installation was built and installed +with a prefix of :file:`/usr/local/python`, so under a standard installation +scripts will wind up in :file:`/usr/local/python/bin`. If you want them in +:file:`/usr/local/bin` instead, you would supply this absolute directory for the +:option:`!--install-scripts` option:: + + python setup.py install --install-scripts=/usr/local/bin + +(This performs an installation using the "prefix scheme," where the prefix is +whatever your Python interpreter was installed with--- :file:`/usr/local/python` +in this case.) + +If you maintain Python on Windows, you might want third-party modules to live in +a subdirectory of :file:`{prefix}`, rather than right in :file:`{prefix}` +itself. This is almost as easy as customizing the script installation +directory---you just have to remember that there are two types of modules +to worry about, Python and extension modules, which can conveniently be both +controlled by one option:: + + python setup.py install --install-lib=Site + +The specified installation directory is relative to :file:`{prefix}`. Of +course, you also have to ensure that this directory is in Python's module +search path, such as by putting a :file:`.pth` file in a site directory (see +:mod:`site`). See section :ref:`inst-search-path` to find out how to modify +Python's search path. + +If you want to define an entire installation scheme, you just have to supply all +of the installation directory options. The recommended way to do this is to +supply relative paths; for example, if you want to maintain all Python +module-related files under :file:`python` in your home directory, and you want a +separate directory for each platform that you use your home directory from, you +might define the following installation scheme:: + + python setup.py install --home=~ \ + --install-purelib=python/lib \ + --install-platlib=python/lib.$PLAT \ + --install-scripts=python/scripts + --install-data=python/data + +or, equivalently, :: + + python setup.py install --home=~/python \ + --install-purelib=lib \ + --install-platlib='lib.$PLAT' \ + --install-scripts=scripts + --install-data=data + +``$PLAT`` is not (necessarily) an environment variable---it will be expanded by +the Distutils as it parses your command line options, just as it does when +parsing your configuration file(s). + +Obviously, specifying the entire installation scheme every time you install a +new module distribution would be very tedious. Thus, you can put these options +into your Distutils config file (see section :ref:`inst-config-files`): + +.. code-block:: ini + + [install] + install-base=$HOME + install-purelib=python/lib + install-platlib=python/lib.$PLAT + install-scripts=python/scripts + install-data=python/data + +or, equivalently, + +.. code-block:: ini + + [install] + install-base=$HOME/python + install-purelib=lib + install-platlib=lib.$PLAT + install-scripts=scripts + install-data=data + +Note that these two are *not* equivalent if you supply a different installation +base directory when you run the setup script. For example, :: + + python setup.py install --install-base=/tmp + +would install pure modules to :file:`/tmp/python/lib` in the first case, and +to :file:`/tmp/lib` in the second case. (For the second case, you probably +want to supply an installation base of :file:`/tmp/python`.) + +You probably noticed the use of ``$HOME`` and ``$PLAT`` in the sample +configuration file input. These are Distutils configuration variables, which +bear a strong resemblance to environment variables. In fact, you can use +environment variables in config files on platforms that have such a notion but +the Distutils additionally define a few extra variables that may not be in your +environment, such as ``$PLAT``. (And of course, on systems that don't have +environment variables, such as Mac OS 9, the configuration variables supplied by +the Distutils are the only ones you can use.) See section :ref:`inst-config-files` +for details. + +.. note:: When a :ref:`virtual environment ` is activated, any options + that change the installation path will be ignored from all distutils configuration + files to prevent inadvertently installing projects outside of the virtual + environment. + +.. XXX need some Windows examples---when would custom installation schemes be + needed on those platforms? + + +.. XXX Move this to Doc/using + +.. _inst-search-path: + +Modifying Python's Search Path +------------------------------ + +When the Python interpreter executes an :keyword:`import` statement, it searches +for both Python code and extension modules along a search path. A default value +for the path is configured into the Python binary when the interpreter is built. +You can determine the path by importing the :mod:`sys` module and printing the +value of ``sys.path``. :: + + $ python + Python 2.2 (#11, Oct 3 2002, 13:31:27) + [GCC 2.96 20000731 (Red Hat Linux 7.3 2.96-112)] on linux2 + Type "help", "copyright", "credits" or "license" for more information. + >>> import sys + >>> sys.path + ['', '/usr/local/lib/python2.3', '/usr/local/lib/python2.3/plat-linux2', + '/usr/local/lib/python2.3/lib-tk', '/usr/local/lib/python2.3/lib-dynload', + '/usr/local/lib/python2.3/site-packages'] + >>> + +The null string in ``sys.path`` represents the current working directory. + +The expected convention for locally installed packages is to put them in the +:file:`{...}/site-packages/` directory, but you may want to install Python +modules into some arbitrary directory. For example, your site may have a +convention of keeping all software related to the web server under :file:`/www`. +Add-on Python modules might then belong in :file:`/www/python`, and in order to +import them, this directory must be added to ``sys.path``. There are several +different ways to add the directory. + +The most convenient way is to add a path configuration file to a directory +that's already on Python's path, usually to the :file:`.../site-packages/` +directory. Path configuration files have an extension of :file:`.pth`, and each +line must contain a single path that will be appended to ``sys.path``. (Because +the new paths are appended to ``sys.path``, modules in the added directories +will not override standard modules. This means you can't use this mechanism for +installing fixed versions of standard modules.) + +Paths can be absolute or relative, in which case they're relative to the +directory containing the :file:`.pth` file. See the documentation of +the :mod:`site` module for more information. + +A slightly less convenient way is to edit the :file:`site.py` file in Python's +standard library, and modify ``sys.path``. :file:`site.py` is automatically +imported when the Python interpreter is executed, unless the :option:`-S` switch +is supplied to suppress this behaviour. So you could simply edit +:file:`site.py` and add two lines to it: + +.. code-block:: python + + import sys + sys.path.append('/www/python/') + +However, if you reinstall the same major version of Python (perhaps when +upgrading from 2.2 to 2.2.2, for example) :file:`site.py` will be overwritten by +the stock version. You'd have to remember that it was modified and save a copy +before doing the installation. + +There are two environment variables that can modify ``sys.path``. +:envvar:`PYTHONHOME` sets an alternate value for the prefix of the Python +installation. For example, if :envvar:`PYTHONHOME` is set to ``/www/python``, +the search path will be set to ``['', '/www/python/lib/pythonX.Y/', +'/www/python/lib/pythonX.Y/plat-linux2', ...]``. + +The :envvar:`PYTHONPATH` variable can be set to a list of paths that will be +added to the beginning of ``sys.path``. For example, if :envvar:`PYTHONPATH` is +set to ``/www/python:/opt/py``, the search path will begin with +``['/www/python', '/opt/py']``. (Note that directories must exist in order to +be added to ``sys.path``; the :mod:`site` module removes paths that don't +exist.) + +Finally, ``sys.path`` is just a regular Python list, so any Python application +can modify it by adding or removing entries. + + +.. _inst-config-files: + +Distutils Configuration Files +============================= + +As mentioned above, you can use Distutils configuration files to record personal +or site preferences for any Distutils options. That is, any option to any +command can be stored in one of two or three (depending on your platform) +configuration files, which will be consulted before the command-line is parsed. +This means that configuration files will override default values, and the +command-line will in turn override configuration files. Furthermore, if +multiple configuration files apply, values from "earlier" files are overridden +by "later" files. + + +.. _inst-config-filenames: + +Location and names of config files +---------------------------------- + +The names and locations of the configuration files vary slightly across +platforms. On Unix and Mac OS X, the three configuration files (in the order +they are processed) are: + ++--------------+----------------------------------------------------------+-------+ +| Type of file | Location and filename | Notes | ++==============+==========================================================+=======+ +| system | :file:`{prefix}/lib/python{ver}/distutils/distutils.cfg` | \(1) | ++--------------+----------------------------------------------------------+-------+ +| personal | :file:`$HOME/.pydistutils.cfg` | \(2) | ++--------------+----------------------------------------------------------+-------+ +| local | :file:`setup.cfg` | \(3) | ++--------------+----------------------------------------------------------+-------+ + +And on Windows, the configuration files are: + ++--------------+-------------------------------------------------+-------+ +| Type of file | Location and filename | Notes | ++==============+=================================================+=======+ +| system | :file:`{prefix}\\Lib\\distutils\\distutils.cfg` | \(4) | ++--------------+-------------------------------------------------+-------+ +| personal | :file:`%HOME%\\pydistutils.cfg` | \(5) | ++--------------+-------------------------------------------------+-------+ +| local | :file:`setup.cfg` | \(3) | ++--------------+-------------------------------------------------+-------+ + +On all platforms, the "personal" file can be temporarily disabled by +passing the `--no-user-cfg` option. + +Notes: + +(1) + Strictly speaking, the system-wide configuration file lives in the directory + where the Distutils are installed; under Python 1.6 and later on Unix, this is + as shown. For Python 1.5.2, the Distutils will normally be installed to + :file:`{prefix}/lib/python1.5/site-packages/distutils`, so the system + configuration file should be put there under Python 1.5.2. + +(2) + On Unix, if the :envvar:`HOME` environment variable is not defined, the user's + home directory will be determined with the :func:`getpwuid` function from the + standard :mod:`pwd` module. This is done by the :func:`os.path.expanduser` + function used by Distutils. + +(3) + I.e., in the current directory (usually the location of the setup script). + +(4) + (See also note (1).) Under Python 1.6 and later, Python's default "installation + prefix" is :file:`C:\\Python`, so the system configuration file is normally + :file:`C:\\Python\\Lib\\distutils\\distutils.cfg`. Under Python 1.5.2, the + default prefix was :file:`C:\\Program Files\\Python`, and the Distutils were not + part of the standard library---so the system configuration file would be + :file:`C:\\Program Files\\Python\\distutils\\distutils.cfg` in a standard Python + 1.5.2 installation under Windows. + +(5) + On Windows, if the :envvar:`HOME` environment variable is not defined, + :envvar:`USERPROFILE` then :envvar:`HOMEDRIVE` and :envvar:`HOMEPATH` will + be tried. This is done by the :func:`os.path.expanduser` function used + by Distutils. + + +.. _inst-config-syntax: + +Syntax of config files +---------------------- + +The Distutils configuration files all have the same syntax. The config files +are grouped into sections. There is one section for each Distutils command, +plus a ``global`` section for global options that affect every command. Each +section consists of one option per line, specified as ``option=value``. + +For example, the following is a complete config file that just forces all +commands to run quietly by default: + +.. code-block:: ini + + [global] + verbose=0 + +If this is installed as the system config file, it will affect all processing of +any Python module distribution by any user on the current system. If it is +installed as your personal config file (on systems that support them), it will +affect only module distributions processed by you. And if it is used as the +:file:`setup.cfg` for a particular module distribution, it affects only that +distribution. + +You could override the default "build base" directory and make the +:command:`build\*` commands always forcibly rebuild all files with the +following: + +.. code-block:: ini + + [build] + build-base=blib + force=1 + +which corresponds to the command-line arguments :: + + python setup.py build --build-base=blib --force + +except that including the :command:`build` command on the command-line means +that command will be run. Including a particular command in config files has no +such implication; it only means that if the command is run, the options in the +config file will apply. (Or if other commands that derive values from it are +run, they will use the values in the config file.) + +You can find out the complete list of options for any command using the +:option:`!--help` option, e.g.:: + + python setup.py build --help + +and you can find out the complete list of global options by using +:option:`!--help` without a command:: + + python setup.py --help + +See also the "Reference" section of the "Distributing Python Modules" manual. + + +.. _inst-building-ext: + +Building Extensions: Tips and Tricks +==================================== + +Whenever possible, the Distutils try to use the configuration information made +available by the Python interpreter used to run the :file:`setup.py` script. +For example, the same compiler and linker flags used to compile Python will also +be used for compiling extensions. Usually this will work well, but in +complicated situations this might be inappropriate. This section discusses how +to override the usual Distutils behaviour. + + +.. _inst-tweak-flags: + +Tweaking compiler/linker flags +------------------------------ + +Compiling a Python extension written in C or C++ will sometimes require +specifying custom flags for the compiler and linker in order to use a particular +library or produce a special kind of object code. This is especially true if the +extension hasn't been tested on your platform, or if you're trying to +cross-compile Python. + +In the most general case, the extension author might have foreseen that +compiling the extensions would be complicated, and provided a :file:`Setup` file +for you to edit. This will likely only be done if the module distribution +contains many separate extension modules, or if they often require elaborate +sets of compiler flags in order to work. + +A :file:`Setup` file, if present, is parsed in order to get a list of extensions +to build. Each line in a :file:`Setup` describes a single module. Lines have +the following structure:: + + module ... [sourcefile ...] [cpparg ...] [library ...] + + +Let's examine each of the fields in turn. + +* *module* is the name of the extension module to be built, and should be a + valid Python identifier. You can't just change this in order to rename a module + (edits to the source code would also be needed), so this should be left alone. + +* *sourcefile* is anything that's likely to be a source code file, at least + judging by the filename. Filenames ending in :file:`.c` are assumed to be + written in C, filenames ending in :file:`.C`, :file:`.cc`, and :file:`.c++` are + assumed to be C++, and filenames ending in :file:`.m` or :file:`.mm` are assumed + to be in Objective C. + +* *cpparg* is an argument for the C preprocessor, and is anything starting with + :option:`!-I`, :option:`!-D`, :option:`!-U` or :option:`!-C`. + +* *library* is anything ending in :file:`.a` or beginning with :option:`!-l` or + :option:`!-L`. + +If a particular platform requires a special library on your platform, you can +add it by editing the :file:`Setup` file and running ``python setup.py build``. +For example, if the module defined by the line :: + + foo foomodule.c + +must be linked with the math library :file:`libm.a` on your platform, simply add +:option:`!-lm` to the line:: + + foo foomodule.c -lm + +Arbitrary switches intended for the compiler or the linker can be supplied with +the :option:`!-Xcompiler` *arg* and :option:`!-Xlinker` *arg* options:: + + foo foomodule.c -Xcompiler -o32 -Xlinker -shared -lm + +The next option after :option:`!-Xcompiler` and :option:`!-Xlinker` will be +appended to the proper command line, so in the above example the compiler will +be passed the :option:`!-o32` option, and the linker will be passed +:option:`!-shared`. If a compiler option requires an argument, you'll have to +supply multiple :option:`!-Xcompiler` options; for example, to pass ``-x c++`` +the :file:`Setup` file would have to contain ``-Xcompiler -x -Xcompiler c++``. + +Compiler flags can also be supplied through setting the :envvar:`CFLAGS` +environment variable. If set, the contents of :envvar:`CFLAGS` will be added to +the compiler flags specified in the :file:`Setup` file. + + +.. _inst-non-ms-compilers: + +Using non-Microsoft compilers on Windows +---------------------------------------- + +.. sectionauthor:: Rene Liebscher + + + +Borland/CodeGear C++ +^^^^^^^^^^^^^^^^^^^^ + +This subsection describes the necessary steps to use Distutils with the Borland +C++ compiler version 5.5. First you have to know that Borland's object file +format (OMF) is different from the format used by the Python version you can +download from the Python or ActiveState Web site. (Python is built with +Microsoft Visual C++, which uses COFF as the object file format.) For this +reason you have to convert Python's library :file:`python25.lib` into the +Borland format. You can do this as follows: + +.. Should we mention that users have to create cfg-files for the compiler? +.. see also http://community.borland.com/article/0,1410,21205,00.html + +:: + + coff2omf python25.lib python25_bcpp.lib + +The :file:`coff2omf` program comes with the Borland compiler. The file +:file:`python25.lib` is in the :file:`Libs` directory of your Python +installation. If your extension uses other libraries (zlib, ...) you have to +convert them too. + +The converted files have to reside in the same directories as the normal +libraries. + +How does Distutils manage to use these libraries with their changed names? If +the extension needs a library (eg. :file:`foo`) Distutils checks first if it +finds a library with suffix :file:`_bcpp` (eg. :file:`foo_bcpp.lib`) and then +uses this library. In the case it doesn't find such a special library it uses +the default name (:file:`foo.lib`.) [#]_ + +To let Distutils compile your extension with Borland C++ you now have to type:: + + python setup.py build --compiler=bcpp + +If you want to use the Borland C++ compiler as the default, you could specify +this in your personal or system-wide configuration file for Distutils (see +section :ref:`inst-config-files`.) + + +.. seealso:: + + `C++Builder Compiler `_ + Information about the free C++ compiler from Borland, including links to the + download pages. + + `Creating Python Extensions Using Borland's Free Compiler `_ + Document describing how to use Borland's free command-line C++ compiler to build + Python. + + +GNU C / Cygwin / MinGW +^^^^^^^^^^^^^^^^^^^^^^ + +This section describes the necessary steps to use Distutils with the GNU C/C++ +compilers in their Cygwin and MinGW distributions. [#]_ For a Python interpreter +that was built with Cygwin, everything should work without any of these +following steps. + +Not all extensions can be built with MinGW or Cygwin, but many can. Extensions +most likely to not work are those that use C++ or depend on Microsoft Visual C +extensions. + +To let Distutils compile your extension with Cygwin you have to type:: + + python setup.py build --compiler=cygwin + +and for Cygwin in no-cygwin mode [#]_ or for MinGW type:: + + python setup.py build --compiler=mingw32 + +If you want to use any of these options/compilers as default, you should +consider writing it in your personal or system-wide configuration file for +Distutils (see section :ref:`inst-config-files`.) + +Older Versions of Python and MinGW +"""""""""""""""""""""""""""""""""" +The following instructions only apply if you're using a version of Python +inferior to 2.4.1 with a MinGW inferior to 3.0.0 (with +binutils-2.13.90-20030111-1). + +These compilers require some special libraries. This task is more complex than +for Borland's C++, because there is no program to convert the library. First +you have to create a list of symbols which the Python DLL exports. (You can find +a good program for this task at +https://sourceforge.net/projects/mingw/files/MinGW/Extension/pexports/). + +.. I don't understand what the next line means. --amk +.. (inclusive the references on data structures.) + +:: + + pexports python25.dll >python25.def + +The location of an installed :file:`python25.dll` will depend on the +installation options and the version and language of Windows. In a "just for +me" installation, it will appear in the root of the installation directory. In +a shared installation, it will be located in the system directory. + +Then you can create from these information an import library for gcc. :: + + /cygwin/bin/dlltool --dllname python25.dll --def python25.def --output-lib libpython25.a + +The resulting library has to be placed in the same directory as +:file:`python25.lib`. (Should be the :file:`libs` directory under your Python +installation directory.) + +If your extension uses other libraries (zlib,...) you might have to convert +them too. The converted files have to reside in the same directories as the +normal libraries do. + + +.. seealso:: + + `Building Python modules on MS Windows platform with MinGW `_ + Information about building the required libraries for the MinGW environment. + + +.. rubric:: Footnotes + +.. [#] This also means you could replace all existing COFF-libraries with OMF-libraries + of the same name. + +.. [#] Check https://www.sourceware.org/cygwin/ and http://www.mingw.org/ for more + information + +.. [#] Then you have no POSIX emulation available, but you also don't need + :file:`cygwin1.dll`. diff --git a/python-3.7.4-docs-html/_sources/installing/index.rst.txt b/python-3.7.4-docs-html/_sources/installing/index.rst.txt new file mode 100644 index 0000000..8af828b --- /dev/null +++ b/python-3.7.4-docs-html/_sources/installing/index.rst.txt @@ -0,0 +1,246 @@ +.. highlightlang:: none + +.. _installing-index: + +************************* +Installing Python Modules +************************* + +:Email: distutils-sig@python.org + +As a popular open source development project, Python has an active +supporting community of contributors and users that also make their software +available for other Python developers to use under open source license terms. + +This allows Python users to share and collaborate effectively, benefiting +from the solutions others have already created to common (and sometimes +even rare!) problems, as well as potentially contributing their own +solutions to the common pool. + +This guide covers the installation part of the process. For a guide to +creating and sharing your own Python projects, refer to the +:ref:`distribution guide `. + +.. note:: + + For corporate and other institutional users, be aware that many + organisations have their own policies around using and contributing to + open source software. Please take such policies into account when making + use of the distribution and installation tools provided with Python. + + +Key terms +========= + +* ``pip`` is the preferred installer program. Starting with Python 3.4, it + is included by default with the Python binary installers. +* A *virtual environment* is a semi-isolated Python environment that allows + packages to be installed for use by a particular application, rather than + being installed system wide. +* ``venv`` is the standard tool for creating virtual environments, and has + been part of Python since Python 3.3. Starting with Python 3.4, it + defaults to installing ``pip`` into all created virtual environments. +* ``virtualenv`` is a third party alternative (and predecessor) to + ``venv``. It allows virtual environments to be used on versions of + Python prior to 3.4, which either don't provide ``venv`` at all, or + aren't able to automatically install ``pip`` into created environments. +* The `Python Packaging Index `__ is a public + repository of open source licensed packages made available for use by + other Python users. +* the `Python Packaging Authority + `__ is the group of + developers and documentation authors responsible for the maintenance and + evolution of the standard packaging tools and the associated metadata and + file format standards. They maintain a variety of tools, documentation, + and issue trackers on both `GitHub `__ and + `BitBucket `__. +* ``distutils`` is the original build and distribution system first added to + the Python standard library in 1998. While direct use of ``distutils`` is + being phased out, it still laid the foundation for the current packaging + and distribution infrastructure, and it not only remains part of the + standard library, but its name lives on in other ways (such as the name + of the mailing list used to coordinate Python packaging standards + development). + +.. deprecated:: 3.6 + ``pyvenv`` was the recommended tool for creating virtual environments for + Python 3.3 and 3.4, and is `deprecated in Python 3.6 + `_. + +.. versionchanged:: 3.5 + The use of ``venv`` is now recommended for creating virtual environments. + +.. seealso:: + + `Python Packaging User Guide: Creating and using virtual environments + `__ + + +Basic usage +=========== + +The standard packaging tools are all designed to be used from the command +line. + +The following command will install the latest version of a module and its +dependencies from the Python Packaging Index:: + + python -m pip install SomePackage + +.. note:: + + For POSIX users (including Mac OS X and Linux users), the examples in + this guide assume the use of a :term:`virtual environment`. + + For Windows users, the examples in this guide assume that the option to + adjust the system PATH environment variable was selected when installing + Python. + +It's also possible to specify an exact or minimum version directly on the +command line. When using comparator operators such as ``>``, ``<`` or some other +special character which get interpreted by shell, the package name and the +version should be enclosed within double quotes:: + + python -m pip install SomePackage==1.0.4 # specific version + python -m pip install "SomePackage>=1.0.4" # minimum version + +Normally, if a suitable module is already installed, attempting to install +it again will have no effect. Upgrading existing modules must be requested +explicitly:: + + python -m pip install --upgrade SomePackage + +More information and resources regarding ``pip`` and its capabilities can be +found in the `Python Packaging User Guide `__. + +Creation of virtual environments is done through the :mod:`venv` module. +Installing packages into an active virtual environment uses the commands shown +above. + +.. seealso:: + + `Python Packaging User Guide: Installing Python Distribution Packages + `__ + + +How do I ...? +============= + +These are quick answers or links for some common tasks. + +... install ``pip`` in versions of Python prior to Python 3.4? +-------------------------------------------------------------- + +Python only started bundling ``pip`` with Python 3.4. For earlier versions, +``pip`` needs to be "bootstrapped" as described in the Python Packaging +User Guide. + +.. seealso:: + + `Python Packaging User Guide: Requirements for Installing Packages + `__ + + +.. installing-per-user-installation: + +... install packages just for the current user? +----------------------------------------------- + +Passing the ``--user`` option to ``python -m pip install`` will install a +package just for the current user, rather than for all users of the system. + + +... install scientific Python packages? +--------------------------------------- + +A number of scientific Python packages have complex binary dependencies, and +aren't currently easy to install using ``pip`` directly. At this point in +time, it will often be easier for users to install these packages by +`other means `__ +rather than attempting to install them with ``pip``. + +.. seealso:: + + `Python Packaging User Guide: Installing Scientific Packages + `__ + + +... work with multiple versions of Python installed in parallel? +---------------------------------------------------------------- + +On Linux, Mac OS X, and other POSIX systems, use the versioned Python commands +in combination with the ``-m`` switch to run the appropriate copy of +``pip``:: + + python2 -m pip install SomePackage # default Python 2 + python2.7 -m pip install SomePackage # specifically Python 2.7 + python3 -m pip install SomePackage # default Python 3 + python3.4 -m pip install SomePackage # specifically Python 3.4 + +Appropriately versioned ``pip`` commands may also be available. + +On Windows, use the ``py`` Python launcher in combination with the ``-m`` +switch:: + + py -2 -m pip install SomePackage # default Python 2 + py -2.7 -m pip install SomePackage # specifically Python 2.7 + py -3 -m pip install SomePackage # default Python 3 + py -3.4 -m pip install SomePackage # specifically Python 3.4 + +.. other questions: + + Once the Development & Deployment part of PPUG is fleshed out, some of + those sections should be linked from new questions here (most notably, + we should have a question about avoiding depending on PyPI that links to + https://packaging.python.org/en/latest/mirrors/) + + +Common installation issues +========================== + +Installing into the system Python on Linux +------------------------------------------ + +On Linux systems, a Python installation will typically be included as part +of the distribution. Installing into this Python installation requires +root access to the system, and may interfere with the operation of the +system package manager and other components of the system if a component +is unexpectedly upgraded using ``pip``. + +On such systems, it is often better to use a virtual environment or a +per-user installation when installing packages with ``pip``. + + +Pip not installed +----------------- + +It is possible that ``pip`` does not get installed by default. One potential fix is:: + + python -m ensurepip --default-pip + +There are also additional resources for `installing pip. +`__ + + +Installing binary extensions +---------------------------- + +Python has typically relied heavily on source based distribution, with end +users being expected to compile extension modules from source as part of +the installation process. + +With the introduction of support for the binary ``wheel`` format, and the +ability to publish wheels for at least Windows and Mac OS X through the +Python Packaging Index, this problem is expected to diminish over time, +as users are more regularly able to install pre-built extensions rather +than needing to build them themselves. + +Some of the solutions for installing `scientific software +`__ +that are not yet available as pre-built ``wheel`` files may also help with +obtaining other binary extensions without needing to build them locally. + +.. seealso:: + + `Python Packaging User Guide: Binary Extensions + `__ diff --git a/python-3.7.4-docs-html/_sources/library/2to3.rst.txt b/python-3.7.4-docs-html/_sources/library/2to3.rst.txt new file mode 100644 index 0000000..fa4b0a9 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/2to3.rst.txt @@ -0,0 +1,474 @@ +.. _2to3-reference: + +2to3 - Automated Python 2 to 3 code translation +=============================================== + +.. sectionauthor:: Benjamin Peterson + +2to3 is a Python program that reads Python 2.x source code and applies a series +of *fixers* to transform it into valid Python 3.x code. The standard library +contains a rich set of fixers that will handle almost all code. 2to3 supporting +library :mod:`lib2to3` is, however, a flexible and generic library, so it is +possible to write your own fixers for 2to3. :mod:`lib2to3` could also be +adapted to custom applications in which Python code needs to be edited +automatically. + + +.. _2to3-using: + +Using 2to3 +---------- + +2to3 will usually be installed with the Python interpreter as a script. It is +also located in the :file:`Tools/scripts` directory of the Python root. + +2to3's basic arguments are a list of files or directories to transform. The +directories are recursively traversed for Python sources. + +Here is a sample Python 2.x source file, :file:`example.py`:: + + def greet(name): + print "Hello, {0}!".format(name) + print "What's your name?" + name = raw_input() + greet(name) + +It can be converted to Python 3.x code via 2to3 on the command line: + +.. code-block:: shell-session + + $ 2to3 example.py + +A diff against the original source file is printed. 2to3 can also write the +needed modifications right back to the source file. (A backup of the original +file is made unless :option:`!-n` is also given.) Writing the changes back is +enabled with the :option:`!-w` flag: + +.. code-block:: shell-session + + $ 2to3 -w example.py + +After transformation, :file:`example.py` looks like this:: + + def greet(name): + print("Hello, {0}!".format(name)) + print("What's your name?") + name = input() + greet(name) + +Comments and exact indentation are preserved throughout the translation process. + +By default, 2to3 runs a set of :ref:`predefined fixers <2to3-fixers>`. The +:option:`!-l` flag lists all available fixers. An explicit set of fixers to run +can be given with :option:`!-f`. Likewise the :option:`!-x` explicitly disables a +fixer. The following example runs only the ``imports`` and ``has_key`` fixers: + +.. code-block:: shell-session + + $ 2to3 -f imports -f has_key example.py + +This command runs every fixer except the ``apply`` fixer: + +.. code-block:: shell-session + + $ 2to3 -x apply example.py + +Some fixers are *explicit*, meaning they aren't run by default and must be +listed on the command line to be run. Here, in addition to the default fixers, +the ``idioms`` fixer is run: + +.. code-block:: shell-session + + $ 2to3 -f all -f idioms example.py + +Notice how passing ``all`` enables all default fixers. + +Sometimes 2to3 will find a place in your source code that needs to be changed, +but 2to3 cannot fix automatically. In this case, 2to3 will print a warning +beneath the diff for a file. You should address the warning in order to have +compliant 3.x code. + +2to3 can also refactor doctests. To enable this mode, use the :option:`!-d` +flag. Note that *only* doctests will be refactored. This also doesn't require +the module to be valid Python. For example, doctest like examples in a reST +document could also be refactored with this option. + +The :option:`!-v` option enables output of more information on the translation +process. + +Since some print statements can be parsed as function calls or statements, 2to3 +cannot always read files containing the print function. When 2to3 detects the +presence of the ``from __future__ import print_function`` compiler directive, it +modifies its internal grammar to interpret :func:`print` as a function. This +change can also be enabled manually with the :option:`!-p` flag. Use +:option:`!-p` to run fixers on code that already has had its print statements +converted. + +The :option:`!-o` or :option:`!--output-dir` option allows specification of an +alternate directory for processed output files to be written to. The +:option:`!-n` flag is required when using this as backup files do not make sense +when not overwriting the input files. + +.. versionadded:: 3.2.3 + The :option:`!-o` option was added. + +The :option:`!-W` or :option:`!--write-unchanged-files` flag tells 2to3 to always +write output files even if no changes were required to the file. This is most +useful with :option:`!-o` so that an entire Python source tree is copied with +translation from one directory to another. +This option implies the :option:`!-w` flag as it would not make sense otherwise. + +.. versionadded:: 3.2.3 + The :option:`!-W` flag was added. + +The :option:`!--add-suffix` option specifies a string to append to all output +filenames. The :option:`!-n` flag is required when specifying this as backups +are not necessary when writing to different filenames. Example: + +.. code-block:: shell-session + + $ 2to3 -n -W --add-suffix=3 example.py + +Will cause a converted file named ``example.py3`` to be written. + +.. versionadded:: 3.2.3 + The :option:`!--add-suffix` option was added. + +To translate an entire project from one directory tree to another use: + +.. code-block:: shell-session + + $ 2to3 --output-dir=python3-version/mycode -W -n python2-version/mycode + + +.. _2to3-fixers: + +Fixers +------ + +Each step of transforming code is encapsulated in a fixer. The command ``2to3 +-l`` lists them. As :ref:`documented above <2to3-using>`, each can be turned on +and off individually. They are described here in more detail. + + +.. 2to3fixer:: apply + + Removes usage of :func:`apply`. For example ``apply(function, *args, + **kwargs)`` is converted to ``function(*args, **kwargs)``. + +.. 2to3fixer:: asserts + + Replaces deprecated :mod:`unittest` method names with the correct ones. + + ================================ ========================================== + From To + ================================ ========================================== + ``failUnlessEqual(a, b)`` :meth:`assertEqual(a, b) + ` + ``assertEquals(a, b)`` :meth:`assertEqual(a, b) + ` + ``failIfEqual(a, b)`` :meth:`assertNotEqual(a, b) + ` + ``assertNotEquals(a, b)`` :meth:`assertNotEqual(a, b) + ` + ``failUnless(a)`` :meth:`assertTrue(a) + ` + ``assert_(a)`` :meth:`assertTrue(a) + ` + ``failIf(a)`` :meth:`assertFalse(a) + ` + ``failUnlessRaises(exc, cal)`` :meth:`assertRaises(exc, cal) + ` + ``failUnlessAlmostEqual(a, b)`` :meth:`assertAlmostEqual(a, b) + ` + ``assertAlmostEquals(a, b)`` :meth:`assertAlmostEqual(a, b) + ` + ``failIfAlmostEqual(a, b)`` :meth:`assertNotAlmostEqual(a, b) + ` + ``assertNotAlmostEquals(a, b)`` :meth:`assertNotAlmostEqual(a, b) + ` + ================================ ========================================== + +.. 2to3fixer:: basestring + + Converts :class:`basestring` to :class:`str`. + +.. 2to3fixer:: buffer + + Converts :class:`buffer` to :class:`memoryview`. This fixer is optional + because the :class:`memoryview` API is similar but not exactly the same as + that of :class:`buffer`. + +.. 2to3fixer:: dict + + Fixes dictionary iteration methods. :meth:`dict.iteritems` is converted to + :meth:`dict.items`, :meth:`dict.iterkeys` to :meth:`dict.keys`, and + :meth:`dict.itervalues` to :meth:`dict.values`. Similarly, + :meth:`dict.viewitems`, :meth:`dict.viewkeys` and :meth:`dict.viewvalues` are + converted respectively to :meth:`dict.items`, :meth:`dict.keys` and + :meth:`dict.values`. It also wraps existing usages of :meth:`dict.items`, + :meth:`dict.keys`, and :meth:`dict.values` in a call to :class:`list`. + +.. 2to3fixer:: except + + Converts ``except X, T`` to ``except X as T``. + +.. 2to3fixer:: exec + + Converts the ``exec`` statement to the :func:`exec` function. + +.. 2to3fixer:: execfile + + Removes usage of :func:`execfile`. The argument to :func:`execfile` is + wrapped in calls to :func:`open`, :func:`compile`, and :func:`exec`. + +.. 2to3fixer:: exitfunc + + Changes assignment of :attr:`sys.exitfunc` to use of the :mod:`atexit` + module. + +.. 2to3fixer:: filter + + Wraps :func:`filter` usage in a :class:`list` call. + +.. 2to3fixer:: funcattrs + + Fixes function attributes that have been renamed. For example, + ``my_function.func_closure`` is converted to ``my_function.__closure__``. + +.. 2to3fixer:: future + + Removes ``from __future__ import new_feature`` statements. + +.. 2to3fixer:: getcwdu + + Renames :func:`os.getcwdu` to :func:`os.getcwd`. + +.. 2to3fixer:: has_key + + Changes ``dict.has_key(key)`` to ``key in dict``. + +.. 2to3fixer:: idioms + + This optional fixer performs several transformations that make Python code + more idiomatic. Type comparisons like ``type(x) is SomeClass`` and + ``type(x) == SomeClass`` are converted to ``isinstance(x, SomeClass)``. + ``while 1`` becomes ``while True``. This fixer also tries to make use of + :func:`sorted` in appropriate places. For example, this block :: + + L = list(some_iterable) + L.sort() + + is changed to :: + + L = sorted(some_iterable) + +.. 2to3fixer:: import + + Detects sibling imports and converts them to relative imports. + +.. 2to3fixer:: imports + + Handles module renames in the standard library. + +.. 2to3fixer:: imports2 + + Handles other modules renames in the standard library. It is separate from + the :2to3fixer:`imports` fixer only because of technical limitations. + +.. 2to3fixer:: input + + Converts ``input(prompt)`` to ``eval(input(prompt))``. + +.. 2to3fixer:: intern + + Converts :func:`intern` to :func:`sys.intern`. + +.. 2to3fixer:: isinstance + + Fixes duplicate types in the second argument of :func:`isinstance`. For + example, ``isinstance(x, (int, int))`` is converted to ``isinstance(x, + int)`` and ``isinstance(x, (int, float, int))`` is converted to + ``isinstance(x, (int, float))``. + +.. 2to3fixer:: itertools_imports + + Removes imports of :func:`itertools.ifilter`, :func:`itertools.izip`, and + :func:`itertools.imap`. Imports of :func:`itertools.ifilterfalse` are also + changed to :func:`itertools.filterfalse`. + +.. 2to3fixer:: itertools + + Changes usage of :func:`itertools.ifilter`, :func:`itertools.izip`, and + :func:`itertools.imap` to their built-in equivalents. + :func:`itertools.ifilterfalse` is changed to :func:`itertools.filterfalse`. + +.. 2to3fixer:: long + + Renames :class:`long` to :class:`int`. + +.. 2to3fixer:: map + + Wraps :func:`map` in a :class:`list` call. It also changes ``map(None, x)`` + to ``list(x)``. Using ``from future_builtins import map`` disables this + fixer. + +.. 2to3fixer:: metaclass + + Converts the old metaclass syntax (``__metaclass__ = Meta`` in the class + body) to the new (``class X(metaclass=Meta)``). + +.. 2to3fixer:: methodattrs + + Fixes old method attribute names. For example, ``meth.im_func`` is converted + to ``meth.__func__``. + +.. 2to3fixer:: ne + + Converts the old not-equal syntax, ``<>``, to ``!=``. + +.. 2to3fixer:: next + + Converts the use of iterator's :meth:`~iterator.next` methods to the + :func:`next` function. It also renames :meth:`next` methods to + :meth:`~iterator.__next__`. + +.. 2to3fixer:: nonzero + + Renames :meth:`__nonzero__` to :meth:`~object.__bool__`. + +.. 2to3fixer:: numliterals + + Converts octal literals into the new syntax. + +.. 2to3fixer:: operator + + Converts calls to various functions in the :mod:`operator` module to other, + but equivalent, function calls. When needed, the appropriate ``import`` + statements are added, e.g. ``import collections.abc``. The following mapping + are made: + + ================================== ============================================= + From To + ================================== ============================================= + ``operator.isCallable(obj)`` ``callable(obj)`` + ``operator.sequenceIncludes(obj)`` ``operator.contains(obj)`` + ``operator.isSequenceType(obj)`` ``isinstance(obj, collections.abc.Sequence)`` + ``operator.isMappingType(obj)`` ``isinstance(obj, collections.abc.Mapping)`` + ``operator.isNumberType(obj)`` ``isinstance(obj, numbers.Number)`` + ``operator.repeat(obj, n)`` ``operator.mul(obj, n)`` + ``operator.irepeat(obj, n)`` ``operator.imul(obj, n)`` + ================================== ============================================= + +.. 2to3fixer:: paren + + Add extra parenthesis where they are required in list comprehensions. For + example, ``[x for x in 1, 2]`` becomes ``[x for x in (1, 2)]``. + +.. 2to3fixer:: print + + Converts the ``print`` statement to the :func:`print` function. + +.. 2to3fixer:: raise + + Converts ``raise E, V`` to ``raise E(V)``, and ``raise E, V, T`` to ``raise + E(V).with_traceback(T)``. If ``E`` is a tuple, the translation will be + incorrect because substituting tuples for exceptions has been removed in 3.0. + +.. 2to3fixer:: raw_input + + Converts :func:`raw_input` to :func:`input`. + +.. 2to3fixer:: reduce + + Handles the move of :func:`reduce` to :func:`functools.reduce`. + +.. 2to3fixer:: reload + + Converts :func:`reload` to :func:`importlib.reload`. + +.. 2to3fixer:: renames + + Changes :data:`sys.maxint` to :data:`sys.maxsize`. + +.. 2to3fixer:: repr + + Replaces backtick repr with the :func:`repr` function. + +.. 2to3fixer:: set_literal + + Replaces use of the :class:`set` constructor with set literals. This fixer + is optional. + +.. 2to3fixer:: standarderror + + Renames :exc:`StandardError` to :exc:`Exception`. + +.. 2to3fixer:: sys_exc + + Changes the deprecated :data:`sys.exc_value`, :data:`sys.exc_type`, + :data:`sys.exc_traceback` to use :func:`sys.exc_info`. + +.. 2to3fixer:: throw + + Fixes the API change in generator's :meth:`throw` method. + +.. 2to3fixer:: tuple_params + + Removes implicit tuple parameter unpacking. This fixer inserts temporary + variables. + +.. 2to3fixer:: types + + Fixes code broken from the removal of some members in the :mod:`types` + module. + +.. 2to3fixer:: unicode + + Renames :class:`unicode` to :class:`str`. + +.. 2to3fixer:: urllib + + Handles the rename of :mod:`urllib` and :mod:`urllib2` to the :mod:`urllib` + package. + +.. 2to3fixer:: ws_comma + + Removes excess whitespace from comma separated items. This fixer is + optional. + +.. 2to3fixer:: xrange + + Renames :func:`xrange` to :func:`range` and wraps existing :func:`range` + calls with :class:`list`. + +.. 2to3fixer:: xreadlines + + Changes ``for x in file.xreadlines()`` to ``for x in file``. + +.. 2to3fixer:: zip + + Wraps :func:`zip` usage in a :class:`list` call. This is disabled when + ``from future_builtins import zip`` appears. + + +:mod:`lib2to3` - 2to3's library +------------------------------- + +.. module:: lib2to3 + :synopsis: the 2to3 library + +.. moduleauthor:: Guido van Rossum +.. moduleauthor:: Collin Winter +.. moduleauthor:: Benjamin Peterson + +**Source code:** :source:`Lib/lib2to3/` + +-------------- + +.. note:: + + The :mod:`lib2to3` API should be considered unstable and may change + drastically in the future. + +.. XXX What is the public interface anyway? diff --git a/python-3.7.4-docs-html/_sources/library/__future__.rst.txt b/python-3.7.4-docs-html/_sources/library/__future__.rst.txt new file mode 100644 index 0000000..e3d749e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/__future__.rst.txt @@ -0,0 +1,103 @@ +:mod:`__future__` --- Future statement definitions +================================================== + +.. module:: __future__ + :synopsis: Future statement definitions + +**Source code:** :source:`Lib/__future__.py` + +-------------- + +:mod:`__future__` is a real module, and serves three purposes: + +* To avoid confusing existing tools that analyze import statements and expect to + find the modules they're importing. + +* To ensure that :ref:`future statements ` run under releases prior to + 2.1 at least yield runtime exceptions (the import of :mod:`__future__` will + fail, because there was no module of that name prior to 2.1). + +* To document when incompatible changes were introduced, and when they will be + --- or were --- made mandatory. This is a form of executable documentation, and + can be inspected programmatically via importing :mod:`__future__` and examining + its contents. + +Each statement in :file:`__future__.py` is of the form:: + + FeatureName = _Feature(OptionalRelease, MandatoryRelease, + CompilerFlag) + + +where, normally, *OptionalRelease* is less than *MandatoryRelease*, and both are +5-tuples of the same form as :data:`sys.version_info`:: + + (PY_MAJOR_VERSION, # the 2 in 2.1.0a3; an int + PY_MINOR_VERSION, # the 1; an int + PY_MICRO_VERSION, # the 0; an int + PY_RELEASE_LEVEL, # "alpha", "beta", "candidate" or "final"; string + PY_RELEASE_SERIAL # the 3; an int + ) + +*OptionalRelease* records the first release in which the feature was accepted. + +In the case of a *MandatoryRelease* that has not yet occurred, +*MandatoryRelease* predicts the release in which the feature will become part of +the language. + +Else *MandatoryRelease* records when the feature became part of the language; in +releases at or after that, modules no longer need a future statement to use the +feature in question, but may continue to use such imports. + +*MandatoryRelease* may also be ``None``, meaning that a planned feature got +dropped. + +Instances of class :class:`_Feature` have two corresponding methods, +:meth:`getOptionalRelease` and :meth:`getMandatoryRelease`. + +*CompilerFlag* is the (bitfield) flag that should be passed in the fourth +argument to the built-in function :func:`compile` to enable the feature in +dynamically compiled code. This flag is stored in the :attr:`compiler_flag` +attribute on :class:`_Feature` instances. + +No feature description will ever be deleted from :mod:`__future__`. Since its +introduction in Python 2.1 the following features have found their way into the +language using this mechanism: + ++------------------+-------------+--------------+---------------------------------------------+ +| feature | optional in | mandatory in | effect | ++==================+=============+==============+=============================================+ +| nested_scopes | 2.1.0b1 | 2.2 | :pep:`227`: | +| | | | *Statically Nested Scopes* | ++------------------+-------------+--------------+---------------------------------------------+ +| generators | 2.2.0a1 | 2.3 | :pep:`255`: | +| | | | *Simple Generators* | ++------------------+-------------+--------------+---------------------------------------------+ +| division | 2.2.0a2 | 3.0 | :pep:`238`: | +| | | | *Changing the Division Operator* | ++------------------+-------------+--------------+---------------------------------------------+ +| absolute_import | 2.5.0a1 | 3.0 | :pep:`328`: | +| | | | *Imports: Multi-Line and Absolute/Relative* | ++------------------+-------------+--------------+---------------------------------------------+ +| with_statement | 2.5.0a1 | 2.6 | :pep:`343`: | +| | | | *The "with" Statement* | ++------------------+-------------+--------------+---------------------------------------------+ +| print_function | 2.6.0a2 | 3.0 | :pep:`3105`: | +| | | | *Make print a function* | ++------------------+-------------+--------------+---------------------------------------------+ +| unicode_literals | 2.6.0a2 | 3.0 | :pep:`3112`: | +| | | | *Bytes literals in Python 3000* | ++------------------+-------------+--------------+---------------------------------------------+ +| generator_stop | 3.5.0b1 | 3.7 | :pep:`479`: | +| | | | *StopIteration handling inside generators* | ++------------------+-------------+--------------+---------------------------------------------+ +| annotations | 3.7.0b1 | 4.0 | :pep:`563`: | +| | | | *Postponed evaluation of annotations* | ++------------------+-------------+--------------+---------------------------------------------+ + +.. XXX Adding a new entry? Remember to update simple_stmts.rst, too. + + +.. seealso:: + + :ref:`future` + How the compiler treats future imports. diff --git a/python-3.7.4-docs-html/_sources/library/__main__.rst.txt b/python-3.7.4-docs-html/_sources/library/__main__.rst.txt new file mode 100644 index 0000000..a64faf1 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/__main__.rst.txt @@ -0,0 +1,25 @@ + +:mod:`__main__` --- Top-level script environment +================================================ + +.. module:: __main__ + :synopsis: The environment where the top-level script is run. + +-------------- + +``'__main__'`` is the name of the scope in which top-level code executes. +A module's __name__ is set equal to ``'__main__'`` when read from +standard input, a script, or from an interactive prompt. + +A module can discover whether or not it is running in the main scope by +checking its own ``__name__``, which allows a common idiom for conditionally +executing code in a module when it is run as a script or with ``python +-m`` but not when it is imported:: + + if __name__ == "__main__": + # execute only if run as a script + main() + +For a package, the same effect can be achieved by including a +``__main__.py`` module, the contents of which will be executed when the +module is run with ``-m``. diff --git a/python-3.7.4-docs-html/_sources/library/_dummy_thread.rst.txt b/python-3.7.4-docs-html/_sources/library/_dummy_thread.rst.txt new file mode 100644 index 0000000..7dccbc5 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/_dummy_thread.rst.txt @@ -0,0 +1,22 @@ +:mod:`_dummy_thread` --- Drop-in replacement for the :mod:`_thread` module +========================================================================== + +.. module:: _dummy_thread + :synopsis: Drop-in replacement for the _thread module. + +**Source code:** :source:`Lib/_dummy_thread.py` + +.. deprecated:: 3.7 + Python now always has threading enabled. Please use :mod:`_thread` + (or, better, :mod:`threading`) instead. + +-------------- + +This module provides a duplicate interface to the :mod:`_thread` module. +It was meant to be imported when the :mod:`_thread` module was not provided +on a platform. + +Be careful to not use this module where deadlock might occur from a thread being +created that blocks waiting for another thread to be created. This often occurs +with blocking I/O. + diff --git a/python-3.7.4-docs-html/_sources/library/_thread.rst.txt b/python-3.7.4-docs-html/_sources/library/_thread.rst.txt new file mode 100644 index 0000000..d1c28f4 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/_thread.rst.txt @@ -0,0 +1,193 @@ +:mod:`_thread` --- Low-level threading API +========================================== + +.. module:: _thread + :synopsis: Low-level threading API. + +.. index:: + single: light-weight processes + single: processes, light-weight + single: binary semaphores + single: semaphores, binary + +-------------- + +This module provides low-level primitives for working with multiple threads +(also called :dfn:`light-weight processes` or :dfn:`tasks`) --- multiple threads of +control sharing their global data space. For synchronization, simple locks +(also called :dfn:`mutexes` or :dfn:`binary semaphores`) are provided. +The :mod:`threading` module provides an easier to use and higher-level +threading API built on top of this module. + +.. index:: + single: pthreads + pair: threads; POSIX + +.. versionchanged:: 3.7 + This module used to be optional, it is now always available. + +This module defines the following constants and functions: + +.. exception:: error + + Raised on thread-specific errors. + + .. versionchanged:: 3.3 + This is now a synonym of the built-in :exc:`RuntimeError`. + + +.. data:: LockType + + This is the type of lock objects. + + +.. function:: start_new_thread(function, args[, kwargs]) + + Start a new thread and return its identifier. The thread executes the function + *function* with the argument list *args* (which must be a tuple). The optional + *kwargs* argument specifies a dictionary of keyword arguments. When the function + returns, the thread silently exits. When the function terminates with an + unhandled exception, a stack trace is printed and then the thread exits (but + other threads continue to run). + + +.. function:: interrupt_main() + + Simulate the effect of a :data:`signal.SIGINT` signal arriving in the main + thread. A thread can use this function to interrupt the main thread. + + If :data:`signal.SIGINT` isn't handled by Python (it was set to + :data:`signal.SIG_DFL` or :data:`signal.SIG_IGN`), this function does + nothing. + + +.. function:: exit() + + Raise the :exc:`SystemExit` exception. When not caught, this will cause the + thread to exit silently. + +.. + function:: exit_prog(status) + + Exit all threads and report the value of the integer argument + *status* as the exit status of the entire program. + **Caveat:** code in pending :keyword:`finally` clauses, in this thread + or in other threads, is not executed. + + +.. function:: allocate_lock() + + Return a new lock object. Methods of locks are described below. The lock is + initially unlocked. + + +.. function:: get_ident() + + Return the 'thread identifier' of the current thread. This is a nonzero + integer. Its value has no direct meaning; it is intended as a magic cookie to + be used e.g. to index a dictionary of thread-specific data. Thread identifiers + may be recycled when a thread exits and another thread is created. + + +.. function:: stack_size([size]) + + Return the thread stack size used when creating new threads. The optional + *size* argument specifies the stack size to be used for subsequently created + threads, and must be 0 (use platform or configured default) or a positive + integer value of at least 32,768 (32 KiB). If *size* is not specified, + 0 is used. If changing the thread stack size is + unsupported, a :exc:`RuntimeError` is raised. If the specified stack size is + invalid, a :exc:`ValueError` is raised and the stack size is unmodified. 32 KiB + is currently the minimum supported stack size value to guarantee sufficient + stack space for the interpreter itself. Note that some platforms may have + particular restrictions on values for the stack size, such as requiring a + minimum stack size > 32 KiB or requiring allocation in multiples of the system + memory page size - platform documentation should be referred to for more + information (4 KiB pages are common; using multiples of 4096 for the stack size is + the suggested approach in the absence of more specific information). + + .. availability:: Windows, systems with POSIX threads. + + +.. data:: TIMEOUT_MAX + + The maximum value allowed for the *timeout* parameter of + :meth:`Lock.acquire`. Specifying a timeout greater than this value will + raise an :exc:`OverflowError`. + + .. versionadded:: 3.2 + + +Lock objects have the following methods: + + +.. method:: lock.acquire(waitflag=1, timeout=-1) + + Without any optional argument, this method acquires the lock unconditionally, if + necessary waiting until it is released by another thread (only one thread at a + time can acquire a lock --- that's their reason for existence). + + If the integer *waitflag* argument is present, the action depends on its + value: if it is zero, the lock is only acquired if it can be acquired + immediately without waiting, while if it is nonzero, the lock is acquired + unconditionally as above. + + If the floating-point *timeout* argument is present and positive, it + specifies the maximum wait time in seconds before returning. A negative + *timeout* argument specifies an unbounded wait. You cannot specify + a *timeout* if *waitflag* is zero. + + The return value is ``True`` if the lock is acquired successfully, + ``False`` if not. + + .. versionchanged:: 3.2 + The *timeout* parameter is new. + + .. versionchanged:: 3.2 + Lock acquires can now be interrupted by signals on POSIX. + + +.. method:: lock.release() + + Releases the lock. The lock must have been acquired earlier, but not + necessarily by the same thread. + + +.. method:: lock.locked() + + Return the status of the lock: ``True`` if it has been acquired by some thread, + ``False`` if not. + +In addition to these methods, lock objects can also be used via the +:keyword:`with` statement, e.g.:: + + import _thread + + a_lock = _thread.allocate_lock() + + with a_lock: + print("a_lock is locked while this executes") + +**Caveats:** + + .. index:: module: signal + +* Threads interact strangely with interrupts: the :exc:`KeyboardInterrupt` + exception will be received by an arbitrary thread. (When the :mod:`signal` + module is available, interrupts always go to the main thread.) + +* Calling :func:`sys.exit` or raising the :exc:`SystemExit` exception is + equivalent to calling :func:`_thread.exit`. + +* It is not possible to interrupt the :meth:`acquire` method on a lock --- the + :exc:`KeyboardInterrupt` exception will happen after the lock has been acquired. + +* When the main thread exits, it is system defined whether the other threads + survive. On most systems, they are killed without executing + :keyword:`try` ... :keyword:`finally` clauses or executing object + destructors. + +* When the main thread exits, it does not do any of its usual cleanup (except + that :keyword:`try` ... :keyword:`finally` clauses are honored), and the + standard I/O files are not flushed. + diff --git a/python-3.7.4-docs-html/_sources/library/abc.rst.txt b/python-3.7.4-docs-html/_sources/library/abc.rst.txt new file mode 100644 index 0000000..fc39a2e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/abc.rst.txt @@ -0,0 +1,342 @@ +:mod:`abc` --- Abstract Base Classes +==================================== + +.. module:: abc + :synopsis: Abstract base classes according to PEP 3119. + +.. moduleauthor:: Guido van Rossum +.. sectionauthor:: Georg Brandl +.. much of the content adapted from docstrings + +**Source code:** :source:`Lib/abc.py` + +-------------- + +This module provides the infrastructure for defining :term:`abstract base +classes ` (ABCs) in Python, as outlined in :pep:`3119`; +see the PEP for why this was added to Python. (See also :pep:`3141` and the +:mod:`numbers` module regarding a type hierarchy for numbers based on ABCs.) + +The :mod:`collections` module has some concrete classes that derive from +ABCs; these can, of course, be further derived. In addition, the +:mod:`collections.abc` submodule has some ABCs that can be used to test whether +a class or instance provides a particular interface, for example, if it is +hashable or if it is a mapping. + + +This module provides the metaclass :class:`ABCMeta` for defining ABCs and +a helper class :class:`ABC` to alternatively define ABCs through inheritance: + +.. class:: ABC + + A helper class that has :class:`ABCMeta` as its metaclass. With this class, + an abstract base class can be created by simply deriving from :class:`ABC` + avoiding sometimes confusing metaclass usage, for example:: + + from abc import ABC + + class MyABC(ABC): + pass + + Note that the type of :class:`ABC` is still :class:`ABCMeta`, therefore + inheriting from :class:`ABC` requires the usual precautions regarding + metaclass usage, as multiple inheritance may lead to metaclass conflicts. + One may also define an abstract base class by passing the metaclass + keyword and using :class:`ABCMeta` directly, for example:: + + from abc import ABCMeta + + class MyABC(metaclass=ABCMeta): + pass + + .. versionadded:: 3.4 + + +.. class:: ABCMeta + + Metaclass for defining Abstract Base Classes (ABCs). + + Use this metaclass to create an ABC. An ABC can be subclassed directly, and + then acts as a mix-in class. You can also register unrelated concrete + classes (even built-in classes) and unrelated ABCs as "virtual subclasses" -- + these and their descendants will be considered subclasses of the registering + ABC by the built-in :func:`issubclass` function, but the registering ABC + won't show up in their MRO (Method Resolution Order) nor will method + implementations defined by the registering ABC be callable (not even via + :func:`super`). [#]_ + + Classes created with a metaclass of :class:`ABCMeta` have the following method: + + .. method:: register(subclass) + + Register *subclass* as a "virtual subclass" of this ABC. For + example:: + + from abc import ABC + + class MyABC(ABC): + pass + + MyABC.register(tuple) + + assert issubclass(tuple, MyABC) + assert isinstance((), MyABC) + + .. versionchanged:: 3.3 + Returns the registered subclass, to allow usage as a class decorator. + + .. versionchanged:: 3.4 + To detect calls to :meth:`register`, you can use the + :func:`get_cache_token` function. + + You can also override this method in an abstract base class: + + .. method:: __subclasshook__(subclass) + + (Must be defined as a class method.) + + Check whether *subclass* is considered a subclass of this ABC. This means + that you can customize the behavior of ``issubclass`` further without the + need to call :meth:`register` on every class you want to consider a + subclass of the ABC. (This class method is called from the + :meth:`__subclasscheck__` method of the ABC.) + + This method should return ``True``, ``False`` or ``NotImplemented``. If + it returns ``True``, the *subclass* is considered a subclass of this ABC. + If it returns ``False``, the *subclass* is not considered a subclass of + this ABC, even if it would normally be one. If it returns + ``NotImplemented``, the subclass check is continued with the usual + mechanism. + + .. XXX explain the "usual mechanism" + + + For a demonstration of these concepts, look at this example ABC definition:: + + class Foo: + def __getitem__(self, index): + ... + def __len__(self): + ... + def get_iterator(self): + return iter(self) + + class MyIterable(ABC): + + @abstractmethod + def __iter__(self): + while False: + yield None + + def get_iterator(self): + return self.__iter__() + + @classmethod + def __subclasshook__(cls, C): + if cls is MyIterable: + if any("__iter__" in B.__dict__ for B in C.__mro__): + return True + return NotImplemented + + MyIterable.register(Foo) + + The ABC ``MyIterable`` defines the standard iterable method, + :meth:`~iterator.__iter__`, as an abstract method. The implementation given + here can still be called from subclasses. The :meth:`get_iterator` method + is also part of the ``MyIterable`` abstract base class, but it does not have + to be overridden in non-abstract derived classes. + + The :meth:`__subclasshook__` class method defined here says that any class + that has an :meth:`~iterator.__iter__` method in its + :attr:`~object.__dict__` (or in that of one of its base classes, accessed + via the :attr:`~class.__mro__` list) is considered a ``MyIterable`` too. + + Finally, the last line makes ``Foo`` a virtual subclass of ``MyIterable``, + even though it does not define an :meth:`~iterator.__iter__` method (it uses + the old-style iterable protocol, defined in terms of :meth:`__len__` and + :meth:`__getitem__`). Note that this will not make ``get_iterator`` + available as a method of ``Foo``, so it is provided separately. + + + + +The :mod:`abc` module also provides the following decorator: + +.. decorator:: abstractmethod + + A decorator indicating abstract methods. + + Using this decorator requires that the class's metaclass is :class:`ABCMeta` + or is derived from it. A class that has a metaclass derived from + :class:`ABCMeta` cannot be instantiated unless all of its abstract methods + and properties are overridden. The abstract methods can be called using any + of the normal 'super' call mechanisms. :func:`abstractmethod` may be used + to declare abstract methods for properties and descriptors. + + Dynamically adding abstract methods to a class, or attempting to modify the + abstraction status of a method or class once it is created, are not + supported. The :func:`abstractmethod` only affects subclasses derived using + regular inheritance; "virtual subclasses" registered with the ABC's + :meth:`register` method are not affected. + + When :func:`abstractmethod` is applied in combination with other method + descriptors, it should be applied as the innermost decorator, as shown in + the following usage examples:: + + class C(ABC): + @abstractmethod + def my_abstract_method(self, ...): + ... + @classmethod + @abstractmethod + def my_abstract_classmethod(cls, ...): + ... + @staticmethod + @abstractmethod + def my_abstract_staticmethod(...): + ... + + @property + @abstractmethod + def my_abstract_property(self): + ... + @my_abstract_property.setter + @abstractmethod + def my_abstract_property(self, val): + ... + + @abstractmethod + def _get_x(self): + ... + @abstractmethod + def _set_x(self, val): + ... + x = property(_get_x, _set_x) + + In order to correctly interoperate with the abstract base class machinery, + the descriptor must identify itself as abstract using + :attr:`__isabstractmethod__`. In general, this attribute should be ``True`` + if any of the methods used to compose the descriptor are abstract. For + example, Python's built-in :class:`property` does the equivalent of:: + + class Descriptor: + ... + @property + def __isabstractmethod__(self): + return any(getattr(f, '__isabstractmethod__', False) for + f in (self._fget, self._fset, self._fdel)) + + .. note:: + + Unlike Java abstract methods, these abstract + methods may have an implementation. This implementation can be + called via the :func:`super` mechanism from the class that + overrides it. This could be useful as an end-point for a + super-call in a framework that uses cooperative + multiple-inheritance. + + +The :mod:`abc` module also supports the following legacy decorators: + +.. decorator:: abstractclassmethod + + .. versionadded:: 3.2 + .. deprecated:: 3.3 + It is now possible to use :class:`classmethod` with + :func:`abstractmethod`, making this decorator redundant. + + A subclass of the built-in :func:`classmethod`, indicating an abstract + classmethod. Otherwise it is similar to :func:`abstractmethod`. + + This special case is deprecated, as the :func:`classmethod` decorator + is now correctly identified as abstract when applied to an abstract + method:: + + class C(ABC): + @classmethod + @abstractmethod + def my_abstract_classmethod(cls, ...): + ... + + +.. decorator:: abstractstaticmethod + + .. versionadded:: 3.2 + .. deprecated:: 3.3 + It is now possible to use :class:`staticmethod` with + :func:`abstractmethod`, making this decorator redundant. + + A subclass of the built-in :func:`staticmethod`, indicating an abstract + staticmethod. Otherwise it is similar to :func:`abstractmethod`. + + This special case is deprecated, as the :func:`staticmethod` decorator + is now correctly identified as abstract when applied to an abstract + method:: + + class C(ABC): + @staticmethod + @abstractmethod + def my_abstract_staticmethod(...): + ... + + +.. decorator:: abstractproperty + + .. deprecated:: 3.3 + It is now possible to use :class:`property`, :meth:`property.getter`, + :meth:`property.setter` and :meth:`property.deleter` with + :func:`abstractmethod`, making this decorator redundant. + + A subclass of the built-in :func:`property`, indicating an abstract + property. + + This special case is deprecated, as the :func:`property` decorator + is now correctly identified as abstract when applied to an abstract + method:: + + class C(ABC): + @property + @abstractmethod + def my_abstract_property(self): + ... + + The above example defines a read-only property; you can also define a + read-write abstract property by appropriately marking one or more of the + underlying methods as abstract:: + + class C(ABC): + @property + def x(self): + ... + + @x.setter + @abstractmethod + def x(self, val): + ... + + If only some components are abstract, only those components need to be + updated to create a concrete property in a subclass:: + + class D(C): + @C.x.setter + def x(self, val): + ... + + +The :mod:`abc` module also provides the following functions: + +.. function:: get_cache_token() + + Returns the current abstract base class cache token. + + The token is an opaque object (that supports equality testing) identifying + the current version of the abstract base class cache for virtual subclasses. + The token changes with every call to :meth:`ABCMeta.register` on any ABC. + + .. versionadded:: 3.4 + + +.. rubric:: Footnotes + +.. [#] C++ programmers should note that Python's virtual base class + concept is not the same as C++'s. diff --git a/python-3.7.4-docs-html/_sources/library/aifc.rst.txt b/python-3.7.4-docs-html/_sources/library/aifc.rst.txt new file mode 100644 index 0000000..7328907 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/aifc.rst.txt @@ -0,0 +1,239 @@ +:mod:`aifc` --- Read and write AIFF and AIFC files +================================================== + +.. module:: aifc + :synopsis: Read and write audio files in AIFF or AIFC format. + +**Source code:** :source:`Lib/aifc.py` + +.. index:: + single: Audio Interchange File Format + single: AIFF + single: AIFF-C + +-------------- + +This module provides support for reading and writing AIFF and AIFF-C files. +AIFF is Audio Interchange File Format, a format for storing digital audio +samples in a file. AIFF-C is a newer version of the format that includes the +ability to compress the audio data. + +Audio files have a number of parameters that describe the audio data. The +sampling rate or frame rate is the number of times per second the sound is +sampled. The number of channels indicate if the audio is mono, stereo, or +quadro. Each frame consists of one sample per channel. The sample size is the +size in bytes of each sample. Thus a frame consists of +``nchannels * samplesize`` bytes, and a second's worth of audio consists of +``nchannels * samplesize * framerate`` bytes. + +For example, CD quality audio has a sample size of two bytes (16 bits), uses two +channels (stereo) and has a frame rate of 44,100 frames/second. This gives a +frame size of 4 bytes (2\*2), and a second's worth occupies 2\*2\*44100 bytes +(176,400 bytes). + +Module :mod:`aifc` defines the following function: + + +.. function:: open(file, mode=None) + + Open an AIFF or AIFF-C file and return an object instance with methods that are + described below. The argument *file* is either a string naming a file or a + :term:`file object`. *mode* must be ``'r'`` or ``'rb'`` when the file must be + opened for reading, or ``'w'`` or ``'wb'`` when the file must be opened for writing. + If omitted, ``file.mode`` is used if it exists, otherwise ``'rb'`` is used. When + used for writing, the file object should be seekable, unless you know ahead of + time how many samples you are going to write in total and use + :meth:`writeframesraw` and :meth:`setnframes`. + The :func:`.open` function may be used in a :keyword:`with` statement. When + the :keyword:`!with` block completes, the :meth:`~aifc.close` method is called. + + .. versionchanged:: 3.4 + Support for the :keyword:`with` statement was added. + +Objects returned by :func:`.open` when a file is opened for reading have the +following methods: + + +.. method:: aifc.getnchannels() + + Return the number of audio channels (1 for mono, 2 for stereo). + + +.. method:: aifc.getsampwidth() + + Return the size in bytes of individual samples. + + +.. method:: aifc.getframerate() + + Return the sampling rate (number of audio frames per second). + + +.. method:: aifc.getnframes() + + Return the number of audio frames in the file. + + +.. method:: aifc.getcomptype() + + Return a bytes array of length 4 describing the type of compression + used in the audio file. For AIFF files, the returned value is + ``b'NONE'``. + + +.. method:: aifc.getcompname() + + Return a bytes array convertible to a human-readable description + of the type of compression used in the audio file. For AIFF files, + the returned value is ``b'not compressed'``. + + +.. method:: aifc.getparams() + + Returns a :func:`~collections.namedtuple` ``(nchannels, sampwidth, + framerate, nframes, comptype, compname)``, equivalent to output of the + :meth:`get\*` methods. + + +.. method:: aifc.getmarkers() + + Return a list of markers in the audio file. A marker consists of a tuple of + three elements. The first is the mark ID (an integer), the second is the mark + position in frames from the beginning of the data (an integer), the third is the + name of the mark (a string). + + +.. method:: aifc.getmark(id) + + Return the tuple as described in :meth:`getmarkers` for the mark with the given + *id*. + + +.. method:: aifc.readframes(nframes) + + Read and return the next *nframes* frames from the audio file. The returned + data is a string containing for each frame the uncompressed samples of all + channels. + + +.. method:: aifc.rewind() + + Rewind the read pointer. The next :meth:`readframes` will start from the + beginning. + + +.. method:: aifc.setpos(pos) + + Seek to the specified frame number. + + +.. method:: aifc.tell() + + Return the current frame number. + + +.. method:: aifc.close() + + Close the AIFF file. After calling this method, the object can no longer be + used. + +Objects returned by :func:`.open` when a file is opened for writing have all the +above methods, except for :meth:`readframes` and :meth:`setpos`. In addition +the following methods exist. The :meth:`get\*` methods can only be called after +the corresponding :meth:`set\*` methods have been called. Before the first +:meth:`writeframes` or :meth:`writeframesraw`, all parameters except for the +number of frames must be filled in. + + +.. method:: aifc.aiff() + + Create an AIFF file. The default is that an AIFF-C file is created, unless the + name of the file ends in ``'.aiff'`` in which case the default is an AIFF file. + + +.. method:: aifc.aifc() + + Create an AIFF-C file. The default is that an AIFF-C file is created, unless + the name of the file ends in ``'.aiff'`` in which case the default is an AIFF + file. + + +.. method:: aifc.setnchannels(nchannels) + + Specify the number of channels in the audio file. + + +.. method:: aifc.setsampwidth(width) + + Specify the size in bytes of audio samples. + + +.. method:: aifc.setframerate(rate) + + Specify the sampling frequency in frames per second. + + +.. method:: aifc.setnframes(nframes) + + Specify the number of frames that are to be written to the audio file. If this + parameter is not set, or not set correctly, the file needs to support seeking. + + +.. method:: aifc.setcomptype(type, name) + + .. index:: + single: u-LAW + single: A-LAW + single: G.722 + + Specify the compression type. If not specified, the audio data will + not be compressed. In AIFF files, compression is not possible. + The name parameter should be a human-readable description of the + compression type as a bytes array, the type parameter should be a + bytes array of length 4. Currently the following compression types + are supported: ``b'NONE'``, ``b'ULAW'``, ``b'ALAW'``, ``b'G722'``. + + +.. method:: aifc.setparams(nchannels, sampwidth, framerate, comptype, compname) + + Set all the above parameters at once. The argument is a tuple consisting of the + various parameters. This means that it is possible to use the result of a + :meth:`getparams` call as argument to :meth:`setparams`. + + +.. method:: aifc.setmark(id, pos, name) + + Add a mark with the given id (larger than 0), and the given name at the given + position. This method can be called at any time before :meth:`close`. + + +.. method:: aifc.tell() + + Return the current write position in the output file. Useful in combination + with :meth:`setmark`. + + +.. method:: aifc.writeframes(data) + + Write data to the output file. This method can only be called after the audio + file parameters have been set. + + .. versionchanged:: 3.4 + Any :term:`bytes-like object` is now accepted. + + +.. method:: aifc.writeframesraw(data) + + Like :meth:`writeframes`, except that the header of the audio file is not + updated. + + .. versionchanged:: 3.4 + Any :term:`bytes-like object` is now accepted. + + +.. method:: aifc.close() + + Close the AIFF file. The header of the file is updated to reflect the actual + size of the audio data. After calling this method, the object can no longer be + used. + diff --git a/python-3.7.4-docs-html/_sources/library/allos.rst.txt b/python-3.7.4-docs-html/_sources/library/allos.rst.txt new file mode 100644 index 0000000..f7105d8 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/allos.rst.txt @@ -0,0 +1,29 @@ +.. _allos: + +********************************* +Generic Operating System Services +********************************* + +The modules described in this chapter provide interfaces to operating system +features that are available on (almost) all operating systems, such as files and +a clock. The interfaces are generally modeled after the Unix or C interfaces, +but they are available on most other systems as well. Here's an overview: + + +.. toctree:: + + os.rst + io.rst + time.rst + argparse.rst + getopt.rst + logging.rst + logging.config.rst + logging.handlers.rst + getpass.rst + curses.rst + curses.ascii.rst + curses.panel.rst + platform.rst + errno.rst + ctypes.rst diff --git a/python-3.7.4-docs-html/_sources/library/archiving.rst.txt b/python-3.7.4-docs-html/_sources/library/archiving.rst.txt new file mode 100644 index 0000000..c928494 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/archiving.rst.txt @@ -0,0 +1,20 @@ +.. _archiving: + +****************************** +Data Compression and Archiving +****************************** + +The modules described in this chapter support data compression with the zlib, +gzip, bzip2 and lzma algorithms, and the creation of ZIP- and tar-format +archives. See also :ref:`archiving-operations` provided by the :mod:`shutil` +module. + + +.. toctree:: + + zlib.rst + gzip.rst + bz2.rst + lzma.rst + zipfile.rst + tarfile.rst diff --git a/python-3.7.4-docs-html/_sources/library/argparse.rst.txt b/python-3.7.4-docs-html/_sources/library/argparse.rst.txt new file mode 100644 index 0000000..cef197f --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/argparse.rst.txt @@ -0,0 +1,2089 @@ +:mod:`argparse` --- Parser for command-line options, arguments and sub-commands +=============================================================================== + +.. module:: argparse + :synopsis: Command-line option and argument parsing library. + +.. moduleauthor:: Steven Bethard +.. sectionauthor:: Steven Bethard + +.. versionadded:: 3.2 + +**Source code:** :source:`Lib/argparse.py` + +-------------- + +.. sidebar:: Tutorial + + This page contains the API reference information. For a more gentle + introduction to Python command-line parsing, have a look at the + :ref:`argparse tutorial `. + +The :mod:`argparse` module makes it easy to write user-friendly command-line +interfaces. The program defines what arguments it requires, and :mod:`argparse` +will figure out how to parse those out of :data:`sys.argv`. The :mod:`argparse` +module also automatically generates help and usage messages and issues errors +when users give the program invalid arguments. + + +Example +------- + +The following code is a Python program that takes a list of integers and +produces either the sum or the max:: + + import argparse + + parser = argparse.ArgumentParser(description='Process some integers.') + parser.add_argument('integers', metavar='N', type=int, nargs='+', + 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)') + + args = parser.parse_args() + print(args.accumulate(args.integers)) + +Assuming the Python code above is saved into a file called ``prog.py``, it can +be run at the command line and provides useful help messages: + +.. code-block:: shell-session + + $ python prog.py -h + usage: prog.py [-h] [--sum] N [N ...] + + Process some integers. + + positional arguments: + N an integer for the accumulator + + optional arguments: + -h, --help show this help message and exit + --sum sum the integers (default: find the max) + +When run with the appropriate arguments, it prints either the sum or the max of +the command-line integers: + +.. code-block:: shell-session + + $ python prog.py 1 2 3 4 + 4 + + $ python prog.py 1 2 3 4 --sum + 10 + +If invalid arguments are passed in, it will issue an error: + +.. code-block:: shell-session + + $ python prog.py a b c + usage: prog.py [-h] [--sum] N [N ...] + prog.py: error: argument N: invalid int value: 'a' + +The following sections walk you through this example. + + +Creating a parser +^^^^^^^^^^^^^^^^^ + +The first step in using the :mod:`argparse` is creating an +:class:`ArgumentParser` object:: + + >>> parser = argparse.ArgumentParser(description='Process some integers.') + +The :class:`ArgumentParser` object will hold all the information necessary to +parse the command line into Python data types. + + +Adding arguments +^^^^^^^^^^^^^^^^ + +Filling an :class:`ArgumentParser` with information about program arguments is +done by making calls to the :meth:`~ArgumentParser.add_argument` method. +Generally, these calls tell the :class:`ArgumentParser` how to take the strings +on the command line and turn them into objects. This information is stored and +used when :meth:`~ArgumentParser.parse_args` is called. For example:: + + >>> parser.add_argument('integers', metavar='N', type=int, nargs='+', + ... 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)') + +Later, calling :meth:`~ArgumentParser.parse_args` will return an object with +two attributes, ``integers`` and ``accumulate``. The ``integers`` attribute +will be a list of one or more ints, and the ``accumulate`` attribute will be +either the :func:`sum` function, if ``--sum`` was specified at the command line, +or the :func:`max` function if it was not. + + +Parsing arguments +^^^^^^^^^^^^^^^^^ + +:class:`ArgumentParser` parses arguments through the +:meth:`~ArgumentParser.parse_args` method. This will inspect the command line, +convert each argument to the appropriate type and then invoke the appropriate action. +In most cases, this means a simple :class:`Namespace` object will be built up from +attributes parsed out of the command line:: + + >>> parser.parse_args(['--sum', '7', '-1', '42']) + Namespace(accumulate=, integers=[7, -1, 42]) + +In a script, :meth:`~ArgumentParser.parse_args` will typically be called with no +arguments, and the :class:`ArgumentParser` will automatically determine the +command-line arguments from :data:`sys.argv`. + + +ArgumentParser objects +---------------------- + +.. class:: ArgumentParser(prog=None, usage=None, description=None, \ + epilog=None, parents=[], \ + formatter_class=argparse.HelpFormatter, \ + prefix_chars='-', fromfile_prefix_chars=None, \ + argument_default=None, conflict_handler='error', \ + add_help=True, allow_abbrev=True) + + Create a new :class:`ArgumentParser` object. All parameters should be passed + as keyword arguments. Each parameter has its own more detailed description + below, but in short they are: + + * prog_ - The name of the program (default: ``sys.argv[0]``) + + * usage_ - The string describing the program usage (default: generated from + arguments added to parser) + + * description_ - Text to display before the argument help (default: none) + + * epilog_ - Text to display after the argument help (default: none) + + * parents_ - A list of :class:`ArgumentParser` objects whose arguments should + also be included + + * formatter_class_ - A class for customizing the help output + + * prefix_chars_ - The set of characters that prefix optional arguments + (default: '-') + + * fromfile_prefix_chars_ - The set of characters that prefix files from + which additional arguments should be read (default: ``None``) + + * argument_default_ - The global default value for arguments + (default: ``None``) + + * conflict_handler_ - The strategy for resolving conflicting optionals + (usually unnecessary) + + * add_help_ - Add a ``-h/--help`` option to the parser (default: ``True``) + + * allow_abbrev_ - Allows long options to be abbreviated if the + abbreviation is unambiguous. (default: ``True``) + + .. versionchanged:: 3.5 + *allow_abbrev* parameter was added. + +The following sections describe how each of these are used. + + +prog +^^^^ + +By default, :class:`ArgumentParser` objects use ``sys.argv[0]`` to determine +how to display the name of the program in help messages. This default is almost +always desirable because it will make the help messages match how the program was +invoked on the command line. For example, consider a file named +``myprogram.py`` with the following code:: + + import argparse + parser = argparse.ArgumentParser() + parser.add_argument('--foo', help='foo help') + args = parser.parse_args() + +The help for this program will display ``myprogram.py`` as the program name +(regardless of where the program was invoked from): + +.. code-block:: shell-session + + $ python myprogram.py --help + usage: myprogram.py [-h] [--foo FOO] + + optional arguments: + -h, --help show this help message and exit + --foo FOO foo help + $ cd .. + $ python subdir/myprogram.py --help + usage: myprogram.py [-h] [--foo FOO] + + optional arguments: + -h, --help show this help message and exit + --foo FOO foo help + +To change this default behavior, another value can be supplied using the +``prog=`` argument to :class:`ArgumentParser`:: + + >>> parser = argparse.ArgumentParser(prog='myprogram') + >>> parser.print_help() + usage: myprogram [-h] + + optional arguments: + -h, --help show this help message and exit + +Note that the program name, whether determined from ``sys.argv[0]`` or from the +``prog=`` argument, is available to help messages using the ``%(prog)s`` format +specifier. + +:: + + >>> parser = argparse.ArgumentParser(prog='myprogram') + >>> parser.add_argument('--foo', help='foo of the %(prog)s program') + >>> parser.print_help() + usage: myprogram [-h] [--foo FOO] + + optional arguments: + -h, --help show this help message and exit + --foo FOO foo of the myprogram program + + +usage +^^^^^ + +By default, :class:`ArgumentParser` calculates the usage message from the +arguments it contains:: + + >>> parser = argparse.ArgumentParser(prog='PROG') + >>> parser.add_argument('--foo', nargs='?', help='foo help') + >>> parser.add_argument('bar', nargs='+', help='bar help') + >>> parser.print_help() + usage: PROG [-h] [--foo [FOO]] bar [bar ...] + + positional arguments: + bar bar help + + optional arguments: + -h, --help show this help message and exit + --foo [FOO] foo help + +The default message can be overridden with the ``usage=`` keyword argument:: + + >>> parser = argparse.ArgumentParser(prog='PROG', usage='%(prog)s [options]') + >>> parser.add_argument('--foo', nargs='?', help='foo help') + >>> parser.add_argument('bar', nargs='+', help='bar help') + >>> parser.print_help() + usage: PROG [options] + + positional arguments: + bar bar help + + optional arguments: + -h, --help show this help message and exit + --foo [FOO] foo help + +The ``%(prog)s`` format specifier is available to fill in the program name in +your usage messages. + + +description +^^^^^^^^^^^ + +Most calls to the :class:`ArgumentParser` constructor will use the +``description=`` keyword argument. This argument gives a brief description of +what the program does and how it works. In help messages, the description is +displayed between the command-line usage string and the help messages for the +various arguments:: + + >>> parser = argparse.ArgumentParser(description='A foo that bars') + >>> parser.print_help() + usage: argparse.py [-h] + + A foo that bars + + optional arguments: + -h, --help show this help message and exit + +By default, the description will be line-wrapped so that it fits within the +given space. To change this behavior, see the formatter_class_ argument. + + +epilog +^^^^^^ + +Some programs like to display additional description of the program after the +description of the arguments. Such text can be specified using the ``epilog=`` +argument to :class:`ArgumentParser`:: + + >>> parser = argparse.ArgumentParser( + ... description='A foo that bars', + ... epilog="And that's how you'd foo a bar") + >>> parser.print_help() + usage: argparse.py [-h] + + A foo that bars + + optional arguments: + -h, --help show this help message and exit + + And that's how you'd foo a bar + +As with the description_ argument, the ``epilog=`` text is by default +line-wrapped, but this behavior can be adjusted with the formatter_class_ +argument to :class:`ArgumentParser`. + + +parents +^^^^^^^ + +Sometimes, several parsers share a common set of arguments. Rather than +repeating the definitions of these arguments, a single parser with all the +shared arguments and passed to ``parents=`` argument to :class:`ArgumentParser` +can be used. The ``parents=`` argument takes a list of :class:`ArgumentParser` +objects, collects all the positional and optional actions from them, and adds +these actions to the :class:`ArgumentParser` object being constructed:: + + >>> parent_parser = argparse.ArgumentParser(add_help=False) + >>> parent_parser.add_argument('--parent', type=int) + + >>> foo_parser = argparse.ArgumentParser(parents=[parent_parser]) + >>> foo_parser.add_argument('foo') + >>> foo_parser.parse_args(['--parent', '2', 'XXX']) + Namespace(foo='XXX', parent=2) + + >>> bar_parser = argparse.ArgumentParser(parents=[parent_parser]) + >>> bar_parser.add_argument('--bar') + >>> bar_parser.parse_args(['--bar', 'YYY']) + Namespace(bar='YYY', parent=None) + +Note that most parent parsers will specify ``add_help=False``. Otherwise, the +:class:`ArgumentParser` will see two ``-h/--help`` options (one in the parent +and one in the child) and raise an error. + +.. note:: + You must fully initialize the parsers before passing them via ``parents=``. + If you change the parent parsers after the child parser, those changes will + not be reflected in the child. + + +formatter_class +^^^^^^^^^^^^^^^ + +:class:`ArgumentParser` objects allow the help formatting to be customized by +specifying an alternate formatting class. Currently, there are four such +classes: + +.. class:: RawDescriptionHelpFormatter + RawTextHelpFormatter + ArgumentDefaultsHelpFormatter + MetavarTypeHelpFormatter + +:class:`RawDescriptionHelpFormatter` and :class:`RawTextHelpFormatter` give +more control over how textual descriptions are displayed. +By default, :class:`ArgumentParser` objects line-wrap the description_ and +epilog_ texts in command-line help messages:: + + >>> parser = argparse.ArgumentParser( + ... prog='PROG', + ... description='''this description + ... was indented weird + ... but that is okay''', + ... epilog=''' + ... likewise for this epilog whose whitespace will + ... be cleaned up and whose words will be wrapped + ... across a couple lines''') + >>> parser.print_help() + usage: PROG [-h] + + this description was indented weird but that is okay + + optional arguments: + -h, --help show this help message and exit + + likewise for this epilog whose whitespace will be cleaned up and whose words + will be wrapped across a couple lines + +Passing :class:`RawDescriptionHelpFormatter` as ``formatter_class=`` +indicates that description_ and epilog_ are already correctly formatted and +should not be line-wrapped:: + + >>> parser = argparse.ArgumentParser( + ... prog='PROG', + ... formatter_class=argparse.RawDescriptionHelpFormatter, + ... description=textwrap.dedent('''\ + ... Please do not mess up this text! + ... -------------------------------- + ... I have indented it + ... exactly the way + ... I want it + ... ''')) + >>> parser.print_help() + usage: PROG [-h] + + Please do not mess up this text! + -------------------------------- + I have indented it + exactly the way + I want it + + optional arguments: + -h, --help show this help message and exit + +:class:`RawTextHelpFormatter` maintains whitespace for all sorts of help text, +including argument descriptions. However, multiple new lines are replaced with +one. If you wish to preserve multiple blank lines, add spaces between the +newlines. + +:class:`ArgumentDefaultsHelpFormatter` automatically adds information about +default values to each of the argument help messages:: + + >>> parser = argparse.ArgumentParser( + ... prog='PROG', + ... formatter_class=argparse.ArgumentDefaultsHelpFormatter) + >>> parser.add_argument('--foo', type=int, default=42, help='FOO!') + >>> parser.add_argument('bar', nargs='*', default=[1, 2, 3], help='BAR!') + >>> parser.print_help() + usage: PROG [-h] [--foo FOO] [bar [bar ...]] + + positional arguments: + bar BAR! (default: [1, 2, 3]) + + optional arguments: + -h, --help show this help message and exit + --foo FOO FOO! (default: 42) + +:class:`MetavarTypeHelpFormatter` uses the name of the type_ argument for each +argument as the display name for its values (rather than using the dest_ +as the regular formatter does):: + + >>> parser = argparse.ArgumentParser( + ... prog='PROG', + ... formatter_class=argparse.MetavarTypeHelpFormatter) + >>> parser.add_argument('--foo', type=int) + >>> parser.add_argument('bar', type=float) + >>> parser.print_help() + usage: PROG [-h] [--foo int] float + + positional arguments: + float + + optional arguments: + -h, --help show this help message and exit + --foo int + + +prefix_chars +^^^^^^^^^^^^ + +Most command-line options will use ``-`` as the prefix, e.g. ``-f/--foo``. +Parsers that need to support different or additional prefix +characters, e.g. for options +like ``+f`` or ``/foo``, may specify them using the ``prefix_chars=`` argument +to the ArgumentParser constructor:: + + >>> parser = argparse.ArgumentParser(prog='PROG', prefix_chars='-+') + >>> parser.add_argument('+f') + >>> parser.add_argument('++bar') + >>> parser.parse_args('+f X ++bar Y'.split()) + Namespace(bar='Y', f='X') + +The ``prefix_chars=`` argument defaults to ``'-'``. Supplying a set of +characters that does not include ``-`` will cause ``-f/--foo`` options to be +disallowed. + + +fromfile_prefix_chars +^^^^^^^^^^^^^^^^^^^^^ + +Sometimes, for example when dealing with a particularly long argument lists, it +may make sense to keep the list of arguments in a file rather than typing it out +at the command line. If the ``fromfile_prefix_chars=`` argument is given to the +:class:`ArgumentParser` constructor, then arguments that start with any of the +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') + >>> parser = argparse.ArgumentParser(fromfile_prefix_chars='@') + >>> parser.add_argument('-f') + >>> parser.parse_args(['-f', 'foo', '@args.txt']) + Namespace(f='bar') + +Arguments read from a file must by default be one per line (but see also +:meth:`~ArgumentParser.convert_arg_line_to_args`) and are treated as if they +were in the same place as the original file referencing argument on the command +line. So in the example above, the expression ``['-f', 'foo', '@args.txt']`` +is considered equivalent to the expression ``['-f', 'foo', '-f', 'bar']``. + +The ``fromfile_prefix_chars=`` argument defaults to ``None``, meaning that +arguments will never be treated as file references. + + +argument_default +^^^^^^^^^^^^^^^^ + +Generally, argument defaults are specified either by passing a default to +:meth:`~ArgumentParser.add_argument` or by calling the +:meth:`~ArgumentParser.set_defaults` methods with a specific set of name-value +pairs. Sometimes however, it may be useful to specify a single parser-wide +default for arguments. This can be accomplished by passing the +``argument_default=`` keyword argument to :class:`ArgumentParser`. For example, +to globally suppress attribute creation on :meth:`~ArgumentParser.parse_args` +calls, we supply ``argument_default=SUPPRESS``:: + + >>> parser = argparse.ArgumentParser(argument_default=argparse.SUPPRESS) + >>> parser.add_argument('--foo') + >>> parser.add_argument('bar', nargs='?') + >>> parser.parse_args(['--foo', '1', 'BAR']) + Namespace(bar='BAR', foo='1') + >>> parser.parse_args([]) + Namespace() + +.. _allow_abbrev: + +allow_abbrev +^^^^^^^^^^^^ + +Normally, when you pass an argument list to the +:meth:`~ArgumentParser.parse_args` method of an :class:`ArgumentParser`, +it :ref:`recognizes abbreviations ` of long options. + +This feature can be disabled by setting ``allow_abbrev`` to ``False``:: + + >>> parser = argparse.ArgumentParser(prog='PROG', allow_abbrev=False) + >>> parser.add_argument('--foobar', action='store_true') + >>> parser.add_argument('--foonley', action='store_false') + >>> parser.parse_args(['--foon']) + usage: PROG [-h] [--foobar] [--foonley] + PROG: error: unrecognized arguments: --foon + +.. versionadded:: 3.5 + + +conflict_handler +^^^^^^^^^^^^^^^^ + +:class:`ArgumentParser` objects do not allow two actions with the same option +string. By default, :class:`ArgumentParser` objects raise an exception if an +attempt is made to create an argument with an option string that is already in +use:: + + >>> parser = argparse.ArgumentParser(prog='PROG') + >>> parser.add_argument('-f', '--foo', help='old foo help') + >>> parser.add_argument('--foo', help='new foo help') + Traceback (most recent call last): + .. + ArgumentError: argument --foo: conflicting option string(s): --foo + +Sometimes (e.g. when using parents_) it may be useful to simply override any +older arguments with the same option string. To get this behavior, the value +``'resolve'`` can be supplied to the ``conflict_handler=`` argument of +:class:`ArgumentParser`:: + + >>> parser = argparse.ArgumentParser(prog='PROG', conflict_handler='resolve') + >>> parser.add_argument('-f', '--foo', help='old foo help') + >>> parser.add_argument('--foo', help='new foo help') + >>> parser.print_help() + usage: PROG [-h] [-f FOO] [--foo FOO] + + optional arguments: + -h, --help show this help message and exit + -f FOO old foo help + --foo FOO new foo help + +Note that :class:`ArgumentParser` objects only remove an action if all of its +option strings are overridden. So, in the example above, the old ``-f/--foo`` +action is retained as the ``-f`` action, because only the ``--foo`` option +string was overridden. + + +add_help +^^^^^^^^ + +By default, ArgumentParser objects add an option which simply displays +the parser's help message. For example, consider a file named +``myprogram.py`` containing the following code:: + + import argparse + parser = argparse.ArgumentParser() + parser.add_argument('--foo', help='foo help') + args = parser.parse_args() + +If ``-h`` or ``--help`` is supplied at the command line, the ArgumentParser +help will be printed: + +.. code-block:: shell-session + + $ python myprogram.py --help + usage: myprogram.py [-h] [--foo FOO] + + optional arguments: + -h, --help show this help message and exit + --foo FOO foo help + +Occasionally, it may be useful to disable the addition of this help option. +This can be achieved by passing ``False`` as the ``add_help=`` argument to +:class:`ArgumentParser`:: + + >>> parser = argparse.ArgumentParser(prog='PROG', add_help=False) + >>> parser.add_argument('--foo', help='foo help') + >>> parser.print_help() + usage: PROG [--foo FOO] + + optional arguments: + --foo FOO foo help + +The help option is typically ``-h/--help``. The exception to this is +if the ``prefix_chars=`` is specified and does not include ``-``, in +which case ``-h`` and ``--help`` are not valid options. In +this case, the first character in ``prefix_chars`` is used to prefix +the help options:: + + >>> parser = argparse.ArgumentParser(prog='PROG', prefix_chars='+/') + >>> parser.print_help() + usage: PROG [+h] + + optional arguments: + +h, ++help show this help message and exit + + +The add_argument() method +------------------------- + +.. method:: ArgumentParser.add_argument(name or flags..., [action], [nargs], \ + [const], [default], [type], [choices], [required], \ + [help], [metavar], [dest]) + + Define how a single command-line argument should be parsed. Each parameter + has its own more detailed description below, but in short they are: + + * `name or flags`_ - Either a name or a list of option strings, e.g. ``foo`` + or ``-f, --foo``. + + * action_ - The basic type of action to be taken when this argument is + encountered at the command line. + + * nargs_ - The number of command-line arguments that should be consumed. + + * const_ - A constant value required by some action_ and nargs_ selections. + + * default_ - The value produced if the argument is absent from the + command line. + + * type_ - The type to which the command-line argument should be converted. + + * choices_ - A container of the allowable values for the argument. + + * required_ - Whether or not the command-line option may be omitted + (optionals only). + + * help_ - A brief description of what the argument does. + + * metavar_ - A name for the argument in usage messages. + + * dest_ - The name of the attribute to be added to the object returned by + :meth:`parse_args`. + +The following sections describe how each of these are used. + + +name or flags +^^^^^^^^^^^^^ + +The :meth:`~ArgumentParser.add_argument` method must know whether an optional +argument, like ``-f`` or ``--foo``, or a positional argument, like a list of +filenames, is expected. The first arguments passed to +:meth:`~ArgumentParser.add_argument` must therefore be either a series of +flags, or a simple argument name. For example, an optional argument could +be created like:: + + >>> parser.add_argument('-f', '--foo') + +while a positional argument could be created like:: + + >>> parser.add_argument('bar') + +When :meth:`~ArgumentParser.parse_args` is called, optional arguments will be +identified by the ``-`` prefix, and the remaining arguments will be assumed to +be positional:: + + >>> parser = argparse.ArgumentParser(prog='PROG') + >>> parser.add_argument('-f', '--foo') + >>> parser.add_argument('bar') + >>> parser.parse_args(['BAR']) + Namespace(bar='BAR', foo=None) + >>> parser.parse_args(['BAR', '--foo', 'FOO']) + Namespace(bar='BAR', foo='FOO') + >>> parser.parse_args(['--foo', 'FOO']) + usage: PROG [-h] [-f FOO] bar + PROG: error: the following arguments are required: bar + + +action +^^^^^^ + +:class:`ArgumentParser` objects associate command-line arguments with actions. These +actions can do just about anything with the command-line arguments associated with +them, though most actions simply add an attribute to the object returned by +:meth:`~ArgumentParser.parse_args`. The ``action`` keyword argument specifies +how the command-line arguments should be handled. The supplied actions are: + +* ``'store'`` - This just stores the argument's value. This is the default + action. For example:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--foo') + >>> parser.parse_args('--foo 1'.split()) + Namespace(foo='1') + +* ``'store_const'`` - This stores the value specified by the const_ keyword + argument. The ``'store_const'`` action is most commonly used with + optional arguments that specify some sort of flag. For example:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--foo', action='store_const', const=42) + >>> parser.parse_args(['--foo']) + Namespace(foo=42) + +* ``'store_true'`` and ``'store_false'`` - These are special cases of + ``'store_const'`` used for storing the values ``True`` and ``False`` + respectively. In addition, they create default values of ``False`` and + ``True`` respectively. For example:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--foo', action='store_true') + >>> parser.add_argument('--bar', action='store_false') + >>> parser.add_argument('--baz', action='store_false') + >>> parser.parse_args('--foo --bar'.split()) + Namespace(foo=True, bar=False, baz=True) + +* ``'append'`` - This stores a list, and appends each argument value to the + list. This is useful to allow an option to be specified multiple times. + Example usage:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--foo', action='append') + >>> parser.parse_args('--foo 1 --foo 2'.split()) + Namespace(foo=['1', '2']) + +* ``'append_const'`` - This stores a list, and appends the value specified by + the const_ keyword argument to the list. (Note that the const_ keyword + argument defaults to ``None``.) The ``'append_const'`` action is typically + useful when multiple arguments need to store constants to the same list. For + example:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--str', dest='types', action='append_const', const=str) + >>> parser.add_argument('--int', dest='types', action='append_const', const=int) + >>> parser.parse_args('--str --int'.split()) + Namespace(types=[, ]) + +* ``'count'`` - This counts the number of times a keyword argument occurs. For + example, this is useful for increasing verbosity levels:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--verbose', '-v', action='count') + >>> parser.parse_args(['-vvv']) + Namespace(verbose=3) + +* ``'help'`` - This prints a complete help message for all the options in the + current parser and then exits. By default a help action is automatically + added to the parser. See :class:`ArgumentParser` for details of how the + output is created. + +* ``'version'`` - This expects a ``version=`` keyword argument in the + :meth:`~ArgumentParser.add_argument` call, and prints version information + and exits when invoked:: + + >>> import argparse + >>> parser = argparse.ArgumentParser(prog='PROG') + >>> parser.add_argument('--version', action='version', version='%(prog)s 2.0') + >>> parser.parse_args(['--version']) + PROG 2.0 + +You may also specify an arbitrary action by passing an Action subclass or +other object that implements the same interface. The recommended way to do +this is to extend :class:`Action`, overriding the ``__call__`` method +and optionally the ``__init__`` method. + +An example of a custom action:: + + >>> class FooAction(argparse.Action): + ... def __init__(self, option_strings, dest, nargs=None, **kwargs): + ... if nargs is not None: + ... raise ValueError("nargs not allowed") + ... super(FooAction, self).__init__(option_strings, dest, **kwargs) + ... def __call__(self, parser, namespace, values, option_string=None): + ... print('%r %r %r' % (namespace, values, option_string)) + ... setattr(namespace, self.dest, values) + ... + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--foo', action=FooAction) + >>> parser.add_argument('bar', action=FooAction) + >>> args = parser.parse_args('1 --foo 2'.split()) + Namespace(bar=None, foo=None) '1' None + Namespace(bar='1', foo=None) '2' '--foo' + >>> args + Namespace(bar='1', foo='2') + +For more details, see :class:`Action`. + +nargs +^^^^^ + +ArgumentParser objects usually associate a single command-line argument with a +single action to be taken. The ``nargs`` keyword argument associates a +different number of command-line arguments with a single action. The supported +values are: + +* ``N`` (an integer). ``N`` arguments from the command line will be gathered + together into a list. For example:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--foo', nargs=2) + >>> parser.add_argument('bar', nargs=1) + >>> parser.parse_args('c --foo a b'.split()) + Namespace(bar=['c'], foo=['a', 'b']) + + Note that ``nargs=1`` produces a list of one item. This is different from + the default, in which the item is produced by itself. + +.. index:: single: ? (question mark); in argparse module + +* ``'?'``. One argument will be consumed from the command line if possible, and + produced as a single item. If no command-line argument is present, the value from + default_ will be produced. Note that for optional arguments, there is an + additional case - the option string is present but not followed by a + command-line argument. In this case the value from const_ will be produced. Some + examples to illustrate this:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--foo', nargs='?', const='c', default='d') + >>> parser.add_argument('bar', nargs='?', default='d') + >>> parser.parse_args(['XX', '--foo', 'YY']) + Namespace(bar='XX', foo='YY') + >>> parser.parse_args(['XX', '--foo']) + Namespace(bar='XX', foo='c') + >>> parser.parse_args([]) + Namespace(bar='d', foo='d') + + One of the more common uses of ``nargs='?'`` is to allow optional input and + output files:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('infile', nargs='?', type=argparse.FileType('r'), + ... default=sys.stdin) + >>> parser.add_argument('outfile', nargs='?', type=argparse.FileType('w'), + ... default=sys.stdout) + >>> parser.parse_args(['input.txt', 'output.txt']) + Namespace(infile=<_io.TextIOWrapper name='input.txt' encoding='UTF-8'>, + outfile=<_io.TextIOWrapper name='output.txt' encoding='UTF-8'>) + >>> parser.parse_args([]) + Namespace(infile=<_io.TextIOWrapper name='' encoding='UTF-8'>, + outfile=<_io.TextIOWrapper name='' encoding='UTF-8'>) + +.. index:: single: * (asterisk); in argparse module + +* ``'*'``. All command-line arguments present are gathered into a list. Note that + it generally doesn't make much sense to have more than one positional argument + with ``nargs='*'``, but multiple optional arguments with ``nargs='*'`` is + possible. For example:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--foo', nargs='*') + >>> parser.add_argument('--bar', nargs='*') + >>> parser.add_argument('baz', nargs='*') + >>> parser.parse_args('a b --foo x y --bar 1 2'.split()) + Namespace(bar=['1', '2'], baz=['a', 'b'], foo=['x', 'y']) + +.. index:: single: + (plus); in argparse module + +* ``'+'``. Just like ``'*'``, all command-line args present are gathered into a + list. Additionally, an error message will be generated if there wasn't at + least one command-line argument present. For example:: + + >>> parser = argparse.ArgumentParser(prog='PROG') + >>> parser.add_argument('foo', nargs='+') + >>> parser.parse_args(['a', 'b']) + Namespace(foo=['a', 'b']) + >>> parser.parse_args([]) + usage: PROG [-h] foo [foo ...] + PROG: error: the following arguments are required: foo + +.. _`argparse.REMAINDER`: + +* ``argparse.REMAINDER``. All the remaining command-line arguments are gathered + into a list. This is commonly useful for command line utilities that dispatch + to other command line utilities:: + + >>> parser = argparse.ArgumentParser(prog='PROG') + >>> parser.add_argument('--foo') + >>> parser.add_argument('command') + >>> parser.add_argument('args', nargs=argparse.REMAINDER) + >>> print(parser.parse_args('--foo B cmd --arg1 XX ZZ'.split())) + Namespace(args=['--arg1', 'XX', 'ZZ'], command='cmd', foo='B') + +If the ``nargs`` keyword argument is not provided, the number of arguments consumed +is determined by the action_. Generally this means a single command-line argument +will be consumed and a single item (not a list) will be produced. + + +const +^^^^^ + +The ``const`` argument of :meth:`~ArgumentParser.add_argument` is used to hold +constant values that are not read from the command line but are required for +the various :class:`ArgumentParser` actions. The two most common uses of it are: + +* When :meth:`~ArgumentParser.add_argument` is called with + ``action='store_const'`` or ``action='append_const'``. These actions add the + ``const`` value to one of the attributes of the object returned by + :meth:`~ArgumentParser.parse_args`. See the action_ description for examples. + +* When :meth:`~ArgumentParser.add_argument` is called with option strings + (like ``-f`` or ``--foo``) and ``nargs='?'``. This creates an optional + argument that can be followed by zero or one command-line arguments. + When parsing the command line, if the option string is encountered with no + command-line argument following it, the value of ``const`` will be assumed instead. + See the nargs_ description for examples. + +With the ``'store_const'`` and ``'append_const'`` actions, the ``const`` +keyword argument must be given. For other actions, it defaults to ``None``. + + +default +^^^^^^^ + +All optional arguments and some positional arguments may be omitted at the +command line. The ``default`` keyword argument of +:meth:`~ArgumentParser.add_argument`, whose value defaults to ``None``, +specifies what value should be used if the command-line argument is not present. +For optional arguments, the ``default`` value is used when the option string +was not present at the command line:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--foo', default=42) + >>> parser.parse_args(['--foo', '2']) + Namespace(foo='2') + >>> parser.parse_args([]) + Namespace(foo=42) + +If the ``default`` value is a string, the parser parses the value as if it +were a command-line argument. In particular, the parser applies any type_ +conversion argument, if provided, before setting the attribute on the +:class:`Namespace` return value. Otherwise, the parser uses the value as is:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--length', default='10', type=int) + >>> parser.add_argument('--width', default=10.5, type=int) + >>> parser.parse_args() + Namespace(length=10, width=10.5) + +For positional arguments with nargs_ equal to ``?`` or ``*``, the ``default`` value +is used when no command-line argument was present:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('foo', nargs='?', default=42) + >>> parser.parse_args(['a']) + Namespace(foo='a') + >>> parser.parse_args([]) + Namespace(foo=42) + + +Providing ``default=argparse.SUPPRESS`` causes no attribute to be added if the +command-line argument was not present:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--foo', default=argparse.SUPPRESS) + >>> parser.parse_args([]) + Namespace() + >>> parser.parse_args(['--foo', '1']) + Namespace(foo='1') + + +type +^^^^ + +By default, :class:`ArgumentParser` objects read command-line arguments in as simple +strings. However, quite often the command-line string should instead be +interpreted as another type, like a :class:`float` or :class:`int`. The +``type`` keyword argument of :meth:`~ArgumentParser.add_argument` allows any +necessary type-checking and type conversions to be performed. Common built-in +types and functions can be used directly as the value of the ``type`` argument:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('foo', type=int) + >>> parser.add_argument('bar', type=open) + >>> parser.parse_args('2 temp.txt'.split()) + Namespace(bar=<_io.TextIOWrapper name='temp.txt' encoding='UTF-8'>, foo=2) + +See the section on the default_ keyword argument for information on when the +``type`` argument is applied to default arguments. + +To ease the use of various types of files, the argparse module provides the +factory FileType which takes the ``mode=``, ``bufsize=``, ``encoding=`` and +``errors=`` arguments of the :func:`open` function. For example, +``FileType('w')`` can be used to create a writable file:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('bar', type=argparse.FileType('w')) + >>> parser.parse_args(['out.txt']) + Namespace(bar=<_io.TextIOWrapper name='out.txt' encoding='UTF-8'>) + +``type=`` can take any callable that takes a single string argument and returns +the converted value:: + + >>> def perfect_square(string): + ... value = int(string) + ... sqrt = math.sqrt(value) + ... if sqrt != int(sqrt): + ... msg = "%r is not a perfect square" % string + ... raise argparse.ArgumentTypeError(msg) + ... return value + ... + >>> parser = argparse.ArgumentParser(prog='PROG') + >>> parser.add_argument('foo', type=perfect_square) + >>> parser.parse_args(['9']) + Namespace(foo=9) + >>> parser.parse_args(['7']) + usage: PROG [-h] foo + PROG: error: argument foo: '7' is not a perfect square + +The choices_ keyword argument may be more convenient for type checkers that +simply check against a range of values:: + + >>> parser = argparse.ArgumentParser(prog='PROG') + >>> parser.add_argument('foo', type=int, choices=range(5, 10)) + >>> parser.parse_args(['7']) + Namespace(foo=7) + >>> parser.parse_args(['11']) + usage: PROG [-h] {5,6,7,8,9} + PROG: error: argument foo: invalid choice: 11 (choose from 5, 6, 7, 8, 9) + +See the choices_ section for more details. + + +choices +^^^^^^^ + +Some command-line arguments should be selected from a restricted set of values. +These can be handled by passing a container object as the *choices* keyword +argument to :meth:`~ArgumentParser.add_argument`. When the command line is +parsed, argument values will be checked, and an error message will be displayed +if the argument was not one of the acceptable values:: + + >>> parser = argparse.ArgumentParser(prog='game.py') + >>> parser.add_argument('move', choices=['rock', 'paper', 'scissors']) + >>> parser.parse_args(['rock']) + Namespace(move='rock') + >>> parser.parse_args(['fire']) + usage: game.py [-h] {rock,paper,scissors} + game.py: error: argument move: invalid choice: 'fire' (choose from 'rock', + 'paper', 'scissors') + +Note that inclusion in the *choices* container is checked after any type_ +conversions have been performed, so the type of the objects in the *choices* +container should match the type_ specified:: + + >>> parser = argparse.ArgumentParser(prog='doors.py') + >>> parser.add_argument('door', type=int, choices=range(1, 4)) + >>> print(parser.parse_args(['3'])) + Namespace(door=3) + >>> parser.parse_args(['4']) + usage: doors.py [-h] {1,2,3} + doors.py: error: argument door: invalid choice: 4 (choose from 1, 2, 3) + +Any object that supports the ``in`` operator can be passed as the *choices* +value, so :class:`dict` objects, :class:`set` objects, custom containers, +etc. are all supported. + + +required +^^^^^^^^ + +In general, the :mod:`argparse` module assumes that flags like ``-f`` and ``--bar`` +indicate *optional* arguments, which can always be omitted at the command line. +To make an option *required*, ``True`` can be specified for the ``required=`` +keyword argument to :meth:`~ArgumentParser.add_argument`:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--foo', required=True) + >>> parser.parse_args(['--foo', 'BAR']) + Namespace(foo='BAR') + >>> parser.parse_args([]) + usage: argparse.py [-h] [--foo FOO] + argparse.py: error: option --foo is required + +As the example shows, if an option is marked as ``required``, +:meth:`~ArgumentParser.parse_args` will report an error if that option is not +present at the command line. + +.. note:: + + Required options are generally considered bad form because users expect + *options* to be *optional*, and thus they should be avoided when possible. + + +help +^^^^ + +The ``help`` value is a string containing a brief description of the argument. +When a user requests help (usually by using ``-h`` or ``--help`` at the +command line), these ``help`` descriptions will be displayed with each +argument:: + + >>> parser = argparse.ArgumentParser(prog='frobble') + >>> parser.add_argument('--foo', action='store_true', + ... help='foo the bars before frobbling') + >>> parser.add_argument('bar', nargs='+', + ... help='one of the bars to be frobbled') + >>> parser.parse_args(['-h']) + usage: frobble [-h] [--foo] bar [bar ...] + + positional arguments: + bar one of the bars to be frobbled + + optional arguments: + -h, --help show this help message and exit + --foo foo the bars before frobbling + +The ``help`` strings can include various format specifiers to avoid repetition +of things like the program name or the argument default_. The available +specifiers include the program name, ``%(prog)s`` and most keyword arguments to +:meth:`~ArgumentParser.add_argument`, e.g. ``%(default)s``, ``%(type)s``, etc.:: + + >>> parser = argparse.ArgumentParser(prog='frobble') + >>> parser.add_argument('bar', nargs='?', type=int, default=42, + ... help='the bar to %(prog)s (default: %(default)s)') + >>> parser.print_help() + usage: frobble [-h] [bar] + + positional arguments: + bar the bar to frobble (default: 42) + + optional arguments: + -h, --help show this help message and exit + +As the help string supports %-formatting, if you want a literal ``%`` to appear +in the help string, you must escape it as ``%%``. + +:mod:`argparse` supports silencing the help entry for certain options, by +setting the ``help`` value to ``argparse.SUPPRESS``:: + + >>> parser = argparse.ArgumentParser(prog='frobble') + >>> parser.add_argument('--foo', help=argparse.SUPPRESS) + >>> parser.print_help() + usage: frobble [-h] + + optional arguments: + -h, --help show this help message and exit + + +metavar +^^^^^^^ + +When :class:`ArgumentParser` generates help messages, it needs some way to refer +to each expected argument. By default, ArgumentParser objects use the dest_ +value as the "name" of each object. By default, for positional argument +actions, the dest_ value is used directly, and for optional argument actions, +the dest_ value is uppercased. So, a single positional argument with +``dest='bar'`` will be referred to as ``bar``. A single +optional argument ``--foo`` that should be followed by a single command-line argument +will be referred to as ``FOO``. An example:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--foo') + >>> parser.add_argument('bar') + >>> parser.parse_args('X --foo Y'.split()) + Namespace(bar='X', foo='Y') + >>> parser.print_help() + usage: [-h] [--foo FOO] bar + + positional arguments: + bar + + optional arguments: + -h, --help show this help message and exit + --foo FOO + +An alternative name can be specified with ``metavar``:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--foo', metavar='YYY') + >>> parser.add_argument('bar', metavar='XXX') + >>> parser.parse_args('X --foo Y'.split()) + Namespace(bar='X', foo='Y') + >>> parser.print_help() + usage: [-h] [--foo YYY] XXX + + positional arguments: + XXX + + optional arguments: + -h, --help show this help message and exit + --foo YYY + +Note that ``metavar`` only changes the *displayed* name - the name of the +attribute on the :meth:`~ArgumentParser.parse_args` object is still determined +by the dest_ value. + +Different values of ``nargs`` may cause the metavar to be used multiple times. +Providing a tuple to ``metavar`` specifies a different display for each of the +arguments:: + + >>> parser = argparse.ArgumentParser(prog='PROG') + >>> parser.add_argument('-x', nargs=2) + >>> parser.add_argument('--foo', nargs=2, metavar=('bar', 'baz')) + >>> parser.print_help() + usage: PROG [-h] [-x X X] [--foo bar baz] + + optional arguments: + -h, --help show this help message and exit + -x X X + --foo bar baz + + +dest +^^^^ + +Most :class:`ArgumentParser` actions add some value as an attribute of the +object returned by :meth:`~ArgumentParser.parse_args`. The name of this +attribute is determined by the ``dest`` keyword argument of +:meth:`~ArgumentParser.add_argument`. For positional argument actions, +``dest`` is normally supplied as the first argument to +:meth:`~ArgumentParser.add_argument`:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('bar') + >>> parser.parse_args(['XXX']) + Namespace(bar='XXX') + +For optional argument actions, the value of ``dest`` is normally inferred from +the option strings. :class:`ArgumentParser` generates the value of ``dest`` by +taking the first long option string and stripping away the initial ``--`` +string. If no long option strings were supplied, ``dest`` will be derived from +the first short option string by stripping the initial ``-`` character. Any +internal ``-`` characters will be converted to ``_`` characters to make sure +the string is a valid attribute name. The examples below illustrate this +behavior:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('-f', '--foo-bar', '--foo') + >>> parser.add_argument('-x', '-y') + >>> parser.parse_args('-f 1 -x 2'.split()) + Namespace(foo_bar='1', x='2') + >>> parser.parse_args('--foo 1 -y 2'.split()) + Namespace(foo_bar='1', x='2') + +``dest`` allows a custom attribute name to be provided:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--foo', dest='bar') + >>> parser.parse_args('--foo XXX'.split()) + Namespace(bar='XXX') + +Action classes +^^^^^^^^^^^^^^ + +Action classes implement the Action API, a callable which returns a callable +which processes arguments from the command-line. Any object which follows +this API may be passed as the ``action`` parameter to +:meth:`add_argument`. + +.. class:: Action(option_strings, dest, nargs=None, const=None, default=None, \ + type=None, choices=None, required=False, help=None, \ + metavar=None) + +Action objects are used by an ArgumentParser to represent the information +needed to parse a single argument from one or more strings from the +command line. The Action class must accept the two positional arguments +plus any keyword arguments passed to :meth:`ArgumentParser.add_argument` +except for the ``action`` itself. + +Instances of Action (or return value of any callable to the ``action`` +parameter) should have attributes "dest", "option_strings", "default", "type", +"required", "help", etc. defined. The easiest way to ensure these attributes +are defined is to call ``Action.__init__``. + +Action instances should be callable, so subclasses must override the +``__call__`` method, which should accept four parameters: + +* ``parser`` - The ArgumentParser object which contains this action. + +* ``namespace`` - The :class:`Namespace` object that will be returned by + :meth:`~ArgumentParser.parse_args`. Most actions add an attribute to this + object using :func:`setattr`. + +* ``values`` - The associated command-line arguments, with any type conversions + applied. Type conversions are specified with the type_ keyword argument to + :meth:`~ArgumentParser.add_argument`. + +* ``option_string`` - The option string that was used to invoke this action. + The ``option_string`` argument is optional, and will be absent if the action + is associated with a positional argument. + +The ``__call__`` method may perform arbitrary actions, but will typically set +attributes on the ``namespace`` based on ``dest`` and ``values``. + + +The parse_args() method +----------------------- + +.. method:: ArgumentParser.parse_args(args=None, namespace=None) + + Convert argument strings to objects and assign them as attributes of the + namespace. Return the populated namespace. + + Previous calls to :meth:`add_argument` determine exactly what objects are + created and how they are assigned. See the documentation for + :meth:`add_argument` for details. + + * args_ - List of strings to parse. The default is taken from + :data:`sys.argv`. + + * namespace_ - An object to take the attributes. The default is a new empty + :class:`Namespace` object. + + +Option value syntax +^^^^^^^^^^^^^^^^^^^ + +The :meth:`~ArgumentParser.parse_args` method supports several ways of +specifying the value of an option (if it takes one). In the simplest case, the +option and its value are passed as two separate arguments:: + + >>> parser = argparse.ArgumentParser(prog='PROG') + >>> parser.add_argument('-x') + >>> parser.add_argument('--foo') + >>> parser.parse_args(['-x', 'X']) + Namespace(foo=None, x='X') + >>> parser.parse_args(['--foo', 'FOO']) + Namespace(foo='FOO', x=None) + +For long options (options with names longer than a single character), the option +and value can also be passed as a single command-line argument, using ``=`` to +separate them:: + + >>> parser.parse_args(['--foo=FOO']) + Namespace(foo='FOO', x=None) + +For short options (options only one character long), the option and its value +can be concatenated:: + + >>> parser.parse_args(['-xX']) + Namespace(foo=None, x='X') + +Several short options can be joined together, using only a single ``-`` prefix, +as long as only the last option (or none of them) requires a value:: + + >>> parser = argparse.ArgumentParser(prog='PROG') + >>> parser.add_argument('-x', action='store_true') + >>> parser.add_argument('-y', action='store_true') + >>> parser.add_argument('-z') + >>> parser.parse_args(['-xyzZ']) + Namespace(x=True, y=True, z='Z') + + +Invalid arguments +^^^^^^^^^^^^^^^^^ + +While parsing the command line, :meth:`~ArgumentParser.parse_args` checks for a +variety of errors, including ambiguous options, invalid types, invalid options, +wrong number of positional arguments, etc. When it encounters such an error, +it exits and prints the error along with a usage message:: + + >>> parser = argparse.ArgumentParser(prog='PROG') + >>> parser.add_argument('--foo', type=int) + >>> parser.add_argument('bar', nargs='?') + + >>> # invalid type + >>> parser.parse_args(['--foo', 'spam']) + usage: PROG [-h] [--foo FOO] [bar] + PROG: error: argument --foo: invalid int value: 'spam' + + >>> # invalid option + >>> parser.parse_args(['--bar']) + usage: PROG [-h] [--foo FOO] [bar] + PROG: error: no such option: --bar + + >>> # wrong number of arguments + >>> parser.parse_args(['spam', 'badger']) + usage: PROG [-h] [--foo FOO] [bar] + PROG: error: extra arguments found: badger + + +Arguments containing ``-`` +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The :meth:`~ArgumentParser.parse_args` method attempts to give errors whenever +the user has clearly made a mistake, but some situations are inherently +ambiguous. For example, the command-line argument ``-1`` could either be an +attempt to specify an option or an attempt to provide a positional argument. +The :meth:`~ArgumentParser.parse_args` method is cautious here: positional +arguments may only begin with ``-`` if they look like negative numbers and +there are no options in the parser that look like negative numbers:: + + >>> parser = argparse.ArgumentParser(prog='PROG') + >>> parser.add_argument('-x') + >>> parser.add_argument('foo', nargs='?') + + >>> # no negative number options, so -1 is a positional argument + >>> parser.parse_args(['-x', '-1']) + Namespace(foo=None, x='-1') + + >>> # no negative number options, so -1 and -5 are positional arguments + >>> parser.parse_args(['-x', '-1', '-5']) + Namespace(foo='-5', x='-1') + + >>> parser = argparse.ArgumentParser(prog='PROG') + >>> parser.add_argument('-1', dest='one') + >>> parser.add_argument('foo', nargs='?') + + >>> # negative number options present, so -1 is an option + >>> parser.parse_args(['-1', 'X']) + Namespace(foo=None, one='X') + + >>> # negative number options present, so -2 is an option + >>> parser.parse_args(['-2']) + usage: PROG [-h] [-1 ONE] [foo] + PROG: error: no such option: -2 + + >>> # negative number options present, so both -1s are options + >>> parser.parse_args(['-1', '-1']) + usage: PROG [-h] [-1 ONE] [foo] + PROG: error: argument -1: expected one argument + +If you have positional arguments that must begin with ``-`` and don't look +like negative numbers, you can insert the pseudo-argument ``'--'`` which tells +:meth:`~ArgumentParser.parse_args` that everything after that is a positional +argument:: + + >>> parser.parse_args(['--', '-f']) + Namespace(foo='-f', one=None) + +.. _prefix-matching: + +Argument abbreviations (prefix matching) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The :meth:`~ArgumentParser.parse_args` method :ref:`by default ` +allows long options to be abbreviated to a prefix, if the abbreviation is +unambiguous (the prefix matches a unique option):: + + >>> parser = argparse.ArgumentParser(prog='PROG') + >>> parser.add_argument('-bacon') + >>> parser.add_argument('-badger') + >>> parser.parse_args('-bac MMM'.split()) + Namespace(bacon='MMM', badger=None) + >>> parser.parse_args('-bad WOOD'.split()) + Namespace(bacon=None, badger='WOOD') + >>> parser.parse_args('-ba BA'.split()) + usage: PROG [-h] [-bacon BACON] [-badger BADGER] + PROG: error: ambiguous option: -ba could match -badger, -bacon + +An error is produced for arguments that could produce more than one options. +This feature can be disabled by setting :ref:`allow_abbrev` to ``False``. + +.. _args: + +Beyond ``sys.argv`` +^^^^^^^^^^^^^^^^^^^ + +Sometimes it may be useful to have an ArgumentParser parse arguments other than those +of :data:`sys.argv`. This can be accomplished by passing a list of strings to +:meth:`~ArgumentParser.parse_args`. This is useful for testing at the +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') + >>> parser.add_argument( + ... '--sum', dest='accumulate', action='store_const', const=sum, + ... default=max, help='sum the integers (default: find the max)') + >>> parser.parse_args(['1', '2', '3', '4']) + Namespace(accumulate=, integers=[1, 2, 3, 4]) + >>> parser.parse_args(['1', '2', '3', '4', '--sum']) + Namespace(accumulate=, integers=[1, 2, 3, 4]) + +.. _namespace: + +The Namespace object +^^^^^^^^^^^^^^^^^^^^ + +.. class:: Namespace + + Simple class used by default by :meth:`~ArgumentParser.parse_args` to create + an object holding attributes and return it. + +This class is deliberately simple, just an :class:`object` subclass with a +readable string representation. If you prefer to have dict-like view of the +attributes, you can use the standard Python idiom, :func:`vars`:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--foo') + >>> args = parser.parse_args(['--foo', 'BAR']) + >>> vars(args) + {'foo': 'BAR'} + +It may also be useful to have an :class:`ArgumentParser` assign attributes to an +already existing object, rather than a new :class:`Namespace` object. This can +be achieved by specifying the ``namespace=`` keyword argument:: + + >>> class C: + ... pass + ... + >>> c = C() + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--foo') + >>> parser.parse_args(args=['--foo', 'BAR'], namespace=c) + >>> c.foo + 'BAR' + + +Other utilities +--------------- + +Sub-commands +^^^^^^^^^^^^ + +.. method:: ArgumentParser.add_subparsers([title], [description], [prog], \ + [parser_class], [action], \ + [option_string], [dest], [required], \ + [help], [metavar]) + + Many programs split up their functionality into a number of sub-commands, + for example, the ``svn`` program can invoke sub-commands like ``svn + checkout``, ``svn update``, and ``svn commit``. Splitting up functionality + this way can be a particularly good idea when a program performs several + different functions which require different kinds of command-line arguments. + :class:`ArgumentParser` supports the creation of such sub-commands with the + :meth:`add_subparsers` method. The :meth:`add_subparsers` method is normally + called with no arguments and returns a special action object. This object + has a single method, :meth:`~ArgumentParser.add_parser`, which takes a + command name and any :class:`ArgumentParser` constructor arguments, and + returns an :class:`ArgumentParser` object that can be modified as usual. + + Description of parameters: + + * title - title for the sub-parser group in help output; by default + "subcommands" if description is provided, otherwise uses title for + positional arguments + + * description - description for the sub-parser group in help output, by + default ``None`` + + * prog - usage information that will be displayed with sub-command help, + by default the name of the program and any positional arguments before the + subparser argument + + * parser_class - class which will be used to create sub-parser instances, by + default the class of the current parser (e.g. ArgumentParser) + + * action_ - the basic type of action to be taken when this argument is + encountered at the command line + + * dest_ - name of the attribute under which sub-command name will be + stored; by default ``None`` and no value is stored + + * required_ - Whether or not a subcommand must be provided, by default + ``False``. + + * help_ - help for sub-parser group in help output, by default ``None`` + + * metavar_ - string presenting available sub-commands in help; by default it + is ``None`` and presents sub-commands in form {cmd1, cmd2, ..} + + Some example usage:: + + >>> # create the top-level parser + >>> parser = argparse.ArgumentParser(prog='PROG') + >>> parser.add_argument('--foo', action='store_true', help='foo help') + >>> subparsers = parser.add_subparsers(help='sub-command help') + >>> + >>> # create the parser for the "a" command + >>> parser_a = subparsers.add_parser('a', help='a help') + >>> parser_a.add_argument('bar', type=int, help='bar help') + >>> + >>> # create the parser for the "b" command + >>> parser_b = subparsers.add_parser('b', help='b help') + >>> parser_b.add_argument('--baz', choices='XYZ', help='baz help') + >>> + >>> # parse some argument lists + >>> parser.parse_args(['a', '12']) + Namespace(bar=12, foo=False) + >>> parser.parse_args(['--foo', 'b', '--baz', 'Z']) + Namespace(baz='Z', foo=True) + + Note that the object returned by :meth:`parse_args` will only contain + attributes for the main parser and the subparser that was selected by the + command line (and not any other subparsers). So in the example above, when + the ``a`` command is specified, only the ``foo`` and ``bar`` attributes are + present, and when the ``b`` command is specified, only the ``foo`` and + ``baz`` attributes are present. + + Similarly, when a help message is requested from a subparser, only the help + for that particular parser will be printed. The help message will not + include parent parser or sibling parser messages. (A help message for each + subparser command, however, can be given by supplying the ``help=`` argument + to :meth:`add_parser` as above.) + + :: + + >>> parser.parse_args(['--help']) + usage: PROG [-h] [--foo] {a,b} ... + + positional arguments: + {a,b} sub-command help + a a help + b b help + + optional arguments: + -h, --help show this help message and exit + --foo foo help + + >>> parser.parse_args(['a', '--help']) + usage: PROG a [-h] bar + + positional arguments: + bar bar help + + optional arguments: + -h, --help show this help message and exit + + >>> parser.parse_args(['b', '--help']) + usage: PROG b [-h] [--baz {X,Y,Z}] + + optional arguments: + -h, --help show this help message and exit + --baz {X,Y,Z} baz help + + The :meth:`add_subparsers` method also supports ``title`` and ``description`` + keyword arguments. When either is present, the subparser's commands will + appear in their own group in the help output. For example:: + + >>> parser = argparse.ArgumentParser() + >>> subparsers = parser.add_subparsers(title='subcommands', + ... description='valid subcommands', + ... help='additional help') + >>> subparsers.add_parser('foo') + >>> subparsers.add_parser('bar') + >>> parser.parse_args(['-h']) + usage: [-h] {foo,bar} ... + + optional arguments: + -h, --help show this help message and exit + + subcommands: + valid subcommands + + {foo,bar} additional help + + Furthermore, ``add_parser`` supports an additional ``aliases`` argument, + which allows multiple strings to refer to the same subparser. This example, + like ``svn``, aliases ``co`` as a shorthand for ``checkout``:: + + >>> parser = argparse.ArgumentParser() + >>> subparsers = parser.add_subparsers() + >>> checkout = subparsers.add_parser('checkout', aliases=['co']) + >>> checkout.add_argument('foo') + >>> parser.parse_args(['co', 'bar']) + Namespace(foo='bar') + + One particularly effective way of handling sub-commands is to combine the use + of the :meth:`add_subparsers` method with calls to :meth:`set_defaults` so + that each subparser knows which Python function it should execute. For + example:: + + >>> # sub-command functions + >>> def foo(args): + ... print(args.x * args.y) + ... + >>> def bar(args): + ... print('((%s))' % args.z) + ... + >>> # create the top-level parser + >>> parser = argparse.ArgumentParser() + >>> subparsers = parser.add_subparsers() + >>> + >>> # create the parser for the "foo" command + >>> parser_foo = subparsers.add_parser('foo') + >>> parser_foo.add_argument('-x', type=int, default=1) + >>> parser_foo.add_argument('y', type=float) + >>> parser_foo.set_defaults(func=foo) + >>> + >>> # create the parser for the "bar" command + >>> parser_bar = subparsers.add_parser('bar') + >>> parser_bar.add_argument('z') + >>> parser_bar.set_defaults(func=bar) + >>> + >>> # parse the args and call whatever function was selected + >>> args = parser.parse_args('foo 1 -x 2'.split()) + >>> args.func(args) + 2.0 + >>> + >>> # parse the args and call whatever function was selected + >>> args = parser.parse_args('bar XYZYX'.split()) + >>> args.func(args) + ((XYZYX)) + + This way, you can let :meth:`parse_args` do the job of calling the + appropriate function after argument parsing is complete. Associating + functions with actions like this is typically the easiest way to handle the + different actions for each of your subparsers. However, if it is necessary + to check the name of the subparser that was invoked, the ``dest`` keyword + argument to the :meth:`add_subparsers` call will work:: + + >>> parser = argparse.ArgumentParser() + >>> subparsers = parser.add_subparsers(dest='subparser_name') + >>> subparser1 = subparsers.add_parser('1') + >>> subparser1.add_argument('-x') + >>> subparser2 = subparsers.add_parser('2') + >>> subparser2.add_argument('y') + >>> parser.parse_args(['2', 'frobble']) + Namespace(subparser_name='2', y='frobble') + + +FileType objects +^^^^^^^^^^^^^^^^ + +.. class:: FileType(mode='r', bufsize=-1, encoding=None, errors=None) + + The :class:`FileType` factory creates objects that can be passed to the type + argument of :meth:`ArgumentParser.add_argument`. Arguments that have + :class:`FileType` objects as their type will open command-line arguments as + files with the requested modes, buffer sizes, encodings and error handling + (see the :func:`open` function for more details):: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--raw', type=argparse.FileType('wb', 0)) + >>> parser.add_argument('out', type=argparse.FileType('w', encoding='UTF-8')) + >>> parser.parse_args(['--raw', 'raw.dat', 'file.txt']) + Namespace(out=<_io.TextIOWrapper name='file.txt' mode='w' encoding='UTF-8'>, raw=<_io.FileIO name='raw.dat' mode='wb'>) + + FileType objects understand the pseudo-argument ``'-'`` and automatically + convert this into ``sys.stdin`` for readable :class:`FileType` objects and + ``sys.stdout`` for writable :class:`FileType` objects:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('infile', type=argparse.FileType('r')) + >>> parser.parse_args(['-']) + Namespace(infile=<_io.TextIOWrapper name='' encoding='UTF-8'>) + + .. versionadded:: 3.4 + The *encodings* and *errors* keyword arguments. + + +Argument groups +^^^^^^^^^^^^^^^ + +.. method:: ArgumentParser.add_argument_group(title=None, description=None) + + By default, :class:`ArgumentParser` groups command-line arguments into + "positional arguments" and "optional arguments" when displaying help + messages. When there is a better conceptual grouping of arguments than this + default one, appropriate groups can be created using the + :meth:`add_argument_group` method:: + + >>> parser = argparse.ArgumentParser(prog='PROG', add_help=False) + >>> group = parser.add_argument_group('group') + >>> group.add_argument('--foo', help='foo help') + >>> group.add_argument('bar', help='bar help') + >>> parser.print_help() + usage: PROG [--foo FOO] bar + + group: + bar bar help + --foo FOO foo help + + The :meth:`add_argument_group` method returns an argument group object which + has an :meth:`~ArgumentParser.add_argument` method just like a regular + :class:`ArgumentParser`. When an argument is added to the group, the parser + treats it just like a normal argument, but displays the argument in a + separate group for help messages. The :meth:`add_argument_group` method + accepts *title* and *description* arguments which can be used to + customize this display:: + + >>> parser = argparse.ArgumentParser(prog='PROG', add_help=False) + >>> group1 = parser.add_argument_group('group1', 'group1 description') + >>> group1.add_argument('foo', help='foo help') + >>> group2 = parser.add_argument_group('group2', 'group2 description') + >>> group2.add_argument('--bar', help='bar help') + >>> parser.print_help() + usage: PROG [--bar BAR] foo + + group1: + group1 description + + foo foo help + + group2: + group2 description + + --bar BAR bar help + + Note that any arguments not in your user-defined groups will end up back + in the usual "positional arguments" and "optional arguments" sections. + + +Mutual exclusion +^^^^^^^^^^^^^^^^ + +.. method:: ArgumentParser.add_mutually_exclusive_group(required=False) + + Create a mutually exclusive group. :mod:`argparse` will make sure that only + one of the arguments in the mutually exclusive group was present on the + command line:: + + >>> parser = argparse.ArgumentParser(prog='PROG') + >>> group = parser.add_mutually_exclusive_group() + >>> group.add_argument('--foo', action='store_true') + >>> group.add_argument('--bar', action='store_false') + >>> parser.parse_args(['--foo']) + Namespace(bar=True, foo=True) + >>> parser.parse_args(['--bar']) + Namespace(bar=False, foo=False) + >>> parser.parse_args(['--foo', '--bar']) + usage: PROG [-h] [--foo | --bar] + PROG: error: argument --bar: not allowed with argument --foo + + The :meth:`add_mutually_exclusive_group` method also accepts a *required* + argument, to indicate that at least one of the mutually exclusive arguments + is required:: + + >>> parser = argparse.ArgumentParser(prog='PROG') + >>> group = parser.add_mutually_exclusive_group(required=True) + >>> group.add_argument('--foo', action='store_true') + >>> group.add_argument('--bar', action='store_false') + >>> parser.parse_args([]) + usage: PROG [-h] (--foo | --bar) + PROG: error: one of the arguments --foo --bar is required + + Note that currently mutually exclusive argument groups do not support the + *title* and *description* arguments of + :meth:`~ArgumentParser.add_argument_group`. + + +Parser defaults +^^^^^^^^^^^^^^^ + +.. method:: ArgumentParser.set_defaults(**kwargs) + + Most of the time, the attributes of the object returned by :meth:`parse_args` + will be fully determined by inspecting the command-line arguments and the argument + actions. :meth:`set_defaults` allows some additional + attributes that are determined without any inspection of the command line to + be added:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('foo', type=int) + >>> parser.set_defaults(bar=42, baz='badger') + >>> parser.parse_args(['736']) + Namespace(bar=42, baz='badger', foo=736) + + Note that parser-level defaults always override argument-level defaults:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--foo', default='bar') + >>> parser.set_defaults(foo='spam') + >>> parser.parse_args([]) + Namespace(foo='spam') + + Parser-level defaults can be particularly useful when working with multiple + parsers. See the :meth:`~ArgumentParser.add_subparsers` method for an + example of this type. + +.. method:: ArgumentParser.get_default(dest) + + Get the default value for a namespace attribute, as set by either + :meth:`~ArgumentParser.add_argument` or by + :meth:`~ArgumentParser.set_defaults`:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--foo', default='badger') + >>> parser.get_default('foo') + 'badger' + + +Printing help +^^^^^^^^^^^^^ + +In most typical applications, :meth:`~ArgumentParser.parse_args` will take +care of formatting and printing any usage or error messages. However, several +formatting methods are available: + +.. method:: ArgumentParser.print_usage(file=None) + + Print a brief description of how the :class:`ArgumentParser` should be + invoked on the command line. If *file* is ``None``, :data:`sys.stdout` is + assumed. + +.. method:: ArgumentParser.print_help(file=None) + + Print a help message, including the program usage and information about the + arguments registered with the :class:`ArgumentParser`. If *file* is + ``None``, :data:`sys.stdout` is assumed. + +There are also variants of these methods that simply return a string instead of +printing it: + +.. method:: ArgumentParser.format_usage() + + Return a string containing a brief description of how the + :class:`ArgumentParser` should be invoked on the command line. + +.. method:: ArgumentParser.format_help() + + Return a string containing a help message, including the program usage and + information about the arguments registered with the :class:`ArgumentParser`. + + +Partial parsing +^^^^^^^^^^^^^^^ + +.. method:: ArgumentParser.parse_known_args(args=None, namespace=None) + +Sometimes a script may only parse a few of the command-line arguments, passing +the remaining arguments on to another script or program. In these cases, the +:meth:`~ArgumentParser.parse_known_args` method can be useful. It works much like +:meth:`~ArgumentParser.parse_args` except that it does not produce an error when +extra arguments are present. Instead, it returns a two item tuple containing +the populated namespace and the list of remaining argument strings. + +:: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--foo', action='store_true') + >>> parser.add_argument('bar') + >>> parser.parse_known_args(['--foo', '--badger', 'BAR', 'spam']) + (Namespace(bar='BAR', foo=True), ['--badger', 'spam']) + +.. warning:: + :ref:`Prefix matching ` rules apply to + :meth:`parse_known_args`. The parser may consume an option even if it's just + a prefix of one of its known options, instead of leaving it in the remaining + arguments list. + + +Customizing file parsing +^^^^^^^^^^^^^^^^^^^^^^^^ + +.. method:: ArgumentParser.convert_arg_line_to_args(arg_line) + + Arguments that are read from a file (see the *fromfile_prefix_chars* + keyword argument to the :class:`ArgumentParser` constructor) are read one + argument per line. :meth:`convert_arg_line_to_args` can be overridden for + fancier reading. + + This method takes a single argument *arg_line* which is a string read from + the argument file. It returns a list of arguments parsed from this string. + The method is called once per line read from the argument file, in order. + + A useful override of this method is one that treats each space-separated word + as an argument. The following example demonstrates how to do this:: + + class MyArgumentParser(argparse.ArgumentParser): + def convert_arg_line_to_args(self, arg_line): + return arg_line.split() + + +Exiting methods +^^^^^^^^^^^^^^^ + +.. method:: ArgumentParser.exit(status=0, message=None) + + This method terminates the program, exiting with the specified *status* + and, if given, it prints a *message* before that. + +.. method:: ArgumentParser.error(message) + + This method prints a usage message including the *message* to the + standard error and terminates the program with a status code of 2. + + +Intermixed parsing +^^^^^^^^^^^^^^^^^^ + +.. method:: ArgumentParser.parse_intermixed_args(args=None, namespace=None) +.. method:: ArgumentParser.parse_known_intermixed_args(args=None, namespace=None) + +A number of Unix commands allow the user to intermix optional arguments with +positional arguments. The :meth:`~ArgumentParser.parse_intermixed_args` +and :meth:`~ArgumentParser.parse_known_intermixed_args` methods +support this parsing style. + +These parsers do not support all the argparse features, and will raise +exceptions if unsupported features are used. In particular, subparsers, +``argparse.REMAINDER``, and mutually exclusive groups that include both +optionals and positionals are not supported. + +The following example shows the difference between +:meth:`~ArgumentParser.parse_known_args` and +:meth:`~ArgumentParser.parse_intermixed_args`: the former returns ``['2', +'3']`` as unparsed arguments, while the latter collects all the positionals +into ``rest``. :: + + >>> parser = argparse.ArgumentParser() + >>> parser.add_argument('--foo') + >>> parser.add_argument('cmd') + >>> parser.add_argument('rest', nargs='*', type=int) + >>> parser.parse_known_args('doit 1 --foo bar 2 3'.split()) + (Namespace(cmd='doit', foo='bar', rest=[1]), ['2', '3']) + >>> parser.parse_intermixed_args('doit 1 --foo bar 2 3'.split()) + Namespace(cmd='doit', foo='bar', rest=[1, 2, 3]) + +:meth:`~ArgumentParser.parse_known_intermixed_args` returns a two item tuple +containing the populated namespace and the list of remaining argument strings. +:meth:`~ArgumentParser.parse_intermixed_args` raises an error if there are any +remaining unparsed argument strings. + +.. versionadded:: 3.7 + +.. _upgrading-optparse-code: + +Upgrading optparse code +----------------------- + +Originally, the :mod:`argparse` module had attempted to maintain compatibility +with :mod:`optparse`. However, :mod:`optparse` was difficult to extend +transparently, particularly with the changes required to support the new +``nargs=`` specifiers and better usage messages. When most everything in +:mod:`optparse` had either been copy-pasted over or monkey-patched, it no +longer seemed practical to try to maintain the backwards compatibility. + +The :mod:`argparse` module improves on the standard library :mod:`optparse` +module in a number of ways including: + +* Handling positional arguments. +* Supporting sub-commands. +* Allowing alternative option prefixes like ``+`` and ``/``. +* Handling zero-or-more and one-or-more style arguments. +* Producing more informative usage messages. +* Providing a much simpler interface for custom ``type`` and ``action``. + +A partial upgrade path from :mod:`optparse` to :mod:`argparse`: + +* Replace all :meth:`optparse.OptionParser.add_option` calls with + :meth:`ArgumentParser.add_argument` calls. + +* Replace ``(options, args) = parser.parse_args()`` with ``args = + parser.parse_args()`` and add additional :meth:`ArgumentParser.add_argument` + calls for the positional arguments. Keep in mind that what was previously + called ``options``, now in the :mod:`argparse` context is called ``args``. + +* Replace :meth:`optparse.OptionParser.disable_interspersed_args` + by using :meth:`~ArgumentParser.parse_intermixed_args` instead of + :meth:`~ArgumentParser.parse_args`. + +* Replace callback actions and the ``callback_*`` keyword arguments with + ``type`` or ``action`` arguments. + +* Replace string names for ``type`` keyword arguments with the corresponding + type objects (e.g. int, float, complex, etc). + +* Replace :class:`optparse.Values` with :class:`Namespace` and + :exc:`optparse.OptionError` and :exc:`optparse.OptionValueError` with + :exc:`ArgumentError`. + +* Replace strings with implicit arguments such as ``%default`` or ``%prog`` with + the standard Python syntax to use dictionaries to format strings, that is, + ``%(default)s`` and ``%(prog)s``. + +* Replace the OptionParser constructor ``version`` argument with a call to + ``parser.add_argument('--version', action='version', version='')``. diff --git a/python-3.7.4-docs-html/_sources/library/array.rst.txt b/python-3.7.4-docs-html/_sources/library/array.rst.txt new file mode 100644 index 0000000..4ac7bb5 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/array.rst.txt @@ -0,0 +1,278 @@ +:mod:`array` --- Efficient arrays of numeric values +=================================================== + +.. module:: array + :synopsis: Space efficient arrays of uniformly typed numeric values. + +.. index:: single: arrays + +-------------- + +This module defines an object type which can compactly represent an array of +basic values: characters, integers, floating point numbers. Arrays are sequence +types and behave very much like lists, except that the type of objects stored in +them is constrained. The type is specified at object creation time by using a +:dfn:`type code`, which is a single character. The following type codes are +defined: + ++-----------+--------------------+-------------------+-----------------------+-------+ +| Type code | C Type | Python Type | Minimum size in bytes | Notes | ++===========+====================+===================+=======================+=======+ +| ``'b'`` | signed char | int | 1 | | ++-----------+--------------------+-------------------+-----------------------+-------+ +| ``'B'`` | unsigned char | int | 1 | | ++-----------+--------------------+-------------------+-----------------------+-------+ +| ``'u'`` | Py_UNICODE | Unicode character | 2 | \(1) | ++-----------+--------------------+-------------------+-----------------------+-------+ +| ``'h'`` | signed short | int | 2 | | ++-----------+--------------------+-------------------+-----------------------+-------+ +| ``'H'`` | unsigned short | int | 2 | | ++-----------+--------------------+-------------------+-----------------------+-------+ +| ``'i'`` | signed int | int | 2 | | ++-----------+--------------------+-------------------+-----------------------+-------+ +| ``'I'`` | unsigned int | int | 2 | | ++-----------+--------------------+-------------------+-----------------------+-------+ +| ``'l'`` | signed long | int | 4 | | ++-----------+--------------------+-------------------+-----------------------+-------+ +| ``'L'`` | unsigned long | int | 4 | | ++-----------+--------------------+-------------------+-----------------------+-------+ +| ``'q'`` | signed long long | int | 8 | \(2) | ++-----------+--------------------+-------------------+-----------------------+-------+ +| ``'Q'`` | unsigned long long | int | 8 | \(2) | ++-----------+--------------------+-------------------+-----------------------+-------+ +| ``'f'`` | float | float | 4 | | ++-----------+--------------------+-------------------+-----------------------+-------+ +| ``'d'`` | double | float | 8 | | ++-----------+--------------------+-------------------+-----------------------+-------+ + +Notes: + +(1) + The ``'u'`` type code corresponds to Python's obsolete unicode character + (:c:type:`Py_UNICODE` which is :c:type:`wchar_t`). Depending on the + platform, it can be 16 bits or 32 bits. + + ``'u'`` will be removed together with the rest of the :c:type:`Py_UNICODE` + API. + + .. deprecated-removed:: 3.3 4.0 + +(2) + The ``'q'`` and ``'Q'`` type codes are available only if + the platform C compiler used to build Python supports C :c:type:`long long`, + or, on Windows, :c:type:`__int64`. + + .. versionadded:: 3.3 + +The actual representation of values is determined by the machine architecture +(strictly speaking, by the C implementation). The actual size can be accessed +through the :attr:`itemsize` attribute. + +The module defines the following type: + + +.. class:: array(typecode[, initializer]) + + A new array whose items are restricted by *typecode*, and initialized + from the optional *initializer* value, which must be a list, a + :term:`bytes-like object`, or iterable over elements of the + appropriate type. + + If given a list or string, the initializer is passed to the new array's + :meth:`fromlist`, :meth:`frombytes`, or :meth:`fromunicode` method (see below) + to add initial items to the array. Otherwise, the iterable initializer is + passed to the :meth:`extend` method. + + +.. data:: typecodes + + A string with all available type codes. + +Array objects support the ordinary sequence operations of indexing, slicing, +concatenation, and multiplication. When using slice assignment, the assigned +value must be an array object with the same type code; in all other cases, +:exc:`TypeError` is raised. Array objects also implement the buffer interface, +and may be used wherever :term:`bytes-like objects ` are supported. + +The following data items and methods are also supported: + +.. attribute:: array.typecode + + The typecode character used to create the array. + + +.. attribute:: array.itemsize + + The length in bytes of one array item in the internal representation. + + +.. method:: array.append(x) + + Append a new item with value *x* to the end of the array. + + +.. method:: array.buffer_info() + + Return a tuple ``(address, length)`` giving the current memory address and the + length in elements of the buffer used to hold array's contents. The size of the + memory buffer in bytes can be computed as ``array.buffer_info()[1] * + array.itemsize``. This is occasionally useful when working with low-level (and + inherently unsafe) I/O interfaces that require memory addresses, such as certain + :c:func:`ioctl` operations. The returned numbers are valid as long as the array + exists and no length-changing operations are applied to it. + + .. note:: + + When using array objects from code written in C or C++ (the only way to + effectively make use of this information), it makes more sense to use the buffer + interface supported by array objects. This method is maintained for backward + compatibility and should be avoided in new code. The buffer interface is + documented in :ref:`bufferobjects`. + + +.. method:: array.byteswap() + + "Byteswap" all items of the array. This is only supported for values which are + 1, 2, 4, or 8 bytes in size; for other types of values, :exc:`RuntimeError` is + raised. It is useful when reading data from a file written on a machine with a + different byte order. + + +.. method:: array.count(x) + + Return the number of occurrences of *x* in the array. + + +.. method:: array.extend(iterable) + + Append items from *iterable* to the end of the array. If *iterable* is another + array, it must have *exactly* the same type code; if not, :exc:`TypeError` will + be raised. If *iterable* is not an array, it must be iterable and its elements + must be the right type to be appended to the array. + + +.. method:: array.frombytes(s) + + Appends items from the string, interpreting the string as an array of machine + values (as if it had been read from a file using the :meth:`fromfile` method). + + .. versionadded:: 3.2 + :meth:`fromstring` is renamed to :meth:`frombytes` for clarity. + + +.. method:: array.fromfile(f, n) + + Read *n* items (as machine values) from the :term:`file object` *f* and append + them to the end of the array. If less than *n* items are available, + :exc:`EOFError` is raised, but the items that were available are still + inserted into the array. *f* must be a real built-in file object; something + else with a :meth:`read` method won't do. + + +.. method:: array.fromlist(list) + + Append items from the list. This is equivalent to ``for x in list: + a.append(x)`` except that if there is a type error, the array is unchanged. + + +.. method:: array.fromstring() + + Deprecated alias for :meth:`frombytes`. + + +.. method:: array.fromunicode(s) + + Extends this array with data from the given unicode string. The array must + be a type ``'u'`` array; otherwise a :exc:`ValueError` is raised. Use + ``array.frombytes(unicodestring.encode(enc))`` to append Unicode data to an + array of some other type. + + +.. method:: array.index(x) + + Return the smallest *i* such that *i* is the index of the first occurrence of + *x* in the array. + + +.. method:: array.insert(i, x) + + Insert a new item with value *x* in the array before position *i*. Negative + values are treated as being relative to the end of the array. + + +.. method:: array.pop([i]) + + Removes the item with the index *i* from the array and returns it. The optional + argument defaults to ``-1``, so that by default the last item is removed and + returned. + + +.. method:: array.remove(x) + + Remove the first occurrence of *x* from the array. + + +.. method:: array.reverse() + + Reverse the order of the items in the array. + + +.. method:: array.tobytes() + + Convert the array to an array of machine values and return the bytes + representation (the same sequence of bytes that would be written to a file by + the :meth:`tofile` method.) + + .. versionadded:: 3.2 + :meth:`tostring` is renamed to :meth:`tobytes` for clarity. + + +.. method:: array.tofile(f) + + Write all items (as machine values) to the :term:`file object` *f*. + + +.. method:: array.tolist() + + Convert the array to an ordinary list with the same items. + + +.. method:: array.tostring() + + Deprecated alias for :meth:`tobytes`. + + +.. method:: array.tounicode() + + Convert the array to a unicode string. The array must be a type ``'u'`` array; + otherwise a :exc:`ValueError` is raised. Use ``array.tobytes().decode(enc)`` to + obtain a unicode string from an array of some other type. + + +When an array object is printed or converted to a string, it is represented as +``array(typecode, initializer)``. The *initializer* is omitted if the array is +empty, otherwise it is a string if the *typecode* is ``'u'``, otherwise it is a +list of numbers. The string is guaranteed to be able to be converted back to an +array with the same type and value using :func:`eval`, so long as the +:class:`~array.array` class has been imported using ``from array import array``. +Examples:: + + array('l') + array('u', 'hello \u2641') + array('l', [1, 2, 3, 4, 5]) + array('d', [1.0, 2.0, 3.14]) + + +.. seealso:: + + Module :mod:`struct` + Packing and unpacking of heterogeneous binary data. + + Module :mod:`xdrlib` + Packing and unpacking of External Data Representation (XDR) data as used in some + remote procedure call systems. + + `The Numerical Python Documentation `_ + The Numeric Python extension (NumPy) defines another array type; see + http://www.numpy.org/ for further information about Numerical Python. + diff --git a/python-3.7.4-docs-html/_sources/library/ast.rst.txt b/python-3.7.4-docs-html/_sources/library/ast.rst.txt new file mode 100644 index 0000000..3c73f74 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/ast.rst.txt @@ -0,0 +1,274 @@ +:mod:`ast` --- Abstract Syntax Trees +==================================== + +.. module:: ast + :synopsis: Abstract Syntax Tree classes and manipulation. + +.. sectionauthor:: Martin v. Löwis +.. sectionauthor:: Georg Brandl + +**Source code:** :source:`Lib/ast.py` + +-------------- + +The :mod:`ast` module helps Python applications to process trees of the Python +abstract syntax grammar. The abstract syntax itself might change with each +Python release; this module helps to find out programmatically what the current +grammar looks like. + +An abstract syntax tree can be generated by passing :data:`ast.PyCF_ONLY_AST` as +a flag to the :func:`compile` built-in function, or using the :func:`parse` +helper provided in this module. The result will be a tree of objects whose +classes all inherit from :class:`ast.AST`. An abstract syntax tree can be +compiled into a Python code object using the built-in :func:`compile` function. + + +Node classes +------------ + +.. class:: AST + + This is the base of all AST node classes. The actual node classes are + derived from the :file:`Parser/Python.asdl` file, which is reproduced + :ref:`below `. They are defined in the :mod:`_ast` C + module and re-exported in :mod:`ast`. + + There is one class defined for each left-hand side symbol in the abstract + grammar (for example, :class:`ast.stmt` or :class:`ast.expr`). In addition, + there is one class defined for each constructor on the right-hand side; these + classes inherit from the classes for the left-hand side trees. For example, + :class:`ast.BinOp` inherits from :class:`ast.expr`. For production rules + with alternatives (aka "sums"), the left-hand side class is abstract: only + instances of specific constructor nodes are ever created. + + .. index:: single: ? (question mark); in AST grammar + .. index:: single: * (asterisk); in AST grammar + + .. attribute:: _fields + + Each concrete class has an attribute :attr:`_fields` which gives the names + of all child nodes. + + Each instance of a concrete class has one attribute for each child node, + of the type as defined in the grammar. For example, :class:`ast.BinOp` + instances have an attribute :attr:`left` of type :class:`ast.expr`. + + If these attributes are marked as optional in the grammar (using a + question mark), the value might be ``None``. If the attributes can have + zero-or-more values (marked with an asterisk), the values are represented + as Python lists. All possible attributes must be present and have valid + values when compiling an AST with :func:`compile`. + + .. attribute:: lineno + col_offset + + Instances of :class:`ast.expr` and :class:`ast.stmt` subclasses have + :attr:`lineno` and :attr:`col_offset` attributes. The :attr:`lineno` is + the line number of source text (1-indexed so the first line is line 1) and + the :attr:`col_offset` is the UTF-8 byte offset of the first token that + generated the node. The UTF-8 offset is recorded because the parser uses + UTF-8 internally. + + The constructor of a class :class:`ast.T` parses its arguments as follows: + + * If there are positional arguments, there must be as many as there are items + in :attr:`T._fields`; they will be assigned as attributes of these names. + * If there are keyword arguments, they will set the attributes of the same + names to the given values. + + For example, to create and populate an :class:`ast.UnaryOp` node, you could + use :: + + node = ast.UnaryOp() + node.op = ast.USub() + node.operand = ast.Num() + node.operand.n = 5 + node.operand.lineno = 0 + node.operand.col_offset = 0 + node.lineno = 0 + node.col_offset = 0 + + or the more compact :: + + node = ast.UnaryOp(ast.USub(), ast.Num(5, lineno=0, col_offset=0), + lineno=0, col_offset=0) + + +.. _abstract-grammar: + +Abstract Grammar +---------------- + +The abstract grammar is currently defined as follows: + +.. literalinclude:: ../../Parser/Python.asdl + :language: none + + +:mod:`ast` Helpers +------------------ + +Apart from the node classes, the :mod:`ast` module defines these utility functions +and classes for traversing abstract syntax trees: + +.. function:: parse(source, filename='', mode='exec') + + Parse the source into an AST node. Equivalent to ``compile(source, + filename, mode, ast.PyCF_ONLY_AST)``. + + .. warning:: + It is possible to crash the Python interpreter with a + sufficiently large/complex string due to stack depth limitations + in Python's AST compiler. + + +.. function:: literal_eval(node_or_string) + + Safely evaluate an expression node or a string containing a Python literal or + container display. The string or node provided may only consist of the + following Python literal structures: strings, bytes, numbers, tuples, lists, + dicts, sets, booleans, and ``None``. + + This can be used for safely evaluating strings containing Python values from + untrusted sources without the need to parse the values oneself. It is not + capable of evaluating arbitrarily complex expressions, for example involving + operators or indexing. + + .. warning:: + It is possible to crash the Python interpreter with a + sufficiently large/complex string due to stack depth limitations + in Python's AST compiler. + + .. versionchanged:: 3.2 + Now allows bytes and set literals. + + +.. function:: get_docstring(node, clean=True) + + Return the docstring of the given *node* (which must be a + :class:`FunctionDef`, :class:`AsyncFunctionDef`, :class:`ClassDef`, + or :class:`Module` node), or ``None`` if it has no docstring. + If *clean* is true, clean up the docstring's indentation with + :func:`inspect.cleandoc`. + + .. versionchanged:: 3.5 + :class:`AsyncFunctionDef` is now supported. + + +.. function:: fix_missing_locations(node) + + When you compile a node tree with :func:`compile`, the compiler expects + :attr:`lineno` and :attr:`col_offset` attributes for every node that supports + them. This is rather tedious to fill in for generated nodes, so this helper + adds these attributes recursively where not already set, by setting them to + the values of the parent node. It works recursively starting at *node*. + + +.. function:: increment_lineno(node, n=1) + + Increment the line number of each node in the tree starting at *node* by *n*. + This is useful to "move code" to a different location in a file. + + +.. function:: copy_location(new_node, old_node) + + Copy source location (:attr:`lineno` and :attr:`col_offset`) from *old_node* + to *new_node* if possible, and return *new_node*. + + +.. function:: iter_fields(node) + + Yield a tuple of ``(fieldname, value)`` for each field in ``node._fields`` + that is present on *node*. + + +.. function:: iter_child_nodes(node) + + Yield all direct child nodes of *node*, that is, all fields that are nodes + and all items of fields that are lists of nodes. + + +.. function:: walk(node) + + Recursively yield all descendant nodes in the tree starting at *node* + (including *node* itself), in no specified order. This is useful if you only + want to modify nodes in place and don't care about the context. + + +.. class:: NodeVisitor() + + A node visitor base class that walks the abstract syntax tree and calls a + visitor function for every node found. This function may return a value + which is forwarded by the :meth:`visit` method. + + This class is meant to be subclassed, with the subclass adding visitor + methods. + + .. method:: visit(node) + + Visit a node. The default implementation calls the method called + :samp:`self.visit_{classname}` where *classname* is the name of the node + class, or :meth:`generic_visit` if that method doesn't exist. + + .. method:: generic_visit(node) + + This visitor calls :meth:`visit` on all children of the node. + + Note that child nodes of nodes that have a custom visitor method won't be + visited unless the visitor calls :meth:`generic_visit` or visits them + itself. + + Don't use the :class:`NodeVisitor` if you want to apply changes to nodes + during traversal. For this a special visitor exists + (:class:`NodeTransformer`) that allows modifications. + + +.. class:: NodeTransformer() + + A :class:`NodeVisitor` subclass that walks the abstract syntax tree and + allows modification of nodes. + + The :class:`NodeTransformer` will walk the AST and use the return value of + the visitor methods to replace or remove the old node. If the return value + of the visitor method is ``None``, the node will be removed from its + location, otherwise it is replaced with the return value. The return value + may be the original node in which case no replacement takes place. + + Here is an example transformer that rewrites all occurrences of name lookups + (``foo``) to ``data['foo']``:: + + class RewriteName(NodeTransformer): + + def visit_Name(self, node): + return copy_location(Subscript( + value=Name(id='data', ctx=Load()), + slice=Index(value=Str(s=node.id)), + ctx=node.ctx + ), node) + + Keep in mind that if the node you're operating on has child nodes you must + either transform the child nodes yourself or call the :meth:`generic_visit` + method for the node first. + + For nodes that were part of a collection of statements (that applies to all + statement nodes), the visitor may also return a list of nodes rather than + just a single node. + + Usually you use the transformer like this:: + + node = YourTransformer().visit(node) + + +.. function:: dump(node, annotate_fields=True, include_attributes=False) + + Return a formatted dump of the tree in *node*. This is mainly useful for + debugging purposes. The returned string will show the names and the values + for fields. This makes the code impossible to evaluate, so if evaluation is + wanted *annotate_fields* must be set to ``False``. Attributes such as line + numbers and column offsets are not dumped by default. If this is wanted, + *include_attributes* can be set to ``True``. + +.. seealso:: + + `Green Tree Snakes `_, an external documentation resource, has good + details on working with Python ASTs. diff --git a/python-3.7.4-docs-html/_sources/library/asynchat.rst.txt b/python-3.7.4-docs-html/_sources/library/asynchat.rst.txt new file mode 100644 index 0000000..9e51416 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/asynchat.rst.txt @@ -0,0 +1,213 @@ +:mod:`asynchat` --- Asynchronous socket command/response handler +================================================================ + +.. module:: asynchat + :synopsis: Support for asynchronous command/response protocols. + +.. moduleauthor:: Sam Rushing +.. sectionauthor:: Steve Holden + +**Source code:** :source:`Lib/asynchat.py` + +.. deprecated:: 3.6 + Please use :mod:`asyncio` instead. + +-------------- + +.. note:: + + This module exists for backwards compatibility only. For new code we + recommend using :mod:`asyncio`. + +This module builds on the :mod:`asyncore` infrastructure, simplifying +asynchronous clients and servers and making it easier to handle protocols +whose elements are terminated by arbitrary strings, or are of variable length. +:mod:`asynchat` defines the abstract class :class:`async_chat` that you +subclass, providing implementations of the :meth:`collect_incoming_data` and +:meth:`found_terminator` methods. It uses the same asynchronous loop as +:mod:`asyncore`, and the two types of channel, :class:`asyncore.dispatcher` +and :class:`asynchat.async_chat`, can freely be mixed in the channel map. +Typically an :class:`asyncore.dispatcher` server channel generates new +:class:`asynchat.async_chat` channel objects as it receives incoming +connection requests. + + +.. class:: async_chat() + + This class is an abstract subclass of :class:`asyncore.dispatcher`. To make + practical use of the code you must subclass :class:`async_chat`, providing + meaningful :meth:`collect_incoming_data` and :meth:`found_terminator` + methods. + The :class:`asyncore.dispatcher` methods can be used, although not all make + sense in a message/response context. + + Like :class:`asyncore.dispatcher`, :class:`async_chat` defines a set of + events that are generated by an analysis of socket conditions after a + :c:func:`select` call. Once the polling loop has been started the + :class:`async_chat` object's methods are called by the event-processing + framework with no action on the part of the programmer. + + Two class attributes can be modified, to improve performance, or possibly + even to conserve memory. + + + .. data:: ac_in_buffer_size + + The asynchronous input buffer size (default ``4096``). + + + .. data:: ac_out_buffer_size + + The asynchronous output buffer size (default ``4096``). + + Unlike :class:`asyncore.dispatcher`, :class:`async_chat` allows you to + define a :abbr:`FIFO (first-in, first-out)` queue of *producers*. A producer need + have only one method, :meth:`more`, which should return data to be + transmitted on the channel. + The producer indicates exhaustion (*i.e.* that it contains no more data) by + having its :meth:`more` method return the empty bytes object. At this point + the :class:`async_chat` object removes the producer from the queue and starts + using the next producer, if any. When the producer queue is empty the + :meth:`handle_write` method does nothing. You use the channel object's + :meth:`set_terminator` method to describe how to recognize the end of, or + an important breakpoint in, an incoming transmission from the remote + endpoint. + + To build a functioning :class:`async_chat` subclass your input methods + :meth:`collect_incoming_data` and :meth:`found_terminator` must handle the + data that the channel receives asynchronously. The methods are described + below. + + +.. method:: async_chat.close_when_done() + + Pushes a ``None`` on to the producer queue. When this producer is popped off + the queue it causes the channel to be closed. + + +.. method:: async_chat.collect_incoming_data(data) + + Called with *data* holding an arbitrary amount of received data. The + default method, which must be overridden, raises a + :exc:`NotImplementedError` exception. + + +.. method:: async_chat.discard_buffers() + + In emergencies this method will discard any data held in the input and/or + output buffers and the producer queue. + + +.. method:: async_chat.found_terminator() + + Called when the incoming data stream matches the termination condition set + by :meth:`set_terminator`. The default method, which must be overridden, + raises a :exc:`NotImplementedError` exception. The buffered input data + should be available via an instance attribute. + + +.. method:: async_chat.get_terminator() + + Returns the current terminator for the channel. + + +.. method:: async_chat.push(data) + + Pushes data on to the channel's queue to ensure its transmission. + This is all you need to do to have the channel write the data out to the + network, although it is possible to use your own producers in more complex + schemes to implement encryption and chunking, for example. + + +.. method:: async_chat.push_with_producer(producer) + + Takes a producer object and adds it to the producer queue associated with + the channel. When all currently-pushed producers have been exhausted the + channel will consume this producer's data by calling its :meth:`more` + method and send the data to the remote endpoint. + + +.. method:: async_chat.set_terminator(term) + + Sets the terminating condition to be recognized on the channel. ``term`` + may be any of three types of value, corresponding to three different ways + to handle incoming protocol data. + + +-----------+---------------------------------------------+ + | term | Description | + +===========+=============================================+ + | *string* | Will call :meth:`found_terminator` when the | + | | string is found in the input stream | + +-----------+---------------------------------------------+ + | *integer* | Will call :meth:`found_terminator` when the | + | | indicated number of characters have been | + | | received | + +-----------+---------------------------------------------+ + | ``None`` | The channel continues to collect data | + | | forever | + +-----------+---------------------------------------------+ + + Note that any data following the terminator will be available for reading + by the channel after :meth:`found_terminator` is called. + + +.. _asynchat-example: + +asynchat Example +---------------- + +The following partial example shows how HTTP requests can be read with +:class:`async_chat`. A web server might create an +:class:`http_request_handler` object for each incoming client connection. +Notice that initially the channel terminator is set to match the blank line at +the end of the HTTP headers, and a flag indicates that the headers are being +read. + +Once the headers have been read, if the request is of type POST (indicating +that further data are present in the input stream) then the +``Content-Length:`` header is used to set a numeric terminator to read the +right amount of data from the channel. + +The :meth:`handle_request` method is called once all relevant input has been +marshalled, after setting the channel terminator to ``None`` to ensure that +any extraneous data sent by the web client are ignored. :: + + + import asynchat + + class http_request_handler(asynchat.async_chat): + + def __init__(self, sock, addr, sessions, log): + asynchat.async_chat.__init__(self, sock=sock) + self.addr = addr + self.sessions = sessions + self.ibuffer = [] + self.obuffer = b"" + self.set_terminator(b"\r\n\r\n") + self.reading_headers = True + self.handling = False + self.cgi_data = None + self.log = log + + def collect_incoming_data(self, data): + """Buffer the data""" + self.ibuffer.append(data) + + def found_terminator(self): + if self.reading_headers: + self.reading_headers = False + self.parse_headers(b"".join(self.ibuffer)) + self.ibuffer = [] + if self.op.upper() == b"POST": + clen = self.headers.getheader("content-length") + self.set_terminator(int(clen)) + else: + self.handling = True + self.set_terminator(None) + self.handle_request() + elif not self.handling: + self.set_terminator(None) # browsers sometimes over-send + self.cgi_data = parse(self.headers, b"".join(self.ibuffer)) + self.handling = True + self.ibuffer = [] + self.handle_request() diff --git a/python-3.7.4-docs-html/_sources/library/asyncio-api-index.rst.txt b/python-3.7.4-docs-html/_sources/library/asyncio-api-index.rst.txt new file mode 100644 index 0000000..d5b5659 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/asyncio-api-index.rst.txt @@ -0,0 +1,218 @@ +.. currentmodule:: asyncio + + +==================== +High-level API Index +==================== + +This page lists all high-level async/await enabled asyncio APIs. + + +Tasks +===== + +Utilities to run asyncio programs, create Tasks, and +await on multiple things with timeouts. + +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - :func:`run` + - Create event loop, run a coroutine, close the loop. + + * - :func:`create_task` + - Start an asyncio Task. + + * - ``await`` :func:`sleep` + - Sleep for a number of seconds. + + * - ``await`` :func:`gather` + - Schedule and wait for things concurrently. + + * - ``await`` :func:`wait_for` + - Run with a timeout. + + * - ``await`` :func:`shield` + - Shield from cancellation. + + * - ``await`` :func:`wait` + - Monitor for completion. + + * - :func:`current_task` + - Return the current Task. + + * - :func:`all_tasks` + - Return all tasks for an event loop. + + * - :class:`Task` + - Task object. + + * - :func:`run_coroutine_threadsafe` + - Schedule a coroutine from another OS thread. + + * - ``for in`` :func:`as_completed` + - Monitor for completion with a ``for`` loop. + + +.. rubric:: Examples + +* :ref:`Using asyncio.gather() to run things in parallel + `. + +* :ref:`Using asyncio.wait_for() to enforce a timeout + `. + +* :ref:`Cancellation `. + +* :ref:`Using asyncio.sleep() `. + +* See also the main :ref:`Tasks documentation page `. + + +Queues +====== + +Queues should be used to distribute work amongst multiple asyncio Tasks, +implement connection pools, and pub/sub patterns. + + +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - :class:`Queue` + - A FIFO queue. + + * - :class:`PriorityQueue` + - A priority queue. + + * - :class:`LifoQueue` + - A LIFO queue. + + +.. rubric:: Examples + +* :ref:`Using asyncio.Queue to distribute workload between several + Tasks `. + +* See also the :ref:`Queues documentation page `. + + +Subprocesses +============ + +Utilities to spawn subprocesses and run shell commands. + +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - ``await`` :func:`create_subprocess_exec` + - Create a subprocess. + + * - ``await`` :func:`create_subprocess_shell` + - Run a shell command. + + +.. rubric:: Examples + +* :ref:`Executing a shell command `. + +* See also the :ref:`subprocess APIs ` + documentation. + + +Streams +======= + +High-level APIs to work with network IO. + +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - ``await`` :func:`open_connection` + - Establish a TCP connection. + + * - ``await`` :func:`open_unix_connection` + - Establish a Unix socket connection. + + * - ``await`` :func:`start_server` + - Start a TCP server. + + * - ``await`` :func:`start_unix_server` + - Start a Unix socket server. + + * - :class:`StreamReader` + - High-level async/await object to receive network data. + + * - :class:`StreamWriter` + - High-level async/await object to send network data. + + +.. rubric:: Examples + +* :ref:`Example TCP client `. + +* See also the :ref:`streams APIs ` + documentation. + + +Synchronization +=============== + +Threading-like synchronization primitives that can be used in Tasks. + +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - :class:`Lock` + - A mutex lock. + + * - :class:`Event` + - An event object. + + * - :class:`Condition` + - A condition object. + + * - :class:`Semaphore` + - A semaphore. + + * - :class:`BoundedSemaphore` + - A bounded semaphore. + + +.. rubric:: Examples + +* :ref:`Using asyncio.Event `. + +* See also the documentation of asyncio + :ref:`synchronization primitives `. + + +Exceptions +========== + +.. list-table:: + :widths: 50 50 + :class: full-width-table + + + * - :exc:`asyncio.TimeoutError` + - Raised on timeout by functions like :func:`wait_for`. + Keep in mind that ``asyncio.TimeoutError`` is **unrelated** + to the built-in :exc:`TimeoutError` exception. + + * - :exc:`asyncio.CancelledError` + - Raised when a Task is cancelled. See also :meth:`Task.cancel`. + + +.. rubric:: Examples + +* :ref:`Handling CancelledError to run code on cancellation request + `. + +* See also the full list of + :ref:`asyncio-specific exceptions `. diff --git a/python-3.7.4-docs-html/_sources/library/asyncio-dev.rst.txt b/python-3.7.4-docs-html/_sources/library/asyncio-dev.rst.txt new file mode 100644 index 0000000..b728803 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/asyncio-dev.rst.txt @@ -0,0 +1,237 @@ +.. currentmodule:: asyncio + +.. _asyncio-dev: + +======================= +Developing with asyncio +======================= + +Asynchronous programming is different from classic "sequential" +programming. + +This page lists common mistakes and traps and explains how +to avoid them. + + +.. _asyncio-debug-mode: + +Debug Mode +========== + +By default asyncio runs in production mode. In order to ease +the development asyncio has a *debug mode*. + +There are several ways to enable asyncio debug mode: + +* Setting the :envvar:`PYTHONASYNCIODEBUG` environment variable to ``1``. + +* Using the :option:`-X` ``dev`` Python command line option. + +* Passing ``debug=True`` to :func:`asyncio.run`. + +* Calling :meth:`loop.set_debug`. + +In addition to enabling the debug mode, consider also: + +* setting the log level of the :ref:`asyncio logger ` to + :py:data:`logging.DEBUG`, for example the following snippet of code + can be run at startup of the application:: + + logging.basicConfig(level=logging.DEBUG) + +* configuring the :mod:`warnings` module to display + :exc:`ResourceWarning` warnings. One way of doing that is by + using the :option:`-W` ``default`` command line option. + + +When the debug mode is enabled: + +* asyncio checks for :ref:`coroutines that were not awaited + ` and logs them; this mitigates + the "forgotten await" pitfall. + +* Many non-threadsafe asyncio APIs (such as :meth:`loop.call_soon` and + :meth:`loop.call_at` methods) raise an exception if they are called + from a wrong thread. + +* The execution time of the I/O selector is logged if it takes too long to + perform an I/O operation. + +* Callbacks taking longer than 100ms are logged. The + :attr:`loop.slow_callback_duration` attribute can be used to set the + minimum execution duration in seconds that is considered "slow". + + +.. _asyncio-multithreading: + +Concurrency and Multithreading +============================== + +An event loop runs in a thread (typically the main thread) and executes +all callbacks and Tasks in its thread. While a Task is running in the +event loop, no other Tasks can run in the same thread. When a Task +executes an ``await`` expression, the running Task gets suspended, and +the event loop executes the next Task. + +To schedule a callback from a different OS thread, the +:meth:`loop.call_soon_threadsafe` method should be used. Example:: + + loop.call_soon_threadsafe(callback, *args) + +Almost all asyncio objects are not thread safe, which is typically +not a problem unless there is code that works with them from outside +of a Task or a callback. If there's a need for such code to call a +low-level asyncio API, the :meth:`loop.call_soon_threadsafe` method +should be used, e.g.:: + + loop.call_soon_threadsafe(fut.cancel) + +To schedule a coroutine object from a different OS thread, the +:func:`run_coroutine_threadsafe` function should be used. It returns a +:class:`concurrent.futures.Future` to access the result:: + + async def coro_func(): + return await asyncio.sleep(1, 42) + + # Later in another OS thread: + + future = asyncio.run_coroutine_threadsafe(coro_func(), loop) + # Wait for the result: + result = future.result() + +To handle signals and to execute subprocesses, the event loop must be +run in the main thread. + +The :meth:`loop.run_in_executor` method can be used with a +:class:`concurrent.futures.ThreadPoolExecutor` to execute +blocking code in a different OS thread without blocking the OS thread +that the event loop runs in. + + +.. _asyncio-handle-blocking: + +Running Blocking Code +===================== + +Blocking (CPU-bound) code should not be called directly. For example, +if a function performs a CPU-intensive calculation for 1 second, +all concurrent asyncio Tasks and IO operations would be delayed +by 1 second. + +An executor can be used to run a task in a different thread or even in +a different process to avoid blocking block the OS thread with the +event loop. See the :meth:`loop.run_in_executor` method for more +details. + + +.. _asyncio-logger: + +Logging +======= + +asyncio uses the :mod:`logging` module and all logging is performed +via the ``"asyncio"`` logger. + +The default log level is :py:data:`logging.INFO`, which can be easily +adjusted:: + + logging.getLogger("asyncio").setLevel(logging.WARNING) + + +.. _asyncio-coroutine-not-scheduled: + +Detect never-awaited coroutines +=============================== + +When a coroutine function is called, but not awaited +(e.g. ``coro()`` instead of ``await coro()``) +or the coroutine is not scheduled with :meth:`asyncio.create_task`, asyncio +will emit a :exc:`RuntimeWarning`:: + + import asyncio + + async def test(): + print("never scheduled") + + async def main(): + test() + + asyncio.run(main()) + +Output:: + + test.py:7: RuntimeWarning: coroutine 'test' was never awaited + test() + +Output in debug mode:: + + test.py:7: RuntimeWarning: coroutine 'test' was never awaited + Coroutine created at (most recent call last) + File "../t.py", line 9, in + asyncio.run(main(), debug=True) + + < .. > + + File "../t.py", line 7, in main + test() + test() + +The usual fix is to either await the coroutine or call the +:meth:`asyncio.create_task` function:: + + async def main(): + await test() + + +Detect never-retrieved exceptions +================================= + +If a :meth:`Future.set_exception` is called but the Future object is +never awaited on, the exception would never be propagated to the +user code. In this case, asyncio would emit a log message when the +Future object is garbage collected. + +Example of an unhandled exception:: + + import asyncio + + async def bug(): + raise Exception("not consumed") + + async def main(): + asyncio.create_task(bug()) + + asyncio.run(main()) + +Output:: + + Task exception was never retrieved + future: + exception=Exception('not consumed')> + + Traceback (most recent call last): + File "test.py", line 4, in bug + raise Exception("not consumed") + Exception: not consumed + +:ref:`Enable the debug mode ` to get the +traceback where the task was created:: + + asyncio.run(main(), debug=True) + +Output in debug mode:: + + Task exception was never retrieved + future: + exception=Exception('not consumed') created at asyncio/tasks.py:321> + + source_traceback: Object created at (most recent call last): + File "../t.py", line 9, in + asyncio.run(main(), debug=True) + + < .. > + + Traceback (most recent call last): + File "../t.py", line 4, in bug + raise Exception("not consumed") + Exception: not consumed diff --git a/python-3.7.4-docs-html/_sources/library/asyncio-eventloop.rst.txt b/python-3.7.4-docs-html/_sources/library/asyncio-eventloop.rst.txt new file mode 100644 index 0000000..7e1d571 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/asyncio-eventloop.rst.txt @@ -0,0 +1,1625 @@ +.. currentmodule:: asyncio + + +========== +Event Loop +========== + + +.. rubric:: Preface + +The event loop is the core of every asyncio application. +Event loops run asynchronous tasks and callbacks, perform network +IO operations, and run subprocesses. + +Application developers should typically use the high-level asyncio functions, +such as :func:`asyncio.run`, and should rarely need to reference the loop +object or call its methods. This section is intended mostly for authors +of lower-level code, libraries, and frameworks, who need finer control over +the event loop behavior. + +.. rubric:: Obtaining the Event Loop + +The following low-level functions can be used to get, set, or create +an event loop: + +.. function:: get_running_loop() + + Return the running event loop in the current OS thread. + + If there is no running event loop a :exc:`RuntimeError` is raised. + This function can only be called from a coroutine or a callback. + + .. versionadded:: 3.7 + +.. function:: get_event_loop() + + Get the current event loop. If there is no current event loop set + in the current OS thread and :func:`set_event_loop` has not yet + been called, asyncio will create a new event loop and set it as the + current one. + + Because this function has rather complex behavior (especially + when custom event loop policies are in use), using the + :func:`get_running_loop` function is preferred to :func:`get_event_loop` + in coroutines and callbacks. + + Consider also using the :func:`asyncio.run` function instead of using + lower level functions to manually create and close an event loop. + +.. function:: set_event_loop(loop) + + Set *loop* as a current event loop for the current OS thread. + +.. function:: new_event_loop() + + Create a new event loop object. + +Note that the behaviour of :func:`get_event_loop`, :func:`set_event_loop`, +and :func:`new_event_loop` functions can be altered by +:ref:`setting a custom event loop policy `. + + +.. rubric:: Contents + +This documentation page contains the following sections: + +* The `Event Loop Methods`_ section is the reference documentation of + the event loop APIs; + +* The `Callback Handles`_ section documents the :class:`Handle` and + :class:`TimerHandle` instances which are returned from scheduling + methods such as :meth:`loop.call_soon` and :meth:`loop.call_later`; + +* The `Server Objects`_ section documents types returned from + event loop methods like :meth:`loop.create_server`; + +* The `Event Loop Implementations`_ section documents the + :class:`SelectorEventLoop` and :class:`ProactorEventLoop` classes; + +* The `Examples`_ section showcases how to work with some event + loop APIs. + + +.. _asyncio-event-loop: + +Event Loop Methods +================== + +Event loops have **low-level** APIs for the following: + +.. contents:: + :depth: 1 + :local: + + +Running and stopping the loop +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. method:: loop.run_until_complete(future) + + Run until the *future* (an instance of :class:`Future`) has + completed. + + If the argument is a :ref:`coroutine object ` it + is implicitly scheduled to run as a :class:`asyncio.Task`. + + Return the Future's result or raise its exception. + +.. method:: loop.run_forever() + + Run the event loop until :meth:`stop` is called. + + If :meth:`stop` is called before :meth:`run_forever()` is called, + the loop will poll the I/O selector once with a timeout of zero, + run all callbacks scheduled in response to I/O events (and + those that were already scheduled), and then exit. + + If :meth:`stop` is called while :meth:`run_forever` is running, + the loop will run the current batch of callbacks and then exit. + Note that new callbacks scheduled by callbacks will not run in this + case; instead, they will run the next time :meth:`run_forever` or + :meth:`run_until_complete` is called. + +.. method:: loop.stop() + + Stop the event loop. + +.. method:: loop.is_running() + + Return ``True`` if the event loop is currently running. + +.. method:: loop.is_closed() + + Return ``True`` if the event loop was closed. + +.. method:: loop.close() + + Close the event loop. + + The loop must not be running when this function is called. + Any pending callbacks will be discarded. + + This method clears all queues and shuts down the executor, but does + not wait for the executor to finish. + + This method is idempotent and irreversible. No other methods + should be called after the event loop is closed. + +.. coroutinemethod:: loop.shutdown_asyncgens() + + Schedule all currently open :term:`asynchronous generator` objects to + close with an :meth:`~agen.aclose()` call. After calling this method, + the event loop will issue a warning if a new asynchronous generator + is iterated. This should be used to reliably finalize all scheduled + asynchronous generators. + + Note that there is no need to call this function when + :func:`asyncio.run` is used. + + Example:: + + try: + loop.run_forever() + finally: + loop.run_until_complete(loop.shutdown_asyncgens()) + loop.close() + + .. versionadded:: 3.6 + + +Scheduling callbacks +^^^^^^^^^^^^^^^^^^^^ + +.. method:: loop.call_soon(callback, *args, context=None) + + Schedule a *callback* to be called with *args* arguments at + the next iteration of the event loop. + + Callbacks are called in the order in which they are registered. + Each callback will be called exactly once. + + An optional keyword-only *context* argument allows specifying a + custom :class:`contextvars.Context` for the *callback* to run in. + The current context is used when no *context* is provided. + + An instance of :class:`asyncio.Handle` is returned, which can be + used later to cancel the callback. + + This method is not thread-safe. + +.. method:: loop.call_soon_threadsafe(callback, *args, context=None) + + A thread-safe variant of :meth:`call_soon`. Must be used to + schedule callbacks *from another thread*. + + See the :ref:`concurrency and multithreading ` + section of the documentation. + +.. versionchanged:: 3.7 + The *context* keyword-only parameter was added. See :pep:`567` + for more details. + +.. _asyncio-pass-keywords: + +.. note:: + + Most :mod:`asyncio` scheduling functions don't allow passing + keyword arguments. To do that, use :func:`functools.partial`:: + + # will schedule "print("Hello", flush=True)" + loop.call_soon( + functools.partial(print, "Hello", flush=True)) + + Using partial objects is usually more convenient than using lambdas, + as asyncio can render partial objects better in debug and error + messages. + + +.. _asyncio-delayed-calls: + +Scheduling delayed callbacks +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Event loop provides mechanisms to schedule callback functions +to be called at some point in the future. Event loop uses monotonic +clocks to track time. + + +.. method:: loop.call_later(delay, callback, *args, context=None) + + Schedule *callback* to be called after the given *delay* + number of seconds (can be either an int or a float). + + An instance of :class:`asyncio.TimerHandle` is returned which can + be used to cancel the callback. + + *callback* will be called exactly once. If two callbacks are + scheduled for exactly the same time, the order in which they + are called is undefined. + + The optional positional *args* will be passed to the callback when + it is called. If you want the callback to be called with keyword + arguments use :func:`functools.partial`. + + An optional keyword-only *context* argument allows specifying a + custom :class:`contextvars.Context` for the *callback* to run in. + The current context is used when no *context* is provided. + + .. versionchanged:: 3.7 + The *context* keyword-only parameter was added. See :pep:`567` + for more details. + + .. versionchanged:: 3.7.1 + In Python 3.7.0 and earlier with the default event loop implementation, + the *delay* could not exceed one day. + This has been fixed in Python 3.7.1. + +.. method:: loop.call_at(when, callback, *args, context=None) + + Schedule *callback* to be called at the given absolute timestamp + *when* (an int or a float), using the same time reference as + :meth:`loop.time`. + + This method's behavior is the same as :meth:`call_later`. + + An instance of :class:`asyncio.TimerHandle` is returned which can + be used to cancel the callback. + + .. versionchanged:: 3.7 + The *context* keyword-only parameter was added. See :pep:`567` + for more details. + + .. versionchanged:: 3.7.1 + In Python 3.7.0 and earlier with the default event loop implementation, + the difference between *when* and the current time could not exceed + one day. This has been fixed in Python 3.7.1. + +.. method:: loop.time() + + Return the current time, as a :class:`float` value, according to + the event loop's internal monotonic clock. + +.. note:: + .. versionchanged:: 3.8 + In Python 3.7 and earlier timeouts (relative *delay* or absolute *when*) + should not exceed one day. This has been fixed in Python 3.8. + +.. seealso:: + + The :func:`asyncio.sleep` function. + + +Creating Futures and Tasks +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. method:: loop.create_future() + + Create an :class:`asyncio.Future` object attached to the event loop. + + This is the preferred way to create Futures in asyncio. This lets + third-party event loops provide alternative implementations of + the Future object (with better performance or instrumentation). + + .. versionadded:: 3.5.2 + +.. method:: loop.create_task(coro) + + Schedule the execution of a :ref:`coroutine`. + Return a :class:`Task` object. + + Third-party event loops can use their own subclass of :class:`Task` + for interoperability. In this case, the result type is a subclass + of :class:`Task`. + +.. method:: loop.set_task_factory(factory) + + Set a task factory that will be used by + :meth:`loop.create_task`. + + If *factory* is ``None`` the default task factory will be set. + Otherwise, *factory* must be a *callable* with the signature matching + ``(loop, coro)``, where *loop* is a reference to the active + event loop, and *coro* is a coroutine object. The callable + must return a :class:`asyncio.Future`-compatible object. + +.. method:: loop.get_task_factory() + + Return a task factory or ``None`` if the default one is in use. + + +Opening network connections +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. coroutinemethod:: loop.create_connection(protocol_factory, \ + host=None, port=None, \*, ssl=None, \ + family=0, proto=0, flags=0, sock=None, \ + local_addr=None, server_hostname=None, \ + ssl_handshake_timeout=None) + + Open a streaming transport connection to a given + address specified by *host* and *port*. + + The socket family can be either :py:data:`~socket.AF_INET` or + :py:data:`~socket.AF_INET6` depending on *host* (or the *family* + argument, if provided). + + The socket type will be :py:data:`~socket.SOCK_STREAM`. + + *protocol_factory* must be a callable returning an + :ref:`asyncio protocol ` implementation. + + This method will try to establish the connection in the background. + When successful, it returns a ``(transport, protocol)`` pair. + + The chronological synopsis of the underlying operation is as follows: + + #. The connection is established and a :ref:`transport ` + is created for it. + + #. *protocol_factory* is called without arguments and is expected to + return a :ref:`protocol ` instance. + + #. The protocol instance is coupled with the transport by calling its + :meth:`~BaseProtocol.connection_made` method. + + #. A ``(transport, protocol)`` tuple is returned on success. + + The created transport is an implementation-dependent bidirectional + stream. + + Other arguments: + + * *ssl*: if given and not false, a SSL/TLS transport is created + (by default a plain TCP transport is created). If *ssl* is + a :class:`ssl.SSLContext` object, this context is used to create + the transport; if *ssl* is :const:`True`, a default context returned + from :func:`ssl.create_default_context` is used. + + .. seealso:: :ref:`SSL/TLS security considerations ` + + * *server_hostname* sets or overrides the hostname that the target + server's certificate will be matched against. Should only be passed + if *ssl* is not ``None``. By default the value of the *host* argument + is used. If *host* is empty, there is no default and you must pass a + value for *server_hostname*. If *server_hostname* is an empty + string, hostname matching is disabled (which is a serious security + risk, allowing for potential man-in-the-middle attacks). + + * *family*, *proto*, *flags* are the optional address family, protocol + and flags to be passed through to getaddrinfo() for *host* resolution. + If given, these should all be integers from the corresponding + :mod:`socket` module constants. + + * *sock*, if given, should be an existing, already connected + :class:`socket.socket` object to be used by the transport. + If *sock* is given, none of *host*, *port*, *family*, *proto*, *flags* + and *local_addr* should be specified. + + * *local_addr*, if given, is a ``(local_host, local_port)`` tuple used + to bind the socket to locally. The *local_host* and *local_port* + are looked up using ``getaddrinfo()``, similarly to *host* and *port*. + + * *ssl_handshake_timeout* is (for a TLS connection) the time in seconds + to wait for the TLS handshake to complete before aborting the connection. + ``60.0`` seconds if ``None`` (default). + + .. versionadded:: 3.7 + + The *ssl_handshake_timeout* parameter. + + .. versionchanged:: 3.6 + + The socket option :py:data:`~socket.TCP_NODELAY` is set by default + for all TCP connections. + + .. versionchanged:: 3.5 + + Added support for SSL/TLS in :class:`ProactorEventLoop`. + + .. seealso:: + + The :func:`open_connection` function is a high-level alternative + API. It returns a pair of (:class:`StreamReader`, :class:`StreamWriter`) + that can be used directly in async/await code. + +.. coroutinemethod:: loop.create_datagram_endpoint(protocol_factory, \ + local_addr=None, remote_addr=None, \*, \ + family=0, proto=0, flags=0, \ + reuse_address=None, reuse_port=None, \ + allow_broadcast=None, sock=None) + + Create a datagram connection. + + The socket family can be either :py:data:`~socket.AF_INET`, + :py:data:`~socket.AF_INET6`, or :py:data:`~socket.AF_UNIX`, + depending on *host* (or the *family* argument, if provided). + + The socket type will be :py:data:`~socket.SOCK_DGRAM`. + + *protocol_factory* must be a callable returning a + :ref:`protocol ` implementation. + + A tuple of ``(transport, protocol)`` is returned on success. + + Other arguments: + + * *local_addr*, if given, is a ``(local_host, local_port)`` tuple used + to bind the socket to locally. The *local_host* and *local_port* + are looked up using :meth:`getaddrinfo`. + + * *remote_addr*, if given, is a ``(remote_host, remote_port)`` tuple used + to connect the socket to a remote address. The *remote_host* and + *remote_port* are looked up using :meth:`getaddrinfo`. + + * *family*, *proto*, *flags* are the optional address family, protocol + and flags to be passed through to :meth:`getaddrinfo` for *host* + resolution. If given, these should all be integers from the + corresponding :mod:`socket` module constants. + + * *reuse_address* tells the kernel to reuse a local socket in + ``TIME_WAIT`` state, without waiting for its natural timeout to + expire. If not specified will automatically be set to ``True`` on + Unix. + + * *reuse_port* tells the kernel to allow this endpoint to be bound to the + same port as other existing endpoints are bound to, so long as they all + set this flag when being created. This option is not supported on Windows + and some Unixes. If the :py:data:`~socket.SO_REUSEPORT` constant is not + defined then this capability is unsupported. + + * *allow_broadcast* tells the kernel to allow this endpoint to send + messages to the broadcast address. + + * *sock* can optionally be specified in order to use a preexisting, + already connected, :class:`socket.socket` object to be used by the + transport. If specified, *local_addr* and *remote_addr* should be omitted + (must be :const:`None`). + + On Windows, with :class:`ProactorEventLoop`, this method is not supported. + + See :ref:`UDP echo client protocol ` and + :ref:`UDP echo server protocol ` examples. + + .. versionchanged:: 3.4.4 + The *family*, *proto*, *flags*, *reuse_address*, *reuse_port, + *allow_broadcast*, and *sock* parameters were added. + +.. coroutinemethod:: loop.create_unix_connection(protocol_factory, \ + path=None, \*, ssl=None, sock=None, \ + server_hostname=None, ssl_handshake_timeout=None) + + Create a Unix connection. + + The socket family will be :py:data:`~socket.AF_UNIX`; socket + type will be :py:data:`~socket.SOCK_STREAM`. + + A tuple of ``(transport, protocol)`` is returned on success. + + *path* is the name of a Unix domain socket and is required, + unless a *sock* parameter is specified. Abstract Unix sockets, + :class:`str`, :class:`bytes`, and :class:`~pathlib.Path` paths are + supported. + + See the documentation of the :meth:`loop.create_connection` method + for information about arguments to this method. + + .. availability:: Unix. + + .. versionadded:: 3.7 + + The *ssl_handshake_timeout* parameter. + + .. versionchanged:: 3.7 + + The *path* parameter can now be a :term:`path-like object`. + + +Creating network servers +^^^^^^^^^^^^^^^^^^^^^^^^ + +.. coroutinemethod:: loop.create_server(protocol_factory, \ + host=None, port=None, \*, \ + family=socket.AF_UNSPEC, \ + flags=socket.AI_PASSIVE, \ + sock=None, backlog=100, ssl=None, \ + reuse_address=None, reuse_port=None, \ + ssl_handshake_timeout=None, start_serving=True) + + Create a TCP server (socket type :data:`~socket.SOCK_STREAM`) listening + on *port* of the *host* address. + + Returns a :class:`Server` object. + + Arguments: + + * *protocol_factory* must be a callable returning a + :ref:`protocol ` implementation. + + * The *host* parameter can be set to several types which determine where + the server would be listening: + + - If *host* is a string, the TCP server is bound to a single network + interface specified by *host*. + + - If *host* is a sequence of strings, the TCP server is bound to all + network interfaces specified by the sequence. + + - If *host* is an empty string or ``None``, all interfaces are + assumed and a list of multiple sockets will be returned (most likely + one for IPv4 and another one for IPv6). + + * *family* can be set to either :data:`socket.AF_INET` or + :data:`~socket.AF_INET6` to force the socket to use IPv4 or IPv6. + If not set, the *family* will be determined from host name + (defaults to :data:`~socket.AF_UNSPEC`). + + * *flags* is a bitmask for :meth:`getaddrinfo`. + + * *sock* can optionally be specified in order to use a preexisting + socket object. If specified, *host* and *port* must not be specified. + + * *backlog* is the maximum number of queued connections passed to + :meth:`~socket.socket.listen` (defaults to 100). + + * *ssl* can be set to an :class:`~ssl.SSLContext` instance to enable + TLS over the accepted connections. + + * *reuse_address* tells the kernel to reuse a local socket in + ``TIME_WAIT`` state, without waiting for its natural timeout to + expire. If not specified will automatically be set to ``True`` on + Unix. + + * *reuse_port* tells the kernel to allow this endpoint to be bound to the + same port as other existing endpoints are bound to, so long as they all + set this flag when being created. This option is not supported on + Windows. + + * *ssl_handshake_timeout* is (for a TLS server) the time in seconds to wait + for the TLS handshake to complete before aborting the connection. + ``60.0`` seconds if ``None`` (default). + + * *start_serving* set to ``True`` (the default) causes the created server + to start accepting connections immediately. When set to ``False``, + the user should await on :meth:`Server.start_serving` or + :meth:`Server.serve_forever` to make the server to start accepting + connections. + + .. versionadded:: 3.7 + + Added *ssl_handshake_timeout* and *start_serving* parameters. + + .. versionchanged:: 3.6 + + The socket option :py:data:`~socket.TCP_NODELAY` is set by default + for all TCP connections. + + .. versionchanged:: 3.5 + + Added support for SSL/TLS in :class:`ProactorEventLoop`. + + .. versionchanged:: 3.5.1 + + The *host* parameter can be a sequence of strings. + + .. seealso:: + + The :func:`start_server` function is a higher-level alternative API + that returns a pair of :class:`StreamReader` and :class:`StreamWriter` + that can be used in an async/await code. + + +.. coroutinemethod:: loop.create_unix_server(protocol_factory, path=None, \ + \*, sock=None, backlog=100, ssl=None, \ + ssl_handshake_timeout=None, start_serving=True) + + Similar to :meth:`loop.create_server` but works with the + :py:data:`~socket.AF_UNIX` socket family. + + *path* is the name of a Unix domain socket, and is required, + unless a *sock* argument is provided. Abstract Unix sockets, + :class:`str`, :class:`bytes`, and :class:`~pathlib.Path` paths + are supported. + + See the documentation of the :meth:`loop.create_server` method + for information about arguments to this method. + + .. availability:: Unix. + + .. versionadded:: 3.7 + + The *ssl_handshake_timeout* and *start_serving* parameters. + + .. versionchanged:: 3.7 + + The *path* parameter can now be a :class:`~pathlib.Path` object. + +.. coroutinemethod:: loop.connect_accepted_socket(protocol_factory, \ + sock, \*, ssl=None, ssl_handshake_timeout=None) + + Wrap an already accepted connection into a transport/protocol pair. + + This method can be used by servers that accept connections outside + of asyncio but that use asyncio to handle them. + + Parameters: + + * *protocol_factory* must be a callable returning a + :ref:`protocol ` implementation. + + * *sock* is a preexisting socket object returned from + :meth:`socket.accept `. + + * *ssl* can be set to an :class:`~ssl.SSLContext` to enable SSL over + the accepted connections. + + * *ssl_handshake_timeout* is (for an SSL connection) the time in seconds to + wait for the SSL handshake to complete before aborting the connection. + ``60.0`` seconds if ``None`` (default). + + Returns a ``(transport, protocol)`` pair. + + .. versionadded:: 3.7 + + The *ssl_handshake_timeout* parameter. + + .. versionadded:: 3.5.3 + + +Transferring files +^^^^^^^^^^^^^^^^^^ + +.. coroutinemethod:: loop.sendfile(transport, file, \ + offset=0, count=None, *, fallback=True) + + Send a *file* over a *transport*. Return the total number of bytes + sent. + + The method uses high-performance :meth:`os.sendfile` if available. + + *file* must be a regular file object opened in binary mode. + + *offset* tells from where to start reading the file. If specified, + *count* is the total number of bytes to transmit as opposed to + sending the file until EOF is reached. File position is always updated, + even when this method raises an error, and + :meth:`file.tell() ` can be used to obtain the actual + number of bytes sent. + + *fallback* set to ``True`` makes asyncio to manually read and send + the file when the platform does not support the sendfile system call + (e.g. Windows or SSL socket on Unix). + + Raise :exc:`SendfileNotAvailableError` if the system does not support + the *sendfile* syscall and *fallback* is ``False``. + + .. versionadded:: 3.7 + + +TLS Upgrade +^^^^^^^^^^^ + +.. coroutinemethod:: loop.start_tls(transport, protocol, \ + sslcontext, \*, server_side=False, \ + server_hostname=None, ssl_handshake_timeout=None) + + Upgrade an existing transport-based connection to TLS. + + Return a new transport instance, that the *protocol* must start using + immediately after the *await*. The *transport* instance passed to + the *start_tls* method should never be used again. + + Parameters: + + * *transport* and *protocol* instances that methods like + :meth:`~loop.create_server` and + :meth:`~loop.create_connection` return. + + * *sslcontext*: a configured instance of :class:`~ssl.SSLContext`. + + * *server_side* pass ``True`` when a server-side connection is being + upgraded (like the one created by :meth:`~loop.create_server`). + + * *server_hostname*: sets or overrides the host name that the target + server's certificate will be matched against. + + * *ssl_handshake_timeout* is (for a TLS connection) the time in seconds to + wait for the TLS handshake to complete before aborting the connection. + ``60.0`` seconds if ``None`` (default). + + .. versionadded:: 3.7 + + +Watching file descriptors +^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. method:: loop.add_reader(fd, callback, \*args) + + Start monitoring the *fd* file descriptor for read availability and + invoke *callback* with the specified arguments once *fd* is available for + reading. + +.. method:: loop.remove_reader(fd) + + Stop monitoring the *fd* file descriptor for read availability. + +.. method:: loop.add_writer(fd, callback, \*args) + + Start monitoring the *fd* file descriptor for write availability and + invoke *callback* with the specified arguments once *fd* is available for + writing. + + Use :func:`functools.partial` :ref:`to pass keyword arguments + ` to *callback*. + +.. method:: loop.remove_writer(fd) + + Stop monitoring the *fd* file descriptor for write availability. + +See also :ref:`Platform Support ` section +for some limitations of these methods. + + +Working with socket objects directly +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In general, protocol implementations that use transport-based APIs +such as :meth:`loop.create_connection` and :meth:`loop.create_server` +are faster than implementations that work with sockets directly. +However, there are some use cases when performance is not critical, and +working with :class:`~socket.socket` objects directly is more +convenient. + +.. coroutinemethod:: loop.sock_recv(sock, nbytes) + + Receive up to *nbytes* from *sock*. Asynchronous version of + :meth:`socket.recv() `. + + Return the received data as a bytes object. + + *sock* must be a non-blocking socket. + + .. versionchanged:: 3.7 + Even though this method was always documented as a coroutine + method, releases before Python 3.7 returned a :class:`Future`. + Since Python 3.7 this is an ``async def`` method. + +.. coroutinemethod:: loop.sock_recv_into(sock, buf) + + Receive data from *sock* into the *buf* buffer. Modeled after the blocking + :meth:`socket.recv_into() ` method. + + Return the number of bytes written to the buffer. + + *sock* must be a non-blocking socket. + + .. versionadded:: 3.7 + +.. coroutinemethod:: loop.sock_sendall(sock, data) + + Send *data* to the *sock* socket. Asynchronous version of + :meth:`socket.sendall() `. + + This method continues to send to the socket until either all data + in *data* has been sent or an error occurs. ``None`` is returned + on success. On error, an exception is raised. Additionally, there is no way + to determine how much data, if any, was successfully processed by the + receiving end of the connection. + + *sock* must be a non-blocking socket. + + .. versionchanged:: 3.7 + Even though the method was always documented as a coroutine + method, before Python 3.7 it returned an :class:`Future`. + Since Python 3.7, this is an ``async def`` method. + +.. coroutinemethod:: loop.sock_connect(sock, address) + + Connect *sock* to a remote socket at *address*. + + Asynchronous version of :meth:`socket.connect() `. + + *sock* must be a non-blocking socket. + + .. versionchanged:: 3.5.2 + ``address`` no longer needs to be resolved. ``sock_connect`` + will try to check if the *address* is already resolved by calling + :func:`socket.inet_pton`. If not, + :meth:`loop.getaddrinfo` will be used to resolve the + *address*. + + .. seealso:: + + :meth:`loop.create_connection` + and :func:`asyncio.open_connection() `. + + +.. coroutinemethod:: loop.sock_accept(sock) + + Accept a connection. Modeled after the blocking + :meth:`socket.accept() ` method. + + The socket must be bound to an address and listening + for connections. The return value is a pair ``(conn, address)`` where *conn* + is a *new* socket object usable to send and receive data on the connection, + and *address* is the address bound to the socket on the other end of the + connection. + + *sock* must be a non-blocking socket. + + .. versionchanged:: 3.7 + Even though the method was always documented as a coroutine + method, before Python 3.7 it returned a :class:`Future`. + Since Python 3.7, this is an ``async def`` method. + + .. seealso:: + + :meth:`loop.create_server` and :func:`start_server`. + +.. coroutinemethod:: loop.sock_sendfile(sock, file, offset=0, count=None, \ + \*, fallback=True) + + Send a file using high-performance :mod:`os.sendfile` if possible. + Return the total number of bytes sent. + + Asynchronous version of :meth:`socket.sendfile() `. + + *sock* must be a non-blocking :const:`socket.SOCK_STREAM` + :class:`~socket.socket`. + + *file* must be a regular file object open in binary mode. + + *offset* tells from where to start reading the file. If specified, + *count* is the total number of bytes to transmit as opposed to + sending the file until EOF is reached. File position is always updated, + even when this method raises an error, and + :meth:`file.tell() ` can be used to obtain the actual + number of bytes sent. + + *fallback*, when set to ``True``, makes asyncio manually read and send + the file when the platform does not support the sendfile syscall + (e.g. Windows or SSL socket on Unix). + + Raise :exc:`SendfileNotAvailableError` if the system does not support + *sendfile* syscall and *fallback* is ``False``. + + *sock* must be a non-blocking socket. + + .. versionadded:: 3.7 + + +DNS +^^^ + +.. coroutinemethod:: loop.getaddrinfo(host, port, \*, family=0, \ + type=0, proto=0, flags=0) + + Asynchronous version of :meth:`socket.getaddrinfo`. + +.. coroutinemethod:: loop.getnameinfo(sockaddr, flags=0) + + Asynchronous version of :meth:`socket.getnameinfo`. + +.. versionchanged:: 3.7 + Both *getaddrinfo* and *getnameinfo* methods were always documented + to return a coroutine, but prior to Python 3.7 they were, in fact, + returning :class:`asyncio.Future` objects. Starting with Python 3.7 + both methods are coroutines. + + +Working with pipes +^^^^^^^^^^^^^^^^^^ + +.. coroutinemethod:: loop.connect_read_pipe(protocol_factory, pipe) + + Register the read end of *pipe* in the event loop. + + *protocol_factory* must be a callable returning an + :ref:`asyncio protocol ` implementation. + + *pipe* is a :term:`file-like object `. + + Return pair ``(transport, protocol)``, where *transport* supports + the :class:`ReadTransport` interface and *protocol* is an object + instantiated by the *protocol_factory*. + + With :class:`SelectorEventLoop` event loop, the *pipe* is set to + non-blocking mode. + +.. coroutinemethod:: loop.connect_write_pipe(protocol_factory, pipe) + + Register the write end of *pipe* in the event loop. + + *protocol_factory* must be a callable returning an + :ref:`asyncio protocol ` implementation. + + *pipe* is :term:`file-like object `. + + Return pair ``(transport, protocol)``, where *transport* supports + :class:`WriteTransport` interface and *protocol* is an object + instantiated by the *protocol_factory*. + + With :class:`SelectorEventLoop` event loop, the *pipe* is set to + non-blocking mode. + +.. note:: + + :class:`SelectorEventLoop` does not support the above methods on + Windows. Use :class:`ProactorEventLoop` instead for Windows. + +.. seealso:: + + The :meth:`loop.subprocess_exec` and + :meth:`loop.subprocess_shell` methods. + + +Unix signals +^^^^^^^^^^^^ + +.. method:: loop.add_signal_handler(signum, callback, \*args) + + Set *callback* as the handler for the *signum* signal. + + The callback will be invoked by *loop*, along with other queued callbacks + and runnable coroutines of that event loop. Unlike signal handlers + registered using :func:`signal.signal`, a callback registered with this + function is allowed to interact with the event loop. + + Raise :exc:`ValueError` if the signal number is invalid or uncatchable. + Raise :exc:`RuntimeError` if there is a problem setting up the handler. + + Use :func:`functools.partial` :ref:`to pass keyword arguments + ` to *callback*. + + Like :func:`signal.signal`, this function must be invoked in the main + thread. + +.. method:: loop.remove_signal_handler(sig) + + Remove the handler for the *sig* signal. + + Return ``True`` if the signal handler was removed, or ``False`` if + no handler was set for the given signal. + + .. availability:: Unix. + +.. seealso:: + + The :mod:`signal` module. + + +Executing code in thread or process pools +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. awaitablemethod:: loop.run_in_executor(executor, func, \*args) + + Arrange for *func* to be called in the specified executor. + + The *executor* argument should be an :class:`concurrent.futures.Executor` + instance. The default executor is used if *executor* is ``None``. + + Example:: + + import asyncio + import concurrent.futures + + def blocking_io(): + # File operations (such as logging) can block the + # event loop: run them in a thread pool. + with open('/dev/urandom', 'rb') as f: + return f.read(100) + + def cpu_bound(): + # CPU-bound operations will block the event loop: + # in general it is preferable to run them in a + # process pool. + return sum(i * i for i in range(10 ** 7)) + + async def main(): + loop = asyncio.get_running_loop() + + ## Options: + + # 1. Run in the default loop's executor: + result = await loop.run_in_executor( + None, blocking_io) + print('default thread pool', result) + + # 2. Run in a custom thread pool: + with concurrent.futures.ThreadPoolExecutor() as pool: + result = await loop.run_in_executor( + pool, blocking_io) + print('custom thread pool', result) + + # 3. Run in a custom process pool: + with concurrent.futures.ProcessPoolExecutor() as pool: + result = await loop.run_in_executor( + pool, cpu_bound) + print('custom process pool', result) + + asyncio.run(main()) + + This method returns a :class:`asyncio.Future` object. + + Use :func:`functools.partial` :ref:`to pass keyword arguments + ` to *func*. + + .. versionchanged:: 3.5.3 + :meth:`loop.run_in_executor` no longer configures the + ``max_workers`` of the thread pool executor it creates, instead + leaving it up to the thread pool executor + (:class:`~concurrent.futures.ThreadPoolExecutor`) to set the + default. + +.. method:: loop.set_default_executor(executor) + + Set *executor* as the default executor used by :meth:`run_in_executor`. + *executor* should be an instance of + :class:`~concurrent.futures.ThreadPoolExecutor`. + + .. deprecated:: 3.7 + Using an executor that is not an instance of + :class:`~concurrent.futures.ThreadPoolExecutor` is deprecated and + will trigger an error in Python 3.9. + + *executor* must be an instance of + :class:`concurrent.futures.ThreadPoolExecutor`. + + +Error Handling API +^^^^^^^^^^^^^^^^^^ + +Allows customizing how exceptions are handled in the event loop. + +.. method:: loop.set_exception_handler(handler) + + Set *handler* as the new event loop exception handler. + + If *handler* is ``None``, the default exception handler will + be set. Otherwise, *handler* must be a callable with the signature + matching ``(loop, context)``, where ``loop`` + is a reference to the active event loop, and ``context`` + is a ``dict`` object containing the details of the exception + (see :meth:`call_exception_handler` documentation for details + about context). + +.. method:: loop.get_exception_handler() + + Return the current exception handler, or ``None`` if no custom + exception handler was set. + + .. versionadded:: 3.5.2 + +.. method:: loop.default_exception_handler(context) + + Default exception handler. + + This is called when an exception occurs and no exception + handler is set. This can be called by a custom exception + handler that wants to defer to the default handler behavior. + + *context* parameter has the same meaning as in + :meth:`call_exception_handler`. + +.. method:: loop.call_exception_handler(context) + + Call the current event loop exception handler. + + *context* is a ``dict`` object containing the following keys + (new keys may be introduced in future Python versions): + + * 'message': Error message; + * 'exception' (optional): Exception object; + * 'future' (optional): :class:`asyncio.Future` instance; + * 'handle' (optional): :class:`asyncio.Handle` instance; + * 'protocol' (optional): :ref:`Protocol ` instance; + * 'transport' (optional): :ref:`Transport ` instance; + * 'socket' (optional): :class:`socket.socket` instance. + + .. note:: + + This method should not be overloaded in subclassed + event loops. For custom exception handling, use + the :meth:`set_exception_handler()` method. + +Enabling debug mode +^^^^^^^^^^^^^^^^^^^ + +.. method:: loop.get_debug() + + Get the debug mode (:class:`bool`) of the event loop. + + The default value is ``True`` if the environment variable + :envvar:`PYTHONASYNCIODEBUG` is set to a non-empty string, ``False`` + otherwise. + +.. method:: loop.set_debug(enabled: bool) + + Set the debug mode of the event loop. + + .. versionchanged:: 3.7 + + The new ``-X dev`` command line option can now also be used + to enable the debug mode. + +.. seealso:: + + The :ref:`debug mode of asyncio `. + + +Running Subprocesses +^^^^^^^^^^^^^^^^^^^^ + +Methods described in this subsections are low-level. In regular +async/await code consider using the high-level +:func:`asyncio.create_subprocess_shell` and +:func:`asyncio.create_subprocess_exec` convenience functions instead. + +.. note:: + + The default asyncio event loop on **Windows** does not support + subprocesses. See :ref:`Subprocess Support on Windows + ` for details. + +.. coroutinemethod:: loop.subprocess_exec(protocol_factory, \*args, \ + stdin=subprocess.PIPE, stdout=subprocess.PIPE, \ + stderr=subprocess.PIPE, \*\*kwargs) + + Create a subprocess from one or more string arguments specified by + *args*. + + *args* must be a list of strings represented by: + + * :class:`str`; + * or :class:`bytes`, encoded to the + :ref:`filesystem encoding `. + + The first string specifies the program executable, + and the remaining strings specify the arguments. Together, string + arguments form the ``argv`` of the program. + + This is similar to the standard library :class:`subprocess.Popen` + class called with ``shell=False`` and the list of strings passed as + the first argument; however, where :class:`~subprocess.Popen` takes + a single argument which is list of strings, *subprocess_exec* + takes multiple string arguments. + + The *protocol_factory* must be a callable returning a subclass of the + :class:`asyncio.SubprocessProtocol` class. + + Other parameters: + + * *stdin*: either a file-like object representing a pipe to be + connected to the subprocess's standard input stream using + :meth:`~loop.connect_write_pipe`, or the + :const:`subprocess.PIPE` constant (default). By default a new + pipe will be created and connected. + + * *stdout*: either a file-like object representing the pipe to be + connected to the subprocess's standard output stream using + :meth:`~loop.connect_read_pipe`, or the + :const:`subprocess.PIPE` constant (default). By default a new pipe + will be created and connected. + + * *stderr*: either a file-like object representing the pipe to be + connected to the subprocess's standard error stream using + :meth:`~loop.connect_read_pipe`, or one of + :const:`subprocess.PIPE` (default) or :const:`subprocess.STDOUT` + constants. + + By default a new pipe will be created and connected. When + :const:`subprocess.STDOUT` is specified, the subprocess' standard + error stream will be connected to the same pipe as the standard + output stream. + + * All other keyword arguments are passed to :class:`subprocess.Popen` + without interpretation, except for *bufsize*, *universal_newlines* + and *shell*, which should not be specified at all. + + See the constructor of the :class:`subprocess.Popen` class + for documentation on other arguments. + + Returns a pair of ``(transport, protocol)``, where *transport* + conforms to the :class:`asyncio.SubprocessTransport` base class and + *protocol* is an object instantiated by the *protocol_factory*. + +.. coroutinemethod:: loop.subprocess_shell(protocol_factory, cmd, \*, \ + stdin=subprocess.PIPE, stdout=subprocess.PIPE, \ + stderr=subprocess.PIPE, \*\*kwargs) + + Create a subprocess from *cmd*, which can be a :class:`str` or a + :class:`bytes` string encoded to the + :ref:`filesystem encoding `, + using the platform's "shell" syntax. + + This is similar to the standard library :class:`subprocess.Popen` + class called with ``shell=True``. + + The *protocol_factory* must be a callable returning a subclass of the + :class:`SubprocessProtocol` class. + + See :meth:`~loop.subprocess_exec` for more details about + the remaining arguments. + + Returns a pair of ``(transport, protocol)``, where *transport* + conforms to the :class:`SubprocessTransport` base class and + *protocol* is an object instantiated by the *protocol_factory*. + +.. note:: + It is the application's responsibility to ensure that all whitespace + and special characters are quoted appropriately to avoid `shell injection + `_ + vulnerabilities. The :func:`shlex.quote` function can be used to + properly escape whitespace and special characters in strings that + are going to be used to construct shell commands. + + +Callback Handles +================ + +.. class:: Handle + + A callback wrapper object returned by :meth:`loop.call_soon`, + :meth:`loop.call_soon_threadsafe`. + + .. method:: cancel() + + Cancel the callback. If the callback has already been canceled + or executed, this method has no effect. + + .. method:: cancelled() + + Return ``True`` if the callback was cancelled. + + .. versionadded:: 3.7 + +.. class:: TimerHandle + + A callback wrapper object returned by :meth:`loop.call_later`, + and :meth:`loop.call_at`. + + This class is a subclass of :class:`Handle`. + + .. method:: when() + + Return a scheduled callback time as :class:`float` seconds. + + The time is an absolute timestamp, using the same time + reference as :meth:`loop.time`. + + .. versionadded:: 3.7 + + +Server Objects +============== + +Server objects are created by :meth:`loop.create_server`, +:meth:`loop.create_unix_server`, :func:`start_server`, +and :func:`start_unix_server` functions. + +Do not instantiate the class directly. + +.. class:: Server + + *Server* objects are asynchronous context managers. When used in an + ``async with`` statement, it's guaranteed that the Server object is + closed and not accepting new connections when the ``async with`` + statement is completed:: + + srv = await loop.create_server(...) + + async with srv: + # some code + + # At this point, srv is closed and no longer accepts new connections. + + + .. versionchanged:: 3.7 + Server object is an asynchronous context manager since Python 3.7. + + .. method:: close() + + Stop serving: close listening sockets and set the :attr:`sockets` + attribute to ``None``. + + The sockets that represent existing incoming client connections + are left open. + + The server is closed asynchronously, use the :meth:`wait_closed` + coroutine to wait until the server is closed. + + .. method:: get_loop() + + Return the event loop associated with the server object. + + .. versionadded:: 3.7 + + .. coroutinemethod:: start_serving() + + Start accepting connections. + + This method is idempotent, so it can be called when + the server is already being serving. + + The *start_serving* keyword-only parameter to + :meth:`loop.create_server` and + :meth:`asyncio.start_server` allows creating a Server object + that is not accepting connections initially. In this case + ``Server.start_serving()``, or :meth:`Server.serve_forever` can be used + to make the Server start accepting connections. + + .. versionadded:: 3.7 + + .. coroutinemethod:: serve_forever() + + Start accepting connections until the coroutine is cancelled. + Cancellation of ``serve_forever`` task causes the server + to be closed. + + This method can be called if the server is already accepting + connections. Only one ``serve_forever`` task can exist per + one *Server* object. + + Example:: + + async def client_connected(reader, writer): + # Communicate with the client with + # reader/writer streams. For example: + await reader.readline() + + async def main(host, port): + srv = await asyncio.start_server( + client_connected, host, port) + await srv.serve_forever() + + asyncio.run(main('127.0.0.1', 0)) + + .. versionadded:: 3.7 + + .. method:: is_serving() + + Return ``True`` if the server is accepting new connections. + + .. versionadded:: 3.7 + + .. coroutinemethod:: wait_closed() + + Wait until the :meth:`close` method completes. + + .. attribute:: sockets + + List of :class:`socket.socket` objects the server is listening on, + or ``None`` if the server is closed. + + .. versionchanged:: 3.7 + Prior to Python 3.7 ``Server.sockets`` used to return an + internal list of server sockets directly. In 3.7 a copy + of that list is returned. + + +.. _asyncio-event-loops: + +Event Loop Implementations +========================== + +asyncio ships with two different event loop implementations: +:class:`SelectorEventLoop` and :class:`ProactorEventLoop`. + +By default asyncio is configured to use :class:`SelectorEventLoop` +on all platforms. + + +.. class:: SelectorEventLoop + + An event loop based on the :mod:`selectors` module. + + Uses the most efficient *selector* available for the given + platform. It is also possible to manually configure the + exact selector implementation to be used:: + + import asyncio + import selectors + + selector = selectors.SelectSelector() + loop = asyncio.SelectorEventLoop(selector) + asyncio.set_event_loop(loop) + + + .. availability:: Unix, Windows. + + +.. class:: ProactorEventLoop + + An event loop for Windows that uses "I/O Completion Ports" (IOCP). + + .. availability:: Windows. + + An example how to use :class:`ProactorEventLoop` on Windows:: + + import asyncio + import sys + + if sys.platform == 'win32': + loop = asyncio.ProactorEventLoop() + asyncio.set_event_loop(loop) + + .. seealso:: + + `MSDN documentation on I/O Completion Ports + `_. + + +.. class:: AbstractEventLoop + + Abstract base class for asyncio-compliant event loops. + + The :ref:`Event Loop Methods ` section lists all + methods that an alternative implementation of ``AbstractEventLoop`` + should have defined. + + +Examples +======== + +Note that all examples in this section **purposefully** show how +to use the low-level event loop APIs, such as :meth:`loop.run_forever` +and :meth:`loop.call_soon`. Modern asyncio applications rarely +need to be written this way; consider using the high-level functions +like :func:`asyncio.run`. + + +.. _asyncio_example_lowlevel_helloworld: + +Hello World with call_soon() +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +An example using the :meth:`loop.call_soon` method to schedule a +callback. The callback displays ``"Hello World"`` and then stops the +event loop:: + + import asyncio + + def hello_world(loop): + """A callback to print 'Hello World' and stop the event loop""" + print('Hello World') + loop.stop() + + loop = asyncio.get_event_loop() + + # Schedule a call to hello_world() + loop.call_soon(hello_world, loop) + + # Blocking call interrupted by loop.stop() + try: + loop.run_forever() + finally: + loop.close() + +.. seealso:: + + A similar :ref:`Hello World ` + example created with a coroutine and the :func:`run` function. + + +.. _asyncio_example_call_later: + +Display the current date with call_later() +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +An example of a callback displaying the current date every second. The +callback uses the :meth:`loop.call_later` method to reschedule itself +after 5 seconds, and then stops the event loop:: + + import asyncio + import datetime + + def display_date(end_time, loop): + print(datetime.datetime.now()) + if (loop.time() + 1.0) < end_time: + loop.call_later(1, display_date, end_time, loop) + else: + loop.stop() + + loop = asyncio.get_event_loop() + + # Schedule the first call to display_date() + end_time = loop.time() + 5.0 + loop.call_soon(display_date, end_time, loop) + + # Blocking call interrupted by loop.stop() + try: + loop.run_forever() + finally: + loop.close() + +.. seealso:: + + A similar :ref:`current date ` example + created with a coroutine and the :func:`run` function. + + +.. _asyncio_example_watch_fd: + +Watch a file descriptor for read events +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Wait until a file descriptor received some data using the +:meth:`loop.add_reader` method and then close the event loop:: + + import asyncio + from socket import socketpair + + # Create a pair of connected file descriptors + rsock, wsock = socketpair() + + loop = asyncio.get_event_loop() + + def reader(): + data = rsock.recv(100) + print("Received:", data.decode()) + + # We are done: unregister the file descriptor + loop.remove_reader(rsock) + + # Stop the event loop + loop.stop() + + # Register the file descriptor for read event + loop.add_reader(rsock, reader) + + # Simulate the reception of data from the network + loop.call_soon(wsock.send, 'abc'.encode()) + + try: + # Run the event loop + loop.run_forever() + finally: + # We are done. Close sockets and the event loop. + rsock.close() + wsock.close() + loop.close() + +.. seealso:: + + * A similar :ref:`example ` + using transports, protocols, and the + :meth:`loop.create_connection` method. + + * Another similar :ref:`example ` + using the high-level :func:`asyncio.open_connection` function + and streams. + + +.. _asyncio_example_unix_signals: + +Set signal handlers for SIGINT and SIGTERM +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +(This ``signals`` example only works on Unix.) + +Register handlers for signals :py:data:`SIGINT` and :py:data:`SIGTERM` +using the :meth:`loop.add_signal_handler` method:: + + import asyncio + import functools + import os + import signal + + def ask_exit(signame, loop): + print("got signal %s: exit" % signame) + loop.stop() + + async def main(): + loop = asyncio.get_running_loop() + + for signame in {'SIGINT', 'SIGTERM'}: + loop.add_signal_handler( + getattr(signal, signame), + functools.partial(ask_exit, signame, loop)) + + await asyncio.sleep(3600) + + print("Event loop running for 1 hour, press Ctrl+C to interrupt.") + print(f"pid {os.getpid()}: send SIGINT or SIGTERM to exit.") + + asyncio.run(main()) diff --git a/python-3.7.4-docs-html/_sources/library/asyncio-exceptions.rst.txt b/python-3.7.4-docs-html/_sources/library/asyncio-exceptions.rst.txt new file mode 100644 index 0000000..e49577a --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/asyncio-exceptions.rst.txt @@ -0,0 +1,91 @@ +.. currentmodule:: asyncio + + +.. _asyncio-exceptions: + +========== +Exceptions +========== + + +.. exception:: TimeoutError + + The operation has exceeded the given deadline. + + .. important:: + This exception is different from the builtin :exc:`TimeoutError` + exception. + + +.. exception:: CancelledError + + The operation has been cancelled. + + This exception can be caught to perform custom operations + when asyncio Tasks are cancelled. In almost all situations the + exception must be re-raised. + + .. important:: + + This exception is a subclass of :exc:`Exception`, so it can be + accidentally suppressed by an overly broad ``try..except`` block:: + + try: + await operation + except Exception: + # The cancellation is broken because the *except* block + # suppresses the CancelledError exception. + log.log('an error has occurred') + + Instead, the following pattern should be used:: + + try: + await operation + except asyncio.CancelledError: + raise + except Exception: + log.log('an error has occurred') + + +.. exception:: InvalidStateError + + Invalid internal state of :class:`Task` or :class:`Future`. + + Can be raised in situations like setting a result value for a + *Future* object that already has a result value set. + + +.. exception:: SendfileNotAvailableError + + The "sendfile" syscall is not available for the given + socket or file type. + + A subclass of :exc:`RuntimeError`. + + +.. exception:: IncompleteReadError + + The requested read operation did not complete fully. + + Raised by the :ref:`asyncio stream APIs`. + + This exception is a subclass of :exc:`EOFError`. + + .. attribute:: expected + + The total number (:class:`int`) of expected bytes. + + .. attribute:: partial + + A string of :class:`bytes` read before the end of stream was reached. + + +.. exception:: LimitOverrunError + + Reached the buffer size limit while looking for a separator. + + Raised by the :ref:`asyncio stream APIs `. + + .. attribute:: consumed + + The total number of to be consumed bytes. diff --git a/python-3.7.4-docs-html/_sources/library/asyncio-future.rst.txt b/python-3.7.4-docs-html/_sources/library/asyncio-future.rst.txt new file mode 100644 index 0000000..6e6e013 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/asyncio-future.rst.txt @@ -0,0 +1,250 @@ +.. currentmodule:: asyncio + + +.. _asyncio-futures: + +======= +Futures +======= + +*Future* objects are used to bridge **low-level callback-based code** +with high-level async/await code. + + +Future Functions +================ + +.. function:: isfuture(obj) + + Return ``True`` if *obj* is either of: + + * an instance of :class:`asyncio.Future`, + * an instance of :class:`asyncio.Task`, + * a Future-like object with a ``_asyncio_future_blocking`` + attribute. + + .. versionadded:: 3.5 + + +.. function:: ensure_future(obj, \*, loop=None) + + Return: + + * *obj* argument as is, if *obj* is a :class:`Future`, + a :class:`Task`, or a Future-like object (:func:`isfuture` + is used for the test.) + + * a :class:`Task` object wrapping *obj*, if *obj* is a + coroutine (:func:`iscoroutine` is used for the test.) + + * a :class:`Task` object that would await on *obj*, if *obj* is an + awaitable (:func:`inspect.isawaitable` is used for the test.) + + If *obj* is neither of the above a :exc:`TypeError` is raised. + + .. important:: + + See also the :func:`create_task` function which is the + preferred way for creating new Tasks. + + .. versionchanged:: 3.5.1 + The function accepts any :term:`awaitable` object. + + +.. function:: wrap_future(future, \*, loop=None) + + Wrap a :class:`concurrent.futures.Future` object in a + :class:`asyncio.Future` object. + + +Future Object +============= + +.. class:: Future(\*, loop=None) + + A Future represents an eventual result of an asynchronous + operation. Not thread-safe. + + Future is an :term:`awaitable` object. Coroutines can await on + Future objects until they either have a result or an exception + set, or until they are cancelled. + + Typically Futures are used to enable low-level + callback-based code (e.g. in protocols implemented using asyncio + :ref:`transports `) + to interoperate with high-level async/await code. + + The rule of thumb is to never expose Future objects in user-facing + APIs, and the recommended way to create a Future object is to call + :meth:`loop.create_future`. This way alternative event loop + implementations can inject their own optimized implementations + of a Future object. + + .. versionchanged:: 3.7 + Added support for the :mod:`contextvars` module. + + .. method:: result() + + Return the result of the Future. + + If the Future is *done* and has a result set by the + :meth:`set_result` method, the result value is returned. + + If the Future is *done* and has an exception set by the + :meth:`set_exception` method, this method raises the exception. + + If the Future has been *cancelled*, this method raises + a :exc:`CancelledError` exception. + + If the Future's result isn't yet available, this method raises + a :exc:`InvalidStateError` exception. + + .. method:: set_result(result) + + Mark the Future as *done* and set its result. + + Raises a :exc:`InvalidStateError` error if the Future is + already *done*. + + .. method:: set_exception(exception) + + Mark the Future as *done* and set an exception. + + Raises a :exc:`InvalidStateError` error if the Future is + already *done*. + + .. method:: done() + + Return ``True`` if the Future is *done*. + + A Future is *done* if it was *cancelled* or if it has a result + or an exception set with :meth:`set_result` or + :meth:`set_exception` calls. + + .. method:: cancelled() + + Return ``True`` if the Future was *cancelled*. + + The method is usually used to check if a Future is not + *cancelled* before setting a result or an exception for it:: + + if not fut.cancelled(): + fut.set_result(42) + + .. method:: add_done_callback(callback, *, context=None) + + Add a callback to be run when the Future is *done*. + + The *callback* is called with the Future object as its only + argument. + + If the Future is already *done* when this method is called, + the callback is scheduled with :meth:`loop.call_soon`. + + An optional keyword-only *context* argument allows specifying a + custom :class:`contextvars.Context` for the *callback* to run in. + The current context is used when no *context* is provided. + + :func:`functools.partial` can be used to pass parameters + to the callback, e.g.:: + + # Call 'print("Future:", fut)' when "fut" is done. + fut.add_done_callback( + functools.partial(print, "Future:")) + + .. versionchanged:: 3.7 + The *context* keyword-only parameter was added. + See :pep:`567` for more details. + + .. method:: remove_done_callback(callback) + + Remove *callback* from the callbacks list. + + Returns the number of callbacks removed, which is typically 1, + unless a callback was added more than once. + + .. method:: cancel() + + Cancel the Future and schedule callbacks. + + If the Future is already *done* or *cancelled*, return ``False``. + Otherwise, change the Future's state to *cancelled*, + schedule the callbacks, and return ``True``. + + .. method:: exception() + + Return the exception that was set on this Future. + + The exception (or ``None`` if no exception was set) is + returned only if the Future is *done*. + + If the Future has been *cancelled*, this method raises a + :exc:`CancelledError` exception. + + If the Future isn't *done* yet, this method raises an + :exc:`InvalidStateError` exception. + + .. method:: get_loop() + + Return the event loop the Future object is bound to. + + .. versionadded:: 3.7 + + +.. _asyncio_example_future: + +This example creates a Future object, creates and schedules an +asynchronous Task to set result for the Future, and waits until +the Future has a result:: + + async def set_after(fut, delay, value): + # Sleep for *delay* seconds. + await asyncio.sleep(delay) + + # Set *value* as a result of *fut* Future. + fut.set_result(value) + + async def main(): + # Get the current event loop. + loop = asyncio.get_running_loop() + + # Create a new Future object. + fut = loop.create_future() + + # Run "set_after()" coroutine in a parallel Task. + # We are using the low-level "loop.create_task()" API here because + # we already have a reference to the event loop at hand. + # Otherwise we could have just used "asyncio.create_task()". + loop.create_task( + set_after(fut, 1, '... world')) + + print('hello ...') + + # Wait until *fut* has a result (1 second) and print it. + print(await fut) + + asyncio.run(main()) + + +.. important:: + + The Future object was designed to mimic + :class:`concurrent.futures.Future`. Key differences include: + + - unlike asyncio Futures, :class:`concurrent.futures.Future` + instances cannot be awaited. + + - :meth:`asyncio.Future.result` and :meth:`asyncio.Future.exception` + do not accept the *timeout* argument. + + - :meth:`asyncio.Future.result` and :meth:`asyncio.Future.exception` + raise an :exc:`InvalidStateError` exception when the Future is not + *done*. + + - Callbacks registered with :meth:`asyncio.Future.add_done_callback` + are not called immediately. They are scheduled with + :meth:`loop.call_soon` instead. + + - asyncio Future is not compatible with the + :func:`concurrent.futures.wait` and + :func:`concurrent.futures.as_completed` functions. diff --git a/python-3.7.4-docs-html/_sources/library/asyncio-llapi-index.rst.txt b/python-3.7.4-docs-html/_sources/library/asyncio-llapi-index.rst.txt new file mode 100644 index 0000000..0ab322a --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/asyncio-llapi-index.rst.txt @@ -0,0 +1,510 @@ +.. currentmodule:: asyncio + + +=================== +Low-level API Index +=================== + +This page lists all low-level asyncio APIs. + + +Obtaining the Event Loop +======================== + +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - :func:`asyncio.get_running_loop` + - The **preferred** function to get the running event loop. + + * - :func:`asyncio.get_event_loop` + - Get an event loop instance (current or via the policy). + + * - :func:`asyncio.set_event_loop` + - Set the event loop as current via the current policy. + + * - :func:`asyncio.new_event_loop` + - Create a new event loop. + + +.. rubric:: Examples + +* :ref:`Using asyncio.get_running_loop() `. + + +Event Loop Methods +================== + +See also the main documentation section about the +:ref:`event loop methods `. + +.. rubric:: Lifecycle +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - :meth:`loop.run_until_complete` + - Run a Future/Task/awaitable until complete. + + * - :meth:`loop.run_forever` + - Run the event loop forever. + + * - :meth:`loop.stop` + - Stop the event loop. + + * - :meth:`loop.close` + - Close the event loop. + + * - :meth:`loop.is_running()` + - Return ``True`` if the event loop is running. + + * - :meth:`loop.is_closed()` + - Return ``True`` if the event loop is closed. + + * - ``await`` :meth:`loop.shutdown_asyncgens` + - Close asynchronous generators. + + +.. rubric:: Debugging +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - :meth:`loop.set_debug` + - Enable or disable the debug mode. + + * - :meth:`loop.get_debug` + - Get the current debug mode. + + +.. rubric:: Scheduling Callbacks +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - :meth:`loop.call_soon` + - Invoke a callback soon. + + * - :meth:`loop.call_soon_threadsafe` + - A thread-safe variant of :meth:`loop.call_soon`. + + * - :meth:`loop.call_later` + - Invoke a callback *after* the given time. + + * - :meth:`loop.call_at` + - Invoke a callback *at* the given time. + + +.. rubric:: Thread/Process Pool +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - ``await`` :meth:`loop.run_in_executor` + - Run a CPU-bound or other blocking function in + a :mod:`concurrent.futures` executor. + + * - :meth:`loop.set_default_executor` + - Set the default executor for :meth:`loop.run_in_executor`. + + +.. rubric:: Tasks and Futures +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - :meth:`loop.create_future` + - Create a :class:`Future` object. + + * - :meth:`loop.create_task` + - Schedule coroutine as a :class:`Task`. + + * - :meth:`loop.set_task_factory` + - Set a factory used by :meth:`loop.create_task` to + create :class:`Tasks `. + + * - :meth:`loop.get_task_factory` + - Get the factory :meth:`loop.create_task` uses + to create :class:`Tasks `. + + +.. rubric:: DNS +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - ``await`` :meth:`loop.getaddrinfo` + - Asynchronous version of :meth:`socket.getaddrinfo`. + + * - ``await`` :meth:`loop.getnameinfo` + - Asynchronous version of :meth:`socket.getnameinfo`. + + +.. rubric:: Networking and IPC +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - ``await`` :meth:`loop.create_connection` + - Open a TCP connection. + + * - ``await`` :meth:`loop.create_server` + - Create a TCP server. + + * - ``await`` :meth:`loop.create_unix_connection` + - Open a Unix socket connection. + + * - ``await`` :meth:`loop.create_unix_server` + - Create a Unix socket server. + + * - ``await`` :meth:`loop.connect_accepted_socket` + - Wrap a :class:`~socket.socket` into a ``(transport, protocol)`` + pair. + + * - ``await`` :meth:`loop.create_datagram_endpoint` + - Open a datagram (UDP) connection. + + * - ``await`` :meth:`loop.sendfile` + - Send a file over a transport. + + * - ``await`` :meth:`loop.start_tls` + - Upgrade an existing connection to TLS. + + * - ``await`` :meth:`loop.connect_read_pipe` + - Wrap a read end of a pipe into a ``(transport, protocol)`` pair. + + * - ``await`` :meth:`loop.connect_write_pipe` + - Wrap a write end of a pipe into a ``(transport, protocol)`` pair. + + +.. rubric:: Sockets +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - ``await`` :meth:`loop.sock_recv` + - Receive data from the :class:`~socket.socket`. + + * - ``await`` :meth:`loop.sock_recv_into` + - Receive data from the :class:`~socket.socket` into a buffer. + + * - ``await`` :meth:`loop.sock_sendall` + - Send data to the :class:`~socket.socket`. + + * - ``await`` :meth:`loop.sock_connect` + - Connect the :class:`~socket.socket`. + + * - ``await`` :meth:`loop.sock_accept` + - Accept a :class:`~socket.socket` connection. + + * - ``await`` :meth:`loop.sock_sendfile` + - Send a file over the :class:`~socket.socket`. + + * - :meth:`loop.add_reader` + - Start watching a file descriptor for read availability. + + * - :meth:`loop.remove_reader` + - Stop watching a file descriptor for read availability. + + * - :meth:`loop.add_writer` + - Start watching a file descriptor for write availability. + + * - :meth:`loop.remove_writer` + - Stop watching a file descriptor for write availability. + + +.. rubric:: Unix Signals +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - :meth:`loop.add_signal_handler` + - Add a handler for a :mod:`signal`. + + * - :meth:`loop.remove_signal_handler` + - Remove a handler for a :mod:`signal`. + + +.. rubric:: Subprocesses +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - :meth:`loop.subprocess_exec` + - Spawn a subprocess. + + * - :meth:`loop.subprocess_shell` + - Spawn a subprocess from a shell command. + + +.. rubric:: Error Handling +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - :meth:`loop.call_exception_handler` + - Call the exception handler. + + * - :meth:`loop.set_exception_handler` + - Set a new exception handler. + + * - :meth:`loop.get_exception_handler` + - Get the current exception handler. + + * - :meth:`loop.default_exception_handler` + - The default exception handler implementation. + + +.. rubric:: Examples + +* :ref:`Using asyncio.get_event_loop() and loop.run_forever() + `. + +* :ref:`Using loop.call_later() `. + +* Using ``loop.create_connection()`` to implement + :ref:`an echo-client `. + +* Using ``loop.create_connection()`` to + :ref:`connect a socket `. + +* :ref:`Using add_reader() to watch an FD for read events + `. + +* :ref:`Using loop.add_signal_handler() `. + +* :ref:`Using loop.subprocess_exec() `. + + +Transports +========== + +All transports implement the following methods: + +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - :meth:`transport.close() ` + - Close the transport. + + * - :meth:`transport.is_closing() ` + - Return ``True`` if the transport is closing or is closed. + + * - :meth:`transport.get_extra_info() ` + - Request for information about the transport. + + * - :meth:`transport.set_protocol() ` + - Set a new protocol. + + * - :meth:`transport.get_protocol() ` + - Return the current protocol. + + +Transports that can receive data (TCP and Unix connections, +pipes, etc). Returned from methods like +:meth:`loop.create_connection`, :meth:`loop.create_unix_connection`, +:meth:`loop.connect_read_pipe`, etc: + +.. rubric:: Read Transports +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - :meth:`transport.is_reading() ` + - Return ``True`` if the transport is receiving. + + * - :meth:`transport.pause_reading() ` + - Pause receiving. + + * - :meth:`transport.resume_reading() ` + - Resume receiving. + + +Transports that can Send data (TCP and Unix connections, +pipes, etc). Returned from methods like +:meth:`loop.create_connection`, :meth:`loop.create_unix_connection`, +:meth:`loop.connect_write_pipe`, etc: + +.. rubric:: Write Transports +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - :meth:`transport.write() ` + - Write data to the transport. + + * - :meth:`transport.writelines() ` + - Write buffers to the transport. + + * - :meth:`transport.can_write_eof() ` + - Return :const:`True` if the transport supports sending EOF. + + * - :meth:`transport.write_eof() ` + - Close and send EOF after flushing buffered data. + + * - :meth:`transport.abort() ` + - Close the transport immediately. + + * - :meth:`transport.get_write_buffer_size() + ` + - Return high and low water marks for write flow control. + + * - :meth:`transport.set_write_buffer_limits() + ` + - Set new high and low water marks for write flow control. + + +Transports returned by :meth:`loop.create_datagram_endpoint`: + +.. rubric:: Datagram Transports +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - :meth:`transport.sendto() ` + - Send data to the remote peer. + + * - :meth:`transport.abort() ` + - Close the transport immediately. + + +Low-level transport abstraction over subprocesses. +Returned by :meth:`loop.subprocess_exec` and +:meth:`loop.subprocess_shell`: + +.. rubric:: Subprocess Transports +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - :meth:`transport.get_pid() ` + - Return the subprocess process id. + + * - :meth:`transport.get_pipe_transport() + ` + - Return the transport for the requested communication pipe + (*stdin*, *stdout*, or *stderr*). + + * - :meth:`transport.get_returncode() ` + - Return the subprocess return code. + + * - :meth:`transport.kill() ` + - Kill the subprocess. + + * - :meth:`transport.send_signal() ` + - Send a signal to the subprocess. + + * - :meth:`transport.terminate() ` + - Stop the subprocess. + + * - :meth:`transport.close() ` + - Kill the subprocess and close all pipes. + + +Protocols +========= + +Protocol classes can implement the following **callback methods**: + +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - ``callback`` :meth:`connection_made() ` + - Called when a connection is made. + + * - ``callback`` :meth:`connection_lost() ` + - Called when the connection is lost or closed. + + * - ``callback`` :meth:`pause_writing() ` + - Called when the transport's buffer goes over the high water mark. + + * - ``callback`` :meth:`resume_writing() ` + - Called when the transport's buffer drains below the low water mark. + + +.. rubric:: Streaming Protocols (TCP, Unix Sockets, Pipes) +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - ``callback`` :meth:`data_received() ` + - Called when some data is received. + + * - ``callback`` :meth:`eof_received() ` + - Called when an EOF is received. + + +.. rubric:: Buffered Streaming Protocols +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - ``callback`` :meth:`get_buffer() ` + - Called to allocate a new receive buffer. + + * - ``callback`` :meth:`buffer_updated() ` + - Called when the buffer was updated with the received data. + + * - ``callback`` :meth:`eof_received() ` + - Called when an EOF is received. + + +.. rubric:: Datagram Protocols +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - ``callback`` :meth:`datagram_received() + ` + - Called when a datagram is received. + + * - ``callback`` :meth:`error_received() ` + - Called when a previous send or receive operation raises an + :class:`OSError`. + + +.. rubric:: Subprocess Protocols +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - ``callback`` :meth:`pipe_data_received() + ` + - Called when the child process writes data into its + *stdout* or *stderr* pipe. + + * - ``callback`` :meth:`pipe_connection_lost() + ` + - Called when one of the pipes communicating with + the child process is closed. + + * - ``callback`` :meth:`process_exited() + ` + - Called when the child process has exited. + + +Event Loop Policies +=================== + +Policies is a low-level mechanism to alter the behavior of +functions like :func:`asyncio.get_event_loop`. See also +the main :ref:`policies section ` for more +details. + + +.. rubric:: Accessing Policies +.. list-table:: + :widths: 50 50 + :class: full-width-table + + * - :meth:`asyncio.get_event_loop_policy` + - Return the current process-wide policy. + + * - :meth:`asyncio.set_event_loop_policy` + - Set a new process-wide policy. + + * - :class:`AbstractEventLoopPolicy` + - Base class for policy objects. diff --git a/python-3.7.4-docs-html/_sources/library/asyncio-platforms.rst.txt b/python-3.7.4-docs-html/_sources/library/asyncio-platforms.rst.txt new file mode 100644 index 0000000..f8ecb58 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/asyncio-platforms.rst.txt @@ -0,0 +1,106 @@ +.. currentmodule:: asyncio + + +.. _asyncio-platform-support: + + +================ +Platform Support +================ + +The :mod:`asyncio` module is designed to be portable, +but some platforms have subtle differences and limitations +due to the platforms' underlying architecture and capabilities. + + +All Platforms +============= + +* :meth:`loop.add_reader` and :meth:`loop.add_writer` + cannot be used to monitor file I/O. + + +Windows +======= + +All event loops on Windows do not support the following methods: + +* :meth:`loop.create_unix_connection` and + :meth:`loop.create_unix_server` are not supported. + The :data:`socket.AF_UNIX` socket family is specific to Unix. + +* :meth:`loop.add_signal_handler` and + :meth:`loop.remove_signal_handler` are not supported. + +:class:`SelectorEventLoop` has the following limitations: + +* :class:`~selectors.SelectSelector` is used to wait on socket events: + it supports sockets and is limited to 512 sockets. + +* :meth:`loop.add_reader` and :meth:`loop.add_writer` only accept + socket handles (e.g. pipe file descriptors are not supported). + +* Pipes are not supported, so the :meth:`loop.connect_read_pipe` + and :meth:`loop.connect_write_pipe` methods are not implemented. + +* :ref:`Subprocesses ` are not supported, i.e. + :meth:`loop.subprocess_exec` and :meth:`loop.subprocess_shell` + methods are not implemented. + +:class:`ProactorEventLoop` has the following limitations: + +* The :meth:`loop.create_datagram_endpoint` method + is not supported. + +* The :meth:`loop.add_reader` and :meth:`loop.add_writer` + methods are not supported. + +The resolution of the monotonic clock on Windows is usually around 15.6 +msec. The best resolution is 0.5 msec. The resolution depends on the +hardware (availability of `HPET +`_) and on the +Windows configuration. + + +.. _asyncio-windows-subprocess: + +Subprocess Support on Windows +----------------------------- + +:class:`SelectorEventLoop` on Windows does not support subproceses. +On Windows, :class:`ProactorEventLoop` should be used instead:: + + import asyncio + + asyncio.set_event_loop_policy( + asyncio.WindowsProactorEventLoopPolicy()) + + asyncio.run(your_code()) + + +The :meth:`policy.set_child_watcher() +` function is also +not supported, as :class:`ProactorEventLoop` has a different mechanism +to watch child processes. + + +macOS +===== + +Modern macOS versions are fully supported. + +.. rubric:: macOS <= 10.8 + +On macOS 10.6, 10.7 and 10.8, the default event loop +uses :class:`selectors.KqueueSelector`, which does not support +character devices on these versions. The :class:`SelectorEventLoop` +can be manually configured to use :class:`~selectors.SelectSelector` +or :class:`~selectors.PollSelector` to support character devices on +these older versions of macOS. Example:: + + import asyncio + import selectors + + selector = selectors.SelectSelector() + loop = asyncio.SelectorEventLoop(selector) + asyncio.set_event_loop(loop) diff --git a/python-3.7.4-docs-html/_sources/library/asyncio-policy.rst.txt b/python-3.7.4-docs-html/_sources/library/asyncio-policy.rst.txt new file mode 100644 index 0000000..07842da --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/asyncio-policy.rst.txt @@ -0,0 +1,221 @@ +.. currentmodule:: asyncio + + +.. _asyncio-policies: + +======== +Policies +======== + +An event loop policy is a global per-process object that controls +the management of the event loop. Each event loop has a default +policy, which can be changed and customized using the policy API. + +A policy defines the notion of *context* and manages a +separate event loop per context. The default policy +defines *context* to be the current thread. + +By using a custom event loop policy, the behavior of +:func:`get_event_loop`, :func:`set_event_loop`, and +:func:`new_event_loop` functions can be customized. + +Policy objects should implement the APIs defined +in the :class:`AbstractEventLoopPolicy` abstract base class. + + +Getting and Setting the Policy +============================== + +The following functions can be used to get and set the policy +for the current process: + +.. function:: get_event_loop_policy() + + Return the current process-wide policy. + +.. function:: set_event_loop_policy(policy) + + Set the current process-wide policy to *policy*. + + If *policy* is set to ``None``, the default policy is restored. + + +Policy Objects +============== + +The abstract event loop policy base class is defined as follows: + +.. class:: AbstractEventLoopPolicy + + An abstract base class for asyncio policies. + + .. method:: get_event_loop() + + Get the event loop for the current context. + + Return an event loop object implementing the + :class:`AbstractEventLoop` interface. + + This method should never return ``None``. + + .. versionchanged:: 3.6 + + .. method:: set_event_loop(loop) + + Set the event loop for the current context to *loop*. + + .. method:: new_event_loop() + + Create and return a new event loop object. + + This method should never return ``None``. + + .. method:: get_child_watcher() + + Get a child process watcher object. + + Return a watcher object implementing the + :class:`AbstractChildWatcher` interface. + + This function is Unix specific. + + .. method:: set_child_watcher(watcher) + + Set the current child process watcher to *watcher*. + + This function is Unix specific. + + +asyncio ships with the following built-in policies: + + +.. class:: DefaultEventLoopPolicy + + The default asyncio policy. Uses :class:`SelectorEventLoop` + on both Unix and Windows platforms. + + There is no need to install the default policy manually. asyncio + is configured to use the default policy automatically. + + +.. class:: WindowsProactorEventLoopPolicy + + An alternative event loop policy that uses the + :class:`ProactorEventLoop` event loop implementation. + + .. availability:: Windows. + + +Process Watchers +================ + +A process watcher allows customization of how an event loop monitors +child processes on Unix. Specifically, the event loop needs to know +when a child process has exited. + +In asyncio, child processes are created with +:func:`create_subprocess_exec` and :meth:`loop.subprocess_exec` +functions. + +asyncio defines the :class:`AbstractChildWatcher` abstract base class, +which child watchers should implement, and has two different +implementations: :class:`SafeChildWatcher` (configured to be used +by default) and :class:`FastChildWatcher`. + +See also the :ref:`Subprocess and Threads ` +section. + +The following two functions can be used to customize the child process watcher +implementation used by the asyncio event loop: + +.. function:: get_child_watcher() + + Return the current child watcher for the current policy. + +.. function:: set_child_watcher(watcher) + + Set the current child watcher to *watcher* for the current + policy. *watcher* must implement methods defined in the + :class:`AbstractChildWatcher` base class. + +.. note:: + Third-party event loops implementations might not support + custom child watchers. For such event loops, using + :func:`set_child_watcher` might be prohibited or have no effect. + +.. class:: AbstractChildWatcher + + .. method:: add_child_handler(pid, callback, \*args) + + Register a new child handler. + + Arrange for ``callback(pid, returncode, *args)`` to be called + when a process with PID equal to *pid* terminates. Specifying + another callback for the same process replaces the previous + handler. + + The *callback* callable must be thread-safe. + + .. method:: remove_child_handler(pid) + + Removes the handler for process with PID equal to *pid*. + + The function returns ``True`` if the handler was successfully + removed, ``False`` if there was nothing to remove. + + .. method:: attach_loop(loop) + + Attach the watcher to an event loop. + + If the watcher was previously attached to an event loop, then + it is first detached before attaching to the new loop. + + Note: loop may be ``None``. + + .. method:: close() + + Close the watcher. + + This method has to be called to ensure that underlying + resources are cleaned-up. + +.. class:: SafeChildWatcher + + This implementation avoids disrupting other code spawning processes + by polling every process explicitly on a :py:data:`SIGCHLD` signal. + + This is a safe solution but it has a significant overhead when + handling a big number of processes (*O(n)* each time a + :py:data:`SIGCHLD` is received). + + asyncio uses this safe implementation by default. + +.. class:: FastChildWatcher + + This implementation reaps every terminated processes by calling + ``os.waitpid(-1)`` directly, possibly breaking other code spawning + processes and waiting for their termination. + + There is no noticeable overhead when handling a big number of + children (*O(1)* each time a child terminates). + + +Custom Policies +=============== + +To implement a new event loop policy, it is recommended to subclass +:class:`DefaultEventLoopPolicy` and override the methods for which +custom behavior is wanted, e.g.:: + + class MyEventLoopPolicy(asyncio.DefaultEventLoopPolicy): + + def get_event_loop(self): + """Get the event loop. + + This may be None or an instance of EventLoop. + """ + loop = super().get_event_loop() + # Do something with loop ... + return loop + + asyncio.set_event_loop_policy(MyEventLoopPolicy()) diff --git a/python-3.7.4-docs-html/_sources/library/asyncio-protocol.rst.txt b/python-3.7.4-docs-html/_sources/library/asyncio-protocol.rst.txt new file mode 100644 index 0000000..d8d7947 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/asyncio-protocol.rst.txt @@ -0,0 +1,1041 @@ +.. currentmodule:: asyncio + + +.. _asyncio-transports-protocols: + + +======================== +Transports and Protocols +======================== + +.. rubric:: Preface + +Transports and Protocols are used by the **low-level** event loop +APIs such as :meth:`loop.create_connection`. They use +callback-based programming style and enable high-performance +implementations of network or IPC protocols (e.g. HTTP). + +Essentially, transports and protocols should only be used in +libraries and frameworks and never in high-level asyncio +applications. + +This documentation page covers both `Transports`_ and `Protocols`_. + +.. rubric:: Introduction + +At the highest level, the transport is concerned with *how* bytes +are transmitted, while the protocol determines *which* bytes to +transmit (and to some extent when). + +A different way of saying the same thing: a transport is an +abstraction for a socket (or similar I/O endpoint) while a protocol +is an abstraction for an application, from the transport's point +of view. + +Yet another view is the transport and protocol interfaces +together define an abstract interface for using network I/O and +interprocess I/O. + +There is always a 1:1 relationship between transport and protocol +objects: the protocol calls transport methods to send data, +while the transport calls protocol methods to pass it data that +has been received. + +Most of connection oriented event loop methods +(such as :meth:`loop.create_connection`) usually accept a +*protocol_factory* argument used to create a *Protocol* object +for an accepted connection, represented by a *Transport* object. +Such methods usually return a tuple of ``(transport, protocol)``. + +.. rubric:: Contents + +This documentation page contains the following sections: + +* The `Transports`_ section documents asyncio :class:`BaseTransport`, + :class:`ReadTransport`, :class:`WriteTransport`, :class:`Transport`, + :class:`DatagramTransport`, and :class:`SubprocessTransport` + classes. + +* The `Protocols`_ section documents asyncio :class:`BaseProtocol`, + :class:`Protocol`, :class:`BufferedProtocol`, + :class:`DatagramProtocol`, and :class:`SubprocessProtocol` classes. + +* The `Examples`_ section showcases how to work with transports, + protocols, and low-level event loop APIs. + + +.. _asyncio-transport: + +Transports +========== + +Transports are classes provided by :mod:`asyncio` in order to abstract +various kinds of communication channels. + +Transport objects are always instantiated by an +:ref:`asyncio event loop `. + +asyncio implements transports for TCP, UDP, SSL, and subprocess pipes. +The methods available on a transport depend on the transport's kind. + +The transport classes are :ref:`not thread safe `. + + +Transports Hierarchy +-------------------- + +.. class:: BaseTransport + + Base class for all transports. Contains methods that all + asyncio transports share. + +.. class:: WriteTransport(BaseTransport) + + A base transport for write-only connections. + + Instances of the *WriteTransport* class are returned from + the :meth:`loop.connect_write_pipe` event loop method and + are also used by subprocess-related methods like + :meth:`loop.subprocess_exec`. + +.. class:: ReadTransport(BaseTransport) + + A base transport for read-only connections. + + Instances of the *ReadTransport* class are returned from + the :meth:`loop.connect_read_pipe` event loop method and + are also used by subprocess-related methods like + :meth:`loop.subprocess_exec`. + +.. class:: Transport(WriteTransport, ReadTransport) + + Interface representing a bidirectional transport, such as a + TCP connection. + + The user does not instantiate a transport directly; they call a + utility function, passing it a protocol factory and other + information necessary to create the transport and protocol. + + Instances of the *Transport* class are returned from or used by + event loop methods like :meth:`loop.create_connection`, + :meth:`loop.create_unix_connection`, + :meth:`loop.create_server`, :meth:`loop.sendfile`, etc. + + +.. class:: DatagramTransport(BaseTransport) + + A transport for datagram (UDP) connections. + + Instances of the *DatagramTransport* class are returned from + the :meth:`loop.create_datagram_endpoint` event loop method. + + +.. class:: SubprocessTransport(BaseTransport) + + An abstraction to represent a connection between a parent and its + child OS process. + + Instances of the *SubprocessTransport* class are returned from + event loop methods :meth:`loop.subprocess_shell` and + :meth:`loop.subprocess_exec`. + + +Base Transport +-------------- + +.. method:: BaseTransport.close() + + Close the transport. + + If the transport has a buffer for outgoing + data, buffered data will be flushed asynchronously. No more data + will be received. After all buffered data is flushed, the + protocol's :meth:`protocol.connection_lost() + ` method will be called with + :const:`None` as its argument. + +.. method:: BaseTransport.is_closing() + + Return ``True`` if the transport is closing or is closed. + +.. method:: BaseTransport.get_extra_info(name, default=None) + + Return information about the transport or underlying resources + it uses. + + *name* is a string representing the piece of transport-specific + information to get. + + *default* is the value to return if the information is not + available, or if the transport does not support querying it + with the given third-party event loop implementation or on the + current platform. + + For example, the following code attempts to get the underlying + socket object of the transport:: + + sock = transport.get_extra_info('socket') + if sock is not None: + print(sock.getsockopt(...)) + + Categories of information that can be queried on some transports: + + * socket: + + - ``'peername'``: the remote address to which the socket is + connected, result of :meth:`socket.socket.getpeername` + (``None`` on error) + + - ``'socket'``: :class:`socket.socket` instance + + - ``'sockname'``: the socket's own address, + result of :meth:`socket.socket.getsockname` + + * SSL socket: + + - ``'compression'``: the compression algorithm being used as a + string, or ``None`` if the connection isn't compressed; result + of :meth:`ssl.SSLSocket.compression` + + - ``'cipher'``: a three-value tuple containing the name of the + cipher being used, the version of the SSL protocol that defines + its use, and the number of secret bits being used; result of + :meth:`ssl.SSLSocket.cipher` + + - ``'peercert'``: peer certificate; result of + :meth:`ssl.SSLSocket.getpeercert` + + - ``'sslcontext'``: :class:`ssl.SSLContext` instance + + - ``'ssl_object'``: :class:`ssl.SSLObject` or + :class:`ssl.SSLSocket` instance + + * pipe: + + - ``'pipe'``: pipe object + + * subprocess: + + - ``'subprocess'``: :class:`subprocess.Popen` instance + +.. method:: BaseTransport.set_protocol(protocol) + + Set a new protocol. + + Switching protocol should only be done when both + protocols are documented to support the switch. + +.. method:: BaseTransport.get_protocol() + + Return the current protocol. + + +Read-only Transports +-------------------- + +.. method:: ReadTransport.is_reading() + + Return ``True`` if the transport is receiving new data. + + .. versionadded:: 3.7 + +.. method:: ReadTransport.pause_reading() + + Pause the receiving end of the transport. No data will be passed to + the protocol's :meth:`protocol.data_received() ` + method until :meth:`resume_reading` is called. + + .. versionchanged:: 3.7 + The method is idempotent, i.e. it can be called when the + transport is already paused or closed. + +.. method:: ReadTransport.resume_reading() + + Resume the receiving end. The protocol's + :meth:`protocol.data_received() ` method + will be called once again if some data is available for reading. + + .. versionchanged:: 3.7 + The method is idempotent, i.e. it can be called when the + transport is already reading. + + +Write-only Transports +--------------------- + +.. method:: WriteTransport.abort() + + Close the transport immediately, without waiting for pending operations + to complete. Buffered data will be lost. No more data will be received. + The protocol's :meth:`protocol.connection_lost() + ` method will eventually be + called with :const:`None` as its argument. + +.. method:: WriteTransport.can_write_eof() + + Return :const:`True` if the transport supports + :meth:`~WriteTransport.write_eof`, :const:`False` if not. + +.. method:: WriteTransport.get_write_buffer_size() + + Return the current size of the output buffer used by the transport. + +.. method:: WriteTransport.get_write_buffer_limits() + + Get the *high* and *low* watermarks for write flow control. Return a + tuple ``(low, high)`` where *low* and *high* are positive number of + bytes. + + Use :meth:`set_write_buffer_limits` to set the limits. + + .. versionadded:: 3.4.2 + +.. method:: WriteTransport.set_write_buffer_limits(high=None, low=None) + + Set the *high* and *low* watermarks for write flow control. + + These two values (measured in number of + bytes) control when the protocol's + :meth:`protocol.pause_writing() ` + and :meth:`protocol.resume_writing() ` + methods are called. If specified, the low watermark must be less + than or equal to the high watermark. Neither *high* nor *low* + can be negative. + + :meth:`~BaseProtocol.pause_writing` is called when the buffer size + becomes greater than or equal to the *high* value. If writing has + been paused, :meth:`~BaseProtocol.resume_writing` is called when + the buffer size becomes less than or equal to the *low* value. + + The defaults are implementation-specific. If only the + high watermark is given, the low watermark defaults to an + implementation-specific value less than or equal to the + high watermark. Setting *high* to zero forces *low* to zero as + well, and causes :meth:`~BaseProtocol.pause_writing` to be called + whenever the buffer becomes non-empty. Setting *low* to zero causes + :meth:`~BaseProtocol.resume_writing` to be called only once the + buffer is empty. Use of zero for either limit is generally + sub-optimal as it reduces opportunities for doing I/O and + computation concurrently. + + Use :meth:`~WriteTransport.get_write_buffer_limits` + to get the limits. + +.. method:: WriteTransport.write(data) + + Write some *data* bytes to the transport. + + This method does not block; it buffers the data and arranges for it + to be sent out asynchronously. + +.. method:: WriteTransport.writelines(list_of_data) + + Write a list (or any iterable) of data bytes to the transport. + This is functionally equivalent to calling :meth:`write` on each + element yielded by the iterable, but may be implemented more + efficiently. + +.. method:: WriteTransport.write_eof() + + Close the write end of the transport after flushing all buffered data. + Data may still be received. + + This method can raise :exc:`NotImplementedError` if the transport + (e.g. SSL) doesn't support half-closed connections. + + +Datagram Transports +------------------- + +.. method:: DatagramTransport.sendto(data, addr=None) + + Send the *data* bytes to the remote peer given by *addr* (a + transport-dependent target address). If *addr* is :const:`None`, + the data is sent to the target address given on transport + creation. + + This method does not block; it buffers the data and arranges + for it to be sent out asynchronously. + +.. method:: DatagramTransport.abort() + + Close the transport immediately, without waiting for pending + operations to complete. Buffered data will be lost. + No more data will be received. The protocol's + :meth:`protocol.connection_lost() ` + method will eventually be called with :const:`None` as its argument. + + +.. _asyncio-subprocess-transports: + +Subprocess Transports +--------------------- + +.. method:: SubprocessTransport.get_pid() + + Return the subprocess process id as an integer. + +.. method:: SubprocessTransport.get_pipe_transport(fd) + + Return the transport for the communication pipe corresponding to the + integer file descriptor *fd*: + + * ``0``: readable streaming transport of the standard input (*stdin*), + or :const:`None` if the subprocess was not created with ``stdin=PIPE`` + * ``1``: writable streaming transport of the standard output (*stdout*), + or :const:`None` if the subprocess was not created with ``stdout=PIPE`` + * ``2``: writable streaming transport of the standard error (*stderr*), + or :const:`None` if the subprocess was not created with ``stderr=PIPE`` + * other *fd*: :const:`None` + +.. method:: SubprocessTransport.get_returncode() + + Return the subprocess return code as an integer or :const:`None` + if it hasn't returned, which is similar to the + :attr:`subprocess.Popen.returncode` attribute. + +.. method:: SubprocessTransport.kill() + + Kill the subprocess. + + On POSIX systems, the function sends SIGKILL to the subprocess. + On Windows, this method is an alias for :meth:`terminate`. + + See also :meth:`subprocess.Popen.kill`. + +.. method:: SubprocessTransport.send_signal(signal) + + Send the *signal* number to the subprocess, as in + :meth:`subprocess.Popen.send_signal`. + +.. method:: SubprocessTransport.terminate() + + Stop the subprocess. + + On POSIX systems, this method sends SIGTERM to the subprocess. + On Windows, the Windows API function TerminateProcess() is called to + stop the subprocess. + + See also :meth:`subprocess.Popen.terminate`. + +.. method:: SubprocessTransport.close() + + Kill the subprocess by calling the :meth:`kill` method. + + If the subprocess hasn't returned yet, and close transports of + *stdin*, *stdout*, and *stderr* pipes. + + +.. _asyncio-protocol: + +Protocols +========= + +asyncio provides a set of abstract base classes that should be used +to implement network protocols. Those classes are meant to be used +together with :ref:`transports `. + +Subclasses of abstract base protocol classes may implement some or +all methods. All these methods are callbacks: they are called by +transports on certain events, for example when some data is received. +A base protocol method should be called by the corresponding transport. + + +Base Protocols +-------------- + +.. class:: BaseProtocol + + Base protocol with methods that all protocols share. + +.. class:: Protocol(BaseProtocol) + + The base class for implementing streaming protocols + (TCP, Unix sockets, etc). + +.. class:: BufferedProtocol(BaseProtocol) + + A base class for implementing streaming protocols with manual + control of the receive buffer. + +.. class:: DatagramProtocol(BaseProtocol) + + The base class for implementing datagram (UDP) protocols. + +.. class:: SubprocessProtocol(BaseProtocol) + + The base class for implementing protocols communicating with child + processes (unidirectional pipes). + + +Base Protocol +------------- + +All asyncio protocols can implement Base Protocol callbacks. + +.. rubric:: Connection Callbacks + +Connection callbacks are called on all protocols, exactly once per +a successful connection. All other protocol callbacks can only be +called between those two methods. + +.. method:: BaseProtocol.connection_made(transport) + + Called when a connection is made. + + The *transport* argument is the transport representing the + connection. The protocol is responsible for storing the reference + to its transport. + +.. method:: BaseProtocol.connection_lost(exc) + + Called when the connection is lost or closed. + + The argument is either an exception object or :const:`None`. + The latter means a regular EOF is received, or the connection was + aborted or closed by this side of the connection. + + +.. rubric:: Flow Control Callbacks + +Flow control callbacks can be called by transports to pause or +resume writing performed by the protocol. + +See the documentation of the :meth:`~WriteTransport.set_write_buffer_limits` +method for more details. + +.. method:: BaseProtocol.pause_writing() + + Called when the transport's buffer goes over the high watermark. + +.. method:: BaseProtocol.resume_writing() + + Called when the transport's buffer drains below the low watermark. + +If the buffer size equals the high watermark, +:meth:`~BaseProtocol.pause_writing` is not called: the buffer size must +go strictly over. + +Conversely, :meth:`~BaseProtocol.resume_writing` is called when the +buffer size is equal or lower than the low watermark. These end +conditions are important to ensure that things go as expected when +either mark is zero. + + +Streaming Protocols +------------------- + +Event methods, such as :meth:`loop.create_server`, +:meth:`loop.create_unix_server`, :meth:`loop.create_connection`, +:meth:`loop.create_unix_connection`, :meth:`loop.connect_accepted_socket`, +:meth:`loop.connect_read_pipe`, and :meth:`loop.connect_write_pipe` +accept factories that return streaming protocols. + +.. method:: Protocol.data_received(data) + + Called when some data is received. *data* is a non-empty bytes + object containing the incoming data. + + Whether the data is buffered, chunked or reassembled depends on + the transport. In general, you shouldn't rely on specific semantics + and instead make your parsing generic and flexible. However, + data is always received in the correct order. + + The method can be called an arbitrary number of times while + a connection is open. + + However, :meth:`protocol.eof_received() ` + is called at most once. Once `eof_received()` is called, + ``data_received()`` is not called anymore. + +.. method:: Protocol.eof_received() + + Called when the other end signals it won't send any more data + (for example by calling :meth:`transport.write_eof() + `, if the other end also uses + asyncio). + + This method may return a false value (including ``None``), in which case + the transport will close itself. Conversely, if this method returns a + true value, the protocol used determines whether to close the transport. + Since the default implementation returns ``None``, it implicitly closes the + connection. + + Some transports, including SSL, don't support half-closed connections, + in which case returning true from this method will result in the connection + being closed. + + +State machine: + +.. code-block:: none + + start -> connection_made + [-> data_received]* + [-> eof_received]? + -> connection_lost -> end + + +Buffered Streaming Protocols +---------------------------- + +.. versionadded:: 3.7 + **Important:** this has been added to asyncio in Python 3.7 + *on a provisional basis*! This is as an experimental API that + might be changed or removed completely in Python 3.8. + +Buffered Protocols can be used with any event loop method +that supports `Streaming Protocols`_. + +``BufferedProtocol`` implementations allow explicit manual allocation +and control of the receive buffer. Event loops can then use the buffer +provided by the protocol to avoid unnecessary data copies. This +can result in noticeable performance improvement for protocols that +receive big amounts of data. Sophisticated protocol implementations +can significantly reduce the number of buffer allocations. + +The following callbacks are called on :class:`BufferedProtocol` +instances: + +.. method:: BufferedProtocol.get_buffer(sizehint) + + Called to allocate a new receive buffer. + + *sizehint* is the recommended minimum size for the returned + buffer. It is acceptable to return smaller or larger buffers + than what *sizehint* suggests. When set to -1, the buffer size + can be arbitrary. It is an error to return a buffer with a zero size. + + ``get_buffer()`` must return an object implementing the + :ref:`buffer protocol `. + +.. method:: BufferedProtocol.buffer_updated(nbytes) + + Called when the buffer was updated with the received data. + + *nbytes* is the total number of bytes that were written to the buffer. + +.. method:: BufferedProtocol.eof_received() + + See the documentation of the :meth:`protocol.eof_received() + ` method. + + +:meth:`~BufferedProtocol.get_buffer` can be called an arbitrary number +of times during a connection. However, :meth:`protocol.eof_received() +` is called at most once +and, if called, :meth:`~BufferedProtocol.get_buffer` and +:meth:`~BufferedProtocol.buffer_updated` won't be called after it. + +State machine: + +.. code-block:: none + + start -> connection_made + [-> get_buffer + [-> buffer_updated]? + ]* + [-> eof_received]? + -> connection_lost -> end + + +Datagram Protocols +------------------ + +Datagram Protocol instances should be constructed by protocol +factories passed to the :meth:`loop.create_datagram_endpoint` method. + +.. method:: DatagramProtocol.datagram_received(data, addr) + + Called when a datagram is received. *data* is a bytes object containing + the incoming data. *addr* is the address of the peer sending the data; + the exact format depends on the transport. + +.. method:: DatagramProtocol.error_received(exc) + + Called when a previous send or receive operation raises an + :class:`OSError`. *exc* is the :class:`OSError` instance. + + This method is called in rare conditions, when the transport (e.g. UDP) + detects that a datagram could not be delivered to its recipient. + In many conditions though, undeliverable datagrams will be silently + dropped. + +.. note:: + + On BSD systems (macOS, FreeBSD, etc.) flow control is not supported + for datagram protocols, because there is no reliable way to detect send + failures caused by writing too many packets. + + The socket always appears 'ready' and excess packets are dropped. An + :class:`OSError` with ``errno`` set to :const:`errno.ENOBUFS` may + or may not be raised; if it is raised, it will be reported to + :meth:`DatagramProtocol.error_received` but otherwise ignored. + + +.. _asyncio-subprocess-protocols: + +Subprocess Protocols +-------------------- + +Datagram Protocol instances should be constructed by protocol +factories passed to the :meth:`loop.subprocess_exec` and +:meth:`loop.subprocess_shell` methods. + +.. method:: SubprocessProtocol.pipe_data_received(fd, data) + + Called when the child process writes data into its stdout or stderr + pipe. + + *fd* is the integer file descriptor of the pipe. + + *data* is a non-empty bytes object containing the received data. + +.. method:: SubprocessProtocol.pipe_connection_lost(fd, exc) + + Called when one of the pipes communicating with the child process + is closed. + + *fd* is the integer file descriptor that was closed. + +.. method:: SubprocessProtocol.process_exited() + + Called when the child process has exited. + + +Examples +======== + +.. _asyncio_example_tcp_echo_server_protocol: + +TCP Echo Server +--------------- + +Create a TCP echo server using the :meth:`loop.create_server` method, send back +received data, and close the connection:: + + import asyncio + + + class EchoServerProtocol(asyncio.Protocol): + def connection_made(self, transport): + peername = transport.get_extra_info('peername') + print('Connection from {}'.format(peername)) + self.transport = transport + + def data_received(self, data): + message = data.decode() + print('Data received: {!r}'.format(message)) + + print('Send: {!r}'.format(message)) + self.transport.write(data) + + print('Close the client socket') + self.transport.close() + + + async def main(): + # Get a reference to the event loop as we plan to use + # low-level APIs. + loop = asyncio.get_running_loop() + + server = await loop.create_server( + lambda: EchoServerProtocol(), + '127.0.0.1', 8888) + + async with server: + await server.serve_forever() + + + asyncio.run(main()) + + +.. seealso:: + + The :ref:`TCP echo server using streams ` + example uses the high-level :func:`asyncio.start_server` function. + +.. _asyncio_example_tcp_echo_client_protocol: + +TCP Echo Client +--------------- + +A TCP echo client using the :meth:`loop.create_connection` method, sends +data, and waits until the connection is closed:: + + import asyncio + + + class EchoClientProtocol(asyncio.Protocol): + def __init__(self, message, on_con_lost, loop): + self.message = message + self.loop = loop + self.on_con_lost = on_con_lost + + def connection_made(self, transport): + transport.write(self.message.encode()) + print('Data sent: {!r}'.format(self.message)) + + def data_received(self, data): + print('Data received: {!r}'.format(data.decode())) + + def connection_lost(self, exc): + print('The server closed the connection') + self.on_con_lost.set_result(True) + + + async def main(): + # Get a reference to the event loop as we plan to use + # low-level APIs. + loop = asyncio.get_running_loop() + + on_con_lost = loop.create_future() + message = 'Hello World!' + + transport, protocol = await loop.create_connection( + lambda: EchoClientProtocol(message, on_con_lost, loop), + '127.0.0.1', 8888) + + # Wait until the protocol signals that the connection + # is lost and close the transport. + try: + await on_con_lost + finally: + transport.close() + + + asyncio.run(main()) + + +.. seealso:: + + The :ref:`TCP echo client using streams ` + example uses the high-level :func:`asyncio.open_connection` function. + + +.. _asyncio-udp-echo-server-protocol: + +UDP Echo Server +--------------- + +A UDP echo server, using the :meth:`loop.create_datagram_endpoint` +method, sends back received data:: + + import asyncio + + + class EchoServerProtocol: + def connection_made(self, transport): + self.transport = transport + + def datagram_received(self, data, addr): + message = data.decode() + print('Received %r from %s' % (message, addr)) + print('Send %r to %s' % (message, addr)) + self.transport.sendto(data, addr) + + + async def main(): + print("Starting UDP server") + + # Get a reference to the event loop as we plan to use + # low-level APIs. + loop = asyncio.get_running_loop() + + # One protocol instance will be created to serve all + # client requests. + transport, protocol = await loop.create_datagram_endpoint( + lambda: EchoServerProtocol(), + local_addr=('127.0.0.1', 9999)) + + try: + await asyncio.sleep(3600) # Serve for 1 hour. + finally: + transport.close() + + + asyncio.run(main()) + + +.. _asyncio-udp-echo-client-protocol: + +UDP Echo Client +--------------- + +A UDP echo client, using the :meth:`loop.create_datagram_endpoint` +method, sends data and closes the transport when it receives the answer:: + + import asyncio + + + class EchoClientProtocol: + def __init__(self, message, loop): + self.message = message + self.loop = loop + self.transport = None + self.on_con_lost = loop.create_future() + + def connection_made(self, transport): + self.transport = transport + print('Send:', self.message) + self.transport.sendto(self.message.encode()) + + def datagram_received(self, data, addr): + print("Received:", data.decode()) + + print("Close the socket") + self.transport.close() + + def error_received(self, exc): + print('Error received:', exc) + + def connection_lost(self, exc): + print("Connection closed") + self.on_con_lost.set_result(True) + + + async def main(): + # Get a reference to the event loop as we plan to use + # low-level APIs. + loop = asyncio.get_running_loop() + + message = "Hello World!" + transport, protocol = await loop.create_datagram_endpoint( + lambda: EchoClientProtocol(message, loop), + remote_addr=('127.0.0.1', 9999)) + + try: + await protocol.on_con_lost + finally: + transport.close() + + + asyncio.run(main()) + + +.. _asyncio_example_create_connection: + +Connecting Existing Sockets +--------------------------- + +Wait until a socket receives data using the +:meth:`loop.create_connection` method with a protocol:: + + import asyncio + import socket + + + class MyProtocol(asyncio.Protocol): + + def __init__(self, loop): + self.transport = None + self.on_con_lost = loop.create_future() + + def connection_made(self, transport): + self.transport = transport + + def data_received(self, data): + print("Received:", data.decode()) + + # We are done: close the transport; + # connection_lost() will be called automatically. + self.transport.close() + + def connection_lost(self, exc): + # The socket has been closed + self.on_con_lost.set_result(True) + + + async def main(): + # Get a reference to the event loop as we plan to use + # low-level APIs. + loop = asyncio.get_running_loop() + + # Create a pair of connected sockets + rsock, wsock = socket.socketpair() + + # Register the socket to wait for data. + transport, protocol = await loop.create_connection( + lambda: MyProtocol(loop), sock=rsock) + + # Simulate the reception of data from the network. + loop.call_soon(wsock.send, 'abc'.encode()) + + try: + await protocol.on_con_lost + finally: + transport.close() + wsock.close() + + asyncio.run(main()) + +.. seealso:: + + The :ref:`watch a file descriptor for read events + ` example uses the low-level + :meth:`loop.add_reader` method to register an FD. + + The :ref:`register an open socket to wait for data using streams + ` example uses high-level streams + created by the :func:`open_connection` function in a coroutine. + +.. _asyncio_example_subprocess_proto: + +loop.subprocess_exec() and SubprocessProtocol +--------------------------------------------- + +An example of a subprocess protocol used to get the output of a +subprocess and to wait for the subprocess exit. + +The subprocess is created by th :meth:`loop.subprocess_exec` method:: + + import asyncio + import sys + + class DateProtocol(asyncio.SubprocessProtocol): + def __init__(self, exit_future): + self.exit_future = exit_future + self.output = bytearray() + + def pipe_data_received(self, fd, data): + self.output.extend(data) + + def process_exited(self): + self.exit_future.set_result(True) + + async def get_date(): + # Get a reference to the event loop as we plan to use + # low-level APIs. + loop = asyncio.get_running_loop() + + code = 'import datetime; print(datetime.datetime.now())' + exit_future = asyncio.Future(loop=loop) + + # Create the subprocess controlled by DateProtocol; + # redirect the standard output into a pipe. + transport, protocol = await loop.subprocess_exec( + lambda: DateProtocol(exit_future), + sys.executable, '-c', code, + stdin=None, stderr=None) + + # Wait for the subprocess exit using the process_exited() + # method of the protocol. + await exit_future + + # Close the stdout pipe. + transport.close() + + # Read the output which was collected by the + # pipe_data_received() method of the protocol. + data = bytes(protocol.output) + return data.decode('ascii').rstrip() + + if sys.platform == "win32": + asyncio.set_event_loop_policy( + asyncio.WindowsProactorEventLoopPolicy()) + + date = asyncio.run(get_date()) + print(f"Current date: {date}") + +See also the :ref:`same example ` +written using high-level APIs. diff --git a/python-3.7.4-docs-html/_sources/library/asyncio-queue.rst.txt b/python-3.7.4-docs-html/_sources/library/asyncio-queue.rst.txt new file mode 100644 index 0000000..7be1023 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/asyncio-queue.rst.txt @@ -0,0 +1,200 @@ +.. currentmodule:: asyncio + +.. _asyncio-queues: + +====== +Queues +====== + +asyncio queues are designed to be similar to classes of the +:mod:`queue` module. Although asyncio queues are not thread-safe, +they are designed to be used specifically in async/await code. + +Note that methods of asyncio queues don't have a *timeout* parameter; +use :func:`asyncio.wait_for` function to do queue operations with a +timeout. + +See also the `Examples`_ section below. + +Queue +===== + +.. class:: Queue(maxsize=0, \*, loop=None) + + A first in, first out (FIFO) queue. + + If *maxsize* is less than or equal to zero, the queue size is + infinite. If it is an integer greater than ``0``, then + ``await put()`` blocks when the queue reaches *maxsize* + until an item is removed by :meth:`get`. + + Unlike the standard library threading :mod:`queue`, the size of + the queue is always known and can be returned by calling the + :meth:`qsize` method. + + This class is :ref:`not thread safe `. + + .. attribute:: maxsize + + Number of items allowed in the queue. + + .. method:: empty() + + Return ``True`` if the queue is empty, ``False`` otherwise. + + .. method:: full() + + Return ``True`` if there are :attr:`maxsize` items in the queue. + + If the queue was initialized with ``maxsize=0`` (the default), + then :meth:`full()` never returns ``True``. + + .. coroutinemethod:: get() + + Remove and return an item from the queue. If queue is empty, + wait until an item is available. + + .. method:: get_nowait() + + Return an item if one is immediately available, else raise + :exc:`QueueEmpty`. + + .. coroutinemethod:: join() + + Block until all items in the queue have been received and processed. + + The count of unfinished tasks goes up whenever an item is added + to the queue. The count goes down whenever a consumer coroutine calls + :meth:`task_done` to indicate that the item was retrieved and all + work on it is complete. When the count of unfinished tasks drops + to zero, :meth:`join` unblocks. + + .. coroutinemethod:: put(item) + + Put an item into the queue. If the queue is full, wait until a + free slot is available before adding the item. + + .. method:: put_nowait(item) + + Put an item into the queue without blocking. + + If no free slot is immediately available, raise :exc:`QueueFull`. + + .. method:: qsize() + + Return the number of items in the queue. + + .. method:: task_done() + + Indicate that a formerly enqueued task is complete. + + Used by queue consumers. For each :meth:`~Queue.get` used to + fetch a task, a subsequent call to :meth:`task_done` tells the + queue that the processing on the task is complete. + + If a :meth:`join` is currently blocking, it will resume when all + items have been processed (meaning that a :meth:`task_done` + call was received for every item that had been :meth:`~Queue.put` + into the queue). + + Raises :exc:`ValueError` if called more times than there were + items placed in the queue. + + +Priority Queue +============== + +.. class:: PriorityQueue + + A variant of :class:`Queue`; retrieves entries in priority order + (lowest first). + + Entries are typically tuples of the form + ``(priority_number, data)``. + + +LIFO Queue +========== + +.. class:: LifoQueue + + A variant of :class:`Queue` that retrieves most recently added + entries first (last in, first out). + + +Exceptions +========== + +.. exception:: QueueEmpty + + This exception is raised when the :meth:`~Queue.get_nowait` method + is called on an empty queue. + + +.. exception:: QueueFull + + Exception raised when the :meth:`~Queue.put_nowait` method is called + on a queue that has reached its *maxsize*. + + +Examples +======== + +.. _asyncio_example_queue_dist: + +Queues can be used to distribute workload between several +concurrent tasks:: + + import asyncio + import random + import time + + + async def worker(name, queue): + while True: + # Get a "work item" out of the queue. + sleep_for = await queue.get() + + # Sleep for the "sleep_for" seconds. + await asyncio.sleep(sleep_for) + + # Notify the queue that the "work item" has been processed. + queue.task_done() + + print(f'{name} has slept for {sleep_for:.2f} seconds') + + + async def main(): + # Create a queue that we will use to store our "workload". + queue = asyncio.Queue() + + # Generate random timings and put them into the queue. + total_sleep_time = 0 + for _ in range(20): + sleep_for = random.uniform(0.05, 1.0) + total_sleep_time += sleep_for + queue.put_nowait(sleep_for) + + # Create three worker tasks to process the queue concurrently. + tasks = [] + for i in range(3): + task = asyncio.create_task(worker(f'worker-{i}', queue)) + tasks.append(task) + + # Wait until the queue is fully processed. + started_at = time.monotonic() + await queue.join() + total_slept_for = time.monotonic() - started_at + + # Cancel our worker tasks. + for task in tasks: + task.cancel() + # Wait until all worker tasks are cancelled. + await asyncio.gather(*tasks, return_exceptions=True) + + print('====') + print(f'3 workers slept in parallel for {total_slept_for:.2f} seconds') + print(f'total expected sleep time: {total_sleep_time:.2f} seconds') + + + asyncio.run(main()) diff --git a/python-3.7.4-docs-html/_sources/library/asyncio-stream.rst.txt b/python-3.7.4-docs-html/_sources/library/asyncio-stream.rst.txt new file mode 100644 index 0000000..42b4c1f --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/asyncio-stream.rst.txt @@ -0,0 +1,470 @@ +.. currentmodule:: asyncio + +.. _asyncio-streams: + +======= +Streams +======= + +Streams are high-level async/await-ready primitives to work with +network connections. Streams allow sending and receiving data without +using callbacks or low-level protocols and transports. + +.. _asyncio_example_stream: + +Here is an example of a TCP echo client written using asyncio +streams:: + + import asyncio + + async def tcp_echo_client(message): + reader, writer = await asyncio.open_connection( + '127.0.0.1', 8888) + + print(f'Send: {message!r}') + writer.write(message.encode()) + + data = await reader.read(100) + print(f'Received: {data.decode()!r}') + + print('Close the connection') + writer.close() + await writer.wait_closed() + + asyncio.run(tcp_echo_client('Hello World!')) + + +See also the `Examples`_ section below. + + +.. rubric:: Stream Functions + +The following top-level asyncio functions can be used to create +and work with streams: + + +.. coroutinefunction:: open_connection(host=None, port=None, \*, \ + loop=None, limit=None, ssl=None, family=0, \ + proto=0, flags=0, sock=None, local_addr=None, \ + server_hostname=None, ssl_handshake_timeout=None) + + Establish a network connection and return a pair of + ``(reader, writer)`` objects. + + The returned *reader* and *writer* objects are instances of + :class:`StreamReader` and :class:`StreamWriter` classes. + + The *loop* argument is optional and can always be determined + automatically when this function is awaited from a coroutine. + + *limit* determines the buffer size limit used by the + returned :class:`StreamReader` instance. By default the *limit* + is set to 64 KiB. + + The rest of the arguments are passed directly to + :meth:`loop.create_connection`. + + .. versionadded:: 3.7 + + The *ssl_handshake_timeout* parameter. + +.. coroutinefunction:: start_server(client_connected_cb, host=None, \ + port=None, \*, loop=None, limit=None, \ + family=socket.AF_UNSPEC, \ + flags=socket.AI_PASSIVE, sock=None, \ + backlog=100, ssl=None, reuse_address=None, \ + reuse_port=None, ssl_handshake_timeout=None, \ + start_serving=True) + + Start a socket server. + + The *client_connected_cb* callback is called whenever a new client + connection is established. It receives a ``(reader, writer)`` pair + as two arguments, instances of the :class:`StreamReader` and + :class:`StreamWriter` classes. + + *client_connected_cb* can be a plain callable or a + :ref:`coroutine function `; if it is a coroutine function, + it will be automatically scheduled as a :class:`Task`. + + The *loop* argument is optional and can always be determined + automatically when this method is awaited from a coroutine. + + *limit* determines the buffer size limit used by the + returned :class:`StreamReader` instance. By default the *limit* + is set to 64 KiB. + + The rest of the arguments are passed directly to + :meth:`loop.create_server`. + + .. versionadded:: 3.7 + + The *ssl_handshake_timeout* and *start_serving* parameters. + + +.. rubric:: Unix Sockets + +.. coroutinefunction:: open_unix_connection(path=None, \*, loop=None, \ + limit=None, ssl=None, sock=None, \ + server_hostname=None, ssl_handshake_timeout=None) + + Establish a Unix socket connection and return a pair of + ``(reader, writer)``. + + Similar to :func:`open_connection` but operates on Unix sockets. + + See also the documentation of :meth:`loop.create_unix_connection`. + + .. availability:: Unix. + + .. versionadded:: 3.7 + + The *ssl_handshake_timeout* parameter. + + .. versionchanged:: 3.7 + + The *path* parameter can now be a :term:`path-like object` + + +.. coroutinefunction:: start_unix_server(client_connected_cb, path=None, \ + \*, loop=None, limit=None, sock=None, \ + backlog=100, ssl=None, ssl_handshake_timeout=None, \ + start_serving=True) + + Start a Unix socket server. + + Similar to :func:`start_server` but works with Unix sockets. + + See also the documentation of :meth:`loop.create_unix_server`. + + .. availability:: Unix. + + .. versionadded:: 3.7 + + The *ssl_handshake_timeout* and *start_serving* parameters. + + .. versionchanged:: 3.7 + + The *path* parameter can now be a :term:`path-like object`. + + +--------- + + +StreamReader +============ + +.. class:: StreamReader + + Represents a reader object that provides APIs to read data + from the IO stream. + + It is not recommended to instantiate *StreamReader* objects + directly; use :func:`open_connection` and :func:`start_server` + instead. + + .. coroutinemethod:: read(n=-1) + + Read up to *n* bytes. If *n* is not provided, or set to ``-1``, + read until EOF and return all read bytes. + + If EOF was received and the internal buffer is empty, + return an empty ``bytes`` object. + + .. coroutinemethod:: readline() + + Read one line, where "line" is a sequence of bytes + ending with ``\n``. + + If EOF is received and ``\n`` was not found, the method + returns partially read data. + + If EOF is received and the internal buffer is empty, + return an empty ``bytes`` object. + + .. coroutinemethod:: readexactly(n) + + Read exactly *n* bytes. + + Raise an :exc:`IncompleteReadError` if EOF is reached before *n* + can be read. Use the :attr:`IncompleteReadError.partial` + attribute to get the partially read data. + + .. coroutinemethod:: readuntil(separator=b'\\n') + + Read data from the stream until *separator* is found. + + On success, the data and separator will be removed from the + internal buffer (consumed). Returned data will include the + separator at the end. + + If the amount of data read exceeds the configured stream limit, a + :exc:`LimitOverrunError` exception is raised, and the data + is left in the internal buffer and can be read again. + + If EOF is reached before the complete separator is found, + an :exc:`IncompleteReadError` exception is raised, and the internal + buffer is reset. The :attr:`IncompleteReadError.partial` attribute + may contain a portion of the separator. + + .. versionadded:: 3.5.2 + + .. method:: at_eof() + + Return ``True`` if the buffer is empty and :meth:`feed_eof` + was called. + + +StreamWriter +============ + +.. class:: StreamWriter + + Represents a writer object that provides APIs to write data + to the IO stream. + + It is not recommended to instantiate *StreamWriter* objects + directly; use :func:`open_connection` and :func:`start_server` + instead. + + .. method:: can_write_eof() + + Return *True* if the underlying transport supports + the :meth:`write_eof` method, *False* otherwise. + + .. method:: write_eof() + + Close the write end of the stream after the buffered write + data is flushed. + + .. attribute:: transport + + Return the underlying asyncio transport. + + .. method:: get_extra_info(name, default=None) + + Access optional transport information; see + :meth:`BaseTransport.get_extra_info` for details. + + .. method:: write(data) + + Write *data* to the stream. + + This method is not subject to flow control. Calls to ``write()`` should + be followed by :meth:`drain`. + + .. method:: writelines(data) + + Write a list (or any iterable) of bytes to the stream. + + This method is not subject to flow control. Calls to ``writelines()`` + should be followed by :meth:`drain`. + + .. coroutinemethod:: drain() + + Wait until it is appropriate to resume writing to the stream. + Example:: + + writer.write(data) + await writer.drain() + + This is a flow control method that interacts with the underlying + IO write buffer. When the size of the buffer reaches + the high watermark, *drain()* blocks until the size of the + buffer is drained down to the low watermark and writing can + be resumed. When there is nothing to wait for, the :meth:`drain` + returns immediately. + + .. method:: close() + + Close the stream. + + .. method:: is_closing() + + Return ``True`` if the stream is closed or in the process of + being closed. + + .. versionadded:: 3.7 + + .. coroutinemethod:: wait_closed() + + Wait until the stream is closed. + + Should be called after :meth:`close` to wait until the underlying + connection is closed. + + .. versionadded:: 3.7 + + +Examples +======== + +.. _asyncio-tcp-echo-client-streams: + +TCP echo client using streams +----------------------------- + +TCP echo client using the :func:`asyncio.open_connection` function:: + + import asyncio + + async def tcp_echo_client(message): + reader, writer = await asyncio.open_connection( + '127.0.0.1', 8888) + + print(f'Send: {message!r}') + writer.write(message.encode()) + + data = await reader.read(100) + print(f'Received: {data.decode()!r}') + + print('Close the connection') + writer.close() + + asyncio.run(tcp_echo_client('Hello World!')) + + +.. seealso:: + + The :ref:`TCP echo client protocol ` + example uses the low-level :meth:`loop.create_connection` method. + + +.. _asyncio-tcp-echo-server-streams: + +TCP echo server using streams +----------------------------- + +TCP echo server using the :func:`asyncio.start_server` function:: + + import asyncio + + async def handle_echo(reader, writer): + data = await reader.read(100) + message = data.decode() + addr = writer.get_extra_info('peername') + + print(f"Received {message!r} from {addr!r}") + + print(f"Send: {message!r}") + writer.write(data) + await writer.drain() + + print("Close the connection") + writer.close() + + async def main(): + server = await asyncio.start_server( + handle_echo, '127.0.0.1', 8888) + + addr = server.sockets[0].getsockname() + print(f'Serving on {addr}') + + async with server: + await server.serve_forever() + + asyncio.run(main()) + + +.. seealso:: + + The :ref:`TCP echo server protocol ` + example uses the :meth:`loop.create_server` method. + + +Get HTTP headers +---------------- + +Simple example querying HTTP headers of the URL passed on the command line:: + + import asyncio + import urllib.parse + import sys + + async def print_http_headers(url): + url = urllib.parse.urlsplit(url) + if url.scheme == 'https': + reader, writer = await asyncio.open_connection( + url.hostname, 443, ssl=True) + else: + reader, writer = await asyncio.open_connection( + url.hostname, 80) + + query = ( + f"HEAD {url.path or '/'} HTTP/1.0\r\n" + f"Host: {url.hostname}\r\n" + f"\r\n" + ) + + writer.write(query.encode('latin-1')) + while True: + line = await reader.readline() + if not line: + break + + line = line.decode('latin1').rstrip() + if line: + print(f'HTTP header> {line}') + + # Ignore the body, close the socket + writer.close() + + url = sys.argv[1] + asyncio.run(print_http_headers(url)) + + +Usage:: + + python example.py http://example.com/path/page.html + +or with HTTPS:: + + python example.py https://example.com/path/page.html + + +.. _asyncio_example_create_connection-streams: + +Register an open socket to wait for data using streams +------------------------------------------------------ + +Coroutine waiting until a socket receives data using the +:func:`open_connection` function:: + + import asyncio + import socket + + async def wait_for_data(): + # Get a reference to the current event loop because + # we want to access low-level APIs. + loop = asyncio.get_running_loop() + + # Create a pair of connected sockets. + rsock, wsock = socket.socketpair() + + # Register the open socket to wait for data. + reader, writer = await asyncio.open_connection(sock=rsock) + + # Simulate the reception of data from the network + loop.call_soon(wsock.send, 'abc'.encode()) + + # Wait for data + data = await reader.read(100) + + # Got data, we are done: close the socket + print("Received:", data.decode()) + writer.close() + + # Close the second socket + wsock.close() + + asyncio.run(wait_for_data()) + +.. seealso:: + + The :ref:`register an open socket to wait for data using a protocol + ` example uses a low-level protocol and + the :meth:`loop.create_connection` method. + + The :ref:`watch a file descriptor for read events + ` example uses the low-level + :meth:`loop.add_reader` method to watch a file descriptor. diff --git a/python-3.7.4-docs-html/_sources/library/asyncio-subprocess.rst.txt b/python-3.7.4-docs-html/_sources/library/asyncio-subprocess.rst.txt new file mode 100644 index 0000000..af7e36e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/asyncio-subprocess.rst.txt @@ -0,0 +1,356 @@ +.. currentmodule:: asyncio + +.. _asyncio-subprocess: + +============ +Subprocesses +============ + +This section describes high-level async/await asyncio APIs to +create and manage subprocesses. + +.. _asyncio_example_subprocess_shell: + +Here's an example of how asyncio can run a shell command and +obtain its result:: + + import asyncio + + async def run(cmd): + proc = await asyncio.create_subprocess_shell( + cmd, + stdout=asyncio.subprocess.PIPE, + stderr=asyncio.subprocess.PIPE) + + stdout, stderr = await proc.communicate() + + print(f'[{cmd!r} exited with {proc.returncode}]') + if stdout: + print(f'[stdout]\n{stdout.decode()}') + if stderr: + print(f'[stderr]\n{stderr.decode()}') + + asyncio.run(run('ls /zzz')) + +will print:: + + ['ls /zzz' exited with 1] + [stderr] + ls: /zzz: No such file or directory + +Because all asyncio subprocess functions are asynchronous and asyncio +provides many tools to work with such functions, it is easy to execute +and monitor multiple subprocesses in parallel. It is indeed trivial +to modify the above example to run several commands simultaneously:: + + async def main(): + await asyncio.gather( + run('ls /zzz'), + run('sleep 1; echo "hello"')) + + asyncio.run(main()) + +See also the `Examples`_ subsection. + + +Creating Subprocesses +===================== + +.. coroutinefunction:: create_subprocess_exec(program, \*args, stdin=None, \ + stdout=None, stderr=None, loop=None, \ + limit=None, \*\*kwds) + + Create a subprocess. + + The *limit* argument sets the buffer limit for :class:`StreamReader` + wrappers for :attr:`Process.stdout` and :attr:`Process.stderr` + (if :attr:`subprocess.PIPE` is passed to *stdout* and *stderr* arguments). + + Return a :class:`~asyncio.subprocess.Process` instance. + + See the documentation of :meth:`loop.subprocess_exec` for other + parameters. + +.. coroutinefunction:: create_subprocess_shell(cmd, stdin=None, \ + stdout=None, stderr=None, loop=None, \ + limit=None, \*\*kwds) + + Run the *cmd* shell command. + + The *limit* argument sets the buffer limit for :class:`StreamReader` + wrappers for :attr:`Process.stdout` and :attr:`Process.stderr` + (if :attr:`subprocess.PIPE` is passed to *stdout* and *stderr* arguments). + + Return a :class:`~asyncio.subprocess.Process` instance. + + See the documentation of :meth:`loop.subprocess_shell` for other + parameters. + +.. important:: + + It is the application's responsibility to ensure that all whitespace and + special characters are quoted appropriately to avoid `shell injection + `_ + vulnerabilities. The :func:`shlex.quote` function can be used to properly + escape whitespace and special shell characters in strings that are going + to be used to construct shell commands. + +.. note:: + + The default asyncio event loop implementation on **Windows** does not + support subprocesses. Subprocesses are available for Windows if a + :class:`ProactorEventLoop` is used. + See :ref:`Subprocess Support on Windows ` + for details. + +.. seealso:: + + asyncio also has the following *low-level* APIs to work with subprocesses: + :meth:`loop.subprocess_exec`, :meth:`loop.subprocess_shell`, + :meth:`loop.connect_read_pipe`, :meth:`loop.connect_write_pipe`, + as well as the :ref:`Subprocess Transports ` + and :ref:`Subprocess Protocols `. + + +Constants +========= + +.. data:: asyncio.subprocess.PIPE + + Can be passed to the *stdin*, *stdout* or *stderr* parameters. + + If *PIPE* is passed to *stdin* argument, the + :attr:`Process.stdin ` attribute + will point to a :class:`StreamWriter` instance. + + If *PIPE* is passed to *stdout* or *stderr* arguments, the + :attr:`Process.stdout ` and + :attr:`Process.stderr ` + attributes will point to :class:`StreamReader` instances. + +.. data:: asyncio.subprocess.STDOUT + + Special value that can be used as the *stderr* argument and indicates + that standard error should be redirected into standard output. + +.. data:: asyncio.subprocess.DEVNULL + + Special value that can be used as the *stdin*, *stdout* or *stderr* argument + to process creation functions. It indicates that the special file + :data:`os.devnull` will be used for the corresponding subprocess stream. + + +Interacting with Subprocesses +============================= + +Both :func:`create_subprocess_exec` and :func:`create_subprocess_shell` +functions return instances of the *Process* class. *Process* is a high-level +wrapper that allows communicating with subprocesses and watching for +their completion. + +.. class:: asyncio.subprocess.Process + + An object that wraps OS processes created by the + :func:`create_subprocess_exec` and :func:`create_subprocess_shell` + functions. + + This class is designed to have a similar API to the + :class:`subprocess.Popen` class, but there are some + notable differences: + + * unlike Popen, Process instances do not have an equivalent to + the :meth:`~subprocess.Popen.poll` method; + + * the :meth:`~asyncio.subprocess.Process.communicate` and + :meth:`~asyncio.subprocess.Process.wait` methods don't have a + *timeout* parameter: use the :func:`wait_for` function; + + * the :meth:`Process.wait() ` method + is asynchronous, whereas :meth:`subprocess.Popen.wait` method + is implemented as a blocking busy loop; + + * the *universal_newlines* parameter is not supported. + + This class is :ref:`not thread safe `. + + See also the :ref:`Subprocess and Threads ` + section. + + .. coroutinemethod:: wait() + + Wait for the child process to terminate. + + Set and return the :attr:`returncode` attribute. + + .. note:: + + This method can deadlock when using ``stdout=PIPE`` or + ``stderr=PIPE`` and the child process generates so much output + that it blocks waiting for the OS pipe buffer to accept + more data. Use the :meth:`communicate` method when using pipes + to avoid this condition. + + .. coroutinemethod:: communicate(input=None) + + Interact with process: + + 1. send data to *stdin* (if *input* is not ``None``); + 2. read data from *stdout* and *stderr*, until EOF is reached; + 3. wait for process to terminate. + + The optional *input* argument is the data (:class:`bytes` object) + that will be sent to the child process. + + Return a tuple ``(stdout_data, stderr_data)``. + + If either :exc:`BrokenPipeError` or :exc:`ConnectionResetError` + exception is raised when writing *input* into *stdin*, the + exception is ignored. This condition occurs when the process + exits before all data are written into *stdin*. + + If it is desired to send data to the process' *stdin*, + the process needs to be created with ``stdin=PIPE``. Similarly, + to get anything other than ``None`` in the result tuple, the + process has to be created with ``stdout=PIPE`` and/or + ``stderr=PIPE`` arguments. + + Note, that the data read is buffered in memory, so do not use + this method if the data size is large or unlimited. + + .. method:: send_signal(signal) + + Sends the signal *signal* to the child process. + + .. note:: + + On Windows, :py:data:`SIGTERM` is an alias for :meth:`terminate`. + ``CTRL_C_EVENT`` and ``CTRL_BREAK_EVENT`` can be sent to processes + started with a *creationflags* parameter which includes + ``CREATE_NEW_PROCESS_GROUP``. + + .. method:: terminate() + + Stop the child process. + + On POSIX systems this method sends :py:data:`signal.SIGTERM` to the + child process. + + On Windows the Win32 API function :c:func:`TerminateProcess` is + called to stop the child process. + + .. method:: kill() + + Kill the child. + + On POSIX systems this method sends :py:data:`SIGKILL` to the child + process. + + On Windows this method is an alias for :meth:`terminate`. + + .. attribute:: stdin + + Standard input stream (:class:`StreamWriter`) or ``None`` + if the process was created with ``stdin=None``. + + .. attribute:: stdout + + Standard output stream (:class:`StreamReader`) or ``None`` + if the process was created with ``stdout=None``. + + .. attribute:: stderr + + Standard error stream (:class:`StreamReader`) or ``None`` + if the process was created with ``stderr=None``. + + .. warning:: + + Use the :meth:`communicate` method rather than + :attr:`process.stdin.write() `, + :attr:`await process.stdout.read() ` or + :attr:`await process.stderr.read `. + This avoids deadlocks due to streams pausing reading or writing + and blocking the child process. + + .. attribute:: pid + + Process identification number (PID). + + Note that for processes created by the :func:`create_subprocess_shell` + function, this attribute is the PID of the spawned shell. + + .. attribute:: returncode + + Return code of the process when it exits. + + A ``None`` value indicates that the process has not terminated yet. + + A negative value ``-N`` indicates that the child was terminated + by signal ``N`` (POSIX only). + + +.. _asyncio-subprocess-threads: + +Subprocess and Threads +---------------------- + +Standard asyncio event loop supports running subprocesses from +different threads, but there are limitations: + +* An event loop must run in the main thread. + +* The child watcher must be instantiated in the main thread + before executing subprocesses from other threads. Call the + :func:`get_child_watcher` function in the main thread to instantiate + the child watcher. + +Note that alternative event loop implementations might not share +the above limitations; please refer to their documentation. + +.. seealso:: + + The :ref:`Concurrency and multithreading in asyncio + ` section. + + +Examples +-------- + +An example using the :class:`~asyncio.subprocess.Process` class to +control a subprocess and the :class:`StreamReader` class to read from +its standard output. + +.. _asyncio_example_create_subprocess_exec: + +The subprocess is created by the :func:`create_subprocess_exec` +function:: + + import asyncio + import sys + + async def get_date(): + code = 'import datetime; print(datetime.datetime.now())' + + # Create the subprocess; redirect the standard output + # into a pipe. + proc = await asyncio.create_subprocess_exec( + sys.executable, '-c', code, + stdout=asyncio.subprocess.PIPE) + + # Read one line of output. + data = await proc.stdout.readline() + line = data.decode('ascii').rstrip() + + # Wait for the subprocess exit. + await proc.wait() + return line + + if sys.platform == "win32": + asyncio.set_event_loop_policy( + asyncio.WindowsProactorEventLoopPolicy()) + + date = asyncio.run(get_date()) + print(f"Current date: {date}") + + +See also the :ref:`same example ` +written using low-level APIs. diff --git a/python-3.7.4-docs-html/_sources/library/asyncio-sync.rst.txt b/python-3.7.4-docs-html/_sources/library/asyncio-sync.rst.txt new file mode 100644 index 0000000..993bd13 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/asyncio-sync.rst.txt @@ -0,0 +1,332 @@ +.. currentmodule:: asyncio + +.. _asyncio-sync: + +========================== +Synchronization Primitives +========================== + +asyncio synchronization primitives are designed to be similar to +those of the :mod:`threading` module with two important caveats: + +* asyncio primitives are not thread-safe, therefore they should not + be used for OS thread synchronization (use :mod:`threading` for + that); + +* methods of these synchronization primitives do not accept the *timeout* + argument; use the :func:`asyncio.wait_for` function to perform + operations with timeouts. + +asyncio has the following basic synchronization primitives: + +* :class:`Lock` +* :class:`Event` +* :class:`Condition` +* :class:`Semaphore` +* :class:`BoundedSemaphore` + + +--------- + + +Lock +==== + +.. class:: Lock(\*, loop=None) + + Implements a mutex lock for asyncio tasks. Not thread-safe. + + An asyncio lock can be used to guarantee exclusive access to a + shared resource. + + The preferred way to use a Lock is an :keyword:`async with` + statement:: + + lock = asyncio.Lock() + + # ... later + async with lock: + # access shared state + + which is equivalent to:: + + lock = asyncio.Lock() + + # ... later + await lock.acquire() + try: + # access shared state + finally: + lock.release() + + .. coroutinemethod:: acquire() + + Acquire the lock. + + This method waits until the lock is *unlocked*, sets it to + *locked* and returns ``True``. + + When more than one coroutine is blocked in :meth:`acquire` + waiting for the lock to be unlocked, only one coroutine + eventually proceeds. + + Acquiring a lock is *fair*: the coroutine that proceeds will be + the first coroutine that started waiting on the lock. + + .. method:: release() + + Release the lock. + + When the lock is *locked*, reset it to *unlocked* and return. + + If the lock is *unlocked*, a :exc:`RuntimeError` is raised. + + .. method:: locked() + + Return ``True`` if the lock is *locked*. + + +Event +===== + +.. class:: Event(\*, loop=None) + + An event object. Not thread-safe. + + An asyncio event can be used to notify multiple asyncio tasks + that some event has happened. + + An Event object manages an internal flag that can be set to *true* + with the :meth:`set` method and reset to *false* with the + :meth:`clear` method. The :meth:`wait` method blocks until the + flag is set to *true*. The flag is set to *false* initially. + + .. _asyncio_example_sync_event: + + Example:: + + async def waiter(event): + print('waiting for it ...') + await event.wait() + print('... got it!') + + async def main(): + # Create an Event object. + event = asyncio.Event() + + # Spawn a Task to wait until 'event' is set. + waiter_task = asyncio.create_task(waiter(event)) + + # Sleep for 1 second and set the event. + await asyncio.sleep(1) + event.set() + + # Wait until the waiter task is finished. + await waiter_task + + asyncio.run(main()) + + .. coroutinemethod:: wait() + + Wait until the event is set. + + If the event is set, return ``True`` immediately. + Otherwise block until another task calls :meth:`set`. + + .. method:: set() + + Set the event. + + All tasks waiting for event to be set will be immediately + awakened. + + .. method:: clear() + + Clear (unset) the event. + + Tasks awaiting on :meth:`wait` will now block until the + :meth:`set` method is called again. + + .. method:: is_set() + + Return ``True`` if the event is set. + + +Condition +========= + +.. class:: Condition(lock=None, \*, loop=None) + + A Condition object. Not thread-safe. + + An asyncio condition primitive can be used by a task to wait for + some event to happen and then get exclusive access to a shared + resource. + + In essence, a Condition object combines the functionality + of an :class:`Event` and a :class:`Lock`. It is possible to have + multiple Condition objects share one Lock, which allows coordinating + exclusive access to a shared resource between different tasks + interested in particular states of that shared resource. + + The optional *lock* argument must be a :class:`Lock` object or + ``None``. In the latter case a new Lock object is created + automatically. + + The preferred way to use a Condition is an :keyword:`async with` + statement:: + + cond = asyncio.Condition() + + # ... later + async with cond: + await cond.wait() + + which is equivalent to:: + + cond = asyncio.Condition() + + # ... later + await lock.acquire() + try: + await cond.wait() + finally: + lock.release() + + .. coroutinemethod:: acquire() + + Acquire the underlying lock. + + This method waits until the underlying lock is *unlocked*, + sets it to *locked* and returns ``True``. + + .. method:: notify(n=1) + + Wake up at most *n* tasks (1 by default) waiting on this + condition. The method is no-op if no tasks are waiting. + + The lock must be acquired before this method is called and + released shortly after. If called with an *unlocked* lock + a :exc:`RuntimeError` error is raised. + + .. method:: locked() + + Return ``True`` if the underlying lock is acquired. + + .. method:: notify_all() + + Wake up all tasks waiting on this condition. + + This method acts like :meth:`notify`, but wakes up all waiting + tasks. + + The lock must be acquired before this method is called and + released shortly after. If called with an *unlocked* lock + a :exc:`RuntimeError` error is raised. + + .. method:: release() + + Release the underlying lock. + + When invoked on an unlocked lock, a :exc:`RuntimeError` is + raised. + + .. coroutinemethod:: wait() + + Wait until notified. + + If the calling task has not acquired the lock when this method is + called, a :exc:`RuntimeError` is raised. + + This method releases the underlying lock, and then blocks until + it is awakened by a :meth:`notify` or :meth:`notify_all` call. + Once awakened, the Condition re-acquires its lock and this method + returns ``True``. + + .. coroutinemethod:: wait_for(predicate) + + Wait until a predicate becomes *true*. + + The predicate must be a callable which result will be + interpreted as a boolean value. The final value is the + return value. + + +Semaphore +========= + +.. class:: Semaphore(value=1, \*, loop=None) + + A Semaphore object. Not thread-safe. + + A semaphore manages an internal counter which is decremented by each + :meth:`acquire` call and incremented by each :meth:`release` call. + The counter can never go below zero; when :meth:`acquire` finds + that it is zero, it blocks, waiting until some task calls + :meth:`release`. + + The optional *value* argument gives the initial value for the + internal counter (``1`` by default). If the given value is + less than ``0`` a :exc:`ValueError` is raised. + + The preferred way to use a Semaphore is an :keyword:`async with` + statement:: + + sem = asyncio.Semaphore(10) + + # ... later + async with sem: + # work with shared resource + + which is equivalent to:: + + sem = asyncio.Semaphore(10) + + # ... later + await sem.acquire() + try: + # work with shared resource + finally: + sem.release() + + .. coroutinemethod:: acquire() + + Acquire a semaphore. + + If the internal counter is greater than zero, decrement + it by one and return ``True`` immediately. If it is zero, wait + until a :meth:`release` is called and return ``True``. + + .. method:: locked() + + Returns ``True`` if semaphore can not be acquired immediately. + + .. method:: release() + + Release a semaphore, incrementing the internal counter by one. + Can wake up a task waiting to acquire the semaphore. + + Unlike :class:`BoundedSemaphore`, :class:`Semaphore` allows + making more ``release()`` calls than ``acquire()`` calls. + + +BoundedSemaphore +================ + +.. class:: BoundedSemaphore(value=1, \*, loop=None) + + A bounded semaphore object. Not thread-safe. + + Bounded Semaphore is a version of :class:`Semaphore` that raises + a :exc:`ValueError` in :meth:`~Semaphore.release` if it + increases the internal counter above the initial *value*. + + +--------- + + +.. deprecated:: 3.7 + + Acquiring a lock using ``await lock`` or ``yield from lock`` and/or + :keyword:`with` statement (``with await lock``, ``with (yield from + lock)``) is deprecated. Use ``async with lock`` instead. diff --git a/python-3.7.4-docs-html/_sources/library/asyncio-task.rst.txt b/python-3.7.4-docs-html/_sources/library/asyncio-task.rst.txt new file mode 100644 index 0000000..29ccafe --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/asyncio-task.rst.txt @@ -0,0 +1,908 @@ +.. currentmodule:: asyncio + + +==================== +Coroutines and Tasks +==================== + +This section outlines high-level asyncio APIs to work with coroutines +and Tasks. + +.. contents:: + :depth: 1 + :local: + + +.. _coroutine: + +Coroutines +========== + +Coroutines declared with async/await syntax is the preferred way of +writing asyncio applications. For example, the following snippet +of code (requires Python 3.7+) prints "hello", waits 1 second, +and then prints "world":: + + >>> import asyncio + + >>> async def main(): + ... print('hello') + ... await asyncio.sleep(1) + ... print('world') + + >>> asyncio.run(main()) + hello + world + +Note that simply calling a coroutine will not schedule it to +be executed:: + + >>> main() + + +To actually run a coroutine, asyncio provides three main mechanisms: + +* The :func:`asyncio.run` function to run the top-level + entry point "main()" function (see the above example.) + +* Awaiting on a coroutine. The following snippet of code will + print "hello" after waiting for 1 second, and then print "world" + after waiting for *another* 2 seconds:: + + import asyncio + import time + + async def say_after(delay, what): + await asyncio.sleep(delay) + print(what) + + async def main(): + print(f"started at {time.strftime('%X')}") + + await say_after(1, 'hello') + await say_after(2, 'world') + + print(f"finished at {time.strftime('%X')}") + + asyncio.run(main()) + + Expected output:: + + started at 17:13:52 + hello + world + finished at 17:13:55 + +* The :func:`asyncio.create_task` function to run coroutines + concurrently as asyncio :class:`Tasks `. + + Let's modify the above example and run two ``say_after`` coroutines + *concurrently*:: + + async def main(): + task1 = asyncio.create_task( + say_after(1, 'hello')) + + task2 = asyncio.create_task( + say_after(2, 'world')) + + print(f"started at {time.strftime('%X')}") + + # Wait until both tasks are completed (should take + # around 2 seconds.) + await task1 + await task2 + + print(f"finished at {time.strftime('%X')}") + + Note that expected output now shows that the snippet runs + 1 second faster than before:: + + started at 17:14:32 + hello + world + finished at 17:14:34 + + +.. _asyncio-awaitables: + +Awaitables +========== + +We say that an object is an **awaitable** object if it can be used +in an :keyword:`await` expression. Many asyncio APIs are designed to +accept awaitables. + +There are three main types of *awaitable* objects: +**coroutines**, **Tasks**, and **Futures**. + + +.. rubric:: Coroutines + +Python coroutines are *awaitables* and therefore can be awaited from +other coroutines:: + + import asyncio + + async def nested(): + return 42 + + async def main(): + # Nothing happens if we just call "nested()". + # A coroutine object is created but not awaited, + # so it *won't run at all*. + nested() + + # Let's do it differently now and await it: + print(await nested()) # will print "42". + + asyncio.run(main()) + +.. important:: + + In this documentation the term "coroutine" can be used for + two closely related concepts: + + * a *coroutine function*: an :keyword:`async def` function; + + * a *coroutine object*: an object returned by calling a + *coroutine function*. + +asyncio also supports legacy :ref:`generator-based +` coroutines. + + +.. rubric:: Tasks + +*Tasks* are used to schedule coroutines *concurrently*. + +When a coroutine is wrapped into a *Task* with functions like +:func:`asyncio.create_task` the coroutine is automatically +scheduled to run soon:: + + import asyncio + + async def nested(): + return 42 + + async def main(): + # Schedule nested() to run soon concurrently + # with "main()". + task = asyncio.create_task(nested()) + + # "task" can now be used to cancel "nested()", or + # can simply be awaited to wait until it is complete: + await task + + asyncio.run(main()) + + +.. rubric:: Futures + +A :class:`Future` is a special **low-level** awaitable object that +represents an **eventual result** of an asynchronous operation. + +When a Future object is *awaited* it means that the coroutine will +wait until the Future is resolved in some other place. + +Future objects in asyncio are needed to allow callback-based code +to be used with async/await. + +Normally **there is no need** to create Future objects at the +application level code. + +Future objects, sometimes exposed by libraries and some asyncio +APIs, can be awaited:: + + async def main(): + await function_that_returns_a_future_object() + + # this is also valid: + await asyncio.gather( + function_that_returns_a_future_object(), + some_python_coroutine() + ) + +A good example of a low-level function that returns a Future object +is :meth:`loop.run_in_executor`. + + +Running an asyncio Program +========================== + +.. function:: run(coro, \*, debug=False) + + This function runs the passed coroutine, taking care of + managing the asyncio event loop and *finalizing asynchronous + generators*. + + This function cannot be called when another asyncio event loop is + running in the same thread. + + If *debug* is ``True``, the event loop will be run in debug mode. + + This function always creates a new event loop and closes it at + the end. It should be used as a main entry point for asyncio + programs, and should ideally only be called once. + + .. versionadded:: 3.7 + **Important:** this function has been added to asyncio in + Python 3.7 on a :term:`provisional basis `. + + +Creating Tasks +============== + +.. function:: create_task(coro) + + Wrap the *coro* :ref:`coroutine ` into a :class:`Task` + and schedule its execution. Return the Task object. + + The task is executed in the loop returned by :func:`get_running_loop`, + :exc:`RuntimeError` is raised if there is no running loop in + current thread. + + This function has been **added in Python 3.7**. Prior to + Python 3.7, the low-level :func:`asyncio.ensure_future` function + can be used instead:: + + async def coro(): + ... + + # In Python 3.7+ + task = asyncio.create_task(coro()) + ... + + # This works in all Python versions but is less readable + task = asyncio.ensure_future(coro()) + ... + + .. versionadded:: 3.7 + + +Sleeping +======== + +.. coroutinefunction:: sleep(delay, result=None, \*, loop=None) + + Block for *delay* seconds. + + If *result* is provided, it is returned to the caller + when the coroutine completes. + + ``sleep()`` always suspends the current task, allowing other tasks + to run. + + The *loop* argument is deprecated and scheduled for removal + in Python 3.10. + + .. _asyncio_example_sleep: + + Example of coroutine displaying the current date every second + for 5 seconds:: + + import asyncio + import datetime + + async def display_date(): + loop = asyncio.get_running_loop() + end_time = loop.time() + 5.0 + while True: + print(datetime.datetime.now()) + if (loop.time() + 1.0) >= end_time: + break + await asyncio.sleep(1) + + asyncio.run(display_date()) + + +Running Tasks Concurrently +========================== + +.. awaitablefunction:: gather(\*aws, loop=None, return_exceptions=False) + + Run :ref:`awaitable objects ` in the *aws* + sequence *concurrently*. + + If any awaitable in *aws* is a coroutine, it is automatically + scheduled as a Task. + + If all awaitables are completed successfully, the result is an + aggregate list of returned values. The order of result values + corresponds to the order of awaitables in *aws*. + + If *return_exceptions* is ``False`` (default), the first + raised exception is immediately propagated to the task that + awaits on ``gather()``. Other awaitables in the *aws* sequence + **won't be cancelled** and will continue to run. + + If *return_exceptions* is ``True``, exceptions are treated the + same as successful results, and aggregated in the result list. + + If ``gather()`` is *cancelled*, all submitted awaitables + (that have not completed yet) are also *cancelled*. + + If any Task or Future from the *aws* sequence is *cancelled*, it is + treated as if it raised :exc:`CancelledError` -- the ``gather()`` + call is **not** cancelled in this case. This is to prevent the + cancellation of one submitted Task/Future to cause other + Tasks/Futures to be cancelled. + + .. _asyncio_example_gather: + + Example:: + + import asyncio + + async def factorial(name, number): + f = 1 + for i in range(2, number + 1): + print(f"Task {name}: Compute factorial({i})...") + await asyncio.sleep(1) + f *= i + print(f"Task {name}: factorial({number}) = {f}") + + async def main(): + # Schedule three calls *concurrently*: + await asyncio.gather( + factorial("A", 2), + factorial("B", 3), + factorial("C", 4), + ) + + asyncio.run(main()) + + # Expected output: + # + # Task A: Compute factorial(2)... + # Task B: Compute factorial(2)... + # Task C: Compute factorial(2)... + # Task A: factorial(2) = 2 + # Task B: Compute factorial(3)... + # Task C: Compute factorial(3)... + # Task B: factorial(3) = 6 + # Task C: Compute factorial(4)... + # Task C: factorial(4) = 24 + + .. versionchanged:: 3.7 + If the *gather* itself is cancelled, the cancellation is + propagated regardless of *return_exceptions*. + + +Shielding From Cancellation +=========================== + +.. awaitablefunction:: shield(aw, \*, loop=None) + + Protect an :ref:`awaitable object ` + from being :meth:`cancelled `. + + If *aw* is a coroutine it is automatically scheduled as a Task. + + The statement:: + + res = await shield(something()) + + is equivalent to:: + + res = await something() + + *except* that if the coroutine containing it is cancelled, the + Task running in ``something()`` is not cancelled. From the point + of view of ``something()``, the cancellation did not happen. + Although its caller is still cancelled, so the "await" expression + still raises a :exc:`CancelledError`. + + If ``something()`` is cancelled by other means (i.e. from within + itself) that would also cancel ``shield()``. + + If it is desired to completely ignore cancellation (not recommended) + the ``shield()`` function should be combined with a try/except + clause, as follows:: + + try: + res = await shield(something()) + except CancelledError: + res = None + + +Timeouts +======== + +.. coroutinefunction:: wait_for(aw, timeout, \*, loop=None) + + Wait for the *aw* :ref:`awaitable ` + to complete with a timeout. + + If *aw* is a coroutine it is automatically scheduled as a Task. + + *timeout* can either be ``None`` or a float or int number of seconds + to wait for. If *timeout* is ``None``, block until the future + completes. + + If a timeout occurs, it cancels the task and raises + :exc:`asyncio.TimeoutError`. + + To avoid the task :meth:`cancellation `, + wrap it in :func:`shield`. + + The function will wait until the future is actually cancelled, + so the total wait time may exceed the *timeout*. + + If the wait is cancelled, the future *aw* is also cancelled. + + The *loop* argument is deprecated and scheduled for removal + in Python 3.10. + + .. _asyncio_example_waitfor: + + Example:: + + async def eternity(): + # Sleep for one hour + await asyncio.sleep(3600) + print('yay!') + + async def main(): + # Wait for at most 1 second + try: + await asyncio.wait_for(eternity(), timeout=1.0) + except asyncio.TimeoutError: + print('timeout!') + + asyncio.run(main()) + + # Expected output: + # + # timeout! + + .. versionchanged:: 3.7 + When *aw* is cancelled due to a timeout, ``wait_for`` waits + for *aw* to be cancelled. Previously, it raised + :exc:`asyncio.TimeoutError` immediately. + + +Waiting Primitives +================== + +.. coroutinefunction:: wait(aws, \*, loop=None, timeout=None,\ + return_when=ALL_COMPLETED) + + Run :ref:`awaitable objects ` in the *aws* + set concurrently and block until the condition specified + by *return_when*. + + If any awaitable in *aws* is a coroutine, it is automatically + scheduled as a Task. Passing coroutines objects to + ``wait()`` directly is deprecated as it leads to + :ref:`confusing behavior `. + + Returns two sets of Tasks/Futures: ``(done, pending)``. + + Usage:: + + done, pending = await asyncio.wait(aws) + + The *loop* argument is deprecated and scheduled for removal + in Python 3.10. + + *timeout* (a float or int), if specified, can be used to control + the maximum number of seconds to wait before returning. + + Note that this function does not raise :exc:`asyncio.TimeoutError`. + Futures or Tasks that aren't done when the timeout occurs are simply + returned in the second set. + + *return_when* indicates when this function should return. It must + be one of the following constants: + + .. tabularcolumns:: |l|L| + + +-----------------------------+----------------------------------------+ + | Constant | Description | + +=============================+========================================+ + | :const:`FIRST_COMPLETED` | The function will return when any | + | | future finishes or is cancelled. | + +-----------------------------+----------------------------------------+ + | :const:`FIRST_EXCEPTION` | The function will return when any | + | | future finishes by raising an | + | | exception. If no future raises an | + | | exception then it is equivalent to | + | | :const:`ALL_COMPLETED`. | + +-----------------------------+----------------------------------------+ + | :const:`ALL_COMPLETED` | The function will return when all | + | | futures finish or are cancelled. | + +-----------------------------+----------------------------------------+ + + Unlike :func:`~asyncio.wait_for`, ``wait()`` does not cancel the + futures when a timeout occurs. + + .. _asyncio_example_wait_coroutine: + .. note:: + + ``wait()`` schedules coroutines as Tasks automatically and later + returns those implicitly created Task objects in ``(done, pending)`` + sets. Therefore the following code won't work as expected:: + + async def foo(): + return 42 + + coro = foo() + done, pending = await asyncio.wait({coro}) + + if coro in done: + # This branch will never be run! + + Here is how the above snippet can be fixed:: + + async def foo(): + return 42 + + task = asyncio.create_task(foo()) + done, pending = await asyncio.wait({task}) + + if task in done: + # Everything will work as expected now. + + Passing coroutine objects to ``wait()`` directly is + deprecated. + + +.. function:: as_completed(aws, \*, loop=None, timeout=None) + + Run :ref:`awaitable objects ` in the *aws* + set concurrently. Return an iterator of :class:`Future` objects. + Each Future object returned represents the earliest result + from the set of the remaining awaitables. + + Raises :exc:`asyncio.TimeoutError` if the timeout occurs before + all Futures are done. + + Example:: + + for f in as_completed(aws): + earliest_result = await f + # ... + + +Scheduling From Other Threads +============================= + +.. function:: run_coroutine_threadsafe(coro, loop) + + Submit a coroutine to the given event loop. Thread-safe. + + Return a :class:`concurrent.futures.Future` to wait for the result + from another OS thread. + + This function is meant to be called from a different OS thread + than the one where the event loop is running. Example:: + + # Create a coroutine + coro = asyncio.sleep(1, result=3) + + # Submit the coroutine to a given loop + future = asyncio.run_coroutine_threadsafe(coro, loop) + + # Wait for the result with an optional timeout argument + assert future.result(timeout) == 3 + + If an exception is raised in the coroutine, the returned Future + will be notified. It can also be used to cancel the task in + the event loop:: + + try: + result = future.result(timeout) + except asyncio.TimeoutError: + print('The coroutine took too long, cancelling the task...') + future.cancel() + except Exception as exc: + print(f'The coroutine raised an exception: {exc!r}') + else: + print(f'The coroutine returned: {result!r}') + + See the :ref:`concurrency and multithreading ` + section of the documentation. + + Unlike other asyncio functions this function requires the *loop* + argument to be passed explicitly. + + .. versionadded:: 3.5.1 + + +Introspection +============= + + +.. function:: current_task(loop=None) + + Return the currently running :class:`Task` instance, or ``None`` if + no task is running. + + If *loop* is ``None`` :func:`get_running_loop` is used to get + the current loop. + + .. versionadded:: 3.7 + + +.. function:: all_tasks(loop=None) + + Return a set of not yet finished :class:`Task` objects run by + the loop. + + If *loop* is ``None``, :func:`get_running_loop` is used for getting + current loop. + + .. versionadded:: 3.7 + + +Task Object +=========== + +.. class:: Task(coro, \*, loop=None) + + A :class:`Future-like ` object that runs a Python + :ref:`coroutine `. Not thread-safe. + + Tasks are used to run coroutines in event loops. + If a coroutine awaits on a Future, the Task suspends + the execution of the coroutine and waits for the completion + of the Future. When the Future is *done*, the execution of + the wrapped coroutine resumes. + + Event loops use cooperative scheduling: an event loop runs + one Task at a time. While a Task awaits for the completion of a + Future, the event loop runs other Tasks, callbacks, or performs + IO operations. + + Use the high-level :func:`asyncio.create_task` function to create + Tasks, or the low-level :meth:`loop.create_task` or + :func:`ensure_future` functions. Manual instantiation of Tasks + is discouraged. + + To cancel a running Task use the :meth:`cancel` method. Calling it + will cause the Task to throw a :exc:`CancelledError` exception into + the wrapped coroutine. If a coroutine is awaiting on a Future + object during cancellation, the Future object will be cancelled. + + :meth:`cancelled` can be used to check if the Task was cancelled. + The method returns ``True`` if the wrapped coroutine did not + suppress the :exc:`CancelledError` exception and was actually + cancelled. + + :class:`asyncio.Task` inherits from :class:`Future` all of its + APIs except :meth:`Future.set_result` and + :meth:`Future.set_exception`. + + Tasks support the :mod:`contextvars` module. When a Task + is created it copies the current context and later runs its + coroutine in the copied context. + + .. versionchanged:: 3.7 + Added support for the :mod:`contextvars` module. + + .. method:: cancel() + + Request the Task to be cancelled. + + This arranges for a :exc:`CancelledError` exception to be thrown + into the wrapped coroutine on the next cycle of the event loop. + + The coroutine then has a chance to clean up or even deny the + request by suppressing the exception with a :keyword:`try` ... + ... ``except CancelledError`` ... :keyword:`finally` block. + Therefore, unlike :meth:`Future.cancel`, :meth:`Task.cancel` does + not guarantee that the Task will be cancelled, although + suppressing cancellation completely is not common and is actively + discouraged. + + .. _asyncio_example_task_cancel: + + The following example illustrates how coroutines can intercept + the cancellation request:: + + async def cancel_me(): + print('cancel_me(): before sleep') + + try: + # Wait for 1 hour + await asyncio.sleep(3600) + except asyncio.CancelledError: + print('cancel_me(): cancel sleep') + raise + finally: + print('cancel_me(): after sleep') + + async def main(): + # Create a "cancel_me" Task + task = asyncio.create_task(cancel_me()) + + # Wait for 1 second + await asyncio.sleep(1) + + task.cancel() + try: + await task + except asyncio.CancelledError: + print("main(): cancel_me is cancelled now") + + asyncio.run(main()) + + # Expected output: + # + # cancel_me(): before sleep + # cancel_me(): cancel sleep + # cancel_me(): after sleep + # main(): cancel_me is cancelled now + + .. method:: cancelled() + + Return ``True`` if the Task is *cancelled*. + + The Task is *cancelled* when the cancellation was requested with + :meth:`cancel` and the wrapped coroutine propagated the + :exc:`CancelledError` exception thrown into it. + + .. method:: done() + + Return ``True`` if the Task is *done*. + + A Task is *done* when the wrapped coroutine either returned + a value, raised an exception, or the Task was cancelled. + + .. method:: result() + + Return the result of the Task. + + If the Task is *done*, the result of the wrapped coroutine + is returned (or if the coroutine raised an exception, that + exception is re-raised.) + + If the Task has been *cancelled*, this method raises + a :exc:`CancelledError` exception. + + If the Task's result isn't yet available, this method raises + a :exc:`InvalidStateError` exception. + + .. method:: exception() + + Return the exception of the Task. + + If the wrapped coroutine raised an exception that exception + is returned. If the wrapped coroutine returned normally + this method returns ``None``. + + If the Task has been *cancelled*, this method raises a + :exc:`CancelledError` exception. + + If the Task isn't *done* yet, this method raises an + :exc:`InvalidStateError` exception. + + .. method:: add_done_callback(callback, *, context=None) + + Add a callback to be run when the Task is *done*. + + This method should only be used in low-level callback-based code. + + See the documentation of :meth:`Future.add_done_callback` + for more details. + + .. method:: remove_done_callback(callback) + + Remove *callback* from the callbacks list. + + This method should only be used in low-level callback-based code. + + See the documentation of :meth:`Future.remove_done_callback` + for more details. + + .. method:: get_stack(\*, limit=None) + + Return the list of stack frames for this Task. + + If the wrapped coroutine is not done, this returns the stack + where it is suspended. If the coroutine has completed + successfully or was cancelled, this returns an empty list. + If the coroutine was terminated by an exception, this returns + the list of traceback frames. + + The frames are always ordered from oldest to newest. + + Only one stack frame is returned for a suspended coroutine. + + The optional *limit* argument sets the maximum number of frames + to return; by default all available frames are returned. + The ordering of the returned list differs depending on whether + a stack or a traceback is returned: the newest frames of a + stack are returned, but the oldest frames of a traceback are + returned. (This matches the behavior of the traceback module.) + + .. method:: print_stack(\*, limit=None, file=None) + + Print the stack or traceback for this Task. + + This produces output similar to that of the traceback module + for the frames retrieved by :meth:`get_stack`. + + The *limit* argument is passed to :meth:`get_stack` directly. + + The *file* argument is an I/O stream to which the output + is written; by default output is written to :data:`sys.stderr`. + + .. classmethod:: all_tasks(loop=None) + + Return a set of all tasks for an event loop. + + By default all tasks for the current event loop are returned. + If *loop* is ``None``, the :func:`get_event_loop` function + is used to get the current loop. + + This method is **deprecated** and will be removed in + Python 3.9. Use the :func:`asyncio.all_tasks` function instead. + + .. classmethod:: current_task(loop=None) + + Return the currently running task or ``None``. + + If *loop* is ``None``, the :func:`get_event_loop` function + is used to get the current loop. + + This method is **deprecated** and will be removed in + Python 3.9. Use the :func:`asyncio.current_task` function + instead. + + +.. _asyncio_generator_based_coro: + +Generator-based Coroutines +========================== + +.. note:: + + Support for generator-based coroutines is **deprecated** and + is scheduled for removal in Python 3.10. + +Generator-based coroutines predate async/await syntax. They are +Python generators that use ``yield from`` expressions to await +on Futures and other coroutines. + +Generator-based coroutines should be decorated with +:func:`@asyncio.coroutine `, although this is not +enforced. + + +.. decorator:: coroutine + + Decorator to mark generator-based coroutines. + + This decorator enables legacy generator-based coroutines to be + compatible with async/await code:: + + @asyncio.coroutine + def old_style_coroutine(): + yield from asyncio.sleep(1) + + async def main(): + await old_style_coroutine() + + This decorator is **deprecated** and is scheduled for removal in + Python 3.10. + + This decorator should not be used for :keyword:`async def` + coroutines. + +.. function:: iscoroutine(obj) + + Return ``True`` if *obj* is a :ref:`coroutine object `. + + This method is different from :func:`inspect.iscoroutine` because + it returns ``True`` for generator-based coroutines. + +.. function:: iscoroutinefunction(func) + + Return ``True`` if *func* is a :ref:`coroutine function + `. + + This method is different from :func:`inspect.iscoroutinefunction` + because it returns ``True`` for generator-based coroutine functions + decorated with :func:`@coroutine `. diff --git a/python-3.7.4-docs-html/_sources/library/asyncio.rst.txt b/python-3.7.4-docs-html/_sources/library/asyncio.rst.txt new file mode 100644 index 0000000..6990adb --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/asyncio.rst.txt @@ -0,0 +1,93 @@ +:mod:`asyncio` --- Asynchronous I/O +=================================== + +.. module:: asyncio + :synopsis: Asynchronous I/O. + +-------------- + +.. sidebar:: Hello World! + + :: + + import asyncio + + async def main(): + print('Hello ...') + await asyncio.sleep(1) + print('... World!') + + # Python 3.7+ + asyncio.run(main()) + +asyncio is a library to write **concurrent** code using +the **async/await** syntax. + +asyncio is used as a foundation for multiple Python asynchronous +frameworks that provide high-performance network and web-servers, +database connection libraries, distributed task queues, etc. + +asyncio is often a perfect fit for IO-bound and high-level +**structured** network code. + +asyncio provides a set of **high-level** APIs to: + +* :ref:`run Python coroutines ` concurrently and + have full control over their execution; + +* perform :ref:`network IO and IPC `; + +* control :ref:`subprocesses `; + +* distribute tasks via :ref:`queues `; + +* :ref:`synchronize ` concurrent code; + +Additionally, there are **low-level** APIs for +*library and framework developers* to: + +* create and manage :ref:`event loops `, which + provide asynchronous APIs for :meth:`networking `, + running :meth:`subprocesses `, + handling :meth:`OS signals `, etc; + +* implement efficient protocols using + :ref:`transports `; + +* :ref:`bridge ` callback-based libraries and code + with async/await syntax. + + +.. We use the "rubric" directive here to avoid creating + the "Reference" subsection in the TOC. + +.. rubric:: Reference + +.. toctree:: + :caption: High-level APIs + :maxdepth: 1 + + asyncio-task.rst + asyncio-stream.rst + asyncio-sync.rst + asyncio-subprocess.rst + asyncio-queue.rst + asyncio-exceptions.rst + +.. toctree:: + :caption: Low-level APIs + :maxdepth: 1 + + asyncio-eventloop.rst + asyncio-future.rst + asyncio-protocol.rst + asyncio-policy.rst + asyncio-platforms.rst + +.. toctree:: + :caption: Guides and Tutorials + :maxdepth: 1 + + asyncio-api-index.rst + asyncio-llapi-index.rst + asyncio-dev.rst diff --git a/python-3.7.4-docs-html/_sources/library/asyncore.rst.txt b/python-3.7.4-docs-html/_sources/library/asyncore.rst.txt new file mode 100644 index 0000000..a86518e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/asyncore.rst.txt @@ -0,0 +1,360 @@ +:mod:`asyncore` --- Asynchronous socket handler +=============================================== + +.. module:: asyncore + :synopsis: A base class for developing asynchronous socket handling + services. + +.. moduleauthor:: Sam Rushing +.. sectionauthor:: Christopher Petrilli +.. sectionauthor:: Steve Holden +.. heavily adapted from original documentation by Sam Rushing + +**Source code:** :source:`Lib/asyncore.py` + +.. deprecated:: 3.6 + Please use :mod:`asyncio` instead. + +-------------- + +.. note:: + + This module exists for backwards compatibility only. For new code we + recommend using :mod:`asyncio`. + +This module provides the basic infrastructure for writing asynchronous socket +service clients and servers. + +There are only two ways to have a program on a single processor do "more than +one thing at a time." Multi-threaded programming is the simplest and most +popular way to do it, but there is another very different technique, that lets +you have nearly all the advantages of multi-threading, without actually using +multiple threads. It's really only practical if your program is largely I/O +bound. If your program is processor bound, then pre-emptive scheduled threads +are probably what you really need. Network servers are rarely processor +bound, however. + +If your operating system supports the :c:func:`select` system call in its I/O +library (and nearly all do), then you can use it to juggle multiple +communication channels at once; doing other work while your I/O is taking +place in the "background." Although this strategy can seem strange and +complex, especially at first, it is in many ways easier to understand and +control than multi-threaded programming. The :mod:`asyncore` module solves +many of the difficult problems for you, making the task of building +sophisticated high-performance network servers and clients a snap. For +"conversational" applications and protocols the companion :mod:`asynchat` +module is invaluable. + +The basic idea behind both modules is to create one or more network +*channels*, instances of class :class:`asyncore.dispatcher` and +:class:`asynchat.async_chat`. Creating the channels adds them to a global +map, used by the :func:`loop` function if you do not provide it with your own +*map*. + +Once the initial channel(s) is(are) created, calling the :func:`loop` function +activates channel service, which continues until the last channel (including +any that have been added to the map during asynchronous service) is closed. + + +.. function:: loop([timeout[, use_poll[, map[,count]]]]) + + Enter a polling loop that terminates after count passes or all open + channels have been closed. All arguments are optional. The *count* + parameter defaults to ``None``, resulting in the loop terminating only when all + channels have been closed. The *timeout* argument sets the timeout + parameter for the appropriate :func:`~select.select` or :func:`~select.poll` + call, measured in seconds; the default is 30 seconds. The *use_poll* + parameter, if true, indicates that :func:`~select.poll` should be used in + preference to :func:`~select.select` (the default is ``False``). + + The *map* parameter is a dictionary whose items are the channels to watch. + As channels are closed they are deleted from their map. If *map* is + omitted, a global map is used. Channels (instances of + :class:`asyncore.dispatcher`, :class:`asynchat.async_chat` and subclasses + thereof) can freely be mixed in the map. + + +.. class:: dispatcher() + + The :class:`dispatcher` class is a thin wrapper around a low-level socket + object. To make it more useful, it has a few methods for event-handling + which are called from the asynchronous loop. Otherwise, it can be treated + as a normal non-blocking socket object. + + The firing of low-level events at certain times or in certain connection + states tells the asynchronous loop that certain higher-level events have + taken place. For example, if we have asked for a socket to connect to + another host, we know that the connection has been made when the socket + becomes writable for the first time (at this point you know that you may + write to it with the expectation of success). The implied higher-level + events are: + + +----------------------+----------------------------------------+ + | Event | Description | + +======================+========================================+ + | ``handle_connect()`` | Implied by the first read or write | + | | event | + +----------------------+----------------------------------------+ + | ``handle_close()`` | Implied by a read event with no data | + | | available | + +----------------------+----------------------------------------+ + | ``handle_accepted()``| Implied by a read event on a listening | + | | socket | + +----------------------+----------------------------------------+ + + During asynchronous processing, each mapped channel's :meth:`readable` and + :meth:`writable` methods are used to determine whether the channel's socket + should be added to the list of channels :c:func:`select`\ ed or + :c:func:`poll`\ ed for read and write events. + + Thus, the set of channel events is larger than the basic socket events. The + full set of methods that can be overridden in your subclass follows: + + + .. method:: handle_read() + + Called when the asynchronous loop detects that a :meth:`read` call on the + channel's socket will succeed. + + + .. method:: handle_write() + + Called when the asynchronous loop detects that a writable socket can be + written. Often this method will implement the necessary buffering for + performance. For example:: + + def handle_write(self): + sent = self.send(self.buffer) + self.buffer = self.buffer[sent:] + + + .. method:: handle_expt() + + Called when there is out of band (OOB) data for a socket connection. This + will almost never happen, as OOB is tenuously supported and rarely used. + + + .. method:: handle_connect() + + Called when the active opener's socket actually makes a connection. Might + send a "welcome" banner, or initiate a protocol negotiation with the + remote endpoint, for example. + + + .. method:: handle_close() + + Called when the socket is closed. + + + .. method:: handle_error() + + Called when an exception is raised and not otherwise handled. The default + version prints a condensed traceback. + + + .. method:: handle_accept() + + Called on listening channels (passive openers) when a connection can be + established with a new remote endpoint that has issued a :meth:`connect` + call for the local endpoint. Deprecated in version 3.2; use + :meth:`handle_accepted` instead. + + .. deprecated:: 3.2 + + + .. method:: handle_accepted(sock, addr) + + Called on listening channels (passive openers) when a connection has been + established with a new remote endpoint that has issued a :meth:`connect` + call for the local endpoint. *sock* is a *new* socket object usable to + send and receive data on the connection, and *addr* is the address + bound to the socket on the other end of the connection. + + .. versionadded:: 3.2 + + + .. method:: readable() + + Called each time around the asynchronous loop to determine whether a + channel's socket should be added to the list on which read events can + occur. The default method simply returns ``True``, indicating that by + default, all channels will be interested in read events. + + + .. method:: writable() + + Called each time around the asynchronous loop to determine whether a + channel's socket should be added to the list on which write events can + occur. The default method simply returns ``True``, indicating that by + default, all channels will be interested in write events. + + + In addition, each channel delegates or extends many of the socket methods. + Most of these are nearly identical to their socket partners. + + + .. method:: create_socket(family=socket.AF_INET, type=socket.SOCK_STREAM) + + This is identical to the creation of a normal socket, and will use the + same options for creation. Refer to the :mod:`socket` documentation for + information on creating sockets. + + .. versionchanged:: 3.3 + *family* and *type* arguments can be omitted. + + + .. method:: connect(address) + + As with the normal socket object, *address* is a tuple with the first + element the host to connect to, and the second the port number. + + + .. method:: send(data) + + Send *data* to the remote end-point of the socket. + + + .. method:: recv(buffer_size) + + Read at most *buffer_size* bytes from the socket's remote end-point. An + empty bytes object implies that the channel has been closed from the + other end. + + Note that :meth:`recv` may raise :exc:`BlockingIOError` , even though + :func:`select.select` or :func:`select.poll` has reported the socket + ready for reading. + + + .. method:: listen(backlog) + + Listen for connections made to the socket. The *backlog* argument + specifies the maximum number of queued connections and should be at least + 1; the maximum value is system-dependent (usually 5). + + + .. method:: bind(address) + + Bind the socket to *address*. The socket must not already be bound. (The + format of *address* depends on the address family --- refer to the + :mod:`socket` documentation for more information.) To mark + the socket as re-usable (setting the :const:`SO_REUSEADDR` option), call + the :class:`dispatcher` object's :meth:`set_reuse_addr` method. + + + .. method:: accept() + + Accept a connection. The socket must be bound to an address and listening + for connections. The return value can be either ``None`` or a pair + ``(conn, address)`` where *conn* is a *new* socket object usable to send + and receive data on the connection, and *address* is the address bound to + the socket on the other end of the connection. + When ``None`` is returned it means the connection didn't take place, in + which case the server should just ignore this event and keep listening + for further incoming connections. + + + .. method:: close() + + Close the socket. All future operations on the socket object will fail. + The remote end-point will receive no more data (after queued data is + flushed). Sockets are automatically closed when they are + garbage-collected. + + +.. class:: dispatcher_with_send() + + A :class:`dispatcher` subclass which adds simple buffered output capability, + useful for simple clients. For more sophisticated usage use + :class:`asynchat.async_chat`. + +.. class:: file_dispatcher() + + A file_dispatcher takes a file descriptor or :term:`file object` along + with an optional map argument and wraps it for use with the :c:func:`poll` + or :c:func:`loop` functions. If provided a file object or anything with a + :c:func:`fileno` method, that method will be called and passed to the + :class:`file_wrapper` constructor. + + .. availability:: Unix. + +.. class:: file_wrapper() + + A file_wrapper takes an integer file descriptor and calls :func:`os.dup` to + duplicate the handle so that the original handle may be closed independently + of the file_wrapper. This class implements sufficient methods to emulate a + socket for use by the :class:`file_dispatcher` class. + + .. availability:: Unix. + + +.. _asyncore-example-1: + +asyncore Example basic HTTP client +---------------------------------- + +Here is a very basic HTTP client that uses the :class:`dispatcher` class to +implement its socket handling:: + + import asyncore + + class HTTPClient(asyncore.dispatcher): + + def __init__(self, host, path): + asyncore.dispatcher.__init__(self) + self.create_socket() + self.connect( (host, 80) ) + self.buffer = bytes('GET %s HTTP/1.0\r\nHost: %s\r\n\r\n' % + (path, host), 'ascii') + + def handle_connect(self): + pass + + def handle_close(self): + self.close() + + def handle_read(self): + print(self.recv(8192)) + + def writable(self): + return (len(self.buffer) > 0) + + def handle_write(self): + sent = self.send(self.buffer) + self.buffer = self.buffer[sent:] + + + client = HTTPClient('www.python.org', '/') + asyncore.loop() + +.. _asyncore-example-2: + +asyncore Example basic echo server +---------------------------------- + +Here is a basic echo server that uses the :class:`dispatcher` class to accept +connections and dispatches the incoming connections to a handler:: + + import asyncore + + class EchoHandler(asyncore.dispatcher_with_send): + + def handle_read(self): + data = self.recv(8192) + if data: + self.send(data) + + class EchoServer(asyncore.dispatcher): + + def __init__(self, host, port): + asyncore.dispatcher.__init__(self) + self.create_socket() + self.set_reuse_addr() + self.bind((host, port)) + self.listen(5) + + def handle_accepted(self, sock, addr): + print('Incoming connection from %s' % repr(addr)) + handler = EchoHandler(sock) + + server = EchoServer('localhost', 8080) + asyncore.loop() diff --git a/python-3.7.4-docs-html/_sources/library/atexit.rst.txt b/python-3.7.4-docs-html/_sources/library/atexit.rst.txt new file mode 100644 index 0000000..c2c058e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/atexit.rst.txt @@ -0,0 +1,112 @@ +:mod:`atexit` --- Exit handlers +=============================== + +.. module:: atexit + :synopsis: Register and execute cleanup functions. + +.. moduleauthor:: Skip Montanaro +.. sectionauthor:: Skip Montanaro + +-------------- + +The :mod:`atexit` module defines functions to register and unregister cleanup +functions. Functions thus registered are automatically executed upon normal +interpreter termination. :mod:`atexit` runs these functions in the *reverse* +order in which they were registered; if you register ``A``, ``B``, and ``C``, +at interpreter termination time they will be run in the order ``C``, ``B``, +``A``. + +**Note:** The functions registered via this module are not called when the +program is killed by a signal not handled by Python, when a Python fatal +internal error is detected, or when :func:`os._exit` is called. + +.. versionchanged:: 3.7 + When used with C-API subinterpreters, registered functions + are local to the interpreter they were registered in. + +.. function:: register(func, *args, **kwargs) + + Register *func* as a function to be executed at termination. Any optional + arguments that are to be passed to *func* must be passed as arguments to + :func:`register`. It is possible to register the same function and arguments + more than once. + + At normal program termination (for instance, if :func:`sys.exit` is called or + the main module's execution completes), all functions registered are called in + last in, first out order. The assumption is that lower level modules will + normally be imported before higher level modules and thus must be cleaned up + later. + + If an exception is raised during execution of the exit handlers, a traceback is + printed (unless :exc:`SystemExit` is raised) and the exception information is + saved. After all exit handlers have had a chance to run the last exception to + be raised is re-raised. + + This function returns *func*, which makes it possible to use it as a + decorator. + + +.. function:: unregister(func) + + Remove *func* from the list of functions to be run at interpreter + shutdown. After calling :func:`unregister`, *func* is guaranteed not to be + called when the interpreter shuts down, even if it was registered more than + once. :func:`unregister` silently does nothing if *func* was not previously + registered. + + +.. seealso:: + + Module :mod:`readline` + Useful example of :mod:`atexit` to read and write :mod:`readline` history + files. + + +.. _atexit-example: + +:mod:`atexit` Example +--------------------- + +The following simple example demonstrates how a module can initialize a counter +from a file when it is imported and save the counter's updated value +automatically when the program terminates without relying on the application +making an explicit call into this module at termination. :: + + try: + with open("counterfile") as infile: + _count = int(infile.read()) + except FileNotFoundError: + _count = 0 + + def incrcounter(n): + global _count + _count = _count + n + + def savecounter(): + with open("counterfile", "w") as outfile: + outfile.write("%d" % _count) + + import atexit + atexit.register(savecounter) + +Positional and keyword arguments may also be passed to :func:`register` to be +passed along to the registered function when it is called:: + + def goodbye(name, adjective): + print('Goodbye, %s, it was %s to meet you.' % (name, adjective)) + + import atexit + atexit.register(goodbye, 'Donny', 'nice') + + # or: + atexit.register(goodbye, adjective='nice', name='Donny') + +Usage as a :term:`decorator`:: + + import atexit + + @atexit.register + def goodbye(): + print("You are now leaving the Python sector.") + +This only works with functions that can be called without arguments. diff --git a/python-3.7.4-docs-html/_sources/library/audioop.rst.txt b/python-3.7.4-docs-html/_sources/library/audioop.rst.txt new file mode 100644 index 0000000..bad9da2 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/audioop.rst.txt @@ -0,0 +1,282 @@ +:mod:`audioop` --- Manipulate raw audio data +============================================ + +.. module:: audioop + :synopsis: Manipulate raw audio data. + +-------------- + +The :mod:`audioop` module contains some useful operations on sound fragments. +It operates on sound fragments consisting of signed integer samples 8, 16, 24 +or 32 bits wide, stored in :term:`bytes-like objects `. All scalar items are +integers, unless specified otherwise. + +.. versionchanged:: 3.4 + Support for 24-bit samples was added. + All functions now accept any :term:`bytes-like object`. + String input now results in an immediate error. + +.. index:: + single: Intel/DVI ADPCM + single: ADPCM, Intel/DVI + single: a-LAW + single: u-LAW + +This module provides support for a-LAW, u-LAW and Intel/DVI ADPCM encodings. + +.. This para is mostly here to provide an excuse for the index entries... + +A few of the more complicated operations only take 16-bit samples, otherwise the +sample size (in bytes) is always a parameter of the operation. + +The module defines the following variables and functions: + + +.. exception:: error + + This exception is raised on all errors, such as unknown number of bytes per + sample, etc. + + +.. function:: add(fragment1, fragment2, width) + + Return a fragment which is the addition of the two samples passed as parameters. + *width* is the sample width in bytes, either ``1``, ``2``, ``3`` or ``4``. Both + fragments should have the same length. Samples are truncated in case of overflow. + + +.. function:: adpcm2lin(adpcmfragment, width, state) + + Decode an Intel/DVI ADPCM coded fragment to a linear fragment. See the + description of :func:`lin2adpcm` for details on ADPCM coding. Return a tuple + ``(sample, newstate)`` where the sample has the width specified in *width*. + + +.. function:: alaw2lin(fragment, width) + + Convert sound fragments in a-LAW encoding to linearly encoded sound fragments. + a-LAW encoding always uses 8 bits samples, so *width* refers only to the sample + width of the output fragment here. + + +.. function:: avg(fragment, width) + + Return the average over all samples in the fragment. + + +.. function:: avgpp(fragment, width) + + Return the average peak-peak value over all samples in the fragment. No + filtering is done, so the usefulness of this routine is questionable. + + +.. function:: bias(fragment, width, bias) + + Return a fragment that is the original fragment with a bias added to each + sample. Samples wrap around in case of overflow. + + +.. function:: byteswap(fragment, width) + + "Byteswap" all samples in a fragment and returns the modified fragment. + Converts big-endian samples to little-endian and vice versa. + + .. versionadded:: 3.4 + + +.. function:: cross(fragment, width) + + Return the number of zero crossings in the fragment passed as an argument. + + +.. function:: findfactor(fragment, reference) + + Return a factor *F* such that ``rms(add(fragment, mul(reference, -F)))`` is + minimal, i.e., return the factor with which you should multiply *reference* to + make it match as well as possible to *fragment*. The fragments should both + contain 2-byte samples. + + The time taken by this routine is proportional to ``len(fragment)``. + + +.. function:: findfit(fragment, reference) + + Try to match *reference* as well as possible to a portion of *fragment* (which + should be the longer fragment). This is (conceptually) done by taking slices + out of *fragment*, using :func:`findfactor` to compute the best match, and + minimizing the result. The fragments should both contain 2-byte samples. + Return a tuple ``(offset, factor)`` where *offset* is the (integer) offset into + *fragment* where the optimal match started and *factor* is the (floating-point) + factor as per :func:`findfactor`. + + +.. function:: findmax(fragment, length) + + Search *fragment* for a slice of length *length* samples (not bytes!) with + maximum energy, i.e., return *i* for which ``rms(fragment[i*2:(i+length)*2])`` + is maximal. The fragments should both contain 2-byte samples. + + The routine takes time proportional to ``len(fragment)``. + + +.. function:: getsample(fragment, width, index) + + Return the value of sample *index* from the fragment. + + +.. function:: lin2adpcm(fragment, width, state) + + Convert samples to 4 bit Intel/DVI ADPCM encoding. ADPCM coding is an adaptive + coding scheme, whereby each 4 bit number is the difference between one sample + and the next, divided by a (varying) step. The Intel/DVI ADPCM algorithm has + been selected for use by the IMA, so it may well become a standard. + + *state* is a tuple containing the state of the coder. The coder returns a tuple + ``(adpcmfrag, newstate)``, and the *newstate* should be passed to the next call + of :func:`lin2adpcm`. In the initial call, ``None`` can be passed as the state. + *adpcmfrag* is the ADPCM coded fragment packed 2 4-bit values per byte. + + +.. function:: lin2alaw(fragment, width) + + Convert samples in the audio fragment to a-LAW encoding and return this as a + bytes object. a-LAW is an audio encoding format whereby you get a dynamic + range of about 13 bits using only 8 bit samples. It is used by the Sun audio + hardware, among others. + + +.. function:: lin2lin(fragment, width, newwidth) + + Convert samples between 1-, 2-, 3- and 4-byte formats. + + .. note:: + + In some audio formats, such as .WAV files, 16, 24 and 32 bit samples are + signed, but 8 bit samples are unsigned. So when converting to 8 bit wide + samples for these formats, you need to also add 128 to the result:: + + new_frames = audioop.lin2lin(frames, old_width, 1) + new_frames = audioop.bias(new_frames, 1, 128) + + The same, in reverse, has to be applied when converting from 8 to 16, 24 + or 32 bit width samples. + + +.. function:: lin2ulaw(fragment, width) + + Convert samples in the audio fragment to u-LAW encoding and return this as a + bytes object. u-LAW is an audio encoding format whereby you get a dynamic + range of about 14 bits using only 8 bit samples. It is used by the Sun audio + hardware, among others. + + +.. function:: max(fragment, width) + + Return the maximum of the *absolute value* of all samples in a fragment. + + +.. function:: maxpp(fragment, width) + + Return the maximum peak-peak value in the sound fragment. + + +.. function:: minmax(fragment, width) + + Return a tuple consisting of the minimum and maximum values of all samples in + the sound fragment. + + +.. function:: mul(fragment, width, factor) + + Return a fragment that has all samples in the original fragment multiplied by + the floating-point value *factor*. Samples are truncated in case of overflow. + + +.. function:: ratecv(fragment, width, nchannels, inrate, outrate, state[, weightA[, weightB]]) + + Convert the frame rate of the input fragment. + + *state* is a tuple containing the state of the converter. The converter returns + a tuple ``(newfragment, newstate)``, and *newstate* should be passed to the next + call of :func:`ratecv`. The initial call should pass ``None`` as the state. + + The *weightA* and *weightB* arguments are parameters for a simple digital filter + and default to ``1`` and ``0`` respectively. + + +.. function:: reverse(fragment, width) + + Reverse the samples in a fragment and returns the modified fragment. + + +.. function:: rms(fragment, width) + + Return the root-mean-square of the fragment, i.e. ``sqrt(sum(S_i^2)/n)``. + + This is a measure of the power in an audio signal. + + +.. function:: tomono(fragment, width, lfactor, rfactor) + + Convert a stereo fragment to a mono fragment. The left channel is multiplied by + *lfactor* and the right channel by *rfactor* before adding the two channels to + give a mono signal. + + +.. function:: tostereo(fragment, width, lfactor, rfactor) + + Generate a stereo fragment from a mono fragment. Each pair of samples in the + stereo fragment are computed from the mono sample, whereby left channel samples + are multiplied by *lfactor* and right channel samples by *rfactor*. + + +.. function:: ulaw2lin(fragment, width) + + Convert sound fragments in u-LAW encoding to linearly encoded sound fragments. + u-LAW encoding always uses 8 bits samples, so *width* refers only to the sample + width of the output fragment here. + +Note that operations such as :func:`.mul` or :func:`.max` make no distinction +between mono and stereo fragments, i.e. all samples are treated equal. If this +is a problem the stereo fragment should be split into two mono fragments first +and recombined later. Here is an example of how to do that:: + + def mul_stereo(sample, width, lfactor, rfactor): + lsample = audioop.tomono(sample, width, 1, 0) + rsample = audioop.tomono(sample, width, 0, 1) + lsample = audioop.mul(lsample, width, lfactor) + rsample = audioop.mul(rsample, width, rfactor) + lsample = audioop.tostereo(lsample, width, 1, 0) + rsample = audioop.tostereo(rsample, width, 0, 1) + return audioop.add(lsample, rsample, width) + +If you use the ADPCM coder to build network packets and you want your protocol +to be stateless (i.e. to be able to tolerate packet loss) you should not only +transmit the data but also the state. Note that you should send the *initial* +state (the one you passed to :func:`lin2adpcm`) along to the decoder, not the +final state (as returned by the coder). If you want to use +:class:`struct.Struct` to store the state in binary you can code the first +element (the predicted value) in 16 bits and the second (the delta index) in 8. + +The ADPCM coders have never been tried against other ADPCM coders, only against +themselves. It could well be that I misinterpreted the standards in which case +they will not be interoperable with the respective standards. + +The :func:`find\*` routines might look a bit funny at first sight. They are +primarily meant to do echo cancellation. A reasonably fast way to do this is to +pick the most energetic piece of the output sample, locate that in the input +sample and subtract the whole output sample from the input sample:: + + def echocancel(outputdata, inputdata): + pos = audioop.findmax(outputdata, 800) # one tenth second + out_test = outputdata[pos*2:] + in_test = inputdata[pos*2:] + ipos, factor = audioop.findfit(in_test, out_test) + # Optional (for better cancellation): + # factor = audioop.findfactor(in_test[ipos*2:ipos*2+len(out_test)], + # out_test) + prefill = '\0'*(pos+ipos)*2 + postfill = '\0'*(len(inputdata)-len(prefill)-len(outputdata)) + outputdata = prefill + audioop.mul(outputdata, 2, -factor) + postfill + return audioop.add(inputdata, outputdata, 2) + diff --git a/python-3.7.4-docs-html/_sources/library/base64.rst.txt b/python-3.7.4-docs-html/_sources/library/base64.rst.txt new file mode 100644 index 0000000..ad9f5f5 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/base64.rst.txt @@ -0,0 +1,290 @@ +:mod:`base64` --- Base16, Base32, Base64, Base85 Data Encodings +=============================================================== + +.. module:: base64 + :synopsis: RFC 3548: Base16, Base32, Base64 Data Encodings; + Base85 and Ascii85 + +**Source code:** :source:`Lib/base64.py` + +.. index:: + pair: base64; encoding + single: MIME; base64 encoding + +-------------- + +This module provides functions for encoding binary data to printable +ASCII characters and decoding such encodings back to binary data. +It provides encoding and decoding functions for the encodings specified in +:rfc:`3548`, which defines the Base16, Base32, and Base64 algorithms, +and for the de-facto standard Ascii85 and Base85 encodings. + +The :rfc:`3548` encodings are suitable for encoding binary data so that it can +safely sent by email, used as parts of URLs, or included as part of an HTTP +POST request. The encoding algorithm is not the same as the +:program:`uuencode` program. + +There are two interfaces provided by this module. The modern interface +supports encoding :term:`bytes-like objects ` to ASCII +:class:`bytes`, and decoding :term:`bytes-like objects ` or +strings containing ASCII to :class:`bytes`. Both base-64 alphabets +defined in :rfc:`3548` (normal, and URL- and filesystem-safe) are supported. + +The legacy interface does not support decoding from strings, but it does +provide functions for encoding and decoding to and from :term:`file objects +`. It only supports the Base64 standard alphabet, and it adds +newlines every 76 characters as per :rfc:`2045`. Note that if you are looking +for :rfc:`2045` support you probably want to be looking at the :mod:`email` +package instead. + + +.. versionchanged:: 3.3 + ASCII-only Unicode strings are now accepted by the decoding functions of + the modern interface. + +.. versionchanged:: 3.4 + Any :term:`bytes-like objects ` are now accepted by all + encoding and decoding functions in this module. Ascii85/Base85 support added. + +The modern interface provides: + +.. function:: b64encode(s, altchars=None) + + Encode the :term:`bytes-like object` *s* using Base64 and return the encoded + :class:`bytes`. + + Optional *altchars* must be a :term:`bytes-like object` of at least + length 2 (additional characters are ignored) which specifies an alternative + alphabet for the ``+`` and ``/`` characters. This allows an application to e.g. + generate URL or filesystem safe Base64 strings. The default is ``None``, for + which the standard Base64 alphabet is used. + + +.. function:: b64decode(s, altchars=None, validate=False) + + Decode the Base64 encoded :term:`bytes-like object` or ASCII string + *s* and return the decoded :class:`bytes`. + + Optional *altchars* must be a :term:`bytes-like object` or ASCII string of + at least length 2 (additional characters are ignored) which specifies the + alternative alphabet used instead of the ``+`` and ``/`` characters. + + A :exc:`binascii.Error` exception is raised + if *s* is incorrectly padded. + + If *validate* is ``False`` (the default), characters that are neither + in the normal base-64 alphabet nor the alternative alphabet are + discarded prior to the padding check. If *validate* is ``True``, + these non-alphabet characters in the input result in a + :exc:`binascii.Error`. + + +.. function:: standard_b64encode(s) + + Encode :term:`bytes-like object` *s* using the standard Base64 alphabet + and return the encoded :class:`bytes`. + + +.. function:: standard_b64decode(s) + + Decode :term:`bytes-like object` or ASCII string *s* using the standard + Base64 alphabet and return the decoded :class:`bytes`. + + +.. function:: urlsafe_b64encode(s) + + Encode :term:`bytes-like object` *s* using the + URL- and filesystem-safe alphabet, which + substitutes ``-`` instead of ``+`` and ``_`` instead of ``/`` in the + standard Base64 alphabet, and return the encoded :class:`bytes`. The result + can still contain ``=``. + + +.. function:: urlsafe_b64decode(s) + + Decode :term:`bytes-like object` or ASCII string *s* + using the URL- and filesystem-safe + alphabet, which substitutes ``-`` instead of ``+`` and ``_`` instead of + ``/`` in the standard Base64 alphabet, and return the decoded + :class:`bytes`. + + +.. function:: b32encode(s) + + Encode the :term:`bytes-like object` *s* using Base32 and return the + encoded :class:`bytes`. + + +.. function:: b32decode(s, casefold=False, map01=None) + + Decode the Base32 encoded :term:`bytes-like object` or ASCII string *s* and + return the decoded :class:`bytes`. + + Optional *casefold* is a flag specifying + whether a lowercase alphabet is acceptable as input. For security purposes, + the default is ``False``. + + :rfc:`3548` allows for optional mapping of the digit 0 (zero) to the letter O + (oh), and for optional mapping of the digit 1 (one) to either the letter I (eye) + or letter L (el). The optional argument *map01* when not ``None``, specifies + which letter the digit 1 should be mapped to (when *map01* is not ``None``, the + digit 0 is always mapped to the letter O). For security purposes the default is + ``None``, so that 0 and 1 are not allowed in the input. + + A :exc:`binascii.Error` is raised if *s* is + incorrectly padded or if there are non-alphabet characters present in the + input. + + +.. function:: b16encode(s) + + Encode the :term:`bytes-like object` *s* using Base16 and return the + encoded :class:`bytes`. + + +.. function:: b16decode(s, casefold=False) + + Decode the Base16 encoded :term:`bytes-like object` or ASCII string *s* and + return the decoded :class:`bytes`. + + Optional *casefold* is a flag specifying whether a + lowercase alphabet is acceptable as input. For security purposes, the default + is ``False``. + + A :exc:`binascii.Error` is raised if *s* is + incorrectly padded or if there are non-alphabet characters present in the + input. + + +.. function:: a85encode(b, *, foldspaces=False, wrapcol=0, pad=False, adobe=False) + + Encode the :term:`bytes-like object` *b* using Ascii85 and return the + encoded :class:`bytes`. + + *foldspaces* is an optional flag that uses the special short sequence 'y' + instead of 4 consecutive spaces (ASCII 0x20) as supported by 'btoa'. This + feature is not supported by the "standard" Ascii85 encoding. + + *wrapcol* controls whether the output should have newline (``b'\n'``) + characters added to it. If this is non-zero, each output line will be + at most this many characters long. + + *pad* controls whether the input is padded to a multiple of 4 + before encoding. Note that the ``btoa`` implementation always pads. + + *adobe* controls whether the encoded byte sequence is framed with ``<~`` + and ``~>``, which is used by the Adobe implementation. + + .. versionadded:: 3.4 + + +.. function:: a85decode(b, *, foldspaces=False, adobe=False, ignorechars=b' \\t\\n\\r\\v') + + Decode the Ascii85 encoded :term:`bytes-like object` or ASCII string *b* and + return the decoded :class:`bytes`. + + *foldspaces* is a flag that specifies whether the 'y' short sequence + should be accepted as shorthand for 4 consecutive spaces (ASCII 0x20). + This feature is not supported by the "standard" Ascii85 encoding. + + *adobe* controls whether the input sequence is in Adobe Ascii85 format + (i.e. is framed with <~ and ~>). + + *ignorechars* should be a :term:`bytes-like object` or ASCII string + containing characters to ignore + from the input. This should only contain whitespace characters, and by + default contains all whitespace characters in ASCII. + + .. versionadded:: 3.4 + + +.. function:: b85encode(b, pad=False) + + Encode the :term:`bytes-like object` *b* using base85 (as used in e.g. + git-style binary diffs) and return the encoded :class:`bytes`. + + If *pad* is true, the input is padded with ``b'\0'`` so its length is a + multiple of 4 bytes before encoding. + + .. versionadded:: 3.4 + + +.. function:: b85decode(b) + + Decode the base85-encoded :term:`bytes-like object` or ASCII string *b* and + return the decoded :class:`bytes`. Padding is implicitly removed, if + necessary. + + .. versionadded:: 3.4 + + +The legacy interface: + +.. function:: decode(input, output) + + Decode the contents of the binary *input* file and write the resulting binary + data to the *output* file. *input* and *output* must be :term:`file objects + `. *input* will be read until ``input.readline()`` returns an + empty bytes object. + + +.. function:: decodebytes(s) + + Decode the :term:`bytes-like object` *s*, which must contain one or more + lines of base64 encoded data, and return the decoded :class:`bytes`. + + .. versionadded:: 3.1 + +.. function:: decodestring(s) + + Deprecated alias of :func:`decodebytes`. + + .. deprecated:: 3.1 + + +.. function:: encode(input, output) + + Encode the contents of the binary *input* file and write the resulting base64 + encoded data to the *output* file. *input* and *output* must be :term:`file + objects `. *input* will be read until ``input.read()`` returns + an empty bytes object. :func:`encode` inserts a newline character (``b'\n'``) + after every 76 bytes of the output, as well as ensuring that the output + always ends with a newline, as per :rfc:`2045` (MIME). + + +.. function:: encodebytes(s) + + Encode the :term:`bytes-like object` *s*, which can contain arbitrary binary + data, and return :class:`bytes` containing the base64-encoded data, with newlines + (``b'\n'``) inserted after every 76 bytes of output, and ensuring that + there is a trailing newline, as per :rfc:`2045` (MIME). + + .. versionadded:: 3.1 + +.. function:: encodestring(s) + + Deprecated alias of :func:`encodebytes`. + + .. deprecated:: 3.1 + + +An example usage of the module: + + >>> import base64 + >>> encoded = base64.b64encode(b'data to be encoded') + >>> encoded + b'ZGF0YSB0byBiZSBlbmNvZGVk' + >>> data = base64.b64decode(encoded) + >>> data + b'data to be encoded' + + +.. seealso:: + + Module :mod:`binascii` + Support module containing ASCII-to-binary and binary-to-ASCII conversions. + + :rfc:`1521` - MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies + Section 5.2, "Base64 Content-Transfer-Encoding," provides the definition of the + base64 encoding. + diff --git a/python-3.7.4-docs-html/_sources/library/bdb.rst.txt b/python-3.7.4-docs-html/_sources/library/bdb.rst.txt new file mode 100644 index 0000000..116ffcf --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/bdb.rst.txt @@ -0,0 +1,372 @@ +:mod:`bdb` --- Debugger framework +================================= + +.. module:: bdb + :synopsis: Debugger framework. + +**Source code:** :source:`Lib/bdb.py` + +-------------- + +The :mod:`bdb` module handles basic debugger functions, like setting breakpoints +or managing execution via the debugger. + +The following exception is defined: + +.. exception:: BdbQuit + + Exception raised by the :class:`Bdb` class for quitting the debugger. + + +The :mod:`bdb` module also defines two classes: + +.. class:: Breakpoint(self, file, line, temporary=0, cond=None, funcname=None) + + This class implements temporary breakpoints, ignore counts, disabling and + (re-)enabling, and conditionals. + + Breakpoints are indexed by number through a list called :attr:`bpbynumber` + and by ``(file, line)`` pairs through :attr:`bplist`. The former points to a + single instance of class :class:`Breakpoint`. The latter points to a list of + such instances since there may be more than one breakpoint per line. + + When creating a breakpoint, its associated filename should be in canonical + form. If a *funcname* is defined, a breakpoint hit will be counted when the + first line of that function is executed. A conditional breakpoint always + counts a hit. + + :class:`Breakpoint` instances have the following methods: + + .. method:: deleteMe() + + Delete the breakpoint from the list associated to a file/line. If it is + the last breakpoint in that position, it also deletes the entry for the + file/line. + + + .. method:: enable() + + Mark the breakpoint as enabled. + + + .. method:: disable() + + Mark the breakpoint as disabled. + + + .. method:: bpformat() + + Return a string with all the information about the breakpoint, nicely + formatted: + + * The breakpoint number. + * If it is temporary or not. + * Its file,line position. + * The condition that causes a break. + * If it must be ignored the next N times. + * The breakpoint hit count. + + .. versionadded:: 3.2 + + .. method:: bpprint(out=None) + + Print the output of :meth:`bpformat` to the file *out*, or if it is + ``None``, to standard output. + + +.. class:: Bdb(skip=None) + + The :class:`Bdb` class acts as a generic Python debugger base class. + + This class takes care of the details of the trace facility; a derived class + should implement user interaction. The standard debugger class + (:class:`pdb.Pdb`) is an example. + + The *skip* argument, if given, must be an iterable of glob-style + module name patterns. The debugger will not step into frames that + originate in a module that matches one of these patterns. Whether a + frame is considered to originate in a certain module is determined + by the ``__name__`` in the frame globals. + + .. versionadded:: 3.1 + The *skip* argument. + + The following methods of :class:`Bdb` normally don't need to be overridden. + + .. method:: canonic(filename) + + Auxiliary method for getting a filename in a canonical form, that is, as a + case-normalized (on case-insensitive filesystems) absolute path, stripped + of surrounding angle brackets. + + .. method:: reset() + + Set the :attr:`botframe`, :attr:`stopframe`, :attr:`returnframe` and + :attr:`quitting` attributes with values ready to start debugging. + + .. method:: trace_dispatch(frame, event, arg) + + This function is installed as the trace function of debugged frames. Its + return value is the new trace function (in most cases, that is, itself). + + The default implementation decides how to dispatch a frame, depending on + the type of event (passed as a string) that is about to be executed. + *event* can be one of the following: + + * ``"line"``: A new line of code is going to be executed. + * ``"call"``: A function is about to be called, or another code block + entered. + * ``"return"``: A function or other code block is about to return. + * ``"exception"``: An exception has occurred. + * ``"c_call"``: A C function is about to be called. + * ``"c_return"``: A C function has returned. + * ``"c_exception"``: A C function has raised an exception. + + For the Python events, specialized functions (see below) are called. For + the C events, no action is taken. + + The *arg* parameter depends on the previous event. + + See the documentation for :func:`sys.settrace` for more information on the + trace function. For more information on code and frame objects, refer to + :ref:`types`. + + .. method:: dispatch_line(frame) + + If the debugger should stop on the current line, invoke the + :meth:`user_line` method (which should be overridden in subclasses). + Raise a :exc:`BdbQuit` exception if the :attr:`Bdb.quitting` flag is set + (which can be set from :meth:`user_line`). Return a reference to the + :meth:`trace_dispatch` method for further tracing in that scope. + + .. method:: dispatch_call(frame, arg) + + If the debugger should stop on this function call, invoke the + :meth:`user_call` method (which should be overridden in subclasses). + Raise a :exc:`BdbQuit` exception if the :attr:`Bdb.quitting` flag is set + (which can be set from :meth:`user_call`). Return a reference to the + :meth:`trace_dispatch` method for further tracing in that scope. + + .. method:: dispatch_return(frame, arg) + + If the debugger should stop on this function return, invoke the + :meth:`user_return` method (which should be overridden in subclasses). + Raise a :exc:`BdbQuit` exception if the :attr:`Bdb.quitting` flag is set + (which can be set from :meth:`user_return`). Return a reference to the + :meth:`trace_dispatch` method for further tracing in that scope. + + .. method:: dispatch_exception(frame, arg) + + If the debugger should stop at this exception, invokes the + :meth:`user_exception` method (which should be overridden in subclasses). + Raise a :exc:`BdbQuit` exception if the :attr:`Bdb.quitting` flag is set + (which can be set from :meth:`user_exception`). Return a reference to the + :meth:`trace_dispatch` method for further tracing in that scope. + + Normally derived classes don't override the following methods, but they may + if they want to redefine the definition of stopping and breakpoints. + + .. method:: stop_here(frame) + + This method checks if the *frame* is somewhere below :attr:`botframe` in + the call stack. :attr:`botframe` is the frame in which debugging started. + + .. method:: break_here(frame) + + This method checks if there is a breakpoint in the filename and line + belonging to *frame* or, at least, in the current function. If the + breakpoint is a temporary one, this method deletes it. + + .. method:: break_anywhere(frame) + + This method checks if there is a breakpoint in the filename of the current + frame. + + Derived classes should override these methods to gain control over debugger + operation. + + .. method:: user_call(frame, argument_list) + + This method is called from :meth:`dispatch_call` when there is the + possibility that a break might be necessary anywhere inside the called + function. + + .. method:: user_line(frame) + + This method is called from :meth:`dispatch_line` when either + :meth:`stop_here` or :meth:`break_here` yields ``True``. + + .. method:: user_return(frame, return_value) + + This method is called from :meth:`dispatch_return` when :meth:`stop_here` + yields ``True``. + + .. method:: user_exception(frame, exc_info) + + This method is called from :meth:`dispatch_exception` when + :meth:`stop_here` yields ``True``. + + .. method:: do_clear(arg) + + Handle how a breakpoint must be removed when it is a temporary one. + + This method must be implemented by derived classes. + + + Derived classes and clients can call the following methods to affect the + stepping state. + + .. method:: set_step() + + Stop after one line of code. + + .. method:: set_next(frame) + + Stop on the next line in or below the given frame. + + .. method:: set_return(frame) + + Stop when returning from the given frame. + + .. method:: set_until(frame) + + Stop when the line with the line no greater than the current one is + reached or when returning from current frame. + + .. method:: set_trace([frame]) + + Start debugging from *frame*. If *frame* is not specified, debugging + starts from caller's frame. + + .. method:: set_continue() + + Stop only at breakpoints or when finished. If there are no breakpoints, + set the system trace function to ``None``. + + .. method:: set_quit() + + Set the :attr:`quitting` attribute to ``True``. This raises :exc:`BdbQuit` in + the next call to one of the :meth:`dispatch_\*` methods. + + + Derived classes and clients can call the following methods to manipulate + breakpoints. These methods return a string containing an error message if + something went wrong, or ``None`` if all is well. + + .. method:: set_break(filename, lineno, temporary=0, cond, funcname) + + Set a new breakpoint. If the *lineno* line doesn't exist for the + *filename* passed as argument, return an error message. The *filename* + should be in canonical form, as described in the :meth:`canonic` method. + + .. method:: clear_break(filename, lineno) + + Delete the breakpoints in *filename* and *lineno*. If none were set, an + error message is returned. + + .. method:: clear_bpbynumber(arg) + + Delete the breakpoint which has the index *arg* in the + :attr:`Breakpoint.bpbynumber`. If *arg* is not numeric or out of range, + return an error message. + + .. method:: clear_all_file_breaks(filename) + + Delete all breakpoints in *filename*. If none were set, an error message + is returned. + + .. method:: clear_all_breaks() + + Delete all existing breakpoints. + + .. method:: get_bpbynumber(arg) + + Return a breakpoint specified by the given number. If *arg* is a string, + it will be converted to a number. If *arg* is a non-numeric string, if + the given breakpoint never existed or has been deleted, a + :exc:`ValueError` is raised. + + .. versionadded:: 3.2 + + .. method:: get_break(filename, lineno) + + Check if there is a breakpoint for *lineno* of *filename*. + + .. method:: get_breaks(filename, lineno) + + Return all breakpoints for *lineno* in *filename*, or an empty list if + none are set. + + .. method:: get_file_breaks(filename) + + Return all breakpoints in *filename*, or an empty list if none are set. + + .. method:: get_all_breaks() + + Return all breakpoints that are set. + + + Derived classes and clients can call the following methods to get a data + structure representing a stack trace. + + .. method:: get_stack(f, t) + + Get a list of records for a frame and all higher (calling) and lower + frames, and the size of the higher part. + + .. method:: format_stack_entry(frame_lineno, lprefix=': ') + + Return a string with information about a stack entry, identified by a + ``(frame, lineno)`` tuple: + + * The canonical form of the filename which contains the frame. + * The function name, or ``""``. + * The input arguments. + * The return value. + * The line of code (if it exists). + + + The following two methods can be called by clients to use a debugger to debug + a :term:`statement`, given as a string. + + .. method:: run(cmd, globals=None, locals=None) + + Debug a statement executed via the :func:`exec` function. *globals* + defaults to :attr:`__main__.__dict__`, *locals* defaults to *globals*. + + .. method:: runeval(expr, globals=None, locals=None) + + Debug an expression executed via the :func:`eval` function. *globals* and + *locals* have the same meaning as in :meth:`run`. + + .. method:: runctx(cmd, globals, locals) + + For backwards compatibility. Calls the :meth:`run` method. + + .. method:: runcall(func, *args, **kwds) + + Debug a single function call, and return its result. + + +Finally, the module defines the following functions: + +.. function:: checkfuncname(b, frame) + + Check whether we should break here, depending on the way the breakpoint *b* + was set. + + If it was set via line number, it checks if ``b.line`` is the same as the one + in the frame also passed as argument. If the breakpoint was set via function + name, we have to check we are in the right frame (the right function) and if + we are in its first executable line. + +.. function:: effective(file, line, frame) + + Determine if there is an effective (active) breakpoint at this line of code. + Return a tuple of the breakpoint and a boolean that indicates if it is ok + to delete a temporary breakpoint. Return ``(None, None)`` if there is no + matching breakpoint. + +.. function:: set_trace() + + Start debugging with a :class:`Bdb` instance from caller's frame. diff --git a/python-3.7.4-docs-html/_sources/library/binary.rst.txt b/python-3.7.4-docs-html/_sources/library/binary.rst.txt new file mode 100644 index 0000000..51fbdc1 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/binary.rst.txt @@ -0,0 +1,23 @@ +.. _binaryservices: + +******************** +Binary Data Services +******************** + +The modules described in this chapter provide some basic services operations +for manipulation of binary data. Other operations on binary data, specifically +in relation to file formats and network protocols, are described in the +relevant sections. + +Some libraries described under :ref:`textservices` also work with either +ASCII-compatible binary formats (for example, :mod:`re`) or all binary data +(for example, :mod:`difflib`). + +In addition, see the documentation for Python's built-in binary data types in +:ref:`binaryseq`. + +.. toctree:: + + struct.rst + codecs.rst + diff --git a/python-3.7.4-docs-html/_sources/library/binascii.rst.txt b/python-3.7.4-docs-html/_sources/library/binascii.rst.txt new file mode 100644 index 0000000..89ecddc --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/binascii.rst.txt @@ -0,0 +1,194 @@ +:mod:`binascii` --- Convert between binary and ASCII +==================================================== + +.. module:: binascii + :synopsis: Tools for converting between binary and various ASCII-encoded binary + representations. + +.. index:: + module: uu + module: base64 + module: binhex + +-------------- + +The :mod:`binascii` module contains a number of methods to convert between +binary and various ASCII-encoded binary representations. Normally, you will not +use these functions directly but use wrapper modules like :mod:`uu`, +:mod:`base64`, or :mod:`binhex` instead. The :mod:`binascii` module contains +low-level functions written in C for greater speed that are used by the +higher-level modules. + +.. note:: + + ``a2b_*`` functions accept Unicode strings containing only ASCII characters. + Other functions only accept :term:`bytes-like objects ` (such as + :class:`bytes`, :class:`bytearray` and other objects that support the buffer + protocol). + + .. versionchanged:: 3.3 + ASCII-only unicode strings are now accepted by the ``a2b_*`` functions. + + +The :mod:`binascii` module defines the following functions: + + +.. function:: a2b_uu(string) + + Convert a single line of uuencoded data back to binary and return the binary + data. Lines normally contain 45 (binary) bytes, except for the last line. Line + data may be followed by whitespace. + + +.. function:: b2a_uu(data, *, backtick=False) + + Convert binary data to a line of ASCII characters, the return value is the + converted line, including a newline char. The length of *data* should be at most + 45. If *backtick* is true, zeros are represented by ``'`'`` instead of spaces. + + .. versionchanged:: 3.7 + Added the *backtick* parameter. + + +.. function:: a2b_base64(string) + + Convert a block of base64 data back to binary and return the binary data. More + than one line may be passed at a time. + + +.. function:: b2a_base64(data, *, newline=True) + + Convert binary data to a line of ASCII characters in base64 coding. The return + value is the converted line, including a newline char if *newline* is + true. The output of this function conforms to :rfc:`3548`. + + .. versionchanged:: 3.6 + Added the *newline* parameter. + + +.. function:: a2b_qp(data, header=False) + + Convert a block of quoted-printable data back to binary and return the binary + data. More than one line may be passed at a time. If the optional argument + *header* is present and true, underscores will be decoded as spaces. + + +.. function:: b2a_qp(data, quotetabs=False, istext=True, header=False) + + Convert binary data to a line(s) of ASCII characters in quoted-printable + encoding. The return value is the converted line(s). If the optional argument + *quotetabs* is present and true, all tabs and spaces will be encoded. If the + optional argument *istext* is present and true, newlines are not encoded but + trailing whitespace will be encoded. If the optional argument *header* is + present and true, spaces will be encoded as underscores per :rfc:`1522`. If the + optional argument *header* is present and false, newline characters will be + encoded as well; otherwise linefeed conversion might corrupt the binary data + stream. + + +.. function:: a2b_hqx(string) + + Convert binhex4 formatted ASCII data to binary, without doing RLE-decompression. + The string should contain a complete number of binary bytes, or (in case of the + last portion of the binhex4 data) have the remaining bits zero. + + +.. function:: rledecode_hqx(data) + + Perform RLE-decompression on the data, as per the binhex4 standard. The + algorithm uses ``0x90`` after a byte as a repeat indicator, followed by a count. + A count of ``0`` specifies a byte value of ``0x90``. The routine returns the + decompressed data, unless data input data ends in an orphaned repeat indicator, + in which case the :exc:`Incomplete` exception is raised. + + .. versionchanged:: 3.2 + Accept only bytestring or bytearray objects as input. + + +.. function:: rlecode_hqx(data) + + Perform binhex4 style RLE-compression on *data* and return the result. + + +.. function:: b2a_hqx(data) + + Perform hexbin4 binary-to-ASCII translation and return the resulting string. The + argument should already be RLE-coded, and have a length divisible by 3 (except + possibly the last fragment). + + +.. function:: crc_hqx(data, value) + + Compute a 16-bit CRC value of *data*, starting with *value* as the + initial CRC, and return the result. This uses the CRC-CCITT polynomial + *x*:sup:`16` + *x*:sup:`12` + *x*:sup:`5` + 1, often represented as + 0x1021. This CRC is used in the binhex4 format. + + +.. function:: crc32(data[, value]) + + Compute CRC-32, the 32-bit checksum of *data*, starting with an + initial CRC of *value*. The default initial CRC is zero. The algorithm + is consistent with the ZIP file checksum. Since the algorithm is designed for + use as a checksum algorithm, it is not suitable for use as a general hash + algorithm. Use as follows:: + + print(binascii.crc32(b"hello world")) + # Or, in two pieces: + crc = binascii.crc32(b"hello") + crc = binascii.crc32(b" world", crc) + print('crc32 = {:#010x}'.format(crc)) + + .. versionchanged:: 3.0 + The result is always unsigned. + To generate the same numeric value across all Python versions and + platforms, use ``crc32(data) & 0xffffffff``. + + +.. function:: b2a_hex(data) + hexlify(data) + + Return the hexadecimal representation of the binary *data*. Every byte of + *data* is converted into the corresponding 2-digit hex representation. The + returned bytes object is therefore twice as long as the length of *data*. + + Similar functionality (but returning a text string) is also conveniently + accessible using the :meth:`bytes.hex` method. + +.. function:: a2b_hex(hexstr) + unhexlify(hexstr) + + Return the binary data represented by the hexadecimal string *hexstr*. This + function is the inverse of :func:`b2a_hex`. *hexstr* must contain an even number + of hexadecimal digits (which can be upper or lower case), otherwise an + :exc:`Error` exception is raised. + + Similar functionality (accepting only text string arguments, but more + liberal towards whitespace) is also accessible using the + :meth:`bytes.fromhex` class method. + +.. exception:: Error + + Exception raised on errors. These are usually programming errors. + + +.. exception:: Incomplete + + Exception raised on incomplete data. These are usually not programming errors, + but may be handled by reading a little more data and trying again. + + +.. seealso:: + + Module :mod:`base64` + Support for RFC compliant base64-style encoding in base 16, 32, 64, + and 85. + + Module :mod:`binhex` + Support for the binhex format used on the Macintosh. + + Module :mod:`uu` + Support for UU encoding used on Unix. + + Module :mod:`quopri` + Support for quoted-printable encoding used in MIME email messages. diff --git a/python-3.7.4-docs-html/_sources/library/binhex.rst.txt b/python-3.7.4-docs-html/_sources/library/binhex.rst.txt new file mode 100644 index 0000000..2966e0d --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/binhex.rst.txt @@ -0,0 +1,57 @@ +:mod:`binhex` --- Encode and decode binhex4 files +================================================= + +.. module:: binhex + :synopsis: Encode and decode files in binhex4 format. + +**Source code:** :source:`Lib/binhex.py` + +-------------- + +This module encodes and decodes files in binhex4 format, a format allowing +representation of Macintosh files in ASCII. Only the data fork is handled. + +The :mod:`binhex` module defines the following functions: + + +.. function:: binhex(input, output) + + Convert a binary file with filename *input* to binhex file *output*. The + *output* parameter can either be a filename or a file-like object (any object + supporting a :meth:`write` and :meth:`close` method). + + +.. function:: hexbin(input, output) + + Decode a binhex file *input*. *input* may be a filename or a file-like object + supporting :meth:`read` and :meth:`close` methods. The resulting file is written + to a file named *output*, unless the argument is ``None`` in which case the + output filename is read from the binhex file. + +The following exception is also defined: + + +.. exception:: Error + + Exception raised when something can't be encoded using the binhex format (for + example, a filename is too long to fit in the filename field), or when input is + not properly encoded binhex data. + + +.. seealso:: + + Module :mod:`binascii` + Support module containing ASCII-to-binary and binary-to-ASCII conversions. + + +.. _binhex-notes: + +Notes +----- + +There is an alternative, more powerful interface to the coder and decoder, see +the source for details. + +If you code or decode textfiles on non-Macintosh platforms they will still use +the old Macintosh newline convention (carriage-return as end of line). + diff --git a/python-3.7.4-docs-html/_sources/library/bisect.rst.txt b/python-3.7.4-docs-html/_sources/library/bisect.rst.txt new file mode 100644 index 0000000..6bf7814 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/bisect.rst.txt @@ -0,0 +1,149 @@ +:mod:`bisect` --- Array bisection algorithm +=========================================== + +.. module:: bisect + :synopsis: Array bisection algorithms for binary searching. +.. sectionauthor:: Fred L. Drake, Jr. +.. sectionauthor:: Raymond Hettinger +.. example based on the PyModules FAQ entry by Aaron Watters + +**Source code:** :source:`Lib/bisect.py` + +-------------- + +This module provides support for maintaining a list in sorted order without +having to sort the list after each insertion. For long lists of items with +expensive comparison operations, this can be an improvement over the more common +approach. The module is called :mod:`bisect` because it uses a basic bisection +algorithm to do its work. The source code may be most useful as a working +example of the algorithm (the boundary conditions are already right!). + +The following functions are provided: + + +.. function:: bisect_left(a, x, lo=0, hi=len(a)) + + Locate the insertion point for *x* in *a* to maintain sorted order. + The parameters *lo* and *hi* may be used to specify a subset of the list + which should be considered; by default the entire list is used. If *x* is + already present in *a*, the insertion point will be before (to the left of) + any existing entries. The return value is suitable for use as the first + parameter to ``list.insert()`` assuming that *a* is already sorted. + + The returned insertion point *i* partitions the array *a* into two halves so + that ``all(val < x for val in a[lo:i])`` for the left side and + ``all(val >= x for val in a[i:hi])`` for the right side. + +.. function:: bisect_right(a, x, lo=0, hi=len(a)) + bisect(a, x, lo=0, hi=len(a)) + + Similar to :func:`bisect_left`, but returns an insertion point which comes + after (to the right of) any existing entries of *x* in *a*. + + The returned insertion point *i* partitions the array *a* into two halves so + that ``all(val <= x for val in a[lo:i])`` for the left side and + ``all(val > x for val in a[i:hi])`` for the right side. + +.. function:: insort_left(a, x, lo=0, hi=len(a)) + + Insert *x* in *a* in sorted order. This is equivalent to + ``a.insert(bisect.bisect_left(a, x, lo, hi), x)`` assuming that *a* is + already sorted. Keep in mind that the O(log n) search is dominated by + the slow O(n) insertion step. + +.. function:: insort_right(a, x, lo=0, hi=len(a)) + insort(a, x, lo=0, hi=len(a)) + + Similar to :func:`insort_left`, but inserting *x* in *a* after any existing + entries of *x*. + +.. seealso:: + + `SortedCollection recipe + `_ that uses + bisect to build a full-featured collection class with straight-forward search + methods and support for a key-function. The keys are precomputed to save + unnecessary calls to the key function during searches. + + +Searching Sorted Lists +---------------------- + +The above :func:`bisect` functions are useful for finding insertion points but +can be tricky or awkward to use for common searching tasks. The following five +functions show how to transform them into the standard lookups for sorted +lists:: + + def index(a, x): + 'Locate the leftmost value exactly equal to x' + i = bisect_left(a, x) + if i != len(a) and a[i] == x: + return i + raise ValueError + + def find_lt(a, x): + 'Find rightmost value less than x' + i = bisect_left(a, x) + if i: + return a[i-1] + raise ValueError + + def find_le(a, x): + 'Find rightmost value less than or equal to x' + i = bisect_right(a, x) + if i: + return a[i-1] + raise ValueError + + def find_gt(a, x): + 'Find leftmost value greater than x' + i = bisect_right(a, x) + if i != len(a): + return a[i] + raise ValueError + + def find_ge(a, x): + 'Find leftmost item greater than or equal to x' + i = bisect_left(a, x) + if i != len(a): + return a[i] + raise ValueError + + +Other Examples +-------------- + +.. _bisect-example: + +The :func:`bisect` function can be useful for numeric table lookups. This +example uses :func:`bisect` to look up a letter grade for an exam score (say) +based on a set of ordered numeric breakpoints: 90 and up is an 'A', 80 to 89 is +a 'B', and so on:: + + >>> def grade(score, breakpoints=[60, 70, 80, 90], grades='FDCBA'): + ... i = bisect(breakpoints, score) + ... return grades[i] + ... + >>> [grade(score) for score in [33, 99, 77, 70, 89, 90, 100]] + ['F', 'A', 'C', 'C', 'B', 'A', 'A'] + +Unlike the :func:`sorted` function, it does not make sense for the :func:`bisect` +functions to have *key* or *reversed* arguments because that would lead to an +inefficient design (successive calls to bisect functions would not "remember" +all of the previous key lookups). + +Instead, it is better to search a list of precomputed keys to find the index +of the record in question:: + + >>> data = [('red', 5), ('blue', 1), ('yellow', 8), ('black', 0)] + >>> data.sort(key=lambda r: r[1]) + >>> keys = [r[1] for r in data] # precomputed list of keys + >>> data[bisect_left(keys, 0)] + ('black', 0) + >>> data[bisect_left(keys, 1)] + ('blue', 1) + >>> data[bisect_left(keys, 5)] + ('red', 5) + >>> data[bisect_left(keys, 8)] + ('yellow', 8) + diff --git a/python-3.7.4-docs-html/_sources/library/builtins.rst.txt b/python-3.7.4-docs-html/_sources/library/builtins.rst.txt new file mode 100644 index 0000000..8fb1fef --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/builtins.rst.txt @@ -0,0 +1,42 @@ +:mod:`builtins` --- Built-in objects +==================================== + +.. module:: builtins + :synopsis: The module that provides the built-in namespace. + +-------------- + +This module provides direct access to all 'built-in' identifiers of Python; for +example, ``builtins.open`` is the full name for the built-in function +:func:`open`. See :ref:`built-in-funcs` and :ref:`built-in-consts` for +documentation. + + +This module is not normally accessed explicitly by most applications, but can be +useful in modules that provide objects with the same name as a built-in value, +but in which the built-in of that name is also needed. For example, in a module +that wants to implement an :func:`open` function that wraps the built-in +:func:`open`, this module can be used directly:: + + import builtins + + def open(path): + f = builtins.open(path, 'r') + return UpperCaser(f) + + class UpperCaser: + '''Wrapper around a file that converts output to upper-case.''' + + def __init__(self, f): + self._f = f + + def read(self, count=-1): + return self._f.read(count).upper() + + # ... + +As an implementation detail, most modules have the name ``__builtins__`` made +available as part of their globals. The value of ``__builtins__`` is normally +either this module or the value of this module's :attr:`~object.__dict__` attribute. +Since this is an implementation detail, it may not be used by alternate +implementations of Python. diff --git a/python-3.7.4-docs-html/_sources/library/bz2.rst.txt b/python-3.7.4-docs-html/_sources/library/bz2.rst.txt new file mode 100644 index 0000000..b247de6 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/bz2.rst.txt @@ -0,0 +1,326 @@ +:mod:`bz2` --- Support for :program:`bzip2` compression +======================================================= + +.. module:: bz2 + :synopsis: Interfaces for bzip2 compression and decompression. + +.. moduleauthor:: Gustavo Niemeyer +.. moduleauthor:: Nadeem Vawda +.. sectionauthor:: Gustavo Niemeyer +.. sectionauthor:: Nadeem Vawda + +**Source code:** :source:`Lib/bz2.py` + +-------------- + +This module provides a comprehensive interface for compressing and +decompressing data using the bzip2 compression algorithm. + +The :mod:`bz2` module contains: + +* The :func:`.open` function and :class:`BZ2File` class for reading and + writing compressed files. +* The :class:`BZ2Compressor` and :class:`BZ2Decompressor` classes for + incremental (de)compression. +* The :func:`compress` and :func:`decompress` functions for one-shot + (de)compression. + +All of the classes in this module may safely be accessed from multiple threads. + + +(De)compression of files +------------------------ + +.. function:: open(filename, mode='r', compresslevel=9, encoding=None, errors=None, newline=None) + + Open a bzip2-compressed file in binary or text mode, returning a :term:`file + object`. + + As with the constructor for :class:`BZ2File`, the *filename* argument can be + an actual filename (a :class:`str` or :class:`bytes` object), or an existing + file object to read from or write to. + + The *mode* argument can be any of ``'r'``, ``'rb'``, ``'w'``, ``'wb'``, + ``'x'``, ``'xb'``, ``'a'`` or ``'ab'`` for binary mode, or ``'rt'``, + ``'wt'``, ``'xt'``, or ``'at'`` for text mode. The default is ``'rb'``. + + The *compresslevel* argument is an integer from 1 to 9, as for the + :class:`BZ2File` constructor. + + For binary mode, this function is equivalent to the :class:`BZ2File` + constructor: ``BZ2File(filename, mode, compresslevel=compresslevel)``. In + this case, the *encoding*, *errors* and *newline* arguments must not be + provided. + + For text mode, a :class:`BZ2File` object is created, and wrapped in an + :class:`io.TextIOWrapper` instance with the specified encoding, error + handling behavior, and line ending(s). + + .. versionadded:: 3.3 + + .. versionchanged:: 3.4 + The ``'x'`` (exclusive creation) mode was added. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. class:: BZ2File(filename, mode='r', buffering=None, compresslevel=9) + + Open a bzip2-compressed file in binary mode. + + If *filename* is a :class:`str` or :class:`bytes` object, open the named file + directly. Otherwise, *filename* should be a :term:`file object`, which will + be used to read or write the compressed data. + + The *mode* argument can be either ``'r'`` for reading (default), ``'w'`` for + overwriting, ``'x'`` for exclusive creation, or ``'a'`` for appending. These + can equivalently be given as ``'rb'``, ``'wb'``, ``'xb'`` and ``'ab'`` + respectively. + + If *filename* is a file object (rather than an actual file name), a mode of + ``'w'`` does not truncate the file, and is instead equivalent to ``'a'``. + + The *buffering* argument is ignored. Its use is deprecated. + + If *mode* is ``'w'`` or ``'a'``, *compresslevel* can be an integer between + ``1`` and ``9`` specifying the level of compression: ``1`` produces the + least compression, and ``9`` (default) produces the most compression. + + If *mode* is ``'r'``, the input file may be the concatenation of multiple + compressed streams. + + :class:`BZ2File` provides all of the members specified by the + :class:`io.BufferedIOBase`, except for :meth:`detach` and :meth:`truncate`. + Iteration and the :keyword:`with` statement are supported. + + :class:`BZ2File` also provides the following method: + + .. method:: peek([n]) + + Return buffered data without advancing the file position. At least one + byte of data will be returned (unless at EOF). The exact number of bytes + returned is unspecified. + + .. note:: While calling :meth:`peek` does not change the file position of + the :class:`BZ2File`, it may change the position of the underlying file + object (e.g. if the :class:`BZ2File` was constructed by passing a file + object for *filename*). + + .. versionadded:: 3.3 + + .. versionchanged:: 3.1 + Support for the :keyword:`with` statement was added. + + .. versionchanged:: 3.3 + The :meth:`fileno`, :meth:`readable`, :meth:`seekable`, :meth:`writable`, + :meth:`read1` and :meth:`readinto` methods were added. + + .. versionchanged:: 3.3 + Support was added for *filename* being a :term:`file object` instead of an + actual filename. + + .. versionchanged:: 3.3 + The ``'a'`` (append) mode was added, along with support for reading + multi-stream files. + + .. versionchanged:: 3.4 + The ``'x'`` (exclusive creation) mode was added. + + .. versionchanged:: 3.5 + The :meth:`~io.BufferedIOBase.read` method now accepts an argument of + ``None``. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +Incremental (de)compression +--------------------------- + +.. class:: BZ2Compressor(compresslevel=9) + + Create a new compressor object. This object may be used to compress data + incrementally. For one-shot compression, use the :func:`compress` function + instead. + + *compresslevel*, if given, must be an integer between ``1`` and ``9``. The + default is ``9``. + + .. method:: compress(data) + + Provide data to the compressor object. Returns a chunk of compressed data + if possible, or an empty byte string otherwise. + + When you have finished providing data to the compressor, call the + :meth:`flush` method to finish the compression process. + + + .. method:: flush() + + Finish the compression process. Returns the compressed data left in + internal buffers. + + The compressor object may not be used after this method has been called. + + +.. class:: BZ2Decompressor() + + Create a new decompressor object. This object may be used to decompress data + incrementally. For one-shot compression, use the :func:`decompress` function + instead. + + .. note:: + This class does not transparently handle inputs containing multiple + compressed streams, unlike :func:`decompress` and :class:`BZ2File`. If + you need to decompress a multi-stream input with :class:`BZ2Decompressor`, + you must use a new decompressor for each stream. + + .. method:: decompress(data, max_length=-1) + + Decompress *data* (a :term:`bytes-like object`), returning + uncompressed data as bytes. Some of *data* may be buffered + internally, for use in later calls to :meth:`decompress`. The + returned data should be concatenated with the output of any + previous calls to :meth:`decompress`. + + If *max_length* is nonnegative, returns at most *max_length* + bytes of decompressed data. If this limit is reached and further + output can be produced, the :attr:`~.needs_input` attribute will + be set to ``False``. In this case, the next call to + :meth:`~.decompress` may provide *data* as ``b''`` to obtain + more of the output. + + If all of the input data was decompressed and returned (either + because this was less than *max_length* bytes, or because + *max_length* was negative), the :attr:`~.needs_input` attribute + will be set to ``True``. + + Attempting to decompress data after the end of stream is reached + raises an `EOFError`. Any data found after the end of the + stream is ignored and saved in the :attr:`~.unused_data` attribute. + + .. versionchanged:: 3.5 + Added the *max_length* parameter. + + .. attribute:: eof + + ``True`` if the end-of-stream marker has been reached. + + .. versionadded:: 3.3 + + + .. attribute:: unused_data + + Data found after the end of the compressed stream. + + If this attribute is accessed before the end of the stream has been + reached, its value will be ``b''``. + + .. attribute:: needs_input + + ``False`` if the :meth:`.decompress` method can provide more + decompressed data before requiring new uncompressed input. + + .. versionadded:: 3.5 + + +One-shot (de)compression +------------------------ + +.. function:: compress(data, compresslevel=9) + + Compress *data*, a :term:`bytes-like object `. + + *compresslevel*, if given, must be an integer between ``1`` and ``9``. The + default is ``9``. + + For incremental compression, use a :class:`BZ2Compressor` instead. + + +.. function:: decompress(data) + + Decompress *data*, a :term:`bytes-like object `. + + If *data* is the concatenation of multiple compressed streams, decompress + all of the streams. + + For incremental decompression, use a :class:`BZ2Decompressor` instead. + + .. versionchanged:: 3.3 + Support for multi-stream inputs was added. + +.. _bz2-usage-examples: + +Examples of usage +----------------- + +Below are some examples of typical usage of the :mod:`bz2` module. + +Using :func:`compress` and :func:`decompress` to demonstrate round-trip compression: + + >>> import bz2 + + >>> data = b"""\ + ... Donec rhoncus quis sapien sit amet molestie. Fusce scelerisque vel augue + ... nec ullamcorper. Nam rutrum pretium placerat. Aliquam vel tristique lorem, + ... sit amet cursus ante. In interdum laoreet mi, sit amet ultrices purus + ... pulvinar a. Nam gravida euismod magna, non varius justo tincidunt feugiat. + ... Aliquam pharetra lacus non risus vehicula rutrum. Maecenas aliquam leo + ... felis. Pellentesque semper nunc sit amet nibh ullamcorper, ac elementum + ... dolor luctus. Curabitur lacinia mi ornare consectetur vestibulum.""" + + >>> c = bz2.compress(data) + >>> len(data) / len(c) # Data compression ratio + 1.513595166163142 + + >>> d = bz2.decompress(c) + >>> data == d # Check equality to original object after round-trip + True + +Using :class:`BZ2Compressor` for incremental compression: + + >>> import bz2 + + >>> def gen_data(chunks=10, chunksize=1000): + ... """Yield incremental blocks of chunksize bytes.""" + ... for _ in range(chunks): + ... yield b"z" * chunksize + ... + >>> comp = bz2.BZ2Compressor() + >>> out = b"" + >>> for chunk in gen_data(): + ... # Provide data to the compressor object + ... out = out + comp.compress(chunk) + ... + >>> # Finish the compression process. Call this once you have + >>> # finished providing data to the compressor. + >>> out = out + comp.flush() + +The example above uses a very "nonrandom" stream of data +(a stream of `b"z"` chunks). Random data tends to compress poorly, +while ordered, repetitive data usually yields a high compression ratio. + +Writing and reading a bzip2-compressed file in binary mode: + + >>> import bz2 + + >>> data = b"""\ + ... Donec rhoncus quis sapien sit amet molestie. Fusce scelerisque vel augue + ... nec ullamcorper. Nam rutrum pretium placerat. Aliquam vel tristique lorem, + ... sit amet cursus ante. In interdum laoreet mi, sit amet ultrices purus + ... pulvinar a. Nam gravida euismod magna, non varius justo tincidunt feugiat. + ... Aliquam pharetra lacus non risus vehicula rutrum. Maecenas aliquam leo + ... felis. Pellentesque semper nunc sit amet nibh ullamcorper, ac elementum + ... dolor luctus. Curabitur lacinia mi ornare consectetur vestibulum.""" + + >>> with bz2.open("myfile.bz2", "wb") as f: + ... # Write compressed data to file + ... unused = f.write(data) + + >>> with bz2.open("myfile.bz2", "rb") as f: + ... # Decompress data from file + ... content = f.read() + + >>> content == data # Check equality to original object after round-trip + True diff --git a/python-3.7.4-docs-html/_sources/library/calendar.rst.txt b/python-3.7.4-docs-html/_sources/library/calendar.rst.txt new file mode 100644 index 0000000..56b75ef --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/calendar.rst.txt @@ -0,0 +1,420 @@ +:mod:`calendar` --- General calendar-related functions +====================================================== + +.. module:: calendar + :synopsis: Functions for working with calendars, including some emulation + of the Unix cal program. + +.. sectionauthor:: Drew Csillag + +**Source code:** :source:`Lib/calendar.py` + +-------------- + +This module allows you to output calendars like the Unix :program:`cal` program, +and provides additional useful functions related to the calendar. By default, +these calendars have Monday as the first day of the week, and Sunday as the last +(the European convention). Use :func:`setfirstweekday` to set the first day of +the week to Sunday (6) or to any other weekday. Parameters that specify dates +are given as integers. For related +functionality, see also the :mod:`datetime` and :mod:`time` modules. + +The functions and classes defined in this module +use an idealized calendar, the current Gregorian calendar extended indefinitely +in both directions. This matches the definition of the "proleptic Gregorian" +calendar in Dershowitz and Reingold's book "Calendrical Calculations", where +it's the base calendar for all computations. Zero and negative years are +interpreted as prescribed by the ISO 8601 standard. Year 0 is 1 BC, year -1 is +2 BC, and so on. + + +.. class:: Calendar(firstweekday=0) + + Creates a :class:`Calendar` object. *firstweekday* is an integer specifying the + first day of the week. ``0`` is Monday (the default), ``6`` is Sunday. + + A :class:`Calendar` object provides several methods that can be used for + preparing the calendar data for formatting. This class doesn't do any formatting + itself. This is the job of subclasses. + + + :class:`Calendar` instances have the following methods: + + .. method:: iterweekdays() + + Return an iterator for the week day numbers that will be used for one + week. The first value from the iterator will be the same as the value of + the :attr:`firstweekday` property. + + + .. method:: itermonthdates(year, month) + + Return an iterator for the month *month* (1--12) in the year *year*. This + iterator will return all days (as :class:`datetime.date` objects) for the + month and all days before the start of the month or after the end of the + month that are required to get a complete week. + + + .. method:: itermonthdays(year, month) + + Return an iterator for the month *month* in the year *year* similar to + :meth:`itermonthdates`, but not restricted by the :class:`datetime.date` + range. Days returned will simply be day of the month numbers. For the + days outside of the specified month, the day number is ``0``. + + + .. method:: itermonthdays2(year, month) + + Return an iterator for the month *month* in the year *year* similar to + :meth:`itermonthdates`, but not restricted by the :class:`datetime.date` + range. Days returned will be tuples consisting of a day of the month + number and a week day number. + + + .. method:: itermonthdays3(year, month) + + Return an iterator for the month *month* in the year *year* similar to + :meth:`itermonthdates`, but not restricted by the :class:`datetime.date` + range. Days returned will be tuples consisting of a year, a month and a day + of the month numbers. + + .. versionadded:: 3.7 + + + .. method:: itermonthdays4(year, month) + + Return an iterator for the month *month* in the year *year* similar to + :meth:`itermonthdates`, but not restricted by the :class:`datetime.date` + range. Days returned will be tuples consisting of a year, a month, a day + of the month, and a day of the week numbers. + + .. versionadded:: 3.7 + + + .. method:: monthdatescalendar(year, month) + + Return a list of the weeks in the month *month* of the *year* as full + weeks. Weeks are lists of seven :class:`datetime.date` objects. + + + .. method:: monthdays2calendar(year, month) + + Return a list of the weeks in the month *month* of the *year* as full + weeks. Weeks are lists of seven tuples of day numbers and weekday + numbers. + + + .. method:: monthdayscalendar(year, month) + + Return a list of the weeks in the month *month* of the *year* as full + weeks. Weeks are lists of seven day numbers. + + + .. method:: yeardatescalendar(year, width=3) + + Return the data for the specified year ready for formatting. The return + value is a list of month rows. Each month row contains up to *width* + months (defaulting to 3). Each month contains between 4 and 6 weeks and + each week contains 1--7 days. Days are :class:`datetime.date` objects. + + + .. method:: yeardays2calendar(year, width=3) + + Return the data for the specified year ready for formatting (similar to + :meth:`yeardatescalendar`). Entries in the week lists are tuples of day + numbers and weekday numbers. Day numbers outside this month are zero. + + + .. method:: yeardayscalendar(year, width=3) + + Return the data for the specified year ready for formatting (similar to + :meth:`yeardatescalendar`). Entries in the week lists are day numbers. Day + numbers outside this month are zero. + + +.. class:: TextCalendar(firstweekday=0) + + This class can be used to generate plain text calendars. + + :class:`TextCalendar` instances have the following methods: + + .. method:: formatmonth(theyear, themonth, w=0, l=0) + + Return a month's calendar in a multi-line string. If *w* is provided, it + specifies the width of the date columns, which are centered. If *l* is + given, it specifies the number of lines that each week will use. Depends + on the first weekday as specified in the constructor or set by the + :meth:`setfirstweekday` method. + + + .. method:: prmonth(theyear, themonth, w=0, l=0) + + Print a month's calendar as returned by :meth:`formatmonth`. + + + .. method:: formatyear(theyear, w=2, l=1, c=6, m=3) + + Return a *m*-column calendar for an entire year as a multi-line string. + Optional parameters *w*, *l*, and *c* are for date column width, lines per + week, and number of spaces between month columns, respectively. Depends on + the first weekday as specified in the constructor or set by the + :meth:`setfirstweekday` method. The earliest year for which a calendar + can be generated is platform-dependent. + + + .. method:: pryear(theyear, w=2, l=1, c=6, m=3) + + Print the calendar for an entire year as returned by :meth:`formatyear`. + + +.. class:: HTMLCalendar(firstweekday=0) + + This class can be used to generate HTML calendars. + + + :class:`!HTMLCalendar` instances have the following methods: + + .. method:: formatmonth(theyear, themonth, withyear=True) + + Return a month's calendar as an HTML table. If *withyear* is true the year + will be included in the header, otherwise just the month name will be + used. + + + .. method:: formatyear(theyear, width=3) + + Return a year's calendar as an HTML table. *width* (defaulting to 3) + specifies the number of months per row. + + + .. method:: formatyearpage(theyear, width=3, css='calendar.css', encoding=None) + + Return a year's calendar as a complete HTML page. *width* (defaulting to + 3) specifies the number of months per row. *css* is the name for the + cascading style sheet to be used. :const:`None` can be passed if no style + sheet should be used. *encoding* specifies the encoding to be used for the + output (defaulting to the system default encoding). + + + :class:`!HTMLCalendar` has the following attributes you can override to + customize the CSS classes used by the calendar: + + .. attribute:: cssclasses + + A list of CSS classes used for each weekday. The default class list is:: + + cssclasses = ["mon", "tue", "wed", "thu", "fri", "sat", "sun"] + + more styles can be added for each day:: + + cssclasses = ["mon text-bold", "tue", "wed", "thu", "fri", "sat", "sun red"] + + Note that the length of this list must be seven items. + + + .. attribute:: cssclass_noday + + The CSS class for a weekday occurring in the previous or coming month. + + .. versionadded:: 3.7 + + + .. attribute:: cssclasses_weekday_head + + A list of CSS classes used for weekday names in the header row. + The default is the same as :attr:`cssclasses`. + + .. versionadded:: 3.7 + + + .. attribute:: cssclass_month_head + + The month's head CSS class (used by :meth:`formatmonthname`). + The default value is ``"month"``. + + .. versionadded:: 3.7 + + + .. attribute:: cssclass_month + + The CSS class for the whole month's table (used by :meth:`formatmonth`). + The default value is ``"month"``. + + .. versionadded:: 3.7 + + + .. attribute:: cssclass_year + + The CSS class for the whole year's table of tables (used by + :meth:`formatyear`). The default value is ``"year"``. + + .. versionadded:: 3.7 + + + .. attribute:: cssclass_year_head + + The CSS class for the table head for the whole year (used by + :meth:`formatyear`). The default value is ``"year"``. + + .. versionadded:: 3.7 + + + Note that although the naming for the above described class attributes is + singular (e.g. ``cssclass_month`` ``cssclass_noday``), one can replace the + single CSS class with a space separated list of CSS classes, for example:: + + "text-bold text-red" + + Here is an example how :class:`!HTMLCalendar` can be customized:: + + class CustomHTMLCal(calendar.HTMLCalendar): + cssclasses = [style + " text-nowrap" for style in + calendar.HTMLCalendar.cssclasses] + cssclass_month_head = "text-center month-head" + cssclass_month = "text-center month" + cssclass_year = "text-italic lead" + + +.. class:: LocaleTextCalendar(firstweekday=0, locale=None) + + This subclass of :class:`TextCalendar` can be passed a locale name in the + constructor and will return month and weekday names in the specified locale. + If this locale includes an encoding all strings containing month and weekday + names will be returned as unicode. + + +.. class:: LocaleHTMLCalendar(firstweekday=0, locale=None) + + This subclass of :class:`HTMLCalendar` can be passed a locale name in the + constructor and will return month and weekday names in the specified + locale. If this locale includes an encoding all strings containing month and + weekday names will be returned as unicode. + +.. note:: + + The :meth:`formatweekday` and :meth:`formatmonthname` methods of these two + classes temporarily change the current locale to the given *locale*. Because + the current locale is a process-wide setting, they are not thread-safe. + + +For simple text calendars this module provides the following functions. + +.. function:: setfirstweekday(weekday) + + Sets the weekday (``0`` is Monday, ``6`` is Sunday) to start each week. The + values :const:`MONDAY`, :const:`TUESDAY`, :const:`WEDNESDAY`, :const:`THURSDAY`, + :const:`FRIDAY`, :const:`SATURDAY`, and :const:`SUNDAY` are provided for + convenience. For example, to set the first weekday to Sunday:: + + import calendar + calendar.setfirstweekday(calendar.SUNDAY) + + +.. function:: firstweekday() + + Returns the current setting for the weekday to start each week. + + +.. function:: isleap(year) + + Returns :const:`True` if *year* is a leap year, otherwise :const:`False`. + + +.. function:: leapdays(y1, y2) + + Returns the number of leap years in the range from *y1* to *y2* (exclusive), + where *y1* and *y2* are years. + + This function works for ranges spanning a century change. + + +.. function:: weekday(year, month, day) + + Returns the day of the week (``0`` is Monday) for *year* (``1970``--...), + *month* (``1``--``12``), *day* (``1``--``31``). + + +.. function:: weekheader(n) + + Return a header containing abbreviated weekday names. *n* specifies the width in + characters for one weekday. + + +.. function:: monthrange(year, month) + + Returns weekday of first day of the month and number of days in month, for the + specified *year* and *month*. + + +.. function:: monthcalendar(year, month) + + Returns a matrix representing a month's calendar. Each row represents a week; + days outside of the month a represented by zeros. Each week begins with Monday + unless set by :func:`setfirstweekday`. + + +.. function:: prmonth(theyear, themonth, w=0, l=0) + + Prints a month's calendar as returned by :func:`month`. + + +.. function:: month(theyear, themonth, w=0, l=0) + + Returns a month's calendar in a multi-line string using the :meth:`formatmonth` + of the :class:`TextCalendar` class. + + +.. function:: prcal(year, w=0, l=0, c=6, m=3) + + Prints the calendar for an entire year as returned by :func:`calendar`. + + +.. function:: calendar(year, w=2, l=1, c=6, m=3) + + Returns a 3-column calendar for an entire year as a multi-line string using + the :meth:`formatyear` of the :class:`TextCalendar` class. + + +.. function:: timegm(tuple) + + An unrelated but handy function that takes a time tuple such as returned by + the :func:`~time.gmtime` function in the :mod:`time` module, and returns the + corresponding Unix timestamp value, assuming an epoch of 1970, and the POSIX + encoding. In fact, :func:`time.gmtime` and :func:`timegm` are each others' + inverse. + + +The :mod:`calendar` module exports the following data attributes: + +.. data:: day_name + + An array that represents the days of the week in the current locale. + + +.. data:: day_abbr + + An array that represents the abbreviated days of the week in the current locale. + + +.. data:: month_name + + An array that represents the months of the year in the current locale. This + follows normal convention of January being month number 1, so it has a length of + 13 and ``month_name[0]`` is the empty string. + + +.. data:: month_abbr + + An array that represents the abbreviated months of the year in the current + locale. This follows normal convention of January being month number 1, so it + has a length of 13 and ``month_abbr[0]`` is the empty string. + + +.. seealso:: + + Module :mod:`datetime` + Object-oriented interface to dates and times with similar functionality to the + :mod:`time` module. + + Module :mod:`time` + Low-level time related functions. diff --git a/python-3.7.4-docs-html/_sources/library/cgi.rst.txt b/python-3.7.4-docs-html/_sources/library/cgi.rst.txt new file mode 100644 index 0000000..0b1aead --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/cgi.rst.txt @@ -0,0 +1,545 @@ +:mod:`cgi` --- Common Gateway Interface support +=============================================== + +.. module:: cgi + :synopsis: Helpers for running Python scripts via the Common Gateway Interface. + +**Source code:** :source:`Lib/cgi.py` + +.. index:: + pair: WWW; server + pair: CGI; protocol + pair: HTTP; protocol + pair: MIME; headers + single: URL + single: Common Gateway Interface + +-------------- + +Support module for Common Gateway Interface (CGI) scripts. + +This module defines a number of utilities for use by CGI scripts written in +Python. + + +Introduction +------------ + +.. _cgi-intro: + +A CGI script is invoked by an HTTP server, usually to process user input +submitted through an HTML ``
    `` or ```` element. + +Most often, CGI scripts live in the server's special :file:`cgi-bin` directory. +The HTTP server places all sorts of information about the request (such as the +client's hostname, the requested URL, the query string, and lots of other +goodies) in the script's shell environment, executes the script, and sends the +script's output back to the client. + +The script's input is connected to the client too, and sometimes the form data +is read this way; at other times the form data is passed via the "query string" +part of the URL. This module is intended to take care of the different cases +and provide a simpler interface to the Python script. It also provides a number +of utilities that help in debugging scripts, and the latest addition is support +for file uploads from a form (if your browser supports it). + +The output of a CGI script should consist of two sections, separated by a blank +line. The first section contains a number of headers, telling the client what +kind of data is following. Python code to generate a minimal header section +looks like this:: + + print("Content-Type: text/html") # HTML is following + print() # blank line, end of headers + +The second section is usually HTML, which allows the client software to display +nicely formatted text with header, in-line images, etc. Here's Python code that +prints a simple piece of HTML:: + + print("CGI script output") + print("

    This is my first CGI script

    ") + print("Hello, world!") + + +.. _using-the-cgi-module: + +Using the cgi module +-------------------- + +Begin by writing ``import cgi``. + +When you write a new script, consider adding these lines:: + + import cgitb + cgitb.enable() + +This activates a special exception handler that will display detailed reports in +the Web browser if any errors occur. If you'd rather not show the guts of your +program to users of your script, you can have the reports saved to files +instead, with code like this:: + + import cgitb + cgitb.enable(display=0, logdir="/path/to/logdir") + +It's very helpful to use this feature during script development. The reports +produced by :mod:`cgitb` provide information that can save you a lot of time in +tracking down bugs. You can always remove the ``cgitb`` line later when you +have tested your script and are confident that it works correctly. + +To get at submitted form data, use the :class:`FieldStorage` class. If the form +contains non-ASCII characters, use the *encoding* keyword parameter set to the +value of the encoding defined for the document. It is usually contained in the +META tag in the HEAD section of the HTML document or by the +:mailheader:`Content-Type` header). This reads the form contents from the +standard input or the environment (depending on the value of various +environment variables set according to the CGI standard). Since it may consume +standard input, it should be instantiated only once. + +The :class:`FieldStorage` instance can be indexed like a Python dictionary. +It allows membership testing with the :keyword:`in` operator, and also supports +the standard dictionary method :meth:`~dict.keys` and the built-in function +:func:`len`. Form fields containing empty strings are ignored and do not appear +in the dictionary; to keep such values, provide a true value for the optional +*keep_blank_values* keyword parameter when creating the :class:`FieldStorage` +instance. + +For instance, the following code (which assumes that the +:mailheader:`Content-Type` header and blank line have already been printed) +checks that the fields ``name`` and ``addr`` are both set to a non-empty +string:: + + form = cgi.FieldStorage() + if "name" not in form or "addr" not in form: + print("

    Error

    ") + print("Please fill in the name and addr fields.") + return + print("

    name:", form["name"].value) + print("

    addr:", form["addr"].value) + ...further form processing here... + +Here the fields, accessed through ``form[key]``, are themselves instances of +:class:`FieldStorage` (or :class:`MiniFieldStorage`, depending on the form +encoding). The :attr:`~FieldStorage.value` attribute of the instance yields +the string value of the field. The :meth:`~FieldStorage.getvalue` method +returns this string value directly; it also accepts an optional second argument +as a default to return if the requested key is not present. + +If the submitted form data contains more than one field with the same name, the +object retrieved by ``form[key]`` is not a :class:`FieldStorage` or +:class:`MiniFieldStorage` instance but a list of such instances. Similarly, in +this situation, ``form.getvalue(key)`` would return a list of strings. If you +expect this possibility (when your HTML form contains multiple fields with the +same name), use the :meth:`~FieldStorage.getlist` method, which always returns +a list of values (so that you do not need to special-case the single item +case). For example, this code concatenates any number of username fields, +separated by commas:: + + value = form.getlist("username") + usernames = ",".join(value) + +If a field represents an uploaded file, accessing the value via the +:attr:`~FieldStorage.value` attribute or the :meth:`~FieldStorage.getvalue` +method reads the entire file in memory as bytes. This may not be what you +want. You can test for an uploaded file by testing either the +:attr:`~FieldStorage.filename` attribute or the :attr:`~FieldStorage.file` +attribute. You can then read the data from the :attr:`!file` +attribute before it is automatically closed as part of the garbage collection of +the :class:`FieldStorage` instance +(the :func:`~io.RawIOBase.read` and :func:`~io.IOBase.readline` methods will +return bytes):: + + fileitem = form["userfile"] + if fileitem.file: + # It's an uploaded file; count lines + linecount = 0 + while True: + line = fileitem.file.readline() + if not line: break + linecount = linecount + 1 + +:class:`FieldStorage` objects also support being used in a :keyword:`with` +statement, which will automatically close them when done. + +If an error is encountered when obtaining the contents of an uploaded file +(for example, when the user interrupts the form submission by clicking on +a Back or Cancel button) the :attr:`~FieldStorage.done` attribute of the +object for the field will be set to the value -1. + +The file upload draft standard entertains the possibility of uploading multiple +files from one field (using a recursive :mimetype:`multipart/\*` encoding). +When this occurs, the item will be a dictionary-like :class:`FieldStorage` item. +This can be determined by testing its :attr:`!type` attribute, which should be +:mimetype:`multipart/form-data` (or perhaps another MIME type matching +:mimetype:`multipart/\*`). In this case, it can be iterated over recursively +just like the top-level form object. + +When a form is submitted in the "old" format (as the query string or as a single +data part of type :mimetype:`application/x-www-form-urlencoded`), the items will +actually be instances of the class :class:`MiniFieldStorage`. In this case, the +:attr:`!list`, :attr:`!file`, and :attr:`filename` attributes are always ``None``. + +A form submitted via POST that also has a query string will contain both +:class:`FieldStorage` and :class:`MiniFieldStorage` items. + +.. versionchanged:: 3.4 + The :attr:`~FieldStorage.file` attribute is automatically closed upon the + garbage collection of the creating :class:`FieldStorage` instance. + +.. versionchanged:: 3.5 + Added support for the context management protocol to the + :class:`FieldStorage` class. + + +Higher Level Interface +---------------------- + +The previous section explains how to read CGI form data using the +:class:`FieldStorage` class. This section describes a higher level interface +which was added to this class to allow one to do it in a more readable and +intuitive way. The interface doesn't make the techniques described in previous +sections obsolete --- they are still useful to process file uploads efficiently, +for example. + +.. XXX: Is this true ? + +The interface consists of two simple methods. Using the methods you can process +form data in a generic way, without the need to worry whether only one or more +values were posted under one name. + +In the previous section, you learned to write following code anytime you +expected a user to post more than one value under one name:: + + item = form.getvalue("item") + if isinstance(item, list): + # The user is requesting more than one item. + else: + # The user is requesting only one item. + +This situation is common for example when a form contains a group of multiple +checkboxes with the same name:: + + + + +In most situations, however, there's only one form control with a particular +name in a form and then you expect and need only one value associated with this +name. So you write a script containing for example this code:: + + user = form.getvalue("user").upper() + +The problem with the code is that you should never expect that a client will +provide valid input to your scripts. For example, if a curious user appends +another ``user=foo`` pair to the query string, then the script would crash, +because in this situation the ``getvalue("user")`` method call returns a list +instead of a string. Calling the :meth:`~str.upper` method on a list is not valid +(since lists do not have a method of this name) and results in an +:exc:`AttributeError` exception. + +Therefore, the appropriate way to read form data values was to always use the +code which checks whether the obtained value is a single value or a list of +values. That's annoying and leads to less readable scripts. + +A more convenient approach is to use the methods :meth:`~FieldStorage.getfirst` +and :meth:`~FieldStorage.getlist` provided by this higher level interface. + + +.. method:: FieldStorage.getfirst(name, default=None) + + This method always returns only one value associated with form field *name*. + The method returns only the first value in case that more values were posted + under such name. Please note that the order in which the values are received + may vary from browser to browser and should not be counted on. [#]_ If no such + form field or value exists then the method returns the value specified by the + optional parameter *default*. This parameter defaults to ``None`` if not + specified. + + +.. method:: FieldStorage.getlist(name) + + This method always returns a list of values associated with form field *name*. + The method returns an empty list if no such form field or value exists for + *name*. It returns a list consisting of one item if only one such value exists. + +Using these methods you can write nice compact code:: + + import cgi + form = cgi.FieldStorage() + user = form.getfirst("user", "").upper() # This way it's safe. + for item in form.getlist("item"): + do_something(item) + + +.. _functions-in-cgi-module: + +Functions +--------- + +These are useful if you want more control, or if you want to employ some of the +algorithms implemented in this module in other circumstances. + + +.. function:: parse(fp=None, environ=os.environ, keep_blank_values=False, strict_parsing=False) + + Parse a query in the environment or from a file (the file defaults to + ``sys.stdin``). The *keep_blank_values* and *strict_parsing* parameters are + passed to :func:`urllib.parse.parse_qs` unchanged. + + +.. function:: parse_qs(qs, keep_blank_values=False, strict_parsing=False) + + This function is deprecated in this module. Use :func:`urllib.parse.parse_qs` + instead. It is maintained here only for backward compatibility. + + +.. function:: parse_qsl(qs, keep_blank_values=False, strict_parsing=False) + + This function is deprecated in this module. Use :func:`urllib.parse.parse_qsl` + instead. It is maintained here only for backward compatibility. + + +.. function:: parse_multipart(fp, pdict, encoding="utf-8", errors="replace") + + Parse input of type :mimetype:`multipart/form-data` (for file uploads). + Arguments are *fp* for the input file, *pdict* for a dictionary containing + other parameters in the :mailheader:`Content-Type` header, and *encoding*, + the request encoding. + + Returns a dictionary just like :func:`urllib.parse.parse_qs`: keys are the + field names, each value is a list of values for that field. For non-file + fields, the value is a list of strings. + + This is easy to use but not much good if you are expecting megabytes to be + uploaded --- in that case, use the :class:`FieldStorage` class instead + which is much more flexible. + + .. versionchanged:: 3.7 + Added the *encoding* and *errors* parameters. For non-file fields, the + value is now a list of strings, not bytes. + + +.. function:: parse_header(string) + + Parse a MIME header (such as :mailheader:`Content-Type`) into a main value and a + dictionary of parameters. + + +.. function:: test() + + Robust test CGI script, usable as main program. Writes minimal HTTP headers and + formats all information provided to the script in HTML form. + + +.. function:: print_environ() + + Format the shell environment in HTML. + + +.. function:: print_form(form) + + Format a form in HTML. + + +.. function:: print_directory() + + Format the current directory in HTML. + + +.. function:: print_environ_usage() + + Print a list of useful (used by CGI) environment variables in HTML. + + +.. function:: escape(s, quote=False) + + Convert the characters ``'&'``, ``'<'`` and ``'>'`` in string *s* to HTML-safe + sequences. Use this if you need to display text that might contain such + characters in HTML. If the optional flag *quote* is true, the quotation mark + character (``"``) is also translated; this helps for inclusion in an HTML + attribute value delimited by double quotes, as in ````. Note + that single quotes are never translated. + + .. deprecated:: 3.2 + This function is unsafe because *quote* is false by default, and therefore + deprecated. Use :func:`html.escape` instead. + + +.. _cgi-security: + +Caring about security +--------------------- + +.. index:: pair: CGI; security + +There's one important rule: if you invoke an external program (via the +:func:`os.system` or :func:`os.popen` functions. or others with similar +functionality), make very sure you don't pass arbitrary strings received from +the client to the shell. This is a well-known security hole whereby clever +hackers anywhere on the Web can exploit a gullible CGI script to invoke +arbitrary shell commands. Even parts of the URL or field names cannot be +trusted, since the request doesn't have to come from your form! + +To be on the safe side, if you must pass a string gotten from a form to a shell +command, you should make sure the string contains only alphanumeric characters, +dashes, underscores, and periods. + + +Installing your CGI script on a Unix system +------------------------------------------- + +Read the documentation for your HTTP server and check with your local system +administrator to find the directory where CGI scripts should be installed; +usually this is in a directory :file:`cgi-bin` in the server tree. + +Make sure that your script is readable and executable by "others"; the Unix file +mode should be ``0o755`` octal (use ``chmod 0755 filename``). Make sure that the +first line of the script contains ``#!`` starting in column 1 followed by the +pathname of the Python interpreter, for instance:: + + #!/usr/local/bin/python + +Make sure the Python interpreter exists and is executable by "others". + +Make sure that any files your script needs to read or write are readable or +writable, respectively, by "others" --- their mode should be ``0o644`` for +readable and ``0o666`` for writable. This is because, for security reasons, the +HTTP server executes your script as user "nobody", without any special +privileges. It can only read (write, execute) files that everybody can read +(write, execute). The current directory at execution time is also different (it +is usually the server's cgi-bin directory) and the set of environment variables +is also different from what you get when you log in. In particular, don't count +on the shell's search path for executables (:envvar:`PATH`) or the Python module +search path (:envvar:`PYTHONPATH`) to be set to anything interesting. + +If you need to load modules from a directory which is not on Python's default +module search path, you can change the path in your script, before importing +other modules. For example:: + + import sys + sys.path.insert(0, "/usr/home/joe/lib/python") + sys.path.insert(0, "/usr/local/lib/python") + +(This way, the directory inserted last will be searched first!) + +Instructions for non-Unix systems will vary; check your HTTP server's +documentation (it will usually have a section on CGI scripts). + + +Testing your CGI script +----------------------- + +Unfortunately, a CGI script will generally not run when you try it from the +command line, and a script that works perfectly from the command line may fail +mysteriously when run from the server. There's one reason why you should still +test your script from the command line: if it contains a syntax error, the +Python interpreter won't execute it at all, and the HTTP server will most likely +send a cryptic error to the client. + +Assuming your script has no syntax errors, yet it does not work, you have no +choice but to read the next section. + + +Debugging CGI scripts +--------------------- + +.. index:: pair: CGI; debugging + +First of all, check for trivial installation errors --- reading the section +above on installing your CGI script carefully can save you a lot of time. If +you wonder whether you have understood the installation procedure correctly, try +installing a copy of this module file (:file:`cgi.py`) as a CGI script. When +invoked as a script, the file will dump its environment and the contents of the +form in HTML form. Give it the right mode etc, and send it a request. If it's +installed in the standard :file:`cgi-bin` directory, it should be possible to +send it a request by entering a URL into your browser of the form: + +.. code-block:: none + + http://yourhostname/cgi-bin/cgi.py?name=Joe+Blow&addr=At+Home + +If this gives an error of type 404, the server cannot find the script -- perhaps +you need to install it in a different directory. If it gives another error, +there's an installation problem that you should fix before trying to go any +further. If you get a nicely formatted listing of the environment and form +content (in this example, the fields should be listed as "addr" with value "At +Home" and "name" with value "Joe Blow"), the :file:`cgi.py` script has been +installed correctly. If you follow the same procedure for your own script, you +should now be able to debug it. + +The next step could be to call the :mod:`cgi` module's :func:`test` function +from your script: replace its main code with the single statement :: + + cgi.test() + +This should produce the same results as those gotten from installing the +:file:`cgi.py` file itself. + +When an ordinary Python script raises an unhandled exception (for whatever +reason: of a typo in a module name, a file that can't be opened, etc.), the +Python interpreter prints a nice traceback and exits. While the Python +interpreter will still do this when your CGI script raises an exception, most +likely the traceback will end up in one of the HTTP server's log files, or be +discarded altogether. + +Fortunately, once you have managed to get your script to execute *some* code, +you can easily send tracebacks to the Web browser using the :mod:`cgitb` module. +If you haven't done so already, just add the lines:: + + import cgitb + cgitb.enable() + +to the top of your script. Then try running it again; when a problem occurs, +you should see a detailed report that will likely make apparent the cause of the +crash. + +If you suspect that there may be a problem in importing the :mod:`cgitb` module, +you can use an even more robust approach (which only uses built-in modules):: + + import sys + sys.stderr = sys.stdout + print("Content-Type: text/plain") + print() + ...your code here... + +This relies on the Python interpreter to print the traceback. The content type +of the output is set to plain text, which disables all HTML processing. If your +script works, the raw HTML will be displayed by your client. If it raises an +exception, most likely after the first two lines have been printed, a traceback +will be displayed. Because no HTML interpretation is going on, the traceback +will be readable. + + +Common problems and solutions +----------------------------- + +* Most HTTP servers buffer the output from CGI scripts until the script is + completed. This means that it is not possible to display a progress report on + the client's display while the script is running. + +* Check the installation instructions above. + +* Check the HTTP server's log files. (``tail -f logfile`` in a separate window + may be useful!) + +* Always check a script for syntax errors first, by doing something like + ``python script.py``. + +* If your script does not have any syntax errors, try adding ``import cgitb; + cgitb.enable()`` to the top of the script. + +* When invoking external programs, make sure they can be found. Usually, this + means using absolute path names --- :envvar:`PATH` is usually not set to a very + useful value in a CGI script. + +* When reading or writing external files, make sure they can be read or written + by the userid under which your CGI script will be running: this is typically the + userid under which the web server is running, or some explicitly specified + userid for a web server's ``suexec`` feature. + +* Don't try to give a CGI script a set-uid mode. This doesn't work on most + systems, and is a security liability as well. + +.. rubric:: Footnotes + +.. [#] Note that some recent versions of the HTML specification do state what + order the field values should be supplied in, but knowing whether a request + was received from a conforming browser, or even from a browser at all, is + tedious and error-prone. diff --git a/python-3.7.4-docs-html/_sources/library/cgitb.rst.txt b/python-3.7.4-docs-html/_sources/library/cgitb.rst.txt new file mode 100644 index 0000000..5f3a647 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/cgitb.rst.txt @@ -0,0 +1,84 @@ +:mod:`cgitb` --- Traceback manager for CGI scripts +================================================== + +.. module:: cgitb + :synopsis: Configurable traceback handler for CGI scripts. + +.. moduleauthor:: Ka-Ping Yee +.. sectionauthor:: Fred L. Drake, Jr. + +**Source code:** :source:`Lib/cgitb.py` + +.. index:: + single: CGI; exceptions + single: CGI; tracebacks + single: exceptions; in CGI scripts + single: tracebacks; in CGI scripts + +-------------- + +The :mod:`cgitb` module provides a special exception handler for Python scripts. +(Its name is a bit misleading. It was originally designed to display extensive +traceback information in HTML for CGI scripts. It was later generalized to also +display this information in plain text.) After this module is activated, if an +uncaught exception occurs, a detailed, formatted report will be displayed. The +report includes a traceback showing excerpts of the source code for each level, +as well as the values of the arguments and local variables to currently running +functions, to help you debug the problem. Optionally, you can save this +information to a file instead of sending it to the browser. + +To enable this feature, simply add this to the top of your CGI script:: + + import cgitb + cgitb.enable() + +The options to the :func:`enable` function control whether the report is +displayed in the browser and whether the report is logged to a file for later +analysis. + + +.. function:: enable(display=1, logdir=None, context=5, format="html") + + .. index:: single: excepthook() (in module sys) + + This function causes the :mod:`cgitb` module to take over the interpreter's + default handling for exceptions by setting the value of :attr:`sys.excepthook`. + + The optional argument *display* defaults to ``1`` and can be set to ``0`` to + suppress sending the traceback to the browser. If the argument *logdir* is + present, the traceback reports are written to files. The value of *logdir* + should be a directory where these files will be placed. The optional argument + *context* is the number of lines of context to display around the current line + of source code in the traceback; this defaults to ``5``. If the optional + argument *format* is ``"html"``, the output is formatted as HTML. Any other + value forces plain text output. The default value is ``"html"``. + + +.. function:: text(info, context=5) + + This function handles the exception described by *info* (a 3-tuple containing + the result of :func:`sys.exc_info`), formatting its traceback as text and + returning the result as a string. The optional argument *context* is the + number of lines of context to display around the current line of source code + in the traceback; this defaults to ``5``. + + +.. function:: html(info, context=5) + + This function handles the exception described by *info* (a 3-tuple containing + the result of :func:`sys.exc_info`), formatting its traceback as HTML and + returning the result as a string. The optional argument *context* is the + number of lines of context to display around the current line of source code + in the traceback; this defaults to ``5``. + + +.. function:: handler(info=None) + + This function handles an exception using the default settings (that is, show a + report in the browser, but don't log to a file). This can be used when you've + caught an exception and want to report it using :mod:`cgitb`. The optional + *info* argument should be a 3-tuple containing an exception type, exception + value, and traceback object, exactly like the tuple returned by + :func:`sys.exc_info`. If the *info* argument is not supplied, the current + exception is obtained from :func:`sys.exc_info`. + diff --git a/python-3.7.4-docs-html/_sources/library/chunk.rst.txt b/python-3.7.4-docs-html/_sources/library/chunk.rst.txt new file mode 100644 index 0000000..5e24df9 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/chunk.rst.txt @@ -0,0 +1,137 @@ +:mod:`chunk` --- Read IFF chunked data +====================================== + +.. module:: chunk + :synopsis: Module to read IFF chunks. + +.. moduleauthor:: Sjoerd Mullender +.. sectionauthor:: Sjoerd Mullender + +**Source code:** :source:`Lib/chunk.py` + +.. index:: + single: Audio Interchange File Format + single: AIFF + single: AIFF-C + single: Real Media File Format + single: RMFF + +-------------- + +This module provides an interface for reading files that use EA IFF 85 chunks. +[#]_ This format is used in at least the Audio Interchange File Format +(AIFF/AIFF-C) and the Real Media File Format (RMFF). The WAVE audio file format +is closely related and can also be read using this module. + +A chunk has the following structure: + ++---------+--------+-------------------------------+ +| Offset | Length | Contents | ++=========+========+===============================+ +| 0 | 4 | Chunk ID | ++---------+--------+-------------------------------+ +| 4 | 4 | Size of chunk in big-endian | +| | | byte order, not including the | +| | | header | ++---------+--------+-------------------------------+ +| 8 | *n* | Data bytes, where *n* is the | +| | | size given in the preceding | +| | | field | ++---------+--------+-------------------------------+ +| 8 + *n* | 0 or 1 | Pad byte needed if *n* is odd | +| | | and chunk alignment is used | ++---------+--------+-------------------------------+ + +The ID is a 4-byte string which identifies the type of chunk. + +The size field (a 32-bit value, encoded using big-endian byte order) gives the +size of the chunk data, not including the 8-byte header. + +Usually an IFF-type file consists of one or more chunks. The proposed usage of +the :class:`Chunk` class defined here is to instantiate an instance at the start +of each chunk and read from the instance until it reaches the end, after which a +new instance can be instantiated. At the end of the file, creating a new +instance will fail with an :exc:`EOFError` exception. + + +.. class:: Chunk(file, align=True, bigendian=True, inclheader=False) + + Class which represents a chunk. The *file* argument is expected to be a + file-like object. An instance of this class is specifically allowed. The + only method that is needed is :meth:`~io.IOBase.read`. If the methods + :meth:`~io.IOBase.seek` and :meth:`~io.IOBase.tell` are present and don't + raise an exception, they are also used. + If these methods are present and raise an exception, they are expected to not + have altered the object. If the optional argument *align* is true, chunks + are assumed to be aligned on 2-byte boundaries. If *align* is false, no + alignment is assumed. The default value is true. If the optional argument + *bigendian* is false, the chunk size is assumed to be in little-endian order. + This is needed for WAVE audio files. The default value is true. If the + optional argument *inclheader* is true, the size given in the chunk header + includes the size of the header. The default value is false. + + A :class:`Chunk` object supports the following methods: + + + .. method:: getname() + + Returns the name (ID) of the chunk. This is the first 4 bytes of the + chunk. + + + .. method:: getsize() + + Returns the size of the chunk. + + + .. method:: close() + + Close and skip to the end of the chunk. This does not close the + underlying file. + + The remaining methods will raise :exc:`OSError` if called after the + :meth:`close` method has been called. Before Python 3.3, they used to + raise :exc:`IOError`, now an alias of :exc:`OSError`. + + + .. method:: isatty() + + Returns ``False``. + + + .. method:: seek(pos, whence=0) + + Set the chunk's current position. The *whence* argument is optional and + defaults to ``0`` (absolute file positioning); other values are ``1`` + (seek relative to the current position) and ``2`` (seek relative to the + file's end). There is no return value. If the underlying file does not + allow seek, only forward seeks are allowed. + + + .. method:: tell() + + Return the current position into the chunk. + + + .. method:: read(size=-1) + + Read at most *size* bytes from the chunk (less if the read hits the end of + the chunk before obtaining *size* bytes). If the *size* argument is + negative or omitted, read all data until the end of the chunk. An empty + bytes object is returned when the end of the chunk is encountered + immediately. + + + .. method:: skip() + + Skip to the end of the chunk. All further calls to :meth:`read` for the + chunk will return ``b''``. If you are not interested in the contents of + the chunk, this method should be called so that the file points to the + start of the next chunk. + + +.. rubric:: Footnotes + +.. [#] "EA IFF 85" Standard for Interchange Format Files, Jerry Morrison, Electronic + Arts, January 1985. + diff --git a/python-3.7.4-docs-html/_sources/library/cmath.rst.txt b/python-3.7.4-docs-html/_sources/library/cmath.rst.txt new file mode 100644 index 0000000..28cd96b --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/cmath.rst.txt @@ -0,0 +1,316 @@ +:mod:`cmath` --- Mathematical functions for complex numbers +=========================================================== + +.. module:: cmath + :synopsis: Mathematical functions for complex numbers. + +-------------- + +This module provides access to mathematical functions for complex numbers. The +functions in this module accept integers, floating-point numbers or complex +numbers as arguments. They will also accept any Python object that has either a +:meth:`__complex__` or a :meth:`__float__` method: these methods are used to +convert the object to a complex or floating-point number, respectively, and +the function is then applied to the result of the conversion. + +.. note:: + + On platforms with hardware and system-level support for signed + zeros, functions involving branch cuts are continuous on *both* + sides of the branch cut: the sign of the zero distinguishes one + side of the branch cut from the other. On platforms that do not + support signed zeros the continuity is as specified below. + + +Conversions to and from polar coordinates +----------------------------------------- + +A Python complex number ``z`` is stored internally using *rectangular* +or *Cartesian* coordinates. It is completely determined by its *real +part* ``z.real`` and its *imaginary part* ``z.imag``. In other +words:: + + z == z.real + z.imag*1j + +*Polar coordinates* give an alternative way to represent a complex +number. In polar coordinates, a complex number *z* is defined by the +modulus *r* and the phase angle *phi*. The modulus *r* is the distance +from *z* to the origin, while the phase *phi* is the counterclockwise +angle, measured in radians, from the positive x-axis to the line +segment that joins the origin to *z*. + +The following functions can be used to convert from the native +rectangular coordinates to polar coordinates and back. + +.. function:: phase(x) + + Return the phase of *x* (also known as the *argument* of *x*), as a + float. ``phase(x)`` is equivalent to ``math.atan2(x.imag, + x.real)``. The result lies in the range [-\ *π*, *π*], and the branch + cut for this operation lies along the negative real axis, + continuous from above. On systems with support for signed zeros + (which includes most systems in current use), this means that the + sign of the result is the same as the sign of ``x.imag``, even when + ``x.imag`` is zero:: + + >>> phase(complex(-1.0, 0.0)) + 3.141592653589793 + >>> phase(complex(-1.0, -0.0)) + -3.141592653589793 + + +.. note:: + + The modulus (absolute value) of a complex number *x* can be + computed using the built-in :func:`abs` function. There is no + separate :mod:`cmath` module function for this operation. + + +.. function:: polar(x) + + Return the representation of *x* in polar coordinates. Returns a + pair ``(r, phi)`` where *r* is the modulus of *x* and phi is the + phase of *x*. ``polar(x)`` is equivalent to ``(abs(x), + phase(x))``. + + +.. function:: rect(r, phi) + + Return the complex number *x* with polar coordinates *r* and *phi*. + Equivalent to ``r * (math.cos(phi) + math.sin(phi)*1j)``. + + +Power and logarithmic functions +------------------------------- + +.. function:: exp(x) + + Return *e* raised to the power *x*, where *e* is the base of natural + logarithms. + + +.. function:: log(x[, base]) + + Returns the logarithm of *x* to the given *base*. If the *base* is not + specified, returns the natural logarithm of *x*. There is one branch cut, from 0 + along the negative real axis to -∞, continuous from above. + + +.. function:: log10(x) + + Return the base-10 logarithm of *x*. This has the same branch cut as + :func:`log`. + + +.. function:: sqrt(x) + + Return the square root of *x*. This has the same branch cut as :func:`log`. + + +Trigonometric functions +----------------------- + +.. function:: acos(x) + + Return the arc cosine of *x*. There are two branch cuts: One extends right from + 1 along the real axis to ∞, continuous from below. The other extends left from + -1 along the real axis to -∞, continuous from above. + + +.. function:: asin(x) + + Return the arc sine of *x*. This has the same branch cuts as :func:`acos`. + + +.. function:: atan(x) + + Return the arc tangent of *x*. There are two branch cuts: One extends from + ``1j`` along the imaginary axis to ``∞j``, continuous from the right. The + other extends from ``-1j`` along the imaginary axis to ``-∞j``, continuous + from the left. + + +.. function:: cos(x) + + Return the cosine of *x*. + + +.. function:: sin(x) + + Return the sine of *x*. + + +.. function:: tan(x) + + Return the tangent of *x*. + + +Hyperbolic functions +-------------------- + +.. function:: acosh(x) + + Return the inverse hyperbolic cosine of *x*. There is one branch cut, + extending left from 1 along the real axis to -∞, continuous from above. + + +.. function:: asinh(x) + + Return the inverse hyperbolic sine of *x*. There are two branch cuts: + One extends from ``1j`` along the imaginary axis to ``∞j``, + continuous from the right. The other extends from ``-1j`` along + the imaginary axis to ``-∞j``, continuous from the left. + + +.. function:: atanh(x) + + Return the inverse hyperbolic tangent of *x*. There are two branch cuts: One + extends from ``1`` along the real axis to ``∞``, continuous from below. The + other extends from ``-1`` along the real axis to ``-∞``, continuous from + above. + + +.. function:: cosh(x) + + Return the hyperbolic cosine of *x*. + + +.. function:: sinh(x) + + Return the hyperbolic sine of *x*. + + +.. function:: tanh(x) + + Return the hyperbolic tangent of *x*. + + +Classification functions +------------------------ + +.. function:: isfinite(x) + + Return ``True`` if both the real and imaginary parts of *x* are finite, and + ``False`` otherwise. + + .. versionadded:: 3.2 + + +.. function:: isinf(x) + + Return ``True`` if either the real or the imaginary part of *x* is an + infinity, and ``False`` otherwise. + + +.. function:: isnan(x) + + Return ``True`` if either the real or the imaginary part of *x* is a NaN, + and ``False`` otherwise. + + +.. function:: isclose(a, b, *, rel_tol=1e-09, abs_tol=0.0) + + Return ``True`` if the values *a* and *b* are close to each other and + ``False`` otherwise. + + Whether or not two values are considered close is determined according to + given absolute and relative tolerances. + + *rel_tol* is the relative tolerance -- it is the maximum allowed difference + between *a* and *b*, relative to the larger absolute value of *a* or *b*. + For example, to set a tolerance of 5%, pass ``rel_tol=0.05``. The default + tolerance is ``1e-09``, which assures that the two values are the same + within about 9 decimal digits. *rel_tol* must be greater than zero. + + *abs_tol* is the minimum absolute tolerance -- useful for comparisons near + zero. *abs_tol* must be at least zero. + + If no errors occur, the result will be: + ``abs(a-b) <= max(rel_tol * max(abs(a), abs(b)), abs_tol)``. + + The IEEE 754 special values of ``NaN``, ``inf``, and ``-inf`` will be + handled according to IEEE rules. Specifically, ``NaN`` is not considered + close to any other value, including ``NaN``. ``inf`` and ``-inf`` are only + considered close to themselves. + + .. versionadded:: 3.5 + + .. seealso:: + + :pep:`485` -- A function for testing approximate equality + + +Constants +--------- + +.. data:: pi + + The mathematical constant *π*, as a float. + + +.. data:: e + + The mathematical constant *e*, as a float. + + +.. data:: tau + + The mathematical constant *τ*, as a float. + + .. versionadded:: 3.6 + + +.. data:: inf + + Floating-point positive infinity. Equivalent to ``float('inf')``. + + .. versionadded:: 3.6 + + +.. data:: infj + + Complex number with zero real part and positive infinity imaginary + part. Equivalent to ``complex(0.0, float('inf'))``. + + .. versionadded:: 3.6 + + +.. data:: nan + + A floating-point "not a number" (NaN) value. Equivalent to + ``float('nan')``. + + .. versionadded:: 3.6 + + +.. data:: nanj + + Complex number with zero real part and NaN imaginary part. Equivalent to + ``complex(0.0, float('nan'))``. + + .. versionadded:: 3.6 + + +.. index:: module: math + +Note that the selection of functions is similar, but not identical, to that in +module :mod:`math`. The reason for having two modules is that some users aren't +interested in complex numbers, and perhaps don't even know what they are. They +would rather have ``math.sqrt(-1)`` raise an exception than return a complex +number. Also note that the functions defined in :mod:`cmath` always return a +complex number, even if the answer can be expressed as a real number (in which +case the complex number has an imaginary part of zero). + +A note on branch cuts: They are curves along which the given function fails to +be continuous. They are a necessary feature of many complex functions. It is +assumed that if you need to compute with complex functions, you will understand +about branch cuts. Consult almost any (not too elementary) book on complex +variables for enlightenment. For information of the proper choice of branch +cuts for numerical purposes, a good reference should be the following: + + +.. seealso:: + + Kahan, W: Branch cuts for complex elementary functions; or, Much ado about + nothing's sign bit. In Iserles, A., and Powell, M. (eds.), The state of the art + in numerical analysis. Clarendon Press (1987) pp165--211. diff --git a/python-3.7.4-docs-html/_sources/library/cmd.rst.txt b/python-3.7.4-docs-html/_sources/library/cmd.rst.txt new file mode 100644 index 0000000..d57edb7 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/cmd.rst.txt @@ -0,0 +1,381 @@ +:mod:`cmd` --- Support for line-oriented command interpreters +============================================================= + +.. module:: cmd + :synopsis: Build line-oriented command interpreters. + +.. sectionauthor:: Eric S. Raymond + +**Source code:** :source:`Lib/cmd.py` + +-------------- + +The :class:`Cmd` class provides a simple framework for writing line-oriented +command interpreters. These are often useful for test harnesses, administrative +tools, and prototypes that will later be wrapped in a more sophisticated +interface. + +.. class:: Cmd(completekey='tab', stdin=None, stdout=None) + + A :class:`Cmd` instance or subclass instance is a line-oriented interpreter + framework. There is no good reason to instantiate :class:`Cmd` itself; rather, + it's useful as a superclass of an interpreter class you define yourself in order + to inherit :class:`Cmd`'s methods and encapsulate action methods. + + The optional argument *completekey* is the :mod:`readline` name of a completion + key; it defaults to :kbd:`Tab`. If *completekey* is not :const:`None` and + :mod:`readline` is available, command completion is done automatically. + + The optional arguments *stdin* and *stdout* specify the input and output file + objects that the Cmd instance or subclass instance will use for input and + output. If not specified, they will default to :data:`sys.stdin` and + :data:`sys.stdout`. + + If you want a given *stdin* to be used, make sure to set the instance's + :attr:`use_rawinput` attribute to ``False``, otherwise *stdin* will be + ignored. + + +.. _cmd-objects: + +Cmd Objects +----------- + +A :class:`Cmd` instance has the following methods: + + +.. method:: Cmd.cmdloop(intro=None) + + Repeatedly issue a prompt, accept input, parse an initial prefix off the + received input, and dispatch to action methods, passing them the remainder of + the line as argument. + + The optional argument is a banner or intro string to be issued before the first + prompt (this overrides the :attr:`intro` class attribute). + + If the :mod:`readline` module is loaded, input will automatically inherit + :program:`bash`\ -like history-list editing (e.g. :kbd:`Control-P` scrolls back + to the last command, :kbd:`Control-N` forward to the next one, :kbd:`Control-F` + moves the cursor to the right non-destructively, :kbd:`Control-B` moves the + cursor to the left non-destructively, etc.). + + An end-of-file on input is passed back as the string ``'EOF'``. + + .. index:: + single: ? (question mark); in a command interpreter + single: ! (exclamation); in a command interpreter + + An interpreter instance will recognize a command name ``foo`` if and only if it + has a method :meth:`do_foo`. As a special case, a line beginning with the + character ``'?'`` is dispatched to the method :meth:`do_help`. As another + special case, a line beginning with the character ``'!'`` is dispatched to the + method :meth:`do_shell` (if such a method is defined). + + This method will return when the :meth:`postcmd` method returns a true value. + The *stop* argument to :meth:`postcmd` is the return value from the command's + corresponding :meth:`do_\*` method. + + If completion is enabled, completing commands will be done automatically, and + completing of commands args is done by calling :meth:`complete_foo` with + arguments *text*, *line*, *begidx*, and *endidx*. *text* is the string prefix + we are attempting to match: all returned matches must begin with it. *line* is + the current input line with leading whitespace removed, *begidx* and *endidx* + are the beginning and ending indexes of the prefix text, which could be used to + provide different completion depending upon which position the argument is in. + + All subclasses of :class:`Cmd` inherit a predefined :meth:`do_help`. This + method, called with an argument ``'bar'``, invokes the corresponding method + :meth:`help_bar`, and if that is not present, prints the docstring of + :meth:`do_bar`, if available. With no argument, :meth:`do_help` lists all + available help topics (that is, all commands with corresponding + :meth:`help_\*` methods or commands that have docstrings), and also lists any + undocumented commands. + + +.. method:: Cmd.onecmd(str) + + Interpret the argument as though it had been typed in response to the prompt. + This may be overridden, but should not normally need to be; see the + :meth:`precmd` and :meth:`postcmd` methods for useful execution hooks. The + return value is a flag indicating whether interpretation of commands by the + interpreter should stop. If there is a :meth:`do_\*` method for the command + *str*, the return value of that method is returned, otherwise the return value + from the :meth:`default` method is returned. + + +.. method:: Cmd.emptyline() + + Method called when an empty line is entered in response to the prompt. If this + method is not overridden, it repeats the last nonempty command entered. + + +.. method:: Cmd.default(line) + + Method called on an input line when the command prefix is not recognized. If + this method is not overridden, it prints an error message and returns. + + +.. method:: Cmd.completedefault(text, line, begidx, endidx) + + Method called to complete an input line when no command-specific + :meth:`complete_\*` method is available. By default, it returns an empty list. + + +.. method:: Cmd.precmd(line) + + Hook method executed just before the command line *line* is interpreted, but + after the input prompt is generated and issued. This method is a stub in + :class:`Cmd`; it exists to be overridden by subclasses. The return value is + used as the command which will be executed by the :meth:`onecmd` method; the + :meth:`precmd` implementation may re-write the command or simply return *line* + unchanged. + + +.. method:: Cmd.postcmd(stop, line) + + Hook method executed just after a command dispatch is finished. This method is + a stub in :class:`Cmd`; it exists to be overridden by subclasses. *line* is the + command line which was executed, and *stop* is a flag which indicates whether + execution will be terminated after the call to :meth:`postcmd`; this will be the + return value of the :meth:`onecmd` method. The return value of this method will + be used as the new value for the internal flag which corresponds to *stop*; + returning false will cause interpretation to continue. + + +.. method:: Cmd.preloop() + + Hook method executed once when :meth:`cmdloop` is called. This method is a stub + in :class:`Cmd`; it exists to be overridden by subclasses. + + +.. method:: Cmd.postloop() + + Hook method executed once when :meth:`cmdloop` is about to return. This method + is a stub in :class:`Cmd`; it exists to be overridden by subclasses. + + +Instances of :class:`Cmd` subclasses have some public instance variables: + +.. attribute:: Cmd.prompt + + The prompt issued to solicit input. + + +.. attribute:: Cmd.identchars + + The string of characters accepted for the command prefix. + + +.. attribute:: Cmd.lastcmd + + The last nonempty command prefix seen. + + +.. attribute:: Cmd.cmdqueue + + A list of queued input lines. The cmdqueue list is checked in + :meth:`cmdloop` when new input is needed; if it is nonempty, its elements + will be processed in order, as if entered at the prompt. + + +.. attribute:: Cmd.intro + + A string to issue as an intro or banner. May be overridden by giving the + :meth:`cmdloop` method an argument. + + +.. attribute:: Cmd.doc_header + + The header to issue if the help output has a section for documented commands. + + +.. attribute:: Cmd.misc_header + + The header to issue if the help output has a section for miscellaneous help + topics (that is, there are :meth:`help_\*` methods without corresponding + :meth:`do_\*` methods). + + +.. attribute:: Cmd.undoc_header + + The header to issue if the help output has a section for undocumented commands + (that is, there are :meth:`do_\*` methods without corresponding :meth:`help_\*` + methods). + + +.. attribute:: Cmd.ruler + + The character used to draw separator lines under the help-message headers. If + empty, no ruler line is drawn. It defaults to ``'='``. + + +.. attribute:: Cmd.use_rawinput + + A flag, defaulting to true. If true, :meth:`cmdloop` uses :func:`input` to + display a prompt and read the next command; if false, :meth:`sys.stdout.write` + and :meth:`sys.stdin.readline` are used. (This means that by importing + :mod:`readline`, on systems that support it, the interpreter will automatically + support :program:`Emacs`\ -like line editing and command-history keystrokes.) + + +.. _cmd-example: + +Cmd Example +----------- + +.. sectionauthor:: Raymond Hettinger + +The :mod:`cmd` module is mainly useful for building custom shells that let a +user work with a program interactively. + +This section presents a simple example of how to build a shell around a few of +the commands in the :mod:`turtle` module. + +Basic turtle commands such as :meth:`~turtle.forward` are added to a +:class:`Cmd` subclass with method named :meth:`do_forward`. The argument is +converted to a number and dispatched to the turtle module. The docstring is +used in the help utility provided by the shell. + +The example also includes a basic record and playback facility implemented with +the :meth:`~Cmd.precmd` method which is responsible for converting the input to +lowercase and writing the commands to a file. The :meth:`do_playback` method +reads the file and adds the recorded commands to the :attr:`cmdqueue` for +immediate playback:: + + import cmd, sys + from turtle import * + + class TurtleShell(cmd.Cmd): + intro = 'Welcome to the turtle shell. Type help or ? to list commands.\n' + prompt = '(turtle) ' + file = None + + # ----- basic turtle commands ----- + def do_forward(self, arg): + 'Move the turtle forward by the specified distance: FORWARD 10' + forward(*parse(arg)) + def do_right(self, arg): + 'Turn turtle right by given number of degrees: RIGHT 20' + right(*parse(arg)) + def do_left(self, arg): + 'Turn turtle left by given number of degrees: LEFT 90' + left(*parse(arg)) + def do_goto(self, arg): + 'Move turtle to an absolute position with changing orientation. GOTO 100 200' + goto(*parse(arg)) + def do_home(self, arg): + 'Return turtle to the home position: HOME' + home() + def do_circle(self, arg): + 'Draw circle with given radius an options extent and steps: CIRCLE 50' + circle(*parse(arg)) + def do_position(self, arg): + 'Print the current turtle position: POSITION' + print('Current position is %d %d\n' % position()) + def do_heading(self, arg): + 'Print the current turtle heading in degrees: HEADING' + print('Current heading is %d\n' % (heading(),)) + def do_color(self, arg): + 'Set the color: COLOR BLUE' + color(arg.lower()) + def do_undo(self, arg): + 'Undo (repeatedly) the last turtle action(s): UNDO' + def do_reset(self, arg): + 'Clear the screen and return turtle to center: RESET' + reset() + def do_bye(self, arg): + 'Stop recording, close the turtle window, and exit: BYE' + print('Thank you for using Turtle') + self.close() + bye() + return True + + # ----- record and playback ----- + def do_record(self, arg): + 'Save future commands to filename: RECORD rose.cmd' + self.file = open(arg, 'w') + def do_playback(self, arg): + 'Playback commands from a file: PLAYBACK rose.cmd' + self.close() + with open(arg) as f: + self.cmdqueue.extend(f.read().splitlines()) + def precmd(self, line): + line = line.lower() + if self.file and 'playback' not in line: + print(line, file=self.file) + return line + def close(self): + if self.file: + self.file.close() + self.file = None + + def parse(arg): + 'Convert a series of zero or more numbers to an argument tuple' + return tuple(map(int, arg.split())) + + if __name__ == '__main__': + TurtleShell().cmdloop() + + +Here is a sample session with the turtle shell showing the help functions, using +blank lines to repeat commands, and the simple record and playback facility: + +.. code-block:: none + + Welcome to the turtle shell. Type help or ? to list commands. + + (turtle) ? + + Documented commands (type help ): + ======================================== + bye color goto home playback record right + circle forward heading left position reset undo + + (turtle) help forward + Move the turtle forward by the specified distance: FORWARD 10 + (turtle) record spiral.cmd + (turtle) position + Current position is 0 0 + + (turtle) heading + Current heading is 0 + + (turtle) reset + (turtle) circle 20 + (turtle) right 30 + (turtle) circle 40 + (turtle) right 30 + (turtle) circle 60 + (turtle) right 30 + (turtle) circle 80 + (turtle) right 30 + (turtle) circle 100 + (turtle) right 30 + (turtle) circle 120 + (turtle) right 30 + (turtle) circle 120 + (turtle) heading + Current heading is 180 + + (turtle) forward 100 + (turtle) + (turtle) right 90 + (turtle) forward 100 + (turtle) + (turtle) right 90 + (turtle) forward 400 + (turtle) right 90 + (turtle) forward 500 + (turtle) right 90 + (turtle) forward 400 + (turtle) right 90 + (turtle) forward 300 + (turtle) playback spiral.cmd + Current position is 0 0 + + Current heading is 0 + + Current heading is 180 + + (turtle) bye + Thank you for using Turtle diff --git a/python-3.7.4-docs-html/_sources/library/code.rst.txt b/python-3.7.4-docs-html/_sources/library/code.rst.txt new file mode 100644 index 0000000..e2c47ba --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/code.rst.txt @@ -0,0 +1,184 @@ +:mod:`code` --- Interpreter base classes +======================================== + +.. module:: code + :synopsis: Facilities to implement read-eval-print loops. + +**Source code:** :source:`Lib/code.py` + +-------------- + +The ``code`` module provides facilities to implement read-eval-print loops in +Python. Two classes and convenience functions are included which can be used to +build applications which provide an interactive interpreter prompt. + + +.. class:: InteractiveInterpreter(locals=None) + + This class deals with parsing and interpreter state (the user's namespace); it + does not deal with input buffering or prompting or input file naming (the + filename is always passed in explicitly). The optional *locals* argument + specifies the dictionary in which code will be executed; it defaults to a newly + created dictionary with key ``'__name__'`` set to ``'__console__'`` and key + ``'__doc__'`` set to ``None``. + + +.. class:: InteractiveConsole(locals=None, filename="") + + Closely emulate the behavior of the interactive Python interpreter. This class + builds on :class:`InteractiveInterpreter` and adds prompting using the familiar + ``sys.ps1`` and ``sys.ps2``, and input buffering. + + +.. function:: interact(banner=None, readfunc=None, local=None, exitmsg=None) + + Convenience function to run a read-eval-print loop. This creates a new + instance of :class:`InteractiveConsole` and sets *readfunc* to be used as + the :meth:`InteractiveConsole.raw_input` method, if provided. If *local* is + provided, it is passed to the :class:`InteractiveConsole` constructor for + use as the default namespace for the interpreter loop. The :meth:`interact` + method of the instance is then run with *banner* and *exitmsg* passed as the + banner and exit message to use, if provided. The console object is discarded + after use. + + .. versionchanged:: 3.6 + Added *exitmsg* parameter. + + +.. function:: compile_command(source, filename="", symbol="single") + + This function is useful for programs that want to emulate Python's interpreter + main loop (a.k.a. the read-eval-print loop). The tricky part is to determine + when the user has entered an incomplete command that can be completed by + entering more text (as opposed to a complete command or a syntax error). This + function *almost* always makes the same decision as the real interpreter main + loop. + + *source* is the source string; *filename* is the optional filename from which + source was read, defaulting to ``''``; and *symbol* is the optional + grammar start symbol, which should be either ``'single'`` (the default) or + ``'eval'``. + + Returns a code object (the same as ``compile(source, filename, symbol)``) if the + command is complete and valid; ``None`` if the command is incomplete; raises + :exc:`SyntaxError` if the command is complete and contains a syntax error, or + raises :exc:`OverflowError` or :exc:`ValueError` if the command contains an + invalid literal. + + +.. _interpreter-objects: + +Interactive Interpreter Objects +------------------------------- + + +.. method:: InteractiveInterpreter.runsource(source, filename="", symbol="single") + + Compile and run some source in the interpreter. Arguments are the same as for + :func:`compile_command`; the default for *filename* is ``''``, and for + *symbol* is ``'single'``. One several things can happen: + + * The input is incorrect; :func:`compile_command` raised an exception + (:exc:`SyntaxError` or :exc:`OverflowError`). A syntax traceback will be + printed by calling the :meth:`showsyntaxerror` method. :meth:`runsource` + returns ``False``. + + * The input is incomplete, and more input is required; :func:`compile_command` + returned ``None``. :meth:`runsource` returns ``True``. + + * The input is complete; :func:`compile_command` returned a code object. The + code is executed by calling the :meth:`runcode` (which also handles run-time + exceptions, except for :exc:`SystemExit`). :meth:`runsource` returns ``False``. + + The return value can be used to decide whether to use ``sys.ps1`` or ``sys.ps2`` + to prompt the next line. + + +.. method:: InteractiveInterpreter.runcode(code) + + Execute a code object. When an exception occurs, :meth:`showtraceback` is called + to display a traceback. All exceptions are caught except :exc:`SystemExit`, + which is allowed to propagate. + + A note about :exc:`KeyboardInterrupt`: this exception may occur elsewhere in + this code, and may not always be caught. The caller should be prepared to deal + with it. + + +.. method:: InteractiveInterpreter.showsyntaxerror(filename=None) + + Display the syntax error that just occurred. This does not display a stack + trace because there isn't one for syntax errors. If *filename* is given, it is + stuffed into the exception instead of the default filename provided by Python's + parser, because it always uses ``''`` when reading from a string. The + output is written by the :meth:`write` method. + + +.. method:: InteractiveInterpreter.showtraceback() + + Display the exception that just occurred. We remove the first stack item + because it is within the interpreter object implementation. The output is + written by the :meth:`write` method. + + .. versionchanged:: 3.5 The full chained traceback is displayed instead + of just the primary traceback. + + +.. method:: InteractiveInterpreter.write(data) + + Write a string to the standard error stream (``sys.stderr``). Derived classes + should override this to provide the appropriate output handling as needed. + + +.. _console-objects: + +Interactive Console Objects +--------------------------- + +The :class:`InteractiveConsole` class is a subclass of +:class:`InteractiveInterpreter`, and so offers all the methods of the +interpreter objects as well as the following additions. + + +.. method:: InteractiveConsole.interact(banner=None, exitmsg=None) + + Closely emulate the interactive Python console. The optional *banner* argument + specify the banner to print before the first interaction; by default it prints a + banner similar to the one printed by the standard Python interpreter, followed + by the class name of the console object in parentheses (so as not to confuse + this with the real interpreter -- since it's so close!). + + The optional *exitmsg* argument specifies an exit message printed when exiting. + Pass the empty string to suppress the exit message. If *exitmsg* is not given or + ``None``, a default message is printed. + + .. versionchanged:: 3.4 + To suppress printing any banner, pass an empty string. + + .. versionchanged:: 3.6 + Print an exit message when exiting. + + +.. method:: InteractiveConsole.push(line) + + Push a line of source text to the interpreter. The line should not have a + trailing newline; it may have internal newlines. The line is appended to a + buffer and the interpreter's :meth:`runsource` method is called with the + concatenated contents of the buffer as source. If this indicates that the + command was executed or invalid, the buffer is reset; otherwise, the command is + incomplete, and the buffer is left as it was after the line was appended. The + return value is ``True`` if more input is required, ``False`` if the line was + dealt with in some way (this is the same as :meth:`runsource`). + + +.. method:: InteractiveConsole.resetbuffer() + + Remove any unhandled source text from the input buffer. + + +.. method:: InteractiveConsole.raw_input(prompt="") + + Write a prompt and read a line. The returned line does not include the trailing + newline. When the user enters the EOF key sequence, :exc:`EOFError` is raised. + The base implementation reads from ``sys.stdin``; a subclass may replace this + with a different implementation. diff --git a/python-3.7.4-docs-html/_sources/library/codecs.rst.txt b/python-3.7.4-docs-html/_sources/library/codecs.rst.txt new file mode 100644 index 0000000..ff4f493 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/codecs.rst.txt @@ -0,0 +1,1502 @@ +:mod:`codecs` --- Codec registry and base classes +================================================= + +.. module:: codecs + :synopsis: Encode and decode data and streams. + +.. moduleauthor:: Marc-André Lemburg +.. sectionauthor:: Marc-André Lemburg +.. sectionauthor:: Martin v. Löwis + +**Source code:** :source:`Lib/codecs.py` + +.. index:: + single: Unicode + single: Codecs + pair: Codecs; encode + pair: Codecs; decode + single: streams + pair: stackable; streams + +-------------- + +This module defines base classes for standard Python codecs (encoders and +decoders) and provides access to the internal Python codec registry, which +manages the codec and error handling lookup process. Most standard codecs +are :term:`text encodings `, which encode text to bytes, +but there are also codecs provided that encode text to text, and bytes to +bytes. Custom codecs may encode and decode between arbitrary types, but some +module features are restricted to use specifically with +:term:`text encodings `, or with codecs that encode to +:class:`bytes`. + +The module defines the following functions for encoding and decoding with +any codec: + +.. function:: encode(obj, encoding='utf-8', errors='strict') + + Encodes *obj* using the codec registered for *encoding*. + + *Errors* may be given to set the desired error handling scheme. The + default error handler is ``'strict'`` meaning that encoding errors raise + :exc:`ValueError` (or a more codec specific subclass, such as + :exc:`UnicodeEncodeError`). Refer to :ref:`codec-base-classes` for more + information on codec error handling. + +.. function:: decode(obj, encoding='utf-8', errors='strict') + + Decodes *obj* using the codec registered for *encoding*. + + *Errors* may be given to set the desired error handling scheme. The + default error handler is ``'strict'`` meaning that decoding errors raise + :exc:`ValueError` (or a more codec specific subclass, such as + :exc:`UnicodeDecodeError`). Refer to :ref:`codec-base-classes` for more + information on codec error handling. + +The full details for each codec can also be looked up directly: + +.. function:: lookup(encoding) + + Looks up the codec info in the Python codec registry and returns a + :class:`CodecInfo` object as defined below. + + Encodings are first looked up in the registry's cache. If not found, the list of + registered search functions is scanned. If no :class:`CodecInfo` object is + found, a :exc:`LookupError` is raised. Otherwise, the :class:`CodecInfo` object + is stored in the cache and returned to the caller. + +.. class:: CodecInfo(encode, decode, streamreader=None, streamwriter=None, incrementalencoder=None, incrementaldecoder=None, name=None) + + Codec details when looking up the codec registry. The constructor + arguments are stored in attributes of the same name: + + + .. attribute:: name + + The name of the encoding. + + + .. attribute:: encode + decode + + The stateless encoding and decoding functions. These must be + functions or methods which have the same interface as + the :meth:`~Codec.encode` and :meth:`~Codec.decode` methods of Codec + instances (see :ref:`Codec Interface `). + The functions or methods are expected to work in a stateless mode. + + + .. attribute:: incrementalencoder + incrementaldecoder + + Incremental encoder and decoder classes or factory functions. + These have to provide the interface defined by the base classes + :class:`IncrementalEncoder` and :class:`IncrementalDecoder`, + respectively. Incremental codecs can maintain state. + + + .. attribute:: streamwriter + streamreader + + Stream writer and reader classes or factory functions. These have to + provide the interface defined by the base classes + :class:`StreamWriter` and :class:`StreamReader`, respectively. + Stream codecs can maintain state. + +To simplify access to the various codec components, the module provides +these additional functions which use :func:`lookup` for the codec lookup: + +.. function:: getencoder(encoding) + + Look up the codec for the given encoding and return its encoder function. + + Raises a :exc:`LookupError` in case the encoding cannot be found. + + +.. function:: getdecoder(encoding) + + Look up the codec for the given encoding and return its decoder function. + + Raises a :exc:`LookupError` in case the encoding cannot be found. + + +.. function:: getincrementalencoder(encoding) + + Look up the codec for the given encoding and return its incremental encoder + class or factory function. + + Raises a :exc:`LookupError` in case the encoding cannot be found or the codec + doesn't support an incremental encoder. + + +.. function:: getincrementaldecoder(encoding) + + Look up the codec for the given encoding and return its incremental decoder + class or factory function. + + Raises a :exc:`LookupError` in case the encoding cannot be found or the codec + doesn't support an incremental decoder. + + +.. function:: getreader(encoding) + + Look up the codec for the given encoding and return its :class:`StreamReader` + class or factory function. + + Raises a :exc:`LookupError` in case the encoding cannot be found. + + +.. function:: getwriter(encoding) + + Look up the codec for the given encoding and return its :class:`StreamWriter` + class or factory function. + + Raises a :exc:`LookupError` in case the encoding cannot be found. + +Custom codecs are made available by registering a suitable codec search +function: + +.. function:: register(search_function) + + Register a codec search function. Search functions are expected to take one + argument, being the encoding name in all lower case letters, and return a + :class:`CodecInfo` object. In case a search function cannot find + a given encoding, it should return ``None``. + + .. note:: + + Search function registration is not currently reversible, + which may cause problems in some cases, such as unit testing or + module reloading. + +While the builtin :func:`open` and the associated :mod:`io` module are the +recommended approach for working with encoded text files, this module +provides additional utility functions and classes that allow the use of a +wider range of codecs when working with binary files: + +.. function:: open(filename, mode='r', encoding=None, errors='strict', buffering=1) + + Open an encoded file using the given *mode* and return an instance of + :class:`StreamReaderWriter`, providing transparent encoding/decoding. + The default file mode is ``'r'``, meaning to open the file in read mode. + + .. note:: + + Underlying encoded files are always opened in binary mode. + No automatic conversion of ``'\n'`` is done on reading and writing. + The *mode* argument may be any binary mode acceptable to the built-in + :func:`open` function; the ``'b'`` is automatically added. + + *encoding* specifies the encoding which is to be used for the file. + Any encoding that encodes to and decodes from bytes is allowed, and + the data types supported by the file methods depend on the codec used. + + *errors* may be given to define the error handling. It defaults to ``'strict'`` + which causes a :exc:`ValueError` to be raised in case an encoding error occurs. + + *buffering* has the same meaning as for the built-in :func:`open` function. It + defaults to line buffered. + + +.. function:: EncodedFile(file, data_encoding, file_encoding=None, errors='strict') + + Return a :class:`StreamRecoder` instance, a wrapped version of *file* + which provides transparent transcoding. The original file is closed + when the wrapped version is closed. + + Data written to the wrapped file is decoded according to the given + *data_encoding* and then written to the original file as bytes using + *file_encoding*. Bytes read from the original file are decoded + according to *file_encoding*, and the result is encoded + using *data_encoding*. + + If *file_encoding* is not given, it defaults to *data_encoding*. + + *errors* may be given to define the error handling. It defaults to + ``'strict'``, which causes :exc:`ValueError` to be raised in case an encoding + error occurs. + + +.. function:: iterencode(iterator, encoding, errors='strict', **kwargs) + + Uses an incremental encoder to iteratively encode the input provided by + *iterator*. This function is a :term:`generator`. + The *errors* argument (as well as any + other keyword argument) is passed through to the incremental encoder. + + This function requires that the codec accept text :class:`str` objects + to encode. Therefore it does not support bytes-to-bytes encoders such as + ``base64_codec``. + + +.. function:: iterdecode(iterator, encoding, errors='strict', **kwargs) + + Uses an incremental decoder to iteratively decode the input provided by + *iterator*. This function is a :term:`generator`. + The *errors* argument (as well as any + other keyword argument) is passed through to the incremental decoder. + + This function requires that the codec accept :class:`bytes` objects + to decode. Therefore it does not support text-to-text encoders such as + ``rot_13``, although ``rot_13`` may be used equivalently with + :func:`iterencode`. + + +The module also provides the following constants which are useful for reading +and writing to platform dependent files: + + +.. data:: BOM + BOM_BE + BOM_LE + BOM_UTF8 + BOM_UTF16 + BOM_UTF16_BE + BOM_UTF16_LE + BOM_UTF32 + BOM_UTF32_BE + BOM_UTF32_LE + + These constants define various byte sequences, + being Unicode byte order marks (BOMs) for several encodings. They are + used in UTF-16 and UTF-32 data streams to indicate the byte order used, + and in UTF-8 as a Unicode signature. :const:`BOM_UTF16` is either + :const:`BOM_UTF16_BE` or :const:`BOM_UTF16_LE` depending on the platform's + native byte order, :const:`BOM` is an alias for :const:`BOM_UTF16`, + :const:`BOM_LE` for :const:`BOM_UTF16_LE` and :const:`BOM_BE` for + :const:`BOM_UTF16_BE`. The others represent the BOM in UTF-8 and UTF-32 + encodings. + + +.. _codec-base-classes: + +Codec Base Classes +------------------ + +The :mod:`codecs` module defines a set of base classes which define the +interfaces for working with codec objects, and can also be used as the basis +for custom codec implementations. + +Each codec has to define four interfaces to make it usable as codec in Python: +stateless encoder, stateless decoder, stream reader and stream writer. The +stream reader and writers typically reuse the stateless encoder/decoder to +implement the file protocols. Codec authors also need to define how the +codec will handle encoding and decoding errors. + + +.. _surrogateescape: +.. _error-handlers: + +Error Handlers +^^^^^^^^^^^^^^ + +To simplify and standardize error handling, +codecs may implement different error handling schemes by +accepting the *errors* string argument. The following string values are +defined and implemented by all standard Python codecs: + +.. tabularcolumns:: |l|L| + ++-------------------------+-----------------------------------------------+ +| Value | Meaning | ++=========================+===============================================+ +| ``'strict'`` | Raise :exc:`UnicodeError` (or a subclass); | +| | this is the default. Implemented in | +| | :func:`strict_errors`. | ++-------------------------+-----------------------------------------------+ +| ``'ignore'`` | Ignore the malformed data and continue | +| | without further notice. Implemented in | +| | :func:`ignore_errors`. | ++-------------------------+-----------------------------------------------+ + +The following error handlers are only applicable to +:term:`text encodings `: + +.. index:: + single: ? (question mark); replacement character + single: \ (backslash); escape sequence + single: \x; escape sequence + single: \u; escape sequence + single: \U; escape sequence + single: \N; escape sequence + ++-------------------------+-----------------------------------------------+ +| Value | Meaning | ++=========================+===============================================+ +| ``'replace'`` | Replace with a suitable replacement | +| | marker; Python will use the official | +| | ``U+FFFD`` REPLACEMENT CHARACTER for the | +| | built-in codecs on decoding, and '?' on | +| | encoding. Implemented in | +| | :func:`replace_errors`. | ++-------------------------+-----------------------------------------------+ +| ``'xmlcharrefreplace'`` | Replace with the appropriate XML character | +| | reference (only for encoding). Implemented | +| | in :func:`xmlcharrefreplace_errors`. | ++-------------------------+-----------------------------------------------+ +| ``'backslashreplace'`` | Replace with backslashed escape sequences. | +| | Implemented in | +| | :func:`backslashreplace_errors`. | ++-------------------------+-----------------------------------------------+ +| ``'namereplace'`` | Replace with ``\N{...}`` escape sequences | +| | (only for encoding). Implemented in | +| | :func:`namereplace_errors`. | ++-------------------------+-----------------------------------------------+ +| ``'surrogateescape'`` | On decoding, replace byte with individual | +| | surrogate code ranging from ``U+DC80`` to | +| | ``U+DCFF``. This code will then be turned | +| | back into the same byte when the | +| | ``'surrogateescape'`` error handler is used | +| | when encoding the data. (See :pep:`383` for | +| | more.) | ++-------------------------+-----------------------------------------------+ + +In addition, the following error handler is specific to the given codecs: + ++-------------------+------------------------+-------------------------------------------+ +| Value | Codecs | Meaning | ++===================+========================+===========================================+ +|``'surrogatepass'``| utf-8, utf-16, utf-32, | Allow encoding and decoding of surrogate | +| | utf-16-be, utf-16-le, | codes. These codecs normally treat the | +| | utf-32-be, utf-32-le | presence of surrogates as an error. | ++-------------------+------------------------+-------------------------------------------+ + +.. versionadded:: 3.1 + The ``'surrogateescape'`` and ``'surrogatepass'`` error handlers. + +.. versionchanged:: 3.4 + The ``'surrogatepass'`` error handlers now works with utf-16\* and utf-32\* codecs. + +.. versionadded:: 3.5 + The ``'namereplace'`` error handler. + +.. versionchanged:: 3.5 + The ``'backslashreplace'`` error handlers now works with decoding and + translating. + +The set of allowed values can be extended by registering a new named error +handler: + +.. function:: register_error(name, error_handler) + + Register the error handling function *error_handler* under the name *name*. + The *error_handler* argument will be called during encoding and decoding + in case of an error, when *name* is specified as the errors parameter. + + For encoding, *error_handler* will be called with a :exc:`UnicodeEncodeError` + instance, which contains information about the location of the error. The + error handler must either raise this or a different exception, or return a + tuple with a replacement for the unencodable part of the input and a position + where encoding should continue. The replacement may be either :class:`str` or + :class:`bytes`. If the replacement is bytes, the encoder will simply copy + them into the output buffer. If the replacement is a string, the encoder will + encode the replacement. Encoding continues on original input at the + specified position. Negative position values will be treated as being + relative to the end of the input string. If the resulting position is out of + bound an :exc:`IndexError` will be raised. + + Decoding and translating works similarly, except :exc:`UnicodeDecodeError` or + :exc:`UnicodeTranslateError` will be passed to the handler and that the + replacement from the error handler will be put into the output directly. + + +Previously registered error handlers (including the standard error handlers) +can be looked up by name: + +.. function:: lookup_error(name) + + Return the error handler previously registered under the name *name*. + + Raises a :exc:`LookupError` in case the handler cannot be found. + +The following standard error handlers are also made available as module level +functions: + +.. function:: strict_errors(exception) + + Implements the ``'strict'`` error handling: each encoding or + decoding error raises a :exc:`UnicodeError`. + + +.. function:: replace_errors(exception) + + Implements the ``'replace'`` error handling (for :term:`text encodings + ` only): substitutes ``'?'`` for encoding errors + (to be encoded by the codec), and ``'\ufffd'`` (the Unicode replacement + character) for decoding errors. + + +.. function:: ignore_errors(exception) + + Implements the ``'ignore'`` error handling: malformed data is ignored and + encoding or decoding is continued without further notice. + + +.. function:: xmlcharrefreplace_errors(exception) + + Implements the ``'xmlcharrefreplace'`` error handling (for encoding with + :term:`text encodings ` only): the + unencodable character is replaced by an appropriate XML character reference. + + +.. function:: backslashreplace_errors(exception) + + Implements the ``'backslashreplace'`` error handling (for + :term:`text encodings ` only): malformed data is + replaced by a backslashed escape sequence. + +.. function:: namereplace_errors(exception) + + Implements the ``'namereplace'`` error handling (for encoding with + :term:`text encodings ` only): the + unencodable character is replaced by a ``\N{...}`` escape sequence. + + .. versionadded:: 3.5 + + +.. _codec-objects: + +Stateless Encoding and Decoding +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The base :class:`Codec` class defines these methods which also define the +function interfaces of the stateless encoder and decoder: + + +.. method:: Codec.encode(input[, errors]) + + Encodes the object *input* and returns a tuple (output object, length consumed). + For instance, :term:`text encoding` converts + a string object to a bytes object using a particular + character set encoding (e.g., ``cp1252`` or ``iso-8859-1``). + + The *errors* argument defines the error handling to apply. + It defaults to ``'strict'`` handling. + + The method may not store state in the :class:`Codec` instance. Use + :class:`StreamWriter` for codecs which have to keep state in order to make + encoding efficient. + + The encoder must be able to handle zero length input and return an empty object + of the output object type in this situation. + + +.. method:: Codec.decode(input[, errors]) + + Decodes the object *input* and returns a tuple (output object, length + consumed). For instance, for a :term:`text encoding`, decoding converts + a bytes object encoded using a particular + character set encoding to a string object. + + For text encodings and bytes-to-bytes codecs, + *input* must be a bytes object or one which provides the read-only + buffer interface -- for example, buffer objects and memory mapped files. + + The *errors* argument defines the error handling to apply. + It defaults to ``'strict'`` handling. + + The method may not store state in the :class:`Codec` instance. Use + :class:`StreamReader` for codecs which have to keep state in order to make + decoding efficient. + + The decoder must be able to handle zero length input and return an empty object + of the output object type in this situation. + + +Incremental Encoding and Decoding +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The :class:`IncrementalEncoder` and :class:`IncrementalDecoder` classes provide +the basic interface for incremental encoding and decoding. Encoding/decoding the +input isn't done with one call to the stateless encoder/decoder function, but +with multiple calls to the +:meth:`~IncrementalEncoder.encode`/:meth:`~IncrementalDecoder.decode` method of +the incremental encoder/decoder. The incremental encoder/decoder keeps track of +the encoding/decoding process during method calls. + +The joined output of calls to the +:meth:`~IncrementalEncoder.encode`/:meth:`~IncrementalDecoder.decode` method is +the same as if all the single inputs were joined into one, and this input was +encoded/decoded with the stateless encoder/decoder. + + +.. _incremental-encoder-objects: + +IncrementalEncoder Objects +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The :class:`IncrementalEncoder` class is used for encoding an input in multiple +steps. It defines the following methods which every incremental encoder must +define in order to be compatible with the Python codec registry. + + +.. class:: IncrementalEncoder(errors='strict') + + Constructor for an :class:`IncrementalEncoder` instance. + + All incremental encoders must provide this constructor interface. They are free + to add additional keyword arguments, but only the ones defined here are used by + the Python codec registry. + + The :class:`IncrementalEncoder` may implement different error handling schemes + by providing the *errors* keyword argument. See :ref:`error-handlers` for + possible values. + + The *errors* argument will be assigned to an attribute of the same name. + Assigning to this attribute makes it possible to switch between different error + handling strategies during the lifetime of the :class:`IncrementalEncoder` + object. + + + .. method:: encode(object[, final]) + + Encodes *object* (taking the current state of the encoder into account) + and returns the resulting encoded object. If this is the last call to + :meth:`encode` *final* must be true (the default is false). + + + .. method:: reset() + + Reset the encoder to the initial state. The output is discarded: call + ``.encode(object, final=True)``, passing an empty byte or text string + if necessary, to reset the encoder and to get the output. + + + .. method:: getstate() + + Return the current state of the encoder which must be an integer. The + implementation should make sure that ``0`` is the most common + state. (States that are more complicated than integers can be converted + into an integer by marshaling/pickling the state and encoding the bytes + of the resulting string into an integer). + + + .. method:: setstate(state) + + Set the state of the encoder to *state*. *state* must be an encoder state + returned by :meth:`getstate`. + + +.. _incremental-decoder-objects: + +IncrementalDecoder Objects +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The :class:`IncrementalDecoder` class is used for decoding an input in multiple +steps. It defines the following methods which every incremental decoder must +define in order to be compatible with the Python codec registry. + + +.. class:: IncrementalDecoder(errors='strict') + + Constructor for an :class:`IncrementalDecoder` instance. + + All incremental decoders must provide this constructor interface. They are free + to add additional keyword arguments, but only the ones defined here are used by + the Python codec registry. + + The :class:`IncrementalDecoder` may implement different error handling schemes + by providing the *errors* keyword argument. See :ref:`error-handlers` for + possible values. + + The *errors* argument will be assigned to an attribute of the same name. + Assigning to this attribute makes it possible to switch between different error + handling strategies during the lifetime of the :class:`IncrementalDecoder` + object. + + + .. method:: decode(object[, final]) + + Decodes *object* (taking the current state of the decoder into account) + and returns the resulting decoded object. If this is the last call to + :meth:`decode` *final* must be true (the default is false). If *final* is + true the decoder must decode the input completely and must flush all + buffers. If this isn't possible (e.g. because of incomplete byte sequences + at the end of the input) it must initiate error handling just like in the + stateless case (which might raise an exception). + + + .. method:: reset() + + Reset the decoder to the initial state. + + + .. method:: getstate() + + Return the current state of the decoder. This must be a tuple with two + items, the first must be the buffer containing the still undecoded + input. The second must be an integer and can be additional state + info. (The implementation should make sure that ``0`` is the most common + additional state info.) If this additional state info is ``0`` it must be + possible to set the decoder to the state which has no input buffered and + ``0`` as the additional state info, so that feeding the previously + buffered input to the decoder returns it to the previous state without + producing any output. (Additional state info that is more complicated than + integers can be converted into an integer by marshaling/pickling the info + and encoding the bytes of the resulting string into an integer.) + + + .. method:: setstate(state) + + Set the state of the decoder to *state*. *state* must be a decoder state + returned by :meth:`getstate`. + + +Stream Encoding and Decoding +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + +The :class:`StreamWriter` and :class:`StreamReader` classes provide generic +working interfaces which can be used to implement new encoding submodules very +easily. See :mod:`encodings.utf_8` for an example of how this is done. + + +.. _stream-writer-objects: + +StreamWriter Objects +~~~~~~~~~~~~~~~~~~~~ + +The :class:`StreamWriter` class is a subclass of :class:`Codec` and defines the +following methods which every stream writer must define in order to be +compatible with the Python codec registry. + + +.. class:: StreamWriter(stream, errors='strict') + + Constructor for a :class:`StreamWriter` instance. + + All stream writers must provide this constructor interface. They are free to add + additional keyword arguments, but only the ones defined here are used by the + Python codec registry. + + The *stream* argument must be a file-like object open for writing + text or binary data, as appropriate for the specific codec. + + The :class:`StreamWriter` may implement different error handling schemes by + providing the *errors* keyword argument. See :ref:`error-handlers` for + the standard error handlers the underlying stream codec may support. + + The *errors* argument will be assigned to an attribute of the same name. + Assigning to this attribute makes it possible to switch between different error + handling strategies during the lifetime of the :class:`StreamWriter` object. + + .. method:: write(object) + + Writes the object's contents encoded to the stream. + + + .. method:: writelines(list) + + Writes the concatenated list of strings to the stream (possibly by reusing + the :meth:`write` method). The standard bytes-to-bytes codecs + do not support this method. + + + .. method:: reset() + + Flushes and resets the codec buffers used for keeping state. + + Calling this method should ensure that the data on the output is put into + a clean state that allows appending of new fresh data without having to + rescan the whole stream to recover state. + + +In addition to the above methods, the :class:`StreamWriter` must also inherit +all other methods and attributes from the underlying stream. + + +.. _stream-reader-objects: + +StreamReader Objects +~~~~~~~~~~~~~~~~~~~~ + +The :class:`StreamReader` class is a subclass of :class:`Codec` and defines the +following methods which every stream reader must define in order to be +compatible with the Python codec registry. + + +.. class:: StreamReader(stream, errors='strict') + + Constructor for a :class:`StreamReader` instance. + + All stream readers must provide this constructor interface. They are free to add + additional keyword arguments, but only the ones defined here are used by the + Python codec registry. + + The *stream* argument must be a file-like object open for reading + text or binary data, as appropriate for the specific codec. + + The :class:`StreamReader` may implement different error handling schemes by + providing the *errors* keyword argument. See :ref:`error-handlers` for + the standard error handlers the underlying stream codec may support. + + The *errors* argument will be assigned to an attribute of the same name. + Assigning to this attribute makes it possible to switch between different error + handling strategies during the lifetime of the :class:`StreamReader` object. + + The set of allowed values for the *errors* argument can be extended with + :func:`register_error`. + + + .. method:: read([size[, chars, [firstline]]]) + + Decodes data from the stream and returns the resulting object. + + The *chars* argument indicates the number of decoded + code points or bytes to return. The :func:`read` method will + never return more data than requested, but it might return less, + if there is not enough available. + + The *size* argument indicates the approximate maximum + number of encoded bytes or code points to read + for decoding. The decoder can modify this setting as + appropriate. The default value -1 indicates to read and decode as much as + possible. This parameter is intended to + prevent having to decode huge files in one step. + + The *firstline* flag indicates that + it would be sufficient to only return the first + line, if there are decoding errors on later lines. + + The method should use a greedy read strategy meaning that it should read + as much data as is allowed within the definition of the encoding and the + given size, e.g. if optional encoding endings or state markers are + available on the stream, these should be read too. + + + .. method:: readline([size[, keepends]]) + + Read one line from the input stream and return the decoded data. + + *size*, if given, is passed as size argument to the stream's + :meth:`read` method. + + If *keepends* is false line-endings will be stripped from the lines + returned. + + + .. method:: readlines([sizehint[, keepends]]) + + Read all lines available on the input stream and return them as a list of + lines. + + Line-endings are implemented using the codec's decoder method and are + included in the list entries if *keepends* is true. + + *sizehint*, if given, is passed as the *size* argument to the stream's + :meth:`read` method. + + + .. method:: reset() + + Resets the codec buffers used for keeping state. + + Note that no stream repositioning should take place. This method is + primarily intended to be able to recover from decoding errors. + + +In addition to the above methods, the :class:`StreamReader` must also inherit +all other methods and attributes from the underlying stream. + +.. _stream-reader-writer: + +StreamReaderWriter Objects +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The :class:`StreamReaderWriter` is a convenience class that allows wrapping +streams which work in both read and write modes. + +The design is such that one can use the factory functions returned by the +:func:`lookup` function to construct the instance. + + +.. class:: StreamReaderWriter(stream, Reader, Writer, errors='strict') + + Creates a :class:`StreamReaderWriter` instance. *stream* must be a file-like + object. *Reader* and *Writer* must be factory functions or classes providing the + :class:`StreamReader` and :class:`StreamWriter` interface resp. Error handling + is done in the same way as defined for the stream readers and writers. + +:class:`StreamReaderWriter` instances define the combined interfaces of +:class:`StreamReader` and :class:`StreamWriter` classes. They inherit all other +methods and attributes from the underlying stream. + + +.. _stream-recoder-objects: + +StreamRecoder Objects +~~~~~~~~~~~~~~~~~~~~~ + +The :class:`StreamRecoder` translates data from one encoding to another, +which is sometimes useful when dealing with different encoding environments. + +The design is such that one can use the factory functions returned by the +:func:`lookup` function to construct the instance. + + +.. class:: StreamRecoder(stream, encode, decode, Reader, Writer, errors='strict') + + Creates a :class:`StreamRecoder` instance which implements a two-way conversion: + *encode* and *decode* work on the frontend — the data visible to + code calling :meth:`read` and :meth:`write`, while *Reader* and *Writer* + work on the backend — the data in *stream*. + + You can use these objects to do transparent transcodings from e.g. Latin-1 + to UTF-8 and back. + + The *stream* argument must be a file-like object. + + The *encode* and *decode* arguments must + adhere to the :class:`Codec` interface. *Reader* and + *Writer* must be factory functions or classes providing objects of the + :class:`StreamReader` and :class:`StreamWriter` interface respectively. + + Error handling is done in the same way as defined for the stream readers and + writers. + + +:class:`StreamRecoder` instances define the combined interfaces of +:class:`StreamReader` and :class:`StreamWriter` classes. They inherit all other +methods and attributes from the underlying stream. + + +.. _encodings-overview: + +Encodings and Unicode +--------------------- + +Strings are stored internally as sequences of code points in +range ``0x0``--``0x10FFFF``. (See :pep:`393` for +more details about the implementation.) +Once a string object is used outside of CPU and memory, endianness +and how these arrays are stored as bytes become an issue. As with other +codecs, serialising a string into a sequence of bytes is known as *encoding*, +and recreating the string from the sequence of bytes is known as *decoding*. +There are a variety of different text serialisation codecs, which are +collectivity referred to as :term:`text encodings `. + +The simplest text encoding (called ``'latin-1'`` or ``'iso-8859-1'``) maps +the code points 0--255 to the bytes ``0x0``--``0xff``, which means that a string +object that contains code points above ``U+00FF`` can't be encoded with this +codec. Doing so will raise a :exc:`UnicodeEncodeError` that looks +like the following (although the details of the error message may differ): +``UnicodeEncodeError: 'latin-1' codec can't encode character '\u1234' in +position 3: ordinal not in range(256)``. + +There's another group of encodings (the so called charmap encodings) that choose +a different subset of all Unicode code points and how these code points are +mapped to the bytes ``0x0``--``0xff``. To see how this is done simply open +e.g. :file:`encodings/cp1252.py` (which is an encoding that is used primarily on +Windows). There's a string constant with 256 characters that shows you which +character is mapped to which byte value. + +All of these encodings can only encode 256 of the 1114112 code points +defined in Unicode. A simple and straightforward way that can store each Unicode +code point, is to store each code point as four consecutive bytes. There are two +possibilities: store the bytes in big endian or in little endian order. These +two encodings are called ``UTF-32-BE`` and ``UTF-32-LE`` respectively. Their +disadvantage is that if e.g. you use ``UTF-32-BE`` on a little endian machine you +will always have to swap bytes on encoding and decoding. ``UTF-32`` avoids this +problem: bytes will always be in natural endianness. When these bytes are read +by a CPU with a different endianness, then bytes have to be swapped though. To +be able to detect the endianness of a ``UTF-16`` or ``UTF-32`` byte sequence, +there's the so called BOM ("Byte Order Mark"). This is the Unicode character +``U+FEFF``. This character can be prepended to every ``UTF-16`` or ``UTF-32`` +byte sequence. The byte swapped version of this character (``0xFFFE``) is an +illegal character that may not appear in a Unicode text. So when the +first character in an ``UTF-16`` or ``UTF-32`` byte sequence +appears to be a ``U+FFFE`` the bytes have to be swapped on decoding. +Unfortunately the character ``U+FEFF`` had a second purpose as +a ``ZERO WIDTH NO-BREAK SPACE``: a character that has no width and doesn't allow +a word to be split. It can e.g. be used to give hints to a ligature algorithm. +With Unicode 4.0 using ``U+FEFF`` as a ``ZERO WIDTH NO-BREAK SPACE`` has been +deprecated (with ``U+2060`` (``WORD JOINER``) assuming this role). Nevertheless +Unicode software still must be able to handle ``U+FEFF`` in both roles: as a BOM +it's a device to determine the storage layout of the encoded bytes, and vanishes +once the byte sequence has been decoded into a string; as a ``ZERO WIDTH +NO-BREAK SPACE`` it's a normal character that will be decoded like any other. + +There's another encoding that is able to encoding the full range of Unicode +characters: UTF-8. UTF-8 is an 8-bit encoding, which means there are no issues +with byte order in UTF-8. Each byte in a UTF-8 byte sequence consists of two +parts: marker bits (the most significant bits) and payload bits. The marker bits +are a sequence of zero to four ``1`` bits followed by a ``0`` bit. Unicode characters are +encoded like this (with x being payload bits, which when concatenated give the +Unicode character): + ++-----------------------------------+----------------------------------------------+ +| Range | Encoding | ++===================================+==============================================+ +| ``U-00000000`` ... ``U-0000007F`` | 0xxxxxxx | ++-----------------------------------+----------------------------------------------+ +| ``U-00000080`` ... ``U-000007FF`` | 110xxxxx 10xxxxxx | ++-----------------------------------+----------------------------------------------+ +| ``U-00000800`` ... ``U-0000FFFF`` | 1110xxxx 10xxxxxx 10xxxxxx | ++-----------------------------------+----------------------------------------------+ +| ``U-00010000`` ... ``U-0010FFFF`` | 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx | ++-----------------------------------+----------------------------------------------+ + +The least significant bit of the Unicode character is the rightmost x bit. + +As UTF-8 is an 8-bit encoding no BOM is required and any ``U+FEFF`` character in +the decoded string (even if it's the first character) is treated as a ``ZERO +WIDTH NO-BREAK SPACE``. + +Without external information it's impossible to reliably determine which +encoding was used for encoding a string. Each charmap encoding can +decode any random byte sequence. However that's not possible with UTF-8, as +UTF-8 byte sequences have a structure that doesn't allow arbitrary byte +sequences. To increase the reliability with which a UTF-8 encoding can be +detected, Microsoft invented a variant of UTF-8 (that Python 2.5 calls +``"utf-8-sig"``) for its Notepad program: Before any of the Unicode characters +is written to the file, a UTF-8 encoded BOM (which looks like this as a byte +sequence: ``0xef``, ``0xbb``, ``0xbf``) is written. As it's rather improbable +that any charmap encoded file starts with these byte values (which would e.g. +map to + + | LATIN SMALL LETTER I WITH DIAERESIS + | RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK + | INVERTED QUESTION MARK + +in iso-8859-1), this increases the probability that a ``utf-8-sig`` encoding can be +correctly guessed from the byte sequence. So here the BOM is not used to be able +to determine the byte order used for generating the byte sequence, but as a +signature that helps in guessing the encoding. On encoding the utf-8-sig codec +will write ``0xef``, ``0xbb``, ``0xbf`` as the first three bytes to the file. On +decoding ``utf-8-sig`` will skip those three bytes if they appear as the first +three bytes in the file. In UTF-8, the use of the BOM is discouraged and +should generally be avoided. + + +.. _standard-encodings: + +Standard Encodings +------------------ + +Python comes with a number of codecs built-in, either implemented as C functions +or with dictionaries as mapping tables. The following table lists the codecs by +name, together with a few common aliases, and the languages for which the +encoding is likely used. Neither the list of aliases nor the list of languages +is meant to be exhaustive. Notice that spelling alternatives that only differ in +case or use a hyphen instead of an underscore are also valid aliases; therefore, +e.g. ``'utf-8'`` is a valid alias for the ``'utf_8'`` codec. + +.. impl-detail:: + + Some common encodings can bypass the codecs lookup machinery to + improve performance. These optimization opportunities are only + recognized by CPython for a limited set of (case insensitive) + aliases: utf-8, utf8, latin-1, latin1, iso-8859-1, iso8859-1, mbcs + (Windows only), ascii, us-ascii, utf-16, utf16, utf-32, utf32, and + the same using underscores instead of dashes. Using alternative + aliases for these encodings may result in slower execution. + + .. versionchanged:: 3.6 + Optimization opportunity recognized for us-ascii. + +Many of the character sets support the same languages. They vary in individual +characters (e.g. whether the EURO SIGN is supported or not), and in the +assignment of characters to code positions. For the European languages in +particular, the following variants typically exist: + +* an ISO 8859 codeset + +* a Microsoft Windows code page, which is typically derived from an 8859 codeset, + but replaces control characters with additional graphic characters + +* an IBM EBCDIC code page + +* an IBM PC code page, which is ASCII compatible + +.. tabularcolumns:: |l|p{0.3\linewidth}|p{0.3\linewidth}| + ++-----------------+--------------------------------+--------------------------------+ +| Codec | Aliases | Languages | ++=================+================================+================================+ +| ascii | 646, us-ascii | English | ++-----------------+--------------------------------+--------------------------------+ +| big5 | big5-tw, csbig5 | Traditional Chinese | ++-----------------+--------------------------------+--------------------------------+ +| big5hkscs | big5-hkscs, hkscs | Traditional Chinese | ++-----------------+--------------------------------+--------------------------------+ +| cp037 | IBM037, IBM039 | English | ++-----------------+--------------------------------+--------------------------------+ +| cp273 | 273, IBM273, csIBM273 | German | +| | | | +| | | .. versionadded:: 3.4 | ++-----------------+--------------------------------+--------------------------------+ +| cp424 | EBCDIC-CP-HE, IBM424 | Hebrew | ++-----------------+--------------------------------+--------------------------------+ +| cp437 | 437, IBM437 | English | ++-----------------+--------------------------------+--------------------------------+ +| cp500 | EBCDIC-CP-BE, EBCDIC-CP-CH, | Western Europe | +| | IBM500 | | ++-----------------+--------------------------------+--------------------------------+ +| cp720 | | Arabic | ++-----------------+--------------------------------+--------------------------------+ +| cp737 | | Greek | ++-----------------+--------------------------------+--------------------------------+ +| cp775 | IBM775 | Baltic languages | ++-----------------+--------------------------------+--------------------------------+ +| cp850 | 850, IBM850 | Western Europe | ++-----------------+--------------------------------+--------------------------------+ +| cp852 | 852, IBM852 | Central and Eastern Europe | ++-----------------+--------------------------------+--------------------------------+ +| cp855 | 855, IBM855 | Bulgarian, Byelorussian, | +| | | Macedonian, Russian, Serbian | ++-----------------+--------------------------------+--------------------------------+ +| cp856 | | Hebrew | ++-----------------+--------------------------------+--------------------------------+ +| cp857 | 857, IBM857 | Turkish | ++-----------------+--------------------------------+--------------------------------+ +| cp858 | 858, IBM858 | Western Europe | ++-----------------+--------------------------------+--------------------------------+ +| cp860 | 860, IBM860 | Portuguese | ++-----------------+--------------------------------+--------------------------------+ +| cp861 | 861, CP-IS, IBM861 | Icelandic | ++-----------------+--------------------------------+--------------------------------+ +| cp862 | 862, IBM862 | Hebrew | ++-----------------+--------------------------------+--------------------------------+ +| cp863 | 863, IBM863 | Canadian | ++-----------------+--------------------------------+--------------------------------+ +| cp864 | IBM864 | Arabic | ++-----------------+--------------------------------+--------------------------------+ +| cp865 | 865, IBM865 | Danish, Norwegian | ++-----------------+--------------------------------+--------------------------------+ +| cp866 | 866, IBM866 | Russian | ++-----------------+--------------------------------+--------------------------------+ +| cp869 | 869, CP-GR, IBM869 | Greek | ++-----------------+--------------------------------+--------------------------------+ +| cp874 | | Thai | ++-----------------+--------------------------------+--------------------------------+ +| cp875 | | Greek | ++-----------------+--------------------------------+--------------------------------+ +| cp932 | 932, ms932, mskanji, ms-kanji | Japanese | ++-----------------+--------------------------------+--------------------------------+ +| cp949 | 949, ms949, uhc | Korean | ++-----------------+--------------------------------+--------------------------------+ +| cp950 | 950, ms950 | Traditional Chinese | ++-----------------+--------------------------------+--------------------------------+ +| cp1006 | | Urdu | ++-----------------+--------------------------------+--------------------------------+ +| cp1026 | ibm1026 | Turkish | ++-----------------+--------------------------------+--------------------------------+ +| cp1125 | 1125, ibm1125, cp866u, ruscii | Ukrainian | +| | | | +| | | .. versionadded:: 3.4 | ++-----------------+--------------------------------+--------------------------------+ +| cp1140 | ibm1140 | Western Europe | ++-----------------+--------------------------------+--------------------------------+ +| cp1250 | windows-1250 | Central and Eastern Europe | ++-----------------+--------------------------------+--------------------------------+ +| cp1251 | windows-1251 | Bulgarian, Byelorussian, | +| | | Macedonian, Russian, Serbian | ++-----------------+--------------------------------+--------------------------------+ +| cp1252 | windows-1252 | Western Europe | ++-----------------+--------------------------------+--------------------------------+ +| cp1253 | windows-1253 | Greek | ++-----------------+--------------------------------+--------------------------------+ +| cp1254 | windows-1254 | Turkish | ++-----------------+--------------------------------+--------------------------------+ +| cp1255 | windows-1255 | Hebrew | ++-----------------+--------------------------------+--------------------------------+ +| cp1256 | windows-1256 | Arabic | ++-----------------+--------------------------------+--------------------------------+ +| cp1257 | windows-1257 | Baltic languages | ++-----------------+--------------------------------+--------------------------------+ +| cp1258 | windows-1258 | Vietnamese | ++-----------------+--------------------------------+--------------------------------+ +| cp65001 | | Windows only: Windows UTF-8 | +| | | (``CP_UTF8``) | +| | | | +| | | .. versionadded:: 3.3 | ++-----------------+--------------------------------+--------------------------------+ +| euc_jp | eucjp, ujis, u-jis | Japanese | ++-----------------+--------------------------------+--------------------------------+ +| euc_jis_2004 | jisx0213, eucjis2004 | Japanese | ++-----------------+--------------------------------+--------------------------------+ +| euc_jisx0213 | eucjisx0213 | Japanese | ++-----------------+--------------------------------+--------------------------------+ +| euc_kr | euckr, korean, ksc5601, | Korean | +| | ks_c-5601, ks_c-5601-1987, | | +| | ksx1001, ks_x-1001 | | ++-----------------+--------------------------------+--------------------------------+ +| gb2312 | chinese, csiso58gb231280, | Simplified Chinese | +| | euc-cn, euccn, eucgb2312-cn, | | +| | gb2312-1980, gb2312-80, | | +| | iso-ir-58 | | ++-----------------+--------------------------------+--------------------------------+ +| gbk | 936, cp936, ms936 | Unified Chinese | ++-----------------+--------------------------------+--------------------------------+ +| gb18030 | gb18030-2000 | Unified Chinese | ++-----------------+--------------------------------+--------------------------------+ +| hz | hzgb, hz-gb, hz-gb-2312 | Simplified Chinese | ++-----------------+--------------------------------+--------------------------------+ +| iso2022_jp | csiso2022jp, iso2022jp, | Japanese | +| | iso-2022-jp | | ++-----------------+--------------------------------+--------------------------------+ +| iso2022_jp_1 | iso2022jp-1, iso-2022-jp-1 | Japanese | ++-----------------+--------------------------------+--------------------------------+ +| iso2022_jp_2 | iso2022jp-2, iso-2022-jp-2 | Japanese, Korean, Simplified | +| | | Chinese, Western Europe, Greek | ++-----------------+--------------------------------+--------------------------------+ +| iso2022_jp_2004 | iso2022jp-2004, | Japanese | +| | iso-2022-jp-2004 | | ++-----------------+--------------------------------+--------------------------------+ +| iso2022_jp_3 | iso2022jp-3, iso-2022-jp-3 | Japanese | ++-----------------+--------------------------------+--------------------------------+ +| iso2022_jp_ext | iso2022jp-ext, iso-2022-jp-ext | Japanese | ++-----------------+--------------------------------+--------------------------------+ +| iso2022_kr | csiso2022kr, iso2022kr, | Korean | +| | iso-2022-kr | | ++-----------------+--------------------------------+--------------------------------+ +| latin_1 | iso-8859-1, iso8859-1, 8859, | West Europe | +| | cp819, latin, latin1, L1 | | ++-----------------+--------------------------------+--------------------------------+ +| iso8859_2 | iso-8859-2, latin2, L2 | Central and Eastern Europe | ++-----------------+--------------------------------+--------------------------------+ +| iso8859_3 | iso-8859-3, latin3, L3 | Esperanto, Maltese | ++-----------------+--------------------------------+--------------------------------+ +| iso8859_4 | iso-8859-4, latin4, L4 | Baltic languages | ++-----------------+--------------------------------+--------------------------------+ +| iso8859_5 | iso-8859-5, cyrillic | Bulgarian, Byelorussian, | +| | | Macedonian, Russian, Serbian | ++-----------------+--------------------------------+--------------------------------+ +| iso8859_6 | iso-8859-6, arabic | Arabic | ++-----------------+--------------------------------+--------------------------------+ +| iso8859_7 | iso-8859-7, greek, greek8 | Greek | ++-----------------+--------------------------------+--------------------------------+ +| iso8859_8 | iso-8859-8, hebrew | Hebrew | ++-----------------+--------------------------------+--------------------------------+ +| iso8859_9 | iso-8859-9, latin5, L5 | Turkish | ++-----------------+--------------------------------+--------------------------------+ +| iso8859_10 | iso-8859-10, latin6, L6 | Nordic languages | ++-----------------+--------------------------------+--------------------------------+ +| iso8859_11 | iso-8859-11, thai | Thai languages | ++-----------------+--------------------------------+--------------------------------+ +| iso8859_13 | iso-8859-13, latin7, L7 | Baltic languages | ++-----------------+--------------------------------+--------------------------------+ +| iso8859_14 | iso-8859-14, latin8, L8 | Celtic languages | ++-----------------+--------------------------------+--------------------------------+ +| iso8859_15 | iso-8859-15, latin9, L9 | Western Europe | ++-----------------+--------------------------------+--------------------------------+ +| iso8859_16 | iso-8859-16, latin10, L10 | South-Eastern Europe | ++-----------------+--------------------------------+--------------------------------+ +| johab | cp1361, ms1361 | Korean | ++-----------------+--------------------------------+--------------------------------+ +| koi8_r | | Russian | ++-----------------+--------------------------------+--------------------------------+ +| koi8_t | | Tajik | +| | | | +| | | .. versionadded:: 3.5 | ++-----------------+--------------------------------+--------------------------------+ +| koi8_u | | Ukrainian | ++-----------------+--------------------------------+--------------------------------+ +| kz1048 | kz_1048, strk1048_2002, rk1048 | Kazakh | +| | | | +| | | .. versionadded:: 3.5 | ++-----------------+--------------------------------+--------------------------------+ +| mac_cyrillic | maccyrillic | Bulgarian, Byelorussian, | +| | | Macedonian, Russian, Serbian | ++-----------------+--------------------------------+--------------------------------+ +| mac_greek | macgreek | Greek | ++-----------------+--------------------------------+--------------------------------+ +| mac_iceland | maciceland | Icelandic | ++-----------------+--------------------------------+--------------------------------+ +| mac_latin2 | maclatin2, maccentraleurope | Central and Eastern Europe | ++-----------------+--------------------------------+--------------------------------+ +| mac_roman | macroman, macintosh | Western Europe | ++-----------------+--------------------------------+--------------------------------+ +| mac_turkish | macturkish | Turkish | ++-----------------+--------------------------------+--------------------------------+ +| ptcp154 | csptcp154, pt154, cp154, | Kazakh | +| | cyrillic-asian | | ++-----------------+--------------------------------+--------------------------------+ +| shift_jis | csshiftjis, shiftjis, sjis, | Japanese | +| | s_jis | | ++-----------------+--------------------------------+--------------------------------+ +| shift_jis_2004 | shiftjis2004, sjis_2004, | Japanese | +| | sjis2004 | | ++-----------------+--------------------------------+--------------------------------+ +| shift_jisx0213 | shiftjisx0213, sjisx0213, | Japanese | +| | s_jisx0213 | | ++-----------------+--------------------------------+--------------------------------+ +| utf_32 | U32, utf32 | all languages | ++-----------------+--------------------------------+--------------------------------+ +| utf_32_be | UTF-32BE | all languages | ++-----------------+--------------------------------+--------------------------------+ +| utf_32_le | UTF-32LE | all languages | ++-----------------+--------------------------------+--------------------------------+ +| utf_16 | U16, utf16 | all languages | ++-----------------+--------------------------------+--------------------------------+ +| utf_16_be | UTF-16BE | all languages | ++-----------------+--------------------------------+--------------------------------+ +| utf_16_le | UTF-16LE | all languages | ++-----------------+--------------------------------+--------------------------------+ +| utf_7 | U7, unicode-1-1-utf-7 | all languages | ++-----------------+--------------------------------+--------------------------------+ +| utf_8 | U8, UTF, utf8 | all languages | ++-----------------+--------------------------------+--------------------------------+ +| utf_8_sig | | all languages | ++-----------------+--------------------------------+--------------------------------+ + +.. versionchanged:: 3.4 + The utf-16\* and utf-32\* encoders no longer allow surrogate code points + (``U+D800``--``U+DFFF``) to be encoded. + The utf-32\* decoders no longer decode + byte sequences that correspond to surrogate code points. + + +Python Specific Encodings +------------------------- + +A number of predefined codecs are specific to Python, so their codec names have +no meaning outside Python. These are listed in the tables below based on the +expected input and output types (note that while text encodings are the most +common use case for codecs, the underlying codec infrastructure supports +arbitrary data transforms rather than just text encodings). For asymmetric +codecs, the stated purpose describes the encoding direction. + +Text Encodings +^^^^^^^^^^^^^^ + +The following codecs provide :class:`str` to :class:`bytes` encoding and +:term:`bytes-like object` to :class:`str` decoding, similar to the Unicode text +encodings. + +.. tabularcolumns:: |l|p{0.3\linewidth}|p{0.3\linewidth}| + ++--------------------+---------+---------------------------+ +| Codec | Aliases | Purpose | ++====================+=========+===========================+ +| idna | | Implements :rfc:`3490`, | +| | | see also | +| | | :mod:`encodings.idna`. | +| | | Only ``errors='strict'`` | +| | | is supported. | ++--------------------+---------+---------------------------+ +| mbcs | ansi, | Windows only: Encode | +| | dbcs | operand according to the | +| | | ANSI codepage (CP_ACP) | ++--------------------+---------+---------------------------+ +| oem | | Windows only: Encode | +| | | operand according to the | +| | | OEM codepage (CP_OEMCP) | +| | | | +| | | .. versionadded:: 3.6 | ++--------------------+---------+---------------------------+ +| palmos | | Encoding of PalmOS 3.5 | ++--------------------+---------+---------------------------+ +| punycode | | Implements :rfc:`3492`. | +| | | Stateful codecs are not | +| | | supported. | ++--------------------+---------+---------------------------+ +| raw_unicode_escape | | Latin-1 encoding with | +| | | ``\uXXXX`` and | +| | | ``\UXXXXXXXX`` for other | +| | | code points. Existing | +| | | backslashes are not | +| | | escaped in any way. | +| | | It is used in the Python | +| | | pickle protocol. | ++--------------------+---------+---------------------------+ +| undefined | | Raise an exception for | +| | | all conversions, even | +| | | empty strings. The error | +| | | handler is ignored. | ++--------------------+---------+---------------------------+ +| unicode_escape | | Encoding suitable as the | +| | | contents of a Unicode | +| | | literal in ASCII-encoded | +| | | Python source code, | +| | | except that quotes are | +| | | not escaped. Decodes from | +| | | Latin-1 source code. | +| | | Beware that Python source | +| | | code actually uses UTF-8 | +| | | by default. | ++--------------------+---------+---------------------------+ +| unicode_internal | | Return the internal | +| | | representation of the | +| | | operand. Stateful codecs | +| | | are not supported. | +| | | | +| | | .. deprecated:: 3.3 | +| | | This representation is | +| | | obsoleted by | +| | | :pep:`393`. | ++--------------------+---------+---------------------------+ + +.. _binary-transforms: + +Binary Transforms +^^^^^^^^^^^^^^^^^ + +The following codecs provide binary transforms: :term:`bytes-like object` +to :class:`bytes` mappings. They are not supported by :meth:`bytes.decode` +(which only produces :class:`str` output). + + +.. tabularcolumns:: |l|L|L|L| + ++----------------------+------------------+------------------------------+------------------------------+ +| Codec | Aliases | Purpose | Encoder / decoder | ++======================+==================+==============================+==============================+ +| base64_codec [#b64]_ | base64, base_64 | Convert operand to multiline | :meth:`base64.encodebytes` / | +| | | MIME base64 (the result | :meth:`base64.decodebytes` | +| | | always includes a trailing | | +| | | ``'\n'``) | | +| | | | | +| | | .. versionchanged:: 3.4 | | +| | | accepts any | | +| | | :term:`bytes-like object` | | +| | | as input for encoding and | | +| | | decoding | | ++----------------------+------------------+------------------------------+------------------------------+ +| bz2_codec | bz2 | Compress the operand | :meth:`bz2.compress` / | +| | | using bz2 | :meth:`bz2.decompress` | ++----------------------+------------------+------------------------------+------------------------------+ +| hex_codec | hex | Convert operand to | :meth:`binascii.b2a_hex` / | +| | | hexadecimal | :meth:`binascii.a2b_hex` | +| | | representation, with two | | +| | | digits per byte | | ++----------------------+------------------+------------------------------+------------------------------+ +| quopri_codec | quopri, | Convert operand to MIME | :meth:`quopri.encode` with | +| | quotedprintable, | quoted printable | ``quotetabs=True`` / | +| | quoted_printable | | :meth:`quopri.decode` | ++----------------------+------------------+------------------------------+------------------------------+ +| uu_codec | uu | Convert the operand using | :meth:`uu.encode` / | +| | | uuencode | :meth:`uu.decode` | ++----------------------+------------------+------------------------------+------------------------------+ +| zlib_codec | zip, zlib | Compress the operand | :meth:`zlib.compress` / | +| | | using gzip | :meth:`zlib.decompress` | ++----------------------+------------------+------------------------------+------------------------------+ + +.. [#b64] In addition to :term:`bytes-like objects `, + ``'base64_codec'`` also accepts ASCII-only instances of :class:`str` for + decoding + +.. versionadded:: 3.2 + Restoration of the binary transforms. + +.. versionchanged:: 3.4 + Restoration of the aliases for the binary transforms. + + +.. _text-transforms: + +Text Transforms +^^^^^^^^^^^^^^^ + +The following codec provides a text transform: a :class:`str` to :class:`str` +mapping. It is not supported by :meth:`str.encode` (which only produces +:class:`bytes` output). + +.. tabularcolumns:: |l|l|L| + ++--------------------+---------+---------------------------+ +| Codec | Aliases | Purpose | ++====================+=========+===========================+ +| rot_13 | rot13 | Returns the Caesar-cypher | +| | | encryption of the operand | ++--------------------+---------+---------------------------+ + +.. versionadded:: 3.2 + Restoration of the ``rot_13`` text transform. + +.. versionchanged:: 3.4 + Restoration of the ``rot13`` alias. + + +:mod:`encodings.idna` --- Internationalized Domain Names in Applications +------------------------------------------------------------------------ + +.. module:: encodings.idna + :synopsis: Internationalized Domain Names implementation +.. moduleauthor:: Martin v. Löwis + +This module implements :rfc:`3490` (Internationalized Domain Names in +Applications) and :rfc:`3492` (Nameprep: A Stringprep Profile for +Internationalized Domain Names (IDN)). It builds upon the ``punycode`` encoding +and :mod:`stringprep`. + +These RFCs together define a protocol to support non-ASCII characters in domain +names. A domain name containing non-ASCII characters (such as +``www.Alliancefrançaise.nu``) is converted into an ASCII-compatible encoding +(ACE, such as ``www.xn--alliancefranaise-npb.nu``). The ACE form of the domain +name is then used in all places where arbitrary characters are not allowed by +the protocol, such as DNS queries, HTTP :mailheader:`Host` fields, and so +on. This conversion is carried out in the application; if possible invisible to +the user: The application should transparently convert Unicode domain labels to +IDNA on the wire, and convert back ACE labels to Unicode before presenting them +to the user. + +Python supports this conversion in several ways: the ``idna`` codec performs +conversion between Unicode and ACE, separating an input string into labels +based on the separator characters defined in :rfc:`section 3.1 of RFC 3490 <3490#section-3.1>` +and converting each label to ACE as required, and conversely separating an input +byte string into labels based on the ``.`` separator and converting any ACE +labels found into unicode. Furthermore, the :mod:`socket` module +transparently converts Unicode host names to ACE, so that applications need not +be concerned about converting host names themselves when they pass them to the +socket module. On top of that, modules that have host names as function +parameters, such as :mod:`http.client` and :mod:`ftplib`, accept Unicode host +names (:mod:`http.client` then also transparently sends an IDNA hostname in the +:mailheader:`Host` field if it sends that field at all). + +When receiving host names from the wire (such as in reverse name lookup), no +automatic conversion to Unicode is performed: Applications wishing to present +such host names to the user should decode them to Unicode. + +The module :mod:`encodings.idna` also implements the nameprep procedure, which +performs certain normalizations on host names, to achieve case-insensitivity of +international domain names, and to unify similar characters. The nameprep +functions can be used directly if desired. + + +.. function:: nameprep(label) + + Return the nameprepped version of *label*. The implementation currently assumes + query strings, so ``AllowUnassigned`` is true. + + +.. function:: ToASCII(label) + + Convert a label to ASCII, as specified in :rfc:`3490`. ``UseSTD3ASCIIRules`` is + assumed to be false. + + +.. function:: ToUnicode(label) + + Convert a label to Unicode, as specified in :rfc:`3490`. + + +:mod:`encodings.mbcs` --- Windows ANSI codepage +----------------------------------------------- + +.. module:: encodings.mbcs + :synopsis: Windows ANSI codepage + +Encode operand according to the ANSI codepage (CP_ACP). + +.. availability:: Windows only. + +.. versionchanged:: 3.3 + Support any error handler. + +.. versionchanged:: 3.2 + Before 3.2, the *errors* argument was ignored; ``'replace'`` was always used + to encode, and ``'ignore'`` to decode. + + +:mod:`encodings.utf_8_sig` --- UTF-8 codec with BOM signature +------------------------------------------------------------- + +.. module:: encodings.utf_8_sig + :synopsis: UTF-8 codec with BOM signature +.. moduleauthor:: Walter Dörwald + +This module implements a variant of the UTF-8 codec: On encoding a UTF-8 encoded +BOM will be prepended to the UTF-8 encoded bytes. For the stateful encoder this +is only done once (on the first write to the byte stream). For decoding an +optional UTF-8 encoded BOM at the start of the data will be skipped. diff --git a/python-3.7.4-docs-html/_sources/library/codeop.rst.txt b/python-3.7.4-docs-html/_sources/library/codeop.rst.txt new file mode 100644 index 0000000..a52d2c6 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/codeop.rst.txt @@ -0,0 +1,72 @@ +:mod:`codeop` --- Compile Python code +===================================== + +.. module:: codeop + :synopsis: Compile (possibly incomplete) Python code. + +.. sectionauthor:: Moshe Zadka +.. sectionauthor:: Michael Hudson + +**Source code:** :source:`Lib/codeop.py` + +-------------- + +The :mod:`codeop` module provides utilities upon which the Python +read-eval-print loop can be emulated, as is done in the :mod:`code` module. As +a result, you probably don't want to use the module directly; if you want to +include such a loop in your program you probably want to use the :mod:`code` +module instead. + +There are two parts to this job: + +#. Being able to tell if a line of input completes a Python statement: in + short, telling whether to print '``>>>``' or '``...``' next. + +#. Remembering which future statements the user has entered, so subsequent + input can be compiled with these in effect. + +The :mod:`codeop` module provides a way of doing each of these things, and a way +of doing them both. + +To do just the former: + +.. function:: compile_command(source, filename="", symbol="single") + + Tries to compile *source*, which should be a string of Python code and return a + code object if *source* is valid Python code. In that case, the filename + attribute of the code object will be *filename*, which defaults to + ``''``. Returns ``None`` if *source* is *not* valid Python code, but is a + prefix of valid Python code. + + If there is a problem with *source*, an exception will be raised. + :exc:`SyntaxError` is raised if there is invalid Python syntax, and + :exc:`OverflowError` or :exc:`ValueError` if there is an invalid literal. + + The *symbol* argument determines whether *source* is compiled as a statement + (``'single'``, the default) or as an :term:`expression` (``'eval'``). Any + other value will cause :exc:`ValueError` to be raised. + + .. note:: + + It is possible (but not likely) that the parser stops parsing with a + successful outcome before reaching the end of the source; in this case, + trailing symbols may be ignored instead of causing an error. For example, + a backslash followed by two newlines may be followed by arbitrary garbage. + This will be fixed once the API for the parser is better. + + +.. class:: Compile() + + Instances of this class have :meth:`__call__` methods identical in signature to + the built-in function :func:`compile`, but with the difference that if the + instance compiles program text containing a :mod:`__future__` statement, the + instance 'remembers' and compiles all subsequent program texts with the + statement in force. + + +.. class:: CommandCompiler() + + Instances of this class have :meth:`__call__` methods identical in signature to + :func:`compile_command`; the difference is that if the instance compiles program + text containing a ``__future__`` statement, the instance 'remembers' and + compiles all subsequent program texts with the statement in force. diff --git a/python-3.7.4-docs-html/_sources/library/collections.abc.rst.txt b/python-3.7.4-docs-html/_sources/library/collections.abc.rst.txt new file mode 100644 index 0000000..2a3fb14 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/collections.abc.rst.txt @@ -0,0 +1,306 @@ +:mod:`collections.abc` --- Abstract Base Classes for Containers +=============================================================== + +.. module:: collections.abc + :synopsis: Abstract base classes for containers + +.. moduleauthor:: Raymond Hettinger +.. sectionauthor:: Raymond Hettinger + +.. versionadded:: 3.3 + Formerly, this module was part of the :mod:`collections` module. + +**Source code:** :source:`Lib/_collections_abc.py` + +.. testsetup:: * + + from collections import * + import itertools + __name__ = '' + +-------------- + +This module provides :term:`abstract base classes ` that +can be used to test whether a class provides a particular interface; for +example, whether it is hashable or whether it is a mapping. + + +.. _collections-abstract-base-classes: + +Collections Abstract Base Classes +--------------------------------- + +The collections module offers the following :term:`ABCs `: + +.. tabularcolumns:: |l|L|L|L| + +========================== ====================== ======================= ==================================================== +ABC Inherits from Abstract Methods Mixin Methods +========================== ====================== ======================= ==================================================== +:class:`Container` ``__contains__`` +:class:`Hashable` ``__hash__`` +:class:`Iterable` ``__iter__`` +:class:`Iterator` :class:`Iterable` ``__next__`` ``__iter__`` +:class:`Reversible` :class:`Iterable` ``__reversed__`` +:class:`Generator` :class:`Iterator` ``send``, ``throw`` ``close``, ``__iter__``, ``__next__`` +:class:`Sized` ``__len__`` +:class:`Callable` ``__call__`` +:class:`Collection` :class:`Sized`, ``__contains__``, + :class:`Iterable`, ``__iter__``, + :class:`Container` ``__len__`` + +:class:`Sequence` :class:`Reversible`, ``__getitem__``, ``__contains__``, ``__iter__``, ``__reversed__``, + :class:`Collection` ``__len__`` ``index``, and ``count`` + +:class:`MutableSequence` :class:`Sequence` ``__getitem__``, Inherited :class:`Sequence` methods and + ``__setitem__``, ``append``, ``reverse``, ``extend``, ``pop``, + ``__delitem__``, ``remove``, and ``__iadd__`` + ``__len__``, + ``insert`` + +:class:`ByteString` :class:`Sequence` ``__getitem__``, Inherited :class:`Sequence` methods + ``__len__`` + +:class:`Set` :class:`Collection` ``__contains__``, ``__le__``, ``__lt__``, ``__eq__``, ``__ne__``, + ``__iter__``, ``__gt__``, ``__ge__``, ``__and__``, ``__or__``, + ``__len__`` ``__sub__``, ``__xor__``, and ``isdisjoint`` + +:class:`MutableSet` :class:`Set` ``__contains__``, Inherited :class:`Set` methods and + ``__iter__``, ``clear``, ``pop``, ``remove``, ``__ior__``, + ``__len__``, ``__iand__``, ``__ixor__``, and ``__isub__`` + ``add``, + ``discard`` + +:class:`Mapping` :class:`Collection` ``__getitem__``, ``__contains__``, ``keys``, ``items``, ``values``, + ``__iter__``, ``get``, ``__eq__``, and ``__ne__`` + ``__len__`` + +:class:`MutableMapping` :class:`Mapping` ``__getitem__``, Inherited :class:`Mapping` methods and + ``__setitem__``, ``pop``, ``popitem``, ``clear``, ``update``, + ``__delitem__``, and ``setdefault`` + ``__iter__``, + ``__len__`` + + +:class:`MappingView` :class:`Sized` ``__len__`` +:class:`ItemsView` :class:`MappingView`, ``__contains__``, + :class:`Set` ``__iter__`` +:class:`KeysView` :class:`MappingView`, ``__contains__``, + :class:`Set` ``__iter__`` +:class:`ValuesView` :class:`MappingView`, ``__contains__``, ``__iter__`` + :class:`Collection` +:class:`Awaitable` ``__await__`` +:class:`Coroutine` :class:`Awaitable` ``send``, ``throw`` ``close`` +:class:`AsyncIterable` ``__aiter__`` +:class:`AsyncIterator` :class:`AsyncIterable` ``__anext__`` ``__aiter__`` +:class:`AsyncGenerator` :class:`AsyncIterator` ``asend``, ``athrow`` ``aclose``, ``__aiter__``, ``__anext__`` +========================== ====================== ======================= ==================================================== + + +.. class:: Container + Hashable + Sized + Callable + + ABCs for classes that provide respectively the methods :meth:`__contains__`, + :meth:`__hash__`, :meth:`__len__`, and :meth:`__call__`. + +.. class:: Iterable + + ABC for classes that provide the :meth:`__iter__` method. + + Checking ``isinstance(obj, Iterable)`` detects classes that are registered + as :class:`Iterable` or that have an :meth:`__iter__` method, but it does + not detect classes that iterate with the :meth:`__getitem__` method. + The only reliable way to determine whether an object is :term:`iterable` + is to call ``iter(obj)``. + +.. class:: Collection + + ABC for sized iterable container classes. + + .. versionadded:: 3.6 + +.. class:: Iterator + + ABC for classes that provide the :meth:`~iterator.__iter__` and + :meth:`~iterator.__next__` methods. See also the definition of + :term:`iterator`. + +.. class:: Reversible + + ABC for iterable classes that also provide the :meth:`__reversed__` + method. + + .. versionadded:: 3.6 + +.. class:: Generator + + ABC for generator classes that implement the protocol defined in + :pep:`342` that extends iterators with the :meth:`~generator.send`, + :meth:`~generator.throw` and :meth:`~generator.close` methods. + See also the definition of :term:`generator`. + + .. versionadded:: 3.5 + +.. class:: Sequence + MutableSequence + ByteString + + ABCs for read-only and mutable :term:`sequences `. + + Implementation note: Some of the mixin methods, such as + :meth:`__iter__`, :meth:`__reversed__` and :meth:`index`, make + repeated calls to the underlying :meth:`__getitem__` method. + Consequently, if :meth:`__getitem__` is implemented with constant + access speed, the mixin methods will have linear performance; + however, if the underlying method is linear (as it would be with a + linked list), the mixins will have quadratic performance and will + likely need to be overridden. + + .. versionchanged:: 3.5 + The index() method added support for *stop* and *start* + arguments. + +.. class:: Set + MutableSet + + ABCs for read-only and mutable sets. + +.. class:: Mapping + MutableMapping + + ABCs for read-only and mutable :term:`mappings `. + +.. class:: MappingView + ItemsView + KeysView + ValuesView + + ABCs for mapping, items, keys, and values :term:`views `. + +.. class:: Awaitable + + ABC for :term:`awaitable` objects, which can be used in :keyword:`await` + expressions. Custom implementations must provide the :meth:`__await__` + method. + + :term:`Coroutine` objects and instances of the + :class:`~collections.abc.Coroutine` ABC are all instances of this ABC. + + .. note:: + In CPython, generator-based coroutines (generators decorated with + :func:`types.coroutine` or :func:`asyncio.coroutine`) are + *awaitables*, even though they do not have an :meth:`__await__` method. + Using ``isinstance(gencoro, Awaitable)`` for them will return ``False``. + Use :func:`inspect.isawaitable` to detect them. + + .. versionadded:: 3.5 + +.. class:: Coroutine + + ABC for coroutine compatible classes. These implement the + following methods, defined in :ref:`coroutine-objects`: + :meth:`~coroutine.send`, :meth:`~coroutine.throw`, and + :meth:`~coroutine.close`. Custom implementations must also implement + :meth:`__await__`. All :class:`Coroutine` instances are also instances of + :class:`Awaitable`. See also the definition of :term:`coroutine`. + + .. note:: + In CPython, generator-based coroutines (generators decorated with + :func:`types.coroutine` or :func:`asyncio.coroutine`) are + *awaitables*, even though they do not have an :meth:`__await__` method. + Using ``isinstance(gencoro, Coroutine)`` for them will return ``False``. + Use :func:`inspect.isawaitable` to detect them. + + .. versionadded:: 3.5 + +.. class:: AsyncIterable + + ABC for classes that provide ``__aiter__`` method. See also the + definition of :term:`asynchronous iterable`. + + .. versionadded:: 3.5 + +.. class:: AsyncIterator + + ABC for classes that provide ``__aiter__`` and ``__anext__`` + methods. See also the definition of :term:`asynchronous iterator`. + + .. versionadded:: 3.5 + +.. class:: AsyncGenerator + + ABC for asynchronous generator classes that implement the protocol + defined in :pep:`525` and :pep:`492`. + + .. versionadded:: 3.6 + + +These ABCs allow us to ask classes or instances if they provide +particular functionality, for example:: + + size = None + if isinstance(myvar, collections.abc.Sized): + size = len(myvar) + +Several of the ABCs are also useful as mixins that make it easier to develop +classes supporting container APIs. For example, to write a class supporting +the full :class:`Set` API, it is only necessary to supply the three underlying +abstract methods: :meth:`__contains__`, :meth:`__iter__`, and :meth:`__len__`. +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) + + s1 = ListBasedSet('abcdef') + s2 = ListBasedSet('defghi') + overlap = s1 & s2 # The __and__() method is supported automatically + +Notes on using :class:`Set` and :class:`MutableSet` as a mixin: + +(1) + Since some set operations create new sets, the default mixin methods need + a way to create new instances from an iterable. The class constructor is + assumed to have a signature in the form ``ClassName(iterable)``. + That assumption is factored-out to an internal classmethod called + :meth:`_from_iterable` which calls ``cls(iterable)`` to produce a new set. + If the :class:`Set` mixin is being used in a class with a different + constructor signature, you will need to override :meth:`_from_iterable` + with a classmethod that can construct new instances from + an iterable argument. + +(2) + To override the comparisons (presumably for speed, as the + semantics are fixed), redefine :meth:`__le__` and :meth:`__ge__`, + then the other operations will automatically follow suit. + +(3) + The :class:`Set` mixin provides a :meth:`_hash` method to compute a hash value + for the set; however, :meth:`__hash__` is not defined because not all sets + are hashable or immutable. To add set hashability using mixins, + inherit from both :meth:`Set` and :meth:`Hashable`, then define + ``__hash__ = Set._hash``. + +.. seealso:: + + * `OrderedSet recipe `_ for an + example built on :class:`MutableSet`. + + * For more about ABCs, see the :mod:`abc` module and :pep:`3119`. diff --git a/python-3.7.4-docs-html/_sources/library/collections.rst.txt b/python-3.7.4-docs-html/_sources/library/collections.rst.txt new file mode 100644 index 0000000..9f47e89 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/collections.rst.txt @@ -0,0 +1,1251 @@ +:mod:`collections` --- Container datatypes +========================================== + +.. module:: collections + :synopsis: Container datatypes + +.. moduleauthor:: Raymond Hettinger +.. sectionauthor:: Raymond Hettinger + +**Source code:** :source:`Lib/collections/__init__.py` + +.. testsetup:: * + + from collections import * + import itertools + __name__ = '' + +-------------- + +This module implements specialized container datatypes providing alternatives to +Python's general purpose built-in containers, :class:`dict`, :class:`list`, +:class:`set`, and :class:`tuple`. + +===================== ==================================================================== +:func:`namedtuple` factory function for creating tuple subclasses with named fields +:class:`deque` list-like container with fast appends and pops on either end +:class:`ChainMap` dict-like class for creating a single view of multiple mappings +:class:`Counter` dict subclass for counting hashable objects +:class:`OrderedDict` dict subclass that remembers the order entries were added +:class:`defaultdict` dict subclass that calls a factory function to supply missing values +:class:`UserDict` wrapper around dictionary objects for easier dict subclassing +:class:`UserList` wrapper around list objects for easier list subclassing +:class:`UserString` wrapper around string objects for easier string subclassing +===================== ==================================================================== + +.. versionchanged:: 3.3 + Moved :ref:`collections-abstract-base-classes` to the :mod:`collections.abc` module. + For backwards compatibility, they continue to be visible in this module through + Python 3.7. Subsequently, they will be removed entirely. + + +:class:`ChainMap` objects +------------------------- + +.. versionadded:: 3.3 + +A :class:`ChainMap` class is provided for quickly linking a number of mappings +so they can be treated as a single unit. It is often much faster than creating +a new dictionary and running multiple :meth:`~dict.update` calls. + +The class can be used to simulate nested scopes and is useful in templating. + +.. class:: ChainMap(*maps) + + A :class:`ChainMap` groups multiple dicts or other mappings together to + create a single, updateable view. If no *maps* are specified, a single empty + dictionary is provided so that a new chain always has at least one mapping. + + The underlying mappings are stored in a list. That list is public and can + be accessed or updated using the *maps* attribute. There is no other state. + + Lookups search the underlying mappings successively until a key is found. In + contrast, writes, updates, and deletions only operate on the first mapping. + + A :class:`ChainMap` incorporates the underlying mappings by reference. So, if + one of the underlying mappings gets updated, those changes will be reflected + in :class:`ChainMap`. + + All of the usual dictionary methods are supported. In addition, there is a + *maps* attribute, a method for creating new subcontexts, and a property for + accessing all but the first mapping: + + .. attribute:: maps + + A user updateable list of mappings. The list is ordered from + first-searched to last-searched. It is the only stored state and can + be modified to change which mappings are searched. The list should + always contain at least one mapping. + + .. method:: new_child(m=None) + + Returns a new :class:`ChainMap` containing a new map followed by + all of the maps in the current instance. If ``m`` is specified, + it becomes the new map at the front of the list of mappings; if not + specified, an empty dict is used, so that a call to ``d.new_child()`` + is equivalent to: ``ChainMap({}, *d.maps)``. This method is used for + creating subcontexts that can be updated without altering values in any + of the parent mappings. + + .. versionchanged:: 3.4 + The optional ``m`` parameter was added. + + .. attribute:: parents + + Property returning a new :class:`ChainMap` containing all of the maps in + the current instance except the first one. This is useful for skipping + the first map in the search. Use cases are similar to those for the + :keyword:`nonlocal` keyword used in :term:`nested scopes `. The use cases also parallel those for the built-in + :func:`super` function. A reference to ``d.parents`` is equivalent to: + ``ChainMap(*d.maps[1:])``. + + Note, the iteration order of a :class:`ChainMap()` is determined by + scanning the mappings last to first:: + + >>> baseline = {'music': 'bach', 'art': 'rembrandt'} + >>> adjustments = {'art': 'van gogh', 'opera': 'carmen'} + >>> list(ChainMap(adjustments, baseline)) + ['music', 'art', 'opera'] + + This gives the same ordering as a series of :meth:`dict.update` calls + starting with the last mapping:: + + >>> combined = baseline.copy() + >>> combined.update(adjustments) + >>> list(combined) + ['music', 'art', 'opera'] + +.. seealso:: + + * The `MultiContext class + `_ + in the Enthought `CodeTools package + `_ has options to support + writing to any mapping in the chain. + + * Django's `Context class + `_ + for templating is a read-only chain of mappings. It also features + pushing and popping of contexts similar to the + :meth:`~collections.ChainMap.new_child` method and the + :attr:`~collections.ChainMap.parents` property. + + * The `Nested Contexts recipe + `_ has options to control + whether writes and other mutations apply only to the first mapping or to + any mapping in the chain. + + * A `greatly simplified read-only version of Chainmap + `_. + + +:class:`ChainMap` Examples and Recipes +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This section shows various approaches to working with chained maps. + + +Example of simulating Python's internal lookup chain:: + + import builtins + pylookup = ChainMap(locals(), globals(), vars(builtins)) + +Example of letting user specified command-line arguments take precedence over +environment variables which in turn take precedence over default values:: + + import os, argparse + + defaults = {'color': 'red', 'user': 'guest'} + + parser = argparse.ArgumentParser() + parser.add_argument('-u', '--user') + parser.add_argument('-c', '--color') + namespace = parser.parse_args() + command_line_args = {k:v for k, v in vars(namespace).items() if v} + + combined = ChainMap(command_line_args, os.environ, defaults) + print(combined['color']) + print(combined['user']) + +Example patterns for using the :class:`ChainMap` class to simulate nested +contexts:: + + c = ChainMap() # Create root context + d = c.new_child() # Create nested child context + e = c.new_child() # Child of c, independent from d + e.maps[0] # Current context dictionary -- like Python's locals() + e.maps[-1] # Root context -- like Python's globals() + e.parents # Enclosing context chain -- like Python's nonlocals + + d['x'] = 1 # Set value in current context + d['x'] # Get first key in the chain of contexts + del d['x'] # Delete from current context + list(d) # All nested values + k in d # Check all nested values + len(d) # Number of nested values + d.items() # All nested items + dict(d) # Flatten into a regular dictionary + +The :class:`ChainMap` class only makes updates (writes and deletions) to the +first mapping in the chain while lookups will search the full chain. However, +if deep writes and deletions are desired, it is easy to make a subclass that +updates keys found deeper in the chain:: + + class DeepChainMap(ChainMap): + 'Variant of ChainMap that allows direct updates to inner scopes' + + def __setitem__(self, key, value): + for mapping in self.maps: + if key in mapping: + mapping[key] = value + return + self.maps[0][key] = value + + def __delitem__(self, key): + for mapping in self.maps: + if key in mapping: + del mapping[key] + return + raise KeyError(key) + + >>> d = DeepChainMap({'zebra': 'black'}, {'elephant': 'blue'}, {'lion': 'yellow'}) + >>> d['lion'] = 'orange' # update an existing key two levels down + >>> d['snake'] = 'red' # new keys get added to the topmost dict + >>> del d['elephant'] # remove an existing key one level down + >>> d # display result + DeepChainMap({'zebra': 'black', 'snake': 'red'}, {}, {'lion': 'orange'}) + + +:class:`Counter` objects +------------------------ + +A counter tool is provided to support convenient and rapid tallies. +For example:: + + >>> # Tally occurrences of words in a list + >>> cnt = Counter() + >>> for word in ['red', 'blue', 'red', 'green', 'blue', 'blue']: + ... cnt[word] += 1 + >>> cnt + Counter({'blue': 3, 'red': 2, 'green': 1}) + + >>> # Find the ten most common words in Hamlet + >>> import re + >>> words = re.findall(r'\w+', open('hamlet.txt').read().lower()) + >>> Counter(words).most_common(10) + [('the', 1143), ('and', 966), ('to', 762), ('of', 669), ('i', 631), + ('you', 554), ('a', 546), ('my', 514), ('hamlet', 471), ('in', 451)] + +.. class:: Counter([iterable-or-mapping]) + + A :class:`Counter` is a :class:`dict` subclass for counting hashable objects. + It is a collection where elements are stored as dictionary keys + and their counts are stored as dictionary values. Counts are allowed to be + any integer value including zero or negative counts. The :class:`Counter` + class is similar to bags or multisets in other languages. + + Elements are counted from an *iterable* or initialized from another + *mapping* (or counter): + + >>> c = Counter() # a new, empty counter + >>> c = Counter('gallahad') # a new counter from an iterable + >>> c = Counter({'red': 4, 'blue': 2}) # a new counter from a mapping + >>> c = Counter(cats=4, dogs=8) # a new counter from keyword args + + Counter objects have a dictionary interface except that they return a zero + count for missing items instead of raising a :exc:`KeyError`: + + >>> c = Counter(['eggs', 'ham']) + >>> c['bacon'] # count of a missing element is zero + 0 + + Setting a count to zero does not remove an element from a counter. + Use ``del`` to remove it entirely: + + >>> c['sausage'] = 0 # counter entry with a zero count + >>> del c['sausage'] # del actually removes the entry + + .. versionadded:: 3.1 + + + Counter objects support three methods beyond those available for all + dictionaries: + + .. method:: elements() + + Return an iterator over elements repeating each as many times as its + count. Elements are returned in arbitrary order. If an element's count + is less than one, :meth:`elements` will ignore it. + + >>> c = Counter(a=4, b=2, c=0, d=-2) + >>> sorted(c.elements()) + ['a', 'a', 'a', 'a', 'b', 'b'] + + .. method:: most_common([n]) + + Return a list of the *n* most common elements and their counts from the + most common to the least. If *n* is omitted or ``None``, + :meth:`most_common` returns *all* elements in the counter. + Elements with equal counts are ordered arbitrarily: + + >>> Counter('abracadabra').most_common(3) # doctest: +SKIP + [('a', 5), ('r', 2), ('b', 2)] + + .. method:: subtract([iterable-or-mapping]) + + Elements are subtracted from an *iterable* or from another *mapping* + (or counter). Like :meth:`dict.update` but subtracts counts instead + of replacing them. Both inputs and outputs may be zero or negative. + + >>> c = Counter(a=4, b=2, c=0, d=-2) + >>> d = Counter(a=1, b=2, c=3, d=4) + >>> c.subtract(d) + >>> c + Counter({'a': 3, 'b': 0, 'c': -3, 'd': -6}) + + .. versionadded:: 3.2 + + The usual dictionary methods are available for :class:`Counter` objects + except for two which work differently for counters. + + .. method:: fromkeys(iterable) + + This class method is not implemented for :class:`Counter` objects. + + .. method:: update([iterable-or-mapping]) + + Elements are counted from an *iterable* or added-in from another + *mapping* (or counter). Like :meth:`dict.update` but adds counts + instead of replacing them. Also, the *iterable* is expected to be a + sequence of elements, not a sequence of ``(key, value)`` pairs. + +Common patterns for working with :class:`Counter` objects:: + + sum(c.values()) # total of all counts + c.clear() # reset all counts + list(c) # list unique elements + set(c) # convert to a set + dict(c) # convert to a regular dictionary + c.items() # convert to a list of (elem, cnt) pairs + Counter(dict(list_of_pairs)) # convert from a list of (elem, cnt) pairs + c.most_common()[:-n-1:-1] # n least common elements + +c # remove zero and negative counts + +Several mathematical operations are provided for combining :class:`Counter` +objects to produce multisets (counters that have counts greater than zero). +Addition and subtraction combine counters by adding or subtracting the counts +of corresponding elements. Intersection and union return the minimum and +maximum of corresponding counts. Each operation can accept inputs with signed +counts, but the output will exclude results with counts of zero or less. + + >>> c = Counter(a=3, b=1) + >>> d = Counter(a=1, b=2) + >>> c + d # add two counters together: c[x] + d[x] + Counter({'a': 4, 'b': 3}) + >>> c - d # subtract (keeping only positive counts) + Counter({'a': 2}) + >>> c & d # intersection: min(c[x], d[x]) # doctest: +SKIP + Counter({'a': 1, 'b': 1}) + >>> c | d # union: max(c[x], d[x]) + Counter({'a': 3, 'b': 2}) + +Unary addition and subtraction are shortcuts for adding an empty counter +or subtracting from an empty counter. + + >>> c = Counter(a=2, b=-4) + >>> +c + Counter({'a': 2}) + >>> -c + Counter({'b': 4}) + +.. versionadded:: 3.3 + Added support for unary plus, unary minus, and in-place multiset operations. + +.. note:: + + Counters were primarily designed to work with positive integers to represent + running counts; however, care was taken to not unnecessarily preclude use + cases needing other types or negative values. To help with those use cases, + this section documents the minimum range and type restrictions. + + * The :class:`Counter` class itself is a dictionary subclass with no + restrictions on its keys and values. The values are intended to be numbers + representing counts, but you *could* store anything in the value field. + + * The :meth:`~Counter.most_common` method requires only that the values be orderable. + + * For in-place operations such as ``c[key] += 1``, the value type need only + support addition and subtraction. So fractions, floats, and decimals would + work and negative values are supported. The same is also true for + :meth:`~Counter.update` and :meth:`~Counter.subtract` which allow negative and zero values + for both inputs and outputs. + + * The multiset methods are designed only for use cases with positive values. + The inputs may be negative or zero, but only outputs with positive values + are created. There are no type restrictions, but the value type needs to + support addition, subtraction, and comparison. + + * The :meth:`~Counter.elements` method requires integer counts. It ignores zero and + negative counts. + +.. seealso:: + + * `Bag class `_ + in Smalltalk. + + * Wikipedia entry for `Multisets `_. + + * `C++ multisets `_ + tutorial with examples. + + * For mathematical operations on multisets and their use cases, see + *Knuth, Donald. The Art of Computer Programming Volume II, + Section 4.6.3, Exercise 19*. + + * To enumerate all distinct multisets of a given size over a given set of + elements, see :func:`itertools.combinations_with_replacement`:: + + map(Counter, combinations_with_replacement('ABC', 2)) # --> AA AB AC BB BC CC + + +:class:`deque` objects +---------------------- + +.. class:: deque([iterable, [maxlen]]) + + Returns a new deque object initialized left-to-right (using :meth:`append`) with + data from *iterable*. If *iterable* is not specified, the new deque is empty. + + Deques are a generalization of stacks and queues (the name is pronounced "deck" + and is short for "double-ended queue"). Deques support thread-safe, memory + efficient appends and pops from either side of the deque with approximately the + same O(1) performance in either direction. + + Though :class:`list` objects support similar operations, they are optimized for + fast fixed-length operations and incur O(n) memory movement costs for + ``pop(0)`` and ``insert(0, v)`` operations which change both the size and + position of the underlying data representation. + + + If *maxlen* is not specified or is ``None``, deques may grow to an + arbitrary length. Otherwise, the deque is bounded to the specified maximum + length. Once a bounded length deque is full, when new items are added, a + corresponding number of items are discarded from the opposite end. Bounded + length deques provide functionality similar to the ``tail`` filter in + Unix. They are also useful for tracking transactions and other pools of data + where only the most recent activity is of interest. + + + Deque objects support the following methods: + + .. method:: append(x) + + Add *x* to the right side of the deque. + + + .. method:: appendleft(x) + + Add *x* to the left side of the deque. + + + .. method:: clear() + + Remove all elements from the deque leaving it with length 0. + + + .. method:: copy() + + Create a shallow copy of the deque. + + .. versionadded:: 3.5 + + + .. method:: count(x) + + Count the number of deque elements equal to *x*. + + .. versionadded:: 3.2 + + + .. method:: extend(iterable) + + Extend the right side of the deque by appending elements from the iterable + argument. + + + .. method:: extendleft(iterable) + + Extend the left side of the deque by appending elements from *iterable*. + Note, the series of left appends results in reversing the order of + elements in the iterable argument. + + + .. method:: index(x[, start[, stop]]) + + Return the position of *x* in the deque (at or after index *start* + and before index *stop*). Returns the first match or raises + :exc:`ValueError` if not found. + + .. versionadded:: 3.5 + + + .. method:: insert(i, x) + + Insert *x* into the deque at position *i*. + + If the insertion would cause a bounded deque to grow beyond *maxlen*, + an :exc:`IndexError` is raised. + + .. versionadded:: 3.5 + + + .. method:: pop() + + Remove and return an element from the right side of the deque. If no + elements are present, raises an :exc:`IndexError`. + + + .. method:: popleft() + + Remove and return an element from the left side of the deque. If no + elements are present, raises an :exc:`IndexError`. + + + .. method:: remove(value) + + Remove the first occurrence of *value*. If not found, raises a + :exc:`ValueError`. + + + .. method:: reverse() + + Reverse the elements of the deque in-place and then return ``None``. + + .. versionadded:: 3.2 + + + .. method:: rotate(n=1) + + Rotate the deque *n* steps to the right. If *n* is negative, rotate + to the left. + + When the deque is not empty, rotating one step to the right is equivalent + to ``d.appendleft(d.pop())``, and rotating one step to the left is + equivalent to ``d.append(d.popleft())``. + + + Deque objects also provide one read-only attribute: + + .. attribute:: maxlen + + Maximum size of a deque or ``None`` if unbounded. + + .. versionadded:: 3.1 + + +In addition to the above, deques support iteration, pickling, ``len(d)``, +``reversed(d)``, ``copy.copy(d)``, ``copy.deepcopy(d)``, membership testing with +the :keyword:`in` operator, and subscript references such as ``d[-1]``. Indexed +access is O(1) at both ends but slows to O(n) in the middle. For fast random +access, use lists instead. + +Starting in version 3.5, deques support ``__add__()``, ``__mul__()``, +and ``__imul__()``. + +Example: + +.. doctest:: + + >>> from collections import deque + >>> d = deque('ghi') # make a new deque with three items + >>> for elem in d: # iterate over the deque's elements + ... print(elem.upper()) + G + H + I + + >>> d.append('j') # add a new entry to the right side + >>> d.appendleft('f') # add a new entry to the left side + >>> d # show the representation of the deque + deque(['f', 'g', 'h', 'i', 'j']) + + >>> d.pop() # return and remove the rightmost item + 'j' + >>> d.popleft() # return and remove the leftmost item + 'f' + >>> list(d) # list the contents of the deque + ['g', 'h', 'i'] + >>> d[0] # peek at leftmost item + 'g' + >>> d[-1] # peek at rightmost item + 'i' + + >>> list(reversed(d)) # list the contents of a deque in reverse + ['i', 'h', 'g'] + >>> 'h' in d # search the deque + True + >>> d.extend('jkl') # add multiple elements at once + >>> d + deque(['g', 'h', 'i', 'j', 'k', 'l']) + >>> d.rotate(1) # right rotation + >>> d + deque(['l', 'g', 'h', 'i', 'j', 'k']) + >>> d.rotate(-1) # left rotation + >>> d + deque(['g', 'h', 'i', 'j', 'k', 'l']) + + >>> deque(reversed(d)) # make a new deque in reverse order + deque(['l', 'k', 'j', 'i', 'h', 'g']) + >>> d.clear() # empty the deque + >>> d.pop() # cannot pop from an empty deque + Traceback (most recent call last): + File "", line 1, in -toplevel- + d.pop() + IndexError: pop from an empty deque + + >>> d.extendleft('abc') # extendleft() reverses the input order + >>> d + deque(['c', 'b', 'a']) + + +:class:`deque` Recipes +^^^^^^^^^^^^^^^^^^^^^^ + +This section shows various approaches to working with deques. + +Bounded length deques provide functionality similar to the ``tail`` filter +in Unix:: + + def tail(filename, n=10): + 'Return the last n lines of a file' + with open(filename) as f: + return deque(f, n) + +Another approach to using deques is to maintain a sequence of recently +added elements by appending to the right and popping to the left:: + + def moving_average(iterable, n=3): + # moving_average([40, 30, 50, 46, 39, 44]) --> 40.0 42.0 45.0 43.0 + # http://en.wikipedia.org/wiki/Moving_average + it = iter(iterable) + d = deque(itertools.islice(it, n-1)) + d.appendleft(0) + s = sum(d) + for elem in it: + s += elem - d.popleft() + d.append(elem) + yield s / n + +A `round-robin scheduler +`_ can be implemented with +input iterators stored in a :class:`deque`. Values are yielded from the active +iterator in position zero. If that iterator is exhausted, it can be removed +with :meth:`~deque.popleft`; otherwise, it can be cycled back to the end with +the :meth:`~deque.rotate` method:: + + def roundrobin(*iterables): + "roundrobin('ABC', 'D', 'EF') --> A D E B F C" + iterators = deque(map(iter, iterables)) + while iterators: + try: + while True: + yield next(iterators[0]) + iterators.rotate(-1) + except StopIteration: + # Remove an exhausted iterator. + iterators.popleft() + +The :meth:`~deque.rotate` method provides a way to implement :class:`deque` slicing and +deletion. For example, a pure Python implementation of ``del d[n]`` relies on +the ``rotate()`` method to position elements to be popped:: + + def delete_nth(d, n): + d.rotate(-n) + d.popleft() + d.rotate(n) + +To implement :class:`deque` slicing, use a similar approach applying +:meth:`~deque.rotate` to bring a target element to the left side of the deque. Remove +old entries with :meth:`~deque.popleft`, add new entries with :meth:`~deque.extend`, and then +reverse the rotation. +With minor variations on that approach, it is easy to implement Forth style +stack manipulations such as ``dup``, ``drop``, ``swap``, ``over``, ``pick``, +``rot``, and ``roll``. + + +:class:`defaultdict` objects +---------------------------- + +.. class:: defaultdict([default_factory[, ...]]) + + Returns a new dictionary-like object. :class:`defaultdict` is a subclass of the + built-in :class:`dict` class. It overrides one method and adds one writable + instance variable. The remaining functionality is the same as for the + :class:`dict` class and is not documented here. + + The first argument provides the initial value for the :attr:`default_factory` + attribute; it defaults to ``None``. All remaining arguments are treated the same + as if they were passed to the :class:`dict` constructor, including keyword + arguments. + + + :class:`defaultdict` objects support the following method in addition to the + standard :class:`dict` operations: + + .. method:: __missing__(key) + + If the :attr:`default_factory` attribute is ``None``, this raises a + :exc:`KeyError` exception with the *key* as argument. + + If :attr:`default_factory` is not ``None``, it is called without arguments + to provide a default value for the given *key*, this value is inserted in + the dictionary for the *key*, and returned. + + If calling :attr:`default_factory` raises an exception this exception is + propagated unchanged. + + This method is called by the :meth:`__getitem__` method of the + :class:`dict` class when the requested key is not found; whatever it + returns or raises is then returned or raised by :meth:`__getitem__`. + + Note that :meth:`__missing__` is *not* called for any operations besides + :meth:`__getitem__`. This means that :meth:`get` will, like normal + dictionaries, return ``None`` as a default rather than using + :attr:`default_factory`. + + + :class:`defaultdict` objects support the following instance variable: + + + .. attribute:: default_factory + + This attribute is used by the :meth:`__missing__` method; it is + initialized from the first argument to the constructor, if present, or to + ``None``, if absent. + + +:class:`defaultdict` Examples +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Using :class:`list` as the :attr:`~defaultdict.default_factory`, it is easy to group a +sequence of key-value pairs into a dictionary of lists: + + >>> s = [('yellow', 1), ('blue', 2), ('yellow', 3), ('blue', 4), ('red', 1)] + >>> d = defaultdict(list) + >>> for k, v in s: + ... d[k].append(v) + ... + >>> sorted(d.items()) + [('blue', [2, 4]), ('red', [1]), ('yellow', [1, 3])] + +When each key is encountered for the first time, it is not already in the +mapping; so an entry is automatically created using the :attr:`~defaultdict.default_factory` +function which returns an empty :class:`list`. The :meth:`list.append` +operation then attaches the value to the new list. When keys are encountered +again, the look-up proceeds normally (returning the list for that key) and the +:meth:`list.append` operation adds another value to the list. This technique is +simpler and faster than an equivalent technique using :meth:`dict.setdefault`: + + >>> d = {} + >>> for k, v in s: + ... d.setdefault(k, []).append(v) + ... + >>> sorted(d.items()) + [('blue', [2, 4]), ('red', [1]), ('yellow', [1, 3])] + +Setting the :attr:`~defaultdict.default_factory` to :class:`int` makes the +:class:`defaultdict` useful for counting (like a bag or multiset in other +languages): + + >>> s = 'mississippi' + >>> d = defaultdict(int) + >>> for k in s: + ... d[k] += 1 + ... + >>> sorted(d.items()) + [('i', 4), ('m', 1), ('p', 2), ('s', 4)] + +When a letter is first encountered, it is missing from the mapping, so the +:attr:`~defaultdict.default_factory` function calls :func:`int` to supply a default count of +zero. The increment operation then builds up the count for each letter. + +The function :func:`int` which always returns zero is just a special case of +constant functions. A faster and more flexible way to create constant functions +is to use a lambda function which can supply any constant value (not just +zero): + + >>> def constant_factory(value): + ... return lambda: value + >>> d = defaultdict(constant_factory('')) + >>> d.update(name='John', action='ran') + >>> '%(name)s %(action)s to %(object)s' % d + 'John ran to ' + +Setting the :attr:`~defaultdict.default_factory` to :class:`set` makes the +:class:`defaultdict` useful for building a dictionary of sets: + + >>> s = [('red', 1), ('blue', 2), ('red', 3), ('blue', 4), ('red', 1), ('blue', 4)] + >>> d = defaultdict(set) + >>> for k, v in s: + ... d[k].add(v) + ... + >>> sorted(d.items()) + [('blue', {2, 4}), ('red', {1, 3})] + + +:func:`namedtuple` Factory Function for Tuples with Named Fields +---------------------------------------------------------------- + +Named tuples assign meaning to each position in a tuple and allow for more readable, +self-documenting code. They can be used wherever regular tuples are used, and +they add the ability to access fields by name instead of position index. + +.. function:: namedtuple(typename, field_names, *, rename=False, defaults=None, module=None) + + Returns a new tuple subclass named *typename*. The new subclass is used to + create tuple-like objects that have fields accessible by attribute lookup as + well as being indexable and iterable. Instances of the subclass also have a + helpful docstring (with typename and field_names) and a helpful :meth:`__repr__` + method which lists the tuple contents in a ``name=value`` format. + + The *field_names* are a sequence of strings such as ``['x', 'y']``. + Alternatively, *field_names* can be a single string with each fieldname + separated by whitespace and/or commas, for example ``'x y'`` or ``'x, y'``. + + Any valid Python identifier may be used for a fieldname except for names + starting with an underscore. Valid identifiers consist of letters, digits, + and underscores but do not start with a digit or underscore and cannot be + a :mod:`keyword` such as *class*, *for*, *return*, *global*, *pass*, + or *raise*. + + If *rename* is true, invalid fieldnames are automatically replaced + with positional names. For example, ``['abc', 'def', 'ghi', 'abc']`` is + converted to ``['abc', '_1', 'ghi', '_3']``, eliminating the keyword + ``def`` and the duplicate fieldname ``abc``. + + *defaults* can be ``None`` or an :term:`iterable` of default values. + Since fields with a default value must come after any fields without a + default, the *defaults* are applied to the rightmost parameters. For + example, if the fieldnames are ``['x', 'y', 'z']`` and the defaults are + ``(1, 2)``, then ``x`` will be a required argument, ``y`` will default to + ``1``, and ``z`` will default to ``2``. + + If *module* is defined, the ``__module__`` attribute of the named tuple is + set to that value. + + Named tuple instances do not have per-instance dictionaries, so they are + lightweight and require no more memory than regular tuples. + + .. versionchanged:: 3.1 + Added support for *rename*. + + .. versionchanged:: 3.6 + The *verbose* and *rename* parameters became + :ref:`keyword-only arguments `. + + .. versionchanged:: 3.6 + Added the *module* parameter. + + .. versionchanged:: 3.7 + Remove the *verbose* parameter and the :attr:`_source` attribute. + + .. versionchanged:: 3.7 + Added the *defaults* parameter and the :attr:`_field_defaults` + attribute. + +.. doctest:: + :options: +NORMALIZE_WHITESPACE + + >>> # Basic example + >>> Point = namedtuple('Point', ['x', 'y']) + >>> p = Point(11, y=22) # instantiate with positional or keyword arguments + >>> p[0] + p[1] # indexable like the plain tuple (11, 22) + 33 + >>> x, y = p # unpack like a regular tuple + >>> x, y + (11, 22) + >>> p.x + p.y # fields also accessible by name + 33 + >>> p # readable __repr__ with a name=value style + Point(x=11, y=22) + +Named tuples are especially useful for assigning field names to result tuples returned +by the :mod:`csv` or :mod:`sqlite3` modules:: + + EmployeeRecord = namedtuple('EmployeeRecord', 'name, age, title, department, paygrade') + + import csv + for emp in map(EmployeeRecord._make, csv.reader(open("employees.csv", "rb"))): + print(emp.name, emp.title) + + import sqlite3 + conn = sqlite3.connect('/companydata') + cursor = conn.cursor() + cursor.execute('SELECT name, age, title, department, paygrade FROM employees') + for emp in map(EmployeeRecord._make, cursor.fetchall()): + print(emp.name, emp.title) + +In addition to the methods inherited from tuples, named tuples support +three additional methods and two attributes. To prevent conflicts with +field names, the method and attribute names start with an underscore. + +.. classmethod:: somenamedtuple._make(iterable) + + Class method that makes a new instance from an existing sequence or iterable. + + .. doctest:: + + >>> t = [11, 22] + >>> Point._make(t) + Point(x=11, y=22) + +.. method:: somenamedtuple._asdict() + + Return a new :class:`dict` which maps field names to their corresponding + values: + + .. doctest:: + + >>> p = Point(x=11, y=22) + >>> p._asdict() + OrderedDict([('x', 11), ('y', 22)]) + + .. versionchanged:: 3.1 + Returns an :class:`OrderedDict` instead of a regular :class:`dict`. + +.. method:: somenamedtuple._replace(**kwargs) + + Return a new instance of the named tuple replacing specified fields with new + values:: + + >>> p = Point(x=11, y=22) + >>> p._replace(x=33) + Point(x=33, y=22) + + >>> for partnum, record in inventory.items(): + ... inventory[partnum] = record._replace(price=newprices[partnum], timestamp=time.now()) + +.. attribute:: somenamedtuple._fields + + Tuple of strings listing the field names. Useful for introspection + and for creating new named tuple types from existing named tuples. + + .. doctest:: + + >>> p._fields # view the field names + ('x', 'y') + + >>> Color = namedtuple('Color', 'red green blue') + >>> Pixel = namedtuple('Pixel', Point._fields + Color._fields) + >>> Pixel(11, 22, 128, 255, 0) + Pixel(x=11, y=22, red=128, green=255, blue=0) + +.. attribute:: somenamedtuple._field_defaults + + Dictionary mapping field names to default values. + + .. doctest:: + + >>> Account = namedtuple('Account', ['type', 'balance'], defaults=[0]) + >>> Account._field_defaults + {'balance': 0} + >>> Account('premium') + Account(type='premium', balance=0) + +To retrieve a field whose name is stored in a string, use the :func:`getattr` +function: + + >>> getattr(p, 'x') + 11 + +To convert a dictionary to a named tuple, use the ``**`` operator +(as described in :ref:`tut-unpacking-arguments`): + + >>> d = {'x': 11, 'y': 22} + >>> Point(**d) + Point(x=11, y=22) + +Since a named tuple is a regular Python class, it is easy to add or change +functionality with a subclass. Here is how to add a calculated field and +a fixed-width print format: + +.. doctest:: + + >>> class Point(namedtuple('Point', ['x', 'y'])): + ... __slots__ = () + ... @property + ... def hypot(self): + ... return (self.x ** 2 + self.y ** 2) ** 0.5 + ... def __str__(self): + ... return 'Point: x=%6.3f y=%6.3f hypot=%6.3f' % (self.x, self.y, self.hypot) + + >>> for p in Point(3, 4), Point(14, 5/7): + ... print(p) + Point: x= 3.000 y= 4.000 hypot= 5.000 + Point: x=14.000 y= 0.714 hypot=14.018 + +The subclass shown above sets ``__slots__`` to an empty tuple. This helps +keep memory requirements low by preventing the creation of instance dictionaries. + +Subclassing is not useful for adding new, stored fields. Instead, simply +create a new named tuple type from the :attr:`~somenamedtuple._fields` attribute: + + >>> Point3D = namedtuple('Point3D', Point._fields + ('z',)) + +Docstrings can be customized by making direct assignments to the ``__doc__`` +fields: + + >>> Book = namedtuple('Book', ['id', 'title', 'authors']) + >>> Book.__doc__ += ': Hardcover book in active collection' + >>> Book.id.__doc__ = '13-digit ISBN' + >>> Book.title.__doc__ = 'Title of first printing' + >>> Book.authors.__doc__ = 'List of authors sorted by last name' + +.. versionchanged:: 3.5 + Property docstrings became writeable. + +Default values can be implemented by using :meth:`~somenamedtuple._replace` to +customize a prototype instance: + + >>> Account = namedtuple('Account', 'owner balance transaction_count') + >>> default_account = Account('', 0.0, 0) + >>> johns_account = default_account._replace(owner='John') + >>> janes_account = default_account._replace(owner='Jane') + + +.. seealso:: + + * See :class:`typing.NamedTuple` for a way to add type hints for named + tuples. It also provides an elegant notation using the :keyword:`class` + keyword:: + + class Component(NamedTuple): + part_number: int + weight: float + description: Optional[str] = None + + * See :meth:`types.SimpleNamespace` for a mutable namespace based on an + underlying dictionary instead of a tuple. + + * The :mod:`dataclasses` module provides a decorator and functions for + automatically adding generated special methods to user-defined classes. + + +:class:`OrderedDict` objects +---------------------------- + +Ordered dictionaries are just like regular dictionaries but have some extra +capabilities relating to ordering operations. They have become less +important now that the built-in :class:`dict` class gained the ability +to remember insertion order (this new behavior became guaranteed in +Python 3.7). + +Some differences from :class:`dict` still remain: + +* The regular :class:`dict` was designed to be very good at mapping + operations. Tracking insertion order was secondary. + +* The :class:`OrderedDict` was designed to be good at reordering operations. + Space efficiency, iteration speed, and the performance of update + operations were secondary. + +* Algorithmically, :class:`OrderedDict` can handle frequent reordering + operations better than :class:`dict`. This makes it suitable for tracking + recent accesses (for example in an `LRU cache + `_). + +* The equality operation for :class:`OrderedDict` checks for matching order. + +* The :meth:`popitem` method of :class:`OrderedDict` has a different + signature. It accepts an optional argument to specify which item is popped. + +* :class:`OrderedDict` has a :meth:`move_to_end` method to + efficiently reposition an element to an endpoint. + +* Until Python 3.8, :class:`dict` lacked a :meth:`__reversed__` method. + + +.. class:: OrderedDict([items]) + + Return an instance of a :class:`dict` subclass that has methods + specialized for rearranging dictionary order. + + .. versionadded:: 3.1 + + .. method:: popitem(last=True) + + The :meth:`popitem` method for ordered dictionaries returns and removes a + (key, value) pair. The pairs are returned in + :abbr:`LIFO (last-in, first-out)` order if *last* is true + or :abbr:`FIFO (first-in, first-out)` order if false. + + .. method:: move_to_end(key, last=True) + + Move an existing *key* to either end of an ordered dictionary. The item + is moved to the right end if *last* is true (the default) or to the + beginning if *last* is false. Raises :exc:`KeyError` if the *key* does + not exist:: + + >>> d = OrderedDict.fromkeys('abcde') + >>> d.move_to_end('b') + >>> ''.join(d.keys()) + 'acdeb' + >>> d.move_to_end('b', last=False) + >>> ''.join(d.keys()) + 'bacde' + + .. versionadded:: 3.2 + +In addition to the usual mapping methods, ordered dictionaries also support +reverse iteration using :func:`reversed`. + +Equality tests between :class:`OrderedDict` objects are order-sensitive +and are implemented as ``list(od1.items())==list(od2.items())``. +Equality tests between :class:`OrderedDict` objects and other +:class:`~collections.abc.Mapping` objects are order-insensitive like regular +dictionaries. This allows :class:`OrderedDict` objects to be substituted +anywhere a regular dictionary is used. + +.. versionchanged:: 3.5 + The items, keys, and values :term:`views ` + of :class:`OrderedDict` now support reverse iteration using :func:`reversed`. + +.. versionchanged:: 3.6 + With the acceptance of :pep:`468`, order is retained for keyword arguments + passed to the :class:`OrderedDict` constructor and its :meth:`update` + method. + +:class:`OrderedDict` Examples and Recipes +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +It is straightforward to create an ordered dictionary variant +that remembers the order the keys were *last* inserted. +If a new entry overwrites an existing entry, the +original insertion position is changed and moved to the end:: + + class LastUpdatedOrderedDict(OrderedDict): + 'Store items in the order the keys were last added' + + def __setitem__(self, key, value): + super().__setitem__(key, value) + super().move_to_end(key) + +An :class:`OrderedDict` would also be useful for implementing +variants of :func:`functools.lru_cache`:: + + class LRU(OrderedDict): + 'Limit size, evicting the least recently looked-up key when full' + + def __init__(self, maxsize=128, *args, **kwds): + self.maxsize = maxsize + super().__init__(*args, **kwds) + + def __getitem__(self, key): + value = super().__getitem__(key) + self.move_to_end(key) + return value + + def __setitem__(self, key, value): + super().__setitem__(key, value) + if len(self) > self.maxsize: + oldest = next(iter(self)) + del self[oldest] + + +:class:`UserDict` objects +------------------------- + +The class, :class:`UserDict` acts as a wrapper around dictionary objects. +The need for this class has been partially supplanted by the ability to +subclass directly from :class:`dict`; however, this class can be easier +to work with because the underlying dictionary is accessible as an +attribute. + +.. class:: UserDict([initialdata]) + + Class that simulates a dictionary. The instance's contents are kept in a + regular dictionary, which is accessible via the :attr:`data` attribute of + :class:`UserDict` instances. If *initialdata* is provided, :attr:`data` is + initialized with its contents; note that a reference to *initialdata* will not + be kept, allowing it be used for other purposes. + + In addition to supporting the methods and operations of mappings, + :class:`UserDict` instances provide the following attribute: + + .. attribute:: data + + A real dictionary used to store the contents of the :class:`UserDict` + class. + + + +:class:`UserList` objects +------------------------- + +This class acts as a wrapper around list objects. It is a useful base class +for your own list-like classes which can inherit from them and override +existing methods or add new ones. In this way, one can add new behaviors to +lists. + +The need for this class has been partially supplanted by the ability to +subclass directly from :class:`list`; however, this class can be easier +to work with because the underlying list is accessible as an attribute. + +.. class:: UserList([list]) + + Class that simulates a list. The instance's contents are kept in a regular + list, which is accessible via the :attr:`data` attribute of :class:`UserList` + instances. The instance's contents are initially set to a copy of *list*, + defaulting to the empty list ``[]``. *list* can be any iterable, for + example a real Python list or a :class:`UserList` object. + + In addition to supporting the methods and operations of mutable sequences, + :class:`UserList` instances provide the following attribute: + + .. attribute:: data + + A real :class:`list` object used to store the contents of the + :class:`UserList` class. + +**Subclassing requirements:** Subclasses of :class:`UserList` are expected to +offer a constructor which can be called with either no arguments or one +argument. List operations which return a new sequence attempt to create an +instance of the actual implementation class. To do so, it assumes that the +constructor can be called with a single parameter, which is a sequence object +used as a data source. + +If a derived class does not wish to comply with this requirement, all of the +special methods supported by this class will need to be overridden; please +consult the sources for information about the methods which need to be provided +in that case. + +:class:`UserString` objects +--------------------------- + +The class, :class:`UserString` acts as a wrapper around string objects. +The need for this class has been partially supplanted by the ability to +subclass directly from :class:`str`; however, this class can be easier +to work with because the underlying string is accessible as an +attribute. + +.. class:: UserString(seq) + + Class that simulates a string object. The instance's + content is kept in a regular string object, which is accessible via the + :attr:`data` attribute of :class:`UserString` instances. The instance's + contents are initially set to a copy of *seq*. The *seq* argument can + be any object which can be converted into a string using the built-in + :func:`str` function. + + In addition to supporting the methods and operations of strings, + :class:`UserString` instances provide the following attribute: + + .. attribute:: data + + A real :class:`str` object used to store the contents of the + :class:`UserString` class. + + .. versionchanged:: 3.5 + New methods ``__getnewargs__``, ``__rmod__``, ``casefold``, + ``format_map``, ``isprintable``, and ``maketrans``. diff --git a/python-3.7.4-docs-html/_sources/library/colorsys.rst.txt b/python-3.7.4-docs-html/_sources/library/colorsys.rst.txt new file mode 100644 index 0000000..1360c7c --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/colorsys.rst.txt @@ -0,0 +1,65 @@ +:mod:`colorsys` --- Conversions between color systems +===================================================== + +.. module:: colorsys + :synopsis: Conversion functions between RGB and other color systems. + +.. sectionauthor:: David Ascher + +**Source code:** :source:`Lib/colorsys.py` + +-------------- + +The :mod:`colorsys` module defines bidirectional conversions of color values +between colors expressed in the RGB (Red Green Blue) color space used in +computer monitors and three other coordinate systems: YIQ, HLS (Hue Lightness +Saturation) and HSV (Hue Saturation Value). Coordinates in all of these color +spaces are floating point values. In the YIQ space, the Y coordinate is between +0 and 1, but the I and Q coordinates can be positive or negative. In all other +spaces, the coordinates are all between 0 and 1. + +.. seealso:: + + More information about color spaces can be found at + http://poynton.ca/ColorFAQ.html and + https://www.cambridgeincolour.com/tutorials/color-spaces.htm. + +The :mod:`colorsys` module defines the following functions: + + +.. function:: rgb_to_yiq(r, g, b) + + Convert the color from RGB coordinates to YIQ coordinates. + + +.. function:: yiq_to_rgb(y, i, q) + + Convert the color from YIQ coordinates to RGB coordinates. + + +.. function:: rgb_to_hls(r, g, b) + + Convert the color from RGB coordinates to HLS coordinates. + + +.. function:: hls_to_rgb(h, l, s) + + Convert the color from HLS coordinates to RGB coordinates. + + +.. function:: rgb_to_hsv(r, g, b) + + Convert the color from RGB coordinates to HSV coordinates. + + +.. function:: hsv_to_rgb(h, s, v) + + Convert the color from HSV coordinates to RGB coordinates. + +Example:: + + >>> import colorsys + >>> colorsys.rgb_to_hsv(0.2, 0.4, 0.4) + (0.5, 0.5, 0.4) + >>> colorsys.hsv_to_rgb(0.5, 0.5, 0.4) + (0.2, 0.4, 0.4) diff --git a/python-3.7.4-docs-html/_sources/library/compileall.rst.txt b/python-3.7.4-docs-html/_sources/library/compileall.rst.txt new file mode 100644 index 0000000..258de28 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/compileall.rst.txt @@ -0,0 +1,267 @@ +:mod:`compileall` --- Byte-compile Python libraries +=================================================== + +.. module:: compileall + :synopsis: Tools for byte-compiling all Python source files in a directory tree. + +**Source code:** :source:`Lib/compileall.py` + +-------------- + +This module provides some utility functions to support installing Python +libraries. These functions compile Python source files in a directory tree. +This module can be used to create the cached byte-code files at library +installation time, which makes them available for use even by users who don't +have write permission to the library directories. + + +Command-line use +---------------- + +This module can work as a script (using :program:`python -m compileall`) to +compile Python sources. + +.. program:: compileall + +.. cmdoption:: directory ... + file ... + + Positional arguments are files to compile or directories that contain + source files, traversed recursively. If no argument is given, behave as if + the command line was ``-l ``. + +.. cmdoption:: -l + + Do not recurse into subdirectories, only compile source code files directly + contained in the named or implied directories. + +.. cmdoption:: -f + + Force rebuild even if timestamps are up-to-date. + +.. cmdoption:: -q + + Do not print the list of files compiled. If passed once, error messages will + still be printed. If passed twice (``-qq``), all output is suppressed. + +.. cmdoption:: -d destdir + + Directory prepended to the path to each file being compiled. This will + appear in compilation time tracebacks, and is also compiled in to the + byte-code file, where it will be used in tracebacks and other messages in + cases where the source file does not exist at the time the byte-code file is + executed. + +.. cmdoption:: -x regex + + regex is used to search the full path to each file considered for + compilation, and if the regex produces a match, the file is skipped. + +.. cmdoption:: -i list + + Read the file ``list`` and add each line that it contains to the list of + files and directories to compile. If ``list`` is ``-``, read lines from + ``stdin``. + +.. cmdoption:: -b + + Write the byte-code files to their legacy locations and names, which may + overwrite byte-code files created by another version of Python. The default + is to write files to their :pep:`3147` locations and names, which allows + byte-code files from multiple versions of Python to coexist. + +.. cmdoption:: -r + + Control the maximum recursion level for subdirectories. + If this is given, then ``-l`` option will not be taken into account. + :program:`python -m compileall -r 0` is equivalent to + :program:`python -m compileall -l`. + +.. cmdoption:: -j N + + Use *N* workers to compile the files within the given directory. + If ``0`` is used, then the result of :func:`os.cpu_count()` + will be used. + +.. cmdoption:: --invalidation-mode [timestamp|checked-hash|unchecked-hash] + + Control how the generated byte-code files are invalidated at runtime. + The ``timestamp`` value, means that ``.pyc`` files with the source timestamp + and size embedded will be generated. The ``checked-hash`` and + ``unchecked-hash`` values cause hash-based pycs to be generated. Hash-based + pycs embed a hash of the source file contents rather than a timestamp. See + :ref:`pyc-invalidation` for more information on how Python validates + bytecode cache files at runtime. + The default is ``timestamp`` if the :envvar:`SOURCE_DATE_EPOCH` environment + variable is not set, and ``checked-hash`` if the ``SOURCE_DATE_EPOCH`` + environment variable is set. + +.. versionchanged:: 3.2 + Added the ``-i``, ``-b`` and ``-h`` options. + +.. versionchanged:: 3.5 + Added the ``-j``, ``-r``, and ``-qq`` options. ``-q`` option + was changed to a multilevel value. ``-b`` will always produce a + byte-code file ending in ``.pyc``, never ``.pyo``. + +.. versionchanged:: 3.7 + Added the ``--invalidation-mode`` option. + + +There is no command-line option to control the optimization level used by the +:func:`compile` function, because the Python interpreter itself already +provides the option: :program:`python -O -m compileall`. + +Public functions +---------------- + +.. function:: compile_dir(dir, maxlevels=10, ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, workers=1, invalidation_mode=py_compile.PycInvalidationMode.TIMESTAMP) + + Recursively descend the directory tree named by *dir*, compiling all :file:`.py` + files along the way. Return a true value if all the files compiled successfully, + and a false value otherwise. + + The *maxlevels* parameter is used to limit the depth of the recursion; it + defaults to ``10``. + + If *ddir* is given, it is prepended to the path to each file being compiled + for use in compilation time tracebacks, and is also compiled in to the + byte-code file, where it will be used in tracebacks and other messages in + cases where the source file does not exist at the time the byte-code file is + executed. + + If *force* is true, modules are re-compiled even if the timestamps are up to + date. + + If *rx* is given, its search method is called on the complete path to each + file considered for compilation, and if it returns a true value, the file + is skipped. + + If *quiet* is ``False`` or ``0`` (the default), the filenames and other + information are printed to standard out. Set to ``1``, only errors are + printed. Set to ``2``, all output is suppressed. + + If *legacy* is true, byte-code files are written to their legacy locations + and names, which may overwrite byte-code files created by another version of + Python. The default is to write files to their :pep:`3147` locations and + names, which allows byte-code files from multiple versions of Python to + coexist. + + *optimize* specifies the optimization level for the compiler. It is passed to + the built-in :func:`compile` function. + + The argument *workers* specifies how many workers are used to + compile files in parallel. The default is to not use multiple workers. + If the platform can't use multiple workers and *workers* argument is given, + then sequential compilation will be used as a fallback. If *workers* is + lower than ``0``, a :exc:`ValueError` will be raised. + + *invalidation_mode* should be a member of the + :class:`py_compile.PycInvalidationMode` enum and controls how the generated + pycs are invalidated at runtime. + + .. versionchanged:: 3.2 + Added the *legacy* and *optimize* parameter. + + .. versionchanged:: 3.5 + Added the *workers* parameter. + + .. versionchanged:: 3.5 + *quiet* parameter was changed to a multilevel value. + + .. versionchanged:: 3.5 + The *legacy* parameter only writes out ``.pyc`` files, not ``.pyo`` files + no matter what the value of *optimize* is. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + .. versionchanged:: 3.7 + The *invalidation_mode* parameter was added. + +.. function:: compile_file(fullname, ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, invalidation_mode=py_compile.PycInvalidationMode.TIMESTAMP) + + Compile the file with path *fullname*. Return a true value if the file + compiled successfully, and a false value otherwise. + + If *ddir* is given, it is prepended to the path to the file being compiled + for use in compilation time tracebacks, and is also compiled in to the + byte-code file, where it will be used in tracebacks and other messages in + cases where the source file does not exist at the time the byte-code file is + executed. + + If *rx* is given, its search method is passed the full path name to the + file being compiled, and if it returns a true value, the file is not + compiled and ``True`` is returned. + + If *quiet* is ``False`` or ``0`` (the default), the filenames and other + information are printed to standard out. Set to ``1``, only errors are + printed. Set to ``2``, all output is suppressed. + + If *legacy* is true, byte-code files are written to their legacy locations + and names, which may overwrite byte-code files created by another version of + Python. The default is to write files to their :pep:`3147` locations and + names, which allows byte-code files from multiple versions of Python to + coexist. + + *optimize* specifies the optimization level for the compiler. It is passed to + the built-in :func:`compile` function. + + *invalidation_mode* should be a member of the + :class:`py_compile.PycInvalidationMode` enum and controls how the generated + pycs are invalidated at runtime. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.5 + *quiet* parameter was changed to a multilevel value. + + .. versionchanged:: 3.5 + The *legacy* parameter only writes out ``.pyc`` files, not ``.pyo`` files + no matter what the value of *optimize* is. + + .. versionchanged:: 3.7 + The *invalidation_mode* parameter was added. + +.. function:: compile_path(skip_curdir=True, maxlevels=0, force=False, quiet=0, legacy=False, optimize=-1, invalidation_mode=py_compile.PycInvalidationMode.TIMESTAMP) + + Byte-compile all the :file:`.py` files found along ``sys.path``. Return a + true value if all the files compiled successfully, and a false value otherwise. + + If *skip_curdir* is true (the default), the current directory is not included + in the search. All other parameters are passed to the :func:`compile_dir` + function. Note that unlike the other compile functions, ``maxlevels`` + defaults to ``0``. + + .. versionchanged:: 3.2 + Added the *legacy* and *optimize* parameter. + + .. versionchanged:: 3.5 + *quiet* parameter was changed to a multilevel value. + + .. versionchanged:: 3.5 + The *legacy* parameter only writes out ``.pyc`` files, not ``.pyo`` files + no matter what the value of *optimize* is. + + .. versionchanged:: 3.7 + The *invalidation_mode* parameter was added. + +To force a recompile of all the :file:`.py` files in the :file:`Lib/` +subdirectory and all its subdirectories:: + + import compileall + + compileall.compile_dir('Lib/', force=True) + + # Perform same compilation, excluding files in .svn directories. + import re + compileall.compile_dir('Lib/', rx=re.compile(r'[/\\][.]svn'), force=True) + + # pathlib.Path objects can also be used. + import pathlib + compileall.compile_dir(pathlib.Path('Lib/'), force=True) + +.. seealso:: + + Module :mod:`py_compile` + Byte-compile a single source file. diff --git a/python-3.7.4-docs-html/_sources/library/concurrency.rst.txt b/python-3.7.4-docs-html/_sources/library/concurrency.rst.txt new file mode 100644 index 0000000..826bf86 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/concurrency.rst.txt @@ -0,0 +1,31 @@ +.. _concurrency: + +******************** +Concurrent Execution +******************** + +The modules described in this chapter provide support for concurrent +execution of code. The appropriate choice of tool will depend on the +task to be executed (CPU bound vs IO bound) and preferred style of +development (event driven cooperative multitasking vs preemptive +multitasking). Here's an overview: + + +.. toctree:: + + threading.rst + multiprocessing.rst + concurrent.rst + concurrent.futures.rst + subprocess.rst + sched.rst + queue.rst + + +The following are support modules for some of the above services: + +.. toctree:: + + _thread.rst + _dummy_thread.rst + dummy_threading.rst diff --git a/python-3.7.4-docs-html/_sources/library/concurrent.futures.rst.txt b/python-3.7.4-docs-html/_sources/library/concurrent.futures.rst.txt new file mode 100644 index 0000000..9295df8 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/concurrent.futures.rst.txt @@ -0,0 +1,494 @@ +:mod:`concurrent.futures` --- Launching parallel tasks +====================================================== + +.. module:: concurrent.futures + :synopsis: Execute computations concurrently using threads or processes. + +.. versionadded:: 3.2 + +**Source code:** :source:`Lib/concurrent/futures/thread.py` +and :source:`Lib/concurrent/futures/process.py` + +-------------- + +The :mod:`concurrent.futures` module provides a high-level interface for +asynchronously executing callables. + +The asynchronous execution can be performed with threads, using +:class:`ThreadPoolExecutor`, or separate processes, using +:class:`ProcessPoolExecutor`. Both implement the same interface, which is +defined by the abstract :class:`Executor` class. + + +Executor Objects +---------------- + +.. class:: Executor + + An abstract class that provides methods to execute calls asynchronously. It + should not be used directly, but through its concrete subclasses. + + .. method:: submit(fn, *args, **kwargs) + + Schedules the callable, *fn*, to be executed as ``fn(*args **kwargs)`` + and returns a :class:`Future` object representing the execution of the + callable. :: + + with ThreadPoolExecutor(max_workers=1) as executor: + future = executor.submit(pow, 323, 1235) + print(future.result()) + + .. method:: map(func, *iterables, timeout=None, chunksize=1) + + Similar to :func:`map(func, *iterables) ` except: + + * the *iterables* are collected immediately rather than lazily; + + * *func* is executed asynchronously and several calls to + *func* may be made concurrently. + + The returned iterator raises a :exc:`concurrent.futures.TimeoutError` + if :meth:`~iterator.__next__` is called and the result isn't available + after *timeout* seconds from the original call to :meth:`Executor.map`. + *timeout* can be an int or a float. If *timeout* is not specified or + ``None``, there is no limit to the wait time. + + If a *func* call raises an exception, then that exception will be + raised when its value is retrieved from the iterator. + + When using :class:`ProcessPoolExecutor`, this method chops *iterables* + into a number of chunks which it submits to the pool as separate + tasks. The (approximate) size of these chunks can be specified by + setting *chunksize* to a positive integer. For very long iterables, + using a large value for *chunksize* can significantly improve + performance compared to the default size of 1. With + :class:`ThreadPoolExecutor`, *chunksize* has no effect. + + .. versionchanged:: 3.5 + Added the *chunksize* argument. + + .. method:: shutdown(wait=True) + + Signal the executor that it should free any resources that it is using + when the currently pending futures are done executing. Calls to + :meth:`Executor.submit` and :meth:`Executor.map` made after shutdown will + raise :exc:`RuntimeError`. + + If *wait* is ``True`` then this method will not return until all the + pending futures are done executing and the resources associated with the + executor have been freed. If *wait* is ``False`` then this method will + return immediately and the resources associated with the executor will be + freed when all pending futures are done executing. Regardless of the + value of *wait*, the entire Python program will not exit until all + pending futures are done executing. + + You can avoid having to call this method explicitly if you use the + :keyword:`with` statement, which will shutdown the :class:`Executor` + (waiting as if :meth:`Executor.shutdown` were called with *wait* set to + ``True``):: + + import shutil + with ThreadPoolExecutor(max_workers=4) as e: + e.submit(shutil.copy, 'src1.txt', 'dest1.txt') + e.submit(shutil.copy, 'src2.txt', 'dest2.txt') + e.submit(shutil.copy, 'src3.txt', 'dest3.txt') + e.submit(shutil.copy, 'src4.txt', 'dest4.txt') + + +ThreadPoolExecutor +------------------ + +:class:`ThreadPoolExecutor` is an :class:`Executor` subclass that uses a pool of +threads to execute calls asynchronously. + +Deadlocks can occur when the callable associated with a :class:`Future` waits on +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. + return 5 + + def wait_on_a(): + time.sleep(5) + print(a.result()) # a will never complete because it is waiting on b. + return 6 + + + executor = ThreadPoolExecutor(max_workers=2) + a = executor.submit(wait_on_b) + b = executor.submit(wait_on_a) + +And:: + + def wait_on_future(): + f = executor.submit(pow, 5, 2) + # This will never complete because there is only one worker thread and + # it is executing this function. + print(f.result()) + + executor = ThreadPoolExecutor(max_workers=1) + executor.submit(wait_on_future) + + +.. class:: ThreadPoolExecutor(max_workers=None, thread_name_prefix='', initializer=None, initargs=()) + + An :class:`Executor` subclass that uses a pool of at most *max_workers* + threads to execute calls asynchronously. + + *initializer* is an optional callable that is called at the start of + each worker thread; *initargs* is a tuple of arguments passed to the + initializer. Should *initializer* raise an exception, all currently + pending jobs will raise a :exc:`~concurrent.futures.thread.BrokenThreadPool`, + as well as any attempt to submit more jobs to the pool. + + .. versionchanged:: 3.5 + If *max_workers* is ``None`` or + not given, it will default to the number of processors on the machine, + multiplied by ``5``, assuming that :class:`ThreadPoolExecutor` is often + used to overlap I/O instead of CPU work and the number of workers + should be higher than the number of workers + for :class:`ProcessPoolExecutor`. + + .. versionadded:: 3.6 + The *thread_name_prefix* argument was added to allow users to + control the :class:`threading.Thread` names for worker threads created by + the pool for easier debugging. + + .. versionchanged:: 3.7 + Added the *initializer* and *initargs* arguments. + + +.. _threadpoolexecutor-example: + +ThreadPoolExecutor Example +~~~~~~~~~~~~~~~~~~~~~~~~~~ +:: + + import concurrent.futures + import urllib.request + + URLS = ['http://www.foxnews.com/', + 'http://www.cnn.com/', + 'http://europe.wsj.com/', + 'http://www.bbc.co.uk/', + 'http://some-made-up-domain.com/'] + + # Retrieve a single page and report the URL and contents + def load_url(url, timeout): + with urllib.request.urlopen(url, timeout=timeout) as conn: + return conn.read() + + # We can use a with statement to ensure threads are cleaned up promptly + with concurrent.futures.ThreadPoolExecutor(max_workers=5) as executor: + # Start the load operations and mark each future with its URL + future_to_url = {executor.submit(load_url, url, 60): url for url in URLS} + for future in concurrent.futures.as_completed(future_to_url): + url = future_to_url[future] + try: + data = future.result() + except Exception as exc: + print('%r generated an exception: %s' % (url, exc)) + else: + print('%r page is %d bytes' % (url, len(data))) + + +ProcessPoolExecutor +------------------- + +The :class:`ProcessPoolExecutor` class is an :class:`Executor` subclass that +uses a pool of processes to execute calls asynchronously. +:class:`ProcessPoolExecutor` uses the :mod:`multiprocessing` module, which +allows it to side-step the :term:`Global Interpreter Lock` but also means that +only picklable objects can be executed and returned. + +The ``__main__`` module must be importable by worker subprocesses. This means +that :class:`ProcessPoolExecutor` will not work in the interactive interpreter. + +Calling :class:`Executor` or :class:`Future` methods from a callable submitted +to a :class:`ProcessPoolExecutor` will result in deadlock. + +.. class:: ProcessPoolExecutor(max_workers=None, mp_context=None, initializer=None, initargs=()) + + An :class:`Executor` subclass that executes calls asynchronously using a pool + of at most *max_workers* processes. If *max_workers* is ``None`` or not + given, it will default to the number of processors on the machine. + If *max_workers* is lower or equal to ``0``, then a :exc:`ValueError` + will be raised. + On Windows, *max_workers* must be equal or lower than ``61``. If it is not + then :exc:`ValueError` will be raised. If *max_workers* is ``None``, then + the default chosen will be at most ``61``, even if more processors are + available. + *mp_context* can be a multiprocessing context or None. It will be used to + launch the workers. If *mp_context* is ``None`` or not given, the default + multiprocessing context is used. + + *initializer* is an optional callable that is called at the start of + each worker process; *initargs* is a tuple of arguments passed to the + initializer. Should *initializer* raise an exception, all currently + pending jobs will raise a :exc:`~concurrent.futures.process.BrokenProcessPool`, + as well any attempt to submit more jobs to the pool. + + .. versionchanged:: 3.3 + When one of the worker processes terminates abruptly, a + :exc:`BrokenProcessPool` error is now raised. Previously, behaviour + was undefined but operations on the executor or its futures would often + freeze or deadlock. + + .. versionchanged:: 3.7 + The *mp_context* argument was added to allow users to control the + start_method for worker processes created by the pool. + + Added the *initializer* and *initargs* arguments. + + +.. _processpoolexecutor-example: + +ProcessPoolExecutor Example +~~~~~~~~~~~~~~~~~~~~~~~~~~~ +:: + + import concurrent.futures + import math + + PRIMES = [ + 112272535095293, + 112582705942171, + 112272535095293, + 115280095190773, + 115797848077099, + 1099726899285419] + + def is_prime(n): + if n % 2 == 0: + return False + + sqrt_n = int(math.floor(math.sqrt(n))) + for i in range(3, sqrt_n + 1, 2): + if n % i == 0: + return False + return True + + def main(): + with concurrent.futures.ProcessPoolExecutor() as executor: + for number, prime in zip(PRIMES, executor.map(is_prime, PRIMES)): + print('%d is prime: %s' % (number, prime)) + + if __name__ == '__main__': + main() + + +Future Objects +-------------- + +The :class:`Future` class encapsulates the asynchronous execution of a callable. +:class:`Future` instances are created by :meth:`Executor.submit`. + +.. class:: Future + + Encapsulates the asynchronous execution of a callable. :class:`Future` + instances are created by :meth:`Executor.submit` and should not be created + directly except for testing. + + .. method:: cancel() + + Attempt to cancel the call. If the call is currently being executed or + finished running and cannot be cancelled then the method will return + ``False``, otherwise the call will be cancelled and the method will + return ``True``. + + .. method:: cancelled() + + Return ``True`` if the call was successfully cancelled. + + .. method:: running() + + Return ``True`` if the call is currently being executed and cannot be + cancelled. + + .. method:: done() + + Return ``True`` if the call was successfully cancelled or finished + running. + + .. method:: result(timeout=None) + + Return the value returned by the call. If the call hasn't yet completed + then this method will wait up to *timeout* seconds. If the call hasn't + completed in *timeout* seconds, then a + :exc:`concurrent.futures.TimeoutError` will be raised. *timeout* can be + an int or float. If *timeout* is not specified or ``None``, there is no + limit to the wait time. + + If the future is cancelled before completing then :exc:`.CancelledError` + will be raised. + + If the call raised, this method will raise the same exception. + + .. method:: exception(timeout=None) + + Return the exception raised by the call. If the call hasn't yet + completed then this method will wait up to *timeout* seconds. If the + call hasn't completed in *timeout* seconds, then a + :exc:`concurrent.futures.TimeoutError` will be raised. *timeout* can be + an int or float. If *timeout* is not specified or ``None``, there is no + limit to the wait time. + + If the future is cancelled before completing then :exc:`.CancelledError` + will be raised. + + If the call completed without raising, ``None`` is returned. + + .. method:: add_done_callback(fn) + + Attaches the callable *fn* to the future. *fn* will be called, with the + future as its only argument, when the future is cancelled or finishes + running. + + Added callables are called in the order that they were added and are + always called in a thread belonging to the process that added them. If + the callable raises an :exc:`Exception` subclass, it will be logged and + ignored. If the callable raises a :exc:`BaseException` subclass, the + behavior is undefined. + + If the future has already completed or been cancelled, *fn* will be + called immediately. + + The following :class:`Future` methods are meant for use in unit tests and + :class:`Executor` implementations. + + .. method:: set_running_or_notify_cancel() + + This method should only be called by :class:`Executor` implementations + before executing the work associated with the :class:`Future` and by unit + tests. + + If the method returns ``False`` then the :class:`Future` was cancelled, + i.e. :meth:`Future.cancel` was called and returned `True`. Any threads + waiting on the :class:`Future` completing (i.e. through + :func:`as_completed` or :func:`wait`) will be woken up. + + If the method returns ``True`` then the :class:`Future` was not cancelled + and has been put in the running state, i.e. calls to + :meth:`Future.running` will return `True`. + + This method can only be called once and cannot be called after + :meth:`Future.set_result` or :meth:`Future.set_exception` have been + called. + + .. method:: set_result(result) + + Sets the result of the work associated with the :class:`Future` to + *result*. + + This method should only be used by :class:`Executor` implementations and + unit tests. + + .. method:: set_exception(exception) + + Sets the result of the work associated with the :class:`Future` to the + :class:`Exception` *exception*. + + This method should only be used by :class:`Executor` implementations and + unit tests. + + +Module Functions +---------------- + +.. function:: wait(fs, timeout=None, return_when=ALL_COMPLETED) + + Wait for the :class:`Future` instances (possibly created by different + :class:`Executor` instances) given by *fs* to complete. Returns a named + 2-tuple of sets. The first set, named ``done``, contains the futures that + completed (finished or cancelled futures) before the wait completed. The + second set, named ``not_done``, contains the futures that did not complete + (pending or running futures). + + *timeout* can be used to control the maximum number of seconds to wait before + returning. *timeout* can be an int or float. If *timeout* is not specified + or ``None``, there is no limit to the wait time. + + *return_when* indicates when this function should return. It must be one of + the following constants: + + .. tabularcolumns:: |l|L| + + +-----------------------------+----------------------------------------+ + | Constant | Description | + +=============================+========================================+ + | :const:`FIRST_COMPLETED` | The function will return when any | + | | future finishes or is cancelled. | + +-----------------------------+----------------------------------------+ + | :const:`FIRST_EXCEPTION` | The function will return when any | + | | future finishes by raising an | + | | exception. If no future raises an | + | | exception then it is equivalent to | + | | :const:`ALL_COMPLETED`. | + +-----------------------------+----------------------------------------+ + | :const:`ALL_COMPLETED` | The function will return when all | + | | futures finish or are cancelled. | + +-----------------------------+----------------------------------------+ + +.. function:: as_completed(fs, timeout=None) + + Returns an iterator over the :class:`Future` instances (possibly created by + different :class:`Executor` instances) given by *fs* that yields futures as + they complete (finished or cancelled futures). Any futures given by *fs* that + are duplicated will be returned once. Any futures that completed before + :func:`as_completed` is called will be yielded first. The returned iterator + raises a :exc:`concurrent.futures.TimeoutError` if :meth:`~iterator.__next__` + is called and the result isn't available after *timeout* seconds from the + original call to :func:`as_completed`. *timeout* can be an int or float. If + *timeout* is not specified or ``None``, there is no limit to the wait time. + + +.. seealso:: + + :pep:`3148` -- futures - execute computations asynchronously + The proposal which described this feature for inclusion in the Python + standard library. + + +Exception classes +----------------- + +.. currentmodule:: concurrent.futures + +.. exception:: CancelledError + + Raised when a future is cancelled. + +.. exception:: TimeoutError + + Raised when a future operation exceeds the given timeout. + +.. exception:: BrokenExecutor + + Derived from :exc:`RuntimeError`, this exception class is raised + when an executor is broken for some reason, and cannot be used + to submit or execute new tasks. + + .. versionadded:: 3.7 + +.. currentmodule:: concurrent.futures.thread + +.. exception:: BrokenThreadPool + + Derived from :exc:`~concurrent.futures.BrokenExecutor`, this exception + class is raised when one of the workers of a :class:`ThreadPoolExecutor` + has failed initializing. + + .. versionadded:: 3.7 + +.. currentmodule:: concurrent.futures.process + +.. exception:: BrokenProcessPool + + Derived from :exc:`~concurrent.futures.BrokenExecutor` (formerly + :exc:`RuntimeError`), this exception class is raised when one of the + workers of a :class:`ProcessPoolExecutor` has terminated in a non-clean + fashion (for example, if it was killed from the outside). + + .. versionadded:: 3.3 diff --git a/python-3.7.4-docs-html/_sources/library/concurrent.rst.txt b/python-3.7.4-docs-html/_sources/library/concurrent.rst.txt new file mode 100644 index 0000000..2eba536 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/concurrent.rst.txt @@ -0,0 +1,6 @@ +The :mod:`concurrent` package +============================= + +Currently, there is only one module in this package: + +* :mod:`concurrent.futures` -- Launching parallel tasks diff --git a/python-3.7.4-docs-html/_sources/library/configparser.rst.txt b/python-3.7.4-docs-html/_sources/library/configparser.rst.txt new file mode 100644 index 0000000..68b663f --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/configparser.rst.txt @@ -0,0 +1,1314 @@ +:mod:`configparser` --- Configuration file parser +================================================= + +.. module:: configparser + :synopsis: Configuration file parser. + +.. moduleauthor:: Ken Manheimer +.. moduleauthor:: Barry Warsaw +.. moduleauthor:: Eric S. Raymond +.. moduleauthor:: Łukasz Langa +.. sectionauthor:: Christopher G. Petrilli +.. sectionauthor:: Łukasz Langa + +**Source code:** :source:`Lib/configparser.py` + +.. index:: + pair: .ini; file + pair: configuration; file + single: ini file + single: Windows ini file + +-------------- + +This module provides the :class:`ConfigParser` class which implements a basic +configuration language which provides a structure similar to what's found in +Microsoft Windows INI files. You can use this to write Python programs which +can be customized by end users easily. + +.. note:: + + This library does *not* interpret or write the value-type prefixes used in + the Windows Registry extended version of INI syntax. + +.. seealso:: + + Module :mod:`shlex` + Support for creating Unix shell-like mini-languages which can be used as + an alternate format for application configuration files. + + Module :mod:`json` + The json module implements a subset of JavaScript syntax which can also + be used for this purpose. + + +.. testsetup:: + + import configparser + + +Quick Start +----------- + +Let's take a very basic configuration file that looks like this: + +.. code-block:: ini + + [DEFAULT] + ServerAliveInterval = 45 + Compression = yes + CompressionLevel = 9 + ForwardX11 = yes + + [bitbucket.org] + User = hg + + [topsecret.server.com] + Port = 50022 + ForwardX11 = no + +The structure of INI files is described `in the following section +<#supported-ini-file-structure>`_. Essentially, the file +consists of sections, each of which contains keys with values. +:mod:`configparser` classes can read and write such files. Let's start by +creating the above configuration file programmatically. + +.. doctest:: + + >>> import configparser + >>> config = configparser.ConfigParser() + >>> config['DEFAULT'] = {'ServerAliveInterval': '45', + ... 'Compression': 'yes', + ... 'CompressionLevel': '9'} + >>> config['bitbucket.org'] = {} + >>> config['bitbucket.org']['User'] = 'hg' + >>> config['topsecret.server.com'] = {} + >>> topsecret = config['topsecret.server.com'] + >>> topsecret['Port'] = '50022' # mutates the parser + >>> topsecret['ForwardX11'] = 'no' # same here + >>> config['DEFAULT']['ForwardX11'] = 'yes' + >>> with open('example.ini', 'w') as configfile: + ... config.write(configfile) + ... + +As you can see, we can treat a config parser much like a dictionary. +There are differences, `outlined later <#mapping-protocol-access>`_, but +the behavior is very close to what you would expect from a dictionary. + +Now that we have created and saved a configuration file, let's read it +back and explore the data it holds. + +.. doctest:: + + >>> config = configparser.ConfigParser() + >>> config.sections() + [] + >>> config.read('example.ini') + ['example.ini'] + >>> config.sections() + ['bitbucket.org', 'topsecret.server.com'] + >>> 'bitbucket.org' in config + True + >>> 'bytebong.com' in config + False + >>> config['bitbucket.org']['User'] + 'hg' + >>> config['DEFAULT']['Compression'] + 'yes' + >>> topsecret = config['topsecret.server.com'] + >>> topsecret['ForwardX11'] + 'no' + >>> topsecret['Port'] + '50022' + >>> for key in config['bitbucket.org']: # doctest: +SKIP + ... print(key) + user + compressionlevel + serveraliveinterval + compression + forwardx11 + >>> config['bitbucket.org']['ForwardX11'] + 'yes' + +As we can see above, the API is pretty straightforward. The only bit of magic +involves the ``DEFAULT`` section which provides default values for all other +sections [1]_. Note also that keys in sections are +case-insensitive and stored in lowercase [1]_. + + +Supported Datatypes +------------------- + +Config parsers do not guess datatypes of values in configuration files, always +storing them internally as strings. This means that if you need other +datatypes, you should convert on your own: + +.. doctest:: + + >>> int(topsecret['Port']) + 50022 + >>> float(topsecret['CompressionLevel']) + 9.0 + +Since this task is so common, config parsers provide a range of handy getter +methods to handle integers, floats and booleans. The last one is the most +interesting because simply passing the value to ``bool()`` would do no good +since ``bool('False')`` is still ``True``. This is why config parsers also +provide :meth:`~ConfigParser.getboolean`. This method is case-insensitive and +recognizes Boolean values from ``'yes'``/``'no'``, ``'on'``/``'off'``, +``'true'``/``'false'`` and ``'1'``/``'0'`` [1]_. For example: + +.. doctest:: + + >>> topsecret.getboolean('ForwardX11') + False + >>> config['bitbucket.org'].getboolean('ForwardX11') + True + >>> config.getboolean('bitbucket.org', 'Compression') + True + +Apart from :meth:`~ConfigParser.getboolean`, config parsers also +provide equivalent :meth:`~ConfigParser.getint` and +:meth:`~ConfigParser.getfloat` methods. You can register your own +converters and customize the provided ones. [1]_ + +Fallback Values +--------------- + +As with a dictionary, you can use a section's :meth:`get` method to +provide fallback values: + +.. doctest:: + + >>> topsecret.get('Port') + '50022' + >>> topsecret.get('CompressionLevel') + '9' + >>> topsecret.get('Cipher') + >>> topsecret.get('Cipher', '3des-cbc') + '3des-cbc' + +Please note that default values have precedence over fallback values. +For instance, in our example the ``'CompressionLevel'`` key was +specified only in the ``'DEFAULT'`` section. If we try to get it from +the section ``'topsecret.server.com'``, we will always get the default, +even if we specify a fallback: + +.. doctest:: + + >>> topsecret.get('CompressionLevel', '3') + '9' + +One more thing to be aware of is that the parser-level :meth:`get` method +provides a custom, more complex interface, maintained for backwards +compatibility. When using this method, a fallback value can be provided via +the ``fallback`` keyword-only argument: + +.. doctest:: + + >>> config.get('bitbucket.org', 'monster', + ... fallback='No such things as monsters') + 'No such things as monsters' + +The same ``fallback`` argument can be used with the +:meth:`~ConfigParser.getint`, :meth:`~ConfigParser.getfloat` and +:meth:`~ConfigParser.getboolean` methods, for example: + +.. doctest:: + + >>> 'BatchMode' in topsecret + False + >>> topsecret.getboolean('BatchMode', fallback=True) + True + >>> config['DEFAULT']['BatchMode'] = 'no' + >>> topsecret.getboolean('BatchMode', fallback=True) + False + + +Supported INI File Structure +---------------------------- + +A configuration file consists of sections, each led by a ``[section]`` header, +followed by key/value entries separated by a specific string (``=`` or ``:`` by +default [1]_). By default, section names are case sensitive but keys are not +[1]_. Leading and trailing whitespace is removed from keys and values. +Values can be omitted, in which case the key/value delimiter may also be left +out. Values can also span multiple lines, as long as they are indented deeper +than the first line of the value. Depending on the parser's mode, blank lines +may be treated as parts of multiline values or ignored. + +Configuration files may include comments, prefixed by specific +characters (``#`` and ``;`` by default [1]_). Comments may appear on +their own on an otherwise empty line, possibly indented. [1]_ + +For example: + +.. code-block:: ini + + [Simple Values] + key=value + spaces in keys=allowed + spaces in values=allowed as well + spaces around the delimiter = obviously + you can also use : to delimit keys from values + + [All Values Are Strings] + values like this: 1000000 + or this: 3.14159265359 + are they treated as numbers? : no + integers, floats and booleans are held as: strings + can use the API to get converted values directly: true + + [Multiline Values] + chorus: I'm a lumberjack, and I'm okay + I sleep all night and I work all day + + [No Values] + key_without_value + empty string value here = + + [You can use comments] + # like this + ; or this + + # By default only in an empty line. + # Inline comments can be harmful because they prevent users + # from using the delimiting characters as parts of values. + # That being said, this can be customized. + + [Sections Can Be Indented] + can_values_be_as_well = True + does_that_mean_anything_special = False + purpose = formatting for readability + multiline_values = are + handled just fine as + long as they are indented + deeper than the first line + of a value + # Did I mention we can indent comments, too? + + +Interpolation of values +----------------------- + +On top of the core functionality, :class:`ConfigParser` supports +interpolation. This means values can be preprocessed before returning them +from ``get()`` calls. + +.. index:: single: % (percent); interpolation in configuration files + +.. class:: BasicInterpolation() + + The default implementation used by :class:`ConfigParser`. It enables + values to contain format strings which refer to other values in the same + section, or values in the special default section [1]_. Additional default + values can be provided on initialization. + + For example: + + .. code-block:: ini + + [Paths] + home_dir: /Users + my_dir: %(home_dir)s/lumberjack + my_pictures: %(my_dir)s/Pictures + + + In the example above, :class:`ConfigParser` with *interpolation* set to + ``BasicInterpolation()`` would resolve ``%(home_dir)s`` to the value of + ``home_dir`` (``/Users`` in this case). ``%(my_dir)s`` in effect would + resolve to ``/Users/lumberjack``. All interpolations are done on demand so + keys used in the chain of references do not have to be specified in any + specific order in the configuration file. + + With ``interpolation`` set to ``None``, the parser would simply return + ``%(my_dir)s/Pictures`` as the value of ``my_pictures`` and + ``%(home_dir)s/lumberjack`` as the value of ``my_dir``. + +.. index:: single: $ (dollar); interpolation in configuration files + +.. class:: ExtendedInterpolation() + + An alternative handler for interpolation which implements a more advanced + syntax, used for instance in ``zc.buildout``. Extended interpolation is + using ``${section:option}`` to denote a value from a foreign section. + Interpolation can span multiple levels. For convenience, if the + ``section:`` part is omitted, interpolation defaults to the current section + (and possibly the default values from the special section). + + For example, the configuration specified above with basic interpolation, + would look like this with extended interpolation: + + .. code-block:: ini + + [Paths] + home_dir: /Users + my_dir: ${home_dir}/lumberjack + my_pictures: ${my_dir}/Pictures + + Values from other sections can be fetched as well: + + .. code-block:: ini + + [Common] + home_dir: /Users + library_dir: /Library + system_dir: /System + macports_dir: /opt/local + + [Frameworks] + Python: 3.2 + path: ${Common:system_dir}/Library/Frameworks/ + + [Arthur] + nickname: Two Sheds + last_name: Jackson + my_dir: ${Common:home_dir}/twosheds + my_pictures: ${my_dir}/Pictures + python_dir: ${Frameworks:path}/Python/Versions/${Frameworks:Python} + +Mapping Protocol Access +----------------------- + +.. versionadded:: 3.2 + +Mapping protocol access is a generic name for functionality that enables using +custom objects as if they were dictionaries. In case of :mod:`configparser`, +the mapping interface implementation is using the +``parser['section']['option']`` notation. + +``parser['section']`` in particular returns a proxy for the section's data in +the parser. This means that the values are not copied but they are taken from +the original parser on demand. What's even more important is that when values +are changed on a section proxy, they are actually mutated in the original +parser. + +:mod:`configparser` objects behave as close to actual dictionaries as possible. +The mapping interface is complete and adheres to the +:class:`~collections.abc.MutableMapping` ABC. +However, there are a few differences that should be taken into account: + +* By default, all keys in sections are accessible in a case-insensitive manner + [1]_. E.g. ``for option in parser["section"]`` yields only ``optionxform``'ed + option key names. This means lowercased keys by default. At the same time, + for a section that holds the key ``'a'``, both expressions return ``True``:: + + "a" in parser["section"] + "A" in parser["section"] + +* All sections include ``DEFAULTSECT`` values as well which means that + ``.clear()`` on a section may not leave the section visibly empty. This is + because default values cannot be deleted from the section (because technically + they are not there). If they are overridden in the section, deleting causes + the default value to be visible again. Trying to delete a default value + causes a :exc:`KeyError`. + +* ``DEFAULTSECT`` cannot be removed from the parser: + + * trying to delete it raises :exc:`ValueError`, + + * ``parser.clear()`` leaves it intact, + + * ``parser.popitem()`` never returns it. + +* ``parser.get(section, option, **kwargs)`` - the second argument is **not** + a fallback value. Note however that the section-level ``get()`` methods are + compatible both with the mapping protocol and the classic configparser API. + +* ``parser.items()`` is compatible with the mapping protocol (returns a list of + *section_name*, *section_proxy* pairs including the DEFAULTSECT). However, + this method can also be invoked with arguments: ``parser.items(section, raw, + vars)``. The latter call returns a list of *option*, *value* pairs for + a specified ``section``, with all interpolations expanded (unless + ``raw=True`` is provided). + +The mapping protocol is implemented on top of the existing legacy API so that +subclasses overriding the original interface still should have mappings working +as expected. + + +Customizing Parser Behaviour +---------------------------- + +There are nearly as many INI format variants as there are applications using it. +:mod:`configparser` goes a long way to provide support for the largest sensible +set of INI styles available. The default functionality is mainly dictated by +historical background and it's very likely that you will want to customize some +of the features. + +The most common way to change the way a specific config parser works is to use +the :meth:`__init__` options: + +* *defaults*, default value: ``None`` + + This option accepts a dictionary of key-value pairs which will be initially + put in the ``DEFAULT`` section. This makes for an elegant way to support + concise configuration files that don't specify values which are the same as + the documented default. + + Hint: if you want to specify default values for a specific section, use + :meth:`read_dict` before you read the actual file. + +* *dict_type*, default value: :class:`collections.OrderedDict` + + This option has a major impact on how the mapping protocol will behave and how + the written configuration files look. With the default ordered + dictionary, every section is stored in the order they were added to the + parser. Same goes for options within sections. + + An alternative dictionary type can be used for example to sort sections and + options on write-back. You can also use a regular dictionary for performance + reasons. + + Please note: there are ways to add a set of key-value pairs in a single + operation. When you use a regular dictionary in those operations, the order + of the keys will be ordered because dict preserves order from Python 3.7. + For example: + + .. doctest:: + + >>> parser = configparser.ConfigParser() + >>> parser.read_dict({'section1': {'key1': 'value1', + ... 'key2': 'value2', + ... 'key3': 'value3'}, + ... 'section2': {'keyA': 'valueA', + ... 'keyB': 'valueB', + ... 'keyC': 'valueC'}, + ... 'section3': {'foo': 'x', + ... 'bar': 'y', + ... 'baz': 'z'} + ... }) + >>> parser.sections() + ['section1', 'section2', 'section3'] + >>> [option for option in parser['section3']] + ['foo', 'bar', 'baz'] + +* *allow_no_value*, default value: ``False`` + + Some configuration files are known to include settings without values, but + which otherwise conform to the syntax supported by :mod:`configparser`. The + *allow_no_value* parameter to the constructor can be used to + indicate that such values should be accepted: + + .. doctest:: + + >>> import configparser + + >>> sample_config = """ + ... [mysqld] + ... user = mysql + ... pid-file = /var/run/mysqld/mysqld.pid + ... skip-external-locking + ... old_passwords = 1 + ... skip-bdb + ... # we don't need ACID today + ... skip-innodb + ... """ + >>> config = configparser.ConfigParser(allow_no_value=True) + >>> config.read_string(sample_config) + + >>> # Settings with values are treated as before: + >>> config["mysqld"]["user"] + 'mysql' + + >>> # Settings without values provide None: + >>> config["mysqld"]["skip-bdb"] + + >>> # Settings which aren't specified still raise an error: + >>> config["mysqld"]["does-not-exist"] + Traceback (most recent call last): + ... + KeyError: 'does-not-exist' + +* *delimiters*, default value: ``('=', ':')`` + + Delimiters are substrings that delimit keys from values within a section. + The first occurrence of a delimiting substring on a line is considered + a delimiter. This means values (but not keys) can contain the delimiters. + + See also the *space_around_delimiters* argument to + :meth:`ConfigParser.write`. + +* *comment_prefixes*, default value: ``('#', ';')`` + +* *inline_comment_prefixes*, default value: ``None`` + + Comment prefixes are strings that indicate the start of a valid comment within + a config file. *comment_prefixes* are used only on otherwise empty lines + (optionally indented) whereas *inline_comment_prefixes* can be used after + every valid value (e.g. section names, options and empty lines as well). By + default inline comments are disabled and ``'#'`` and ``';'`` are used as + prefixes for whole line comments. + + .. versionchanged:: 3.2 + In previous versions of :mod:`configparser` behaviour matched + ``comment_prefixes=('#',';')`` and ``inline_comment_prefixes=(';',)``. + + Please note that config parsers don't support escaping of comment prefixes so + using *inline_comment_prefixes* may prevent users from specifying option + values with characters used as comment prefixes. When in doubt, avoid + setting *inline_comment_prefixes*. In any circumstances, the only way of + storing comment prefix characters at the beginning of a line in multiline + values is to interpolate the prefix, for example:: + + >>> from configparser import ConfigParser, ExtendedInterpolation + >>> parser = ConfigParser(interpolation=ExtendedInterpolation()) + >>> # the default BasicInterpolation could be used as well + >>> parser.read_string(""" + ... [DEFAULT] + ... hash = # + ... + ... [hashes] + ... shebang = + ... ${hash}!/usr/bin/env python + ... ${hash} -*- coding: utf-8 -*- + ... + ... extensions = + ... enabled_extension + ... another_extension + ... #disabled_by_comment + ... yet_another_extension + ... + ... interpolation not necessary = if # is not at line start + ... even in multiline values = line #1 + ... line #2 + ... line #3 + ... """) + >>> print(parser['hashes']['shebang']) + + #!/usr/bin/env python + # -*- coding: utf-8 -*- + >>> print(parser['hashes']['extensions']) + + enabled_extension + another_extension + yet_another_extension + >>> print(parser['hashes']['interpolation not necessary']) + if # is not at line start + >>> print(parser['hashes']['even in multiline values']) + line #1 + line #2 + line #3 + +* *strict*, default value: ``True`` + + When set to ``True``, the parser will not allow for any section or option + duplicates while reading from a single source (using :meth:`read_file`, + :meth:`read_string` or :meth:`read_dict`). It is recommended to use strict + parsers in new applications. + + .. versionchanged:: 3.2 + In previous versions of :mod:`configparser` behaviour matched + ``strict=False``. + +* *empty_lines_in_values*, default value: ``True`` + + In config parsers, values can span multiple lines as long as they are + indented more than the key that holds them. By default parsers also let + empty lines to be parts of values. At the same time, keys can be arbitrarily + indented themselves to improve readability. In consequence, when + configuration files get big and complex, it is easy for the user to lose + track of the file structure. Take for instance: + + .. code-block:: ini + + [Section] + key = multiline + value with a gotcha + + this = is still a part of the multiline value of 'key' + + This can be especially problematic for the user to see if she's using a + proportional font to edit the file. That is why when your application does + not need values with empty lines, you should consider disallowing them. This + will make empty lines split keys every time. In the example above, it would + produce two keys, ``key`` and ``this``. + +* *default_section*, default value: ``configparser.DEFAULTSECT`` (that is: + ``"DEFAULT"``) + + The convention of allowing a special section of default values for other + sections or interpolation purposes is a powerful concept of this library, + letting users create complex declarative configurations. This section is + normally called ``"DEFAULT"`` but this can be customized to point to any + other valid section name. Some typical values include: ``"general"`` or + ``"common"``. The name provided is used for recognizing default sections + when reading from any source and is used when writing configuration back to + a file. Its current value can be retrieved using the + ``parser_instance.default_section`` attribute and may be modified at runtime + (i.e. to convert files from one format to another). + +* *interpolation*, default value: ``configparser.BasicInterpolation`` + + Interpolation behaviour may be customized by providing a custom handler + through the *interpolation* argument. ``None`` can be used to turn off + interpolation completely, ``ExtendedInterpolation()`` provides a more + advanced variant inspired by ``zc.buildout``. More on the subject in the + `dedicated documentation section <#interpolation-of-values>`_. + :class:`RawConfigParser` has a default value of ``None``. + +* *converters*, default value: not set + + Config parsers provide option value getters that perform type conversion. By + default :meth:`~ConfigParser.getint`, :meth:`~ConfigParser.getfloat`, and + :meth:`~ConfigParser.getboolean` are implemented. Should other getters be + desirable, users may define them in a subclass or pass a dictionary where each + key is a name of the converter and each value is a callable implementing said + conversion. For instance, passing ``{'decimal': decimal.Decimal}`` would add + :meth:`getdecimal` on both the parser object and all section proxies. In + other words, it will be possible to write both + ``parser_instance.getdecimal('section', 'key', fallback=0)`` and + ``parser_instance['section'].getdecimal('key', 0)``. + + If the converter needs to access the state of the parser, it can be + implemented as a method on a config parser subclass. If the name of this + method starts with ``get``, it will be available on all section proxies, in + the dict-compatible form (see the ``getdecimal()`` example above). + +More advanced customization may be achieved by overriding default values of +these parser attributes. The defaults are defined on the classes, so they may +be overridden by subclasses or by attribute assignment. + +.. attribute:: ConfigParser.BOOLEAN_STATES + + By default when using :meth:`~ConfigParser.getboolean`, config parsers + consider the following values ``True``: ``'1'``, ``'yes'``, ``'true'``, + ``'on'`` and the following values ``False``: ``'0'``, ``'no'``, ``'false'``, + ``'off'``. You can override this by specifying a custom dictionary of strings + and their Boolean outcomes. For example: + + .. doctest:: + + >>> custom = configparser.ConfigParser() + >>> custom['section1'] = {'funky': 'nope'} + >>> custom['section1'].getboolean('funky') + Traceback (most recent call last): + ... + ValueError: Not a boolean: nope + >>> custom.BOOLEAN_STATES = {'sure': True, 'nope': False} + >>> custom['section1'].getboolean('funky') + False + + Other typical Boolean pairs include ``accept``/``reject`` or + ``enabled``/``disabled``. + +.. method:: ConfigParser.optionxform(option) + + This method transforms option names on every read, get, or set + operation. The default converts the name to lowercase. This also + means that when a configuration file gets written, all keys will be + lowercase. Override this method if that's unsuitable. + For example: + + .. doctest:: + + >>> config = """ + ... [Section1] + ... Key = Value + ... + ... [Section2] + ... AnotherKey = Value + ... """ + >>> typical = configparser.ConfigParser() + >>> typical.read_string(config) + >>> list(typical['Section1'].keys()) + ['key'] + >>> list(typical['Section2'].keys()) + ['anotherkey'] + >>> custom = configparser.RawConfigParser() + >>> custom.optionxform = lambda option: option + >>> custom.read_string(config) + >>> list(custom['Section1'].keys()) + ['Key'] + >>> list(custom['Section2'].keys()) + ['AnotherKey'] + + .. note:: + The optionxform function transforms option names to a canonical form. + This should be an idempotent function: if the name is already in + canonical form, it should be returned unchanged. + + +.. attribute:: ConfigParser.SECTCRE + + A compiled regular expression used to parse section headers. The default + matches ``[section]`` to the name ``"section"``. Whitespace is considered + part of the section name, thus ``[ larch ]`` will be read as a section of + name ``" larch "``. Override this attribute if that's unsuitable. For + example: + + .. doctest:: + + >>> import re + >>> config = """ + ... [Section 1] + ... option = value + ... + ... [ Section 2 ] + ... another = val + ... """ + >>> typical = configparser.ConfigParser() + >>> typical.read_string(config) + >>> typical.sections() + ['Section 1', ' Section 2 '] + >>> custom = configparser.ConfigParser() + >>> custom.SECTCRE = re.compile(r"\[ *(?P

    [^]]+?) *\]") + >>> custom.read_string(config) + >>> custom.sections() + ['Section 1', 'Section 2'] + + .. note:: + + While ConfigParser objects also use an ``OPTCRE`` attribute for recognizing + option lines, it's not recommended to override it because that would + interfere with constructor options *allow_no_value* and *delimiters*. + + +Legacy API Examples +------------------- + +Mainly because of backwards compatibility concerns, :mod:`configparser` +provides also a legacy API with explicit ``get``/``set`` methods. While there +are valid use cases for the methods outlined below, mapping protocol access is +preferred for new projects. The legacy API is at times more advanced, +low-level and downright counterintuitive. + +An example of writing to a configuration file:: + + import configparser + + config = configparser.RawConfigParser() + + # Please note that using RawConfigParser's set functions, you can assign + # non-string values to keys internally, but will receive an error when + # attempting to write to a file or when you get it in non-raw mode. Setting + # values using the mapping protocol or ConfigParser's set() does not allow + # such assignments to take place. + config.add_section('Section1') + config.set('Section1', 'an_int', '15') + config.set('Section1', 'a_bool', 'true') + config.set('Section1', 'a_float', '3.1415') + config.set('Section1', 'baz', 'fun') + config.set('Section1', 'bar', 'Python') + config.set('Section1', 'foo', '%(bar)s is %(baz)s!') + + # Writing our configuration file to 'example.cfg' + with open('example.cfg', 'w') as configfile: + config.write(configfile) + +An example of reading the configuration file again:: + + import configparser + + config = configparser.RawConfigParser() + config.read('example.cfg') + + # getfloat() raises an exception if the value is not a float + # getint() and getboolean() also do this for their respective types + a_float = config.getfloat('Section1', 'a_float') + an_int = config.getint('Section1', 'an_int') + print(a_float + an_int) + + # Notice that the next output does not interpolate '%(bar)s' or '%(baz)s'. + # This is because we are using a RawConfigParser(). + if config.getboolean('Section1', 'a_bool'): + print(config.get('Section1', 'foo')) + +To get interpolation, use :class:`ConfigParser`:: + + import configparser + + cfg = configparser.ConfigParser() + cfg.read('example.cfg') + + # 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!" + + # 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'})) + + # The optional *fallback* argument can be used to provide a fallback value + print(cfg.get('Section1', 'foo')) + # -> "Python is fun!" + + print(cfg.get('Section1', 'foo', fallback='Monty is not.')) + # -> "Python is fun!" + + print(cfg.get('Section1', 'monster', fallback='No such things as monsters.')) + # -> "No such things as monsters." + + # A bare print(cfg.get('Section1', 'monster')) would raise NoOptionError + # but we can also use: + + print(cfg.get('Section1', 'monster', fallback=None)) + # -> None + +Default values are available in both types of ConfigParsers. They are used in +interpolation if an option used is not defined elsewhere. :: + + import configparser + + # New instance with 'bar' and 'baz' defaulting to 'Life' and 'hard' each + config = configparser.ConfigParser({'bar': 'Life', 'baz': 'hard'}) + config.read('example.cfg') + + 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!" + + +.. _configparser-objects: + +ConfigParser Objects +-------------------- + +.. class:: ConfigParser(defaults=None, dict_type=collections.OrderedDict, allow_no_value=False, delimiters=('=', ':'), comment_prefixes=('#', ';'), inline_comment_prefixes=None, strict=True, empty_lines_in_values=True, default_section=configparser.DEFAULTSECT, interpolation=BasicInterpolation(), converters={}) + + The main configuration parser. When *defaults* is given, it is initialized + into the dictionary of intrinsic defaults. When *dict_type* is given, it + will be used to create the dictionary objects for the list of sections, for + the options within a section, and for the default values. + + When *delimiters* is given, it is used as the set of substrings that + divide keys from values. When *comment_prefixes* is given, it will be used + as the set of substrings that prefix comments in otherwise empty lines. + Comments can be indented. When *inline_comment_prefixes* is given, it will + be used as the set of substrings that prefix comments in non-empty lines. + + When *strict* is ``True`` (the default), the parser won't allow for + any section or option duplicates while reading from a single source (file, + string or dictionary), raising :exc:`DuplicateSectionError` or + :exc:`DuplicateOptionError`. When *empty_lines_in_values* is ``False`` + (default: ``True``), each empty line marks the end of an option. Otherwise, + internal empty lines of a multiline option are kept as part of the value. + When *allow_no_value* is ``True`` (default: ``False``), options without + values are accepted; the value held for these is ``None`` and they are + serialized without the trailing delimiter. + + When *default_section* is given, it specifies the name for the special + section holding default values for other sections and interpolation purposes + (normally named ``"DEFAULT"``). This value can be retrieved and changed on + runtime using the ``default_section`` instance attribute. + + Interpolation behaviour may be customized by providing a custom handler + through the *interpolation* argument. ``None`` can be used to turn off + interpolation completely, ``ExtendedInterpolation()`` provides a more + advanced variant inspired by ``zc.buildout``. More on the subject in the + `dedicated documentation section <#interpolation-of-values>`_. + + All option names used in interpolation will be passed through the + :meth:`optionxform` method just like any other option name reference. For + example, using the default implementation of :meth:`optionxform` (which + converts option names to lower case), the values ``foo %(bar)s`` and ``foo + %(BAR)s`` are equivalent. + + When *converters* is given, it should be a dictionary where each key + represents the name of a type converter and each value is a callable + implementing the conversion from string to the desired datatype. Every + converter gets its own corresponding :meth:`get*()` method on the parser + object and section proxies. + + .. versionchanged:: 3.1 + The default *dict_type* is :class:`collections.OrderedDict`. + + .. versionchanged:: 3.2 + *allow_no_value*, *delimiters*, *comment_prefixes*, *strict*, + *empty_lines_in_values*, *default_section* and *interpolation* were + added. + + .. versionchanged:: 3.5 + The *converters* argument was added. + + .. versionchanged:: 3.7 + The *defaults* argument is read with :meth:`read_dict()`, + providing consistent behavior across the parser: non-string + keys and values are implicitly converted to strings. + + .. method:: defaults() + + Return a dictionary containing the instance-wide defaults. + + + .. method:: sections() + + Return a list of the sections available; the *default section* is not + included in the list. + + + .. method:: add_section(section) + + Add a section named *section* to the instance. If a section by the given + name already exists, :exc:`DuplicateSectionError` is raised. If the + *default section* name is passed, :exc:`ValueError` is raised. The name + of the section must be a string; if not, :exc:`TypeError` is raised. + + .. versionchanged:: 3.2 + Non-string section names raise :exc:`TypeError`. + + + .. method:: has_section(section) + + Indicates whether the named *section* is present in the configuration. + The *default section* is not acknowledged. + + + .. method:: options(section) + + Return a list of options available in the specified *section*. + + + .. method:: has_option(section, option) + + If the given *section* exists, and contains the given *option*, return + :const:`True`; otherwise return :const:`False`. If the specified + *section* is :const:`None` or an empty string, DEFAULT is assumed. + + + .. method:: read(filenames, encoding=None) + + Attempt to read and parse an iterable of filenames, returning a list of + filenames which were successfully parsed. + + If *filenames* is a string, a :class:`bytes` object or a + :term:`path-like object`, it is treated as + a single filename. If a file named in *filenames* cannot be opened, that + file will be ignored. This is designed so that you can specify an + iterable of potential configuration file locations (for example, the + current directory, the user's home directory, and some system-wide + directory), and all existing configuration files in the iterable will be + read. + + If none of the named files exist, the :class:`ConfigParser` + instance will contain an empty dataset. An application which requires + initial values to be loaded from a file should load the required file or + files using :meth:`read_file` before calling :meth:`read` for any + optional files:: + + import configparser, os + + config = configparser.ConfigParser() + config.read_file(open('defaults.cfg')) + config.read(['site.cfg', os.path.expanduser('~/.myapp.cfg')], + encoding='cp1250') + + .. versionadded:: 3.2 + The *encoding* parameter. Previously, all files were read using the + default encoding for :func:`open`. + + .. versionadded:: 3.6.1 + The *filenames* parameter accepts a :term:`path-like object`. + + .. versionadded:: 3.7 + The *filenames* parameter accepts a :class:`bytes` object. + + + .. method:: read_file(f, source=None) + + Read and parse configuration data from *f* which must be an iterable + yielding Unicode strings (for example files opened in text mode). + + Optional argument *source* specifies the name of the file being read. If + not given and *f* has a :attr:`name` attribute, that is used for + *source*; the default is ``''``. + + .. versionadded:: 3.2 + Replaces :meth:`readfp`. + + .. method:: read_string(string, source='') + + Parse configuration data from a string. + + Optional argument *source* specifies a context-specific name of the + string passed. If not given, ``''`` is used. This should + commonly be a filesystem path or a URL. + + .. versionadded:: 3.2 + + + .. method:: read_dict(dictionary, source='') + + Load configuration from any object that provides a dict-like ``items()`` + method. Keys are section names, values are dictionaries with keys and + values that should be present in the section. If the used dictionary + type preserves order, sections and their keys will be added in order. + Values are automatically converted to strings. + + Optional argument *source* specifies a context-specific name of the + dictionary passed. If not given, ```` is used. + + This method can be used to copy state between parsers. + + .. versionadded:: 3.2 + + + .. method:: get(section, option, *, raw=False, vars=None[, fallback]) + + Get an *option* value for the named *section*. If *vars* is provided, it + must be a dictionary. The *option* is looked up in *vars* (if provided), + *section*, and in *DEFAULTSECT* in that order. If the key is not found + and *fallback* is provided, it is used as a fallback value. ``None`` can + be provided as a *fallback* value. + + All the ``'%'`` interpolations are expanded in the return values, unless + the *raw* argument is true. Values for interpolation keys are looked up + in the same manner as the option. + + .. versionchanged:: 3.2 + Arguments *raw*, *vars* and *fallback* are keyword only to protect + users from trying to use the third argument as the *fallback* fallback + (especially when using the mapping protocol). + + + .. method:: getint(section, option, *, raw=False, vars=None[, fallback]) + + A convenience method which coerces the *option* in the specified *section* + to an integer. See :meth:`get` for explanation of *raw*, *vars* and + *fallback*. + + + .. method:: getfloat(section, option, *, raw=False, vars=None[, fallback]) + + A convenience method which coerces the *option* in the specified *section* + to a floating point number. See :meth:`get` for explanation of *raw*, + *vars* and *fallback*. + + + .. method:: getboolean(section, option, *, raw=False, vars=None[, fallback]) + + A convenience method which coerces the *option* in the specified *section* + to a Boolean value. Note that the accepted values for the option are + ``'1'``, ``'yes'``, ``'true'``, and ``'on'``, which cause this method to + return ``True``, and ``'0'``, ``'no'``, ``'false'``, and ``'off'``, which + cause it to return ``False``. These string values are checked in a + case-insensitive manner. Any other value will cause it to raise + :exc:`ValueError`. See :meth:`get` for explanation of *raw*, *vars* and + *fallback*. + + + .. method:: items(raw=False, vars=None) + items(section, raw=False, vars=None) + + When *section* is not given, return a list of *section_name*, + *section_proxy* pairs, including DEFAULTSECT. + + Otherwise, return a list of *name*, *value* pairs for the options in the + given *section*. Optional arguments have the same meaning as for the + :meth:`get` method. + + + .. method:: set(section, option, value) + + If the given section exists, set the given option to the specified value; + otherwise raise :exc:`NoSectionError`. *option* and *value* must be + strings; if not, :exc:`TypeError` is raised. + + + .. method:: write(fileobject, space_around_delimiters=True) + + Write a representation of the configuration to the specified :term:`file + object`, which must be opened in text mode (accepting strings). This + representation can be parsed by a future :meth:`read` call. If + *space_around_delimiters* is true, delimiters between + keys and values are surrounded by spaces. + + + .. method:: remove_option(section, option) + + Remove the specified *option* from the specified *section*. If the + section does not exist, raise :exc:`NoSectionError`. If the option + existed to be removed, return :const:`True`; otherwise return + :const:`False`. + + + .. method:: remove_section(section) + + Remove the specified *section* from the configuration. If the section in + fact existed, return ``True``. Otherwise return ``False``. + + + .. method:: optionxform(option) + + Transforms the option name *option* as found in an input file or as passed + in by client code to the form that should be used in the internal + structures. The default implementation returns a lower-case version of + *option*; subclasses may override this or client code can set an attribute + of this name on instances to affect this behavior. + + You don't need to subclass the parser to use this method, you can also + set it on an instance, to a function that takes a string argument and + returns a string. Setting it to ``str``, for example, would make option + names case sensitive:: + + cfgparser = ConfigParser() + cfgparser.optionxform = str + + Note that when reading configuration files, whitespace around the option + names is stripped before :meth:`optionxform` is called. + + + .. method:: readfp(fp, filename=None) + + .. deprecated:: 3.2 + Use :meth:`read_file` instead. + + .. versionchanged:: 3.2 + :meth:`readfp` now iterates on *fp* instead of calling ``fp.readline()``. + + For existing code calling :meth:`readfp` with arguments which don't + support iteration, the following generator may be used as a wrapper + around the file-like object:: + + def readline_generator(fp): + line = fp.readline() + while line: + yield line + line = fp.readline() + + Instead of ``parser.readfp(fp)`` use + ``parser.read_file(readline_generator(fp))``. + + +.. data:: MAX_INTERPOLATION_DEPTH + + The maximum depth for recursive interpolation for :meth:`get` when the *raw* + parameter is false. This is relevant only when the default *interpolation* + is used. + + +.. _rawconfigparser-objects: + +RawConfigParser Objects +----------------------- + +.. class:: RawConfigParser(defaults=None, dict_type=collections.OrderedDict, \ + allow_no_value=False, *, delimiters=('=', ':'), \ + comment_prefixes=('#', ';'), \ + inline_comment_prefixes=None, strict=True, \ + empty_lines_in_values=True, \ + default_section=configparser.DEFAULTSECT[, \ + interpolation]) + + Legacy variant of the :class:`ConfigParser`. It has interpolation + disabled by default and allows for non-string section names, option + names, and values via its unsafe ``add_section`` and ``set`` methods, + as well as the legacy ``defaults=`` keyword argument handling. + + .. note:: + Consider using :class:`ConfigParser` instead which checks types of + the values to be stored internally. If you don't want interpolation, you + can use ``ConfigParser(interpolation=None)``. + + + .. method:: add_section(section) + + Add a section named *section* to the instance. If a section by the given + name already exists, :exc:`DuplicateSectionError` is raised. If the + *default section* name is passed, :exc:`ValueError` is raised. + + Type of *section* is not checked which lets users create non-string named + sections. This behaviour is unsupported and may cause internal errors. + + + .. method:: set(section, option, value) + + If the given section exists, set the given option to the specified value; + otherwise raise :exc:`NoSectionError`. While it is possible to use + :class:`RawConfigParser` (or :class:`ConfigParser` with *raw* parameters + set to true) for *internal* storage of non-string values, full + functionality (including interpolation and output to files) can only be + achieved using string values. + + This method lets users assign non-string values to keys internally. This + behaviour is unsupported and will cause errors when attempting to write + to a file or get it in non-raw mode. **Use the mapping protocol API** + which does not allow such assignments to take place. + + +Exceptions +---------- + +.. exception:: Error + + Base class for all other :mod:`configparser` exceptions. + + +.. exception:: NoSectionError + + Exception raised when a specified section is not found. + + +.. exception:: DuplicateSectionError + + Exception raised if :meth:`add_section` is called with the name of a section + that is already present or in strict parsers when a section if found more + than once in a single input file, string or dictionary. + + .. versionadded:: 3.2 + Optional ``source`` and ``lineno`` attributes and arguments to + :meth:`__init__` were added. + + +.. exception:: DuplicateOptionError + + Exception raised by strict parsers if a single option appears twice during + reading from a single file, string or dictionary. This catches misspellings + and case sensitivity-related errors, e.g. a dictionary may have two keys + representing the same case-insensitive configuration key. + + +.. exception:: NoOptionError + + Exception raised when a specified option is not found in the specified + section. + + +.. exception:: InterpolationError + + Base class for exceptions raised when problems occur performing string + interpolation. + + +.. exception:: InterpolationDepthError + + Exception raised when string interpolation cannot be completed because the + number of iterations exceeds :const:`MAX_INTERPOLATION_DEPTH`. Subclass of + :exc:`InterpolationError`. + + +.. exception:: InterpolationMissingOptionError + + Exception raised when an option referenced from a value does not exist. + Subclass of :exc:`InterpolationError`. + + +.. exception:: InterpolationSyntaxError + + Exception raised when the source text into which substitutions are made does + not conform to the required syntax. Subclass of :exc:`InterpolationError`. + + +.. exception:: MissingSectionHeaderError + + Exception raised when attempting to parse a file which has no section + headers. + + +.. exception:: ParsingError + + Exception raised when errors occur attempting to parse a file. + + .. versionchanged:: 3.2 + The ``filename`` attribute and :meth:`__init__` argument were renamed to + ``source`` for consistency. + + +.. rubric:: Footnotes + +.. [1] Config parsers allow for heavy customization. If you are interested in + changing the behaviour outlined by the footnote reference, consult the + `Customizing Parser Behaviour`_ section. diff --git a/python-3.7.4-docs-html/_sources/library/constants.rst.txt b/python-3.7.4-docs-html/_sources/library/constants.rst.txt new file mode 100644 index 0000000..634ff00 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/constants.rst.txt @@ -0,0 +1,100 @@ +.. _built-in-consts: + +Built-in Constants +================== + +A small number of constants live in the built-in namespace. They are: + +.. data:: False + + The false value of the :class:`bool` type. Assignments to ``False`` + are illegal and raise a :exc:`SyntaxError`. + + +.. data:: True + + The true value of the :class:`bool` type. Assignments to ``True`` + are illegal and raise a :exc:`SyntaxError`. + + +.. data:: None + + The sole value of the type ``NoneType``. ``None`` is frequently used to + represent the absence of a value, as when default arguments are not passed to a + function. Assignments to ``None`` are illegal and raise a :exc:`SyntaxError`. + + +.. data:: NotImplemented + + Special value which should be returned by the binary special methods + (e.g. :meth:`__eq__`, :meth:`__lt__`, :meth:`__add__`, :meth:`__rsub__`, + etc.) to indicate that the operation is not implemented with respect to + the other type; may be returned by the in-place binary special methods + (e.g. :meth:`__imul__`, :meth:`__iand__`, etc.) for the same purpose. + Its truth value is true. + + .. note:: + + When a binary (or in-place) method returns ``NotImplemented`` the + interpreter will try the reflected operation on the other type (or some + other fallback, depending on the operator). If all attempts return + ``NotImplemented``, the interpreter will raise an appropriate exception. + Incorrectly returning ``NotImplemented`` will result in a misleading + error message or the ``NotImplemented`` value being returned to Python code. + + See :ref:`implementing-the-arithmetic-operations` for examples. + + .. note:: + + ``NotImplementedError`` and ``NotImplemented`` are not interchangeable, + even though they have similar names and purposes. + See :exc:`NotImplementedError` for details on when to use it. + + +.. index:: single: ...; ellipsis literal +.. data:: Ellipsis + + The same as the ellipsis literal "``...``". Special value used mostly in conjunction + with extended slicing syntax for user-defined container data types. + + +.. data:: __debug__ + + This constant is true if Python was not started with an :option:`-O` option. + See also the :keyword:`assert` statement. + + +.. note:: + + The names :data:`None`, :data:`False`, :data:`True` and :data:`__debug__` + cannot be reassigned (assignments to them, even as an attribute name, raise + :exc:`SyntaxError`), so they can be considered "true" constants. + + +Constants added by the :mod:`site` module +----------------------------------------- + +The :mod:`site` module (which is imported automatically during startup, except +if the :option:`-S` command-line option is given) adds several constants to the +built-in namespace. They are useful for the interactive interpreter shell and +should not be used in programs. + +.. data:: quit(code=None) + exit(code=None) + + Objects that when printed, print a message like "Use quit() or Ctrl-D + (i.e. EOF) to exit", and when called, raise :exc:`SystemExit` with the + specified exit code. + +.. data:: copyright + credits + + Objects that when printed or called, print the text of copyright or + credits, respectively. + +.. data:: license + + Object that when printed, prints the message "Type license() to see the + full license text", and when called, displays the full license text in a + pager-like fashion (one screen at a time). + diff --git a/python-3.7.4-docs-html/_sources/library/contextlib.rst.txt b/python-3.7.4-docs-html/_sources/library/contextlib.rst.txt new file mode 100644 index 0000000..017a87a --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/contextlib.rst.txt @@ -0,0 +1,872 @@ +:mod:`!contextlib` --- Utilities for :keyword:`!with`\ -statement contexts +========================================================================== + +.. module:: contextlib + :synopsis: Utilities for with-statement contexts. + +**Source code:** :source:`Lib/contextlib.py` + +-------------- + +This module provides utilities for common tasks involving the :keyword:`with` +statement. For more information see also :ref:`typecontextmanager` and +:ref:`context-managers`. + + +Utilities +--------- + +Functions and classes provided: + +.. class:: AbstractContextManager + + An :term:`abstract base class` for classes that implement + :meth:`object.__enter__` and :meth:`object.__exit__`. A default + implementation for :meth:`object.__enter__` is provided which returns + ``self`` while :meth:`object.__exit__` is an abstract method which by default + returns ``None``. See also the definition of :ref:`typecontextmanager`. + + .. versionadded:: 3.6 + + +.. class:: AbstractAsyncContextManager + + An :term:`abstract base class` for classes that implement + :meth:`object.__aenter__` and :meth:`object.__aexit__`. A default + implementation for :meth:`object.__aenter__` is provided which returns + ``self`` while :meth:`object.__aexit__` is an abstract method which by default + returns ``None``. See also the definition of + :ref:`async-context-managers`. + + .. versionadded:: 3.7 + + +.. decorator:: contextmanager + + This function is a :term:`decorator` that can be used to define a factory + function for :keyword:`with` statement context managers, without needing to + create a class or separate :meth:`__enter__` and :meth:`__exit__` methods. + + While many objects natively support use in with statements, sometimes a + resource needs to be managed that isn't a context manager in its own right, + and doesn't implement a ``close()`` method for use with ``contextlib.closing`` + + An abstract example would be the following to ensure correct resource + management:: + + from contextlib import contextmanager + + @contextmanager + def managed_resource(*args, **kwds): + # Code to acquire resource, e.g.: + resource = acquire_resource(*args, **kwds) + try: + yield resource + finally: + # Code to release resource, e.g.: + release_resource(resource) + + >>> with managed_resource(timeout=3600) as resource: + ... # Resource is released at the end of this block, + ... # even if code in the block raises an exception + + The function being decorated must return a :term:`generator`-iterator when + called. This iterator must yield exactly one value, which will be bound to + the targets in the :keyword:`with` statement's :keyword:`!as` clause, if any. + + At the point where the generator yields, the block nested in the :keyword:`with` + statement is executed. The generator is then resumed after the block is exited. + If an unhandled exception occurs in the block, it is reraised inside the + generator at the point where the yield occurred. Thus, you can use a + :keyword:`try`...\ :keyword:`except`...\ :keyword:`finally` statement to trap + the error (if any), or ensure that some cleanup takes place. If an exception is + trapped merely in order to log it or to perform some action (rather than to + suppress it entirely), the generator must reraise that exception. Otherwise the + generator context manager will indicate to the :keyword:`!with` statement that + the exception has been handled, and execution will resume with the statement + immediately following the :keyword:`!with` statement. + + :func:`contextmanager` uses :class:`ContextDecorator` so the context managers + it creates can be used as decorators as well as in :keyword:`with` statements. + When used as a decorator, a new generator instance is implicitly created on + each function call (this allows the otherwise "one-shot" context managers + created by :func:`contextmanager` to meet the requirement that context + managers support multiple invocations in order to be used as decorators). + + .. versionchanged:: 3.2 + Use of :class:`ContextDecorator`. + + +.. decorator:: asynccontextmanager + + Similar to :func:`~contextlib.contextmanager`, but creates an + :ref:`asynchronous context manager `. + + This function is a :term:`decorator` that can be used to define a factory + function for :keyword:`async with` statement asynchronous context managers, + without needing to create a class or separate :meth:`__aenter__` and + :meth:`__aexit__` methods. It must be applied to an :term:`asynchronous + generator` function. + + A simple example:: + + from contextlib import asynccontextmanager + + @asynccontextmanager + async def get_connection(): + conn = await acquire_db_connection() + try: + yield conn + finally: + await release_db_connection(conn) + + async def get_all_users(): + async with get_connection() as conn: + return conn.query('SELECT ...') + + .. versionadded:: 3.7 + + +.. function:: closing(thing) + + Return a context manager that closes *thing* upon completion of the block. This + is basically equivalent to:: + + from contextlib import contextmanager + + @contextmanager + def closing(thing): + try: + yield thing + finally: + thing.close() + + And lets you write code like this:: + + from contextlib import closing + from urllib.request import urlopen + + with closing(urlopen('http://www.python.org')) as page: + for line in page: + print(line) + + without needing to explicitly close ``page``. Even if an error occurs, + ``page.close()`` will be called when the :keyword:`with` block is exited. + + +.. _simplifying-support-for-single-optional-context-managers: + +.. function:: nullcontext(enter_result=None) + + Return a context manager that returns *enter_result* from ``__enter__``, but + otherwise does nothing. It is intended to be used as a stand-in for an + optional context manager, for example:: + + def myfunction(arg, ignore_exceptions=False): + if ignore_exceptions: + # Use suppress to ignore all exceptions. + cm = contextlib.suppress(Exception) + else: + # Do not ignore any exceptions, cm has no effect. + cm = contextlib.nullcontext() + with cm: + # Do something + + An example using *enter_result*:: + + def process_file(file_or_path): + if isinstance(file_or_path, str): + # If string, open file + cm = open(file_or_path) + else: + # Caller is responsible for closing file + cm = nullcontext(file_or_path) + + with cm as file: + # Perform processing on the file + + .. versionadded:: 3.7 + + +.. function:: suppress(*exceptions) + + Return a context manager that suppresses any of the specified exceptions + if they occur in the body of a with statement and then resumes execution + with the first statement following the end of the with statement. + + As with any other mechanism that completely suppresses exceptions, this + context manager should be used only to cover very specific errors where + silently continuing with program execution is known to be the right + thing to do. + + For example:: + + from contextlib import suppress + + with suppress(FileNotFoundError): + os.remove('somefile.tmp') + + with suppress(FileNotFoundError): + os.remove('someotherfile.tmp') + + This code is equivalent to:: + + try: + os.remove('somefile.tmp') + except FileNotFoundError: + pass + + try: + os.remove('someotherfile.tmp') + except FileNotFoundError: + pass + + This context manager is :ref:`reentrant `. + + .. versionadded:: 3.4 + + +.. function:: redirect_stdout(new_target) + + Context manager for temporarily redirecting :data:`sys.stdout` to + another file or file-like object. + + This tool adds flexibility to existing functions or classes whose output + is hardwired to stdout. + + For example, the output of :func:`help` normally is sent to *sys.stdout*. + You can capture that output in a string by redirecting the output to an + :class:`io.StringIO` object:: + + f = io.StringIO() + with redirect_stdout(f): + help(pow) + s = f.getvalue() + + To send the output of :func:`help` to a file on disk, redirect the output + to a regular file:: + + with open('help.txt', 'w') as f: + with redirect_stdout(f): + help(pow) + + To send the output of :func:`help` to *sys.stderr*:: + + with redirect_stdout(sys.stderr): + help(pow) + + Note that the global side effect on :data:`sys.stdout` means that this + context manager is not suitable for use in library code and most threaded + applications. It also has no effect on the output of subprocesses. + However, it is still a useful approach for many utility scripts. + + This context manager is :ref:`reentrant `. + + .. versionadded:: 3.4 + + +.. function:: redirect_stderr(new_target) + + Similar to :func:`~contextlib.redirect_stdout` but redirecting + :data:`sys.stderr` to another file or file-like object. + + This context manager is :ref:`reentrant `. + + .. versionadded:: 3.5 + + +.. class:: ContextDecorator() + + A base class that enables a context manager to also be used as a decorator. + + Context managers inheriting from ``ContextDecorator`` have to implement + ``__enter__`` and ``__exit__`` as normal. ``__exit__`` retains its optional + exception handling even when used as a decorator. + + ``ContextDecorator`` is used by :func:`contextmanager`, so you get this + functionality automatically. + + Example of ``ContextDecorator``:: + + from contextlib import ContextDecorator + + class mycontext(ContextDecorator): + def __enter__(self): + print('Starting') + return self + + def __exit__(self, *exc): + print('Finishing') + return False + + >>> @mycontext() + ... def function(): + ... print('The bit in the middle') + ... + >>> function() + Starting + The bit in the middle + Finishing + + >>> with mycontext(): + ... print('The bit in the middle') + ... + Starting + The bit in the middle + Finishing + + This change is just syntactic sugar for any construct of the following form:: + + def f(): + with cm(): + # Do stuff + + ``ContextDecorator`` lets you instead write:: + + @cm() + def f(): + # Do stuff + + It makes it clear that the ``cm`` applies to the whole function, rather than + just a piece of it (and saving an indentation level is nice, too). + + Existing context managers that already have a base class can be extended by + using ``ContextDecorator`` as a mixin class:: + + from contextlib import ContextDecorator + + class mycontext(ContextBaseClass, ContextDecorator): + def __enter__(self): + return self + + def __exit__(self, *exc): + return False + + .. note:: + As the decorated function must be able to be called multiple times, the + underlying context manager must support use in multiple :keyword:`with` + statements. If this is not the case, then the original construct with the + explicit :keyword:`!with` statement inside the function should be used. + + .. versionadded:: 3.2 + + +.. class:: ExitStack() + + A context manager that is designed to make it easy to programmatically + combine other context managers and cleanup functions, especially those + that are optional or otherwise driven by input data. + + For example, a set of files may easily be handled in a single with + statement as follows:: + + with ExitStack() as stack: + files = [stack.enter_context(open(fname)) for fname in filenames] + # All opened files will automatically be closed at the end of + # the with statement, even if attempts to open files later + # in the list raise an exception + + Each instance maintains a stack of registered callbacks that are called in + reverse order when the instance is closed (either explicitly or implicitly + at the end of a :keyword:`with` statement). Note that callbacks are *not* + invoked implicitly when the context stack instance is garbage collected. + + This stack model is used so that context managers that acquire their + resources in their ``__init__`` method (such as file objects) can be + handled correctly. + + Since registered callbacks are invoked in the reverse order of + registration, this ends up behaving as if multiple nested :keyword:`with` + statements had been used with the registered set of callbacks. This even + extends to exception handling - if an inner callback suppresses or replaces + an exception, then outer callbacks will be passed arguments based on that + updated state. + + This is a relatively low level API that takes care of the details of + correctly unwinding the stack of exit callbacks. It provides a suitable + foundation for higher level context managers that manipulate the exit + stack in application specific ways. + + .. versionadded:: 3.3 + + .. method:: enter_context(cm) + + Enters a new context manager and adds its :meth:`__exit__` method to + the callback stack. The return value is the result of the context + manager's own :meth:`__enter__` method. + + These context managers may suppress exceptions just as they normally + would if used directly as part of a :keyword:`with` statement. + + .. method:: push(exit) + + Adds a context manager's :meth:`__exit__` method to the callback stack. + + As ``__enter__`` is *not* invoked, this method can be used to cover + part of an :meth:`__enter__` implementation with a context manager's own + :meth:`__exit__` method. + + If passed an object that is not a context manager, this method assumes + it is a callback with the same signature as a context manager's + :meth:`__exit__` method and adds it directly to the callback stack. + + By returning true values, these callbacks can suppress exceptions the + same way context manager :meth:`__exit__` methods can. + + The passed in object is returned from the function, allowing this + method to be used as a function decorator. + + .. method:: callback(callback, *args, **kwds) + + Accepts an arbitrary callback function and arguments and adds it to + the callback stack. + + Unlike the other methods, callbacks added this way cannot suppress + exceptions (as they are never passed the exception details). + + The passed in callback is returned from the function, allowing this + method to be used as a function decorator. + + .. method:: pop_all() + + Transfers the callback stack to a fresh :class:`ExitStack` instance + and returns it. No callbacks are invoked by this operation - instead, + they will now be invoked when the new stack is closed (either + explicitly or implicitly at the end of a :keyword:`with` statement). + + For example, a group of files can be opened as an "all or nothing" + operation as follows:: + + with ExitStack() as stack: + files = [stack.enter_context(open(fname)) for fname in filenames] + # Hold onto the close method, but don't call it yet. + close_files = stack.pop_all().close + # If opening any file fails, all previously opened files will be + # closed automatically. If all files are opened successfully, + # they will remain open even after the with statement ends. + # close_files() can then be invoked explicitly to close them all. + + .. method:: close() + + Immediately unwinds the callback stack, invoking callbacks in the + reverse order of registration. For any context managers and exit + callbacks registered, the arguments passed in will indicate that no + exception occurred. + +.. class:: AsyncExitStack() + + An :ref:`asynchronous context manager `, similar + to :class:`ExitStack`, that supports combining both synchronous and + asynchronous context managers, as well as having coroutines for + cleanup logic. + + The :meth:`close` method is not implemented, :meth:`aclose` must be used + instead. + + .. method:: enter_async_context(cm) + + Similar to :meth:`enter_context` but expects an asynchronous context + manager. + + .. method:: push_async_exit(exit) + + Similar to :meth:`push` but expects either an asynchronous context manager + or a coroutine function. + + .. method:: push_async_callback(callback, *args, **kwds) + + Similar to :meth:`callback` but expects a coroutine function. + + .. method:: aclose() + + Similar to :meth:`close` but properly handles awaitables. + + Continuing the example for :func:`asynccontextmanager`:: + + async with AsyncExitStack() as stack: + connections = [await stack.enter_async_context(get_connection()) + for i in range(5)] + # All opened connections will automatically be released at the end of + # the async with statement, even if attempts to open a connection + # later in the list raise an exception. + + .. versionadded:: 3.7 + +Examples and Recipes +-------------------- + +This section describes some examples and recipes for making effective use of +the tools provided by :mod:`contextlib`. + + +Supporting a variable number of context managers +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The primary use case for :class:`ExitStack` is the one given in the class +documentation: supporting a variable number of context managers and other +cleanup operations in a single :keyword:`with` statement. The variability +may come from the number of context managers needed being driven by user +input (such as opening a user specified collection of files), or from +some of the context managers being optional:: + + with ExitStack() as stack: + for resource in resources: + stack.enter_context(resource) + if need_special_resource(): + special = acquire_special_resource() + stack.callback(release_special_resource, special) + # Perform operations that use the acquired resources + +As shown, :class:`ExitStack` also makes it quite easy to use :keyword:`with` +statements to manage arbitrary resources that don't natively support the +context management protocol. + + +Catching exceptions from ``__enter__`` methods +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +It is occasionally desirable to catch exceptions from an ``__enter__`` +method implementation, *without* inadvertently catching exceptions from +the :keyword:`with` statement body or the context manager's ``__exit__`` +method. By using :class:`ExitStack` the steps in the context management +protocol can be separated slightly in order to allow this:: + + stack = ExitStack() + try: + x = stack.enter_context(cm) + except Exception: + # handle __enter__ exception + else: + with stack: + # Handle normal case + +Actually needing to do this is likely to indicate that the underlying API +should be providing a direct resource management interface for use with +:keyword:`try`/:keyword:`except`/:keyword:`finally` statements, but not +all APIs are well designed in that regard. When a context manager is the +only resource management API provided, then :class:`ExitStack` can make it +easier to handle various situations that can't be handled directly in a +:keyword:`with` statement. + + +Cleaning up in an ``__enter__`` implementation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +As noted in the documentation of :meth:`ExitStack.push`, this +method can be useful in cleaning up an already allocated resource if later +steps in the :meth:`__enter__` implementation fail. + +Here's an example of doing this for a context manager that accepts resource +acquisition and release functions, along with an optional validation function, +and maps them to the context management protocol:: + + from contextlib import contextmanager, AbstractContextManager, ExitStack + + class ResourceManager(AbstractContextManager): + + def __init__(self, acquire_resource, release_resource, check_resource_ok=None): + self.acquire_resource = acquire_resource + self.release_resource = release_resource + if check_resource_ok is None: + def check_resource_ok(resource): + return True + self.check_resource_ok = check_resource_ok + + @contextmanager + def _cleanup_on_error(self): + with ExitStack() as stack: + stack.push(self) + yield + # The validation check passed and didn't raise an exception + # Accordingly, we want to keep the resource, and pass it + # back to our caller + stack.pop_all() + + def __enter__(self): + resource = self.acquire_resource() + with self._cleanup_on_error(): + if not self.check_resource_ok(resource): + msg = "Failed validation for {!r}" + raise RuntimeError(msg.format(resource)) + return resource + + def __exit__(self, *exc_details): + # We don't need to duplicate any of our resource release logic + self.release_resource() + + +Replacing any use of ``try-finally`` and flag variables +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +A pattern you will sometimes see is a ``try-finally`` statement with a flag +variable to indicate whether or not the body of the ``finally`` clause should +be executed. In its simplest form (that can't already be handled just by +using an ``except`` clause instead), it looks something like this:: + + cleanup_needed = True + try: + result = perform_operation() + if result: + cleanup_needed = False + finally: + if cleanup_needed: + cleanup_resources() + +As with any ``try`` statement based code, this can cause problems for +development and review, because the setup code and the cleanup code can end +up being separated by arbitrarily long sections of code. + +:class:`ExitStack` makes it possible to instead register a callback for +execution at the end of a ``with`` statement, and then later decide to skip +executing that callback:: + + from contextlib import ExitStack + + with ExitStack() as stack: + stack.callback(cleanup_resources) + result = perform_operation() + if result: + stack.pop_all() + +This allows the intended cleanup up behaviour to be made explicit up front, +rather than requiring a separate flag variable. + +If a particular application uses this pattern a lot, it can be simplified +even further by means of a small helper class:: + + from contextlib import ExitStack + + class Callback(ExitStack): + def __init__(self, callback, *args, **kwds): + super(Callback, self).__init__() + self.callback(callback, *args, **kwds) + + def cancel(self): + self.pop_all() + + with Callback(cleanup_resources) as cb: + result = perform_operation() + if result: + cb.cancel() + +If the resource cleanup isn't already neatly bundled into a standalone +function, then it is still possible to use the decorator form of +:meth:`ExitStack.callback` to declare the resource cleanup in +advance:: + + from contextlib import ExitStack + + with ExitStack() as stack: + @stack.callback + def cleanup_resources(): + ... + result = perform_operation() + if result: + stack.pop_all() + +Due to the way the decorator protocol works, a callback function +declared this way cannot take any parameters. Instead, any resources to +be released must be accessed as closure variables. + + +Using a context manager as a function decorator +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:class:`ContextDecorator` makes it possible to use a context manager in +both an ordinary ``with`` statement and also as a function decorator. + +For example, it is sometimes useful to wrap functions or groups of statements +with a logger that can track the time of entry and time of exit. Rather than +writing both a function decorator and a context manager for the task, +inheriting from :class:`ContextDecorator` provides both capabilities in a +single definition:: + + from contextlib import ContextDecorator + import logging + + logging.basicConfig(level=logging.INFO) + + class track_entry_and_exit(ContextDecorator): + def __init__(self, name): + self.name = name + + def __enter__(self): + logging.info('Entering: %s', self.name) + + def __exit__(self, exc_type, exc, exc_tb): + logging.info('Exiting: %s', self.name) + +Instances of this class can be used as both a context manager:: + + with track_entry_and_exit('widget loader'): + print('Some time consuming activity goes here') + load_widget() + +And also as a function decorator:: + + @track_entry_and_exit('widget loader') + def activity(): + print('Some time consuming activity goes here') + load_widget() + +Note that there is one additional limitation when using context managers +as function decorators: there's no way to access the return value of +:meth:`__enter__`. If that value is needed, then it is still necessary to use +an explicit ``with`` statement. + +.. seealso:: + + :pep:`343` - The "with" statement + The specification, background, and examples for the Python :keyword:`with` + statement. + +.. _single-use-reusable-and-reentrant-cms: + +Single use, reusable and reentrant context managers +--------------------------------------------------- + +Most context managers are written in a way that means they can only be +used effectively in a :keyword:`with` statement once. These single use +context managers must be created afresh each time they're used - +attempting to use them a second time will trigger an exception or +otherwise not work correctly. + +This common limitation means that it is generally advisable to create +context managers directly in the header of the :keyword:`with` statement +where they are used (as shown in all of the usage examples above). + +Files are an example of effectively single use context managers, since +the first :keyword:`with` statement will close the file, preventing any +further IO operations using that file object. + +Context managers created using :func:`contextmanager` are also single use +context managers, and will complain about the underlying generator failing +to yield if an attempt is made to use them a second time:: + + >>> from contextlib import contextmanager + >>> @contextmanager + ... def singleuse(): + ... print("Before") + ... yield + ... print("After") + ... + >>> cm = singleuse() + >>> with cm: + ... pass + ... + Before + After + >>> with cm: + ... pass + ... + Traceback (most recent call last): + ... + RuntimeError: generator didn't yield + + +.. _reentrant-cms: + +Reentrant context managers +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +More sophisticated context managers may be "reentrant". These context +managers can not only be used in multiple :keyword:`with` statements, +but may also be used *inside* a :keyword:`!with` statement that is already +using the same context manager. + +:class:`threading.RLock` is an example of a reentrant context manager, as are +:func:`suppress` and :func:`redirect_stdout`. Here's a very simple example of +reentrant use:: + + >>> from contextlib import redirect_stdout + >>> from io import StringIO + >>> stream = StringIO() + >>> write_to_stream = redirect_stdout(stream) + >>> with write_to_stream: + ... print("This is written to the stream rather than stdout") + ... with write_to_stream: + ... print("This is also written to the stream") + ... + >>> print("This is written directly to stdout") + This is written directly to stdout + >>> print(stream.getvalue()) + This is written to the stream rather than stdout + This is also written to the stream + +Real world examples of reentrancy are more likely to involve multiple +functions calling each other and hence be far more complicated than this +example. + +Note also that being reentrant is *not* the same thing as being thread safe. +:func:`redirect_stdout`, for example, is definitely not thread safe, as it +makes a global modification to the system state by binding :data:`sys.stdout` +to a different stream. + + +.. _reusable-cms: + +Reusable context managers +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Distinct from both single use and reentrant context managers are "reusable" +context managers (or, to be completely explicit, "reusable, but not +reentrant" context managers, since reentrant context managers are also +reusable). These context managers support being used multiple times, but +will fail (or otherwise not work correctly) if the specific context manager +instance has already been used in a containing with statement. + +:class:`threading.Lock` is an example of a reusable, but not reentrant, +context manager (for a reentrant lock, it is necessary to use +:class:`threading.RLock` instead). + +Another example of a reusable, but not reentrant, context manager is +:class:`ExitStack`, as it invokes *all* currently registered callbacks +when leaving any with statement, regardless of where those callbacks +were added:: + + >>> from contextlib import ExitStack + >>> stack = ExitStack() + >>> with stack: + ... stack.callback(print, "Callback: from first context") + ... print("Leaving first context") + ... + Leaving first context + Callback: from first context + >>> with stack: + ... stack.callback(print, "Callback: from second context") + ... print("Leaving second context") + ... + Leaving second context + Callback: from second context + >>> with stack: + ... stack.callback(print, "Callback: from outer context") + ... with stack: + ... stack.callback(print, "Callback: from inner context") + ... print("Leaving inner context") + ... print("Leaving outer context") + ... + Leaving inner context + Callback: from inner context + Callback: from outer context + Leaving outer context + +As the output from the example shows, reusing a single stack object across +multiple with statements works correctly, but attempting to nest them +will cause the stack to be cleared at the end of the innermost with +statement, which is unlikely to be desirable behaviour. + +Using separate :class:`ExitStack` instances instead of reusing a single +instance avoids that problem:: + + >>> from contextlib import ExitStack + >>> with ExitStack() as outer_stack: + ... outer_stack.callback(print, "Callback: from outer context") + ... with ExitStack() as inner_stack: + ... inner_stack.callback(print, "Callback: from inner context") + ... print("Leaving inner context") + ... print("Leaving outer context") + ... + Leaving inner context + Callback: from inner context + Leaving outer context + Callback: from outer context diff --git a/python-3.7.4-docs-html/_sources/library/contextvars.rst.txt b/python-3.7.4-docs-html/_sources/library/contextvars.rst.txt new file mode 100644 index 0000000..8805661 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/contextvars.rst.txt @@ -0,0 +1,281 @@ +:mod:`contextvars` --- Context Variables +======================================== + +.. module:: contextvars + :synopsis: Context Variables + +.. sectionauthor:: Yury Selivanov + +-------------- + +This module provides APIs to manage, store, and access context-local +state. The :class:`~contextvars.ContextVar` class is used to declare +and work with *Context Variables*. The :func:`~contextvars.copy_context` +function and the :class:`~contextvars.Context` class should be used to +manage the current context in asynchronous frameworks. + +Context managers that have state should use Context Variables +instead of :func:`threading.local()` to prevent their state from +bleeding to other code unexpectedly, when used in concurrent code. + +See also :pep:`567` for additional details. + +.. versionadded:: 3.7 + + +Context Variables +----------------- + +.. class:: ContextVar(name, [\*, default]) + + This class is used to declare a new Context Variable, e.g.:: + + var: ContextVar[int] = ContextVar('var', default=42) + + The required *name* parameter is used for introspection and debug + purposes. + + The optional keyword-only *default* parameter is returned by + :meth:`ContextVar.get` when no value for the variable is found + in the current context. + + **Important:** Context Variables should be created at the top module + level and never in closures. :class:`Context` objects hold strong + references to context variables which prevents context variables + from being properly garbage collected. + + .. attribute:: ContextVar.name + + The name of the variable. This is a read-only property. + + .. versionadded:: 3.7.1 + + .. method:: get([default]) + + Return a value for the context variable for the current context. + + If there is no value for the variable in the current context, + the method will: + + * return the value of the *default* argument of the method, + if provided; or + + * return the default value for the context variable, + if it was created with one; or + + * raise a :exc:`LookupError`. + + .. method:: set(value) + + Call to set a new value for the context variable in the current + context. + + The required *value* argument is the new value for the context + variable. + + Returns a :class:`~contextvars.Token` object that can be used + to restore the variable to its previous value via the + :meth:`ContextVar.reset` method. + + .. method:: reset(token) + + Reset the context variable to the value it had before the + :meth:`ContextVar.set` that created the *token* was used. + + For example:: + + var = ContextVar('var') + + token = var.set('new value') + # code that uses 'var'; var.get() returns 'new value'. + var.reset(token) + + # After the reset call the var has no value again, so + # var.get() would raise a LookupError. + + +.. class:: contextvars.Token + + *Token* objects are returned by the :meth:`ContextVar.set` method. + They can be passed to the :meth:`ContextVar.reset` method to revert + the value of the variable to what it was before the corresponding + *set*. + + .. attribute:: Token.var + + A read-only property. Points to the :class:`ContextVar` object + that created the token. + + .. attribute:: Token.old_value + + A read-only property. Set to the value the variable had before + the :meth:`ContextVar.set` method call that created the token. + It points to :attr:`Token.MISSING` is the variable was not set + before the call. + + .. attribute:: Token.MISSING + + A marker object used by :attr:`Token.old_value`. + + +Manual Context Management +------------------------- + +.. function:: copy_context() + + Returns a copy of the current :class:`~contextvars.Context` object. + + The following snippet gets a copy of the current context and prints + all variables and their values that are set in it:: + + ctx: Context = copy_context() + print(list(ctx.items())) + + The function has an O(1) complexity, i.e. works equally fast for + contexts with a few context variables and for contexts that have + a lot of them. + + +.. class:: Context() + + A mapping of :class:`ContextVars ` to their values. + + ``Context()`` creates an empty context with no values in it. + To get a copy of the current context use the + :func:`~contextvars.copy_context` function. + + Context implements the :class:`collections.abc.Mapping` interface. + + .. method:: run(callable, \*args, \*\*kwargs) + + Execute ``callable(*args, **kwargs)`` code in the context object + the *run* method is called on. Return the result of the execution + or propagate an exception if one occurred. + + Any changes to any context variables that *callable* makes will + be contained in the context object:: + + var = ContextVar('var') + var.set('spam') + + def main(): + # 'var' was set to 'spam' before + # calling 'copy_context()' and 'ctx.run(main)', so: + # var.get() == ctx[var] == 'spam' + + var.set('ham') + + # Now, after setting 'var' to 'ham': + # var.get() == ctx[var] == 'ham' + + ctx = copy_context() + + # Any changes that the 'main' function makes to 'var' + # will be contained in 'ctx'. + ctx.run(main) + + # The 'main()' function was run in the 'ctx' context, + # so changes to 'var' are contained in it: + # ctx[var] == 'ham' + + # However, outside of 'ctx', 'var' is still set to 'spam': + # var.get() == 'spam' + + The method raises a :exc:`RuntimeError` when called on the same + context object from more than one OS thread, or when called + recursively. + + .. method:: copy() + + Return a shallow copy of the context object. + + .. describe:: var in context + + Return ``True`` if the *context* has a value for *var* set; + return ``False`` otherwise. + + .. describe:: context[var] + + Return the value of the *var* :class:`ContextVar` variable. + If the variable is not set in the context object, a + :exc:`KeyError` is raised. + + .. method:: get(var, [default]) + + Return the value for *var* if *var* has the value in the context + object. Return *default* otherwise. If *default* is not given, + return ``None``. + + .. describe:: iter(context) + + Return an iterator over the variables stored in the context + object. + + .. describe:: len(proxy) + + Return the number of variables set in the context object. + + .. method:: keys() + + Return a list of all variables in the context object. + + .. method:: values() + + Return a list of all variables' values in the context object. + + + .. method:: items() + + Return a list of 2-tuples containing all variables and their + values in the context object. + + +asyncio support +--------------- + +Context variables are natively supported in :mod:`asyncio` and are +ready to be used without any extra configuration. For example, here +is a simple echo server, that uses a context variable to make the +address of a remote client available in the Task that handles that +client:: + + import asyncio + import contextvars + + client_addr_var = contextvars.ContextVar('client_addr') + + def render_goodbye(): + # The address of the currently handled client can be accessed + # without passing it explicitly to this function. + + client_addr = client_addr_var.get() + return f'Good bye, client @ {client_addr}\n'.encode() + + async def handle_request(reader, writer): + addr = writer.transport.get_extra_info('socket').getpeername() + client_addr_var.set(addr) + + # In any code that we call is now possible to get + # client's address by calling 'client_addr_var.get()'. + + while True: + line = await reader.readline() + print(line) + if not line.strip(): + break + writer.write(line) + + writer.write(render_goodbye()) + writer.close() + + async def main(): + srv = await asyncio.start_server( + handle_request, '127.0.0.1', 8081) + + async with srv: + await srv.serve_forever() + + asyncio.run(main()) + + # To test it you can use telnet: + # telnet 127.0.0.1 8081 diff --git a/python-3.7.4-docs-html/_sources/library/copy.rst.txt b/python-3.7.4-docs-html/_sources/library/copy.rst.txt new file mode 100644 index 0000000..c7bd89f --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/copy.rst.txt @@ -0,0 +1,95 @@ +:mod:`copy` --- Shallow and deep copy operations +================================================ + +.. module:: copy + :synopsis: Shallow and deep copy operations. + +**Source code:** :source:`Lib/copy.py` + +-------------- + +Assignment statements in Python do not copy objects, they create bindings +between a target and an object. For collections that are mutable or contain +mutable items, a copy is sometimes needed so one can change one copy without +changing the other. This module provides generic shallow and deep copy +operations (explained below). + + +Interface summary: + +.. function:: copy(x) + + Return a shallow copy of *x*. + + +.. function:: deepcopy(x[, memo]) + + Return a deep copy of *x*. + + +.. exception:: error + + Raised for module specific errors. + + +The difference between shallow and deep copying is only relevant for compound +objects (objects that contain other objects, like lists or class instances): + +* A *shallow copy* constructs a new compound object and then (to the extent + possible) inserts *references* into it to the objects found in the original. + +* A *deep copy* constructs a new compound object and then, recursively, inserts + *copies* into it of the objects found in the original. + +Two problems often exist with deep copy operations that don't exist with shallow +copy operations: + +* Recursive objects (compound objects that, directly or indirectly, contain a + reference to themselves) may cause a recursive loop. + +* Because deep copy copies everything it may copy too much, such as data + which is intended to be shared between copies. + +The :func:`deepcopy` function avoids these problems by: + +* keeping a ``memo`` dictionary of objects already copied during the current + copying pass; and + +* letting user-defined classes override the copying operation or the set of + components copied. + +This module does not copy types like module, method, stack trace, stack frame, +file, socket, window, array, or any similar types. It does "copy" functions and +classes (shallow and deeply), by returning the original object unchanged; this +is compatible with the way these are treated by the :mod:`pickle` module. + +Shallow copies of dictionaries can be made using :meth:`dict.copy`, and +of lists by assigning a slice of the entire list, for example, +``copied_list = original_list[:]``. + +.. index:: module: pickle + +Classes can use the same interfaces to control copying that they use to control +pickling. See the description of module :mod:`pickle` for information on these +methods. In fact, the :mod:`copy` module uses the registered +pickle functions from the :mod:`copyreg` module. + +.. index:: + single: __copy__() (copy protocol) + single: __deepcopy__() (copy protocol) + +In order for a class to define its own copy implementation, it can define +special methods :meth:`__copy__` and :meth:`__deepcopy__`. The former is called +to implement the shallow copy operation; no additional arguments are passed. +The latter is called to implement the deep copy operation; it is passed one +argument, the ``memo`` dictionary. If the :meth:`__deepcopy__` implementation needs +to make a deep copy of a component, it should call the :func:`deepcopy` function +with the component as first argument and the memo dictionary as second argument. + + +.. seealso:: + + Module :mod:`pickle` + Discussion of the special methods used to support object state retrieval and + restoration. + diff --git a/python-3.7.4-docs-html/_sources/library/copyreg.rst.txt b/python-3.7.4-docs-html/_sources/library/copyreg.rst.txt new file mode 100644 index 0000000..40fca56 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/copyreg.rst.txt @@ -0,0 +1,65 @@ +:mod:`copyreg` --- Register :mod:`pickle` support functions +=========================================================== + +.. module:: copyreg + :synopsis: Register pickle support functions. + +**Source code:** :source:`Lib/copyreg.py` + +.. index:: + module: pickle + module: copy + +-------------- + +The :mod:`copyreg` module offers a way to define functions used while pickling +specific objects. The :mod:`pickle` and :mod:`copy` modules use those functions +when pickling/copying those objects. The module provides configuration +information about object constructors which are not classes. +Such constructors may be factory functions or class instances. + + +.. function:: constructor(object) + + Declares *object* to be a valid constructor. If *object* is not callable (and + hence not valid as a constructor), raises :exc:`TypeError`. + + +.. function:: pickle(type, function, constructor=None) + + Declares that *function* should be used as a "reduction" function for objects + of type *type*. *function* should return either a string or a tuple + containing two or three elements. + + The optional *constructor* parameter, if provided, is a callable object which + can be used to reconstruct the object when called with the tuple of arguments + returned by *function* at pickling time. :exc:`TypeError` will be raised if + *object* is a class or *constructor* is not callable. + + See the :mod:`pickle` module for more details on the interface + expected of *function* and *constructor*. Note that the + :attr:`~pickle.Pickler.dispatch_table` attribute of a pickler + object or subclass of :class:`pickle.Pickler` can also be used for + declaring reduction functions. + +Example +------- + +The example below would like to show how to register a pickle function and how +it will be used: + + >>> import copyreg, copy, pickle + >>> class C(object): + ... def __init__(self, a): + ... self.a = a + ... + >>> def pickle_c(c): + ... print("pickling a C instance...") + ... return C, (c.a,) + ... + >>> copyreg.pickle(C, pickle_c) + >>> c = C(1) + >>> d = copy.copy(c) # doctest: +SKIP + pickling a C instance... + >>> p = pickle.dumps(c) # doctest: +SKIP + pickling a C instance... diff --git a/python-3.7.4-docs-html/_sources/library/crypt.rst.txt b/python-3.7.4-docs-html/_sources/library/crypt.rst.txt new file mode 100644 index 0000000..43d4b5b --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/crypt.rst.txt @@ -0,0 +1,173 @@ +:mod:`crypt` --- Function to check Unix passwords +================================================= + +.. module:: crypt + :platform: Unix + :synopsis: The crypt() function used to check Unix passwords. + +.. moduleauthor:: Steven D. Majewski +.. sectionauthor:: Steven D. Majewski +.. sectionauthor:: Peter Funk + +**Source code:** :source:`Lib/crypt.py` + +.. index:: + single: crypt(3) + pair: cipher; DES + +-------------- + +This module implements an interface to the :manpage:`crypt(3)` routine, which is +a one-way hash function based upon a modified DES algorithm; see the Unix man +page for further details. Possible uses include storing hashed passwords +so you can check passwords without storing the actual password, or attempting +to crack Unix passwords with a dictionary. + +.. index:: single: crypt(3) + +Notice that the behavior of this module depends on the actual implementation of +the :manpage:`crypt(3)` routine in the running system. Therefore, any +extensions available on the current implementation will also be available on +this module. + +Hashing Methods +--------------- + +.. versionadded:: 3.3 + +The :mod:`crypt` module defines the list of hashing methods (not all methods +are available on all platforms): + +.. data:: METHOD_SHA512 + + A Modular Crypt Format method with 16 character salt and 86 character + hash based on the SHA-512 hash function. This is the strongest method. + +.. data:: METHOD_SHA256 + + Another Modular Crypt Format method with 16 character salt and 43 + character hash based on the SHA-256 hash function. + +.. data:: METHOD_BLOWFISH + + Another Modular Crypt Format method with 22 character salt and 31 + character hash based on the Blowfish cipher. + + .. versionadded:: 3.7 + +.. data:: METHOD_MD5 + + Another Modular Crypt Format method with 8 character salt and 22 + character hash based on the MD5 hash function. + +.. data:: METHOD_CRYPT + + The traditional method with a 2 character salt and 13 characters of + hash. This is the weakest method. + + +Module Attributes +----------------- + +.. versionadded:: 3.3 + +.. attribute:: methods + + A list of available password hashing algorithms, as + ``crypt.METHOD_*`` objects. This list is sorted from strongest to + weakest. + + +Module Functions +---------------- + +The :mod:`crypt` module defines the following functions: + +.. function:: crypt(word, salt=None) + + *word* will usually be a user's password as typed at a prompt or in a graphical + interface. The optional *salt* is either a string as returned from + :func:`mksalt`, one of the ``crypt.METHOD_*`` values (though not all + may be available on all platforms), or a full encrypted password + including salt, as returned by this function. If *salt* is not + provided, the strongest method will be used (as returned by + :func:`methods`). + + Checking a password is usually done by passing the plain-text password + as *word* and the full results of a previous :func:`crypt` call, + which should be the same as the results of this call. + + *salt* (either a random 2 or 16 character string, possibly prefixed with + ``$digit$`` to indicate the method) which will be used to perturb the + encryption algorithm. The characters in *salt* must be in the set + ``[./a-zA-Z0-9]``, with the exception of Modular Crypt Format which + prefixes a ``$digit$``. + + Returns the hashed password as a string, which will be composed of + characters from the same alphabet as the salt. + + .. index:: single: crypt(3) + + Since a few :manpage:`crypt(3)` extensions allow different values, with + different sizes in the *salt*, it is recommended to use the full crypted + password as salt when checking for a password. + + .. versionchanged:: 3.3 + Accept ``crypt.METHOD_*`` values in addition to strings for *salt*. + + +.. function:: mksalt(method=None, *, rounds=None) + + Return a randomly generated salt of the specified method. If no + *method* is given, the strongest method available as returned by + :func:`methods` is used. + + The return value is a string suitable for passing as the *salt* argument + to :func:`crypt`. + + *rounds* specifies the number of rounds for ``METHOD_SHA256``, + ``METHOD_SHA512`` and ``METHOD_BLOWFISH``. + For ``METHOD_SHA256`` and ``METHOD_SHA512`` it must be an integer between + ``1000`` and ``999_999_999``, the default is ``5000``. For + ``METHOD_BLOWFISH`` it must be a power of two between ``16`` (2\ :sup:`4`) + and ``2_147_483_648`` (2\ :sup:`31`), the default is ``4096`` + (2\ :sup:`12`). + + .. versionadded:: 3.3 + + .. versionchanged:: 3.7 + Added the *rounds* parameter. + + +Examples +-------- + +A simple example illustrating typical use (a constant-time comparison +operation is needed to limit exposure to timing attacks. +:func:`hmac.compare_digest` is suitable for this purpose):: + + import pwd + import crypt + import getpass + from hmac import compare_digest as compare_hash + + def login(): + username = input('Python login: ') + cryptedpasswd = pwd.getpwnam(username)[1] + if cryptedpasswd: + if cryptedpasswd == 'x' or cryptedpasswd == '*': + raise ValueError('no support for shadow passwords') + cleartext = getpass.getpass() + return compare_hash(crypt.crypt(cleartext, cryptedpasswd), cryptedpasswd) + else: + return True + +To generate a hash of a password using the strongest available method and +check it against the original:: + + import crypt + from hmac import compare_digest as compare_hash + + hashed = crypt.crypt(plaintext) + if not compare_hash(hashed, crypt.crypt(plaintext, hashed)): + raise ValueError("hashed version doesn't validate against original") diff --git a/python-3.7.4-docs-html/_sources/library/crypto.rst.txt b/python-3.7.4-docs-html/_sources/library/crypto.rst.txt new file mode 100644 index 0000000..ae45549 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/crypto.rst.txt @@ -0,0 +1,19 @@ +.. _crypto: + +********************** +Cryptographic Services +********************** + +.. index:: single: cryptography + +The modules described in this chapter implement various algorithms of a +cryptographic nature. They are available at the discretion of the installation. +On Unix systems, the :mod:`crypt` module may also be available. +Here's an overview: + + +.. toctree:: + + hashlib.rst + hmac.rst + secrets.rst diff --git a/python-3.7.4-docs-html/_sources/library/csv.rst.txt b/python-3.7.4-docs-html/_sources/library/csv.rst.txt new file mode 100644 index 0000000..049537e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/csv.rst.txt @@ -0,0 +1,550 @@ +:mod:`csv` --- CSV File Reading and Writing +=========================================== + +.. module:: csv + :synopsis: Write and read tabular data to and from delimited files. + +.. sectionauthor:: Skip Montanaro + +**Source code:** :source:`Lib/csv.py` + +.. index:: + single: csv + pair: data; tabular + +-------------- + +The so-called CSV (Comma Separated Values) format is the most common import and +export format for spreadsheets and databases. CSV format was used for many +years prior to attempts to describe the format in a standardized way in +:rfc:`4180`. The lack of a well-defined standard means that subtle differences +often exist in the data produced and consumed by different applications. These +differences can make it annoying to process CSV files from multiple sources. +Still, while the delimiters and quoting characters vary, the overall format is +similar enough that it is possible to write a single module which can +efficiently manipulate such data, hiding the details of reading and writing the +data from the programmer. + +The :mod:`csv` module implements classes to read and write tabular data in CSV +format. It allows programmers to say, "write this data in the format preferred +by Excel," or "read data from this file which was generated by Excel," without +knowing the precise details of the CSV format used by Excel. Programmers can +also describe the CSV formats understood by other applications or define their +own special-purpose CSV formats. + +The :mod:`csv` module's :class:`reader` and :class:`writer` objects read and +write sequences. Programmers can also read and write data in dictionary form +using the :class:`DictReader` and :class:`DictWriter` classes. + +.. seealso:: + + :pep:`305` - CSV File API + The Python Enhancement Proposal which proposed this addition to Python. + + +.. _csv-contents: + +Module Contents +--------------- + +The :mod:`csv` module defines the following functions: + + +.. index:: + single: universal newlines; csv.reader function + +.. function:: reader(csvfile, dialect='excel', **fmtparams) + + Return a reader object which will iterate over lines in the given *csvfile*. + *csvfile* can be any object which supports the :term:`iterator` protocol and returns a + string each time its :meth:`!__next__` method is called --- :term:`file objects + ` and list objects are both suitable. If *csvfile* is a file object, + it should be opened with ``newline=''``. [1]_ An optional + *dialect* parameter can be given which is used to define a set of parameters + specific to a particular CSV dialect. It may be an instance of a subclass of + the :class:`Dialect` class or one of the strings returned by the + :func:`list_dialects` function. The other optional *fmtparams* keyword arguments + can be given to override individual formatting parameters in the current + dialect. For full details about the dialect and formatting parameters, see + section :ref:`csv-fmt-params`. + + Each row read from the csv file is returned as a list of strings. No + automatic data type conversion is performed unless the ``QUOTE_NONNUMERIC`` format + option is specified (in which case unquoted fields are transformed into floats). + + A short usage example:: + + >>> import csv + >>> with open('eggs.csv', newline='') as csvfile: + ... spamreader = csv.reader(csvfile, delimiter=' ', quotechar='|') + ... for row in spamreader: + ... print(', '.join(row)) + Spam, Spam, Spam, Spam, Spam, Baked Beans + Spam, Lovely Spam, Wonderful Spam + + +.. function:: writer(csvfile, dialect='excel', **fmtparams) + + Return a writer object responsible for converting the user's data into delimited + strings on the given file-like object. *csvfile* can be any object with a + :func:`write` method. If *csvfile* is a file object, it should be opened with + ``newline=''`` [1]_. An optional *dialect* + parameter can be given which is used to define a set of parameters specific to a + particular CSV dialect. It may be an instance of a subclass of the + :class:`Dialect` class or one of the strings returned by the + :func:`list_dialects` function. The other optional *fmtparams* keyword arguments + can be given to override individual formatting parameters in the current + dialect. For full details about the dialect and formatting parameters, see + section :ref:`csv-fmt-params`. To make it + as easy as possible to interface with modules which implement the DB API, the + value :const:`None` is written as the empty string. While this isn't a + reversible transformation, it makes it easier to dump SQL NULL data values to + CSV files without preprocessing the data returned from a ``cursor.fetch*`` call. + All other non-string data are stringified with :func:`str` before being written. + + A short usage example:: + + import csv + with open('eggs.csv', 'w', newline='') as csvfile: + spamwriter = csv.writer(csvfile, delimiter=' ', + quotechar='|', quoting=csv.QUOTE_MINIMAL) + spamwriter.writerow(['Spam'] * 5 + ['Baked Beans']) + spamwriter.writerow(['Spam', 'Lovely Spam', 'Wonderful Spam']) + + +.. function:: register_dialect(name[, dialect[, **fmtparams]]) + + Associate *dialect* with *name*. *name* must be a string. The + dialect can be specified either by passing a sub-class of :class:`Dialect`, or + by *fmtparams* keyword arguments, or both, with keyword arguments overriding + parameters of the dialect. For full details about the dialect and formatting + parameters, see section :ref:`csv-fmt-params`. + + +.. function:: unregister_dialect(name) + + Delete the dialect associated with *name* from the dialect registry. An + :exc:`Error` is raised if *name* is not a registered dialect name. + + +.. function:: get_dialect(name) + + Return the dialect associated with *name*. An :exc:`Error` is raised if + *name* is not a registered dialect name. This function returns an immutable + :class:`Dialect`. + +.. function:: list_dialects() + + Return the names of all registered dialects. + + +.. function:: field_size_limit([new_limit]) + + Returns the current maximum field size allowed by the parser. If *new_limit* is + given, this becomes the new limit. + + +The :mod:`csv` module defines the following classes: + +.. class:: DictReader(f, fieldnames=None, restkey=None, restval=None, \ + dialect='excel', *args, **kwds) + + Create an object that operates like a regular reader but maps the + information in each row to an :mod:`OrderedDict ` + whose keys are given by the optional *fieldnames* parameter. + + The *fieldnames* parameter is a :term:`sequence`. If *fieldnames* is + omitted, the values in the first row of file *f* will be used as the + fieldnames. Regardless of how the fieldnames are determined, the ordered + dictionary preserves their original ordering. + + If a row has more fields than fieldnames, the remaining data is put in a + list and stored with the fieldname specified by *restkey* (which defaults + to ``None``). If a non-blank row has fewer fields than fieldnames, the + missing values are filled-in with ``None``. + + All other optional or keyword arguments are passed to the underlying + :class:`reader` instance. + + .. versionchanged:: 3.6 + Returned rows are now of type :class:`OrderedDict`. + + A short usage example:: + + >>> import csv + >>> with open('names.csv', newline='') as csvfile: + ... reader = csv.DictReader(csvfile) + ... for row in reader: + ... print(row['first_name'], row['last_name']) + ... + Eric Idle + John Cleese + + >>> print(row) + OrderedDict([('first_name', 'John'), ('last_name', 'Cleese')]) + + +.. class:: DictWriter(f, fieldnames, restval='', extrasaction='raise', \ + dialect='excel', *args, **kwds) + + Create an object which operates like a regular writer but maps dictionaries + onto output rows. The *fieldnames* parameter is a :mod:`sequence + ` of keys that identify the order in which values in the + dictionary passed to the :meth:`writerow` method are written to file + *f*. The optional *restval* parameter specifies the value to be + written if the dictionary is missing a key in *fieldnames*. If the + dictionary passed to the :meth:`writerow` method contains a key not found in + *fieldnames*, the optional *extrasaction* parameter indicates what action to + take. + If it is set to ``'raise'``, the default value, a :exc:`ValueError` + is raised. + If it is set to ``'ignore'``, extra values in the dictionary are ignored. + Any other optional or keyword arguments are passed to the underlying + :class:`writer` instance. + + Note that unlike the :class:`DictReader` class, the *fieldnames* parameter + of the :class:`DictWriter` class is not optional. + + A short usage example:: + + import csv + + with open('names.csv', 'w', newline='') as csvfile: + fieldnames = ['first_name', 'last_name'] + writer = csv.DictWriter(csvfile, fieldnames=fieldnames) + + writer.writeheader() + writer.writerow({'first_name': 'Baked', 'last_name': 'Beans'}) + writer.writerow({'first_name': 'Lovely', 'last_name': 'Spam'}) + writer.writerow({'first_name': 'Wonderful', 'last_name': 'Spam'}) + + +.. class:: Dialect + + The :class:`Dialect` class is a container class relied on primarily for its + attributes, which are used to define the parameters for a specific + :class:`reader` or :class:`writer` instance. + + +.. class:: excel() + + The :class:`excel` class defines the usual properties of an Excel-generated CSV + file. It is registered with the dialect name ``'excel'``. + + +.. class:: excel_tab() + + The :class:`excel_tab` class defines the usual properties of an Excel-generated + TAB-delimited file. It is registered with the dialect name ``'excel-tab'``. + + +.. class:: unix_dialect() + + The :class:`unix_dialect` class defines the usual properties of a CSV file + generated on UNIX systems, i.e. using ``'\n'`` as line terminator and quoting + all fields. It is registered with the dialect name ``'unix'``. + + .. versionadded:: 3.2 + + +.. class:: Sniffer() + + The :class:`Sniffer` class is used to deduce the format of a CSV file. + + The :class:`Sniffer` class provides two methods: + + .. method:: sniff(sample, delimiters=None) + + Analyze the given *sample* and return a :class:`Dialect` subclass + reflecting the parameters found. If the optional *delimiters* parameter + is given, it is interpreted as a string containing possible valid + delimiter characters. + + + .. method:: has_header(sample) + + Analyze the sample text (presumed to be in CSV format) and return + :const:`True` if the first row appears to be a series of column headers. + +An example for :class:`Sniffer` use:: + + with open('example.csv', newline='') as csvfile: + dialect = csv.Sniffer().sniff(csvfile.read(1024)) + csvfile.seek(0) + reader = csv.reader(csvfile, dialect) + # ... process CSV file contents here ... + + +The :mod:`csv` module defines the following constants: + +.. data:: QUOTE_ALL + + Instructs :class:`writer` objects to quote all fields. + + +.. data:: QUOTE_MINIMAL + + Instructs :class:`writer` objects to only quote those fields which contain + special characters such as *delimiter*, *quotechar* or any of the characters in + *lineterminator*. + + +.. data:: QUOTE_NONNUMERIC + + Instructs :class:`writer` objects to quote all non-numeric fields. + + Instructs the reader to convert all non-quoted fields to type *float*. + + +.. data:: QUOTE_NONE + + Instructs :class:`writer` objects to never quote fields. When the current + *delimiter* occurs in output data it is preceded by the current *escapechar* + character. If *escapechar* is not set, the writer will raise :exc:`Error` if + any characters that require escaping are encountered. + + Instructs :class:`reader` to perform no special processing of quote characters. + +The :mod:`csv` module defines the following exception: + + +.. exception:: Error + + Raised by any of the functions when an error is detected. + +.. _csv-fmt-params: + +Dialects and Formatting Parameters +---------------------------------- + +To make it easier to specify the format of input and output records, specific +formatting parameters are grouped together into dialects. A dialect is a +subclass of the :class:`Dialect` class having a set of specific methods and a +single :meth:`validate` method. When creating :class:`reader` or +:class:`writer` objects, the programmer can specify a string or a subclass of +the :class:`Dialect` class as the dialect parameter. In addition to, or instead +of, the *dialect* parameter, the programmer can also specify individual +formatting parameters, which have the same names as the attributes defined below +for the :class:`Dialect` class. + +Dialects support the following attributes: + + +.. attribute:: Dialect.delimiter + + A one-character string used to separate fields. It defaults to ``','``. + + +.. attribute:: Dialect.doublequote + + Controls how instances of *quotechar* appearing inside a field should + themselves be quoted. When :const:`True`, the character is doubled. When + :const:`False`, the *escapechar* is used as a prefix to the *quotechar*. It + defaults to :const:`True`. + + On output, if *doublequote* is :const:`False` and no *escapechar* is set, + :exc:`Error` is raised if a *quotechar* is found in a field. + + +.. attribute:: Dialect.escapechar + + A one-character string used by the writer to escape the *delimiter* if *quoting* + is set to :const:`QUOTE_NONE` and the *quotechar* if *doublequote* is + :const:`False`. On reading, the *escapechar* removes any special meaning from + the following character. It defaults to :const:`None`, which disables escaping. + + +.. attribute:: Dialect.lineterminator + + The string used to terminate lines produced by the :class:`writer`. It defaults + to ``'\r\n'``. + + .. note:: + + The :class:`reader` is hard-coded to recognise either ``'\r'`` or ``'\n'`` as + end-of-line, and ignores *lineterminator*. This behavior may change in the + future. + + +.. attribute:: Dialect.quotechar + + A one-character string used to quote fields containing special characters, such + as the *delimiter* or *quotechar*, or which contain new-line characters. It + defaults to ``'"'``. + + +.. attribute:: Dialect.quoting + + Controls when quotes should be generated by the writer and recognised by the + reader. It can take on any of the :const:`QUOTE_\*` constants (see section + :ref:`csv-contents`) and defaults to :const:`QUOTE_MINIMAL`. + + +.. attribute:: Dialect.skipinitialspace + + When :const:`True`, whitespace immediately following the *delimiter* is ignored. + The default is :const:`False`. + + +.. attribute:: Dialect.strict + + When ``True``, raise exception :exc:`Error` on bad CSV input. + The default is ``False``. + +Reader Objects +-------------- + +Reader objects (:class:`DictReader` instances and objects returned by the +:func:`reader` function) have the following public methods: + +.. method:: csvreader.__next__() + + Return the next row of the reader's iterable object as a list (if the object + was returned from :func:`reader`) or a dict (if it is a :class:`DictReader` + instance), parsed according to the current dialect. Usually you should call + this as ``next(reader)``. + + +Reader objects have the following public attributes: + +.. attribute:: csvreader.dialect + + A read-only description of the dialect in use by the parser. + + +.. attribute:: csvreader.line_num + + The number of lines read from the source iterator. This is not the same as the + number of records returned, as records can span multiple lines. + + +DictReader objects have the following public attribute: + +.. attribute:: csvreader.fieldnames + + If not passed as a parameter when creating the object, this attribute is + initialized upon first access or when the first record is read from the + file. + + + +Writer Objects +-------------- + +:class:`Writer` objects (:class:`DictWriter` instances and objects returned by +the :func:`writer` function) have the following public methods. A *row* must be +an iterable of strings or numbers for :class:`Writer` objects and a dictionary +mapping fieldnames to strings or numbers (by passing them through :func:`str` +first) for :class:`DictWriter` objects. Note that complex numbers are written +out surrounded by parens. This may cause some problems for other programs which +read CSV files (assuming they support complex numbers at all). + + +.. method:: csvwriter.writerow(row) + + Write the *row* parameter to the writer's file object, formatted according to + the current dialect. + + .. versionchanged:: 3.5 + Added support of arbitrary iterables. + +.. method:: csvwriter.writerows(rows) + + Write all elements in *rows* (an iterable of *row* objects as described + above) to the writer's file object, formatted according to the current + dialect. + +Writer objects have the following public attribute: + + +.. attribute:: csvwriter.dialect + + A read-only description of the dialect in use by the writer. + + +DictWriter objects have the following public method: + + +.. method:: DictWriter.writeheader() + + Write a row with the field names (as specified in the constructor). + + .. versionadded:: 3.2 + + +.. _csv-examples: + +Examples +-------- + +The simplest example of reading a CSV file:: + + import csv + with open('some.csv', newline='') as f: + reader = csv.reader(f) + for row in reader: + print(row) + +Reading a file with an alternate format:: + + import csv + with open('passwd', newline='') as f: + reader = csv.reader(f, delimiter=':', quoting=csv.QUOTE_NONE) + for row in reader: + print(row) + +The corresponding simplest possible writing example is:: + + import csv + with open('some.csv', 'w', newline='') as f: + writer = csv.writer(f) + writer.writerows(someiterable) + +Since :func:`open` is used to open a CSV file for reading, the file +will by default be decoded into unicode using the system default +encoding (see :func:`locale.getpreferredencoding`). To decode a file +using a different encoding, use the ``encoding`` argument of open:: + + import csv + with open('some.csv', newline='', encoding='utf-8') as f: + reader = csv.reader(f) + for row in reader: + print(row) + +The same applies to writing in something other than the system default +encoding: specify the encoding argument when opening the output file. + +Registering a new dialect:: + + import csv + csv.register_dialect('unixpwd', delimiter=':', quoting=csv.QUOTE_NONE) + with open('passwd', newline='') as f: + reader = csv.reader(f, 'unixpwd') + +A slightly more advanced use of the reader --- catching and reporting errors:: + + import csv, sys + filename = 'some.csv' + with open(filename, newline='') as f: + reader = csv.reader(f) + try: + for row in reader: + print(row) + except csv.Error as e: + sys.exit('file {}, line {}: {}'.format(filename, reader.line_num, e)) + +And while the module doesn't directly support parsing strings, it can easily be +done:: + + import csv + for row in csv.reader(['one,two,three']): + print(row) + + +.. rubric:: Footnotes + +.. [1] If ``newline=''`` is not specified, newlines embedded inside quoted fields + will not be interpreted correctly, and on platforms that use ``\r\n`` linendings + on write an extra ``\r`` will be added. It should always be safe to specify + ``newline=''``, since the csv module does its own + (:term:`universal `) newline handling. diff --git a/python-3.7.4-docs-html/_sources/library/ctypes.rst.txt b/python-3.7.4-docs-html/_sources/library/ctypes.rst.txt new file mode 100644 index 0000000..46a9d23 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/ctypes.rst.txt @@ -0,0 +1,2486 @@ +:mod:`ctypes` --- A foreign function library for Python +======================================================= + +.. module:: ctypes + :synopsis: A foreign function library for Python. + +.. moduleauthor:: Thomas Heller + +-------------- + +:mod:`ctypes` is a foreign function library for Python. It provides C compatible +data types, and allows calling functions in DLLs or shared libraries. It can be +used to wrap these libraries in pure Python. + + +.. _ctypes-ctypes-tutorial: + +ctypes tutorial +--------------- + +Note: The code samples in this tutorial use :mod:`doctest` to make sure that +they actually work. Since some code samples behave differently under Linux, +Windows, or Mac OS X, they contain doctest directives in comments. + +Note: Some code samples reference the ctypes :class:`c_int` type. On platforms +where ``sizeof(long) == sizeof(int)`` it is an alias to :class:`c_long`. +So, you should not be confused if :class:`c_long` is printed if you would expect +:class:`c_int` --- they are actually the same type. + +.. _ctypes-loading-dynamic-link-libraries: + +Loading dynamic link libraries +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:mod:`ctypes` exports the *cdll*, and on Windows *windll* and *oledll* +objects, for loading dynamic link libraries. + +You load libraries by accessing them as attributes of these objects. *cdll* +loads libraries which export functions using the standard ``cdecl`` calling +convention, while *windll* libraries call functions using the ``stdcall`` +calling convention. *oledll* also uses the ``stdcall`` calling convention, and +assumes the functions return a Windows :c:type:`HRESULT` error code. The error +code is used to automatically raise an :class:`OSError` exception when the +function call fails. + +.. versionchanged:: 3.3 + Windows errors used to raise :exc:`WindowsError`, which is now an alias + of :exc:`OSError`. + + +Here are some examples for Windows. Note that ``msvcrt`` is the MS standard C +library containing most standard C functions, and uses the cdecl calling +convention:: + + >>> from ctypes import * + >>> print(windll.kernel32) # doctest: +WINDOWS + + >>> print(cdll.msvcrt) # doctest: +WINDOWS + + >>> libc = cdll.msvcrt # doctest: +WINDOWS + >>> + +Windows appends the usual ``.dll`` file suffix automatically. + +.. note:: + Accessing the standard C library through ``cdll.msvcrt`` will use an + outdated version of the library that may be incompatible with the one + being used by Python. Where possible, use native Python functionality, + or else import and use the ``msvcrt`` module. + +On Linux, it is required to specify the filename *including* the extension to +load a library, so attribute access can not be used to load libraries. Either the +: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 + + >>> libc = CDLL("libc.so.6") # doctest: +LINUX + >>> libc # doctest: +LINUX + + >>> + +.. XXX Add section for Mac OS X. + + +.. _ctypes-accessing-functions-from-loaded-dlls: + +Accessing functions from loaded dlls +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Functions are accessed as attributes of dll objects:: + + >>> from ctypes import * + >>> libc.printf + <_FuncPtr object at 0x...> + >>> print(windll.kernel32.GetModuleHandleA) # doctest: +WINDOWS + <_FuncPtr object at 0x...> + >>> print(windll.kernel32.MyOwnFunction) # doctest: +WINDOWS + Traceback (most recent call last): + File "", line 1, in + File "ctypes.py", line 239, in __getattr__ + func = _StdcallFuncPtr(name, self) + AttributeError: function 'MyOwnFunction' not found + >>> + +Note that win32 system dlls like ``kernel32`` and ``user32`` often export ANSI +as well as UNICODE versions of a function. The UNICODE version is exported with +an ``W`` appended to the name, while the ANSI version is exported with an ``A`` +appended to the name. The win32 ``GetModuleHandle`` function, which returns a +*module handle* for a given module name, has the following C prototype, and a +macro is used to expose one of them as ``GetModuleHandle`` depending on whether +UNICODE is defined or not:: + + /* ANSI version */ + HMODULE GetModuleHandleA(LPCSTR lpModuleName); + /* UNICODE version */ + HMODULE GetModuleHandleW(LPCWSTR lpModuleName); + +*windll* does not try to select one of them by magic, you must access the +version you need by specifying ``GetModuleHandleA`` or ``GetModuleHandleW`` +explicitly, and then call it with bytes or string objects respectively. + +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 + <_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 + <_FuncPtr object at 0x...> + >>> cdll.kernel32[0] # doctest: +WINDOWS + Traceback (most recent call last): + File "", line 1, in + File "ctypes.py", line 310, in __getitem__ + func = _StdcallFuncPtr(name, self) + AttributeError: function ordinal 0 not found + >>> + + +.. _ctypes-calling-functions: + +Calling functions +^^^^^^^^^^^^^^^^^ + +You can call these functions like any other Python callable. This example uses +the ``time()`` function, which returns system time in seconds since the Unix +epoch, and the ``GetModuleHandleA()`` function, which returns a win32 module +handle. + +This example calls both functions with a NULL pointer (``None`` should be used +as the NULL pointer):: + + >>> print(libc.time(None)) # doctest: +SKIP + 1150640792 + >>> print(hex(windll.kernel32.GetModuleHandleA(None))) # doctest: +WINDOWS + 0x1d000000 + >>> + +.. note:: + + :mod:`ctypes` may raise a :exc:`ValueError` after calling the function, if + it detects that an invalid number of arguments were passed. This behavior + should not be relied upon. It is deprecated in 3.6.2, and will be removed + in 3.7. + +:exc:`ValueError` is raised when you call an ``stdcall`` function with the +``cdecl`` calling convention, or vice versa:: + + >>> cdll.kernel32.GetModuleHandleA(None) # doctest: +WINDOWS + Traceback (most recent call last): + File "", line 1, in + ValueError: Procedure probably called with not enough arguments (4 bytes missing) + >>> + + >>> windll.msvcrt.printf(b"spam") # doctest: +WINDOWS + Traceback (most recent call last): + File "", line 1, in + ValueError: Procedure probably called with too many arguments (4 bytes in excess) + >>> + +To find out the correct calling convention you have to look into the C header +file or the documentation for the function you want to call. + +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 + Traceback (most recent call last): + File "", line 1, in + OSError: exception: access violation reading 0x00000020 + >>> + +There are, however, enough ways to crash Python with :mod:`ctypes`, so you +should be careful anyway. The :mod:`faulthandler` module can be helpful in +debugging crashes (e.g. from segmentation faults produced by erroneous C library +calls). + +``None``, integers, bytes objects and (unicode) strings are the only native +Python objects that can directly be used as parameters in these function calls. +``None`` is passed as a C ``NULL`` pointer, bytes objects and strings are passed +as pointer to the memory block that contains their data (:c:type:`char *` or +:c:type:`wchar_t *`). Python integers are passed as the platforms default C +:c:type:`int` type, their value is masked to fit into the C type. + +Before we move on calling functions with other parameter types, we have to learn +more about :mod:`ctypes` data types. + + +.. _ctypes-fundamental-data-types: + +Fundamental data types +^^^^^^^^^^^^^^^^^^^^^^ + +:mod:`ctypes` defines a number of primitive C compatible data types: + ++----------------------+------------------------------------------+----------------------------+ +| ctypes type | C type | Python type | ++======================+==========================================+============================+ +| :class:`c_bool` | :c:type:`_Bool` | bool (1) | ++----------------------+------------------------------------------+----------------------------+ +| :class:`c_char` | :c:type:`char` | 1-character bytes object | ++----------------------+------------------------------------------+----------------------------+ +| :class:`c_wchar` | :c:type:`wchar_t` | 1-character string | ++----------------------+------------------------------------------+----------------------------+ +| :class:`c_byte` | :c:type:`char` | int | ++----------------------+------------------------------------------+----------------------------+ +| :class:`c_ubyte` | :c:type:`unsigned char` | int | ++----------------------+------------------------------------------+----------------------------+ +| :class:`c_short` | :c:type:`short` | int | ++----------------------+------------------------------------------+----------------------------+ +| :class:`c_ushort` | :c:type:`unsigned short` | int | ++----------------------+------------------------------------------+----------------------------+ +| :class:`c_int` | :c:type:`int` | int | ++----------------------+------------------------------------------+----------------------------+ +| :class:`c_uint` | :c:type:`unsigned int` | int | ++----------------------+------------------------------------------+----------------------------+ +| :class:`c_long` | :c:type:`long` | int | ++----------------------+------------------------------------------+----------------------------+ +| :class:`c_ulong` | :c:type:`unsigned long` | int | ++----------------------+------------------------------------------+----------------------------+ +| :class:`c_longlong` | :c:type:`__int64` or :c:type:`long long` | int | ++----------------------+------------------------------------------+----------------------------+ +| :class:`c_ulonglong` | :c:type:`unsigned __int64` or | int | +| | :c:type:`unsigned long long` | | ++----------------------+------------------------------------------+----------------------------+ +| :class:`c_size_t` | :c:type:`size_t` | int | ++----------------------+------------------------------------------+----------------------------+ +| :class:`c_ssize_t` | :c:type:`ssize_t` or | int | +| | :c:type:`Py_ssize_t` | | ++----------------------+------------------------------------------+----------------------------+ +| :class:`c_float` | :c:type:`float` | float | ++----------------------+------------------------------------------+----------------------------+ +| :class:`c_double` | :c:type:`double` | float | ++----------------------+------------------------------------------+----------------------------+ +| :class:`c_longdouble`| :c:type:`long double` | float | ++----------------------+------------------------------------------+----------------------------+ +| :class:`c_char_p` | :c:type:`char *` (NUL terminated) | bytes object or ``None`` | ++----------------------+------------------------------------------+----------------------------+ +| :class:`c_wchar_p` | :c:type:`wchar_t *` (NUL terminated) | string or ``None`` | ++----------------------+------------------------------------------+----------------------------+ +| :class:`c_void_p` | :c:type:`void *` | int or ``None`` | ++----------------------+------------------------------------------+----------------------------+ + +(1) + The constructor accepts any object with a truth value. + +All these types can be created by calling them with an optional initializer of +the correct type and value:: + + >>> c_int() + c_long(0) + >>> c_wchar_p("Hello, World") + c_wchar_p(140018365411392) + >>> c_ushort(-3) + c_ushort(65533) + >>> + +Since these types are mutable, their value can also be changed afterwards:: + + >>> i = c_int(42) + >>> print(i) + c_long(42) + >>> print(i.value) + 42 + >>> i.value = -99 + >>> print(i.value) + -99 + >>> + +Assigning a new value to instances of the pointer types :class:`c_char_p`, +:class:`c_wchar_p`, and :class:`c_void_p` changes the *memory location* they +point to, *not the contents* of the memory block (of course not, because Python +bytes objects are immutable):: + + >>> s = "Hello, World" + >>> c_s = c_wchar_p(s) + >>> print(c_s) + c_wchar_p(139966785747344) + >>> print(c_s.value) + Hello World + >>> c_s.value = "Hi, there" + >>> print(c_s) # the memory location has changed + c_wchar_p(139966783348904) + >>> print(c_s.value) + Hi, there + >>> print(s) # first object is unchanged + Hello, World + >>> + +You should be careful, however, not to pass them to functions expecting pointers +to mutable memory. If you need mutable memory blocks, ctypes has a +:func:`create_string_buffer` function which creates these in various ways. The +current memory block contents can be accessed (or changed) with the ``raw`` +property; if you want to access it as NUL terminated string, use the ``value`` +property:: + + >>> from ctypes import * + >>> p = create_string_buffer(3) # create a 3 byte buffer, initialized to NUL bytes + >>> print(sizeof(p), repr(p.raw)) + 3 b'\x00\x00\x00' + >>> p = create_string_buffer(b"Hello") # create a buffer containing a NUL terminated string + >>> print(sizeof(p), repr(p.raw)) + 6 b'Hello\x00' + >>> print(repr(p.value)) + b'Hello' + >>> p = create_string_buffer(b"Hello", 10) # create a 10 byte buffer + >>> print(sizeof(p), repr(p.raw)) + 10 b'Hello\x00\x00\x00\x00\x00' + >>> p.value = b"Hi" + >>> print(sizeof(p), repr(p.raw)) + 10 b'Hi\x00lo\x00\x00\x00\x00\x00' + >>> + +The :func:`create_string_buffer` function replaces the :func:`c_buffer` function +(which is still available as an alias), as well as the :func:`c_string` function +from earlier ctypes releases. To create a mutable memory block containing +unicode characters of the C type :c:type:`wchar_t` use the +:func:`create_unicode_buffer` function. + + +.. _ctypes-calling-functions-continued: + +Calling functions, continued +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Note that printf prints to the real standard output channel, *not* to +:data:`sys.stdout`, so these examples will only work at the console prompt, not +from within *IDLE* or *PythonWin*:: + + >>> printf = libc.printf + >>> printf(b"Hello, %s\n", b"World!") + Hello, World! + 14 + >>> printf(b"Hello, %S\n", "World!") + Hello, World! + 14 + >>> printf(b"%d bottles of beer\n", 42) + 42 bottles of beer + 19 + >>> printf(b"%f bottles of beer\n", 42.5) + Traceback (most recent call last): + File "", line 1, in + ArgumentError: argument 2: exceptions.TypeError: Don't know how to convert parameter 2 + >>> + +As has been mentioned before, all Python types except integers, strings, and +bytes objects have to be wrapped in their corresponding :mod:`ctypes` type, so +that they can be converted to the required C data type:: + + >>> printf(b"An int %d, a double %f\n", 1234, c_double(3.14)) + An int 1234, a double 3.140000 + 31 + >>> + + +.. _ctypes-calling-functions-with-own-custom-data-types: + +Calling functions with your own custom data types +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +You can also customize :mod:`ctypes` argument conversion to allow instances of +your own classes be used as function arguments. :mod:`ctypes` looks for an +:attr:`_as_parameter_` attribute and uses this as the function argument. Of +course, it must be one of integer, string, or bytes:: + + >>> class Bottles: + ... def __init__(self, number): + ... self._as_parameter_ = number + ... + >>> bottles = Bottles(42) + >>> printf(b"%d bottles of beer\n", bottles) + 42 bottles of beer + 19 + >>> + +If you don't want to store the instance's data in the :attr:`_as_parameter_` +instance variable, you could define a :class:`property` which makes the +attribute available on request. + + +.. _ctypes-specifying-required-argument-types: + +Specifying the required argument types (function prototypes) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +It is possible to specify the required argument types of functions exported from +DLLs by setting the :attr:`argtypes` attribute. + +:attr:`argtypes` must be a sequence of C data types (the ``printf`` function is +probably not a good example here, because it takes a variable number and +different types of parameters depending on the format string, on the other hand +this is quite handy to experiment with this feature):: + + >>> printf.argtypes = [c_char_p, c_char_p, c_int, c_double] + >>> printf(b"String '%s', Int %d, Double %f\n", b"Hi", 10, 2.2) + String 'Hi', Int 10, Double 2.200000 + 37 + >>> + +Specifying a format protects against incompatible argument types (just as a +prototype for a C function), and tries to convert the arguments to valid types:: + + >>> printf(b"%d %d %d", 1, 2, 3) + Traceback (most recent call last): + File "", line 1, in + ArgumentError: argument 2: exceptions.TypeError: wrong type + >>> printf(b"%s %d %f\n", b"X", 2, 3) + X 2 3.000000 + 13 + >>> + +If you have defined your own classes which you pass to function calls, you have +to implement a :meth:`from_param` class method for them to be able to use them +in the :attr:`argtypes` sequence. The :meth:`from_param` class method receives +the Python object passed to the function call, it should do a typecheck or +whatever is needed to make sure this object is acceptable, and then return the +object itself, its :attr:`_as_parameter_` attribute, or whatever you want to +pass as the C function argument in this case. Again, the result should be an +integer, string, bytes, a :mod:`ctypes` instance, or an object with an +:attr:`_as_parameter_` attribute. + + +.. _ctypes-return-types: + +Return types +^^^^^^^^^^^^ + +By default functions are assumed to return the C :c:type:`int` type. Other +return types can be specified by setting the :attr:`restype` attribute of the +function object. + +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 + 8059983 + >>> 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"))) + None + >>> + +If you want to avoid the ``ord("x")`` calls above, you can set the +:attr:`argtypes` attribute, and the second argument will be converted from a +single character Python bytes object into a C char:: + + >>> strchr.restype = c_char_p + >>> strchr.argtypes = [c_char_p, c_char] + >>> strchr(b"abcdef", b"d") + 'def' + >>> strchr(b"abcdef", b"def") + Traceback (most recent call last): + File "", line 1, in + ArgumentError: argument 2: exceptions.TypeError: one character string expected + >>> print(strchr(b"abcdef", b"x")) + None + >>> strchr(b"abcdef", b"d") + 'def' + >>> + +You can also use a callable Python object (a function or a class for example) as +the :attr:`restype` attribute, if the foreign function returns an integer. The +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 + >>> def ValidHandle(value): + ... if value == 0: + ... raise WinError() + ... return value + ... + >>> + >>> GetModuleHandle.restype = ValidHandle # doctest: +WINDOWS + >>> GetModuleHandle(None) # doctest: +WINDOWS + 486539264 + >>> GetModuleHandle("something silly") # doctest: +WINDOWS + Traceback (most recent call last): + File "", line 1, in + File "", line 3, in ValidHandle + OSError: [Errno 126] The specified module could not be found. + >>> + +``WinError`` is a function which will call Windows ``FormatMessage()`` api to +get the string representation of an error code, and *returns* an exception. +``WinError`` takes an optional error code parameter, if no one is used, it calls +:func:`GetLastError` to retrieve it. + +Please note that a much more powerful error checking mechanism is available +through the :attr:`errcheck` attribute; see the reference manual for details. + + +.. _ctypes-passing-pointers: + +Passing pointers (or: passing parameters by reference) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Sometimes a C api function expects a *pointer* to a data type as parameter, +probably to write into the corresponding location, or if the data is too large +to be passed by value. This is also known as *passing parameters by reference*. + +:mod:`ctypes` exports the :func:`byref` function which is used to pass parameters +by reference. The same effect can be achieved with the :func:`pointer` function, +although :func:`pointer` does a lot more work since it constructs a real pointer +object, so it is faster to use :func:`byref` if you don't need the pointer +object in Python itself:: + + >>> i = c_int() + >>> f = c_float() + >>> s = create_string_buffer(b'\000' * 32) + >>> print(i.value, f.value, repr(s.value)) + 0 0.0 b'' + >>> libc.sscanf(b"1 3.14 Hello", b"%d %f %s", + ... byref(i), byref(f), s) + 3 + >>> print(i.value, f.value, repr(s.value)) + 1 3.1400001049 b'Hello' + >>> + + +.. _ctypes-structures-unions: + +Structures and unions +^^^^^^^^^^^^^^^^^^^^^ + +Structures and unions must derive from the :class:`Structure` and :class:`Union` +base classes which are defined in the :mod:`ctypes` module. Each subclass must +define a :attr:`_fields_` attribute. :attr:`_fields_` must be a list of +*2-tuples*, containing a *field name* and a *field type*. + +The field type must be a :mod:`ctypes` type like :class:`c_int`, or any other +derived :mod:`ctypes` type: structure, union, array, pointer. + +Here is a simple example of a POINT structure, which contains two integers named +*x* and *y*, and also shows how to initialize a structure in the constructor:: + + >>> from ctypes import * + >>> class POINT(Structure): + ... _fields_ = [("x", c_int), + ... ("y", c_int)] + ... + >>> point = POINT(10, 20) + >>> print(point.x, point.y) + 10 20 + >>> point = POINT(y=5) + >>> print(point.x, point.y) + 0 5 + >>> POINT(1, 2, 3) + Traceback (most recent call last): + File "", line 1, in + TypeError: too many initializers + >>> + +You can, however, build much more complicated structures. A structure can +itself contain other structures by using a structure as a field type. + +Here is a RECT structure which contains two POINTs named *upperleft* and +*lowerright*:: + + >>> class RECT(Structure): + ... _fields_ = [("upperleft", POINT), + ... ("lowerright", POINT)] + ... + >>> rc = RECT(point) + >>> print(rc.upperleft.x, rc.upperleft.y) + 0 5 + >>> print(rc.lowerright.x, rc.lowerright.y) + 0 0 + >>> + +Nested structures can also be initialized in the constructor in several ways:: + + >>> r = RECT(POINT(1, 2), POINT(3, 4)) + >>> r = RECT((1, 2), (3, 4)) + +Field :term:`descriptor`\s can be retrieved from the *class*, they are useful +for debugging because they can provide useful information:: + + >>> print(POINT.x) + + >>> print(POINT.y) + + >>> + + +.. _ctypes-structureunion-alignment-byte-order: + +.. warning:: + + :mod:`ctypes` does not support passing unions or structures with bit-fields + to functions by value. While this may work on 32-bit x86, it's not + guaranteed by the library to work in the general case. Unions and + structures with bit-fields should always be passed to functions by pointer. + +Structure/union alignment and byte order +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +By default, Structure and Union fields are aligned in the same way the C +compiler does it. It is possible to override this behavior be specifying a +:attr:`_pack_` class attribute in the subclass definition. This must be set to a +positive integer and specifies the maximum alignment for the fields. This is +what ``#pragma pack(n)`` also does in MSVC. + +:mod:`ctypes` uses the native byte order for Structures and Unions. To build +structures with non-native byte order, you can use one of the +:class:`BigEndianStructure`, :class:`LittleEndianStructure`, +:class:`BigEndianUnion`, and :class:`LittleEndianUnion` base classes. These +classes cannot contain pointer fields. + + +.. _ctypes-bit-fields-in-structures-unions: + +Bit fields in structures and unions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +It is possible to create structures and unions containing bit fields. Bit fields +are only possible for integer fields, the bit width is specified as the third +item in the :attr:`_fields_` tuples:: + + >>> class Int(Structure): + ... _fields_ = [("first_16", c_int, 16), + ... ("second_16", c_int, 16)] + ... + >>> print(Int.first_16) + + >>> print(Int.second_16) + + >>> + + +.. _ctypes-arrays: + +Arrays +^^^^^^ + +Arrays are sequences, containing a fixed number of instances of the same type. + +The recommended way to create array types is by multiplying a data type with a +positive integer:: + + TenPointsArrayType = POINT * 10 + +Here is an example of a somewhat artificial data type, a structure containing 4 +POINTs among other stuff:: + + >>> from ctypes import * + >>> class POINT(Structure): + ... _fields_ = ("x", c_int), ("y", c_int) + ... + >>> class MyStruct(Structure): + ... _fields_ = [("a", c_int), + ... ("b", c_float), + ... ("point_array", POINT * 4)] + >>> + >>> print(len(MyStruct().point_array)) + 4 + >>> + +Instances are created in the usual way, by calling the class:: + + arr = TenPointsArrayType() + for pt in arr: + print(pt.x, pt.y) + +The above code print a series of ``0 0`` lines, because the array contents is +initialized to zeros. + +Initializers of the correct type can also be specified:: + + >>> from ctypes import * + >>> TenIntegers = c_int * 10 + >>> ii = TenIntegers(1, 2, 3, 4, 5, 6, 7, 8, 9, 10) + >>> print(ii) + + >>> for i in ii: print(i, end=" ") + ... + 1 2 3 4 5 6 7 8 9 10 + >>> + + +.. _ctypes-pointers: + +Pointers +^^^^^^^^ + +Pointer instances are created by calling the :func:`pointer` function on a +:mod:`ctypes` type:: + + >>> from ctypes import * + >>> i = c_int(42) + >>> pi = pointer(i) + >>> + +Pointer instances have a :attr:`~_Pointer.contents` attribute which +returns the object to which the pointer points, the ``i`` object above:: + + >>> pi.contents + c_long(42) + >>> + +Note that :mod:`ctypes` does not have OOR (original object return), it constructs a +new, equivalent object each time you retrieve an attribute:: + + >>> pi.contents is i + False + >>> pi.contents is pi.contents + False + >>> + +Assigning another :class:`c_int` instance to the pointer's contents attribute +would cause the pointer to point to the memory location where this is stored:: + + >>> i = c_int(99) + >>> pi.contents = i + >>> pi.contents + c_long(99) + >>> + +.. XXX Document dereferencing pointers, and that it is preferred over the + .contents attribute. + +Pointer instances can also be indexed with integers:: + + >>> pi[0] + 99 + >>> + +Assigning to an integer index changes the pointed to value:: + + >>> print(i) + c_long(99) + >>> pi[0] = 22 + >>> print(i) + c_long(22) + >>> + +It is also possible to use indexes different from 0, but you must know what +you're doing, just as in C: You can access or change arbitrary memory locations. +Generally you only use this feature if you receive a pointer from a C function, +and you *know* that the pointer actually points to an array instead of a single +item. + +Behind the scenes, the :func:`pointer` function does more than simply create +pointer instances, it has to create pointer *types* first. This is done with the +:func:`POINTER` function, which accepts any :mod:`ctypes` type, and returns a +new type:: + + >>> PI = POINTER(c_int) + >>> PI + + >>> PI(42) + Traceback (most recent call last): + File "", line 1, in + TypeError: expected c_long instead of int + >>> PI(c_int(42)) + + >>> + +Calling the pointer type without an argument creates a ``NULL`` pointer. +``NULL`` pointers have a ``False`` boolean value:: + + >>> null_ptr = POINTER(c_int)() + >>> print(bool(null_ptr)) + False + >>> + +:mod:`ctypes` checks for ``NULL`` when dereferencing pointers (but dereferencing +invalid non-\ ``NULL`` pointers would crash Python):: + + >>> null_ptr[0] + Traceback (most recent call last): + .... + ValueError: NULL pointer access + >>> + + >>> null_ptr[0] = 1234 + Traceback (most recent call last): + .... + ValueError: NULL pointer access + >>> + + +.. _ctypes-type-conversions: + +Type conversions +^^^^^^^^^^^^^^^^ + +Usually, ctypes does strict type checking. This means, if you have +``POINTER(c_int)`` in the :attr:`argtypes` list of a function or as the type of +a member field in a structure definition, only instances of exactly the same +type are accepted. There are some exceptions to this rule, where ctypes accepts +other objects. For example, you can pass compatible array instances instead of +pointer types. So, for ``POINTER(c_int)``, ctypes accepts an array of c_int:: + + >>> class Bar(Structure): + ... _fields_ = [("count", c_int), ("values", POINTER(c_int))] + ... + >>> bar = Bar() + >>> bar.values = (c_int * 3)(1, 2, 3) + >>> bar.count = 3 + >>> for i in range(bar.count): + ... print(bar.values[i]) + ... + 1 + 2 + 3 + >>> + +In addition, if a function argument is explicitly declared to be a pointer type +(such as ``POINTER(c_int)``) in :attr:`argtypes`, an object of the pointed +type (``c_int`` in this case) can be passed to the function. ctypes will apply +the required :func:`byref` conversion in this case automatically. + +To set a POINTER type field to ``NULL``, you can assign ``None``:: + + >>> bar.values = None + >>> + +.. XXX list other conversions... + +Sometimes you have instances of incompatible types. In C, you can cast one type +into another type. :mod:`ctypes` provides a :func:`cast` function which can be +used in the same way. The ``Bar`` structure defined above accepts +``POINTER(c_int)`` pointers or :class:`c_int` arrays for its ``values`` field, +but not instances of other types:: + + >>> bar.values = (c_byte * 4)() + Traceback (most recent call last): + File "", line 1, in + TypeError: incompatible types, c_byte_Array_4 instance instead of LP_c_long instance + >>> + +For these cases, the :func:`cast` function is handy. + +The :func:`cast` function can be used to cast a ctypes instance into a pointer +to a different ctypes data type. :func:`cast` takes two parameters, a ctypes +object that is or can be converted to a pointer of some kind, and a ctypes +pointer type. It returns an instance of the second argument, which references +the same memory block as the first argument:: + + >>> a = (c_byte * 4)() + >>> cast(a, POINTER(c_int)) + + >>> + +So, :func:`cast` can be used to assign to the ``values`` field of ``Bar`` the +structure:: + + >>> bar = Bar() + >>> bar.values = cast((c_byte * 4)(), POINTER(c_int)) + >>> print(bar.values[0]) + 0 + >>> + + +.. _ctypes-incomplete-types: + +Incomplete Types +^^^^^^^^^^^^^^^^ + +*Incomplete Types* are structures, unions or arrays whose members are not yet +specified. In C, they are specified by forward declarations, which are defined +later:: + + struct cell; /* forward declaration */ + + struct cell { + char *name; + struct cell *next; + }; + +The straightforward translation into ctypes code would be this, but it does not +work:: + + >>> class cell(Structure): + ... _fields_ = [("name", c_char_p), + ... ("next", POINTER(cell))] + ... + Traceback (most recent call last): + File "", line 1, in + File "", line 2, in cell + NameError: name 'cell' is not defined + >>> + +because the new ``class cell`` is not available in the class statement itself. +In :mod:`ctypes`, we can define the ``cell`` class and set the :attr:`_fields_` +attribute later, after the class statement:: + + >>> from ctypes import * + >>> class cell(Structure): + ... pass + ... + >>> cell._fields_ = [("name", c_char_p), + ... ("next", POINTER(cell))] + >>> + +Lets try it. We create two instances of ``cell``, and let them point to each +other, and finally follow the pointer chain a few times:: + + >>> c1 = cell() + >>> c1.name = "foo" + >>> c2 = cell() + >>> c2.name = "bar" + >>> c1.next = pointer(c2) + >>> c2.next = pointer(c1) + >>> p = c1 + >>> for i in range(8): + ... print(p.name, end=" ") + ... p = p.next[0] + ... + foo bar foo bar foo bar foo bar + >>> + + +.. _ctypes-callback-functions: + +Callback functions +^^^^^^^^^^^^^^^^^^ + +:mod:`ctypes` allows creating C callable function pointers from Python callables. +These are sometimes called *callback functions*. + +First, you must create a class for the callback function. The class knows the +calling convention, the return type, and the number and types of arguments this +function will receive. + +The :func:`CFUNCTYPE` factory function creates types for callback functions +using the ``cdecl`` calling convention. On Windows, the :func:`WINFUNCTYPE` +factory function creates types for callback functions using the ``stdcall`` +calling convention. + +Both of these factory functions are called with the result type as first +argument, and the callback functions expected argument types as the remaining +arguments. + +I will present an example here which uses the standard C library's +:c:func:`qsort` function, that is used to sort items with the help of a callback +function. :c:func:`qsort` will be used to sort an array of integers:: + + >>> IntArray5 = c_int * 5 + >>> ia = IntArray5(5, 1, 7, 33, 99) + >>> qsort = libc.qsort + >>> qsort.restype = None + >>> + +:func:`qsort` must be called with a pointer to the data to sort, the number of +items in the data array, the size of one item, and a pointer to the comparison +function, the callback. The callback will then be called with two pointers to +items, and it must return a negative integer if the first item is smaller than +the second, a zero if they are equal, and a positive integer otherwise. + +So our callback function receives pointers to integers, and must return an +integer. First we create the ``type`` for the callback function:: + + >>> CMPFUNC = CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int)) + >>> + +To get started, here is a simple callback that shows the values it gets +passed:: + + >>> def py_cmp_func(a, b): + ... print("py_cmp_func", a[0], b[0]) + ... return 0 + ... + >>> cmp_func = CMPFUNC(py_cmp_func) + >>> + +The result:: + + >>> 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 + py_cmp_func 5 7 + py_cmp_func 1 7 + >>> + +Now we can actually compare the two items and return a useful result:: + + >>> def py_cmp_func(a, b): + ... print("py_cmp_func", a[0], b[0]) + ... return a[0] - b[0] + ... + >>> + >>> qsort(ia, len(ia), sizeof(c_int), CMPFUNC(py_cmp_func)) # doctest: +LINUX + py_cmp_func 5 1 + py_cmp_func 33 99 + py_cmp_func 7 33 + py_cmp_func 1 7 + py_cmp_func 5 7 + >>> + +As we can easily check, our array is sorted now:: + + >>> for i in ia: print(i, end=" ") + ... + 1 5 7 33 99 + >>> + +The function factories can be used as decorator factories, so we may as well +write:: + + >>> @CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int)) + ... def py_cmp_func(a, b): + ... print("py_cmp_func", a[0], b[0]) + ... return a[0] - b[0] + ... + >>> qsort(ia, len(ia), sizeof(c_int), py_cmp_func) + py_cmp_func 5 1 + py_cmp_func 33 99 + py_cmp_func 7 33 + py_cmp_func 1 7 + py_cmp_func 5 7 + >>> + +.. note:: + + Make sure you keep references to :func:`CFUNCTYPE` objects as long as they + are used from C code. :mod:`ctypes` doesn't, and if you don't, they may be + garbage collected, crashing your program when a callback is made. + + Also, note that if the callback function is called in a thread created + outside of Python's control (e.g. by the foreign code that calls the + callback), ctypes creates a new dummy Python thread on every invocation. This + behavior is correct for most purposes, but it means that values stored with + :class:`threading.local` will *not* survive across different callbacks, even when + those calls are made from the same C thread. + +.. _ctypes-accessing-values-exported-from-dlls: + +Accessing values exported from dlls +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Some shared libraries not only export functions, they also export variables. An +example in the Python library itself is the :c:data:`Py_OptimizeFlag`, an integer +set to 0, 1, or 2, depending on the :option:`-O` or :option:`-OO` flag given on +startup. + +:mod:`ctypes` can access values like this with the :meth:`in_dll` class methods of +the type. *pythonapi* is a predefined symbol giving access to the Python C +api:: + + >>> opt_flag = c_int.in_dll(pythonapi, "Py_OptimizeFlag") + >>> print(opt_flag) + c_long(0) + >>> + +If the interpreter would have been started with :option:`-O`, the sample would +have printed ``c_long(1)``, or ``c_long(2)`` if :option:`-OO` would have been +specified. + +An extended example which also demonstrates the use of pointers accesses the +:c:data:`PyImport_FrozenModules` pointer exported by Python. + +Quoting the docs for that value: + + This pointer is initialized to point to an array of :c:type:`struct _frozen` + records, terminated by one whose members are all *NULL* or zero. When a frozen + module is imported, it is searched in this table. Third-party code could play + tricks with this to provide a dynamically created collection of frozen modules. + +So manipulating this pointer could even prove useful. To restrict the example +size, we show only how this table can be read with :mod:`ctypes`:: + + >>> from ctypes import * + >>> + >>> class struct_frozen(Structure): + ... _fields_ = [("name", c_char_p), + ... ("code", POINTER(c_ubyte)), + ... ("size", c_int)] + ... + >>> + +We have defined the :c:type:`struct _frozen` data type, so we can get the pointer +to the table:: + + >>> FrozenTable = POINTER(struct_frozen) + >>> table = FrozenTable.in_dll(pythonapi, "PyImport_FrozenModules") + >>> + +Since ``table`` is a ``pointer`` to the array of ``struct_frozen`` records, we +can iterate over it, but we just have to make sure that our loop terminates, +because pointers have no size. Sooner or later it would probably crash with an +access violation or whatever, so it's better to break out of the loop when we +hit the NULL entry:: + + >>> for item in table: + ... if item.name is None: + ... break + ... print(item.name.decode("ascii"), item.size) + ... + _frozen_importlib 31764 + _frozen_importlib_external 41499 + __hello__ 161 + __phello__ -161 + __phello__.spam 161 + >>> + +The fact that standard Python has a frozen module and a frozen package +(indicated by the negative size member) is not well known, it is only used for +testing. Try it out with ``import __hello__`` for example. + + +.. _ctypes-surprises: + +Surprises +^^^^^^^^^ + +There are some edges in :mod:`ctypes` where you might expect something other +than what actually happens. + +Consider the following example:: + + >>> from ctypes import * + >>> class POINT(Structure): + ... _fields_ = ("x", c_int), ("y", c_int) + ... + >>> class RECT(Structure): + ... _fields_ = ("a", POINT), ("b", POINT) + ... + >>> p1 = POINT(1, 2) + >>> p2 = POINT(3, 4) + >>> rc = RECT(p1, p2) + >>> print(rc.a.x, rc.a.y, rc.b.x, rc.b.y) + 1 2 3 4 + >>> # now swap the two points + >>> rc.a, rc.b = rc.b, rc.a + >>> print(rc.a.x, rc.a.y, rc.b.x, rc.b.y) + 3 4 3 4 + >>> + +Hm. We certainly expected the last statement to print ``3 4 1 2``. What +happened? Here are the steps of the ``rc.a, rc.b = rc.b, rc.a`` line above:: + + >>> temp0, temp1 = rc.b, rc.a + >>> rc.a = temp0 + >>> rc.b = temp1 + >>> + +Note that ``temp0`` and ``temp1`` are objects still using the internal buffer of +the ``rc`` object above. So executing ``rc.a = temp0`` copies the buffer +contents of ``temp0`` into ``rc`` 's buffer. This, in turn, changes the +contents of ``temp1``. So, the last assignment ``rc.b = temp1``, doesn't have +the expected effect. + +Keep in mind that retrieving sub-objects from Structure, Unions, and Arrays +doesn't *copy* the sub-object, instead it retrieves a wrapper object accessing +the root-object's underlying buffer. + +Another example that may behave different from what one would expect is this:: + + >>> s = c_char_p() + >>> s.value = "abc def ghi" + >>> s.value + 'abc def ghi' + >>> s.value is s.value + False + >>> + +Why is it printing ``False``? ctypes instances are objects containing a memory +block plus some :term:`descriptor`\s accessing the contents of the memory. +Storing a Python object in the memory block does not store the object itself, +instead the ``contents`` of the object is stored. Accessing the contents again +constructs a new Python object each time! + + +.. _ctypes-variable-sized-data-types: + +Variable-sized data types +^^^^^^^^^^^^^^^^^^^^^^^^^ + +:mod:`ctypes` provides some support for variable-sized arrays and structures. + +The :func:`resize` function can be used to resize the memory buffer of an +existing ctypes object. The function takes the object as first argument, and +the requested size in bytes as the second argument. The memory block cannot be +made smaller than the natural memory block specified by the objects type, a +:exc:`ValueError` is raised if this is tried:: + + >>> short_array = (c_short * 4)() + >>> print(sizeof(short_array)) + 8 + >>> resize(short_array, 4) + Traceback (most recent call last): + ... + ValueError: minimum size is 8 + >>> resize(short_array, 32) + >>> sizeof(short_array) + 32 + >>> sizeof(type(short_array)) + 8 + >>> + +This is nice and fine, but how would one access the additional elements +contained in this array? Since the type still only knows about 4 elements, we +get errors accessing other elements:: + + >>> short_array[:] + [0, 0, 0, 0] + >>> short_array[7] + Traceback (most recent call last): + ... + IndexError: invalid index + >>> + +Another way to use variable-sized data types with :mod:`ctypes` is to use the +dynamic nature of Python, and (re-)define the data type after the required size +is already known, on a case by case basis. + + +.. _ctypes-ctypes-reference: + +ctypes reference +---------------- + + +.. _ctypes-finding-shared-libraries: + +Finding shared libraries +^^^^^^^^^^^^^^^^^^^^^^^^ + +When programming in a compiled language, shared libraries are accessed when +compiling/linking a program, and when the program is run. + +The purpose of the :func:`find_library` function is to locate a library in a way +similar to what the compiler or runtime loader does (on platforms with several +versions of a shared library the most recent should be loaded), while the ctypes +library loaders act like when a program is run, and call the runtime loader +directly. + +The :mod:`ctypes.util` module provides a function which can help to determine +the library to load. + + +.. data:: find_library(name) + :module: ctypes.util + :noindex: + + Try to find a library and return a pathname. *name* is the library name without + any prefix like *lib*, suffix like ``.so``, ``.dylib`` or version number (this + is the form used for the posix linker option :option:`!-l`). If no library can + be found, returns ``None``. + +The exact functionality is system dependent. + +On Linux, :func:`find_library` tries to run external programs +(``/sbin/ldconfig``, ``gcc``, ``objdump`` and ``ld``) to find the library file. +It returns the filename of the library file. + +.. versionchanged:: 3.6 + On Linux, the value of the environment variable ``LD_LIBRARY_PATH`` is used + when searching for libraries, if a library cannot be found by any other means. + +Here are some examples:: + + >>> from ctypes.util import find_library + >>> find_library("m") + 'libm.so.6' + >>> find_library("c") + 'libc.so.6' + >>> find_library("bz2") + 'libbz2.so.1.0' + >>> + +On OS X, :func:`find_library` tries several predefined naming schemes and paths +to locate the library, and returns a full pathname if successful:: + + >>> from ctypes.util import find_library + >>> find_library("c") + '/usr/lib/libc.dylib' + >>> find_library("m") + '/usr/lib/libm.dylib' + >>> find_library("bz2") + '/usr/lib/libbz2.dylib' + >>> find_library("AGL") + '/System/Library/Frameworks/AGL.framework/AGL' + >>> + +On Windows, :func:`find_library` searches along the system search path, and +returns the full pathname, but since there is no predefined naming scheme a call +like ``find_library("c")`` will fail and return ``None``. + +If wrapping a shared library with :mod:`ctypes`, it *may* be better to determine +the shared library name at development time, and hardcode that into the wrapper +module instead of using :func:`find_library` to locate the library at runtime. + + +.. _ctypes-loading-shared-libraries: + +Loading shared libraries +^^^^^^^^^^^^^^^^^^^^^^^^ + +There are several ways to load shared libraries into the Python process. One +way is to instantiate one of the following classes: + + +.. class:: CDLL(name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False) + + Instances of this class represent loaded shared libraries. Functions in these + libraries use the standard C calling convention, and are assumed to return + :c:type:`int`. + + +.. class:: OleDLL(name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False) + + Windows only: Instances of this class represent loaded shared libraries, + functions in these libraries use the ``stdcall`` calling convention, and are + assumed to return the windows specific :class:`HRESULT` code. :class:`HRESULT` + values contain information specifying whether the function call failed or + succeeded, together with additional error code. If the return value signals a + failure, an :class:`OSError` is automatically raised. + + .. versionchanged:: 3.3 + :exc:`WindowsError` used to be raised. + + +.. class:: WinDLL(name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False) + + Windows only: Instances of this class represent loaded shared libraries, + functions in these libraries use the ``stdcall`` calling convention, and are + assumed to return :c:type:`int` by default. + + On Windows CE only the standard calling convention is used, for convenience the + :class:`WinDLL` and :class:`OleDLL` use the standard calling convention on this + platform. + +The Python :term:`global interpreter lock` is released before calling any +function exported by these libraries, and reacquired afterwards. + + +.. class:: PyDLL(name, mode=DEFAULT_MODE, handle=None) + + Instances of this class behave like :class:`CDLL` instances, except that the + Python GIL is *not* released during the function call, and after the function + execution the Python error flag is checked. If the error flag is set, a Python + exception is raised. + + Thus, this is only useful to call Python C api functions directly. + +All these classes can be instantiated by calling them with at least one +argument, the pathname of the shared library. If you have an existing handle to +an already loaded shared library, it can be passed as the ``handle`` named +parameter, otherwise the underlying platforms ``dlopen`` or ``LoadLibrary`` +function is used to load the library into the process, and to get a handle to +it. + +The *mode* parameter can be used to specify how the library is loaded. For +details, consult the :manpage:`dlopen(3)` manpage. On Windows, *mode* is +ignored. On posix systems, RTLD_NOW is always added, and is not +configurable. + +The *use_errno* parameter, when set to true, enables a ctypes mechanism that +allows accessing the system :data:`errno` error number in a safe way. +:mod:`ctypes` maintains a thread-local copy of the systems :data:`errno` +variable; if you call foreign functions created with ``use_errno=True`` then the +:data:`errno` value before the function call is swapped with the ctypes private +copy, the same happens immediately after the function call. + +The function :func:`ctypes.get_errno` returns the value of the ctypes private +copy, and the function :func:`ctypes.set_errno` changes the ctypes private copy +to a new value and returns the former value. + +The *use_last_error* parameter, when set to true, enables the same mechanism for +the Windows error code which is managed by the :func:`GetLastError` and +:func:`SetLastError` Windows API functions; :func:`ctypes.get_last_error` and +:func:`ctypes.set_last_error` are used to request and change the ctypes private +copy of the windows error code. + +.. data:: RTLD_GLOBAL + :noindex: + + Flag to use as *mode* parameter. On platforms where this flag is not available, + it is defined as the integer zero. + + +.. data:: RTLD_LOCAL + :noindex: + + Flag to use as *mode* parameter. On platforms where this is not available, it + is the same as *RTLD_GLOBAL*. + + +.. data:: DEFAULT_MODE + :noindex: + + The default mode which is used to load shared libraries. On OSX 10.3, this is + *RTLD_GLOBAL*, otherwise it is the same as *RTLD_LOCAL*. + +Instances of these classes have no public methods. Functions exported by the +shared library can be accessed as attributes or by index. Please note that +accessing the function through an attribute caches the result and therefore +accessing it repeatedly returns the same object each time. On the other hand, +accessing it through an index returns a new object each time:: + + >>> from ctypes import CDLL + >>> libc = CDLL("libc.so.6") # On Linux + >>> libc.time == libc.time + True + >>> libc['time'] == libc['time'] + False + +The following public attributes are available, their name starts with an +underscore to not clash with exported function names: + + +.. attribute:: PyDLL._handle + + The system handle used to access the library. + + +.. attribute:: PyDLL._name + + The name of the library passed in the constructor. + +Shared libraries can also be loaded by using one of the prefabricated objects, +which are instances of the :class:`LibraryLoader` class, either by calling the +:meth:`LoadLibrary` method, or by retrieving the library as attribute of the +loader instance. + + +.. class:: LibraryLoader(dlltype) + + Class which loads shared libraries. *dlltype* should be one of the + :class:`CDLL`, :class:`PyDLL`, :class:`WinDLL`, or :class:`OleDLL` types. + + :meth:`__getattr__` has special behavior: It allows loading a shared library by + accessing it as attribute of a library loader instance. The result is cached, + so repeated attribute accesses return the same library each time. + + .. method:: LoadLibrary(name) + + Load a shared library into the process and return it. This method always + returns a new instance of the library. + + +These prefabricated library loaders are available: + +.. data:: cdll + :noindex: + + Creates :class:`CDLL` instances. + + +.. data:: windll + :noindex: + + Windows only: Creates :class:`WinDLL` instances. + + +.. data:: oledll + :noindex: + + Windows only: Creates :class:`OleDLL` instances. + + +.. data:: pydll + :noindex: + + Creates :class:`PyDLL` instances. + + +For accessing the C Python api directly, a ready-to-use Python shared library +object is available: + +.. data:: pythonapi + :noindex: + + An instance of :class:`PyDLL` that exposes Python C API functions as + attributes. Note that all these functions are assumed to return C + :c:type:`int`, which is of course not always the truth, so you have to assign + the correct :attr:`restype` attribute to use these functions. + + +.. _ctypes-foreign-functions: + +Foreign functions +^^^^^^^^^^^^^^^^^ + +As explained in the previous section, foreign functions can be accessed as +attributes of loaded shared libraries. The function objects created in this way +by default accept any number of arguments, accept any ctypes data instances as +arguments, and return the default result type specified by the library loader. +They are instances of a private class: + + +.. class:: _FuncPtr + + Base class for C callable foreign functions. + + Instances of foreign functions are also C compatible data types; they + represent C function pointers. + + This behavior can be customized by assigning to special attributes of the + foreign function object. + + .. attribute:: restype + + Assign a ctypes type to specify the result type of the foreign function. + Use ``None`` for :c:type:`void`, a function not returning anything. + + It is possible to assign a callable Python object that is not a ctypes + type, in this case the function is assumed to return a C :c:type:`int`, and + the callable will be called with this integer, allowing further + processing or error checking. Using this is deprecated, for more flexible + post processing or error checking use a ctypes data type as + :attr:`restype` and assign a callable to the :attr:`errcheck` attribute. + + .. attribute:: argtypes + + Assign a tuple of ctypes types to specify the argument types that the + function accepts. Functions using the ``stdcall`` calling convention can + only be called with the same number of arguments as the length of this + tuple; functions using the C calling convention accept additional, + unspecified arguments as well. + + When a foreign function is called, each actual argument is passed to the + :meth:`from_param` class method of the items in the :attr:`argtypes` + tuple, this method allows adapting the actual argument to an object that + the foreign function accepts. For example, a :class:`c_char_p` item in + the :attr:`argtypes` tuple will convert a string passed as argument into + a bytes object using ctypes conversion rules. + + New: It is now possible to put items in argtypes which are not ctypes + types, but each item must have a :meth:`from_param` method which returns a + value usable as argument (integer, string, ctypes instance). This allows + defining adapters that can adapt custom objects as function parameters. + + .. attribute:: errcheck + + Assign a Python function or another callable to this attribute. The + callable will be called with three or more arguments: + + .. function:: callable(result, func, arguments) + :noindex: + :module: + + *result* is what the foreign function returns, as specified by the + :attr:`restype` attribute. + + *func* is the foreign function object itself, this allows reusing the + same callable object to check or post process the results of several + functions. + + *arguments* is a tuple containing the parameters originally passed to + the function call, this allows specializing the behavior on the + arguments used. + + The object that this function returns will be returned from the + foreign function call, but it can also check the result value + and raise an exception if the foreign function call failed. + + +.. exception:: ArgumentError + + This exception is raised when a foreign function call cannot convert one of the + passed arguments. + + +.. _ctypes-function-prototypes: + +Function prototypes +^^^^^^^^^^^^^^^^^^^ + +Foreign functions can also be created by instantiating function prototypes. +Function prototypes are similar to function prototypes in C; they describe a +function (return type, argument types, calling convention) without defining an +implementation. The factory functions must be called with the desired result +type and the argument types of the function, and can be used as decorator +factories, and as such, be applied to functions through the ``@wrapper`` syntax. +See :ref:`ctypes-callback-functions` for examples. + + +.. function:: CFUNCTYPE(restype, *argtypes, use_errno=False, use_last_error=False) + + The returned function prototype creates functions that use the standard C + calling convention. The function will release the GIL during the call. If + *use_errno* is set to true, the ctypes private copy of the system + :data:`errno` variable is exchanged with the real :data:`errno` value before + and after the call; *use_last_error* does the same for the Windows error + code. + + +.. function:: WINFUNCTYPE(restype, *argtypes, use_errno=False, use_last_error=False) + + Windows only: The returned function prototype creates functions that use the + ``stdcall`` calling convention, except on Windows CE where + :func:`WINFUNCTYPE` is the same as :func:`CFUNCTYPE`. The function will + release the GIL during the call. *use_errno* and *use_last_error* have the + same meaning as above. + + +.. function:: PYFUNCTYPE(restype, *argtypes) + + The returned function prototype creates functions that use the Python calling + convention. The function will *not* release the GIL during the call. + +Function prototypes created by these factory functions can be instantiated in +different ways, depending on the type and number of the parameters in the call: + + + .. function:: prototype(address) + :noindex: + :module: + + Returns a foreign function at the specified address which must be an integer. + + + .. function:: prototype(callable) + :noindex: + :module: + + Create a C callable function (a callback function) from a Python *callable*. + + + .. function:: prototype(func_spec[, paramflags]) + :noindex: + :module: + + Returns a foreign function exported by a shared library. *func_spec* must + be a 2-tuple ``(name_or_ordinal, library)``. The first item is the name of + the exported function as string, or the ordinal of the exported function + as small integer. The second item is the shared library instance. + + + .. function:: prototype(vtbl_index, name[, paramflags[, iid]]) + :noindex: + :module: + + Returns a foreign function that will call a COM method. *vtbl_index* is + the index into the virtual function table, a small non-negative + integer. *name* is name of the COM method. *iid* is an optional pointer to + the interface identifier which is used in extended error reporting. + + COM methods use a special calling convention: They require a pointer to + the COM interface as first argument, in addition to those parameters that + are specified in the :attr:`argtypes` tuple. + + The optional *paramflags* parameter creates foreign function wrappers with much + more functionality than the features described above. + + *paramflags* must be a tuple of the same length as :attr:`argtypes`. + + Each item in this tuple contains further information about a parameter, it must + be a tuple containing one, two, or three items. + + The first item is an integer containing a combination of direction + flags for the parameter: + + 1 + Specifies an input parameter to the function. + + 2 + Output parameter. The foreign function fills in a value. + + 4 + Input parameter which defaults to the integer zero. + + The optional second item is the parameter name as string. If this is specified, + the foreign function can be called with named parameters. + + The optional third item is the default value for this parameter. + +This example demonstrates how to wrap the Windows ``MessageBoxW`` function so +that it supports default parameters and named arguments. The C declaration from +the windows header file is this:: + + WINUSERAPI int WINAPI + MessageBoxW( + HWND hWnd, + LPCWSTR lpText, + LPCWSTR lpCaption, + UINT uType); + +Here is the wrapping with :mod:`ctypes`:: + + >>> from ctypes import c_int, WINFUNCTYPE, windll + >>> from ctypes.wintypes import HWND, LPCWSTR, UINT + >>> prototype = WINFUNCTYPE(c_int, HWND, LPCWSTR, LPCWSTR, UINT) + >>> paramflags = (1, "hwnd", 0), (1, "text", "Hi"), (1, "caption", "Hello from ctypes"), (1, "flags", 0) + >>> MessageBox = prototype(("MessageBoxW", windll.user32), paramflags) + +The ``MessageBox`` foreign function can now be called in these ways:: + + >>> MessageBox() + >>> MessageBox(text="Spam, spam, spam") + >>> MessageBox(flags=2, text="foo bar") + +A second example demonstrates output parameters. The win32 ``GetWindowRect`` +function retrieves the dimensions of a specified window by copying them into +``RECT`` structure that the caller has to supply. Here is the C declaration:: + + WINUSERAPI BOOL WINAPI + GetWindowRect( + HWND hWnd, + LPRECT lpRect); + +Here is the wrapping with :mod:`ctypes`:: + + >>> from ctypes import POINTER, WINFUNCTYPE, windll, WinError + >>> from ctypes.wintypes import BOOL, HWND, RECT + >>> prototype = WINFUNCTYPE(BOOL, HWND, POINTER(RECT)) + >>> paramflags = (1, "hwnd"), (2, "lprect") + >>> GetWindowRect = prototype(("GetWindowRect", windll.user32), paramflags) + >>> + +Functions with output parameters will automatically return the output parameter +value if there is a single one, or a tuple containing the output parameter +values when there are more than one, so the GetWindowRect function now returns a +RECT instance, when called. + +Output parameters can be combined with the :attr:`errcheck` protocol to do +further output processing and error checking. The win32 ``GetWindowRect`` api +function returns a ``BOOL`` to signal success or failure, so this function could +do the error checking, and raises an exception when the api call failed:: + + >>> def errcheck(result, func, args): + ... if not result: + ... raise WinError() + ... return args + ... + >>> GetWindowRect.errcheck = errcheck + >>> + +If the :attr:`errcheck` function returns the argument tuple it receives +unchanged, :mod:`ctypes` continues the normal processing it does on the output +parameters. If you want to return a tuple of window coordinates instead of a +``RECT`` instance, you can retrieve the fields in the function and return them +instead, the normal processing will no longer take place:: + + >>> def errcheck(result, func, args): + ... if not result: + ... raise WinError() + ... rc = args[1] + ... return rc.left, rc.top, rc.bottom, rc.right + ... + >>> GetWindowRect.errcheck = errcheck + >>> + + +.. _ctypes-utility-functions: + +Utility functions +^^^^^^^^^^^^^^^^^ + +.. function:: addressof(obj) + + Returns the address of the memory buffer as integer. *obj* must be an + instance of a ctypes type. + + +.. function:: alignment(obj_or_type) + + Returns the alignment requirements of a ctypes type. *obj_or_type* must be a + ctypes type or instance. + + +.. function:: byref(obj[, offset]) + + Returns a light-weight pointer to *obj*, which must be an instance of a + ctypes type. *offset* defaults to zero, and must be an integer that will be + added to the internal pointer value. + + ``byref(obj, offset)`` corresponds to this C code:: + + (((char *)&obj) + offset) + + The returned object can only be used as a foreign function call parameter. + It behaves similar to ``pointer(obj)``, but the construction is a lot faster. + + +.. function:: cast(obj, type) + + This function is similar to the cast operator in C. It returns a new instance + of *type* which points to the same memory block as *obj*. *type* must be a + pointer type, and *obj* must be an object that can be interpreted as a + pointer. + + +.. function:: create_string_buffer(init_or_size, size=None) + + This function creates a mutable character buffer. The returned object is a + ctypes array of :class:`c_char`. + + *init_or_size* must be an integer which specifies the size of the array, or a + bytes object which will be used to initialize the array items. + + If a bytes object is specified as first argument, the buffer is made one item + larger than its length so that the last element in the array is a NUL + termination character. An integer can be passed as second argument which allows + specifying the size of the array if the length of the bytes should not be used. + + + +.. function:: create_unicode_buffer(init_or_size, size=None) + + This function creates a mutable unicode character buffer. The returned object is + a ctypes array of :class:`c_wchar`. + + *init_or_size* must be an integer which specifies the size of the array, or a + string which will be used to initialize the array items. + + If a string is specified as first argument, the buffer is made one item + larger than the length of the string so that the last element in the array is a + NUL termination character. An integer can be passed as second argument which + allows specifying the size of the array if the length of the string should not + be used. + + + +.. function:: DllCanUnloadNow() + + Windows only: This function is a hook which allows implementing in-process + COM servers with ctypes. It is called from the DllCanUnloadNow function that + the _ctypes extension dll exports. + + +.. function:: DllGetClassObject() + + Windows only: This function is a hook which allows implementing in-process + COM servers with ctypes. It is called from the DllGetClassObject function + that the ``_ctypes`` extension dll exports. + + +.. function:: find_library(name) + :module: ctypes.util + + Try to find a library and return a pathname. *name* is the library name + without any prefix like ``lib``, suffix like ``.so``, ``.dylib`` or version + number (this is the form used for the posix linker option :option:`!-l`). If + no library can be found, returns ``None``. + + The exact functionality is system dependent. + + +.. function:: find_msvcrt() + :module: ctypes.util + + Windows only: return the filename of the VC runtime library used by Python, + and by the extension modules. If the name of the library cannot be + determined, ``None`` is returned. + + If you need to free memory, for example, allocated by an extension module + with a call to the ``free(void *)``, it is important that you use the + function in the same library that allocated the memory. + + +.. function:: FormatError([code]) + + Windows only: Returns a textual description of the error code *code*. If no + error code is specified, the last error code is used by calling the Windows + api function GetLastError. + + +.. function:: GetLastError() + + Windows only: Returns the last error code set by Windows in the calling thread. + This function calls the Windows `GetLastError()` function directly, + it does not return the ctypes-private copy of the error code. + +.. function:: get_errno() + + Returns the current value of the ctypes-private copy of the system + :data:`errno` variable in the calling thread. + +.. function:: get_last_error() + + Windows only: returns the current value of the ctypes-private copy of the system + :data:`LastError` variable in the calling thread. + +.. function:: memmove(dst, src, count) + + Same as the standard C memmove library function: copies *count* bytes from + *src* to *dst*. *dst* and *src* must be integers or ctypes instances that can + be converted to pointers. + + +.. function:: memset(dst, c, count) + + Same as the standard C memset library function: fills the memory block at + address *dst* with *count* bytes of value *c*. *dst* must be an integer + specifying an address, or a ctypes instance. + + +.. function:: POINTER(type) + + This factory function creates and returns a new ctypes pointer type. Pointer + types are cached and reused internally, so calling this function repeatedly is + cheap. *type* must be a ctypes type. + + +.. function:: pointer(obj) + + This function creates a new pointer instance, pointing to *obj*. The returned + object is of the type ``POINTER(type(obj))``. + + Note: If you just want to pass a pointer to an object to a foreign function + call, you should use ``byref(obj)`` which is much faster. + + +.. function:: resize(obj, size) + + This function resizes the internal memory buffer of *obj*, which must be an + instance of a ctypes type. It is not possible to make the buffer smaller + than the native size of the objects type, as given by ``sizeof(type(obj))``, + but it is possible to enlarge the buffer. + + +.. function:: set_errno(value) + + Set the current value of the ctypes-private copy of the system :data:`errno` + variable in the calling thread to *value* and return the previous value. + + + +.. function:: set_last_error(value) + + Windows only: set the current value of the ctypes-private copy of the system + :data:`LastError` variable in the calling thread to *value* and return the + previous value. + + + +.. function:: sizeof(obj_or_type) + + Returns the size in bytes of a ctypes type or instance memory buffer. + Does the same as the C ``sizeof`` operator. + + +.. function:: string_at(address, size=-1) + + This function returns the C string starting at memory address *address* as a bytes + object. If size is specified, it is used as size, otherwise the string is assumed + to be zero-terminated. + + +.. function:: WinError(code=None, descr=None) + + Windows only: this function is probably the worst-named thing in ctypes. It + creates an instance of OSError. If *code* is not specified, + ``GetLastError`` is called to determine the error code. If *descr* is not + specified, :func:`FormatError` is called to get a textual description of the + error. + + .. versionchanged:: 3.3 + An instance of :exc:`WindowsError` used to be created. + + +.. function:: wstring_at(address, size=-1) + + This function returns the wide character string starting at memory address + *address* as a string. If *size* is specified, it is used as the number of + characters of the string, otherwise the string is assumed to be + zero-terminated. + + +.. _ctypes-data-types: + +Data types +^^^^^^^^^^ + + +.. class:: _CData + + This non-public class is the common base class of all ctypes data types. + Among other things, all ctypes type instances contain a memory block that + hold C compatible data; the address of the memory block is returned by the + :func:`addressof` helper function. Another instance variable is exposed as + :attr:`_objects`; this contains other Python objects that need to be kept + alive in case the memory block contains pointers. + + Common methods of ctypes data types, these are all class methods (to be + exact, they are methods of the :term:`metaclass`): + + .. method:: _CData.from_buffer(source[, offset]) + + This method returns a ctypes instance that shares the buffer of the + *source* object. The *source* object must support the writeable buffer + interface. The optional *offset* parameter specifies an offset into the + source buffer in bytes; the default is zero. If the source buffer is not + large enough a :exc:`ValueError` is raised. + + + .. method:: _CData.from_buffer_copy(source[, offset]) + + This method creates a ctypes instance, copying the buffer from the + *source* object buffer which must be readable. The optional *offset* + parameter specifies an offset into the source buffer in bytes; the default + is zero. If the source buffer is not large enough a :exc:`ValueError` is + raised. + + .. method:: from_address(address) + + This method returns a ctypes type instance using the memory specified by + *address* which must be an integer. + + .. method:: from_param(obj) + + This method adapts *obj* to a ctypes type. It is called with the actual + object used in a foreign function call when the type is present in the + foreign function's :attr:`argtypes` tuple; it must return an object that + can be used as a function call parameter. + + All ctypes data types have a default implementation of this classmethod + that normally returns *obj* if that is an instance of the type. Some + types accept other objects as well. + + .. method:: in_dll(library, name) + + This method returns a ctypes type instance exported by a shared + library. *name* is the name of the symbol that exports the data, *library* + is the loaded shared library. + + Common instance variables of ctypes data types: + + .. attribute:: _b_base_ + + Sometimes ctypes data instances do not own the memory block they contain, + instead they share part of the memory block of a base object. The + :attr:`_b_base_` read-only member is the root ctypes object that owns the + memory block. + + .. attribute:: _b_needsfree_ + + This read-only variable is true when the ctypes data instance has + allocated the memory block itself, false otherwise. + + .. attribute:: _objects + + This member is either ``None`` or a dictionary containing Python objects + that need to be kept alive so that the memory block contents is kept + valid. This object is only exposed for debugging; never modify the + contents of this dictionary. + + +.. _ctypes-fundamental-data-types-2: + +Fundamental data types +^^^^^^^^^^^^^^^^^^^^^^ + +.. class:: _SimpleCData + + This non-public class is the base class of all fundamental ctypes data + types. It is mentioned here because it contains the common attributes of the + fundamental ctypes data types. :class:`_SimpleCData` is a subclass of + :class:`_CData`, so it inherits their methods and attributes. ctypes data + types that are not and do not contain pointers can now be pickled. + + Instances have a single attribute: + + .. attribute:: value + + This attribute contains the actual value of the instance. For integer and + pointer types, it is an integer, for character types, it is a single + character bytes object or string, for character pointer types it is a + Python bytes object or string. + + When the ``value`` attribute is retrieved from a ctypes instance, usually + a new object is returned each time. :mod:`ctypes` does *not* implement + original object return, always a new object is constructed. The same is + true for all other ctypes object instances. + + +Fundamental data types, when returned as foreign function call results, or, for +example, by retrieving structure field members or array items, are transparently +converted to native Python types. In other words, if a foreign function has a +:attr:`restype` of :class:`c_char_p`, you will always receive a Python bytes +object, *not* a :class:`c_char_p` instance. + +.. XXX above is false, it actually returns a Unicode string + +Subclasses of fundamental data types do *not* inherit this behavior. So, if a +foreign functions :attr:`restype` is a subclass of :class:`c_void_p`, you will +receive an instance of this subclass from the function call. Of course, you can +get the value of the pointer by accessing the ``value`` attribute. + +These are the fundamental ctypes data types: + +.. class:: c_byte + + Represents the C :c:type:`signed char` datatype, and interprets the value as + small integer. The constructor accepts an optional integer initializer; no + overflow checking is done. + + +.. class:: c_char + + Represents the C :c:type:`char` datatype, and interprets the value as a single + character. The constructor accepts an optional string initializer, the + length of the string must be exactly one character. + + +.. class:: c_char_p + + Represents the C :c:type:`char *` datatype when it points to a zero-terminated + string. For a general character pointer that may also point to binary data, + ``POINTER(c_char)`` must be used. The constructor accepts an integer + address, or a bytes object. + + +.. class:: c_double + + Represents the C :c:type:`double` datatype. The constructor accepts an + optional float initializer. + + +.. class:: c_longdouble + + Represents the C :c:type:`long double` datatype. The constructor accepts an + optional float initializer. On platforms where ``sizeof(long double) == + sizeof(double)`` it is an alias to :class:`c_double`. + +.. class:: c_float + + Represents the C :c:type:`float` datatype. The constructor accepts an + optional float initializer. + + +.. class:: c_int + + Represents the C :c:type:`signed int` datatype. The constructor accepts an + optional integer initializer; no overflow checking is done. On platforms + where ``sizeof(int) == sizeof(long)`` it is an alias to :class:`c_long`. + + +.. class:: c_int8 + + Represents the C 8-bit :c:type:`signed int` datatype. Usually an alias for + :class:`c_byte`. + + +.. class:: c_int16 + + Represents the C 16-bit :c:type:`signed int` datatype. Usually an alias for + :class:`c_short`. + + +.. class:: c_int32 + + Represents the C 32-bit :c:type:`signed int` datatype. Usually an alias for + :class:`c_int`. + + +.. class:: c_int64 + + Represents the C 64-bit :c:type:`signed int` datatype. Usually an alias for + :class:`c_longlong`. + + +.. class:: c_long + + Represents the C :c:type:`signed long` datatype. The constructor accepts an + optional integer initializer; no overflow checking is done. + + +.. class:: c_longlong + + Represents the C :c:type:`signed long long` datatype. The constructor accepts + an optional integer initializer; no overflow checking is done. + + +.. class:: c_short + + Represents the C :c:type:`signed short` datatype. The constructor accepts an + optional integer initializer; no overflow checking is done. + + +.. class:: c_size_t + + Represents the C :c:type:`size_t` datatype. + + +.. class:: c_ssize_t + + Represents the C :c:type:`ssize_t` datatype. + + .. versionadded:: 3.2 + + +.. class:: c_ubyte + + Represents the C :c:type:`unsigned char` datatype, it interprets the value as + small integer. The constructor accepts an optional integer initializer; no + overflow checking is done. + + +.. class:: c_uint + + Represents the C :c:type:`unsigned int` datatype. The constructor accepts an + optional integer initializer; no overflow checking is done. On platforms + where ``sizeof(int) == sizeof(long)`` it is an alias for :class:`c_ulong`. + + +.. class:: c_uint8 + + Represents the C 8-bit :c:type:`unsigned int` datatype. Usually an alias for + :class:`c_ubyte`. + + +.. class:: c_uint16 + + Represents the C 16-bit :c:type:`unsigned int` datatype. Usually an alias for + :class:`c_ushort`. + + +.. class:: c_uint32 + + Represents the C 32-bit :c:type:`unsigned int` datatype. Usually an alias for + :class:`c_uint`. + + +.. class:: c_uint64 + + Represents the C 64-bit :c:type:`unsigned int` datatype. Usually an alias for + :class:`c_ulonglong`. + + +.. class:: c_ulong + + Represents the C :c:type:`unsigned long` datatype. The constructor accepts an + optional integer initializer; no overflow checking is done. + + +.. class:: c_ulonglong + + Represents the C :c:type:`unsigned long long` datatype. The constructor + accepts an optional integer initializer; no overflow checking is done. + + +.. class:: c_ushort + + Represents the C :c:type:`unsigned short` datatype. The constructor accepts + an optional integer initializer; no overflow checking is done. + + +.. class:: c_void_p + + Represents the C :c:type:`void *` type. The value is represented as integer. + The constructor accepts an optional integer initializer. + + +.. class:: c_wchar + + Represents the C :c:type:`wchar_t` datatype, and interprets the value as a + single character unicode string. The constructor accepts an optional string + initializer, the length of the string must be exactly one character. + + +.. class:: c_wchar_p + + Represents the C :c:type:`wchar_t *` datatype, which must be a pointer to a + zero-terminated wide character string. The constructor accepts an integer + address, or a string. + + +.. class:: c_bool + + Represent the C :c:type:`bool` datatype (more accurately, :c:type:`_Bool` from + C99). Its value can be ``True`` or ``False``, and the constructor accepts any object + that has a truth value. + + +.. class:: HRESULT + + Windows only: Represents a :c:type:`HRESULT` value, which contains success or + error information for a function or method call. + + +.. class:: py_object + + Represents the C :c:type:`PyObject *` datatype. Calling this without an + argument creates a ``NULL`` :c:type:`PyObject *` pointer. + +The :mod:`ctypes.wintypes` module provides quite some other Windows specific +data types, for example :c:type:`HWND`, :c:type:`WPARAM`, or :c:type:`DWORD`. Some +useful structures like :c:type:`MSG` or :c:type:`RECT` are also defined. + + +.. _ctypes-structured-data-types: + +Structured data types +^^^^^^^^^^^^^^^^^^^^^ + + +.. class:: Union(*args, **kw) + + Abstract base class for unions in native byte order. + + +.. class:: BigEndianStructure(*args, **kw) + + Abstract base class for structures in *big endian* byte order. + + +.. class:: LittleEndianStructure(*args, **kw) + + Abstract base class for structures in *little endian* byte order. + +Structures with non-native byte order cannot contain pointer type fields, or any +other data types containing pointer type fields. + + +.. class:: Structure(*args, **kw) + + Abstract base class for structures in *native* byte order. + + Concrete structure and union types must be created by subclassing one of these + types, and at least define a :attr:`_fields_` class variable. :mod:`ctypes` will + create :term:`descriptor`\s which allow reading and writing the fields by direct + attribute accesses. These are the + + + .. attribute:: _fields_ + + A sequence defining the structure fields. The items must be 2-tuples or + 3-tuples. The first item is the name of the field, the second item + specifies the type of the field; it can be any ctypes data type. + + For integer type fields like :class:`c_int`, a third optional item can be + given. It must be a small positive integer defining the bit width of the + field. + + Field names must be unique within one structure or union. This is not + checked, only one field can be accessed when names are repeated. + + It is possible to define the :attr:`_fields_` class variable *after* the + class statement that defines the Structure subclass, this allows creating + data types that directly or indirectly reference themselves:: + + class List(Structure): + pass + List._fields_ = [("pnext", POINTER(List)), + ... + ] + + The :attr:`_fields_` class variable must, however, be defined before the + type is first used (an instance is created, :func:`sizeof` is called on it, + and so on). Later assignments to the :attr:`_fields_` class variable will + raise an AttributeError. + + It is possible to define sub-subclasses of structure types, they inherit + the fields of the base class plus the :attr:`_fields_` defined in the + sub-subclass, if any. + + + .. attribute:: _pack_ + + An optional small integer that allows overriding the alignment of + structure fields in the instance. :attr:`_pack_` must already be defined + when :attr:`_fields_` is assigned, otherwise it will have no effect. + + + .. attribute:: _anonymous_ + + An optional sequence that lists the names of unnamed (anonymous) fields. + :attr:`_anonymous_` must be already defined when :attr:`_fields_` is + assigned, otherwise it will have no effect. + + The fields listed in this variable must be structure or union type fields. + :mod:`ctypes` will create descriptors in the structure type that allows + accessing the nested fields directly, without the need to create the + structure or union field. + + Here is an example type (Windows):: + + class _U(Union): + _fields_ = [("lptdesc", POINTER(TYPEDESC)), + ("lpadesc", POINTER(ARRAYDESC)), + ("hreftype", HREFTYPE)] + + class TYPEDESC(Structure): + _anonymous_ = ("u",) + _fields_ = [("u", _U), + ("vt", VARTYPE)] + + + The ``TYPEDESC`` structure describes a COM data type, the ``vt`` field + specifies which one of the union fields is valid. Since the ``u`` field + is defined as anonymous field, it is now possible to access the members + directly off the TYPEDESC instance. ``td.lptdesc`` and ``td.u.lptdesc`` + are equivalent, but the former is faster since it does not need to create + a temporary union instance:: + + td = TYPEDESC() + td.vt = VT_PTR + td.lptdesc = POINTER(some_type) + td.u.lptdesc = POINTER(some_type) + + It is possible to define sub-subclasses of structures, they inherit the + fields of the base class. If the subclass definition has a separate + :attr:`_fields_` variable, the fields specified in this are appended to the + fields of the base class. + + Structure and union constructors accept both positional and keyword + arguments. Positional arguments are used to initialize member fields in the + same order as they are appear in :attr:`_fields_`. Keyword arguments in the + constructor are interpreted as attribute assignments, so they will initialize + :attr:`_fields_` with the same name, or create new attributes for names not + present in :attr:`_fields_`. + + +.. _ctypes-arrays-pointers: + +Arrays and pointers +^^^^^^^^^^^^^^^^^^^ + +.. class:: Array(\*args) + + Abstract base class for arrays. + + The recommended way to create concrete array types is by multiplying any + :mod:`ctypes` data type with a positive integer. Alternatively, you can subclass + this type and define :attr:`_length_` and :attr:`_type_` class variables. + Array elements can be read and written using standard + subscript and slice accesses; for slice reads, the resulting object is + *not* itself an :class:`Array`. + + + .. attribute:: _length_ + + A positive integer specifying the number of elements in the array. + Out-of-range subscripts result in an :exc:`IndexError`. Will be + returned by :func:`len`. + + + .. attribute:: _type_ + + Specifies the type of each element in the array. + + + Array subclass constructors accept positional arguments, used to + initialize the elements in order. + + +.. class:: _Pointer + + Private, abstract base class for pointers. + + Concrete pointer types are created by calling :func:`POINTER` with the + type that will be pointed to; this is done automatically by + :func:`pointer`. + + If a pointer points to an array, its elements can be read and + written using standard subscript and slice accesses. Pointer objects + have no size, so :func:`len` will raise :exc:`TypeError`. Negative + subscripts will read from the memory *before* the pointer (as in C), and + out-of-range subscripts will probably crash with an access violation (if + you're lucky). + + + .. attribute:: _type_ + + Specifies the type pointed to. + + .. attribute:: contents + + Returns the object to which to pointer points. Assigning to this + attribute changes the pointer to point to the assigned object. + diff --git a/python-3.7.4-docs-html/_sources/library/curses.ascii.rst.txt b/python-3.7.4-docs-html/_sources/library/curses.ascii.rst.txt new file mode 100644 index 0000000..a69dbb2 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/curses.ascii.rst.txt @@ -0,0 +1,229 @@ +:mod:`curses.ascii` --- Utilities for ASCII characters +====================================================== + +.. module:: curses.ascii + :synopsis: Constants and set-membership functions for ASCII characters. + +.. moduleauthor:: Eric S. Raymond +.. sectionauthor:: Eric S. Raymond + +-------------- + +The :mod:`curses.ascii` module supplies name constants for ASCII characters and +functions to test membership in various ASCII character classes. The constants +supplied are names for control characters as follows: + ++--------------+----------------------------------------------+ +| Name | Meaning | ++==============+==============================================+ +| :const:`NUL` | | ++--------------+----------------------------------------------+ +| :const:`SOH` | Start of heading, console interrupt | ++--------------+----------------------------------------------+ +| :const:`STX` | Start of text | ++--------------+----------------------------------------------+ +| :const:`ETX` | End of text | ++--------------+----------------------------------------------+ +| :const:`EOT` | End of transmission | ++--------------+----------------------------------------------+ +| :const:`ENQ` | Enquiry, goes with :const:`ACK` flow control | ++--------------+----------------------------------------------+ +| :const:`ACK` | Acknowledgement | ++--------------+----------------------------------------------+ +| :const:`BEL` | Bell | ++--------------+----------------------------------------------+ +| :const:`BS` | Backspace | ++--------------+----------------------------------------------+ +| :const:`TAB` | Tab | ++--------------+----------------------------------------------+ +| :const:`HT` | Alias for :const:`TAB`: "Horizontal tab" | ++--------------+----------------------------------------------+ +| :const:`LF` | Line feed | ++--------------+----------------------------------------------+ +| :const:`NL` | Alias for :const:`LF`: "New line" | ++--------------+----------------------------------------------+ +| :const:`VT` | Vertical tab | ++--------------+----------------------------------------------+ +| :const:`FF` | Form feed | ++--------------+----------------------------------------------+ +| :const:`CR` | Carriage return | ++--------------+----------------------------------------------+ +| :const:`SO` | Shift-out, begin alternate character set | ++--------------+----------------------------------------------+ +| :const:`SI` | Shift-in, resume default character set | ++--------------+----------------------------------------------+ +| :const:`DLE` | Data-link escape | ++--------------+----------------------------------------------+ +| :const:`DC1` | XON, for flow control | ++--------------+----------------------------------------------+ +| :const:`DC2` | Device control 2, block-mode flow control | ++--------------+----------------------------------------------+ +| :const:`DC3` | XOFF, for flow control | ++--------------+----------------------------------------------+ +| :const:`DC4` | Device control 4 | ++--------------+----------------------------------------------+ +| :const:`NAK` | Negative acknowledgement | ++--------------+----------------------------------------------+ +| :const:`SYN` | Synchronous idle | ++--------------+----------------------------------------------+ +| :const:`ETB` | End transmission block | ++--------------+----------------------------------------------+ +| :const:`CAN` | Cancel | ++--------------+----------------------------------------------+ +| :const:`EM` | End of medium | ++--------------+----------------------------------------------+ +| :const:`SUB` | Substitute | ++--------------+----------------------------------------------+ +| :const:`ESC` | Escape | ++--------------+----------------------------------------------+ +| :const:`FS` | File separator | ++--------------+----------------------------------------------+ +| :const:`GS` | Group separator | ++--------------+----------------------------------------------+ +| :const:`RS` | Record separator, block-mode terminator | ++--------------+----------------------------------------------+ +| :const:`US` | Unit separator | ++--------------+----------------------------------------------+ +| :const:`SP` | Space | ++--------------+----------------------------------------------+ +| :const:`DEL` | Delete | ++--------------+----------------------------------------------+ + +Note that many of these have little practical significance in modern usage. The +mnemonics derive from teleprinter conventions that predate digital computers. + +The module supplies the following functions, patterned on those in the standard +C library: + + +.. function:: isalnum(c) + + Checks for an ASCII alphanumeric character; it is equivalent to ``isalpha(c) or + isdigit(c)``. + + +.. function:: isalpha(c) + + Checks for an ASCII alphabetic character; it is equivalent to ``isupper(c) or + islower(c)``. + + +.. function:: isascii(c) + + Checks for a character value that fits in the 7-bit ASCII set. + + +.. function:: isblank(c) + + Checks for an ASCII whitespace character; space or horizontal tab. + + +.. function:: iscntrl(c) + + Checks for an ASCII control character (in the range 0x00 to 0x1f or 0x7f). + + +.. function:: isdigit(c) + + Checks for an ASCII decimal digit, ``'0'`` through ``'9'``. This is equivalent + to ``c in string.digits``. + + +.. function:: isgraph(c) + + Checks for ASCII any printable character except space. + + +.. function:: islower(c) + + Checks for an ASCII lower-case character. + + +.. function:: isprint(c) + + Checks for any ASCII printable character including space. + + +.. function:: ispunct(c) + + Checks for any printable ASCII character which is not a space or an alphanumeric + character. + + +.. function:: isspace(c) + + Checks for ASCII white-space characters; space, line feed, carriage return, form + feed, horizontal tab, vertical tab. + + +.. function:: isupper(c) + + Checks for an ASCII uppercase letter. + + +.. function:: isxdigit(c) + + Checks for an ASCII hexadecimal digit. This is equivalent to ``c in + string.hexdigits``. + + +.. function:: isctrl(c) + + Checks for an ASCII control character (ordinal values 0 to 31). + + +.. function:: ismeta(c) + + Checks for a non-ASCII character (ordinal values 0x80 and above). + +These functions accept either integers or single-character strings; when the argument is a +string, it is first converted using the built-in function :func:`ord`. + +Note that all these functions check ordinal bit values derived from the +character of the string you pass in; they do not actually know anything about +the host machine's character encoding. + +The following two functions take either a single-character string or integer +byte value; they return a value of the same type. + + +.. function:: ascii(c) + + Return the ASCII value corresponding to the low 7 bits of *c*. + + +.. function:: ctrl(c) + + Return the control character corresponding to the given character (the character + bit value is bitwise-anded with 0x1f). + + +.. function:: alt(c) + + Return the 8-bit character corresponding to the given ASCII character (the + character bit value is bitwise-ored with 0x80). + +The following function takes either a single-character string or integer value; +it returns a string. + + +.. index:: + single: ^ (caret); in curses module + single: ! (exclamation); in curses module + +.. function:: unctrl(c) + + Return a string representation of the ASCII character *c*. If *c* is printable, + this string is the character itself. If the character is a control character + (0x00--0x1f) the string consists of a caret (``'^'``) followed by the + corresponding uppercase letter. If the character is an ASCII delete (0x7f) the + string is ``'^?'``. If the character has its meta bit (0x80) set, the meta bit + is stripped, the preceding rules applied, and ``'!'`` prepended to the result. + + +.. data:: controlnames + + A 33-element string array that contains the ASCII mnemonics for the thirty-two + ASCII control characters from 0 (NUL) to 0x1f (US), in order, plus the mnemonic + ``SP`` for the space character. + diff --git a/python-3.7.4-docs-html/_sources/library/curses.panel.rst.txt b/python-3.7.4-docs-html/_sources/library/curses.panel.rst.txt new file mode 100644 index 0000000..d770c03 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/curses.panel.rst.txt @@ -0,0 +1,120 @@ +:mod:`curses.panel` --- A panel stack extension for curses +========================================================== + +.. module:: curses.panel + :synopsis: A panel stack extension that adds depth to curses windows. + +.. sectionauthor:: A.M. Kuchling + +-------------- + +Panels are windows with the added feature of depth, so they can be stacked on +top of each other, and only the visible portions of each window will be +displayed. Panels can be added, moved up or down in the stack, and removed. + + +.. _cursespanel-functions: + +Functions +--------- + +The module :mod:`curses.panel` defines the following functions: + + +.. function:: bottom_panel() + + Returns the bottom panel in the panel stack. + + +.. function:: new_panel(win) + + Returns a panel object, associating it with the given window *win*. Be aware + that you need to keep the returned panel object referenced explicitly. If you + don't, the panel object is garbage collected and removed from the panel stack. + + +.. function:: top_panel() + + Returns the top panel in the panel stack. + + +.. function:: update_panels() + + Updates the virtual screen after changes in the panel stack. This does not call + :func:`curses.doupdate`, so you'll have to do this yourself. + + +.. _curses-panel-objects: + +Panel Objects +------------- + +Panel objects, as returned by :func:`new_panel` above, are windows with a +stacking order. There's always a window associated with a panel which determines +the content, while the panel methods are responsible for the window's depth in +the panel stack. + +Panel objects have the following methods: + + +.. method:: Panel.above() + + Returns the panel above the current panel. + + +.. method:: Panel.below() + + Returns the panel below the current panel. + + +.. method:: Panel.bottom() + + Push the panel to the bottom of the stack. + + +.. method:: Panel.hidden() + + Returns ``True`` if the panel is hidden (not visible), ``False`` otherwise. + + +.. method:: Panel.hide() + + Hide the panel. This does not delete the object, it just makes the window on + screen invisible. + + +.. method:: Panel.move(y, x) + + Move the panel to the screen coordinates ``(y, x)``. + + +.. method:: Panel.replace(win) + + Change the window associated with the panel to the window *win*. + + +.. method:: Panel.set_userptr(obj) + + Set the panel's user pointer to *obj*. This is used to associate an arbitrary + piece of data with the panel, and can be any Python object. + + +.. method:: Panel.show() + + Display the panel (which might have been hidden). + + +.. method:: Panel.top() + + Push panel to the top of the stack. + + +.. method:: Panel.userptr() + + Returns the user pointer for the panel. This might be any Python object. + + +.. method:: Panel.window() + + Returns the window object associated with the panel. + diff --git a/python-3.7.4-docs-html/_sources/library/curses.rst.txt b/python-3.7.4-docs-html/_sources/library/curses.rst.txt new file mode 100644 index 0000000..2a2ee2b --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/curses.rst.txt @@ -0,0 +1,1835 @@ +:mod:`curses` --- Terminal handling for character-cell displays +=============================================================== + +.. module:: curses + :synopsis: An interface to the curses library, providing portable + terminal handling. + :platform: Unix + +.. sectionauthor:: Moshe Zadka +.. sectionauthor:: Eric Raymond + +-------------- + +The :mod:`curses` module provides an interface to the curses library, the +de-facto standard for portable advanced terminal handling. + +While curses is most widely used in the Unix environment, versions are available +for Windows, DOS, and possibly other systems as well. This extension module is +designed to match the API of ncurses, an open-source curses library hosted on +Linux and the BSD variants of Unix. + +.. note:: + + Whenever the documentation mentions a *character* it can be specified + as an integer, a one-character Unicode string or a one-byte byte string. + + Whenever the documentation mentions a *character string* it can be specified + as a Unicode string or a byte string. + +.. note:: + + Since version 5.4, the ncurses library decides how to interpret non-ASCII data + using the ``nl_langinfo`` function. That means that you have to call + :func:`locale.setlocale` in the application and encode Unicode strings + using one of the system's available encodings. This example uses the + system's default encoding:: + + import locale + locale.setlocale(locale.LC_ALL, '') + code = locale.getpreferredencoding() + + Then use *code* as the encoding for :meth:`str.encode` calls. + +.. seealso:: + + Module :mod:`curses.ascii` + Utilities for working with ASCII characters, regardless of your locale settings. + + Module :mod:`curses.panel` + A panel stack extension that adds depth to curses windows. + + Module :mod:`curses.textpad` + Editable text widget for curses supporting :program:`Emacs`\ -like bindings. + + :ref:`curses-howto` + Tutorial material on using curses with Python, by Andrew Kuchling and Eric + Raymond. + + The :source:`Tools/demo/` directory in the Python source distribution contains + some example programs using the curses bindings provided by this module. + + +.. _curses-functions: + +Functions +--------- + +The module :mod:`curses` defines the following exception: + + +.. exception:: error + + Exception raised when a curses library function returns an error. + +.. note:: + + Whenever *x* or *y* arguments to a function or a method are optional, they + default to the current cursor location. Whenever *attr* is optional, it defaults + to :const:`A_NORMAL`. + +The module :mod:`curses` defines the following functions: + + +.. function:: baudrate() + + Return the output speed of the terminal in bits per second. On software + terminal emulators it will have a fixed high value. Included for historical + reasons; in former times, it was used to write output loops for time delays and + occasionally to change interfaces depending on the line speed. + + +.. function:: beep() + + Emit a short attention sound. + + +.. function:: can_change_color() + + Return ``True`` or ``False``, depending on whether the programmer can change the colors + displayed by the terminal. + + +.. function:: cbreak() + + Enter cbreak mode. In cbreak mode (sometimes called "rare" mode) normal tty + line buffering is turned off and characters are available to be read one by one. + However, unlike raw mode, special characters (interrupt, quit, suspend, and flow + control) retain their effects on the tty driver and calling program. Calling + first :func:`raw` then :func:`cbreak` leaves the terminal in cbreak mode. + + +.. function:: color_content(color_number) + + Return the intensity of the red, green, and blue (RGB) components in the color + *color_number*, which must be between ``0`` and :const:`COLORS`. Return a 3-tuple, + containing the R,G,B values for the given color, which will be between + ``0`` (no component) and ``1000`` (maximum amount of component). + + +.. function:: color_pair(color_number) + + Return the attribute value for displaying text in the specified color. This + attribute value can be combined with :const:`A_STANDOUT`, :const:`A_REVERSE`, + and the other :const:`A_\*` attributes. :func:`pair_number` is the counterpart + to this function. + + +.. function:: curs_set(visibility) + + Set the cursor state. *visibility* can be set to ``0``, ``1``, or ``2``, for invisible, + normal, or very visible. If the terminal supports the visibility requested, return the + previous cursor state; otherwise raise an exception. On many + terminals, the "visible" mode is an underline cursor and the "very visible" mode + is a block cursor. + + +.. function:: def_prog_mode() + + Save the current terminal mode as the "program" mode, the mode when the running + program is using curses. (Its counterpart is the "shell" mode, for when the + program is not in curses.) Subsequent calls to :func:`reset_prog_mode` will + restore this mode. + + +.. function:: def_shell_mode() + + Save the current terminal mode as the "shell" mode, the mode when the running + program is not using curses. (Its counterpart is the "program" mode, when the + program is using curses capabilities.) Subsequent calls to + :func:`reset_shell_mode` will restore this mode. + + +.. function:: delay_output(ms) + + Insert an *ms* millisecond pause in output. + + +.. function:: doupdate() + + Update the physical screen. The curses library keeps two data structures, one + representing the current physical screen contents and a virtual screen + representing the desired next state. The :func:`doupdate` ground updates the + physical screen to match the virtual screen. + + The virtual screen may be updated by a :meth:`~window.noutrefresh` call after write + operations such as :meth:`~window.addstr` have been performed on a window. The normal + :meth:`~window.refresh` call is simply :meth:`!noutrefresh` followed by :func:`!doupdate`; + if you have to update multiple windows, you can speed performance and perhaps + reduce screen flicker by issuing :meth:`!noutrefresh` calls on all windows, + followed by a single :func:`!doupdate`. + + +.. function:: echo() + + Enter echo mode. In echo mode, each character input is echoed to the screen as + it is entered. + + +.. function:: endwin() + + De-initialize the library, and return terminal to normal status. + + +.. function:: erasechar() + + Return the user's current erase character as a one-byte bytes object. Under Unix operating systems this + is a property of the controlling tty of the curses program, and is not set by + the curses library itself. + + +.. function:: filter() + + The :func:`.filter` routine, if used, must be called before :func:`initscr` is + called. The effect is that, during those calls, :envvar:`LINES` is set to ``1``; the + capabilities ``clear``, ``cup``, ``cud``, ``cud1``, ``cuu1``, ``cuu``, ``vpa`` are disabled; and the ``home`` + string is set to the value of ``cr``. The effect is that the cursor is confined to + the current line, and so are screen updates. This may be used for enabling + character-at-a-time line editing without touching the rest of the screen. + + +.. function:: flash() + + Flash the screen. That is, change it to reverse-video and then change it back + in a short interval. Some people prefer such as 'visible bell' to the audible + attention signal produced by :func:`beep`. + + +.. function:: flushinp() + + Flush all input buffers. This throws away any typeahead that has been typed + by the user and has not yet been processed by the program. + + +.. function:: getmouse() + + After :meth:`~window.getch` returns :const:`KEY_MOUSE` to signal a mouse event, this + method should be call to retrieve the queued mouse event, represented as a + 5-tuple ``(id, x, y, z, bstate)``. *id* is an ID value used to distinguish + multiple devices, and *x*, *y*, *z* are the event's coordinates. (*z* is + currently unused.) *bstate* is an integer value whose bits will be set to + indicate the type of event, and will be the bitwise OR of one or more of the + following constants, where *n* is the button number from 1 to 4: + :const:`BUTTONn_PRESSED`, :const:`BUTTONn_RELEASED`, :const:`BUTTONn_CLICKED`, + :const:`BUTTONn_DOUBLE_CLICKED`, :const:`BUTTONn_TRIPLE_CLICKED`, + :const:`BUTTON_SHIFT`, :const:`BUTTON_CTRL`, :const:`BUTTON_ALT`. + + +.. function:: getsyx() + + Return the current coordinates of the virtual screen cursor as a tuple + ``(y, x)``. If :meth:`leaveok ` is currently ``True``, then return ``(-1, -1)``. + + +.. function:: getwin(file) + + Read window related data stored in the file by an earlier :func:`putwin` call. + The routine then creates and initializes a new window using that data, returning + the new window object. + + +.. function:: has_colors() + + Return ``True`` if the terminal can display colors; otherwise, return ``False``. + + +.. function:: has_ic() + + Return ``True`` if the terminal has insert- and delete-character capabilities. + This function is included for historical reasons only, as all modern software + terminal emulators have such capabilities. + + +.. function:: has_il() + + Return ``True`` if the terminal has insert- and delete-line capabilities, or can + simulate them using scrolling regions. This function is included for + historical reasons only, as all modern software terminal emulators have such + capabilities. + + +.. function:: has_key(ch) + + Take a key value *ch*, and return ``True`` if the current terminal type recognizes + a key with that value. + + +.. function:: halfdelay(tenths) + + Used for half-delay mode, which is similar to cbreak mode in that characters + typed by the user are immediately available to the program. However, after + blocking for *tenths* tenths of seconds, raise an exception if nothing has + been typed. The value of *tenths* must be a number between ``1`` and ``255``. Use + :func:`nocbreak` to leave half-delay mode. + + +.. function:: init_color(color_number, r, g, b) + + Change the definition of a color, taking the number of the color to be changed + followed by three RGB values (for the amounts of red, green, and blue + components). The value of *color_number* must be between ``0`` and + :const:`COLORS`. Each of *r*, *g*, *b*, must be a value between ``0`` and + ``1000``. When :func:`init_color` is used, all occurrences of that color on the + screen immediately change to the new definition. This function is a no-op on + most terminals; it is active only if :func:`can_change_color` returns ``True``. + + +.. function:: init_pair(pair_number, fg, bg) + + Change the definition of a color-pair. It takes three arguments: the number of + the color-pair to be changed, the foreground color number, and the background + color number. The value of *pair_number* must be between ``1`` and + ``COLOR_PAIRS - 1`` (the ``0`` color pair is wired to white on black and cannot + be changed). The value of *fg* and *bg* arguments must be between ``0`` and + :const:`COLORS`. If the color-pair was previously initialized, the screen is + refreshed and all occurrences of that color-pair are changed to the new + definition. + + +.. function:: initscr() + + Initialize the library. Return a :ref:`window ` object + which represents the whole screen. + + .. note:: + + If there is an error opening the terminal, the underlying curses library may + cause the interpreter to exit. + + +.. function:: is_term_resized(nlines, ncols) + + Return ``True`` if :func:`resize_term` would modify the window structure, + ``False`` otherwise. + + +.. function:: isendwin() + + Return ``True`` if :func:`endwin` has been called (that is, the curses library has + been deinitialized). + + +.. function:: keyname(k) + + Return the name of the key numbered *k* as a bytes object. The name of a key generating printable + ASCII character is the key's character. The name of a control-key combination + is a two-byte bytes object consisting of a caret (``b'^'``) followed by the corresponding + printable ASCII character. The name of an alt-key combination (128--255) is a + bytes object consisting of the prefix ``b'M-'`` followed by the name of the corresponding + ASCII character. + + +.. function:: killchar() + + Return the user's current line kill character as a one-byte bytes object. Under Unix operating systems + this is a property of the controlling tty of the curses program, and is not set + by the curses library itself. + + +.. function:: longname() + + Return a bytes object containing the terminfo long name field describing the current + terminal. The maximum length of a verbose description is 128 characters. It is + defined only after the call to :func:`initscr`. + + +.. function:: meta(flag) + + If *flag* is ``True``, allow 8-bit characters to be input. If + *flag* is ``False``, allow only 7-bit chars. + + +.. function:: mouseinterval(interval) + + Set the maximum time in milliseconds that can elapse between press and release + events in order for them to be recognized as a click, and return the previous + interval value. The default value is 200 msec, or one fifth of a second. + + +.. function:: mousemask(mousemask) + + Set the mouse events to be reported, and return a tuple ``(availmask, + oldmask)``. *availmask* indicates which of the specified mouse events can be + reported; on complete failure it returns ``0``. *oldmask* is the previous value of + the given window's mouse event mask. If this function is never called, no mouse + events are ever reported. + + +.. function:: napms(ms) + + Sleep for *ms* milliseconds. + + +.. function:: newpad(nlines, ncols) + + Create and return a pointer to a new pad data structure with the given number + of lines and columns. Return a pad as a window object. + + A pad is like a window, except that it is not restricted by the screen size, and + is not necessarily associated with a particular part of the screen. Pads can be + used when a large window is needed, and only a part of the window will be on the + screen at one time. Automatic refreshes of pads (such as from scrolling or + echoing of input) do not occur. The :meth:`~window.refresh` and :meth:`~window.noutrefresh` + methods of a pad require 6 arguments to specify the part of the pad to be + displayed and the location on the screen to be used for the display. The + arguments are *pminrow*, *pmincol*, *sminrow*, *smincol*, *smaxrow*, *smaxcol*; the *p* + arguments refer to the upper left corner of the pad region to be displayed and + the *s* arguments define a clipping box on the screen within which the pad region + is to be displayed. + + +.. function:: newwin(nlines, ncols) + newwin(nlines, ncols, begin_y, begin_x) + + Return a new :ref:`window `, whose left-upper corner + is at ``(begin_y, begin_x)``, and whose height/width is *nlines*/*ncols*. + + By default, the window will extend from the specified position to the lower + right corner of the screen. + + +.. function:: nl() + + Enter newline mode. This mode translates the return key into newline on input, + and translates newline into return and line-feed on output. Newline mode is + initially on. + + +.. function:: nocbreak() + + Leave cbreak mode. Return to normal "cooked" mode with line buffering. + + +.. function:: noecho() + + Leave echo mode. Echoing of input characters is turned off. + + +.. function:: nonl() + + Leave newline mode. Disable translation of return into newline on input, and + disable low-level translation of newline into newline/return on output (but this + does not change the behavior of ``addch('\n')``, which always does the + equivalent of return and line feed on the virtual screen). With translation + off, curses can sometimes speed up vertical motion a little; also, it will be + able to detect the return key on input. + + +.. function:: noqiflush() + + When the :func:`!noqiflush` routine is used, normal flush of input and output queues + associated with the ``INTR``, ``QUIT`` and ``SUSP`` characters will not be done. You may + want to call :func:`!noqiflush` in a signal handler if you want output to + continue as though the interrupt had not occurred, after the handler exits. + + +.. function:: noraw() + + Leave raw mode. Return to normal "cooked" mode with line buffering. + + +.. function:: pair_content(pair_number) + + Return a tuple ``(fg, bg)`` containing the colors for the requested color pair. + The value of *pair_number* must be between ``1`` and ``COLOR_PAIRS - 1``. + + +.. function:: pair_number(attr) + + Return the number of the color-pair set by the attribute value *attr*. + :func:`color_pair` is the counterpart to this function. + + +.. function:: putp(str) + + Equivalent to ``tputs(str, 1, putchar)``; emit the value of a specified + terminfo capability for the current terminal. Note that the output of :func:`putp` + always goes to standard output. + + +.. function:: qiflush([flag]) + + If *flag* is ``False``, the effect is the same as calling :func:`noqiflush`. If + *flag* is ``True``, or no argument is provided, the queues will be flushed when + these control characters are read. + + +.. function:: raw() + + Enter raw mode. In raw mode, normal line buffering and processing of + interrupt, quit, suspend, and flow control keys are turned off; characters are + presented to curses input functions one by one. + + +.. function:: reset_prog_mode() + + Restore the terminal to "program" mode, as previously saved by + :func:`def_prog_mode`. + + +.. function:: reset_shell_mode() + + Restore the terminal to "shell" mode, as previously saved by + :func:`def_shell_mode`. + + +.. function:: resetty() + + Restore the state of the terminal modes to what it was at the last call to + :func:`savetty`. + + +.. function:: resize_term(nlines, ncols) + + Backend function used by :func:`resizeterm`, performing most of the work; + when resizing the windows, :func:`resize_term` blank-fills the areas that are + extended. The calling application should fill in these areas with + appropriate data. The :func:`!resize_term` function attempts to resize all + windows. However, due to the calling convention of pads, it is not possible + to resize these without additional interaction with the application. + + +.. function:: resizeterm(nlines, ncols) + + Resize the standard and current windows to the specified dimensions, and + adjusts other bookkeeping data used by the curses library that record the + window dimensions (in particular the SIGWINCH handler). + + +.. function:: savetty() + + Save the current state of the terminal modes in a buffer, usable by + :func:`resetty`. + + +.. function:: setsyx(y, x) + + Set the virtual screen cursor to *y*, *x*. If *y* and *x* are both ``-1``, then + :meth:`leaveok ` is set ``True``. + + +.. function:: setupterm(term=None, fd=-1) + + Initialize the terminal. *term* is a string giving + the terminal name, or ``None``; if omitted or ``None``, the value of the + :envvar:`TERM` environment variable will be used. *fd* is the + file descriptor to which any initialization sequences will be sent; if not + supplied or ``-1``, the file descriptor for ``sys.stdout`` will be used. + + +.. function:: start_color() + + Must be called if the programmer wants to use colors, and before any other color + manipulation routine is called. It is good practice to call this routine right + after :func:`initscr`. + + :func:`start_color` initializes eight basic colors (black, red, green, yellow, + blue, magenta, cyan, and white), and two global variables in the :mod:`curses` + module, :const:`COLORS` and :const:`COLOR_PAIRS`, containing the maximum number + of colors and color-pairs the terminal can support. It also restores the colors + on the terminal to the values they had when the terminal was just turned on. + + +.. function:: termattrs() + + Return a logical OR of all video attributes supported by the terminal. This + information is useful when a curses program needs complete control over the + appearance of the screen. + + +.. function:: termname() + + Return the value of the environment variable :envvar:`TERM`, as a bytes object, + truncated to 14 characters. + + +.. function:: tigetflag(capname) + + Return the value of the Boolean capability corresponding to the terminfo + capability name *capname* as an integer. Return the value ``-1`` if *capname* is not a + Boolean capability, or ``0`` if it is canceled or absent from the terminal + description. + + +.. function:: tigetnum(capname) + + Return the value of the numeric capability corresponding to the terminfo + capability name *capname* as an integer. Return the value ``-2`` if *capname* is not a + numeric capability, or ``-1`` if it is canceled or absent from the terminal + description. + + +.. function:: tigetstr(capname) + + Return the value of the string capability corresponding to the terminfo + capability name *capname* as a bytes object. Return ``None`` if *capname* + is not a terminfo "string capability", or is canceled or absent from the + terminal description. + + +.. function:: tparm(str[, ...]) + + Instantiate the bytes object *str* with the supplied parameters, where *str* should + be a parameterized string obtained from the terminfo database. E.g. + ``tparm(tigetstr("cup"), 5, 3)`` could result in ``b'\033[6;4H'``, the exact + result depending on terminal type. + + +.. function:: typeahead(fd) + + Specify that the file descriptor *fd* be used for typeahead checking. If *fd* + is ``-1``, then no typeahead checking is done. + + The curses library does "line-breakout optimization" by looking for typeahead + periodically while updating the screen. If input is found, and it is coming + from a tty, the current update is postponed until refresh or doupdate is called + again, allowing faster response to commands typed in advance. This function + allows specifying a different file descriptor for typeahead checking. + + +.. function:: unctrl(ch) + + Return a bytes object which is a printable representation of the character *ch*. + Control characters are represented as a caret followed by the character, for + example as ``b'^C'``. Printing characters are left as they are. + + +.. function:: ungetch(ch) + + Push *ch* so the next :meth:`~window.getch` will return it. + + .. note:: + + Only one *ch* can be pushed before :meth:`!getch` is called. + + +.. function:: update_lines_cols() + + Update :envvar:`LINES` and :envvar:`COLS`. Useful for detecting manual screen resize. + + .. versionadded:: 3.5 + + +.. function:: unget_wch(ch) + + Push *ch* so the next :meth:`~window.get_wch` will return it. + + .. note:: + + Only one *ch* can be pushed before :meth:`!get_wch` is called. + + .. versionadded:: 3.3 + + +.. function:: ungetmouse(id, x, y, z, bstate) + + Push a :const:`KEY_MOUSE` event onto the input queue, associating the given + state data with it. + + +.. function:: use_env(flag) + + If used, this function should be called before :func:`initscr` or newterm are + called. When *flag* is ``False``, the values of lines and columns specified in the + terminfo database will be used, even if environment variables :envvar:`LINES` + and :envvar:`COLUMNS` (used by default) are set, or if curses is running in a + window (in which case default behavior would be to use the window size if + :envvar:`LINES` and :envvar:`COLUMNS` are not set). + + +.. function:: use_default_colors() + + Allow use of default values for colors on terminals supporting this feature. Use + this to support transparency in your application. The default color is assigned + to the color number ``-1``. After calling this function, ``init_pair(x, + curses.COLOR_RED, -1)`` initializes, for instance, color pair *x* to a red + foreground color on the default background. + + +.. function:: wrapper(func, ...) + + Initialize curses and call another callable object, *func*, which should be the + rest of your curses-using application. If the application raises an exception, + this function will restore the terminal to a sane state before re-raising the + exception and generating a traceback. The callable object *func* is then passed + the main window 'stdscr' as its first argument, followed by any other arguments + passed to :func:`!wrapper`. Before calling *func*, :func:`!wrapper` turns on + cbreak mode, turns off echo, enables the terminal keypad, and initializes colors + if the terminal has color support. On exit (whether normally or by exception) + it restores cooked mode, turns on echo, and disables the terminal keypad. + + +.. _curses-window-objects: + +Window Objects +-------------- + +Window objects, as returned by :func:`initscr` and :func:`newwin` above, have +the following methods and attributes: + + +.. method:: window.addch(ch[, attr]) + window.addch(y, x, ch[, attr]) + + Paint character *ch* at ``(y, x)`` with attributes *attr*, overwriting any + character previously painter at that location. By default, the character + position and attributes are the current settings for the window object. + + .. note:: + + Writing outside the window, subwindow, or pad raises a :exc:`curses.error`. + Attempting to write to the lower right corner of a window, subwindow, + or pad will cause an exception to be raised after the character is printed. + + +.. method:: window.addnstr(str, n[, attr]) + window.addnstr(y, x, str, n[, attr]) + + Paint at most *n* characters of the character string *str* at + ``(y, x)`` with attributes + *attr*, overwriting anything previously on the display. + + +.. method:: window.addstr(str[, attr]) + window.addstr(y, x, str[, attr]) + + Paint the character string *str* at ``(y, x)`` with attributes + *attr*, overwriting anything previously on the display. + + .. note:: + + Writing outside the window, subwindow, or pad raises :exc:`curses.error`. + Attempting to write to the lower right corner of a window, subwindow, + or pad will cause an exception to be raised after the string is printed. + + +.. method:: window.attroff(attr) + + Remove attribute *attr* from the "background" set applied to all writes to the + current window. + + +.. method:: window.attron(attr) + + Add attribute *attr* from the "background" set applied to all writes to the + current window. + + +.. method:: window.attrset(attr) + + Set the "background" set of attributes to *attr*. This set is initially + ``0`` (no attributes). + + +.. method:: window.bkgd(ch[, attr]) + + Set the background property of the window to the character *ch*, with + attributes *attr*. The change is then applied to every character position in + that window: + + * The attribute of every character in the window is changed to the new + background attribute. + + * Wherever the former background character appears, it is changed to the new + background character. + + +.. method:: window.bkgdset(ch[, attr]) + + Set the window's background. A window's background consists of a character and + any combination of attributes. The attribute part of the background is combined + (OR'ed) with all non-blank characters that are written into the window. Both + the character and attribute parts of the background are combined with the blank + characters. The background becomes a property of the character and moves with + the character through any scrolling and insert/delete line/character operations. + + +.. method:: window.border([ls[, rs[, ts[, bs[, tl[, tr[, bl[, br]]]]]]]]) + + Draw a border around the edges of the window. Each parameter specifies the + character to use for a specific part of the border; see the table below for more + details. + + .. note:: + + A ``0`` value for any parameter will cause the default character to be used for + that parameter. Keyword parameters can *not* be used. The defaults are listed + in this table: + + +-----------+---------------------+-----------------------+ + | Parameter | Description | Default value | + +===========+=====================+=======================+ + | *ls* | Left side | :const:`ACS_VLINE` | + +-----------+---------------------+-----------------------+ + | *rs* | Right side | :const:`ACS_VLINE` | + +-----------+---------------------+-----------------------+ + | *ts* | Top | :const:`ACS_HLINE` | + +-----------+---------------------+-----------------------+ + | *bs* | Bottom | :const:`ACS_HLINE` | + +-----------+---------------------+-----------------------+ + | *tl* | Upper-left corner | :const:`ACS_ULCORNER` | + +-----------+---------------------+-----------------------+ + | *tr* | Upper-right corner | :const:`ACS_URCORNER` | + +-----------+---------------------+-----------------------+ + | *bl* | Bottom-left corner | :const:`ACS_LLCORNER` | + +-----------+---------------------+-----------------------+ + | *br* | Bottom-right corner | :const:`ACS_LRCORNER` | + +-----------+---------------------+-----------------------+ + + +.. method:: window.box([vertch, horch]) + + Similar to :meth:`border`, but both *ls* and *rs* are *vertch* and both *ts* and + *bs* are *horch*. The default corner characters are always used by this function. + + +.. method:: window.chgat(attr) + window.chgat(num, attr) + window.chgat(y, x, attr) + window.chgat(y, x, num, attr) + + Set the attributes of *num* characters at the current cursor position, or at + position ``(y, x)`` if supplied. If *num* is not given or is ``-1``, + the attribute will be set on all the characters to the end of the line. This + function moves cursor to position ``(y, x)`` if supplied. The changed line + will be touched using the :meth:`touchline` method so that the contents will + be redisplayed by the next window refresh. + + +.. method:: window.clear() + + Like :meth:`erase`, but also cause the whole window to be repainted upon next + call to :meth:`refresh`. + + +.. method:: window.clearok(flag) + + If *flag* is ``True``, the next call to :meth:`refresh` will clear the window + completely. + + +.. method:: window.clrtobot() + + Erase from cursor to the end of the window: all lines below the cursor are + deleted, and then the equivalent of :meth:`clrtoeol` is performed. + + +.. method:: window.clrtoeol() + + Erase from cursor to the end of the line. + + +.. method:: window.cursyncup() + + Update the current cursor position of all the ancestors of the window to + reflect the current cursor position of the window. + + +.. method:: window.delch([y, x]) + + Delete any character at ``(y, x)``. + + +.. method:: window.deleteln() + + Delete the line under the cursor. All following lines are moved up by one line. + + +.. method:: window.derwin(begin_y, begin_x) + window.derwin(nlines, ncols, begin_y, begin_x) + + An abbreviation for "derive window", :meth:`derwin` is the same as calling + :meth:`subwin`, except that *begin_y* and *begin_x* are relative to the origin + of the window, rather than relative to the entire screen. Return a window + object for the derived window. + + +.. method:: window.echochar(ch[, attr]) + + Add character *ch* with attribute *attr*, and immediately call :meth:`refresh` + on the window. + + +.. method:: window.enclose(y, x) + + Test whether the given pair of screen-relative character-cell coordinates are + enclosed by the given window, returning ``True`` or ``False``. It is useful for + determining what subset of the screen windows enclose the location of a mouse + event. + + +.. attribute:: window.encoding + + Encoding used to encode method arguments (Unicode strings and characters). + The encoding attribute is inherited from the parent window when a subwindow + is created, for example with :meth:`window.subwin`. By default, the locale + encoding is used (see :func:`locale.getpreferredencoding`). + + .. versionadded:: 3.3 + + +.. method:: window.erase() + + Clear the window. + + +.. method:: window.getbegyx() + + Return a tuple ``(y, x)`` of co-ordinates of upper-left corner. + + +.. method:: window.getbkgd() + + Return the given window's current background character/attribute pair. + + +.. method:: window.getch([y, x]) + + Get a character. Note that the integer returned does *not* have to be in ASCII + range: function keys, keypad keys and so on are represented by numbers higher + than 255. In no-delay mode, return ``-1`` if there is no input, otherwise + wait until a key is pressed. + + +.. method:: window.get_wch([y, x]) + + Get a wide character. Return a character for most keys, or an integer for + function keys, keypad keys, and other special keys. + In no-delay mode, raise an exception if there is no input. + + .. versionadded:: 3.3 + + +.. method:: window.getkey([y, x]) + + Get a character, returning a string instead of an integer, as :meth:`getch` + does. Function keys, keypad keys and other special keys return a multibyte + string containing the key name. In no-delay mode, raise an exception if + there is no input. + + +.. method:: window.getmaxyx() + + Return a tuple ``(y, x)`` of the height and width of the window. + + +.. method:: window.getparyx() + + Return the beginning coordinates of this window relative to its parent window + as a tuple ``(y, x)``. Return ``(-1, -1)`` if this window has no + parent. + + +.. method:: window.getstr() + window.getstr(n) + window.getstr(y, x) + window.getstr(y, x, n) + + Read a bytes object from the user, with primitive line editing capacity. + + +.. method:: window.getyx() + + Return a tuple ``(y, x)`` of current cursor position relative to the window's + upper-left corner. + + +.. method:: window.hline(ch, n) + window.hline(y, x, ch, n) + + Display a horizontal line starting at ``(y, x)`` with length *n* consisting of + the character *ch*. + + +.. method:: window.idcok(flag) + + If *flag* is ``False``, curses no longer considers using the hardware insert/delete + character feature of the terminal; if *flag* is ``True``, use of character insertion + and deletion is enabled. When curses is first initialized, use of character + insert/delete is enabled by default. + + +.. method:: window.idlok(flag) + + If *flag* is ``True``, :mod:`curses` will try and use hardware line + editing facilities. Otherwise, line insertion/deletion are disabled. + + +.. method:: window.immedok(flag) + + If *flag* is ``True``, any change in the window image automatically causes the + window to be refreshed; you no longer have to call :meth:`refresh` yourself. + However, it may degrade performance considerably, due to repeated calls to + wrefresh. This option is disabled by default. + + +.. method:: window.inch([y, x]) + + Return the character at the given position in the window. The bottom 8 bits are + the character proper, and upper bits are the attributes. + + +.. method:: window.insch(ch[, attr]) + window.insch(y, x, ch[, attr]) + + Paint character *ch* at ``(y, x)`` with attributes *attr*, moving the line from + position *x* right by one character. + + +.. method:: window.insdelln(nlines) + + Insert *nlines* lines into the specified window above the current line. The + *nlines* bottom lines are lost. For negative *nlines*, delete *nlines* lines + starting with the one under the cursor, and move the remaining lines up. The + bottom *nlines* lines are cleared. The current cursor position remains the + same. + + +.. method:: window.insertln() + + Insert a blank line under the cursor. All following lines are moved down by one + line. + + +.. method:: window.insnstr(str, n[, attr]) + window.insnstr(y, x, str, n[, attr]) + + Insert a character string (as many characters as will fit on the line) before + the character under the cursor, up to *n* characters. If *n* is zero or + negative, the entire string is inserted. All characters to the right of the + cursor are shifted right, with the rightmost characters on the line being lost. + The cursor position does not change (after moving to *y*, *x*, if specified). + + +.. method:: window.insstr(str[, attr]) + window.insstr(y, x, str[, attr]) + + Insert a character string (as many characters as will fit on the line) before + the character under the cursor. All characters to the right of the cursor are + shifted right, with the rightmost characters on the line being lost. The cursor + position does not change (after moving to *y*, *x*, if specified). + + +.. method:: window.instr([n]) + window.instr(y, x[, n]) + + Return a bytes object of characters, extracted from the window starting at the + current cursor position, or at *y*, *x* if specified. Attributes are stripped + from the characters. If *n* is specified, :meth:`instr` returns a string + at most *n* characters long (exclusive of the trailing NUL). + + +.. method:: window.is_linetouched(line) + + Return ``True`` if the specified line was modified since the last call to + :meth:`refresh`; otherwise return ``False``. Raise a :exc:`curses.error` + exception if *line* is not valid for the given window. + + +.. method:: window.is_wintouched() + + Return ``True`` if the specified window was modified since the last call to + :meth:`refresh`; otherwise return ``False``. + + +.. method:: window.keypad(flag) + + If *flag* is ``True``, escape sequences generated by some keys (keypad, function keys) + will be interpreted by :mod:`curses`. If *flag* is ``False``, escape sequences will be + left as is in the input stream. + + +.. method:: window.leaveok(flag) + + If *flag* is ``True``, cursor is left where it is on update, instead of being at "cursor + position." This reduces cursor movement where possible. If possible the cursor + will be made invisible. + + If *flag* is ``False``, cursor will always be at "cursor position" after an update. + + +.. method:: window.move(new_y, new_x) + + Move cursor to ``(new_y, new_x)``. + + +.. method:: window.mvderwin(y, x) + + Move the window inside its parent window. The screen-relative parameters of + the window are not changed. This routine is used to display different parts of + the parent window at the same physical position on the screen. + + +.. method:: window.mvwin(new_y, new_x) + + Move the window so its upper-left corner is at ``(new_y, new_x)``. + + +.. method:: window.nodelay(flag) + + If *flag* is ``True``, :meth:`getch` will be non-blocking. + + +.. method:: window.notimeout(flag) + + If *flag* is ``True``, escape sequences will not be timed out. + + If *flag* is ``False``, after a few milliseconds, an escape sequence will not be + interpreted, and will be left in the input stream as is. + + +.. method:: window.noutrefresh() + + Mark for refresh but wait. This function updates the data structure + representing the desired state of the window, but does not force an update of + the physical screen. To accomplish that, call :func:`doupdate`. + + +.. method:: window.overlay(destwin[, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol]) + + Overlay the window on top of *destwin*. The windows need not be the same size, + only the overlapping region is copied. This copy is non-destructive, which means + that the current background character does not overwrite the old contents of + *destwin*. + + To get fine-grained control over the copied region, the second form of + :meth:`overlay` can be used. *sminrow* and *smincol* are the upper-left + coordinates of the source window, and the other variables mark a rectangle in + the destination window. + + +.. method:: window.overwrite(destwin[, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol]) + + Overwrite the window on top of *destwin*. The windows need not be the same size, + in which case only the overlapping region is copied. This copy is destructive, + which means that the current background character overwrites the old contents of + *destwin*. + + To get fine-grained control over the copied region, the second form of + :meth:`overwrite` can be used. *sminrow* and *smincol* are the upper-left + coordinates of the source window, the other variables mark a rectangle in the + destination window. + + +.. method:: window.putwin(file) + + Write all data associated with the window into the provided file object. This + information can be later retrieved using the :func:`getwin` function. + + +.. method:: window.redrawln(beg, num) + + Indicate that the *num* screen lines, starting at line *beg*, are corrupted and + should be completely redrawn on the next :meth:`refresh` call. + + +.. method:: window.redrawwin() + + Touch the entire window, causing it to be completely redrawn on the next + :meth:`refresh` call. + + +.. method:: window.refresh([pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol]) + + Update the display immediately (sync actual screen with previous + drawing/deleting methods). + + The 6 optional arguments can only be specified when the window is a pad created + with :func:`newpad`. The additional parameters are needed to indicate what part + of the pad and screen are involved. *pminrow* and *pmincol* specify the upper + left-hand corner of the rectangle to be displayed in the pad. *sminrow*, + *smincol*, *smaxrow*, and *smaxcol* specify the edges of the rectangle to be + displayed on the screen. The lower right-hand corner of the rectangle to be + displayed in the pad is calculated from the screen coordinates, since the + rectangles must be the same size. Both rectangles must be entirely contained + within their respective structures. Negative values of *pminrow*, *pmincol*, + *sminrow*, or *smincol* are treated as if they were zero. + + +.. method:: window.resize(nlines, ncols) + + Reallocate storage for a curses window to adjust its dimensions to the + specified values. If either dimension is larger than the current values, the + window's data is filled with blanks that have the current background + rendition (as set by :meth:`bkgdset`) merged into them. + + +.. method:: window.scroll([lines=1]) + + Scroll the screen or scrolling region upward by *lines* lines. + + +.. method:: window.scrollok(flag) + + Control what happens when the cursor of a window is moved off the edge of the + window or scrolling region, either as a result of a newline action on the bottom + line, or typing the last character of the last line. If *flag* is ``False``, the + cursor is left on the bottom line. If *flag* is ``True``, the window is scrolled up + one line. Note that in order to get the physical scrolling effect on the + terminal, it is also necessary to call :meth:`idlok`. + + +.. method:: window.setscrreg(top, bottom) + + Set the scrolling region from line *top* to line *bottom*. All scrolling actions + will take place in this region. + + +.. method:: window.standend() + + Turn off the standout attribute. On some terminals this has the side effect of + turning off all attributes. + + +.. method:: window.standout() + + Turn on attribute *A_STANDOUT*. + + +.. method:: window.subpad(begin_y, begin_x) + window.subpad(nlines, ncols, begin_y, begin_x) + + Return a sub-window, whose upper-left corner is at ``(begin_y, begin_x)``, and + whose width/height is *ncols*/*nlines*. + + +.. method:: window.subwin(begin_y, begin_x) + window.subwin(nlines, ncols, begin_y, begin_x) + + Return a sub-window, whose upper-left corner is at ``(begin_y, begin_x)``, and + whose width/height is *ncols*/*nlines*. + + By default, the sub-window will extend from the specified position to the lower + right corner of the window. + + +.. method:: window.syncdown() + + Touch each location in the window that has been touched in any of its ancestor + windows. This routine is called by :meth:`refresh`, so it should almost never + be necessary to call it manually. + + +.. method:: window.syncok(flag) + + If *flag* is ``True``, then :meth:`syncup` is called automatically + whenever there is a change in the window. + + +.. method:: window.syncup() + + Touch all locations in ancestors of the window that have been changed in the + window. + + +.. method:: window.timeout(delay) + + Set blocking or non-blocking read behavior for the window. If *delay* is + negative, blocking read is used (which will wait indefinitely for input). If + *delay* is zero, then non-blocking read is used, and :meth:`getch` will + return ``-1`` if no input is waiting. If *delay* is positive, then + :meth:`getch` will block for *delay* milliseconds, and return ``-1`` if there is + still no input at the end of that time. + + +.. method:: window.touchline(start, count[, changed]) + + Pretend *count* lines have been changed, starting with line *start*. If + *changed* is supplied, it specifies whether the affected lines are marked as + having been changed (*changed*\ ``=True``) or unchanged (*changed*\ ``=False``). + + +.. method:: window.touchwin() + + Pretend the whole window has been changed, for purposes of drawing + optimizations. + + +.. method:: window.untouchwin() + + Mark all lines in the window as unchanged since the last call to + :meth:`refresh`. + + +.. method:: window.vline(ch, n) + window.vline(y, x, ch, n) + + Display a vertical line starting at ``(y, x)`` with length *n* consisting of the + character *ch*. + + +Constants +--------- + +The :mod:`curses` module defines the following data members: + + +.. data:: ERR + + Some curses routines that return an integer, such as :func:`getch`, return + :const:`ERR` upon failure. + + +.. data:: OK + + Some curses routines that return an integer, such as :func:`napms`, return + :const:`OK` upon success. + + +.. data:: version + + A bytes object representing the current version of the module. Also available as + :const:`__version__`. + +Some constants are available to specify character cell attributes. +The exact constants available are system dependent. + ++------------------+-------------------------------+ +| Attribute | Meaning | ++==================+===============================+ +| ``A_ALTCHARSET`` | Alternate character set mode | ++------------------+-------------------------------+ +| ``A_BLINK`` | Blink mode | ++------------------+-------------------------------+ +| ``A_BOLD`` | Bold mode | ++------------------+-------------------------------+ +| ``A_DIM`` | Dim mode | ++------------------+-------------------------------+ +| ``A_INVIS`` | Invisible or blank mode | ++------------------+-------------------------------+ +| ``A_ITALIC`` | Italic mode | ++------------------+-------------------------------+ +| ``A_NORMAL`` | Normal attribute | ++------------------+-------------------------------+ +| ``A_PROTECT`` | Protected mode | ++------------------+-------------------------------+ +| ``A_REVERSE`` | Reverse background and | +| | foreground colors | ++------------------+-------------------------------+ +| ``A_STANDOUT`` | Standout mode | ++------------------+-------------------------------+ +| ``A_UNDERLINE`` | Underline mode | ++------------------+-------------------------------+ +| ``A_HORIZONTAL`` | Horizontal highlight | ++------------------+-------------------------------+ +| ``A_LEFT`` | Left highlight | ++------------------+-------------------------------+ +| ``A_LOW`` | Low highlight | ++------------------+-------------------------------+ +| ``A_RIGHT`` | Right highlight | ++------------------+-------------------------------+ +| ``A_TOP`` | Top highlight | ++------------------+-------------------------------+ +| ``A_VERTICAL`` | Vertical highlight | ++------------------+-------------------------------+ +| ``A_CHARTEXT`` | Bit-mask to extract a | +| | character | ++------------------+-------------------------------+ + +.. versionadded:: 3.7 + ``A_ITALIC`` was added. + +Several constants are available to extract corresponding attributes returned +by some methods. + ++------------------+-------------------------------+ +| Bit-mask | Meaning | ++==================+===============================+ +| ``A_ATTRIBUTES`` | Bit-mask to extract | +| | attributes | ++------------------+-------------------------------+ +| ``A_CHARTEXT`` | Bit-mask to extract a | +| | character | ++------------------+-------------------------------+ +| ``A_COLOR`` | Bit-mask to extract | +| | color-pair field information | ++------------------+-------------------------------+ + +Keys are referred to by integer constants with names starting with ``KEY_``. +The exact keycaps available are system dependent. + +.. XXX this table is far too large! should it be alphabetized? + ++-------------------+--------------------------------------------+ +| Key constant | Key | ++===================+============================================+ +| ``KEY_MIN`` | Minimum key value | ++-------------------+--------------------------------------------+ +| ``KEY_BREAK`` | Break key (unreliable) | ++-------------------+--------------------------------------------+ +| ``KEY_DOWN`` | Down-arrow | ++-------------------+--------------------------------------------+ +| ``KEY_UP`` | Up-arrow | ++-------------------+--------------------------------------------+ +| ``KEY_LEFT`` | Left-arrow | ++-------------------+--------------------------------------------+ +| ``KEY_RIGHT`` | Right-arrow | ++-------------------+--------------------------------------------+ +| ``KEY_HOME`` | Home key (upward+left arrow) | ++-------------------+--------------------------------------------+ +| ``KEY_BACKSPACE`` | Backspace (unreliable) | ++-------------------+--------------------------------------------+ +| ``KEY_F0`` | Function keys. Up to 64 function keys are | +| | supported. | ++-------------------+--------------------------------------------+ +| ``KEY_Fn`` | Value of function key *n* | ++-------------------+--------------------------------------------+ +| ``KEY_DL`` | Delete line | ++-------------------+--------------------------------------------+ +| ``KEY_IL`` | Insert line | ++-------------------+--------------------------------------------+ +| ``KEY_DC`` | Delete character | ++-------------------+--------------------------------------------+ +| ``KEY_IC`` | Insert char or enter insert mode | ++-------------------+--------------------------------------------+ +| ``KEY_EIC`` | Exit insert char mode | ++-------------------+--------------------------------------------+ +| ``KEY_CLEAR`` | Clear screen | ++-------------------+--------------------------------------------+ +| ``KEY_EOS`` | Clear to end of screen | ++-------------------+--------------------------------------------+ +| ``KEY_EOL`` | Clear to end of line | ++-------------------+--------------------------------------------+ +| ``KEY_SF`` | Scroll 1 line forward | ++-------------------+--------------------------------------------+ +| ``KEY_SR`` | Scroll 1 line backward (reverse) | ++-------------------+--------------------------------------------+ +| ``KEY_NPAGE`` | Next page | ++-------------------+--------------------------------------------+ +| ``KEY_PPAGE`` | Previous page | ++-------------------+--------------------------------------------+ +| ``KEY_STAB`` | Set tab | ++-------------------+--------------------------------------------+ +| ``KEY_CTAB`` | Clear tab | ++-------------------+--------------------------------------------+ +| ``KEY_CATAB`` | Clear all tabs | ++-------------------+--------------------------------------------+ +| ``KEY_ENTER`` | Enter or send (unreliable) | ++-------------------+--------------------------------------------+ +| ``KEY_SRESET`` | Soft (partial) reset (unreliable) | ++-------------------+--------------------------------------------+ +| ``KEY_RESET`` | Reset or hard reset (unreliable) | ++-------------------+--------------------------------------------+ +| ``KEY_PRINT`` | Print | ++-------------------+--------------------------------------------+ +| ``KEY_LL`` | Home down or bottom (lower left) | ++-------------------+--------------------------------------------+ +| ``KEY_A1`` | Upper left of keypad | ++-------------------+--------------------------------------------+ +| ``KEY_A3`` | Upper right of keypad | ++-------------------+--------------------------------------------+ +| ``KEY_B2`` | Center of keypad | ++-------------------+--------------------------------------------+ +| ``KEY_C1`` | Lower left of keypad | ++-------------------+--------------------------------------------+ +| ``KEY_C3`` | Lower right of keypad | ++-------------------+--------------------------------------------+ +| ``KEY_BTAB`` | Back tab | ++-------------------+--------------------------------------------+ +| ``KEY_BEG`` | Beg (beginning) | ++-------------------+--------------------------------------------+ +| ``KEY_CANCEL`` | Cancel | ++-------------------+--------------------------------------------+ +| ``KEY_CLOSE`` | Close | ++-------------------+--------------------------------------------+ +| ``KEY_COMMAND`` | Cmd (command) | ++-------------------+--------------------------------------------+ +| ``KEY_COPY`` | Copy | ++-------------------+--------------------------------------------+ +| ``KEY_CREATE`` | Create | ++-------------------+--------------------------------------------+ +| ``KEY_END`` | End | ++-------------------+--------------------------------------------+ +| ``KEY_EXIT`` | Exit | ++-------------------+--------------------------------------------+ +| ``KEY_FIND`` | Find | ++-------------------+--------------------------------------------+ +| ``KEY_HELP`` | Help | ++-------------------+--------------------------------------------+ +| ``KEY_MARK`` | Mark | ++-------------------+--------------------------------------------+ +| ``KEY_MESSAGE`` | Message | ++-------------------+--------------------------------------------+ +| ``KEY_MOVE`` | Move | ++-------------------+--------------------------------------------+ +| ``KEY_NEXT`` | Next | ++-------------------+--------------------------------------------+ +| ``KEY_OPEN`` | Open | ++-------------------+--------------------------------------------+ +| ``KEY_OPTIONS`` | Options | ++-------------------+--------------------------------------------+ +| ``KEY_PREVIOUS`` | Prev (previous) | ++-------------------+--------------------------------------------+ +| ``KEY_REDO`` | Redo | ++-------------------+--------------------------------------------+ +| ``KEY_REFERENCE`` | Ref (reference) | ++-------------------+--------------------------------------------+ +| ``KEY_REFRESH`` | Refresh | ++-------------------+--------------------------------------------+ +| ``KEY_REPLACE`` | Replace | ++-------------------+--------------------------------------------+ +| ``KEY_RESTART`` | Restart | ++-------------------+--------------------------------------------+ +| ``KEY_RESUME`` | Resume | ++-------------------+--------------------------------------------+ +| ``KEY_SAVE`` | Save | ++-------------------+--------------------------------------------+ +| ``KEY_SBEG`` | Shifted Beg (beginning) | ++-------------------+--------------------------------------------+ +| ``KEY_SCANCEL`` | Shifted Cancel | ++-------------------+--------------------------------------------+ +| ``KEY_SCOMMAND`` | Shifted Command | ++-------------------+--------------------------------------------+ +| ``KEY_SCOPY`` | Shifted Copy | ++-------------------+--------------------------------------------+ +| ``KEY_SCREATE`` | Shifted Create | ++-------------------+--------------------------------------------+ +| ``KEY_SDC`` | Shifted Delete char | ++-------------------+--------------------------------------------+ +| ``KEY_SDL`` | Shifted Delete line | ++-------------------+--------------------------------------------+ +| ``KEY_SELECT`` | Select | ++-------------------+--------------------------------------------+ +| ``KEY_SEND`` | Shifted End | ++-------------------+--------------------------------------------+ +| ``KEY_SEOL`` | Shifted Clear line | ++-------------------+--------------------------------------------+ +| ``KEY_SEXIT`` | Shifted Exit | ++-------------------+--------------------------------------------+ +| ``KEY_SFIND`` | Shifted Find | ++-------------------+--------------------------------------------+ +| ``KEY_SHELP`` | Shifted Help | ++-------------------+--------------------------------------------+ +| ``KEY_SHOME`` | Shifted Home | ++-------------------+--------------------------------------------+ +| ``KEY_SIC`` | Shifted Input | ++-------------------+--------------------------------------------+ +| ``KEY_SLEFT`` | Shifted Left arrow | ++-------------------+--------------------------------------------+ +| ``KEY_SMESSAGE`` | Shifted Message | ++-------------------+--------------------------------------------+ +| ``KEY_SMOVE`` | Shifted Move | ++-------------------+--------------------------------------------+ +| ``KEY_SNEXT`` | Shifted Next | ++-------------------+--------------------------------------------+ +| ``KEY_SOPTIONS`` | Shifted Options | ++-------------------+--------------------------------------------+ +| ``KEY_SPREVIOUS`` | Shifted Prev | ++-------------------+--------------------------------------------+ +| ``KEY_SPRINT`` | Shifted Print | ++-------------------+--------------------------------------------+ +| ``KEY_SREDO`` | Shifted Redo | ++-------------------+--------------------------------------------+ +| ``KEY_SREPLACE`` | Shifted Replace | ++-------------------+--------------------------------------------+ +| ``KEY_SRIGHT`` | Shifted Right arrow | ++-------------------+--------------------------------------------+ +| ``KEY_SRSUME`` | Shifted Resume | ++-------------------+--------------------------------------------+ +| ``KEY_SSAVE`` | Shifted Save | ++-------------------+--------------------------------------------+ +| ``KEY_SSUSPEND`` | Shifted Suspend | ++-------------------+--------------------------------------------+ +| ``KEY_SUNDO`` | Shifted Undo | ++-------------------+--------------------------------------------+ +| ``KEY_SUSPEND`` | Suspend | ++-------------------+--------------------------------------------+ +| ``KEY_UNDO`` | Undo | ++-------------------+--------------------------------------------+ +| ``KEY_MOUSE`` | Mouse event has occurred | ++-------------------+--------------------------------------------+ +| ``KEY_RESIZE`` | Terminal resize event | ++-------------------+--------------------------------------------+ +| ``KEY_MAX`` | Maximum key value | ++-------------------+--------------------------------------------+ + +On VT100s and their software emulations, such as X terminal emulators, there are +normally at least four function keys (:const:`KEY_F1`, :const:`KEY_F2`, +:const:`KEY_F3`, :const:`KEY_F4`) available, and the arrow keys mapped to +:const:`KEY_UP`, :const:`KEY_DOWN`, :const:`KEY_LEFT` and :const:`KEY_RIGHT` in +the obvious way. If your machine has a PC keyboard, it is safe to expect arrow +keys and twelve function keys (older PC keyboards may have only ten function +keys); also, the following keypad mappings are standard: + ++------------------+-----------+ +| Keycap | Constant | ++==================+===========+ +| :kbd:`Insert` | KEY_IC | ++------------------+-----------+ +| :kbd:`Delete` | KEY_DC | ++------------------+-----------+ +| :kbd:`Home` | KEY_HOME | ++------------------+-----------+ +| :kbd:`End` | KEY_END | ++------------------+-----------+ +| :kbd:`Page Up` | KEY_PPAGE | ++------------------+-----------+ +| :kbd:`Page Down` | KEY_NPAGE | ++------------------+-----------+ + +The following table lists characters from the alternate character set. These are +inherited from the VT100 terminal, and will generally be available on software +emulations such as X terminals. When there is no graphic available, curses +falls back on a crude printable ASCII approximation. + +.. note:: + + These are available only after :func:`initscr` has been called. + ++------------------+------------------------------------------+ +| ACS code | Meaning | ++==================+==========================================+ +| ``ACS_BBSS`` | alternate name for upper right corner | ++------------------+------------------------------------------+ +| ``ACS_BLOCK`` | solid square block | ++------------------+------------------------------------------+ +| ``ACS_BOARD`` | board of squares | ++------------------+------------------------------------------+ +| ``ACS_BSBS`` | alternate name for horizontal line | ++------------------+------------------------------------------+ +| ``ACS_BSSB`` | alternate name for upper left corner | ++------------------+------------------------------------------+ +| ``ACS_BSSS`` | alternate name for top tee | ++------------------+------------------------------------------+ +| ``ACS_BTEE`` | bottom tee | ++------------------+------------------------------------------+ +| ``ACS_BULLET`` | bullet | ++------------------+------------------------------------------+ +| ``ACS_CKBOARD`` | checker board (stipple) | ++------------------+------------------------------------------+ +| ``ACS_DARROW`` | arrow pointing down | ++------------------+------------------------------------------+ +| ``ACS_DEGREE`` | degree symbol | ++------------------+------------------------------------------+ +| ``ACS_DIAMOND`` | diamond | ++------------------+------------------------------------------+ +| ``ACS_GEQUAL`` | greater-than-or-equal-to | ++------------------+------------------------------------------+ +| ``ACS_HLINE`` | horizontal line | ++------------------+------------------------------------------+ +| ``ACS_LANTERN`` | lantern symbol | ++------------------+------------------------------------------+ +| ``ACS_LARROW`` | left arrow | ++------------------+------------------------------------------+ +| ``ACS_LEQUAL`` | less-than-or-equal-to | ++------------------+------------------------------------------+ +| ``ACS_LLCORNER`` | lower left-hand corner | ++------------------+------------------------------------------+ +| ``ACS_LRCORNER`` | lower right-hand corner | ++------------------+------------------------------------------+ +| ``ACS_LTEE`` | left tee | ++------------------+------------------------------------------+ +| ``ACS_NEQUAL`` | not-equal sign | ++------------------+------------------------------------------+ +| ``ACS_PI`` | letter pi | ++------------------+------------------------------------------+ +| ``ACS_PLMINUS`` | plus-or-minus sign | ++------------------+------------------------------------------+ +| ``ACS_PLUS`` | big plus sign | ++------------------+------------------------------------------+ +| ``ACS_RARROW`` | right arrow | ++------------------+------------------------------------------+ +| ``ACS_RTEE`` | right tee | ++------------------+------------------------------------------+ +| ``ACS_S1`` | scan line 1 | ++------------------+------------------------------------------+ +| ``ACS_S3`` | scan line 3 | ++------------------+------------------------------------------+ +| ``ACS_S7`` | scan line 7 | ++------------------+------------------------------------------+ +| ``ACS_S9`` | scan line 9 | ++------------------+------------------------------------------+ +| ``ACS_SBBS`` | alternate name for lower right corner | ++------------------+------------------------------------------+ +| ``ACS_SBSB`` | alternate name for vertical line | ++------------------+------------------------------------------+ +| ``ACS_SBSS`` | alternate name for right tee | ++------------------+------------------------------------------+ +| ``ACS_SSBB`` | alternate name for lower left corner | ++------------------+------------------------------------------+ +| ``ACS_SSBS`` | alternate name for bottom tee | ++------------------+------------------------------------------+ +| ``ACS_SSSB`` | alternate name for left tee | ++------------------+------------------------------------------+ +| ``ACS_SSSS`` | alternate name for crossover or big plus | ++------------------+------------------------------------------+ +| ``ACS_STERLING`` | pound sterling | ++------------------+------------------------------------------+ +| ``ACS_TTEE`` | top tee | ++------------------+------------------------------------------+ +| ``ACS_UARROW`` | up arrow | ++------------------+------------------------------------------+ +| ``ACS_ULCORNER`` | upper left corner | ++------------------+------------------------------------------+ +| ``ACS_URCORNER`` | upper right corner | ++------------------+------------------------------------------+ +| ``ACS_VLINE`` | vertical line | ++------------------+------------------------------------------+ + +The following table lists the predefined colors: + ++-------------------+----------------------------+ +| Constant | Color | ++===================+============================+ +| ``COLOR_BLACK`` | Black | ++-------------------+----------------------------+ +| ``COLOR_BLUE`` | Blue | ++-------------------+----------------------------+ +| ``COLOR_CYAN`` | Cyan (light greenish blue) | ++-------------------+----------------------------+ +| ``COLOR_GREEN`` | Green | ++-------------------+----------------------------+ +| ``COLOR_MAGENTA`` | Magenta (purplish red) | ++-------------------+----------------------------+ +| ``COLOR_RED`` | Red | ++-------------------+----------------------------+ +| ``COLOR_WHITE`` | White | ++-------------------+----------------------------+ +| ``COLOR_YELLOW`` | Yellow | ++-------------------+----------------------------+ + + +:mod:`curses.textpad` --- Text input widget for curses programs +=============================================================== + +.. module:: curses.textpad + :synopsis: Emacs-like input editing in a curses window. +.. moduleauthor:: Eric Raymond +.. sectionauthor:: Eric Raymond + + +The :mod:`curses.textpad` module provides a :class:`Textbox` class that handles +elementary text editing in a curses window, supporting a set of keybindings +resembling those of Emacs (thus, also of Netscape Navigator, BBedit 6.x, +FrameMaker, and many other programs). The module also provides a +rectangle-drawing function useful for framing text boxes or for other purposes. + +The module :mod:`curses.textpad` defines the following function: + + +.. function:: rectangle(win, uly, ulx, lry, lrx) + + Draw a rectangle. The first argument must be a window object; the remaining + arguments are coordinates relative to that window. The second and third + arguments are the y and x coordinates of the upper left hand corner of the + rectangle to be drawn; the fourth and fifth arguments are the y and x + coordinates of the lower right hand corner. The rectangle will be drawn using + VT100/IBM PC forms characters on terminals that make this possible (including + xterm and most other software terminal emulators). Otherwise it will be drawn + with ASCII dashes, vertical bars, and plus signs. + + +.. _curses-textpad-objects: + +Textbox objects +--------------- + +You can instantiate a :class:`Textbox` object as follows: + + +.. class:: Textbox(win) + + Return a textbox widget object. The *win* argument should be a curses + :ref:`window ` object in which the textbox is to + be contained. The edit cursor of the textbox is initially located at the + upper left hand corner of the containing window, with coordinates ``(0, 0)``. + The instance's :attr:`stripspaces` flag is initially on. + + :class:`Textbox` objects have the following methods: + + + .. method:: edit([validator]) + + This is the entry point you will normally use. It accepts editing + keystrokes until one of the termination keystrokes is entered. If + *validator* is supplied, it must be a function. It will be called for + each keystroke entered with the keystroke as a parameter; command dispatch + is done on the result. This method returns the window contents as a + string; whether blanks in the window are included is affected by the + :attr:`stripspaces` attribute. + + + .. method:: do_command(ch) + + Process a single command keystroke. Here are the supported special + keystrokes: + + +------------------+-------------------------------------------+ + | Keystroke | Action | + +==================+===========================================+ + | :kbd:`Control-A` | Go to left edge of window. | + +------------------+-------------------------------------------+ + | :kbd:`Control-B` | Cursor left, wrapping to previous line if | + | | appropriate. | + +------------------+-------------------------------------------+ + | :kbd:`Control-D` | Delete character under cursor. | + +------------------+-------------------------------------------+ + | :kbd:`Control-E` | Go to right edge (stripspaces off) or end | + | | of line (stripspaces on). | + +------------------+-------------------------------------------+ + | :kbd:`Control-F` | Cursor right, wrapping to next line when | + | | appropriate. | + +------------------+-------------------------------------------+ + | :kbd:`Control-G` | Terminate, returning the window contents. | + +------------------+-------------------------------------------+ + | :kbd:`Control-H` | Delete character backward. | + +------------------+-------------------------------------------+ + | :kbd:`Control-J` | Terminate if the window is 1 line, | + | | otherwise insert newline. | + +------------------+-------------------------------------------+ + | :kbd:`Control-K` | If line is blank, delete it, otherwise | + | | clear to end of line. | + +------------------+-------------------------------------------+ + | :kbd:`Control-L` | Refresh screen. | + +------------------+-------------------------------------------+ + | :kbd:`Control-N` | Cursor down; move down one line. | + +------------------+-------------------------------------------+ + | :kbd:`Control-O` | Insert a blank line at cursor location. | + +------------------+-------------------------------------------+ + | :kbd:`Control-P` | Cursor up; move up one line. | + +------------------+-------------------------------------------+ + + Move operations do nothing if the cursor is at an edge where the movement + is not possible. The following synonyms are supported where possible: + + +------------------------+------------------+ + | Constant | Keystroke | + +========================+==================+ + | :const:`KEY_LEFT` | :kbd:`Control-B` | + +------------------------+------------------+ + | :const:`KEY_RIGHT` | :kbd:`Control-F` | + +------------------------+------------------+ + | :const:`KEY_UP` | :kbd:`Control-P` | + +------------------------+------------------+ + | :const:`KEY_DOWN` | :kbd:`Control-N` | + +------------------------+------------------+ + | :const:`KEY_BACKSPACE` | :kbd:`Control-h` | + +------------------------+------------------+ + + All other keystrokes are treated as a command to insert the given + character and move right (with line wrapping). + + + .. method:: gather() + + Return the window contents as a string; whether blanks in the + window are included is affected by the :attr:`stripspaces` member. + + + .. attribute:: stripspaces + + This attribute is a flag which controls the interpretation of blanks in + the window. When it is on, trailing blanks on each line are ignored; any + cursor motion that would land the cursor on a trailing blank goes to the + end of that line instead, and trailing blanks are stripped when the window + contents are gathered. diff --git a/python-3.7.4-docs-html/_sources/library/custominterp.rst.txt b/python-3.7.4-docs-html/_sources/library/custominterp.rst.txt new file mode 100644 index 0000000..5eeced2 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/custominterp.rst.txt @@ -0,0 +1,19 @@ +.. _custominterp: + +************************** +Custom Python Interpreters +************************** + +The modules described in this chapter allow writing interfaces similar to +Python's interactive interpreter. If you want a Python interpreter that +supports some special feature in addition to the Python language, you should +look at the :mod:`code` module. (The :mod:`codeop` module is lower-level, used +to support compiling a possibly-incomplete chunk of Python code.) + +The full list of modules described in this chapter is: + + +.. toctree:: + + code.rst + codeop.rst diff --git a/python-3.7.4-docs-html/_sources/library/dataclasses.rst.txt b/python-3.7.4-docs-html/_sources/library/dataclasses.rst.txt new file mode 100644 index 0000000..6af60b6 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/dataclasses.rst.txt @@ -0,0 +1,593 @@ +:mod:`dataclasses` --- Data Classes +=================================== + +.. module:: dataclasses + :synopsis: Generate special methods on user-defined classes. + +.. moduleauthor:: Eric V. Smith +.. sectionauthor:: Eric V. Smith + +**Source code:** :source:`Lib/dataclasses.py` + +-------------- + +This module provides a decorator and functions for automatically +adding generated :term:`special method`\s such as :meth:`__init__` and +:meth:`__repr__` to user-defined classes. It was originally described +in :pep:`557`. + +The member variables to use in these generated methods are defined +using :pep:`526` type annotations. For example this code:: + + @dataclass + class InventoryItem: + '''Class for keeping track of an item in inventory.''' + name: str + unit_price: float + quantity_on_hand: int = 0 + + def total_cost(self) -> float: + return self.unit_price * self.quantity_on_hand + +Will add, among other things, a :meth:`__init__` that looks like:: + + def __init__(self, name: str, unit_price: float, quantity_on_hand: int=0): + self.name = name + self.unit_price = unit_price + self.quantity_on_hand = quantity_on_hand + +Note that this method is automatically added to the class: it is not +directly specified in the ``InventoryItem`` definition shown above. + +.. versionadded:: 3.7 + +Module-level decorators, classes, and functions +----------------------------------------------- + +.. decorator:: dataclass(*, init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False) + + This function is a :term:`decorator` that is used to add generated + :term:`special method`\s to classes, as described below. + + The :func:`dataclass` decorator examines the class to find + ``field``\s. A ``field`` is defined as class variable that has a + :term:`type annotation `. With two + exceptions described below, nothing in :func:`dataclass` + examines the type specified in the variable annotation. + + The order of the fields in all of the generated methods is the + order in which they appear in the class definition. + + The :func:`dataclass` decorator will add various "dunder" methods to + the class, described below. If any of the added methods already + exist on the class, the behavior depends on the parameter, as documented + below. The decorator returns the same class that is called on; no new + class is created. + + If :func:`dataclass` is used just as a simple decorator with no parameters, + it acts as if it has the default values documented in this + signature. That is, these three uses of :func:`dataclass` are + equivalent:: + + @dataclass + class C: + ... + + @dataclass() + class C: + ... + + @dataclass(init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False) + class C: + ... + + The parameters to :func:`dataclass` are: + + - ``init``: If true (the default), a :meth:`__init__` method will be + generated. + + If the class already defines :meth:`__init__`, this parameter is + ignored. + + - ``repr``: If true (the default), a :meth:`__repr__` method will be + generated. The generated repr string will have the class name and + the name and repr of each field, in the order they are defined in + the class. Fields that are marked as being excluded from the repr + are not included. For example: + ``InventoryItem(name='widget', unit_price=3.0, quantity_on_hand=10)``. + + If the class already defines :meth:`__repr__`, this parameter is + ignored. + + - ``eq``: If true (the default), an :meth:`__eq__` method will be + generated. This method compares the class as if it were a tuple + of its fields, in order. Both instances in the comparison must + be of the identical type. + + If the class already defines :meth:`__eq__`, this parameter is + ignored. + + - ``order``: If true (the default is ``False``), :meth:`__lt__`, + :meth:`__le__`, :meth:`__gt__`, and :meth:`__ge__` methods will be + generated. These compare the class as if it were a tuple of its + fields, in order. Both instances in the comparison must be of the + identical type. If ``order`` is true and ``eq`` is false, a + :exc:`ValueError` is raised. + + If the class already defines any of :meth:`__lt__`, + :meth:`__le__`, :meth:`__gt__`, or :meth:`__ge__`, then + :exc:`TypeError` is raised. + + - ``unsafe_hash``: If ``False`` (the default), a :meth:`__hash__` method + is generated according to how ``eq`` and ``frozen`` are set. + + :meth:`__hash__` is used by built-in :meth:`hash()`, and when objects are + added to hashed collections such as dictionaries and sets. Having a + :meth:`__hash__` implies that instances of the class are immutable. + Mutability is a complicated property that depends on the programmer's + intent, the existence and behavior of :meth:`__eq__`, and the values of + the ``eq`` and ``frozen`` flags in the :func:`dataclass` decorator. + + By default, :func:`dataclass` will not implicitly add a :meth:`__hash__` + method unless it is safe to do so. Neither will it add or change an + existing explicitly defined :meth:`__hash__` method. Setting the class + attribute ``__hash__ = None`` has a specific meaning to Python, as + described in the :meth:`__hash__` documentation. + + If :meth:`__hash__` is not explicit defined, or if it is set to ``None``, + then :func:`dataclass` *may* add an implicit :meth:`__hash__` method. + Although not recommended, you can force :func:`dataclass` to create a + :meth:`__hash__` method with ``unsafe_hash=True``. This might be the case + if your class is logically immutable but can nonetheless be mutated. + This is a specialized use case and should be considered carefully. + + Here are the rules governing implicit creation of a :meth:`__hash__` + method. Note that you cannot both have an explicit :meth:`__hash__` + method in your dataclass and set ``unsafe_hash=True``; this will result + in a :exc:`TypeError`. + + If ``eq`` and ``frozen`` are both true, by default :func:`dataclass` will + generate a :meth:`__hash__` method for you. If ``eq`` is true and + ``frozen`` is false, :meth:`__hash__` will be set to ``None``, marking it + unhashable (which it is, since it is mutable). If ``eq`` is false, + :meth:`__hash__` will be left untouched meaning the :meth:`__hash__` + method of the superclass will be used (if the superclass is + :class:`object`, this means it will fall back to id-based hashing). + + - ``frozen``: If true (the default is False), assigning to fields will + generate an exception. This emulates read-only frozen instances. If + :meth:`__setattr__` or :meth:`__delattr__` is defined in the class, then + :exc:`TypeError` is raised. See the discussion below. + + ``field``\s may optionally specify a default value, using normal + Python syntax:: + + @dataclass + class C: + a: int # 'a' has no default value + b: int = 0 # assign a default value for 'b' + + In this example, both ``a`` and ``b`` will be included in the added + :meth:`__init__` method, which will be defined as:: + + def __init__(self, a: int, b: int = 0): + + :exc:`TypeError` will be raised if a field without a default value + follows a field with a default value. This is true either when this + occurs in a single class, or as a result of class inheritance. + +.. function:: field(*, default=MISSING, default_factory=MISSING, repr=True, hash=None, init=True, compare=True, metadata=None) + + For common and simple use cases, no other functionality is + required. There are, however, some dataclass features that + require additional per-field information. To satisfy this need for + additional information, you can replace the default field value + with a call to the provided :func:`field` function. For example:: + + @dataclass + class C: + mylist: List[int] = field(default_factory=list) + + c = C() + c.mylist += [1, 2, 3] + + As shown above, the ``MISSING`` value is a sentinel object used to + detect if the ``default`` and ``default_factory`` parameters are + provided. This sentinel is used because ``None`` is a valid value + for ``default``. No code should directly use the ``MISSING`` + value. + + The parameters to :func:`field` are: + + - ``default``: If provided, this will be the default value for this + field. This is needed because the :meth:`field` call itself + replaces the normal position of the default value. + + - ``default_factory``: If provided, it must be a zero-argument + callable that will be called when a default value is needed for + this field. Among other purposes, this can be used to specify + fields with mutable default values, as discussed below. It is an + error to specify both ``default`` and ``default_factory``. + + - ``init``: If true (the default), this field is included as a + parameter to the generated :meth:`__init__` method. + + - ``repr``: If true (the default), this field is included in the + string returned by the generated :meth:`__repr__` method. + + - ``compare``: If true (the default), this field is included in the + generated equality and comparison methods (:meth:`__eq__`, + :meth:`__gt__`, et al.). + + - ``hash``: This can be a bool or ``None``. If true, this field is + included in the generated :meth:`__hash__` method. If ``None`` (the + default), use the value of ``compare``: this would normally be + the expected behavior. A field should be considered in the hash + if it's used for comparisons. Setting this value to anything + other than ``None`` is discouraged. + + One possible reason to set ``hash=False`` but ``compare=True`` + would be if a field is expensive to compute a hash value for, + that field is needed for equality testing, and there are other + fields that contribute to the type's hash value. Even if a field + is excluded from the hash, it will still be used for comparisons. + + - ``metadata``: This can be a mapping or None. None is treated as + an empty dict. This value is wrapped in + :func:`~types.MappingProxyType` to make it read-only, and exposed + on the :class:`Field` object. It is not used at all by Data + Classes, and is provided as a third-party extension mechanism. + Multiple third-parties can each have their own key, to use as a + namespace in the metadata. + + If the default value of a field is specified by a call to + :func:`field()`, then the class attribute for this field will be + replaced by the specified ``default`` value. If no ``default`` is + provided, then the class attribute will be deleted. The intent is + that after the :func:`dataclass` decorator runs, the class + attributes will all contain the default values for the fields, just + as if the default value itself were specified. For example, + after:: + + @dataclass + class C: + x: int + y: int = field(repr=False) + z: int = field(repr=False, default=10) + t: int = 20 + + The class attribute ``C.z`` will be ``10``, the class attribute + ``C.t`` will be ``20``, and the class attributes ``C.x`` and + ``C.y`` will not be set. + +.. class:: Field + + :class:`Field` objects describe each defined field. These objects + are created internally, and are returned by the :func:`fields` + module-level method (see below). Users should never instantiate a + :class:`Field` object directly. Its documented attributes are: + + - ``name``: The name of the field. + + - ``type``: The type of the field. + + - ``default``, ``default_factory``, ``init``, ``repr``, ``hash``, + ``compare``, and ``metadata`` have the identical meaning and + values as they do in the :func:`field` declaration. + + Other attributes may exist, but they are private and must not be + inspected or relied on. + +.. function:: fields(class_or_instance) + + Returns a tuple of :class:`Field` objects that define the fields for this + dataclass. Accepts either a dataclass, or an instance of a dataclass. + Raises :exc:`TypeError` if not passed a dataclass or instance of one. + Does not return pseudo-fields which are ``ClassVar`` or ``InitVar``. + +.. function:: asdict(instance, *, dict_factory=dict) + + Converts the dataclass ``instance`` to a dict (by using the + factory function ``dict_factory``). Each dataclass is converted + to a dict of its fields, as ``name: value`` pairs. dataclasses, dicts, + lists, and tuples are recursed into. For example:: + + @dataclass + class Point: + x: int + y: int + + @dataclass + class C: + mylist: List[Point] + + p = Point(10, 20) + assert asdict(p) == {'x': 10, 'y': 20} + + c = C([Point(0, 0), Point(10, 4)]) + assert asdict(c) == {'mylist': [{'x': 0, 'y': 0}, {'x': 10, 'y': 4}]} + + Raises :exc:`TypeError` if ``instance`` is not a dataclass instance. + +.. function:: astuple(instance, *, tuple_factory=tuple) + + Converts the dataclass ``instance`` to a tuple (by using the + factory function ``tuple_factory``). Each dataclass is converted + to a tuple of its field values. dataclasses, dicts, lists, and + tuples are recursed into. + + Continuing from the previous example:: + + assert astuple(p) == (10, 20) + assert astuple(c) == ([(0, 0), (10, 4)],) + + Raises :exc:`TypeError` if ``instance`` is not a dataclass instance. + +.. function:: make_dataclass(cls_name, fields, *, bases=(), namespace=None, init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False) + + Creates a new dataclass with name ``cls_name``, fields as defined + in ``fields``, base classes as given in ``bases``, and initialized + with a namespace as given in ``namespace``. ``fields`` is an + iterable whose elements are each either ``name``, ``(name, type)``, + or ``(name, type, Field)``. If just ``name`` is supplied, + ``typing.Any`` is used for ``type``. The values of ``init``, + ``repr``, ``eq``, ``order``, ``unsafe_hash``, and ``frozen`` have + the same meaning as they do in :func:`dataclass`. + + This function is not strictly required, because any Python + mechanism for creating a new class with ``__annotations__`` can + then apply the :func:`dataclass` function to convert that class to + a dataclass. This function is provided as a convenience. For + example:: + + C = make_dataclass('C', + [('x', int), + 'y', + ('z', int, field(default=5))], + namespace={'add_one': lambda self: self.x + 1}) + + Is equivalent to:: + + @dataclass + class C: + x: int + y: 'typing.Any' + z: int = 5 + + def add_one(self): + return self.x + 1 + +.. function:: replace(instance, **changes) + + Creates a new object of the same type of ``instance``, replacing + fields with values from ``changes``. If ``instance`` is not a Data + Class, raises :exc:`TypeError`. If values in ``changes`` do not + specify fields, raises :exc:`TypeError`. + + The newly returned object is created by calling the :meth:`__init__` + method of the dataclass. This ensures that + :meth:`__post_init__`, if present, is also called. + + Init-only variables without default values, if any exist, must be + specified on the call to :func:`replace` so that they can be passed to + :meth:`__init__` and :meth:`__post_init__`. + + It is an error for ``changes`` to contain any fields that are + defined as having ``init=False``. A :exc:`ValueError` will be raised + in this case. + + Be forewarned about how ``init=False`` fields work during a call to + :func:`replace`. They are not copied from the source object, but + rather are initialized in :meth:`__post_init__`, if they're + initialized at all. It is expected that ``init=False`` fields will + be rarely and judiciously used. If they are used, it might be wise + to have alternate class constructors, or perhaps a custom + ``replace()`` (or similarly named) method which handles instance + copying. + +.. function:: is_dataclass(class_or_instance) + + Returns True if its parameter is a dataclass or an instance of one, + otherwise returns False. + + If you need to know if a class is an instance of a dataclass (and + not a dataclass itself), then add a further check for ``not + isinstance(obj, type)``:: + + def is_dataclass_instance(obj): + return is_dataclass(obj) and not isinstance(obj, type) + +Post-init processing +-------------------- + +The generated :meth:`__init__` code will call a method named +:meth:`__post_init__`, if :meth:`__post_init__` is defined on the +class. It will normally be called as ``self.__post_init__()``. +However, if any ``InitVar`` fields are defined, they will also be +passed to :meth:`__post_init__` in the order they were defined in the +class. If no :meth:`__init__` method is generated, then +:meth:`__post_init__` will not automatically be called. + +Among other uses, this allows for initializing field values that +depend on one or more other fields. For example:: + + @dataclass + class C: + a: float + b: float + c: float = field(init=False) + + def __post_init__(self): + self.c = self.a + self.b + +See the section below on init-only variables for ways to pass +parameters to :meth:`__post_init__`. Also see the warning about how +:func:`replace` handles ``init=False`` fields. + +Class variables +--------------- + +One of two places where :func:`dataclass` actually inspects the type +of a field is to determine if a field is a class variable as defined +in :pep:`526`. It does this by checking if the type of the field is +``typing.ClassVar``. If a field is a ``ClassVar``, it is excluded +from consideration as a field and is ignored by the dataclass +mechanisms. Such ``ClassVar`` pseudo-fields are not returned by the +module-level :func:`fields` function. + +Init-only variables +------------------- + +The other place where :func:`dataclass` inspects a type annotation is to +determine if a field is an init-only variable. It does this by seeing +if the type of a field is of type ``dataclasses.InitVar``. If a field +is an ``InitVar``, it is considered a pseudo-field called an init-only +field. As it is not a true field, it is not returned by the +module-level :func:`fields` function. Init-only fields are added as +parameters to the generated :meth:`__init__` method, and are passed to +the optional :meth:`__post_init__` method. They are not otherwise used +by dataclasses. + +For example, suppose a field will be initialized from a database, if a +value is not provided when creating the class:: + + @dataclass + class C: + i: int + j: int = None + database: InitVar[DatabaseType] = None + + def __post_init__(self, database): + if self.j is None and database is not None: + self.j = database.lookup('j') + + c = C(10, database=my_database) + +In this case, :func:`fields` will return :class:`Field` objects for ``i`` and +``j``, but not for ``database``. + +Frozen instances +---------------- + +It is not possible to create truly immutable Python objects. However, +by passing ``frozen=True`` to the :meth:`dataclass` decorator you can +emulate immutability. In that case, dataclasses will add +:meth:`__setattr__` and :meth:`__delattr__` methods to the class. These +methods will raise a :exc:`FrozenInstanceError` when invoked. + +There is a tiny performance penalty when using ``frozen=True``: +:meth:`__init__` cannot use simple assignment to initialize fields, and +must use :meth:`object.__setattr__`. + +Inheritance +----------- + +When the dataclass is being created by the :meth:`dataclass` decorator, +it looks through all of the class's base classes in reverse MRO (that +is, starting at :class:`object`) and, for each dataclass that it finds, +adds the fields from that base class to an ordered mapping of fields. +After all of the base class fields are added, it adds its own fields +to the ordered mapping. All of the generated methods will use this +combined, calculated ordered mapping of fields. Because the fields +are in insertion order, derived classes override base classes. An +example:: + + @dataclass + class Base: + x: Any = 15.0 + y: int = 0 + + @dataclass + class C(Base): + z: int = 10 + x: int = 15 + +The final list of fields is, in order, ``x``, ``y``, ``z``. The final +type of ``x`` is ``int``, as specified in class ``C``. + +The generated :meth:`__init__` method for ``C`` will look like:: + + def __init__(self, x: int = 15, y: int = 0, z: int = 10): + +Default factory functions +------------------------- + + If a :func:`field` specifies a ``default_factory``, it is called with + zero arguments when a default value for the field is needed. For + example, to create a new instance of a list, use:: + + mylist: list = field(default_factory=list) + + If a field is excluded from :meth:`__init__` (using ``init=False``) + and the field also specifies ``default_factory``, then the default + factory function will always be called from the generated + :meth:`__init__` function. This happens because there is no other + way to give the field an initial value. + +Mutable default values +---------------------- + + Python stores default member variable values in class attributes. + Consider this example, not using dataclasses:: + + class C: + x = [] + def add(self, element): + self.x.append(element) + + o1 = C() + o2 = C() + o1.add(1) + o2.add(2) + assert o1.x == [1, 2] + assert o1.x is o2.x + + Note that the two instances of class ``C`` share the same class + variable ``x``, as expected. + + Using dataclasses, *if* this code was valid:: + + @dataclass + class D: + x: List = [] + def add(self, element): + self.x += element + + it would generate code similar to:: + + class D: + x = [] + def __init__(self, x=x): + self.x = x + def add(self, element): + self.x += element + + assert D().x is D().x + + This has the same issue as the original example using class ``C``. + That is, two instances of class ``D`` that do not specify a value for + ``x`` when creating a class instance will share the same copy of + ``x``. Because dataclasses just use normal Python class creation + they also share this behavior. There is no general way for Data + Classes to detect this condition. Instead, dataclasses will raise a + :exc:`TypeError` if it detects a default parameter of type ``list``, + ``dict``, or ``set``. This is a partial solution, but it does protect + against many common errors. + + Using default factory functions is a way to create new instances of + mutable types as default values for fields:: + + @dataclass + class D: + x: list = field(default_factory=list) + + assert D().x is not D().x + +Exceptions +---------- + +.. exception:: FrozenInstanceError + + Raised when an implicitly defined :meth:`__setattr__` or + :meth:`__delattr__` is called on a dataclass which was defined with + ``frozen=True``. diff --git a/python-3.7.4-docs-html/_sources/library/datatypes.rst.txt b/python-3.7.4-docs-html/_sources/library/datatypes.rst.txt new file mode 100644 index 0000000..48af082 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/datatypes.rst.txt @@ -0,0 +1,33 @@ +.. _datatypes: + +********** +Data Types +********** + +The modules described in this chapter provide a variety of specialized data +types such as dates and times, fixed-type arrays, heap queues, synchronized +queues, and sets. + +Python also provides some built-in data types, in particular, +:class:`dict`, :class:`list`, :class:`set` and :class:`frozenset`, and +:class:`tuple`. The :class:`str` class is used to hold +Unicode strings, and the :class:`bytes` class is used to hold binary data. + +The following modules are documented in this chapter: + + +.. toctree:: + + datetime.rst + calendar.rst + collections.rst + collections.abc.rst + heapq.rst + bisect.rst + array.rst + weakref.rst + types.rst + copy.rst + pprint.rst + reprlib.rst + enum.rst diff --git a/python-3.7.4-docs-html/_sources/library/datetime.rst.txt b/python-3.7.4-docs-html/_sources/library/datetime.rst.txt new file mode 100644 index 0000000..270b238 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/datetime.rst.txt @@ -0,0 +1,2285 @@ +:mod:`datetime` --- Basic date and time types +============================================= + +.. module:: datetime + :synopsis: Basic date and time types. + +.. moduleauthor:: Tim Peters +.. sectionauthor:: Tim Peters +.. sectionauthor:: A.M. Kuchling + +**Source code:** :source:`Lib/datetime.py` + +-------------- + +.. XXX what order should the types be discussed in? + +The :mod:`datetime` module supplies classes for manipulating dates and times in +both simple and complex ways. While date and time arithmetic is supported, the +focus of the implementation is on efficient attribute extraction for output +formatting and manipulation. For related functionality, see also the +:mod:`time` and :mod:`calendar` modules. + +There are two kinds of date and time objects: "naive" and "aware". + +An aware object has sufficient knowledge of applicable algorithmic and +political time adjustments, such as time zone and daylight saving time +information, to locate itself relative to other aware objects. An aware object +is used to represent a specific moment in time that is not open to +interpretation [#]_. + +A naive object does not contain enough information to unambiguously locate +itself relative to other date/time objects. Whether a naive object represents +Coordinated Universal Time (UTC), local time, or time in some other timezone is +purely up to the program, just like it is up to the program whether a +particular number represents metres, miles, or mass. Naive objects are easy to +understand and to work with, at the cost of ignoring some aspects of reality. + +For applications requiring aware objects, :class:`.datetime` and :class:`.time` +objects have an optional time zone information attribute, :attr:`!tzinfo`, that +can be set to an instance of a subclass of the abstract :class:`tzinfo` class. +These :class:`tzinfo` objects capture information about the offset from UTC +time, the time zone name, and whether Daylight Saving Time is in effect. Note +that only one concrete :class:`tzinfo` class, the :class:`timezone` class, is +supplied by the :mod:`datetime` module. The :class:`timezone` class can +represent simple timezones with fixed offset from UTC, such as UTC itself or +North American EST and EDT timezones. Supporting timezones at deeper levels of +detail is up to the application. The rules for time adjustment across the +world are more political than rational, change frequently, and there is no +standard suitable for every application aside from UTC. + +The :mod:`datetime` module exports the following constants: + +.. data:: MINYEAR + + The smallest year number allowed in a :class:`date` or :class:`.datetime` object. + :const:`MINYEAR` is ``1``. + + +.. data:: MAXYEAR + + The largest year number allowed in a :class:`date` or :class:`.datetime` object. + :const:`MAXYEAR` is ``9999``. + + +.. seealso:: + + Module :mod:`calendar` + General calendar related functions. + + Module :mod:`time` + Time access and conversions. + + +Available Types +--------------- + +.. class:: date + :noindex: + + An idealized naive date, assuming the current Gregorian calendar always was, and + always will be, in effect. Attributes: :attr:`year`, :attr:`month`, and + :attr:`day`. + + +.. class:: time + :noindex: + + An idealized time, independent of any particular day, assuming that every day + has exactly 24\*60\*60 seconds (there is no notion of "leap seconds" here). + Attributes: :attr:`hour`, :attr:`minute`, :attr:`second`, :attr:`microsecond`, + and :attr:`.tzinfo`. + + +.. class:: datetime + :noindex: + + A combination of a date and a time. Attributes: :attr:`year`, :attr:`month`, + :attr:`day`, :attr:`hour`, :attr:`minute`, :attr:`second`, :attr:`microsecond`, + and :attr:`.tzinfo`. + + +.. class:: timedelta + :noindex: + + A duration expressing the difference between two :class:`date`, :class:`.time`, + or :class:`.datetime` instances to microsecond resolution. + + +.. class:: tzinfo + :noindex: + + An abstract base class for time zone information objects. These are used by the + :class:`.datetime` and :class:`.time` classes to provide a customizable notion of + time adjustment (for example, to account for time zone and/or daylight saving + time). + +.. class:: timezone + :noindex: + + A class that implements the :class:`tzinfo` abstract base class as a + fixed offset from the UTC. + + .. versionadded:: 3.2 + + +Objects of these types are immutable. + +Objects of the :class:`date` type are always naive. + +An object of type :class:`.time` or :class:`.datetime` may be naive or aware. +A :class:`.datetime` object *d* is aware if ``d.tzinfo`` is not ``None`` and +``d.tzinfo.utcoffset(d)`` does not return ``None``. If ``d.tzinfo`` is +``None``, or if ``d.tzinfo`` is not ``None`` but ``d.tzinfo.utcoffset(d)`` +returns ``None``, *d* is naive. A :class:`.time` object *t* is aware +if ``t.tzinfo`` is not ``None`` and ``t.tzinfo.utcoffset(None)`` does not return +``None``. Otherwise, *t* is naive. + +The distinction between naive and aware doesn't apply to :class:`timedelta` +objects. + +Subclass relationships:: + + object + timedelta + tzinfo + timezone + time + date + datetime + + +.. _datetime-timedelta: + +:class:`timedelta` Objects +-------------------------- + +A :class:`timedelta` object represents a duration, the difference between two +dates or times. + +.. class:: timedelta(days=0, seconds=0, microseconds=0, milliseconds=0, minutes=0, hours=0, weeks=0) + + All arguments are optional and default to ``0``. Arguments may be integers + or floats, and may be positive or negative. + + Only *days*, *seconds* and *microseconds* are stored internally. Arguments are + converted to those units: + + * A millisecond is converted to 1000 microseconds. + * A minute is converted to 60 seconds. + * An hour is converted to 3600 seconds. + * A week is converted to 7 days. + + and days, seconds and microseconds are then normalized so that the + representation is unique, with + + * ``0 <= microseconds < 1000000`` + * ``0 <= seconds < 3600*24`` (the number of seconds in one day) + * ``-999999999 <= days <= 999999999`` + + If any argument is a float and there are fractional microseconds, + the fractional microseconds left over from all arguments are + combined and their sum is rounded to the nearest microsecond using + round-half-to-even tiebreaker. If no argument is a float, the + conversion and normalization processes are exact (no information is + lost). + + If the normalized value of days lies outside the indicated range, + :exc:`OverflowError` is raised. + + Note that normalization of negative values may be surprising at first. For + example, + + >>> from datetime import timedelta + >>> d = timedelta(microseconds=-1) + >>> (d.days, d.seconds, d.microseconds) + (-1, 86399, 999999) + + +Class attributes are: + +.. attribute:: timedelta.min + + The most negative :class:`timedelta` object, ``timedelta(-999999999)``. + + +.. attribute:: timedelta.max + + The most positive :class:`timedelta` object, ``timedelta(days=999999999, + hours=23, minutes=59, seconds=59, microseconds=999999)``. + + +.. attribute:: timedelta.resolution + + The smallest possible difference between non-equal :class:`timedelta` objects, + ``timedelta(microseconds=1)``. + +Note that, because of normalization, ``timedelta.max`` > ``-timedelta.min``. +``-timedelta.max`` is not representable as a :class:`timedelta` object. + +Instance attributes (read-only): + ++------------------+--------------------------------------------+ +| Attribute | Value | ++==================+============================================+ +| ``days`` | Between -999999999 and 999999999 inclusive | ++------------------+--------------------------------------------+ +| ``seconds`` | Between 0 and 86399 inclusive | ++------------------+--------------------------------------------+ +| ``microseconds`` | Between 0 and 999999 inclusive | ++------------------+--------------------------------------------+ + +Supported operations: + +.. XXX this table is too wide! + ++--------------------------------+-----------------------------------------------+ +| Operation | Result | ++================================+===============================================+ +| ``t1 = t2 + t3`` | Sum of *t2* and *t3*. Afterwards *t1*-*t2* == | +| | *t3* and *t1*-*t3* == *t2* are true. (1) | ++--------------------------------+-----------------------------------------------+ +| ``t1 = t2 - t3`` | Difference of *t2* and *t3*. Afterwards *t1* | +| | == *t2* - *t3* and *t2* == *t1* + *t3* are | +| | true. (1)(6) | ++--------------------------------+-----------------------------------------------+ +| ``t1 = t2 * i or t1 = i * t2`` | Delta multiplied by an integer. | +| | Afterwards *t1* // i == *t2* is true, | +| | provided ``i != 0``. | ++--------------------------------+-----------------------------------------------+ +| | In general, *t1* \* i == *t1* \* (i-1) + *t1* | +| | is true. (1) | ++--------------------------------+-----------------------------------------------+ +| ``t1 = t2 * f or t1 = f * t2`` | Delta multiplied by a float. The result is | +| | rounded to the nearest multiple of | +| | timedelta.resolution using round-half-to-even.| ++--------------------------------+-----------------------------------------------+ +| ``f = t2 / t3`` | Division (3) of overall duration *t2* by | +| | interval unit *t3*. Returns a :class:`float` | +| | object. | ++--------------------------------+-----------------------------------------------+ +| ``t1 = t2 / f or t1 = t2 / i`` | Delta divided by a float or an int. The result| +| | is rounded to the nearest multiple of | +| | timedelta.resolution using round-half-to-even.| ++--------------------------------+-----------------------------------------------+ +| ``t1 = t2 // i`` or | The floor is computed and the remainder (if | +| ``t1 = t2 // t3`` | any) is thrown away. In the second case, an | +| | integer is returned. (3) | ++--------------------------------+-----------------------------------------------+ +| ``t1 = t2 % t3`` | The remainder is computed as a | +| | :class:`timedelta` object. (3) | ++--------------------------------+-----------------------------------------------+ +| ``q, r = divmod(t1, t2)`` | Computes the quotient and the remainder: | +| | ``q = t1 // t2`` (3) and ``r = t1 % t2``. | +| | q is an integer and r is a :class:`timedelta` | +| | object. | ++--------------------------------+-----------------------------------------------+ +| ``+t1`` | Returns a :class:`timedelta` object with the | +| | same value. (2) | ++--------------------------------+-----------------------------------------------+ +| ``-t1`` | equivalent to | +| | :class:`timedelta`\ (-*t1.days*, | +| | -*t1.seconds*, -*t1.microseconds*), | +| | and to *t1*\* -1. (1)(4) | ++--------------------------------+-----------------------------------------------+ +| ``abs(t)`` | equivalent to +\ *t* when ``t.days >= 0``, and| +| | to -*t* when ``t.days < 0``. (2) | ++--------------------------------+-----------------------------------------------+ +| ``str(t)`` | Returns a string in the form | +| | ``[D day[s], ][H]H:MM:SS[.UUUUUU]``, where D | +| | is negative for negative ``t``. (5) | ++--------------------------------+-----------------------------------------------+ +| ``repr(t)`` | Returns a string representation of the | +| | :class:`timedelta` object as a constructor | +| | call with canonical attribute values. | ++--------------------------------+-----------------------------------------------+ + + +Notes: + +(1) + This is exact, but may overflow. + +(2) + This is exact, and cannot overflow. + +(3) + Division by 0 raises :exc:`ZeroDivisionError`. + +(4) + -*timedelta.max* is not representable as a :class:`timedelta` object. + +(5) + String representations of :class:`timedelta` objects are normalized + similarly to their internal representation. This leads to somewhat + unusual results for negative timedeltas. For example: + + >>> timedelta(hours=-5) + datetime.timedelta(days=-1, seconds=68400) + >>> print(_) + -1 day, 19:00:00 + +(6) + The expression ``t2 - t3`` will always be equal to the expression ``t2 + (-t3)`` except + when t3 is equal to ``timedelta.max``; in that case the former will produce a result + while the latter will overflow. + +In addition to the operations listed above :class:`timedelta` objects support +certain additions and subtractions with :class:`date` and :class:`.datetime` +objects (see below). + +.. versionchanged:: 3.2 + Floor division and true division of a :class:`timedelta` object by another + :class:`timedelta` object are now supported, as are remainder operations and + the :func:`divmod` function. True division and multiplication of a + :class:`timedelta` object by a :class:`float` object are now supported. + + +Comparisons of :class:`timedelta` objects are supported with the +:class:`timedelta` object representing the smaller duration considered to be the +smaller timedelta. In order to stop mixed-type comparisons from falling back to +the default comparison by object address, when a :class:`timedelta` object is +compared to an object of a different type, :exc:`TypeError` is raised unless the +comparison is ``==`` or ``!=``. The latter cases return :const:`False` or +:const:`True`, respectively. + +:class:`timedelta` objects are :term:`hashable` (usable as dictionary keys), support +efficient pickling, and in Boolean contexts, a :class:`timedelta` object is +considered to be true if and only if it isn't equal to ``timedelta(0)``. + +Instance methods: + +.. method:: timedelta.total_seconds() + + Return the total number of seconds contained in the duration. Equivalent to + ``td / timedelta(seconds=1)``. For interval units other than seconds, use the + division form directly (e.g. ``td / timedelta(microseconds=1)``). + + Note that for very large time intervals (greater than 270 years on + most platforms) this method will lose microsecond accuracy. + + .. versionadded:: 3.2 + + +Example usage: + + >>> from datetime import timedelta + >>> year = timedelta(days=365) + >>> another_year = timedelta(weeks=40, days=84, hours=23, + ... minutes=50, seconds=600) # adds up to 365 days + >>> year.total_seconds() + 31536000.0 + >>> year == another_year + True + >>> ten_years = 10 * year + >>> ten_years, ten_years.days // 365 + (datetime.timedelta(days=3650), 10) + >>> nine_years = ten_years - year + >>> nine_years, nine_years.days // 365 + (datetime.timedelta(days=3285), 9) + >>> three_years = nine_years // 3 + >>> three_years, three_years.days // 365 + (datetime.timedelta(days=1095), 3) + >>> abs(three_years - ten_years) == 2 * three_years + year + True + + +.. _datetime-date: + +:class:`date` Objects +--------------------- + +A :class:`date` object represents a date (year, month and day) in an idealized +calendar, the current Gregorian calendar indefinitely extended in both +directions. January 1 of year 1 is called day number 1, January 2 of year 1 is +called day number 2, and so on. This matches the definition of the "proleptic +Gregorian" calendar in Dershowitz and Reingold's book Calendrical Calculations, +where it's the base calendar for all computations. See the book for algorithms +for converting between proleptic Gregorian ordinals and many other calendar +systems. + + +.. class:: date(year, month, day) + + All arguments are required. Arguments may be integers, in the following + ranges: + + * ``MINYEAR <= year <= MAXYEAR`` + * ``1 <= month <= 12`` + * ``1 <= day <= number of days in the given month and year`` + + If an argument outside those ranges is given, :exc:`ValueError` is raised. + + +Other constructors, all class methods: + +.. classmethod:: date.today() + + Return the current local date. This is equivalent to + ``date.fromtimestamp(time.time())``. + + +.. classmethod:: date.fromtimestamp(timestamp) + + Return the local date corresponding to the POSIX timestamp, such as is returned + by :func:`time.time`. This may raise :exc:`OverflowError`, if the timestamp is out + of the range of values supported by the platform C :c:func:`localtime` function, + and :exc:`OSError` on :c:func:`localtime` failure. + It's common for this to be restricted to years from 1970 through 2038. Note + that on non-POSIX systems that include leap seconds in their notion of a + timestamp, leap seconds are ignored by :meth:`fromtimestamp`. + + .. versionchanged:: 3.3 + Raise :exc:`OverflowError` instead of :exc:`ValueError` if the timestamp + is out of the range of values supported by the platform C + :c:func:`localtime` function. Raise :exc:`OSError` instead of + :exc:`ValueError` on :c:func:`localtime` failure. + + +.. classmethod:: date.fromordinal(ordinal) + + Return the date corresponding to the proleptic Gregorian ordinal, where January + 1 of year 1 has ordinal 1. :exc:`ValueError` is raised unless ``1 <= ordinal <= + date.max.toordinal()``. For any date *d*, ``date.fromordinal(d.toordinal()) == + d``. + + +.. classmethod:: date.fromisoformat(date_string) + + Return a :class:`date` corresponding to a *date_string* in the format emitted + by :meth:`date.isoformat`. Specifically, this function supports strings in + the format(s) ``YYYY-MM-DD``. + + .. caution:: + + This does not support parsing arbitrary ISO 8601 strings - it is only intended + as the inverse operation of :meth:`date.isoformat`. + + .. versionadded:: 3.7 + + + +Class attributes: + +.. attribute:: date.min + + The earliest representable date, ``date(MINYEAR, 1, 1)``. + + +.. attribute:: date.max + + The latest representable date, ``date(MAXYEAR, 12, 31)``. + + +.. attribute:: date.resolution + + The smallest possible difference between non-equal date objects, + ``timedelta(days=1)``. + + +Instance attributes (read-only): + +.. attribute:: date.year + + Between :const:`MINYEAR` and :const:`MAXYEAR` inclusive. + + +.. attribute:: date.month + + Between 1 and 12 inclusive. + + +.. attribute:: date.day + + Between 1 and the number of days in the given month of the given year. + + +Supported operations: + ++-------------------------------+----------------------------------------------+ +| Operation | Result | ++===============================+==============================================+ +| ``date2 = date1 + timedelta`` | *date2* is ``timedelta.days`` days removed | +| | from *date1*. (1) | ++-------------------------------+----------------------------------------------+ +| ``date2 = date1 - timedelta`` | Computes *date2* such that ``date2 + | +| | timedelta == date1``. (2) | ++-------------------------------+----------------------------------------------+ +| ``timedelta = date1 - date2`` | \(3) | ++-------------------------------+----------------------------------------------+ +| ``date1 < date2`` | *date1* is considered less than *date2* when | +| | *date1* precedes *date2* in time. (4) | ++-------------------------------+----------------------------------------------+ + +Notes: + +(1) + *date2* is moved forward in time if ``timedelta.days > 0``, or backward if + ``timedelta.days < 0``. Afterward ``date2 - date1 == timedelta.days``. + ``timedelta.seconds`` and ``timedelta.microseconds`` are ignored. + :exc:`OverflowError` is raised if ``date2.year`` would be smaller than + :const:`MINYEAR` or larger than :const:`MAXYEAR`. + +(2) + ``timedelta.seconds`` and ``timedelta.microseconds`` are ignored. + +(3) + This is exact, and cannot overflow. timedelta.seconds and + timedelta.microseconds are 0, and date2 + timedelta == date1 after. + +(4) + In other words, ``date1 < date2`` if and only if ``date1.toordinal() < + date2.toordinal()``. Date comparison raises :exc:`TypeError` if + the other comparand isn't also a :class:`date` object. However, + ``NotImplemented`` is returned instead if the other comparand has a + :meth:`timetuple` attribute. This hook gives other kinds of date objects a + chance at implementing mixed-type comparison. If not, when a :class:`date` + object is compared to an object of a different type, :exc:`TypeError` is raised + unless the comparison is ``==`` or ``!=``. The latter cases return + :const:`False` or :const:`True`, respectively. + +Dates can be used as dictionary keys. In Boolean contexts, all :class:`date` +objects are considered to be true. + +Instance methods: + +.. method:: date.replace(year=self.year, month=self.month, day=self.day) + + Return a date with the same value, except for those parameters given new + values by whichever keyword arguments are specified. For example, if ``d == + date(2002, 12, 31)``, then ``d.replace(day=26) == date(2002, 12, 26)``. + + +.. method:: date.timetuple() + + Return a :class:`time.struct_time` such as returned by :func:`time.localtime`. + The hours, minutes and seconds are 0, and the DST flag is -1. ``d.timetuple()`` + is equivalent to ``time.struct_time((d.year, d.month, d.day, 0, 0, 0, + d.weekday(), yday, -1))``, where ``yday = d.toordinal() - date(d.year, 1, + 1).toordinal() + 1`` is the day number within the current year starting with + ``1`` for January 1st. + + +.. method:: date.toordinal() + + Return the proleptic Gregorian ordinal of the date, where January 1 of year 1 + has ordinal 1. For any :class:`date` object *d*, + ``date.fromordinal(d.toordinal()) == d``. + + +.. method:: date.weekday() + + Return the day of the week as an integer, where Monday is 0 and Sunday is 6. + For example, ``date(2002, 12, 4).weekday() == 2``, a Wednesday. See also + :meth:`isoweekday`. + + +.. method:: date.isoweekday() + + Return the day of the week as an integer, where Monday is 1 and Sunday is 7. + For example, ``date(2002, 12, 4).isoweekday() == 3``, a Wednesday. See also + :meth:`weekday`, :meth:`isocalendar`. + + +.. method:: date.isocalendar() + + Return a 3-tuple, (ISO year, ISO week number, ISO weekday). + + The ISO calendar is a widely used variant of the Gregorian calendar. See + https://www.staff.science.uu.nl/~gent0113/calendar/isocalendar.htm for a good + explanation. + + The ISO year consists of 52 or 53 full weeks, and where a week starts on a + Monday and ends on a Sunday. The first week of an ISO year is the first + (Gregorian) calendar week of a year containing a Thursday. This is called week + number 1, and the ISO year of that Thursday is the same as its Gregorian year. + + For example, 2004 begins on a Thursday, so the first week of ISO year 2004 + begins on Monday, 29 Dec 2003 and ends on Sunday, 4 Jan 2004, so that + ``date(2003, 12, 29).isocalendar() == (2004, 1, 1)`` and ``date(2004, 1, + 4).isocalendar() == (2004, 1, 7)``. + + +.. method:: date.isoformat() + + Return a string representing the date in ISO 8601 format, 'YYYY-MM-DD'. For + example, ``date(2002, 12, 4).isoformat() == '2002-12-04'``. + + +.. method:: date.__str__() + + For a date *d*, ``str(d)`` is equivalent to ``d.isoformat()``. + + +.. method:: date.ctime() + + Return a string representing the date, for example ``date(2002, 12, + 4).ctime() == 'Wed Dec 4 00:00:00 2002'``. ``d.ctime()`` is equivalent to + ``time.ctime(time.mktime(d.timetuple()))`` on platforms where the native C + :c:func:`ctime` function (which :func:`time.ctime` invokes, but which + :meth:`date.ctime` does not invoke) conforms to the C standard. + + +.. method:: date.strftime(format) + + Return a string representing the date, controlled by an explicit format string. + Format codes referring to hours, minutes or seconds will see 0 values. For a + complete list of formatting directives, see + :ref:`strftime-strptime-behavior`. + + +.. method:: date.__format__(format) + + Same as :meth:`.date.strftime`. This makes it possible to specify a format + string for a :class:`.date` object in :ref:`formatted string + literals ` and when using :meth:`str.format`. For a + complete list of formatting directives, see + :ref:`strftime-strptime-behavior`. + + +Example of counting days to an event:: + + >>> import time + >>> from datetime import date + >>> today = date.today() + >>> today + datetime.date(2007, 12, 5) + >>> today == date.fromtimestamp(time.time()) + True + >>> my_birthday = date(today.year, 6, 24) + >>> if my_birthday < today: + ... my_birthday = my_birthday.replace(year=today.year + 1) + >>> my_birthday + datetime.date(2008, 6, 24) + >>> time_to_birthday = abs(my_birthday - today) + >>> time_to_birthday.days + 202 + +Example of working with :class:`date`: + +.. doctest:: + + >>> from datetime import date + >>> d = date.fromordinal(730920) # 730920th day after 1. 1. 0001 + >>> d + datetime.date(2002, 3, 11) + >>> t = d.timetuple() + >>> for i in t: # doctest: +SKIP + ... print(i) + 2002 # year + 3 # month + 11 # day + 0 + 0 + 0 + 0 # weekday (0 = Monday) + 70 # 70th day in the year + -1 + >>> ic = d.isocalendar() + >>> for i in ic: # doctest: +SKIP + ... print(i) + 2002 # ISO year + 11 # ISO week number + 1 # ISO day number ( 1 = Monday ) + >>> d.isoformat() + '2002-03-11' + >>> d.strftime("%d/%m/%y") + '11/03/02' + >>> d.strftime("%A %d. %B %Y") + 'Monday 11. March 2002' + >>> 'The {1} is {0:%d}, the {2} is {0:%B}.'.format(d, "day", "month") + 'The day is 11, the month is March.' + + +.. _datetime-datetime: + +:class:`.datetime` Objects +-------------------------- + +A :class:`.datetime` object is a single object containing all the information +from a :class:`date` object and a :class:`.time` object. Like a :class:`date` +object, :class:`.datetime` assumes the current Gregorian calendar extended in +both directions; like a time object, :class:`.datetime` assumes there are exactly +3600\*24 seconds in every day. + +Constructor: + +.. class:: datetime(year, month, day, hour=0, minute=0, second=0, microsecond=0, tzinfo=None, *, fold=0) + + The year, month and day arguments are required. *tzinfo* may be ``None``, or an + instance of a :class:`tzinfo` subclass. The remaining arguments may be integers, + in the following ranges: + + * ``MINYEAR <= year <= MAXYEAR``, + * ``1 <= month <= 12``, + * ``1 <= day <= number of days in the given month and year``, + * ``0 <= hour < 24``, + * ``0 <= minute < 60``, + * ``0 <= second < 60``, + * ``0 <= microsecond < 1000000``, + * ``fold in [0, 1]``. + + If an argument outside those ranges is given, :exc:`ValueError` is raised. + + .. versionadded:: 3.6 + Added the ``fold`` argument. + +Other constructors, all class methods: + +.. classmethod:: datetime.today() + + Return the current local datetime, with :attr:`.tzinfo` ``None``. This is + equivalent to ``datetime.fromtimestamp(time.time())``. See also :meth:`now`, + :meth:`fromtimestamp`. + + +.. classmethod:: datetime.now(tz=None) + + Return the current local date and time. If optional argument *tz* is ``None`` + or not specified, this is like :meth:`today`, but, if possible, supplies more + precision than can be gotten from going through a :func:`time.time` timestamp + (for example, this may be possible on platforms supplying the C + :c:func:`gettimeofday` function). + + If *tz* is not ``None``, it must be an instance of a :class:`tzinfo` subclass, and the + current date and time are converted to *tz*’s time zone. In this case the + result is equivalent to ``tz.fromutc(datetime.utcnow().replace(tzinfo=tz))``. + See also :meth:`today`, :meth:`utcnow`. + + +.. classmethod:: datetime.utcnow() + + Return the current UTC date and time, with :attr:`.tzinfo` ``None``. This is like + :meth:`now`, but returns the current UTC date and time, as a naive + :class:`.datetime` object. An aware current UTC datetime can be obtained by + calling ``datetime.now(timezone.utc)``. See also :meth:`now`. + +.. classmethod:: datetime.fromtimestamp(timestamp, tz=None) + + Return the local date and time corresponding to the POSIX timestamp, such as is + returned by :func:`time.time`. If optional argument *tz* is ``None`` or not + specified, the timestamp is converted to the platform's local date and time, and + the returned :class:`.datetime` object is naive. + + If *tz* is not ``None``, it must be an instance of a :class:`tzinfo` subclass, and the + timestamp is converted to *tz*’s time zone. In this case the result is + equivalent to + ``tz.fromutc(datetime.utcfromtimestamp(timestamp).replace(tzinfo=tz))``. + + :meth:`fromtimestamp` may raise :exc:`OverflowError`, if the timestamp is out of + the range of values supported by the platform C :c:func:`localtime` or + :c:func:`gmtime` functions, and :exc:`OSError` on :c:func:`localtime` or + :c:func:`gmtime` failure. + It's common for this to be restricted to years in + 1970 through 2038. Note that on non-POSIX systems that include leap seconds in + their notion of a timestamp, leap seconds are ignored by :meth:`fromtimestamp`, + and then it's possible to have two timestamps differing by a second that yield + identical :class:`.datetime` objects. See also :meth:`utcfromtimestamp`. + + .. versionchanged:: 3.3 + Raise :exc:`OverflowError` instead of :exc:`ValueError` if the timestamp + is out of the range of values supported by the platform C + :c:func:`localtime` or :c:func:`gmtime` functions. Raise :exc:`OSError` + instead of :exc:`ValueError` on :c:func:`localtime` or :c:func:`gmtime` + failure. + + .. versionchanged:: 3.6 + :meth:`fromtimestamp` may return instances with :attr:`.fold` set to 1. + +.. classmethod:: datetime.utcfromtimestamp(timestamp) + + Return the UTC :class:`.datetime` corresponding to the POSIX timestamp, with + :attr:`.tzinfo` ``None``. This may raise :exc:`OverflowError`, if the timestamp is + out of the range of values supported by the platform C :c:func:`gmtime` function, + and :exc:`OSError` on :c:func:`gmtime` failure. + It's common for this to be restricted to years in 1970 through 2038. + + To get an aware :class:`.datetime` object, call :meth:`fromtimestamp`:: + + datetime.fromtimestamp(timestamp, timezone.utc) + + On the POSIX compliant platforms, it is equivalent to the following + expression:: + + datetime(1970, 1, 1, tzinfo=timezone.utc) + timedelta(seconds=timestamp) + + except the latter formula always supports the full years range: between + :const:`MINYEAR` and :const:`MAXYEAR` inclusive. + + .. versionchanged:: 3.3 + Raise :exc:`OverflowError` instead of :exc:`ValueError` if the timestamp + is out of the range of values supported by the platform C + :c:func:`gmtime` function. Raise :exc:`OSError` instead of + :exc:`ValueError` on :c:func:`gmtime` failure. + + +.. classmethod:: datetime.fromordinal(ordinal) + + Return the :class:`.datetime` corresponding to the proleptic Gregorian ordinal, + where January 1 of year 1 has ordinal 1. :exc:`ValueError` is raised unless ``1 + <= ordinal <= datetime.max.toordinal()``. The hour, minute, second and + microsecond of the result are all 0, and :attr:`.tzinfo` is ``None``. + + +.. classmethod:: datetime.combine(date, time, tzinfo=self.tzinfo) + + Return a new :class:`.datetime` object whose date components are equal to the + given :class:`date` object's, and whose time components + are equal to the given :class:`.time` object's. If the *tzinfo* + argument is provided, its value is used to set the :attr:`.tzinfo` attribute + of the result, otherwise the :attr:`~.time.tzinfo` attribute of the *time* argument + is used. + + For any :class:`.datetime` object *d*, + ``d == datetime.combine(d.date(), d.time(), d.tzinfo)``. If date is a + :class:`.datetime` object, its time components and :attr:`.tzinfo` attributes + are ignored. + + .. versionchanged:: 3.6 + Added the *tzinfo* argument. + + +.. classmethod:: datetime.fromisoformat(date_string) + + Return a :class:`datetime` corresponding to a *date_string* in one of the + formats emitted by :meth:`date.isoformat` and :meth:`datetime.isoformat`. + Specifically, this function supports strings in the format(s) + ``YYYY-MM-DD[*HH[:MM[:SS[.fff[fff]]]][+HH:MM[:SS[.ffffff]]]]``, + where ``*`` can match any single character. + + .. caution:: + + This does not support parsing arbitrary ISO 8601 strings - it is only intended + as the inverse operation of :meth:`datetime.isoformat`. + + .. versionadded:: 3.7 + +.. classmethod:: datetime.strptime(date_string, format) + + Return a :class:`.datetime` corresponding to *date_string*, parsed according to + *format*. This is equivalent to ``datetime(*(time.strptime(date_string, + format)[0:6]))``. :exc:`ValueError` is raised if the date_string and format + can't be parsed by :func:`time.strptime` or if it returns a value which isn't a + time tuple. For a complete list of formatting directives, see + :ref:`strftime-strptime-behavior`. + + + +Class attributes: + +.. attribute:: datetime.min + + The earliest representable :class:`.datetime`, ``datetime(MINYEAR, 1, 1, + tzinfo=None)``. + + +.. attribute:: datetime.max + + The latest representable :class:`.datetime`, ``datetime(MAXYEAR, 12, 31, 23, 59, + 59, 999999, tzinfo=None)``. + + +.. attribute:: datetime.resolution + + The smallest possible difference between non-equal :class:`.datetime` objects, + ``timedelta(microseconds=1)``. + + +Instance attributes (read-only): + +.. attribute:: datetime.year + + Between :const:`MINYEAR` and :const:`MAXYEAR` inclusive. + + +.. attribute:: datetime.month + + Between 1 and 12 inclusive. + + +.. attribute:: datetime.day + + Between 1 and the number of days in the given month of the given year. + + +.. attribute:: datetime.hour + + In ``range(24)``. + + +.. attribute:: datetime.minute + + In ``range(60)``. + + +.. attribute:: datetime.second + + In ``range(60)``. + + +.. attribute:: datetime.microsecond + + In ``range(1000000)``. + + +.. attribute:: datetime.tzinfo + + The object passed as the *tzinfo* argument to the :class:`.datetime` constructor, + or ``None`` if none was passed. + + +.. attribute:: datetime.fold + + In ``[0, 1]``. Used to disambiguate wall times during a repeated interval. (A + repeated interval occurs when clocks are rolled back at the end of daylight saving + time or when the UTC offset for the current zone is decreased for political reasons.) + The value 0 (1) represents the earlier (later) of the two moments with the same wall + time representation. + + .. versionadded:: 3.6 + +Supported operations: + ++---------------------------------------+--------------------------------+ +| Operation | Result | ++=======================================+================================+ +| ``datetime2 = datetime1 + timedelta`` | \(1) | ++---------------------------------------+--------------------------------+ +| ``datetime2 = datetime1 - timedelta`` | \(2) | ++---------------------------------------+--------------------------------+ +| ``timedelta = datetime1 - datetime2`` | \(3) | ++---------------------------------------+--------------------------------+ +| ``datetime1 < datetime2`` | Compares :class:`.datetime` to | +| | :class:`.datetime`. (4) | ++---------------------------------------+--------------------------------+ + +(1) + datetime2 is a duration of timedelta removed from datetime1, moving forward in + time if ``timedelta.days`` > 0, or backward if ``timedelta.days`` < 0. The + result has the same :attr:`~.datetime.tzinfo` attribute as the input datetime, and + datetime2 - datetime1 == timedelta after. :exc:`OverflowError` is raised if + datetime2.year would be smaller than :const:`MINYEAR` or larger than + :const:`MAXYEAR`. Note that no time zone adjustments are done even if the + input is an aware object. + +(2) + Computes the datetime2 such that datetime2 + timedelta == datetime1. As for + addition, the result has the same :attr:`~.datetime.tzinfo` attribute as the input + datetime, and no time zone adjustments are done even if the input is aware. + +(3) + Subtraction of a :class:`.datetime` from a :class:`.datetime` is defined only if + both operands are naive, or if both are aware. If one is aware and the other is + naive, :exc:`TypeError` is raised. + + If both are naive, or both are aware and have the same :attr:`~.datetime.tzinfo` attribute, + the :attr:`~.datetime.tzinfo` attributes are ignored, and the result is a :class:`timedelta` + object *t* such that ``datetime2 + t == datetime1``. No time zone adjustments + are done in this case. + + If both are aware and have different :attr:`~.datetime.tzinfo` attributes, ``a-b`` acts + as if *a* and *b* were first converted to naive UTC datetimes first. The + result is ``(a.replace(tzinfo=None) - a.utcoffset()) - (b.replace(tzinfo=None) + - b.utcoffset())`` except that the implementation never overflows. + +(4) + *datetime1* is considered less than *datetime2* when *datetime1* precedes + *datetime2* in time. + + If one comparand is naive and the other is aware, :exc:`TypeError` + is raised if an order comparison is attempted. For equality + comparisons, naive instances are never equal to aware instances. + + If both comparands are aware, and have the same :attr:`~.datetime.tzinfo` attribute, the + common :attr:`~.datetime.tzinfo` attribute is ignored and the base datetimes are + compared. If both comparands are aware and have different :attr:`~.datetime.tzinfo` + attributes, the comparands are first adjusted by subtracting their UTC + offsets (obtained from ``self.utcoffset()``). + + .. versionchanged:: 3.3 + Equality comparisons between naive and aware :class:`.datetime` + instances don't raise :exc:`TypeError`. + + .. note:: + + In order to stop comparison from falling back to the default scheme of comparing + object addresses, datetime comparison normally raises :exc:`TypeError` if the + other comparand isn't also a :class:`.datetime` object. However, + ``NotImplemented`` is returned instead if the other comparand has a + :meth:`timetuple` attribute. This hook gives other kinds of date objects a + chance at implementing mixed-type comparison. If not, when a :class:`.datetime` + object is compared to an object of a different type, :exc:`TypeError` is raised + unless the comparison is ``==`` or ``!=``. The latter cases return + :const:`False` or :const:`True`, respectively. + +:class:`.datetime` objects can be used as dictionary keys. In Boolean contexts, +all :class:`.datetime` objects are considered to be true. + +Instance methods: + +.. method:: datetime.date() + + Return :class:`date` object with same year, month and day. + + +.. method:: datetime.time() + + Return :class:`.time` object with same hour, minute, second, microsecond and fold. + :attr:`.tzinfo` is ``None``. See also method :meth:`timetz`. + + .. versionchanged:: 3.6 + The fold value is copied to the returned :class:`.time` object. + + +.. method:: datetime.timetz() + + Return :class:`.time` object with same hour, minute, second, microsecond, fold, and + tzinfo attributes. See also method :meth:`time`. + + .. versionchanged:: 3.6 + The fold value is copied to the returned :class:`.time` object. + + +.. method:: datetime.replace(year=self.year, month=self.month, day=self.day, \ + hour=self.hour, minute=self.minute, second=self.second, microsecond=self.microsecond, \ + tzinfo=self.tzinfo, * fold=0) + + Return a datetime with the same attributes, except for those attributes given + new values by whichever keyword arguments are specified. Note that + ``tzinfo=None`` can be specified to create a naive datetime from an aware + datetime with no conversion of date and time data. + + .. versionadded:: 3.6 + Added the ``fold`` argument. + + +.. method:: datetime.astimezone(tz=None) + + Return a :class:`.datetime` object with new :attr:`.tzinfo` attribute *tz*, + adjusting the date and time data so the result is the same UTC time as + *self*, but in *tz*'s local time. + + If provided, *tz* must be an instance of a :class:`tzinfo` subclass, and its + :meth:`utcoffset` and :meth:`dst` methods must not return ``None``. If *self* + is naive, it is presumed to represent time in the system timezone. + + If called without arguments (or with ``tz=None``) the system local + timezone is assumed for the target timezone. The ``.tzinfo`` attribute of the converted + datetime instance will be set to an instance of :class:`timezone` + with the zone name and offset obtained from the OS. + + If ``self.tzinfo`` is *tz*, ``self.astimezone(tz)`` is equal to *self*: no + adjustment of date or time data is performed. Else the result is local + time in the timezone *tz*, representing the same UTC time as *self*: after + ``astz = dt.astimezone(tz)``, ``astz - astz.utcoffset()`` will have + the same date and time data as ``dt - dt.utcoffset()``. + + If you merely want to attach a time zone object *tz* to a datetime *dt* without + adjustment of date and time data, use ``dt.replace(tzinfo=tz)``. If you + merely want to remove the time zone object from an aware datetime *dt* without + conversion of date and time data, use ``dt.replace(tzinfo=None)``. + + Note that the default :meth:`tzinfo.fromutc` method can be overridden in a + :class:`tzinfo` subclass to affect the result returned by :meth:`astimezone`. + Ignoring error cases, :meth:`astimezone` acts like:: + + def astimezone(self, tz): + if self.tzinfo is tz: + return self + # Convert self to UTC, and attach the new time zone object. + utc = (self - self.utcoffset()).replace(tzinfo=tz) + # Convert from UTC to tz's local time. + return tz.fromutc(utc) + + .. versionchanged:: 3.3 + *tz* now can be omitted. + + .. versionchanged:: 3.6 + The :meth:`astimezone` method can now be called on naive instances that + are presumed to represent system local time. + + +.. method:: datetime.utcoffset() + + If :attr:`.tzinfo` is ``None``, returns ``None``, else returns + ``self.tzinfo.utcoffset(self)``, and raises an exception if the latter doesn't + return ``None`` or a :class:`timedelta` object with magnitude less than one day. + + .. versionchanged:: 3.7 + The UTC offset is not restricted to a whole number of minutes. + + +.. method:: datetime.dst() + + If :attr:`.tzinfo` is ``None``, returns ``None``, else returns + ``self.tzinfo.dst(self)``, and raises an exception if the latter doesn't return + ``None`` or a :class:`timedelta` object with magnitude less than one day. + + .. versionchanged:: 3.7 + The DST offset is not restricted to a whole number of minutes. + + +.. method:: datetime.tzname() + + If :attr:`.tzinfo` is ``None``, returns ``None``, else returns + ``self.tzinfo.tzname(self)``, raises an exception if the latter doesn't return + ``None`` or a string object, + + +.. method:: datetime.timetuple() + + Return a :class:`time.struct_time` such as returned by :func:`time.localtime`. + ``d.timetuple()`` is equivalent to ``time.struct_time((d.year, d.month, d.day, + d.hour, d.minute, d.second, d.weekday(), yday, dst))``, where ``yday = + d.toordinal() - date(d.year, 1, 1).toordinal() + 1`` is the day number within + the current year starting with ``1`` for January 1st. The :attr:`tm_isdst` flag + of the result is set according to the :meth:`dst` method: :attr:`.tzinfo` is + ``None`` or :meth:`dst` returns ``None``, :attr:`tm_isdst` is set to ``-1``; + else if :meth:`dst` returns a non-zero value, :attr:`tm_isdst` is set to ``1``; + else :attr:`tm_isdst` is set to ``0``. + + +.. method:: datetime.utctimetuple() + + If :class:`.datetime` instance *d* is naive, this is the same as + ``d.timetuple()`` except that :attr:`tm_isdst` is forced to 0 regardless of what + ``d.dst()`` returns. DST is never in effect for a UTC time. + + If *d* is aware, *d* is normalized to UTC time, by subtracting + ``d.utcoffset()``, and a :class:`time.struct_time` for the + normalized time is returned. :attr:`tm_isdst` is forced to 0. Note + that an :exc:`OverflowError` may be raised if *d*.year was + ``MINYEAR`` or ``MAXYEAR`` and UTC adjustment spills over a year + boundary. + + +.. method:: datetime.toordinal() + + Return the proleptic Gregorian ordinal of the date. The same as + ``self.date().toordinal()``. + +.. method:: datetime.timestamp() + + Return POSIX timestamp corresponding to the :class:`.datetime` + instance. The return value is a :class:`float` similar to that + returned by :func:`time.time`. + + Naive :class:`.datetime` instances are assumed to represent local + time and this method relies on the platform C :c:func:`mktime` + function to perform the conversion. Since :class:`.datetime` + supports wider range of values than :c:func:`mktime` on many + platforms, this method may raise :exc:`OverflowError` for times far + in the past or far in the future. + + For aware :class:`.datetime` instances, the return value is computed + as:: + + (dt - datetime(1970, 1, 1, tzinfo=timezone.utc)).total_seconds() + + .. versionadded:: 3.3 + + .. versionchanged:: 3.6 + The :meth:`timestamp` method uses the :attr:`.fold` attribute to + disambiguate the times during a repeated interval. + + .. note:: + + There is no method to obtain the POSIX timestamp directly from a + naive :class:`.datetime` instance representing UTC time. If your + application uses this convention and your system timezone is not + set to UTC, you can obtain the POSIX timestamp by supplying + ``tzinfo=timezone.utc``:: + + timestamp = dt.replace(tzinfo=timezone.utc).timestamp() + + or by calculating the timestamp directly:: + + timestamp = (dt - datetime(1970, 1, 1)) / timedelta(seconds=1) + +.. method:: datetime.weekday() + + Return the day of the week as an integer, where Monday is 0 and Sunday is 6. + The same as ``self.date().weekday()``. See also :meth:`isoweekday`. + + +.. method:: datetime.isoweekday() + + Return the day of the week as an integer, where Monday is 1 and Sunday is 7. + The same as ``self.date().isoweekday()``. See also :meth:`weekday`, + :meth:`isocalendar`. + + +.. method:: datetime.isocalendar() + + Return a 3-tuple, (ISO year, ISO week number, ISO weekday). The same as + ``self.date().isocalendar()``. + + +.. method:: datetime.isoformat(sep='T', timespec='auto') + + Return a string representing the date and time in ISO 8601 format, + YYYY-MM-DDTHH:MM:SS.ffffff or, if :attr:`microsecond` is 0, + YYYY-MM-DDTHH:MM:SS + + If :meth:`utcoffset` does not return ``None``, a string is + appended, giving the UTC offset: + YYYY-MM-DDTHH:MM:SS.ffffff+HH:MM[:SS[.ffffff]] or, if :attr:`microsecond` + is 0 YYYY-MM-DDTHH:MM:SS+HH:MM[:SS[.ffffff]]. + + The optional argument *sep* (default ``'T'``) is a one-character separator, + placed between the date and time portions of the result. For example, + + >>> from datetime import tzinfo, timedelta, datetime + >>> class TZ(tzinfo): + ... def utcoffset(self, dt): return timedelta(minutes=-399) + ... + >>> datetime(2002, 12, 25, tzinfo=TZ()).isoformat(' ') + '2002-12-25 00:00:00-06:39' + + The optional argument *timespec* specifies the number of additional + components of the time to include (the default is ``'auto'``). + It can be one of the following: + + - ``'auto'``: Same as ``'seconds'`` if :attr:`microsecond` is 0, + same as ``'microseconds'`` otherwise. + - ``'hours'``: Include the :attr:`hour` in the two-digit HH format. + - ``'minutes'``: Include :attr:`hour` and :attr:`minute` in HH:MM format. + - ``'seconds'``: Include :attr:`hour`, :attr:`minute`, and :attr:`second` + in HH:MM:SS format. + - ``'milliseconds'``: Include full time, but truncate fractional second + part to milliseconds. HH:MM:SS.sss format. + - ``'microseconds'``: Include full time in HH:MM:SS.ffffff format. + + .. note:: + + Excluded time components are truncated, not rounded. + + :exc:`ValueError` will be raised on an invalid *timespec* argument. + + + >>> from datetime import datetime + >>> datetime.now().isoformat(timespec='minutes') # doctest: +SKIP + '2002-12-25T00:00' + >>> dt = datetime(2015, 1, 1, 12, 30, 59, 0) + >>> dt.isoformat(timespec='microseconds') + '2015-01-01T12:30:59.000000' + + .. versionadded:: 3.6 + Added the *timespec* argument. + + +.. method:: datetime.__str__() + + For a :class:`.datetime` instance *d*, ``str(d)`` is equivalent to + ``d.isoformat(' ')``. + + +.. method:: datetime.ctime() + + Return a string representing the date and time, for example ``datetime(2002, 12, + 4, 20, 30, 40).ctime() == 'Wed Dec 4 20:30:40 2002'``. ``d.ctime()`` is + equivalent to ``time.ctime(time.mktime(d.timetuple()))`` on platforms where the + native C :c:func:`ctime` function (which :func:`time.ctime` invokes, but which + :meth:`datetime.ctime` does not invoke) conforms to the C standard. + + +.. method:: datetime.strftime(format) + + Return a string representing the date and time, controlled by an explicit format + string. For a complete list of formatting directives, see + :ref:`strftime-strptime-behavior`. + + +.. method:: datetime.__format__(format) + + Same as :meth:`.datetime.strftime`. This makes it possible to specify a format + string for a :class:`.datetime` object in :ref:`formatted string + literals ` and when using :meth:`str.format`. For a + complete list of formatting directives, see + :ref:`strftime-strptime-behavior`. + + +Examples of working with datetime objects: + +.. doctest:: + + >>> from datetime import datetime, date, time + >>> # Using datetime.combine() + >>> d = date(2005, 7, 14) + >>> t = time(12, 30) + >>> datetime.combine(d, t) + datetime.datetime(2005, 7, 14, 12, 30) + >>> # Using datetime.now() or datetime.utcnow() + >>> datetime.now() # doctest: +SKIP + datetime.datetime(2007, 12, 6, 16, 29, 43, 79043) # GMT +1 + >>> datetime.utcnow() # doctest: +SKIP + datetime.datetime(2007, 12, 6, 15, 29, 43, 79060) + >>> # Using datetime.strptime() + >>> dt = datetime.strptime("21/11/06 16:30", "%d/%m/%y %H:%M") + >>> dt + datetime.datetime(2006, 11, 21, 16, 30) + >>> # Using datetime.timetuple() to get tuple of all attributes + >>> tt = dt.timetuple() + >>> for it in tt: # doctest: +SKIP + ... print(it) + ... + 2006 # year + 11 # month + 21 # day + 16 # hour + 30 # minute + 0 # second + 1 # weekday (0 = Monday) + 325 # number of days since 1st January + -1 # dst - method tzinfo.dst() returned None + >>> # Date in ISO format + >>> ic = dt.isocalendar() + >>> for it in ic: # doctest: +SKIP + ... print(it) + ... + 2006 # ISO year + 47 # ISO week + 2 # ISO weekday + >>> # Formatting datetime + >>> dt.strftime("%A, %d. %B %Y %I:%M%p") + 'Tuesday, 21. November 2006 04:30PM' + >>> 'The {1} is {0:%d}, the {2} is {0:%B}, the {3} is {0:%I:%M%p}.'.format(dt, "day", "month", "time") + 'The day is 21, the month is November, the time is 04:30PM.' + +Using datetime with tzinfo: + + >>> from datetime import timedelta, datetime, tzinfo, timezone + >>> class KabulTz(tzinfo): + ... # Kabul used +4 until 1945, when they moved to +4:30 + ... UTC_MOVE_DATE = datetime(1944, 12, 31, 20, tzinfo=timezone.utc) + ... def utcoffset(self, dt): + ... if dt.year < 1945: + ... return timedelta(hours=4) + ... elif (1945, 1, 1, 0, 0) <= dt.timetuple()[:5] < (1945, 1, 1, 0, 30): + ... # If dt falls in the imaginary range, use fold to decide how + ... # to resolve. See PEP495 + ... return timedelta(hours=4, minutes=(30 if dt.fold else 0)) + ... else: + ... return timedelta(hours=4, minutes=30) + ... + ... def fromutc(self, dt): + ... # A custom implementation is required for fromutc as + ... # the input to this function is a datetime with utc values + ... # but with a tzinfo set to self + ... # See datetime.astimezone or fromtimestamp + ... + ... # Follow same validations as in datetime.tzinfo + ... if not isinstance(dt, datetime): + ... raise TypeError("fromutc() requires a datetime argument") + ... if dt.tzinfo is not self: + ... raise ValueError("dt.tzinfo is not self") + ... + ... if dt.replace(tzinfo=timezone.utc) >= self.UTC_MOVE_DATE: + ... return dt + timedelta(hours=4, minutes=30) + ... else: + ... return dt + timedelta(hours=4) + ... + ... def dst(self, dt): + ... return timedelta(0) + ... + ... def tzname(self, dt): + ... if dt >= self.UTC_MOVE_DATE: + ... return "+04:30" + ... else: + ... return "+04" + ... + ... def __repr__(self): + ... return f"{self.__class__.__name__}()" + ... + >>> tz1 = KabulTz() + >>> # Datetime before the change + >>> dt1 = datetime(1900, 11, 21, 16, 30, tzinfo=tz1) + >>> print(dt1.utcoffset()) + 4:00:00 + >>> # Datetime after the change + >>> dt2 = datetime(2006, 6, 14, 13, 0, tzinfo=tz1) + >>> print(dt2.utcoffset()) + 4:30:00 + >>> # Convert datetime to another time zone + >>> dt3 = dt2.astimezone(timezone.utc) + >>> dt3 + datetime.datetime(2006, 6, 14, 8, 30, tzinfo=datetime.timezone.utc) + >>> dt2 + datetime.datetime(2006, 6, 14, 13, 0, tzinfo=KabulTz()) + >>> dt2.utctimetuple() == dt3.utctimetuple() + True + + + +.. _datetime-time: + +:class:`.time` Objects +---------------------- + +A time object represents a (local) time of day, independent of any particular +day, and subject to adjustment via a :class:`tzinfo` object. + +.. class:: time(hour=0, minute=0, second=0, microsecond=0, tzinfo=None, *, fold=0) + + All arguments are optional. *tzinfo* may be ``None``, or an instance of a + :class:`tzinfo` subclass. The remaining arguments may be integers, in the + following ranges: + + * ``0 <= hour < 24``, + * ``0 <= minute < 60``, + * ``0 <= second < 60``, + * ``0 <= microsecond < 1000000``, + * ``fold in [0, 1]``. + + If an argument outside those ranges is given, :exc:`ValueError` is raised. All + default to ``0`` except *tzinfo*, which defaults to :const:`None`. + +Class attributes: + + +.. attribute:: time.min + + The earliest representable :class:`.time`, ``time(0, 0, 0, 0)``. + + +.. attribute:: time.max + + The latest representable :class:`.time`, ``time(23, 59, 59, 999999)``. + + +.. attribute:: time.resolution + + The smallest possible difference between non-equal :class:`.time` objects, + ``timedelta(microseconds=1)``, although note that arithmetic on + :class:`.time` objects is not supported. + + +Instance attributes (read-only): + +.. attribute:: time.hour + + In ``range(24)``. + + +.. attribute:: time.minute + + In ``range(60)``. + + +.. attribute:: time.second + + In ``range(60)``. + + +.. attribute:: time.microsecond + + In ``range(1000000)``. + + +.. attribute:: time.tzinfo + + The object passed as the tzinfo argument to the :class:`.time` constructor, or + ``None`` if none was passed. + + +.. attribute:: time.fold + + In ``[0, 1]``. Used to disambiguate wall times during a repeated interval. (A + repeated interval occurs when clocks are rolled back at the end of daylight saving + time or when the UTC offset for the current zone is decreased for political reasons.) + The value 0 (1) represents the earlier (later) of the two moments with the same wall + time representation. + + .. versionadded:: 3.6 + + +Supported operations: + +* comparison of :class:`.time` to :class:`.time`, where *a* is considered less + than *b* when *a* precedes *b* in time. If one comparand is naive and the other + is aware, :exc:`TypeError` is raised if an order comparison is attempted. For equality + comparisons, naive instances are never equal to aware instances. + + If both comparands are aware, and have + the same :attr:`~time.tzinfo` attribute, the common :attr:`~time.tzinfo` attribute is + ignored and the base times are compared. If both comparands are aware and + have different :attr:`~time.tzinfo` attributes, the comparands are first adjusted by + subtracting their UTC offsets (obtained from ``self.utcoffset()``). In order + to stop mixed-type comparisons from falling back to the default comparison by + object address, when a :class:`.time` object is compared to an object of a + different type, :exc:`TypeError` is raised unless the comparison is ``==`` or + ``!=``. The latter cases return :const:`False` or :const:`True`, respectively. + + .. versionchanged:: 3.3 + Equality comparisons between naive and aware :class:`~datetime.time` instances + don't raise :exc:`TypeError`. + +* hash, use as dict key + +* efficient pickling + +In boolean contexts, a :class:`.time` object is always considered to be true. + +.. versionchanged:: 3.5 + Before Python 3.5, a :class:`.time` object was considered to be false if it + represented midnight in UTC. This behavior was considered obscure and + error-prone and has been removed in Python 3.5. See :issue:`13936` for full + details. + + +Other constructor: + +.. classmethod:: time.fromisoformat(time_string) + + Return a :class:`time` corresponding to a *time_string* in one of the + formats emitted by :meth:`time.isoformat`. Specifically, this function supports + strings in the format(s) ``HH[:MM[:SS[.fff[fff]]]][+HH:MM[:SS[.ffffff]]]``. + + .. caution:: + + This does not support parsing arbitrary ISO 8601 strings - it is only intended + as the inverse operation of :meth:`time.isoformat`. + + .. versionadded:: 3.7 + + +Instance methods: + +.. method:: time.replace(hour=self.hour, minute=self.minute, second=self.second, \ + microsecond=self.microsecond, tzinfo=self.tzinfo, * fold=0) + + Return a :class:`.time` with the same value, except for those attributes given + new values by whichever keyword arguments are specified. Note that + ``tzinfo=None`` can be specified to create a naive :class:`.time` from an + aware :class:`.time`, without conversion of the time data. + + .. versionadded:: 3.6 + Added the ``fold`` argument. + + +.. method:: time.isoformat(timespec='auto') + + Return a string representing the time in ISO 8601 format, HH:MM:SS.ffffff or, if + :attr:`microsecond` is 0, HH:MM:SS If :meth:`utcoffset` does not return ``None``, a + string is appended, giving the UTC offset: HH:MM:SS.ffffff+HH:MM[:SS[.ffffff]] + or, if self.microsecond is 0, HH:MM:SS+HH:MM[:SS[.ffffff]]. + + The optional argument *timespec* specifies the number of additional + components of the time to include (the default is ``'auto'``). + It can be one of the following: + + - ``'auto'``: Same as ``'seconds'`` if :attr:`microsecond` is 0, + same as ``'microseconds'`` otherwise. + - ``'hours'``: Include the :attr:`hour` in the two-digit HH format. + - ``'minutes'``: Include :attr:`hour` and :attr:`minute` in HH:MM format. + - ``'seconds'``: Include :attr:`hour`, :attr:`minute`, and :attr:`second` + in HH:MM:SS format. + - ``'milliseconds'``: Include full time, but truncate fractional second + part to milliseconds. HH:MM:SS.sss format. + - ``'microseconds'``: Include full time in HH:MM:SS.ffffff format. + + .. note:: + + Excluded time components are truncated, not rounded. + + :exc:`ValueError` will be raised on an invalid *timespec* argument. + + + >>> from datetime import time + >>> time(hour=12, minute=34, second=56, microsecond=123456).isoformat(timespec='minutes') + '12:34' + >>> dt = time(hour=12, minute=34, second=56, microsecond=0) + >>> dt.isoformat(timespec='microseconds') + '12:34:56.000000' + >>> dt.isoformat(timespec='auto') + '12:34:56' + + .. versionadded:: 3.6 + Added the *timespec* argument. + + +.. method:: time.__str__() + + For a time *t*, ``str(t)`` is equivalent to ``t.isoformat()``. + + +.. method:: time.strftime(format) + + Return a string representing the time, controlled by an explicit format + string. For a complete list of formatting directives, see + :ref:`strftime-strptime-behavior`. + + +.. method:: time.__format__(format) + + Same as :meth:`.time.strftime`. This makes it possible to specify a format string + for a :class:`.time` object in :ref:`formatted string + literals ` and when using :meth:`str.format`. For a + complete list of formatting directives, see + :ref:`strftime-strptime-behavior`. + + +.. method:: time.utcoffset() + + If :attr:`.tzinfo` is ``None``, returns ``None``, else returns + ``self.tzinfo.utcoffset(None)``, and raises an exception if the latter doesn't + return ``None`` or a :class:`timedelta` object with magnitude less than one day. + + .. versionchanged:: 3.7 + The UTC offset is not restricted to a whole number of minutes. + + +.. method:: time.dst() + + If :attr:`.tzinfo` is ``None``, returns ``None``, else returns + ``self.tzinfo.dst(None)``, and raises an exception if the latter doesn't return + ``None``, or a :class:`timedelta` object with magnitude less than one day. + + .. versionchanged:: 3.7 + The DST offset is not restricted to a whole number of minutes. + +.. method:: time.tzname() + + If :attr:`.tzinfo` is ``None``, returns ``None``, else returns + ``self.tzinfo.tzname(None)``, or raises an exception if the latter doesn't + return ``None`` or a string object. + +Example: + + >>> from datetime import time, tzinfo, timedelta + >>> class TZ1(tzinfo): + ... def utcoffset(self, dt): + ... return timedelta(hours=1) + ... def dst(self, dt): + ... return timedelta(0) + ... def tzname(self,dt): + ... return "+01:00" + ... def __repr__(self): + ... return f"{self.__class__.__name__}()" + ... + >>> t = time(12, 10, 30, tzinfo=TZ1()) + >>> t + datetime.time(12, 10, 30, tzinfo=TZ1()) + >>> t.isoformat() + '12:10:30+01:00' + >>> t.dst() + datetime.timedelta(0) + >>> t.tzname() + '+01:00' + >>> t.strftime("%H:%M:%S %Z") + '12:10:30 +01:00' + >>> 'The {} is {:%H:%M}.'.format("time", t) + 'The time is 12:10.' + + +.. _datetime-tzinfo: + +:class:`tzinfo` Objects +----------------------- + +.. class:: tzinfo() + + This is an abstract base class, meaning that this class should not be + instantiated directly. You need to derive a concrete subclass, and (at least) + supply implementations of the standard :class:`tzinfo` methods needed by the + :class:`.datetime` methods you use. The :mod:`datetime` module supplies + a simple concrete subclass of :class:`tzinfo`, :class:`timezone`, which can represent + timezones with fixed offset from UTC such as UTC itself or North American EST and + EDT. + + An instance of (a concrete subclass of) :class:`tzinfo` can be passed to the + constructors for :class:`.datetime` and :class:`.time` objects. The latter objects + view their attributes as being in local time, and the :class:`tzinfo` object + supports methods revealing offset of local time from UTC, the name of the time + zone, and DST offset, all relative to a date or time object passed to them. + + Special requirement for pickling: A :class:`tzinfo` subclass must have an + :meth:`__init__` method that can be called with no arguments, else it can be + pickled but possibly not unpickled again. This is a technical requirement that + may be relaxed in the future. + + A concrete subclass of :class:`tzinfo` may need to implement the following + methods. Exactly which methods are needed depends on the uses made of aware + :mod:`datetime` objects. If in doubt, simply implement all of them. + + +.. method:: tzinfo.utcoffset(dt) + + Return offset of local time from UTC, as a :class:`timedelta` object that is + positive east of UTC. If local time is + west of UTC, this should be negative. Note that this is intended to be the + total offset from UTC; for example, if a :class:`tzinfo` object represents both + time zone and DST adjustments, :meth:`utcoffset` should return their sum. If + the UTC offset isn't known, return ``None``. Else the value returned must be a + :class:`timedelta` object strictly between ``-timedelta(hours=24)`` and + ``timedelta(hours=24)`` (the magnitude of the offset must be less + than one day). Most implementations of :meth:`utcoffset` will probably look + like one of these two:: + + return CONSTANT # fixed-offset class + return CONSTANT + self.dst(dt) # daylight-aware class + + If :meth:`utcoffset` does not return ``None``, :meth:`dst` should not return + ``None`` either. + + The default implementation of :meth:`utcoffset` raises + :exc:`NotImplementedError`. + + .. versionchanged:: 3.7 + The UTC offset is not restricted to a whole number of minutes. + + +.. method:: tzinfo.dst(dt) + + Return the daylight saving time (DST) adjustment, as a :class:`timedelta` + object or + ``None`` if DST information isn't known. Return ``timedelta(0)`` if DST is not + in effect. If DST is in effect, return the offset as a :class:`timedelta` object + (see :meth:`utcoffset` for details). Note that DST offset, if applicable, has + already been added to the UTC offset returned by :meth:`utcoffset`, so there's + no need to consult :meth:`dst` unless you're interested in obtaining DST info + separately. For example, :meth:`datetime.timetuple` calls its :attr:`~.datetime.tzinfo` + attribute's :meth:`dst` method to determine how the :attr:`tm_isdst` flag + should be set, and :meth:`tzinfo.fromutc` calls :meth:`dst` to account for + DST changes when crossing time zones. + + An instance *tz* of a :class:`tzinfo` subclass that models both standard and + daylight times must be consistent in this sense: + + ``tz.utcoffset(dt) - tz.dst(dt)`` + + must return the same result for every :class:`.datetime` *dt* with ``dt.tzinfo == + tz`` For sane :class:`tzinfo` subclasses, this expression yields the time + zone's "standard offset", which should not depend on the date or the time, but + only on geographic location. The implementation of :meth:`datetime.astimezone` + relies on this, but cannot detect violations; it's the programmer's + responsibility to ensure it. If a :class:`tzinfo` subclass cannot guarantee + this, it may be able to override the default implementation of + :meth:`tzinfo.fromutc` to work correctly with :meth:`astimezone` regardless. + + Most implementations of :meth:`dst` will probably look like one of these two:: + + def dst(self, dt): + # a fixed-offset class: doesn't account for DST + return timedelta(0) + + or :: + + def dst(self, dt): + # Code to set dston and dstoff to the time zone's DST + # transition times based on the input dt.year, and expressed + # in standard local time. Then + + if dston <= dt.replace(tzinfo=None) < dstoff: + return timedelta(hours=1) + else: + return timedelta(0) + + The default implementation of :meth:`dst` raises :exc:`NotImplementedError`. + + .. versionchanged:: 3.7 + The DST offset is not restricted to a whole number of minutes. + + +.. method:: tzinfo.tzname(dt) + + Return the time zone name corresponding to the :class:`.datetime` object *dt*, as + a string. Nothing about string names is defined by the :mod:`datetime` module, + and there's no requirement that it mean anything in particular. For example, + "GMT", "UTC", "-500", "-5:00", "EDT", "US/Eastern", "America/New York" are all + valid replies. Return ``None`` if a string name isn't known. Note that this is + a method rather than a fixed string primarily because some :class:`tzinfo` + subclasses will wish to return different names depending on the specific value + of *dt* passed, especially if the :class:`tzinfo` class is accounting for + daylight time. + + The default implementation of :meth:`tzname` raises :exc:`NotImplementedError`. + + +These methods are called by a :class:`.datetime` or :class:`.time` object, in +response to their methods of the same names. A :class:`.datetime` object passes +itself as the argument, and a :class:`.time` object passes ``None`` as the +argument. A :class:`tzinfo` subclass's methods should therefore be prepared to +accept a *dt* argument of ``None``, or of class :class:`.datetime`. + +When ``None`` is passed, it's up to the class designer to decide the best +response. For example, returning ``None`` is appropriate if the class wishes to +say that time objects don't participate in the :class:`tzinfo` protocols. It +may be more useful for ``utcoffset(None)`` to return the standard UTC offset, as +there is no other convention for discovering the standard offset. + +When a :class:`.datetime` object is passed in response to a :class:`.datetime` +method, ``dt.tzinfo`` is the same object as *self*. :class:`tzinfo` methods can +rely on this, unless user code calls :class:`tzinfo` methods directly. The +intent is that the :class:`tzinfo` methods interpret *dt* as being in local +time, and not need worry about objects in other timezones. + +There is one more :class:`tzinfo` method that a subclass may wish to override: + + +.. method:: tzinfo.fromutc(dt) + + This is called from the default :class:`datetime.astimezone()` + implementation. When called from that, ``dt.tzinfo`` is *self*, and *dt*'s + date and time data are to be viewed as expressing a UTC time. The purpose + of :meth:`fromutc` is to adjust the date and time data, returning an + equivalent datetime in *self*'s local time. + + Most :class:`tzinfo` subclasses should be able to inherit the default + :meth:`fromutc` implementation without problems. It's strong enough to handle + fixed-offset time zones, and time zones accounting for both standard and + daylight time, and the latter even if the DST transition times differ in + different years. An example of a time zone the default :meth:`fromutc` + implementation may not handle correctly in all cases is one where the standard + offset (from UTC) depends on the specific date and time passed, which can happen + for political reasons. The default implementations of :meth:`astimezone` and + :meth:`fromutc` may not produce the result you want if the result is one of the + hours straddling the moment the standard offset changes. + + Skipping code for error cases, the default :meth:`fromutc` implementation acts + like:: + + def fromutc(self, dt): + # raise ValueError error if dt.tzinfo is not self + dtoff = dt.utcoffset() + dtdst = dt.dst() + # raise ValueError if dtoff is None or dtdst is None + delta = dtoff - dtdst # this is self's standard offset + if delta: + dt += delta # convert to standard local time + dtdst = dt.dst() + # raise ValueError if dtdst is None + if dtdst: + return dt + dtdst + else: + return dt + +In the following :download:`tzinfo_examples.py +<../includes/tzinfo_examples.py>` file there are some examples of +:class:`tzinfo` classes: + +.. literalinclude:: ../includes/tzinfo_examples.py + +Note that there are unavoidable subtleties twice per year in a :class:`tzinfo` +subclass accounting for both standard and daylight time, at the DST transition +points. For concreteness, consider US Eastern (UTC -0500), where EDT begins the +minute after 1:59 (EST) on the second Sunday in March, and ends the minute after +1:59 (EDT) on the first Sunday in November:: + + UTC 3:MM 4:MM 5:MM 6:MM 7:MM 8:MM + EST 22:MM 23:MM 0:MM 1:MM 2:MM 3:MM + EDT 23:MM 0:MM 1:MM 2:MM 3:MM 4:MM + + start 22:MM 23:MM 0:MM 1:MM 3:MM 4:MM + + end 23:MM 0:MM 1:MM 1:MM 2:MM 3:MM + +When DST starts (the "start" line), the local wall clock leaps from 1:59 to +3:00. A wall time of the form 2:MM doesn't really make sense on that day, so +``astimezone(Eastern)`` won't deliver a result with ``hour == 2`` on the day DST +begins. For example, at the Spring forward transition of 2016, we get + + >>> from datetime import datetime, timezone + >>> from tzinfo_examples import HOUR, Eastern + >>> u0 = datetime(2016, 3, 13, 5, tzinfo=timezone.utc) + >>> for i in range(4): + ... u = u0 + i*HOUR + ... t = u.astimezone(Eastern) + ... print(u.time(), 'UTC =', t.time(), t.tzname()) + ... + 05:00:00 UTC = 00:00:00 EST + 06:00:00 UTC = 01:00:00 EST + 07:00:00 UTC = 03:00:00 EDT + 08:00:00 UTC = 04:00:00 EDT + + +When DST ends (the "end" line), there's a potentially worse problem: there's an +hour that can't be spelled unambiguously in local wall time: the last hour of +daylight time. In Eastern, that's times of the form 5:MM UTC on the day +daylight time ends. The local wall clock leaps from 1:59 (daylight time) back +to 1:00 (standard time) again. Local times of the form 1:MM are ambiguous. +:meth:`astimezone` mimics the local clock's behavior by mapping two adjacent UTC +hours into the same local hour then. In the Eastern example, UTC times of the +form 5:MM and 6:MM both map to 1:MM when converted to Eastern, but earlier times +have the :attr:`~datetime.fold` attribute set to 0 and the later times have it set to 1. +For example, at the Fall back transition of 2016, we get + + >>> u0 = datetime(2016, 11, 6, 4, tzinfo=timezone.utc) + >>> for i in range(4): + ... u = u0 + i*HOUR + ... t = u.astimezone(Eastern) + ... print(u.time(), 'UTC =', t.time(), t.tzname(), t.fold) + ... + 04:00:00 UTC = 00:00:00 EDT 0 + 05:00:00 UTC = 01:00:00 EDT 0 + 06:00:00 UTC = 01:00:00 EST 1 + 07:00:00 UTC = 02:00:00 EST 0 + +Note that the :class:`datetime` instances that differ only by the value of the +:attr:`~datetime.fold` attribute are considered equal in comparisons. + +Applications that can't bear wall-time ambiguities should explicitly check the +value of the :attr:`~datetime.fold` attribute or avoid using hybrid +:class:`tzinfo` subclasses; there are no ambiguities when using :class:`timezone`, +or any other fixed-offset :class:`tzinfo` subclass (such as a class representing +only EST (fixed offset -5 hours), or only EDT (fixed offset -4 hours)). + +.. seealso:: + + `dateutil.tz `_ + The standard library has :class:`timezone` class for handling arbitrary + fixed offsets from UTC and :attr:`timezone.utc` as UTC timezone instance. + + *dateutil.tz* library brings the *IANA timezone database* (also known as the + Olson database) to Python and its usage is recommended. + + `IANA timezone database `_ + The Time Zone Database (often called tz, tzdata or zoneinfo) contains code and + data that represent the history of local time for many representative + locations around the globe. It is updated periodically to reflect changes + made by political bodies to time zone boundaries, UTC offsets, and + daylight-saving rules. + + +.. _datetime-timezone: + +:class:`timezone` Objects +-------------------------- + +The :class:`timezone` class is a subclass of :class:`tzinfo`, each +instance of which represents a timezone defined by a fixed offset from +UTC. Note that objects of this class cannot be used to represent +timezone information in the locations where different offsets are used +in different days of the year or where historical changes have been +made to civil time. + + +.. class:: timezone(offset, name=None) + + The *offset* argument must be specified as a :class:`timedelta` + object representing the difference between the local time and UTC. It must + be strictly between ``-timedelta(hours=24)`` and + ``timedelta(hours=24)``, otherwise :exc:`ValueError` is raised. + + The *name* argument is optional. If specified it must be a string that + will be used as the value returned by the :meth:`datetime.tzname` method. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.7 + The UTC offset is not restricted to a whole number of minutes. + + +.. method:: timezone.utcoffset(dt) + + Return the fixed value specified when the :class:`timezone` instance is + constructed. The *dt* argument is ignored. The return value is a + :class:`timedelta` instance equal to the difference between the + local time and UTC. + + .. versionchanged:: 3.7 + The UTC offset is not restricted to a whole number of minutes. + +.. method:: timezone.tzname(dt) + + Return the fixed value specified when the :class:`timezone` instance + is constructed. If *name* is not provided in the constructor, the + name returned by ``tzname(dt)`` is generated from the value of the + ``offset`` as follows. If *offset* is ``timedelta(0)``, the name + is "UTC", otherwise it is a string 'UTC±HH:MM', where ± is the sign + of ``offset``, HH and MM are two digits of ``offset.hours`` and + ``offset.minutes`` respectively. + + .. versionchanged:: 3.6 + Name generated from ``offset=timedelta(0)`` is now plain 'UTC', not + 'UTC+00:00'. + + +.. method:: timezone.dst(dt) + + Always returns ``None``. + +.. method:: timezone.fromutc(dt) + + Return ``dt + offset``. The *dt* argument must be an aware + :class:`.datetime` instance, with ``tzinfo`` set to ``self``. + +Class attributes: + +.. attribute:: timezone.utc + + The UTC timezone, ``timezone(timedelta(0))``. + + +.. index:: + single: % (percent); datetime format + +.. _strftime-strptime-behavior: + +:meth:`strftime` and :meth:`strptime` Behavior +---------------------------------------------- + +:class:`date`, :class:`.datetime`, and :class:`.time` objects all support a +``strftime(format)`` method, to create a string representing the time under the +control of an explicit format string. Broadly speaking, ``d.strftime(fmt)`` +acts like the :mod:`time` module's ``time.strftime(fmt, d.timetuple())`` +although not all objects support a :meth:`timetuple` method. + +Conversely, the :meth:`datetime.strptime` class method creates a +:class:`.datetime` object from a string representing a date and time and a +corresponding format string. ``datetime.strptime(date_string, format)`` is +equivalent to ``datetime(*(time.strptime(date_string, format)[0:6]))``, except +when the format includes sub-second components or timezone offset information, +which are supported in ``datetime.strptime`` but are discarded by ``time.strptime``. + +For :class:`.time` objects, the format codes for year, month, and day should not +be used, as time objects have no such values. If they're used anyway, ``1900`` +is substituted for the year, and ``1`` for the month and day. + +For :class:`date` objects, the format codes for hours, minutes, seconds, and +microseconds should not be used, as :class:`date` objects have no such +values. If they're used anyway, ``0`` is substituted for them. + +For the :meth:`datetime.strptime` class method, the default value is ``1900-01-01T00:00:00.000``: +any components not specified in the format string will be pulled from the default value. [#]_ + +The full set of format codes supported varies across platforms, because Python +calls the platform C library's :func:`strftime` function, and platform +variations are common. To see the full set of format codes supported on your +platform, consult the :manpage:`strftime(3)` documentation. + +For the same reason, handling of format strings containing Unicode code points +that can't be represented in the charset of the current locale is also +platform-dependent. On some platforms such code points are preserved intact in +the output, while on others ``strftime`` may raise :exc:`UnicodeError` or return +an empty string instead. + +The following is a list of all the format codes that the C standard (1989 +version) requires, and these work on all platforms with a standard C +implementation. Note that the 1999 version of the C standard added additional +format codes. + ++-----------+--------------------------------+------------------------+-------+ +| Directive | Meaning | Example | Notes | ++===========+================================+========================+=======+ +| ``%a`` | Weekday as locale's || Sun, Mon, ..., Sat | \(1) | +| | abbreviated name. | (en_US); | | +| | || So, Mo, ..., Sa | | +| | | (de_DE) | | ++-----------+--------------------------------+------------------------+-------+ +| ``%A`` | Weekday as locale's full name. || Sunday, Monday, ..., | \(1) | +| | | Saturday (en_US); | | +| | || Sonntag, Montag, ..., | | +| | | Samstag (de_DE) | | ++-----------+--------------------------------+------------------------+-------+ +| ``%w`` | Weekday as a decimal number, | 0, 1, ..., 6 | | +| | where 0 is Sunday and 6 is | | | +| | Saturday. | | | ++-----------+--------------------------------+------------------------+-------+ +| ``%d`` | Day of the month as a | 01, 02, ..., 31 | \(9) | +| | zero-padded decimal number. | | | ++-----------+--------------------------------+------------------------+-------+ +| ``%b`` | Month as locale's abbreviated || Jan, Feb, ..., Dec | \(1) | +| | name. | (en_US); | | +| | || Jan, Feb, ..., Dez | | +| | | (de_DE) | | ++-----------+--------------------------------+------------------------+-------+ +| ``%B`` | Month as locale's full name. || January, February, | \(1) | +| | | ..., December (en_US);| | +| | || Januar, Februar, ..., | | +| | | Dezember (de_DE) | | ++-----------+--------------------------------+------------------------+-------+ +| ``%m`` | Month as a zero-padded | 01, 02, ..., 12 | \(9) | +| | decimal number. | | | ++-----------+--------------------------------+------------------------+-------+ +| ``%y`` | Year without century as a | 00, 01, ..., 99 | \(9) | +| | zero-padded decimal number. | | | ++-----------+--------------------------------+------------------------+-------+ +| ``%Y`` | Year with century as a decimal | 0001, 0002, ..., 2013, | \(2) | +| | number. | 2014, ..., 9998, 9999 | | ++-----------+--------------------------------+------------------------+-------+ +| ``%H`` | Hour (24-hour clock) as a | 00, 01, ..., 23 | \(9) | +| | zero-padded decimal number. | | | ++-----------+--------------------------------+------------------------+-------+ +| ``%I`` | Hour (12-hour clock) as a | 01, 02, ..., 12 | \(9) | +| | zero-padded decimal number. | | | ++-----------+--------------------------------+------------------------+-------+ +| ``%p`` | Locale's equivalent of either || AM, PM (en_US); | \(1), | +| | AM or PM. || am, pm (de_DE) | \(3) | ++-----------+--------------------------------+------------------------+-------+ +| ``%M`` | Minute as a zero-padded | 00, 01, ..., 59 | \(9) | +| | decimal number. | | | ++-----------+--------------------------------+------------------------+-------+ +| ``%S`` | Second as a zero-padded | 00, 01, ..., 59 | \(4), | +| | decimal number. | | \(9) | ++-----------+--------------------------------+------------------------+-------+ +| ``%f`` | Microsecond as a decimal | 000000, 000001, ..., | \(5) | +| | number, zero-padded on the | 999999 | | +| | left. | | | ++-----------+--------------------------------+------------------------+-------+ +| ``%z`` | UTC offset in the form | (empty), +0000, | \(6) | +| | ±HHMM[SS[.ffffff]] (empty | -0400, +1030, | | +| | string if the object is | +063415, | | +| | naive). | -030712.345216 | | ++-----------+--------------------------------+------------------------+-------+ +| ``%Z`` | Time zone name (empty string | (empty), UTC, EST, CST | | +| | if the object is naive). | | | ++-----------+--------------------------------+------------------------+-------+ +| ``%j`` | Day of the year as a | 001, 002, ..., 366 | \(9) | +| | zero-padded decimal number. | | | ++-----------+--------------------------------+------------------------+-------+ +| ``%U`` | Week number of the year | 00, 01, ..., 53 | \(7), | +| | (Sunday as the first day of | | \(9) | +| | the week) as a zero padded | | | +| | decimal number. All days in a | | | +| | new year preceding the first | | | +| | Sunday are considered to be in | | | +| | week 0. | | | ++-----------+--------------------------------+------------------------+-------+ +| ``%W`` | Week number of the year | 00, 01, ..., 53 | \(7), | +| | (Monday as the first day of | | \(9) | +| | the week) as a decimal number. | | | +| | All days in a new year | | | +| | preceding the first Monday | | | +| | are considered to be in | | | +| | week 0. | | | ++-----------+--------------------------------+------------------------+-------+ +| ``%c`` | Locale's appropriate date and || Tue Aug 16 21:30:00 | \(1) | +| | time representation. | 1988 (en_US); | | +| | || Di 16 Aug 21:30:00 | | +| | | 1988 (de_DE) | | ++-----------+--------------------------------+------------------------+-------+ +| ``%x`` | Locale's appropriate date || 08/16/88 (None); | \(1) | +| | representation. || 08/16/1988 (en_US); | | +| | || 16.08.1988 (de_DE) | | ++-----------+--------------------------------+------------------------+-------+ +| ``%X`` | Locale's appropriate time || 21:30:00 (en_US); | \(1) | +| | representation. || 21:30:00 (de_DE) | | ++-----------+--------------------------------+------------------------+-------+ +| ``%%`` | A literal ``'%'`` character. | % | | ++-----------+--------------------------------+------------------------+-------+ + +Several additional directives not required by the C89 standard are included for +convenience. These parameters all correspond to ISO 8601 date values. These +may not be available on all platforms when used with the :meth:`strftime` +method. The ISO 8601 year and ISO 8601 week directives are not interchangeable +with the year and week number directives above. Calling :meth:`strptime` with +incomplete or ambiguous ISO 8601 directives will raise a :exc:`ValueError`. + ++-----------+--------------------------------+------------------------+-------+ +| Directive | Meaning | Example | Notes | ++===========+================================+========================+=======+ +| ``%G`` | ISO 8601 year with century | 0001, 0002, ..., 2013, | \(8) | +| | representing the year that | 2014, ..., 9998, 9999 | | +| | contains the greater part of | | | +| | the ISO week (``%V``). | | | ++-----------+--------------------------------+------------------------+-------+ +| ``%u`` | ISO 8601 weekday as a decimal | 1, 2, ..., 7 | | +| | number where 1 is Monday. | | | ++-----------+--------------------------------+------------------------+-------+ +| ``%V`` | ISO 8601 week as a decimal | 01, 02, ..., 53 | \(8), | +| | number with Monday as | | \(9) | +| | the first day of the week. | | | +| | Week 01 is the week containing | | | +| | Jan 4. | | | ++-----------+--------------------------------+------------------------+-------+ + +.. versionadded:: 3.6 + ``%G``, ``%u`` and ``%V`` were added. + +Notes: + +(1) + Because the format depends on the current locale, care should be taken when + making assumptions about the output value. Field orderings will vary (for + example, "month/day/year" versus "day/month/year"), and the output may + contain Unicode characters encoded using the locale's default encoding (for + example, if the current locale is ``ja_JP``, the default encoding could be + any one of ``eucJP``, ``SJIS``, or ``utf-8``; use :meth:`locale.getlocale` + to determine the current locale's encoding). + +(2) + The :meth:`strptime` method can parse years in the full [1, 9999] range, but + years < 1000 must be zero-filled to 4-digit width. + + .. versionchanged:: 3.2 + In previous versions, :meth:`strftime` method was restricted to + years >= 1900. + + .. versionchanged:: 3.3 + In version 3.2, :meth:`strftime` method was restricted to + years >= 1000. + +(3) + When used with the :meth:`strptime` method, the ``%p`` directive only affects + the output hour field if the ``%I`` directive is used to parse the hour. + +(4) + Unlike the :mod:`time` module, the :mod:`datetime` module does not support + leap seconds. + +(5) + When used with the :meth:`strptime` method, the ``%f`` directive + accepts from one to six digits and zero pads on the right. ``%f`` is + an extension to the set of format characters in the C standard (but + implemented separately in datetime objects, and therefore always + available). + +(6) + For a naive object, the ``%z`` and ``%Z`` format codes are replaced by empty + strings. + + For an aware object: + + ``%z`` + :meth:`utcoffset` is transformed into a string of the form + ±HHMM[SS[.ffffff]], where HH is a 2-digit string giving the number of UTC + offset hours, MM is a 2-digit string giving the number of UTC offset + minutes, SS is a 2-digit string giving the number of UTC offset + seconds and ffffff is a 6-digit string giving the number of UTC + offset microseconds. The ffffff part is omitted when the offset is a + whole number of seconds and both the ffffff and the SS part is omitted + when the offset is a whole number of minutes. For example, if + :meth:`utcoffset` returns ``timedelta(hours=-3, minutes=-30)``, ``%z`` is + replaced with the string ``'-0330'``. + + .. versionchanged:: 3.7 + The UTC offset is not restricted to a whole number of minutes. + + .. versionchanged:: 3.7 + When the ``%z`` directive is provided to the :meth:`strptime` method, + the UTC offsets can have a colon as a separator between hours, minutes + and seconds. + For example, ``'+01:00:00'`` will be parsed as an offset of one hour. + In addition, providing ``'Z'`` is identical to ``'+00:00'``. + + ``%Z`` + If :meth:`tzname` returns ``None``, ``%Z`` is replaced by an empty + string. Otherwise ``%Z`` is replaced by the returned value, which must + be a string. + + .. versionchanged:: 3.2 + When the ``%z`` directive is provided to the :meth:`strptime` method, an + aware :class:`.datetime` object will be produced. The ``tzinfo`` of the + result will be set to a :class:`timezone` instance. + +(7) + When used with the :meth:`strptime` method, ``%U`` and ``%W`` are only used + in calculations when the day of the week and the calendar year (``%Y``) + are specified. + +(8) + Similar to ``%U`` and ``%W``, ``%V`` is only used in calculations when the + day of the week and the ISO year (``%G``) are specified in a + :meth:`strptime` format string. Also note that ``%G`` and ``%Y`` are not + interchangeable. + +(9) + When used with the :meth:`strptime` method, the leading zero is optional + for formats ``%d``, ``%m``, ``%H``, ``%I``, ``%M``, ``%S``, ``%J``, ``%U``, + ``%W``, and ``%V``. Format ``%y`` does require a leading zero. + +.. rubric:: Footnotes + +.. [#] If, that is, we ignore the effects of Relativity +.. [#] Passing ``datetime.strptime('Feb 29', '%b %d')`` will fail since ``1900`` is not a leap year. diff --git a/python-3.7.4-docs-html/_sources/library/dbm.rst.txt b/python-3.7.4-docs-html/_sources/library/dbm.rst.txt new file mode 100644 index 0000000..0150f5d --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/dbm.rst.txt @@ -0,0 +1,375 @@ +:mod:`dbm` --- Interfaces to Unix "databases" +============================================= + +.. module:: dbm + :synopsis: Interfaces to various Unix "database" formats. + +**Source code:** :source:`Lib/dbm/__init__.py` + +-------------- + +:mod:`dbm` is a generic interface to variants of the DBM database --- +:mod:`dbm.gnu` or :mod:`dbm.ndbm`. If none of these modules is installed, the +slow-but-simple implementation in module :mod:`dbm.dumb` will be used. There +is a `third party interface `_ to +the Oracle Berkeley DB. + + +.. exception:: error + + A tuple containing the exceptions that can be raised by each of the supported + modules, with a unique exception also named :exc:`dbm.error` as the first + item --- the latter is used when :exc:`dbm.error` is raised. + + +.. function:: whichdb(filename) + + This function attempts to guess which of the several simple database modules + available --- :mod:`dbm.gnu`, :mod:`dbm.ndbm` or :mod:`dbm.dumb` --- should + be used to open a given file. + + Returns one of the following values: ``None`` if the file can't be opened + because it's unreadable or doesn't exist; the empty string (``''``) if the + file's format can't be guessed; or a string containing the required module + name, such as ``'dbm.ndbm'`` or ``'dbm.gnu'``. + + +.. function:: open(file, flag='r', mode=0o666) + + Open the database file *file* and return a corresponding object. + + If the database file already exists, the :func:`whichdb` function is used to + determine its type and the appropriate module is used; if it does not exist, + the first module listed above that can be imported is used. + + The optional *flag* argument can be: + + +---------+-------------------------------------------+ + | Value | Meaning | + +=========+===========================================+ + | ``'r'`` | Open existing database for reading only | + | | (default) | + +---------+-------------------------------------------+ + | ``'w'`` | Open existing database for reading and | + | | writing | + +---------+-------------------------------------------+ + | ``'c'`` | Open database for reading and writing, | + | | creating it if it doesn't exist | + +---------+-------------------------------------------+ + | ``'n'`` | Always create a new, empty database, open | + | | for reading and writing | + +---------+-------------------------------------------+ + + The optional *mode* argument is the Unix mode of the file, used only when the + database has to be created. It defaults to octal ``0o666`` (and will be + modified by the prevailing umask). + + +The object returned by :func:`.open` supports the same basic functionality as +dictionaries; keys and their corresponding values can be stored, retrieved, and +deleted, and the :keyword:`in` operator and the :meth:`keys` method are +available, as well as :meth:`get` and :meth:`setdefault`. + +.. versionchanged:: 3.2 + :meth:`get` and :meth:`setdefault` are now available in all database modules. + +Key and values are always stored as bytes. This means that when +strings are used they are implicitly converted to the default encoding before +being stored. + +These objects also support being used in a :keyword:`with` statement, which +will automatically close them when done. + +.. versionchanged:: 3.4 + Added native support for the context management protocol to the objects + returned by :func:`.open`. + +The following example records some hostnames and a corresponding title, and +then prints out the contents of the database:: + + import dbm + + # Open database, creating it if necessary. + with dbm.open('cache', 'c') as db: + + # Record some values + db[b'hello'] = b'there' + db['www.python.org'] = 'Python Website' + db['www.cnn.com'] = 'Cable News Network' + + # Note that the keys are considered bytes now. + assert db[b'www.python.org'] == b'Python Website' + # Notice how the value is now in bytes. + assert db['www.cnn.com'] == b'Cable News Network' + + # Often-used methods of the dict interface work too. + print(db.get('python.org', b'not present')) + + # Storing a non-string key or value will raise an exception (most + # likely a TypeError). + db['www.yahoo.com'] = 4 + + # db is automatically closed when leaving the with statement. + + +.. seealso:: + + Module :mod:`shelve` + Persistence module which stores non-string data. + + +The individual submodules are described in the following sections. + + +:mod:`dbm.gnu` --- GNU's reinterpretation of dbm +------------------------------------------------ + +.. module:: dbm.gnu + :platform: Unix + :synopsis: GNU's reinterpretation of dbm. + +**Source code:** :source:`Lib/dbm/gnu.py` + +-------------- + +This module is quite similar to the :mod:`dbm` module, but uses the GNU library +``gdbm`` instead to provide some additional functionality. Please note that the +file formats created by :mod:`dbm.gnu` and :mod:`dbm.ndbm` are incompatible. + +The :mod:`dbm.gnu` module provides an interface to the GNU DBM library. +``dbm.gnu.gdbm`` objects behave like mappings (dictionaries), except that keys and +values are always converted to bytes before storing. Printing a ``gdbm`` +object doesn't print the +keys and values, and the :meth:`items` and :meth:`values` methods are not +supported. + +.. exception:: error + + Raised on :mod:`dbm.gnu`-specific errors, such as I/O errors. :exc:`KeyError` is + raised for general mapping errors like specifying an incorrect key. + + +.. function:: open(filename[, flag[, mode]]) + + Open a ``gdbm`` database and return a :class:`gdbm` object. The *filename* + argument is the name of the database file. + + The optional *flag* argument can be: + + +---------+-------------------------------------------+ + | Value | Meaning | + +=========+===========================================+ + | ``'r'`` | Open existing database for reading only | + | | (default) | + +---------+-------------------------------------------+ + | ``'w'`` | Open existing database for reading and | + | | writing | + +---------+-------------------------------------------+ + | ``'c'`` | Open database for reading and writing, | + | | creating it if it doesn't exist | + +---------+-------------------------------------------+ + | ``'n'`` | Always create a new, empty database, open | + | | for reading and writing | + +---------+-------------------------------------------+ + + The following additional characters may be appended to the flag to control + how the database is opened: + + +---------+--------------------------------------------+ + | Value | Meaning | + +=========+============================================+ + | ``'f'`` | Open the database in fast mode. Writes | + | | to the database will not be synchronized. | + +---------+--------------------------------------------+ + | ``'s'`` | Synchronized mode. This will cause changes | + | | to the database to be immediately written | + | | to the file. | + +---------+--------------------------------------------+ + | ``'u'`` | Do not lock database. | + +---------+--------------------------------------------+ + + Not all flags are valid for all versions of ``gdbm``. The module constant + :const:`open_flags` is a string of supported flag characters. The exception + :exc:`error` is raised if an invalid flag is specified. + + The optional *mode* argument is the Unix mode of the file, used only when the + database has to be created. It defaults to octal ``0o666``. + + In addition to the dictionary-like methods, ``gdbm`` objects have the + following methods: + + .. method:: gdbm.firstkey() + + It's possible to loop over every key in the database using this method and the + :meth:`nextkey` method. The traversal is ordered by ``gdbm``'s internal + hash values, and won't be sorted by the key values. This method returns + the starting key. + + .. method:: gdbm.nextkey(key) + + Returns the key that follows *key* in the traversal. The following code prints + every key in the database ``db``, without having to create a list in memory that + contains them all:: + + k = db.firstkey() + while k != None: + print(k) + k = db.nextkey(k) + + .. method:: gdbm.reorganize() + + If you have carried out a lot of deletions and would like to shrink the space + used by the ``gdbm`` file, this routine will reorganize the database. ``gdbm`` + objects will not shorten the length of a database file except by using this + reorganization; otherwise, deleted file space will be kept and reused as new + (key, value) pairs are added. + + .. method:: gdbm.sync() + + When the database has been opened in fast mode, this method forces any + unwritten data to be written to the disk. + + .. method:: gdbm.close() + + Close the ``gdbm`` database. + +:mod:`dbm.ndbm` --- Interface based on ndbm +------------------------------------------- + +.. module:: dbm.ndbm + :platform: Unix + :synopsis: The standard "database" interface, based on ndbm. + +**Source code:** :source:`Lib/dbm/ndbm.py` + +-------------- + +The :mod:`dbm.ndbm` module provides an interface to the Unix "(n)dbm" library. +Dbm objects behave like mappings (dictionaries), except that keys and values are +always stored as bytes. Printing a ``dbm`` object doesn't print the keys and +values, and the :meth:`items` and :meth:`values` methods are not supported. + +This module can be used with the "classic" ndbm interface or the GNU GDBM +compatibility interface. On Unix, the :program:`configure` script will attempt +to locate the appropriate header file to simplify building this module. + +.. exception:: error + + Raised on :mod:`dbm.ndbm`-specific errors, such as I/O errors. :exc:`KeyError` is raised + for general mapping errors like specifying an incorrect key. + + +.. data:: library + + Name of the ``ndbm`` implementation library used. + + +.. function:: open(filename[, flag[, mode]]) + + Open a dbm database and return a ``ndbm`` object. The *filename* argument is the + name of the database file (without the :file:`.dir` or :file:`.pag` extensions). + + The optional *flag* argument must be one of these values: + + +---------+-------------------------------------------+ + | Value | Meaning | + +=========+===========================================+ + | ``'r'`` | Open existing database for reading only | + | | (default) | + +---------+-------------------------------------------+ + | ``'w'`` | Open existing database for reading and | + | | writing | + +---------+-------------------------------------------+ + | ``'c'`` | Open database for reading and writing, | + | | creating it if it doesn't exist | + +---------+-------------------------------------------+ + | ``'n'`` | Always create a new, empty database, open | + | | for reading and writing | + +---------+-------------------------------------------+ + + The optional *mode* argument is the Unix mode of the file, used only when the + database has to be created. It defaults to octal ``0o666`` (and will be + modified by the prevailing umask). + + In addition to the dictionary-like methods, ``ndbm`` objects + provide the following method: + + .. method:: ndbm.close() + + Close the ``ndbm`` database. + + +:mod:`dbm.dumb` --- Portable DBM implementation +----------------------------------------------- + +.. module:: dbm.dumb + :synopsis: Portable implementation of the simple DBM interface. + +**Source code:** :source:`Lib/dbm/dumb.py` + +.. index:: single: databases + +.. note:: + + The :mod:`dbm.dumb` module is intended as a last resort fallback for the + :mod:`dbm` module when a more robust module is not available. The :mod:`dbm.dumb` + module is not written for speed and is not nearly as heavily used as the other + database modules. + +-------------- + +The :mod:`dbm.dumb` module provides a persistent dictionary-like interface which +is written entirely in Python. Unlike other modules such as :mod:`dbm.gnu` no +external library is required. As with other persistent mappings, the keys and +values are always stored as bytes. + +The module defines the following: + + +.. exception:: error + + Raised on :mod:`dbm.dumb`-specific errors, such as I/O errors. :exc:`KeyError` is + raised for general mapping errors like specifying an incorrect key. + + +.. function:: open(filename[, flag[, mode]]) + + Open a ``dumbdbm`` database and return a dumbdbm object. The *filename* argument is + the basename of the database file (without any specific extensions). When a + dumbdbm database is created, files with :file:`.dat` and :file:`.dir` extensions + are created. + + The optional *flag* argument supports only the semantics of ``'c'`` + and ``'n'`` values. Other values will default to database being always + opened for update, and will be created if it does not exist. + + The optional *mode* argument is the Unix mode of the file, used only when the + database has to be created. It defaults to octal ``0o666`` (and will be modified + by the prevailing umask). + + .. warning:: + It is possible to crash the Python interpreter when loading a database + with a sufficiently large/complex entry due to stack depth limitations in + Python's AST compiler. + + .. versionchanged:: 3.5 + :func:`.open` always creates a new database when the flag has the value + ``'n'``. + + .. deprecated-removed:: 3.6 3.8 + Creating database in ``'r'`` and ``'w'`` modes. Modifying database in + ``'r'`` mode. + + In addition to the methods provided by the + :class:`collections.abc.MutableMapping` class, :class:`dumbdbm` objects + provide the following methods: + + .. method:: dumbdbm.sync() + + Synchronize the on-disk directory and data files. This method is called + by the :meth:`Shelve.sync` method. + + .. method:: dumbdbm.close() + + Close the ``dumbdbm`` database. + diff --git a/python-3.7.4-docs-html/_sources/library/debug.rst.txt b/python-3.7.4-docs-html/_sources/library/debug.rst.txt new file mode 100644 index 0000000..88a2fa6 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/debug.rst.txt @@ -0,0 +1,18 @@ +*********************** +Debugging and Profiling +*********************** + +These libraries help you with Python development: the debugger enables you to +step through code, analyze stack frames and set breakpoints etc., and the +profilers run code and give you a detailed breakdown of execution times, +allowing you to identify bottlenecks in your programs. + +.. toctree:: + + bdb.rst + faulthandler.rst + pdb.rst + profile.rst + timeit.rst + trace.rst + tracemalloc.rst diff --git a/python-3.7.4-docs-html/_sources/library/decimal.rst.txt b/python-3.7.4-docs-html/_sources/library/decimal.rst.txt new file mode 100644 index 0000000..bcae55e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/decimal.rst.txt @@ -0,0 +1,2137 @@ +:mod:`decimal` --- Decimal fixed point and floating point arithmetic +==================================================================== + +.. module:: decimal + :synopsis: Implementation of the General Decimal Arithmetic Specification. + +.. moduleauthor:: Eric Price +.. moduleauthor:: Facundo Batista +.. moduleauthor:: Raymond Hettinger +.. moduleauthor:: Aahz +.. moduleauthor:: Tim Peters +.. moduleauthor:: Stefan Krah +.. sectionauthor:: Raymond D. Hettinger + +**Source code:** :source:`Lib/decimal.py` + +.. import modules for testing inline doctests with the Sphinx doctest builder +.. testsetup:: * + + import decimal + import math + from decimal import * + # make sure each group gets a fresh context + setcontext(Context()) + +.. testcleanup:: * + + # make sure other tests (outside this file) get a fresh context + setcontext(Context()) + +-------------- + +The :mod:`decimal` module provides support for fast correctly-rounded +decimal floating point arithmetic. It offers several advantages over the +:class:`float` datatype: + +* Decimal "is based on a floating-point model which was designed with people + in mind, and necessarily has a paramount guiding principle -- computers must + provide an arithmetic that works in the same way as the arithmetic that + people learn at school." -- excerpt from the decimal arithmetic specification. + +* Decimal numbers can be represented exactly. In contrast, numbers like + :const:`1.1` and :const:`2.2` do not have exact representations in binary + floating point. End users typically would not expect ``1.1 + 2.2`` to display + as :const:`3.3000000000000003` as it does with binary floating point. + +* The exactness carries over into arithmetic. In decimal floating point, ``0.1 + + 0.1 + 0.1 - 0.3`` is exactly equal to zero. In binary floating point, the result + is :const:`5.5511151231257827e-017`. While near to zero, the differences + prevent reliable equality testing and differences can accumulate. For this + reason, decimal is preferred in accounting applications which have strict + equality invariants. + +* The decimal module incorporates a notion of significant places so that ``1.30 + + 1.20`` is :const:`2.50`. The trailing zero is kept to indicate significance. + This is the customary presentation for monetary applications. For + multiplication, the "schoolbook" approach uses all the figures in the + multiplicands. For instance, ``1.3 * 1.2`` gives :const:`1.56` while ``1.30 * + 1.20`` gives :const:`1.5600`. + +* Unlike hardware based binary floating point, the decimal module has a user + alterable precision (defaulting to 28 places) which can be as large as needed for + a given problem: + + >>> from decimal import * + >>> getcontext().prec = 6 + >>> Decimal(1) / Decimal(7) + Decimal('0.142857') + >>> getcontext().prec = 28 + >>> Decimal(1) / Decimal(7) + Decimal('0.1428571428571428571428571429') + +* Both binary and decimal floating point are implemented in terms of published + standards. While the built-in float type exposes only a modest portion of its + capabilities, the decimal module exposes all required parts of the standard. + When needed, the programmer has full control over rounding and signal handling. + This includes an option to enforce exact arithmetic by using exceptions + to block any inexact operations. + +* The decimal module was designed to support "without prejudice, both exact + unrounded decimal arithmetic (sometimes called fixed-point arithmetic) + and rounded floating-point arithmetic." -- excerpt from the decimal + arithmetic specification. + +The module design is centered around three concepts: the decimal number, the +context for arithmetic, and signals. + +A decimal number is immutable. It has a sign, coefficient digits, and an +exponent. To preserve significance, the coefficient digits do not truncate +trailing zeros. Decimals also include special values such as +:const:`Infinity`, :const:`-Infinity`, and :const:`NaN`. The standard also +differentiates :const:`-0` from :const:`+0`. + +The context for arithmetic is an environment specifying precision, rounding +rules, limits on exponents, flags indicating the results of operations, and trap +enablers which determine whether signals are treated as exceptions. Rounding +options include :const:`ROUND_CEILING`, :const:`ROUND_DOWN`, +:const:`ROUND_FLOOR`, :const:`ROUND_HALF_DOWN`, :const:`ROUND_HALF_EVEN`, +:const:`ROUND_HALF_UP`, :const:`ROUND_UP`, and :const:`ROUND_05UP`. + +Signals are groups of exceptional conditions arising during the course of +computation. Depending on the needs of the application, signals may be ignored, +considered as informational, or treated as exceptions. The signals in the +decimal module are: :const:`Clamped`, :const:`InvalidOperation`, +:const:`DivisionByZero`, :const:`Inexact`, :const:`Rounded`, :const:`Subnormal`, +:const:`Overflow`, :const:`Underflow` and :const:`FloatOperation`. + +For each signal there is a flag and a trap enabler. When a signal is +encountered, its flag is set to one, then, if the trap enabler is +set to one, an exception is raised. Flags are sticky, so the user needs to +reset them before monitoring a calculation. + + +.. seealso:: + + * IBM's General Decimal Arithmetic Specification, `The General Decimal Arithmetic + Specification `_. + +.. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + +.. _decimal-tutorial: + +Quick-start Tutorial +-------------------- + +The usual start to using decimals is importing the module, viewing the current +context with :func:`getcontext` and, if necessary, setting new values for +precision, rounding, or enabled traps:: + + >>> from decimal import * + >>> getcontext() + Context(prec=28, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999, + capitals=1, clamp=0, flags=[], traps=[Overflow, DivisionByZero, + InvalidOperation]) + + >>> getcontext().prec = 7 # Set a new precision + +Decimal instances can be constructed from integers, strings, floats, or tuples. +Construction from an integer or a float performs an exact conversion of the +value of that integer or float. Decimal numbers include special values such as +:const:`NaN` which stands for "Not a number", positive and negative +:const:`Infinity`, and :const:`-0`:: + + >>> getcontext().prec = 28 + >>> Decimal(10) + Decimal('10') + >>> Decimal('3.14') + Decimal('3.14') + >>> Decimal(3.14) + Decimal('3.140000000000000124344978758017532527446746826171875') + >>> Decimal((0, (3, 1, 4), -2)) + Decimal('3.14') + >>> Decimal(str(2.0 ** 0.5)) + Decimal('1.4142135623730951') + >>> Decimal(2) ** Decimal('0.5') + Decimal('1.414213562373095048801688724') + >>> Decimal('NaN') + Decimal('NaN') + >>> Decimal('-Infinity') + Decimal('-Infinity') + +If the :exc:`FloatOperation` signal is trapped, accidental mixing of +decimals and floats in constructors or ordering comparisons raises +an exception:: + + >>> c = getcontext() + >>> c.traps[FloatOperation] = True + >>> Decimal(3.14) + Traceback (most recent call last): + File "", line 1, in + decimal.FloatOperation: [] + >>> Decimal('3.5') < 3.7 + Traceback (most recent call last): + File "", line 1, in + decimal.FloatOperation: [] + >>> Decimal('3.5') == 3.5 + True + +.. versionadded:: 3.3 + +The significance of a new Decimal is determined solely by the number of digits +input. Context precision and rounding only come into play during arithmetic +operations. + +.. doctest:: newcontext + + >>> getcontext().prec = 6 + >>> Decimal('3.0') + Decimal('3.0') + >>> Decimal('3.1415926535') + Decimal('3.1415926535') + >>> Decimal('3.1415926535') + Decimal('2.7182818285') + Decimal('5.85987') + >>> getcontext().rounding = ROUND_UP + >>> Decimal('3.1415926535') + Decimal('2.7182818285') + Decimal('5.85988') + +If the internal limits of the C version are exceeded, constructing +a decimal raises :class:`InvalidOperation`:: + + >>> Decimal("1e9999999999999999999") + Traceback (most recent call last): + File "", line 1, in + decimal.InvalidOperation: [] + +.. versionchanged:: 3.3 + +Decimals interact well with much of the rest of Python. Here is a small decimal +floating point flying circus: + +.. doctest:: + :options: +NORMALIZE_WHITESPACE + + >>> data = list(map(Decimal, '1.34 1.87 3.45 2.35 1.00 0.03 9.25'.split())) + >>> max(data) + Decimal('9.25') + >>> min(data) + Decimal('0.03') + >>> sorted(data) + [Decimal('0.03'), Decimal('1.00'), Decimal('1.34'), Decimal('1.87'), + Decimal('2.35'), Decimal('3.45'), Decimal('9.25')] + >>> sum(data) + Decimal('19.29') + >>> a,b,c = data[:3] + >>> str(a) + '1.34' + >>> float(a) + 1.34 + >>> round(a, 1) + Decimal('1.3') + >>> int(a) + 1 + >>> a * 5 + Decimal('6.70') + >>> a * b + Decimal('2.5058') + >>> c % a + Decimal('0.77') + +And some mathematical functions are also available to Decimal: + + >>> getcontext().prec = 28 + >>> Decimal(2).sqrt() + Decimal('1.414213562373095048801688724') + >>> Decimal(1).exp() + Decimal('2.718281828459045235360287471') + >>> Decimal('10').ln() + Decimal('2.302585092994045684017991455') + >>> Decimal('10').log10() + Decimal('1') + +The :meth:`quantize` method rounds a number to a fixed exponent. This method is +useful for monetary applications that often round results to a fixed number of +places: + + >>> Decimal('7.325').quantize(Decimal('.01'), rounding=ROUND_DOWN) + Decimal('7.32') + >>> Decimal('7.325').quantize(Decimal('1.'), rounding=ROUND_UP) + Decimal('8') + +As shown above, the :func:`getcontext` function accesses the current context and +allows the settings to be changed. This approach meets the needs of most +applications. + +For more advanced work, it may be useful to create alternate contexts using the +Context() constructor. To make an alternate active, use the :func:`setcontext` +function. + +In accordance with the standard, the :mod:`decimal` module provides two ready to +use standard contexts, :const:`BasicContext` and :const:`ExtendedContext`. The +former is especially useful for debugging because many of the traps are +enabled: + +.. doctest:: newcontext + :options: +NORMALIZE_WHITESPACE + + >>> myothercontext = Context(prec=60, rounding=ROUND_HALF_DOWN) + >>> setcontext(myothercontext) + >>> Decimal(1) / Decimal(7) + Decimal('0.142857142857142857142857142857142857142857142857142857142857') + + >>> ExtendedContext + Context(prec=9, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999, + capitals=1, clamp=0, flags=[], traps=[]) + >>> setcontext(ExtendedContext) + >>> Decimal(1) / Decimal(7) + Decimal('0.142857143') + >>> Decimal(42) / Decimal(0) + Decimal('Infinity') + + >>> setcontext(BasicContext) + >>> Decimal(42) / Decimal(0) + Traceback (most recent call last): + File "", line 1, in -toplevel- + Decimal(42) / Decimal(0) + DivisionByZero: x / 0 + +Contexts also have signal flags for monitoring exceptional conditions +encountered during computations. The flags remain set until explicitly cleared, +so it is best to clear the flags before each set of monitored computations by +using the :meth:`clear_flags` method. :: + + >>> setcontext(ExtendedContext) + >>> getcontext().clear_flags() + >>> Decimal(355) / Decimal(113) + Decimal('3.14159292') + >>> getcontext() + Context(prec=9, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999, + capitals=1, clamp=0, flags=[Inexact, Rounded], traps=[]) + +The *flags* entry shows that the rational approximation to :const:`Pi` was +rounded (digits beyond the context precision were thrown away) and that the +result is inexact (some of the discarded digits were non-zero). + +Individual traps are set using the dictionary in the :attr:`traps` field of a +context: + +.. doctest:: newcontext + + >>> setcontext(ExtendedContext) + >>> Decimal(1) / Decimal(0) + Decimal('Infinity') + >>> getcontext().traps[DivisionByZero] = 1 + >>> Decimal(1) / Decimal(0) + Traceback (most recent call last): + File "", line 1, in -toplevel- + Decimal(1) / Decimal(0) + DivisionByZero: x / 0 + +Most programs adjust the current context only once, at the beginning of the +program. And, in many applications, data is converted to :class:`Decimal` with +a single cast inside a loop. With context set and decimals created, the bulk of +the program manipulates the data no differently than with other Python numeric +types. + +.. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + +.. _decimal-decimal: + +Decimal objects +--------------- + + +.. class:: Decimal(value="0", context=None) + + Construct a new :class:`Decimal` object based from *value*. + + *value* can be an integer, string, tuple, :class:`float`, or another :class:`Decimal` + object. If no *value* is given, returns ``Decimal('0')``. If *value* is a + string, it should conform to the decimal numeric string syntax after leading + and trailing whitespace characters, as well as underscores throughout, are removed:: + + sign ::= '+' | '-' + digit ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' + indicator ::= 'e' | 'E' + digits ::= digit [digit]... + decimal-part ::= digits '.' [digits] | ['.'] digits + exponent-part ::= indicator [sign] digits + infinity ::= 'Infinity' | 'Inf' + nan ::= 'NaN' [digits] | 'sNaN' [digits] + numeric-value ::= decimal-part [exponent-part] | infinity + numeric-string ::= [sign] numeric-value | [sign] nan + + Other Unicode decimal digits are also permitted where ``digit`` + appears above. These include decimal digits from various other + alphabets (for example, Arabic-Indic and Devanāgarī digits) along + with the fullwidth digits ``'\uff10'`` through ``'\uff19'``. + + If *value* is a :class:`tuple`, it should have three components, a sign + (:const:`0` for positive or :const:`1` for negative), a :class:`tuple` of + digits, and an integer exponent. For example, ``Decimal((0, (1, 4, 1, 4), -3))`` + returns ``Decimal('1.414')``. + + If *value* is a :class:`float`, the binary floating point value is losslessly + converted to its exact decimal equivalent. This conversion can often require + 53 or more digits of precision. For example, ``Decimal(float('1.1'))`` + converts to + ``Decimal('1.100000000000000088817841970012523233890533447265625')``. + + The *context* precision does not affect how many digits are stored. That is + determined exclusively by the number of digits in *value*. For example, + ``Decimal('3.00000')`` records all five zeros even if the context precision is + only three. + + The purpose of the *context* argument is determining what to do if *value* is a + malformed string. If the context traps :const:`InvalidOperation`, an exception + is raised; otherwise, the constructor returns a new Decimal with the value of + :const:`NaN`. + + Once constructed, :class:`Decimal` objects are immutable. + + .. versionchanged:: 3.2 + The argument to the constructor is now permitted to be a :class:`float` + instance. + + .. versionchanged:: 3.3 + :class:`float` arguments raise an exception if the :exc:`FloatOperation` + trap is set. By default the trap is off. + + .. versionchanged:: 3.6 + Underscores are allowed for grouping, as with integral and floating-point + literals in code. + + Decimal floating point objects share many properties with the other built-in + numeric types such as :class:`float` and :class:`int`. All of the usual math + operations and special methods apply. Likewise, decimal objects can be + copied, pickled, printed, used as dictionary keys, used as set elements, + compared, sorted, and coerced to another type (such as :class:`float` or + :class:`int`). + + There are some small differences between arithmetic on Decimal objects and + arithmetic on integers and floats. When the remainder operator ``%`` is + applied to Decimal objects, the sign of the result is the sign of the + *dividend* rather than the sign of the divisor:: + + >>> (-7) % 4 + 1 + >>> Decimal(-7) % Decimal(4) + Decimal('-3') + + The integer division operator ``//`` behaves analogously, returning the + integer part of the true quotient (truncating towards zero) rather than its + floor, so as to preserve the usual identity ``x == (x // y) * y + x % y``:: + + >>> -7 // 4 + -2 + >>> Decimal(-7) // Decimal(4) + Decimal('-1') + + The ``%`` and ``//`` operators implement the ``remainder`` and + ``divide-integer`` operations (respectively) as described in the + specification. + + Decimal objects cannot generally be combined with floats or + instances of :class:`fractions.Fraction` in arithmetic operations: + an attempt to add a :class:`Decimal` to a :class:`float`, for + example, will raise a :exc:`TypeError`. However, it is possible to + use Python's comparison operators to compare a :class:`Decimal` + instance ``x`` with another number ``y``. This avoids confusing results + when doing equality comparisons between numbers of different types. + + .. versionchanged:: 3.2 + Mixed-type comparisons between :class:`Decimal` instances and other + numeric types are now fully supported. + + In addition to the standard numeric properties, decimal floating point + objects also have a number of specialized methods: + + + .. method:: adjusted() + + Return the adjusted exponent after shifting out the coefficient's + rightmost digits until only the lead digit remains: + ``Decimal('321e+5').adjusted()`` returns seven. Used for determining the + position of the most significant digit with respect to the decimal point. + + .. method:: as_integer_ratio() + + Return a pair ``(n, d)`` of integers that represent the given + :class:`Decimal` instance as a fraction, in lowest terms and + with a positive denominator:: + + >>> Decimal('-3.14').as_integer_ratio() + (-157, 50) + + The conversion is exact. Raise OverflowError on infinities and ValueError + on NaNs. + + .. versionadded:: 3.6 + + .. method:: as_tuple() + + Return a :term:`named tuple` representation of the number: + ``DecimalTuple(sign, digits, exponent)``. + + + .. method:: canonical() + + Return the canonical encoding of the argument. Currently, the encoding of + a :class:`Decimal` instance is always canonical, so this operation returns + its argument unchanged. + + .. method:: compare(other, context=None) + + Compare the values of two Decimal instances. :meth:`compare` returns a + Decimal instance, and if either operand is a NaN then the result is a + NaN:: + + a or b is a NaN ==> Decimal('NaN') + a < b ==> Decimal('-1') + a == b ==> Decimal('0') + a > b ==> Decimal('1') + + .. method:: compare_signal(other, context=None) + + This operation is identical to the :meth:`compare` method, except that all + NaNs signal. That is, if neither operand is a signaling NaN then any + quiet NaN operand is treated as though it were a signaling NaN. + + .. method:: compare_total(other, context=None) + + Compare two operands using their abstract representation rather than their + numerical value. Similar to the :meth:`compare` method, but the result + gives a total ordering on :class:`Decimal` instances. Two + :class:`Decimal` instances with the same numeric value but different + representations compare unequal in this ordering: + + >>> Decimal('12.0').compare_total(Decimal('12')) + Decimal('-1') + + Quiet and signaling NaNs are also included in the total ordering. The + result of this function is ``Decimal('0')`` if both operands have the same + representation, ``Decimal('-1')`` if the first operand is lower in the + total order than the second, and ``Decimal('1')`` if the first operand is + higher in the total order than the second operand. See the specification + for details of the total order. + + This operation is unaffected by context and is quiet: no flags are changed + and no rounding is performed. As an exception, the C version may raise + InvalidOperation if the second operand cannot be converted exactly. + + .. method:: compare_total_mag(other, context=None) + + Compare two operands using their abstract representation rather than their + value as in :meth:`compare_total`, but ignoring the sign of each operand. + ``x.compare_total_mag(y)`` is equivalent to + ``x.copy_abs().compare_total(y.copy_abs())``. + + This operation is unaffected by context and is quiet: no flags are changed + and no rounding is performed. As an exception, the C version may raise + InvalidOperation if the second operand cannot be converted exactly. + + .. method:: conjugate() + + Just returns self, this method is only to comply with the Decimal + Specification. + + .. method:: copy_abs() + + Return the absolute value of the argument. This operation is unaffected + by the context and is quiet: no flags are changed and no rounding is + performed. + + .. method:: copy_negate() + + Return the negation of the argument. This operation is unaffected by the + context and is quiet: no flags are changed and no rounding is performed. + + .. method:: copy_sign(other, context=None) + + Return a copy of the first operand with the sign set to be the same as the + sign of the second operand. For example: + + >>> Decimal('2.3').copy_sign(Decimal('-1.5')) + Decimal('-2.3') + + This operation is unaffected by context and is quiet: no flags are changed + and no rounding is performed. As an exception, the C version may raise + InvalidOperation if the second operand cannot be converted exactly. + + .. method:: exp(context=None) + + Return the value of the (natural) exponential function ``e**x`` at the + given number. The result is correctly rounded using the + :const:`ROUND_HALF_EVEN` rounding mode. + + >>> Decimal(1).exp() + Decimal('2.718281828459045235360287471') + >>> Decimal(321).exp() + Decimal('2.561702493119680037517373933E+139') + + .. method:: from_float(f) + + Classmethod that converts a float to a decimal number, exactly. + + Note `Decimal.from_float(0.1)` is not the same as `Decimal('0.1')`. + Since 0.1 is not exactly representable in binary floating point, the + value is stored as the nearest representable value which is + `0x1.999999999999ap-4`. That equivalent value in decimal is + `0.1000000000000000055511151231257827021181583404541015625`. + + .. note:: From Python 3.2 onwards, a :class:`Decimal` instance + can also be constructed directly from a :class:`float`. + + .. doctest:: + + >>> Decimal.from_float(0.1) + Decimal('0.1000000000000000055511151231257827021181583404541015625') + >>> Decimal.from_float(float('nan')) + Decimal('NaN') + >>> Decimal.from_float(float('inf')) + Decimal('Infinity') + >>> Decimal.from_float(float('-inf')) + Decimal('-Infinity') + + .. versionadded:: 3.1 + + .. method:: fma(other, third, context=None) + + Fused multiply-add. Return self*other+third with no rounding of the + intermediate product self*other. + + >>> Decimal(2).fma(3, 5) + Decimal('11') + + .. method:: is_canonical() + + Return :const:`True` if the argument is canonical and :const:`False` + otherwise. Currently, a :class:`Decimal` instance is always canonical, so + this operation always returns :const:`True`. + + .. method:: is_finite() + + Return :const:`True` if the argument is a finite number, and + :const:`False` if the argument is an infinity or a NaN. + + .. method:: is_infinite() + + Return :const:`True` if the argument is either positive or negative + infinity and :const:`False` otherwise. + + .. method:: is_nan() + + Return :const:`True` if the argument is a (quiet or signaling) NaN and + :const:`False` otherwise. + + .. method:: is_normal(context=None) + + Return :const:`True` if the argument is a *normal* finite number. Return + :const:`False` if the argument is zero, subnormal, infinite or a NaN. + + .. method:: is_qnan() + + Return :const:`True` if the argument is a quiet NaN, and + :const:`False` otherwise. + + .. method:: is_signed() + + Return :const:`True` if the argument has a negative sign and + :const:`False` otherwise. Note that zeros and NaNs can both carry signs. + + .. method:: is_snan() + + Return :const:`True` if the argument is a signaling NaN and :const:`False` + otherwise. + + .. method:: is_subnormal(context=None) + + Return :const:`True` if the argument is subnormal, and :const:`False` + otherwise. + + .. method:: is_zero() + + Return :const:`True` if the argument is a (positive or negative) zero and + :const:`False` otherwise. + + .. method:: ln(context=None) + + Return the natural (base e) logarithm of the operand. The result is + correctly rounded using the :const:`ROUND_HALF_EVEN` rounding mode. + + .. method:: log10(context=None) + + Return the base ten logarithm of the operand. The result is correctly + rounded using the :const:`ROUND_HALF_EVEN` rounding mode. + + .. method:: logb(context=None) + + For a nonzero number, return the adjusted exponent of its operand as a + :class:`Decimal` instance. If the operand is a zero then + ``Decimal('-Infinity')`` is returned and the :const:`DivisionByZero` flag + is raised. If the operand is an infinity then ``Decimal('Infinity')`` is + returned. + + .. method:: logical_and(other, context=None) + + :meth:`logical_and` is a logical operation which takes two *logical + operands* (see :ref:`logical_operands_label`). The result is the + digit-wise ``and`` of the two operands. + + .. method:: logical_invert(context=None) + + :meth:`logical_invert` is a logical operation. The + result is the digit-wise inversion of the operand. + + .. method:: logical_or(other, context=None) + + :meth:`logical_or` is a logical operation which takes two *logical + operands* (see :ref:`logical_operands_label`). The result is the + digit-wise ``or`` of the two operands. + + .. method:: logical_xor(other, context=None) + + :meth:`logical_xor` is a logical operation which takes two *logical + operands* (see :ref:`logical_operands_label`). The result is the + digit-wise exclusive or of the two operands. + + .. method:: max(other, context=None) + + Like ``max(self, other)`` except that the context rounding rule is applied + before returning and that :const:`NaN` values are either signaled or + ignored (depending on the context and whether they are signaling or + quiet). + + .. method:: max_mag(other, context=None) + + Similar to the :meth:`.max` method, but the comparison is done using the + absolute values of the operands. + + .. method:: min(other, context=None) + + Like ``min(self, other)`` except that the context rounding rule is applied + before returning and that :const:`NaN` values are either signaled or + ignored (depending on the context and whether they are signaling or + quiet). + + .. method:: min_mag(other, context=None) + + Similar to the :meth:`.min` method, but the comparison is done using the + absolute values of the operands. + + .. method:: next_minus(context=None) + + Return the largest number representable in the given context (or in the + current thread's context if no context is given) that is smaller than the + given operand. + + .. method:: next_plus(context=None) + + Return the smallest number representable in the given context (or in the + current thread's context if no context is given) that is larger than the + given operand. + + .. method:: next_toward(other, context=None) + + If the two operands are unequal, return the number closest to the first + operand in the direction of the second operand. If both operands are + numerically equal, return a copy of the first operand with the sign set to + be the same as the sign of the second operand. + + .. method:: normalize(context=None) + + Normalize the number by stripping the rightmost trailing zeros and + converting any result equal to :const:`Decimal('0')` to + :const:`Decimal('0e0')`. Used for producing canonical values for attributes + of an equivalence class. For example, ``Decimal('32.100')`` and + ``Decimal('0.321000e+2')`` both normalize to the equivalent value + ``Decimal('32.1')``. + + .. method:: number_class(context=None) + + Return a string describing the *class* of the operand. The returned value + is one of the following ten strings. + + * ``"-Infinity"``, indicating that the operand is negative infinity. + * ``"-Normal"``, indicating that the operand is a negative normal number. + * ``"-Subnormal"``, indicating that the operand is negative and subnormal. + * ``"-Zero"``, indicating that the operand is a negative zero. + * ``"+Zero"``, indicating that the operand is a positive zero. + * ``"+Subnormal"``, indicating that the operand is positive and subnormal. + * ``"+Normal"``, indicating that the operand is a positive normal number. + * ``"+Infinity"``, indicating that the operand is positive infinity. + * ``"NaN"``, indicating that the operand is a quiet NaN (Not a Number). + * ``"sNaN"``, indicating that the operand is a signaling NaN. + + .. method:: quantize(exp, rounding=None, context=None) + + Return a value equal to the first operand after rounding and having the + exponent of the second operand. + + >>> Decimal('1.41421356').quantize(Decimal('1.000')) + Decimal('1.414') + + Unlike other operations, if the length of the coefficient after the + quantize operation would be greater than precision, then an + :const:`InvalidOperation` is signaled. This guarantees that, unless there + is an error condition, the quantized exponent is always equal to that of + the right-hand operand. + + Also unlike other operations, quantize never signals Underflow, even if + the result is subnormal and inexact. + + If the exponent of the second operand is larger than that of the first + then rounding may be necessary. In this case, the rounding mode is + determined by the ``rounding`` argument if given, else by the given + ``context`` argument; if neither argument is given the rounding mode of + the current thread's context is used. + + An error is returned whenever the resulting exponent is greater than + :attr:`Emax` or less than :attr:`Etiny`. + + .. method:: radix() + + Return ``Decimal(10)``, the radix (base) in which the :class:`Decimal` + class does all its arithmetic. Included for compatibility with the + specification. + + .. method:: remainder_near(other, context=None) + + Return the remainder from dividing *self* by *other*. This differs from + ``self % other`` in that the sign of the remainder is chosen so as to + minimize its absolute value. More precisely, the return value is + ``self - n * other`` where ``n`` is the integer nearest to the exact + value of ``self / other``, and if two integers are equally near then the + even one is chosen. + + If the result is zero then its sign will be the sign of *self*. + + >>> Decimal(18).remainder_near(Decimal(10)) + Decimal('-2') + >>> Decimal(25).remainder_near(Decimal(10)) + Decimal('5') + >>> Decimal(35).remainder_near(Decimal(10)) + Decimal('-5') + + .. method:: rotate(other, context=None) + + Return the result of rotating the digits of the first operand by an amount + specified by the second operand. The second operand must be an integer in + the range -precision through precision. The absolute value of the second + operand gives the number of places to rotate. If the second operand is + positive then rotation is to the left; otherwise rotation is to the right. + The coefficient of the first operand is padded on the left with zeros to + length precision if necessary. The sign and exponent of the first operand + are unchanged. + + .. method:: same_quantum(other, context=None) + + Test whether self and other have the same exponent or whether both are + :const:`NaN`. + + This operation is unaffected by context and is quiet: no flags are changed + and no rounding is performed. As an exception, the C version may raise + InvalidOperation if the second operand cannot be converted exactly. + + .. method:: scaleb(other, context=None) + + Return the first operand with exponent adjusted by the second. + Equivalently, return the first operand multiplied by ``10**other``. The + second operand must be an integer. + + .. method:: shift(other, context=None) + + Return the result of shifting the digits of the first operand by an amount + specified by the second operand. The second operand must be an integer in + the range -precision through precision. The absolute value of the second + operand gives the number of places to shift. If the second operand is + positive then the shift is to the left; otherwise the shift is to the + right. Digits shifted into the coefficient are zeros. The sign and + exponent of the first operand are unchanged. + + .. method:: sqrt(context=None) + + Return the square root of the argument to full precision. + + + .. method:: to_eng_string(context=None) + + Convert to a string, using engineering notation if an exponent is needed. + + Engineering notation has an exponent which is a multiple of 3. This + can leave up to 3 digits to the left of the decimal place and may + require the addition of either one or two trailing zeros. + + For example, this converts ``Decimal('123E+1')`` to ``Decimal('1.23E+3')``. + + .. method:: to_integral(rounding=None, context=None) + + Identical to the :meth:`to_integral_value` method. The ``to_integral`` + name has been kept for compatibility with older versions. + + .. method:: to_integral_exact(rounding=None, context=None) + + Round to the nearest integer, signaling :const:`Inexact` or + :const:`Rounded` as appropriate if rounding occurs. The rounding mode is + determined by the ``rounding`` parameter if given, else by the given + ``context``. If neither parameter is given then the rounding mode of the + current context is used. + + .. method:: to_integral_value(rounding=None, context=None) + + Round to the nearest integer without signaling :const:`Inexact` or + :const:`Rounded`. If given, applies *rounding*; otherwise, uses the + rounding method in either the supplied *context* or the current context. + + +.. _logical_operands_label: + +Logical operands +^^^^^^^^^^^^^^^^ + +The :meth:`logical_and`, :meth:`logical_invert`, :meth:`logical_or`, +and :meth:`logical_xor` methods expect their arguments to be *logical +operands*. A *logical operand* is a :class:`Decimal` instance whose +exponent and sign are both zero, and whose digits are all either +:const:`0` or :const:`1`. + +.. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + +.. _decimal-context: + +Context objects +--------------- + +Contexts are environments for arithmetic operations. They govern precision, set +rules for rounding, determine which signals are treated as exceptions, and limit +the range for exponents. + +Each thread has its own current context which is accessed or changed using the +:func:`getcontext` and :func:`setcontext` functions: + + +.. function:: getcontext() + + Return the current context for the active thread. + + +.. function:: setcontext(c) + + Set the current context for the active thread to *c*. + +You can also use the :keyword:`with` statement and the :func:`localcontext` +function to temporarily change the active context. + +.. function:: localcontext(ctx=None) + + Return a context manager that will set the current context for the active thread + to a copy of *ctx* on entry to the with-statement and restore the previous context + when exiting the with-statement. If no context is specified, a copy of the + current context is used. + + For example, the following code sets the current decimal precision to 42 places, + performs a calculation, and then automatically restores the previous context:: + + from decimal import localcontext + + with localcontext() as ctx: + ctx.prec = 42 # Perform a high precision calculation + s = calculate_something() + s = +s # Round the final result back to the default precision + +New contexts can also be created using the :class:`Context` constructor +described below. In addition, the module provides three pre-made contexts: + + +.. class:: BasicContext + + This is a standard context defined by the General Decimal Arithmetic + Specification. Precision is set to nine. Rounding is set to + :const:`ROUND_HALF_UP`. All flags are cleared. All traps are enabled (treated + as exceptions) except :const:`Inexact`, :const:`Rounded`, and + :const:`Subnormal`. + + Because many of the traps are enabled, this context is useful for debugging. + + +.. class:: ExtendedContext + + This is a standard context defined by the General Decimal Arithmetic + Specification. Precision is set to nine. Rounding is set to + :const:`ROUND_HALF_EVEN`. All flags are cleared. No traps are enabled (so that + exceptions are not raised during computations). + + Because the traps are disabled, this context is useful for applications that + prefer to have result value of :const:`NaN` or :const:`Infinity` instead of + raising exceptions. This allows an application to complete a run in the + presence of conditions that would otherwise halt the program. + + +.. class:: DefaultContext + + This context is used by the :class:`Context` constructor as a prototype for new + contexts. Changing a field (such a precision) has the effect of changing the + default for new contexts created by the :class:`Context` constructor. + + This context is most useful in multi-threaded environments. Changing one of the + fields before threads are started has the effect of setting system-wide + defaults. Changing the fields after threads have started is not recommended as + it would require thread synchronization to prevent race conditions. + + In single threaded environments, it is preferable to not use this context at + all. Instead, simply create contexts explicitly as described below. + + The default values are :attr:`prec`\ =\ :const:`28`, + :attr:`rounding`\ =\ :const:`ROUND_HALF_EVEN`, + and enabled traps for :class:`Overflow`, :class:`InvalidOperation`, and + :class:`DivisionByZero`. + +In addition to the three supplied contexts, new contexts can be created with the +:class:`Context` constructor. + + +.. class:: Context(prec=None, rounding=None, Emin=None, Emax=None, capitals=None, clamp=None, flags=None, traps=None) + + Creates a new context. If a field is not specified or is :const:`None`, the + default values are copied from the :const:`DefaultContext`. If the *flags* + field is not specified or is :const:`None`, all flags are cleared. + + *prec* is an integer in the range [:const:`1`, :const:`MAX_PREC`] that sets + the precision for arithmetic operations in the context. + + The *rounding* option is one of the constants listed in the section + `Rounding Modes`_. + + The *traps* and *flags* fields list any signals to be set. Generally, new + contexts should only set traps and leave the flags clear. + + The *Emin* and *Emax* fields are integers specifying the outer limits allowable + for exponents. *Emin* must be in the range [:const:`MIN_EMIN`, :const:`0`], + *Emax* in the range [:const:`0`, :const:`MAX_EMAX`]. + + The *capitals* field is either :const:`0` or :const:`1` (the default). If set to + :const:`1`, exponents are printed with a capital :const:`E`; otherwise, a + lowercase :const:`e` is used: :const:`Decimal('6.02e+23')`. + + The *clamp* field is either :const:`0` (the default) or :const:`1`. + If set to :const:`1`, the exponent ``e`` of a :class:`Decimal` + instance representable in this context is strictly limited to the + range ``Emin - prec + 1 <= e <= Emax - prec + 1``. If *clamp* is + :const:`0` then a weaker condition holds: the adjusted exponent of + the :class:`Decimal` instance is at most ``Emax``. When *clamp* is + :const:`1`, a large normal number will, where possible, have its + exponent reduced and a corresponding number of zeros added to its + coefficient, in order to fit the exponent constraints; this + preserves the value of the number but loses information about + significant trailing zeros. For example:: + + >>> Context(prec=6, Emax=999, clamp=1).create_decimal('1.23e999') + Decimal('1.23000E+999') + + A *clamp* value of :const:`1` allows compatibility with the + fixed-width decimal interchange formats specified in IEEE 754. + + The :class:`Context` class defines several general purpose methods as well as + a large number of methods for doing arithmetic directly in a given context. + In addition, for each of the :class:`Decimal` methods described above (with + the exception of the :meth:`adjusted` and :meth:`as_tuple` methods) there is + a corresponding :class:`Context` method. For example, for a :class:`Context` + instance ``C`` and :class:`Decimal` instance ``x``, ``C.exp(x)`` is + equivalent to ``x.exp(context=C)``. Each :class:`Context` method accepts a + Python integer (an instance of :class:`int`) anywhere that a + Decimal instance is accepted. + + + .. method:: clear_flags() + + Resets all of the flags to :const:`0`. + + .. method:: clear_traps() + + Resets all of the traps to :const:`0`. + + .. versionadded:: 3.3 + + .. method:: copy() + + Return a duplicate of the context. + + .. method:: copy_decimal(num) + + Return a copy of the Decimal instance num. + + .. method:: create_decimal(num) + + Creates a new Decimal instance from *num* but using *self* as + context. Unlike the :class:`Decimal` constructor, the context precision, + rounding method, flags, and traps are applied to the conversion. + + This is useful because constants are often given to a greater precision + than is needed by the application. Another benefit is that rounding + immediately eliminates unintended effects from digits beyond the current + precision. In the following example, using unrounded inputs means that + adding zero to a sum can change the result: + + .. doctest:: newcontext + + >>> getcontext().prec = 3 + >>> Decimal('3.4445') + Decimal('1.0023') + Decimal('4.45') + >>> Decimal('3.4445') + Decimal(0) + Decimal('1.0023') + Decimal('4.44') + + This method implements the to-number operation of the IBM specification. + If the argument is a string, no leading or trailing whitespace or + underscores are permitted. + + .. method:: create_decimal_from_float(f) + + Creates a new Decimal instance from a float *f* but rounding using *self* + as the context. Unlike the :meth:`Decimal.from_float` class method, + the context precision, rounding method, flags, and traps are applied to + the conversion. + + .. doctest:: + + >>> context = Context(prec=5, rounding=ROUND_DOWN) + >>> context.create_decimal_from_float(math.pi) + Decimal('3.1415') + >>> context = Context(prec=5, traps=[Inexact]) + >>> context.create_decimal_from_float(math.pi) + Traceback (most recent call last): + ... + decimal.Inexact: None + + .. versionadded:: 3.1 + + .. method:: Etiny() + + Returns a value equal to ``Emin - prec + 1`` which is the minimum exponent + value for subnormal results. When underflow occurs, the exponent is set + to :const:`Etiny`. + + .. method:: Etop() + + Returns a value equal to ``Emax - prec + 1``. + + The usual approach to working with decimals is to create :class:`Decimal` + instances and then apply arithmetic operations which take place within the + current context for the active thread. An alternative approach is to use + context methods for calculating within a specific context. The methods are + similar to those for the :class:`Decimal` class and are only briefly + recounted here. + + + .. method:: abs(x) + + Returns the absolute value of *x*. + + + .. method:: add(x, y) + + Return the sum of *x* and *y*. + + + .. method:: canonical(x) + + Returns the same Decimal object *x*. + + + .. method:: compare(x, y) + + Compares *x* and *y* numerically. + + + .. method:: compare_signal(x, y) + + Compares the values of the two operands numerically. + + + .. method:: compare_total(x, y) + + Compares two operands using their abstract representation. + + + .. method:: compare_total_mag(x, y) + + Compares two operands using their abstract representation, ignoring sign. + + + .. method:: copy_abs(x) + + Returns a copy of *x* with the sign set to 0. + + + .. method:: copy_negate(x) + + Returns a copy of *x* with the sign inverted. + + + .. method:: copy_sign(x, y) + + Copies the sign from *y* to *x*. + + + .. method:: divide(x, y) + + Return *x* divided by *y*. + + + .. method:: divide_int(x, y) + + Return *x* divided by *y*, truncated to an integer. + + + .. method:: divmod(x, y) + + Divides two numbers and returns the integer part of the result. + + + .. method:: exp(x) + + Returns `e ** x`. + + + .. method:: fma(x, y, z) + + Returns *x* multiplied by *y*, plus *z*. + + + .. method:: is_canonical(x) + + Returns ``True`` if *x* is canonical; otherwise returns ``False``. + + + .. method:: is_finite(x) + + Returns ``True`` if *x* is finite; otherwise returns ``False``. + + + .. method:: is_infinite(x) + + Returns ``True`` if *x* is infinite; otherwise returns ``False``. + + + .. method:: is_nan(x) + + Returns ``True`` if *x* is a qNaN or sNaN; otherwise returns ``False``. + + + .. method:: is_normal(x) + + Returns ``True`` if *x* is a normal number; otherwise returns ``False``. + + + .. method:: is_qnan(x) + + Returns ``True`` if *x* is a quiet NaN; otherwise returns ``False``. + + + .. method:: is_signed(x) + + Returns ``True`` if *x* is negative; otherwise returns ``False``. + + + .. method:: is_snan(x) + + Returns ``True`` if *x* is a signaling NaN; otherwise returns ``False``. + + + .. method:: is_subnormal(x) + + Returns ``True`` if *x* is subnormal; otherwise returns ``False``. + + + .. method:: is_zero(x) + + Returns ``True`` if *x* is a zero; otherwise returns ``False``. + + + .. method:: ln(x) + + Returns the natural (base e) logarithm of *x*. + + + .. method:: log10(x) + + Returns the base 10 logarithm of *x*. + + + .. method:: logb(x) + + Returns the exponent of the magnitude of the operand's MSD. + + + .. method:: logical_and(x, y) + + Applies the logical operation *and* between each operand's digits. + + + .. method:: logical_invert(x) + + Invert all the digits in *x*. + + + .. method:: logical_or(x, y) + + Applies the logical operation *or* between each operand's digits. + + + .. method:: logical_xor(x, y) + + Applies the logical operation *xor* between each operand's digits. + + + .. method:: max(x, y) + + Compares two values numerically and returns the maximum. + + + .. method:: max_mag(x, y) + + Compares the values numerically with their sign ignored. + + + .. method:: min(x, y) + + Compares two values numerically and returns the minimum. + + + .. method:: min_mag(x, y) + + Compares the values numerically with their sign ignored. + + + .. method:: minus(x) + + Minus corresponds to the unary prefix minus operator in Python. + + + .. method:: multiply(x, y) + + Return the product of *x* and *y*. + + + .. method:: next_minus(x) + + Returns the largest representable number smaller than *x*. + + + .. method:: next_plus(x) + + Returns the smallest representable number larger than *x*. + + + .. method:: next_toward(x, y) + + Returns the number closest to *x*, in direction towards *y*. + + + .. method:: normalize(x) + + Reduces *x* to its simplest form. + + + .. method:: number_class(x) + + Returns an indication of the class of *x*. + + + .. method:: plus(x) + + Plus corresponds to the unary prefix plus operator in Python. This + operation applies the context precision and rounding, so it is *not* an + identity operation. + + + .. method:: power(x, y, modulo=None) + + Return ``x`` to the power of ``y``, reduced modulo ``modulo`` if given. + + With two arguments, compute ``x**y``. If ``x`` is negative then ``y`` + must be integral. The result will be inexact unless ``y`` is integral and + the result is finite and can be expressed exactly in 'precision' digits. + The rounding mode of the context is used. Results are always correctly-rounded + in the Python version. + + .. versionchanged:: 3.3 + The C module computes :meth:`power` in terms of the correctly-rounded + :meth:`exp` and :meth:`ln` functions. The result is well-defined but + only "almost always correctly-rounded". + + With three arguments, compute ``(x**y) % modulo``. For the three argument + form, the following restrictions on the arguments hold: + + - all three arguments must be integral + - ``y`` must be nonnegative + - at least one of ``x`` or ``y`` must be nonzero + - ``modulo`` must be nonzero and have at most 'precision' digits + + The value resulting from ``Context.power(x, y, modulo)`` is + equal to the value that would be obtained by computing ``(x**y) + % modulo`` with unbounded precision, but is computed more + efficiently. The exponent of the result is zero, regardless of + the exponents of ``x``, ``y`` and ``modulo``. The result is + always exact. + + + .. method:: quantize(x, y) + + Returns a value equal to *x* (rounded), having the exponent of *y*. + + + .. method:: radix() + + Just returns 10, as this is Decimal, :) + + + .. method:: remainder(x, y) + + Returns the remainder from integer division. + + The sign of the result, if non-zero, is the same as that of the original + dividend. + + + .. method:: remainder_near(x, y) + + Returns ``x - y * n``, where *n* is the integer nearest the exact value + of ``x / y`` (if the result is 0 then its sign will be the sign of *x*). + + + .. method:: rotate(x, y) + + Returns a rotated copy of *x*, *y* times. + + + .. method:: same_quantum(x, y) + + Returns ``True`` if the two operands have the same exponent. + + + .. method:: scaleb (x, y) + + Returns the first operand after adding the second value its exp. + + + .. method:: shift(x, y) + + Returns a shifted copy of *x*, *y* times. + + + .. method:: sqrt(x) + + Square root of a non-negative number to context precision. + + + .. method:: subtract(x, y) + + Return the difference between *x* and *y*. + + + .. method:: to_eng_string(x) + + Convert to a string, using engineering notation if an exponent is needed. + + Engineering notation has an exponent which is a multiple of 3. This + can leave up to 3 digits to the left of the decimal place and may + require the addition of either one or two trailing zeros. + + + .. method:: to_integral_exact(x) + + Rounds to an integer. + + + .. method:: to_sci_string(x) + + Converts a number to a string using scientific notation. + +.. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +.. _decimal-rounding-modes: + +Constants +--------- + +The constants in this section are only relevant for the C module. They +are also included in the pure Python version for compatibility. + ++---------------------+---------------------+-------------------------------+ +| | 32-bit | 64-bit | ++=====================+=====================+===============================+ +| .. data:: MAX_PREC | :const:`425000000` | :const:`999999999999999999` | ++---------------------+---------------------+-------------------------------+ +| .. data:: MAX_EMAX | :const:`425000000` | :const:`999999999999999999` | ++---------------------+---------------------+-------------------------------+ +| .. data:: MIN_EMIN | :const:`-425000000` | :const:`-999999999999999999` | ++---------------------+---------------------+-------------------------------+ +| .. data:: MIN_ETINY | :const:`-849999999` | :const:`-1999999999999999997` | ++---------------------+---------------------+-------------------------------+ + + +.. data:: HAVE_THREADS + + The default value is ``True``. If Python is compiled without threads, the + C version automatically disables the expensive thread local context + machinery. In this case, the value is ``False``. + +Rounding modes +-------------- + +.. data:: ROUND_CEILING + + Round towards :const:`Infinity`. + +.. data:: ROUND_DOWN + + Round towards zero. + +.. data:: ROUND_FLOOR + + Round towards :const:`-Infinity`. + +.. data:: ROUND_HALF_DOWN + + Round to nearest with ties going towards zero. + +.. data:: ROUND_HALF_EVEN + + Round to nearest with ties going to nearest even integer. + +.. data:: ROUND_HALF_UP + + Round to nearest with ties going away from zero. + +.. data:: ROUND_UP + + Round away from zero. + +.. data:: ROUND_05UP + + Round away from zero if last digit after rounding towards zero would have + been 0 or 5; otherwise round towards zero. + + +.. _decimal-signals: + +Signals +------- + +Signals represent conditions that arise during computation. Each corresponds to +one context flag and one context trap enabler. + +The context flag is set whenever the condition is encountered. After the +computation, flags may be checked for informational purposes (for instance, to +determine whether a computation was exact). After checking the flags, be sure to +clear all flags before starting the next computation. + +If the context's trap enabler is set for the signal, then the condition causes a +Python exception to be raised. For example, if the :class:`DivisionByZero` trap +is set, then a :exc:`DivisionByZero` exception is raised upon encountering the +condition. + + +.. class:: Clamped + + Altered an exponent to fit representation constraints. + + Typically, clamping occurs when an exponent falls outside the context's + :attr:`Emin` and :attr:`Emax` limits. If possible, the exponent is reduced to + fit by adding zeros to the coefficient. + + +.. class:: DecimalException + + Base class for other signals and a subclass of :exc:`ArithmeticError`. + + +.. class:: DivisionByZero + + Signals the division of a non-infinite number by zero. + + Can occur with division, modulo division, or when raising a number to a negative + power. If this signal is not trapped, returns :const:`Infinity` or + :const:`-Infinity` with the sign determined by the inputs to the calculation. + + +.. class:: Inexact + + Indicates that rounding occurred and the result is not exact. + + Signals when non-zero digits were discarded during rounding. The rounded result + is returned. The signal flag or trap is used to detect when results are + inexact. + + +.. class:: InvalidOperation + + An invalid operation was performed. + + Indicates that an operation was requested that does not make sense. If not + trapped, returns :const:`NaN`. Possible causes include:: + + Infinity - Infinity + 0 * Infinity + Infinity / Infinity + x % 0 + Infinity % x + sqrt(-x) and x > 0 + 0 ** 0 + x ** (non-integer) + x ** Infinity + + +.. class:: Overflow + + Numerical overflow. + + Indicates the exponent is larger than :attr:`Emax` after rounding has + occurred. If not trapped, the result depends on the rounding mode, either + pulling inward to the largest representable finite number or rounding outward + to :const:`Infinity`. In either case, :class:`Inexact` and :class:`Rounded` + are also signaled. + + +.. class:: Rounded + + Rounding occurred though possibly no information was lost. + + Signaled whenever rounding discards digits; even if those digits are zero + (such as rounding :const:`5.00` to :const:`5.0`). If not trapped, returns + the result unchanged. This signal is used to detect loss of significant + digits. + + +.. class:: Subnormal + + Exponent was lower than :attr:`Emin` prior to rounding. + + Occurs when an operation result is subnormal (the exponent is too small). If + not trapped, returns the result unchanged. + + +.. class:: Underflow + + Numerical underflow with result rounded to zero. + + Occurs when a subnormal result is pushed to zero by rounding. :class:`Inexact` + and :class:`Subnormal` are also signaled. + + +.. class:: FloatOperation + + Enable stricter semantics for mixing floats and Decimals. + + If the signal is not trapped (default), mixing floats and Decimals is + permitted in the :class:`~decimal.Decimal` constructor, + :meth:`~decimal.Context.create_decimal` and all comparison operators. + Both conversion and comparisons are exact. Any occurrence of a mixed + operation is silently recorded by setting :exc:`FloatOperation` in the + context flags. Explicit conversions with :meth:`~decimal.Decimal.from_float` + or :meth:`~decimal.Context.create_decimal_from_float` do not set the flag. + + Otherwise (the signal is trapped), only equality comparisons and explicit + conversions are silent. All other mixed operations raise :exc:`FloatOperation`. + + +The following table summarizes the hierarchy of signals:: + + exceptions.ArithmeticError(exceptions.Exception) + DecimalException + Clamped + DivisionByZero(DecimalException, exceptions.ZeroDivisionError) + Inexact + Overflow(Inexact, Rounded) + Underflow(Inexact, Rounded, Subnormal) + InvalidOperation + Rounded + Subnormal + FloatOperation(DecimalException, exceptions.TypeError) + +.. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + + +.. _decimal-notes: + +Floating Point Notes +-------------------- + + +Mitigating round-off error with increased precision +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The use of decimal floating point eliminates decimal representation error +(making it possible to represent :const:`0.1` exactly); however, some operations +can still incur round-off error when non-zero digits exceed the fixed precision. + +The effects of round-off error can be amplified by the addition or subtraction +of nearly offsetting quantities resulting in loss of significance. Knuth +provides two instructive examples where rounded floating point arithmetic with +insufficient precision causes the breakdown of the associative and distributive +properties of addition: + +.. doctest:: newcontext + + # Examples from Seminumerical Algorithms, Section 4.2.2. + >>> from decimal import Decimal, getcontext + >>> getcontext().prec = 8 + + >>> u, v, w = Decimal(11111113), Decimal(-11111111), Decimal('7.51111111') + >>> (u + v) + w + Decimal('9.5111111') + >>> u + (v + w) + Decimal('10') + + >>> u, v, w = Decimal(20000), Decimal(-6), Decimal('6.0000003') + >>> (u*v) + (u*w) + Decimal('0.01') + >>> u * (v+w) + Decimal('0.0060000') + +The :mod:`decimal` module makes it possible to restore the identities by +expanding the precision sufficiently to avoid loss of significance: + +.. doctest:: newcontext + + >>> getcontext().prec = 20 + >>> u, v, w = Decimal(11111113), Decimal(-11111111), Decimal('7.51111111') + >>> (u + v) + w + Decimal('9.51111111') + >>> u + (v + w) + Decimal('9.51111111') + >>> + >>> u, v, w = Decimal(20000), Decimal(-6), Decimal('6.0000003') + >>> (u*v) + (u*w) + Decimal('0.0060000') + >>> u * (v+w) + Decimal('0.0060000') + + +Special values +^^^^^^^^^^^^^^ + +The number system for the :mod:`decimal` module provides special values +including :const:`NaN`, :const:`sNaN`, :const:`-Infinity`, :const:`Infinity`, +and two zeros, :const:`+0` and :const:`-0`. + +Infinities can be constructed directly with: ``Decimal('Infinity')``. Also, +they can arise from dividing by zero when the :exc:`DivisionByZero` signal is +not trapped. Likewise, when the :exc:`Overflow` signal is not trapped, infinity +can result from rounding beyond the limits of the largest representable number. + +The infinities are signed (affine) and can be used in arithmetic operations +where they get treated as very large, indeterminate numbers. For instance, +adding a constant to infinity gives another infinite result. + +Some operations are indeterminate and return :const:`NaN`, or if the +:exc:`InvalidOperation` signal is trapped, raise an exception. For example, +``0/0`` returns :const:`NaN` which means "not a number". This variety of +:const:`NaN` is quiet and, once created, will flow through other computations +always resulting in another :const:`NaN`. This behavior can be useful for a +series of computations that occasionally have missing inputs --- it allows the +calculation to proceed while flagging specific results as invalid. + +A variant is :const:`sNaN` which signals rather than remaining quiet after every +operation. This is a useful return value when an invalid result needs to +interrupt a calculation for special handling. + +The behavior of Python's comparison operators can be a little surprising where a +:const:`NaN` is involved. A test for equality where one of the operands is a +quiet or signaling :const:`NaN` always returns :const:`False` (even when doing +``Decimal('NaN')==Decimal('NaN')``), while a test for inequality always returns +:const:`True`. An attempt to compare two Decimals using any of the ``<``, +``<=``, ``>`` or ``>=`` operators will raise the :exc:`InvalidOperation` signal +if either operand is a :const:`NaN`, and return :const:`False` if this signal is +not trapped. Note that the General Decimal Arithmetic specification does not +specify the behavior of direct comparisons; these rules for comparisons +involving a :const:`NaN` were taken from the IEEE 854 standard (see Table 3 in +section 5.7). To ensure strict standards-compliance, use the :meth:`compare` +and :meth:`compare-signal` methods instead. + +The signed zeros can result from calculations that underflow. They keep the sign +that would have resulted if the calculation had been carried out to greater +precision. Since their magnitude is zero, both positive and negative zeros are +treated as equal and their sign is informational. + +In addition to the two signed zeros which are distinct yet equal, there are +various representations of zero with differing precisions yet equivalent in +value. This takes a bit of getting used to. For an eye accustomed to +normalized floating point representations, it is not immediately obvious that +the following calculation returns a value equal to zero: + + >>> 1 / Decimal('Infinity') + Decimal('0E-1000026') + +.. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + +.. _decimal-threads: + +Working with threads +-------------------- + +The :func:`getcontext` function accesses a different :class:`Context` object for +each thread. Having separate thread contexts means that threads may make +changes (such as ``getcontext().prec=10``) without interfering with other threads. + +Likewise, the :func:`setcontext` function automatically assigns its target to +the current thread. + +If :func:`setcontext` has not been called before :func:`getcontext`, then +:func:`getcontext` will automatically create a new context for use in the +current thread. + +The new context is copied from a prototype context called *DefaultContext*. To +control the defaults so that each thread will use the same values throughout the +application, directly modify the *DefaultContext* object. This should be done +*before* any threads are started so that there won't be a race condition between +threads calling :func:`getcontext`. For example:: + + # Set applicationwide defaults for all threads about to be launched + DefaultContext.prec = 12 + DefaultContext.rounding = ROUND_DOWN + DefaultContext.traps = ExtendedContext.traps.copy() + DefaultContext.traps[InvalidOperation] = 1 + setcontext(DefaultContext) + + # Afterwards, the threads can be started + t1.start() + t2.start() + t3.start() + . . . + +.. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + +.. _decimal-recipes: + +Recipes +------- + +Here are a few recipes that serve as utility functions and that demonstrate ways +to work with the :class:`Decimal` class:: + + def moneyfmt(value, places=2, curr='', sep=',', dp='.', + pos='', neg='-', trailneg=''): + """Convert Decimal to a money formatted string. + + places: required number of places after the decimal point + curr: optional currency symbol before the sign (may be blank) + sep: optional grouping separator (comma, period, space, or blank) + dp: decimal point indicator (comma or period) + only specify as blank when places is zero + pos: optional sign for positive numbers: '+', space or blank + neg: optional sign for negative numbers: '-', '(', space or blank + trailneg:optional trailing minus indicator: '-', ')', space or blank + + >>> d = Decimal('-1234567.8901') + >>> moneyfmt(d, curr='$') + '-$1,234,567.89' + >>> moneyfmt(d, places=0, sep='.', dp='', neg='', trailneg='-') + '1.234.568-' + >>> moneyfmt(d, curr='$', neg='(', trailneg=')') + '($1,234,567.89)' + >>> moneyfmt(Decimal(123456789), sep=' ') + '123 456 789.00' + >>> moneyfmt(Decimal('-0.02'), neg='<', trailneg='>') + '<0.02>' + + """ + q = Decimal(10) ** -places # 2 places --> '0.01' + sign, digits, exp = value.quantize(q).as_tuple() + result = [] + digits = list(map(str, digits)) + build, next = result.append, digits.pop + if sign: + build(trailneg) + for i in range(places): + build(next() if digits else '0') + if places: + build(dp) + if not digits: + build('0') + i = 0 + while digits: + build(next()) + i += 1 + if i == 3 and digits: + i = 0 + build(sep) + build(curr) + build(neg if sign else pos) + return ''.join(reversed(result)) + + def pi(): + """Compute Pi to the current precision. + + >>> print(pi()) + 3.141592653589793238462643383 + + """ + getcontext().prec += 2 # extra digits for intermediate steps + three = Decimal(3) # substitute "three=3.0" for regular floats + lasts, t, s, n, na, d, da = 0, three, 3, 1, 0, 0, 24 + while s != lasts: + lasts = s + n, na = n+na, na+8 + d, da = d+da, da+32 + t = (t * n) / d + s += t + getcontext().prec -= 2 + return +s # unary plus applies the new precision + + def exp(x): + """Return e raised to the power of x. Result type matches input type. + + >>> print(exp(Decimal(1))) + 2.718281828459045235360287471 + >>> print(exp(Decimal(2))) + 7.389056098930650227230427461 + >>> print(exp(2.0)) + 7.38905609893 + >>> print(exp(2+0j)) + (7.38905609893+0j) + + """ + getcontext().prec += 2 + i, lasts, s, fact, num = 0, 0, 1, 1, 1 + while s != lasts: + lasts = s + i += 1 + fact *= i + num *= x + s += num / fact + getcontext().prec -= 2 + return +s + + def cos(x): + """Return the cosine of x as measured in radians. + + The Taylor series approximation works best for a small value of x. + For larger values, first compute x = x % (2 * pi). + + >>> print(cos(Decimal('0.5'))) + 0.8775825618903727161162815826 + >>> print(cos(0.5)) + 0.87758256189 + >>> print(cos(0.5+0j)) + (0.87758256189+0j) + + """ + getcontext().prec += 2 + i, lasts, s, fact, num, sign = 0, 0, 1, 1, 1, 1 + while s != lasts: + lasts = s + i += 2 + fact *= i * (i-1) + num *= x * x + sign *= -1 + s += num / fact * sign + getcontext().prec -= 2 + return +s + + def sin(x): + """Return the sine of x as measured in radians. + + The Taylor series approximation works best for a small value of x. + For larger values, first compute x = x % (2 * pi). + + >>> print(sin(Decimal('0.5'))) + 0.4794255386042030002732879352 + >>> print(sin(0.5)) + 0.479425538604 + >>> print(sin(0.5+0j)) + (0.479425538604+0j) + + """ + getcontext().prec += 2 + i, lasts, s, fact, num, sign = 1, 0, x, 1, x, 1 + while s != lasts: + lasts = s + i += 2 + fact *= i * (i-1) + num *= x * x + sign *= -1 + s += num / fact * sign + getcontext().prec -= 2 + return +s + + +.. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + +.. _decimal-faq: + +Decimal FAQ +----------- + +Q. It is cumbersome to type ``decimal.Decimal('1234.5')``. Is there a way to +minimize typing when using the interactive interpreter? + +A. Some users abbreviate the constructor to just a single letter: + + >>> D = decimal.Decimal + >>> D('1.23') + D('3.45') + Decimal('4.68') + +Q. In a fixed-point application with two decimal places, some inputs have many +places and need to be rounded. Others are not supposed to have excess digits +and need to be validated. What methods should be used? + +A. The :meth:`quantize` method rounds to a fixed number of decimal places. If +the :const:`Inexact` trap is set, it is also useful for validation: + + >>> TWOPLACES = Decimal(10) ** -2 # same as Decimal('0.01') + + >>> # Round to two places + >>> Decimal('3.214').quantize(TWOPLACES) + Decimal('3.21') + + >>> # Validate that a number does not exceed two places + >>> Decimal('3.21').quantize(TWOPLACES, context=Context(traps=[Inexact])) + Decimal('3.21') + + >>> Decimal('3.214').quantize(TWOPLACES, context=Context(traps=[Inexact])) + Traceback (most recent call last): + ... + Inexact: None + +Q. Once I have valid two place inputs, how do I maintain that invariant +throughout an application? + +A. Some operations like addition, subtraction, and multiplication by an integer +will automatically preserve fixed point. Others operations, like division and +non-integer multiplication, will change the number of decimal places and need to +be followed-up with a :meth:`quantize` step: + + >>> a = Decimal('102.72') # Initial fixed-point values + >>> b = Decimal('3.17') + >>> a + b # Addition preserves fixed-point + Decimal('105.89') + >>> a - b + Decimal('99.55') + >>> a * 42 # So does integer multiplication + Decimal('4314.24') + >>> (a * b).quantize(TWOPLACES) # Must quantize non-integer multiplication + Decimal('325.62') + >>> (b / a).quantize(TWOPLACES) # And quantize division + Decimal('0.03') + +In developing fixed-point applications, it is convenient to define functions +to handle the :meth:`quantize` step: + + >>> def mul(x, y, fp=TWOPLACES): + ... return (x * y).quantize(fp) + >>> def div(x, y, fp=TWOPLACES): + ... return (x / y).quantize(fp) + + >>> mul(a, b) # Automatically preserve fixed-point + Decimal('325.62') + >>> div(b, a) + Decimal('0.03') + +Q. There are many ways to express the same value. The numbers :const:`200`, +:const:`200.000`, :const:`2E2`, and :const:`.02E+4` all have the same value at +various precisions. Is there a way to transform them to a single recognizable +canonical value? + +A. The :meth:`normalize` method maps all equivalent values to a single +representative: + + >>> values = map(Decimal, '200 200.000 2E2 .02E+4'.split()) + >>> [v.normalize() for v in values] + [Decimal('2E+2'), Decimal('2E+2'), Decimal('2E+2'), Decimal('2E+2')] + +Q. Some decimal values always print with exponential notation. Is there a way +to get a non-exponential representation? + +A. For some values, exponential notation is the only way to express the number +of significant places in the coefficient. For example, expressing +:const:`5.0E+3` as :const:`5000` keeps the value constant but cannot show the +original's two-place significance. + +If an application does not care about tracking significance, it is easy to +remove the exponent and trailing zeroes, losing significance, but keeping the +value unchanged: + + >>> def remove_exponent(d): + ... return d.quantize(Decimal(1)) if d == d.to_integral() else d.normalize() + + >>> remove_exponent(Decimal('5E+3')) + Decimal('5000') + +Q. Is there a way to convert a regular float to a :class:`Decimal`? + +A. Yes, any binary floating point number can be exactly expressed as a +Decimal though an exact conversion may take more precision than intuition would +suggest: + +.. doctest:: + + >>> Decimal(math.pi) + Decimal('3.141592653589793115997963468544185161590576171875') + +Q. Within a complex calculation, how can I make sure that I haven't gotten a +spurious result because of insufficient precision or rounding anomalies. + +A. The decimal module makes it easy to test results. A best practice is to +re-run calculations using greater precision and with various rounding modes. +Widely differing results indicate insufficient precision, rounding mode issues, +ill-conditioned inputs, or a numerically unstable algorithm. + +Q. I noticed that context precision is applied to the results of operations but +not to the inputs. Is there anything to watch out for when mixing values of +different precisions? + +A. Yes. The principle is that all values are considered to be exact and so is +the arithmetic on those values. Only the results are rounded. The advantage +for inputs is that "what you type is what you get". A disadvantage is that the +results can look odd if you forget that the inputs haven't been rounded: + +.. doctest:: newcontext + + >>> getcontext().prec = 3 + >>> Decimal('3.104') + Decimal('2.104') + Decimal('5.21') + >>> Decimal('3.104') + Decimal('0.000') + Decimal('2.104') + Decimal('5.20') + +The solution is either to increase precision or to force rounding of inputs +using the unary plus operation: + +.. doctest:: newcontext + + >>> getcontext().prec = 3 + >>> +Decimal('1.23456789') # unary plus triggers rounding + Decimal('1.23') + +Alternatively, inputs can be rounded upon creation using the +:meth:`Context.create_decimal` method: + + >>> Context(prec=5, rounding=ROUND_DOWN).create_decimal('1.2345678') + Decimal('1.2345') + +Q. Is the CPython implementation fast for large numbers? + +A. Yes. In the CPython and PyPy3 implementations, the C/CFFI versions of +the decimal module integrate the high speed `libmpdec +`_ library for +arbitrary precision correctly-rounded decimal floating point arithmetic. +``libmpdec`` uses `Karatsuba multiplication +`_ +for medium-sized numbers and the `Number Theoretic Transform +`_ +for very large numbers. However, to realize this performance gain, the +context needs to be set for unrounded calculations. + + >>> c = getcontext() + >>> c.prec = MAX_PREC + >>> c.Emax = MAX_EMAX + >>> c.Emin = MIN_EMIN + +.. versionadded:: 3.3 \ No newline at end of file diff --git a/python-3.7.4-docs-html/_sources/library/development.rst.txt b/python-3.7.4-docs-html/_sources/library/development.rst.txt new file mode 100644 index 0000000..ab34e1f --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/development.rst.txt @@ -0,0 +1,29 @@ +.. _development: + +***************** +Development Tools +***************** + +The modules described in this chapter help you write software. For example, the +:mod:`pydoc` module takes a module and generates documentation based on the +module's contents. The :mod:`doctest` and :mod:`unittest` modules contains +frameworks for writing unit tests that automatically exercise code and verify +that the expected output is produced. :program:`2to3` can translate Python 2.x +source code into valid Python 3.x code. + +The list of modules described in this chapter is: + + +.. toctree:: + + typing.rst + pydoc.rst + doctest.rst + unittest.rst + unittest.mock.rst + unittest.mock-examples.rst + 2to3.rst + test.rst + +See also the Python development mode: the :option:`-X` ``dev`` option and +:envvar:`PYTHONDEVMODE` environment variable. diff --git a/python-3.7.4-docs-html/_sources/library/difflib.rst.txt b/python-3.7.4-docs-html/_sources/library/difflib.rst.txt new file mode 100644 index 0000000..f044cb2 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/difflib.rst.txt @@ -0,0 +1,746 @@ +:mod:`difflib` --- Helpers for computing deltas +=============================================== + +.. module:: difflib + :synopsis: Helpers for computing differences between objects. + +.. moduleauthor:: Tim Peters +.. sectionauthor:: Tim Peters +.. Markup by Fred L. Drake, Jr. + +**Source code:** :source:`Lib/difflib.py` + +.. testsetup:: + + import sys + from difflib import * + +-------------- + +This module provides classes and functions for comparing sequences. It +can be used for example, for comparing files, and can produce difference +information in various formats, including HTML and context and unified +diffs. For comparing directories and files, see also, the :mod:`filecmp` module. + + +.. class:: SequenceMatcher + + This is a flexible class for comparing pairs of sequences of any type, so long + as the sequence elements are :term:`hashable`. The basic algorithm predates, and is a + little fancier than, an algorithm published in the late 1980's by Ratcliff and + Obershelp under the hyperbolic name "gestalt pattern matching." The idea is to + find the longest contiguous matching subsequence that contains no "junk" + elements; these "junk" elements are ones that are uninteresting in some + sense, such as blank lines or whitespace. (Handling junk is an + extension to the Ratcliff and Obershelp algorithm.) The same + idea is then applied recursively to the pieces of the sequences to the left and + to the right of the matching subsequence. This does not yield minimal edit + sequences, but does tend to yield matches that "look right" to people. + + **Timing:** The basic Ratcliff-Obershelp algorithm is cubic time in the worst + case and quadratic time in the expected case. :class:`SequenceMatcher` is + quadratic time for the worst case and has expected-case behavior dependent in a + complicated way on how many elements the sequences have in common; best case + time is linear. + + **Automatic junk heuristic:** :class:`SequenceMatcher` supports a heuristic that + automatically treats certain sequence items as junk. The heuristic counts how many + times each individual item appears in the sequence. If an item's duplicates (after + the first one) account for more than 1% of the sequence and the sequence is at least + 200 items long, this item is marked as "popular" and is treated as junk for + the purpose of sequence matching. This heuristic can be turned off by setting + the ``autojunk`` argument to ``False`` when creating the :class:`SequenceMatcher`. + + .. versionadded:: 3.2 + The *autojunk* parameter. + + +.. class:: Differ + + This is a class for comparing sequences of lines of text, and producing + human-readable differences or deltas. Differ uses :class:`SequenceMatcher` + both to compare sequences of lines, and to compare sequences of characters + within similar (near-matching) lines. + + Each line of a :class:`Differ` delta begins with a two-letter code: + + +----------+-------------------------------------------+ + | Code | Meaning | + +==========+===========================================+ + | ``'- '`` | line unique to sequence 1 | + +----------+-------------------------------------------+ + | ``'+ '`` | line unique to sequence 2 | + +----------+-------------------------------------------+ + | ``' '`` | line common to both sequences | + +----------+-------------------------------------------+ + | ``'? '`` | line not present in either input sequence | + +----------+-------------------------------------------+ + + Lines beginning with '``?``' attempt to guide the eye to intraline differences, + and were not present in either input sequence. These lines can be confusing if + the sequences contain tab characters. + + +.. class:: HtmlDiff + + This class can be used to create an HTML table (or a complete HTML file + containing the table) showing a side by side, line by line comparison of text + with inter-line and intra-line change highlights. The table can be generated in + either full or contextual difference mode. + + The constructor for this class is: + + + .. method:: __init__(tabsize=8, wrapcolumn=None, linejunk=None, charjunk=IS_CHARACTER_JUNK) + + Initializes instance of :class:`HtmlDiff`. + + *tabsize* is an optional keyword argument to specify tab stop spacing and + defaults to ``8``. + + *wrapcolumn* is an optional keyword to specify column number where lines are + broken and wrapped, defaults to ``None`` where lines are not wrapped. + + *linejunk* and *charjunk* are optional keyword arguments passed into :func:`ndiff` + (used by :class:`HtmlDiff` to generate the side by side HTML differences). See + :func:`ndiff` documentation for argument default values and descriptions. + + The following methods are public: + + .. method:: make_file(fromlines, tolines, fromdesc='', todesc='', context=False, \ + numlines=5, *, charset='utf-8') + + Compares *fromlines* and *tolines* (lists of strings) and returns a string which + is a complete HTML file containing a table showing line by line differences with + inter-line and intra-line changes highlighted. + + *fromdesc* and *todesc* are optional keyword arguments to specify from/to file + column header strings (both default to an empty string). + + *context* and *numlines* are both optional keyword arguments. Set *context* to + ``True`` when contextual differences are to be shown, else the default is + ``False`` to show the full files. *numlines* defaults to ``5``. When *context* + is ``True`` *numlines* controls the number of context lines which surround the + difference highlights. When *context* is ``False`` *numlines* controls the + number of lines which are shown before a difference highlight when using the + "next" hyperlinks (setting to zero would cause the "next" hyperlinks to place + the next difference highlight at the top of the browser without any leading + context). + + .. versionchanged:: 3.5 + *charset* keyword-only argument was added. The default charset of + HTML document changed from ``'ISO-8859-1'`` to ``'utf-8'``. + + .. method:: make_table(fromlines, tolines, fromdesc='', todesc='', context=False, numlines=5) + + Compares *fromlines* and *tolines* (lists of strings) and returns a string which + is a complete HTML table showing line by line differences with inter-line and + intra-line changes highlighted. + + The arguments for this method are the same as those for the :meth:`make_file` + method. + + :file:`Tools/scripts/diff.py` is a command-line front-end to this class and + contains a good example of its use. + + +.. function:: context_diff(a, b, fromfile='', tofile='', fromfiledate='', tofiledate='', n=3, lineterm='\\n') + + Compare *a* and *b* (lists of strings); return a delta (a :term:`generator` + generating the delta lines) in context diff format. + + Context diffs are a compact way of showing just the lines that have changed plus + a few lines of context. The changes are shown in a before/after style. The + number of context lines is set by *n* which defaults to three. + + By default, the diff control lines (those with ``***`` or ``---``) are created + with a trailing newline. This is helpful so that inputs created from + :func:`io.IOBase.readlines` result in diffs that are suitable for use with + :func:`io.IOBase.writelines` since both the inputs and outputs have trailing + newlines. + + For inputs that do not have trailing newlines, set the *lineterm* argument to + ``""`` so that the output will be uniformly newline free. + + The context diff format normally has a header for filenames and modification + times. Any or all of these may be specified using strings for *fromfile*, + *tofile*, *fromfiledate*, and *tofiledate*. The modification times are normally + expressed in the ISO 8601 format. If not specified, the + strings default to blanks. + + >>> s1 = ['bacon\n', 'eggs\n', 'ham\n', 'guido\n'] + >>> s2 = ['python\n', 'eggy\n', 'hamster\n', 'guido\n'] + >>> sys.stdout.writelines(context_diff(s1, s2, fromfile='before.py', tofile='after.py')) + *** before.py + --- after.py + *************** + *** 1,4 **** + ! bacon + ! eggs + ! ham + guido + --- 1,4 ---- + ! python + ! eggy + ! hamster + guido + + See :ref:`difflib-interface` for a more detailed example. + + +.. function:: get_close_matches(word, possibilities, n=3, cutoff=0.6) + + Return a list of the best "good enough" matches. *word* is a sequence for which + close matches are desired (typically a string), and *possibilities* is a list of + sequences against which to match *word* (typically a list of strings). + + Optional argument *n* (default ``3``) is the maximum number of close matches to + return; *n* must be greater than ``0``. + + Optional argument *cutoff* (default ``0.6``) is a float in the range [0, 1]. + Possibilities that don't score at least that similar to *word* are ignored. + + The best (no more than *n*) matches among the possibilities are returned in a + list, sorted by similarity score, most similar first. + + >>> get_close_matches('appel', ['ape', 'apple', 'peach', 'puppy']) + ['apple', 'ape'] + >>> import keyword + >>> get_close_matches('wheel', keyword.kwlist) + ['while'] + >>> get_close_matches('pineapple', keyword.kwlist) + [] + >>> get_close_matches('accept', keyword.kwlist) + ['except'] + + +.. function:: ndiff(a, b, linejunk=None, charjunk=IS_CHARACTER_JUNK) + + Compare *a* and *b* (lists of strings); return a :class:`Differ`\ -style + delta (a :term:`generator` generating the delta lines). + + Optional keyword parameters *linejunk* and *charjunk* are filtering functions + (or ``None``): + + *linejunk*: A function that accepts a single string argument, and returns + true if the string is junk, or false if not. The default is ``None``. There + is also a module-level function :func:`IS_LINE_JUNK`, which filters out lines + without visible characters, except for at most one pound character (``'#'``) + -- however the underlying :class:`SequenceMatcher` class does a dynamic + analysis of which lines are so frequent as to constitute noise, and this + usually works better than using this function. + + *charjunk*: A function that accepts a character (a string of length 1), and + returns if the character is junk, or false if not. The default is module-level + function :func:`IS_CHARACTER_JUNK`, which filters out whitespace characters (a + blank or tab; it's a bad idea to include newline in this!). + + :file:`Tools/scripts/ndiff.py` is a command-line front-end to this function. + + >>> diff = ndiff('one\ntwo\nthree\n'.splitlines(keepends=True), + ... 'ore\ntree\nemu\n'.splitlines(keepends=True)) + >>> print(''.join(diff), end="") + - one + ? ^ + + ore + ? ^ + - two + - three + ? - + + tree + + emu + + +.. function:: restore(sequence, which) + + Return one of the two sequences that generated a delta. + + Given a *sequence* produced by :meth:`Differ.compare` or :func:`ndiff`, extract + lines originating from file 1 or 2 (parameter *which*), stripping off line + prefixes. + + Example: + + >>> diff = ndiff('one\ntwo\nthree\n'.splitlines(keepends=True), + ... 'ore\ntree\nemu\n'.splitlines(keepends=True)) + >>> diff = list(diff) # materialize the generated delta into a list + >>> print(''.join(restore(diff, 1)), end="") + one + two + three + >>> print(''.join(restore(diff, 2)), end="") + ore + tree + emu + + +.. function:: unified_diff(a, b, fromfile='', tofile='', fromfiledate='', tofiledate='', n=3, lineterm='\\n') + + Compare *a* and *b* (lists of strings); return a delta (a :term:`generator` + generating the delta lines) in unified diff format. + + Unified diffs are a compact way of showing just the lines that have changed plus + a few lines of context. The changes are shown in an inline style (instead of + separate before/after blocks). The number of context lines is set by *n* which + defaults to three. + + By default, the diff control lines (those with ``---``, ``+++``, or ``@@``) are + created with a trailing newline. This is helpful so that inputs created from + :func:`io.IOBase.readlines` result in diffs that are suitable for use with + :func:`io.IOBase.writelines` since both the inputs and outputs have trailing + newlines. + + For inputs that do not have trailing newlines, set the *lineterm* argument to + ``""`` so that the output will be uniformly newline free. + + The context diff format normally has a header for filenames and modification + times. Any or all of these may be specified using strings for *fromfile*, + *tofile*, *fromfiledate*, and *tofiledate*. The modification times are normally + expressed in the ISO 8601 format. If not specified, the + strings default to blanks. + + + >>> s1 = ['bacon\n', 'eggs\n', 'ham\n', 'guido\n'] + >>> s2 = ['python\n', 'eggy\n', 'hamster\n', 'guido\n'] + >>> sys.stdout.writelines(unified_diff(s1, s2, fromfile='before.py', tofile='after.py')) + --- before.py + +++ after.py + @@ -1,4 +1,4 @@ + -bacon + -eggs + -ham + +python + +eggy + +hamster + guido + + See :ref:`difflib-interface` for a more detailed example. + +.. function:: diff_bytes(dfunc, a, b, fromfile=b'', tofile=b'', fromfiledate=b'', tofiledate=b'', n=3, lineterm=b'\\n') + + Compare *a* and *b* (lists of bytes objects) using *dfunc*; yield a + sequence of delta lines (also bytes) in the format returned by *dfunc*. + *dfunc* must be a callable, typically either :func:`unified_diff` or + :func:`context_diff`. + + Allows you to compare data with unknown or inconsistent encoding. All + inputs except *n* must be bytes objects, not str. Works by losslessly + converting all inputs (except *n*) to str, and calling ``dfunc(a, b, + fromfile, tofile, fromfiledate, tofiledate, n, lineterm)``. The output of + *dfunc* is then converted back to bytes, so the delta lines that you + receive have the same unknown/inconsistent encodings as *a* and *b*. + + .. versionadded:: 3.5 + +.. function:: IS_LINE_JUNK(line) + + Return true for ignorable lines. The line *line* is ignorable if *line* is + blank or contains a single ``'#'``, otherwise it is not ignorable. Used as a + default for parameter *linejunk* in :func:`ndiff` in older versions. + + +.. function:: IS_CHARACTER_JUNK(ch) + + Return true for ignorable characters. The character *ch* is ignorable if *ch* + is a space or tab, otherwise it is not ignorable. Used as a default for + parameter *charjunk* in :func:`ndiff`. + + +.. seealso:: + + `Pattern Matching: The Gestalt Approach `_ + Discussion of a similar algorithm by John W. Ratcliff and D. E. Metzener. This + was published in `Dr. Dobb's Journal `_ in July, 1988. + + +.. _sequence-matcher: + +SequenceMatcher Objects +----------------------- + +The :class:`SequenceMatcher` class has this constructor: + + +.. class:: SequenceMatcher(isjunk=None, a='', b='', autojunk=True) + + Optional argument *isjunk* must be ``None`` (the default) or a one-argument + function that takes a sequence element and returns true if and only if the + element is "junk" and should be ignored. Passing ``None`` for *isjunk* is + equivalent to passing ``lambda x: 0``; in other words, no elements are ignored. + For example, pass:: + + lambda x: x in " \t" + + if you're comparing lines as sequences of characters, and don't want to synch up + on blanks or hard tabs. + + The optional arguments *a* and *b* are sequences to be compared; both default to + empty strings. The elements of both sequences must be :term:`hashable`. + + The optional argument *autojunk* can be used to disable the automatic junk + heuristic. + + .. versionadded:: 3.2 + The *autojunk* parameter. + + SequenceMatcher objects get three data attributes: *bjunk* is the + set of elements of *b* for which *isjunk* is ``True``; *bpopular* is the set of + non-junk elements considered popular by the heuristic (if it is not + disabled); *b2j* is a dict mapping the remaining elements of *b* to a list + of positions where they occur. All three are reset whenever *b* is reset + with :meth:`set_seqs` or :meth:`set_seq2`. + + .. versionadded:: 3.2 + The *bjunk* and *bpopular* attributes. + + :class:`SequenceMatcher` objects have the following methods: + + .. method:: set_seqs(a, b) + + Set the two sequences to be compared. + + :class:`SequenceMatcher` computes and caches detailed information about the + second sequence, so if you want to compare one sequence against many + sequences, use :meth:`set_seq2` to set the commonly used sequence once and + call :meth:`set_seq1` repeatedly, once for each of the other sequences. + + + .. method:: set_seq1(a) + + Set the first sequence to be compared. The second sequence to be compared + is not changed. + + + .. method:: set_seq2(b) + + Set the second sequence to be compared. The first sequence to be compared + is not changed. + + + .. method:: find_longest_match(alo, ahi, blo, bhi) + + Find longest matching block in ``a[alo:ahi]`` and ``b[blo:bhi]``. + + If *isjunk* was omitted or ``None``, :meth:`find_longest_match` returns + ``(i, j, k)`` such that ``a[i:i+k]`` is equal to ``b[j:j+k]``, where ``alo + <= i <= i+k <= ahi`` and ``blo <= j <= j+k <= bhi``. For all ``(i', j', + k')`` meeting those conditions, the additional conditions ``k >= k'``, ``i + <= i'``, and if ``i == i'``, ``j <= j'`` are also met. In other words, of + all maximal matching blocks, return one that starts earliest in *a*, and + of all those maximal matching blocks that start earliest in *a*, return + the one that starts earliest in *b*. + + >>> s = SequenceMatcher(None, " abcd", "abcd abcd") + >>> s.find_longest_match(0, 5, 0, 9) + Match(a=0, b=4, size=5) + + If *isjunk* was provided, first the longest matching block is determined + as above, but with the additional restriction that no junk element appears + in the block. Then that block is extended as far as possible by matching + (only) junk elements on both sides. So the resulting block never matches + on junk except as identical junk happens to be adjacent to an interesting + match. + + Here's the same example as before, but considering blanks to be junk. That + prevents ``' abcd'`` from matching the ``' abcd'`` at the tail end of the + second sequence directly. Instead only the ``'abcd'`` can match, and + matches the leftmost ``'abcd'`` in the second sequence: + + >>> s = SequenceMatcher(lambda x: x==" ", " abcd", "abcd abcd") + >>> s.find_longest_match(0, 5, 0, 9) + Match(a=1, b=0, size=4) + + If no blocks match, this returns ``(alo, blo, 0)``. + + This method returns a :term:`named tuple` ``Match(a, b, size)``. + + + .. method:: get_matching_blocks() + + Return list of triples describing non-overlapping matching subsequences. + Each triple is of the form ``(i, j, n)``, + and means that ``a[i:i+n] == b[j:j+n]``. The + triples are monotonically increasing in *i* and *j*. + + The last triple is a dummy, and has the value ``(len(a), len(b), 0)``. It + is the only triple with ``n == 0``. If ``(i, j, n)`` and ``(i', j', n')`` + are adjacent triples in the list, and the second is not the last triple in + the list, then ``i+n < i'`` or ``j+n < j'``; in other words, adjacent + triples always describe non-adjacent equal blocks. + + .. XXX Explain why a dummy is used! + + .. doctest:: + + >>> s = SequenceMatcher(None, "abxcd", "abcd") + >>> s.get_matching_blocks() + [Match(a=0, b=0, size=2), Match(a=3, b=2, size=2), Match(a=5, b=4, size=0)] + + + .. method:: get_opcodes() + + Return list of 5-tuples describing how to turn *a* into *b*. Each tuple is + of the form ``(tag, i1, i2, j1, j2)``. The first tuple has ``i1 == j1 == + 0``, and remaining tuples have *i1* equal to the *i2* from the preceding + tuple, and, likewise, *j1* equal to the previous *j2*. + + The *tag* values are strings, with these meanings: + + +---------------+---------------------------------------------+ + | Value | Meaning | + +===============+=============================================+ + | ``'replace'`` | ``a[i1:i2]`` should be replaced by | + | | ``b[j1:j2]``. | + +---------------+---------------------------------------------+ + | ``'delete'`` | ``a[i1:i2]`` should be deleted. Note that | + | | ``j1 == j2`` in this case. | + +---------------+---------------------------------------------+ + | ``'insert'`` | ``b[j1:j2]`` should be inserted at | + | | ``a[i1:i1]``. Note that ``i1 == i2`` in | + | | this case. | + +---------------+---------------------------------------------+ + | ``'equal'`` | ``a[i1:i2] == b[j1:j2]`` (the sub-sequences | + | | are equal). | + +---------------+---------------------------------------------+ + + For example:: + + >>> a = "qabxcd" + >>> b = "abycdf" + >>> s = SequenceMatcher(None, a, b) + >>> for tag, i1, i2, j1, j2 in s.get_opcodes(): + ... print('{:7} a[{}:{}] --> b[{}:{}] {!r:>8} --> {!r}'.format( + ... tag, i1, i2, j1, j2, a[i1:i2], b[j1:j2])) + delete a[0:1] --> b[0:0] 'q' --> '' + equal a[1:3] --> b[0:2] 'ab' --> 'ab' + replace a[3:4] --> b[2:3] 'x' --> 'y' + equal a[4:6] --> b[3:5] 'cd' --> 'cd' + insert a[6:6] --> b[5:6] '' --> 'f' + + + .. method:: get_grouped_opcodes(n=3) + + Return a :term:`generator` of groups with up to *n* lines of context. + + Starting with the groups returned by :meth:`get_opcodes`, this method + splits out smaller change clusters and eliminates intervening ranges which + have no changes. + + The groups are returned in the same format as :meth:`get_opcodes`. + + + .. method:: ratio() + + Return a measure of the sequences' similarity as a float in the range [0, + 1]. + + Where T is the total number of elements in both sequences, and M is the + number of matches, this is 2.0\*M / T. Note that this is ``1.0`` if the + sequences are identical, and ``0.0`` if they have nothing in common. + + This is expensive to compute if :meth:`get_matching_blocks` or + :meth:`get_opcodes` hasn't already been called, in which case you may want + to try :meth:`quick_ratio` or :meth:`real_quick_ratio` first to get an + upper bound. + + + .. method:: quick_ratio() + + Return an upper bound on :meth:`ratio` relatively quickly. + + + .. method:: real_quick_ratio() + + Return an upper bound on :meth:`ratio` very quickly. + + +The three methods that return the ratio of matching to total characters can give +different results due to differing levels of approximation, although +:meth:`quick_ratio` and :meth:`real_quick_ratio` are always at least as large as +:meth:`ratio`: + + >>> s = SequenceMatcher(None, "abcd", "bcde") + >>> s.ratio() + 0.75 + >>> s.quick_ratio() + 0.75 + >>> s.real_quick_ratio() + 1.0 + + +.. _sequencematcher-examples: + +SequenceMatcher Examples +------------------------ + +This example compares two strings, considering blanks to be "junk": + + >>> s = SequenceMatcher(lambda x: x == " ", + ... "private Thread currentThread;", + ... "private volatile Thread currentThread;") + +:meth:`ratio` returns a float in [0, 1], measuring the similarity of the +sequences. As a rule of thumb, a :meth:`ratio` value over 0.6 means the +sequences are close matches: + + >>> print(round(s.ratio(), 3)) + 0.866 + +If you're only interested in where the sequences match, +:meth:`get_matching_blocks` is handy: + + >>> for block in s.get_matching_blocks(): + ... print("a[%d] and b[%d] match for %d elements" % block) + a[0] and b[0] match for 8 elements + a[8] and b[17] match for 21 elements + a[29] and b[38] match for 0 elements + +Note that the last tuple returned by :meth:`get_matching_blocks` is always a +dummy, ``(len(a), len(b), 0)``, and this is the only case in which the last +tuple element (number of elements matched) is ``0``. + +If you want to know how to change the first sequence into the second, use +:meth:`get_opcodes`: + + >>> for opcode in s.get_opcodes(): + ... print("%6s a[%d:%d] b[%d:%d]" % opcode) + equal a[0:8] b[0:8] + insert a[8:8] b[8:17] + equal a[8:29] b[17:38] + +.. seealso:: + + * The :func:`get_close_matches` function in this module which shows how + simple code building on :class:`SequenceMatcher` can be used to do useful + work. + + * `Simple version control recipe + `_ for a small application + built with :class:`SequenceMatcher`. + + +.. _differ-objects: + +Differ Objects +-------------- + +Note that :class:`Differ`\ -generated deltas make no claim to be **minimal** +diffs. To the contrary, minimal diffs are often counter-intuitive, because they +synch up anywhere possible, sometimes accidental matches 100 pages apart. +Restricting synch points to contiguous matches preserves some notion of +locality, at the occasional cost of producing a longer diff. + +The :class:`Differ` class has this constructor: + + +.. class:: Differ(linejunk=None, charjunk=None) + + Optional keyword parameters *linejunk* and *charjunk* are for filter functions + (or ``None``): + + *linejunk*: A function that accepts a single string argument, and returns true + if the string is junk. The default is ``None``, meaning that no line is + considered junk. + + *charjunk*: A function that accepts a single character argument (a string of + length 1), and returns true if the character is junk. The default is ``None``, + meaning that no character is considered junk. + + These junk-filtering functions speed up matching to find + differences and do not cause any differing lines or characters to + be ignored. Read the description of the + :meth:`~SequenceMatcher.find_longest_match` method's *isjunk* + parameter for an explanation. + + :class:`Differ` objects are used (deltas generated) via a single method: + + + .. method:: Differ.compare(a, b) + + Compare two sequences of lines, and generate the delta (a sequence of lines). + + Each sequence must contain individual single-line strings ending with + newlines. Such sequences can be obtained from the + :meth:`~io.IOBase.readlines` method of file-like objects. The delta + generated also consists of newline-terminated strings, ready to be + printed as-is via the :meth:`~io.IOBase.writelines` method of a + file-like object. + + +.. _differ-examples: + +Differ Example +-------------- + +This example compares two texts. First we set up the texts, sequences of +individual single-line strings ending with newlines (such sequences can also be +obtained from the :meth:`~io.BaseIO.readlines` method of file-like objects): + + >>> text1 = ''' 1. Beautiful is better than ugly. + ... 2. Explicit is better than implicit. + ... 3. Simple is better than complex. + ... 4. Complex is better than complicated. + ... '''.splitlines(keepends=True) + >>> len(text1) + 4 + >>> text1[0][-1] + '\n' + >>> text2 = ''' 1. Beautiful is better than ugly. + ... 3. Simple is better than complex. + ... 4. Complicated is better than complex. + ... 5. Flat is better than nested. + ... '''.splitlines(keepends=True) + +Next we instantiate a Differ object: + + >>> d = Differ() + +Note that when instantiating a :class:`Differ` object we may pass functions to +filter out line and character "junk." See the :meth:`Differ` constructor for +details. + +Finally, we compare the two: + + >>> result = list(d.compare(text1, text2)) + +``result`` is a list of strings, so let's pretty-print it: + + >>> from pprint import pprint + >>> pprint(result) + [' 1. Beautiful is better than ugly.\n', + '- 2. Explicit is better than implicit.\n', + '- 3. Simple is better than complex.\n', + '+ 3. Simple is better than complex.\n', + '? ++\n', + '- 4. Complex is better than complicated.\n', + '? ^ ---- ^\n', + '+ 4. Complicated is better than complex.\n', + '? ++++ ^ ^\n', + '+ 5. Flat is better than nested.\n'] + +As a single multi-line string it looks like this: + + >>> import sys + >>> sys.stdout.writelines(result) + 1. Beautiful is better than ugly. + - 2. Explicit is better than implicit. + - 3. Simple is better than complex. + + 3. Simple is better than complex. + ? ++ + - 4. Complex is better than complicated. + ? ^ ---- ^ + + 4. Complicated is better than complex. + ? ++++ ^ ^ + + 5. Flat is better than nested. + + +.. _difflib-interface: + +A command-line interface to difflib +----------------------------------- + +This example shows how to use difflib to create a ``diff``-like utility. +It is also contained in the Python source distribution, as +:file:`Tools/scripts/diff.py`. + +.. literalinclude:: ../../Tools/scripts/diff.py diff --git a/python-3.7.4-docs-html/_sources/library/dis.rst.txt b/python-3.7.4-docs-html/_sources/library/dis.rst.txt new file mode 100644 index 0000000..5e6f002 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/dis.rst.txt @@ -0,0 +1,1265 @@ +:mod:`dis` --- Disassembler for Python bytecode +=============================================== + +.. module:: dis + :synopsis: Disassembler for Python bytecode. + +**Source code:** :source:`Lib/dis.py` + +-------------- + +The :mod:`dis` module supports the analysis of CPython :term:`bytecode` by +disassembling it. The CPython bytecode which this module takes as an input is +defined in the file :file:`Include/opcode.h` and used by the compiler and the +interpreter. + +.. impl-detail:: + + Bytecode is an implementation detail of the CPython interpreter. No + guarantees are made that bytecode will not be added, removed, or changed + between versions of Python. Use of this module should not be considered to + work across Python VMs or Python releases. + + .. versionchanged:: 3.6 + Use 2 bytes for each instruction. Previously the number of bytes varied + by instruction. + + +Example: Given the function :func:`myfunc`:: + + def myfunc(alist): + return len(alist) + +the following command can be used to display the disassembly of +:func:`myfunc`:: + + >>> dis.dis(myfunc) + 2 0 LOAD_GLOBAL 0 (len) + 2 LOAD_FAST 0 (alist) + 4 CALL_FUNCTION 1 + 6 RETURN_VALUE + +(The "2" is a line number). + +Bytecode analysis +----------------- + +.. versionadded:: 3.4 + +The bytecode analysis API allows pieces of Python code to be wrapped in a +:class:`Bytecode` object that provides easy access to details of the compiled +code. + +.. class:: Bytecode(x, *, first_line=None, current_offset=None) + + + Analyse the bytecode corresponding to a function, generator, asynchronous + generator, coroutine, method, string of source code, or a code object (as + returned by :func:`compile`). + + This is a convenience wrapper around many of the functions listed below, most + notably :func:`get_instructions`, as iterating over a :class:`Bytecode` + instance yields the bytecode operations as :class:`Instruction` instances. + + If *first_line* is not ``None``, it indicates the line number that should be + reported for the first source line in the disassembled code. Otherwise, the + source line information (if any) is taken directly from the disassembled code + object. + + If *current_offset* is not ``None``, it refers to an instruction offset in the + disassembled code. Setting this means :meth:`.dis` will display a "current + instruction" marker against the specified opcode. + + .. classmethod:: from_traceback(tb) + + Construct a :class:`Bytecode` instance from the given traceback, setting + *current_offset* to the instruction responsible for the exception. + + .. data:: codeobj + + The compiled code object. + + .. data:: first_line + + The first source line of the code object (if available) + + .. method:: dis() + + Return a formatted view of the bytecode operations (the same as printed by + :func:`dis.dis`, but returned as a multi-line string). + + .. method:: info() + + Return a formatted multi-line string with detailed information about the + code object, like :func:`code_info`. + + .. versionchanged:: 3.7 + This can now handle coroutine and asynchronous generator objects. + +Example:: + + >>> bytecode = dis.Bytecode(myfunc) + >>> for instr in bytecode: + ... print(instr.opname) + ... + LOAD_GLOBAL + LOAD_FAST + CALL_FUNCTION + RETURN_VALUE + + +Analysis functions +------------------ + +The :mod:`dis` module also defines the following analysis functions that convert +the input directly to the desired output. They can be useful if only a single +operation is being performed, so the intermediate analysis object isn't useful: + +.. function:: code_info(x) + + Return a formatted multi-line string with detailed code object information + for the supplied function, generator, asynchronous generator, coroutine, + method, source code string or code object. + + Note that the exact contents of code info strings are highly implementation + dependent and they may change arbitrarily across Python VMs or Python + releases. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.7 + This can now handle coroutine and asynchronous generator objects. + + +.. function:: show_code(x, *, file=None) + + Print detailed code object information for the supplied function, method, + source code string or code object to *file* (or ``sys.stdout`` if *file* + is not specified). + + This is a convenient shorthand for ``print(code_info(x), file=file)``, + intended for interactive exploration at the interpreter prompt. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.4 + Added *file* parameter. + + +.. function:: dis(x=None, *, file=None, depth=None) + + Disassemble the *x* object. *x* can denote either a module, a class, a + method, a function, a generator, an asynchronous generator, a coroutine, + a code object, a string of source code or a byte sequence of raw bytecode. + For a module, it disassembles all functions. For a class, it disassembles + all methods (including class and static methods). For a code object or + sequence of raw bytecode, it prints one line per bytecode instruction. + It also recursively disassembles nested code objects (the code of + comprehensions, generator expressions and nested functions, and the code + used for building nested classes). + Strings are first compiled to code objects with the :func:`compile` + built-in function before being disassembled. If no object is provided, this + function disassembles the last traceback. + + The disassembly is written as text to the supplied *file* argument if + provided and to ``sys.stdout`` otherwise. + + The maximal depth of recursion is limited by *depth* unless it is ``None``. + ``depth=0`` means no recursion. + + .. versionchanged:: 3.4 + Added *file* parameter. + + .. versionchanged:: 3.7 + Implemented recursive disassembling and added *depth* parameter. + + .. versionchanged:: 3.7 + This can now handle coroutine and asynchronous generator objects. + + +.. function:: distb(tb=None, *, file=None) + + Disassemble the top-of-stack function of a traceback, using the last + traceback if none was passed. The instruction causing the exception is + indicated. + + The disassembly is written as text to the supplied *file* argument if + provided and to ``sys.stdout`` otherwise. + + .. versionchanged:: 3.4 + Added *file* parameter. + + +.. function:: disassemble(code, lasti=-1, *, file=None) + disco(code, lasti=-1, *, file=None) + + Disassemble a code object, indicating the last instruction if *lasti* was + provided. The output is divided in the following columns: + + #. the line number, for the first instruction of each line + #. the current instruction, indicated as ``-->``, + #. a labelled instruction, indicated with ``>>``, + #. the address of the instruction, + #. the operation code name, + #. operation parameters, and + #. interpretation of the parameters in parentheses. + + The parameter interpretation recognizes local and global variable names, + constant values, branch targets, and compare operators. + + The disassembly is written as text to the supplied *file* argument if + provided and to ``sys.stdout`` otherwise. + + .. versionchanged:: 3.4 + Added *file* parameter. + + +.. function:: get_instructions(x, *, first_line=None) + + Return an iterator over the instructions in the supplied function, method, + source code string or code object. + + The iterator generates a series of :class:`Instruction` named tuples giving + the details of each operation in the supplied code. + + If *first_line* is not ``None``, it indicates the line number that should be + reported for the first source line in the disassembled code. Otherwise, the + source line information (if any) is taken directly from the disassembled code + object. + + .. versionadded:: 3.4 + + +.. function:: findlinestarts(code) + + This generator function uses the ``co_firstlineno`` and ``co_lnotab`` + attributes of the code object *code* to find the offsets which are starts of + lines in the source code. They are generated as ``(offset, lineno)`` pairs. + See :source:`Objects/lnotab_notes.txt` for the ``co_lnotab`` format and + how to decode it. + + .. versionchanged:: 3.6 + Line numbers can be decreasing. Before, they were always increasing. + + +.. function:: findlabels(code) + + Detect all offsets in the code object *code* which are jump targets, and + return a list of these offsets. + + +.. function:: stack_effect(opcode, [oparg]) + + Compute the stack effect of *opcode* with argument *oparg*. + + .. versionadded:: 3.4 + +.. _bytecodes: + +Python Bytecode Instructions +---------------------------- + +The :func:`get_instructions` function and :class:`Bytecode` class provide +details of bytecode instructions as :class:`Instruction` instances: + +.. class:: Instruction + + Details for a bytecode operation + + .. data:: opcode + + numeric code for operation, corresponding to the opcode values listed + below and the bytecode values in the :ref:`opcode_collections`. + + + .. data:: opname + + human readable name for operation + + + .. data:: arg + + numeric argument to operation (if any), otherwise ``None`` + + + .. data:: argval + + resolved arg value (if known), otherwise same as arg + + + .. data:: argrepr + + human readable description of operation argument + + + .. data:: offset + + start index of operation within bytecode sequence + + + .. data:: starts_line + + line started by this opcode (if any), otherwise ``None`` + + + .. data:: is_jump_target + + ``True`` if other code jumps to here, otherwise ``False`` + + .. versionadded:: 3.4 + + +The Python compiler currently generates the following bytecode instructions. + + +**General instructions** + +.. opcode:: NOP + + Do nothing code. Used as a placeholder by the bytecode optimizer. + + +.. opcode:: POP_TOP + + Removes the top-of-stack (TOS) item. + + +.. opcode:: ROT_TWO + + Swaps the two top-most stack items. + + +.. opcode:: ROT_THREE + + Lifts second and third stack item one position up, moves top down to position + three. + + +.. opcode:: DUP_TOP + + Duplicates the reference on top of the stack. + + .. versionadded:: 3.2 + + +.. opcode:: DUP_TOP_TWO + + Duplicates the two references on top of the stack, leaving them in the + same order. + + .. versionadded:: 3.2 + + +**Unary operations** + +Unary operations take the top of the stack, apply the operation, and push the +result back on the stack. + +.. opcode:: UNARY_POSITIVE + + Implements ``TOS = +TOS``. + + +.. opcode:: UNARY_NEGATIVE + + Implements ``TOS = -TOS``. + + +.. opcode:: UNARY_NOT + + Implements ``TOS = not TOS``. + + +.. opcode:: UNARY_INVERT + + Implements ``TOS = ~TOS``. + + +.. opcode:: GET_ITER + + Implements ``TOS = iter(TOS)``. + + +.. opcode:: GET_YIELD_FROM_ITER + + If ``TOS`` is a :term:`generator iterator` or :term:`coroutine` object + it is left as is. Otherwise, implements ``TOS = iter(TOS)``. + + .. versionadded:: 3.5 + + +**Binary operations** + +Binary operations remove the top of the stack (TOS) and the second top-most +stack item (TOS1) from the stack. They perform the operation, and put the +result back on the stack. + +.. opcode:: BINARY_POWER + + Implements ``TOS = TOS1 ** TOS``. + + +.. opcode:: BINARY_MULTIPLY + + Implements ``TOS = TOS1 * TOS``. + + +.. opcode:: BINARY_MATRIX_MULTIPLY + + Implements ``TOS = TOS1 @ TOS``. + + .. versionadded:: 3.5 + + +.. opcode:: BINARY_FLOOR_DIVIDE + + Implements ``TOS = TOS1 // TOS``. + + +.. opcode:: BINARY_TRUE_DIVIDE + + Implements ``TOS = TOS1 / TOS``. + + +.. opcode:: BINARY_MODULO + + Implements ``TOS = TOS1 % TOS``. + + +.. opcode:: BINARY_ADD + + Implements ``TOS = TOS1 + TOS``. + + +.. opcode:: BINARY_SUBTRACT + + Implements ``TOS = TOS1 - TOS``. + + +.. opcode:: BINARY_SUBSCR + + Implements ``TOS = TOS1[TOS]``. + + +.. opcode:: BINARY_LSHIFT + + Implements ``TOS = TOS1 << TOS``. + + +.. opcode:: BINARY_RSHIFT + + Implements ``TOS = TOS1 >> TOS``. + + +.. opcode:: BINARY_AND + + Implements ``TOS = TOS1 & TOS``. + + +.. opcode:: BINARY_XOR + + Implements ``TOS = TOS1 ^ TOS``. + + +.. opcode:: BINARY_OR + + Implements ``TOS = TOS1 | TOS``. + + +**In-place operations** + +In-place operations are like binary operations, in that they remove TOS and +TOS1, and push the result back on the stack, but the operation is done in-place +when TOS1 supports it, and the resulting TOS may be (but does not have to be) +the original TOS1. + +.. opcode:: INPLACE_POWER + + Implements in-place ``TOS = TOS1 ** TOS``. + + +.. opcode:: INPLACE_MULTIPLY + + Implements in-place ``TOS = TOS1 * TOS``. + + +.. opcode:: INPLACE_MATRIX_MULTIPLY + + Implements in-place ``TOS = TOS1 @ TOS``. + + .. versionadded:: 3.5 + + +.. opcode:: INPLACE_FLOOR_DIVIDE + + Implements in-place ``TOS = TOS1 // TOS``. + + +.. opcode:: INPLACE_TRUE_DIVIDE + + Implements in-place ``TOS = TOS1 / TOS``. + + +.. opcode:: INPLACE_MODULO + + Implements in-place ``TOS = TOS1 % TOS``. + + +.. opcode:: INPLACE_ADD + + Implements in-place ``TOS = TOS1 + TOS``. + + +.. opcode:: INPLACE_SUBTRACT + + Implements in-place ``TOS = TOS1 - TOS``. + + +.. opcode:: INPLACE_LSHIFT + + Implements in-place ``TOS = TOS1 << TOS``. + + +.. opcode:: INPLACE_RSHIFT + + Implements in-place ``TOS = TOS1 >> TOS``. + + +.. opcode:: INPLACE_AND + + Implements in-place ``TOS = TOS1 & TOS``. + + +.. opcode:: INPLACE_XOR + + Implements in-place ``TOS = TOS1 ^ TOS``. + + +.. opcode:: INPLACE_OR + + Implements in-place ``TOS = TOS1 | TOS``. + + +.. opcode:: STORE_SUBSCR + + Implements ``TOS1[TOS] = TOS2``. + + +.. opcode:: DELETE_SUBSCR + + Implements ``del TOS1[TOS]``. + + +**Coroutine opcodes** + +.. opcode:: GET_AWAITABLE + + Implements ``TOS = get_awaitable(TOS)``, where ``get_awaitable(o)`` + returns ``o`` if ``o`` is a coroutine object or a generator object with + the CO_ITERABLE_COROUTINE flag, or resolves + ``o.__await__``. + + .. versionadded:: 3.5 + + +.. opcode:: GET_AITER + + Implements ``TOS = TOS.__aiter__()``. + + .. versionadded:: 3.5 + .. versionchanged:: 3.7 + Returning awaitable objects from ``__aiter__`` is no longer + supported. + + +.. opcode:: GET_ANEXT + + Implements ``PUSH(get_awaitable(TOS.__anext__()))``. See ``GET_AWAITABLE`` + for details about ``get_awaitable`` + + .. versionadded:: 3.5 + + +.. opcode:: BEFORE_ASYNC_WITH + + Resolves ``__aenter__`` and ``__aexit__`` from the object on top of the + stack. Pushes ``__aexit__`` and result of ``__aenter__()`` to the stack. + + .. versionadded:: 3.5 + + +.. opcode:: SETUP_ASYNC_WITH + + Creates a new frame object. + + .. versionadded:: 3.5 + + + +**Miscellaneous opcodes** + +.. opcode:: PRINT_EXPR + + Implements the expression statement for the interactive mode. TOS is removed + from the stack and printed. In non-interactive mode, an expression statement + is terminated with :opcode:`POP_TOP`. + + +.. opcode:: BREAK_LOOP + + Terminates a loop due to a :keyword:`break` statement. + + +.. opcode:: CONTINUE_LOOP (target) + + Continues a loop due to a :keyword:`continue` statement. *target* is the + address to jump to (which should be a :opcode:`FOR_ITER` instruction). + + +.. opcode:: SET_ADD (i) + + Calls ``set.add(TOS1[-i], TOS)``. Used to implement set comprehensions. + + +.. opcode:: LIST_APPEND (i) + + Calls ``list.append(TOS[-i], TOS)``. Used to implement list comprehensions. + + +.. opcode:: MAP_ADD (i) + + Calls ``dict.setitem(TOS1[-i], TOS, TOS1)``. Used to implement dict + comprehensions. + + .. versionadded:: 3.1 + +For all of the :opcode:`SET_ADD`, :opcode:`LIST_APPEND` and :opcode:`MAP_ADD` +instructions, while the added value or key/value pair is popped off, the +container object remains on the stack so that it is available for further +iterations of the loop. + + +.. opcode:: RETURN_VALUE + + Returns with TOS to the caller of the function. + + +.. opcode:: YIELD_VALUE + + Pops TOS and yields it from a :term:`generator`. + + +.. opcode:: YIELD_FROM + + Pops TOS and delegates to it as a subiterator from a :term:`generator`. + + .. versionadded:: 3.3 + + +.. opcode:: SETUP_ANNOTATIONS + + Checks whether ``__annotations__`` is defined in ``locals()``, if not it is + set up to an empty ``dict``. This opcode is only emitted if a class + or module body contains :term:`variable annotations ` + statically. + + .. versionadded:: 3.6 + + +.. opcode:: IMPORT_STAR + + Loads all symbols not starting with ``'_'`` directly from the module TOS to + the local namespace. The module is popped after loading all names. This + opcode implements ``from module import *``. + + +.. opcode:: POP_BLOCK + + Removes one block from the block stack. Per frame, there is a stack of + blocks, denoting nested loops, try statements, and such. + + +.. opcode:: POP_EXCEPT + + Removes one block from the block stack. The popped block must be an exception + handler block, as implicitly created when entering an except handler. In + addition to popping extraneous values from the frame stack, the last three + popped values are used to restore the exception state. + + +.. opcode:: END_FINALLY + + Terminates a :keyword:`finally` clause. The interpreter recalls whether the + exception has to be re-raised, or whether the function returns, and continues + with the outer-next block. + + +.. opcode:: LOAD_BUILD_CLASS + + Pushes :func:`builtins.__build_class__` onto the stack. It is later called + by :opcode:`CALL_FUNCTION` to construct a class. + + +.. opcode:: SETUP_WITH (delta) + + This opcode performs several operations before a with block starts. First, + it loads :meth:`~object.__exit__` from the context manager and pushes it onto + the stack for later use by :opcode:`WITH_CLEANUP`. Then, + :meth:`~object.__enter__` is called, and a finally block pointing to *delta* + is pushed. Finally, the result of calling the enter method is pushed onto + the stack. The next opcode will either ignore it (:opcode:`POP_TOP`), or + store it in (a) variable(s) (:opcode:`STORE_FAST`, :opcode:`STORE_NAME`, or + :opcode:`UNPACK_SEQUENCE`). + + .. versionadded:: 3.2 + + +.. opcode:: WITH_CLEANUP_START + + Cleans up the stack when a :keyword:`with` statement block exits. TOS is the + context manager's :meth:`__exit__` bound method. Below TOS are 1--3 values + indicating how/why the finally clause was entered: + + * SECOND = ``None`` + * (SECOND, THIRD) = (``WHY_{RETURN,CONTINUE}``), retval + * SECOND = ``WHY_*``; no retval below it + * (SECOND, THIRD, FOURTH) = exc_info() + + In the last case, ``TOS(SECOND, THIRD, FOURTH)`` is called, otherwise + ``TOS(None, None, None)``. Pushes SECOND and result of the call + to the stack. + + +.. opcode:: WITH_CLEANUP_FINISH + + Pops exception type and result of 'exit' function call from the stack. + + If the stack represents an exception, *and* the function call returns a + 'true' value, this information is "zapped" and replaced with a single + ``WHY_SILENCED`` to prevent :opcode:`END_FINALLY` from re-raising the + exception. (But non-local gotos will still be resumed.) + + .. XXX explain the WHY stuff! + + +All of the following opcodes use their arguments. + +.. opcode:: STORE_NAME (namei) + + Implements ``name = TOS``. *namei* is the index of *name* in the attribute + :attr:`co_names` of the code object. The compiler tries to use + :opcode:`STORE_FAST` or :opcode:`STORE_GLOBAL` if possible. + + +.. opcode:: DELETE_NAME (namei) + + Implements ``del name``, where *namei* is the index into :attr:`co_names` + attribute of the code object. + + +.. opcode:: UNPACK_SEQUENCE (count) + + Unpacks TOS into *count* individual values, which are put onto the stack + right-to-left. + + +.. opcode:: UNPACK_EX (counts) + + Implements assignment with a starred target: Unpacks an iterable in TOS into + individual values, where the total number of values can be smaller than the + number of items in the iterable: one of the new values will be a list of all + leftover items. + + The low byte of *counts* is the number of values before the list value, the + high byte of *counts* the number of values after it. The resulting values + are put onto the stack right-to-left. + + +.. opcode:: STORE_ATTR (namei) + + Implements ``TOS.name = TOS1``, where *namei* is the index of name in + :attr:`co_names`. + + +.. opcode:: DELETE_ATTR (namei) + + Implements ``del TOS.name``, using *namei* as index into :attr:`co_names`. + + +.. opcode:: STORE_GLOBAL (namei) + + Works as :opcode:`STORE_NAME`, but stores the name as a global. + + +.. opcode:: DELETE_GLOBAL (namei) + + Works as :opcode:`DELETE_NAME`, but deletes a global name. + + +.. opcode:: LOAD_CONST (consti) + + Pushes ``co_consts[consti]`` onto the stack. + + +.. opcode:: LOAD_NAME (namei) + + Pushes the value associated with ``co_names[namei]`` onto the stack. + + +.. opcode:: BUILD_TUPLE (count) + + Creates a tuple consuming *count* items from the stack, and pushes the + resulting tuple onto the stack. + + +.. opcode:: BUILD_LIST (count) + + Works as :opcode:`BUILD_TUPLE`, but creates a list. + + +.. opcode:: BUILD_SET (count) + + Works as :opcode:`BUILD_TUPLE`, but creates a set. + + +.. opcode:: BUILD_MAP (count) + + Pushes a new dictionary object onto the stack. Pops ``2 * count`` items + so that the dictionary holds *count* entries: + ``{..., TOS3: TOS2, TOS1: TOS}``. + + .. versionchanged:: 3.5 + The dictionary is created from stack items instead of creating an + empty dictionary pre-sized to hold *count* items. + + +.. opcode:: BUILD_CONST_KEY_MAP (count) + + The version of :opcode:`BUILD_MAP` specialized for constant keys. *count* + values are consumed from the stack. The top element on the stack contains + a tuple of keys. + + .. versionadded:: 3.6 + + +.. opcode:: BUILD_STRING (count) + + Concatenates *count* strings from the stack and pushes the resulting string + onto the stack. + + .. versionadded:: 3.6 + + +.. opcode:: BUILD_TUPLE_UNPACK (count) + + Pops *count* iterables from the stack, joins them in a single tuple, + and pushes the result. Implements iterable unpacking in tuple + displays ``(*x, *y, *z)``. + + .. versionadded:: 3.5 + + +.. opcode:: BUILD_TUPLE_UNPACK_WITH_CALL (count) + + This is similar to :opcode:`BUILD_TUPLE_UNPACK`, + but is used for ``f(*x, *y, *z)`` call syntax. The stack item at position + ``count + 1`` should be the corresponding callable ``f``. + + .. versionadded:: 3.6 + + +.. opcode:: BUILD_LIST_UNPACK (count) + + This is similar to :opcode:`BUILD_TUPLE_UNPACK`, but pushes a list + instead of tuple. Implements iterable unpacking in list + displays ``[*x, *y, *z]``. + + .. versionadded:: 3.5 + + +.. opcode:: BUILD_SET_UNPACK (count) + + This is similar to :opcode:`BUILD_TUPLE_UNPACK`, but pushes a set + instead of tuple. Implements iterable unpacking in set + displays ``{*x, *y, *z}``. + + .. versionadded:: 3.5 + + +.. opcode:: BUILD_MAP_UNPACK (count) + + Pops *count* mappings from the stack, merges them into a single dictionary, + and pushes the result. Implements dictionary unpacking in dictionary + displays ``{**x, **y, **z}``. + + .. versionadded:: 3.5 + + +.. opcode:: BUILD_MAP_UNPACK_WITH_CALL (count) + + This is similar to :opcode:`BUILD_MAP_UNPACK`, + but is used for ``f(**x, **y, **z)`` call syntax. The stack item at + position ``count + 2`` should be the corresponding callable ``f``. + + .. versionadded:: 3.5 + .. versionchanged:: 3.6 + The position of the callable is determined by adding 2 to the opcode + argument instead of encoding it in the second byte of the argument. + + +.. opcode:: LOAD_ATTR (namei) + + Replaces TOS with ``getattr(TOS, co_names[namei])``. + + +.. opcode:: COMPARE_OP (opname) + + Performs a Boolean operation. The operation name can be found in + ``cmp_op[opname]``. + + +.. opcode:: IMPORT_NAME (namei) + + Imports the module ``co_names[namei]``. TOS and TOS1 are popped and provide + the *fromlist* and *level* arguments of :func:`__import__`. The module + object is pushed onto the stack. The current namespace is not affected: for + a proper import statement, a subsequent :opcode:`STORE_FAST` instruction + modifies the namespace. + + +.. opcode:: IMPORT_FROM (namei) + + Loads the attribute ``co_names[namei]`` from the module found in TOS. The + resulting object is pushed onto the stack, to be subsequently stored by a + :opcode:`STORE_FAST` instruction. + + +.. opcode:: JUMP_FORWARD (delta) + + Increments bytecode counter by *delta*. + + +.. opcode:: POP_JUMP_IF_TRUE (target) + + If TOS is true, sets the bytecode counter to *target*. TOS is popped. + + .. versionadded:: 3.1 + + +.. opcode:: POP_JUMP_IF_FALSE (target) + + If TOS is false, sets the bytecode counter to *target*. TOS is popped. + + .. versionadded:: 3.1 + + +.. opcode:: JUMP_IF_TRUE_OR_POP (target) + + If TOS is true, sets the bytecode counter to *target* and leaves TOS on the + stack. Otherwise (TOS is false), TOS is popped. + + .. versionadded:: 3.1 + + +.. opcode:: JUMP_IF_FALSE_OR_POP (target) + + If TOS is false, sets the bytecode counter to *target* and leaves TOS on the + stack. Otherwise (TOS is true), TOS is popped. + + .. versionadded:: 3.1 + + +.. opcode:: JUMP_ABSOLUTE (target) + + Set bytecode counter to *target*. + + +.. opcode:: FOR_ITER (delta) + + TOS is an :term:`iterator`. Call its :meth:`~iterator.__next__` method. If + this yields a new value, push it on the stack (leaving the iterator below + it). If the iterator indicates it is exhausted TOS is popped, and the byte + code counter is incremented by *delta*. + + +.. opcode:: LOAD_GLOBAL (namei) + + Loads the global named ``co_names[namei]`` onto the stack. + + +.. opcode:: SETUP_LOOP (delta) + + Pushes a block for a loop onto the block stack. The block spans from the + current instruction with a size of *delta* bytes. + + +.. opcode:: SETUP_EXCEPT (delta) + + Pushes a try block from a try-except clause onto the block stack. *delta* + points to the first except block. + + +.. opcode:: SETUP_FINALLY (delta) + + Pushes a try block from a try-except clause onto the block stack. *delta* + points to the finally block. + + +.. opcode:: LOAD_FAST (var_num) + + Pushes a reference to the local ``co_varnames[var_num]`` onto the stack. + + +.. opcode:: STORE_FAST (var_num) + + Stores TOS into the local ``co_varnames[var_num]``. + + +.. opcode:: DELETE_FAST (var_num) + + Deletes local ``co_varnames[var_num]``. + + +.. opcode:: LOAD_CLOSURE (i) + + Pushes a reference to the cell contained in slot *i* of the cell and free + variable storage. The name of the variable is ``co_cellvars[i]`` if *i* is + less than the length of *co_cellvars*. Otherwise it is ``co_freevars[i - + len(co_cellvars)]``. + + +.. opcode:: LOAD_DEREF (i) + + Loads the cell contained in slot *i* of the cell and free variable storage. + Pushes a reference to the object the cell contains on the stack. + + +.. opcode:: LOAD_CLASSDEREF (i) + + Much like :opcode:`LOAD_DEREF` but first checks the locals dictionary before + consulting the cell. This is used for loading free variables in class + bodies. + + .. versionadded:: 3.4 + + +.. opcode:: STORE_DEREF (i) + + Stores TOS into the cell contained in slot *i* of the cell and free variable + storage. + + +.. opcode:: DELETE_DEREF (i) + + Empties the cell contained in slot *i* of the cell and free variable storage. + Used by the :keyword:`del` statement. + + .. versionadded:: 3.2 + + +.. opcode:: RAISE_VARARGS (argc) + + Raises an exception using one of the 3 forms of the ``raise`` statement, + depending on the value of *argc*: + + * 0: ``raise`` (re-raise previous exception) + * 1: ``raise TOS`` (raise exception instance or type at ``TOS``) + * 2: ``raise TOS1 from TOS`` (raise exception instance or type at ``TOS1`` + with ``__cause__`` set to ``TOS``) + + +.. opcode:: CALL_FUNCTION (argc) + + Calls a callable object with positional arguments. + *argc* indicates the number of positional arguments. + The top of the stack contains positional arguments, with the right-most + argument on top. Below the arguments is a callable object to call. + ``CALL_FUNCTION`` pops all arguments and the callable object off the stack, + calls the callable object with those arguments, and pushes the return value + returned by the callable object. + + .. versionchanged:: 3.6 + This opcode is used only for calls with positional arguments. + + +.. opcode:: CALL_FUNCTION_KW (argc) + + Calls a callable object with positional (if any) and keyword arguments. + *argc* indicates the total number of positional and keyword arguments. + The top element on the stack contains a tuple of keyword argument names. + Below that are keyword arguments in the order corresponding to the tuple. + Below that are positional arguments, with the right-most parameter on + top. Below the arguments is a callable object to call. + ``CALL_FUNCTION_KW`` pops all arguments and the callable object off the stack, + calls the callable object with those arguments, and pushes the return value + returned by the callable object. + + .. versionchanged:: 3.6 + Keyword arguments are packed in a tuple instead of a dictionary, + *argc* indicates the total number of arguments. + + +.. opcode:: CALL_FUNCTION_EX (flags) + + Calls a callable object with variable set of positional and keyword + arguments. If the lowest bit of *flags* is set, the top of the stack + contains a mapping object containing additional keyword arguments. + Below that is an iterable object containing positional arguments and + a callable object to call. :opcode:`BUILD_MAP_UNPACK_WITH_CALL` and + :opcode:`BUILD_TUPLE_UNPACK_WITH_CALL` can be used for merging multiple + mapping objects and iterables containing arguments. + Before the callable is called, the mapping object and iterable object + are each "unpacked" and their contents passed in as keyword and + positional arguments respectively. + ``CALL_FUNCTION_EX`` pops all arguments and the callable object off the stack, + calls the callable object with those arguments, and pushes the return value + returned by the callable object. + + .. versionadded:: 3.6 + + +.. opcode:: LOAD_METHOD (namei) + + Loads a method named ``co_names[namei]`` from TOS object. TOS is popped and + method and TOS are pushed when interpreter can call unbound method directly. + TOS will be used as the first argument (``self``) by :opcode:`CALL_METHOD`. + Otherwise, ``NULL`` and method is pushed (method is bound method or + something else). + + .. versionadded:: 3.7 + + +.. opcode:: CALL_METHOD (argc) + + Calls a method. *argc* is number of positional arguments. + Keyword arguments are not supported. This opcode is designed to be used + with :opcode:`LOAD_METHOD`. Positional arguments are on top of the stack. + Below them, two items described in :opcode:`LOAD_METHOD` on the stack. + All of them are popped and return value is pushed. + + .. versionadded:: 3.7 + + +.. opcode:: MAKE_FUNCTION (argc) + + Pushes a new function object on the stack. From bottom to top, the consumed + stack must consist of values if the argument carries a specified flag value + + * ``0x01`` a tuple of default values for positional-only and + positional-or-keyword parameters in positional order + * ``0x02`` a dictionary of keyword-only parameters' default values + * ``0x04`` an annotation dictionary + * ``0x08`` a tuple containing cells for free variables, making a closure + * the code associated with the function (at TOS1) + * the :term:`qualified name` of the function (at TOS) + + +.. opcode:: BUILD_SLICE (argc) + + .. index:: builtin: slice + + Pushes a slice object on the stack. *argc* must be 2 or 3. If it is 2, + ``slice(TOS1, TOS)`` is pushed; if it is 3, ``slice(TOS2, TOS1, TOS)`` is + pushed. See the :func:`slice` built-in function for more information. + + +.. opcode:: EXTENDED_ARG (ext) + + Prefixes any opcode which has an argument too big to fit into the default one + byte. *ext* holds an additional byte which act as higher bits in the argument. + For each opcode, at most three prefixal ``EXTENDED_ARG`` are allowed, forming + an argument from two-byte to four-byte. + + +.. opcode:: FORMAT_VALUE (flags) + + Used for implementing formatted literal strings (f-strings). Pops + an optional *fmt_spec* from the stack, then a required *value*. + *flags* is interpreted as follows: + + * ``(flags & 0x03) == 0x00``: *value* is formatted as-is. + * ``(flags & 0x03) == 0x01``: call :func:`str` on *value* before + formatting it. + * ``(flags & 0x03) == 0x02``: call :func:`repr` on *value* before + formatting it. + * ``(flags & 0x03) == 0x03``: call :func:`ascii` on *value* before + formatting it. + * ``(flags & 0x04) == 0x04``: pop *fmt_spec* from the stack and use + it, else use an empty *fmt_spec*. + + Formatting is performed using :c:func:`PyObject_Format`. The + result is pushed on the stack. + + .. versionadded:: 3.6 + + +.. opcode:: HAVE_ARGUMENT + + This is not really an opcode. It identifies the dividing line between + opcodes which don't use their argument and those that do + (``< HAVE_ARGUMENT`` and ``>= HAVE_ARGUMENT``, respectively). + + .. versionchanged:: 3.6 + Now every instruction has an argument, but opcodes ``< HAVE_ARGUMENT`` + ignore it. Before, only opcodes ``>= HAVE_ARGUMENT`` had an argument. + + +.. _opcode_collections: + +Opcode collections +------------------ + +These collections are provided for automatic introspection of bytecode +instructions: + +.. data:: opname + + Sequence of operation names, indexable using the bytecode. + + +.. data:: opmap + + Dictionary mapping operation names to bytecodes. + + +.. data:: cmp_op + + Sequence of all compare operation names. + + +.. data:: hasconst + + Sequence of bytecodes that access a constant. + + +.. data:: hasfree + + Sequence of bytecodes that access a free variable (note that 'free' in this + context refers to names in the current scope that are referenced by inner + scopes or names in outer scopes that are referenced from this scope. It does + *not* include references to global or builtin scopes). + + +.. data:: hasname + + Sequence of bytecodes that access an attribute by name. + + +.. data:: hasjrel + + Sequence of bytecodes that have a relative jump target. + + +.. data:: hasjabs + + Sequence of bytecodes that have an absolute jump target. + + +.. data:: haslocal + + Sequence of bytecodes that access a local variable. + + +.. data:: hascompare + + Sequence of bytecodes of Boolean operations. diff --git a/python-3.7.4-docs-html/_sources/library/distribution.rst.txt b/python-3.7.4-docs-html/_sources/library/distribution.rst.txt new file mode 100644 index 0000000..8d4befe --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/distribution.rst.txt @@ -0,0 +1,15 @@ +*********************************** +Software Packaging and Distribution +*********************************** + +These libraries help you with publishing and installing Python software. +While these modules are designed to work in conjunction with the +`Python Package Index `__, they can also be used +with a local index server, or without any index server at all. + +.. toctree:: + + distutils.rst + ensurepip.rst + venv.rst + zipapp.rst diff --git a/python-3.7.4-docs-html/_sources/library/distutils.rst.txt b/python-3.7.4-docs-html/_sources/library/distutils.rst.txt new file mode 100644 index 0000000..62abc85 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/distutils.rst.txt @@ -0,0 +1,44 @@ +:mod:`distutils` --- Building and installing Python modules +=========================================================== + +.. module:: distutils + :synopsis: Support for building and installing Python modules into an + existing Python installation. + +.. sectionauthor:: Fred L. Drake, Jr. + +-------------- + +The :mod:`distutils` package provides support for building and installing +additional modules into a Python installation. The new modules may be either +100%-pure Python, or may be extension modules written in C, or may be +collections of Python packages which include modules coded in both Python and C. + +Most Python users will *not* want to use this module directly, but instead +use the cross-version tools maintained by the Python Packaging Authority. In +particular, +`setuptools `__ is an +enhanced alternative to :mod:`distutils` that provides: + +* support for declaring project dependencies +* additional mechanisms for configuring which files to include in source + releases (including plugins for integration with version control systems) +* the ability to declare project "entry points", which can be used as the + basis for application plugin systems +* the ability to automatically generate Windows command line executables at + installation time rather than needing to prebuild them +* consistent behaviour across all supported Python versions + +The recommended `pip `__ installer runs all +``setup.py`` scripts with ``setuptools``, even if the script itself only +imports ``distutils``. Refer to the +`Python Packaging User Guide `_ for more +information. + +For the benefits of packaging tool authors and users seeking a deeper +understanding of the details of the current packaging and distribution +system, the legacy :mod:`distutils` based user documentation and API +reference remain available: + +* :ref:`install-index` +* :ref:`distutils-index` diff --git a/python-3.7.4-docs-html/_sources/library/doctest.rst.txt b/python-3.7.4-docs-html/_sources/library/doctest.rst.txt new file mode 100644 index 0000000..e7c0033 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/doctest.rst.txt @@ -0,0 +1,1868 @@ +:keepdoctest: + +:mod:`doctest` --- Test interactive Python examples +=================================================== + +.. module:: doctest + :synopsis: Test pieces of code within docstrings. + +.. moduleauthor:: Tim Peters +.. sectionauthor:: Tim Peters +.. sectionauthor:: Moshe Zadka +.. sectionauthor:: Edward Loper + +**Source code:** :source:`Lib/doctest.py` + +-------------- + +The :mod:`doctest` module searches for pieces of text that look like interactive +Python sessions, and then executes those sessions to verify that they work +exactly as shown. There are several common ways to use doctest: + +* To check that a module's docstrings are up-to-date by verifying that all + interactive examples still work as documented. + +* To perform regression testing by verifying that interactive examples from a + test file or a test object work as expected. + +* To write tutorial documentation for a package, liberally illustrated with + input-output examples. Depending on whether the examples or the expository text + are emphasized, this has the flavor of "literate testing" or "executable + documentation". + +Here's a complete but small example module:: + + """ + This is the "example" module. + + The example module supplies one function, factorial(). For example, + + >>> factorial(5) + 120 + """ + + def factorial(n): + """Return the factorial of n, an exact integer >= 0. + + >>> [factorial(n) for n in range(6)] + [1, 1, 2, 6, 24, 120] + >>> factorial(30) + 265252859812191058636308480000000 + >>> factorial(-1) + Traceback (most recent call last): + ... + ValueError: n must be >= 0 + + Factorials of floats are OK, but the float must be an exact integer: + >>> factorial(30.1) + Traceback (most recent call last): + ... + ValueError: n must be exact integer + >>> factorial(30.0) + 265252859812191058636308480000000 + + It must also not be ridiculously large: + >>> factorial(1e100) + Traceback (most recent call last): + ... + OverflowError: n too large + """ + + import math + if not n >= 0: + raise ValueError("n must be >= 0") + if math.floor(n) != n: + raise ValueError("n must be exact integer") + if n+1 == n: # catch a value like 1e300 + raise OverflowError("n too large") + result = 1 + factor = 2 + while factor <= n: + result *= factor + factor += 1 + return result + + + if __name__ == "__main__": + import doctest + doctest.testmod() + +If you run :file:`example.py` directly from the command line, :mod:`doctest` +works its magic: + +.. code-block:: shell-session + + $ python example.py + $ + +There's no output! That's normal, and it means all the examples worked. Pass +``-v`` to the script, and :mod:`doctest` prints a detailed log of what +it's trying, and prints a summary at the end: + +.. code-block:: shell-session + + $ python example.py -v + Trying: + factorial(5) + Expecting: + 120 + ok + Trying: + [factorial(n) for n in range(6)] + Expecting: + [1, 1, 2, 6, 24, 120] + ok + +And so on, eventually ending with: + +.. code-block:: none + + Trying: + factorial(1e100) + Expecting: + Traceback (most recent call last): + ... + OverflowError: n too large + ok + 2 items passed all tests: + 1 tests in __main__ + 8 tests in __main__.factorial + 9 tests in 2 items. + 9 passed and 0 failed. + Test passed. + $ + +That's all you need to know to start making productive use of :mod:`doctest`! +Jump in. The following sections provide full details. Note that there are many +examples of doctests in the standard Python test suite and libraries. +Especially useful examples can be found in the standard test file +:file:`Lib/test/test_doctest.py`. + + +.. _doctest-simple-testmod: + +Simple Usage: Checking Examples in Docstrings +--------------------------------------------- + +The simplest way to start using doctest (but not necessarily the way you'll +continue to do it) is to end each module :mod:`M` with:: + + if __name__ == "__main__": + import doctest + doctest.testmod() + +:mod:`doctest` then examines docstrings in module :mod:`M`. + +Running the module as a script causes the examples in the docstrings to get +executed and verified:: + + python M.py + +This won't display anything unless an example fails, in which case the failing +example(s) and the cause(s) of the failure(s) are printed to stdout, and the +final line of output is ``***Test Failed*** N failures.``, where *N* is the +number of examples that failed. + +Run it with the ``-v`` switch instead:: + + python M.py -v + +and a detailed report of all examples tried is printed to standard output, along +with assorted summaries at the end. + +You can force verbose mode by passing ``verbose=True`` to :func:`testmod`, or +prohibit it by passing ``verbose=False``. In either of those cases, +``sys.argv`` is not examined by :func:`testmod` (so passing ``-v`` or not +has no effect). + +There is also a command line shortcut for running :func:`testmod`. You can +instruct the Python interpreter to run the doctest module directly from the +standard library and pass the module name(s) on the command line:: + + python -m doctest -v example.py + +This will import :file:`example.py` as a standalone module and run +:func:`testmod` on it. Note that this may not work correctly if the file is +part of a package and imports other submodules from that package. + +For more information on :func:`testmod`, see section :ref:`doctest-basic-api`. + + +.. _doctest-simple-testfile: + +Simple Usage: Checking Examples in a Text File +---------------------------------------------- + +Another simple application of doctest is testing interactive examples in a text +file. This can be done with the :func:`testfile` function:: + + import doctest + doctest.testfile("example.txt") + +That short script executes and verifies any interactive Python examples +contained in the file :file:`example.txt`. The file content is treated as if it +were a single giant docstring; the file doesn't need to contain a Python +program! For example, perhaps :file:`example.txt` contains this: + +.. code-block:: none + + The ``example`` module + ====================== + + Using ``factorial`` + ------------------- + + This is an example text file in reStructuredText format. First import + ``factorial`` from the ``example`` module: + + >>> from example import factorial + + Now use it: + + >>> factorial(6) + 120 + +Running ``doctest.testfile("example.txt")`` then finds the error in this +documentation:: + + File "./example.txt", line 14, in example.txt + Failed example: + factorial(6) + Expected: + 120 + Got: + 720 + +As with :func:`testmod`, :func:`testfile` won't display anything unless an +example fails. If an example does fail, then the failing example(s) and the +cause(s) of the failure(s) are printed to stdout, using the same format as +:func:`testmod`. + +By default, :func:`testfile` looks for files in the calling module's directory. +See section :ref:`doctest-basic-api` for a description of the optional arguments +that can be used to tell it to look for files in other locations. + +Like :func:`testmod`, :func:`testfile`'s verbosity can be set with the +``-v`` command-line switch or with the optional keyword argument +*verbose*. + +There is also a command line shortcut for running :func:`testfile`. You can +instruct the Python interpreter to run the doctest module directly from the +standard library and pass the file name(s) on the command line:: + + python -m doctest -v example.txt + +Because the file name does not end with :file:`.py`, :mod:`doctest` infers that +it must be run with :func:`testfile`, not :func:`testmod`. + +For more information on :func:`testfile`, see section :ref:`doctest-basic-api`. + + +.. _doctest-how-it-works: + +How It Works +------------ + +This section examines in detail how doctest works: which docstrings it looks at, +how it finds interactive examples, what execution context it uses, how it +handles exceptions, and how option flags can be used to control its behavior. +This is the information that you need to know to write doctest examples; for +information about actually running doctest on these examples, see the following +sections. + + +.. _doctest-which-docstrings: + +Which Docstrings Are Examined? +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The module docstring, and all function, class and method docstrings are +searched. Objects imported into the module are not searched. + +In addition, if ``M.__test__`` exists and "is true", it must be a dict, and each +entry maps a (string) name to a function object, class object, or string. +Function and class object docstrings found from ``M.__test__`` are searched, and +strings are treated as if they were docstrings. In output, a key ``K`` in +``M.__test__`` appears with name :: + + .__test__.K + +Any classes found are recursively searched similarly, to test docstrings in +their contained methods and nested classes. + +.. impl-detail:: + Prior to version 3.4, extension modules written in C were not fully + searched by doctest. + + +.. _doctest-finding-examples: + +How are Docstring Examples Recognized? +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In most cases a copy-and-paste of an interactive console session works fine, +but doctest isn't trying to do an exact emulation of any specific Python shell. + +:: + + >>> # comments are ignored + >>> x = 12 + >>> x + 12 + >>> if x == 13: + ... print("yes") + ... else: + ... print("no") + ... print("NO") + ... print("NO!!!") + ... + no + NO + NO!!! + >>> + +.. index:: + single: >>>; interpreter prompt + single: ...; interpreter prompt + +Any expected output must immediately follow the final ``'>>> '`` or ``'... '`` +line containing the code, and the expected output (if any) extends to the next +``'>>> '`` or all-whitespace line. + +The fine print: + +* Expected output cannot contain an all-whitespace line, since such a line is + taken to signal the end of expected output. If expected output does contain a + blank line, put ```` in your doctest example each place a blank line + is expected. + +* All hard tab characters are expanded to spaces, using 8-column tab stops. + Tabs in output generated by the tested code are not modified. Because any + hard tabs in the sample output *are* expanded, this means that if the code + output includes hard tabs, the only way the doctest can pass is if the + :const:`NORMALIZE_WHITESPACE` option or :ref:`directive ` + is in effect. + Alternatively, the test can be rewritten to capture the output and compare it + to an expected value as part of the test. This handling of tabs in the + source was arrived at through trial and error, and has proven to be the least + error prone way of handling them. It is possible to use a different + algorithm for handling tabs by writing a custom :class:`DocTestParser` class. + +* Output to stdout is captured, but not output to stderr (exception tracebacks + are captured via a different means). + +* If you continue a line via backslashing in an interactive session, or for any + other reason use a backslash, you should use a raw docstring, which will + preserve your backslashes exactly as you type them:: + + >>> def f(x): + ... r'''Backslashes in a raw docstring: m\n''' + >>> print(f.__doc__) + Backslashes in a raw docstring: m\n + + Otherwise, the backslash will be interpreted as part of the string. For example, + the ``\n`` above would be interpreted as a newline character. Alternatively, you + can double each backslash in the doctest version (and not use a raw string):: + + >>> def f(x): + ... '''Backslashes in a raw docstring: m\\n''' + >>> print(f.__doc__) + Backslashes in a raw docstring: m\n + +* The starting column doesn't matter:: + + >>> assert "Easy!" + >>> import math + >>> math.floor(1.9) + 1 + + and as many leading whitespace characters are stripped from the expected output + as appeared in the initial ``'>>> '`` line that started the example. + + +.. _doctest-execution-context: + +What's the Execution Context? +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +By default, each time :mod:`doctest` finds a docstring to test, it uses a +*shallow copy* of :mod:`M`'s globals, so that running tests doesn't change the +module's real globals, and so that one test in :mod:`M` can't leave behind +crumbs that accidentally allow another test to work. This means examples can +freely use any names defined at top-level in :mod:`M`, and names defined earlier +in the docstring being run. Examples cannot see names defined in other +docstrings. + +You can force use of your own dict as the execution context by passing +``globs=your_dict`` to :func:`testmod` or :func:`testfile` instead. + + +.. _doctest-exceptions: + +What About Exceptions? +^^^^^^^^^^^^^^^^^^^^^^ + +No problem, provided that the traceback is the only output produced by the +example: just paste in the traceback. [#]_ Since tracebacks contain details +that are likely to change rapidly (for example, exact file paths and line +numbers), this is one case where doctest works hard to be flexible in what it +accepts. + +Simple example:: + + >>> [1, 2, 3].remove(42) + Traceback (most recent call last): + File "", line 1, in + ValueError: list.remove(x): x not in list + +That doctest succeeds if :exc:`ValueError` is raised, with the ``list.remove(x): +x not in list`` detail as shown. + +The expected output for an exception must start with a traceback header, which +may be either of the following two lines, indented the same as the first line of +the example:: + + Traceback (most recent call last): + Traceback (innermost last): + +The traceback header is followed by an optional traceback stack, whose contents +are ignored by doctest. The traceback stack is typically omitted, or copied +verbatim from an interactive session. + +The traceback stack is followed by the most interesting part: the line(s) +containing the exception type and detail. This is usually the last line of a +traceback, but can extend across multiple lines if the exception has a +multi-line detail:: + + >>> raise ValueError('multi\n line\ndetail') + Traceback (most recent call last): + File "", line 1, in + ValueError: multi + line + detail + +The last three lines (starting with :exc:`ValueError`) are compared against the +exception's type and detail, and the rest are ignored. + +Best practice is to omit the traceback stack, unless it adds significant +documentation value to the example. So the last example is probably better as:: + + >>> raise ValueError('multi\n line\ndetail') + Traceback (most recent call last): + ... + ValueError: multi + line + detail + +Note that tracebacks are treated very specially. In particular, in the +rewritten example, the use of ``...`` is independent of doctest's +:const:`ELLIPSIS` option. The ellipsis in that example could be left out, or +could just as well be three (or three hundred) commas or digits, or an indented +transcript of a Monty Python skit. + +Some details you should read once, but won't need to remember: + +* Doctest can't guess whether your expected output came from an exception + traceback or from ordinary printing. So, e.g., an example that expects + ``ValueError: 42 is prime`` will pass whether :exc:`ValueError` is actually + raised or if the example merely prints that traceback text. In practice, + ordinary output rarely begins with a traceback header line, so this doesn't + create real problems. + +* Each line of the traceback stack (if present) must be indented further than + the first line of the example, *or* start with a non-alphanumeric character. + The first line following the traceback header indented the same and starting + with an alphanumeric is taken to be the start of the exception detail. Of + course this does the right thing for genuine tracebacks. + +* When the :const:`IGNORE_EXCEPTION_DETAIL` doctest option is specified, + everything following the leftmost colon and any module information in the + exception name is ignored. + +* The interactive shell omits the traceback header line for some + :exc:`SyntaxError`\ s. But doctest uses the traceback header line to + distinguish exceptions from non-exceptions. So in the rare case where you need + to test a :exc:`SyntaxError` that omits the traceback header, you will need to + manually add the traceback header line to your test example. + +.. index:: single: ^ (caret); marker + +* For some :exc:`SyntaxError`\ s, Python displays the character position of the + syntax error, using a ``^`` marker:: + + >>> 1 1 + File "", line 1 + 1 1 + ^ + SyntaxError: invalid syntax + + Since the lines showing the position of the error come before the exception type + and detail, they are not checked by doctest. For example, the following test + would pass, even though it puts the ``^`` marker in the wrong location:: + + >>> 1 1 + Traceback (most recent call last): + File "", line 1 + 1 1 + ^ + SyntaxError: invalid syntax + + +.. _option-flags-and-directives: +.. _doctest-options: + +Option Flags +^^^^^^^^^^^^ + +A number of option flags control various aspects of doctest's behavior. +Symbolic names for the flags are supplied as module constants, which can be +:ref:`bitwise ORed ` together and passed to various functions. +The names can also be used in :ref:`doctest directives `, +and may be passed to the doctest command line interface via the ``-o`` option. + +.. versionadded:: 3.4 + The ``-o`` command line option. + +The first group of options define test semantics, controlling aspects of how +doctest decides whether actual output matches an example's expected output: + + +.. data:: DONT_ACCEPT_TRUE_FOR_1 + + By default, if an expected output block contains just ``1``, an actual output + block containing just ``1`` or just ``True`` is considered to be a match, and + similarly for ``0`` versus ``False``. When :const:`DONT_ACCEPT_TRUE_FOR_1` is + specified, neither substitution is allowed. The default behavior caters to that + Python changed the return type of many functions from integer to boolean; + doctests expecting "little integer" output still work in these cases. This + option will probably go away, but not for several years. + + +.. index:: single: +.. data:: DONT_ACCEPT_BLANKLINE + + By default, if an expected output block contains a line containing only the + string ````, then that line will match a blank line in the actual + output. Because a genuinely blank line delimits the expected output, this is + the only way to communicate that a blank line is expected. When + :const:`DONT_ACCEPT_BLANKLINE` is specified, this substitution is not allowed. + + +.. data:: NORMALIZE_WHITESPACE + + When specified, all sequences of whitespace (blanks and newlines) are treated as + equal. Any sequence of whitespace within the expected output will match any + sequence of whitespace within the actual output. By default, whitespace must + match exactly. :const:`NORMALIZE_WHITESPACE` is especially useful when a line of + expected output is very long, and you want to wrap it across multiple lines in + your source. + + +.. index:: single: ...; in doctests +.. data:: ELLIPSIS + + When specified, an ellipsis marker (``...``) in the expected output can match + any substring in the actual output. This includes substrings that span line + boundaries, and empty substrings, so it's best to keep usage of this simple. + Complicated uses can lead to the same kinds of "oops, it matched too much!" + surprises that ``.*`` is prone to in regular expressions. + + +.. data:: IGNORE_EXCEPTION_DETAIL + + When specified, an example that expects an exception passes if an exception of + the expected type is raised, even if the exception detail does not match. For + example, an example expecting ``ValueError: 42`` will pass if the actual + exception raised is ``ValueError: 3*14``, but will fail, e.g., if + :exc:`TypeError` is raised. + + It will also ignore the module name used in Python 3 doctest reports. Hence + both of these variations will work with the flag specified, regardless of + whether the test is run under Python 2.7 or Python 3.2 (or later versions):: + + >>> raise CustomError('message') + Traceback (most recent call last): + CustomError: message + + >>> raise CustomError('message') + Traceback (most recent call last): + my_module.CustomError: message + + Note that :const:`ELLIPSIS` can also be used to ignore the + details of the exception message, but such a test may still fail based + on whether or not the module details are printed as part of the + exception name. Using :const:`IGNORE_EXCEPTION_DETAIL` and the details + from Python 2.3 is also the only clear way to write a doctest that doesn't + care about the exception detail yet continues to pass under Python 2.3 or + earlier (those releases do not support :ref:`doctest directives + ` and ignore them as irrelevant comments). For example:: + + >>> (1, 2)[3] = 'moo' + Traceback (most recent call last): + File "", line 1, in + TypeError: object doesn't support item assignment + + passes under Python 2.3 and later Python versions with the flag specified, + even though the detail + changed in Python 2.4 to say "does not" instead of "doesn't". + + .. versionchanged:: 3.2 + :const:`IGNORE_EXCEPTION_DETAIL` now also ignores any information relating + to the module containing the exception under test. + + +.. data:: SKIP + + When specified, do not run the example at all. This can be useful in contexts + where doctest examples serve as both documentation and test cases, and an + example should be included for documentation purposes, but should not be + checked. E.g., the example's output might be random; or the example might + depend on resources which would be unavailable to the test driver. + + The SKIP flag can also be used for temporarily "commenting out" examples. + + +.. data:: COMPARISON_FLAGS + + A bitmask or'ing together all the comparison flags above. + +The second group of options controls how test failures are reported: + + +.. data:: REPORT_UDIFF + + When specified, failures that involve multi-line expected and actual outputs are + displayed using a unified diff. + + +.. data:: REPORT_CDIFF + + When specified, failures that involve multi-line expected and actual outputs + will be displayed using a context diff. + + +.. data:: REPORT_NDIFF + + When specified, differences are computed by ``difflib.Differ``, using the same + algorithm as the popular :file:`ndiff.py` utility. This is the only method that + marks differences within lines as well as across lines. For example, if a line + of expected output contains digit ``1`` where actual output contains letter + ``l``, a line is inserted with a caret marking the mismatching column positions. + + +.. data:: REPORT_ONLY_FIRST_FAILURE + + When specified, display the first failing example in each doctest, but suppress + output for all remaining examples. This will prevent doctest from reporting + correct examples that break because of earlier failures; but it might also hide + incorrect examples that fail independently of the first failure. When + :const:`REPORT_ONLY_FIRST_FAILURE` is specified, the remaining examples are + still run, and still count towards the total number of failures reported; only + the output is suppressed. + + +.. data:: FAIL_FAST + + When specified, exit after the first failing example and don't attempt to run + the remaining examples. Thus, the number of failures reported will be at most + 1. This flag may be useful during debugging, since examples after the first + failure won't even produce debugging output. + + The doctest command line accepts the option ``-f`` as a shorthand for ``-o + FAIL_FAST``. + + .. versionadded:: 3.4 + + +.. data:: REPORTING_FLAGS + + A bitmask or'ing together all the reporting flags above. + + +There is also a way to register new option flag names, though this isn't +useful unless you intend to extend :mod:`doctest` internals via subclassing: + + +.. function:: register_optionflag(name) + + Create a new option flag with a given name, and return the new flag's integer + value. :func:`register_optionflag` can be used when subclassing + :class:`OutputChecker` or :class:`DocTestRunner` to create new options that are + supported by your subclasses. :func:`register_optionflag` should always be + called using the following idiom:: + + MY_FLAG = register_optionflag('MY_FLAG') + + +.. index:: + single: # (hash); in doctests + single: + (plus); in doctests + single: - (minus); in doctests +.. _doctest-directives: + +Directives +^^^^^^^^^^ + +Doctest directives may be used to modify the :ref:`option flags +` for an individual example. Doctest directives are +special Python comments following an example's source code: + +.. productionlist:: doctest + directive: "#" "doctest:" `directive_options` + directive_options: `directive_option` ("," `directive_option`)\* + directive_option: `on_or_off` `directive_option_name` + on_or_off: "+" \| "-" + directive_option_name: "DONT_ACCEPT_BLANKLINE" \| "NORMALIZE_WHITESPACE" \| ... + +Whitespace is not allowed between the ``+`` or ``-`` and the directive option +name. The directive option name can be any of the option flag names explained +above. + +An example's doctest directives modify doctest's behavior for that single +example. Use ``+`` to enable the named behavior, or ``-`` to disable it. + +For example, this test passes:: + + >>> print(list(range(20))) # doctest: +NORMALIZE_WHITESPACE + [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, + 10, 11, 12, 13, 14, 15, 16, 17, 18, 19] + +Without the directive it would fail, both because the actual output doesn't have +two blanks before the single-digit list elements, and because the actual output +is on a single line. This test also passes, and also requires a directive to do +so:: + + >>> print(list(range(20))) # doctest: +ELLIPSIS + [0, 1, ..., 18, 19] + +Multiple directives can be used on a single physical line, separated by +commas:: + + >>> print(list(range(20))) # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE + [0, 1, ..., 18, 19] + +If multiple directive comments are used for a single example, then they are +combined:: + + >>> print(list(range(20))) # doctest: +ELLIPSIS + ... # doctest: +NORMALIZE_WHITESPACE + [0, 1, ..., 18, 19] + +As the previous example shows, you can add ``...`` lines to your example +containing only directives. This can be useful when an example is too long for +a directive to comfortably fit on the same line:: + + >>> print(list(range(5)) + list(range(10, 20)) + list(range(30, 40))) + ... # doctest: +ELLIPSIS + [0, ..., 4, 10, ..., 19, 30, ..., 39] + +Note that since all options are disabled by default, and directives apply only +to the example they appear in, enabling options (via ``+`` in a directive) is +usually the only meaningful choice. However, option flags can also be passed to +functions that run doctests, establishing different defaults. In such cases, +disabling an option via ``-`` in a directive can be useful. + + +.. _doctest-warnings: + +Warnings +^^^^^^^^ + +:mod:`doctest` is serious about requiring exact matches in expected output. If +even a single character doesn't match, the test fails. This will probably +surprise you a few times, as you learn exactly what Python does and doesn't +guarantee about output. For example, when printing a set, Python doesn't +guarantee that the element is printed in any particular order, so a test like :: + + >>> foo() + {"Hermione", "Harry"} + +is vulnerable! One workaround is to do :: + + >>> foo() == {"Hermione", "Harry"} + True + +instead. Another is to do :: + + >>> d = sorted(foo()) + >>> d + ['Harry', 'Hermione'] + +.. note:: + + Before Python 3.6, when printing a dict, Python did not guarantee that + the key-value pairs was printed in any particular order. + +There are others, but you get the idea. + +Another bad idea is to print things that embed an object address, like :: + + >>> id(1.0) # certain to fail some of the time + 7948648 + >>> class C: pass + >>> C() # the default repr() for instances embeds an address + <__main__.C instance at 0x00AC18F0> + +The :const:`ELLIPSIS` directive gives a nice approach for the last example:: + + >>> C() #doctest: +ELLIPSIS + <__main__.C instance at 0x...> + +Floating-point numbers are also subject to small output variations across +platforms, because Python defers to the platform C library for float formatting, +and C libraries vary widely in quality here. :: + + >>> 1./7 # risky + 0.14285714285714285 + >>> print(1./7) # safer + 0.142857142857 + >>> print(round(1./7, 6)) # much safer + 0.142857 + +Numbers of the form ``I/2.**J`` are safe across all platforms, and I often +contrive doctest examples to produce numbers of that form:: + + >>> 3./4 # utterly safe + 0.75 + +Simple fractions are also easier for people to understand, and that makes for +better documentation. + + +.. _doctest-basic-api: + +Basic API +--------- + +The functions :func:`testmod` and :func:`testfile` provide a simple interface to +doctest that should be sufficient for most basic uses. For a less formal +introduction to these two functions, see sections :ref:`doctest-simple-testmod` +and :ref:`doctest-simple-testfile`. + + +.. function:: testfile(filename, module_relative=True, name=None, package=None, globs=None, verbose=None, report=True, optionflags=0, extraglobs=None, raise_on_error=False, parser=DocTestParser(), encoding=None) + + All arguments except *filename* are optional, and should be specified in keyword + form. + + Test examples in the file named *filename*. Return ``(failure_count, + test_count)``. + + Optional argument *module_relative* specifies how the filename should be + interpreted: + + * If *module_relative* is ``True`` (the default), then *filename* specifies an + OS-independent module-relative path. By default, this path is relative to the + calling module's directory; but if the *package* argument is specified, then it + is relative to that package. To ensure OS-independence, *filename* should use + ``/`` characters to separate path segments, and may not be an absolute path + (i.e., it may not begin with ``/``). + + * If *module_relative* is ``False``, then *filename* specifies an OS-specific + path. The path may be absolute or relative; relative paths are resolved with + respect to the current working directory. + + Optional argument *name* gives the name of the test; by default, or if ``None``, + ``os.path.basename(filename)`` is used. + + Optional argument *package* is a Python package or the name of a Python package + whose directory should be used as the base directory for a module-relative + filename. If no package is specified, then the calling module's directory is + used as the base directory for module-relative filenames. It is an error to + specify *package* if *module_relative* is ``False``. + + Optional argument *globs* gives a dict to be used as the globals when executing + examples. A new shallow copy of this dict is created for the doctest, so its + examples start with a clean slate. By default, or if ``None``, a new empty dict + is used. + + Optional argument *extraglobs* gives a dict merged into the globals used to + execute examples. This works like :meth:`dict.update`: if *globs* and + *extraglobs* have a common key, the associated value in *extraglobs* appears in + the combined dict. By default, or if ``None``, no extra globals are used. This + is an advanced feature that allows parameterization of doctests. For example, a + doctest can be written for a base class, using a generic name for the class, + then reused to test any number of subclasses by passing an *extraglobs* dict + mapping the generic name to the subclass to be tested. + + Optional argument *verbose* prints lots of stuff if true, and prints only + failures if false; by default, or if ``None``, it's true if and only if ``'-v'`` + is in ``sys.argv``. + + Optional argument *report* prints a summary at the end when true, else prints + nothing at the end. In verbose mode, the summary is detailed, else the summary + is very brief (in fact, empty if all tests passed). + + Optional argument *optionflags* (default value 0) takes the + :ref:`bitwise OR ` of option flags. + See section :ref:`doctest-options`. + + Optional argument *raise_on_error* defaults to false. If true, an exception is + raised upon the first failure or unexpected exception in an example. This + allows failures to be post-mortem debugged. Default behavior is to continue + running examples. + + Optional argument *parser* specifies a :class:`DocTestParser` (or subclass) that + should be used to extract tests from the files. It defaults to a normal parser + (i.e., ``DocTestParser()``). + + Optional argument *encoding* specifies an encoding that should be used to + convert the file to unicode. + + +.. function:: testmod(m=None, name=None, globs=None, verbose=None, report=True, optionflags=0, extraglobs=None, raise_on_error=False, exclude_empty=False) + + All arguments are optional, and all except for *m* should be specified in + keyword form. + + Test examples in docstrings in functions and classes reachable from module *m* + (or module :mod:`__main__` if *m* is not supplied or is ``None``), starting with + ``m.__doc__``. + + Also test examples reachable from dict ``m.__test__``, if it exists and is not + ``None``. ``m.__test__`` maps names (strings) to functions, classes and + strings; function and class docstrings are searched for examples; strings are + searched directly, as if they were docstrings. + + Only docstrings attached to objects belonging to module *m* are searched. + + Return ``(failure_count, test_count)``. + + Optional argument *name* gives the name of the module; by default, or if + ``None``, ``m.__name__`` is used. + + Optional argument *exclude_empty* defaults to false. If true, objects for which + no doctests are found are excluded from consideration. The default is a backward + compatibility hack, so that code still using :meth:`doctest.master.summarize` in + conjunction with :func:`testmod` continues to get output for objects with no + tests. The *exclude_empty* argument to the newer :class:`DocTestFinder` + constructor defaults to true. + + Optional arguments *extraglobs*, *verbose*, *report*, *optionflags*, + *raise_on_error*, and *globs* are the same as for function :func:`testfile` + above, except that *globs* defaults to ``m.__dict__``. + + +.. function:: run_docstring_examples(f, globs, verbose=False, name="NoName", compileflags=None, optionflags=0) + + Test examples associated with object *f*; for example, *f* may be a string, + a module, a function, or a class object. + + A shallow copy of dictionary argument *globs* is used for the execution context. + + Optional argument *name* is used in failure messages, and defaults to + ``"NoName"``. + + If optional argument *verbose* is true, output is generated even if there are no + failures. By default, output is generated only in case of an example failure. + + Optional argument *compileflags* gives the set of flags that should be used by + the Python compiler when running the examples. By default, or if ``None``, + flags are deduced corresponding to the set of future features found in *globs*. + + Optional argument *optionflags* works as for function :func:`testfile` above. + + +.. _doctest-unittest-api: + +Unittest API +------------ + +As your collection of doctest'ed modules grows, you'll want a way to run all +their doctests systematically. :mod:`doctest` provides two functions that can +be used to create :mod:`unittest` test suites from modules and text files +containing doctests. To integrate with :mod:`unittest` test discovery, include +a :func:`load_tests` function in your test module:: + + import unittest + import doctest + import my_module_with_doctests + + def load_tests(loader, tests, ignore): + tests.addTests(doctest.DocTestSuite(my_module_with_doctests)) + return tests + +There are two main functions for creating :class:`unittest.TestSuite` instances +from text files and modules with doctests: + + +.. function:: DocFileSuite(*paths, module_relative=True, package=None, setUp=None, tearDown=None, globs=None, optionflags=0, parser=DocTestParser(), encoding=None) + + Convert doctest tests from one or more text files to a + :class:`unittest.TestSuite`. + + The returned :class:`unittest.TestSuite` is to be run by the unittest framework + and runs the interactive examples in each file. If an example in any file + fails, then the synthesized unit test fails, and a :exc:`failureException` + exception is raised showing the name of the file containing the test and a + (sometimes approximate) line number. + + Pass one or more paths (as strings) to text files to be examined. + + Options may be provided as keyword arguments: + + Optional argument *module_relative* specifies how the filenames in *paths* + should be interpreted: + + * If *module_relative* is ``True`` (the default), then each filename in + *paths* specifies an OS-independent module-relative path. By default, this + path is relative to the calling module's directory; but if the *package* + argument is specified, then it is relative to that package. To ensure + OS-independence, each filename should use ``/`` characters to separate path + segments, and may not be an absolute path (i.e., it may not begin with + ``/``). + + * If *module_relative* is ``False``, then each filename in *paths* specifies + an OS-specific path. The path may be absolute or relative; relative paths + are resolved with respect to the current working directory. + + Optional argument *package* is a Python package or the name of a Python + package whose directory should be used as the base directory for + module-relative filenames in *paths*. If no package is specified, then the + calling module's directory is used as the base directory for module-relative + filenames. It is an error to specify *package* if *module_relative* is + ``False``. + + Optional argument *setUp* specifies a set-up function for the test suite. + This is called before running the tests in each file. The *setUp* function + will be passed a :class:`DocTest` object. The setUp function can access the + test globals as the *globs* attribute of the test passed. + + Optional argument *tearDown* specifies a tear-down function for the test + suite. This is called after running the tests in each file. The *tearDown* + function will be passed a :class:`DocTest` object. The setUp function can + access the test globals as the *globs* attribute of the test passed. + + Optional argument *globs* is a dictionary containing the initial global + variables for the tests. A new copy of this dictionary is created for each + test. By default, *globs* is a new empty dictionary. + + Optional argument *optionflags* specifies the default doctest options for the + tests, created by or-ing together individual option flags. See section + :ref:`doctest-options`. See function :func:`set_unittest_reportflags` below + for a better way to set reporting options. + + Optional argument *parser* specifies a :class:`DocTestParser` (or subclass) + that should be used to extract tests from the files. It defaults to a normal + parser (i.e., ``DocTestParser()``). + + Optional argument *encoding* specifies an encoding that should be used to + convert the file to unicode. + + The global ``__file__`` is added to the globals provided to doctests loaded + from a text file using :func:`DocFileSuite`. + + +.. function:: DocTestSuite(module=None, globs=None, extraglobs=None, test_finder=None, setUp=None, tearDown=None, checker=None) + + Convert doctest tests for a module to a :class:`unittest.TestSuite`. + + The returned :class:`unittest.TestSuite` is to be run by the unittest framework + and runs each doctest in the module. If any of the doctests fail, then the + synthesized unit test fails, and a :exc:`failureException` exception is raised + showing the name of the file containing the test and a (sometimes approximate) + line number. + + Optional argument *module* provides the module to be tested. It can be a module + object or a (possibly dotted) module name. If not specified, the module calling + this function is used. + + Optional argument *globs* is a dictionary containing the initial global + variables for the tests. A new copy of this dictionary is created for each + test. By default, *globs* is a new empty dictionary. + + Optional argument *extraglobs* specifies an extra set of global variables, which + is merged into *globs*. By default, no extra globals are used. + + Optional argument *test_finder* is the :class:`DocTestFinder` object (or a + drop-in replacement) that is used to extract doctests from the module. + + Optional arguments *setUp*, *tearDown*, and *optionflags* are the same as for + function :func:`DocFileSuite` above. + + This function uses the same search technique as :func:`testmod`. + + .. versionchanged:: 3.5 + :func:`DocTestSuite` returns an empty :class:`unittest.TestSuite` if *module* + contains no docstrings instead of raising :exc:`ValueError`. + + +Under the covers, :func:`DocTestSuite` creates a :class:`unittest.TestSuite` out +of :class:`doctest.DocTestCase` instances, and :class:`DocTestCase` is a +subclass of :class:`unittest.TestCase`. :class:`DocTestCase` isn't documented +here (it's an internal detail), but studying its code can answer questions about +the exact details of :mod:`unittest` integration. + +Similarly, :func:`DocFileSuite` creates a :class:`unittest.TestSuite` out of +:class:`doctest.DocFileCase` instances, and :class:`DocFileCase` is a subclass +of :class:`DocTestCase`. + +So both ways of creating a :class:`unittest.TestSuite` run instances of +:class:`DocTestCase`. This is important for a subtle reason: when you run +:mod:`doctest` functions yourself, you can control the :mod:`doctest` options in +use directly, by passing option flags to :mod:`doctest` functions. However, if +you're writing a :mod:`unittest` framework, :mod:`unittest` ultimately controls +when and how tests get run. The framework author typically wants to control +:mod:`doctest` reporting options (perhaps, e.g., specified by command line +options), but there's no way to pass options through :mod:`unittest` to +:mod:`doctest` test runners. + +For this reason, :mod:`doctest` also supports a notion of :mod:`doctest` +reporting flags specific to :mod:`unittest` support, via this function: + + +.. function:: set_unittest_reportflags(flags) + + Set the :mod:`doctest` reporting flags to use. + + Argument *flags* takes the :ref:`bitwise OR ` of option flags. See + section :ref:`doctest-options`. Only "reporting flags" can be used. + + This is a module-global setting, and affects all future doctests run by module + :mod:`unittest`: the :meth:`runTest` method of :class:`DocTestCase` looks at + the option flags specified for the test case when the :class:`DocTestCase` + instance was constructed. If no reporting flags were specified (which is the + typical and expected case), :mod:`doctest`'s :mod:`unittest` reporting flags are + :ref:`bitwise ORed ` into the option flags, and the option flags + so augmented are passed to the :class:`DocTestRunner` instance created to + run the doctest. If any reporting flags were specified when the + :class:`DocTestCase` instance was constructed, :mod:`doctest`'s + :mod:`unittest` reporting flags are ignored. + + The value of the :mod:`unittest` reporting flags in effect before the function + was called is returned by the function. + + +.. _doctest-advanced-api: + +Advanced API +------------ + +The basic API is a simple wrapper that's intended to make doctest easy to use. +It is fairly flexible, and should meet most users' needs; however, if you +require more fine-grained control over testing, or wish to extend doctest's +capabilities, then you should use the advanced API. + +The advanced API revolves around two container classes, which are used to store +the interactive examples extracted from doctest cases: + +* :class:`Example`: A single Python :term:`statement`, paired with its expected + output. + +* :class:`DocTest`: A collection of :class:`Example`\ s, typically extracted + from a single docstring or text file. + +Additional processing classes are defined to find, parse, and run, and check +doctest examples: + +* :class:`DocTestFinder`: Finds all docstrings in a given module, and uses a + :class:`DocTestParser` to create a :class:`DocTest` from every docstring that + contains interactive examples. + +* :class:`DocTestParser`: Creates a :class:`DocTest` object from a string (such + as an object's docstring). + +* :class:`DocTestRunner`: Executes the examples in a :class:`DocTest`, and uses + an :class:`OutputChecker` to verify their output. + +* :class:`OutputChecker`: Compares the actual output from a doctest example with + the expected output, and decides whether they match. + +The relationships among these processing classes are summarized in the following +diagram:: + + list of: + +------+ +---------+ + |module| --DocTestFinder-> | DocTest | --DocTestRunner-> results + +------+ | ^ +---------+ | ^ (printed) + | | | Example | | | + v | | ... | v | + DocTestParser | Example | OutputChecker + +---------+ + + +.. _doctest-doctest: + +DocTest Objects +^^^^^^^^^^^^^^^ + + +.. class:: DocTest(examples, globs, name, filename, lineno, docstring) + + A collection of doctest examples that should be run in a single namespace. The + constructor arguments are used to initialize the attributes of the same names. + + + :class:`DocTest` defines the following attributes. They are initialized by + the constructor, and should not be modified directly. + + + .. attribute:: examples + + A list of :class:`Example` objects encoding the individual interactive Python + examples that should be run by this test. + + + .. attribute:: globs + + The namespace (aka globals) that the examples should be run in. This is a + dictionary mapping names to values. Any changes to the namespace made by the + examples (such as binding new variables) will be reflected in :attr:`globs` + after the test is run. + + + .. attribute:: name + + A string name identifying the :class:`DocTest`. Typically, this is the name + of the object or file that the test was extracted from. + + + .. attribute:: filename + + The name of the file that this :class:`DocTest` was extracted from; or + ``None`` if the filename is unknown, or if the :class:`DocTest` was not + extracted from a file. + + + .. attribute:: lineno + + The line number within :attr:`filename` where this :class:`DocTest` begins, or + ``None`` if the line number is unavailable. This line number is zero-based + with respect to the beginning of the file. + + + .. attribute:: docstring + + The string that the test was extracted from, or ``None`` if the string is + unavailable, or if the test was not extracted from a string. + + +.. _doctest-example: + +Example Objects +^^^^^^^^^^^^^^^ + + +.. class:: Example(source, want, exc_msg=None, lineno=0, indent=0, options=None) + + A single interactive example, consisting of a Python statement and its expected + output. The constructor arguments are used to initialize the attributes of + the same names. + + + :class:`Example` defines the following attributes. They are initialized by + the constructor, and should not be modified directly. + + + .. attribute:: source + + A string containing the example's source code. This source code consists of a + single Python statement, and always ends with a newline; the constructor adds + a newline when necessary. + + + .. attribute:: want + + The expected output from running the example's source code (either from + stdout, or a traceback in case of exception). :attr:`want` ends with a + newline unless no output is expected, in which case it's an empty string. The + constructor adds a newline when necessary. + + + .. attribute:: exc_msg + + The exception message generated by the example, if the example is expected to + generate an exception; or ``None`` if it is not expected to generate an + exception. This exception message is compared against the return value of + :func:`traceback.format_exception_only`. :attr:`exc_msg` ends with a newline + unless it's ``None``. The constructor adds a newline if needed. + + + .. attribute:: lineno + + The line number within the string containing this example where the example + begins. This line number is zero-based with respect to the beginning of the + containing string. + + + .. attribute:: indent + + The example's indentation in the containing string, i.e., the number of space + characters that precede the example's first prompt. + + + .. attribute:: options + + A dictionary mapping from option flags to ``True`` or ``False``, which is used + to override default options for this example. Any option flags not contained + in this dictionary are left at their default value (as specified by the + :class:`DocTestRunner`'s :attr:`optionflags`). By default, no options are set. + + +.. _doctest-doctestfinder: + +DocTestFinder objects +^^^^^^^^^^^^^^^^^^^^^ + + +.. class:: DocTestFinder(verbose=False, parser=DocTestParser(), recurse=True, exclude_empty=True) + + A processing class used to extract the :class:`DocTest`\ s that are relevant to + a given object, from its docstring and the docstrings of its contained objects. + :class:`DocTest`\ s can be extracted from modules, classes, functions, + methods, staticmethods, classmethods, and properties. + + The optional argument *verbose* can be used to display the objects searched by + the finder. It defaults to ``False`` (no output). + + The optional argument *parser* specifies the :class:`DocTestParser` object (or a + drop-in replacement) that is used to extract doctests from docstrings. + + If the optional argument *recurse* is false, then :meth:`DocTestFinder.find` + will only examine the given object, and not any contained objects. + + If the optional argument *exclude_empty* is false, then + :meth:`DocTestFinder.find` will include tests for objects with empty docstrings. + + + :class:`DocTestFinder` defines the following method: + + + .. method:: find(obj[, name][, module][, globs][, extraglobs]) + + Return a list of the :class:`DocTest`\ s that are defined by *obj*'s + docstring, or by any of its contained objects' docstrings. + + The optional argument *name* specifies the object's name; this name will be + used to construct names for the returned :class:`DocTest`\ s. If *name* is + not specified, then ``obj.__name__`` is used. + + The optional parameter *module* is the module that contains the given object. + If the module is not specified or is ``None``, then the test finder will attempt + to automatically determine the correct module. The object's module is used: + + * As a default namespace, if *globs* is not specified. + + * To prevent the DocTestFinder from extracting DocTests from objects that are + imported from other modules. (Contained objects with modules other than + *module* are ignored.) + + * To find the name of the file containing the object. + + * To help find the line number of the object within its file. + + If *module* is ``False``, no attempt to find the module will be made. This is + obscure, of use mostly in testing doctest itself: if *module* is ``False``, or + is ``None`` but cannot be found automatically, then all objects are considered + to belong to the (non-existent) module, so all contained objects will + (recursively) be searched for doctests. + + The globals for each :class:`DocTest` is formed by combining *globs* and + *extraglobs* (bindings in *extraglobs* override bindings in *globs*). A new + shallow copy of the globals dictionary is created for each :class:`DocTest`. + If *globs* is not specified, then it defaults to the module's *__dict__*, if + specified, or ``{}`` otherwise. If *extraglobs* is not specified, then it + defaults to ``{}``. + + +.. _doctest-doctestparser: + +DocTestParser objects +^^^^^^^^^^^^^^^^^^^^^ + + +.. class:: DocTestParser() + + A processing class used to extract interactive examples from a string, and use + them to create a :class:`DocTest` object. + + + :class:`DocTestParser` defines the following methods: + + + .. method:: get_doctest(string, globs, name, filename, lineno) + + Extract all doctest examples from the given string, and collect them into a + :class:`DocTest` object. + + *globs*, *name*, *filename*, and *lineno* are attributes for the new + :class:`DocTest` object. See the documentation for :class:`DocTest` for more + information. + + + .. method:: get_examples(string, name='') + + Extract all doctest examples from the given string, and return them as a list + of :class:`Example` objects. Line numbers are 0-based. The optional argument + *name* is a name identifying this string, and is only used for error messages. + + + .. method:: parse(string, name='') + + Divide the given string into examples and intervening text, and return them as + a list of alternating :class:`Example`\ s and strings. Line numbers for the + :class:`Example`\ s are 0-based. The optional argument *name* is a name + identifying this string, and is only used for error messages. + + +.. _doctest-doctestrunner: + +DocTestRunner objects +^^^^^^^^^^^^^^^^^^^^^ + + +.. class:: DocTestRunner(checker=None, verbose=None, optionflags=0) + + A processing class used to execute and verify the interactive examples in a + :class:`DocTest`. + + The comparison between expected outputs and actual outputs is done by an + :class:`OutputChecker`. This comparison may be customized with a number of + option flags; see section :ref:`doctest-options` for more information. If the + option flags are insufficient, then the comparison may also be customized by + passing a subclass of :class:`OutputChecker` to the constructor. + + The test runner's display output can be controlled in two ways. First, an output + function can be passed to :meth:`TestRunner.run`; this function will be called + with strings that should be displayed. It defaults to ``sys.stdout.write``. If + capturing the output is not sufficient, then the display output can be also + customized by subclassing DocTestRunner, and overriding the methods + :meth:`report_start`, :meth:`report_success`, + :meth:`report_unexpected_exception`, and :meth:`report_failure`. + + The optional keyword argument *checker* specifies the :class:`OutputChecker` + object (or drop-in replacement) that should be used to compare the expected + outputs to the actual outputs of doctest examples. + + The optional keyword argument *verbose* controls the :class:`DocTestRunner`'s + verbosity. If *verbose* is ``True``, then information is printed about each + example, as it is run. If *verbose* is ``False``, then only failures are + printed. If *verbose* is unspecified, or ``None``, then verbose output is used + iff the command-line switch ``-v`` is used. + + The optional keyword argument *optionflags* can be used to control how the test + runner compares expected output to actual output, and how it displays failures. + For more information, see section :ref:`doctest-options`. + + + :class:`DocTestParser` defines the following methods: + + + .. method:: report_start(out, test, example) + + Report that the test runner is about to process the given example. This method + is provided to allow subclasses of :class:`DocTestRunner` to customize their + output; it should not be called directly. + + *example* is the example about to be processed. *test* is the test + *containing example*. *out* is the output function that was passed to + :meth:`DocTestRunner.run`. + + + .. method:: report_success(out, test, example, got) + + Report that the given example ran successfully. This method is provided to + allow subclasses of :class:`DocTestRunner` to customize their output; it + should not be called directly. + + *example* is the example about to be processed. *got* is the actual output + from the example. *test* is the test containing *example*. *out* is the + output function that was passed to :meth:`DocTestRunner.run`. + + + .. method:: report_failure(out, test, example, got) + + Report that the given example failed. This method is provided to allow + subclasses of :class:`DocTestRunner` to customize their output; it should not + be called directly. + + *example* is the example about to be processed. *got* is the actual output + from the example. *test* is the test containing *example*. *out* is the + output function that was passed to :meth:`DocTestRunner.run`. + + + .. method:: report_unexpected_exception(out, test, example, exc_info) + + Report that the given example raised an unexpected exception. This method is + provided to allow subclasses of :class:`DocTestRunner` to customize their + output; it should not be called directly. + + *example* is the example about to be processed. *exc_info* is a tuple + containing information about the unexpected exception (as returned by + :func:`sys.exc_info`). *test* is the test containing *example*. *out* is the + output function that was passed to :meth:`DocTestRunner.run`. + + + .. method:: run(test, compileflags=None, out=None, clear_globs=True) + + Run the examples in *test* (a :class:`DocTest` object), and display the + results using the writer function *out*. + + The examples are run in the namespace ``test.globs``. If *clear_globs* is + true (the default), then this namespace will be cleared after the test runs, + to help with garbage collection. If you would like to examine the namespace + after the test completes, then use *clear_globs=False*. + + *compileflags* gives the set of flags that should be used by the Python + compiler when running the examples. If not specified, then it will default to + the set of future-import flags that apply to *globs*. + + The output of each example is checked using the :class:`DocTestRunner`'s + output checker, and the results are formatted by the + :meth:`DocTestRunner.report_\*` methods. + + + .. method:: summarize(verbose=None) + + Print a summary of all the test cases that have been run by this DocTestRunner, + and return a :term:`named tuple` ``TestResults(failed, attempted)``. + + The optional *verbose* argument controls how detailed the summary is. If the + verbosity is not specified, then the :class:`DocTestRunner`'s verbosity is + used. + +.. _doctest-outputchecker: + +OutputChecker objects +^^^^^^^^^^^^^^^^^^^^^ + + +.. class:: OutputChecker() + + A class used to check the whether the actual output from a doctest example + matches the expected output. :class:`OutputChecker` defines two methods: + :meth:`check_output`, which compares a given pair of outputs, and returns true + if they match; and :meth:`output_difference`, which returns a string describing + the differences between two outputs. + + + :class:`OutputChecker` defines the following methods: + + .. method:: check_output(want, got, optionflags) + + Return ``True`` iff the actual output from an example (*got*) matches the + expected output (*want*). These strings are always considered to match if + they are identical; but depending on what option flags the test runner is + using, several non-exact match types are also possible. See section + :ref:`doctest-options` for more information about option flags. + + + .. method:: output_difference(example, got, optionflags) + + Return a string describing the differences between the expected output for a + given example (*example*) and the actual output (*got*). *optionflags* is the + set of option flags used to compare *want* and *got*. + + +.. _doctest-debugging: + +Debugging +--------- + +Doctest provides several mechanisms for debugging doctest examples: + +* Several functions convert doctests to executable Python programs, which can be + run under the Python debugger, :mod:`pdb`. + +* The :class:`DebugRunner` class is a subclass of :class:`DocTestRunner` that + raises an exception for the first failing example, containing information about + that example. This information can be used to perform post-mortem debugging on + the example. + +* The :mod:`unittest` cases generated by :func:`DocTestSuite` support the + :meth:`debug` method defined by :class:`unittest.TestCase`. + +* You can add a call to :func:`pdb.set_trace` in a doctest example, and you'll + drop into the Python debugger when that line is executed. Then you can inspect + current values of variables, and so on. For example, suppose :file:`a.py` + contains just this module docstring:: + + """ + >>> def f(x): + ... g(x*2) + >>> def g(x): + ... print(x+3) + ... import pdb; pdb.set_trace() + >>> f(3) + 9 + """ + + Then an interactive Python session may look like this:: + + >>> import a, doctest + >>> doctest.testmod(a) + --Return-- + > (3)g()->None + -> import pdb; pdb.set_trace() + (Pdb) list + 1 def g(x): + 2 print(x+3) + 3 -> import pdb; pdb.set_trace() + [EOF] + (Pdb) p x + 6 + (Pdb) step + --Return-- + > (2)f()->None + -> g(x*2) + (Pdb) list + 1 def f(x): + 2 -> g(x*2) + [EOF] + (Pdb) p x + 3 + (Pdb) step + --Return-- + > (1)?()->None + -> f(3) + (Pdb) cont + (0, 3) + >>> + + +Functions that convert doctests to Python code, and possibly run the synthesized +code under the debugger: + + +.. function:: script_from_examples(s) + + Convert text with examples to a script. + + Argument *s* is a string containing doctest examples. The string is converted + to a Python script, where doctest examples in *s* are converted to regular code, + and everything else is converted to Python comments. The generated script is + returned as a string. For example, :: + + import doctest + print(doctest.script_from_examples(r""" + Set x and y to 1 and 2. + >>> x, y = 1, 2 + + Print their sum: + >>> print(x+y) + 3 + """)) + + displays:: + + # Set x and y to 1 and 2. + x, y = 1, 2 + # + # Print their sum: + print(x+y) + # Expected: + ## 3 + + This function is used internally by other functions (see below), but can also be + useful when you want to transform an interactive Python session into a Python + script. + + +.. function:: testsource(module, name) + + Convert the doctest for an object to a script. + + Argument *module* is a module object, or dotted name of a module, containing the + object whose doctests are of interest. Argument *name* is the name (within the + module) of the object with the doctests of interest. The result is a string, + containing the object's docstring converted to a Python script, as described for + :func:`script_from_examples` above. For example, if module :file:`a.py` + contains a top-level function :func:`f`, then :: + + import a, doctest + print(doctest.testsource(a, "a.f")) + + prints a script version of function :func:`f`'s docstring, with doctests + converted to code, and the rest placed in comments. + + +.. function:: debug(module, name, pm=False) + + Debug the doctests for an object. + + The *module* and *name* arguments are the same as for function + :func:`testsource` above. The synthesized Python script for the named object's + docstring is written to a temporary file, and then that file is run under the + control of the Python debugger, :mod:`pdb`. + + A shallow copy of ``module.__dict__`` is used for both local and global + execution context. + + Optional argument *pm* controls whether post-mortem debugging is used. If *pm* + has a true value, the script file is run directly, and the debugger gets + involved only if the script terminates via raising an unhandled exception. If + it does, then post-mortem debugging is invoked, via :func:`pdb.post_mortem`, + passing the traceback object from the unhandled exception. If *pm* is not + specified, or is false, the script is run under the debugger from the start, via + passing an appropriate :func:`exec` call to :func:`pdb.run`. + + +.. function:: debug_src(src, pm=False, globs=None) + + Debug the doctests in a string. + + This is like function :func:`debug` above, except that a string containing + doctest examples is specified directly, via the *src* argument. + + Optional argument *pm* has the same meaning as in function :func:`debug` above. + + Optional argument *globs* gives a dictionary to use as both local and global + execution context. If not specified, or ``None``, an empty dictionary is used. + If specified, a shallow copy of the dictionary is used. + + +The :class:`DebugRunner` class, and the special exceptions it may raise, are of +most interest to testing framework authors, and will only be sketched here. See +the source code, and especially :class:`DebugRunner`'s docstring (which is a +doctest!) for more details: + + +.. class:: DebugRunner(checker=None, verbose=None, optionflags=0) + + A subclass of :class:`DocTestRunner` that raises an exception as soon as a + failure is encountered. If an unexpected exception occurs, an + :exc:`UnexpectedException` exception is raised, containing the test, the + example, and the original exception. If the output doesn't match, then a + :exc:`DocTestFailure` exception is raised, containing the test, the example, and + the actual output. + + For information about the constructor parameters and methods, see the + documentation for :class:`DocTestRunner` in section :ref:`doctest-advanced-api`. + +There are two exceptions that may be raised by :class:`DebugRunner` instances: + + +.. exception:: DocTestFailure(test, example, got) + + An exception raised by :class:`DocTestRunner` to signal that a doctest example's + actual output did not match its expected output. The constructor arguments are + used to initialize the attributes of the same names. + +:exc:`DocTestFailure` defines the following attributes: + + +.. attribute:: DocTestFailure.test + + The :class:`DocTest` object that was being run when the example failed. + + +.. attribute:: DocTestFailure.example + + The :class:`Example` that failed. + + +.. attribute:: DocTestFailure.got + + The example's actual output. + + +.. exception:: UnexpectedException(test, example, exc_info) + + An exception raised by :class:`DocTestRunner` to signal that a doctest + example raised an unexpected exception. The constructor arguments are used + to initialize the attributes of the same names. + +:exc:`UnexpectedException` defines the following attributes: + + +.. attribute:: UnexpectedException.test + + The :class:`DocTest` object that was being run when the example failed. + + +.. attribute:: UnexpectedException.example + + The :class:`Example` that failed. + + +.. attribute:: UnexpectedException.exc_info + + A tuple containing information about the unexpected exception, as returned by + :func:`sys.exc_info`. + + +.. _doctest-soapbox: + +Soapbox +------- + +As mentioned in the introduction, :mod:`doctest` has grown to have three primary +uses: + +#. Checking examples in docstrings. + +#. Regression testing. + +#. Executable documentation / literate testing. + +These uses have different requirements, and it is important to distinguish them. +In particular, filling your docstrings with obscure test cases makes for bad +documentation. + +When writing a docstring, choose docstring examples with care. There's an art to +this that needs to be learned---it may not be natural at first. Examples should +add genuine value to the documentation. A good example can often be worth many +words. If done with care, the examples will be invaluable for your users, and +will pay back the time it takes to collect them many times over as the years go +by and things change. I'm still amazed at how often one of my :mod:`doctest` +examples stops working after a "harmless" change. + +Doctest also makes an excellent tool for regression testing, especially if you +don't skimp on explanatory text. By interleaving prose and examples, it becomes +much easier to keep track of what's actually being tested, and why. When a test +fails, good prose can make it much easier to figure out what the problem is, and +how it should be fixed. It's true that you could write extensive comments in +code-based testing, but few programmers do. Many have found that using doctest +approaches instead leads to much clearer tests. Perhaps this is simply because +doctest makes writing prose a little easier than writing code, while writing +comments in code is a little harder. I think it goes deeper than just that: +the natural attitude when writing a doctest-based test is that you want to +explain the fine points of your software, and illustrate them with examples. +This in turn naturally leads to test files that start with the simplest +features, and logically progress to complications and edge cases. A coherent +narrative is the result, instead of a collection of isolated functions that test +isolated bits of functionality seemingly at random. It's a different attitude, +and produces different results, blurring the distinction between testing and +explaining. + +Regression testing is best confined to dedicated objects or files. There are +several options for organizing tests: + +* Write text files containing test cases as interactive examples, and test the + files using :func:`testfile` or :func:`DocFileSuite`. This is recommended, + although is easiest to do for new projects, designed from the start to use + doctest. + +* Define functions named ``_regrtest_topic`` that consist of single docstrings, + containing test cases for the named topics. These functions can be included in + the same file as the module, or separated out into a separate test file. + +* Define a ``__test__`` dictionary mapping from regression test topics to + docstrings containing test cases. + +When you have placed your tests in a module, the module can itself be the test +runner. When a test fails, you can arrange for your test runner to re-run only +the failing doctest while you debug the problem. Here is a minimal example of +such a test runner:: + + if __name__ == '__main__': + import doctest + flags = doctest.REPORT_NDIFF|doctest.FAIL_FAST + if len(sys.argv) > 1: + name = sys.argv[1] + if name in globals(): + obj = globals()[name] + else: + obj = __test__[name] + doctest.run_docstring_examples(obj, globals(), name=name, + optionflags=flags) + else: + fail, total = doctest.testmod(optionflags=flags) + print("{} failures out of {} tests".format(fail, total)) + + +.. rubric:: Footnotes + +.. [#] Examples containing both expected output and an exception are not supported. + Trying to guess where one ends and the other begins is too error-prone, and that + also makes for a confusing test. diff --git a/python-3.7.4-docs-html/_sources/library/dummy_threading.rst.txt b/python-3.7.4-docs-html/_sources/library/dummy_threading.rst.txt new file mode 100644 index 0000000..dfc3289 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/dummy_threading.rst.txt @@ -0,0 +1,20 @@ +:mod:`dummy_threading` --- Drop-in replacement for the :mod:`threading` module +============================================================================== + +.. module:: dummy_threading + :synopsis: Drop-in replacement for the threading module. + +**Source code:** :source:`Lib/dummy_threading.py` + +.. deprecated:: 3.7 + Python now always has threading enabled. Please use :mod:`threading` instead. + +-------------- + +This module provides a duplicate interface to the :mod:`threading` module. +It was meant to be imported when the :mod:`_thread` module was not provided +on a platform. + +Be careful to not use this module where deadlock might occur from a thread being +created that blocks waiting for another thread to be created. This often occurs +with blocking I/O. diff --git a/python-3.7.4-docs-html/_sources/library/email.charset.rst.txt b/python-3.7.4-docs-html/_sources/library/email.charset.rst.txt new file mode 100644 index 0000000..053463f --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/email.charset.rst.txt @@ -0,0 +1,247 @@ +:mod:`email.charset`: Representing character sets +------------------------------------------------- + +.. module:: email.charset + :synopsis: Character Sets + +**Source code:** :source:`Lib/email/charset.py` + +-------------- + +This module is part of the legacy (``Compat32``) email API. In the new +API only the aliases table is used. + +The remaining text in this section is the original documentation of the module. + +This module provides a class :class:`Charset` for representing character sets +and character set conversions in email messages, as well as a character set +registry and several convenience methods for manipulating this registry. +Instances of :class:`Charset` are used in several other modules within the +:mod:`email` package. + +Import this class from the :mod:`email.charset` module. + + +.. class:: Charset(input_charset=DEFAULT_CHARSET) + + Map character sets to their email properties. + + This class provides information about the requirements imposed on email for a + specific character set. It also provides convenience routines for converting + between character sets, given the availability of the applicable codecs. Given + a character set, it will do its best to provide information on how to use that + character set in an email message in an RFC-compliant way. + + Certain character sets must be encoded with quoted-printable or base64 when used + in email headers or bodies. Certain character sets must be converted outright, + and are not allowed in email. + + Optional *input_charset* is as described below; it is always coerced to lower + case. After being alias normalized it is also used as a lookup into the + registry of character sets to find out the header encoding, body encoding, and + output conversion codec to be used for the character set. For example, if + *input_charset* is ``iso-8859-1``, then headers and bodies will be encoded using + quoted-printable and no output conversion codec is necessary. If + *input_charset* is ``euc-jp``, then headers will be encoded with base64, bodies + will not be encoded, but output text will be converted from the ``euc-jp`` + character set to the ``iso-2022-jp`` character set. + + :class:`Charset` instances have the following data attributes: + + .. attribute:: input_charset + + The initial character set specified. Common aliases are converted to + their *official* email names (e.g. ``latin_1`` is converted to + ``iso-8859-1``). Defaults to 7-bit ``us-ascii``. + + + .. attribute:: header_encoding + + If the character set must be encoded before it can be used in an email + header, this attribute will be set to ``Charset.QP`` (for + quoted-printable), ``Charset.BASE64`` (for base64 encoding), or + ``Charset.SHORTEST`` for the shortest of QP or BASE64 encoding. Otherwise, + it will be ``None``. + + + .. attribute:: body_encoding + + Same as *header_encoding*, but describes the encoding for the mail + message's body, which indeed may be different than the header encoding. + ``Charset.SHORTEST`` is not allowed for *body_encoding*. + + + .. attribute:: output_charset + + Some character sets must be converted before they can be used in email + headers or bodies. If the *input_charset* is one of them, this attribute + will contain the name of the character set output will be converted to. + Otherwise, it will be ``None``. + + + .. attribute:: input_codec + + The name of the Python codec used to convert the *input_charset* to + Unicode. If no conversion codec is necessary, this attribute will be + ``None``. + + + .. attribute:: output_codec + + The name of the Python codec used to convert Unicode to the + *output_charset*. If no conversion codec is necessary, this attribute + will have the same value as the *input_codec*. + + + :class:`Charset` instances also have the following methods: + + .. method:: get_body_encoding() + + Return the content transfer encoding used for body encoding. + + This is either the string ``quoted-printable`` or ``base64`` depending on + the encoding used, or it is a function, in which case you should call the + function with a single argument, the Message object being encoded. The + function should then set the :mailheader:`Content-Transfer-Encoding` + header itself to whatever is appropriate. + + Returns the string ``quoted-printable`` if *body_encoding* is ``QP``, + returns the string ``base64`` if *body_encoding* is ``BASE64``, and + returns the string ``7bit`` otherwise. + + + .. XXX to_splittable and from_splittable are not there anymore! + + .. to_splittable(s) + + Convert a possibly multibyte string to a safely splittable format. *s* is + the string to split. + + Uses the *input_codec* to try and convert the string to Unicode, so it can + be safely split on character boundaries (even for multibyte characters). + + Returns the string as-is if it isn't known how to convert *s* to Unicode + with the *input_charset*. + + Characters that could not be converted to Unicode will be replaced with + the Unicode replacement character ``'U+FFFD'``. + + + .. from_splittable(ustr[, to_output]) + + Convert a splittable string back into an encoded string. *ustr* is a + Unicode string to "unsplit". + + This method uses the proper codec to try and convert the string from + Unicode back into an encoded format. Return the string as-is if it is not + Unicode, or if it could not be converted from Unicode. + + Characters that could not be converted from Unicode will be replaced with + an appropriate character (usually ``'?'``). + + If *to_output* is ``True`` (the default), uses *output_codec* to convert + to an encoded format. If *to_output* is ``False``, it uses *input_codec*. + + + .. method:: get_output_charset() + + Return the output character set. + + This is the *output_charset* attribute if that is not ``None``, otherwise + it is *input_charset*. + + + .. method:: header_encode(string) + + Header-encode the string *string*. + + The type of encoding (base64 or quoted-printable) will be based on the + *header_encoding* attribute. + + + .. method:: header_encode_lines(string, maxlengths) + + Header-encode a *string* by converting it first to bytes. + + This is similar to :meth:`header_encode` except that the string is fit + into maximum line lengths as given by the argument *maxlengths*, which + must be an iterator: each element returned from this iterator will provide + the next maximum line length. + + + .. method:: body_encode(string) + + Body-encode the string *string*. + + The type of encoding (base64 or quoted-printable) will be based on the + *body_encoding* attribute. + + The :class:`Charset` class also provides a number of methods to support + standard operations and built-in functions. + + + .. method:: __str__() + + Returns *input_charset* as a string coerced to lower + case. :meth:`__repr__` is an alias for :meth:`__str__`. + + + .. method:: __eq__(other) + + This method allows you to compare two :class:`Charset` instances for + equality. + + + .. method:: __ne__(other) + + This method allows you to compare two :class:`Charset` instances for + inequality. + +The :mod:`email.charset` module also provides the following functions for adding +new entries to the global character set, alias, and codec registries: + + +.. function:: add_charset(charset, header_enc=None, body_enc=None, output_charset=None) + + Add character properties to the global registry. + + *charset* is the input character set, and must be the canonical name of a + character set. + + Optional *header_enc* and *body_enc* is either ``Charset.QP`` for + quoted-printable, ``Charset.BASE64`` for base64 encoding, + ``Charset.SHORTEST`` for the shortest of quoted-printable or base64 encoding, + or ``None`` for no encoding. ``SHORTEST`` is only valid for + *header_enc*. The default is ``None`` for no encoding. + + Optional *output_charset* is the character set that the output should be in. + Conversions will proceed from input charset, to Unicode, to the output charset + when the method :meth:`Charset.convert` is called. The default is to output in + the same character set as the input. + + Both *input_charset* and *output_charset* must have Unicode codec entries in the + module's character set-to-codec mapping; use :func:`add_codec` to add codecs the + module does not know about. See the :mod:`codecs` module's documentation for + more information. + + The global character set registry is kept in the module global dictionary + ``CHARSETS``. + + +.. function:: add_alias(alias, canonical) + + Add a character set alias. *alias* is the alias name, e.g. ``latin-1``. + *canonical* is the character set's canonical name, e.g. ``iso-8859-1``. + + The global charset alias registry is kept in the module global dictionary + ``ALIASES``. + + +.. function:: add_codec(charset, codecname) + + Add a codec that map characters in the given character set to and from Unicode. + + *charset* is the canonical name of a character set. *codecname* is the name of a + Python codec, as appropriate for the second argument to the :class:`str`'s + :meth:`~str.encode` method. + diff --git a/python-3.7.4-docs-html/_sources/library/email.compat32-message.rst.txt b/python-3.7.4-docs-html/_sources/library/email.compat32-message.rst.txt new file mode 100644 index 0000000..09ea64a --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/email.compat32-message.rst.txt @@ -0,0 +1,759 @@ +.. _compat32_message: + +:mod:`email.message.Message`: Representing an email message using the :data:`~email.policy.compat32` API +-------------------------------------------------------------------------------------------------------- + +.. module:: email.message + :synopsis: The base class representing email messages in a fashion + backward compatible with Python 3.2 + :noindex: + + +The :class:`Message` class is very similar to the +:class:`~email.message.EmailMessage` class, without the methods added by that +class, and with the default behavior of certain other methods being slightly +different. We also document here some methods that, while supported by the +:class:`~email.message.EmailMessage` class, are not recommended unless you are +dealing with legacy code. + +The philosophy and structure of the two classes is otherwise the same. + +This document describes the behavior under the default (for :class:`Message`) +policy :attr:`~email.policy.Compat32`. If you are going to use another policy, +you should be using the :class:`~email.message.EmailMessage` class instead. + +An email message consists of *headers* and a *payload*. Headers must be +:rfc:`5233` style names and values, where the field name and value are +separated by a colon. The colon is not part of either the field name or the +field value. The payload may be a simple text message, or a binary object, or +a structured sequence of sub-messages each with their own set of headers and +their own payload. The latter type of payload is indicated by the message +having a MIME type such as :mimetype:`multipart/\*` or +:mimetype:`message/rfc822`. + +The conceptual model provided by a :class:`Message` object is that of an +ordered dictionary of headers with additional methods for accessing both +specialized information from the headers, for accessing the payload, for +generating a serialized version of the message, and for recursively walking +over the object tree. Note that duplicate headers are supported but special +methods must be used to access them. + +The :class:`Message` pseudo-dictionary is indexed by the header names, which +must be ASCII values. The values of the dictionary are strings that are +supposed to contain only ASCII characters; there is some special handling for +non-ASCII input, but it doesn't always produce the correct results. Headers +are stored and returned in case-preserving form, but field names are matched +case-insensitively. There may also be a single envelope header, also known as +the *Unix-From* header or the ``From_`` header. The *payload* is either a +string or bytes, in the case of simple message objects, or a list of +:class:`Message` objects, for MIME container documents (e.g. +:mimetype:`multipart/\*` and :mimetype:`message/rfc822`). + +Here are the methods of the :class:`Message` class: + + +.. class:: Message(policy=compat32) + + If *policy* is specified (it must be an instance of a :mod:`~email.policy` + class) use the rules it specifies to update and serialize the representation + of the message. If *policy* is not set, use the :class:`compat32 + ` policy, which maintains backward compatibility with + the Python 3.2 version of the email package. For more information see the + :mod:`~email.policy` documentation. + + .. versionchanged:: 3.3 The *policy* keyword argument was added. + + + .. method:: as_string(unixfrom=False, maxheaderlen=0, policy=None) + + Return the entire message flattened as a string. When optional *unixfrom* + is true, the envelope header is included in the returned string. + *unixfrom* defaults to ``False``. For backward compatibility reasons, + *maxheaderlen* defaults to ``0``, so if you want a different value you + must override it explicitly (the value specified for *max_line_length* in + the policy will be ignored by this method). The *policy* argument may be + used to override the default policy obtained from the message instance. + This can be used to control some of the formatting produced by the + method, since the specified *policy* will be passed to the ``Generator``. + + Flattening the message may trigger changes to the :class:`Message` if + defaults need to be filled in to complete the transformation to a string + (for example, MIME boundaries may be generated or modified). + + Note that this method is provided as a convenience and may not always + format the message the way you want. For example, by default it does + not do the mangling of lines that begin with ``From`` that is + required by the unix mbox format. For more flexibility, instantiate a + :class:`~email.generator.Generator` instance and use its + :meth:`~email.generator.Generator.flatten` method directly. For example:: + + from io import StringIO + from email.generator import Generator + fp = StringIO() + g = Generator(fp, mangle_from_=True, maxheaderlen=60) + g.flatten(msg) + text = fp.getvalue() + + If the message object contains binary data that is not encoded according + to RFC standards, the non-compliant data will be replaced by unicode + "unknown character" code points. (See also :meth:`.as_bytes` and + :class:`~email.generator.BytesGenerator`.) + + .. versionchanged:: 3.4 the *policy* keyword argument was added. + + + .. method:: __str__() + + Equivalent to :meth:`.as_string()`. Allows ``str(msg)`` to produce a + string containing the formatted message. + + + .. method:: as_bytes(unixfrom=False, policy=None) + + Return the entire message flattened as a bytes object. When optional + *unixfrom* is true, the envelope header is included in the returned + string. *unixfrom* defaults to ``False``. The *policy* argument may be + used to override the default policy obtained from the message instance. + This can be used to control some of the formatting produced by the + method, since the specified *policy* will be passed to the + ``BytesGenerator``. + + Flattening the message may trigger changes to the :class:`Message` if + defaults need to be filled in to complete the transformation to a string + (for example, MIME boundaries may be generated or modified). + + Note that this method is provided as a convenience and may not always + format the message the way you want. For example, by default it does + not do the mangling of lines that begin with ``From`` that is + required by the unix mbox format. For more flexibility, instantiate a + :class:`~email.generator.BytesGenerator` instance and use its + :meth:`~email.generator.BytesGenerator.flatten` method directly. + For example:: + + from io import BytesIO + from email.generator import BytesGenerator + fp = BytesIO() + g = BytesGenerator(fp, mangle_from_=True, maxheaderlen=60) + g.flatten(msg) + text = fp.getvalue() + + .. versionadded:: 3.4 + + + .. method:: __bytes__() + + Equivalent to :meth:`.as_bytes()`. Allows ``bytes(msg)`` to produce a + bytes object containing the formatted message. + + .. versionadded:: 3.4 + + + .. method:: is_multipart() + + Return ``True`` if the message's payload is a list of + sub-\ :class:`Message` objects, otherwise return ``False``. When + :meth:`is_multipart` returns ``False``, the payload should be a string + object (which might be a CTE encoded binary payload). (Note that + :meth:`is_multipart` returning ``True`` does not necessarily mean that + "msg.get_content_maintype() == 'multipart'" will return the ``True``. + For example, ``is_multipart`` will return ``True`` when the + :class:`Message` is of type ``message/rfc822``.) + + + .. method:: set_unixfrom(unixfrom) + + Set the message's envelope header to *unixfrom*, which should be a string. + + + .. method:: get_unixfrom() + + Return the message's envelope header. Defaults to ``None`` if the + envelope header was never set. + + + .. method:: attach(payload) + + Add the given *payload* to the current payload, which must be ``None`` or + a list of :class:`Message` objects before the call. After the call, the + payload will always be a list of :class:`Message` objects. If you want to + set the payload to a scalar object (e.g. a string), use + :meth:`set_payload` instead. + + This is a legacy method. On the + :class:`~email.emailmessage.EmailMessage` class its functionality is + replaced by :meth:`~email.message.EmailMessage.set_content` and the + related ``make`` and ``add`` methods. + + + .. method:: get_payload(i=None, decode=False) + + Return the current payload, which will be a list of + :class:`Message` objects when :meth:`is_multipart` is ``True``, or a + string when :meth:`is_multipart` is ``False``. If the payload is a list + and you mutate the list object, you modify the message's payload in place. + + With optional argument *i*, :meth:`get_payload` will return the *i*-th + element of the payload, counting from zero, if :meth:`is_multipart` is + ``True``. An :exc:`IndexError` will be raised if *i* is less than 0 or + greater than or equal to the number of items in the payload. If the + payload is a string (i.e. :meth:`is_multipart` is ``False``) and *i* is + given, a :exc:`TypeError` is raised. + + Optional *decode* is a flag indicating whether the payload should be + decoded or not, according to the :mailheader:`Content-Transfer-Encoding` + header. When ``True`` and the message is not a multipart, the payload will + be decoded if this header's value is ``quoted-printable`` or ``base64``. + If some other encoding is used, or :mailheader:`Content-Transfer-Encoding` + header is missing, the payload is + returned as-is (undecoded). In all cases the returned value is binary + data. If the message is a multipart and the *decode* flag is ``True``, + then ``None`` is returned. If the payload is base64 and it was not + perfectly formed (missing padding, characters outside the base64 + alphabet), then an appropriate defect will be added to the message's + defect property (:class:`~email.errors.InvalidBase64PaddingDefect` or + :class:`~email.errors.InvalidBase64CharactersDefect`, respectively). + + When *decode* is ``False`` (the default) the body is returned as a string + without decoding the :mailheader:`Content-Transfer-Encoding`. However, + for a :mailheader:`Content-Transfer-Encoding` of 8bit, an attempt is made + to decode the original bytes using the ``charset`` specified by the + :mailheader:`Content-Type` header, using the ``replace`` error handler. + If no ``charset`` is specified, or if the ``charset`` given is not + recognized by the email package, the body is decoded using the default + ASCII charset. + + This is a legacy method. On the + :class:`~email.emailmessage.EmailMessage` class its functionality is + replaced by :meth:`~email.message.EmailMessage.get_content` and + :meth:`~email.message.EmailMessage.iter_parts`. + + + .. method:: set_payload(payload, charset=None) + + Set the entire message object's payload to *payload*. It is the client's + responsibility to ensure the payload invariants. Optional *charset* sets + the message's default character set; see :meth:`set_charset` for details. + + This is a legacy method. On the + :class:`~email.emailmessage.EmailMessage` class its functionality is + replaced by :meth:`~email.message.EmailMessage.set_content`. + + + .. method:: set_charset(charset) + + Set the character set of the payload to *charset*, which can either be a + :class:`~email.charset.Charset` instance (see :mod:`email.charset`), a + string naming a character set, or ``None``. If it is a string, it will + be converted to a :class:`~email.charset.Charset` instance. If *charset* + is ``None``, the ``charset`` parameter will be removed from the + :mailheader:`Content-Type` header (the message will not be otherwise + modified). Anything else will generate a :exc:`TypeError`. + + If there is no existing :mailheader:`MIME-Version` header one will be + added. If there is no existing :mailheader:`Content-Type` header, one + will be added with a value of :mimetype:`text/plain`. Whether the + :mailheader:`Content-Type` header already exists or not, its ``charset`` + parameter will be set to *charset.output_charset*. If + *charset.input_charset* and *charset.output_charset* differ, the payload + will be re-encoded to the *output_charset*. If there is no existing + :mailheader:`Content-Transfer-Encoding` header, then the payload will be + transfer-encoded, if needed, using the specified + :class:`~email.charset.Charset`, and a header with the appropriate value + will be added. If a :mailheader:`Content-Transfer-Encoding` header + already exists, the payload is assumed to already be correctly encoded + using that :mailheader:`Content-Transfer-Encoding` and is not modified. + + This is a legacy method. On the + :class:`~email.emailmessage.EmailMessage` class its functionality is + replaced by the *charset* parameter of the + :meth:`email.emailmessage.EmailMessage.set_content` method. + + + .. method:: get_charset() + + Return the :class:`~email.charset.Charset` instance associated with the + message's payload. + + This is a legacy method. On the + :class:`~email.emailmessage.EmailMessage` class it always returns + ``None``. + + + The following methods implement a mapping-like interface for accessing the + message's :rfc:`2822` headers. Note that there are some semantic differences + between these methods and a normal mapping (i.e. dictionary) interface. For + example, in a dictionary there are no duplicate keys, but here there may be + duplicate message headers. Also, in dictionaries there is no guaranteed + order to the keys returned by :meth:`keys`, but in a :class:`Message` object, + headers are always returned in the order they appeared in the original + message, or were added to the message later. Any header deleted and then + re-added are always appended to the end of the header list. + + These semantic differences are intentional and are biased toward maximal + convenience. + + Note that in all cases, any envelope header present in the message is not + included in the mapping interface. + + In a model generated from bytes, any header values that (in contravention of + the RFCs) contain non-ASCII bytes will, when retrieved through this + interface, be represented as :class:`~email.header.Header` objects with + a charset of `unknown-8bit`. + + + .. method:: __len__() + + Return the total number of headers, including duplicates. + + + .. method:: __contains__(name) + + Return true if the message object has a field named *name*. Matching is + done case-insensitively and *name* should not include the trailing colon. + Used for the ``in`` operator, e.g.:: + + if 'message-id' in myMessage: + print('Message-ID:', myMessage['message-id']) + + + .. method:: __getitem__(name) + + Return the value of the named header field. *name* should not include the + colon field separator. If the header is missing, ``None`` is returned; a + :exc:`KeyError` is never raised. + + Note that if the named field appears more than once in the message's + headers, exactly which of those field values will be returned is + undefined. Use the :meth:`get_all` method to get the values of all the + extant named headers. + + + .. method:: __setitem__(name, val) + + Add a header to the message with field name *name* and value *val*. The + field is appended to the end of the message's existing fields. + + Note that this does *not* overwrite or delete any existing header with the same + name. If you want to ensure that the new header is the only one present in the + message with field name *name*, delete the field first, e.g.:: + + del msg['subject'] + msg['subject'] = 'Python roolz!' + + + .. method:: __delitem__(name) + + Delete all occurrences of the field with name *name* from the message's + headers. No exception is raised if the named field isn't present in the + headers. + + + .. method:: keys() + + Return a list of all the message's header field names. + + + .. method:: values() + + Return a list of all the message's field values. + + + .. method:: items() + + Return a list of 2-tuples containing all the message's field headers and + values. + + + .. method:: get(name, failobj=None) + + Return the value of the named header field. This is identical to + :meth:`__getitem__` except that optional *failobj* is returned if the + named header is missing (defaults to ``None``). + + Here are some additional useful methods: + + + .. method:: get_all(name, failobj=None) + + Return a list of all the values for the field named *name*. If there are + no such named headers in the message, *failobj* is returned (defaults to + ``None``). + + + .. method:: add_header(_name, _value, **_params) + + Extended header setting. This method is similar to :meth:`__setitem__` + except that additional header parameters can be provided as keyword + arguments. *_name* is the header field to add and *_value* is the + *primary* value for the header. + + For each item in the keyword argument dictionary *_params*, the key is + taken as the parameter name, with underscores converted to dashes (since + dashes are illegal in Python identifiers). Normally, the parameter will + be added as ``key="value"`` unless the value is ``None``, in which case + only the key will be added. If the value contains non-ASCII characters, + it can be specified as a three tuple in the format + ``(CHARSET, LANGUAGE, VALUE)``, where ``CHARSET`` is a string naming the + charset to be used to encode the value, ``LANGUAGE`` can usually be set + to ``None`` or the empty string (see :rfc:`2231` for other possibilities), + and ``VALUE`` is the string value containing non-ASCII code points. If + a three tuple is not passed and the value contains non-ASCII characters, + it is automatically encoded in :rfc:`2231` format using a ``CHARSET`` + of ``utf-8`` and a ``LANGUAGE`` of ``None``. + + Here's an example:: + + msg.add_header('Content-Disposition', 'attachment', filename='bud.gif') + + This will add a header that looks like :: + + Content-Disposition: attachment; filename="bud.gif" + + An example with non-ASCII characters:: + + msg.add_header('Content-Disposition', 'attachment', + filename=('iso-8859-1', '', 'Fußballer.ppt')) + + Which produces :: + + Content-Disposition: attachment; filename*="iso-8859-1''Fu%DFballer.ppt" + + + .. method:: replace_header(_name, _value) + + Replace a header. Replace the first header found in the message that + matches *_name*, retaining header order and field name case. If no + matching header was found, a :exc:`KeyError` is raised. + + + .. method:: get_content_type() + + Return the message's content type. The returned string is coerced to + lower case of the form :mimetype:`maintype/subtype`. If there was no + :mailheader:`Content-Type` header in the message the default type as given + by :meth:`get_default_type` will be returned. Since according to + :rfc:`2045`, messages always have a default type, :meth:`get_content_type` + will always return a value. + + :rfc:`2045` defines a message's default type to be :mimetype:`text/plain` + unless it appears inside a :mimetype:`multipart/digest` container, in + which case it would be :mimetype:`message/rfc822`. If the + :mailheader:`Content-Type` header has an invalid type specification, + :rfc:`2045` mandates that the default type be :mimetype:`text/plain`. + + + .. method:: get_content_maintype() + + Return the message's main content type. This is the :mimetype:`maintype` + part of the string returned by :meth:`get_content_type`. + + + .. method:: get_content_subtype() + + Return the message's sub-content type. This is the :mimetype:`subtype` + part of the string returned by :meth:`get_content_type`. + + + .. method:: get_default_type() + + Return the default content type. Most messages have a default content + type of :mimetype:`text/plain`, except for messages that are subparts of + :mimetype:`multipart/digest` containers. Such subparts have a default + content type of :mimetype:`message/rfc822`. + + + .. method:: set_default_type(ctype) + + Set the default content type. *ctype* should either be + :mimetype:`text/plain` or :mimetype:`message/rfc822`, although this is not + enforced. The default content type is not stored in the + :mailheader:`Content-Type` header. + + + .. method:: get_params(failobj=None, header='content-type', unquote=True) + + Return the message's :mailheader:`Content-Type` parameters, as a list. + The elements of the returned list are 2-tuples of key/value pairs, as + split on the ``'='`` sign. The left hand side of the ``'='`` is the key, + while the right hand side is the value. If there is no ``'='`` sign in + the parameter the value is the empty string, otherwise the value is as + described in :meth:`get_param` and is unquoted if optional *unquote* is + ``True`` (the default). + + Optional *failobj* is the object to return if there is no + :mailheader:`Content-Type` header. Optional *header* is the header to + search instead of :mailheader:`Content-Type`. + + This is a legacy method. On the + :class:`~email.emailmessage.EmailMessage` class its functionality is + replaced by the *params* property of the individual header objects + returned by the header access methods. + + + .. method:: get_param(param, failobj=None, header='content-type', unquote=True) + + Return the value of the :mailheader:`Content-Type` header's parameter + *param* as a string. If the message has no :mailheader:`Content-Type` + header or if there is no such parameter, then *failobj* is returned + (defaults to ``None``). + + Optional *header* if given, specifies the message header to use instead of + :mailheader:`Content-Type`. + + Parameter keys are always compared case insensitively. The return value + can either be a string, or a 3-tuple if the parameter was :rfc:`2231` + encoded. When it's a 3-tuple, the elements of the value are of the form + ``(CHARSET, LANGUAGE, VALUE)``. Note that both ``CHARSET`` and + ``LANGUAGE`` can be ``None``, in which case you should consider ``VALUE`` + to be encoded in the ``us-ascii`` charset. You can usually ignore + ``LANGUAGE``. + + If your application doesn't care whether the parameter was encoded as in + :rfc:`2231`, you can collapse the parameter value by calling + :func:`email.utils.collapse_rfc2231_value`, passing in the return value + from :meth:`get_param`. This will return a suitably decoded Unicode + string when the value is a tuple, or the original string unquoted if it + isn't. For example:: + + rawparam = msg.get_param('foo') + param = email.utils.collapse_rfc2231_value(rawparam) + + In any case, the parameter value (either the returned string, or the + ``VALUE`` item in the 3-tuple) is always unquoted, unless *unquote* is set + to ``False``. + + This is a legacy method. On the + :class:`~email.emailmessage.EmailMessage` class its functionality is + replaced by the *params* property of the individual header objects + returned by the header access methods. + + + .. method:: set_param(param, value, header='Content-Type', requote=True, \ + charset=None, language='', replace=False) + + Set a parameter in the :mailheader:`Content-Type` header. If the + parameter already exists in the header, its value will be replaced with + *value*. If the :mailheader:`Content-Type` header as not yet been defined + for this message, it will be set to :mimetype:`text/plain` and the new + parameter value will be appended as per :rfc:`2045`. + + Optional *header* specifies an alternative header to + :mailheader:`Content-Type`, and all parameters will be quoted as necessary + unless optional *requote* is ``False`` (the default is ``True``). + + If optional *charset* is specified, the parameter will be encoded + according to :rfc:`2231`. Optional *language* specifies the RFC 2231 + language, defaulting to the empty string. Both *charset* and *language* + should be strings. + + If *replace* is ``False`` (the default) the header is moved to the + end of the list of headers. If *replace* is ``True``, the header + will be updated in place. + + .. versionchanged:: 3.4 ``replace`` keyword was added. + + + .. method:: del_param(param, header='content-type', requote=True) + + Remove the given parameter completely from the :mailheader:`Content-Type` + header. The header will be re-written in place without the parameter or + its value. All values will be quoted as necessary unless *requote* is + ``False`` (the default is ``True``). Optional *header* specifies an + alternative to :mailheader:`Content-Type`. + + + .. method:: set_type(type, header='Content-Type', requote=True) + + Set the main type and subtype for the :mailheader:`Content-Type` + header. *type* must be a string in the form :mimetype:`maintype/subtype`, + otherwise a :exc:`ValueError` is raised. + + This method replaces the :mailheader:`Content-Type` header, keeping all + the parameters in place. If *requote* is ``False``, this leaves the + existing header's quoting as is, otherwise the parameters will be quoted + (the default). + + An alternative header can be specified in the *header* argument. When the + :mailheader:`Content-Type` header is set a :mailheader:`MIME-Version` + header is also added. + + This is a legacy method. On the + :class:`~email.emailmessage.EmailMessage` class its functionality is + replaced by the ``make_`` and ``add_`` methods. + + + .. method:: get_filename(failobj=None) + + Return the value of the ``filename`` parameter of the + :mailheader:`Content-Disposition` header of the message. If the header + does not have a ``filename`` parameter, this method falls back to looking + for the ``name`` parameter on the :mailheader:`Content-Type` header. If + neither is found, or the header is missing, then *failobj* is returned. + The returned string will always be unquoted as per + :func:`email.utils.unquote`. + + + .. method:: get_boundary(failobj=None) + + Return the value of the ``boundary`` parameter of the + :mailheader:`Content-Type` header of the message, or *failobj* if either + the header is missing, or has no ``boundary`` parameter. The returned + string will always be unquoted as per :func:`email.utils.unquote`. + + + .. method:: set_boundary(boundary) + + Set the ``boundary`` parameter of the :mailheader:`Content-Type` header to + *boundary*. :meth:`set_boundary` will always quote *boundary* if + necessary. A :exc:`~email.errors.HeaderParseError` is raised if the + message object has no :mailheader:`Content-Type` header. + + Note that using this method is subtly different than deleting the old + :mailheader:`Content-Type` header and adding a new one with the new + boundary via :meth:`add_header`, because :meth:`set_boundary` preserves + the order of the :mailheader:`Content-Type` header in the list of + headers. However, it does *not* preserve any continuation lines which may + have been present in the original :mailheader:`Content-Type` header. + + + .. method:: get_content_charset(failobj=None) + + Return the ``charset`` parameter of the :mailheader:`Content-Type` header, + coerced to lower case. If there is no :mailheader:`Content-Type` header, or if + that header has no ``charset`` parameter, *failobj* is returned. + + Note that this method differs from :meth:`get_charset` which returns the + :class:`~email.charset.Charset` instance for the default encoding of the message body. + + + .. method:: get_charsets(failobj=None) + + Return a list containing the character set names in the message. If the + message is a :mimetype:`multipart`, then the list will contain one element + for each subpart in the payload, otherwise, it will be a list of length 1. + + Each item in the list will be a string which is the value of the + ``charset`` parameter in the :mailheader:`Content-Type` header for the + represented subpart. However, if the subpart has no + :mailheader:`Content-Type` header, no ``charset`` parameter, or is not of + the :mimetype:`text` main MIME type, then that item in the returned list + will be *failobj*. + + + .. method:: get_content_disposition() + + Return the lowercased value (without parameters) of the message's + :mailheader:`Content-Disposition` header if it has one, or ``None``. The + possible values for this method are *inline*, *attachment* or ``None`` + if the message follows :rfc:`2183`. + + .. versionadded:: 3.5 + + .. method:: walk() + + The :meth:`walk` method is an all-purpose generator which can be used to + iterate over all the parts and subparts of a message object tree, in + depth-first traversal order. You will typically use :meth:`walk` as the + iterator in a ``for`` loop; each iteration returns the next subpart. + + Here's an example that prints the MIME type of every part of a multipart + message structure: + + .. testsetup:: + + import email + from email import message_from_binary_file + from os.path import join, dirname + lib_dir = dirname(dirname(email.__file__)) + file_path = join(lib_dir, 'test/test_email/data/msg_16.txt') + with open(file_path, 'rb') as f: + msg = message_from_binary_file(f) + from email.iterators import _structure + + .. doctest:: + + >>> for part in msg.walk(): + ... print(part.get_content_type()) + multipart/report + text/plain + message/delivery-status + text/plain + text/plain + message/rfc822 + text/plain + + ``walk`` iterates over the subparts of any part where + :meth:`is_multipart` returns ``True``, even though + ``msg.get_content_maintype() == 'multipart'`` may return ``False``. We + can see this in our example by making use of the ``_structure`` debug + helper function: + + .. doctest:: + + >>> for part in msg.walk(): + ... print(part.get_content_maintype() == 'multipart', + ... part.is_multipart()) + True True + False False + False True + False False + False False + False True + False False + >>> _structure(msg) + multipart/report + text/plain + message/delivery-status + text/plain + text/plain + message/rfc822 + text/plain + + Here the ``message`` parts are not ``multiparts``, but they do contain + subparts. ``is_multipart()`` returns ``True`` and ``walk`` descends + into the subparts. + + + :class:`Message` objects can also optionally contain two instance attributes, + which can be used when generating the plain text of a MIME message. + + + .. attribute:: preamble + + The format of a MIME document allows for some text between the blank line + following the headers, and the first multipart boundary string. Normally, + this text is never visible in a MIME-aware mail reader because it falls + outside the standard MIME armor. However, when viewing the raw text of + the message, or when viewing the message in a non-MIME aware reader, this + text can become visible. + + The *preamble* attribute contains this leading extra-armor text for MIME + documents. When the :class:`~email.parser.Parser` discovers some text + after the headers but before the first boundary string, it assigns this + text to the message's *preamble* attribute. When the + :class:`~email.generator.Generator` is writing out the plain text + representation of a MIME message, and it finds the + message has a *preamble* attribute, it will write this text in the area + between the headers and the first boundary. See :mod:`email.parser` and + :mod:`email.generator` for details. + + Note that if the message object has no preamble, the *preamble* attribute + will be ``None``. + + + .. attribute:: epilogue + + The *epilogue* attribute acts the same way as the *preamble* attribute, + except that it contains text that appears between the last boundary and + the end of the message. + + You do not need to set the epilogue to the empty string in order for the + :class:`~email.generator.Generator` to print a newline at the end of the + file. + + + .. attribute:: defects + + The *defects* attribute contains a list of all the problems found when + parsing this message. See :mod:`email.errors` for a detailed description + of the possible parsing defects. diff --git a/python-3.7.4-docs-html/_sources/library/email.contentmanager.rst.txt b/python-3.7.4-docs-html/_sources/library/email.contentmanager.rst.txt new file mode 100644 index 0000000..e09c7c0 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/email.contentmanager.rst.txt @@ -0,0 +1,198 @@ +:mod:`email.contentmanager`: Managing MIME Content +-------------------------------------------------- + +.. module:: email.contentmanager + :synopsis: Storing and Retrieving Content from MIME Parts + +.. moduleauthor:: R. David Murray +.. sectionauthor:: R. David Murray + +**Source code:** :source:`Lib/email/contentmanager.py` + +------------ + +.. versionadded:: 3.6 [1]_ + + +.. class:: ContentManager() + + Base class for content managers. Provides the standard registry mechanisms + to register converters between MIME content and other representations, as + well as the ``get_content`` and ``set_content`` dispatch methods. + + + .. method:: get_content(msg, *args, **kw) + + Look up a handler function based on the ``mimetype`` of *msg* (see next + paragraph), call it, passing through all arguments, and return the result + of the call. The expectation is that the handler will extract the + payload from *msg* and return an object that encodes information about + the extracted data. + + To find the handler, look for the following keys in the registry, + stopping with the first one found: + + * the string representing the full MIME type (``maintype/subtype``) + * the string representing the ``maintype`` + * the empty string + + If none of these keys produce a handler, raise a :exc:`KeyError` for the + full MIME type. + + + .. method:: set_content(msg, obj, *args, **kw) + + If the ``maintype`` is ``multipart``, raise a :exc:`TypeError`; otherwise + look up a handler function based on the type of *obj* (see next + paragraph), call :meth:`~email.message.EmailMessage.clear_content` on the + *msg*, and call the handler function, passing through all arguments. The + expectation is that the handler will transform and store *obj* into + *msg*, possibly making other changes to *msg* as well, such as adding + various MIME headers to encode information needed to interpret the stored + data. + + To find the handler, obtain the type of *obj* (``typ = type(obj)``), and + look for the following keys in the registry, stopping with the first one + found: + + * the type itself (``typ``) + * the type's fully qualified name (``typ.__module__ + '.' + + typ.__qualname__``). + * the type's qualname (``typ.__qualname__``) + * the type's name (``typ.__name__``). + + If none of the above match, repeat all of the checks above for each of + the types in the :term:`MRO` (``typ.__mro__``). Finally, if no other key + yields a handler, check for a handler for the key ``None``. If there is + no handler for ``None``, raise a :exc:`KeyError` for the fully + qualified name of the type. + + Also add a :mailheader:`MIME-Version` header if one is not present (see + also :class:`.MIMEPart`). + + + .. method:: add_get_handler(key, handler) + + Record the function *handler* as the handler for *key*. For the possible + values of *key*, see :meth:`get_content`. + + + .. method:: add_set_handler(typekey, handler) + + Record *handler* as the function to call when an object of a type + matching *typekey* is passed to :meth:`set_content`. For the possible + values of *typekey*, see :meth:`set_content`. + + +Content Manager Instances +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Currently the email package provides only one concrete content manager, +:data:`raw_data_manager`, although more may be added in the future. +:data:`raw_data_manager` is the +:attr:`~email.policy.EmailPolicy.content_manager` provided by +:attr:`~email.policy.EmailPolicy` and its derivatives. + + +.. data:: raw_data_manager + + This content manager provides only a minimum interface beyond that provided + by :class:`~email.message.Message` itself: it deals only with text, raw + byte strings, and :class:`~email.message.Message` objects. Nevertheless, it + provides significant advantages compared to the base API: ``get_content`` on + a text part will return a unicode string without the application needing to + manually decode it, ``set_content`` provides a rich set of options for + controlling the headers added to a part and controlling the content transfer + encoding, and it enables the use of the various ``add_`` methods, thereby + simplifying the creation of multipart messages. + + .. method:: get_content(msg, errors='replace') + + Return the payload of the part as either a string (for ``text`` parts), an + :class:`~email.message.EmailMessage` object (for ``message/rfc822`` + parts), or a ``bytes`` object (for all other non-multipart types). Raise + a :exc:`KeyError` if called on a ``multipart``. If the part is a + ``text`` part and *errors* is specified, use it as the error handler when + decoding the payload to unicode. The default error handler is + ``replace``. + + .. method:: set_content(msg, <'str'>, subtype="plain", charset='utf-8' \ + cte=None, \ + disposition=None, filename=None, cid=None, \ + params=None, headers=None) + set_content(msg, <'bytes'>, maintype, subtype, cte="base64", \ + disposition=None, filename=None, cid=None, \ + params=None, headers=None) + set_content(msg, <'EmailMessage'>, cte=None, \ + disposition=None, filename=None, cid=None, \ + params=None, headers=None) + + Add headers and payload to *msg*: + + Add a :mailheader:`Content-Type` header with a ``maintype/subtype`` + value. + + * For ``str``, set the MIME ``maintype`` to ``text``, and set the + subtype to *subtype* if it is specified, or ``plain`` if it is not. + * For ``bytes``, use the specified *maintype* and *subtype*, or + raise a :exc:`TypeError` if they are not specified. + * For :class:`~email.message.EmailMessage` objects, set the maintype + to ``message``, and set the subtype to *subtype* if it is + specified or ``rfc822`` if it is not. If *subtype* is + ``partial``, raise an error (``bytes`` objects must be used to + construct ``message/partial`` parts). + + If *charset* is provided (which is valid only for ``str``), encode the + string to bytes using the specified character set. The default is + ``utf-8``. If the specified *charset* is a known alias for a standard + MIME charset name, use the standard charset instead. + + If *cte* is set, encode the payload using the specified content transfer + encoding, and set the :mailheader:`Content-Transfer-Encoding` header to + that value. Possible values for *cte* are ``quoted-printable``, + ``base64``, ``7bit``, ``8bit``, and ``binary``. If the input cannot be + encoded in the specified encoding (for example, specifying a *cte* of + ``7bit`` for an input that contains non-ASCII values), raise a + :exc:`ValueError`. + + * For ``str`` objects, if *cte* is not set use heuristics to + determine the most compact encoding. + * For :class:`~email.message.EmailMessage`, per :rfc:`2046`, raise + an error if a *cte* of ``quoted-printable`` or ``base64`` is + requested for *subtype* ``rfc822``, and for any *cte* other than + ``7bit`` for *subtype* ``external-body``. For + ``message/rfc822``, use ``8bit`` if *cte* is not specified. For + all other values of *subtype*, use ``7bit``. + + .. note:: A *cte* of ``binary`` does not actually work correctly yet. + The ``EmailMessage`` object as modified by ``set_content`` is + correct, but :class:`~email.generator.BytesGenerator` does not + serialize it correctly. + + If *disposition* is set, use it as the value of the + :mailheader:`Content-Disposition` header. If not specified, and + *filename* is specified, add the header with the value ``attachment``. + If *disposition* is not specified and *filename* is also not specified, + do not add the header. The only valid values for *disposition* are + ``attachment`` and ``inline``. + + If *filename* is specified, use it as the value of the ``filename`` + parameter of the :mailheader:`Content-Disposition` header. + + If *cid* is specified, add a :mailheader:`Content-ID` header with + *cid* as its value. + + If *params* is specified, iterate its ``items`` method and use the + resulting ``(key, value)`` pairs to set additional parameters on the + :mailheader:`Content-Type` header. + + If *headers* is specified and is a list of strings of the form + ``headername: headervalue`` or a list of ``header`` objects + (distinguished from strings by having a ``name`` attribute), add the + headers to *msg*. + + +.. rubric:: Footnotes + +.. [1] Originally added in 3.4 as a :term:`provisional module ` diff --git a/python-3.7.4-docs-html/_sources/library/email.encoders.rst.txt b/python-3.7.4-docs-html/_sources/library/email.encoders.rst.txt new file mode 100644 index 0000000..debd1c8 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/email.encoders.rst.txt @@ -0,0 +1,75 @@ +:mod:`email.encoders`: Encoders +------------------------------- + +.. module:: email.encoders + :synopsis: Encoders for email message payloads. + +**Source code:** :source:`Lib/email/encoders.py` + +-------------- + +This module is part of the legacy (``Compat32``) email API. In the +new API the functionality is provided by the *cte* parameter of +the :meth:`~email.message.EmailMessage.set_content` method. + +This module is deprecated in Python 3. The functions provided here +should not be called explicitly since the :class:`~email.mime.text.MIMEText` +class sets the content type and CTE header using the *_subtype* and *_charset* +values passed during the instaniation of that class. + +The remaining text in this section is the original documentation of the module. + +When creating :class:`~email.message.Message` objects from scratch, you often +need to encode the payloads for transport through compliant mail servers. This +is especially true for :mimetype:`image/\*` and :mimetype:`text/\*` type messages +containing binary data. + +The :mod:`email` package provides some convenient encodings in its +:mod:`encoders` module. These encoders are actually used by the +:class:`~email.mime.audio.MIMEAudio` and :class:`~email.mime.image.MIMEImage` +class constructors to provide default encodings. All encoder functions take +exactly one argument, the message object to encode. They usually extract the +payload, encode it, and reset the payload to this newly encoded value. They +should also set the :mailheader:`Content-Transfer-Encoding` header as appropriate. + +Note that these functions are not meaningful for a multipart message. They +must be applied to individual subparts instead, and will raise a +:exc:`TypeError` if passed a message whose type is multipart. + +Here are the encoding functions provided: + + +.. function:: encode_quopri(msg) + + Encodes the payload into quoted-printable form and sets the + :mailheader:`Content-Transfer-Encoding` header to ``quoted-printable`` [#]_. + This is a good encoding to use when most of your payload is normal printable + data, but contains a few unprintable characters. + + +.. function:: encode_base64(msg) + + Encodes the payload into base64 form and sets the + :mailheader:`Content-Transfer-Encoding` header to ``base64``. This is a good + encoding to use when most of your payload is unprintable data since it is a more + compact form than quoted-printable. The drawback of base64 encoding is that it + renders the text non-human readable. + + +.. function:: encode_7or8bit(msg) + + This doesn't actually modify the message's payload, but it does set the + :mailheader:`Content-Transfer-Encoding` header to either ``7bit`` or ``8bit`` as + appropriate, based on the payload data. + + +.. function:: encode_noop(msg) + + This does nothing; it doesn't even set the + :mailheader:`Content-Transfer-Encoding` header. + +.. rubric:: Footnotes + +.. [#] Note that encoding with :meth:`encode_quopri` also encodes all tabs and space + characters in the data. + diff --git a/python-3.7.4-docs-html/_sources/library/email.errors.rst.txt b/python-3.7.4-docs-html/_sources/library/email.errors.rst.txt new file mode 100644 index 0000000..511ad16 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/email.errors.rst.txt @@ -0,0 +1,114 @@ +:mod:`email.errors`: Exception and Defect classes +------------------------------------------------- + +.. module:: email.errors + :synopsis: The exception classes used by the email package. + +**Source code:** :source:`Lib/email/errors.py` + +-------------- + +The following exception classes are defined in the :mod:`email.errors` module: + + +.. exception:: MessageError() + + This is the base class for all exceptions that the :mod:`email` package can + raise. It is derived from the standard :exc:`Exception` class and defines no + additional methods. + + +.. exception:: MessageParseError() + + This is the base class for exceptions raised by the + :class:`~email.parser.Parser` class. It is derived from + :exc:`MessageError`. This class is also used internally by the parser used + by :mod:`~email.headerregistry`. + + +.. exception:: HeaderParseError() + + Raised under some error conditions when parsing the :rfc:`5322` headers of a + message, this class is derived from :exc:`MessageParseError`. The + :meth:`~email.message.EmailMessage.set_boundary` method will raise this + error if the content type is unknown when the method is called. + :class:`~email.header.Header` may raise this error for certain base64 + decoding errors, and when an attempt is made to create a header that appears + to contain an embedded header (that is, there is what is supposed to be a + continuation line that has no leading whitespace and looks like a header). + + +.. exception:: BoundaryError() + + Deprecated and no longer used. + + +.. exception:: MultipartConversionError() + + Raised when a payload is added to a :class:`~email.message.Message` object + using :meth:`add_payload`, but the payload is already a scalar and the + message's :mailheader:`Content-Type` main type is not either + :mimetype:`multipart` or missing. :exc:`MultipartConversionError` multiply + inherits from :exc:`MessageError` and the built-in :exc:`TypeError`. + + Since :meth:`Message.add_payload` is deprecated, this exception is rarely + raised in practice. However the exception may also be raised if the + :meth:`~email.message.Message.attach` + method is called on an instance of a class derived from + :class:`~email.mime.nonmultipart.MIMENonMultipart` (e.g. + :class:`~email.mime.image.MIMEImage`). + + +Here is the list of the defects that the :class:`~email.parser.FeedParser` +can find while parsing messages. Note that the defects are added to the message +where the problem was found, so for example, if a message nested inside a +:mimetype:`multipart/alternative` had a malformed header, that nested message +object would have a defect, but the containing messages would not. + +All defect classes are subclassed from :class:`email.errors.MessageDefect`. + +* :class:`NoBoundaryInMultipartDefect` -- A message claimed to be a multipart, + but had no :mimetype:`boundary` parameter. + +* :class:`StartBoundaryNotFoundDefect` -- The start boundary claimed in the + :mailheader:`Content-Type` header was never found. + +* :class:`CloseBoundaryNotFoundDefect` -- A start boundary was found, but + no corresponding close boundary was ever found. + + .. versionadded:: 3.3 + +* :class:`FirstHeaderLineIsContinuationDefect` -- The message had a continuation + line as its first header line. + +* :class:`MisplacedEnvelopeHeaderDefect` - A "Unix From" header was found in the + middle of a header block. + +* :class:`MissingHeaderBodySeparatorDefect` - A line was found while parsing + headers that had no leading white space but contained no ':'. Parsing + continues assuming that the line represents the first line of the body. + + .. versionadded:: 3.3 + +* :class:`MalformedHeaderDefect` -- A header was found that was missing a colon, + or was otherwise malformed. + + .. deprecated:: 3.3 + This defect has not been used for several Python versions. + +* :class:`MultipartInvariantViolationDefect` -- A message claimed to be a + :mimetype:`multipart`, but no subparts were found. Note that when a message + has this defect, its :meth:`~email.message.Message.is_multipart` method may + return false even though its content type claims to be :mimetype:`multipart`. + +* :class:`InvalidBase64PaddingDefect` -- When decoding a block of base64 + encoded bytes, the padding was not correct. Enough padding is added to + perform the decode, but the resulting decoded bytes may be invalid. + +* :class:`InvalidBase64CharactersDefect` -- When decoding a block of base64 + encoded bytes, characters outside the base64 alphabet were encountered. + The characters are ignored, but the resulting decoded bytes may be invalid. + +* :class:`InvalidBase64LengthDefect` -- When decoding a block of base64 encoded + bytes, the number of non-padding base64 characters was invalid (1 more than + a multiple of 4). The encoded block was kept as-is. diff --git a/python-3.7.4-docs-html/_sources/library/email.examples.rst.txt b/python-3.7.4-docs-html/_sources/library/email.examples.rst.txt new file mode 100644 index 0000000..fc96462 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/email.examples.rst.txt @@ -0,0 +1,67 @@ +.. _email-examples: + +:mod:`email`: Examples +---------------------- + +Here are a few examples of how to use the :mod:`email` package to read, write, +and send simple email messages, as well as more complex MIME messages. + +First, let's see how to create and send a simple text message (both the +text content and the addresses may contain unicode characters): + +.. literalinclude:: ../includes/email-simple.py + + +Parsing :rfc:`822` headers can easily be done by the using the classes +from the :mod:`~email.parser` module: + +.. literalinclude:: ../includes/email-headers.py + + +Here's an example of how to send a MIME message containing a bunch of family +pictures that may be residing in a directory: + +.. literalinclude:: ../includes/email-mime.py + + +Here's an example of how to send the entire contents of a directory as an email +message: [1]_ + +.. literalinclude:: ../includes/email-dir.py + + +Here's an example of how to unpack a MIME message like the one +above, into a directory of files: + +.. literalinclude:: ../includes/email-unpack.py + + +Here's an example of how to create an HTML message with an alternative plain +text version. To make things a bit more interesting, we include a related +image in the html part, and we save a copy of what we are going to send to +disk, as well as sending it. + +.. literalinclude:: ../includes/email-alternative.py + + +If we were sent the message from the last example, here is one way we could +process it: + +.. literalinclude:: ../includes/email-read-alternative.py + +Up to the prompt, the output from the above is: + +.. code-block:: none + + To: Penelope Pussycat , Fabrette Pussycat + From: Pepé Le Pew + Subject: Ayons asperges pour le déjeuner + + Salut! + + Cela ressemble à un excellent recipie[1] déjeuner. + + +.. rubric:: Footnotes + +.. [1] Thanks to Matthew Dixon Cowles for the original inspiration and examples. diff --git a/python-3.7.4-docs-html/_sources/library/email.generator.rst.txt b/python-3.7.4-docs-html/_sources/library/email.generator.rst.txt new file mode 100644 index 0000000..c825aa1 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/email.generator.rst.txt @@ -0,0 +1,279 @@ +:mod:`email.generator`: Generating MIME documents +------------------------------------------------- + +.. module:: email.generator + :synopsis: Generate flat text email messages from a message structure. + +**Source code:** :source:`Lib/email/generator.py` + +-------------- + +One of the most common tasks is to generate the flat (serialized) version of +the email message represented by a message object structure. You will need to +do this if you want to send your message via :meth:`smtplib.SMTP.sendmail` or +the :mod:`nntplib` module, or print the message on the console. Taking a +message object structure and producing a serialized representation is the job +of the generator classes. + +As with the :mod:`email.parser` module, you aren't limited to the functionality +of the bundled generator; you could write one from scratch yourself. However +the bundled generator knows how to generate most email in a standards-compliant +way, should handle MIME and non-MIME email messages just fine, and is designed +so that the bytes-oriented parsing and generation operations are inverses, +assuming the same non-transforming :mod:`~email.policy` is used for both. That +is, parsing the serialized byte stream via the +:class:`~email.parser.BytesParser` class and then regenerating the serialized +byte stream using :class:`BytesGenerator` should produce output identical to +the input [#]_. (On the other hand, using the generator on an +:class:`~email.message.EmailMessage` constructed by program may result in +changes to the :class:`~email.message.EmailMessage` object as defaults are +filled in.) + +The :class:`Generator` class can be used to flatten a message into a text (as +opposed to binary) serialized representation, but since Unicode cannot +represent binary data directly, the message is of necessity transformed into +something that contains only ASCII characters, using the standard email RFC +Content Transfer Encoding techniques for encoding email messages for transport +over channels that are not "8 bit clean". + + +.. class:: BytesGenerator(outfp, mangle_from_=None, maxheaderlen=None, *, \ + policy=None) + + Return a :class:`BytesGenerator` object that will write any message provided + to the :meth:`flatten` method, or any surrogateescape encoded text provided + to the :meth:`write` method, to the :term:`file-like object` *outfp*. + *outfp* must support a ``write`` method that accepts binary data. + + If optional *mangle_from_* is ``True``, put a ``>`` character in front of + any line in the body that starts with the exact string ``"From "``, that is + ``From`` followed by a space at the beginning of a line. *mangle_from_* + defaults to the value of the :attr:`~email.policy.Policy.mangle_from_` + setting of the *policy* (which is ``True`` for the + :data:`~email.policy.compat32` policy and ``False`` for all others). + *mangle_from_* is intended for use when messages are stored in unix mbox + format (see :mod:`mailbox` and `WHY THE CONTENT-LENGTH FORMAT IS BAD + `_). + + If *maxheaderlen* is not ``None``, refold any header lines that are longer + than *maxheaderlen*, or if ``0``, do not rewrap any headers. If + *manheaderlen* is ``None`` (the default), wrap headers and other message + lines according to the *policy* settings. + + If *policy* is specified, use that policy to control message generation. If + *policy* is ``None`` (the default), use the policy associated with the + :class:`~email.message.Message` or :class:`~email.message.EmailMessage` + object passed to ``flatten`` to control the message generation. See + :mod:`email.policy` for details on what *policy* controls. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.3 Added the *policy* keyword. + + .. versionchanged:: 3.6 The default behavior of the *mangle_from_* + and *maxheaderlen* parameters is to follow the policy. + + + .. method:: flatten(msg, unixfrom=False, linesep=None) + + Print the textual representation of the message object structure rooted + at *msg* to the output file specified when the :class:`BytesGenerator` + instance was created. + + If the :mod:`~email.policy` option :attr:`~email.policy.Policy.cte_type` + is ``8bit`` (the default), copy any headers in the original parsed + message that have not been modified to the output with any bytes with the + high bit set reproduced as in the original, and preserve the non-ASCII + :mailheader:`Content-Transfer-Encoding` of any body parts that have them. + If ``cte_type`` is ``7bit``, convert the bytes with the high bit set as + needed using an ASCII-compatible :mailheader:`Content-Transfer-Encoding`. + That is, transform parts with non-ASCII + :mailheader:`Content-Transfer-Encoding` + (:mailheader:`Content-Transfer-Encoding: 8bit`) to an ASCII compatible + :mailheader:`Content-Transfer-Encoding`, and encode RFC-invalid non-ASCII + bytes in headers using the MIME ``unknown-8bit`` character set, thus + rendering them RFC-compliant. + + .. XXX: There should be an option that just does the RFC + compliance transformation on headers but leaves CTE 8bit parts alone. + + If *unixfrom* is ``True``, print the envelope header delimiter used by + the Unix mailbox format (see :mod:`mailbox`) before the first of the + :rfc:`5322` headers of the root message object. If the root object has + no envelope header, craft a standard one. The default is ``False``. + Note that for subparts, no envelope header is ever printed. + + If *linesep* is not ``None``, use it as the separator character between + all the lines of the flattened message. If *linesep* is ``None`` (the + default), use the value specified in the *policy*. + + .. XXX: flatten should take a *policy* keyword. + + + .. method:: clone(fp) + + Return an independent clone of this :class:`BytesGenerator` instance with + the exact same option settings, and *fp* as the new *outfp*. + + + .. method:: write(s) + + Encode *s* using the ``ASCII`` codec and the ``surrogateescape`` error + handler, and pass it to the *write* method of the *outfp* passed to the + :class:`BytesGenerator`'s constructor. + + +As a convenience, :class:`~email.message.EmailMessage` provides the methods +:meth:`~email.message.EmailMessage.as_bytes` and ``bytes(aMessage)`` (a.k.a. +:meth:`~email.message.EmailMessage.__bytes__`), which simplify the generation of +a serialized binary representation of a message object. For more detail, see +:mod:`email.message`. + + +Because strings cannot represent binary data, the :class:`Generator` class must +convert any binary data in any message it flattens to an ASCII compatible +format, by converting them to an ASCII compatible +:mailheader:`Content-Transfer_Encoding`. Using the terminology of the email +RFCs, you can think of this as :class:`Generator` serializing to an I/O stream +that is not "8 bit clean". In other words, most applications will want +to be using :class:`BytesGenerator`, and not :class:`Generator`. + +.. class:: Generator(outfp, mangle_from_=None, maxheaderlen=None, *, \ + policy=None) + + Return a :class:`Generator` object that will write any message provided + to the :meth:`flatten` method, or any text provided to the :meth:`write` + method, to the :term:`file-like object` *outfp*. *outfp* must support a + ``write`` method that accepts string data. + + If optional *mangle_from_* is ``True``, put a ``>`` character in front of + any line in the body that starts with the exact string ``"From "``, that is + ``From`` followed by a space at the beginning of a line. *mangle_from_* + defaults to the value of the :attr:`~email.policy.Policy.mangle_from_` + setting of the *policy* (which is ``True`` for the + :data:`~email.policy.compat32` policy and ``False`` for all others). + *mangle_from_* is intended for use when messages are stored in unix mbox + format (see :mod:`mailbox` and `WHY THE CONTENT-LENGTH FORMAT IS BAD + `_). + + If *maxheaderlen* is not ``None``, refold any header lines that are longer + than *maxheaderlen*, or if ``0``, do not rewrap any headers. If + *manheaderlen* is ``None`` (the default), wrap headers and other message + lines according to the *policy* settings. + + If *policy* is specified, use that policy to control message generation. If + *policy* is ``None`` (the default), use the policy associated with the + :class:`~email.message.Message` or :class:`~email.message.EmailMessage` + object passed to ``flatten`` to control the message generation. See + :mod:`email.policy` for details on what *policy* controls. + + .. versionchanged:: 3.3 Added the *policy* keyword. + + .. versionchanged:: 3.6 The default behavior of the *mangle_from_* + and *maxheaderlen* parameters is to follow the policy. + + + .. method:: flatten(msg, unixfrom=False, linesep=None) + + Print the textual representation of the message object structure rooted + at *msg* to the output file specified when the :class:`Generator` + instance was created. + + If the :mod:`~email.policy` option :attr:`~email.policy.Policy.cte_type` + is ``8bit``, generate the message as if the option were set to ``7bit``. + (This is required because strings cannot represent non-ASCII bytes.) + Convert any bytes with the high bit set as needed using an + ASCII-compatible :mailheader:`Content-Transfer-Encoding`. That is, + transform parts with non-ASCII :mailheader:`Content-Transfer-Encoding` + (:mailheader:`Content-Transfer-Encoding: 8bit`) to an ASCII compatible + :mailheader:`Content-Transfer-Encoding`, and encode RFC-invalid non-ASCII + bytes in headers using the MIME ``unknown-8bit`` character set, thus + rendering them RFC-compliant. + + If *unixfrom* is ``True``, print the envelope header delimiter used by + the Unix mailbox format (see :mod:`mailbox`) before the first of the + :rfc:`5322` headers of the root message object. If the root object has + no envelope header, craft a standard one. The default is ``False``. + Note that for subparts, no envelope header is ever printed. + + If *linesep* is not ``None``, use it as the separator character between + all the lines of the flattened message. If *linesep* is ``None`` (the + default), use the value specified in the *policy*. + + .. XXX: flatten should take a *policy* keyword. + + .. versionchanged:: 3.2 + Added support for re-encoding ``8bit`` message bodies, and the + *linesep* argument. + + + .. method:: clone(fp) + + Return an independent clone of this :class:`Generator` instance with the + exact same options, and *fp* as the new *outfp*. + + + .. method:: write(s) + + Write *s* to the *write* method of the *outfp* passed to the + :class:`Generator`'s constructor. This provides just enough file-like + API for :class:`Generator` instances to be used in the :func:`print` + function. + + +As a convenience, :class:`~email.message.EmailMessage` provides the methods +:meth:`~email.message.EmailMessage.as_string` and ``str(aMessage)`` (a.k.a. +:meth:`~email.message.EmailMessage.__str__`), which simplify the generation of +a formatted string representation of a message object. For more detail, see +:mod:`email.message`. + + +The :mod:`email.generator` module also provides a derived class, +:class:`DecodedGenerator`, which is like the :class:`Generator` base class, +except that non-\ :mimetype:`text` parts are not serialized, but are instead +represented in the output stream by a string derived from a template filled +in with information about the part. + +.. class:: DecodedGenerator(outfp, mangle_from_=None, maxheaderlen=None, \ + fmt=None, *, policy=None) + + Act like :class:`Generator`, except that for any subpart of the message + passed to :meth:`Generator.flatten`, if the subpart is of main type + :mimetype:`text`, print the decoded payload of the subpart, and if the main + type is not :mimetype:`text`, instead of printing it fill in the string + *fmt* using information from the part and print the resulting + filled-in string. + + To fill in *fmt*, execute ``fmt % part_info``, where ``part_info`` + is a dictionary composed of the following keys and values: + + * ``type`` -- Full MIME type of the non-\ :mimetype:`text` part + + * ``maintype`` -- Main MIME type of the non-\ :mimetype:`text` part + + * ``subtype`` -- Sub-MIME type of the non-\ :mimetype:`text` part + + * ``filename`` -- Filename of the non-\ :mimetype:`text` part + + * ``description`` -- Description associated with the non-\ :mimetype:`text` part + + * ``encoding`` -- Content transfer encoding of the non-\ :mimetype:`text` part + + If *fmt* is ``None``, use the following default *fmt*: + + "[Non-text (%(type)s) part of message omitted, filename %(filename)s]" + + Optional *_mangle_from_* and *maxheaderlen* are as with the + :class:`Generator` base class. + + +.. rubric:: Footnotes + +.. [#] This statement assumes that you use the appropriate setting for + ``unixfrom``, and that there are no :mod:`policy` settings calling for + automatic adjustments (for example, + :attr:`~email.policy.Policy.refold_source` must be ``none``, which is + *not* the default). It is also not 100% true, since if the message + does not conform to the RFC standards occasionally information about the + exact original text is lost during parsing error recovery. It is a goal + to fix these latter edge cases when possible. diff --git a/python-3.7.4-docs-html/_sources/library/email.header.rst.txt b/python-3.7.4-docs-html/_sources/library/email.header.rst.txt new file mode 100644 index 0000000..07152c2 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/email.header.rst.txt @@ -0,0 +1,205 @@ +:mod:`email.header`: Internationalized headers +---------------------------------------------- + +.. module:: email.header + :synopsis: Representing non-ASCII headers + +**Source code:** :source:`Lib/email/header.py` + +-------------- + +This module is part of the legacy (``Compat32``) email API. In the current API +encoding and decoding of headers is handled transparently by the +dictionary-like API of the :class:`~email.message.EmailMessage` class. In +addition to uses in legacy code, this module can be useful in applications that +need to completely control the character sets used when encoding headers. + +The remaining text in this section is the original documentation of the module. + +:rfc:`2822` is the base standard that describes the format of email messages. +It derives from the older :rfc:`822` standard which came into widespread use at +a time when most email was composed of ASCII characters only. :rfc:`2822` is a +specification written assuming email contains only 7-bit ASCII characters. + +Of course, as email has been deployed worldwide, it has become +internationalized, such that language specific character sets can now be used in +email messages. The base standard still requires email messages to be +transferred using only 7-bit ASCII characters, so a slew of RFCs have been +written describing how to encode email containing non-ASCII characters into +:rfc:`2822`\ -compliant format. These RFCs include :rfc:`2045`, :rfc:`2046`, +:rfc:`2047`, and :rfc:`2231`. The :mod:`email` package supports these standards +in its :mod:`email.header` and :mod:`email.charset` modules. + +If you want to include non-ASCII characters in your email headers, say in the +:mailheader:`Subject` or :mailheader:`To` fields, you should use the +:class:`Header` class and assign the field in the :class:`~email.message.Message` +object to an instance of :class:`Header` instead of using a string for the header +value. Import the :class:`Header` class from the :mod:`email.header` module. +For example:: + + >>> from email.message import Message + >>> from email.header import Header + >>> msg = Message() + >>> h = Header('p\xf6stal', 'iso-8859-1') + >>> msg['Subject'] = h + >>> msg.as_string() + 'Subject: =?iso-8859-1?q?p=F6stal?=\n\n' + + + +Notice here how we wanted the :mailheader:`Subject` field to contain a non-ASCII +character? We did this by creating a :class:`Header` instance and passing in +the character set that the byte string was encoded in. When the subsequent +:class:`~email.message.Message` instance was flattened, the :mailheader:`Subject` +field was properly :rfc:`2047` encoded. MIME-aware mail readers would show this +header using the embedded ISO-8859-1 character. + +Here is the :class:`Header` class description: + + +.. class:: Header(s=None, charset=None, maxlinelen=None, header_name=None, continuation_ws=' ', errors='strict') + + Create a MIME-compliant header that can contain strings in different character + sets. + + Optional *s* is the initial header value. If ``None`` (the default), the + initial header value is not set. You can later append to the header with + :meth:`append` method calls. *s* may be an instance of :class:`bytes` or + :class:`str`, but see the :meth:`append` documentation for semantics. + + Optional *charset* serves two purposes: it has the same meaning as the *charset* + argument to the :meth:`append` method. It also sets the default character set + for all subsequent :meth:`append` calls that omit the *charset* argument. If + *charset* is not provided in the constructor (the default), the ``us-ascii`` + character set is used both as *s*'s initial charset and as the default for + subsequent :meth:`append` calls. + + The maximum line length can be specified explicitly via *maxlinelen*. For + splitting the first line to a shorter value (to account for the field header + which isn't included in *s*, e.g. :mailheader:`Subject`) pass in the name of the + field in *header_name*. The default *maxlinelen* is 76, and the default value + for *header_name* is ``None``, meaning it is not taken into account for the + first line of a long, split header. + + Optional *continuation_ws* must be :rfc:`2822`\ -compliant folding + whitespace, and is usually either a space or a hard tab character. This + character will be prepended to continuation lines. *continuation_ws* + defaults to a single space character. + + Optional *errors* is passed straight through to the :meth:`append` method. + + + .. method:: append(s, charset=None, errors='strict') + + Append the string *s* to the MIME header. + + Optional *charset*, if given, should be a :class:`~email.charset.Charset` + instance (see :mod:`email.charset`) or the name of a character set, which + will be converted to a :class:`~email.charset.Charset` instance. A value + of ``None`` (the default) means that the *charset* given in the constructor + is used. + + *s* may be an instance of :class:`bytes` or :class:`str`. If it is an + instance of :class:`bytes`, then *charset* is the encoding of that byte + string, and a :exc:`UnicodeError` will be raised if the string cannot be + decoded with that character set. + + If *s* is an instance of :class:`str`, then *charset* is a hint specifying + the character set of the characters in the string. + + In either case, when producing an :rfc:`2822`\ -compliant header using + :rfc:`2047` rules, the string will be encoded using the output codec of + the charset. If the string cannot be encoded using the output codec, a + UnicodeError will be raised. + + Optional *errors* is passed as the errors argument to the decode call + if *s* is a byte string. + + + .. method:: encode(splitchars=';, \\t', maxlinelen=None, linesep='\\n') + + Encode a message header into an RFC-compliant format, possibly wrapping + long lines and encapsulating non-ASCII parts in base64 or quoted-printable + encodings. + + Optional *splitchars* is a string containing characters which should be + given extra weight by the splitting algorithm during normal header + wrapping. This is in very rough support of :RFC:`2822`\'s 'higher level + syntactic breaks': split points preceded by a splitchar are preferred + during line splitting, with the characters preferred in the order in + which they appear in the string. Space and tab may be included in the + string to indicate whether preference should be given to one over the + other as a split point when other split chars do not appear in the line + being split. Splitchars does not affect :RFC:`2047` encoded lines. + + *maxlinelen*, if given, overrides the instance's value for the maximum + line length. + + *linesep* specifies the characters used to separate the lines of the + folded header. It defaults to the most useful value for Python + application code (``\n``), but ``\r\n`` can be specified in order + to produce headers with RFC-compliant line separators. + + .. versionchanged:: 3.2 + Added the *linesep* argument. + + + The :class:`Header` class also provides a number of methods to support + standard operators and built-in functions. + + .. method:: __str__() + + Returns an approximation of the :class:`Header` as a string, using an + unlimited line length. All pieces are converted to unicode using the + specified encoding and joined together appropriately. Any pieces with a + charset of ``'unknown-8bit'`` are decoded as ASCII using the ``'replace'`` + error handler. + + .. versionchanged:: 3.2 + Added handling for the ``'unknown-8bit'`` charset. + + + .. method:: __eq__(other) + + This method allows you to compare two :class:`Header` instances for + equality. + + + .. method:: __ne__(other) + + This method allows you to compare two :class:`Header` instances for + inequality. + +The :mod:`email.header` module also provides the following convenient functions. + + +.. function:: decode_header(header) + + Decode a message header value without converting the character set. The header + value is in *header*. + + This function returns a list of ``(decoded_string, charset)`` pairs containing + each of the decoded parts of the header. *charset* is ``None`` for non-encoded + parts of the header, otherwise a lower case string containing the name of the + character set specified in the encoded string. + + Here's an example:: + + >>> from email.header import decode_header + >>> decode_header('=?iso-8859-1?q?p=F6stal?=') + [(b'p\xf6stal', 'iso-8859-1')] + + +.. function:: make_header(decoded_seq, maxlinelen=None, header_name=None, continuation_ws=' ') + + Create a :class:`Header` instance from a sequence of pairs as returned by + :func:`decode_header`. + + :func:`decode_header` takes a header value string and returns a sequence of + pairs of the format ``(decoded_string, charset)`` where *charset* is the name of + the character set. + + This function takes one of those sequence of pairs and returns a + :class:`Header` instance. Optional *maxlinelen*, *header_name*, and + *continuation_ws* are as in the :class:`Header` constructor. + diff --git a/python-3.7.4-docs-html/_sources/library/email.headerregistry.rst.txt b/python-3.7.4-docs-html/_sources/library/email.headerregistry.rst.txt new file mode 100644 index 0000000..ce283c6 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/email.headerregistry.rst.txt @@ -0,0 +1,455 @@ +:mod:`email.headerregistry`: Custom Header Objects +-------------------------------------------------- + +.. module:: email.headerregistry + :synopsis: Automatic Parsing of headers based on the field name + +.. moduleauthor:: R. David Murray +.. sectionauthor:: R. David Murray + +**Source code:** :source:`Lib/email/headerregistry.py` + +-------------- + +.. versionadded:: 3.6 [1]_ + +Headers are represented by customized subclasses of :class:`str`. The +particular class used to represent a given header is determined by the +:attr:`~email.policy.EmailPolicy.header_factory` of the :mod:`~email.policy` in +effect when the headers are created. This section documents the particular +``header_factory`` implemented by the email package for handling :RFC:`5322` +compliant email messages, which not only provides customized header objects for +various header types, but also provides an extension mechanism for applications +to add their own custom header types. + +When using any of the policy objects derived from +:data:`~email.policy.EmailPolicy`, all headers are produced by +:class:`.HeaderRegistry` and have :class:`.BaseHeader` as their last base +class. Each header class has an additional base class that is determined by +the type of the header. For example, many headers have the class +:class:`.UnstructuredHeader` as their other base class. The specialized second +class for a header is determined by the name of the header, using a lookup +table stored in the :class:`.HeaderRegistry`. All of this is managed +transparently for the typical application program, but interfaces are provided +for modifying the default behavior for use by more complex applications. + +The sections below first document the header base classes and their attributes, +followed by the API for modifying the behavior of :class:`.HeaderRegistry`, and +finally the support classes used to represent the data parsed from structured +headers. + + +.. class:: BaseHeader(name, value) + + *name* and *value* are passed to ``BaseHeader`` from the + :attr:`~email.policy.EmailPolicy.header_factory` call. The string value of + any header object is the *value* fully decoded to unicode. + + This base class defines the following read-only properties: + + + .. attribute:: name + + The name of the header (the portion of the field before the ':'). This + is exactly the value passed in the + :attr:`~email.policy.EmailPolicy.header_factory` call for *name*; that + is, case is preserved. + + + .. attribute:: defects + + A tuple of :exc:`~email.errors.HeaderDefect` instances reporting any + RFC compliance problems found during parsing. The email package tries to + be complete about detecting compliance issues. See the :mod:`~email.errors` + module for a discussion of the types of defects that may be reported. + + + .. attribute:: max_count + + The maximum number of headers of this type that can have the same + ``name``. A value of ``None`` means unlimited. The ``BaseHeader`` value + for this attribute is ``None``; it is expected that specialized header + classes will override this value as needed. + + ``BaseHeader`` also provides the following method, which is called by the + email library code and should not in general be called by application + programs: + + .. method:: fold(*, policy) + + Return a string containing :attr:`~email.policy.Policy.linesep` + characters as required to correctly fold the header according to + *policy*. A :attr:`~email.policy.Policy.cte_type` of ``8bit`` will be + treated as if it were ``7bit``, since headers may not contain arbitrary + binary data. If :attr:`~email.policy.EmailPolicy.utf8` is ``False``, + non-ASCII data will be :rfc:`2047` encoded. + + + ``BaseHeader`` by itself cannot be used to create a header object. It + defines a protocol that each specialized header cooperates with in order to + produce the header object. Specifically, ``BaseHeader`` requires that + the specialized class provide a :func:`classmethod` named ``parse``. This + method is called as follows:: + + parse(string, kwds) + + ``kwds`` is a dictionary containing one pre-initialized key, ``defects``. + ``defects`` is an empty list. The parse method should append any detected + defects to this list. On return, the ``kwds`` dictionary *must* contain + values for at least the keys ``decoded`` and ``defects``. ``decoded`` + should be the string value for the header (that is, the header value fully + decoded to unicode). The parse method should assume that *string* may + contain content-transfer-encoded parts, but should correctly handle all valid + unicode characters as well so that it can parse un-encoded header values. + + ``BaseHeader``'s ``__new__`` then creates the header instance, and calls its + ``init`` method. The specialized class only needs to provide an ``init`` + method if it wishes to set additional attributes beyond those provided by + ``BaseHeader`` itself. Such an ``init`` method should look like this:: + + def init(self, *args, **kw): + self._myattr = kw.pop('myattr') + super().init(*args, **kw) + + That is, anything extra that the specialized class puts in to the ``kwds`` + dictionary should be removed and handled, and the remaining contents of + ``kw`` (and ``args``) passed to the ``BaseHeader`` ``init`` method. + + +.. class:: UnstructuredHeader + + An "unstructured" header is the default type of header in :rfc:`5322`. + Any header that does not have a specified syntax is treated as + unstructured. The classic example of an unstructured header is the + :mailheader:`Subject` header. + + In :rfc:`5322`, an unstructured header is a run of arbitrary text in the + ASCII character set. :rfc:`2047`, however, has an :rfc:`5322` compatible + mechanism for encoding non-ASCII text as ASCII characters within a header + value. When a *value* containing encoded words is passed to the + constructor, the ``UnstructuredHeader`` parser converts such encoded words + into unicode, following the :rfc:`2047` rules for unstructured text. The + parser uses heuristics to attempt to decode certain non-compliant encoded + words. Defects are registered in such cases, as well as defects for issues + such as invalid characters within the encoded words or the non-encoded text. + + This header type provides no additional attributes. + + +.. class:: DateHeader + + :rfc:`5322` specifies a very specific format for dates within email headers. + The ``DateHeader`` parser recognizes that date format, as well as + recognizing a number of variant forms that are sometimes found "in the + wild". + + This header type provides the following additional attributes: + + .. attribute:: datetime + + If the header value can be recognized as a valid date of one form or + another, this attribute will contain a :class:`~datetime.datetime` + instance representing that date. If the timezone of the input date is + specified as ``-0000`` (indicating it is in UTC but contains no + information about the source timezone), then :attr:`.datetime` will be a + naive :class:`~datetime.datetime`. If a specific timezone offset is + found (including `+0000`), then :attr:`.datetime` will contain an aware + ``datetime`` that uses :class:`datetime.timezone` to record the timezone + offset. + + The ``decoded`` value of the header is determined by formatting the + ``datetime`` according to the :rfc:`5322` rules; that is, it is set to:: + + email.utils.format_datetime(self.datetime) + + When creating a ``DateHeader``, *value* may be + :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) + + 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 + more useful is to use the :func:`~email.utils.localtime` function from the + :mod:`~email.utils` module:: + + msg['Date'] = utils.localtime() + + This example sets the date header to the current time and date using + the current timezone offset. + + +.. class:: AddressHeader + + Address headers are one of the most complex structured header types. + The ``AddressHeader`` class provides a generic interface to any address + header. + + This header type provides the following additional attributes: + + + .. attribute:: groups + + A tuple of :class:`.Group` objects encoding the + addresses and groups found in the header value. Addresses that are + not part of a group are represented in this list as single-address + ``Groups`` whose :attr:`~.Group.display_name` is ``None``. + + + .. attribute:: addresses + + A tuple of :class:`.Address` objects encoding all + of the individual addresses from the header value. If the header value + contains any groups, the individual addresses from the group are included + in the list at the point where the group occurs in the value (that is, + the list of addresses is "flattened" into a one dimensional list). + + The ``decoded`` value of the header will have all encoded words decoded to + unicode. :class:`~encodings.idna` encoded domain names are also decoded to + unicode. The ``decoded`` value is set by :attr:`~str.join`\ ing the + :class:`str` value of the elements of the ``groups`` attribute with ``', + '``. + + A list of :class:`.Address` and :class:`.Group` objects in any combination + may be used to set the value of an address header. ``Group`` objects whose + ``display_name`` is ``None`` will be interpreted as single addresses, which + allows an address list to be copied with groups intact by using the list + obtained from the ``groups`` attribute of the source header. + + +.. class:: SingleAddressHeader + + A subclass of :class:`.AddressHeader` that adds one + additional attribute: + + + .. attribute:: address + + The single address encoded by the header value. If the header value + actually contains more than one address (which would be a violation of + the RFC under the default :mod:`~email.policy`), accessing this attribute + will result in a :exc:`ValueError`. + + +Many of the above classes also have a ``Unique`` variant (for example, +``UniqueUnstructuredHeader``). The only difference is that in the ``Unique`` +variant, :attr:`~.BaseHeader.max_count` is set to 1. + + +.. class:: MIMEVersionHeader + + There is really only one valid value for the :mailheader:`MIME-Version` + header, and that is ``1.0``. For future proofing, this header class + supports other valid version numbers. If a version number has a valid value + per :rfc:`2045`, then the header object will have non-``None`` values for + the following attributes: + + .. attribute:: version + + The version number as a string, with any whitespace and/or comments + removed. + + .. attribute:: major + + The major version number as an integer + + .. attribute:: minor + + The minor version number as an integer + + +.. class:: ParameterizedMIMEHeader + + MIME headers all start with the prefix 'Content-'. Each specific header has + a certain value, described under the class for that header. Some can + also take a list of supplemental parameters, which have a common format. + This class serves as a base for all the MIME headers that take parameters. + + .. attribute:: params + + A dictionary mapping parameter names to parameter values. + + +.. class:: ContentTypeHeader + + A :class:`ParameterizedMIMEHeader` class that handles the + :mailheader:`Content-Type` header. + + .. attribute:: content_type + + The content type string, in the form ``maintype/subtype``. + + .. attribute:: maintype + + .. attribute:: subtype + + +.. class:: ContentDispositionHeader + + A :class:`ParameterizedMIMEHeader` class that handles the + :mailheader:`Content-Disposition` header. + + .. attribute:: content-disposition + + ``inline`` and ``attachment`` are the only valid values in common use. + + +.. class:: ContentTransferEncoding + + Handles the :mailheader:`Content-Transfer-Encoding` header. + + .. attribute:: cte + + Valid values are ``7bit``, ``8bit``, ``base64``, and + ``quoted-printable``. See :rfc:`2045` for more information. + + + +.. class:: HeaderRegistry(base_class=BaseHeader, \ + default_class=UnstructuredHeader, \ + use_default_map=True) + + This is the factory used by :class:`~email.policy.EmailPolicy` by default. + ``HeaderRegistry`` builds the class used to create a header instance + dynamically, using *base_class* and a specialized class retrieved from a + registry that it holds. When a given header name does not appear in the + registry, the class specified by *default_class* is used as the specialized + class. When *use_default_map* is ``True`` (the default), the standard + mapping of header names to classes is copied in to the registry during + initialization. *base_class* is always the last class in the generated + class's ``__bases__`` list. + + The default mappings are: + + :subject: UniqueUnstructuredHeader + :date: UniqueDateHeader + :resent-date: DateHeader + :orig-date: UniqueDateHeader + :sender: UniqueSingleAddressHeader + :resent-sender: SingleAddressHeader + :to: UniqueAddressHeader + :resent-to: AddressHeader + :cc: UniqueAddressHeader + :resent-cc: AddressHeader + :from: UniqueAddressHeader + :resent-from: AddressHeader + :reply-to: UniqueAddressHeader + + ``HeaderRegistry`` has the following methods: + + + .. method:: map_to_type(self, name, cls) + + *name* is the name of the header to be mapped. It will be converted to + lower case in the registry. *cls* is the specialized class to be used, + along with *base_class*, to create the class used to instantiate headers + that match *name*. + + + .. method:: __getitem__(name) + + Construct and return a class to handle creating a *name* header. + + + .. method:: __call__(name, value) + + Retrieves the specialized header associated with *name* from the + registry (using *default_class* if *name* does not appear in the + registry) and composes it with *base_class* to produce a class, + calls the constructed class's constructor, passing it the same + argument list, and finally returns the class instance created thereby. + + +The following classes are the classes used to represent data parsed from +structured headers and can, in general, be used by an application program to +construct structured values to assign to specific headers. + + +.. class:: Address(display_name='', username='', domain='', addr_spec=None) + + The class used to represent an email address. The general form of an + address is:: + + [display_name] + + or:: + + username@domain + + where each part must conform to specific syntax rules spelled out in + :rfc:`5322`. + + As a convenience *addr_spec* can be specified instead of *username* and + *domain*, in which case *username* and *domain* will be parsed from the + *addr_spec*. An *addr_spec* must be a properly RFC quoted string; if it is + not ``Address`` will raise an error. Unicode characters are allowed and + will be property encoded when serialized. However, per the RFCs, unicode is + *not* allowed in the username portion of the address. + + .. attribute:: display_name + + The display name portion of the address, if any, with all quoting + removed. If the address does not have a display name, this attribute + will be an empty string. + + .. attribute:: username + + The ``username`` portion of the address, with all quoting removed. + + .. attribute:: domain + + The ``domain`` portion of the address. + + .. attribute:: addr_spec + + The ``username@domain`` portion of the address, correctly quoted + for use as a bare address (the second form shown above). This + attribute is not mutable. + + .. method:: __str__() + + The ``str`` value of the object is the address quoted according to + :rfc:`5322` rules, but with no Content Transfer Encoding of any non-ASCII + characters. + + To support SMTP (:rfc:`5321`), ``Address`` handles one special case: if + ``username`` and ``domain`` are both the empty string (or ``None``), then + the string value of the ``Address`` is ``<>``. + + +.. class:: Group(display_name=None, addresses=None) + + The class used to represent an address group. The general form of an + address group is:: + + display_name: [address-list]; + + As a convenience for processing lists of addresses that consist of a mixture + of groups and single addresses, a ``Group`` may also be used to represent + single addresses that are not part of a group by setting *display_name* to + ``None`` and providing a list of the single address as *addresses*. + + .. attribute:: display_name + + The ``display_name`` of the group. If it is ``None`` and there is + exactly one ``Address`` in ``addresses``, then the ``Group`` represents a + single address that is not in a group. + + .. attribute:: addresses + + A possibly empty tuple of :class:`.Address` objects representing the + addresses in the group. + + .. method:: __str__() + + The ``str`` value of a ``Group`` is formatted according to :rfc:`5322`, + but with no Content Transfer Encoding of any non-ASCII characters. If + ``display_name`` is none and there is a single ``Address`` in the + ``addresses`` list, the ``str`` value will be the same as the ``str`` of + that single ``Address``. + + +.. rubric:: Footnotes + +.. [1] Originally added in 3.3 as a :term:`provisional module ` diff --git a/python-3.7.4-docs-html/_sources/library/email.iterators.rst.txt b/python-3.7.4-docs-html/_sources/library/email.iterators.rst.txt new file mode 100644 index 0000000..d53ab33 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/email.iterators.rst.txt @@ -0,0 +1,83 @@ +:mod:`email.iterators`: Iterators +--------------------------------- + +.. module:: email.iterators + :synopsis: Iterate over a message object tree. + +**Source code:** :source:`Lib/email/iterators.py` + +-------------- + +Iterating over a message object tree is fairly easy with the +:meth:`Message.walk ` method. The +:mod:`email.iterators` module provides some useful higher level iterations over +message object trees. + + +.. function:: body_line_iterator(msg, decode=False) + + This iterates over all the payloads in all the subparts of *msg*, returning the + string payloads line-by-line. It skips over all the subpart headers, and it + skips over any subpart with a payload that isn't a Python string. This is + somewhat equivalent to reading the flat text representation of the message from + a file using :meth:`~io.TextIOBase.readline`, skipping over all the + intervening headers. + + Optional *decode* is passed through to :meth:`Message.get_payload + `. + + +.. function:: typed_subpart_iterator(msg, maintype='text', subtype=None) + + This iterates over all the subparts of *msg*, returning only those subparts that + match the MIME type specified by *maintype* and *subtype*. + + Note that *subtype* is optional; if omitted, then subpart MIME type matching is + done only with the main type. *maintype* is optional too; it defaults to + :mimetype:`text`. + + Thus, by default :func:`typed_subpart_iterator` returns each subpart that has a + MIME type of :mimetype:`text/\*`. + + +The following function has been added as a useful debugging tool. It should +*not* be considered part of the supported public interface for the package. + +.. function:: _structure(msg, fp=None, level=0, include_default=False) + + Prints an indented representation of the content types of the message object + structure. For example: + + .. testsetup:: + + import email + from email.iterators import _structure + somefile = open('../Lib/test/test_email/data/msg_02.txt') + + .. doctest:: + + >>> msg = email.message_from_file(somefile) + >>> _structure(msg) + multipart/mixed + text/plain + text/plain + multipart/digest + message/rfc822 + text/plain + message/rfc822 + text/plain + message/rfc822 + text/plain + message/rfc822 + text/plain + message/rfc822 + text/plain + text/plain + + .. testcleanup:: + + somefile.close() + + Optional *fp* is a file-like object to print the output to. It must be + suitable for Python's :func:`print` function. *level* is used internally. + *include_default*, if true, prints the default type as well. diff --git a/python-3.7.4-docs-html/_sources/library/email.message.rst.txt b/python-3.7.4-docs-html/_sources/library/email.message.rst.txt new file mode 100644 index 0000000..77b8099 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/email.message.rst.txt @@ -0,0 +1,751 @@ +:mod:`email.message`: Representing an email message +--------------------------------------------------- + +.. module:: email.message + :synopsis: The base class representing email messages. +.. moduleauthor:: R. David Murray +.. sectionauthor:: R. David Murray , + Barry A. Warsaw + +**Source code:** :source:`Lib/email/message.py` + +-------------- + +.. versionadded:: 3.6 [1]_ + +The central class in the :mod:`email` package is the :class:`EmailMessage` +class, imported from the :mod:`email.message` module. It is the base class for +the :mod:`email` object model. :class:`EmailMessage` provides the core +functionality for setting and querying header fields, for accessing message +bodies, and for creating or modifying structured messages. + +An email message consists of *headers* and a *payload* (which is also referred +to as the *content*). Headers are :rfc:`5322` or :rfc:`6532` style field names +and values, where the field name and value are separated by a colon. The colon +is not part of either the field name or the field value. The payload may be a +simple text message, or a binary object, or a structured sequence of +sub-messages each with their own set of headers and their own payload. The +latter type of payload is indicated by the message having a MIME type such as +:mimetype:`multipart/\*` or :mimetype:`message/rfc822`. + +The conceptual model provided by an :class:`EmailMessage` object is that of an +ordered dictionary of headers coupled with a *payload* that represents the +:rfc:`5322` body of the message, which might be a list of sub-``EmailMessage`` +objects. In addition to the normal dictionary methods for accessing the header +names and values, there are methods for accessing specialized information from +the headers (for example the MIME content type), for operating on the payload, +for generating a serialized version of the message, and for recursively walking +over the object tree. + +The :class:`EmailMessage` dictionary-like interface is indexed by the header +names, which must be ASCII values. The values of the dictionary are strings +with some extra methods. Headers are stored and returned in case-preserving +form, but field names are matched case-insensitively. Unlike a real dict, +there is an ordering to the keys, and there can be duplicate keys. Additional +methods are provided for working with headers that have duplicate keys. + +The *payload* is either a string or bytes object, in the case of simple message +objects, or a list of :class:`EmailMessage` objects, for MIME container +documents such as :mimetype:`multipart/\*` and :mimetype:`message/rfc822` +message objects. + + +.. class:: EmailMessage(policy=default) + + If *policy* is specified use the rules it specifies to update and serialize + the representation of the message. If *policy* is not set, use the + :class:`~email.policy.default` policy, which follows the rules of the email + RFCs except for line endings (instead of the RFC mandated ``\r\n``, it uses + the Python standard ``\n`` line endings). For more information see the + :mod:`~email.policy` documentation. + + .. method:: as_string(unixfrom=False, maxheaderlen=None, policy=None) + + Return the entire message flattened as a string. When optional + *unixfrom* is true, the envelope header is included in the returned + string. *unixfrom* defaults to ``False``. For backward compatibility + with the base :class:`~email.message.Message` class *maxheaderlen* is + accepted, but defaults to ``None``, which means that by default the line + length is controlled by the + :attr:`~email.policy.EmailPolicy.max_line_length` of the policy. The + *policy* argument may be used to override the default policy obtained + from the message instance. This can be used to control some of the + formatting produced by the method, since the specified *policy* will be + passed to the :class:`~email.generator.Generator`. + + Flattening the message may trigger changes to the :class:`EmailMessage` + if defaults need to be filled in to complete the transformation to a + string (for example, MIME boundaries may be generated or modified). + + Note that this method is provided as a convenience and may not be the + most useful way to serialize messages in your application, especially if + you are dealing with multiple messages. See + :class:`email.generator.Generator` for a more flexible API for + serializing messages. Note also that this method is restricted to + producing messages serialized as "7 bit clean" when + :attr:`~email.policy.EmailPolicy.utf8` is ``False``, which is the default. + + .. versionchanged:: 3.6 the default behavior when *maxheaderlen* + is not specified was changed from defaulting to 0 to defaulting + to the value of *max_line_length* from the policy. + + + .. method:: __str__() + + Equivalent to ``as_string(policy=self.policy.clone(utf8=True))``. Allows + ``str(msg)`` to produce a string containing the serialized message in a + readable format. + + .. versionchanged:: 3.4 the method was changed to use ``utf8=True``, + thus producing an :rfc:`6531`-like message representation, instead of + being a direct alias for :meth:`as_string`. + + + .. method:: as_bytes(unixfrom=False, policy=None) + + Return the entire message flattened as a bytes object. When optional + *unixfrom* is true, the envelope header is included in the returned + string. *unixfrom* defaults to ``False``. The *policy* argument may be + used to override the default policy obtained from the message instance. + This can be used to control some of the formatting produced by the + method, since the specified *policy* will be passed to the + :class:`~email.generator.BytesGenerator`. + + Flattening the message may trigger changes to the :class:`EmailMessage` + if defaults need to be filled in to complete the transformation to a + string (for example, MIME boundaries may be generated or modified). + + Note that this method is provided as a convenience and may not be the + most useful way to serialize messages in your application, especially if + you are dealing with multiple messages. See + :class:`email.generator.BytesGenerator` for a more flexible API for + serializing messages. + + + .. method:: __bytes__() + + Equivalent to :meth:`.as_bytes()`. Allows ``bytes(msg)`` to produce a + bytes object containing the serialized message. + + + .. method:: is_multipart() + + Return ``True`` if the message's payload is a list of + sub-\ :class:`EmailMessage` objects, otherwise return ``False``. When + :meth:`is_multipart` returns ``False``, the payload should be a string + object (which might be a CTE encoded binary payload). Note that + :meth:`is_multipart` returning ``True`` does not necessarily mean that + "msg.get_content_maintype() == 'multipart'" will return the ``True``. + For example, ``is_multipart`` will return ``True`` when the + :class:`EmailMessage` is of type ``message/rfc822``. + + + .. method:: set_unixfrom(unixfrom) + + Set the message's envelope header to *unixfrom*, which should be a + string. (See :class:`~mailbox.mboxMessage` for a brief description of + this header.) + + + .. method:: get_unixfrom() + + Return the message's envelope header. Defaults to ``None`` if the + envelope header was never set. + + + The following methods implement the mapping-like interface for accessing the + message's headers. Note that there are some semantic differences + between these methods and a normal mapping (i.e. dictionary) interface. For + example, in a dictionary there are no duplicate keys, but here there may be + duplicate message headers. Also, in dictionaries there is no guaranteed + order to the keys returned by :meth:`keys`, but in an :class:`EmailMessage` + object, headers are always returned in the order they appeared in the + original message, or in which they were added to the message later. Any + header deleted and then re-added is always appended to the end of the + header list. + + These semantic differences are intentional and are biased toward + convenience in the most common use cases. + + Note that in all cases, any envelope header present in the message is not + included in the mapping interface. + + + .. method:: __len__() + + Return the total number of headers, including duplicates. + + + .. method:: __contains__(name) + + Return true if the message object has a field named *name*. Matching is + done without regard to case and *name* does not include the trailing + colon. Used for the ``in`` operator. For example:: + + if 'message-id' in myMessage: + print('Message-ID:', myMessage['message-id']) + + + .. method:: __getitem__(name) + + Return the value of the named header field. *name* does not include the + colon field separator. If the header is missing, ``None`` is returned; a + :exc:`KeyError` is never raised. + + Note that if the named field appears more than once in the message's + headers, exactly which of those field values will be returned is + undefined. Use the :meth:`get_all` method to get the values of all the + extant headers named *name*. + + Using the standard (non-``compat32``) policies, the returned value is an + instance of a subclass of :class:`email.headerregistry.BaseHeader`. + + + .. method:: __setitem__(name, val) + + Add a header to the message with field name *name* and value *val*. The + field is appended to the end of the message's existing headers. + + Note that this does *not* overwrite or delete any existing header with the same + name. If you want to ensure that the new header is the only one present in the + message with field name *name*, delete the field first, e.g.:: + + del msg['subject'] + msg['subject'] = 'Python roolz!' + + If the :mod:`policy` defines certain headers to be unique (as the standard + policies do), this method may raise a :exc:`ValueError` when an attempt + is made to assign a value to such a header when one already exists. This + behavior is intentional for consistency's sake, but do not depend on it + as we may choose to make such assignments do an automatic deletion of the + existing header in the future. + + + .. method:: __delitem__(name) + + Delete all occurrences of the field with name *name* from the message's + headers. No exception is raised if the named field isn't present in the + headers. + + + .. method:: keys() + + Return a list of all the message's header field names. + + + .. method:: values() + + Return a list of all the message's field values. + + + .. method:: items() + + Return a list of 2-tuples containing all the message's field headers and + values. + + + .. method:: get(name, failobj=None) + + Return the value of the named header field. This is identical to + :meth:`__getitem__` except that optional *failobj* is returned if the + named header is missing (*failobj* defaults to ``None``). + + + Here are some additional useful header related methods: + + + .. method:: get_all(name, failobj=None) + + Return a list of all the values for the field named *name*. If there are + no such named headers in the message, *failobj* is returned (defaults to + ``None``). + + + .. method:: add_header(_name, _value, **_params) + + Extended header setting. This method is similar to :meth:`__setitem__` + except that additional header parameters can be provided as keyword + arguments. *_name* is the header field to add and *_value* is the + *primary* value for the header. + + For each item in the keyword argument dictionary *_params*, the key is + taken as the parameter name, with underscores converted to dashes (since + dashes are illegal in Python identifiers). Normally, the parameter will + be added as ``key="value"`` unless the value is ``None``, in which case + only the key will be added. + + If the value contains non-ASCII characters, the charset and language may + be explicitly controlled by specifying the value as a three tuple in the + format ``(CHARSET, LANGUAGE, VALUE)``, where ``CHARSET`` is a string + naming the charset to be used to encode the value, ``LANGUAGE`` can + usually be set to ``None`` or the empty string (see :rfc:`2231` for other + possibilities), and ``VALUE`` is the string value containing non-ASCII + code points. If a three tuple is not passed and the value contains + non-ASCII characters, it is automatically encoded in :rfc:`2231` format + using a ``CHARSET`` of ``utf-8`` and a ``LANGUAGE`` of ``None``. + + Here is an example:: + + msg.add_header('Content-Disposition', 'attachment', filename='bud.gif') + + This will add a header that looks like :: + + Content-Disposition: attachment; filename="bud.gif" + + An example of the extended interface with non-ASCII characters:: + + msg.add_header('Content-Disposition', 'attachment', + filename=('iso-8859-1', '', 'Fußballer.ppt')) + + + .. method:: replace_header(_name, _value) + + Replace a header. Replace the first header found in the message that + matches *_name*, retaining header order and field name case of the + original header. If no matching header is found, raise a + :exc:`KeyError`. + + + .. method:: get_content_type() + + Return the message's content type, coerced to lower case of the form + :mimetype:`maintype/subtype`. If there is no :mailheader:`Content-Type` + header in the message return the value returned by + :meth:`get_default_type`. If the :mailheader:`Content-Type` header is + invalid, return ``text/plain``. + + (According to :rfc:`2045`, messages always have a default type, + :meth:`get_content_type` will always return a value. :rfc:`2045` defines + a message's default type to be :mimetype:`text/plain` unless it appears + inside a :mimetype:`multipart/digest` container, in which case it would + be :mimetype:`message/rfc822`. If the :mailheader:`Content-Type` header + has an invalid type specification, :rfc:`2045` mandates that the default + type be :mimetype:`text/plain`.) + + + .. method:: get_content_maintype() + + Return the message's main content type. This is the :mimetype:`maintype` + part of the string returned by :meth:`get_content_type`. + + + .. method:: get_content_subtype() + + Return the message's sub-content type. This is the :mimetype:`subtype` + part of the string returned by :meth:`get_content_type`. + + + .. method:: get_default_type() + + Return the default content type. Most messages have a default content + type of :mimetype:`text/plain`, except for messages that are subparts of + :mimetype:`multipart/digest` containers. Such subparts have a default + content type of :mimetype:`message/rfc822`. + + + .. method:: set_default_type(ctype) + + Set the default content type. *ctype* should either be + :mimetype:`text/plain` or :mimetype:`message/rfc822`, although this is + not enforced. The default content type is not stored in the + :mailheader:`Content-Type` header, so it only affects the return value of + the ``get_content_type`` methods when no :mailheader:`Content-Type` + header is present in the message. + + + .. method:: set_param(param, value, header='Content-Type', requote=True, \ + charset=None, language='', replace=False) + + Set a parameter in the :mailheader:`Content-Type` header. If the + parameter already exists in the header, replace its value with *value*. + When *header* is ``Content-Type`` (the default) and the header does not + yet exist in the message, add it, set its value to + :mimetype:`text/plain`, and append the new parameter value. Optional + *header* specifies an alternative header to :mailheader:`Content-Type`. + + If the value contains non-ASCII characters, the charset and language may + be explicitly specified using the optional *charset* and *language* + parameters. Optional *language* specifies the :rfc:`2231` language, + defaulting to the empty string. Both *charset* and *language* should be + strings. The default is to use the ``utf8`` *charset* and ``None`` for + the *language*. + + If *replace* is ``False`` (the default) the header is moved to the + end of the list of headers. If *replace* is ``True``, the header + will be updated in place. + + Use of the *requote* parameter with :class:`EmailMessage` objects is + deprecated. + + Note that existing parameter values of headers may be accessed through + the :attr:`~email.headerregistry.BaseHeader.params` attribute of the + header value (for example, ``msg['Content-Type'].params['charset']``). + + .. versionchanged:: 3.4 ``replace`` keyword was added. + + + .. method:: del_param(param, header='content-type', requote=True) + + Remove the given parameter completely from the :mailheader:`Content-Type` + header. The header will be re-written in place without the parameter or + its value. Optional *header* specifies an alternative to + :mailheader:`Content-Type`. + + Use of the *requote* parameter with :class:`EmailMessage` objects is + deprecated. + + + .. method:: get_filename(failobj=None) + + Return the value of the ``filename`` parameter of the + :mailheader:`Content-Disposition` header of the message. If the header + does not have a ``filename`` parameter, this method falls back to looking + for the ``name`` parameter on the :mailheader:`Content-Type` header. If + neither is found, or the header is missing, then *failobj* is returned. + The returned string will always be unquoted as per + :func:`email.utils.unquote`. + + + .. method:: get_boundary(failobj=None) + + Return the value of the ``boundary`` parameter of the + :mailheader:`Content-Type` header of the message, or *failobj* if either + the header is missing, or has no ``boundary`` parameter. The returned + string will always be unquoted as per :func:`email.utils.unquote`. + + + .. method:: set_boundary(boundary) + + Set the ``boundary`` parameter of the :mailheader:`Content-Type` header to + *boundary*. :meth:`set_boundary` will always quote *boundary* if + necessary. A :exc:`~email.errors.HeaderParseError` is raised if the + message object has no :mailheader:`Content-Type` header. + + Note that using this method is subtly different from deleting the old + :mailheader:`Content-Type` header and adding a new one with the new + boundary via :meth:`add_header`, because :meth:`set_boundary` preserves + the order of the :mailheader:`Content-Type` header in the list of + headers. + + + .. method:: get_content_charset(failobj=None) + + Return the ``charset`` parameter of the :mailheader:`Content-Type` header, + coerced to lower case. If there is no :mailheader:`Content-Type` header, or if + that header has no ``charset`` parameter, *failobj* is returned. + + + .. method:: get_charsets(failobj=None) + + Return a list containing the character set names in the message. If the + message is a :mimetype:`multipart`, then the list will contain one element + for each subpart in the payload, otherwise, it will be a list of length 1. + + Each item in the list will be a string which is the value of the + ``charset`` parameter in the :mailheader:`Content-Type` header for the + represented subpart. If the subpart has no :mailheader:`Content-Type` + header, no ``charset`` parameter, or is not of the :mimetype:`text` main + MIME type, then that item in the returned list will be *failobj*. + + + .. method:: is_attachment + + Return ``True`` if there is a :mailheader:`Content-Disposition` header + and its (case insensitive) value is ``attachment``, ``False`` otherwise. + + .. versionchanged:: 3.4.2 + is_attachment is now a method instead of a property, for consistency + with :meth:`~email.message.Message.is_multipart`. + + + .. method:: get_content_disposition() + + Return the lowercased value (without parameters) of the message's + :mailheader:`Content-Disposition` header if it has one, or ``None``. The + possible values for this method are *inline*, *attachment* or ``None`` + if the message follows :rfc:`2183`. + + .. versionadded:: 3.5 + + + The following methods relate to interrogating and manipulating the content + (payload) of the message. + + + .. method:: walk() + + The :meth:`walk` method is an all-purpose generator which can be used to + iterate over all the parts and subparts of a message object tree, in + depth-first traversal order. You will typically use :meth:`walk` as the + iterator in a ``for`` loop; each iteration returns the next subpart. + + Here's an example that prints the MIME type of every part of a multipart + message structure: + + .. testsetup:: + + from email import message_from_binary_file + with open('../Lib/test/test_email/data/msg_16.txt', 'rb') as f: + msg = message_from_binary_file(f) + from email.iterators import _structure + + .. doctest:: + + >>> for part in msg.walk(): + ... print(part.get_content_type()) + multipart/report + text/plain + message/delivery-status + text/plain + text/plain + message/rfc822 + text/plain + + ``walk`` iterates over the subparts of any part where + :meth:`is_multipart` returns ``True``, even though + ``msg.get_content_maintype() == 'multipart'`` may return ``False``. We + can see this in our example by making use of the ``_structure`` debug + helper function: + + .. doctest:: + + >>> for part in msg.walk(): + ... print(part.get_content_maintype() == 'multipart', + ... part.is_multipart()) + True True + False False + False True + False False + False False + False True + False False + >>> _structure(msg) + multipart/report + text/plain + message/delivery-status + text/plain + text/plain + message/rfc822 + text/plain + + Here the ``message`` parts are not ``multiparts``, but they do contain + subparts. ``is_multipart()`` returns ``True`` and ``walk`` descends + into the subparts. + + + .. method:: get_body(preferencelist=('related', 'html', 'plain')) + + Return the MIME part that is the best candidate to be the "body" of the + message. + + *preferencelist* must be a sequence of strings from the set ``related``, + ``html``, and ``plain``, and indicates the order of preference for the + content type of the part returned. + + Start looking for candidate matches with the object on which the + ``get_body`` method is called. + + If ``related`` is not included in *preferencelist*, consider the root + part (or subpart of the root part) of any related encountered as a + candidate if the (sub-)part matches a preference. + + When encountering a ``multipart/related``, check the ``start`` parameter + and if a part with a matching :mailheader:`Content-ID` is found, consider + only it when looking for candidate matches. Otherwise consider only the + first (default root) part of the ``multipart/related``. + + If a part has a :mailheader:`Content-Disposition` header, only consider + the part a candidate match if the value of the header is ``inline``. + + If none of the candidates matches any of the preferences in + *preferencelist*, return ``None``. + + Notes: (1) For most applications the only *preferencelist* combinations + that really make sense are ``('plain',)``, ``('html', 'plain')``, and the + default ``('related', 'html', 'plain')``. (2) Because matching starts + with the object on which ``get_body`` is called, calling ``get_body`` on + a ``multipart/related`` will return the object itself unless + *preferencelist* has a non-default value. (3) Messages (or message parts) + that do not specify a :mailheader:`Content-Type` or whose + :mailheader:`Content-Type` header is invalid will be treated as if they + are of type ``text/plain``, which may occasionally cause ``get_body`` to + return unexpected results. + + + .. method:: iter_attachments() + + Return an iterator over all of the immediate sub-parts of the message + that are not candidate "body" parts. That is, skip the first occurrence + of each of ``text/plain``, ``text/html``, ``multipart/related``, or + ``multipart/alternative`` (unless they are explicitly marked as + attachments via :mailheader:`Content-Disposition: attachment`), and + return all remaining parts. When applied directly to a + ``multipart/related``, return an iterator over the all the related parts + except the root part (ie: the part pointed to by the ``start`` parameter, + or the first part if there is no ``start`` parameter or the ``start`` + parameter doesn't match the :mailheader:`Content-ID` of any of the + parts). When applied directly to a ``multipart/alternative`` or a + non-``multipart``, return an empty iterator. + + + .. method:: iter_parts() + + Return an iterator over all of the immediate sub-parts of the message, + which will be empty for a non-``multipart``. (See also + :meth:`~email.message.EmailMessage.walk`.) + + + .. method:: get_content(*args, content_manager=None, **kw) + + Call the :meth:`~email.contentmanager.ContentManager.get_content` method + of the *content_manager*, passing self as the message object, and passing + along any other arguments or keywords as additional arguments. If + *content_manager* is not specified, use the ``content_manager`` specified + by the current :mod:`~email.policy`. + + + .. method:: set_content(*args, content_manager=None, **kw) + + Call the :meth:`~email.contentmanager.ContentManager.set_content` method + of the *content_manager*, passing self as the message object, and passing + along any other arguments or keywords as additional arguments. If + *content_manager* is not specified, use the ``content_manager`` specified + by the current :mod:`~email.policy`. + + + .. method:: make_related(boundary=None) + + Convert a non-``multipart`` message into a ``multipart/related`` message, + moving any existing :mailheader:`Content-` headers and payload into a + (new) first part of the ``multipart``. If *boundary* is specified, use + it as the boundary string in the multipart, otherwise leave the boundary + to be automatically created when it is needed (for example, when the + message is serialized). + + + .. method:: make_alternative(boundary=None) + + Convert a non-``multipart`` or a ``multipart/related`` into a + ``multipart/alternative``, moving any existing :mailheader:`Content-` + headers and payload into a (new) first part of the ``multipart``. If + *boundary* is specified, use it as the boundary string in the multipart, + otherwise leave the boundary to be automatically created when it is + needed (for example, when the message is serialized). + + + .. method:: make_mixed(boundary=None) + + Convert a non-``multipart``, a ``multipart/related``, or a + ``multipart-alternative`` into a ``multipart/mixed``, moving any existing + :mailheader:`Content-` headers and payload into a (new) first part of the + ``multipart``. If *boundary* is specified, use it as the boundary string + in the multipart, otherwise leave the boundary to be automatically + created when it is needed (for example, when the message is serialized). + + + .. method:: add_related(*args, content_manager=None, **kw) + + If the message is a ``multipart/related``, create a new message + object, pass all of the arguments to its :meth:`set_content` method, + and :meth:`~email.message.Message.attach` it to the ``multipart``. If + the message is a non-``multipart``, call :meth:`make_related` and then + proceed as above. If the message is any other type of ``multipart``, + raise a :exc:`TypeError`. If *content_manager* is not specified, use + the ``content_manager`` specified by the current :mod:`~email.policy`. + If the added part has no :mailheader:`Content-Disposition` header, + add one with the value ``inline``. + + + .. method:: add_alternative(*args, content_manager=None, **kw) + + If the message is a ``multipart/alternative``, create a new message + object, pass all of the arguments to its :meth:`set_content` method, and + :meth:`~email.message.Message.attach` it to the ``multipart``. If the + message is a non-``multipart`` or ``multipart/related``, call + :meth:`make_alternative` and then proceed as above. If the message is + any other type of ``multipart``, raise a :exc:`TypeError`. If + *content_manager* is not specified, use the ``content_manager`` specified + by the current :mod:`~email.policy`. + + + .. method:: add_attachment(*args, content_manager=None, **kw) + + If the message is a ``multipart/mixed``, create a new message object, + pass all of the arguments to its :meth:`set_content` method, and + :meth:`~email.message.Message.attach` it to the ``multipart``. If the + message is a non-``multipart``, ``multipart/related``, or + ``multipart/alternative``, call :meth:`make_mixed` and then proceed as + above. If *content_manager* is not specified, use the ``content_manager`` + specified by the current :mod:`~email.policy`. If the added part + has no :mailheader:`Content-Disposition` header, add one with the value + ``attachment``. This method can be used both for explicit attachments + (:mailheader:`Content-Disposition: attachment`) and ``inline`` attachments + (:mailheader:`Content-Disposition: inline`), by passing appropriate + options to the ``content_manager``. + + + .. method:: clear() + + Remove the payload and all of the headers. + + + .. method:: clear_content() + + Remove the payload and all of the :exc:`Content-` headers, leaving + all other headers intact and in their original order. + + + :class:`EmailMessage` objects have the following instance attributes: + + + .. attribute:: preamble + + The format of a MIME document allows for some text between the blank line + following the headers, and the first multipart boundary string. Normally, + this text is never visible in a MIME-aware mail reader because it falls + outside the standard MIME armor. However, when viewing the raw text of + the message, or when viewing the message in a non-MIME aware reader, this + text can become visible. + + The *preamble* attribute contains this leading extra-armor text for MIME + documents. When the :class:`~email.parser.Parser` discovers some text + after the headers but before the first boundary string, it assigns this + text to the message's *preamble* attribute. When the + :class:`~email.generator.Generator` is writing out the plain text + representation of a MIME message, and it finds the + message has a *preamble* attribute, it will write this text in the area + between the headers and the first boundary. See :mod:`email.parser` and + :mod:`email.generator` for details. + + Note that if the message object has no preamble, the *preamble* attribute + will be ``None``. + + + .. attribute:: epilogue + + The *epilogue* attribute acts the same way as the *preamble* attribute, + except that it contains text that appears between the last boundary and + the end of the message. As with the :attr:`~EmailMessage.preamble`, + if there is no epilog text this attribute will be ``None``. + + + .. attribute:: defects + + The *defects* attribute contains a list of all the problems found when + parsing this message. See :mod:`email.errors` for a detailed description + of the possible parsing defects. + + +.. class:: MIMEPart(policy=default) + + This class represents a subpart of a MIME message. It is identical to + :class:`EmailMessage`, except that no :mailheader:`MIME-Version` headers are + added when :meth:`~EmailMessage.set_content` is called, since sub-parts do + not need their own :mailheader:`MIME-Version` headers. + + +.. rubric:: Footnotes + +.. [1] Originally added in 3.4 as a :term:`provisional module `. Docs for legacy message class moved to + :ref:`compat32_message`. diff --git a/python-3.7.4-docs-html/_sources/library/email.mime.rst.txt b/python-3.7.4-docs-html/_sources/library/email.mime.rst.txt new file mode 100644 index 0000000..f37f6aa --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/email.mime.rst.txt @@ -0,0 +1,259 @@ +:mod:`email.mime`: Creating email and MIME objects from scratch +--------------------------------------------------------------- + +.. module:: email.mime + :synopsis: Build MIME messages. + +**Source code:** :source:`Lib/email/mime/` + +-------------- + +This module is part of the legacy (``Compat32``) email API. Its functionality +is partially replaced by the :mod:`~email.contentmanager` in the new API, but +in certain applications these classes may still be useful, even in non-legacy +code. + +Ordinarily, you get a message object structure by passing a file or some text to +a parser, which parses the text and returns the root message object. However +you can also build a complete message structure from scratch, or even individual +:class:`~email.message.Message` objects by hand. In fact, you can also take an +existing structure and add new :class:`~email.message.Message` objects, move them +around, etc. This makes a very convenient interface for slicing-and-dicing MIME +messages. + +You can create a new object structure by creating :class:`~email.message.Message` +instances, adding attachments and all the appropriate headers manually. For MIME +messages though, the :mod:`email` package provides some convenient subclasses to +make things easier. + +Here are the classes: + +.. currentmodule:: email.mime.base + +.. class:: MIMEBase(_maintype, _subtype, *, policy=compat32, **_params) + + Module: :mod:`email.mime.base` + + This is the base class for all the MIME-specific subclasses of + :class:`~email.message.Message`. Ordinarily you won't create instances + specifically of :class:`MIMEBase`, although you could. :class:`MIMEBase` + is provided primarily as a convenient base class for more specific + MIME-aware subclasses. + + *_maintype* is the :mailheader:`Content-Type` major type (e.g. :mimetype:`text` + or :mimetype:`image`), and *_subtype* is the :mailheader:`Content-Type` minor + type (e.g. :mimetype:`plain` or :mimetype:`gif`). *_params* is a parameter + key/value dictionary and is passed directly to :meth:`Message.add_header + `. + + If *policy* is specified, (defaults to the + :class:`compat32 ` policy) it will be passed to + :class:`~email.message.Message`. + + The :class:`MIMEBase` class always adds a :mailheader:`Content-Type` header + (based on *_maintype*, *_subtype*, and *_params*), and a + :mailheader:`MIME-Version` header (always set to ``1.0``). + + .. versionchanged:: 3.6 + Added *policy* keyword-only parameter. + + +.. currentmodule:: email.mime.nonmultipart + +.. class:: MIMENonMultipart() + + Module: :mod:`email.mime.nonmultipart` + + A subclass of :class:`~email.mime.base.MIMEBase`, this is an intermediate base + class for MIME messages that are not :mimetype:`multipart`. The primary + purpose of this class is to prevent the use of the + :meth:`~email.message.Message.attach` method, which only makes sense for + :mimetype:`multipart` messages. If :meth:`~email.message.Message.attach` + is called, a :exc:`~email.errors.MultipartConversionError` exception is raised. + + +.. currentmodule:: email.mime.multipart + +.. class:: MIMEMultipart(_subtype='mixed', boundary=None, _subparts=None, \ + *, policy=compat32, **_params) + + Module: :mod:`email.mime.multipart` + + A subclass of :class:`~email.mime.base.MIMEBase`, this is an intermediate base + class for MIME messages that are :mimetype:`multipart`. Optional *_subtype* + defaults to :mimetype:`mixed`, but can be used to specify the subtype of the + message. A :mailheader:`Content-Type` header of :mimetype:`multipart/_subtype` + will be added to the message object. A :mailheader:`MIME-Version` header will + also be added. + + Optional *boundary* is the multipart boundary string. When ``None`` (the + default), the boundary is calculated when needed (for example, when the + message is serialized). + + *_subparts* is a sequence of initial subparts for the payload. It must be + possible to convert this sequence to a list. You can always attach new subparts + to the message by using the :meth:`Message.attach + ` method. + + Optional *policy* argument defaults to :class:`compat32 `. + + Additional parameters for the :mailheader:`Content-Type` header are taken from + the keyword arguments, or passed into the *_params* argument, which is a keyword + dictionary. + + .. versionchanged:: 3.6 + Added *policy* keyword-only parameter. + +.. currentmodule:: email.mime.application + +.. class:: MIMEApplication(_data, _subtype='octet-stream', \ + _encoder=email.encoders.encode_base64, \ + *, policy=compat32, **_params) + + Module: :mod:`email.mime.application` + + A subclass of :class:`~email.mime.nonmultipart.MIMENonMultipart`, the + :class:`MIMEApplication` class is used to represent MIME message objects of + major type :mimetype:`application`. *_data* is a string containing the raw + byte data. Optional *_subtype* specifies the MIME subtype and defaults to + :mimetype:`octet-stream`. + + Optional *_encoder* is a callable (i.e. function) which will perform the actual + encoding of the data for transport. This callable takes one argument, which is + the :class:`MIMEApplication` instance. It should use + :meth:`~email.message.Message.get_payload` and + :meth:`~email.message.Message.set_payload` to change the payload to encoded + form. It should also add + any :mailheader:`Content-Transfer-Encoding` or other headers to the message + object as necessary. The default encoding is base64. See the + :mod:`email.encoders` module for a list of the built-in encoders. + + Optional *policy* argument defaults to :class:`compat32 `. + + *_params* are passed straight through to the base class constructor. + + .. versionchanged:: 3.6 + Added *policy* keyword-only parameter. + +.. currentmodule:: email.mime.audio + +.. class:: MIMEAudio(_audiodata, _subtype=None, \ + _encoder=email.encoders.encode_base64, \ + *, policy=compat32, **_params) + + Module: :mod:`email.mime.audio` + + A subclass of :class:`~email.mime.nonmultipart.MIMENonMultipart`, the + :class:`MIMEAudio` class is used to create MIME message objects of major type + :mimetype:`audio`. *_audiodata* is a string containing the raw audio data. If + this data can be decoded by the standard Python module :mod:`sndhdr`, then the + subtype will be automatically included in the :mailheader:`Content-Type` header. + Otherwise you can explicitly specify the audio subtype via the *_subtype* + argument. If the minor type could not be guessed and *_subtype* was not given, + then :exc:`TypeError` is raised. + + Optional *_encoder* is a callable (i.e. function) which will perform the actual + encoding of the audio data for transport. This callable takes one argument, + which is the :class:`MIMEAudio` instance. It should use + :meth:`~email.message.Message.get_payload` and + :meth:`~email.message.Message.set_payload` to change the payload to encoded + form. It should also add + any :mailheader:`Content-Transfer-Encoding` or other headers to the message + object as necessary. The default encoding is base64. See the + :mod:`email.encoders` module for a list of the built-in encoders. + + Optional *policy* argument defaults to :class:`compat32 `. + + *_params* are passed straight through to the base class constructor. + + .. versionchanged:: 3.6 + Added *policy* keyword-only parameter. + +.. currentmodule:: email.mime.image + +.. class:: MIMEImage(_imagedata, _subtype=None, \ + _encoder=email.encoders.encode_base64, \ + *, policy=compat32, **_params) + + Module: :mod:`email.mime.image` + + A subclass of :class:`~email.mime.nonmultipart.MIMENonMultipart`, the + :class:`MIMEImage` class is used to create MIME message objects of major type + :mimetype:`image`. *_imagedata* is a string containing the raw image data. If + this data can be decoded by the standard Python module :mod:`imghdr`, then the + subtype will be automatically included in the :mailheader:`Content-Type` header. + Otherwise you can explicitly specify the image subtype via the *_subtype* + argument. If the minor type could not be guessed and *_subtype* was not given, + then :exc:`TypeError` is raised. + + Optional *_encoder* is a callable (i.e. function) which will perform the actual + encoding of the image data for transport. This callable takes one argument, + which is the :class:`MIMEImage` instance. It should use + :meth:`~email.message.Message.get_payload` and + :meth:`~email.message.Message.set_payload` to change the payload to encoded + form. It should also add + any :mailheader:`Content-Transfer-Encoding` or other headers to the message + object as necessary. The default encoding is base64. See the + :mod:`email.encoders` module for a list of the built-in encoders. + + Optional *policy* argument defaults to :class:`compat32 `. + + *_params* are passed straight through to the :class:`~email.mime.base.MIMEBase` + constructor. + + .. versionchanged:: 3.6 + Added *policy* keyword-only parameter. + +.. currentmodule:: email.mime.message + +.. class:: MIMEMessage(_msg, _subtype='rfc822', *, policy=compat32) + + Module: :mod:`email.mime.message` + + A subclass of :class:`~email.mime.nonmultipart.MIMENonMultipart`, the + :class:`MIMEMessage` class is used to create MIME objects of main type + :mimetype:`message`. *_msg* is used as the payload, and must be an instance + of class :class:`~email.message.Message` (or a subclass thereof), otherwise + a :exc:`TypeError` is raised. + + Optional *_subtype* sets the subtype of the message; it defaults to + :mimetype:`rfc822`. + + Optional *policy* argument defaults to :class:`compat32 `. + + .. versionchanged:: 3.6 + Added *policy* keyword-only parameter. + +.. currentmodule:: email.mime.text + +.. class:: MIMEText(_text, _subtype='plain', _charset=None, *, policy=compat32) + + Module: :mod:`email.mime.text` + + A subclass of :class:`~email.mime.nonmultipart.MIMENonMultipart`, the + :class:`MIMEText` class is used to create MIME objects of major type + :mimetype:`text`. *_text* is the string for the payload. *_subtype* is the + minor type and defaults to :mimetype:`plain`. *_charset* is the character + set of the text and is passed as an argument to the + :class:`~email.mime.nonmultipart.MIMENonMultipart` constructor; it defaults + to ``us-ascii`` if the string contains only ``ascii`` code points, and + ``utf-8`` otherwise. The *_charset* parameter accepts either a string or a + :class:`~email.charset.Charset` instance. + + Unless the *_charset* argument is explicitly set to ``None``, the + MIMEText object created will have both a :mailheader:`Content-Type` header + with a ``charset`` parameter, and a :mailheader:`Content-Transfer-Encoding` + header. This means that a subsequent ``set_payload`` call will not result + in an encoded payload, even if a charset is passed in the ``set_payload`` + command. You can "reset" this behavior by deleting the + ``Content-Transfer-Encoding`` header, after which a ``set_payload`` call + will automatically encode the new payload (and add a new + :mailheader:`Content-Transfer-Encoding` header). + + Optional *policy* argument defaults to :class:`compat32 `. + + .. versionchanged:: 3.5 + *_charset* also accepts :class:`~email.charset.Charset` instances. + + .. versionchanged:: 3.6 + Added *policy* keyword-only parameter. diff --git a/python-3.7.4-docs-html/_sources/library/email.parser.rst.txt b/python-3.7.4-docs-html/_sources/library/email.parser.rst.txt new file mode 100644 index 0000000..d9a6161 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/email.parser.rst.txt @@ -0,0 +1,320 @@ +:mod:`email.parser`: Parsing email messages +------------------------------------------- + +.. module:: email.parser + :synopsis: Parse flat text email messages to produce a message object structure. + +**Source code:** :source:`Lib/email/parser.py` + +-------------- + +Message object structures can be created in one of two ways: they can be +created from whole cloth by creating an :class:`~email.message.EmailMessage` +object, adding headers using the dictionary interface, and adding payload(s) +using :meth:`~email.message.EmailMessage.set_content` and related methods, or +they can be created by parsing a serialized representation of the email +message. + +The :mod:`email` package provides a standard parser that understands most email +document structures, including MIME documents. You can pass the parser a +bytes, string or file object, and the parser will return to you the root +:class:`~email.message.EmailMessage` instance of the object structure. For +simple, non-MIME messages the payload of this root object will likely be a +string containing the text of the message. For MIME messages, the root object +will return ``True`` from its :meth:`~email.message.EmailMessage.is_multipart` +method, and the subparts can be accessed via the payload manipulation methods, +such as :meth:`~email.message.EmailMessage.get_body`, +:meth:`~email.message.EmailMessage.iter_parts`, and +:meth:`~email.message.EmailMessage.walk`. + +There are actually two parser interfaces available for use, the :class:`Parser` +API and the incremental :class:`FeedParser` API. The :class:`Parser` API is +most useful if you have the entire text of the message in memory, or if the +entire message lives in a file on the file system. :class:`FeedParser` is more +appropriate when you are reading the message from a stream which might block +waiting for more input (such as reading an email message from a socket). The +:class:`FeedParser` can consume and parse the message incrementally, and only +returns the root object when you close the parser. + +Note that the parser can be extended in limited ways, and of course you can +implement your own parser completely from scratch. All of the logic that +connects the :mod:`email` package's bundled parser and the +:class:`~email.message.EmailMessage` class is embodied in the :mod:`policy` +class, so a custom parser can create message object trees any way it finds +necessary by implementing custom versions of the appropriate :mod:`policy` +methods. + + +FeedParser API +^^^^^^^^^^^^^^ + +The :class:`BytesFeedParser`, imported from the :mod:`email.feedparser` module, +provides an API that is conducive to incremental parsing of email messages, +such as would be necessary when reading the text of an email message from a +source that can block (such as a socket). The :class:`BytesFeedParser` can of +course be used to parse an email message fully contained in a :term:`bytes-like +object`, string, or file, but the :class:`BytesParser` API may be more +convenient for such use cases. The semantics and results of the two parser +APIs are identical. + +The :class:`BytesFeedParser`'s API is simple; you create an instance, feed it a +bunch of bytes until there's no more to feed it, then close the parser to +retrieve the root message object. The :class:`BytesFeedParser` is extremely +accurate when parsing standards-compliant messages, and it does a very good job +of parsing non-compliant messages, providing information about how a message +was deemed broken. It will populate a message object's +:attr:`~email.message.EmailMessage.defects` attribute with a list of any +problems it found in a message. See the :mod:`email.errors` module for the +list of defects that it can find. + +Here is the API for the :class:`BytesFeedParser`: + + +.. class:: BytesFeedParser(_factory=None, *, policy=policy.compat32) + + Create a :class:`BytesFeedParser` instance. Optional *_factory* is a + no-argument callable; if not specified use the + :attr:`~email.policy.Policy.message_factory` from the *policy*. Call + *_factory* whenever a new message object is needed. + + If *policy* is specified use the rules it specifies to update the + representation of the message. If *policy* is not set, use the + :class:`compat32 ` policy, which maintains backward + compatibility with the Python 3.2 version of the email package and provides + :class:`~email.message.Message` as the default factory. All other policies + provide :class:`~email.message.EmailMessage` as the default *_factory*. For + more information on what else *policy* controls, see the + :mod:`~email.policy` documentation. + + Note: **The policy keyword should always be specified**; The default will + change to :data:`email.policy.default` in a future version of Python. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.3 Added the *policy* keyword. + .. versionchanged:: 3.6 *_factory* defaults to the policy ``message_factory``. + + + .. method:: feed(data) + + Feed the parser some more data. *data* should be a :term:`bytes-like + object` containing one or more lines. The lines can be partial and the + parser will stitch such partial lines together properly. The lines can + have any of the three common line endings: carriage return, newline, or + carriage return and newline (they can even be mixed). + + + .. method:: close() + + Complete the parsing of all previously fed data and return the root + message object. It is undefined what happens if :meth:`~feed` is called + after this method has been called. + + +.. class:: FeedParser(_factory=None, *, policy=policy.compat32) + + Works like :class:`BytesFeedParser` except that the input to the + :meth:`~BytesFeedParser.feed` method must be a string. This is of limited + utility, since the only way for such a message to be valid is for it to + contain only ASCII text or, if :attr:`~email.policy.Policy.utf8` is + ``True``, no binary attachments. + + .. versionchanged:: 3.3 Added the *policy* keyword. + + +Parser API +^^^^^^^^^^ + +The :class:`BytesParser` class, imported from the :mod:`email.parser` module, +provides an API that can be used to parse a message when the complete contents +of the message are available in a :term:`bytes-like object` or file. The +:mod:`email.parser` module also provides :class:`Parser` for parsing strings, +and header-only parsers, :class:`BytesHeaderParser` and +:class:`HeaderParser`, which can be used if you're only interested in the +headers of the message. :class:`BytesHeaderParser` and :class:`HeaderParser` +can be much faster in these situations, since they do not attempt to parse the +message body, instead setting the payload to the raw body. + + +.. class:: BytesParser(_class=None, *, policy=policy.compat32) + + Create a :class:`BytesParser` instance. The *_class* and *policy* + arguments have the same meaning and semantics as the *_factory* + and *policy* arguments of :class:`BytesFeedParser`. + + Note: **The policy keyword should always be specified**; The default will + change to :data:`email.policy.default` in a future version of Python. + + .. versionchanged:: 3.3 + Removed the *strict* argument that was deprecated in 2.4. Added the + *policy* keyword. + .. versionchanged:: 3.6 *_class* defaults to the policy ``message_factory``. + + + .. method:: parse(fp, headersonly=False) + + Read all the data from the binary file-like object *fp*, parse the + resulting bytes, and return the message object. *fp* must support + both the :meth:`~io.IOBase.readline` and the :meth:`~io.IOBase.read` + methods. + + The bytes contained in *fp* must be formatted as a block of :rfc:`5322` + (or, if :attr:`~email.policy.Policy.utf8` is ``True``, :rfc:`6532`) + style headers and header continuation lines, optionally preceded by an + envelope header. The header block is terminated either by the end of the + data or by a blank line. Following the header block is the body of the + message (which may contain MIME-encoded subparts, including subparts + with a :mailheader:`Content-Transfer-Encoding` of ``8bit``). + + Optional *headersonly* is a flag specifying whether to stop parsing after + reading the headers or not. The default is ``False``, meaning it parses + the entire contents of the file. + + + .. method:: parsebytes(bytes, headersonly=False) + + Similar to the :meth:`parse` method, except it takes a :term:`bytes-like + object` instead of a file-like object. Calling this method on a + :term:`bytes-like object` is equivalent to wrapping *bytes* in a + :class:`~io.BytesIO` instance first and calling :meth:`parse`. + + Optional *headersonly* is as with the :meth:`parse` method. + + .. versionadded:: 3.2 + + +.. class:: BytesHeaderParser(_class=None, *, policy=policy.compat32) + + Exactly like :class:`BytesParser`, except that *headersonly* + defaults to ``True``. + + .. versionadded:: 3.3 + + +.. class:: Parser(_class=None, *, policy=policy.compat32) + + This class is parallel to :class:`BytesParser`, but handles string input. + + .. versionchanged:: 3.3 + Removed the *strict* argument. Added the *policy* keyword. + .. versionchanged:: 3.6 *_class* defaults to the policy ``message_factory``. + + + .. method:: parse(fp, headersonly=False) + + Read all the data from the text-mode file-like object *fp*, parse the + resulting text, and return the root message object. *fp* must support + both the :meth:`~io.TextIOBase.readline` and the + :meth:`~io.TextIOBase.read` methods on file-like objects. + + Other than the text mode requirement, this method operates like + :meth:`BytesParser.parse`. + + + .. method:: parsestr(text, headersonly=False) + + Similar to the :meth:`parse` method, except it takes a string object + instead of a file-like object. Calling this method on a string is + equivalent to wrapping *text* in a :class:`~io.StringIO` instance first + and calling :meth:`parse`. + + Optional *headersonly* is as with the :meth:`parse` method. + + +.. class:: HeaderParser(_class=None, *, policy=policy.compat32) + + Exactly like :class:`Parser`, except that *headersonly* + defaults to ``True``. + + +Since creating a message object structure from a string or a file object is such +a common task, four functions are provided as a convenience. They are available +in the top-level :mod:`email` package namespace. + +.. currentmodule:: email + + +.. function:: message_from_bytes(s, _class=None, *, policy=policy.compat32) + + Return a message object structure from a :term:`bytes-like object`. This is + equivalent to ``BytesParser().parsebytes(s)``. Optional *_class* and + *policy* are interpreted as with the :class:`~email.parser.BytesParser` class + constructor. + + .. versionadded:: 3.2 + .. versionchanged:: 3.3 + Removed the *strict* argument. Added the *policy* keyword. + + +.. function:: message_from_binary_file(fp, _class=None, *, \ + policy=policy.compat32) + + Return a message object structure tree from an open binary :term:`file + object`. This is equivalent to ``BytesParser().parse(fp)``. *_class* and + *policy* are interpreted as with the :class:`~email.parser.BytesParser` class + constructor. + + .. versionadded:: 3.2 + .. versionchanged:: 3.3 + Removed the *strict* argument. Added the *policy* keyword. + + +.. function:: message_from_string(s, _class=None, *, policy=policy.compat32) + + Return a message object structure from a string. This is equivalent to + ``Parser().parsestr(s)``. *_class* and *policy* are interpreted as + with the :class:`~email.parser.Parser` class constructor. + + .. versionchanged:: 3.3 + Removed the *strict* argument. Added the *policy* keyword. + + +.. function:: message_from_file(fp, _class=None, *, policy=policy.compat32) + + Return a message object structure tree from an open :term:`file object`. + This is equivalent to ``Parser().parse(fp)``. *_class* and *policy* are + interpreted as with the :class:`~email.parser.Parser` class constructor. + + .. versionchanged:: 3.3 + Removed the *strict* argument. Added the *policy* keyword. + .. versionchanged:: 3.6 *_class* defaults to the policy ``message_factory``. + + +Here's an example of how you might use :func:`message_from_bytes` at an +interactive Python prompt:: + + >>> import email + >>> msg = email.message_from_bytes(myBytes) # doctest: +SKIP + + +Additional notes +^^^^^^^^^^^^^^^^ + +Here are some notes on the parsing semantics: + +* Most non-\ :mimetype:`multipart` type messages are parsed as a single message + object with a string payload. These objects will return ``False`` for + :meth:`~email.message.EmailMessage.is_multipart`, and + :meth:`~email.message.EmailMessage.iter_parts` will yield an empty list. + +* All :mimetype:`multipart` type messages will be parsed as a container message + object with a list of sub-message objects for their payload. The outer + container message will return ``True`` for + :meth:`~email.message.EmailMessage.is_multipart`, and + :meth:`~email.message.EmailMessage.iter_parts` will yield a list of subparts. + +* Most messages with a content type of :mimetype:`message/\*` (such as + :mimetype:`message/delivery-status` and :mimetype:`message/rfc822`) will also + be parsed as container object containing a list payload of length 1. Their + :meth:`~email.message.EmailMessage.is_multipart` method will return ``True``. + The single element yielded by :meth:`~email.message.EmailMessage.iter_parts` + will be a sub-message object. + +* Some non-standards-compliant messages may not be internally consistent about + their :mimetype:`multipart`\ -edness. Such messages may have a + :mailheader:`Content-Type` header of type :mimetype:`multipart`, but their + :meth:`~email.message.EmailMessage.is_multipart` method may return ``False``. + If such messages were parsed with the :class:`~email.parser.FeedParser`, + they will have an instance of the + :class:`~email.errors.MultipartInvariantViolationDefect` class in their + *defects* attribute list. See :mod:`email.errors` for details. diff --git a/python-3.7.4-docs-html/_sources/library/email.policy.rst.txt b/python-3.7.4-docs-html/_sources/library/email.policy.rst.txt new file mode 100644 index 0000000..8e70762 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/email.policy.rst.txt @@ -0,0 +1,651 @@ +:mod:`email.policy`: Policy Objects +----------------------------------- + +.. module:: email.policy + :synopsis: Controlling the parsing and generating of messages + +.. moduleauthor:: R. David Murray +.. sectionauthor:: R. David Murray + +.. versionadded:: 3.3 + +**Source code:** :source:`Lib/email/policy.py` + +-------------- + +The :mod:`email` package's prime focus is the handling of email messages as +described by the various email and MIME RFCs. However, the general format of +email messages (a block of header fields each consisting of a name followed by +a colon followed by a value, the whole block followed by a blank line and an +arbitrary 'body'), is a format that has found utility outside of the realm of +email. Some of these uses conform fairly closely to the main email RFCs, some +do not. Even when working with email, there are times when it is desirable to +break strict compliance with the RFCs, such as generating emails that +interoperate with email servers that do not themselves follow the standards, or +that implement extensions you want to use in ways that violate the +standards. + +Policy objects give the email package the flexibility to handle all these +disparate use cases. + +A :class:`Policy` object encapsulates a set of attributes and methods that +control the behavior of various components of the email package during use. +:class:`Policy` instances can be passed to various classes and methods in the +email package to alter the default behavior. The settable values and their +defaults are described below. + +There is a default policy used by all classes in the email package. For all of +the :mod:`~email.parser` classes and the related convenience functions, and for +the :class:`~email.message.Message` class, this is the :class:`Compat32` +policy, via its corresponding pre-defined instance :const:`compat32`. This +policy provides for complete backward compatibility (in some cases, including +bug compatibility) with the pre-Python3.3 version of the email package. + +This default value for the *policy* keyword to +:class:`~email.message.EmailMessage` is the :class:`EmailPolicy` policy, via +its pre-defined instance :data:`~default`. + +When a :class:`~email.message.Message` or :class:`~email.message.EmailMessage` +object is created, it acquires a policy. If the message is created by a +:mod:`~email.parser`, a policy passed to the parser will be the policy used by +the message it creates. If the message is created by the program, then the +policy can be specified when it is created. When a message is passed to a +:mod:`~email.generator`, the generator uses the policy from the message by +default, but you can also pass a specific policy to the generator that will +override the one stored on the message object. + +The default value for the *policy* keyword for the :mod:`email.parser` classes +and the parser convenience functions **will be changing** in a future version of +Python. Therefore you should **always specify explicitly which policy you want +to use** when calling any of the classes and functions described in the +:mod:`~email.parser` module. + +The first part of this documentation covers the features of :class:`Policy`, an +:term:`abstract base class` that defines the features that are common to all +policy objects, including :const:`compat32`. This includes certain hook +methods that are called internally by the email package, which a custom policy +could override to obtain different behavior. The second part describes the +concrete classes :class:`EmailPolicy` and :class:`Compat32`, which implement +the hooks that provide the standard behavior and the backward compatible +behavior and features, respectively. + +:class:`Policy` instances are immutable, but they can be cloned, accepting the +same keyword arguments as the class constructor and returning a new +:class:`Policy` instance that is a copy of the original but with the specified +attributes values changed. + +As an example, the following code could be used to read an email message from a +file on disk and pass it to the system ``sendmail`` program on a Unix system: + +.. testsetup:: + + from unittest import mock + mocker = mock.patch('subprocess.Popen') + m = mocker.start() + proc = mock.MagicMock() + m.return_value = proc + proc.stdin.close.return_value = None + mymsg = open('mymsg.txt', 'w') + mymsg.write('To: abc@xyz.com\n\n') + mymsg.flush() + +.. doctest:: + + >>> from email import message_from_binary_file + >>> from email.generator import BytesGenerator + >>> from email import policy + >>> from subprocess import Popen, PIPE + >>> with open('mymsg.txt', 'rb') as f: + ... msg = message_from_binary_file(f, policy=policy.default) + >>> p = Popen(['sendmail', msg['To'].addresses[0]], stdin=PIPE) + >>> g = BytesGenerator(p.stdin, policy=msg.policy.clone(linesep='\r\n')) + >>> g.flatten(msg) + >>> p.stdin.close() + >>> rc = p.wait() + +.. testcleanup:: + + mymsg.close() + mocker.stop() + import os + os.remove('mymsg.txt') + +Here we are telling :class:`~email.generator.BytesGenerator` to use the RFC +correct line separator characters when creating the binary string to feed into +``sendmail's`` ``stdin``, where the default policy would use ``\n`` line +separators. + +Some email package methods accept a *policy* keyword argument, allowing the +policy to be overridden for that method. For example, the following code uses +the :meth:`~email.message.Message.as_bytes` method of the *msg* object from +the previous example and writes the message to a file using the native line +separators for the platform on which it is running:: + + >>> import os + >>> with open('converted.txt', 'wb') as f: + ... f.write(msg.as_bytes(policy=msg.policy.clone(linesep=os.linesep))) + 17 + +Policy objects can also be combined using the addition operator, producing a +policy object whose settings are a combination of the non-default values of the +summed objects:: + + >>> compat_SMTP = policy.compat32.clone(linesep='\r\n') + >>> compat_strict = policy.compat32.clone(raise_on_defect=True) + >>> compat_strict_SMTP = compat_SMTP + compat_strict + +This operation is not commutative; that is, the order in which the objects are +added matters. To illustrate:: + + >>> policy100 = policy.compat32.clone(max_line_length=100) + >>> policy80 = policy.compat32.clone(max_line_length=80) + >>> apolicy = policy100 + policy80 + >>> apolicy.max_line_length + 80 + >>> apolicy = policy80 + policy100 + >>> apolicy.max_line_length + 100 + + +.. class:: Policy(**kw) + + This is the :term:`abstract base class` for all policy classes. It provides + default implementations for a couple of trivial methods, as well as the + implementation of the immutability property, the :meth:`clone` method, and + the constructor semantics. + + The constructor of a policy class can be passed various keyword arguments. + The arguments that may be specified are any non-method properties on this + class, plus any additional non-method properties on the concrete class. A + value specified in the constructor will override the default value for the + corresponding attribute. + + This class defines the following properties, and thus values for the + following may be passed in the constructor of any policy class: + + + .. attribute:: max_line_length + + The maximum length of any line in the serialized output, not counting the + end of line character(s). Default is 78, per :rfc:`5322`. A value of + ``0`` or :const:`None` indicates that no line wrapping should be + done at all. + + + .. attribute:: linesep + + The string to be used to terminate lines in serialized output. The + default is ``\n`` because that's the internal end-of-line discipline used + by Python, though ``\r\n`` is required by the RFCs. + + + .. attribute:: cte_type + + Controls the type of Content Transfer Encodings that may be or are + required to be used. The possible values are: + + .. tabularcolumns:: |l|L| + + ======== =============================================================== + ``7bit`` all data must be "7 bit clean" (ASCII-only). This means that + where necessary data will be encoded using either + quoted-printable or base64 encoding. + + ``8bit`` data is not constrained to be 7 bit clean. Data in headers is + still required to be ASCII-only and so will be encoded (see + :meth:`fold_binary` and :attr:`~EmailPolicy.utf8` below for + exceptions), but body parts may use the ``8bit`` CTE. + ======== =============================================================== + + A ``cte_type`` value of ``8bit`` only works with ``BytesGenerator``, not + ``Generator``, because strings cannot contain binary data. If a + ``Generator`` is operating under a policy that specifies + ``cte_type=8bit``, it will act as if ``cte_type`` is ``7bit``. + + + .. attribute:: raise_on_defect + + If :const:`True`, any defects encountered will be raised as errors. If + :const:`False` (the default), defects will be passed to the + :meth:`register_defect` method. + + + .. attribute:: mangle_from\_ + + If :const:`True`, lines starting with *"From "* in the body are + escaped by putting a ``>`` in front of them. This parameter is used when + the message is being serialized by a generator. + Default: :const:`False`. + + .. versionadded:: 3.5 + The *mangle_from_* parameter. + + + .. attribute:: message_factory + + A factory function for constructing a new empty message object. Used + by the parser when building messages. Defaults to ``None``, in + which case :class:`~email.message.Message` is used. + + .. versionadded:: 3.6 + + The following :class:`Policy` method is intended to be called by code using + the email library to create policy instances with custom settings: + + + .. method:: clone(**kw) + + Return a new :class:`Policy` instance whose attributes have the same + values as the current instance, except where those attributes are + given new values by the keyword arguments. + + + The remaining :class:`Policy` methods are called by the email package code, + and are not intended to be called by an application using the email package. + A custom policy must implement all of these methods. + + + .. method:: handle_defect(obj, defect) + + Handle a *defect* found on *obj*. When the email package calls this + method, *defect* will always be a subclass of + :class:`~email.errors.Defect`. + + The default implementation checks the :attr:`raise_on_defect` flag. If + it is ``True``, *defect* is raised as an exception. If it is ``False`` + (the default), *obj* and *defect* are passed to :meth:`register_defect`. + + + .. method:: register_defect(obj, defect) + + Register a *defect* on *obj*. In the email package, *defect* will always + be a subclass of :class:`~email.errors.Defect`. + + The default implementation calls the ``append`` method of the ``defects`` + attribute of *obj*. When the email package calls :attr:`handle_defect`, + *obj* will normally have a ``defects`` attribute that has an ``append`` + method. Custom object types used with the email package (for example, + custom ``Message`` objects) should also provide such an attribute, + otherwise defects in parsed messages will raise unexpected errors. + + + .. method:: header_max_count(name) + + Return the maximum allowed number of headers named *name*. + + Called when a header is added to an :class:`~email.message.EmailMessage` + or :class:`~email.message.Message` object. If the returned value is not + ``0`` or ``None``, and there are already a number of headers with the + name *name* greater than or equal to the value returned, a + :exc:`ValueError` is raised. + + Because the default behavior of ``Message.__setitem__`` is to append the + value to the list of headers, it is easy to create duplicate headers + without realizing it. This method allows certain headers to be limited + in the number of instances of that header that may be added to a + ``Message`` programmatically. (The limit is not observed by the parser, + which will faithfully produce as many headers as exist in the message + being parsed.) + + The default implementation returns ``None`` for all header names. + + + .. method:: header_source_parse(sourcelines) + + The email package calls this method with a list of strings, each string + ending with the line separation characters found in the source being + parsed. The first line includes the field header name and separator. + All whitespace in the source is preserved. The method should return the + ``(name, value)`` tuple that is to be stored in the ``Message`` to + represent the parsed header. + + If an implementation wishes to retain compatibility with the existing + email package policies, *name* should be the case preserved name (all + characters up to the '``:``' separator), while *value* should be the + unfolded value (all line separator characters removed, but whitespace + kept intact), stripped of leading whitespace. + + *sourcelines* may contain surrogateescaped binary data. + + There is no default implementation + + + .. method:: header_store_parse(name, value) + + The email package calls this method with the name and value provided by + the application program when the application program is modifying a + ``Message`` programmatically (as opposed to a ``Message`` created by a + parser). The method should return the ``(name, value)`` tuple that is to + be stored in the ``Message`` to represent the header. + + If an implementation wishes to retain compatibility with the existing + email package policies, the *name* and *value* should be strings or + string subclasses that do not change the content of the passed in + arguments. + + There is no default implementation + + + .. method:: header_fetch_parse(name, value) + + The email package calls this method with the *name* and *value* currently + stored in the ``Message`` when that header is requested by the + application program, and whatever the method returns is what is passed + back to the application as the value of the header being retrieved. + Note that there may be more than one header with the same name stored in + the ``Message``; the method is passed the specific name and value of the + header destined to be returned to the application. + + *value* may contain surrogateescaped binary data. There should be no + surrogateescaped binary data in the value returned by the method. + + There is no default implementation + + + .. method:: fold(name, value) + + The email package calls this method with the *name* and *value* currently + stored in the ``Message`` for a given header. The method should return a + string that represents that header "folded" correctly (according to the + policy settings) by composing the *name* with the *value* and inserting + :attr:`linesep` characters at the appropriate places. See :rfc:`5322` + for a discussion of the rules for folding email headers. + + *value* may contain surrogateescaped binary data. There should be no + surrogateescaped binary data in the string returned by the method. + + + .. method:: fold_binary(name, value) + + The same as :meth:`fold`, except that the returned value should be a + bytes object rather than a string. + + *value* may contain surrogateescaped binary data. These could be + converted back into binary data in the returned bytes object. + + + +.. class:: EmailPolicy(**kw) + + This concrete :class:`Policy` provides behavior that is intended to be fully + compliant with the current email RFCs. These include (but are not limited + to) :rfc:`5322`, :rfc:`2047`, and the current MIME RFCs. + + This policy adds new header parsing and folding algorithms. Instead of + simple strings, headers are ``str`` subclasses with attributes that depend + on the type of the field. The parsing and folding algorithm fully implement + :rfc:`2047` and :rfc:`5322`. + + The default value for the :attr:`~email.policy.Policy.message_factory` + attribute is :class:`~email.message.EmailMessage`. + + In addition to the settable attributes listed above that apply to all + policies, this policy adds the following additional attributes: + + .. versionadded:: 3.6 [1]_ + + + .. attribute:: utf8 + + If ``False``, follow :rfc:`5322`, supporting non-ASCII characters in + headers by encoding them as "encoded words". If ``True``, follow + :rfc:`6532` and use ``utf-8`` encoding for headers. Messages + formatted in this way may be passed to SMTP servers that support + the ``SMTPUTF8`` extension (:rfc:`6531`). + + + .. attribute:: refold_source + + If the value for a header in the ``Message`` object originated from a + :mod:`~email.parser` (as opposed to being set by a program), this + attribute indicates whether or not a generator should refold that value + when transforming the message back into serialized form. The possible + values are: + + ======== =============================================================== + ``none`` all source values use original folding + + ``long`` source values that have any line that is longer than + ``max_line_length`` will be refolded + + ``all`` all values are refolded. + ======== =============================================================== + + The default is ``long``. + + + .. attribute:: header_factory + + A callable that takes two arguments, ``name`` and ``value``, where + ``name`` is a header field name and ``value`` is an unfolded header field + value, and returns a string subclass that represents that header. A + default ``header_factory`` (see :mod:`~email.headerregistry`) is provided + that supports custom parsing for the various address and date :RFC:`5322` + header field types, and the major MIME header field stypes. Support for + additional custom parsing will be added in the future. + + + .. attribute:: content_manager + + An object with at least two methods: get_content and set_content. When + the :meth:`~email.message.EmailMessage.get_content` or + :meth:`~email.message.EmailMessage.set_content` method of an + :class:`~email.message.EmailMessage` object is called, it calls the + corresponding method of this object, passing it the message object as its + first argument, and any arguments or keywords that were passed to it as + additional arguments. By default ``content_manager`` is set to + :data:`~email.contentmanager.raw_data_manager`. + + .. versionadded:: 3.4 + + + The class provides the following concrete implementations of the abstract + methods of :class:`Policy`: + + + .. method:: header_max_count(name) + + Returns the value of the + :attr:`~email.headerregistry.BaseHeader.max_count` attribute of the + specialized class used to represent the header with the given name. + + + .. method:: header_source_parse(sourcelines) + + + The name is parsed as everything up to the '``:``' and returned + unmodified. The value is determined by stripping leading whitespace off + the remainder of the first line, joining all subsequent lines together, + and stripping any trailing carriage return or linefeed characters. + + + .. method:: header_store_parse(name, value) + + The name is returned unchanged. If the input value has a ``name`` + attribute and it matches *name* ignoring case, the value is returned + unchanged. Otherwise the *name* and *value* are passed to + ``header_factory``, and the resulting header object is returned as + the value. In this case a ``ValueError`` is raised if the input value + contains CR or LF characters. + + + .. method:: header_fetch_parse(name, value) + + If the value has a ``name`` attribute, it is returned to unmodified. + Otherwise the *name*, and the *value* with any CR or LF characters + removed, are passed to the ``header_factory``, and the resulting + header object is returned. Any surrogateescaped bytes get turned into + the unicode unknown-character glyph. + + + .. method:: fold(name, value) + + Header folding is controlled by the :attr:`refold_source` policy setting. + A value is considered to be a 'source value' if and only if it does not + have a ``name`` attribute (having a ``name`` attribute means it is a + header object of some sort). If a source value needs to be refolded + according to the policy, it is converted into a header object by + passing the *name* and the *value* with any CR and LF characters removed + to the ``header_factory``. Folding of a header object is done by + calling its ``fold`` method with the current policy. + + Source values are split into lines using :meth:`~str.splitlines`. If + the value is not to be refolded, the lines are rejoined using the + ``linesep`` from the policy and returned. The exception is lines + containing non-ascii binary data. In that case the value is refolded + regardless of the ``refold_source`` setting, which causes the binary data + to be CTE encoded using the ``unknown-8bit`` charset. + + + .. method:: fold_binary(name, value) + + The same as :meth:`fold` if :attr:`~Policy.cte_type` is ``7bit``, except + that the returned value is bytes. + + If :attr:`~Policy.cte_type` is ``8bit``, non-ASCII binary data is + converted back + into bytes. Headers with binary data are not refolded, regardless of the + ``refold_header`` setting, since there is no way to know whether the + binary data consists of single byte characters or multibyte characters. + + +The following instances of :class:`EmailPolicy` provide defaults suitable for +specific application domains. Note that in the future the behavior of these +instances (in particular the ``HTTP`` instance) may be adjusted to conform even +more closely to the RFCs relevant to their domains. + + +.. data:: default + + An instance of ``EmailPolicy`` with all defaults unchanged. This policy + uses the standard Python ``\n`` line endings rather than the RFC-correct + ``\r\n``. + + +.. data:: SMTP + + Suitable for serializing messages in conformance with the email RFCs. + Like ``default``, but with ``linesep`` set to ``\r\n``, which is RFC + compliant. + + +.. data:: SMTPUTF8 + + The same as ``SMTP`` except that :attr:`~EmailPolicy.utf8` is ``True``. + Useful for serializing messages to a message store without using encoded + words in the headers. Should only be used for SMTP transmission if the + sender or recipient addresses have non-ASCII characters (the + :meth:`smtplib.SMTP.send_message` method handles this automatically). + + +.. data:: HTTP + + Suitable for serializing headers with for use in HTTP traffic. Like + ``SMTP`` except that ``max_line_length`` is set to ``None`` (unlimited). + + +.. data:: strict + + Convenience instance. The same as ``default`` except that + ``raise_on_defect`` is set to ``True``. This allows any policy to be made + strict by writing:: + + somepolicy + policy.strict + + +With all of these :class:`EmailPolicies <.EmailPolicy>`, the effective API of +the email package is changed from the Python 3.2 API in the following ways: + + * Setting a header on a :class:`~email.message.Message` results in that + header being parsed and a header object created. + + * Fetching a header value from a :class:`~email.message.Message` results + in that header being parsed and a header object created and + returned. + + * Any header object, or any header that is refolded due to the + policy settings, is folded using an algorithm that fully implements the + RFC folding algorithms, including knowing where encoded words are required + and allowed. + +From the application view, this means that any header obtained through the +:class:`~email.message.EmailMessage` is a header object with extra +attributes, whose string value is the fully decoded unicode value of the +header. Likewise, a header may be assigned a new value, or a new header +created, using a unicode string, and the policy will take care of converting +the unicode string into the correct RFC encoded form. + +The header objects and their attributes are described in +:mod:`~email.headerregistry`. + + + +.. class:: Compat32(**kw) + + This concrete :class:`Policy` is the backward compatibility policy. It + replicates the behavior of the email package in Python 3.2. The + :mod:`~email.policy` module also defines an instance of this class, + :const:`compat32`, that is used as the default policy. Thus the default + behavior of the email package is to maintain compatibility with Python 3.2. + + The following attributes have values that are different from the + :class:`Policy` default: + + + .. attribute:: mangle_from_ + + The default is ``True``. + + + The class provides the following concrete implementations of the + abstract methods of :class:`Policy`: + + + .. method:: header_source_parse(sourcelines) + + The name is parsed as everything up to the '``:``' and returned + unmodified. The value is determined by stripping leading whitespace off + the remainder of the first line, joining all subsequent lines together, + and stripping any trailing carriage return or linefeed characters. + + + .. method:: header_store_parse(name, value) + + The name and value are returned unmodified. + + + .. method:: header_fetch_parse(name, value) + + If the value contains binary data, it is converted into a + :class:`~email.header.Header` object using the ``unknown-8bit`` charset. + Otherwise it is returned unmodified. + + + .. method:: fold(name, value) + + Headers are folded using the :class:`~email.header.Header` folding + algorithm, which preserves existing line breaks in the value, and wraps + each resulting line to the ``max_line_length``. Non-ASCII binary data are + CTE encoded using the ``unknown-8bit`` charset. + + + .. method:: fold_binary(name, value) + + Headers are folded using the :class:`~email.header.Header` folding + algorithm, which preserves existing line breaks in the value, and wraps + each resulting line to the ``max_line_length``. If ``cte_type`` is + ``7bit``, non-ascii binary data is CTE encoded using the ``unknown-8bit`` + charset. Otherwise the original source header is used, with its existing + line breaks and any (RFC invalid) binary data it may contain. + + +.. data:: compat32 + + An instance of :class:`Compat32`, providing backward compatibility with the + behavior of the email package in Python 3.2. + + +.. rubric:: Footnotes + +.. [1] Originally added in 3.3 as a :term:`provisional feature `. diff --git a/python-3.7.4-docs-html/_sources/library/email.rst.txt b/python-3.7.4-docs-html/_sources/library/email.rst.txt new file mode 100644 index 0000000..fae99cf --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/email.rst.txt @@ -0,0 +1,152 @@ +:mod:`email` --- An email and MIME handling package +=================================================== + +.. module:: email + :synopsis: Package supporting the parsing, manipulating, and generating + email messages. +.. moduleauthor:: Barry A. Warsaw , + R. David Murray +.. sectionauthor:: R. David Murray + +**Source code:** :source:`Lib/email/__init__.py` + +-------------- + +The :mod:`email` package is a library for managing email messages. It is +specifically *not* designed to do any sending of email messages to SMTP +(:rfc:`2821`), NNTP, or other servers; those are functions of modules such as +:mod:`smtplib` and :mod:`nntplib`. The :mod:`email` package attempts to be as +RFC-compliant as possible, supporting :rfc:`5233` and :rfc:`6532`, as well as +such MIME-related RFCs as :rfc:`2045`, :rfc:`2046`, :rfc:`2047`, :rfc:`2183`, +and :rfc:`2231`. + +The overall structure of the email package can be divided into three major +components, plus a fourth component that controls the behavior of the other +components. + +The central component of the package is an "object model" that represents email +messages. An application interacts with the package primarily through the +object model interface defined in the :mod:`~email.message` sub-module. The +application can use this API to ask questions about an existing email, to +construct a new email, or to add or remove email subcomponents that themselves +use the same object model interface. That is, following the nature of email +messages and their MIME subcomponents, the email object model is a tree +structure of objects that all provide the :class:`~email.message.EmailMessage` +API. + +The other two major components of the package are the :mod:`~email.parser` and +the :mod:`~email.generator`. The parser takes the serialized version of an +email message (a stream of bytes) and converts it into a tree of +:class:`~email.message.EmailMessage` objects. The generator takes an +:class:`~email.message.EmailMessage` and turns it back into a serialized byte +stream. (The parser and generator also handle streams of text characters, but +this usage is discouraged as it is too easy to end up with messages that are +not valid in one way or another.) + +The control component is the :mod:`~email.policy` module. Every +:class:`~email.message.EmailMessage`, every :mod:`~email.generator`, and every +:mod:`~email.parser` has an associated :mod:`~email.policy` object that +controls its behavior. Usually an application only needs to specify the policy +when an :class:`~email.message.EmailMessage` is created, either by directly +instantiating an :class:`~email.message.EmailMessage` to create a new email, +or by parsing an input stream using a :mod:`~email.parser`. But the policy can +be changed when the message is serialized using a :mod:`~email.generator`. +This allows, for example, a generic email message to be parsed from disk, but +to serialize it using standard SMTP settings when sending it to an email +server. + +The email package does its best to hide the details of the various governing +RFCs from the application. Conceptually the application should be able to +treat the email message as a structured tree of unicode text and binary +attachments, without having to worry about how these are represented when +serialized. In practice, however, it is often necessary to be aware of at +least some of the rules governing MIME messages and their structure, +specifically the names and nature of the MIME "content types" and how they +identify multipart documents. For the most part this knowledge should only be +required for more complex applications, and even then it should only be the +high level structure in question, and not the details of how those structures +are represented. Since MIME content types are used widely in modern internet +software (not just email), this will be a familiar concept to many programmers. + +The following sections describe the functionality of the :mod:`email` package. +We start with the :mod:`~email.message` object model, which is the primary +interface an application will use, and follow that with the +:mod:`~email.parser` and :mod:`~email.generator` components. Then we cover the +:mod:`~email.policy` controls, which completes the treatment of the main +components of the library. + +The next three sections cover the exceptions the package may raise and the +defects (non-compliance with the RFCs) that the :mod:`~email.parser` may +detect. Then we cover the :mod:`~email.headerregistry` and the +:mod:`~email.contentmanager` sub-components, which provide tools for doing more +detailed manipulation of headers and payloads, respectively. Both of these +components contain features relevant to consuming and producing non-trivial +messages, but also document their extensibility APIs, which will be of interest +to advanced applications. + +Following those is a set of examples of using the fundamental parts of the APIs +covered in the preceding sections. + +The foregoing represent the modern (unicode friendly) API of the email package. +The remaining sections, starting with the :class:`~email.message.Message` +class, cover the legacy :data:`~email.policy.compat32` API that deals much more +directly with the details of how email messages are represented. The +:data:`~email.policy.compat32` API does *not* hide the details of the RFCs from +the application, but for applications that need to operate at that level, they +can be useful tools. This documentation is also relevant for applications that +are still using the :mod:`~email.policy.compat32` API for backward +compatibility reasons. + +.. versionchanged:: 3.6 + Docs reorganized and rewritten to promote the new + :class:`~email.message.EmailMessage`/:class:`~email.policy.EmailPolicy` + API. + +Contents of the :mod:`email` package documentation: + +.. toctree:: + + email.message.rst + email.parser.rst + email.generator.rst + email.policy.rst + + email.errors.rst + email.headerregistry.rst + email.contentmanager.rst + + email.examples.rst + +Legacy API: + +.. toctree:: + + email.compat32-message.rst + email.mime.rst + email.header.rst + email.charset.rst + email.encoders.rst + email.utils.rst + email.iterators.rst + + +.. seealso:: + + Module :mod:`smtplib` + SMTP (Simple Mail Transport Protocol) client + + Module :mod:`poplib` + POP (Post Office Protocol) client + + Module :mod:`imaplib` + IMAP (Internet Message Access Protocol) client + + Module :mod:`nntplib` + NNTP (Net News Transport Protocol) client + + Module :mod:`mailbox` + Tools for creating, reading, and managing collections of messages on disk + using a variety standard formats. + + Module :mod:`smtpd` + SMTP server framework (primarily useful for testing) diff --git a/python-3.7.4-docs-html/_sources/library/email.utils.rst.txt b/python-3.7.4-docs-html/_sources/library/email.utils.rst.txt new file mode 100644 index 0000000..63fae2a --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/email.utils.rst.txt @@ -0,0 +1,218 @@ +:mod:`email.utils`: Miscellaneous utilities +------------------------------------------- + +.. module:: email.utils + :synopsis: Miscellaneous email package utilities. + +**Source code:** :source:`Lib/email/utils.py` + +-------------- + +There are a couple of useful utilities provided in the :mod:`email.utils` +module: + +.. function:: localtime(dt=None) + + Return local time as an aware datetime object. If called without + arguments, return current time. Otherwise *dt* argument should be a + :class:`~datetime.datetime` instance, and it is converted to the local time + zone according to the system time zone database. If *dt* is naive (that + is, ``dt.tzinfo`` is ``None``), it is assumed to be in local time. In this + case, a positive or zero value for *isdst* causes ``localtime`` to presume + initially that summer time (for example, Daylight Saving Time) is or is not + (respectively) in effect for the specified time. A negative value for + *isdst* causes the ``localtime`` to attempt to divine whether summer time + is in effect for the specified time. + + .. versionadded:: 3.3 + + +.. function:: make_msgid(idstring=None, domain=None) + + Returns a string suitable for an :rfc:`2822`\ -compliant + :mailheader:`Message-ID` header. Optional *idstring* if given, is a string + used to strengthen the uniqueness of the message id. Optional *domain* if + given provides the portion of the msgid after the '@'. The default is the + local hostname. It is not normally necessary to override this default, but + may be useful certain cases, such as a constructing distributed system that + uses a consistent domain name across multiple hosts. + + .. versionchanged:: 3.2 + Added the *domain* keyword. + + +The remaining functions are part of the legacy (``Compat32``) email API. There +is no need to directly use these with the new API, since the parsing and +formatting they provide is done automatically by the header parsing machinery +of the new API. + + +.. function:: quote(str) + + Return a new string with backslashes in *str* replaced by two backslashes, and + double quotes replaced by backslash-double quote. + + +.. function:: unquote(str) + + Return a new string which is an *unquoted* version of *str*. If *str* ends and + begins with double quotes, they are stripped off. Likewise if *str* ends and + begins with angle brackets, they are stripped off. + + +.. function:: parseaddr(address) + + Parse address -- which should be the value of some address-containing field such + as :mailheader:`To` or :mailheader:`Cc` -- into its constituent *realname* and + *email address* parts. Returns a tuple of that information, unless the parse + fails, in which case a 2-tuple of ``('', '')`` is returned. + + +.. function:: formataddr(pair, charset='utf-8') + + The inverse of :meth:`parseaddr`, this takes a 2-tuple of the form ``(realname, + email_address)`` and returns the string value suitable for a :mailheader:`To` or + :mailheader:`Cc` header. If the first element of *pair* is false, then the + second element is returned unmodified. + + Optional *charset* is the character set that will be used in the :rfc:`2047` + encoding of the ``realname`` if the ``realname`` contains non-ASCII + characters. Can be an instance of :class:`str` or a + :class:`~email.charset.Charset`. Defaults to ``utf-8``. + + .. versionchanged:: 3.3 + Added the *charset* option. + + +.. function:: getaddresses(fieldvalues) + + This method returns a list of 2-tuples of the form returned by ``parseaddr()``. + *fieldvalues* is a sequence of header field values as might be returned by + :meth:`Message.get_all `. Here's a simple + example that gets all the recipients of a message:: + + from email.utils import getaddresses + + tos = msg.get_all('to', []) + ccs = msg.get_all('cc', []) + resent_tos = msg.get_all('resent-to', []) + resent_ccs = msg.get_all('resent-cc', []) + all_recipients = getaddresses(tos + ccs + resent_tos + resent_ccs) + + +.. function:: parsedate(date) + + Attempts to parse a date according to the rules in :rfc:`2822`. however, some + mailers don't follow that format as specified, so :func:`parsedate` tries to + guess correctly in such cases. *date* is a string containing an :rfc:`2822` + date, such as ``"Mon, 20 Nov 1995 19:12:08 -0500"``. If it succeeds in parsing + the date, :func:`parsedate` returns a 9-tuple that can be passed directly to + :func:`time.mktime`; otherwise ``None`` will be returned. Note that indexes 6, + 7, and 8 of the result tuple are not usable. + + +.. function:: parsedate_tz(date) + + Performs the same function as :func:`parsedate`, but returns either ``None`` or + a 10-tuple; the first 9 elements make up a tuple that can be passed directly to + :func:`time.mktime`, and the tenth is the offset of the date's timezone from UTC + (which is the official term for Greenwich Mean Time) [#]_. If the input string + has no timezone, the last element of the tuple returned is ``None``. Note that + indexes 6, 7, and 8 of the result tuple are not usable. + + +.. function:: parsedate_to_datetime(date) + + The inverse of :func:`format_datetime`. Performs the same function as + :func:`parsedate`, but on success returns a :mod:`~datetime.datetime`. If + the input date has a timezone of ``-0000``, the ``datetime`` will be a naive + ``datetime``, and if the date is conforming to the RFCs it will represent a + time in UTC but with no indication of the actual source timezone of the + message the date comes from. If the input date has any other valid timezone + offset, the ``datetime`` will be an aware ``datetime`` with the + corresponding a :class:`~datetime.timezone` :class:`~datetime.tzinfo`. + + .. versionadded:: 3.3 + + +.. function:: mktime_tz(tuple) + + Turn a 10-tuple as returned by :func:`parsedate_tz` into a UTC + timestamp (seconds since the Epoch). If the timezone item in the + tuple is ``None``, assume local time. + + +.. function:: formatdate(timeval=None, localtime=False, usegmt=False) + + Returns a date string as per :rfc:`2822`, e.g.:: + + Fri, 09 Nov 2001 01:08:47 -0000 + + Optional *timeval* if given is a floating point time value as accepted by + :func:`time.gmtime` and :func:`time.localtime`, otherwise the current time is + used. + + Optional *localtime* is a flag that when ``True``, interprets *timeval*, and + returns a date relative to the local timezone instead of UTC, properly taking + daylight savings time into account. The default is ``False`` meaning UTC is + used. + + Optional *usegmt* is a flag that when ``True``, outputs a date string with the + timezone as an ascii string ``GMT``, rather than a numeric ``-0000``. This is + needed for some protocols (such as HTTP). This only applies when *localtime* is + ``False``. The default is ``False``. + + +.. function:: format_datetime(dt, usegmt=False) + + Like ``formatdate``, but the input is a :mod:`datetime` instance. If it is + a naive datetime, it is assumed to be "UTC with no information about the + source timezone", and the conventional ``-0000`` is used for the timezone. + If it is an aware ``datetime``, then the numeric timezone offset is used. + If it is an aware timezone with offset zero, then *usegmt* may be set to + ``True``, in which case the string ``GMT`` is used instead of the numeric + timezone offset. This provides a way to generate standards conformant HTTP + date headers. + + .. versionadded:: 3.3 + + +.. function:: decode_rfc2231(s) + + Decode the string *s* according to :rfc:`2231`. + + +.. function:: encode_rfc2231(s, charset=None, language=None) + + Encode the string *s* according to :rfc:`2231`. Optional *charset* and + *language*, if given is the character set name and language name to use. If + neither is given, *s* is returned as-is. If *charset* is given but *language* + is not, the string is encoded using the empty string for *language*. + + +.. function:: collapse_rfc2231_value(value, errors='replace', fallback_charset='us-ascii') + + When a header parameter is encoded in :rfc:`2231` format, + :meth:`Message.get_param ` may return a + 3-tuple containing the character set, + language, and value. :func:`collapse_rfc2231_value` turns this into a unicode + string. Optional *errors* is passed to the *errors* argument of :class:`str`'s + :func:`~str.encode` method; it defaults to ``'replace'``. Optional + *fallback_charset* specifies the character set to use if the one in the + :rfc:`2231` header is not known by Python; it defaults to ``'us-ascii'``. + + For convenience, if the *value* passed to :func:`collapse_rfc2231_value` is not + a tuple, it should be a string and it is returned unquoted. + + +.. function:: decode_params(params) + + Decode parameters list according to :rfc:`2231`. *params* is a sequence of + 2-tuples containing elements of the form ``(content-type, string-value)``. + + +.. rubric:: Footnotes + +.. [#] Note that the sign of the timezone offset is the opposite of the sign of the + ``time.timezone`` variable for the same timezone; the latter variable follows + the POSIX standard while this module follows :rfc:`2822`. diff --git a/python-3.7.4-docs-html/_sources/library/ensurepip.rst.txt b/python-3.7.4-docs-html/_sources/library/ensurepip.rst.txt new file mode 100644 index 0000000..c797f63 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/ensurepip.rst.txt @@ -0,0 +1,133 @@ +:mod:`ensurepip` --- Bootstrapping the ``pip`` installer +======================================================== + +.. module:: ensurepip + :synopsis: Bootstrapping the "pip" installer into an existing Python + installation or virtual environment. + +.. versionadded:: 3.4 + +-------------- + +The :mod:`ensurepip` package provides support for bootstrapping the ``pip`` +installer into an existing Python installation or virtual environment. This +bootstrapping approach reflects the fact that ``pip`` is an independent +project with its own release cycle, and the latest available stable version +is bundled with maintenance and feature releases of the CPython reference +interpreter. + +In most cases, end users of Python shouldn't need to invoke this module +directly (as ``pip`` should be bootstrapped by default), but it may be +needed if installing ``pip`` was skipped when installing Python (or +when creating a virtual environment) or after explicitly uninstalling +``pip``. + +.. note:: + + This module *does not* access the internet. All of the components + needed to bootstrap ``pip`` are included as internal parts of the + package. + +.. seealso:: + + :ref:`installing-index` + The end user guide for installing Python packages + + :pep:`453`: Explicit bootstrapping of pip in Python installations + The original rationale and specification for this module. + + +Command line interface +---------------------- + +The command line interface is invoked using the interpreter's ``-m`` switch. + +The simplest possible invocation is:: + + python -m ensurepip + +This invocation will install ``pip`` if it is not already installed, +but otherwise does nothing. To ensure the installed version of ``pip`` +is at least as recent as the one bundled with ``ensurepip``, pass the +``--upgrade`` option:: + + python -m ensurepip --upgrade + +By default, ``pip`` is installed into the current virtual environment +(if one is active) or into the system site packages (if there is no +active virtual environment). The installation location can be controlled +through two additional command line options: + +* ``--root ``: Installs ``pip`` relative to the given root directory + rather than the root of the currently active virtual environment (if any) + or the default root for the current Python installation. +* ``--user``: Installs ``pip`` into the user site packages directory rather + than globally for the current Python installation (this option is not + permitted inside an active virtual environment). + +By default, the scripts ``pipX`` and ``pipX.Y`` will be installed (where +X.Y stands for the version of Python used to invoke ``ensurepip``). The +scripts installed can be controlled through two additional command line +options: + +* ``--altinstall``: if an alternate installation is requested, the ``pipX`` + script will *not* be installed. + +* ``--default-pip``: if a "default pip" installation is requested, the + ``pip`` script will be installed in addition to the two regular scripts. + +Providing both of the script selection options will trigger an exception. + + +Module API +---------- + +:mod:`ensurepip` exposes two functions for programmatic use: + +.. function:: version() + + Returns a string specifying the bundled version of pip that will be + installed when bootstrapping an environment. + +.. function:: bootstrap(root=None, upgrade=False, user=False, \ + altinstall=False, default_pip=False, \ + verbosity=0) + + Bootstraps ``pip`` into the current or designated environment. + + *root* specifies an alternative root directory to install relative to. + If *root* is ``None``, then installation uses the default install location + for the current environment. + + *upgrade* indicates whether or not to upgrade an existing installation + of an earlier version of ``pip`` to the bundled version. + + *user* indicates whether to use the user scheme rather than installing + globally. + + By default, the scripts ``pipX`` and ``pipX.Y`` will be installed (where + X.Y stands for the current version of Python). + + If *altinstall* is set, then ``pipX`` will *not* be installed. + + If *default_pip* is set, then ``pip`` will be installed in addition to + the two regular scripts. + + Setting both *altinstall* and *default_pip* will trigger + :exc:`ValueError`. + + *verbosity* controls the level of output to :data:`sys.stdout` from the + bootstrapping operation. + + .. note:: + + The bootstrapping process has side effects on both ``sys.path`` and + ``os.environ``. Invoking the command line interface in a subprocess + instead allows these side effects to be avoided. + + .. note:: + + The bootstrapping process may install additional modules required by + ``pip``, but other software should not assume those dependencies will + always be present by default (as the dependencies may be removed in a + future version of ``pip``). diff --git a/python-3.7.4-docs-html/_sources/library/enum.rst.txt b/python-3.7.4-docs-html/_sources/library/enum.rst.txt new file mode 100644 index 0000000..a6285ff --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/enum.rst.txt @@ -0,0 +1,1124 @@ +:mod:`enum` --- Support for enumerations +======================================== + +.. module:: enum + :synopsis: Implementation of an enumeration class. + +.. moduleauthor:: Ethan Furman +.. sectionauthor:: Barry Warsaw +.. sectionauthor:: Eli Bendersky +.. sectionauthor:: Ethan Furman + +.. versionadded:: 3.4 + +**Source code:** :source:`Lib/enum.py` + +---------------- + +An enumeration is a set of symbolic names (members) bound to unique, +constant values. Within an enumeration, the members can be compared +by identity, and the enumeration itself can be iterated over. + + +Module Contents +--------------- + +This module defines four enumeration classes that can be used to define unique +sets of names and values: :class:`Enum`, :class:`IntEnum`, :class:`Flag`, and +:class:`IntFlag`. It also defines one decorator, :func:`unique`, and one +helper, :class:`auto`. + +.. class:: Enum + + Base class for creating enumerated constants. See section + `Functional API`_ for an alternate construction syntax. + +.. class:: IntEnum + + Base class for creating enumerated constants that are also + subclasses of :class:`int`. + +.. class:: IntFlag + + Base class for creating enumerated constants that can be combined using + the bitwise operators without losing their :class:`IntFlag` membership. + :class:`IntFlag` members are also subclasses of :class:`int`. + +.. class:: Flag + + Base class for creating enumerated constants that can be combined using + the bitwise operations without losing their :class:`Flag` membership. + +.. function:: unique + + Enum class decorator that ensures only one name is bound to any one value. + +.. class:: auto + + Instances are replaced with an appropriate value for Enum members. + +.. versionadded:: 3.6 ``Flag``, ``IntFlag``, ``auto`` + + +Creating an Enum +---------------- + +Enumerations are created using the :keyword:`class` syntax, which makes them +easy to read and write. An alternative creation method is described in +`Functional API`_. To define an enumeration, subclass :class:`Enum` as +follows:: + + >>> from enum import Enum + >>> class Color(Enum): + ... RED = 1 + ... GREEN = 2 + ... BLUE = 3 + ... + +.. note:: Enum member values + + Member values can be anything: :class:`int`, :class:`str`, etc.. If + the exact value is unimportant you may use :class:`auto` instances and an + appropriate value will be chosen for you. Care must be taken if you mix + :class:`auto` with other values. + +.. note:: Nomenclature + + - The class :class:`Color` is an *enumeration* (or *enum*) + - The attributes :attr:`Color.RED`, :attr:`Color.GREEN`, etc., are + *enumeration members* (or *enum members*) and are functionally constants. + - The enum members have *names* and *values* (the name of + :attr:`Color.RED` is ``RED``, the value of :attr:`Color.BLUE` is + ``3``, etc.) + +.. note:: + + Even though we use the :keyword:`class` syntax to create Enums, Enums + are not normal Python classes. See `How are Enums different?`_ for + more details. + +Enumeration members have human readable string representations:: + + >>> print(Color.RED) + Color.RED + +...while their ``repr`` has more information:: + + >>> print(repr(Color.RED)) + + +The *type* of an enumeration member is the enumeration it belongs to:: + + >>> type(Color.RED) + + >>> isinstance(Color.GREEN, Color) + True + >>> + +Enum members also have a property that contains just their item name:: + + >>> print(Color.RED.name) + RED + +Enumerations support iteration, in definition order:: + + >>> class Shake(Enum): + ... VANILLA = 7 + ... CHOCOLATE = 4 + ... COOKIES = 9 + ... MINT = 3 + ... + >>> for shake in Shake: + ... print(shake) + ... + Shake.VANILLA + Shake.CHOCOLATE + Shake.COOKIES + Shake.MINT + +Enumeration members are hashable, so they can be used in dictionaries and sets:: + + >>> apples = {} + >>> apples[Color.RED] = 'red delicious' + >>> apples[Color.GREEN] = 'granny smith' + >>> apples == {Color.RED: 'red delicious', Color.GREEN: 'granny smith'} + True + + +Programmatic access to enumeration members and their attributes +--------------------------------------------------------------- + +Sometimes it's useful to access members in enumerations programmatically (i.e. +situations where ``Color.RED`` won't do because the exact color is not known +at program-writing time). ``Enum`` allows such access:: + + >>> Color(1) + + >>> Color(3) + + +If you want to access enum members by *name*, use item access:: + + >>> Color['RED'] + + >>> Color['GREEN'] + + +If you have an enum member and need its :attr:`name` or :attr:`value`:: + + >>> member = Color.RED + >>> member.name + 'RED' + >>> member.value + 1 + + +Duplicating enum members and values +----------------------------------- + +Having two enum members with the same name is invalid:: + + >>> class Shape(Enum): + ... SQUARE = 2 + ... SQUARE = 3 + ... + Traceback (most recent call last): + ... + TypeError: Attempted to reuse key: 'SQUARE' + +However, two enum members are allowed to have the same value. Given two members +A and B with the same value (and A defined first), B is an alias to A. By-value +lookup of the value of A and B will return A. By-name lookup of B will also +return A:: + + >>> class Shape(Enum): + ... SQUARE = 2 + ... DIAMOND = 1 + ... CIRCLE = 3 + ... ALIAS_FOR_SQUARE = 2 + ... + >>> Shape.SQUARE + + >>> Shape.ALIAS_FOR_SQUARE + + >>> Shape(2) + + +.. note:: + + Attempting to create a member with the same name as an already + defined attribute (another member, a method, etc.) or attempting to create + an attribute with the same name as a member is not allowed. + + +Ensuring unique enumeration values +---------------------------------- + +By default, enumerations allow multiple names as aliases for the same value. +When this behavior isn't desired, the following decorator can be used to +ensure each value is used only once in the enumeration: + +.. decorator:: unique + +A :keyword:`class` decorator specifically for enumerations. It searches an +enumeration's :attr:`__members__` gathering any aliases it finds; if any are +found :exc:`ValueError` is raised with the details:: + + >>> from enum import Enum, unique + >>> @unique + ... class Mistake(Enum): + ... ONE = 1 + ... TWO = 2 + ... THREE = 3 + ... FOUR = 3 + ... + Traceback (most recent call last): + ... + ValueError: duplicate values found in : FOUR -> THREE + + +Using automatic values +---------------------- + +If the exact value is unimportant you can use :class:`auto`:: + + >>> from enum import Enum, auto + >>> class Color(Enum): + ... RED = auto() + ... BLUE = auto() + ... GREEN = auto() + ... + >>> list(Color) + [, , ] + +The values are chosen by :func:`_generate_next_value_`, which can be +overridden:: + + >>> class AutoName(Enum): + ... def _generate_next_value_(name, start, count, last_values): + ... return name + ... + >>> class Ordinal(AutoName): + ... NORTH = auto() + ... SOUTH = auto() + ... EAST = auto() + ... WEST = auto() + ... + >>> list(Ordinal) + [, , , ] + +.. note:: + + The goal of the default :meth:`_generate_next_value_` methods is to provide + the next :class:`int` in sequence with the last :class:`int` provided, but + the way it does this is an implementation detail and may change. + +Iteration +--------- + +Iterating over the members of an enum does not provide the aliases:: + + >>> list(Shape) + [, , ] + +The special attribute ``__members__`` is an ordered dictionary mapping names +to members. It includes all names defined in the enumeration, including the +aliases:: + + >>> for name, member in Shape.__members__.items(): + ... name, member + ... + ('SQUARE', ) + ('DIAMOND', ) + ('CIRCLE', ) + ('ALIAS_FOR_SQUARE', ) + +The ``__members__`` attribute can be used for detailed programmatic access to +the enumeration members. For example, finding all the aliases:: + + >>> [name for name, member in Shape.__members__.items() if member.name != name] + ['ALIAS_FOR_SQUARE'] + + +Comparisons +----------- + +Enumeration members are compared by identity:: + + >>> Color.RED is Color.RED + True + >>> Color.RED is Color.BLUE + False + >>> Color.RED is not Color.BLUE + True + +Ordered comparisons between enumeration values are *not* supported. Enum +members are not integers (but see `IntEnum`_ below):: + + >>> Color.RED < Color.BLUE + Traceback (most recent call last): + File "", line 1, in + TypeError: '<' not supported between instances of 'Color' and 'Color' + +Equality comparisons are defined though:: + + >>> Color.BLUE == Color.RED + False + >>> Color.BLUE != Color.RED + True + >>> Color.BLUE == Color.BLUE + True + +Comparisons against non-enumeration values will always compare not equal +(again, :class:`IntEnum` was explicitly designed to behave differently, see +below):: + + >>> Color.BLUE == 2 + False + + +Allowed members and attributes of enumerations +---------------------------------------------- + +The examples above use integers for enumeration values. Using integers is +short and handy (and provided by default by the `Functional API`_), but not +strictly enforced. In the vast majority of use-cases, one doesn't care what +the actual value of an enumeration is. But if the value *is* important, +enumerations can have arbitrary values. + +Enumerations are Python classes, and can have methods and special methods as +usual. If we have this enumeration:: + + >>> class Mood(Enum): + ... FUNKY = 1 + ... HAPPY = 3 + ... + ... def describe(self): + ... # self is the member here + ... return self.name, self.value + ... + ... def __str__(self): + ... return 'my custom str! {0}'.format(self.value) + ... + ... @classmethod + ... def favorite_mood(cls): + ... # cls here is the enumeration + ... return cls.HAPPY + ... + +Then:: + + >>> Mood.favorite_mood() + + >>> Mood.HAPPY.describe() + ('HAPPY', 3) + >>> str(Mood.FUNKY) + 'my custom str! 1' + +The rules for what is allowed are as follows: names that start and end with +a single underscore are reserved by enum and cannot be used; all other +attributes defined within an enumeration will become members of this +enumeration, with the exception of special methods (:meth:`__str__`, +:meth:`__add__`, etc.), descriptors (methods are also descriptors), and +variable names listed in :attr:`_ignore_`. + +Note: if your enumeration defines :meth:`__new__` and/or :meth:`__init__` then +whatever value(s) were given to the enum member will be passed into those +methods. See `Planet`_ for an example. + + +Restricted Enum subclassing +--------------------------- + +A new :class:`Enum` class must have one base Enum class, up to one concrete +data type, and as many :class:`object`-based mixin classes as needed. The +order of these base classes is:: + + class EnumName([mix-in, ...,] [data-type,] base-enum): + pass + +Also, subclassing an enumeration is allowed only if the enumeration does not define +any members. So this is forbidden:: + + >>> class MoreColor(Color): + ... PINK = 17 + ... + Traceback (most recent call last): + ... + TypeError: Cannot extend enumerations + +But this is allowed:: + + >>> class Foo(Enum): + ... def some_behavior(self): + ... pass + ... + >>> class Bar(Foo): + ... HAPPY = 1 + ... SAD = 2 + ... + +Allowing subclassing of enums that define members would lead to a violation of +some important invariants of types and instances. On the other hand, it makes +sense to allow sharing some common behavior between a group of enumerations. +(See `OrderedEnum`_ for an example.) + + +Pickling +-------- + +Enumerations can be pickled and unpickled:: + + >>> from test.test_enum import Fruit + >>> from pickle import dumps, loads + >>> Fruit.TOMATO is loads(dumps(Fruit.TOMATO)) + True + +The usual restrictions for pickling apply: picklable enums must be defined in +the top level of a module, since unpickling requires them to be importable +from that module. + +.. note:: + + With pickle protocol version 4 it is possible to easily pickle enums + nested in other classes. + +It is possible to modify how Enum members are pickled/unpickled by defining +:meth:`__reduce_ex__` in the enumeration class. + + +Functional API +-------------- + +The :class:`Enum` class is callable, providing the following functional API:: + + >>> Animal = Enum('Animal', 'ANT BEE CAT DOG') + >>> Animal + + >>> Animal.ANT + + >>> Animal.ANT.value + 1 + >>> list(Animal) + [, , , ] + +The semantics of this API resemble :class:`~collections.namedtuple`. The first +argument of the call to :class:`Enum` is the name of the enumeration. + +The second argument is the *source* of enumeration member names. It can be a +whitespace-separated string of names, a sequence of names, a sequence of +2-tuples with key/value pairs, or a mapping (e.g. dictionary) of names to +values. The last two options enable assigning arbitrary values to +enumerations; the others auto-assign increasing integers starting with 1 (use +the ``start`` parameter to specify a different starting value). A +new class derived from :class:`Enum` is returned. In other words, the above +assignment to :class:`Animal` is equivalent to:: + + >>> class Animal(Enum): + ... ANT = 1 + ... BEE = 2 + ... CAT = 3 + ... DOG = 4 + ... + +The reason for defaulting to ``1`` as the starting number and not ``0`` is +that ``0`` is ``False`` in a boolean sense, but enum members all evaluate +to ``True``. + +Pickling enums created with the functional API can be tricky as frame stack +implementation details are used to try and figure out which module the +enumeration is being created in (e.g. it will fail if you use a utility +function in separate module, and also may not work on IronPython or Jython). +The solution is to specify the module name explicitly as follows:: + + >>> Animal = Enum('Animal', 'ANT BEE CAT DOG', module=__name__) + +.. warning:: + + If ``module`` is not supplied, and Enum cannot determine what it is, + the new Enum members will not be unpicklable; to keep errors closer to + the source, pickling will be disabled. + +The new pickle protocol 4 also, in some circumstances, relies on +:attr:`~definition.__qualname__` being set to the location where pickle will be able +to find the class. For example, if the class was made available in class +SomeData in the global scope:: + + >>> Animal = Enum('Animal', 'ANT BEE CAT DOG', qualname='SomeData.Animal') + +The complete signature is:: + + Enum(value='NewEnumName', names=<...>, *, module='...', qualname='...', type=, start=1) + +:value: What the new Enum class will record as its name. + +:names: The Enum members. This can be a whitespace or comma separated string + (values will start at 1 unless otherwise specified):: + + 'RED GREEN BLUE' | 'RED,GREEN,BLUE' | 'RED, GREEN, BLUE' + + or an iterator of names:: + + ['RED', 'GREEN', 'BLUE'] + + or an iterator of (name, value) pairs:: + + [('CYAN', 4), ('MAGENTA', 5), ('YELLOW', 6)] + + or a mapping:: + + {'CHARTREUSE': 7, 'SEA_GREEN': 11, 'ROSEMARY': 42} + +:module: name of module where new Enum class can be found. + +:qualname: where in module new Enum class can be found. + +:type: type to mix in to new Enum class. + +:start: number to start counting at if only names are passed in. + +.. versionchanged:: 3.5 + The *start* parameter was added. + + +Derived Enumerations +-------------------- + +IntEnum +^^^^^^^ + +The first variation of :class:`Enum` that is provided is also a subclass of +:class:`int`. Members of an :class:`IntEnum` can be compared to integers; +by extension, integer enumerations of different types can also be compared +to each other:: + + >>> from enum import IntEnum + >>> class Shape(IntEnum): + ... CIRCLE = 1 + ... SQUARE = 2 + ... + >>> class Request(IntEnum): + ... POST = 1 + ... GET = 2 + ... + >>> Shape == 1 + False + >>> Shape.CIRCLE == 1 + True + >>> Shape.CIRCLE == Request.POST + True + +However, they still can't be compared to standard :class:`Enum` enumerations:: + + >>> class Shape(IntEnum): + ... CIRCLE = 1 + ... SQUARE = 2 + ... + >>> class Color(Enum): + ... RED = 1 + ... GREEN = 2 + ... + >>> Shape.CIRCLE == Color.RED + False + +:class:`IntEnum` values behave like integers in other ways you'd expect:: + + >>> int(Shape.CIRCLE) + 1 + >>> ['a', 'b', 'c'][Shape.CIRCLE] + 'b' + >>> [i for i in range(Shape.SQUARE)] + [0, 1] + + +IntFlag +^^^^^^^ + +The next variation of :class:`Enum` provided, :class:`IntFlag`, is also based +on :class:`int`. The difference being :class:`IntFlag` members can be combined +using the bitwise operators (&, \|, ^, ~) and the result is still an +:class:`IntFlag` member. However, as the name implies, :class:`IntFlag` +members also subclass :class:`int` and can be used wherever an :class:`int` is +used. Any operation on an :class:`IntFlag` member besides the bit-wise +operations will lose the :class:`IntFlag` membership. + +.. versionadded:: 3.6 + +Sample :class:`IntFlag` class:: + + >>> from enum import IntFlag + >>> class Perm(IntFlag): + ... R = 4 + ... W = 2 + ... X = 1 + ... + >>> Perm.R | Perm.W + + >>> Perm.R + Perm.W + 6 + >>> RW = Perm.R | Perm.W + >>> Perm.R in RW + True + +It is also possible to name the combinations:: + + >>> class Perm(IntFlag): + ... R = 4 + ... W = 2 + ... X = 1 + ... RWX = 7 + >>> Perm.RWX + + >>> ~Perm.RWX + + +Another important difference between :class:`IntFlag` and :class:`Enum` is that +if no flags are set (the value is 0), its boolean evaluation is :data:`False`:: + + >>> Perm.R & Perm.X + + >>> bool(Perm.R & Perm.X) + False + +Because :class:`IntFlag` members are also subclasses of :class:`int` they can +be combined with them:: + + >>> Perm.X | 8 + + + +Flag +^^^^ + +The last variation is :class:`Flag`. Like :class:`IntFlag`, :class:`Flag` +members can be combined using the bitwise operators (&, \|, ^, ~). Unlike +:class:`IntFlag`, they cannot be combined with, nor compared against, any +other :class:`Flag` enumeration, nor :class:`int`. While it is possible to +specify the values directly it is recommended to use :class:`auto` as the +value and let :class:`Flag` select an appropriate value. + +.. versionadded:: 3.6 + +Like :class:`IntFlag`, if a combination of :class:`Flag` members results in no +flags being set, the boolean evaluation is :data:`False`:: + + >>> from enum import Flag, auto + >>> class Color(Flag): + ... RED = auto() + ... BLUE = auto() + ... GREEN = auto() + ... + >>> Color.RED & Color.GREEN + + >>> bool(Color.RED & Color.GREEN) + False + +Individual flags should have values that are powers of two (1, 2, 4, 8, ...), +while combinations of flags won't:: + + >>> class Color(Flag): + ... RED = auto() + ... BLUE = auto() + ... GREEN = auto() + ... WHITE = RED | BLUE | GREEN + ... + >>> Color.WHITE + + +Giving a name to the "no flags set" condition does not change its boolean +value:: + + >>> class Color(Flag): + ... BLACK = 0 + ... RED = auto() + ... BLUE = auto() + ... GREEN = auto() + ... + >>> Color.BLACK + + >>> bool(Color.BLACK) + False + +.. note:: + + For the majority of new code, :class:`Enum` and :class:`Flag` are strongly + recommended, since :class:`IntEnum` and :class:`IntFlag` break some + semantic promises of an enumeration (by being comparable to integers, and + thus by transitivity to other unrelated enumerations). :class:`IntEnum` + and :class:`IntFlag` should be used only in cases where :class:`Enum` and + :class:`Flag` will not do; for example, when integer constants are replaced + with enumerations, or for interoperability with other systems. + + +Others +^^^^^^ + +While :class:`IntEnum` is part of the :mod:`enum` module, it would be very +simple to implement independently:: + + class IntEnum(int, Enum): + pass + +This demonstrates how similar derived enumerations can be defined; for example +a :class:`StrEnum` that mixes in :class:`str` instead of :class:`int`. + +Some rules: + +1. When subclassing :class:`Enum`, mix-in types must appear before + :class:`Enum` itself in the sequence of bases, as in the :class:`IntEnum` + example above. +2. While :class:`Enum` can have members of any type, once you mix in an + additional type, all the members must have values of that type, e.g. + :class:`int` above. This restriction does not apply to mix-ins which only + add methods and don't specify another data type such as :class:`int` or + :class:`str`. +3. When another data type is mixed in, the :attr:`value` attribute is *not the + same* as the enum member itself, although it is equivalent and will compare + equal. +4. %-style formatting: `%s` and `%r` call the :class:`Enum` class's + :meth:`__str__` and :meth:`__repr__` respectively; other codes (such as + `%i` or `%h` for IntEnum) treat the enum member as its mixed-in type. +5. :ref:`Formatted string literals `, :meth:`str.format`, + and :func:`format` will use the mixed-in + type's :meth:`__format__`. If the :class:`Enum` class's :func:`str` or + :func:`repr` is desired, use the `!s` or `!r` format codes. + + +Interesting examples +-------------------- + +While :class:`Enum`, :class:`IntEnum`, :class:`IntFlag`, and :class:`Flag` are +expected to cover the majority of use-cases, they cannot cover them all. Here +are recipes for some different types of enumerations that can be used directly, +or as examples for creating one's own. + + +Omitting values +^^^^^^^^^^^^^^^ + +In many use-cases one doesn't care what the actual value of an enumeration +is. There are several ways to define this type of simple enumeration: + +- use instances of :class:`auto` for the value +- use instances of :class:`object` as the value +- use a descriptive string as the value +- use a tuple as the value and a custom :meth:`__new__` to replace the + tuple with an :class:`int` value + +Using any of these methods signifies to the user that these values are not +important, and also enables one to add, remove, or reorder members without +having to renumber the remaining members. + +Whichever method you choose, you should provide a :meth:`repr` that also hides +the (unimportant) value:: + + >>> class NoValue(Enum): + ... def __repr__(self): + ... return '<%s.%s>' % (self.__class__.__name__, self.name) + ... + + +Using :class:`auto` +""""""""""""""""""" + +Using :class:`auto` would look like:: + + >>> class Color(NoValue): + ... RED = auto() + ... BLUE = auto() + ... GREEN = auto() + ... + >>> Color.GREEN + + + +Using :class:`object` +""""""""""""""""""""" + +Using :class:`object` would look like:: + + >>> class Color(NoValue): + ... RED = object() + ... GREEN = object() + ... BLUE = object() + ... + >>> Color.GREEN + + + +Using a descriptive string +"""""""""""""""""""""""""" + +Using a string as the value would look like:: + + >>> class Color(NoValue): + ... RED = 'stop' + ... GREEN = 'go' + ... BLUE = 'too fast!' + ... + >>> Color.GREEN + + >>> Color.GREEN.value + 'go' + + +Using a custom :meth:`__new__` +"""""""""""""""""""""""""""""" + +Using an auto-numbering :meth:`__new__` would look like:: + + >>> class AutoNumber(NoValue): + ... def __new__(cls): + ... value = len(cls.__members__) + 1 + ... obj = object.__new__(cls) + ... obj._value_ = value + ... return obj + ... + >>> class Color(AutoNumber): + ... RED = () + ... GREEN = () + ... BLUE = () + ... + >>> Color.GREEN + + >>> Color.GREEN.value + 2 + + +.. note:: + + The :meth:`__new__` method, if defined, is used during creation of the Enum + members; it is then replaced by Enum's :meth:`__new__` which is used after + class creation for lookup of existing members. + + +OrderedEnum +^^^^^^^^^^^ + +An ordered enumeration that is not based on :class:`IntEnum` and so maintains +the normal :class:`Enum` invariants (such as not being comparable to other +enumerations):: + + >>> class OrderedEnum(Enum): + ... def __ge__(self, other): + ... if self.__class__ is other.__class__: + ... return self.value >= other.value + ... return NotImplemented + ... def __gt__(self, other): + ... if self.__class__ is other.__class__: + ... return self.value > other.value + ... return NotImplemented + ... def __le__(self, other): + ... if self.__class__ is other.__class__: + ... return self.value <= other.value + ... return NotImplemented + ... def __lt__(self, other): + ... if self.__class__ is other.__class__: + ... return self.value < other.value + ... return NotImplemented + ... + >>> class Grade(OrderedEnum): + ... A = 5 + ... B = 4 + ... C = 3 + ... D = 2 + ... F = 1 + ... + >>> Grade.C < Grade.A + True + + +DuplicateFreeEnum +^^^^^^^^^^^^^^^^^ + +Raises an error if a duplicate member name is found instead of creating an +alias:: + + >>> class DuplicateFreeEnum(Enum): + ... def __init__(self, *args): + ... cls = self.__class__ + ... if any(self.value == e.value for e in cls): + ... a = self.name + ... e = cls(self.value).name + ... raise ValueError( + ... "aliases not allowed in DuplicateFreeEnum: %r --> %r" + ... % (a, e)) + ... + >>> class Color(DuplicateFreeEnum): + ... RED = 1 + ... GREEN = 2 + ... BLUE = 3 + ... GRENE = 2 + ... + Traceback (most recent call last): + ... + ValueError: aliases not allowed in DuplicateFreeEnum: 'GRENE' --> 'GREEN' + +.. note:: + + This is a useful example for subclassing Enum to add or change other + behaviors as well as disallowing aliases. If the only desired change is + disallowing aliases, the :func:`unique` decorator can be used instead. + + +Planet +^^^^^^ + +If :meth:`__new__` or :meth:`__init__` is defined the value of the enum member +will be passed to those methods:: + + >>> class Planet(Enum): + ... MERCURY = (3.303e+23, 2.4397e6) + ... VENUS = (4.869e+24, 6.0518e6) + ... EARTH = (5.976e+24, 6.37814e6) + ... MARS = (6.421e+23, 3.3972e6) + ... JUPITER = (1.9e+27, 7.1492e7) + ... SATURN = (5.688e+26, 6.0268e7) + ... URANUS = (8.686e+25, 2.5559e7) + ... NEPTUNE = (1.024e+26, 2.4746e7) + ... def __init__(self, mass, radius): + ... self.mass = mass # in kilograms + ... self.radius = radius # in meters + ... @property + ... def surface_gravity(self): + ... # universal gravitational constant (m3 kg-1 s-2) + ... G = 6.67300E-11 + ... return G * self.mass / (self.radius * self.radius) + ... + >>> Planet.EARTH.value + (5.976e+24, 6378140.0) + >>> Planet.EARTH.surface_gravity + 9.802652743337129 + + +TimePeriod +^^^^^^^^^^ + +An example to show the :attr:`_ignore_` attribute in use:: + + >>> from datetime import timedelta + >>> class Period(timedelta, Enum): + ... "different lengths of time" + ... _ignore_ = 'Period i' + ... Period = vars() + ... for i in range(367): + ... Period['day_%d' % i] = i + ... + >>> list(Period)[:2] + [, ] + >>> list(Period)[-2:] + [, ] + + +How are Enums different? +------------------------ + +Enums have a custom metaclass that affects many aspects of both derived Enum +classes and their instances (members). + + +Enum Classes +^^^^^^^^^^^^ + +The :class:`EnumMeta` metaclass is responsible for providing the +:meth:`__contains__`, :meth:`__dir__`, :meth:`__iter__` and other methods that +allow one to do things with an :class:`Enum` class that fail on a typical +class, such as `list(Color)` or `some_enum_var in Color`. :class:`EnumMeta` is +responsible for ensuring that various other methods on the final :class:`Enum` +class are correct (such as :meth:`__new__`, :meth:`__getnewargs__`, +:meth:`__str__` and :meth:`__repr__`). + + +Enum Members (aka instances) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The most interesting thing about Enum members is that they are singletons. +:class:`EnumMeta` creates them all while it is creating the :class:`Enum` +class itself, and then puts a custom :meth:`__new__` in place to ensure +that no new ones are ever instantiated by returning only the existing +member instances. + + +Finer Points +^^^^^^^^^^^^ + +Supported ``__dunder__`` names +"""""""""""""""""""""""""""""" + +:attr:`__members__` is an :class:`OrderedDict` of ``member_name``:``member`` +items. It is only available on the class. + +:meth:`__new__`, if specified, must create and return the enum members; it is +also a very good idea to set the member's :attr:`_value_` appropriately. Once +all the members are created it is no longer used. + + +Supported ``_sunder_`` names +"""""""""""""""""""""""""""" + +- ``_name_`` -- name of the member +- ``_value_`` -- value of the member; can be set / modified in ``__new__`` + +- ``_missing_`` -- a lookup function used when a value is not found; may be + overridden +- ``_ignore_`` -- a list of names, either as a :func:`list` or a :func:`str`, + that will not be transformed into members, and will be removed from the final + class +- ``_order_`` -- used in Python 2/3 code to ensure member order is consistent + (class attribute, removed during class creation) +- ``_generate_next_value_`` -- used by the `Functional API`_ and by + :class:`auto` to get an appropriate value for an enum member; may be + overridden + +.. versionadded:: 3.6 ``_missing_``, ``_order_``, ``_generate_next_value_`` +.. versionadded:: 3.7 ``_ignore_`` + +To help keep Python 2 / Python 3 code in sync an :attr:`_order_` attribute can +be provided. It will be checked against the actual order of the enumeration +and raise an error if the two do not match:: + + >>> class Color(Enum): + ... _order_ = 'RED GREEN BLUE' + ... RED = 1 + ... BLUE = 3 + ... GREEN = 2 + ... + Traceback (most recent call last): + ... + TypeError: member order does not match _order_ + +.. note:: + + In Python 2 code the :attr:`_order_` attribute is necessary as definition + order is lost before it can be recorded. + +``Enum`` member type +"""""""""""""""""""" + +:class:`Enum` members are instances of their :class:`Enum` class, and are +normally accessed as ``EnumClass.member``. Under certain circumstances they +can also be accessed as ``EnumClass.member.member``, but you should never do +this as that lookup may fail or, worse, return something besides the +:class:`Enum` member you are looking for (this is another good reason to use +all-uppercase names for members):: + + >>> class FieldTypes(Enum): + ... name = 0 + ... value = 1 + ... size = 2 + ... + >>> FieldTypes.value.size + + >>> FieldTypes.size.value + 2 + +.. versionchanged:: 3.5 + + +Boolean value of ``Enum`` classes and members +""""""""""""""""""""""""""""""""""""""""""""" + +:class:`Enum` members that are mixed with non-:class:`Enum` types (such as +:class:`int`, :class:`str`, etc.) are evaluated according to the mixed-in +type's rules; otherwise, all members evaluate as :data:`True`. To make your +own Enum's boolean evaluation depend on the member's value add the following to +your class:: + + def __bool__(self): + return bool(self.value) + +:class:`Enum` classes always evaluate as :data:`True`. + + +``Enum`` classes with methods +""""""""""""""""""""""""""""" + +If you give your :class:`Enum` subclass extra methods, like the `Planet`_ +class above, those methods will show up in a :func:`dir` of the member, +but not of the class:: + + >>> dir(Planet) + ['EARTH', 'JUPITER', 'MARS', 'MERCURY', 'NEPTUNE', 'SATURN', 'URANUS', 'VENUS', '__class__', '__doc__', '__members__', '__module__'] + >>> dir(Planet.EARTH) + ['__class__', '__doc__', '__module__', 'name', 'surface_gravity', 'value'] + + +Combining members of ``Flag`` +""""""""""""""""""""""""""""" + +If a combination of Flag members is not named, the :func:`repr` will include +all named flags and all named combinations of flags that are in the value:: + + >>> class Color(Flag): + ... RED = auto() + ... GREEN = auto() + ... BLUE = auto() + ... MAGENTA = RED | BLUE + ... YELLOW = RED | GREEN + ... CYAN = GREEN | BLUE + ... + >>> Color(3) # named combination + + >>> Color(7) # not named combination + + diff --git a/python-3.7.4-docs-html/_sources/library/errno.rst.txt b/python-3.7.4-docs-html/_sources/library/errno.rst.txt new file mode 100644 index 0000000..1cbd51c --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/errno.rst.txt @@ -0,0 +1,639 @@ +:mod:`errno` --- Standard errno system symbols +============================================== + +.. module:: errno + :synopsis: Standard errno system symbols. + +---------------- + +This module makes available standard ``errno`` system symbols. The value of each +symbol is the corresponding integer value. The names and descriptions are +borrowed from :file:`linux/include/errno.h`, which should be pretty +all-inclusive. + + +.. data:: errorcode + + Dictionary providing a mapping from the errno value to the string name in the + underlying system. For instance, ``errno.errorcode[errno.EPERM]`` maps to + ``'EPERM'``. + +To translate a numeric error code to an error message, use :func:`os.strerror`. + +Of the following list, symbols that are not used on the current platform are not +defined by the module. The specific list of defined symbols is available as +``errno.errorcode.keys()``. Symbols available can include: + + +.. data:: EPERM + + Operation not permitted + + +.. data:: ENOENT + + No such file or directory + + +.. data:: ESRCH + + No such process + + +.. data:: EINTR + + Interrupted system call. + + .. seealso:: + This error is mapped to the exception :exc:`InterruptedError`. + + +.. data:: EIO + + I/O error + + +.. data:: ENXIO + + No such device or address + + +.. data:: E2BIG + + Arg list too long + + +.. data:: ENOEXEC + + Exec format error + + +.. data:: EBADF + + Bad file number + + +.. data:: ECHILD + + No child processes + + +.. data:: EAGAIN + + Try again + + +.. data:: ENOMEM + + Out of memory + + +.. data:: EACCES + + Permission denied + + +.. data:: EFAULT + + Bad address + + +.. data:: ENOTBLK + + Block device required + + +.. data:: EBUSY + + Device or resource busy + + +.. data:: EEXIST + + File exists + + +.. data:: EXDEV + + Cross-device link + + +.. data:: ENODEV + + No such device + + +.. data:: ENOTDIR + + Not a directory + + +.. data:: EISDIR + + Is a directory + + +.. data:: EINVAL + + Invalid argument + + +.. data:: ENFILE + + File table overflow + + +.. data:: EMFILE + + Too many open files + + +.. data:: ENOTTY + + Not a typewriter + + +.. data:: ETXTBSY + + Text file busy + + +.. data:: EFBIG + + File too large + + +.. data:: ENOSPC + + No space left on device + + +.. data:: ESPIPE + + Illegal seek + + +.. data:: EROFS + + Read-only file system + + +.. data:: EMLINK + + Too many links + + +.. data:: EPIPE + + Broken pipe + + +.. data:: EDOM + + Math argument out of domain of func + + +.. data:: ERANGE + + Math result not representable + + +.. data:: EDEADLK + + Resource deadlock would occur + + +.. data:: ENAMETOOLONG + + File name too long + + +.. data:: ENOLCK + + No record locks available + + +.. data:: ENOSYS + + Function not implemented + + +.. data:: ENOTEMPTY + + Directory not empty + + +.. data:: ELOOP + + Too many symbolic links encountered + + +.. data:: EWOULDBLOCK + + Operation would block + + +.. data:: ENOMSG + + No message of desired type + + +.. data:: EIDRM + + Identifier removed + + +.. data:: ECHRNG + + Channel number out of range + + +.. data:: EL2NSYNC + + Level 2 not synchronized + + +.. data:: EL3HLT + + Level 3 halted + + +.. data:: EL3RST + + Level 3 reset + + +.. data:: ELNRNG + + Link number out of range + + +.. data:: EUNATCH + + Protocol driver not attached + + +.. data:: ENOCSI + + No CSI structure available + + +.. data:: EL2HLT + + Level 2 halted + + +.. data:: EBADE + + Invalid exchange + + +.. data:: EBADR + + Invalid request descriptor + + +.. data:: EXFULL + + Exchange full + + +.. data:: ENOANO + + No anode + + +.. data:: EBADRQC + + Invalid request code + + +.. data:: EBADSLT + + Invalid slot + + +.. data:: EDEADLOCK + + File locking deadlock error + + +.. data:: EBFONT + + Bad font file format + + +.. data:: ENOSTR + + Device not a stream + + +.. data:: ENODATA + + No data available + + +.. data:: ETIME + + Timer expired + + +.. data:: ENOSR + + Out of streams resources + + +.. data:: ENONET + + Machine is not on the network + + +.. data:: ENOPKG + + Package not installed + + +.. data:: EREMOTE + + Object is remote + + +.. data:: ENOLINK + + Link has been severed + + +.. data:: EADV + + Advertise error + + +.. data:: ESRMNT + + Srmount error + + +.. data:: ECOMM + + Communication error on send + + +.. data:: EPROTO + + Protocol error + + +.. data:: EMULTIHOP + + Multihop attempted + + +.. data:: EDOTDOT + + RFS specific error + + +.. data:: EBADMSG + + Not a data message + + +.. data:: EOVERFLOW + + Value too large for defined data type + + +.. data:: ENOTUNIQ + + Name not unique on network + + +.. data:: EBADFD + + File descriptor in bad state + + +.. data:: EREMCHG + + Remote address changed + + +.. data:: ELIBACC + + Can not access a needed shared library + + +.. data:: ELIBBAD + + Accessing a corrupted shared library + + +.. data:: ELIBSCN + + .lib section in a.out corrupted + + +.. data:: ELIBMAX + + Attempting to link in too many shared libraries + + +.. data:: ELIBEXEC + + Cannot exec a shared library directly + + +.. data:: EILSEQ + + Illegal byte sequence + + +.. data:: ERESTART + + Interrupted system call should be restarted + + +.. data:: ESTRPIPE + + Streams pipe error + + +.. data:: EUSERS + + Too many users + + +.. data:: ENOTSOCK + + Socket operation on non-socket + + +.. data:: EDESTADDRREQ + + Destination address required + + +.. data:: EMSGSIZE + + Message too long + + +.. data:: EPROTOTYPE + + Protocol wrong type for socket + + +.. data:: ENOPROTOOPT + + Protocol not available + + +.. data:: EPROTONOSUPPORT + + Protocol not supported + + +.. data:: ESOCKTNOSUPPORT + + Socket type not supported + + +.. data:: EOPNOTSUPP + + Operation not supported on transport endpoint + + +.. data:: EPFNOSUPPORT + + Protocol family not supported + + +.. data:: EAFNOSUPPORT + + Address family not supported by protocol + + +.. data:: EADDRINUSE + + Address already in use + + +.. data:: EADDRNOTAVAIL + + Cannot assign requested address + + +.. data:: ENETDOWN + + Network is down + + +.. data:: ENETUNREACH + + Network is unreachable + + +.. data:: ENETRESET + + Network dropped connection because of reset + + +.. data:: ECONNABORTED + + Software caused connection abort + + +.. data:: ECONNRESET + + Connection reset by peer + + +.. data:: ENOBUFS + + No buffer space available + + +.. data:: EISCONN + + Transport endpoint is already connected + + +.. data:: ENOTCONN + + Transport endpoint is not connected + + +.. data:: ESHUTDOWN + + Cannot send after transport endpoint shutdown + + +.. data:: ETOOMANYREFS + + Too many references: cannot splice + + +.. data:: ETIMEDOUT + + Connection timed out + + +.. data:: ECONNREFUSED + + Connection refused + + +.. data:: EHOSTDOWN + + Host is down + + +.. data:: EHOSTUNREACH + + No route to host + + +.. data:: EALREADY + + Operation already in progress + + +.. data:: EINPROGRESS + + Operation now in progress + + +.. data:: ESTALE + + Stale NFS file handle + + +.. data:: EUCLEAN + + Structure needs cleaning + + +.. data:: ENOTNAM + + Not a XENIX named type file + + +.. data:: ENAVAIL + + No XENIX semaphores available + + +.. data:: EISNAM + + Is a named type file + + +.. data:: EREMOTEIO + + Remote I/O error + + +.. data:: EDQUOT + + Quota exceeded + diff --git a/python-3.7.4-docs-html/_sources/library/exceptions.rst.txt b/python-3.7.4-docs-html/_sources/library/exceptions.rst.txt new file mode 100644 index 0000000..52a505e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/exceptions.rst.txt @@ -0,0 +1,748 @@ +.. _bltin-exceptions: + +Built-in Exceptions +=================== + +.. index:: + statement: try + statement: except + +In Python, all exceptions must be instances of a class that derives from +:class:`BaseException`. In a :keyword:`try` statement with an :keyword:`except` +clause that mentions a particular class, that clause also handles any exception +classes derived from that class (but not exception classes from which *it* is +derived). Two exception classes that are not related via subclassing are never +equivalent, even if they have the same name. + +.. index:: statement: raise + +The built-in exceptions listed below can be generated by the interpreter or +built-in functions. Except where mentioned, they have an "associated value" +indicating the detailed cause of the error. This may be a string or a tuple of +several items of information (e.g., an error code and a string explaining the +code). The associated value is usually passed as arguments to the exception +class's constructor. + +User code can raise built-in exceptions. This can be used to test an exception +handler or to report an error condition "just like" the situation in which the +interpreter raises the same exception; but beware that there is nothing to +prevent user code from raising an inappropriate error. + +The built-in exception classes can be subclassed to define new exceptions; +programmers are encouraged to derive new exceptions from the :exc:`Exception` +class or one of its subclasses, and not from :exc:`BaseException`. More +information on defining exceptions is available in the Python Tutorial under +:ref:`tut-userexceptions`. + +When raising (or re-raising) an exception in an :keyword:`except` or +:keyword:`finally` clause +:attr:`__context__` is automatically set to the last exception caught; if the +new exception is not handled the traceback that is eventually displayed will +include the originating exception(s) and the final exception. + +When raising a new exception (rather than using a bare ``raise`` to re-raise +the exception currently being handled), the implicit exception context can be +supplemented with an explicit cause by using :keyword:`from` with +:keyword:`raise`:: + + raise new_exc from original_exc + +The expression following :keyword:`from` must be an exception or ``None``. It +will be set as :attr:`__cause__` on the raised exception. Setting +:attr:`__cause__` also implicitly sets the :attr:`__suppress_context__` +attribute to ``True``, so that using ``raise new_exc from None`` +effectively replaces the old exception with the new one for display +purposes (e.g. converting :exc:`KeyError` to :exc:`AttributeError`), while +leaving the old exception available in :attr:`__context__` for introspection +when debugging. + +The default traceback display code shows these chained exceptions in +addition to the traceback for the exception itself. An explicitly chained +exception in :attr:`__cause__` is always shown when present. An implicitly +chained exception in :attr:`__context__` is shown only if :attr:`__cause__` +is :const:`None` and :attr:`__suppress_context__` is false. + +In either case, the exception itself is always shown after any chained +exceptions so that the final line of the traceback always shows the last +exception that was raised. + + +Base classes +------------ + +The following exceptions are used mostly as base classes for other exceptions. + +.. exception:: BaseException + + The base class for all built-in exceptions. It is not meant to be directly + inherited by user-defined classes (for that, use :exc:`Exception`). If + :func:`str` is called on an instance of this class, the representation of + the argument(s) to the instance are returned, or the empty string when + there were no arguments. + + .. attribute:: args + + The tuple of arguments given to the exception constructor. Some built-in + exceptions (like :exc:`OSError`) expect a certain number of arguments and + assign a special meaning to the elements of this tuple, while others are + usually called only with a single string giving an error message. + + .. method:: with_traceback(tb) + + This method sets *tb* as the new traceback for the exception and returns + the exception object. It is usually used in exception handling code like + this:: + + try: + ... + except SomeException: + tb = sys.exc_info()[2] + raise OtherException(...).with_traceback(tb) + + +.. exception:: Exception + + All built-in, non-system-exiting exceptions are derived from this class. All + user-defined exceptions should also be derived from this class. + + +.. exception:: ArithmeticError + + The base class for those built-in exceptions that are raised for various + arithmetic errors: :exc:`OverflowError`, :exc:`ZeroDivisionError`, + :exc:`FloatingPointError`. + + +.. exception:: BufferError + + Raised when a :ref:`buffer ` related operation cannot be + performed. + + +.. exception:: LookupError + + The base class for the exceptions that are raised when a key or index used on + a mapping or sequence is invalid: :exc:`IndexError`, :exc:`KeyError`. This + can be raised directly by :func:`codecs.lookup`. + + +Concrete exceptions +------------------- + +The following exceptions are the exceptions that are usually raised. + +.. exception:: AssertionError + + .. index:: statement: assert + + Raised when an :keyword:`assert` statement fails. + + +.. exception:: AttributeError + + Raised when an attribute reference (see :ref:`attribute-references`) or + assignment fails. (When an object does not support attribute references or + attribute assignments at all, :exc:`TypeError` is raised.) + + +.. exception:: EOFError + + Raised when the :func:`input` function hits an end-of-file condition (EOF) + without reading any data. (N.B.: the :meth:`io.IOBase.read` and + :meth:`io.IOBase.readline` methods return an empty string when they hit EOF.) + + +.. exception:: FloatingPointError + + Not currently used. + + +.. exception:: GeneratorExit + + Raised when a :term:`generator` or :term:`coroutine` is closed; + see :meth:`generator.close` and :meth:`coroutine.close`. It + directly inherits from :exc:`BaseException` instead of :exc:`Exception` since + it is technically not an error. + + +.. exception:: ImportError + + Raised when the :keyword:`import` statement has troubles trying to + load a module. Also raised when the "from list" in ``from ... import`` + has a name that cannot be found. + + The :attr:`name` and :attr:`path` attributes can be set using keyword-only + arguments to the constructor. When set they represent the name of the module + that was attempted to be imported and the path to any file which triggered + the exception, respectively. + + .. versionchanged:: 3.3 + Added the :attr:`name` and :attr:`path` attributes. + +.. exception:: ModuleNotFoundError + + A subclass of :exc:`ImportError` which is raised by :keyword:`import` + when a module could not be located. It is also raised when ``None`` + is found in :data:`sys.modules`. + + .. versionadded:: 3.6 + + +.. exception:: IndexError + + Raised when a sequence subscript is out of range. (Slice indices are + silently truncated to fall in the allowed range; if an index is not an + integer, :exc:`TypeError` is raised.) + + .. XXX xref to sequences + + +.. exception:: KeyError + + Raised when a mapping (dictionary) key is not found in the set of existing keys. + + .. XXX xref to mapping objects? + + +.. exception:: KeyboardInterrupt + + Raised when the user hits the interrupt key (normally :kbd:`Control-C` or + :kbd:`Delete`). During execution, a check for interrupts is made + regularly. The exception inherits from :exc:`BaseException` so as to not be + accidentally caught by code that catches :exc:`Exception` and thus prevent + the interpreter from exiting. + + +.. exception:: MemoryError + + Raised when an operation runs out of memory but the situation may still be + rescued (by deleting some objects). The associated value is a string indicating + what kind of (internal) operation ran out of memory. Note that because of the + underlying memory management architecture (C's :c:func:`malloc` function), the + interpreter may not always be able to completely recover from this situation; it + nevertheless raises an exception so that a stack traceback can be printed, in + case a run-away program was the cause. + + +.. exception:: NameError + + Raised when a local or global name is not found. This applies only to + unqualified names. The associated value is an error message that includes the + name that could not be found. + + +.. exception:: NotImplementedError + + This exception is derived from :exc:`RuntimeError`. In user defined base + classes, abstract methods should raise this exception when they require + derived classes to override the method, or while the class is being + developed to indicate that the real implementation still needs to be added. + + .. note:: + + It should not be used to indicate that an operator or method is not + meant to be supported at all -- in that case either leave the operator / + method undefined or, if a subclass, set it to :data:`None`. + + .. note:: + + ``NotImplementedError`` and ``NotImplemented`` are not interchangeable, + even though they have similar names and purposes. See + :data:`NotImplemented` for details on when to use it. + +.. exception:: OSError([arg]) + OSError(errno, strerror[, filename[, winerror[, filename2]]]) + + .. index:: module: errno + + This exception is raised when a system function returns a system-related + error, including I/O failures such as "file not found" or "disk full" + (not for illegal argument types or other incidental errors). + + The second form of the constructor sets the corresponding attributes, + described below. The attributes default to :const:`None` if not + specified. For backwards compatibility, if three arguments are passed, + the :attr:`~BaseException.args` attribute contains only a 2-tuple + of the first two constructor arguments. + + The constructor often actually returns a subclass of :exc:`OSError`, as + described in `OS exceptions`_ below. The particular subclass depends on + the final :attr:`.errno` value. This behaviour only occurs when + constructing :exc:`OSError` directly or via an alias, and is not + inherited when subclassing. + + .. attribute:: errno + + A numeric error code from the C variable :c:data:`errno`. + + .. attribute:: winerror + + Under Windows, this gives you the native + Windows error code. The :attr:`.errno` attribute is then an approximate + translation, in POSIX terms, of that native error code. + + Under Windows, if the *winerror* constructor argument is an integer, + the :attr:`.errno` attribute is determined from the Windows error code, + and the *errno* argument is ignored. On other platforms, the + *winerror* argument is ignored, and the :attr:`winerror` attribute + does not exist. + + .. attribute:: strerror + + The corresponding error message, as provided by + the operating system. It is formatted by the C + functions :c:func:`perror` under POSIX, and :c:func:`FormatMessage` + under Windows. + + .. attribute:: filename + filename2 + + For exceptions that involve a file system path (such as :func:`open` or + :func:`os.unlink`), :attr:`filename` is the file name passed to the function. + For functions that involve two file system paths (such as + :func:`os.rename`), :attr:`filename2` corresponds to the second + file name passed to the function. + + + .. versionchanged:: 3.3 + :exc:`EnvironmentError`, :exc:`IOError`, :exc:`WindowsError`, + :exc:`socket.error`, :exc:`select.error` and + :exc:`mmap.error` have been merged into :exc:`OSError`, and the + constructor may return a subclass. + + .. versionchanged:: 3.4 + The :attr:`filename` attribute is now the original file name passed to + the function, instead of the name encoded to or decoded from the + filesystem encoding. Also, the *filename2* constructor argument and + attribute was added. + + +.. exception:: OverflowError + + Raised when the result of an arithmetic operation is too large to be + represented. This cannot occur for integers (which would rather raise + :exc:`MemoryError` than give up). However, for historical reasons, + OverflowError is sometimes raised for integers that are outside a required + range. Because of the lack of standardization of floating point exception + handling in C, most floating point operations are not checked. + + +.. exception:: RecursionError + + This exception is derived from :exc:`RuntimeError`. It is raised when the + interpreter detects that the maximum recursion depth (see + :func:`sys.getrecursionlimit`) is exceeded. + + .. versionadded:: 3.5 + Previously, a plain :exc:`RuntimeError` was raised. + + +.. exception:: ReferenceError + + This exception is raised when a weak reference proxy, created by the + :func:`weakref.proxy` function, is used to access an attribute of the referent + after it has been garbage collected. For more information on weak references, + see the :mod:`weakref` module. + + +.. exception:: RuntimeError + + Raised when an error is detected that doesn't fall in any of the other + categories. The associated value is a string indicating what precisely went + wrong. + + +.. exception:: StopIteration + + Raised by built-in function :func:`next` and an :term:`iterator`\'s + :meth:`~iterator.__next__` method to signal that there are no further + items produced by the iterator. + + The exception object has a single attribute :attr:`value`, which is + given as an argument when constructing the exception, and defaults + to :const:`None`. + + When a :term:`generator` or :term:`coroutine` function + returns, a new :exc:`StopIteration` instance is + raised, and the value returned by the function is used as the + :attr:`value` parameter to the constructor of the exception. + + If a generator code directly or indirectly raises :exc:`StopIteration`, + it is converted into a :exc:`RuntimeError` (retaining the + :exc:`StopIteration` as the new exception's cause). + + .. versionchanged:: 3.3 + Added ``value`` attribute and the ability for generator functions to + use it to return a value. + + .. versionchanged:: 3.5 + Introduced the RuntimeError transformation via + ``from __future__ import generator_stop``, see :pep:`479`. + + .. versionchanged:: 3.7 + Enable :pep:`479` for all code by default: a :exc:`StopIteration` + error raised in a generator is transformed into a :exc:`RuntimeError`. + +.. exception:: StopAsyncIteration + + Must be raised by :meth:`__anext__` method of an + :term:`asynchronous iterator` object to stop the iteration. + + .. versionadded:: 3.5 + +.. exception:: SyntaxError + + Raised when the parser encounters a syntax error. This may occur in an + :keyword:`import` statement, in a call to the built-in functions :func:`exec` + or :func:`eval`, or when reading the initial script or standard input + (also interactively). + + Instances of this class have attributes :attr:`filename`, :attr:`lineno`, + :attr:`offset` and :attr:`text` for easier access to the details. :func:`str` + of the exception instance returns only the message. + + +.. exception:: IndentationError + + Base class for syntax errors related to incorrect indentation. This is a + subclass of :exc:`SyntaxError`. + + +.. exception:: TabError + + Raised when indentation contains an inconsistent use of tabs and spaces. + This is a subclass of :exc:`IndentationError`. + + +.. exception:: SystemError + + Raised when the interpreter finds an internal error, but the situation does not + look so serious to cause it to abandon all hope. The associated value is a + string indicating what went wrong (in low-level terms). + + You should report this to the author or maintainer of your Python interpreter. + Be sure to report the version of the Python interpreter (``sys.version``; it is + also printed at the start of an interactive Python session), the exact error + message (the exception's associated value) and if possible the source of the + program that triggered the error. + + +.. exception:: SystemExit + + This exception is raised by the :func:`sys.exit` function. It inherits from + :exc:`BaseException` instead of :exc:`Exception` so that it is not accidentally + caught by code that catches :exc:`Exception`. This allows the exception to + properly propagate up and cause the interpreter to exit. When it is not + handled, the Python interpreter exits; no stack traceback is printed. The + constructor accepts the same optional argument passed to :func:`sys.exit`. + If the value is an integer, it specifies the system exit status (passed to + C's :c:func:`exit` function); if it is ``None``, the exit status is zero; if + it has another type (such as a string), the object's value is printed and + the exit status is one. + + A call to :func:`sys.exit` is translated into an exception so that clean-up + handlers (:keyword:`finally` clauses of :keyword:`try` statements) can be + executed, and so that a debugger can execute a script without running the risk + of losing control. The :func:`os._exit` function can be used if it is + absolutely positively necessary to exit immediately (for example, in the child + process after a call to :func:`os.fork`). + + .. attribute:: code + + The exit status or error message that is passed to the constructor. + (Defaults to ``None``.) + + +.. exception:: TypeError + + Raised when an operation or function is applied to an object of inappropriate + type. The associated value is a string giving details about the type mismatch. + + This exception may be raised by user code to indicate that an attempted + operation on an object is not supported, and is not meant to be. If an object + is meant to support a given operation but has not yet provided an + implementation, :exc:`NotImplementedError` is the proper exception to raise. + + Passing arguments of the wrong type (e.g. passing a :class:`list` when an + :class:`int` is expected) should result in a :exc:`TypeError`, but passing + arguments with the wrong value (e.g. a number outside expected boundaries) + should result in a :exc:`ValueError`. + +.. exception:: UnboundLocalError + + Raised when a reference is made to a local variable in a function or method, but + no value has been bound to that variable. This is a subclass of + :exc:`NameError`. + + +.. exception:: UnicodeError + + Raised when a Unicode-related encoding or decoding error occurs. It is a + subclass of :exc:`ValueError`. + + :exc:`UnicodeError` has attributes that describe the encoding or decoding + error. For example, ``err.object[err.start:err.end]`` gives the particular + invalid input that the codec failed on. + + .. attribute:: encoding + + The name of the encoding that raised the error. + + .. attribute:: reason + + A string describing the specific codec error. + + .. attribute:: object + + The object the codec was attempting to encode or decode. + + .. attribute:: start + + The first index of invalid data in :attr:`object`. + + .. attribute:: end + + The index after the last invalid data in :attr:`object`. + + +.. exception:: UnicodeEncodeError + + Raised when a Unicode-related error occurs during encoding. It is a subclass of + :exc:`UnicodeError`. + + +.. exception:: UnicodeDecodeError + + Raised when a Unicode-related error occurs during decoding. It is a subclass of + :exc:`UnicodeError`. + + +.. exception:: UnicodeTranslateError + + Raised when a Unicode-related error occurs during translating. It is a subclass + of :exc:`UnicodeError`. + + +.. exception:: ValueError + + Raised when an operation or function receives an argument that has the + right type but an inappropriate value, and the situation is not described by a + more precise exception such as :exc:`IndexError`. + + +.. exception:: ZeroDivisionError + + Raised when the second argument of a division or modulo operation is zero. The + associated value is a string indicating the type of the operands and the + operation. + + +The following exceptions are kept for compatibility with previous versions; +starting from Python 3.3, they are aliases of :exc:`OSError`. + +.. exception:: EnvironmentError + +.. exception:: IOError + +.. exception:: WindowsError + + Only available on Windows. + + +OS exceptions +^^^^^^^^^^^^^ + +The following exceptions are subclasses of :exc:`OSError`, they get raised +depending on the system error code. + +.. exception:: BlockingIOError + + Raised when an operation would block on an object (e.g. socket) set + for non-blocking operation. + Corresponds to :c:data:`errno` ``EAGAIN``, ``EALREADY``, + ``EWOULDBLOCK`` and ``EINPROGRESS``. + + In addition to those of :exc:`OSError`, :exc:`BlockingIOError` can have + one more attribute: + + .. attribute:: characters_written + + An integer containing the number of characters written to the stream + before it blocked. This attribute is available when using the + buffered I/O classes from the :mod:`io` module. + +.. exception:: ChildProcessError + + Raised when an operation on a child process failed. + Corresponds to :c:data:`errno` ``ECHILD``. + +.. exception:: ConnectionError + + A base class for connection-related issues. + + Subclasses are :exc:`BrokenPipeError`, :exc:`ConnectionAbortedError`, + :exc:`ConnectionRefusedError` and :exc:`ConnectionResetError`. + +.. exception:: BrokenPipeError + + A subclass of :exc:`ConnectionError`, raised when trying to write on a + pipe while the other end has been closed, or trying to write on a socket + which has been shutdown for writing. + Corresponds to :c:data:`errno` ``EPIPE`` and ``ESHUTDOWN``. + +.. exception:: ConnectionAbortedError + + A subclass of :exc:`ConnectionError`, raised when a connection attempt + is aborted by the peer. + Corresponds to :c:data:`errno` ``ECONNABORTED``. + +.. exception:: ConnectionRefusedError + + A subclass of :exc:`ConnectionError`, raised when a connection attempt + is refused by the peer. + Corresponds to :c:data:`errno` ``ECONNREFUSED``. + +.. exception:: ConnectionResetError + + A subclass of :exc:`ConnectionError`, raised when a connection is + reset by the peer. + Corresponds to :c:data:`errno` ``ECONNRESET``. + +.. exception:: FileExistsError + + Raised when trying to create a file or directory which already exists. + Corresponds to :c:data:`errno` ``EEXIST``. + +.. exception:: FileNotFoundError + + Raised when a file or directory is requested but doesn't exist. + Corresponds to :c:data:`errno` ``ENOENT``. + +.. exception:: InterruptedError + + Raised when a system call is interrupted by an incoming signal. + Corresponds to :c:data:`errno` :py:data:`~errno.EINTR`. + + .. versionchanged:: 3.5 + Python now retries system calls when a syscall is interrupted by a + signal, except if the signal handler raises an exception (see :pep:`475` + for the rationale), instead of raising :exc:`InterruptedError`. + +.. exception:: IsADirectoryError + + Raised when a file operation (such as :func:`os.remove`) is requested + on a directory. + Corresponds to :c:data:`errno` ``EISDIR``. + +.. exception:: NotADirectoryError + + Raised when a directory operation (such as :func:`os.listdir`) is requested + on something which is not a directory. + Corresponds to :c:data:`errno` ``ENOTDIR``. + +.. exception:: PermissionError + + Raised when trying to run an operation without the adequate access + rights - for example filesystem permissions. + Corresponds to :c:data:`errno` ``EACCES`` and ``EPERM``. + +.. exception:: ProcessLookupError + + Raised when a given process doesn't exist. + Corresponds to :c:data:`errno` ``ESRCH``. + +.. exception:: TimeoutError + + Raised when a system function timed out at the system level. + Corresponds to :c:data:`errno` ``ETIMEDOUT``. + +.. versionadded:: 3.3 + All the above :exc:`OSError` subclasses were added. + + +.. seealso:: + + :pep:`3151` - Reworking the OS and IO exception hierarchy + + +.. _warning-categories-as-exceptions: + +Warnings +-------- + +The following exceptions are used as warning categories; see the +:ref:`warning-categories` documentation for more details. + +.. exception:: Warning + + Base class for warning categories. + + +.. exception:: UserWarning + + Base class for warnings generated by user code. + + +.. exception:: DeprecationWarning + + Base class for warnings about deprecated features when those warnings are + intended for other Python developers. + + +.. exception:: PendingDeprecationWarning + + Base class for warnings about features which are obsolete and + expected to be deprecated in the future, but are not deprecated + at the moment. + + This class is rarely used as emitting a warning about a possible + upcoming deprecation is unusual, and :exc:`DeprecationWarning` + is preferred for already active deprecations. + + +.. exception:: SyntaxWarning + + Base class for warnings about dubious syntax. + + +.. exception:: RuntimeWarning + + Base class for warnings about dubious runtime behavior. + + +.. exception:: FutureWarning + + Base class for warnings about deprecated features when those warnings are + intended for end users of applications that are written in Python. + + +.. exception:: ImportWarning + + Base class for warnings about probable mistakes in module imports. + + +.. exception:: UnicodeWarning + + Base class for warnings related to Unicode. + + +.. exception:: BytesWarning + + Base class for warnings related to :class:`bytes` and :class:`bytearray`. + + +.. exception:: ResourceWarning + + Base class for warnings related to resource usage. Ignored by the default + warning filters. + + .. versionadded:: 3.2 + + + +Exception hierarchy +------------------- + +The class hierarchy for built-in exceptions is: + +.. literalinclude:: ../../Lib/test/exception_hierarchy.txt diff --git a/python-3.7.4-docs-html/_sources/library/faulthandler.rst.txt b/python-3.7.4-docs-html/_sources/library/faulthandler.rst.txt new file mode 100644 index 0000000..94ebd87 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/faulthandler.rst.txt @@ -0,0 +1,172 @@ +:mod:`faulthandler` --- Dump the Python traceback +================================================= + +.. module:: faulthandler + :synopsis: Dump the Python traceback. + +.. versionadded:: 3.3 + +---------------- + +This module contains functions to dump Python tracebacks explicitly, on a fault, +after a timeout, or on a user signal. Call :func:`faulthandler.enable` to +install fault handlers for the :const:`SIGSEGV`, :const:`SIGFPE`, +:const:`SIGABRT`, :const:`SIGBUS`, and :const:`SIGILL` signals. You can also +enable them at startup by setting the :envvar:`PYTHONFAULTHANDLER` environment +variable or by using the :option:`-X` ``faulthandler`` command line option. + +The fault handler is compatible with system fault handlers like Apport or the +Windows fault handler. The module uses an alternative stack for signal handlers +if the :c:func:`sigaltstack` function is available. This allows it to dump the +traceback even on a stack overflow. + +The fault handler is called on catastrophic cases and therefore can only use +signal-safe functions (e.g. it cannot allocate memory on the heap). Because of +this limitation traceback dumping is minimal compared to normal Python +tracebacks: + +* Only ASCII is supported. The ``backslashreplace`` error handler is used on + encoding. +* Each string is limited to 500 characters. +* Only the filename, the function name and the line number are + displayed. (no source code) +* It is limited to 100 frames and 100 threads. +* The order is reversed: the most recent call is shown first. + +By default, the Python traceback is written to :data:`sys.stderr`. To see +tracebacks, applications must be run in the terminal. A log file can +alternatively be passed to :func:`faulthandler.enable`. + +The module is implemented in C, so tracebacks can be dumped on a crash or when +Python is deadlocked. + + +Dumping the traceback +--------------------- + +.. function:: dump_traceback(file=sys.stderr, all_threads=True) + + Dump the tracebacks of all threads into *file*. If *all_threads* is + ``False``, dump only the current thread. + + .. versionchanged:: 3.5 + Added support for passing file descriptor to this function. + + +Fault handler state +------------------- + +.. function:: enable(file=sys.stderr, all_threads=True) + + Enable the fault handler: install handlers for the :const:`SIGSEGV`, + :const:`SIGFPE`, :const:`SIGABRT`, :const:`SIGBUS` and :const:`SIGILL` + signals to dump the Python traceback. If *all_threads* is ``True``, + produce tracebacks for every running thread. Otherwise, dump only the current + thread. + + The *file* must be kept open until the fault handler is disabled: see + :ref:`issue with file descriptors `. + + .. versionchanged:: 3.5 + Added support for passing file descriptor to this function. + + .. versionchanged:: 3.6 + On Windows, a handler for Windows exception is also installed. + +.. function:: disable() + + Disable the fault handler: uninstall the signal handlers installed by + :func:`enable`. + +.. function:: is_enabled() + + Check if the fault handler is enabled. + + +Dumping the tracebacks after a timeout +-------------------------------------- + +.. function:: dump_traceback_later(timeout, repeat=False, file=sys.stderr, exit=False) + + Dump the tracebacks of all threads, after a timeout of *timeout* seconds, or + every *timeout* seconds if *repeat* is ``True``. If *exit* is ``True``, call + :c:func:`_exit` with status=1 after dumping the tracebacks. (Note + :c:func:`_exit` exits the process immediately, which means it doesn't do any + cleanup like flushing file buffers.) If the function is called twice, the new + call replaces previous parameters and resets the timeout. The timer has a + sub-second resolution. + + The *file* must be kept open until the traceback is dumped or + :func:`cancel_dump_traceback_later` is called: see :ref:`issue with file + descriptors `. + + This function is implemented using a watchdog thread and therefore is not + available if Python is compiled with threads disabled. + + .. versionchanged:: 3.5 + Added support for passing file descriptor to this function. + +.. function:: cancel_dump_traceback_later() + + Cancel the last call to :func:`dump_traceback_later`. + + +Dumping the traceback on a user signal +-------------------------------------- + +.. function:: register(signum, file=sys.stderr, all_threads=True, chain=False) + + Register a user signal: install a handler for the *signum* signal to dump + the traceback of all threads, or of the current thread if *all_threads* is + ``False``, into *file*. Call the previous handler if chain is ``True``. + + The *file* must be kept open until the signal is unregistered by + :func:`unregister`: see :ref:`issue with file descriptors `. + + Not available on Windows. + + .. versionchanged:: 3.5 + Added support for passing file descriptor to this function. + +.. function:: unregister(signum) + + Unregister a user signal: uninstall the handler of the *signum* signal + installed by :func:`register`. Return ``True`` if the signal was registered, + ``False`` otherwise. + + Not available on Windows. + + +.. _faulthandler-fd: + +Issue with file descriptors +--------------------------- + +:func:`enable`, :func:`dump_traceback_later` and :func:`register` keep the +file descriptor of their *file* argument. If the file is closed and its file +descriptor is reused by a new file, or if :func:`os.dup2` is used to replace +the file descriptor, the traceback will be written into a different file. Call +these functions again each time that the file is replaced. + + +Example +------- + +Example of a segmentation fault on Linux with and without enabling the fault +handler: + +.. code-block:: shell-session + + $ python3 -c "import ctypes; ctypes.string_at(0)" + Segmentation fault + + $ python3 -q -X faulthandler + >>> import ctypes + >>> ctypes.string_at(0) + Fatal Python error: Segmentation fault + + Current thread 0x00007fb899f39700 (most recent call first): + File "/home/python/cpython/Lib/ctypes/__init__.py", line 486 in string_at + File "", line 1 in + Segmentation fault + diff --git a/python-3.7.4-docs-html/_sources/library/fcntl.rst.txt b/python-3.7.4-docs-html/_sources/library/fcntl.rst.txt new file mode 100644 index 0000000..88112f6 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/fcntl.rst.txt @@ -0,0 +1,170 @@ +:mod:`fcntl` --- The ``fcntl`` and ``ioctl`` system calls +========================================================= + +.. module:: fcntl + :platform: Unix + :synopsis: The fcntl() and ioctl() system calls. + +.. sectionauthor:: Jaap Vermeulen + +.. index:: + pair: UNIX; file control + pair: UNIX; I/O control + +---------------- + +This module performs file control and I/O control on file descriptors. It is an +interface to the :c:func:`fcntl` and :c:func:`ioctl` Unix routines. For a +complete description of these calls, see :manpage:`fcntl(2)` and +:manpage:`ioctl(2)` Unix manual pages. + +All functions in this module take a file descriptor *fd* as their first +argument. This can be an integer file descriptor, such as returned by +``sys.stdin.fileno()``, or an :class:`io.IOBase` object, such as ``sys.stdin`` +itself, which provides a :meth:`~io.IOBase.fileno` that returns a genuine file +descriptor. + +.. versionchanged:: 3.3 + Operations in this module used to raise an :exc:`IOError` where they now + raise an :exc:`OSError`. + + +The module defines the following functions: + + +.. function:: fcntl(fd, cmd, arg=0) + + Perform the operation *cmd* on file descriptor *fd* (file objects providing + a :meth:`~io.IOBase.fileno` method are accepted as well). The values used + for *cmd* are operating system dependent, and are available as constants + in the :mod:`fcntl` module, using the same names as used in the relevant C + header files. The argument *arg* can either be an integer value, or a + :class:`bytes` object. With an integer value, the return value of this + function is the integer return value of the C :c:func:`fcntl` call. When + the argument is bytes it represents a binary structure, e.g. created by + :func:`struct.pack`. The binary data is copied to a buffer whose address is + passed to the C :c:func:`fcntl` call. The return value after a successful + call is the contents of the buffer, converted to a :class:`bytes` object. + The length of the returned object will be the same as the length of the + *arg* argument. This is limited to 1024 bytes. If the information returned + in the buffer by the operating system is larger than 1024 bytes, this is + most likely to result in a segmentation violation or a more subtle data + corruption. + + If the :c:func:`fcntl` fails, an :exc:`OSError` is raised. + + +.. function:: ioctl(fd, request, arg=0, mutate_flag=True) + + This function is identical to the :func:`~fcntl.fcntl` function, except + that the argument handling is even more complicated. + + The *request* parameter is limited to values that can fit in 32-bits. + Additional constants of interest for use as the *request* argument can be + found in the :mod:`termios` module, under the same names as used in + the relevant C header files. + + The parameter *arg* can be one of an integer, an object supporting the + read-only buffer interface (like :class:`bytes`) or an object supporting + the read-write buffer interface (like :class:`bytearray`). + + In all but the last case, behaviour is as for the :func:`~fcntl.fcntl` + function. + + If a mutable buffer is passed, then the behaviour is determined by the value of + the *mutate_flag* parameter. + + If it is false, the buffer's mutability is ignored and behaviour is as for a + read-only buffer, except that the 1024 byte limit mentioned above is avoided -- + so long as the buffer you pass is at least as long as what the operating system + wants to put there, things should work. + + If *mutate_flag* is true (the default), then the buffer is (in effect) passed + to the underlying :func:`ioctl` system call, the latter's return code is + passed back to the calling Python, and the buffer's new contents reflect the + action of the :func:`ioctl`. This is a slight simplification, because if the + supplied buffer is less than 1024 bytes long it is first copied into a static + buffer 1024 bytes long which is then passed to :func:`ioctl` and copied back + into the supplied buffer. + + If the :c:func:`ioctl` fails, an :exc:`OSError` exception is raised. + + An example:: + + >>> import array, fcntl, struct, termios, os + >>> os.getpgrp() + 13341 + >>> struct.unpack('h', fcntl.ioctl(0, termios.TIOCGPGRP, " "))[0] + 13341 + >>> buf = array.array('h', [0]) + >>> fcntl.ioctl(0, termios.TIOCGPGRP, buf, 1) + 0 + >>> buf + array('h', [13341]) + + +.. function:: flock(fd, operation) + + Perform the lock operation *operation* on file descriptor *fd* (file objects providing + a :meth:`~io.IOBase.fileno` method are accepted as well). See the Unix manual + :manpage:`flock(2)` for details. (On some systems, this function is emulated + using :c:func:`fcntl`.) + + If the :c:func:`flock` fails, an :exc:`OSError` exception is raised. + + +.. function:: lockf(fd, cmd, len=0, start=0, whence=0) + + This is essentially a wrapper around the :func:`~fcntl.fcntl` locking calls. + *fd* is the file descriptor of the file to lock or unlock, and *cmd* + is one of the following values: + + * :const:`LOCK_UN` -- unlock + * :const:`LOCK_SH` -- acquire a shared lock + * :const:`LOCK_EX` -- acquire an exclusive lock + + When *cmd* is :const:`LOCK_SH` or :const:`LOCK_EX`, it can also be + bitwise ORed with :const:`LOCK_NB` to avoid blocking on lock acquisition. + If :const:`LOCK_NB` is used and the lock cannot be acquired, an + :exc:`OSError` will be raised and the exception will have an *errno* + attribute set to :const:`EACCES` or :const:`EAGAIN` (depending on the + operating system; for portability, check for both values). On at least some + systems, :const:`LOCK_EX` can only be used if the file descriptor refers to a + file opened for writing. + + *len* is the number of bytes to lock, *start* is the byte offset at + which the lock starts, relative to *whence*, and *whence* is as with + :func:`io.IOBase.seek`, specifically: + + * :const:`0` -- relative to the start of the file (:data:`os.SEEK_SET`) + * :const:`1` -- relative to the current buffer position (:data:`os.SEEK_CUR`) + * :const:`2` -- relative to the end of the file (:data:`os.SEEK_END`) + + The default for *start* is 0, which means to start at the beginning of the file. + The default for *len* is 0 which means to lock to the end of the file. The + default for *whence* is also 0. + +Examples (all on a SVR4 compliant system):: + + import struct, fcntl, os + + f = open(...) + rv = fcntl.fcntl(f, fcntl.F_SETFL, os.O_NDELAY) + + lockdata = struct.pack('hhllhh', fcntl.F_WRLCK, 0, 0, 0, 0, 0) + rv = fcntl.fcntl(f, fcntl.F_SETLKW, lockdata) + +Note that in the first example the return value variable *rv* will hold an +integer value; in the second example it will hold a :class:`bytes` object. The +structure lay-out for the *lockdata* variable is system dependent --- therefore +using the :func:`flock` call may be better. + + +.. seealso:: + + Module :mod:`os` + If the locking flags :data:`~os.O_SHLOCK` and :data:`~os.O_EXLOCK` are + present in the :mod:`os` module (on BSD only), the :func:`os.open` + function provides an alternative to the :func:`lockf` and :func:`flock` + functions. + diff --git a/python-3.7.4-docs-html/_sources/library/filecmp.rst.txt b/python-3.7.4-docs-html/_sources/library/filecmp.rst.txt new file mode 100644 index 0000000..31b9b4a --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/filecmp.rst.txt @@ -0,0 +1,198 @@ +:mod:`filecmp` --- File and Directory Comparisons +================================================= + +.. module:: filecmp + :synopsis: Compare files efficiently. + +.. sectionauthor:: Moshe Zadka + +**Source code:** :source:`Lib/filecmp.py` + +-------------- + +The :mod:`filecmp` module defines functions to compare files and directories, +with various optional time/correctness trade-offs. For comparing files, +see also the :mod:`difflib` module. + +The :mod:`filecmp` module defines the following functions: + + +.. function:: cmp(f1, f2, shallow=True) + + Compare the files named *f1* and *f2*, returning ``True`` if they seem equal, + ``False`` otherwise. + + If *shallow* is true, files with identical :func:`os.stat` signatures are + taken to be equal. Otherwise, the contents of the files are compared. + + Note that no external programs are called from this function, giving it + portability and efficiency. + + This function uses a cache for past comparisons and the results, + with cache entries invalidated if the :func:`os.stat` information for the + file changes. The entire cache may be cleared using :func:`clear_cache`. + + +.. function:: cmpfiles(dir1, dir2, common, shallow=True) + + Compare the files in the two directories *dir1* and *dir2* whose names are + given by *common*. + + Returns three lists of file names: *match*, *mismatch*, + *errors*. *match* contains the list of files that match, *mismatch* contains + the names of those that don't, and *errors* lists the names of files which + could not be compared. Files are listed in *errors* if they don't exist in + one of the directories, the user lacks permission to read them or if the + comparison could not be done for some other reason. + + The *shallow* parameter has the same meaning and default value as for + :func:`filecmp.cmp`. + + For example, ``cmpfiles('a', 'b', ['c', 'd/e'])`` will compare ``a/c`` with + ``b/c`` and ``a/d/e`` with ``b/d/e``. ``'c'`` and ``'d/e'`` will each be in + one of the three returned lists. + + +.. function:: clear_cache() + + Clear the filecmp cache. This may be useful if a file is compared so quickly + after it is modified that it is within the mtime resolution of + the underlying filesystem. + + .. versionadded:: 3.4 + + +.. _dircmp-objects: + +The :class:`dircmp` class +------------------------- + +.. class:: dircmp(a, b, ignore=None, hide=None) + + Construct a new directory comparison object, to compare the directories *a* + and *b*. *ignore* is a list of names to ignore, and defaults to + :attr:`filecmp.DEFAULT_IGNORES`. *hide* is a list of names to hide, and + defaults to ``[os.curdir, os.pardir]``. + + The :class:`dircmp` class compares files by doing *shallow* comparisons + as described for :func:`filecmp.cmp`. + + The :class:`dircmp` class provides the following methods: + + .. method:: report() + + Print (to :data:`sys.stdout`) a comparison between *a* and *b*. + + .. method:: report_partial_closure() + + Print a comparison between *a* and *b* and common immediate + subdirectories. + + .. method:: report_full_closure() + + Print a comparison between *a* and *b* and common subdirectories + (recursively). + + The :class:`dircmp` class offers a number of interesting attributes that may be + used to get various bits of information about the directory trees being + compared. + + Note that via :meth:`__getattr__` hooks, all attributes are computed lazily, + so there is no speed penalty if only those attributes which are lightweight + to compute are used. + + + .. attribute:: left + + The directory *a*. + + + .. attribute:: right + + The directory *b*. + + + .. attribute:: left_list + + Files and subdirectories in *a*, filtered by *hide* and *ignore*. + + + .. attribute:: right_list + + Files and subdirectories in *b*, filtered by *hide* and *ignore*. + + + .. attribute:: common + + Files and subdirectories in both *a* and *b*. + + + .. attribute:: left_only + + Files and subdirectories only in *a*. + + + .. attribute:: right_only + + Files and subdirectories only in *b*. + + + .. attribute:: common_dirs + + Subdirectories in both *a* and *b*. + + + .. attribute:: common_files + + Files in both *a* and *b*. + + + .. attribute:: common_funny + + Names in both *a* and *b*, such that the type differs between the + directories, or names for which :func:`os.stat` reports an error. + + + .. attribute:: same_files + + Files which are identical in both *a* and *b*, using the class's + file comparison operator. + + + .. attribute:: diff_files + + Files which are in both *a* and *b*, whose contents differ according + to the class's file comparison operator. + + + .. attribute:: funny_files + + Files which are in both *a* and *b*, but could not be compared. + + + .. attribute:: subdirs + + A dictionary mapping names in :attr:`common_dirs` to :class:`dircmp` + objects. + +.. attribute:: DEFAULT_IGNORES + + .. versionadded:: 3.4 + + List of directories ignored by :class:`dircmp` by default. + + +Here is a simplified example of using the ``subdirs`` attribute to search +recursively through two directories to show common different files:: + + >>> from filecmp import dircmp + >>> def print_diff_files(dcmp): + ... for name in dcmp.diff_files: + ... print("diff_file %s found in %s and %s" % (name, dcmp.left, + ... dcmp.right)) + ... for sub_dcmp in dcmp.subdirs.values(): + ... print_diff_files(sub_dcmp) + ... + >>> dcmp = dircmp('dir1', 'dir2') # doctest: +SKIP + >>> print_diff_files(dcmp) # doctest: +SKIP + diff --git a/python-3.7.4-docs-html/_sources/library/fileformats.rst.txt b/python-3.7.4-docs-html/_sources/library/fileformats.rst.txt new file mode 100644 index 0000000..e9c2e1f --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/fileformats.rst.txt @@ -0,0 +1,17 @@ +.. _fileformats: + +************ +File Formats +************ + +The modules described in this chapter parse various miscellaneous file formats +that aren't markup languages and are not related to e-mail. + + +.. toctree:: + + csv.rst + configparser.rst + netrc.rst + xdrlib.rst + plistlib.rst diff --git a/python-3.7.4-docs-html/_sources/library/fileinput.rst.txt b/python-3.7.4-docs-html/_sources/library/fileinput.rst.txt new file mode 100644 index 0000000..bf81749 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/fileinput.rst.txt @@ -0,0 +1,208 @@ +:mod:`fileinput` --- Iterate over lines from multiple input streams +=================================================================== + +.. module:: fileinput + :synopsis: Loop over standard input or a list of files. + +.. moduleauthor:: Guido van Rossum +.. sectionauthor:: Fred L. Drake, Jr. + +**Source code:** :source:`Lib/fileinput.py` + +-------------- + +This module implements a helper class and functions to quickly write a +loop over standard input or a list of files. If you just want to read or +write one file see :func:`open`. + +The typical use is:: + + import fileinput + for line in fileinput.input(): + process(line) + +This iterates over the lines of all files listed in ``sys.argv[1:]``, defaulting +to ``sys.stdin`` if the list is empty. If a filename is ``'-'``, it is also +replaced by ``sys.stdin`` and the optional arguments *mode* and *openhook* +are ignored. To specify an alternative list of filenames, pass it as the +first argument to :func:`.input`. A single file name is also allowed. + +All files are opened in text mode by default, but you can override this by +specifying the *mode* parameter in the call to :func:`.input` or +:class:`FileInput`. If an I/O error occurs during opening or reading a file, +:exc:`OSError` is raised. + +.. versionchanged:: 3.3 + :exc:`IOError` used to be raised; it is now an alias of :exc:`OSError`. + +If ``sys.stdin`` is used more than once, the second and further use will return +no lines, except perhaps for interactive use, or if it has been explicitly reset +(e.g. using ``sys.stdin.seek(0)``). + +Empty files are opened and immediately closed; the only time their presence in +the list of filenames is noticeable at all is when the last file opened is +empty. + +Lines are returned with any newlines intact, which means that the last line in +a file may not have one. + +You can control how files are opened by providing an opening hook via the +*openhook* parameter to :func:`fileinput.input` or :class:`FileInput()`. The +hook must be a function that takes two arguments, *filename* and *mode*, and +returns an accordingly opened file-like object. Two useful hooks are already +provided by this module. + +The following function is the primary interface of this module: + + +.. function:: input(files=None, inplace=False, backup='', bufsize=0, mode='r', openhook=None) + + Create an instance of the :class:`FileInput` class. The instance will be used + as global state for the functions of this module, and is also returned to use + during iteration. The parameters to this function will be passed along to the + constructor of the :class:`FileInput` class. + + The :class:`FileInput` instance can be used as a context manager in the + :keyword:`with` statement. In this example, *input* is closed after the + :keyword:`!with` statement is exited, even if an exception occurs:: + + with fileinput.input(files=('spam.txt', 'eggs.txt')) as f: + for line in f: + process(line) + + .. versionchanged:: 3.2 + Can be used as a context manager. + + .. deprecated-removed:: 3.6 3.8 + The *bufsize* parameter. + +The following functions use the global state created by :func:`fileinput.input`; +if there is no active state, :exc:`RuntimeError` is raised. + + +.. function:: filename() + + Return the name of the file currently being read. Before the first line has + been read, returns ``None``. + + +.. function:: fileno() + + Return the integer "file descriptor" for the current file. When no file is + opened (before the first line and between files), returns ``-1``. + + +.. function:: lineno() + + Return the cumulative line number of the line that has just been read. Before + the first line has been read, returns ``0``. After the last line of the last + file has been read, returns the line number of that line. + + +.. function:: filelineno() + + Return the line number in the current file. Before the first line has been + read, returns ``0``. After the last line of the last file has been read, + returns the line number of that line within the file. + + +.. function:: isfirstline() + + Returns true if the line just read is the first line of its file, otherwise + returns false. + + +.. function:: isstdin() + + Returns true if the last line was read from ``sys.stdin``, otherwise returns + false. + + +.. function:: nextfile() + + Close the current file so that the next iteration will read the first line from + the next file (if any); lines not read from the file will not count towards the + cumulative line count. The filename is not changed until after the first line + of the next file has been read. Before the first line has been read, this + function has no effect; it cannot be used to skip the first file. After the + last line of the last file has been read, this function has no effect. + + +.. function:: close() + + Close the sequence. + +The class which implements the sequence behavior provided by the module is +available for subclassing as well: + + +.. class:: FileInput(files=None, inplace=False, backup='', bufsize=0, mode='r', openhook=None) + + Class :class:`FileInput` is the implementation; its methods :meth:`filename`, + :meth:`fileno`, :meth:`lineno`, :meth:`filelineno`, :meth:`isfirstline`, + :meth:`isstdin`, :meth:`nextfile` and :meth:`close` correspond to the + functions of the same name in the module. In addition it has a + :meth:`~io.TextIOBase.readline` method which returns the next input line, + and a :meth:`__getitem__` method which implements the sequence behavior. + The sequence must be accessed in strictly sequential order; random access + and :meth:`~io.TextIOBase.readline` cannot be mixed. + + With *mode* you can specify which file mode will be passed to :func:`open`. It + must be one of ``'r'``, ``'rU'``, ``'U'`` and ``'rb'``. + + The *openhook*, when given, must be a function that takes two arguments, + *filename* and *mode*, and returns an accordingly opened file-like object. You + cannot use *inplace* and *openhook* together. + + A :class:`FileInput` instance can be used as a context manager in the + :keyword:`with` statement. In this example, *input* is closed after the + :keyword:`!with` statement is exited, even if an exception occurs:: + + with FileInput(files=('spam.txt', 'eggs.txt')) as input: + process(input) + + .. versionchanged:: 3.2 + Can be used as a context manager. + + .. deprecated:: 3.4 + The ``'rU'`` and ``'U'`` modes. + + .. deprecated-removed:: 3.6 3.8 + The *bufsize* parameter. + + +**Optional in-place filtering:** if the keyword argument ``inplace=True`` is +passed to :func:`fileinput.input` or to the :class:`FileInput` constructor, the +file is moved to a backup file and standard output is directed to the input file +(if a file of the same name as the backup file already exists, it will be +replaced silently). This makes it possible to write a filter that rewrites its +input file in place. If the *backup* parameter is given (typically as +``backup='.'``), it specifies the extension for the backup file, +and the backup file remains around; by default, the extension is ``'.bak'`` and +it is deleted when the output file is closed. In-place filtering is disabled +when standard input is read. + + +The two following opening hooks are provided by this module: + +.. function:: hook_compressed(filename, mode) + + Transparently opens files compressed with gzip and bzip2 (recognized by the + extensions ``'.gz'`` and ``'.bz2'``) using the :mod:`gzip` and :mod:`bz2` + modules. If the filename extension is not ``'.gz'`` or ``'.bz2'``, the file is + opened normally (ie, using :func:`open` without any decompression). + + Usage example: ``fi = fileinput.FileInput(openhook=fileinput.hook_compressed)`` + + +.. function:: hook_encoded(encoding, errors=None) + + Returns a hook which opens each file with :func:`open`, using the given + *encoding* and *errors* to read the file. + + Usage example: ``fi = + fileinput.FileInput(openhook=fileinput.hook_encoded("utf-8", + "surrogateescape"))`` + + .. versionchanged:: 3.6 + Added the optional *errors* parameter. diff --git a/python-3.7.4-docs-html/_sources/library/filesys.rst.txt b/python-3.7.4-docs-html/_sources/library/filesys.rst.txt new file mode 100644 index 0000000..03e085b --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/filesys.rst.txt @@ -0,0 +1,39 @@ +.. _filesys: + +************************* +File and Directory Access +************************* + +The modules described in this chapter deal with disk files and directories. For +example, there are modules for reading the properties of files, manipulating +paths in a portable way, and creating temporary files. The full list of modules +in this chapter is: + + +.. toctree:: + + pathlib.rst + os.path.rst + fileinput.rst + stat.rst + filecmp.rst + tempfile.rst + glob.rst + fnmatch.rst + linecache.rst + shutil.rst + macpath.rst + + +.. seealso:: + + Module :mod:`os` + Operating system interfaces, including functions to work with files at a + lower level than Python :term:`file objects `. + + Module :mod:`io` + Python's built-in I/O library, including both abstract classes and + some concrete classes such as file I/O. + + Built-in function :func:`open` + The standard way to open files for reading and writing with Python. diff --git a/python-3.7.4-docs-html/_sources/library/fnmatch.rst.txt b/python-3.7.4-docs-html/_sources/library/fnmatch.rst.txt new file mode 100644 index 0000000..ce07d32 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/fnmatch.rst.txt @@ -0,0 +1,102 @@ +:mod:`fnmatch` --- Unix filename pattern matching +================================================= + +.. module:: fnmatch + :synopsis: Unix shell style filename pattern matching. + +**Source code:** :source:`Lib/fnmatch.py` + +.. index:: single: filenames; wildcard expansion + +.. index:: module: re + +-------------- + +This module provides support for Unix shell-style wildcards, which are *not* the +same as regular expressions (which are documented in the :mod:`re` module). The +special characters used in shell-style wildcards are: + +.. index:: + single: * (asterisk); in glob-style wildcards + single: ? (question mark); in glob-style wildcards + single: [] (square brackets); in glob-style wildcards + single: ! (exclamation); in glob-style wildcards + single: - (minus); in glob-style wildcards + ++------------+------------------------------------+ +| Pattern | Meaning | ++============+====================================+ +| ``*`` | matches everything | ++------------+------------------------------------+ +| ``?`` | matches any single character | ++------------+------------------------------------+ +| ``[seq]`` | matches any character in *seq* | ++------------+------------------------------------+ +| ``[!seq]`` | matches any character not in *seq* | ++------------+------------------------------------+ + +For a literal match, wrap the meta-characters in brackets. +For example, ``'[?]'`` matches the character ``'?'``. + +.. index:: module: glob + +Note that the filename separator (``'/'`` on Unix) is *not* special to this +module. See module :mod:`glob` for pathname expansion (:mod:`glob` uses +:func:`.filter` to match pathname segments). Similarly, filenames starting with +a period are not special for this module, and are matched by the ``*`` and ``?`` +patterns. + + +.. function:: fnmatch(filename, pattern) + + Test whether the *filename* string matches the *pattern* string, returning + :const:`True` or :const:`False`. Both parameters are case-normalized + using :func:`os.path.normcase`. :func:`fnmatchcase` can be used to perform a + case-sensitive comparison, regardless of whether that's standard for the + operating system. + + This example will print all file names in the current directory with the + extension ``.txt``:: + + import fnmatch + import os + + for file in os.listdir('.'): + if fnmatch.fnmatch(file, '*.txt'): + print(file) + + +.. function:: fnmatchcase(filename, pattern) + + Test whether *filename* matches *pattern*, returning :const:`True` or + :const:`False`; the comparison is case-sensitive and does not apply + :func:`os.path.normcase`. + + +.. function:: filter(names, pattern) + + Return the subset of the list of *names* that match *pattern*. It is the same as + ``[n for n in names if fnmatch(n, pattern)]``, but implemented more efficiently. + + +.. function:: translate(pattern) + + Return the shell-style *pattern* converted to a regular expression for + using with :func:`re.match`. + + Example: + + >>> import fnmatch, re + >>> + >>> regex = fnmatch.translate('*.txt') + >>> regex + '(?s:.*\\.txt)\\Z' + >>> reobj = re.compile(regex) + >>> reobj.match('foobar.txt') + + + +.. seealso:: + + Module :mod:`glob` + Unix shell-style path expansion. diff --git a/python-3.7.4-docs-html/_sources/library/formatter.rst.txt b/python-3.7.4-docs-html/_sources/library/formatter.rst.txt new file mode 100644 index 0000000..6c10ac6 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/formatter.rst.txt @@ -0,0 +1,351 @@ +:mod:`formatter` --- Generic output formatting +============================================== + +.. module:: formatter + :synopsis: Generic output formatter and device interface. + :deprecated: + +.. deprecated:: 3.4 + Due to lack of usage, the formatter module has been deprecated. + +-------------- + +This module supports two interface definitions, each with multiple +implementations: The *formatter* interface, and the *writer* interface which is +required by the formatter interface. + +Formatter objects transform an abstract flow of formatting events into specific +output events on writer objects. Formatters manage several stack structures to +allow various properties of a writer object to be changed and restored; writers +need not be able to handle relative changes nor any sort of "change back" +operation. Specific writer properties which may be controlled via formatter +objects are horizontal alignment, font, and left margin indentations. A +mechanism is provided which supports providing arbitrary, non-exclusive style +settings to a writer as well. Additional interfaces facilitate formatting +events which are not reversible, such as paragraph separation. + +Writer objects encapsulate device interfaces. Abstract devices, such as file +formats, are supported as well as physical devices. The provided +implementations all work with abstract devices. The interface makes available +mechanisms for setting the properties which formatter objects manage and +inserting data into the output. + + +.. _formatter-interface: + +The Formatter Interface +----------------------- + +Interfaces to create formatters are dependent on the specific formatter class +being instantiated. The interfaces described below are the required interfaces +which all formatters must support once initialized. + +One data element is defined at the module level: + + +.. data:: AS_IS + + Value which can be used in the font specification passed to the ``push_font()`` + method described below, or as the new value to any other ``push_property()`` + method. Pushing the ``AS_IS`` value allows the corresponding ``pop_property()`` + method to be called without having to track whether the property was changed. + +The following attributes are defined for formatter instance objects: + + +.. attribute:: formatter.writer + + The writer instance with which the formatter interacts. + + +.. method:: formatter.end_paragraph(blanklines) + + Close any open paragraphs and insert at least *blanklines* before the next + paragraph. + + +.. method:: formatter.add_line_break() + + Add a hard line break if one does not already exist. This does not break the + logical paragraph. + + +.. method:: formatter.add_hor_rule(*args, **kw) + + Insert a horizontal rule in the output. A hard break is inserted if there is + data in the current paragraph, but the logical paragraph is not broken. The + arguments and keywords are passed on to the writer's :meth:`send_line_break` + method. + + +.. method:: formatter.add_flowing_data(data) + + Provide data which should be formatted with collapsed whitespace. Whitespace + from preceding and successive calls to :meth:`add_flowing_data` is considered as + well when the whitespace collapse is performed. The data which is passed to + this method is expected to be word-wrapped by the output device. Note that any + word-wrapping still must be performed by the writer object due to the need to + rely on device and font information. + + +.. method:: formatter.add_literal_data(data) + + Provide data which should be passed to the writer unchanged. Whitespace, + including newline and tab characters, are considered legal in the value of + *data*. + + +.. method:: formatter.add_label_data(format, counter) + + Insert a label which should be placed to the left of the current left margin. + This should be used for constructing bulleted or numbered lists. If the + *format* value is a string, it is interpreted as a format specification for + *counter*, which should be an integer. The result of this formatting becomes the + value of the label; if *format* is not a string it is used as the label value + directly. The label value is passed as the only argument to the writer's + :meth:`send_label_data` method. Interpretation of non-string label values is + dependent on the associated writer. + + Format specifications are strings which, in combination with a counter value, + are used to compute label values. Each character in the format string is copied + to the label value, with some characters recognized to indicate a transform on + the counter value. Specifically, the character ``'1'`` represents the counter + value formatter as an Arabic number, the characters ``'A'`` and ``'a'`` + represent alphabetic representations of the counter value in upper and lower + case, respectively, and ``'I'`` and ``'i'`` represent the counter value in Roman + numerals, in upper and lower case. Note that the alphabetic and roman + transforms require that the counter value be greater than zero. + + +.. method:: formatter.flush_softspace() + + Send any pending whitespace buffered from a previous call to + :meth:`add_flowing_data` to the associated writer object. This should be called + before any direct manipulation of the writer object. + + +.. method:: formatter.push_alignment(align) + + Push a new alignment setting onto the alignment stack. This may be + :const:`AS_IS` if no change is desired. If the alignment value is changed from + the previous setting, the writer's :meth:`new_alignment` method is called with + the *align* value. + + +.. method:: formatter.pop_alignment() + + Restore the previous alignment. + + +.. method:: formatter.push_font((size, italic, bold, teletype)) + + Change some or all font properties of the writer object. Properties which are + not set to :const:`AS_IS` are set to the values passed in while others are + maintained at their current settings. The writer's :meth:`new_font` method is + called with the fully resolved font specification. + + +.. method:: formatter.pop_font() + + Restore the previous font. + + +.. method:: formatter.push_margin(margin) + + Increase the number of left margin indentations by one, associating the logical + tag *margin* with the new indentation. The initial margin level is ``0``. + Changed values of the logical tag must be true values; false values other than + :const:`AS_IS` are not sufficient to change the margin. + + +.. method:: formatter.pop_margin() + + Restore the previous margin. + + +.. method:: formatter.push_style(*styles) + + Push any number of arbitrary style specifications. All styles are pushed onto + the styles stack in order. A tuple representing the entire stack, including + :const:`AS_IS` values, is passed to the writer's :meth:`new_styles` method. + + +.. method:: formatter.pop_style(n=1) + + Pop the last *n* style specifications passed to :meth:`push_style`. A tuple + representing the revised stack, including :const:`AS_IS` values, is passed to + the writer's :meth:`new_styles` method. + + +.. method:: formatter.set_spacing(spacing) + + Set the spacing style for the writer. + + +.. method:: formatter.assert_line_data(flag=1) + + Inform the formatter that data has been added to the current paragraph + out-of-band. This should be used when the writer has been manipulated + directly. The optional *flag* argument can be set to false if the writer + manipulations produced a hard line break at the end of the output. + + +.. _formatter-impls: + +Formatter Implementations +------------------------- + +Two implementations of formatter objects are provided by this module. Most +applications may use one of these classes without modification or subclassing. + + +.. class:: NullFormatter(writer=None) + + A formatter which does nothing. If *writer* is omitted, a :class:`NullWriter` + instance is created. No methods of the writer are called by + :class:`NullFormatter` instances. Implementations should inherit from this + class if implementing a writer interface but don't need to inherit any + implementation. + + +.. class:: AbstractFormatter(writer) + + The standard formatter. This implementation has demonstrated wide applicability + to many writers, and may be used directly in most circumstances. It has been + used to implement a full-featured World Wide Web browser. + + +.. _writer-interface: + +The Writer Interface +-------------------- + +Interfaces to create writers are dependent on the specific writer class being +instantiated. The interfaces described below are the required interfaces which +all writers must support once initialized. Note that while most applications can +use the :class:`AbstractFormatter` class as a formatter, the writer must +typically be provided by the application. + + +.. method:: writer.flush() + + Flush any buffered output or device control events. + + +.. method:: writer.new_alignment(align) + + Set the alignment style. The *align* value can be any object, but by convention + is a string or ``None``, where ``None`` indicates that the writer's "preferred" + alignment should be used. Conventional *align* values are ``'left'``, + ``'center'``, ``'right'``, and ``'justify'``. + + +.. method:: writer.new_font(font) + + Set the font style. The value of *font* will be ``None``, indicating that the + device's default font should be used, or a tuple of the form ``(size, + italic, bold, teletype)``. Size will be a string indicating the size of + font that should be used; specific strings and their interpretation must be + defined by the application. The *italic*, *bold*, and *teletype* values are + Boolean values specifying which of those font attributes should be used. + + +.. method:: writer.new_margin(margin, level) + + Set the margin level to the integer *level* and the logical tag to *margin*. + Interpretation of the logical tag is at the writer's discretion; the only + restriction on the value of the logical tag is that it not be a false value for + non-zero values of *level*. + + +.. method:: writer.new_spacing(spacing) + + Set the spacing style to *spacing*. + + +.. method:: writer.new_styles(styles) + + Set additional styles. The *styles* value is a tuple of arbitrary values; the + value :const:`AS_IS` should be ignored. The *styles* tuple may be interpreted + either as a set or as a stack depending on the requirements of the application + and writer implementation. + + +.. method:: writer.send_line_break() + + Break the current line. + + +.. method:: writer.send_paragraph(blankline) + + Produce a paragraph separation of at least *blankline* blank lines, or the + equivalent. The *blankline* value will be an integer. Note that the + implementation will receive a call to :meth:`send_line_break` before this call + if a line break is needed; this method should not include ending the last line + of the paragraph. It is only responsible for vertical spacing between + paragraphs. + + +.. method:: writer.send_hor_rule(*args, **kw) + + Display a horizontal rule on the output device. The arguments to this method + are entirely application- and writer-specific, and should be interpreted with + care. The method implementation may assume that a line break has already been + issued via :meth:`send_line_break`. + + +.. method:: writer.send_flowing_data(data) + + Output character data which may be word-wrapped and re-flowed as needed. Within + any sequence of calls to this method, the writer may assume that spans of + multiple whitespace characters have been collapsed to single space characters. + + +.. method:: writer.send_literal_data(data) + + Output character data which has already been formatted for display. Generally, + this should be interpreted to mean that line breaks indicated by newline + characters should be preserved and no new line breaks should be introduced. The + data may contain embedded newline and tab characters, unlike data provided to + the :meth:`send_formatted_data` interface. + + +.. method:: writer.send_label_data(data) + + Set *data* to the left of the current left margin, if possible. The value of + *data* is not restricted; treatment of non-string values is entirely + application- and writer-dependent. This method will only be called at the + beginning of a line. + + +.. _writer-impls: + +Writer Implementations +---------------------- + +Three implementations of the writer object interface are provided as examples by +this module. Most applications will need to derive new writer classes from the +:class:`NullWriter` class. + + +.. class:: NullWriter() + + A writer which only provides the interface definition; no actions are taken on + any methods. This should be the base class for all writers which do not need to + inherit any implementation methods. + + +.. class:: AbstractWriter() + + A writer which can be used in debugging formatters, but not much else. Each + method simply announces itself by printing its name and arguments on standard + output. + + +.. class:: DumbWriter(file=None, maxcol=72) + + Simple writer class which writes output on the :term:`file object` passed + in as *file* or, if *file* is omitted, on standard output. The output is + simply word-wrapped to the number of columns specified by *maxcol*. This + class is suitable for reflowing a sequence of paragraphs. + diff --git a/python-3.7.4-docs-html/_sources/library/fractions.rst.txt b/python-3.7.4-docs-html/_sources/library/fractions.rst.txt new file mode 100644 index 0000000..b5a818e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/fractions.rst.txt @@ -0,0 +1,183 @@ +:mod:`fractions` --- Rational numbers +===================================== + +.. module:: fractions + :synopsis: Rational numbers. + +.. moduleauthor:: Jeffrey Yasskin +.. sectionauthor:: Jeffrey Yasskin + +**Source code:** :source:`Lib/fractions.py` + +-------------- + +The :mod:`fractions` module provides support for rational number arithmetic. + + +A Fraction instance can be constructed from a pair of integers, from +another rational number, or from a string. + +.. class:: Fraction(numerator=0, denominator=1) + Fraction(other_fraction) + Fraction(float) + Fraction(decimal) + Fraction(string) + + The first version requires that *numerator* and *denominator* are instances + of :class:`numbers.Rational` and returns a new :class:`Fraction` instance + with value ``numerator/denominator``. If *denominator* is :const:`0`, it + raises a :exc:`ZeroDivisionError`. The second version requires that + *other_fraction* is an instance of :class:`numbers.Rational` and returns a + :class:`Fraction` instance with the same value. The next two versions accept + either a :class:`float` or a :class:`decimal.Decimal` instance, and return a + :class:`Fraction` instance with exactly the same value. Note that due to the + usual issues with binary floating-point (see :ref:`tut-fp-issues`), the + argument to ``Fraction(1.1)`` is not exactly equal to 11/10, and so + ``Fraction(1.1)`` does *not* return ``Fraction(11, 10)`` as one might expect. + (But see the documentation for the :meth:`limit_denominator` method below.) + The last version of the constructor expects a string or unicode instance. + The usual form for this instance is:: + + [sign] numerator ['/' denominator] + + where the optional ``sign`` may be either '+' or '-' and + ``numerator`` and ``denominator`` (if present) are strings of + decimal digits. In addition, any string that represents a finite + value and is accepted by the :class:`float` constructor is also + accepted by the :class:`Fraction` constructor. In either form the + input string may also have leading and/or trailing whitespace. + Here are some examples:: + + >>> from fractions import Fraction + >>> Fraction(16, -10) + Fraction(-8, 5) + >>> Fraction(123) + Fraction(123, 1) + >>> Fraction() + Fraction(0, 1) + >>> Fraction('3/7') + Fraction(3, 7) + >>> Fraction(' -3/7 ') + Fraction(-3, 7) + >>> Fraction('1.414213 \t\n') + Fraction(1414213, 1000000) + >>> Fraction('-.125') + Fraction(-1, 8) + >>> Fraction('7e-6') + Fraction(7, 1000000) + >>> Fraction(2.25) + Fraction(9, 4) + >>> Fraction(1.1) + Fraction(2476979795053773, 2251799813685248) + >>> from decimal import Decimal + >>> Fraction(Decimal('1.1')) + Fraction(11, 10) + + + The :class:`Fraction` class inherits from the abstract base class + :class:`numbers.Rational`, and implements all of the methods and + operations from that class. :class:`Fraction` instances are hashable, + and should be treated as immutable. In addition, + :class:`Fraction` has the following properties and methods: + + .. versionchanged:: 3.2 + The :class:`Fraction` constructor now accepts :class:`float` and + :class:`decimal.Decimal` instances. + + + .. attribute:: numerator + + Numerator of the Fraction in lowest term. + + .. attribute:: denominator + + Denominator of the Fraction in lowest term. + + + .. method:: from_float(flt) + + This class method constructs a :class:`Fraction` representing the exact + value of *flt*, which must be a :class:`float`. Beware that + ``Fraction.from_float(0.3)`` is not the same value as ``Fraction(3, 10)``. + + .. note:: + + From Python 3.2 onwards, you can also construct a + :class:`Fraction` instance directly from a :class:`float`. + + + .. method:: from_decimal(dec) + + This class method constructs a :class:`Fraction` representing the exact + value of *dec*, which must be a :class:`decimal.Decimal` instance. + + .. note:: + + From Python 3.2 onwards, you can also construct a + :class:`Fraction` instance directly from a :class:`decimal.Decimal` + instance. + + + .. method:: limit_denominator(max_denominator=1000000) + + Finds and returns the closest :class:`Fraction` to ``self`` that has + denominator at most max_denominator. This method is useful for finding + rational approximations to a given floating-point number: + + >>> from fractions import Fraction + >>> Fraction('3.1415926535897932').limit_denominator(1000) + Fraction(355, 113) + + or for recovering a rational number that's represented as a float: + + >>> from math import pi, cos + >>> Fraction(cos(pi/3)) + Fraction(4503599627370497, 9007199254740992) + >>> Fraction(cos(pi/3)).limit_denominator() + Fraction(1, 2) + >>> Fraction(1.1).limit_denominator() + Fraction(11, 10) + + + .. method:: __floor__() + + Returns the greatest :class:`int` ``<= self``. This method can + also be accessed through the :func:`math.floor` function: + + >>> from math import floor + >>> floor(Fraction(355, 113)) + 3 + + + .. method:: __ceil__() + + Returns the least :class:`int` ``>= self``. This method can + also be accessed through the :func:`math.ceil` function. + + + .. method:: __round__() + __round__(ndigits) + + The first version returns the nearest :class:`int` to ``self``, + rounding half to even. The second version rounds ``self`` to the + nearest multiple of ``Fraction(1, 10**ndigits)`` (logically, if + ``ndigits`` is negative), again rounding half toward even. This + method can also be accessed through the :func:`round` function. + + +.. function:: gcd(a, b) + + Return the greatest common divisor of the integers *a* and *b*. If either + *a* or *b* is nonzero, then the absolute value of ``gcd(a, b)`` is the + largest integer that divides both *a* and *b*. ``gcd(a,b)`` has the same + sign as *b* if *b* is nonzero; otherwise it takes the sign of *a*. ``gcd(0, + 0)`` returns ``0``. + + .. deprecated:: 3.5 + Use :func:`math.gcd` instead. + + +.. seealso:: + + Module :mod:`numbers` + The abstract base classes making up the numeric tower. diff --git a/python-3.7.4-docs-html/_sources/library/frameworks.rst.txt b/python-3.7.4-docs-html/_sources/library/frameworks.rst.txt new file mode 100644 index 0000000..15ceeec --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/frameworks.rst.txt @@ -0,0 +1,18 @@ +.. _frameworks: + +****************** +Program Frameworks +****************** + +The modules described in this chapter are frameworks that will largely dictate +the structure of your program. Currently the modules described here are all +oriented toward writing command-line interfaces. + +The full list of modules described in this chapter is: + + +.. toctree:: + + turtle.rst + cmd.rst + shlex.rst diff --git a/python-3.7.4-docs-html/_sources/library/ftplib.rst.txt b/python-3.7.4-docs-html/_sources/library/ftplib.rst.txt new file mode 100644 index 0000000..6c39f9a --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/ftplib.rst.txt @@ -0,0 +1,442 @@ +:mod:`ftplib` --- FTP protocol client +===================================== + +.. module:: ftplib + :synopsis: FTP protocol client (requires sockets). + +**Source code:** :source:`Lib/ftplib.py` + +.. index:: + pair: FTP; protocol + single: FTP; ftplib (standard module) + +-------------- + +This module defines the class :class:`FTP` and a few related items. The +:class:`FTP` class implements the client side of the FTP protocol. You can use +this to write Python programs that perform a variety of automated FTP jobs, such +as mirroring other FTP servers. It is also used by the module +:mod:`urllib.request` to handle URLs that use FTP. For more information on FTP +(File Transfer Protocol), see Internet :rfc:`959`. + +Here's a sample session using the :mod:`ftplib` module:: + + >>> from ftplib import FTP + >>> ftp = FTP('ftp.debian.org') # connect to host, default port + >>> ftp.login() # user anonymous, passwd anonymous@ + '230 Login successful.' + >>> ftp.cwd('debian') # change into "debian" directory + >>> ftp.retrlines('LIST') # list directory contents + -rw-rw-r-- 1 1176 1176 1063 Jun 15 10:18 README + ... + drwxr-sr-x 5 1176 1176 4096 Dec 19 2000 pool + drwxr-sr-x 4 1176 1176 4096 Nov 17 2008 project + drwxr-xr-x 3 1176 1176 4096 Oct 10 2012 tools + '226 Directory send OK.' + >>> ftp.retrbinary('RETR README', open('README', 'wb').write) + '226 Transfer complete.' + >>> ftp.quit() + + +The module defines the following items: + +.. class:: FTP(host='', user='', passwd='', acct='', timeout=None, source_address=None) + + Return a new instance of the :class:`FTP` class. When *host* is given, the + method call ``connect(host)`` is made. When *user* is given, additionally + the method call ``login(user, passwd, acct)`` is made (where *passwd* and + *acct* default to the empty string when not given). The optional *timeout* + parameter specifies a timeout in seconds for blocking operations like the + connection attempt (if is not specified, the global default timeout setting + will be used). *source_address* is a 2-tuple ``(host, port)`` for the socket + to bind to as its source address before connecting. + + The :class:`FTP` class supports the :keyword:`with` statement, e.g.: + + >>> from ftplib import FTP + >>> with FTP("ftp1.at.proftpd.org") as ftp: + ... ftp.login() + ... ftp.dir() + ... # doctest: +SKIP + '230 Anonymous login ok, restrictions apply.' + dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 . + dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 .. + dr-xr-xr-x 5 ftp ftp 4096 May 6 10:43 CentOS + dr-xr-xr-x 3 ftp ftp 18 Jul 10 2008 Fedora + >>> + + .. versionchanged:: 3.2 + Support for the :keyword:`with` statement was added. + + .. versionchanged:: 3.3 + *source_address* parameter was added. + + +.. class:: FTP_TLS(host='', user='', passwd='', acct='', keyfile=None, certfile=None, context=None, timeout=None, source_address=None) + + A :class:`FTP` subclass which adds TLS support to FTP as described in + :rfc:`4217`. + Connect as usual to port 21 implicitly securing the FTP control connection + before authenticating. Securing the data connection requires the user to + explicitly ask for it by calling the :meth:`prot_p` method. *context* + is a :class:`ssl.SSLContext` object which allows bundling SSL configuration + options, certificates and private keys into a single (potentially + long-lived) structure. Please read :ref:`ssl-security` for best practices. + + *keyfile* and *certfile* are a legacy alternative to *context* -- they + can point to PEM-formatted private key and certificate chain files + (respectively) for the SSL connection. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.3 + *source_address* parameter was added. + + .. versionchanged:: 3.4 + The class now supports hostname check with + :attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see + :data:`ssl.HAS_SNI`). + + .. deprecated:: 3.6 + + *keyfile* and *certfile* are deprecated in favor of *context*. + Please use :meth:`ssl.SSLContext.load_cert_chain` instead, or let + :func:`ssl.create_default_context` select the system's trusted CA + certificates for you. + + Here's a sample session using the :class:`FTP_TLS` class:: + + >>> ftps = FTP_TLS('ftp.pureftpd.org') + >>> ftps.login() + '230 Anonymous user logged in' + >>> ftps.prot_p() + '200 Data protection level set to "private"' + >>> ftps.nlst() + ['6jack', 'OpenBSD', 'antilink', 'blogbench', 'bsdcam', 'clockspeed', 'djbdns-jedi', 'docs', 'eaccelerator-jedi', 'favicon.ico', 'francotone', 'fugu', 'ignore', 'libpuzzle', 'metalog', 'minidentd', 'misc', 'mysql-udf-global-user-variables', 'php-jenkins-hash', 'php-skein-hash', 'php-webdav', 'phpaudit', 'phpbench', 'pincaster', 'ping', 'posto', 'pub', 'public', 'public_keys', 'pure-ftpd', 'qscan', 'qtc', 'sharedance', 'skycache', 'sound', 'tmp', 'ucarp'] + + +.. exception:: error_reply + + Exception raised when an unexpected reply is received from the server. + + +.. exception:: error_temp + + Exception raised when an error code signifying a temporary error (response + codes in the range 400--499) is received. + + +.. exception:: error_perm + + Exception raised when an error code signifying a permanent error (response + codes in the range 500--599) is received. + + +.. exception:: error_proto + + Exception raised when a reply is received from the server that does not fit + the response specifications of the File Transfer Protocol, i.e. begin with a + digit in the range 1--5. + + +.. data:: all_errors + + The set of all exceptions (as a tuple) that methods of :class:`FTP` + instances may raise as a result of problems with the FTP connection (as + opposed to programming errors made by the caller). This set includes the + four exceptions listed above as well as :exc:`OSError`. + + +.. seealso:: + + Module :mod:`netrc` + Parser for the :file:`.netrc` file format. The file :file:`.netrc` is + typically used by FTP clients to load user authentication information + before prompting the user. + + +.. _ftp-objects: + +FTP Objects +----------- + +Several methods are available in two flavors: one for handling text files and +another for binary files. These are named for the command which is used +followed by ``lines`` for the text version or ``binary`` for the binary version. + +:class:`FTP` instances have the following methods: + + +.. method:: FTP.set_debuglevel(level) + + Set the instance's debugging level. This controls the amount of debugging + output printed. The default, ``0``, produces no debugging output. A value of + ``1`` produces a moderate amount of debugging output, generally a single line + per request. A value of ``2`` or higher produces the maximum amount of + debugging output, logging each line sent and received on the control connection. + + +.. method:: FTP.connect(host='', port=0, timeout=None, source_address=None) + + Connect to the given host and port. The default port number is ``21``, as + specified by the FTP protocol specification. It is rarely needed to specify a + different port number. This function should be called only once for each + instance; it should not be called at all if a host was given when the instance + was created. All other methods can only be used after a connection has been + made. + The optional *timeout* parameter specifies a timeout in seconds for the + connection attempt. If no *timeout* is passed, the global default timeout + setting will be used. + *source_address* is a 2-tuple ``(host, port)`` for the socket to bind to as + its source address before connecting. + + .. versionchanged:: 3.3 + *source_address* parameter was added. + + +.. method:: FTP.getwelcome() + + Return the welcome message sent by the server in reply to the initial + connection. (This message sometimes contains disclaimers or help information + that may be relevant to the user.) + + +.. method:: FTP.login(user='anonymous', passwd='', acct='') + + Log in as the given *user*. The *passwd* and *acct* parameters are optional and + default to the empty string. If no *user* is specified, it defaults to + ``'anonymous'``. If *user* is ``'anonymous'``, the default *passwd* is + ``'anonymous@'``. This function should be called only once for each instance, + after a connection has been established; it should not be called at all if a + host and user were given when the instance was created. Most FTP commands are + only allowed after the client has logged in. The *acct* parameter supplies + "accounting information"; few systems implement this. + + +.. method:: FTP.abort() + + Abort a file transfer that is in progress. Using this does not always work, but + it's worth a try. + + +.. method:: FTP.sendcmd(cmd) + + Send a simple command string to the server and return the response string. + + +.. method:: FTP.voidcmd(cmd) + + Send a simple command string to the server and handle the response. Return + nothing if a response code corresponding to success (codes in the range + 200--299) is received. Raise :exc:`error_reply` otherwise. + + +.. method:: FTP.retrbinary(cmd, callback, blocksize=8192, rest=None) + + Retrieve a file in binary transfer mode. *cmd* should be an appropriate + ``RETR`` command: ``'RETR filename'``. The *callback* function is called for + each block of data received, with a single bytes argument giving the data + block. The optional *blocksize* argument specifies the maximum chunk size to + read on the low-level socket object created to do the actual transfer (which + will also be the largest size of the data blocks passed to *callback*). A + reasonable default is chosen. *rest* means the same thing as in the + :meth:`transfercmd` method. + + +.. method:: FTP.retrlines(cmd, callback=None) + + Retrieve a file or directory listing in ASCII transfer mode. *cmd* should be + an appropriate ``RETR`` command (see :meth:`retrbinary`) or a command such as + ``LIST`` or ``NLST`` (usually just the string ``'LIST'``). + ``LIST`` retrieves a list of files and information about those files. + ``NLST`` retrieves a list of file names. + The *callback* function is called for each line with a string argument + containing the line with the trailing CRLF stripped. The default *callback* + prints the line to ``sys.stdout``. + + +.. method:: FTP.set_pasv(val) + + Enable "passive" mode if *val* is true, otherwise disable passive mode. + Passive mode is on by default. + + +.. method:: FTP.storbinary(cmd, fp, blocksize=8192, callback=None, rest=None) + + Store a file in binary transfer mode. *cmd* should be an appropriate + ``STOR`` command: ``"STOR filename"``. *fp* is a :term:`file object` + (opened in binary mode) which is read until EOF using its :meth:`~io.IOBase.read` + method in blocks of size *blocksize* to provide the data to be stored. + The *blocksize* argument defaults to 8192. *callback* is an optional single + parameter callable that is called on each block of data after it is sent. + *rest* means the same thing as in the :meth:`transfercmd` method. + + .. versionchanged:: 3.2 + *rest* parameter added. + + +.. method:: FTP.storlines(cmd, fp, callback=None) + + Store a file in ASCII transfer mode. *cmd* should be an appropriate + ``STOR`` command (see :meth:`storbinary`). Lines are read until EOF from the + :term:`file object` *fp* (opened in binary mode) using its :meth:`~io.IOBase.readline` + method to provide the data to be stored. *callback* is an optional single + parameter callable that is called on each line after it is sent. + + +.. method:: FTP.transfercmd(cmd, rest=None) + + Initiate a transfer over the data connection. If the transfer is active, send an + ``EPRT`` or ``PORT`` command and the transfer command specified by *cmd*, and + accept the connection. If the server is passive, send an ``EPSV`` or ``PASV`` + command, connect to it, and start the transfer command. Either way, return the + socket for the connection. + + If optional *rest* is given, a ``REST`` command is sent to the server, passing + *rest* as an argument. *rest* is usually a byte offset into the requested file, + telling the server to restart sending the file's bytes at the requested offset, + skipping over the initial bytes. Note however that :rfc:`959` requires only that + *rest* be a string containing characters in the printable range from ASCII code + 33 to ASCII code 126. The :meth:`transfercmd` method, therefore, converts + *rest* to a string, but no check is performed on the string's contents. If the + server does not recognize the ``REST`` command, an :exc:`error_reply` exception + will be raised. If this happens, simply call :meth:`transfercmd` without a + *rest* argument. + + +.. method:: FTP.ntransfercmd(cmd, rest=None) + + Like :meth:`transfercmd`, but returns a tuple of the data connection and the + expected size of the data. If the expected size could not be computed, ``None`` + will be returned as the expected size. *cmd* and *rest* means the same thing as + in :meth:`transfercmd`. + + +.. method:: FTP.mlsd(path="", facts=[]) + + List a directory in a standardized format by using ``MLSD`` command + (:rfc:`3659`). If *path* is omitted the current directory is assumed. + *facts* is a list of strings representing the type of information desired + (e.g. ``["type", "size", "perm"]``). Return a generator object yielding a + tuple of two elements for every file found in path. First element is the + file name, the second one is a dictionary containing facts about the file + name. Content of this dictionary might be limited by the *facts* argument + but server is not guaranteed to return all requested facts. + + .. versionadded:: 3.3 + + +.. method:: FTP.nlst(argument[, ...]) + + Return a list of file names as returned by the ``NLST`` command. The + optional *argument* is a directory to list (default is the current server + directory). Multiple arguments can be used to pass non-standard options to + the ``NLST`` command. + + .. note:: If your server supports the command, :meth:`mlsd` offers a better API. + + +.. method:: FTP.dir(argument[, ...]) + + Produce a directory listing as returned by the ``LIST`` command, printing it to + standard output. The optional *argument* is a directory to list (default is the + current server directory). Multiple arguments can be used to pass non-standard + options to the ``LIST`` command. If the last argument is a function, it is used + as a *callback* function as for :meth:`retrlines`; the default prints to + ``sys.stdout``. This method returns ``None``. + + .. note:: If your server supports the command, :meth:`mlsd` offers a better API. + + +.. method:: FTP.rename(fromname, toname) + + Rename file *fromname* on the server to *toname*. + + +.. method:: FTP.delete(filename) + + Remove the file named *filename* from the server. If successful, returns the + text of the response, otherwise raises :exc:`error_perm` on permission errors or + :exc:`error_reply` on other errors. + + +.. method:: FTP.cwd(pathname) + + Set the current directory on the server. + + +.. method:: FTP.mkd(pathname) + + Create a new directory on the server. + + +.. method:: FTP.pwd() + + Return the pathname of the current directory on the server. + + +.. method:: FTP.rmd(dirname) + + Remove the directory named *dirname* on the server. + + +.. method:: FTP.size(filename) + + Request the size of the file named *filename* on the server. On success, the + size of the file is returned as an integer, otherwise ``None`` is returned. + Note that the ``SIZE`` command is not standardized, but is supported by many + common server implementations. + + +.. method:: FTP.quit() + + Send a ``QUIT`` command to the server and close the connection. This is the + "polite" way to close a connection, but it may raise an exception if the server + responds with an error to the ``QUIT`` command. This implies a call to the + :meth:`close` method which renders the :class:`FTP` instance useless for + subsequent calls (see below). + + +.. method:: FTP.close() + + Close the connection unilaterally. This should not be applied to an already + closed connection such as after a successful call to :meth:`~FTP.quit`. + After this call the :class:`FTP` instance should not be used any more (after + a call to :meth:`close` or :meth:`~FTP.quit` you cannot reopen the + connection by issuing another :meth:`login` method). + + +FTP_TLS Objects +--------------- + +:class:`FTP_TLS` class inherits from :class:`FTP`, defining these additional objects: + +.. attribute:: FTP_TLS.ssl_version + + The SSL version to use (defaults to :attr:`ssl.PROTOCOL_SSLv23`). + +.. method:: FTP_TLS.auth() + + Set up a secure control connection by using TLS or SSL, depending on what + is specified in the :attr:`ssl_version` attribute. + + .. versionchanged:: 3.4 + The method now supports hostname check with + :attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see + :data:`ssl.HAS_SNI`). + +.. method:: FTP_TLS.ccc() + + Revert control channel back to plaintext. This can be useful to take + advantage of firewalls that know how to handle NAT with non-secure FTP + without opening fixed ports. + + .. versionadded:: 3.3 + +.. method:: FTP_TLS.prot_p() + + Set up secure data connection. + +.. method:: FTP_TLS.prot_c() + + Set up clear text data connection. diff --git a/python-3.7.4-docs-html/_sources/library/functional.rst.txt b/python-3.7.4-docs-html/_sources/library/functional.rst.txt new file mode 100644 index 0000000..5b6185a --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/functional.rst.txt @@ -0,0 +1,15 @@ +****************************** +Functional Programming Modules +****************************** + +The modules described in this chapter provide functions and classes that support +a functional programming style, and general operations on callables. + +The following modules are documented in this chapter: + + +.. toctree:: + + itertools.rst + functools.rst + operator.rst diff --git a/python-3.7.4-docs-html/_sources/library/functions.rst.txt b/python-3.7.4-docs-html/_sources/library/functions.rst.txt new file mode 100644 index 0000000..1114752 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/functions.rst.txt @@ -0,0 +1,1729 @@ +.. XXX document all delegations to __special__ methods +.. _built-in-funcs: + +Built-in Functions +================== + +The Python interpreter has a number of functions and types built into it that +are always available. They are listed here in alphabetical order. + +=================== ================= ================== ================== ==================== +.. .. Built-in Functions .. .. +=================== ================= ================== ================== ==================== +:func:`abs` :func:`delattr` :func:`hash` |func-memoryview|_ |func-set|_ +:func:`all` |func-dict|_ :func:`help` :func:`min` :func:`setattr` +:func:`any` :func:`dir` :func:`hex` :func:`next` :func:`slice` +:func:`ascii` :func:`divmod` :func:`id` :func:`object` :func:`sorted` +:func:`bin` :func:`enumerate` :func:`input` :func:`oct` :func:`staticmethod` +:func:`bool` :func:`eval` :func:`int` :func:`open` |func-str|_ +:func:`breakpoint` :func:`exec` :func:`isinstance` :func:`ord` :func:`sum` +|func-bytearray|_ :func:`filter` :func:`issubclass` :func:`pow` :func:`super` +|func-bytes|_ :func:`float` :func:`iter` :func:`print` |func-tuple|_ +:func:`callable` :func:`format` :func:`len` :func:`property` :func:`type` +:func:`chr` |func-frozenset|_ |func-list|_ |func-range|_ :func:`vars` +:func:`classmethod` :func:`getattr` :func:`locals` :func:`repr` :func:`zip` +:func:`compile` :func:`globals` :func:`map` :func:`reversed` :func:`__import__` +:func:`complex` :func:`hasattr` :func:`max` :func:`round` +=================== ================= ================== ================== ==================== + +.. using :func:`dict` would create a link to another page, so local targets are + used, with replacement texts to make the output in the table consistent + +.. |func-dict| replace:: ``dict()`` +.. |func-frozenset| replace:: ``frozenset()`` +.. |func-memoryview| replace:: ``memoryview()`` +.. |func-set| replace:: ``set()`` +.. |func-list| replace:: ``list()`` +.. |func-str| replace:: ``str()`` +.. |func-tuple| replace:: ``tuple()`` +.. |func-range| replace:: ``range()`` +.. |func-bytearray| replace:: ``bytearray()`` +.. |func-bytes| replace:: ``bytes()`` + +.. function:: abs(x) + + Return the absolute value of a number. The argument may be an + integer or a floating point number. If the argument is a complex number, its + magnitude is returned. + + +.. function:: all(iterable) + + Return ``True`` if all elements of the *iterable* are true (or if the iterable + is empty). Equivalent to:: + + def all(iterable): + for element in iterable: + if not element: + return False + return True + + +.. function:: any(iterable) + + Return ``True`` if any element of the *iterable* is true. If the iterable + is empty, return ``False``. Equivalent to:: + + def any(iterable): + for element in iterable: + if element: + return True + return False + + +.. function:: ascii(object) + + As :func:`repr`, return a string containing a printable representation of an + object, but escape the non-ASCII characters in the string returned by + :func:`repr` using ``\x``, ``\u`` or ``\U`` escapes. This generates a string + similar to that returned by :func:`repr` in Python 2. + + +.. function:: bin(x) + + Convert an integer number to a binary string prefixed with "0b". The result + is a valid Python expression. If *x* is not a Python :class:`int` object, it + has to define an :meth:`__index__` method that returns an integer. Some + examples: + + >>> bin(3) + '0b11' + >>> bin(-10) + '-0b1010' + + If prefix "0b" is desired or not, you can use either of the following ways. + + >>> format(14, '#b'), format(14, 'b') + ('0b1110', '1110') + >>> f'{14:#b}', f'{14:b}' + ('0b1110', '1110') + + See also :func:`format` for more information. + + +.. class:: bool([x]) + + Return a Boolean value, i.e. one of ``True`` or ``False``. *x* is converted + using the standard :ref:`truth testing procedure `. If *x* is false + or omitted, this returns ``False``; otherwise it returns ``True``. The + :class:`bool` class is a subclass of :class:`int` (see :ref:`typesnumeric`). + It cannot be subclassed further. Its only instances are ``False`` and + ``True`` (see :ref:`bltin-boolean-values`). + + .. index:: pair: Boolean; type + + .. versionchanged:: 3.7 + *x* is now a positional-only parameter. + +.. function:: breakpoint(*args, **kws) + + This function drops you into the debugger at the call site. Specifically, + it calls :func:`sys.breakpointhook`, passing ``args`` and ``kws`` straight + through. By default, ``sys.breakpointhook()`` calls + :func:`pdb.set_trace()` expecting no arguments. In this case, it is + purely a convenience function so you don't have to explicitly import + :mod:`pdb` or type as much code to enter the debugger. However, + :func:`sys.breakpointhook` can be set to some other function and + :func:`breakpoint` will automatically call that, allowing you to drop into + the debugger of choice. + + .. versionadded:: 3.7 + +.. _func-bytearray: +.. class:: bytearray([source[, encoding[, errors]]]) + :noindex: + + Return a new array of bytes. The :class:`bytearray` class is a mutable + sequence of integers in the range 0 <= x < 256. It has most of the usual + methods of mutable sequences, described in :ref:`typesseq-mutable`, as well + as most methods that the :class:`bytes` type has, see :ref:`bytes-methods`. + + The optional *source* parameter can be used to initialize the array in a few + different ways: + + * If it is a *string*, you must also give the *encoding* (and optionally, + *errors*) parameters; :func:`bytearray` then converts the string to + bytes using :meth:`str.encode`. + + * If it is an *integer*, the array will have that size and will be + initialized with null bytes. + + * If it is an object conforming to the *buffer* interface, a read-only buffer + of the object will be used to initialize the bytes array. + + * If it is an *iterable*, it must be an iterable of integers in the range + ``0 <= x < 256``, which are used as the initial contents of the array. + + Without an argument, an array of size 0 is created. + + See also :ref:`binaryseq` and :ref:`typebytearray`. + + +.. _func-bytes: +.. class:: bytes([source[, encoding[, errors]]]) + :noindex: + + Return a new "bytes" object, which is an immutable sequence of integers in + the range ``0 <= x < 256``. :class:`bytes` is an immutable version of + :class:`bytearray` -- it has the same non-mutating methods and the same + indexing and slicing behavior. + + Accordingly, constructor arguments are interpreted as for :func:`bytearray`. + + Bytes objects can also be created with literals, see :ref:`strings`. + + See also :ref:`binaryseq`, :ref:`typebytes`, and :ref:`bytes-methods`. + + +.. function:: callable(object) + + Return :const:`True` if the *object* argument appears callable, + :const:`False` if not. If this returns true, it is still possible that a + call fails, but if it is false, calling *object* will never succeed. + Note that classes are callable (calling a class returns a new instance); + instances are callable if their class has a :meth:`__call__` method. + + .. versionadded:: 3.2 + This function was first removed in Python 3.0 and then brought back + in Python 3.2. + + +.. function:: chr(i) + + Return the string representing a character whose Unicode code point is the + integer *i*. For example, ``chr(97)`` returns the string ``'a'``, while + ``chr(8364)`` returns the string ``'€'``. This is the inverse of :func:`ord`. + + The valid range for the argument is from 0 through 1,114,111 (0x10FFFF in + base 16). :exc:`ValueError` will be raised if *i* is outside that range. + + +.. decorator:: classmethod + + Transform a method into a class method. + + A class method receives the class as implicit first argument, just like an + instance method receives the instance. To declare a class method, use this + idiom:: + + class C: + @classmethod + def f(cls, arg1, arg2, ...): ... + + The ``@classmethod`` form is a function :term:`decorator` -- see + :ref:`function` for details. + + A class method can be called either on the class (such as ``C.f()``) or on an instance (such + as ``C().f()``). The instance is ignored except for its class. If a class + method is called for a derived class, the derived class object is passed as the + implied first argument. + + Class methods are different than C++ or Java static methods. If you want those, + see :func:`staticmethod`. + + For more information on class methods, see :ref:`types`. + + +.. function:: compile(source, filename, mode, flags=0, dont_inherit=False, optimize=-1) + + Compile the *source* into a code or AST object. Code objects can be executed + by :func:`exec` or :func:`eval`. *source* can either be a normal string, a + byte string, or an AST object. Refer to the :mod:`ast` module documentation + for information on how to work with AST objects. + + The *filename* argument should give the file from which the code was read; + pass some recognizable value if it wasn't read from a file (``''`` is + commonly used). + + The *mode* argument specifies what kind of code must be compiled; it can be + ``'exec'`` if *source* consists of a sequence of statements, ``'eval'`` if it + consists of a single expression, or ``'single'`` if it consists of a single + interactive statement (in the latter case, expression statements that + evaluate to something other than ``None`` will be printed). + + The optional arguments *flags* and *dont_inherit* control which :ref:`future + statements ` affect the compilation of *source*. If neither + is present (or both are zero) the code is compiled with those future + statements that are in effect in the code that is calling :func:`compile`. If the + *flags* argument is given and *dont_inherit* is not (or is zero) then the + future statements specified by the *flags* argument are used in addition to + those that would be used anyway. If *dont_inherit* is a non-zero integer then + the *flags* argument is it -- the future statements in effect around the call + to compile are ignored. + + Future statements are specified by bits which can be bitwise ORed together to + specify multiple statements. The bitfield required to specify a given feature + can be found as the :attr:`~__future__._Feature.compiler_flag` attribute on + the :class:`~__future__._Feature` instance in the :mod:`__future__` module. + + The argument *optimize* specifies the optimization level of the compiler; the + default value of ``-1`` selects the optimization level of the interpreter as + given by :option:`-O` options. Explicit levels are ``0`` (no optimization; + ``__debug__`` is true), ``1`` (asserts are removed, ``__debug__`` is false) + or ``2`` (docstrings are removed too). + + This function raises :exc:`SyntaxError` if the compiled source is invalid, + and :exc:`ValueError` if the source contains null bytes. + + If you want to parse Python code into its AST representation, see + :func:`ast.parse`. + + .. note:: + + When compiling a string with multi-line code in ``'single'`` or + ``'eval'`` mode, input must be terminated by at least one newline + character. This is to facilitate detection of incomplete and complete + statements in the :mod:`code` module. + + .. warning:: + + It is possible to crash the Python interpreter with a + sufficiently large/complex string when compiling to an AST + object due to stack depth limitations in Python's AST compiler. + + .. versionchanged:: 3.2 + Allowed use of Windows and Mac newlines. Also input in ``'exec'`` mode + does not have to end in a newline anymore. Added the *optimize* parameter. + + .. versionchanged:: 3.5 + Previously, :exc:`TypeError` was raised when null bytes were encountered + in *source*. + + +.. class:: complex([real[, imag]]) + + Return a complex number with the value *real* + *imag*\*1j or convert a string + or number to a complex number. If the first parameter is a string, it will + be interpreted as a complex number and the function must be called without a + second parameter. The second parameter can never be a string. Each argument + may be any numeric type (including complex). If *imag* is omitted, it + defaults to zero and the constructor serves as a numeric conversion like + :class:`int` and :class:`float`. If both arguments are omitted, returns + ``0j``. + + .. note:: + + When converting from a string, the string must not contain whitespace + around the central ``+`` or ``-`` operator. For example, + ``complex('1+2j')`` is fine, but ``complex('1 + 2j')`` raises + :exc:`ValueError`. + + The complex type is described in :ref:`typesnumeric`. + + .. versionchanged:: 3.6 + Grouping digits with underscores as in code literals is allowed. + + +.. function:: delattr(object, name) + + This is a relative of :func:`setattr`. The arguments are an object and a + string. The string must be the name of one of the object's attributes. The + function deletes the named attribute, provided the object allows it. For + example, ``delattr(x, 'foobar')`` is equivalent to ``del x.foobar``. + + +.. _func-dict: +.. class:: dict(**kwarg) + dict(mapping, **kwarg) + dict(iterable, **kwarg) + :noindex: + + Create a new dictionary. The :class:`dict` object is the dictionary class. + See :class:`dict` and :ref:`typesmapping` for documentation about this class. + + For other containers see the built-in :class:`list`, :class:`set`, and + :class:`tuple` classes, as well as the :mod:`collections` module. + + +.. function:: dir([object]) + + Without arguments, return the list of names in the current local scope. With an + argument, attempt to return a list of valid attributes for that object. + + If the object has a method named :meth:`__dir__`, this method will be called and + must return the list of attributes. This allows objects that implement a custom + :func:`__getattr__` or :func:`__getattribute__` function to customize the way + :func:`dir` reports their attributes. + + If the object does not provide :meth:`__dir__`, the function tries its best to + gather information from the object's :attr:`~object.__dict__` attribute, if defined, and + from its type object. The resulting list is not necessarily complete, and may + be inaccurate when the object has a custom :func:`__getattr__`. + + The default :func:`dir` mechanism behaves differently with different types of + objects, as it attempts to produce the most relevant, rather than complete, + information: + + * If the object is a module object, the list contains the names of the module's + attributes. + + * If the object is a type or class object, the list contains the names of its + attributes, and recursively of the attributes of its bases. + + * Otherwise, the list contains the object's attributes' names, the names of its + class's attributes, and recursively of the attributes of its class's base + classes. + + The resulting list is sorted alphabetically. For example: + + >>> import struct + >>> dir() # show the names in the module namespace # doctest: +SKIP + ['__builtins__', '__name__', 'struct'] + >>> dir(struct) # show the names in the struct module # doctest: +SKIP + ['Struct', '__all__', '__builtins__', '__cached__', '__doc__', '__file__', + '__initializing__', '__loader__', '__name__', '__package__', + '_clearcache', 'calcsize', 'error', 'pack', 'pack_into', + 'unpack', 'unpack_from'] + >>> class Shape: + ... def __dir__(self): + ... return ['area', 'perimeter', 'location'] + >>> s = Shape() + >>> dir(s) + ['area', 'location', 'perimeter'] + + .. note:: + + Because :func:`dir` is supplied primarily as a convenience for use at an + interactive prompt, it tries to supply an interesting set of names more + than it tries to supply a rigorously or consistently defined set of names, + and its detailed behavior may change across releases. For example, + metaclass attributes are not in the result list when the argument is a + class. + + +.. function:: divmod(a, b) + + Take two (non complex) numbers as arguments and return a pair of numbers + consisting of their quotient and remainder when using integer division. With + mixed operand types, the rules for binary arithmetic operators apply. For + integers, the result is the same as ``(a // b, a % b)``. For floating point + numbers the result is ``(q, a % b)``, where *q* is usually ``math.floor(a / + b)`` but may be 1 less than that. In any case ``q * b + a % b`` is very + close to *a*, if ``a % b`` is non-zero it has the same sign as *b*, and ``0 + <= abs(a % b) < abs(b)``. + + +.. function:: enumerate(iterable, start=0) + + Return an enumerate object. *iterable* must be a sequence, an + :term:`iterator`, or some other object which supports iteration. + The :meth:`~iterator.__next__` method of the iterator returned by + :func:`enumerate` returns a tuple containing a count (from *start* which + defaults to 0) and the values obtained from iterating over *iterable*. + + >>> seasons = ['Spring', 'Summer', 'Fall', 'Winter'] + >>> list(enumerate(seasons)) + [(0, 'Spring'), (1, 'Summer'), (2, 'Fall'), (3, 'Winter')] + >>> list(enumerate(seasons, start=1)) + [(1, 'Spring'), (2, 'Summer'), (3, 'Fall'), (4, 'Winter')] + + Equivalent to:: + + def enumerate(sequence, start=0): + n = start + for elem in sequence: + yield n, elem + n += 1 + + +.. function:: eval(expression, globals=None, locals=None) + + The arguments are a string and optional globals and locals. If provided, + *globals* must be a dictionary. If provided, *locals* can be any mapping + object. + + The *expression* argument is parsed and evaluated as a Python expression + (technically speaking, a condition list) using the *globals* and *locals* + dictionaries as global and local namespace. If the *globals* dictionary is + present and does not contain a value for the key ``__builtins__``, a + reference to the dictionary of the built-in module :mod:`builtins` is + inserted under that key before *expression* is parsed. + This means that *expression* normally has full + access to the standard :mod:`builtins` module and restricted environments are + propagated. If the *locals* dictionary is omitted it defaults to the *globals* + dictionary. If both dictionaries are omitted, the expression is executed in the + environment where :func:`eval` is called. The return value is the result of + the evaluated expression. Syntax errors are reported as exceptions. Example: + + >>> x = 1 + >>> eval('x+1') + 2 + + This function can also be used to execute arbitrary code objects (such as + those created by :func:`compile`). In this case pass a code object instead + of a string. If the code object has been compiled with ``'exec'`` as the + *mode* argument, :func:`eval`\'s return value will be ``None``. + + Hints: dynamic execution of statements is supported by the :func:`exec` + function. The :func:`globals` and :func:`locals` functions + returns the current global and local dictionary, respectively, which may be + useful to pass around for use by :func:`eval` or :func:`exec`. + + See :func:`ast.literal_eval` for a function that can safely evaluate strings + with expressions containing only literals. + +.. index:: builtin: exec + +.. function:: exec(object[, globals[, locals]]) + + This function supports dynamic execution of Python code. *object* must be + either a string or a code object. If it is a string, the string is parsed as + a suite of Python statements which is then executed (unless a syntax error + occurs). [#]_ If it is a code object, it is simply executed. In all cases, + the code that's executed is expected to be valid as file input (see the + section "File input" in the Reference Manual). Be aware that the + :keyword:`return` and :keyword:`yield` statements may not be used outside of + function definitions even within the context of code passed to the + :func:`exec` function. The return value is ``None``. + + In all cases, if the optional parts are omitted, the code is executed in the + current scope. If only *globals* is provided, it must be a dictionary, which + will be used for both the global and the local variables. If *globals* and + *locals* are given, they are used for the global and local variables, + respectively. If provided, *locals* can be any mapping object. Remember + that at module level, globals and locals are the same dictionary. If exec + gets two separate objects as *globals* and *locals*, the code will be + executed as if it were embedded in a class definition. + + If the *globals* dictionary does not contain a value for the key + ``__builtins__``, a reference to the dictionary of the built-in module + :mod:`builtins` is inserted under that key. That way you can control what + builtins are available to the executed code by inserting your own + ``__builtins__`` dictionary into *globals* before passing it to :func:`exec`. + + .. note:: + + The built-in functions :func:`globals` and :func:`locals` return the current + global and local dictionary, respectively, which may be useful to pass around + for use as the second and third argument to :func:`exec`. + + .. note:: + + The default *locals* act as described for function :func:`locals` below: + modifications to the default *locals* dictionary should not be attempted. + Pass an explicit *locals* dictionary if you need to see effects of the + code on *locals* after function :func:`exec` returns. + + +.. function:: filter(function, iterable) + + Construct an iterator from those elements of *iterable* for which *function* + returns true. *iterable* may be either a sequence, a container which + supports iteration, or an iterator. If *function* is ``None``, the identity + function is assumed, that is, all elements of *iterable* that are false are + removed. + + Note that ``filter(function, iterable)`` is equivalent to the generator + expression ``(item for item in iterable if function(item))`` if function is + not ``None`` and ``(item for item in iterable if item)`` if function is + ``None``. + + See :func:`itertools.filterfalse` for the complementary function that returns + elements of *iterable* for which *function* returns false. + + +.. class:: float([x]) + + .. index:: + single: NaN + single: Infinity + + Return a floating point number constructed from a number or string *x*. + + If the argument is a string, it should contain a decimal number, optionally + preceded by a sign, and optionally embedded in whitespace. The optional + sign may be ``'+'`` or ``'-'``; a ``'+'`` sign has no effect on the value + produced. The argument may also be a string representing a NaN + (not-a-number), or a positive or negative infinity. More precisely, the + input must conform to the following grammar after leading and trailing + whitespace characters are removed: + + .. productionlist:: + sign: "+" | "-" + infinity: "Infinity" | "inf" + nan: "nan" + numeric_value: `floatnumber` | `infinity` | `nan` + numeric_string: [`sign`] `numeric_value` + + Here ``floatnumber`` is the form of a Python floating-point literal, + described in :ref:`floating`. Case is not significant, so, for example, + "inf", "Inf", "INFINITY" and "iNfINity" are all acceptable spellings for + positive infinity. + + Otherwise, if the argument is an integer or a floating point number, a + floating point number with the same value (within Python's floating point + precision) is returned. If the argument is outside the range of a Python + float, an :exc:`OverflowError` will be raised. + + For a general Python object ``x``, ``float(x)`` delegates to + ``x.__float__()``. + + If no argument is given, ``0.0`` is returned. + + Examples:: + + >>> float('+1.23') + 1.23 + >>> float(' -12345\n') + -12345.0 + >>> float('1e-003') + 0.001 + >>> float('+1E6') + 1000000.0 + >>> float('-Infinity') + -inf + + The float type is described in :ref:`typesnumeric`. + + .. versionchanged:: 3.6 + Grouping digits with underscores as in code literals is allowed. + + .. versionchanged:: 3.7 + *x* is now a positional-only parameter. + + +.. index:: + single: __format__ + single: string; format() (built-in function) + +.. function:: format(value[, format_spec]) + + Convert a *value* to a "formatted" representation, as controlled by + *format_spec*. The interpretation of *format_spec* will depend on the type + of the *value* argument, however there is a standard formatting syntax that + is used by most built-in types: :ref:`formatspec`. + + The default *format_spec* is an empty string which usually gives the same + effect as calling :func:`str(value) `. + + A call to ``format(value, format_spec)`` is translated to + ``type(value).__format__(value, format_spec)`` which bypasses the instance + dictionary when searching for the value's :meth:`__format__` method. A + :exc:`TypeError` exception is raised if the method search reaches + :mod:`object` and the *format_spec* is non-empty, or if either the + *format_spec* or the return value are not strings. + + .. versionchanged:: 3.4 + ``object().__format__(format_spec)`` raises :exc:`TypeError` + if *format_spec* is not an empty string. + + +.. _func-frozenset: +.. class:: frozenset([iterable]) + :noindex: + + Return a new :class:`frozenset` object, optionally with elements taken from + *iterable*. ``frozenset`` is a built-in class. See :class:`frozenset` and + :ref:`types-set` for documentation about this class. + + For other containers see the built-in :class:`set`, :class:`list`, + :class:`tuple`, and :class:`dict` classes, as well as the :mod:`collections` + module. + + +.. function:: getattr(object, name[, default]) + + Return the value of the named attribute of *object*. *name* must be a string. + If the string is the name of one of the object's attributes, the result is the + value of that attribute. For example, ``getattr(x, 'foobar')`` is equivalent to + ``x.foobar``. If the named attribute does not exist, *default* is returned if + provided, otherwise :exc:`AttributeError` is raised. + + +.. function:: globals() + + Return a dictionary representing the current global symbol table. This is always + the dictionary of the current module (inside a function or method, this is the + module where it is defined, not the module from which it is called). + + +.. function:: hasattr(object, name) + + The arguments are an object and a string. The result is ``True`` if the + string is the name of one of the object's attributes, ``False`` if not. (This + is implemented by calling ``getattr(object, name)`` and seeing whether it + raises an :exc:`AttributeError` or not.) + + +.. function:: hash(object) + + Return the hash value of the object (if it has one). Hash values are + integers. They are used to quickly compare dictionary keys during a + dictionary lookup. Numeric values that compare equal have the same hash + value (even if they are of different types, as is the case for 1 and 1.0). + + .. note:: + + For objects with custom :meth:`__hash__` methods, note that :func:`hash` + truncates the return value based on the bit width of the host machine. + See :meth:`__hash__` for details. + +.. function:: help([object]) + + Invoke the built-in help system. (This function is intended for interactive + use.) If no argument is given, the interactive help system starts on the + interpreter console. If the argument is a string, then the string is looked up + as the name of a module, function, class, method, keyword, or documentation + topic, and a help page is printed on the console. If the argument is any other + kind of object, a help page on the object is generated. + + Note that if a slash(/) appears in the parameter list of a function, when + invoking :func:`help`, it means that the parameters prior to the slash are + positional-only. For more info, see + :ref:`the FAQ entry on positional-only parameters `. + + This function is added to the built-in namespace by the :mod:`site` module. + + .. versionchanged:: 3.4 + Changes to :mod:`pydoc` and :mod:`inspect` mean that the reported + signatures for callables are now more comprehensive and consistent. + + +.. function:: hex(x) + + Convert an integer number to a lowercase hexadecimal string prefixed with + "0x". If *x* is not a Python :class:`int` object, it has to define an + :meth:`__index__` method that returns an integer. Some examples: + + >>> hex(255) + '0xff' + >>> hex(-42) + '-0x2a' + + If you want to convert an integer number to an uppercase or lower hexadecimal + string with prefix or not, you can use either of the following ways: + + >>> '%#x' % 255, '%x' % 255, '%X' % 255 + ('0xff', 'ff', 'FF') + >>> format(255, '#x'), format(255, 'x'), format(255, 'X') + ('0xff', 'ff', 'FF') + >>> f'{255:#x}', f'{255:x}', f'{255:X}' + ('0xff', 'ff', 'FF') + + See also :func:`format` for more information. + + See also :func:`int` for converting a hexadecimal string to an + integer using a base of 16. + + .. note:: + + To obtain a hexadecimal string representation for a float, use the + :meth:`float.hex` method. + + +.. function:: id(object) + + Return the "identity" of an object. This is an integer which + is guaranteed to be unique and constant for this object during its lifetime. + Two objects with non-overlapping lifetimes may have the same :func:`id` + value. + + .. impl-detail:: This is the address of the object in memory. + + +.. function:: input([prompt]) + + If the *prompt* argument is present, it is written to standard output without + a trailing newline. The function then reads a line from input, converts it + to a string (stripping a trailing newline), and returns that. When EOF is + read, :exc:`EOFError` is raised. Example:: + + >>> s = input('--> ') # doctest: +SKIP + --> Monty Python's Flying Circus + >>> s # doctest: +SKIP + "Monty Python's Flying Circus" + + If the :mod:`readline` module was loaded, then :func:`input` will use it + to provide elaborate line editing and history features. + + +.. class:: int([x]) + int(x, base=10) + + Return an integer object constructed from a number or string *x*, or return + ``0`` if no arguments are given. If *x* defines :meth:`__int__`, + ``int(x)`` returns ``x.__int__()``. If *x* defines :meth:`__trunc__`, + it returns ``x.__trunc__()``. + For floating point numbers, this truncates towards zero. + + If *x* is not a number or if *base* is given, then *x* must be a string, + :class:`bytes`, or :class:`bytearray` instance representing an :ref:`integer + literal ` in radix *base*. Optionally, the literal can be + preceded by ``+`` or ``-`` (with no space in between) and surrounded by + whitespace. A base-n literal consists of the digits 0 to n-1, with ``a`` + to ``z`` (or ``A`` to ``Z``) having + values 10 to 35. The default *base* is 10. The allowed values are 0 and 2--36. + Base-2, -8, and -16 literals can be optionally prefixed with ``0b``/``0B``, + ``0o``/``0O``, or ``0x``/``0X``, as with integer literals in code. Base 0 + means to interpret exactly as a code literal, so that the actual base is 2, + 8, 10, or 16, and so that ``int('010', 0)`` is not legal, while + ``int('010')`` is, as well as ``int('010', 8)``. + + The integer type is described in :ref:`typesnumeric`. + + .. versionchanged:: 3.4 + If *base* is not an instance of :class:`int` and the *base* object has a + :meth:`base.__index__ ` method, that method is called + to obtain an integer for the base. Previous versions used + :meth:`base.__int__ ` instead of :meth:`base.__index__ + `. + + .. versionchanged:: 3.6 + Grouping digits with underscores as in code literals is allowed. + + .. versionchanged:: 3.7 + *x* is now a positional-only parameter. + + +.. function:: isinstance(object, classinfo) + + Return true if the *object* argument is an instance of the *classinfo* + argument, or of a (direct, indirect or :term:`virtual `) subclass thereof. If *object* is not + an object of the given type, the function always returns false. + If *classinfo* is a tuple of type objects (or recursively, other such + tuples), return true if *object* is an instance of any of the types. + If *classinfo* is not a type or tuple of types and such tuples, + a :exc:`TypeError` exception is raised. + + +.. function:: issubclass(class, classinfo) + + Return true if *class* is a subclass (direct, indirect or :term:`virtual + `) of *classinfo*. A + class is considered a subclass of itself. *classinfo* may be a tuple of class + objects, in which case every entry in *classinfo* will be checked. In any other + case, a :exc:`TypeError` exception is raised. + + +.. function:: iter(object[, sentinel]) + + Return an :term:`iterator` object. The first argument is interpreted very + differently depending on the presence of the second argument. Without a + second argument, *object* must be a collection object which supports the + iteration protocol (the :meth:`__iter__` method), or it must support the + sequence protocol (the :meth:`__getitem__` method with integer arguments + starting at ``0``). If it does not support either of those protocols, + :exc:`TypeError` is raised. If the second argument, *sentinel*, is given, + then *object* must be a callable object. The iterator created in this case + will call *object* with no arguments for each call to its + :meth:`~iterator.__next__` method; if the value returned is equal to + *sentinel*, :exc:`StopIteration` will be raised, otherwise the value will + be returned. + + See also :ref:`typeiter`. + + One useful application of the second form of :func:`iter` is to build a + block-reader. For example, reading fixed-width blocks from a binary + database file until the end of file is reached:: + + from functools import partial + with open('mydata.db', 'rb') as f: + for block in iter(partial(f.read, 64), b''): + process_block(block) + + +.. function:: len(s) + + Return the length (the number of items) of an object. The argument may be a + sequence (such as a string, bytes, tuple, list, or range) or a collection + (such as a dictionary, set, or frozen set). + + +.. _func-list: +.. class:: list([iterable]) + :noindex: + + Rather than being a function, :class:`list` is actually a mutable + sequence type, as documented in :ref:`typesseq-list` and :ref:`typesseq`. + + +.. function:: locals() + + Update and return a dictionary representing the current local symbol table. + Free variables are returned by :func:`locals` when it is called in function + blocks, but not in class blocks. Note that at the module level, :func:`locals` + and :func:`globals` are the same dictionary. + + .. note:: + The contents of this dictionary should not be modified; changes may not + affect the values of local and free variables used by the interpreter. + +.. function:: map(function, iterable, ...) + + Return an iterator that applies *function* to every item of *iterable*, + yielding the results. If additional *iterable* arguments are passed, + *function* must take that many arguments and is applied to the items from all + iterables in parallel. With multiple iterables, the iterator stops when the + shortest iterable is exhausted. For cases where the function inputs are + already arranged into argument tuples, see :func:`itertools.starmap`\. + + +.. function:: max(iterable, *[, key, default]) + max(arg1, arg2, *args[, key]) + + Return the largest item in an iterable or the largest of two or more + arguments. + + If one positional argument is provided, it should be an :term:`iterable`. + The largest item in the iterable is returned. If two or more positional + arguments are provided, the largest of the positional arguments is + returned. + + There are two optional keyword-only arguments. The *key* argument specifies + a one-argument ordering function like that used for :meth:`list.sort`. The + *default* argument specifies an object to return if the provided iterable is + empty. If the iterable is empty and *default* is not provided, a + :exc:`ValueError` is raised. + + If multiple items are maximal, the function returns the first one + encountered. This is consistent with other sort-stability preserving tools + such as ``sorted(iterable, key=keyfunc, reverse=True)[0]`` and + ``heapq.nlargest(1, iterable, key=keyfunc)``. + + .. versionadded:: 3.4 + The *default* keyword-only argument. + + +.. _func-memoryview: +.. function:: memoryview(obj) + :noindex: + + Return a "memory view" object created from the given argument. See + :ref:`typememoryview` for more information. + + +.. function:: min(iterable, *[, key, default]) + min(arg1, arg2, *args[, key]) + + Return the smallest item in an iterable or the smallest of two or more + arguments. + + If one positional argument is provided, it should be an :term:`iterable`. + The smallest item in the iterable is returned. If two or more positional + arguments are provided, the smallest of the positional arguments is + returned. + + There are two optional keyword-only arguments. The *key* argument specifies + a one-argument ordering function like that used for :meth:`list.sort`. The + *default* argument specifies an object to return if the provided iterable is + empty. If the iterable is empty and *default* is not provided, a + :exc:`ValueError` is raised. + + If multiple items are minimal, the function returns the first one + encountered. This is consistent with other sort-stability preserving tools + such as ``sorted(iterable, key=keyfunc)[0]`` and ``heapq.nsmallest(1, + iterable, key=keyfunc)``. + + .. versionadded:: 3.4 + The *default* keyword-only argument. + + +.. function:: next(iterator[, default]) + + Retrieve the next item from the *iterator* by calling its + :meth:`~iterator.__next__` method. If *default* is given, it is returned + if the iterator is exhausted, otherwise :exc:`StopIteration` is raised. + + +.. class:: object() + + Return a new featureless object. :class:`object` is a base for all classes. + It has the methods that are common to all instances of Python classes. This + function does not accept any arguments. + + .. note:: + + :class:`object` does *not* have a :attr:`~object.__dict__`, so you can't + assign arbitrary attributes to an instance of the :class:`object` class. + + +.. function:: oct(x) + + Convert an integer number to an octal string prefixed with "0o". The result + is a valid Python expression. If *x* is not a Python :class:`int` object, it + has to define an :meth:`__index__` method that returns an integer. For + example: + + >>> oct(8) + '0o10' + >>> oct(-56) + '-0o70' + + If you want to convert an integer number to octal string either with prefix + "0o" or not, you can use either of the following ways. + + >>> '%#o' % 10, '%o' % 10 + ('0o12', '12') + >>> format(10, '#o'), format(10, 'o') + ('0o12', '12') + >>> f'{10:#o}', f'{10:o}' + ('0o12', '12') + + See also :func:`format` for more information. + + .. index:: + single: file object; open() built-in function + +.. function:: open(file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) + + Open *file* and return a corresponding :term:`file object`. If the file + cannot be opened, an :exc:`OSError` is raised. + + *file* is a :term:`path-like object` giving the pathname (absolute or + relative to the current working directory) of the file to be opened or an + integer file descriptor of the file to be wrapped. (If a file descriptor is + given, it is closed when the returned I/O object is closed, unless *closefd* + is set to ``False``.) + + *mode* is an optional string that specifies the mode in which the file is + opened. It defaults to ``'r'`` which means open for reading in text mode. + Other common values are ``'w'`` for writing (truncating the file if it + already exists), ``'x'`` for exclusive creation and ``'a'`` for appending + (which on *some* Unix systems, means that *all* writes append to the end of + the file regardless of the current seek position). In text mode, if + *encoding* is not specified the encoding used is platform dependent: + ``locale.getpreferredencoding(False)`` is called to get the current locale + encoding. (For reading and writing raw bytes use binary mode and leave + *encoding* unspecified.) The available modes are: + + .. _filemodes: + + .. index:: + pair: file; modes + + ========= =============================================================== + Character Meaning + ========= =============================================================== + ``'r'`` open for reading (default) + ``'w'`` open for writing, truncating the file first + ``'x'`` open for exclusive creation, failing if the file already exists + ``'a'`` open for writing, appending to the end of the file if it exists + ``'b'`` binary mode + ``'t'`` text mode (default) + ``'+'`` open a disk file for updating (reading and writing) + ========= =============================================================== + + The default mode is ``'r'`` (open for reading text, synonym of ``'rt'``). + For binary read-write access, the mode ``'w+b'`` opens and truncates the file + to 0 bytes. ``'r+b'`` opens the file without truncation. + + As mentioned in the :ref:`io-overview`, Python distinguishes between binary + and text I/O. Files opened in binary mode (including ``'b'`` in the *mode* + argument) return contents as :class:`bytes` objects without any decoding. In + text mode (the default, or when ``'t'`` is included in the *mode* argument), + the contents of the file are returned as :class:`str`, the bytes having been + first decoded using a platform-dependent encoding or using the specified + *encoding* if given. + + There is an additional mode character permitted, ``'U'``, which no longer + has any effect, and is considered deprecated. It previously enabled + :term:`universal newlines` in text mode, which became the default behaviour + in Python 3.0. Refer to the documentation of the + :ref:`newline ` parameter for further details. + + .. note:: + + Python doesn't depend on the underlying operating system's notion of text + files; all the processing is done by Python itself, and is therefore + platform-independent. + + *buffering* is an optional integer used to set the buffering policy. Pass 0 + to switch buffering off (only allowed in binary mode), 1 to select line + buffering (only usable in text mode), and an integer > 1 to indicate the size + in bytes of a fixed-size chunk buffer. When no *buffering* argument is + given, the default buffering policy works as follows: + + * Binary files are buffered in fixed-size chunks; the size of the buffer is + chosen using a heuristic trying to determine the underlying device's "block + size" and falling back on :attr:`io.DEFAULT_BUFFER_SIZE`. On many systems, + the buffer will typically be 4096 or 8192 bytes long. + + * "Interactive" text files (files for which :meth:`~io.IOBase.isatty` + returns ``True``) use line buffering. Other text files use the policy + described above for binary files. + + *encoding* is the name of the encoding used to decode or encode the file. + This should only be used in text mode. The default encoding is platform + dependent (whatever :func:`locale.getpreferredencoding` returns), but any + :term:`text encoding` supported by Python + can be used. See the :mod:`codecs` module for + the list of supported encodings. + + *errors* is an optional string that specifies how encoding and decoding + errors are to be handled—this cannot be used in binary mode. + A variety of standard error handlers are available + (listed under :ref:`error-handlers`), though any + error handling name that has been registered with + :func:`codecs.register_error` is also valid. The standard names + include: + + * ``'strict'`` to raise a :exc:`ValueError` exception if there is + an encoding error. The default value of ``None`` has the same + effect. + + * ``'ignore'`` ignores errors. Note that ignoring encoding errors + can lead to data loss. + + * ``'replace'`` causes a replacement marker (such as ``'?'``) to be inserted + where there is malformed data. + + * ``'surrogateescape'`` will represent any incorrect bytes as code + points in the Unicode Private Use Area ranging from U+DC80 to + U+DCFF. These private code points will then be turned back into + the same bytes when the ``surrogateescape`` error handler is used + when writing data. This is useful for processing files in an + unknown encoding. + + * ``'xmlcharrefreplace'`` is only supported when writing to a file. + Characters not supported by the encoding are replaced with the + appropriate XML character reference ``&#nnn;``. + + * ``'backslashreplace'`` replaces malformed data by Python's backslashed + escape sequences. + + * ``'namereplace'`` (also only supported when writing) + replaces unsupported characters with ``\N{...}`` escape sequences. + + .. index:: + single: universal newlines; open() built-in function + + .. _open-newline-parameter: + + *newline* controls how :term:`universal newlines` mode works (it only + applies to text mode). It can be ``None``, ``''``, ``'\n'``, ``'\r'``, and + ``'\r\n'``. It works as follows: + + * When reading input from the stream, if *newline* is ``None``, universal + newlines mode is enabled. Lines in the input can end in ``'\n'``, + ``'\r'``, or ``'\r\n'``, and these are translated into ``'\n'`` before + being returned to the caller. If it is ``''``, universal newlines mode is + enabled, but line endings are returned to the caller untranslated. If it + has any of the other legal values, input lines are only terminated by the + given string, and the line ending is returned to the caller untranslated. + + * When writing output to the stream, if *newline* is ``None``, any ``'\n'`` + characters written are translated to the system default line separator, + :data:`os.linesep`. If *newline* is ``''`` or ``'\n'``, no translation + takes place. If *newline* is any of the other legal values, any ``'\n'`` + characters written are translated to the given string. + + If *closefd* is ``False`` and a file descriptor rather than a filename was + given, the underlying file descriptor will be kept open when the file is + closed. If a filename is given *closefd* must be ``True`` (the default) + otherwise an error will be raised. + + A custom opener can be used by passing a callable as *opener*. The underlying + file descriptor for the file object is then obtained by calling *opener* with + (*file*, *flags*). *opener* must return an open file descriptor (passing + :mod:`os.open` as *opener* results in functionality similar to passing + ``None``). + + The newly created file is :ref:`non-inheritable `. + + The following example uses the :ref:`dir_fd ` parameter of the + :func:`os.open` function to open a file relative to a given directory:: + + >>> import os + >>> dir_fd = os.open('somedir', os.O_RDONLY) + >>> def opener(path, flags): + ... return os.open(path, flags, dir_fd=dir_fd) + ... + >>> with open('spamspam.txt', 'w', opener=opener) as f: + ... print('This will be written to somedir/spamspam.txt', file=f) + ... + >>> os.close(dir_fd) # don't leak a file descriptor + + The type of :term:`file object` returned by the :func:`open` function + depends on the mode. When :func:`open` is used to open a file in a text + mode (``'w'``, ``'r'``, ``'wt'``, ``'rt'``, etc.), it returns a subclass of + :class:`io.TextIOBase` (specifically :class:`io.TextIOWrapper`). When used + to open a file in a binary mode with buffering, the returned class is a + subclass of :class:`io.BufferedIOBase`. The exact class varies: in read + binary mode, it returns an :class:`io.BufferedReader`; in write binary and + append binary modes, it returns an :class:`io.BufferedWriter`, and in + read/write mode, it returns an :class:`io.BufferedRandom`. When buffering is + disabled, the raw stream, a subclass of :class:`io.RawIOBase`, + :class:`io.FileIO`, is returned. + + .. index:: + single: line-buffered I/O + single: unbuffered I/O + single: buffer size, I/O + single: I/O control; buffering + single: binary mode + single: text mode + module: sys + + See also the file handling modules, such as, :mod:`fileinput`, :mod:`io` + (where :func:`open` is declared), :mod:`os`, :mod:`os.path`, :mod:`tempfile`, + and :mod:`shutil`. + + .. versionchanged:: + 3.3 + + * The *opener* parameter was added. + * The ``'x'`` mode was added. + * :exc:`IOError` used to be raised, it is now an alias of :exc:`OSError`. + * :exc:`FileExistsError` is now raised if the file opened in exclusive + creation mode (``'x'``) already exists. + + .. versionchanged:: + 3.4 + + * The file is now non-inheritable. + + .. deprecated-removed:: 3.4 4.0 + + The ``'U'`` mode. + + .. versionchanged:: + 3.5 + + * If the system call is interrupted and the signal handler does not raise an + exception, the function now retries the system call instead of raising an + :exc:`InterruptedError` exception (see :pep:`475` for the rationale). + * The ``'namereplace'`` error handler was added. + + .. versionchanged:: + 3.6 + + * Support added to accept objects implementing :class:`os.PathLike`. + * On Windows, opening a console buffer may return a subclass of + :class:`io.RawIOBase` other than :class:`io.FileIO`. + +.. function:: ord(c) + + Given a string representing one Unicode character, return an integer + representing the Unicode code point of that character. For example, + ``ord('a')`` returns the integer ``97`` and ``ord('€')`` (Euro sign) + returns ``8364``. This is the inverse of :func:`chr`. + + +.. function:: pow(x, y[, z]) + + Return *x* to the power *y*; if *z* is present, return *x* to the power *y*, + modulo *z* (computed more efficiently than ``pow(x, y) % z``). The two-argument + form ``pow(x, y)`` is equivalent to using the power operator: ``x**y``. + + The arguments must have numeric types. With mixed operand types, the + coercion rules for binary arithmetic operators apply. For :class:`int` + operands, the result has the same type as the operands (after coercion) + unless the second argument is negative; in that case, all arguments are + converted to float and a float result is delivered. For example, ``10**2`` + returns ``100``, but ``10**-2`` returns ``0.01``. If the second argument is + negative, the third argument must be omitted. If *z* is present, *x* and *y* + must be of integer types, and *y* must be non-negative. + + +.. function:: print(*objects, sep=' ', end='\\n', file=sys.stdout, flush=False) + + Print *objects* to the text stream *file*, separated by *sep* and followed + by *end*. *sep*, *end*, *file* and *flush*, if present, must be given as keyword + arguments. + + All non-keyword arguments are converted to strings like :func:`str` does and + written to the stream, separated by *sep* and followed by *end*. Both *sep* + and *end* must be strings; they can also be ``None``, which means to use the + default values. If no *objects* are given, :func:`print` will just write + *end*. + + The *file* argument must be an object with a ``write(string)`` method; if it + is not present or ``None``, :data:`sys.stdout` will be used. Since printed + arguments are converted to text strings, :func:`print` cannot be used with + binary mode file objects. For these, use ``file.write(...)`` instead. + + Whether output is buffered is usually determined by *file*, but if the + *flush* keyword argument is true, the stream is forcibly flushed. + + .. versionchanged:: 3.3 + Added the *flush* keyword argument. + + +.. class:: property(fget=None, fset=None, fdel=None, doc=None) + + Return a property attribute. + + *fget* is a function for getting an attribute value. *fset* is a function + for setting an attribute value. *fdel* is a function for deleting an attribute + value. And *doc* creates a docstring for the attribute. + + A typical use is to define a managed attribute ``x``:: + + class C: + def __init__(self): + self._x = None + + def getx(self): + return self._x + + def setx(self, value): + self._x = value + + def delx(self): + del self._x + + x = property(getx, setx, delx, "I'm the 'x' property.") + + If *c* is an instance of *C*, ``c.x`` will invoke the getter, + ``c.x = value`` will invoke the setter and ``del c.x`` the deleter. + + If given, *doc* will be the docstring of the property attribute. Otherwise, the + property will copy *fget*'s docstring (if it exists). This makes it possible to + create read-only properties easily using :func:`property` as a :term:`decorator`:: + + class Parrot: + def __init__(self): + self._voltage = 100000 + + @property + def voltage(self): + """Get the current voltage.""" + return self._voltage + + The ``@property`` decorator turns the :meth:`voltage` method into a "getter" + for a read-only attribute with the same name, and it sets the docstring for + *voltage* to "Get the current voltage." + + A property object has :attr:`~property.getter`, :attr:`~property.setter`, + and :attr:`~property.deleter` methods usable as decorators that create a + copy of the property with the corresponding accessor function set to the + decorated function. This is best explained with an example:: + + class C: + def __init__(self): + self._x = None + + @property + def x(self): + """I'm the 'x' property.""" + return self._x + + @x.setter + def x(self, value): + self._x = value + + @x.deleter + def x(self): + del self._x + + This code is exactly equivalent to the first example. Be sure to give the + additional functions the same name as the original property (``x`` in this + case.) + + The returned property object also has the attributes ``fget``, ``fset``, and + ``fdel`` corresponding to the constructor arguments. + + .. versionchanged:: 3.5 + The docstrings of property objects are now writeable. + + +.. _func-range: +.. function:: range(stop) + range(start, stop[, step]) + :noindex: + + Rather than being a function, :class:`range` is actually an immutable + sequence type, as documented in :ref:`typesseq-range` and :ref:`typesseq`. + + +.. function:: repr(object) + + Return a string containing a printable representation of an object. For many + types, this function makes an attempt to return a string that would yield an + object with the same value when passed to :func:`eval`, otherwise the + representation is a string enclosed in angle brackets that contains the name + of the type of the object together with additional information often + including the name and address of the object. A class can control what this + function returns for its instances by defining a :meth:`__repr__` method. + + +.. function:: reversed(seq) + + Return a reverse :term:`iterator`. *seq* must be an object which has + a :meth:`__reversed__` method or supports the sequence protocol (the + :meth:`__len__` method and the :meth:`__getitem__` method with integer + arguments starting at ``0``). + + +.. function:: round(number[, ndigits]) + + Return *number* rounded to *ndigits* precision after the decimal + point. If *ndigits* is omitted or is ``None``, it returns the + nearest integer to its input. + + For the built-in types supporting :func:`round`, values are rounded to the + closest multiple of 10 to the power minus *ndigits*; if two multiples are + equally close, rounding is done toward the even choice (so, for example, + both ``round(0.5)`` and ``round(-0.5)`` are ``0``, and ``round(1.5)`` is + ``2``). Any integer value is valid for *ndigits* (positive, zero, or + negative). The return value is an integer if *ndigits* is omitted or + ``None``. + Otherwise the return value has the same type as *number*. + + For a general Python object ``number``, ``round`` delegates to + ``number.__round__``. + + .. note:: + + The behavior of :func:`round` for floats can be surprising: for example, + ``round(2.675, 2)`` gives ``2.67`` instead of the expected ``2.68``. + This is not a bug: it's a result of the fact that most decimal fractions + can't be represented exactly as a float. See :ref:`tut-fp-issues` for + more information. + + +.. _func-set: +.. class:: set([iterable]) + :noindex: + + Return a new :class:`set` object, optionally with elements taken from + *iterable*. ``set`` is a built-in class. See :class:`set` and + :ref:`types-set` for documentation about this class. + + For other containers see the built-in :class:`frozenset`, :class:`list`, + :class:`tuple`, and :class:`dict` classes, as well as the :mod:`collections` + module. + + +.. function:: setattr(object, name, value) + + This is the counterpart of :func:`getattr`. The arguments are an object, a + string and an arbitrary value. The string may name an existing attribute or a + new attribute. The function assigns the value to the attribute, provided the + object allows it. For example, ``setattr(x, 'foobar', 123)`` is equivalent to + ``x.foobar = 123``. + + +.. class:: slice(stop) + slice(start, stop[, step]) + + .. index:: single: Numerical Python + + Return a :term:`slice` object representing the set of indices specified by + ``range(start, stop, step)``. The *start* and *step* arguments default to + ``None``. Slice objects have read-only data attributes :attr:`~slice.start`, + :attr:`~slice.stop` and :attr:`~slice.step` which merely return the argument + values (or their default). They have no other explicit functionality; + however they are used by Numerical Python and other third party extensions. + Slice objects are also generated when extended indexing syntax is used. For + example: ``a[start:stop:step]`` or ``a[start:stop, i]``. See + :func:`itertools.islice` for an alternate version that returns an iterator. + + +.. function:: sorted(iterable, *, key=None, reverse=False) + + Return a new sorted list from the items in *iterable*. + + Has two optional arguments which must be specified as keyword arguments. + + *key* specifies a function of one argument that is used to extract a comparison + key from each element in *iterable* (for example, ``key=str.lower``). The + default value is ``None`` (compare the elements directly). + + *reverse* is a boolean value. If set to ``True``, then the list elements are + sorted as if each comparison were reversed. + + Use :func:`functools.cmp_to_key` to convert an old-style *cmp* function to a + *key* function. + + The built-in :func:`sorted` function is guaranteed to be stable. A sort is + stable if it guarantees not to change the relative order of elements that + compare equal --- this is helpful for sorting in multiple passes (for + example, sort by department, then by salary grade). + + For sorting examples and a brief sorting tutorial, see :ref:`sortinghowto`. + +.. decorator:: staticmethod + + Transform a method into a static method. + + A static method does not receive an implicit first argument. To declare a static + method, use this idiom:: + + class C: + @staticmethod + def f(arg1, arg2, ...): ... + + The ``@staticmethod`` form is a function :term:`decorator` -- see + :ref:`function` for details. + + A static method can be called either on the class (such as ``C.f()``) or on an instance (such + as ``C().f()``). + + Static methods in Python are similar to those found in Java or C++. Also see + :func:`classmethod` for a variant that is useful for creating alternate class + constructors. + + Like all decorators, it is also possible to call ``staticmethod`` as + a regular function and do something with its result. This is needed + in some cases where you need a reference to a function from a class + body and you want to avoid the automatic transformation to instance + method. For these cases, use this idiom:: + + class C: + builtin_open = staticmethod(open) + + For more information on static methods, see :ref:`types`. + + +.. index:: + single: string; str() (built-in function) + +.. _func-str: +.. class:: str(object='') + str(object=b'', encoding='utf-8', errors='strict') + :noindex: + + Return a :class:`str` version of *object*. See :func:`str` for details. + + ``str`` is the built-in string :term:`class`. For general information + about strings, see :ref:`textseq`. + + +.. function:: sum(iterable[, start]) + + Sums *start* and the items of an *iterable* from left to right and returns the + total. *start* defaults to ``0``. The *iterable*'s items are normally numbers, + and the start value is not allowed to be a string. + + For some use cases, there are good alternatives to :func:`sum`. + The preferred, fast way to concatenate a sequence of strings is by calling + ``''.join(sequence)``. To add floating point values with extended precision, + see :func:`math.fsum`\. To concatenate a series of iterables, consider using + :func:`itertools.chain`. + +.. function:: super([type[, object-or-type]]) + + Return a proxy object that delegates method calls to a parent or sibling + class of *type*. This is useful for accessing inherited methods that have + been overridden in a class. The search order is same as that used by + :func:`getattr` except that the *type* itself is skipped. + + The :attr:`~class.__mro__` attribute of the *type* lists the method + resolution search order used by both :func:`getattr` and :func:`super`. The + attribute is dynamic and can change whenever the inheritance hierarchy is + updated. + + If the second argument is omitted, the super object returned is unbound. If + the second argument is an object, ``isinstance(obj, type)`` must be true. If + the second argument is a type, ``issubclass(type2, type)`` must be true (this + is useful for classmethods). + + There are two typical use cases for *super*. In a class hierarchy with + single inheritance, *super* can be used to refer to parent classes without + naming them explicitly, thus making the code more maintainable. This use + closely parallels the use of *super* in other programming languages. + + The second use case is to support cooperative multiple inheritance in a + dynamic execution environment. This use case is unique to Python and is + not found in statically compiled languages or languages that only support + single inheritance. This makes it possible to implement "diamond diagrams" + where multiple base classes implement the same method. Good design dictates + that this method have the same calling signature in every case (because the + order of calls is determined at runtime, because that order adapts + to changes in the class hierarchy, and because that order can include + sibling classes that are unknown prior to runtime). + + For both use cases, a typical superclass call looks like this:: + + class C(B): + def method(self, arg): + super().method(arg) # This does the same thing as: + # super(C, self).method(arg) + + Note that :func:`super` is implemented as part of the binding process for + explicit dotted attribute lookups such as ``super().__getitem__(name)``. + It does so by implementing its own :meth:`__getattribute__` method for searching + classes in a predictable order that supports cooperative multiple inheritance. + Accordingly, :func:`super` is undefined for implicit lookups using statements or + operators such as ``super()[name]``. + + Also note that, aside from the zero argument form, :func:`super` is not + limited to use inside methods. The two argument form specifies the + arguments exactly and makes the appropriate references. The zero + argument form only works inside a class definition, as the compiler fills + in the necessary details to correctly retrieve the class being defined, + as well as accessing the current instance for ordinary methods. + + For practical suggestions on how to design cooperative classes using + :func:`super`, see `guide to using super() + `_. + + +.. _func-tuple: +.. function:: tuple([iterable]) + :noindex: + + Rather than being a function, :class:`tuple` is actually an immutable + sequence type, as documented in :ref:`typesseq-tuple` and :ref:`typesseq`. + + +.. class:: type(object) + type(name, bases, dict) + + .. index:: object: type + + With one argument, return the type of an *object*. The return value is a + type object and generally the same object as returned by + :attr:`object.__class__ `. + + The :func:`isinstance` built-in function is recommended for testing the type + of an object, because it takes subclasses into account. + + + With three arguments, return a new type object. This is essentially a + dynamic form of the :keyword:`class` statement. The *name* string is the + class name and becomes the :attr:`~definition.__name__` attribute; the *bases* + tuple itemizes the base classes and becomes the :attr:`~class.__bases__` + attribute; and the *dict* dictionary is the namespace containing definitions + for class body and is copied to a standard dictionary to become the + :attr:`~object.__dict__` attribute. For example, the following two + statements create identical :class:`type` objects: + + >>> class X: + ... a = 1 + ... + >>> X = type('X', (object,), dict(a=1)) + + See also :ref:`bltin-type-objects`. + + .. versionchanged:: 3.6 + Subclasses of :class:`type` which don't override ``type.__new__`` may no + longer use the one-argument form to get the type of an object. + +.. function:: vars([object]) + + Return the :attr:`~object.__dict__` attribute for a module, class, instance, + or any other object with a :attr:`~object.__dict__` attribute. + + Objects such as modules and instances have an updateable :attr:`~object.__dict__` + attribute; however, other objects may have write restrictions on their + :attr:`~object.__dict__` attributes (for example, classes use a + :class:`types.MappingProxyType` to prevent direct dictionary updates). + + Without an argument, :func:`vars` acts like :func:`locals`. Note, the + locals dictionary is only useful for reads since updates to the locals + dictionary are ignored. + + +.. function:: zip(*iterables) + + Make an iterator that aggregates elements from each of the iterables. + + Returns an iterator of tuples, where the *i*-th tuple contains + the *i*-th element from each of the argument sequences or iterables. The + iterator stops when the shortest input iterable is exhausted. With a single + iterable argument, it returns an iterator of 1-tuples. With no arguments, + it returns an empty iterator. Equivalent to:: + + def zip(*iterables): + # zip('ABCD', 'xy') --> Ax By + sentinel = object() + iterators = [iter(it) for it in iterables] + while iterators: + result = [] + for it in iterators: + elem = next(it, sentinel) + if elem is sentinel: + return + result.append(elem) + yield tuple(result) + + The left-to-right evaluation order of the iterables is guaranteed. This + makes possible an idiom for clustering a data series into n-length groups + using ``zip(*[iter(s)]*n)``. This repeats the *same* iterator ``n`` times + so that each output tuple has the result of ``n`` calls to the iterator. + This has the effect of dividing the input into n-length chunks. + + :func:`zip` should only be used with unequal length inputs when you don't + care about trailing, unmatched values from the longer iterables. If those + values are important, use :func:`itertools.zip_longest` instead. + + :func:`zip` in conjunction with the ``*`` operator can be used to unzip a + list:: + + >>> x = [1, 2, 3] + >>> y = [4, 5, 6] + >>> zipped = zip(x, y) + >>> list(zipped) + [(1, 4), (2, 5), (3, 6)] + >>> x2, y2 = zip(*zip(x, y)) + >>> x == list(x2) and y == list(y2) + True + + +.. function:: __import__(name, globals=None, locals=None, fromlist=(), level=0) + + .. index:: + statement: import + module: imp + + .. note:: + + This is an advanced function that is not needed in everyday Python + programming, unlike :func:`importlib.import_module`. + + This function is invoked by the :keyword:`import` statement. It can be + replaced (by importing the :mod:`builtins` module and assigning to + ``builtins.__import__``) in order to change semantics of the + :keyword:`!import` statement, but doing so is **strongly** discouraged as it + is usually simpler to use import hooks (see :pep:`302`) to attain the same + goals and does not cause issues with code which assumes the default import + implementation is in use. Direct use of :func:`__import__` is also + discouraged in favor of :func:`importlib.import_module`. + + The function imports the module *name*, potentially using the given *globals* + and *locals* to determine how to interpret the name in a package context. + The *fromlist* gives the names of objects or submodules that should be + imported from the module given by *name*. The standard implementation does + not use its *locals* argument at all, and uses its *globals* only to + determine the package context of the :keyword:`import` statement. + + *level* specifies whether to use absolute or relative imports. ``0`` (the + default) means only perform absolute imports. Positive values for + *level* indicate the number of parent directories to search relative to the + directory of the module calling :func:`__import__` (see :pep:`328` for the + details). + + When the *name* variable is of the form ``package.module``, normally, the + top-level package (the name up till the first dot) is returned, *not* the + module named by *name*. However, when a non-empty *fromlist* argument is + given, the module named by *name* is returned. + + For example, the statement ``import spam`` results in bytecode resembling the + following code:: + + spam = __import__('spam', globals(), locals(), [], 0) + + The statement ``import spam.ham`` results in this call:: + + spam = __import__('spam.ham', globals(), locals(), [], 0) + + Note how :func:`__import__` returns the toplevel module here because this is + the object that is bound to a name by the :keyword:`import` statement. + + On the other hand, the statement ``from spam.ham import eggs, sausage as + saus`` results in :: + + _temp = __import__('spam.ham', globals(), locals(), ['eggs', 'sausage'], 0) + eggs = _temp.eggs + saus = _temp.sausage + + Here, the ``spam.ham`` module is returned from :func:`__import__`. From this + object, the names to import are retrieved and assigned to their respective + names. + + If you simply want to import a module (potentially within a package) by name, + use :func:`importlib.import_module`. + + .. versionchanged:: 3.3 + Negative values for *level* are no longer supported (which also changes + the default value to 0). + + +.. rubric:: Footnotes + +.. [#] Note that the parser only accepts the Unix-style end of line convention. + If you are reading the code from a file, make sure to use newline conversion + mode to convert Windows or Mac-style newlines. diff --git a/python-3.7.4-docs-html/_sources/library/functools.rst.txt b/python-3.7.4-docs-html/_sources/library/functools.rst.txt new file mode 100644 index 0000000..d19373b --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/functools.rst.txt @@ -0,0 +1,505 @@ +:mod:`functools` --- Higher-order functions and operations on callable objects +============================================================================== + +.. module:: functools + :synopsis: Higher-order functions and operations on callable objects. + +.. moduleauthor:: Peter Harris +.. moduleauthor:: Raymond Hettinger +.. moduleauthor:: Nick Coghlan +.. moduleauthor:: Łukasz Langa +.. sectionauthor:: Peter Harris + +**Source code:** :source:`Lib/functools.py` + +-------------- + +The :mod:`functools` module is for higher-order functions: functions that act on +or return other functions. In general, any callable object can be treated as a +function for the purposes of this module. + +The :mod:`functools` module defines the following functions: + +.. function:: cmp_to_key(func) + + Transform an old-style comparison function to a :term:`key function`. Used + with tools that accept key functions (such as :func:`sorted`, :func:`min`, + :func:`max`, :func:`heapq.nlargest`, :func:`heapq.nsmallest`, + :func:`itertools.groupby`). This function is primarily used as a transition + tool for programs being converted from Python 2 which supported the use of + comparison functions. + + A comparison function is any callable that accept two arguments, compares them, + and returns a negative number for less-than, zero for equality, or a positive + number for greater-than. A key function is a callable that accepts one + argument and returns another value to be used as the sort key. + + Example:: + + sorted(iterable, key=cmp_to_key(locale.strcoll)) # locale-aware sort order + + For sorting examples and a brief sorting tutorial, see :ref:`sortinghowto`. + + .. versionadded:: 3.2 + + +.. decorator:: lru_cache(maxsize=128, typed=False) + + Decorator to wrap a function with a memoizing callable that saves up to the + *maxsize* most recent calls. It can save time when an expensive or I/O bound + function is periodically called with the same arguments. + + Since a dictionary is used to cache results, the positional and keyword + arguments to the function must be hashable. + + Distinct argument patterns may be considered to be distinct calls with + separate cache entries. For example, `f(a=1, b=2)` and `f(b=2, a=1)` + differ in their keyword argument order and may have two separate cache + entries. + + If *maxsize* is set to ``None``, the LRU feature is disabled and the cache can + grow without bound. The LRU feature performs best when *maxsize* is a + power-of-two. + + If *typed* is set to true, function arguments of different types will be + cached separately. For example, ``f(3)`` and ``f(3.0)`` will be treated + as distinct calls with distinct results. + + To help measure the effectiveness of the cache and tune the *maxsize* + parameter, the wrapped function is instrumented with a :func:`cache_info` + function that returns a :term:`named tuple` showing *hits*, *misses*, + *maxsize* and *currsize*. In a multi-threaded environment, the hits + and misses are approximate. + + The decorator also provides a :func:`cache_clear` function for clearing or + invalidating the cache. + + The original underlying function is accessible through the + :attr:`__wrapped__` attribute. This is useful for introspection, for + bypassing the cache, or for rewrapping the function with a different cache. + + An `LRU (least recently used) cache + `_ works + best when the most recent calls are the best predictors of upcoming calls (for + example, the most popular articles on a news server tend to change each day). + The cache's size limit assures that the cache does not grow without bound on + long-running processes such as web servers. + + In general, the LRU cache should only be used when you want to reuse + previously computed values. Accordingly, it doesn't make sense to cache + functions with side-effects, functions that need to create distinct mutable + objects on each call, or impure functions such as time() or random(). + + Example of an LRU cache for static web content:: + + @lru_cache(maxsize=32) + def get_pep(num): + 'Retrieve text of a Python Enhancement Proposal' + resource = 'http://www.python.org/dev/peps/pep-%04d/' % num + try: + with urllib.request.urlopen(resource) as s: + return s.read() + except urllib.error.HTTPError: + return 'Not Found' + + >>> for n in 8, 290, 308, 320, 8, 218, 320, 279, 289, 320, 9991: + ... pep = get_pep(n) + ... print(n, len(pep)) + + >>> get_pep.cache_info() + CacheInfo(hits=3, misses=8, maxsize=32, currsize=8) + + Example of efficiently computing + `Fibonacci numbers `_ + using a cache to implement a + `dynamic programming `_ + technique:: + + @lru_cache(maxsize=None) + def fib(n): + if n < 2: + return n + return fib(n-1) + fib(n-2) + + >>> [fib(n) for n in range(16)] + [0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377, 610] + + >>> fib.cache_info() + CacheInfo(hits=28, misses=16, maxsize=None, currsize=16) + + .. versionadded:: 3.2 + + .. versionchanged:: 3.3 + Added the *typed* option. + +.. decorator:: total_ordering + + Given a class defining one or more rich comparison ordering methods, this + class decorator supplies the rest. This simplifies the effort involved + in specifying all of the possible rich comparison operations: + + The class must define one of :meth:`__lt__`, :meth:`__le__`, + :meth:`__gt__`, or :meth:`__ge__`. + In addition, the class should supply an :meth:`__eq__` method. + + For example:: + + @total_ordering + class Student: + def _is_valid_operand(self, other): + return (hasattr(other, "lastname") and + hasattr(other, "firstname")) + def __eq__(self, other): + if not self._is_valid_operand(other): + return NotImplemented + return ((self.lastname.lower(), self.firstname.lower()) == + (other.lastname.lower(), other.firstname.lower())) + def __lt__(self, other): + if not self._is_valid_operand(other): + return NotImplemented + return ((self.lastname.lower(), self.firstname.lower()) < + (other.lastname.lower(), other.firstname.lower())) + + .. note:: + + While this decorator makes it easy to create well behaved totally + ordered types, it *does* come at the cost of slower execution and + more complex stack traces for the derived comparison methods. If + performance benchmarking indicates this is a bottleneck for a given + application, implementing all six rich comparison methods instead is + likely to provide an easy speed boost. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.4 + Returning NotImplemented from the underlying comparison function for + unrecognised types is now supported. + +.. function:: partial(func, *args, **keywords) + + Return a new :ref:`partial object` which when called + will behave like *func* called with the positional arguments *args* + and keyword arguments *keywords*. If more arguments are supplied to the + call, they are appended to *args*. If additional keyword arguments are + supplied, they extend and override *keywords*. + Roughly equivalent to:: + + def partial(func, *args, **keywords): + def newfunc(*fargs, **fkeywords): + newkeywords = keywords.copy() + newkeywords.update(fkeywords) + return func(*args, *fargs, **newkeywords) + newfunc.func = func + newfunc.args = args + newfunc.keywords = keywords + return newfunc + + The :func:`partial` is used for partial function application which "freezes" + some portion of a function's arguments and/or keywords resulting in a new object + with a simplified signature. For example, :func:`partial` can be used to create + a callable that behaves like the :func:`int` function where the *base* argument + defaults to two: + + >>> from functools import partial + >>> basetwo = partial(int, base=2) + >>> basetwo.__doc__ = 'Convert base 2 string to an int.' + >>> basetwo('10010') + 18 + + +.. class:: partialmethod(func, *args, **keywords) + + Return a new :class:`partialmethod` descriptor which behaves + like :class:`partial` except that it is designed to be used as a method + definition rather than being directly callable. + + *func* must be a :term:`descriptor` or a callable (objects which are both, + like normal functions, are handled as descriptors). + + When *func* is a descriptor (such as a normal Python function, + :func:`classmethod`, :func:`staticmethod`, :func:`abstractmethod` or + another instance of :class:`partialmethod`), calls to ``__get__`` are + delegated to the underlying descriptor, and an appropriate + :ref:`partial object` returned as the result. + + When *func* is a non-descriptor callable, an appropriate bound method is + created dynamically. This behaves like a normal Python function when + used as a method: the *self* argument will be inserted as the first + positional argument, even before the *args* and *keywords* supplied to + the :class:`partialmethod` constructor. + + Example:: + + >>> class Cell(object): + ... def __init__(self): + ... self._alive = False + ... @property + ... def alive(self): + ... return self._alive + ... def set_state(self, state): + ... self._alive = bool(state) + ... set_alive = partialmethod(set_state, True) + ... set_dead = partialmethod(set_state, False) + ... + >>> c = Cell() + >>> c.alive + False + >>> c.set_alive() + >>> c.alive + True + + .. versionadded:: 3.4 + + +.. function:: reduce(function, iterable[, initializer]) + + Apply *function* of two arguments cumulatively to the items of *sequence*, from + left to right, so as to reduce the sequence to a single value. For example, + ``reduce(lambda x, y: x+y, [1, 2, 3, 4, 5])`` calculates ``((((1+2)+3)+4)+5)``. + The left argument, *x*, is the accumulated value and the right argument, *y*, is + the update value from the *sequence*. If the optional *initializer* is present, + it is placed before the items of the sequence in the calculation, and serves as + a default when the sequence is empty. If *initializer* is not given and + *sequence* contains only one item, the first item is returned. + + Roughly equivalent to:: + + def reduce(function, iterable, initializer=None): + it = iter(iterable) + if initializer is None: + value = next(it) + else: + value = initializer + for element in it: + value = function(value, element) + return value + + +.. decorator:: singledispatch + + Transform a function into a :term:`single-dispatch ` :term:`generic function`. + + To define a generic function, decorate it with the ``@singledispatch`` + decorator. Note that the dispatch happens on the type of the first argument, + create your function accordingly:: + + >>> from functools import singledispatch + >>> @singledispatch + ... def fun(arg, verbose=False): + ... if verbose: + ... print("Let me just say,", end=" ") + ... print(arg) + + To add overloaded implementations to the function, use the :func:`register` + attribute of the generic function. It is a decorator. For functions + annotated with types, the decorator will infer the type of the first + argument automatically:: + + >>> @fun.register + ... def _(arg: int, verbose=False): + ... if verbose: + ... print("Strength in numbers, eh?", end=" ") + ... print(arg) + ... + >>> @fun.register + ... def _(arg: list, verbose=False): + ... if verbose: + ... print("Enumerate this:") + ... for i, elem in enumerate(arg): + ... print(i, elem) + + For code which doesn't use type annotations, the appropriate type + argument can be passed explicitly to the decorator itself:: + + >>> @fun.register(complex) + ... def _(arg, verbose=False): + ... if verbose: + ... print("Better than complicated.", end=" ") + ... print(arg.real, arg.imag) + ... + + + To enable registering lambdas and pre-existing functions, the + :func:`register` attribute can be used in a functional form:: + + >>> def nothing(arg, verbose=False): + ... print("Nothing.") + ... + >>> fun.register(type(None), nothing) + + The :func:`register` attribute returns the undecorated function which + enables decorator stacking, pickling, as well as creating unit tests for + each variant independently:: + + >>> @fun.register(float) + ... @fun.register(Decimal) + ... def fun_num(arg, verbose=False): + ... if verbose: + ... print("Half of your number:", end=" ") + ... print(arg / 2) + ... + >>> fun_num is fun + False + + When called, the generic function dispatches on the type of the first + argument:: + + >>> fun("Hello, world.") + Hello, world. + >>> fun("test.", verbose=True) + Let me just say, test. + >>> fun(42, verbose=True) + Strength in numbers, eh? 42 + >>> fun(['spam', 'spam', 'eggs', 'spam'], verbose=True) + Enumerate this: + 0 spam + 1 spam + 2 eggs + 3 spam + >>> fun(None) + Nothing. + >>> fun(1.23) + 0.615 + + Where there is no registered implementation for a specific type, its + method resolution order is used to find a more generic implementation. + The original function decorated with ``@singledispatch`` is registered + for the base ``object`` type, which means it is used if no better + implementation is found. + + To check which implementation will the generic function choose for + a given type, use the ``dispatch()`` attribute:: + + >>> fun.dispatch(float) + + >>> fun.dispatch(dict) # note: default implementation + + + To access all registered implementations, use the read-only ``registry`` + attribute:: + + >>> fun.registry.keys() + dict_keys([, , , + , , + ]) + >>> fun.registry[float] + + >>> fun.registry[object] + + + .. versionadded:: 3.4 + + .. versionchanged:: 3.7 + The :func:`register` attribute supports using type annotations. + + +.. function:: update_wrapper(wrapper, wrapped, assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES) + + Update a *wrapper* function to look like the *wrapped* function. The optional + arguments are tuples to specify which attributes of the original function are + assigned directly to the matching attributes on the wrapper function and which + attributes of the wrapper function are updated with the corresponding attributes + from the original function. The default values for these arguments are the + module level constants ``WRAPPER_ASSIGNMENTS`` (which assigns to the wrapper + function's ``__module__``, ``__name__``, ``__qualname__``, ``__annotations__`` + and ``__doc__``, the documentation string) and ``WRAPPER_UPDATES`` (which + updates the wrapper function's ``__dict__``, i.e. the instance dictionary). + + To allow access to the original function for introspection and other purposes + (e.g. bypassing a caching decorator such as :func:`lru_cache`), this function + automatically adds a ``__wrapped__`` attribute to the wrapper that refers to + the function being wrapped. + + The main intended use for this function is in :term:`decorator` functions which + wrap the decorated function and return the wrapper. If the wrapper function is + not updated, the metadata of the returned function will reflect the wrapper + definition rather than the original function definition, which is typically less + than helpful. + + :func:`update_wrapper` may be used with callables other than functions. Any + attributes named in *assigned* or *updated* that are missing from the object + being wrapped are ignored (i.e. this function will not attempt to set them + on the wrapper function). :exc:`AttributeError` is still raised if the + wrapper function itself is missing any attributes named in *updated*. + + .. versionadded:: 3.2 + Automatic addition of the ``__wrapped__`` attribute. + + .. versionadded:: 3.2 + Copying of the ``__annotations__`` attribute by default. + + .. versionchanged:: 3.2 + Missing attributes no longer trigger an :exc:`AttributeError`. + + .. versionchanged:: 3.4 + The ``__wrapped__`` attribute now always refers to the wrapped + function, even if that function defined a ``__wrapped__`` attribute. + (see :issue:`17482`) + + +.. decorator:: wraps(wrapped, assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES) + + This is a convenience function for invoking :func:`update_wrapper` as a + function decorator when defining a wrapper function. It is equivalent to + ``partial(update_wrapper, wrapped=wrapped, assigned=assigned, updated=updated)``. + For example:: + + >>> from functools import wraps + >>> def my_decorator(f): + ... @wraps(f) + ... def wrapper(*args, **kwds): + ... print('Calling decorated function') + ... return f(*args, **kwds) + ... return wrapper + ... + >>> @my_decorator + ... def example(): + ... """Docstring""" + ... print('Called example function') + ... + >>> example() + Calling decorated function + Called example function + >>> example.__name__ + 'example' + >>> example.__doc__ + 'Docstring' + + Without the use of this decorator factory, the name of the example function + would have been ``'wrapper'``, and the docstring of the original :func:`example` + would have been lost. + + +.. _partial-objects: + +:class:`partial` Objects +------------------------ + +:class:`partial` objects are callable objects created by :func:`partial`. They +have three read-only attributes: + + +.. attribute:: partial.func + + A callable object or function. Calls to the :class:`partial` object will be + forwarded to :attr:`func` with new arguments and keywords. + + +.. attribute:: partial.args + + The leftmost positional arguments that will be prepended to the positional + arguments provided to a :class:`partial` object call. + + +.. attribute:: partial.keywords + + The keyword arguments that will be supplied when the :class:`partial` object is + called. + +:class:`partial` objects are like :class:`function` objects in that they are +callable, weak referencable, and can have attributes. There are some important +differences. For instance, the :attr:`~definition.__name__` and :attr:`__doc__` attributes +are not created automatically. Also, :class:`partial` objects defined in +classes behave like static methods and do not transform into bound methods +during instance attribute look-up. diff --git a/python-3.7.4-docs-html/_sources/library/gc.rst.txt b/python-3.7.4-docs-html/_sources/library/gc.rst.txt new file mode 100644 index 0000000..153d8fb --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/gc.rst.txt @@ -0,0 +1,297 @@ +:mod:`gc` --- Garbage Collector interface +========================================= + +.. module:: gc + :synopsis: Interface to the cycle-detecting garbage collector. + +.. moduleauthor:: Neil Schemenauer +.. sectionauthor:: Neil Schemenauer + +-------------- + +This module provides an interface to the optional garbage collector. It +provides the ability to disable the collector, tune the collection frequency, +and set debugging options. It also provides access to unreachable objects that +the collector found but cannot free. Since the collector supplements the +reference counting already used in Python, you can disable the collector if you +are sure your program does not create reference cycles. Automatic collection +can be disabled by calling ``gc.disable()``. To debug a leaking program call +``gc.set_debug(gc.DEBUG_LEAK)``. Notice that this includes +``gc.DEBUG_SAVEALL``, causing garbage-collected objects to be saved in +gc.garbage for inspection. + +The :mod:`gc` module provides the following functions: + + +.. function:: enable() + + Enable automatic garbage collection. + + +.. function:: disable() + + Disable automatic garbage collection. + + +.. function:: isenabled() + + Returns true if automatic collection is enabled. + + +.. function:: collect(generation=2) + + With no arguments, run a full collection. The optional argument *generation* + may be an integer specifying which generation to collect (from 0 to 2). A + :exc:`ValueError` is raised if the generation number is invalid. The number of + unreachable objects found is returned. + + The free lists maintained for a number of built-in types are cleared + whenever a full collection or collection of the highest generation (2) + is run. Not all items in some free lists may be freed due to the + particular implementation, in particular :class:`float`. + + +.. function:: set_debug(flags) + + Set the garbage collection debugging flags. Debugging information will be + written to ``sys.stderr``. See below for a list of debugging flags which can be + combined using bit operations to control debugging. + + +.. function:: get_debug() + + Return the debugging flags currently set. + + +.. function:: get_objects() + + Returns a list of all objects tracked by the collector, excluding the list + returned. + + +.. function:: get_stats() + + Return a list of three per-generation dictionaries containing collection + statistics since interpreter start. The number of keys may change + in the future, but currently each dictionary will contain the following + items: + + * ``collections`` is the number of times this generation was collected; + + * ``collected`` is the total number of objects collected inside this + generation; + + * ``uncollectable`` is the total number of objects which were found + to be uncollectable (and were therefore moved to the :data:`garbage` + list) inside this generation. + + .. versionadded:: 3.4 + + +.. function:: set_threshold(threshold0[, threshold1[, threshold2]]) + + Set the garbage collection thresholds (the collection frequency). Setting + *threshold0* to zero disables collection. + + The GC classifies objects into three generations depending on how many + collection sweeps they have survived. New objects are placed in the youngest + generation (generation ``0``). If an object survives a collection it is moved + into the next older generation. Since generation ``2`` is the oldest + generation, objects in that generation remain there after a collection. In + order to decide when to run, the collector keeps track of the number object + allocations and deallocations since the last collection. When the number of + allocations minus the number of deallocations exceeds *threshold0*, collection + starts. Initially only generation ``0`` is examined. If generation ``0`` has + been examined more than *threshold1* times since generation ``1`` has been + examined, then generation ``1`` is examined as well. Similarly, *threshold2* + controls the number of collections of generation ``1`` before collecting + generation ``2``. + + +.. function:: get_count() + + Return the current collection counts as a tuple of ``(count0, count1, + count2)``. + + +.. function:: get_threshold() + + Return the current collection thresholds as a tuple of ``(threshold0, + threshold1, threshold2)``. + + +.. function:: get_referrers(*objs) + + Return the list of objects that directly refer to any of objs. This function + will only locate those containers which support garbage collection; extension + types which do refer to other objects but do not support garbage collection will + not be found. + + Note that objects which have already been dereferenced, but which live in cycles + and have not yet been collected by the garbage collector can be listed among the + resulting referrers. To get only currently live objects, call :func:`collect` + before calling :func:`get_referrers`. + + Care must be taken when using objects returned by :func:`get_referrers` because + some of them could still be under construction and hence in a temporarily + invalid state. Avoid using :func:`get_referrers` for any purpose other than + debugging. + + +.. function:: get_referents(*objs) + + Return a list of objects directly referred to by any of the arguments. The + referents returned are those objects visited by the arguments' C-level + :c:member:`~PyTypeObject.tp_traverse` methods (if any), and may not be all objects actually + directly reachable. :c:member:`~PyTypeObject.tp_traverse` methods are supported only by objects + that support garbage collection, and are only required to visit objects that may + be involved in a cycle. So, for example, if an integer is directly reachable + from an argument, that integer object may or may not appear in the result list. + + +.. function:: is_tracked(obj) + + Returns ``True`` if the object is currently tracked by the garbage collector, + ``False`` otherwise. As a general rule, instances of atomic types aren't + tracked and instances of non-atomic types (containers, user-defined + objects...) are. However, some type-specific optimizations can be present + in order to suppress the garbage collector footprint of simple instances + (e.g. dicts containing only atomic keys and values):: + + >>> gc.is_tracked(0) + False + >>> gc.is_tracked("a") + False + >>> gc.is_tracked([]) + True + >>> gc.is_tracked({}) + False + >>> gc.is_tracked({"a": 1}) + False + >>> gc.is_tracked({"a": []}) + True + + .. versionadded:: 3.1 + + +.. function:: freeze() + + Freeze all the objects tracked by gc - move them to a permanent generation + and ignore all the future collections. This can be used before a POSIX + fork() call to make the gc copy-on-write friendly or to speed up collection. + Also collection before a POSIX fork() call may free pages for future + allocation which can cause copy-on-write too so it's advised to disable gc + in master process and freeze before fork and enable gc in child process. + + .. versionadded:: 3.7 + + +.. function:: unfreeze() + + Unfreeze the objects in the permanent generation, put them back into the + oldest generation. + + .. versionadded:: 3.7 + + +.. function:: get_freeze_count() + + Return the number of objects in the permanent generation. + + .. versionadded:: 3.7 + + +The following variables are provided for read-only access (you can mutate the +values but should not rebind them): + +.. data:: garbage + + A list of objects which the collector found to be unreachable but could + not be freed (uncollectable objects). Starting with Python 3.4, this + list should be empty most of the time, except when using instances of + C extension types with a non-NULL ``tp_del`` slot. + + If :const:`DEBUG_SAVEALL` is set, then all unreachable objects will be + added to this list rather than freed. + + .. versionchanged:: 3.2 + If this list is non-empty at :term:`interpreter shutdown`, a + :exc:`ResourceWarning` is emitted, which is silent by default. If + :const:`DEBUG_UNCOLLECTABLE` is set, in addition all uncollectable objects + are printed. + + .. versionchanged:: 3.4 + Following :pep:`442`, objects with a :meth:`__del__` method don't end + up in :attr:`gc.garbage` anymore. + +.. data:: callbacks + + A list of callbacks that will be invoked by the garbage collector before and + after collection. The callbacks will be called with two arguments, + *phase* and *info*. + + *phase* can be one of two values: + + "start": The garbage collection is about to start. + + "stop": The garbage collection has finished. + + *info* is a dict providing more information for the callback. The following + keys are currently defined: + + "generation": The oldest generation being collected. + + "collected": When *phase* is "stop", the number of objects + successfully collected. + + "uncollectable": When *phase* is "stop", the number of objects + that could not be collected and were put in :data:`garbage`. + + Applications can add their own callbacks to this list. The primary + use cases are: + + Gathering statistics about garbage collection, such as how often + various generations are collected, and how long the collection + takes. + + Allowing applications to identify and clear their own uncollectable + types when they appear in :data:`garbage`. + + .. versionadded:: 3.3 + + +The following constants are provided for use with :func:`set_debug`: + + +.. data:: DEBUG_STATS + + Print statistics during collection. This information can be useful when tuning + the collection frequency. + + +.. data:: DEBUG_COLLECTABLE + + Print information on collectable objects found. + + +.. data:: DEBUG_UNCOLLECTABLE + + Print information of uncollectable objects found (objects which are not + reachable but cannot be freed by the collector). These objects will be added + to the ``garbage`` list. + + .. versionchanged:: 3.2 + Also print the contents of the :data:`garbage` list at + :term:`interpreter shutdown`, if it isn't empty. + +.. data:: DEBUG_SAVEALL + + When set, all unreachable objects found will be appended to *garbage* rather + than being freed. This can be useful for debugging a leaking program. + + +.. data:: DEBUG_LEAK + + The debugging flags necessary for the collector to print information about a + leaking program (equal to ``DEBUG_COLLECTABLE | DEBUG_UNCOLLECTABLE | + DEBUG_SAVEALL``). diff --git a/python-3.7.4-docs-html/_sources/library/getopt.rst.txt b/python-3.7.4-docs-html/_sources/library/getopt.rst.txt new file mode 100644 index 0000000..336deab --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/getopt.rst.txt @@ -0,0 +1,164 @@ +:mod:`getopt` --- C-style parser for command line options +========================================================= + +.. module:: getopt + :synopsis: Portable parser for command line options; support both short and + long option names. + +**Source code:** :source:`Lib/getopt.py` + +.. note:: + + The :mod:`getopt` module is a parser for command line options whose API is + designed to be familiar to users of the C :c:func:`getopt` function. Users who + are unfamiliar with the C :c:func:`getopt` function or who would like to write + less code and get better help and error messages should consider using the + :mod:`argparse` module instead. + +-------------- + +This module helps scripts to parse the command line arguments in ``sys.argv``. +It supports the same conventions as the Unix :c:func:`getopt` function (including +the special meanings of arguments of the form '``-``' and '``--``'). Long +options similar to those supported by GNU software may be used as well via an +optional third argument. + +This module provides two functions and an +exception: + + +.. function:: getopt(args, shortopts, longopts=[]) + + Parses command line options and parameter list. *args* is the argument list to + be parsed, without the leading reference to the running program. Typically, this + means ``sys.argv[1:]``. *shortopts* is the string of option letters that the + script wants to recognize, with options that require an argument followed by a + colon (``':'``; i.e., the same format that Unix :c:func:`getopt` uses). + + .. note:: + + Unlike GNU :c:func:`getopt`, after a non-option argument, all further + arguments are considered also non-options. This is similar to the way + non-GNU Unix systems work. + + *longopts*, if specified, must be a list of strings with the names of the + long options which should be supported. The leading ``'--'`` characters + should not be included in the option name. Long options which require an + argument should be followed by an equal sign (``'='``). Optional arguments + are not supported. To accept only long options, *shortopts* should be an + empty string. Long options on the command line can be recognized so long as + they provide a prefix of the option name that matches exactly one of the + accepted options. For example, if *longopts* is ``['foo', 'frob']``, the + option ``--fo`` will match as ``--foo``, but ``--f`` will + not match uniquely, so :exc:`GetoptError` will be raised. + + The return value consists of two elements: the first is a list of ``(option, + value)`` pairs; the second is the list of program arguments left after the + option list was stripped (this is a trailing slice of *args*). Each + option-and-value pair returned has the option as its first element, prefixed + with a hyphen for short options (e.g., ``'-x'``) or two hyphens for long + options (e.g., ``'--long-option'``), and the option argument as its + second element, or an empty string if the option has no argument. The + options occur in the list in the same order in which they were found, thus + allowing multiple occurrences. Long and short options may be mixed. + + +.. function:: gnu_getopt(args, shortopts, longopts=[]) + + This function works like :func:`getopt`, except that GNU style scanning mode is + used by default. This means that option and non-option arguments may be + intermixed. The :func:`getopt` function stops processing options as soon as a + non-option argument is encountered. + + If the first character of the option string is ``'+'``, or if the environment + variable :envvar:`POSIXLY_CORRECT` is set, then option processing stops as + soon as a non-option argument is encountered. + + +.. exception:: GetoptError + + This is raised when an unrecognized option is found in the argument list or when + an option requiring an argument is given none. The argument to the exception is + a string indicating the cause of the error. For long options, an argument given + to an option which does not require one will also cause this exception to be + raised. The attributes :attr:`msg` and :attr:`opt` give the error message and + related option; if there is no specific option to which the exception relates, + :attr:`opt` is an empty string. + +.. XXX deprecated? +.. exception:: error + + Alias for :exc:`GetoptError`; for backward compatibility. + +An example using only Unix style options: + + >>> import getopt + >>> args = '-a -b -cfoo -d bar a1 a2'.split() + >>> args + ['-a', '-b', '-cfoo', '-d', 'bar', 'a1', 'a2'] + >>> optlist, args = getopt.getopt(args, 'abc:d:') + >>> optlist + [('-a', ''), ('-b', ''), ('-c', 'foo'), ('-d', 'bar')] + >>> args + ['a1', 'a2'] + +Using long option names is equally easy: + + >>> s = '--condition=foo --testing --output-file abc.def -x a1 a2' + >>> args = s.split() + >>> args + ['--condition=foo', '--testing', '--output-file', 'abc.def', '-x', 'a1', 'a2'] + >>> optlist, args = getopt.getopt(args, 'x', [ + ... 'condition=', 'output-file=', 'testing']) + >>> optlist + [('--condition', 'foo'), ('--testing', ''), ('--output-file', 'abc.def'), ('-x', '')] + >>> args + ['a1', 'a2'] + +In a script, typical usage is something like this:: + + import getopt, sys + + def main(): + try: + 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" + usage() + sys.exit(2) + output = None + verbose = False + for o, a in opts: + if o == "-v": + verbose = True + elif o in ("-h", "--help"): + usage() + sys.exit() + elif o in ("-o", "--output"): + output = a + else: + assert False, "unhandled option" + # ... + + if __name__ == "__main__": + main() + +Note that an equivalent command line interface could be produced with less code +and more informative help and error messages by using the :mod:`argparse` module:: + + import argparse + + if __name__ == '__main__': + parser = argparse.ArgumentParser() + parser.add_argument('-o', '--output') + parser.add_argument('-v', dest='verbose', action='store_true') + args = parser.parse_args() + # ... do something with args.output ... + # ... do something with args.verbose .. + +.. seealso:: + + Module :mod:`argparse` + Alternative command line option and argument parsing library. + diff --git a/python-3.7.4-docs-html/_sources/library/getpass.rst.txt b/python-3.7.4-docs-html/_sources/library/getpass.rst.txt new file mode 100644 index 0000000..82b1191 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/getpass.rst.txt @@ -0,0 +1,51 @@ +:mod:`getpass` --- Portable password input +========================================== + +.. module:: getpass + :synopsis: Portable reading of passwords and retrieval of the userid. + +.. moduleauthor:: Piers Lauder +.. sectionauthor:: Fred L. Drake, Jr. +.. Windows (& Mac?) support by Guido van Rossum. + +**Source code:** :source:`Lib/getpass.py` + +-------------- + +The :mod:`getpass` module provides two functions: + + +.. function:: getpass(prompt='Password: ', stream=None) + + Prompt the user for a password without echoing. The user is prompted using + the string *prompt*, which defaults to ``'Password: '``. On Unix, the + prompt is written to the file-like object *stream* using the replace error + handler if needed. *stream* defaults to the controlling terminal + (:file:`/dev/tty`) or if that is unavailable to ``sys.stderr`` (this + argument is ignored on Windows). + + If echo free input is unavailable getpass() falls back to printing + a warning message to *stream* and reading from ``sys.stdin`` and + issuing a :exc:`GetPassWarning`. + + .. note:: + If you call getpass from within IDLE, the input may be done in the + terminal you launched IDLE from rather than the idle window itself. + +.. exception:: GetPassWarning + + A :exc:`UserWarning` subclass issued when password input may be echoed. + + +.. function:: getuser() + + Return the "login name" of the user. + + This function checks the environment variables :envvar:`LOGNAME`, + :envvar:`USER`, :envvar:`LNAME` and :envvar:`USERNAME`, in order, and + returns the value of the first one which is set to a non-empty string. If + none are set, the login name from the password database is returned on + systems which support the :mod:`pwd` module, otherwise, an exception is + raised. + + In general, this function should be preferred over :func:`os.getlogin()`. diff --git a/python-3.7.4-docs-html/_sources/library/gettext.rst.txt b/python-3.7.4-docs-html/_sources/library/gettext.rst.txt new file mode 100644 index 0000000..94ed340 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/gettext.rst.txt @@ -0,0 +1,660 @@ +:mod:`gettext` --- Multilingual internationalization services +============================================================= + +.. module:: gettext + :synopsis: Multilingual internationalization services. + +.. moduleauthor:: Barry A. Warsaw +.. sectionauthor:: Barry A. Warsaw + +**Source code:** :source:`Lib/gettext.py` + +-------------- + +The :mod:`gettext` module provides internationalization (I18N) and localization +(L10N) services for your Python modules and applications. It supports both the +GNU :program:`gettext` message catalog API and a higher level, class-based API that may +be more appropriate for Python files. The interface described below allows you +to write your module and application messages in one natural language, and +provide a catalog of translated messages for running under different natural +languages. + +Some hints on localizing your Python modules and applications are also given. + + +GNU :program:`gettext` API +-------------------------- + +The :mod:`gettext` module defines the following API, which is very similar to +the GNU :program:`gettext` API. If you use this API you will affect the +translation of your entire application globally. Often this is what you want if +your application is monolingual, with the choice of language dependent on the +locale of your user. If you are localizing a Python module, or if your +application needs to switch languages on the fly, you probably want to use the +class-based API instead. + + +.. function:: bindtextdomain(domain, localedir=None) + + Bind the *domain* to the locale directory *localedir*. More concretely, + :mod:`gettext` will look for binary :file:`.mo` files for the given domain using + the path (on Unix): :file:`{localedir}/{language}/LC_MESSAGES/{domain}.mo`, where + *languages* is searched for in the environment variables :envvar:`LANGUAGE`, + :envvar:`LC_ALL`, :envvar:`LC_MESSAGES`, and :envvar:`LANG` respectively. + + If *localedir* is omitted or ``None``, then the current binding for *domain* is + returned. [#]_ + + +.. function:: bind_textdomain_codeset(domain, codeset=None) + + Bind the *domain* to *codeset*, changing the encoding of byte strings + returned by the :func:`lgettext`, :func:`ldgettext`, :func:`lngettext` + and :func:`ldngettext` functions. + If *codeset* is omitted, then the current binding is returned. + + +.. function:: textdomain(domain=None) + + Change or query the current global domain. If *domain* is ``None``, then the + current global domain is returned, otherwise the global domain is set to + *domain*, which is returned. + + +.. index:: single: _ (underscore); gettext +.. function:: gettext(message) + + Return the localized translation of *message*, based on the current global + domain, language, and locale directory. This function is usually aliased as + :func:`_` in the local namespace (see examples below). + + +.. function:: dgettext(domain, message) + + Like :func:`.gettext`, but look the message up in the specified *domain*. + + +.. function:: ngettext(singular, plural, n) + + Like :func:`.gettext`, but consider plural forms. If a translation is found, + apply the plural formula to *n*, and return the resulting message (some + languages have more than two plural forms). If no translation is found, return + *singular* if *n* is 1; return *plural* otherwise. + + The Plural formula is taken from the catalog header. It is a C or Python + expression that has a free variable *n*; the expression evaluates to the index + of the plural in the catalog. See + `the GNU gettext documentation `__ + for the precise syntax to be used in :file:`.po` files and the + formulas for a variety of languages. + + +.. function:: dngettext(domain, singular, plural, n) + + Like :func:`ngettext`, but look the message up in the specified *domain*. + + +.. function:: lgettext(message) +.. function:: ldgettext(domain, message) +.. function:: lngettext(singular, plural, n) +.. function:: ldngettext(domain, singular, plural, n) + + Equivalent to the corresponding functions without the ``l`` prefix + (:func:`.gettext`, :func:`dgettext`, :func:`ngettext` and :func:`dngettext`), + but the translation is returned as a byte string encoded in the preferred + system encoding if no other encoding was explicitly set with + :func:`bind_textdomain_codeset`. + + .. warning:: + + These functions should be avoided in Python 3, because they return + encoded bytes. It's much better to use alternatives which return + Unicode strings instead, since most Python applications will want to + manipulate human readable text as strings instead of bytes. Further, + it's possible that you may get unexpected Unicode-related exceptions + if there are encoding problems with the translated strings. It is + possible that the ``l*()`` functions will be deprecated in future Python + versions due to their inherent problems and limitations. + + +Note that GNU :program:`gettext` also defines a :func:`dcgettext` method, but +this was deemed not useful and so it is currently unimplemented. + +Here's an example of typical usage for this API:: + + import gettext + gettext.bindtextdomain('myapplication', '/path/to/my/language/directory') + gettext.textdomain('myapplication') + _ = gettext.gettext + # ... + print(_('This is a translatable string.')) + + +Class-based API +--------------- + +The class-based API of the :mod:`gettext` module gives you more flexibility and +greater convenience than the GNU :program:`gettext` API. It is the recommended +way of localizing your Python applications and modules. :mod:`!gettext` defines +a :class:`GNUTranslations` class which implements the parsing of GNU :file:`.mo` format +files, and has methods for returning strings. Instances of this class can also +install themselves in the built-in namespace as the function :func:`_`. + + +.. function:: find(domain, localedir=None, languages=None, all=False) + + This function implements the standard :file:`.mo` file search algorithm. It + takes a *domain*, identical to what :func:`textdomain` takes. Optional + *localedir* is as in :func:`bindtextdomain`. Optional *languages* is a list of + strings, where each string is a language code. + + If *localedir* is not given, then the default system locale directory is used. + [#]_ If *languages* is not given, then the following environment variables are + searched: :envvar:`LANGUAGE`, :envvar:`LC_ALL`, :envvar:`LC_MESSAGES`, and + :envvar:`LANG`. The first one returning a non-empty value is used for the + *languages* variable. The environment variables should contain a colon separated + list of languages, which will be split on the colon to produce the expected list + of language code strings. + + :func:`find` then expands and normalizes the languages, and then iterates + through them, searching for an existing file built of these components: + + :file:`{localedir}/{language}/LC_MESSAGES/{domain}.mo` + + The first such file name that exists is returned by :func:`find`. If no such + file is found, then ``None`` is returned. If *all* is given, it returns a list + of all file names, in the order in which they appear in the languages list or + the environment variables. + + +.. function:: translation(domain, localedir=None, languages=None, class_=None, fallback=False, codeset=None) + + Return a :class:`*Translations` instance based on the *domain*, *localedir*, + and *languages*, which are first passed to :func:`find` to get a list of the + associated :file:`.mo` file paths. Instances with identical :file:`.mo` file + names are cached. The actual class instantiated is *class_* if + provided, otherwise :class:`GNUTranslations`. The class's constructor must + take a single :term:`file object` argument. If provided, *codeset* will change + the charset used to encode translated strings in the + :meth:`~NullTranslations.lgettext` and :meth:`~NullTranslations.lngettext` + methods. + + If multiple files are found, later files are used as fallbacks for earlier ones. + To allow setting the fallback, :func:`copy.copy` is used to clone each + translation object from the cache; the actual instance data is still shared with + the cache. + + If no :file:`.mo` file is found, this function raises :exc:`OSError` if + *fallback* is false (which is the default), and returns a + :class:`NullTranslations` instance if *fallback* is true. + + .. versionchanged:: 3.3 + :exc:`IOError` used to be raised instead of :exc:`OSError`. + + +.. function:: install(domain, localedir=None, codeset=None, names=None) + + This installs the function :func:`_` in Python's builtins namespace, based on + *domain*, *localedir*, and *codeset* which are passed to the function + :func:`translation`. + + For the *names* parameter, please see the description of the translation + object's :meth:`~NullTranslations.install` method. + + As seen below, you usually mark the strings in your application that are + candidates for translation, by wrapping them in a call to the :func:`_` + function, like this:: + + print(_('This string will be translated.')) + + For convenience, you want the :func:`_` function to be installed in Python's + builtins namespace, so it is easily accessible in all modules of your + application. + + +The :class:`NullTranslations` class +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Translation classes are what actually implement the translation of original +source file message strings to translated message strings. The base class used +by all translation classes is :class:`NullTranslations`; this provides the basic +interface you can use to write your own specialized translation classes. Here +are the methods of :class:`!NullTranslations`: + + +.. class:: NullTranslations(fp=None) + + Takes an optional :term:`file object` *fp*, which is ignored by the base class. + Initializes "protected" instance variables *_info* and *_charset* which are set + by derived classes, as well as *_fallback*, which is set through + :meth:`add_fallback`. It then calls ``self._parse(fp)`` if *fp* is not + ``None``. + + .. method:: _parse(fp) + + No-op in the base class, this method takes file object *fp*, and reads + the data from the file, initializing its message catalog. If you have an + unsupported message catalog file format, you should override this method + to parse your format. + + + .. method:: add_fallback(fallback) + + Add *fallback* as the fallback object for the current translation object. + A translation object should consult the fallback if it cannot provide a + translation for a given message. + + + .. method:: gettext(message) + + If a fallback has been set, forward :meth:`!gettext` to the fallback. + Otherwise, return *message*. Overridden in derived classes. + + + .. method:: ngettext(singular, plural, n) + + If a fallback has been set, forward :meth:`!ngettext` to the fallback. + Otherwise, return *singular* if *n* is 1; return *plural* otherwise. + Overridden in derived classes. + + + .. method:: lgettext(message) + .. method:: lngettext(singular, plural, n) + + Equivalent to :meth:`.gettext` and :meth:`.ngettext`, but the translation + is returned as a byte string encoded in the preferred system encoding + if no encoding was explicitly set with :meth:`set_output_charset`. + Overridden in derived classes. + + .. warning:: + + These methods should be avoided in Python 3. See the warning for the + :func:`lgettext` function. + + + .. method:: info() + + Return the "protected" :attr:`_info` variable, a dictionary containing + the metadata found in the message catalog file. + + + .. method:: charset() + + Return the encoding of the message catalog file. + + + .. method:: output_charset() + + Return the encoding used to return translated messages in :meth:`.lgettext` + and :meth:`.lngettext`. + + + .. method:: set_output_charset(charset) + + Change the encoding used to return translated messages. + + + .. method:: install(names=None) + + This method installs :meth:`.gettext` into the built-in namespace, + binding it to ``_``. + + If the *names* parameter is given, it must be a sequence containing the + names of functions you want to install in the builtins namespace in + addition to :func:`_`. Supported names are ``'gettext'``, ``'ngettext'``, + ``'lgettext'`` and ``'lngettext'``. + + Note that this is only one way, albeit the most convenient way, to make + the :func:`_` function available to your application. Because it affects + the entire application globally, and specifically the built-in namespace, + localized modules should never install :func:`_`. Instead, they should use + this code to make :func:`_` available to their module:: + + import gettext + t = gettext.translation('mymodule', ...) + _ = t.gettext + + This puts :func:`_` only in the module's global namespace and so only + affects calls within this module. + + +The :class:`GNUTranslations` class +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The :mod:`gettext` module provides one additional class derived from +:class:`NullTranslations`: :class:`GNUTranslations`. This class overrides +:meth:`_parse` to enable reading GNU :program:`gettext` format :file:`.mo` files +in both big-endian and little-endian format. + +:class:`GNUTranslations` parses optional metadata out of the translation +catalog. It is convention with GNU :program:`gettext` to include metadata as +the translation for the empty string. This metadata is in :rfc:`822`\ -style +``key: value`` pairs, and should contain the ``Project-Id-Version`` key. If the +key ``Content-Type`` is found, then the ``charset`` property is used to +initialize the "protected" :attr:`_charset` instance variable, defaulting to +``None`` if not found. If the charset encoding is specified, then all message +ids and message strings read from the catalog are converted to Unicode using +this encoding, else ASCII is assumed. + +Since message ids are read as Unicode strings too, all :meth:`*gettext` methods +will assume message ids as Unicode strings, not byte strings. + +The entire set of key/value pairs are placed into a dictionary and set as the +"protected" :attr:`_info` instance variable. + +If the :file:`.mo` file's magic number is invalid, the major version number is +unexpected, or if other problems occur while reading the file, instantiating a +:class:`GNUTranslations` class can raise :exc:`OSError`. + +.. class:: GNUTranslations + + The following methods are overridden from the base class implementation: + + .. method:: gettext(message) + + Look up the *message* id in the catalog and return the corresponding message + string, as a Unicode string. If there is no entry in the catalog for the + *message* id, and a fallback has been set, the look up is forwarded to the + fallback's :meth:`~NullTranslations.gettext` method. Otherwise, the + *message* id is returned. + + + .. method:: ngettext(singular, plural, n) + + Do a plural-forms lookup of a message id. *singular* is used as the message id + for purposes of lookup in the catalog, while *n* is used to determine which + plural form to use. The returned message string is a Unicode string. + + If the message id is not found in the catalog, and a fallback is specified, + the request is forwarded to the fallback's :meth:`~NullTranslations.ngettext` + method. Otherwise, when *n* is 1 *singular* is returned, and *plural* is + returned in all other cases. + + Here is an example:: + + n = len(os.listdir('.')) + cat = GNUTranslations(somefile) + message = cat.ngettext( + 'There is %(num)d file in this directory', + 'There are %(num)d files in this directory', + n) % {'num': n} + + + .. method:: lgettext(message) + .. method:: lngettext(singular, plural, n) + + Equivalent to :meth:`.gettext` and :meth:`.ngettext`, but the translation + is returned as a byte string encoded in the preferred system encoding + if no encoding was explicitly set with + :meth:`~NullTranslations.set_output_charset`. + + .. warning:: + + These methods should be avoided in Python 3. See the warning for the + :func:`lgettext` function. + + +Solaris message catalog support +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The Solaris operating system defines its own binary :file:`.mo` file format, but +since no documentation can be found on this format, it is not supported at this +time. + + +The Catalog constructor +^^^^^^^^^^^^^^^^^^^^^^^ + +.. index:: single: GNOME + +GNOME uses a version of the :mod:`gettext` module by James Henstridge, but this +version has a slightly different API. Its documented usage was:: + + import gettext + cat = gettext.Catalog(domain, localedir) + _ = cat.gettext + print(_('hello world')) + +For compatibility with this older module, the function :func:`Catalog` is an +alias for the :func:`translation` function described above. + +One difference between this module and Henstridge's: his catalog objects +supported access through a mapping API, but this appears to be unused and so is +not currently supported. + + +Internationalizing your programs and modules +-------------------------------------------- + +Internationalization (I18N) refers to the operation by which a program is made +aware of multiple languages. Localization (L10N) refers to the adaptation of +your program, once internationalized, to the local language and cultural habits. +In order to provide multilingual messages for your Python programs, you need to +take the following steps: + +#. prepare your program or module by specially marking translatable strings + +#. run a suite of tools over your marked files to generate raw messages catalogs + +#. create language-specific translations of the message catalogs + +#. use the :mod:`gettext` module so that message strings are properly translated + +In order to prepare your code for I18N, you need to look at all the strings in +your files. Any string that needs to be translated should be marked by wrapping +it in ``_('...')`` --- that is, a call to the function :func:`_`. For example:: + + filename = 'mylog.txt' + message = _('writing a log message') + with open(filename, 'w') as fp: + fp.write(message) + +In this example, the string ``'writing a log message'`` is marked as a candidate +for translation, while the strings ``'mylog.txt'`` and ``'w'`` are not. + +There are a few tools to extract the strings meant for translation. +The original GNU :program:`gettext` only supported C or C++ source +code but its extended version :program:`xgettext` scans code written +in a number of languages, including Python, to find strings marked as +translatable. `Babel `__ is a Python +internationalization library that includes a :file:`pybabel` script to +extract and compile message catalogs. François Pinard's program +called :program:`xpot` does a similar job and is available as part of +his `po-utils package `__. + +(Python also includes pure-Python versions of these programs, called +:program:`pygettext.py` and :program:`msgfmt.py`; some Python distributions +will install them for you. :program:`pygettext.py` is similar to +:program:`xgettext`, but only understands Python source code and +cannot handle other programming languages such as C or C++. +:program:`pygettext.py` supports a command-line interface similar to +:program:`xgettext`; for details on its use, run ``pygettext.py +--help``. :program:`msgfmt.py` is binary compatible with GNU +:program:`msgfmt`. With these two programs, you may not need the GNU +:program:`gettext` package to internationalize your Python +applications.) + +:program:`xgettext`, :program:`pygettext`, and similar tools generate +:file:`.po` files that are message catalogs. They are structured +human-readable files that contain every marked string in the source +code, along with a placeholder for the translated versions of these +strings. + +Copies of these :file:`.po` files are then handed over to the +individual human translators who write translations for every +supported natural language. They send back the completed +language-specific versions as a :file:`.po` file that's +compiled into a machine-readable :file:`.mo` binary catalog file using +the :program:`msgfmt` program. The :file:`.mo` files are used by the +:mod:`gettext` module for the actual translation processing at +run-time. + +How you use the :mod:`gettext` module in your code depends on whether you are +internationalizing a single module or your entire application. The next two +sections will discuss each case. + + +Localizing your module +^^^^^^^^^^^^^^^^^^^^^^ + +If you are localizing your module, you must take care not to make global +changes, e.g. to the built-in namespace. You should not use the GNU :program:`gettext` +API but instead the class-based API. + +Let's say your module is called "spam" and the module's various natural language +translation :file:`.mo` files reside in :file:`/usr/share/locale` in GNU +:program:`gettext` format. Here's what you would put at the top of your +module:: + + import gettext + t = gettext.translation('spam', '/usr/share/locale') + _ = t.gettext + + +Localizing your application +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you are localizing your application, you can install the :func:`_` function +globally into the built-in namespace, usually in the main driver file of your +application. This will let all your application-specific files just use +``_('...')`` without having to explicitly install it in each file. + +In the simple case then, you need only add the following bit of code to the main +driver file of your application:: + + import gettext + gettext.install('myapplication') + +If you need to set the locale directory, you can pass it into the +:func:`install` function:: + + import gettext + gettext.install('myapplication', '/usr/share/locale') + + +Changing languages on the fly +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If your program needs to support many languages at the same time, you may want +to create multiple translation instances and then switch between them +explicitly, like so:: + + import gettext + + lang1 = gettext.translation('myapplication', languages=['en']) + lang2 = gettext.translation('myapplication', languages=['fr']) + lang3 = gettext.translation('myapplication', languages=['de']) + + # start by using language1 + lang1.install() + + # ... time goes by, user selects language 2 + lang2.install() + + # ... more time goes by, user selects language 3 + lang3.install() + + +Deferred translations +^^^^^^^^^^^^^^^^^^^^^ + +In most coding situations, strings are translated where they are coded. +Occasionally however, you need to mark strings for translation, but defer actual +translation until later. A classic example is:: + + animals = ['mollusk', + 'albatross', + 'rat', + 'penguin', + 'python', ] + # ... + for a in animals: + print(a) + +Here, you want to mark the strings in the ``animals`` list as being +translatable, but you don't actually want to translate them until they are +printed. + +Here is one way you can handle this situation:: + + def _(message): return message + + animals = [_('mollusk'), + _('albatross'), + _('rat'), + _('penguin'), + _('python'), ] + + del _ + + # ... + for a in animals: + print(_(a)) + +This works because the dummy definition of :func:`_` simply returns the string +unchanged. And this dummy definition will temporarily override any definition +of :func:`_` in the built-in namespace (until the :keyword:`del` command). Take +care, though if you have a previous definition of :func:`_` in the local +namespace. + +Note that the second use of :func:`_` will not identify "a" as being +translatable to the :program:`gettext` program, because the parameter +is not a string literal. + +Another way to handle this is with the following example:: + + def N_(message): return message + + animals = [N_('mollusk'), + N_('albatross'), + N_('rat'), + N_('penguin'), + N_('python'), ] + + # ... + for a in animals: + print(_(a)) + +In this case, you are marking translatable strings with the function +:func:`N_`, which won't conflict with any definition of :func:`_`. +However, you will need to teach your message extraction program to +look for translatable strings marked with :func:`N_`. :program:`xgettext`, +:program:`pygettext`, ``pybabel extract``, and :program:`xpot` all +support this through the use of the :option:`!-k` command-line switch. +The choice of :func:`N_` here is totally arbitrary; it could have just +as easily been :func:`MarkThisStringForTranslation`. + + +Acknowledgements +---------------- + +The following people contributed code, feedback, design suggestions, previous +implementations, and valuable experience to the creation of this module: + +* Peter Funk + +* James Henstridge + +* Juan David Ibáñez Palomar + +* Marc-André Lemburg + +* Martin von Löwis + +* François Pinard + +* Barry Warsaw + +* Gustavo Niemeyer + +.. rubric:: Footnotes + +.. [#] The default locale directory is system dependent; for example, on RedHat Linux + it is :file:`/usr/share/locale`, but on Solaris it is :file:`/usr/lib/locale`. + The :mod:`gettext` module does not try to support these system dependent + defaults; instead its default is :file:`{sys.prefix}/share/locale` (see + :data:`sys.prefix`). For this reason, it is always best to call + :func:`bindtextdomain` with an explicit absolute path at the start of your + application. + +.. [#] See the footnote for :func:`bindtextdomain` above. diff --git a/python-3.7.4-docs-html/_sources/library/glob.rst.txt b/python-3.7.4-docs-html/_sources/library/glob.rst.txt new file mode 100644 index 0000000..0db10b5 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/glob.rst.txt @@ -0,0 +1,111 @@ +:mod:`glob` --- Unix style pathname pattern expansion +===================================================== + +.. module:: glob + :synopsis: Unix shell style pathname pattern expansion. + +**Source code:** :source:`Lib/glob.py` + +.. index:: single: filenames; pathname expansion + +-------------- + +.. index:: + single: * (asterisk); in glob-style wildcards + single: ? (question mark); in glob-style wildcards + single: [] (square brackets); in glob-style wildcards + single: ! (exclamation); in glob-style wildcards + single: - (minus); in glob-style wildcards + single: . (dot); in glob-style wildcards + +The :mod:`glob` module finds all the pathnames matching a specified pattern +according to the rules used by the Unix shell, although results are returned in +arbitrary order. No tilde expansion is done, but ``*``, ``?``, and character +ranges expressed with ``[]`` will be correctly matched. This is done by using +the :func:`os.scandir` and :func:`fnmatch.fnmatch` functions in concert, and +not by actually invoking a subshell. Note that unlike :func:`fnmatch.fnmatch`, +:mod:`glob` treats filenames beginning with a dot (``.``) as special cases. +(For tilde and shell variable expansion, use :func:`os.path.expanduser` and +:func:`os.path.expandvars`.) + +For a literal match, wrap the meta-characters in brackets. +For example, ``'[?]'`` matches the character ``'?'``. + + +.. seealso:: + The :mod:`pathlib` module offers high-level path objects. + + +.. function:: glob(pathname, *, recursive=False) + + Return a possibly-empty list of path names that match *pathname*, which must be + a string containing a path specification. *pathname* can be either absolute + (like :file:`/usr/src/Python-1.5/Makefile`) or relative (like + :file:`../../Tools/\*/\*.gif`), and can contain shell-style wildcards. Broken + symlinks are included in the results (as in the shell). + + .. index:: + single: **; in glob-style wildcards + + If *recursive* is true, the pattern "``**``" will match any files and zero or + more directories and subdirectories. If the pattern is followed by an + ``os.sep``, only directories and subdirectories match. + + .. note:: + Using the "``**``" pattern in large directory trees may consume + an inordinate amount of time. + + .. versionchanged:: 3.5 + Support for recursive globs using "``**``". + + +.. function:: iglob(pathname, *, recursive=False) + + Return an :term:`iterator` which yields the same values as :func:`glob` + without actually storing them all simultaneously. + + +.. function:: escape(pathname) + + Escape all special characters (``'?'``, ``'*'`` and ``'['``). + This is useful if you want to match an arbitrary literal string that may + have special characters in it. Special characters in drive/UNC + sharepoints are not escaped, e.g. on Windows + ``escape('//?/c:/Quo vadis?.txt')`` returns ``'//?/c:/Quo vadis[?].txt'``. + + .. versionadded:: 3.4 + + +For example, consider a directory containing the following files: +:file:`1.gif`, :file:`2.txt`, :file:`card.gif` and a subdirectory :file:`sub` +which contains only the file :file:`3.txt`. :func:`glob` will produce +the following results. Notice how any leading components of the path are +preserved. :: + + >>> import glob + >>> glob.glob('./[0-9].*') + ['./1.gif', './2.txt'] + >>> glob.glob('*.gif') + ['1.gif', 'card.gif'] + >>> glob.glob('?.gif') + ['1.gif'] + >>> glob.glob('**/*.txt', recursive=True) + ['2.txt', 'sub/3.txt'] + >>> glob.glob('./**/', recursive=True) + ['./', './sub/'] + +If the directory contains files starting with ``.`` they won't be matched by +default. For example, consider a directory containing :file:`card.gif` and +:file:`.card.gif`:: + + >>> import glob + >>> glob.glob('*.gif') + ['card.gif'] + >>> glob.glob('.c*') + ['.card.gif'] + +.. seealso:: + + Module :mod:`fnmatch` + Shell-style filename (not path) expansion + diff --git a/python-3.7.4-docs-html/_sources/library/grp.rst.txt b/python-3.7.4-docs-html/_sources/library/grp.rst.txt new file mode 100644 index 0000000..74de3f9 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/grp.rst.txt @@ -0,0 +1,68 @@ +:mod:`grp` --- The group database +================================= + +.. module:: grp + :platform: Unix + :synopsis: The group database (getgrnam() and friends). + +-------------- + +This module provides access to the Unix group database. It is available on all +Unix versions. + +Group database entries are reported as a tuple-like object, whose attributes +correspond to the members of the ``group`` structure (Attribute field below, see +````): + ++-------+-----------+---------------------------------+ +| Index | Attribute | Meaning | ++=======+===========+=================================+ +| 0 | gr_name | the name of the group | ++-------+-----------+---------------------------------+ +| 1 | gr_passwd | the (encrypted) group password; | +| | | often empty | ++-------+-----------+---------------------------------+ +| 2 | gr_gid | the numerical group ID | ++-------+-----------+---------------------------------+ +| 3 | gr_mem | all the group member's user | +| | | names | ++-------+-----------+---------------------------------+ + +The gid is an integer, name and password are strings, and the member list is a +list of strings. (Note that most users are not explicitly listed as members of +the group they are in according to the password database. Check both databases +to get complete membership information. Also note that a ``gr_name`` that +starts with a ``+`` or ``-`` is likely to be a YP/NIS reference and may not be +accessible via :func:`getgrnam` or :func:`getgrgid`.) + +It defines the following items: + + +.. function:: getgrgid(gid) + + Return the group database entry for the given numeric group ID. :exc:`KeyError` + is raised if the entry asked for cannot be found. + + .. deprecated:: 3.6 + Since Python 3.6 the support of non-integer arguments like floats or + strings in :func:`getgrgid` is deprecated. + +.. function:: getgrnam(name) + + Return the group database entry for the given group name. :exc:`KeyError` is + raised if the entry asked for cannot be found. + + +.. function:: getgrall() + + Return a list of all available group entries, in arbitrary order. + + +.. seealso:: + + Module :mod:`pwd` + An interface to the user database, similar to this. + + Module :mod:`spwd` + An interface to the shadow password database, similar to this. + diff --git a/python-3.7.4-docs-html/_sources/library/gzip.rst.txt b/python-3.7.4-docs-html/_sources/library/gzip.rst.txt new file mode 100644 index 0000000..9c6b722 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/gzip.rst.txt @@ -0,0 +1,213 @@ +:mod:`gzip` --- Support for :program:`gzip` files +================================================= + +.. module:: gzip + :synopsis: Interfaces for gzip compression and decompression using file objects. + +**Source code:** :source:`Lib/gzip.py` + +-------------- + +This module provides a simple interface to compress and decompress files just +like the GNU programs :program:`gzip` and :program:`gunzip` would. + +The data compression is provided by the :mod:`zlib` module. + +The :mod:`gzip` module provides the :class:`GzipFile` class, as well as the +:func:`.open`, :func:`compress` and :func:`decompress` convenience functions. +The :class:`GzipFile` class reads and writes :program:`gzip`\ -format files, +automatically compressing or decompressing the data so that it looks like an +ordinary :term:`file object`. + +Note that additional file formats which can be decompressed by the +:program:`gzip` and :program:`gunzip` programs, such as those produced by +:program:`compress` and :program:`pack`, are not supported by this module. + +The module defines the following items: + + +.. function:: open(filename, mode='rb', compresslevel=9, encoding=None, errors=None, newline=None) + + Open a gzip-compressed file in binary or text mode, returning a :term:`file + object`. + + The *filename* argument can be an actual filename (a :class:`str` or + :class:`bytes` object), or an existing file object to read from or write to. + + The *mode* argument can be any of ``'r'``, ``'rb'``, ``'a'``, ``'ab'``, + ``'w'``, ``'wb'``, ``'x'`` or ``'xb'`` for binary mode, or ``'rt'``, + ``'at'``, ``'wt'``, or ``'xt'`` for text mode. The default is ``'rb'``. + + The *compresslevel* argument is an integer from 0 to 9, as for the + :class:`GzipFile` constructor. + + For binary mode, this function is equivalent to the :class:`GzipFile` + constructor: ``GzipFile(filename, mode, compresslevel)``. In this case, the + *encoding*, *errors* and *newline* arguments must not be provided. + + For text mode, a :class:`GzipFile` object is created, and wrapped in an + :class:`io.TextIOWrapper` instance with the specified encoding, error + handling behavior, and line ending(s). + + .. versionchanged:: 3.3 + Added support for *filename* being a file object, support for text mode, + and the *encoding*, *errors* and *newline* arguments. + + .. versionchanged:: 3.4 + Added support for the ``'x'``, ``'xb'`` and ``'xt'`` modes. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + +.. class:: GzipFile(filename=None, mode=None, compresslevel=9, fileobj=None, mtime=None) + + Constructor for the :class:`GzipFile` class, which simulates most of the + methods of a :term:`file object`, with the exception of the :meth:`truncate` + method. At least one of *fileobj* and *filename* must be given a non-trivial + value. + + The new class instance is based on *fileobj*, which can be a regular file, an + :class:`io.BytesIO` object, or any other object which simulates a file. It + defaults to ``None``, in which case *filename* is opened to provide a file + object. + + When *fileobj* is not ``None``, the *filename* argument is only used to be + included in the :program:`gzip` file header, which may include the original + filename of the uncompressed file. It defaults to the filename of *fileobj*, if + discernible; otherwise, it defaults to the empty string, and in this case the + original filename is not included in the header. + + The *mode* argument can be any of ``'r'``, ``'rb'``, ``'a'``, ``'ab'``, ``'w'``, + ``'wb'``, ``'x'``, or ``'xb'``, depending on whether the file will be read or + written. The default is the mode of *fileobj* if discernible; otherwise, the + default is ``'rb'``. + + Note that the file is always opened in binary mode. To open a compressed file + in text mode, use :func:`.open` (or wrap your :class:`GzipFile` with an + :class:`io.TextIOWrapper`). + + The *compresslevel* argument is an integer from ``0`` to ``9`` controlling + the level of compression; ``1`` is fastest and produces the least + compression, and ``9`` is slowest and produces the most compression. ``0`` + is no compression. The default is ``9``. + + The *mtime* argument is an optional numeric timestamp to be written to + the last modification time field in the stream when compressing. It + should only be provided in compression mode. If omitted or ``None``, the + current time is used. See the :attr:`mtime` attribute for more details. + + Calling a :class:`GzipFile` object's :meth:`close` method does not close + *fileobj*, since you might wish to append more material after the compressed + data. This also allows you to pass an :class:`io.BytesIO` object opened for + writing as *fileobj*, and retrieve the resulting memory buffer using the + :class:`io.BytesIO` object's :meth:`~io.BytesIO.getvalue` method. + + :class:`GzipFile` supports the :class:`io.BufferedIOBase` interface, + including iteration and the :keyword:`with` statement. Only the + :meth:`truncate` method isn't implemented. + + :class:`GzipFile` also provides the following method and attribute: + + .. method:: peek(n) + + Read *n* uncompressed bytes without advancing the file position. + At most one single read on the compressed stream is done to satisfy + the call. The number of bytes returned may be more or less than + requested. + + .. note:: While calling :meth:`peek` does not change the file position of + the :class:`GzipFile`, it may change the position of the underlying + file object (e.g. if the :class:`GzipFile` was constructed with the + *fileobj* parameter). + + .. versionadded:: 3.2 + + .. attribute:: mtime + + When decompressing, the value of the last modification time field in + the most recently read header may be read from this attribute, as an + integer. The initial value before reading any headers is ``None``. + + All :program:`gzip` compressed streams are required to contain this + timestamp field. Some programs, such as :program:`gunzip`\ , make use + of the timestamp. The format is the same as the return value of + :func:`time.time` and the :attr:`~os.stat_result.st_mtime` attribute of + the object returned by :func:`os.stat`. + + .. versionchanged:: 3.1 + Support for the :keyword:`with` statement was added, along with the + *mtime* constructor argument and :attr:`mtime` attribute. + + .. versionchanged:: 3.2 + Support for zero-padded and unseekable files was added. + + .. versionchanged:: 3.3 + The :meth:`io.BufferedIOBase.read1` method is now implemented. + + .. versionchanged:: 3.4 + Added support for the ``'x'`` and ``'xb'`` modes. + + .. versionchanged:: 3.5 + Added support for writing arbitrary + :term:`bytes-like objects `. + The :meth:`~io.BufferedIOBase.read` method now accepts an argument of + ``None``. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: compress(data, compresslevel=9) + + Compress the *data*, returning a :class:`bytes` object containing + the compressed data. *compresslevel* has the same meaning as in + the :class:`GzipFile` constructor above. + + .. versionadded:: 3.2 + +.. function:: decompress(data) + + Decompress the *data*, returning a :class:`bytes` object containing the + uncompressed data. + + .. versionadded:: 3.2 + + +.. _gzip-usage-examples: + +Examples of usage +----------------- + +Example of how to read a compressed file:: + + import gzip + with gzip.open('/home/joe/file.txt.gz', 'rb') as f: + file_content = f.read() + +Example of how to create a compressed GZIP file:: + + import gzip + content = b"Lots of content here" + with gzip.open('/home/joe/file.txt.gz', 'wb') as f: + f.write(content) + +Example of how to GZIP compress an existing file:: + + import gzip + import shutil + with open('/home/joe/file.txt', 'rb') as f_in: + with gzip.open('/home/joe/file.txt.gz', 'wb') as f_out: + shutil.copyfileobj(f_in, f_out) + +Example of how to GZIP compress a binary string:: + + import gzip + s_in = b"Lots of content here" + s_out = gzip.compress(s_in) + +.. seealso:: + + Module :mod:`zlib` + The basic data compression module needed to support the :program:`gzip` file + format. + diff --git a/python-3.7.4-docs-html/_sources/library/hashlib.rst.txt b/python-3.7.4-docs-html/_sources/library/hashlib.rst.txt new file mode 100644 index 0000000..ab4414f --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/hashlib.rst.txt @@ -0,0 +1,739 @@ +:mod:`hashlib` --- Secure hashes and message digests +==================================================== + +.. module:: hashlib + :synopsis: Secure hash and message digest algorithms. + +.. moduleauthor:: Gregory P. Smith +.. sectionauthor:: Gregory P. Smith + +**Source code:** :source:`Lib/hashlib.py` + +.. index:: + single: message digest, MD5 + single: secure hash algorithm, SHA1, SHA224, SHA256, SHA384, SHA512 + +.. testsetup:: + + import hashlib + + +-------------- + +This module implements a common interface to many different secure hash and +message digest algorithms. Included are the FIPS secure hash algorithms SHA1, +SHA224, SHA256, SHA384, and SHA512 (defined in FIPS 180-2) as well as RSA's MD5 +algorithm (defined in Internet :rfc:`1321`). The terms "secure hash" and +"message digest" are interchangeable. Older algorithms were called message +digests. The modern term is secure hash. + +.. note:: + + If you want the adler32 or crc32 hash functions, they are available in + the :mod:`zlib` module. + +.. warning:: + + Some algorithms have known hash collision weaknesses, refer to the "See + also" section at the end. + + +.. _hash-algorithms: + +Hash algorithms +--------------- + +There is one constructor method named for each type of :dfn:`hash`. All return +a hash object with the same simple interface. For example: use :func:`sha256` to +create a SHA-256 hash object. You can now feed this object with :term:`bytes-like +objects ` (normally :class:`bytes`) using the :meth:`update` method. +At any point you can ask it for the :dfn:`digest` of the +concatenation of the data fed to it so far using the :meth:`digest` or +:meth:`hexdigest` methods. + +.. note:: + + For better multithreading performance, the Python :term:`GIL` is released for + data larger than 2047 bytes at object creation or on update. + +.. note:: + + Feeding string objects into :meth:`update` is not supported, as hashes work + on bytes, not on characters. + +.. index:: single: OpenSSL; (use in module hashlib) + +Constructors for hash algorithms that are always present in this module are +:func:`sha1`, :func:`sha224`, :func:`sha256`, :func:`sha384`, +:func:`sha512`, :func:`blake2b`, and :func:`blake2s`. +:func:`md5` is normally available as well, though it +may be missing if you are using a rare "FIPS compliant" build of Python. +Additional algorithms may also be available depending upon the OpenSSL +library that Python uses on your platform. On most platforms the +:func:`sha3_224`, :func:`sha3_256`, :func:`sha3_384`, :func:`sha3_512`, +:func:`shake_128`, :func:`shake_256` are also available. + +.. versionadded:: 3.6 + SHA3 (Keccak) and SHAKE constructors :func:`sha3_224`, :func:`sha3_256`, + :func:`sha3_384`, :func:`sha3_512`, :func:`shake_128`, :func:`shake_256`. + +.. versionadded:: 3.6 + :func:`blake2b` and :func:`blake2s` were added. + +For example, to obtain the digest of the byte string ``b'Nobody inspects the +spammish repetition'``:: + + >>> import hashlib + >>> m = hashlib.sha256() + >>> m.update(b"Nobody inspects") + >>> m.update(b" the spammish repetition") + >>> m.digest() + b'\x03\x1e\xdd}Ae\x15\x93\xc5\xfe\\\x00o\xa5u+7\xfd\xdf\xf7\xbcN\x84:\xa6\xaf\x0c\x95\x0fK\x94\x06' + >>> m.digest_size + 32 + >>> m.block_size + 64 + +More condensed: + + >>> hashlib.sha224(b"Nobody inspects the spammish repetition").hexdigest() + 'a4337bc45a8fc544c03f52dc550cd6e1e87021bc896588bd79e901e2' + +.. function:: new(name[, data]) + + Is a generic constructor that takes the string *name* of the desired + algorithm as its first parameter. It also exists to allow access to the + above listed hashes as well as any other algorithms that your OpenSSL + library may offer. The named constructors are much faster than :func:`new` + and should be preferred. + +Using :func:`new` with an algorithm provided by OpenSSL: + + >>> h = hashlib.new('ripemd160') + >>> h.update(b"Nobody inspects the spammish repetition") + >>> h.hexdigest() + 'cc4a5ce1b3df48aec5d22d1f16b894a0b894eccc' + +Hashlib provides the following constant attributes: + +.. data:: algorithms_guaranteed + + A set containing the names of the hash algorithms guaranteed to be supported + by this module on all platforms. Note that 'md5' is in this list despite + some upstream vendors offering an odd "FIPS compliant" Python build that + excludes it. + + .. versionadded:: 3.2 + +.. data:: algorithms_available + + A set containing the names of the hash algorithms that are available in the + running Python interpreter. These names will be recognized when passed to + :func:`new`. :attr:`algorithms_guaranteed` will always be a subset. The + same algorithm may appear multiple times in this set under different names + (thanks to OpenSSL). + + .. versionadded:: 3.2 + +The following values are provided as constant attributes of the hash objects +returned by the constructors: + + +.. data:: hash.digest_size + + The size of the resulting hash in bytes. + +.. data:: hash.block_size + + The internal block size of the hash algorithm in bytes. + +A hash object has the following attributes: + +.. attribute:: hash.name + + The canonical name of this hash, always lowercase and always suitable as a + parameter to :func:`new` to create another hash of this type. + + .. versionchanged:: 3.4 + The name attribute has been present in CPython since its inception, but + until Python 3.4 was not formally specified, so may not exist on some + platforms. + +A hash object has the following methods: + + +.. method:: hash.update(data) + + Update the hash object with the :term:`bytes-like object`. + Repeated calls are equivalent to a single call with the + concatenation of all the arguments: ``m.update(a); m.update(b)`` is + equivalent to ``m.update(a+b)``. + + .. versionchanged:: 3.1 + The Python GIL is released to allow other threads to run while hash + updates on data larger than 2047 bytes is taking place when using hash + algorithms supplied by OpenSSL. + + +.. method:: hash.digest() + + Return the digest of the data passed to the :meth:`update` method so far. + This is a bytes object of size :attr:`digest_size` which may contain bytes in + the whole range from 0 to 255. + + +.. method:: hash.hexdigest() + + Like :meth:`digest` except the digest is returned as a string object of + double length, containing only hexadecimal digits. This may be used to + exchange the value safely in email or other non-binary environments. + + +.. method:: hash.copy() + + Return a copy ("clone") of the hash object. This can be used to efficiently + compute the digests of data sharing a common initial substring. + + +SHAKE variable length digests +----------------------------- + +The :func:`shake_128` and :func:`shake_256` algorithms provide variable +length digests with length_in_bits//2 up to 128 or 256 bits of security. +As such, their digest methods require a length. Maximum length is not limited +by the SHAKE algorithm. + +.. method:: shake.digest(length) + + Return the digest of the data passed to the :meth:`update` method so far. + This is a bytes object of size *length* which may contain bytes in + the whole range from 0 to 255. + + +.. method:: shake.hexdigest(length) + + Like :meth:`digest` except the digest is returned as a string object of + double length, containing only hexadecimal digits. This may be used to + exchange the value safely in email or other non-binary environments. + + +Key derivation +-------------- + +Key derivation and key stretching algorithms are designed for secure password +hashing. Naive algorithms such as ``sha1(password)`` are not resistant against +brute-force attacks. A good password hashing function must be tunable, slow, and +include a `salt `_. + + +.. function:: pbkdf2_hmac(hash_name, password, salt, iterations, dklen=None) + + The function provides PKCS#5 password-based key derivation function 2. It + uses HMAC as pseudorandom function. + + The string *hash_name* is the desired name of the hash digest algorithm for + HMAC, e.g. 'sha1' or 'sha256'. *password* and *salt* are interpreted as + buffers of bytes. Applications and libraries should limit *password* to + a sensible length (e.g. 1024). *salt* should be about 16 or more bytes from + a proper source, e.g. :func:`os.urandom`. + + The number of *iterations* should be chosen based on the hash algorithm and + computing power. As of 2013, at least 100,000 iterations of SHA-256 are + suggested. + + *dklen* is the length of the derived key. If *dklen* is ``None`` then the + digest size of the hash algorithm *hash_name* is used, e.g. 64 for SHA-512. + + >>> import hashlib, binascii + >>> dk = hashlib.pbkdf2_hmac('sha256', b'password', b'salt', 100000) + >>> binascii.hexlify(dk) + b'0394a2ede332c9a13eb82e9b24631604c31df978b4e2f0fbd2c549944f9d79a5' + + .. versionadded:: 3.4 + + .. note:: + + A fast implementation of *pbkdf2_hmac* is available with OpenSSL. The + Python implementation uses an inline version of :mod:`hmac`. It is about + three times slower and doesn't release the GIL. + +.. function:: scrypt(password, *, salt, n, r, p, maxmem=0, dklen=64) + + The function provides scrypt password-based key derivation function as + defined in :rfc:`7914`. + + *password* and *salt* must be :term:`bytes-like objects + `. Applications and libraries should limit *password* + to a sensible length (e.g. 1024). *salt* should be about 16 or more + bytes from a proper source, e.g. :func:`os.urandom`. + + *n* is the CPU/Memory cost factor, *r* the block size, *p* parallelization + factor and *maxmem* limits memory (OpenSSL 1.1.0 defaults to 32 MiB). + *dklen* is the length of the derived key. + + .. availability:: OpenSSL 1.1+. + + .. versionadded:: 3.6 + + +BLAKE2 +------ + +.. sectionauthor:: Dmitry Chestnykh + +.. index:: + single: blake2b, blake2s + +BLAKE2_ is a cryptographic hash function defined in :rfc:`7693` that comes in two +flavors: + +* **BLAKE2b**, optimized for 64-bit platforms and produces digests of any size + between 1 and 64 bytes, + +* **BLAKE2s**, optimized for 8- to 32-bit platforms and produces digests of any + size between 1 and 32 bytes. + +BLAKE2 supports **keyed mode** (a faster and simpler replacement for HMAC_), +**salted hashing**, **personalization**, and **tree hashing**. + +Hash objects from this module follow the API of standard library's +:mod:`hashlib` objects. + + +Creating hash objects +^^^^^^^^^^^^^^^^^^^^^ + +New hash objects are created by calling constructor functions: + + +.. function:: blake2b(data=b'', *, digest_size=64, key=b'', salt=b'', \ + person=b'', fanout=1, depth=1, leaf_size=0, node_offset=0, \ + node_depth=0, inner_size=0, last_node=False) + +.. function:: blake2s(data=b'', *, digest_size=32, key=b'', salt=b'', \ + person=b'', fanout=1, depth=1, leaf_size=0, node_offset=0, \ + node_depth=0, inner_size=0, last_node=False) + + +These functions return the corresponding hash objects for calculating +BLAKE2b or BLAKE2s. They optionally take these general parameters: + +* *data*: initial chunk of data to hash, which must be + :term:`bytes-like object`. It can be passed only as positional argument. + +* *digest_size*: size of output digest in bytes. + +* *key*: key for keyed hashing (up to 64 bytes for BLAKE2b, up to 32 bytes for + BLAKE2s). + +* *salt*: salt for randomized hashing (up to 16 bytes for BLAKE2b, up to 8 + bytes for BLAKE2s). + +* *person*: personalization string (up to 16 bytes for BLAKE2b, up to 8 bytes + for BLAKE2s). + +The following table shows limits for general parameters (in bytes): + +======= =========== ======== ========= =========== +Hash digest_size len(key) len(salt) len(person) +======= =========== ======== ========= =========== +BLAKE2b 64 64 16 16 +BLAKE2s 32 32 8 8 +======= =========== ======== ========= =========== + +.. note:: + + BLAKE2 specification defines constant lengths for salt and personalization + parameters, however, for convenience, this implementation accepts byte + strings of any size up to the specified length. If the length of the + parameter is less than specified, it is padded with zeros, thus, for + example, ``b'salt'`` and ``b'salt\x00'`` is the same value. (This is not + the case for *key*.) + +These sizes are available as module `constants`_ described below. + +Constructor functions also accept the following tree hashing parameters: + +* *fanout*: fanout (0 to 255, 0 if unlimited, 1 in sequential mode). + +* *depth*: maximal depth of tree (1 to 255, 255 if unlimited, 1 in + sequential mode). + +* *leaf_size*: maximal byte length of leaf (0 to 2**32-1, 0 if unlimited or in + sequential mode). + +* *node_offset*: node offset (0 to 2**64-1 for BLAKE2b, 0 to 2**48-1 for + BLAKE2s, 0 for the first, leftmost, leaf, or in sequential mode). + +* *node_depth*: node depth (0 to 255, 0 for leaves, or in sequential mode). + +* *inner_size*: inner digest size (0 to 64 for BLAKE2b, 0 to 32 for + BLAKE2s, 0 in sequential mode). + +* *last_node*: boolean indicating whether the processed node is the last + one (`False` for sequential mode). + +.. figure:: hashlib-blake2-tree.png + :alt: Explanation of tree mode parameters. + +See section 2.10 in `BLAKE2 specification +`_ for comprehensive review of tree +hashing. + + +Constants +^^^^^^^^^ + +.. data:: blake2b.SALT_SIZE +.. data:: blake2s.SALT_SIZE + +Salt length (maximum length accepted by constructors). + + +.. data:: blake2b.PERSON_SIZE +.. data:: blake2s.PERSON_SIZE + +Personalization string length (maximum length accepted by constructors). + + +.. data:: blake2b.MAX_KEY_SIZE +.. data:: blake2s.MAX_KEY_SIZE + +Maximum key size. + + +.. data:: blake2b.MAX_DIGEST_SIZE +.. data:: blake2s.MAX_DIGEST_SIZE + +Maximum digest size that the hash function can output. + + +Examples +^^^^^^^^ + +Simple hashing +"""""""""""""" + +To calculate hash of some data, you should first construct a hash object by +calling the appropriate constructor function (:func:`blake2b` or +:func:`blake2s`), then update it with the data by calling :meth:`update` on the +object, and, finally, get the digest out of the object by calling +:meth:`digest` (or :meth:`hexdigest` for hex-encoded string). + + >>> from hashlib import blake2b + >>> h = blake2b() + >>> h.update(b'Hello world') + >>> h.hexdigest() + '6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183' + + +As a shortcut, you can pass the first chunk of data to update directly to the +constructor as the positional argument: + + >>> from hashlib import blake2b + >>> blake2b(b'Hello world').hexdigest() + '6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183' + +You can call :meth:`hash.update` as many times as you need to iteratively +update the hash: + + >>> from hashlib import blake2b + >>> items = [b'Hello', b' ', b'world'] + >>> h = blake2b() + >>> for item in items: + ... h.update(item) + >>> h.hexdigest() + '6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183' + + +Using different digest sizes +"""""""""""""""""""""""""""" + +BLAKE2 has configurable size of digests up to 64 bytes for BLAKE2b and up to 32 +bytes for BLAKE2s. For example, to replace SHA-1 with BLAKE2b without changing +the size of output, we can tell BLAKE2b to produce 20-byte digests: + + >>> from hashlib import blake2b + >>> h = blake2b(digest_size=20) + >>> h.update(b'Replacing SHA1 with the more secure function') + >>> h.hexdigest() + 'd24f26cf8de66472d58d4e1b1774b4c9158b1f4c' + >>> h.digest_size + 20 + >>> len(h.digest()) + 20 + +Hash objects with different digest sizes have completely different outputs +(shorter hashes are *not* prefixes of longer hashes); BLAKE2b and BLAKE2s +produce different outputs even if the output length is the same: + + >>> from hashlib import blake2b, blake2s + >>> blake2b(digest_size=10).hexdigest() + '6fa1d8fcfd719046d762' + >>> blake2b(digest_size=11).hexdigest() + 'eb6ec15daf9546254f0809' + >>> blake2s(digest_size=10).hexdigest() + '1bf21a98c78a1c376ae9' + >>> blake2s(digest_size=11).hexdigest() + '567004bf96e4a25773ebf4' + + +Keyed hashing +""""""""""""" + +Keyed hashing can be used for authentication as a faster and simpler +replacement for `Hash-based message authentication code +`_ (HMAC). +BLAKE2 can be securely used in prefix-MAC mode thanks to the +indifferentiability property inherited from BLAKE. + +This example shows how to get a (hex-encoded) 128-bit authentication code for +message ``b'message data'`` with key ``b'pseudorandom key'``:: + + >>> from hashlib import blake2b + >>> h = blake2b(key=b'pseudorandom key', digest_size=16) + >>> h.update(b'message data') + >>> h.hexdigest() + '3d363ff7401e02026f4a4687d4863ced' + + +As a practical example, a web application can symmetrically sign cookies sent +to users and later verify them to make sure they weren't tampered with:: + + >>> from hashlib import blake2b + >>> from hmac import compare_digest + >>> + >>> SECRET_KEY = b'pseudorandomly generated server secret key' + >>> AUTH_SIZE = 16 + >>> + >>> def sign(cookie): + ... h = blake2b(digest_size=AUTH_SIZE, key=SECRET_KEY) + ... h.update(cookie) + ... return h.hexdigest().encode('utf-8') + >>> + >>> def verify(cookie, sig): + ... good_sig = sign(cookie) + ... return compare_digest(good_sig, sig) + >>> + >>> cookie = b'user-alice' + >>> sig = sign(cookie) + >>> print("{0},{1}".format(cookie.decode('utf-8'), sig)) + user-alice,b'43b3c982cf697e0c5ab22172d1ca7421' + >>> verify(cookie, sig) + True + >>> verify(b'user-bob', sig) + False + >>> verify(cookie, b'0102030405060708090a0b0c0d0e0f00') + False + +Even though there's a native keyed hashing mode, BLAKE2 can, of course, be used +in HMAC construction with :mod:`hmac` module:: + + >>> import hmac, hashlib + >>> m = hmac.new(b'secret key', digestmod=hashlib.blake2s) + >>> m.update(b'message') + >>> m.hexdigest() + 'e3c8102868d28b5ff85fc35dda07329970d1a01e273c37481326fe0c861c8142' + + +Randomized hashing +"""""""""""""""""" + +By setting *salt* parameter users can introduce randomization to the hash +function. Randomized hashing is useful for protecting against collision attacks +on the hash function used in digital signatures. + + Randomized hashing is designed for situations where one party, the message + preparer, generates all or part of a message to be signed by a second + party, the message signer. If the message preparer is able to find + cryptographic hash function collisions (i.e., two messages producing the + same hash value), then they might prepare meaningful versions of the message + that would produce the same hash value and digital signature, but with + different results (e.g., transferring $1,000,000 to an account, rather than + $10). Cryptographic hash functions have been designed with collision + resistance as a major goal, but the current concentration on attacking + cryptographic hash functions may result in a given cryptographic hash + function providing less collision resistance than expected. Randomized + hashing offers the signer additional protection by reducing the likelihood + that a preparer can generate two or more messages that ultimately yield the + same hash value during the digital signature generation process --- even if + it is practical to find collisions for the hash function. However, the use + of randomized hashing may reduce the amount of security provided by a + digital signature when all portions of the message are prepared + by the signer. + + (`NIST SP-800-106 "Randomized Hashing for Digital Signatures" + `_) + +In BLAKE2 the salt is processed as a one-time input to the hash function during +initialization, rather than as an input to each compression function. + +.. warning:: + + *Salted hashing* (or just hashing) with BLAKE2 or any other general-purpose + cryptographic hash function, such as SHA-256, is not suitable for hashing + passwords. See `BLAKE2 FAQ `_ for more + information. +.. + + >>> import os + >>> from hashlib import blake2b + >>> msg = b'some message' + >>> # Calculate the first hash with a random salt. + >>> salt1 = os.urandom(blake2b.SALT_SIZE) + >>> h1 = blake2b(salt=salt1) + >>> h1.update(msg) + >>> # Calculate the second hash with a different random salt. + >>> salt2 = os.urandom(blake2b.SALT_SIZE) + >>> h2 = blake2b(salt=salt2) + >>> h2.update(msg) + >>> # The digests are different. + >>> h1.digest() != h2.digest() + True + + +Personalization +""""""""""""""" + +Sometimes it is useful to force hash function to produce different digests for +the same input for different purposes. Quoting the authors of the Skein hash +function: + + We recommend that all application designers seriously consider doing this; + we have seen many protocols where a hash that is computed in one part of + the protocol can be used in an entirely different part because two hash + computations were done on similar or related data, and the attacker can + force the application to make the hash inputs the same. Personalizing each + hash function used in the protocol summarily stops this type of attack. + + (`The Skein Hash Function Family + `_, + p. 21) + +BLAKE2 can be personalized by passing bytes to the *person* argument:: + + >>> from hashlib import blake2b + >>> FILES_HASH_PERSON = b'MyApp Files Hash' + >>> BLOCK_HASH_PERSON = b'MyApp Block Hash' + >>> h = blake2b(digest_size=32, person=FILES_HASH_PERSON) + >>> h.update(b'the same content') + >>> h.hexdigest() + '20d9cd024d4fb086aae819a1432dd2466de12947831b75c5a30cf2676095d3b4' + >>> h = blake2b(digest_size=32, person=BLOCK_HASH_PERSON) + >>> h.update(b'the same content') + >>> h.hexdigest() + 'cf68fb5761b9c44e7878bfb2c4c9aea52264a80b75005e65619778de59f383a3' + +Personalization together with the keyed mode can also be used to derive different +keys from a single one. + + >>> from hashlib import blake2s + >>> from base64 import b64decode, b64encode + >>> orig_key = b64decode(b'Rm5EPJai72qcK3RGBpW3vPNfZy5OZothY+kHY6h21KM=') + >>> enc_key = blake2s(key=orig_key, person=b'kEncrypt').digest() + >>> mac_key = blake2s(key=orig_key, person=b'kMAC').digest() + >>> print(b64encode(enc_key).decode('utf-8')) + rbPb15S/Z9t+agffno5wuhB77VbRi6F9Iv2qIxU7WHw= + >>> print(b64encode(mac_key).decode('utf-8')) + G9GtHFE1YluXY1zWPlYk1e/nWfu0WSEb0KRcjhDeP/o= + +Tree mode +""""""""" + +Here's an example of hashing a minimal tree with two leaf nodes:: + + 10 + / \ + 00 01 + +This example uses 64-byte internal digests, and returns the 32-byte final +digest:: + + >>> from hashlib import blake2b + >>> + >>> FANOUT = 2 + >>> DEPTH = 2 + >>> LEAF_SIZE = 4096 + >>> INNER_SIZE = 64 + >>> + >>> buf = bytearray(6000) + >>> + >>> # Left leaf + ... h00 = blake2b(buf[0:LEAF_SIZE], fanout=FANOUT, depth=DEPTH, + ... leaf_size=LEAF_SIZE, inner_size=INNER_SIZE, + ... node_offset=0, node_depth=0, last_node=False) + >>> # Right leaf + ... h01 = blake2b(buf[LEAF_SIZE:], fanout=FANOUT, depth=DEPTH, + ... leaf_size=LEAF_SIZE, inner_size=INNER_SIZE, + ... node_offset=1, node_depth=0, last_node=True) + >>> # Root node + ... h10 = blake2b(digest_size=32, fanout=FANOUT, depth=DEPTH, + ... leaf_size=LEAF_SIZE, inner_size=INNER_SIZE, + ... node_offset=0, node_depth=1, last_node=True) + >>> h10.update(h00.digest()) + >>> h10.update(h01.digest()) + >>> h10.hexdigest() + '3ad2a9b37c6070e374c7a8c508fe20ca86b6ed54e286e93a0318e95e881db5aa' + +Credits +^^^^^^^ + +BLAKE2_ was designed by *Jean-Philippe Aumasson*, *Samuel Neves*, *Zooko +Wilcox-O'Hearn*, and *Christian Winnerlein* based on SHA-3_ finalist BLAKE_ +created by *Jean-Philippe Aumasson*, *Luca Henzen*, *Willi Meier*, and +*Raphael C.-W. Phan*. + +It uses core algorithm from ChaCha_ cipher designed by *Daniel J. Bernstein*. + +The stdlib implementation is based on pyblake2_ module. It was written by +*Dmitry Chestnykh* based on C implementation written by *Samuel Neves*. The +documentation was copied from pyblake2_ and written by *Dmitry Chestnykh*. + +The C code was partly rewritten for Python by *Christian Heimes*. + +The following public domain dedication applies for both C hash function +implementation, extension code, and this documentation: + + To the extent possible under law, the author(s) have dedicated all copyright + and related and neighboring rights to this software to the public domain + worldwide. This software is distributed without any warranty. + + You should have received a copy of the CC0 Public Domain Dedication along + with this software. If not, see + https://creativecommons.org/publicdomain/zero/1.0/. + +The following people have helped with development or contributed their changes +to the project and the public domain according to the Creative Commons Public +Domain Dedication 1.0 Universal: + +* *Alexandr Sokolovskiy* + +.. _BLAKE2: https://blake2.net +.. _HMAC: https://en.wikipedia.org/wiki/Hash-based_message_authentication_code +.. _BLAKE: https://131002.net/blake/ +.. _SHA-3: https://en.wikipedia.org/wiki/NIST_hash_function_competition +.. _ChaCha: https://cr.yp.to/chacha.html +.. _pyblake2: https://pythonhosted.org/pyblake2/ + + + +.. seealso:: + + Module :mod:`hmac` + A module to generate message authentication codes using hashes. + + Module :mod:`base64` + Another way to encode binary hashes for non-binary environments. + + https://blake2.net + Official BLAKE2 website. + + https://csrc.nist.gov/csrc/media/publications/fips/180/2/archive/2002-08-01/documents/fips180-2.pdf + The FIPS 180-2 publication on Secure Hash Algorithms. + + https://en.wikipedia.org/wiki/Cryptographic_hash_function#Cryptographic_hash_algorithms + Wikipedia article with information on which algorithms have known issues and + what that means regarding their use. + + https://www.ietf.org/rfc/rfc2898.txt + PKCS #5: Password-Based Cryptography Specification Version 2.0 diff --git a/python-3.7.4-docs-html/_sources/library/heapq.rst.txt b/python-3.7.4-docs-html/_sources/library/heapq.rst.txt new file mode 100644 index 0000000..8b00f7b --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/heapq.rst.txt @@ -0,0 +1,322 @@ +:mod:`heapq` --- Heap queue algorithm +===================================== + +.. module:: heapq + :synopsis: Heap queue algorithm (a.k.a. priority queue). + +.. moduleauthor:: Kevin O'Connor +.. sectionauthor:: Guido van Rossum +.. sectionauthor:: François Pinard +.. sectionauthor:: Raymond Hettinger + +**Source code:** :source:`Lib/heapq.py` + +-------------- + +This module provides an implementation of the heap queue algorithm, also known +as the priority queue algorithm. + +Heaps are binary trees for which every parent node has a value less than or +equal to any of its children. This implementation uses arrays for which +``heap[k] <= heap[2*k+1]`` and ``heap[k] <= heap[2*k+2]`` for all *k*, counting +elements from zero. For the sake of comparison, non-existing elements are +considered to be infinite. The interesting property of a heap is that its +smallest element is always the root, ``heap[0]``. + +The API below differs from textbook heap algorithms in two aspects: (a) We use +zero-based indexing. This makes the relationship between the index for a node +and the indexes for its children slightly less obvious, but is more suitable +since Python uses zero-based indexing. (b) Our pop method returns the smallest +item, not the largest (called a "min heap" in textbooks; a "max heap" is more +common in texts because of its suitability for in-place sorting). + +These two make it possible to view the heap as a regular Python list without +surprises: ``heap[0]`` is the smallest item, and ``heap.sort()`` maintains the +heap invariant! + +To create a heap, use a list initialized to ``[]``, or you can transform a +populated list into a heap via function :func:`heapify`. + +The following functions are provided: + + +.. function:: heappush(heap, item) + + Push the value *item* onto the *heap*, maintaining the heap invariant. + + +.. function:: heappop(heap) + + Pop and return the smallest item from the *heap*, maintaining the heap + invariant. If the heap is empty, :exc:`IndexError` is raised. To access the + smallest item without popping it, use ``heap[0]``. + + +.. function:: heappushpop(heap, item) + + Push *item* on the heap, then pop and return the smallest item from the + *heap*. The combined action runs more efficiently than :func:`heappush` + followed by a separate call to :func:`heappop`. + + +.. function:: heapify(x) + + Transform list *x* into a heap, in-place, in linear time. + + +.. function:: heapreplace(heap, item) + + Pop and return the smallest item from the *heap*, and also push the new *item*. + The heap size doesn't change. If the heap is empty, :exc:`IndexError` is raised. + + This one step operation is more efficient than a :func:`heappop` followed by + :func:`heappush` and can be more appropriate when using a fixed-size heap. + The pop/push combination always returns an element from the heap and replaces + it with *item*. + + The value returned may be larger than the *item* added. If that isn't + desired, consider using :func:`heappushpop` instead. Its push/pop + combination returns the smaller of the two values, leaving the larger value + on the heap. + + +The module also offers three general purpose functions based on heaps. + + +.. function:: merge(*iterables, key=None, reverse=False) + + Merge multiple sorted inputs into a single sorted output (for example, merge + timestamped entries from multiple log files). Returns an :term:`iterator` + over the sorted values. + + Similar to ``sorted(itertools.chain(*iterables))`` but returns an iterable, does + not pull the data into memory all at once, and assumes that each of the input + streams is already sorted (smallest to largest). + + Has two optional arguments which must be specified as keyword arguments. + + *key* specifies a :term:`key function` of one argument that is used to + extract a comparison key from each input element. The default value is + ``None`` (compare the elements directly). + + *reverse* is a boolean value. If set to ``True``, then the input elements + are merged as if each comparison were reversed. To achieve behavior similar + to ``sorted(itertools.chain(*iterables), reverse=True)``, all iterables must + be sorted from largest to smallest. + + .. versionchanged:: 3.5 + Added the optional *key* and *reverse* parameters. + + +.. function:: nlargest(n, iterable, key=None) + + Return a list with the *n* largest elements from the dataset defined by + *iterable*. *key*, if provided, specifies a function of one argument that is + used to extract a comparison key from each element in *iterable* (for example, + ``key=str.lower``). Equivalent to: ``sorted(iterable, key=key, + reverse=True)[:n]``. + + +.. function:: nsmallest(n, iterable, key=None) + + Return a list with the *n* smallest elements from the dataset defined by + *iterable*. *key*, if provided, specifies a function of one argument that is + used to extract a comparison key from each element in *iterable* (for example, + ``key=str.lower``). Equivalent to: ``sorted(iterable, key=key)[:n]``. + + +The latter two functions perform best for smaller values of *n*. For larger +values, it is more efficient to use the :func:`sorted` function. Also, when +``n==1``, it is more efficient to use the built-in :func:`min` and :func:`max` +functions. If repeated usage of these functions is required, consider turning +the iterable into an actual heap. + + +Basic Examples +-------------- + +A `heapsort `_ can be implemented by +pushing all values onto a heap and then popping off the smallest values one at a +time:: + + >>> def heapsort(iterable): + ... h = [] + ... for value in iterable: + ... heappush(h, value) + ... return [heappop(h) for i in range(len(h))] + ... + >>> heapsort([1, 3, 5, 7, 9, 2, 4, 6, 8, 0]) + [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] + +This is similar to ``sorted(iterable)``, but unlike :func:`sorted`, this +implementation is not stable. + +Heap elements can be tuples. This is useful for assigning comparison values +(such as task priorities) alongside the main record being tracked:: + + >>> h = [] + >>> heappush(h, (5, 'write code')) + >>> heappush(h, (7, 'release product')) + >>> heappush(h, (1, 'write spec')) + >>> heappush(h, (3, 'create tests')) + >>> heappop(h) + (1, 'write spec') + + +Priority Queue Implementation Notes +----------------------------------- + +A `priority queue `_ is common use +for a heap, and it presents several implementation challenges: + +* Sort stability: how do you get two tasks with equal priorities to be returned + in the order they were originally added? + +* Tuple comparison breaks for (priority, task) pairs if the priorities are equal + and the tasks do not have a default comparison order. + +* If the priority of a task changes, how do you move it to a new position in + the heap? + +* Or if a pending task needs to be deleted, how do you find it and remove it + from the queue? + +A solution to the first two challenges is to store entries as 3-element list +including the priority, an entry count, and the task. The entry count serves as +a tie-breaker so that two tasks with the same priority are returned in the order +they were added. And since no two entry counts are the same, the tuple +comparison will never attempt to directly compare two tasks. + +Another solution to the problem of non-comparable tasks is to create a wrapper +class that ignores the task item and only compares the priority field:: + + from dataclasses import dataclass, field + from typing import Any + + @dataclass(order=True) + class PrioritizedItem: + priority: int + item: Any=field(compare=False) + +The remaining challenges revolve around finding a pending task and making +changes to its priority or removing it entirely. Finding a task can be done +with a dictionary pointing to an entry in the queue. + +Removing the entry or changing its priority is more difficult because it would +break the heap structure invariants. So, a possible solution is to mark the +entry as removed and add a new entry with the revised priority:: + + pq = [] # list of entries arranged in a heap + entry_finder = {} # mapping of tasks to entries + REMOVED = '' # placeholder for a removed task + counter = itertools.count() # unique sequence count + + def add_task(task, priority=0): + 'Add a new task or update the priority of an existing task' + if task in entry_finder: + remove_task(task) + count = next(counter) + entry = [priority, count, task] + entry_finder[task] = entry + heappush(pq, entry) + + def remove_task(task): + 'Mark an existing task as REMOVED. Raise KeyError if not found.' + entry = entry_finder.pop(task) + entry[-1] = REMOVED + + def pop_task(): + 'Remove and return the lowest priority task. Raise KeyError if empty.' + while pq: + priority, count, task = heappop(pq) + if task is not REMOVED: + del entry_finder[task] + return task + raise KeyError('pop from an empty priority queue') + + +Theory +------ + +Heaps are arrays for which ``a[k] <= a[2*k+1]`` and ``a[k] <= a[2*k+2]`` for all +*k*, counting elements from 0. For the sake of comparison, non-existing +elements are considered to be infinite. The interesting property of a heap is +that ``a[0]`` is always its smallest element. + +The strange invariant above is meant to be an efficient memory representation +for a tournament. The numbers below are *k*, not ``a[k]``:: + + 0 + + 1 2 + + 3 4 5 6 + + 7 8 9 10 11 12 13 14 + + 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 + +In the tree above, each cell *k* is topping ``2*k+1`` and ``2*k+2``. In a usual +binary tournament we see in sports, each cell is the winner over the two cells +it tops, and we can trace the winner down the tree to see all opponents s/he +had. However, in many computer applications of such tournaments, we do not need +to trace the history of a winner. To be more memory efficient, when a winner is +promoted, we try to replace it by something else at a lower level, and the rule +becomes that a cell and the two cells it tops contain three different items, but +the top cell "wins" over the two topped cells. + +If this heap invariant is protected at all time, index 0 is clearly the overall +winner. The simplest algorithmic way to remove it and find the "next" winner is +to move some loser (let's say cell 30 in the diagram above) into the 0 position, +and then percolate this new 0 down the tree, exchanging values, until the +invariant is re-established. This is clearly logarithmic on the total number of +items in the tree. By iterating over all items, you get an O(n log n) sort. + +A nice feature of this sort is that you can efficiently insert new items while +the sort is going on, provided that the inserted items are not "better" than the +last 0'th element you extracted. This is especially useful in simulation +contexts, where the tree holds all incoming events, and the "win" condition +means the smallest scheduled time. When an event schedules other events for +execution, they are scheduled into the future, so they can easily go into the +heap. So, a heap is a good structure for implementing schedulers (this is what +I used for my MIDI sequencer :-). + +Various structures for implementing schedulers have been extensively studied, +and heaps are good for this, as they are reasonably speedy, the speed is almost +constant, and the worst case is not much different than the average case. +However, there are other representations which are more efficient overall, yet +the worst cases might be terrible. + +Heaps are also very useful in big disk sorts. You most probably all know that a +big sort implies producing "runs" (which are pre-sorted sequences, whose size is +usually related to the amount of CPU memory), followed by a merging passes for +these runs, which merging is often very cleverly organised [#]_. It is very +important that the initial sort produces the longest runs possible. Tournaments +are a good way to achieve that. If, using all the memory available to hold a +tournament, you replace and percolate items that happen to fit the current run, +you'll produce runs which are twice the size of the memory for random input, and +much better for input fuzzily ordered. + +Moreover, if you output the 0'th item on disk and get an input which may not fit +in the current tournament (because the value "wins" over the last output value), +it cannot fit in the heap, so the size of the heap decreases. The freed memory +could be cleverly reused immediately for progressively building a second heap, +which grows at exactly the same rate the first heap is melting. When the first +heap completely vanishes, you switch heaps and start a new run. Clever and +quite effective! + +In a word, heaps are useful memory structures to know. I use them in a few +applications, and I think it is good to keep a 'heap' module around. :-) + +.. rubric:: Footnotes + +.. [#] The disk balancing algorithms which are current, nowadays, are more annoying + than clever, and this is a consequence of the seeking capabilities of the disks. + On devices which cannot seek, like big tape drives, the story was quite + different, and one had to be very clever to ensure (far in advance) that each + tape movement will be the most effective possible (that is, will best + participate at "progressing" the merge). Some tapes were even able to read + backwards, and this was also used to avoid the rewinding time. Believe me, real + good tape sorts were quite spectacular to watch! From all times, sorting has + always been a Great Art! :-) + diff --git a/python-3.7.4-docs-html/_sources/library/hmac.rst.txt b/python-3.7.4-docs-html/_sources/library/hmac.rst.txt new file mode 100644 index 0000000..731624b --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/hmac.rst.txt @@ -0,0 +1,138 @@ +:mod:`hmac` --- Keyed-Hashing for Message Authentication +======================================================== + +.. module:: hmac + :synopsis: Keyed-Hashing for Message Authentication (HMAC) implementation + +.. moduleauthor:: Gerhard Häring +.. sectionauthor:: Gerhard Häring + +**Source code:** :source:`Lib/hmac.py` + +-------------- + +This module implements the HMAC algorithm as described by :rfc:`2104`. + + +.. function:: new(key, msg=None, digestmod=None) + + Return a new hmac object. *key* is a bytes or bytearray object giving the + secret key. If *msg* is present, the method call ``update(msg)`` is made. + *digestmod* is the digest name, digest constructor or module for the HMAC + object to use. It supports any name suitable to :func:`hashlib.new` and + defaults to the :data:`hashlib.md5` constructor. + + .. versionchanged:: 3.4 + Parameter *key* can be a bytes or bytearray object. + Parameter *msg* can be of any type supported by :mod:`hashlib`. + Parameter *digestmod* can be the name of a hash algorithm. + + .. deprecated-removed:: 3.4 3.8 + MD5 as implicit default digest for *digestmod* is deprecated. + + +.. function:: digest(key, msg, digest) + + Return digest of *msg* for given secret *key* and *digest*. The + function is equivalent to ``HMAC(key, msg, digest).digest()``, but + uses an optimized C or inline implementation, which is faster for messages + that fit into memory. The parameters *key*, *msg*, and *digest* have + the same meaning as in :func:`~hmac.new`. + + CPython implementation detail, the optimized C implementation is only used + when *digest* is a string and name of a digest algorithm, which is + supported by OpenSSL. + + .. versionadded:: 3.7 + + +An HMAC object has the following methods: + +.. method:: HMAC.update(msg) + + Update the hmac object with *msg*. Repeated calls are equivalent to a + single call with the concatenation of all the arguments: + ``m.update(a); m.update(b)`` is equivalent to ``m.update(a + b)``. + + .. versionchanged:: 3.4 + Parameter *msg* can be of any type supported by :mod:`hashlib`. + + +.. method:: HMAC.digest() + + Return the digest of the bytes passed to the :meth:`update` method so far. + This bytes object will be the same length as the *digest_size* of the digest + given to the constructor. It may contain non-ASCII bytes, including NUL + bytes. + + .. warning:: + + When comparing the output of :meth:`digest` to an externally-supplied + digest during a verification routine, it is recommended to use the + :func:`compare_digest` function instead of the ``==`` operator + to reduce the vulnerability to timing attacks. + + +.. method:: HMAC.hexdigest() + + Like :meth:`digest` except the digest is returned as a string twice the + length containing only hexadecimal digits. This may be used to exchange the + value safely in email or other non-binary environments. + + .. warning:: + + When comparing the output of :meth:`hexdigest` to an externally-supplied + digest during a verification routine, it is recommended to use the + :func:`compare_digest` function instead of the ``==`` operator + to reduce the vulnerability to timing attacks. + + +.. method:: HMAC.copy() + + Return a copy ("clone") of the hmac object. This can be used to efficiently + compute the digests of strings that share a common initial substring. + + +A hash object has the following attributes: + +.. attribute:: HMAC.digest_size + + The size of the resulting HMAC digest in bytes. + +.. attribute:: HMAC.block_size + + The internal block size of the hash algorithm in bytes. + + .. versionadded:: 3.4 + +.. attribute:: HMAC.name + + The canonical name of this HMAC, always lowercase, e.g. ``hmac-md5``. + + .. versionadded:: 3.4 + + +This module also provides the following helper function: + +.. function:: compare_digest(a, b) + + Return ``a == b``. This function uses an approach designed to prevent + timing analysis by avoiding content-based short circuiting behaviour, + making it appropriate for cryptography. *a* and *b* must both be of the + same type: either :class:`str` (ASCII only, as e.g. returned by + :meth:`HMAC.hexdigest`), or a :term:`bytes-like object`. + + .. note:: + + If *a* and *b* are of different lengths, or if an error occurs, + a timing attack could theoretically reveal information about the + types and lengths of *a* and *b*—but not their values. + + + .. versionadded:: 3.3 + + +.. seealso:: + + Module :mod:`hashlib` + The Python module providing secure hash functions. diff --git a/python-3.7.4-docs-html/_sources/library/html.entities.rst.txt b/python-3.7.4-docs-html/_sources/library/html.entities.rst.txt new file mode 100644 index 0000000..067e1b1 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/html.entities.rst.txt @@ -0,0 +1,47 @@ +:mod:`html.entities` --- Definitions of HTML general entities +============================================================= + +.. module:: html.entities + :synopsis: Definitions of HTML general entities. + +.. sectionauthor:: Fred L. Drake, Jr. + +**Source code:** :source:`Lib/html/entities.py` + +-------------- + +This module defines four dictionaries, :data:`html5`, +:data:`name2codepoint`, :data:`codepoint2name`, and :data:`entitydefs`. + + +.. data:: html5 + + A dictionary that maps HTML5 named character references [#]_ to the + equivalent Unicode character(s), e.g. ``html5['gt;'] == '>'``. + Note that the trailing semicolon is included in the name (e.g. ``'gt;'``), + however some of the names are accepted by the standard even without the + semicolon: in this case the name is present with and without the ``';'``. + See also :func:`html.unescape`. + + .. versionadded:: 3.3 + + +.. data:: entitydefs + + A dictionary mapping XHTML 1.0 entity definitions to their replacement text in + ISO Latin-1. + + +.. data:: name2codepoint + + A dictionary that maps HTML entity names to the Unicode code points. + + +.. data:: codepoint2name + + A dictionary that maps Unicode code points to HTML entity names. + + +.. rubric:: Footnotes + +.. [#] See https://www.w3.org/TR/html5/syntax.html#named-character-references diff --git a/python-3.7.4-docs-html/_sources/library/html.parser.rst.txt b/python-3.7.4-docs-html/_sources/library/html.parser.rst.txt new file mode 100644 index 0000000..ac844a6 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/html.parser.rst.txt @@ -0,0 +1,340 @@ +:mod:`html.parser` --- Simple HTML and XHTML parser +=================================================== + +.. module:: html.parser + :synopsis: A simple parser that can handle HTML and XHTML. + +**Source code:** :source:`Lib/html/parser.py` + +.. index:: + single: HTML + single: XHTML + +-------------- + +This module defines a class :class:`HTMLParser` which serves as the basis for +parsing text files formatted in HTML (HyperText Mark-up Language) and XHTML. + +.. class:: HTMLParser(*, convert_charrefs=True) + + Create a parser instance able to parse invalid markup. + + If *convert_charrefs* is ``True`` (the default), all character + references (except the ones in ``script``/``style`` elements) are + automatically converted to the corresponding Unicode characters. + + An :class:`.HTMLParser` instance is fed HTML data and calls handler methods + when start tags, end tags, text, comments, and other markup elements are + encountered. The user should subclass :class:`.HTMLParser` and override its + methods to implement the desired behavior. + + This parser does not check that end tags match start tags or call the end-tag + handler for elements which are closed implicitly by closing an outer element. + + .. versionchanged:: 3.4 + *convert_charrefs* keyword argument added. + + .. versionchanged:: 3.5 + The default value for argument *convert_charrefs* is now ``True``. + + +Example HTML Parser Application +------------------------------- + +As a basic example, below is a simple HTML parser that uses the +:class:`HTMLParser` class to print out start tags, end tags, and data +as they are encountered:: + + from html.parser import HTMLParser + + 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) + + parser = MyHTMLParser() + parser.feed('Test' + '

    Parse me!

    ') + +The output will then be: + +.. code-block:: none + + Encountered a start tag: html + Encountered a start tag: head + Encountered a start tag: title + Encountered some data : Test + Encountered an end tag : title + Encountered an end tag : head + Encountered a start tag: body + Encountered a start tag: h1 + Encountered some data : Parse me! + Encountered an end tag : h1 + Encountered an end tag : body + Encountered an end tag : html + + +:class:`.HTMLParser` Methods +---------------------------- + +:class:`HTMLParser` instances have the following methods: + + +.. method:: HTMLParser.feed(data) + + Feed some text to the parser. It is processed insofar as it consists of + complete elements; incomplete data is buffered until more data is fed or + :meth:`close` is called. *data* must be :class:`str`. + + +.. method:: HTMLParser.close() + + Force processing of all buffered data as if it were followed by an end-of-file + mark. This method may be redefined by a derived class to define additional + processing at the end of the input, but the redefined version should always call + the :class:`HTMLParser` base class method :meth:`close`. + + +.. method:: HTMLParser.reset() + + Reset the instance. Loses all unprocessed data. This is called implicitly at + instantiation time. + + +.. method:: HTMLParser.getpos() + + Return current line number and offset. + + +.. method:: HTMLParser.get_starttag_text() + + Return the text of the most recently opened start tag. This should not normally + be needed for structured processing, but may be useful in dealing with HTML "as + deployed" or for re-generating input with minimal changes (whitespace between + attributes can be preserved, etc.). + + +The following methods are called when data or markup elements are encountered +and they are meant to be overridden in a subclass. The base class +implementations do nothing (except for :meth:`~HTMLParser.handle_startendtag`): + + +.. method:: HTMLParser.handle_starttag(tag, attrs) + + This method is called to handle the start of a tag (e.g. ``
    ``). + + The *tag* argument is the name of the tag converted to lower case. + + +.. method:: HTMLParser.handle_startendtag(tag, attrs) + + Similar to :meth:`handle_starttag`, but called when the parser encounters an + XHTML-style empty tag (````). This method may be overridden by + subclasses which require this particular lexical information; the default + implementation simply calls :meth:`handle_starttag` and :meth:`handle_endtag`. + + +.. method:: HTMLParser.handle_data(data) + + This method is called to process arbitrary data (e.g. text nodes and the + content of ```` and ````). + + +.. method:: HTMLParser.handle_entityref(name) + + This method is called to process a named character reference of the form + ``&name;`` (e.g. ``>``), where *name* is a general entity reference + (e.g. ``'gt'``). This method is never called if *convert_charrefs* is + ``True``. + + +.. method:: HTMLParser.handle_charref(name) + + This method is called to process decimal and hexadecimal numeric character + references of the form ``&#NNN;`` and ``&#xNNN;``. For example, the decimal + equivalent for ``>`` is ``>``, whereas the hexadecimal is ``>``; + in this case the method will receive ``'62'`` or ``'x3E'``. This method + is never called if *convert_charrefs* is ``True``. + + +.. method:: HTMLParser.handle_comment(data) + + This method is called when a comment is encountered (e.g. ````). + + For example, the comment ```` will cause this method to be + called with the argument ``' comment '``. + + The content of Internet Explorer conditional comments (condcoms) will also be + sent to this method, so, for ````, + this method will receive ``'[if IE 9]>IE9-specific content``). + + The *decl* parameter will be the entire contents of the declaration inside + the ```` markup (e.g. ``'DOCTYPE html'``). + + +.. method:: HTMLParser.handle_pi(data) + + Method called when a processing instruction is encountered. The *data* + parameter will contain the entire processing instruction. For example, for the + processing instruction ````, this method would be called as + ``handle_pi("proc color='red'")``. It is intended to be overridden by a derived + class; the base class implementation does nothing. + + .. note:: + + The :class:`HTMLParser` class uses the SGML syntactic rules for processing + instructions. An XHTML processing instruction using the trailing ``'?'`` will + cause the ``'?'`` to be included in *data*. + + +.. method:: HTMLParser.unknown_decl(data) + + This method is called when an unrecognized declaration is read by the parser. + + The *data* parameter will be the entire contents of the declaration inside + the ```` markup. It is sometimes useful to be overridden by a + derived class. The base class implementation does nothing. + + +.. _htmlparser-examples: + +Examples +-------- + +The following class implements a parser that will be used to illustrate more +examples:: + + from html.parser import HTMLParser + from html.entities import name2codepoint + + class MyHTMLParser(HTMLParser): + def handle_starttag(self, tag, attrs): + 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) + + parser = MyHTMLParser() + +Parsing a doctype:: + + >>> parser.feed('') + Decl : DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd" + +Parsing an element with a few attributes and a title:: + + >>> parser.feed('The Python logo') + Start tag: img + attr: ('src', 'python-logo.png') + attr: ('alt', 'The Python logo') + >>> + >>> parser.feed('

    Python

    ') + Start tag: h1 + Data : Python + End tag : h1 + +The content of ``script`` and ``style`` elements is returned as is, without +further parsing:: + + >>> parser.feed('') + Start tag: style + attr: ('type', 'text/css') + Data : #python { color: green } + End tag : style + + >>> parser.feed('') + Start tag: script + attr: ('type', 'text/javascript') + Data : alert("hello!"); + End tag : script + +Parsing comments:: + + >>> parser.feed('' + ... '') + Comment : a comment + Comment : [if IE 9]>IE-specific content'``):: + + >>> parser.feed('>>>') + Named ent: > + Num ent : > + Num ent : > + +Feeding incomplete chunks to :meth:`~HTMLParser.feed` works, but +:meth:`~HTMLParser.handle_data` might be called more than once +(unless *convert_charrefs* is set to ``True``):: + + >>> for chunk in ['buff', 'ered ', 'text']: + ... parser.feed(chunk) + ... + Start tag: span + Data : buff + Data : ered + Data : text + End tag : span + +Parsing invalid HTML (e.g. unquoted attributes) also works:: + + >>> parser.feed('

    tag soup

    ') + Start tag: p + Start tag: a + attr: ('class', 'link') + attr: ('href', '#main') + Data : tag soup + End tag : p + End tag : a diff --git a/python-3.7.4-docs-html/_sources/library/html.rst.txt b/python-3.7.4-docs-html/_sources/library/html.rst.txt new file mode 100644 index 0000000..c2b01e1 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/html.rst.txt @@ -0,0 +1,39 @@ +:mod:`html` --- HyperText Markup Language support +================================================= + +.. module:: html + :synopsis: Helpers for manipulating HTML. + +**Source code:** :source:`Lib/html/__init__.py` + +-------------- + +This module defines utilities to manipulate HTML. + +.. function:: escape(s, quote=True) + + Convert the characters ``&``, ``<`` and ``>`` in string *s* to HTML-safe + sequences. Use this if you need to display text that might contain such + characters in HTML. If the optional flag *quote* is true, the characters + (``"``) and (``'``) are also translated; this helps for inclusion in an HTML + attribute value delimited by quotes, as in ````. + + .. versionadded:: 3.2 + + +.. function:: unescape(s) + + Convert all named and numeric character references (e.g. ``>``, + ``>``, ``>``) in the string *s* to the corresponding Unicode + characters. This function uses the rules defined by the HTML 5 standard + for both valid and invalid character references, and the :data:`list of + HTML 5 named character references `. + + .. versionadded:: 3.4 + +-------------- + +Submodules in the ``html`` package are: + +* :mod:`html.parser` -- HTML/XHTML parser with lenient parsing mode +* :mod:`html.entities` -- HTML entity definitions diff --git a/python-3.7.4-docs-html/_sources/library/http.client.rst.txt b/python-3.7.4-docs-html/_sources/library/http.client.rst.txt new file mode 100644 index 0000000..3ebeb10 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/http.client.rst.txt @@ -0,0 +1,571 @@ +:mod:`http.client` --- HTTP protocol client +=========================================== + +.. module:: http.client + :synopsis: HTTP and HTTPS protocol client (requires sockets). + +**Source code:** :source:`Lib/http/client.py` + +.. index:: + pair: HTTP; protocol + single: HTTP; http.client (standard module) + +.. index:: module: urllib.request + +-------------- + +This module defines classes which implement the client side of the HTTP and +HTTPS protocols. It is normally not used directly --- the module +:mod:`urllib.request` uses it to handle URLs that use HTTP and HTTPS. + +.. seealso:: + + The `Requests package `_ + is recommended for a higher-level HTTP client interface. + +.. note:: + + HTTPS support is only available if Python was compiled with SSL support + (through the :mod:`ssl` module). + +The module provides the following classes: + + +.. class:: HTTPConnection(host, port=None[, timeout], source_address=None, \ + blocksize=8192) + + An :class:`HTTPConnection` instance represents one transaction with an HTTP + server. It should be instantiated passing it a host and optional port + number. If no port number is passed, the port is extracted from the host + string if it has the form ``host:port``, else the default HTTP port (80) is + used. If the optional *timeout* parameter is given, blocking + operations (like connection attempts) will timeout after that many seconds + (if it is not given, the global default timeout setting is used). + The optional *source_address* parameter may be a tuple of a (host, port) + to use as the source address the HTTP connection is made from. + The optional *blocksize* parameter sets the buffer size in bytes for + sending a file-like message body. + + For example, the following calls all create instances that connect to the server + at the same host and port:: + + >>> h1 = http.client.HTTPConnection('www.python.org') + >>> h2 = http.client.HTTPConnection('www.python.org:80') + >>> h3 = http.client.HTTPConnection('www.python.org', 80) + >>> h4 = http.client.HTTPConnection('www.python.org', 80, timeout=10) + + .. versionchanged:: 3.2 + *source_address* was added. + + .. versionchanged:: 3.4 + The *strict* parameter was removed. HTTP 0.9-style "Simple Responses" are + not longer supported. + + .. versionchanged:: 3.7 + *blocksize* parameter was added. + + +.. class:: HTTPSConnection(host, port=None, key_file=None, \ + cert_file=None[, timeout], \ + source_address=None, *, context=None, \ + check_hostname=None, blocksize=8192) + + A subclass of :class:`HTTPConnection` that uses SSL for communication with + secure servers. Default port is ``443``. If *context* is specified, it + must be a :class:`ssl.SSLContext` instance describing the various SSL + options. + + Please read :ref:`ssl-security` for more information on best practices. + + .. versionchanged:: 3.2 + *source_address*, *context* and *check_hostname* were added. + + .. versionchanged:: 3.2 + This class now supports HTTPS virtual hosts if possible (that is, + if :data:`ssl.HAS_SNI` is true). + + .. versionchanged:: 3.4 + The *strict* parameter was removed. HTTP 0.9-style "Simple Responses" are + no longer supported. + + .. versionchanged:: 3.4.3 + This class now performs all the necessary certificate and hostname checks + by default. To revert to the previous, unverified, behavior + :func:`ssl._create_unverified_context` can be passed to the *context* + parameter. + + .. versionchanged:: 3.7.4 + This class now enables TLS 1.3 + :attr:`ssl.SSLContext.post_handshake_auth` for the default *context* or + when *cert_file* is passed with a custom *context*. + + .. deprecated:: 3.6 + + *key_file* and *cert_file* are deprecated in favor of *context*. + Please use :meth:`ssl.SSLContext.load_cert_chain` instead, or let + :func:`ssl.create_default_context` select the system's trusted CA + certificates for you. + + The *check_hostname* parameter is also deprecated; the + :attr:`ssl.SSLContext.check_hostname` attribute of *context* should + be used instead. + + +.. class:: HTTPResponse(sock, debuglevel=0, method=None, url=None) + + Class whose instances are returned upon successful connection. Not + instantiated directly by user. + + .. versionchanged:: 3.4 + The *strict* parameter was removed. HTTP 0.9 style "Simple Responses" are + no longer supported. + + +The following exceptions are raised as appropriate: + + +.. exception:: HTTPException + + The base class of the other exceptions in this module. It is a subclass of + :exc:`Exception`. + + +.. exception:: NotConnected + + A subclass of :exc:`HTTPException`. + + +.. exception:: InvalidURL + + A subclass of :exc:`HTTPException`, raised if a port is given and is either + non-numeric or empty. + + +.. exception:: UnknownProtocol + + A subclass of :exc:`HTTPException`. + + +.. exception:: UnknownTransferEncoding + + A subclass of :exc:`HTTPException`. + + +.. exception:: UnimplementedFileMode + + A subclass of :exc:`HTTPException`. + + +.. exception:: IncompleteRead + + A subclass of :exc:`HTTPException`. + + +.. exception:: ImproperConnectionState + + A subclass of :exc:`HTTPException`. + + +.. exception:: CannotSendRequest + + A subclass of :exc:`ImproperConnectionState`. + + +.. exception:: CannotSendHeader + + A subclass of :exc:`ImproperConnectionState`. + + +.. exception:: ResponseNotReady + + A subclass of :exc:`ImproperConnectionState`. + + +.. exception:: BadStatusLine + + A subclass of :exc:`HTTPException`. Raised if a server responds with a HTTP + status code that we don't understand. + + +.. exception:: LineTooLong + + A subclass of :exc:`HTTPException`. Raised if an excessively long line + is received in the HTTP protocol from the server. + + +.. exception:: RemoteDisconnected + + A subclass of :exc:`ConnectionResetError` and :exc:`BadStatusLine`. Raised + by :meth:`HTTPConnection.getresponse` when the attempt to read the response + results in no data read from the connection, indicating that the remote end + has closed the connection. + + .. versionadded:: 3.5 + Previously, :exc:`BadStatusLine`\ ``('')`` was raised. + + +The constants defined in this module are: + +.. data:: HTTP_PORT + + The default port for the HTTP protocol (always ``80``). + +.. data:: HTTPS_PORT + + The default port for the HTTPS protocol (always ``443``). + +.. data:: responses + + This dictionary maps the HTTP 1.1 status codes to the W3C names. + + Example: ``http.client.responses[http.client.NOT_FOUND]`` is ``'Not Found'``. + +See :ref:`http-status-codes` for a list of HTTP status codes that are +available in this module as constants. + + +.. _httpconnection-objects: + +HTTPConnection Objects +---------------------- + +:class:`HTTPConnection` instances have the following methods: + + +.. method:: HTTPConnection.request(method, url, body=None, headers={}, *, \ + encode_chunked=False) + + This will send a request to the server using the HTTP request + method *method* and the selector *url*. + + If *body* is specified, the specified data is sent after the headers are + finished. It may be a :class:`str`, a :term:`bytes-like object`, an + open :term:`file object`, or an iterable of :class:`bytes`. If *body* + is a string, it is encoded as ISO-8859-1, the default for HTTP. If it + is a bytes-like object, the bytes are sent as is. If it is a :term:`file + object`, the contents of the file is sent; this file object should + support at least the ``read()`` method. If the file object is an + instance of :class:`io.TextIOBase`, the data returned by the ``read()`` + method will be encoded as ISO-8859-1, otherwise the data returned by + ``read()`` is sent as is. If *body* is an iterable, the elements of the + iterable are sent as is until the iterable is exhausted. + + The *headers* argument should be a mapping of extra HTTP headers to send + with the request. + + If *headers* contains neither Content-Length nor Transfer-Encoding, + but there is a request body, one of those + header fields will be added automatically. If + *body* is ``None``, the Content-Length header is set to ``0`` for + methods that expect a body (``PUT``, ``POST``, and ``PATCH``). If + *body* is a string or a bytes-like object that is not also a + :term:`file `, the Content-Length header is + set to its length. Any other type of *body* (files + and iterables in general) will be chunk-encoded, and the + Transfer-Encoding header will automatically be set instead of + Content-Length. + + The *encode_chunked* argument is only relevant if Transfer-Encoding is + specified in *headers*. If *encode_chunked* is ``False``, the + HTTPConnection object assumes that all encoding is handled by the + calling code. If it is ``True``, the body will be chunk-encoded. + + .. note:: + Chunked transfer encoding has been added to the HTTP protocol + version 1.1. Unless the HTTP server is known to handle HTTP 1.1, + the caller must either specify the Content-Length, or must pass a + :class:`str` or bytes-like object that is not also a file as the + body representation. + + .. versionadded:: 3.2 + *body* can now be an iterable. + + .. versionchanged:: 3.6 + If neither Content-Length nor Transfer-Encoding are set in + *headers*, file and iterable *body* objects are now chunk-encoded. + The *encode_chunked* argument was added. + No attempt is made to determine the Content-Length for file + objects. + +.. method:: HTTPConnection.getresponse() + + Should be called after a request is sent to get the response from the server. + Returns an :class:`HTTPResponse` instance. + + .. note:: + + Note that you must have read the whole response before you can send a new + request to the server. + + .. versionchanged:: 3.5 + If a :exc:`ConnectionError` or subclass is raised, the + :class:`HTTPConnection` object will be ready to reconnect when + a new request is sent. + + +.. method:: HTTPConnection.set_debuglevel(level) + + Set the debugging level. The default debug level is ``0``, meaning no + debugging output is printed. Any value greater than ``0`` will cause all + currently defined debug output to be printed to stdout. The ``debuglevel`` + is passed to any new :class:`HTTPResponse` objects that are created. + + .. versionadded:: 3.1 + + +.. method:: HTTPConnection.set_tunnel(host, port=None, headers=None) + + Set the host and the port for HTTP Connect Tunnelling. This allows running + the connection through a proxy server. + + The host and port arguments specify the endpoint of the tunneled connection + (i.e. the address included in the CONNECT request, *not* the address of the + proxy server). + + The headers argument should be a mapping of extra HTTP headers to send with + the CONNECT request. + + For example, to tunnel through a HTTPS proxy server running locally on port + 8080, we would pass the address of the proxy to the :class:`HTTPSConnection` + constructor, and the address of the host that we eventually want to reach to + the :meth:`~HTTPConnection.set_tunnel` method:: + + >>> import http.client + >>> conn = http.client.HTTPSConnection("localhost", 8080) + >>> conn.set_tunnel("www.python.org") + >>> conn.request("HEAD","/index.html") + + .. versionadded:: 3.2 + + +.. method:: HTTPConnection.connect() + + Connect to the server specified when the object was created. By default, + this is called automatically when making a request if the client does not + already have a connection. + + +.. method:: HTTPConnection.close() + + Close the connection to the server. + + +.. attribute:: HTTPConnection.blocksize + + Buffer size in bytes for sending a file-like message body. + + .. versionadded:: 3.7 + + +As an alternative to using the :meth:`request` method described above, you can +also send your request step by step, by using the four functions below. + + +.. method:: HTTPConnection.putrequest(method, url, skip_host=False, \ + skip_accept_encoding=False) + + This should be the first call after the connection to the server has been + made. It sends a line to the server consisting of the *method* string, + the *url* string, and the HTTP version (``HTTP/1.1``). To disable automatic + sending of ``Host:`` or ``Accept-Encoding:`` headers (for example to accept + additional content encodings), specify *skip_host* or *skip_accept_encoding* + with non-False values. + + +.. method:: HTTPConnection.putheader(header, argument[, ...]) + + Send an :rfc:`822`\ -style header to the server. It sends a line to the server + consisting of the header, a colon and a space, and the first argument. If more + arguments are given, continuation lines are sent, each consisting of a tab and + an argument. + + +.. method:: HTTPConnection.endheaders(message_body=None, *, encode_chunked=False) + + Send a blank line to the server, signalling the end of the headers. The + optional *message_body* argument can be used to pass a message body + associated with the request. + + If *encode_chunked* is ``True``, the result of each iteration of + *message_body* will be chunk-encoded as specified in :rfc:`7230`, + Section 3.3.1. How the data is encoded is dependent on the type of + *message_body*. If *message_body* implements the :ref:`buffer interface + ` the encoding will result in a single chunk. + If *message_body* is a :class:`collections.abc.Iterable`, each iteration + of *message_body* will result in a chunk. If *message_body* is a + :term:`file object`, each call to ``.read()`` will result in a chunk. + The method automatically signals the end of the chunk-encoded data + immediately after *message_body*. + + .. note:: Due to the chunked encoding specification, empty chunks + yielded by an iterator body will be ignored by the chunk-encoder. + This is to avoid premature termination of the read of the request by + the target server due to malformed encoding. + + .. versionadded:: 3.6 + Chunked encoding support. The *encode_chunked* parameter was + added. + + +.. method:: HTTPConnection.send(data) + + Send data to the server. This should be used directly only after the + :meth:`endheaders` method has been called and before :meth:`getresponse` is + called. + + +.. _httpresponse-objects: + +HTTPResponse Objects +-------------------- + +An :class:`HTTPResponse` instance wraps the HTTP response from the +server. It provides access to the request headers and the entity +body. The response is an iterable object and can be used in a with +statement. + +.. versionchanged:: 3.5 + The :class:`io.BufferedIOBase` interface is now implemented and + all of its reader operations are supported. + + +.. method:: HTTPResponse.read([amt]) + + Reads and returns the response body, or up to the next *amt* bytes. + +.. method:: HTTPResponse.readinto(b) + + Reads up to the next len(b) bytes of the response body into the buffer *b*. + Returns the number of bytes read. + + .. versionadded:: 3.3 + +.. method:: HTTPResponse.getheader(name, default=None) + + Return the value of the header *name*, or *default* if there is no header + matching *name*. If there is more than one header with the name *name*, + return all of the values joined by ', '. If 'default' is any iterable other + than a single string, its elements are similarly returned joined by commas. + +.. method:: HTTPResponse.getheaders() + + Return a list of (header, value) tuples. + +.. method:: HTTPResponse.fileno() + + Return the ``fileno`` of the underlying socket. + +.. attribute:: HTTPResponse.msg + + A :class:`http.client.HTTPMessage` instance containing the response + headers. :class:`http.client.HTTPMessage` is a subclass of + :class:`email.message.Message`. + +.. attribute:: HTTPResponse.version + + HTTP protocol version used by server. 10 for HTTP/1.0, 11 for HTTP/1.1. + +.. attribute:: HTTPResponse.status + + Status code returned by server. + +.. attribute:: HTTPResponse.reason + + Reason phrase returned by server. + +.. attribute:: HTTPResponse.debuglevel + + A debugging hook. If :attr:`debuglevel` is greater than zero, messages + will be printed to stdout as the response is read and parsed. + +.. attribute:: HTTPResponse.closed + + Is ``True`` if the stream is closed. + +Examples +-------- + +Here is an example session that uses the ``GET`` method:: + + >>> import http.client + >>> conn = http.client.HTTPSConnection("www.python.org") + >>> conn.request("GET", "/") + >>> r1 = conn.getresponse() + >>> print(r1.status, r1.reason) + 200 OK + >>> data1 = r1.read() # This will return entire content. + >>> # The following example demonstrates reading data in chunks. + >>> conn.request("GET", "/") + >>> r1 = conn.getresponse() + >>> while not r1.closed: + ... print(r1.read(200)) # 200 bytes + b'\n 10 11 12 13 14 ...`` +:func:`cycle` p p0, p1, ... plast, p0, p1, ... ``cycle('ABCD') --> A B C D A B C D ...`` +:func:`repeat` elem [,n] elem, elem, elem, ... endlessly or up to n times ``repeat(10, 3) --> 10 10 10`` +================== ================= ================================================= ========================================= + +**Iterators terminating on the shortest input sequence:** + +============================ ============================ ================================================= ============================================================= +Iterator Arguments Results Example +============================ ============================ ================================================= ============================================================= +:func:`accumulate` p [,func] p0, p0+p1, p0+p1+p2, ... ``accumulate([1,2,3,4,5]) --> 1 3 6 10 15`` +:func:`chain` p, q, ... p0, p1, ... plast, q0, q1, ... ``chain('ABC', 'DEF') --> A B C D E F`` +:func:`chain.from_iterable` iterable p0, p1, ... plast, q0, q1, ... ``chain.from_iterable(['ABC', 'DEF']) --> A B C D E F`` +:func:`compress` data, selectors (d[0] if s[0]), (d[1] if s[1]), ... ``compress('ABCDEF', [1,0,1,0,1,1]) --> A C E F`` +:func:`dropwhile` pred, seq seq[n], seq[n+1], starting when pred fails ``dropwhile(lambda x: x<5, [1,4,6,4,1]) --> 6 4 1`` +:func:`filterfalse` pred, seq elements of seq where pred(elem) is false ``filterfalse(lambda x: x%2, range(10)) --> 0 2 4 6 8`` +:func:`groupby` iterable[, key] sub-iterators grouped by value of key(v) +:func:`islice` seq, [start,] stop [, step] elements from seq[start:stop:step] ``islice('ABCDEFG', 2, None) --> C D E F G`` +:func:`starmap` func, seq func(\*seq[0]), func(\*seq[1]), ... ``starmap(pow, [(2,5), (3,2), (10,3)]) --> 32 9 1000`` +:func:`takewhile` pred, seq seq[0], seq[1], until pred fails ``takewhile(lambda x: x<5, [1,4,6,4,1]) --> 1 4`` +:func:`tee` it, n it1, it2, ... itn splits one iterator into n +:func:`zip_longest` p, q, ... (p[0], q[0]), (p[1], q[1]), ... ``zip_longest('ABCD', 'xy', fillvalue='-') --> Ax By C- D-`` +============================ ============================ ================================================= ============================================================= + +**Combinatoric iterators:** + +============================================== ==================== ============================================================= +Iterator Arguments Results +============================================== ==================== ============================================================= +:func:`product` p, q, ... [repeat=1] cartesian product, equivalent to a nested for-loop +:func:`permutations` p[, r] r-length tuples, all possible orderings, no repeated elements +:func:`combinations` p, r r-length tuples, in sorted order, no repeated elements +:func:`combinations_with_replacement` p, r r-length tuples, in sorted order, with repeated elements +``product('ABCD', repeat=2)`` ``AA AB AC AD BA BB BC BD CA CB CC CD DA DB DC DD`` +``permutations('ABCD', 2)`` ``AB AC AD BA BC BD CA CB CD DA DB DC`` +``combinations('ABCD', 2)`` ``AB AC AD BC BD CD`` +``combinations_with_replacement('ABCD', 2)`` ``AA AB AC AD BB BC BD CC CD DD`` +============================================== ==================== ============================================================= + + +.. _itertools-functions: + +Itertool functions +------------------ + +The following module functions all construct and return iterators. Some provide +streams of infinite length, so they should only be accessed by functions or +loops that truncate the stream. + +.. function:: accumulate(iterable[, func]) + + Make an iterator that returns accumulated sums, or accumulated + results of other binary functions (specified via the optional + *func* argument). If *func* is supplied, it should be a function + of two arguments. Elements of the input *iterable* may be any type + that can be accepted as arguments to *func*. (For example, with + the default operation of addition, elements may be any addable + type including :class:`~decimal.Decimal` or + :class:`~fractions.Fraction`.) If the input iterable is empty, the + output iterable will also be empty. + + Roughly equivalent to:: + + def accumulate(iterable, func=operator.add): + 'Return running totals' + # accumulate([1,2,3,4,5]) --> 1 3 6 10 15 + # accumulate([1,2,3,4,5], operator.mul) --> 1 2 6 24 120 + it = iter(iterable) + try: + total = next(it) + except StopIteration: + return + yield total + for element in it: + total = func(total, element) + yield total + + There are a number of uses for the *func* argument. It can be set to + :func:`min` for a running minimum, :func:`max` for a running maximum, or + :func:`operator.mul` for a running product. Amortization tables can be + built by accumulating interest and applying payments. First-order + `recurrence relations `_ + can be modeled by supplying the initial value in the iterable and using only + the accumulated total in *func* argument:: + + >>> data = [3, 4, 6, 2, 1, 9, 0, 7, 5, 8] + >>> list(accumulate(data, operator.mul)) # running product + [3, 12, 72, 144, 144, 1296, 0, 0, 0, 0] + >>> list(accumulate(data, max)) # running maximum + [3, 4, 6, 6, 6, 9, 9, 9, 9, 9] + + # Amortize a 5% loan of 1000 with 4 annual payments of 90 + >>> cashflows = [1000, -90, -90, -90, -90] + >>> list(accumulate(cashflows, lambda bal, pmt: bal*1.05 + pmt)) + [1000, 960.0, 918.0, 873.9000000000001, 827.5950000000001] + + # Chaotic recurrence relation https://en.wikipedia.org/wiki/Logistic_map + >>> logistic_map = lambda x, _: r * x * (1 - x) + >>> r = 3.8 + >>> x0 = 0.4 + >>> inputs = repeat(x0, 36) # only the initial value is used + >>> [format(x, '.2f') for x in accumulate(inputs, logistic_map)] + ['0.40', '0.91', '0.30', '0.81', '0.60', '0.92', '0.29', '0.79', '0.63', + '0.88', '0.39', '0.90', '0.33', '0.84', '0.52', '0.95', '0.18', '0.57', + '0.93', '0.25', '0.71', '0.79', '0.63', '0.88', '0.39', '0.91', '0.32', + '0.83', '0.54', '0.95', '0.20', '0.60', '0.91', '0.30', '0.80', '0.60'] + + See :func:`functools.reduce` for a similar function that returns only the + final accumulated value. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.3 + Added the optional *func* parameter. + +.. function:: chain(*iterables) + + Make an iterator that returns elements from the first iterable until it is + exhausted, then proceeds to the next iterable, until all of the iterables are + exhausted. Used for treating consecutive sequences as a single sequence. + Roughly equivalent to:: + + def chain(*iterables): + # chain('ABC', 'DEF') --> A B C D E F + for it in iterables: + for element in it: + yield element + + +.. classmethod:: chain.from_iterable(iterable) + + Alternate constructor for :func:`chain`. Gets chained inputs from a + single iterable argument that is evaluated lazily. Roughly equivalent to:: + + def from_iterable(iterables): + # chain.from_iterable(['ABC', 'DEF']) --> A B C D E F + for it in iterables: + for element in it: + yield element + + +.. function:: combinations(iterable, r) + + Return *r* length subsequences of elements from the input *iterable*. + + Combinations are emitted in lexicographic sort order. So, if the + input *iterable* is sorted, the combination tuples will be produced + in sorted order. + + Elements are treated as unique based on their position, not on their + value. So if the input elements are unique, there will be no repeat + values in each combination. + + Roughly equivalent to:: + + def combinations(iterable, r): + # combinations('ABCD', 2) --> AB AC AD BC BD CD + # combinations(range(4), 3) --> 012 013 023 123 + pool = tuple(iterable) + n = len(pool) + if r > n: + return + indices = list(range(r)) + yield tuple(pool[i] for i in indices) + while True: + for i in reversed(range(r)): + if indices[i] != i + n - r: + break + else: + return + indices[i] += 1 + for j in range(i+1, r): + indices[j] = indices[j-1] + 1 + yield tuple(pool[i] for i in indices) + + The code for :func:`combinations` can be also expressed as a subsequence + of :func:`permutations` after filtering entries where the elements are not + in sorted order (according to their position in the input pool):: + + def combinations(iterable, r): + pool = tuple(iterable) + n = len(pool) + for indices in permutations(range(n), r): + if sorted(indices) == list(indices): + yield tuple(pool[i] for i in indices) + + The number of items returned is ``n! / r! / (n-r)!`` when ``0 <= r <= n`` + or zero when ``r > n``. + +.. function:: combinations_with_replacement(iterable, r) + + Return *r* length subsequences of elements from the input *iterable* + allowing individual elements to be repeated more than once. + + Combinations are emitted in lexicographic sort order. So, if the + input *iterable* is sorted, the combination tuples will be produced + in sorted order. + + Elements are treated as unique based on their position, not on their + value. So if the input elements are unique, the generated combinations + will also be unique. + + Roughly equivalent to:: + + def combinations_with_replacement(iterable, r): + # combinations_with_replacement('ABC', 2) --> AA AB AC BB BC CC + pool = tuple(iterable) + n = len(pool) + if not n and r: + return + indices = [0] * r + yield tuple(pool[i] for i in indices) + while True: + for i in reversed(range(r)): + if indices[i] != n - 1: + break + else: + return + indices[i:] = [indices[i] + 1] * (r - i) + yield tuple(pool[i] for i in indices) + + The code for :func:`combinations_with_replacement` can be also expressed as + a subsequence of :func:`product` after filtering entries where the elements + are not in sorted order (according to their position in the input pool):: + + def combinations_with_replacement(iterable, r): + pool = tuple(iterable) + n = len(pool) + for indices in product(range(n), repeat=r): + if sorted(indices) == list(indices): + yield tuple(pool[i] for i in indices) + + The number of items returned is ``(n+r-1)! / r! / (n-1)!`` when ``n > 0``. + + .. versionadded:: 3.1 + + +.. function:: compress(data, selectors) + + Make an iterator that filters elements from *data* returning only those that + have a corresponding element in *selectors* that evaluates to ``True``. + Stops when either the *data* or *selectors* iterables has been exhausted. + Roughly equivalent to:: + + def compress(data, selectors): + # compress('ABCDEF', [1,0,1,0,1,1]) --> A C E F + return (d for d, s in zip(data, selectors) if s) + + .. versionadded:: 3.1 + + +.. function:: count(start=0, step=1) + + Make an iterator that returns evenly spaced values starting with number *start*. Often + used as an argument to :func:`map` to generate consecutive data points. + Also, used with :func:`zip` to add sequence numbers. Roughly equivalent to:: + + def count(start=0, step=1): + # count(10) --> 10 11 12 13 14 ... + # count(2.5, 0.5) -> 2.5 3.0 3.5 ... + n = start + while True: + yield n + n += step + + When counting with floating point numbers, better accuracy can sometimes be + achieved by substituting multiplicative code such as: ``(start + step * i + for i in count())``. + + .. versionchanged:: 3.1 + Added *step* argument and allowed non-integer arguments. + +.. function:: cycle(iterable) + + Make an iterator returning elements from the iterable and saving a copy of each. + When the iterable is exhausted, return elements from the saved copy. Repeats + indefinitely. Roughly equivalent to:: + + def cycle(iterable): + # cycle('ABCD') --> A B C D A B C D A B C D ... + saved = [] + for element in iterable: + yield element + saved.append(element) + while saved: + for element in saved: + yield element + + Note, this member of the toolkit may require significant auxiliary storage + (depending on the length of the iterable). + + +.. function:: dropwhile(predicate, iterable) + + Make an iterator that drops elements from the iterable as long as the predicate + is true; afterwards, returns every element. Note, the iterator does not produce + *any* output until the predicate first becomes false, so it may have a lengthy + start-up time. Roughly equivalent to:: + + def dropwhile(predicate, iterable): + # dropwhile(lambda x: x<5, [1,4,6,4,1]) --> 6 4 1 + iterable = iter(iterable) + for x in iterable: + if not predicate(x): + yield x + break + for x in iterable: + yield x + +.. function:: filterfalse(predicate, iterable) + + Make an iterator that filters elements from iterable returning only those for + which the predicate is ``False``. If *predicate* is ``None``, return the items + that are false. Roughly equivalent to:: + + def filterfalse(predicate, iterable): + # filterfalse(lambda x: x%2, range(10)) --> 0 2 4 6 8 + if predicate is None: + predicate = bool + for x in iterable: + if not predicate(x): + yield x + + +.. function:: groupby(iterable, key=None) + + Make an iterator that returns consecutive keys and groups from the *iterable*. + The *key* is a function computing a key value for each element. If not + specified or is ``None``, *key* defaults to an identity function and returns + the element unchanged. Generally, the iterable needs to already be sorted on + the same key function. + + The operation of :func:`groupby` is similar to the ``uniq`` filter in Unix. It + generates a break or new group every time the value of the key function changes + (which is why it is usually necessary to have sorted the data using the same key + function). That behavior differs from SQL's GROUP BY which aggregates common + elements regardless of their input order. + + The returned group is itself an iterator that shares the underlying iterable + with :func:`groupby`. Because the source is shared, when the :func:`groupby` + object is advanced, the previous group is no longer visible. So, if that data + is needed later, it should be stored as a list:: + + groups = [] + uniquekeys = [] + data = sorted(data, key=keyfunc) + for k, g in groupby(data, keyfunc): + groups.append(list(g)) # Store group iterator as a list + uniquekeys.append(k) + + :func:`groupby` is roughly equivalent to:: + + class groupby: + # [k for k, g in groupby('AAAABBBCCDAABBB')] --> A B C D A B + # [list(g) for k, g in groupby('AAAABBBCCD')] --> AAAA BBB CC D + def __init__(self, iterable, key=None): + if key is None: + key = lambda x: x + self.keyfunc = key + self.it = iter(iterable) + self.tgtkey = self.currkey = self.currvalue = object() + def __iter__(self): + return self + def __next__(self): + self.id = object() + while self.currkey == self.tgtkey: + self.currvalue = next(self.it) # Exit on StopIteration + self.currkey = self.keyfunc(self.currvalue) + self.tgtkey = self.currkey + return (self.currkey, self._grouper(self.tgtkey, self.id)) + def _grouper(self, tgtkey, id): + while self.id is id and self.currkey == tgtkey: + yield self.currvalue + try: + self.currvalue = next(self.it) + except StopIteration: + return + self.currkey = self.keyfunc(self.currvalue) + + +.. function:: islice(iterable, stop) + islice(iterable, start, stop[, step]) + + Make an iterator that returns selected elements from the iterable. If *start* is + non-zero, then elements from the iterable are skipped until start is reached. + Afterward, elements are returned consecutively unless *step* is set higher than + one which results in items being skipped. If *stop* is ``None``, then iteration + continues until the iterator is exhausted, if at all; otherwise, it stops at the + specified position. Unlike regular slicing, :func:`islice` does not support + negative values for *start*, *stop*, or *step*. Can be used to extract related + fields from data where the internal structure has been flattened (for example, a + multi-line report may list a name field on every third line). Roughly equivalent to:: + + def islice(iterable, *args): + # islice('ABCDEFG', 2) --> A B + # islice('ABCDEFG', 2, 4) --> C D + # islice('ABCDEFG', 2, None) --> C D E F G + # islice('ABCDEFG', 0, None, 2) --> A C E G + s = slice(*args) + start, stop, step = s.start or 0, s.stop or sys.maxsize, s.step or 1 + it = iter(range(start, stop, step)) + try: + nexti = next(it) + except StopIteration: + # Consume *iterable* up to the *start* position. + for i, element in zip(range(start), iterable): + pass + return + try: + for i, element in enumerate(iterable): + if i == nexti: + yield element + nexti = next(it) + except StopIteration: + # Consume to *stop*. + for i, element in zip(range(i + 1, stop), iterable): + pass + + If *start* is ``None``, then iteration starts at zero. If *step* is ``None``, + then the step defaults to one. + + +.. function:: permutations(iterable, r=None) + + Return successive *r* length permutations of elements in the *iterable*. + + If *r* is not specified or is ``None``, then *r* defaults to the length + of the *iterable* and all possible full-length permutations + are generated. + + Permutations are emitted in lexicographic sort order. So, if the + input *iterable* is sorted, the permutation tuples will be produced + in sorted order. + + Elements are treated as unique based on their position, not on their + value. So if the input elements are unique, there will be no repeat + values in each permutation. + + Roughly equivalent to:: + + def permutations(iterable, r=None): + # permutations('ABCD', 2) --> AB AC AD BA BC BD CA CB CD DA DB DC + # permutations(range(3)) --> 012 021 102 120 201 210 + pool = tuple(iterable) + n = len(pool) + r = n if r is None else r + if r > n: + return + indices = list(range(n)) + cycles = list(range(n, n-r, -1)) + yield tuple(pool[i] for i in indices[:r]) + while n: + for i in reversed(range(r)): + cycles[i] -= 1 + if cycles[i] == 0: + indices[i:] = indices[i+1:] + indices[i:i+1] + cycles[i] = n - i + else: + j = cycles[i] + indices[i], indices[-j] = indices[-j], indices[i] + yield tuple(pool[i] for i in indices[:r]) + break + else: + return + + The code for :func:`permutations` can be also expressed as a subsequence of + :func:`product`, filtered to exclude entries with repeated elements (those + from the same position in the input pool):: + + def permutations(iterable, r=None): + pool = tuple(iterable) + n = len(pool) + r = n if r is None else r + for indices in product(range(n), repeat=r): + if len(set(indices)) == r: + yield tuple(pool[i] for i in indices) + + The number of items returned is ``n! / (n-r)!`` when ``0 <= r <= n`` + or zero when ``r > n``. + +.. function:: product(*iterables, repeat=1) + + Cartesian product of input iterables. + + Roughly equivalent to nested for-loops in a generator expression. For example, + ``product(A, B)`` returns the same as ``((x,y) for x in A for y in B)``. + + The nested loops cycle like an odometer with the rightmost element advancing + on every iteration. This pattern creates a lexicographic ordering so that if + the input's iterables are sorted, the product tuples are emitted in sorted + order. + + To compute the product of an iterable with itself, specify the number of + repetitions with the optional *repeat* keyword argument. For example, + ``product(A, repeat=4)`` means the same as ``product(A, A, A, A)``. + + This function is roughly equivalent to the following code, except that the + actual implementation does not build up intermediate results in memory:: + + def product(*args, repeat=1): + # product('ABCD', 'xy') --> Ax Ay Bx By Cx Cy Dx Dy + # product(range(2), repeat=3) --> 000 001 010 011 100 101 110 111 + pools = [tuple(pool) for pool in args] * repeat + result = [[]] + for pool in pools: + result = [x+[y] for x in result for y in pool] + for prod in result: + yield tuple(prod) + + +.. function:: repeat(object[, times]) + + Make an iterator that returns *object* over and over again. Runs indefinitely + unless the *times* argument is specified. Used as argument to :func:`map` for + invariant parameters to the called function. Also used with :func:`zip` to + create an invariant part of a tuple record. + + Roughly equivalent to:: + + def repeat(object, times=None): + # repeat(10, 3) --> 10 10 10 + if times is None: + while True: + yield object + else: + for i in range(times): + yield object + + A common use for *repeat* is to supply a stream of constant values to *map* + or *zip*:: + + >>> list(map(pow, range(10), repeat(2))) + [0, 1, 4, 9, 16, 25, 36, 49, 64, 81] + +.. function:: starmap(function, iterable) + + Make an iterator that computes the function using arguments obtained from + the iterable. Used instead of :func:`map` when argument parameters are already + grouped in tuples from a single iterable (the data has been "pre-zipped"). The + difference between :func:`map` and :func:`starmap` parallels the distinction + between ``function(a,b)`` and ``function(*c)``. Roughly equivalent to:: + + def starmap(function, iterable): + # starmap(pow, [(2,5), (3,2), (10,3)]) --> 32 9 1000 + for args in iterable: + yield function(*args) + + +.. function:: takewhile(predicate, iterable) + + Make an iterator that returns elements from the iterable as long as the + predicate is true. Roughly equivalent to:: + + def takewhile(predicate, iterable): + # takewhile(lambda x: x<5, [1,4,6,4,1]) --> 1 4 + for x in iterable: + if predicate(x): + yield x + else: + break + + +.. function:: tee(iterable, n=2) + + Return *n* independent iterators from a single iterable. + + The following Python code helps explain what *tee* does (although the actual + implementation is more complex and uses only a single underlying + :abbr:`FIFO (first-in, first-out)` queue). + + Roughly equivalent to:: + + def tee(iterable, n=2): + it = iter(iterable) + deques = [collections.deque() for i in range(n)] + def gen(mydeque): + while True: + if not mydeque: # when the local deque is empty + try: + newval = next(it) # fetch a new value and + except StopIteration: + return + for d in deques: # load it to all the deques + d.append(newval) + yield mydeque.popleft() + return tuple(gen(d) for d in deques) + + Once :func:`tee` has made a split, the original *iterable* should not be + used anywhere else; otherwise, the *iterable* could get advanced without + the tee objects being informed. + + This itertool may require significant auxiliary storage (depending on how + much temporary data needs to be stored). In general, if one iterator uses + most or all of the data before another iterator starts, it is faster to use + :func:`list` instead of :func:`tee`. + + +.. function:: zip_longest(*iterables, fillvalue=None) + + Make an iterator that aggregates elements from each of the iterables. If the + iterables are of uneven length, missing values are filled-in with *fillvalue*. + Iteration continues until the longest iterable is exhausted. Roughly equivalent to:: + + def zip_longest(*args, fillvalue=None): + # zip_longest('ABCD', 'xy', fillvalue='-') --> Ax By C- D- + iterators = [iter(it) for it in args] + num_active = len(iterators) + if not num_active: + return + while True: + values = [] + for i, it in enumerate(iterators): + try: + value = next(it) + except StopIteration: + num_active -= 1 + if not num_active: + return + iterators[i] = repeat(fillvalue) + value = fillvalue + values.append(value) + yield tuple(values) + + If one of the iterables is potentially infinite, then the :func:`zip_longest` + function should be wrapped with something that limits the number of calls + (for example :func:`islice` or :func:`takewhile`). If not specified, + *fillvalue* defaults to ``None``. + + +.. _itertools-recipes: + +Itertools Recipes +----------------- + +This section shows recipes for creating an extended toolset using the existing +itertools as building blocks. + +The extended tools offer the same high performance as the underlying toolset. +The superior memory performance is kept by processing elements one at a time +rather than bringing the whole iterable into memory all at once. Code volume is +kept small by linking the tools together in a functional style which helps +eliminate temporary variables. High speed is retained by preferring +"vectorized" building blocks over the use of for-loops and :term:`generator`\s +which incur interpreter overhead. + +.. testcode:: + + def take(n, iterable): + "Return first n items of the iterable as a list" + return list(islice(iterable, n)) + + def prepend(value, iterator): + "Prepend a single value in front of an iterator" + # prepend(1, [2, 3, 4]) -> 1 2 3 4 + return chain([value], iterator) + + def tabulate(function, start=0): + "Return function(0), function(1), ..." + return map(function, count(start)) + + def tail(n, iterable): + "Return an iterator over the last n items" + # tail(3, 'ABCDEFG') --> E F G + return iter(collections.deque(iterable, maxlen=n)) + + def consume(iterator, n=None): + "Advance the iterator n-steps ahead. If n is None, consume entirely." + # Use functions that consume iterators at C speed. + if n is None: + # feed the entire iterator into a zero-length deque + collections.deque(iterator, maxlen=0) + else: + # advance to the empty slice starting at position n + next(islice(iterator, n, n), None) + + def nth(iterable, n, default=None): + "Returns the nth item or a default value" + return next(islice(iterable, n, None), default) + + def all_equal(iterable): + "Returns True if all the elements are equal to each other" + g = groupby(iterable) + return next(g, True) and not next(g, False) + + def quantify(iterable, pred=bool): + "Count how many times the predicate is true" + return sum(map(pred, iterable)) + + def padnone(iterable): + """Returns the sequence elements and then returns None indefinitely. + + Useful for emulating the behavior of the built-in map() function. + """ + return chain(iterable, repeat(None)) + + def ncycles(iterable, n): + "Returns the sequence elements n times" + return chain.from_iterable(repeat(tuple(iterable), n)) + + def dotproduct(vec1, vec2): + return sum(map(operator.mul, vec1, vec2)) + + def flatten(listOfLists): + "Flatten one level of nesting" + return chain.from_iterable(listOfLists) + + def repeatfunc(func, times=None, *args): + """Repeat calls to func with specified arguments. + + Example: repeatfunc(random.random) + """ + if times is None: + return starmap(func, repeat(args)) + return starmap(func, repeat(args, times)) + + def pairwise(iterable): + "s -> (s0,s1), (s1,s2), (s2, s3), ..." + a, b = tee(iterable) + next(b, None) + return zip(a, b) + + def grouper(iterable, n, fillvalue=None): + "Collect data into fixed-length chunks or blocks" + # grouper('ABCDEFG', 3, 'x') --> ABC DEF Gxx" + args = [iter(iterable)] * n + return zip_longest(*args, fillvalue=fillvalue) + + def roundrobin(*iterables): + "roundrobin('ABC', 'D', 'EF') --> A D E B F C" + # Recipe credited to George Sakkis + num_active = len(iterables) + nexts = cycle(iter(it).__next__ for it in iterables) + while num_active: + try: + for next in nexts: + yield next() + except StopIteration: + # Remove the iterator we just exhausted from the cycle. + num_active -= 1 + nexts = cycle(islice(nexts, num_active)) + + def partition(pred, iterable): + 'Use a predicate to partition entries into false entries and true entries' + # partition(is_odd, range(10)) --> 0 2 4 6 8 and 1 3 5 7 9 + t1, t2 = tee(iterable) + return filterfalse(pred, t1), filter(pred, t2) + + def powerset(iterable): + "powerset([1,2,3]) --> () (1,) (2,) (3,) (1,2) (1,3) (2,3) (1,2,3)" + s = list(iterable) + return chain.from_iterable(combinations(s, r) for r in range(len(s)+1)) + + def unique_everseen(iterable, key=None): + "List unique elements, preserving order. Remember all elements ever seen." + # unique_everseen('AAAABBBCCDAABBB') --> A B C D + # unique_everseen('ABBCcAD', str.lower) --> A B C D + seen = set() + seen_add = seen.add + if key is None: + for element in filterfalse(seen.__contains__, iterable): + seen_add(element) + yield element + else: + for element in iterable: + k = key(element) + if k not in seen: + seen_add(k) + yield element + + def unique_justseen(iterable, key=None): + "List unique elements, preserving order. Remember only the element just seen." + # unique_justseen('AAAABBBCCDAABBB') --> A B C D A B + # unique_justseen('ABBCcAD', str.lower) --> A B C A D + return map(next, map(itemgetter(1), groupby(iterable, key))) + + def iter_except(func, exception, first=None): + """ Call a function repeatedly until an exception is raised. + + Converts a call-until-exception interface to an iterator interface. + Like builtins.iter(func, sentinel) but uses an exception instead + of a sentinel to end the loop. + + Examples: + iter_except(functools.partial(heappop, h), IndexError) # priority queue iterator + iter_except(d.popitem, KeyError) # non-blocking dict iterator + iter_except(d.popleft, IndexError) # non-blocking deque iterator + iter_except(q.get_nowait, Queue.Empty) # loop over a producer Queue + iter_except(s.pop, KeyError) # non-blocking set iterator + + """ + try: + if first is not None: + yield first() # For database APIs needing an initial cast to db.first() + while True: + yield func() + except exception: + pass + + def first_true(iterable, default=False, pred=None): + """Returns the first true value in the iterable. + + If no true value is found, returns *default* + + If *pred* is not None, returns the first item + for which pred(item) is true. + + """ + # first_true([a,b,c], x) --> a or b or c or x + # first_true([a,b], x, f) --> a if f(a) else b if f(b) else x + return next(filter(pred, iterable), default) + + def random_product(*args, repeat=1): + "Random selection from itertools.product(*args, **kwds)" + pools = [tuple(pool) for pool in args] * repeat + return tuple(random.choice(pool) for pool in pools) + + def random_permutation(iterable, r=None): + "Random selection from itertools.permutations(iterable, r)" + pool = tuple(iterable) + r = len(pool) if r is None else r + return tuple(random.sample(pool, r)) + + def random_combination(iterable, r): + "Random selection from itertools.combinations(iterable, r)" + pool = tuple(iterable) + n = len(pool) + indices = sorted(random.sample(range(n), r)) + return tuple(pool[i] for i in indices) + + def random_combination_with_replacement(iterable, r): + "Random selection from itertools.combinations_with_replacement(iterable, r)" + pool = tuple(iterable) + n = len(pool) + indices = sorted(random.randrange(n) for i in range(r)) + return tuple(pool[i] for i in indices) + + def nth_combination(iterable, r, index): + 'Equivalent to list(combinations(iterable, r))[index]' + pool = tuple(iterable) + n = len(pool) + if r < 0 or r > n: + raise ValueError + c = 1 + k = min(r, n-r) + for i in range(1, k+1): + c = c * (n - k + i) // i + if index < 0: + index += c + if index < 0 or index >= c: + raise IndexError + result = [] + while r: + c, n, r = c*r//n, n-1, r-1 + while index >= c: + index -= c + c, n = c*(n-r)//n, n-1 + result.append(pool[-1-n]) + return tuple(result) + +Note, many of the above recipes can be optimized by replacing global lookups +with local variables defined as default values. For example, the +*dotproduct* recipe can be written as:: + + def dotproduct(vec1, vec2, sum=sum, map=map, mul=operator.mul): + return sum(map(mul, vec1, vec2)) diff --git a/python-3.7.4-docs-html/_sources/library/json.rst.txt b/python-3.7.4-docs-html/_sources/library/json.rst.txt new file mode 100644 index 0000000..510e307 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/json.rst.txt @@ -0,0 +1,731 @@ +:mod:`json` --- JSON encoder and decoder +======================================== + +.. module:: json + :synopsis: Encode and decode the JSON format. + +.. moduleauthor:: Bob Ippolito +.. sectionauthor:: Bob Ippolito + +**Source code:** :source:`Lib/json/__init__.py` + +-------------- + +`JSON (JavaScript Object Notation) `_, specified by +:rfc:`7159` (which obsoletes :rfc:`4627`) and by +`ECMA-404 `_, +is a lightweight data interchange format inspired by +`JavaScript `_ object literal syntax +(although it is not a strict subset of JavaScript [#rfc-errata]_ ). + +:mod:`json` exposes an API familiar to users of the standard library +:mod:`marshal` and :mod:`pickle` modules. + +Encoding basic Python object hierarchies:: + + >>> import json + >>> json.dumps(['foo', {'bar': ('baz', None, 1.0, 2)}]) + '["foo", {"bar": ["baz", null, 1.0, 2]}]' + >>> print(json.dumps("\"foo\bar")) + "\"foo\bar" + >>> print(json.dumps('\u1234')) + "\u1234" + >>> print(json.dumps('\\')) + "\\" + >>> print(json.dumps({"c": 0, "b": 0, "a": 0}, sort_keys=True)) + {"a": 0, "b": 0, "c": 0} + >>> from io import StringIO + >>> io = StringIO() + >>> json.dump(['streaming API'], io) + >>> io.getvalue() + '["streaming API"]' + +Compact encoding:: + + >>> import json + >>> json.dumps([1, 2, 3, {'4': 5, '6': 7}], separators=(',', ':')) + '[1,2,3,{"4":5,"6":7}]' + +Pretty printing:: + + >>> import json + >>> print(json.dumps({'4': 5, '6': 7}, sort_keys=True, indent=4)) + { + "4": 5, + "6": 7 + } + +Decoding JSON:: + + >>> import json + >>> json.loads('["foo", {"bar":["baz", null, 1.0, 2]}]') + ['foo', {'bar': ['baz', None, 1.0, 2]}] + >>> json.loads('"\\"foo\\bar"') + '"foo\x08ar' + >>> from io import StringIO + >>> io = StringIO('["streaming API"]') + >>> json.load(io) + ['streaming API'] + +Specializing JSON object decoding:: + + >>> import json + >>> def as_complex(dct): + ... if '__complex__' in dct: + ... return complex(dct['real'], dct['imag']) + ... return dct + ... + >>> json.loads('{"__complex__": true, "real": 1, "imag": 2}', + ... object_hook=as_complex) + (1+2j) + >>> import decimal + >>> json.loads('1.1', parse_float=decimal.Decimal) + Decimal('1.1') + +Extending :class:`JSONEncoder`:: + + >>> import json + >>> class ComplexEncoder(json.JSONEncoder): + ... def default(self, obj): + ... if isinstance(obj, complex): + ... return [obj.real, obj.imag] + ... # Let the base class default method raise the TypeError + ... return json.JSONEncoder.default(self, obj) + ... + >>> json.dumps(2 + 1j, cls=ComplexEncoder) + '[2.0, 1.0]' + >>> ComplexEncoder().encode(2 + 1j) + '[2.0, 1.0]' + >>> list(ComplexEncoder().iterencode(2 + 1j)) + ['[2.0', ', 1.0', ']'] + + +Using :mod:`json.tool` from the shell to validate and pretty-print: + +.. code-block:: shell-session + + $ echo '{"json":"obj"}' | python -m json.tool + { + "json": "obj" + } + $ echo '{1.2:3.4}' | python -m json.tool + Expecting property name enclosed in double quotes: line 1 column 2 (char 1) + +See :ref:`json-commandline` for detailed documentation. + +.. note:: + + JSON is a subset of `YAML `_ 1.2. The JSON produced by + this module's default settings (in particular, the default *separators* + value) is also a subset of YAML 1.0 and 1.1. This module can thus also be + used as a YAML serializer. + + +Basic Usage +----------- + +.. function:: dump(obj, fp, *, skipkeys=False, ensure_ascii=True, \ + check_circular=True, allow_nan=True, cls=None, \ + indent=None, separators=None, default=None, \ + sort_keys=False, **kw) + + Serialize *obj* as a JSON formatted stream to *fp* (a ``.write()``-supporting + :term:`file-like object`) using this :ref:`conversion table + `. + + If *skipkeys* is true (default: ``False``), then dict keys that are not + of a basic type (:class:`str`, :class:`int`, :class:`float`, :class:`bool`, + ``None``) will be skipped instead of raising a :exc:`TypeError`. + + The :mod:`json` module always produces :class:`str` objects, not + :class:`bytes` objects. Therefore, ``fp.write()`` must support :class:`str` + input. + + If *ensure_ascii* is true (the default), the output is guaranteed to + have all incoming non-ASCII characters escaped. If *ensure_ascii* is + false, these characters will be output as-is. + + If *check_circular* is false (default: ``True``), then the circular + reference check for container types will be skipped and a circular reference + will result in an :exc:`OverflowError` (or worse). + + If *allow_nan* is false (default: ``True``), then it will be a + :exc:`ValueError` to serialize out of range :class:`float` values (``nan``, + ``inf``, ``-inf``) in strict compliance of the JSON specification. + If *allow_nan* is true, their JavaScript equivalents (``NaN``, + ``Infinity``, ``-Infinity``) will be used. + + If *indent* is a non-negative integer or string, then JSON array elements and + object members will be pretty-printed with that indent level. An indent level + of 0, negative, or ``""`` will only insert newlines. ``None`` (the default) + selects the most compact representation. Using a positive integer indent + indents that many spaces per level. If *indent* is a string (such as ``"\t"``), + that string is used to indent each level. + + .. versionchanged:: 3.2 + Allow strings for *indent* in addition to integers. + + If specified, *separators* should be an ``(item_separator, key_separator)`` + tuple. The default is ``(', ', ': ')`` if *indent* is ``None`` and + ``(',', ': ')`` otherwise. To get the most compact JSON representation, + you should specify ``(',', ':')`` to eliminate whitespace. + + .. versionchanged:: 3.4 + Use ``(',', ': ')`` as default if *indent* is not ``None``. + + If specified, *default* should be a function that gets called for objects that + can't otherwise be serialized. It should return a JSON encodable version of + the object or raise a :exc:`TypeError`. If not specified, :exc:`TypeError` + is raised. + + If *sort_keys* is true (default: ``False``), then the output of + dictionaries will be sorted by key. + + To use a custom :class:`JSONEncoder` subclass (e.g. one that overrides the + :meth:`default` method to serialize additional types), specify it with the + *cls* kwarg; otherwise :class:`JSONEncoder` is used. + + .. versionchanged:: 3.6 + All optional parameters are now :ref:`keyword-only `. + + .. note:: + + Unlike :mod:`pickle` and :mod:`marshal`, JSON is not a framed protocol, + so trying to serialize multiple objects with repeated calls to + :func:`dump` using the same *fp* will result in an invalid JSON file. + +.. function:: dumps(obj, *, skipkeys=False, ensure_ascii=True, \ + check_circular=True, allow_nan=True, cls=None, \ + indent=None, separators=None, default=None, \ + sort_keys=False, **kw) + + Serialize *obj* to a JSON formatted :class:`str` using this :ref:`conversion + table `. The arguments have the same meaning as in + :func:`dump`. + + .. note:: + + Keys in key/value pairs of JSON are always of the type :class:`str`. When + a dictionary is converted into JSON, all the keys of the dictionary are + coerced to strings. As a result of this, if a dictionary is converted + into JSON and then back into a dictionary, the dictionary may not equal + the original one. That is, ``loads(dumps(x)) != x`` if x has non-string + keys. + +.. function:: load(fp, *, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw) + + Deserialize *fp* (a ``.read()``-supporting :term:`text file` or + :term:`binary file` containing a JSON document) to a Python object using + this :ref:`conversion table `. + + *object_hook* is an optional function that will be called with the result of + any object literal decoded (a :class:`dict`). The return value of + *object_hook* will be used instead of the :class:`dict`. This feature can be used + to implement custom decoders (e.g. `JSON-RPC `_ + class hinting). + + *object_pairs_hook* is an optional function that will be called with the + result of any object literal decoded with an ordered list of pairs. The + return value of *object_pairs_hook* will be used instead of the + :class:`dict`. This feature can be used to implement custom decoders. + If *object_hook* is also defined, the *object_pairs_hook* takes priority. + + .. versionchanged:: 3.1 + Added support for *object_pairs_hook*. + + *parse_float*, if specified, will be called with the string of every JSON + float to be decoded. By default, this is equivalent to ``float(num_str)``. + This can be used to use another datatype or parser for JSON floats + (e.g. :class:`decimal.Decimal`). + + *parse_int*, if specified, will be called with the string of every JSON int + to be decoded. By default, this is equivalent to ``int(num_str)``. This can + be used to use another datatype or parser for JSON integers + (e.g. :class:`float`). + + *parse_constant*, if specified, will be called with one of the following + strings: ``'-Infinity'``, ``'Infinity'``, ``'NaN'``. + This can be used to raise an exception if invalid JSON numbers + are encountered. + + .. versionchanged:: 3.1 + *parse_constant* doesn't get called on 'null', 'true', 'false' anymore. + + To use a custom :class:`JSONDecoder` subclass, specify it with the ``cls`` + kwarg; otherwise :class:`JSONDecoder` is used. Additional keyword arguments + will be passed to the constructor of the class. + + If the data being deserialized is not a valid JSON document, a + :exc:`JSONDecodeError` will be raised. + + .. versionchanged:: 3.6 + All optional parameters are now :ref:`keyword-only `. + + .. versionchanged:: 3.6 + *fp* can now be a :term:`binary file`. The input encoding should be + UTF-8, UTF-16 or UTF-32. + +.. function:: loads(s, *, encoding=None, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw) + + Deserialize *s* (a :class:`str`, :class:`bytes` or :class:`bytearray` + instance containing a JSON document) to a Python object using this + :ref:`conversion table `. + + The other arguments have the same meaning as in :func:`load`, except + *encoding* which is ignored and deprecated. + + If the data being deserialized is not a valid JSON document, a + :exc:`JSONDecodeError` will be raised. + + .. versionchanged:: 3.6 + *s* can now be of type :class:`bytes` or :class:`bytearray`. The + input encoding should be UTF-8, UTF-16 or UTF-32. + + +Encoders and Decoders +--------------------- + +.. class:: JSONDecoder(*, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, strict=True, object_pairs_hook=None) + + Simple JSON decoder. + + Performs the following translations in decoding by default: + + .. _json-to-py-table: + + +---------------+-------------------+ + | JSON | Python | + +===============+===================+ + | object | dict | + +---------------+-------------------+ + | array | list | + +---------------+-------------------+ + | string | str | + +---------------+-------------------+ + | number (int) | int | + +---------------+-------------------+ + | number (real) | float | + +---------------+-------------------+ + | true | True | + +---------------+-------------------+ + | false | False | + +---------------+-------------------+ + | null | None | + +---------------+-------------------+ + + It also understands ``NaN``, ``Infinity``, and ``-Infinity`` as their + corresponding ``float`` values, which is outside the JSON spec. + + *object_hook*, if specified, will be called with the result of every JSON + object decoded and its return value will be used in place of the given + :class:`dict`. This can be used to provide custom deserializations (e.g. to + support JSON-RPC class hinting). + + *object_pairs_hook*, if specified will be called with the result of every + JSON object decoded with an ordered list of pairs. The return value of + *object_pairs_hook* will be used instead of the :class:`dict`. This + feature can be used to implement custom decoders. If *object_hook* is also + defined, the *object_pairs_hook* takes priority. + + .. versionchanged:: 3.1 + Added support for *object_pairs_hook*. + + *parse_float*, if specified, will be called with the string of every JSON + float to be decoded. By default, this is equivalent to ``float(num_str)``. + This can be used to use another datatype or parser for JSON floats + (e.g. :class:`decimal.Decimal`). + + *parse_int*, if specified, will be called with the string of every JSON int + to be decoded. By default, this is equivalent to ``int(num_str)``. This can + be used to use another datatype or parser for JSON integers + (e.g. :class:`float`). + + *parse_constant*, if specified, will be called with one of the following + strings: ``'-Infinity'``, ``'Infinity'``, ``'NaN'``. + This can be used to raise an exception if invalid JSON numbers + are encountered. + + If *strict* is false (``True`` is the default), then control characters + will be allowed inside strings. Control characters in this context are + those with character codes in the 0--31 range, including ``'\t'`` (tab), + ``'\n'``, ``'\r'`` and ``'\0'``. + + If the data being deserialized is not a valid JSON document, a + :exc:`JSONDecodeError` will be raised. + + .. versionchanged:: 3.6 + All parameters are now :ref:`keyword-only `. + + .. method:: decode(s) + + Return the Python representation of *s* (a :class:`str` instance + containing a JSON document). + + :exc:`JSONDecodeError` will be raised if the given JSON document is not + valid. + + .. method:: raw_decode(s) + + Decode a JSON document from *s* (a :class:`str` beginning with a + JSON document) and return a 2-tuple of the Python representation + and the index in *s* where the document ended. + + This can be used to decode a JSON document from a string that may have + extraneous data at the end. + + +.. class:: JSONEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None) + + Extensible JSON encoder for Python data structures. + + Supports the following objects and types by default: + + .. _py-to-json-table: + + +----------------------------------------+---------------+ + | Python | JSON | + +========================================+===============+ + | dict | object | + +----------------------------------------+---------------+ + | list, tuple | array | + +----------------------------------------+---------------+ + | str | string | + +----------------------------------------+---------------+ + | int, float, int- & float-derived Enums | number | + +----------------------------------------+---------------+ + | True | true | + +----------------------------------------+---------------+ + | False | false | + +----------------------------------------+---------------+ + | None | null | + +----------------------------------------+---------------+ + + .. versionchanged:: 3.4 + Added support for int- and float-derived Enum classes. + + To extend this to recognize other objects, subclass and implement a + :meth:`default` method with another method that returns a serializable object + for ``o`` if possible, otherwise it should call the superclass implementation + (to raise :exc:`TypeError`). + + If *skipkeys* is false (the default), then it is a :exc:`TypeError` to + attempt encoding of keys that are not :class:`str`, :class:`int`, + :class:`float` or ``None``. If *skipkeys* is true, such items are simply + skipped. + + If *ensure_ascii* is true (the default), the output is guaranteed to + have all incoming non-ASCII characters escaped. If *ensure_ascii* is + false, these characters will be output as-is. + + If *check_circular* is true (the default), then lists, dicts, and custom + encoded objects will be checked for circular references during encoding to + prevent an infinite recursion (which would cause an :exc:`OverflowError`). + Otherwise, no such check takes place. + + If *allow_nan* is true (the default), then ``NaN``, ``Infinity``, and + ``-Infinity`` will be encoded as such. This behavior is not JSON + specification compliant, but is consistent with most JavaScript based + encoders and decoders. Otherwise, it will be a :exc:`ValueError` to encode + such floats. + + If *sort_keys* is true (default: ``False``), then the output of dictionaries + will be sorted by key; this is useful for regression tests to ensure that + JSON serializations can be compared on a day-to-day basis. + + If *indent* is a non-negative integer or string, then JSON array elements and + object members will be pretty-printed with that indent level. An indent level + of 0, negative, or ``""`` will only insert newlines. ``None`` (the default) + selects the most compact representation. Using a positive integer indent + indents that many spaces per level. If *indent* is a string (such as ``"\t"``), + that string is used to indent each level. + + .. versionchanged:: 3.2 + Allow strings for *indent* in addition to integers. + + If specified, *separators* should be an ``(item_separator, key_separator)`` + tuple. The default is ``(', ', ': ')`` if *indent* is ``None`` and + ``(',', ': ')`` otherwise. To get the most compact JSON representation, + you should specify ``(',', ':')`` to eliminate whitespace. + + .. versionchanged:: 3.4 + Use ``(',', ': ')`` as default if *indent* is not ``None``. + + If specified, *default* should be a function that gets called for objects that + can't otherwise be serialized. It should return a JSON encodable version of + the object or raise a :exc:`TypeError`. If not specified, :exc:`TypeError` + is raised. + + .. versionchanged:: 3.6 + All parameters are now :ref:`keyword-only `. + + + .. method:: default(o) + + Implement this method in a subclass such that it returns a serializable + object for *o*, or calls the base implementation (to raise a + :exc:`TypeError`). + + For example, to support arbitrary iterators, you could implement default + like this:: + + def default(self, o): + try: + iterable = iter(o) + except TypeError: + pass + else: + return list(iterable) + # Let the base class default method raise the TypeError + return json.JSONEncoder.default(self, o) + + + .. method:: encode(o) + + Return a JSON string representation of a Python data structure, *o*. For + example:: + + >>> json.JSONEncoder().encode({"foo": ["bar", "baz"]}) + '{"foo": ["bar", "baz"]}' + + + .. method:: iterencode(o) + + Encode the given object, *o*, and yield each string representation as + available. For example:: + + for chunk in json.JSONEncoder().iterencode(bigobject): + mysocket.write(chunk) + + +Exceptions +---------- + +.. exception:: JSONDecodeError(msg, doc, pos) + + Subclass of :exc:`ValueError` with the following additional attributes: + + .. attribute:: msg + + The unformatted error message. + + .. attribute:: doc + + The JSON document being parsed. + + .. attribute:: pos + + The start index of *doc* where parsing failed. + + .. attribute:: lineno + + The line corresponding to *pos*. + + .. attribute:: colno + + The column corresponding to *pos*. + + .. versionadded:: 3.5 + + +Standard Compliance and Interoperability +---------------------------------------- + +The JSON format is specified by :rfc:`7159` and by +`ECMA-404 `_. +This section details this module's level of compliance with the RFC. +For simplicity, :class:`JSONEncoder` and :class:`JSONDecoder` subclasses, and +parameters other than those explicitly mentioned, are not considered. + +This module does not comply with the RFC in a strict fashion, implementing some +extensions that are valid JavaScript but not valid JSON. In particular: + +- Infinite and NaN number values are accepted and output; +- Repeated names within an object are accepted, and only the value of the last + name-value pair is used. + +Since the RFC permits RFC-compliant parsers to accept input texts that are not +RFC-compliant, this module's deserializer is technically RFC-compliant under +default settings. + +Character Encodings +^^^^^^^^^^^^^^^^^^^ + +The RFC requires that JSON be represented using either UTF-8, UTF-16, or +UTF-32, with UTF-8 being the recommended default for maximum interoperability. + +As permitted, though not required, by the RFC, this module's serializer sets +*ensure_ascii=True* by default, thus escaping the output so that the resulting +strings only contain ASCII characters. + +Other than the *ensure_ascii* parameter, this module is defined strictly in +terms of conversion between Python objects and +:class:`Unicode strings `, and thus does not otherwise directly address +the issue of character encodings. + +The RFC prohibits adding a byte order mark (BOM) to the start of a JSON text, +and this module's serializer does not add a BOM to its output. +The RFC permits, but does not require, JSON deserializers to ignore an initial +BOM in their input. This module's deserializer raises a :exc:`ValueError` +when an initial BOM is present. + +The RFC does not explicitly forbid JSON strings which contain byte sequences +that don't correspond to valid Unicode characters (e.g. unpaired UTF-16 +surrogates), but it does note that they may cause interoperability problems. +By default, this module accepts and outputs (when present in the original +:class:`str`) code points for such sequences. + + +Infinite and NaN Number Values +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The RFC does not permit the representation of infinite or NaN number values. +Despite that, by default, this module accepts and outputs ``Infinity``, +``-Infinity``, and ``NaN`` as if they were valid JSON number literal values:: + + >>> # Neither of these calls raises an exception, but the results are not valid JSON + >>> json.dumps(float('-inf')) + '-Infinity' + >>> json.dumps(float('nan')) + 'NaN' + >>> # Same when deserializing + >>> json.loads('-Infinity') + -inf + >>> json.loads('NaN') + nan + +In the serializer, the *allow_nan* parameter can be used to alter this +behavior. In the deserializer, the *parse_constant* parameter can be used to +alter this behavior. + + +Repeated Names Within an Object +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The RFC specifies that the names within a JSON object should be unique, but +does not mandate how repeated names in JSON objects should be handled. By +default, this module does not raise an exception; instead, it ignores all but +the last name-value pair for a given name:: + + >>> weird_json = '{"x": 1, "x": 2, "x": 3}' + >>> json.loads(weird_json) + {'x': 3} + +The *object_pairs_hook* parameter can be used to alter this behavior. + + +Top-level Non-Object, Non-Array Values +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The old version of JSON specified by the obsolete :rfc:`4627` required that +the top-level value of a JSON text must be either a JSON object or array +(Python :class:`dict` or :class:`list`), and could not be a JSON null, +boolean, number, or string value. :rfc:`7159` removed that restriction, and +this module does not and has never implemented that restriction in either its +serializer or its deserializer. + +Regardless, for maximum interoperability, you may wish to voluntarily adhere +to the restriction yourself. + + +Implementation Limitations +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Some JSON deserializer implementations may set limits on: + +* the size of accepted JSON texts +* the maximum level of nesting of JSON objects and arrays +* the range and precision of JSON numbers +* the content and maximum length of JSON strings + +This module does not impose any such limits beyond those of the relevant +Python datatypes themselves or the Python interpreter itself. + +When serializing to JSON, beware any such limitations in applications that may +consume your JSON. In particular, it is common for JSON numbers to be +deserialized into IEEE 754 double precision numbers and thus subject to that +representation's range and precision limitations. This is especially relevant +when serializing Python :class:`int` values of extremely large magnitude, or +when serializing instances of "exotic" numerical types such as +:class:`decimal.Decimal`. + + +.. _json-commandline: +.. program:: json.tool + +Command Line Interface +---------------------- + +.. module:: json.tool + :synopsis: A command line to validate and pretty-print JSON. + +**Source code:** :source:`Lib/json/tool.py` + +-------------- + +The :mod:`json.tool` module provides a simple command line interface to validate +and pretty-print JSON objects. + +If the optional ``infile`` and ``outfile`` arguments are not +specified, :attr:`sys.stdin` and :attr:`sys.stdout` will be used respectively: + +.. code-block:: shell-session + + $ echo '{"json": "obj"}' | python -m json.tool + { + "json": "obj" + } + $ echo '{1.2:3.4}' | python -m json.tool + Expecting property name enclosed in double quotes: line 1 column 2 (char 1) + +.. versionchanged:: 3.5 + The output is now in the same order as the input. Use the + :option:`--sort-keys` option to sort the output of dictionaries + alphabetically by key. + + +Command line options +^^^^^^^^^^^^^^^^^^^^ + +.. cmdoption:: infile + + The JSON file to be validated or pretty-printed: + + .. code-block:: shell-session + + $ python -m json.tool mp_films.json + [ + { + "title": "And Now for Something Completely Different", + "year": 1971 + }, + { + "title": "Monty Python and the Holy Grail", + "year": 1975 + } + ] + + If *infile* is not specified, read from :attr:`sys.stdin`. + +.. cmdoption:: outfile + + Write the output of the *infile* to the given *outfile*. Otherwise, write it + to :attr:`sys.stdout`. + +.. cmdoption:: --sort-keys + + Sort the output of dictionaries alphabetically by key. + + .. versionadded:: 3.5 + +.. cmdoption:: -h, --help + + Show the help message. + + +.. rubric:: Footnotes + +.. [#rfc-errata] As noted in `the errata for RFC 7159 + `_, + JSON permits literal U+2028 (LINE SEPARATOR) and + U+2029 (PARAGRAPH SEPARATOR) characters in strings, whereas JavaScript + (as of ECMAScript Edition 5.1) does not. diff --git a/python-3.7.4-docs-html/_sources/library/keyword.rst.txt b/python-3.7.4-docs-html/_sources/library/keyword.rst.txt new file mode 100644 index 0000000..173db23 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/keyword.rst.txt @@ -0,0 +1,23 @@ +:mod:`keyword` --- Testing for Python keywords +============================================== + +.. module:: keyword + :synopsis: Test whether a string is a keyword in Python. + +**Source code:** :source:`Lib/keyword.py` + +-------------- + +This module allows a Python program to determine if a string is a keyword. + + +.. function:: iskeyword(s) + + Return true if *s* is a Python keyword. + + +.. data:: kwlist + + Sequence containing all the keywords defined for the interpreter. If any + keywords are defined to only be active when particular :mod:`__future__` + statements are in effect, these will be included as well. diff --git a/python-3.7.4-docs-html/_sources/library/language.rst.txt b/python-3.7.4-docs-html/_sources/library/language.rst.txt new file mode 100644 index 0000000..1eac32e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/language.rst.txt @@ -0,0 +1,28 @@ +.. _language: + +************************ +Python Language Services +************************ + +Python provides a number of modules to assist in working with the Python +language. These modules support tokenizing, parsing, syntax analysis, bytecode +disassembly, and various other facilities. + +These modules include: + + +.. toctree:: + + parser.rst + ast.rst + symtable.rst + symbol.rst + token.rst + keyword.rst + tokenize.rst + tabnanny.rst + pyclbr.rst + py_compile.rst + compileall.rst + dis.rst + pickletools.rst diff --git a/python-3.7.4-docs-html/_sources/library/linecache.rst.txt b/python-3.7.4-docs-html/_sources/library/linecache.rst.txt new file mode 100644 index 0000000..34fcac5 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/linecache.rst.txt @@ -0,0 +1,64 @@ +:mod:`linecache` --- Random access to text lines +================================================ + +.. module:: linecache + :synopsis: This module provides random access to individual lines from text files. + +.. sectionauthor:: Moshe Zadka + +**Source code:** :source:`Lib/linecache.py` + +-------------- + +The :mod:`linecache` module allows one to get any line from a Python source file, while +attempting to optimize internally, using a cache, the common case where many +lines are read from a single file. This is used by the :mod:`traceback` module +to retrieve source lines for inclusion in the formatted traceback. + +The :func:`tokenize.open` function is used to open files. This +function uses :func:`tokenize.detect_encoding` to get the encoding of the +file; in the absence of an encoding token, the file encoding defaults to UTF-8. + +The :mod:`linecache` module defines the following functions: + + +.. function:: getline(filename, lineno, module_globals=None) + + Get line *lineno* from file named *filename*. This function will never raise an + exception --- it will return ``''`` on errors (the terminating newline character + will be included for lines that are found). + + .. index:: triple: module; search; path + + If a file named *filename* is not found, the function will look for it in the + module search path, ``sys.path``, after first checking for a :pep:`302` + ``__loader__`` in *module_globals*, in case the module was imported from a + zipfile or other non-filesystem import source. + + +.. function:: clearcache() + + Clear the cache. Use this function if you no longer need lines from files + previously read using :func:`getline`. + + +.. function:: checkcache(filename=None) + + Check the cache for validity. Use this function if files in the cache may have + changed on disk, and you require the updated version. If *filename* is omitted, + it will check all the entries in the cache. + +.. function:: lazycache(filename, module_globals) + + Capture enough detail about a non-file-based module to permit getting its + lines later via :func:`getline` even if *module_globals* is ``None`` in the later + call. This avoids doing I/O until a line is actually needed, without having + to carry the module globals around indefinitely. + + .. versionadded:: 3.5 + +Example:: + + >>> import linecache + >>> linecache.getline(linecache.__file__, 8) + 'import sys\n' diff --git a/python-3.7.4-docs-html/_sources/library/locale.rst.txt b/python-3.7.4-docs-html/_sources/library/locale.rst.txt new file mode 100644 index 0000000..bf57a08 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/locale.rst.txt @@ -0,0 +1,588 @@ +:mod:`locale` --- Internationalization services +=============================================== + +.. module:: locale + :synopsis: Internationalization services. + +.. moduleauthor:: Martin von Löwis +.. sectionauthor:: Martin von Löwis + +**Source code:** :source:`Lib/locale.py` + +-------------- + +The :mod:`locale` module opens access to the POSIX locale database and +functionality. The POSIX locale mechanism allows programmers to deal with +certain cultural issues in an application, without requiring the programmer to +know all the specifics of each country where the software is executed. + +.. index:: module: _locale + +The :mod:`locale` module is implemented on top of the :mod:`_locale` module, +which in turn uses an ANSI C locale implementation if available. + +The :mod:`locale` module defines the following exception and functions: + + +.. exception:: Error + + Exception raised when the locale passed to :func:`setlocale` is not + recognized. + + +.. function:: setlocale(category, locale=None) + + If *locale* is given and not ``None``, :func:`setlocale` modifies the locale + setting for the *category*. The available categories are listed in the data + description below. *locale* may be a string, or an iterable of two strings + (language code and encoding). If it's an iterable, it's converted to a locale + name using the locale aliasing engine. An empty string specifies the user's + default settings. If the modification of the locale fails, the exception + :exc:`Error` is raised. If successful, the new locale setting is returned. + + If *locale* is omitted or ``None``, the current setting for *category* is + returned. + + :func:`setlocale` is not thread-safe on most systems. Applications typically + start with a call of :: + + import locale + locale.setlocale(locale.LC_ALL, '') + + This sets the locale for all categories to the user's default setting (typically + specified in the :envvar:`LANG` environment variable). If the locale is not + changed thereafter, using multithreading should not cause problems. + + +.. function:: localeconv() + + Returns the database of the local conventions as a dictionary. This dictionary + has the following strings as keys: + + .. tabularcolumns:: |l|l|L| + + +----------------------+-------------------------------------+--------------------------------+ + | Category | Key | Meaning | + +======================+=====================================+================================+ + | :const:`LC_NUMERIC` | ``'decimal_point'`` | Decimal point character. | + +----------------------+-------------------------------------+--------------------------------+ + | | ``'grouping'`` | Sequence of numbers specifying | + | | | which relative positions the | + | | | ``'thousands_sep'`` is | + | | | expected. If the sequence is | + | | | terminated with | + | | | :const:`CHAR_MAX`, no further | + | | | grouping is performed. If the | + | | | sequence terminates with a | + | | | ``0``, the last group size is | + | | | repeatedly used. | + +----------------------+-------------------------------------+--------------------------------+ + | | ``'thousands_sep'`` | Character used between groups. | + +----------------------+-------------------------------------+--------------------------------+ + | :const:`LC_MONETARY` | ``'int_curr_symbol'`` | International currency symbol. | + +----------------------+-------------------------------------+--------------------------------+ + | | ``'currency_symbol'`` | Local currency symbol. | + +----------------------+-------------------------------------+--------------------------------+ + | | ``'p_cs_precedes/n_cs_precedes'`` | Whether the currency symbol | + | | | precedes the value (for | + | | | positive resp. negative | + | | | values). | + +----------------------+-------------------------------------+--------------------------------+ + | | ``'p_sep_by_space/n_sep_by_space'`` | Whether the currency symbol is | + | | | separated from the value by a | + | | | space (for positive resp. | + | | | negative values). | + +----------------------+-------------------------------------+--------------------------------+ + | | ``'mon_decimal_point'`` | Decimal point used for | + | | | monetary values. | + +----------------------+-------------------------------------+--------------------------------+ + | | ``'frac_digits'`` | Number of fractional digits | + | | | used in local formatting of | + | | | monetary values. | + +----------------------+-------------------------------------+--------------------------------+ + | | ``'int_frac_digits'`` | Number of fractional digits | + | | | used in international | + | | | formatting of monetary values. | + +----------------------+-------------------------------------+--------------------------------+ + | | ``'mon_thousands_sep'`` | Group separator used for | + | | | monetary values. | + +----------------------+-------------------------------------+--------------------------------+ + | | ``'mon_grouping'`` | Equivalent to ``'grouping'``, | + | | | used for monetary values. | + +----------------------+-------------------------------------+--------------------------------+ + | | ``'positive_sign'`` | Symbol used to annotate a | + | | | positive monetary value. | + +----------------------+-------------------------------------+--------------------------------+ + | | ``'negative_sign'`` | Symbol used to annotate a | + | | | negative monetary value. | + +----------------------+-------------------------------------+--------------------------------+ + | | ``'p_sign_posn/n_sign_posn'`` | The position of the sign (for | + | | | positive resp. negative | + | | | values), see below. | + +----------------------+-------------------------------------+--------------------------------+ + + All numeric values can be set to :const:`CHAR_MAX` to indicate that there is no + value specified in this locale. + + The possible values for ``'p_sign_posn'`` and ``'n_sign_posn'`` are given below. + + +--------------+-----------------------------------------+ + | Value | Explanation | + +==============+=========================================+ + | ``0`` | Currency and value are surrounded by | + | | parentheses. | + +--------------+-----------------------------------------+ + | ``1`` | The sign should precede the value and | + | | currency symbol. | + +--------------+-----------------------------------------+ + | ``2`` | The sign should follow the value and | + | | currency symbol. | + +--------------+-----------------------------------------+ + | ``3`` | The sign should immediately precede the | + | | value. | + +--------------+-----------------------------------------+ + | ``4`` | The sign should immediately follow the | + | | value. | + +--------------+-----------------------------------------+ + | ``CHAR_MAX`` | Nothing is specified in this locale. | + +--------------+-----------------------------------------+ + + The function sets temporarily the ``LC_CTYPE`` locale to the ``LC_NUMERIC`` + locale or the ``LC_MONETARY`` locale if locales are different and numeric or + monetary strings are non-ASCII. This temporary change affects other threads. + + .. versionchanged:: 3.7 + The function now sets temporarily the ``LC_CTYPE`` locale to the + ``LC_NUMERIC`` locale in some cases. + + +.. function:: nl_langinfo(option) + + Return some locale-specific information as a string. This function is not + available on all systems, and the set of possible options might also vary + across platforms. The possible argument values are numbers, for which + symbolic constants are available in the locale module. + + The :func:`nl_langinfo` function accepts one of the following keys. Most + descriptions are taken from the corresponding description in the GNU C + library. + + .. data:: CODESET + + Get a string with the name of the character encoding used in the + selected locale. + + .. data:: D_T_FMT + + Get a string that can be used as a format string for :func:`time.strftime` to + represent date and time in a locale-specific way. + + .. data:: D_FMT + + Get a string that can be used as a format string for :func:`time.strftime` to + represent a date in a locale-specific way. + + .. data:: T_FMT + + Get a string that can be used as a format string for :func:`time.strftime` to + represent a time in a locale-specific way. + + .. data:: T_FMT_AMPM + + Get a format string for :func:`time.strftime` to represent time in the am/pm + format. + + .. data:: DAY_1 ... DAY_7 + + Get the name of the n-th day of the week. + + .. note:: + + This follows the US convention of :const:`DAY_1` being Sunday, not the + international convention (ISO 8601) that Monday is the first day of the + week. + + .. data:: ABDAY_1 ... ABDAY_7 + + Get the abbreviated name of the n-th day of the week. + + .. data:: MON_1 ... MON_12 + + Get the name of the n-th month. + + .. data:: ABMON_1 ... ABMON_12 + + Get the abbreviated name of the n-th month. + + .. data:: RADIXCHAR + + Get the radix character (decimal dot, decimal comma, etc.). + + .. data:: THOUSEP + + Get the separator character for thousands (groups of three digits). + + .. data:: YESEXPR + + Get a regular expression that can be used with the regex function to + recognize a positive response to a yes/no question. + + .. note:: + + The expression is in the syntax suitable for the :c:func:`regex` function + from the C library, which might differ from the syntax used in :mod:`re`. + + .. data:: NOEXPR + + Get a regular expression that can be used with the regex(3) function to + recognize a negative response to a yes/no question. + + .. data:: CRNCYSTR + + Get the currency symbol, preceded by "-" if the symbol should appear before + the value, "+" if the symbol should appear after the value, or "." if the + symbol should replace the radix character. + + .. data:: ERA + + Get a string that represents the era used in the current locale. + + Most locales do not define this value. An example of a locale which does + define this value is the Japanese one. In Japan, the traditional + representation of dates includes the name of the era corresponding to the + then-emperor's reign. + + Normally it should not be necessary to use this value directly. Specifying + the ``E`` modifier in their format strings causes the :func:`time.strftime` + function to use this information. The format of the returned string is not + specified, and therefore you should not assume knowledge of it on different + systems. + + .. data:: ERA_D_T_FMT + + Get a format string for :func:`time.strftime` to represent date and time in a + locale-specific era-based way. + + .. data:: ERA_D_FMT + + Get a format string for :func:`time.strftime` to represent a date in a + locale-specific era-based way. + + .. data:: ERA_T_FMT + + Get a format string for :func:`time.strftime` to represent a time in a + locale-specific era-based way. + + .. data:: ALT_DIGITS + + Get a representation of up to 100 values used to represent the values + 0 to 99. + + +.. function:: getdefaultlocale([envvars]) + + Tries to determine the default locale settings and returns them as a tuple of + the form ``(language code, encoding)``. + + According to POSIX, a program which has not called ``setlocale(LC_ALL, '')`` + runs using the portable ``'C'`` locale. Calling ``setlocale(LC_ALL, '')`` lets + it use the default locale as defined by the :envvar:`LANG` variable. Since we + do not want to interfere with the current locale setting we thus emulate the + behavior in the way described above. + + To maintain compatibility with other platforms, not only the :envvar:`LANG` + variable is tested, but a list of variables given as envvars parameter. The + first found to be defined will be used. *envvars* defaults to the search + path used in GNU gettext; it must always contain the variable name + ``'LANG'``. The GNU gettext search path contains ``'LC_ALL'``, + ``'LC_CTYPE'``, ``'LANG'`` and ``'LANGUAGE'``, in that order. + + Except for the code ``'C'``, the language code corresponds to :rfc:`1766`. + *language code* and *encoding* may be ``None`` if their values cannot be + determined. + + +.. function:: getlocale(category=LC_CTYPE) + + Returns the current setting for the given locale category as sequence containing + *language code*, *encoding*. *category* may be one of the :const:`LC_\*` values + except :const:`LC_ALL`. It defaults to :const:`LC_CTYPE`. + + Except for the code ``'C'``, the language code corresponds to :rfc:`1766`. + *language code* and *encoding* may be ``None`` if their values cannot be + determined. + + +.. function:: getpreferredencoding(do_setlocale=True) + + Return the encoding used for text data, according to user preferences. User + preferences are expressed differently on different systems, and might not be + available programmatically on some systems, so this function only returns a + guess. + + On some systems, it is necessary to invoke :func:`setlocale` to obtain the user + preferences, so this function is not thread-safe. If invoking setlocale is not + necessary or desired, *do_setlocale* should be set to ``False``. + + On Android or in the UTF-8 mode (:option:`-X` ``utf8`` option), always + return ``'UTF-8'``, the locale and the *do_setlocale* argument are ignored. + + .. versionchanged:: 3.7 + The function now always returns ``UTF-8`` on Android or if the UTF-8 mode + is enabled. + + +.. function:: normalize(localename) + + Returns a normalized locale code for the given locale name. The returned locale + code is formatted for use with :func:`setlocale`. If normalization fails, the + original name is returned unchanged. + + If the given encoding is not known, the function defaults to the default + encoding for the locale code just like :func:`setlocale`. + + +.. function:: resetlocale(category=LC_ALL) + + Sets the locale for *category* to the default setting. + + The default setting is determined by calling :func:`getdefaultlocale`. + *category* defaults to :const:`LC_ALL`. + + +.. function:: strcoll(string1, string2) + + Compares two strings according to the current :const:`LC_COLLATE` setting. As + any other compare function, returns a negative, or a positive value, or ``0``, + depending on whether *string1* collates before or after *string2* or is equal to + it. + + +.. function:: strxfrm(string) + + Transforms a string to one that can be used in locale-aware + comparisons. For example, ``strxfrm(s1) < strxfrm(s2)`` is + equivalent to ``strcoll(s1, s2) < 0``. This function can be used + when the same string is compared repeatedly, e.g. when collating a + sequence of strings. + + +.. function:: format_string(format, val, grouping=False, monetary=False) + + Formats a number *val* according to the current :const:`LC_NUMERIC` setting. + The format follows the conventions of the ``%`` operator. For floating point + values, the decimal point is modified if appropriate. If *grouping* is true, + also takes the grouping into account. + + If *monetary* is true, the conversion uses monetary thousands separator and + grouping strings. + + Processes formatting specifiers as in ``format % val``, but takes the current + locale settings into account. + + .. versionchanged:: 3.7 + The *monetary* keyword parameter was added. + + +.. function:: format(format, val, grouping=False, monetary=False) + + Please note that this function works like :meth:`format_string` but will + only work for exactly one ``%char`` specifier. For example, ``'%f'`` and + ``'%.0f'`` are both valid specifiers, but ``'%f KiB'`` is not. + + For whole format strings, use :func:`format_string`. + + .. deprecated:: 3.7 + Use :meth:`format_string` instead. + + +.. function:: currency(val, symbol=True, grouping=False, international=False) + + Formats a number *val* according to the current :const:`LC_MONETARY` settings. + + The returned string includes the currency symbol if *symbol* is true, which is + the default. If *grouping* is true (which is not the default), grouping is done + with the value. If *international* is true (which is not the default), the + international currency symbol is used. + + Note that this function will not work with the 'C' locale, so you have to set a + locale via :func:`setlocale` first. + + +.. function:: str(float) + + Formats a floating point number using the same format as the built-in function + ``str(float)``, but takes the decimal point into account. + + +.. function:: delocalize(string) + + Converts a string into a normalized number string, following the + :const:`LC_NUMERIC` settings. + + .. versionadded:: 3.5 + + +.. function:: atof(string) + + Converts a string to a floating point number, following the :const:`LC_NUMERIC` + settings. + + +.. function:: atoi(string) + + Converts a string to an integer, following the :const:`LC_NUMERIC` conventions. + + +.. data:: LC_CTYPE + + .. index:: module: string + + Locale category for the character type functions. Depending on the settings of + this category, the functions of module :mod:`string` dealing with case change + their behaviour. + + +.. data:: LC_COLLATE + + Locale category for sorting strings. The functions :func:`strcoll` and + :func:`strxfrm` of the :mod:`locale` module are affected. + + +.. data:: LC_TIME + + Locale category for the formatting of time. The function :func:`time.strftime` + follows these conventions. + + +.. data:: LC_MONETARY + + Locale category for formatting of monetary values. The available options are + available from the :func:`localeconv` function. + + +.. data:: LC_MESSAGES + + Locale category for message display. Python currently does not support + application specific locale-aware messages. Messages displayed by the operating + system, like those returned by :func:`os.strerror` might be affected by this + category. + + +.. data:: LC_NUMERIC + + Locale category for formatting numbers. The functions :func:`.format`, + :func:`atoi`, :func:`atof` and :func:`.str` of the :mod:`locale` module are + affected by that category. All other numeric formatting operations are not + affected. + + +.. data:: LC_ALL + + Combination of all locale settings. If this flag is used when the locale is + changed, setting the locale for all categories is attempted. If that fails for + any category, no category is changed at all. When the locale is retrieved using + this flag, a string indicating the setting for all categories is returned. This + string can be later used to restore the settings. + + +.. data:: CHAR_MAX + + This is a symbolic constant used for different values returned by + :func:`localeconv`. + + +Example:: + + >>> import 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 + + +Background, details, hints, tips and caveats +-------------------------------------------- + +The C standard defines the locale as a program-wide property that may be +relatively expensive to change. On top of that, some implementation are broken +in such a way that frequent locale changes may cause core dumps. This makes the +locale somewhat painful to use correctly. + +Initially, when a program is started, the locale is the ``C`` locale, no matter +what the user's preferred locale is. There is one exception: the +:data:`LC_CTYPE` category is changed at startup to set the current locale +encoding to the user's preferred locale encoding. The program must explicitly +say that it wants the user's preferred locale settings for other categories by +calling ``setlocale(LC_ALL, '')``. + +It is generally a bad idea to call :func:`setlocale` in some library routine, +since as a side effect it affects the entire program. Saving and restoring it +is almost as bad: it is expensive and affects other threads that happen to run +before the settings have been restored. + +If, when coding a module for general use, you need a locale independent version +of an operation that is affected by the locale (such as +certain formats used with :func:`time.strftime`), you will have to find a way to +do it without using the standard library routine. Even better is convincing +yourself that using locale settings is okay. Only as a last resort should you +document that your module is not compatible with non-\ ``C`` locale settings. + +The only way to perform numeric operations according to the locale is to use the +special functions defined by this module: :func:`atof`, :func:`atoi`, +:func:`.format`, :func:`.str`. + +There is no way to perform case conversions and character classifications +according to the locale. For (Unicode) text strings these are done according +to the character value only, while for byte strings, the conversions and +classifications are done according to the ASCII value of the byte, and bytes +whose high bit is set (i.e., non-ASCII bytes) are never converted or considered +part of a character class such as letter or whitespace. + + +.. _embedding-locale: + +For extension writers and programs that embed Python +---------------------------------------------------- + +Extension modules should never call :func:`setlocale`, except to find out what +the current locale is. But since the return value can only be used portably to +restore it, that is not very useful (except perhaps to find out whether or not +the locale is ``C``). + +When Python code uses the :mod:`locale` module to change the locale, this also +affects the embedding application. If the embedding application doesn't want +this to happen, it should remove the :mod:`_locale` extension module (which does +all the work) from the table of built-in modules in the :file:`config.c` file, +and make sure that the :mod:`_locale` module is not accessible as a shared +library. + + +.. _locale-gettext: + +Access to message catalogs +-------------------------- + +.. function:: gettext(msg) +.. function:: dgettext(domain, msg) +.. function:: dcgettext(domain, msg, category) +.. function:: textdomain(domain) +.. function:: bindtextdomain(domain, dir) + +The locale module exposes the C library's gettext interface on systems that +provide this interface. It consists of the functions :func:`!gettext`, +:func:`!dgettext`, :func:`!dcgettext`, :func:`!textdomain`, :func:`!bindtextdomain`, +and :func:`!bind_textdomain_codeset`. These are similar to the same functions in +the :mod:`gettext` module, but use the C library's binary format for message +catalogs, and the C library's search algorithms for locating message catalogs. + +Python applications should normally find no need to invoke these functions, and +should use :mod:`gettext` instead. A known exception to this rule are +applications that link with additional C libraries which internally invoke +:c:func:`gettext` or :c:func:`dcgettext`. For these applications, it may be +necessary to bind the text domain, so that the libraries can properly locate +their message catalogs. + diff --git a/python-3.7.4-docs-html/_sources/library/logging.config.rst.txt b/python-3.7.4-docs-html/_sources/library/logging.config.rst.txt new file mode 100644 index 0000000..cd62adb --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/logging.config.rst.txt @@ -0,0 +1,818 @@ +:mod:`logging.config` --- Logging configuration +=============================================== + +.. module:: logging.config + :synopsis: Configuration of the logging module. + +.. moduleauthor:: Vinay Sajip +.. sectionauthor:: Vinay Sajip + +**Source code:** :source:`Lib/logging/config.py` + +.. sidebar:: Important + + This page contains only reference information. For tutorials, + please see + + * :ref:`Basic Tutorial ` + * :ref:`Advanced Tutorial ` + * :ref:`Logging Cookbook ` + +-------------- + +This section describes the API for configuring the logging module. + +.. _logging-config-api: + +Configuration functions +^^^^^^^^^^^^^^^^^^^^^^^ + +The following functions configure the logging module. They are located in the +:mod:`logging.config` module. Their use is optional --- you can configure the +logging module using these functions or by making calls to the main API (defined +in :mod:`logging` itself) and defining handlers which are declared either in +:mod:`logging` or :mod:`logging.handlers`. + +.. function:: dictConfig(config) + + Takes the logging configuration from a dictionary. The contents of + this dictionary are described in :ref:`logging-config-dictschema` + below. + + If an error is encountered during configuration, this function will + raise a :exc:`ValueError`, :exc:`TypeError`, :exc:`AttributeError` + or :exc:`ImportError` with a suitably descriptive message. The + following is a (possibly incomplete) list of conditions which will + raise an error: + + * A ``level`` which is not a string or which is a string not + corresponding to an actual logging level. + * A ``propagate`` value which is not a boolean. + * An id which does not have a corresponding destination. + * A non-existent handler id found during an incremental call. + * An invalid logger name. + * Inability to resolve to an internal or external object. + + Parsing is performed by the :class:`DictConfigurator` class, whose + constructor is passed the dictionary used for configuration, and + has a :meth:`configure` method. The :mod:`logging.config` module + has a callable attribute :attr:`dictConfigClass` + which is initially set to :class:`DictConfigurator`. + You can replace the value of :attr:`dictConfigClass` with a + suitable implementation of your own. + + :func:`dictConfig` calls :attr:`dictConfigClass` passing + the specified dictionary, and then calls the :meth:`configure` method on + the returned object to put the configuration into effect:: + + def dictConfig(config): + dictConfigClass(config).configure() + + For example, a subclass of :class:`DictConfigurator` could call + ``DictConfigurator.__init__()`` in its own :meth:`__init__()`, then + set up custom prefixes which would be usable in the subsequent + :meth:`configure` call. :attr:`dictConfigClass` would be bound to + this new subclass, and then :func:`dictConfig` could be called exactly as + in the default, uncustomized state. + + .. versionadded:: 3.2 + +.. function:: fileConfig(fname, defaults=None, disable_existing_loggers=True) + + Reads the logging configuration from a :mod:`configparser`\-format file. The + format of the file should be as described in + :ref:`logging-config-fileformat`. + This function can be called several times from an application, allowing an + end user to select from various pre-canned configurations (if the developer + provides a mechanism to present the choices and load the chosen + configuration). + + :param fname: A filename, or a file-like object, or an instance derived + from :class:`~configparser.RawConfigParser`. If a + ``RawConfigParser``-derived instance is passed, it is used as + is. Otherwise, a :class:`~configparser.Configparser` is + instantiated, and the configuration read by it from the + object passed in ``fname``. If that has a :meth:`readline` + method, it is assumed to be a file-like object and read using + :meth:`~configparser.ConfigParser.read_file`; otherwise, + it is assumed to be a filename and passed to + :meth:`~configparser.ConfigParser.read`. + + + :param defaults: Defaults to be passed to the ConfigParser can be specified + in this argument. + + :param disable_existing_loggers: If specified as ``False``, loggers which + exist when this call is made are left + enabled. The default is ``True`` because this + enables old behaviour in a + backward-compatible way. This behaviour is to + disable any existing non-root loggers unless + they or their ancestors are explicitly named + in the logging configuration. + + .. versionchanged:: 3.4 + An instance of a subclass of :class:`~configparser.RawConfigParser` is + now accepted as a value for ``fname``. This facilitates: + + * Use of a configuration file where logging configuration is just part + of the overall application configuration. + * Use of a configuration read from a file, and then modified by the using + application (e.g. based on command-line parameters or other aspects + of the runtime environment) before being passed to ``fileConfig``. + +.. function:: listen(port=DEFAULT_LOGGING_CONFIG_PORT, verify=None) + + Starts up a socket server on the specified port, and listens for new + configurations. If no port is specified, the module's default + :const:`DEFAULT_LOGGING_CONFIG_PORT` is used. Logging configurations will be + sent as a file suitable for processing by :func:`dictConfig` or + :func:`fileConfig`. Returns a :class:`~threading.Thread` instance on which + you can call :meth:`~threading.Thread.start` to start the server, and which + you can :meth:`~threading.Thread.join` when appropriate. To stop the server, + call :func:`stopListening`. + + The ``verify`` argument, if specified, should be a callable which should + verify whether bytes received across the socket are valid and should be + processed. This could be done by encrypting and/or signing what is sent + across the socket, such that the ``verify`` callable can perform + signature verification and/or decryption. The ``verify`` callable is called + with a single argument - the bytes received across the socket - and should + return the bytes to be processed, or ``None`` to indicate that the bytes should + be discarded. The returned bytes could be the same as the passed in bytes + (e.g. when only verification is done), or they could be completely different + (perhaps if decryption were performed). + + To send a configuration to the socket, read in the configuration file and + send it to the socket as a sequence of bytes preceded by a four-byte length + string packed in binary using ``struct.pack('>L', n)``. + + .. note:: + + Because portions of the configuration are passed through + :func:`eval`, use of this function may open its users to a security risk. + While the function only binds to a socket on ``localhost``, and so does + not accept connections from remote machines, there are scenarios where + untrusted code could be run under the account of the process which calls + :func:`listen`. Specifically, if the process calling :func:`listen` runs + on a multi-user machine where users cannot trust each other, then a + malicious user could arrange to run essentially arbitrary code in a + victim user's process, simply by connecting to the victim's + :func:`listen` socket and sending a configuration which runs whatever + code the attacker wants to have executed in the victim's process. This is + especially easy to do if the default port is used, but not hard even if a + different port is used). To avoid the risk of this happening, use the + ``verify`` argument to :func:`listen` to prevent unrecognised + configurations from being applied. + + .. versionchanged:: 3.4 + The ``verify`` argument was added. + + .. note:: + + If you want to send configurations to the listener which don't + disable existing loggers, you will need to use a JSON format for + the configuration, which will use :func:`dictConfig` for configuration. + This method allows you to specify ``disable_existing_loggers`` as + ``False`` in the configuration you send. + + +.. function:: stopListening() + + Stops the listening server which was created with a call to :func:`listen`. + This is typically called before calling :meth:`join` on the return value from + :func:`listen`. + + +.. _logging-config-dictschema: + +Configuration dictionary schema +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Describing a logging configuration requires listing the various +objects to create and the connections between them; for example, you +may create a handler named 'console' and then say that the logger +named 'startup' will send its messages to the 'console' handler. +These objects aren't limited to those provided by the :mod:`logging` +module because you might write your own formatter or handler class. +The parameters to these classes may also need to include external +objects such as ``sys.stderr``. The syntax for describing these +objects and connections is defined in :ref:`logging-config-dict-connections` +below. + +Dictionary Schema Details +""""""""""""""""""""""""" + +The dictionary passed to :func:`dictConfig` must contain the following +keys: + +* *version* - to be set to an integer value representing the schema + version. The only valid value at present is 1, but having this key + allows the schema to evolve while still preserving backwards + compatibility. + +All other keys are optional, but if present they will be interpreted +as described below. In all cases below where a 'configuring dict' is +mentioned, it will be checked for the special ``'()'`` key to see if a +custom instantiation is required. If so, the mechanism described in +:ref:`logging-config-dict-userdef` below is used to create an instance; +otherwise, the context is used to determine what to instantiate. + +* *formatters* - the corresponding value will be a dict in which each + key is a formatter id and each value is a dict describing how to + configure the corresponding :class:`~logging.Formatter` instance. + + The configuring dict is searched for keys ``format`` and ``datefmt`` + (with defaults of ``None``) and these are used to construct a + :class:`~logging.Formatter` instance. + +* *filters* - the corresponding value will be a dict in which each key + is a filter id and each value is a dict describing how to configure + the corresponding Filter instance. + + The configuring dict is searched for the key ``name`` (defaulting to the + empty string) and this is used to construct a :class:`logging.Filter` + instance. + +* *handlers* - the corresponding value will be a dict in which each + key is a handler id and each value is a dict describing how to + configure the corresponding Handler instance. + + The configuring dict is searched for the following keys: + + * ``class`` (mandatory). This is the fully qualified name of the + handler class. + + * ``level`` (optional). The level of the handler. + + * ``formatter`` (optional). The id of the formatter for this + handler. + + * ``filters`` (optional). A list of ids of the filters for this + handler. + + All *other* keys are passed through as keyword arguments to the + handler's constructor. For example, given the snippet: + + .. code-block:: yaml + + handlers: + console: + class : logging.StreamHandler + formatter: brief + level : INFO + filters: [allow_foo] + stream : ext://sys.stdout + file: + class : logging.handlers.RotatingFileHandler + formatter: precise + filename: logconfig.log + maxBytes: 1024 + backupCount: 3 + + the handler with id ``console`` is instantiated as a + :class:`logging.StreamHandler`, using ``sys.stdout`` as the underlying + stream. The handler with id ``file`` is instantiated as a + :class:`logging.handlers.RotatingFileHandler` with the keyword arguments + ``filename='logconfig.log', maxBytes=1024, backupCount=3``. + +* *loggers* - the corresponding value will be a dict in which each key + is a logger name and each value is a dict describing how to + configure the corresponding Logger instance. + + The configuring dict is searched for the following keys: + + * ``level`` (optional). The level of the logger. + + * ``propagate`` (optional). The propagation setting of the logger. + + * ``filters`` (optional). A list of ids of the filters for this + logger. + + * ``handlers`` (optional). A list of ids of the handlers for this + logger. + + The specified loggers will be configured according to the level, + propagation, filters and handlers specified. + +* *root* - this will be the configuration for the root logger. + Processing of the configuration will be as for any logger, except + that the ``propagate`` setting will not be applicable. + +* *incremental* - whether the configuration is to be interpreted as + incremental to the existing configuration. This value defaults to + ``False``, which means that the specified configuration replaces the + existing configuration with the same semantics as used by the + existing :func:`fileConfig` API. + + If the specified value is ``True``, the configuration is processed + as described in the section on :ref:`logging-config-dict-incremental`. + +* *disable_existing_loggers* - whether any existing non-root loggers are + to be disabled. This setting mirrors the parameter of the same name in + :func:`fileConfig`. If absent, this parameter defaults to ``True``. + This value is ignored if *incremental* is ``True``. + +.. _logging-config-dict-incremental: + +Incremental Configuration +""""""""""""""""""""""""" + +It is difficult to provide complete flexibility for incremental +configuration. For example, because objects such as filters +and formatters are anonymous, once a configuration is set up, it is +not possible to refer to such anonymous objects when augmenting a +configuration. + +Furthermore, there is not a compelling case for arbitrarily altering +the object graph of loggers, handlers, filters, formatters at +run-time, once a configuration is set up; the verbosity of loggers and +handlers can be controlled just by setting levels (and, in the case of +loggers, propagation flags). Changing the object graph arbitrarily in +a safe way is problematic in a multi-threaded environment; while not +impossible, the benefits are not worth the complexity it adds to the +implementation. + +Thus, when the ``incremental`` key of a configuration dict is present +and is ``True``, the system will completely ignore any ``formatters`` and +``filters`` entries, and process only the ``level`` +settings in the ``handlers`` entries, and the ``level`` and +``propagate`` settings in the ``loggers`` and ``root`` entries. + +Using a value in the configuration dict lets configurations to be sent +over the wire as pickled dicts to a socket listener. Thus, the logging +verbosity of a long-running application can be altered over time with +no need to stop and restart the application. + +.. _logging-config-dict-connections: + +Object connections +"""""""""""""""""" + +The schema describes a set of logging objects - loggers, +handlers, formatters, filters - which are connected to each other in +an object graph. Thus, the schema needs to represent connections +between the objects. For example, say that, once configured, a +particular logger has attached to it a particular handler. For the +purposes of this discussion, we can say that the logger represents the +source, and the handler the destination, of a connection between the +two. Of course in the configured objects this is represented by the +logger holding a reference to the handler. In the configuration dict, +this is done by giving each destination object an id which identifies +it unambiguously, and then using the id in the source object's +configuration to indicate that a connection exists between the source +and the destination object with that id. + +So, for example, consider the following YAML snippet: + +.. code-block:: yaml + + formatters: + brief: + # configuration for formatter with id 'brief' goes here + precise: + # configuration for formatter with id 'precise' goes here + handlers: + h1: #This is an id + # configuration of handler with id 'h1' goes here + formatter: brief + h2: #This is another id + # configuration of handler with id 'h2' goes here + formatter: precise + loggers: + foo.bar.baz: + # other configuration for logger 'foo.bar.baz' + handlers: [h1, h2] + +(Note: YAML used here because it's a little more readable than the +equivalent Python source form for the dictionary.) + +The ids for loggers are the logger names which would be used +programmatically to obtain a reference to those loggers, e.g. +``foo.bar.baz``. The ids for Formatters and Filters can be any string +value (such as ``brief``, ``precise`` above) and they are transient, +in that they are only meaningful for processing the configuration +dictionary and used to determine connections between objects, and are +not persisted anywhere when the configuration call is complete. + +The above snippet indicates that logger named ``foo.bar.baz`` should +have two handlers attached to it, which are described by the handler +ids ``h1`` and ``h2``. The formatter for ``h1`` is that described by id +``brief``, and the formatter for ``h2`` is that described by id +``precise``. + + +.. _logging-config-dict-userdef: + +User-defined objects +"""""""""""""""""""" + +The schema supports user-defined objects for handlers, filters and +formatters. (Loggers do not need to have different types for +different instances, so there is no support in this configuration +schema for user-defined logger classes.) + +Objects to be configured are described by dictionaries +which detail their configuration. In some places, the logging system +will be able to infer from the context how an object is to be +instantiated, but when a user-defined object is to be instantiated, +the system will not know how to do this. In order to provide complete +flexibility for user-defined object instantiation, the user needs +to provide a 'factory' - a callable which is called with a +configuration dictionary and which returns the instantiated object. +This is signalled by an absolute import path to the factory being +made available under the special key ``'()'``. Here's a concrete +example: + +.. code-block:: yaml + + formatters: + brief: + format: '%(message)s' + default: + format: '%(asctime)s %(levelname)-8s %(name)-15s %(message)s' + datefmt: '%Y-%m-%d %H:%M:%S' + custom: + (): my.package.customFormatterFactory + bar: baz + spam: 99.9 + answer: 42 + +The above YAML snippet defines three formatters. The first, with id +``brief``, is a standard :class:`logging.Formatter` instance with the +specified format string. The second, with id ``default``, has a +longer format and also defines the time format explicitly, and will +result in a :class:`logging.Formatter` initialized with those two format +strings. Shown in Python source form, the ``brief`` and ``default`` +formatters have configuration sub-dictionaries:: + + { + 'format' : '%(message)s' + } + +and:: + + { + 'format' : '%(asctime)s %(levelname)-8s %(name)-15s %(message)s', + 'datefmt' : '%Y-%m-%d %H:%M:%S' + } + +respectively, and as these dictionaries do not contain the special key +``'()'``, the instantiation is inferred from the context: as a result, +standard :class:`logging.Formatter` instances are created. The +configuration sub-dictionary for the third formatter, with id +``custom``, is:: + + { + '()' : 'my.package.customFormatterFactory', + 'bar' : 'baz', + 'spam' : 99.9, + 'answer' : 42 + } + +and this contains the special key ``'()'``, which means that +user-defined instantiation is wanted. In this case, the specified +factory callable will be used. If it is an actual callable it will be +used directly - otherwise, if you specify a string (as in the example) +the actual callable will be located using normal import mechanisms. +The callable will be called with the **remaining** items in the +configuration sub-dictionary as keyword arguments. In the above +example, the formatter with id ``custom`` will be assumed to be +returned by the call:: + + my.package.customFormatterFactory(bar='baz', spam=99.9, answer=42) + +The key ``'()'`` has been used as the special key because it is not a +valid keyword parameter name, and so will not clash with the names of +the keyword arguments used in the call. The ``'()'`` also serves as a +mnemonic that the corresponding value is a callable. + + +.. _logging-config-dict-externalobj: + +Access to external objects +"""""""""""""""""""""""""" + +There are times where a configuration needs to refer to objects +external to the configuration, for example ``sys.stderr``. If the +configuration dict is constructed using Python code, this is +straightforward, but a problem arises when the configuration is +provided via a text file (e.g. JSON, YAML). In a text file, there is +no standard way to distinguish ``sys.stderr`` from the literal string +``'sys.stderr'``. To facilitate this distinction, the configuration +system looks for certain special prefixes in string values and +treat them specially. For example, if the literal string +``'ext://sys.stderr'`` is provided as a value in the configuration, +then the ``ext://`` will be stripped off and the remainder of the +value processed using normal import mechanisms. + +The handling of such prefixes is done in a way analogous to protocol +handling: there is a generic mechanism to look for prefixes which +match the regular expression ``^(?P[a-z]+)://(?P.*)$`` +whereby, if the ``prefix`` is recognised, the ``suffix`` is processed +in a prefix-dependent manner and the result of the processing replaces +the string value. If the prefix is not recognised, then the string +value will be left as-is. + + +.. _logging-config-dict-internalobj: + +Access to internal objects +"""""""""""""""""""""""""" + +As well as external objects, there is sometimes also a need to refer +to objects in the configuration. This will be done implicitly by the +configuration system for things that it knows about. For example, the +string value ``'DEBUG'`` for a ``level`` in a logger or handler will +automatically be converted to the value ``logging.DEBUG``, and the +``handlers``, ``filters`` and ``formatter`` entries will take an +object id and resolve to the appropriate destination object. + +However, a more generic mechanism is needed for user-defined +objects which are not known to the :mod:`logging` module. For +example, consider :class:`logging.handlers.MemoryHandler`, which takes +a ``target`` argument which is another handler to delegate to. Since +the system already knows about this class, then in the configuration, +the given ``target`` just needs to be the object id of the relevant +target handler, and the system will resolve to the handler from the +id. If, however, a user defines a ``my.package.MyHandler`` which has +an ``alternate`` handler, the configuration system would not know that +the ``alternate`` referred to a handler. To cater for this, a generic +resolution system allows the user to specify: + +.. code-block:: yaml + + handlers: + file: + # configuration of file handler goes here + + custom: + (): my.package.MyHandler + alternate: cfg://handlers.file + +The literal string ``'cfg://handlers.file'`` will be resolved in an +analogous way to strings with the ``ext://`` prefix, but looking +in the configuration itself rather than the import namespace. The +mechanism allows access by dot or by index, in a similar way to +that provided by ``str.format``. Thus, given the following snippet: + +.. code-block:: yaml + + handlers: + email: + class: logging.handlers.SMTPHandler + mailhost: localhost + fromaddr: my_app@domain.tld + toaddrs: + - support_team@domain.tld + - dev_team@domain.tld + subject: Houston, we have a problem. + +in the configuration, the string ``'cfg://handlers'`` would resolve to +the dict with key ``handlers``, the string ``'cfg://handlers.email`` +would resolve to the dict with key ``email`` in the ``handlers`` dict, +and so on. The string ``'cfg://handlers.email.toaddrs[1]`` would +resolve to ``'dev_team.domain.tld'`` and the string +``'cfg://handlers.email.toaddrs[0]'`` would resolve to the value +``'support_team@domain.tld'``. The ``subject`` value could be accessed +using either ``'cfg://handlers.email.subject'`` or, equivalently, +``'cfg://handlers.email[subject]'``. The latter form only needs to be +used if the key contains spaces or non-alphanumeric characters. If an +index value consists only of decimal digits, access will be attempted +using the corresponding integer value, falling back to the string +value if needed. + +Given a string ``cfg://handlers.myhandler.mykey.123``, this will +resolve to ``config_dict['handlers']['myhandler']['mykey']['123']``. +If the string is specified as ``cfg://handlers.myhandler.mykey[123]``, +the system will attempt to retrieve the value from +``config_dict['handlers']['myhandler']['mykey'][123]``, and fall back +to ``config_dict['handlers']['myhandler']['mykey']['123']`` if that +fails. + + +.. _logging-import-resolution: + +Import resolution and custom importers +"""""""""""""""""""""""""""""""""""""" + +Import resolution, by default, uses the builtin :func:`__import__` function +to do its importing. You may want to replace this with your own importing +mechanism: if so, you can replace the :attr:`importer` attribute of the +:class:`DictConfigurator` or its superclass, the +:class:`BaseConfigurator` class. However, you need to be +careful because of the way functions are accessed from classes via +descriptors. If you are using a Python callable to do your imports, and you +want to define it at class level rather than instance level, you need to wrap +it with :func:`staticmethod`. For example:: + + from importlib import import_module + from logging.config import BaseConfigurator + + BaseConfigurator.importer = staticmethod(import_module) + +You don't need to wrap with :func:`staticmethod` if you're setting the import +callable on a configurator *instance*. + + +.. _logging-config-fileformat: + +Configuration file format +^^^^^^^^^^^^^^^^^^^^^^^^^ + +The configuration file format understood by :func:`fileConfig` is based on +:mod:`configparser` functionality. The file must contain sections called +``[loggers]``, ``[handlers]`` and ``[formatters]`` which identify by name the +entities of each type which are defined in the file. For each such entity, there +is a separate section which identifies how that entity is configured. Thus, for +a logger named ``log01`` in the ``[loggers]`` section, the relevant +configuration details are held in a section ``[logger_log01]``. Similarly, a +handler called ``hand01`` in the ``[handlers]`` section will have its +configuration held in a section called ``[handler_hand01]``, while a formatter +called ``form01`` in the ``[formatters]`` section will have its configuration +specified in a section called ``[formatter_form01]``. The root logger +configuration must be specified in a section called ``[logger_root]``. + +.. note:: + + The :func:`fileConfig` API is older than the :func:`dictConfig` API and does + not provide functionality to cover certain aspects of logging. For example, + you cannot configure :class:`~logging.Filter` objects, which provide for + filtering of messages beyond simple integer levels, using :func:`fileConfig`. + If you need to have instances of :class:`~logging.Filter` in your logging + configuration, you will need to use :func:`dictConfig`. Note that future + enhancements to configuration functionality will be added to + :func:`dictConfig`, so it's worth considering transitioning to this newer + API when it's convenient to do so. + +Examples of these sections in the file are given below. + +.. code-block:: ini + + [loggers] + keys=root,log02,log03,log04,log05,log06,log07 + + [handlers] + keys=hand01,hand02,hand03,hand04,hand05,hand06,hand07,hand08,hand09 + + [formatters] + keys=form01,form02,form03,form04,form05,form06,form07,form08,form09 + +The root logger must specify a level and a list of handlers. An example of a +root logger section is given below. + +.. code-block:: ini + + [logger_root] + level=NOTSET + handlers=hand01 + +The ``level`` entry can be one of ``DEBUG, INFO, WARNING, ERROR, CRITICAL`` or +``NOTSET``. For the root logger only, ``NOTSET`` means that all messages will be +logged. Level values are :func:`eval`\ uated in the context of the ``logging`` +package's namespace. + +The ``handlers`` entry is a comma-separated list of handler names, which must +appear in the ``[handlers]`` section. These names must appear in the +``[handlers]`` section and have corresponding sections in the configuration +file. + +For loggers other than the root logger, some additional information is required. +This is illustrated by the following example. + +.. code-block:: ini + + [logger_parser] + level=DEBUG + handlers=hand01 + propagate=1 + qualname=compiler.parser + +The ``level`` and ``handlers`` entries are interpreted as for the root logger, +except that if a non-root logger's level is specified as ``NOTSET``, the system +consults loggers higher up the hierarchy to determine the effective level of the +logger. The ``propagate`` entry is set to 1 to indicate that messages must +propagate to handlers higher up the logger hierarchy from this logger, or 0 to +indicate that messages are **not** propagated to handlers up the hierarchy. The +``qualname`` entry is the hierarchical channel name of the logger, that is to +say the name used by the application to get the logger. + +Sections which specify handler configuration are exemplified by the following. + +.. code-block:: ini + + [handler_hand01] + class=StreamHandler + level=NOTSET + formatter=form01 + args=(sys.stdout,) + +The ``class`` entry indicates the handler's class (as determined by :func:`eval` +in the ``logging`` package's namespace). The ``level`` is interpreted as for +loggers, and ``NOTSET`` is taken to mean 'log everything'. + +The ``formatter`` entry indicates the key name of the formatter for this +handler. If blank, a default formatter (``logging._defaultFormatter``) is used. +If a name is specified, it must appear in the ``[formatters]`` section and have +a corresponding section in the configuration file. + +The ``args`` entry, when :func:`eval`\ uated in the context of the ``logging`` +package's namespace, is the list of arguments to the constructor for the handler +class. Refer to the constructors for the relevant handlers, or to the examples +below, to see how typical entries are constructed. If not provided, it defaults +to ``()``. + +The optional ``kwargs`` entry, when :func:`eval`\ uated in the context of the +``logging`` package's namespace, is the keyword argument dict to the constructor +for the handler class. If not provided, it defaults to ``{}``. + +.. code-block:: ini + + [handler_hand02] + class=FileHandler + level=DEBUG + formatter=form02 + args=('python.log', 'w') + + [handler_hand03] + class=handlers.SocketHandler + level=INFO + formatter=form03 + args=('localhost', handlers.DEFAULT_TCP_LOGGING_PORT) + + [handler_hand04] + class=handlers.DatagramHandler + level=WARN + formatter=form04 + args=('localhost', handlers.DEFAULT_UDP_LOGGING_PORT) + + [handler_hand05] + class=handlers.SysLogHandler + level=ERROR + formatter=form05 + args=(('localhost', handlers.SYSLOG_UDP_PORT), handlers.SysLogHandler.LOG_USER) + + [handler_hand06] + class=handlers.NTEventLogHandler + level=CRITICAL + formatter=form06 + args=('Python Application', '', 'Application') + + [handler_hand07] + class=handlers.SMTPHandler + level=WARN + formatter=form07 + args=('localhost', 'from@abc', ['user1@abc', 'user2@xyz'], 'Logger Subject') + kwargs={'timeout': 10.0} + + [handler_hand08] + class=handlers.MemoryHandler + level=NOTSET + formatter=form08 + target= + args=(10, ERROR) + + [handler_hand09] + class=handlers.HTTPHandler + level=NOTSET + formatter=form09 + args=('localhost:9022', '/log', 'GET') + kwargs={'secure': True} + +Sections which specify formatter configuration are typified by the following. + +.. code-block:: ini + + [formatter_form01] + format=F1 %(asctime)s %(levelname)s %(message)s + datefmt= + class=logging.Formatter + +The ``format`` entry is the overall format string, and the ``datefmt`` entry is +the :func:`strftime`\ -compatible date/time format string. If empty, the +package substitutes something which is almost equivalent to specifying the date +format string ``'%Y-%m-%d %H:%M:%S'``. This format also specifies milliseconds, +which are appended to the result of using the above format string, with a comma +separator. An example time in this format is ``2003-01-23 00:29:50,411``. + +The ``class`` entry is optional. It indicates the name of the formatter's class +(as a dotted module and class name.) This option is useful for instantiating a +:class:`~logging.Formatter` subclass. Subclasses of +:class:`~logging.Formatter` can present exception tracebacks in an expanded or +condensed format. + +.. note:: + + Due to the use of :func:`eval` as described above, there are + potential security risks which result from using the :func:`listen` to send + and receive configurations via sockets. The risks are limited to where + multiple users with no mutual trust run code on the same machine; see the + :func:`listen` documentation for more information. + +.. seealso:: + + Module :mod:`logging` + API reference for the logging module. + + Module :mod:`logging.handlers` + Useful handlers included with the logging module. diff --git a/python-3.7.4-docs-html/_sources/library/logging.handlers.rst.txt b/python-3.7.4-docs-html/_sources/library/logging.handlers.rst.txt new file mode 100644 index 0000000..32919c1 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/logging.handlers.rst.txt @@ -0,0 +1,1108 @@ +:mod:`logging.handlers` --- Logging handlers +============================================ + +.. module:: logging.handlers + :synopsis: Handlers for the logging module. + +.. moduleauthor:: Vinay Sajip +.. sectionauthor:: Vinay Sajip + +**Source code:** :source:`Lib/logging/handlers.py` + +.. sidebar:: Important + + This page contains only reference information. For tutorials, + please see + + * :ref:`Basic Tutorial ` + * :ref:`Advanced Tutorial ` + * :ref:`Logging Cookbook ` + +-------------- + +.. currentmodule:: logging + +The following useful handlers are provided in the package. Note that three of +the handlers (:class:`StreamHandler`, :class:`FileHandler` and +:class:`NullHandler`) are actually defined in the :mod:`logging` module itself, +but have been documented here along with the other handlers. + +.. _stream-handler: + +StreamHandler +^^^^^^^^^^^^^ + +The :class:`StreamHandler` class, located in the core :mod:`logging` package, +sends logging output to streams such as *sys.stdout*, *sys.stderr* or any +file-like object (or, more precisely, any object which supports :meth:`write` +and :meth:`flush` methods). + + +.. class:: StreamHandler(stream=None) + + Returns a new instance of the :class:`StreamHandler` class. If *stream* is + specified, the instance will use it for logging output; otherwise, *sys.stderr* + will be used. + + + .. method:: emit(record) + + If a formatter is specified, it is used to format the record. The record + is then written to the stream with a terminator. If exception information + is present, it is formatted using :func:`traceback.print_exception` and + appended to the stream. + + + .. method:: flush() + + Flushes the stream by calling its :meth:`flush` method. Note that the + :meth:`close` method is inherited from :class:`~logging.Handler` and so + does no output, so an explicit :meth:`flush` call may be needed at times. + + .. method:: setStream(stream) + + Sets the instance's stream to the specified value, if it is different. + The old stream is flushed before the new stream is set. + + :param stream: The stream that the handler should use. + + :return: the old stream, if the stream was changed, or *None* if it wasn't. + + .. versionadded:: 3.7 + + +.. versionchanged:: 3.2 + The ``StreamHandler`` class now has a ``terminator`` attribute, default + value ``'\n'``, which is used as the terminator when writing a formatted + record to a stream. If you don't want this newline termination, you can + set the handler instance's ``terminator`` attribute to the empty string. + In earlier versions, the terminator was hardcoded as ``'\n'``. + + +.. _file-handler: + +FileHandler +^^^^^^^^^^^ + +The :class:`FileHandler` class, located in the core :mod:`logging` package, +sends logging output to a disk file. It inherits the output functionality from +:class:`StreamHandler`. + + +.. class:: FileHandler(filename, mode='a', encoding=None, delay=False) + + Returns a new instance of the :class:`FileHandler` class. The specified file is + opened and used as the stream for logging. If *mode* is not specified, + :const:`'a'` is used. If *encoding* is not ``None``, it is used to open the file + with that encoding. If *delay* is true, then file opening is deferred until the + first call to :meth:`emit`. By default, the file grows indefinitely. + + .. versionchanged:: 3.6 + As well as string values, :class:`~pathlib.Path` objects are also accepted + for the *filename* argument. + + .. method:: close() + + Closes the file. + + + .. method:: emit(record) + + Outputs the record to the file. + + +.. _null-handler: + +NullHandler +^^^^^^^^^^^ + +.. versionadded:: 3.1 + +The :class:`NullHandler` class, located in the core :mod:`logging` package, +does not do any formatting or output. It is essentially a 'no-op' handler +for use by library developers. + +.. class:: NullHandler() + + Returns a new instance of the :class:`NullHandler` class. + + .. method:: emit(record) + + This method does nothing. + + .. method:: handle(record) + + This method does nothing. + + .. method:: createLock() + + This method returns ``None`` for the lock, since there is no + underlying I/O to which access needs to be serialized. + + +See :ref:`library-config` for more information on how to use +:class:`NullHandler`. + +.. _watched-file-handler: + +WatchedFileHandler +^^^^^^^^^^^^^^^^^^ + +.. currentmodule:: logging.handlers + +The :class:`WatchedFileHandler` class, located in the :mod:`logging.handlers` +module, is a :class:`FileHandler` which watches the file it is logging to. If +the file changes, it is closed and reopened using the file name. + +A file change can happen because of usage of programs such as *newsyslog* and +*logrotate* which perform log file rotation. This handler, intended for use +under Unix/Linux, watches the file to see if it has changed since the last emit. +(A file is deemed to have changed if its device or inode have changed.) If the +file has changed, the old file stream is closed, and the file opened to get a +new stream. + +This handler is not appropriate for use under Windows, because under Windows +open log files cannot be moved or renamed - logging opens the files with +exclusive locks - and so there is no need for such a handler. Furthermore, +*ST_INO* is not supported under Windows; :func:`~os.stat` always returns zero +for this value. + + +.. class:: WatchedFileHandler(filename, mode='a', encoding=None, delay=False) + + Returns a new instance of the :class:`WatchedFileHandler` class. The specified + file is opened and used as the stream for logging. If *mode* is not specified, + :const:`'a'` is used. If *encoding* is not ``None``, it is used to open the file + with that encoding. If *delay* is true, then file opening is deferred until the + first call to :meth:`emit`. By default, the file grows indefinitely. + + .. versionchanged:: 3.6 + As well as string values, :class:`~pathlib.Path` objects are also accepted + for the *filename* argument. + + .. method:: reopenIfNeeded() + + Checks to see if the file has changed. If it has, the existing stream is + flushed and closed and the file opened again, typically as a precursor to + outputting the record to the file. + + .. versionadded:: 3.6 + + + .. method:: emit(record) + + Outputs the record to the file, but first calls :meth:`reopenIfNeeded` to + reopen the file if it has changed. + +.. _base-rotating-handler: + +BaseRotatingHandler +^^^^^^^^^^^^^^^^^^^ + +The :class:`BaseRotatingHandler` class, located in the :mod:`logging.handlers` +module, is the base class for the rotating file handlers, +:class:`RotatingFileHandler` and :class:`TimedRotatingFileHandler`. You should +not need to instantiate this class, but it has attributes and methods you may +need to override. + +.. class:: BaseRotatingHandler(filename, mode, encoding=None, delay=False) + + The parameters are as for :class:`FileHandler`. The attributes are: + + .. attribute:: namer + + If this attribute is set to a callable, the :meth:`rotation_filename` + method delegates to this callable. The parameters passed to the callable + are those passed to :meth:`rotation_filename`. + + .. note:: The namer function is called quite a few times during rollover, + so it should be as simple and as fast as possible. It should also + return the same output every time for a given input, otherwise the + rollover behaviour may not work as expected. + + .. versionadded:: 3.3 + + + .. attribute:: BaseRotatingHandler.rotator + + If this attribute is set to a callable, the :meth:`rotate` method + delegates to this callable. The parameters passed to the callable are + those passed to :meth:`rotate`. + + .. versionadded:: 3.3 + + .. method:: BaseRotatingHandler.rotation_filename(default_name) + + Modify the filename of a log file when rotating. + + This is provided so that a custom filename can be provided. + + The default implementation calls the 'namer' attribute of the handler, + if it's callable, passing the default name to it. If the attribute isn't + callable (the default is ``None``), the name is returned unchanged. + + :param default_name: The default name for the log file. + + .. versionadded:: 3.3 + + + .. method:: BaseRotatingHandler.rotate(source, dest) + + When rotating, rotate the current log. + + The default implementation calls the 'rotator' attribute of the handler, + if it's callable, passing the source and dest arguments to it. If the + attribute isn't callable (the default is ``None``), the source is simply + renamed to the destination. + + :param source: The source filename. This is normally the base + filename, e.g. 'test.log'. + :param dest: The destination filename. This is normally + what the source is rotated to, e.g. 'test.log.1'. + + .. versionadded:: 3.3 + +The reason the attributes exist is to save you having to subclass - you can use +the same callables for instances of :class:`RotatingFileHandler` and +:class:`TimedRotatingFileHandler`. If either the namer or rotator callable +raises an exception, this will be handled in the same way as any other +exception during an :meth:`emit` call, i.e. via the :meth:`handleError` method +of the handler. + +If you need to make more significant changes to rotation processing, you can +override the methods. + +For an example, see :ref:`cookbook-rotator-namer`. + + +.. _rotating-file-handler: + +RotatingFileHandler +^^^^^^^^^^^^^^^^^^^ + +The :class:`RotatingFileHandler` class, located in the :mod:`logging.handlers` +module, supports rotation of disk log files. + + +.. class:: RotatingFileHandler(filename, mode='a', maxBytes=0, backupCount=0, encoding=None, delay=False) + + Returns a new instance of the :class:`RotatingFileHandler` class. The specified + file is opened and used as the stream for logging. If *mode* is not specified, + ``'a'`` is used. If *encoding* is not ``None``, it is used to open the file + with that encoding. If *delay* is true, then file opening is deferred until the + first call to :meth:`emit`. By default, the file grows indefinitely. + + You can use the *maxBytes* and *backupCount* values to allow the file to + :dfn:`rollover` at a predetermined size. When the size is about to be exceeded, + the file is closed and a new file is silently opened for output. Rollover occurs + whenever the current log file is nearly *maxBytes* in length; but if either of + *maxBytes* or *backupCount* is zero, rollover never occurs, so you generally want + to set *backupCount* to at least 1, and have a non-zero *maxBytes*. + When *backupCount* is non-zero, the system will save old log files by appending + the extensions '.1', '.2' etc., to the filename. For example, with a *backupCount* + of 5 and a base file name of :file:`app.log`, you would get :file:`app.log`, + :file:`app.log.1`, :file:`app.log.2`, up to :file:`app.log.5`. The file being + written to is always :file:`app.log`. When this file is filled, it is closed + and renamed to :file:`app.log.1`, and if files :file:`app.log.1`, + :file:`app.log.2`, etc. exist, then they are renamed to :file:`app.log.2`, + :file:`app.log.3` etc. respectively. + + .. versionchanged:: 3.6 + As well as string values, :class:`~pathlib.Path` objects are also accepted + for the *filename* argument. + + .. method:: doRollover() + + Does a rollover, as described above. + + + .. method:: emit(record) + + Outputs the record to the file, catering for rollover as described + previously. + +.. _timed-rotating-file-handler: + +TimedRotatingFileHandler +^^^^^^^^^^^^^^^^^^^^^^^^ + +The :class:`TimedRotatingFileHandler` class, located in the +:mod:`logging.handlers` module, supports rotation of disk log files at certain +timed intervals. + + +.. class:: TimedRotatingFileHandler(filename, when='h', interval=1, backupCount=0, encoding=None, delay=False, utc=False, atTime=None) + + Returns a new instance of the :class:`TimedRotatingFileHandler` class. The + specified file is opened and used as the stream for logging. On rotating it also + sets the filename suffix. Rotating happens based on the product of *when* and + *interval*. + + You can use the *when* to specify the type of *interval*. The list of possible + values is below. Note that they are not case sensitive. + + +----------------+----------------------------+-------------------------+ + | Value | Type of interval | If/how *atTime* is used | + +================+============================+=========================+ + | ``'S'`` | Seconds | Ignored | + +----------------+----------------------------+-------------------------+ + | ``'M'`` | Minutes | Ignored | + +----------------+----------------------------+-------------------------+ + | ``'H'`` | Hours | Ignored | + +----------------+----------------------------+-------------------------+ + | ``'D'`` | Days | Ignored | + +----------------+----------------------------+-------------------------+ + | ``'W0'-'W6'`` | Weekday (0=Monday) | Used to compute initial | + | | | rollover time | + +----------------+----------------------------+-------------------------+ + | ``'midnight'`` | Roll over at midnight, if | Used to compute initial | + | | *atTime* not specified, | rollover time | + | | else at time *atTime* | | + +----------------+----------------------------+-------------------------+ + + When using weekday-based rotation, specify 'W0' for Monday, 'W1' for + Tuesday, and so on up to 'W6' for Sunday. In this case, the value passed for + *interval* isn't used. + + The system will save old log files by appending extensions to the filename. + The extensions are date-and-time based, using the strftime format + ``%Y-%m-%d_%H-%M-%S`` or a leading portion thereof, depending on the + rollover interval. + + When computing the next rollover time for the first time (when the handler + is created), the last modification time of an existing log file, or else + the current time, is used to compute when the next rotation will occur. + + If the *utc* argument is true, times in UTC will be used; otherwise + local time is used. + + If *backupCount* is nonzero, at most *backupCount* files + will be kept, and if more would be created when rollover occurs, the oldest + one is deleted. The deletion logic uses the interval to determine which + files to delete, so changing the interval may leave old files lying around. + + If *delay* is true, then file opening is deferred until the first call to + :meth:`emit`. + + If *atTime* is not ``None``, it must be a ``datetime.time`` instance which + specifies the time of day when rollover occurs, for the cases where rollover + is set to happen "at midnight" or "on a particular weekday". Note that in + these cases, the *atTime* value is effectively used to compute the *initial* + rollover, and subsequent rollovers would be calculated via the normal + interval calculation. + + .. note:: Calculation of the initial rollover time is done when the handler + is initialised. Calculation of subsequent rollover times is done only + when rollover occurs, and rollover occurs only when emitting output. If + this is not kept in mind, it might lead to some confusion. For example, + if an interval of "every minute" is set, that does not mean you will + always see log files with times (in the filename) separated by a minute; + if, during application execution, logging output is generated more + frequently than once a minute, *then* you can expect to see log files + with times separated by a minute. If, on the other hand, logging messages + are only output once every five minutes (say), then there will be gaps in + the file times corresponding to the minutes where no output (and hence no + rollover) occurred. + + .. versionchanged:: 3.4 + *atTime* parameter was added. + + .. versionchanged:: 3.6 + As well as string values, :class:`~pathlib.Path` objects are also accepted + for the *filename* argument. + + .. method:: doRollover() + + Does a rollover, as described above. + + .. method:: emit(record) + + Outputs the record to the file, catering for rollover as described above. + + +.. _socket-handler: + +SocketHandler +^^^^^^^^^^^^^ + +The :class:`SocketHandler` class, located in the :mod:`logging.handlers` module, +sends logging output to a network socket. The base class uses a TCP socket. + + +.. class:: SocketHandler(host, port) + + Returns a new instance of the :class:`SocketHandler` class intended to + communicate with a remote machine whose address is given by *host* and *port*. + + .. versionchanged:: 3.4 + If ``port`` is specified as ``None``, a Unix domain socket is created + using the value in ``host`` - otherwise, a TCP socket is created. + + .. method:: close() + + Closes the socket. + + + .. method:: emit() + + Pickles the record's attribute dictionary and writes it to the socket in + binary format. If there is an error with the socket, silently drops the + packet. If the connection was previously lost, re-establishes the + connection. To unpickle the record at the receiving end into a + :class:`~logging.LogRecord`, use the :func:`~logging.makeLogRecord` + function. + + + .. method:: handleError() + + Handles an error which has occurred during :meth:`emit`. The most likely + cause is a lost connection. Closes the socket so that we can retry on the + next event. + + + .. method:: makeSocket() + + This is a factory method which allows subclasses to define the precise + type of socket they want. The default implementation creates a TCP socket + (:const:`socket.SOCK_STREAM`). + + + .. method:: makePickle(record) + + Pickles the record's attribute dictionary in binary format with a length + prefix, and returns it ready for transmission across the socket. The + details of this operation are equivalent to:: + + data = pickle.dumps(record_attr_dict, 1) + datalen = struct.pack('>L', len(data)) + return datalen + data + + Note that pickles aren't completely secure. If you are concerned about + security, you may want to override this method to implement a more secure + mechanism. For example, you can sign pickles using HMAC and then verify + them on the receiving end, or alternatively you can disable unpickling of + global objects on the receiving end. + + + .. method:: send(packet) + + Send a pickled byte-string *packet* to the socket. The format of the sent + byte-string is as described in the documentation for + :meth:`~SocketHandler.makePickle`. + + This function allows for partial sends, which can happen when the network + is busy. + + + .. method:: createSocket() + + Tries to create a socket; on failure, uses an exponential back-off + algorithm. On initial failure, the handler will drop the message it was + trying to send. When subsequent messages are handled by the same + instance, it will not try connecting until some time has passed. The + default parameters are such that the initial delay is one second, and if + after that delay the connection still can't be made, the handler will + double the delay each time up to a maximum of 30 seconds. + + This behaviour is controlled by the following handler attributes: + + * ``retryStart`` (initial delay, defaulting to 1.0 seconds). + * ``retryFactor`` (multiplier, defaulting to 2.0). + * ``retryMax`` (maximum delay, defaulting to 30.0 seconds). + + This means that if the remote listener starts up *after* the handler has + been used, you could lose messages (since the handler won't even attempt + a connection until the delay has elapsed, but just silently drop messages + during the delay period). + + +.. _datagram-handler: + +DatagramHandler +^^^^^^^^^^^^^^^ + +The :class:`DatagramHandler` class, located in the :mod:`logging.handlers` +module, inherits from :class:`SocketHandler` to support sending logging messages +over UDP sockets. + + +.. class:: DatagramHandler(host, port) + + Returns a new instance of the :class:`DatagramHandler` class intended to + communicate with a remote machine whose address is given by *host* and *port*. + + .. versionchanged:: 3.4 + If ``port`` is specified as ``None``, a Unix domain socket is created + using the value in ``host`` - otherwise, a UDP socket is created. + + .. method:: emit() + + Pickles the record's attribute dictionary and writes it to the socket in + binary format. If there is an error with the socket, silently drops the + packet. To unpickle the record at the receiving end into a + :class:`~logging.LogRecord`, use the :func:`~logging.makeLogRecord` + function. + + + .. method:: makeSocket() + + The factory method of :class:`SocketHandler` is here overridden to create + a UDP socket (:const:`socket.SOCK_DGRAM`). + + + .. method:: send(s) + + Send a pickled byte-string to a socket. The format of the sent byte-string + is as described in the documentation for :meth:`SocketHandler.makePickle`. + + +.. _syslog-handler: + +SysLogHandler +^^^^^^^^^^^^^ + +The :class:`SysLogHandler` class, located in the :mod:`logging.handlers` module, +supports sending logging messages to a remote or local Unix syslog. + + +.. class:: SysLogHandler(address=('localhost', SYSLOG_UDP_PORT), facility=LOG_USER, socktype=socket.SOCK_DGRAM) + + Returns a new instance of the :class:`SysLogHandler` class intended to + communicate with a remote Unix machine whose address is given by *address* in + the form of a ``(host, port)`` tuple. If *address* is not specified, + ``('localhost', 514)`` is used. The address is used to open a socket. An + alternative to providing a ``(host, port)`` tuple is providing an address as a + string, for example '/dev/log'. In this case, a Unix domain socket is used to + send the message to the syslog. If *facility* is not specified, + :const:`LOG_USER` is used. The type of socket opened depends on the + *socktype* argument, which defaults to :const:`socket.SOCK_DGRAM` and thus + opens a UDP socket. To open a TCP socket (for use with the newer syslog + daemons such as rsyslog), specify a value of :const:`socket.SOCK_STREAM`. + + Note that if your server is not listening on UDP port 514, + :class:`SysLogHandler` may appear not to work. In that case, check what + address you should be using for a domain socket - it's system dependent. + For example, on Linux it's usually '/dev/log' but on OS/X it's + '/var/run/syslog'. You'll need to check your platform and use the + appropriate address (you may need to do this check at runtime if your + application needs to run on several platforms). On Windows, you pretty + much have to use the UDP option. + + .. versionchanged:: 3.2 + *socktype* was added. + + + .. method:: close() + + Closes the socket to the remote host. + + + .. method:: emit(record) + + The record is formatted, and then sent to the syslog server. If exception + information is present, it is *not* sent to the server. + + .. versionchanged:: 3.2.1 + (See: :issue:`12168`.) In earlier versions, the message sent to the + syslog daemons was always terminated with a NUL byte, because early + versions of these daemons expected a NUL terminated message - even + though it's not in the relevant specification (:rfc:`5424`). More recent + versions of these daemons don't expect the NUL byte but strip it off + if it's there, and even more recent daemons (which adhere more closely + to RFC 5424) pass the NUL byte on as part of the message. + + To enable easier handling of syslog messages in the face of all these + differing daemon behaviours, the appending of the NUL byte has been + made configurable, through the use of a class-level attribute, + ``append_nul``. This defaults to ``True`` (preserving the existing + behaviour) but can be set to ``False`` on a ``SysLogHandler`` instance + in order for that instance to *not* append the NUL terminator. + + .. versionchanged:: 3.3 + (See: :issue:`12419`.) In earlier versions, there was no facility for + an "ident" or "tag" prefix to identify the source of the message. This + can now be specified using a class-level attribute, defaulting to + ``""`` to preserve existing behaviour, but which can be overridden on + a ``SysLogHandler`` instance in order for that instance to prepend + the ident to every message handled. Note that the provided ident must + be text, not bytes, and is prepended to the message exactly as is. + + .. method:: encodePriority(facility, priority) + + Encodes the facility and priority into an integer. You can pass in strings + or integers - if strings are passed, internal mapping dictionaries are + used to convert them to integers. + + The symbolic ``LOG_`` values are defined in :class:`SysLogHandler` and + mirror the values defined in the ``sys/syslog.h`` header file. + + **Priorities** + + +--------------------------+---------------+ + | Name (string) | Symbolic value| + +==========================+===============+ + | ``alert`` | LOG_ALERT | + +--------------------------+---------------+ + | ``crit`` or ``critical`` | LOG_CRIT | + +--------------------------+---------------+ + | ``debug`` | LOG_DEBUG | + +--------------------------+---------------+ + | ``emerg`` or ``panic`` | LOG_EMERG | + +--------------------------+---------------+ + | ``err`` or ``error`` | LOG_ERR | + +--------------------------+---------------+ + | ``info`` | LOG_INFO | + +--------------------------+---------------+ + | ``notice`` | LOG_NOTICE | + +--------------------------+---------------+ + | ``warn`` or ``warning`` | LOG_WARNING | + +--------------------------+---------------+ + + **Facilities** + + +---------------+---------------+ + | Name (string) | Symbolic value| + +===============+===============+ + | ``auth`` | LOG_AUTH | + +---------------+---------------+ + | ``authpriv`` | LOG_AUTHPRIV | + +---------------+---------------+ + | ``cron`` | LOG_CRON | + +---------------+---------------+ + | ``daemon`` | LOG_DAEMON | + +---------------+---------------+ + | ``ftp`` | LOG_FTP | + +---------------+---------------+ + | ``kern`` | LOG_KERN | + +---------------+---------------+ + | ``lpr`` | LOG_LPR | + +---------------+---------------+ + | ``mail`` | LOG_MAIL | + +---------------+---------------+ + | ``news`` | LOG_NEWS | + +---------------+---------------+ + | ``syslog`` | LOG_SYSLOG | + +---------------+---------------+ + | ``user`` | LOG_USER | + +---------------+---------------+ + | ``uucp`` | LOG_UUCP | + +---------------+---------------+ + | ``local0`` | LOG_LOCAL0 | + +---------------+---------------+ + | ``local1`` | LOG_LOCAL1 | + +---------------+---------------+ + | ``local2`` | LOG_LOCAL2 | + +---------------+---------------+ + | ``local3`` | LOG_LOCAL3 | + +---------------+---------------+ + | ``local4`` | LOG_LOCAL4 | + +---------------+---------------+ + | ``local5`` | LOG_LOCAL5 | + +---------------+---------------+ + | ``local6`` | LOG_LOCAL6 | + +---------------+---------------+ + | ``local7`` | LOG_LOCAL7 | + +---------------+---------------+ + + .. method:: mapPriority(levelname) + + Maps a logging level name to a syslog priority name. + You may need to override this if you are using custom levels, or + if the default algorithm is not suitable for your needs. The + default algorithm maps ``DEBUG``, ``INFO``, ``WARNING``, ``ERROR`` and + ``CRITICAL`` to the equivalent syslog names, and all other level + names to 'warning'. + +.. _nt-eventlog-handler: + +NTEventLogHandler +^^^^^^^^^^^^^^^^^ + +The :class:`NTEventLogHandler` class, located in the :mod:`logging.handlers` +module, supports sending logging messages to a local Windows NT, Windows 2000 or +Windows XP event log. Before you can use it, you need Mark Hammond's Win32 +extensions for Python installed. + + +.. class:: NTEventLogHandler(appname, dllname=None, logtype='Application') + + Returns a new instance of the :class:`NTEventLogHandler` class. The *appname* is + used to define the application name as it appears in the event log. An + appropriate registry entry is created using this name. The *dllname* should give + the fully qualified pathname of a .dll or .exe which contains message + definitions to hold in the log (if not specified, ``'win32service.pyd'`` is used + - this is installed with the Win32 extensions and contains some basic + placeholder message definitions. Note that use of these placeholders will make + your event logs big, as the entire message source is held in the log. If you + want slimmer logs, you have to pass in the name of your own .dll or .exe which + contains the message definitions you want to use in the event log). The + *logtype* is one of ``'Application'``, ``'System'`` or ``'Security'``, and + defaults to ``'Application'``. + + + .. method:: close() + + At this point, you can remove the application name from the registry as a + source of event log entries. However, if you do this, you will not be able + to see the events as you intended in the Event Log Viewer - it needs to be + able to access the registry to get the .dll name. The current version does + not do this. + + + .. method:: emit(record) + + Determines the message ID, event category and event type, and then logs + the message in the NT event log. + + + .. method:: getEventCategory(record) + + Returns the event category for the record. Override this if you want to + specify your own categories. This version returns 0. + + + .. method:: getEventType(record) + + Returns the event type for the record. Override this if you want to + specify your own types. This version does a mapping using the handler's + typemap attribute, which is set up in :meth:`__init__` to a dictionary + which contains mappings for :const:`DEBUG`, :const:`INFO`, + :const:`WARNING`, :const:`ERROR` and :const:`CRITICAL`. If you are using + your own levels, you will either need to override this method or place a + suitable dictionary in the handler's *typemap* attribute. + + + .. method:: getMessageID(record) + + Returns the message ID for the record. If you are using your own messages, + you could do this by having the *msg* passed to the logger being an ID + rather than a format string. Then, in here, you could use a dictionary + lookup to get the message ID. This version returns 1, which is the base + message ID in :file:`win32service.pyd`. + +.. _smtp-handler: + +SMTPHandler +^^^^^^^^^^^ + +The :class:`SMTPHandler` class, located in the :mod:`logging.handlers` module, +supports sending logging messages to an email address via SMTP. + + +.. class:: SMTPHandler(mailhost, fromaddr, toaddrs, subject, credentials=None, secure=None, timeout=1.0) + + Returns a new instance of the :class:`SMTPHandler` class. The instance is + initialized with the from and to addresses and subject line of the email. The + *toaddrs* should be a list of strings. To specify a non-standard SMTP port, use + the (host, port) tuple format for the *mailhost* argument. If you use a string, + the standard SMTP port is used. If your SMTP server requires authentication, you + can specify a (username, password) tuple for the *credentials* argument. + + To specify the use of a secure protocol (TLS), pass in a tuple to the + *secure* argument. This will only be used when authentication credentials are + supplied. The tuple should be either an empty tuple, or a single-value tuple + with the name of a keyfile, or a 2-value tuple with the names of the keyfile + and certificate file. (This tuple is passed to the + :meth:`smtplib.SMTP.starttls` method.) + + A timeout can be specified for communication with the SMTP server using the + *timeout* argument. + + .. versionadded:: 3.3 + The *timeout* argument was added. + + .. method:: emit(record) + + Formats the record and sends it to the specified addressees. + + + .. method:: getSubject(record) + + If you want to specify a subject line which is record-dependent, override + this method. + +.. _memory-handler: + +MemoryHandler +^^^^^^^^^^^^^ + +The :class:`MemoryHandler` class, located in the :mod:`logging.handlers` module, +supports buffering of logging records in memory, periodically flushing them to a +:dfn:`target` handler. Flushing occurs whenever the buffer is full, or when an +event of a certain severity or greater is seen. + +:class:`MemoryHandler` is a subclass of the more general +:class:`BufferingHandler`, which is an abstract class. This buffers logging +records in memory. Whenever each record is added to the buffer, a check is made +by calling :meth:`shouldFlush` to see if the buffer should be flushed. If it +should, then :meth:`flush` is expected to do the flushing. + + +.. class:: BufferingHandler(capacity) + + Initializes the handler with a buffer of the specified capacity. Here, + *capacity* means the number of logging records buffered. + + + .. method:: emit(record) + + Appends the record to the buffer. If :meth:`shouldFlush` returns true, + calls :meth:`flush` to process the buffer. + + + .. method:: flush() + + You can override this to implement custom flushing behavior. This version + just zaps the buffer to empty. + + + .. method:: shouldFlush(record) + + Returns true if the buffer is up to capacity. This method can be + overridden to implement custom flushing strategies. + + +.. class:: MemoryHandler(capacity, flushLevel=ERROR, target=None, flushOnClose=True) + + Returns a new instance of the :class:`MemoryHandler` class. The instance is + initialized with a buffer size of *capacity* (number of records buffered). + If *flushLevel* is not specified, :const:`ERROR` is used. If no *target* is + specified, the target will need to be set using :meth:`setTarget` before this + handler does anything useful. If *flushOnClose* is specified as ``False``, + then the buffer is *not* flushed when the handler is closed. If not specified + or specified as ``True``, the previous behaviour of flushing the buffer will + occur when the handler is closed. + + .. versionchanged:: 3.6 + The *flushOnClose* parameter was added. + + + .. method:: close() + + Calls :meth:`flush`, sets the target to ``None`` and clears the + buffer. + + + .. method:: flush() + + For a :class:`MemoryHandler`, flushing means just sending the buffered + records to the target, if there is one. The buffer is also cleared when + this happens. Override if you want different behavior. + + + .. method:: setTarget(target) + + Sets the target handler for this handler. + + + .. method:: shouldFlush(record) + + Checks for buffer full or a record at the *flushLevel* or higher. + + +.. _http-handler: + +HTTPHandler +^^^^^^^^^^^ + +The :class:`HTTPHandler` class, located in the :mod:`logging.handlers` module, +supports sending logging messages to a Web server, using either ``GET`` or +``POST`` semantics. + + +.. class:: HTTPHandler(host, url, method='GET', secure=False, credentials=None, context=None) + + Returns a new instance of the :class:`HTTPHandler` class. The *host* can be + of the form ``host:port``, should you need to use a specific port number. If + no *method* is specified, ``GET`` is used. If *secure* is true, a HTTPS + connection will be used. The *context* parameter may be set to a + :class:`ssl.SSLContext` instance to configure the SSL settings used for the + HTTPS connection. If *credentials* is specified, it should be a 2-tuple + consisting of userid and password, which will be placed in a HTTP + 'Authorization' header using Basic authentication. If you specify + credentials, you should also specify secure=True so that your userid and + password are not passed in cleartext across the wire. + + .. versionchanged:: 3.5 + The *context* parameter was added. + + .. method:: mapLogRecord(record) + + Provides a dictionary, based on ``record``, which is to be URL-encoded + and sent to the web server. The default implementation just returns + ``record.__dict__``. This method can be overridden if e.g. only a + subset of :class:`~logging.LogRecord` is to be sent to the web server, or + if more specific customization of what's sent to the server is required. + + .. method:: emit(record) + + Sends the record to the Web server as a URL-encoded dictionary. The + :meth:`mapLogRecord` method is used to convert the record to the + dictionary to be sent. + + .. note:: Since preparing a record for sending it to a Web server is not + the same as a generic formatting operation, using + :meth:`~logging.Handler.setFormatter` to specify a + :class:`~logging.Formatter` for a :class:`HTTPHandler` has no effect. + Instead of calling :meth:`~logging.Handler.format`, this handler calls + :meth:`mapLogRecord` and then :func:`urllib.parse.urlencode` to encode the + dictionary in a form suitable for sending to a Web server. + + +.. _queue-handler: + + +QueueHandler +^^^^^^^^^^^^ + +.. versionadded:: 3.2 + +The :class:`QueueHandler` class, located in the :mod:`logging.handlers` module, +supports sending logging messages to a queue, such as those implemented in the +:mod:`queue` or :mod:`multiprocessing` modules. + +Along with the :class:`QueueListener` class, :class:`QueueHandler` can be used +to let handlers do their work on a separate thread from the one which does the +logging. This is important in Web applications and also other service +applications where threads servicing clients need to respond as quickly as +possible, while any potentially slow operations (such as sending an email via +:class:`SMTPHandler`) are done on a separate thread. + +.. class:: QueueHandler(queue) + + Returns a new instance of the :class:`QueueHandler` class. The instance is + initialized with the queue to send messages to. The *queue* can be any + queue-like object; it's used as-is by the :meth:`enqueue` method, which + needs to know how to send messages to it. The queue is not *required* to + have the task tracking API, which means that you can use + :class:`~queue.SimpleQueue` instances for *queue*. + + + .. method:: emit(record) + + Enqueues the result of preparing the LogRecord. Should an exception + occur (e.g. because a bounded queue has filled up), the + :meth:`~logging.Handler.handleError` method is called to handle the + error. This can result in the record silently being dropped (if + :attr:`logging.raiseExceptions` is ``False``) or a message printed to + ``sys.stderr`` (if :attr:`logging.raiseExceptions` is ``True``). + + .. method:: prepare(record) + + Prepares a record for queuing. The object returned by this + method is enqueued. + + The base implementation formats the record to merge the message, + arguments, and exception information, if present. It also + removes unpickleable items from the record in-place. + + You might want to override this method if you want to convert + the record to a dict or JSON string, or send a modified copy + of the record while leaving the original intact. + + .. method:: enqueue(record) + + Enqueues the record on the queue using ``put_nowait()``; you may + want to override this if you want to use blocking behaviour, or a + timeout, or a customized queue implementation. + + + +.. _queue-listener: + +QueueListener +^^^^^^^^^^^^^ + +.. versionadded:: 3.2 + +The :class:`QueueListener` class, located in the :mod:`logging.handlers` +module, supports receiving logging messages from a queue, such as those +implemented in the :mod:`queue` or :mod:`multiprocessing` modules. The +messages are received from a queue in an internal thread and passed, on +the same thread, to one or more handlers for processing. While +:class:`QueueListener` is not itself a handler, it is documented here +because it works hand-in-hand with :class:`QueueHandler`. + +Along with the :class:`QueueHandler` class, :class:`QueueListener` can be used +to let handlers do their work on a separate thread from the one which does the +logging. This is important in Web applications and also other service +applications where threads servicing clients need to respond as quickly as +possible, while any potentially slow operations (such as sending an email via +:class:`SMTPHandler`) are done on a separate thread. + +.. class:: QueueListener(queue, *handlers, respect_handler_level=False) + + Returns a new instance of the :class:`QueueListener` class. The instance is + initialized with the queue to send messages to and a list of handlers which + will handle entries placed on the queue. The queue can be any queue-like + object; it's passed as-is to the :meth:`dequeue` method, which needs + to know how to get messages from it. The queue is not *required* to have the + task tracking API (though it's used if available), which means that you can + use :class:`~queue.SimpleQueue` instances for *queue*. + + If ``respect_handler_level`` is ``True``, a handler's level is respected + (compared with the level for the message) when deciding whether to pass + messages to that handler; otherwise, the behaviour is as in previous Python + versions - to always pass each message to each handler. + + .. versionchanged:: 3.5 + The ``respect_handler_levels`` argument was added. + + .. method:: dequeue(block) + + Dequeues a record and return it, optionally blocking. + + The base implementation uses ``get()``. You may want to override this + method if you want to use timeouts or work with custom queue + implementations. + + .. method:: prepare(record) + + Prepare a record for handling. + + This implementation just returns the passed-in record. You may want to + override this method if you need to do any custom marshalling or + manipulation of the record before passing it to the handlers. + + .. method:: handle(record) + + Handle a record. + + This just loops through the handlers offering them the record + to handle. The actual object passed to the handlers is that which + is returned from :meth:`prepare`. + + .. method:: start() + + Starts the listener. + + This starts up a background thread to monitor the queue for + LogRecords to process. + + .. method:: stop() + + Stops the listener. + + This asks the thread to terminate, and then waits for it to do so. + Note that if you don't call this before your application exits, there + may be some records still left on the queue, which won't be processed. + + .. method:: enqueue_sentinel() + + Writes a sentinel to the queue to tell the listener to quit. This + implementation uses ``put_nowait()``. You may want to override this + method if you want to use timeouts or work with custom queue + implementations. + + .. versionadded:: 3.3 + + +.. seealso:: + + Module :mod:`logging` + API reference for the logging module. + + Module :mod:`logging.config` + Configuration API for the logging module. + + diff --git a/python-3.7.4-docs-html/_sources/library/logging.rst.txt b/python-3.7.4-docs-html/_sources/library/logging.rst.txt new file mode 100644 index 0000000..73ce9ad --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/logging.rst.txt @@ -0,0 +1,1280 @@ +:mod:`logging` --- Logging facility for Python +============================================== + +.. module:: logging + :synopsis: Flexible event logging system for applications. + +.. moduleauthor:: Vinay Sajip +.. sectionauthor:: Vinay Sajip + +**Source code:** :source:`Lib/logging/__init__.py` + +.. index:: pair: Errors; logging + +.. sidebar:: Important + + This page contains the API reference information. For tutorial + information and discussion of more advanced topics, see + + * :ref:`Basic Tutorial ` + * :ref:`Advanced Tutorial ` + * :ref:`Logging Cookbook ` + +-------------- + +This module defines functions and classes which implement a flexible event +logging system for applications and libraries. + +The key benefit of having the logging API provided by a standard library module +is that all Python modules can participate in logging, so your application log +can include your own messages integrated with messages from third-party +modules. + +The module provides a lot of functionality and flexibility. If you are +unfamiliar with logging, the best way to get to grips with it is to see the +tutorials (see the links on the right). + +The basic classes defined by the module, together with their functions, are +listed below. + +* Loggers expose the interface that application code directly uses. +* Handlers send the log records (created by loggers) to the appropriate + destination. +* Filters provide a finer grained facility for determining which log records + to output. +* Formatters specify the layout of log records in the final output. + + +.. _logger: + +Logger Objects +-------------- + +Loggers have the following attributes and methods. Note that Loggers should +*NEVER* be instantiated directly, but always through the module-level function +``logging.getLogger(name)``. Multiple calls to :func:`getLogger` with the same +name will always return a reference to the same Logger object. + +The ``name`` is potentially a period-separated hierarchical value, like +``foo.bar.baz`` (though it could also be just plain ``foo``, for example). +Loggers that are further down in the hierarchical list are children of loggers +higher up in the list. For example, given a logger with a name of ``foo``, +loggers with names of ``foo.bar``, ``foo.bar.baz``, and ``foo.bam`` are all +descendants of ``foo``. The logger name hierarchy is analogous to the Python +package hierarchy, and identical to it if you organise your loggers on a +per-module basis using the recommended construction +``logging.getLogger(__name__)``. That's because in a module, ``__name__`` +is the module's name in the Python package namespace. + + +.. class:: Logger + + .. attribute:: Logger.propagate + + If this attribute evaluates to true, events logged to this logger will be + passed to the handlers of higher level (ancestor) loggers, in addition to + any handlers attached to this logger. Messages are passed directly to the + ancestor loggers' handlers - neither the level nor filters of the ancestor + loggers in question are considered. + + If this evaluates to false, logging messages are not passed to the handlers + of ancestor loggers. + + The constructor sets this attribute to ``True``. + + .. note:: If you attach a handler to a logger *and* one or more of its + ancestors, it may emit the same record multiple times. In general, you + should not need to attach a handler to more than one logger - if you just + attach it to the appropriate logger which is highest in the logger + hierarchy, then it will see all events logged by all descendant loggers, + provided that their propagate setting is left set to ``True``. A common + scenario is to attach handlers only to the root logger, and to let + propagation take care of the rest. + + .. method:: Logger.setLevel(level) + + Sets the threshold for this logger to *level*. Logging messages which are less + severe than *level* will be ignored; logging messages which have severity *level* + or higher will be emitted by whichever handler or handlers service this logger, + unless a handler's level has been set to a higher severity level than *level*. + + When a logger is created, the level is set to :const:`NOTSET` (which causes + all messages to be processed when the logger is the root logger, or delegation + to the parent when the logger is a non-root logger). Note that the root logger + is created with level :const:`WARNING`. + + The term 'delegation to the parent' means that if a logger has a level of + NOTSET, its chain of ancestor loggers is traversed until either an ancestor with + a level other than NOTSET is found, or the root is reached. + + If an ancestor is found with a level other than NOTSET, then that ancestor's + level is treated as the effective level of the logger where the ancestor search + began, and is used to determine how a logging event is handled. + + If the root is reached, and it has a level of NOTSET, then all messages will be + processed. Otherwise, the root's level will be used as the effective level. + + See :ref:`levels` for a list of levels. + + .. versionchanged:: 3.2 + The *level* parameter now accepts a string representation of the + level such as 'INFO' as an alternative to the integer constants + such as :const:`INFO`. Note, however, that levels are internally stored + as integers, and methods such as e.g. :meth:`getEffectiveLevel` and + :meth:`isEnabledFor` will return/expect to be passed integers. + + + .. method:: Logger.isEnabledFor(lvl) + + Indicates if a message of severity *lvl* would be processed by this logger. + This method checks first the module-level level set by + ``logging.disable(lvl)`` and then the logger's effective level as determined + by :meth:`getEffectiveLevel`. + + + .. method:: Logger.getEffectiveLevel() + + Indicates the effective level for this logger. If a value other than + :const:`NOTSET` has been set using :meth:`setLevel`, it is returned. Otherwise, + the hierarchy is traversed towards the root until a value other than + :const:`NOTSET` is found, and that value is returned. The value returned is + an integer, typically one of :const:`logging.DEBUG`, :const:`logging.INFO` + etc. + + + .. method:: Logger.getChild(suffix) + + Returns a logger which is a descendant to this logger, as determined by the suffix. + Thus, ``logging.getLogger('abc').getChild('def.ghi')`` would return the same + logger as would be returned by ``logging.getLogger('abc.def.ghi')``. This is a + convenience method, useful when the parent logger is named using e.g. ``__name__`` + rather than a literal string. + + .. versionadded:: 3.2 + + + .. method:: Logger.debug(msg, *args, **kwargs) + + Logs a message with level :const:`DEBUG` on this logger. The *msg* is the + message format string, and the *args* are the arguments which are merged into + *msg* using the string formatting operator. (Note that this means that you can + use keywords in the format string, together with a single dictionary argument.) + + There are three keyword arguments in *kwargs* which are inspected: + *exc_info*, *stack_info*, and *extra*. + + If *exc_info* does not evaluate as false, it causes exception information to be + added to the logging message. If an exception tuple (in the format returned by + :func:`sys.exc_info`) or an exception instance is provided, it is used; + otherwise, :func:`sys.exc_info` is called to get the exception information. + + The second optional keyword argument is *stack_info*, which defaults to + ``False``. If true, stack information is added to the logging + message, including the actual logging call. Note that this is not the same + stack information as that displayed through specifying *exc_info*: The + former is stack frames from the bottom of the stack up to the logging call + in the current thread, whereas the latter is information about stack frames + which have been unwound, following an exception, while searching for + exception handlers. + + You can specify *stack_info* independently of *exc_info*, e.g. to just show + how you got to a certain point in your code, even when no exceptions were + raised. The stack frames are printed following a header line which says: + + .. code-block:: none + + Stack (most recent call last): + + This mimics the ``Traceback (most recent call last):`` which is used when + displaying exception frames. + + The third keyword argument is *extra* which can be used to pass a + dictionary which is used to populate the __dict__ of the LogRecord created for + the logging event with user-defined attributes. These custom attributes can then + be used as you like. For example, they could be incorporated into logged + messages. For example:: + + FORMAT = '%(asctime)-15s %(clientip)s %(user)-8s %(message)s' + logging.basicConfig(format=FORMAT) + d = {'clientip': '192.168.0.1', 'user': 'fbloggs'} + logger = logging.getLogger('tcpserver') + logger.warning('Protocol problem: %s', 'connection reset', extra=d) + + would print something like + + .. code-block:: none + + 2006-02-08 22:20:02,165 192.168.0.1 fbloggs Protocol problem: connection reset + + The keys in the dictionary passed in *extra* should not clash with the keys used + by the logging system. (See the :class:`Formatter` documentation for more + information on which keys are used by the logging system.) + + If you choose to use these attributes in logged messages, you need to exercise + some care. In the above example, for instance, the :class:`Formatter` has been + set up with a format string which expects 'clientip' and 'user' in the attribute + dictionary of the LogRecord. If these are missing, the message will not be + logged because a string formatting exception will occur. So in this case, you + always need to pass the *extra* dictionary with these keys. + + While this might be annoying, this feature is intended for use in specialized + circumstances, such as multi-threaded servers where the same code executes in + many contexts, and interesting conditions which arise are dependent on this + context (such as remote client IP address and authenticated user name, in the + above example). In such circumstances, it is likely that specialized + :class:`Formatter`\ s would be used with particular :class:`Handler`\ s. + + .. versionadded:: 3.2 + The *stack_info* parameter was added. + + .. versionchanged:: 3.5 + The *exc_info* parameter can now accept exception instances. + + + .. method:: Logger.info(msg, *args, **kwargs) + + Logs a message with level :const:`INFO` on this logger. The arguments are + interpreted as for :meth:`debug`. + + + .. method:: Logger.warning(msg, *args, **kwargs) + + Logs a message with level :const:`WARNING` on this logger. The arguments are + interpreted as for :meth:`debug`. + + .. note:: There is an obsolete method ``warn`` which is functionally + identical to ``warning``. As ``warn`` is deprecated, please do not use + it - use ``warning`` instead. + + .. method:: Logger.error(msg, *args, **kwargs) + + Logs a message with level :const:`ERROR` on this logger. The arguments are + interpreted as for :meth:`debug`. + + + .. method:: Logger.critical(msg, *args, **kwargs) + + Logs a message with level :const:`CRITICAL` on this logger. The arguments are + interpreted as for :meth:`debug`. + + + .. method:: Logger.log(lvl, msg, *args, **kwargs) + + Logs a message with integer level *lvl* on this logger. The other arguments are + interpreted as for :meth:`debug`. + + + .. method:: Logger.exception(msg, *args, **kwargs) + + Logs a message with level :const:`ERROR` on this logger. The arguments are + interpreted as for :meth:`debug`. Exception info is added to the logging + message. This method should only be called from an exception handler. + + + .. method:: Logger.addFilter(filter) + + Adds the specified filter *filter* to this logger. + + + .. method:: Logger.removeFilter(filter) + + Removes the specified filter *filter* from this logger. + + + .. method:: Logger.filter(record) + + Applies this logger's filters to the record and returns a true value if the + record is to be processed. The filters are consulted in turn, until one of + them returns a false value. If none of them return a false value, the record + will be processed (passed to handlers). If one returns a false value, no + further processing of the record occurs. + + + .. method:: Logger.addHandler(hdlr) + + Adds the specified handler *hdlr* to this logger. + + + .. method:: Logger.removeHandler(hdlr) + + Removes the specified handler *hdlr* from this logger. + + + .. method:: Logger.findCaller(stack_info=False) + + Finds the caller's source filename and line number. Returns the filename, line + number, function name and stack information as a 4-element tuple. The stack + information is returned as ``None`` unless *stack_info* is ``True``. + + + .. method:: Logger.handle(record) + + Handles a record by passing it to all handlers associated with this logger and + its ancestors (until a false value of *propagate* is found). This method is used + for unpickled records received from a socket, as well as those created locally. + Logger-level filtering is applied using :meth:`~Logger.filter`. + + + .. method:: Logger.makeRecord(name, lvl, fn, lno, msg, args, exc_info, func=None, extra=None, sinfo=None) + + This is a factory method which can be overridden in subclasses to create + specialized :class:`LogRecord` instances. + + .. method:: Logger.hasHandlers() + + Checks to see if this logger has any handlers configured. This is done by + looking for handlers in this logger and its parents in the logger hierarchy. + Returns ``True`` if a handler was found, else ``False``. The method stops searching + up the hierarchy whenever a logger with the 'propagate' attribute set to + false is found - that will be the last logger which is checked for the + existence of handlers. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.7 + Loggers can now be pickled and unpickled. + +.. _levels: + +Logging Levels +-------------- + +The numeric values of logging levels are given in the following table. These are +primarily of interest if you want to define your own levels, and need them to +have specific values relative to the predefined levels. If you define a level +with the same numeric value, it overwrites the predefined value; the predefined +name is lost. + ++--------------+---------------+ +| Level | Numeric value | ++==============+===============+ +| ``CRITICAL`` | 50 | ++--------------+---------------+ +| ``ERROR`` | 40 | ++--------------+---------------+ +| ``WARNING`` | 30 | ++--------------+---------------+ +| ``INFO`` | 20 | ++--------------+---------------+ +| ``DEBUG`` | 10 | ++--------------+---------------+ +| ``NOTSET`` | 0 | ++--------------+---------------+ + + +.. _handler: + +Handler Objects +--------------- + +Handlers have the following attributes and methods. Note that :class:`Handler` +is never instantiated directly; this class acts as a base for more useful +subclasses. However, the :meth:`__init__` method in subclasses needs to call +:meth:`Handler.__init__`. + +.. class:: Handler + + .. method:: Handler.__init__(level=NOTSET) + + Initializes the :class:`Handler` instance by setting its level, setting the list + of filters to the empty list and creating a lock (using :meth:`createLock`) for + serializing access to an I/O mechanism. + + + .. method:: Handler.createLock() + + Initializes a thread lock which can be used to serialize access to underlying + I/O functionality which may not be threadsafe. + + + .. method:: Handler.acquire() + + Acquires the thread lock created with :meth:`createLock`. + + + .. method:: Handler.release() + + Releases the thread lock acquired with :meth:`acquire`. + + + .. method:: Handler.setLevel(level) + + Sets the threshold for this handler to *level*. Logging messages which are + less severe than *level* will be ignored. When a handler is created, the + level is set to :const:`NOTSET` (which causes all messages to be + processed). + + See :ref:`levels` for a list of levels. + + .. versionchanged:: 3.2 + The *level* parameter now accepts a string representation of the + level such as 'INFO' as an alternative to the integer constants + such as :const:`INFO`. + + + .. method:: Handler.setFormatter(fmt) + + Sets the :class:`Formatter` for this handler to *fmt*. + + + .. method:: Handler.addFilter(filter) + + Adds the specified filter *filter* to this handler. + + + .. method:: Handler.removeFilter(filter) + + Removes the specified filter *filter* from this handler. + + + .. method:: Handler.filter(record) + + Applies this handler's filters to the record and returns a true value if the + record is to be processed. The filters are consulted in turn, until one of + them returns a false value. If none of them return a false value, the record + will be emitted. If one returns a false value, the handler will not emit the + record. + + + .. method:: Handler.flush() + + Ensure all logging output has been flushed. This version does nothing and is + intended to be implemented by subclasses. + + + .. method:: Handler.close() + + Tidy up any resources used by the handler. This version does no output but + removes the handler from an internal list of handlers which is closed when + :func:`shutdown` is called. Subclasses should ensure that this gets called + from overridden :meth:`close` methods. + + + .. method:: Handler.handle(record) + + Conditionally emits the specified logging record, depending on filters which may + have been added to the handler. Wraps the actual emission of the record with + acquisition/release of the I/O thread lock. + + + .. method:: Handler.handleError(record) + + This method should be called from handlers when an exception is encountered + during an :meth:`emit` call. If the module-level attribute + ``raiseExceptions`` is ``False``, exceptions get silently ignored. This is + what is mostly wanted for a logging system - most users will not care about + errors in the logging system, they are more interested in application + errors. You could, however, replace this with a custom handler if you wish. + The specified record is the one which was being processed when the exception + occurred. (The default value of ``raiseExceptions`` is ``True``, as that is + more useful during development). + + + .. method:: Handler.format(record) + + Do formatting for a record - if a formatter is set, use it. Otherwise, use the + default formatter for the module. + + + .. method:: Handler.emit(record) + + Do whatever it takes to actually log the specified logging record. This version + is intended to be implemented by subclasses and so raises a + :exc:`NotImplementedError`. + +For a list of handlers included as standard, see :mod:`logging.handlers`. + +.. _formatter-objects: + +Formatter Objects +----------------- + +.. currentmodule:: logging + +:class:`Formatter` objects have the following attributes and methods. They are +responsible for converting a :class:`LogRecord` to (usually) a string which can +be interpreted by either a human or an external system. The base +:class:`Formatter` allows a formatting string to be specified. If none is +supplied, the default value of ``'%(message)s'`` is used, which just includes +the message in the logging call. To have additional items of information in the +formatted output (such as a timestamp), keep reading. + +A Formatter can be initialized with a format string which makes use of knowledge +of the :class:`LogRecord` attributes - such as the default value mentioned above +making use of the fact that the user's message and arguments are pre-formatted +into a :class:`LogRecord`'s *message* attribute. This format string contains +standard Python %-style mapping keys. See section :ref:`old-string-formatting` +for more information on string formatting. + +The useful mapping keys in a :class:`LogRecord` are given in the section on +:ref:`logrecord-attributes`. + + +.. class:: Formatter(fmt=None, datefmt=None, style='%') + + Returns a new instance of the :class:`Formatter` class. The instance is + initialized with a format string for the message as a whole, as well as a + format string for the date/time portion of a message. If no *fmt* is + specified, ``'%(message)s'`` is used. If no *datefmt* is specified, a format + is used which is described in the :meth:`formatTime` documentation. + + The *style* parameter can be one of '%', '{' or '$' and determines how + the format string will be merged with its data: using one of %-formatting, + :meth:`str.format` or :class:`string.Template`. See :ref:`formatting-styles` + for more information on using {- and $-formatting for log messages. + + .. versionchanged:: 3.2 + The *style* parameter was added. + + + .. method:: format(record) + + The record's attribute dictionary is used as the operand to a string + formatting operation. Returns the resulting string. Before formatting the + dictionary, a couple of preparatory steps are carried out. The *message* + attribute of the record is computed using *msg* % *args*. If the + formatting string contains ``'(asctime)'``, :meth:`formatTime` is called + to format the event time. If there is exception information, it is + formatted using :meth:`formatException` and appended to the message. Note + that the formatted exception information is cached in attribute + *exc_text*. This is useful because the exception information can be + pickled and sent across the wire, but you should be careful if you have + more than one :class:`Formatter` subclass which customizes the formatting + of exception information. In this case, you will have to clear the cached + value after a formatter has done its formatting, so that the next + formatter to handle the event doesn't use the cached value but + recalculates it afresh. + + If stack information is available, it's appended after the exception + information, using :meth:`formatStack` to transform it if necessary. + + + .. method:: formatTime(record, datefmt=None) + + This method should be called from :meth:`format` by a formatter which + wants to make use of a formatted time. This method can be overridden in + formatters to provide for any specific requirement, but the basic behavior + is as follows: if *datefmt* (a string) is specified, it is used with + :func:`time.strftime` to format the creation time of the + record. Otherwise, the format '%Y-%m-%d %H:%M:%S,uuu' is used, where the + uuu part is a millisecond value and the other letters are as per the + :func:`time.strftime` documentation. An example time in this format is + ``2003-01-23 00:29:50,411``. The resulting string is returned. + + This function uses a user-configurable function to convert the creation + time to a tuple. By default, :func:`time.localtime` is used; to change + this for a particular formatter instance, set the ``converter`` attribute + to a function with the same signature as :func:`time.localtime` or + :func:`time.gmtime`. To change it for all formatters, for example if you + want all logging times to be shown in GMT, set the ``converter`` + attribute in the ``Formatter`` class. + + .. versionchanged:: 3.3 + Previously, the default format was hard-coded as in this example: + ``2010-09-06 22:38:15,292`` where the part before the comma is + handled by a strptime format string (``'%Y-%m-%d %H:%M:%S'``), and the + part after the comma is a millisecond value. Because strptime does not + have a format placeholder for milliseconds, the millisecond value is + appended using another format string, ``'%s,%03d'`` --- and both of these + format strings have been hardcoded into this method. With the change, + these strings are defined as class-level attributes which can be + overridden at the instance level when desired. The names of the + attributes are ``default_time_format`` (for the strptime format string) + and ``default_msec_format`` (for appending the millisecond value). + + .. method:: formatException(exc_info) + + Formats the specified exception information (a standard exception tuple as + returned by :func:`sys.exc_info`) as a string. This default implementation + just uses :func:`traceback.print_exception`. The resulting string is + returned. + + .. method:: formatStack(stack_info) + + Formats the specified stack information (a string as returned by + :func:`traceback.print_stack`, but with the last newline removed) as a + string. This default implementation just returns the input value. + +.. _filter: + +Filter Objects +-------------- + +``Filters`` can be used by ``Handlers`` and ``Loggers`` for more sophisticated +filtering than is provided by levels. The base filter class only allows events +which are below a certain point in the logger hierarchy. For example, a filter +initialized with 'A.B' will allow events logged by loggers 'A.B', 'A.B.C', +'A.B.C.D', 'A.B.D' etc. but not 'A.BB', 'B.A.B' etc. If initialized with the +empty string, all events are passed. + + +.. class:: Filter(name='') + + Returns an instance of the :class:`Filter` class. If *name* is specified, it + names a logger which, together with its children, will have its events allowed + through the filter. If *name* is the empty string, allows every event. + + + .. method:: filter(record) + + Is the specified record to be logged? Returns zero for no, nonzero for + yes. If deemed appropriate, the record may be modified in-place by this + method. + +Note that filters attached to handlers are consulted before an event is +emitted by the handler, whereas filters attached to loggers are consulted +whenever an event is logged (using :meth:`debug`, :meth:`info`, +etc.), before sending an event to handlers. This means that events which have +been generated by descendant loggers will not be filtered by a logger's filter +setting, unless the filter has also been applied to those descendant loggers. + +You don't actually need to subclass ``Filter``: you can pass any instance +which has a ``filter`` method with the same semantics. + +.. versionchanged:: 3.2 + You don't need to create specialized ``Filter`` classes, or use other + classes with a ``filter`` method: you can use a function (or other + callable) as a filter. The filtering logic will check to see if the filter + object has a ``filter`` attribute: if it does, it's assumed to be a + ``Filter`` and its :meth:`~Filter.filter` method is called. Otherwise, it's + assumed to be a callable and called with the record as the single + parameter. The returned value should conform to that returned by + :meth:`~Filter.filter`. + +Although filters are used primarily to filter records based on more +sophisticated criteria than levels, they get to see every record which is +processed by the handler or logger they're attached to: this can be useful if +you want to do things like counting how many records were processed by a +particular logger or handler, or adding, changing or removing attributes in +the LogRecord being processed. Obviously changing the LogRecord needs to be +done with some care, but it does allow the injection of contextual information +into logs (see :ref:`filters-contextual`). + +.. _log-record: + +LogRecord Objects +----------------- + +:class:`LogRecord` instances are created automatically by the :class:`Logger` +every time something is logged, and can be created manually via +:func:`makeLogRecord` (for example, from a pickled event received over the +wire). + + +.. class:: LogRecord(name, level, pathname, lineno, msg, args, exc_info, func=None, sinfo=None) + + Contains all the information pertinent to the event being logged. + + The primary information is passed in :attr:`msg` and :attr:`args`, which + are combined using ``msg % args`` to create the :attr:`message` field of the + record. + + :param name: The name of the logger used to log the event represented by + this LogRecord. Note that this name will always have this + value, even though it may be emitted by a handler attached to + a different (ancestor) logger. + :param level: The numeric level of the logging event (one of DEBUG, INFO etc.) + Note that this is converted to *two* attributes of the LogRecord: + ``levelno`` for the numeric value and ``levelname`` for the + corresponding level name. + :param pathname: The full pathname of the source file where the logging call + was made. + :param lineno: The line number in the source file where the logging call was + made. + :param msg: The event description message, possibly a format string with + placeholders for variable data. + :param args: Variable data to merge into the *msg* argument to obtain the + event description. + :param exc_info: An exception tuple with the current exception information, + or ``None`` if no exception information is available. + :param func: The name of the function or method from which the logging call + was invoked. + :param sinfo: A text string representing stack information from the base of + the stack in the current thread, up to the logging call. + + .. method:: getMessage() + + Returns the message for this :class:`LogRecord` instance after merging any + user-supplied arguments with the message. If the user-supplied message + argument to the logging call is not a string, :func:`str` is called on it to + convert it to a string. This allows use of user-defined classes as + messages, whose ``__str__`` method can return the actual format string to + be used. + + .. versionchanged:: 3.2 + The creation of a ``LogRecord`` has been made more configurable by + providing a factory which is used to create the record. The factory can be + set using :func:`getLogRecordFactory` and :func:`setLogRecordFactory` + (see this for the factory's signature). + + This functionality can be used to inject your own values into a + LogRecord at creation time. You can use the following pattern:: + + old_factory = logging.getLogRecordFactory() + + def record_factory(*args, **kwargs): + record = old_factory(*args, **kwargs) + record.custom_attribute = 0xdecafbad + return record + + logging.setLogRecordFactory(record_factory) + + With this pattern, multiple factories could be chained, and as long + as they don't overwrite each other's attributes or unintentionally + overwrite the standard attributes listed above, there should be no + surprises. + + +.. _logrecord-attributes: + +LogRecord attributes +-------------------- + +The LogRecord has a number of attributes, most of which are derived from the +parameters to the constructor. (Note that the names do not always correspond +exactly between the LogRecord constructor parameters and the LogRecord +attributes.) These attributes can be used to merge data from the record into +the format string. The following table lists (in alphabetical order) the +attribute names, their meanings and the corresponding placeholder in a %-style +format string. + +If you are using {}-formatting (:func:`str.format`), you can use +``{attrname}`` as the placeholder in the format string. If you are using +$-formatting (:class:`string.Template`), use the form ``${attrname}``. In +both cases, of course, replace ``attrname`` with the actual attribute name +you want to use. + +In the case of {}-formatting, you can specify formatting flags by placing them +after the attribute name, separated from it with a colon. For example: a +placeholder of ``{msecs:03d}`` would format a millisecond value of ``4`` as +``004``. Refer to the :meth:`str.format` documentation for full details on +the options available to you. + ++----------------+-------------------------+-----------------------------------------------+ +| Attribute name | Format | Description | ++================+=========================+===============================================+ +| args | You shouldn't need to | The tuple of arguments merged into ``msg`` to | +| | format this yourself. | produce ``message``, or a dict whose values | +| | | are used for the merge (when there is only one| +| | | argument, and it is a dictionary). | ++----------------+-------------------------+-----------------------------------------------+ +| asctime | ``%(asctime)s`` | Human-readable time when the | +| | | :class:`LogRecord` was created. By default | +| | | this is of the form '2003-07-08 16:49:45,896' | +| | | (the numbers after the comma are millisecond | +| | | portion of the time). | ++----------------+-------------------------+-----------------------------------------------+ +| created | ``%(created)f`` | Time when the :class:`LogRecord` was created | +| | | (as returned by :func:`time.time`). | ++----------------+-------------------------+-----------------------------------------------+ +| exc_info | You shouldn't need to | Exception tuple (à la ``sys.exc_info``) or, | +| | format this yourself. | if no exception has occurred, ``None``. | ++----------------+-------------------------+-----------------------------------------------+ +| filename | ``%(filename)s`` | Filename portion of ``pathname``. | ++----------------+-------------------------+-----------------------------------------------+ +| funcName | ``%(funcName)s`` | Name of function containing the logging call. | ++----------------+-------------------------+-----------------------------------------------+ +| levelname | ``%(levelname)s`` | Text logging level for the message | +| | | (``'DEBUG'``, ``'INFO'``, ``'WARNING'``, | +| | | ``'ERROR'``, ``'CRITICAL'``). | ++----------------+-------------------------+-----------------------------------------------+ +| levelno | ``%(levelno)s`` | Numeric logging level for the message | +| | | (:const:`DEBUG`, :const:`INFO`, | +| | | :const:`WARNING`, :const:`ERROR`, | +| | | :const:`CRITICAL`). | ++----------------+-------------------------+-----------------------------------------------+ +| lineno | ``%(lineno)d`` | Source line number where the logging call was | +| | | issued (if available). | ++----------------+-------------------------+-----------------------------------------------+ +| message | ``%(message)s`` | The logged message, computed as ``msg % | +| | | args``. This is set when | +| | | :meth:`Formatter.format` is invoked. | ++----------------+-------------------------+-----------------------------------------------+ +| module | ``%(module)s`` | Module (name portion of ``filename``). | ++----------------+-------------------------+-----------------------------------------------+ +| msecs | ``%(msecs)d`` | Millisecond portion of the time when the | +| | | :class:`LogRecord` was created. | ++----------------+-------------------------+-----------------------------------------------+ +| msg | You shouldn't need to | The format string passed in the original | +| | format this yourself. | logging call. Merged with ``args`` to | +| | | produce ``message``, or an arbitrary object | +| | | (see :ref:`arbitrary-object-messages`). | ++----------------+-------------------------+-----------------------------------------------+ +| name | ``%(name)s`` | Name of the logger used to log the call. | ++----------------+-------------------------+-----------------------------------------------+ +| pathname | ``%(pathname)s`` | Full pathname of the source file where the | +| | | logging call was issued (if available). | ++----------------+-------------------------+-----------------------------------------------+ +| process | ``%(process)d`` | Process ID (if available). | ++----------------+-------------------------+-----------------------------------------------+ +| processName | ``%(processName)s`` | Process name (if available). | ++----------------+-------------------------+-----------------------------------------------+ +| relativeCreated| ``%(relativeCreated)d`` | Time in milliseconds when the LogRecord was | +| | | created, relative to the time the logging | +| | | module was loaded. | ++----------------+-------------------------+-----------------------------------------------+ +| stack_info | You shouldn't need to | Stack frame information (where available) | +| | format this yourself. | from the bottom of the stack in the current | +| | | thread, up to and including the stack frame | +| | | of the logging call which resulted in the | +| | | creation of this record. | ++----------------+-------------------------+-----------------------------------------------+ +| thread | ``%(thread)d`` | Thread ID (if available). | ++----------------+-------------------------+-----------------------------------------------+ +| threadName | ``%(threadName)s`` | Thread name (if available). | ++----------------+-------------------------+-----------------------------------------------+ + +.. versionchanged:: 3.1 + *processName* was added. + + +.. _logger-adapter: + +LoggerAdapter Objects +--------------------- + +:class:`LoggerAdapter` instances are used to conveniently pass contextual +information into logging calls. For a usage example, see the section on +:ref:`adding contextual information to your logging output `. + +.. class:: LoggerAdapter(logger, extra) + + Returns an instance of :class:`LoggerAdapter` initialized with an + underlying :class:`Logger` instance and a dict-like object. + + .. method:: process(msg, kwargs) + + Modifies the message and/or keyword arguments passed to a logging call in + order to insert contextual information. This implementation takes the object + passed as *extra* to the constructor and adds it to *kwargs* using key + 'extra'. The return value is a (*msg*, *kwargs*) tuple which has the + (possibly modified) versions of the arguments passed in. + +In addition to the above, :class:`LoggerAdapter` supports the following +methods of :class:`Logger`: :meth:`~Logger.debug`, :meth:`~Logger.info`, +:meth:`~Logger.warning`, :meth:`~Logger.error`, :meth:`~Logger.exception`, +:meth:`~Logger.critical`, :meth:`~Logger.log`, :meth:`~Logger.isEnabledFor`, +:meth:`~Logger.getEffectiveLevel`, :meth:`~Logger.setLevel` and +:meth:`~Logger.hasHandlers`. These methods have the same signatures as their +counterparts in :class:`Logger`, so you can use the two types of instances +interchangeably. + +.. versionchanged:: 3.2 + The :meth:`~Logger.isEnabledFor`, :meth:`~Logger.getEffectiveLevel`, + :meth:`~Logger.setLevel` and :meth:`~Logger.hasHandlers` methods were added + to :class:`LoggerAdapter`. These methods delegate to the underlying logger. + + +Thread Safety +------------- + +The logging module is intended to be thread-safe without any special work +needing to be done by its clients. It achieves this though using threading +locks; there is one lock to serialize access to the module's shared data, and +each handler also creates a lock to serialize access to its underlying I/O. + +If you are implementing asynchronous signal handlers using the :mod:`signal` +module, you may not be able to use logging from within such handlers. This is +because lock implementations in the :mod:`threading` module are not always +re-entrant, and so cannot be invoked from such signal handlers. + + +Module-Level Functions +---------------------- + +In addition to the classes described above, there are a number of module-level +functions. + + +.. function:: getLogger(name=None) + + Return a logger with the specified name or, if name is ``None``, return a + logger which is the root logger of the hierarchy. If specified, the name is + typically a dot-separated hierarchical name like *'a'*, *'a.b'* or *'a.b.c.d'*. + Choice of these names is entirely up to the developer who is using logging. + + All calls to this function with a given name return the same logger instance. + This means that logger instances never need to be passed between different parts + of an application. + + +.. function:: getLoggerClass() + + Return either the standard :class:`Logger` class, or the last class passed to + :func:`setLoggerClass`. This function may be called from within a new class + definition, to ensure that installing a customized :class:`Logger` class will + not undo customizations already applied by other code. For example:: + + class MyLogger(logging.getLoggerClass()): + # ... override behaviour here + + +.. function:: getLogRecordFactory() + + Return a callable which is used to create a :class:`LogRecord`. + + .. versionadded:: 3.2 + This function has been provided, along with :func:`setLogRecordFactory`, + to allow developers more control over how the :class:`LogRecord` + representing a logging event is constructed. + + See :func:`setLogRecordFactory` for more information about the how the + factory is called. + +.. function:: debug(msg, *args, **kwargs) + + Logs a message with level :const:`DEBUG` on the root logger. The *msg* is the + message format string, and the *args* are the arguments which are merged into + *msg* using the string formatting operator. (Note that this means that you can + use keywords in the format string, together with a single dictionary argument.) + + There are three keyword arguments in *kwargs* which are inspected: *exc_info* + which, if it does not evaluate as false, causes exception information to be + added to the logging message. If an exception tuple (in the format returned by + :func:`sys.exc_info`) or an exception instance is provided, it is used; + otherwise, :func:`sys.exc_info` is called to get the exception information. + + The second optional keyword argument is *stack_info*, which defaults to + ``False``. If true, stack information is added to the logging + message, including the actual logging call. Note that this is not the same + stack information as that displayed through specifying *exc_info*: The + former is stack frames from the bottom of the stack up to the logging call + in the current thread, whereas the latter is information about stack frames + which have been unwound, following an exception, while searching for + exception handlers. + + You can specify *stack_info* independently of *exc_info*, e.g. to just show + how you got to a certain point in your code, even when no exceptions were + raised. The stack frames are printed following a header line which says: + + .. code-block:: none + + Stack (most recent call last): + + This mimics the ``Traceback (most recent call last):`` which is used when + displaying exception frames. + + The third optional keyword argument is *extra* which can be used to pass a + dictionary which is used to populate the __dict__ of the LogRecord created for + the logging event with user-defined attributes. These custom attributes can then + be used as you like. For example, they could be incorporated into logged + messages. For example:: + + FORMAT = '%(asctime)-15s %(clientip)s %(user)-8s %(message)s' + logging.basicConfig(format=FORMAT) + d = {'clientip': '192.168.0.1', 'user': 'fbloggs'} + logging.warning('Protocol problem: %s', 'connection reset', extra=d) + + would print something like: + + .. code-block:: none + + 2006-02-08 22:20:02,165 192.168.0.1 fbloggs Protocol problem: connection reset + + The keys in the dictionary passed in *extra* should not clash with the keys used + by the logging system. (See the :class:`Formatter` documentation for more + information on which keys are used by the logging system.) + + If you choose to use these attributes in logged messages, you need to exercise + some care. In the above example, for instance, the :class:`Formatter` has been + set up with a format string which expects 'clientip' and 'user' in the attribute + dictionary of the LogRecord. If these are missing, the message will not be + logged because a string formatting exception will occur. So in this case, you + always need to pass the *extra* dictionary with these keys. + + While this might be annoying, this feature is intended for use in specialized + circumstances, such as multi-threaded servers where the same code executes in + many contexts, and interesting conditions which arise are dependent on this + context (such as remote client IP address and authenticated user name, in the + above example). In such circumstances, it is likely that specialized + :class:`Formatter`\ s would be used with particular :class:`Handler`\ s. + + .. versionadded:: 3.2 + The *stack_info* parameter was added. + +.. function:: info(msg, *args, **kwargs) + + Logs a message with level :const:`INFO` on the root logger. The arguments are + interpreted as for :func:`debug`. + + +.. function:: warning(msg, *args, **kwargs) + + Logs a message with level :const:`WARNING` on the root logger. The arguments + are interpreted as for :func:`debug`. + + .. note:: There is an obsolete function ``warn`` which is functionally + identical to ``warning``. As ``warn`` is deprecated, please do not use + it - use ``warning`` instead. + + +.. function:: error(msg, *args, **kwargs) + + Logs a message with level :const:`ERROR` on the root logger. The arguments are + interpreted as for :func:`debug`. + + +.. function:: critical(msg, *args, **kwargs) + + Logs a message with level :const:`CRITICAL` on the root logger. The arguments + are interpreted as for :func:`debug`. + + +.. function:: exception(msg, *args, **kwargs) + + Logs a message with level :const:`ERROR` on the root logger. The arguments are + interpreted as for :func:`debug`. Exception info is added to the logging + message. This function should only be called from an exception handler. + +.. function:: log(level, msg, *args, **kwargs) + + Logs a message with level *level* on the root logger. The other arguments are + interpreted as for :func:`debug`. + + .. note:: The above module-level convenience functions, which delegate to the + root logger, call :func:`basicConfig` to ensure that at least one handler + is available. Because of this, they should *not* be used in threads, + in versions of Python earlier than 2.7.1 and 3.2, unless at least one + handler has been added to the root logger *before* the threads are + started. In earlier versions of Python, due to a thread safety shortcoming + in :func:`basicConfig`, this can (under rare circumstances) lead to + handlers being added multiple times to the root logger, which can in turn + lead to multiple messages for the same event. + +.. function:: disable(lvl=CRITICAL) + + Provides an overriding level *lvl* for all loggers which takes precedence over + the logger's own level. When the need arises to temporarily throttle logging + output down across the whole application, this function can be useful. Its + effect is to disable all logging calls of severity *lvl* and below, so that + if you call it with a value of INFO, then all INFO and DEBUG events would be + discarded, whereas those of severity WARNING and above would be processed + according to the logger's effective level. If + ``logging.disable(logging.NOTSET)`` is called, it effectively removes this + overriding level, so that logging output again depends on the effective + levels of individual loggers. + + Note that if you have defined any custom logging level higher than + ``CRITICAL`` (this is not recommended), you won't be able to rely on the + default value for the *lvl* parameter, but will have to explicitly supply a + suitable value. + + .. versionchanged:: 3.7 + The *lvl* parameter was defaulted to level ``CRITICAL``. See Issue + #28524 for more information about this change. + +.. function:: addLevelName(lvl, levelName) + + Associates level *lvl* with text *levelName* in an internal dictionary, which is + used to map numeric levels to a textual representation, for example when a + :class:`Formatter` formats a message. This function can also be used to define + your own levels. The only constraints are that all levels used must be + registered using this function, levels should be positive integers and they + should increase in increasing order of severity. + + .. note:: If you are thinking of defining your own levels, please see the + section on :ref:`custom-levels`. + +.. function:: getLevelName(lvl) + + Returns the textual representation of logging level *lvl*. If the level is one + of the predefined levels :const:`CRITICAL`, :const:`ERROR`, :const:`WARNING`, + :const:`INFO` or :const:`DEBUG` then you get the corresponding string. If you + have associated levels with names using :func:`addLevelName` then the name you + have associated with *lvl* is returned. If a numeric value corresponding to one + of the defined levels is passed in, the corresponding string representation is + returned. Otherwise, the string 'Level %s' % lvl is returned. + + .. note:: Levels are internally integers (as they need to be compared in the + logging logic). This function is used to convert between an integer level + and the level name displayed in the formatted log output by means of the + ``%(levelname)s`` format specifier (see :ref:`logrecord-attributes`). + + .. versionchanged:: 3.4 + In Python versions earlier than 3.4, this function could also be passed a + text level, and would return the corresponding numeric value of the level. + This undocumented behaviour was considered a mistake, and was removed in + Python 3.4, but reinstated in 3.4.2 due to retain backward compatibility. + +.. function:: makeLogRecord(attrdict) + + Creates and returns a new :class:`LogRecord` instance whose attributes are + defined by *attrdict*. This function is useful for taking a pickled + :class:`LogRecord` attribute dictionary, sent over a socket, and reconstituting + it as a :class:`LogRecord` instance at the receiving end. + + +.. function:: basicConfig(**kwargs) + + Does basic configuration for the logging system by creating a + :class:`StreamHandler` with a default :class:`Formatter` and adding it to the + root logger. The functions :func:`debug`, :func:`info`, :func:`warning`, + :func:`error` and :func:`critical` will call :func:`basicConfig` automatically + if no handlers are defined for the root logger. + + This function does nothing if the root logger already has handlers + configured for it. + + .. note:: This function should be called from the main thread + before other threads are started. In versions of Python prior to + 2.7.1 and 3.2, if this function is called from multiple threads, + it is possible (in rare circumstances) that a handler will be added + to the root logger more than once, leading to unexpected results + such as messages being duplicated in the log. + + The following keyword arguments are supported. + + .. tabularcolumns:: |l|L| + + +--------------+---------------------------------------------+ + | Format | Description | + +==============+=============================================+ + | *filename* | Specifies that a FileHandler be created, | + | | using the specified filename, rather than a | + | | StreamHandler. | + +--------------+---------------------------------------------+ + | *filemode* | If *filename* is specified, open the file | + | | in this :ref:`mode `. Defaults | + | | to ``'a'``. | + +--------------+---------------------------------------------+ + | *format* | Use the specified format string for the | + | | handler. | + +--------------+---------------------------------------------+ + | *datefmt* | Use the specified date/time format, as | + | | accepted by :func:`time.strftime`. | + +--------------+---------------------------------------------+ + | *style* | If *format* is specified, use this style | + | | for the format string. One of ``'%'``, | + | | ``'{'`` or ``'$'`` for :ref:`printf-style | + | | `, | + | | :meth:`str.format` or | + | | :class:`string.Template` respectively. | + | | Defaults to ``'%'``. | + +--------------+---------------------------------------------+ + | *level* | Set the root logger level to the specified | + | | :ref:`level `. | + +--------------+---------------------------------------------+ + | *stream* | Use the specified stream to initialize the | + | | StreamHandler. Note that this argument is | + | | incompatible with *filename* - if both | + | | are present, a ``ValueError`` is raised. | + +--------------+---------------------------------------------+ + | *handlers* | If specified, this should be an iterable of | + | | already created handlers to add to the root | + | | logger. Any handlers which don't already | + | | have a formatter set will be assigned the | + | | default formatter created in this function. | + | | Note that this argument is incompatible | + | | with *filename* or *stream* - if both | + | | are present, a ``ValueError`` is raised. | + +--------------+---------------------------------------------+ + + .. versionchanged:: 3.2 + The *style* argument was added. + + .. versionchanged:: 3.3 + The *handlers* argument was added. Additional checks were added to + catch situations where incompatible arguments are specified (e.g. + *handlers* together with *stream* or *filename*, or *stream* + together with *filename*). + +.. function:: shutdown() + + Informs the logging system to perform an orderly shutdown by flushing and + closing all handlers. This should be called at application exit and no + further use of the logging system should be made after this call. + + +.. function:: setLoggerClass(klass) + + Tells the logging system to use the class *klass* when instantiating a logger. + The class should define :meth:`__init__` such that only a name argument is + required, and the :meth:`__init__` should call :meth:`Logger.__init__`. This + function is typically called before any loggers are instantiated by applications + which need to use custom logger behavior. After this call, as at any other + time, do not instantiate loggers directly using the subclass: continue to use + the :func:`logging.getLogger` API to get your loggers. + + +.. function:: setLogRecordFactory(factory) + + Set a callable which is used to create a :class:`LogRecord`. + + :param factory: The factory callable to be used to instantiate a log record. + + .. versionadded:: 3.2 + This function has been provided, along with :func:`getLogRecordFactory`, to + allow developers more control over how the :class:`LogRecord` representing + a logging event is constructed. + + The factory has the following signature: + + ``factory(name, level, fn, lno, msg, args, exc_info, func=None, sinfo=None, **kwargs)`` + + :name: The logger name. + :level: The logging level (numeric). + :fn: The full pathname of the file where the logging call was made. + :lno: The line number in the file where the logging call was made. + :msg: The logging message. + :args: The arguments for the logging message. + :exc_info: An exception tuple, or ``None``. + :func: The name of the function or method which invoked the logging + call. + :sinfo: A stack traceback such as is provided by + :func:`traceback.print_stack`, showing the call hierarchy. + :kwargs: Additional keyword arguments. + + +Module-Level Attributes +----------------------- + +.. attribute:: lastResort + + A "handler of last resort" is available through this attribute. This + is a :class:`StreamHandler` writing to ``sys.stderr`` with a level of + ``WARNING``, and is used to handle logging events in the absence of any + logging configuration. The end result is to just print the message to + ``sys.stderr``. This replaces the earlier error message saying that + "no handlers could be found for logger XYZ". If you need the earlier + behaviour for some reason, ``lastResort`` can be set to ``None``. + + .. versionadded:: 3.2 + +Integration with the warnings module +------------------------------------ + +The :func:`captureWarnings` function can be used to integrate :mod:`logging` +with the :mod:`warnings` module. + +.. function:: captureWarnings(capture) + + This function is used to turn the capture of warnings by logging on and + off. + + If *capture* is ``True``, warnings issued by the :mod:`warnings` module will + be redirected to the logging system. Specifically, a warning will be + formatted using :func:`warnings.formatwarning` and the resulting string + logged to a logger named ``'py.warnings'`` with a severity of :const:`WARNING`. + + If *capture* is ``False``, the redirection of warnings to the logging system + will stop, and warnings will be redirected to their original destinations + (i.e. those in effect before ``captureWarnings(True)`` was called). + + +.. seealso:: + + Module :mod:`logging.config` + Configuration API for the logging module. + + Module :mod:`logging.handlers` + Useful handlers included with the logging module. + + :pep:`282` - A Logging System + The proposal which described this feature for inclusion in the Python standard + library. + + `Original Python logging package `_ + This is the original source for the :mod:`logging` package. The version of the + package available from this site is suitable for use with Python 1.5.2, 2.1.x + and 2.2.x, which do not include the :mod:`logging` package in the standard + library. diff --git a/python-3.7.4-docs-html/_sources/library/lzma.rst.txt b/python-3.7.4-docs-html/_sources/library/lzma.rst.txt new file mode 100644 index 0000000..cce6c23 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/lzma.rst.txt @@ -0,0 +1,434 @@ +:mod:`lzma` --- Compression using the LZMA algorithm +==================================================== + +.. module:: lzma + :synopsis: A Python wrapper for the liblzma compression library. + +.. moduleauthor:: Nadeem Vawda +.. sectionauthor:: Nadeem Vawda + +.. versionadded:: 3.3 + +**Source code:** :source:`Lib/lzma.py` + +-------------- + +This module provides classes and convenience functions for compressing and +decompressing data using the LZMA compression algorithm. Also included is a file +interface supporting the ``.xz`` and legacy ``.lzma`` file formats used by the +:program:`xz` utility, as well as raw compressed streams. + +The interface provided by this module is very similar to that of the :mod:`bz2` +module. However, note that :class:`LZMAFile` is *not* thread-safe, unlike +:class:`bz2.BZ2File`, so if you need to use a single :class:`LZMAFile` instance +from multiple threads, it is necessary to protect it with a lock. + + +.. exception:: LZMAError + + This exception is raised when an error occurs during compression or + decompression, or while initializing the compressor/decompressor state. + + +Reading and writing compressed files +------------------------------------ + +.. function:: open(filename, mode="rb", \*, format=None, check=-1, preset=None, filters=None, encoding=None, errors=None, newline=None) + + Open an LZMA-compressed file in binary or text mode, returning a :term:`file + object`. + + The *filename* argument can be either an actual file name (given as a + :class:`str`, :class:`bytes` or :term:`path-like ` object), in + which case the named file is opened, or it can be an existing file object + to read from or write to. + + The *mode* argument can be any of ``"r"``, ``"rb"``, ``"w"``, ``"wb"``, + ``"x"``, ``"xb"``, ``"a"`` or ``"ab"`` for binary mode, or ``"rt"``, + ``"wt"``, ``"xt"``, or ``"at"`` for text mode. The default is ``"rb"``. + + When opening a file for reading, the *format* and *filters* arguments have + the same meanings as for :class:`LZMADecompressor`. In this case, the *check* + and *preset* arguments should not be used. + + When opening a file for writing, the *format*, *check*, *preset* and + *filters* arguments have the same meanings as for :class:`LZMACompressor`. + + For binary mode, this function is equivalent to the :class:`LZMAFile` + constructor: ``LZMAFile(filename, mode, ...)``. In this case, the *encoding*, + *errors* and *newline* arguments must not be provided. + + For text mode, a :class:`LZMAFile` object is created, and wrapped in an + :class:`io.TextIOWrapper` instance with the specified encoding, error + handling behavior, and line ending(s). + + .. versionchanged:: 3.4 + Added support for the ``"x"``, ``"xb"`` and ``"xt"`` modes. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. class:: LZMAFile(filename=None, mode="r", \*, format=None, check=-1, preset=None, filters=None) + + Open an LZMA-compressed file in binary mode. + + An :class:`LZMAFile` can wrap an already-open :term:`file object`, or operate + directly on a named file. The *filename* argument specifies either the file + object to wrap, or the name of the file to open (as a :class:`str`, + :class:`bytes` or :term:`path-like ` object). When wrapping an + existing file object, the wrapped file will not be closed when the + :class:`LZMAFile` is closed. + + The *mode* argument can be either ``"r"`` for reading (default), ``"w"`` for + overwriting, ``"x"`` for exclusive creation, or ``"a"`` for appending. These + can equivalently be given as ``"rb"``, ``"wb"``, ``"xb"`` and ``"ab"`` + respectively. + + If *filename* is a file object (rather than an actual file name), a mode of + ``"w"`` does not truncate the file, and is instead equivalent to ``"a"``. + + When opening a file for reading, the input file may be the concatenation of + multiple separate compressed streams. These are transparently decoded as a + single logical stream. + + When opening a file for reading, the *format* and *filters* arguments have + the same meanings as for :class:`LZMADecompressor`. In this case, the *check* + and *preset* arguments should not be used. + + When opening a file for writing, the *format*, *check*, *preset* and + *filters* arguments have the same meanings as for :class:`LZMACompressor`. + + :class:`LZMAFile` supports all the members specified by + :class:`io.BufferedIOBase`, except for :meth:`detach` and :meth:`truncate`. + Iteration and the :keyword:`with` statement are supported. + + The following method is also provided: + + .. method:: peek(size=-1) + + Return buffered data without advancing the file position. At least one + byte of data will be returned, unless EOF has been reached. The exact + number of bytes returned is unspecified (the *size* argument is ignored). + + .. note:: While calling :meth:`peek` does not change the file position of + the :class:`LZMAFile`, it may change the position of the underlying + file object (e.g. if the :class:`LZMAFile` was constructed by passing a + file object for *filename*). + + .. versionchanged:: 3.4 + Added support for the ``"x"`` and ``"xb"`` modes. + + .. versionchanged:: 3.5 + The :meth:`~io.BufferedIOBase.read` method now accepts an argument of + ``None``. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +Compressing and decompressing data in memory +-------------------------------------------- + +.. class:: LZMACompressor(format=FORMAT_XZ, check=-1, preset=None, filters=None) + + Create a compressor object, which can be used to compress data incrementally. + + For a more convenient way of compressing a single chunk of data, see + :func:`compress`. + + The *format* argument specifies what container format should be used. + Possible values are: + + * :const:`FORMAT_XZ`: The ``.xz`` container format. + This is the default format. + + * :const:`FORMAT_ALONE`: The legacy ``.lzma`` container format. + This format is more limited than ``.xz`` -- it does not support integrity + checks or multiple filters. + + * :const:`FORMAT_RAW`: A raw data stream, not using any container format. + This format specifier does not support integrity checks, and requires that + you always specify a custom filter chain (for both compression and + decompression). Additionally, data compressed in this manner cannot be + decompressed using :const:`FORMAT_AUTO` (see :class:`LZMADecompressor`). + + The *check* argument specifies the type of integrity check to include in the + compressed data. This check is used when decompressing, to ensure that the + data has not been corrupted. Possible values are: + + * :const:`CHECK_NONE`: No integrity check. + This is the default (and the only acceptable value) for + :const:`FORMAT_ALONE` and :const:`FORMAT_RAW`. + + * :const:`CHECK_CRC32`: 32-bit Cyclic Redundancy Check. + + * :const:`CHECK_CRC64`: 64-bit Cyclic Redundancy Check. + This is the default for :const:`FORMAT_XZ`. + + * :const:`CHECK_SHA256`: 256-bit Secure Hash Algorithm. + + If the specified check is not supported, an :class:`LZMAError` is raised. + + The compression settings can be specified either as a preset compression + level (with the *preset* argument), or in detail as a custom filter chain + (with the *filters* argument). + + The *preset* argument (if provided) should be an integer between ``0`` and + ``9`` (inclusive), optionally OR-ed with the constant + :const:`PRESET_EXTREME`. If neither *preset* nor *filters* are given, the + default behavior is to use :const:`PRESET_DEFAULT` (preset level ``6``). + Higher presets produce smaller output, but make the compression process + slower. + + .. note:: + + In addition to being more CPU-intensive, compression with higher presets + also requires much more memory (and produces output that needs more memory + to decompress). With preset ``9`` for example, the overhead for an + :class:`LZMACompressor` object can be as high as 800 MiB. For this reason, + it is generally best to stick with the default preset. + + The *filters* argument (if provided) should be a filter chain specifier. + See :ref:`filter-chain-specs` for details. + + .. method:: compress(data) + + Compress *data* (a :class:`bytes` object), returning a :class:`bytes` + object containing compressed data for at least part of the input. Some of + *data* may be buffered internally, for use in later calls to + :meth:`compress` and :meth:`flush`. The returned data should be + concatenated with the output of any previous calls to :meth:`compress`. + + .. method:: flush() + + Finish the compression process, returning a :class:`bytes` object + containing any data stored in the compressor's internal buffers. + + The compressor cannot be used after this method has been called. + + +.. class:: LZMADecompressor(format=FORMAT_AUTO, memlimit=None, filters=None) + + Create a decompressor object, which can be used to decompress data + incrementally. + + For a more convenient way of decompressing an entire compressed stream at + once, see :func:`decompress`. + + The *format* argument specifies the container format that should be used. The + default is :const:`FORMAT_AUTO`, which can decompress both ``.xz`` and + ``.lzma`` files. Other possible values are :const:`FORMAT_XZ`, + :const:`FORMAT_ALONE`, and :const:`FORMAT_RAW`. + + The *memlimit* argument specifies a limit (in bytes) on the amount of memory + that the decompressor can use. When this argument is used, decompression will + fail with an :class:`LZMAError` if it is not possible to decompress the input + within the given memory limit. + + The *filters* argument specifies the filter chain that was used to create + the stream being decompressed. This argument is required if *format* is + :const:`FORMAT_RAW`, but should not be used for other formats. + See :ref:`filter-chain-specs` for more information about filter chains. + + .. note:: + This class does not transparently handle inputs containing multiple + compressed streams, unlike :func:`decompress` and :class:`LZMAFile`. To + decompress a multi-stream input with :class:`LZMADecompressor`, you must + create a new decompressor for each stream. + + .. method:: decompress(data, max_length=-1) + + Decompress *data* (a :term:`bytes-like object`), returning + uncompressed data as bytes. Some of *data* may be buffered + internally, for use in later calls to :meth:`decompress`. The + returned data should be concatenated with the output of any + previous calls to :meth:`decompress`. + + If *max_length* is nonnegative, returns at most *max_length* + bytes of decompressed data. If this limit is reached and further + output can be produced, the :attr:`~.needs_input` attribute will + be set to ``False``. In this case, the next call to + :meth:`~.decompress` may provide *data* as ``b''`` to obtain + more of the output. + + If all of the input data was decompressed and returned (either + because this was less than *max_length* bytes, or because + *max_length* was negative), the :attr:`~.needs_input` attribute + will be set to ``True``. + + Attempting to decompress data after the end of stream is reached + raises an `EOFError`. Any data found after the end of the + stream is ignored and saved in the :attr:`~.unused_data` attribute. + + .. versionchanged:: 3.5 + Added the *max_length* parameter. + + .. attribute:: check + + The ID of the integrity check used by the input stream. This may be + :const:`CHECK_UNKNOWN` until enough of the input has been decoded to + determine what integrity check it uses. + + .. attribute:: eof + + ``True`` if the end-of-stream marker has been reached. + + .. attribute:: unused_data + + Data found after the end of the compressed stream. + + Before the end of the stream is reached, this will be ``b""``. + + .. attribute:: needs_input + + ``False`` if the :meth:`.decompress` method can provide more + decompressed data before requiring new uncompressed input. + + .. versionadded:: 3.5 + +.. function:: compress(data, format=FORMAT_XZ, check=-1, preset=None, filters=None) + + Compress *data* (a :class:`bytes` object), returning the compressed data as a + :class:`bytes` object. + + See :class:`LZMACompressor` above for a description of the *format*, *check*, + *preset* and *filters* arguments. + + +.. function:: decompress(data, format=FORMAT_AUTO, memlimit=None, filters=None) + + Decompress *data* (a :class:`bytes` object), returning the uncompressed data + as a :class:`bytes` object. + + If *data* is the concatenation of multiple distinct compressed streams, + decompress all of these streams, and return the concatenation of the results. + + See :class:`LZMADecompressor` above for a description of the *format*, + *memlimit* and *filters* arguments. + + +Miscellaneous +------------- + +.. function:: is_check_supported(check) + + Returns true if the given integrity check is supported on this system. + + :const:`CHECK_NONE` and :const:`CHECK_CRC32` are always supported. + :const:`CHECK_CRC64` and :const:`CHECK_SHA256` may be unavailable if you are + using a version of :program:`liblzma` that was compiled with a limited + feature set. + + +.. _filter-chain-specs: + +Specifying custom filter chains +------------------------------- + +A filter chain specifier is a sequence of dictionaries, where each dictionary +contains the ID and options for a single filter. Each dictionary must contain +the key ``"id"``, and may contain additional keys to specify filter-dependent +options. Valid filter IDs are as follows: + +* Compression filters: + * :const:`FILTER_LZMA1` (for use with :const:`FORMAT_ALONE`) + * :const:`FILTER_LZMA2` (for use with :const:`FORMAT_XZ` and :const:`FORMAT_RAW`) + +* Delta filter: + * :const:`FILTER_DELTA` + +* Branch-Call-Jump (BCJ) filters: + * :const:`FILTER_X86` + * :const:`FILTER_IA64` + * :const:`FILTER_ARM` + * :const:`FILTER_ARMTHUMB` + * :const:`FILTER_POWERPC` + * :const:`FILTER_SPARC` + +A filter chain can consist of up to 4 filters, and cannot be empty. The last +filter in the chain must be a compression filter, and any other filters must be +delta or BCJ filters. + +Compression filters support the following options (specified as additional +entries in the dictionary representing the filter): + + * ``preset``: A compression preset to use as a source of default values for + options that are not specified explicitly. + * ``dict_size``: Dictionary size in bytes. This should be between 4 KiB and + 1.5 GiB (inclusive). + * ``lc``: Number of literal context bits. + * ``lp``: Number of literal position bits. The sum ``lc + lp`` must be at + most 4. + * ``pb``: Number of position bits; must be at most 4. + * ``mode``: :const:`MODE_FAST` or :const:`MODE_NORMAL`. + * ``nice_len``: What should be considered a "nice length" for a match. + This should be 273 or less. + * ``mf``: What match finder to use -- :const:`MF_HC3`, :const:`MF_HC4`, + :const:`MF_BT2`, :const:`MF_BT3`, or :const:`MF_BT4`. + * ``depth``: Maximum search depth used by match finder. 0 (default) means to + select automatically based on other filter options. + +The delta filter stores the differences between bytes, producing more repetitive +input for the compressor in certain circumstances. It supports one option, +``dist``. This indicates the distance between bytes to be subtracted. The +default is 1, i.e. take the differences between adjacent bytes. + +The BCJ filters are intended to be applied to machine code. They convert +relative branches, calls and jumps in the code to use absolute addressing, with +the aim of increasing the redundancy that can be exploited by the compressor. +These filters support one option, ``start_offset``. This specifies the address +that should be mapped to the beginning of the input data. The default is 0. + + +Examples +-------- + +Reading in a compressed file:: + + import lzma + with lzma.open("file.xz") as f: + file_content = f.read() + +Creating a compressed file:: + + import lzma + data = b"Insert Data Here" + with lzma.open("file.xz", "w") as f: + f.write(data) + +Compressing data in memory:: + + import lzma + data_in = b"Insert Data Here" + data_out = lzma.compress(data_in) + +Incremental compression:: + + import lzma + lzc = lzma.LZMACompressor() + out1 = lzc.compress(b"Some data\n") + out2 = lzc.compress(b"Another piece of data\n") + out3 = lzc.compress(b"Even more data\n") + out4 = lzc.flush() + # Concatenate all the partial results: + result = b"".join([out1, out2, out3, out4]) + +Writing compressed data to an already-open file:: + + import lzma + with open("file.xz", "wb") as f: + f.write(b"This data will not be compressed\n") + with lzma.open(f, "w") as lzf: + lzf.write(b"This *will* be compressed\n") + f.write(b"Not compressed\n") + +Creating a compressed file using a custom filter chain:: + + import lzma + my_filters = [ + {"id": lzma.FILTER_DELTA, "dist": 5}, + {"id": lzma.FILTER_LZMA2, "preset": 7 | lzma.PRESET_EXTREME}, + ] + with lzma.open("file.xz", "w", filters=my_filters) as f: + f.write(b"blah blah blah") diff --git a/python-3.7.4-docs-html/_sources/library/macpath.rst.txt b/python-3.7.4-docs-html/_sources/library/macpath.rst.txt new file mode 100644 index 0000000..2af51c6 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/macpath.rst.txt @@ -0,0 +1,21 @@ +:mod:`macpath` --- Mac OS 9 path manipulation functions +======================================================= + +.. module:: macpath + :synopsis: Mac OS 9 path manipulation functions. + +**Source code:** :source:`Lib/macpath.py` + +.. deprecated-removed:: 3.7 3.8 + +-------------- + +This module is the Mac OS 9 (and earlier) implementation of the :mod:`os.path` +module. It can be used to manipulate old-style Macintosh pathnames on Mac OS X +(or any other platform). + +The following functions are available in this module: :func:`normcase`, +:func:`normpath`, :func:`isabs`, :func:`join`, :func:`split`, :func:`isdir`, +:func:`isfile`, :func:`walk`, :func:`exists`. For other functions available in +:mod:`os.path` dummy counterparts are available. + diff --git a/python-3.7.4-docs-html/_sources/library/mailbox.rst.txt b/python-3.7.4-docs-html/_sources/library/mailbox.rst.txt new file mode 100644 index 0000000..d901ad2 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/mailbox.rst.txt @@ -0,0 +1,1593 @@ +:mod:`mailbox` --- Manipulate mailboxes in various formats +========================================================== + +.. module:: mailbox + :synopsis: Manipulate mailboxes in various formats + +.. moduleauthor:: Gregory K. Johnson +.. sectionauthor:: Gregory K. Johnson + +**Source code:** :source:`Lib/mailbox.py` + +-------------- + +This module defines two classes, :class:`Mailbox` and :class:`Message`, for +accessing and manipulating on-disk mailboxes and the messages they contain. +:class:`Mailbox` offers a dictionary-like mapping from keys to messages. +:class:`Message` extends the :mod:`email.message` module's +:class:`~email.message.Message` class with format-specific state and behavior. +Supported mailbox formats are Maildir, mbox, MH, Babyl, and MMDF. + + +.. seealso:: + + Module :mod:`email` + Represent and manipulate messages. + + +.. _mailbox-objects: + +:class:`Mailbox` objects +------------------------ + +.. class:: Mailbox + + A mailbox, which may be inspected and modified. + + The :class:`Mailbox` class defines an interface and is not intended to be + instantiated. Instead, format-specific subclasses should inherit from + :class:`Mailbox` and your code should instantiate a particular subclass. + + The :class:`Mailbox` interface is dictionary-like, with small keys + corresponding to messages. Keys are issued by the :class:`Mailbox` instance + with which they will be used and are only meaningful to that :class:`Mailbox` + instance. A key continues to identify a message even if the corresponding + message is modified, such as by replacing it with another message. + + Messages may be added to a :class:`Mailbox` instance using the set-like + method :meth:`add` and removed using a ``del`` statement or the set-like + methods :meth:`remove` and :meth:`discard`. + + :class:`Mailbox` interface semantics differ from dictionary semantics in some + noteworthy ways. Each time a message is requested, a new representation + (typically a :class:`Message` instance) is generated based upon the current + state of the mailbox. Similarly, when a message is added to a + :class:`Mailbox` instance, the provided message representation's contents are + copied. In neither case is a reference to the message representation kept by + the :class:`Mailbox` instance. + + The default :class:`Mailbox` iterator iterates over message representations, + not keys as the default dictionary iterator does. Moreover, modification of a + mailbox during iteration is safe and well-defined. Messages added to the + mailbox after an iterator is created will not be seen by the + iterator. Messages removed from the mailbox before the iterator yields them + will be silently skipped, though using a key from an iterator may result in a + :exc:`KeyError` exception if the corresponding message is subsequently + removed. + + .. warning:: + + Be very cautious when modifying mailboxes that might be simultaneously + changed by some other process. The safest mailbox format to use for such + tasks is Maildir; try to avoid using single-file formats such as mbox for + concurrent writing. If you're modifying a mailbox, you *must* lock it by + calling the :meth:`lock` and :meth:`unlock` methods *before* reading any + messages in the file or making any changes by adding or deleting a + message. Failing to lock the mailbox runs the risk of losing messages or + corrupting the entire mailbox. + + :class:`Mailbox` instances have the following methods: + + + .. method:: add(message) + + Add *message* to the mailbox and return the key that has been assigned to + it. + + Parameter *message* may be a :class:`Message` instance, an + :class:`email.message.Message` instance, a string, a byte string, or a + file-like object (which should be open in binary mode). If *message* is + an instance of the + appropriate format-specific :class:`Message` subclass (e.g., if it's an + :class:`mboxMessage` instance and this is an :class:`mbox` instance), its + format-specific information is used. Otherwise, reasonable defaults for + format-specific information are used. + + .. versionchanged:: 3.2 + Support for binary input was added. + + + .. method:: remove(key) + __delitem__(key) + discard(key) + + Delete the message corresponding to *key* from the mailbox. + + If no such message exists, a :exc:`KeyError` exception is raised if the + method was called as :meth:`remove` or :meth:`__delitem__` but no + exception is raised if the method was called as :meth:`discard`. The + behavior of :meth:`discard` may be preferred if the underlying mailbox + format supports concurrent modification by other processes. + + + .. method:: __setitem__(key, message) + + Replace the message corresponding to *key* with *message*. Raise a + :exc:`KeyError` exception if no message already corresponds to *key*. + + As with :meth:`add`, parameter *message* may be a :class:`Message` + instance, an :class:`email.message.Message` instance, a string, a byte + string, or a file-like object (which should be open in binary mode). If + *message* is an + instance of the appropriate format-specific :class:`Message` subclass + (e.g., if it's an :class:`mboxMessage` instance and this is an + :class:`mbox` instance), its format-specific information is + used. Otherwise, the format-specific information of the message that + currently corresponds to *key* is left unchanged. + + + .. method:: iterkeys() + keys() + + Return an iterator over all keys if called as :meth:`iterkeys` or return a + list of keys if called as :meth:`keys`. + + + .. method:: itervalues() + __iter__() + values() + + Return an iterator over representations of all messages if called as + :meth:`itervalues` or :meth:`__iter__` or return a list of such + representations if called as :meth:`values`. The messages are represented + as instances of the appropriate format-specific :class:`Message` subclass + unless a custom message factory was specified when the :class:`Mailbox` + instance was initialized. + + .. note:: + + The behavior of :meth:`__iter__` is unlike that of dictionaries, which + iterate over keys. + + + .. method:: iteritems() + items() + + Return an iterator over (*key*, *message*) pairs, where *key* is a key and + *message* is a message representation, if called as :meth:`iteritems` or + return a list of such pairs if called as :meth:`items`. The messages are + represented as instances of the appropriate format-specific + :class:`Message` subclass unless a custom message factory was specified + when the :class:`Mailbox` instance was initialized. + + + .. method:: get(key, default=None) + __getitem__(key) + + Return a representation of the message corresponding to *key*. If no such + message exists, *default* is returned if the method was called as + :meth:`get` and a :exc:`KeyError` exception is raised if the method was + called as :meth:`__getitem__`. The message is represented as an instance + of the appropriate format-specific :class:`Message` subclass unless a + custom message factory was specified when the :class:`Mailbox` instance + was initialized. + + + .. method:: get_message(key) + + Return a representation of the message corresponding to *key* as an + instance of the appropriate format-specific :class:`Message` subclass, or + raise a :exc:`KeyError` exception if no such message exists. + + + .. method:: get_bytes(key) + + Return a byte representation of the message corresponding to *key*, or + raise a :exc:`KeyError` exception if no such message exists. + + .. versionadded:: 3.2 + + + .. method:: get_string(key) + + Return a string representation of the message corresponding to *key*, or + raise a :exc:`KeyError` exception if no such message exists. The + message is processed through :class:`email.message.Message` to + convert it to a 7bit clean representation. + + + .. method:: get_file(key) + + Return a file-like representation of the message corresponding to *key*, + or raise a :exc:`KeyError` exception if no such message exists. The + file-like object behaves as if open in binary mode. This file should be + closed once it is no longer needed. + + .. versionchanged:: 3.2 + The file object really is a binary file; previously it was incorrectly + returned in text mode. Also, the file-like object now supports the + context management protocol: you can use a :keyword:`with` statement to + automatically close it. + + .. note:: + + Unlike other representations of messages, file-like representations are + not necessarily independent of the :class:`Mailbox` instance that + created them or of the underlying mailbox. More specific documentation + is provided by each subclass. + + + .. method:: __contains__(key) + + Return ``True`` if *key* corresponds to a message, ``False`` otherwise. + + + .. method:: __len__() + + Return a count of messages in the mailbox. + + + .. method:: clear() + + Delete all messages from the mailbox. + + + .. method:: pop(key, default=None) + + Return a representation of the message corresponding to *key* and delete + the message. If no such message exists, return *default*. The message is + represented as an instance of the appropriate format-specific + :class:`Message` subclass unless a custom message factory was specified + when the :class:`Mailbox` instance was initialized. + + + .. method:: popitem() + + Return an arbitrary (*key*, *message*) pair, where *key* is a key and + *message* is a message representation, and delete the corresponding + message. If the mailbox is empty, raise a :exc:`KeyError` exception. The + message is represented as an instance of the appropriate format-specific + :class:`Message` subclass unless a custom message factory was specified + when the :class:`Mailbox` instance was initialized. + + + .. method:: update(arg) + + Parameter *arg* should be a *key*-to-*message* mapping or an iterable of + (*key*, *message*) pairs. Updates the mailbox so that, for each given + *key* and *message*, the message corresponding to *key* is set to + *message* as if by using :meth:`__setitem__`. As with :meth:`__setitem__`, + each *key* must already correspond to a message in the mailbox or else a + :exc:`KeyError` exception will be raised, so in general it is incorrect + for *arg* to be a :class:`Mailbox` instance. + + .. note:: + + Unlike with dictionaries, keyword arguments are not supported. + + + .. method:: flush() + + Write any pending changes to the filesystem. For some :class:`Mailbox` + subclasses, changes are always written immediately and :meth:`flush` does + nothing, but you should still make a habit of calling this method. + + + .. method:: lock() + + Acquire an exclusive advisory lock on the mailbox so that other processes + know not to modify it. An :exc:`ExternalClashError` is raised if the lock + is not available. The particular locking mechanisms used depend upon the + mailbox format. You should *always* lock the mailbox before making any + modifications to its contents. + + + .. method:: unlock() + + Release the lock on the mailbox, if any. + + + .. method:: close() + + Flush the mailbox, unlock it if necessary, and close any open files. For + some :class:`Mailbox` subclasses, this method does nothing. + + +.. _mailbox-maildir: + +:class:`Maildir` +^^^^^^^^^^^^^^^^ + + +.. class:: Maildir(dirname, factory=None, create=True) + + A subclass of :class:`Mailbox` for mailboxes in Maildir format. Parameter + *factory* is a callable object that accepts a file-like message representation + (which behaves as if opened in binary mode) and returns a custom representation. + If *factory* is ``None``, :class:`MaildirMessage` is used as the default message + representation. If *create* is ``True``, the mailbox is created if it does not + exist. + + It is for historical reasons that *dirname* is named as such rather than *path*. + + Maildir is a directory-based mailbox format invented for the qmail mail + transfer agent and now widely supported by other programs. Messages in a + Maildir mailbox are stored in separate files within a common directory + structure. This design allows Maildir mailboxes to be accessed and modified + by multiple unrelated programs without data corruption, so file locking is + unnecessary. + + Maildir mailboxes contain three subdirectories, namely: :file:`tmp`, + :file:`new`, and :file:`cur`. Messages are created momentarily in the + :file:`tmp` subdirectory and then moved to the :file:`new` subdirectory to + finalize delivery. A mail user agent may subsequently move the message to the + :file:`cur` subdirectory and store information about the state of the message + in a special "info" section appended to its file name. + + Folders of the style introduced by the Courier mail transfer agent are also + supported. Any subdirectory of the main mailbox is considered a folder if + ``'.'`` is the first character in its name. Folder names are represented by + :class:`Maildir` without the leading ``'.'``. Each folder is itself a Maildir + mailbox but should not contain other folders. Instead, a logical nesting is + indicated using ``'.'`` to delimit levels, e.g., "Archived.2005.07". + + .. note:: + + The Maildir specification requires the use of a colon (``':'``) in certain + message file names. However, some operating systems do not permit this + character in file names, If you wish to use a Maildir-like format on such + an operating system, you should specify another character to use + instead. The exclamation point (``'!'``) is a popular choice. For + example:: + + import mailbox + mailbox.Maildir.colon = '!' + + The :attr:`colon` attribute may also be set on a per-instance basis. + + :class:`Maildir` instances have all of the methods of :class:`Mailbox` in + addition to the following: + + + .. method:: list_folders() + + Return a list of the names of all folders. + + + .. method:: get_folder(folder) + + Return a :class:`Maildir` instance representing the folder whose name is + *folder*. A :exc:`NoSuchMailboxError` exception is raised if the folder + does not exist. + + + .. method:: add_folder(folder) + + Create a folder whose name is *folder* and return a :class:`Maildir` + instance representing it. + + + .. method:: remove_folder(folder) + + Delete the folder whose name is *folder*. If the folder contains any + messages, a :exc:`NotEmptyError` exception will be raised and the folder + will not be deleted. + + + .. method:: clean() + + Delete temporary files from the mailbox that have not been accessed in the + last 36 hours. The Maildir specification says that mail-reading programs + should do this occasionally. + + Some :class:`Mailbox` methods implemented by :class:`Maildir` deserve special + remarks: + + + .. method:: add(message) + __setitem__(key, message) + update(arg) + + .. warning:: + + These methods generate unique file names based upon the current process + ID. When using multiple threads, undetected name clashes may occur and + cause corruption of the mailbox unless threads are coordinated to avoid + using these methods to manipulate the same mailbox simultaneously. + + + .. method:: flush() + + All changes to Maildir mailboxes are immediately applied, so this method + does nothing. + + + .. method:: lock() + unlock() + + Maildir mailboxes do not support (or require) locking, so these methods do + nothing. + + + .. method:: close() + + :class:`Maildir` instances do not keep any open files and the underlying + mailboxes do not support locking, so this method does nothing. + + + .. method:: get_file(key) + + Depending upon the host platform, it may not be possible to modify or + remove the underlying message while the returned file remains open. + + +.. seealso:: + + `maildir man page from qmail `_ + The original specification of the format. + + `Using maildir format `_ + Notes on Maildir by its inventor. Includes an updated name-creation scheme and + details on "info" semantics. + + `maildir man page from Courier `_ + Another specification of the format. Describes a common extension for supporting + folders. + + +.. _mailbox-mbox: + +:class:`mbox` +^^^^^^^^^^^^^ + + +.. class:: mbox(path, factory=None, create=True) + + A subclass of :class:`Mailbox` for mailboxes in mbox format. Parameter *factory* + is a callable object that accepts a file-like message representation (which + behaves as if opened in binary mode) and returns a custom representation. If + *factory* is ``None``, :class:`mboxMessage` is used as the default message + representation. If *create* is ``True``, the mailbox is created if it does not + exist. + + The mbox format is the classic format for storing mail on Unix systems. All + messages in an mbox mailbox are stored in a single file with the beginning of + each message indicated by a line whose first five characters are "From ". + + Several variations of the mbox format exist to address perceived shortcomings in + the original. In the interest of compatibility, :class:`mbox` implements the + original format, which is sometimes referred to as :dfn:`mboxo`. This means that + the :mailheader:`Content-Length` header, if present, is ignored and that any + occurrences of "From " at the beginning of a line in a message body are + transformed to ">From " when storing the message, although occurrences of ">From + " are not transformed to "From " when reading the message. + + Some :class:`Mailbox` methods implemented by :class:`mbox` deserve special + remarks: + + + .. method:: get_file(key) + + Using the file after calling :meth:`flush` or :meth:`close` on the + :class:`mbox` instance may yield unpredictable results or raise an + exception. + + + .. method:: lock() + unlock() + + Three locking mechanisms are used---dot locking and, if available, the + :c:func:`flock` and :c:func:`lockf` system calls. + + +.. seealso:: + + `mbox man page from qmail `_ + A specification of the format and its variations. + + `mbox man page from tin `_ + Another specification of the format, with details on locking. + + `Configuring Netscape Mail on Unix: Why The Content-Length Format is Bad `_ + An argument for using the original mbox format rather than a variation. + + `"mbox" is a family of several mutually incompatible mailbox formats `_ + A history of mbox variations. + + +.. _mailbox-mh: + +:class:`MH` +^^^^^^^^^^^ + + +.. class:: MH(path, factory=None, create=True) + + A subclass of :class:`Mailbox` for mailboxes in MH format. Parameter *factory* + is a callable object that accepts a file-like message representation (which + behaves as if opened in binary mode) and returns a custom representation. If + *factory* is ``None``, :class:`MHMessage` is used as the default message + representation. If *create* is ``True``, the mailbox is created if it does not + exist. + + MH is a directory-based mailbox format invented for the MH Message Handling + System, a mail user agent. Each message in an MH mailbox resides in its own + file. An MH mailbox may contain other MH mailboxes (called :dfn:`folders`) in + addition to messages. Folders may be nested indefinitely. MH mailboxes also + support :dfn:`sequences`, which are named lists used to logically group + messages without moving them to sub-folders. Sequences are defined in a file + called :file:`.mh_sequences` in each folder. + + The :class:`MH` class manipulates MH mailboxes, but it does not attempt to + emulate all of :program:`mh`'s behaviors. In particular, it does not modify + and is not affected by the :file:`context` or :file:`.mh_profile` files that + are used by :program:`mh` to store its state and configuration. + + :class:`MH` instances have all of the methods of :class:`Mailbox` in addition + to the following: + + + .. method:: list_folders() + + Return a list of the names of all folders. + + + .. method:: get_folder(folder) + + Return an :class:`MH` instance representing the folder whose name is + *folder*. A :exc:`NoSuchMailboxError` exception is raised if the folder + does not exist. + + + .. method:: add_folder(folder) + + Create a folder whose name is *folder* and return an :class:`MH` instance + representing it. + + + .. method:: remove_folder(folder) + + Delete the folder whose name is *folder*. If the folder contains any + messages, a :exc:`NotEmptyError` exception will be raised and the folder + will not be deleted. + + + .. method:: get_sequences() + + Return a dictionary of sequence names mapped to key lists. If there are no + sequences, the empty dictionary is returned. + + + .. method:: set_sequences(sequences) + + Re-define the sequences that exist in the mailbox based upon *sequences*, + a dictionary of names mapped to key lists, like returned by + :meth:`get_sequences`. + + + .. method:: pack() + + Rename messages in the mailbox as necessary to eliminate gaps in + numbering. Entries in the sequences list are updated correspondingly. + + .. note:: + + Already-issued keys are invalidated by this operation and should not be + subsequently used. + + Some :class:`Mailbox` methods implemented by :class:`MH` deserve special + remarks: + + + .. method:: remove(key) + __delitem__(key) + discard(key) + + These methods immediately delete the message. The MH convention of marking + a message for deletion by prepending a comma to its name is not used. + + + .. method:: lock() + unlock() + + Three locking mechanisms are used---dot locking and, if available, the + :c:func:`flock` and :c:func:`lockf` system calls. For MH mailboxes, locking + the mailbox means locking the :file:`.mh_sequences` file and, only for the + duration of any operations that affect them, locking individual message + files. + + + .. method:: get_file(key) + + Depending upon the host platform, it may not be possible to remove the + underlying message while the returned file remains open. + + + .. method:: flush() + + All changes to MH mailboxes are immediately applied, so this method does + nothing. + + + .. method:: close() + + :class:`MH` instances do not keep any open files, so this method is + equivalent to :meth:`unlock`. + + +.. seealso:: + + `nmh - Message Handling System `_ + Home page of :program:`nmh`, an updated version of the original :program:`mh`. + + `MH & nmh: Email for Users & Programmers `_ + A GPL-licensed book on :program:`mh` and :program:`nmh`, with some information + on the mailbox format. + + +.. _mailbox-babyl: + +:class:`Babyl` +^^^^^^^^^^^^^^ + + +.. class:: Babyl(path, factory=None, create=True) + + A subclass of :class:`Mailbox` for mailboxes in Babyl format. Parameter + *factory* is a callable object that accepts a file-like message representation + (which behaves as if opened in binary mode) and returns a custom representation. + If *factory* is ``None``, :class:`BabylMessage` is used as the default message + representation. If *create* is ``True``, the mailbox is created if it does not + exist. + + Babyl is a single-file mailbox format used by the Rmail mail user agent + included with Emacs. The beginning of a message is indicated by a line + containing the two characters Control-Underscore (``'\037'``) and Control-L + (``'\014'``). The end of a message is indicated by the start of the next + message or, in the case of the last message, a line containing a + Control-Underscore (``'\037'``) character. + + Messages in a Babyl mailbox have two sets of headers, original headers and + so-called visible headers. Visible headers are typically a subset of the + original headers that have been reformatted or abridged to be more + attractive. Each message in a Babyl mailbox also has an accompanying list of + :dfn:`labels`, or short strings that record extra information about the + message, and a list of all user-defined labels found in the mailbox is kept + in the Babyl options section. + + :class:`Babyl` instances have all of the methods of :class:`Mailbox` in + addition to the following: + + + .. method:: get_labels() + + Return a list of the names of all user-defined labels used in the mailbox. + + .. note:: + + The actual messages are inspected to determine which labels exist in + the mailbox rather than consulting the list of labels in the Babyl + options section, but the Babyl section is updated whenever the mailbox + is modified. + + Some :class:`Mailbox` methods implemented by :class:`Babyl` deserve special + remarks: + + + .. method:: get_file(key) + + In Babyl mailboxes, the headers of a message are not stored contiguously + with the body of the message. To generate a file-like representation, the + headers and body are copied together into an :class:`io.BytesIO` instance, + which has an API identical to that of a + file. As a result, the file-like object is truly independent of the + underlying mailbox but does not save memory compared to a string + representation. + + + .. method:: lock() + unlock() + + Three locking mechanisms are used---dot locking and, if available, the + :c:func:`flock` and :c:func:`lockf` system calls. + + +.. seealso:: + + `Format of Version 5 Babyl Files `_ + A specification of the Babyl format. + + `Reading Mail with Rmail `_ + The Rmail manual, with some information on Babyl semantics. + + +.. _mailbox-mmdf: + +:class:`MMDF` +^^^^^^^^^^^^^ + + +.. class:: MMDF(path, factory=None, create=True) + + A subclass of :class:`Mailbox` for mailboxes in MMDF format. Parameter *factory* + is a callable object that accepts a file-like message representation (which + behaves as if opened in binary mode) and returns a custom representation. If + *factory* is ``None``, :class:`MMDFMessage` is used as the default message + representation. If *create* is ``True``, the mailbox is created if it does not + exist. + + MMDF is a single-file mailbox format invented for the Multichannel Memorandum + Distribution Facility, a mail transfer agent. Each message is in the same + form as an mbox message but is bracketed before and after by lines containing + four Control-A (``'\001'``) characters. As with the mbox format, the + beginning of each message is indicated by a line whose first five characters + are "From ", but additional occurrences of "From " are not transformed to + ">From " when storing messages because the extra message separator lines + prevent mistaking such occurrences for the starts of subsequent messages. + + Some :class:`Mailbox` methods implemented by :class:`MMDF` deserve special + remarks: + + + .. method:: get_file(key) + + Using the file after calling :meth:`flush` or :meth:`close` on the + :class:`MMDF` instance may yield unpredictable results or raise an + exception. + + + .. method:: lock() + unlock() + + Three locking mechanisms are used---dot locking and, if available, the + :c:func:`flock` and :c:func:`lockf` system calls. + + +.. seealso:: + + `mmdf man page from tin `_ + A specification of MMDF format from the documentation of tin, a newsreader. + + `MMDF `_ + A Wikipedia article describing the Multichannel Memorandum Distribution + Facility. + + +.. _mailbox-message-objects: + +:class:`Message` objects +------------------------ + + +.. class:: Message(message=None) + + A subclass of the :mod:`email.message` module's + :class:`~email.message.Message`. Subclasses of :class:`mailbox.Message` add + mailbox-format-specific state and behavior. + + If *message* is omitted, the new instance is created in a default, empty state. + If *message* is an :class:`email.message.Message` instance, its contents are + copied; furthermore, any format-specific information is converted insofar as + possible if *message* is a :class:`Message` instance. If *message* is a string, + a byte string, + or a file, it should contain an :rfc:`2822`\ -compliant message, which is read + and parsed. Files should be open in binary mode, but text mode files + are accepted for backward compatibility. + + The format-specific state and behaviors offered by subclasses vary, but in + general it is only the properties that are not specific to a particular + mailbox that are supported (although presumably the properties are specific + to a particular mailbox format). For example, file offsets for single-file + mailbox formats and file names for directory-based mailbox formats are not + retained, because they are only applicable to the original mailbox. But state + such as whether a message has been read by the user or marked as important is + retained, because it applies to the message itself. + + There is no requirement that :class:`Message` instances be used to represent + messages retrieved using :class:`Mailbox` instances. In some situations, the + time and memory required to generate :class:`Message` representations might + not be acceptable. For such situations, :class:`Mailbox` instances also + offer string and file-like representations, and a custom message factory may + be specified when a :class:`Mailbox` instance is initialized. + + +.. _mailbox-maildirmessage: + +:class:`MaildirMessage` +^^^^^^^^^^^^^^^^^^^^^^^ + + +.. class:: MaildirMessage(message=None) + + A message with Maildir-specific behaviors. Parameter *message* has the same + meaning as with the :class:`Message` constructor. + + Typically, a mail user agent application moves all of the messages in the + :file:`new` subdirectory to the :file:`cur` subdirectory after the first time + the user opens and closes the mailbox, recording that the messages are old + whether or not they've actually been read. Each message in :file:`cur` has an + "info" section added to its file name to store information about its state. + (Some mail readers may also add an "info" section to messages in + :file:`new`.) The "info" section may take one of two forms: it may contain + "2," followed by a list of standardized flags (e.g., "2,FR") or it may + contain "1," followed by so-called experimental information. Standard flags + for Maildir messages are as follows: + + +------+---------+--------------------------------+ + | Flag | Meaning | Explanation | + +======+=========+================================+ + | D | Draft | Under composition | + +------+---------+--------------------------------+ + | F | Flagged | Marked as important | + +------+---------+--------------------------------+ + | P | Passed | Forwarded, resent, or bounced | + +------+---------+--------------------------------+ + | R | Replied | Replied to | + +------+---------+--------------------------------+ + | S | Seen | Read | + +------+---------+--------------------------------+ + | T | Trashed | Marked for subsequent deletion | + +------+---------+--------------------------------+ + + :class:`MaildirMessage` instances offer the following methods: + + + .. method:: get_subdir() + + Return either "new" (if the message should be stored in the :file:`new` + subdirectory) or "cur" (if the message should be stored in the :file:`cur` + subdirectory). + + .. note:: + + A message is typically moved from :file:`new` to :file:`cur` after its + mailbox has been accessed, whether or not the message is has been + read. A message ``msg`` has been read if ``"S" in msg.get_flags()`` is + ``True``. + + + .. method:: set_subdir(subdir) + + Set the subdirectory the message should be stored in. Parameter *subdir* + must be either "new" or "cur". + + + .. method:: get_flags() + + Return a string specifying the flags that are currently set. If the + message complies with the standard Maildir format, the result is the + concatenation in alphabetical order of zero or one occurrence of each of + ``'D'``, ``'F'``, ``'P'``, ``'R'``, ``'S'``, and ``'T'``. The empty string + is returned if no flags are set or if "info" contains experimental + semantics. + + + .. method:: set_flags(flags) + + Set the flags specified by *flags* and unset all others. + + + .. method:: add_flag(flag) + + Set the flag(s) specified by *flag* without changing other flags. To add + more than one flag at a time, *flag* may be a string of more than one + character. The current "info" is overwritten whether or not it contains + experimental information rather than flags. + + + .. method:: remove_flag(flag) + + Unset the flag(s) specified by *flag* without changing other flags. To + remove more than one flag at a time, *flag* maybe a string of more than + one character. If "info" contains experimental information rather than + flags, the current "info" is not modified. + + + .. method:: get_date() + + Return the delivery date of the message as a floating-point number + representing seconds since the epoch. + + + .. method:: set_date(date) + + Set the delivery date of the message to *date*, a floating-point number + representing seconds since the epoch. + + + .. method:: get_info() + + Return a string containing the "info" for a message. This is useful for + accessing and modifying "info" that is experimental (i.e., not a list of + flags). + + + .. method:: set_info(info) + + Set "info" to *info*, which should be a string. + +When a :class:`MaildirMessage` instance is created based upon an +:class:`mboxMessage` or :class:`MMDFMessage` instance, the :mailheader:`Status` +and :mailheader:`X-Status` headers are omitted and the following conversions +take place: + ++--------------------+----------------------------------------------+ +| Resulting state | :class:`mboxMessage` or :class:`MMDFMessage` | +| | state | ++====================+==============================================+ +| "cur" subdirectory | O flag | ++--------------------+----------------------------------------------+ +| F flag | F flag | ++--------------------+----------------------------------------------+ +| R flag | A flag | ++--------------------+----------------------------------------------+ +| S flag | R flag | ++--------------------+----------------------------------------------+ +| T flag | D flag | ++--------------------+----------------------------------------------+ + +When a :class:`MaildirMessage` instance is created based upon an +:class:`MHMessage` instance, the following conversions take place: + ++-------------------------------+--------------------------+ +| Resulting state | :class:`MHMessage` state | ++===============================+==========================+ +| "cur" subdirectory | "unseen" sequence | ++-------------------------------+--------------------------+ +| "cur" subdirectory and S flag | no "unseen" sequence | ++-------------------------------+--------------------------+ +| F flag | "flagged" sequence | ++-------------------------------+--------------------------+ +| R flag | "replied" sequence | ++-------------------------------+--------------------------+ + +When a :class:`MaildirMessage` instance is created based upon a +:class:`BabylMessage` instance, the following conversions take place: + ++-------------------------------+-------------------------------+ +| Resulting state | :class:`BabylMessage` state | ++===============================+===============================+ +| "cur" subdirectory | "unseen" label | ++-------------------------------+-------------------------------+ +| "cur" subdirectory and S flag | no "unseen" label | ++-------------------------------+-------------------------------+ +| P flag | "forwarded" or "resent" label | ++-------------------------------+-------------------------------+ +| R flag | "answered" label | ++-------------------------------+-------------------------------+ +| T flag | "deleted" label | ++-------------------------------+-------------------------------+ + + +.. _mailbox-mboxmessage: + +:class:`mboxMessage` +^^^^^^^^^^^^^^^^^^^^ + + +.. class:: mboxMessage(message=None) + + A message with mbox-specific behaviors. Parameter *message* has the same meaning + as with the :class:`Message` constructor. + + Messages in an mbox mailbox are stored together in a single file. The + sender's envelope address and the time of delivery are typically stored in a + line beginning with "From " that is used to indicate the start of a message, + though there is considerable variation in the exact format of this data among + mbox implementations. Flags that indicate the state of the message, such as + whether it has been read or marked as important, are typically stored in + :mailheader:`Status` and :mailheader:`X-Status` headers. + + Conventional flags for mbox messages are as follows: + + +------+----------+--------------------------------+ + | Flag | Meaning | Explanation | + +======+==========+================================+ + | R | Read | Read | + +------+----------+--------------------------------+ + | O | Old | Previously detected by MUA | + +------+----------+--------------------------------+ + | D | Deleted | Marked for subsequent deletion | + +------+----------+--------------------------------+ + | F | Flagged | Marked as important | + +------+----------+--------------------------------+ + | A | Answered | Replied to | + +------+----------+--------------------------------+ + + The "R" and "O" flags are stored in the :mailheader:`Status` header, and the + "D", "F", and "A" flags are stored in the :mailheader:`X-Status` header. The + flags and headers typically appear in the order mentioned. + + :class:`mboxMessage` instances offer the following methods: + + + .. method:: get_from() + + Return a string representing the "From " line that marks the start of the + message in an mbox mailbox. The leading "From " and the trailing newline + are excluded. + + + .. method:: set_from(from_, time_=None) + + Set the "From " line to *from_*, which should be specified without a + leading "From " or trailing newline. For convenience, *time_* may be + specified and will be formatted appropriately and appended to *from_*. If + *time_* is specified, it should be a :class:`time.struct_time` instance, a + tuple suitable for passing to :meth:`time.strftime`, or ``True`` (to use + :meth:`time.gmtime`). + + + .. method:: get_flags() + + Return a string specifying the flags that are currently set. If the + message complies with the conventional format, the result is the + concatenation in the following order of zero or one occurrence of each of + ``'R'``, ``'O'``, ``'D'``, ``'F'``, and ``'A'``. + + + .. method:: set_flags(flags) + + Set the flags specified by *flags* and unset all others. Parameter *flags* + should be the concatenation in any order of zero or more occurrences of + each of ``'R'``, ``'O'``, ``'D'``, ``'F'``, and ``'A'``. + + + .. method:: add_flag(flag) + + Set the flag(s) specified by *flag* without changing other flags. To add + more than one flag at a time, *flag* may be a string of more than one + character. + + + .. method:: remove_flag(flag) + + Unset the flag(s) specified by *flag* without changing other flags. To + remove more than one flag at a time, *flag* maybe a string of more than + one character. + +When an :class:`mboxMessage` instance is created based upon a +:class:`MaildirMessage` instance, a "From " line is generated based upon the +:class:`MaildirMessage` instance's delivery date, and the following conversions +take place: + ++-----------------+-------------------------------+ +| Resulting state | :class:`MaildirMessage` state | ++=================+===============================+ +| R flag | S flag | ++-----------------+-------------------------------+ +| O flag | "cur" subdirectory | ++-----------------+-------------------------------+ +| D flag | T flag | ++-----------------+-------------------------------+ +| F flag | F flag | ++-----------------+-------------------------------+ +| A flag | R flag | ++-----------------+-------------------------------+ + +When an :class:`mboxMessage` instance is created based upon an +:class:`MHMessage` instance, the following conversions take place: + ++-------------------+--------------------------+ +| Resulting state | :class:`MHMessage` state | ++===================+==========================+ +| R flag and O flag | no "unseen" sequence | ++-------------------+--------------------------+ +| O flag | "unseen" sequence | ++-------------------+--------------------------+ +| F flag | "flagged" sequence | ++-------------------+--------------------------+ +| A flag | "replied" sequence | ++-------------------+--------------------------+ + +When an :class:`mboxMessage` instance is created based upon a +:class:`BabylMessage` instance, the following conversions take place: + ++-------------------+-----------------------------+ +| Resulting state | :class:`BabylMessage` state | ++===================+=============================+ +| R flag and O flag | no "unseen" label | ++-------------------+-----------------------------+ +| O flag | "unseen" label | ++-------------------+-----------------------------+ +| D flag | "deleted" label | ++-------------------+-----------------------------+ +| A flag | "answered" label | ++-------------------+-----------------------------+ + +When a :class:`Message` instance is created based upon an :class:`MMDFMessage` +instance, the "From " line is copied and all flags directly correspond: + ++-----------------+----------------------------+ +| Resulting state | :class:`MMDFMessage` state | ++=================+============================+ +| R flag | R flag | ++-----------------+----------------------------+ +| O flag | O flag | ++-----------------+----------------------------+ +| D flag | D flag | ++-----------------+----------------------------+ +| F flag | F flag | ++-----------------+----------------------------+ +| A flag | A flag | ++-----------------+----------------------------+ + + +.. _mailbox-mhmessage: + +:class:`MHMessage` +^^^^^^^^^^^^^^^^^^ + + +.. class:: MHMessage(message=None) + + A message with MH-specific behaviors. Parameter *message* has the same meaning + as with the :class:`Message` constructor. + + MH messages do not support marks or flags in the traditional sense, but they + do support sequences, which are logical groupings of arbitrary messages. Some + mail reading programs (although not the standard :program:`mh` and + :program:`nmh`) use sequences in much the same way flags are used with other + formats, as follows: + + +----------+------------------------------------------+ + | Sequence | Explanation | + +==========+==========================================+ + | unseen | Not read, but previously detected by MUA | + +----------+------------------------------------------+ + | replied | Replied to | + +----------+------------------------------------------+ + | flagged | Marked as important | + +----------+------------------------------------------+ + + :class:`MHMessage` instances offer the following methods: + + + .. method:: get_sequences() + + Return a list of the names of sequences that include this message. + + + .. method:: set_sequences(sequences) + + Set the list of sequences that include this message. + + + .. method:: add_sequence(sequence) + + Add *sequence* to the list of sequences that include this message. + + + .. method:: remove_sequence(sequence) + + Remove *sequence* from the list of sequences that include this message. + +When an :class:`MHMessage` instance is created based upon a +:class:`MaildirMessage` instance, the following conversions take place: + ++--------------------+-------------------------------+ +| Resulting state | :class:`MaildirMessage` state | ++====================+===============================+ +| "unseen" sequence | no S flag | ++--------------------+-------------------------------+ +| "replied" sequence | R flag | ++--------------------+-------------------------------+ +| "flagged" sequence | F flag | ++--------------------+-------------------------------+ + +When an :class:`MHMessage` instance is created based upon an +:class:`mboxMessage` or :class:`MMDFMessage` instance, the :mailheader:`Status` +and :mailheader:`X-Status` headers are omitted and the following conversions +take place: + ++--------------------+----------------------------------------------+ +| Resulting state | :class:`mboxMessage` or :class:`MMDFMessage` | +| | state | ++====================+==============================================+ +| "unseen" sequence | no R flag | ++--------------------+----------------------------------------------+ +| "replied" sequence | A flag | ++--------------------+----------------------------------------------+ +| "flagged" sequence | F flag | ++--------------------+----------------------------------------------+ + +When an :class:`MHMessage` instance is created based upon a +:class:`BabylMessage` instance, the following conversions take place: + ++--------------------+-----------------------------+ +| Resulting state | :class:`BabylMessage` state | ++====================+=============================+ +| "unseen" sequence | "unseen" label | ++--------------------+-----------------------------+ +| "replied" sequence | "answered" label | ++--------------------+-----------------------------+ + + +.. _mailbox-babylmessage: + +:class:`BabylMessage` +^^^^^^^^^^^^^^^^^^^^^ + + +.. class:: BabylMessage(message=None) + + A message with Babyl-specific behaviors. Parameter *message* has the same + meaning as with the :class:`Message` constructor. + + Certain message labels, called :dfn:`attributes`, are defined by convention + to have special meanings. The attributes are as follows: + + +-----------+------------------------------------------+ + | Label | Explanation | + +===========+==========================================+ + | unseen | Not read, but previously detected by MUA | + +-----------+------------------------------------------+ + | deleted | Marked for subsequent deletion | + +-----------+------------------------------------------+ + | filed | Copied to another file or mailbox | + +-----------+------------------------------------------+ + | answered | Replied to | + +-----------+------------------------------------------+ + | forwarded | Forwarded | + +-----------+------------------------------------------+ + | edited | Modified by the user | + +-----------+------------------------------------------+ + | resent | Resent | + +-----------+------------------------------------------+ + + By default, Rmail displays only visible headers. The :class:`BabylMessage` + class, though, uses the original headers because they are more + complete. Visible headers may be accessed explicitly if desired. + + :class:`BabylMessage` instances offer the following methods: + + + .. method:: get_labels() + + Return a list of labels on the message. + + + .. method:: set_labels(labels) + + Set the list of labels on the message to *labels*. + + + .. method:: add_label(label) + + Add *label* to the list of labels on the message. + + + .. method:: remove_label(label) + + Remove *label* from the list of labels on the message. + + + .. method:: get_visible() + + Return an :class:`Message` instance whose headers are the message's + visible headers and whose body is empty. + + + .. method:: set_visible(visible) + + Set the message's visible headers to be the same as the headers in + *message*. Parameter *visible* should be a :class:`Message` instance, an + :class:`email.message.Message` instance, a string, or a file-like object + (which should be open in text mode). + + + .. method:: update_visible() + + When a :class:`BabylMessage` instance's original headers are modified, the + visible headers are not automatically modified to correspond. This method + updates the visible headers as follows: each visible header with a + corresponding original header is set to the value of the original header, + each visible header without a corresponding original header is removed, + and any of :mailheader:`Date`, :mailheader:`From`, :mailheader:`Reply-To`, + :mailheader:`To`, :mailheader:`CC`, and :mailheader:`Subject` that are + present in the original headers but not the visible headers are added to + the visible headers. + +When a :class:`BabylMessage` instance is created based upon a +:class:`MaildirMessage` instance, the following conversions take place: + ++-------------------+-------------------------------+ +| Resulting state | :class:`MaildirMessage` state | ++===================+===============================+ +| "unseen" label | no S flag | ++-------------------+-------------------------------+ +| "deleted" label | T flag | ++-------------------+-------------------------------+ +| "answered" label | R flag | ++-------------------+-------------------------------+ +| "forwarded" label | P flag | ++-------------------+-------------------------------+ + +When a :class:`BabylMessage` instance is created based upon an +:class:`mboxMessage` or :class:`MMDFMessage` instance, the :mailheader:`Status` +and :mailheader:`X-Status` headers are omitted and the following conversions +take place: + ++------------------+----------------------------------------------+ +| Resulting state | :class:`mboxMessage` or :class:`MMDFMessage` | +| | state | ++==================+==============================================+ +| "unseen" label | no R flag | ++------------------+----------------------------------------------+ +| "deleted" label | D flag | ++------------------+----------------------------------------------+ +| "answered" label | A flag | ++------------------+----------------------------------------------+ + +When a :class:`BabylMessage` instance is created based upon an +:class:`MHMessage` instance, the following conversions take place: + ++------------------+--------------------------+ +| Resulting state | :class:`MHMessage` state | ++==================+==========================+ +| "unseen" label | "unseen" sequence | ++------------------+--------------------------+ +| "answered" label | "replied" sequence | ++------------------+--------------------------+ + + +.. _mailbox-mmdfmessage: + +:class:`MMDFMessage` +^^^^^^^^^^^^^^^^^^^^ + + +.. class:: MMDFMessage(message=None) + + A message with MMDF-specific behaviors. Parameter *message* has the same meaning + as with the :class:`Message` constructor. + + As with message in an mbox mailbox, MMDF messages are stored with the + sender's address and the delivery date in an initial line beginning with + "From ". Likewise, flags that indicate the state of the message are + typically stored in :mailheader:`Status` and :mailheader:`X-Status` headers. + + Conventional flags for MMDF messages are identical to those of mbox message + and are as follows: + + +------+----------+--------------------------------+ + | Flag | Meaning | Explanation | + +======+==========+================================+ + | R | Read | Read | + +------+----------+--------------------------------+ + | O | Old | Previously detected by MUA | + +------+----------+--------------------------------+ + | D | Deleted | Marked for subsequent deletion | + +------+----------+--------------------------------+ + | F | Flagged | Marked as important | + +------+----------+--------------------------------+ + | A | Answered | Replied to | + +------+----------+--------------------------------+ + + The "R" and "O" flags are stored in the :mailheader:`Status` header, and the + "D", "F", and "A" flags are stored in the :mailheader:`X-Status` header. The + flags and headers typically appear in the order mentioned. + + :class:`MMDFMessage` instances offer the following methods, which are + identical to those offered by :class:`mboxMessage`: + + + .. method:: get_from() + + Return a string representing the "From " line that marks the start of the + message in an mbox mailbox. The leading "From " and the trailing newline + are excluded. + + + .. method:: set_from(from_, time_=None) + + Set the "From " line to *from_*, which should be specified without a + leading "From " or trailing newline. For convenience, *time_* may be + specified and will be formatted appropriately and appended to *from_*. If + *time_* is specified, it should be a :class:`time.struct_time` instance, a + tuple suitable for passing to :meth:`time.strftime`, or ``True`` (to use + :meth:`time.gmtime`). + + + .. method:: get_flags() + + Return a string specifying the flags that are currently set. If the + message complies with the conventional format, the result is the + concatenation in the following order of zero or one occurrence of each of + ``'R'``, ``'O'``, ``'D'``, ``'F'``, and ``'A'``. + + + .. method:: set_flags(flags) + + Set the flags specified by *flags* and unset all others. Parameter *flags* + should be the concatenation in any order of zero or more occurrences of + each of ``'R'``, ``'O'``, ``'D'``, ``'F'``, and ``'A'``. + + + .. method:: add_flag(flag) + + Set the flag(s) specified by *flag* without changing other flags. To add + more than one flag at a time, *flag* may be a string of more than one + character. + + + .. method:: remove_flag(flag) + + Unset the flag(s) specified by *flag* without changing other flags. To + remove more than one flag at a time, *flag* maybe a string of more than + one character. + +When an :class:`MMDFMessage` instance is created based upon a +:class:`MaildirMessage` instance, a "From " line is generated based upon the +:class:`MaildirMessage` instance's delivery date, and the following conversions +take place: + ++-----------------+-------------------------------+ +| Resulting state | :class:`MaildirMessage` state | ++=================+===============================+ +| R flag | S flag | ++-----------------+-------------------------------+ +| O flag | "cur" subdirectory | ++-----------------+-------------------------------+ +| D flag | T flag | ++-----------------+-------------------------------+ +| F flag | F flag | ++-----------------+-------------------------------+ +| A flag | R flag | ++-----------------+-------------------------------+ + +When an :class:`MMDFMessage` instance is created based upon an +:class:`MHMessage` instance, the following conversions take place: + ++-------------------+--------------------------+ +| Resulting state | :class:`MHMessage` state | ++===================+==========================+ +| R flag and O flag | no "unseen" sequence | ++-------------------+--------------------------+ +| O flag | "unseen" sequence | ++-------------------+--------------------------+ +| F flag | "flagged" sequence | ++-------------------+--------------------------+ +| A flag | "replied" sequence | ++-------------------+--------------------------+ + +When an :class:`MMDFMessage` instance is created based upon a +:class:`BabylMessage` instance, the following conversions take place: + ++-------------------+-----------------------------+ +| Resulting state | :class:`BabylMessage` state | ++===================+=============================+ +| R flag and O flag | no "unseen" label | ++-------------------+-----------------------------+ +| O flag | "unseen" label | ++-------------------+-----------------------------+ +| D flag | "deleted" label | ++-------------------+-----------------------------+ +| A flag | "answered" label | ++-------------------+-----------------------------+ + +When an :class:`MMDFMessage` instance is created based upon an +:class:`mboxMessage` instance, the "From " line is copied and all flags directly +correspond: + ++-----------------+----------------------------+ +| Resulting state | :class:`mboxMessage` state | ++=================+============================+ +| R flag | R flag | ++-----------------+----------------------------+ +| O flag | O flag | ++-----------------+----------------------------+ +| D flag | D flag | ++-----------------+----------------------------+ +| F flag | F flag | ++-----------------+----------------------------+ +| A flag | A flag | ++-----------------+----------------------------+ + + +Exceptions +---------- + +The following exception classes are defined in the :mod:`mailbox` module: + + +.. exception:: Error() + + The based class for all other module-specific exceptions. + + +.. exception:: NoSuchMailboxError() + + Raised when a mailbox is expected but is not found, such as when instantiating a + :class:`Mailbox` subclass with a path that does not exist (and with the *create* + parameter set to ``False``), or when opening a folder that does not exist. + + +.. exception:: NotEmptyError() + + Raised when a mailbox is not empty but is expected to be, such as when deleting + a folder that contains messages. + + +.. exception:: ExternalClashError() + + Raised when some mailbox-related condition beyond the control of the program + causes it to be unable to proceed, such as when failing to acquire a lock that + another program already holds a lock, or when a uniquely-generated file name + already exists. + + +.. exception:: FormatError() + + Raised when the data in a file cannot be parsed, such as when an :class:`MH` + instance attempts to read a corrupted :file:`.mh_sequences` file. + + +.. _mailbox-examples: + +Examples +-------- + +A simple example of printing the subjects of all messages in a mailbox that seem +interesting:: + + import mailbox + for message in mailbox.mbox('~/mbox'): + subject = message['subject'] # Could possibly be None. + if subject and 'python' in subject.lower(): + print(subject) + +To copy all mail from a Babyl mailbox to an MH mailbox, converting all of the +format-specific information that can be converted:: + + import mailbox + destination = mailbox.MH('~/Mail') + destination.lock() + for message in mailbox.Babyl('~/RMAIL'): + destination.add(mailbox.MHMessage(message)) + destination.flush() + destination.unlock() + +This example sorts mail from several mailing lists into different mailboxes, +being careful to avoid mail corruption due to concurrent modification by other +programs, mail loss due to interruption of the program, or premature termination +due to malformed messages in the mailbox:: + + import mailbox + import email.errors + + list_names = ('python-list', 'python-dev', 'python-bugs') + + boxes = {name: mailbox.mbox('~/email/%s' % name) for name in list_names} + inbox = mailbox.Maildir('~/Maildir', factory=None) + + for key in inbox.iterkeys(): + try: + message = inbox[key] + except email.errors.MessageParseError: + continue # The message is malformed. Just leave it. + + for name in list_names: + list_id = message['list-id'] + if list_id and name in list_id: + # Get mailbox to use + box = boxes[name] + + # Write copy to disk before removing original. + # If there's a crash, you might duplicate a message, but + # that's better than losing a message completely. + box.lock() + box.add(message) + box.flush() + box.unlock() + + # Remove original message + inbox.lock() + inbox.discard(key) + inbox.flush() + inbox.unlock() + break # Found destination, so stop looking. + + for box in boxes.itervalues(): + box.close() + diff --git a/python-3.7.4-docs-html/_sources/library/mailcap.rst.txt b/python-3.7.4-docs-html/_sources/library/mailcap.rst.txt new file mode 100644 index 0000000..896afd1 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/mailcap.rst.txt @@ -0,0 +1,76 @@ +:mod:`mailcap` --- Mailcap file handling +======================================== + +.. module:: mailcap + :synopsis: Mailcap file handling. + +**Source code:** :source:`Lib/mailcap.py` + +-------------- + +Mailcap files are used to configure how MIME-aware applications such as mail +readers and Web browsers react to files with different MIME types. (The name +"mailcap" is derived from the phrase "mail capability".) For example, a mailcap +file might contain a line like ``video/mpeg; xmpeg %s``. Then, if the user +encounters an email message or Web document with the MIME type +:mimetype:`video/mpeg`, ``%s`` will be replaced by a filename (usually one +belonging to a temporary file) and the :program:`xmpeg` program can be +automatically started to view the file. + +The mailcap format is documented in :rfc:`1524`, "A User Agent Configuration +Mechanism For Multimedia Mail Format Information," but is not an Internet +standard. However, mailcap files are supported on most Unix systems. + + +.. function:: findmatch(caps, MIMEtype, key='view', filename='/dev/null', plist=[]) + + Return a 2-tuple; the first element is a string containing the command line to + be executed (which can be passed to :func:`os.system`), and the second element + is the mailcap entry for a given MIME type. If no matching MIME type can be + found, ``(None, None)`` is returned. + + *key* is the name of the field desired, which represents the type of activity to + be performed; the default value is 'view', since in the most common case you + simply want to view the body of the MIME-typed data. Other possible values + might be 'compose' and 'edit', if you wanted to create a new body of the given + MIME type or alter the existing body data. See :rfc:`1524` for a complete list + of these fields. + + *filename* is the filename to be substituted for ``%s`` in the command line; the + default value is ``'/dev/null'`` which is almost certainly not what you want, so + usually you'll override it by specifying a filename. + + *plist* can be a list containing named parameters; the default value is simply + an empty list. Each entry in the list must be a string containing the parameter + name, an equals sign (``'='``), and the parameter's value. Mailcap entries can + contain named parameters like ``%{foo}``, which will be replaced by the value + of the parameter named 'foo'. For example, if the command line ``showpartial + %{id} %{number} %{total}`` was in a mailcap file, and *plist* was set to + ``['id=1', 'number=2', 'total=3']``, the resulting command line would be + ``'showpartial 1 2 3'``. + + In a mailcap file, the "test" field can optionally be specified to test some + external condition (such as the machine architecture, or the window system in + use) to determine whether or not the mailcap line applies. :func:`findmatch` + will automatically check such conditions and skip the entry if the check fails. + + +.. function:: getcaps() + + Returns a dictionary mapping MIME types to a list of mailcap file entries. This + dictionary must be passed to the :func:`findmatch` function. An entry is stored + as a list of dictionaries, but it shouldn't be necessary to know the details of + this representation. + + The information is derived from all of the mailcap files found on the system. + Settings in the user's mailcap file :file:`$HOME/.mailcap` will override + settings in the system mailcap files :file:`/etc/mailcap`, + :file:`/usr/etc/mailcap`, and :file:`/usr/local/etc/mailcap`. + +An example usage:: + + >>> import mailcap + >>> d = mailcap.getcaps() + >>> mailcap.findmatch(d, 'video/mpeg', filename='tmp1223') + ('xmpeg tmp1223', {'view': 'xmpeg %s'}) + diff --git a/python-3.7.4-docs-html/_sources/library/markup.rst.txt b/python-3.7.4-docs-html/_sources/library/markup.rst.txt new file mode 100644 index 0000000..1588aa8 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/markup.rst.txt @@ -0,0 +1,27 @@ +.. _markup: + +********************************** +Structured Markup Processing Tools +********************************** + +Python supports a variety of modules to work with various forms of structured +data markup. This includes modules to work with the Standard Generalized Markup +Language (SGML) and the Hypertext Markup Language (HTML), and several interfaces +for working with the Extensible Markup Language (XML). + + +.. toctree:: + + html.rst + html.parser.rst + html.entities.rst + xml.rst + xml.etree.elementtree.rst + xml.dom.rst + xml.dom.minidom.rst + xml.dom.pulldom.rst + xml.sax.rst + xml.sax.handler.rst + xml.sax.utils.rst + xml.sax.reader.rst + pyexpat.rst diff --git a/python-3.7.4-docs-html/_sources/library/marshal.rst.txt b/python-3.7.4-docs-html/_sources/library/marshal.rst.txt new file mode 100644 index 0000000..d65afc2 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/marshal.rst.txt @@ -0,0 +1,118 @@ +:mod:`marshal` --- Internal Python object serialization +======================================================= + +.. module:: marshal + :synopsis: Convert Python objects to streams of bytes and back (with different + constraints). + +-------------- + +This module contains functions that can read and write Python values in a binary +format. The format is specific to Python, but independent of machine +architecture issues (e.g., you can write a Python value to a file on a PC, +transport the file to a Sun, and read it back there). Details of the format are +undocumented on purpose; it may change between Python versions (although it +rarely does). [#]_ + +.. index:: + module: pickle + module: shelve + +This is not a general "persistence" module. For general persistence and +transfer of Python objects through RPC calls, see the modules :mod:`pickle` and +:mod:`shelve`. The :mod:`marshal` module exists mainly to support reading and +writing the "pseudo-compiled" code for Python modules of :file:`.pyc` files. +Therefore, the Python maintainers reserve the right to modify the marshal format +in backward incompatible ways should the need arise. If you're serializing and +de-serializing Python objects, use the :mod:`pickle` module instead -- the +performance is comparable, version independence is guaranteed, and pickle +supports a substantially wider range of objects than marshal. + +.. warning:: + + The :mod:`marshal` module is not intended to be secure against erroneous or + maliciously constructed data. Never unmarshal data received from an + untrusted or unauthenticated source. + +.. index:: object; code, code object + +Not all Python object types are supported; in general, only objects whose value +is independent from a particular invocation of Python can be written and read by +this module. The following types are supported: booleans, integers, floating +point numbers, complex numbers, strings, bytes, bytearrays, tuples, lists, sets, +frozensets, dictionaries, and code objects, where it should be understood that +tuples, lists, sets, frozensets and dictionaries are only supported as long as +the values contained therein are themselves supported. The +singletons :const:`None`, :const:`Ellipsis` and :exc:`StopIteration` can also be +marshalled and unmarshalled. +For format *version* lower than 3, recursive lists, sets and dictionaries cannot +be written (see below). + +There are functions that read/write files as well as functions operating on +bytes-like objects. + +The module defines these functions: + + +.. function:: dump(value, file[, version]) + + Write the value on the open file. The value must be a supported type. The + file must be a writeable :term:`binary file`. + + If the value has (or contains an object that has) an unsupported type, a + :exc:`ValueError` exception is raised --- but garbage data will also be written + to the file. The object will not be properly read back by :func:`load`. + + The *version* argument indicates the data format that ``dump`` should use + (see below). + + +.. function:: load(file) + + Read one value from the open file and return it. If no valid value is read + (e.g. because the data has a different Python version's incompatible marshal + format), raise :exc:`EOFError`, :exc:`ValueError` or :exc:`TypeError`. The + file must be a readable :term:`binary file`. + + .. note:: + + If an object containing an unsupported type was marshalled with :func:`dump`, + :func:`load` will substitute ``None`` for the unmarshallable type. + + +.. function:: dumps(value[, version]) + + Return the bytes object that would be written to a file by ``dump(value, file)``. The + value must be a supported type. Raise a :exc:`ValueError` exception if value + has (or contains an object that has) an unsupported type. + + The *version* argument indicates the data format that ``dumps`` should use + (see below). + + +.. function:: loads(bytes) + + Convert the :term:`bytes-like object` to a value. If no valid value is found, raise + :exc:`EOFError`, :exc:`ValueError` or :exc:`TypeError`. Extra bytes in the + input are ignored. + + +In addition, the following constants are defined: + +.. data:: version + + Indicates the format that the module uses. Version 0 is the historical + format, version 1 shares interned strings and version 2 uses a binary format + for floating point numbers. + Version 3 adds support for object instancing and recursion. + The current version is 4. + + +.. rubric:: Footnotes + +.. [#] The name of this module stems from a bit of terminology used by the designers of + Modula-3 (amongst others), who use the term "marshalling" for shipping of data + around in a self-contained form. Strictly speaking, "to marshal" means to + convert some data from internal to external form (in an RPC buffer for instance) + and "unmarshalling" for the reverse process. + diff --git a/python-3.7.4-docs-html/_sources/library/math.rst.txt b/python-3.7.4-docs-html/_sources/library/math.rst.txt new file mode 100644 index 0000000..fd96d7a --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/math.rst.txt @@ -0,0 +1,507 @@ +:mod:`math` --- Mathematical functions +====================================== + +.. module:: math + :synopsis: Mathematical functions (sin() etc.). + +.. testsetup:: + + from math import fsum + +-------------- + +This module provides access to the mathematical functions defined by the C +standard. + +These functions cannot be used with complex numbers; use the functions of the +same name from the :mod:`cmath` module if you require support for complex +numbers. The distinction between functions which support complex numbers and +those which don't is made since most users do not want to learn quite as much +mathematics as required to understand complex numbers. Receiving an exception +instead of a complex result allows earlier detection of the unexpected complex +number used as a parameter, so that the programmer can determine how and why it +was generated in the first place. + +The following functions are provided by this module. Except when explicitly +noted otherwise, all return values are floats. + + +Number-theoretic and representation functions +--------------------------------------------- + +.. function:: ceil(x) + + Return the ceiling of *x*, the smallest integer greater than or equal to *x*. + If *x* is not a float, delegates to ``x.__ceil__()``, which should return an + :class:`~numbers.Integral` value. + + +.. function:: copysign(x, y) + + Return a float with the magnitude (absolute value) of *x* but the sign of + *y*. On platforms that support signed zeros, ``copysign(1.0, -0.0)`` + returns *-1.0*. + + +.. function:: fabs(x) + + Return the absolute value of *x*. + + +.. function:: factorial(x) + + Return *x* factorial as an integer. Raises :exc:`ValueError` if *x* is not integral or + is negative. + + +.. function:: floor(x) + + Return the floor of *x*, the largest integer less than or equal to *x*. + If *x* is not a float, delegates to ``x.__floor__()``, which should return an + :class:`~numbers.Integral` value. + + +.. function:: fmod(x, y) + + Return ``fmod(x, y)``, as defined by the platform C library. Note that the + Python expression ``x % y`` may not return the same result. The intent of the C + standard is that ``fmod(x, y)`` be exactly (mathematically; to infinite + precision) equal to ``x - n*y`` for some integer *n* such that the result has + the same sign as *x* and magnitude less than ``abs(y)``. Python's ``x % y`` + returns a result with the sign of *y* instead, and may not be exactly computable + for float arguments. For example, ``fmod(-1e-100, 1e100)`` is ``-1e-100``, but + the result of Python's ``-1e-100 % 1e100`` is ``1e100-1e-100``, which cannot be + represented exactly as a float, and rounds to the surprising ``1e100``. For + this reason, function :func:`fmod` is generally preferred when working with + floats, while Python's ``x % y`` is preferred when working with integers. + + +.. function:: frexp(x) + + Return the mantissa and exponent of *x* as the pair ``(m, e)``. *m* is a float + and *e* is an integer such that ``x == m * 2**e`` exactly. If *x* is zero, + returns ``(0.0, 0)``, otherwise ``0.5 <= abs(m) < 1``. This is used to "pick + apart" the internal representation of a float in a portable way. + + +.. function:: fsum(iterable) + + Return an accurate floating point sum of values in the iterable. Avoids + loss of precision by tracking multiple intermediate partial sums:: + + >>> sum([.1, .1, .1, .1, .1, .1, .1, .1, .1, .1]) + 0.9999999999999999 + >>> fsum([.1, .1, .1, .1, .1, .1, .1, .1, .1, .1]) + 1.0 + + The algorithm's accuracy depends on IEEE-754 arithmetic guarantees and the + typical case where the rounding mode is half-even. On some non-Windows + builds, the underlying C library uses extended precision addition and may + occasionally double-round an intermediate sum causing it to be off in its + least significant bit. + + For further discussion and two alternative approaches, see the `ASPN cookbook + recipes for accurate floating point summation + `_\. + + +.. function:: gcd(a, b) + + Return the greatest common divisor of the integers *a* and *b*. If either + *a* or *b* is nonzero, then the value of ``gcd(a, b)`` is the largest + positive integer that divides both *a* and *b*. ``gcd(0, 0)`` returns + ``0``. + + .. versionadded:: 3.5 + + +.. function:: isclose(a, b, *, rel_tol=1e-09, abs_tol=0.0) + + Return ``True`` if the values *a* and *b* are close to each other and + ``False`` otherwise. + + Whether or not two values are considered close is determined according to + given absolute and relative tolerances. + + *rel_tol* is the relative tolerance -- it is the maximum allowed difference + between *a* and *b*, relative to the larger absolute value of *a* or *b*. + For example, to set a tolerance of 5%, pass ``rel_tol=0.05``. The default + tolerance is ``1e-09``, which assures that the two values are the same + within about 9 decimal digits. *rel_tol* must be greater than zero. + + *abs_tol* is the minimum absolute tolerance -- useful for comparisons near + zero. *abs_tol* must be at least zero. + + If no errors occur, the result will be: + ``abs(a-b) <= max(rel_tol * max(abs(a), abs(b)), abs_tol)``. + + The IEEE 754 special values of ``NaN``, ``inf``, and ``-inf`` will be + handled according to IEEE rules. Specifically, ``NaN`` is not considered + close to any other value, including ``NaN``. ``inf`` and ``-inf`` are only + considered close to themselves. + + .. versionadded:: 3.5 + + .. seealso:: + + :pep:`485` -- A function for testing approximate equality + + +.. function:: isfinite(x) + + Return ``True`` if *x* is neither an infinity nor a NaN, and + ``False`` otherwise. (Note that ``0.0`` *is* considered finite.) + + .. versionadded:: 3.2 + + +.. function:: isinf(x) + + Return ``True`` if *x* is a positive or negative infinity, and + ``False`` otherwise. + + +.. function:: isnan(x) + + Return ``True`` if *x* is a NaN (not a number), and ``False`` otherwise. + + +.. function:: ldexp(x, i) + + Return ``x * (2**i)``. This is essentially the inverse of function + :func:`frexp`. + + +.. function:: modf(x) + + Return the fractional and integer parts of *x*. Both results carry the sign + of *x* and are floats. + + +.. function:: remainder(x, y) + + Return the IEEE 754-style remainder of *x* with respect to *y*. For + finite *x* and finite nonzero *y*, this is the difference ``x - n*y``, + where ``n`` is the closest integer to the exact value of the quotient ``x / + y``. If ``x / y`` is exactly halfway between two consecutive integers, the + nearest *even* integer is used for ``n``. The remainder ``r = remainder(x, + y)`` thus always satisfies ``abs(r) <= 0.5 * abs(y)``. + + Special cases follow IEEE 754: in particular, ``remainder(x, math.inf)`` is + *x* for any finite *x*, and ``remainder(x, 0)`` and + ``remainder(math.inf, x)`` raise :exc:`ValueError` for any non-NaN *x*. + If the result of the remainder operation is zero, that zero will have + the same sign as *x*. + + On platforms using IEEE 754 binary floating-point, the result of this + operation is always exactly representable: no rounding error is introduced. + + .. versionadded:: 3.7 + + +.. function:: trunc(x) + + Return the :class:`~numbers.Real` value *x* truncated to an + :class:`~numbers.Integral` (usually an integer). Delegates to + :meth:`x.__trunc__() `. + + +Note that :func:`frexp` and :func:`modf` have a different call/return pattern +than their C equivalents: they take a single argument and return a pair of +values, rather than returning their second return value through an 'output +parameter' (there is no such thing in Python). + +For the :func:`ceil`, :func:`floor`, and :func:`modf` functions, note that *all* +floating-point numbers of sufficiently large magnitude are exact integers. +Python floats typically carry no more than 53 bits of precision (the same as the +platform C double type), in which case any float *x* with ``abs(x) >= 2**52`` +necessarily has no fractional bits. + + +Power and logarithmic functions +------------------------------- + +.. function:: exp(x) + + Return *e* raised to the power *x*, where *e* = 2.718281... is the base + of natural logarithms. This is usually more accurate than ``math.e ** x`` + or ``pow(math.e, x)``. + + +.. function:: expm1(x) + + Return *e* raised to the power *x*, minus 1. Here *e* is the base of natural + logarithms. For small floats *x*, the subtraction in ``exp(x) - 1`` + can result in a `significant loss of precision + `_\; the :func:`expm1` + function provides a way to compute this quantity to full precision:: + + >>> from math import exp, expm1 + >>> exp(1e-5) - 1 # gives result accurate to 11 places + 1.0000050000069649e-05 + >>> expm1(1e-5) # result accurate to full precision + 1.0000050000166668e-05 + + .. versionadded:: 3.2 + + +.. function:: log(x[, base]) + + With one argument, return the natural logarithm of *x* (to base *e*). + + With two arguments, return the logarithm of *x* to the given *base*, + calculated as ``log(x)/log(base)``. + + +.. function:: log1p(x) + + Return the natural logarithm of *1+x* (base *e*). The + result is calculated in a way which is accurate for *x* near zero. + + +.. function:: log2(x) + + Return the base-2 logarithm of *x*. This is usually more accurate than + ``log(x, 2)``. + + .. versionadded:: 3.3 + + .. seealso:: + + :meth:`int.bit_length` returns the number of bits necessary to represent + an integer in binary, excluding the sign and leading zeros. + + +.. function:: log10(x) + + Return the base-10 logarithm of *x*. This is usually more accurate + than ``log(x, 10)``. + + +.. function:: pow(x, y) + + Return ``x`` raised to the power ``y``. Exceptional cases follow + Annex 'F' of the C99 standard as far as possible. In particular, + ``pow(1.0, x)`` and ``pow(x, 0.0)`` always return ``1.0``, even + when ``x`` is a zero or a NaN. If both ``x`` and ``y`` are finite, + ``x`` is negative, and ``y`` is not an integer then ``pow(x, y)`` + is undefined, and raises :exc:`ValueError`. + + Unlike the built-in ``**`` operator, :func:`math.pow` converts both + its arguments to type :class:`float`. Use ``**`` or the built-in + :func:`pow` function for computing exact integer powers. + + +.. function:: sqrt(x) + + Return the square root of *x*. + + +Trigonometric functions +----------------------- + +.. function:: acos(x) + + Return the arc cosine of *x*, in radians. + + +.. function:: asin(x) + + Return the arc sine of *x*, in radians. + + +.. function:: atan(x) + + Return the arc tangent of *x*, in radians. + + +.. function:: atan2(y, x) + + Return ``atan(y / x)``, in radians. The result is between ``-pi`` and ``pi``. + The vector in the plane from the origin to point ``(x, y)`` makes this angle + with the positive X axis. The point of :func:`atan2` is that the signs of both + inputs are known to it, so it can compute the correct quadrant for the angle. + For example, ``atan(1)`` and ``atan2(1, 1)`` are both ``pi/4``, but ``atan2(-1, + -1)`` is ``-3*pi/4``. + + +.. function:: cos(x) + + Return the cosine of *x* radians. + + +.. function:: hypot(x, y) + + Return the Euclidean norm, ``sqrt(x*x + y*y)``. This is the length of the vector + from the origin to point ``(x, y)``. + + +.. function:: sin(x) + + Return the sine of *x* radians. + + +.. function:: tan(x) + + Return the tangent of *x* radians. + + +Angular conversion +------------------ + +.. function:: degrees(x) + + Convert angle *x* from radians to degrees. + + +.. function:: radians(x) + + Convert angle *x* from degrees to radians. + + +Hyperbolic functions +-------------------- + +`Hyperbolic functions `_ +are analogs of trigonometric functions that are based on hyperbolas +instead of circles. + +.. function:: acosh(x) + + Return the inverse hyperbolic cosine of *x*. + + +.. function:: asinh(x) + + Return the inverse hyperbolic sine of *x*. + + +.. function:: atanh(x) + + Return the inverse hyperbolic tangent of *x*. + + +.. function:: cosh(x) + + Return the hyperbolic cosine of *x*. + + +.. function:: sinh(x) + + Return the hyperbolic sine of *x*. + + +.. function:: tanh(x) + + Return the hyperbolic tangent of *x*. + + +Special functions +----------------- + +.. function:: erf(x) + + Return the `error function `_ at + *x*. + + The :func:`erf` function can be used to compute traditional statistical + functions such as the `cumulative standard normal distribution + `_:: + + def phi(x): + 'Cumulative distribution function for the standard normal distribution' + return (1.0 + erf(x / sqrt(2.0))) / 2.0 + + .. versionadded:: 3.2 + + +.. function:: erfc(x) + + Return the complementary error function at *x*. The `complementary error + function `_ is defined as + ``1.0 - erf(x)``. It is used for large values of *x* where a subtraction + from one would cause a `loss of significance + `_\. + + .. versionadded:: 3.2 + + +.. function:: gamma(x) + + Return the `Gamma function `_ at + *x*. + + .. versionadded:: 3.2 + + +.. function:: lgamma(x) + + Return the natural logarithm of the absolute value of the Gamma + function at *x*. + + .. versionadded:: 3.2 + + +Constants +--------- + +.. data:: pi + + The mathematical constant *π* = 3.141592..., to available precision. + + +.. data:: e + + The mathematical constant *e* = 2.718281..., to available precision. + + +.. data:: tau + + The mathematical constant *τ* = 6.283185..., to available precision. + Tau is a circle constant equal to 2\ *π*, the ratio of a circle's circumference to + its radius. To learn more about Tau, check out Vi Hart's video `Pi is (still) + Wrong `_, and start celebrating + `Tau day `_ by eating twice as much pie! + + .. versionadded:: 3.6 + + +.. data:: inf + + A floating-point positive infinity. (For negative infinity, use + ``-math.inf``.) Equivalent to the output of ``float('inf')``. + + .. versionadded:: 3.5 + + +.. data:: nan + + A floating-point "not a number" (NaN) value. Equivalent to the output of + ``float('nan')``. + + .. versionadded:: 3.5 + + +.. impl-detail:: + + The :mod:`math` module consists mostly of thin wrappers around the platform C + math library functions. Behavior in exceptional cases follows Annex F of + the C99 standard where appropriate. The current implementation will raise + :exc:`ValueError` for invalid operations like ``sqrt(-1.0)`` or ``log(0.0)`` + (where C99 Annex F recommends signaling invalid operation or divide-by-zero), + and :exc:`OverflowError` for results that overflow (for example, + ``exp(1000.0)``). A NaN will not be returned from any of the functions + above unless one or more of the input arguments was a NaN; in that case, + most functions will return a NaN, but (again following C99 Annex F) there + are some exceptions to this rule, for example ``pow(float('nan'), 0.0)`` or + ``hypot(float('nan'), float('inf'))``. + + Note that Python makes no effort to distinguish signaling NaNs from + quiet NaNs, and behavior for signaling NaNs remains unspecified. + Typical behavior is to treat all NaNs as though they were quiet. + + +.. seealso:: + + Module :mod:`cmath` + Complex number versions of many of these functions. diff --git a/python-3.7.4-docs-html/_sources/library/mimetypes.rst.txt b/python-3.7.4-docs-html/_sources/library/mimetypes.rst.txt new file mode 100644 index 0000000..4c445fb --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/mimetypes.rst.txt @@ -0,0 +1,269 @@ +:mod:`mimetypes` --- Map filenames to MIME types +================================================ + +.. module:: mimetypes + :synopsis: Mapping of filename extensions to MIME types. + +.. sectionauthor:: Fred L. Drake, Jr. + +**Source code:** :source:`Lib/mimetypes.py` + +.. index:: pair: MIME; content type + +-------------- + +The :mod:`mimetypes` module converts between a filename or URL and the MIME type +associated with the filename extension. Conversions are provided from filename +to MIME type and from MIME type to filename extension; encodings are not +supported for the latter conversion. + +The module provides one class and a number of convenience functions. The +functions are the normal interface to this module, but some applications may be +interested in the class as well. + +The functions described below provide the primary interface for this module. If +the module has not been initialized, they will call :func:`init` if they rely on +the information :func:`init` sets up. + + +.. function:: guess_type(url, strict=True) + + .. index:: pair: MIME; headers + + Guess the type of a file based on its filename or URL, given by *url*. The + return value is a tuple ``(type, encoding)`` where *type* is ``None`` if the + type can't be guessed (missing or unknown suffix) or a string of the form + ``'type/subtype'``, usable for a MIME :mailheader:`content-type` header. + + *encoding* is ``None`` for no encoding or the name of the program used to encode + (e.g. :program:`compress` or :program:`gzip`). The encoding is suitable for use + as a :mailheader:`Content-Encoding` header, **not** as a + :mailheader:`Content-Transfer-Encoding` header. The mappings are table driven. + Encoding suffixes are case sensitive; type suffixes are first tried case + sensitively, then case insensitively. + + The optional *strict* argument is a flag specifying whether the list of known MIME types + is limited to only the official types `registered with IANA + `_. + When *strict* is ``True`` (the default), only the IANA types are supported; when + *strict* is ``False``, some additional non-standard but commonly used MIME types + are also recognized. + + +.. function:: guess_all_extensions(type, strict=True) + + Guess the extensions for a file based on its MIME type, given by *type*. The + return value is a list of strings giving all possible filename extensions, + including the leading dot (``'.'``). The extensions are not guaranteed to have + been associated with any particular data stream, but would be mapped to the MIME + type *type* by :func:`guess_type`. + + The optional *strict* argument has the same meaning as with the :func:`guess_type` function. + + +.. function:: guess_extension(type, strict=True) + + Guess the extension for a file based on its MIME type, given by *type*. The + return value is a string giving a filename extension, including the leading dot + (``'.'``). The extension is not guaranteed to have been associated with any + particular data stream, but would be mapped to the MIME type *type* by + :func:`guess_type`. If no extension can be guessed for *type*, ``None`` is + returned. + + The optional *strict* argument has the same meaning as with the :func:`guess_type` function. + +Some additional functions and data items are available for controlling the +behavior of the module. + + +.. function:: init(files=None) + + Initialize the internal data structures. If given, *files* must be a sequence + of file names which should be used to augment the default type map. If omitted, + the file names to use are taken from :const:`knownfiles`; on Windows, the + current registry settings are loaded. Each file named in *files* or + :const:`knownfiles` takes precedence over those named before it. Calling + :func:`init` repeatedly is allowed. + + Specifying an empty list for *files* will prevent the system defaults from + being applied: only the well-known values will be present from a built-in list. + + If *files* is ``None`` the internal data structure is completely rebuilt to its + initial default value. This is a stable operation and will produce the same results + when called multiple times. + + .. versionchanged:: 3.2 + Previously, Windows registry settings were ignored. + + +.. function:: read_mime_types(filename) + + Load the type map given in the file *filename*, if it exists. The type map is + returned as a dictionary mapping filename extensions, including the leading dot + (``'.'``), to strings of the form ``'type/subtype'``. If the file *filename* + does not exist or cannot be read, ``None`` is returned. + + +.. function:: add_type(type, ext, strict=True) + + Add a mapping from the MIME type *type* to the extension *ext*. When the + extension is already known, the new type will replace the old one. When the type + is already known the extension will be added to the list of known extensions. + + When *strict* is ``True`` (the default), the mapping will be added to the + official MIME types, otherwise to the non-standard ones. + + +.. data:: inited + + Flag indicating whether or not the global data structures have been initialized. + This is set to ``True`` by :func:`init`. + + +.. data:: knownfiles + + .. index:: single: file; mime.types + + List of type map file names commonly installed. These files are typically named + :file:`mime.types` and are installed in different locations by different + packages. + + +.. data:: suffix_map + + Dictionary mapping suffixes to suffixes. This is used to allow recognition of + encoded files for which the encoding and the type are indicated by the same + extension. For example, the :file:`.tgz` extension is mapped to :file:`.tar.gz` + to allow the encoding and type to be recognized separately. + + +.. data:: encodings_map + + Dictionary mapping filename extensions to encoding types. + + +.. data:: types_map + + Dictionary mapping filename extensions to MIME types. + + +.. data:: common_types + + Dictionary mapping filename extensions to non-standard, but commonly found MIME + types. + + +An example usage of the module:: + + >>> import mimetypes + >>> mimetypes.init() + >>> mimetypes.knownfiles + ['/etc/mime.types', '/etc/httpd/mime.types', ... ] + >>> mimetypes.suffix_map['.tgz'] + '.tar.gz' + >>> mimetypes.encodings_map['.gz'] + 'gzip' + >>> mimetypes.types_map['.tgz'] + 'application/x-tar-gz' + + +.. _mimetypes-objects: + +MimeTypes Objects +----------------- + +The :class:`MimeTypes` class may be useful for applications which may want more +than one MIME-type database; it provides an interface similar to the one of the +:mod:`mimetypes` module. + + +.. class:: MimeTypes(filenames=(), strict=True) + + This class represents a MIME-types database. By default, it provides access to + the same database as the rest of this module. The initial database is a copy of + that provided by the module, and may be extended by loading additional + :file:`mime.types`\ -style files into the database using the :meth:`read` or + :meth:`readfp` methods. The mapping dictionaries may also be cleared before + loading additional data if the default data is not desired. + + The optional *filenames* parameter can be used to cause additional files to be + loaded "on top" of the default database. + + + .. attribute:: MimeTypes.suffix_map + + Dictionary mapping suffixes to suffixes. This is used to allow recognition of + encoded files for which the encoding and the type are indicated by the same + extension. For example, the :file:`.tgz` extension is mapped to :file:`.tar.gz` + to allow the encoding and type to be recognized separately. This is initially a + copy of the global :data:`suffix_map` defined in the module. + + + .. attribute:: MimeTypes.encodings_map + + Dictionary mapping filename extensions to encoding types. This is initially a + copy of the global :data:`encodings_map` defined in the module. + + + .. attribute:: MimeTypes.types_map + + Tuple containing two dictionaries, mapping filename extensions to MIME types: + the first dictionary is for the non-standards types and the second one is for + the standard types. They are initialized by :data:`common_types` and + :data:`types_map`. + + + .. attribute:: MimeTypes.types_map_inv + + Tuple containing two dictionaries, mapping MIME types to a list of filename + extensions: the first dictionary is for the non-standards types and the + second one is for the standard types. They are initialized by + :data:`common_types` and :data:`types_map`. + + + .. method:: MimeTypes.guess_extension(type, strict=True) + + Similar to the :func:`guess_extension` function, using the tables stored as part + of the object. + + + .. method:: MimeTypes.guess_type(url, strict=True) + + Similar to the :func:`guess_type` function, using the tables stored as part of + the object. + + + .. method:: MimeTypes.guess_all_extensions(type, strict=True) + + Similar to the :func:`guess_all_extensions` function, using the tables stored + as part of the object. + + + .. method:: MimeTypes.read(filename, strict=True) + + Load MIME information from a file named *filename*. This uses :meth:`readfp` to + parse the file. + + If *strict* is ``True``, information will be added to list of standard types, + else to the list of non-standard types. + + + .. method:: MimeTypes.readfp(fp, strict=True) + + Load MIME type information from an open file *fp*. The file must have the format of + the standard :file:`mime.types` files. + + If *strict* is ``True``, information will be added to the list of standard + types, else to the list of non-standard types. + + + .. method:: MimeTypes.read_windows_registry(strict=True) + + Load MIME type information from the Windows registry. + + .. availability:: Windows. + + If *strict* is ``True``, information will be added to the list of standard + types, else to the list of non-standard types. + + .. versionadded:: 3.2 diff --git a/python-3.7.4-docs-html/_sources/library/misc.rst.txt b/python-3.7.4-docs-html/_sources/library/misc.rst.txt new file mode 100644 index 0000000..0943235 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/misc.rst.txt @@ -0,0 +1,13 @@ +.. _misc: + +********************** +Miscellaneous Services +********************** + +The modules described in this chapter provide miscellaneous services that are +available in all Python versions. Here's an overview: + + +.. toctree:: + + formatter.rst diff --git a/python-3.7.4-docs-html/_sources/library/mm.rst.txt b/python-3.7.4-docs-html/_sources/library/mm.rst.txt new file mode 100644 index 0000000..c8f79c4 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/mm.rst.txt @@ -0,0 +1,22 @@ +.. _mmedia: + +******************* +Multimedia Services +******************* + +The modules described in this chapter implement various algorithms or interfaces +that are mainly useful for multimedia applications. They are available at the +discretion of the installation. Here's an overview: + + +.. toctree:: + + audioop.rst + aifc.rst + sunau.rst + wave.rst + chunk.rst + colorsys.rst + imghdr.rst + sndhdr.rst + ossaudiodev.rst diff --git a/python-3.7.4-docs-html/_sources/library/mmap.rst.txt b/python-3.7.4-docs-html/_sources/library/mmap.rst.txt new file mode 100644 index 0000000..f0d2071 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/mmap.rst.txt @@ -0,0 +1,290 @@ +:mod:`mmap` --- Memory-mapped file support +========================================== + +.. module:: mmap + :synopsis: Interface to memory-mapped files for Unix and Windows. + +-------------- + +Memory-mapped file objects behave like both :class:`bytearray` and like +:term:`file objects `. You can use mmap objects in most places +where :class:`bytearray` are expected; for example, you can use the :mod:`re` +module to search through a memory-mapped file. You can also change a single +byte by doing ``obj[index] = 97``, or change a subsequence by assigning to a +slice: ``obj[i1:i2] = b'...'``. You can also read and write data starting at +the current file position, and :meth:`seek` through the file to different positions. + +A memory-mapped file is created by the :class:`~mmap.mmap` constructor, which is +different on Unix and on Windows. In either case you must provide a file +descriptor for a file opened for update. If you wish to map an existing Python +file object, use its :meth:`fileno` method to obtain the correct value for the +*fileno* parameter. Otherwise, you can open the file using the +:func:`os.open` function, which returns a file descriptor directly (the file +still needs to be closed when done). + +.. note:: + If you want to create a memory-mapping for a writable, buffered file, you + should :func:`~io.IOBase.flush` the file first. This is necessary to ensure + that local modifications to the buffers are actually available to the + mapping. + +For both the Unix and Windows versions of the constructor, *access* may be +specified as an optional keyword parameter. *access* accepts one of four +values: :const:`ACCESS_READ`, :const:`ACCESS_WRITE`, or :const:`ACCESS_COPY` to +specify read-only, write-through or copy-on-write memory respectively, or +:const:`ACCESS_DEFAULT` to defer to *prot*. *access* can be used on both Unix +and Windows. If *access* is not specified, Windows mmap returns a +write-through mapping. The initial memory values for all three access types +are taken from the specified file. Assignment to an :const:`ACCESS_READ` +memory map raises a :exc:`TypeError` exception. Assignment to an +:const:`ACCESS_WRITE` memory map affects both memory and the underlying file. +Assignment to an :const:`ACCESS_COPY` memory map affects memory but does not +update the underlying file. + +.. versionchanged:: 3.7 + Added :const:`ACCESS_DEFAULT` constant. + +To map anonymous memory, -1 should be passed as the fileno along with the length. + +.. class:: mmap(fileno, length, tagname=None, access=ACCESS_DEFAULT[, offset]) + + **(Windows version)** Maps *length* bytes from the file specified by the + file handle *fileno*, and creates a mmap object. If *length* is larger + than the current size of the file, the file is extended to contain *length* + bytes. If *length* is ``0``, the maximum length of the map is the current + size of the file, except that if the file is empty Windows raises an + exception (you cannot create an empty mapping on Windows). + + *tagname*, if specified and not ``None``, is a string giving a tag name for + the mapping. Windows allows you to have many different mappings against + the same file. If you specify the name of an existing tag, that tag is + opened, otherwise a new tag of this name is created. If this parameter is + omitted or ``None``, the mapping is created without a name. Avoiding the + use of the tag parameter will assist in keeping your code portable between + Unix and Windows. + + *offset* may be specified as a non-negative integer offset. mmap references + will be relative to the offset from the beginning of the file. *offset* + defaults to 0. *offset* must be a multiple of the :const:`ALLOCATIONGRANULARITY`. + + +.. class:: mmap(fileno, length, flags=MAP_SHARED, prot=PROT_WRITE|PROT_READ, access=ACCESS_DEFAULT[, offset]) + :noindex: + + **(Unix version)** Maps *length* bytes from the file specified by the file + descriptor *fileno*, and returns a mmap object. If *length* is ``0``, the + maximum length of the map will be the current size of the file when + :class:`~mmap.mmap` is called. + + *flags* specifies the nature of the mapping. :const:`MAP_PRIVATE` creates a + private copy-on-write mapping, so changes to the contents of the mmap + object will be private to this process, and :const:`MAP_SHARED` creates a + mapping that's shared with all other processes mapping the same areas of + the file. The default value is :const:`MAP_SHARED`. + + *prot*, if specified, gives the desired memory protection; the two most + useful values are :const:`PROT_READ` and :const:`PROT_WRITE`, to specify + that the pages may be read or written. *prot* defaults to + :const:`PROT_READ \| PROT_WRITE`. + + *access* may be specified in lieu of *flags* and *prot* as an optional + keyword parameter. It is an error to specify both *flags*, *prot* and + *access*. See the description of *access* above for information on how to + use this parameter. + + *offset* may be specified as a non-negative integer offset. mmap references + will be relative to the offset from the beginning of the file. *offset* + defaults to 0. *offset* must be a multiple of :const:`ALLOCATIONGRANULARITY` + which is equal to :const:`PAGESIZE` on Unix systems. + + To ensure validity of the created memory mapping the file specified + by the descriptor *fileno* is internally automatically synchronized + with physical backing store on Mac OS X and OpenVMS. + + This example shows a simple way of using :class:`~mmap.mmap`:: + + import mmap + + # write a simple example file + with open("hello.txt", "wb") as f: + f.write(b"Hello Python!\n") + + with open("hello.txt", "r+b") as f: + # memory-map the file, size 0 means whole file + mm = mmap.mmap(f.fileno(), 0) + # read content via standard file methods + print(mm.readline()) # prints b"Hello Python!\n" + # read content via slice notation + print(mm[:5]) # prints b"Hello" + # update content using slice notation; + # note that new content must have same size + mm[6:] = b" world!\n" + # ... and read again using standard file methods + mm.seek(0) + print(mm.readline()) # prints b"Hello world!\n" + # close the map + mm.close() + + + :class:`~mmap.mmap` can also be used as a context manager in a :keyword:`with` + statement:: + + import mmap + + with mmap.mmap(-1, 13) as mm: + mm.write(b"Hello world!") + + .. versionadded:: 3.2 + Context manager support. + + + The next example demonstrates how to create an anonymous map and exchange + data between the parent and child processes:: + + import mmap + import os + + mm = mmap.mmap(-1, 13) + mm.write(b"Hello world!") + + pid = os.fork() + + if pid == 0: # In a child process + mm.seek(0) + print(mm.readline()) + + mm.close() + + + Memory-mapped file objects support the following methods: + + .. method:: close() + + Closes the mmap. Subsequent calls to other methods of the object will + result in a ValueError exception being raised. This will not close + the open file. + + + .. attribute:: closed + + ``True`` if the file is closed. + + .. versionadded:: 3.2 + + + .. method:: find(sub[, start[, end]]) + + Returns the lowest index in the object where the subsequence *sub* is + found, such that *sub* is contained in the range [*start*, *end*]. + Optional arguments *start* and *end* are interpreted as in slice notation. + Returns ``-1`` on failure. + + .. versionchanged:: 3.5 + Writable :term:`bytes-like object` is now accepted. + + + .. method:: flush([offset[, size]]) + + Flushes changes made to the in-memory copy of a file back to disk. Without + use of this call there is no guarantee that changes are written back before + the object is destroyed. If *offset* and *size* are specified, only + changes to the given range of bytes will be flushed to disk; otherwise, the + whole extent of the mapping is flushed. *offset* must be a multiple of the + :const:`PAGESIZE` or :const:`ALLOCATIONGRANULARITY`. + + **(Windows version)** A nonzero value returned indicates success; zero + indicates failure. + + **(Unix version)** A zero value is returned to indicate success. An + exception is raised when the call failed. + + + .. method:: move(dest, src, count) + + Copy the *count* bytes starting at offset *src* to the destination index + *dest*. If the mmap was created with :const:`ACCESS_READ`, then calls to + move will raise a :exc:`TypeError` exception. + + + .. method:: read([n]) + + Return a :class:`bytes` containing up to *n* bytes starting from the + current file position. If the argument is omitted, ``None`` or negative, + return all bytes from the current file position to the end of the + mapping. The file position is updated to point after the bytes that were + returned. + + .. versionchanged:: 3.3 + Argument can be omitted or ``None``. + + .. method:: read_byte() + + Returns a byte at the current file position as an integer, and advances + the file position by 1. + + + .. method:: readline() + + Returns a single line, starting at the current file position and up to the + next newline. + + + .. method:: resize(newsize) + + Resizes the map and the underlying file, if any. If the mmap was created + with :const:`ACCESS_READ` or :const:`ACCESS_COPY`, resizing the map will + raise a :exc:`TypeError` exception. + + + .. method:: rfind(sub[, start[, end]]) + + Returns the highest index in the object where the subsequence *sub* is + found, such that *sub* is contained in the range [*start*, *end*]. + Optional arguments *start* and *end* are interpreted as in slice notation. + Returns ``-1`` on failure. + + .. versionchanged:: 3.5 + Writable :term:`bytes-like object` is now accepted. + + + .. method:: seek(pos[, whence]) + + Set the file's current position. *whence* argument is optional and + defaults to ``os.SEEK_SET`` or ``0`` (absolute file positioning); other + values are ``os.SEEK_CUR`` or ``1`` (seek relative to the current + position) and ``os.SEEK_END`` or ``2`` (seek relative to the file's end). + + + .. method:: size() + + Return the length of the file, which can be larger than the size of the + memory-mapped area. + + + .. method:: tell() + + Returns the current position of the file pointer. + + + .. method:: write(bytes) + + Write the bytes in *bytes* into memory at the current position of the + file pointer and return the number of bytes written (never less than + ``len(bytes)``, since if the write fails, a :exc:`ValueError` will be + raised). The file position is updated to point after the bytes that + were written. If the mmap was created with :const:`ACCESS_READ`, then + writing to it will raise a :exc:`TypeError` exception. + + .. versionchanged:: 3.5 + Writable :term:`bytes-like object` is now accepted. + + .. versionchanged:: 3.6 + The number of bytes written is now returned. + + + .. method:: write_byte(byte) + + Write the integer *byte* into memory at the current + position of the file pointer; the file position is advanced by ``1``. If + the mmap was created with :const:`ACCESS_READ`, then writing to it will + raise a :exc:`TypeError` exception. diff --git a/python-3.7.4-docs-html/_sources/library/modulefinder.rst.txt b/python-3.7.4-docs-html/_sources/library/modulefinder.rst.txt new file mode 100644 index 0000000..7b39ce7 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/modulefinder.rst.txt @@ -0,0 +1,114 @@ +:mod:`modulefinder` --- Find modules used by a script +===================================================== + +.. module:: modulefinder + :synopsis: Find modules used by a script. + +.. sectionauthor:: A.M. Kuchling + +**Source code:** :source:`Lib/modulefinder.py` + +-------------- + +This module provides a :class:`ModuleFinder` class that can be used to determine +the set of modules imported by a script. ``modulefinder.py`` can also be run as +a script, giving the filename of a Python script as its argument, after which a +report of the imported modules will be printed. + + +.. function:: AddPackagePath(pkg_name, path) + + Record that the package named *pkg_name* can be found in the specified *path*. + + +.. function:: ReplacePackage(oldname, newname) + + Allows specifying that the module named *oldname* is in fact the package named + *newname*. + + +.. class:: ModuleFinder(path=None, debug=0, excludes=[], replace_paths=[]) + + This class provides :meth:`run_script` and :meth:`report` methods to determine + the set of modules imported by a script. *path* can be a list of directories to + search for modules; if not specified, ``sys.path`` is used. *debug* sets the + debugging level; higher values make the class print debugging messages about + what it's doing. *excludes* is a list of module names to exclude from the + analysis. *replace_paths* is a list of ``(oldpath, newpath)`` tuples that will + be replaced in module paths. + + + .. method:: report() + + Print a report to standard output that lists the modules imported by the + script and their paths, as well as modules that are missing or seem to be + missing. + + .. method:: run_script(pathname) + + Analyze the contents of the *pathname* file, which must contain Python + code. + + .. attribute:: modules + + A dictionary mapping module names to modules. See + :ref:`modulefinder-example`. + + +.. _modulefinder-example: + +Example usage of :class:`ModuleFinder` +-------------------------------------- + +The script that is going to get analyzed later on (bacon.py):: + + import re, itertools + + try: + import baconhameggs + except ImportError: + pass + + try: + import guido.python.ham + except ImportError: + pass + + +The script that will output the report of bacon.py:: + + from modulefinder import ModuleFinder + + finder = ModuleFinder() + finder.run_script('bacon.py') + + print('Loaded modules:') + for name, mod in finder.modules.items(): + print('%s: ' % name, end='') + print(','.join(list(mod.globalnames.keys())[:3])) + + print('-'*50) + print('Modules not imported:') + print('\n'.join(finder.badmodules.keys())) + +Sample output (may vary depending on the architecture):: + + Loaded modules: + _types: + copyreg: _inverted_registry,_slotnames,__all__ + sre_compile: isstring,_sre,_optimize_unicode + _sre: + sre_constants: REPEAT_ONE,makedict,AT_END_LINE + sys: + re: __module__,finditer,_expand + itertools: + __main__: re,itertools,baconhameggs + sre_parse: _PATTERNENDERS,SRE_FLAG_UNICODE + array: + types: __module__,IntType,TypeType + --------------------------------------------------- + Modules not imported: + guido.python.ham + baconhameggs + + diff --git a/python-3.7.4-docs-html/_sources/library/modules.rst.txt b/python-3.7.4-docs-html/_sources/library/modules.rst.txt new file mode 100644 index 0000000..6b2a40a --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/modules.rst.txt @@ -0,0 +1,19 @@ +.. _modules: + +***************** +Importing Modules +***************** + +The modules described in this chapter provide new ways to import other Python +modules and hooks for customizing the import process. + +The full list of modules described in this chapter is: + + +.. toctree:: + + zipimport.rst + pkgutil.rst + modulefinder.rst + runpy.rst + importlib.rst diff --git a/python-3.7.4-docs-html/_sources/library/msilib.rst.txt b/python-3.7.4-docs-html/_sources/library/msilib.rst.txt new file mode 100644 index 0000000..83b3d49 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/msilib.rst.txt @@ -0,0 +1,563 @@ +:mod:`msilib` --- Read and write Microsoft Installer files +========================================================== + +.. module:: msilib + :platform: Windows + :synopsis: Creation of Microsoft Installer files, and CAB files. + +.. moduleauthor:: Martin v. Löwis +.. sectionauthor:: Martin v. Löwis + +**Source code:** :source:`Lib/msilib/__init__.py` + +.. index:: single: msi + +-------------- + +The :mod:`msilib` supports the creation of Microsoft Installer (``.msi``) files. +Because these files often contain an embedded "cabinet" file (``.cab``), it also +exposes an API to create CAB files. Support for reading ``.cab`` files is +currently not implemented; read support for the ``.msi`` database is possible. + +This package aims to provide complete access to all tables in an ``.msi`` file, +therefore, it is a fairly low-level API. Two primary applications of this +package are the :mod:`distutils` command ``bdist_msi``, and the creation of +Python installer package itself (although that currently uses a different +version of ``msilib``). + +The package contents can be roughly split into four parts: low-level CAB +routines, low-level MSI routines, higher-level MSI routines, and standard table +structures. + + +.. function:: FCICreate(cabname, files) + + Create a new CAB file named *cabname*. *files* must be a list of tuples, each + containing the name of the file on disk, and the name of the file inside the CAB + file. + + The files are added to the CAB file in the order they appear in the list. All + files are added into a single CAB file, using the MSZIP compression algorithm. + + Callbacks to Python for the various steps of MSI creation are currently not + exposed. + + +.. function:: UuidCreate() + + Return the string representation of a new unique identifier. This wraps the + Windows API functions :c:func:`UuidCreate` and :c:func:`UuidToString`. + + +.. function:: OpenDatabase(path, persist) + + Return a new database object by calling MsiOpenDatabase. *path* is the file + name of the MSI file; *persist* can be one of the constants + ``MSIDBOPEN_CREATEDIRECT``, ``MSIDBOPEN_CREATE``, ``MSIDBOPEN_DIRECT``, + ``MSIDBOPEN_READONLY``, or ``MSIDBOPEN_TRANSACT``, and may include the flag + ``MSIDBOPEN_PATCHFILE``. See the Microsoft documentation for the meaning of + these flags; depending on the flags, an existing database is opened, or a new + one created. + + +.. function:: CreateRecord(count) + + Return a new record object by calling :c:func:`MSICreateRecord`. *count* is the + number of fields of the record. + + +.. function:: init_database(name, schema, ProductName, ProductCode, ProductVersion, Manufacturer) + + Create and return a new database *name*, initialize it with *schema*, and set + the properties *ProductName*, *ProductCode*, *ProductVersion*, and + *Manufacturer*. + + *schema* must be a module object containing ``tables`` and + ``_Validation_records`` attributes; typically, :mod:`msilib.schema` should be + used. + + The database will contain just the schema and the validation records when this + function returns. + + +.. function:: add_data(database, table, records) + + Add all *records* to the table named *table* in *database*. + + The *table* argument must be one of the predefined tables in the MSI schema, + e.g. ``'Feature'``, ``'File'``, ``'Component'``, ``'Dialog'``, ``'Control'``, + etc. + + *records* should be a list of tuples, each one containing all fields of a + record according to the schema of the table. For optional fields, + ``None`` can be passed. + + Field values can be ints, strings, or instances of the Binary class. + + +.. class:: Binary(filename) + + Represents entries in the Binary table; inserting such an object using + :func:`add_data` reads the file named *filename* into the table. + + +.. function:: add_tables(database, module) + + Add all table content from *module* to *database*. *module* must contain an + attribute *tables* listing all tables for which content should be added, and one + attribute per table that has the actual content. + + This is typically used to install the sequence tables. + + +.. function:: add_stream(database, name, path) + + Add the file *path* into the ``_Stream`` table of *database*, with the stream + name *name*. + + +.. function:: gen_uuid() + + Return a new UUID, in the format that MSI typically requires (i.e. in curly + braces, and with all hexdigits in upper-case). + + +.. seealso:: + + `FCICreate `_ + `UuidCreate `_ + `UuidToString `_ + +.. _database-objects: + +Database Objects +---------------- + + +.. method:: Database.OpenView(sql) + + Return a view object, by calling :c:func:`MSIDatabaseOpenView`. *sql* is the SQL + statement to execute. + + +.. method:: Database.Commit() + + Commit the changes pending in the current transaction, by calling + :c:func:`MSIDatabaseCommit`. + + +.. method:: Database.GetSummaryInformation(count) + + Return a new summary information object, by calling + :c:func:`MsiGetSummaryInformation`. *count* is the maximum number of updated + values. + +.. method:: Database.Close() + + Close the database object, through :c:func:`MsiCloseHandle`. + + .. versionadded:: 3.7 + +.. seealso:: + + `MSIDatabaseOpenView `_ + `MSIDatabaseCommit `_ + `MSIGetSummaryInformation `_ + `MsiCloseHandle `_ + +.. _view-objects: + +View Objects +------------ + + +.. method:: View.Execute(params) + + Execute the SQL query of the view, through :c:func:`MSIViewExecute`. If + *params* is not ``None``, it is a record describing actual values of the + parameter tokens in the query. + + +.. method:: View.GetColumnInfo(kind) + + Return a record describing the columns of the view, through calling + :c:func:`MsiViewGetColumnInfo`. *kind* can be either ``MSICOLINFO_NAMES`` or + ``MSICOLINFO_TYPES``. + + +.. method:: View.Fetch() + + Return a result record of the query, through calling :c:func:`MsiViewFetch`. + + +.. method:: View.Modify(kind, data) + + Modify the view, by calling :c:func:`MsiViewModify`. *kind* can be one of + ``MSIMODIFY_SEEK``, ``MSIMODIFY_REFRESH``, ``MSIMODIFY_INSERT``, + ``MSIMODIFY_UPDATE``, ``MSIMODIFY_ASSIGN``, ``MSIMODIFY_REPLACE``, + ``MSIMODIFY_MERGE``, ``MSIMODIFY_DELETE``, ``MSIMODIFY_INSERT_TEMPORARY``, + ``MSIMODIFY_VALIDATE``, ``MSIMODIFY_VALIDATE_NEW``, + ``MSIMODIFY_VALIDATE_FIELD``, or ``MSIMODIFY_VALIDATE_DELETE``. + + *data* must be a record describing the new data. + + +.. method:: View.Close() + + Close the view, through :c:func:`MsiViewClose`. + + +.. seealso:: + + `MsiViewExecute `_ + `MSIViewGetColumnInfo `_ + `MsiViewFetch `_ + `MsiViewModify `_ + `MsiViewClose `_ + +.. _summary-objects: + +Summary Information Objects +--------------------------- + + +.. method:: SummaryInformation.GetProperty(field) + + Return a property of the summary, through :c:func:`MsiSummaryInfoGetProperty`. + *field* is the name of the property, and can be one of the constants + ``PID_CODEPAGE``, ``PID_TITLE``, ``PID_SUBJECT``, ``PID_AUTHOR``, + ``PID_KEYWORDS``, ``PID_COMMENTS``, ``PID_TEMPLATE``, ``PID_LASTAUTHOR``, + ``PID_REVNUMBER``, ``PID_LASTPRINTED``, ``PID_CREATE_DTM``, + ``PID_LASTSAVE_DTM``, ``PID_PAGECOUNT``, ``PID_WORDCOUNT``, ``PID_CHARCOUNT``, + ``PID_APPNAME``, or ``PID_SECURITY``. + + +.. method:: SummaryInformation.GetPropertyCount() + + Return the number of summary properties, through + :c:func:`MsiSummaryInfoGetPropertyCount`. + + +.. method:: SummaryInformation.SetProperty(field, value) + + Set a property through :c:func:`MsiSummaryInfoSetProperty`. *field* can have the + same values as in :meth:`GetProperty`, *value* is the new value of the property. + Possible value types are integer and string. + + +.. method:: SummaryInformation.Persist() + + Write the modified properties to the summary information stream, using + :c:func:`MsiSummaryInfoPersist`. + + +.. seealso:: + + `MsiSummaryInfoGetProperty `_ + `MsiSummaryInfoGetPropertyCount `_ + `MsiSummaryInfoSetProperty `_ + `MsiSummaryInfoPersist `_ + +.. _record-objects: + +Record Objects +-------------- + + +.. method:: Record.GetFieldCount() + + Return the number of fields of the record, through + :c:func:`MsiRecordGetFieldCount`. + + +.. method:: Record.GetInteger(field) + + Return the value of *field* as an integer where possible. *field* must + be an integer. + + +.. method:: Record.GetString(field) + + Return the value of *field* as a string where possible. *field* must + be an integer. + + +.. method:: Record.SetString(field, value) + + Set *field* to *value* through :c:func:`MsiRecordSetString`. *field* must be an + integer; *value* a string. + + +.. method:: Record.SetStream(field, value) + + Set *field* to the contents of the file named *value*, through + :c:func:`MsiRecordSetStream`. *field* must be an integer; *value* a string. + + +.. method:: Record.SetInteger(field, value) + + Set *field* to *value* through :c:func:`MsiRecordSetInteger`. Both *field* and + *value* must be an integer. + + +.. method:: Record.ClearData() + + Set all fields of the record to 0, through :c:func:`MsiRecordClearData`. + + +.. seealso:: + + `MsiRecordGetFieldCount `_ + `MsiRecordSetString `_ + `MsiRecordSetStream `_ + `MsiRecordSetInteger `_ + `MsiRecordClearData `_ + +.. _msi-errors: + +Errors +------ + +All wrappers around MSI functions raise :exc:`MSIError`; the string inside the +exception will contain more detail. + + +.. _cab: + +CAB Objects +----------- + + +.. class:: CAB(name) + + The class :class:`CAB` represents a CAB file. During MSI construction, files + will be added simultaneously to the ``Files`` table, and to a CAB file. Then, + when all files have been added, the CAB file can be written, then added to the + MSI file. + + *name* is the name of the CAB file in the MSI file. + + + .. method:: append(full, file, logical) + + Add the file with the pathname *full* to the CAB file, under the name + *logical*. If there is already a file named *logical*, a new file name is + created. + + Return the index of the file in the CAB file, and the new name of the file + inside the CAB file. + + + .. method:: commit(database) + + Generate a CAB file, add it as a stream to the MSI file, put it into the + ``Media`` table, and remove the generated file from the disk. + + +.. _msi-directory: + +Directory Objects +----------------- + + +.. class:: Directory(database, cab, basedir, physical, logical, default, [componentflags]) + + Create a new directory in the Directory table. There is a current component at + each point in time for the directory, which is either explicitly created through + :meth:`start_component`, or implicitly when files are added for the first time. + Files are added into the current component, and into the cab file. To create a + directory, a base directory object needs to be specified (can be ``None``), the + path to the physical directory, and a logical directory name. *default* + specifies the DefaultDir slot in the directory table. *componentflags* specifies + the default flags that new components get. + + + .. method:: start_component(component=None, feature=None, flags=None, keyfile=None, uuid=None) + + Add an entry to the Component table, and make this component the current + component for this directory. If no component name is given, the directory + name is used. If no *feature* is given, the current feature is used. If no + *flags* are given, the directory's default flags are used. If no *keyfile* + is given, the KeyPath is left null in the Component table. + + + .. method:: add_file(file, src=None, version=None, language=None) + + Add a file to the current component of the directory, starting a new one + if there is no current component. By default, the file name in the source + and the file table will be identical. If the *src* file is specified, it + is interpreted relative to the current directory. Optionally, a *version* + and a *language* can be specified for the entry in the File table. + + + .. method:: glob(pattern, exclude=None) + + Add a list of files to the current component as specified in the glob + pattern. Individual files can be excluded in the *exclude* list. + + + .. method:: remove_pyc() + + Remove ``.pyc`` files on uninstall. + + +.. seealso:: + + `Directory Table `_ + `File Table `_ + `Component Table `_ + `FeatureComponents Table `_ + +.. _features: + +Features +-------- + + +.. class:: Feature(db, id, title, desc, display, level=1, parent=None, directory=None, attributes=0) + + Add a new record to the ``Feature`` table, using the values *id*, *parent.id*, + *title*, *desc*, *display*, *level*, *directory*, and *attributes*. The + resulting feature object can be passed to the :meth:`start_component` method of + :class:`Directory`. + + + .. method:: set_current() + + Make this feature the current feature of :mod:`msilib`. New components are + automatically added to the default feature, unless a feature is explicitly + specified. + + +.. seealso:: + + `Feature Table `_ + +.. _msi-gui: + +GUI classes +----------- + +:mod:`msilib` provides several classes that wrap the GUI tables in an MSI +database. However, no standard user interface is provided; use +:mod:`~distutils.command.bdist_msi` to create MSI files with a user-interface +for installing Python packages. + + +.. class:: Control(dlg, name) + + Base class of the dialog controls. *dlg* is the dialog object the control + belongs to, and *name* is the control's name. + + + .. method:: event(event, argument, condition=1, ordering=None) + + Make an entry into the ``ControlEvent`` table for this control. + + + .. method:: mapping(event, attribute) + + Make an entry into the ``EventMapping`` table for this control. + + + .. method:: condition(action, condition) + + Make an entry into the ``ControlCondition`` table for this control. + + +.. class:: RadioButtonGroup(dlg, name, property) + + Create a radio button control named *name*. *property* is the installer property + that gets set when a radio button is selected. + + + .. method:: add(name, x, y, width, height, text, value=None) + + Add a radio button named *name* to the group, at the coordinates *x*, *y*, + *width*, *height*, and with the label *text*. If *value* is ``None``, it + defaults to *name*. + + +.. class:: Dialog(db, name, x, y, w, h, attr, title, first, default, cancel) + + Return a new :class:`Dialog` object. An entry in the ``Dialog`` table is made, + with the specified coordinates, dialog attributes, title, name of the first, + default, and cancel controls. + + + .. method:: control(name, type, x, y, width, height, attributes, property, text, control_next, help) + + Return a new :class:`Control` object. An entry in the ``Control`` table is + made with the specified parameters. + + This is a generic method; for specific types, specialized methods are + provided. + + + .. method:: text(name, x, y, width, height, attributes, text) + + Add and return a ``Text`` control. + + + .. method:: bitmap(name, x, y, width, height, text) + + Add and return a ``Bitmap`` control. + + + .. method:: line(name, x, y, width, height) + + Add and return a ``Line`` control. + + + .. method:: pushbutton(name, x, y, width, height, attributes, text, next_control) + + Add and return a ``PushButton`` control. + + + .. method:: radiogroup(name, x, y, width, height, attributes, property, text, next_control) + + Add and return a ``RadioButtonGroup`` control. + + + .. method:: checkbox(name, x, y, width, height, attributes, property, text, next_control) + + Add and return a ``CheckBox`` control. + + +.. seealso:: + + `Dialog Table `_ + `Control Table `_ + `Control Types `_ + `ControlCondition Table `_ + `ControlEvent Table `_ + `EventMapping Table `_ + `RadioButton Table `_ + +.. _msi-tables: + +Precomputed tables +------------------ + +:mod:`msilib` provides a few subpackages that contain only schema and table +definitions. Currently, these definitions are based on MSI version 2.0. + + +.. data:: schema + + This is the standard MSI schema for MSI 2.0, with the *tables* variable + providing a list of table definitions, and *_Validation_records* providing the + data for MSI validation. + + +.. data:: sequence + + This module contains table contents for the standard sequence tables: + *AdminExecuteSequence*, *AdminUISequence*, *AdvtExecuteSequence*, + *InstallExecuteSequence*, and *InstallUISequence*. + + +.. data:: text + + This module contains definitions for the UIText and ActionText tables, for the + standard installer actions. diff --git a/python-3.7.4-docs-html/_sources/library/msvcrt.rst.txt b/python-3.7.4-docs-html/_sources/library/msvcrt.rst.txt new file mode 100644 index 0000000..bd34ffb --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/msvcrt.rst.txt @@ -0,0 +1,154 @@ +:mod:`msvcrt` --- Useful routines from the MS VC++ runtime +========================================================== + +.. module:: msvcrt + :platform: Windows + :synopsis: Miscellaneous useful routines from the MS VC++ runtime. + +.. sectionauthor:: Fred L. Drake, Jr. + +-------------- + +These functions provide access to some useful capabilities on Windows platforms. +Some higher-level modules use these functions to build the Windows +implementations of their services. For example, the :mod:`getpass` module uses +this in the implementation of the :func:`getpass` function. + +Further documentation on these functions can be found in the Platform API +documentation. + +The module implements both the normal and wide char variants of the console I/O +api. The normal API deals only with ASCII characters and is of limited use +for internationalized applications. The wide char API should be used where +ever possible. + +.. versionchanged:: 3.3 + Operations in this module now raise :exc:`OSError` where :exc:`IOError` + was raised. + + +.. _msvcrt-files: + +File Operations +--------------- + + +.. function:: locking(fd, mode, nbytes) + + Lock part of a file based on file descriptor *fd* from the C runtime. Raises + :exc:`OSError` on failure. The locked region of the file extends from the + current file position for *nbytes* bytes, and may continue beyond the end of the + file. *mode* must be one of the :const:`LK_\*` constants listed below. Multiple + regions in a file may be locked at the same time, but may not overlap. Adjacent + regions are not merged; they must be unlocked individually. + + +.. data:: LK_LOCK + LK_RLCK + + Locks the specified bytes. If the bytes cannot be locked, the program + immediately tries again after 1 second. If, after 10 attempts, the bytes cannot + be locked, :exc:`OSError` is raised. + + +.. data:: LK_NBLCK + LK_NBRLCK + + Locks the specified bytes. If the bytes cannot be locked, :exc:`OSError` is + raised. + + +.. data:: LK_UNLCK + + Unlocks the specified bytes, which must have been previously locked. + + +.. function:: setmode(fd, flags) + + Set the line-end translation mode for the file descriptor *fd*. To set it to + text mode, *flags* should be :const:`os.O_TEXT`; for binary, it should be + :const:`os.O_BINARY`. + + +.. function:: open_osfhandle(handle, flags) + + Create a C runtime file descriptor from the file handle *handle*. The *flags* + parameter should be a bitwise OR of :const:`os.O_APPEND`, :const:`os.O_RDONLY`, + and :const:`os.O_TEXT`. The returned file descriptor may be used as a parameter + to :func:`os.fdopen` to create a file object. + + +.. function:: get_osfhandle(fd) + + Return the file handle for the file descriptor *fd*. Raises :exc:`OSError` if + *fd* is not recognized. + + +.. _msvcrt-console: + +Console I/O +----------- + + +.. function:: kbhit() + + Return true if a keypress is waiting to be read. + + +.. function:: getch() + + Read a keypress and return the resulting character as a byte string. + Nothing is echoed to the console. This call will block if a keypress + is not already available, but will not wait for :kbd:`Enter` to be + pressed. If the pressed key was a special function key, this will + return ``'\000'`` or ``'\xe0'``; the next call will return the keycode. + The :kbd:`Control-C` keypress cannot be read with this function. + + +.. function:: getwch() + + Wide char variant of :func:`getch`, returning a Unicode value. + + +.. function:: getche() + + Similar to :func:`getch`, but the keypress will be echoed if it represents a + printable character. + + +.. function:: getwche() + + Wide char variant of :func:`getche`, returning a Unicode value. + + +.. function:: putch(char) + + Print the byte string *char* to the console without buffering. + + +.. function:: putwch(unicode_char) + + Wide char variant of :func:`putch`, accepting a Unicode value. + + +.. function:: ungetch(char) + + Cause the byte string *char* to be "pushed back" into the console buffer; + it will be the next character read by :func:`getch` or :func:`getche`. + + +.. function:: ungetwch(unicode_char) + + Wide char variant of :func:`ungetch`, accepting a Unicode value. + + +.. _msvcrt-other: + +Other Functions +--------------- + + +.. function:: heapmin() + + Force the :c:func:`malloc` heap to clean itself up and return unused blocks to + the operating system. On failure, this raises :exc:`OSError`. diff --git a/python-3.7.4-docs-html/_sources/library/multiprocessing.rst.txt b/python-3.7.4-docs-html/_sources/library/multiprocessing.rst.txt new file mode 100644 index 0000000..96e0dc8 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/multiprocessing.rst.txt @@ -0,0 +1,2862 @@ +:mod:`multiprocessing` --- Process-based parallelism +==================================================== + +.. module:: multiprocessing + :synopsis: Process-based parallelism. + +**Source code:** :source:`Lib/multiprocessing/` + +-------------- + +Introduction +------------ + +:mod:`multiprocessing` is a package that supports spawning processes using an +API similar to the :mod:`threading` module. The :mod:`multiprocessing` package +offers both local and remote concurrency, effectively side-stepping the +:term:`Global Interpreter Lock` by using subprocesses instead of threads. Due +to this, the :mod:`multiprocessing` module allows the programmer to fully +leverage multiple processors on a given machine. It runs on both Unix and +Windows. + +The :mod:`multiprocessing` module also introduces APIs which do not have +analogs in the :mod:`threading` module. A prime example of this is the +:class:`~multiprocessing.pool.Pool` object which offers a convenient means of +parallelizing the execution of a function across multiple input values, +distributing the input data across processes (data parallelism). The following +example demonstrates the common practice of defining such functions in a module +so that child processes can successfully import that module. This basic example +of data parallelism using :class:`~multiprocessing.pool.Pool`, :: + + from multiprocessing import Pool + + def f(x): + return x*x + + if __name__ == '__main__': + with Pool(5) as p: + print(p.map(f, [1, 2, 3])) + +will print to standard output :: + + [1, 4, 9] + + +The :class:`Process` class +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In :mod:`multiprocessing`, processes are spawned by creating a :class:`Process` +object and then calling its :meth:`~Process.start` method. :class:`Process` +follows the API of :class:`threading.Thread`. A trivial example of a +multiprocess program is :: + + from multiprocessing import Process + + def f(name): + print('hello', name) + + if __name__ == '__main__': + p = Process(target=f, args=('bob',)) + p.start() + p.join() + +To show the individual process IDs involved, here is an expanded example:: + + from multiprocessing import Process + import os + + def info(title): + print(title) + print('module name:', __name__) + print('parent process:', os.getppid()) + print('process id:', os.getpid()) + + def f(name): + info('function f') + print('hello', name) + + if __name__ == '__main__': + info('main line') + p = Process(target=f, args=('bob',)) + p.start() + p.join() + +For an explanation of why the ``if __name__ == '__main__'`` part is +necessary, see :ref:`multiprocessing-programming`. + + + +Contexts and start methods +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. _multiprocessing-start-methods: + +Depending on the platform, :mod:`multiprocessing` supports three ways +to start a process. These *start methods* are + + *spawn* + The parent process starts a fresh python interpreter process. The + child process will only inherit those resources necessary to run + the process objects :meth:`~Process.run` method. In particular, + unnecessary file descriptors and handles from the parent process + will not be inherited. Starting a process using this method is + rather slow compared to using *fork* or *forkserver*. + + Available on Unix and Windows. The default on Windows. + + *fork* + The parent process uses :func:`os.fork` to fork the Python + interpreter. The child process, when it begins, is effectively + identical to the parent process. All resources of the parent are + inherited by the child process. Note that safely forking a + multithreaded process is problematic. + + Available on Unix only. The default on Unix. + + *forkserver* + When the program starts and selects the *forkserver* start method, + a server process is started. From then on, whenever a new process + is needed, the parent process connects to the server and requests + that it fork a new process. The fork server process is single + threaded so it is safe for it to use :func:`os.fork`. No + unnecessary resources are inherited. + + Available on Unix platforms which support passing file descriptors + over Unix pipes. + +.. versionchanged:: 3.4 + *spawn* added on all unix platforms, and *forkserver* added for + some unix platforms. + Child processes no longer inherit all of the parents inheritable + handles on Windows. + +On Unix using the *spawn* or *forkserver* start methods will also +start a *semaphore tracker* process which tracks the unlinked named +semaphores created by processes of the program. When all processes +have exited the semaphore tracker unlinks any remaining semaphores. +Usually there should be none, but if a process was killed by a signal +there may be some "leaked" semaphores. (Unlinking the named semaphores +is a serious matter since the system allows only a limited number, and +they will not be automatically unlinked until the next reboot.) + +To select a start method you use the :func:`set_start_method` in +the ``if __name__ == '__main__'`` clause of the main module. For +example:: + + import multiprocessing as mp + + def foo(q): + q.put('hello') + + if __name__ == '__main__': + mp.set_start_method('spawn') + q = mp.Queue() + p = mp.Process(target=foo, args=(q,)) + p.start() + print(q.get()) + p.join() + +:func:`set_start_method` should not be used more than once in the +program. + +Alternatively, you can use :func:`get_context` to obtain a context +object. Context objects have the same API as the multiprocessing +module, and allow one to use multiple start methods in the same +program. :: + + import multiprocessing as mp + + def foo(q): + q.put('hello') + + if __name__ == '__main__': + ctx = mp.get_context('spawn') + q = ctx.Queue() + p = ctx.Process(target=foo, args=(q,)) + p.start() + print(q.get()) + p.join() + +Note that objects related to one context may not be compatible with +processes for a different context. In particular, locks created using +the *fork* context cannot be passed to processes started using the +*spawn* or *forkserver* start methods. + +A library which wants to use a particular start method should probably +use :func:`get_context` to avoid interfering with the choice of the +library user. + +.. warning:: + + The ``'spawn'`` and ``'forkserver'`` start methods cannot currently + be used with "frozen" executables (i.e., binaries produced by + packages like **PyInstaller** and **cx_Freeze**) on Unix. + The ``'fork'`` start method does work. + + +Exchanging objects between processes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:mod:`multiprocessing` supports two types of communication channel between +processes: + +**Queues** + + The :class:`Queue` class is a near clone of :class:`queue.Queue`. For + example:: + + from multiprocessing import Process, Queue + + def f(q): + q.put([42, None, 'hello']) + + if __name__ == '__main__': + q = Queue() + p = Process(target=f, args=(q,)) + p.start() + print(q.get()) # prints "[42, None, 'hello']" + p.join() + + Queues are thread and process safe. + +**Pipes** + + The :func:`Pipe` function returns a pair of connection objects connected by a + pipe which by default is duplex (two-way). For example:: + + from multiprocessing import Process, Pipe + + def f(conn): + conn.send([42, None, 'hello']) + conn.close() + + if __name__ == '__main__': + parent_conn, child_conn = Pipe() + p = Process(target=f, args=(child_conn,)) + p.start() + print(parent_conn.recv()) # prints "[42, None, 'hello']" + p.join() + + The two connection objects returned by :func:`Pipe` represent the two ends of + the pipe. Each connection object has :meth:`~Connection.send` and + :meth:`~Connection.recv` methods (among others). Note that data in a pipe + may become corrupted if two processes (or threads) try to read from or write + to the *same* end of the pipe at the same time. Of course there is no risk + of corruption from processes using different ends of the pipe at the same + time. + + +Synchronization between processes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:mod:`multiprocessing` contains equivalents of all the synchronization +primitives from :mod:`threading`. For instance one can use a lock to ensure +that only one process prints to standard output at a time:: + + from multiprocessing import Process, Lock + + def f(l, i): + l.acquire() + try: + print('hello world', i) + finally: + l.release() + + if __name__ == '__main__': + lock = Lock() + + for num in range(10): + Process(target=f, args=(lock, num)).start() + +Without using the lock output from the different processes is liable to get all +mixed up. + + +Sharing state between processes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +As mentioned above, when doing concurrent programming it is usually best to +avoid using shared state as far as possible. This is particularly true when +using multiple processes. + +However, if you really do need to use some shared data then +:mod:`multiprocessing` provides a couple of ways of doing so. + +**Shared memory** + + Data can be stored in a shared memory map using :class:`Value` or + :class:`Array`. For example, the following code :: + + from multiprocessing import Process, Value, Array + + def f(n, a): + n.value = 3.1415927 + for i in range(len(a)): + a[i] = -a[i] + + if __name__ == '__main__': + num = Value('d', 0.0) + arr = Array('i', range(10)) + + p = Process(target=f, args=(num, arr)) + p.start() + p.join() + + print(num.value) + print(arr[:]) + + will print :: + + 3.1415927 + [0, -1, -2, -3, -4, -5, -6, -7, -8, -9] + + The ``'d'`` and ``'i'`` arguments used when creating ``num`` and ``arr`` are + typecodes of the kind used by the :mod:`array` module: ``'d'`` indicates a + double precision float and ``'i'`` indicates a signed integer. These shared + objects will be process and thread-safe. + + For more flexibility in using shared memory one can use the + :mod:`multiprocessing.sharedctypes` module which supports the creation of + arbitrary ctypes objects allocated from shared memory. + +**Server process** + + A manager object returned by :func:`Manager` controls a server process which + holds Python objects and allows other processes to manipulate them using + proxies. + + A manager returned by :func:`Manager` will support types + :class:`list`, :class:`dict`, :class:`~managers.Namespace`, :class:`Lock`, + :class:`RLock`, :class:`Semaphore`, :class:`BoundedSemaphore`, + :class:`Condition`, :class:`Event`, :class:`Barrier`, + :class:`Queue`, :class:`Value` and :class:`Array`. For example, :: + + from multiprocessing import Process, Manager + + def f(d, l): + d[1] = '1' + d['2'] = 2 + d[0.25] = None + l.reverse() + + if __name__ == '__main__': + with Manager() as manager: + d = manager.dict() + l = manager.list(range(10)) + + p = Process(target=f, args=(d, l)) + p.start() + p.join() + + print(d) + print(l) + + will print :: + + {0.25: None, 1: '1', '2': 2} + [9, 8, 7, 6, 5, 4, 3, 2, 1, 0] + + Server process managers are more flexible than using shared memory objects + because they can be made to support arbitrary object types. Also, a single + manager can be shared by processes on different computers over a network. + They are, however, slower than using shared memory. + + +Using a pool of workers +~~~~~~~~~~~~~~~~~~~~~~~ + +The :class:`~multiprocessing.pool.Pool` class represents a pool of worker +processes. It has methods which allows tasks to be offloaded to the worker +processes in a few different ways. + +For example:: + + from multiprocessing import Pool, TimeoutError + import time + import os + + def f(x): + return x*x + + if __name__ == '__main__': + # start 4 worker processes + with Pool(processes=4) as pool: + + # print "[0, 1, 4,..., 81]" + print(pool.map(f, range(10))) + + # print same numbers in arbitrary order + for i in pool.imap_unordered(f, range(10)): + print(i) + + # evaluate "f(20)" asynchronously + res = pool.apply_async(f, (20,)) # runs in *only* one process + print(res.get(timeout=1)) # prints "400" + + # evaluate "os.getpid()" asynchronously + res = pool.apply_async(os.getpid, ()) # runs in *only* one process + print(res.get(timeout=1)) # prints the PID of that process + + # launching multiple evaluations asynchronously *may* use more processes + multiple_results = [pool.apply_async(os.getpid, ()) for i in range(4)] + print([res.get(timeout=1) for res in multiple_results]) + + # make a single worker sleep for 10 secs + res = pool.apply_async(time.sleep, (10,)) + try: + print(res.get(timeout=1)) + except TimeoutError: + print("We lacked patience and got a multiprocessing.TimeoutError") + + print("For the moment, the pool remains available for more work") + + # exiting the 'with'-block has stopped the pool + print("Now the pool is closed and no longer available") + +Note that the methods of a pool should only ever be used by the +process which created it. + +.. note:: + + Functionality within this package requires that the ``__main__`` module be + importable by the children. This is covered in :ref:`multiprocessing-programming` + however it is worth pointing out here. This means that some examples, such + as the :class:`multiprocessing.pool.Pool` examples will not work in the + interactive interpreter. For example:: + + >>> from multiprocessing import Pool + >>> p = Pool(5) + >>> def f(x): + ... return x*x + ... + >>> p.map(f, [1,2,3]) + Process PoolWorker-1: + Process PoolWorker-2: + Process PoolWorker-3: + Traceback (most recent call last): + Traceback (most recent call last): + Traceback (most recent call last): + AttributeError: 'module' object has no attribute 'f' + AttributeError: 'module' object has no attribute 'f' + AttributeError: 'module' object has no attribute 'f' + + (If you try this it will actually output three full tracebacks + interleaved in a semi-random fashion, and then you may have to + stop the master process somehow.) + + +Reference +--------- + +The :mod:`multiprocessing` package mostly replicates the API of the +:mod:`threading` module. + + +:class:`Process` and exceptions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. class:: Process(group=None, target=None, name=None, args=(), kwargs={}, \ + *, daemon=None) + + Process objects represent activity that is run in a separate process. The + :class:`Process` class has equivalents of all the methods of + :class:`threading.Thread`. + + The constructor should always be called with keyword arguments. *group* + should always be ``None``; it exists solely for compatibility with + :class:`threading.Thread`. *target* is the callable object to be invoked by + the :meth:`run()` method. It defaults to ``None``, meaning nothing is + called. *name* is the process name (see :attr:`name` for more details). + *args* is the argument tuple for the target invocation. *kwargs* is a + dictionary of keyword arguments for the target invocation. If provided, + the keyword-only *daemon* argument sets the process :attr:`daemon` flag + to ``True`` or ``False``. If ``None`` (the default), this flag will be + inherited from the creating process. + + By default, no arguments are passed to *target*. + + If a subclass overrides the constructor, it must make sure it invokes the + base class constructor (:meth:`Process.__init__`) before doing anything else + to the process. + + .. versionchanged:: 3.3 + Added the *daemon* argument. + + .. method:: run() + + Method representing the process's activity. + + You may override this method in a subclass. The standard :meth:`run` + method invokes the callable object passed to the object's constructor as + the target argument, if any, with sequential and keyword arguments taken + from the *args* and *kwargs* arguments, respectively. + + .. method:: start() + + Start the process's activity. + + This must be called at most once per process object. It arranges for the + object's :meth:`run` method to be invoked in a separate process. + + .. method:: join([timeout]) + + If the optional argument *timeout* is ``None`` (the default), the method + blocks until the process whose :meth:`join` method is called terminates. + If *timeout* is a positive number, it blocks at most *timeout* seconds. + Note that the method returns ``None`` if its process terminates or if the + method times out. Check the process's :attr:`exitcode` to determine if + it terminated. + + A process can be joined many times. + + A process cannot join itself because this would cause a deadlock. It is + an error to attempt to join a process before it has been started. + + .. attribute:: name + + The process's name. The name is a string used for identification purposes + only. It has no semantics. Multiple processes may be given the same + name. + + The initial name is set by the constructor. If no explicit name is + provided to the constructor, a name of the form + 'Process-N\ :sub:`1`:N\ :sub:`2`:...:N\ :sub:`k`' is constructed, where + each N\ :sub:`k` is the N-th child of its parent. + + .. method:: is_alive + + Return whether the process is alive. + + Roughly, a process object is alive from the moment the :meth:`start` + method returns until the child process terminates. + + .. attribute:: daemon + + The process's daemon flag, a Boolean value. This must be set before + :meth:`start` is called. + + The initial value is inherited from the creating process. + + When a process exits, it attempts to terminate all of its daemonic child + processes. + + Note that a daemonic process is not allowed to create child processes. + Otherwise a daemonic process would leave its children orphaned if it gets + terminated when its parent process exits. Additionally, these are **not** + Unix daemons or services, they are normal processes that will be + terminated (and not joined) if non-daemonic processes have exited. + + In addition to the :class:`threading.Thread` API, :class:`Process` objects + also support the following attributes and methods: + + .. attribute:: pid + + Return the process ID. Before the process is spawned, this will be + ``None``. + + .. attribute:: exitcode + + The child's exit code. This will be ``None`` if the process has not yet + terminated. A negative value *-N* indicates that the child was terminated + by signal *N*. + + .. attribute:: authkey + + The process's authentication key (a byte string). + + When :mod:`multiprocessing` is initialized the main process is assigned a + random string using :func:`os.urandom`. + + When a :class:`Process` object is created, it will inherit the + authentication key of its parent process, although this may be changed by + setting :attr:`authkey` to another byte string. + + See :ref:`multiprocessing-auth-keys`. + + .. attribute:: sentinel + + A numeric handle of a system object which will become "ready" when + the process ends. + + You can use this value if you want to wait on several events at + once using :func:`multiprocessing.connection.wait`. Otherwise + calling :meth:`join()` is simpler. + + On Windows, this is an OS handle usable with the ``WaitForSingleObject`` + and ``WaitForMultipleObjects`` family of API calls. On Unix, this is + a file descriptor usable with primitives from the :mod:`select` module. + + .. versionadded:: 3.3 + + .. method:: terminate() + + Terminate the process. On Unix this is done using the ``SIGTERM`` signal; + on Windows :c:func:`TerminateProcess` is used. Note that exit handlers and + finally clauses, etc., will not be executed. + + Note that descendant processes of the process will *not* be terminated -- + they will simply become orphaned. + + .. warning:: + + If this method is used when the associated process is using a pipe or + queue then the pipe or queue is liable to become corrupted and may + become unusable by other process. Similarly, if the process has + acquired a lock or semaphore etc. then terminating it is liable to + cause other processes to deadlock. + + .. method:: kill() + + Same as :meth:`terminate()` but using the ``SIGKILL`` signal on Unix. + + .. versionadded:: 3.7 + + .. method:: close() + + Close the :class:`Process` object, releasing all resources associated + with it. :exc:`ValueError` is raised if the underlying process + is still running. Once :meth:`close` returns successfully, most + other methods and attributes of the :class:`Process` object will + raise :exc:`ValueError`. + + .. versionadded:: 3.7 + + Note that the :meth:`start`, :meth:`join`, :meth:`is_alive`, + :meth:`terminate` and :attr:`exitcode` methods should only be called by + the process that created the process object. + + Example usage of some of the methods of :class:`Process`: + + .. doctest:: + + >>> import multiprocessing, time, signal + >>> p = multiprocessing.Process(target=time.sleep, args=(1000,)) + >>> print(p, p.is_alive()) + False + >>> p.start() + >>> print(p, p.is_alive()) + True + >>> p.terminate() + >>> time.sleep(0.1) + >>> print(p, p.is_alive()) + False + >>> p.exitcode == -signal.SIGTERM + True + +.. exception:: ProcessError + + The base class of all :mod:`multiprocessing` exceptions. + +.. exception:: BufferTooShort + + Exception raised by :meth:`Connection.recv_bytes_into()` when the supplied + buffer object is too small for the message read. + + If ``e`` is an instance of :exc:`BufferTooShort` then ``e.args[0]`` will give + the message as a byte string. + +.. exception:: AuthenticationError + + Raised when there is an authentication error. + +.. exception:: TimeoutError + + Raised by methods with a timeout when the timeout expires. + +Pipes and Queues +~~~~~~~~~~~~~~~~ + +When using multiple processes, one generally uses message passing for +communication between processes and avoids having to use any synchronization +primitives like locks. + +For passing messages one can use :func:`Pipe` (for a connection between two +processes) or a queue (which allows multiple producers and consumers). + +The :class:`Queue`, :class:`SimpleQueue` and :class:`JoinableQueue` types +are multi-producer, multi-consumer :abbr:`FIFO (first-in, first-out)` +queues modelled on the :class:`queue.Queue` class in the +standard library. They differ in that :class:`Queue` lacks the +:meth:`~queue.Queue.task_done` and :meth:`~queue.Queue.join` methods introduced +into Python 2.5's :class:`queue.Queue` class. + +If you use :class:`JoinableQueue` then you **must** call +:meth:`JoinableQueue.task_done` for each task removed from the queue or else the +semaphore used to count the number of unfinished tasks may eventually overflow, +raising an exception. + +Note that one can also create a shared queue by using a manager object -- see +:ref:`multiprocessing-managers`. + +.. note:: + + :mod:`multiprocessing` uses the usual :exc:`queue.Empty` and + :exc:`queue.Full` exceptions to signal a timeout. They are not available in + the :mod:`multiprocessing` namespace so you need to import them from + :mod:`queue`. + +.. note:: + + When an object is put on a queue, the object is pickled and a + background thread later flushes the pickled data to an underlying + pipe. This has some consequences which are a little surprising, + but should not cause any practical difficulties -- if they really + bother you then you can instead use a queue created with a + :ref:`manager `. + + (1) After putting an object on an empty queue there may be an + infinitesimal delay before the queue's :meth:`~Queue.empty` + method returns :const:`False` and :meth:`~Queue.get_nowait` can + return without raising :exc:`queue.Empty`. + + (2) If multiple processes are enqueuing objects, it is possible for + the objects to be received at the other end out-of-order. + However, objects enqueued by the same process will always be in + the expected order with respect to each other. + +.. warning:: + + If a process is killed using :meth:`Process.terminate` or :func:`os.kill` + while it is trying to use a :class:`Queue`, then the data in the queue is + likely to become corrupted. This may cause any other process to get an + exception when it tries to use the queue later on. + +.. warning:: + + As mentioned above, if a child process has put items on a queue (and it has + not used :meth:`JoinableQueue.cancel_join_thread + `), then that process will + not terminate until all buffered items have been flushed to the pipe. + + This means that if you try joining that process you may get a deadlock unless + you are sure that all items which have been put on the queue have been + consumed. Similarly, if the child process is non-daemonic then the parent + process may hang on exit when it tries to join all its non-daemonic children. + + Note that a queue created using a manager does not have this issue. See + :ref:`multiprocessing-programming`. + +For an example of the usage of queues for interprocess communication see +:ref:`multiprocessing-examples`. + + +.. function:: Pipe([duplex]) + + Returns a pair ``(conn1, conn2)`` of + :class:`~multiprocessing.connection.Connection` objects representing the + ends of a pipe. + + If *duplex* is ``True`` (the default) then the pipe is bidirectional. If + *duplex* is ``False`` then the pipe is unidirectional: ``conn1`` can only be + used for receiving messages and ``conn2`` can only be used for sending + messages. + + +.. class:: Queue([maxsize]) + + Returns a process shared queue implemented using a pipe and a few + locks/semaphores. When a process first puts an item on the queue a feeder + thread is started which transfers objects from a buffer into the pipe. + + The usual :exc:`queue.Empty` and :exc:`queue.Full` exceptions from the + standard library's :mod:`queue` module are raised to signal timeouts. + + :class:`Queue` implements all the methods of :class:`queue.Queue` except for + :meth:`~queue.Queue.task_done` and :meth:`~queue.Queue.join`. + + .. method:: qsize() + + Return the approximate size of the queue. Because of + multithreading/multiprocessing semantics, this number is not reliable. + + Note that this may raise :exc:`NotImplementedError` on Unix platforms like + Mac OS X where ``sem_getvalue()`` is not implemented. + + .. method:: empty() + + Return ``True`` if the queue is empty, ``False`` otherwise. Because of + multithreading/multiprocessing semantics, this is not reliable. + + .. method:: full() + + Return ``True`` if the queue is full, ``False`` otherwise. Because of + multithreading/multiprocessing semantics, this is not reliable. + + .. method:: put(obj[, block[, timeout]]) + + Put obj into the queue. If the optional argument *block* is ``True`` + (the default) and *timeout* is ``None`` (the default), block if necessary until + a free slot is available. If *timeout* is a positive number, it blocks at + most *timeout* seconds and raises the :exc:`queue.Full` exception if no + free slot was available within that time. Otherwise (*block* is + ``False``), put an item on the queue if a free slot is immediately + available, else raise the :exc:`queue.Full` exception (*timeout* is + ignored in that case). + + .. method:: put_nowait(obj) + + Equivalent to ``put(obj, False)``. + + .. method:: get([block[, timeout]]) + + Remove and return an item from the queue. If optional args *block* is + ``True`` (the default) and *timeout* is ``None`` (the default), block if + necessary until an item is available. If *timeout* is a positive number, + it blocks at most *timeout* seconds and raises the :exc:`queue.Empty` + exception if no item was available within that time. Otherwise (block is + ``False``), return an item if one is immediately available, else raise the + :exc:`queue.Empty` exception (*timeout* is ignored in that case). + + .. method:: get_nowait() + + Equivalent to ``get(False)``. + + :class:`multiprocessing.Queue` has a few additional methods not found in + :class:`queue.Queue`. These methods are usually unnecessary for most + code: + + .. method:: close() + + Indicate that no more data will be put on this queue by the current + process. The background thread will quit once it has flushed all buffered + data to the pipe. This is called automatically when the queue is garbage + collected. + + .. method:: join_thread() + + Join the background thread. This can only be used after :meth:`close` has + been called. It blocks until the background thread exits, ensuring that + all data in the buffer has been flushed to the pipe. + + By default if a process is not the creator of the queue then on exit it + will attempt to join the queue's background thread. The process can call + :meth:`cancel_join_thread` to make :meth:`join_thread` do nothing. + + .. method:: cancel_join_thread() + + Prevent :meth:`join_thread` from blocking. In particular, this prevents + the background thread from being joined automatically when the process + exits -- see :meth:`join_thread`. + + A better name for this method might be + ``allow_exit_without_flush()``. It is likely to cause enqueued + data to lost, and you almost certainly will not need to use it. + It is really only there if you need the current process to exit + immediately without waiting to flush enqueued data to the + underlying pipe, and you don't care about lost data. + + .. note:: + + This class's functionality requires a functioning shared semaphore + implementation on the host operating system. Without one, the + functionality in this class will be disabled, and attempts to + instantiate a :class:`Queue` will result in an :exc:`ImportError`. See + :issue:`3770` for additional information. The same holds true for any + of the specialized queue types listed below. + +.. class:: SimpleQueue() + + It is a simplified :class:`Queue` type, very close to a locked :class:`Pipe`. + + .. method:: empty() + + Return ``True`` if the queue is empty, ``False`` otherwise. + + .. method:: get() + + Remove and return an item from the queue. + + .. method:: put(item) + + Put *item* into the queue. + + +.. class:: JoinableQueue([maxsize]) + + :class:`JoinableQueue`, a :class:`Queue` subclass, is a queue which + additionally has :meth:`task_done` and :meth:`join` methods. + + .. method:: task_done() + + Indicate that a formerly enqueued task is complete. Used by queue + consumers. For each :meth:`~Queue.get` used to fetch a task, a subsequent + call to :meth:`task_done` tells the queue that the processing on the task + is complete. + + If a :meth:`~queue.Queue.join` is currently blocking, it will resume when all + items have been processed (meaning that a :meth:`task_done` call was + received for every item that had been :meth:`~Queue.put` into the queue). + + Raises a :exc:`ValueError` if called more times than there were items + placed in the queue. + + + .. method:: join() + + Block until all items in the queue have been gotten and processed. + + The count of unfinished tasks goes up whenever an item is added to the + queue. The count goes down whenever a consumer calls + :meth:`task_done` to indicate that the item was retrieved and all work on + it is complete. When the count of unfinished tasks drops to zero, + :meth:`~queue.Queue.join` unblocks. + + +Miscellaneous +~~~~~~~~~~~~~ + +.. function:: active_children() + + Return list of all live children of the current process. + + Calling this has the side effect of "joining" any processes which have + already finished. + +.. function:: cpu_count() + + Return the number of CPUs in the system. + + This number is not equivalent to the number of CPUs the current process can + use. The number of usable CPUs can be obtained with + ``len(os.sched_getaffinity(0))`` + + May raise :exc:`NotImplementedError`. + + .. seealso:: + :func:`os.cpu_count` + +.. function:: current_process() + + Return the :class:`Process` object corresponding to the current process. + + An analogue of :func:`threading.current_thread`. + +.. function:: freeze_support() + + Add support for when a program which uses :mod:`multiprocessing` has been + frozen to produce a Windows executable. (Has been tested with **py2exe**, + **PyInstaller** and **cx_Freeze**.) + + One needs to call this function straight after the ``if __name__ == + '__main__'`` line of the main module. For example:: + + from multiprocessing import Process, freeze_support + + def f(): + print('hello world!') + + if __name__ == '__main__': + freeze_support() + Process(target=f).start() + + If the ``freeze_support()`` line is omitted then trying to run the frozen + executable will raise :exc:`RuntimeError`. + + Calling ``freeze_support()`` has no effect when invoked on any operating + system other than Windows. In addition, if the module is being run + normally by the Python interpreter on Windows (the program has not been + frozen), then ``freeze_support()`` has no effect. + +.. function:: get_all_start_methods() + + Returns a list of the supported start methods, the first of which + is the default. The possible start methods are ``'fork'``, + ``'spawn'`` and ``'forkserver'``. On Windows only ``'spawn'`` is + available. On Unix ``'fork'`` and ``'spawn'`` are always + supported, with ``'fork'`` being the default. + + .. versionadded:: 3.4 + +.. function:: get_context(method=None) + + Return a context object which has the same attributes as the + :mod:`multiprocessing` module. + + If *method* is ``None`` then the default context is returned. + Otherwise *method* should be ``'fork'``, ``'spawn'``, + ``'forkserver'``. :exc:`ValueError` is raised if the specified + start method is not available. + + .. versionadded:: 3.4 + +.. function:: get_start_method(allow_none=False) + + Return the name of start method used for starting processes. + + If the start method has not been fixed and *allow_none* is false, + then the start method is fixed to the default and the name is + returned. If the start method has not been fixed and *allow_none* + is true then ``None`` is returned. + + The return value can be ``'fork'``, ``'spawn'``, ``'forkserver'`` + or ``None``. ``'fork'`` is the default on Unix, while ``'spawn'`` is + the default on Windows. + + .. versionadded:: 3.4 + +.. function:: set_executable() + + Sets the path of the Python interpreter to use when starting a child process. + (By default :data:`sys.executable` is used). Embedders will probably need to + do some thing like :: + + set_executable(os.path.join(sys.exec_prefix, 'pythonw.exe')) + + before they can create child processes. + + .. versionchanged:: 3.4 + Now supported on Unix when the ``'spawn'`` start method is used. + +.. function:: set_start_method(method) + + Set the method which should be used to start child processes. + *method* can be ``'fork'``, ``'spawn'`` or ``'forkserver'``. + + Note that this should be called at most once, and it should be + protected inside the ``if __name__ == '__main__'`` clause of the + main module. + + .. versionadded:: 3.4 + +.. note:: + + :mod:`multiprocessing` contains no analogues of + :func:`threading.active_count`, :func:`threading.enumerate`, + :func:`threading.settrace`, :func:`threading.setprofile`, + :class:`threading.Timer`, or :class:`threading.local`. + + +Connection Objects +~~~~~~~~~~~~~~~~~~ + +.. currentmodule:: multiprocessing.connection + +Connection objects allow the sending and receiving of picklable objects or +strings. They can be thought of as message oriented connected sockets. + +Connection objects are usually created using +:func:`Pipe ` -- see also +:ref:`multiprocessing-listeners-clients`. + +.. class:: Connection + + .. method:: send(obj) + + Send an object to the other end of the connection which should be read + using :meth:`recv`. + + The object must be picklable. Very large pickles (approximately 32 MiB+, + though it depends on the OS) may raise a :exc:`ValueError` exception. + + .. method:: recv() + + Return an object sent from the other end of the connection using + :meth:`send`. Blocks until there is something to receive. Raises + :exc:`EOFError` if there is nothing left to receive + and the other end was closed. + + .. method:: fileno() + + Return the file descriptor or handle used by the connection. + + .. method:: close() + + Close the connection. + + This is called automatically when the connection is garbage collected. + + .. method:: poll([timeout]) + + Return whether there is any data available to be read. + + If *timeout* is not specified then it will return immediately. If + *timeout* is a number then this specifies the maximum time in seconds to + block. If *timeout* is ``None`` then an infinite timeout is used. + + Note that multiple connection objects may be polled at once by + using :func:`multiprocessing.connection.wait`. + + .. method:: send_bytes(buffer[, offset[, size]]) + + Send byte data from a :term:`bytes-like object` as a complete message. + + If *offset* is given then data is read from that position in *buffer*. If + *size* is given then that many bytes will be read from buffer. Very large + buffers (approximately 32 MiB+, though it depends on the OS) may raise a + :exc:`ValueError` exception + + .. method:: recv_bytes([maxlength]) + + Return a complete message of byte data sent from the other end of the + connection as a string. Blocks until there is something to receive. + Raises :exc:`EOFError` if there is nothing left + to receive and the other end has closed. + + If *maxlength* is specified and the message is longer than *maxlength* + then :exc:`OSError` is raised and the connection will no longer be + readable. + + .. versionchanged:: 3.3 + This function used to raise :exc:`IOError`, which is now an + alias of :exc:`OSError`. + + + .. method:: recv_bytes_into(buffer[, offset]) + + Read into *buffer* a complete message of byte data sent from the other end + of the connection and return the number of bytes in the message. Blocks + until there is something to receive. Raises + :exc:`EOFError` if there is nothing left to receive and the other end was + closed. + + *buffer* must be a writable :term:`bytes-like object`. If + *offset* is given then the message will be written into the buffer from + that position. Offset must be a non-negative integer less than the + length of *buffer* (in bytes). + + If the buffer is too short then a :exc:`BufferTooShort` exception is + raised and the complete message is available as ``e.args[0]`` where ``e`` + is the exception instance. + + .. versionchanged:: 3.3 + Connection objects themselves can now be transferred between processes + using :meth:`Connection.send` and :meth:`Connection.recv`. + + .. versionadded:: 3.3 + Connection objects now support the context management protocol -- see + :ref:`typecontextmanager`. :meth:`~contextmanager.__enter__` returns the + connection object, and :meth:`~contextmanager.__exit__` calls :meth:`close`. + +For example: + +.. doctest:: + + >>> from multiprocessing import Pipe + >>> a, b = Pipe() + >>> a.send([1, 'hello', None]) + >>> b.recv() + [1, 'hello', None] + >>> b.send_bytes(b'thank you') + >>> a.recv_bytes() + b'thank you' + >>> import array + >>> arr1 = array.array('i', range(5)) + >>> arr2 = array.array('i', [0] * 10) + >>> a.send_bytes(arr1) + >>> count = b.recv_bytes_into(arr2) + >>> assert count == len(arr1) * arr1.itemsize + >>> arr2 + array('i', [0, 1, 2, 3, 4, 0, 0, 0, 0, 0]) + + +.. warning:: + + The :meth:`Connection.recv` method automatically unpickles the data it + receives, which can be a security risk unless you can trust the process + which sent the message. + + Therefore, unless the connection object was produced using :func:`Pipe` you + should only use the :meth:`~Connection.recv` and :meth:`~Connection.send` + methods after performing some sort of authentication. See + :ref:`multiprocessing-auth-keys`. + +.. warning:: + + If a process is killed while it is trying to read or write to a pipe then + the data in the pipe is likely to become corrupted, because it may become + impossible to be sure where the message boundaries lie. + + +Synchronization primitives +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. currentmodule:: multiprocessing + +Generally synchronization primitives are not as necessary in a multiprocess +program as they are in a multithreaded program. See the documentation for +:mod:`threading` module. + +Note that one can also create synchronization primitives by using a manager +object -- see :ref:`multiprocessing-managers`. + +.. class:: Barrier(parties[, action[, timeout]]) + + A barrier object: a clone of :class:`threading.Barrier`. + + .. versionadded:: 3.3 + +.. class:: BoundedSemaphore([value]) + + A bounded semaphore object: a close analog of + :class:`threading.BoundedSemaphore`. + + A solitary difference from its close analog exists: its ``acquire`` method's + first argument is named *block*, as is consistent with :meth:`Lock.acquire`. + + .. note:: + On Mac OS X, this is indistinguishable from :class:`Semaphore` because + ``sem_getvalue()`` is not implemented on that platform. + +.. class:: Condition([lock]) + + A condition variable: an alias for :class:`threading.Condition`. + + If *lock* is specified then it should be a :class:`Lock` or :class:`RLock` + object from :mod:`multiprocessing`. + + .. versionchanged:: 3.3 + The :meth:`~threading.Condition.wait_for` method was added. + +.. class:: Event() + + A clone of :class:`threading.Event`. + + +.. class:: Lock() + + A non-recursive lock object: a close analog of :class:`threading.Lock`. + Once a process or thread has acquired a lock, subsequent attempts to + acquire it from any process or thread will block until it is released; + any process or thread may release it. The concepts and behaviors of + :class:`threading.Lock` as it applies to threads are replicated here in + :class:`multiprocessing.Lock` as it applies to either processes or threads, + except as noted. + + Note that :class:`Lock` is actually a factory function which returns an + instance of ``multiprocessing.synchronize.Lock`` initialized with a + default context. + + :class:`Lock` supports the :term:`context manager` protocol and thus may be + used in :keyword:`with` statements. + + .. method:: acquire(block=True, timeout=None) + + Acquire a lock, blocking or non-blocking. + + With the *block* argument set to ``True`` (the default), the method call + will block until the lock is in an unlocked state, then set it to locked + and return ``True``. Note that the name of this first argument differs + from that in :meth:`threading.Lock.acquire`. + + With the *block* argument set to ``False``, the method call does not + block. If the lock is currently in a locked state, return ``False``; + otherwise set the lock to a locked state and return ``True``. + + When invoked with a positive, floating-point value for *timeout*, block + for at most the number of seconds specified by *timeout* as long as + the lock can not be acquired. Invocations with a negative value for + *timeout* are equivalent to a *timeout* of zero. Invocations with a + *timeout* value of ``None`` (the default) set the timeout period to + infinite. Note that the treatment of negative or ``None`` values for + *timeout* differs from the implemented behavior in + :meth:`threading.Lock.acquire`. The *timeout* argument has no practical + implications if the *block* argument is set to ``False`` and is thus + ignored. Returns ``True`` if the lock has been acquired or ``False`` if + the timeout period has elapsed. + + + .. method:: release() + + Release a lock. This can be called from any process or thread, not only + the process or thread which originally acquired the lock. + + Behavior is the same as in :meth:`threading.Lock.release` except that + when invoked on an unlocked lock, a :exc:`ValueError` is raised. + + +.. class:: RLock() + + A recursive lock object: a close analog of :class:`threading.RLock`. A + recursive lock must be released by the process or thread that acquired it. + Once a process or thread has acquired a recursive lock, the same process + or thread may acquire it again without blocking; that process or thread + must release it once for each time it has been acquired. + + Note that :class:`RLock` is actually a factory function which returns an + instance of ``multiprocessing.synchronize.RLock`` initialized with a + default context. + + :class:`RLock` supports the :term:`context manager` protocol and thus may be + used in :keyword:`with` statements. + + + .. method:: acquire(block=True, timeout=None) + + Acquire a lock, blocking or non-blocking. + + When invoked with the *block* argument set to ``True``, block until the + lock is in an unlocked state (not owned by any process or thread) unless + the lock is already owned by the current process or thread. The current + process or thread then takes ownership of the lock (if it does not + already have ownership) and the recursion level inside the lock increments + by one, resulting in a return value of ``True``. Note that there are + several differences in this first argument's behavior compared to the + implementation of :meth:`threading.RLock.acquire`, starting with the name + of the argument itself. + + When invoked with the *block* argument set to ``False``, do not block. + If the lock has already been acquired (and thus is owned) by another + process or thread, the current process or thread does not take ownership + and the recursion level within the lock is not changed, resulting in + a return value of ``False``. If the lock is in an unlocked state, the + current process or thread takes ownership and the recursion level is + incremented, resulting in a return value of ``True``. + + Use and behaviors of the *timeout* argument are the same as in + :meth:`Lock.acquire`. Note that some of these behaviors of *timeout* + differ from the implemented behaviors in :meth:`threading.RLock.acquire`. + + + .. method:: release() + + Release a lock, decrementing the recursion level. If after the + decrement the recursion level is zero, reset the lock to unlocked (not + owned by any process or thread) and if any other processes or threads + are blocked waiting for the lock to become unlocked, allow exactly one + of them to proceed. If after the decrement the recursion level is still + nonzero, the lock remains locked and owned by the calling process or + thread. + + Only call this method when the calling process or thread owns the lock. + An :exc:`AssertionError` is raised if this method is called by a process + or thread other than the owner or if the lock is in an unlocked (unowned) + state. Note that the type of exception raised in this situation + differs from the implemented behavior in :meth:`threading.RLock.release`. + + +.. class:: Semaphore([value]) + + A semaphore object: a close analog of :class:`threading.Semaphore`. + + A solitary difference from its close analog exists: its ``acquire`` method's + first argument is named *block*, as is consistent with :meth:`Lock.acquire`. + +.. note:: + + On Mac OS X, ``sem_timedwait`` is unsupported, so calling ``acquire()`` with + a timeout will emulate that function's behavior using a sleeping loop. + +.. note:: + + If the SIGINT signal generated by :kbd:`Ctrl-C` arrives while the main thread is + blocked by a call to :meth:`BoundedSemaphore.acquire`, :meth:`Lock.acquire`, + :meth:`RLock.acquire`, :meth:`Semaphore.acquire`, :meth:`Condition.acquire` + or :meth:`Condition.wait` then the call will be immediately interrupted and + :exc:`KeyboardInterrupt` will be raised. + + This differs from the behaviour of :mod:`threading` where SIGINT will be + ignored while the equivalent blocking calls are in progress. + +.. note:: + + Some of this package's functionality requires a functioning shared semaphore + implementation on the host operating system. Without one, the + :mod:`multiprocessing.synchronize` module will be disabled, and attempts to + import it will result in an :exc:`ImportError`. See + :issue:`3770` for additional information. + + +Shared :mod:`ctypes` Objects +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +It is possible to create shared objects using shared memory which can be +inherited by child processes. + +.. function:: Value(typecode_or_type, *args, lock=True) + + Return a :mod:`ctypes` object allocated from shared memory. By default the + return value is actually a synchronized wrapper for the object. The object + itself can be accessed via the *value* attribute of a :class:`Value`. + + *typecode_or_type* determines the type of the returned object: it is either a + ctypes type or a one character typecode of the kind used by the :mod:`array` + module. *\*args* is passed on to the constructor for the type. + + If *lock* is ``True`` (the default) then a new recursive lock + object is created to synchronize access to the value. If *lock* is + a :class:`Lock` or :class:`RLock` object then that will be used to + synchronize access to the value. If *lock* is ``False`` then + access to the returned object will not be automatically protected + by a lock, so it will not necessarily be "process-safe". + + Operations like ``+=`` which involve a read and write are not + atomic. So if, for instance, you want to atomically increment a + shared value it is insufficient to just do :: + + counter.value += 1 + + Assuming the associated lock is recursive (which it is by default) + you can instead do :: + + with counter.get_lock(): + counter.value += 1 + + Note that *lock* is a keyword-only argument. + +.. function:: Array(typecode_or_type, size_or_initializer, *, lock=True) + + Return a ctypes array allocated from shared memory. By default the return + value is actually a synchronized wrapper for the array. + + *typecode_or_type* determines the type of the elements of the returned array: + it is either a ctypes type or a one character typecode of the kind used by + the :mod:`array` module. If *size_or_initializer* is an integer, then it + determines the length of the array, and the array will be initially zeroed. + Otherwise, *size_or_initializer* is a sequence which is used to initialize + the array and whose length determines the length of the array. + + If *lock* is ``True`` (the default) then a new lock object is created to + synchronize access to the value. If *lock* is a :class:`Lock` or + :class:`RLock` object then that will be used to synchronize access to the + value. If *lock* is ``False`` then access to the returned object will not be + automatically protected by a lock, so it will not necessarily be + "process-safe". + + Note that *lock* is a keyword only argument. + + Note that an array of :data:`ctypes.c_char` has *value* and *raw* + attributes which allow one to use it to store and retrieve strings. + + +The :mod:`multiprocessing.sharedctypes` module +>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> + +.. module:: multiprocessing.sharedctypes + :synopsis: Allocate ctypes objects from shared memory. + +The :mod:`multiprocessing.sharedctypes` module provides functions for allocating +:mod:`ctypes` objects from shared memory which can be inherited by child +processes. + +.. note:: + + Although it is possible to store a pointer in shared memory remember that + this will refer to a location in the address space of a specific process. + However, the pointer is quite likely to be invalid in the context of a second + process and trying to dereference the pointer from the second process may + cause a crash. + +.. function:: RawArray(typecode_or_type, size_or_initializer) + + Return a ctypes array allocated from shared memory. + + *typecode_or_type* determines the type of the elements of the returned array: + it is either a ctypes type or a one character typecode of the kind used by + the :mod:`array` module. If *size_or_initializer* is an integer then it + determines the length of the array, and the array will be initially zeroed. + Otherwise *size_or_initializer* is a sequence which is used to initialize the + array and whose length determines the length of the array. + + Note that setting and getting an element is potentially non-atomic -- use + :func:`Array` instead to make sure that access is automatically synchronized + using a lock. + +.. function:: RawValue(typecode_or_type, *args) + + Return a ctypes object allocated from shared memory. + + *typecode_or_type* determines the type of the returned object: it is either a + ctypes type or a one character typecode of the kind used by the :mod:`array` + module. *\*args* is passed on to the constructor for the type. + + Note that setting and getting the value is potentially non-atomic -- use + :func:`Value` instead to make sure that access is automatically synchronized + using a lock. + + Note that an array of :data:`ctypes.c_char` has ``value`` and ``raw`` + attributes which allow one to use it to store and retrieve strings -- see + documentation for :mod:`ctypes`. + +.. function:: Array(typecode_or_type, size_or_initializer, *, lock=True) + + The same as :func:`RawArray` except that depending on the value of *lock* a + process-safe synchronization wrapper may be returned instead of a raw ctypes + array. + + If *lock* is ``True`` (the default) then a new lock object is created to + synchronize access to the value. If *lock* is a + :class:`~multiprocessing.Lock` or :class:`~multiprocessing.RLock` object + then that will be used to synchronize access to the + value. If *lock* is ``False`` then access to the returned object will not be + automatically protected by a lock, so it will not necessarily be + "process-safe". + + Note that *lock* is a keyword-only argument. + +.. function:: Value(typecode_or_type, *args, lock=True) + + The same as :func:`RawValue` except that depending on the value of *lock* a + process-safe synchronization wrapper may be returned instead of a raw ctypes + object. + + If *lock* is ``True`` (the default) then a new lock object is created to + synchronize access to the value. If *lock* is a :class:`~multiprocessing.Lock` or + :class:`~multiprocessing.RLock` object then that will be used to synchronize access to the + value. If *lock* is ``False`` then access to the returned object will not be + automatically protected by a lock, so it will not necessarily be + "process-safe". + + Note that *lock* is a keyword-only argument. + +.. function:: copy(obj) + + Return a ctypes object allocated from shared memory which is a copy of the + ctypes object *obj*. + +.. function:: synchronized(obj[, lock]) + + Return a process-safe wrapper object for a ctypes object which uses *lock* to + synchronize access. If *lock* is ``None`` (the default) then a + :class:`multiprocessing.RLock` object is created automatically. + + A synchronized wrapper will have two methods in addition to those of the + object it wraps: :meth:`get_obj` returns the wrapped object and + :meth:`get_lock` returns the lock object used for synchronization. + + Note that accessing the ctypes object through the wrapper can be a lot slower + than accessing the raw ctypes object. + + .. versionchanged:: 3.5 + Synchronized objects support the :term:`context manager` protocol. + + +The table below compares the syntax for creating shared ctypes objects from +shared memory with the normal ctypes syntax. (In the table ``MyStruct`` is some +subclass of :class:`ctypes.Structure`.) + +==================== ========================== =========================== +ctypes sharedctypes using type sharedctypes using typecode +==================== ========================== =========================== +c_double(2.4) RawValue(c_double, 2.4) RawValue('d', 2.4) +MyStruct(4, 6) RawValue(MyStruct, 4, 6) +(c_short * 7)() RawArray(c_short, 7) RawArray('h', 7) +(c_int * 3)(9, 2, 8) RawArray(c_int, (9, 2, 8)) RawArray('i', (9, 2, 8)) +==================== ========================== =========================== + + +Below is an example where a number of ctypes objects are modified by a child +process:: + + from multiprocessing import Process, Lock + from multiprocessing.sharedctypes import Value, Array + from ctypes import Structure, c_double + + class Point(Structure): + _fields_ = [('x', c_double), ('y', c_double)] + + def modify(n, x, s, A): + n.value **= 2 + x.value **= 2 + s.value = s.value.upper() + for a in A: + a.x **= 2 + a.y **= 2 + + if __name__ == '__main__': + lock = Lock() + + n = Value('i', 7) + x = Value(c_double, 1.0/3.0, lock=False) + s = Array('c', b'hello world', lock=lock) + A = Array(Point, [(1.875,-6.25), (-5.75,2.0), (2.375,9.5)], lock=lock) + + p = Process(target=modify, args=(n, x, s, A)) + p.start() + p.join() + + print(n.value) + print(x.value) + print(s.value) + print([(a.x, a.y) for a in A]) + + +.. highlight:: none + +The results printed are :: + + 49 + 0.1111111111111111 + HELLO WORLD + [(3.515625, 39.0625), (33.0625, 4.0), (5.640625, 90.25)] + +.. highlight:: python3 + + +.. _multiprocessing-managers: + +Managers +~~~~~~~~ + +Managers provide a way to create data which can be shared between different +processes, including sharing over a network between processes running on +different machines. A manager object controls a server process which manages +*shared objects*. Other processes can access the shared objects by using +proxies. + +.. function:: multiprocessing.Manager() + + Returns a started :class:`~multiprocessing.managers.SyncManager` object which + can be used for sharing objects between processes. The returned manager + object corresponds to a spawned child process and has methods which will + create shared objects and return corresponding proxies. + +.. module:: multiprocessing.managers + :synopsis: Share data between process with shared objects. + +Manager processes will be shutdown as soon as they are garbage collected or +their parent process exits. The manager classes are defined in the +:mod:`multiprocessing.managers` module: + +.. class:: BaseManager([address[, authkey]]) + + Create a BaseManager object. + + Once created one should call :meth:`start` or ``get_server().serve_forever()`` to ensure + that the manager object refers to a started manager process. + + *address* is the address on which the manager process listens for new + connections. If *address* is ``None`` then an arbitrary one is chosen. + + *authkey* is the authentication key which will be used to check the + validity of incoming connections to the server process. If + *authkey* is ``None`` then ``current_process().authkey`` is used. + Otherwise *authkey* is used and it must be a byte string. + + .. method:: start([initializer[, initargs]]) + + Start a subprocess to start the manager. If *initializer* is not ``None`` + then the subprocess will call ``initializer(*initargs)`` when it starts. + + .. method:: get_server() + + Returns a :class:`Server` object which represents the actual server under + the control of the Manager. The :class:`Server` object supports the + :meth:`serve_forever` method:: + + >>> from multiprocessing.managers import BaseManager + >>> manager = BaseManager(address=('', 50000), authkey=b'abc') + >>> server = manager.get_server() + >>> server.serve_forever() + + :class:`Server` additionally has an :attr:`address` attribute. + + .. method:: connect() + + Connect a local manager object to a remote manager process:: + + >>> from multiprocessing.managers import BaseManager + >>> m = BaseManager(address=('127.0.0.1', 50000), authkey=b'abc') + >>> m.connect() + + .. method:: shutdown() + + Stop the process used by the manager. This is only available if + :meth:`start` has been used to start the server process. + + This can be called multiple times. + + .. method:: register(typeid[, callable[, proxytype[, exposed[, method_to_typeid[, create_method]]]]]) + + A classmethod which can be used for registering a type or callable with + the manager class. + + *typeid* is a "type identifier" which is used to identify a particular + type of shared object. This must be a string. + + *callable* is a callable used for creating objects for this type + identifier. If a manager instance will be connected to the + server using the :meth:`connect` method, or if the + *create_method* argument is ``False`` then this can be left as + ``None``. + + *proxytype* is a subclass of :class:`BaseProxy` which is used to create + proxies for shared objects with this *typeid*. If ``None`` then a proxy + class is created automatically. + + *exposed* is used to specify a sequence of method names which proxies for + this typeid should be allowed to access using + :meth:`BaseProxy._callmethod`. (If *exposed* is ``None`` then + :attr:`proxytype._exposed_` is used instead if it exists.) In the case + where no exposed list is specified, all "public methods" of the shared + object will be accessible. (Here a "public method" means any attribute + which has a :meth:`~object.__call__` method and whose name does not begin + with ``'_'``.) + + *method_to_typeid* is a mapping used to specify the return type of those + exposed methods which should return a proxy. It maps method names to + typeid strings. (If *method_to_typeid* is ``None`` then + :attr:`proxytype._method_to_typeid_` is used instead if it exists.) If a + method's name is not a key of this mapping or if the mapping is ``None`` + then the object returned by the method will be copied by value. + + *create_method* determines whether a method should be created with name + *typeid* which can be used to tell the server process to create a new + shared object and return a proxy for it. By default it is ``True``. + + :class:`BaseManager` instances also have one read-only property: + + .. attribute:: address + + The address used by the manager. + + .. versionchanged:: 3.3 + Manager objects support the context management protocol -- see + :ref:`typecontextmanager`. :meth:`~contextmanager.__enter__` starts the + server process (if it has not already started) and then returns the + manager object. :meth:`~contextmanager.__exit__` calls :meth:`shutdown`. + + In previous versions :meth:`~contextmanager.__enter__` did not start the + manager's server process if it was not already started. + +.. class:: SyncManager + + A subclass of :class:`BaseManager` which can be used for the synchronization + of processes. Objects of this type are returned by + :func:`multiprocessing.Manager`. + + Its methods create and return :ref:`multiprocessing-proxy_objects` for a + number of commonly used data types to be synchronized across processes. + This notably includes shared lists and dictionaries. + + .. method:: Barrier(parties[, action[, timeout]]) + + Create a shared :class:`threading.Barrier` object and return a + proxy for it. + + .. versionadded:: 3.3 + + .. method:: BoundedSemaphore([value]) + + Create a shared :class:`threading.BoundedSemaphore` object and return a + proxy for it. + + .. method:: Condition([lock]) + + Create a shared :class:`threading.Condition` object and return a proxy for + it. + + If *lock* is supplied then it should be a proxy for a + :class:`threading.Lock` or :class:`threading.RLock` object. + + .. versionchanged:: 3.3 + The :meth:`~threading.Condition.wait_for` method was added. + + .. method:: Event() + + Create a shared :class:`threading.Event` object and return a proxy for it. + + .. method:: Lock() + + Create a shared :class:`threading.Lock` object and return a proxy for it. + + .. method:: Namespace() + + Create a shared :class:`Namespace` object and return a proxy for it. + + .. method:: Queue([maxsize]) + + Create a shared :class:`queue.Queue` object and return a proxy for it. + + .. method:: RLock() + + Create a shared :class:`threading.RLock` object and return a proxy for it. + + .. method:: Semaphore([value]) + + Create a shared :class:`threading.Semaphore` object and return a proxy for + it. + + .. method:: Array(typecode, sequence) + + Create an array and return a proxy for it. + + .. method:: Value(typecode, value) + + Create an object with a writable ``value`` attribute and return a proxy + for it. + + .. method:: dict() + dict(mapping) + dict(sequence) + + Create a shared :class:`dict` object and return a proxy for it. + + .. method:: list() + list(sequence) + + Create a shared :class:`list` object and return a proxy for it. + + .. versionchanged:: 3.6 + Shared objects are capable of being nested. For example, a shared + container object such as a shared list can contain other shared objects + which will all be managed and synchronized by the :class:`SyncManager`. + +.. class:: Namespace + + A type that can register with :class:`SyncManager`. + + A namespace object has no public methods, but does have writable attributes. + Its representation shows the values of its attributes. + + However, when using a proxy for a namespace object, an attribute beginning + with ``'_'`` will be an attribute of the proxy and not an attribute of the + referent: + + .. doctest:: + + >>> manager = multiprocessing.Manager() + >>> Global = manager.Namespace() + >>> Global.x = 10 + >>> Global.y = 'hello' + >>> Global._z = 12.3 # this is an attribute of the proxy + >>> print(Global) + Namespace(x=10, y='hello') + + +Customized managers +>>>>>>>>>>>>>>>>>>> + +To create one's own manager, one creates a subclass of :class:`BaseManager` and +uses the :meth:`~BaseManager.register` classmethod to register new types or +callables with the manager class. For example:: + + from multiprocessing.managers import BaseManager + + class MathsClass: + def add(self, x, y): + return x + y + def mul(self, x, y): + return x * y + + class MyManager(BaseManager): + pass + + MyManager.register('Maths', MathsClass) + + if __name__ == '__main__': + with MyManager() as manager: + maths = manager.Maths() + print(maths.add(4, 3)) # prints 7 + print(maths.mul(7, 8)) # prints 56 + + +Using a remote manager +>>>>>>>>>>>>>>>>>>>>>> + +It is possible to run a manager server on one machine and have clients use it +from other machines (assuming that the firewalls involved allow it). + +Running the following commands creates a server for a single shared queue which +remote clients can access:: + + >>> from multiprocessing.managers import BaseManager + >>> from queue import Queue + >>> queue = Queue() + >>> class QueueManager(BaseManager): pass + >>> QueueManager.register('get_queue', callable=lambda:queue) + >>> m = QueueManager(address=('', 50000), authkey=b'abracadabra') + >>> s = m.get_server() + >>> s.serve_forever() + +One client can access the server as follows:: + + >>> from multiprocessing.managers import BaseManager + >>> class QueueManager(BaseManager): pass + >>> QueueManager.register('get_queue') + >>> m = QueueManager(address=('foo.bar.org', 50000), authkey=b'abracadabra') + >>> m.connect() + >>> queue = m.get_queue() + >>> queue.put('hello') + +Another client can also use it:: + + >>> from multiprocessing.managers import BaseManager + >>> class QueueManager(BaseManager): pass + >>> QueueManager.register('get_queue') + >>> m = QueueManager(address=('foo.bar.org', 50000), authkey=b'abracadabra') + >>> m.connect() + >>> queue = m.get_queue() + >>> queue.get() + 'hello' + +Local processes can also access that queue, using the code from above on the +client to access it remotely:: + + >>> from multiprocessing import Process, Queue + >>> from multiprocessing.managers import BaseManager + >>> class Worker(Process): + ... def __init__(self, q): + ... self.q = q + ... super(Worker, self).__init__() + ... def run(self): + ... self.q.put('local hello') + ... + >>> queue = Queue() + >>> w = Worker(queue) + >>> w.start() + >>> class QueueManager(BaseManager): pass + ... + >>> QueueManager.register('get_queue', callable=lambda: queue) + >>> m = QueueManager(address=('', 50000), authkey=b'abracadabra') + >>> s = m.get_server() + >>> s.serve_forever() + +.. _multiprocessing-proxy_objects: + +Proxy Objects +~~~~~~~~~~~~~ + +A proxy is an object which *refers* to a shared object which lives (presumably) +in a different process. The shared object is said to be the *referent* of the +proxy. Multiple proxy objects may have the same referent. + +A proxy object has methods which invoke corresponding methods of its referent +(although not every method of the referent will necessarily be available through +the proxy). In this way, a proxy can be used just like its referent can: + +.. doctest:: + + >>> from multiprocessing import Manager + >>> manager = Manager() + >>> l = manager.list([i*i for i in range(10)]) + >>> print(l) + [0, 1, 4, 9, 16, 25, 36, 49, 64, 81] + >>> print(repr(l)) + + >>> l[4] + 16 + >>> l[2:5] + [4, 9, 16] + +Notice that applying :func:`str` to a proxy will return the representation of +the referent, whereas applying :func:`repr` will return the representation of +the proxy. + +An important feature of proxy objects is that they are picklable so they can be +passed between processes. As such, a referent can contain +:ref:`multiprocessing-proxy_objects`. This permits nesting of these managed +lists, dicts, and other :ref:`multiprocessing-proxy_objects`: + +.. doctest:: + + >>> a = manager.list() + >>> b = manager.list() + >>> a.append(b) # referent of a now contains referent of b + >>> print(a, b) + [] [] + >>> b.append('hello') + >>> print(a[0], b) + ['hello'] ['hello'] + +Similarly, dict and list proxies may be nested inside one another:: + + >>> l_outer = manager.list([ manager.dict() for i in range(2) ]) + >>> d_first_inner = l_outer[0] + >>> d_first_inner['a'] = 1 + >>> d_first_inner['b'] = 2 + >>> l_outer[1]['c'] = 3 + >>> l_outer[1]['z'] = 26 + >>> print(l_outer[0]) + {'a': 1, 'b': 2} + >>> print(l_outer[1]) + {'c': 3, 'z': 26} + +If standard (non-proxy) :class:`list` or :class:`dict` objects are contained +in a referent, modifications to those mutable values will not be propagated +through the manager because the proxy has no way of knowing when the values +contained within are modified. However, storing a value in a container proxy +(which triggers a ``__setitem__`` on the proxy object) does propagate through +the manager and so to effectively modify such an item, one could re-assign the +modified value to the container proxy:: + + # create a list proxy and append a mutable object (a dictionary) + lproxy = manager.list() + lproxy.append({}) + # now mutate the dictionary + d = lproxy[0] + d['a'] = 1 + d['b'] = 2 + # at this point, the changes to d are not yet synced, but by + # updating the dictionary, the proxy is notified of the change + lproxy[0] = d + +This approach is perhaps less convenient than employing nested +:ref:`multiprocessing-proxy_objects` for most use cases but also +demonstrates a level of control over the synchronization. + +.. note:: + + The proxy types in :mod:`multiprocessing` do nothing to support comparisons + by value. So, for instance, we have: + + .. doctest:: + + >>> manager.list([1,2,3]) == [1,2,3] + False + + One should just use a copy of the referent instead when making comparisons. + +.. class:: BaseProxy + + Proxy objects are instances of subclasses of :class:`BaseProxy`. + + .. method:: _callmethod(methodname[, args[, kwds]]) + + Call and return the result of a method of the proxy's referent. + + If ``proxy`` is a proxy whose referent is ``obj`` then the expression :: + + proxy._callmethod(methodname, args, kwds) + + will evaluate the expression :: + + getattr(obj, methodname)(*args, **kwds) + + in the manager's process. + + The returned value will be a copy of the result of the call or a proxy to + a new shared object -- see documentation for the *method_to_typeid* + argument of :meth:`BaseManager.register`. + + If an exception is raised by the call, then is re-raised by + :meth:`_callmethod`. If some other exception is raised in the manager's + process then this is converted into a :exc:`RemoteError` exception and is + raised by :meth:`_callmethod`. + + Note in particular that an exception will be raised if *methodname* has + not been *exposed*. + + An example of the usage of :meth:`_callmethod`: + + .. doctest:: + + >>> l = manager.list(range(10)) + >>> l._callmethod('__len__') + 10 + >>> l._callmethod('__getitem__', (slice(2, 7),)) # equivalent to l[2:7] + [2, 3, 4, 5, 6] + >>> l._callmethod('__getitem__', (20,)) # equivalent to l[20] + Traceback (most recent call last): + ... + IndexError: list index out of range + + .. method:: _getvalue() + + Return a copy of the referent. + + If the referent is unpicklable then this will raise an exception. + + .. method:: __repr__ + + Return a representation of the proxy object. + + .. method:: __str__ + + Return the representation of the referent. + + +Cleanup +>>>>>>> + +A proxy object uses a weakref callback so that when it gets garbage collected it +deregisters itself from the manager which owns its referent. + +A shared object gets deleted from the manager process when there are no longer +any proxies referring to it. + + +Process Pools +~~~~~~~~~~~~~ + +.. module:: multiprocessing.pool + :synopsis: Create pools of processes. + +One can create a pool of processes which will carry out tasks submitted to it +with the :class:`Pool` class. + +.. class:: Pool([processes[, initializer[, initargs[, maxtasksperchild [, context]]]]]) + + A process pool object which controls a pool of worker processes to which jobs + can be submitted. It supports asynchronous results with timeouts and + callbacks and has a parallel map implementation. + + *processes* is the number of worker processes to use. If *processes* is + ``None`` then the number returned by :func:`os.cpu_count` is used. + + If *initializer* is not ``None`` then each worker process will call + ``initializer(*initargs)`` when it starts. + + *maxtasksperchild* is the number of tasks a worker process can complete + before it will exit and be replaced with a fresh worker process, to enable + unused resources to be freed. The default *maxtasksperchild* is ``None``, which + means worker processes will live as long as the pool. + + *context* can be used to specify the context used for starting + the worker processes. Usually a pool is created using the + function :func:`multiprocessing.Pool` or the :meth:`Pool` method + of a context object. In both cases *context* is set + appropriately. + + Note that the methods of the pool object should only be called by + the process which created the pool. + + .. versionadded:: 3.2 + *maxtasksperchild* + + .. versionadded:: 3.4 + *context* + + .. note:: + + Worker processes within a :class:`Pool` typically live for the complete + duration of the Pool's work queue. A frequent pattern found in other + systems (such as Apache, mod_wsgi, etc) to free resources held by + workers is to allow a worker within a pool to complete only a set + amount of work before being exiting, being cleaned up and a new + process spawned to replace the old one. The *maxtasksperchild* + argument to the :class:`Pool` exposes this ability to the end user. + + .. method:: apply(func[, args[, kwds]]) + + Call *func* with arguments *args* and keyword arguments *kwds*. It blocks + until the result is ready. Given this blocks, :meth:`apply_async` is + better suited for performing work in parallel. Additionally, *func* + is only executed in one of the workers of the pool. + + .. method:: apply_async(func[, args[, kwds[, callback[, error_callback]]]]) + + A variant of the :meth:`apply` method which returns a result object. + + If *callback* is specified then it should be a callable which accepts a + single argument. When the result becomes ready *callback* is applied to + it, that is unless the call failed, in which case the *error_callback* + is applied instead. + + If *error_callback* is specified then it should be a callable which + accepts a single argument. If the target function fails, then + the *error_callback* is called with the exception instance. + + Callbacks should complete immediately since otherwise the thread which + handles the results will get blocked. + + .. method:: map(func, iterable[, chunksize]) + + A parallel equivalent of the :func:`map` built-in function (it supports only + one *iterable* argument though). It blocks until the result is ready. + + This method chops the iterable into a number of chunks which it submits to + the process pool as separate tasks. The (approximate) size of these + chunks can be specified by setting *chunksize* to a positive integer. + + Note that it may cause high memory usage for very long iterables. Consider + using :meth:`imap` or :meth:`imap_unordered` with explicit *chunksize* + option for better efficiency. + + .. method:: map_async(func, iterable[, chunksize[, callback[, error_callback]]]) + + A variant of the :meth:`.map` method which returns a result object. + + If *callback* is specified then it should be a callable which accepts a + single argument. When the result becomes ready *callback* is applied to + it, that is unless the call failed, in which case the *error_callback* + is applied instead. + + If *error_callback* is specified then it should be a callable which + accepts a single argument. If the target function fails, then + the *error_callback* is called with the exception instance. + + Callbacks should complete immediately since otherwise the thread which + handles the results will get blocked. + + .. method:: imap(func, iterable[, chunksize]) + + A lazier version of :meth:`.map`. + + The *chunksize* argument is the same as the one used by the :meth:`.map` + method. For very long iterables using a large value for *chunksize* can + make the job complete **much** faster than using the default value of + ``1``. + + Also if *chunksize* is ``1`` then the :meth:`!next` method of the iterator + returned by the :meth:`imap` method has an optional *timeout* parameter: + ``next(timeout)`` will raise :exc:`multiprocessing.TimeoutError` if the + result cannot be returned within *timeout* seconds. + + .. method:: imap_unordered(func, iterable[, chunksize]) + + The same as :meth:`imap` except that the ordering of the results from the + returned iterator should be considered arbitrary. (Only when there is + only one worker process is the order guaranteed to be "correct".) + + .. method:: starmap(func, iterable[, chunksize]) + + Like :meth:`map` except that the elements of the *iterable* are expected + to be iterables that are unpacked as arguments. + + Hence an *iterable* of ``[(1,2), (3, 4)]`` results in ``[func(1,2), + func(3,4)]``. + + .. versionadded:: 3.3 + + .. method:: starmap_async(func, iterable[, chunksize[, callback[, error_callback]]]) + + A combination of :meth:`starmap` and :meth:`map_async` that iterates over + *iterable* of iterables and calls *func* with the iterables unpacked. + Returns a result object. + + .. versionadded:: 3.3 + + .. method:: close() + + Prevents any more tasks from being submitted to the pool. Once all the + tasks have been completed the worker processes will exit. + + .. method:: terminate() + + Stops the worker processes immediately without completing outstanding + work. When the pool object is garbage collected :meth:`terminate` will be + called immediately. + + .. method:: join() + + Wait for the worker processes to exit. One must call :meth:`close` or + :meth:`terminate` before using :meth:`join`. + + .. versionadded:: 3.3 + Pool objects now support the context management protocol -- see + :ref:`typecontextmanager`. :meth:`~contextmanager.__enter__` returns the + pool object, and :meth:`~contextmanager.__exit__` calls :meth:`terminate`. + + +.. class:: AsyncResult + + The class of the result returned by :meth:`Pool.apply_async` and + :meth:`Pool.map_async`. + + .. method:: get([timeout]) + + Return the result when it arrives. If *timeout* is not ``None`` and the + result does not arrive within *timeout* seconds then + :exc:`multiprocessing.TimeoutError` is raised. If the remote call raised + an exception then that exception will be reraised by :meth:`get`. + + .. method:: wait([timeout]) + + Wait until the result is available or until *timeout* seconds pass. + + .. method:: ready() + + Return whether the call has completed. + + .. method:: successful() + + Return whether the call completed without raising an exception. Will + raise :exc:`AssertionError` if the result is not ready. + +The following example demonstrates the use of a pool:: + + from multiprocessing import Pool + import time + + def f(x): + return x*x + + if __name__ == '__main__': + with Pool(processes=4) as pool: # start 4 worker processes + result = pool.apply_async(f, (10,)) # evaluate "f(10)" asynchronously in a single process + print(result.get(timeout=1)) # prints "100" unless your computer is *very* slow + + print(pool.map(f, range(10))) # prints "[0, 1, 4,..., 81]" + + it = pool.imap(f, range(10)) + print(next(it)) # prints "0" + print(next(it)) # prints "1" + print(it.next(timeout=1)) # prints "4" unless your computer is *very* slow + + result = pool.apply_async(time.sleep, (10,)) + print(result.get(timeout=1)) # raises multiprocessing.TimeoutError + + +.. _multiprocessing-listeners-clients: + +Listeners and Clients +~~~~~~~~~~~~~~~~~~~~~ + +.. module:: multiprocessing.connection + :synopsis: API for dealing with sockets. + +Usually message passing between processes is done using queues or by using +:class:`~Connection` objects returned by +:func:`~multiprocessing.Pipe`. + +However, the :mod:`multiprocessing.connection` module allows some extra +flexibility. It basically gives a high level message oriented API for dealing +with sockets or Windows named pipes. It also has support for *digest +authentication* using the :mod:`hmac` module, and for polling +multiple connections at the same time. + + +.. function:: deliver_challenge(connection, authkey) + + Send a randomly generated message to the other end of the connection and wait + for a reply. + + If the reply matches the digest of the message using *authkey* as the key + then a welcome message is sent to the other end of the connection. Otherwise + :exc:`~multiprocessing.AuthenticationError` is raised. + +.. function:: answer_challenge(connection, authkey) + + Receive a message, calculate the digest of the message using *authkey* as the + key, and then send the digest back. + + If a welcome message is not received, then + :exc:`~multiprocessing.AuthenticationError` is raised. + +.. function:: Client(address[, family[, authkey]]) + + Attempt to set up a connection to the listener which is using address + *address*, returning a :class:`~Connection`. + + The type of the connection is determined by *family* argument, but this can + generally be omitted since it can usually be inferred from the format of + *address*. (See :ref:`multiprocessing-address-formats`) + + If *authkey* is given and not None, it should be a byte string and will be + used as the secret key for an HMAC-based authentication challenge. No + authentication is done if *authkey* is None. + :exc:`~multiprocessing.AuthenticationError` is raised if authentication fails. + See :ref:`multiprocessing-auth-keys`. + +.. class:: Listener([address[, family[, backlog[, authkey]]]]) + + A wrapper for a bound socket or Windows named pipe which is 'listening' for + connections. + + *address* is the address to be used by the bound socket or named pipe of the + listener object. + + .. note:: + + If an address of '0.0.0.0' is used, the address will not be a connectable + end point on Windows. If you require a connectable end-point, + you should use '127.0.0.1'. + + *family* is the type of socket (or named pipe) to use. This can be one of + the strings ``'AF_INET'`` (for a TCP socket), ``'AF_UNIX'`` (for a Unix + domain socket) or ``'AF_PIPE'`` (for a Windows named pipe). Of these only + the first is guaranteed to be available. If *family* is ``None`` then the + family is inferred from the format of *address*. If *address* is also + ``None`` then a default is chosen. This default is the family which is + assumed to be the fastest available. See + :ref:`multiprocessing-address-formats`. Note that if *family* is + ``'AF_UNIX'`` and address is ``None`` then the socket will be created in a + private temporary directory created using :func:`tempfile.mkstemp`. + + If the listener object uses a socket then *backlog* (1 by default) is passed + to the :meth:`~socket.socket.listen` method of the socket once it has been + bound. + + If *authkey* is given and not None, it should be a byte string and will be + used as the secret key for an HMAC-based authentication challenge. No + authentication is done if *authkey* is None. + :exc:`~multiprocessing.AuthenticationError` is raised if authentication fails. + See :ref:`multiprocessing-auth-keys`. + + .. method:: accept() + + Accept a connection on the bound socket or named pipe of the listener + object and return a :class:`~Connection` object. + If authentication is attempted and fails, then + :exc:`~multiprocessing.AuthenticationError` is raised. + + .. method:: close() + + Close the bound socket or named pipe of the listener object. This is + called automatically when the listener is garbage collected. However it + is advisable to call it explicitly. + + Listener objects have the following read-only properties: + + .. attribute:: address + + The address which is being used by the Listener object. + + .. attribute:: last_accepted + + The address from which the last accepted connection came. If this is + unavailable then it is ``None``. + + .. versionadded:: 3.3 + Listener objects now support the context management protocol -- see + :ref:`typecontextmanager`. :meth:`~contextmanager.__enter__` returns the + listener object, and :meth:`~contextmanager.__exit__` calls :meth:`close`. + +.. function:: wait(object_list, timeout=None) + + Wait till an object in *object_list* is ready. Returns the list of + those objects in *object_list* which are ready. If *timeout* is a + float then the call blocks for at most that many seconds. If + *timeout* is ``None`` then it will block for an unlimited period. + A negative timeout is equivalent to a zero timeout. + + For both Unix and Windows, an object can appear in *object_list* if + it is + + * a readable :class:`~multiprocessing.connection.Connection` object; + * a connected and readable :class:`socket.socket` object; or + * the :attr:`~multiprocessing.Process.sentinel` attribute of a + :class:`~multiprocessing.Process` object. + + A connection or socket object is ready when there is data available + to be read from it, or the other end has been closed. + + **Unix**: ``wait(object_list, timeout)`` almost equivalent + ``select.select(object_list, [], [], timeout)``. The difference is + that, if :func:`select.select` is interrupted by a signal, it can + raise :exc:`OSError` with an error number of ``EINTR``, whereas + :func:`wait` will not. + + **Windows**: An item in *object_list* must either be an integer + handle which is waitable (according to the definition used by the + documentation of the Win32 function ``WaitForMultipleObjects()``) + or it can be an object with a :meth:`fileno` method which returns a + socket handle or pipe handle. (Note that pipe handles and socket + handles are **not** waitable handles.) + + .. versionadded:: 3.3 + + +**Examples** + +The following server code creates a listener which uses ``'secret password'`` as +an authentication key. It then waits for a connection and sends some data to +the client:: + + from multiprocessing.connection import Listener + from array import array + + address = ('localhost', 6000) # family is deduced to be 'AF_INET' + + with Listener(address, authkey=b'secret password') as listener: + with listener.accept() as conn: + print('connection accepted from', listener.last_accepted) + + conn.send([2.25, None, 'junk', float]) + + conn.send_bytes(b'hello') + + conn.send_bytes(array('i', [42, 1729])) + +The following code connects to the server and receives some data from the +server:: + + from multiprocessing.connection import Client + from array import array + + address = ('localhost', 6000) + + with Client(address, authkey=b'secret password') as conn: + print(conn.recv()) # => [2.25, None, 'junk', float] + + print(conn.recv_bytes()) # => 'hello' + + arr = array('i', [0, 0, 0, 0, 0]) + print(conn.recv_bytes_into(arr)) # => 8 + print(arr) # => array('i', [42, 1729, 0, 0, 0]) + +The following code uses :func:`~multiprocessing.connection.wait` to +wait for messages from multiple processes at once:: + + import time, random + from multiprocessing import Process, Pipe, current_process + from multiprocessing.connection import wait + + def foo(w): + for i in range(10): + w.send((i, current_process().name)) + w.close() + + if __name__ == '__main__': + readers = [] + + for i in range(4): + r, w = Pipe(duplex=False) + readers.append(r) + p = Process(target=foo, args=(w,)) + p.start() + # We close the writable end of the pipe now to be sure that + # p is the only process which owns a handle for it. This + # ensures that when p closes its handle for the writable end, + # wait() will promptly report the readable end as being ready. + w.close() + + while readers: + for r in wait(readers): + try: + msg = r.recv() + except EOFError: + readers.remove(r) + else: + print(msg) + + +.. _multiprocessing-address-formats: + +Address Formats +>>>>>>>>>>>>>>> + +* An ``'AF_INET'`` address is a tuple of the form ``(hostname, port)`` where + *hostname* is a string and *port* is an integer. + +* An ``'AF_UNIX'`` address is a string representing a filename on the + filesystem. + +* An ``'AF_PIPE'`` address is a string of the form + :samp:`r'\\\\.\\pipe\\{PipeName}'`. To use :func:`Client` to connect to a named + pipe on a remote computer called *ServerName* one should use an address of the + form :samp:`r'\\\\{ServerName}\\pipe\\{PipeName}'` instead. + +Note that any string beginning with two backslashes is assumed by default to be +an ``'AF_PIPE'`` address rather than an ``'AF_UNIX'`` address. + + +.. _multiprocessing-auth-keys: + +Authentication keys +~~~~~~~~~~~~~~~~~~~ + +When one uses :meth:`Connection.recv `, the +data received is automatically +unpickled. Unfortunately unpickling data from an untrusted source is a security +risk. Therefore :class:`Listener` and :func:`Client` use the :mod:`hmac` module +to provide digest authentication. + +An authentication key is a byte string which can be thought of as a +password: once a connection is established both ends will demand proof +that the other knows the authentication key. (Demonstrating that both +ends are using the same key does **not** involve sending the key over +the connection.) + +If authentication is requested but no authentication key is specified then the +return value of ``current_process().authkey`` is used (see +:class:`~multiprocessing.Process`). This value will be automatically inherited by +any :class:`~multiprocessing.Process` object that the current process creates. +This means that (by default) all processes of a multi-process program will share +a single authentication key which can be used when setting up connections +between themselves. + +Suitable authentication keys can also be generated by using :func:`os.urandom`. + + +Logging +~~~~~~~ + +Some support for logging is available. Note, however, that the :mod:`logging` +package does not use process shared locks so it is possible (depending on the +handler type) for messages from different processes to get mixed up. + +.. currentmodule:: multiprocessing +.. function:: get_logger() + + Returns the logger used by :mod:`multiprocessing`. If necessary, a new one + will be created. + + When first created the logger has level :data:`logging.NOTSET` and no + default handler. Messages sent to this logger will not by default propagate + to the root logger. + + Note that on Windows child processes will only inherit the level of the + parent process's logger -- any other customization of the logger will not be + inherited. + +.. currentmodule:: multiprocessing +.. function:: log_to_stderr() + + This function performs a call to :func:`get_logger` but in addition to + returning the logger created by get_logger, it adds a handler which sends + output to :data:`sys.stderr` using format + ``'[%(levelname)s/%(processName)s] %(message)s'``. + +Below is an example session with logging turned on:: + + >>> import multiprocessing, logging + >>> logger = multiprocessing.log_to_stderr() + >>> logger.setLevel(logging.INFO) + >>> logger.warning('doomed') + [WARNING/MainProcess] doomed + >>> m = multiprocessing.Manager() + [INFO/SyncManager-...] child process calling self.run() + [INFO/SyncManager-...] created temp directory /.../pymp-... + [INFO/SyncManager-...] manager serving at '/.../listener-...' + >>> del m + [INFO/MainProcess] sending shutdown message to manager + [INFO/SyncManager-...] manager exiting with exitcode 0 + +For a full table of logging levels, see the :mod:`logging` module. + + +The :mod:`multiprocessing.dummy` module +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. module:: multiprocessing.dummy + :synopsis: Dumb wrapper around threading. + +:mod:`multiprocessing.dummy` replicates the API of :mod:`multiprocessing` but is +no more than a wrapper around the :mod:`threading` module. + + +.. _multiprocessing-programming: + +Programming guidelines +---------------------- + +There are certain guidelines and idioms which should be adhered to when using +:mod:`multiprocessing`. + + +All start methods +~~~~~~~~~~~~~~~~~ + +The following applies to all start methods. + +Avoid shared state + + As far as possible one should try to avoid shifting large amounts of data + between processes. + + It is probably best to stick to using queues or pipes for communication + between processes rather than using the lower level synchronization + primitives. + +Picklability + + Ensure that the arguments to the methods of proxies are picklable. + +Thread safety of proxies + + Do not use a proxy object from more than one thread unless you protect it + with a lock. + + (There is never a problem with different processes using the *same* proxy.) + +Joining zombie processes + + On Unix when a process finishes but has not been joined it becomes a zombie. + There should never be very many because each time a new process starts (or + :func:`~multiprocessing.active_children` is called) all completed processes + which have not yet been joined will be joined. Also calling a finished + process's :meth:`Process.is_alive ` will + join the process. Even so it is probably good + practice to explicitly join all the processes that you start. + +Better to inherit than pickle/unpickle + + When using the *spawn* or *forkserver* start methods many types + from :mod:`multiprocessing` need to be picklable so that child + processes can use them. However, one should generally avoid + sending shared objects to other processes using pipes or queues. + Instead you should arrange the program so that a process which + needs access to a shared resource created elsewhere can inherit it + from an ancestor process. + +Avoid terminating processes + + Using the :meth:`Process.terminate ` + method to stop a process is liable to + cause any shared resources (such as locks, semaphores, pipes and queues) + currently being used by the process to become broken or unavailable to other + processes. + + Therefore it is probably best to only consider using + :meth:`Process.terminate ` on processes + which never use any shared resources. + +Joining processes that use queues + + Bear in mind that a process that has put items in a queue will wait before + terminating until all the buffered items are fed by the "feeder" thread to + the underlying pipe. (The child process can call the + :meth:`Queue.cancel_join_thread ` + method of the queue to avoid this behaviour.) + + This means that whenever you use a queue you need to make sure that all + items which have been put on the queue will eventually be removed before the + process is joined. Otherwise you cannot be sure that processes which have + put items on the queue will terminate. Remember also that non-daemonic + processes will be joined automatically. + + An example which will deadlock is the following:: + + from multiprocessing import Process, Queue + + def f(q): + q.put('X' * 1000000) + + if __name__ == '__main__': + queue = Queue() + p = Process(target=f, args=(queue,)) + p.start() + p.join() # this deadlocks + obj = queue.get() + + A fix here would be to swap the last two lines (or simply remove the + ``p.join()`` line). + +Explicitly pass resources to child processes + + On Unix using the *fork* start method, a child process can make + use of a shared resource created in a parent process using a + global resource. However, it is better to pass the object as an + argument to the constructor for the child process. + + Apart from making the code (potentially) compatible with Windows + and the other start methods this also ensures that as long as the + child process is still alive the object will not be garbage + collected in the parent process. This might be important if some + resource is freed when the object is garbage collected in the + parent process. + + So for instance :: + + from multiprocessing import Process, Lock + + def f(): + ... do something using "lock" ... + + if __name__ == '__main__': + lock = Lock() + for i in range(10): + Process(target=f).start() + + should be rewritten as :: + + from multiprocessing import Process, Lock + + def f(l): + ... do something using "l" ... + + if __name__ == '__main__': + lock = Lock() + for i in range(10): + Process(target=f, args=(lock,)).start() + +Beware of replacing :data:`sys.stdin` with a "file like object" + + :mod:`multiprocessing` originally unconditionally called:: + + os.close(sys.stdin.fileno()) + + in the :meth:`multiprocessing.Process._bootstrap` method --- this resulted + in issues with processes-in-processes. This has been changed to:: + + sys.stdin.close() + sys.stdin = open(os.open(os.devnull, os.O_RDONLY), closefd=False) + + Which solves the fundamental issue of processes colliding with each other + resulting in a bad file descriptor error, but introduces a potential danger + to applications which replace :func:`sys.stdin` with a "file-like object" + with output buffering. This danger is that if multiple processes call + :meth:`~io.IOBase.close()` on this file-like object, it could result in the same + data being flushed to the object multiple times, resulting in corruption. + + If you write a file-like object and implement your own caching, you can + make it fork-safe by storing the pid whenever you append to the cache, + and discarding the cache when the pid changes. For example:: + + @property + def cache(self): + pid = os.getpid() + if pid != self._pid: + self._pid = pid + self._cache = [] + return self._cache + + For more information, see :issue:`5155`, :issue:`5313` and :issue:`5331` + +The *spawn* and *forkserver* start methods +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +There are a few extra restriction which don't apply to the *fork* +start method. + +More picklability + + Ensure that all arguments to :meth:`Process.__init__` are picklable. + Also, if you subclass :class:`~multiprocessing.Process` then make sure that + instances will be picklable when the :meth:`Process.start + ` method is called. + +Global variables + + Bear in mind that if code run in a child process tries to access a global + variable, then the value it sees (if any) may not be the same as the value + in the parent process at the time that :meth:`Process.start + ` was called. + + However, global variables which are just module level constants cause no + problems. + +Safe importing of main module + + Make sure that the main module can be safely imported by a new Python + interpreter without causing unintended side effects (such a starting a new + process). + + For example, using the *spawn* or *forkserver* start method + running the following module would fail with a + :exc:`RuntimeError`:: + + from multiprocessing import Process + + def foo(): + print('hello') + + p = Process(target=foo) + p.start() + + Instead one should protect the "entry point" of the program by using ``if + __name__ == '__main__':`` as follows:: + + from multiprocessing import Process, freeze_support, set_start_method + + def foo(): + print('hello') + + if __name__ == '__main__': + freeze_support() + set_start_method('spawn') + p = Process(target=foo) + p.start() + + (The ``freeze_support()`` line can be omitted if the program will be run + normally instead of frozen.) + + This allows the newly spawned Python interpreter to safely import the module + and then run the module's ``foo()`` function. + + Similar restrictions apply if a pool or manager is created in the main + module. + + +.. _multiprocessing-examples: + +Examples +-------- + +Demonstration of how to create and use customized managers and proxies: + +.. literalinclude:: ../includes/mp_newtype.py + :language: python3 + + +Using :class:`~multiprocessing.pool.Pool`: + +.. literalinclude:: ../includes/mp_pool.py + :language: python3 + + +An example showing how to use queues to feed tasks to a collection of worker +processes and collect the results: + +.. literalinclude:: ../includes/mp_workers.py diff --git a/python-3.7.4-docs-html/_sources/library/netdata.rst.txt b/python-3.7.4-docs-html/_sources/library/netdata.rst.txt new file mode 100644 index 0000000..4915016 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/netdata.rst.txt @@ -0,0 +1,23 @@ + +.. _netdata: + +********************** +Internet Data Handling +********************** + +This chapter describes modules which support handling data formats commonly used +on the Internet. + + +.. toctree:: + + email.rst + json.rst + mailcap.rst + mailbox.rst + mimetypes.rst + base64.rst + binhex.rst + binascii.rst + quopri.rst + uu.rst diff --git a/python-3.7.4-docs-html/_sources/library/netrc.rst.txt b/python-3.7.4-docs-html/_sources/library/netrc.rst.txt new file mode 100644 index 0000000..3d29ac4 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/netrc.rst.txt @@ -0,0 +1,90 @@ + +:mod:`netrc` --- netrc file processing +====================================== + +.. module:: netrc + :synopsis: Loading of .netrc files. + +.. moduleauthor:: Eric S. Raymond +.. sectionauthor:: Eric S. Raymond + +**Source code:** :source:`Lib/netrc.py` + +-------------- + +The :class:`~netrc.netrc` class parses and encapsulates the netrc file format used by +the Unix :program:`ftp` program and other FTP clients. + + +.. class:: netrc([file]) + + A :class:`~netrc.netrc` instance or subclass instance encapsulates data from a netrc + file. The initialization argument, if present, specifies the file to parse. If + no argument is given, the file :file:`.netrc` in the user's home directory -- + as determined by :func:`os.path.expanduser` -- will be read. Otherwise, + a :exc:`FileNotFoundError` exception will be raised. + Parse errors will raise :exc:`NetrcParseError` with diagnostic + information including the file name, line number, and terminating token. + If no argument is specified on a POSIX system, the presence of passwords in + the :file:`.netrc` file will raise a :exc:`NetrcParseError` if the file + ownership or permissions are insecure (owned by a user other than the user + running the process, or accessible for read or write by any other user). + This implements security behavior equivalent to that of ftp and other + programs that use :file:`.netrc`. + + .. versionchanged:: 3.4 Added the POSIX permission check. + + .. versionchanged:: 3.7 + :func:`os.path.expanduser` is used to find the location of the + :file:`.netrc` file when *file* is not passed as argument. + + +.. exception:: NetrcParseError + + Exception raised by the :class:`~netrc.netrc` class when syntactical errors are + encountered in source text. Instances of this exception provide three + interesting attributes: :attr:`msg` is a textual explanation of the error, + :attr:`filename` is the name of the source file, and :attr:`lineno` gives the + line number on which the error was found. + + +.. _netrc-objects: + +netrc Objects +------------- + +A :class:`~netrc.netrc` instance has the following methods: + + +.. method:: netrc.authenticators(host) + + Return a 3-tuple ``(login, account, password)`` of authenticators for *host*. + If the netrc file did not contain an entry for the given host, return the tuple + associated with the 'default' entry. If neither matching host nor default entry + is available, return ``None``. + + +.. method:: netrc.__repr__() + + Dump the class data as a string in the format of a netrc file. (This discards + comments and may reorder the entries.) + +Instances of :class:`~netrc.netrc` have public instance variables: + + +.. attribute:: netrc.hosts + + Dictionary mapping host names to ``(login, account, password)`` tuples. The + 'default' entry, if any, is represented as a pseudo-host by that name. + + +.. attribute:: netrc.macros + + Dictionary mapping macro names to string lists. + +.. note:: + + Passwords are limited to a subset of the ASCII character set. All ASCII + punctuation is allowed in passwords, however, note that whitespace and + non-printable characters are not allowed in passwords. This is a limitation + of the way the .netrc file is parsed and may be removed in the future. diff --git a/python-3.7.4-docs-html/_sources/library/nis.rst.txt b/python-3.7.4-docs-html/_sources/library/nis.rst.txt new file mode 100644 index 0000000..10c67cb --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/nis.rst.txt @@ -0,0 +1,65 @@ + +:mod:`nis` --- Interface to Sun's NIS (Yellow Pages) +==================================================== + +.. module:: nis + :platform: Unix + :synopsis: Interface to Sun's NIS (Yellow Pages) library. + +.. moduleauthor:: Fred Gansevles +.. sectionauthor:: Moshe Zadka + +-------------- + +The :mod:`nis` module gives a thin wrapper around the NIS library, useful for +central administration of several hosts. + +Because NIS exists only on Unix systems, this module is only available for Unix. + +The :mod:`nis` module defines the following functions: + + +.. function:: match(key, mapname, domain=default_domain) + + Return the match for *key* in map *mapname*, or raise an error + (:exc:`nis.error`) if there is none. Both should be strings, *key* is 8-bit + clean. Return value is an arbitrary array of bytes (may contain ``NULL`` and + other joys). + + Note that *mapname* is first checked if it is an alias to another name. + + The *domain* argument allows overriding the NIS domain used for the lookup. If + unspecified, lookup is in the default NIS domain. + + +.. function:: cat(mapname, domain=default_domain) + + Return a dictionary mapping *key* to *value* such that ``match(key, + mapname)==value``. Note that both keys and values of the dictionary are + arbitrary arrays of bytes. + + Note that *mapname* is first checked if it is an alias to another name. + + The *domain* argument allows overriding the NIS domain used for the lookup. If + unspecified, lookup is in the default NIS domain. + + +.. function:: maps(domain=default_domain) + + Return a list of all valid maps. + + The *domain* argument allows overriding the NIS domain used for the lookup. If + unspecified, lookup is in the default NIS domain. + + +.. function:: get_default_domain() + + Return the system default NIS domain. + + +The :mod:`nis` module defines the following exception: + +.. exception:: error + + An error raised when a NIS function returns an error code. + diff --git a/python-3.7.4-docs-html/_sources/library/nntplib.rst.txt b/python-3.7.4-docs-html/_sources/library/nntplib.rst.txt new file mode 100644 index 0000000..56188c7 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/nntplib.rst.txt @@ -0,0 +1,567 @@ +:mod:`nntplib` --- NNTP protocol client +======================================= + +.. module:: nntplib + :synopsis: NNTP protocol client (requires sockets). + +**Source code:** :source:`Lib/nntplib.py` + +.. index:: + pair: NNTP; protocol + single: Network News Transfer Protocol + +-------------- + +This module defines the class :class:`NNTP` which implements the client side of +the Network News Transfer Protocol. It can be used to implement a news reader +or poster, or automated news processors. It is compatible with :rfc:`3977` +as well as the older :rfc:`977` and :rfc:`2980`. + +Here are two small examples of how it can be used. To list some statistics +about a newsgroup and print the subjects of the last 10 articles:: + + >>> s = nntplib.NNTP('news.gmane.org') + >>> resp, count, first, last, name = s.group('gmane.comp.python.committers') + >>> print('Group', name, 'has', count, 'articles, range', first, 'to', last) + Group gmane.comp.python.committers has 1096 articles, range 1 to 1096 + >>> resp, overviews = s.over((last - 9, last)) + >>> for id, over in overviews: + ... print(id, nntplib.decode_header(over['subject'])) + ... + 1087 Re: Commit privileges for Łukasz Langa + 1088 Re: 3.2 alpha 2 freeze + 1089 Re: 3.2 alpha 2 freeze + 1090 Re: Commit privileges for Łukasz Langa + 1091 Re: Commit privileges for Łukasz Langa + 1092 Updated ssh key + 1093 Re: Updated ssh key + 1094 Re: Updated ssh key + 1095 Hello fellow committers! + 1096 Re: Hello fellow committers! + >>> s.quit() + '205 Bye!' + +To post an article from a binary file (this assumes that the article has valid +headers, and that you have right to post on the particular newsgroup):: + + >>> s = nntplib.NNTP('news.gmane.org') + >>> f = open('article.txt', 'rb') + >>> s.post(f) + '240 Article posted successfully.' + >>> s.quit() + '205 Bye!' + +The module itself defines the following classes: + + +.. class:: NNTP(host, port=119, user=None, password=None, readermode=None, usenetrc=False, [timeout]) + + Return a new :class:`NNTP` object, representing a connection + to the NNTP server running on host *host*, listening at port *port*. + An optional *timeout* can be specified for the socket connection. + If the optional *user* and *password* are provided, or if suitable + credentials are present in :file:`/.netrc` and the optional flag *usenetrc* + is true, the ``AUTHINFO USER`` and ``AUTHINFO PASS`` commands are used + to identify and authenticate the user to the server. If the optional + flag *readermode* is true, then a ``mode reader`` command is sent before + authentication is performed. Reader mode is sometimes necessary if you are + connecting to an NNTP server on the local machine and intend to call + reader-specific commands, such as ``group``. If you get unexpected + :exc:`NNTPPermanentError`\ s, you might need to set *readermode*. + The :class:`NNTP` class supports the :keyword:`with` statement to + unconditionally consume :exc:`OSError` exceptions and to close the NNTP + connection when done, e.g.: + + >>> from nntplib import NNTP + >>> with NNTP('news.gmane.org') as n: + ... n.group('gmane.comp.python.committers') + ... # doctest: +SKIP + ('211 1755 1 1755 gmane.comp.python.committers', 1755, 1, 1755, 'gmane.comp.python.committers') + >>> + + + .. versionchanged:: 3.2 + *usenetrc* is now ``False`` by default. + + .. versionchanged:: 3.3 + Support for the :keyword:`with` statement was added. + +.. class:: NNTP_SSL(host, port=563, user=None, password=None, ssl_context=None, readermode=None, usenetrc=False, [timeout]) + + Return a new :class:`NNTP_SSL` object, representing an encrypted + connection to the NNTP server running on host *host*, listening at + port *port*. :class:`NNTP_SSL` objects have the same methods as + :class:`NNTP` objects. If *port* is omitted, port 563 (NNTPS) is used. + *ssl_context* is also optional, and is a :class:`~ssl.SSLContext` object. + Please read :ref:`ssl-security` for best practices. + All other parameters behave the same as for :class:`NNTP`. + + Note that SSL-on-563 is discouraged per :rfc:`4642`, in favor of + STARTTLS as described below. However, some servers only support the + former. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.4 + The class now supports hostname check with + :attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see + :data:`ssl.HAS_SNI`). + +.. exception:: NNTPError + + Derived from the standard exception :exc:`Exception`, this is the base + class for all exceptions raised by the :mod:`nntplib` module. Instances + of this class have the following attribute: + + .. attribute:: response + + The response of the server if available, as a :class:`str` object. + + +.. exception:: NNTPReplyError + + Exception raised when an unexpected reply is received from the server. + + +.. exception:: NNTPTemporaryError + + Exception raised when a response code in the range 400--499 is received. + + +.. exception:: NNTPPermanentError + + Exception raised when a response code in the range 500--599 is received. + + +.. exception:: NNTPProtocolError + + Exception raised when a reply is received from the server that does not begin + with a digit in the range 1--5. + + +.. exception:: NNTPDataError + + Exception raised when there is some error in the response data. + + +.. _nntp-objects: + +NNTP Objects +------------ + +When connected, :class:`NNTP` and :class:`NNTP_SSL` objects support the +following methods and attributes. + +Attributes +^^^^^^^^^^ + +.. attribute:: NNTP.nntp_version + + An integer representing the version of the NNTP protocol supported by the + server. In practice, this should be ``2`` for servers advertising + :rfc:`3977` compliance and ``1`` for others. + + .. versionadded:: 3.2 + +.. attribute:: NNTP.nntp_implementation + + A string describing the software name and version of the NNTP server, + or :const:`None` if not advertised by the server. + + .. versionadded:: 3.2 + +Methods +^^^^^^^ + +The *response* that is returned as the first item in the return tuple of almost +all methods is the server's response: a string beginning with a three-digit +code. If the server's response indicates an error, the method raises one of +the above exceptions. + +Many of the following methods take an optional keyword-only argument *file*. +When the *file* argument is supplied, it must be either a :term:`file object` +opened for binary writing, or the name of an on-disk file to be written to. +The method will then write any data returned by the server (except for the +response line and the terminating dot) to the file; any list of lines, +tuples or objects that the method normally returns will be empty. + +.. versionchanged:: 3.2 + Many of the following methods have been reworked and fixed, which makes + them incompatible with their 3.1 counterparts. + + +.. method:: NNTP.quit() + + Send a ``QUIT`` command and close the connection. Once this method has been + called, no other methods of the NNTP object should be called. + + +.. method:: NNTP.getwelcome() + + Return the welcome message sent by the server in reply to the initial + connection. (This message sometimes contains disclaimers or help information + that may be relevant to the user.) + + +.. method:: NNTP.getcapabilities() + + Return the :rfc:`3977` capabilities advertised by the server, as a + :class:`dict` instance mapping capability names to (possibly empty) lists + of values. On legacy servers which don't understand the ``CAPABILITIES`` + command, an empty dictionary is returned instead. + + >>> s = NNTP('news.gmane.org') + >>> 'POST' in s.getcapabilities() + True + + .. versionadded:: 3.2 + + +.. method:: NNTP.login(user=None, password=None, usenetrc=True) + + Send ``AUTHINFO`` commands with the user name and password. If *user* + and *password* are ``None`` and *usenetrc* is true, credentials from + ``~/.netrc`` will be used if possible. + + Unless intentionally delayed, login is normally performed during the + :class:`NNTP` object initialization and separately calling this function + is unnecessary. To force authentication to be delayed, you must not set + *user* or *password* when creating the object, and must set *usenetrc* to + False. + + .. versionadded:: 3.2 + + +.. method:: NNTP.starttls(context=None) + + Send a ``STARTTLS`` command. This will enable encryption on the NNTP + connection. The *context* argument is optional and should be a + :class:`ssl.SSLContext` object. Please read :ref:`ssl-security` for best + practices. + + Note that this may not be done after authentication information has + been transmitted, and authentication occurs by default if possible during a + :class:`NNTP` object initialization. See :meth:`NNTP.login` for information + on suppressing this behavior. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.4 + The method now supports hostname check with + :attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see + :data:`ssl.HAS_SNI`). + +.. method:: NNTP.newgroups(date, *, file=None) + + Send a ``NEWGROUPS`` command. The *date* argument should be a + :class:`datetime.date` or :class:`datetime.datetime` object. + Return a pair ``(response, groups)`` where *groups* is a list representing + the groups that are new since the given *date*. If *file* is supplied, + though, then *groups* will be empty. + + >>> from datetime import date, timedelta + >>> resp, groups = s.newgroups(date.today() - timedelta(days=3)) + >>> len(groups) # doctest: +SKIP + 85 + >>> groups[0] # doctest: +SKIP + GroupInfo(group='gmane.network.tor.devel', last='4', first='1', flag='m') + + +.. method:: NNTP.newnews(group, date, *, file=None) + + Send a ``NEWNEWS`` command. Here, *group* is a group name or ``'*'``, and + *date* has the same meaning as for :meth:`newgroups`. Return a pair + ``(response, articles)`` where *articles* is a list of message ids. + + This command is frequently disabled by NNTP server administrators. + + +.. method:: NNTP.list(group_pattern=None, *, file=None) + + Send a ``LIST`` or ``LIST ACTIVE`` command. Return a pair + ``(response, list)`` where *list* is a list of tuples representing all + the groups available from this NNTP server, optionally matching the + pattern string *group_pattern*. Each tuple has the form + ``(group, last, first, flag)``, where *group* is a group name, *last* + and *first* are the last and first article numbers, and *flag* usually + takes one of these values: + + * ``y``: Local postings and articles from peers are allowed. + * ``m``: The group is moderated and all postings must be approved. + * ``n``: No local postings are allowed, only articles from peers. + * ``j``: Articles from peers are filed in the junk group instead. + * ``x``: No local postings, and articles from peers are ignored. + * ``=foo.bar``: Articles are filed in the ``foo.bar`` group instead. + + If *flag* has another value, then the status of the newsgroup should be + considered unknown. + + This command can return very large results, especially if *group_pattern* + is not specified. It is best to cache the results offline unless you + really need to refresh them. + + .. versionchanged:: 3.2 + *group_pattern* was added. + + +.. method:: NNTP.descriptions(grouppattern) + + Send a ``LIST NEWSGROUPS`` command, where *grouppattern* is a wildmat string as + specified in :rfc:`3977` (it's essentially the same as DOS or UNIX shell wildcard + strings). Return a pair ``(response, descriptions)``, where *descriptions* + is a dictionary mapping group names to textual descriptions. + + >>> resp, descs = s.descriptions('gmane.comp.python.*') + >>> len(descs) # doctest: +SKIP + 295 + >>> descs.popitem() # doctest: +SKIP + ('gmane.comp.python.bio.general', 'BioPython discussion list (Moderated)') + + +.. method:: NNTP.description(group) + + Get a description for a single group *group*. If more than one group matches + (if 'group' is a real wildmat string), return the first match. If no group + matches, return an empty string. + + This elides the response code from the server. If the response code is needed, + use :meth:`descriptions`. + + +.. method:: NNTP.group(name) + + Send a ``GROUP`` command, where *name* is the group name. The group is + selected as the current group, if it exists. Return a tuple + ``(response, count, first, last, name)`` where *count* is the (estimated) + number of articles in the group, *first* is the first article number in + the group, *last* is the last article number in the group, and *name* + is the group name. + + +.. method:: NNTP.over(message_spec, *, file=None) + + Send an ``OVER`` command, or an ``XOVER`` command on legacy servers. + *message_spec* can be either a string representing a message id, or + a ``(first, last)`` tuple of numbers indicating a range of articles in + the current group, or a ``(first, None)`` tuple indicating a range of + articles starting from *first* to the last article in the current group, + or :const:`None` to select the current article in the current group. + + Return a pair ``(response, overviews)``. *overviews* is a list of + ``(article_number, overview)`` tuples, one for each article selected + by *message_spec*. Each *overview* is a dictionary with the same number + of items, but this number depends on the server. These items are either + message headers (the key is then the lower-cased header name) or metadata + items (the key is then the metadata name prepended with ``":"``). The + following items are guaranteed to be present by the NNTP specification: + + * the ``subject``, ``from``, ``date``, ``message-id`` and ``references`` + headers + * the ``:bytes`` metadata: the number of bytes in the entire raw article + (including headers and body) + * the ``:lines`` metadata: the number of lines in the article body + + The value of each item is either a string, or :const:`None` if not present. + + It is advisable to use the :func:`decode_header` function on header + values when they may contain non-ASCII characters:: + + >>> _, _, first, last, _ = s.group('gmane.comp.python.devel') + >>> resp, overviews = s.over((last, last)) + >>> art_num, over = overviews[0] + >>> art_num + 117216 + >>> list(over.keys()) + ['xref', 'from', ':lines', ':bytes', 'references', 'date', 'message-id', 'subject'] + >>> over['from'] + '=?UTF-8?B?Ik1hcnRpbiB2LiBMw7Z3aXMi?= ' + >>> nntplib.decode_header(over['from']) + '"Martin v. Löwis" ' + + .. versionadded:: 3.2 + + +.. method:: NNTP.help(*, file=None) + + Send a ``HELP`` command. Return a pair ``(response, list)`` where *list* is a + list of help strings. + + +.. method:: NNTP.stat(message_spec=None) + + Send a ``STAT`` command, where *message_spec* is either a message id + (enclosed in ``'<'`` and ``'>'``) or an article number in the current group. + If *message_spec* is omitted or :const:`None`, the current article in the + current group is considered. Return a triple ``(response, number, id)`` + where *number* is the article number and *id* is the message id. + + >>> _, _, first, last, _ = s.group('gmane.comp.python.devel') + >>> resp, number, message_id = s.stat(first) + >>> number, message_id + (9099, '<20030112190404.GE29873@epoch.metaslash.com>') + + +.. method:: NNTP.next() + + Send a ``NEXT`` command. Return as for :meth:`.stat`. + + +.. method:: NNTP.last() + + Send a ``LAST`` command. Return as for :meth:`.stat`. + + +.. method:: NNTP.article(message_spec=None, *, file=None) + + Send an ``ARTICLE`` command, where *message_spec* has the same meaning as + for :meth:`.stat`. Return a tuple ``(response, info)`` where *info* + is a :class:`~collections.namedtuple` with three attributes *number*, + *message_id* and *lines* (in that order). *number* is the article number + in the group (or 0 if the information is not available), *message_id* the + message id as a string, and *lines* a list of lines (without terminating + newlines) comprising the raw message including headers and body. + + >>> resp, info = s.article('<20030112190404.GE29873@epoch.metaslash.com>') + >>> info.number + 0 + >>> info.message_id + '<20030112190404.GE29873@epoch.metaslash.com>' + >>> len(info.lines) + 65 + >>> info.lines[0] + b'Path: main.gmane.org!not-for-mail' + >>> info.lines[1] + b'From: Neal Norwitz ' + >>> info.lines[-3:] + [b'There is a patch for 2.3 as well as 2.2.', b'', b'Neal'] + + +.. method:: NNTP.head(message_spec=None, *, file=None) + + Same as :meth:`article()`, but sends a ``HEAD`` command. The *lines* + returned (or written to *file*) will only contain the message headers, not + the body. + + +.. method:: NNTP.body(message_spec=None, *, file=None) + + Same as :meth:`article()`, but sends a ``BODY`` command. The *lines* + returned (or written to *file*) will only contain the message body, not the + headers. + + +.. method:: NNTP.post(data) + + Post an article using the ``POST`` command. The *data* argument is either + a :term:`file object` opened for binary reading, or any iterable of bytes + objects (representing raw lines of the article to be posted). It should + represent a well-formed news article, including the required headers. The + :meth:`post` method automatically escapes lines beginning with ``.`` and + appends the termination line. + + If the method succeeds, the server's response is returned. If the server + refuses posting, a :class:`NNTPReplyError` is raised. + + +.. method:: NNTP.ihave(message_id, data) + + Send an ``IHAVE`` command. *message_id* is the id of the message to send + to the server (enclosed in ``'<'`` and ``'>'``). The *data* parameter + and the return value are the same as for :meth:`post()`. + + +.. method:: NNTP.date() + + Return a pair ``(response, date)``. *date* is a :class:`~datetime.datetime` + object containing the current date and time of the server. + + +.. method:: NNTP.slave() + + Send a ``SLAVE`` command. Return the server's *response*. + + +.. method:: NNTP.set_debuglevel(level) + + Set the instance's debugging level. This controls the amount of debugging + output printed. The default, ``0``, produces no debugging output. A value of + ``1`` produces a moderate amount of debugging output, generally a single line + per request or response. A value of ``2`` or higher produces the maximum amount + of debugging output, logging each line sent and received on the connection + (including message text). + + +The following are optional NNTP extensions defined in :rfc:`2980`. Some of +them have been superseded by newer commands in :rfc:`3977`. + + +.. method:: NNTP.xhdr(hdr, str, *, file=None) + + Send an ``XHDR`` command. The *hdr* argument is a header keyword, e.g. + ``'subject'``. The *str* argument should have the form ``'first-last'`` + where *first* and *last* are the first and last article numbers to search. + Return a pair ``(response, list)``, where *list* is a list of pairs ``(id, + text)``, where *id* is an article number (as a string) and *text* is the text of + the requested header for that article. If the *file* parameter is supplied, then + the output of the ``XHDR`` command is stored in a file. If *file* is a string, + then the method will open a file with that name, write to it then close it. + If *file* is a :term:`file object`, then it will start calling :meth:`write` on + it to store the lines of the command output. If *file* is supplied, then the + returned *list* is an empty list. + + +.. method:: NNTP.xover(start, end, *, file=None) + + Send an ``XOVER`` command. *start* and *end* are article numbers + delimiting the range of articles to select. The return value is the + same of for :meth:`over()`. It is recommended to use :meth:`over()` + instead, since it will automatically use the newer ``OVER`` command + if available. + + +.. method:: NNTP.xpath(id) + + Return a pair ``(resp, path)``, where *path* is the directory path to the + article with message ID *id*. Most of the time, this extension is not + enabled by NNTP server administrators. + + .. deprecated:: 3.3 + The XPATH extension is not actively used. + + +.. XXX deprecated: + + .. method:: NNTP.xgtitle(name, *, file=None) + + Process an ``XGTITLE`` command, returning a pair ``(response, list)``, where + *list* is a list of tuples containing ``(name, title)``. If the *file* parameter + is supplied, then the output of the ``XGTITLE`` command is stored in a file. + If *file* is a string, then the method will open a file with that name, write + to it then close it. If *file* is a :term:`file object`, then it will start + calling :meth:`write` on it to store the lines of the command output. If *file* + is supplied, then the returned *list* is an empty list. This is an optional NNTP + extension, and may not be supported by all servers. + + :rfc:`2980` says "It is suggested that this extension be deprecated". Use + :meth:`descriptions` or :meth:`description` instead. + + +Utility functions +----------------- + +The module also defines the following utility function: + + +.. function:: decode_header(header_str) + + Decode a header value, un-escaping any escaped non-ASCII characters. + *header_str* must be a :class:`str` object. The unescaped value is + returned. Using this function is recommended to display some headers + in a human readable form:: + + >>> decode_header("Some subject") + 'Some subject' + >>> decode_header("=?ISO-8859-15?Q?D=E9buter_en_Python?=") + 'Débuter en Python' + >>> decode_header("Re: =?UTF-8?B?cHJvYmzDqG1lIGRlIG1hdHJpY2U=?=") + 'Re: problème de matrice' diff --git a/python-3.7.4-docs-html/_sources/library/numbers.rst.txt b/python-3.7.4-docs-html/_sources/library/numbers.rst.txt new file mode 100644 index 0000000..1b59495 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/numbers.rst.txt @@ -0,0 +1,223 @@ +:mod:`numbers` --- Numeric abstract base classes +================================================ + +.. module:: numbers + :synopsis: Numeric abstract base classes (Complex, Real, Integral, etc.). + +**Source code:** :source:`Lib/numbers.py` + +-------------- + +The :mod:`numbers` module (:pep:`3141`) defines a hierarchy of numeric +:term:`abstract base classes ` which progressively define +more operations. None of the types defined in this module can be instantiated. + + +.. class:: Number + + The root of the numeric hierarchy. If you just want to check if an argument + *x* is a number, without caring what kind, use ``isinstance(x, Number)``. + + +The numeric tower +----------------- + +.. class:: Complex + + Subclasses of this type describe complex numbers and include the operations + that work on the built-in :class:`complex` type. These are: conversions to + :class:`complex` and :class:`bool`, :attr:`.real`, :attr:`.imag`, ``+``, + ``-``, ``*``, ``/``, :func:`abs`, :meth:`conjugate`, ``==``, and ``!=``. All + except ``-`` and ``!=`` are abstract. + + .. attribute:: real + + Abstract. Retrieves the real component of this number. + + .. attribute:: imag + + Abstract. Retrieves the imaginary component of this number. + + .. abstractmethod:: conjugate() + + Abstract. Returns the complex conjugate. For example, ``(1+3j).conjugate() + == (1-3j)``. + +.. class:: Real + + To :class:`Complex`, :class:`Real` adds the operations that work on real + numbers. + + In short, those are: a conversion to :class:`float`, :func:`math.trunc`, + :func:`round`, :func:`math.floor`, :func:`math.ceil`, :func:`divmod`, ``//``, + ``%``, ``<``, ``<=``, ``>``, and ``>=``. + + Real also provides defaults for :func:`complex`, :attr:`~Complex.real`, + :attr:`~Complex.imag`, and :meth:`~Complex.conjugate`. + + +.. class:: Rational + + Subtypes :class:`Real` and adds + :attr:`~Rational.numerator` and :attr:`~Rational.denominator` properties, which + should be in lowest terms. With these, it provides a default for + :func:`float`. + + .. attribute:: numerator + + Abstract. + + .. attribute:: denominator + + Abstract. + + +.. class:: Integral + + Subtypes :class:`Rational` and adds a conversion to :class:`int`. Provides + defaults for :func:`float`, :attr:`~Rational.numerator`, and + :attr:`~Rational.denominator`. Adds abstract methods for ``**`` and + bit-string operations: ``<<``, ``>>``, ``&``, ``^``, ``|``, ``~``. + + +Notes for type implementors +--------------------------- + +Implementors should be careful to make equal numbers equal and hash +them to the same values. This may be subtle if there are two different +extensions of the real numbers. For example, :class:`fractions.Fraction` +implements :func:`hash` as follows:: + + def __hash__(self): + if self.denominator == 1: + # Get integers right. + return hash(self.numerator) + # Expensive check, but definitely correct. + if self == float(self): + return hash(float(self)) + else: + # Use tuple's hash to avoid a high collision rate on + # simple fractions. + return hash((self.numerator, self.denominator)) + + +Adding More Numeric ABCs +~~~~~~~~~~~~~~~~~~~~~~~~ + +There are, of course, more possible ABCs for numbers, and this would +be a poor hierarchy if it precluded the possibility of adding +those. You can add ``MyFoo`` between :class:`Complex` and +:class:`Real` with:: + + class MyFoo(Complex): ... + MyFoo.register(Real) + + +.. _implementing-the-arithmetic-operations: + +Implementing the arithmetic operations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +We want to implement the arithmetic operations so that mixed-mode +operations either call an implementation whose author knew about the +types of both arguments, or convert both to the nearest built in type +and do the operation there. For subtypes of :class:`Integral`, this +means that :meth:`__add__` and :meth:`__radd__` should be defined as:: + + class MyIntegral(Integral): + + def __add__(self, other): + if isinstance(other, MyIntegral): + return do_my_adding_stuff(self, other) + elif isinstance(other, OtherTypeIKnowAbout): + return do_my_other_adding_stuff(self, other) + else: + return NotImplemented + + def __radd__(self, other): + if isinstance(other, MyIntegral): + return do_my_adding_stuff(other, self) + elif isinstance(other, OtherTypeIKnowAbout): + return do_my_other_adding_stuff(other, self) + elif isinstance(other, Integral): + return int(other) + int(self) + elif isinstance(other, Real): + return float(other) + float(self) + elif isinstance(other, Complex): + return complex(other) + complex(self) + else: + return NotImplemented + + +There are 5 different cases for a mixed-type operation on subclasses +of :class:`Complex`. I'll refer to all of the above code that doesn't +refer to ``MyIntegral`` and ``OtherTypeIKnowAbout`` as +"boilerplate". ``a`` will be an instance of ``A``, which is a subtype +of :class:`Complex` (``a : A <: Complex``), and ``b : B <: +Complex``. I'll consider ``a + b``: + + 1. If ``A`` defines an :meth:`__add__` which accepts ``b``, all is + well. + 2. If ``A`` falls back to the boilerplate code, and it were to + return a value from :meth:`__add__`, we'd miss the possibility + that ``B`` defines a more intelligent :meth:`__radd__`, so the + boilerplate should return :const:`NotImplemented` from + :meth:`__add__`. (Or ``A`` may not implement :meth:`__add__` at + all.) + 3. Then ``B``'s :meth:`__radd__` gets a chance. If it accepts + ``a``, all is well. + 4. If it falls back to the boilerplate, there are no more possible + methods to try, so this is where the default implementation + should live. + 5. If ``B <: A``, Python tries ``B.__radd__`` before + ``A.__add__``. This is ok, because it was implemented with + knowledge of ``A``, so it can handle those instances before + delegating to :class:`Complex`. + +If ``A <: Complex`` and ``B <: Real`` without sharing any other knowledge, +then the appropriate shared operation is the one involving the built +in :class:`complex`, and both :meth:`__radd__` s land there, so ``a+b +== b+a``. + +Because most of the operations on any given type will be very similar, +it can be useful to define a helper function which generates the +forward and reverse instances of any given operator. For example, +:class:`fractions.Fraction` uses:: + + def _operator_fallbacks(monomorphic_operator, fallback_operator): + def forward(a, b): + if isinstance(b, (int, Fraction)): + return monomorphic_operator(a, b) + elif isinstance(b, float): + return fallback_operator(float(a), b) + elif isinstance(b, complex): + return fallback_operator(complex(a), b) + else: + return NotImplemented + forward.__name__ = '__' + fallback_operator.__name__ + '__' + forward.__doc__ = monomorphic_operator.__doc__ + + def reverse(b, a): + if isinstance(a, Rational): + # Includes ints. + return monomorphic_operator(a, b) + elif isinstance(a, numbers.Real): + return fallback_operator(float(a), float(b)) + elif isinstance(a, numbers.Complex): + return fallback_operator(complex(a), complex(b)) + else: + return NotImplemented + reverse.__name__ = '__r' + fallback_operator.__name__ + '__' + reverse.__doc__ = monomorphic_operator.__doc__ + + return forward, reverse + + def _add(a, b): + """a + b""" + return Fraction(a.numerator * b.denominator + + b.numerator * a.denominator, + a.denominator * b.denominator) + + __add__, __radd__ = _operator_fallbacks(_add, operator.add) + + # ... diff --git a/python-3.7.4-docs-html/_sources/library/numeric.rst.txt b/python-3.7.4-docs-html/_sources/library/numeric.rst.txt new file mode 100644 index 0000000..7c76a47 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/numeric.rst.txt @@ -0,0 +1,26 @@ + +.. _numeric: + +******************************** +Numeric and Mathematical Modules +******************************** + +The modules described in this chapter provide numeric and math-related functions +and data types. The :mod:`numbers` module defines an abstract hierarchy of +numeric types. The :mod:`math` and :mod:`cmath` modules contain various +mathematical functions for floating-point and complex numbers. The :mod:`decimal` +module supports exact representations of decimal numbers, using arbitrary precision +arithmetic. + +The following modules are documented in this chapter: + + +.. toctree:: + + numbers.rst + math.rst + cmath.rst + decimal.rst + fractions.rst + random.rst + statistics.rst diff --git a/python-3.7.4-docs-html/_sources/library/operator.rst.txt b/python-3.7.4-docs-html/_sources/library/operator.rst.txt new file mode 100644 index 0000000..11152f6 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/operator.rst.txt @@ -0,0 +1,557 @@ +:mod:`operator` --- Standard operators as functions +=================================================== + +.. module:: operator + :synopsis: Functions corresponding to the standard operators. + +.. sectionauthor:: Skip Montanaro + +**Source code:** :source:`Lib/operator.py` + +.. testsetup:: + + import operator + from operator import itemgetter, iadd + +-------------- + +The :mod:`operator` module exports a set of efficient functions corresponding to +the intrinsic operators of Python. For example, ``operator.add(x, y)`` is +equivalent to the expression ``x+y``. Many function names are those used for +special methods, without the double underscores. For backward compatibility, +many of these have a variant with the double underscores kept. The variants +without the double underscores are preferred for clarity. + +The functions fall into categories that perform object comparisons, logical +operations, mathematical operations and sequence operations. + +The object comparison functions are useful for all objects, and are named after +the rich comparison operators they support: + + +.. function:: lt(a, b) + le(a, b) + eq(a, b) + ne(a, b) + ge(a, b) + gt(a, b) + __lt__(a, b) + __le__(a, b) + __eq__(a, b) + __ne__(a, b) + __ge__(a, b) + __gt__(a, b) + + Perform "rich comparisons" between *a* and *b*. Specifically, ``lt(a, b)`` is + equivalent to ``a < b``, ``le(a, b)`` is equivalent to ``a <= b``, ``eq(a, + b)`` is equivalent to ``a == b``, ``ne(a, b)`` is equivalent to ``a != b``, + ``gt(a, b)`` is equivalent to ``a > b`` and ``ge(a, b)`` is equivalent to ``a + >= b``. Note that these functions can return any value, which may + or may not be interpretable as a Boolean value. See + :ref:`comparisons` for more information about rich comparisons. + + +The logical operations are also generally applicable to all objects, and support +truth tests, identity tests, and boolean operations: + + +.. function:: not_(obj) + __not__(obj) + + Return the outcome of :keyword:`not` *obj*. (Note that there is no + :meth:`__not__` method for object instances; only the interpreter core defines + this operation. The result is affected by the :meth:`__bool__` and + :meth:`__len__` methods.) + + +.. function:: truth(obj) + + Return :const:`True` if *obj* is true, and :const:`False` otherwise. This is + equivalent to using the :class:`bool` constructor. + + +.. function:: is_(a, b) + + Return ``a is b``. Tests object identity. + + +.. function:: is_not(a, b) + + Return ``a is not b``. Tests object identity. + + +The mathematical and bitwise operations are the most numerous: + + +.. function:: abs(obj) + __abs__(obj) + + Return the absolute value of *obj*. + + +.. function:: add(a, b) + __add__(a, b) + + Return ``a + b``, for *a* and *b* numbers. + + +.. function:: and_(a, b) + __and__(a, b) + + Return the bitwise and of *a* and *b*. + + +.. function:: floordiv(a, b) + __floordiv__(a, b) + + Return ``a // b``. + + +.. function:: index(a) + __index__(a) + + Return *a* converted to an integer. Equivalent to ``a.__index__()``. + + +.. function:: inv(obj) + invert(obj) + __inv__(obj) + __invert__(obj) + + Return the bitwise inverse of the number *obj*. This is equivalent to ``~obj``. + + +.. function:: lshift(a, b) + __lshift__(a, b) + + Return *a* shifted left by *b*. + + +.. function:: mod(a, b) + __mod__(a, b) + + Return ``a % b``. + + +.. function:: mul(a, b) + __mul__(a, b) + + Return ``a * b``, for *a* and *b* numbers. + + +.. function:: matmul(a, b) + __matmul__(a, b) + + Return ``a @ b``. + + .. versionadded:: 3.5 + + +.. function:: neg(obj) + __neg__(obj) + + Return *obj* negated (``-obj``). + + +.. function:: or_(a, b) + __or__(a, b) + + Return the bitwise or of *a* and *b*. + + +.. function:: pos(obj) + __pos__(obj) + + Return *obj* positive (``+obj``). + + +.. function:: pow(a, b) + __pow__(a, b) + + Return ``a ** b``, for *a* and *b* numbers. + + +.. function:: rshift(a, b) + __rshift__(a, b) + + Return *a* shifted right by *b*. + + +.. function:: sub(a, b) + __sub__(a, b) + + Return ``a - b``. + + +.. function:: truediv(a, b) + __truediv__(a, b) + + Return ``a / b`` where 2/3 is .66 rather than 0. This is also known as + "true" division. + + +.. function:: xor(a, b) + __xor__(a, b) + + Return the bitwise exclusive or of *a* and *b*. + + +Operations which work with sequences (some of them with mappings too) include: + +.. function:: concat(a, b) + __concat__(a, b) + + Return ``a + b`` for *a* and *b* sequences. + + +.. function:: contains(a, b) + __contains__(a, b) + + Return the outcome of the test ``b in a``. Note the reversed operands. + + +.. function:: countOf(a, b) + + Return the number of occurrences of *b* in *a*. + + +.. function:: delitem(a, b) + __delitem__(a, b) + + Remove the value of *a* at index *b*. + + +.. function:: getitem(a, b) + __getitem__(a, b) + + Return the value of *a* at index *b*. + + +.. function:: indexOf(a, b) + + Return the index of the first of occurrence of *b* in *a*. + + +.. function:: setitem(a, b, c) + __setitem__(a, b, c) + + Set the value of *a* at index *b* to *c*. + + +.. function:: length_hint(obj, default=0) + + Return an estimated length for the object *o*. First try to return its + actual length, then an estimate using :meth:`object.__length_hint__`, and + finally return the default value. + + .. versionadded:: 3.4 + +The :mod:`operator` module also defines tools for generalized attribute and item +lookups. These are useful for making fast field extractors as arguments for +:func:`map`, :func:`sorted`, :meth:`itertools.groupby`, or other functions that +expect a function argument. + + +.. function:: attrgetter(attr) + attrgetter(*attrs) + + Return a callable object that fetches *attr* from its operand. + If more than one attribute is requested, returns a tuple of attributes. + The attribute names can also contain dots. For example: + + * After ``f = attrgetter('name')``, the call ``f(b)`` returns ``b.name``. + + * After ``f = attrgetter('name', 'date')``, the call ``f(b)`` returns + ``(b.name, b.date)``. + + * After ``f = attrgetter('name.first', 'name.last')``, the call ``f(b)`` + returns ``(b.name.first, b.name.last)``. + + Equivalent to:: + + def attrgetter(*items): + if any(not isinstance(item, str) for item in items): + raise TypeError('attribute name must be a string') + if len(items) == 1: + attr = items[0] + def g(obj): + return resolve_attr(obj, attr) + else: + def g(obj): + return tuple(resolve_attr(obj, attr) for attr in items) + return g + + def resolve_attr(obj, attr): + for name in attr.split("."): + obj = getattr(obj, name) + return obj + + +.. function:: itemgetter(item) + itemgetter(*items) + + Return a callable object that fetches *item* from its operand using the + operand's :meth:`__getitem__` method. If multiple items are specified, + returns a tuple of lookup values. For example: + + * After ``f = itemgetter(2)``, the call ``f(r)`` returns ``r[2]``. + + * After ``g = itemgetter(2, 5, 3)``, the call ``g(r)`` returns + ``(r[2], r[5], r[3])``. + + Equivalent to:: + + def itemgetter(*items): + if len(items) == 1: + item = items[0] + def g(obj): + return obj[item] + else: + def g(obj): + return tuple(obj[item] for item in items) + return g + + The items can be any type accepted by the operand's :meth:`__getitem__` + method. Dictionaries accept any hashable value. Lists, tuples, and + strings accept an index or a slice: + + >>> itemgetter(1)('ABCDEFG') + 'B' + >>> itemgetter(1,3,5)('ABCDEFG') + ('B', 'D', 'F') + >>> itemgetter(slice(2,None))('ABCDEFG') + 'CDEFG' + + >>> soldier = dict(rank='captain', name='dotterbart') + >>> itemgetter('rank')(soldier) + 'captain' + + Example of using :func:`itemgetter` to retrieve specific fields from a + tuple record: + + >>> inventory = [('apple', 3), ('banana', 2), ('pear', 5), ('orange', 1)] + >>> getcount = itemgetter(1) + >>> list(map(getcount, inventory)) + [3, 2, 5, 1] + >>> sorted(inventory, key=getcount) + [('orange', 1), ('banana', 2), ('apple', 3), ('pear', 5)] + + +.. function:: methodcaller(name[, args...]) + + Return a callable object that calls the method *name* on its operand. If + additional arguments and/or keyword arguments are given, they will be given + to the method as well. For example: + + * After ``f = methodcaller('name')``, the call ``f(b)`` returns ``b.name()``. + + * After ``f = methodcaller('name', 'foo', bar=1)``, the call ``f(b)`` + returns ``b.name('foo', bar=1)``. + + Equivalent to:: + + def methodcaller(name, *args, **kwargs): + def caller(obj): + return getattr(obj, name)(*args, **kwargs) + return caller + + +.. _operator-map: + +Mapping Operators to Functions +------------------------------ + +This table shows how abstract operations correspond to operator symbols in the +Python syntax and the functions in the :mod:`operator` module. + ++-----------------------+-------------------------+---------------------------------------+ +| Operation | Syntax | Function | ++=======================+=========================+=======================================+ +| Addition | ``a + b`` | ``add(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Concatenation | ``seq1 + seq2`` | ``concat(seq1, seq2)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Containment Test | ``obj in seq`` | ``contains(seq, obj)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Division | ``a / b`` | ``truediv(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Division | ``a // b`` | ``floordiv(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Bitwise And | ``a & b`` | ``and_(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Bitwise Exclusive Or | ``a ^ b`` | ``xor(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Bitwise Inversion | ``~ a`` | ``invert(a)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Bitwise Or | ``a | b`` | ``or_(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Exponentiation | ``a ** b`` | ``pow(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Identity | ``a is b`` | ``is_(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Identity | ``a is not b`` | ``is_not(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Indexed Assignment | ``obj[k] = v`` | ``setitem(obj, k, v)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Indexed Deletion | ``del obj[k]`` | ``delitem(obj, k)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Indexing | ``obj[k]`` | ``getitem(obj, k)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Left Shift | ``a << b`` | ``lshift(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Modulo | ``a % b`` | ``mod(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Multiplication | ``a * b`` | ``mul(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Matrix Multiplication | ``a @ b`` | ``matmul(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Negation (Arithmetic) | ``- a`` | ``neg(a)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Negation (Logical) | ``not a`` | ``not_(a)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Positive | ``+ a`` | ``pos(a)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Right Shift | ``a >> b`` | ``rshift(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Slice Assignment | ``seq[i:j] = values`` | ``setitem(seq, slice(i, j), values)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Slice Deletion | ``del seq[i:j]`` | ``delitem(seq, slice(i, j))`` | ++-----------------------+-------------------------+---------------------------------------+ +| Slicing | ``seq[i:j]`` | ``getitem(seq, slice(i, j))`` | ++-----------------------+-------------------------+---------------------------------------+ +| String Formatting | ``s % obj`` | ``mod(s, obj)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Subtraction | ``a - b`` | ``sub(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Truth Test | ``obj`` | ``truth(obj)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Ordering | ``a < b`` | ``lt(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Ordering | ``a <= b`` | ``le(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Equality | ``a == b`` | ``eq(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Difference | ``a != b`` | ``ne(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Ordering | ``a >= b`` | ``ge(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ +| Ordering | ``a > b`` | ``gt(a, b)`` | ++-----------------------+-------------------------+---------------------------------------+ + +In-place Operators +------------------ + +Many operations have an "in-place" version. Listed below are functions +providing a more primitive access to in-place operators than the usual syntax +does; for example, the :term:`statement` ``x += y`` is equivalent to +``x = operator.iadd(x, y)``. Another way to put it is to say that +``z = operator.iadd(x, y)`` is equivalent to the compound statement +``z = x; z += y``. + +In those examples, note that when an in-place method is called, the computation +and assignment are performed in two separate steps. The in-place functions +listed below only do the first step, calling the in-place method. The second +step, assignment, is not handled. + +For immutable targets such as strings, numbers, and tuples, the updated +value is computed, but not assigned back to the input variable: + +>>> a = 'hello' +>>> iadd(a, ' world') +'hello world' +>>> a +'hello' + +For mutable targets such as lists and dictionaries, the in-place method +will perform the update, so no subsequent assignment is necessary: + +>>> s = ['h', 'e', 'l', 'l', 'o'] +>>> iadd(s, [' ', 'w', 'o', 'r', 'l', 'd']) +['h', 'e', 'l', 'l', 'o', ' ', 'w', 'o', 'r', 'l', 'd'] +>>> s +['h', 'e', 'l', 'l', 'o', ' ', 'w', 'o', 'r', 'l', 'd'] + +.. function:: iadd(a, b) + __iadd__(a, b) + + ``a = iadd(a, b)`` is equivalent to ``a += b``. + + +.. function:: iand(a, b) + __iand__(a, b) + + ``a = iand(a, b)`` is equivalent to ``a &= b``. + + +.. function:: iconcat(a, b) + __iconcat__(a, b) + + ``a = iconcat(a, b)`` is equivalent to ``a += b`` for *a* and *b* sequences. + + +.. function:: ifloordiv(a, b) + __ifloordiv__(a, b) + + ``a = ifloordiv(a, b)`` is equivalent to ``a //= b``. + + +.. function:: ilshift(a, b) + __ilshift__(a, b) + + ``a = ilshift(a, b)`` is equivalent to ``a <<= b``. + + +.. function:: imod(a, b) + __imod__(a, b) + + ``a = imod(a, b)`` is equivalent to ``a %= b``. + + +.. function:: imul(a, b) + __imul__(a, b) + + ``a = imul(a, b)`` is equivalent to ``a *= b``. + + +.. function:: imatmul(a, b) + __imatmul__(a, b) + + ``a = imatmul(a, b)`` is equivalent to ``a @= b``. + + .. versionadded:: 3.5 + + +.. function:: ior(a, b) + __ior__(a, b) + + ``a = ior(a, b)`` is equivalent to ``a |= b``. + + +.. function:: ipow(a, b) + __ipow__(a, b) + + ``a = ipow(a, b)`` is equivalent to ``a **= b``. + + +.. function:: irshift(a, b) + __irshift__(a, b) + + ``a = irshift(a, b)`` is equivalent to ``a >>= b``. + + +.. function:: isub(a, b) + __isub__(a, b) + + ``a = isub(a, b)`` is equivalent to ``a -= b``. + + +.. function:: itruediv(a, b) + __itruediv__(a, b) + + ``a = itruediv(a, b)`` is equivalent to ``a /= b``. + + +.. function:: ixor(a, b) + __ixor__(a, b) + + ``a = ixor(a, b)`` is equivalent to ``a ^= b``. diff --git a/python-3.7.4-docs-html/_sources/library/optparse.rst.txt b/python-3.7.4-docs-html/_sources/library/optparse.rst.txt new file mode 100644 index 0000000..3afc77b --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/optparse.rst.txt @@ -0,0 +1,2037 @@ +:mod:`optparse` --- Parser for command line options +=================================================== + +.. module:: optparse + :synopsis: Command-line option parsing library. + :deprecated: + +.. moduleauthor:: Greg Ward +.. sectionauthor:: Greg Ward + +**Source code:** :source:`Lib/optparse.py` + +.. deprecated:: 3.2 + The :mod:`optparse` module is deprecated and will not be developed further; + development will continue with the :mod:`argparse` module. + +-------------- + +:mod:`optparse` is a more convenient, flexible, and powerful library for parsing +command-line options than the old :mod:`getopt` module. :mod:`optparse` uses a +more declarative style of command-line parsing: you create an instance of +:class:`OptionParser`, populate it with options, and parse the command +line. :mod:`optparse` allows users to specify options in the conventional +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") + parser.add_option("-q", "--quiet", + action="store_false", dest="verbose", default=True, + help="don't print status messages to stdout") + + (options, args) = parser.parse_args() + +With these few lines of code, users of your script can now do the "usual thing" +on the command-line, for example:: + + --file=outfile -q + +As it parses the command line, :mod:`optparse` sets attributes of the +``options`` object returned by :meth:`parse_args` based on user-supplied +command-line values. When :meth:`parse_args` returns from parsing this command +line, ``options.filename`` will be ``"outfile"`` and ``options.verbose`` will be +``False``. :mod:`optparse` supports both long and short options, allows short +options to be merged together, and allows options to be associated with their +arguments in a variety of ways. Thus, the following command lines are all +equivalent to the above example:: + + -f outfile --quiet + --quiet --file outfile + -q -foutfile + -qfoutfile + +Additionally, users can run one of :: + + -h + --help + +and :mod:`optparse` will print out a brief summary of your script's options: + +.. code-block:: text + + Usage: [options] + + Options: + -h, --help show this help message and exit + -f FILE, --file=FILE write report to FILE + -q, --quiet don't print status messages to stdout + +where the value of *yourscript* is determined at runtime (normally from +``sys.argv[0]``). + + +.. _optparse-background: + +Background +---------- + +:mod:`optparse` was explicitly designed to encourage the creation of programs +with straightforward, conventional command-line interfaces. To that end, it +supports only the most common command-line syntax and semantics conventionally +used under Unix. If you are unfamiliar with these conventions, read this +section to acquaint yourself with them. + + +.. _optparse-terminology: + +Terminology +^^^^^^^^^^^ + +argument + a string entered on the command-line, and passed by the shell to ``execl()`` + or ``execv()``. In Python, arguments are elements of ``sys.argv[1:]`` + (``sys.argv[0]`` is the name of the program being executed). Unix shells + also use the term "word". + + It is occasionally desirable to substitute an argument list other than + ``sys.argv[1:]``, so you should read "argument" as "an element of + ``sys.argv[1:]``, or of some other list provided as a substitute for + ``sys.argv[1:]``". + +option + an argument used to supply extra information to guide or customize the + execution of a program. There are many different syntaxes for options; the + traditional Unix syntax is a hyphen ("-") followed by a single letter, + e.g. ``-x`` or ``-F``. Also, traditional Unix syntax allows multiple + options to be merged into a single argument, e.g. ``-x -F`` is equivalent + to ``-xF``. The GNU project introduced ``--`` followed by a series of + hyphen-separated words, e.g. ``--file`` or ``--dry-run``. These are the + only two option syntaxes provided by :mod:`optparse`. + + Some other option syntaxes that the world has seen include: + + * a hyphen followed by a few letters, e.g. ``-pf`` (this is *not* the same + as multiple options merged into a single argument) + + * a hyphen followed by a whole word, e.g. ``-file`` (this is technically + equivalent to the previous syntax, but they aren't usually seen in the same + program) + + * a plus sign followed by a single letter, or a few letters, or a word, e.g. + ``+f``, ``+rgb`` + + * a slash followed by a letter, or a few letters, or a word, e.g. ``/f``, + ``/file`` + + These option syntaxes are not supported by :mod:`optparse`, and they never + will be. This is deliberate: the first three are non-standard on any + environment, and the last only makes sense if you're exclusively targeting + VMS, MS-DOS, and/or Windows. + +option argument + an argument that follows an option, is closely associated with that option, + and is consumed from the argument list when that option is. With + :mod:`optparse`, option arguments may either be in a separate argument from + their option: + + .. code-block:: text + + -f foo + --file foo + + or included in the same argument: + + .. code-block:: text + + -ffoo + --file=foo + + Typically, a given option either takes an argument or it doesn't. Lots of + people want an "optional option arguments" feature, meaning that some options + will take an argument if they see it, and won't if they don't. This is + somewhat controversial, because it makes parsing ambiguous: if ``-a`` takes + an optional argument and ``-b`` is another option entirely, how do we + interpret ``-ab``? Because of this ambiguity, :mod:`optparse` does not + support this feature. + +positional argument + something leftover in the argument list after options have been parsed, i.e. + after options and their arguments have been parsed and removed from the + argument list. + +required option + an option that must be supplied on the command-line; note that the phrase + "required option" is self-contradictory in English. :mod:`optparse` doesn't + prevent you from implementing required options, but doesn't give you much + help at it either. + +For example, consider this hypothetical command-line:: + + prog -v --report report.txt foo bar + +``-v`` and ``--report`` are both options. Assuming that ``--report`` +takes one argument, ``report.txt`` is an option argument. ``foo`` and +``bar`` are positional arguments. + + +.. _optparse-what-options-for: + +What are options for? +^^^^^^^^^^^^^^^^^^^^^ + +Options are used to provide extra information to tune or customize the execution +of a program. In case it wasn't clear, options are usually *optional*. A +program should be able to run just fine with no options whatsoever. (Pick a +random program from the Unix or GNU toolsets. Can it run without any options at +all and still make sense? The main exceptions are ``find``, ``tar``, and +``dd``\ ---all of which are mutant oddballs that have been rightly criticized +for their non-standard syntax and confusing interfaces.) + +Lots of people want their programs to have "required options". Think about it. +If it's required, then it's *not optional*! If there is a piece of information +that your program absolutely requires in order to run successfully, that's what +positional arguments are for. + +As an example of good command-line interface design, consider the humble ``cp`` +utility, for copying files. It doesn't make much sense to try to copy files +without supplying a destination and at least one source. Hence, ``cp`` fails if +you run it with no arguments. However, it has a flexible, useful syntax that +does not require any options at all:: + + cp SOURCE DEST + cp SOURCE ... DEST-DIR + +You can get pretty far with just that. Most ``cp`` implementations provide a +bunch of options to tweak exactly how the files are copied: you can preserve +mode and modification time, avoid following symlinks, ask before clobbering +existing files, etc. But none of this distracts from the core mission of +``cp``, which is to copy either one file to another, or several files to another +directory. + + +.. _optparse-what-positional-arguments-for: + +What are positional arguments for? +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Positional arguments are for those pieces of information that your program +absolutely, positively requires to run. + +A good user interface should have as few absolute requirements as possible. If +your program requires 17 distinct pieces of information in order to run +successfully, it doesn't much matter *how* you get that information from the +user---most people will give up and walk away before they successfully run the +program. This applies whether the user interface is a command-line, a +configuration file, or a GUI: if you make that many demands on your users, most +of them will simply give up. + +In short, try to minimize the amount of information that users are absolutely +required to supply---use sensible defaults whenever possible. Of course, you +also want to make your programs reasonably flexible. That's what options are +for. Again, it doesn't matter if they are entries in a config file, widgets in +the "Preferences" dialog of a GUI, or command-line options---the more options +you implement, the more flexible your program is, and the more complicated its +implementation becomes. Too much flexibility has drawbacks as well, of course; +too many options can overwhelm users and make your code much harder to maintain. + + +.. _optparse-tutorial: + +Tutorial +-------- + +While :mod:`optparse` is quite flexible and powerful, it's also straightforward +to use in most cases. This section covers the code patterns that are common to +any :mod:`optparse`\ -based program. + +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:: + + parser.add_option(opt_str, ..., + attr=value, ...) + +Each option has one or more option strings, such as ``-f`` or ``--file``, +and several option attributes that tell :mod:`optparse` what to expect and what +to do when it encounters that option on the command line. + +Typically, each option will have one short option string and one long option +string, e.g.:: + + parser.add_option("-f", "--file", ...) + +You're free to define as many short option strings and as many long option +strings as you like (including zero), as long as there is at least one option +string overall. + +The option strings passed to :meth:`OptionParser.add_option` are effectively +labels for the +option defined by that call. For brevity, we will frequently refer to +*encountering an option* on the command line; in reality, :mod:`optparse` +encounters *option strings* and looks up options from them. + +Once all of your options are defined, instruct :mod:`optparse` to parse your +program's command line:: + + (options, args) = parser.parse_args() + +(If you like, you can pass a custom argument list to :meth:`parse_args`, but +that's rarely necessary: by default it uses ``sys.argv[1:]``.) + +:meth:`parse_args` returns two values: + +* ``options``, an object containing values for all of your options---e.g. if + ``--file`` takes a single string argument, then ``options.file`` will be the + filename supplied by the user, or ``None`` if the user did not supply that + option + +* ``args``, the list of positional arguments leftover after parsing options + +This tutorial section only covers the four most important option attributes: +:attr:`~Option.action`, :attr:`~Option.type`, :attr:`~Option.dest` +(destination), and :attr:`~Option.help`. Of these, :attr:`~Option.action` is the +most fundamental. + + +.. _optparse-understanding-option-actions: + +Understanding option actions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Actions tell :mod:`optparse` what to do when it encounters an option on the +command line. There is a fixed set of actions hard-coded into :mod:`optparse`; +adding new actions is an advanced topic covered in section +:ref:`optparse-extending-optparse`. Most actions tell :mod:`optparse` to store +a value in some variable---for example, take a string from the command line and +store it in an attribute of ``options``. + +If you don't specify an option action, :mod:`optparse` defaults to ``store``. + + +.. _optparse-store-action: + +The store action +^^^^^^^^^^^^^^^^ + +The most common option action is ``store``, which tells :mod:`optparse` to take +the next argument (or the remainder of the current argument), ensure that it is +of the correct type, and store it to your chosen destination. + +For example:: + + parser.add_option("-f", "--file", + action="store", type="string", dest="filename") + +Now let's make up a fake command line and ask :mod:`optparse` to parse it:: + + args = ["-f", "foo.txt"] + (options, args) = parser.parse_args(args) + +When :mod:`optparse` sees the option string ``-f``, it consumes the next +argument, ``foo.txt``, and stores it in ``options.filename``. So, after this +call to :meth:`parse_args`, ``options.filename`` is ``"foo.txt"``. + +Some other option types supported by :mod:`optparse` are ``int`` and ``float``. +Here's an option that expects an integer argument:: + + parser.add_option("-n", type="int", dest="num") + +Note that this option has no long option string, which is perfectly acceptable. +Also, there's no explicit action, since the default is ``store``. + +Let's parse another fake command-line. This time, we'll jam the option argument +right up against the option: since ``-n42`` (one argument) is equivalent to +``-n 42`` (two arguments), the code :: + + (options, args) = parser.parse_args(["-n42"]) + print(options.num) + +will print ``42``. + +If you don't specify a type, :mod:`optparse` assumes ``string``. Combined with +the fact that the default action is ``store``, that means our first example can +be a lot shorter:: + + parser.add_option("-f", "--file", dest="filename") + +If you don't supply a destination, :mod:`optparse` figures out a sensible +default from the option strings: if the first long option string is +``--foo-bar``, then the default destination is ``foo_bar``. If there are no +long option strings, :mod:`optparse` looks at the first short option string: the +default destination for ``-f`` is ``f``. + +:mod:`optparse` also includes the built-in ``complex`` type. Adding +types is covered in section :ref:`optparse-extending-optparse`. + + +.. _optparse-handling-boolean-options: + +Handling boolean (flag) options +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Flag options---set a variable to true or false when a particular option is +seen---are quite common. :mod:`optparse` supports them with two separate actions, +``store_true`` and ``store_false``. For example, you might have a ``verbose`` +flag that is turned on with ``-v`` and off with ``-q``:: + + parser.add_option("-v", action="store_true", dest="verbose") + parser.add_option("-q", action="store_false", dest="verbose") + +Here we have two different options with the same destination, which is perfectly +OK. (It just means you have to be a bit careful when setting default +values---see below.) + +When :mod:`optparse` encounters ``-v`` on the command line, it sets +``options.verbose`` to ``True``; when it encounters ``-q``, +``options.verbose`` is set to ``False``. + + +.. _optparse-other-actions: + +Other actions +^^^^^^^^^^^^^ + +Some other actions supported by :mod:`optparse` are: + +``"store_const"`` + store a constant value + +``"append"`` + append this option's argument to a list + +``"count"`` + increment a counter by one + +``"callback"`` + call a specified function + +These are covered in section :ref:`optparse-reference-guide`, Reference Guide +and section :ref:`optparse-option-callbacks`. + + +.. _optparse-default-values: + +Default values +^^^^^^^^^^^^^^ + +All of the above examples involve setting some variable (the "destination") when +certain command-line options are seen. What happens if those options are never +seen? Since we didn't supply any defaults, they are all set to ``None``. This +is usually fine, but sometimes you want more control. :mod:`optparse` lets you +supply a default value for each destination, which is assigned before the +command line is parsed. + +First, consider the verbose/quiet example. If we want :mod:`optparse` to set +``verbose`` to ``True`` unless ``-q`` is seen, then we can do this:: + + parser.add_option("-v", action="store_true", dest="verbose", default=True) + parser.add_option("-q", action="store_false", dest="verbose") + +Since default values apply to the *destination* rather than to any particular +option, and these two options happen to have the same destination, this is +exactly equivalent:: + + parser.add_option("-v", action="store_true", dest="verbose") + parser.add_option("-q", action="store_false", dest="verbose", default=True) + +Consider this:: + + parser.add_option("-v", action="store_true", dest="verbose", default=False) + parser.add_option("-q", action="store_false", dest="verbose", default=True) + +Again, the default value for ``verbose`` will be ``True``: the last default +value supplied for any particular destination is the one that counts. + +A clearer way to specify default values is the :meth:`set_defaults` method of +OptionParser, which you can call at any time before calling :meth:`parse_args`:: + + parser.set_defaults(verbose=True) + parser.add_option(...) + (options, args) = parser.parse_args() + +As before, the last value specified for a given option destination is the one +that counts. For clarity, try to use one method or the other of setting default +values, not both. + + +.. _optparse-generating-help: + +Generating help +^^^^^^^^^^^^^^^ + +:mod:`optparse`'s ability to generate help and usage text automatically is +useful for creating user-friendly command-line interfaces. All you have to do +is supply a :attr:`~Option.help` value for each option, and optionally a short +usage message for your whole program. Here's an OptionParser populated with +user-friendly (documented) options:: + + usage = "usage: %prog [options] arg1 arg2" + parser = OptionParser(usage=usage) + parser.add_option("-v", "--verbose", + action="store_true", dest="verbose", default=True, + help="make lots of noise [default]") + parser.add_option("-q", "--quiet", + action="store_false", dest="verbose", + help="be vewwy quiet (I'm hunting wabbits)") + parser.add_option("-f", "--filename", + metavar="FILE", help="write output to FILE") + parser.add_option("-m", "--mode", + default="intermediate", + help="interaction mode: novice, intermediate, " + "or expert [default: %default]") + +If :mod:`optparse` encounters either ``-h`` or ``--help`` on the +command-line, or if you just call :meth:`parser.print_help`, it prints the +following to standard output: + +.. code-block:: text + + Usage: [options] arg1 arg2 + + Options: + -h, --help show this help message and exit + -v, --verbose make lots of noise [default] + -q, --quiet be vewwy quiet (I'm hunting wabbits) + -f FILE, --filename=FILE + write output to FILE + -m MODE, --mode=MODE interaction mode: novice, intermediate, or + expert [default: intermediate] + +(If the help output is triggered by a help option, :mod:`optparse` exits after +printing the help text.) + +There's a lot going on here to help :mod:`optparse` generate the best possible +help message: + +* the script defines its own usage message:: + + usage = "usage: %prog [options] arg1 arg2" + + :mod:`optparse` expands ``%prog`` in the usage string to the name of the + current program, i.e. ``os.path.basename(sys.argv[0])``. The expanded string + is then printed before the detailed option help. + + If you don't supply a usage string, :mod:`optparse` uses a bland but sensible + default: ``"Usage: %prog [options]"``, which is fine if your script doesn't + take any positional arguments. + +* every option defines a help string, and doesn't worry about + line-wrapping---\ :mod:`optparse` takes care of wrapping lines and making + the help output look good. + +* options that take a value indicate this fact in their automatically-generated + help message, e.g. for the "mode" option:: + + -m MODE, --mode=MODE + + Here, "MODE" is called the meta-variable: it stands for the argument that the + user is expected to supply to ``-m``/``--mode``. By default, + :mod:`optparse` converts the destination variable name to uppercase and uses + that for the meta-variable. Sometimes, that's not what you want---for + example, the ``--filename`` option explicitly sets ``metavar="FILE"``, + resulting in this automatically-generated option description:: + + -f FILE, --filename=FILE + + This is important for more than just saving space, though: the manually + written help text uses the meta-variable ``FILE`` to clue the user in that + there's a connection between the semi-formal syntax ``-f FILE`` and the informal + semantic description "write output to FILE". This is a simple but effective + way to make your help text a lot clearer and more useful for end users. + +* options that have a default value can include ``%default`` in the help + string---\ :mod:`optparse` will replace it with :func:`str` of the option's + default value. If an option has no default value (or the default value is + ``None``), ``%default`` expands to ``none``. + +Grouping Options +++++++++++++++++ + +When dealing with many options, it is convenient to group these options for +better help output. An :class:`OptionParser` can contain several option groups, +each of which can contain several options. + +An option group is obtained using the class :class:`OptionGroup`: + +.. class:: OptionGroup(parser, title, description=None) + + where + + * parser is the :class:`OptionParser` instance the group will be inserted in + to + * title is the group title + * description, optional, is a long description of the group + +:class:`OptionGroup` inherits from :class:`OptionContainer` (like +:class:`OptionParser`) and so the :meth:`add_option` method can be used to add +an option to the group. + +Once all the options are declared, using the :class:`OptionParser` method +:meth:`add_option_group` the group is added to the previously defined parser. + +Continuing with the parser defined in the previous section, adding an +:class:`OptionGroup` to a parser is easy:: + + group = OptionGroup(parser, "Dangerous Options", + "Caution: use these options at your own risk. " + "It is believed that some of them bite.") + group.add_option("-g", action="store_true", help="Group option.") + parser.add_option_group(group) + +This would result in the following help output: + +.. code-block:: text + + Usage: [options] arg1 arg2 + + Options: + -h, --help show this help message and exit + -v, --verbose make lots of noise [default] + -q, --quiet be vewwy quiet (I'm hunting wabbits) + -f FILE, --filename=FILE + write output to FILE + -m MODE, --mode=MODE interaction mode: novice, intermediate, or + expert [default: intermediate] + + Dangerous Options: + Caution: use these options at your own risk. It is believed that some + of them bite. + + -g Group option. + +A bit more complete example might involve using more than one group: still +extending the previous example:: + + group = OptionGroup(parser, "Dangerous Options", + "Caution: use these options at your own risk. " + "It is believed that some of them bite.") + group.add_option("-g", action="store_true", help="Group option.") + parser.add_option_group(group) + + group = OptionGroup(parser, "Debug Options") + group.add_option("-d", "--debug", action="store_true", + help="Print debug information") + group.add_option("-s", "--sql", action="store_true", + help="Print all SQL statements executed") + group.add_option("-e", action="store_true", help="Print every action done") + parser.add_option_group(group) + +that results in the following output: + +.. code-block:: text + + Usage: [options] arg1 arg2 + + Options: + -h, --help show this help message and exit + -v, --verbose make lots of noise [default] + -q, --quiet be vewwy quiet (I'm hunting wabbits) + -f FILE, --filename=FILE + write output to FILE + -m MODE, --mode=MODE interaction mode: novice, intermediate, or expert + [default: intermediate] + + Dangerous Options: + Caution: use these options at your own risk. It is believed that some + of them bite. + + -g Group option. + + Debug Options: + -d, --debug Print debug information + -s, --sql Print all SQL statements executed + -e Print every action done + +Another interesting method, in particular when working programmatically with +option groups is: + +.. method:: OptionParser.get_option_group(opt_str) + + Return the :class:`OptionGroup` to which the short or long option + string *opt_str* (e.g. ``'-o'`` or ``'--option'``) belongs. If + there's no such :class:`OptionGroup`, return ``None``. + +.. _optparse-printing-version-string: + +Printing a version string +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Similar to the brief usage string, :mod:`optparse` can also print a version +string for your program. You have to supply the string as the ``version`` +argument to OptionParser:: + + parser = OptionParser(usage="%prog [-f] [-q]", version="%prog 1.0") + +``%prog`` is expanded just like it is in ``usage``. Apart from that, +``version`` can contain anything you like. When you supply it, :mod:`optparse` +automatically adds a ``--version`` option to your parser. If it encounters +this option on the command line, it expands your ``version`` string (by +replacing ``%prog``), prints it to stdout, and exits. + +For example, if your script is called ``/usr/bin/foo``: + +.. code-block:: shell-session + + $ /usr/bin/foo --version + foo 1.0 + +The following two methods can be used to print and get the ``version`` string: + +.. method:: OptionParser.print_version(file=None) + + Print the version message for the current program (``self.version``) to + *file* (default stdout). As with :meth:`print_usage`, any occurrence + of ``%prog`` in ``self.version`` is replaced with the name of the current + program. Does nothing if ``self.version`` is empty or undefined. + +.. method:: OptionParser.get_version() + + Same as :meth:`print_version` but returns the version string instead of + printing it. + + +.. _optparse-how-optparse-handles-errors: + +How :mod:`optparse` handles errors +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +There are two broad classes of errors that :mod:`optparse` has to worry about: +programmer errors and user errors. Programmer errors are usually erroneous +calls to :func:`OptionParser.add_option`, e.g. invalid option strings, unknown +option attributes, missing option attributes, etc. These are dealt with in the +usual way: raise an exception (either :exc:`optparse.OptionError` or +:exc:`TypeError`) and let the program crash. + +Handling user errors is much more important, since they are guaranteed to happen +no matter how stable your code is. :mod:`optparse` can automatically detect +some user errors, such as bad option arguments (passing ``-n 4x`` where +``-n`` takes an integer argument), missing arguments (``-n`` at the end +of the command line, where ``-n`` takes an argument of any type). Also, +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") + +In either case, :mod:`optparse` handles the error the same way: it prints the +program's usage message and an error message to standard error and exits with +error status 2. + +Consider the first example above, where the user passes ``4x`` to an option +that takes an integer: + +.. code-block:: shell-session + + $ /usr/bin/foo -n 4x + Usage: foo [options] + + foo: error: option -n: invalid integer value: '4x' + +Or, where the user fails to pass a value at all: + +.. code-block:: shell-session + + $ /usr/bin/foo -n + Usage: foo [options] + + foo: error: -n option requires an argument + +:mod:`optparse`\ -generated error messages take care always to mention the +option involved in the error; be sure to do the same when calling +:func:`OptionParser.error` from your application code. + +If :mod:`optparse`'s default error-handling behaviour does not suit your needs, +you'll need to subclass OptionParser and override its :meth:`~OptionParser.exit` +and/or :meth:`~OptionParser.error` methods. + + +.. _optparse-putting-it-all-together: + +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) + parser.add_option("-f", "--file", dest="filename", + help="read data from FILENAME") + parser.add_option("-v", "--verbose", + 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() + + +.. _optparse-reference-guide: + +Reference Guide +--------------- + + +.. _optparse-creating-parser: + +Creating the parser +^^^^^^^^^^^^^^^^^^^ + +The first step in using :mod:`optparse` is to create an OptionParser instance. + +.. class:: OptionParser(...) + + The OptionParser constructor has no required arguments, but a number of + optional keyword arguments. You should always pass them as keyword + arguments, i.e. do not rely on the order in which the arguments are declared. + + ``usage`` (default: ``"%prog [options]"``) + The usage summary to print when your program is run incorrectly or with a + help option. When :mod:`optparse` prints the usage string, it expands + ``%prog`` to ``os.path.basename(sys.argv[0])`` (or to ``prog`` if you + passed that keyword argument). To suppress a usage message, pass the + special value :data:`optparse.SUPPRESS_USAGE`. + + ``option_list`` (default: ``[]``) + A list of Option objects to populate the parser with. The options in + ``option_list`` are added after any options in ``standard_option_list`` (a + class attribute that may be set by OptionParser subclasses), but before + any version or help options. Deprecated; use :meth:`add_option` after + creating the parser instead. + + ``option_class`` (default: optparse.Option) + Class to use when adding options to the parser in :meth:`add_option`. + + ``version`` (default: ``None``) + A version string to print when the user supplies a version option. If you + supply a true value for ``version``, :mod:`optparse` automatically adds a + version option with the single option string ``--version``. The + substring ``%prog`` is expanded the same as for ``usage``. + + ``conflict_handler`` (default: ``"error"``) + Specifies what to do when options with conflicting option strings are + added to the parser; see section + :ref:`optparse-conflicts-between-options`. + + ``description`` (default: ``None``) + A paragraph of text giving a brief overview of your program. + :mod:`optparse` reformats this paragraph to fit the current terminal width + and prints it when the user requests help (after ``usage``, but before the + list of options). + + ``formatter`` (default: a new :class:`IndentedHelpFormatter`) + An instance of optparse.HelpFormatter that will be used for printing help + text. :mod:`optparse` provides two concrete classes for this purpose: + IndentedHelpFormatter and TitledHelpFormatter. + + ``add_help_option`` (default: ``True``) + If true, :mod:`optparse` will add a help option (with option strings ``-h`` + and ``--help``) to the parser. + + ``prog`` + The string to use when expanding ``%prog`` in ``usage`` and ``version`` + instead of ``os.path.basename(sys.argv[0])``. + + ``epilog`` (default: ``None``) + A paragraph of help text to print after the option help. + +.. _optparse-populating-parser: + +Populating the parser +^^^^^^^^^^^^^^^^^^^^^ + +There are several ways to populate the parser with options. The preferred way +is by using :meth:`OptionParser.add_option`, as shown in section +:ref:`optparse-tutorial`. :meth:`add_option` can be called in one of two ways: + +* pass it an Option instance (as returned by :func:`make_option`) + +* pass it any combination of positional and keyword arguments that are + acceptable to :func:`make_option` (i.e., to the Option constructor), and it + will create the Option instance for you + +The other alternative is to pass a list of pre-constructed Option instances to +the OptionParser constructor, as in:: + + option_list = [ + make_option("-f", "--filename", + action="store", type="string", dest="filename"), + make_option("-q", "--quiet", + action="store_false", dest="verbose"), + ] + parser = OptionParser(option_list=option_list) + +(:func:`make_option` is a factory function for creating Option instances; +currently it is an alias for the Option constructor. A future version of +:mod:`optparse` may split Option into several classes, and :func:`make_option` +will pick the right class to instantiate. Do not instantiate Option directly.) + + +.. _optparse-defining-options: + +Defining options +^^^^^^^^^^^^^^^^ + +Each Option instance represents a set of synonymous command-line option strings, +e.g. ``-f`` and ``--file``. You can specify any number of short or +long option strings, but you must specify at least one overall option string. + +The canonical way to create an :class:`Option` instance is with the +:meth:`add_option` method of :class:`OptionParser`. + +.. method:: OptionParser.add_option(option) + OptionParser.add_option(*opt_str, attr=value, ...) + + To define an option with only a short option string:: + + parser.add_option("-f", attr=value, ...) + + And to define an option with only a long option string:: + + parser.add_option("--foo", attr=value, ...) + + The keyword arguments define attributes of the new Option object. The most + important option attribute is :attr:`~Option.action`, and it largely + determines which other attributes are relevant or required. If you pass + irrelevant option attributes, or fail to pass required ones, :mod:`optparse` + raises an :exc:`OptionError` exception explaining your mistake. + + An option's *action* determines what :mod:`optparse` does when it encounters + this option on the command-line. The standard option actions hard-coded into + :mod:`optparse` are: + + ``"store"`` + store this option's argument (default) + + ``"store_const"`` + store a constant value + + ``"store_true"`` + store a true value + + ``"store_false"`` + store a false value + + ``"append"`` + append this option's argument to a list + + ``"append_const"`` + append a constant value to a list + + ``"count"`` + increment a counter by one + + ``"callback"`` + call a specified function + + ``"help"`` + print a usage message including all options and the documentation for them + + (If you don't supply an action, the default is ``"store"``. For this action, + you may also supply :attr:`~Option.type` and :attr:`~Option.dest` option + attributes; see :ref:`optparse-standard-option-actions`.) + +As you can see, most actions involve storing or updating a value somewhere. +:mod:`optparse` always creates a special object for this, conventionally called +``options`` (it happens to be an instance of :class:`optparse.Values`). Option +arguments (and various other values) are stored as attributes of this object, +according to the :attr:`~Option.dest` (destination) option attribute. + +For example, when you call :: + + parser.parse_args() + +one of the first things :mod:`optparse` does is create the ``options`` object:: + + options = Values() + +If one of the options in this parser is defined with :: + + parser.add_option("-f", "--file", action="store", type="string", dest="filename") + +and the command-line being parsed includes any of the following:: + + -ffoo + -f foo + --file=foo + --file foo + +then :mod:`optparse`, on seeing this option, will do the equivalent of :: + + options.filename = "foo" + +The :attr:`~Option.type` and :attr:`~Option.dest` option attributes are almost +as important as :attr:`~Option.action`, but :attr:`~Option.action` is the only +one that makes sense for *all* options. + + +.. _optparse-option-attributes: + +Option attributes +^^^^^^^^^^^^^^^^^ + +The following option attributes may be passed as keyword arguments to +:meth:`OptionParser.add_option`. If you pass an option attribute that is not +relevant to a particular option, or fail to pass a required option attribute, +:mod:`optparse` raises :exc:`OptionError`. + +.. attribute:: Option.action + + (default: ``"store"``) + + Determines :mod:`optparse`'s behaviour when this option is seen on the + command line; the available options are documented :ref:`here + `. + +.. attribute:: Option.type + + (default: ``"string"``) + + The argument type expected by this option (e.g., ``"string"`` or ``"int"``); + the available option types are documented :ref:`here + `. + +.. attribute:: Option.dest + + (default: derived from option strings) + + If the option's action implies writing or modifying a value somewhere, this + tells :mod:`optparse` where to write it: :attr:`~Option.dest` names an + attribute of the ``options`` object that :mod:`optparse` builds as it parses + the command line. + +.. attribute:: Option.default + + The value to use for this option's destination if the option is not seen on + the command line. See also :meth:`OptionParser.set_defaults`. + +.. attribute:: Option.nargs + + (default: 1) + + How many arguments of type :attr:`~Option.type` should be consumed when this + option is seen. If > 1, :mod:`optparse` will store a tuple of values to + :attr:`~Option.dest`. + +.. attribute:: Option.const + + For actions that store a constant value, the constant value to store. + +.. attribute:: Option.choices + + For options of type ``"choice"``, the list of strings the user may choose + from. + +.. attribute:: Option.callback + + For options with action ``"callback"``, the callable to call when this option + is seen. See section :ref:`optparse-option-callbacks` for detail on the + arguments passed to the callable. + +.. attribute:: Option.callback_args + Option.callback_kwargs + + Additional positional and keyword arguments to pass to ``callback`` after the + four standard callback arguments. + +.. attribute:: Option.help + + Help text to print for this option when listing all available options after + the user supplies a :attr:`~Option.help` option (such as ``--help``). If + no help text is supplied, the option will be listed without help text. To + hide this option, use the special value :data:`optparse.SUPPRESS_HELP`. + +.. attribute:: Option.metavar + + (default: derived from option strings) + + Stand-in for the option argument(s) to use when printing help text. See + section :ref:`optparse-tutorial` for an example. + + +.. _optparse-standard-option-actions: + +Standard option actions +^^^^^^^^^^^^^^^^^^^^^^^ + +The various option actions all have slightly different requirements and effects. +Most actions have several relevant option attributes which you may specify to +guide :mod:`optparse`'s behaviour; a few have required attributes, which you +must specify for any option using that action. + +* ``"store"`` [relevant: :attr:`~Option.type`, :attr:`~Option.dest`, + :attr:`~Option.nargs`, :attr:`~Option.choices`] + + The option must be followed by an argument, which is converted to a value + according to :attr:`~Option.type` and stored in :attr:`~Option.dest`. If + :attr:`~Option.nargs` > 1, multiple arguments will be consumed from the + command line; all will be converted according to :attr:`~Option.type` and + stored to :attr:`~Option.dest` as a tuple. See the + :ref:`optparse-standard-option-types` section. + + If :attr:`~Option.choices` is supplied (a list or tuple of strings), the type + defaults to ``"choice"``. + + If :attr:`~Option.type` is not supplied, it defaults to ``"string"``. + + If :attr:`~Option.dest` is not supplied, :mod:`optparse` derives a destination + from the first long option string (e.g., ``--foo-bar`` implies + ``foo_bar``). If there are no long option strings, :mod:`optparse` derives a + destination from the first short option string (e.g., ``-f`` implies ``f``). + + Example:: + + parser.add_option("-f") + parser.add_option("-p", type="float", nargs=3, dest="point") + + As it parses the command line :: + + -f foo.txt -p 1 -3.5 4 -fbar.txt + + :mod:`optparse` will set :: + + options.f = "foo.txt" + options.point = (1.0, -3.5, 4.0) + options.f = "bar.txt" + +* ``"store_const"`` [required: :attr:`~Option.const`; relevant: + :attr:`~Option.dest`] + + The value :attr:`~Option.const` is stored in :attr:`~Option.dest`. + + Example:: + + parser.add_option("-q", "--quiet", + action="store_const", const=0, dest="verbose") + parser.add_option("-v", "--verbose", + action="store_const", const=1, dest="verbose") + parser.add_option("--noisy", + action="store_const", const=2, dest="verbose") + + If ``--noisy`` is seen, :mod:`optparse` will set :: + + options.verbose = 2 + +* ``"store_true"`` [relevant: :attr:`~Option.dest`] + + A special case of ``"store_const"`` that stores a true value to + :attr:`~Option.dest`. + +* ``"store_false"`` [relevant: :attr:`~Option.dest`] + + Like ``"store_true"``, but stores a false value. + + Example:: + + parser.add_option("--clobber", action="store_true", dest="clobber") + parser.add_option("--no-clobber", action="store_false", dest="clobber") + +* ``"append"`` [relevant: :attr:`~Option.type`, :attr:`~Option.dest`, + :attr:`~Option.nargs`, :attr:`~Option.choices`] + + The option must be followed by an argument, which is appended to the list in + :attr:`~Option.dest`. If no default value for :attr:`~Option.dest` is + supplied, an empty list is automatically created when :mod:`optparse` first + encounters this option on the command-line. If :attr:`~Option.nargs` > 1, + multiple arguments are consumed, and a tuple of length :attr:`~Option.nargs` + is appended to :attr:`~Option.dest`. + + The defaults for :attr:`~Option.type` and :attr:`~Option.dest` are the same as + for the ``"store"`` action. + + Example:: + + parser.add_option("-t", "--tracks", action="append", type="int") + + If ``-t3`` is seen on the command-line, :mod:`optparse` does the equivalent + of:: + + options.tracks = [] + options.tracks.append(int("3")) + + If, a little later on, ``--tracks=4`` is seen, it does:: + + options.tracks.append(int("4")) + + The ``append`` action calls the ``append`` method on the current value of the + option. This means that any default value specified must have an ``append`` + method. It also means that if the default value is non-empty, the default + elements will be present in the parsed value for the option, with any values + from the command line appended after those default values:: + + >>> parser.add_option("--files", action="append", default=['~/.mypkg/defaults']) + >>> opts, args = parser.parse_args(['--files', 'overrides.mypkg']) + >>> opts.files + ['~/.mypkg/defaults', 'overrides.mypkg'] + +* ``"append_const"`` [required: :attr:`~Option.const`; relevant: + :attr:`~Option.dest`] + + Like ``"store_const"``, but the value :attr:`~Option.const` is appended to + :attr:`~Option.dest`; as with ``"append"``, :attr:`~Option.dest` defaults to + ``None``, and an empty list is automatically created the first time the option + is encountered. + +* ``"count"`` [relevant: :attr:`~Option.dest`] + + Increment the integer stored at :attr:`~Option.dest`. If no default value is + supplied, :attr:`~Option.dest` is set to zero before being incremented the + first time. + + Example:: + + parser.add_option("-v", action="count", dest="verbosity") + + The first time ``-v`` is seen on the command line, :mod:`optparse` does the + equivalent of:: + + options.verbosity = 0 + options.verbosity += 1 + + Every subsequent occurrence of ``-v`` results in :: + + options.verbosity += 1 + +* ``"callback"`` [required: :attr:`~Option.callback`; relevant: + :attr:`~Option.type`, :attr:`~Option.nargs`, :attr:`~Option.callback_args`, + :attr:`~Option.callback_kwargs`] + + Call the function specified by :attr:`~Option.callback`, which is called as :: + + func(option, opt_str, value, parser, *args, **kwargs) + + See section :ref:`optparse-option-callbacks` for more detail. + +* ``"help"`` + + Prints a complete help message for all the options in the current option + parser. The help message is constructed from the ``usage`` string passed to + OptionParser's constructor and the :attr:`~Option.help` string passed to every + option. + + If no :attr:`~Option.help` string is supplied for an option, it will still be + listed in the help message. To omit an option entirely, use the special value + :data:`optparse.SUPPRESS_HELP`. + + :mod:`optparse` automatically adds a :attr:`~Option.help` option to all + OptionParsers, so you do not normally need to create one. + + Example:: + + from optparse import OptionParser, SUPPRESS_HELP + + # usually, a help option is added automatically, but that can + # be suppressed using the add_help_option argument + parser = OptionParser(add_help_option=False) + + parser.add_option("-h", "--help", action="help") + parser.add_option("-v", action="store_true", dest="verbose", + help="Be moderately verbose") + parser.add_option("--file", dest="filename", + help="Input file to read data from") + parser.add_option("--secret", help=SUPPRESS_HELP) + + If :mod:`optparse` sees either ``-h`` or ``--help`` on the command line, + it will print something like the following help message to stdout (assuming + ``sys.argv[0]`` is ``"foo.py"``): + + .. code-block:: text + + Usage: foo.py [options] + + Options: + -h, --help Show this help message and exit + -v Be moderately verbose + --file=FILENAME Input file to read data from + + After printing the help message, :mod:`optparse` terminates your process with + ``sys.exit(0)``. + +* ``"version"`` + + Prints the version number supplied to the OptionParser to stdout and exits. + The version number is actually formatted and printed by the + ``print_version()`` method of OptionParser. Generally only relevant if the + ``version`` argument is supplied to the OptionParser constructor. As with + :attr:`~Option.help` options, you will rarely create ``version`` options, + since :mod:`optparse` automatically adds them when needed. + + +.. _optparse-standard-option-types: + +Standard option types +^^^^^^^^^^^^^^^^^^^^^ + +:mod:`optparse` has five built-in option types: ``"string"``, ``"int"``, +``"choice"``, ``"float"`` and ``"complex"``. If you need to add new +option types, see section :ref:`optparse-extending-optparse`. + +Arguments to string options are not checked or converted in any way: the text on +the command line is stored in the destination (or passed to the callback) as-is. + +Integer arguments (type ``"int"``) are parsed as follows: + +* if the number starts with ``0x``, it is parsed as a hexadecimal number + +* if the number starts with ``0``, it is parsed as an octal number + +* if the number starts with ``0b``, it is parsed as a binary number + +* otherwise, the number is parsed as a decimal number + + +The conversion is done by calling :func:`int` with the appropriate base (2, 8, +10, or 16). If this fails, so will :mod:`optparse`, although with a more useful +error message. + +``"float"`` and ``"complex"`` option arguments are converted directly with +:func:`float` and :func:`complex`, with similar error-handling. + +``"choice"`` options are a subtype of ``"string"`` options. The +:attr:`~Option.choices` option attribute (a sequence of strings) defines the +set of allowed option arguments. :func:`optparse.check_choice` compares +user-supplied option arguments against this master list and raises +:exc:`OptionValueError` if an invalid string is given. + + +.. _optparse-parsing-arguments: + +Parsing arguments +^^^^^^^^^^^^^^^^^ + +The whole point of creating and populating an OptionParser is to call its +:meth:`parse_args` method:: + + (options, args) = parser.parse_args(args=None, values=None) + +where the input parameters are + +``args`` + the list of arguments to process (default: ``sys.argv[1:]``) + +``values`` + an :class:`optparse.Values` object to store option arguments in (default: a + new instance of :class:`Values`) -- if you give an existing object, the + option defaults will not be initialized on it + +and the return values are + +``options`` + the same object that was passed in as ``values``, or the optparse.Values + instance created by :mod:`optparse` + +``args`` + the leftover positional arguments after all options have been processed + +The most common usage is to supply neither keyword argument. If you supply +``values``, it will be modified with repeated :func:`setattr` calls (roughly one +for every option argument stored to an option destination) and returned by +:meth:`parse_args`. + +If :meth:`parse_args` encounters any errors in the argument list, it calls the +OptionParser's :meth:`error` method with an appropriate end-user error message. +This ultimately terminates your process with an exit status of 2 (the +traditional Unix exit status for command-line errors). + + +.. _optparse-querying-manipulating-option-parser: + +Querying and manipulating your option parser +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The default behavior of the option parser can be customized slightly, and you +can also poke around your option parser and see what's there. OptionParser +provides several methods to help you out: + +.. method:: OptionParser.disable_interspersed_args() + + Set parsing to stop on the first non-option. For example, if ``-a`` and + ``-b`` are both simple options that take no arguments, :mod:`optparse` + normally accepts this syntax:: + + prog -a arg1 -b arg2 + + and treats it as equivalent to :: + + prog -a -b arg1 arg2 + + To disable this feature, call :meth:`disable_interspersed_args`. This + restores traditional Unix syntax, where option parsing stops with the first + non-option argument. + + Use this if you have a command processor which runs another command which has + options of its own and you want to make sure these options don't get + confused. For example, each command might have a different set of options. + +.. method:: OptionParser.enable_interspersed_args() + + Set parsing to not stop on the first non-option, allowing interspersing + switches with command arguments. This is the default behavior. + +.. method:: OptionParser.get_option(opt_str) + + Returns the Option instance with the option string *opt_str*, or ``None`` if + no options have that option string. + +.. method:: OptionParser.has_option(opt_str) + + Return true if the OptionParser has an option with option string *opt_str* + (e.g., ``-q`` or ``--verbose``). + +.. method:: OptionParser.remove_option(opt_str) + + If the :class:`OptionParser` has an option corresponding to *opt_str*, that + option is removed. If that option provided any other option strings, all of + those option strings become invalid. If *opt_str* does not occur in any + option belonging to this :class:`OptionParser`, raises :exc:`ValueError`. + + +.. _optparse-conflicts-between-options: + +Conflicts between options +^^^^^^^^^^^^^^^^^^^^^^^^^ + +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 +some standard options.) + +Every time you add an option, :mod:`optparse` checks for conflicts with existing +options. If it finds any, it invokes the current conflict-handling mechanism. +You can set the conflict-handling mechanism either in the constructor:: + + parser = OptionParser(..., conflict_handler=handler) + +or with a separate call:: + + parser.set_conflict_handler(handler) + +The available conflict handlers are: + + ``"error"`` (default) + assume option conflicts are a programming error and raise + :exc:`OptionConflictError` + + ``"resolve"`` + resolve option conflicts intelligently (see below) + + +As an example, let's define an :class:`OptionParser` that resolves conflicts +intelligently and add conflicting options to it:: + + parser = OptionParser(conflict_handler="resolve") + parser.add_option("-n", "--dry-run", ..., help="do no harm") + parser.add_option("-n", "--noisy", ..., help="be noisy") + +At this point, :mod:`optparse` detects that a previously-added option is already +using the ``-n`` option string. Since ``conflict_handler`` is ``"resolve"``, +it resolves the situation by removing ``-n`` from the earlier option's list of +option strings. Now ``--dry-run`` is the only way for the user to activate +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 +until there are none left, and the user has no way of invoking that option from +the command-line. In that case, :mod:`optparse` removes that option completely, +so it doesn't show up in help text or anywhere else. Carrying on with our +existing OptionParser:: + + parser.add_option("--dry-run", ..., help="new dry-run option") + +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 + + +.. _optparse-cleanup: + +Cleanup +^^^^^^^ + +OptionParser instances have several cyclic references. This should not be a +problem for Python's garbage collector, but you may wish to break the cyclic +references explicitly by calling :meth:`~OptionParser.destroy` on your +OptionParser once you are done with it. This is particularly useful in +long-running applications where large object graphs are reachable from your +OptionParser. + + +.. _optparse-other-methods: + +Other methods +^^^^^^^^^^^^^ + +OptionParser supports several other public methods: + +.. method:: OptionParser.set_usage(usage) + + Set the usage string according to the rules described above for the ``usage`` + constructor keyword argument. Passing ``None`` sets the default usage + string; use :data:`optparse.SUPPRESS_USAGE` to suppress a usage message. + +.. method:: OptionParser.print_usage(file=None) + + Print the usage message for the current program (``self.usage``) to *file* + (default stdout). Any occurrence of the string ``%prog`` in ``self.usage`` + is replaced with the name of the current program. Does nothing if + ``self.usage`` is empty or not defined. + +.. method:: OptionParser.get_usage() + + Same as :meth:`print_usage` but returns the usage string instead of + printing it. + +.. method:: OptionParser.set_defaults(dest=value, ...) + + Set default values for several option destinations at once. Using + :meth:`set_defaults` is the preferred way to set default values for options, + since multiple options can share the same destination. For example, if + several "mode" options all set the same destination, any one of them can set + the default, and the last one wins:: + + parser.add_option("--advanced", action="store_const", + dest="mode", const="advanced", + default="novice") # overridden below + parser.add_option("--novice", action="store_const", + dest="mode", const="novice", + default="advanced") # overrides above setting + + To avoid this confusion, use :meth:`set_defaults`:: + + parser.set_defaults(mode="advanced") + parser.add_option("--advanced", action="store_const", + dest="mode", const="advanced") + parser.add_option("--novice", action="store_const", + dest="mode", const="novice") + + +.. _optparse-option-callbacks: + +Option Callbacks +---------------- + +When :mod:`optparse`'s built-in actions and types aren't quite enough for your +needs, you have two choices: extend :mod:`optparse` or define a callback option. +Extending :mod:`optparse` is more general, but overkill for a lot of simple +cases. Quite often a simple callback is all you need. + +There are two steps to defining a callback option: + +* define the option itself using the ``"callback"`` action + +* write the callback; this is a function (or method) that takes at least four + arguments, as described below + + +.. _optparse-defining-callback-option: + +Defining a callback option +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +As always, the easiest way to define a callback option is by using the +:meth:`OptionParser.add_option` method. Apart from :attr:`~Option.action`, the +only option attribute you must specify is ``callback``, the function to call:: + + parser.add_option("-c", action="callback", callback=my_callback) + +``callback`` is a function (or other callable object), so you must have already +defined ``my_callback()`` when you create this callback option. In this simple +case, :mod:`optparse` doesn't even know if ``-c`` takes any arguments, +which usually means that the option takes no arguments---the mere presence of +``-c`` on the command-line is all it needs to know. In some +circumstances, though, you might want your callback to consume an arbitrary +number of command-line arguments. This is where writing callbacks gets tricky; +it's covered later in this section. + +:mod:`optparse` always passes four particular arguments to your callback, and it +will only pass additional arguments if you specify them via +:attr:`~Option.callback_args` and :attr:`~Option.callback_kwargs`. Thus, the +minimal callback function signature is:: + + def my_callback(option, opt, value, parser): + +The four arguments to a callback are described below. + +There are several other option attributes that you can supply when you define a +callback option: + +:attr:`~Option.type` + has its usual meaning: as with the ``"store"`` or ``"append"`` actions, it + instructs :mod:`optparse` to consume one argument and convert it to + :attr:`~Option.type`. Rather than storing the converted value(s) anywhere, + though, :mod:`optparse` passes it to your callback function. + +:attr:`~Option.nargs` + also has its usual meaning: if it is supplied and > 1, :mod:`optparse` will + consume :attr:`~Option.nargs` arguments, each of which must be convertible to + :attr:`~Option.type`. It then passes a tuple of converted values to your + callback. + +:attr:`~Option.callback_args` + a tuple of extra positional arguments to pass to the callback + +:attr:`~Option.callback_kwargs` + a dictionary of extra keyword arguments to pass to the callback + + +.. _optparse-how-callbacks-called: + +How callbacks are called +^^^^^^^^^^^^^^^^^^^^^^^^ + +All callbacks are called as follows:: + + func(option, opt_str, value, parser, *args, **kwargs) + +where + +``option`` + is the Option instance that's calling the callback + +``opt_str`` + is the option string seen on the command-line that's triggering the callback. + (If an abbreviated long option was used, ``opt_str`` will be the full, + canonical option string---e.g. if the user puts ``--foo`` on the + command-line as an abbreviation for ``--foobar``, then ``opt_str`` will be + ``"--foobar"``.) + +``value`` + is the argument to this option seen on the command-line. :mod:`optparse` will + only expect an argument if :attr:`~Option.type` is set; the type of ``value`` will be + the type implied by the option's type. If :attr:`~Option.type` for this option is + ``None`` (no argument expected), then ``value`` will be ``None``. If :attr:`~Option.nargs` + > 1, ``value`` will be a tuple of values of the appropriate type. + +``parser`` + is the OptionParser instance driving the whole thing, mainly useful because + you can access some other interesting data through its instance attributes: + + ``parser.largs`` + the current list of leftover arguments, ie. arguments that have been + consumed but are neither options nor option arguments. Feel free to modify + ``parser.largs``, e.g. by adding more arguments to it. (This list will + become ``args``, the second return value of :meth:`parse_args`.) + + ``parser.rargs`` + the current list of remaining arguments, ie. with ``opt_str`` and + ``value`` (if applicable) removed, and only the arguments following them + still there. Feel free to modify ``parser.rargs``, e.g. by consuming more + arguments. + + ``parser.values`` + the object where option values are by default stored (an instance of + optparse.OptionValues). This lets callbacks use the same mechanism as the + rest of :mod:`optparse` for storing option values; you don't need to mess + around with globals or closures. You can also access or modify the + value(s) of any options already encountered on the command-line. + +``args`` + is a tuple of arbitrary positional arguments supplied via the + :attr:`~Option.callback_args` option attribute. + +``kwargs`` + is a dictionary of arbitrary keyword arguments supplied via + :attr:`~Option.callback_kwargs`. + + +.. _optparse-raising-errors-in-callback: + +Raising errors in a callback +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The callback function should raise :exc:`OptionValueError` if there are any +problems with the option or its argument(s). :mod:`optparse` catches this and +terminates the program, printing the error message you supply to stderr. Your +message should be clear, concise, accurate, and mention the option at fault. +Otherwise, the user will have a hard time figuring out what they did wrong. + + +.. _optparse-callback-example-1: + +Callback example 1: trivial callback +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Here's an example of a callback option that takes no arguments, and simply +records that the option was seen:: + + def record_foo_seen(option, opt_str, value, parser): + parser.values.saw_foo = True + + parser.add_option("--foo", action="callback", callback=record_foo_seen) + +Of course, you could do that with the ``"store_true"`` action. + + +.. _optparse-callback-example-2: + +Callback example 2: check option order +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Here's a slightly more interesting example: record the fact that ``-a`` is +seen, but blow up if it comes after ``-b`` in the command-line. :: + + def check_order(option, opt_str, value, parser): + 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") + + +.. _optparse-callback-example-3: + +Callback example 3: check option order (generalized) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you want to re-use this callback for several similar options (set a flag, but +blow up if ``-b`` has already been seen), it needs a bit of work: the error +message and the flag that it sets must be generalized. :: + + def check_order(option, opt_str, value, parser): + 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') + + +.. _optparse-callback-example-4: + +Callback example 4: check arbitrary condition +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Of course, you could put any condition in there---you're not limited to checking +the values of already-defined options. For example, if you have options that +should not be called when the moon is full, all you have to do is this:: + + def check_moon(option, opt_str, value, parser): + if is_moon_full(): + 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") + +(The definition of ``is_moon_full()`` is left as an exercise for the reader.) + + +.. _optparse-callback-example-5: + +Callback example 5: fixed arguments +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Things get slightly more interesting when you define callback options that take +a fixed number of arguments. Specifying that a callback option takes arguments +is similar to defining a ``"store"`` or ``"append"`` option: if you define +:attr:`~Option.type`, then the option takes one argument that must be +convertible to that type; if you further define :attr:`~Option.nargs`, then the +option takes :attr:`~Option.nargs` arguments. + +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") + +Note that :mod:`optparse` takes care of consuming 3 arguments and converting +them to integers for you; all you have to do is store them. (Or whatever; +obviously you don't need a callback for this example.) + + +.. _optparse-callback-example-6: + +Callback example 6: variable arguments +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Things get hairy when you want an option to take a variable number of arguments. +For this case, you must write a callback, as :mod:`optparse` doesn't provide any +built-in capabilities for it. And you have to deal with certain intricacies of +conventional Unix command-line parsing that :mod:`optparse` normally handles for +you. In particular, callbacks should implement the conventional rules for bare +``--`` and ``-`` arguments: + +* either ``--`` or ``-`` can be option arguments + +* bare ``--`` (if not the argument to some option): halt command-line + processing and discard the ``--`` + +* bare ``-`` (if not the argument to some option): halt command-line + processing but keep the ``-`` (append it to ``parser.largs``) + +If you want an option that takes a variable number of arguments, there are +several subtle, tricky issues to worry about. The exact implementation you +choose will be based on which trade-offs you're willing to make for your +application (which is why :mod:`optparse` doesn't support this sort of thing +directly). + +Nevertheless, here's a stab at a callback for an option with variable +arguments:: + + def vararg_callback(option, opt_str, value, parser): + assert value is None + value = [] + + def floatable(str): + try: + float(str) + return True + except ValueError: + return False + + for arg in parser.rargs: + # stop on --foo like options + if arg[:2] == "--" and len(arg) > 2: + break + # stop on -a, but not on -3 or -3.0 + if arg[:1] == "-" and len(arg) > 1 and not floatable(arg): + break + value.append(arg) + + del parser.rargs[:len(value)] + setattr(parser.values, option.dest, value) + + ... + parser.add_option("-c", "--callback", dest="vararg_attr", + action="callback", callback=vararg_callback) + + +.. _optparse-extending-optparse: + +Extending :mod:`optparse` +------------------------- + +Since the two major controlling factors in how :mod:`optparse` interprets +command-line options are the action and type of each option, the most likely +direction of extension is to add new actions and new types. + + +.. _optparse-adding-new-types: + +Adding new types +^^^^^^^^^^^^^^^^ + +To add new types, you need to define your own subclass of :mod:`optparse`'s +:class:`Option` class. This class has a couple of attributes that define +:mod:`optparse`'s types: :attr:`~Option.TYPES` and :attr:`~Option.TYPE_CHECKER`. + +.. attribute:: Option.TYPES + + A tuple of type names; in your subclass, simply define a new tuple + :attr:`TYPES` that builds on the standard one. + +.. attribute:: Option.TYPE_CHECKER + + A dictionary mapping type names to type-checking functions. A type-checking + function has the following signature:: + + def check_mytype(option, opt, value) + + where ``option`` is an :class:`Option` instance, ``opt`` is an option string + (e.g., ``-f``), and ``value`` is the string from the command line that must + be checked and converted to your desired type. ``check_mytype()`` should + return an object of the hypothetical type ``mytype``. The value returned by + a type-checking function will wind up in the OptionValues instance returned + by :meth:`OptionParser.parse_args`, or be passed to a callback as the + ``value`` parameter. + + Your type-checking function should raise :exc:`OptionValueError` if it + encounters any problems. :exc:`OptionValueError` takes a single string + argument, which is passed as-is to :class:`OptionParser`'s :meth:`error` + method, which in turn prepends the program name and the string ``"error:"`` + and prints everything to stderr before terminating the process. + +Here's a silly example that demonstrates adding a ``"complex"`` option type to +parse Python-style complex numbers on the command line. (This is even sillier +than it used to be, because :mod:`optparse` 1.3 added built-in support for +complex numbers, but never mind.) + +First, the necessary imports:: + + from copy import copy + from optparse import Option, OptionValueError + +You need to define your type-checker first, since it's referred to later (in the +:attr:`~Option.TYPE_CHECKER` class attribute of your Option subclass):: + + def check_complex(option, opt, value): + try: + return complex(value) + except ValueError: + raise OptionValueError( + "option %s: invalid complex value: %r" % (opt, value)) + +Finally, the Option subclass:: + + class MyOption (Option): + TYPES = Option.TYPES + ("complex",) + TYPE_CHECKER = copy(Option.TYPE_CHECKER) + TYPE_CHECKER["complex"] = check_complex + +(If we didn't make a :func:`copy` of :attr:`Option.TYPE_CHECKER`, we would end +up modifying the :attr:`~Option.TYPE_CHECKER` attribute of :mod:`optparse`'s +Option class. This being Python, nothing stops you from doing that except good +manners and common sense.) + +That's it! Now you can write a script that uses the new option type just like +any other :mod:`optparse`\ -based script, except you have to instruct your +OptionParser to use MyOption instead of Option:: + + parser = OptionParser(option_class=MyOption) + parser.add_option("-c", type="complex") + +Alternately, you can build your own option list and pass it to OptionParser; if +you don't use :meth:`add_option` in the above way, you don't need to tell +OptionParser which option class to use:: + + option_list = [MyOption("-c", action="store", type="complex", dest="c")] + parser = OptionParser(option_list=option_list) + + +.. _optparse-adding-new-actions: + +Adding new actions +^^^^^^^^^^^^^^^^^^ + +Adding new actions is a bit trickier, because you have to understand that +:mod:`optparse` has a couple of classifications for actions: + +"store" actions + actions that result in :mod:`optparse` storing a value to an attribute of the + current OptionValues instance; these options require a :attr:`~Option.dest` + attribute to be supplied to the Option constructor. + +"typed" actions + actions that take a value from the command line and expect it to be of a + certain type; or rather, a string that can be converted to a certain type. + These options require a :attr:`~Option.type` attribute to the Option + constructor. + +These are overlapping sets: some default "store" actions are ``"store"``, +``"store_const"``, ``"append"``, and ``"count"``, while the default "typed" +actions are ``"store"``, ``"append"``, and ``"callback"``. + +When you add an action, you need to categorize it by listing it in at least one +of the following class attributes of Option (all are lists of strings): + +.. attribute:: Option.ACTIONS + + All actions must be listed in ACTIONS. + +.. attribute:: Option.STORE_ACTIONS + + "store" actions are additionally listed here. + +.. attribute:: Option.TYPED_ACTIONS + + "typed" actions are additionally listed here. + +.. attribute:: Option.ALWAYS_TYPED_ACTIONS + + Actions that always take a type (i.e. whose options always take a value) are + additionally listed here. The only effect of this is that :mod:`optparse` + assigns the default type, ``"string"``, to options with no explicit type + whose action is listed in :attr:`ALWAYS_TYPED_ACTIONS`. + +In order to actually implement your new action, you must override Option's +:meth:`take_action` method and add a case that recognizes your action. + +For example, let's add an ``"extend"`` action. This is similar to the standard +``"append"`` action, but instead of taking a single value from the command-line +and appending it to an existing list, ``"extend"`` will take multiple values in +a single comma-delimited string, and extend an existing list with them. That +is, if ``--names`` is an ``"extend"`` option of type ``"string"``, the command +line :: + + --names=foo,bar --names blah --names ding,dong + +would result in a list :: + + ["foo", "bar", "blah", "ding", "dong"] + +Again we define a subclass of Option:: + + class MyOption(Option): + + ACTIONS = Option.ACTIONS + ("extend",) + STORE_ACTIONS = Option.STORE_ACTIONS + ("extend",) + TYPED_ACTIONS = Option.TYPED_ACTIONS + ("extend",) + ALWAYS_TYPED_ACTIONS = Option.ALWAYS_TYPED_ACTIONS + ("extend",) + + def take_action(self, action, dest, opt, value, values, parser): + if action == "extend": + lvalue = value.split(",") + values.ensure_value(dest, []).extend(lvalue) + else: + Option.take_action( + self, action, dest, opt, value, values, parser) + +Features of note: + +* ``"extend"`` both expects a value on the command-line and stores that value + somewhere, so it goes in both :attr:`~Option.STORE_ACTIONS` and + :attr:`~Option.TYPED_ACTIONS`. + +* to ensure that :mod:`optparse` assigns the default type of ``"string"`` to + ``"extend"`` actions, we put the ``"extend"`` action in + :attr:`~Option.ALWAYS_TYPED_ACTIONS` as well. + +* :meth:`MyOption.take_action` implements just this one new action, and passes + control back to :meth:`Option.take_action` for the standard :mod:`optparse` + actions. + +* ``values`` is an instance of the optparse_parser.Values class, which provides + the very useful :meth:`ensure_value` method. :meth:`ensure_value` is + essentially :func:`getattr` with a safety valve; it is called as :: + + values.ensure_value(attr, value) + + If the ``attr`` attribute of ``values`` doesn't exist or is ``None``, then + ensure_value() first sets it to ``value``, and then returns 'value. This is + very handy for actions like ``"extend"``, ``"append"``, and ``"count"``, all + of which accumulate data in a variable and expect that variable to be of a + certain type (a list for the first two, an integer for the latter). Using + :meth:`ensure_value` means that scripts using your action don't have to worry + about setting a default value for the option destinations in question; they + can just leave the default as ``None`` and :meth:`ensure_value` will take care of + getting it right when it's needed. diff --git a/python-3.7.4-docs-html/_sources/library/os.path.rst.txt b/python-3.7.4-docs-html/_sources/library/os.path.rst.txt new file mode 100644 index 0000000..ef0e35d --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/os.path.rst.txt @@ -0,0 +1,462 @@ +:mod:`os.path` --- Common pathname manipulations +================================================ + +.. module:: os.path + :synopsis: Operations on pathnames. + +**Source code:** :source:`Lib/posixpath.py` (for POSIX), +:source:`Lib/ntpath.py` (for Windows NT), +and :source:`Lib/macpath.py` (for Macintosh) + +.. index:: single: path; operations + +-------------- + +This module implements some useful functions on pathnames. To read or +write files see :func:`open`, and for accessing the filesystem see the +:mod:`os` module. The path parameters can be passed as either strings, +or bytes. Applications are encouraged to represent file names as +(Unicode) character strings. Unfortunately, some file names may not be +representable as strings on Unix, so applications that need to support +arbitrary file names on Unix should use bytes objects to represent +path names. Vice versa, using bytes objects cannot represent all file +names on Windows (in the standard ``mbcs`` encoding), hence Windows +applications should use string objects to access all files. + +Unlike a unix shell, Python does not do any *automatic* path expansions. +Functions such as :func:`expanduser` and :func:`expandvars` can be invoked +explicitly when an application desires shell-like path expansion. (See also +the :mod:`glob` module.) + + +.. seealso:: + The :mod:`pathlib` module offers high-level path objects. + + +.. note:: + + All of these functions accept either only bytes or only string objects as + their parameters. The result is an object of the same type, if a path or + file name is returned. + + +.. note:: + + Since different operating systems have different path name conventions, there + are several versions of this module in the standard library. The + :mod:`os.path` module is always the path module suitable for the operating + system Python is running on, and therefore usable for local paths. However, + you can also import and use the individual modules if you want to manipulate + a path that is *always* in one of the different formats. They all have the + same interface: + + * :mod:`posixpath` for UNIX-style paths + * :mod:`ntpath` for Windows paths + * :mod:`macpath` for old-style MacOS paths + + +.. function:: abspath(path) + + Return a normalized absolutized version of the pathname *path*. On most + platforms, this is equivalent to calling the function :func:`normpath` as + follows: ``normpath(join(os.getcwd(), path))``. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: basename(path) + + Return the base name of pathname *path*. This is the second element of the + pair returned by passing *path* to the function :func:`split`. Note that + the result of this function is different + from the Unix :program:`basename` program; where :program:`basename` for + ``'/foo/bar/'`` returns ``'bar'``, the :func:`basename` function returns an + empty string (``''``). + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: commonpath(paths) + + Return the longest common sub-path of each pathname in the sequence + *paths*. Raise :exc:`ValueError` if *paths* contains both absolute and relative + pathnames, or if *paths* is empty. Unlike :func:`commonprefix`, this + returns a valid path. + + .. availability:: Unix, Windows. + + .. versionadded:: 3.5 + + .. versionchanged:: 3.6 + Accepts a sequence of :term:`path-like objects `. + + +.. function:: commonprefix(list) + + Return the longest path prefix (taken character-by-character) that is a + prefix of all paths in *list*. If *list* is empty, return the empty string + (``''``). + + .. note:: + + This function may return invalid paths because it works a + character at a time. To obtain a valid path, see + :func:`commonpath`. + + :: + + >>> os.path.commonprefix(['/usr/lib', '/usr/local/lib']) + '/usr/l' + + >>> os.path.commonpath(['/usr/lib', '/usr/local/lib']) + '/usr' + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: dirname(path) + + Return the directory name of pathname *path*. This is the first element of + the pair returned by passing *path* to the function :func:`split`. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: exists(path) + + Return ``True`` if *path* refers to an existing path or an open + file descriptor. Returns ``False`` for broken symbolic links. On + some platforms, this function may return ``False`` if permission is + not granted to execute :func:`os.stat` on the requested file, even + if the *path* physically exists. + + .. versionchanged:: 3.3 + *path* can now be an integer: ``True`` is returned if it is an + open file descriptor, ``False`` otherwise. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: lexists(path) + + Return ``True`` if *path* refers to an existing path. Returns ``True`` for + broken symbolic links. Equivalent to :func:`exists` on platforms lacking + :func:`os.lstat`. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. index:: single: ~ (tilde); home directory expansion + +.. function:: expanduser(path) + + On Unix and Windows, return the argument with an initial component of ``~`` or + ``~user`` replaced by that *user*'s home directory. + + .. index:: module: pwd + + On Unix, an initial ``~`` is replaced by the environment variable :envvar:`HOME` + if it is set; otherwise the current user's home directory is looked up in the + password directory through the built-in module :mod:`pwd`. An initial ``~user`` + is looked up directly in the password directory. + + On Windows, :envvar:`HOME` and :envvar:`USERPROFILE` will be used if set, + otherwise a combination of :envvar:`HOMEPATH` and :envvar:`HOMEDRIVE` will be + used. An initial ``~user`` is handled by stripping the last directory component + from the created user path derived above. + + If the expansion fails or if the path does not begin with a tilde, the path is + returned unchanged. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + +.. index:: + single: $ (dollar); environment variables expansion + single: % (percent); environment variables expansion (Windows) + +.. function:: expandvars(path) + + Return the argument with environment variables expanded. Substrings of the form + ``$name`` or ``${name}`` are replaced by the value of environment variable + *name*. Malformed variable names and references to non-existing variables are + left unchanged. + + On Windows, ``%name%`` expansions are supported in addition to ``$name`` and + ``${name}``. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: getatime(path) + + Return the time of last access of *path*. The return value is a floating point number giving + the number of seconds since the epoch (see the :mod:`time` module). Raise + :exc:`OSError` if the file does not exist or is inaccessible. + + +.. function:: getmtime(path) + + Return the time of last modification of *path*. The return value is a floating point number + giving the number of seconds since the epoch (see the :mod:`time` module). + Raise :exc:`OSError` if the file does not exist or is inaccessible. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: getctime(path) + + Return the system's ctime which, on some systems (like Unix) is the time of the + last metadata change, and, on others (like Windows), is the creation time for *path*. + The return value is a number giving the number of seconds since the epoch (see + the :mod:`time` module). Raise :exc:`OSError` if the file does not exist or + is inaccessible. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: getsize(path) + + Return the size, in bytes, of *path*. Raise :exc:`OSError` if the file does + not exist or is inaccessible. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: isabs(path) + + Return ``True`` if *path* is an absolute pathname. On Unix, that means it + begins with a slash, on Windows that it begins with a (back)slash after chopping + off a potential drive letter. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: isfile(path) + + Return ``True`` if *path* is an :func:`existing ` regular file. + This follows symbolic links, so both :func:`islink` and :func:`isfile` can + be true for the same path. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: isdir(path) + + Return ``True`` if *path* is an :func:`existing ` directory. This + follows symbolic links, so both :func:`islink` and :func:`isdir` can be true + for the same path. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: islink(path) + + Return ``True`` if *path* refers to an :func:`existing ` directory + entry that is a symbolic link. Always ``False`` if symbolic links are not + supported by the Python runtime. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: ismount(path) + + Return ``True`` if pathname *path* is a :dfn:`mount point`: a point in a + file system where a different file system has been mounted. On POSIX, the + function checks whether *path*'s parent, :file:`{path}/..`, is on a different + device than *path*, or whether :file:`{path}/..` and *path* point to the same + i-node on the same device --- this should detect mount points for all Unix + and POSIX variants. It is not able to reliably detect bind mounts on the + same filesystem. On Windows, a drive letter root and a share UNC are + always mount points, and for any other path ``GetVolumePathName`` is called + to see if it is different from the input path. + + .. versionadded:: 3.4 + Support for detecting non-root mount points on Windows. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: join(path, *paths) + + Join one or more path components intelligently. The return value is the + concatenation of *path* and any members of *\*paths* with exactly one + directory separator (``os.sep``) following each non-empty part except the + last, meaning that the result will only end in a separator if the last + part is empty. If a component is an absolute path, all previous + components are thrown away and joining continues from the absolute path + component. + + On Windows, the drive letter is not reset when an absolute path component + (e.g., ``r'\foo'``) is encountered. If a component contains a drive + letter, all previous components are thrown away and the drive letter is + reset. Note that since there is a current directory for each drive, + ``os.path.join("c:", "foo")`` represents a path relative to the current + directory on drive :file:`C:` (:file:`c:foo`), not :file:`c:\\foo`. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object` for *path* and *paths*. + + +.. function:: normcase(path) + + Normalize the case of a pathname. On Windows, convert all characters in the + pathname to lowercase, and also convert forward slashes to backward slashes. + On other operating systems, return the path unchanged. + Raise a :exc:`TypeError` if the type of *path* is not ``str`` or ``bytes`` (directly + or indirectly through the :class:`os.PathLike` interface). + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: normpath(path) + + Normalize a pathname by collapsing redundant separators and up-level + references so that ``A//B``, ``A/B/``, ``A/./B`` and ``A/foo/../B`` all + become ``A/B``. This string manipulation may change the meaning of a path + that contains symbolic links. On Windows, it converts forward slashes to + backward slashes. To normalize case, use :func:`normcase`. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: realpath(path) + + Return the canonical path of the specified filename, eliminating any symbolic + links encountered in the path (if they are supported by the operating system). + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: relpath(path, start=os.curdir) + + Return a relative filepath to *path* either from the current directory or + from an optional *start* directory. This is a path computation: the + filesystem is not accessed to confirm the existence or nature of *path* or + *start*. + + *start* defaults to :attr:`os.curdir`. + + .. availability:: Unix, Windows. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: samefile(path1, path2) + + Return ``True`` if both pathname arguments refer to the same file or directory. + This is determined by the device number and i-node number and raises an + exception if an :func:`os.stat` call on either pathname fails. + + .. availability:: Unix, Windows. + + .. versionchanged:: 3.2 + Added Windows support. + + .. versionchanged:: 3.4 + Windows now uses the same implementation as all other platforms. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: sameopenfile(fp1, fp2) + + Return ``True`` if the file descriptors *fp1* and *fp2* refer to the same file. + + .. availability:: Unix, Windows. + + .. versionchanged:: 3.2 + Added Windows support. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: samestat(stat1, stat2) + + Return ``True`` if the stat tuples *stat1* and *stat2* refer to the same file. + These structures may have been returned by :func:`os.fstat`, + :func:`os.lstat`, or :func:`os.stat`. This function implements the + underlying comparison used by :func:`samefile` and :func:`sameopenfile`. + + .. availability:: Unix, Windows. + + .. versionchanged:: 3.4 + Added Windows support. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: split(path) + + Split the pathname *path* into a pair, ``(head, tail)`` where *tail* is the + last pathname component and *head* is everything leading up to that. The + *tail* part will never contain a slash; if *path* ends in a slash, *tail* + will be empty. If there is no slash in *path*, *head* will be empty. If + *path* is empty, both *head* and *tail* are empty. Trailing slashes are + stripped from *head* unless it is the root (one or more slashes only). In + all cases, ``join(head, tail)`` returns a path to the same location as *path* + (but the strings may differ). Also see the functions :func:`dirname` and + :func:`basename`. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: splitdrive(path) + + Split the pathname *path* into a pair ``(drive, tail)`` where *drive* is either + a mount point or the empty string. On systems which do not use drive + specifications, *drive* will always be the empty string. In all cases, ``drive + + tail`` will be the same as *path*. + + On Windows, splits a pathname into drive/UNC sharepoint and relative path. + + If the path contains a drive letter, drive will contain everything + up to and including the colon. + e.g. ``splitdrive("c:/dir")`` returns ``("c:", "/dir")`` + + If the path contains a UNC path, drive will contain the host name + and share, up to but not including the fourth separator. + e.g. ``splitdrive("//host/computer/dir")`` returns ``("//host/computer", "/dir")`` + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: splitext(path) + + Split the pathname *path* into a pair ``(root, ext)`` such that ``root + ext == + path``, and *ext* is empty or begins with a period and contains at most one + period. Leading periods on the basename are ignored; ``splitext('.cshrc')`` + returns ``('.cshrc', '')``. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. data:: supports_unicode_filenames + + ``True`` if arbitrary Unicode strings can be used as file names (within limitations + imposed by the file system). diff --git a/python-3.7.4-docs-html/_sources/library/os.rst.txt b/python-3.7.4-docs-html/_sources/library/os.rst.txt new file mode 100644 index 0000000..5572b62 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/os.rst.txt @@ -0,0 +1,4197 @@ +:mod:`os` --- Miscellaneous operating system interfaces +======================================================= + +.. module:: os + :synopsis: Miscellaneous operating system interfaces. + +**Source code:** :source:`Lib/os.py` + +-------------- + +This module provides a portable way of using operating system dependent +functionality. If you just want to read or write a file see :func:`open`, if +you want to manipulate paths, see the :mod:`os.path` module, and if you want to +read all the lines in all the files on the command line see the :mod:`fileinput` +module. For creating temporary files and directories see the :mod:`tempfile` +module, and for high-level file and directory handling see the :mod:`shutil` +module. + +Notes on the availability of these functions: + +* The design of all built-in operating system dependent modules of Python is + such that as long as the same functionality is available, it uses the same + interface; for example, the function ``os.stat(path)`` returns stat + information about *path* in the same format (which happens to have originated + with the POSIX interface). + +* Extensions peculiar to a particular operating system are also available + through the :mod:`os` module, but using them is of course a threat to + portability. + +* All functions accepting path or file names accept both bytes and string + objects, and result in an object of the same type, if a path or file name is + returned. + + +.. note:: + + All functions in this module raise :exc:`OSError` (or subclasses thereof) in + the case of invalid or inaccessible file names and paths, or other arguments + that have the correct type, but are not accepted by the operating system. + +.. exception:: error + + An alias for the built-in :exc:`OSError` exception. + + +.. data:: name + + The name of the operating system dependent module imported. The following + names have currently been registered: ``'posix'``, ``'nt'``, + ``'java'``. + + .. seealso:: + :attr:`sys.platform` has a finer granularity. :func:`os.uname` gives + system-dependent version information. + + The :mod:`platform` module provides detailed checks for the + system's identity. + + +.. _os-filenames: +.. _filesystem-encoding: + +File Names, Command Line Arguments, and Environment Variables +------------------------------------------------------------- + +In Python, file names, command line arguments, and environment variables are +represented using the string type. On some systems, decoding these strings to +and from bytes is necessary before passing them to the operating system. Python +uses the file system encoding to perform this conversion (see +:func:`sys.getfilesystemencoding`). + +.. versionchanged:: 3.1 + On some systems, conversion using the file system encoding may fail. In this + case, Python uses the :ref:`surrogateescape encoding error handler + `, which means that undecodable bytes are replaced by a + Unicode character U+DCxx on decoding, and these are again translated to the + original byte on encoding. + + +The file system encoding must guarantee to successfully decode all bytes +below 128. If the file system encoding fails to provide this guarantee, API +functions may raise UnicodeErrors. + + +.. _os-procinfo: + +Process Parameters +------------------ + +These functions and data items provide information and operate on the current +process and user. + + +.. function:: ctermid() + + Return the filename corresponding to the controlling terminal of the process. + + .. availability:: Unix. + + +.. data:: environ + + A :term:`mapping` object representing the string environment. For example, + ``environ['HOME']`` is the pathname of your home directory (on some platforms), + and is equivalent to ``getenv("HOME")`` in C. + + This mapping is captured the first time the :mod:`os` module is imported, + typically during Python startup as part of processing :file:`site.py`. Changes + to the environment made after this time are not reflected in ``os.environ``, + except for changes made by modifying ``os.environ`` directly. + + If the platform supports the :func:`putenv` function, this mapping may be used + to modify the environment as well as query the environment. :func:`putenv` will + be called automatically when the mapping is modified. + + On Unix, keys and values use :func:`sys.getfilesystemencoding` and + ``'surrogateescape'`` error handler. Use :data:`environb` if you would like + to use a different encoding. + + .. note:: + + Calling :func:`putenv` directly does not change ``os.environ``, so it's better + to modify ``os.environ``. + + .. note:: + + On some platforms, including FreeBSD and Mac OS X, setting ``environ`` may + cause memory leaks. Refer to the system documentation for + :c:func:`putenv`. + + If :func:`putenv` is not provided, a modified copy of this mapping may be + passed to the appropriate process-creation functions to cause child processes + to use a modified environment. + + If the platform supports the :func:`unsetenv` function, you can delete items in + this mapping to unset environment variables. :func:`unsetenv` will be called + automatically when an item is deleted from ``os.environ``, and when + one of the :meth:`pop` or :meth:`clear` methods is called. + + +.. data:: environb + + Bytes version of :data:`environ`: a :term:`mapping` object representing the + environment as byte strings. :data:`environ` and :data:`environb` are + synchronized (modify :data:`environb` updates :data:`environ`, and vice + versa). + + :data:`environb` is only available if :data:`supports_bytes_environ` is + True. + + .. versionadded:: 3.2 + + +.. function:: chdir(path) + fchdir(fd) + getcwd() + :noindex: + + These functions are described in :ref:`os-file-dir`. + + +.. function:: fsencode(filename) + + Encode :term:`path-like ` *filename* to the filesystem + encoding with ``'surrogateescape'`` error handler, or ``'strict'`` on + Windows; return :class:`bytes` unchanged. + + :func:`fsdecode` is the reverse function. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.6 + Support added to accept objects implementing the :class:`os.PathLike` + interface. + + +.. function:: fsdecode(filename) + + Decode the :term:`path-like ` *filename* from the + filesystem encoding with ``'surrogateescape'`` error handler, or ``'strict'`` + on Windows; return :class:`str` unchanged. + + :func:`fsencode` is the reverse function. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.6 + Support added to accept objects implementing the :class:`os.PathLike` + interface. + + +.. function:: fspath(path) + + Return the file system representation of the path. + + If :class:`str` or :class:`bytes` is passed in, it is returned unchanged. + Otherwise :meth:`~os.PathLike.__fspath__` is called and its value is + returned as long as it is a :class:`str` or :class:`bytes` object. + In all other cases, :exc:`TypeError` is raised. + + .. versionadded:: 3.6 + + +.. class:: PathLike + + An :term:`abstract base class` for objects representing a file system path, + e.g. :class:`pathlib.PurePath`. + + .. versionadded:: 3.6 + + .. abstractmethod:: __fspath__() + + Return the file system path representation of the object. + + The method should only return a :class:`str` or :class:`bytes` object, + with the preference being for :class:`str`. + + +.. function:: getenv(key, default=None) + + Return the value of the environment variable *key* if it exists, or + *default* if it doesn't. *key*, *default* and the result are str. + + On Unix, keys and values are decoded with :func:`sys.getfilesystemencoding` + and ``'surrogateescape'`` error handler. Use :func:`os.getenvb` if you + would like to use a different encoding. + + .. availability:: most flavors of Unix, Windows. + + +.. function:: getenvb(key, default=None) + + Return the value of the environment variable *key* if it exists, or + *default* if it doesn't. *key*, *default* and the result are bytes. + + :func:`getenvb` is only available if :data:`supports_bytes_environ` + is True. + + .. availability:: most flavors of Unix. + + .. versionadded:: 3.2 + + +.. function:: get_exec_path(env=None) + + Returns the list of directories that will be searched for a named + executable, similar to a shell, when launching a process. + *env*, when specified, should be an environment variable dictionary + to lookup the PATH in. + By default, when *env* is ``None``, :data:`environ` is used. + + .. versionadded:: 3.2 + + +.. function:: getegid() + + Return the effective group id of the current process. This corresponds to the + "set id" bit on the file being executed in the current process. + + .. availability:: Unix. + + +.. function:: geteuid() + + .. index:: single: user; effective id + + Return the current process's effective user id. + + .. availability:: Unix. + + +.. function:: getgid() + + .. index:: single: process; group + + Return the real group id of the current process. + + .. availability:: Unix. + + +.. function:: getgrouplist(user, group) + + Return list of group ids that *user* belongs to. If *group* is not in the + list, it is included; typically, *group* is specified as the group ID + field from the password record for *user*. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. function:: getgroups() + + Return list of supplemental group ids associated with the current process. + + .. availability:: Unix. + + .. note:: + + On Mac OS X, :func:`getgroups` behavior differs somewhat from + other Unix platforms. If the Python interpreter was built with a + deployment target of :const:`10.5` or earlier, :func:`getgroups` returns + the list of effective group ids associated with the current user process; + this list is limited to a system-defined number of entries, typically 16, + and may be modified by calls to :func:`setgroups` if suitably privileged. + If built with a deployment target greater than :const:`10.5`, + :func:`getgroups` returns the current group access list for the user + associated with the effective user id of the process; the group access + list may change over the lifetime of the process, it is not affected by + calls to :func:`setgroups`, and its length is not limited to 16. The + deployment target value, :const:`MACOSX_DEPLOYMENT_TARGET`, can be + obtained with :func:`sysconfig.get_config_var`. + + +.. function:: getlogin() + + Return the name of the user logged in on the controlling terminal of the + process. For most purposes, it is more useful to use + :func:`getpass.getuser` since the latter checks the environment variables + :envvar:`LOGNAME` or :envvar:`USERNAME` to find out who the user is, and + falls back to ``pwd.getpwuid(os.getuid())[0]`` to get the login name of the + current real user id. + + .. availability:: Unix, Windows. + + +.. function:: getpgid(pid) + + Return the process group id of the process with process id *pid*. If *pid* is 0, + the process group id of the current process is returned. + + .. availability:: Unix. + +.. function:: getpgrp() + + .. index:: single: process; group + + Return the id of the current process group. + + .. availability:: Unix. + + +.. function:: getpid() + + .. index:: single: process; id + + Return the current process id. + + +.. function:: getppid() + + .. index:: single: process; id of parent + + Return the parent's process id. When the parent process has exited, on Unix + the id returned is the one of the init process (1), on Windows it is still + the same id, which may be already reused by another process. + + .. availability:: Unix, Windows. + + .. versionchanged:: 3.2 + Added support for Windows. + + +.. function:: getpriority(which, who) + + .. index:: single: process; scheduling priority + + Get program scheduling priority. The value *which* is one of + :const:`PRIO_PROCESS`, :const:`PRIO_PGRP`, or :const:`PRIO_USER`, and *who* + is interpreted relative to *which* (a process identifier for + :const:`PRIO_PROCESS`, process group identifier for :const:`PRIO_PGRP`, and a + user ID for :const:`PRIO_USER`). A zero value for *who* denotes + (respectively) the calling process, the process group of the calling process, + or the real user ID of the calling process. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. data:: PRIO_PROCESS + PRIO_PGRP + PRIO_USER + + Parameters for the :func:`getpriority` and :func:`setpriority` functions. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. function:: getresuid() + + Return a tuple (ruid, euid, suid) denoting the current process's + real, effective, and saved user ids. + + .. availability:: Unix. + + .. versionadded:: 3.2 + + +.. function:: getresgid() + + Return a tuple (rgid, egid, sgid) denoting the current process's + real, effective, and saved group ids. + + .. availability:: Unix. + + .. versionadded:: 3.2 + + +.. function:: getuid() + + .. index:: single: user; id + + Return the current process's real user id. + + .. availability:: Unix. + + +.. function:: initgroups(username, gid) + + Call the system initgroups() to initialize the group access list with all of + the groups of which the specified username is a member, plus the specified + group id. + + .. availability:: Unix. + + .. versionadded:: 3.2 + + +.. function:: putenv(key, value) + + .. index:: single: environment variables; setting + + Set the environment variable named *key* to the string *value*. Such + changes to the environment affect subprocesses started with :func:`os.system`, + :func:`popen` or :func:`fork` and :func:`execv`. + + .. availability:: most flavors of Unix, Windows. + + .. note:: + + On some platforms, including FreeBSD and Mac OS X, setting ``environ`` may + cause memory leaks. Refer to the system documentation for putenv. + + When :func:`putenv` is supported, assignments to items in ``os.environ`` are + automatically translated into corresponding calls to :func:`putenv`; however, + calls to :func:`putenv` don't update ``os.environ``, so it is actually + preferable to assign to items of ``os.environ``. + + +.. function:: setegid(egid) + + Set the current process's effective group id. + + .. availability:: Unix. + + +.. function:: seteuid(euid) + + Set the current process's effective user id. + + .. availability:: Unix. + + +.. function:: setgid(gid) + + Set the current process' group id. + + .. availability:: Unix. + + +.. function:: setgroups(groups) + + Set the list of supplemental group ids associated with the current process to + *groups*. *groups* must be a sequence, and each element must be an integer + identifying a group. This operation is typically available only to the superuser. + + .. availability:: Unix. + + .. note:: On Mac OS X, the length of *groups* may not exceed the + system-defined maximum number of effective group ids, typically 16. + See the documentation for :func:`getgroups` for cases where it may not + return the same group list set by calling setgroups(). + +.. function:: setpgrp() + + Call the system call :c:func:`setpgrp` or ``setpgrp(0, 0)`` depending on + which version is implemented (if any). See the Unix manual for the semantics. + + .. availability:: Unix. + + +.. function:: setpgid(pid, pgrp) + + Call the system call :c:func:`setpgid` to set the process group id of the + process with id *pid* to the process group with id *pgrp*. See the Unix manual + for the semantics. + + .. availability:: Unix. + + +.. function:: setpriority(which, who, priority) + + .. index:: single: process; scheduling priority + + Set program scheduling priority. The value *which* is one of + :const:`PRIO_PROCESS`, :const:`PRIO_PGRP`, or :const:`PRIO_USER`, and *who* + is interpreted relative to *which* (a process identifier for + :const:`PRIO_PROCESS`, process group identifier for :const:`PRIO_PGRP`, and a + user ID for :const:`PRIO_USER`). A zero value for *who* denotes + (respectively) the calling process, the process group of the calling process, + or the real user ID of the calling process. + *priority* is a value in the range -20 to 19. The default priority is 0; + lower priorities cause more favorable scheduling. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. function:: setregid(rgid, egid) + + Set the current process's real and effective group ids. + + .. availability:: Unix. + + +.. function:: setresgid(rgid, egid, sgid) + + Set the current process's real, effective, and saved group ids. + + .. availability:: Unix. + + .. versionadded:: 3.2 + + +.. function:: setresuid(ruid, euid, suid) + + Set the current process's real, effective, and saved user ids. + + .. availability:: Unix. + + .. versionadded:: 3.2 + + +.. function:: setreuid(ruid, euid) + + Set the current process's real and effective user ids. + + .. availability:: Unix. + + +.. function:: getsid(pid) + + Call the system call :c:func:`getsid`. See the Unix manual for the semantics. + + .. availability:: Unix. + + +.. function:: setsid() + + Call the system call :c:func:`setsid`. See the Unix manual for the semantics. + + .. availability:: Unix. + + +.. function:: setuid(uid) + + .. index:: single: user; id, setting + + Set the current process's user id. + + .. availability:: Unix. + + +.. placed in this section since it relates to errno.... a little weak +.. function:: strerror(code) + + Return the error message corresponding to the error code in *code*. + On platforms where :c:func:`strerror` returns ``NULL`` when given an unknown + error number, :exc:`ValueError` is raised. + + +.. data:: supports_bytes_environ + + ``True`` if the native OS type of the environment is bytes (eg. ``False`` on + Windows). + + .. versionadded:: 3.2 + + +.. function:: umask(mask) + + Set the current numeric umask and return the previous umask. + + +.. function:: uname() + + .. index:: + single: gethostname() (in module socket) + single: gethostbyaddr() (in module socket) + + Returns information identifying the current operating system. + The return value is an object with five attributes: + + * :attr:`sysname` - operating system name + * :attr:`nodename` - name of machine on network (implementation-defined) + * :attr:`release` - operating system release + * :attr:`version` - operating system version + * :attr:`machine` - hardware identifier + + For backwards compatibility, this object is also iterable, behaving + like a five-tuple containing :attr:`sysname`, :attr:`nodename`, + :attr:`release`, :attr:`version`, and :attr:`machine` + in that order. + + Some systems truncate :attr:`nodename` to 8 characters or to the + leading component; a better way to get the hostname is + :func:`socket.gethostname` or even + ``socket.gethostbyaddr(socket.gethostname())``. + + .. availability:: recent flavors of Unix. + + .. versionchanged:: 3.3 + Return type changed from a tuple to a tuple-like object + with named attributes. + + +.. function:: unsetenv(key) + + .. index:: single: environment variables; deleting + + Unset (delete) the environment variable named *key*. Such changes to the + environment affect subprocesses started with :func:`os.system`, :func:`popen` or + :func:`fork` and :func:`execv`. + + When :func:`unsetenv` is supported, deletion of items in ``os.environ`` is + automatically translated into a corresponding call to :func:`unsetenv`; however, + calls to :func:`unsetenv` don't update ``os.environ``, so it is actually + preferable to delete items of ``os.environ``. + + .. availability:: most flavors of Unix, Windows. + + +.. _os-newstreams: + +File Object Creation +-------------------- + +This function creates new :term:`file objects `. (See also +:func:`~os.open` for opening file descriptors.) + + +.. function:: fdopen(fd, *args, **kwargs) + + Return an open file object connected to the file descriptor *fd*. This is an + alias of the :func:`open` built-in function and accepts the same arguments. + The only difference is that the first argument of :func:`fdopen` must always + be an integer. + + +.. _os-fd-ops: + +File Descriptor Operations +-------------------------- + +These functions operate on I/O streams referenced using file descriptors. + +File descriptors are small integers corresponding to a file that has been opened +by the current process. For example, standard input is usually file descriptor +0, standard output is 1, and standard error is 2. Further files opened by a +process will then be assigned 3, 4, 5, and so forth. The name "file descriptor" +is slightly deceptive; on Unix platforms, sockets and pipes are also referenced +by file descriptors. + +The :meth:`~io.IOBase.fileno` method can be used to obtain the file descriptor +associated with a :term:`file object` when required. Note that using the file +descriptor directly will bypass the file object methods, ignoring aspects such +as internal buffering of data. + + +.. function:: close(fd) + + Close file descriptor *fd*. + + .. note:: + + This function is intended for low-level I/O and must be applied to a file + descriptor as returned by :func:`os.open` or :func:`pipe`. To close a "file + object" returned by the built-in function :func:`open` or by :func:`popen` or + :func:`fdopen`, use its :meth:`~io.IOBase.close` method. + + +.. function:: closerange(fd_low, fd_high) + + Close all file descriptors from *fd_low* (inclusive) to *fd_high* (exclusive), + ignoring errors. Equivalent to (but much faster than):: + + for fd in range(fd_low, fd_high): + try: + os.close(fd) + except OSError: + pass + + +.. function:: device_encoding(fd) + + Return a string describing the encoding of the device associated with *fd* + if it is connected to a terminal; else return :const:`None`. + + +.. function:: dup(fd) + + Return a duplicate of file descriptor *fd*. The new file descriptor is + :ref:`non-inheritable `. + + On Windows, when duplicating a standard stream (0: stdin, 1: stdout, + 2: stderr), the new file descriptor is :ref:`inheritable + `. + + .. versionchanged:: 3.4 + The new file descriptor is now non-inheritable. + + +.. function:: dup2(fd, fd2, inheritable=True) + + Duplicate file descriptor *fd* to *fd2*, closing the latter first if + necessary. Return *fd2*. The new file descriptor is :ref:`inheritable + ` by default or non-inheritable if *inheritable* + is ``False``. + + .. versionchanged:: 3.4 + Add the optional *inheritable* parameter. + + .. versionchanged:: 3.7 + Return *fd2* on success. Previously, ``None`` was always returned. + + +.. function:: fchmod(fd, mode) + + Change the mode of the file given by *fd* to the numeric *mode*. See the + docs for :func:`chmod` for possible values of *mode*. As of Python 3.3, this + is equivalent to ``os.chmod(fd, mode)``. + + .. availability:: Unix. + + +.. function:: fchown(fd, uid, gid) + + Change the owner and group id of the file given by *fd* to the numeric *uid* + and *gid*. To leave one of the ids unchanged, set it to -1. See + :func:`chown`. As of Python 3.3, this is equivalent to ``os.chown(fd, uid, + gid)``. + + .. availability:: Unix. + + +.. function:: fdatasync(fd) + + Force write of file with filedescriptor *fd* to disk. Does not force update of + metadata. + + .. availability:: Unix. + + .. note:: + This function is not available on MacOS. + + +.. function:: fpathconf(fd, name) + + Return system configuration information relevant to an open file. *name* + specifies the configuration value to retrieve; it may be a string which is the + name of a defined system value; these names are specified in a number of + standards (POSIX.1, Unix 95, Unix 98, and others). Some platforms define + additional names as well. The names known to the host operating system are + given in the ``pathconf_names`` dictionary. For configuration variables not + included in that mapping, passing an integer for *name* is also accepted. + + If *name* is a string and is not known, :exc:`ValueError` is raised. If a + specific value for *name* is not supported by the host system, even if it is + included in ``pathconf_names``, an :exc:`OSError` is raised with + :const:`errno.EINVAL` for the error number. + + As of Python 3.3, this is equivalent to ``os.pathconf(fd, name)``. + + .. availability:: Unix. + + +.. function:: fstat(fd) + + Get the status of the file descriptor *fd*. Return a :class:`stat_result` + object. + + As of Python 3.3, this is equivalent to ``os.stat(fd)``. + + .. seealso:: + + The :func:`.stat` function. + + +.. function:: fstatvfs(fd) + + Return information about the filesystem containing the file associated with + file descriptor *fd*, like :func:`statvfs`. As of Python 3.3, this is + equivalent to ``os.statvfs(fd)``. + + .. availability:: Unix. + + +.. function:: fsync(fd) + + Force write of file with filedescriptor *fd* to disk. On Unix, this calls the + native :c:func:`fsync` function; on Windows, the MS :c:func:`_commit` function. + + If you're starting with a buffered Python :term:`file object` *f*, first do + ``f.flush()``, and then do ``os.fsync(f.fileno())``, to ensure that all internal + buffers associated with *f* are written to disk. + + .. availability:: Unix, Windows. + + +.. function:: ftruncate(fd, length) + + Truncate the file corresponding to file descriptor *fd*, so that it is at + most *length* bytes in size. As of Python 3.3, this is equivalent to + ``os.truncate(fd, length)``. + + .. availability:: Unix, Windows. + + .. versionchanged:: 3.5 + Added support for Windows + +.. function:: get_blocking(fd) + + Get the blocking mode of the file descriptor: ``False`` if the + :data:`O_NONBLOCK` flag is set, ``True`` if the flag is cleared. + + See also :func:`set_blocking` and :meth:`socket.socket.setblocking`. + + .. availability:: Unix. + + .. versionadded:: 3.5 + +.. function:: isatty(fd) + + Return ``True`` if the file descriptor *fd* is open and connected to a + tty(-like) device, else ``False``. + + +.. function:: lockf(fd, cmd, len) + + Apply, test or remove a POSIX lock on an open file descriptor. + *fd* is an open file descriptor. + *cmd* specifies the command to use - one of :data:`F_LOCK`, :data:`F_TLOCK`, + :data:`F_ULOCK` or :data:`F_TEST`. + *len* specifies the section of the file to lock. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. data:: F_LOCK + F_TLOCK + F_ULOCK + F_TEST + + Flags that specify what action :func:`lockf` will take. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. function:: lseek(fd, pos, how) + + Set the current position of file descriptor *fd* to position *pos*, modified + by *how*: :const:`SEEK_SET` or ``0`` to set the position relative to the + beginning of the file; :const:`SEEK_CUR` or ``1`` to set it relative to the + current position; :const:`SEEK_END` or ``2`` to set it relative to the end of + the file. Return the new cursor position in bytes, starting from the beginning. + + +.. data:: SEEK_SET + SEEK_CUR + SEEK_END + + Parameters to the :func:`lseek` function. Their values are 0, 1, and 2, + respectively. + + .. versionadded:: 3.3 + Some operating systems could support additional values, like + :data:`os.SEEK_HOLE` or :data:`os.SEEK_DATA`. + + +.. function:: open(path, flags, mode=0o777, *, dir_fd=None) + + Open the file *path* and set various flags according to *flags* and possibly + its mode according to *mode*. When computing *mode*, the current umask value + is first masked out. Return the file descriptor for the newly opened file. + The new file descriptor is :ref:`non-inheritable `. + + For a description of the flag and mode values, see the C run-time documentation; + flag constants (like :const:`O_RDONLY` and :const:`O_WRONLY`) are defined in + the :mod:`os` module. In particular, on Windows adding + :const:`O_BINARY` is needed to open files in binary mode. + + This function can support :ref:`paths relative to directory descriptors + ` with the *dir_fd* parameter. + + .. versionchanged:: 3.4 + The new file descriptor is now non-inheritable. + + .. note:: + + This function is intended for low-level I/O. For normal usage, use the + built-in function :func:`open`, which returns a :term:`file object` with + :meth:`~file.read` and :meth:`~file.write` methods (and many more). To + wrap a file descriptor in a file object, use :func:`fdopen`. + + .. versionadded:: 3.3 + The *dir_fd* argument. + + .. versionchanged:: 3.5 + If the system call is interrupted and the signal handler does not raise an + exception, the function now retries the system call instead of raising an + :exc:`InterruptedError` exception (see :pep:`475` for the rationale). + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + +The following constants are options for the *flags* parameter to the +:func:`~os.open` function. They can be combined using the bitwise OR operator +``|``. Some of them are not available on all platforms. For descriptions of +their availability and use, consult the :manpage:`open(2)` manual page on Unix +or `the MSDN `_ on Windows. + + +.. data:: O_RDONLY + O_WRONLY + O_RDWR + O_APPEND + O_CREAT + O_EXCL + O_TRUNC + + The above constants are available on Unix and Windows. + + +.. data:: O_DSYNC + O_RSYNC + O_SYNC + O_NDELAY + O_NONBLOCK + O_NOCTTY + O_CLOEXEC + + The above constants are only available on Unix. + + .. versionchanged:: 3.3 + Add :data:`O_CLOEXEC` constant. + +.. data:: O_BINARY + O_NOINHERIT + O_SHORT_LIVED + O_TEMPORARY + O_RANDOM + O_SEQUENTIAL + O_TEXT + + The above constants are only available on Windows. + + +.. data:: O_ASYNC + O_DIRECT + O_DIRECTORY + O_NOFOLLOW + O_NOATIME + O_PATH + O_TMPFILE + O_SHLOCK + O_EXLOCK + + The above constants are extensions and not present if they are not defined by + the C library. + + .. versionchanged:: 3.4 + Add :data:`O_PATH` on systems that support it. + Add :data:`O_TMPFILE`, only available on Linux Kernel 3.11 + or newer. + + +.. function:: openpty() + + .. index:: module: pty + + Open a new pseudo-terminal pair. Return a pair of file descriptors + ``(master, slave)`` for the pty and the tty, respectively. The new file + descriptors are :ref:`non-inheritable `. For a (slightly) more + portable approach, use the :mod:`pty` module. + + .. availability:: some flavors of Unix. + + .. versionchanged:: 3.4 + The new file descriptors are now non-inheritable. + + +.. function:: pipe() + + Create a pipe. Return a pair of file descriptors ``(r, w)`` usable for + reading and writing, respectively. The new file descriptor is + :ref:`non-inheritable `. + + .. availability:: Unix, Windows. + + .. versionchanged:: 3.4 + The new file descriptors are now non-inheritable. + + +.. function:: pipe2(flags) + + Create a pipe with *flags* set atomically. + *flags* can be constructed by ORing together one or more of these values: + :data:`O_NONBLOCK`, :data:`O_CLOEXEC`. + Return a pair of file descriptors ``(r, w)`` usable for reading and writing, + respectively. + + .. availability:: some flavors of Unix. + + .. versionadded:: 3.3 + + +.. function:: posix_fallocate(fd, offset, len) + + Ensures that enough disk space is allocated for the file specified by *fd* + starting from *offset* and continuing for *len* bytes. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. function:: posix_fadvise(fd, offset, len, advice) + + Announces an intention to access data in a specific pattern thus allowing + the kernel to make optimizations. + The advice applies to the region of the file specified by *fd* starting at + *offset* and continuing for *len* bytes. + *advice* is one of :data:`POSIX_FADV_NORMAL`, :data:`POSIX_FADV_SEQUENTIAL`, + :data:`POSIX_FADV_RANDOM`, :data:`POSIX_FADV_NOREUSE`, + :data:`POSIX_FADV_WILLNEED` or :data:`POSIX_FADV_DONTNEED`. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. data:: POSIX_FADV_NORMAL + POSIX_FADV_SEQUENTIAL + POSIX_FADV_RANDOM + POSIX_FADV_NOREUSE + POSIX_FADV_WILLNEED + POSIX_FADV_DONTNEED + + Flags that can be used in *advice* in :func:`posix_fadvise` that specify + the access pattern that is likely to be used. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. function:: pread(fd, n, offset) + + Read at most *n* bytes from file descriptor *fd* at a position of *offset*, + leaving the file offset unchanged. + + Return a bytestring containing the bytes read. If the end of the file + referred to by *fd* has been reached, an empty bytes object is returned. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. function:: preadv(fd, buffers, offset, flags=0) + + Read from a file descriptor *fd* at a position of *offset* into mutable + :term:`bytes-like objects ` *buffers*, leaving the file + offset unchanged. Transfer data into each buffer until it is full and then + move on to the next buffer in the sequence to hold the rest of the data. + + The flags argument contains a bitwise OR of zero or more of the following + flags: + + - :data:`RWF_HIPRI` + - :data:`RWF_NOWAIT` + + Return the total number of bytes actually read which can be less than the + total capacity of all the objects. + + The operating system may set a limit (:func:`sysconf` value + ``'SC_IOV_MAX'``) on the number of buffers that can be used. + + Combine the functionality of :func:`os.readv` and :func:`os.pread`. + + .. availability:: Linux 2.6.30 and newer, FreeBSD 6.0 and newer, + OpenBSD 2.7 and newer. Using flags requires Linux 4.6 or newer. + + .. versionadded:: 3.7 + + +.. data:: RWF_NOWAIT + + Do not wait for data which is not immediately available. If this flag is + specified, the system call will return instantly if it would have to read + data from the backing storage or wait for a lock. + + If some data was successfully read, it will return the number of bytes read. + If no bytes were read, it will return ``-1`` and set errno to + :data:`errno.EAGAIN`. + + .. availability:: Linux 4.14 and newer. + + .. versionadded:: 3.7 + + +.. data:: RWF_HIPRI + + High priority read/write. Allows block-based filesystems to use polling + of the device, which provides lower latency, but may use additional + resources. + + Currently, on Linux, this feature is usable only on a file descriptor opened + using the :data:`O_DIRECT` flag. + + .. availability:: Linux 4.6 and newer. + + .. versionadded:: 3.7 + + +.. function:: pwrite(fd, str, offset) + + Write the bytestring in *str* to file descriptor *fd* at position of + *offset*, leaving the file offset unchanged. + + Return the number of bytes actually written. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. function:: pwritev(fd, buffers, offset, flags=0) + + Write the *buffers* contents to file descriptor *fd* at a offset *offset*, + leaving the file offset unchanged. *buffers* must be a sequence of + :term:`bytes-like objects `. Buffers are processed in + array order. Entire contents of the first buffer is written before + proceeding to the second, and so on. + + The flags argument contains a bitwise OR of zero or more of the following + flags: + + - :data:`RWF_DSYNC` + - :data:`RWF_SYNC` + + Return the total number of bytes actually written. + + The operating system may set a limit (:func:`sysconf` value + ``'SC_IOV_MAX'``) on the number of buffers that can be used. + + Combine the functionality of :func:`os.writev` and :func:`os.pwrite`. + + .. availability:: Linux 2.6.30 and newer, FreeBSD 6.0 and newer, + OpenBSD 2.7 and newer. Using flags requires Linux 4.7 or newer. + + .. versionadded:: 3.7 + + +.. data:: RWF_DSYNC + + Provide a per-write equivalent of the :data:`O_DSYNC` ``open(2)`` flag. This + flag effect applies only to the data range written by the system call. + + .. availability:: Linux 4.7 and newer. + + .. versionadded:: 3.7 + + +.. data:: RWF_SYNC + + Provide a per-write equivalent of the :data:`O_SYNC` ``open(2)`` flag. This + flag effect applies only to the data range written by the system call. + + .. availability:: Linux 4.7 and newer. + + .. versionadded:: 3.7 + + +.. function:: read(fd, n) + + Read at most *n* bytes from file descriptor *fd*. + + Return a bytestring containing the bytes read. If the end of the file + referred to by *fd* has been reached, an empty bytes object is returned. + + .. note:: + + This function is intended for low-level I/O and must be applied to a file + descriptor as returned by :func:`os.open` or :func:`pipe`. To read a + "file object" returned by the built-in function :func:`open` or by + :func:`popen` or :func:`fdopen`, or :data:`sys.stdin`, use its + :meth:`~file.read` or :meth:`~file.readline` methods. + + .. versionchanged:: 3.5 + If the system call is interrupted and the signal handler does not raise an + exception, the function now retries the system call instead of raising an + :exc:`InterruptedError` exception (see :pep:`475` for the rationale). + + +.. function:: sendfile(out, in, offset, count) + sendfile(out, in, offset, count, [headers], [trailers], flags=0) + + Copy *count* bytes from file descriptor *in* to file descriptor *out* + starting at *offset*. + Return the number of bytes sent. When EOF is reached return 0. + + The first function notation is supported by all platforms that define + :func:`sendfile`. + + On Linux, if *offset* is given as ``None``, the bytes are read from the + current position of *in* and the position of *in* is updated. + + The second case may be used on Mac OS X and FreeBSD where *headers* and + *trailers* are arbitrary sequences of buffers that are written before and + after the data from *in* is written. It returns the same as the first case. + + On Mac OS X and FreeBSD, a value of 0 for *count* specifies to send until + the end of *in* is reached. + + All platforms support sockets as *out* file descriptor, and some platforms + allow other types (e.g. regular file, pipe) as well. + + Cross-platform applications should not use *headers*, *trailers* and *flags* + arguments. + + .. availability:: Unix. + + .. note:: + + For a higher-level wrapper of :func:`sendfile`, see + :meth:`socket.socket.sendfile`. + + .. versionadded:: 3.3 + + +.. function:: set_blocking(fd, blocking) + + Set the blocking mode of the specified file descriptor. Set the + :data:`O_NONBLOCK` flag if blocking is ``False``, clear the flag otherwise. + + See also :func:`get_blocking` and :meth:`socket.socket.setblocking`. + + .. availability:: Unix. + + .. versionadded:: 3.5 + + +.. data:: SF_NODISKIO + SF_MNOWAIT + SF_SYNC + + Parameters to the :func:`sendfile` function, if the implementation supports + them. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. function:: readv(fd, buffers) + + Read from a file descriptor *fd* into a number of mutable :term:`bytes-like + objects ` *buffers*. Transfer data into each buffer until + it is full and then move on to the next buffer in the sequence to hold the + rest of the data. + + Return the total number of bytes actually read which can be less than the + total capacity of all the objects. + + The operating system may set a limit (:func:`sysconf` value + ``'SC_IOV_MAX'``) on the number of buffers that can be used. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. function:: tcgetpgrp(fd) + + Return the process group associated with the terminal given by *fd* (an open + file descriptor as returned by :func:`os.open`). + + .. availability:: Unix. + + +.. function:: tcsetpgrp(fd, pg) + + Set the process group associated with the terminal given by *fd* (an open file + descriptor as returned by :func:`os.open`) to *pg*. + + .. availability:: Unix. + + +.. function:: ttyname(fd) + + Return a string which specifies the terminal device associated with + file descriptor *fd*. If *fd* is not associated with a terminal device, an + exception is raised. + + .. availability:: Unix. + + +.. function:: write(fd, str) + + Write the bytestring in *str* to file descriptor *fd*. + + Return the number of bytes actually written. + + .. note:: + + This function is intended for low-level I/O and must be applied to a file + descriptor as returned by :func:`os.open` or :func:`pipe`. To write a "file + object" returned by the built-in function :func:`open` or by :func:`popen` or + :func:`fdopen`, or :data:`sys.stdout` or :data:`sys.stderr`, use its + :meth:`~file.write` method. + + .. versionchanged:: 3.5 + If the system call is interrupted and the signal handler does not raise an + exception, the function now retries the system call instead of raising an + :exc:`InterruptedError` exception (see :pep:`475` for the rationale). + + +.. function:: writev(fd, buffers) + + Write the contents of *buffers* to file descriptor *fd*. *buffers* must be + a sequence of :term:`bytes-like objects `. Buffers are + processed in array order. Entire contents of the first buffer is written + before proceeding to the second, and so on. + + Returns the total number of bytes actually written. + + The operating system may set a limit (:func:`sysconf` value + ``'SC_IOV_MAX'``) on the number of buffers that can be used. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. _terminal-size: + +Querying the size of a terminal +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. versionadded:: 3.3 + +.. function:: get_terminal_size(fd=STDOUT_FILENO) + + Return the size of the terminal window as ``(columns, lines)``, + tuple of type :class:`terminal_size`. + + The optional argument ``fd`` (default ``STDOUT_FILENO``, or standard + output) specifies which file descriptor should be queried. + + If the file descriptor is not connected to a terminal, an :exc:`OSError` + is raised. + + :func:`shutil.get_terminal_size` is the high-level function which + should normally be used, ``os.get_terminal_size`` is the low-level + implementation. + + .. availability:: Unix, Windows. + +.. class:: terminal_size + + A subclass of tuple, holding ``(columns, lines)`` of the terminal window size. + + .. attribute:: columns + + Width of the terminal window in characters. + + .. attribute:: lines + + Height of the terminal window in characters. + + +.. _fd_inheritance: + +Inheritance of File Descriptors +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. versionadded:: 3.4 + +A file descriptor has an "inheritable" flag which indicates if the file descriptor +can be inherited by child processes. Since Python 3.4, file descriptors +created by Python are non-inheritable by default. + +On UNIX, non-inheritable file descriptors are closed in child processes at the +execution of a new program, other file descriptors are inherited. + +On Windows, non-inheritable handles and file descriptors are closed in child +processes, except for standard streams (file descriptors 0, 1 and 2: stdin, stdout +and stderr), which are always inherited. Using :func:`spawn\* ` functions, +all inheritable handles and all inheritable file descriptors are inherited. +Using the :mod:`subprocess` module, all file descriptors except standard +streams are closed, and inheritable handles are only inherited if the +*close_fds* parameter is ``False``. + +.. function:: get_inheritable(fd) + + Get the "inheritable" flag of the specified file descriptor (a boolean). + +.. function:: set_inheritable(fd, inheritable) + + Set the "inheritable" flag of the specified file descriptor. + +.. function:: get_handle_inheritable(handle) + + Get the "inheritable" flag of the specified handle (a boolean). + + .. availability:: Windows. + +.. function:: set_handle_inheritable(handle, inheritable) + + Set the "inheritable" flag of the specified handle. + + .. availability:: Windows. + + +.. _os-file-dir: + +Files and Directories +--------------------- + +On some Unix platforms, many of these functions support one or more of these +features: + +.. _path_fd: + +* **specifying a file descriptor:** + For some functions, the *path* argument can be not only a string giving a path + name, but also a file descriptor. The function will then operate on the file + referred to by the descriptor. (For POSIX systems, Python will call the + ``f...`` version of the function.) + + You can check whether or not *path* can be specified as a file descriptor on + your platform using :data:`os.supports_fd`. If it is unavailable, using it + will raise a :exc:`NotImplementedError`. + + If the function also supports *dir_fd* or *follow_symlinks* arguments, it is + an error to specify one of those when supplying *path* as a file descriptor. + +.. _dir_fd: + +* **paths relative to directory descriptors:** If *dir_fd* is not ``None``, it + should be a file descriptor referring to a directory, and the path to operate + on should be relative; path will then be relative to that directory. If the + path is absolute, *dir_fd* is ignored. (For POSIX systems, Python will call + the ``...at`` or ``f...at`` version of the function.) + + You can check whether or not *dir_fd* is supported on your platform using + :data:`os.supports_dir_fd`. If it is unavailable, using it will raise a + :exc:`NotImplementedError`. + +.. _follow_symlinks: + +* **not following symlinks:** If *follow_symlinks* is + ``False``, and the last element of the path to operate on is a symbolic link, + the function will operate on the symbolic link itself instead of the file the + link points to. (For POSIX systems, Python will call the ``l...`` version of + the function.) + + You can check whether or not *follow_symlinks* is supported on your platform + using :data:`os.supports_follow_symlinks`. If it is unavailable, using it + will raise a :exc:`NotImplementedError`. + + + +.. function:: access(path, mode, *, dir_fd=None, effective_ids=False, follow_symlinks=True) + + Use the real uid/gid to test for access to *path*. Note that most operations + will use the effective uid/gid, therefore this routine can be used in a + suid/sgid environment to test if the invoking user has the specified access to + *path*. *mode* should be :const:`F_OK` to test the existence of *path*, or it + can be the inclusive OR of one or more of :const:`R_OK`, :const:`W_OK`, and + :const:`X_OK` to test permissions. Return :const:`True` if access is allowed, + :const:`False` if not. See the Unix man page :manpage:`access(2)` for more + information. + + This function can support specifying :ref:`paths relative to directory + descriptors ` and :ref:`not following symlinks `. + + If *effective_ids* is ``True``, :func:`access` will perform its access + checks using the effective uid/gid instead of the real uid/gid. + *effective_ids* may not be supported on your platform; you can check whether + or not it is available using :data:`os.supports_effective_ids`. If it is + unavailable, using it will raise a :exc:`NotImplementedError`. + + .. note:: + + Using :func:`access` to check if a user is authorized to e.g. open a file + before actually doing so using :func:`open` creates a security hole, + because the user might exploit the short time interval between checking + and opening the file to manipulate it. It's preferable to use :term:`EAFP` + techniques. For example:: + + if os.access("myfile", os.R_OK): + with open("myfile") as fp: + return fp.read() + return "some default data" + + is better written as:: + + try: + fp = open("myfile") + except PermissionError: + return "some default data" + else: + with fp: + return fp.read() + + .. note:: + + I/O operations may fail even when :func:`access` indicates that they would + succeed, particularly for operations on network filesystems which may have + permissions semantics beyond the usual POSIX permission-bit model. + + .. versionchanged:: 3.3 + Added the *dir_fd*, *effective_ids*, and *follow_symlinks* parameters. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. data:: F_OK + R_OK + W_OK + X_OK + + Values to pass as the *mode* parameter of :func:`access` to test the + existence, readability, writability and executability of *path*, + respectively. + + +.. function:: chdir(path) + + .. index:: single: directory; changing + + Change the current working directory to *path*. + + This function can support :ref:`specifying a file descriptor `. The + descriptor must refer to an opened directory, not an open file. + + This function can raise :exc:`OSError` and subclasses such as + :exc:`FileNotFoundError`, :exc:`PermissionError`, and :exc:`NotADirectoryError`. + + .. versionadded:: 3.3 + Added support for specifying *path* as a file descriptor + on some platforms. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: chflags(path, flags, *, follow_symlinks=True) + + Set the flags of *path* to the numeric *flags*. *flags* may take a combination + (bitwise OR) of the following values (as defined in the :mod:`stat` module): + + * :data:`stat.UF_NODUMP` + * :data:`stat.UF_IMMUTABLE` + * :data:`stat.UF_APPEND` + * :data:`stat.UF_OPAQUE` + * :data:`stat.UF_NOUNLINK` + * :data:`stat.UF_COMPRESSED` + * :data:`stat.UF_HIDDEN` + * :data:`stat.SF_ARCHIVED` + * :data:`stat.SF_IMMUTABLE` + * :data:`stat.SF_APPEND` + * :data:`stat.SF_NOUNLINK` + * :data:`stat.SF_SNAPSHOT` + + This function can support :ref:`not following symlinks `. + + .. availability:: Unix. + + .. versionadded:: 3.3 + The *follow_symlinks* argument. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: chmod(path, mode, *, dir_fd=None, follow_symlinks=True) + + Change the mode of *path* to the numeric *mode*. *mode* may take one of the + following values (as defined in the :mod:`stat` module) or bitwise ORed + combinations of them: + + * :data:`stat.S_ISUID` + * :data:`stat.S_ISGID` + * :data:`stat.S_ENFMT` + * :data:`stat.S_ISVTX` + * :data:`stat.S_IREAD` + * :data:`stat.S_IWRITE` + * :data:`stat.S_IEXEC` + * :data:`stat.S_IRWXU` + * :data:`stat.S_IRUSR` + * :data:`stat.S_IWUSR` + * :data:`stat.S_IXUSR` + * :data:`stat.S_IRWXG` + * :data:`stat.S_IRGRP` + * :data:`stat.S_IWGRP` + * :data:`stat.S_IXGRP` + * :data:`stat.S_IRWXO` + * :data:`stat.S_IROTH` + * :data:`stat.S_IWOTH` + * :data:`stat.S_IXOTH` + + This function can support :ref:`specifying a file descriptor `, + :ref:`paths relative to directory descriptors ` and :ref:`not + following symlinks `. + + .. note:: + + Although Windows supports :func:`chmod`, you can only set the file's + read-only flag with it (via the ``stat.S_IWRITE`` and ``stat.S_IREAD`` + constants or a corresponding integer value). All other bits are ignored. + + .. versionadded:: 3.3 + Added support for specifying *path* as an open file descriptor, + and the *dir_fd* and *follow_symlinks* arguments. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: chown(path, uid, gid, *, dir_fd=None, follow_symlinks=True) + + Change the owner and group id of *path* to the numeric *uid* and *gid*. To + leave one of the ids unchanged, set it to -1. + + This function can support :ref:`specifying a file descriptor `, + :ref:`paths relative to directory descriptors ` and :ref:`not + following symlinks `. + + See :func:`shutil.chown` for a higher-level function that accepts names in + addition to numeric ids. + + .. availability:: Unix. + + .. versionadded:: 3.3 + Added support for specifying an open file descriptor for *path*, + and the *dir_fd* and *follow_symlinks* arguments. + + .. versionchanged:: 3.6 + Supports a :term:`path-like object`. + + +.. function:: chroot(path) + + Change the root directory of the current process to *path*. + + .. availability:: Unix. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: fchdir(fd) + + Change the current working directory to the directory represented by the file + descriptor *fd*. The descriptor must refer to an opened directory, not an + open file. As of Python 3.3, this is equivalent to ``os.chdir(fd)``. + + .. availability:: Unix. + + +.. function:: getcwd() + + Return a string representing the current working directory. + + +.. function:: getcwdb() + + Return a bytestring representing the current working directory. + + +.. function:: lchflags(path, flags) + + Set the flags of *path* to the numeric *flags*, like :func:`chflags`, but do + not follow symbolic links. As of Python 3.3, this is equivalent to + ``os.chflags(path, flags, follow_symlinks=False)``. + + .. availability:: Unix. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: lchmod(path, mode) + + Change the mode of *path* to the numeric *mode*. If path is a symlink, this + affects the symlink rather than the target. See the docs for :func:`chmod` + for possible values of *mode*. As of Python 3.3, this is equivalent to + ``os.chmod(path, mode, follow_symlinks=False)``. + + .. availability:: Unix. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + +.. function:: lchown(path, uid, gid) + + Change the owner and group id of *path* to the numeric *uid* and *gid*. This + function will not follow symbolic links. As of Python 3.3, this is equivalent + to ``os.chown(path, uid, gid, follow_symlinks=False)``. + + .. availability:: Unix. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: link(src, dst, *, src_dir_fd=None, dst_dir_fd=None, follow_symlinks=True) + + Create a hard link pointing to *src* named *dst*. + + This function can support specifying *src_dir_fd* and/or *dst_dir_fd* to + supply :ref:`paths relative to directory descriptors `, and :ref:`not + following symlinks `. + + .. availability:: Unix, Windows. + + .. versionchanged:: 3.2 + Added Windows support. + + .. versionadded:: 3.3 + Added the *src_dir_fd*, *dst_dir_fd*, and *follow_symlinks* arguments. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object` for *src* and *dst*. + + +.. function:: listdir(path='.') + + Return a list containing the names of the entries in the directory given by + *path*. The list is in arbitrary order, and does not include the special + entries ``'.'`` and ``'..'`` even if they are present in the directory. + + *path* may be a :term:`path-like object`. If *path* is of type ``bytes`` + (directly or indirectly through the :class:`PathLike` interface), + the filenames returned will also be of type ``bytes``; + in all other circumstances, they will be of type ``str``. + + This function can also support :ref:`specifying a file descriptor + `; the file descriptor must refer to a directory. + + .. note:: + To encode ``str`` filenames to ``bytes``, use :func:`~os.fsencode`. + + .. seealso:: + + The :func:`scandir` function returns directory entries along with + file attribute information, giving better performance for many + common use cases. + + .. versionchanged:: 3.2 + The *path* parameter became optional. + + .. versionadded:: 3.3 + Added support for specifying an open file descriptor for *path*. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: lstat(path, \*, dir_fd=None) + + Perform the equivalent of an :c:func:`lstat` system call on the given path. + Similar to :func:`~os.stat`, but does not follow symbolic links. Return a + :class:`stat_result` object. + + On platforms that do not support symbolic links, this is an alias for + :func:`~os.stat`. + + As of Python 3.3, this is equivalent to ``os.stat(path, dir_fd=dir_fd, + follow_symlinks=False)``. + + This function can also support :ref:`paths relative to directory descriptors + `. + + .. seealso:: + + The :func:`.stat` function. + + .. versionchanged:: 3.2 + Added support for Windows 6.0 (Vista) symbolic links. + + .. versionchanged:: 3.3 + Added the *dir_fd* parameter. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object` for *src* and *dst*. + + +.. function:: mkdir(path, mode=0o777, *, dir_fd=None) + + Create a directory named *path* with numeric mode *mode*. + + If the directory already exists, :exc:`FileExistsError` is raised. + + .. _mkdir_modebits: + + On some systems, *mode* is ignored. Where it is used, the current umask + value is first masked out. If bits other than the last 9 (i.e. the last 3 + digits of the octal representation of the *mode*) are set, their meaning is + platform-dependent. On some platforms, they are ignored and you should call + :func:`chmod` explicitly to set them. + + This function can also support :ref:`paths relative to directory descriptors + `. + + It is also possible to create temporary directories; see the + :mod:`tempfile` module's :func:`tempfile.mkdtemp` function. + + .. versionadded:: 3.3 + The *dir_fd* argument. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: makedirs(name, mode=0o777, exist_ok=False) + + .. index:: + single: directory; creating + single: UNC paths; and os.makedirs() + + Recursive directory creation function. Like :func:`mkdir`, but makes all + intermediate-level directories needed to contain the leaf directory. + + The *mode* parameter is passed to :func:`mkdir` for creating the leaf + directory; see :ref:`the mkdir() description ` for how it + is interpreted. To set the file permission bits of any newly-created parent + directories you can set the umask before invoking :func:`makedirs`. The + file permission bits of existing parent directories are not changed. + + If *exist_ok* is ``False`` (the default), an :exc:`FileExistsError` is + raised if the target directory already exists. + + .. note:: + + :func:`makedirs` will become confused if the path elements to create + include :data:`pardir` (eg. ".." on UNIX systems). + + This function handles UNC paths correctly. + + .. versionadded:: 3.2 + The *exist_ok* parameter. + + .. versionchanged:: 3.4.1 + + Before Python 3.4.1, if *exist_ok* was ``True`` and the directory existed, + :func:`makedirs` would still raise an error if *mode* did not match the + mode of the existing directory. Since this behavior was impossible to + implement safely, it was removed in Python 3.4.1. See :issue:`21082`. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + .. versionchanged:: 3.7 + The *mode* argument no longer affects the file permission bits of + newly-created intermediate-level directories. + + +.. function:: mkfifo(path, mode=0o666, *, dir_fd=None) + + Create a FIFO (a named pipe) named *path* with numeric mode *mode*. + The current umask value is first masked out from the mode. + + This function can also support :ref:`paths relative to directory descriptors + `. + + FIFOs are pipes that can be accessed like regular files. FIFOs exist until they + are deleted (for example with :func:`os.unlink`). Generally, FIFOs are used as + rendezvous between "client" and "server" type processes: the server opens the + FIFO for reading, and the client opens it for writing. Note that :func:`mkfifo` + doesn't open the FIFO --- it just creates the rendezvous point. + + .. availability:: Unix. + + .. versionadded:: 3.3 + The *dir_fd* argument. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: mknod(path, mode=0o600, device=0, *, dir_fd=None) + + Create a filesystem node (file, device special file or named pipe) named + *path*. *mode* specifies both the permissions to use and the type of node + to be created, being combined (bitwise OR) with one of ``stat.S_IFREG``, + ``stat.S_IFCHR``, ``stat.S_IFBLK``, and ``stat.S_IFIFO`` (those constants are + available in :mod:`stat`). For ``stat.S_IFCHR`` and ``stat.S_IFBLK``, + *device* defines the newly created device special file (probably using + :func:`os.makedev`), otherwise it is ignored. + + This function can also support :ref:`paths relative to directory descriptors + `. + + .. availability:: Unix. + + .. versionadded:: 3.3 + The *dir_fd* argument. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: major(device) + + Extract the device major number from a raw device number (usually the + :attr:`st_dev` or :attr:`st_rdev` field from :c:type:`stat`). + + +.. function:: minor(device) + + Extract the device minor number from a raw device number (usually the + :attr:`st_dev` or :attr:`st_rdev` field from :c:type:`stat`). + + +.. function:: makedev(major, minor) + + Compose a raw device number from the major and minor device numbers. + + +.. function:: pathconf(path, name) + + Return system configuration information relevant to a named file. *name* + specifies the configuration value to retrieve; it may be a string which is the + name of a defined system value; these names are specified in a number of + standards (POSIX.1, Unix 95, Unix 98, and others). Some platforms define + additional names as well. The names known to the host operating system are + given in the ``pathconf_names`` dictionary. For configuration variables not + included in that mapping, passing an integer for *name* is also accepted. + + If *name* is a string and is not known, :exc:`ValueError` is raised. If a + specific value for *name* is not supported by the host system, even if it is + included in ``pathconf_names``, an :exc:`OSError` is raised with + :const:`errno.EINVAL` for the error number. + + This function can support :ref:`specifying a file descriptor + `. + + .. availability:: Unix. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. data:: pathconf_names + + Dictionary mapping names accepted by :func:`pathconf` and :func:`fpathconf` to + the integer values defined for those names by the host operating system. This + can be used to determine the set of names known to the system. + + .. availability:: Unix. + + +.. function:: readlink(path, *, dir_fd=None) + + Return a string representing the path to which the symbolic link points. The + result may be either an absolute or relative pathname; if it is relative, it + may be converted to an absolute pathname using + ``os.path.join(os.path.dirname(path), result)``. + + If the *path* is a string object (directly or indirectly through a + :class:`PathLike` interface), the result will also be a string object, + and the call may raise a UnicodeDecodeError. If the *path* is a bytes + object (direct or indirectly), the result will be a bytes object. + + This function can also support :ref:`paths relative to directory descriptors + `. + + .. availability:: Unix, Windows. + + .. versionchanged:: 3.2 + Added support for Windows 6.0 (Vista) symbolic links. + + .. versionadded:: 3.3 + The *dir_fd* argument. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: remove(path, *, dir_fd=None) + + Remove (delete) the file *path*. If *path* is a directory, an + :exc:`IsADirectoryError` is raised. Use :func:`rmdir` to remove directories. + + This function can support :ref:`paths relative to directory descriptors + `. + + On Windows, attempting to remove a file that is in use causes an exception to + be raised; on Unix, the directory entry is removed but the storage allocated + to the file is not made available until the original file is no longer in use. + + This function is semantically identical to :func:`unlink`. + + .. versionadded:: 3.3 + The *dir_fd* argument. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: removedirs(name) + + .. index:: single: directory; deleting + + Remove directories recursively. Works like :func:`rmdir` except that, if the + leaf directory is successfully removed, :func:`removedirs` tries to + successively remove every parent directory mentioned in *path* until an error + is raised (which is ignored, because it generally means that a parent directory + is not empty). For example, ``os.removedirs('foo/bar/baz')`` will first remove + the directory ``'foo/bar/baz'``, and then remove ``'foo/bar'`` and ``'foo'`` if + they are empty. Raises :exc:`OSError` if the leaf directory could not be + successfully removed. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: rename(src, dst, *, src_dir_fd=None, dst_dir_fd=None) + + Rename the file or directory *src* to *dst*. If *dst* exists, the operation + will fail with an :exc:`OSError` subclass in a number of cases: + + On Windows, if *dst* exists a :exc:`FileExistsError` is always raised. + + On Unix, if *src* is a file and *dst* is a directory or vice-versa, an + :exc:`IsADirectoryError` or a :exc:`NotADirectoryError` will be raised + respectively. If both are directories and *dst* is empty, *dst* will be + silently replaced. If *dst* is a non-empty directory, an :exc:`OSError` + is raised. If both are files, *dst* it will be replaced silently if the user + has permission. The operation may fail on some Unix flavors if *src* and + *dst* are on different filesystems. If successful, the renaming will be an + atomic operation (this is a POSIX requirement). + + This function can support specifying *src_dir_fd* and/or *dst_dir_fd* to + supply :ref:`paths relative to directory descriptors `. + + If you want cross-platform overwriting of the destination, use :func:`replace`. + + .. versionadded:: 3.3 + The *src_dir_fd* and *dst_dir_fd* arguments. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object` for *src* and *dst*. + + +.. function:: renames(old, new) + + Recursive directory or file renaming function. Works like :func:`rename`, except + creation of any intermediate directories needed to make the new pathname good is + attempted first. After the rename, directories corresponding to rightmost path + segments of the old name will be pruned away using :func:`removedirs`. + + .. note:: + + This function can fail with the new directory structure made if you lack + permissions needed to remove the leaf directory or file. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object` for *old* and *new*. + + +.. function:: replace(src, dst, *, src_dir_fd=None, dst_dir_fd=None) + + Rename the file or directory *src* to *dst*. If *dst* is a directory, + :exc:`OSError` will be raised. If *dst* exists and is a file, it will + be replaced silently if the user has permission. The operation may fail + if *src* and *dst* are on different filesystems. If successful, + the renaming will be an atomic operation (this is a POSIX requirement). + + This function can support specifying *src_dir_fd* and/or *dst_dir_fd* to + supply :ref:`paths relative to directory descriptors `. + + .. versionadded:: 3.3 + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object` for *src* and *dst*. + + +.. function:: rmdir(path, *, dir_fd=None) + + Remove (delete) the directory *path*. If the directory does not exist or is + not empty, an :exc:`FileNotFoundError` or an :exc:`OSError` is raised + respectively. In order to remove whole directory trees, + :func:`shutil.rmtree` can be used. + + This function can support :ref:`paths relative to directory descriptors + `. + + .. versionadded:: 3.3 + The *dir_fd* parameter. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: scandir(path='.') + + Return an iterator of :class:`os.DirEntry` objects corresponding to the + entries in the directory given by *path*. The entries are yielded in + arbitrary order, and the special entries ``'.'`` and ``'..'`` are not + included. + + Using :func:`scandir` instead of :func:`listdir` can significantly + increase the performance of code that also needs file type or file + attribute information, because :class:`os.DirEntry` objects expose this + information if the operating system provides it when scanning a directory. + All :class:`os.DirEntry` methods may perform a system call, but + :func:`~os.DirEntry.is_dir` and :func:`~os.DirEntry.is_file` usually only + require a system call for symbolic links; :func:`os.DirEntry.stat` + always requires a system call on Unix but only requires one for + symbolic links on Windows. + + *path* may be a :term:`path-like object`. If *path* is of type ``bytes`` + (directly or indirectly through the :class:`PathLike` interface), + the type of the :attr:`~os.DirEntry.name` and :attr:`~os.DirEntry.path` + attributes of each :class:`os.DirEntry` will be ``bytes``; in all other + circumstances, they will be of type ``str``. + + This function can also support :ref:`specifying a file descriptor + `; the file descriptor must refer to a directory. + + The :func:`scandir` iterator supports the :term:`context manager` protocol + and has the following method: + + .. method:: scandir.close() + + Close the iterator and free acquired resources. + + This is called automatically when the iterator is exhausted or garbage + collected, or when an error happens during iterating. However it + is advisable to call it explicitly or use the :keyword:`with` + statement. + + .. versionadded:: 3.6 + + The following example shows a simple use of :func:`scandir` to display all + the files (excluding directories) in the given *path* that don't start with + ``'.'``. The ``entry.is_file()`` call will generally not make an additional + system call:: + + with os.scandir(path) as it: + for entry in it: + if not entry.name.startswith('.') and entry.is_file(): + print(entry.name) + + .. note:: + + On Unix-based systems, :func:`scandir` uses the system's + `opendir() `_ + and + `readdir() `_ + functions. On Windows, it uses the Win32 + `FindFirstFileW `_ + and + `FindNextFileW `_ + functions. + + .. versionadded:: 3.5 + + .. versionadded:: 3.6 + Added support for the :term:`context manager` protocol and the + :func:`~scandir.close()` method. If a :func:`scandir` iterator is neither + exhausted nor explicitly closed a :exc:`ResourceWarning` will be emitted + in its destructor. + + The function accepts a :term:`path-like object`. + + .. versionchanged:: 3.7 + Added support for :ref:`file descriptors ` on Unix. + + +.. class:: DirEntry + + Object yielded by :func:`scandir` to expose the file path and other file + attributes of a directory entry. + + :func:`scandir` will provide as much of this information as possible without + making additional system calls. When a ``stat()`` or ``lstat()`` system call + is made, the ``os.DirEntry`` object will cache the result. + + ``os.DirEntry`` instances are not intended to be stored in long-lived data + structures; if you know the file metadata has changed or if a long time has + elapsed since calling :func:`scandir`, call ``os.stat(entry.path)`` to fetch + up-to-date information. + + Because the ``os.DirEntry`` methods can make operating system calls, they may + also raise :exc:`OSError`. If you need very fine-grained + control over errors, you can catch :exc:`OSError` when calling one of the + ``os.DirEntry`` methods and handle as appropriate. + + To be directly usable as a :term:`path-like object`, ``os.DirEntry`` + implements the :class:`PathLike` interface. + + Attributes and methods on a ``os.DirEntry`` instance are as follows: + + .. attribute:: name + + The entry's base filename, relative to the :func:`scandir` *path* + argument. + + The :attr:`name` attribute will be ``bytes`` if the :func:`scandir` + *path* argument is of type ``bytes`` and ``str`` otherwise. Use + :func:`~os.fsdecode` to decode byte filenames. + + .. attribute:: path + + The entry's full path name: equivalent to ``os.path.join(scandir_path, + entry.name)`` where *scandir_path* is the :func:`scandir` *path* + argument. The path is only absolute if the :func:`scandir` *path* + argument was absolute. If the :func:`scandir` *path* + argument was a :ref:`file descriptor `, the :attr:`path` + attribute is the same as the :attr:`name` attribute. + + The :attr:`path` attribute will be ``bytes`` if the :func:`scandir` + *path* argument is of type ``bytes`` and ``str`` otherwise. Use + :func:`~os.fsdecode` to decode byte filenames. + + .. method:: inode() + + Return the inode number of the entry. + + The result is cached on the ``os.DirEntry`` object. Use + ``os.stat(entry.path, follow_symlinks=False).st_ino`` to fetch up-to-date + information. + + On the first, uncached call, a system call is required on Windows but + not on Unix. + + .. method:: is_dir(\*, follow_symlinks=True) + + Return ``True`` if this entry is a directory or a symbolic link pointing + to a directory; return ``False`` if the entry is or points to any other + kind of file, or if it doesn't exist anymore. + + If *follow_symlinks* is ``False``, return ``True`` only if this entry + is a directory (without following symlinks); return ``False`` if the + entry is any other kind of file or if it doesn't exist anymore. + + The result is cached on the ``os.DirEntry`` object, with a separate cache + for *follow_symlinks* ``True`` and ``False``. Call :func:`os.stat` along + with :func:`stat.S_ISDIR` to fetch up-to-date information. + + On the first, uncached call, no system call is required in most cases. + Specifically, for non-symlinks, neither Windows or Unix require a system + call, except on certain Unix file systems, such as network file systems, + that return ``dirent.d_type == DT_UNKNOWN``. If the entry is a symlink, + a system call will be required to follow the symlink unless + *follow_symlinks* is ``False``. + + This method can raise :exc:`OSError`, such as :exc:`PermissionError`, + but :exc:`FileNotFoundError` is caught and not raised. + + .. method:: is_file(\*, follow_symlinks=True) + + Return ``True`` if this entry is a file or a symbolic link pointing to a + file; return ``False`` if the entry is or points to a directory or other + non-file entry, or if it doesn't exist anymore. + + If *follow_symlinks* is ``False``, return ``True`` only if this entry + is a file (without following symlinks); return ``False`` if the entry is + a directory or other non-file entry, or if it doesn't exist anymore. + + The result is cached on the ``os.DirEntry`` object. Caching, system calls + made, and exceptions raised are as per :func:`~os.DirEntry.is_dir`. + + .. method:: is_symlink() + + Return ``True`` if this entry is a symbolic link (even if broken); + return ``False`` if the entry points to a directory or any kind of file, + or if it doesn't exist anymore. + + The result is cached on the ``os.DirEntry`` object. Call + :func:`os.path.islink` to fetch up-to-date information. + + On the first, uncached call, no system call is required in most cases. + Specifically, neither Windows or Unix require a system call, except on + certain Unix file systems, such as network file systems, that return + ``dirent.d_type == DT_UNKNOWN``. + + This method can raise :exc:`OSError`, such as :exc:`PermissionError`, + but :exc:`FileNotFoundError` is caught and not raised. + + .. method:: stat(\*, follow_symlinks=True) + + Return a :class:`stat_result` object for this entry. This method + follows symbolic links by default; to stat a symbolic link add the + ``follow_symlinks=False`` argument. + + On Unix, this method always requires a system call. On Windows, it + only requires a system call if *follow_symlinks* is ``True`` and the + entry is a symbolic link. + + On Windows, the ``st_ino``, ``st_dev`` and ``st_nlink`` attributes of the + :class:`stat_result` are always set to zero. Call :func:`os.stat` to + get these attributes. + + The result is cached on the ``os.DirEntry`` object, with a separate cache + for *follow_symlinks* ``True`` and ``False``. Call :func:`os.stat` to + fetch up-to-date information. + + Note that there is a nice correspondence between several attributes + and methods of ``os.DirEntry`` and of :class:`pathlib.Path`. In + particular, the ``name`` attribute has the same + meaning, as do the ``is_dir()``, ``is_file()``, ``is_symlink()`` + and ``stat()`` methods. + + .. versionadded:: 3.5 + + .. versionchanged:: 3.6 + Added support for the :class:`~os.PathLike` interface. Added support + for :class:`bytes` paths on Windows. + + +.. function:: stat(path, \*, dir_fd=None, follow_symlinks=True) + + Get the status of a file or a file descriptor. Perform the equivalent of a + :c:func:`stat` system call on the given path. *path* may be specified as + either a string or bytes -- directly or indirectly through the :class:`PathLike` + interface -- or as an open file descriptor. Return a :class:`stat_result` + object. + + This function normally follows symlinks; to stat a symlink add the argument + ``follow_symlinks=False``, or use :func:`lstat`. + + This function can support :ref:`specifying a file descriptor ` and + :ref:`not following symlinks `. + + .. index:: module: stat + + Example:: + + >>> import os + >>> statinfo = os.stat('somefile.txt') + >>> statinfo + os.stat_result(st_mode=33188, st_ino=7876932, st_dev=234881026, + st_nlink=1, st_uid=501, st_gid=501, st_size=264, st_atime=1297230295, + st_mtime=1297230027, st_ctime=1297230027) + >>> statinfo.st_size + 264 + + .. seealso:: + + :func:`fstat` and :func:`lstat` functions. + + .. versionadded:: 3.3 + Added the *dir_fd* and *follow_symlinks* arguments, specifying a file + descriptor instead of a path. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. class:: stat_result + + Object whose attributes correspond roughly to the members of the + :c:type:`stat` structure. It is used for the result of :func:`os.stat`, + :func:`os.fstat` and :func:`os.lstat`. + + Attributes: + + .. attribute:: st_mode + + File mode: file type and file mode bits (permissions). + + .. attribute:: st_ino + + Platform dependent, but if non-zero, uniquely identifies the + file for a given value of ``st_dev``. Typically: + + * the inode number on Unix, + * the `file index + `_ on + Windows + + .. attribute:: st_dev + + Identifier of the device on which this file resides. + + .. attribute:: st_nlink + + Number of hard links. + + .. attribute:: st_uid + + User identifier of the file owner. + + .. attribute:: st_gid + + Group identifier of the file owner. + + .. attribute:: st_size + + Size of the file in bytes, if it is a regular file or a symbolic link. + The size of a symbolic link is the length of the pathname it contains, + without a terminating null byte. + + Timestamps: + + .. attribute:: st_atime + + Time of most recent access expressed in seconds. + + .. attribute:: st_mtime + + Time of most recent content modification expressed in seconds. + + .. attribute:: st_ctime + + Platform dependent: + + * the time of most recent metadata change on Unix, + * the time of creation on Windows, expressed in seconds. + + .. attribute:: st_atime_ns + + Time of most recent access expressed in nanoseconds as an integer. + + .. attribute:: st_mtime_ns + + Time of most recent content modification expressed in nanoseconds as an + integer. + + .. attribute:: st_ctime_ns + + Platform dependent: + + * the time of most recent metadata change on Unix, + * the time of creation on Windows, expressed in nanoseconds as an + integer. + + .. note:: + + The exact meaning and resolution of the :attr:`st_atime`, + :attr:`st_mtime`, and :attr:`st_ctime` attributes depend on the operating + system and the file system. For example, on Windows systems using the FAT + or FAT32 file systems, :attr:`st_mtime` has 2-second resolution, and + :attr:`st_atime` has only 1-day resolution. See your operating system + documentation for details. + + Similarly, although :attr:`st_atime_ns`, :attr:`st_mtime_ns`, + and :attr:`st_ctime_ns` are always expressed in nanoseconds, many + systems do not provide nanosecond precision. On systems that do + provide nanosecond precision, the floating-point object used to + store :attr:`st_atime`, :attr:`st_mtime`, and :attr:`st_ctime` + cannot preserve all of it, and as such will be slightly inexact. + If you need the exact timestamps you should always use + :attr:`st_atime_ns`, :attr:`st_mtime_ns`, and :attr:`st_ctime_ns`. + + On some Unix systems (such as Linux), the following attributes may also be + available: + + .. attribute:: st_blocks + + Number of 512-byte blocks allocated for file. + This may be smaller than :attr:`st_size`/512 when the file has holes. + + .. attribute:: st_blksize + + "Preferred" blocksize for efficient file system I/O. Writing to a file in + smaller chunks may cause an inefficient read-modify-rewrite. + + .. attribute:: st_rdev + + Type of device if an inode device. + + .. attribute:: st_flags + + User defined flags for file. + + On other Unix systems (such as FreeBSD), the following attributes may be + available (but may be only filled out if root tries to use them): + + .. attribute:: st_gen + + File generation number. + + .. attribute:: st_birthtime + + Time of file creation. + + On Solaris and derivatives, the following attributes may also be + available: + + .. attribute:: st_fstype + + String that uniquely identifies the type of the filesystem that + contains the file. + + On Mac OS systems, the following attributes may also be available: + + .. attribute:: st_rsize + + Real size of the file. + + .. attribute:: st_creator + + Creator of the file. + + .. attribute:: st_type + + File type. + + On Windows systems, the following attribute is also available: + + .. attribute:: st_file_attributes + + Windows file attributes: ``dwFileAttributes`` member of the + ``BY_HANDLE_FILE_INFORMATION`` structure returned by + :c:func:`GetFileInformationByHandle`. See the ``FILE_ATTRIBUTE_*`` + constants in the :mod:`stat` module. + + The standard module :mod:`stat` defines functions and constants that are + useful for extracting information from a :c:type:`stat` structure. (On + Windows, some items are filled with dummy values.) + + For backward compatibility, a :class:`stat_result` instance is also + accessible as a tuple of at least 10 integers giving the most important (and + portable) members of the :c:type:`stat` structure, in the order + :attr:`st_mode`, :attr:`st_ino`, :attr:`st_dev`, :attr:`st_nlink`, + :attr:`st_uid`, :attr:`st_gid`, :attr:`st_size`, :attr:`st_atime`, + :attr:`st_mtime`, :attr:`st_ctime`. More items may be added at the end by + some implementations. For compatibility with older Python versions, + accessing :class:`stat_result` as a tuple always returns integers. + + .. versionadded:: 3.3 + Added the :attr:`st_atime_ns`, :attr:`st_mtime_ns`, and + :attr:`st_ctime_ns` members. + + .. versionadded:: 3.5 + Added the :attr:`st_file_attributes` member on Windows. + + .. versionchanged:: 3.5 + Windows now returns the file index as :attr:`st_ino` when + available. + + .. versionadded:: 3.7 + Added the :attr:`st_fstype` member to Solaris/derivatives. + +.. function:: statvfs(path) + + Perform a :c:func:`statvfs` system call on the given path. The return value is + an object whose attributes describe the filesystem on the given path, and + correspond to the members of the :c:type:`statvfs` structure, namely: + :attr:`f_bsize`, :attr:`f_frsize`, :attr:`f_blocks`, :attr:`f_bfree`, + :attr:`f_bavail`, :attr:`f_files`, :attr:`f_ffree`, :attr:`f_favail`, + :attr:`f_flag`, :attr:`f_namemax`, :attr:`f_fsid`. + + Two module-level constants are defined for the :attr:`f_flag` attribute's + bit-flags: if :const:`ST_RDONLY` is set, the filesystem is mounted + read-only, and if :const:`ST_NOSUID` is set, the semantics of + setuid/setgid bits are disabled or not supported. + + Additional module-level constants are defined for GNU/glibc based systems. + These are :const:`ST_NODEV` (disallow access to device special files), + :const:`ST_NOEXEC` (disallow program execution), :const:`ST_SYNCHRONOUS` + (writes are synced at once), :const:`ST_MANDLOCK` (allow mandatory locks on an FS), + :const:`ST_WRITE` (write on file/directory/symlink), :const:`ST_APPEND` + (append-only file), :const:`ST_IMMUTABLE` (immutable file), :const:`ST_NOATIME` + (do not update access times), :const:`ST_NODIRATIME` (do not update directory access + times), :const:`ST_RELATIME` (update atime relative to mtime/ctime). + + This function can support :ref:`specifying a file descriptor `. + + .. availability:: Unix. + + .. versionchanged:: 3.2 + The :const:`ST_RDONLY` and :const:`ST_NOSUID` constants were added. + + .. versionadded:: 3.3 + Added support for specifying an open file descriptor for *path*. + + .. versionchanged:: 3.4 + The :const:`ST_NODEV`, :const:`ST_NOEXEC`, :const:`ST_SYNCHRONOUS`, + :const:`ST_MANDLOCK`, :const:`ST_WRITE`, :const:`ST_APPEND`, + :const:`ST_IMMUTABLE`, :const:`ST_NOATIME`, :const:`ST_NODIRATIME`, + and :const:`ST_RELATIME` constants were added. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + .. versionadded:: 3.7 + Added :attr:`f_fsid`. + + +.. data:: supports_dir_fd + + A :class:`~collections.abc.Set` object indicating which functions in the + :mod:`os` module permit use of their *dir_fd* parameter. Different platforms + provide different functionality, and an option that might work on one might + be unsupported on another. For consistency's sakes, functions that support + *dir_fd* always allow specifying the parameter, but will raise an exception + if the functionality is not actually available. + + To check whether a particular function permits use of its *dir_fd* + parameter, use the ``in`` operator on ``supports_dir_fd``. As an example, + this expression determines whether the *dir_fd* parameter of :func:`os.stat` + is locally available:: + + os.stat in os.supports_dir_fd + + Currently *dir_fd* parameters only work on Unix platforms; none of them work + on Windows. + + .. versionadded:: 3.3 + + +.. data:: supports_effective_ids + + A :class:`~collections.abc.Set` object indicating which functions in the + :mod:`os` module permit use of the *effective_ids* parameter for + :func:`os.access`. If the local platform supports it, the collection will + contain :func:`os.access`, otherwise it will be empty. + + To check whether you can use the *effective_ids* parameter for + :func:`os.access`, use the ``in`` operator on ``supports_effective_ids``, + like so:: + + os.access in os.supports_effective_ids + + Currently *effective_ids* only works on Unix platforms; it does not work on + Windows. + + .. versionadded:: 3.3 + + +.. data:: supports_fd + + A :class:`~collections.abc.Set` object indicating which functions in the + :mod:`os` module permit specifying their *path* parameter as an open file + descriptor. Different platforms provide different functionality, and an + option that might work on one might be unsupported on another. For + consistency's sakes, functions that support *fd* always allow specifying + the parameter, but will raise an exception if the functionality is not + actually available. + + To check whether a particular function permits specifying an open file + descriptor for its *path* parameter, use the ``in`` operator on + ``supports_fd``. As an example, this expression determines whether + :func:`os.chdir` accepts open file descriptors when called on your local + platform:: + + os.chdir in os.supports_fd + + .. versionadded:: 3.3 + + +.. data:: supports_follow_symlinks + + A :class:`~collections.abc.Set` object indicating which functions in the + :mod:`os` module permit use of their *follow_symlinks* parameter. Different + platforms provide different functionality, and an option that might work on + one might be unsupported on another. For consistency's sakes, functions that + support *follow_symlinks* always allow specifying the parameter, but will + raise an exception if the functionality is not actually available. + + To check whether a particular function permits use of its *follow_symlinks* + parameter, use the ``in`` operator on ``supports_follow_symlinks``. As an + example, this expression determines whether the *follow_symlinks* parameter + of :func:`os.stat` is locally available:: + + os.stat in os.supports_follow_symlinks + + .. versionadded:: 3.3 + + +.. function:: symlink(src, dst, target_is_directory=False, *, dir_fd=None) + + Create a symbolic link pointing to *src* named *dst*. + + On Windows, a symlink represents either a file or a directory, and does not + morph to the target dynamically. If the target is present, the type of the + symlink will be created to match. Otherwise, the symlink will be created + as a directory if *target_is_directory* is ``True`` or a file symlink (the + default) otherwise. On non-Windows platforms, *target_is_directory* is ignored. + + Symbolic link support was introduced in Windows 6.0 (Vista). :func:`symlink` + will raise a :exc:`NotImplementedError` on Windows versions earlier than 6.0. + + This function can support :ref:`paths relative to directory descriptors + `. + + .. note:: + + On Windows, the *SeCreateSymbolicLinkPrivilege* is required in order to + successfully create symlinks. This privilege is not typically granted to + regular users but is available to accounts which can escalate privileges + to the administrator level. Either obtaining the privilege or running your + application as an administrator are ways to successfully create symlinks. + + + :exc:`OSError` is raised when the function is called by an unprivileged + user. + + .. availability:: Unix, Windows. + + .. versionchanged:: 3.2 + Added support for Windows 6.0 (Vista) symbolic links. + + .. versionadded:: 3.3 + Added the *dir_fd* argument, and now allow *target_is_directory* + on non-Windows platforms. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object` for *src* and *dst*. + + +.. function:: sync() + + Force write of everything to disk. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. function:: truncate(path, length) + + Truncate the file corresponding to *path*, so that it is at most + *length* bytes in size. + + This function can support :ref:`specifying a file descriptor `. + + .. availability:: Unix, Windows. + + .. versionadded:: 3.3 + + .. versionchanged:: 3.5 + Added support for Windows + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: unlink(path, *, dir_fd=None) + + Remove (delete) the file *path*. This function is semantically + identical to :func:`remove`; the ``unlink`` name is its + traditional Unix name. Please see the documentation for + :func:`remove` for further information. + + .. versionadded:: 3.3 + The *dir_fd* parameter. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: utime(path, times=None, *[, ns], dir_fd=None, follow_symlinks=True) + + Set the access and modified times of the file specified by *path*. + + :func:`utime` takes two optional parameters, *times* and *ns*. + These specify the times set on *path* and are used as follows: + + - If *ns* is specified, + it must be a 2-tuple of the form ``(atime_ns, mtime_ns)`` + where each member is an int expressing nanoseconds. + - If *times* is not ``None``, + it must be a 2-tuple of the form ``(atime, mtime)`` + where each member is an int or float expressing seconds. + - If *times* is ``None`` and *ns* is unspecified, + this is equivalent to specifying ``ns=(atime_ns, mtime_ns)`` + where both times are the current time. + + It is an error to specify tuples for both *times* and *ns*. + + Whether a directory can be given for *path* + depends on whether the operating system implements directories as files + (for example, Windows does not). Note that the exact times you set here may + not be returned by a subsequent :func:`~os.stat` call, depending on the + resolution with which your operating system records access and modification + times; see :func:`~os.stat`. The best way to preserve exact times is to + use the *st_atime_ns* and *st_mtime_ns* fields from the :func:`os.stat` + result object with the *ns* parameter to `utime`. + + This function can support :ref:`specifying a file descriptor `, + :ref:`paths relative to directory descriptors ` and :ref:`not + following symlinks `. + + .. versionadded:: 3.3 + Added support for specifying an open file descriptor for *path*, + and the *dir_fd*, *follow_symlinks*, and *ns* parameters. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: walk(top, topdown=True, onerror=None, followlinks=False) + + .. index:: + single: directory; walking + single: directory; traversal + + Generate the file names in a directory tree by walking the tree + either top-down or bottom-up. For each directory in the tree rooted at directory + *top* (including *top* itself), it yields a 3-tuple ``(dirpath, dirnames, + filenames)``. + + *dirpath* is a string, the path to the directory. *dirnames* is a list of the + names of the subdirectories in *dirpath* (excluding ``'.'`` and ``'..'``). + *filenames* is a list of the names of the non-directory files in *dirpath*. + Note that the names in the lists contain no path components. To get a full path + (which begins with *top*) to a file or directory in *dirpath*, do + ``os.path.join(dirpath, name)``. + + If optional argument *topdown* is ``True`` or not specified, the triple for a + directory is generated before the triples for any of its subdirectories + (directories are generated top-down). If *topdown* is ``False``, the triple + for a directory is generated after the triples for all of its subdirectories + (directories are generated bottom-up). No matter the value of *topdown*, the + list of subdirectories is retrieved before the tuples for the directory and + its subdirectories are generated. + + When *topdown* is ``True``, the caller can modify the *dirnames* list in-place + (perhaps using :keyword:`del` or slice assignment), and :func:`walk` will only + recurse into the subdirectories whose names remain in *dirnames*; this can be + used to prune the search, impose a specific order of visiting, or even to inform + :func:`walk` about directories the caller creates or renames before it resumes + :func:`walk` again. Modifying *dirnames* when *topdown* is ``False`` has + no effect on the behavior of the walk, because in bottom-up mode the directories + in *dirnames* are generated before *dirpath* itself is generated. + + By default, errors from the :func:`scandir` call are ignored. If optional + argument *onerror* is specified, it should be a function; it will be called with + one argument, an :exc:`OSError` instance. It can report the error to continue + with the walk, or raise the exception to abort the walk. Note that the filename + is available as the ``filename`` attribute of the exception object. + + By default, :func:`walk` will not walk down into symbolic links that resolve to + directories. Set *followlinks* to ``True`` to visit directories pointed to by + symlinks, on systems that support them. + + .. note:: + + Be aware that setting *followlinks* to ``True`` can lead to infinite + recursion if a link points to a parent directory of itself. :func:`walk` + does not keep track of the directories it visited already. + + .. note:: + + If you pass a relative pathname, don't change the current working directory + between resumptions of :func:`walk`. :func:`walk` never changes the current + directory, and assumes that its caller doesn't either. + + This example displays the number of bytes taken by non-directory files in each + directory under the starting directory, except that it doesn't look under any + CVS subdirectory:: + + import os + from os.path import join, getsize + for root, dirs, files in os.walk('python/Lib/email'): + print(root, "consumes", end=" ") + print(sum(getsize(join(root, name)) for name in files), end=" ") + print("bytes in", len(files), "non-directory files") + if 'CVS' in dirs: + dirs.remove('CVS') # don't visit CVS directories + + In the next example (simple implementation of :func:`shutil.rmtree`), + walking the tree bottom-up is essential, :func:`rmdir` doesn't allow + deleting a directory before the directory is empty:: + + # Delete everything reachable from the directory named in "top", + # assuming there are no symbolic links. + # CAUTION: This is dangerous! For example, if top == '/', it + # could delete all your disk files. + import os + for root, dirs, files in os.walk(top, topdown=False): + for name in files: + os.remove(os.path.join(root, name)) + for name in dirs: + os.rmdir(os.path.join(root, name)) + + .. versionchanged:: 3.5 + This function now calls :func:`os.scandir` instead of :func:`os.listdir`, + making it faster by reducing the number of calls to :func:`os.stat`. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: fwalk(top='.', topdown=True, onerror=None, *, follow_symlinks=False, dir_fd=None) + + .. index:: + single: directory; walking + single: directory; traversal + + This behaves exactly like :func:`walk`, except that it yields a 4-tuple + ``(dirpath, dirnames, filenames, dirfd)``, and it supports ``dir_fd``. + + *dirpath*, *dirnames* and *filenames* are identical to :func:`walk` output, + and *dirfd* is a file descriptor referring to the directory *dirpath*. + + This function always supports :ref:`paths relative to directory descriptors + ` and :ref:`not following symlinks `. Note however + that, unlike other functions, the :func:`fwalk` default value for + *follow_symlinks* is ``False``. + + .. note:: + + Since :func:`fwalk` yields file descriptors, those are only valid until + the next iteration step, so you should duplicate them (e.g. with + :func:`dup`) if you want to keep them longer. + + This example displays the number of bytes taken by non-directory files in each + directory under the starting directory, except that it doesn't look under any + CVS subdirectory:: + + import os + for root, dirs, files, rootfd in os.fwalk('python/Lib/email'): + print(root, "consumes", end="") + print(sum([os.stat(name, dir_fd=rootfd).st_size for name in files]), + end="") + print("bytes in", len(files), "non-directory files") + if 'CVS' in dirs: + dirs.remove('CVS') # don't visit CVS directories + + In the next example, walking the tree bottom-up is essential: + :func:`rmdir` doesn't allow deleting a directory before the directory is + empty:: + + # Delete everything reachable from the directory named in "top", + # assuming there are no symbolic links. + # CAUTION: This is dangerous! For example, if top == '/', it + # could delete all your disk files. + import os + for root, dirs, files, rootfd in os.fwalk(top, topdown=False): + for name in files: + os.unlink(name, dir_fd=rootfd) + for name in dirs: + os.rmdir(name, dir_fd=rootfd) + + .. availability:: Unix. + + .. versionadded:: 3.3 + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + .. versionchanged:: 3.7 + Added support for :class:`bytes` paths. + + +Linux extended attributes +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. versionadded:: 3.3 + +These functions are all available on Linux only. + +.. function:: getxattr(path, attribute, *, follow_symlinks=True) + + Return the value of the extended filesystem attribute *attribute* for + *path*. *attribute* can be bytes or str (directly or indirectly through the + :class:`PathLike` interface). If it is str, it is encoded with the filesystem + encoding. + + This function can support :ref:`specifying a file descriptor ` and + :ref:`not following symlinks `. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object` for *path* and *attribute*. + + +.. function:: listxattr(path=None, *, follow_symlinks=True) + + Return a list of the extended filesystem attributes on *path*. The + attributes in the list are represented as strings decoded with the filesystem + encoding. If *path* is ``None``, :func:`listxattr` will examine the current + directory. + + This function can support :ref:`specifying a file descriptor ` and + :ref:`not following symlinks `. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. function:: removexattr(path, attribute, *, follow_symlinks=True) + + Removes the extended filesystem attribute *attribute* from *path*. + *attribute* should be bytes or str (directly or indirectly through the + :class:`PathLike` interface). If it is a string, it is encoded + with the filesystem encoding. + + This function can support :ref:`specifying a file descriptor ` and + :ref:`not following symlinks `. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object` for *path* and *attribute*. + + +.. function:: setxattr(path, attribute, value, flags=0, *, follow_symlinks=True) + + Set the extended filesystem attribute *attribute* on *path* to *value*. + *attribute* must be a bytes or str with no embedded NULs (directly or + indirectly through the :class:`PathLike` interface). If it is a str, + it is encoded with the filesystem encoding. *flags* may be + :data:`XATTR_REPLACE` or :data:`XATTR_CREATE`. If :data:`XATTR_REPLACE` is + given and the attribute does not exist, ``EEXISTS`` will be raised. + If :data:`XATTR_CREATE` is given and the attribute already exists, the + attribute will not be created and ``ENODATA`` will be raised. + + This function can support :ref:`specifying a file descriptor ` and + :ref:`not following symlinks `. + + .. note:: + + A bug in Linux kernel versions less than 2.6.39 caused the flags argument + to be ignored on some filesystems. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object` for *path* and *attribute*. + + +.. data:: XATTR_SIZE_MAX + + The maximum size the value of an extended attribute can be. Currently, this + is 64 KiB on Linux. + + +.. data:: XATTR_CREATE + + This is a possible value for the flags argument in :func:`setxattr`. It + indicates the operation must create an attribute. + + +.. data:: XATTR_REPLACE + + This is a possible value for the flags argument in :func:`setxattr`. It + indicates the operation must replace an existing attribute. + + +.. _os-process: + +Process Management +------------------ + +These functions may be used to create and manage processes. + +The various :func:`exec\* ` functions take a list of arguments for the new +program loaded into the process. In each case, the first of these arguments is +passed to the new program as its own name rather than as an argument a user may +have typed on a command line. For the C programmer, this is the ``argv[0]`` +passed to a program's :c:func:`main`. For example, ``os.execv('/bin/echo', +['foo', 'bar'])`` will only print ``bar`` on standard output; ``foo`` will seem +to be ignored. + + +.. function:: abort() + + Generate a :const:`SIGABRT` signal to the current process. On Unix, the default + behavior is to produce a core dump; on Windows, the process immediately returns + an exit code of ``3``. Be aware that calling this function will not call the + Python signal handler registered for :const:`SIGABRT` with + :func:`signal.signal`. + + +.. function:: execl(path, arg0, arg1, ...) + execle(path, arg0, arg1, ..., env) + execlp(file, arg0, arg1, ...) + execlpe(file, arg0, arg1, ..., env) + execv(path, args) + execve(path, args, env) + execvp(file, args) + execvpe(file, args, env) + + These functions all execute a new program, replacing the current process; they + do not return. On Unix, the new executable is loaded into the current process, + and will have the same process id as the caller. Errors will be reported as + :exc:`OSError` exceptions. + + The current process is replaced immediately. Open file objects and + descriptors are not flushed, so if there may be data buffered + on these open files, you should flush them using + :func:`sys.stdout.flush` or :func:`os.fsync` before calling an + :func:`exec\* ` function. + + The "l" and "v" variants of the :func:`exec\* ` functions differ in how + command-line arguments are passed. The "l" variants are perhaps the easiest + to work with if the number of parameters is fixed when the code is written; the + individual parameters simply become additional parameters to the :func:`execl\*` + functions. The "v" variants are good when the number of parameters is + variable, with the arguments being passed in a list or tuple as the *args* + parameter. In either case, the arguments to the child process should start with + the name of the command being run, but this is not enforced. + + The variants which include a "p" near the end (:func:`execlp`, + :func:`execlpe`, :func:`execvp`, and :func:`execvpe`) will use the + :envvar:`PATH` environment variable to locate the program *file*. When the + environment is being replaced (using one of the :func:`exec\*e ` variants, + discussed in the next paragraph), the new environment is used as the source of + the :envvar:`PATH` variable. The other variants, :func:`execl`, :func:`execle`, + :func:`execv`, and :func:`execve`, will not use the :envvar:`PATH` variable to + locate the executable; *path* must contain an appropriate absolute or relative + path. + + For :func:`execle`, :func:`execlpe`, :func:`execve`, and :func:`execvpe` (note + that these all end in "e"), the *env* parameter must be a mapping which is + used to define the environment variables for the new process (these are used + instead of the current process' environment); the functions :func:`execl`, + :func:`execlp`, :func:`execv`, and :func:`execvp` all cause the new process to + inherit the environment of the current process. + + For :func:`execve` on some platforms, *path* may also be specified as an open + file descriptor. This functionality may not be supported on your platform; + you can check whether or not it is available using :data:`os.supports_fd`. + If it is unavailable, using it will raise a :exc:`NotImplementedError`. + + .. availability:: Unix, Windows. + + .. versionadded:: 3.3 + Added support for specifying an open file descriptor for *path* + for :func:`execve`. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + +.. function:: _exit(n) + + Exit the process with status *n*, without calling cleanup handlers, flushing + stdio buffers, etc. + + .. note:: + + The standard way to exit is ``sys.exit(n)``. :func:`_exit` should + normally only be used in the child process after a :func:`fork`. + +The following exit codes are defined and can be used with :func:`_exit`, +although they are not required. These are typically used for system programs +written in Python, such as a mail server's external command delivery program. + +.. note:: + + Some of these may not be available on all Unix platforms, since there is some + variation. These constants are defined where they are defined by the underlying + platform. + + +.. data:: EX_OK + + Exit code that means no error occurred. + + .. availability:: Unix. + + +.. data:: EX_USAGE + + Exit code that means the command was used incorrectly, such as when the wrong + number of arguments are given. + + .. availability:: Unix. + + +.. data:: EX_DATAERR + + Exit code that means the input data was incorrect. + + .. availability:: Unix. + + +.. data:: EX_NOINPUT + + Exit code that means an input file did not exist or was not readable. + + .. availability:: Unix. + + +.. data:: EX_NOUSER + + Exit code that means a specified user did not exist. + + .. availability:: Unix. + + +.. data:: EX_NOHOST + + Exit code that means a specified host did not exist. + + .. availability:: Unix. + + +.. data:: EX_UNAVAILABLE + + Exit code that means that a required service is unavailable. + + .. availability:: Unix. + + +.. data:: EX_SOFTWARE + + Exit code that means an internal software error was detected. + + .. availability:: Unix. + + +.. data:: EX_OSERR + + Exit code that means an operating system error was detected, such as the + inability to fork or create a pipe. + + .. availability:: Unix. + + +.. data:: EX_OSFILE + + Exit code that means some system file did not exist, could not be opened, or had + some other kind of error. + + .. availability:: Unix. + + +.. data:: EX_CANTCREAT + + Exit code that means a user specified output file could not be created. + + .. availability:: Unix. + + +.. data:: EX_IOERR + + Exit code that means that an error occurred while doing I/O on some file. + + .. availability:: Unix. + + +.. data:: EX_TEMPFAIL + + Exit code that means a temporary failure occurred. This indicates something + that may not really be an error, such as a network connection that couldn't be + made during a retryable operation. + + .. availability:: Unix. + + +.. data:: EX_PROTOCOL + + Exit code that means that a protocol exchange was illegal, invalid, or not + understood. + + .. availability:: Unix. + + +.. data:: EX_NOPERM + + Exit code that means that there were insufficient permissions to perform the + operation (but not intended for file system problems). + + .. availability:: Unix. + + +.. data:: EX_CONFIG + + Exit code that means that some kind of configuration error occurred. + + .. availability:: Unix. + + +.. data:: EX_NOTFOUND + + Exit code that means something like "an entry was not found". + + .. availability:: Unix. + + +.. function:: fork() + + Fork a child process. Return ``0`` in the child and the child's process id in the + parent. If an error occurs :exc:`OSError` is raised. + + Note that some platforms including FreeBSD <= 6.3 and Cygwin have + known issues when using fork() from a thread. + + .. warning:: + + See :mod:`ssl` for applications that use the SSL module with fork(). + + .. availability:: Unix. + + +.. function:: forkpty() + + Fork a child process, using a new pseudo-terminal as the child's controlling + terminal. Return a pair of ``(pid, fd)``, where *pid* is ``0`` in the child, the + new child's process id in the parent, and *fd* is the file descriptor of the + master end of the pseudo-terminal. For a more portable approach, use the + :mod:`pty` module. If an error occurs :exc:`OSError` is raised. + + .. availability:: some flavors of Unix. + + +.. function:: kill(pid, sig) + + .. index:: + single: process; killing + single: process; signalling + + Send signal *sig* to the process *pid*. Constants for the specific signals + available on the host platform are defined in the :mod:`signal` module. + + Windows: The :data:`signal.CTRL_C_EVENT` and + :data:`signal.CTRL_BREAK_EVENT` signals are special signals which can + only be sent to console processes which share a common console window, + e.g., some subprocesses. Any other value for *sig* will cause the process + to be unconditionally killed by the TerminateProcess API, and the exit code + will be set to *sig*. The Windows version of :func:`kill` additionally takes + process handles to be killed. + + See also :func:`signal.pthread_kill`. + + .. versionadded:: 3.2 + Windows support. + + +.. function:: killpg(pgid, sig) + + .. index:: + single: process; killing + single: process; signalling + + Send the signal *sig* to the process group *pgid*. + + .. availability:: Unix. + + +.. function:: nice(increment) + + Add *increment* to the process's "niceness". Return the new niceness. + + .. availability:: Unix. + + +.. function:: plock(op) + + Lock program segments into memory. The value of *op* (defined in + ````) determines which segments are locked. + + .. availability:: Unix. + + +.. function:: popen(cmd, mode='r', buffering=-1) + + Open a pipe to or from command *cmd*. + The return value is an open file object + connected to the pipe, which can be read or written depending on whether *mode* + is ``'r'`` (default) or ``'w'``. The *buffering* argument has the same meaning as + the corresponding argument to the built-in :func:`open` function. The + returned file object reads or writes text strings rather than bytes. + + The ``close`` method returns :const:`None` if the subprocess exited + successfully, or the subprocess's return code if there was an + error. On POSIX systems, if the return code is positive it + represents the return value of the process left-shifted by one + byte. If the return code is negative, the process was terminated + by the signal given by the negated value of the return code. (For + example, the return value might be ``- signal.SIGKILL`` if the + subprocess was killed.) On Windows systems, the return value + contains the signed integer return code from the child process. + + This is implemented using :class:`subprocess.Popen`; see that class's + documentation for more powerful ways to manage and communicate with + subprocesses. + + +.. function:: register_at_fork(*, before=None, after_in_parent=None, \ + after_in_child=None) + + Register callables to be executed when a new child process is forked + using :func:`os.fork` or similar process cloning APIs. + The parameters are optional and keyword-only. + Each specifies a different call point. + + * *before* is a function called before forking a child process. + * *after_in_parent* is a function called from the parent process + after forking a child process. + * *after_in_child* is a function called from the child process. + + These calls are only made if control is expected to return to the + Python interpreter. A typical :mod:`subprocess` launch will not + trigger them as the child is not going to re-enter the interpreter. + + Functions registered for execution before forking are called in + reverse registration order. Functions registered for execution + after forking (either in the parent or in the child) are called + in registration order. + + Note that :c:func:`fork` calls made by third-party C code may not + call those functions, unless it explicitly calls :c:func:`PyOS_BeforeFork`, + :c:func:`PyOS_AfterFork_Parent` and :c:func:`PyOS_AfterFork_Child`. + + There is no way to unregister a function. + + .. availability:: Unix. + + .. versionadded:: 3.7 + + +.. function:: spawnl(mode, path, ...) + spawnle(mode, path, ..., env) + spawnlp(mode, file, ...) + spawnlpe(mode, file, ..., env) + spawnv(mode, path, args) + spawnve(mode, path, args, env) + spawnvp(mode, file, args) + spawnvpe(mode, file, args, env) + + Execute the program *path* in a new process. + + (Note that the :mod:`subprocess` module provides more powerful facilities for + spawning new processes and retrieving their results; using that module is + preferable to using these functions. Check especially the + :ref:`subprocess-replacements` section.) + + If *mode* is :const:`P_NOWAIT`, this function returns the process id of the new + process; if *mode* is :const:`P_WAIT`, returns the process's exit code if it + exits normally, or ``-signal``, where *signal* is the signal that killed the + process. On Windows, the process id will actually be the process handle, so can + be used with the :func:`waitpid` function. + + The "l" and "v" variants of the :func:`spawn\* ` functions differ in how + command-line arguments are passed. The "l" variants are perhaps the easiest + to work with if the number of parameters is fixed when the code is written; the + individual parameters simply become additional parameters to the + :func:`spawnl\*` functions. The "v" variants are good when the number of + parameters is variable, with the arguments being passed in a list or tuple as + the *args* parameter. In either case, the arguments to the child process must + start with the name of the command being run. + + The variants which include a second "p" near the end (:func:`spawnlp`, + :func:`spawnlpe`, :func:`spawnvp`, and :func:`spawnvpe`) will use the + :envvar:`PATH` environment variable to locate the program *file*. When the + environment is being replaced (using one of the :func:`spawn\*e ` variants, + discussed in the next paragraph), the new environment is used as the source of + the :envvar:`PATH` variable. The other variants, :func:`spawnl`, + :func:`spawnle`, :func:`spawnv`, and :func:`spawnve`, will not use the + :envvar:`PATH` variable to locate the executable; *path* must contain an + appropriate absolute or relative path. + + For :func:`spawnle`, :func:`spawnlpe`, :func:`spawnve`, and :func:`spawnvpe` + (note that these all end in "e"), the *env* parameter must be a mapping + which is used to define the environment variables for the new process (they are + used instead of the current process' environment); the functions + :func:`spawnl`, :func:`spawnlp`, :func:`spawnv`, and :func:`spawnvp` all cause + the new process to inherit the environment of the current process. Note that + keys and values in the *env* dictionary must be strings; invalid keys or + values will cause the function to fail, with a return value of ``127``. + + As an example, the following calls to :func:`spawnlp` and :func:`spawnvpe` are + equivalent:: + + import os + os.spawnlp(os.P_WAIT, 'cp', 'cp', 'index.html', '/dev/null') + + L = ['cp', 'index.html', '/dev/null'] + os.spawnvpe(os.P_WAIT, 'cp', L, os.environ) + + .. availability:: Unix, Windows. :func:`spawnlp`, :func:`spawnlpe`, :func:`spawnvp` + and :func:`spawnvpe` are not available on Windows. :func:`spawnle` and + :func:`spawnve` are not thread-safe on Windows; we advise you to use the + :mod:`subprocess` module instead. + + .. versionchanged:: 3.6 + Accepts a :term:`path-like object`. + + +.. data:: P_NOWAIT + P_NOWAITO + + Possible values for the *mode* parameter to the :func:`spawn\* ` family of + functions. If either of these values is given, the :func:`spawn\*` functions + will return as soon as the new process has been created, with the process id as + the return value. + + .. availability:: Unix, Windows. + + +.. data:: P_WAIT + + Possible value for the *mode* parameter to the :func:`spawn\* ` family of + functions. If this is given as *mode*, the :func:`spawn\*` functions will not + return until the new process has run to completion and will return the exit code + of the process the run is successful, or ``-signal`` if a signal kills the + process. + + .. availability:: Unix, Windows. + + +.. data:: P_DETACH + P_OVERLAY + + Possible values for the *mode* parameter to the :func:`spawn\* ` family of + functions. These are less portable than those listed above. :const:`P_DETACH` + is similar to :const:`P_NOWAIT`, but the new process is detached from the + console of the calling process. If :const:`P_OVERLAY` is used, the current + process will be replaced; the :func:`spawn\* ` function will not return. + + .. availability:: Windows. + + +.. function:: startfile(path[, operation]) + + Start a file with its associated application. + + When *operation* is not specified or ``'open'``, this acts like double-clicking + the file in Windows Explorer, or giving the file name as an argument to the + :program:`start` command from the interactive command shell: the file is opened + with whatever application (if any) its extension is associated. + + When another *operation* is given, it must be a "command verb" that specifies + what should be done with the file. Common verbs documented by Microsoft are + ``'print'`` and ``'edit'`` (to be used on files) as well as ``'explore'`` and + ``'find'`` (to be used on directories). + + :func:`startfile` returns as soon as the associated application is launched. + There is no option to wait for the application to close, and no way to retrieve + the application's exit status. The *path* parameter is relative to the current + directory. If you want to use an absolute path, make sure the first character + is not a slash (``'/'``); the underlying Win32 :c:func:`ShellExecute` function + doesn't work if it is. Use the :func:`os.path.normpath` function to ensure that + the path is properly encoded for Win32. + + To reduce interpreter startup overhead, the Win32 :c:func:`ShellExecute` + function is not resolved until this function is first called. If the function + cannot be resolved, :exc:`NotImplementedError` will be raised. + + .. availability:: Windows. + + +.. function:: system(command) + + Execute the command (a string) in a subshell. This is implemented by calling + the Standard C function :c:func:`system`, and has the same limitations. + Changes to :data:`sys.stdin`, etc. are not reflected in the environment of + the executed command. If *command* generates any output, it will be sent to + the interpreter standard output stream. + + On Unix, the return value is the exit status of the process encoded in the + format specified for :func:`wait`. Note that POSIX does not specify the + meaning of the return value of the C :c:func:`system` function, so the return + value of the Python function is system-dependent. + + On Windows, the return value is that returned by the system shell after + running *command*. The shell is given by the Windows environment variable + :envvar:`COMSPEC`: it is usually :program:`cmd.exe`, which returns the exit + status of the command run; on systems using a non-native shell, consult your + shell documentation. + + The :mod:`subprocess` module provides more powerful facilities for spawning + new processes and retrieving their results; using that module is preferable + to using this function. See the :ref:`subprocess-replacements` section in + the :mod:`subprocess` documentation for some helpful recipes. + + .. availability:: Unix, Windows. + + +.. function:: times() + + Returns the current global process times. + The return value is an object with five attributes: + + * :attr:`user` - user time + * :attr:`system` - system time + * :attr:`children_user` - user time of all child processes + * :attr:`children_system` - system time of all child processes + * :attr:`elapsed` - elapsed real time since a fixed point in the past + + For backwards compatibility, this object also behaves like a five-tuple + containing :attr:`user`, :attr:`system`, :attr:`children_user`, + :attr:`children_system`, and :attr:`elapsed` in that order. + + See the Unix manual page + :manpage:`times(2)` or the corresponding Windows Platform API documentation. + On Windows, only :attr:`user` and :attr:`system` are known; the other + attributes are zero. + + .. availability:: Unix, Windows. + + .. versionchanged:: 3.3 + Return type changed from a tuple to a tuple-like object + with named attributes. + + +.. function:: wait() + + Wait for completion of a child process, and return a tuple containing its pid + and exit status indication: a 16-bit number, whose low byte is the signal number + that killed the process, and whose high byte is the exit status (if the signal + number is zero); the high bit of the low byte is set if a core file was + produced. + + .. availability:: Unix. + +.. function:: waitid(idtype, id, options) + + Wait for the completion of one or more child processes. + *idtype* can be :data:`P_PID`, :data:`P_PGID` or :data:`P_ALL`. + *id* specifies the pid to wait on. + *options* is constructed from the ORing of one or more of :data:`WEXITED`, + :data:`WSTOPPED` or :data:`WCONTINUED` and additionally may be ORed with + :data:`WNOHANG` or :data:`WNOWAIT`. The return value is an object + representing the data contained in the :c:type:`siginfo_t` structure, namely: + :attr:`si_pid`, :attr:`si_uid`, :attr:`si_signo`, :attr:`si_status`, + :attr:`si_code` or ``None`` if :data:`WNOHANG` is specified and there are no + children in a waitable state. + + .. availability:: Unix. + + .. versionadded:: 3.3 + +.. data:: P_PID + P_PGID + P_ALL + + These are the possible values for *idtype* in :func:`waitid`. They affect + how *id* is interpreted. + + .. availability:: Unix. + + .. versionadded:: 3.3 + +.. data:: WEXITED + WSTOPPED + WNOWAIT + + Flags that can be used in *options* in :func:`waitid` that specify what + child signal to wait for. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. data:: CLD_EXITED + CLD_DUMPED + CLD_TRAPPED + CLD_CONTINUED + + These are the possible values for :attr:`si_code` in the result returned by + :func:`waitid`. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. function:: waitpid(pid, options) + + The details of this function differ on Unix and Windows. + + On Unix: Wait for completion of a child process given by process id *pid*, and + return a tuple containing its process id and exit status indication (encoded as + for :func:`wait`). The semantics of the call are affected by the value of the + integer *options*, which should be ``0`` for normal operation. + + If *pid* is greater than ``0``, :func:`waitpid` requests status information for + that specific process. If *pid* is ``0``, the request is for the status of any + child in the process group of the current process. If *pid* is ``-1``, the + request pertains to any child of the current process. If *pid* is less than + ``-1``, status is requested for any process in the process group ``-pid`` (the + absolute value of *pid*). + + An :exc:`OSError` is raised with the value of errno when the syscall + returns -1. + + On Windows: Wait for completion of a process given by process handle *pid*, and + return a tuple containing *pid*, and its exit status shifted left by 8 bits + (shifting makes cross-platform use of the function easier). A *pid* less than or + equal to ``0`` has no special meaning on Windows, and raises an exception. The + value of integer *options* has no effect. *pid* can refer to any process whose + id is known, not necessarily a child process. The :func:`spawn\* ` + functions called with :const:`P_NOWAIT` return suitable process handles. + + .. versionchanged:: 3.5 + If the system call is interrupted and the signal handler does not raise an + exception, the function now retries the system call instead of raising an + :exc:`InterruptedError` exception (see :pep:`475` for the rationale). + + +.. function:: wait3(options) + + Similar to :func:`waitpid`, except no process id argument is given and a + 3-element tuple containing the child's process id, exit status indication, + and resource usage information is returned. Refer to + :mod:`resource`.\ :func:`~resource.getrusage` for details on resource usage + information. The option argument is the same as that provided to + :func:`waitpid` and :func:`wait4`. + + .. availability:: Unix. + + +.. function:: wait4(pid, options) + + Similar to :func:`waitpid`, except a 3-element tuple, containing the child's + process id, exit status indication, and resource usage information is returned. + Refer to :mod:`resource`.\ :func:`~resource.getrusage` for details on + resource usage information. The arguments to :func:`wait4` are the same + as those provided to :func:`waitpid`. + + .. availability:: Unix. + + +.. data:: WNOHANG + + The option for :func:`waitpid` to return immediately if no child process status + is available immediately. The function returns ``(0, 0)`` in this case. + + .. availability:: Unix. + + +.. data:: WCONTINUED + + This option causes child processes to be reported if they have been continued + from a job control stop since their status was last reported. + + .. availability:: some Unix systems. + + +.. data:: WUNTRACED + + This option causes child processes to be reported if they have been stopped but + their current state has not been reported since they were stopped. + + .. availability:: Unix. + + +The following functions take a process status code as returned by +:func:`system`, :func:`wait`, or :func:`waitpid` as a parameter. They may be +used to determine the disposition of a process. + +.. function:: WCOREDUMP(status) + + Return ``True`` if a core dump was generated for the process, otherwise + return ``False``. + + .. availability:: Unix. + + +.. function:: WIFCONTINUED(status) + + Return ``True`` if the process has been continued from a job control stop, + otherwise return ``False``. + + .. availability:: Unix. + + +.. function:: WIFSTOPPED(status) + + Return ``True`` if the process has been stopped, otherwise return + ``False``. + + .. availability:: Unix. + + +.. function:: WIFSIGNALED(status) + + Return ``True`` if the process exited due to a signal, otherwise return + ``False``. + + .. availability:: Unix. + + +.. function:: WIFEXITED(status) + + Return ``True`` if the process exited using the :manpage:`exit(2)` system call, + otherwise return ``False``. + + .. availability:: Unix. + + +.. function:: WEXITSTATUS(status) + + If ``WIFEXITED(status)`` is true, return the integer parameter to the + :manpage:`exit(2)` system call. Otherwise, the return value is meaningless. + + .. availability:: Unix. + + +.. function:: WSTOPSIG(status) + + Return the signal which caused the process to stop. + + .. availability:: Unix. + + +.. function:: WTERMSIG(status) + + Return the signal which caused the process to exit. + + .. availability:: Unix. + + +Interface to the scheduler +-------------------------- + +These functions control how a process is allocated CPU time by the operating +system. They are only available on some Unix platforms. For more detailed +information, consult your Unix manpages. + +.. versionadded:: 3.3 + +The following scheduling policies are exposed if they are supported by the +operating system. + +.. data:: SCHED_OTHER + + The default scheduling policy. + +.. data:: SCHED_BATCH + + Scheduling policy for CPU-intensive processes that tries to preserve + interactivity on the rest of the computer. + +.. data:: SCHED_IDLE + + Scheduling policy for extremely low priority background tasks. + +.. data:: SCHED_SPORADIC + + Scheduling policy for sporadic server programs. + +.. data:: SCHED_FIFO + + A First In First Out scheduling policy. + +.. data:: SCHED_RR + + A round-robin scheduling policy. + +.. data:: SCHED_RESET_ON_FORK + + This flag can be OR'ed with any other scheduling policy. When a process with + this flag set forks, its child's scheduling policy and priority are reset to + the default. + + +.. class:: sched_param(sched_priority) + + This class represents tunable scheduling parameters used in + :func:`sched_setparam`, :func:`sched_setscheduler`, and + :func:`sched_getparam`. It is immutable. + + At the moment, there is only one possible parameter: + + .. attribute:: sched_priority + + The scheduling priority for a scheduling policy. + + +.. function:: sched_get_priority_min(policy) + + Get the minimum priority value for *policy*. *policy* is one of the + scheduling policy constants above. + + +.. function:: sched_get_priority_max(policy) + + Get the maximum priority value for *policy*. *policy* is one of the + scheduling policy constants above. + + +.. function:: sched_setscheduler(pid, policy, param) + + Set the scheduling policy for the process with PID *pid*. A *pid* of 0 means + the calling process. *policy* is one of the scheduling policy constants + above. *param* is a :class:`sched_param` instance. + + +.. function:: sched_getscheduler(pid) + + Return the scheduling policy for the process with PID *pid*. A *pid* of 0 + means the calling process. The result is one of the scheduling policy + constants above. + + +.. function:: sched_setparam(pid, param) + + Set a scheduling parameters for the process with PID *pid*. A *pid* of 0 means + the calling process. *param* is a :class:`sched_param` instance. + + +.. function:: sched_getparam(pid) + + Return the scheduling parameters as a :class:`sched_param` instance for the + process with PID *pid*. A *pid* of 0 means the calling process. + + +.. function:: sched_rr_get_interval(pid) + + Return the round-robin quantum in seconds for the process with PID *pid*. A + *pid* of 0 means the calling process. + + +.. function:: sched_yield() + + Voluntarily relinquish the CPU. + + +.. function:: sched_setaffinity(pid, mask) + + Restrict the process with PID *pid* (or the current process if zero) to a + set of CPUs. *mask* is an iterable of integers representing the set of + CPUs to which the process should be restricted. + + +.. function:: sched_getaffinity(pid) + + Return the set of CPUs the process with PID *pid* (or the current process + if zero) is restricted to. + + +.. _os-path: + +Miscellaneous System Information +-------------------------------- + + +.. function:: confstr(name) + + Return string-valued system configuration values. *name* specifies the + configuration value to retrieve; it may be a string which is the name of a + defined system value; these names are specified in a number of standards (POSIX, + Unix 95, Unix 98, and others). Some platforms define additional names as well. + The names known to the host operating system are given as the keys of the + ``confstr_names`` dictionary. For configuration variables not included in that + mapping, passing an integer for *name* is also accepted. + + If the configuration value specified by *name* isn't defined, ``None`` is + returned. + + If *name* is a string and is not known, :exc:`ValueError` is raised. If a + specific value for *name* is not supported by the host system, even if it is + included in ``confstr_names``, an :exc:`OSError` is raised with + :const:`errno.EINVAL` for the error number. + + .. availability:: Unix. + + +.. data:: confstr_names + + Dictionary mapping names accepted by :func:`confstr` to the integer values + defined for those names by the host operating system. This can be used to + determine the set of names known to the system. + + .. availability:: Unix. + + +.. function:: cpu_count() + + Return the number of CPUs in the system. Returns ``None`` if undetermined. + + This number is not equivalent to the number of CPUs the current process can + use. The number of usable CPUs can be obtained with + ``len(os.sched_getaffinity(0))`` + + + .. versionadded:: 3.4 + + +.. function:: getloadavg() + + Return the number of processes in the system run queue averaged over the last + 1, 5, and 15 minutes or raises :exc:`OSError` if the load average was + unobtainable. + + .. availability:: Unix. + + +.. function:: sysconf(name) + + Return integer-valued system configuration values. If the configuration value + specified by *name* isn't defined, ``-1`` is returned. The comments regarding + the *name* parameter for :func:`confstr` apply here as well; the dictionary that + provides information on the known names is given by ``sysconf_names``. + + .. availability:: Unix. + + +.. data:: sysconf_names + + Dictionary mapping names accepted by :func:`sysconf` to the integer values + defined for those names by the host operating system. This can be used to + determine the set of names known to the system. + + .. availability:: Unix. + +The following data values are used to support path manipulation operations. These +are defined for all platforms. + +Higher-level operations on pathnames are defined in the :mod:`os.path` module. + + +.. index:: single: . (dot); in pathnames +.. data:: curdir + + The constant string used by the operating system to refer to the current + directory. This is ``'.'`` for Windows and POSIX. Also available via + :mod:`os.path`. + + +.. index:: single: ..; in pathnames +.. data:: pardir + + The constant string used by the operating system to refer to the parent + directory. This is ``'..'`` for Windows and POSIX. Also available via + :mod:`os.path`. + + +.. index:: single: / (slash); in pathnames +.. index:: single: \ (backslash); in pathnames (Windows) +.. data:: sep + + The character used by the operating system to separate pathname components. + This is ``'/'`` for POSIX and ``'\\'`` for Windows. Note that knowing this + is not sufficient to be able to parse or concatenate pathnames --- use + :func:`os.path.split` and :func:`os.path.join` --- but it is occasionally + useful. Also available via :mod:`os.path`. + + +.. index:: single: / (slash); in pathnames +.. data:: altsep + + An alternative character used by the operating system to separate pathname + components, or ``None`` if only one separator character exists. This is set to + ``'/'`` on Windows systems where ``sep`` is a backslash. Also available via + :mod:`os.path`. + + +.. index:: single: . (dot); in pathnames +.. data:: extsep + + The character which separates the base filename from the extension; for example, + the ``'.'`` in :file:`os.py`. Also available via :mod:`os.path`. + + +.. index:: single: : (colon); path separator (POSIX) + single: ; (semicolon) +.. data:: pathsep + + The character conventionally used by the operating system to separate search + path components (as in :envvar:`PATH`), such as ``':'`` for POSIX or ``';'`` for + Windows. Also available via :mod:`os.path`. + + +.. data:: defpath + + The default search path used by :func:`exec\*p\* ` and + :func:`spawn\*p\* ` if the environment doesn't have a ``'PATH'`` + key. Also available via :mod:`os.path`. + + +.. data:: linesep + + The string used to separate (or, rather, terminate) lines on the current + platform. This may be a single character, such as ``'\n'`` for POSIX, or + multiple characters, for example, ``'\r\n'`` for Windows. Do not use + *os.linesep* as a line terminator when writing files opened in text mode (the + default); use a single ``'\n'`` instead, on all platforms. + + +.. data:: devnull + + The file path of the null device. For example: ``'/dev/null'`` for + POSIX, ``'nul'`` for Windows. Also available via :mod:`os.path`. + +.. data:: RTLD_LAZY + RTLD_NOW + RTLD_GLOBAL + RTLD_LOCAL + RTLD_NODELETE + RTLD_NOLOAD + RTLD_DEEPBIND + + Flags for use with the :func:`~sys.setdlopenflags` and + :func:`~sys.getdlopenflags` functions. See the Unix manual page + :manpage:`dlopen(3)` for what the different flags mean. + + .. versionadded:: 3.3 + + +Random numbers +-------------- + + +.. function:: getrandom(size, flags=0) + + Get up to *size* random bytes. The function can return less bytes than + requested. + + These bytes can be used to seed user-space random number generators or for + cryptographic purposes. + + ``getrandom()`` relies on entropy gathered from device drivers and other + sources of environmental noise. Unnecessarily reading large quantities of + data will have a negative impact on other users of the ``/dev/random`` and + ``/dev/urandom`` devices. + + The flags argument is a bit mask that can contain zero or more of the + following values ORed together: :py:data:`os.GRND_RANDOM` and + :py:data:`GRND_NONBLOCK`. + + See also the `Linux getrandom() manual page + `_. + + .. availability:: Linux 3.17 and newer. + + .. versionadded:: 3.6 + +.. function:: urandom(size) + + Return a string of *size* random bytes suitable for cryptographic use. + + This function returns random bytes from an OS-specific randomness source. The + returned data should be unpredictable enough for cryptographic applications, + though its exact quality depends on the OS implementation. + + On Linux, if the ``getrandom()`` syscall is available, it is used in + blocking mode: block until the system urandom entropy pool is initialized + (128 bits of entropy are collected by the kernel). See the :pep:`524` for + the rationale. On Linux, the :func:`getrandom` function can be used to get + random bytes in non-blocking mode (using the :data:`GRND_NONBLOCK` flag) or + to poll until the system urandom entropy pool is initialized. + + On a Unix-like system, random bytes are read from the ``/dev/urandom`` + device. If the ``/dev/urandom`` device is not available or not readable, the + :exc:`NotImplementedError` exception is raised. + + On Windows, it will use ``CryptGenRandom()``. + + .. seealso:: + The :mod:`secrets` module provides higher level functions. For an + easy-to-use interface to the random number generator provided by your + platform, please see :class:`random.SystemRandom`. + + .. versionchanged:: 3.6.0 + On Linux, ``getrandom()`` is now used in blocking mode to increase the + security. + + .. versionchanged:: 3.5.2 + On Linux, if the ``getrandom()`` syscall blocks (the urandom entropy pool + is not initialized yet), fall back on reading ``/dev/urandom``. + + .. versionchanged:: 3.5 + On Linux 3.17 and newer, the ``getrandom()`` syscall is now used + when available. On OpenBSD 5.6 and newer, the C ``getentropy()`` + function is now used. These functions avoid the usage of an internal file + descriptor. + +.. data:: GRND_NONBLOCK + + By default, when reading from ``/dev/random``, :func:`getrandom` blocks if + no random bytes are available, and when reading from ``/dev/urandom``, it blocks + if the entropy pool has not yet been initialized. + + If the :py:data:`GRND_NONBLOCK` flag is set, then :func:`getrandom` does not + block in these cases, but instead immediately raises :exc:`BlockingIOError`. + + .. versionadded:: 3.6 + +.. data:: GRND_RANDOM + + If this bit is set, then random bytes are drawn from the + ``/dev/random`` pool instead of the ``/dev/urandom`` pool. + + .. versionadded:: 3.6 diff --git a/python-3.7.4-docs-html/_sources/library/ossaudiodev.rst.txt b/python-3.7.4-docs-html/_sources/library/ossaudiodev.rst.txt new file mode 100644 index 0000000..a7d3dac --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/ossaudiodev.rst.txt @@ -0,0 +1,448 @@ +:mod:`ossaudiodev` --- Access to OSS-compatible audio devices +============================================================= + +.. module:: ossaudiodev + :platform: Linux, FreeBSD + :synopsis: Access to OSS-compatible audio devices. + +-------------- + +This module allows you to access the OSS (Open Sound System) audio interface. +OSS is available for a wide range of open-source and commercial Unices, and is +the standard audio interface for Linux and recent versions of FreeBSD. + +.. Things will get more complicated for future Linux versions, since + ALSA is in the standard kernel as of 2.5.x. Presumably if you + use ALSA, you'll have to make sure its OSS compatibility layer + is active to use ossaudiodev, but you're going to need it for the vast + majority of Linux audio apps anyway. + + Sounds like things are also complicated for other BSDs. In response + to my python-dev query, Thomas Wouters said: + + > Likewise, googling shows OpenBSD also uses OSS/Free -- the commercial + > OSS installation manual tells you to remove references to OSS/Free from the + > kernel :) + + but Aleksander Piotrowsk actually has an OpenBSD box, and he quotes + from its : + > * WARNING! WARNING! + > * This is an OSS (Linux) audio emulator. + > * Use the Native NetBSD API for developing new code, and this + > * only for compiling Linux programs. + + There's also an ossaudio manpage on OpenBSD that explains things + further. Presumably NetBSD and OpenBSD have a different standard + audio interface. That's the great thing about standards, there are so + many to choose from ... ;-) + + This probably all warrants a footnote or two, but I don't understand + things well enough right now to write it! --GPW + +.. versionchanged:: 3.3 + Operations in this module now raise :exc:`OSError` where :exc:`IOError` + was raised. + + +.. seealso:: + + `Open Sound System Programmer's Guide `_ + the official documentation for the OSS C API + + The module defines a large number of constants supplied by the OSS device + driver; see ```` on either Linux or FreeBSD for a listing. + +:mod:`ossaudiodev` defines the following variables and functions: + + +.. exception:: OSSAudioError + + This exception is raised on certain errors. The argument is a string describing + what went wrong. + + (If :mod:`ossaudiodev` receives an error from a system call such as + :c:func:`open`, :c:func:`write`, or :c:func:`ioctl`, it raises :exc:`OSError`. + Errors detected directly by :mod:`ossaudiodev` result in :exc:`OSSAudioError`.) + + (For backwards compatibility, the exception class is also available as + ``ossaudiodev.error``.) + + +.. function:: open(mode) + open(device, mode) + + Open an audio device and return an OSS audio device object. This object + supports many file-like methods, such as :meth:`read`, :meth:`write`, and + :meth:`fileno` (although there are subtle differences between conventional Unix + read/write semantics and those of OSS audio devices). It also supports a number + of audio-specific methods; see below for the complete list of methods. + + *device* is the audio device filename to use. If it is not specified, this + module first looks in the environment variable :envvar:`AUDIODEV` for a device + to use. If not found, it falls back to :file:`/dev/dsp`. + + *mode* is one of ``'r'`` for read-only (record) access, ``'w'`` for + write-only (playback) access and ``'rw'`` for both. Since many sound cards + only allow one process to have the recorder or player open at a time, it is a + good idea to open the device only for the activity needed. Further, some + sound cards are half-duplex: they can be opened for reading or writing, but + not both at once. + + Note the unusual calling syntax: the *first* argument is optional, and the + second is required. This is a historical artifact for compatibility with the + older :mod:`linuxaudiodev` module which :mod:`ossaudiodev` supersedes. + + .. XXX it might also be motivated + by my unfounded-but-still-possibly-true belief that the default + audio device varies unpredictably across operating systems. -GW + + +.. function:: openmixer([device]) + + Open a mixer device and return an OSS mixer device object. *device* is the + mixer device filename to use. If it is not specified, this module first looks + in the environment variable :envvar:`MIXERDEV` for a device to use. If not + found, it falls back to :file:`/dev/mixer`. + + +.. _ossaudio-device-objects: + +Audio Device Objects +-------------------- + +Before you can write to or read from an audio device, you must call three +methods in the correct order: + +#. :meth:`setfmt` to set the output format + +#. :meth:`channels` to set the number of channels + +#. :meth:`speed` to set the sample rate + +Alternately, you can use the :meth:`setparameters` method to set all three audio +parameters at once. This is more convenient, but may not be as flexible in all +cases. + +The audio device objects returned by :func:`.open` define the following methods +and (read-only) attributes: + + +.. method:: oss_audio_device.close() + + Explicitly close the audio device. When you are done writing to or reading from + an audio device, you should explicitly close it. A closed device cannot be used + again. + + +.. method:: oss_audio_device.fileno() + + Return the file descriptor associated with the device. + + +.. method:: oss_audio_device.read(size) + + Read *size* bytes from the audio input and return them as a Python string. + Unlike most Unix device drivers, OSS audio devices in blocking mode (the + default) will block :func:`read` until the entire requested amount of data is + available. + + +.. method:: oss_audio_device.write(data) + + Write a :term:`bytes-like object` *data* to the audio device and return the + number of bytes written. If the audio device is in blocking mode (the + default), the entire data is always written (again, this is different from + usual Unix device semantics). If the device is in non-blocking mode, some + data may not be written---see :meth:`writeall`. + + .. versionchanged:: 3.5 + Writable :term:`bytes-like object` is now accepted. + + +.. method:: oss_audio_device.writeall(data) + + Write a :term:`bytes-like object` *data* to the audio device: waits until + the audio device is able to accept data, writes as much data as it will + accept, and repeats until *data* has been completely written. If the device + is in blocking mode (the default), this has the same effect as + :meth:`write`; :meth:`writeall` is only useful in non-blocking mode. Has + no return value, since the amount of data written is always equal to the + amount of data supplied. + + .. versionchanged:: 3.5 + Writable :term:`bytes-like object` is now accepted. + + +.. versionchanged:: 3.2 + Audio device objects also support the context management protocol, i.e. they can + be used in a :keyword:`with` statement. + + +The following methods each map to exactly one :c:func:`ioctl` system call. The +correspondence is obvious: for example, :meth:`setfmt` corresponds to the +``SNDCTL_DSP_SETFMT`` ioctl, and :meth:`sync` to ``SNDCTL_DSP_SYNC`` (this can +be useful when consulting the OSS documentation). If the underlying +:c:func:`ioctl` fails, they all raise :exc:`OSError`. + + +.. method:: oss_audio_device.nonblock() + + Put the device into non-blocking mode. Once in non-blocking mode, there is no + way to return it to blocking mode. + + +.. method:: oss_audio_device.getfmts() + + Return a bitmask of the audio output formats supported by the soundcard. Some + of the formats supported by OSS are: + + +-------------------------+---------------------------------------------+ + | Format | Description | + +=========================+=============================================+ + | :const:`AFMT_MU_LAW` | a logarithmic encoding (used by Sun ``.au`` | + | | files and :file:`/dev/audio`) | + +-------------------------+---------------------------------------------+ + | :const:`AFMT_A_LAW` | a logarithmic encoding | + +-------------------------+---------------------------------------------+ + | :const:`AFMT_IMA_ADPCM` | a 4:1 compressed format defined by the | + | | Interactive Multimedia Association | + +-------------------------+---------------------------------------------+ + | :const:`AFMT_U8` | Unsigned, 8-bit audio | + +-------------------------+---------------------------------------------+ + | :const:`AFMT_S16_LE` | Signed, 16-bit audio, little-endian byte | + | | order (as used by Intel processors) | + +-------------------------+---------------------------------------------+ + | :const:`AFMT_S16_BE` | Signed, 16-bit audio, big-endian byte order | + | | (as used by 68k, PowerPC, Sparc) | + +-------------------------+---------------------------------------------+ + | :const:`AFMT_S8` | Signed, 8 bit audio | + +-------------------------+---------------------------------------------+ + | :const:`AFMT_U16_LE` | Unsigned, 16-bit little-endian audio | + +-------------------------+---------------------------------------------+ + | :const:`AFMT_U16_BE` | Unsigned, 16-bit big-endian audio | + +-------------------------+---------------------------------------------+ + + Consult the OSS documentation for a full list of audio formats, and note that + most devices support only a subset of these formats. Some older devices only + support :const:`AFMT_U8`; the most common format used today is + :const:`AFMT_S16_LE`. + + +.. method:: oss_audio_device.setfmt(format) + + Try to set the current audio format to *format*---see :meth:`getfmts` for a + list. Returns the audio format that the device was set to, which may not be the + requested format. May also be used to return the current audio format---do this + by passing an "audio format" of :const:`AFMT_QUERY`. + + +.. method:: oss_audio_device.channels(nchannels) + + Set the number of output channels to *nchannels*. A value of 1 indicates + monophonic sound, 2 stereophonic. Some devices may have more than 2 channels, + and some high-end devices may not support mono. Returns the number of channels + the device was set to. + + +.. method:: oss_audio_device.speed(samplerate) + + Try to set the audio sampling rate to *samplerate* samples per second. Returns + the rate actually set. Most sound devices don't support arbitrary sampling + rates. Common rates are: + + +-------+-------------------------------------------+ + | Rate | Description | + +=======+===========================================+ + | 8000 | default rate for :file:`/dev/audio` | + +-------+-------------------------------------------+ + | 11025 | speech recording | + +-------+-------------------------------------------+ + | 22050 | | + +-------+-------------------------------------------+ + | 44100 | CD quality audio (at 16 bits/sample and 2 | + | | channels) | + +-------+-------------------------------------------+ + | 96000 | DVD quality audio (at 24 bits/sample) | + +-------+-------------------------------------------+ + + +.. method:: oss_audio_device.sync() + + Wait until the sound device has played every byte in its buffer. (This happens + implicitly when the device is closed.) The OSS documentation recommends closing + and re-opening the device rather than using :meth:`sync`. + + +.. method:: oss_audio_device.reset() + + Immediately stop playing or recording and return the device to a state where it + can accept commands. The OSS documentation recommends closing and re-opening + the device after calling :meth:`reset`. + + +.. method:: oss_audio_device.post() + + Tell the driver that there is likely to be a pause in the output, making it + possible for the device to handle the pause more intelligently. You might use + this after playing a spot sound effect, before waiting for user input, or before + doing disk I/O. + +The following convenience methods combine several ioctls, or one ioctl and some +simple calculations. + + +.. method:: oss_audio_device.setparameters(format, nchannels, samplerate[, strict=False]) + + Set the key audio sampling parameters---sample format, number of channels, and + sampling rate---in one method call. *format*, *nchannels*, and *samplerate* + should be as specified in the :meth:`setfmt`, :meth:`channels`, and + :meth:`speed` methods. If *strict* is true, :meth:`setparameters` checks to + see if each parameter was actually set to the requested value, and raises + :exc:`OSSAudioError` if not. Returns a tuple (*format*, *nchannels*, + *samplerate*) indicating the parameter values that were actually set by the + device driver (i.e., the same as the return values of :meth:`setfmt`, + :meth:`channels`, and :meth:`speed`). + + For example, :: + + (fmt, channels, rate) = dsp.setparameters(fmt, channels, rate) + + is equivalent to :: + + fmt = dsp.setfmt(fmt) + channels = dsp.channels(channels) + rate = dsp.rate(rate) + + +.. method:: oss_audio_device.bufsize() + + Returns the size of the hardware buffer, in samples. + + +.. method:: oss_audio_device.obufcount() + + Returns the number of samples that are in the hardware buffer yet to be played. + + +.. method:: oss_audio_device.obuffree() + + Returns the number of samples that could be queued into the hardware buffer to + be played without blocking. + +Audio device objects also support several read-only attributes: + + +.. attribute:: oss_audio_device.closed + + Boolean indicating whether the device has been closed. + + +.. attribute:: oss_audio_device.name + + String containing the name of the device file. + + +.. attribute:: oss_audio_device.mode + + The I/O mode for the file, either ``"r"``, ``"rw"``, or ``"w"``. + + +.. _mixer-device-objects: + +Mixer Device Objects +-------------------- + +The mixer object provides two file-like methods: + + +.. method:: oss_mixer_device.close() + + This method closes the open mixer device file. Any further attempts to use the + mixer after this file is closed will raise an :exc:`OSError`. + + +.. method:: oss_mixer_device.fileno() + + Returns the file handle number of the open mixer device file. + +.. versionchanged:: 3.2 + Mixer objects also support the context management protocol. + + +The remaining methods are specific to audio mixing: + + +.. method:: oss_mixer_device.controls() + + This method returns a bitmask specifying the available mixer controls ("Control" + being a specific mixable "channel", such as :const:`SOUND_MIXER_PCM` or + :const:`SOUND_MIXER_SYNTH`). This bitmask indicates a subset of all available + mixer controls---the :const:`SOUND_MIXER_\*` constants defined at module level. + To determine if, for example, the current mixer object supports a PCM mixer, use + the following Python code:: + + mixer=ossaudiodev.openmixer() + if mixer.controls() & (1 << ossaudiodev.SOUND_MIXER_PCM): + # PCM is supported + ... code ... + + For most purposes, the :const:`SOUND_MIXER_VOLUME` (master volume) and + :const:`SOUND_MIXER_PCM` controls should suffice---but code that uses the mixer + should be flexible when it comes to choosing mixer controls. On the Gravis + Ultrasound, for example, :const:`SOUND_MIXER_VOLUME` does not exist. + + +.. method:: oss_mixer_device.stereocontrols() + + Returns a bitmask indicating stereo mixer controls. If a bit is set, the + corresponding control is stereo; if it is unset, the control is either + monophonic or not supported by the mixer (use in combination with + :meth:`controls` to determine which). + + See the code example for the :meth:`controls` function for an example of getting + data from a bitmask. + + +.. method:: oss_mixer_device.reccontrols() + + Returns a bitmask specifying the mixer controls that may be used to record. See + the code example for :meth:`controls` for an example of reading from a bitmask. + + +.. method:: oss_mixer_device.get(control) + + Returns the volume of a given mixer control. The returned volume is a 2-tuple + ``(left_volume,right_volume)``. Volumes are specified as numbers from 0 + (silent) to 100 (full volume). If the control is monophonic, a 2-tuple is still + returned, but both volumes are the same. + + Raises :exc:`OSSAudioError` if an invalid control is specified, or + :exc:`OSError` if an unsupported control is specified. + + +.. method:: oss_mixer_device.set(control, (left, right)) + + Sets the volume for a given mixer control to ``(left,right)``. ``left`` and + ``right`` must be ints and between 0 (silent) and 100 (full volume). On + success, the new volume is returned as a 2-tuple. Note that this may not be + exactly the same as the volume specified, because of the limited resolution of + some soundcard's mixers. + + Raises :exc:`OSSAudioError` if an invalid mixer control was specified, or if the + specified volumes were out-of-range. + + +.. method:: oss_mixer_device.get_recsrc() + + This method returns a bitmask indicating which control(s) are currently being + used as a recording source. + + +.. method:: oss_mixer_device.set_recsrc(bitmask) + + Call this function to specify a recording source. Returns a bitmask indicating + the new recording source (or sources) if successful; raises :exc:`OSError` if an + invalid source was specified. To set the current recording source to the + microphone input:: + + mixer.setrecsrc (1 << ossaudiodev.SOUND_MIXER_MIC) diff --git a/python-3.7.4-docs-html/_sources/library/othergui.rst.txt b/python-3.7.4-docs-html/_sources/library/othergui.rst.txt new file mode 100644 index 0000000..4548459 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/othergui.rst.txt @@ -0,0 +1,56 @@ +.. _other-gui-packages: + +Other Graphical User Interface Packages +======================================= + +Major cross-platform (Windows, Mac OS X, Unix-like) GUI toolkits are +available for Python: + +.. seealso:: + + `PyGObject `_ + PyGObject provides introspection bindings for C libraries using + `GObject `_. One of + these libraries is the `GTK+ 3 `_ widget set. + GTK+ comes with many more widgets than Tkinter provides. An online + `Python GTK+ 3 Tutorial `_ + is available. + + `PyGTK `_ + PyGTK provides bindings for an older version + of the library, GTK+ 2. It provides an object oriented interface that + is slightly higher level than the C one. There are also bindings to + `GNOME `_. An online `tutorial + `_ is available. + + `PyQt `_ + PyQt is a :program:`sip`\ -wrapped binding to the Qt toolkit. Qt is an + extensive C++ GUI application development framework that is + available for Unix, Windows and Mac OS X. :program:`sip` is a tool + for generating bindings for C++ libraries as Python classes, and + is specifically designed for Python. + + `PySide `_ + PySide is a newer binding to the Qt toolkit, provided by Nokia. + Compared to PyQt, its licensing scheme is friendlier to non-open source + applications. + + `wxPython `_ + wxPython is a cross-platform GUI toolkit for Python that is built around + the popular `wxWidgets `_ (formerly wxWindows) + C++ toolkit. It provides a native look and feel for applications on + Windows, Mac OS X, and Unix systems by using each platform's native + widgets where ever possible, (GTK+ on Unix-like systems). In addition to + an extensive set of widgets, wxPython provides classes for online + documentation and context sensitive help, printing, HTML viewing, + low-level device context drawing, drag and drop, system clipboard access, + an XML-based resource format and more, including an ever growing library + of user-contributed modules. + +PyGTK, PyQt, and wxPython, all have a modern look and feel and more +widgets than Tkinter. In addition, there are many other GUI toolkits for +Python, both cross-platform, and platform-specific. See the `GUI Programming +`_ page in the Python Wiki for a +much more complete list, and also for links to documents where the +different GUI toolkits are compared. + diff --git a/python-3.7.4-docs-html/_sources/library/parser.rst.txt b/python-3.7.4-docs-html/_sources/library/parser.rst.txt new file mode 100644 index 0000000..a302681 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/parser.rst.txt @@ -0,0 +1,356 @@ +:mod:`parser` --- Access Python parse trees +=========================================== + +.. module:: parser + :synopsis: Access parse trees for Python source code. + +.. moduleauthor:: Fred L. Drake, Jr. +.. sectionauthor:: Fred L. Drake, Jr. + +.. Copyright 1995 Virginia Polytechnic Institute and State University and Fred + L. Drake, Jr. This copyright notice must be distributed on all copies, but + this document otherwise may be distributed as part of the Python + distribution. No fee may be charged for this document in any representation, + either on paper or electronically. This restriction does not affect other + elements in a distributed package in any way. + +.. index:: single: parsing; Python source code + +-------------- + +The :mod:`parser` module provides an interface to Python's internal parser and +byte-code compiler. The primary purpose for this interface is to allow Python +code to edit the parse tree of a Python expression and create executable code +from this. This is better than trying to parse and modify an arbitrary Python +code fragment as a string because parsing is performed in a manner identical to +the code forming the application. It is also faster. + +.. note:: + + From Python 2.5 onward, it's much more convenient to cut in at the Abstract + Syntax Tree (AST) generation and compilation stage, using the :mod:`ast` + module. + +There are a few things to note about this module which are important to making +use of the data structures created. This is not a tutorial on editing the parse +trees for Python code, but some examples of using the :mod:`parser` module are +presented. + +Most importantly, a good understanding of the Python grammar processed by the +internal parser is required. For full information on the language syntax, refer +to :ref:`reference-index`. The parser +itself is created from a grammar specification defined in the file +:file:`Grammar/Grammar` in the standard Python distribution. The parse trees +stored in the ST objects created by this module are the actual output from the +internal parser when created by the :func:`expr` or :func:`suite` functions, +described below. The ST objects created by :func:`sequence2st` faithfully +simulate those structures. Be aware that the values of the sequences which are +considered "correct" will vary from one version of Python to another as the +formal grammar for the language is revised. However, transporting code from one +Python version to another as source text will always allow correct parse trees +to be created in the target version, with the only restriction being that +migrating to an older version of the interpreter will not support more recent +language constructs. The parse trees are not typically compatible from one +version to another, whereas source code has always been forward-compatible. + +Each element of the sequences returned by :func:`st2list` or :func:`st2tuple` +has a simple form. Sequences representing non-terminal elements in the grammar +always have a length greater than one. The first element is an integer which +identifies a production in the grammar. These integers are given symbolic names +in the C header file :file:`Include/graminit.h` and the Python module +:mod:`symbol`. Each additional element of the sequence represents a component +of the production as recognized in the input string: these are always sequences +which have the same form as the parent. An important aspect of this structure +which should be noted is that keywords used to identify the parent node type, +such as the keyword :keyword:`if` in an :const:`if_stmt`, are included in the +node tree without any special treatment. For example, the :keyword:`!if` keyword +is represented by the tuple ``(1, 'if')``, where ``1`` is the numeric value +associated with all :const:`NAME` tokens, including variable and function names +defined by the user. In an alternate form returned when line number information +is requested, the same token might be represented as ``(1, 'if', 12)``, where +the ``12`` represents the line number at which the terminal symbol was found. + +Terminal elements are represented in much the same way, but without any child +elements and the addition of the source text which was identified. The example +of the :keyword:`if` keyword above is representative. The various types of +terminal symbols are defined in the C header file :file:`Include/token.h` and +the Python module :mod:`token`. + +The ST objects are not required to support the functionality of this module, +but are provided for three purposes: to allow an application to amortize the +cost of processing complex parse trees, to provide a parse tree representation +which conserves memory space when compared to the Python list or tuple +representation, and to ease the creation of additional modules in C which +manipulate parse trees. A simple "wrapper" class may be created in Python to +hide the use of ST objects. + +The :mod:`parser` module defines functions for a few distinct purposes. The +most important purposes are to create ST objects and to convert ST objects to +other representations such as parse trees and compiled code objects, but there +are also functions which serve to query the type of parse tree represented by an +ST object. + + +.. seealso:: + + Module :mod:`symbol` + Useful constants representing internal nodes of the parse tree. + + Module :mod:`token` + Useful constants representing leaf nodes of the parse tree and functions for + testing node values. + + +.. _creating-sts: + +Creating ST Objects +------------------- + +ST objects may be created from source code or from a parse tree. When creating +an ST object from source, different functions are used to create the ``'eval'`` +and ``'exec'`` forms. + + +.. function:: expr(source) + + The :func:`expr` function parses the parameter *source* as if it were an input + to ``compile(source, 'file.py', 'eval')``. If the parse succeeds, an ST object + is created to hold the internal parse tree representation, otherwise an + appropriate exception is raised. + + +.. function:: suite(source) + + The :func:`suite` function parses the parameter *source* as if it were an input + to ``compile(source, 'file.py', 'exec')``. If the parse succeeds, an ST object + is created to hold the internal parse tree representation, otherwise an + appropriate exception is raised. + + +.. function:: sequence2st(sequence) + + This function accepts a parse tree represented as a sequence and builds an + internal representation if possible. If it can validate that the tree conforms + to the Python grammar and all nodes are valid node types in the host version of + Python, an ST object is created from the internal representation and returned + to the called. If there is a problem creating the internal representation, or + if the tree cannot be validated, a :exc:`ParserError` exception is raised. An + ST object created this way should not be assumed to compile correctly; normal + exceptions raised by compilation may still be initiated when the ST object is + passed to :func:`compilest`. This may indicate problems not related to syntax + (such as a :exc:`MemoryError` exception), but may also be due to constructs such + as the result of parsing ``del f(0)``, which escapes the Python parser but is + checked by the bytecode compiler. + + Sequences representing terminal tokens may be represented as either two-element + lists of the form ``(1, 'name')`` or as three-element lists of the form ``(1, + 'name', 56)``. If the third element is present, it is assumed to be a valid + line number. The line number may be specified for any subset of the terminal + symbols in the input tree. + + +.. function:: tuple2st(sequence) + + This is the same function as :func:`sequence2st`. This entry point is + maintained for backward compatibility. + + +.. _converting-sts: + +Converting ST Objects +--------------------- + +ST objects, regardless of the input used to create them, may be converted to +parse trees represented as list- or tuple- trees, or may be compiled into +executable code objects. Parse trees may be extracted with or without line +numbering information. + + +.. function:: st2list(st, line_info=False, col_info=False) + + This function accepts an ST object from the caller in *st* and returns a + Python list representing the equivalent parse tree. The resulting list + representation can be used for inspection or the creation of a new parse tree in + list form. This function does not fail so long as memory is available to build + the list representation. If the parse tree will only be used for inspection, + :func:`st2tuple` should be used instead to reduce memory consumption and + fragmentation. When the list representation is required, this function is + significantly faster than retrieving a tuple representation and converting that + to nested lists. + + If *line_info* is true, line number information will be included for all + terminal tokens as a third element of the list representing the token. Note + that the line number provided specifies the line on which the token *ends*. + This information is omitted if the flag is false or omitted. + + +.. function:: st2tuple(st, line_info=False, col_info=False) + + This function accepts an ST object from the caller in *st* and returns a + Python tuple representing the equivalent parse tree. Other than returning a + tuple instead of a list, this function is identical to :func:`st2list`. + + If *line_info* is true, line number information will be included for all + terminal tokens as a third element of the list representing the token. This + information is omitted if the flag is false or omitted. + + +.. function:: compilest(st, filename='') + + .. index:: + builtin: exec + builtin: eval + + The Python byte compiler can be invoked on an ST object to produce code objects + which can be used as part of a call to the built-in :func:`exec` or :func:`eval` + functions. This function provides the interface to the compiler, passing the + internal parse tree from *st* to the parser, using the source file name + specified by the *filename* parameter. The default value supplied for *filename* + indicates that the source was an ST object. + + Compiling an ST object may result in exceptions related to compilation; an + example would be a :exc:`SyntaxError` caused by the parse tree for ``del f(0)``: + this statement is considered legal within the formal grammar for Python but is + not a legal language construct. The :exc:`SyntaxError` raised for this + condition is actually generated by the Python byte-compiler normally, which is + why it can be raised at this point by the :mod:`parser` module. Most causes of + compilation failure can be diagnosed programmatically by inspection of the parse + tree. + + +.. _querying-sts: + +Queries on ST Objects +--------------------- + +Two functions are provided which allow an application to determine if an ST was +created as an expression or a suite. Neither of these functions can be used to +determine if an ST was created from source code via :func:`expr` or +:func:`suite` or from a parse tree via :func:`sequence2st`. + + +.. function:: isexpr(st) + + .. index:: builtin: compile + + When *st* represents an ``'eval'`` form, this function returns true, otherwise + it returns false. This is useful, since code objects normally cannot be queried + for this information using existing built-in functions. Note that the code + objects created by :func:`compilest` cannot be queried like this either, and + are identical to those created by the built-in :func:`compile` function. + + +.. function:: issuite(st) + + This function mirrors :func:`isexpr` in that it reports whether an ST object + represents an ``'exec'`` form, commonly known as a "suite." It is not safe to + assume that this function is equivalent to ``not isexpr(st)``, as additional + syntactic fragments may be supported in the future. + + +.. _st-errors: + +Exceptions and Error Handling +----------------------------- + +The parser module defines a single exception, but may also pass other built-in +exceptions from other portions of the Python runtime environment. See each +function for information about the exceptions it can raise. + + +.. exception:: ParserError + + Exception raised when a failure occurs within the parser module. This is + generally produced for validation failures rather than the built-in + :exc:`SyntaxError` raised during normal parsing. The exception argument is + either a string describing the reason of the failure or a tuple containing a + sequence causing the failure from a parse tree passed to :func:`sequence2st` + and an explanatory string. Calls to :func:`sequence2st` need to be able to + handle either type of exception, while calls to other functions in the module + will only need to be aware of the simple string values. + +Note that the functions :func:`compilest`, :func:`expr`, and :func:`suite` may +raise exceptions which are normally raised by the parsing and compilation +process. These include the built in exceptions :exc:`MemoryError`, +:exc:`OverflowError`, :exc:`SyntaxError`, and :exc:`SystemError`. In these +cases, these exceptions carry all the meaning normally associated with them. +Refer to the descriptions of each function for detailed information. + + +.. _st-objects: + +ST Objects +---------- + +Ordered and equality comparisons are supported between ST objects. Pickling of +ST objects (using the :mod:`pickle` module) is also supported. + + +.. data:: STType + + The type of the objects returned by :func:`expr`, :func:`suite` and + :func:`sequence2st`. + +ST objects have the following methods: + + +.. method:: ST.compile(filename='') + + Same as ``compilest(st, filename)``. + + +.. method:: ST.isexpr() + + Same as ``isexpr(st)``. + + +.. method:: ST.issuite() + + Same as ``issuite(st)``. + + +.. method:: ST.tolist(line_info=False, col_info=False) + + Same as ``st2list(st, line_info, col_info)``. + + +.. method:: ST.totuple(line_info=False, col_info=False) + + Same as ``st2tuple(st, line_info, col_info)``. + + +Example: Emulation of :func:`compile` +------------------------------------- + +While many useful operations may take place between parsing and bytecode +generation, the simplest operation is to do nothing. For this purpose, using +the :mod:`parser` module to produce an intermediate data structure is equivalent +to the code :: + + >>> code = compile('a + 5', 'file.py', 'eval') + >>> a = 5 + >>> eval(code) + 10 + +The equivalent operation using the :mod:`parser` module is somewhat longer, and +allows the intermediate internal parse tree to be retained as an ST object:: + + >>> import parser + >>> st = parser.expr('a + 5') + >>> code = st.compile('file.py') + >>> a = 5 + >>> eval(code) + 10 + +An application which needs both ST and code objects can package this code into +readily available functions:: + + import parser + + def load_suite(source_string): + st = parser.suite(source_string) + return st, st.compile() + + def load_expression(source_string): + st = parser.expr(source_string) + return st, st.compile() diff --git a/python-3.7.4-docs-html/_sources/library/pathlib.rst.txt b/python-3.7.4-docs-html/_sources/library/pathlib.rst.txt new file mode 100644 index 0000000..5b2df3f --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/pathlib.rst.txt @@ -0,0 +1,1114 @@ + +:mod:`pathlib` --- Object-oriented filesystem paths +=================================================== + +.. module:: pathlib + :synopsis: Object-oriented filesystem paths + +.. versionadded:: 3.4 + +**Source code:** :source:`Lib/pathlib.py` + +.. index:: single: path; operations + +-------------- + +This module offers classes representing filesystem paths with semantics +appropriate for different operating systems. Path classes are divided +between :ref:`pure paths `, which provide purely computational +operations without I/O, and :ref:`concrete paths `, which +inherit from pure paths but also provide I/O operations. + +.. image:: pathlib-inheritance.png + :align: center + +If you've never used this module before or just aren't sure which class is +right for your task, :class:`Path` is most likely what you need. It instantiates +a :ref:`concrete path ` for the platform the code is running on. + +Pure paths are useful in some special cases; for example: + +#. If you want to manipulate Windows paths on a Unix machine (or vice versa). + You cannot instantiate a :class:`WindowsPath` when running on Unix, but you + can instantiate :class:`PureWindowsPath`. +#. You want to make sure that your code only manipulates paths without actually + accessing the OS. In this case, instantiating one of the pure classes may be + useful since those simply don't have any OS-accessing operations. + +.. seealso:: + :pep:`428`: The pathlib module -- object-oriented filesystem paths. + +.. seealso:: + For low-level path manipulation on strings, you can also use the + :mod:`os.path` module. + + +Basic use +--------- + +Importing the main class:: + + >>> from pathlib import Path + +Listing subdirectories:: + + >>> p = Path('.') + >>> [x for x in p.iterdir() if x.is_dir()] + [PosixPath('.hg'), PosixPath('docs'), PosixPath('dist'), + PosixPath('__pycache__'), PosixPath('build')] + +Listing Python source files in this directory tree:: + + >>> list(p.glob('**/*.py')) + [PosixPath('test_pathlib.py'), PosixPath('setup.py'), + PosixPath('pathlib.py'), PosixPath('docs/conf.py'), + PosixPath('build/lib/pathlib.py')] + +Navigating inside a directory tree:: + + >>> p = Path('/etc') + >>> q = p / 'init.d' / 'reboot' + >>> q + PosixPath('/etc/init.d/reboot') + >>> q.resolve() + PosixPath('/etc/rc.d/init.d/halt') + +Querying path properties:: + + >>> q.exists() + True + >>> q.is_dir() + False + +Opening a file:: + + >>> with q.open() as f: f.readline() + ... + '#!/bin/bash\n' + + +.. _pure-paths: + +Pure paths +---------- + +Pure path objects provide path-handling operations which don't actually +access a filesystem. There are three ways to access these classes, which +we also call *flavours*: + +.. class:: PurePath(*pathsegments) + + A generic class that represents the system's path flavour (instantiating + it creates either a :class:`PurePosixPath` or a :class:`PureWindowsPath`):: + + >>> PurePath('setup.py') # Running on a Unix machine + PurePosixPath('setup.py') + + Each element of *pathsegments* can be either a string representing a + path segment, an object implementing the :class:`os.PathLike` interface + which returns a string, or another path object:: + + >>> PurePath('foo', 'some/path', 'bar') + PurePosixPath('foo/some/path/bar') + >>> PurePath(Path('foo'), Path('bar')) + PurePosixPath('foo/bar') + + When *pathsegments* is empty, the current directory is assumed:: + + >>> PurePath() + PurePosixPath('.') + + When several absolute paths are given, the last is taken as an anchor + (mimicking :func:`os.path.join`'s behaviour):: + + >>> PurePath('/etc', '/usr', 'lib64') + PurePosixPath('/usr/lib64') + >>> PureWindowsPath('c:/Windows', 'd:bar') + PureWindowsPath('d:bar') + + However, in a Windows path, changing the local root doesn't discard the + previous drive setting:: + + >>> PureWindowsPath('c:/Windows', '/Program Files') + PureWindowsPath('c:/Program Files') + + Spurious slashes and single dots are collapsed, but double dots (``'..'``) + are not, since this would change the meaning of a path in the face of + symbolic links:: + + >>> PurePath('foo//bar') + PurePosixPath('foo/bar') + >>> PurePath('foo/./bar') + PurePosixPath('foo/bar') + >>> PurePath('foo/../bar') + PurePosixPath('foo/../bar') + + (a naïve approach would make ``PurePosixPath('foo/../bar')`` equivalent + to ``PurePosixPath('bar')``, which is wrong if ``foo`` is a symbolic link + to another directory) + + Pure path objects implement the :class:`os.PathLike` interface, allowing them + to be used anywhere the interface is accepted. + + .. versionchanged:: 3.6 + Added support for the :class:`os.PathLike` interface. + +.. class:: PurePosixPath(*pathsegments) + + A subclass of :class:`PurePath`, this path flavour represents non-Windows + filesystem paths:: + + >>> PurePosixPath('/etc') + PurePosixPath('/etc') + + *pathsegments* is specified similarly to :class:`PurePath`. + +.. class:: PureWindowsPath(*pathsegments) + + A subclass of :class:`PurePath`, this path flavour represents Windows + filesystem paths:: + + >>> PureWindowsPath('c:/Program Files/') + PureWindowsPath('c:/Program Files') + + *pathsegments* is specified similarly to :class:`PurePath`. + +Regardless of the system you're running on, you can instantiate all of +these classes, since they don't provide any operation that does system calls. + + +General properties +^^^^^^^^^^^^^^^^^^ + +Paths are immutable and hashable. Paths of a same flavour are comparable +and orderable. These properties respect the flavour's case-folding +semantics:: + + >>> PurePosixPath('foo') == PurePosixPath('FOO') + False + >>> PureWindowsPath('foo') == PureWindowsPath('FOO') + True + >>> PureWindowsPath('FOO') in { PureWindowsPath('foo') } + True + >>> PureWindowsPath('C:') < PureWindowsPath('d:') + True + +Paths of a different flavour compare unequal and cannot be ordered:: + + >>> PureWindowsPath('foo') == PurePosixPath('foo') + False + >>> PureWindowsPath('foo') < PurePosixPath('foo') + Traceback (most recent call last): + File "", line 1, in + TypeError: '<' not supported between instances of 'PureWindowsPath' and 'PurePosixPath' + + +Operators +^^^^^^^^^ + +The slash operator helps create child paths, similarly to :func:`os.path.join`:: + + >>> p = PurePath('/etc') + >>> p + PurePosixPath('/etc') + >>> p / 'init.d' / 'apache2' + PurePosixPath('/etc/init.d/apache2') + >>> q = PurePath('bin') + >>> '/usr' / q + PurePosixPath('/usr/bin') + +A path object can be used anywhere an object implementing :class:`os.PathLike` +is accepted:: + + >>> import os + >>> p = PurePath('/etc') + >>> os.fspath(p) + '/etc' + +The string representation of a path is the raw filesystem path itself +(in native form, e.g. with backslashes under Windows), which you can +pass to any function taking a file path as a string:: + + >>> p = PurePath('/etc') + >>> str(p) + '/etc' + >>> p = PureWindowsPath('c:/Program Files') + >>> str(p) + 'c:\\Program Files' + +Similarly, calling :class:`bytes` on a path gives the raw filesystem path as a +bytes object, as encoded by :func:`os.fsencode`:: + + >>> bytes(p) + b'/etc' + +.. note:: + Calling :class:`bytes` is only recommended under Unix. Under Windows, + the unicode form is the canonical representation of filesystem paths. + + +Accessing individual parts +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To access the individual "parts" (components) of a path, use the following +property: + +.. data:: PurePath.parts + + A tuple giving access to the path's various components:: + + >>> p = PurePath('/usr/bin/python3') + >>> p.parts + ('/', 'usr', 'bin', 'python3') + + >>> p = PureWindowsPath('c:/Program Files/PSF') + >>> p.parts + ('c:\\', 'Program Files', 'PSF') + + (note how the drive and local root are regrouped in a single part) + + +Methods and properties +^^^^^^^^^^^^^^^^^^^^^^ + +.. testsetup:: + + from pathlib import PurePosixPath, PureWindowsPath + +Pure paths provide the following methods and properties: + +.. data:: PurePath.drive + + A string representing the drive letter or name, if any:: + + >>> PureWindowsPath('c:/Program Files/').drive + 'c:' + >>> PureWindowsPath('/Program Files/').drive + '' + >>> PurePosixPath('/etc').drive + '' + + UNC shares are also considered drives:: + + >>> PureWindowsPath('//host/share/foo.txt').drive + '\\\\host\\share' + +.. data:: PurePath.root + + A string representing the (local or global) root, if any:: + + >>> PureWindowsPath('c:/Program Files/').root + '\\' + >>> PureWindowsPath('c:Program Files/').root + '' + >>> PurePosixPath('/etc').root + '/' + + UNC shares always have a root:: + + >>> PureWindowsPath('//host/share').root + '\\' + +.. data:: PurePath.anchor + + The concatenation of the drive and root:: + + >>> PureWindowsPath('c:/Program Files/').anchor + 'c:\\' + >>> PureWindowsPath('c:Program Files/').anchor + 'c:' + >>> PurePosixPath('/etc').anchor + '/' + >>> PureWindowsPath('//host/share').anchor + '\\\\host\\share\\' + + +.. data:: PurePath.parents + + An immutable sequence providing access to the logical ancestors of + the path:: + + >>> p = PureWindowsPath('c:/foo/bar/setup.py') + >>> p.parents[0] + PureWindowsPath('c:/foo/bar') + >>> p.parents[1] + PureWindowsPath('c:/foo') + >>> p.parents[2] + PureWindowsPath('c:/') + + +.. data:: PurePath.parent + + The logical parent of the path:: + + >>> p = PurePosixPath('/a/b/c/d') + >>> p.parent + PurePosixPath('/a/b/c') + + You cannot go past an anchor, or empty path:: + + >>> p = PurePosixPath('/') + >>> p.parent + PurePosixPath('/') + >>> p = PurePosixPath('.') + >>> p.parent + PurePosixPath('.') + + .. note:: + This is a purely lexical operation, hence the following behaviour:: + + >>> p = PurePosixPath('foo/..') + >>> p.parent + PurePosixPath('foo') + + If you want to walk an arbitrary filesystem path upwards, it is + recommended to first call :meth:`Path.resolve` so as to resolve + symlinks and eliminate `".."` components. + + +.. data:: PurePath.name + + A string representing the final path component, excluding the drive and + root, if any:: + + >>> PurePosixPath('my/library/setup.py').name + 'setup.py' + + UNC drive names are not considered:: + + >>> PureWindowsPath('//some/share/setup.py').name + 'setup.py' + >>> PureWindowsPath('//some/share').name + '' + + +.. data:: PurePath.suffix + + The file extension of the final component, if any:: + + >>> PurePosixPath('my/library/setup.py').suffix + '.py' + >>> PurePosixPath('my/library.tar.gz').suffix + '.gz' + >>> PurePosixPath('my/library').suffix + '' + + +.. data:: PurePath.suffixes + + A list of the path's file extensions:: + + >>> PurePosixPath('my/library.tar.gar').suffixes + ['.tar', '.gar'] + >>> PurePosixPath('my/library.tar.gz').suffixes + ['.tar', '.gz'] + >>> PurePosixPath('my/library').suffixes + [] + + +.. data:: PurePath.stem + + The final path component, without its suffix:: + + >>> PurePosixPath('my/library.tar.gz').stem + 'library.tar' + >>> PurePosixPath('my/library.tar').stem + 'library' + >>> PurePosixPath('my/library').stem + 'library' + + +.. method:: PurePath.as_posix() + + Return a string representation of the path with forward slashes (``/``):: + + >>> p = PureWindowsPath('c:\\windows') + >>> str(p) + 'c:\\windows' + >>> p.as_posix() + 'c:/windows' + + +.. method:: PurePath.as_uri() + + Represent the path as a ``file`` URI. :exc:`ValueError` is raised if + the path isn't absolute. + + >>> p = PurePosixPath('/etc/passwd') + >>> p.as_uri() + 'file:///etc/passwd' + >>> p = PureWindowsPath('c:/Windows') + >>> p.as_uri() + 'file:///c:/Windows' + + +.. method:: PurePath.is_absolute() + + Return whether the path is absolute or not. A path is considered absolute + if it has both a root and (if the flavour allows) a drive:: + + >>> PurePosixPath('/a/b').is_absolute() + True + >>> PurePosixPath('a/b').is_absolute() + False + + >>> PureWindowsPath('c:/a/b').is_absolute() + True + >>> PureWindowsPath('/a/b').is_absolute() + False + >>> PureWindowsPath('c:').is_absolute() + False + >>> PureWindowsPath('//some/share').is_absolute() + True + + +.. method:: PurePath.is_reserved() + + With :class:`PureWindowsPath`, return ``True`` if the path is considered + reserved under Windows, ``False`` otherwise. With :class:`PurePosixPath`, + ``False`` is always returned. + + >>> PureWindowsPath('nul').is_reserved() + True + >>> PurePosixPath('nul').is_reserved() + False + + File system calls on reserved paths can fail mysteriously or have + unintended effects. + + +.. method:: PurePath.joinpath(*other) + + Calling this method is equivalent to combining the path with each of + the *other* arguments in turn:: + + >>> PurePosixPath('/etc').joinpath('passwd') + PurePosixPath('/etc/passwd') + >>> PurePosixPath('/etc').joinpath(PurePosixPath('passwd')) + PurePosixPath('/etc/passwd') + >>> PurePosixPath('/etc').joinpath('init.d', 'apache2') + PurePosixPath('/etc/init.d/apache2') + >>> PureWindowsPath('c:').joinpath('/Program Files') + PureWindowsPath('c:/Program Files') + + +.. method:: PurePath.match(pattern) + + Match this path against the provided glob-style pattern. Return ``True`` + if matching is successful, ``False`` otherwise. + + If *pattern* is relative, the path can be either relative or absolute, + and matching is done from the right:: + + >>> PurePath('a/b.py').match('*.py') + True + >>> PurePath('/a/b/c.py').match('b/*.py') + True + >>> PurePath('/a/b/c.py').match('a/*.py') + False + + If *pattern* is absolute, the path must be absolute, and the whole path + must match:: + + >>> PurePath('/a.py').match('/*.py') + True + >>> PurePath('a/b.py').match('/*.py') + False + + As with other methods, case-sensitivity is observed:: + + >>> PureWindowsPath('b.py').match('*.PY') + True + + +.. method:: PurePath.relative_to(*other) + + Compute a version of this path relative to the path represented by + *other*. If it's impossible, ValueError is raised:: + + >>> p = PurePosixPath('/etc/passwd') + >>> p.relative_to('/') + PurePosixPath('etc/passwd') + >>> p.relative_to('/etc') + PurePosixPath('passwd') + >>> p.relative_to('/usr') + Traceback (most recent call last): + File "", line 1, in + File "pathlib.py", line 694, in relative_to + .format(str(self), str(formatted))) + ValueError: '/etc/passwd' does not start with '/usr' + + +.. method:: PurePath.with_name(name) + + Return a new path with the :attr:`name` changed. If the original path + doesn't have a name, ValueError is raised:: + + >>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz') + >>> p.with_name('setup.py') + PureWindowsPath('c:/Downloads/setup.py') + >>> p = PureWindowsPath('c:/') + >>> p.with_name('setup.py') + Traceback (most recent call last): + File "", line 1, in + File "/home/antoine/cpython/default/Lib/pathlib.py", line 751, in with_name + raise ValueError("%r has an empty name" % (self,)) + ValueError: PureWindowsPath('c:/') has an empty name + + +.. method:: PurePath.with_suffix(suffix) + + Return a new path with the :attr:`suffix` changed. If the original path + doesn't have a suffix, the new *suffix* is appended instead. If the + *suffix* is an empty string, the original suffix is removed:: + + >>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz') + >>> p.with_suffix('.bz2') + PureWindowsPath('c:/Downloads/pathlib.tar.bz2') + >>> p = PureWindowsPath('README') + >>> p.with_suffix('.txt') + PureWindowsPath('README.txt') + >>> p = PureWindowsPath('README.txt') + >>> p.with_suffix('') + PureWindowsPath('README') + + +.. _concrete-paths: + + +Concrete paths +-------------- + +Concrete paths are subclasses of the pure path classes. In addition to +operations provided by the latter, they also provide methods to do system +calls on path objects. There are three ways to instantiate concrete paths: + +.. class:: Path(*pathsegments) + + A subclass of :class:`PurePath`, this class represents concrete paths of + the system's path flavour (instantiating it creates either a + :class:`PosixPath` or a :class:`WindowsPath`):: + + >>> Path('setup.py') + PosixPath('setup.py') + + *pathsegments* is specified similarly to :class:`PurePath`. + +.. class:: PosixPath(*pathsegments) + + A subclass of :class:`Path` and :class:`PurePosixPath`, this class + represents concrete non-Windows filesystem paths:: + + >>> PosixPath('/etc') + PosixPath('/etc') + + *pathsegments* is specified similarly to :class:`PurePath`. + +.. class:: WindowsPath(*pathsegments) + + A subclass of :class:`Path` and :class:`PureWindowsPath`, this class + represents concrete Windows filesystem paths:: + + >>> WindowsPath('c:/Program Files/') + WindowsPath('c:/Program Files') + + *pathsegments* is specified similarly to :class:`PurePath`. + +You can only instantiate the class flavour that corresponds to your system +(allowing system calls on non-compatible path flavours could lead to +bugs or failures in your application):: + + >>> import os + >>> os.name + 'posix' + >>> Path('setup.py') + PosixPath('setup.py') + >>> PosixPath('setup.py') + PosixPath('setup.py') + >>> WindowsPath('setup.py') + Traceback (most recent call last): + File "", line 1, in + File "pathlib.py", line 798, in __new__ + % (cls.__name__,)) + NotImplementedError: cannot instantiate 'WindowsPath' on your system + + +Methods +^^^^^^^ + +Concrete paths provide the following methods in addition to pure paths +methods. Many of these methods can raise an :exc:`OSError` if a system +call fails (for example because the path doesn't exist): + +.. classmethod:: Path.cwd() + + Return a new path object representing the current directory (as returned + by :func:`os.getcwd`):: + + >>> Path.cwd() + PosixPath('/home/antoine/pathlib') + + +.. classmethod:: Path.home() + + Return a new path object representing the user's home directory (as + returned by :func:`os.path.expanduser` with ``~`` construct):: + + >>> Path.home() + PosixPath('/home/antoine') + + .. versionadded:: 3.5 + + +.. method:: Path.stat() + + Return information about this path (similarly to :func:`os.stat`). + The result is looked up at each call to this method. + + :: + + >>> p = Path('setup.py') + >>> p.stat().st_size + 956 + >>> p.stat().st_mtime + 1327883547.852554 + + +.. method:: Path.chmod(mode) + + Change the file mode and permissions, like :func:`os.chmod`:: + + >>> p = Path('setup.py') + >>> p.stat().st_mode + 33277 + >>> p.chmod(0o444) + >>> p.stat().st_mode + 33060 + + +.. method:: Path.exists() + + Whether the path points to an existing file or directory:: + + >>> Path('.').exists() + True + >>> Path('setup.py').exists() + True + >>> Path('/etc').exists() + True + >>> Path('nonexistentfile').exists() + False + + .. note:: + If the path points to a symlink, :meth:`exists` returns whether the + symlink *points to* an existing file or directory. + + +.. method:: Path.expanduser() + + Return a new path with expanded ``~`` and ``~user`` constructs, + as returned by :meth:`os.path.expanduser`:: + + >>> p = PosixPath('~/films/Monty Python') + >>> p.expanduser() + PosixPath('/home/eric/films/Monty Python') + + .. versionadded:: 3.5 + + +.. method:: Path.glob(pattern) + + Glob the given relative *pattern* in the directory represented by this path, + yielding all matching files (of any kind):: + + >>> sorted(Path('.').glob('*.py')) + [PosixPath('pathlib.py'), PosixPath('setup.py'), PosixPath('test_pathlib.py')] + >>> sorted(Path('.').glob('*/*.py')) + [PosixPath('docs/conf.py')] + + The "``**``" pattern means "this directory and all subdirectories, + recursively". In other words, it enables recursive globbing:: + + >>> sorted(Path('.').glob('**/*.py')) + [PosixPath('build/lib/pathlib.py'), + PosixPath('docs/conf.py'), + PosixPath('pathlib.py'), + PosixPath('setup.py'), + PosixPath('test_pathlib.py')] + + .. note:: + Using the "``**``" pattern in large directory trees may consume + an inordinate amount of time. + + +.. method:: Path.group() + + Return the name of the group owning the file. :exc:`KeyError` is raised + if the file's gid isn't found in the system database. + + +.. method:: Path.is_dir() + + Return ``True`` if the path points to a directory (or a symbolic link + pointing to a directory), ``False`` if it points to another kind of file. + + ``False`` is also returned if the path doesn't exist or is a broken symlink; + other errors (such as permission errors) are propagated. + + +.. method:: Path.is_file() + + Return ``True`` if the path points to a regular file (or a symbolic link + pointing to a regular file), ``False`` if it points to another kind of file. + + ``False`` is also returned if the path doesn't exist or is a broken symlink; + other errors (such as permission errors) are propagated. + + +.. method:: Path.is_mount() + + Return ``True`` if the path is a :dfn:`mount point`: a point in a + file system where a different file system has been mounted. On POSIX, the + function checks whether *path*'s parent, :file:`path/..`, is on a different + device than *path*, or whether :file:`path/..` and *path* point to the same + i-node on the same device --- this should detect mount points for all Unix + and POSIX variants. Not implemented on Windows. + + .. versionadded:: 3.7 + + +.. method:: Path.is_symlink() + + Return ``True`` if the path points to a symbolic link, ``False`` otherwise. + + ``False`` is also returned if the path doesn't exist; other errors (such + as permission errors) are propagated. + + +.. method:: Path.is_socket() + + Return ``True`` if the path points to a Unix socket (or a symbolic link + pointing to a Unix socket), ``False`` if it points to another kind of file. + + ``False`` is also returned if the path doesn't exist or is a broken symlink; + other errors (such as permission errors) are propagated. + + +.. method:: Path.is_fifo() + + Return ``True`` if the path points to a FIFO (or a symbolic link + pointing to a FIFO), ``False`` if it points to another kind of file. + + ``False`` is also returned if the path doesn't exist or is a broken symlink; + other errors (such as permission errors) are propagated. + + +.. method:: Path.is_block_device() + + Return ``True`` if the path points to a block device (or a symbolic link + pointing to a block device), ``False`` if it points to another kind of file. + + ``False`` is also returned if the path doesn't exist or is a broken symlink; + other errors (such as permission errors) are propagated. + + +.. method:: Path.is_char_device() + + Return ``True`` if the path points to a character device (or a symbolic link + pointing to a character device), ``False`` if it points to another kind of file. + + ``False`` is also returned if the path doesn't exist or is a broken symlink; + other errors (such as permission errors) are propagated. + + +.. method:: Path.iterdir() + + When the path points to a directory, yield path objects of the directory + contents:: + + >>> p = Path('docs') + >>> for child in p.iterdir(): child + ... + PosixPath('docs/conf.py') + PosixPath('docs/_templates') + PosixPath('docs/make.bat') + PosixPath('docs/index.rst') + PosixPath('docs/_build') + PosixPath('docs/_static') + PosixPath('docs/Makefile') + +.. method:: Path.lchmod(mode) + + Like :meth:`Path.chmod` but, if the path points to a symbolic link, the + symbolic link's mode is changed rather than its target's. + + +.. method:: Path.lstat() + + Like :meth:`Path.stat` but, if the path points to a symbolic link, return + the symbolic link's information rather than its target's. + + +.. method:: Path.mkdir(mode=0o777, parents=False, exist_ok=False) + + Create a new directory at this given path. If *mode* is given, it is + combined with the process' ``umask`` value to determine the file mode + and access flags. If the path already exists, :exc:`FileExistsError` + is raised. + + If *parents* is true, any missing parents of this path are created + as needed; they are created with the default permissions without taking + *mode* into account (mimicking the POSIX ``mkdir -p`` command). + + If *parents* is false (the default), a missing parent raises + :exc:`FileNotFoundError`. + + If *exist_ok* is false (the default), :exc:`FileExistsError` is + raised if the target directory already exists. + + If *exist_ok* is true, :exc:`FileExistsError` exceptions will be + ignored (same behavior as the POSIX ``mkdir -p`` command), but only if the + last path component is not an existing non-directory file. + + .. versionchanged:: 3.5 + The *exist_ok* parameter was added. + + +.. method:: Path.open(mode='r', buffering=-1, encoding=None, errors=None, newline=None) + + Open the file pointed to by the path, like the built-in :func:`open` + function does:: + + >>> p = Path('setup.py') + >>> with p.open() as f: + ... f.readline() + ... + '#!/usr/bin/env python3\n' + + +.. method:: Path.owner() + + Return the name of the user owning the file. :exc:`KeyError` is raised + if the file's uid isn't found in the system database. + + +.. method:: Path.read_bytes() + + Return the binary contents of the pointed-to file as a bytes object:: + + >>> p = Path('my_binary_file') + >>> p.write_bytes(b'Binary file contents') + 20 + >>> p.read_bytes() + b'Binary file contents' + + .. versionadded:: 3.5 + + +.. method:: Path.read_text(encoding=None, errors=None) + + Return the decoded contents of the pointed-to file as a string:: + + >>> p = Path('my_text_file') + >>> p.write_text('Text file contents') + 18 + >>> p.read_text() + 'Text file contents' + + The file is opened and then closed. The optional parameters have the same + meaning as in :func:`open`. + + .. versionadded:: 3.5 + + +.. method:: Path.rename(target) + + Rename this file or directory to the given *target*. On Unix, if + *target* exists and is a file, it will be replaced silently if the user + has permission. *target* can be either a string or another path object:: + + >>> p = Path('foo') + >>> p.open('w').write('some text') + 9 + >>> target = Path('bar') + >>> p.rename(target) + >>> target.open().read() + 'some text' + + +.. method:: Path.replace(target) + + Rename this file or directory to the given *target*. If *target* points + to an existing file or directory, it will be unconditionally replaced. + + +.. method:: Path.resolve(strict=False) + + Make the path absolute, resolving any symlinks. A new path object is + returned:: + + >>> p = Path() + >>> p + PosixPath('.') + >>> p.resolve() + PosixPath('/home/antoine/pathlib') + + "``..``" components are also eliminated (this is the only method to do so):: + + >>> p = Path('docs/../setup.py') + >>> p.resolve() + PosixPath('/home/antoine/pathlib/setup.py') + + If the path doesn't exist and *strict* is ``True``, :exc:`FileNotFoundError` + is raised. If *strict* is ``False``, the path is resolved as far as possible + and any remainder is appended without checking whether it exists. If an + infinite loop is encountered along the resolution path, :exc:`RuntimeError` + is raised. + + .. versionadded:: 3.6 + The *strict* argument (pre-3.6 behavior is strict). + +.. method:: Path.rglob(pattern) + + This is like calling :func:`Path.glob` with "``**/``" added in front of the + given relative *pattern*:: + + >>> sorted(Path().rglob("*.py")) + [PosixPath('build/lib/pathlib.py'), + PosixPath('docs/conf.py'), + PosixPath('pathlib.py'), + PosixPath('setup.py'), + PosixPath('test_pathlib.py')] + + +.. method:: Path.rmdir() + + Remove this directory. The directory must be empty. + + +.. method:: Path.samefile(other_path) + + Return whether this path points to the same file as *other_path*, which + can be either a Path object, or a string. The semantics are similar + to :func:`os.path.samefile` and :func:`os.path.samestat`. + + An :exc:`OSError` can be raised if either file cannot be accessed for some + reason. + + :: + + >>> p = Path('spam') + >>> q = Path('eggs') + >>> p.samefile(q) + False + >>> p.samefile('spam') + True + + .. versionadded:: 3.5 + + +.. method:: Path.symlink_to(target, target_is_directory=False) + + Make this path a symbolic link to *target*. Under Windows, + *target_is_directory* must be true (default ``False``) if the link's target + is a directory. Under POSIX, *target_is_directory*'s value is ignored. + + :: + + >>> p = Path('mylink') + >>> p.symlink_to('setup.py') + >>> p.resolve() + PosixPath('/home/antoine/pathlib/setup.py') + >>> p.stat().st_size + 956 + >>> p.lstat().st_size + 8 + + .. note:: + The order of arguments (link, target) is the reverse + of :func:`os.symlink`'s. + + +.. method:: Path.touch(mode=0o666, exist_ok=True) + + Create a file at this given path. If *mode* is given, it is combined + with the process' ``umask`` value to determine the file mode and access + flags. If the file already exists, the function succeeds if *exist_ok* + is true (and its modification time is updated to the current time), + otherwise :exc:`FileExistsError` is raised. + + +.. method:: Path.unlink() + + Remove this file or symbolic link. If the path points to a directory, + use :func:`Path.rmdir` instead. + + +.. method:: Path.write_bytes(data) + + Open the file pointed to in bytes mode, write *data* to it, and close the + file:: + + >>> p = Path('my_binary_file') + >>> p.write_bytes(b'Binary file contents') + 20 + >>> p.read_bytes() + b'Binary file contents' + + An existing file of the same name is overwritten. + + .. versionadded:: 3.5 + + +.. method:: Path.write_text(data, encoding=None, errors=None) + + Open the file pointed to in text mode, write *data* to it, and close the + file:: + + >>> p = Path('my_text_file') + >>> p.write_text('Text file contents') + 18 + >>> p.read_text() + 'Text file contents' + + .. versionadded:: 3.5 + +Correspondence to tools in the :mod:`os` module +----------------------------------------------- + +Below is a table mapping various :mod:`os` functions to their corresponding +:class:`PurePath`/:class:`Path` equivalent. + +.. note:: + + Although :func:`os.path.relpath` and :meth:`PurePath.relative_to` have some + overlapping use-cases, their semantics differ enough to warrant not + considering them equivalent. + +==================================== ============================== +os and os.path pathlib +==================================== ============================== +:func:`os.path.abspath` :meth:`Path.resolve` +:func:`os.chmod` :meth:`Path.chmod` +:func:`os.mkdir` :meth:`Path.mkdir` +:func:`os.rename` :meth:`Path.rename` +:func:`os.replace` :meth:`Path.replace` +:func:`os.rmdir` :meth:`Path.rmdir` +:func:`os.remove`, :func:`os.unlink` :meth:`Path.unlink` +:func:`os.getcwd` :func:`Path.cwd` +:func:`os.path.exists` :meth:`Path.exists` +:func:`os.path.expanduser` :meth:`Path.expanduser` and + :meth:`Path.home` +:func:`os.path.isdir` :meth:`Path.is_dir` +:func:`os.path.isfile` :meth:`Path.is_file` +:func:`os.path.islink` :meth:`Path.is_symlink` +:func:`os.stat` :meth:`Path.stat`, + :meth:`Path.owner`, + :meth:`Path.group` +:func:`os.path.isabs` :meth:`PurePath.is_absolute` +:func:`os.path.join` :func:`PurePath.joinpath` +:func:`os.path.basename` :data:`PurePath.name` +:func:`os.path.dirname` :data:`PurePath.parent` +:func:`os.path.samefile` :meth:`Path.samefile` +:func:`os.path.splitext` :data:`PurePath.suffix` +==================================== ============================== diff --git a/python-3.7.4-docs-html/_sources/library/pdb.rst.txt b/python-3.7.4-docs-html/_sources/library/pdb.rst.txt new file mode 100644 index 0000000..c7864e9 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/pdb.rst.txt @@ -0,0 +1,536 @@ +.. _debugger: + +:mod:`pdb` --- The Python Debugger +================================== + +.. module:: pdb + :synopsis: The Python debugger for interactive interpreters. + +**Source code:** :source:`Lib/pdb.py` + +.. index:: single: debugging + +-------------- + +The module :mod:`pdb` defines an interactive source code debugger for Python +programs. It supports setting (conditional) breakpoints and single stepping at +the source line level, inspection of stack frames, source code listing, and +evaluation of arbitrary Python code in the context of any stack frame. It also +supports post-mortem debugging and can be called under program control. + +.. index:: + single: Pdb (class in pdb) + module: bdb + module: cmd + +The debugger is extensible -- it is actually defined as the class :class:`Pdb`. +This is currently undocumented but easily understood by reading the source. The +extension interface uses the modules :mod:`bdb` and :mod:`cmd`. + +The debugger's prompt is ``(Pdb)``. Typical usage to run a program under control +of the debugger is:: + + >>> import pdb + >>> import mymodule + >>> pdb.run('mymodule.test()') + > (0)?() + (Pdb) continue + > (1)?() + (Pdb) continue + NameError: 'spam' + > (1)?() + (Pdb) + +.. versionchanged:: 3.3 + Tab-completion via the :mod:`readline` module is available for commands and + command arguments, e.g. the current global and local names are offered as + arguments of the ``p`` command. + +:file:`pdb.py` can also be invoked as a script to debug other scripts. For +example:: + + python3 -m pdb myscript.py + +When invoked as a script, pdb will automatically enter post-mortem debugging if +the program being debugged exits abnormally. After post-mortem debugging (or +after normal exit of the program), pdb will restart the program. Automatic +restarting preserves pdb's state (such as breakpoints) and in most cases is more +useful than quitting the debugger upon program's exit. + +.. versionadded:: 3.2 + :file:`pdb.py` now accepts a ``-c`` option that executes commands as if given + in a :file:`.pdbrc` file, see :ref:`debugger-commands`. + +.. versionadded:: 3.7 + :file:`pdb.py` now accepts a ``-m`` option that execute modules similar to the way + ``python3 -m`` does. As with a script, the debugger will pause execution just + before the first line of the module. + + +The typical usage to break into the debugger from a running program is to +insert :: + + import pdb; pdb.set_trace() + +at the location you want to break into the debugger. You can then step through +the code following this statement, and continue running without the debugger +using the :pdbcmd:`continue` command. + +.. versionadded:: 3.7 + The built-in :func:`breakpoint()`, when called with defaults, can be used + instead of ``import pdb; pdb.set_trace()``. + +The typical usage to inspect a crashed program is:: + + >>> import pdb + >>> import mymodule + >>> mymodule.test() + Traceback (most recent call last): + File "", line 1, in + File "./mymodule.py", line 4, in test + test2() + File "./mymodule.py", line 3, in test2 + print(spam) + NameError: spam + >>> pdb.pm() + > ./mymodule.py(3)test2() + -> print(spam) + (Pdb) + + +The module defines the following functions; each enters the debugger in a +slightly different way: + +.. function:: run(statement, globals=None, locals=None) + + Execute the *statement* (given as a string or a code object) under debugger + control. The debugger prompt appears before any code is executed; you can + set breakpoints and type :pdbcmd:`continue`, or you can step through the + statement using :pdbcmd:`step` or :pdbcmd:`next` (all these commands are + explained below). The optional *globals* and *locals* arguments specify the + environment in which the code is executed; by default the dictionary of the + module :mod:`__main__` is used. (See the explanation of the built-in + :func:`exec` or :func:`eval` functions.) + + +.. function:: runeval(expression, globals=None, locals=None) + + Evaluate the *expression* (given as a string or a code object) under debugger + control. When :func:`runeval` returns, it returns the value of the + expression. Otherwise this function is similar to :func:`run`. + + +.. function:: runcall(function, *args, **kwds) + + Call the *function* (a function or method object, not a string) with the + given arguments. When :func:`runcall` returns, it returns whatever the + function call returned. The debugger prompt appears as soon as the function + is entered. + + +.. function:: set_trace(*, header=None) + + Enter the debugger at the calling stack frame. This is useful to hard-code + a breakpoint at a given point in a program, even if the code is not + otherwise being debugged (e.g. when an assertion fails). If given, + *header* is printed to the console just before debugging begins. + + .. versionchanged:: 3.7 + The keyword-only argument *header*. + + +.. function:: post_mortem(traceback=None) + + Enter post-mortem debugging of the given *traceback* object. If no + *traceback* is given, it uses the one of the exception that is currently + being handled (an exception must be being handled if the default is to be + used). + + +.. function:: pm() + + Enter post-mortem debugging of the traceback found in + :data:`sys.last_traceback`. + + +The ``run*`` functions and :func:`set_trace` are aliases for instantiating the +:class:`Pdb` class and calling the method of the same name. If you want to +access further features, you have to do this yourself: + +.. class:: Pdb(completekey='tab', stdin=None, stdout=None, skip=None, \ + nosigint=False, readrc=True) + + :class:`Pdb` is the debugger class. + + The *completekey*, *stdin* and *stdout* arguments are passed to the + underlying :class:`cmd.Cmd` class; see the description there. + + The *skip* argument, if given, must be an iterable of glob-style module name + patterns. The debugger will not step into frames that originate in a module + that matches one of these patterns. [1]_ + + By default, Pdb sets a handler for the SIGINT signal (which is sent when the + user presses :kbd:`Ctrl-C` on the console) when you give a ``continue`` command. + This allows you to break into the debugger again by pressing :kbd:`Ctrl-C`. If you + want Pdb not to touch the SIGINT handler, set *nosigint* to true. + + The *readrc* argument defaults to true and controls whether Pdb will load + .pdbrc files from the filesystem. + + Example call to enable tracing with *skip*:: + + import pdb; pdb.Pdb(skip=['django.*']).set_trace() + + .. versionadded:: 3.1 + The *skip* argument. + + .. versionadded:: 3.2 + The *nosigint* argument. Previously, a SIGINT handler was never set by + Pdb. + + .. versionchanged:: 3.6 + The *readrc* argument. + + .. method:: run(statement, globals=None, locals=None) + runeval(expression, globals=None, locals=None) + runcall(function, *args, **kwds) + set_trace() + + See the documentation for the functions explained above. + + +.. _debugger-commands: + +Debugger Commands +----------------- + +The commands recognized by the debugger are listed below. Most commands can be +abbreviated to one or two letters as indicated; e.g. ``h(elp)`` means that +either ``h`` or ``help`` can be used to enter the help command (but not ``he`` +or ``hel``, nor ``H`` or ``Help`` or ``HELP``). Arguments to commands must be +separated by whitespace (spaces or tabs). Optional arguments are enclosed in +square brackets (``[]``) in the command syntax; the square brackets must not be +typed. Alternatives in the command syntax are separated by a vertical bar +(``|``). + +Entering a blank line repeats the last command entered. Exception: if the last +command was a :pdbcmd:`list` command, the next 11 lines are listed. + +Commands that the debugger doesn't recognize are assumed to be Python statements +and are executed in the context of the program being debugged. Python +statements can also be prefixed with an exclamation point (``!``). This is a +powerful way to inspect the program being debugged; it is even possible to +change a variable or call a function. When an exception occurs in such a +statement, the exception name is printed but the debugger's state is not +changed. + +The debugger supports :ref:`aliases `. Aliases can have +parameters which allows one a certain level of adaptability to the context under +examination. + +Multiple commands may be entered on a single line, separated by ``;;``. (A +single ``;`` is not used as it is the separator for multiple commands in a line +that is passed to the Python parser.) No intelligence is applied to separating +the commands; the input is split at the first ``;;`` pair, even if it is in the +middle of a quoted string. + +.. index:: + pair: .pdbrc; file + triple: debugger; configuration; file + +If a file :file:`.pdbrc` exists in the user's home directory or in the current +directory, it is read in and executed as if it had been typed at the debugger +prompt. This is particularly useful for aliases. If both files exist, the one +in the home directory is read first and aliases defined there can be overridden +by the local file. + +.. versionchanged:: 3.2 + :file:`.pdbrc` can now contain commands that continue debugging, such as + :pdbcmd:`continue` or :pdbcmd:`next`. Previously, these commands had no + effect. + + +.. pdbcommand:: h(elp) [command] + + Without argument, print the list of available commands. With a *command* as + argument, print help about that command. ``help pdb`` displays the full + documentation (the docstring of the :mod:`pdb` module). Since the *command* + argument must be an identifier, ``help exec`` must be entered to get help on + the ``!`` command. + +.. pdbcommand:: w(here) + + Print a stack trace, with the most recent frame at the bottom. An arrow + indicates the current frame, which determines the context of most commands. + +.. pdbcommand:: d(own) [count] + + Move the current frame *count* (default one) levels down in the stack trace + (to a newer frame). + +.. pdbcommand:: u(p) [count] + + Move the current frame *count* (default one) levels up in the stack trace (to + an older frame). + +.. pdbcommand:: b(reak) [([filename:]lineno | function) [, condition]] + + With a *lineno* argument, set a break there in the current file. With a + *function* argument, set a break at the first executable statement within + that function. The line number may be prefixed with a filename and a colon, + to specify a breakpoint in another file (probably one that hasn't been loaded + yet). The file is searched on :data:`sys.path`. Note that each breakpoint + is assigned a number to which all the other breakpoint commands refer. + + If a second argument is present, it is an expression which must evaluate to + true before the breakpoint is honored. + + Without argument, list all breaks, including for each breakpoint, the number + of times that breakpoint has been hit, the current ignore count, and the + associated condition if any. + +.. pdbcommand:: tbreak [([filename:]lineno | function) [, condition]] + + Temporary breakpoint, which is removed automatically when it is first hit. + The arguments are the same as for :pdbcmd:`break`. + +.. pdbcommand:: cl(ear) [filename:lineno | bpnumber [bpnumber ...]] + + With a *filename:lineno* argument, clear all the breakpoints at this line. + With a space separated list of breakpoint numbers, clear those breakpoints. + Without argument, clear all breaks (but first ask confirmation). + +.. pdbcommand:: disable [bpnumber [bpnumber ...]] + + Disable the breakpoints given as a space separated list of breakpoint + numbers. Disabling a breakpoint means it cannot cause the program to stop + execution, but unlike clearing a breakpoint, it remains in the list of + breakpoints and can be (re-)enabled. + +.. pdbcommand:: enable [bpnumber [bpnumber ...]] + + Enable the breakpoints specified. + +.. pdbcommand:: ignore bpnumber [count] + + Set the ignore count for the given breakpoint number. If count is omitted, + the ignore count is set to 0. A breakpoint becomes active when the ignore + count is zero. When non-zero, the count is decremented each time the + breakpoint is reached and the breakpoint is not disabled and any associated + condition evaluates to true. + +.. pdbcommand:: condition bpnumber [condition] + + Set a new *condition* for the breakpoint, an expression which must evaluate + to true before the breakpoint is honored. If *condition* is absent, any + existing condition is removed; i.e., the breakpoint is made unconditional. + +.. pdbcommand:: commands [bpnumber] + + Specify a list of commands for breakpoint number *bpnumber*. The commands + themselves appear on the following lines. Type a line containing just + ``end`` to terminate the commands. An example:: + + (Pdb) commands 1 + (com) p some_variable + (com) end + (Pdb) + + To remove all commands from a breakpoint, type ``commands`` and follow it + immediately with ``end``; that is, give no commands. + + With no *bpnumber* argument, ``commands`` refers to the last breakpoint set. + + You can use breakpoint commands to start your program up again. Simply use + the :pdbcmd:`continue` command, or :pdbcmd:`step`, + or any other command that resumes execution. + + Specifying any command resuming execution + (currently :pdbcmd:`continue`, :pdbcmd:`step`, :pdbcmd:`next`, + :pdbcmd:`return`, :pdbcmd:`jump`, :pdbcmd:`quit` and their abbreviations) + terminates the command list (as if + that command was immediately followed by end). This is because any time you + resume execution (even with a simple next or step), you may encounter another + breakpoint—which could have its own command list, leading to ambiguities about + which list to execute. + + If you use the 'silent' command in the command list, the usual message about + stopping at a breakpoint is not printed. This may be desirable for breakpoints + that are to print a specific message and then continue. If none of the other + commands print anything, you see no sign that the breakpoint was reached. + +.. pdbcommand:: s(tep) + + Execute the current line, stop at the first possible occasion (either in a + function that is called or on the next line in the current function). + +.. pdbcommand:: n(ext) + + Continue execution until the next line in the current function is reached or + it returns. (The difference between :pdbcmd:`next` and :pdbcmd:`step` is + that :pdbcmd:`step` stops inside a called function, while :pdbcmd:`next` + executes called functions at (nearly) full speed, only stopping at the next + line in the current function.) + +.. pdbcommand:: unt(il) [lineno] + + Without argument, continue execution until the line with a number greater + than the current one is reached. + + With a line number, continue execution until a line with a number greater or + equal to that is reached. In both cases, also stop when the current frame + returns. + + .. versionchanged:: 3.2 + Allow giving an explicit line number. + +.. pdbcommand:: r(eturn) + + Continue execution until the current function returns. + +.. pdbcommand:: c(ont(inue)) + + Continue execution, only stop when a breakpoint is encountered. + +.. pdbcommand:: j(ump) lineno + + Set the next line that will be executed. Only available in the bottom-most + frame. This lets you jump back and execute code again, or jump forward to + skip code that you don't want to run. + + It should be noted that not all jumps are allowed -- for instance it is not + possible to jump into the middle of a :keyword:`for` loop or out of a + :keyword:`finally` clause. + +.. pdbcommand:: l(ist) [first[, last]] + + List source code for the current file. Without arguments, list 11 lines + around the current line or continue the previous listing. With ``.`` as + argument, list 11 lines around the current line. With one argument, + list 11 lines around at that line. With two arguments, list the given range; + if the second argument is less than the first, it is interpreted as a count. + + The current line in the current frame is indicated by ``->``. If an + exception is being debugged, the line where the exception was originally + raised or propagated is indicated by ``>>``, if it differs from the current + line. + + .. versionadded:: 3.2 + The ``>>`` marker. + +.. pdbcommand:: ll | longlist + + List all source code for the current function or frame. Interesting lines + are marked as for :pdbcmd:`list`. + + .. versionadded:: 3.2 + +.. pdbcommand:: a(rgs) + + Print the argument list of the current function. + +.. pdbcommand:: p expression + + Evaluate the *expression* in the current context and print its value. + + .. note:: + + ``print()`` can also be used, but is not a debugger command --- this executes the + Python :func:`print` function. + + +.. pdbcommand:: pp expression + + Like the :pdbcmd:`p` command, except the value of the expression is + pretty-printed using the :mod:`pprint` module. + +.. pdbcommand:: whatis expression + + Print the type of the *expression*. + +.. pdbcommand:: source expression + + Try to get source code for the given object and display it. + + .. versionadded:: 3.2 + +.. pdbcommand:: display [expression] + + Display the value of the expression if it changed, each time execution stops + in the current frame. + + Without expression, list all display expressions for the current frame. + + .. versionadded:: 3.2 + +.. pdbcommand:: undisplay [expression] + + Do not display the expression any more in the current frame. Without + expression, clear all display expressions for the current frame. + + .. versionadded:: 3.2 + +.. pdbcommand:: interact + + Start an interactive interpreter (using the :mod:`code` module) whose global + namespace contains all the (global and local) names found in the current + scope. + + .. versionadded:: 3.2 + +.. _debugger-aliases: + +.. pdbcommand:: alias [name [command]] + + Create an alias called *name* that executes *command*. The command must + *not* be enclosed in quotes. Replaceable parameters can be indicated by + ``%1``, ``%2``, and so on, while ``%*`` is replaced by all the parameters. + If no command is given, the current alias for *name* is shown. If no + arguments are given, all aliases are listed. + + Aliases may be nested and can contain anything that can be legally typed at + the pdb prompt. Note that internal pdb commands *can* be overridden by + aliases. Such a command is then hidden until the alias is removed. Aliasing + is recursively applied to the first word of the command line; all other words + in the line are left alone. + + As an example, here are two useful aliases (especially when placed in the + :file:`.pdbrc` file):: + + # Print instance variables (usage "pi classInst") + alias pi for k in %1.__dict__.keys(): print("%1.",k,"=",%1.__dict__[k]) + # Print instance variables in self + alias ps pi self + +.. pdbcommand:: unalias name + + Delete the specified alias. + +.. pdbcommand:: ! statement + + Execute the (one-line) *statement* in the context of the current stack frame. + The exclamation point can be omitted unless the first word of the statement + resembles a debugger command. To set a global variable, you can prefix the + assignment command with a :keyword:`global` statement on the same line, + e.g.:: + + (Pdb) global list_options; list_options = ['-l'] + (Pdb) + +.. pdbcommand:: run [args ...] + restart [args ...] + + Restart the debugged Python program. If an argument is supplied, it is split + with :mod:`shlex` and the result is used as the new :data:`sys.argv`. + History, breakpoints, actions and debugger options are preserved. + :pdbcmd:`restart` is an alias for :pdbcmd:`run`. + +.. pdbcommand:: q(uit) + + Quit from the debugger. The program being executed is aborted. + + +.. rubric:: Footnotes + +.. [1] Whether a frame is considered to originate in a certain module + is determined by the ``__name__`` in the frame globals. diff --git a/python-3.7.4-docs-html/_sources/library/persistence.rst.txt b/python-3.7.4-docs-html/_sources/library/persistence.rst.txt new file mode 100644 index 0000000..d5bb193 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/persistence.rst.txt @@ -0,0 +1,23 @@ +.. _persistence: + +**************** +Data Persistence +**************** + +The modules described in this chapter support storing Python data in a +persistent form on disk. The :mod:`pickle` and :mod:`marshal` modules can turn +many Python data types into a stream of bytes and then recreate the objects from +the bytes. The various DBM-related modules support a family of hash-based file +formats that store a mapping of strings to other strings. + +The list of modules described in this chapter is: + + +.. toctree:: + + pickle.rst + copyreg.rst + shelve.rst + marshal.rst + dbm.rst + sqlite3.rst diff --git a/python-3.7.4-docs-html/_sources/library/pickle.rst.txt b/python-3.7.4-docs-html/_sources/library/pickle.rst.txt new file mode 100644 index 0000000..2d01d8b --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/pickle.rst.txt @@ -0,0 +1,937 @@ +:mod:`pickle` --- Python object serialization +============================================= + +.. module:: pickle + :synopsis: Convert Python objects to streams of bytes and back. + +.. sectionauthor:: Jim Kerr . +.. sectionauthor:: Barry Warsaw + +**Source code:** :source:`Lib/pickle.py` + +.. index:: + single: persistence + pair: persistent; objects + pair: serializing; objects + pair: marshalling; objects + pair: flattening; objects + pair: pickling; objects + +-------------- + +The :mod:`pickle` module implements binary protocols for serializing and +de-serializing a Python object structure. *"Pickling"* is the process +whereby a Python object hierarchy is converted into a byte stream, and +*"unpickling"* is the inverse operation, whereby a byte stream +(from a :term:`binary file` or :term:`bytes-like object`) is converted +back into an object hierarchy. Pickling (and unpickling) is alternatively +known as "serialization", "marshalling," [#]_ or "flattening"; however, to +avoid confusion, the terms used here are "pickling" and "unpickling". + +.. warning:: + + The :mod:`pickle` module is not secure against erroneous or maliciously + constructed data. Never unpickle data received from an untrusted or + unauthenticated source. + + +Relationship to other Python modules +------------------------------------ + +Comparison with ``marshal`` +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Python has a more primitive serialization module called :mod:`marshal`, but in +general :mod:`pickle` should always be the preferred way to serialize Python +objects. :mod:`marshal` exists primarily to support Python's :file:`.pyc` +files. + +The :mod:`pickle` module differs from :mod:`marshal` in several significant ways: + +* The :mod:`pickle` module keeps track of the objects it has already serialized, + so that later references to the same object won't be serialized again. + :mod:`marshal` doesn't do this. + + This has implications both for recursive objects and object sharing. Recursive + objects are objects that contain references to themselves. These are not + handled by marshal, and in fact, attempting to marshal recursive objects will + crash your Python interpreter. Object sharing happens when there are multiple + references to the same object in different places in the object hierarchy being + serialized. :mod:`pickle` stores such objects only once, and ensures that all + other references point to the master copy. Shared objects remain shared, which + can be very important for mutable objects. + +* :mod:`marshal` cannot be used to serialize user-defined classes and their + instances. :mod:`pickle` can save and restore class instances transparently, + however the class definition must be importable and live in the same module as + when the object was stored. + +* The :mod:`marshal` serialization format is not guaranteed to be portable + across Python versions. Because its primary job in life is to support + :file:`.pyc` files, the Python implementers reserve the right to change the + serialization format in non-backwards compatible ways should the need arise. + The :mod:`pickle` serialization format is guaranteed to be backwards compatible + across Python releases provided a compatible pickle protocol is chosen and + pickling and unpickling code deals with Python 2 to Python 3 type differences + if your data is crossing that unique breaking change language boundary. + +Comparison with ``json`` +^^^^^^^^^^^^^^^^^^^^^^^^ + +There are fundamental differences between the pickle protocols and +`JSON (JavaScript Object Notation) `_: + +* JSON is a text serialization format (it outputs unicode text, although + most of the time it is then encoded to ``utf-8``), while pickle is + a binary serialization format; + +* JSON is human-readable, while pickle is not; + +* JSON is interoperable and widely used outside of the Python ecosystem, + while pickle is Python-specific; + +* JSON, by default, can only represent a subset of the Python built-in + types, and no custom classes; pickle can represent an extremely large + number of Python types (many of them automatically, by clever usage + of Python's introspection facilities; complex cases can be tackled by + implementing :ref:`specific object APIs `). + +.. seealso:: + The :mod:`json` module: a standard library module allowing JSON + serialization and deserialization. + + +.. _pickle-protocols: + +Data stream format +------------------ + +.. index:: + single: External Data Representation + +The data format used by :mod:`pickle` is Python-specific. This has the +advantage that there are no restrictions imposed by external standards such as +JSON or XDR (which can't represent pointer sharing); however it means that +non-Python programs may not be able to reconstruct pickled Python objects. + +By default, the :mod:`pickle` data format uses a relatively compact binary +representation. If you need optimal size characteristics, you can efficiently +:doc:`compress ` pickled data. + +The module :mod:`pickletools` contains tools for analyzing data streams +generated by :mod:`pickle`. :mod:`pickletools` source code has extensive +comments about opcodes used by pickle protocols. + +There are currently 5 different protocols which can be used for pickling. +The higher the protocol used, the more recent the version of Python needed +to read the pickle produced. + +* Protocol version 0 is the original "human-readable" protocol and is + backwards compatible with earlier versions of Python. + +* Protocol version 1 is an old binary format which is also compatible with + earlier versions of Python. + +* Protocol version 2 was introduced in Python 2.3. It provides much more + efficient pickling of :term:`new-style class`\es. Refer to :pep:`307` for + information about improvements brought by protocol 2. + +* Protocol version 3 was added in Python 3.0. It has explicit support for + :class:`bytes` objects and cannot be unpickled by Python 2.x. This is + the default protocol, and the recommended protocol when compatibility with + other Python 3 versions is required. + +* Protocol version 4 was added in Python 3.4. It adds support for very large + objects, pickling more kinds of objects, and some data format + optimizations. Refer to :pep:`3154` for information about improvements + brought by protocol 4. + +.. note:: + Serialization is a more primitive notion than persistence; although + :mod:`pickle` reads and writes file objects, it does not handle the issue of + naming persistent objects, nor the (even more complicated) issue of concurrent + access to persistent objects. The :mod:`pickle` module can transform a complex + object into a byte stream and it can transform the byte stream into an object + with the same internal structure. Perhaps the most obvious thing to do with + these byte streams is to write them onto a file, but it is also conceivable to + send them across a network or store them in a database. The :mod:`shelve` + module provides a simple interface to pickle and unpickle objects on + DBM-style database files. + + +Module Interface +---------------- + +To serialize an object hierarchy, you simply call the :func:`dumps` function. +Similarly, to de-serialize a data stream, you call the :func:`loads` function. +However, if you want more control over serialization and de-serialization, +you can create a :class:`Pickler` or an :class:`Unpickler` object, respectively. + +The :mod:`pickle` module provides the following constants: + + +.. data:: HIGHEST_PROTOCOL + + An integer, the highest :ref:`protocol version ` + available. This value can be passed as a *protocol* value to functions + :func:`dump` and :func:`dumps` as well as the :class:`Pickler` + constructor. + +.. data:: DEFAULT_PROTOCOL + + An integer, the default :ref:`protocol version ` used + for pickling. May be less than :data:`HIGHEST_PROTOCOL`. Currently the + default protocol is 3, a new protocol designed for Python 3. + + +The :mod:`pickle` module provides the following functions to make the pickling +process more convenient: + +.. function:: dump(obj, file, protocol=None, \*, fix_imports=True) + + Write a pickled representation of *obj* to the open :term:`file object` *file*. + This is equivalent to ``Pickler(file, protocol).dump(obj)``. + + The optional *protocol* argument, an integer, tells the pickler to use + the given protocol; supported protocols are 0 to :data:`HIGHEST_PROTOCOL`. + If not specified, the default is :data:`DEFAULT_PROTOCOL`. If a negative + number is specified, :data:`HIGHEST_PROTOCOL` is selected. + + The *file* argument must have a write() method that accepts a single bytes + argument. It can thus be an on-disk file opened for binary writing, an + :class:`io.BytesIO` instance, or any other custom object that meets this + interface. + + If *fix_imports* is true and *protocol* is less than 3, pickle will try to + map the new Python 3 names to the old module names used in Python 2, so + that the pickle data stream is readable with Python 2. + +.. function:: dumps(obj, protocol=None, \*, fix_imports=True) + + Return the pickled representation of the object as a :class:`bytes` object, + instead of writing it to a file. + + Arguments *protocol* and *fix_imports* have the same meaning as in + :func:`dump`. + +.. function:: load(file, \*, fix_imports=True, encoding="ASCII", errors="strict") + + Read a pickled object representation from the open :term:`file object` + *file* and return the reconstituted object hierarchy specified therein. + This is equivalent to ``Unpickler(file).load()``. + + The protocol version of the pickle is detected automatically, so no + protocol argument is needed. Bytes past the pickled object's + representation are ignored. + + The argument *file* must have two methods, a read() method that takes an + integer argument, and a readline() method that requires no arguments. Both + methods should return bytes. Thus *file* can be an on-disk file opened for + binary reading, an :class:`io.BytesIO` object, or any other custom object + that meets this interface. + + Optional keyword arguments are *fix_imports*, *encoding* and *errors*, + which are used to control compatibility support for pickle stream generated + by Python 2. If *fix_imports* is true, pickle will try to map the old + Python 2 names to the new names used in Python 3. The *encoding* and + *errors* tell pickle how to decode 8-bit string instances pickled by Python + 2; these default to 'ASCII' and 'strict', respectively. The *encoding* can + be 'bytes' to read these 8-bit string instances as bytes objects. + Using ``encoding='latin1'`` is required for unpickling NumPy arrays and + instances of :class:`~datetime.datetime`, :class:`~datetime.date` and + :class:`~datetime.time` pickled by Python 2. + +.. function:: loads(bytes_object, \*, fix_imports=True, encoding="ASCII", errors="strict") + + Read a pickled object hierarchy from a :class:`bytes` object and return the + reconstituted object hierarchy specified therein. + + The protocol version of the pickle is detected automatically, so no + protocol argument is needed. Bytes past the pickled object's + representation are ignored. + + Optional keyword arguments are *fix_imports*, *encoding* and *errors*, + which are used to control compatibility support for pickle stream generated + by Python 2. If *fix_imports* is true, pickle will try to map the old + Python 2 names to the new names used in Python 3. The *encoding* and + *errors* tell pickle how to decode 8-bit string instances pickled by Python + 2; these default to 'ASCII' and 'strict', respectively. The *encoding* can + be 'bytes' to read these 8-bit string instances as bytes objects. + Using ``encoding='latin1'`` is required for unpickling NumPy arrays and + instances of :class:`~datetime.datetime`, :class:`~datetime.date` and + :class:`~datetime.time` pickled by Python 2. + + +The :mod:`pickle` module defines three exceptions: + +.. exception:: PickleError + + Common base class for the other pickling exceptions. It inherits + :exc:`Exception`. + +.. exception:: PicklingError + + Error raised when an unpicklable object is encountered by :class:`Pickler`. + It inherits :exc:`PickleError`. + + Refer to :ref:`pickle-picklable` to learn what kinds of objects can be + pickled. + +.. exception:: UnpicklingError + + Error raised when there is a problem unpickling an object, such as a data + corruption or a security violation. It inherits :exc:`PickleError`. + + Note that other exceptions may also be raised during unpickling, including + (but not necessarily limited to) AttributeError, EOFError, ImportError, and + IndexError. + + +The :mod:`pickle` module exports two classes, :class:`Pickler` and +:class:`Unpickler`: + +.. class:: Pickler(file, protocol=None, \*, fix_imports=True) + + This takes a binary file for writing a pickle data stream. + + The optional *protocol* argument, an integer, tells the pickler to use + the given protocol; supported protocols are 0 to :data:`HIGHEST_PROTOCOL`. + If not specified, the default is :data:`DEFAULT_PROTOCOL`. If a negative + number is specified, :data:`HIGHEST_PROTOCOL` is selected. + + The *file* argument must have a write() method that accepts a single bytes + argument. It can thus be an on-disk file opened for binary writing, an + :class:`io.BytesIO` instance, or any other custom object that meets this + interface. + + If *fix_imports* is true and *protocol* is less than 3, pickle will try to + map the new Python 3 names to the old module names used in Python 2, so + that the pickle data stream is readable with Python 2. + + .. method:: dump(obj) + + Write a pickled representation of *obj* to the open file object given in + the constructor. + + .. method:: persistent_id(obj) + + Do nothing by default. This exists so a subclass can override it. + + If :meth:`persistent_id` returns ``None``, *obj* is pickled as usual. Any + other value causes :class:`Pickler` to emit the returned value as a + persistent ID for *obj*. The meaning of this persistent ID should be + defined by :meth:`Unpickler.persistent_load`. Note that the value + returned by :meth:`persistent_id` cannot itself have a persistent ID. + + See :ref:`pickle-persistent` for details and examples of uses. + + .. attribute:: dispatch_table + + A pickler object's dispatch table is a registry of *reduction + functions* of the kind which can be declared using + :func:`copyreg.pickle`. It is a mapping whose keys are classes + and whose values are reduction functions. A reduction function + takes a single argument of the associated class and should + conform to the same interface as a :meth:`__reduce__` + method. + + By default, a pickler object will not have a + :attr:`dispatch_table` attribute, and it will instead use the + global dispatch table managed by the :mod:`copyreg` module. + However, to customize the pickling for a specific pickler object + one can set the :attr:`dispatch_table` attribute to a dict-like + object. Alternatively, if a subclass of :class:`Pickler` has a + :attr:`dispatch_table` attribute then this will be used as the + default dispatch table for instances of that class. + + See :ref:`pickle-dispatch` for usage examples. + + .. versionadded:: 3.3 + + .. attribute:: fast + + Deprecated. Enable fast mode if set to a true value. The fast mode + disables the usage of memo, therefore speeding the pickling process by not + generating superfluous PUT opcodes. It should not be used with + self-referential objects, doing otherwise will cause :class:`Pickler` to + recurse infinitely. + + Use :func:`pickletools.optimize` if you need more compact pickles. + + +.. class:: Unpickler(file, \*, fix_imports=True, encoding="ASCII", errors="strict") + + This takes a binary file for reading a pickle data stream. + + The protocol version of the pickle is detected automatically, so no + protocol argument is needed. + + The argument *file* must have two methods, a read() method that takes an + integer argument, and a readline() method that requires no arguments. Both + methods should return bytes. Thus *file* can be an on-disk file object + opened for binary reading, an :class:`io.BytesIO` object, or any other + custom object that meets this interface. + + Optional keyword arguments are *fix_imports*, *encoding* and *errors*, + which are used to control compatibility support for pickle stream generated + by Python 2. If *fix_imports* is true, pickle will try to map the old + Python 2 names to the new names used in Python 3. The *encoding* and + *errors* tell pickle how to decode 8-bit string instances pickled by Python + 2; these default to 'ASCII' and 'strict', respectively. The *encoding* can + be 'bytes' to read these 8-bit string instances as bytes objects. + + .. method:: load() + + Read a pickled object representation from the open file object given in + the constructor, and return the reconstituted object hierarchy specified + therein. Bytes past the pickled object's representation are ignored. + + .. method:: persistent_load(pid) + + Raise an :exc:`UnpicklingError` by default. + + If defined, :meth:`persistent_load` should return the object specified by + the persistent ID *pid*. If an invalid persistent ID is encountered, an + :exc:`UnpicklingError` should be raised. + + See :ref:`pickle-persistent` for details and examples of uses. + + .. method:: find_class(module, name) + + Import *module* if necessary and return the object called *name* from it, + where the *module* and *name* arguments are :class:`str` objects. Note, + unlike its name suggests, :meth:`find_class` is also used for finding + functions. + + Subclasses may override this to gain control over what type of objects and + how they can be loaded, potentially reducing security risks. Refer to + :ref:`pickle-restrict` for details. + + +.. _pickle-picklable: + +What can be pickled and unpickled? +---------------------------------- + +The following types can be pickled: + +* ``None``, ``True``, and ``False`` + +* integers, floating point numbers, complex numbers + +* strings, bytes, bytearrays + +* tuples, lists, sets, and dictionaries containing only picklable objects + +* functions defined at the top level of a module (using :keyword:`def`, not + :keyword:`lambda`) + +* built-in functions defined at the top level of a module + +* classes that are defined at the top level of a module + +* instances of such classes whose :attr:`~object.__dict__` or the result of + calling :meth:`__getstate__` is picklable (see section :ref:`pickle-inst` for + details). + +Attempts to pickle unpicklable objects will raise the :exc:`PicklingError` +exception; when this happens, an unspecified number of bytes may have already +been written to the underlying file. Trying to pickle a highly recursive data +structure may exceed the maximum recursion depth, a :exc:`RecursionError` will be +raised in this case. You can carefully raise this limit with +:func:`sys.setrecursionlimit`. + +Note that functions (built-in and user-defined) are pickled by "fully qualified" +name reference, not by value. [#]_ This means that only the function name is +pickled, along with the name of the module the function is defined in. Neither +the function's code, nor any of its function attributes are pickled. Thus the +defining module must be importable in the unpickling environment, and the module +must contain the named object, otherwise an exception will be raised. [#]_ + +Similarly, classes are pickled by named reference, so the same restrictions in +the unpickling environment apply. Note that none of the class's code or data is +pickled, so in the following example the class attribute ``attr`` is not +restored in the unpickling environment:: + + class Foo: + attr = 'A class attribute' + + picklestring = pickle.dumps(Foo) + +These restrictions are why picklable functions and classes must be defined in +the top level of a module. + +Similarly, when class instances are pickled, their class's code and data are not +pickled along with them. Only the instance data are pickled. This is done on +purpose, so you can fix bugs in a class or add methods to the class and still +load objects that were created with an earlier version of the class. If you +plan to have long-lived objects that will see many versions of a class, it may +be worthwhile to put a version number in the objects so that suitable +conversions can be made by the class's :meth:`__setstate__` method. + + +.. _pickle-inst: + +Pickling Class Instances +------------------------ + +.. currentmodule:: None + +In this section, we describe the general mechanisms available to you to define, +customize, and control how class instances are pickled and unpickled. + +In most cases, no additional code is needed to make instances picklable. By +default, pickle will retrieve the class and the attributes of an instance via +introspection. When a class instance is unpickled, its :meth:`__init__` method +is usually *not* invoked. The default behaviour first creates an uninitialized +instance and then restores the saved attributes. The following code shows an +implementation of this behaviour:: + + def save(obj): + return (obj.__class__, obj.__dict__) + + def load(cls, attributes): + obj = cls.__new__(cls) + obj.__dict__.update(attributes) + return obj + +Classes can alter the default behaviour by providing one or several special +methods: + +.. method:: object.__getnewargs_ex__() + + In protocols 2 and newer, classes that implements the + :meth:`__getnewargs_ex__` method can dictate the values passed to the + :meth:`__new__` method upon unpickling. The method must return a pair + ``(args, kwargs)`` where *args* is a tuple of positional arguments + and *kwargs* a dictionary of named arguments for constructing the + object. Those will be passed to the :meth:`__new__` method upon + unpickling. + + You should implement this method if the :meth:`__new__` method of your + class requires keyword-only arguments. Otherwise, it is recommended for + compatibility to implement :meth:`__getnewargs__`. + + .. versionchanged:: 3.6 + :meth:`__getnewargs_ex__` is now used in protocols 2 and 3. + + +.. method:: object.__getnewargs__() + + This method serves a similar purpose as :meth:`__getnewargs_ex__`, but + supports only positional arguments. It must return a tuple of arguments + ``args`` which will be passed to the :meth:`__new__` method upon unpickling. + + :meth:`__getnewargs__` will not be called if :meth:`__getnewargs_ex__` is + defined. + + .. versionchanged:: 3.6 + Before Python 3.6, :meth:`__getnewargs__` was called instead of + :meth:`__getnewargs_ex__` in protocols 2 and 3. + + +.. method:: object.__getstate__() + + Classes can further influence how their instances are pickled; if the class + defines the method :meth:`__getstate__`, it is called and the returned object + is pickled as the contents for the instance, instead of the contents of the + instance's dictionary. If the :meth:`__getstate__` method is absent, the + instance's :attr:`~object.__dict__` is pickled as usual. + + +.. method:: object.__setstate__(state) + + Upon unpickling, if the class defines :meth:`__setstate__`, it is called with + the unpickled state. In that case, there is no requirement for the state + object to be a dictionary. Otherwise, the pickled state must be a dictionary + and its items are assigned to the new instance's dictionary. + + .. note:: + + If :meth:`__getstate__` returns a false value, the :meth:`__setstate__` + method will not be called upon unpickling. + + +Refer to the section :ref:`pickle-state` for more information about how to use +the methods :meth:`__getstate__` and :meth:`__setstate__`. + +.. note:: + + At unpickling time, some methods like :meth:`__getattr__`, + :meth:`__getattribute__`, or :meth:`__setattr__` may be called upon the + instance. In case those methods rely on some internal invariant being + true, the type should implement :meth:`__getnewargs__` or + :meth:`__getnewargs_ex__` to establish such an invariant; otherwise, + neither :meth:`__new__` nor :meth:`__init__` will be called. + +.. index:: pair: copy; protocol + +As we shall see, pickle does not use directly the methods described above. In +fact, these methods are part of the copy protocol which implements the +:meth:`__reduce__` special method. The copy protocol provides a unified +interface for retrieving the data necessary for pickling and copying +objects. [#]_ + +Although powerful, implementing :meth:`__reduce__` directly in your classes is +error prone. For this reason, class designers should use the high-level +interface (i.e., :meth:`__getnewargs_ex__`, :meth:`__getstate__` and +:meth:`__setstate__`) whenever possible. We will show, however, cases where +using :meth:`__reduce__` is the only option or leads to more efficient pickling +or both. + +.. method:: object.__reduce__() + + The interface is currently defined as follows. The :meth:`__reduce__` method + takes no argument and shall return either a string or preferably a tuple (the + returned object is often referred to as the "reduce value"). + + If a string is returned, the string should be interpreted as the name of a + global variable. It should be the object's local name relative to its + module; the pickle module searches the module namespace to determine the + object's module. This behaviour is typically useful for singletons. + + When a tuple is returned, it must be between two and five items long. + Optional items can either be omitted, or ``None`` can be provided as their + value. The semantics of each item are in order: + + .. XXX Mention __newobj__ special-case? + + * A callable object that will be called to create the initial version of the + object. + + * A tuple of arguments for the callable object. An empty tuple must be given + if the callable does not accept any argument. + + * Optionally, the object's state, which will be passed to the object's + :meth:`__setstate__` method as previously described. If the object has no + such method then, the value must be a dictionary and it will be added to + the object's :attr:`~object.__dict__` attribute. + + * Optionally, an iterator (and not a sequence) yielding successive items. + These items will be appended to the object either using + ``obj.append(item)`` or, in batch, using ``obj.extend(list_of_items)``. + This is primarily used for list subclasses, but may be used by other + classes as long as they have :meth:`append` and :meth:`extend` methods with + the appropriate signature. (Whether :meth:`append` or :meth:`extend` is + used depends on which pickle protocol version is used as well as the number + of items to append, so both must be supported.) + + * Optionally, an iterator (not a sequence) yielding successive key-value + pairs. These items will be stored to the object using ``obj[key] = + value``. This is primarily used for dictionary subclasses, but may be used + by other classes as long as they implement :meth:`__setitem__`. + + +.. method:: object.__reduce_ex__(protocol) + + Alternatively, a :meth:`__reduce_ex__` method may be defined. The only + difference is this method should take a single integer argument, the protocol + version. When defined, pickle will prefer it over the :meth:`__reduce__` + method. In addition, :meth:`__reduce__` automatically becomes a synonym for + the extended version. The main use for this method is to provide + backwards-compatible reduce values for older Python releases. + +.. currentmodule:: pickle + +.. _pickle-persistent: + +Persistence of External Objects +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. index:: + single: persistent_id (pickle protocol) + single: persistent_load (pickle protocol) + +For the benefit of object persistence, the :mod:`pickle` module supports the +notion of a reference to an object outside the pickled data stream. Such +objects are referenced by a persistent ID, which should be either a string of +alphanumeric characters (for protocol 0) [#]_ or just an arbitrary object (for +any newer protocol). + +The resolution of such persistent IDs is not defined by the :mod:`pickle` +module; it will delegate this resolution to the user defined methods on the +pickler and unpickler, :meth:`~Pickler.persistent_id` and +:meth:`~Unpickler.persistent_load` respectively. + +To pickle objects that have an external persistent id, the pickler must have a +custom :meth:`~Pickler.persistent_id` method that takes an object as an +argument and returns either ``None`` or the persistent id for that object. +When ``None`` is returned, the pickler simply pickles the object as normal. +When a persistent ID string is returned, the pickler will pickle that object, +along with a marker so that the unpickler will recognize it as a persistent ID. + +To unpickle external objects, the unpickler must have a custom +:meth:`~Unpickler.persistent_load` method that takes a persistent ID object and +returns the referenced object. + +Here is a comprehensive example presenting how persistent ID can be used to +pickle external objects by reference. + +.. literalinclude:: ../includes/dbpickle.py + +.. _pickle-dispatch: + +Dispatch Tables +^^^^^^^^^^^^^^^ + +If one wants to customize pickling of some classes without disturbing +any other code which depends on pickling, then one can create a +pickler with a private dispatch table. + +The global dispatch table managed by the :mod:`copyreg` module is +available as :data:`copyreg.dispatch_table`. Therefore, one may +choose to use a modified copy of :data:`copyreg.dispatch_table` as a +private dispatch table. + +For example :: + + f = io.BytesIO() + p = pickle.Pickler(f) + p.dispatch_table = copyreg.dispatch_table.copy() + p.dispatch_table[SomeClass] = reduce_SomeClass + +creates an instance of :class:`pickle.Pickler` with a private dispatch +table which handles the ``SomeClass`` class specially. Alternatively, +the code :: + + class MyPickler(pickle.Pickler): + dispatch_table = copyreg.dispatch_table.copy() + dispatch_table[SomeClass] = reduce_SomeClass + f = io.BytesIO() + p = MyPickler(f) + +does the same, but all instances of ``MyPickler`` will by default +share the same dispatch table. The equivalent code using the +:mod:`copyreg` module is :: + + copyreg.pickle(SomeClass, reduce_SomeClass) + f = io.BytesIO() + p = pickle.Pickler(f) + +.. _pickle-state: + +Handling Stateful Objects +^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. index:: + single: __getstate__() (copy protocol) + single: __setstate__() (copy protocol) + +Here's an example that shows how to modify pickling behavior for a class. +The :class:`TextReader` class opens a text file, and returns the line number and +line contents each time its :meth:`!readline` method is called. If a +:class:`TextReader` instance is pickled, all attributes *except* the file object +member are saved. When the instance is unpickled, the file is reopened, and +reading resumes from the last location. The :meth:`__setstate__` and +:meth:`__getstate__` methods are used to implement this behavior. :: + + class TextReader: + """Print and number lines in a text file.""" + + def __init__(self, filename): + self.filename = filename + self.file = open(filename) + self.lineno = 0 + + def readline(self): + self.lineno += 1 + line = self.file.readline() + if not line: + return None + if line.endswith('\n'): + line = line[:-1] + return "%i: %s" % (self.lineno, line) + + def __getstate__(self): + # Copy the object's state from self.__dict__ which contains + # all our instance attributes. Always use the dict.copy() + # method to avoid modifying the original state. + state = self.__dict__.copy() + # Remove the unpicklable entries. + del state['file'] + return state + + def __setstate__(self, state): + # Restore instance attributes (i.e., filename and lineno). + self.__dict__.update(state) + # Restore the previously opened file's state. To do so, we need to + # reopen it and read from it until the line count is restored. + file = open(self.filename) + for _ in range(self.lineno): + file.readline() + # Finally, save the file. + self.file = file + + +A sample usage might be something like this:: + + >>> reader = TextReader("hello.txt") + >>> reader.readline() + '1: Hello world!' + >>> reader.readline() + '2: I am line number two.' + >>> new_reader = pickle.loads(pickle.dumps(reader)) + >>> new_reader.readline() + '3: Goodbye!' + + +.. _pickle-restrict: + +Restricting Globals +------------------- + +.. index:: + single: find_class() (pickle protocol) + +By default, unpickling will import any class or function that it finds in the +pickle data. For many applications, this behaviour is unacceptable as it +permits the unpickler to import and invoke arbitrary code. Just consider what +this hand-crafted pickle data stream does when loaded:: + + >>> import pickle + >>> pickle.loads(b"cos\nsystem\n(S'echo hello world'\ntR.") + hello world + 0 + +In this example, the unpickler imports the :func:`os.system` function and then +apply the string argument "echo hello world". Although this example is +inoffensive, it is not difficult to imagine one that could damage your system. + +For this reason, you may want to control what gets unpickled by customizing +:meth:`Unpickler.find_class`. Unlike its name suggests, +:meth:`Unpickler.find_class` is called whenever a global (i.e., a class or +a function) is requested. Thus it is possible to either completely forbid +globals or restrict them to a safe subset. + +Here is an example of an unpickler allowing only few safe classes from the +:mod:`builtins` module to be loaded:: + + import builtins + import io + import pickle + + safe_builtins = { + 'range', + 'complex', + 'set', + 'frozenset', + 'slice', + } + + class RestrictedUnpickler(pickle.Unpickler): + + def find_class(self, module, name): + # Only allow safe classes from builtins. + if module == "builtins" and name in safe_builtins: + return getattr(builtins, name) + # Forbid everything else. + raise pickle.UnpicklingError("global '%s.%s' is forbidden" % + (module, name)) + + def restricted_loads(s): + """Helper function analogous to pickle.loads().""" + return RestrictedUnpickler(io.BytesIO(s)).load() + +A sample usage of our unpickler working has intended:: + + >>> restricted_loads(pickle.dumps([1, 2, range(15)])) + [1, 2, range(0, 15)] + >>> restricted_loads(b"cos\nsystem\n(S'echo hello world'\ntR.") + Traceback (most recent call last): + ... + pickle.UnpicklingError: global 'os.system' is forbidden + >>> restricted_loads(b'cbuiltins\neval\n' + ... b'(S\'getattr(__import__("os"), "system")' + ... b'("echo hello world")\'\ntR.') + Traceback (most recent call last): + ... + pickle.UnpicklingError: global 'builtins.eval' is forbidden + + +.. XXX Add note about how extension codes could evade our protection + mechanism (e.g. cached classes do not invokes find_class()). + +As our examples shows, you have to be careful with what you allow to be +unpickled. Therefore if security is a concern, you may want to consider +alternatives such as the marshalling API in :mod:`xmlrpc.client` or +third-party solutions. + + +Performance +----------- + +Recent versions of the pickle protocol (from protocol 2 and upwards) feature +efficient binary encodings for several common features and built-in types. +Also, the :mod:`pickle` module has a transparent optimizer written in C. + + +.. _pickle-example: + +Examples +-------- + +For the simplest code, use the :func:`dump` and :func:`load` functions. :: + + import pickle + + # An arbitrary collection of objects supported by pickle. + data = { + 'a': [1, 2.0, 3, 4+6j], + 'b': ("character string", b"byte string"), + 'c': {None, True, False} + } + + with open('data.pickle', 'wb') as f: + # Pickle the 'data' dictionary using the highest protocol available. + pickle.dump(data, f, pickle.HIGHEST_PROTOCOL) + + +The following example reads the resulting pickled data. :: + + import pickle + + with open('data.pickle', 'rb') as f: + # The protocol version used is detected automatically, so we do not + # have to specify it. + data = pickle.load(f) + + +.. XXX: Add examples showing how to optimize pickles for size (like using +.. pickletools.optimize() or the gzip module). + + +.. seealso:: + + Module :mod:`copyreg` + Pickle interface constructor registration for extension types. + + Module :mod:`pickletools` + Tools for working with and analyzing pickled data. + + Module :mod:`shelve` + Indexed databases of objects; uses :mod:`pickle`. + + Module :mod:`copy` + Shallow and deep object copying. + + Module :mod:`marshal` + High-performance serialization of built-in types. + + +.. rubric:: Footnotes + +.. [#] Don't confuse this with the :mod:`marshal` module + +.. [#] This is why :keyword:`lambda` functions cannot be pickled: all + :keyword:`!lambda` functions share the same name: ````. + +.. [#] The exception raised will likely be an :exc:`ImportError` or an + :exc:`AttributeError` but it could be something else. + +.. [#] The :mod:`copy` module uses this protocol for shallow and deep copying + operations. + +.. [#] The limitation on alphanumeric characters is due to the fact + the persistent IDs, in protocol 0, are delimited by the newline + character. Therefore if any kind of newline characters occurs in + persistent IDs, the resulting pickle will become unreadable. diff --git a/python-3.7.4-docs-html/_sources/library/pickletools.rst.txt b/python-3.7.4-docs-html/_sources/library/pickletools.rst.txt new file mode 100644 index 0000000..480f4a6 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/pickletools.rst.txt @@ -0,0 +1,110 @@ +:mod:`pickletools` --- Tools for pickle developers +================================================== + +.. module:: pickletools + :synopsis: Contains extensive comments about the pickle protocols and + pickle-machine opcodes, as well as some useful functions. + +**Source code:** :source:`Lib/pickletools.py` + +-------------- + + +This module contains various constants relating to the intimate details of the +:mod:`pickle` module, some lengthy comments about the implementation, and a +few useful functions for analyzing pickled data. The contents of this module +are useful for Python core developers who are working on the :mod:`pickle`; +ordinary users of the :mod:`pickle` module probably won't find the +:mod:`pickletools` module relevant. + +Command line usage +------------------ + +.. versionadded:: 3.2 + +When invoked from the command line, ``python -m pickletools`` will +disassemble the contents of one or more pickle files. Note that if +you want to see the Python object stored in the pickle rather than the +details of pickle format, you may want to use ``-m pickle`` instead. +However, when the pickle file that you want to examine comes from an +untrusted source, ``-m pickletools`` is a safer option because it does +not execute pickle bytecode. + +For example, with a tuple ``(1, 2)`` pickled in file ``x.pickle``: + +.. code-block:: shell-session + + $ python -m pickle x.pickle + (1, 2) + + $ python -m pickletools x.pickle + 0: \x80 PROTO 3 + 2: K BININT1 1 + 4: K BININT1 2 + 6: \x86 TUPLE2 + 7: q BINPUT 0 + 9: . STOP + highest protocol among opcodes = 2 + +Command line options +^^^^^^^^^^^^^^^^^^^^ + +.. program:: pickletools + +.. cmdoption:: -a, --annotate + + Annotate each line with a short opcode description. + +.. cmdoption:: -o, --output= + + Name of a file where the output should be written. + +.. cmdoption:: -l, --indentlevel= + + The number of blanks by which to indent a new MARK level. + +.. cmdoption:: -m, --memo + + When multiple objects are disassembled, preserve memo between + disassemblies. + +.. cmdoption:: -p, --preamble= + + When more than one pickle file are specified, print given preamble + before each disassembly. + + + +Programmatic Interface +---------------------- + + +.. function:: dis(pickle, out=None, memo=None, indentlevel=4, annotate=0) + + Outputs a symbolic disassembly of the pickle to the file-like + object *out*, defaulting to ``sys.stdout``. *pickle* can be a + string or a file-like object. *memo* can be a Python dictionary + that will be used as the pickle's memo; it can be used to perform + disassemblies across multiple pickles created by the same + pickler. Successive levels, indicated by ``MARK`` opcodes in the + stream, are indented by *indentlevel* spaces. If a nonzero value + is given to *annotate*, each opcode in the output is annotated with + a short description. The value of *annotate* is used as a hint for + the column where annotation should start. + + .. versionadded:: 3.2 + The *annotate* argument. + +.. function:: genops(pickle) + + Provides an :term:`iterator` over all of the opcodes in a pickle, returning a + sequence of ``(opcode, arg, pos)`` triples. *opcode* is an instance of an + :class:`OpcodeInfo` class; *arg* is the decoded value, as a Python object, of + the opcode's argument; *pos* is the position at which this opcode is located. + *pickle* can be a string or a file-like object. + +.. function:: optimize(picklestring) + + Returns a new equivalent pickle string after eliminating unused ``PUT`` + opcodes. The optimized pickle is shorter, takes less transmission time, + requires less storage space, and unpickles more efficiently. diff --git a/python-3.7.4-docs-html/_sources/library/pipes.rst.txt b/python-3.7.4-docs-html/_sources/library/pipes.rst.txt new file mode 100644 index 0000000..0a22da1 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/pipes.rst.txt @@ -0,0 +1,95 @@ +:mod:`pipes` --- Interface to shell pipelines +============================================= + +.. module:: pipes + :platform: Unix + :synopsis: A Python interface to Unix shell pipelines. + +.. sectionauthor:: Moshe Zadka + +**Source code:** :source:`Lib/pipes.py` + +-------------- + +The :mod:`pipes` module defines a class to abstract the concept of a *pipeline* +--- a sequence of converters from one file to another. + +Because the module uses :program:`/bin/sh` command lines, a POSIX or compatible +shell for :func:`os.system` and :func:`os.popen` is required. + +The :mod:`pipes` module defines the following class: + + +.. class:: Template() + + An abstraction of a pipeline. + +Example:: + + >>> import pipes + >>> t = pipes.Template() + >>> t.append('tr a-z A-Z', '--') + >>> f = t.open('pipefile', 'w') + >>> f.write('hello world') + >>> f.close() + >>> open('pipefile').read() + 'HELLO WORLD' + + +.. _template-objects: + +Template Objects +---------------- + +Template objects following methods: + + +.. method:: Template.reset() + + Restore a pipeline template to its initial state. + + +.. method:: Template.clone() + + Return a new, equivalent, pipeline template. + + +.. method:: Template.debug(flag) + + If *flag* is true, turn debugging on. Otherwise, turn debugging off. When + debugging is on, commands to be executed are printed, and the shell is given + ``set -x`` command to be more verbose. + + +.. method:: Template.append(cmd, kind) + + Append a new action at the end. The *cmd* variable must be a valid bourne shell + command. The *kind* variable consists of two letters. + + The first letter can be either of ``'-'`` (which means the command reads its + standard input), ``'f'`` (which means the commands reads a given file on the + command line) or ``'.'`` (which means the commands reads no input, and hence + must be first.) + + Similarly, the second letter can be either of ``'-'`` (which means the command + writes to standard output), ``'f'`` (which means the command writes a file on + the command line) or ``'.'`` (which means the command does not write anything, + and hence must be last.) + + +.. method:: Template.prepend(cmd, kind) + + Add a new action at the beginning. See :meth:`append` for explanations of the + arguments. + + +.. method:: Template.open(file, mode) + + Return a file-like object, open to *file*, but read from or written to by the + pipeline. Note that only one of ``'r'``, ``'w'`` may be given. + + +.. method:: Template.copy(infile, outfile) + + Copy *infile* to *outfile* through the pipe. + diff --git a/python-3.7.4-docs-html/_sources/library/pkgutil.rst.txt b/python-3.7.4-docs-html/_sources/library/pkgutil.rst.txt new file mode 100644 index 0000000..fba0ea6 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/pkgutil.rst.txt @@ -0,0 +1,229 @@ +:mod:`pkgutil` --- Package extension utility +============================================ + +.. module:: pkgutil + :synopsis: Utilities for the import system. + +**Source code:** :source:`Lib/pkgutil.py` + +-------------- + +This module provides utilities for the import system, in particular package +support. + +.. class:: ModuleInfo(module_finder, name, ispkg) + + A namedtuple that holds a brief summary of a module's info. + + .. versionadded:: 3.6 + +.. function:: extend_path(path, name) + + Extend the search path for the modules which comprise a package. Intended + use is to place the following code in a package's :file:`__init__.py`:: + + from pkgutil import extend_path + __path__ = extend_path(__path__, __name__) + + This will add to the package's ``__path__`` all subdirectories of directories + on ``sys.path`` named after the package. This is useful if one wants to + distribute different parts of a single logical package as multiple + directories. + + It also looks for :file:`\*.pkg` files beginning where ``*`` matches the + *name* argument. This feature is similar to :file:`\*.pth` files (see the + :mod:`site` module for more information), except that it doesn't special-case + lines starting with ``import``. A :file:`\*.pkg` file is trusted at face + value: apart from checking for duplicates, all entries found in a + :file:`\*.pkg` file are added to the path, regardless of whether they exist + on the filesystem. (This is a feature.) + + If the input path is not a list (as is the case for frozen packages) it is + returned unchanged. The input path is not modified; an extended copy is + returned. Items are only appended to the copy at the end. + + It is assumed that :data:`sys.path` is a sequence. Items of :data:`sys.path` + that are not strings referring to existing directories are ignored. Unicode + items on :data:`sys.path` that cause errors when used as filenames may cause + this function to raise an exception (in line with :func:`os.path.isdir` + behavior). + + +.. class:: ImpImporter(dirname=None) + + :pep:`302` Finder that wraps Python's "classic" import algorithm. + + If *dirname* is a string, a :pep:`302` finder is created that searches that + directory. If *dirname* is ``None``, a :pep:`302` finder is created that + searches the current :data:`sys.path`, plus any modules that are frozen or + built-in. + + Note that :class:`ImpImporter` does not currently support being used by + placement on :data:`sys.meta_path`. + + .. deprecated:: 3.3 + This emulation is no longer needed, as the standard import mechanism + is now fully PEP 302 compliant and available in :mod:`importlib`. + + +.. class:: ImpLoader(fullname, file, filename, etc) + + :term:`Loader` that wraps Python's "classic" import algorithm. + + .. deprecated:: 3.3 + This emulation is no longer needed, as the standard import mechanism + is now fully PEP 302 compliant and available in :mod:`importlib`. + + +.. function:: find_loader(fullname) + + Retrieve a module :term:`loader` for the given *fullname*. + + This is a backwards compatibility wrapper around + :func:`importlib.util.find_spec` that converts most failures to + :exc:`ImportError` and only returns the loader rather than the full + :class:`ModuleSpec`. + + .. versionchanged:: 3.3 + Updated to be based directly on :mod:`importlib` rather than relying + on the package internal PEP 302 import emulation. + + .. versionchanged:: 3.4 + Updated to be based on :pep:`451` + +.. function:: get_importer(path_item) + + Retrieve a :term:`finder` for the given *path_item*. + + The returned finder is cached in :data:`sys.path_importer_cache` if it was + newly created by a path hook. + + The cache (or part of it) can be cleared manually if a rescan of + :data:`sys.path_hooks` is necessary. + + .. versionchanged:: 3.3 + Updated to be based directly on :mod:`importlib` rather than relying + on the package internal PEP 302 import emulation. + + +.. function:: get_loader(module_or_name) + + Get a :term:`loader` object for *module_or_name*. + + If the module or package is accessible via the normal import mechanism, a + wrapper around the relevant part of that machinery is returned. Returns + ``None`` if the module cannot be found or imported. If the named module is + not already imported, its containing package (if any) is imported, in order + to establish the package ``__path__``. + + .. versionchanged:: 3.3 + Updated to be based directly on :mod:`importlib` rather than relying + on the package internal PEP 302 import emulation. + + .. versionchanged:: 3.4 + Updated to be based on :pep:`451` + + +.. function:: iter_importers(fullname='') + + Yield :term:`finder` objects for the given module name. + + If fullname contains a '.', the finders will be for the package + containing fullname, otherwise they will be all registered top level + finders (i.e. those on both sys.meta_path and sys.path_hooks). + + If the named module is in a package, that package is imported as a side + effect of invoking this function. + + If no module name is specified, all top level finders are produced. + + .. versionchanged:: 3.3 + Updated to be based directly on :mod:`importlib` rather than relying + on the package internal PEP 302 import emulation. + + +.. function:: iter_modules(path=None, prefix='') + + Yields :class:`ModuleInfo` for all submodules on *path*, or, if + *path* is ``None``, all top-level modules on ``sys.path``. + + *path* should be either ``None`` or a list of paths to look for modules in. + + *prefix* is a string to output on the front of every module name on output. + + .. note:: + + Only works for a :term:`finder` which defines an ``iter_modules()`` + method. This interface is non-standard, so the module also provides + implementations for :class:`importlib.machinery.FileFinder` and + :class:`zipimport.zipimporter`. + + .. versionchanged:: 3.3 + Updated to be based directly on :mod:`importlib` rather than relying + on the package internal PEP 302 import emulation. + + +.. function:: walk_packages(path=None, prefix='', onerror=None) + + Yields :class:`ModuleInfo` for all modules recursively on + *path*, or, if *path* is ``None``, all accessible modules. + + *path* should be either ``None`` or a list of paths to look for modules in. + + *prefix* is a string to output on the front of every module name on output. + + Note that this function must import all *packages* (*not* all modules!) on + the given *path*, in order to access the ``__path__`` attribute to find + submodules. + + *onerror* is a function which gets called with one argument (the name of the + package which was being imported) if any exception occurs while trying to + import a package. If no *onerror* function is supplied, :exc:`ImportError`\s + are caught and ignored, while all other exceptions are propagated, + terminating the search. + + Examples:: + + # list all modules python can access + walk_packages() + + # list all submodules of ctypes + walk_packages(ctypes.__path__, ctypes.__name__ + '.') + + .. note:: + + Only works for a :term:`finder` which defines an ``iter_modules()`` + method. This interface is non-standard, so the module also provides + implementations for :class:`importlib.machinery.FileFinder` and + :class:`zipimport.zipimporter`. + + .. versionchanged:: 3.3 + Updated to be based directly on :mod:`importlib` rather than relying + on the package internal PEP 302 import emulation. + + +.. function:: get_data(package, resource) + + Get a resource from a package. + + This is a wrapper for the :term:`loader` + :meth:`get_data ` API. The + *package* argument should be the name of a package, in standard module format + (``foo.bar``). The *resource* argument should be in the form of a relative + filename, using ``/`` as the path separator. The parent directory name + ``..`` is not allowed, and nor is a rooted name (starting with a ``/``). + + The function returns a binary string that is the contents of the specified + resource. + + For packages located in the filesystem, which have already been imported, + this is the rough equivalent of:: + + d = os.path.dirname(sys.modules[package].__file__) + data = open(os.path.join(d, resource), 'rb').read() + + If the package cannot be located or loaded, or it uses a :term:`loader` + which does not support :meth:`get_data `, + then ``None`` is returned. In particular, the :term:`loader` for + :term:`namespace packages ` does not support + :meth:`get_data `. diff --git a/python-3.7.4-docs-html/_sources/library/platform.rst.txt b/python-3.7.4-docs-html/_sources/library/platform.rst.txt new file mode 100644 index 0000000..7d29dc1 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/platform.rst.txt @@ -0,0 +1,284 @@ +:mod:`platform` --- Access to underlying platform's identifying data +===================================================================== + +.. module:: platform + :synopsis: Retrieves as much platform identifying data as possible. + +.. moduleauthor:: Marc-André Lemburg +.. sectionauthor:: Bjorn Pettersen + +**Source code:** :source:`Lib/platform.py` + +-------------- + +.. note:: + + Specific platforms listed alphabetically, with Linux included in the Unix + section. + + +Cross Platform +-------------- + + +.. function:: architecture(executable=sys.executable, bits='', linkage='') + + Queries the given executable (defaults to the Python interpreter binary) for + various architecture information. + + Returns a tuple ``(bits, linkage)`` which contain information about the bit + architecture and the linkage format used for the executable. Both values are + returned as strings. + + Values that cannot be determined are returned as given by the parameter presets. + If bits is given as ``''``, the ``sizeof(pointer)`` (or + ``sizeof(long)`` on Python version < 1.5.2) is used as indicator for the + supported pointer size. + + The function relies on the system's :file:`file` command to do the actual work. + This is available on most if not all Unix platforms and some non-Unix platforms + and then only if the executable points to the Python interpreter. Reasonable + defaults are used when the above needs are not met. + + .. note:: + + On Mac OS X (and perhaps other platforms), executable files may be + universal files containing multiple architectures. + + To get at the "64-bitness" of the current interpreter, it is more + reliable to query the :attr:`sys.maxsize` attribute:: + + is_64bits = sys.maxsize > 2**32 + + +.. function:: machine() + + Returns the machine type, e.g. ``'i386'``. An empty string is returned if the + value cannot be determined. + + +.. function:: node() + + Returns the computer's network name (may not be fully qualified!). An empty + string is returned if the value cannot be determined. + + +.. function:: platform(aliased=0, terse=0) + + Returns a single string identifying the underlying platform with as much useful + information as possible. + + The output is intended to be *human readable* rather than machine parseable. It + may look different on different platforms and this is intended. + + If *aliased* is true, the function will use aliases for various platforms that + report system names which differ from their common names, for example SunOS will + be reported as Solaris. The :func:`system_alias` function is used to implement + this. + + Setting *terse* to true causes the function to return only the absolute minimum + information needed to identify the platform. + + +.. function:: processor() + + Returns the (real) processor name, e.g. ``'amdk6'``. + + An empty string is returned if the value cannot be determined. Note that many + platforms do not provide this information or simply return the same value as for + :func:`machine`. NetBSD does this. + + +.. function:: python_build() + + Returns a tuple ``(buildno, builddate)`` stating the Python build number and + date as strings. + + +.. function:: python_compiler() + + Returns a string identifying the compiler used for compiling Python. + + +.. function:: python_branch() + + Returns a string identifying the Python implementation SCM branch. + + +.. function:: python_implementation() + + Returns a string identifying the Python implementation. Possible return values + are: 'CPython', 'IronPython', 'Jython', 'PyPy'. + + +.. function:: python_revision() + + Returns a string identifying the Python implementation SCM revision. + + +.. function:: python_version() + + Returns the Python version as string ``'major.minor.patchlevel'``. + + Note that unlike the Python ``sys.version``, the returned value will always + include the patchlevel (it defaults to 0). + + +.. function:: python_version_tuple() + + Returns the Python version as tuple ``(major, minor, patchlevel)`` of strings. + + Note that unlike the Python ``sys.version``, the returned value will always + include the patchlevel (it defaults to ``'0'``). + + +.. function:: release() + + Returns the system's release, e.g. ``'2.2.0'`` or ``'NT'`` An empty string is + returned if the value cannot be determined. + + +.. function:: system() + + Returns the system/OS name, e.g. ``'Linux'``, ``'Windows'``, or ``'Java'``. An + empty string is returned if the value cannot be determined. + + +.. function:: system_alias(system, release, version) + + Returns ``(system, release, version)`` aliased to common marketing names used + for some systems. It also does some reordering of the information in some cases + where it would otherwise cause confusion. + + +.. function:: version() + + Returns the system's release version, e.g. ``'#3 on degas'``. An empty string is + returned if the value cannot be determined. + + +.. function:: uname() + + Fairly portable uname interface. Returns a :func:`~collections.namedtuple` + containing six attributes: :attr:`system`, :attr:`node`, :attr:`release`, + :attr:`version`, :attr:`machine`, and :attr:`processor`. + + Note that this adds a sixth attribute (:attr:`processor`) not present + in the :func:`os.uname` result. Also, the attribute names are different + for the first two attributes; :func:`os.uname` names them + :attr:`sysname` and :attr:`nodename`. + + Entries which cannot be determined are set to ``''``. + + .. versionchanged:: 3.3 + Result changed from a tuple to a namedtuple. + + +Java Platform +------------- + + +.. function:: java_ver(release='', vendor='', vminfo=('','',''), osinfo=('','','')) + + Version interface for Jython. + + Returns a tuple ``(release, vendor, vminfo, osinfo)`` with *vminfo* being a + tuple ``(vm_name, vm_release, vm_vendor)`` and *osinfo* being a tuple + ``(os_name, os_version, os_arch)``. Values which cannot be determined are set to + the defaults given as parameters (which all default to ``''``). + + +Windows Platform +---------------- + + +.. function:: win32_ver(release='', version='', csd='', ptype='') + + Get additional version information from the Windows Registry and return a tuple + ``(release, version, csd, ptype)`` referring to OS release, version number, + CSD level (service pack) and OS type (multi/single processor). + + As a hint: *ptype* is ``'Uniprocessor Free'`` on single processor NT machines + and ``'Multiprocessor Free'`` on multi processor machines. The *'Free'* refers + to the OS version being free of debugging code. It could also state *'Checked'* + which means the OS version uses debugging code, i.e. code that checks arguments, + ranges, etc. + + .. note:: + + This function works best with Mark Hammond's + :mod:`win32all` package installed, but also on Python 2.3 and + later (support for this was added in Python 2.6). It obviously + only runs on Win32 compatible platforms. + + +Win95/98 specific +^^^^^^^^^^^^^^^^^ + +.. function:: popen(cmd, mode='r', bufsize=-1) + + Portable :func:`popen` interface. Find a working popen implementation + preferring :func:`win32pipe.popen`. On Windows NT, :func:`win32pipe.popen` + should work; on Windows 9x it hangs due to bugs in the MS C library. + + .. deprecated:: 3.3 + This function is obsolete. Use the :mod:`subprocess` module. Check + especially the :ref:`subprocess-replacements` section. + + +Mac OS Platform +--------------- + + +.. function:: mac_ver(release='', versioninfo=('','',''), machine='') + + Get Mac OS version information and return it as tuple ``(release, versioninfo, + machine)`` with *versioninfo* being a tuple ``(version, dev_stage, + non_release_version)``. + + Entries which cannot be determined are set to ``''``. All tuple entries are + strings. + + +Unix Platforms +-------------- + + +.. function:: dist(distname='', version='', id='', supported_dists=('SuSE','debian','redhat','mandrake',...)) + + This is another name for :func:`linux_distribution`. + + .. deprecated-removed:: 3.5 3.8 + See alternative like the `distro `_ package. + +.. function:: linux_distribution(distname='', version='', id='', supported_dists=('SuSE','debian','redhat','mandrake',...), full_distribution_name=1) + + Tries to determine the name of the Linux OS distribution name. + + ``supported_dists`` may be given to define the set of Linux distributions to + look for. It defaults to a list of currently supported Linux distributions + identified by their release file name. + + If ``full_distribution_name`` is true (default), the full distribution read + from the OS is returned. Otherwise the short name taken from + ``supported_dists`` is used. + + Returns a tuple ``(distname,version,id)`` which defaults to the args given as + parameters. ``id`` is the item in parentheses after the version number. It + is usually the version codename. + + .. deprecated-removed:: 3.5 3.8 + See alternative like the `distro `_ package. + +.. function:: libc_ver(executable=sys.executable, lib='', version='', chunksize=16384) + + Tries to determine the libc version against which the file executable (defaults + to the Python interpreter) is linked. Returns a tuple of strings ``(lib, + version)`` which default to the given parameters in case the lookup fails. + + Note that this function has intimate knowledge of how different libc versions + add symbols to the executable is probably only usable for executables compiled + using :program:`gcc`. + + The file is read and scanned in chunks of *chunksize* bytes. + diff --git a/python-3.7.4-docs-html/_sources/library/plistlib.rst.txt b/python-3.7.4-docs-html/_sources/library/plistlib.rst.txt new file mode 100644 index 0000000..8bd6b63 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/plistlib.rst.txt @@ -0,0 +1,226 @@ +:mod:`plistlib` --- Generate and parse Mac OS X ``.plist`` files +================================================================ + +.. module:: plistlib + :synopsis: Generate and parse Mac OS X plist files. + +.. moduleauthor:: Jack Jansen +.. sectionauthor:: Georg Brandl +.. (harvested from docstrings in the original file) + +**Source code:** :source:`Lib/plistlib.py` + +.. index:: + pair: plist; file + single: property list + +-------------- + +This module provides an interface for reading and writing the "property list" +files used mainly by Mac OS X and supports both binary and XML plist files. + +The property list (``.plist``) file format is a simple serialization supporting +basic object types, like dictionaries, lists, numbers and strings. Usually the +top level object is a dictionary. + +To write out and to parse a plist file, use the :func:`dump` and +:func:`load` functions. + +To work with plist data in bytes objects, use :func:`dumps` +and :func:`loads`. + +Values can be strings, integers, floats, booleans, tuples, lists, dictionaries +(but only with string keys), :class:`Data`, :class:`bytes`, :class:`bytesarray` +or :class:`datetime.datetime` objects. + +.. versionchanged:: 3.4 + New API, old API deprecated. Support for binary format plists added. + +.. seealso:: + + `PList manual page `_ + Apple's documentation of the file format. + + +This module defines the following functions: + +.. function:: load(fp, \*, fmt=None, use_builtin_types=True, dict_type=dict) + + Read a plist file. *fp* should be a readable and binary file object. + Return the unpacked root object (which usually is a + dictionary). + + The *fmt* is the format of the file and the following values are valid: + + * :data:`None`: Autodetect the file format + + * :data:`FMT_XML`: XML file format + + * :data:`FMT_BINARY`: Binary plist format + + If *use_builtin_types* is true (the default) binary data will be returned + as instances of :class:`bytes`, otherwise it is returned as instances of + :class:`Data`. + + The *dict_type* is the type used for dictionaries that are read from the + plist file. + + XML data for the :data:`FMT_XML` format is parsed using the Expat parser + from :mod:`xml.parsers.expat` -- see its documentation for possible + exceptions on ill-formed XML. Unknown elements will simply be ignored + by the plist parser. + + The parser for the binary format raises :exc:`InvalidFileException` + when the file cannot be parsed. + + .. versionadded:: 3.4 + + +.. function:: loads(data, \*, fmt=None, use_builtin_types=True, dict_type=dict) + + Load a plist from a bytes object. See :func:`load` for an explanation of + the keyword arguments. + + .. versionadded:: 3.4 + + +.. function:: dump(value, fp, \*, fmt=FMT_XML, sort_keys=True, skipkeys=False) + + Write *value* to a plist file. *Fp* should be a writable, binary + file object. + + The *fmt* argument specifies the format of the plist file and can be + one of the following values: + + * :data:`FMT_XML`: XML formatted plist file + + * :data:`FMT_BINARY`: Binary formatted plist file + + When *sort_keys* is true (the default) the keys for dictionaries will be + written to the plist in sorted order, otherwise they will be written in + the iteration order of the dictionary. + + When *skipkeys* is false (the default) the function raises :exc:`TypeError` + when a key of a dictionary is not a string, otherwise such keys are skipped. + + A :exc:`TypeError` will be raised if the object is of an unsupported type or + a container that contains objects of unsupported types. + + An :exc:`OverflowError` will be raised for integer values that cannot + be represented in (binary) plist files. + + .. versionadded:: 3.4 + + +.. function:: dumps(value, \*, fmt=FMT_XML, sort_keys=True, skipkeys=False) + + Return *value* as a plist-formatted bytes object. See + the documentation for :func:`dump` for an explanation of the keyword + arguments of this function. + + .. versionadded:: 3.4 + +The following functions are deprecated: + +.. function:: readPlist(pathOrFile) + + Read a plist file. *pathOrFile* may be either a file name or a (readable + and binary) file object. Returns the unpacked root object (which usually + is a dictionary). + + This function calls :func:`load` to do the actual work, see the documentation + of :func:`that function ` for an explanation of the keyword arguments. + + .. deprecated:: 3.4 Use :func:`load` instead. + + .. versionchanged:: 3.7 + Dict values in the result are now normal dicts. You no longer can use + attribute access to access items of these dictionaries. + + +.. function:: writePlist(rootObject, pathOrFile) + + Write *rootObject* to an XML plist file. *pathOrFile* may be either a file name + or a (writable and binary) file object + + .. deprecated:: 3.4 Use :func:`dump` instead. + + +.. function:: readPlistFromBytes(data) + + Read a plist data from a bytes object. Return the root object. + + See :func:`load` for a description of the keyword arguments. + + .. deprecated:: 3.4 Use :func:`loads` instead. + + .. versionchanged:: 3.7 + Dict values in the result are now normal dicts. You no longer can use + attribute access to access items of these dictionaries. + + +.. function:: writePlistToBytes(rootObject) + + Return *rootObject* as an XML plist-formatted bytes object. + + .. deprecated:: 3.4 Use :func:`dumps` instead. + + +The following classes are available: + +.. class:: Data(data) + + Return a "data" wrapper object around the bytes object *data*. This is used + in functions converting from/to plists to represent the ```` type + available in plists. + + It has one attribute, :attr:`data`, that can be used to retrieve the Python + bytes object stored in it. + + .. deprecated:: 3.4 Use a :class:`bytes` object instead. + + +The following constants are available: + +.. data:: FMT_XML + + The XML format for plist files. + + .. versionadded:: 3.4 + + +.. data:: FMT_BINARY + + The binary format for plist files + + .. versionadded:: 3.4 + + +Examples +-------- + +Generating a plist:: + + pl = dict( + aString = "Doodah", + aList = ["A", "B", 12, 32.1, [1, 2, 3]], + aFloat = 0.1, + anInt = 728, + aDict = dict( + anotherString = "", + aThirdString = "M\xe4ssig, Ma\xdf", + aTrueValue = True, + aFalseValue = False, + ), + someData = b"", + someMoreData = b"" * 10, + aDate = datetime.datetime.fromtimestamp(time.mktime(time.gmtime())), + ) + with open(fileName, 'wb') as fp: + dump(pl, fp) + +Parsing a plist:: + + with open(fileName, 'rb') as fp: + pl = load(fp) + print(pl["aKey"]) diff --git a/python-3.7.4-docs-html/_sources/library/poplib.rst.txt b/python-3.7.4-docs-html/_sources/library/poplib.rst.txt new file mode 100644 index 0000000..d72b660 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/poplib.rst.txt @@ -0,0 +1,255 @@ +:mod:`poplib` --- POP3 protocol client +====================================== + +.. module:: poplib + :synopsis: POP3 protocol client (requires sockets). + +.. sectionauthor:: Andrew T. Csillag +.. revised by ESR, January 2000 + +**Source code:** :source:`Lib/poplib.py` + +.. index:: pair: POP3; protocol + +-------------- + +This module defines a class, :class:`POP3`, which encapsulates a connection to a +POP3 server and implements the protocol as defined in :rfc:`1939`. The +:class:`POP3` class supports both the minimal and optional command sets from +:rfc:`1939`. The :class:`POP3` class also supports the ``STLS`` command introduced +in :rfc:`2595` to enable encrypted communication on an already established connection. + +Additionally, this module provides a class :class:`POP3_SSL`, which provides +support for connecting to POP3 servers that use SSL as an underlying protocol +layer. + +Note that POP3, though widely supported, is obsolescent. The implementation +quality of POP3 servers varies widely, and too many are quite poor. If your +mailserver supports IMAP, you would be better off using the +:class:`imaplib.IMAP4` class, as IMAP servers tend to be better implemented. + +The :mod:`poplib` module provides two classes: + + +.. class:: POP3(host, port=POP3_PORT[, timeout]) + + This class implements the actual POP3 protocol. The connection is created when + the instance is initialized. If *port* is omitted, the standard POP3 port (110) + is used. The optional *timeout* parameter specifies a timeout in seconds for the + connection attempt (if not specified, the global default timeout setting will + be used). + + +.. class:: POP3_SSL(host, port=POP3_SSL_PORT, keyfile=None, certfile=None, timeout=None, context=None) + + This is a subclass of :class:`POP3` that connects to the server over an SSL + encrypted socket. If *port* is not specified, 995, the standard POP3-over-SSL + port is used. *timeout* works as in the :class:`POP3` constructor. + *context* is an optional :class:`ssl.SSLContext` object which allows + bundling SSL configuration options, certificates and private keys into a + single (potentially long-lived) structure. Please read :ref:`ssl-security` + for best practices. + + *keyfile* and *certfile* are a legacy alternative to *context* - they can + point to PEM-formatted private key and certificate chain files, + respectively, for the SSL connection. + + .. versionchanged:: 3.2 + *context* parameter added. + + .. versionchanged:: 3.4 + The class now supports hostname check with + :attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see + :data:`ssl.HAS_SNI`). + + .. deprecated:: 3.6 + + *keyfile* and *certfile* are deprecated in favor of *context*. + Please use :meth:`ssl.SSLContext.load_cert_chain` instead, or let + :func:`ssl.create_default_context` select the system's trusted CA + certificates for you. + +One exception is defined as an attribute of the :mod:`poplib` module: + + +.. exception:: error_proto + + Exception raised on any errors from this module (errors from :mod:`socket` + module are not caught). The reason for the exception is passed to the + constructor as a string. + + +.. seealso:: + + Module :mod:`imaplib` + The standard Python IMAP module. + + `Frequently Asked Questions About Fetchmail `_ + The FAQ for the :program:`fetchmail` POP/IMAP client collects information on + POP3 server variations and RFC noncompliance that may be useful if you need to + write an application based on the POP protocol. + + +.. _pop3-objects: + +POP3 Objects +------------ + +All POP3 commands are represented by methods of the same name, in lower-case; +most return the response text sent by the server. + +An :class:`POP3` instance has the following methods: + + +.. method:: POP3.set_debuglevel(level) + + Set the instance's debugging level. This controls the amount of debugging + output printed. The default, ``0``, produces no debugging output. A value of + ``1`` produces a moderate amount of debugging output, generally a single line + per request. A value of ``2`` or higher produces the maximum amount of + debugging output, logging each line sent and received on the control connection. + + +.. method:: POP3.getwelcome() + + Returns the greeting string sent by the POP3 server. + + +.. method:: POP3.capa() + + Query the server's capabilities as specified in :rfc:`2449`. + Returns a dictionary in the form ``{'name': ['param'...]}``. + + .. versionadded:: 3.4 + + +.. method:: POP3.user(username) + + Send user command, response should indicate that a password is required. + + +.. method:: POP3.pass_(password) + + Send password, response includes message count and mailbox size. Note: the + mailbox on the server is locked until :meth:`~poplib.quit` is called. + + +.. method:: POP3.apop(user, secret) + + Use the more secure APOP authentication to log into the POP3 server. + + +.. method:: POP3.rpop(user) + + Use RPOP authentication (similar to UNIX r-commands) to log into POP3 server. + + +.. method:: POP3.stat() + + Get mailbox status. The result is a tuple of 2 integers: ``(message count, + mailbox size)``. + + +.. method:: POP3.list([which]) + + Request message list, result is in the form ``(response, ['mesg_num octets', + ...], octets)``. If *which* is set, it is the message to list. + + +.. method:: POP3.retr(which) + + Retrieve whole message number *which*, and set its seen flag. Result is in form + ``(response, ['line', ...], octets)``. + + +.. method:: POP3.dele(which) + + Flag message number *which* for deletion. On most servers deletions are not + actually performed until QUIT (the major exception is Eudora QPOP, which + deliberately violates the RFCs by doing pending deletes on any disconnect). + + +.. method:: POP3.rset() + + Remove any deletion marks for the mailbox. + + +.. method:: POP3.noop() + + Do nothing. Might be used as a keep-alive. + + +.. method:: POP3.quit() + + Signoff: commit changes, unlock mailbox, drop connection. + + +.. method:: POP3.top(which, howmuch) + + Retrieves the message header plus *howmuch* lines of the message after the + header of message number *which*. Result is in form ``(response, ['line', ...], + octets)``. + + The POP3 TOP command this method uses, unlike the RETR command, doesn't set the + message's seen flag; unfortunately, TOP is poorly specified in the RFCs and is + frequently broken in off-brand servers. Test this method by hand against the + POP3 servers you will use before trusting it. + + +.. method:: POP3.uidl(which=None) + + Return message digest (unique id) list. If *which* is specified, result contains + the unique id for that message in the form ``'response mesgnum uid``, otherwise + result is list ``(response, ['mesgnum uid', ...], octets)``. + + +.. method:: POP3.utf8() + + Try to switch to UTF-8 mode. Returns the server response if successful, + raises :class:`error_proto` if not. Specified in :RFC:`6856`. + + .. versionadded:: 3.5 + + +.. method:: POP3.stls(context=None) + + Start a TLS session on the active connection as specified in :rfc:`2595`. + This is only allowed before user authentication + + *context* parameter is a :class:`ssl.SSLContext` object which allows + bundling SSL configuration options, certificates and private keys into + a single (potentially long-lived) structure. Please read :ref:`ssl-security` + for best practices. + + This method supports hostname checking via + :attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see + :data:`ssl.HAS_SNI`). + + .. versionadded:: 3.4 + + +Instances of :class:`POP3_SSL` have no additional methods. The interface of this +subclass is identical to its parent. + + +.. _pop3-example: + +POP3 Example +------------ + +Here is a minimal example (without error checking) that opens a mailbox and +retrieves and prints all messages:: + + import getpass, poplib + + M = poplib.POP3('localhost') + M.user(getpass.getuser()) + M.pass_(getpass.getpass()) + numMessages = len(M.list()[1]) + for i in range(numMessages): + for j in M.retr(i+1)[1]: + print(j) + +At the end of the module, there is a test section that contains a more extensive +example of usage. + diff --git a/python-3.7.4-docs-html/_sources/library/posix.rst.txt b/python-3.7.4-docs-html/_sources/library/posix.rst.txt new file mode 100644 index 0000000..9cbc550 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/posix.rst.txt @@ -0,0 +1,92 @@ +:mod:`posix` --- The most common POSIX system calls +=================================================== + +.. module:: posix + :platform: Unix + :synopsis: The most common POSIX system calls (normally used via module os). + +-------------- + +This module provides access to operating system functionality that is +standardized by the C Standard and the POSIX standard (a thinly disguised Unix +interface). + +.. index:: module: os + +**Do not import this module directly.** Instead, import the module :mod:`os`, +which provides a *portable* version of this interface. On Unix, the :mod:`os` +module provides a superset of the :mod:`posix` interface. On non-Unix operating +systems the :mod:`posix` module is not available, but a subset is always +available through the :mod:`os` interface. Once :mod:`os` is imported, there is +*no* performance penalty in using it instead of :mod:`posix`. In addition, +:mod:`os` provides some additional functionality, such as automatically calling +:func:`~os.putenv` when an entry in ``os.environ`` is changed. + +Errors are reported as exceptions; the usual exceptions are given for type +errors, while errors reported by the system calls raise :exc:`OSError`. + + +.. _posix-large-files: + +Large File Support +------------------ + +.. index:: + single: large files + single: file; large files + +.. sectionauthor:: Steve Clift + +Several operating systems (including AIX, HP-UX, Irix and Solaris) provide +support for files that are larger than 2 GiB from a C programming model where +:c:type:`int` and :c:type:`long` are 32-bit values. This is typically accomplished +by defining the relevant size and offset types as 64-bit values. Such files are +sometimes referred to as :dfn:`large files`. + +Large file support is enabled in Python when the size of an :c:type:`off_t` is +larger than a :c:type:`long` and the :c:type:`long long` type is available and is +at least as large as an :c:type:`off_t`. +It may be necessary to configure and compile Python with certain compiler flags +to enable this mode. For example, it is enabled by default with recent versions +of Irix, but with Solaris 2.6 and 2.7 you need to do something like:: + + CFLAGS="`getconf LFS_CFLAGS`" OPT="-g -O2 $CFLAGS" \ + ./configure + +On large-file-capable Linux systems, this might work:: + + CFLAGS='-D_LARGEFILE64_SOURCE -D_FILE_OFFSET_BITS=64' OPT="-g -O2 $CFLAGS" \ + ./configure + + +.. _posix-contents: + +Notable Module Contents +----------------------- + +In addition to many functions described in the :mod:`os` module documentation, +:mod:`posix` defines the following data item: + +.. data:: environ + + A dictionary representing the string environment at the time the interpreter + was started. Keys and values are bytes on Unix and str on Windows. For + example, ``environ[b'HOME']`` (``environ['HOME']`` on Windows) is the + pathname of your home directory, equivalent to ``getenv("HOME")`` in C. + + Modifying this dictionary does not affect the string environment passed on by + :func:`~os.execv`, :func:`~os.popen` or :func:`~os.system`; if you need to + change the environment, pass ``environ`` to :func:`~os.execve` or add + variable assignments and export statements to the command string for + :func:`~os.system` or :func:`~os.popen`. + + .. versionchanged:: 3.2 + On Unix, keys and values are bytes. + + .. note:: + + The :mod:`os` module provides an alternate implementation of ``environ`` + which updates the environment on modification. Note also that updating + :data:`os.environ` will render this dictionary obsolete. Use of the + :mod:`os` module version of this is recommended over direct access to the + :mod:`posix` module. diff --git a/python-3.7.4-docs-html/_sources/library/pprint.rst.txt b/python-3.7.4-docs-html/_sources/library/pprint.rst.txt new file mode 100644 index 0000000..deadf18 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/pprint.rst.txt @@ -0,0 +1,374 @@ +:mod:`pprint` --- Data pretty printer +===================================== + +.. module:: pprint + :synopsis: Data pretty printer. + +.. moduleauthor:: Fred L. Drake, Jr. +.. sectionauthor:: Fred L. Drake, Jr. + +**Source code:** :source:`Lib/pprint.py` + +-------------- + +The :mod:`pprint` module provides a capability to "pretty-print" arbitrary +Python data structures in a form which can be used as input to the interpreter. +If the formatted structures include objects which are not fundamental Python +types, the representation may not be loadable. This may be the case if objects +such as files, sockets or classes are included, as well as many other +objects which are not representable as Python literals. + +The formatted representation keeps objects on a single line if it can, and +breaks them onto multiple lines if they don't fit within the allowed width. +Construct :class:`PrettyPrinter` objects explicitly if you need to adjust the +width constraint. + +Dictionaries are sorted by key before the display is computed. + +The :mod:`pprint` module defines one class: + +.. First the implementation class: + + +.. index:: single: ...; placeholder + +.. class:: PrettyPrinter(indent=1, width=80, depth=None, stream=None, *, \ + compact=False) + + Construct a :class:`PrettyPrinter` instance. This constructor understands + several keyword parameters. An output stream may be set using the *stream* + keyword; the only method used on the stream object is the file protocol's + :meth:`write` method. If not specified, the :class:`PrettyPrinter` adopts + ``sys.stdout``. The + amount of indentation added for each recursive level is specified by *indent*; + the default is one. Other values can cause output to look a little odd, but can + make nesting easier to spot. The number of levels which may be printed is + controlled by *depth*; if the data structure being printed is too deep, the next + contained level is replaced by ``...``. By default, there is no constraint on + the depth of the objects being formatted. The desired output width is + constrained using the *width* parameter; the default is 80 characters. If a + structure cannot be formatted within the constrained width, a best effort will + be made. If *compact* is false (the default) each item of a long sequence + will be formatted on a separate line. If *compact* is true, as many items + as will fit within the *width* will be formatted on each output line. + + .. versionchanged:: 3.4 + Added the *compact* parameter. + + >>> import pprint + >>> stuff = ['spam', 'eggs', 'lumberjack', 'knights', 'ni'] + >>> stuff.insert(0, stuff[:]) + >>> pp = pprint.PrettyPrinter(indent=4) + >>> pp.pprint(stuff) + [ ['spam', 'eggs', 'lumberjack', 'knights', 'ni'], + 'spam', + 'eggs', + 'lumberjack', + 'knights', + 'ni'] + >>> pp = pprint.PrettyPrinter(width=41, compact=True) + >>> pp.pprint(stuff) + [['spam', 'eggs', 'lumberjack', + 'knights', 'ni'], + 'spam', 'eggs', 'lumberjack', 'knights', + 'ni'] + >>> tup = ('spam', ('eggs', ('lumberjack', ('knights', ('ni', ('dead', + ... ('parrot', ('fresh fruit',)))))))) + >>> pp = pprint.PrettyPrinter(depth=6) + >>> pp.pprint(tup) + ('spam', ('eggs', ('lumberjack', ('knights', ('ni', ('dead', (...))))))) + + +The :mod:`pprint` module also provides several shortcut functions: + +.. function:: pformat(object, indent=1, width=80, depth=None, *, compact=False) + + Return the formatted representation of *object* as a string. *indent*, + *width*, *depth* and *compact* will be passed to the :class:`PrettyPrinter` + constructor as formatting parameters. + + .. versionchanged:: 3.4 + Added the *compact* parameter. + + +.. function:: pprint(object, stream=None, indent=1, width=80, depth=None, *, \ + compact=False) + + Prints the formatted representation of *object* on *stream*, followed by a + newline. If *stream* is ``None``, ``sys.stdout`` is used. This may be used + in the interactive interpreter instead of the :func:`print` function for + inspecting values (you can even reassign ``print = pprint.pprint`` for use + within a scope). *indent*, *width*, *depth* and *compact* will be passed + to the :class:`PrettyPrinter` constructor as formatting parameters. + + .. versionchanged:: 3.4 + Added the *compact* parameter. + + >>> import pprint + >>> stuff = ['spam', 'eggs', 'lumberjack', 'knights', 'ni'] + >>> stuff.insert(0, stuff) + >>> pprint.pprint(stuff) + [, + 'spam', + 'eggs', + 'lumberjack', + 'knights', + 'ni'] + + +.. function:: isreadable(object) + + .. index:: builtin: eval + + Determine if the formatted representation of *object* is "readable," or can be + used to reconstruct the value using :func:`eval`. This always returns ``False`` + for recursive objects. + + >>> pprint.isreadable(stuff) + False + + +.. function:: isrecursive(object) + + Determine if *object* requires a recursive representation. + + +One more support function is also defined: + +.. function:: saferepr(object) + + Return a string representation of *object*, protected against recursive data + structures. If the representation of *object* exposes a recursive entry, the + recursive reference will be represented as ````. The representation is not otherwise formatted. + + >>> pprint.saferepr(stuff) + "[, 'spam', 'eggs', 'lumberjack', 'knights', 'ni']" + + +.. _prettyprinter-objects: + +PrettyPrinter Objects +--------------------- + +:class:`PrettyPrinter` instances have the following methods: + + +.. method:: PrettyPrinter.pformat(object) + + Return the formatted representation of *object*. This takes into account the + options passed to the :class:`PrettyPrinter` constructor. + + +.. method:: PrettyPrinter.pprint(object) + + Print the formatted representation of *object* on the configured stream, + followed by a newline. + +The following methods provide the implementations for the corresponding +functions of the same names. Using these methods on an instance is slightly +more efficient since new :class:`PrettyPrinter` objects don't need to be +created. + + +.. method:: PrettyPrinter.isreadable(object) + + .. index:: builtin: eval + + Determine if the formatted representation of the object is "readable," or can be + used to reconstruct the value using :func:`eval`. Note that this returns + ``False`` for recursive objects. If the *depth* parameter of the + :class:`PrettyPrinter` is set and the object is deeper than allowed, this + returns ``False``. + + +.. method:: PrettyPrinter.isrecursive(object) + + Determine if the object requires a recursive representation. + +This method is provided as a hook to allow subclasses to modify the way objects +are converted to strings. The default implementation uses the internals of the +:func:`saferepr` implementation. + + +.. method:: PrettyPrinter.format(object, context, maxlevels, level) + + Returns three values: the formatted version of *object* as a string, a flag + indicating whether the result is readable, and a flag indicating whether + recursion was detected. The first argument is the object to be presented. The + second is a dictionary which contains the :func:`id` of objects that are part of + the current presentation context (direct and indirect containers for *object* + that are affecting the presentation) as the keys; if an object needs to be + presented which is already represented in *context*, the third return value + should be ``True``. Recursive calls to the :meth:`.format` method should add + additional entries for containers to this dictionary. The third argument, + *maxlevels*, gives the requested limit to recursion; this will be ``0`` if there + is no requested limit. This argument should be passed unmodified to recursive + calls. The fourth argument, *level*, gives the current level; recursive calls + should be passed a value less than that of the current call. + + +.. _pprint-example: + +Example +------- + +To demonstrate several uses of the :func:`pprint` function and its parameters, +let's fetch information about a project from `PyPI `_:: + + >>> import json + >>> import pprint + >>> from urllib.request import urlopen + >>> with urlopen('https://pypi.org/pypi/sampleproject/json') as resp: + ... project_info = json.load(resp)['info'] + +In its basic form, :func:`pprint` shows the whole object:: + + >>> pprint.pprint(project_info) + {'author': 'The Python Packaging Authority', + 'author_email': 'pypa-dev@googlegroups.com', + 'bugtrack_url': None, + 'classifiers': ['Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: MIT License', + 'Programming Language :: Python :: 2', + 'Programming Language :: Python :: 2.6', + 'Programming Language :: Python :: 2.7', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.2', + 'Programming Language :: Python :: 3.3', + 'Programming Language :: Python :: 3.4', + 'Topic :: Software Development :: Build Tools'], + 'description': 'A sample Python project\n' + '=======================\n' + '\n' + 'This is the description file for the project.\n' + '\n' + 'The file should use UTF-8 encoding and be written using ' + 'ReStructured Text. It\n' + 'will be used to generate the project webpage on PyPI, and ' + 'should be written for\n' + 'that purpose.\n' + '\n' + 'Typical contents for this file would include an overview of ' + 'the project, basic\n' + 'usage examples, etc. Generally, including the project ' + 'changelog in here is not\n' + 'a good idea, although a simple "What\'s New" section for the ' + 'most recent version\n' + 'may be appropriate.', + 'description_content_type': None, + 'docs_url': None, + 'download_url': 'UNKNOWN', + 'downloads': {'last_day': -1, 'last_month': -1, 'last_week': -1}, + 'home_page': 'https://github.com/pypa/sampleproject', + 'keywords': 'sample setuptools development', + 'license': 'MIT', + 'maintainer': None, + 'maintainer_email': None, + 'name': 'sampleproject', + 'package_url': 'https://pypi.org/project/sampleproject/', + 'platform': 'UNKNOWN', + 'project_url': 'https://pypi.org/project/sampleproject/', + 'project_urls': {'Download': 'UNKNOWN', + 'Homepage': 'https://github.com/pypa/sampleproject'}, + 'release_url': 'https://pypi.org/project/sampleproject/1.2.0/', + 'requires_dist': None, + 'requires_python': None, + 'summary': 'A sample Python project', + 'version': '1.2.0'} + +The result can be limited to a certain *depth* (ellipsis is used for deeper +contents):: + + >>> pprint.pprint(project_info, depth=1) + {'author': 'The Python Packaging Authority', + 'author_email': 'pypa-dev@googlegroups.com', + 'bugtrack_url': None, + 'classifiers': [...], + 'description': 'A sample Python project\n' + '=======================\n' + '\n' + 'This is the description file for the project.\n' + '\n' + 'The file should use UTF-8 encoding and be written using ' + 'ReStructured Text. It\n' + 'will be used to generate the project webpage on PyPI, and ' + 'should be written for\n' + 'that purpose.\n' + '\n' + 'Typical contents for this file would include an overview of ' + 'the project, basic\n' + 'usage examples, etc. Generally, including the project ' + 'changelog in here is not\n' + 'a good idea, although a simple "What\'s New" section for the ' + 'most recent version\n' + 'may be appropriate.', + 'description_content_type': None, + 'docs_url': None, + 'download_url': 'UNKNOWN', + 'downloads': {...}, + 'home_page': 'https://github.com/pypa/sampleproject', + 'keywords': 'sample setuptools development', + 'license': 'MIT', + 'maintainer': None, + 'maintainer_email': None, + 'name': 'sampleproject', + 'package_url': 'https://pypi.org/project/sampleproject/', + 'platform': 'UNKNOWN', + 'project_url': 'https://pypi.org/project/sampleproject/', + 'project_urls': {...}, + 'release_url': 'https://pypi.org/project/sampleproject/1.2.0/', + 'requires_dist': None, + 'requires_python': None, + 'summary': 'A sample Python project', + 'version': '1.2.0'} + +Additionally, maximum character *width* can be suggested. If a long object +cannot be split, the specified width will be exceeded:: + + >>> pprint.pprint(project_info, depth=1, width=60) + {'author': 'The Python Packaging Authority', + 'author_email': 'pypa-dev@googlegroups.com', + 'bugtrack_url': None, + 'classifiers': [...], + 'description': 'A sample Python project\n' + '=======================\n' + '\n' + 'This is the description file for the ' + 'project.\n' + '\n' + 'The file should use UTF-8 encoding and be ' + 'written using ReStructured Text. It\n' + 'will be used to generate the project ' + 'webpage on PyPI, and should be written ' + 'for\n' + 'that purpose.\n' + '\n' + 'Typical contents for this file would ' + 'include an overview of the project, ' + 'basic\n' + 'usage examples, etc. Generally, including ' + 'the project changelog in here is not\n' + 'a good idea, although a simple "What\'s ' + 'New" section for the most recent version\n' + 'may be appropriate.', + 'description_content_type': None, + 'docs_url': None, + 'download_url': 'UNKNOWN', + 'downloads': {...}, + 'home_page': 'https://github.com/pypa/sampleproject', + 'keywords': 'sample setuptools development', + 'license': 'MIT', + 'maintainer': None, + 'maintainer_email': None, + 'name': 'sampleproject', + 'package_url': 'https://pypi.org/project/sampleproject/', + 'platform': 'UNKNOWN', + 'project_url': 'https://pypi.org/project/sampleproject/', + 'project_urls': {...}, + 'release_url': 'https://pypi.org/project/sampleproject/1.2.0/', + 'requires_dist': None, + 'requires_python': None, + 'summary': 'A sample Python project', + 'version': '1.2.0'} diff --git a/python-3.7.4-docs-html/_sources/library/profile.rst.txt b/python-3.7.4-docs-html/_sources/library/profile.rst.txt new file mode 100644 index 0000000..926d775 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/profile.rst.txt @@ -0,0 +1,669 @@ +.. _profile: + +******************** +The Python Profilers +******************** + +**Source code:** :source:`Lib/profile.py` and :source:`Lib/pstats.py` + +-------------- + +.. _profiler-introduction: + +Introduction to the profilers +============================= + +.. index:: + single: deterministic profiling + single: profiling, deterministic + +:mod:`cProfile` and :mod:`profile` provide :dfn:`deterministic profiling` of +Python programs. A :dfn:`profile` is a set of statistics that describes how +often and for how long various parts of the program executed. These statistics +can be formatted into reports via the :mod:`pstats` module. + +The Python standard library provides two different implementations of the same +profiling interface: + +1. :mod:`cProfile` is recommended for most users; it's a C extension with + reasonable overhead that makes it suitable for profiling long-running + programs. Based on :mod:`lsprof`, contributed by Brett Rosen and Ted + Czotter. + +2. :mod:`profile`, a pure Python module whose interface is imitated by + :mod:`cProfile`, but which adds significant overhead to profiled programs. + If you're trying to extend the profiler in some way, the task might be easier + with this module. Originally designed and written by Jim Roskind. + +.. note:: + + The profiler modules are designed to provide an execution profile for a given + program, not for benchmarking purposes (for that, there is :mod:`timeit` for + reasonably accurate results). This particularly applies to benchmarking + Python code against C code: the profilers introduce overhead for Python code, + but not for C-level functions, and so the C code would seem faster than any + Python one. + + +.. _profile-instant: + +Instant User's Manual +===================== + +This section is provided for users that "don't want to read the manual." It +provides a very brief overview, and allows a user to rapidly perform profiling +on an existing application. + +To profile a function that takes a single argument, you can do:: + + import cProfile + import re + cProfile.run('re.compile("foo|bar")') + +(Use :mod:`profile` instead of :mod:`cProfile` if the latter is not available on +your system.) + +The above action would run :func:`re.compile` and print profile results like +the following:: + + 197 function calls (192 primitive calls) in 0.002 seconds + + Ordered by: standard name + + ncalls tottime percall cumtime percall filename:lineno(function) + 1 0.000 0.000 0.001 0.001 :1() + 1 0.000 0.000 0.001 0.001 re.py:212(compile) + 1 0.000 0.000 0.001 0.001 re.py:268(_compile) + 1 0.000 0.000 0.000 0.000 sre_compile.py:172(_compile_charset) + 1 0.000 0.000 0.000 0.000 sre_compile.py:201(_optimize_charset) + 4 0.000 0.000 0.000 0.000 sre_compile.py:25(_identityfunction) + 3/1 0.000 0.000 0.000 0.000 sre_compile.py:33(_compile) + +The first line indicates that 197 calls were monitored. Of those calls, 192 +were :dfn:`primitive`, meaning that the call was not induced via recursion. The +next line: ``Ordered by: standard name``, indicates that the text string in the +far right column was used to sort the output. The column headings include: + +ncalls + for the number of calls. + +tottime + for the total time spent in the given function (and excluding time made in + calls to sub-functions) + +percall + is the quotient of ``tottime`` divided by ``ncalls`` + +cumtime + is the cumulative time spent in this and all subfunctions (from invocation + till exit). This figure is accurate *even* for recursive functions. + +percall + is the quotient of ``cumtime`` divided by primitive calls + +filename:lineno(function) + provides the respective data of each function + +When there are two numbers in the first column (for example ``3/1``), it means +that the function recursed. The second value is the number of primitive calls +and the former is the total number of calls. Note that when the function does +not recurse, these two values are the same, and only the single figure is +printed. + +Instead of printing the output at the end of the profile run, you can save the +results to a file by specifying a filename to the :func:`run` function:: + + import cProfile + import re + cProfile.run('re.compile("foo|bar")', 'restats') + +The :class:`pstats.Stats` class reads profile results from a file and formats +them in various ways. + +The file :mod:`cProfile` can also be invoked as a script to profile another +script. For example:: + + python -m cProfile [-o output_file] [-s sort_order] (-m module | myscript.py) + +``-o`` writes the profile results to a file instead of to stdout + +``-s`` specifies one of the :func:`~pstats.Stats.sort_stats` sort values to sort +the output by. This only applies when ``-o`` is not supplied. + +``-m`` specifies that a module is being profiled instead of a script. + + .. versionadded:: 3.7 + Added the ``-m`` option. + +The :mod:`pstats` module's :class:`~pstats.Stats` class has a variety of methods +for manipulating and printing the data saved into a profile results file:: + + import pstats + from pstats import SortKey + p = pstats.Stats('restats') + p.strip_dirs().sort_stats(-1).print_stats() + +The :meth:`~pstats.Stats.strip_dirs` method removed the extraneous path from all +the module names. The :meth:`~pstats.Stats.sort_stats` method sorted all the +entries according to the standard module/line/name string that is printed. The +:meth:`~pstats.Stats.print_stats` method printed out all the statistics. You +might try the following sort calls:: + + p.sort_stats(SortKey.NAME) + p.print_stats() + +The first call will actually sort the list by function name, and the second call +will print out the statistics. The following are some interesting calls to +experiment with:: + + p.sort_stats(SortKey.CUMULATIVE).print_stats(10) + +This sorts the profile by cumulative time in a function, and then only prints +the ten most significant lines. If you want to understand what algorithms are +taking time, the above line is what you would use. + +If you were looking to see what functions were looping a lot, and taking a lot +of time, you would do:: + + p.sort_stats(SortKey.TIME).print_stats(10) + +to sort according to time spent within each function, and then print the +statistics for the top ten functions. + +You might also try:: + + p.sort_stats(SortKey.FILENAME).print_stats('__init__') + +This will sort all the statistics by file name, and then print out statistics +for only the class init methods (since they are spelled with ``__init__`` in +them). As one final example, you could try:: + + p.sort_stats(SortKey.TIME, SortKey.CUMULATIVE).print_stats(.5, 'init') + +This line sorts statistics with a primary key of time, and a secondary key of +cumulative time, and then prints out some of the statistics. To be specific, the +list is first culled down to 50% (re: ``.5``) of its original size, then only +lines containing ``init`` are maintained, and that sub-sub-list is printed. + +If you wondered what functions called the above functions, you could now (``p`` +is still sorted according to the last criteria) do:: + + p.print_callers(.5, 'init') + +and you would get a list of callers for each of the listed functions. + +If you want more functionality, you're going to have to read the manual, or +guess what the following functions do:: + + p.print_callees() + p.add('restats') + +Invoked as a script, the :mod:`pstats` module is a statistics browser for +reading and examining profile dumps. It has a simple line-oriented interface +(implemented using :mod:`cmd`) and interactive help. + +:mod:`profile` and :mod:`cProfile` Module Reference +======================================================= + +.. module:: cProfile +.. module:: profile + :synopsis: Python source profiler. + +Both the :mod:`profile` and :mod:`cProfile` modules provide the following +functions: + +.. function:: run(command, filename=None, sort=-1) + + This function takes a single argument that can be passed to the :func:`exec` + function, and an optional file name. In all cases this routine executes:: + + exec(command, __main__.__dict__, __main__.__dict__) + + and gathers profiling statistics from the execution. If no file name is + present, then this function automatically creates a :class:`~pstats.Stats` + instance and prints a simple profiling report. If the sort value is specified, + it is passed to this :class:`~pstats.Stats` instance to control how the + results are sorted. + +.. function:: runctx(command, globals, locals, filename=None, sort=-1) + + This function is similar to :func:`run`, with added arguments to supply the + globals and locals dictionaries for the *command* string. This routine + executes:: + + exec(command, globals, locals) + + and gathers profiling statistics as in the :func:`run` function above. + +.. class:: Profile(timer=None, timeunit=0.0, subcalls=True, builtins=True) + + This class is normally only used if more precise control over profiling is + needed than what the :func:`cProfile.run` function provides. + + A custom timer can be supplied for measuring how long code takes to run via + the *timer* argument. This must be a function that returns a single number + representing the current time. If the number is an integer, the *timeunit* + specifies a multiplier that specifies the duration of each unit of time. For + example, if the timer returns times measured in thousands of seconds, the + time unit would be ``.001``. + + Directly using the :class:`Profile` class allows formatting profile results + without writing the profile data to a file:: + + import cProfile, pstats, io + from pstats import SortKey + pr = cProfile.Profile() + pr.enable() + # ... do something ... + pr.disable() + s = io.StringIO() + sortby = SortKey.CUMULATIVE + ps = pstats.Stats(pr, stream=s).sort_stats(sortby) + ps.print_stats() + print(s.getvalue()) + + .. method:: enable() + + Start collecting profiling data. + + .. method:: disable() + + Stop collecting profiling data. + + .. method:: create_stats() + + Stop collecting profiling data and record the results internally + as the current profile. + + .. method:: print_stats(sort=-1) + + Create a :class:`~pstats.Stats` object based on the current + profile and print the results to stdout. + + .. method:: dump_stats(filename) + + Write the results of the current profile to *filename*. + + .. method:: run(cmd) + + Profile the cmd via :func:`exec`. + + .. method:: runctx(cmd, globals, locals) + + Profile the cmd via :func:`exec` with the specified global and + local environment. + + .. method:: runcall(func, *args, **kwargs) + + Profile ``func(*args, **kwargs)`` + +Note that profiling will only work if the called command/function actually +returns. If the interpreter is terminated (e.g. via a :func:`sys.exit` call +during the called command/function execution) no profiling results will be +printed. + +.. _profile-stats: + +The :class:`Stats` Class +======================== + +Analysis of the profiler data is done using the :class:`~pstats.Stats` class. + +.. module:: pstats + :synopsis: Statistics object for use with the profiler. + +.. class:: Stats(*filenames or profile, stream=sys.stdout) + + This class constructor creates an instance of a "statistics object" from a + *filename* (or list of filenames) or from a :class:`Profile` instance. Output + will be printed to the stream specified by *stream*. + + The file selected by the above constructor must have been created by the + corresponding version of :mod:`profile` or :mod:`cProfile`. To be specific, + there is *no* file compatibility guaranteed with future versions of this + profiler, and there is no compatibility with files produced by other + profilers, or the same profiler run on a different operating system. If + several files are provided, all the statistics for identical functions will + be coalesced, so that an overall view of several processes can be considered + in a single report. If additional files need to be combined with data in an + existing :class:`~pstats.Stats` object, the :meth:`~pstats.Stats.add` method + can be used. + + Instead of reading the profile data from a file, a :class:`cProfile.Profile` + or :class:`profile.Profile` object can be used as the profile data source. + + :class:`Stats` objects have the following methods: + + .. method:: strip_dirs() + + This method for the :class:`Stats` class removes all leading path + information from file names. It is very useful in reducing the size of + the printout to fit within (close to) 80 columns. This method modifies + the object, and the stripped information is lost. After performing a + strip operation, the object is considered to have its entries in a + "random" order, as it was just after object initialization and loading. + If :meth:`~pstats.Stats.strip_dirs` causes two function names to be + indistinguishable (they are on the same line of the same filename, and + have the same function name), then the statistics for these two entries + are accumulated into a single entry. + + + .. method:: add(*filenames) + + This method of the :class:`Stats` class accumulates additional profiling + information into the current profiling object. Its arguments should refer + to filenames created by the corresponding version of :func:`profile.run` + or :func:`cProfile.run`. Statistics for identically named (re: file, line, + name) functions are automatically accumulated into single function + statistics. + + + .. method:: dump_stats(filename) + + Save the data loaded into the :class:`Stats` object to a file named + *filename*. The file is created if it does not exist, and is overwritten + if it already exists. This is equivalent to the method of the same name + on the :class:`profile.Profile` and :class:`cProfile.Profile` classes. + + + .. method:: sort_stats(*keys) + + This method modifies the :class:`Stats` object by sorting it according to + the supplied criteria. The argument can be either a string or a SortKey + enum identifying the basis of a sort (example: ``'time'``, ``'name'``, + ``SortKey.TIME`` or ``SortKey.NAME``). The SortKey enums argument have + advantage over the string argument in that it is more robust and less + error prone. + + When more than one key is provided, then additional keys are used as + secondary criteria when there is equality in all keys selected before + them. For example, ``sort_stats(SortKey.NAME, SortKey.FILE)`` will sort + all the entries according to their function name, and resolve all ties + (identical function names) by sorting by file name. + + For the string argument, abbreviations can be used for any key names, as + long as the abbreviation is unambiguous. + + The following are the valid string and SortKey: + + +------------------+---------------------+----------------------+ + | Valid String Arg | Valid enum Arg | Meaning | + +==================+=====================+======================+ + | ``'calls'`` | SortKey.CALLS | call count | + +------------------+---------------------+----------------------+ + | ``'cumulative'`` | SortKey.CUMULATIVE | cumulative time | + +------------------+---------------------+----------------------+ + | ``'cumtime'`` | N/A | cumulative time | + +------------------+---------------------+----------------------+ + | ``'file'`` | N/A | file name | + +------------------+---------------------+----------------------+ + | ``'filename'`` | SortKey.FILENAME | file name | + +------------------+---------------------+----------------------+ + | ``'module'`` | N/A | file name | + +------------------+---------------------+----------------------+ + | ``'ncalls'`` | N/A | call count | + +------------------+---------------------+----------------------+ + | ``'pcalls'`` | SortKey.PCALLS | primitive call count | + +------------------+---------------------+----------------------+ + | ``'line'`` | SortKey.LINE | line number | + +------------------+---------------------+----------------------+ + | ``'name'`` | SortKey.NAME | function name | + +------------------+---------------------+----------------------+ + | ``'nfl'`` | SortKey.NFL | name/file/line | + +------------------+---------------------+----------------------+ + | ``'stdname'`` | SortKey.STDNAME | standard name | + +------------------+---------------------+----------------------+ + | ``'time'`` | SortKey.TIME | internal time | + +------------------+---------------------+----------------------+ + | ``'tottime'`` | N/A | internal time | + +------------------+---------------------+----------------------+ + + Note that all sorts on statistics are in descending order (placing most + time consuming items first), where as name, file, and line number searches + are in ascending order (alphabetical). The subtle distinction between + ``SortKey.NFL`` and ``SortKey.STDNAME`` is that the standard name is a + sort of the name as printed, which means that the embedded line numbers + get compared in an odd way. For example, lines 3, 20, and 40 would (if + the file names were the same) appear in the string order 20, 3 and 40. + In contrast, ``SortKey.NFL`` does a numeric compare of the line numbers. + In fact, ``sort_stats(SortKey.NFL)`` is the same as + ``sort_stats(SortKey.NAME, SortKey.FILENAME, SortKey.LINE)``. + + For backward-compatibility reasons, the numeric arguments ``-1``, ``0``, + ``1``, and ``2`` are permitted. They are interpreted as ``'stdname'``, + ``'calls'``, ``'time'``, and ``'cumulative'`` respectively. If this old + style format (numeric) is used, only one sort key (the numeric key) will + be used, and additional arguments will be silently ignored. + + .. For compatibility with the old profiler. + + .. versionadded:: 3.7 + Added the SortKey enum. + + .. method:: reverse_order() + + This method for the :class:`Stats` class reverses the ordering of the + basic list within the object. Note that by default ascending vs + descending order is properly selected based on the sort key of choice. + + .. This method is provided primarily for compatibility with the old + profiler. + + + .. method:: print_stats(*restrictions) + + This method for the :class:`Stats` class prints out a report as described + in the :func:`profile.run` definition. + + The order of the printing is based on the last + :meth:`~pstats.Stats.sort_stats` operation done on the object (subject to + caveats in :meth:`~pstats.Stats.add` and + :meth:`~pstats.Stats.strip_dirs`). + + The arguments provided (if any) can be used to limit the list down to the + significant entries. Initially, the list is taken to be the complete set + of profiled functions. Each restriction is either an integer (to select a + count of lines), or a decimal fraction between 0.0 and 1.0 inclusive (to + select a percentage of lines), or a string that will interpreted as a + regular expression (to pattern match the standard name that is printed). + If several restrictions are provided, then they are applied sequentially. + For example:: + + print_stats(.1, 'foo:') + + would first limit the printing to first 10% of list, and then only print + functions that were part of filename :file:`.\*foo:`. In contrast, the + command:: + + print_stats('foo:', .1) + + would limit the list to all functions having file names :file:`.\*foo:`, + and then proceed to only print the first 10% of them. + + + .. method:: print_callers(*restrictions) + + This method for the :class:`Stats` class prints a list of all functions + that called each function in the profiled database. The ordering is + identical to that provided by :meth:`~pstats.Stats.print_stats`, and the + definition of the restricting argument is also identical. Each caller is + reported on its own line. The format differs slightly depending on the + profiler that produced the stats: + + * With :mod:`profile`, a number is shown in parentheses after each caller + to show how many times this specific call was made. For convenience, a + second non-parenthesized number repeats the cumulative time spent in the + function at the right. + + * With :mod:`cProfile`, each caller is preceded by three numbers: the + number of times this specific call was made, and the total and + cumulative times spent in the current function while it was invoked by + this specific caller. + + + .. method:: print_callees(*restrictions) + + This method for the :class:`Stats` class prints a list of all function + that were called by the indicated function. Aside from this reversal of + direction of calls (re: called vs was called by), the arguments and + ordering are identical to the :meth:`~pstats.Stats.print_callers` method. + + +.. _deterministic-profiling: + +What Is Deterministic Profiling? +================================ + +:dfn:`Deterministic profiling` is meant to reflect the fact that all *function +call*, *function return*, and *exception* events are monitored, and precise +timings are made for the intervals between these events (during which time the +user's code is executing). In contrast, :dfn:`statistical profiling` (which is +not done by this module) randomly samples the effective instruction pointer, and +deduces where time is being spent. The latter technique traditionally involves +less overhead (as the code does not need to be instrumented), but provides only +relative indications of where time is being spent. + +In Python, since there is an interpreter active during execution, the presence +of instrumented code is not required to do deterministic profiling. Python +automatically provides a :dfn:`hook` (optional callback) for each event. In +addition, the interpreted nature of Python tends to add so much overhead to +execution, that deterministic profiling tends to only add small processing +overhead in typical applications. The result is that deterministic profiling is +not that expensive, yet provides extensive run time statistics about the +execution of a Python program. + +Call count statistics can be used to identify bugs in code (surprising counts), +and to identify possible inline-expansion points (high call counts). Internal +time statistics can be used to identify "hot loops" that should be carefully +optimized. Cumulative time statistics should be used to identify high level +errors in the selection of algorithms. Note that the unusual handling of +cumulative times in this profiler allows statistics for recursive +implementations of algorithms to be directly compared to iterative +implementations. + + +.. _profile-limitations: + +Limitations +=========== + +One limitation has to do with accuracy of timing information. There is a +fundamental problem with deterministic profilers involving accuracy. The most +obvious restriction is that the underlying "clock" is only ticking at a rate +(typically) of about .001 seconds. Hence no measurements will be more accurate +than the underlying clock. If enough measurements are taken, then the "error" +will tend to average out. Unfortunately, removing this first error induces a +second source of error. + +The second problem is that it "takes a while" from when an event is dispatched +until the profiler's call to get the time actually *gets* the state of the +clock. Similarly, there is a certain lag when exiting the profiler event +handler from the time that the clock's value was obtained (and then squirreled +away), until the user's code is once again executing. As a result, functions +that are called many times, or call many functions, will typically accumulate +this error. The error that accumulates in this fashion is typically less than +the accuracy of the clock (less than one clock tick), but it *can* accumulate +and become very significant. + +The problem is more important with :mod:`profile` than with the lower-overhead +:mod:`cProfile`. For this reason, :mod:`profile` provides a means of +calibrating itself for a given platform so that this error can be +probabilistically (on the average) removed. After the profiler is calibrated, it +will be more accurate (in a least square sense), but it will sometimes produce +negative numbers (when call counts are exceptionally low, and the gods of +probability work against you :-). ) Do *not* be alarmed by negative numbers in +the profile. They should *only* appear if you have calibrated your profiler, +and the results are actually better than without calibration. + + +.. _profile-calibration: + +Calibration +=========== + +The profiler of the :mod:`profile` module subtracts a constant from each event +handling time to compensate for the overhead of calling the time function, and +socking away the results. By default, the constant is 0. The following +procedure can be used to obtain a better constant for a given platform (see +:ref:`profile-limitations`). :: + + import profile + pr = profile.Profile() + for i in range(5): + print(pr.calibrate(10000)) + +The method executes the number of Python calls given by the argument, directly +and again under the profiler, measuring the time for both. It then computes the +hidden overhead per profiler event, and returns that as a float. For example, +on a 1.8Ghz Intel Core i5 running Mac OS X, and using Python's time.process_time() as +the timer, the magical number is about 4.04e-6. + +The object of this exercise is to get a fairly consistent result. If your +computer is *very* fast, or your timer function has poor resolution, you might +have to pass 100000, or even 1000000, to get consistent results. + +When you have a consistent answer, there are three ways you can use it:: + + import profile + + # 1. Apply computed bias to all Profile instances created hereafter. + profile.Profile.bias = your_computed_bias + + # 2. Apply computed bias to a specific Profile instance. + pr = profile.Profile() + pr.bias = your_computed_bias + + # 3. Specify computed bias in instance constructor. + pr = profile.Profile(bias=your_computed_bias) + +If you have a choice, you are better off choosing a smaller constant, and then +your results will "less often" show up as negative in profile statistics. + +.. _profile-timers: + +Using a custom timer +==================== + +If you want to change how current time is determined (for example, to force use +of wall-clock time or elapsed process time), pass the timing function you want +to the :class:`Profile` class constructor:: + + pr = profile.Profile(your_time_func) + +The resulting profiler will then call ``your_time_func``. Depending on whether +you are using :class:`profile.Profile` or :class:`cProfile.Profile`, +``your_time_func``'s return value will be interpreted differently: + +:class:`profile.Profile` + ``your_time_func`` should return a single number, or a list of numbers whose + sum is the current time (like what :func:`os.times` returns). If the + function returns a single time number, or the list of returned numbers has + length 2, then you will get an especially fast version of the dispatch + routine. + + Be warned that you should calibrate the profiler class for the timer function + that you choose (see :ref:`profile-calibration`). For most machines, a timer + that returns a lone integer value will provide the best results in terms of + low overhead during profiling. (:func:`os.times` is *pretty* bad, as it + returns a tuple of floating point values). If you want to substitute a + better timer in the cleanest fashion, derive a class and hardwire a + replacement dispatch method that best handles your timer call, along with the + appropriate calibration constant. + +:class:`cProfile.Profile` + ``your_time_func`` should return a single number. If it returns integers, + you can also invoke the class constructor with a second argument specifying + the real duration of one unit of time. For example, if + ``your_integer_time_func`` returns times measured in thousands of seconds, + you would construct the :class:`Profile` instance as follows:: + + pr = cProfile.Profile(your_integer_time_func, 0.001) + + As the :class:`cProfile.Profile` class cannot be calibrated, custom timer + functions should be used with care and should be as fast as possible. For + the best results with a custom timer, it might be necessary to hard-code it + in the C source of the internal :mod:`_lsprof` module. + +Python 3.3 adds several new functions in :mod:`time` that can be used to make +precise measurements of process or wall-clock time. For example, see +:func:`time.perf_counter`. diff --git a/python-3.7.4-docs-html/_sources/library/pty.rst.txt b/python-3.7.4-docs-html/_sources/library/pty.rst.txt new file mode 100644 index 0000000..1226843 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/pty.rst.txt @@ -0,0 +1,114 @@ +:mod:`pty` --- Pseudo-terminal utilities +======================================== + +.. module:: pty + :platform: Linux + :synopsis: Pseudo-Terminal Handling for Linux. + +.. moduleauthor:: Steen Lumholt +.. sectionauthor:: Moshe Zadka + +**Source code:** :source:`Lib/pty.py` + +-------------- + +The :mod:`pty` module defines operations for handling the pseudo-terminal +concept: starting another process and being able to write to and read from its +controlling terminal programmatically. + +Because pseudo-terminal handling is highly platform dependent, there is code to +do it only for Linux. (The Linux code is supposed to work on other platforms, +but hasn't been tested yet.) + +The :mod:`pty` module defines the following functions: + + +.. function:: fork() + + Fork. Connect the child's controlling terminal to a pseudo-terminal. Return + value is ``(pid, fd)``. Note that the child gets *pid* 0, and the *fd* is + *invalid*. The parent's return value is the *pid* of the child, and *fd* is a + file descriptor connected to the child's controlling terminal (and also to the + child's standard input and output). + + +.. function:: openpty() + + Open a new pseudo-terminal pair, using :func:`os.openpty` if possible, or + emulation code for generic Unix systems. Return a pair of file descriptors + ``(master, slave)``, for the master and the slave end, respectively. + + +.. function:: spawn(argv[, master_read[, stdin_read]]) + + Spawn a process, and connect its controlling terminal with the current + process's standard io. This is often used to baffle programs which insist on + reading from the controlling terminal. It is expected that the process + spawned behind the pty will eventually terminate, and when it does *spawn* + will return. + + The functions *master_read* and *stdin_read* are passed a file descriptor + which they should read from, and they should always return a byte string. In + order to force spawn to return before the child process exits an + :exc:`OSError` should be thrown. + + The default implementation for both functions will read and return up to 1024 + bytes each time the function is called. The *master_read* callback is passed + the pseudoterminal’s master file descriptor to read output from the child + process, and *stdin_read* is passed file descriptor 0, to read from the + parent process's standard input. + + Returning an empty byte string from either callback is interpreted as an + end-of-file (EOF) condition, and that callback will not be called after + that. If *stdin_read* signals EOF the controlling terminal can no longer + communicate with the parent process OR the child process. Unless the child + process will quit without any input, *spawn* will then loop forever. If + *master_read* signals EOF the same behavior results (on linux at least). + + If both callbacks signal EOF then *spawn* will probably never return, unless + *select* throws an error on your platform when passed three empty lists. This + is a bug, documented in `issue 26228 `_. + + + .. versionchanged:: 3.4 + :func:`spawn` now returns the status value from :func:`os.waitpid` + on the child process. + +Example +------- + +.. sectionauthor:: Steen Lumholt + +The following program acts like the Unix command :manpage:`script(1)`, using a +pseudo-terminal to record all input and output of a terminal session in a +"typescript". :: + + import argparse + import os + import pty + import sys + import time + + parser = argparse.ArgumentParser() + parser.add_argument('-a', dest='append', action='store_true') + parser.add_argument('-p', dest='use_python', action='store_true') + parser.add_argument('filename', nargs='?', default='typescript') + options = parser.parse_args() + + shell = sys.executable if options.use_python else os.environ.get('SHELL', 'sh') + filename = options.filename + mode = 'ab' if options.append else 'wb' + + with open(filename, mode) as script: + def read(fd): + data = os.read(fd, 1024) + script.write(data) + return data + + print('Script started, file is', filename) + script.write(('Script started on %s\n' % time.asctime()).encode()) + + pty.spawn(shell, read) + + script.write(('Script done on %s\n' % time.asctime()).encode()) + print('Script done, file is', filename) diff --git a/python-3.7.4-docs-html/_sources/library/pwd.rst.txt b/python-3.7.4-docs-html/_sources/library/pwd.rst.txt new file mode 100644 index 0000000..03ebb02 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/pwd.rst.txt @@ -0,0 +1,76 @@ +:mod:`pwd` --- The password database +==================================== + +.. module:: pwd + :platform: Unix + :synopsis: The password database (getpwnam() and friends). + +-------------- + +This module provides access to the Unix user account and password database. It +is available on all Unix versions. + +Password database entries are reported as a tuple-like object, whose attributes +correspond to the members of the ``passwd`` structure (Attribute field below, +see ````): + ++-------+---------------+-----------------------------+ +| Index | Attribute | Meaning | ++=======+===============+=============================+ +| 0 | ``pw_name`` | Login name | ++-------+---------------+-----------------------------+ +| 1 | ``pw_passwd`` | Optional encrypted password | ++-------+---------------+-----------------------------+ +| 2 | ``pw_uid`` | Numerical user ID | ++-------+---------------+-----------------------------+ +| 3 | ``pw_gid`` | Numerical group ID | ++-------+---------------+-----------------------------+ +| 4 | ``pw_gecos`` | User name or comment field | ++-------+---------------+-----------------------------+ +| 5 | ``pw_dir`` | User home directory | ++-------+---------------+-----------------------------+ +| 6 | ``pw_shell`` | User command interpreter | ++-------+---------------+-----------------------------+ + +The uid and gid items are integers, all others are strings. :exc:`KeyError` is +raised if the entry asked for cannot be found. + +.. note:: + + .. index:: module: crypt + + In traditional Unix the field ``pw_passwd`` usually contains a password + encrypted with a DES derived algorithm (see module :mod:`crypt`). However most + modern unices use a so-called *shadow password* system. On those unices the + *pw_passwd* field only contains an asterisk (``'*'``) or the letter ``'x'`` + where the encrypted password is stored in a file :file:`/etc/shadow` which is + not world readable. Whether the *pw_passwd* field contains anything useful is + system-dependent. If available, the :mod:`spwd` module should be used where + access to the encrypted password is required. + +It defines the following items: + + +.. function:: getpwuid(uid) + + Return the password database entry for the given numeric user ID. + + +.. function:: getpwnam(name) + + Return the password database entry for the given user name. + + +.. function:: getpwall() + + Return a list of all available password database entries, in arbitrary order. + + +.. seealso:: + + Module :mod:`grp` + An interface to the group database, similar to this. + + Module :mod:`spwd` + An interface to the shadow password database, similar to this. + diff --git a/python-3.7.4-docs-html/_sources/library/py_compile.rst.txt b/python-3.7.4-docs-html/_sources/library/py_compile.rst.txt new file mode 100644 index 0000000..8cb5a4d --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/py_compile.rst.txt @@ -0,0 +1,138 @@ +:mod:`py_compile` --- Compile Python source files +================================================= + +.. module:: py_compile + :synopsis: Generate byte-code files from Python source files. + +.. sectionauthor:: Fred L. Drake, Jr. +.. documentation based on module docstrings + +**Source code:** :source:`Lib/py_compile.py` + +.. index:: pair: file; byte-code + +-------------- + +The :mod:`py_compile` module provides a function to generate a byte-code file +from a source file, and another function used when the module source file is +invoked as a script. + +Though not often needed, this function can be useful when installing modules for +shared use, especially if some of the users may not have permission to write the +byte-code cache files in the directory containing the source code. + + +.. exception:: PyCompileError + + Exception raised when an error occurs while attempting to compile the file. + + +.. function:: compile(file, cfile=None, dfile=None, doraise=False, optimize=-1, invalidation_mode=PycInvalidationMode.TIMESTAMP) + + Compile a source file to byte-code and write out the byte-code cache file. + The source code is loaded from the file named *file*. The byte-code is + written to *cfile*, which defaults to the :pep:`3147`/:pep:`488` path, ending + in ``.pyc``. + For example, if *file* is ``/foo/bar/baz.py`` *cfile* will default to + ``/foo/bar/__pycache__/baz.cpython-32.pyc`` for Python 3.2. If *dfile* is + specified, it is used as the name of the source file in error messages when + instead of *file*. If *doraise* is true, a :exc:`PyCompileError` is raised + when an error is encountered while compiling *file*. If *doraise* is false + (the default), an error string is written to ``sys.stderr``, but no exception + is raised. This function returns the path to byte-compiled file, i.e. + whatever *cfile* value was used. + + If the path that *cfile* becomes (either explicitly specified or computed) + is a symlink or non-regular file, :exc:`FileExistsError` will be raised. + This is to act as a warning that import will turn those paths into regular + files if it is allowed to write byte-compiled files to those paths. This is + a side-effect of import using file renaming to place the final byte-compiled + file into place to prevent concurrent file writing issues. + + *optimize* controls the optimization level and is passed to the built-in + :func:`compile` function. The default of ``-1`` selects the optimization + level of the current interpreter. + + *invalidation_mode* should be a member of the :class:`PycInvalidationMode` + enum and controls how the generated bytecode cache is invalidated at + runtime. The default is :attr:`PycInvalidationMode.CHECKED_HASH` if + the :envvar:`SOURCE_DATE_EPOCH` environment variable is set, otherwise + the default is :attr:`PycInvalidationMode.TIMESTAMP`. + + .. versionchanged:: 3.2 + Changed default value of *cfile* to be :PEP:`3147`-compliant. Previous + default was *file* + ``'c'`` (``'o'`` if optimization was enabled). + Also added the *optimize* parameter. + + .. versionchanged:: 3.4 + Changed code to use :mod:`importlib` for the byte-code cache file writing. + This means file creation/writing semantics now match what :mod:`importlib` + does, e.g. permissions, write-and-move semantics, etc. Also added the + caveat that :exc:`FileExistsError` is raised if *cfile* is a symlink or + non-regular file. + + .. versionchanged:: 3.7 + The *invalidation_mode* parameter was added as specified in :pep:`552`. + If the :envvar:`SOURCE_DATE_EPOCH` environment variable is set, + *invalidation_mode* will be forced to + :attr:`PycInvalidationMode.CHECKED_HASH`. + + .. versionchanged:: 3.7.2 + The :envvar:`SOURCE_DATE_EPOCH` environment variable no longer + overrides the value of the *invalidation_mode* argument, and determines + its default value instead. + + +.. class:: PycInvalidationMode + + A enumeration of possible methods the interpreter can use to determine + whether a bytecode file is up to date with a source file. The ``.pyc`` file + indicates the desired invalidation mode in its header. See + :ref:`pyc-invalidation` for more information on how Python invalidates + ``.pyc`` files at runtime. + + .. versionadded:: 3.7 + + .. attribute:: TIMESTAMP + + The ``.pyc`` file includes the timestamp and size of the source file, + which Python will compare against the metadata of the source file at + runtime to determine if the ``.pyc`` file needs to be regenerated. + + .. attribute:: CHECKED_HASH + + The ``.pyc`` file includes a hash of the source file content, which Python + will compare against the source at runtime to determine if the ``.pyc`` + file needs to be regenerated. + + .. attribute:: UNCHECKED_HASH + + Like :attr:`CHECKED_HASH`, the ``.pyc`` file includes a hash of the source + file content. However, Python will at runtime assume the ``.pyc`` file is + up to date and not validate the ``.pyc`` against the source file at all. + + This option is useful when the ``.pycs`` are kept up to date by some + system external to Python like a build system. + + +.. function:: main(args=None) + + Compile several source files. The files named in *args* (or on the command + line, if *args* is ``None``) are compiled and the resulting byte-code is + cached in the normal manner. This function does not search a directory + structure to locate source files; it only compiles files named explicitly. + If ``'-'`` is the only parameter in args, the list of files is taken from + standard input. + + .. versionchanged:: 3.2 + Added support for ``'-'``. + +When this module is run as a script, the :func:`main` is used to compile all the +files named on the command line. The exit status is nonzero if one of the files +could not be compiled. + + +.. seealso:: + + Module :mod:`compileall` + Utilities to compile all Python source files in a directory tree. diff --git a/python-3.7.4-docs-html/_sources/library/pyclbr.rst.txt b/python-3.7.4-docs-html/_sources/library/pyclbr.rst.txt new file mode 100644 index 0000000..b80a2fa --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/pyclbr.rst.txt @@ -0,0 +1,153 @@ +:mod:`pyclbr` --- Python class browser support +============================================== + +.. module:: pyclbr + :synopsis: Supports information extraction for a Python class browser. + +.. sectionauthor:: Fred L. Drake, Jr. + +**Source code:** :source:`Lib/pyclbr.py` + +-------------- + +The :mod:`pyclbr` module provides limited information about the +functions, classes, and methods defined in a Python-coded module. The +information is sufficient to implement a module browser. The +information is extracted from the Python source code rather than by +importing the module, so this module is safe to use with untrusted code. +This restriction makes it impossible to use this module with modules not +implemented in Python, including all standard and optional extension +modules. + + +.. function:: readmodule(module, path=None) + + Return a dictionary mapping module-level class names to class + descriptors. If possible, descriptors for imported base classes are + included. Parameter *module* is a string with the name of the module + to read; it may be the name of a module within a package. If given, + *path* is a sequence of directory paths prepended to ``sys.path``, + which is used to locate the module source code. + + +.. function:: readmodule_ex(module, path=None) + + Return a dictionary-based tree containing a function or class + descriptors for each function and class defined in the module with a + ``def`` or ``class`` statement. The returned dictionary maps + module-level function and class names to their descriptors. Nested + objects are entered into the children dictionary of their parent. As + with readmodule, *module* names the module to be read and *path* is + prepended to sys.path. If the module being read is a package, the + returned dictionary has a key ``'__path__'`` whose value is a list + containing the package search path. + +.. versionadded:: 3.7 + Descriptors for nested definitions. They are accessed through the + new children attribute. Each has a new parent attribute. + +The descriptors returned by these functions are instances of +Function and Class classes. Users are not expected to create instances +of these classes. + + +.. _pyclbr-function-objects: + +Function Objects +---------------- +Class :class:`Function` instances describe functions defined by def +statements. They have the following attributes: + + +.. attribute:: Function.file + + Name of the file in which the function is defined. + + +.. attribute:: Function.module + + The name of the module defining the function described. + + +.. attribute:: Function.name + + The name of the function. + + +.. attribute:: Function.lineno + + The line number in the file where the definition starts. + + +.. attribute:: Function.parent + + For top-level functions, None. For nested functions, the parent. + + .. versionadded:: 3.7 + + +.. attribute:: Function.children + + A dictionary mapping names to descriptors for nested functions and + classes. + + .. versionadded:: 3.7 + + +.. _pyclbr-class-objects: + +Class Objects +------------- +Class :class:`Class` instances describe classes defined by class +statements. They have the same attributes as Functions and two more. + + +.. attribute:: Class.file + + Name of the file in which the class is defined. + + +.. attribute:: Class.module + + The name of the module defining the class described. + + +.. attribute:: Class.name + + The name of the class. + + +.. attribute:: Class.lineno + + The line number in the file where the definition starts. + + +.. attribute:: Class.parent + + For top-level classes, None. For nested classes, the parent. + + .. versionadded:: 3.7 + + +.. attribute:: Class.children + + A dictionary mapping names to descriptors for nested functions and + classes. + + .. versionadded:: 3.7 + + +.. attribute:: Class.super + + A list of :class:`Class` objects which describe the immediate base + classes of the class being described. Classes which are named as + superclasses but which are not discoverable by :func:`readmodule_ex` + are listed as a string with the class name instead of as + :class:`Class` objects. + + +.. attribute:: Class.methods + + A dictionary mapping method names to line numbers. This can be + derived from the newer children dictionary, but remains for + back-compatibility. diff --git a/python-3.7.4-docs-html/_sources/library/pydoc.rst.txt b/python-3.7.4-docs-html/_sources/library/pydoc.rst.txt new file mode 100644 index 0000000..f956b9d --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/pydoc.rst.txt @@ -0,0 +1,109 @@ +:mod:`pydoc` --- Documentation generator and online help system +=============================================================== + +.. module:: pydoc + :synopsis: Documentation generator and online help system. + +.. moduleauthor:: Ka-Ping Yee +.. sectionauthor:: Ka-Ping Yee + +**Source code:** :source:`Lib/pydoc.py` + +.. index:: + single: documentation; generation + single: documentation; online + single: help; online + +-------------- + +The :mod:`pydoc` module automatically generates documentation from Python +modules. The documentation can be presented as pages of text on the console, +served to a Web browser, or saved to HTML files. + +For modules, classes, functions and methods, the displayed documentation is +derived from the docstring (i.e. the :attr:`__doc__` attribute) of the object, +and recursively of its documentable members. If there is no docstring, +:mod:`pydoc` tries to obtain a description from the block of comment lines just +above the definition of the class, function or method in the source file, or at +the top of the module (see :func:`inspect.getcomments`). + +The built-in function :func:`help` invokes the online help system in the +interactive interpreter, which uses :mod:`pydoc` to generate its documentation +as text on the console. The same text documentation can also be viewed from +outside the Python interpreter by running :program:`pydoc` as a script at the +operating system's command prompt. For example, running :: + + pydoc sys + +at a shell prompt will display documentation on the :mod:`sys` module, in a +style similar to the manual pages shown by the Unix :program:`man` command. The +argument to :program:`pydoc` can be the name of a function, module, or package, +or a dotted reference to a class, method, or function within a module or module +in a package. If the argument to :program:`pydoc` looks like a path (that is, +it contains the path separator for your operating system, such as a slash in +Unix), and refers to an existing Python source file, then documentation is +produced for that file. + +.. note:: + + In order to find objects and their documentation, :mod:`pydoc` imports the + module(s) to be documented. Therefore, any code on module level will be + executed on that occasion. Use an ``if __name__ == '__main__':`` guard to + only execute code when a file is invoked as a script and not just imported. + +When printing output to the console, :program:`pydoc` attempts to paginate the +output for easier reading. If the :envvar:`PAGER` environment variable is set, +:program:`pydoc` will use its value as a pagination program. + +Specifying a ``-w`` flag before the argument will cause HTML documentation +to be written out to a file in the current directory, instead of displaying text +on the console. + +Specifying a ``-k`` flag before the argument will search the synopsis +lines of all available modules for the keyword given as the argument, again in a +manner similar to the Unix :program:`man` command. The synopsis line of a +module is the first line of its documentation string. + +You can also use :program:`pydoc` to start an HTTP server on the local machine +that will serve documentation to visiting Web browsers. :program:`pydoc -p 1234` +will start a HTTP server on port 1234, allowing you to browse the +documentation at ``http://localhost:1234/`` in your preferred Web browser. +Specifying ``0`` as the port number will select an arbitrary unused port. + +:program:`pydoc -n ` will start the server listening at the given +hostname. By default the hostname is 'localhost' but if you want the server to +be reached from other machines, you may want to change the host name that the +server responds to. During development this is especially useful if you want +to run pydoc from within a container. + +:program:`pydoc -b` will start the server and additionally open a web +browser to a module index page. Each served page has a navigation bar at the +top where you can *Get* help on an individual item, *Search* all modules with a +keyword in their synopsis line, and go to the *Module index*, *Topics* and +*Keywords* pages. + +When :program:`pydoc` generates documentation, it uses the current environment +and path to locate modules. Thus, invoking :program:`pydoc spam` +documents precisely the version of the module you would get if you started the +Python interpreter and typed ``import spam``. + +Module docs for core modules are assumed to reside in +``https://docs.python.org/X.Y/library/`` where ``X`` and ``Y`` are the +major and minor version numbers of the Python interpreter. This can +be overridden by setting the :envvar:`PYTHONDOCS` environment variable +to a different URL or to a local directory containing the Library +Reference Manual pages. + +.. versionchanged:: 3.2 + Added the ``-b`` option. + +.. versionchanged:: 3.3 + The ``-g`` command line option was removed. + +.. versionchanged:: 3.4 + :mod:`pydoc` now uses :func:`inspect.signature` rather than + :func:`inspect.getfullargspec` to extract signature information from + callables. + +.. versionchanged:: 3.7 + Added the ``-n`` option. diff --git a/python-3.7.4-docs-html/_sources/library/pyexpat.rst.txt b/python-3.7.4-docs-html/_sources/library/pyexpat.rst.txt new file mode 100644 index 0000000..e43b9ae --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/pyexpat.rst.txt @@ -0,0 +1,876 @@ +:mod:`xml.parsers.expat` --- Fast XML parsing using Expat +========================================================= + +.. module:: xml.parsers.expat + :synopsis: An interface to the Expat non-validating XML parser. + +.. moduleauthor:: Paul Prescod + +-------------- + +.. Markup notes: + + Many of the attributes of the XMLParser objects are callbacks. Since + signature information must be presented, these are described using the method + directive. Since they are attributes which are set by client code, in-text + references to these attributes should be marked using the :member: role. + + +.. warning:: + + The :mod:`pyexpat` module is not secure against maliciously + constructed data. If you need to parse untrusted or unauthenticated data see + :ref:`xml-vulnerabilities`. + + +.. index:: single: Expat + +The :mod:`xml.parsers.expat` module is a Python interface to the Expat +non-validating XML parser. The module provides a single extension type, +:class:`xmlparser`, that represents the current state of an XML parser. After +an :class:`xmlparser` object has been created, various attributes of the object +can be set to handler functions. When an XML document is then fed to the +parser, the handler functions are called for the character data and markup in +the XML document. + +.. index:: module: pyexpat + +This module uses the :mod:`pyexpat` module to provide access to the Expat +parser. Direct use of the :mod:`pyexpat` module is deprecated. + +This module provides one exception and one type object: + + +.. exception:: ExpatError + + The exception raised when Expat reports an error. See section + :ref:`expaterror-objects` for more information on interpreting Expat errors. + + +.. exception:: error + + Alias for :exc:`ExpatError`. + + +.. data:: XMLParserType + + The type of the return values from the :func:`ParserCreate` function. + +The :mod:`xml.parsers.expat` module contains two functions: + + +.. function:: ErrorString(errno) + + Returns an explanatory string for a given error number *errno*. + + +.. function:: ParserCreate(encoding=None, namespace_separator=None) + + Creates and returns a new :class:`xmlparser` object. *encoding*, if specified, + must be a string naming the encoding used by the XML data. Expat doesn't + support as many encodings as Python does, and its repertoire of encodings can't + be extended; it supports UTF-8, UTF-16, ISO-8859-1 (Latin1), and ASCII. If + *encoding* [1]_ is given it will override the implicit or explicit encoding of the + document. + + Expat can optionally do XML namespace processing for you, enabled by providing a + value for *namespace_separator*. The value must be a one-character string; a + :exc:`ValueError` will be raised if the string has an illegal length (``None`` + is considered the same as omission). When namespace processing is enabled, + element type names and attribute names that belong to a namespace will be + expanded. The element name passed to the element handlers + :attr:`StartElementHandler` and :attr:`EndElementHandler` will be the + concatenation of the namespace URI, the namespace separator character, and the + local part of the name. If the namespace separator is a zero byte (``chr(0)``) + then the namespace URI and the local part will be concatenated without any + separator. + + For example, if *namespace_separator* is set to a space character (``' '``) and + the following document is parsed: + + .. code-block:: xml + + + + + + + + :attr:`StartElementHandler` will receive the following strings for each + element:: + + http://default-namespace.org/ root + http://www.python.org/ns/ elem1 + elem2 + + Due to limitations in the ``Expat`` library used by :mod:`pyexpat`, + the :class:`xmlparser` instance returned can only be used to parse a single + XML document. Call ``ParserCreate`` for each document to provide unique + parser instances. + + +.. seealso:: + + `The Expat XML Parser `_ + Home page of the Expat project. + + +.. _xmlparser-objects: + +XMLParser Objects +----------------- + +:class:`xmlparser` objects have the following methods: + + +.. method:: xmlparser.Parse(data[, isfinal]) + + Parses the contents of the string *data*, calling the appropriate handler + functions to process the parsed data. *isfinal* must be true on the final call + to this method; it allows the parsing of a single file in fragments, + not the submission of multiple files. + *data* can be the empty string at any time. + + +.. method:: xmlparser.ParseFile(file) + + Parse XML data reading from the object *file*. *file* only needs to provide + the ``read(nbytes)`` method, returning the empty string when there's no more + data. + + +.. method:: xmlparser.SetBase(base) + + Sets the base to be used for resolving relative URIs in system identifiers in + declarations. Resolving relative identifiers is left to the application: this + value will be passed through as the *base* argument to the + :func:`ExternalEntityRefHandler`, :func:`NotationDeclHandler`, and + :func:`UnparsedEntityDeclHandler` functions. + + +.. method:: xmlparser.GetBase() + + Returns a string containing the base set by a previous call to :meth:`SetBase`, + or ``None`` if :meth:`SetBase` hasn't been called. + + +.. method:: xmlparser.GetInputContext() + + Returns the input data that generated the current event as a string. The data is + in the encoding of the entity which contains the text. When called while an + event handler is not active, the return value is ``None``. + + +.. method:: xmlparser.ExternalEntityParserCreate(context[, encoding]) + + Create a "child" parser which can be used to parse an external parsed entity + referred to by content parsed by the parent parser. The *context* parameter + should be the string passed to the :meth:`ExternalEntityRefHandler` handler + function, described below. The child parser is created with the + :attr:`ordered_attributes` and :attr:`specified_attributes` set to the values of + this parser. + +.. method:: xmlparser.SetParamEntityParsing(flag) + + Control parsing of parameter entities (including the external DTD subset). + Possible *flag* values are :const:`XML_PARAM_ENTITY_PARSING_NEVER`, + :const:`XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE` and + :const:`XML_PARAM_ENTITY_PARSING_ALWAYS`. Return true if setting the flag + was successful. + +.. method:: xmlparser.UseForeignDTD([flag]) + + Calling this with a true value for *flag* (the default) will cause Expat to call + the :attr:`ExternalEntityRefHandler` with :const:`None` for all arguments to + allow an alternate DTD to be loaded. If the document does not contain a + document type declaration, the :attr:`ExternalEntityRefHandler` will still be + called, but the :attr:`StartDoctypeDeclHandler` and + :attr:`EndDoctypeDeclHandler` will not be called. + + Passing a false value for *flag* will cancel a previous call that passed a true + value, but otherwise has no effect. + + This method can only be called before the :meth:`Parse` or :meth:`ParseFile` + methods are called; calling it after either of those have been called causes + :exc:`ExpatError` to be raised with the :attr:`code` attribute set to + ``errors.codes[errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING]``. + +:class:`xmlparser` objects have the following attributes: + + +.. attribute:: xmlparser.buffer_size + + The size of the buffer used when :attr:`buffer_text` is true. + A new buffer size can be set by assigning a new integer value + to this attribute. + When the size is changed, the buffer will be flushed. + + +.. attribute:: xmlparser.buffer_text + + Setting this to true causes the :class:`xmlparser` object to buffer textual + content returned by Expat to avoid multiple calls to the + :meth:`CharacterDataHandler` callback whenever possible. This can improve + performance substantially since Expat normally breaks character data into chunks + at every line ending. This attribute is false by default, and may be changed at + any time. + + +.. attribute:: xmlparser.buffer_used + + If :attr:`buffer_text` is enabled, the number of bytes stored in the buffer. + These bytes represent UTF-8 encoded text. This attribute has no meaningful + interpretation when :attr:`buffer_text` is false. + + +.. attribute:: xmlparser.ordered_attributes + + Setting this attribute to a non-zero integer causes the attributes to be + reported as a list rather than a dictionary. The attributes are presented in + the order found in the document text. For each attribute, two list entries are + presented: the attribute name and the attribute value. (Older versions of this + module also used this format.) By default, this attribute is false; it may be + changed at any time. + + +.. attribute:: xmlparser.specified_attributes + + If set to a non-zero integer, the parser will report only those attributes which + were specified in the document instance and not those which were derived from + attribute declarations. Applications which set this need to be especially + careful to use what additional information is available from the declarations as + needed to comply with the standards for the behavior of XML processors. By + default, this attribute is false; it may be changed at any time. + + +The following attributes contain values relating to the most recent error +encountered by an :class:`xmlparser` object, and will only have correct values +once a call to :meth:`Parse` or :meth:`ParseFile` has raised an +:exc:`xml.parsers.expat.ExpatError` exception. + + +.. attribute:: xmlparser.ErrorByteIndex + + Byte index at which an error occurred. + + +.. attribute:: xmlparser.ErrorCode + + Numeric code specifying the problem. This value can be passed to the + :func:`ErrorString` function, or compared to one of the constants defined in the + ``errors`` object. + + +.. attribute:: xmlparser.ErrorColumnNumber + + Column number at which an error occurred. + + +.. attribute:: xmlparser.ErrorLineNumber + + Line number at which an error occurred. + +The following attributes contain values relating to the current parse location +in an :class:`xmlparser` object. During a callback reporting a parse event they +indicate the location of the first of the sequence of characters that generated +the event. When called outside of a callback, the position indicated will be +just past the last parse event (regardless of whether there was an associated +callback). + + +.. attribute:: xmlparser.CurrentByteIndex + + Current byte index in the parser input. + + +.. attribute:: xmlparser.CurrentColumnNumber + + Current column number in the parser input. + + +.. attribute:: xmlparser.CurrentLineNumber + + Current line number in the parser input. + +Here is the list of handlers that can be set. To set a handler on an +:class:`xmlparser` object *o*, use ``o.handlername = func``. *handlername* must +be taken from the following list, and *func* must be a callable object accepting +the correct number of arguments. The arguments are all strings, unless +otherwise stated. + + +.. method:: xmlparser.XmlDeclHandler(version, encoding, standalone) + + Called when the XML declaration is parsed. The XML declaration is the + (optional) declaration of the applicable version of the XML recommendation, the + encoding of the document text, and an optional "standalone" declaration. + *version* and *encoding* will be strings, and *standalone* will be ``1`` if the + document is declared standalone, ``0`` if it is declared not to be standalone, + or ``-1`` if the standalone clause was omitted. This is only available with + Expat version 1.95.0 or newer. + + +.. method:: xmlparser.StartDoctypeDeclHandler(doctypeName, systemId, publicId, has_internal_subset) + + Called when Expat begins parsing the document type declaration (``'``. + + +.. method:: xmlparser.StartCdataSectionHandler() + + Called at the start of a CDATA section. This and :attr:`EndCdataSectionHandler` + are needed to be able to identify the syntactical start and end for CDATA + sections. + + +.. method:: xmlparser.EndCdataSectionHandler() + + Called at the end of a CDATA section. + + +.. method:: xmlparser.DefaultHandler(data) + + Called for any characters in the XML document for which no applicable handler + has been specified. This means characters that are part of a construct which + could be reported, but for which no handler has been supplied. + + +.. method:: xmlparser.DefaultHandlerExpand(data) + + This is the same as the :func:`DefaultHandler`, but doesn't inhibit expansion + of internal entities. The entity reference will not be passed to the default + handler. + + +.. method:: xmlparser.NotStandaloneHandler() + + Called if the XML document hasn't been declared as being a standalone document. + This happens when there is an external subset or a reference to a parameter + entity, but the XML declaration does not set standalone to ``yes`` in an XML + declaration. If this handler returns ``0``, then the parser will raise an + :const:`XML_ERROR_NOT_STANDALONE` error. If this handler is not set, no + exception is raised by the parser for this condition. + + +.. method:: xmlparser.ExternalEntityRefHandler(context, base, systemId, publicId) + + Called for references to external entities. *base* is the current base, as set + by a previous call to :meth:`SetBase`. The public and system identifiers, + *systemId* and *publicId*, are strings if given; if the public identifier is not + given, *publicId* will be ``None``. The *context* value is opaque and should + only be used as described below. + + For external entities to be parsed, this handler must be implemented. It is + responsible for creating the sub-parser using + ``ExternalEntityParserCreate(context)``, initializing it with the appropriate + callbacks, and parsing the entity. This handler should return an integer; if it + returns ``0``, the parser will raise an + :const:`XML_ERROR_EXTERNAL_ENTITY_HANDLING` error, otherwise parsing will + continue. + + If this handler is not provided, external entities are reported by the + :attr:`DefaultHandler` callback, if provided. + + +.. _expaterror-objects: + +ExpatError Exceptions +--------------------- + +.. sectionauthor:: Fred L. Drake, Jr. + + +:exc:`ExpatError` exceptions have a number of interesting attributes: + + +.. attribute:: ExpatError.code + + Expat's internal error number for the specific error. The + :data:`errors.messages ` dictionary maps + these error numbers to Expat's error messages. For example:: + + from xml.parsers.expat import ParserCreate, ExpatError, errors + + p = ParserCreate() + try: + p.Parse(some_xml_document) + except ExpatError as err: + print("Error:", errors.messages[err.code]) + + The :mod:`~xml.parsers.expat.errors` module also provides error message + constants and a dictionary :data:`~xml.parsers.expat.errors.codes` mapping + these messages back to the error codes, see below. + + +.. attribute:: ExpatError.lineno + + Line number on which the error was detected. The first line is numbered ``1``. + + +.. attribute:: ExpatError.offset + + Character offset into the line where the error occurred. The first column is + numbered ``0``. + + +.. _expat-example: + +Example +------- + +The following program defines three handlers that just print out their +arguments. :: + + import xml.parsers.expat + + # 3 handler functions + def start_element(name, attrs): + print('Start element:', name, attrs) + def end_element(name): + print('End element:', name) + def char_data(data): + print('Character data:', repr(data)) + + p = xml.parsers.expat.ParserCreate() + + p.StartElementHandler = start_element + p.EndElementHandler = end_element + p.CharacterDataHandler = char_data + + p.Parse(""" + Text goes here + More text + """, 1) + +The output from this program is:: + + Start element: parent {'id': 'top'} + Start element: child1 {'name': 'paul'} + Character data: 'Text goes here' + End element: child1 + Character data: '\n' + Start element: child2 {'name': 'fred'} + Character data: 'More text' + End element: child2 + Character data: '\n' + End element: parent + + +.. _expat-content-models: + +Content Model Descriptions +-------------------------- + +.. module:: xml.parsers.expat.model + +.. sectionauthor:: Fred L. Drake, Jr. + +Content models are described using nested tuples. Each tuple contains four +values: the type, the quantifier, the name, and a tuple of children. Children +are simply additional content model descriptions. + +The values of the first two fields are constants defined in the +:mod:`xml.parsers.expat.model` module. These constants can be collected in two +groups: the model type group and the quantifier group. + +The constants in the model type group are: + + +.. data:: XML_CTYPE_ANY + :noindex: + + The element named by the model name was declared to have a content model of + ``ANY``. + + +.. data:: XML_CTYPE_CHOICE + :noindex: + + The named element allows a choice from a number of options; this is used for + content models such as ``(A | B | C)``. + + +.. data:: XML_CTYPE_EMPTY + :noindex: + + Elements which are declared to be ``EMPTY`` have this model type. + + +.. data:: XML_CTYPE_MIXED + :noindex: + + +.. data:: XML_CTYPE_NAME + :noindex: + + +.. data:: XML_CTYPE_SEQ + :noindex: + + Models which represent a series of models which follow one after the other are + indicated with this model type. This is used for models such as ``(A, B, C)``. + +The constants in the quantifier group are: + + +.. data:: XML_CQUANT_NONE + :noindex: + + No modifier is given, so it can appear exactly once, as for ``A``. + + +.. data:: XML_CQUANT_OPT + :noindex: + + The model is optional: it can appear once or not at all, as for ``A?``. + + +.. data:: XML_CQUANT_PLUS + :noindex: + + The model must occur one or more times (like ``A+``). + + +.. data:: XML_CQUANT_REP + :noindex: + + The model must occur zero or more times, as for ``A*``. + + +.. _expat-errors: + +Expat error constants +--------------------- + +.. module:: xml.parsers.expat.errors + +The following constants are provided in the :mod:`xml.parsers.expat.errors` +module. These constants are useful in interpreting some of the attributes of +the :exc:`ExpatError` exception objects raised when an error has occurred. +Since for backwards compatibility reasons, the constants' value is the error +*message* and not the numeric error *code*, you do this by comparing its +:attr:`code` attribute with +:samp:`errors.codes[errors.XML_ERROR_{CONSTANT_NAME}]`. + +The ``errors`` module has the following attributes: + +.. data:: codes + + A dictionary mapping numeric error codes to their string descriptions. + + .. versionadded:: 3.2 + + +.. data:: messages + + A dictionary mapping string descriptions to their error codes. + + .. versionadded:: 3.2 + + +.. data:: XML_ERROR_ASYNC_ENTITY + + +.. data:: XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF + + An entity reference in an attribute value referred to an external entity instead + of an internal entity. + + +.. data:: XML_ERROR_BAD_CHAR_REF + + A character reference referred to a character which is illegal in XML (for + example, character ``0``, or '``�``'). + + +.. data:: XML_ERROR_BINARY_ENTITY_REF + + An entity reference referred to an entity which was declared with a notation, so + cannot be parsed. + + +.. data:: XML_ERROR_DUPLICATE_ATTRIBUTE + + An attribute was used more than once in a start tag. + + +.. data:: XML_ERROR_INCORRECT_ENCODING + + +.. data:: XML_ERROR_INVALID_TOKEN + + Raised when an input byte could not properly be assigned to a character; for + example, a NUL byte (value ``0``) in a UTF-8 input stream. + + +.. data:: XML_ERROR_JUNK_AFTER_DOC_ELEMENT + + Something other than whitespace occurred after the document element. + + +.. data:: XML_ERROR_MISPLACED_XML_PI + + An XML declaration was found somewhere other than the start of the input data. + + +.. data:: XML_ERROR_NO_ELEMENTS + + The document contains no elements (XML requires all documents to contain exactly + one top-level element).. + + +.. data:: XML_ERROR_NO_MEMORY + + Expat was not able to allocate memory internally. + + +.. data:: XML_ERROR_PARAM_ENTITY_REF + + A parameter entity reference was found where it was not allowed. + + +.. data:: XML_ERROR_PARTIAL_CHAR + + An incomplete character was found in the input. + + +.. data:: XML_ERROR_RECURSIVE_ENTITY_REF + + An entity reference contained another reference to the same entity; possibly via + a different name, and possibly indirectly. + + +.. data:: XML_ERROR_SYNTAX + + Some unspecified syntax error was encountered. + + +.. data:: XML_ERROR_TAG_MISMATCH + + An end tag did not match the innermost open start tag. + + +.. data:: XML_ERROR_UNCLOSED_TOKEN + + Some token (such as a start tag) was not closed before the end of the stream or + the next token was encountered. + + +.. data:: XML_ERROR_UNDEFINED_ENTITY + + A reference was made to an entity which was not defined. + + +.. data:: XML_ERROR_UNKNOWN_ENCODING + + The document encoding is not supported by Expat. + + +.. data:: XML_ERROR_UNCLOSED_CDATA_SECTION + + A CDATA marked section was not closed. + + +.. data:: XML_ERROR_EXTERNAL_ENTITY_HANDLING + + +.. data:: XML_ERROR_NOT_STANDALONE + + The parser determined that the document was not "standalone" though it declared + itself to be in the XML declaration, and the :attr:`NotStandaloneHandler` was + set and returned ``0``. + + +.. data:: XML_ERROR_UNEXPECTED_STATE + + +.. data:: XML_ERROR_ENTITY_DECLARED_IN_PE + + +.. data:: XML_ERROR_FEATURE_REQUIRES_XML_DTD + + An operation was requested that requires DTD support to be compiled in, but + Expat was configured without DTD support. This should never be reported by a + standard build of the :mod:`xml.parsers.expat` module. + + +.. data:: XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING + + A behavioral change was requested after parsing started that can only be changed + before parsing has started. This is (currently) only raised by + :meth:`UseForeignDTD`. + + +.. data:: XML_ERROR_UNBOUND_PREFIX + + An undeclared prefix was found when namespace processing was enabled. + + +.. data:: XML_ERROR_UNDECLARING_PREFIX + + The document attempted to remove the namespace declaration associated with a + prefix. + + +.. data:: XML_ERROR_INCOMPLETE_PE + + A parameter entity contained incomplete markup. + + +.. data:: XML_ERROR_XML_DECL + + The document contained no document element at all. + + +.. data:: XML_ERROR_TEXT_DECL + + There was an error parsing a text declaration in an external entity. + + +.. data:: XML_ERROR_PUBLICID + + Characters were found in the public id that are not allowed. + + +.. data:: XML_ERROR_SUSPENDED + + The requested operation was made on a suspended parser, but isn't allowed. This + includes attempts to provide additional input or to stop the parser. + + +.. data:: XML_ERROR_NOT_SUSPENDED + + An attempt to resume the parser was made when the parser had not been suspended. + + +.. data:: XML_ERROR_ABORTED + + This should not be reported to Python applications. + + +.. data:: XML_ERROR_FINISHED + + The requested operation was made on a parser which was finished parsing input, + but isn't allowed. This includes attempts to provide additional input or to + stop the parser. + + +.. data:: XML_ERROR_SUSPEND_PE + + +.. rubric:: Footnotes + +.. [1] The encoding string included in XML output should conform to the + appropriate standards. For example, "UTF-8" is valid, but "UTF8" is + not. See https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl + and https://www.iana.org/assignments/character-sets/character-sets.xhtml. + diff --git a/python-3.7.4-docs-html/_sources/library/python.rst.txt b/python-3.7.4-docs-html/_sources/library/python.rst.txt new file mode 100644 index 0000000..f39613f --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/python.rst.txt @@ -0,0 +1,27 @@ +.. _python: + +*********************** +Python Runtime Services +*********************** + +The modules described in this chapter provide a wide range of services related +to the Python interpreter and its interaction with its environment. Here's an +overview: + + +.. toctree:: + + sys.rst + sysconfig.rst + builtins.rst + __main__.rst + warnings.rst + dataclasses.rst + contextlib.rst + abc.rst + atexit.rst + traceback.rst + __future__.rst + gc.rst + inspect.rst + site.rst diff --git a/python-3.7.4-docs-html/_sources/library/queue.rst.txt b/python-3.7.4-docs-html/_sources/library/queue.rst.txt new file mode 100644 index 0000000..0a42da1 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/queue.rst.txt @@ -0,0 +1,285 @@ +:mod:`queue` --- A synchronized queue class +=========================================== + +.. module:: queue + :synopsis: A synchronized queue class. + +**Source code:** :source:`Lib/queue.py` + +-------------- + +The :mod:`queue` module implements multi-producer, multi-consumer queues. +It is especially useful in threaded programming when information must be +exchanged safely between multiple threads. The :class:`Queue` class in this +module implements all the required locking semantics. It depends on the +availability of thread support in Python; see the :mod:`threading` +module. + +The module implements three types of queue, which differ only in the order in +which the entries are retrieved. In a :abbr:`FIFO (first-in, first-out)` +queue, the first tasks added are the first retrieved. In a +:abbr:`LIFO (last-in, first-out)` queue, the most recently added entry is +the first retrieved (operating like a stack). With a priority queue, +the entries are kept sorted (using the :mod:`heapq` module) and the +lowest valued entry is retrieved first. + +Internally, those three types of queues use locks to temporarily block +competing threads; however, they are not designed to handle reentrancy +within a thread. + +In addition, the module implements a "simple" +:abbr:`FIFO (first-in, first-out)` queue type, :class:`SimpleQueue`, whose +specific implementation provides additional guarantees +in exchange for the smaller functionality. + +The :mod:`queue` module defines the following classes and exceptions: + +.. class:: Queue(maxsize=0) + + Constructor for a :abbr:`FIFO (first-in, first-out)` queue. *maxsize* is + an integer that sets the upperbound + limit on the number of items that can be placed in the queue. Insertion will + block once this size has been reached, until queue items are consumed. If + *maxsize* is less than or equal to zero, the queue size is infinite. + +.. class:: LifoQueue(maxsize=0) + + Constructor for a :abbr:`LIFO (last-in, first-out)` queue. *maxsize* is + an integer that sets the upperbound + limit on the number of items that can be placed in the queue. Insertion will + block once this size has been reached, until queue items are consumed. If + *maxsize* is less than or equal to zero, the queue size is infinite. + + +.. class:: PriorityQueue(maxsize=0) + + Constructor for a priority queue. *maxsize* is an integer that sets the upperbound + limit on the number of items that can be placed in the queue. Insertion will + block once this size has been reached, until queue items are consumed. If + *maxsize* is less than or equal to zero, the queue size is infinite. + + The lowest valued entries are retrieved first (the lowest valued entry is the + one returned by ``sorted(list(entries))[0]``). A typical pattern for entries + is a tuple in the form: ``(priority_number, data)``. + + If the *data* elements are not comparable, the data can be wrapped in a class + that ignores the data item and only compares the priority number:: + + from dataclasses import dataclass, field + from typing import Any + + @dataclass(order=True) + class PrioritizedItem: + priority: int + item: Any=field(compare=False) + +.. class:: SimpleQueue() + + Constructor for an unbounded :abbr:`FIFO (first-in, first-out)` queue. + Simple queues lack advanced functionality such as task tracking. + + .. versionadded:: 3.7 + + +.. exception:: Empty + + Exception raised when non-blocking :meth:`~Queue.get` (or + :meth:`~Queue.get_nowait`) is called + on a :class:`Queue` object which is empty. + + +.. exception:: Full + + Exception raised when non-blocking :meth:`~Queue.put` (or + :meth:`~Queue.put_nowait`) is called + on a :class:`Queue` object which is full. + + +.. _queueobjects: + +Queue Objects +------------- + +Queue objects (:class:`Queue`, :class:`LifoQueue`, or :class:`PriorityQueue`) +provide the public methods described below. + + +.. method:: Queue.qsize() + + Return the approximate size of the queue. Note, qsize() > 0 doesn't + guarantee that a subsequent get() will not block, nor will qsize() < maxsize + guarantee that put() will not block. + + +.. method:: Queue.empty() + + Return ``True`` if the queue is empty, ``False`` otherwise. If empty() + returns ``True`` it doesn't guarantee that a subsequent call to put() + will not block. Similarly, if empty() returns ``False`` it doesn't + guarantee that a subsequent call to get() will not block. + + +.. method:: Queue.full() + + Return ``True`` if the queue is full, ``False`` otherwise. If full() + returns ``True`` it doesn't guarantee that a subsequent call to get() + will not block. Similarly, if full() returns ``False`` it doesn't + guarantee that a subsequent call to put() will not block. + + +.. method:: Queue.put(item, block=True, timeout=None) + + Put *item* into the queue. If optional args *block* is true and *timeout* is + ``None`` (the default), block if necessary until a free slot is available. If + *timeout* is a positive number, it blocks at most *timeout* seconds and raises + the :exc:`Full` exception if no free slot was available within that time. + Otherwise (*block* is false), put an item on the queue if a free slot is + immediately available, else raise the :exc:`Full` exception (*timeout* is + ignored in that case). + + +.. method:: Queue.put_nowait(item) + + Equivalent to ``put(item, False)``. + + +.. method:: Queue.get(block=True, timeout=None) + + Remove and return an item from the queue. If optional args *block* is true and + *timeout* is ``None`` (the default), block if necessary until an item is available. + If *timeout* is a positive number, it blocks at most *timeout* seconds and + raises the :exc:`Empty` exception if no item was available within that time. + Otherwise (*block* is false), return an item if one is immediately available, + else raise the :exc:`Empty` exception (*timeout* is ignored in that case). + + Prior to 3.0 on POSIX systems, and for all versions on Windows, if + *block* is true and *timeout* is ``None``, this operation goes into + an uninterruptible wait on an underlying lock. This means that no exceptions + can occur, and in particular a SIGINT will not trigger a :exc:`KeyboardInterrupt`. + + +.. method:: Queue.get_nowait() + + Equivalent to ``get(False)``. + +Two methods are offered to support tracking whether enqueued tasks have been +fully processed by daemon consumer threads. + + +.. method:: Queue.task_done() + + Indicate that a formerly enqueued task is complete. Used by queue consumer + threads. For each :meth:`get` used to fetch a task, a subsequent call to + :meth:`task_done` tells the queue that the processing on the task is complete. + + If a :meth:`join` is currently blocking, it will resume when all items have been + processed (meaning that a :meth:`task_done` call was received for every item + that had been :meth:`put` into the queue). + + Raises a :exc:`ValueError` if called more times than there were items placed in + the queue. + + +.. method:: Queue.join() + + Blocks until all items in the queue have been gotten and processed. + + The count of unfinished tasks goes up whenever an item is added to the queue. + The count goes down whenever a consumer thread calls :meth:`task_done` to + indicate that the item was retrieved and all work on it is complete. When the + count of unfinished tasks drops to zero, :meth:`join` unblocks. + + +Example of how to wait for enqueued tasks to be completed:: + + def worker(): + while True: + item = q.get() + if item is None: + break + do_work(item) + q.task_done() + + q = queue.Queue() + threads = [] + for i in range(num_worker_threads): + t = threading.Thread(target=worker) + t.start() + threads.append(t) + + for item in source(): + q.put(item) + + # block until all tasks are done + q.join() + + # stop workers + for i in range(num_worker_threads): + q.put(None) + for t in threads: + t.join() + + +SimpleQueue Objects +------------------- + +:class:`SimpleQueue` objects provide the public methods described below. + +.. method:: SimpleQueue.qsize() + + Return the approximate size of the queue. Note, qsize() > 0 doesn't + guarantee that a subsequent get() will not block. + + +.. method:: SimpleQueue.empty() + + Return ``True`` if the queue is empty, ``False`` otherwise. If empty() + returns ``False`` it doesn't guarantee that a subsequent call to get() + will not block. + + +.. method:: SimpleQueue.put(item, block=True, timeout=None) + + Put *item* into the queue. The method never blocks and always succeeds + (except for potential low-level errors such as failure to allocate memory). + The optional args *block* and *timeout* are ignored and only provided + for compatibility with :meth:`Queue.put`. + + .. impl-detail:: + This method has a C implementation which is reentrant. That is, a + ``put()`` or ``get()`` call can be interrupted by another ``put()`` + call in the same thread without deadlocking or corrupting internal + state inside the queue. This makes it appropriate for use in + destructors such as ``__del__`` methods or :mod:`weakref` callbacks. + + +.. method:: SimpleQueue.put_nowait(item) + + Equivalent to ``put(item)``, provided for compatibility with + :meth:`Queue.put_nowait`. + + +.. method:: SimpleQueue.get(block=True, timeout=None) + + Remove and return an item from the queue. If optional args *block* is true and + *timeout* is ``None`` (the default), block if necessary until an item is available. + If *timeout* is a positive number, it blocks at most *timeout* seconds and + raises the :exc:`Empty` exception if no item was available within that time. + Otherwise (*block* is false), return an item if one is immediately available, + else raise the :exc:`Empty` exception (*timeout* is ignored in that case). + + +.. method:: SimpleQueue.get_nowait() + + Equivalent to ``get(False)``. + + +.. seealso:: + + Class :class:`multiprocessing.Queue` + A queue class for use in a multi-processing (rather than multi-threading) + context. + + :class:`collections.deque` is an alternative implementation of unbounded + queues with fast atomic :meth:`~collections.deque.append` and + :meth:`~collections.deque.popleft` operations that do not require locking. diff --git a/python-3.7.4-docs-html/_sources/library/quopri.rst.txt b/python-3.7.4-docs-html/_sources/library/quopri.rst.txt new file mode 100644 index 0000000..86717c0 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/quopri.rst.txt @@ -0,0 +1,63 @@ +:mod:`quopri` --- Encode and decode MIME quoted-printable data +============================================================== + +.. module:: quopri + :synopsis: Encode and decode files using the MIME quoted-printable encoding. + +**Source code:** :source:`Lib/quopri.py` + +.. index:: + pair: quoted-printable; encoding + single: MIME; quoted-printable encoding + +-------------- + +This module performs quoted-printable transport encoding and decoding, as +defined in :rfc:`1521`: "MIME (Multipurpose Internet Mail Extensions) Part One: +Mechanisms for Specifying and Describing the Format of Internet Message Bodies". +The quoted-printable encoding is designed for data where there are relatively +few nonprintable characters; the base64 encoding scheme available via the +:mod:`base64` module is more compact if there are many such characters, as when +sending a graphics file. + +.. function:: decode(input, output, header=False) + + Decode the contents of the *input* file and write the resulting decoded binary + data to the *output* file. *input* and *output* must be :term:`binary file objects + `. If the optional argument *header* is present and true, underscore + will be decoded as space. This is used to decode "Q"-encoded headers as + described in :rfc:`1522`: "MIME (Multipurpose Internet Mail Extensions) + Part Two: Message Header Extensions for Non-ASCII Text". + + +.. function:: encode(input, output, quotetabs, header=False) + + Encode the contents of the *input* file and write the resulting quoted-printable + data to the *output* file. *input* and *output* must be + :term:`binary file objects `. *quotetabs*, a + non-optional flag which controls whether to encode embedded spaces + and tabs; when true it encodes such embedded whitespace, and when + false it leaves them unencoded. + Note that spaces and tabs appearing at the end of lines are always encoded, + as per :rfc:`1521`. *header* is a flag which controls if spaces are encoded + as underscores as per :rfc:`1522`. + + +.. function:: decodestring(s, header=False) + + Like :func:`decode`, except that it accepts a source :class:`bytes` and + returns the corresponding decoded :class:`bytes`. + + +.. function:: encodestring(s, quotetabs=False, header=False) + + Like :func:`encode`, except that it accepts a source :class:`bytes` and + returns the corresponding encoded :class:`bytes`. By default, it sends a + ``False`` value to *quotetabs* parameter of the :func:`encode` function. + + + +.. seealso:: + + Module :mod:`base64` + Encode and decode MIME base64 data diff --git a/python-3.7.4-docs-html/_sources/library/random.rst.txt b/python-3.7.4-docs-html/_sources/library/random.rst.txt new file mode 100644 index 0000000..42979ff --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/random.rst.txt @@ -0,0 +1,495 @@ +:mod:`random` --- Generate pseudo-random numbers +================================================ + +.. module:: random + :synopsis: Generate pseudo-random numbers with various common distributions. + +**Source code:** :source:`Lib/random.py` + +-------------- + +This module implements pseudo-random number generators for various +distributions. + +For integers, there is uniform selection from a range. For sequences, there is +uniform selection of a random element, a function to generate a random +permutation of a list in-place, and a function for random sampling without +replacement. + +On the real line, there are functions to compute uniform, normal (Gaussian), +lognormal, negative exponential, gamma, and beta distributions. For generating +distributions of angles, the von Mises distribution is available. + +Almost all module functions depend on the basic function :func:`.random`, which +generates a random float uniformly in the semi-open range [0.0, 1.0). Python +uses the Mersenne Twister as the core generator. It produces 53-bit precision +floats and has a period of 2\*\*19937-1. The underlying implementation in C is +both fast and threadsafe. The Mersenne Twister is one of the most extensively +tested random number generators in existence. However, being completely +deterministic, it is not suitable for all purposes, and is completely unsuitable +for cryptographic purposes. + +The functions supplied by this module are actually bound methods of a hidden +instance of the :class:`random.Random` class. You can instantiate your own +instances of :class:`Random` to get generators that don't share state. + +Class :class:`Random` can also be subclassed if you want to use a different +basic generator of your own devising: in that case, override the :meth:`~Random.random`, +:meth:`~Random.seed`, :meth:`~Random.getstate`, and :meth:`~Random.setstate` methods. +Optionally, a new generator can supply a :meth:`~Random.getrandbits` method --- this +allows :meth:`randrange` to produce selections over an arbitrarily large range. + +The :mod:`random` module also provides the :class:`SystemRandom` class which +uses the system function :func:`os.urandom` to generate random numbers +from sources provided by the operating system. + +.. warning:: + + The pseudo-random generators of this module should not be used for + security purposes. For security or cryptographic uses, see the + :mod:`secrets` module. + +.. seealso:: + + M. Matsumoto and T. Nishimura, "Mersenne Twister: A 623-dimensionally + equidistributed uniform pseudorandom number generator", ACM Transactions on + Modeling and Computer Simulation Vol. 8, No. 1, January pp.3--30 1998. + + + `Complementary-Multiply-with-Carry recipe + `_ for a compatible alternative + random number generator with a long period and comparatively simple update + operations. + + +Bookkeeping functions +--------------------- + +.. function:: seed(a=None, version=2) + + Initialize the random number generator. + + If *a* is omitted or ``None``, the current system time is used. If + randomness sources are provided by the operating system, they are used + instead of the system time (see the :func:`os.urandom` function for details + on availability). + + If *a* is an int, it is used directly. + + With version 2 (the default), a :class:`str`, :class:`bytes`, or :class:`bytearray` + object gets converted to an :class:`int` and all of its bits are used. + + With version 1 (provided for reproducing random sequences from older versions + of Python), the algorithm for :class:`str` and :class:`bytes` generates a + narrower range of seeds. + + .. versionchanged:: 3.2 + Moved to the version 2 scheme which uses all of the bits in a string seed. + +.. function:: getstate() + + Return an object capturing the current internal state of the generator. This + object can be passed to :func:`setstate` to restore the state. + + +.. function:: setstate(state) + + *state* should have been obtained from a previous call to :func:`getstate`, and + :func:`setstate` restores the internal state of the generator to what it was at + the time :func:`getstate` was called. + + +.. function:: getrandbits(k) + + Returns a Python integer with *k* random bits. This method is supplied with + the MersenneTwister generator and some other generators may also provide it + as an optional part of the API. When available, :meth:`getrandbits` enables + :meth:`randrange` to handle arbitrarily large ranges. + + +Functions for integers +---------------------- + +.. function:: randrange(stop) + randrange(start, stop[, step]) + + Return a randomly selected element from ``range(start, stop, step)``. This is + equivalent to ``choice(range(start, stop, step))``, but doesn't actually build a + range object. + + The positional argument pattern matches that of :func:`range`. Keyword arguments + should not be used because the function may use them in unexpected ways. + + .. versionchanged:: 3.2 + :meth:`randrange` is more sophisticated about producing equally distributed + values. Formerly it used a style like ``int(random()*n)`` which could produce + slightly uneven distributions. + +.. function:: randint(a, b) + + Return a random integer *N* such that ``a <= N <= b``. Alias for + ``randrange(a, b+1)``. + + +Functions for sequences +----------------------- + +.. function:: choice(seq) + + Return a random element from the non-empty sequence *seq*. If *seq* is empty, + raises :exc:`IndexError`. + +.. function:: choices(population, weights=None, *, cum_weights=None, k=1) + + Return a *k* sized list of elements chosen from the *population* with replacement. + If the *population* is empty, raises :exc:`IndexError`. + + If a *weights* sequence is specified, selections are made according to the + relative weights. Alternatively, if a *cum_weights* sequence is given, the + selections are made according to the cumulative weights (perhaps computed + using :func:`itertools.accumulate`). For example, the relative weights + ``[10, 5, 30, 5]`` are equivalent to the cumulative weights + ``[10, 15, 45, 50]``. Internally, the relative weights are converted to + cumulative weights before making selections, so supplying the cumulative + weights saves work. + + If neither *weights* nor *cum_weights* are specified, selections are made + with equal probability. If a weights sequence is supplied, it must be + the same length as the *population* sequence. It is a :exc:`TypeError` + to specify both *weights* and *cum_weights*. + + The *weights* or *cum_weights* can use any numeric type that interoperates + with the :class:`float` values returned by :func:`random` (that includes + integers, floats, and fractions but excludes decimals). + + For a given seed, the :func:`choices` function with equal weighting + typically produces a different sequence than repeated calls to + :func:`choice`. The algorithm used by :func:`choices` uses floating + point arithmetic for internal consistency and speed. The algorithm used + by :func:`choice` defaults to integer arithmetic with repeated selections + to avoid small biases from round-off error. + + .. versionadded:: 3.6 + + +.. function:: shuffle(x[, random]) + + Shuffle the sequence *x* in place. + + The optional argument *random* is a 0-argument function returning a random + float in [0.0, 1.0); by default, this is the function :func:`.random`. + + To shuffle an immutable sequence and return a new shuffled list, use + ``sample(x, k=len(x))`` instead. + + Note that even for small ``len(x)``, the total number of permutations of *x* + can quickly grow larger than the period of most random number generators. + This implies that most permutations of a long sequence can never be + generated. For example, a sequence of length 2080 is the largest that + can fit within the period of the Mersenne Twister random number generator. + + +.. function:: sample(population, k) + + Return a *k* length list of unique elements chosen from the population sequence + or set. Used for random sampling without replacement. + + Returns a new list containing elements from the population while leaving the + original population unchanged. The resulting list is in selection order so that + all sub-slices will also be valid random samples. This allows raffle winners + (the sample) to be partitioned into grand prize and second place winners (the + subslices). + + Members of the population need not be :term:`hashable` or unique. If the population + contains repeats, then each occurrence is a possible selection in the sample. + + To choose a sample from a range of integers, use a :func:`range` object as an + argument. This is especially fast and space efficient for sampling from a large + population: ``sample(range(10000000), k=60)``. + + If the sample size is larger than the population size, a :exc:`ValueError` + is raised. + +Real-valued distributions +------------------------- + +The following functions generate specific real-valued distributions. Function +parameters are named after the corresponding variables in the distribution's +equation, as used in common mathematical practice; most of these equations can +be found in any statistics text. + + +.. function:: random() + + Return the next random floating point number in the range [0.0, 1.0). + + +.. function:: uniform(a, b) + + Return a random floating point number *N* such that ``a <= N <= b`` for + ``a <= b`` and ``b <= N <= a`` for ``b < a``. + + The end-point value ``b`` may or may not be included in the range + depending on floating-point rounding in the equation ``a + (b-a) * random()``. + + +.. function:: triangular(low, high, mode) + + Return a random floating point number *N* such that ``low <= N <= high`` and + with the specified *mode* between those bounds. The *low* and *high* bounds + default to zero and one. The *mode* argument defaults to the midpoint + between the bounds, giving a symmetric distribution. + + +.. function:: betavariate(alpha, beta) + + Beta distribution. Conditions on the parameters are ``alpha > 0`` and + ``beta > 0``. Returned values range between 0 and 1. + + +.. function:: expovariate(lambd) + + Exponential distribution. *lambd* is 1.0 divided by the desired + mean. It should be nonzero. (The parameter would be called + "lambda", but that is a reserved word in Python.) Returned values + range from 0 to positive infinity if *lambd* is positive, and from + negative infinity to 0 if *lambd* is negative. + + +.. function:: gammavariate(alpha, beta) + + Gamma distribution. (*Not* the gamma function!) Conditions on the + parameters are ``alpha > 0`` and ``beta > 0``. + + The probability distribution function is:: + + x ** (alpha - 1) * math.exp(-x / beta) + pdf(x) = -------------------------------------- + math.gamma(alpha) * beta ** alpha + + +.. function:: gauss(mu, sigma) + + Gaussian distribution. *mu* is the mean, and *sigma* is the standard + deviation. This is slightly faster than the :func:`normalvariate` function + defined below. + + +.. function:: lognormvariate(mu, sigma) + + Log normal distribution. If you take the natural logarithm of this + distribution, you'll get a normal distribution with mean *mu* and standard + deviation *sigma*. *mu* can have any value, and *sigma* must be greater than + zero. + + +.. function:: normalvariate(mu, sigma) + + Normal distribution. *mu* is the mean, and *sigma* is the standard deviation. + + +.. function:: vonmisesvariate(mu, kappa) + + *mu* is the mean angle, expressed in radians between 0 and 2\*\ *pi*, and *kappa* + is the concentration parameter, which must be greater than or equal to zero. If + *kappa* is equal to zero, this distribution reduces to a uniform random angle + over the range 0 to 2\*\ *pi*. + + +.. function:: paretovariate(alpha) + + Pareto distribution. *alpha* is the shape parameter. + + +.. function:: weibullvariate(alpha, beta) + + Weibull distribution. *alpha* is the scale parameter and *beta* is the shape + parameter. + + +Alternative Generator +--------------------- + +.. class:: Random([seed]) + + Class that implements the default pseudo-random number generator used by the + :mod:`random` module. + +.. class:: SystemRandom([seed]) + + Class that uses the :func:`os.urandom` function for generating random numbers + from sources provided by the operating system. Not available on all systems. + Does not rely on software state, and sequences are not reproducible. Accordingly, + the :meth:`seed` method has no effect and is ignored. + The :meth:`getstate` and :meth:`setstate` methods raise + :exc:`NotImplementedError` if called. + + +Notes on Reproducibility +------------------------ + +Sometimes it is useful to be able to reproduce the sequences given by a pseudo +random number generator. By re-using a seed value, the same sequence should be +reproducible from run to run as long as multiple threads are not running. + +Most of the random module's algorithms and seeding functions are subject to +change across Python versions, but two aspects are guaranteed not to change: + +* If a new seeding method is added, then a backward compatible seeder will be + offered. + +* The generator's :meth:`~Random.random` method will continue to produce the same + sequence when the compatible seeder is given the same seed. + +.. _random-examples: + +Examples and Recipes +-------------------- + +Basic examples:: + + >>> random() # Random float: 0.0 <= x < 1.0 + 0.37444887175646646 + + >>> uniform(2.5, 10.0) # Random float: 2.5 <= x < 10.0 + 3.1800146073117523 + + >>> expovariate(1 / 5) # Interval between arrivals averaging 5 seconds + 5.148957571865031 + + >>> randrange(10) # Integer from 0 to 9 inclusive + 7 + + >>> randrange(0, 101, 2) # Even integer from 0 to 100 inclusive + 26 + + >>> choice(['win', 'lose', 'draw']) # Single random element from a sequence + 'draw' + + >>> deck = 'ace two three four'.split() + >>> shuffle(deck) # Shuffle a list + >>> deck + ['four', 'two', 'ace', 'three'] + + >>> sample([10, 20, 30, 40, 50], k=4) # Four samples without replacement + [40, 10, 50, 30] + +Simulations:: + + >>> # Six roulette wheel spins (weighted sampling with replacement) + >>> choices(['red', 'black', 'green'], [18, 18, 2], k=6) + ['red', 'green', 'black', 'black', 'red', 'black'] + + >>> # Deal 20 cards without replacement from a deck of 52 playing cards + >>> # and determine the proportion of cards with a ten-value + >>> # (a ten, jack, queen, or king). + >>> deck = collections.Counter(tens=16, low_cards=36) + >>> seen = sample(list(deck.elements()), k=20) + >>> seen.count('tens') / 20 + 0.15 + + >>> # Estimate the probability of getting 5 or more heads from 7 spins + >>> # of a biased coin that settles on heads 60% of the time. + >>> def trial(): + ... return choices('HT', cum_weights=(0.60, 1.00), k=7).count('H') >= 5 + ... + >>> sum(trial() for i in range(10000)) / 10000 + 0.4169 + + >>> # Probability of the median of 5 samples being in middle two quartiles + >>> def trial(): + ... return 2500 <= sorted(choices(range(10000), k=5))[2] < 7500 + ... + >>> sum(trial() for i in range(10000)) / 10000 + 0.7958 + +Example of `statistical bootstrapping +`_ using resampling +with replacement to estimate a confidence interval for the mean of a sample of +size five:: + + # http://statistics.about.com/od/Applications/a/Example-Of-Bootstrapping.htm + from statistics import mean + from random import choices + + data = 1, 2, 4, 4, 10 + means = sorted(mean(choices(data, k=5)) for i in range(20)) + print(f'The sample mean of {mean(data):.1f} has a 90% confidence ' + f'interval from {means[1]:.1f} to {means[-2]:.1f}') + +Example of a `resampling permutation test +`_ +to determine the statistical significance or `p-value +`_ of an observed difference +between the effects of a drug versus a placebo:: + + # Example from "Statistics is Easy" by Dennis Shasha and Manda Wilson + from statistics import mean + from random import shuffle + + drug = [54, 73, 53, 70, 73, 68, 52, 65, 65] + placebo = [54, 51, 58, 44, 55, 52, 42, 47, 58, 46] + observed_diff = mean(drug) - mean(placebo) + + n = 10000 + count = 0 + combined = drug + placebo + for i in range(n): + shuffle(combined) + new_diff = mean(combined[:len(drug)]) - mean(combined[len(drug):]) + count += (new_diff >= observed_diff) + + print(f'{n} label reshufflings produced only {count} instances with a difference') + print(f'at least as extreme as the observed difference of {observed_diff:.1f}.') + print(f'The one-sided p-value of {count / n:.4f} leads us to reject the null') + print(f'hypothesis that there is no difference between the drug and the placebo.') + +Simulation of arrival times and service deliveries in a single server queue:: + + from random import expovariate, gauss + from statistics import mean, median, stdev + + average_arrival_interval = 5.6 + average_service_time = 5.0 + stdev_service_time = 0.5 + + num_waiting = 0 + arrivals = [] + starts = [] + arrival = service_end = 0.0 + for i in range(20000): + if arrival <= service_end: + num_waiting += 1 + arrival += expovariate(1.0 / average_arrival_interval) + arrivals.append(arrival) + else: + num_waiting -= 1 + service_start = service_end if num_waiting else arrival + service_time = gauss(average_service_time, stdev_service_time) + service_end = service_start + service_time + starts.append(service_start) + + waits = [start - arrival for arrival, start in zip(arrivals, starts)] + print(f'Mean wait: {mean(waits):.1f}. Stdev wait: {stdev(waits):.1f}.') + print(f'Median wait: {median(waits):.1f}. Max wait: {max(waits):.1f}.') + +.. seealso:: + + `Statistics for Hackers `_ + a video tutorial by + `Jake Vanderplas `_ + on statistical analysis using just a few fundamental concepts + including simulation, sampling, shuffling, and cross-validation. + + `Economics Simulation + `_ + a simulation of a marketplace by + `Peter Norvig `_ that shows effective + use of many of the tools and distributions provided by this module + (gauss, uniform, sample, betavariate, choice, triangular, and randrange). + + `A Concrete Introduction to Probability (using Python) + `_ + a tutorial by `Peter Norvig `_ covering + the basics of probability theory, how to write simulations, and + how to perform data analysis using Python. diff --git a/python-3.7.4-docs-html/_sources/library/re.rst.txt b/python-3.7.4-docs-html/_sources/library/re.rst.txt new file mode 100644 index 0000000..2e6c7f7 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/re.rst.txt @@ -0,0 +1,1687 @@ +:mod:`re` --- Regular expression operations +=========================================== + +.. module:: re + :synopsis: Regular expression operations. + +.. moduleauthor:: Fredrik Lundh +.. sectionauthor:: Andrew M. Kuchling + +**Source code:** :source:`Lib/re.py` + +-------------- + +This module provides regular expression matching operations similar to +those found in Perl. + +Both patterns and strings to be searched can be Unicode strings (:class:`str`) +as well as 8-bit strings (:class:`bytes`). +However, Unicode strings and 8-bit strings cannot be mixed: +that is, you cannot match a Unicode string with a byte pattern or +vice-versa; similarly, when asking for a substitution, the replacement +string must be of the same type as both the pattern and the search string. + +Regular expressions use the backslash character (``'\'``) to indicate +special forms or to allow special characters to be used without invoking +their special meaning. This collides with Python's usage of the same +character for the same purpose in string literals; for example, to match +a literal backslash, one might have to write ``'\\\\'`` as the pattern +string, because the regular expression must be ``\\``, and each +backslash must be expressed as ``\\`` inside a regular Python string +literal. + +The solution is to use Python's raw string notation for regular expression +patterns; backslashes are not handled in any special way in a string literal +prefixed with ``'r'``. So ``r"\n"`` is a two-character string containing +``'\'`` and ``'n'``, while ``"\n"`` is a one-character string containing a +newline. Usually patterns will be expressed in Python code using this raw +string notation. + +It is important to note that most regular expression operations are available as +module-level functions and methods on +:ref:`compiled regular expressions `. The functions are shortcuts +that don't require you to compile a regex object first, but miss some +fine-tuning parameters. + +.. seealso:: + + The third-party `regex `_ module, + which has an API compatible with the standard library :mod:`re` module, + but offers additional functionality and a more thorough Unicode support. + + +.. _re-syntax: + +Regular Expression Syntax +------------------------- + +A regular expression (or RE) specifies a set of strings that matches it; the +functions in this module let you check if a particular string matches a given +regular expression (or if a given regular expression matches a particular +string, which comes down to the same thing). + +Regular expressions can be concatenated to form new regular expressions; if *A* +and *B* are both regular expressions, then *AB* is also a regular expression. +In general, if a string *p* matches *A* and another string *q* matches *B*, the +string *pq* will match AB. This holds unless *A* or *B* contain low precedence +operations; boundary conditions between *A* and *B*; or have numbered group +references. Thus, complex expressions can easily be constructed from simpler +primitive expressions like the ones described here. For details of the theory +and implementation of regular expressions, consult the Friedl book [Frie09]_, +or almost any textbook about compiler construction. + +A brief explanation of the format of regular expressions follows. For further +information and a gentler presentation, consult the :ref:`regex-howto`. + +Regular expressions can contain both special and ordinary characters. Most +ordinary characters, like ``'A'``, ``'a'``, or ``'0'``, are the simplest regular +expressions; they simply match themselves. You can concatenate ordinary +characters, so ``last`` matches the string ``'last'``. (In the rest of this +section, we'll write RE's in ``this special style``, usually without quotes, and +strings to be matched ``'in single quotes'``.) + +Some characters, like ``'|'`` or ``'('``, are special. Special +characters either stand for classes of ordinary characters, or affect +how the regular expressions around them are interpreted. + +Repetition qualifiers (``*``, ``+``, ``?``, ``{m,n}``, etc) cannot be +directly nested. This avoids ambiguity with the non-greedy modifier suffix +``?``, and with other modifiers in other implementations. To apply a second +repetition to an inner repetition, parentheses may be used. For example, +the expression ``(?:a{6})*`` matches any multiple of six ``'a'`` characters. + + +The special characters are: + +.. index:: single: . (dot); in regular expressions + +``.`` + (Dot.) In the default mode, this matches any character except a newline. If + the :const:`DOTALL` flag has been specified, this matches any character + including a newline. + +.. index:: single: ^ (caret); in regular expressions + +``^`` + (Caret.) Matches the start of the string, and in :const:`MULTILINE` mode also + matches immediately after each newline. + +.. index:: single: $ (dollar); in regular expressions + +``$`` + Matches the end of the string or just before the newline at the end of the + string, and in :const:`MULTILINE` mode also matches before a newline. ``foo`` + matches both 'foo' and 'foobar', while the regular expression ``foo$`` matches + only 'foo'. More interestingly, searching for ``foo.$`` in ``'foo1\nfoo2\n'`` + matches 'foo2' normally, but 'foo1' in :const:`MULTILINE` mode; searching for + a single ``$`` in ``'foo\n'`` will find two (empty) matches: one just before + the newline, and one at the end of the string. + +.. index:: single: * (asterisk); in regular expressions + +``*`` + Causes the resulting RE to match 0 or more repetitions of the preceding RE, as + many repetitions as are possible. ``ab*`` will match 'a', 'ab', or 'a' followed + by any number of 'b's. + +.. index:: single: + (plus); in regular expressions + +``+`` + Causes the resulting RE to match 1 or more repetitions of the preceding RE. + ``ab+`` will match 'a' followed by any non-zero number of 'b's; it will not + match just 'a'. + +.. index:: single: ? (question mark); in regular expressions + +``?`` + Causes the resulting RE to match 0 or 1 repetitions of the preceding RE. + ``ab?`` will match either 'a' or 'ab'. + +.. index:: + single: *?; in regular expressions + single: +?; in regular expressions + single: ??; in regular expressions + +``*?``, ``+?``, ``??`` + The ``'*'``, ``'+'``, and ``'?'`` qualifiers are all :dfn:`greedy`; they match + as much text as possible. Sometimes this behaviour isn't desired; if the RE + ``<.*>`` is matched against ``' b '``, it will match the entire + string, and not just ``''``. Adding ``?`` after the qualifier makes it + perform the match in :dfn:`non-greedy` or :dfn:`minimal` fashion; as *few* + characters as possible will be matched. Using the RE ``<.*?>`` will match + only ``''``. + +.. index:: + single: {} (curly brackets); in regular expressions + +``{m}`` + Specifies that exactly *m* copies of the previous RE should be matched; fewer + matches cause the entire RE not to match. For example, ``a{6}`` will match + exactly six ``'a'`` characters, but not five. + +``{m,n}`` + Causes the resulting RE to match from *m* to *n* repetitions of the preceding + RE, attempting to match as many repetitions as possible. For example, + ``a{3,5}`` will match from 3 to 5 ``'a'`` characters. Omitting *m* specifies a + lower bound of zero, and omitting *n* specifies an infinite upper bound. As an + example, ``a{4,}b`` will match ``'aaaab'`` or a thousand ``'a'`` characters + followed by a ``'b'``, but not ``'aaab'``. The comma may not be omitted or the + modifier would be confused with the previously described form. + +``{m,n}?`` + Causes the resulting RE to match from *m* to *n* repetitions of the preceding + RE, attempting to match as *few* repetitions as possible. This is the + non-greedy version of the previous qualifier. For example, on the + 6-character string ``'aaaaaa'``, ``a{3,5}`` will match 5 ``'a'`` characters, + while ``a{3,5}?`` will only match 3 characters. + +.. index:: single: \ (backslash); in regular expressions + +``\`` + Either escapes special characters (permitting you to match characters like + ``'*'``, ``'?'``, and so forth), or signals a special sequence; special + sequences are discussed below. + + If you're not using a raw string to express the pattern, remember that Python + also uses the backslash as an escape sequence in string literals; if the escape + sequence isn't recognized by Python's parser, the backslash and subsequent + character are included in the resulting string. However, if Python would + recognize the resulting sequence, the backslash should be repeated twice. This + is complicated and hard to understand, so it's highly recommended that you use + raw strings for all but the simplest expressions. + +.. index:: + single: [] (square brackets); in regular expressions + +``[]`` + Used to indicate a set of characters. In a set: + + * Characters can be listed individually, e.g. ``[amk]`` will match ``'a'``, + ``'m'``, or ``'k'``. + + .. index:: single: - (minus); in regular expressions + + * Ranges of characters can be indicated by giving two characters and separating + them by a ``'-'``, for example ``[a-z]`` will match any lowercase ASCII letter, + ``[0-5][0-9]`` will match all the two-digits numbers from ``00`` to ``59``, and + ``[0-9A-Fa-f]`` will match any hexadecimal digit. If ``-`` is escaped (e.g. + ``[a\-z]``) or if it's placed as the first or last character + (e.g. ``[-a]`` or ``[a-]``), it will match a literal ``'-'``. + + * Special characters lose their special meaning inside sets. For example, + ``[(+*)]`` will match any of the literal characters ``'('``, ``'+'``, + ``'*'``, or ``')'``. + + .. index:: single: \ (backslash); in regular expressions + + * Character classes such as ``\w`` or ``\S`` (defined below) are also accepted + inside a set, although the characters they match depends on whether + :const:`ASCII` or :const:`LOCALE` mode is in force. + + .. index:: single: ^ (caret); in regular expressions + + * Characters that are not within a range can be matched by :dfn:`complementing` + the set. If the first character of the set is ``'^'``, all the characters + that are *not* in the set will be matched. For example, ``[^5]`` will match + any character except ``'5'``, and ``[^^]`` will match any character except + ``'^'``. ``^`` has no special meaning if it's not the first character in + the set. + + * To match a literal ``']'`` inside a set, precede it with a backslash, or + place it at the beginning of the set. For example, both ``[()[\]{}]`` and + ``[]()[{}]`` will both match a parenthesis. + + .. .. index:: single: --; in regular expressions + .. .. index:: single: &&; in regular expressions + .. .. index:: single: ~~; in regular expressions + .. .. index:: single: ||; in regular expressions + + * Support of nested sets and set operations as in `Unicode Technical + Standard #18`_ might be added in the future. This would change the + syntax, so to facilitate this change a :exc:`FutureWarning` will be raised + in ambiguous cases for the time being. + That includes sets starting with a literal ``'['`` or containing literal + character sequences ``'--'``, ``'&&'``, ``'~~'``, and ``'||'``. To + avoid a warning escape them with a backslash. + + .. _Unicode Technical Standard #18: https://unicode.org/reports/tr18/ + + .. versionchanged:: 3.7 + :exc:`FutureWarning` is raised if a character set contains constructs + that will change semantically in the future. + +.. index:: single: | (vertical bar); in regular expressions + +``|`` + ``A|B``, where *A* and *B* can be arbitrary REs, creates a regular expression that + will match either *A* or *B*. An arbitrary number of REs can be separated by the + ``'|'`` in this way. This can be used inside groups (see below) as well. As + the target string is scanned, REs separated by ``'|'`` are tried from left to + right. When one pattern completely matches, that branch is accepted. This means + that once *A* matches, *B* will not be tested further, even if it would + produce a longer overall match. In other words, the ``'|'`` operator is never + greedy. To match a literal ``'|'``, use ``\|``, or enclose it inside a + character class, as in ``[|]``. + +.. index:: + single: () (parentheses); in regular expressions + +``(...)`` + Matches whatever regular expression is inside the parentheses, and indicates the + start and end of a group; the contents of a group can be retrieved after a match + has been performed, and can be matched later in the string with the ``\number`` + special sequence, described below. To match the literals ``'('`` or ``')'``, + use ``\(`` or ``\)``, or enclose them inside a character class: ``[(]``, ``[)]``. + +.. index:: single: (?; in regular expressions + +``(?...)`` + This is an extension notation (a ``'?'`` following a ``'('`` is not meaningful + otherwise). The first character after the ``'?'`` determines what the meaning + and further syntax of the construct is. Extensions usually do not create a new + group; ``(?P...)`` is the only exception to this rule. Following are the + currently supported extensions. + +``(?aiLmsux)`` + (One or more letters from the set ``'a'``, ``'i'``, ``'L'``, ``'m'``, + ``'s'``, ``'u'``, ``'x'``.) The group matches the empty string; the + letters set the corresponding flags: :const:`re.A` (ASCII-only matching), + :const:`re.I` (ignore case), :const:`re.L` (locale dependent), + :const:`re.M` (multi-line), :const:`re.S` (dot matches all), + :const:`re.U` (Unicode matching), and :const:`re.X` (verbose), + for the entire regular expression. + (The flags are described in :ref:`contents-of-module-re`.) + This is useful if you wish to include the flags as part of the + regular expression, instead of passing a *flag* argument to the + :func:`re.compile` function. Flags should be used first in the + expression string. + +.. index:: single: (?:; in regular expressions + +``(?:...)`` + A non-capturing version of regular parentheses. Matches whatever regular + expression is inside the parentheses, but the substring matched by the group + *cannot* be retrieved after performing a match or referenced later in the + pattern. + +``(?aiLmsux-imsx:...)`` + (Zero or more letters from the set ``'a'``, ``'i'``, ``'L'``, ``'m'``, + ``'s'``, ``'u'``, ``'x'``, optionally followed by ``'-'`` followed by + one or more letters from the ``'i'``, ``'m'``, ``'s'``, ``'x'``.) + The letters set or remove the corresponding flags: + :const:`re.A` (ASCII-only matching), :const:`re.I` (ignore case), + :const:`re.L` (locale dependent), :const:`re.M` (multi-line), + :const:`re.S` (dot matches all), :const:`re.U` (Unicode matching), + and :const:`re.X` (verbose), for the part of the expression. + (The flags are described in :ref:`contents-of-module-re`.) + + The letters ``'a'``, ``'L'`` and ``'u'`` are mutually exclusive when used + as inline flags, so they can't be combined or follow ``'-'``. Instead, + when one of them appears in an inline group, it overrides the matching mode + in the enclosing group. In Unicode patterns ``(?a:...)`` switches to + ASCII-only matching, and ``(?u:...)`` switches to Unicode matching + (default). In byte pattern ``(?L:...)`` switches to locale depending + matching, and ``(?a:...)`` switches to ASCII-only matching (default). + This override is only in effect for the narrow inline group, and the + original matching mode is restored outside of the group. + + .. versionadded:: 3.6 + + .. versionchanged:: 3.7 + The letters ``'a'``, ``'L'`` and ``'u'`` also can be used in a group. + +.. index:: single: (?P<; in regular expressions + +``(?P...)`` + Similar to regular parentheses, but the substring matched by the group is + accessible via the symbolic group name *name*. Group names must be valid + Python identifiers, and each group name must be defined only once within a + regular expression. A symbolic group is also a numbered group, just as if + the group were not named. + + Named groups can be referenced in three contexts. If the pattern is + ``(?P['"]).*?(?P=quote)`` (i.e. matching a string quoted with either + single or double quotes): + + +---------------------------------------+----------------------------------+ + | Context of reference to group "quote" | Ways to reference it | + +=======================================+==================================+ + | in the same pattern itself | * ``(?P=quote)`` (as shown) | + | | * ``\1`` | + +---------------------------------------+----------------------------------+ + | when processing match object *m* | * ``m.group('quote')`` | + | | * ``m.end('quote')`` (etc.) | + +---------------------------------------+----------------------------------+ + | in a string passed to the *repl* | * ``\g`` | + | argument of ``re.sub()`` | * ``\g<1>`` | + | | * ``\1`` | + +---------------------------------------+----------------------------------+ + +.. index:: single: (?P=; in regular expressions + +``(?P=name)`` + A backreference to a named group; it matches whatever text was matched by the + earlier group named *name*. + +.. index:: single: (?#; in regular expressions + +``(?#...)`` + A comment; the contents of the parentheses are simply ignored. + +.. index:: single: (?=; in regular expressions + +``(?=...)`` + Matches if ``...`` matches next, but doesn't consume any of the string. This is + called a :dfn:`lookahead assertion`. For example, ``Isaac (?=Asimov)`` will match + ``'Isaac '`` only if it's followed by ``'Asimov'``. + +.. index:: single: (?!; in regular expressions + +``(?!...)`` + Matches if ``...`` doesn't match next. This is a :dfn:`negative lookahead assertion`. + For example, ``Isaac (?!Asimov)`` will match ``'Isaac '`` only if it's *not* + followed by ``'Asimov'``. + +.. index:: single: (?<=; in regular expressions + +``(?<=...)`` + Matches if the current position in the string is preceded by a match for ``...`` + that ends at the current position. This is called a :dfn:`positive lookbehind + assertion`. ``(?<=abc)def`` will find a match in ``'abcdef'``, since the + lookbehind will back up 3 characters and check if the contained pattern matches. + The contained pattern must only match strings of some fixed length, meaning that + ``abc`` or ``a|b`` are allowed, but ``a*`` and ``a{3,4}`` are not. Note that + patterns which start with positive lookbehind assertions will not match at the + beginning of the string being searched; you will most likely want to use the + :func:`search` function rather than the :func:`match` function: + + >>> import re + >>> m = re.search('(?<=abc)def', 'abcdef') + >>> m.group(0) + 'def' + + This example looks for a word following a hyphen: + + >>> m = re.search(r'(?<=-)\w+', 'spam-egg') + >>> m.group(0) + 'egg' + + .. versionchanged:: 3.5 + Added support for group references of fixed length. + +.. index:: single: (?|$)`` is a poor email matching pattern, which + will match with ``''`` as well as ``'user@host.com'``, but + not with ``''``. + + +The special sequences consist of ``'\'`` and a character from the list below. +If the ordinary character is not an ASCII digit or an ASCII letter, then the +resulting RE will match the second character. For example, ``\$`` matches the +character ``'$'``. + +.. index:: single: \ (backslash); in regular expressions + +``\number`` + Matches the contents of the group of the same number. Groups are numbered + starting from 1. For example, ``(.+) \1`` matches ``'the the'`` or ``'55 55'``, + but not ``'thethe'`` (note the space after the group). This special sequence + can only be used to match one of the first 99 groups. If the first digit of + *number* is 0, or *number* is 3 octal digits long, it will not be interpreted as + a group match, but as the character with octal value *number*. Inside the + ``'['`` and ``']'`` of a character class, all numeric escapes are treated as + characters. + +.. index:: single: \A; in regular expressions + +``\A`` + Matches only at the start of the string. + +.. index:: single: \b; in regular expressions + +``\b`` + Matches the empty string, but only at the beginning or end of a word. + A word is defined as a sequence of word characters. Note that formally, + ``\b`` is defined as the boundary between a ``\w`` and a ``\W`` character + (or vice versa), or between ``\w`` and the beginning/end of the string. + This means that ``r'\bfoo\b'`` matches ``'foo'``, ``'foo.'``, ``'(foo)'``, + ``'bar foo baz'`` but not ``'foobar'`` or ``'foo3'``. + + By default Unicode alphanumerics are the ones used in Unicode patterns, but + this can be changed by using the :const:`ASCII` flag. Word boundaries are + determined by the current locale if the :const:`LOCALE` flag is used. + Inside a character range, ``\b`` represents the backspace character, for + compatibility with Python's string literals. + +.. index:: single: \B; in regular expressions + +``\B`` + Matches the empty string, but only when it is *not* at the beginning or end + of a word. This means that ``r'py\B'`` matches ``'python'``, ``'py3'``, + ``'py2'``, but not ``'py'``, ``'py.'``, or ``'py!'``. + ``\B`` is just the opposite of ``\b``, so word characters in Unicode + patterns are Unicode alphanumerics or the underscore, although this can + be changed by using the :const:`ASCII` flag. Word boundaries are + determined by the current locale if the :const:`LOCALE` flag is used. + +.. index:: single: \d; in regular expressions + +``\d`` + For Unicode (str) patterns: + Matches any Unicode decimal digit (that is, any character in + Unicode character category [Nd]). This includes ``[0-9]``, and + also many other digit characters. If the :const:`ASCII` flag is + used only ``[0-9]`` is matched. + + For 8-bit (bytes) patterns: + Matches any decimal digit; this is equivalent to ``[0-9]``. + +.. index:: single: \D; in regular expressions + +``\D`` + Matches any character which is not a decimal digit. This is + the opposite of ``\d``. If the :const:`ASCII` flag is used this + becomes the equivalent of ``[^0-9]``. + +.. index:: single: \s; in regular expressions + +``\s`` + For Unicode (str) patterns: + Matches Unicode whitespace characters (which includes + ``[ \t\n\r\f\v]``, and also many other characters, for example the + non-breaking spaces mandated by typography rules in many + languages). If the :const:`ASCII` flag is used, only + ``[ \t\n\r\f\v]`` is matched. + + For 8-bit (bytes) patterns: + Matches characters considered whitespace in the ASCII character set; + this is equivalent to ``[ \t\n\r\f\v]``. + +.. index:: single: \S; in regular expressions + +``\S`` + Matches any character which is not a whitespace character. This is + the opposite of ``\s``. If the :const:`ASCII` flag is used this + becomes the equivalent of ``[^ \t\n\r\f\v]``. + +.. index:: single: \w; in regular expressions + +``\w`` + For Unicode (str) patterns: + Matches Unicode word characters; this includes most characters + that can be part of a word in any language, as well as numbers and + the underscore. If the :const:`ASCII` flag is used, only + ``[a-zA-Z0-9_]`` is matched. + + For 8-bit (bytes) patterns: + Matches characters considered alphanumeric in the ASCII character set; + this is equivalent to ``[a-zA-Z0-9_]``. If the :const:`LOCALE` flag is + used, matches characters considered alphanumeric in the current locale + and the underscore. + +.. index:: single: \W; in regular expressions + +``\W`` + Matches any character which is not a word character. This is + the opposite of ``\w``. If the :const:`ASCII` flag is used this + becomes the equivalent of ``[^a-zA-Z0-9_]``. If the :const:`LOCALE` flag is + used, matches characters considered alphanumeric in the current locale + and the underscore. + +.. index:: single: \Z; in regular expressions + +``\Z`` + Matches only at the end of the string. + +.. index:: + single: \a; in regular expressions + single: \b; in regular expressions + single: \f; in regular expressions + single: \n; in regular expressions + single: \N; in regular expressions + single: \r; in regular expressions + single: \t; in regular expressions + single: \u; in regular expressions + single: \U; in regular expressions + single: \v; in regular expressions + single: \x; in regular expressions + single: \\; in regular expressions + +Most of the standard escapes supported by Python string literals are also +accepted by the regular expression parser:: + + \a \b \f \n + \r \t \u \U + \v \x \\ + +(Note that ``\b`` is used to represent word boundaries, and means "backspace" +only inside character classes.) + +``'\u'`` and ``'\U'`` escape sequences are only recognized in Unicode +patterns. In bytes patterns they are errors. Unknown escapes of ASCII +letters are reserved for future use and treated as errors. + +Octal escapes are included in a limited form. If the first digit is a 0, or if +there are three octal digits, it is considered an octal escape. Otherwise, it is +a group reference. As for string literals, octal escapes are always at most +three digits in length. + +.. versionchanged:: 3.3 + The ``'\u'`` and ``'\U'`` escape sequences have been added. + +.. versionchanged:: 3.6 + Unknown escapes consisting of ``'\'`` and an ASCII letter now are errors. + + + +.. _contents-of-module-re: + +Module Contents +--------------- + +The module defines several functions, constants, and an exception. Some of the +functions are simplified versions of the full featured methods for compiled +regular expressions. Most non-trivial applications always use the compiled +form. + +.. versionchanged:: 3.6 + Flag constants are now instances of :class:`RegexFlag`, which is a subclass of + :class:`enum.IntFlag`. + +.. function:: compile(pattern, flags=0) + + Compile a regular expression pattern into a :ref:`regular expression object + `, which can be used for matching using its + :func:`~Pattern.match`, :func:`~Pattern.search` and other methods, described + below. + + The expression's behaviour can be modified by specifying a *flags* value. + Values can be any of the following variables, combined using bitwise OR (the + ``|`` operator). + + The sequence :: + + prog = re.compile(pattern) + result = prog.match(string) + + is equivalent to :: + + result = re.match(pattern, string) + + but using :func:`re.compile` and saving the resulting regular expression + object for reuse is more efficient when the expression will be used several + times in a single program. + + .. note:: + + The compiled versions of the most recent patterns passed to + :func:`re.compile` and the module-level matching functions are cached, so + programs that use only a few regular expressions at a time needn't worry + about compiling regular expressions. + + +.. data:: A + ASCII + + Make ``\w``, ``\W``, ``\b``, ``\B``, ``\d``, ``\D``, ``\s`` and ``\S`` + perform ASCII-only matching instead of full Unicode matching. This is only + meaningful for Unicode patterns, and is ignored for byte patterns. + Corresponds to the inline flag ``(?a)``. + + Note that for backward compatibility, the :const:`re.U` flag still + exists (as well as its synonym :const:`re.UNICODE` and its embedded + counterpart ``(?u)``), but these are redundant in Python 3 since + matches are Unicode by default for strings (and Unicode matching + isn't allowed for bytes). + + +.. data:: DEBUG + + Display debug information about compiled expression. + No corresponding inline flag. + + +.. data:: I + IGNORECASE + + Perform case-insensitive matching; expressions like ``[A-Z]`` will also + match lowercase letters. Full Unicode matching (such as ``Ü`` matching + ``ü``) also works unless the :const:`re.ASCII` flag is used to disable + non-ASCII matches. The current locale does not change the effect of this + flag unless the :const:`re.LOCALE` flag is also used. + Corresponds to the inline flag ``(?i)``. + + Note that when the Unicode patterns ``[a-z]`` or ``[A-Z]`` are used in + combination with the :const:`IGNORECASE` flag, they will match the 52 ASCII + letters and 4 additional non-ASCII letters: 'İ' (U+0130, Latin capital + letter I with dot above), 'ı' (U+0131, Latin small letter dotless i), + 'ſ' (U+017F, Latin small letter long s) and 'K' (U+212A, Kelvin sign). + If the :const:`ASCII` flag is used, only letters 'a' to 'z' + and 'A' to 'Z' are matched. + +.. data:: L + LOCALE + + Make ``\w``, ``\W``, ``\b``, ``\B`` and case-insensitive matching + dependent on the current locale. This flag can be used only with bytes + patterns. The use of this flag is discouraged as the locale mechanism + is very unreliable, it only handles one "culture" at a time, and it only + works with 8-bit locales. Unicode matching is already enabled by default + in Python 3 for Unicode (str) patterns, and it is able to handle different + locales/languages. + Corresponds to the inline flag ``(?L)``. + + .. versionchanged:: 3.6 + :const:`re.LOCALE` can be used only with bytes patterns and is + not compatible with :const:`re.ASCII`. + + .. versionchanged:: 3.7 + Compiled regular expression objects with the :const:`re.LOCALE` flag no + longer depend on the locale at compile time. Only the locale at + matching time affects the result of matching. + + +.. data:: M + MULTILINE + + When specified, the pattern character ``'^'`` matches at the beginning of the + string and at the beginning of each line (immediately following each newline); + and the pattern character ``'$'`` matches at the end of the string and at the + end of each line (immediately preceding each newline). By default, ``'^'`` + matches only at the beginning of the string, and ``'$'`` only at the end of the + string and immediately before the newline (if any) at the end of the string. + Corresponds to the inline flag ``(?m)``. + + +.. data:: S + DOTALL + + Make the ``'.'`` special character match any character at all, including a + newline; without this flag, ``'.'`` will match anything *except* a newline. + Corresponds to the inline flag ``(?s)``. + + +.. data:: X + VERBOSE + + .. index:: single: # (hash); in regular expressions + + This flag allows you to write regular expressions that look nicer and are + more readable by allowing you to visually separate logical sections of the + pattern and add comments. Whitespace within the pattern is ignored, except + when in a character class, or when preceded by an unescaped backslash, + or within tokens like ``*?``, ``(?:`` or ``(?P<...>``. + When a line contains a ``#`` that is not in a character class and is not + preceded by an unescaped backslash, all characters from the leftmost such + ``#`` through the end of the line are ignored. + + This means that the two following regular expression objects that match a + decimal number are functionally equal:: + + a = re.compile(r"""\d + # the integral part + \. # the decimal point + \d * # some fractional digits""", re.X) + b = re.compile(r"\d+\.\d*") + + Corresponds to the inline flag ``(?x)``. + + +.. function:: search(pattern, string, flags=0) + + Scan through *string* looking for the first location where the regular expression + *pattern* produces a match, and return a corresponding :ref:`match object + `. Return ``None`` if no position in the string matches the + pattern; note that this is different from finding a zero-length match at some + point in the string. + + +.. function:: match(pattern, string, flags=0) + + If zero or more characters at the beginning of *string* match the regular + expression *pattern*, return a corresponding :ref:`match object + `. Return ``None`` if the string does not match the pattern; + note that this is different from a zero-length match. + + Note that even in :const:`MULTILINE` mode, :func:`re.match` will only match + at the beginning of the string and not at the beginning of each line. + + If you want to locate a match anywhere in *string*, use :func:`search` + instead (see also :ref:`search-vs-match`). + + +.. function:: fullmatch(pattern, string, flags=0) + + If the whole *string* matches the regular expression *pattern*, return a + corresponding :ref:`match object `. Return ``None`` if the + string does not match the pattern; note that this is different from a + zero-length match. + + .. versionadded:: 3.4 + + +.. function:: split(pattern, string, maxsplit=0, flags=0) + + Split *string* by the occurrences of *pattern*. If capturing parentheses are + used in *pattern*, then the text of all groups in the pattern are also returned + as part of the resulting list. If *maxsplit* is nonzero, at most *maxsplit* + splits occur, and the remainder of the string is returned as the final element + of the list. :: + + >>> re.split(r'\W+', 'Words, words, words.') + ['Words', 'words', 'words', ''] + >>> re.split(r'(\W+)', 'Words, words, words.') + ['Words', ', ', 'words', ', ', 'words', '.', ''] + >>> re.split(r'\W+', 'Words, words, words.', 1) + ['Words', 'words, words.'] + >>> re.split('[a-f]+', '0a3B9', flags=re.IGNORECASE) + ['0', '3', '9'] + + If there are capturing groups in the separator and it matches at the start of + the string, the result will start with an empty string. The same holds for + the end of the string:: + + >>> re.split(r'(\W+)', '...words, words...') + ['', '...', 'words', ', ', 'words', '...', ''] + + That way, separator components are always found at the same relative + indices within the result list. + + Empty matches for the pattern split the string only when not adjacent + to a previous empty match. + + >>> re.split(r'\b', 'Words, words, words.') + ['', 'Words', ', ', 'words', ', ', 'words', '.'] + >>> re.split(r'\W*', '...words...') + ['', '', 'w', 'o', 'r', 'd', 's', '', ''] + >>> re.split(r'(\W*)', '...words...') + ['', '...', '', '', 'w', '', 'o', '', 'r', '', 'd', '', 's', '...', '', '', ''] + + .. versionchanged:: 3.1 + Added the optional flags argument. + + .. versionchanged:: 3.7 + Added support of splitting on a pattern that could match an empty string. + + +.. function:: findall(pattern, string, flags=0) + + Return all non-overlapping matches of *pattern* in *string*, as a list of + strings. The *string* is scanned left-to-right, and matches are returned in + the order found. If one or more groups are present in the pattern, return a + list of groups; this will be a list of tuples if the pattern has more than + one group. Empty matches are included in the result. + + .. versionchanged:: 3.7 + Non-empty matches can now start just after a previous empty match. + + +.. function:: finditer(pattern, string, flags=0) + + Return an :term:`iterator` yielding :ref:`match objects ` over + all non-overlapping matches for the RE *pattern* in *string*. The *string* + is scanned left-to-right, and matches are returned in the order found. Empty + matches are included in the result. + + .. versionchanged:: 3.7 + Non-empty matches can now start just after a previous empty match. + + +.. function:: sub(pattern, repl, string, count=0, flags=0) + + Return the string obtained by replacing the leftmost non-overlapping occurrences + of *pattern* in *string* by the replacement *repl*. If the pattern isn't found, + *string* is returned unchanged. *repl* can be a string or a function; if it is + a string, any backslash escapes in it are processed. That is, ``\n`` is + converted to a single newline character, ``\r`` is converted to a carriage return, and + so forth. Unknown escapes of ASCII letters are reserved for future use and + treated as errors. Other unknown escapes such as ``\&`` are left alone. + Backreferences, such + as ``\6``, are replaced with the substring matched by group 6 in the pattern. + For example:: + + >>> re.sub(r'def\s+([a-zA-Z_][a-zA-Z_0-9]*)\s*\(\s*\):', + ... r'static PyObject*\npy_\1(void)\n{', + ... 'def myfunc():') + 'static PyObject*\npy_myfunc(void)\n{' + + If *repl* is a function, it is called for every non-overlapping occurrence of + *pattern*. The function takes a single :ref:`match object ` + argument, and returns the replacement string. For example:: + + >>> def dashrepl(matchobj): + ... if matchobj.group(0) == '-': return ' ' + ... else: return '-' + >>> re.sub('-{1,2}', dashrepl, 'pro----gram-files') + 'pro--gram files' + >>> re.sub(r'\sAND\s', ' & ', 'Baked Beans And Spam', flags=re.IGNORECASE) + 'Baked Beans & Spam' + + The pattern may be a string or a :ref:`pattern object `. + + The optional argument *count* is the maximum number of pattern occurrences to be + replaced; *count* must be a non-negative integer. If omitted or zero, all + occurrences will be replaced. Empty matches for the pattern are replaced only + when not adjacent to a previous empty match, so ``sub('x*', '-', 'abxd')`` returns + ``'-a-b--d-'``. + + .. index:: single: \g; in regular expressions + + In string-type *repl* arguments, in addition to the character escapes and + backreferences described above, + ``\g`` will use the substring matched by the group named ``name``, as + defined by the ``(?P...)`` syntax. ``\g`` uses the corresponding + group number; ``\g<2>`` is therefore equivalent to ``\2``, but isn't ambiguous + in a replacement such as ``\g<2>0``. ``\20`` would be interpreted as a + reference to group 20, not a reference to group 2 followed by the literal + character ``'0'``. The backreference ``\g<0>`` substitutes in the entire + substring matched by the RE. + + .. versionchanged:: 3.1 + Added the optional flags argument. + + .. versionchanged:: 3.5 + Unmatched groups are replaced with an empty string. + + .. versionchanged:: 3.6 + Unknown escapes in *pattern* consisting of ``'\'`` and an ASCII letter + now are errors. + + .. versionchanged:: 3.7 + Unknown escapes in *repl* consisting of ``'\'`` and an ASCII letter + now are errors. + + .. versionchanged:: 3.7 + Empty matches for the pattern are replaced when adjacent to a previous + non-empty match. + + +.. function:: subn(pattern, repl, string, count=0, flags=0) + + Perform the same operation as :func:`sub`, but return a tuple ``(new_string, + number_of_subs_made)``. + + .. versionchanged:: 3.1 + Added the optional flags argument. + + .. versionchanged:: 3.5 + Unmatched groups are replaced with an empty string. + + +.. function:: escape(pattern) + + Escape special characters in *pattern*. + This is useful if you want to match an arbitrary literal string that may + have regular expression metacharacters in it. For example:: + + >>> print(re.escape('python.exe')) + python\.exe + + >>> legal_chars = string.ascii_lowercase + string.digits + "!#$%&'*+-.^_`|~:" + >>> print('[%s]+' % re.escape(legal_chars)) + [abcdefghijklmnopqrstuvwxyz0123456789!\#\$%\&'\*\+\-\.\^_`\|\~:]+ + + >>> operators = ['+', '-', '*', '/', '**'] + >>> print('|'.join(map(re.escape, sorted(operators, reverse=True)))) + /|\-|\+|\*\*|\* + + This functions must not be used for the replacement string in :func:`sub` + and :func:`subn`, only backslashes should be escaped. For example:: + + >>> digits_re = r'\d+' + >>> sample = '/usr/sbin/sendmail - 0 errors, 12 warnings' + >>> print(re.sub(digits_re, digits_re.replace('\\', r'\\'), sample)) + /usr/sbin/sendmail - \d+ errors, \d+ warnings + + .. versionchanged:: 3.3 + The ``'_'`` character is no longer escaped. + + .. versionchanged:: 3.7 + Only characters that can have special meaning in a regular expression + are escaped. + + +.. function:: purge() + + Clear the regular expression cache. + + +.. exception:: error(msg, pattern=None, pos=None) + + Exception raised when a string passed to one of the functions here is not a + valid regular expression (for example, it might contain unmatched parentheses) + or when some other error occurs during compilation or matching. It is never an + error if a string contains no match for a pattern. The error instance has + the following additional attributes: + + .. attribute:: msg + + The unformatted error message. + + .. attribute:: pattern + + The regular expression pattern. + + .. attribute:: pos + + The index in *pattern* where compilation failed (may be ``None``). + + .. attribute:: lineno + + The line corresponding to *pos* (may be ``None``). + + .. attribute:: colno + + The column corresponding to *pos* (may be ``None``). + + .. versionchanged:: 3.5 + Added additional attributes. + +.. _re-objects: + +Regular Expression Objects +-------------------------- + +Compiled regular expression objects support the following methods and +attributes: + +.. method:: Pattern.search(string[, pos[, endpos]]) + + Scan through *string* looking for the first location where this regular + expression produces a match, and return a corresponding :ref:`match object + `. Return ``None`` if no position in the string matches the + pattern; note that this is different from finding a zero-length match at some + point in the string. + + The optional second parameter *pos* gives an index in the string where the + search is to start; it defaults to ``0``. This is not completely equivalent to + slicing the string; the ``'^'`` pattern character matches at the real beginning + of the string and at positions just after a newline, but not necessarily at the + index where the search is to start. + + The optional parameter *endpos* limits how far the string will be searched; it + will be as if the string is *endpos* characters long, so only the characters + from *pos* to ``endpos - 1`` will be searched for a match. If *endpos* is less + than *pos*, no match will be found; otherwise, if *rx* is a compiled regular + expression object, ``rx.search(string, 0, 50)`` is equivalent to + ``rx.search(string[:50], 0)``. :: + + >>> pattern = re.compile("d") + >>> pattern.search("dog") # Match at index 0 + + >>> pattern.search("dog", 1) # No match; search doesn't include the "d" + + +.. method:: Pattern.match(string[, pos[, endpos]]) + + If zero or more characters at the *beginning* of *string* match this regular + expression, return a corresponding :ref:`match object `. + Return ``None`` if the string does not match the pattern; note that this is + different from a zero-length match. + + The optional *pos* and *endpos* parameters have the same meaning as for the + :meth:`~Pattern.search` method. :: + + >>> pattern = re.compile("o") + >>> pattern.match("dog") # No match as "o" is not at the start of "dog". + >>> pattern.match("dog", 1) # Match as "o" is the 2nd character of "dog". + + + If you want to locate a match anywhere in *string*, use + :meth:`~Pattern.search` instead (see also :ref:`search-vs-match`). + + +.. method:: Pattern.fullmatch(string[, pos[, endpos]]) + + If the whole *string* matches this regular expression, return a corresponding + :ref:`match object `. Return ``None`` if the string does not + match the pattern; note that this is different from a zero-length match. + + The optional *pos* and *endpos* parameters have the same meaning as for the + :meth:`~Pattern.search` method. :: + + >>> pattern = re.compile("o[gh]") + >>> pattern.fullmatch("dog") # No match as "o" is not at the start of "dog". + >>> pattern.fullmatch("ogre") # No match as not the full string matches. + >>> pattern.fullmatch("doggie", 1, 3) # Matches within given limits. + + + .. versionadded:: 3.4 + + +.. method:: Pattern.split(string, maxsplit=0) + + Identical to the :func:`split` function, using the compiled pattern. + + +.. method:: Pattern.findall(string[, pos[, endpos]]) + + Similar to the :func:`findall` function, using the compiled pattern, but + also accepts optional *pos* and *endpos* parameters that limit the search + region like for :meth:`search`. + + +.. method:: Pattern.finditer(string[, pos[, endpos]]) + + Similar to the :func:`finditer` function, using the compiled pattern, but + also accepts optional *pos* and *endpos* parameters that limit the search + region like for :meth:`search`. + + +.. method:: Pattern.sub(repl, string, count=0) + + Identical to the :func:`sub` function, using the compiled pattern. + + +.. method:: Pattern.subn(repl, string, count=0) + + Identical to the :func:`subn` function, using the compiled pattern. + + +.. attribute:: Pattern.flags + + The regex matching flags. This is a combination of the flags given to + :func:`.compile`, any ``(?...)`` inline flags in the pattern, and implicit + flags such as :data:`UNICODE` if the pattern is a Unicode string. + + +.. attribute:: Pattern.groups + + The number of capturing groups in the pattern. + + +.. attribute:: Pattern.groupindex + + A dictionary mapping any symbolic group names defined by ``(?P)`` to group + numbers. The dictionary is empty if no symbolic groups were used in the + pattern. + + +.. attribute:: Pattern.pattern + + The pattern string from which the pattern object was compiled. + + +.. versionchanged:: 3.7 + Added support of :func:`copy.copy` and :func:`copy.deepcopy`. Compiled + regular expression objects are considered atomic. + + +.. _match-objects: + +Match Objects +------------- + +Match objects always have a boolean value of ``True``. +Since :meth:`~Pattern.match` and :meth:`~Pattern.search` return ``None`` +when there is no match, you can test whether there was a match with a simple +``if`` statement:: + + match = re.search(pattern, string) + if match: + process(match) + +Match objects support the following methods and attributes: + + +.. method:: Match.expand(template) + + Return the string obtained by doing backslash substitution on the template + string *template*, as done by the :meth:`~Pattern.sub` method. + Escapes such as ``\n`` are converted to the appropriate characters, + and numeric backreferences (``\1``, ``\2``) and named backreferences + (``\g<1>``, ``\g``) are replaced by the contents of the + corresponding group. + + .. versionchanged:: 3.5 + Unmatched groups are replaced with an empty string. + +.. method:: Match.group([group1, ...]) + + Returns one or more subgroups of the match. If there is a single argument, the + result is a single string; if there are multiple arguments, the result is a + tuple with one item per argument. Without arguments, *group1* defaults to zero + (the whole match is returned). If a *groupN* argument is zero, the corresponding + return value is the entire matching string; if it is in the inclusive range + [1..99], it is the string matching the corresponding parenthesized group. If a + group number is negative or larger than the number of groups defined in the + pattern, an :exc:`IndexError` exception is raised. If a group is contained in a + part of the pattern that did not match, the corresponding result is ``None``. + If a group is contained in a part of the pattern that matched multiple times, + the last match is returned. :: + + >>> m = re.match(r"(\w+) (\w+)", "Isaac Newton, physicist") + >>> m.group(0) # The entire match + 'Isaac Newton' + >>> m.group(1) # The first parenthesized subgroup. + 'Isaac' + >>> m.group(2) # The second parenthesized subgroup. + 'Newton' + >>> m.group(1, 2) # Multiple arguments give us a tuple. + ('Isaac', 'Newton') + + If the regular expression uses the ``(?P...)`` syntax, the *groupN* + arguments may also be strings identifying groups by their group name. If a + string argument is not used as a group name in the pattern, an :exc:`IndexError` + exception is raised. + + A moderately complicated example:: + + >>> m = re.match(r"(?P\w+) (?P\w+)", "Malcolm Reynolds") + >>> m.group('first_name') + 'Malcolm' + >>> m.group('last_name') + 'Reynolds' + + Named groups can also be referred to by their index:: + + >>> m.group(1) + 'Malcolm' + >>> m.group(2) + 'Reynolds' + + If a group matches multiple times, only the last match is accessible:: + + >>> m = re.match(r"(..)+", "a1b2c3") # Matches 3 times. + >>> m.group(1) # Returns only the last match. + 'c3' + + +.. method:: Match.__getitem__(g) + + This is identical to ``m.group(g)``. This allows easier access to + an individual group from a match:: + + >>> m = re.match(r"(\w+) (\w+)", "Isaac Newton, physicist") + >>> m[0] # The entire match + 'Isaac Newton' + >>> m[1] # The first parenthesized subgroup. + 'Isaac' + >>> m[2] # The second parenthesized subgroup. + 'Newton' + + .. versionadded:: 3.6 + + +.. method:: Match.groups(default=None) + + Return a tuple containing all the subgroups of the match, from 1 up to however + many groups are in the pattern. The *default* argument is used for groups that + did not participate in the match; it defaults to ``None``. + + For example:: + + >>> m = re.match(r"(\d+)\.(\d+)", "24.1632") + >>> m.groups() + ('24', '1632') + + If we make the decimal place and everything after it optional, not all groups + might participate in the match. These groups will default to ``None`` unless + the *default* argument is given:: + + >>> m = re.match(r"(\d+)\.?(\d+)?", "24") + >>> m.groups() # Second group defaults to None. + ('24', None) + >>> m.groups('0') # Now, the second group defaults to '0'. + ('24', '0') + + +.. method:: Match.groupdict(default=None) + + Return a dictionary containing all the *named* subgroups of the match, keyed by + the subgroup name. The *default* argument is used for groups that did not + participate in the match; it defaults to ``None``. For example:: + + >>> m = re.match(r"(?P\w+) (?P\w+)", "Malcolm Reynolds") + >>> m.groupdict() + {'first_name': 'Malcolm', 'last_name': 'Reynolds'} + + +.. method:: Match.start([group]) + Match.end([group]) + + Return the indices of the start and end of the substring matched by *group*; + *group* defaults to zero (meaning the whole matched substring). Return ``-1`` if + *group* exists but did not contribute to the match. For a match object *m*, and + a group *g* that did contribute to the match, the substring matched by group *g* + (equivalent to ``m.group(g)``) is :: + + m.string[m.start(g):m.end(g)] + + Note that ``m.start(group)`` will equal ``m.end(group)`` if *group* matched a + null string. For example, after ``m = re.search('b(c?)', 'cba')``, + ``m.start(0)`` is 1, ``m.end(0)`` is 2, ``m.start(1)`` and ``m.end(1)`` are both + 2, and ``m.start(2)`` raises an :exc:`IndexError` exception. + + An example that will remove *remove_this* from email addresses:: + + >>> email = "tony@tiremove_thisger.net" + >>> m = re.search("remove_this", email) + >>> email[:m.start()] + email[m.end():] + 'tony@tiger.net' + + +.. method:: Match.span([group]) + + For a match *m*, return the 2-tuple ``(m.start(group), m.end(group))``. Note + that if *group* did not contribute to the match, this is ``(-1, -1)``. + *group* defaults to zero, the entire match. + + +.. attribute:: Match.pos + + The value of *pos* which was passed to the :meth:`~Pattern.search` or + :meth:`~Pattern.match` method of a :ref:`regex object `. This is + the index into the string at which the RE engine started looking for a match. + + +.. attribute:: Match.endpos + + The value of *endpos* which was passed to the :meth:`~Pattern.search` or + :meth:`~Pattern.match` method of a :ref:`regex object `. This is + the index into the string beyond which the RE engine will not go. + + +.. attribute:: Match.lastindex + + The integer index of the last matched capturing group, or ``None`` if no group + was matched at all. For example, the expressions ``(a)b``, ``((a)(b))``, and + ``((ab))`` will have ``lastindex == 1`` if applied to the string ``'ab'``, while + the expression ``(a)(b)`` will have ``lastindex == 2``, if applied to the same + string. + + +.. attribute:: Match.lastgroup + + The name of the last matched capturing group, or ``None`` if the group didn't + have a name, or if no group was matched at all. + + +.. attribute:: Match.re + + The :ref:`regular expression object ` whose :meth:`~Pattern.match` or + :meth:`~Pattern.search` method produced this match instance. + + +.. attribute:: Match.string + + The string passed to :meth:`~Pattern.match` or :meth:`~Pattern.search`. + + +.. versionchanged:: 3.7 + Added support of :func:`copy.copy` and :func:`copy.deepcopy`. Match objects + are considered atomic. + + +.. _re-examples: + +Regular Expression Examples +--------------------------- + + +Checking for a Pair +^^^^^^^^^^^^^^^^^^^ + +In this example, we'll use the following helper function to display match +objects a little more gracefully: + +.. testcode:: + + def displaymatch(match): + if match is None: + return None + return '' % (match.group(), match.groups()) + +Suppose you are writing a poker program where a player's hand is represented as +a 5-character string with each character representing a card, "a" for ace, "k" +for king, "q" for queen, "j" for jack, "t" for 10, and "2" through "9" +representing the card with that value. + +To see if a given string is a valid hand, one could do the following:: + + >>> valid = re.compile(r"^[a2-9tjqk]{5}$") + >>> displaymatch(valid.match("akt5q")) # Valid. + "" + >>> displaymatch(valid.match("akt5e")) # Invalid. + >>> displaymatch(valid.match("akt")) # Invalid. + >>> displaymatch(valid.match("727ak")) # Valid. + "" + +That last hand, ``"727ak"``, contained a pair, or two of the same valued cards. +To match this with a regular expression, one could use backreferences as such:: + + >>> pair = re.compile(r".*(.).*\1") + >>> displaymatch(pair.match("717ak")) # Pair of 7s. + "" + >>> displaymatch(pair.match("718ak")) # No pairs. + >>> displaymatch(pair.match("354aa")) # Pair of aces. + "" + +To find out what card the pair consists of, one could use the +:meth:`~Match.group` method of the match object in the following manner: + +.. doctest:: + + >>> pair.match("717ak").group(1) + '7' + + # Error because re.match() returns None, which doesn't have a group() method: + >>> pair.match("718ak").group(1) + Traceback (most recent call last): + File "", line 1, in + re.match(r".*(.).*\1", "718ak").group(1) + AttributeError: 'NoneType' object has no attribute 'group' + + >>> pair.match("354aa").group(1) + 'a' + + +Simulating scanf() +^^^^^^^^^^^^^^^^^^ + +.. index:: single: scanf() + +Python does not currently have an equivalent to :c:func:`scanf`. Regular +expressions are generally more powerful, though also more verbose, than +:c:func:`scanf` format strings. The table below offers some more-or-less +equivalent mappings between :c:func:`scanf` format tokens and regular +expressions. + ++--------------------------------+---------------------------------------------+ +| :c:func:`scanf` Token | Regular Expression | ++================================+=============================================+ +| ``%c`` | ``.`` | ++--------------------------------+---------------------------------------------+ +| ``%5c`` | ``.{5}`` | ++--------------------------------+---------------------------------------------+ +| ``%d`` | ``[-+]?\d+`` | ++--------------------------------+---------------------------------------------+ +| ``%e``, ``%E``, ``%f``, ``%g`` | ``[-+]?(\d+(\.\d*)?|\.\d+)([eE][-+]?\d+)?`` | ++--------------------------------+---------------------------------------------+ +| ``%i`` | ``[-+]?(0[xX][\dA-Fa-f]+|0[0-7]*|\d+)`` | ++--------------------------------+---------------------------------------------+ +| ``%o`` | ``[-+]?[0-7]+`` | ++--------------------------------+---------------------------------------------+ +| ``%s`` | ``\S+`` | ++--------------------------------+---------------------------------------------+ +| ``%u`` | ``\d+`` | ++--------------------------------+---------------------------------------------+ +| ``%x``, ``%X`` | ``[-+]?(0[xX])?[\dA-Fa-f]+`` | ++--------------------------------+---------------------------------------------+ + +To extract the filename and numbers from a string like :: + + /usr/sbin/sendmail - 0 errors, 4 warnings + +you would use a :c:func:`scanf` format like :: + + %s - %d errors, %d warnings + +The equivalent regular expression would be :: + + (\S+) - (\d+) errors, (\d+) warnings + + +.. _search-vs-match: + +search() vs. match() +^^^^^^^^^^^^^^^^^^^^ + +.. sectionauthor:: Fred L. Drake, Jr. + +Python offers two different primitive operations based on regular expressions: +:func:`re.match` checks for a match only at the beginning of the string, while +:func:`re.search` checks for a match anywhere in the string (this is what Perl +does by default). + +For example:: + + >>> re.match("c", "abcdef") # No match + >>> re.search("c", "abcdef") # Match + + +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.search("^a", "abcdef") # Match + + +Note however that in :const:`MULTILINE` mode :func:`match` only matches at the +beginning of the string, whereas using :func:`search` with a regular expression +beginning with ``'^'`` will match at the beginning of each line. :: + + >>> re.match('X', 'A\nB\nX', re.MULTILINE) # No match + >>> re.search('^X', 'A\nB\nX', re.MULTILINE) # Match + + + +Making a Phonebook +^^^^^^^^^^^^^^^^^^ + +:func:`split` splits a string into a list delimited by the passed pattern. The +method is invaluable for converting textual data into data structures that can be +easily read and modified by Python as demonstrated in the following example that +creates a phonebook. + +First, here is the input. Normally it may come from a file, here we are using +triple-quoted string syntax:: + + >>> text = """Ross McFluff: 834.345.1254 155 Elm Street + ... + ... Ronald Heathmore: 892.345.3428 436 Finley Avenue + ... Frank Burger: 925.541.7625 662 South Dogwood Way + ... + ... + ... Heather Albrecht: 548.326.4584 919 Park Place""" + +The entries are separated by one or more newlines. Now we convert the string +into a list with each nonempty line having its own entry: + +.. doctest:: + :options: +NORMALIZE_WHITESPACE + + >>> entries = re.split("\n+", text) + >>> entries + ['Ross McFluff: 834.345.1254 155 Elm Street', + 'Ronald Heathmore: 892.345.3428 436 Finley Avenue', + 'Frank Burger: 925.541.7625 662 South Dogwood Way', + 'Heather Albrecht: 548.326.4584 919 Park Place'] + +Finally, split each entry into a list with first name, last name, telephone +number, and address. We use the ``maxsplit`` parameter of :func:`split` +because the address has spaces, our splitting pattern, in it: + +.. doctest:: + :options: +NORMALIZE_WHITESPACE + + >>> [re.split(":? ", entry, 3) for entry in entries] + [['Ross', 'McFluff', '834.345.1254', '155 Elm Street'], + ['Ronald', 'Heathmore', '892.345.3428', '436 Finley Avenue'], + ['Frank', 'Burger', '925.541.7625', '662 South Dogwood Way'], + ['Heather', 'Albrecht', '548.326.4584', '919 Park Place']] + +The ``:?`` pattern matches the colon after the last name, so that it does not +occur in the result list. With a ``maxsplit`` of ``4``, we could separate the +house number from the street name: + +.. doctest:: + :options: +NORMALIZE_WHITESPACE + + >>> [re.split(":? ", entry, 4) for entry in entries] + [['Ross', 'McFluff', '834.345.1254', '155', 'Elm Street'], + ['Ronald', 'Heathmore', '892.345.3428', '436', 'Finley Avenue'], + ['Frank', 'Burger', '925.541.7625', '662', 'South Dogwood Way'], + ['Heather', 'Albrecht', '548.326.4584', '919', 'Park Place']] + + +Text Munging +^^^^^^^^^^^^ + +:func:`sub` replaces every occurrence of a pattern with a string or the +result of a function. This example demonstrates using :func:`sub` with +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) + >>> text = "Professor Abdolmalek, please report your absences promptly." + >>> re.sub(r"(\w)(\w+)(\w)", repl, text) + 'Poefsrosr Aealmlobdk, pslaee reorpt your abnseces plmrptoy.' + >>> re.sub(r"(\w)(\w+)(\w)", repl, text) + 'Pofsroser Aodlambelk, plasee reoprt yuor asnebces potlmrpy.' + + +Finding all Adverbs +^^^^^^^^^^^^^^^^^^^ + +:func:`findall` matches *all* occurrences of a pattern, not just the first +one as :func:`search` does. For example, if a writer wanted to +find all of the adverbs in some text, they might use :func:`findall` in +the following manner:: + + >>> text = "He was carefully disguised but captured quickly by police." + >>> re.findall(r"\w+ly", text) + ['carefully', 'quickly'] + + +Finding all Adverbs and their Positions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If one wants more information about all matches of a pattern than the matched +text, :func:`finditer` is useful as it provides :ref:`match objects +` instead of strings. Continuing with the previous example, if +a writer wanted to find all of the adverbs *and their positions* in +some text, they would use :func:`finditer` in the following manner:: + + >>> text = "He was carefully disguised but captured quickly by police." + >>> for m in re.finditer(r"\w+ly", text): + ... print('%02d-%02d: %s' % (m.start(), m.end(), m.group(0))) + 07-16: carefully + 40-47: quickly + + +Raw String Notation +^^^^^^^^^^^^^^^^^^^ + +Raw string notation (``r"text"``) keeps regular expressions sane. Without it, +every backslash (``'\'``) in a regular expression would have to be prefixed with +another one to escape it. For example, the two following lines of code are +functionally identical:: + + >>> re.match(r"\W(.)\1\W", " ff ") + + >>> re.match("\\W(.)\\1\\W", " ff ") + + +When one wants to match a literal backslash, it must be escaped in the regular +expression. With raw string notation, this means ``r"\\"``. Without raw string +notation, one must use ``"\\\\"``, making the following lines of code +functionally identical:: + + >>> re.match(r"\\", r"\\") + + >>> re.match("\\\\", r"\\") + + + +Writing a Tokenizer +^^^^^^^^^^^^^^^^^^^ + +A `tokenizer or scanner `_ +analyzes a string to categorize groups of characters. This is a useful first +step in writing a compiler or interpreter. + +The text categories are specified with regular expressions. The technique is +to combine those into a single master regular expression and to loop over +successive matches:: + + import collections + import re + + Token = collections.namedtuple('Token', ['type', 'value', 'line', 'column']) + + 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 + ] + tok_regex = '|'.join('(?P<%s>%s)' % pair for pair in token_specification) + line_num = 1 + line_start = 0 + for mo in re.finditer(tok_regex, code): + kind = mo.lastgroup + value = mo.group() + column = mo.start() - line_start + if kind == 'NUMBER': + value = float(value) if '.' in value else int(value) + elif kind == 'ID' and value in keywords: + kind = value + elif kind == 'NEWLINE': + line_start = mo.end() + line_num += 1 + continue + elif kind == 'SKIP': + continue + elif kind == 'MISMATCH': + raise RuntimeError(f'{value!r} unexpected on line {line_num}') + yield Token(kind, value, line_num, column) + + statements = ''' + IF quantity THEN + total := total + price * quantity; + tax := price * 0.05; + ENDIF; + ''' + + for token in tokenize(statements): + print(token) + +The tokenizer produces the following output:: + + Token(type='IF', value='IF', line=2, column=4) + Token(type='ID', value='quantity', line=2, column=7) + Token(type='THEN', value='THEN', line=2, column=16) + Token(type='ID', value='total', line=3, column=8) + Token(type='ASSIGN', value=':=', line=3, column=14) + Token(type='ID', value='total', line=3, column=17) + Token(type='OP', value='+', line=3, column=23) + Token(type='ID', value='price', line=3, column=25) + Token(type='OP', value='*', line=3, column=31) + Token(type='ID', value='quantity', line=3, column=33) + Token(type='END', value=';', line=3, column=41) + Token(type='ID', value='tax', line=4, column=8) + Token(type='ASSIGN', value=':=', line=4, column=12) + Token(type='ID', value='price', line=4, column=15) + Token(type='OP', value='*', line=4, column=21) + Token(type='NUMBER', value=0.05, line=4, column=23) + Token(type='END', value=';', line=4, column=27) + Token(type='ENDIF', value='ENDIF', line=5, column=4) + Token(type='END', value=';', line=5, column=9) + + +.. [Frie09] Friedl, Jeffrey. Mastering Regular Expressions. 3rd ed., O'Reilly + Media, 2009. The third edition of the book no longer covers Python at all, + but the first edition covered writing good regular expression patterns in + great detail. diff --git a/python-3.7.4-docs-html/_sources/library/readline.rst.txt b/python-3.7.4-docs-html/_sources/library/readline.rst.txt new file mode 100644 index 0000000..eae0a6d --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/readline.rst.txt @@ -0,0 +1,359 @@ +:mod:`readline` --- GNU readline interface +========================================== + +.. module:: readline + :platform: Unix + :synopsis: GNU readline support for Python. + +.. sectionauthor:: Skip Montanaro + +-------------- + +The :mod:`readline` module defines a number of functions to facilitate +completion and reading/writing of history files from the Python interpreter. +This module can be used directly, or via the :mod:`rlcompleter` module, which +supports completion of Python identifiers at the interactive prompt. Settings +made using this module affect the behaviour of both the interpreter's +interactive prompt and the prompts offered by the built-in :func:`input` +function. + +Readline keybindings may be configured via an initialization file, typically +``.inputrc`` in your home directory. See `Readline Init File +`_ +in the GNU Readline manual for information about the format and +allowable constructs of that file, and the capabilities of the +Readline library in general. + +.. note:: + + The underlying Readline library API may be implemented by + the ``libedit`` library instead of GNU readline. + On macOS the :mod:`readline` module detects which library is being used + at run time. + + The configuration file for ``libedit`` is different from that + of GNU readline. If you programmatically load configuration strings + you can check for the text "libedit" in :const:`readline.__doc__` + to differentiate between GNU readline and libedit. + + If you use *editline*/``libedit`` readline emulation on macOS, the + initialization file located in your home directory is named + ``.editrc``. For example, the following content in ``~/.editrc`` will + turn ON *vi* keybindings and TAB completion:: + + python:bind -v + python:bind ^I rl_complete + + +Init file +--------- + +The following functions relate to the init file and user configuration: + + +.. function:: parse_and_bind(string) + + Execute the init line provided in the *string* argument. This calls + :c:func:`rl_parse_and_bind` in the underlying library. + + +.. function:: read_init_file([filename]) + + Execute a readline initialization file. The default filename is the last filename + used. This calls :c:func:`rl_read_init_file` in the underlying library. + + +Line buffer +----------- + +The following functions operate on the line buffer: + + +.. function:: get_line_buffer() + + Return the current contents of the line buffer (:c:data:`rl_line_buffer` + in the underlying library). + + +.. function:: insert_text(string) + + Insert text into the line buffer at the cursor position. This calls + :c:func:`rl_insert_text` in the underlying library, but ignores + the return value. + + +.. function:: redisplay() + + Change what's displayed on the screen to reflect the current contents of the + line buffer. This calls :c:func:`rl_redisplay` in the underlying library. + + +History file +------------ + +The following functions operate on a history file: + + +.. function:: read_history_file([filename]) + + Load a readline history file, and append it to the history list. + The default filename is :file:`~/.history`. This calls + :c:func:`read_history` in the underlying library. + + +.. function:: write_history_file([filename]) + + Save the history list to a readline history file, overwriting any + existing file. The default filename is :file:`~/.history`. This calls + :c:func:`write_history` in the underlying library. + + +.. function:: append_history_file(nelements[, filename]) + + Append the last *nelements* items of history to a file. The default filename is + :file:`~/.history`. The file must already exist. This calls + :c:func:`append_history` in the underlying library. This function + only exists if Python was compiled for a version of the library + that supports it. + + .. versionadded:: 3.5 + + +.. function:: get_history_length() + set_history_length(length) + + Set or return the desired number of lines to save in the history file. + The :func:`write_history_file` function uses this value to truncate + the history file, by calling :c:func:`history_truncate_file` in + the underlying library. Negative values imply + unlimited history file size. + + +History list +------------ + +The following functions operate on a global history list: + + +.. function:: clear_history() + + Clear the current history. This calls :c:func:`clear_history` in the + underlying library. The Python function only exists if Python was + compiled for a version of the library that supports it. + + +.. function:: get_current_history_length() + + Return the number of items currently in the history. (This is different from + :func:`get_history_length`, which returns the maximum number of lines that will + be written to a history file.) + + +.. function:: get_history_item(index) + + Return the current contents of history item at *index*. The item index + is one-based. This calls :c:func:`history_get` in the underlying library. + + +.. function:: remove_history_item(pos) + + Remove history item specified by its position from the history. + The position is zero-based. This calls :c:func:`remove_history` in + the underlying library. + + +.. function:: replace_history_item(pos, line) + + Replace history item specified by its position with *line*. + The position is zero-based. This calls :c:func:`replace_history_entry` + in the underlying library. + + +.. function:: add_history(line) + + Append *line* to the history buffer, as if it was the last line typed. + This calls :c:func:`add_history` in the underlying library. + + +.. function:: set_auto_history(enabled) + + Enable or disable automatic calls to :c:func:`add_history` when reading + input via readline. The *enabled* argument should be a Boolean value + that when true, enables auto history, and that when false, disables + auto history. + + .. versionadded:: 3.6 + + .. impl-detail:: + Auto history is enabled by default, and changes to this do not persist + across multiple sessions. + + +Startup hooks +------------- + + +.. function:: set_startup_hook([function]) + + Set or remove the function invoked by the :c:data:`rl_startup_hook` + callback of the underlying library. If *function* is specified, it will + be used as the new hook function; if omitted or ``None``, any function + already installed is removed. The hook is called with no + arguments just before readline prints the first prompt. + + +.. function:: set_pre_input_hook([function]) + + Set or remove the function invoked by the :c:data:`rl_pre_input_hook` + callback of the underlying library. If *function* is specified, it will + be used as the new hook function; if omitted or ``None``, any + function already installed is removed. The hook is called + with no arguments after the first prompt has been printed and just before + readline starts reading input characters. This function only exists + if Python was compiled for a version of the library that supports it. + + +Completion +---------- + +The following functions relate to implementing a custom word completion +function. This is typically operated by the Tab key, and can suggest and +automatically complete a word being typed. By default, Readline is set up +to be used by :mod:`rlcompleter` to complete Python identifiers for +the interactive interpreter. If the :mod:`readline` module is to be used +with a custom completer, a different set of word delimiters should be set. + + +.. function:: set_completer([function]) + + Set or remove the completer function. If *function* is specified, it will be + used as the new completer function; if omitted or ``None``, any completer + function already installed is removed. The completer function is called as + ``function(text, state)``, for *state* in ``0``, ``1``, ``2``, ..., until it + returns a non-string value. It should return the next possible completion + starting with *text*. + + The installed completer function is invoked by the *entry_func* callback + passed to :c:func:`rl_completion_matches` in the underlying library. + The *text* string comes from the first parameter to the + :c:data:`rl_attempted_completion_function` callback of the + underlying library. + + +.. function:: get_completer() + + Get the completer function, or ``None`` if no completer function has been set. + + +.. function:: get_completion_type() + + Get the type of completion being attempted. This returns the + :c:data:`rl_completion_type` variable in the underlying library as + an integer. + + +.. function:: get_begidx() + get_endidx() + + Get the beginning or ending index of the completion scope. + These indexes are the *start* and *end* arguments passed to the + :c:data:`rl_attempted_completion_function` callback of the + underlying library. + + +.. function:: set_completer_delims(string) + get_completer_delims() + + Set or get the word delimiters for completion. These determine the + start of the word to be considered for completion (the completion scope). + These functions access the :c:data:`rl_completer_word_break_characters` + variable in the underlying library. + + +.. function:: set_completion_display_matches_hook([function]) + + Set or remove the completion display function. If *function* is + specified, it will be used as the new completion display function; + if omitted or ``None``, any completion display function already + installed is removed. This sets or clears the + :c:data:`rl_completion_display_matches_hook` callback in the + underlying library. The completion display function is called as + ``function(substitution, [matches], longest_match_length)`` once + each time matches need to be displayed. + + +.. _readline-example: + +Example +------- + +The following example demonstrates how to use the :mod:`readline` module's +history reading and writing functions to automatically load and save a history +file named :file:`.python_history` from the user's home directory. The code +below would normally be executed automatically during interactive sessions +from the user's :envvar:`PYTHONSTARTUP` file. :: + + import atexit + import os + import readline + + histfile = os.path.join(os.path.expanduser("~"), ".python_history") + try: + readline.read_history_file(histfile) + # default history len is -1 (infinite), which may grow unruly + readline.set_history_length(1000) + except FileNotFoundError: + pass + + atexit.register(readline.write_history_file, histfile) + +This code is actually automatically run when Python is run in +:ref:`interactive mode ` (see :ref:`rlcompleter-config`). + +The following example achieves the same goal but supports concurrent interactive +sessions, by only appending the new history. :: + + import atexit + import os + import readline + histfile = os.path.join(os.path.expanduser("~"), ".python_history") + + try: + readline.read_history_file(histfile) + h_len = readline.get_current_history_length() + except FileNotFoundError: + open(histfile, 'wb').close() + h_len = 0 + + def save(prev_h_len, histfile): + new_h_len = readline.get_current_history_length() + readline.set_history_length(1000) + readline.append_history_file(new_h_len - prev_h_len, histfile) + atexit.register(save, h_len, histfile) + +The following example extends the :class:`code.InteractiveConsole` class to +support history save/restore. :: + + import atexit + import code + import os + import readline + + class HistoryConsole(code.InteractiveConsole): + def __init__(self, locals=None, filename="", + histfile=os.path.expanduser("~/.console-history")): + code.InteractiveConsole.__init__(self, locals, filename) + self.init_history(histfile) + + def init_history(self, histfile): + readline.parse_and_bind("tab: complete") + if hasattr(readline, "read_history_file"): + try: + readline.read_history_file(histfile) + except FileNotFoundError: + pass + atexit.register(self.save_history, histfile) + + def save_history(self, histfile): + readline.set_history_length(1000) + readline.write_history_file(histfile) diff --git a/python-3.7.4-docs-html/_sources/library/reprlib.rst.txt b/python-3.7.4-docs-html/_sources/library/reprlib.rst.txt new file mode 100644 index 0000000..1a0c1b0 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/reprlib.rst.txt @@ -0,0 +1,163 @@ +:mod:`reprlib` --- Alternate :func:`repr` implementation +======================================================== + +.. module:: reprlib + :synopsis: Alternate repr() implementation with size limits. + +.. sectionauthor:: Fred L. Drake, Jr. + +**Source code:** :source:`Lib/reprlib.py` + +-------------- + +The :mod:`reprlib` module provides a means for producing object representations +with limits on the size of the resulting strings. This is used in the Python +debugger and may be useful in other contexts as well. + +This module provides a class, an instance, and a function: + + +.. class:: Repr() + + Class which provides formatting services useful in implementing functions + similar to the built-in :func:`repr`; size limits for different object types + are added to avoid the generation of representations which are excessively long. + + +.. data:: aRepr + + This is an instance of :class:`Repr` which is used to provide the + :func:`.repr` function described below. Changing the attributes of this + object will affect the size limits used by :func:`.repr` and the Python + debugger. + + +.. function:: repr(obj) + + This is the :meth:`~Repr.repr` method of ``aRepr``. It returns a string + similar to that returned by the built-in function of the same name, but with + limits on most sizes. + +In addition to size-limiting tools, the module also provides a decorator for +detecting recursive calls to :meth:`__repr__` and substituting a placeholder +string instead. + + +.. index:: single: ...; placeholder + +.. decorator:: recursive_repr(fillvalue="...") + + Decorator for :meth:`__repr__` methods to detect recursive calls within the + same thread. If a recursive call is made, the *fillvalue* is returned, + otherwise, the usual :meth:`__repr__` call is made. For example: + + >>> from reprlib import recursive_repr + >>> class MyList(list): + ... @recursive_repr() + ... def __repr__(self): + ... return '<' + '|'.join(map(repr, self)) + '>' + ... + >>> m = MyList('abc') + >>> m.append(m) + >>> m.append('x') + >>> print(m) + <'a'|'b'|'c'|...|'x'> + + .. versionadded:: 3.2 + + +.. _repr-objects: + +Repr Objects +------------ + +:class:`Repr` instances provide several attributes which can be used to provide +size limits for the representations of different object types, and methods +which format specific object types. + + +.. attribute:: Repr.maxlevel + + Depth limit on the creation of recursive representations. The default is ``6``. + + +.. attribute:: Repr.maxdict + Repr.maxlist + Repr.maxtuple + Repr.maxset + Repr.maxfrozenset + Repr.maxdeque + Repr.maxarray + + Limits on the number of entries represented for the named object type. The + default is ``4`` for :attr:`maxdict`, ``5`` for :attr:`maxarray`, and ``6`` for + the others. + + +.. attribute:: Repr.maxlong + + Maximum number of characters in the representation for an integer. Digits + are dropped from the middle. The default is ``40``. + + +.. attribute:: Repr.maxstring + + Limit on the number of characters in the representation of the string. Note + that the "normal" representation of the string is used as the character source: + if escape sequences are needed in the representation, these may be mangled when + the representation is shortened. The default is ``30``. + + +.. attribute:: Repr.maxother + + This limit is used to control the size of object types for which no specific + formatting method is available on the :class:`Repr` object. It is applied in a + similar manner as :attr:`maxstring`. The default is ``20``. + + +.. method:: Repr.repr(obj) + + The equivalent to the built-in :func:`repr` that uses the formatting imposed by + the instance. + + +.. method:: Repr.repr1(obj, level) + + Recursive implementation used by :meth:`.repr`. This uses the type of *obj* to + determine which formatting method to call, passing it *obj* and *level*. The + type-specific methods should call :meth:`repr1` to perform recursive formatting, + with ``level - 1`` for the value of *level* in the recursive call. + + +.. method:: Repr.repr_TYPE(obj, level) + :noindex: + + Formatting methods for specific types are implemented as methods with a name + based on the type name. In the method name, **TYPE** is replaced by + ``'_'.join(type(obj).__name__.split())``. Dispatch to these methods is + handled by :meth:`repr1`. Type-specific methods which need to recursively + format a value should call ``self.repr1(subobj, level - 1)``. + + +.. _subclassing-reprs: + +Subclassing Repr Objects +------------------------ + +The use of dynamic dispatching by :meth:`Repr.repr1` allows subclasses of +:class:`Repr` to add support for additional built-in object types or to modify +the handling of types already supported. This example shows how special support +for file objects could be added:: + + import reprlib + import sys + + class MyRepr(reprlib.Repr): + + def repr_TextIOWrapper(self, obj, level): + if obj.name in {'', '', ''}: + return obj.name + return repr(obj) + + aRepr = MyRepr() + print(aRepr.repr(sys.stdin)) # prints '' diff --git a/python-3.7.4-docs-html/_sources/library/resource.rst.txt b/python-3.7.4-docs-html/_sources/library/resource.rst.txt new file mode 100644 index 0000000..bd49c87 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/resource.rst.txt @@ -0,0 +1,350 @@ +:mod:`resource` --- Resource usage information +============================================== + +.. module:: resource + :platform: Unix + :synopsis: An interface to provide resource usage information on the current process. + +.. moduleauthor:: Jeremy Hylton +.. sectionauthor:: Jeremy Hylton + +-------------- + +This module provides basic mechanisms for measuring and controlling system +resources utilized by a program. + +Symbolic constants are used to specify particular system resources and to +request usage information about either the current process or its children. + +An :exc:`OSError` is raised on syscall failure. + + +.. exception:: error + + A deprecated alias of :exc:`OSError`. + + .. versionchanged:: 3.3 + Following :pep:`3151`, this class was made an alias of :exc:`OSError`. + + +Resource Limits +--------------- + +Resources usage can be limited using the :func:`setrlimit` function described +below. Each resource is controlled by a pair of limits: a soft limit and a hard +limit. The soft limit is the current limit, and may be lowered or raised by a +process over time. The soft limit can never exceed the hard limit. The hard +limit can be lowered to any value greater than the soft limit, but not raised. +(Only processes with the effective UID of the super-user can raise a hard +limit.) + +The specific resources that can be limited are system dependent. They are +described in the :manpage:`getrlimit(2)` man page. The resources listed below +are supported when the underlying operating system supports them; resources +which cannot be checked or controlled by the operating system are not defined in +this module for those platforms. + + +.. data:: RLIM_INFINITY + + Constant used to represent the limit for an unlimited resource. + + +.. function:: getrlimit(resource) + + Returns a tuple ``(soft, hard)`` with the current soft and hard limits of + *resource*. Raises :exc:`ValueError` if an invalid resource is specified, or + :exc:`error` if the underlying system call fails unexpectedly. + + +.. function:: setrlimit(resource, limits) + + Sets new limits of consumption of *resource*. The *limits* argument must be a + tuple ``(soft, hard)`` of two integers describing the new limits. A value of + :data:`~resource.RLIM_INFINITY` can be used to request a limit that is + unlimited. + + Raises :exc:`ValueError` if an invalid resource is specified, if the new soft + limit exceeds the hard limit, or if a process tries to raise its hard limit. + Specifying a limit of :data:`~resource.RLIM_INFINITY` when the hard or + system limit for that resource is not unlimited will result in a + :exc:`ValueError`. A process with the effective UID of super-user can + request any valid limit value, including unlimited, but :exc:`ValueError` + will still be raised if the requested limit exceeds the system imposed + limit. + + ``setrlimit`` may also raise :exc:`error` if the underlying system call + fails. + +.. function:: prlimit(pid, resource[, limits]) + + Combines :func:`setrlimit` and :func:`getrlimit` in one function and + supports to get and set the resources limits of an arbitrary process. If + *pid* is 0, then the call applies to the current process. *resource* and + *limits* have the same meaning as in :func:`setrlimit`, except that + *limits* is optional. + + When *limits* is not given the function returns the *resource* limit of the + process *pid*. When *limits* is given the *resource* limit of the process is + set and the former resource limit is returned. + + Raises :exc:`ProcessLookupError` when *pid* can't be found and + :exc:`PermissionError` when the user doesn't have ``CAP_SYS_RESOURCE`` for + the process. + + .. availability:: Linux 2.6.36 or later with glibc 2.13 or later. + + .. versionadded:: 3.4 + + +These symbols define resources whose consumption can be controlled using the +:func:`setrlimit` and :func:`getrlimit` functions described below. The values of +these symbols are exactly the constants used by C programs. + +The Unix man page for :manpage:`getrlimit(2)` lists the available resources. +Note that not all systems use the same symbol or same value to denote the same +resource. This module does not attempt to mask platform differences --- symbols +not defined for a platform will not be available from this module on that +platform. + + +.. data:: RLIMIT_CORE + + The maximum size (in bytes) of a core file that the current process can create. + This may result in the creation of a partial core file if a larger core would be + required to contain the entire process image. + + +.. data:: RLIMIT_CPU + + The maximum amount of processor time (in seconds) that a process can use. If + this limit is exceeded, a :const:`SIGXCPU` signal is sent to the process. (See + the :mod:`signal` module documentation for information about how to catch this + signal and do something useful, e.g. flush open files to disk.) + + +.. data:: RLIMIT_FSIZE + + The maximum size of a file which the process may create. + + +.. data:: RLIMIT_DATA + + The maximum size (in bytes) of the process's heap. + + +.. data:: RLIMIT_STACK + + The maximum size (in bytes) of the call stack for the current process. This only + affects the stack of the main thread in a multi-threaded process. + + +.. data:: RLIMIT_RSS + + The maximum resident set size that should be made available to the process. + + +.. data:: RLIMIT_NPROC + + The maximum number of processes the current process may create. + + +.. data:: RLIMIT_NOFILE + + The maximum number of open file descriptors for the current process. + + +.. data:: RLIMIT_OFILE + + The BSD name for :const:`RLIMIT_NOFILE`. + + +.. data:: RLIMIT_MEMLOCK + + The maximum address space which may be locked in memory. + + +.. data:: RLIMIT_VMEM + + The largest area of mapped memory which the process may occupy. + + +.. data:: RLIMIT_AS + + The maximum area (in bytes) of address space which may be taken by the process. + + +.. data:: RLIMIT_MSGQUEUE + + The number of bytes that can be allocated for POSIX message queues. + + .. availability:: Linux 2.6.8 or later. + + .. versionadded:: 3.4 + + +.. data:: RLIMIT_NICE + + The ceiling for the process's nice level (calculated as 20 - rlim_cur). + + .. availability:: Linux 2.6.12 or later. + + .. versionadded:: 3.4 + + +.. data:: RLIMIT_RTPRIO + + The ceiling of the real-time priority. + + .. availability:: Linux 2.6.12 or later. + + .. versionadded:: 3.4 + + +.. data:: RLIMIT_RTTIME + + The time limit (in microseconds) on CPU time that a process can spend + under real-time scheduling without making a blocking syscall. + + .. availability:: Linux 2.6.25 or later. + + .. versionadded:: 3.4 + + +.. data:: RLIMIT_SIGPENDING + + The number of signals which the process may queue. + + .. availability:: Linux 2.6.8 or later. + + .. versionadded:: 3.4 + +.. data:: RLIMIT_SBSIZE + + The maximum size (in bytes) of socket buffer usage for this user. + This limits the amount of network memory, and hence the amount of mbufs, + that this user may hold at any time. + + .. availability:: FreeBSD 9 or later. + + .. versionadded:: 3.4 + +.. data:: RLIMIT_SWAP + + The maximum size (in bytes) of the swap space that may be reserved or + used by all of this user id's processes. + This limit is enforced only if bit 1 of the vm.overcommit sysctl is set. + Please see :manpage:`tuning(7)` for a complete description of this sysctl. + + .. availability:: FreeBSD 9 or later. + + .. versionadded:: 3.4 + +.. data:: RLIMIT_NPTS + + The maximum number of pseudo-terminals created by this user id. + + .. availability:: FreeBSD 9 or later. + + .. versionadded:: 3.4 + +Resource Usage +-------------- + +These functions are used to retrieve resource usage information: + + +.. function:: getrusage(who) + + This function returns an object that describes the resources consumed by either + the current process or its children, as specified by the *who* parameter. The + *who* parameter should be specified using one of the :const:`RUSAGE_\*` + constants described below. + + The fields of the return value each describe how a particular system resource + has been used, e.g. amount of time spent running is user mode or number of times + the process was swapped out of main memory. Some values are dependent on the + clock tick internal, e.g. the amount of memory the process is using. + + For backward compatibility, the return value is also accessible as a tuple of 16 + elements. + + The fields :attr:`ru_utime` and :attr:`ru_stime` of the return value are + floating point values representing the amount of time spent executing in user + mode and the amount of time spent executing in system mode, respectively. The + remaining values are integers. Consult the :manpage:`getrusage(2)` man page for + detailed information about these values. A brief summary is presented here: + + +--------+---------------------+-------------------------------+ + | Index | Field | Resource | + +========+=====================+===============================+ + | ``0`` | :attr:`ru_utime` | time in user mode (float) | + +--------+---------------------+-------------------------------+ + | ``1`` | :attr:`ru_stime` | time in system mode (float) | + +--------+---------------------+-------------------------------+ + | ``2`` | :attr:`ru_maxrss` | maximum resident set size | + +--------+---------------------+-------------------------------+ + | ``3`` | :attr:`ru_ixrss` | shared memory size | + +--------+---------------------+-------------------------------+ + | ``4`` | :attr:`ru_idrss` | unshared memory size | + +--------+---------------------+-------------------------------+ + | ``5`` | :attr:`ru_isrss` | unshared stack size | + +--------+---------------------+-------------------------------+ + | ``6`` | :attr:`ru_minflt` | page faults not requiring I/O | + +--------+---------------------+-------------------------------+ + | ``7`` | :attr:`ru_majflt` | page faults requiring I/O | + +--------+---------------------+-------------------------------+ + | ``8`` | :attr:`ru_nswap` | number of swap outs | + +--------+---------------------+-------------------------------+ + | ``9`` | :attr:`ru_inblock` | block input operations | + +--------+---------------------+-------------------------------+ + | ``10`` | :attr:`ru_oublock` | block output operations | + +--------+---------------------+-------------------------------+ + | ``11`` | :attr:`ru_msgsnd` | messages sent | + +--------+---------------------+-------------------------------+ + | ``12`` | :attr:`ru_msgrcv` | messages received | + +--------+---------------------+-------------------------------+ + | ``13`` | :attr:`ru_nsignals` | signals received | + +--------+---------------------+-------------------------------+ + | ``14`` | :attr:`ru_nvcsw` | voluntary context switches | + +--------+---------------------+-------------------------------+ + | ``15`` | :attr:`ru_nivcsw` | involuntary context switches | + +--------+---------------------+-------------------------------+ + + This function will raise a :exc:`ValueError` if an invalid *who* parameter is + specified. It may also raise :exc:`error` exception in unusual circumstances. + + +.. function:: getpagesize() + + Returns the number of bytes in a system page. (This need not be the same as the + hardware page size.) + +The following :const:`RUSAGE_\*` symbols are passed to the :func:`getrusage` +function to specify which processes information should be provided for. + + +.. data:: RUSAGE_SELF + + Pass to :func:`getrusage` to request resources consumed by the calling + process, which is the sum of resources used by all threads in the process. + + +.. data:: RUSAGE_CHILDREN + + Pass to :func:`getrusage` to request resources consumed by child processes + of the calling process which have been terminated and waited for. + + +.. data:: RUSAGE_BOTH + + Pass to :func:`getrusage` to request resources consumed by both the current + process and child processes. May not be available on all systems. + + +.. data:: RUSAGE_THREAD + + Pass to :func:`getrusage` to request resources consumed by the current + thread. May not be available on all systems. + + .. versionadded:: 3.2 diff --git a/python-3.7.4-docs-html/_sources/library/rlcompleter.rst.txt b/python-3.7.4-docs-html/_sources/library/rlcompleter.rst.txt new file mode 100644 index 0000000..40b09ce --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/rlcompleter.rst.txt @@ -0,0 +1,61 @@ +:mod:`rlcompleter` --- Completion function for GNU readline +=========================================================== + +.. module:: rlcompleter + :synopsis: Python identifier completion, suitable for the GNU readline library. + +.. sectionauthor:: Moshe Zadka + +**Source code:** :source:`Lib/rlcompleter.py` + +-------------- + +The :mod:`rlcompleter` module defines a completion function suitable for the +:mod:`readline` module by completing valid Python identifiers and keywords. + +When this module is imported on a Unix platform with the :mod:`readline` module +available, an instance of the :class:`Completer` class is automatically created +and its :meth:`complete` method is set as the :mod:`readline` completer. + +Example:: + + >>> import rlcompleter + >>> import readline + >>> readline.parse_and_bind("tab: complete") + >>> readline. + readline.__doc__ readline.get_line_buffer( readline.read_init_file( + readline.__file__ readline.insert_text( readline.set_completer( + readline.__name__ readline.parse_and_bind( + >>> readline. + +The :mod:`rlcompleter` module is designed for use with Python's +:ref:`interactive mode `. Unless Python is run with the +:option:`-S` option, the module is automatically imported and configured +(see :ref:`rlcompleter-config`). + +On platforms without :mod:`readline`, the :class:`Completer` class defined by +this module can still be used for custom purposes. + + +.. _completer-objects: + +Completer Objects +----------------- + +Completer objects have the following method: + + +.. method:: Completer.complete(text, state) + + Return the *state*\ th completion for *text*. + + If called for *text* that doesn't include a period character (``'.'``), it will + complete from names currently defined in :mod:`__main__`, :mod:`builtins` and + keywords (as defined by the :mod:`keyword` module). + + If called for a dotted name, it will try to evaluate anything without obvious + side-effects (functions will not be evaluated, but it can generate calls to + :meth:`__getattr__`) up to the last part, and find matches for the rest via the + :func:`dir` function. Any exception raised during the evaluation of the + expression is caught, silenced and :const:`None` is returned. + diff --git a/python-3.7.4-docs-html/_sources/library/runpy.rst.txt b/python-3.7.4-docs-html/_sources/library/runpy.rst.txt new file mode 100644 index 0000000..af35e81 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/runpy.rst.txt @@ -0,0 +1,179 @@ +:mod:`runpy` --- Locating and executing Python modules +====================================================== + +.. module:: runpy + :synopsis: Locate and run Python modules without importing them first. + +.. moduleauthor:: Nick Coghlan + +**Source code:** :source:`Lib/runpy.py` + +-------------- + +The :mod:`runpy` module is used to locate and run Python modules without +importing them first. Its main use is to implement the :option:`-m` command +line switch that allows scripts to be located using the Python module +namespace rather than the filesystem. + +Note that this is *not* a sandbox module - all code is executed in the +current process, and any side effects (such as cached imports of other +modules) will remain in place after the functions have returned. + +Furthermore, any functions and classes defined by the executed code are not +guaranteed to work correctly after a :mod:`runpy` function has returned. +If that limitation is not acceptable for a given use case, :mod:`importlib` +is likely to be a more suitable choice than this module. + +The :mod:`runpy` module provides two functions: + + +.. function:: run_module(mod_name, init_globals=None, run_name=None, alter_sys=False) + + .. index:: + module: __main__ + + Execute the code of the specified module and return the resulting module + globals dictionary. The module's code is first located using the standard + import mechanism (refer to :pep:`302` for details) and then executed in a + fresh module namespace. + + The *mod_name* argument should be an absolute module name. + If the module name refers to a package rather than a normal + module, then that package is imported and the ``__main__`` submodule within + that package is then executed and the resulting module globals dictionary + returned. + + The optional dictionary argument *init_globals* may be used to pre-populate + the module's globals dictionary before the code is executed. The supplied + dictionary will not be modified. If any of the special global variables + below are defined in the supplied dictionary, those definitions are + overridden by :func:`run_module`. + + The special global variables ``__name__``, ``__spec__``, ``__file__``, + ``__cached__``, ``__loader__`` and ``__package__`` are set in the globals + dictionary before the module code is executed (Note that this is a + minimal set of variables - other variables may be set implicitly as an + interpreter implementation detail). + + ``__name__`` is set to *run_name* if this optional argument is not + :const:`None`, to ``mod_name + '.__main__'`` if the named module is a + package and to the *mod_name* argument otherwise. + + ``__spec__`` will be set appropriately for the *actually* imported + module (that is, ``__spec__.name`` will always be *mod_name* or + ``mod_name + '.__main__``, never *run_name*). + + ``__file__``, ``__cached__``, ``__loader__`` and ``__package__`` are + :ref:`set as normal ` based on the module spec. + + If the argument *alter_sys* is supplied and evaluates to :const:`True`, + then ``sys.argv[0]`` is updated with the value of ``__file__`` and + ``sys.modules[__name__]`` is updated with a temporary module object for the + module being executed. Both ``sys.argv[0]`` and ``sys.modules[__name__]`` + are restored to their original values before the function returns. + + Note that this manipulation of :mod:`sys` is not thread-safe. Other threads + may see the partially initialised module, as well as the altered list of + arguments. It is recommended that the :mod:`sys` module be left alone when + invoking this function from threaded code. + + .. seealso:: + The :option:`-m` option offering equivalent functionality from the + command line. + + .. versionchanged:: 3.1 + Added ability to execute packages by looking for a ``__main__`` submodule. + + .. versionchanged:: 3.2 + Added ``__cached__`` global variable (see :pep:`3147`). + + .. versionchanged:: 3.4 + Updated to take advantage of the module spec feature added by + :pep:`451`. This allows ``__cached__`` to be set correctly for modules + run this way, as well as ensuring the real module name is always + accessible as ``__spec__.name``. + +.. function:: run_path(file_path, init_globals=None, run_name=None) + + .. index:: + module: __main__ + + Execute the code at the named filesystem location and return the resulting + module globals dictionary. As with a script name supplied to the CPython + command line, the supplied path may refer to a Python source file, a + compiled bytecode file or a valid sys.path entry containing a ``__main__`` + module (e.g. a zipfile containing a top-level ``__main__.py`` file). + + For a simple script, the specified code is simply executed in a fresh + module namespace. For a valid sys.path entry (typically a zipfile or + directory), the entry is first added to the beginning of ``sys.path``. The + function then looks for and executes a :mod:`__main__` module using the + updated path. Note that there is no special protection against invoking + an existing :mod:`__main__` entry located elsewhere on ``sys.path`` if + there is no such module at the specified location. + + The optional dictionary argument *init_globals* may be used to pre-populate + the module's globals dictionary before the code is executed. The supplied + dictionary will not be modified. If any of the special global variables + below are defined in the supplied dictionary, those definitions are + overridden by :func:`run_path`. + + The special global variables ``__name__``, ``__spec__``, ``__file__``, + ``__cached__``, ``__loader__`` and ``__package__`` are set in the globals + dictionary before the module code is executed (Note that this is a + minimal set of variables - other variables may be set implicitly as an + interpreter implementation detail). + + ``__name__`` is set to *run_name* if this optional argument is not + :const:`None` and to ``''`` otherwise. + + If the supplied path directly references a script file (whether as source + or as precompiled byte code), then ``__file__`` will be set to the + supplied path, and ``__spec__``, ``__cached__``, ``__loader__`` and + ``__package__`` will all be set to :const:`None`. + + If the supplied path is a reference to a valid sys.path entry, then + ``__spec__`` will be set appropriately for the imported ``__main__`` + module (that is, ``__spec__.name`` will always be ``__main__``). + ``__file__``, ``__cached__``, ``__loader__`` and ``__package__`` will be + :ref:`set as normal ` based on the module spec. + + A number of alterations are also made to the :mod:`sys` module. Firstly, + ``sys.path`` may be altered as described above. ``sys.argv[0]`` is updated + with the value of ``file_path`` and ``sys.modules[__name__]`` is updated + with a temporary module object for the module being executed. All + modifications to items in :mod:`sys` are reverted before the function + returns. + + Note that, unlike :func:`run_module`, the alterations made to :mod:`sys` + are not optional in this function as these adjustments are essential to + allowing the execution of sys.path entries. As the thread-safety + limitations still apply, use of this function in threaded code should be + either serialised with the import lock or delegated to a separate process. + + .. seealso:: + :ref:`using-on-interface-options` for equivalent functionality on the + command line (``python path/to/script``). + + .. versionadded:: 3.2 + + .. versionchanged:: 3.4 + Updated to take advantage of the module spec feature added by + :pep:`451`. This allows ``__cached__`` to be set correctly in the + case where ``__main__`` is imported from a valid sys.path entry rather + than being executed directly. + +.. seealso:: + + :pep:`338` -- Executing modules as scripts + PEP written and implemented by Nick Coghlan. + + :pep:`366` -- Main module explicit relative imports + PEP written and implemented by Nick Coghlan. + + :pep:`451` -- A ModuleSpec Type for the Import System + PEP written and implemented by Eric Snow + + :ref:`using-on-general` - CPython command line details + + The :func:`importlib.import_module` function diff --git a/python-3.7.4-docs-html/_sources/library/sched.rst.txt b/python-3.7.4-docs-html/_sources/library/sched.rst.txt new file mode 100644 index 0000000..03753af --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/sched.rst.txt @@ -0,0 +1,137 @@ +:mod:`sched` --- Event scheduler +================================ + +.. module:: sched + :synopsis: General purpose event scheduler. + +.. sectionauthor:: Moshe Zadka + +**Source code:** :source:`Lib/sched.py` + +.. index:: single: event scheduling + +-------------- + +The :mod:`sched` module defines a class which implements a general purpose event +scheduler: + +.. class:: scheduler(timefunc=time.monotonic, delayfunc=time.sleep) + + The :class:`scheduler` class defines a generic interface to scheduling events. + It needs two functions to actually deal with the "outside world" --- *timefunc* + should be callable without arguments, and return a number (the "time", in any + units whatsoever). The *delayfunc* function should be callable with one + argument, compatible with the output of *timefunc*, and should delay that many + time units. *delayfunc* will also be called with the argument ``0`` after each + event is run to allow other threads an opportunity to run in multi-threaded + applications. + + .. versionchanged:: 3.3 + *timefunc* and *delayfunc* parameters are optional. + + .. versionchanged:: 3.3 + :class:`scheduler` class can be safely used in multi-threaded + environments. + +Example:: + + >>> import sched, time + >>> s = sched.scheduler(time.time, time.sleep) + >>> def print_time(a='default'): + ... print("From print_time", time.time(), a) + ... + >>> def print_some_times(): + ... print(time.time()) + ... s.enter(10, 1, print_time) + ... s.enter(5, 2, print_time, argument=('positional',)) + ... s.enter(5, 1, print_time, kwargs={'a': 'keyword'}) + ... s.run() + ... print(time.time()) + ... + >>> print_some_times() + 930343690.257 + From print_time 930343695.274 positional + From print_time 930343695.275 keyword + From print_time 930343700.273 default + 930343700.276 + +.. _scheduler-objects: + +Scheduler Objects +----------------- + +:class:`scheduler` instances have the following methods and attributes: + + +.. method:: scheduler.enterabs(time, priority, action, argument=(), kwargs={}) + + Schedule a new event. The *time* argument should be a numeric type compatible + with the return value of the *timefunc* function passed to the constructor. + Events scheduled for the same *time* will be executed in the order of their + *priority*. A lower number represents a higher priority. + + Executing the event means executing ``action(*argument, **kwargs)``. + *argument* is a sequence holding the positional arguments for *action*. + *kwargs* is a dictionary holding the keyword arguments for *action*. + + Return value is an event which may be used for later cancellation of the event + (see :meth:`cancel`). + + .. versionchanged:: 3.3 + *argument* parameter is optional. + + .. versionadded:: 3.3 + *kwargs* parameter was added. + + +.. method:: scheduler.enter(delay, priority, action, argument=(), kwargs={}) + + Schedule an event for *delay* more time units. Other than the relative time, the + other arguments, the effect and the return value are the same as those for + :meth:`enterabs`. + + .. versionchanged:: 3.3 + *argument* parameter is optional. + + .. versionadded:: 3.3 + *kwargs* parameter was added. + +.. method:: scheduler.cancel(event) + + Remove the event from the queue. If *event* is not an event currently in the + queue, this method will raise a :exc:`ValueError`. + + +.. method:: scheduler.empty() + + Return true if the event queue is empty. + + +.. method:: scheduler.run(blocking=True) + + Run all scheduled events. This method will wait (using the :func:`delayfunc` + function passed to the constructor) for the next event, then execute it and so + on until there are no more scheduled events. + + If *blocking* is false executes the scheduled events due to expire soonest + (if any) and then return the deadline of the next scheduled call in the + scheduler (if any). + + Either *action* or *delayfunc* can raise an exception. In either case, the + scheduler will maintain a consistent state and propagate the exception. If an + exception is raised by *action*, the event will not be attempted in future calls + to :meth:`run`. + + If a sequence of events takes longer to run than the time available before the + next event, the scheduler will simply fall behind. No events will be dropped; + the calling code is responsible for canceling events which are no longer + pertinent. + + .. versionadded:: 3.3 + *blocking* parameter was added. + +.. attribute:: scheduler.queue + + Read-only attribute returning a list of upcoming events in the order they + will be run. Each event is shown as a :term:`named tuple` with the + following fields: time, priority, action, argument, kwargs. diff --git a/python-3.7.4-docs-html/_sources/library/secrets.rst.txt b/python-3.7.4-docs-html/_sources/library/secrets.rst.txt new file mode 100644 index 0000000..28ce472 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/secrets.rst.txt @@ -0,0 +1,198 @@ +:mod:`secrets` --- Generate secure random numbers for managing secrets +====================================================================== + +.. module:: secrets + :synopsis: Generate secure random numbers for managing secrets. + +.. moduleauthor:: Steven D'Aprano +.. sectionauthor:: Steven D'Aprano +.. versionadded:: 3.6 + +.. testsetup:: + + from secrets import * + __name__ = '' + +**Source code:** :source:`Lib/secrets.py` + +------------- + +The :mod:`secrets` module is used for generating cryptographically strong +random numbers suitable for managing data such as passwords, account +authentication, security tokens, and related secrets. + +In particularly, :mod:`secrets` should be used in preference to the +default pseudo-random number generator in the :mod:`random` module, which +is designed for modelling and simulation, not security or cryptography. + +.. seealso:: + + :pep:`506` + + +Random numbers +-------------- + +The :mod:`secrets` module provides access to the most secure source of +randomness that your operating system provides. + +.. class:: SystemRandom + + A class for generating random numbers using the highest-quality + sources provided by the operating system. See + :class:`random.SystemRandom` for additional details. + +.. function:: choice(sequence) + + Return a randomly-chosen element from a non-empty sequence. + +.. function:: randbelow(n) + + Return a random int in the range [0, *n*). + +.. function:: randbits(k) + + Return an int with *k* random bits. + + +Generating tokens +----------------- + +The :mod:`secrets` module provides functions for generating secure +tokens, suitable for applications such as password resets, +hard-to-guess URLs, and similar. + +.. function:: token_bytes([nbytes=None]) + + Return a random byte string containing *nbytes* number of bytes. + If *nbytes* is ``None`` or not supplied, a reasonable default is + used. + + .. doctest:: + + >>> token_bytes(16) #doctest:+SKIP + b'\xebr\x17D*t\xae\xd4\xe3S\xb6\xe2\xebP1\x8b' + + +.. function:: token_hex([nbytes=None]) + + Return a random text string, in hexadecimal. The string has *nbytes* + random bytes, each byte converted to two hex digits. If *nbytes* is + ``None`` or not supplied, a reasonable default is used. + + .. doctest:: + + >>> token_hex(16) #doctest:+SKIP + 'f9bf78b9a18ce6d46a0cd2b0b86df9da' + +.. function:: token_urlsafe([nbytes=None]) + + Return a random URL-safe text string, containing *nbytes* random + bytes. The text is Base64 encoded, so on average each byte results + in approximately 1.3 characters. If *nbytes* is ``None`` or not + supplied, a reasonable default is used. + + .. doctest:: + + >>> token_urlsafe(16) #doctest:+SKIP + 'Drmhze6EPcv0fN_81Bj-nA' + + +How many bytes should tokens use? +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To be secure against +`brute-force attacks `_, +tokens need to have sufficient randomness. Unfortunately, what is +considered sufficient will necessarily increase as computers get more +powerful and able to make more guesses in a shorter period. As of 2015, +it is believed that 32 bytes (256 bits) of randomness is sufficient for +the typical use-case expected for the :mod:`secrets` module. + +For those who want to manage their own token length, you can explicitly +specify how much randomness is used for tokens by giving an :class:`int` +argument to the various ``token_*`` functions. That argument is taken +as the number of bytes of randomness to use. + +Otherwise, if no argument is provided, or if the argument is ``None``, +the ``token_*`` functions will use a reasonable default instead. + +.. note:: + + That default is subject to change at any time, including during + maintenance releases. + + +Other functions +--------------- + +.. function:: compare_digest(a, b) + + Return ``True`` if strings *a* and *b* are equal, otherwise ``False``, + in such a way as to reduce the risk of + `timing attacks `_. + See :func:`hmac.compare_digest` for additional details. + + +Recipes and best practices +-------------------------- + +This section shows recipes and best practices for using :mod:`secrets` +to manage a basic level of security. + +Generate an eight-character alphanumeric password: + +.. testcode:: + + import string + alphabet = string.ascii_letters + string.digits + password = ''.join(choice(alphabet) for i in range(8)) + + +.. note:: + + Applications should not + `store passwords in a recoverable format `_, + whether plain text or encrypted. They should be salted and hashed + using a cryptographically-strong one-way (irreversible) hash function. + + +Generate a ten-character alphanumeric password with at least one +lowercase character, at least one uppercase character, and at least +three digits: + +.. testcode:: + + import string + alphabet = string.ascii_letters + string.digits + while True: + password = ''.join(choice(alphabet) for i in range(10)) + if (any(c.islower() for c in password) + and any(c.isupper() for c in password) + and sum(c.isdigit() for c in password) >= 3): + break + + +Generate an `XKCD-style passphrase `_: + +.. testcode:: + + # On standard Linux systems, use a convenient dictionary file. + # Other platforms may need to provide their own word-list. + with open('/usr/share/dict/words') as f: + words = [word.strip() for word in f] + password = ' '.join(choice(words) for i in range(4)) + + +Generate a hard-to-guess temporary URL containing a security token +suitable for password recovery applications: + +.. testcode:: + + url = 'https://mydomain.com/reset=' + token_urlsafe() + + + +.. + # This modeline must appear within the last ten lines of the file. + kate: indent-width 3; remove-trailing-space on; replace-tabs on; encoding utf-8; diff --git a/python-3.7.4-docs-html/_sources/library/select.rst.txt b/python-3.7.4-docs-html/_sources/library/select.rst.txt new file mode 100644 index 0000000..7d65363 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/select.rst.txt @@ -0,0 +1,646 @@ +:mod:`select` --- Waiting for I/O completion +============================================ + +.. module:: select + :synopsis: Wait for I/O completion on multiple streams. + +-------------- + +This module provides access to the :c:func:`select` and :c:func:`poll` functions +available in most operating systems, :c:func:`devpoll` available on +Solaris and derivatives, :c:func:`epoll` available on Linux 2.5+ and +:c:func:`kqueue` available on most BSD. +Note that on Windows, it only works for sockets; on other operating systems, +it also works for other file types (in particular, on Unix, it works on pipes). +It cannot be used on regular files to determine whether a file has grown since +it was last read. + +.. note:: + + The :mod:`selectors` module allows high-level and efficient I/O + multiplexing, built upon the :mod:`select` module primitives. Users are + encouraged to use the :mod:`selectors` module instead, unless they want + precise control over the OS-level primitives used. + + +The module defines the following: + + +.. exception:: error + + A deprecated alias of :exc:`OSError`. + + .. versionchanged:: 3.3 + Following :pep:`3151`, this class was made an alias of :exc:`OSError`. + + +.. function:: devpoll() + + (Only supported on Solaris and derivatives.) Returns a ``/dev/poll`` + polling object; see section :ref:`devpoll-objects` below for the + methods supported by devpoll objects. + + :c:func:`devpoll` objects are linked to the number of file + descriptors allowed at the time of instantiation. If your program + reduces this value, :c:func:`devpoll` will fail. If your program + increases this value, :c:func:`devpoll` may return an + incomplete list of active file descriptors. + + The new file descriptor is :ref:`non-inheritable `. + + .. versionadded:: 3.3 + + .. versionchanged:: 3.4 + The new file descriptor is now non-inheritable. + +.. function:: epoll(sizehint=-1, flags=0) + + (Only supported on Linux 2.5.44 and newer.) Return an edge polling object, + which can be used as Edge or Level Triggered interface for I/O + events. + + *sizehint* informs epoll about the expected number of events to be + registered. It must be positive, or `-1` to use the default. It is only + used on older systems where :c:func:`epoll_create1` is not available; + otherwise it has no effect (though its value is still checked). + + *flags* is deprecated and completely ignored. However, when supplied, its + value must be ``0`` or ``select.EPOLL_CLOEXEC``, otherwise ``OSError`` is + raised. + + See the :ref:`epoll-objects` section below for the methods supported by + epolling objects. + + ``epoll`` objects support the context management protocol: when used in a + :keyword:`with` statement, the new file descriptor is automatically closed + at the end of the block. + + The new file descriptor is :ref:`non-inheritable `. + + .. versionchanged:: 3.3 + Added the *flags* parameter. + + .. versionchanged:: 3.4 + Support for the :keyword:`with` statement was added. + The new file descriptor is now non-inheritable. + + .. deprecated:: 3.4 + The *flags* parameter. ``select.EPOLL_CLOEXEC`` is used by default now. + Use :func:`os.set_inheritable` to make the file descriptor inheritable. + + +.. function:: poll() + + (Not supported by all operating systems.) Returns a polling object, which + supports registering and unregistering file descriptors, and then polling them + for I/O events; see section :ref:`poll-objects` below for the methods supported + by polling objects. + + +.. function:: kqueue() + + (Only supported on BSD.) Returns a kernel queue object; see section + :ref:`kqueue-objects` below for the methods supported by kqueue objects. + + The new file descriptor is :ref:`non-inheritable `. + + .. versionchanged:: 3.4 + The new file descriptor is now non-inheritable. + + +.. function:: kevent(ident, filter=KQ_FILTER_READ, flags=KQ_EV_ADD, fflags=0, data=0, udata=0) + + (Only supported on BSD.) Returns a kernel event object; see section + :ref:`kevent-objects` below for the methods supported by kevent objects. + + +.. function:: select(rlist, wlist, xlist[, timeout]) + + This is a straightforward interface to the Unix :c:func:`select` system call. + The first three arguments are sequences of 'waitable objects': either + integers representing file descriptors or objects with a parameterless method + named :meth:`~io.IOBase.fileno` returning such an integer: + + * *rlist*: wait until ready for reading + * *wlist*: wait until ready for writing + * *xlist*: wait for an "exceptional condition" (see the manual page for what + your system considers such a condition) + + Empty sequences are allowed, but acceptance of three empty sequences is + platform-dependent. (It is known to work on Unix but not on Windows.) The + optional *timeout* argument specifies a time-out as a floating point number + in seconds. When the *timeout* argument is omitted the function blocks until + at least one file descriptor is ready. A time-out value of zero specifies a + poll and never blocks. + + The return value is a triple of lists of objects that are ready: subsets of the + first three arguments. When the time-out is reached without a file descriptor + becoming ready, three empty lists are returned. + + .. index:: + single: socket() (in module socket) + single: popen() (in module os) + + Among the acceptable object types in the sequences are Python :term:`file + objects ` (e.g. ``sys.stdin``, or objects returned by + :func:`open` or :func:`os.popen`), socket objects returned by + :func:`socket.socket`. You may also define a :dfn:`wrapper` class yourself, + as long as it has an appropriate :meth:`~io.IOBase.fileno` method (that + really returns a file descriptor, not just a random integer). + + .. note:: + + .. index:: single: WinSock + + File objects on Windows are not acceptable, but sockets are. On Windows, + the underlying :c:func:`select` function is provided by the WinSock + library, and does not handle file descriptors that don't originate from + WinSock. + + .. versionchanged:: 3.5 + The function is now retried with a recomputed timeout when interrupted by + a signal, except if the signal handler raises an exception (see + :pep:`475` for the rationale), instead of raising + :exc:`InterruptedError`. + + +.. attribute:: PIPE_BUF + + The minimum number of bytes which can be written without blocking to a pipe + when the pipe has been reported as ready for writing by :func:`~select.select`, + :func:`poll` or another interface in this module. This doesn't apply + to other kind of file-like objects such as sockets. + + This value is guaranteed by POSIX to be at least 512. + + .. availability:: Unix + + .. versionadded:: 3.2 + + +.. _devpoll-objects: + +``/dev/poll`` Polling Objects +----------------------------- + +Solaris and derivatives have ``/dev/poll``. While :c:func:`select` is +O(highest file descriptor) and :c:func:`poll` is O(number of file +descriptors), ``/dev/poll`` is O(active file descriptors). + +``/dev/poll`` behaviour is very close to the standard :c:func:`poll` +object. + + +.. method:: devpoll.close() + + Close the file descriptor of the polling object. + + .. versionadded:: 3.4 + + +.. attribute:: devpoll.closed + + ``True`` if the polling object is closed. + + .. versionadded:: 3.4 + + +.. method:: devpoll.fileno() + + Return the file descriptor number of the polling object. + + .. versionadded:: 3.4 + + +.. method:: devpoll.register(fd[, eventmask]) + + Register a file descriptor with the polling object. Future calls to the + :meth:`poll` method will then check whether the file descriptor has any + pending I/O events. *fd* can be either an integer, or an object with a + :meth:`~io.IOBase.fileno` method that returns an integer. File objects + implement :meth:`!fileno`, so they can also be used as the argument. + + *eventmask* is an optional bitmask describing the type of events you want to + check for. The constants are the same that with :c:func:`poll` + object. The default value is a combination of the constants :const:`POLLIN`, + :const:`POLLPRI`, and :const:`POLLOUT`. + + .. warning:: + + Registering a file descriptor that's already registered is not an + error, but the result is undefined. The appropriate action is to + unregister or modify it first. This is an important difference + compared with :c:func:`poll`. + + +.. method:: devpoll.modify(fd[, eventmask]) + + This method does an :meth:`unregister` followed by a + :meth:`register`. It is (a bit) more efficient that doing the same + explicitly. + + +.. method:: devpoll.unregister(fd) + + Remove a file descriptor being tracked by a polling object. Just like the + :meth:`register` method, *fd* can be an integer or an object with a + :meth:`~io.IOBase.fileno` method that returns an integer. + + Attempting to remove a file descriptor that was never registered is + safely ignored. + + +.. method:: devpoll.poll([timeout]) + + Polls the set of registered file descriptors, and returns a possibly-empty list + containing ``(fd, event)`` 2-tuples for the descriptors that have events or + errors to report. *fd* is the file descriptor, and *event* is a bitmask with + bits set for the reported events for that descriptor --- :const:`POLLIN` for + waiting input, :const:`POLLOUT` to indicate that the descriptor can be written + to, and so forth. An empty list indicates that the call timed out and no file + descriptors had any events to report. If *timeout* is given, it specifies the + length of time in milliseconds which the system will wait for events before + returning. If *timeout* is omitted, -1, or :const:`None`, the call will + block until there is an event for this poll object. + + .. versionchanged:: 3.5 + The function is now retried with a recomputed timeout when interrupted by + a signal, except if the signal handler raises an exception (see + :pep:`475` for the rationale), instead of raising + :exc:`InterruptedError`. + + +.. _epoll-objects: + +Edge and Level Trigger Polling (epoll) Objects +---------------------------------------------- + + https://linux.die.net/man/4/epoll + + *eventmask* + + +-------------------------+-----------------------------------------------+ + | Constant | Meaning | + +=========================+===============================================+ + | :const:`EPOLLIN` | Available for read | + +-------------------------+-----------------------------------------------+ + | :const:`EPOLLOUT` | Available for write | + +-------------------------+-----------------------------------------------+ + | :const:`EPOLLPRI` | Urgent data for read | + +-------------------------+-----------------------------------------------+ + | :const:`EPOLLERR` | Error condition happened on the assoc. fd | + +-------------------------+-----------------------------------------------+ + | :const:`EPOLLHUP` | Hang up happened on the assoc. fd | + +-------------------------+-----------------------------------------------+ + | :const:`EPOLLET` | Set Edge Trigger behavior, the default is | + | | Level Trigger behavior | + +-------------------------+-----------------------------------------------+ + | :const:`EPOLLONESHOT` | Set one-shot behavior. After one event is | + | | pulled out, the fd is internally disabled | + +-------------------------+-----------------------------------------------+ + | :const:`EPOLLEXCLUSIVE` | Wake only one epoll object when the | + | | associated fd has an event. The default (if | + | | this flag is not set) is to wake all epoll | + | | objects polling on a fd. | + +-------------------------+-----------------------------------------------+ + | :const:`EPOLLRDHUP` | Stream socket peer closed connection or shut | + | | down writing half of connection. | + +-------------------------+-----------------------------------------------+ + | :const:`EPOLLRDNORM` | Equivalent to :const:`EPOLLIN` | + +-------------------------+-----------------------------------------------+ + | :const:`EPOLLRDBAND` | Priority data band can be read. | + +-------------------------+-----------------------------------------------+ + | :const:`EPOLLWRNORM` | Equivalent to :const:`EPOLLOUT` | + +-------------------------+-----------------------------------------------+ + | :const:`EPOLLWRBAND` | Priority data may be written. | + +-------------------------+-----------------------------------------------+ + | :const:`EPOLLMSG` | Ignored. | + +-------------------------+-----------------------------------------------+ + + .. versionadded:: 3.6 + :const:`EPOLLEXCLUSIVE` was added. It's only supported by Linux Kernel 4.5 + or later. + +.. method:: epoll.close() + + Close the control file descriptor of the epoll object. + + +.. attribute:: epoll.closed + + ``True`` if the epoll object is closed. + + +.. method:: epoll.fileno() + + Return the file descriptor number of the control fd. + + +.. method:: epoll.fromfd(fd) + + Create an epoll object from a given file descriptor. + + +.. method:: epoll.register(fd[, eventmask]) + + Register a fd descriptor with the epoll object. + + +.. method:: epoll.modify(fd, eventmask) + + Modify a registered file descriptor. + + +.. method:: epoll.unregister(fd) + + Remove a registered file descriptor from the epoll object. + + +.. method:: epoll.poll(timeout=-1, maxevents=-1) + + Wait for events. timeout in seconds (float) + + .. versionchanged:: 3.5 + The function is now retried with a recomputed timeout when interrupted by + a signal, except if the signal handler raises an exception (see + :pep:`475` for the rationale), instead of raising + :exc:`InterruptedError`. + + +.. _poll-objects: + +Polling Objects +--------------- + +The :c:func:`poll` system call, supported on most Unix systems, provides better +scalability for network servers that service many, many clients at the same +time. :c:func:`poll` scales better because the system call only requires listing +the file descriptors of interest, while :c:func:`select` builds a bitmap, turns +on bits for the fds of interest, and then afterward the whole bitmap has to be +linearly scanned again. :c:func:`select` is O(highest file descriptor), while +:c:func:`poll` is O(number of file descriptors). + + +.. method:: poll.register(fd[, eventmask]) + + Register a file descriptor with the polling object. Future calls to the + :meth:`poll` method will then check whether the file descriptor has any + pending I/O events. *fd* can be either an integer, or an object with a + :meth:`~io.IOBase.fileno` method that returns an integer. File objects + implement :meth:`!fileno`, so they can also be used as the argument. + + *eventmask* is an optional bitmask describing the type of events you want to + check for, and can be a combination of the constants :const:`POLLIN`, + :const:`POLLPRI`, and :const:`POLLOUT`, described in the table below. If not + specified, the default value used will check for all 3 types of events. + + +-------------------+------------------------------------------+ + | Constant | Meaning | + +===================+==========================================+ + | :const:`POLLIN` | There is data to read | + +-------------------+------------------------------------------+ + | :const:`POLLPRI` | There is urgent data to read | + +-------------------+------------------------------------------+ + | :const:`POLLOUT` | Ready for output: writing will not block | + +-------------------+------------------------------------------+ + | :const:`POLLERR` | Error condition of some sort | + +-------------------+------------------------------------------+ + | :const:`POLLHUP` | Hung up | + +-------------------+------------------------------------------+ + | :const:`POLLRDHUP`| Stream socket peer closed connection, or | + | | shut down writing half of connection | + +-------------------+------------------------------------------+ + | :const:`POLLNVAL` | Invalid request: descriptor not open | + +-------------------+------------------------------------------+ + + Registering a file descriptor that's already registered is not an error, and has + the same effect as registering the descriptor exactly once. + + +.. method:: poll.modify(fd, eventmask) + + Modifies an already registered fd. This has the same effect as + ``register(fd, eventmask)``. Attempting to modify a file descriptor + that was never registered causes an :exc:`OSError` exception with errno + :const:`ENOENT` to be raised. + + +.. method:: poll.unregister(fd) + + Remove a file descriptor being tracked by a polling object. Just like the + :meth:`register` method, *fd* can be an integer or an object with a + :meth:`~io.IOBase.fileno` method that returns an integer. + + Attempting to remove a file descriptor that was never registered causes a + :exc:`KeyError` exception to be raised. + + +.. method:: poll.poll([timeout]) + + Polls the set of registered file descriptors, and returns a possibly-empty list + containing ``(fd, event)`` 2-tuples for the descriptors that have events or + errors to report. *fd* is the file descriptor, and *event* is a bitmask with + bits set for the reported events for that descriptor --- :const:`POLLIN` for + waiting input, :const:`POLLOUT` to indicate that the descriptor can be written + to, and so forth. An empty list indicates that the call timed out and no file + descriptors had any events to report. If *timeout* is given, it specifies the + length of time in milliseconds which the system will wait for events before + returning. If *timeout* is omitted, negative, or :const:`None`, the call will + block until there is an event for this poll object. + + .. versionchanged:: 3.5 + The function is now retried with a recomputed timeout when interrupted by + a signal, except if the signal handler raises an exception (see + :pep:`475` for the rationale), instead of raising + :exc:`InterruptedError`. + + +.. _kqueue-objects: + +Kqueue Objects +-------------- + +.. method:: kqueue.close() + + Close the control file descriptor of the kqueue object. + + +.. attribute:: kqueue.closed + + ``True`` if the kqueue object is closed. + + +.. method:: kqueue.fileno() + + Return the file descriptor number of the control fd. + + +.. method:: kqueue.fromfd(fd) + + Create a kqueue object from a given file descriptor. + + +.. method:: kqueue.control(changelist, max_events[, timeout]) -> eventlist + + Low level interface to kevent + + - changelist must be an iterable of kevent objects or ``None`` + - max_events must be 0 or a positive integer + - timeout in seconds (floats possible); the default is ``None``, + to wait forever + + .. versionchanged:: 3.5 + The function is now retried with a recomputed timeout when interrupted by + a signal, except if the signal handler raises an exception (see + :pep:`475` for the rationale), instead of raising + :exc:`InterruptedError`. + + +.. _kevent-objects: + +Kevent Objects +-------------- + +https://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2 + +.. attribute:: kevent.ident + + Value used to identify the event. The interpretation depends on the filter + but it's usually the file descriptor. In the constructor ident can either + be an int or an object with a :meth:`~io.IOBase.fileno` method. kevent + stores the integer internally. + +.. attribute:: kevent.filter + + Name of the kernel filter. + + +---------------------------+---------------------------------------------+ + | Constant | Meaning | + +===========================+=============================================+ + | :const:`KQ_FILTER_READ` | Takes a descriptor and returns whenever | + | | there is data available to read | + +---------------------------+---------------------------------------------+ + | :const:`KQ_FILTER_WRITE` | Takes a descriptor and returns whenever | + | | there is data available to write | + +---------------------------+---------------------------------------------+ + | :const:`KQ_FILTER_AIO` | AIO requests | + +---------------------------+---------------------------------------------+ + | :const:`KQ_FILTER_VNODE` | Returns when one or more of the requested | + | | events watched in *fflag* occurs | + +---------------------------+---------------------------------------------+ + | :const:`KQ_FILTER_PROC` | Watch for events on a process id | + +---------------------------+---------------------------------------------+ + | :const:`KQ_FILTER_NETDEV` | Watch for events on a network device | + | | [not available on Mac OS X] | + +---------------------------+---------------------------------------------+ + | :const:`KQ_FILTER_SIGNAL` | Returns whenever the watched signal is | + | | delivered to the process | + +---------------------------+---------------------------------------------+ + | :const:`KQ_FILTER_TIMER` | Establishes an arbitrary timer | + +---------------------------+---------------------------------------------+ + +.. attribute:: kevent.flags + + Filter action. + + +---------------------------+---------------------------------------------+ + | Constant | Meaning | + +===========================+=============================================+ + | :const:`KQ_EV_ADD` | Adds or modifies an event | + +---------------------------+---------------------------------------------+ + | :const:`KQ_EV_DELETE` | Removes an event from the queue | + +---------------------------+---------------------------------------------+ + | :const:`KQ_EV_ENABLE` | Permitscontrol() to returns the event | + +---------------------------+---------------------------------------------+ + | :const:`KQ_EV_DISABLE` | Disablesevent | + +---------------------------+---------------------------------------------+ + | :const:`KQ_EV_ONESHOT` | Removes event after first occurrence | + +---------------------------+---------------------------------------------+ + | :const:`KQ_EV_CLEAR` | Reset the state after an event is retrieved | + +---------------------------+---------------------------------------------+ + | :const:`KQ_EV_SYSFLAGS` | internal event | + +---------------------------+---------------------------------------------+ + | :const:`KQ_EV_FLAG1` | internal event | + +---------------------------+---------------------------------------------+ + | :const:`KQ_EV_EOF` | Filter specific EOF condition | + +---------------------------+---------------------------------------------+ + | :const:`KQ_EV_ERROR` | See return values | + +---------------------------+---------------------------------------------+ + + +.. attribute:: kevent.fflags + + Filter specific flags. + + :const:`KQ_FILTER_READ` and :const:`KQ_FILTER_WRITE` filter flags: + + +----------------------------+--------------------------------------------+ + | Constant | Meaning | + +============================+============================================+ + | :const:`KQ_NOTE_LOWAT` | low water mark of a socket buffer | + +----------------------------+--------------------------------------------+ + + :const:`KQ_FILTER_VNODE` filter flags: + + +----------------------------+--------------------------------------------+ + | Constant | Meaning | + +============================+============================================+ + | :const:`KQ_NOTE_DELETE` | *unlink()* was called | + +----------------------------+--------------------------------------------+ + | :const:`KQ_NOTE_WRITE` | a write occurred | + +----------------------------+--------------------------------------------+ + | :const:`KQ_NOTE_EXTEND` | the file was extended | + +----------------------------+--------------------------------------------+ + | :const:`KQ_NOTE_ATTRIB` | an attribute was changed | + +----------------------------+--------------------------------------------+ + | :const:`KQ_NOTE_LINK` | the link count has changed | + +----------------------------+--------------------------------------------+ + | :const:`KQ_NOTE_RENAME` | the file was renamed | + +----------------------------+--------------------------------------------+ + | :const:`KQ_NOTE_REVOKE` | access to the file was revoked | + +----------------------------+--------------------------------------------+ + + :const:`KQ_FILTER_PROC` filter flags: + + +----------------------------+--------------------------------------------+ + | Constant | Meaning | + +============================+============================================+ + | :const:`KQ_NOTE_EXIT` | the process has exited | + +----------------------------+--------------------------------------------+ + | :const:`KQ_NOTE_FORK` | the process has called *fork()* | + +----------------------------+--------------------------------------------+ + | :const:`KQ_NOTE_EXEC` | the process has executed a new process | + +----------------------------+--------------------------------------------+ + | :const:`KQ_NOTE_PCTRLMASK` | internal filter flag | + +----------------------------+--------------------------------------------+ + | :const:`KQ_NOTE_PDATAMASK` | internal filter flag | + +----------------------------+--------------------------------------------+ + | :const:`KQ_NOTE_TRACK` | follow a process across *fork()* | + +----------------------------+--------------------------------------------+ + | :const:`KQ_NOTE_CHILD` | returned on the child process for | + | | *NOTE_TRACK* | + +----------------------------+--------------------------------------------+ + | :const:`KQ_NOTE_TRACKERR` | unable to attach to a child | + +----------------------------+--------------------------------------------+ + + :const:`KQ_FILTER_NETDEV` filter flags (not available on Mac OS X): + + +----------------------------+--------------------------------------------+ + | Constant | Meaning | + +============================+============================================+ + | :const:`KQ_NOTE_LINKUP` | link is up | + +----------------------------+--------------------------------------------+ + | :const:`KQ_NOTE_LINKDOWN` | link is down | + +----------------------------+--------------------------------------------+ + | :const:`KQ_NOTE_LINKINV` | link state is invalid | + +----------------------------+--------------------------------------------+ + + +.. attribute:: kevent.data + + Filter specific data. + + +.. attribute:: kevent.udata + + User defined value. diff --git a/python-3.7.4-docs-html/_sources/library/selectors.rst.txt b/python-3.7.4-docs-html/_sources/library/selectors.rst.txt new file mode 100644 index 0000000..6d864a8 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/selectors.rst.txt @@ -0,0 +1,277 @@ +:mod:`selectors` --- High-level I/O multiplexing +================================================ + +.. module:: selectors + :synopsis: High-level I/O multiplexing. + +.. versionadded:: 3.4 + +**Source code:** :source:`Lib/selectors.py` + +-------------- + +Introduction +------------ + +This module allows high-level and efficient I/O multiplexing, built upon the +:mod:`select` module primitives. Users are encouraged to use this module +instead, unless they want precise control over the OS-level primitives used. + +It defines a :class:`BaseSelector` abstract base class, along with several +concrete implementations (:class:`KqueueSelector`, :class:`EpollSelector`...), +that can be used to wait for I/O readiness notification on multiple file +objects. In the following, "file object" refers to any object with a +:meth:`fileno()` method, or a raw file descriptor. See :term:`file object`. + +:class:`DefaultSelector` is an alias to the most efficient implementation +available on the current platform: this should be the default choice for most +users. + +.. note:: + The type of file objects supported depends on the platform: on Windows, + sockets are supported, but not pipes, whereas on Unix, both are supported + (some other types may be supported as well, such as fifos or special file + devices). + +.. seealso:: + + :mod:`select` + Low-level I/O multiplexing module. + + +Classes +------- + +Classes hierarchy:: + + BaseSelector + +-- SelectSelector + +-- PollSelector + +-- EpollSelector + +-- DevpollSelector + +-- KqueueSelector + + +In the following, *events* is a bitwise mask indicating which I/O events should +be waited for on a given file object. It can be a combination of the modules +constants below: + + +-----------------------+-----------------------------------------------+ + | Constant | Meaning | + +=======================+===============================================+ + | :const:`EVENT_READ` | Available for read | + +-----------------------+-----------------------------------------------+ + | :const:`EVENT_WRITE` | Available for write | + +-----------------------+-----------------------------------------------+ + + +.. class:: SelectorKey + + A :class:`SelectorKey` is a :class:`~collections.namedtuple` used to + associate a file object to its underlying file descriptor, selected event + mask and attached data. It is returned by several :class:`BaseSelector` + methods. + + .. attribute:: fileobj + + File object registered. + + .. attribute:: fd + + Underlying file descriptor. + + .. attribute:: events + + Events that must be waited for on this file object. + + .. attribute:: data + + Optional opaque data associated to this file object: for example, this + could be used to store a per-client session ID. + + +.. class:: BaseSelector + + A :class:`BaseSelector` is used to wait for I/O event readiness on multiple + file objects. It supports file stream registration, unregistration, and a + method to wait for I/O events on those streams, with an optional timeout. + It's an abstract base class, so cannot be instantiated. Use + :class:`DefaultSelector` instead, or one of :class:`SelectSelector`, + :class:`KqueueSelector` etc. if you want to specifically use an + implementation, and your platform supports it. + :class:`BaseSelector` and its concrete implementations support the + :term:`context manager` protocol. + + .. abstractmethod:: register(fileobj, events, data=None) + + Register a file object for selection, monitoring it for I/O events. + + *fileobj* is the file object to monitor. It may either be an integer + file descriptor or an object with a ``fileno()`` method. + *events* is a bitwise mask of events to monitor. + *data* is an opaque object. + + This returns a new :class:`SelectorKey` instance, or raises a + :exc:`ValueError` in case of invalid event mask or file descriptor, or + :exc:`KeyError` if the file object is already registered. + + .. abstractmethod:: unregister(fileobj) + + Unregister a file object from selection, removing it from monitoring. A + file object shall be unregistered prior to being closed. + + *fileobj* must be a file object previously registered. + + This returns the associated :class:`SelectorKey` instance, or raises a + :exc:`KeyError` if *fileobj* is not registered. It will raise + :exc:`ValueError` if *fileobj* is invalid (e.g. it has no ``fileno()`` + method or its ``fileno()`` method has an invalid return value). + + .. method:: modify(fileobj, events, data=None) + + Change a registered file object's monitored events or attached data. + + This is equivalent to :meth:`BaseSelector.unregister(fileobj)` followed + by :meth:`BaseSelector.register(fileobj, events, data)`, except that it + can be implemented more efficiently. + + This returns a new :class:`SelectorKey` instance, or raises a + :exc:`ValueError` in case of invalid event mask or file descriptor, or + :exc:`KeyError` if the file object is not registered. + + .. abstractmethod:: select(timeout=None) + + Wait until some registered file objects become ready, or the timeout + expires. + + If ``timeout > 0``, this specifies the maximum wait time, in seconds. + If ``timeout <= 0``, the call won't block, and will report the currently + ready file objects. + If *timeout* is ``None``, the call will block until a monitored file object + becomes ready. + + This returns a list of ``(key, events)`` tuples, one for each ready file + object. + + *key* is the :class:`SelectorKey` instance corresponding to a ready file + object. + *events* is a bitmask of events ready on this file object. + + .. note:: + This method can return before any file object becomes ready or the + timeout has elapsed if the current process receives a signal: in this + case, an empty list will be returned. + + .. versionchanged:: 3.5 + The selector is now retried with a recomputed timeout when interrupted + by a signal if the signal handler did not raise an exception (see + :pep:`475` for the rationale), instead of returning an empty list + of events before the timeout. + + .. method:: close() + + Close the selector. + + This must be called to make sure that any underlying resource is freed. + The selector shall not be used once it has been closed. + + .. method:: get_key(fileobj) + + Return the key associated with a registered file object. + + This returns the :class:`SelectorKey` instance associated to this file + object, or raises :exc:`KeyError` if the file object is not registered. + + .. abstractmethod:: get_map() + + Return a mapping of file objects to selector keys. + + This returns a :class:`~collections.abc.Mapping` instance mapping + registered file objects to their associated :class:`SelectorKey` + instance. + + +.. class:: DefaultSelector() + + The default selector class, using the most efficient implementation + available on the current platform. This should be the default choice for + most users. + + +.. class:: SelectSelector() + + :func:`select.select`-based selector. + + +.. class:: PollSelector() + + :func:`select.poll`-based selector. + + +.. class:: EpollSelector() + + :func:`select.epoll`-based selector. + + .. method:: fileno() + + This returns the file descriptor used by the underlying + :func:`select.epoll` object. + +.. class:: DevpollSelector() + + :func:`select.devpoll`-based selector. + + .. method:: fileno() + + This returns the file descriptor used by the underlying + :func:`select.devpoll` object. + + .. versionadded:: 3.5 + +.. class:: KqueueSelector() + + :func:`select.kqueue`-based selector. + + .. method:: fileno() + + This returns the file descriptor used by the underlying + :func:`select.kqueue` object. + + +Examples +-------- + +Here is a simple echo server implementation:: + + import selectors + import socket + + sel = selectors.DefaultSelector() + + def accept(sock, mask): + conn, addr = sock.accept() # Should be ready + print('accepted', conn, 'from', addr) + conn.setblocking(False) + sel.register(conn, selectors.EVENT_READ, read) + + def read(conn, mask): + data = conn.recv(1000) # Should be ready + if data: + print('echoing', repr(data), 'to', conn) + conn.send(data) # Hope it won't block + else: + print('closing', conn) + sel.unregister(conn) + conn.close() + + sock = socket.socket() + sock.bind(('localhost', 1234)) + sock.listen(100) + sock.setblocking(False) + sel.register(sock, selectors.EVENT_READ, accept) + + while True: + events = sel.select() + for key, mask in events: + callback = key.data + callback(key.fileobj, mask) diff --git a/python-3.7.4-docs-html/_sources/library/shelve.rst.txt b/python-3.7.4-docs-html/_sources/library/shelve.rst.txt new file mode 100644 index 0000000..f08c581 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/shelve.rst.txt @@ -0,0 +1,203 @@ +:mod:`shelve` --- Python object persistence +=========================================== + +.. module:: shelve + :synopsis: Python object persistence. + +**Source code:** :source:`Lib/shelve.py` + +.. index:: module: pickle + +-------------- + +A "shelf" is a persistent, dictionary-like object. The difference with "dbm" +databases is that the values (not the keys!) in a shelf can be essentially +arbitrary Python objects --- anything that the :mod:`pickle` module can handle. +This includes most class instances, recursive data types, and objects containing +lots of shared sub-objects. The keys are ordinary strings. + + +.. function:: open(filename, flag='c', protocol=None, writeback=False) + + Open a persistent dictionary. The filename specified is the base filename for + the underlying database. As a side-effect, an extension may be added to the + filename and more than one file may be created. By default, the underlying + database file is opened for reading and writing. The optional *flag* parameter + has the same interpretation as the *flag* parameter of :func:`dbm.open`. + + By default, version 3 pickles are used to serialize values. The version of the + pickle protocol can be specified with the *protocol* parameter. + + Because of Python semantics, a shelf cannot know when a mutable + persistent-dictionary entry is modified. By default modified objects are + written *only* when assigned to the shelf (see :ref:`shelve-example`). If the + optional *writeback* parameter is set to ``True``, all entries accessed are also + cached in memory, and written back on :meth:`~Shelf.sync` and + :meth:`~Shelf.close`; this can make it handier to mutate mutable entries in + the persistent dictionary, but, if many entries are accessed, it can consume + vast amounts of memory for the cache, and it can make the close operation + very slow since all accessed entries are written back (there is no way to + determine which accessed entries are mutable, nor which ones were actually + mutated). + + .. note:: + + Do not rely on the shelf being closed automatically; always call + :meth:`~Shelf.close` explicitly when you don't need it any more, or + use :func:`shelve.open` as a context manager:: + + with shelve.open('spam') as db: + db['eggs'] = 'eggs' + +.. warning:: + + Because the :mod:`shelve` module is backed by :mod:`pickle`, it is insecure + to load a shelf from an untrusted source. Like with pickle, loading a shelf + can execute arbitrary code. + +Shelf objects support all methods supported by dictionaries. This eases the +transition from dictionary based scripts to those requiring persistent storage. + +Two additional methods are supported: + +.. method:: Shelf.sync() + + Write back all entries in the cache if the shelf was opened with *writeback* + set to :const:`True`. Also empty the cache and synchronize the persistent + dictionary on disk, if feasible. This is called automatically when the shelf + is closed with :meth:`close`. + +.. method:: Shelf.close() + + Synchronize and close the persistent *dict* object. Operations on a closed + shelf will fail with a :exc:`ValueError`. + + +.. seealso:: + + `Persistent dictionary recipe `_ + with widely supported storage formats and having the speed of native + dictionaries. + + +Restrictions +------------ + + .. index:: + module: dbm.ndbm + module: dbm.gnu + +* The choice of which database package will be used (such as :mod:`dbm.ndbm` or + :mod:`dbm.gnu`) depends on which interface is available. Therefore it is not + safe to open the database directly using :mod:`dbm`. The database is also + (unfortunately) subject to the limitations of :mod:`dbm`, if it is used --- + this means that (the pickled representation of) the objects stored in the + database should be fairly small, and in rare cases key collisions may cause + the database to refuse updates. + +* The :mod:`shelve` module does not support *concurrent* read/write access to + shelved objects. (Multiple simultaneous read accesses are safe.) When a + program has a shelf open for writing, no other program should have it open for + reading or writing. Unix file locking can be used to solve this, but this + differs across Unix versions and requires knowledge about the database + implementation used. + + +.. class:: Shelf(dict, protocol=None, writeback=False, keyencoding='utf-8') + + A subclass of :class:`collections.abc.MutableMapping` which stores pickled + values in the *dict* object. + + By default, version 3 pickles are used to serialize values. The version of the + pickle protocol can be specified with the *protocol* parameter. See the + :mod:`pickle` documentation for a discussion of the pickle protocols. + + If the *writeback* parameter is ``True``, the object will hold a cache of all + entries accessed and write them back to the *dict* at sync and close times. + This allows natural operations on mutable entries, but can consume much more + memory and make sync and close take a long time. + + The *keyencoding* parameter is the encoding used to encode keys before they + are used with the underlying dict. + + A :class:`Shelf` object can also be used as a context manager, in which + case it will be automatically closed when the :keyword:`with` block ends. + + .. versionchanged:: 3.2 + Added the *keyencoding* parameter; previously, keys were always encoded in + UTF-8. + + .. versionchanged:: 3.4 + Added context manager support. + + +.. class:: BsdDbShelf(dict, protocol=None, writeback=False, keyencoding='utf-8') + + A subclass of :class:`Shelf` which exposes :meth:`first`, :meth:`!next`, + :meth:`previous`, :meth:`last` and :meth:`set_location` which are available + in the third-party :mod:`bsddb` module from `pybsddb + `_ but not in other database + modules. The *dict* object passed to the constructor must support those + methods. This is generally accomplished by calling one of + :func:`bsddb.hashopen`, :func:`bsddb.btopen` or :func:`bsddb.rnopen`. The + optional *protocol*, *writeback*, and *keyencoding* parameters have the same + interpretation as for the :class:`Shelf` class. + + +.. class:: DbfilenameShelf(filename, flag='c', protocol=None, writeback=False) + + A subclass of :class:`Shelf` which accepts a *filename* instead of a dict-like + object. The underlying file will be opened using :func:`dbm.open`. By + default, the file will be created and opened for both read and write. The + optional *flag* parameter has the same interpretation as for the :func:`.open` + function. The optional *protocol* and *writeback* parameters have the same + interpretation as for the :class:`Shelf` class. + + +.. _shelve-example: + +Example +------- + +To summarize the interface (``key`` is a string, ``data`` is an arbitrary +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!) + + # 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]! + + # 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 + + # 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 + + +.. seealso:: + + Module :mod:`dbm` + Generic interface to ``dbm``-style databases. + + Module :mod:`pickle` + Object serialization used by :mod:`shelve`. + diff --git a/python-3.7.4-docs-html/_sources/library/shlex.rst.txt b/python-3.7.4-docs-html/_sources/library/shlex.rst.txt new file mode 100644 index 0000000..fb335c6 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/shlex.rst.txt @@ -0,0 +1,418 @@ +:mod:`shlex` --- Simple lexical analysis +======================================== + +.. module:: shlex + :synopsis: Simple lexical analysis for Unix shell-like languages. + +.. moduleauthor:: Eric S. Raymond +.. moduleauthor:: Gustavo Niemeyer +.. sectionauthor:: Eric S. Raymond +.. sectionauthor:: Gustavo Niemeyer + +**Source code:** :source:`Lib/shlex.py` + +-------------- + +The :class:`~shlex.shlex` class makes it easy to write lexical analyzers for +simple syntaxes resembling that of the Unix shell. This will often be useful +for writing minilanguages, (for example, in run control files for Python +applications) or for parsing quoted strings. + +The :mod:`shlex` module defines the following functions: + + +.. function:: split(s, comments=False, posix=True) + + Split the string *s* using shell-like syntax. If *comments* is :const:`False` + (the default), the parsing of comments in the given string will be disabled + (setting the :attr:`~shlex.commenters` attribute of the + :class:`~shlex.shlex` instance to the empty string). This function operates + in POSIX mode by default, but uses non-POSIX mode if the *posix* argument is + false. + + .. note:: + + Since the :func:`split` function instantiates a :class:`~shlex.shlex` + instance, passing ``None`` for *s* will read the string to split from + standard input. + + +.. function:: quote(s) + + Return a shell-escaped version of the string *s*. The returned value is a + string that can safely be used as one token in a shell command line, for + cases where you cannot use a list. + + This idiom would be unsafe: + + >>> filename = 'somefile; rm -rf ~' + >>> command = 'ls -l {}'.format(filename) + >>> print(command) # executed by a shell: boom! + ls -l somefile; rm -rf ~ + + :func:`quote` lets you plug the security hole: + + >>> from shlex import quote + >>> command = 'ls -l {}'.format(quote(filename)) + >>> print(command) + ls -l 'somefile; rm -rf ~' + >>> remote_command = 'ssh home {}'.format(quote(command)) + >>> print(remote_command) + ssh home 'ls -l '"'"'somefile; rm -rf ~'"'"'' + + The quoting is compatible with UNIX shells and with :func:`split`: + + >>> from shlex import split + >>> remote_command = split(remote_command) + >>> remote_command + ['ssh', 'home', "ls -l 'somefile; rm -rf ~'"] + >>> command = split(remote_command[-1]) + >>> command + ['ls', '-l', 'somefile; rm -rf ~'] + + .. versionadded:: 3.3 + +The :mod:`shlex` module defines the following class: + + +.. class:: shlex(instream=None, infile=None, posix=False, punctuation_chars=False) + + A :class:`~shlex.shlex` instance or subclass instance is a lexical analyzer + object. The initialization argument, if present, specifies where to read + characters from. It must be a file-/stream-like object with + :meth:`~io.TextIOBase.read` and :meth:`~io.TextIOBase.readline` methods, or + a string. If no argument is given, input will be taken from ``sys.stdin``. + The second optional argument is a filename string, which sets the initial + value of the :attr:`~shlex.infile` attribute. If the *instream* + argument is omitted or equal to ``sys.stdin``, this second argument + defaults to "stdin". The *posix* argument defines the operational mode: + when *posix* is not true (default), the :class:`~shlex.shlex` instance will + operate in compatibility mode. When operating in POSIX mode, + :class:`~shlex.shlex` will try to be as close as possible to the POSIX shell + parsing rules. The *punctuation_chars* argument provides a way to make the + behaviour even closer to how real shells parse. This can take a number of + values: the default value, ``False``, preserves the behaviour seen under + Python 3.5 and earlier. If set to ``True``, then parsing of the characters + ``();<>|&`` is changed: any run of these characters (considered punctuation + characters) is returned as a single token. If set to a non-empty string of + characters, those characters will be used as the punctuation characters. Any + characters in the :attr:`wordchars` attribute that appear in + *punctuation_chars* will be removed from :attr:`wordchars`. See + :ref:`improved-shell-compatibility` for more information. + + .. versionchanged:: 3.6 + The *punctuation_chars* parameter was added. + +.. seealso:: + + Module :mod:`configparser` + Parser for configuration files similar to the Windows :file:`.ini` files. + + +.. _shlex-objects: + +shlex Objects +------------- + +A :class:`~shlex.shlex` instance has the following methods: + + +.. method:: shlex.get_token() + + Return a token. If tokens have been stacked using :meth:`push_token`, pop a + token off the stack. Otherwise, read one from the input stream. If reading + encounters an immediate end-of-file, :attr:`eof` is returned (the empty + string (``''``) in non-POSIX mode, and ``None`` in POSIX mode). + + +.. method:: shlex.push_token(str) + + Push the argument onto the token stack. + + +.. method:: shlex.read_token() + + Read a raw token. Ignore the pushback stack, and do not interpret source + requests. (This is not ordinarily a useful entry point, and is documented here + only for the sake of completeness.) + + +.. method:: shlex.sourcehook(filename) + + When :class:`~shlex.shlex` detects a source request (see :attr:`source` + below) this method is given the following token as argument, and expected + to return a tuple consisting of a filename and an open file-like object. + + Normally, this method first strips any quotes off the argument. If the result + is an absolute pathname, or there was no previous source request in effect, or + the previous source was a stream (such as ``sys.stdin``), the result is left + alone. Otherwise, if the result is a relative pathname, the directory part of + the name of the file immediately before it on the source inclusion stack is + prepended (this behavior is like the way the C preprocessor handles ``#include + "file.h"``). + + The result of the manipulations is treated as a filename, and returned as the + first component of the tuple, with :func:`open` called on it to yield the second + component. (Note: this is the reverse of the order of arguments in instance + initialization!) + + This hook is exposed so that you can use it to implement directory search paths, + addition of file extensions, and other namespace hacks. There is no + corresponding 'close' hook, but a shlex instance will call the + :meth:`~io.IOBase.close` method of the sourced input stream when it returns + EOF. + + For more explicit control of source stacking, use the :meth:`push_source` and + :meth:`pop_source` methods. + + +.. method:: shlex.push_source(newstream, newfile=None) + + Push an input source stream onto the input stack. If the filename argument is + specified it will later be available for use in error messages. This is the + same method used internally by the :meth:`sourcehook` method. + + +.. method:: shlex.pop_source() + + Pop the last-pushed input source from the input stack. This is the same method + used internally when the lexer reaches EOF on a stacked input stream. + + +.. method:: shlex.error_leader(infile=None, lineno=None) + + This method generates an error message leader in the format of a Unix C compiler + error label; the format is ``'"%s", line %d: '``, where the ``%s`` is replaced + with the name of the current source file and the ``%d`` with the current input + line number (the optional arguments can be used to override these). + + This convenience is provided to encourage :mod:`shlex` users to generate error + messages in the standard, parseable format understood by Emacs and other Unix + tools. + +Instances of :class:`~shlex.shlex` subclasses have some public instance +variables which either control lexical analysis or can be used for debugging: + + +.. attribute:: shlex.commenters + + The string of characters that are recognized as comment beginners. All + characters from the comment beginner to end of line are ignored. Includes just + ``'#'`` by default. + + +.. attribute:: shlex.wordchars + + The string of characters that will accumulate into multi-character tokens. By + default, includes all ASCII alphanumerics and underscore. In POSIX mode, the + accented characters in the Latin-1 set are also included. If + :attr:`punctuation_chars` is not empty, the characters ``~-./*?=``, which can + appear in filename specifications and command line parameters, will also be + included in this attribute, and any characters which appear in + ``punctuation_chars`` will be removed from ``wordchars`` if they are present + there. + + +.. attribute:: shlex.whitespace + + Characters that will be considered whitespace and skipped. Whitespace bounds + tokens. By default, includes space, tab, linefeed and carriage-return. + + +.. attribute:: shlex.escape + + Characters that will be considered as escape. This will be only used in POSIX + mode, and includes just ``'\'`` by default. + + +.. attribute:: shlex.quotes + + Characters that will be considered string quotes. The token accumulates until + the same quote is encountered again (thus, different quote types protect each + other as in the shell.) By default, includes ASCII single and double quotes. + + +.. attribute:: shlex.escapedquotes + + Characters in :attr:`quotes` that will interpret escape characters defined in + :attr:`escape`. This is only used in POSIX mode, and includes just ``'"'`` by + default. + + +.. attribute:: shlex.whitespace_split + + If ``True``, tokens will only be split in whitespaces. This is useful, for + example, for parsing command lines with :class:`~shlex.shlex`, getting + tokens in a similar way to shell arguments. If this attribute is ``True``, + :attr:`punctuation_chars` will have no effect, and splitting will happen + only on whitespaces. When using :attr:`punctuation_chars`, which is + intended to provide parsing closer to that implemented by shells, it is + advisable to leave ``whitespace_split`` as ``False`` (the default value). + + +.. attribute:: shlex.infile + + The name of the current input file, as initially set at class instantiation time + or stacked by later source requests. It may be useful to examine this when + constructing error messages. + + +.. attribute:: shlex.instream + + The input stream from which this :class:`~shlex.shlex` instance is reading + characters. + + +.. attribute:: shlex.source + + This attribute is ``None`` by default. If you assign a string to it, that + string will be recognized as a lexical-level inclusion request similar to the + ``source`` keyword in various shells. That is, the immediately following token + will be opened as a filename and input will be taken from that stream until + EOF, at which point the :meth:`~io.IOBase.close` method of that stream will be + called and the input source will again become the original input stream. Source + requests may be stacked any number of levels deep. + + +.. attribute:: shlex.debug + + If this attribute is numeric and ``1`` or more, a :class:`~shlex.shlex` + instance will print verbose progress output on its behavior. If you need + to use this, you can read the module source code to learn the details. + + +.. attribute:: shlex.lineno + + Source line number (count of newlines seen so far plus one). + + +.. attribute:: shlex.token + + The token buffer. It may be useful to examine this when catching exceptions. + + +.. attribute:: shlex.eof + + Token used to determine end of file. This will be set to the empty string + (``''``), in non-POSIX mode, and to ``None`` in POSIX mode. + + +.. attribute:: shlex.punctuation_chars + + Characters that will be considered punctuation. Runs of punctuation + characters will be returned as a single token. However, note that no + semantic validity checking will be performed: for example, '>>>' could be + returned as a token, even though it may not be recognised as such by shells. + + .. versionadded:: 3.6 + + +.. _shlex-parsing-rules: + +Parsing Rules +------------- + +When operating in non-POSIX mode, :class:`~shlex.shlex` will try to obey to the +following rules. + +* Quote characters are not recognized within words (``Do"Not"Separate`` is + parsed as the single word ``Do"Not"Separate``); + +* Escape characters are not recognized; + +* Enclosing characters in quotes preserve the literal value of all characters + within the quotes; + +* Closing quotes separate words (``"Do"Separate`` is parsed as ``"Do"`` and + ``Separate``); + +* If :attr:`~shlex.whitespace_split` is ``False``, any character not + declared to be a word character, whitespace, or a quote will be returned as + a single-character token. If it is ``True``, :class:`~shlex.shlex` will only + split words in whitespaces; + +* EOF is signaled with an empty string (``''``); + +* It's not possible to parse empty strings, even if quoted. + +When operating in POSIX mode, :class:`~shlex.shlex` will try to obey to the +following parsing rules. + +* Quotes are stripped out, and do not separate words (``"Do"Not"Separate"`` is + parsed as the single word ``DoNotSeparate``); + +* Non-quoted escape characters (e.g. ``'\'``) preserve the literal value of the + next character that follows; + +* Enclosing characters in quotes which are not part of + :attr:`~shlex.escapedquotes` (e.g. ``"'"``) preserve the literal value + of all characters within the quotes; + +* Enclosing characters in quotes which are part of + :attr:`~shlex.escapedquotes` (e.g. ``'"'``) preserves the literal value + of all characters within the quotes, with the exception of the characters + mentioned in :attr:`~shlex.escape`. The escape characters retain its + special meaning only when followed by the quote in use, or the escape + character itself. Otherwise the escape character will be considered a + normal character. + +* EOF is signaled with a :const:`None` value; + +* Quoted empty strings (``''``) are allowed. + +.. _improved-shell-compatibility: + +Improved Compatibility with Shells +---------------------------------- + +.. versionadded:: 3.6 + +The :class:`shlex` class provides compatibility with the parsing performed by +common Unix shells like ``bash``, ``dash``, and ``sh``. To take advantage of +this compatibility, specify the ``punctuation_chars`` argument in the +constructor. This defaults to ``False``, which preserves pre-3.6 behaviour. +However, if it is set to ``True``, then parsing of the characters ``();<>|&`` +is changed: any run of these characters is returned as a single token. While +this is short of a full parser for shells (which would be out of scope for the +standard library, given the multiplicity of shells out there), it does allow +you to perform processing of command lines more easily than you could +otherwise. To illustrate, you can see the difference in the following snippet: + +.. doctest:: + :options: +NORMALIZE_WHITESPACE + + >>> import shlex + >>> text = "a && b; c && d || e; f >'abc'; (def \"ghi\")" + >>> list(shlex.shlex(text)) + ['a', '&', '&', 'b', ';', 'c', '&', '&', 'd', '|', '|', 'e', ';', 'f', '>', + "'abc'", ';', '(', 'def', '"ghi"', ')'] + >>> list(shlex.shlex(text, punctuation_chars=True)) + ['a', '&&', 'b', ';', 'c', '&&', 'd', '||', 'e', ';', 'f', '>', "'abc'", + ';', '(', 'def', '"ghi"', ')'] + +Of course, tokens will be returned which are not valid for shells, and you'll +need to implement your own error checks on the returned tokens. + +Instead of passing ``True`` as the value for the punctuation_chars parameter, +you can pass a string with specific characters, which will be used to determine +which characters constitute punctuation. For example:: + + >>> import shlex + >>> s = shlex.shlex("a && b || c", punctuation_chars="|") + >>> list(s) + ['a', '&', '&', 'b', '||', 'c'] + +.. note:: When ``punctuation_chars`` is specified, the :attr:`~shlex.wordchars` + attribute is augmented with the characters ``~-./*?=``. That is because these + characters can appear in file names (including wildcards) and command-line + arguments (e.g. ``--color=auto``). Hence:: + + >>> import shlex + >>> s = shlex.shlex('~/a && b-c --color=auto || d *.py?', + ... punctuation_chars=True) + >>> list(s) + ['~/a', '&&', 'b-c', '--color=auto', '||', 'd', '*.py?'] + +For best effect, ``punctuation_chars`` should be set in conjunction with +``posix=True``. (Note that ``posix=False`` is the default for +:class:`~shlex.shlex`.) diff --git a/python-3.7.4-docs-html/_sources/library/shutil.rst.txt b/python-3.7.4-docs-html/_sources/library/shutil.rst.txt new file mode 100644 index 0000000..12e69a4 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/shutil.rst.txt @@ -0,0 +1,659 @@ +:mod:`shutil` --- High-level file operations +============================================ + +.. module:: shutil + :synopsis: High-level file operations, including copying. + +.. sectionauthor:: Fred L. Drake, Jr. +.. partly based on the docstrings + +**Source code:** :source:`Lib/shutil.py` + +.. index:: + single: file; copying + single: copying files + +-------------- + +The :mod:`shutil` module offers a number of high-level operations on files and +collections of files. In particular, functions are provided which support file +copying and removal. For operations on individual files, see also the +:mod:`os` module. + +.. warning:: + + Even the higher-level file copying functions (:func:`shutil.copy`, + :func:`shutil.copy2`) cannot copy all file metadata. + + On POSIX platforms, this means that file owner and group are lost as well + as ACLs. On Mac OS, the resource fork and other metadata are not used. + This means that resources will be lost and file type and creator codes will + not be correct. On Windows, file owners, ACLs and alternate data streams + are not copied. + + +.. _file-operations: + +Directory and files operations +------------------------------ + +.. function:: copyfileobj(fsrc, fdst[, length]) + + Copy the contents of the file-like object *fsrc* to the file-like object *fdst*. + The integer *length*, if given, is the buffer size. In particular, a negative + *length* value means to copy the data without looping over the source data in + chunks; by default the data is read in chunks to avoid uncontrolled memory + consumption. Note that if the current file position of the *fsrc* object is not + 0, only the contents from the current file position to the end of the file will + be copied. + + +.. function:: copyfile(src, dst, *, follow_symlinks=True) + + Copy the contents (no metadata) of the file named *src* to a file named + *dst* and return *dst*. *src* and *dst* are path names given as strings. + *dst* must be the complete target file name; look at :func:`shutil.copy` + for a copy that accepts a target directory path. If *src* and *dst* + specify the same file, :exc:`SameFileError` is raised. + + The destination location must be writable; otherwise, an :exc:`OSError` + exception will be raised. If *dst* already exists, it will be replaced. + Special files such as character or block devices and pipes cannot be + copied with this function. + + If *follow_symlinks* is false and *src* is a symbolic link, + a new symbolic link will be created instead of copying the + file *src* points to. + + .. versionchanged:: 3.3 + :exc:`IOError` used to be raised instead of :exc:`OSError`. + Added *follow_symlinks* argument. + Now returns *dst*. + + .. versionchanged:: 3.4 + Raise :exc:`SameFileError` instead of :exc:`Error`. Since the former is + a subclass of the latter, this change is backward compatible. + + +.. exception:: SameFileError + + This exception is raised if source and destination in :func:`copyfile` + are the same file. + + .. versionadded:: 3.4 + + +.. function:: copymode(src, dst, *, follow_symlinks=True) + + Copy the permission bits from *src* to *dst*. The file contents, owner, and + group are unaffected. *src* and *dst* are path names given as strings. + If *follow_symlinks* is false, and both *src* and *dst* are symbolic links, + :func:`copymode` will attempt to modify the mode of *dst* itself (rather + than the file it points to). This functionality is not available on every + platform; please see :func:`copystat` for more information. If + :func:`copymode` cannot modify symbolic links on the local platform, and it + is asked to do so, it will do nothing and return. + + .. versionchanged:: 3.3 + Added *follow_symlinks* argument. + +.. function:: copystat(src, dst, *, follow_symlinks=True) + + Copy the permission bits, last access time, last modification time, and + flags from *src* to *dst*. On Linux, :func:`copystat` also copies the + "extended attributes" where possible. The file contents, owner, and + group are unaffected. *src* and *dst* are path names given as strings. + + If *follow_symlinks* is false, and *src* and *dst* both + refer to symbolic links, :func:`copystat` will operate on + the symbolic links themselves rather than the files the + symbolic links refer to—reading the information from the + *src* symbolic link, and writing the information to the + *dst* symbolic link. + + .. note:: + + Not all platforms provide the ability to examine and + modify symbolic links. Python itself can tell you what + functionality is locally available. + + * If ``os.chmod in os.supports_follow_symlinks`` is + ``True``, :func:`copystat` can modify the permission + bits of a symbolic link. + + * If ``os.utime in os.supports_follow_symlinks`` is + ``True``, :func:`copystat` can modify the last access + and modification times of a symbolic link. + + * If ``os.chflags in os.supports_follow_symlinks`` is + ``True``, :func:`copystat` can modify the flags of + a symbolic link. (``os.chflags`` is not available on + all platforms.) + + On platforms where some or all of this functionality + is unavailable, when asked to modify a symbolic link, + :func:`copystat` will copy everything it can. + :func:`copystat` never returns failure. + + Please see :data:`os.supports_follow_symlinks` + for more information. + + .. versionchanged:: 3.3 + Added *follow_symlinks* argument and support for Linux extended attributes. + +.. function:: copy(src, dst, *, follow_symlinks=True) + + Copies the file *src* to the file or directory *dst*. *src* and *dst* + should be strings. If *dst* specifies a directory, the file will be + copied into *dst* using the base filename from *src*. Returns the + path to the newly created file. + + If *follow_symlinks* is false, and *src* is a symbolic link, + *dst* will be created as a symbolic link. If *follow_symlinks* + is true and *src* is a symbolic link, *dst* will be a copy of + the file *src* refers to. + + :func:`~shutil.copy` copies the file data and the file's permission + mode (see :func:`os.chmod`). Other metadata, like the + file's creation and modification times, is not preserved. + To preserve all file metadata from the original, use + :func:`~shutil.copy2` instead. + + .. versionchanged:: 3.3 + Added *follow_symlinks* argument. + Now returns path to the newly created file. + +.. function:: copy2(src, dst, *, follow_symlinks=True) + + Identical to :func:`~shutil.copy` except that :func:`copy2` + also attempts to preserve file metadata. + + When *follow_symlinks* is false, and *src* is a symbolic + link, :func:`copy2` attempts to copy all metadata from the + *src* symbolic link to the newly-created *dst* symbolic link. + However, this functionality is not available on all platforms. + On platforms where some or all of this functionality is + unavailable, :func:`copy2` will preserve all the metadata + it can; :func:`copy2` never returns failure. + + :func:`copy2` uses :func:`copystat` to copy the file metadata. + Please see :func:`copystat` for more information + about platform support for modifying symbolic link metadata. + + .. versionchanged:: 3.3 + Added *follow_symlinks* argument, try to copy extended + file system attributes too (currently Linux only). + Now returns path to the newly created file. + +.. function:: ignore_patterns(\*patterns) + + This factory function creates a function that can be used as a callable for + :func:`copytree`\'s *ignore* argument, ignoring files and directories that + match one of the glob-style *patterns* provided. See the example below. + + +.. function:: copytree(src, dst, symlinks=False, ignore=None, \ + copy_function=copy2, ignore_dangling_symlinks=False) + + Recursively copy an entire directory tree rooted at *src*, returning the + destination directory. The destination + directory, named by *dst*, must not already exist; it will be created as + well as missing parent directories. Permissions and times of directories + are copied with :func:`copystat`, individual files are copied using + :func:`shutil.copy2`. + + If *symlinks* is true, symbolic links in the source tree are represented as + symbolic links in the new tree and the metadata of the original links will + be copied as far as the platform allows; if false or omitted, the contents + and metadata of the linked files are copied to the new tree. + + When *symlinks* is false, if the file pointed by the symlink doesn't + exist, an exception will be added in the list of errors raised in + an :exc:`Error` exception at the end of the copy process. + You can set the optional *ignore_dangling_symlinks* flag to true if you + want to silence this exception. Notice that this option has no effect + on platforms that don't support :func:`os.symlink`. + + If *ignore* is given, it must be a callable that will receive as its + arguments the directory being visited by :func:`copytree`, and a list of its + contents, as returned by :func:`os.listdir`. Since :func:`copytree` is + called recursively, the *ignore* callable will be called once for each + directory that is copied. The callable must return a sequence of directory + and file names relative to the current directory (i.e. a subset of the items + in its second argument); these names will then be ignored in the copy + process. :func:`ignore_patterns` can be used to create such a callable that + ignores names based on glob-style patterns. + + If exception(s) occur, an :exc:`Error` is raised with a list of reasons. + + If *copy_function* is given, it must be a callable that will be used to copy + each file. It will be called with the source path and the destination path + as arguments. By default, :func:`shutil.copy2` is used, but any function + that supports the same signature (like :func:`shutil.copy`) can be used. + + .. versionchanged:: 3.3 + Copy metadata when *symlinks* is false. + Now returns *dst*. + + .. versionchanged:: 3.2 + Added the *copy_function* argument to be able to provide a custom copy + function. + Added the *ignore_dangling_symlinks* argument to silent dangling symlinks + errors when *symlinks* is false. + + +.. function:: rmtree(path, ignore_errors=False, onerror=None) + + .. index:: single: directory; deleting + + Delete an entire directory tree; *path* must point to a directory (but not a + symbolic link to a directory). If *ignore_errors* is true, errors resulting + from failed removals will be ignored; if false or omitted, such errors are + handled by calling a handler specified by *onerror* or, if that is omitted, + they raise an exception. + + .. note:: + + On platforms that support the necessary fd-based functions a symlink + attack resistant version of :func:`rmtree` is used by default. On other + platforms, the :func:`rmtree` implementation is susceptible to a symlink + attack: given proper timing and circumstances, attackers can manipulate + symlinks on the filesystem to delete files they wouldn't be able to access + otherwise. Applications can use the :data:`rmtree.avoids_symlink_attacks` + function attribute to determine which case applies. + + If *onerror* is provided, it must be a callable that accepts three + parameters: *function*, *path*, and *excinfo*. + + The first parameter, *function*, is the function which raised the exception; + it depends on the platform and implementation. The second parameter, + *path*, will be the path name passed to *function*. The third parameter, + *excinfo*, will be the exception information returned by + :func:`sys.exc_info`. Exceptions raised by *onerror* will not be caught. + + .. versionchanged:: 3.3 + Added a symlink attack resistant version that is used automatically + if platform supports fd-based functions. + + .. attribute:: rmtree.avoids_symlink_attacks + + Indicates whether the current platform and implementation provides a + symlink attack resistant version of :func:`rmtree`. Currently this is + only true for platforms supporting fd-based directory access functions. + + .. versionadded:: 3.3 + + +.. function:: move(src, dst, copy_function=copy2) + + Recursively move a file or directory (*src*) to another location (*dst*) + and return the destination. + + If the destination is an existing directory, then *src* is moved inside that + directory. If the destination already exists but is not a directory, it may + be overwritten depending on :func:`os.rename` semantics. + + If the destination is on the current filesystem, then :func:`os.rename` is + used. Otherwise, *src* is copied to *dst* using *copy_function* and then + removed. In case of symlinks, a new symlink pointing to the target of *src* + will be created in or as *dst* and *src* will be removed. + + If *copy_function* is given, it must be a callable that takes two arguments + *src* and *dst*, and will be used to copy *src* to *dest* if + :func:`os.rename` cannot be used. If the source is a directory, + :func:`copytree` is called, passing it the :func:`copy_function`. The + default *copy_function* is :func:`copy2`. Using :func:`~shutil.copy` as the + *copy_function* allows the move to succeed when it is not possible to also + copy the metadata, at the expense of not copying any of the metadata. + + .. versionchanged:: 3.3 + Added explicit symlink handling for foreign filesystems, thus adapting + it to the behavior of GNU's :program:`mv`. + Now returns *dst*. + + .. versionchanged:: 3.5 + Added the *copy_function* keyword argument. + +.. function:: disk_usage(path) + + Return disk usage statistics about the given path as a :term:`named tuple` + with the attributes *total*, *used* and *free*, which are the amount of + total, used and free space, in bytes. On Windows, *path* must be a + directory; on Unix, it can be a file or directory. + + .. versionadded:: 3.3 + + .. availability:: Unix, Windows. + +.. function:: chown(path, user=None, group=None) + + Change owner *user* and/or *group* of the given *path*. + + *user* can be a system user name or a uid; the same applies to *group*. At + least one argument is required. + + See also :func:`os.chown`, the underlying function. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. function:: which(cmd, mode=os.F_OK | os.X_OK, path=None) + + Return the path to an executable which would be run if the given *cmd* was + called. If no *cmd* would be called, return ``None``. + + *mode* is a permission mask passed to :func:`os.access`, by default + determining if the file exists and executable. + + When no *path* is specified, the results of :func:`os.environ` are used, + returning either the "PATH" value or a fallback of :attr:`os.defpath`. + + On Windows, the current directory is always prepended to the *path* whether + or not you use the default or provide your own, which is the behavior the + command shell uses when finding executables. Additionally, when finding the + *cmd* in the *path*, the ``PATHEXT`` environment variable is checked. For + example, if you call ``shutil.which("python")``, :func:`which` will search + ``PATHEXT`` to know that it should look for ``python.exe`` within the *path* + directories. For example, on Windows:: + + >>> shutil.which("python") + 'C:\\Python33\\python.EXE' + + .. versionadded:: 3.3 + + +.. exception:: Error + + This exception collects exceptions that are raised during a multi-file + operation. For :func:`copytree`, the exception argument is a list of 3-tuples + (*srcname*, *dstname*, *exception*). + + +.. _shutil-copytree-example: + +copytree example +~~~~~~~~~~~~~~~~ + +This example is the implementation of the :func:`copytree` function, described +above, with the docstring omitted. It demonstrates many of the other functions +provided by this module. :: + + def copytree(src, dst, symlinks=False): + names = os.listdir(src) + os.makedirs(dst) + errors = [] + for name in names: + srcname = os.path.join(src, name) + dstname = os.path.join(dst, name) + try: + if symlinks and os.path.islink(srcname): + linkto = os.readlink(srcname) + os.symlink(linkto, dstname) + elif os.path.isdir(srcname): + copytree(srcname, dstname, symlinks) + else: + copy2(srcname, dstname) + # XXX What about devices, sockets etc.? + except OSError as why: + errors.append((srcname, dstname, str(why))) + # catch the Error from the recursive copytree so that we can + # continue with other files + except Error as err: + errors.extend(err.args[0]) + try: + copystat(src, dst) + except OSError as why: + # can't copy file access times on Windows + if why.winerror is None: + errors.extend((src, dst, str(why))) + if errors: + raise Error(errors) + +Another example that uses the :func:`ignore_patterns` helper:: + + from shutil import copytree, ignore_patterns + + copytree(source, destination, ignore=ignore_patterns('*.pyc', 'tmp*')) + +This will copy everything except ``.pyc`` files and files or directories whose +name starts with ``tmp``. + +Another example that uses the *ignore* argument to add a logging call:: + + from shutil import copytree + import logging + + def _logpath(path, names): + logging.info('Working in %s', path) + return [] # nothing will be ignored + + copytree(source, destination, ignore=_logpath) + + +.. _shutil-rmtree-example: + +rmtree example +~~~~~~~~~~~~~~ + +This example shows how to remove a directory tree on Windows where some +of the files have their read-only bit set. It uses the onerror callback +to clear the readonly bit and reattempt the remove. Any subsequent failure +will propagate. :: + + import os, stat + import shutil + + def remove_readonly(func, path, _): + "Clear the readonly bit and reattempt the removal" + os.chmod(path, stat.S_IWRITE) + func(path) + + shutil.rmtree(directory, onerror=remove_readonly) + +.. _archiving-operations: + +Archiving operations +-------------------- + +.. versionadded:: 3.2 + +.. versionchanged:: 3.5 + Added support for the *xztar* format. + + +High-level utilities to create and read compressed and archived files are also +provided. They rely on the :mod:`zipfile` and :mod:`tarfile` modules. + +.. function:: make_archive(base_name, format, [root_dir, [base_dir, [verbose, [dry_run, [owner, [group, [logger]]]]]]]) + + Create an archive file (such as zip or tar) and return its name. + + *base_name* is the name of the file to create, including the path, minus + any format-specific extension. *format* is the archive format: one of + "zip" (if the :mod:`zlib` module is available), "tar", "gztar" (if the + :mod:`zlib` module is available), "bztar" (if the :mod:`bz2` module is + available), or "xztar" (if the :mod:`lzma` module is available). + + *root_dir* is a directory that will be the root directory of the + archive; for example, we typically chdir into *root_dir* before creating the + archive. + + *base_dir* is the directory where we start archiving from; + i.e. *base_dir* will be the common prefix of all files and + directories in the archive. + + *root_dir* and *base_dir* both default to the current directory. + + If *dry_run* is true, no archive is created, but the operations that would be + executed are logged to *logger*. + + *owner* and *group* are used when creating a tar archive. By default, + uses the current owner and group. + + *logger* must be an object compatible with :pep:`282`, usually an instance of + :class:`logging.Logger`. + + The *verbose* argument is unused and deprecated. + + +.. function:: get_archive_formats() + + Return a list of supported formats for archiving. + Each element of the returned sequence is a tuple ``(name, description)``. + + By default :mod:`shutil` provides these formats: + + - *zip*: ZIP file (if the :mod:`zlib` module is available). + - *tar*: uncompressed tar file. + - *gztar*: gzip'ed tar-file (if the :mod:`zlib` module is available). + - *bztar*: bzip2'ed tar-file (if the :mod:`bz2` module is available). + - *xztar*: xz'ed tar-file (if the :mod:`lzma` module is available). + + You can register new formats or provide your own archiver for any existing + formats, by using :func:`register_archive_format`. + + +.. function:: register_archive_format(name, function, [extra_args, [description]]) + + Register an archiver for the format *name*. + + *function* is the callable that will be used to unpack archives. The callable + will receive the *base_name* of the file to create, followed by the + *base_dir* (which defaults to :data:`os.curdir`) to start archiving from. + Further arguments are passed as keyword arguments: *owner*, *group*, + *dry_run* and *logger* (as passed in :func:`make_archive`). + + If given, *extra_args* is a sequence of ``(name, value)`` pairs that will be + used as extra keywords arguments when the archiver callable is used. + + *description* is used by :func:`get_archive_formats` which returns the + list of archivers. Defaults to an empty string. + + +.. function:: unregister_archive_format(name) + + Remove the archive format *name* from the list of supported formats. + + +.. function:: unpack_archive(filename[, extract_dir[, format]]) + + Unpack an archive. *filename* is the full path of the archive. + + *extract_dir* is the name of the target directory where the archive is + unpacked. If not provided, the current working directory is used. + + *format* is the archive format: one of "zip", "tar", "gztar", "bztar", or + "xztar". Or any other format registered with + :func:`register_unpack_format`. If not provided, :func:`unpack_archive` + will use the archive file name extension and see if an unpacker was + registered for that extension. In case none is found, + a :exc:`ValueError` is raised. + + .. versionchanged:: 3.7 + Accepts a :term:`path-like object` for *filename* and *extract_dir*. + + +.. function:: register_unpack_format(name, extensions, function[, extra_args[, description]]) + + Registers an unpack format. *name* is the name of the format and + *extensions* is a list of extensions corresponding to the format, like + ``.zip`` for Zip files. + + *function* is the callable that will be used to unpack archives. The + callable will receive the path of the archive, followed by the directory + the archive must be extracted to. + + When provided, *extra_args* is a sequence of ``(name, value)`` tuples that + will be passed as keywords arguments to the callable. + + *description* can be provided to describe the format, and will be returned + by the :func:`get_unpack_formats` function. + + +.. function:: unregister_unpack_format(name) + + Unregister an unpack format. *name* is the name of the format. + + +.. function:: get_unpack_formats() + + Return a list of all registered formats for unpacking. + Each element of the returned sequence is a tuple + ``(name, extensions, description)``. + + By default :mod:`shutil` provides these formats: + + - *zip*: ZIP file (unpacking compressed files works only if the corresponding + module is available). + - *tar*: uncompressed tar file. + - *gztar*: gzip'ed tar-file (if the :mod:`zlib` module is available). + - *bztar*: bzip2'ed tar-file (if the :mod:`bz2` module is available). + - *xztar*: xz'ed tar-file (if the :mod:`lzma` module is available). + + You can register new formats or provide your own unpacker for any existing + formats, by using :func:`register_unpack_format`. + + +.. _shutil-archiving-example: + +Archiving example +~~~~~~~~~~~~~~~~~ + +In this example, we create a gzip'ed tar-file archive containing all files +found in the :file:`.ssh` directory of the user:: + + >>> from shutil import make_archive + >>> import os + >>> archive_name = os.path.expanduser(os.path.join('~', 'myarchive')) + >>> root_dir = os.path.expanduser(os.path.join('~', '.ssh')) + >>> make_archive(archive_name, 'gztar', root_dir) + '/Users/tarek/myarchive.tar.gz' + +The resulting archive contains: + +.. code-block:: shell-session + + $ tar -tzvf /Users/tarek/myarchive.tar.gz + drwx------ tarek/staff 0 2010-02-01 16:23:40 ./ + -rw-r--r-- tarek/staff 609 2008-06-09 13:26:54 ./authorized_keys + -rwxr-xr-x tarek/staff 65 2008-06-09 13:26:54 ./config + -rwx------ tarek/staff 668 2008-06-09 13:26:54 ./id_dsa + -rwxr-xr-x tarek/staff 609 2008-06-09 13:26:54 ./id_dsa.pub + -rw------- tarek/staff 1675 2008-06-09 13:26:54 ./id_rsa + -rw-r--r-- tarek/staff 397 2008-06-09 13:26:54 ./id_rsa.pub + -rw-r--r-- tarek/staff 37192 2010-02-06 18:23:10 ./known_hosts + + +Querying the size of the output terminal +---------------------------------------- + +.. function:: get_terminal_size(fallback=(columns, lines)) + + Get the size of the terminal window. + + For each of the two dimensions, the environment variable, ``COLUMNS`` + and ``LINES`` respectively, is checked. If the variable is defined and + the value is a positive integer, it is used. + + When ``COLUMNS`` or ``LINES`` is not defined, which is the common case, + the terminal connected to :data:`sys.__stdout__` is queried + by invoking :func:`os.get_terminal_size`. + + If the terminal size cannot be successfully queried, either because + the system doesn't support querying, or because we are not + connected to a terminal, the value given in ``fallback`` parameter + is used. ``fallback`` defaults to ``(80, 24)`` which is the default + size used by many terminal emulators. + + The value returned is a named tuple of type :class:`os.terminal_size`. + + See also: The Single UNIX Specification, Version 2, + `Other Environment Variables`_. + + .. versionadded:: 3.3 + +.. _`Other Environment Variables`: + http://pubs.opengroup.org/onlinepubs/7908799/xbd/envvar.html#tag_002_003 + diff --git a/python-3.7.4-docs-html/_sources/library/signal.rst.txt b/python-3.7.4-docs-html/_sources/library/signal.rst.txt new file mode 100644 index 0000000..b6716ee --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/signal.rst.txt @@ -0,0 +1,529 @@ +:mod:`signal` --- Set handlers for asynchronous events +====================================================== + +.. module:: signal + :synopsis: Set handlers for asynchronous events. + +-------------- + +This module provides mechanisms to use signal handlers in Python. + + +General rules +------------- + +The :func:`signal.signal` function allows defining custom handlers to be +executed when a signal is received. A small number of default handlers are +installed: :const:`SIGPIPE` is ignored (so write errors on pipes and sockets +can be reported as ordinary Python exceptions) and :const:`SIGINT` is +translated into a :exc:`KeyboardInterrupt` exception if the parent process +has not changed it. + +A handler for a particular signal, once set, remains installed until it is +explicitly reset (Python emulates the BSD style interface regardless of the +underlying implementation), with the exception of the handler for +:const:`SIGCHLD`, which follows the underlying implementation. + + +Execution of Python signal handlers +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +A Python signal handler does not get executed inside the low-level (C) signal +handler. Instead, the low-level signal handler sets a flag which tells the +:term:`virtual machine` to execute the corresponding Python signal handler +at a later point(for example at the next :term:`bytecode` instruction). +This has consequences: + +* It makes little sense to catch synchronous errors like :const:`SIGFPE` or + :const:`SIGSEGV` that are caused by an invalid operation in C code. Python + will return from the signal handler to the C code, which is likely to raise + the same signal again, causing Python to apparently hang. From Python 3.3 + onwards, you can use the :mod:`faulthandler` module to report on synchronous + errors. + +* A long-running calculation implemented purely in C (such as regular + expression matching on a large body of text) may run uninterrupted for an + arbitrary amount of time, regardless of any signals received. The Python + signal handlers will be called when the calculation finishes. + + +.. _signals-and-threads: + + +Signals and threads +^^^^^^^^^^^^^^^^^^^ + +Python signal handlers are always executed in the main Python thread, +even if the signal was received in another thread. This means that signals +can't be used as a means of inter-thread communication. You can use +the synchronization primitives from the :mod:`threading` module instead. + +Besides, only the main thread is allowed to set a new signal handler. + + +Module contents +--------------- + +.. versionchanged:: 3.5 + signal (SIG*), handler (:const:`SIG_DFL`, :const:`SIG_IGN`) and sigmask + (:const:`SIG_BLOCK`, :const:`SIG_UNBLOCK`, :const:`SIG_SETMASK`) + related constants listed below were turned into + :class:`enums `. + :func:`getsignal`, :func:`pthread_sigmask`, :func:`sigpending` and + :func:`sigwait` functions return human-readable + :class:`enums `. + + +The variables defined in the :mod:`signal` module are: + + +.. data:: SIG_DFL + + This is one of two standard signal handling options; it will simply perform + the default function for the signal. For example, on most systems the + default action for :const:`SIGQUIT` is to dump core and exit, while the + default action for :const:`SIGCHLD` is to simply ignore it. + + +.. data:: SIG_IGN + + This is another standard signal handler, which will simply ignore the given + signal. + + +.. data:: SIG* + + All the signal numbers are defined symbolically. For example, the hangup signal + is defined as :const:`signal.SIGHUP`; the variable names are identical to the + names used in C programs, as found in ````. The Unix man page for + ':c:func:`signal`' lists the existing signals (on some systems this is + :manpage:`signal(2)`, on others the list is in :manpage:`signal(7)`). Note that + not all systems define the same set of signal names; only those names defined by + the system are defined by this module. + + +.. data:: CTRL_C_EVENT + + The signal corresponding to the :kbd:`Ctrl+C` keystroke event. This signal can + only be used with :func:`os.kill`. + + .. availability:: Windows. + + .. versionadded:: 3.2 + + +.. data:: CTRL_BREAK_EVENT + + The signal corresponding to the :kbd:`Ctrl+Break` keystroke event. This signal can + only be used with :func:`os.kill`. + + .. availability:: Windows. + + .. versionadded:: 3.2 + + +.. data:: NSIG + + One more than the number of the highest signal number. + + +.. data:: ITIMER_REAL + + Decrements interval timer in real time, and delivers :const:`SIGALRM` upon + expiration. + + +.. data:: ITIMER_VIRTUAL + + Decrements interval timer only when the process is executing, and delivers + SIGVTALRM upon expiration. + + +.. data:: ITIMER_PROF + + Decrements interval timer both when the process executes and when the + system is executing on behalf of the process. Coupled with ITIMER_VIRTUAL, + this timer is usually used to profile the time spent by the application + in user and kernel space. SIGPROF is delivered upon expiration. + + +.. data:: SIG_BLOCK + + A possible value for the *how* parameter to :func:`pthread_sigmask` + indicating that signals are to be blocked. + + .. versionadded:: 3.3 + +.. data:: SIG_UNBLOCK + + A possible value for the *how* parameter to :func:`pthread_sigmask` + indicating that signals are to be unblocked. + + .. versionadded:: 3.3 + +.. data:: SIG_SETMASK + + A possible value for the *how* parameter to :func:`pthread_sigmask` + indicating that the signal mask is to be replaced. + + .. versionadded:: 3.3 + + +The :mod:`signal` module defines one exception: + +.. exception:: ItimerError + + Raised to signal an error from the underlying :func:`setitimer` or + :func:`getitimer` implementation. Expect this error if an invalid + interval timer or a negative time is passed to :func:`setitimer`. + This error is a subtype of :exc:`OSError`. + + .. versionadded:: 3.3 + This error used to be a subtype of :exc:`IOError`, which is now an + alias of :exc:`OSError`. + + +The :mod:`signal` module defines the following functions: + + +.. function:: alarm(time) + + If *time* is non-zero, this function requests that a :const:`SIGALRM` signal be + sent to the process in *time* seconds. Any previously scheduled alarm is + canceled (only one alarm can be scheduled at any time). The returned value is + then the number of seconds before any previously set alarm was to have been + delivered. If *time* is zero, no alarm is scheduled, and any scheduled alarm is + canceled. If the return value is zero, no alarm is currently scheduled. (See + the Unix man page :manpage:`alarm(2)`.) + + .. availability:: Unix. + + +.. function:: getsignal(signalnum) + + Return the current signal handler for the signal *signalnum*. The returned value + may be a callable Python object, or one of the special values + :const:`signal.SIG_IGN`, :const:`signal.SIG_DFL` or :const:`None`. Here, + :const:`signal.SIG_IGN` means that the signal was previously ignored, + :const:`signal.SIG_DFL` means that the default way of handling the signal was + previously in use, and ``None`` means that the previous signal handler was not + installed from Python. + + +.. function:: pause() + + Cause the process to sleep until a signal is received; the appropriate handler + will then be called. Returns nothing. Not on Windows. (See the Unix man page + :manpage:`signal(2)`.) + + See also :func:`sigwait`, :func:`sigwaitinfo`, :func:`sigtimedwait` and + :func:`sigpending`. + + +.. function:: pthread_kill(thread_id, signalnum) + + Send the signal *signalnum* to the thread *thread_id*, another thread in the + same process as the caller. The target thread can be executing any code + (Python or not). However, if the target thread is executing the Python + interpreter, the Python signal handlers will be :ref:`executed by the main + thread `. Therefore, the only point of sending a + signal to a particular Python thread would be to force a running system call + to fail with :exc:`InterruptedError`. + + Use :func:`threading.get_ident()` or the :attr:`~threading.Thread.ident` + attribute of :class:`threading.Thread` objects to get a suitable value + for *thread_id*. + + If *signalnum* is 0, then no signal is sent, but error checking is still + performed; this can be used to check if the target thread is still running. + + .. availability:: Unix (see the man page :manpage:`pthread_kill(3)` for further + information). + + See also :func:`os.kill`. + + .. versionadded:: 3.3 + + +.. function:: pthread_sigmask(how, mask) + + Fetch and/or change the signal mask of the calling thread. The signal mask + is the set of signals whose delivery is currently blocked for the caller. + Return the old signal mask as a set of signals. + + The behavior of the call is dependent on the value of *how*, as follows. + + * :data:`SIG_BLOCK`: The set of blocked signals is the union of the current + set and the *mask* argument. + * :data:`SIG_UNBLOCK`: The signals in *mask* are removed from the current + set of blocked signals. It is permissible to attempt to unblock a + signal which is not blocked. + * :data:`SIG_SETMASK`: The set of blocked signals is set to the *mask* + argument. + + *mask* is a set of signal numbers (e.g. {:const:`signal.SIGINT`, + :const:`signal.SIGTERM`}). Use ``range(1, signal.NSIG)`` for a full mask + including all signals. + + For example, ``signal.pthread_sigmask(signal.SIG_BLOCK, [])`` reads the + signal mask of the calling thread. + + .. availability:: Unix. See the man page :manpage:`sigprocmask(3)` and + :manpage:`pthread_sigmask(3)` for further information. + + See also :func:`pause`, :func:`sigpending` and :func:`sigwait`. + + .. versionadded:: 3.3 + + +.. function:: setitimer(which, seconds, interval=0.0) + + Sets given interval timer (one of :const:`signal.ITIMER_REAL`, + :const:`signal.ITIMER_VIRTUAL` or :const:`signal.ITIMER_PROF`) specified + by *which* to fire after *seconds* (float is accepted, different from + :func:`alarm`) and after that every *interval* seconds (if *interval* + is non-zero). The interval timer specified by *which* can be cleared by + setting *seconds* to zero. + + When an interval timer fires, a signal is sent to the process. + The signal sent is dependent on the timer being used; + :const:`signal.ITIMER_REAL` will deliver :const:`SIGALRM`, + :const:`signal.ITIMER_VIRTUAL` sends :const:`SIGVTALRM`, + and :const:`signal.ITIMER_PROF` will deliver :const:`SIGPROF`. + + The old values are returned as a tuple: (delay, interval). + + Attempting to pass an invalid interval timer will cause an + :exc:`ItimerError`. + + .. availability:: Unix. + + +.. function:: getitimer(which) + + Returns current value of a given interval timer specified by *which*. + + .. availability:: Unix. + + +.. function:: set_wakeup_fd(fd, *, warn_on_full_buffer=True) + + Set the wakeup file descriptor to *fd*. When a signal is received, the + signal number is written as a single byte into the fd. This can be used by + a library to wakeup a poll or select call, allowing the signal to be fully + processed. + + The old wakeup fd is returned (or -1 if file descriptor wakeup was not + enabled). If *fd* is -1, file descriptor wakeup is disabled. + If not -1, *fd* must be non-blocking. It is up to the library to remove + any bytes from *fd* before calling poll or select again. + + When threads are enabled, this function can only be called from the main thread; + attempting to call it from other threads will cause a :exc:`ValueError` + exception to be raised. + + There are two common ways to use this function. In both approaches, + you use the fd to wake up when a signal arrives, but then they + differ in how they determine *which* signal or signals have + arrived. + + In the first approach, we read the data out of the fd's buffer, and + the byte values give you the signal numbers. This is simple, but in + rare cases it can run into a problem: generally the fd will have a + limited amount of buffer space, and if too many signals arrive too + quickly, then the buffer may become full, and some signals may be + lost. If you use this approach, then you should set + ``warn_on_full_buffer=True``, which will at least cause a warning + to be printed to stderr when signals are lost. + + In the second approach, we use the wakeup fd *only* for wakeups, + and ignore the actual byte values. In this case, all we care about + is whether the fd's buffer is empty or non-empty; a full buffer + doesn't indicate a problem at all. If you use this approach, then + you should set ``warn_on_full_buffer=False``, so that your users + are not confused by spurious warning messages. + + .. versionchanged:: 3.5 + On Windows, the function now also supports socket handles. + + .. versionchanged:: 3.7 + Added ``warn_on_full_buffer`` parameter. + +.. function:: siginterrupt(signalnum, flag) + + Change system call restart behaviour: if *flag* is :const:`False`, system + calls will be restarted when interrupted by signal *signalnum*, otherwise + system calls will be interrupted. Returns nothing. + + .. availability:: Unix (see the man page :manpage:`siginterrupt(3)` + for further information). + + Note that installing a signal handler with :func:`signal` will reset the + restart behaviour to interruptible by implicitly calling + :c:func:`siginterrupt` with a true *flag* value for the given signal. + + +.. function:: signal(signalnum, handler) + + Set the handler for signal *signalnum* to the function *handler*. *handler* can + be a callable Python object taking two arguments (see below), or one of the + special values :const:`signal.SIG_IGN` or :const:`signal.SIG_DFL`. The previous + signal handler will be returned (see the description of :func:`getsignal` + above). (See the Unix man page :manpage:`signal(2)`.) + + When threads are enabled, this function can only be called from the main thread; + attempting to call it from other threads will cause a :exc:`ValueError` + exception to be raised. + + The *handler* is called with two arguments: the signal number and the current + stack frame (``None`` or a frame object; for a description of frame objects, + see the :ref:`description in the type hierarchy ` or see the + attribute descriptions in the :mod:`inspect` module). + + On Windows, :func:`signal` can only be called with :const:`SIGABRT`, + :const:`SIGFPE`, :const:`SIGILL`, :const:`SIGINT`, :const:`SIGSEGV`, + :const:`SIGTERM`, or :const:`SIGBREAK`. + A :exc:`ValueError` will be raised in any other case. + Note that not all systems define the same set of signal names; an + :exc:`AttributeError` will be raised if a signal name is not defined as + ``SIG*`` module level constant. + + +.. function:: sigpending() + + Examine the set of signals that are pending for delivery to the calling + thread (i.e., the signals which have been raised while blocked). Return the + set of the pending signals. + + .. availability:: Unix (see the man page :manpage:`sigpending(2)` for further + information). + + See also :func:`pause`, :func:`pthread_sigmask` and :func:`sigwait`. + + .. versionadded:: 3.3 + + +.. function:: sigwait(sigset) + + Suspend execution of the calling thread until the delivery of one of the + signals specified in the signal set *sigset*. The function accepts the signal + (removes it from the pending list of signals), and returns the signal number. + + .. availability:: Unix (see the man page :manpage:`sigwait(3)` for further + information). + + See also :func:`pause`, :func:`pthread_sigmask`, :func:`sigpending`, + :func:`sigwaitinfo` and :func:`sigtimedwait`. + + .. versionadded:: 3.3 + + +.. function:: sigwaitinfo(sigset) + + Suspend execution of the calling thread until the delivery of one of the + signals specified in the signal set *sigset*. The function accepts the + signal and removes it from the pending list of signals. If one of the + signals in *sigset* is already pending for the calling thread, the function + will return immediately with information about that signal. The signal + handler is not called for the delivered signal. The function raises an + :exc:`InterruptedError` if it is interrupted by a signal that is not in + *sigset*. + + The return value is an object representing the data contained in the + :c:type:`siginfo_t` structure, namely: :attr:`si_signo`, :attr:`si_code`, + :attr:`si_errno`, :attr:`si_pid`, :attr:`si_uid`, :attr:`si_status`, + :attr:`si_band`. + + .. availability:: Unix (see the man page :manpage:`sigwaitinfo(2)` for further + information). + + See also :func:`pause`, :func:`sigwait` and :func:`sigtimedwait`. + + .. versionadded:: 3.3 + + .. versionchanged:: 3.5 + The function is now retried if interrupted by a signal not in *sigset* + and the signal handler does not raise an exception (see :pep:`475` for + the rationale). + + +.. function:: sigtimedwait(sigset, timeout) + + Like :func:`sigwaitinfo`, but takes an additional *timeout* argument + specifying a timeout. If *timeout* is specified as :const:`0`, a poll is + performed. Returns :const:`None` if a timeout occurs. + + .. availability:: Unix (see the man page :manpage:`sigtimedwait(2)` for further + information). + + See also :func:`pause`, :func:`sigwait` and :func:`sigwaitinfo`. + + .. versionadded:: 3.3 + + .. versionchanged:: 3.5 + The function is now retried with the recomputed *timeout* if interrupted + by a signal not in *sigset* and the signal handler does not raise an + exception (see :pep:`475` for the rationale). + + +.. _signal-example: + +Example +------- + +Here is a minimal example program. It uses the :func:`alarm` function to limit +the time spent waiting to open a file; this is useful if the file is for a +serial device that may not be turned on, which would normally cause the +:func:`os.open` to hang indefinitely. The solution is to set a 5-second alarm +before opening the file; if the operation takes too long, the alarm signal will +be sent, and the handler raises an exception. :: + + import signal, os + + def handler(signum, frame): + print('Signal handler called with signal', signum) + raise OSError("Couldn't open device!") + + # Set the signal handler and a 5-second alarm + signal.signal(signal.SIGALRM, handler) + signal.alarm(5) + + # This open() may hang indefinitely + fd = os.open('/dev/ttyS0', os.O_RDWR) + + signal.alarm(0) # Disable the alarm + +Note on SIGPIPE +--------------- + +Piping output of your program to tools like :manpage:`head(1)` will +cause a :const:`SIGPIPE` signal to be sent to your process when the receiver +of its standard output closes early. This results in an exception +like :code:`BrokenPipeError: [Errno 32] Broken pipe`. To handle this +case, wrap your entry point to catch this exception as follows:: + + import os + import sys + + def main(): + try: + # simulate large output (your code replaces this loop) + for x in range(10000): + print("y") + # flush output here to force SIGPIPE to be triggered + # while inside this try block. + sys.stdout.flush() + except BrokenPipeError: + # Python flushes standard streams on exit; redirect remaining output + # to devnull to avoid another BrokenPipeError at shutdown + devnull = os.open(os.devnull, os.O_WRONLY) + os.dup2(devnull, sys.stdout.fileno()) + sys.exit(1) # Python exits with error code 1 on EPIPE + + if __name__ == '__main__': + main() + +Do not set :const:`SIGPIPE`'s disposition to :const:`SIG_DFL` +in order to avoid :exc:`BrokenPipeError`. Doing that would cause +your program to exit unexpectedly also whenever any socket connection +is interrupted while your program is still writing to it. diff --git a/python-3.7.4-docs-html/_sources/library/site.rst.txt b/python-3.7.4-docs-html/_sources/library/site.rst.txt new file mode 100644 index 0000000..7974e20 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/site.rst.txt @@ -0,0 +1,259 @@ +:mod:`site` --- Site-specific configuration hook +================================================ + +.. module:: site + :synopsis: Module responsible for site-specific configuration. + +**Source code:** :source:`Lib/site.py` + +-------------- + +.. highlightlang:: none + +**This module is automatically imported during initialization.** The automatic +import can be suppressed using the interpreter's :option:`-S` option. + +.. index:: triple: module; search; path + +Importing this module will append site-specific paths to the module search path +and add a few builtins, unless :option:`-S` was used. In that case, this module +can be safely imported with no automatic modifications to the module search path +or additions to the builtins. To explicitly trigger the usual site-specific +additions, call the :func:`site.main` function. + +.. versionchanged:: 3.3 + Importing the module used to trigger paths manipulation even when using + :option:`-S`. + +.. index:: + pair: site-packages; directory + +It starts by constructing up to four directories from a head and a tail part. +For the head part, it uses ``sys.prefix`` and ``sys.exec_prefix``; empty heads +are skipped. For the tail part, it uses the empty string and then +:file:`lib/site-packages` (on Windows) or +:file:`lib/python{X.Y}/site-packages` (on Unix and Macintosh). For each +of the distinct head-tail combinations, it sees if it refers to an existing +directory, and if so, adds it to ``sys.path`` and also inspects the newly +added path for configuration files. + +.. versionchanged:: 3.5 + Support for the "site-python" directory has been removed. + +If a file named "pyvenv.cfg" exists one directory above sys.executable, +sys.prefix and sys.exec_prefix are set to that directory and +it is also checked for site-packages (sys.base_prefix and +sys.base_exec_prefix will always be the "real" prefixes of the Python +installation). If "pyvenv.cfg" (a bootstrap configuration file) contains +the key "include-system-site-packages" set to anything other than "false" +(case-insensitive), the system-level prefixes will still also be +searched for site-packages; otherwise they won't. + +.. index:: + single: # (hash); comment + statement: import + +A path configuration file is a file whose name has the form :file:`{name}.pth` +and exists in one of the four directories mentioned above; its contents are +additional items (one per line) to be added to ``sys.path``. Non-existing items +are never added to ``sys.path``, and no check is made that the item refers to a +directory rather than a file. No item is added to ``sys.path`` more than +once. Blank lines and lines beginning with ``#`` are skipped. Lines starting +with ``import`` (followed by space or tab) are executed. + +.. index:: + single: package + triple: path; configuration; file + +For example, suppose ``sys.prefix`` and ``sys.exec_prefix`` are set to +:file:`/usr/local`. The Python X.Y library is then installed in +:file:`/usr/local/lib/python{X.Y}`. Suppose this has +a subdirectory :file:`/usr/local/lib/python{X.Y}/site-packages` with three +subsubdirectories, :file:`foo`, :file:`bar` and :file:`spam`, and two path +configuration files, :file:`foo.pth` and :file:`bar.pth`. Assume +:file:`foo.pth` contains the following:: + + # foo package configuration + + foo + bar + bletch + +and :file:`bar.pth` contains:: + + # bar package configuration + + bar + +Then the following version-specific directories are added to +``sys.path``, in this order:: + + /usr/local/lib/pythonX.Y/site-packages/bar + /usr/local/lib/pythonX.Y/site-packages/foo + +Note that :file:`bletch` is omitted because it doesn't exist; the :file:`bar` +directory precedes the :file:`foo` directory because :file:`bar.pth` comes +alphabetically before :file:`foo.pth`; and :file:`spam` is omitted because it is +not mentioned in either path configuration file. + +.. index:: module: sitecustomize + +After these path manipulations, an attempt is made to import a module named +:mod:`sitecustomize`, which can perform arbitrary site-specific customizations. +It is typically created by a system administrator in the site-packages +directory. If this import fails with an :exc:`ImportError` or its subclass +exception, and the exception's :attr:`name` attribute equals to ``'sitecustomize'``, +it is silently ignored. If Python is started without output streams available, as +with :file:`pythonw.exe` on Windows (which is used by default to start IDLE), +attempted output from :mod:`sitecustomize` is ignored. Any other exception +causes a silent and perhaps mysterious failure of the process. + +.. index:: module: usercustomize + +After this, an attempt is made to import a module named :mod:`usercustomize`, +which can perform arbitrary user-specific customizations, if +:data:`ENABLE_USER_SITE` is true. This file is intended to be created in the +user site-packages directory (see below), which is part of ``sys.path`` unless +disabled by :option:`-s`. If this import fails with an :exc:`ImportError` or +its subclass exception, and the exception's :attr:`name` attribute equals to +``'usercustomize'``, it is silently ignored. + +Note that for some non-Unix systems, ``sys.prefix`` and ``sys.exec_prefix`` are +empty, and the path manipulations are skipped; however the import of +:mod:`sitecustomize` and :mod:`usercustomize` is still attempted. + + +.. _rlcompleter-config: + +Readline configuration +---------------------- + +On systems that support :mod:`readline`, this module will also import and +configure the :mod:`rlcompleter` module, if Python is started in +:ref:`interactive mode ` and without the :option:`-S` option. +The default behavior is enable tab-completion and to use +:file:`~/.python_history` as the history save file. To disable it, delete (or +override) the :data:`sys.__interactivehook__` attribute in your +:mod:`sitecustomize` or :mod:`usercustomize` module or your +:envvar:`PYTHONSTARTUP` file. + +.. versionchanged:: 3.4 + Activation of rlcompleter and history was made automatic. + + +Module contents +--------------- + +.. data:: PREFIXES + + A list of prefixes for site-packages directories. + + +.. data:: ENABLE_USER_SITE + + Flag showing the status of the user site-packages directory. ``True`` means + that it is enabled and was added to ``sys.path``. ``False`` means that it + was disabled by user request (with :option:`-s` or + :envvar:`PYTHONNOUSERSITE`). ``None`` means it was disabled for security + reasons (mismatch between user or group id and effective id) or by an + administrator. + + +.. data:: USER_SITE + + Path to the user site-packages for the running Python. Can be ``None`` if + :func:`getusersitepackages` hasn't been called yet. Default value is + :file:`~/.local/lib/python{X.Y}/site-packages` for UNIX and non-framework Mac + OS X builds, :file:`~/Library/Python/{X.Y}/lib/python/site-packages` for Mac + framework builds, and :file:`{%APPDATA%}\\Python\\Python{XY}\\site-packages` + on Windows. This directory is a site directory, which means that + :file:`.pth` files in it will be processed. + + +.. data:: USER_BASE + + Path to the base directory for the user site-packages. Can be ``None`` if + :func:`getuserbase` hasn't been called yet. Default value is + :file:`~/.local` for UNIX and Mac OS X non-framework builds, + :file:`~/Library/Python/{X.Y}` for Mac framework builds, and + :file:`{%APPDATA%}\\Python` for Windows. This value is used by Distutils to + compute the installation directories for scripts, data files, Python modules, + etc. for the :ref:`user installation scheme `. + See also :envvar:`PYTHONUSERBASE`. + + +.. function:: main() + + Adds all the standard site-specific directories to the module search + path. This function is called automatically when this module is imported, + unless the Python interpreter was started with the :option:`-S` flag. + + .. versionchanged:: 3.3 + This function used to be called unconditionally. + + +.. function:: addsitedir(sitedir, known_paths=None) + + Add a directory to sys.path and process its :file:`.pth` files. Typically + used in :mod:`sitecustomize` or :mod:`usercustomize` (see above). + + +.. function:: getsitepackages() + + Return a list containing all global site-packages directories. + + .. versionadded:: 3.2 + + +.. function:: getuserbase() + + Return the path of the user base directory, :data:`USER_BASE`. If it is not + initialized yet, this function will also set it, respecting + :envvar:`PYTHONUSERBASE`. + + .. versionadded:: 3.2 + + +.. function:: getusersitepackages() + + Return the path of the user-specific site-packages directory, + :data:`USER_SITE`. If it is not initialized yet, this function will also set + it, respecting :envvar:`PYTHONNOUSERSITE` and :data:`USER_BASE`. + + .. versionadded:: 3.2 + + +The :mod:`site` module also provides a way to get the user directories from the +command line: + +.. code-block:: shell-session + + $ python3 -m site --user-site + /home/user/.local/lib/python3.3/site-packages + +.. program:: site + +If it is called without arguments, it will print the contents of +:data:`sys.path` on the standard output, followed by the value of +:data:`USER_BASE` and whether the directory exists, then the same thing for +:data:`USER_SITE`, and finally the value of :data:`ENABLE_USER_SITE`. + +.. cmdoption:: --user-base + + Print the path to the user base directory. + +.. cmdoption:: --user-site + + Print the path to the user site-packages directory. + +If both options are given, user base and user site will be printed (always in +this order), separated by :data:`os.pathsep`. + +If any option is given, the script will exit with one of these values: ``0`` if +the user site-packages directory is enabled, ``1`` if it was disabled by the +user, ``2`` if it is disabled for security reasons or by an administrator, and a +value greater than 2 if there is an error. + +.. seealso:: + + :pep:`370` -- Per user site-packages directory diff --git a/python-3.7.4-docs-html/_sources/library/smtpd.rst.txt b/python-3.7.4-docs-html/_sources/library/smtpd.rst.txt new file mode 100644 index 0000000..85ee8a7 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/smtpd.rst.txt @@ -0,0 +1,277 @@ +:mod:`smtpd` --- SMTP Server +============================ + +.. module:: smtpd + :synopsis: A SMTP server implementation in Python. + +.. moduleauthor:: Barry Warsaw +.. sectionauthor:: Moshe Zadka + +**Source code:** :source:`Lib/smtpd.py` + +-------------- + +This module offers several classes to implement SMTP (email) servers. + +.. seealso:: + + The `aiosmtpd `_ package is a recommended + replacement for this module. It is based on :mod:`asyncio` and provides a + more straightforward API. :mod:`smtpd` should be considered deprecated. + +Several server implementations are present; one is a generic +do-nothing implementation, which can be overridden, while the other two offer +specific mail-sending strategies. + +Additionally the SMTPChannel may be extended to implement very specific +interaction behaviour with SMTP clients. + +The code supports :RFC:`5321`, plus the :rfc:`1870` SIZE and :rfc:`6531` +SMTPUTF8 extensions. + + +SMTPServer Objects +------------------ + + +.. class:: SMTPServer(localaddr, remoteaddr, data_size_limit=33554432,\ + map=None, enable_SMTPUTF8=False, decode_data=False) + + Create a new :class:`SMTPServer` object, which binds to local address + *localaddr*. It will treat *remoteaddr* as an upstream SMTP relayer. Both + *localaddr* and *remoteaddr* should be a :ref:`(host, port) ` + tuple. The object inherits from :class:`asyncore.dispatcher`, and so will + insert itself into :mod:`asyncore`'s event loop on instantiation. + + *data_size_limit* specifies the maximum number of bytes that will be + accepted in a ``DATA`` command. A value of ``None`` or ``0`` means no + limit. + + *map* is the socket map to use for connections (an initially empty + dictionary is a suitable value). If not specified the :mod:`asyncore` + global socket map is used. + + *enable_SMTPUTF8* determines whether the ``SMTPUTF8`` extension (as defined + in :RFC:`6531`) should be enabled. The default is ``False``. + When ``True``, ``SMTPUTF8`` is accepted as a parameter to the ``MAIL`` + command and when present is passed to :meth:`process_message` in the + ``kwargs['mail_options']`` list. *decode_data* and *enable_SMTPUTF8* + cannot be set to ``True`` at the same time. + + *decode_data* specifies whether the data portion of the SMTP transaction + should be decoded using UTF-8. When *decode_data* is ``False`` (the + default), the server advertises the ``8BITMIME`` + extension (:rfc:`6152`), accepts the ``BODY=8BITMIME`` parameter to + the ``MAIL`` command, and when present passes it to :meth:`process_message` + in the ``kwargs['mail_options']`` list. *decode_data* and *enable_SMTPUTF8* + cannot be set to ``True`` at the same time. + + .. method:: process_message(peer, mailfrom, rcpttos, data, **kwargs) + + Raise a :exc:`NotImplementedError` exception. Override this in subclasses to + do something useful with this message. Whatever was passed in the + constructor as *remoteaddr* will be available as the :attr:`_remoteaddr` + attribute. *peer* is the remote host's address, *mailfrom* is the envelope + originator, *rcpttos* are the envelope recipients and *data* is a string + containing the contents of the e-mail (which should be in :rfc:`5321` + format). + + If the *decode_data* constructor keyword is set to ``True``, the *data* + argument will be a unicode string. If it is set to ``False``, it + will be a bytes object. + + *kwargs* is a dictionary containing additional information. It is empty + if ``decode_data=True`` was given as an init argument, otherwise + it contains the following keys: + + *mail_options*: + a list of all received parameters to the ``MAIL`` + command (the elements are uppercase strings; example: + ``['BODY=8BITMIME', 'SMTPUTF8']``). + + *rcpt_options*: + same as *mail_options* but for the ``RCPT`` command. + Currently no ``RCPT TO`` options are supported, so for now + this will always be an empty list. + + Implementations of ``process_message`` should use the ``**kwargs`` + signature to accept arbitrary keyword arguments, since future feature + enhancements may add keys to the kwargs dictionary. + + Return ``None`` to request a normal ``250 Ok`` response; otherwise + return the desired response string in :RFC:`5321` format. + + .. attribute:: channel_class + + Override this in subclasses to use a custom :class:`SMTPChannel` for + managing SMTP clients. + + .. versionadded:: 3.4 + The *map* constructor argument. + + .. versionchanged:: 3.5 + *localaddr* and *remoteaddr* may now contain IPv6 addresses. + + .. versionadded:: 3.5 + The *decode_data* and *enable_SMTPUTF8* constructor parameters, and the + *kwargs* parameter to :meth:`process_message` when *decode_data* is + ``False``. + + .. versionchanged:: 3.6 + *decode_data* is now ``False`` by default. + + +DebuggingServer Objects +----------------------- + + +.. class:: DebuggingServer(localaddr, remoteaddr) + + Create a new debugging server. Arguments are as per :class:`SMTPServer`. + Messages will be discarded, and printed on stdout. + + +PureProxy Objects +----------------- + + +.. class:: PureProxy(localaddr, remoteaddr) + + Create a new pure proxy server. Arguments are as per :class:`SMTPServer`. + Everything will be relayed to *remoteaddr*. Note that running this has a good + chance to make you into an open relay, so please be careful. + + +MailmanProxy Objects +-------------------- + + +.. class:: MailmanProxy(localaddr, remoteaddr) + + Create a new pure proxy server. Arguments are as per :class:`SMTPServer`. + Everything will be relayed to *remoteaddr*, unless local mailman configurations + knows about an address, in which case it will be handled via mailman. Note that + running this has a good chance to make you into an open relay, so please be + careful. + +SMTPChannel Objects +------------------- + +.. class:: SMTPChannel(server, conn, addr, data_size_limit=33554432,\ + map=None, enable_SMTPUTF8=False, decode_data=False) + + Create a new :class:`SMTPChannel` object which manages the communication + between the server and a single SMTP client. + + *conn* and *addr* are as per the instance variables described below. + + *data_size_limit* specifies the maximum number of bytes that will be + accepted in a ``DATA`` command. A value of ``None`` or ``0`` means no + limit. + + *enable_SMTPUTF8* determines whether the ``SMTPUTF8`` extension (as defined + in :RFC:`6531`) should be enabled. The default is ``False``. + *decode_data* and *enable_SMTPUTF8* cannot be set to ``True`` at the same + time. + + A dictionary can be specified in *map* to avoid using a global socket map. + + *decode_data* specifies whether the data portion of the SMTP transaction + should be decoded using UTF-8. The default is ``False``. + *decode_data* and *enable_SMTPUTF8* cannot be set to ``True`` at the same + time. + + To use a custom SMTPChannel implementation you need to override the + :attr:`SMTPServer.channel_class` of your :class:`SMTPServer`. + + .. versionchanged:: 3.5 + The *decode_data* and *enable_SMTPUTF8* parameters were added. + + .. versionchanged:: 3.6 + *decode_data* is now ``False`` by default. + + The :class:`SMTPChannel` has the following instance variables: + + .. attribute:: smtp_server + + Holds the :class:`SMTPServer` that spawned this channel. + + .. attribute:: conn + + Holds the socket object connecting to the client. + + .. attribute:: addr + + Holds the address of the client, the second value returned by + :func:`socket.accept ` + + .. attribute:: received_lines + + Holds a list of the line strings (decoded using UTF-8) received from + the client. The lines have their ``"\r\n"`` line ending translated to + ``"\n"``. + + .. attribute:: smtp_state + + Holds the current state of the channel. This will be either + :attr:`COMMAND` initially and then :attr:`DATA` after the client sends + a "DATA" line. + + .. attribute:: seen_greeting + + Holds a string containing the greeting sent by the client in its "HELO". + + .. attribute:: mailfrom + + Holds a string containing the address identified in the "MAIL FROM:" line + from the client. + + .. attribute:: rcpttos + + Holds a list of strings containing the addresses identified in the + "RCPT TO:" lines from the client. + + .. attribute:: received_data + + Holds a string containing all of the data sent by the client during the + DATA state, up to but not including the terminating ``"\r\n.\r\n"``. + + .. attribute:: fqdn + + Holds the fully-qualified domain name of the server as returned by + :func:`socket.getfqdn`. + + .. attribute:: peer + + Holds the name of the client peer as returned by ``conn.getpeername()`` + where ``conn`` is :attr:`conn`. + + The :class:`SMTPChannel` operates by invoking methods named ``smtp_`` + upon reception of a command line from the client. Built into the base + :class:`SMTPChannel` class are methods for handling the following commands + (and responding to them appropriately): + + ======== =================================================================== + Command Action taken + ======== =================================================================== + HELO Accepts the greeting from the client and stores it in + :attr:`seen_greeting`. Sets server to base command mode. + EHLO Accepts the greeting from the client and stores it in + :attr:`seen_greeting`. Sets server to extended command mode. + NOOP Takes no action. + QUIT Closes the connection cleanly. + MAIL Accepts the "MAIL FROM:" syntax and stores the supplied address as + :attr:`mailfrom`. In extended command mode, accepts the + :rfc:`1870` SIZE attribute and responds appropriately based on the + value of *data_size_limit*. + RCPT Accepts the "RCPT TO:" syntax and stores the supplied addresses in + the :attr:`rcpttos` list. + RSET Resets the :attr:`mailfrom`, :attr:`rcpttos`, and + :attr:`received_data`, but not the greeting. + DATA Sets the internal state to :attr:`DATA` and stores remaining lines + from the client in :attr:`received_data` until the terminator + ``"\r\n.\r\n"`` is received. + HELP Returns minimal information on command syntax + VRFY Returns code 252 (the server doesn't know if the address is valid) + EXPN Reports that the command is not implemented. + ======== =================================================================== diff --git a/python-3.7.4-docs-html/_sources/library/smtplib.rst.txt b/python-3.7.4-docs-html/_sources/library/smtplib.rst.txt new file mode 100644 index 0000000..2c3a5f0 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/smtplib.rst.txt @@ -0,0 +1,586 @@ +:mod:`smtplib` --- SMTP protocol client +======================================= + +.. module:: smtplib + :synopsis: SMTP protocol client (requires sockets). + +.. sectionauthor:: Eric S. Raymond + +**Source code:** :source:`Lib/smtplib.py` + +.. index:: + pair: SMTP; protocol + single: Simple Mail Transfer Protocol + +-------------- + +The :mod:`smtplib` module defines an SMTP client session object that can be used +to send mail to any Internet machine with an SMTP or ESMTP listener daemon. For +details of SMTP and ESMTP operation, consult :rfc:`821` (Simple Mail Transfer +Protocol) and :rfc:`1869` (SMTP Service Extensions). + + +.. class:: SMTP(host='', port=0, local_hostname=None[, timeout], source_address=None) + + An :class:`SMTP` instance encapsulates an SMTP connection. It has methods + that support a full repertoire of SMTP and ESMTP operations. If the optional + host and port parameters are given, the SMTP :meth:`connect` method is + called with those parameters during initialization. If specified, + *local_hostname* is used as the FQDN of the local host in the HELO/EHLO + command. Otherwise, the local hostname is found using + :func:`socket.getfqdn`. If the :meth:`connect` call returns anything other + than a success code, an :exc:`SMTPConnectError` is raised. The optional + *timeout* parameter specifies a timeout in seconds for blocking operations + like the connection attempt (if not specified, the global default timeout + setting will be used). If the timeout expires, :exc:`socket.timeout` is + raised. The optional source_address parameter allows binding + to some specific source address in a machine with multiple network + interfaces, and/or to some specific source TCP port. It takes a 2-tuple + (host, port), for the socket to bind to as its source address before + connecting. If omitted (or if host or port are ``''`` and/or 0 respectively) + the OS default behavior will be used. + + For normal use, you should only require the initialization/connect, + :meth:`sendmail`, and :meth:`SMTP.quit` methods. + An example is included below. + + The :class:`SMTP` class supports the :keyword:`with` statement. When used + like this, the SMTP ``QUIT`` command is issued automatically when the + :keyword:`!with` statement exits. E.g.:: + + >>> from smtplib import SMTP + >>> with SMTP("domain.org") as smtp: + ... smtp.noop() + ... + (250, b'Ok') + >>> + + .. versionchanged:: 3.3 + Support for the :keyword:`with` statement was added. + + .. versionchanged:: 3.3 + source_address argument was added. + + .. versionadded:: 3.5 + The SMTPUTF8 extension (:rfc:`6531`) is now supported. + + +.. class:: SMTP_SSL(host='', port=0, local_hostname=None, keyfile=None, \ + certfile=None [, timeout], context=None, \ + source_address=None) + + An :class:`SMTP_SSL` instance behaves exactly the same as instances of + :class:`SMTP`. :class:`SMTP_SSL` should be used for situations where SSL is + required from the beginning of the connection and using :meth:`starttls` is + not appropriate. If *host* is not specified, the local host is used. If + *port* is zero, the standard SMTP-over-SSL port (465) is used. The optional + arguments *local_hostname*, *timeout* and *source_address* have the same + meaning as they do in the :class:`SMTP` class. *context*, also optional, + can contain a :class:`~ssl.SSLContext` and allows configuring various + aspects of the secure connection. Please read :ref:`ssl-security` for + best practices. + + *keyfile* and *certfile* are a legacy alternative to *context*, and can + point to a PEM formatted private key and certificate chain file for the + SSL connection. + + .. versionchanged:: 3.3 + *context* was added. + + .. versionchanged:: 3.3 + source_address argument was added. + + .. versionchanged:: 3.4 + The class now supports hostname check with + :attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see + :data:`ssl.HAS_SNI`). + + .. deprecated:: 3.6 + + *keyfile* and *certfile* are deprecated in favor of *context*. + Please use :meth:`ssl.SSLContext.load_cert_chain` instead, or let + :func:`ssl.create_default_context` select the system's trusted CA + certificates for you. + + +.. class:: LMTP(host='', port=LMTP_PORT, local_hostname=None, source_address=None) + + The LMTP protocol, which is very similar to ESMTP, is heavily based on the + standard SMTP client. It's common to use Unix sockets for LMTP, so our + :meth:`connect` method must support that as well as a regular host:port + server. The optional arguments local_hostname and source_address have the + same meaning as they do in the :class:`SMTP` class. To specify a Unix + socket, you must use an absolute path for *host*, starting with a '/'. + + Authentication is supported, using the regular SMTP mechanism. When using a + Unix socket, LMTP generally don't support or require any authentication, but + your mileage might vary. + + +A nice selection of exceptions is defined as well: + + +.. exception:: SMTPException + + Subclass of :exc:`OSError` that is the base exception class for all + the other exceptions provided by this module. + + .. versionchanged:: 3.4 + SMTPException became subclass of :exc:`OSError` + + +.. exception:: SMTPServerDisconnected + + This exception is raised when the server unexpectedly disconnects, or when an + attempt is made to use the :class:`SMTP` instance before connecting it to a + server. + + +.. exception:: SMTPResponseException + + Base class for all exceptions that include an SMTP error code. These exceptions + are generated in some instances when the SMTP server returns an error code. The + error code is stored in the :attr:`smtp_code` attribute of the error, and the + :attr:`smtp_error` attribute is set to the error message. + + +.. exception:: SMTPSenderRefused + + Sender address refused. In addition to the attributes set by on all + :exc:`SMTPResponseException` exceptions, this sets 'sender' to the string that + the SMTP server refused. + + +.. exception:: SMTPRecipientsRefused + + All recipient addresses refused. The errors for each recipient are accessible + through the attribute :attr:`recipients`, which is a dictionary of exactly the + same sort as :meth:`SMTP.sendmail` returns. + + +.. exception:: SMTPDataError + + The SMTP server refused to accept the message data. + + +.. exception:: SMTPConnectError + + Error occurred during establishment of a connection with the server. + + +.. exception:: SMTPHeloError + + The server refused our ``HELO`` message. + + +.. exception:: SMTPNotSupportedError + + The command or option attempted is not supported by the server. + + .. versionadded:: 3.5 + + +.. exception:: SMTPAuthenticationError + + SMTP authentication went wrong. Most probably the server didn't accept the + username/password combination provided. + + +.. seealso:: + + :rfc:`821` - Simple Mail Transfer Protocol + Protocol definition for SMTP. This document covers the model, operating + procedure, and protocol details for SMTP. + + :rfc:`1869` - SMTP Service Extensions + Definition of the ESMTP extensions for SMTP. This describes a framework for + extending SMTP with new commands, supporting dynamic discovery of the commands + provided by the server, and defines a few additional commands. + + +.. _smtp-objects: + +SMTP Objects +------------ + +An :class:`SMTP` instance has the following methods: + + +.. method:: SMTP.set_debuglevel(level) + + Set the debug output level. A value of 1 or ``True`` for *level* results in + debug messages for connection and for all messages sent to and received from + the server. A value of 2 for *level* results in these messages being + timestamped. + + .. versionchanged:: 3.5 Added debuglevel 2. + + +.. method:: SMTP.docmd(cmd, args='') + + Send a command *cmd* to the server. The optional argument *args* is simply + concatenated to the command, separated by a space. + + This returns a 2-tuple composed of a numeric response code and the actual + response line (multiline responses are joined into one long line.) + + In normal operation it should not be necessary to call this method explicitly. + It is used to implement other methods and may be useful for testing private + extensions. + + If the connection to the server is lost while waiting for the reply, + :exc:`SMTPServerDisconnected` will be raised. + + +.. method:: SMTP.connect(host='localhost', port=0) + + Connect to a host on a given port. The defaults are to connect to the local + host at the standard SMTP port (25). If the hostname ends with a colon (``':'``) + followed by a number, that suffix will be stripped off and the number + interpreted as the port number to use. This method is automatically invoked by + the constructor if a host is specified during instantiation. Returns a + 2-tuple of the response code and message sent by the server in its + connection response. + + +.. method:: SMTP.helo(name='') + + Identify yourself to the SMTP server using ``HELO``. The hostname argument + defaults to the fully qualified domain name of the local host. + The message returned by the server is stored as the :attr:`helo_resp` attribute + of the object. + + In normal operation it should not be necessary to call this method explicitly. + It will be implicitly called by the :meth:`sendmail` when necessary. + + +.. method:: SMTP.ehlo(name='') + + Identify yourself to an ESMTP server using ``EHLO``. The hostname argument + defaults to the fully qualified domain name of the local host. Examine the + response for ESMTP option and store them for use by :meth:`has_extn`. + Also sets several informational attributes: the message returned by + the server is stored as the :attr:`ehlo_resp` attribute, :attr:`does_esmtp` + is set to true or false depending on whether the server supports ESMTP, and + :attr:`esmtp_features` will be a dictionary containing the names of the + SMTP service extensions this server supports, and their parameters (if any). + + Unless you wish to use :meth:`has_extn` before sending mail, it should not be + necessary to call this method explicitly. It will be implicitly called by + :meth:`sendmail` when necessary. + +.. method:: SMTP.ehlo_or_helo_if_needed() + + This method calls :meth:`ehlo` and/or :meth:`helo` if there has been no + previous ``EHLO`` or ``HELO`` command this session. It tries ESMTP ``EHLO`` + first. + + :exc:`SMTPHeloError` + The server didn't reply properly to the ``HELO`` greeting. + +.. method:: SMTP.has_extn(name) + + Return :const:`True` if *name* is in the set of SMTP service extensions returned + by the server, :const:`False` otherwise. Case is ignored. + + +.. method:: SMTP.verify(address) + + Check the validity of an address on this server using SMTP ``VRFY``. Returns a + tuple consisting of code 250 and a full :rfc:`822` address (including human + name) if the user address is valid. Otherwise returns an SMTP error code of 400 + or greater and an error string. + + .. note:: + + Many sites disable SMTP ``VRFY`` in order to foil spammers. + + +.. method:: SMTP.login(user, password, *, initial_response_ok=True) + + Log in on an SMTP server that requires authentication. The arguments are the + username and the password to authenticate with. If there has been no previous + ``EHLO`` or ``HELO`` command this session, this method tries ESMTP ``EHLO`` + first. This method will return normally if the authentication was successful, or + may raise the following exceptions: + + :exc:`SMTPHeloError` + The server didn't reply properly to the ``HELO`` greeting. + + :exc:`SMTPAuthenticationError` + The server didn't accept the username/password combination. + + :exc:`SMTPNotSupportedError` + The ``AUTH`` command is not supported by the server. + + :exc:`SMTPException` + No suitable authentication method was found. + + Each of the authentication methods supported by :mod:`smtplib` are tried in + turn if they are advertised as supported by the server. See :meth:`auth` + for a list of supported authentication methods. *initial_response_ok* is + passed through to :meth:`auth`. + + Optional keyword argument *initial_response_ok* specifies whether, for + authentication methods that support it, an "initial response" as specified + in :rfc:`4954` can be sent along with the ``AUTH`` command, rather than + requiring a challenge/response. + + .. versionchanged:: 3.5 + :exc:`SMTPNotSupportedError` may be raised, and the + *initial_response_ok* parameter was added. + + +.. method:: SMTP.auth(mechanism, authobject, *, initial_response_ok=True) + + Issue an ``SMTP`` ``AUTH`` command for the specified authentication + *mechanism*, and handle the challenge response via *authobject*. + + *mechanism* specifies which authentication mechanism is to + be used as argument to the ``AUTH`` command; the valid values are + those listed in the ``auth`` element of :attr:`esmtp_features`. + + *authobject* must be a callable object taking an optional single argument: + + data = authobject(challenge=None) + + If optional keyword argument *initial_response_ok* is true, + ``authobject()`` will be called first with no argument. It can return the + :rfc:`4954` "initial response" ASCII ``str`` which will be encoded and sent with + the ``AUTH`` command as below. If the ``authobject()`` does not support an + initial response (e.g. because it requires a challenge), it should return + ``None`` when called with ``challenge=None``. If *initial_response_ok* is + false, then ``authobject()`` will not be called first with ``None``. + + If the initial response check returns ``None``, or if *initial_response_ok* is + false, ``authobject()`` will be called to process the server's challenge + response; the *challenge* argument it is passed will be a ``bytes``. It + should return ASCII ``str`` *data* that will be base64 encoded and sent to the + server. + + The ``SMTP`` class provides ``authobjects`` for the ``CRAM-MD5``, ``PLAIN``, + and ``LOGIN`` mechanisms; they are named ``SMTP.auth_cram_md5``, + ``SMTP.auth_plain``, and ``SMTP.auth_login`` respectively. They all require + that the ``user`` and ``password`` properties of the ``SMTP`` instance are + set to appropriate values. + + User code does not normally need to call ``auth`` directly, but can instead + call the :meth:`login` method, which will try each of the above mechanisms + in turn, in the order listed. ``auth`` is exposed to facilitate the + implementation of authentication methods not (or not yet) supported + directly by :mod:`smtplib`. + + .. versionadded:: 3.5 + + +.. method:: SMTP.starttls(keyfile=None, certfile=None, context=None) + + Put the SMTP connection in TLS (Transport Layer Security) mode. All SMTP + commands that follow will be encrypted. You should then call :meth:`ehlo` + again. + + If *keyfile* and *certfile* are provided, they are used to create an + :class:`ssl.SSLContext`. + + Optional *context* parameter is an :class:`ssl.SSLContext` object; This is + an alternative to using a keyfile and a certfile and if specified both + *keyfile* and *certfile* should be ``None``. + + If there has been no previous ``EHLO`` or ``HELO`` command this session, + this method tries ESMTP ``EHLO`` first. + + .. deprecated:: 3.6 + + *keyfile* and *certfile* are deprecated in favor of *context*. + Please use :meth:`ssl.SSLContext.load_cert_chain` instead, or let + :func:`ssl.create_default_context` select the system's trusted CA + certificates for you. + + :exc:`SMTPHeloError` + The server didn't reply properly to the ``HELO`` greeting. + + :exc:`SMTPNotSupportedError` + The server does not support the STARTTLS extension. + + :exc:`RuntimeError` + SSL/TLS support is not available to your Python interpreter. + + .. versionchanged:: 3.3 + *context* was added. + + .. versionchanged:: 3.4 + The method now supports hostname check with + :attr:`SSLContext.check_hostname` and *Server Name Indicator* (see + :data:`~ssl.HAS_SNI`). + + .. versionchanged:: 3.5 + The error raised for lack of STARTTLS support is now the + :exc:`SMTPNotSupportedError` subclass instead of the base + :exc:`SMTPException`. + + +.. method:: SMTP.sendmail(from_addr, to_addrs, msg, mail_options=(), rcpt_options=()) + + Send mail. The required arguments are an :rfc:`822` from-address string, a list + of :rfc:`822` to-address strings (a bare string will be treated as a list with 1 + address), and a message string. The caller may pass a list of ESMTP options + (such as ``8bitmime``) to be used in ``MAIL FROM`` commands as *mail_options*. + ESMTP options (such as ``DSN`` commands) that should be used with all ``RCPT`` + commands can be passed as *rcpt_options*. (If you need to use different ESMTP + options to different recipients you have to use the low-level methods such as + :meth:`mail`, :meth:`rcpt` and :meth:`data` to send the message.) + + .. note:: + + The *from_addr* and *to_addrs* parameters are used to construct the message + envelope used by the transport agents. ``sendmail`` does not modify the + message headers in any way. + + *msg* may be a string containing characters in the ASCII range, or a byte + string. A string is encoded to bytes using the ascii codec, and lone ``\r`` + and ``\n`` characters are converted to ``\r\n`` characters. A byte string is + not modified. + + If there has been no previous ``EHLO`` or ``HELO`` command this session, this + method tries ESMTP ``EHLO`` first. If the server does ESMTP, message size and + each of the specified options will be passed to it (if the option is in the + feature set the server advertises). If ``EHLO`` fails, ``HELO`` will be tried + and ESMTP options suppressed. + + This method will return normally if the mail is accepted for at least one + recipient. Otherwise it will raise an exception. That is, if this method does + not raise an exception, then someone should get your mail. If this method does + not raise an exception, it returns a dictionary, with one entry for each + recipient that was refused. Each entry contains a tuple of the SMTP error code + and the accompanying error message sent by the server. + + If ``SMTPUTF8`` is included in *mail_options*, and the server supports it, + *from_addr* and *to_addrs* may contain non-ASCII characters. + + This method may raise the following exceptions: + + :exc:`SMTPRecipientsRefused` + All recipients were refused. Nobody got the mail. The :attr:`recipients` + attribute of the exception object is a dictionary with information about the + refused recipients (like the one returned when at least one recipient was + accepted). + + :exc:`SMTPHeloError` + The server didn't reply properly to the ``HELO`` greeting. + + :exc:`SMTPSenderRefused` + The server didn't accept the *from_addr*. + + :exc:`SMTPDataError` + The server replied with an unexpected error code (other than a refusal of a + recipient). + + :exc:`SMTPNotSupportedError` + ``SMTPUTF8`` was given in the *mail_options* but is not supported by the + server. + + Unless otherwise noted, the connection will be open even after an exception is + raised. + + .. versionchanged:: 3.2 + *msg* may be a byte string. + + .. versionchanged:: 3.5 + ``SMTPUTF8`` support added, and :exc:`SMTPNotSupportedError` may be + raised if ``SMTPUTF8`` is specified but the server does not support it. + + +.. method:: SMTP.send_message(msg, from_addr=None, to_addrs=None, \ + mail_options=(), rcpt_options=()) + + This is a convenience method for calling :meth:`sendmail` with the message + represented by an :class:`email.message.Message` object. The arguments have + the same meaning as for :meth:`sendmail`, except that *msg* is a ``Message`` + object. + + If *from_addr* is ``None`` or *to_addrs* is ``None``, ``send_message`` fills + those arguments with addresses extracted from the headers of *msg* as + specified in :rfc:`5322`\: *from_addr* is set to the :mailheader:`Sender` + field if it is present, and otherwise to the :mailheader:`From` field. + *to_addrs* combines the values (if any) of the :mailheader:`To`, + :mailheader:`Cc`, and :mailheader:`Bcc` fields from *msg*. If exactly one + set of :mailheader:`Resent-*` headers appear in the message, the regular + headers are ignored and the :mailheader:`Resent-*` headers are used instead. + If the message contains more than one set of :mailheader:`Resent-*` headers, + a :exc:`ValueError` is raised, since there is no way to unambiguously detect + the most recent set of :mailheader:`Resent-` headers. + + ``send_message`` serializes *msg* using + :class:`~email.generator.BytesGenerator` with ``\r\n`` as the *linesep*, and + calls :meth:`sendmail` to transmit the resulting message. Regardless of the + values of *from_addr* and *to_addrs*, ``send_message`` does not transmit any + :mailheader:`Bcc` or :mailheader:`Resent-Bcc` headers that may appear + in *msg*. If any of the addresses in *from_addr* and *to_addrs* contain + non-ASCII characters and the server does not advertise ``SMTPUTF8`` support, + an :exc:`SMTPNotSupported` error is raised. Otherwise the ``Message`` is + serialized with a clone of its :mod:`~email.policy` with the + :attr:`~email.policy.EmailPolicy.utf8` attribute set to ``True``, and + ``SMTPUTF8`` and ``BODY=8BITMIME`` are added to *mail_options*. + + .. versionadded:: 3.2 + + .. versionadded:: 3.5 + Support for internationalized addresses (``SMTPUTF8``). + + +.. method:: SMTP.quit() + + Terminate the SMTP session and close the connection. Return the result of + the SMTP ``QUIT`` command. + + +Low-level methods corresponding to the standard SMTP/ESMTP commands ``HELP``, +``RSET``, ``NOOP``, ``MAIL``, ``RCPT``, and ``DATA`` are also supported. +Normally these do not need to be called directly, so they are not documented +here. For details, consult the module code. + + +.. _smtp-example: + +SMTP Example +------------ + +This example prompts the user for addresses needed in the message envelope ('To' +and 'From' addresses), and the message to be delivered. Note that the headers +to be included with the message must be included in the message as entered; this +example doesn't do any processing of the :rfc:`822` headers. In particular, the +'To' and 'From' addresses must be included in the message headers explicitly. :: + + import smtplib + + def prompt(prompt): + return input(prompt).strip() + + fromaddr = prompt("From: ") + toaddrs = prompt("To: ").split() + print("Enter message, end with ^D (Unix) or ^Z (Windows):") + + # Add the From: and To: headers at the start! + msg = ("From: %s\r\nTo: %s\r\n\r\n" + % (fromaddr, ", ".join(toaddrs))) + while True: + try: + line = input() + except EOFError: + break + if not line: + break + msg = msg + line + + print("Message length is", len(msg)) + + server = smtplib.SMTP('localhost') + server.set_debuglevel(1) + server.sendmail(fromaddr, toaddrs, msg) + server.quit() + +.. note:: + + In general, you will want to use the :mod:`email` package's features to + construct an email message, which you can then send + via :meth:`~smtplib.SMTP.send_message`; see :ref:`email-examples`. diff --git a/python-3.7.4-docs-html/_sources/library/sndhdr.rst.txt b/python-3.7.4-docs-html/_sources/library/sndhdr.rst.txt new file mode 100644 index 0000000..6bfa9a9 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/sndhdr.rst.txt @@ -0,0 +1,51 @@ +:mod:`sndhdr` --- Determine type of sound file +============================================== + +.. module:: sndhdr + :synopsis: Determine type of a sound file. + +.. sectionauthor:: Fred L. Drake, Jr. +.. Based on comments in the module source file. + +**Source code:** :source:`Lib/sndhdr.py` + +.. index:: + single: A-LAW + single: u-LAW + +-------------- + +The :mod:`sndhdr` provides utility functions which attempt to determine the type +of sound data which is in a file. When these functions are able to determine +what type of sound data is stored in a file, they return a +:func:`~collections.namedtuple`, containing five attributes: (``filetype``, +``framerate``, ``nchannels``, ``nframes``, ``sampwidth``). The value for *type* +indicates the data type and will be one of the strings ``'aifc'``, ``'aiff'``, +``'au'``, ``'hcom'``, ``'sndr'``, ``'sndt'``, ``'voc'``, ``'wav'``, ``'8svx'``, +``'sb'``, ``'ub'``, or ``'ul'``. The *sampling_rate* will be either the actual +value or ``0`` if unknown or difficult to decode. Similarly, *channels* will be +either the number of channels or ``0`` if it cannot be determined or if the +value is difficult to decode. The value for *frames* will be either the number +of frames or ``-1``. The last item in the tuple, *bits_per_sample*, will either +be the sample size in bits or ``'A'`` for A-LAW or ``'U'`` for u-LAW. + + +.. function:: what(filename) + + Determines the type of sound data stored in the file *filename* using + :func:`whathdr`. If it succeeds, returns a namedtuple as described above, otherwise + ``None`` is returned. + + .. versionchanged:: 3.5 + Result changed from a tuple to a namedtuple. + + +.. function:: whathdr(filename) + + Determines the type of sound data stored in a file based on the file header. + The name of the file is given by *filename*. This function returns a namedtuple as + described above on success, or ``None``. + + .. versionchanged:: 3.5 + Result changed from a tuple to a namedtuple. + diff --git a/python-3.7.4-docs-html/_sources/library/socket.rst.txt b/python-3.7.4-docs-html/_sources/library/socket.rst.txt new file mode 100644 index 0000000..15c65b9 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/socket.rst.txt @@ -0,0 +1,1876 @@ +:mod:`socket` --- Low-level networking interface +================================================ + +.. module:: socket + :synopsis: Low-level networking interface. + +**Source code:** :source:`Lib/socket.py` + +-------------- + +This module provides access to the BSD *socket* interface. It is available on +all modern Unix systems, Windows, MacOS, and probably additional platforms. + +.. note:: + + Some behavior may be platform dependent, since calls are made to the operating + system socket APIs. + +.. index:: object: socket + +The Python interface is a straightforward transliteration of the Unix system +call and library interface for sockets to Python's object-oriented style: the +:func:`.socket` function returns a :dfn:`socket object` whose methods implement +the various socket system calls. Parameter types are somewhat higher-level than +in the C interface: as with :meth:`read` and :meth:`write` operations on Python +files, buffer allocation on receive operations is automatic, and buffer length +is implicit on send operations. + + +.. seealso:: + + Module :mod:`socketserver` + Classes that simplify writing network servers. + + Module :mod:`ssl` + A TLS/SSL wrapper for socket objects. + + +Socket families +--------------- + +Depending on the system and the build options, various socket families +are supported by this module. + +The address format required by a particular socket object is automatically +selected based on the address family specified when the socket object was +created. Socket addresses are represented as follows: + +- The address of an :const:`AF_UNIX` socket bound to a file system node + is represented as a string, using the file system encoding and the + ``'surrogateescape'`` error handler (see :pep:`383`). An address in + Linux's abstract namespace is returned as a :term:`bytes-like object` with + an initial null byte; note that sockets in this namespace can + communicate with normal file system sockets, so programs intended to + run on Linux may need to deal with both types of address. A string or + bytes-like object can be used for either type of address when + passing it as an argument. + + .. versionchanged:: 3.3 + Previously, :const:`AF_UNIX` socket paths were assumed to use UTF-8 + encoding. + + .. versionchanged:: 3.5 + Writable :term:`bytes-like object` is now accepted. + +.. _host_port: + +- A pair ``(host, port)`` is used for the :const:`AF_INET` address family, + where *host* is a string representing either a hostname in Internet domain + notation like ``'daring.cwi.nl'`` or an IPv4 address like ``'100.50.200.5'``, + and *port* is an integer. + + - For IPv4 addresses, two special forms are accepted instead of a host + address: ``''`` represents :const:`INADDR_ANY`, which is used to bind to all + interfaces, and the string ``''`` represents + :const:`INADDR_BROADCAST`. This behavior is not compatible with IPv6, + therefore, you may want to avoid these if you intend to support IPv6 with your + Python programs. + +- For :const:`AF_INET6` address family, a four-tuple ``(host, port, flowinfo, + scopeid)`` is used, where *flowinfo* and *scopeid* represent the ``sin6_flowinfo`` + and ``sin6_scope_id`` members in :const:`struct sockaddr_in6` in C. For + :mod:`socket` module methods, *flowinfo* and *scopeid* can be omitted just for + backward compatibility. Note, however, omission of *scopeid* can cause problems + in manipulating scoped IPv6 addresses. + + .. versionchanged:: 3.7 + For multicast addresses (with *scopeid* meaningful) *address* may not contain + ``%scope`` (or ``zone id``) part. This information is superfluous and may + be safely omitted (recommended). + +- :const:`AF_NETLINK` sockets are represented as pairs ``(pid, groups)``. + +- Linux-only support for TIPC is available using the :const:`AF_TIPC` + address family. TIPC is an open, non-IP based networked protocol designed + for use in clustered computer environments. Addresses are represented by a + tuple, and the fields depend on the address type. The general tuple form is + ``(addr_type, v1, v2, v3 [, scope])``, where: + + - *addr_type* is one of :const:`TIPC_ADDR_NAMESEQ`, :const:`TIPC_ADDR_NAME`, + or :const:`TIPC_ADDR_ID`. + - *scope* is one of :const:`TIPC_ZONE_SCOPE`, :const:`TIPC_CLUSTER_SCOPE`, and + :const:`TIPC_NODE_SCOPE`. + - If *addr_type* is :const:`TIPC_ADDR_NAME`, then *v1* is the server type, *v2* is + the port identifier, and *v3* should be 0. + + If *addr_type* is :const:`TIPC_ADDR_NAMESEQ`, then *v1* is the server type, *v2* + is the lower port number, and *v3* is the upper port number. + + If *addr_type* is :const:`TIPC_ADDR_ID`, then *v1* is the node, *v2* is the + reference, and *v3* should be set to 0. + +- A tuple ``(interface, )`` is used for the :const:`AF_CAN` address family, + where *interface* is a string representing a network interface name like + ``'can0'``. The network interface name ``''`` can be used to receive packets + from all network interfaces of this family. + + - :const:`CAN_ISOTP` protocol require a tuple ``(interface, rx_addr, tx_addr)`` + where both additional parameters are unsigned long integer that represent a + CAN identifier (standard or extended). + +- A string or a tuple ``(id, unit)`` is used for the :const:`SYSPROTO_CONTROL` + protocol of the :const:`PF_SYSTEM` family. The string is the name of a + kernel control using a dynamically-assigned ID. The tuple can be used if ID + and unit number of the kernel control are known or if a registered ID is + used. + + .. versionadded:: 3.3 + +- :const:`AF_BLUETOOTH` supports the following protocols and address + formats: + + - :const:`BTPROTO_L2CAP` accepts ``(bdaddr, psm)`` where ``bdaddr`` is + the Bluetooth address as a string and ``psm`` is an integer. + + - :const:`BTPROTO_RFCOMM` accepts ``(bdaddr, channel)`` where ``bdaddr`` + is the Bluetooth address as a string and ``channel`` is an integer. + + - :const:`BTPROTO_HCI` accepts ``(device_id,)`` where ``device_id`` is + either an integer or a string with the Bluetooth address of the + interface. (This depends on your OS; NetBSD and DragonFlyBSD expect + a Bluetooth address while everything else expects an integer.) + + .. versionchanged:: 3.2 + NetBSD and DragonFlyBSD support added. + + - :const:`BTPROTO_SCO` accepts ``bdaddr`` where ``bdaddr`` is a + :class:`bytes` object containing the Bluetooth address in a + string format. (ex. ``b'12:23:34:45:56:67'``) This protocol is not + supported under FreeBSD. + +- :const:`AF_ALG` is a Linux-only socket based interface to Kernel + cryptography. An algorithm socket is configured with a tuple of two to four + elements ``(type, name [, feat [, mask]])``, where: + + - *type* is the algorithm type as string, e.g. ``aead``, ``hash``, + ``skcipher`` or ``rng``. + + - *name* is the algorithm name and operation mode as string, e.g. + ``sha256``, ``hmac(sha256)``, ``cbc(aes)`` or ``drbg_nopr_ctr_aes256``. + + - *feat* and *mask* are unsigned 32bit integers. + + .. availability:: Linux 2.6.38, some algorithm types require more recent Kernels. + + .. versionadded:: 3.6 + +- :const:`AF_VSOCK` allows communication between virtual machines and + their hosts. The sockets are represented as a ``(CID, port)`` tuple + where the context ID or CID and port are integers. + + .. availability:: Linux >= 4.8 QEMU >= 2.8 ESX >= 4.0 ESX Workstation >= 6.5. + + .. versionadded:: 3.7 + +- :const:`AF_PACKET` is a low-level interface directly to network devices. + The packets are represented by the tuple + ``(ifname, proto[, pkttype[, hatype[, addr]]])`` where: + + - *ifname* - String specifying the device name. + - *proto* - An in network-byte-order integer specifying the Ethernet + protocol number. + - *pkttype* - Optional integer specifying the packet type: + + - ``PACKET_HOST`` (the default) - Packet addressed to the local host. + - ``PACKET_BROADCAST`` - Physical-layer broadcast packet. + - ``PACKET_MULTIHOST`` - Packet sent to a physical-layer multicast address. + - ``PACKET_OTHERHOST`` - Packet to some other host that has been caught by + a device driver in promiscuous mode. + - ``PACKET_OUTGOING`` - Packet originating from the local host that is + looped back to a packet socket. + - *hatype* - Optional integer specifying the ARP hardware address type. + - *addr* - Optional bytes-like object specifying the hardware physical + address, whose interpretation depends on the device. + +If you use a hostname in the *host* portion of IPv4/v6 socket address, the +program may show a nondeterministic behavior, as Python uses the first address +returned from the DNS resolution. The socket address will be resolved +differently into an actual IPv4/v6 address, depending on the results from DNS +resolution and/or the host configuration. For deterministic behavior use a +numeric address in *host* portion. + +All errors raise exceptions. The normal exceptions for invalid argument types +and out-of-memory conditions can be raised; starting from Python 3.3, errors +related to socket or address semantics raise :exc:`OSError` or one of its +subclasses (they used to raise :exc:`socket.error`). + +Non-blocking mode is supported through :meth:`~socket.setblocking`. A +generalization of this based on timeouts is supported through +:meth:`~socket.settimeout`. + + +Module contents +--------------- + +The module :mod:`socket` exports the following elements. + + +Exceptions +^^^^^^^^^^ + +.. exception:: error + + A deprecated alias of :exc:`OSError`. + + .. versionchanged:: 3.3 + Following :pep:`3151`, this class was made an alias of :exc:`OSError`. + + +.. exception:: herror + + A subclass of :exc:`OSError`, this exception is raised for + address-related errors, i.e. for functions that use *h_errno* in the POSIX + C API, including :func:`gethostbyname_ex` and :func:`gethostbyaddr`. + The accompanying value is a pair ``(h_errno, string)`` representing an + error returned by a library call. *h_errno* is a numeric value, while + *string* represents the description of *h_errno*, as returned by the + :c:func:`hstrerror` C function. + + .. versionchanged:: 3.3 + This class was made a subclass of :exc:`OSError`. + +.. exception:: gaierror + + A subclass of :exc:`OSError`, this exception is raised for + address-related errors by :func:`getaddrinfo` and :func:`getnameinfo`. + The accompanying value is a pair ``(error, string)`` representing an error + returned by a library call. *string* represents the description of + *error*, as returned by the :c:func:`gai_strerror` C function. The + numeric *error* value will match one of the :const:`EAI_\*` constants + defined in this module. + + .. versionchanged:: 3.3 + This class was made a subclass of :exc:`OSError`. + +.. exception:: timeout + + A subclass of :exc:`OSError`, this exception is raised when a timeout + occurs on a socket which has had timeouts enabled via a prior call to + :meth:`~socket.settimeout` (or implicitly through + :func:`~socket.setdefaulttimeout`). The accompanying value is a string + whose value is currently always "timed out". + + .. versionchanged:: 3.3 + This class was made a subclass of :exc:`OSError`. + + +Constants +^^^^^^^^^ + + The AF_* and SOCK_* constants are now :class:`AddressFamily` and + :class:`SocketKind` :class:`.IntEnum` collections. + + .. versionadded:: 3.4 + +.. data:: AF_UNIX + AF_INET + AF_INET6 + + These constants represent the address (and protocol) families, used for the + first argument to :func:`.socket`. If the :const:`AF_UNIX` constant is not + defined then this protocol is unsupported. More constants may be available + depending on the system. + + +.. data:: SOCK_STREAM + SOCK_DGRAM + SOCK_RAW + SOCK_RDM + SOCK_SEQPACKET + + These constants represent the socket types, used for the second argument to + :func:`.socket`. More constants may be available depending on the system. + (Only :const:`SOCK_STREAM` and :const:`SOCK_DGRAM` appear to be generally + useful.) + +.. data:: SOCK_CLOEXEC + SOCK_NONBLOCK + + These two constants, if defined, can be combined with the socket types and + allow you to set some flags atomically (thus avoiding possible race + conditions and the need for separate calls). + + .. seealso:: + + `Secure File Descriptor Handling `_ + for a more thorough explanation. + + .. availability:: Linux >= 2.6.27. + + .. versionadded:: 3.2 + +.. data:: SO_* + SOMAXCONN + MSG_* + SOL_* + SCM_* + IPPROTO_* + IPPORT_* + INADDR_* + IP_* + IPV6_* + EAI_* + AI_* + NI_* + TCP_* + + Many constants of these forms, documented in the Unix documentation on sockets + and/or the IP protocol, are also defined in the socket module. They are + generally used in arguments to the :meth:`setsockopt` and :meth:`getsockopt` + methods of socket objects. In most cases, only those symbols that are defined + in the Unix header files are defined; for a few symbols, default values are + provided. + + .. versionchanged:: 3.6 + ``SO_DOMAIN``, ``SO_PROTOCOL``, ``SO_PEERSEC``, ``SO_PASSSEC``, + ``TCP_USER_TIMEOUT``, ``TCP_CONGESTION`` were added. + + .. versionchanged:: 3.6.5 + On Windows, ``TCP_FASTOPEN``, ``TCP_KEEPCNT`` appear if run-time Windows + supports. + + .. versionchanged:: 3.7 + ``TCP_NOTSENT_LOWAT`` was added. + + On Windows, ``TCP_KEEPIDLE``, ``TCP_KEEPINTVL`` appear if run-time Windows + supports. + +.. data:: AF_CAN + PF_CAN + SOL_CAN_* + CAN_* + + Many constants of these forms, documented in the Linux documentation, are + also defined in the socket module. + + .. availability:: Linux >= 2.6.25. + + .. versionadded:: 3.3 + +.. data:: CAN_BCM + CAN_BCM_* + + CAN_BCM, in the CAN protocol family, is the broadcast manager (BCM) protocol. + Broadcast manager constants, documented in the Linux documentation, are also + defined in the socket module. + + .. availability:: Linux >= 2.6.25. + + .. versionadded:: 3.4 + +.. data:: CAN_RAW_FD_FRAMES + + Enables CAN FD support in a CAN_RAW socket. This is disabled by default. + This allows your application to send both CAN and CAN FD frames; however, + you must accept both CAN and CAN FD frames when reading from the socket. + + This constant is documented in the Linux documentation. + + .. availability:: Linux >= 3.6. + + .. versionadded:: 3.5 + +.. data:: CAN_ISOTP + + CAN_ISOTP, in the CAN protocol family, is the ISO-TP (ISO 15765-2) protocol. + ISO-TP constants, documented in the Linux documentation. + + .. availability:: Linux >= 2.6.25. + + .. versionadded:: 3.7 + + +.. data:: AF_PACKET + PF_PACKET + PACKET_* + + Many constants of these forms, documented in the Linux documentation, are + also defined in the socket module. + + .. availability:: Linux >= 2.2. + + +.. data:: AF_RDS + PF_RDS + SOL_RDS + RDS_* + + Many constants of these forms, documented in the Linux documentation, are + also defined in the socket module. + + .. availability:: Linux >= 2.6.30. + + .. versionadded:: 3.3 + + +.. data:: SIO_RCVALL + SIO_KEEPALIVE_VALS + SIO_LOOPBACK_FAST_PATH + RCVALL_* + + Constants for Windows' WSAIoctl(). The constants are used as arguments to the + :meth:`~socket.socket.ioctl` method of socket objects. + + .. versionchanged:: 3.6 + ``SIO_LOOPBACK_FAST_PATH`` was added. + + +.. data:: TIPC_* + + TIPC related constants, matching the ones exported by the C socket API. See + the TIPC documentation for more information. + +.. data:: AF_ALG + SOL_ALG + ALG_* + + Constants for Linux Kernel cryptography. + + .. availability:: Linux >= 2.6.38. + + .. versionadded:: 3.6 + + +.. data:: AF_VSOCK + IOCTL_VM_SOCKETS_GET_LOCAL_CID + VMADDR* + SO_VM* + + Constants for Linux host/guest communication. + + .. availability:: Linux >= 4.8. + + .. versionadded:: 3.7 + +.. data:: AF_LINK + + .. availability:: BSD, OSX. + + .. versionadded:: 3.4 + +.. data:: has_ipv6 + + This constant contains a boolean value which indicates if IPv6 is supported on + this platform. + +.. data:: BDADDR_ANY + BDADDR_LOCAL + + These are string constants containing Bluetooth addresses with special + meanings. For example, :const:`BDADDR_ANY` can be used to indicate + any address when specifying the binding socket with + :const:`BTPROTO_RFCOMM`. + +.. data:: HCI_FILTER + HCI_TIME_STAMP + HCI_DATA_DIR + + For use with :const:`BTPROTO_HCI`. :const:`HCI_FILTER` is not + available for NetBSD or DragonFlyBSD. :const:`HCI_TIME_STAMP` and + :const:`HCI_DATA_DIR` are not available for FreeBSD, NetBSD, or + DragonFlyBSD. + +Functions +^^^^^^^^^ + +Creating sockets +'''''''''''''''' + +The following functions all create :ref:`socket objects `. + + +.. function:: socket(family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None) + + Create a new socket using the given address family, socket type and protocol + number. The address family should be :const:`AF_INET` (the default), + :const:`AF_INET6`, :const:`AF_UNIX`, :const:`AF_CAN`, :const:`AF_PACKET`, + or :const:`AF_RDS`. The socket type should be :const:`SOCK_STREAM` (the + default), :const:`SOCK_DGRAM`, :const:`SOCK_RAW` or perhaps one of the other + ``SOCK_`` constants. The protocol number is usually zero and may be omitted + or in the case where the address family is :const:`AF_CAN` the protocol + should be one of :const:`CAN_RAW`, :const:`CAN_BCM` or :const:`CAN_ISOTP`. + + If *fileno* is specified, the values for *family*, *type*, and *proto* are + auto-detected from the specified file descriptor. Auto-detection can be + overruled by calling the function with explicit *family*, *type*, or *proto* + arguments. This only affects how Python represents e.g. the return value + of :meth:`socket.getpeername` but not the actual OS resource. Unlike + :func:`socket.fromfd`, *fileno* will return the same socket and not a + duplicate. This may help close a detached socket using + :meth:`socket.close()`. + + The newly created socket is :ref:`non-inheritable `. + + .. versionchanged:: 3.3 + The AF_CAN family was added. + The AF_RDS family was added. + + .. versionchanged:: 3.4 + The CAN_BCM protocol was added. + + .. versionchanged:: 3.4 + The returned socket is now non-inheritable. + + .. versionchanged:: 3.7 + The CAN_ISOTP protocol was added. + + .. versionchanged:: 3.7 + When :const:`SOCK_NONBLOCK` or :const:`SOCK_CLOEXEC` + bit flags are applied to *type* they are cleared, and + :attr:`socket.type` will not reflect them. They are still passed + to the underlying system `socket()` call. Therefore:: + + sock = socket.socket( + socket.AF_INET, + socket.SOCK_STREAM | socket.SOCK_NONBLOCK) + + will still create a non-blocking socket on OSes that support + ``SOCK_NONBLOCK``, but ``sock.type`` will be set to + ``socket.SOCK_STREAM``. + +.. function:: socketpair([family[, type[, proto]]]) + + Build a pair of connected socket objects using the given address family, socket + type, and protocol number. Address family, socket type, and protocol number are + as for the :func:`.socket` function above. The default family is :const:`AF_UNIX` + if defined on the platform; otherwise, the default is :const:`AF_INET`. + + The newly created sockets are :ref:`non-inheritable `. + + .. versionchanged:: 3.2 + The returned socket objects now support the whole socket API, rather + than a subset. + + .. versionchanged:: 3.4 + The returned sockets are now non-inheritable. + + .. versionchanged:: 3.5 + Windows support added. + + +.. function:: create_connection(address[, timeout[, source_address]]) + + Connect to a TCP service listening on the Internet *address* (a 2-tuple + ``(host, port)``), and return the socket object. This is a higher-level + function than :meth:`socket.connect`: if *host* is a non-numeric hostname, + it will try to resolve it for both :data:`AF_INET` and :data:`AF_INET6`, + and then try to connect to all possible addresses in turn until a + connection succeeds. This makes it easy to write clients that are + compatible to both IPv4 and IPv6. + + Passing the optional *timeout* parameter will set the timeout on the + socket instance before attempting to connect. If no *timeout* is + supplied, the global default timeout setting returned by + :func:`getdefaulttimeout` is used. + + If supplied, *source_address* must be a 2-tuple ``(host, port)`` for the + socket to bind to as its source address before connecting. If host or port + are '' or 0 respectively the OS default behavior will be used. + + .. versionchanged:: 3.2 + *source_address* was added. + + +.. function:: fromfd(fd, family, type, proto=0) + + Duplicate the file descriptor *fd* (an integer as returned by a file object's + :meth:`fileno` method) and build a socket object from the result. Address + family, socket type and protocol number are as for the :func:`.socket` function + above. The file descriptor should refer to a socket, but this is not checked --- + subsequent operations on the object may fail if the file descriptor is invalid. + This function is rarely needed, but can be used to get or set socket options on + a socket passed to a program as standard input or output (such as a server + started by the Unix inet daemon). The socket is assumed to be in blocking mode. + + The newly created socket is :ref:`non-inheritable `. + + .. versionchanged:: 3.4 + The returned socket is now non-inheritable. + + +.. function:: fromshare(data) + + Instantiate a socket from data obtained from the :meth:`socket.share` + method. The socket is assumed to be in blocking mode. + + .. availability:: Windows. + + .. versionadded:: 3.3 + + +.. data:: SocketType + + This is a Python type object that represents the socket object type. It is the + same as ``type(socket(...))``. + + +Other functions +''''''''''''''' + +The :mod:`socket` module also offers various network-related services: + + +.. function:: close(fd) + + Close a socket file descriptor. This is like :func:`os.close`, but for + sockets. On some platforms (most noticeable Windows) :func:`os.close` + does not work for socket file descriptors. + + .. versionadded:: 3.7 + +.. function:: getaddrinfo(host, port, family=0, type=0, proto=0, flags=0) + + Translate the *host*/*port* argument into a sequence of 5-tuples that contain + all the necessary arguments for creating a socket connected to that service. + *host* is a domain name, a string representation of an IPv4/v6 address + or ``None``. *port* is a string service name such as ``'http'``, a numeric + port number or ``None``. By passing ``None`` as the value of *host* + and *port*, you can pass ``NULL`` to the underlying C API. + + The *family*, *type* and *proto* arguments can be optionally specified + in order to narrow the list of addresses returned. Passing zero as a + value for each of these arguments selects the full range of results. + The *flags* argument can be one or several of the ``AI_*`` constants, + and will influence how results are computed and returned. + For example, :const:`AI_NUMERICHOST` will disable domain name resolution + and will raise an error if *host* is a domain name. + + The function returns a list of 5-tuples with the following structure: + + ``(family, type, proto, canonname, sockaddr)`` + + In these tuples, *family*, *type*, *proto* are all integers and are + meant to be passed to the :func:`.socket` function. *canonname* will be + a string representing the canonical name of the *host* if + :const:`AI_CANONNAME` is part of the *flags* argument; else *canonname* + will be empty. *sockaddr* is a tuple describing a socket address, whose + format depends on the returned *family* (a ``(address, port)`` 2-tuple for + :const:`AF_INET`, a ``(address, port, flow info, scope id)`` 4-tuple for + :const:`AF_INET6`), and is meant to be passed to the :meth:`socket.connect` + method. + + The following example fetches address information for a hypothetical TCP + connection to ``example.org`` on port 80 (results may differ on your + system if IPv6 isn't enabled):: + + >>> socket.getaddrinfo("example.org", 80, proto=socket.IPPROTO_TCP) + [(, , + 6, '', ('2606:2800:220:1:248:1893:25c8:1946', 80, 0, 0)), + (, , + 6, '', ('93.184.216.34', 80))] + + .. versionchanged:: 3.2 + parameters can now be passed using keyword arguments. + + .. versionchanged:: 3.7 + for IPv6 multicast addresses, string representing an address will not + contain ``%scope`` part. + +.. function:: getfqdn([name]) + + Return a fully qualified domain name for *name*. If *name* is omitted or empty, + it is interpreted as the local host. To find the fully qualified name, the + hostname returned by :func:`gethostbyaddr` is checked, followed by aliases for the + host, if available. The first name which includes a period is selected. In + case no fully qualified domain name is available, the hostname as returned by + :func:`gethostname` is returned. + + +.. function:: gethostbyname(hostname) + + Translate a host name to IPv4 address format. The IPv4 address is returned as a + string, such as ``'100.50.200.5'``. If the host name is an IPv4 address itself + it is returned unchanged. See :func:`gethostbyname_ex` for a more complete + interface. :func:`gethostbyname` does not support IPv6 name resolution, and + :func:`getaddrinfo` should be used instead for IPv4/v6 dual stack support. + + +.. function:: gethostbyname_ex(hostname) + + Translate a host name to IPv4 address format, extended interface. Return a + triple ``(hostname, aliaslist, ipaddrlist)`` where *hostname* is the primary + host name responding to the given *ip_address*, *aliaslist* is a (possibly + empty) list of alternative host names for the same address, and *ipaddrlist* is + a list of IPv4 addresses for the same interface on the same host (often but not + always a single address). :func:`gethostbyname_ex` does not support IPv6 name + resolution, and :func:`getaddrinfo` should be used instead for IPv4/v6 dual + stack support. + + +.. function:: gethostname() + + Return a string containing the hostname of the machine where the Python + interpreter is currently executing. + + Note: :func:`gethostname` doesn't always return the fully qualified domain + name; use :func:`getfqdn` for that. + + +.. function:: gethostbyaddr(ip_address) + + Return a triple ``(hostname, aliaslist, ipaddrlist)`` where *hostname* is the + primary host name responding to the given *ip_address*, *aliaslist* is a + (possibly empty) list of alternative host names for the same address, and + *ipaddrlist* is a list of IPv4/v6 addresses for the same interface on the same + host (most likely containing only a single address). To find the fully qualified + domain name, use the function :func:`getfqdn`. :func:`gethostbyaddr` supports + both IPv4 and IPv6. + + +.. function:: getnameinfo(sockaddr, flags) + + Translate a socket address *sockaddr* into a 2-tuple ``(host, port)``. Depending + on the settings of *flags*, the result can contain a fully-qualified domain name + or numeric address representation in *host*. Similarly, *port* can contain a + string port name or a numeric port number. + + For IPv6 addresses, ``%scope`` is appended to the host part if *sockaddr* + contains meaningful *scopeid*. Usually this happens for multicast addresses. + +.. function:: getprotobyname(protocolname) + + Translate an Internet protocol name (for example, ``'icmp'``) to a constant + suitable for passing as the (optional) third argument to the :func:`.socket` + function. This is usually only needed for sockets opened in "raw" mode + (:const:`SOCK_RAW`); for the normal socket modes, the correct protocol is chosen + automatically if the protocol is omitted or zero. + + +.. function:: getservbyname(servicename[, protocolname]) + + Translate an Internet service name and protocol name to a port number for that + service. The optional protocol name, if given, should be ``'tcp'`` or + ``'udp'``, otherwise any protocol will match. + + +.. function:: getservbyport(port[, protocolname]) + + Translate an Internet port number and protocol name to a service name for that + service. The optional protocol name, if given, should be ``'tcp'`` or + ``'udp'``, otherwise any protocol will match. + + +.. function:: ntohl(x) + + Convert 32-bit positive integers from network to host byte order. On machines + where the host byte order is the same as network byte order, this is a no-op; + otherwise, it performs a 4-byte swap operation. + + +.. function:: ntohs(x) + + Convert 16-bit positive integers from network to host byte order. On machines + where the host byte order is the same as network byte order, this is a no-op; + otherwise, it performs a 2-byte swap operation. + + .. deprecated:: 3.7 + In case *x* does not fit in 16-bit unsigned integer, but does fit in a + positive C int, it is silently truncated to 16-bit unsigned integer. + This silent truncation feature is deprecated, and will raise an + exception in future versions of Python. + + +.. function:: htonl(x) + + Convert 32-bit positive integers from host to network byte order. On machines + where the host byte order is the same as network byte order, this is a no-op; + otherwise, it performs a 4-byte swap operation. + + +.. function:: htons(x) + + Convert 16-bit positive integers from host to network byte order. On machines + where the host byte order is the same as network byte order, this is a no-op; + otherwise, it performs a 2-byte swap operation. + + .. deprecated:: 3.7 + In case *x* does not fit in 16-bit unsigned integer, but does fit in a + positive C int, it is silently truncated to 16-bit unsigned integer. + This silent truncation feature is deprecated, and will raise an + exception in future versions of Python. + + +.. function:: inet_aton(ip_string) + + Convert an IPv4 address from dotted-quad string format (for example, + '123.45.67.89') to 32-bit packed binary format, as a bytes object four characters in + length. This is useful when conversing with a program that uses the standard C + library and needs objects of type :c:type:`struct in_addr`, which is the C type + for the 32-bit packed binary this function returns. + + :func:`inet_aton` also accepts strings with less than three dots; see the + Unix manual page :manpage:`inet(3)` for details. + + If the IPv4 address string passed to this function is invalid, + :exc:`OSError` will be raised. Note that exactly what is valid depends on + the underlying C implementation of :c:func:`inet_aton`. + + :func:`inet_aton` does not support IPv6, and :func:`inet_pton` should be used + instead for IPv4/v6 dual stack support. + + +.. function:: inet_ntoa(packed_ip) + + Convert a 32-bit packed IPv4 address (a :term:`bytes-like object` four + bytes in length) to its standard dotted-quad string representation (for example, + '123.45.67.89'). This is useful when conversing with a program that uses the + standard C library and needs objects of type :c:type:`struct in_addr`, which + is the C type for the 32-bit packed binary data this function takes as an + argument. + + If the byte sequence passed to this function is not exactly 4 bytes in + length, :exc:`OSError` will be raised. :func:`inet_ntoa` does not + support IPv6, and :func:`inet_ntop` should be used instead for IPv4/v6 dual + stack support. + + .. versionchanged:: 3.5 + Writable :term:`bytes-like object` is now accepted. + + +.. function:: inet_pton(address_family, ip_string) + + Convert an IP address from its family-specific string format to a packed, + binary format. :func:`inet_pton` is useful when a library or network protocol + calls for an object of type :c:type:`struct in_addr` (similar to + :func:`inet_aton`) or :c:type:`struct in6_addr`. + + Supported values for *address_family* are currently :const:`AF_INET` and + :const:`AF_INET6`. If the IP address string *ip_string* is invalid, + :exc:`OSError` will be raised. Note that exactly what is valid depends on + both the value of *address_family* and the underlying implementation of + :c:func:`inet_pton`. + + .. availability:: Unix (maybe not all platforms), Windows. + + .. versionchanged:: 3.4 + Windows support added + + +.. function:: inet_ntop(address_family, packed_ip) + + Convert a packed IP address (a :term:`bytes-like object` of some number of + bytes) to its standard, family-specific string representation (for + example, ``'7.10.0.5'`` or ``'5aef:2b::8'``). + :func:`inet_ntop` is useful when a library or network protocol returns an + object of type :c:type:`struct in_addr` (similar to :func:`inet_ntoa`) or + :c:type:`struct in6_addr`. + + Supported values for *address_family* are currently :const:`AF_INET` and + :const:`AF_INET6`. If the bytes object *packed_ip* is not the correct + length for the specified address family, :exc:`ValueError` will be raised. + :exc:`OSError` is raised for errors from the call to :func:`inet_ntop`. + + .. availability:: Unix (maybe not all platforms), Windows. + + .. versionchanged:: 3.4 + Windows support added + + .. versionchanged:: 3.5 + Writable :term:`bytes-like object` is now accepted. + + +.. + XXX: Are sendmsg(), recvmsg() and CMSG_*() available on any + non-Unix platforms? The old (obsolete?) 4.2BSD form of the + interface, in which struct msghdr has no msg_control or + msg_controllen members, is not currently supported. + +.. function:: CMSG_LEN(length) + + Return the total length, without trailing padding, of an ancillary + data item with associated data of the given *length*. This value + can often be used as the buffer size for :meth:`~socket.recvmsg` to + receive a single item of ancillary data, but :rfc:`3542` requires + portable applications to use :func:`CMSG_SPACE` and thus include + space for padding, even when the item will be the last in the + buffer. Raises :exc:`OverflowError` if *length* is outside the + permissible range of values. + + .. availability:: most Unix platforms, possibly others. + + .. versionadded:: 3.3 + + +.. function:: CMSG_SPACE(length) + + Return the buffer size needed for :meth:`~socket.recvmsg` to + receive an ancillary data item with associated data of the given + *length*, along with any trailing padding. The buffer space needed + to receive multiple items is the sum of the :func:`CMSG_SPACE` + values for their associated data lengths. Raises + :exc:`OverflowError` if *length* is outside the permissible range + of values. + + Note that some systems might support ancillary data without + providing this function. Also note that setting the buffer size + using the results of this function may not precisely limit the + amount of ancillary data that can be received, since additional + data may be able to fit into the padding area. + + .. availability:: most Unix platforms, possibly others. + + .. versionadded:: 3.3 + + +.. function:: getdefaulttimeout() + + Return the default timeout in seconds (float) for new socket objects. A value + of ``None`` indicates that new socket objects have no timeout. When the socket + module is first imported, the default is ``None``. + + +.. function:: setdefaulttimeout(timeout) + + Set the default timeout in seconds (float) for new socket objects. When + the socket module is first imported, the default is ``None``. See + :meth:`~socket.settimeout` for possible values and their respective + meanings. + + +.. function:: sethostname(name) + + Set the machine's hostname to *name*. This will raise an + :exc:`OSError` if you don't have enough rights. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. function:: if_nameindex() + + Return a list of network interface information + (index int, name string) tuples. + :exc:`OSError` if the system call fails. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. function:: if_nametoindex(if_name) + + Return a network interface index number corresponding to an + interface name. + :exc:`OSError` if no interface with the given name exists. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. function:: if_indextoname(if_index) + + Return a network interface name corresponding to an + interface index number. + :exc:`OSError` if no interface with the given index exists. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. _socket-objects: + +Socket Objects +-------------- + +Socket objects have the following methods. Except for +:meth:`~socket.makefile`, these correspond to Unix system calls applicable +to sockets. + +.. versionchanged:: 3.2 + Support for the :term:`context manager` protocol was added. Exiting the + context manager is equivalent to calling :meth:`~socket.close`. + + +.. method:: socket.accept() + + Accept a connection. The socket must be bound to an address and listening for + connections. The return value is a pair ``(conn, address)`` where *conn* is a + *new* socket object usable to send and receive data on the connection, and + *address* is the address bound to the socket on the other end of the connection. + + The newly created socket is :ref:`non-inheritable `. + + .. versionchanged:: 3.4 + The socket is now non-inheritable. + + .. versionchanged:: 3.5 + If the system call is interrupted and the signal handler does not raise + an exception, the method now retries the system call instead of raising + an :exc:`InterruptedError` exception (see :pep:`475` for the rationale). + + +.. method:: socket.bind(address) + + Bind the socket to *address*. The socket must not already be bound. (The format + of *address* depends on the address family --- see above.) + + +.. method:: socket.close() + + Mark the socket closed. The underlying system resource (e.g. a file + descriptor) is also closed when all file objects from :meth:`makefile()` + are closed. Once that happens, all future operations on the socket + object will fail. The remote end will receive no more data (after + queued data is flushed). + + Sockets are automatically closed when they are garbage-collected, but + it is recommended to :meth:`close` them explicitly, or to use a + :keyword:`with` statement around them. + + .. versionchanged:: 3.6 + :exc:`OSError` is now raised if an error occurs when the underlying + :c:func:`close` call is made. + + .. note:: + + :meth:`close()` releases the resource associated with a connection but + does not necessarily close the connection immediately. If you want + to close the connection in a timely fashion, call :meth:`shutdown()` + before :meth:`close()`. + + +.. method:: socket.connect(address) + + Connect to a remote socket at *address*. (The format of *address* depends on the + address family --- see above.) + + If the connection is interrupted by a signal, the method waits until the + connection completes, or raise a :exc:`socket.timeout` on timeout, if the + signal handler doesn't raise an exception and the socket is blocking or has + a timeout. For non-blocking sockets, the method raises an + :exc:`InterruptedError` exception if the connection is interrupted by a + signal (or the exception raised by the signal handler). + + .. versionchanged:: 3.5 + The method now waits until the connection completes instead of raising an + :exc:`InterruptedError` exception if the connection is interrupted by a + signal, the signal handler doesn't raise an exception and the socket is + blocking or has a timeout (see the :pep:`475` for the rationale). + + +.. method:: socket.connect_ex(address) + + Like ``connect(address)``, but return an error indicator instead of raising an + exception for errors returned by the C-level :c:func:`connect` call (other + problems, such as "host not found," can still raise exceptions). The error + indicator is ``0`` if the operation succeeded, otherwise the value of the + :c:data:`errno` variable. This is useful to support, for example, asynchronous + connects. + + +.. method:: socket.detach() + + Put the socket object into closed state without actually closing the + underlying file descriptor. The file descriptor is returned, and can + be reused for other purposes. + + .. versionadded:: 3.2 + + +.. method:: socket.dup() + + Duplicate the socket. + + The newly created socket is :ref:`non-inheritable `. + + .. versionchanged:: 3.4 + The socket is now non-inheritable. + + +.. method:: socket.fileno() + + Return the socket's file descriptor (a small integer), or -1 on failure. This + is useful with :func:`select.select`. + + Under Windows the small integer returned by this method cannot be used where a + file descriptor can be used (such as :func:`os.fdopen`). Unix does not have + this limitation. + +.. method:: socket.get_inheritable() + + Get the :ref:`inheritable flag ` of the socket's file + descriptor or socket's handle: ``True`` if the socket can be inherited in + child processes, ``False`` if it cannot. + + .. versionadded:: 3.4 + + +.. method:: socket.getpeername() + + Return the remote address to which the socket is connected. This is useful to + find out the port number of a remote IPv4/v6 socket, for instance. (The format + of the address returned depends on the address family --- see above.) On some + systems this function is not supported. + + +.. method:: socket.getsockname() + + Return the socket's own address. This is useful to find out the port number of + an IPv4/v6 socket, for instance. (The format of the address returned depends on + the address family --- see above.) + + +.. method:: socket.getsockopt(level, optname[, buflen]) + + Return the value of the given socket option (see the Unix man page + :manpage:`getsockopt(2)`). The needed symbolic constants (:const:`SO_\*` etc.) + are defined in this module. If *buflen* is absent, an integer option is assumed + and its integer value is returned by the function. If *buflen* is present, it + specifies the maximum length of the buffer used to receive the option in, and + this buffer is returned as a bytes object. It is up to the caller to decode the + contents of the buffer (see the optional built-in module :mod:`struct` for a way + to decode C structures encoded as byte strings). + + +.. method:: socket.getblocking() + + Return ``True`` if socket is in blocking mode, ``False`` if in + non-blocking. + + This is equivalent to checking ``socket.gettimeout() == 0``. + + .. versionadded:: 3.7 + + +.. method:: socket.gettimeout() + + Return the timeout in seconds (float) associated with socket operations, + or ``None`` if no timeout is set. This reflects the last call to + :meth:`setblocking` or :meth:`settimeout`. + + +.. method:: socket.ioctl(control, option) + + :platform: Windows + + The :meth:`ioctl` method is a limited interface to the WSAIoctl system + interface. Please refer to the `Win32 documentation + `_ for more + information. + + On other platforms, the generic :func:`fcntl.fcntl` and :func:`fcntl.ioctl` + functions may be used; they accept a socket object as their first argument. + + Currently only the following control codes are supported: + ``SIO_RCVALL``, ``SIO_KEEPALIVE_VALS``, and ``SIO_LOOPBACK_FAST_PATH``. + + .. versionchanged:: 3.6 + ``SIO_LOOPBACK_FAST_PATH`` was added. + +.. method:: socket.listen([backlog]) + + Enable a server to accept connections. If *backlog* is specified, it must + be at least 0 (if it is lower, it is set to 0); it specifies the number of + unaccepted connections that the system will allow before refusing new + connections. If not specified, a default reasonable value is chosen. + + .. versionchanged:: 3.5 + The *backlog* parameter is now optional. + +.. method:: socket.makefile(mode='r', buffering=None, *, encoding=None, \ + errors=None, newline=None) + + .. index:: single: I/O control; buffering + + Return a :term:`file object` associated with the socket. The exact returned + type depends on the arguments given to :meth:`makefile`. These arguments are + interpreted the same way as by the built-in :func:`open` function, except + the only supported *mode* values are ``'r'`` (default), ``'w'`` and ``'b'``. + + The socket must be in blocking mode; it can have a timeout, but the file + object's internal buffer may end up in an inconsistent state if a timeout + occurs. + + Closing the file object returned by :meth:`makefile` won't close the + original socket unless all other file objects have been closed and + :meth:`socket.close` has been called on the socket object. + + .. note:: + + On Windows, the file-like object created by :meth:`makefile` cannot be + used where a file object with a file descriptor is expected, such as the + stream arguments of :meth:`subprocess.Popen`. + + +.. method:: socket.recv(bufsize[, flags]) + + Receive data from the socket. The return value is a bytes object representing the + data received. The maximum amount of data to be received at once is specified + by *bufsize*. See the Unix manual page :manpage:`recv(2)` for the meaning of + the optional argument *flags*; it defaults to zero. + + .. note:: + + For best match with hardware and network realities, the value of *bufsize* + should be a relatively small power of 2, for example, 4096. + + .. versionchanged:: 3.5 + If the system call is interrupted and the signal handler does not raise + an exception, the method now retries the system call instead of raising + an :exc:`InterruptedError` exception (see :pep:`475` for the rationale). + + +.. method:: socket.recvfrom(bufsize[, flags]) + + Receive data from the socket. The return value is a pair ``(bytes, address)`` + where *bytes* is a bytes object representing the data received and *address* is the + address of the socket sending the data. See the Unix manual page + :manpage:`recv(2)` for the meaning of the optional argument *flags*; it defaults + to zero. (The format of *address* depends on the address family --- see above.) + + .. versionchanged:: 3.5 + If the system call is interrupted and the signal handler does not raise + an exception, the method now retries the system call instead of raising + an :exc:`InterruptedError` exception (see :pep:`475` for the rationale). + + .. versionchanged:: 3.7 + For multicast IPv6 address, first item of *address* does not contain + ``%scope`` part anymore. In order to get full IPv6 address use + :func:`getnameinfo`. + +.. method:: socket.recvmsg(bufsize[, ancbufsize[, flags]]) + + Receive normal data (up to *bufsize* bytes) and ancillary data from + the socket. The *ancbufsize* argument sets the size in bytes of + the internal buffer used to receive the ancillary data; it defaults + to 0, meaning that no ancillary data will be received. Appropriate + buffer sizes for ancillary data can be calculated using + :func:`CMSG_SPACE` or :func:`CMSG_LEN`, and items which do not fit + into the buffer might be truncated or discarded. The *flags* + argument defaults to 0 and has the same meaning as for + :meth:`recv`. + + The return value is a 4-tuple: ``(data, ancdata, msg_flags, + address)``. The *data* item is a :class:`bytes` object holding the + non-ancillary data received. The *ancdata* item is a list of zero + or more tuples ``(cmsg_level, cmsg_type, cmsg_data)`` representing + the ancillary data (control messages) received: *cmsg_level* and + *cmsg_type* are integers specifying the protocol level and + protocol-specific type respectively, and *cmsg_data* is a + :class:`bytes` object holding the associated data. The *msg_flags* + item is the bitwise OR of various flags indicating conditions on + the received message; see your system documentation for details. + If the receiving socket is unconnected, *address* is the address of + the sending socket, if available; otherwise, its value is + unspecified. + + On some systems, :meth:`sendmsg` and :meth:`recvmsg` can be used to + pass file descriptors between processes over an :const:`AF_UNIX` + socket. When this facility is used (it is often restricted to + :const:`SOCK_STREAM` sockets), :meth:`recvmsg` will return, in its + ancillary data, items of the form ``(socket.SOL_SOCKET, + socket.SCM_RIGHTS, fds)``, where *fds* is a :class:`bytes` object + representing the new file descriptors as a binary array of the + native C :c:type:`int` type. If :meth:`recvmsg` raises an + exception after the system call returns, it will first attempt to + close any file descriptors received via this mechanism. + + Some systems do not indicate the truncated length of ancillary data + items which have been only partially received. If an item appears + to extend beyond the end of the buffer, :meth:`recvmsg` will issue + a :exc:`RuntimeWarning`, and will return the part of it which is + inside the buffer provided it has not been truncated before the + start of its associated data. + + On systems which support the :const:`SCM_RIGHTS` mechanism, the + following function will receive up to *maxfds* file descriptors, + returning the message data and a list containing the descriptors + (while ignoring unexpected conditions such as unrelated control + messages being received). See also :meth:`sendmsg`. :: + + import socket, array + + def recv_fds(sock, msglen, maxfds): + fds = array.array("i") # Array of ints + msg, ancdata, flags, addr = sock.recvmsg(msglen, socket.CMSG_LEN(maxfds * fds.itemsize)) + for cmsg_level, cmsg_type, cmsg_data in ancdata: + if (cmsg_level == socket.SOL_SOCKET and cmsg_type == socket.SCM_RIGHTS): + # Append data, ignoring any truncated integers at the end. + fds.fromstring(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)]) + return msg, list(fds) + + .. availability:: most Unix platforms, possibly others. + + .. versionadded:: 3.3 + + .. versionchanged:: 3.5 + If the system call is interrupted and the signal handler does not raise + an exception, the method now retries the system call instead of raising + an :exc:`InterruptedError` exception (see :pep:`475` for the rationale). + + +.. method:: socket.recvmsg_into(buffers[, ancbufsize[, flags]]) + + Receive normal data and ancillary data from the socket, behaving as + :meth:`recvmsg` would, but scatter the non-ancillary data into a + series of buffers instead of returning a new bytes object. The + *buffers* argument must be an iterable of objects that export + writable buffers (e.g. :class:`bytearray` objects); these will be + filled with successive chunks of the non-ancillary data until it + has all been written or there are no more buffers. The operating + system may set a limit (:func:`~os.sysconf` value ``SC_IOV_MAX``) + on the number of buffers that can be used. The *ancbufsize* and + *flags* arguments have the same meaning as for :meth:`recvmsg`. + + The return value is a 4-tuple: ``(nbytes, ancdata, msg_flags, + address)``, where *nbytes* is the total number of bytes of + non-ancillary data written into the buffers, and *ancdata*, + *msg_flags* and *address* are the same as for :meth:`recvmsg`. + + Example:: + + >>> import socket + >>> s1, s2 = socket.socketpair() + >>> b1 = bytearray(b'----') + >>> b2 = bytearray(b'0123456789') + >>> b3 = bytearray(b'--------------') + >>> s1.send(b'Mary had a little lamb') + 22 + >>> s2.recvmsg_into([b1, memoryview(b2)[2:9], b3]) + (22, [], 0, None) + >>> [b1, b2, b3] + [bytearray(b'Mary'), bytearray(b'01 had a 9'), bytearray(b'little lamb---')] + + .. availability:: most Unix platforms, possibly others. + + .. versionadded:: 3.3 + + +.. method:: socket.recvfrom_into(buffer[, nbytes[, flags]]) + + Receive data from the socket, writing it into *buffer* instead of creating a + new bytestring. The return value is a pair ``(nbytes, address)`` where *nbytes* is + the number of bytes received and *address* is the address of the socket sending + the data. See the Unix manual page :manpage:`recv(2)` for the meaning of the + optional argument *flags*; it defaults to zero. (The format of *address* + depends on the address family --- see above.) + + +.. method:: socket.recv_into(buffer[, nbytes[, flags]]) + + Receive up to *nbytes* bytes from the socket, storing the data into a buffer + rather than creating a new bytestring. If *nbytes* is not specified (or 0), + receive up to the size available in the given buffer. Returns the number of + bytes received. See the Unix manual page :manpage:`recv(2)` for the meaning + of the optional argument *flags*; it defaults to zero. + + +.. method:: socket.send(bytes[, flags]) + + Send data to the socket. The socket must be connected to a remote socket. The + optional *flags* argument has the same meaning as for :meth:`recv` above. + Returns the number of bytes sent. Applications are responsible for checking that + all data has been sent; if only some of the data was transmitted, the + application needs to attempt delivery of the remaining data. For further + information on this topic, consult the :ref:`socket-howto`. + + .. versionchanged:: 3.5 + If the system call is interrupted and the signal handler does not raise + an exception, the method now retries the system call instead of raising + an :exc:`InterruptedError` exception (see :pep:`475` for the rationale). + + +.. method:: socket.sendall(bytes[, flags]) + + Send data to the socket. The socket must be connected to a remote socket. The + optional *flags* argument has the same meaning as for :meth:`recv` above. + Unlike :meth:`send`, this method continues to send data from *bytes* until + either all data has been sent or an error occurs. ``None`` is returned on + success. On error, an exception is raised, and there is no way to determine how + much data, if any, was successfully sent. + + .. versionchanged:: 3.5 + The socket timeout is no more reset each time data is sent successfully. + The socket timeout is now the maximum total duration to send all data. + + .. versionchanged:: 3.5 + If the system call is interrupted and the signal handler does not raise + an exception, the method now retries the system call instead of raising + an :exc:`InterruptedError` exception (see :pep:`475` for the rationale). + + +.. method:: socket.sendto(bytes, address) + socket.sendto(bytes, flags, address) + + Send data to the socket. The socket should not be connected to a remote socket, + since the destination socket is specified by *address*. The optional *flags* + argument has the same meaning as for :meth:`recv` above. Return the number of + bytes sent. (The format of *address* depends on the address family --- see + above.) + + .. versionchanged:: 3.5 + If the system call is interrupted and the signal handler does not raise + an exception, the method now retries the system call instead of raising + an :exc:`InterruptedError` exception (see :pep:`475` for the rationale). + + +.. method:: socket.sendmsg(buffers[, ancdata[, flags[, address]]]) + + Send normal and ancillary data to the socket, gathering the + non-ancillary data from a series of buffers and concatenating it + into a single message. The *buffers* argument specifies the + non-ancillary data as an iterable of + :term:`bytes-like objects ` + (e.g. :class:`bytes` objects); the operating system may set a limit + (:func:`~os.sysconf` value ``SC_IOV_MAX``) on the number of buffers + that can be used. The *ancdata* argument specifies the ancillary + data (control messages) as an iterable of zero or more tuples + ``(cmsg_level, cmsg_type, cmsg_data)``, where *cmsg_level* and + *cmsg_type* are integers specifying the protocol level and + protocol-specific type respectively, and *cmsg_data* is a + bytes-like object holding the associated data. Note that + some systems (in particular, systems without :func:`CMSG_SPACE`) + might support sending only one control message per call. The + *flags* argument defaults to 0 and has the same meaning as for + :meth:`send`. If *address* is supplied and not ``None``, it sets a + destination address for the message. The return value is the + number of bytes of non-ancillary data sent. + + The following function sends the list of file descriptors *fds* + over an :const:`AF_UNIX` socket, on systems which support the + :const:`SCM_RIGHTS` mechanism. See also :meth:`recvmsg`. :: + + import socket, array + + def send_fds(sock, msg, fds): + return sock.sendmsg([msg], [(socket.SOL_SOCKET, socket.SCM_RIGHTS, array.array("i", fds))]) + + .. availability:: most Unix platforms, possibly others. + + .. versionadded:: 3.3 + + .. versionchanged:: 3.5 + If the system call is interrupted and the signal handler does not raise + an exception, the method now retries the system call instead of raising + an :exc:`InterruptedError` exception (see :pep:`475` for the rationale). + +.. method:: socket.sendmsg_afalg([msg], *, op[, iv[, assoclen[, flags]]]) + + Specialized version of :meth:`~socket.sendmsg` for :const:`AF_ALG` socket. + Set mode, IV, AEAD associated data length and flags for :const:`AF_ALG` socket. + + .. availability:: Linux >= 2.6.38. + + .. versionadded:: 3.6 + +.. method:: socket.sendfile(file, offset=0, count=None) + + Send a file until EOF is reached by using high-performance + :mod:`os.sendfile` and return the total number of bytes which were sent. + *file* must be a regular file object opened in binary mode. If + :mod:`os.sendfile` is not available (e.g. Windows) or *file* is not a + regular file :meth:`send` will be used instead. *offset* tells from where to + start reading the file. If specified, *count* is the total number of bytes + to transmit as opposed to sending the file until EOF is reached. File + position is updated on return or also in case of error in which case + :meth:`file.tell() ` can be used to figure out the number of + bytes which were sent. The socket must be of :const:`SOCK_STREAM` type. + Non-blocking sockets are not supported. + + .. versionadded:: 3.5 + +.. method:: socket.set_inheritable(inheritable) + + Set the :ref:`inheritable flag ` of the socket's file + descriptor or socket's handle. + + .. versionadded:: 3.4 + + +.. method:: socket.setblocking(flag) + + Set blocking or non-blocking mode of the socket: if *flag* is false, the + socket is set to non-blocking, else to blocking mode. + + This method is a shorthand for certain :meth:`~socket.settimeout` calls: + + * ``sock.setblocking(True)`` is equivalent to ``sock.settimeout(None)`` + + * ``sock.setblocking(False)`` is equivalent to ``sock.settimeout(0.0)`` + + .. versionchanged:: 3.7 + The method no longer applies :const:`SOCK_NONBLOCK` flag on + :attr:`socket.type`. + + +.. method:: socket.settimeout(value) + + Set a timeout on blocking socket operations. The *value* argument can be a + nonnegative floating point number expressing seconds, or ``None``. + If a non-zero value is given, subsequent socket operations will raise a + :exc:`timeout` exception if the timeout period *value* has elapsed before + the operation has completed. If zero is given, the socket is put in + non-blocking mode. If ``None`` is given, the socket is put in blocking mode. + + For further information, please consult the :ref:`notes on socket timeouts `. + + .. versionchanged:: 3.7 + The method no longer toggles :const:`SOCK_NONBLOCK` flag on + :attr:`socket.type`. + + +.. method:: socket.setsockopt(level, optname, value: int) +.. method:: socket.setsockopt(level, optname, value: buffer) +.. method:: socket.setsockopt(level, optname, None, optlen: int) + + .. index:: module: struct + + Set the value of the given socket option (see the Unix manual page + :manpage:`setsockopt(2)`). The needed symbolic constants are defined in the + :mod:`socket` module (:const:`SO_\*` etc.). The value can be an integer, + ``None`` or a :term:`bytes-like object` representing a buffer. In the later + case it is up to the caller to ensure that the bytestring contains the + proper bits (see the optional built-in module :mod:`struct` for a way to + encode C structures as bytestrings). When value is set to ``None``, + optlen argument is required. It's equivalent to call setsockopt C + function with optval=NULL and optlen=optlen. + + + .. versionchanged:: 3.5 + Writable :term:`bytes-like object` is now accepted. + + .. versionchanged:: 3.6 + setsockopt(level, optname, None, optlen: int) form added. + + +.. method:: socket.shutdown(how) + + Shut down one or both halves of the connection. If *how* is :const:`SHUT_RD`, + further receives are disallowed. If *how* is :const:`SHUT_WR`, further sends + are disallowed. If *how* is :const:`SHUT_RDWR`, further sends and receives are + disallowed. + + +.. method:: socket.share(process_id) + + Duplicate a socket and prepare it for sharing with a target process. The + target process must be provided with *process_id*. The resulting bytes object + can then be passed to the target process using some form of interprocess + communication and the socket can be recreated there using :func:`fromshare`. + Once this method has been called, it is safe to close the socket since + the operating system has already duplicated it for the target process. + + .. availability:: Windows. + + .. versionadded:: 3.3 + + +Note that there are no methods :meth:`read` or :meth:`write`; use +:meth:`~socket.recv` and :meth:`~socket.send` without *flags* argument instead. + +Socket objects also have these (read-only) attributes that correspond to the +values given to the :class:`~socket.socket` constructor. + + +.. attribute:: socket.family + + The socket family. + + +.. attribute:: socket.type + + The socket type. + + +.. attribute:: socket.proto + + The socket protocol. + + + +.. _socket-timeouts: + +Notes on socket timeouts +------------------------ + +A socket object can be in one of three modes: blocking, non-blocking, or +timeout. Sockets are by default always created in blocking mode, but this +can be changed by calling :func:`setdefaulttimeout`. + +* In *blocking mode*, operations block until complete or the system returns + an error (such as connection timed out). + +* In *non-blocking mode*, operations fail (with an error that is unfortunately + system-dependent) if they cannot be completed immediately: functions from the + :mod:`select` can be used to know when and whether a socket is available for + reading or writing. + +* In *timeout mode*, operations fail if they cannot be completed within the + timeout specified for the socket (they raise a :exc:`timeout` exception) + or if the system returns an error. + +.. note:: + At the operating system level, sockets in *timeout mode* are internally set + in non-blocking mode. Also, the blocking and timeout modes are shared between + file descriptors and socket objects that refer to the same network endpoint. + This implementation detail can have visible consequences if e.g. you decide + to use the :meth:`~socket.fileno()` of a socket. + +Timeouts and the ``connect`` method +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The :meth:`~socket.connect` operation is also subject to the timeout +setting, and in general it is recommended to call :meth:`~socket.settimeout` +before calling :meth:`~socket.connect` or pass a timeout parameter to +:meth:`create_connection`. However, the system network stack may also +return a connection timeout error of its own regardless of any Python socket +timeout setting. + +Timeouts and the ``accept`` method +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If :func:`getdefaulttimeout` is not :const:`None`, sockets returned by +the :meth:`~socket.accept` method inherit that timeout. Otherwise, the +behaviour depends on settings of the listening socket: + +* if the listening socket is in *blocking mode* or in *timeout mode*, + the socket returned by :meth:`~socket.accept` is in *blocking mode*; + +* if the listening socket is in *non-blocking mode*, whether the socket + returned by :meth:`~socket.accept` is in blocking or non-blocking mode + is operating system-dependent. If you want to ensure cross-platform + behaviour, it is recommended you manually override this setting. + + +.. _socket-example: + +Example +------- + +Here are four minimal example programs using the TCP/IP protocol: a server that +echoes all data that it receives back (servicing only one client), and a client +using it. Note that a server must perform the sequence :func:`.socket`, +:meth:`~socket.bind`, :meth:`~socket.listen`, :meth:`~socket.accept` (possibly +repeating the :meth:`~socket.accept` to service more than one client), while a +client only needs the sequence :func:`.socket`, :meth:`~socket.connect`. Also +note that the server does not :meth:`~socket.sendall`/:meth:`~socket.recv` on +the socket it is listening on but on the new socket returned by +:meth:`~socket.accept`. + +The first two examples support IPv4 only. :: + + # Echo server program + import socket + + HOST = '' # Symbolic name meaning all available interfaces + PORT = 50007 # Arbitrary non-privileged port + with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s: + s.bind((HOST, PORT)) + s.listen(1) + conn, addr = s.accept() + with conn: + print('Connected by', addr) + while True: + data = conn.recv(1024) + if not data: break + conn.sendall(data) + +:: + + # Echo client program + import socket + + HOST = 'daring.cwi.nl' # The remote host + PORT = 50007 # The same port as used by the server + with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s: + s.connect((HOST, PORT)) + s.sendall(b'Hello, world') + data = s.recv(1024) + print('Received', repr(data)) + +The next two examples are identical to the above two, but support both IPv4 and +IPv6. The server side will listen to the first address family available (it +should listen to both instead). On most of IPv6-ready systems, IPv6 will take +precedence and the server may not accept IPv4 traffic. The client side will try +to connect to the all addresses returned as a result of the name resolution, and +sends traffic to the first one connected successfully. :: + + # Echo server program + import socket + import sys + + HOST = None # Symbolic name meaning all available interfaces + PORT = 50007 # Arbitrary non-privileged port + s = None + for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC, + socket.SOCK_STREAM, 0, socket.AI_PASSIVE): + af, socktype, proto, canonname, sa = res + try: + s = socket.socket(af, socktype, proto) + except OSError as msg: + s = None + continue + try: + s.bind(sa) + s.listen(1) + except OSError as msg: + s.close() + s = None + continue + break + if s is None: + print('could not open socket') + sys.exit(1) + conn, addr = s.accept() + with conn: + print('Connected by', addr) + while True: + data = conn.recv(1024) + if not data: break + conn.send(data) + +:: + + # Echo client program + import socket + import sys + + HOST = 'daring.cwi.nl' # The remote host + PORT = 50007 # The same port as used by the server + s = None + for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC, socket.SOCK_STREAM): + af, socktype, proto, canonname, sa = res + try: + s = socket.socket(af, socktype, proto) + except OSError as msg: + s = None + continue + try: + s.connect(sa) + except OSError as msg: + s.close() + s = None + continue + break + if s is None: + print('could not open socket') + sys.exit(1) + with s: + s.sendall(b'Hello, world') + data = s.recv(1024) + print('Received', repr(data)) + + +The next example shows how to write a very simple network sniffer with raw +sockets on Windows. The example requires administrator privileges to modify +the interface:: + + import socket + + # the public network interface + HOST = socket.gethostbyname(socket.gethostname()) + + # create a raw socket and bind it to the public interface + s = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.IPPROTO_IP) + s.bind((HOST, 0)) + + # Include IP headers + s.setsockopt(socket.IPPROTO_IP, socket.IP_HDRINCL, 1) + + # receive all packages + s.ioctl(socket.SIO_RCVALL, socket.RCVALL_ON) + + # receive a package + print(s.recvfrom(65565)) + + # disabled promiscuous mode + s.ioctl(socket.SIO_RCVALL, socket.RCVALL_OFF) + +The next example shows how to use the socket interface to communicate to a CAN +network using the raw socket protocol. To use CAN with the broadcast +manager protocol instead, open a socket with:: + + socket.socket(socket.AF_CAN, socket.SOCK_DGRAM, socket.CAN_BCM) + +After binding (:const:`CAN_RAW`) or connecting (:const:`CAN_BCM`) the socket, you +can use the :meth:`socket.send`, and the :meth:`socket.recv` operations (and +their counterparts) on the socket object as usual. + +This last example might require special privileges:: + + import socket + import struct + + + # CAN frame packing/unpacking (see 'struct can_frame' in ) + + can_frame_fmt = "=IB3x8s" + can_frame_size = struct.calcsize(can_frame_fmt) + + def build_can_frame(can_id, data): + can_dlc = len(data) + data = data.ljust(8, b'\x00') + return struct.pack(can_frame_fmt, can_id, can_dlc, data) + + def dissect_can_frame(frame): + can_id, can_dlc, data = struct.unpack(can_frame_fmt, frame) + return (can_id, can_dlc, data[:can_dlc]) + + + # create a raw socket and bind it to the 'vcan0' interface + s = socket.socket(socket.AF_CAN, socket.SOCK_RAW, socket.CAN_RAW) + s.bind(('vcan0',)) + + while True: + cf, addr = s.recvfrom(can_frame_size) + + print('Received: can_id=%x, can_dlc=%x, data=%s' % dissect_can_frame(cf)) + + try: + s.send(cf) + except OSError: + print('Error sending CAN frame') + + try: + s.send(build_can_frame(0x01, b'\x01\x02\x03')) + except OSError: + print('Error sending CAN frame') + +Running an example several times with too small delay between executions, could +lead to this error:: + + OSError: [Errno 98] Address already in use + +This is because the previous execution has left the socket in a ``TIME_WAIT`` +state, and can't be immediately reused. + +There is a :mod:`socket` flag to set, in order to prevent this, +:data:`socket.SO_REUSEADDR`:: + + s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) + s.bind((HOST, PORT)) + +the :data:`SO_REUSEADDR` flag tells the kernel to reuse a local socket in +``TIME_WAIT`` state, without waiting for its natural timeout to expire. + + +.. seealso:: + + For an introduction to socket programming (in C), see the following papers: + + - *An Introductory 4.3BSD Interprocess Communication Tutorial*, by Stuart Sechrest + + - *An Advanced 4.3BSD Interprocess Communication Tutorial*, by Samuel J. Leffler et + al, + + both in the UNIX Programmer's Manual, Supplementary Documents 1 (sections + PS1:7 and PS1:8). The platform-specific reference material for the various + socket-related system calls are also a valuable source of information on the + details of socket semantics. For Unix, refer to the manual pages; for Windows, + see the WinSock (or Winsock 2) specification. For IPv6-ready APIs, readers may + want to refer to :rfc:`3493` titled Basic Socket Interface Extensions for IPv6. diff --git a/python-3.7.4-docs-html/_sources/library/socketserver.rst.txt b/python-3.7.4-docs-html/_sources/library/socketserver.rst.txt new file mode 100644 index 0000000..7c8c8d5 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/socketserver.rst.txt @@ -0,0 +1,660 @@ +:mod:`socketserver` --- A framework for network servers +======================================================= + +.. module:: socketserver + :synopsis: A framework for network servers. + +**Source code:** :source:`Lib/socketserver.py` + +-------------- + +The :mod:`socketserver` module simplifies the task of writing network servers. + +There are four basic concrete server classes: + + +.. class:: TCPServer(server_address, RequestHandlerClass, bind_and_activate=True) + + This uses the Internet TCP protocol, which provides for + continuous streams of data between the client and server. + If *bind_and_activate* is true, the constructor automatically attempts to + invoke :meth:`~BaseServer.server_bind` and + :meth:`~BaseServer.server_activate`. The other parameters are passed to + the :class:`BaseServer` base class. + + +.. class:: UDPServer(server_address, RequestHandlerClass, bind_and_activate=True) + + This uses datagrams, which are discrete packets of information that may + arrive out of order or be lost while in transit. The parameters are + the same as for :class:`TCPServer`. + + +.. class:: UnixStreamServer(server_address, RequestHandlerClass, bind_and_activate=True) + UnixDatagramServer(server_address, RequestHandlerClass, bind_and_activate=True) + + These more infrequently used classes are similar to the TCP and + UDP classes, but use Unix domain sockets; they're not available on + non-Unix platforms. The parameters are the same as for + :class:`TCPServer`. + + +These four classes process requests :dfn:`synchronously`; each request must be +completed before the next request can be started. This isn't suitable if each +request takes a long time to complete, because it requires a lot of computation, +or because it returns a lot of data which the client is slow to process. The +solution is to create a separate process or thread to handle each request; the +:class:`ForkingMixIn` and :class:`ThreadingMixIn` mix-in classes can be used to +support asynchronous behaviour. + +Creating a server requires several steps. First, you must create a request +handler class by subclassing the :class:`BaseRequestHandler` class and +overriding its :meth:`~BaseRequestHandler.handle` method; +this method will process incoming +requests. Second, you must instantiate one of the server classes, passing it +the server's address and the request handler class. It is recommended to use +the server in a :keyword:`with` statement. Then call the +:meth:`~BaseServer.handle_request` or +:meth:`~BaseServer.serve_forever` method of the server object to +process one or many requests. Finally, call :meth:`~BaseServer.server_close` +to close the socket (unless you used a :keyword:`!with` statement). + +When inheriting from :class:`ThreadingMixIn` for threaded connection behavior, +you should explicitly declare how you want your threads to behave on an abrupt +shutdown. The :class:`ThreadingMixIn` class defines an attribute +*daemon_threads*, which indicates whether or not the server should wait for +thread termination. You should set the flag explicitly if you would like +threads to behave autonomously; the default is :const:`False`, meaning that +Python will not exit until all threads created by :class:`ThreadingMixIn` have +exited. + +Server classes have the same external methods and attributes, no matter what +network protocol they use. + + +Server Creation Notes +--------------------- + +There are five classes in an inheritance diagram, four of which represent +synchronous servers of four types:: + + +------------+ + | BaseServer | + +------------+ + | + v + +-----------+ +------------------+ + | TCPServer |------->| UnixStreamServer | + +-----------+ +------------------+ + | + v + +-----------+ +--------------------+ + | UDPServer |------->| UnixDatagramServer | + +-----------+ +--------------------+ + +Note that :class:`UnixDatagramServer` derives from :class:`UDPServer`, not from +:class:`UnixStreamServer` --- the only difference between an IP and a Unix +stream server is the address family, which is simply repeated in both Unix +server classes. + + +.. class:: ForkingMixIn + ThreadingMixIn + + Forking and threading versions of each type of server can be created + using these mix-in classes. For instance, :class:`ThreadingUDPServer` + is created as follows:: + + class ThreadingUDPServer(ThreadingMixIn, UDPServer): + pass + + The mix-in class comes first, since it overrides a method defined in + :class:`UDPServer`. Setting the various attributes also changes the + behavior of the underlying server mechanism. + + :class:`ForkingMixIn` and the Forking classes mentioned below are + only available on POSIX platforms that support :func:`~os.fork`. + + :meth:`socketserver.ForkingMixIn.server_close` waits until all child + processes complete, except if + :attr:`socketserver.ForkingMixIn.block_on_close` attribute is false. + + :meth:`socketserver.ThreadingMixIn.server_close` waits until all non-daemon + threads complete, except if + :attr:`socketserver.ThreadingMixIn.block_on_close` attribute is false. Use + daemonic threads by setting + :data:`ThreadingMixIn.daemon_threads` to ``True`` to not wait until threads + complete. + + .. versionchanged:: 3.7 + + :meth:`socketserver.ForkingMixIn.server_close` and + :meth:`socketserver.ThreadingMixIn.server_close` now waits until all + child processes and non-daemonic threads complete. + Add a new :attr:`socketserver.ForkingMixIn.block_on_close` class + attribute to opt-in for the pre-3.7 behaviour. + + +.. class:: ForkingTCPServer + ForkingUDPServer + ThreadingTCPServer + ThreadingUDPServer + + These classes are pre-defined using the mix-in classes. + + +To implement a service, you must derive a class from :class:`BaseRequestHandler` +and redefine its :meth:`~BaseRequestHandler.handle` method. +You can then run various versions of +the service by combining one of the server classes with your request handler +class. The request handler class must be different for datagram or stream +services. This can be hidden by using the handler subclasses +:class:`StreamRequestHandler` or :class:`DatagramRequestHandler`. + +Of course, you still have to use your head! For instance, it makes no sense to +use a forking server if the service contains state in memory that can be +modified by different requests, since the modifications in the child process +would never reach the initial state kept in the parent process and passed to +each child. In this case, you can use a threading server, but you will probably +have to use locks to protect the integrity of the shared data. + +On the other hand, if you are building an HTTP server where all data is stored +externally (for instance, in the file system), a synchronous class will +essentially render the service "deaf" while one request is being handled -- +which may be for a very long time if a client is slow to receive all the data it +has requested. Here a threading or forking server is appropriate. + +In some cases, it may be appropriate to process part of a request synchronously, +but to finish processing in a forked child depending on the request data. This +can be implemented by using a synchronous server and doing an explicit fork in +the request handler class :meth:`~BaseRequestHandler.handle` method. + +Another approach to handling multiple simultaneous requests in an environment +that supports neither threads nor :func:`~os.fork` (or where these are too +expensive or inappropriate for the service) is to maintain an explicit table of +partially finished requests and to use :mod:`selectors` to decide which +request to work on next (or whether to handle a new incoming request). This is +particularly important for stream services where each client can potentially be +connected for a long time (if threads or subprocesses cannot be used). See +:mod:`asyncore` for another way to manage this. + +.. XXX should data and methods be intermingled, or separate? + how should the distinction between class and instance variables be drawn? + + +Server Objects +-------------- + +.. class:: BaseServer(server_address, RequestHandlerClass) + + This is the superclass of all Server objects in the module. It defines the + interface, given below, but does not implement most of the methods, which is + done in subclasses. The two parameters are stored in the respective + :attr:`server_address` and :attr:`RequestHandlerClass` attributes. + + + .. method:: fileno() + + Return an integer file descriptor for the socket on which the server is + listening. This function is most commonly passed to :mod:`selectors`, to + allow monitoring multiple servers in the same process. + + + .. method:: handle_request() + + Process a single request. This function calls the following methods in + order: :meth:`get_request`, :meth:`verify_request`, and + :meth:`process_request`. If the user-provided + :meth:`~BaseRequestHandler.handle` method of the + handler class raises an exception, the server's :meth:`handle_error` method + will be called. If no request is received within :attr:`timeout` + seconds, :meth:`handle_timeout` will be called and :meth:`handle_request` + will return. + + + .. method:: serve_forever(poll_interval=0.5) + + Handle requests until an explicit :meth:`shutdown` request. Poll for + shutdown every *poll_interval* seconds. + Ignores the :attr:`timeout` attribute. It + also calls :meth:`service_actions`, which may be used by a subclass or mixin + to provide actions specific to a given service. For example, the + :class:`ForkingMixIn` class uses :meth:`service_actions` to clean up zombie + child processes. + + .. versionchanged:: 3.3 + Added ``service_actions`` call to the ``serve_forever`` method. + + + .. method:: service_actions() + + This is called in the :meth:`serve_forever` loop. This method can be + overridden by subclasses or mixin classes to perform actions specific to + a given service, such as cleanup actions. + + .. versionadded:: 3.3 + + .. method:: shutdown() + + Tell the :meth:`serve_forever` loop to stop and wait until it does. + + + .. method:: server_close() + + Clean up the server. May be overridden. + + + .. attribute:: address_family + + The family of protocols to which the server's socket belongs. + Common examples are :const:`socket.AF_INET` and :const:`socket.AF_UNIX`. + + + .. attribute:: RequestHandlerClass + + The user-provided request handler class; an instance of this class is created + for each request. + + + .. attribute:: server_address + + The address on which the server is listening. The format of addresses varies + depending on the protocol family; + see the documentation for the :mod:`socket` module + for details. For Internet protocols, this is a tuple containing a string giving + the address, and an integer port number: ``('127.0.0.1', 80)``, for example. + + + .. attribute:: socket + + The socket object on which the server will listen for incoming requests. + + + The server classes support the following class variables: + + .. XXX should class variables be covered before instance variables, or vice versa? + + .. attribute:: allow_reuse_address + + Whether the server will allow the reuse of an address. This defaults to + :const:`False`, and can be set in subclasses to change the policy. + + + .. attribute:: request_queue_size + + The size of the request queue. If it takes a long time to process a single + request, any requests that arrive while the server is busy are placed into a + queue, up to :attr:`request_queue_size` requests. Once the queue is full, + further requests from clients will get a "Connection denied" error. The default + value is usually 5, but this can be overridden by subclasses. + + + .. attribute:: socket_type + + The type of socket used by the server; :const:`socket.SOCK_STREAM` and + :const:`socket.SOCK_DGRAM` are two common values. + + + .. attribute:: timeout + + Timeout duration, measured in seconds, or :const:`None` if no timeout is + desired. If :meth:`handle_request` receives no incoming requests within the + timeout period, the :meth:`handle_timeout` method is called. + + + There are various server methods that can be overridden by subclasses of base + server classes like :class:`TCPServer`; these methods aren't useful to external + users of the server object. + + .. XXX should the default implementations of these be documented, or should + it be assumed that the user will look at socketserver.py? + + .. method:: finish_request(request, client_address) + + Actually processes the request by instantiating :attr:`RequestHandlerClass` and + calling its :meth:`~BaseRequestHandler.handle` method. + + + .. method:: get_request() + + Must accept a request from the socket, and return a 2-tuple containing the *new* + socket object to be used to communicate with the client, and the client's + address. + + + .. method:: handle_error(request, client_address) + + This function is called if the :meth:`~BaseRequestHandler.handle` + method of a :attr:`RequestHandlerClass` instance raises + an exception. The default action is to print the traceback to + standard error and continue handling further requests. + + .. versionchanged:: 3.6 + Now only called for exceptions derived from the :exc:`Exception` + class. + + + .. method:: handle_timeout() + + This function is called when the :attr:`timeout` attribute has been set to a + value other than :const:`None` and the timeout period has passed with no + requests being received. The default action for forking servers is + to collect the status of any child processes that have exited, while + in threading servers this method does nothing. + + + .. method:: process_request(request, client_address) + + Calls :meth:`finish_request` to create an instance of the + :attr:`RequestHandlerClass`. If desired, this function can create a new process + or thread to handle the request; the :class:`ForkingMixIn` and + :class:`ThreadingMixIn` classes do this. + + + .. Is there any point in documenting the following two functions? + What would the purpose of overriding them be: initializing server + instance variables, adding new network families? + + .. method:: server_activate() + + Called by the server's constructor to activate the server. The default behavior + for a TCP server just invokes :meth:`~socket.socket.listen` + on the server's socket. May be overridden. + + + .. method:: server_bind() + + Called by the server's constructor to bind the socket to the desired address. + May be overridden. + + + .. method:: verify_request(request, client_address) + + Must return a Boolean value; if the value is :const:`True`, the request will + be processed, and if it's :const:`False`, the request will be denied. This + function can be overridden to implement access controls for a server. The + default implementation always returns :const:`True`. + + + .. versionchanged:: 3.6 + Support for the :term:`context manager` protocol was added. Exiting the + context manager is equivalent to calling :meth:`server_close`. + + +Request Handler Objects +----------------------- + +.. class:: BaseRequestHandler + + This is the superclass of all request handler objects. It defines + the interface, given below. A concrete request handler subclass must + define a new :meth:`handle` method, and can override any of + the other methods. A new instance of the subclass is created for each + request. + + + .. method:: setup() + + Called before the :meth:`handle` method to perform any initialization actions + required. The default implementation does nothing. + + + .. method:: handle() + + This function must do all the work required to service a request. The + default implementation does nothing. Several instance attributes are + available to it; the request is available as :attr:`self.request`; the client + address as :attr:`self.client_address`; and the server instance as + :attr:`self.server`, in case it needs access to per-server information. + + The type of :attr:`self.request` is different for datagram or stream + services. For stream services, :attr:`self.request` is a socket object; for + datagram services, :attr:`self.request` is a pair of string and socket. + + + .. method:: finish() + + Called after the :meth:`handle` method to perform any clean-up actions + required. The default implementation does nothing. If :meth:`setup` + raises an exception, this function will not be called. + + +.. class:: StreamRequestHandler + DatagramRequestHandler + + These :class:`BaseRequestHandler` subclasses override the + :meth:`~BaseRequestHandler.setup` and :meth:`~BaseRequestHandler.finish` + methods, and provide :attr:`self.rfile` and :attr:`self.wfile` attributes. + The :attr:`self.rfile` and :attr:`self.wfile` attributes can be + read or written, respectively, to get the request data or return data + to the client. + + The :attr:`rfile` attributes of both classes support the + :class:`io.BufferedIOBase` readable interface, and + :attr:`DatagramRequestHandler.wfile` supports the + :class:`io.BufferedIOBase` writable interface. + + .. versionchanged:: 3.6 + :attr:`StreamRequestHandler.wfile` also supports the + :class:`io.BufferedIOBase` writable interface. + + +Examples +-------- + +:class:`socketserver.TCPServer` Example +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This is the server side:: + + import socketserver + + class MyTCPHandler(socketserver.BaseRequestHandler): + """ + The request handler class for our server. + + It is instantiated once per connection to the server, and must + override the handle() method to implement communication to the + client. + """ + + def handle(self): + # self.request is the TCP socket connected to the client + self.data = self.request.recv(1024).strip() + print("{} wrote:".format(self.client_address[0])) + print(self.data) + # just send back the same data, but upper-cased + self.request.sendall(self.data.upper()) + + if __name__ == "__main__": + HOST, PORT = "localhost", 9999 + + # Create the server, binding to localhost on port 9999 + with socketserver.TCPServer((HOST, PORT), MyTCPHandler) as server: + # Activate the server; this will keep running until you + # interrupt the program with Ctrl-C + server.serve_forever() + +An alternative request handler class that makes use of streams (file-like +objects that simplify communication by providing the standard file interface):: + + class MyTCPHandler(socketserver.StreamRequestHandler): + + def handle(self): + # self.rfile is a file-like object created by the handler; + # we can now use e.g. readline() instead of raw recv() calls + self.data = self.rfile.readline().strip() + print("{} wrote:".format(self.client_address[0])) + print(self.data) + # Likewise, self.wfile is a file-like object used to write back + # to the client + self.wfile.write(self.data.upper()) + +The difference is that the ``readline()`` call in the second handler will call +``recv()`` multiple times until it encounters a newline character, while the +single ``recv()`` call in the first handler will just return what has been sent +from the client in one ``sendall()`` call. + + +This is the client side:: + + import socket + import sys + + HOST, PORT = "localhost", 9999 + data = " ".join(sys.argv[1:]) + + # Create a socket (SOCK_STREAM means a TCP socket) + with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock: + # Connect to server and send data + sock.connect((HOST, PORT)) + sock.sendall(bytes(data + "\n", "utf-8")) + + # Receive data from the server and shut down + received = str(sock.recv(1024), "utf-8") + + print("Sent: {}".format(data)) + print("Received: {}".format(received)) + + +The output of the example should look something like this: + +Server: + +.. code-block:: shell-session + + $ python TCPServer.py + 127.0.0.1 wrote: + b'hello world with TCP' + 127.0.0.1 wrote: + b'python is nice' + +Client: + +.. code-block:: shell-session + + $ python TCPClient.py hello world with TCP + Sent: hello world with TCP + Received: HELLO WORLD WITH TCP + $ python TCPClient.py python is nice + Sent: python is nice + Received: PYTHON IS NICE + + +:class:`socketserver.UDPServer` Example +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This is the server side:: + + import socketserver + + class MyUDPHandler(socketserver.BaseRequestHandler): + """ + This class works similar to the TCP handler class, except that + self.request consists of a pair of data and client socket, and since + there is no connection the client address must be given explicitly + when sending data back via sendto(). + """ + + def handle(self): + data = self.request[0].strip() + socket = self.request[1] + print("{} wrote:".format(self.client_address[0])) + print(data) + socket.sendto(data.upper(), self.client_address) + + if __name__ == "__main__": + HOST, PORT = "localhost", 9999 + with socketserver.UDPServer((HOST, PORT), MyUDPHandler) as server: + server.serve_forever() + +This is the client side:: + + import socket + import sys + + HOST, PORT = "localhost", 9999 + data = " ".join(sys.argv[1:]) + + # SOCK_DGRAM is the socket type to use for UDP sockets + sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) + + # As you can see, there is no connect() call; UDP has no connections. + # Instead, data is directly sent to the recipient via sendto(). + sock.sendto(bytes(data + "\n", "utf-8"), (HOST, PORT)) + received = str(sock.recv(1024), "utf-8") + + print("Sent: {}".format(data)) + print("Received: {}".format(received)) + +The output of the example should look exactly like for the TCP server example. + + +Asynchronous Mixins +~~~~~~~~~~~~~~~~~~~ + +To build asynchronous handlers, use the :class:`ThreadingMixIn` and +:class:`ForkingMixIn` classes. + +An example for the :class:`ThreadingMixIn` class:: + + import socket + import threading + import socketserver + + class ThreadedTCPRequestHandler(socketserver.BaseRequestHandler): + + def handle(self): + data = str(self.request.recv(1024), 'ascii') + cur_thread = threading.current_thread() + response = bytes("{}: {}".format(cur_thread.name, data), 'ascii') + self.request.sendall(response) + + class ThreadedTCPServer(socketserver.ThreadingMixIn, socketserver.TCPServer): + pass + + def client(ip, port, message): + with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock: + sock.connect((ip, port)) + sock.sendall(bytes(message, 'ascii')) + response = str(sock.recv(1024), 'ascii') + print("Received: {}".format(response)) + + if __name__ == "__main__": + # Port 0 means to select an arbitrary unused port + HOST, PORT = "localhost", 0 + + server = ThreadedTCPServer((HOST, PORT), ThreadedTCPRequestHandler) + with server: + ip, port = server.server_address + + # Start a thread with the server -- that thread will then start one + # more thread for each request + server_thread = threading.Thread(target=server.serve_forever) + # Exit the server thread when the main thread terminates + server_thread.daemon = True + server_thread.start() + print("Server loop running in thread:", server_thread.name) + + client(ip, port, "Hello World 1") + client(ip, port, "Hello World 2") + client(ip, port, "Hello World 3") + + server.shutdown() + + +The output of the example should look something like this: + +.. code-block:: shell-session + + $ python ThreadedTCPServer.py + Server loop running in thread: Thread-1 + Received: Thread-2: Hello World 1 + Received: Thread-3: Hello World 2 + Received: Thread-4: Hello World 3 + + +The :class:`ForkingMixIn` class is used in the same way, except that the server +will spawn a new process for each request. +Available only on POSIX platforms that support :func:`~os.fork`. + diff --git a/python-3.7.4-docs-html/_sources/library/spwd.rst.txt b/python-3.7.4-docs-html/_sources/library/spwd.rst.txt new file mode 100644 index 0000000..c6cad2a --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/spwd.rst.txt @@ -0,0 +1,75 @@ +:mod:`spwd` --- The shadow password database +============================================ + +.. module:: spwd + :platform: Unix + :synopsis: The shadow password database (getspnam() and friends). + +-------------- + +This module provides access to the Unix shadow password database. It is +available on various Unix versions. + +You must have enough privileges to access the shadow password database (this +usually means you have to be root). + +Shadow password database entries are reported as a tuple-like object, whose +attributes correspond to the members of the ``spwd`` structure (Attribute field +below, see ````): + ++-------+---------------+---------------------------------+ +| Index | Attribute | Meaning | ++=======+===============+=================================+ +| 0 | ``sp_namp`` | Login name | ++-------+---------------+---------------------------------+ +| 1 | ``sp_pwdp`` | Encrypted password | ++-------+---------------+---------------------------------+ +| 2 | ``sp_lstchg`` | Date of last change | ++-------+---------------+---------------------------------+ +| 3 | ``sp_min`` | Minimal number of days between | +| | | changes | ++-------+---------------+---------------------------------+ +| 4 | ``sp_max`` | Maximum number of days between | +| | | changes | ++-------+---------------+---------------------------------+ +| 5 | ``sp_warn`` | Number of days before password | +| | | expires to warn user about it | ++-------+---------------+---------------------------------+ +| 6 | ``sp_inact`` | Number of days after password | +| | | expires until account is | +| | | disabled | ++-------+---------------+---------------------------------+ +| 7 | ``sp_expire`` | Number of days since 1970-01-01 | +| | | when account expires | ++-------+---------------+---------------------------------+ +| 8 | ``sp_flag`` | Reserved | ++-------+---------------+---------------------------------+ + +The sp_namp and sp_pwdp items are strings, all others are integers. +:exc:`KeyError` is raised if the entry asked for cannot be found. + +The following functions are defined: + + +.. function:: getspnam(name) + + Return the shadow password database entry for the given user name. + + .. versionchanged:: 3.6 + Raises a :exc:`PermissionError` instead of :exc:`KeyError` if the user + doesn't have privileges. + +.. function:: getspall() + + Return a list of all available shadow password database entries, in arbitrary + order. + + +.. seealso:: + + Module :mod:`grp` + An interface to the group database, similar to this. + + Module :mod:`pwd` + An interface to the normal password database, similar to this. + diff --git a/python-3.7.4-docs-html/_sources/library/sqlite3.rst.txt b/python-3.7.4-docs-html/_sources/library/sqlite3.rst.txt new file mode 100644 index 0000000..e20b4b3 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/sqlite3.rst.txt @@ -0,0 +1,1103 @@ +:mod:`sqlite3` --- DB-API 2.0 interface for SQLite databases +============================================================ + +.. module:: sqlite3 + :synopsis: A DB-API 2.0 implementation using SQLite 3.x. + +.. sectionauthor:: Gerhard Häring + +**Source code:** :source:`Lib/sqlite3/` + +-------------- + +SQLite is a C library that provides a lightweight disk-based database that +doesn't require a separate server process and allows accessing the database +using a nonstandard variant of the SQL query language. Some applications can use +SQLite for internal data storage. It's also possible to prototype an +application using SQLite and then port the code to a larger database such as +PostgreSQL or Oracle. + +The sqlite3 module was written by Gerhard Häring. It provides a SQL interface +compliant with the DB-API 2.0 specification described by :pep:`249`. + +To use the module, you must first create a :class:`Connection` object that +represents the database. Here the data will be stored in the +:file:`example.db` file:: + + import sqlite3 + conn = sqlite3.connect('example.db') + +You can also supply the special name ``:memory:`` to create a database in RAM. + +Once you have a :class:`Connection`, you can create a :class:`Cursor` object +and call its :meth:`~Cursor.execute` method to perform SQL commands:: + + c = conn.cursor() + + # Create table + c.execute('''CREATE TABLE stocks + (date text, trans text, symbol text, qty real, price real)''') + + # Insert a row of data + c.execute("INSERT INTO stocks VALUES ('2006-01-05','BUY','RHAT',100,35.14)") + + # Save (commit) the changes + conn.commit() + + # We can also close the connection if we are done with it. + # Just be sure any changes have been committed or they will be lost. + conn.close() + +The data you've saved is persistent and is available in subsequent sessions:: + + import sqlite3 + conn = sqlite3.connect('example.db') + c = conn.cursor() + +Usually your SQL operations will need to use values from Python variables. You +shouldn't assemble your query using Python's string operations because doing so +is insecure; it makes your program vulnerable to an SQL injection attack +(see https://xkcd.com/327/ for humorous example of what can go wrong). + +Instead, use the DB-API's parameter substitution. Put ``?`` as a placeholder +wherever you want to use a value, and then provide a tuple of values as the +second argument to the cursor's :meth:`~Cursor.execute` method. (Other database +modules may use a different placeholder, such as ``%s`` or ``:1``.) For +example:: + + # Never do this -- insecure! + symbol = 'RHAT' + c.execute("SELECT * FROM stocks WHERE symbol = '%s'" % symbol) + + # Do this instead + t = ('RHAT',) + c.execute('SELECT * FROM stocks WHERE symbol=?', t) + print(c.fetchone()) + + # Larger example that inserts many records at a time + purchases = [('2006-03-28', 'BUY', 'IBM', 1000, 45.00), + ('2006-04-05', 'BUY', 'MSFT', 1000, 72.00), + ('2006-04-06', 'SELL', 'IBM', 500, 53.00), + ] + c.executemany('INSERT INTO stocks VALUES (?,?,?,?,?)', purchases) + +To retrieve data after executing a SELECT statement, you can either treat the +cursor as an :term:`iterator`, call the cursor's :meth:`~Cursor.fetchone` method to +retrieve a single matching row, or call :meth:`~Cursor.fetchall` to get a list of the +matching rows. + +This example uses the iterator form:: + + >>> for row in c.execute('SELECT * FROM stocks ORDER BY price'): + print(row) + + ('2006-01-05', 'BUY', 'RHAT', 100, 35.14) + ('2006-03-28', 'BUY', 'IBM', 1000, 45.0) + ('2006-04-06', 'SELL', 'IBM', 500, 53.0) + ('2006-04-05', 'BUY', 'MSFT', 1000, 72.0) + + +.. seealso:: + + https://github.com/ghaering/pysqlite + The pysqlite web page -- sqlite3 is developed externally under the name + "pysqlite". + + https://www.sqlite.org + The SQLite web page; the documentation describes the syntax and the + available data types for the supported SQL dialect. + + https://www.w3schools.com/sql/ + Tutorial, reference and examples for learning SQL syntax. + + :pep:`249` - Database API Specification 2.0 + PEP written by Marc-André Lemburg. + + +.. _sqlite3-module-contents: + +Module functions and constants +------------------------------ + + +.. data:: version + + The version number of this module, as a string. This is not the version of + the SQLite library. + + +.. data:: version_info + + The version number of this module, as a tuple of integers. This is not the + version of the SQLite library. + + +.. data:: sqlite_version + + The version number of the run-time SQLite library, as a string. + + +.. data:: sqlite_version_info + + The version number of the run-time SQLite library, as a tuple of integers. + + +.. data:: PARSE_DECLTYPES + + This constant is meant to be used with the *detect_types* parameter of the + :func:`connect` function. + + Setting it makes the :mod:`sqlite3` module parse the declared type for each + column it returns. It will parse out the first word of the declared type, + i. e. for "integer primary key", it will parse out "integer", or for + "number(10)" it will parse out "number". Then for that column, it will look + into the converters dictionary and use the converter function registered for + that type there. + + +.. data:: PARSE_COLNAMES + + This constant is meant to be used with the *detect_types* parameter of the + :func:`connect` function. + + Setting this makes the SQLite interface parse the column name for each column it + returns. It will look for a string formed [mytype] in there, and then decide + that 'mytype' is the type of the column. It will try to find an entry of + 'mytype' in the converters dictionary and then use the converter function found + there to return the value. The column name found in :attr:`Cursor.description` + is only the first word of the column name, i. e. if you use something like + ``'as "x [datetime]"'`` in your SQL, then we will parse out everything until the + first blank for the column name: the column name would simply be "x". + + +.. function:: connect(database[, timeout, detect_types, isolation_level, check_same_thread, factory, cached_statements, uri]) + + Opens a connection to the SQLite database file *database*. By default returns a + :class:`Connection` object, unless a custom *factory* is given. + + *database* is a :term:`path-like object` giving the pathname (absolute or + relative to the current working directory) of the database file to be opened. + You can use ``":memory:"`` to open a database connection to a database that + resides in RAM instead of on disk. + + When a database is accessed by multiple connections, and one of the processes + modifies the database, the SQLite database is locked until that transaction is + committed. The *timeout* parameter specifies how long the connection should wait + for the lock to go away until raising an exception. The default for the timeout + parameter is 5.0 (five seconds). + + For the *isolation_level* parameter, please see the + :attr:`~Connection.isolation_level` property of :class:`Connection` objects. + + SQLite natively supports only the types TEXT, INTEGER, REAL, BLOB and NULL. If + you want to use other types you must add support for them yourself. The + *detect_types* parameter and the using custom **converters** registered with the + module-level :func:`register_converter` function allow you to easily do that. + + *detect_types* defaults to 0 (i. e. off, no type detection), you can set it to + any combination of :const:`PARSE_DECLTYPES` and :const:`PARSE_COLNAMES` to turn + type detection on. + + By default, *check_same_thread* is :const:`True` and only the creating thread may + use the connection. If set :const:`False`, the returned connection may be shared + across multiple threads. When using multiple threads with the same connection + writing operations should be serialized by the user to avoid data corruption. + + By default, the :mod:`sqlite3` module uses its :class:`Connection` class for the + connect call. You can, however, subclass the :class:`Connection` class and make + :func:`connect` use your class instead by providing your class for the *factory* + parameter. + + Consult the section :ref:`sqlite3-types` of this manual for details. + + The :mod:`sqlite3` module internally uses a statement cache to avoid SQL parsing + overhead. If you want to explicitly set the number of statements that are cached + for the connection, you can set the *cached_statements* parameter. The currently + implemented default is to cache 100 statements. + + If *uri* is true, *database* is interpreted as a URI. This allows you + to specify options. For example, to open a database in read-only mode + you can use:: + + db = sqlite3.connect('file:path/to/database?mode=ro', uri=True) + + More information about this feature, including a list of recognized options, can + be found in the `SQLite URI documentation `_. + + .. versionchanged:: 3.4 + Added the *uri* parameter. + + .. versionchanged:: 3.7 + *database* can now also be a :term:`path-like object`, not only a string. + + +.. function:: register_converter(typename, callable) + + Registers a callable to convert a bytestring from the database into a custom + Python type. The callable will be invoked for all database values that are of + the type *typename*. Confer the parameter *detect_types* of the :func:`connect` + function for how the type detection works. Note that *typename* and the name of + the type in your query are matched in case-insensitive manner. + + +.. function:: register_adapter(type, callable) + + Registers a callable to convert the custom Python type *type* into one of + SQLite's supported types. The callable *callable* accepts as single parameter + the Python value, and must return a value of the following types: int, + float, str or bytes. + + +.. function:: complete_statement(sql) + + Returns :const:`True` if the string *sql* contains one or more complete SQL + statements terminated by semicolons. It does not verify that the SQL is + syntactically correct, only that there are no unclosed string literals and the + statement is terminated by a semicolon. + + This can be used to build a shell for SQLite, as in the following example: + + + .. literalinclude:: ../includes/sqlite3/complete_statement.py + + +.. function:: enable_callback_tracebacks(flag) + + By default you will not get any tracebacks in user-defined functions, + aggregates, converters, authorizer callbacks etc. If you want to debug them, + you can call this function with *flag* set to ``True``. Afterwards, you will + get tracebacks from callbacks on ``sys.stderr``. Use :const:`False` to + disable the feature again. + + +.. _sqlite3-connection-objects: + +Connection Objects +------------------ + +.. class:: Connection + + A SQLite database connection has the following attributes and methods: + + .. attribute:: isolation_level + + Get or set the current default isolation level. :const:`None` for autocommit mode or + one of "DEFERRED", "IMMEDIATE" or "EXCLUSIVE". See section + :ref:`sqlite3-controlling-transactions` for a more detailed explanation. + + .. attribute:: in_transaction + + :const:`True` if a transaction is active (there are uncommitted changes), + :const:`False` otherwise. Read-only attribute. + + .. versionadded:: 3.2 + + .. method:: cursor(factory=Cursor) + + The cursor method accepts a single optional parameter *factory*. If + supplied, this must be a callable returning an instance of :class:`Cursor` + or its subclasses. + + .. method:: commit() + + This method commits the current transaction. If you don't call this method, + anything you did since the last call to ``commit()`` is not visible from + other database connections. If you wonder why you don't see the data you've + written to the database, please check you didn't forget to call this method. + + .. method:: rollback() + + This method rolls back any changes to the database since the last call to + :meth:`commit`. + + .. method:: close() + + This closes the database connection. Note that this does not automatically + call :meth:`commit`. If you just close your database connection without + calling :meth:`commit` first, your changes will be lost! + + .. method:: execute(sql[, parameters]) + + This is a nonstandard shortcut that creates a cursor object by calling + the :meth:`~Connection.cursor` method, calls the cursor's + :meth:`~Cursor.execute` method with the *parameters* given, and returns + the cursor. + + .. method:: executemany(sql[, parameters]) + + This is a nonstandard shortcut that creates a cursor object by + calling the :meth:`~Connection.cursor` method, calls the cursor's + :meth:`~Cursor.executemany` method with the *parameters* given, and + returns the cursor. + + .. method:: executescript(sql_script) + + This is a nonstandard shortcut that creates a cursor object by + calling the :meth:`~Connection.cursor` method, calls the cursor's + :meth:`~Cursor.executescript` method with the given *sql_script*, and + returns the cursor. + + .. method:: create_function(name, num_params, func) + + Creates a user-defined function that you can later use from within SQL + statements under the function name *name*. *num_params* is the number of + parameters the function accepts (if *num_params* is -1, the function may + take any number of arguments), and *func* is a Python callable that is + called as the SQL function. + + The function can return any of the types supported by SQLite: bytes, str, int, + float and ``None``. + + Example: + + .. literalinclude:: ../includes/sqlite3/md5func.py + + + .. method:: create_aggregate(name, num_params, aggregate_class) + + Creates a user-defined aggregate function. + + The aggregate class must implement a ``step`` method, which accepts the number + of parameters *num_params* (if *num_params* is -1, the function may take + any number of arguments), and a ``finalize`` method which will return the + final result of the aggregate. + + The ``finalize`` method can return any of the types supported by SQLite: + bytes, str, int, float and ``None``. + + Example: + + .. literalinclude:: ../includes/sqlite3/mysumaggr.py + + + .. method:: create_collation(name, callable) + + Creates a collation with the specified *name* and *callable*. The callable will + be passed two string arguments. It should return -1 if the first is ordered + lower than the second, 0 if they are ordered equal and 1 if the first is ordered + higher than the second. Note that this controls sorting (ORDER BY in SQL) so + your comparisons don't affect other SQL operations. + + Note that the callable will get its parameters as Python bytestrings, which will + normally be encoded in UTF-8. + + The following example shows a custom collation that sorts "the wrong way": + + .. literalinclude:: ../includes/sqlite3/collation_reverse.py + + To remove a collation, call ``create_collation`` with ``None`` as callable:: + + con.create_collation("reverse", None) + + + .. method:: interrupt() + + You can call this method from a different thread to abort any queries that might + be executing on the connection. The query will then abort and the caller will + get an exception. + + + .. method:: set_authorizer(authorizer_callback) + + This routine registers a callback. The callback is invoked for each attempt to + access a column of a table in the database. The callback should return + :const:`SQLITE_OK` if access is allowed, :const:`SQLITE_DENY` if the entire SQL + statement should be aborted with an error and :const:`SQLITE_IGNORE` if the + column should be treated as a NULL value. These constants are available in the + :mod:`sqlite3` module. + + The first argument to the callback signifies what kind of operation is to be + authorized. The second and third argument will be arguments or :const:`None` + depending on the first argument. The 4th argument is the name of the database + ("main", "temp", etc.) if applicable. The 5th argument is the name of the + inner-most trigger or view that is responsible for the access attempt or + :const:`None` if this access attempt is directly from input SQL code. + + Please consult the SQLite documentation about the possible values for the first + argument and the meaning of the second and third argument depending on the first + one. All necessary constants are available in the :mod:`sqlite3` module. + + + .. method:: set_progress_handler(handler, n) + + This routine registers a callback. The callback is invoked for every *n* + instructions of the SQLite virtual machine. This is useful if you want to + get called from SQLite during long-running operations, for example to update + a GUI. + + If you want to clear any previously installed progress handler, call the + method with :const:`None` for *handler*. + + Returning a non-zero value from the handler function will terminate the + currently executing query and cause it to raise an :exc:`OperationalError` + exception. + + + .. method:: set_trace_callback(trace_callback) + + Registers *trace_callback* to be called for each SQL statement that is + actually executed by the SQLite backend. + + The only argument passed to the callback is the statement (as string) that + is being executed. The return value of the callback is ignored. Note that + the backend does not only run statements passed to the :meth:`Cursor.execute` + methods. Other sources include the transaction management of the Python + module and the execution of triggers defined in the current database. + + Passing :const:`None` as *trace_callback* will disable the trace callback. + + .. versionadded:: 3.3 + + + .. method:: enable_load_extension(enabled) + + This routine allows/disallows the SQLite engine to load SQLite extensions + from shared libraries. SQLite extensions can define new functions, + aggregates or whole new virtual table implementations. One well-known + extension is the fulltext-search extension distributed with SQLite. + + Loadable extensions are disabled by default. See [#f1]_. + + .. versionadded:: 3.2 + + .. literalinclude:: ../includes/sqlite3/load_extension.py + + .. method:: load_extension(path) + + This routine loads a SQLite extension from a shared library. You have to + enable extension loading with :meth:`enable_load_extension` before you can + use this routine. + + Loadable extensions are disabled by default. See [#f1]_. + + .. versionadded:: 3.2 + + .. attribute:: row_factory + + You can change this attribute to a callable that accepts the cursor and the + original row as a tuple and will return the real result row. This way, you can + implement more advanced ways of returning results, such as returning an object + that can also access columns by name. + + Example: + + .. literalinclude:: ../includes/sqlite3/row_factory.py + + If returning a tuple doesn't suffice and you want name-based access to + columns, you should consider setting :attr:`row_factory` to the + highly-optimized :class:`sqlite3.Row` type. :class:`Row` provides both + index-based and case-insensitive name-based access to columns with almost no + memory overhead. It will probably be better than your own custom + dictionary-based approach or even a db_row based solution. + + .. XXX what's a db_row-based solution? + + + .. attribute:: text_factory + + Using this attribute you can control what objects are returned for the ``TEXT`` + data type. By default, this attribute is set to :class:`str` and the + :mod:`sqlite3` module will return Unicode objects for ``TEXT``. If you want to + return bytestrings instead, you can set it to :class:`bytes`. + + You can also set it to any other callable that accepts a single bytestring + parameter and returns the resulting object. + + See the following example code for illustration: + + .. literalinclude:: ../includes/sqlite3/text_factory.py + + + .. attribute:: total_changes + + Returns the total number of database rows that have been modified, inserted, or + deleted since the database connection was opened. + + + .. method:: iterdump + + Returns an iterator to dump the database in an SQL text format. Useful when + saving an in-memory database for later restoration. This function provides + the same capabilities as the :kbd:`.dump` command in the :program:`sqlite3` + shell. + + Example:: + + # Convert file existing_db.db to SQL dump file dump.sql + import sqlite3 + + con = sqlite3.connect('existing_db.db') + with open('dump.sql', 'w') as f: + for line in con.iterdump(): + f.write('%s\n' % line) + con.close() + + + .. method:: backup(target, *, pages=0, progress=None, name="main", sleep=0.250) + + This method makes a backup of a SQLite database even while it's being accessed + by other clients, or concurrently by the same connection. The copy will be + written into the mandatory argument *target*, that must be another + :class:`Connection` instance. + + By default, or when *pages* is either ``0`` or a negative integer, the entire + database is copied in a single step; otherwise the method performs a loop + copying up to *pages* pages at a time. + + If *progress* is specified, it must either be ``None`` or a callable object that + will be executed at each iteration with three integer arguments, respectively + the *status* of the last iteration, the *remaining* number of pages still to be + copied and the *total* number of pages. + + The *name* argument specifies the database name that will be copied: it must be + a string containing either ``"main"``, the default, to indicate the main + database, ``"temp"`` to indicate the temporary database or the name specified + after the ``AS`` keyword in an ``ATTACH DATABASE`` statement for an attached + database. + + The *sleep* argument specifies the number of seconds to sleep by between + successive attempts to backup remaining pages, can be specified either as an + integer or a floating point value. + + Example 1, copy an existing database into another:: + + import sqlite3 + + def progress(status, remaining, total): + print(f'Copied {total-remaining} of {total} pages...') + + con = sqlite3.connect('existing_db.db') + bck = sqlite3.connect('backup.db') + with bck: + con.backup(bck, pages=1, progress=progress) + bck.close() + con.close() + + Example 2, copy an existing database into a transient copy:: + + import sqlite3 + + source = sqlite3.connect('existing_db.db') + dest = sqlite3.connect(':memory:') + source.backup(dest) + + Availability: SQLite 3.6.11 or higher + + .. versionadded:: 3.7 + + +.. _sqlite3-cursor-objects: + +Cursor Objects +-------------- + +.. class:: Cursor + + A :class:`Cursor` instance has the following attributes and methods. + + .. index:: single: ? (question mark); in SQL statements + .. index:: single: : (colon); in SQL statements + + .. method:: execute(sql[, parameters]) + + Executes an SQL statement. The SQL statement may be parameterized (i. e. + placeholders instead of SQL literals). The :mod:`sqlite3` module supports two + kinds of placeholders: question marks (qmark style) and named placeholders + (named style). + + Here's an example of both styles: + + .. literalinclude:: ../includes/sqlite3/execute_1.py + + :meth:`execute` will only execute a single SQL statement. If you try to execute + more than one statement with it, it will raise a :exc:`.Warning`. Use + :meth:`executescript` if you want to execute multiple SQL statements with one + call. + + + .. method:: executemany(sql, seq_of_parameters) + + Executes an SQL command against all parameter sequences or mappings found in + the sequence *seq_of_parameters*. The :mod:`sqlite3` module also allows + using an :term:`iterator` yielding parameters instead of a sequence. + + .. literalinclude:: ../includes/sqlite3/executemany_1.py + + Here's a shorter example using a :term:`generator`: + + .. literalinclude:: ../includes/sqlite3/executemany_2.py + + + .. method:: executescript(sql_script) + + This is a nonstandard convenience method for executing multiple SQL statements + at once. It issues a ``COMMIT`` statement first, then executes the SQL script it + gets as a parameter. + + *sql_script* can be an instance of :class:`str`. + + Example: + + .. literalinclude:: ../includes/sqlite3/executescript.py + + + .. method:: fetchone() + + Fetches the next row of a query result set, returning a single sequence, + or :const:`None` when no more data is available. + + + .. method:: fetchmany(size=cursor.arraysize) + + Fetches the next set of rows of a query result, returning a list. An empty + list is returned when no more rows are available. + + The number of rows to fetch per call is specified by the *size* parameter. + If it is not given, the cursor's arraysize determines the number of rows + to be fetched. The method should try to fetch as many rows as indicated by + the size parameter. If this is not possible due to the specified number of + rows not being available, fewer rows may be returned. + + Note there are performance considerations involved with the *size* parameter. + For optimal performance, it is usually best to use the arraysize attribute. + If the *size* parameter is used, then it is best for it to retain the same + value from one :meth:`fetchmany` call to the next. + + .. method:: fetchall() + + Fetches all (remaining) rows of a query result, returning a list. Note that + the cursor's arraysize attribute can affect the performance of this operation. + An empty list is returned when no rows are available. + + .. method:: close() + + Close the cursor now (rather than whenever ``__del__`` is called). + + The cursor will be unusable from this point forward; a :exc:`ProgrammingError` + exception will be raised if any operation is attempted with the cursor. + + .. attribute:: rowcount + + Although the :class:`Cursor` class of the :mod:`sqlite3` module implements this + attribute, the database engine's own support for the determination of "rows + affected"/"rows selected" is quirky. + + For :meth:`executemany` statements, the number of modifications are summed up + into :attr:`rowcount`. + + As required by the Python DB API Spec, the :attr:`rowcount` attribute "is -1 in + case no ``executeXX()`` has been performed on the cursor or the rowcount of the + last operation is not determinable by the interface". This includes ``SELECT`` + statements because we cannot determine the number of rows a query produced + until all rows were fetched. + + With SQLite versions before 3.6.5, :attr:`rowcount` is set to 0 if + you make a ``DELETE FROM table`` without any condition. + + .. attribute:: lastrowid + + This read-only attribute provides the rowid of the last modified row. It is + only set if you issued an ``INSERT`` or a ``REPLACE`` statement using the + :meth:`execute` method. For operations other than ``INSERT`` or + ``REPLACE`` or when :meth:`executemany` is called, :attr:`lastrowid` is + set to :const:`None`. + + If the ``INSERT`` or ``REPLACE`` statement failed to insert the previous + successful rowid is returned. + + .. versionchanged:: 3.6 + Added support for the ``REPLACE`` statement. + + .. attribute:: arraysize + + Read/write attribute that controls the number of rows returned by :meth:`fetchmany`. + The default value is 1 which means a single row would be fetched per call. + + .. attribute:: description + + This read-only attribute provides the column names of the last query. To + remain compatible with the Python DB API, it returns a 7-tuple for each + column where the last six items of each tuple are :const:`None`. + + It is set for ``SELECT`` statements without any matching rows as well. + + .. attribute:: connection + + This read-only attribute provides the SQLite database :class:`Connection` + used by the :class:`Cursor` object. A :class:`Cursor` object created by + calling :meth:`con.cursor() ` will have a + :attr:`connection` attribute that refers to *con*:: + + >>> con = sqlite3.connect(":memory:") + >>> cur = con.cursor() + >>> cur.connection == con + True + +.. _sqlite3-row-objects: + +Row Objects +----------- + +.. class:: Row + + A :class:`Row` instance serves as a highly optimized + :attr:`~Connection.row_factory` for :class:`Connection` objects. + It tries to mimic a tuple in most of its features. + + It supports mapping access by column name and index, iteration, + representation, equality testing and :func:`len`. + + If two :class:`Row` objects have exactly the same columns and their + members are equal, they compare equal. + + .. method:: keys + + This method returns a list of column names. Immediately after a query, + it is the first member of each tuple in :attr:`Cursor.description`. + + .. versionchanged:: 3.5 + Added support of slicing. + +Let's assume we initialize a table as in the example given above:: + + conn = sqlite3.connect(":memory:") + c = conn.cursor() + c.execute('''create table stocks + (date text, trans text, symbol text, + qty real, price real)''') + c.execute("""insert into stocks + values ('2006-01-05','BUY','RHAT',100,35.14)""") + conn.commit() + c.close() + +Now we plug :class:`Row` in:: + + >>> conn.row_factory = sqlite3.Row + >>> c = conn.cursor() + >>> c.execute('select * from stocks') + + >>> r = c.fetchone() + >>> type(r) + + >>> tuple(r) + ('2006-01-05', 'BUY', 'RHAT', 100.0, 35.14) + >>> len(r) + 5 + >>> r[2] + 'RHAT' + >>> r.keys() + ['date', 'trans', 'symbol', 'qty', 'price'] + >>> r['qty'] + 100.0 + >>> for member in r: + ... print(member) + ... + 2006-01-05 + BUY + RHAT + 100.0 + 35.14 + + +.. _sqlite3-exceptions: + +Exceptions +---------- + +.. exception:: Warning + + A subclass of :exc:`Exception`. + +.. exception:: Error + + The base class of the other exceptions in this module. It is a subclass + of :exc:`Exception`. + +.. exception:: DatabaseError + + Exception raised for errors that are related to the database. + +.. exception:: IntegrityError + + Exception raised when the relational integrity of the database is affected, + e.g. a foreign key check fails. It is a subclass of :exc:`DatabaseError`. + +.. exception:: ProgrammingError + + Exception raised for programming errors, e.g. table not found or already + exists, syntax error in the SQL statement, wrong number of parameters + specified, etc. It is a subclass of :exc:`DatabaseError`. + +.. exception:: OperationalError + + Exception raised for errors that are related to the database's operation + and not necessarily under the control of the programmer, e.g. an unexpected + disconnect occurs, the data source name is not found, a transaction could + not be processed, etc. It is a subclass of :exc:`DatabaseError`. + +.. exception:: NotSupportedError + + Exception raised in case a method or database API was used which is not + supported by the database, e.g. calling the :meth:`~Connection.rollback` + method on a connection that does not support transaction or has + transactions turned off. It is a subclass of :exc:`DatabaseError`. + + +.. _sqlite3-types: + +SQLite and Python types +----------------------- + + +Introduction +^^^^^^^^^^^^ + +SQLite natively supports the following types: ``NULL``, ``INTEGER``, +``REAL``, ``TEXT``, ``BLOB``. + +The following Python types can thus be sent to SQLite without any problem: + ++-------------------------------+-------------+ +| Python type | SQLite type | ++===============================+=============+ +| :const:`None` | ``NULL`` | ++-------------------------------+-------------+ +| :class:`int` | ``INTEGER`` | ++-------------------------------+-------------+ +| :class:`float` | ``REAL`` | ++-------------------------------+-------------+ +| :class:`str` | ``TEXT`` | ++-------------------------------+-------------+ +| :class:`bytes` | ``BLOB`` | ++-------------------------------+-------------+ + + +This is how SQLite types are converted to Python types by default: + ++-------------+----------------------------------------------+ +| SQLite type | Python type | ++=============+==============================================+ +| ``NULL`` | :const:`None` | ++-------------+----------------------------------------------+ +| ``INTEGER`` | :class:`int` | ++-------------+----------------------------------------------+ +| ``REAL`` | :class:`float` | ++-------------+----------------------------------------------+ +| ``TEXT`` | depends on :attr:`~Connection.text_factory`, | +| | :class:`str` by default | ++-------------+----------------------------------------------+ +| ``BLOB`` | :class:`bytes` | ++-------------+----------------------------------------------+ + +The type system of the :mod:`sqlite3` module is extensible in two ways: you can +store additional Python types in a SQLite database via object adaptation, and +you can let the :mod:`sqlite3` module convert SQLite types to different Python +types via converters. + + +Using adapters to store additional Python types in SQLite databases +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +As described before, SQLite supports only a limited set of types natively. To +use other Python types with SQLite, you must **adapt** them to one of the +sqlite3 module's supported types for SQLite: one of NoneType, int, float, +str, bytes. + +There are two ways to enable the :mod:`sqlite3` module to adapt a custom Python +type to one of the supported ones. + + +Letting your object adapt itself +"""""""""""""""""""""""""""""""" + +This is a good approach if you write the class yourself. Let's suppose you have +a class like this:: + + class Point: + def __init__(self, x, y): + self.x, self.y = x, y + +Now you want to store the point in a single SQLite column. First you'll have to +choose one of the supported types first to be used for representing the point. +Let's just use str and separate the coordinates using a semicolon. Then you need +to give your class a method ``__conform__(self, protocol)`` which must return +the converted value. The parameter *protocol* will be :class:`PrepareProtocol`. + +.. literalinclude:: ../includes/sqlite3/adapter_point_1.py + + +Registering an adapter callable +""""""""""""""""""""""""""""""" + +The other possibility is to create a function that converts the type to the +string representation and register the function with :meth:`register_adapter`. + +.. literalinclude:: ../includes/sqlite3/adapter_point_2.py + +The :mod:`sqlite3` module has two default adapters for Python's built-in +:class:`datetime.date` and :class:`datetime.datetime` types. Now let's suppose +we want to store :class:`datetime.datetime` objects not in ISO representation, +but as a Unix timestamp. + +.. literalinclude:: ../includes/sqlite3/adapter_datetime.py + + +Converting SQLite values to custom Python types +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Writing an adapter lets you send custom Python types to SQLite. But to make it +really useful we need to make the Python to SQLite to Python roundtrip work. + +Enter converters. + +Let's go back to the :class:`Point` class. We stored the x and y coordinates +separated via semicolons as strings in SQLite. + +First, we'll define a converter function that accepts the string as a parameter +and constructs a :class:`Point` object from it. + +.. note:: + + Converter functions **always** get called with a :class:`bytes` object, no + matter under which data type you sent the value to SQLite. + +:: + + def convert_point(s): + x, y = map(float, s.split(b";")) + return Point(x, y) + +Now you need to make the :mod:`sqlite3` module know that what you select from +the database is actually a point. There are two ways of doing this: + +* Implicitly via the declared type + +* Explicitly via the column name + +Both ways are described in section :ref:`sqlite3-module-contents`, in the entries +for the constants :const:`PARSE_DECLTYPES` and :const:`PARSE_COLNAMES`. + +The following example illustrates both approaches. + +.. literalinclude:: ../includes/sqlite3/converter_point.py + + +Default adapters and converters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +There are default adapters for the date and datetime types in the datetime +module. They will be sent as ISO dates/ISO timestamps to SQLite. + +The default converters are registered under the name "date" for +:class:`datetime.date` and under the name "timestamp" for +:class:`datetime.datetime`. + +This way, you can use date/timestamps from Python without any additional +fiddling in most cases. The format of the adapters is also compatible with the +experimental SQLite date/time functions. + +The following example demonstrates this. + +.. literalinclude:: ../includes/sqlite3/pysqlite_datetime.py + +If a timestamp stored in SQLite has a fractional part longer than 6 +numbers, its value will be truncated to microsecond precision by the +timestamp converter. + + +.. _sqlite3-controlling-transactions: + +Controlling Transactions +------------------------ + +The underlying ``sqlite3`` library operates in ``autocommit`` mode by default, +but the Python :mod:`sqlite3` module by default does not. + +``autocommit`` mode means that statements that modify the database take effect +immediately. A ``BEGIN`` or ``SAVEPOINT`` statement disables ``autocommit`` +mode, and a ``COMMIT``, a ``ROLLBACK``, or a ``RELEASE`` that ends the +outermost transaction, turns ``autocommit`` mode back on. + +The Python :mod:`sqlite3` module by default issues a ``BEGIN`` statement +implicitly before a Data Modification Language (DML) statement (i.e. +``INSERT``/``UPDATE``/``DELETE``/``REPLACE``). + +You can control which kind of ``BEGIN`` statements :mod:`sqlite3` implicitly +executes via the *isolation_level* parameter to the :func:`connect` +call, or via the :attr:`isolation_level` property of connections. +If you specify no *isolation_level*, a plain ``BEGIN`` is used, which is +equivalent to specifying ``DEFERRED``. Other possible values are ``IMMEDIATE`` +and ``EXCLUSIVE``. + +You can disable the :mod:`sqlite3` module's implicit transaction management by +setting :attr:`isolation_level` to ``None``. This will leave the underlying +``sqlite3`` library operating in ``autocommit`` mode. You can then completely +control the transaction state by explicitly issuing ``BEGIN``, ``ROLLBACK``, +``SAVEPOINT``, and ``RELEASE`` statements in your code. + +.. versionchanged:: 3.6 + :mod:`sqlite3` used to implicitly commit an open transaction before DDL + statements. This is no longer the case. + + +Using :mod:`sqlite3` efficiently +-------------------------------- + + +Using shortcut methods +^^^^^^^^^^^^^^^^^^^^^^ + +Using the nonstandard :meth:`execute`, :meth:`executemany` and +:meth:`executescript` methods of the :class:`Connection` object, your code can +be written more concisely because you don't have to create the (often +superfluous) :class:`Cursor` objects explicitly. Instead, the :class:`Cursor` +objects are created implicitly and these shortcut methods return the cursor +objects. This way, you can execute a ``SELECT`` statement and iterate over it +directly using only a single call on the :class:`Connection` object. + +.. literalinclude:: ../includes/sqlite3/shortcut_methods.py + + +Accessing columns by name instead of by index +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +One useful feature of the :mod:`sqlite3` module is the built-in +:class:`sqlite3.Row` class designed to be used as a row factory. + +Rows wrapped with this class can be accessed both by index (like tuples) and +case-insensitively by name: + +.. literalinclude:: ../includes/sqlite3/rowclass.py + + +Using the connection as a context manager +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Connection objects can be used as context managers +that automatically commit or rollback transactions. In the event of an +exception, the transaction is rolled back; otherwise, the transaction is +committed: + +.. literalinclude:: ../includes/sqlite3/ctx_manager.py + + +Common issues +------------- + +Multithreading +^^^^^^^^^^^^^^ + +Older SQLite versions had issues with sharing connections between threads. +That's why the Python module disallows sharing connections and cursors between +threads. If you still try to do so, you will get an exception at runtime. + +The only exception is calling the :meth:`~Connection.interrupt` method, which +only makes sense to call from a different thread. + +.. rubric:: Footnotes + +.. [#f1] The sqlite3 module is not built with loadable extension support by + default, because some platforms (notably Mac OS X) have SQLite + libraries which are compiled without this feature. To get loadable + extension support, you must pass --enable-loadable-sqlite-extensions to + configure. diff --git a/python-3.7.4-docs-html/_sources/library/ssl.rst.txt b/python-3.7.4-docs-html/_sources/library/ssl.rst.txt new file mode 100644 index 0000000..1133ebf --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/ssl.rst.txt @@ -0,0 +1,2724 @@ +:mod:`ssl` --- TLS/SSL wrapper for socket objects +================================================= + +.. module:: ssl + :synopsis: TLS/SSL wrapper for socket objects + +.. moduleauthor:: Bill Janssen +.. sectionauthor:: Bill Janssen + +**Source code:** :source:`Lib/ssl.py` + +.. index:: single: OpenSSL; (use in module ssl) + +.. index:: TLS, SSL, Transport Layer Security, Secure Sockets Layer + +-------------- + +This module provides access to Transport Layer Security (often known as "Secure +Sockets Layer") encryption and peer authentication facilities for network +sockets, both client-side and server-side. This module uses the OpenSSL +library. It is available on all modern Unix systems, Windows, Mac OS X, and +probably additional platforms, as long as OpenSSL is installed on that platform. + +.. note:: + + Some behavior may be platform dependent, since calls are made to the + operating system socket APIs. The installed version of OpenSSL may also + cause variations in behavior. For example, TLSv1.1 and TLSv1.2 come with + openssl version 1.0.1. + +.. warning:: + Don't use this module without reading the :ref:`ssl-security`. Doing so + may lead to a false sense of security, as the default settings of the + ssl module are not necessarily appropriate for your application. + + +This section documents the objects and functions in the ``ssl`` module; for more +general information about TLS, SSL, and certificates, the reader is referred to +the documents in the "See Also" section at the bottom. + +This module provides a class, :class:`ssl.SSLSocket`, which is derived from the +:class:`socket.socket` type, and provides a socket-like wrapper that also +encrypts and decrypts the data going over the socket with SSL. It supports +additional methods such as :meth:`getpeercert`, which retrieves the +certificate of the other side of the connection, and :meth:`cipher`,which +retrieves the cipher being used for the secure connection. + +For more sophisticated applications, the :class:`ssl.SSLContext` class +helps manage settings and certificates, which can then be inherited +by SSL sockets created through the :meth:`SSLContext.wrap_socket` method. + +.. versionchanged:: 3.5.3 + Updated to support linking with OpenSSL 1.1.0 + +.. versionchanged:: 3.6 + + OpenSSL 0.9.8, 1.0.0 and 1.0.1 are deprecated and no longer supported. + In the future the ssl module will require at least OpenSSL 1.0.2 or + 1.1.0. + + +Functions, Constants, and Exceptions +------------------------------------ + + +Socket creation +^^^^^^^^^^^^^^^ + +Since Python 3.2 and 2.7.9, it is recommended to use the +:meth:`SSLContext.wrap_socket` of an :class:`SSLContext` instance to wrap +sockets as :class:`SSLSocket` objects. The helper functions +:func:`create_default_context` returns a new context with secure default +settings. The old :func:`wrap_socket` function is deprecated since it is +both inefficient and has no support for server name indication (SNI) and +hostname matching. + +Client socket example with default context and IPv4/IPv6 dual stack:: + + import socket + import ssl + + hostname = 'www.python.org' + context = ssl.create_default_context() + + with socket.create_connection((hostname, 443)) as sock: + with context.wrap_socket(sock, server_hostname=hostname) as ssock: + print(ssock.version()) + + +Client socket example with custom context and IPv4:: + + hostname = 'www.python.org' + # PROTOCOL_TLS_CLIENT requires valid cert chain and hostname + context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT) + context.load_verify_locations('path/to/cabundle.pem') + + with socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0) as sock: + with context.wrap_socket(sock, server_hostname=hostname) as ssock: + print(ssock.version()) + + +Server socket example listening on localhost IPv4:: + + context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER) + context.load_cert_chain('/path/to/certchain.pem', '/path/to/private.key') + + with socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0) as sock: + sock.bind(('127.0.0.1', 8443)) + sock.listen(5) + with context.wrap_socket(sock, server_side=True) as ssock: + conn, addr = ssock.accept() + ... + + +Context creation +^^^^^^^^^^^^^^^^ + +A convenience function helps create :class:`SSLContext` objects for common +purposes. + +.. function:: create_default_context(purpose=Purpose.SERVER_AUTH, cafile=None, capath=None, cadata=None) + + Return a new :class:`SSLContext` object with default settings for + the given *purpose*. The settings are chosen by the :mod:`ssl` module, + and usually represent a higher security level than when calling the + :class:`SSLContext` constructor directly. + + *cafile*, *capath*, *cadata* represent optional CA certificates to + trust for certificate verification, as in + :meth:`SSLContext.load_verify_locations`. If all three are + :const:`None`, this function can choose to trust the system's default + CA certificates instead. + + The settings are: :data:`PROTOCOL_TLS`, :data:`OP_NO_SSLv2`, and + :data:`OP_NO_SSLv3` with high encryption cipher suites without RC4 and + without unauthenticated cipher suites. Passing :data:`~Purpose.SERVER_AUTH` + as *purpose* sets :data:`~SSLContext.verify_mode` to :data:`CERT_REQUIRED` + and either loads CA certificates (when at least one of *cafile*, *capath* or + *cadata* is given) or uses :meth:`SSLContext.load_default_certs` to load + default CA certificates. + + .. note:: + The protocol, options, cipher and other settings may change to more + restrictive values anytime without prior deprecation. The values + represent a fair balance between compatibility and security. + + If your application needs specific settings, you should create a + :class:`SSLContext` and apply the settings yourself. + + .. note:: + If you find that when certain older clients or servers attempt to connect + with a :class:`SSLContext` created by this function that they get an error + stating "Protocol or cipher suite mismatch", it may be that they only + support SSL3.0 which this function excludes using the + :data:`OP_NO_SSLv3`. SSL3.0 is widely considered to be `completely broken + `_. If you still wish to continue to + use this function but still allow SSL 3.0 connections you can re-enable + them using:: + + ctx = ssl.create_default_context(Purpose.CLIENT_AUTH) + ctx.options &= ~ssl.OP_NO_SSLv3 + + .. versionadded:: 3.4 + + .. versionchanged:: 3.4.4 + + RC4 was dropped from the default cipher string. + + .. versionchanged:: 3.6 + + ChaCha20/Poly1305 was added to the default cipher string. + + 3DES was dropped from the default cipher string. + + +Exceptions +^^^^^^^^^^ + +.. exception:: SSLError + + Raised to signal an error from the underlying SSL implementation + (currently provided by the OpenSSL library). This signifies some + problem in the higher-level encryption and authentication layer that's + superimposed on the underlying network connection. This error + is a subtype of :exc:`OSError`. The error code and message of + :exc:`SSLError` instances are provided by the OpenSSL library. + + .. versionchanged:: 3.3 + :exc:`SSLError` used to be a subtype of :exc:`socket.error`. + + .. attribute:: library + + A string mnemonic designating the OpenSSL submodule in which the error + occurred, such as ``SSL``, ``PEM`` or ``X509``. The range of possible + values depends on the OpenSSL version. + + .. versionadded:: 3.3 + + .. attribute:: reason + + A string mnemonic designating the reason this error occurred, for + example ``CERTIFICATE_VERIFY_FAILED``. The range of possible + values depends on the OpenSSL version. + + .. versionadded:: 3.3 + +.. exception:: SSLZeroReturnError + + A subclass of :exc:`SSLError` raised when trying to read or write and + the SSL connection has been closed cleanly. Note that this doesn't + mean that the underlying transport (read TCP) has been closed. + + .. versionadded:: 3.3 + +.. exception:: SSLWantReadError + + A subclass of :exc:`SSLError` raised by a :ref:`non-blocking SSL socket + ` when trying to read or write data, but more data needs + to be received on the underlying TCP transport before the request can be + fulfilled. + + .. versionadded:: 3.3 + +.. exception:: SSLWantWriteError + + A subclass of :exc:`SSLError` raised by a :ref:`non-blocking SSL socket + ` when trying to read or write data, but more data needs + to be sent on the underlying TCP transport before the request can be + fulfilled. + + .. versionadded:: 3.3 + +.. exception:: SSLSyscallError + + A subclass of :exc:`SSLError` raised when a system error was encountered + while trying to fulfill an operation on a SSL socket. Unfortunately, + there is no easy way to inspect the original errno number. + + .. versionadded:: 3.3 + +.. exception:: SSLEOFError + + A subclass of :exc:`SSLError` raised when the SSL connection has been + terminated abruptly. Generally, you shouldn't try to reuse the underlying + transport when this error is encountered. + + .. versionadded:: 3.3 + +.. exception:: SSLCertVerificationError + + A subclass of :exc:`SSLError` raised when certificate validation has + failed. + + .. versionadded:: 3.7 + + .. attribute:: verify_code + + A numeric error number that denotes the verification error. + + .. attribute:: verify_message + + A human readable string of the verification error. + +.. exception:: CertificateError + + An alias for :exc:`SSLCertVerificationError`. + + .. versionchanged:: 3.7 + The exception is now an alias for :exc:`SSLCertVerificationError`. + + +Random generation +^^^^^^^^^^^^^^^^^ + +.. function:: RAND_bytes(num) + + Return *num* cryptographically strong pseudo-random bytes. Raises an + :class:`SSLError` if the PRNG has not been seeded with enough data or if the + operation is not supported by the current RAND method. :func:`RAND_status` + can be used to check the status of the PRNG and :func:`RAND_add` can be used + to seed the PRNG. + + For almost all applications :func:`os.urandom` is preferable. + + Read the Wikipedia article, `Cryptographically secure pseudorandom number + generator (CSPRNG) + `_, + to get the requirements of a cryptographically generator. + + .. versionadded:: 3.3 + +.. function:: RAND_pseudo_bytes(num) + + Return (bytes, is_cryptographic): bytes are *num* pseudo-random bytes, + is_cryptographic is ``True`` if the bytes generated are cryptographically + strong. Raises an :class:`SSLError` if the operation is not supported by the + current RAND method. + + Generated pseudo-random byte sequences will be unique if they are of + sufficient length, but are not necessarily unpredictable. They can be used + for non-cryptographic purposes and for certain purposes in cryptographic + protocols, but usually not for key generation etc. + + For almost all applications :func:`os.urandom` is preferable. + + .. versionadded:: 3.3 + + .. deprecated:: 3.6 + + OpenSSL has deprecated :func:`ssl.RAND_pseudo_bytes`, use + :func:`ssl.RAND_bytes` instead. + +.. function:: RAND_status() + + Return ``True`` if the SSL pseudo-random number generator has been seeded + with 'enough' randomness, and ``False`` otherwise. You can use + :func:`ssl.RAND_egd` and :func:`ssl.RAND_add` to increase the randomness of + the pseudo-random number generator. + +.. function:: RAND_egd(path) + + If you are running an entropy-gathering daemon (EGD) somewhere, and *path* + is the pathname of a socket connection open to it, this will read 256 bytes + of randomness from the socket, and add it to the SSL pseudo-random number + generator to increase the security of generated secret keys. This is + typically only necessary on systems without better sources of randomness. + + See http://egd.sourceforge.net/ or http://prngd.sourceforge.net/ for sources + of entropy-gathering daemons. + + .. availability:: not available with LibreSSL and OpenSSL > 1.1.0. + +.. function:: RAND_add(bytes, entropy) + + Mix the given *bytes* into the SSL pseudo-random number generator. The + parameter *entropy* (a float) is a lower bound on the entropy contained in + string (so you can always use :const:`0.0`). See :rfc:`1750` for more + information on sources of entropy. + + .. versionchanged:: 3.5 + Writable :term:`bytes-like object` is now accepted. + +Certificate handling +^^^^^^^^^^^^^^^^^^^^ + +.. testsetup:: + + import ssl + +.. function:: match_hostname(cert, hostname) + + Verify that *cert* (in decoded format as returned by + :meth:`SSLSocket.getpeercert`) matches the given *hostname*. The rules + applied are those for checking the identity of HTTPS servers as outlined + in :rfc:`2818`, :rfc:`5280` and :rfc:`6125`. In addition to HTTPS, this + function should be suitable for checking the identity of servers in + various SSL-based protocols such as FTPS, IMAPS, POPS and others. + + :exc:`CertificateError` is raised on failure. On success, the function + returns nothing:: + + >>> cert = {'subject': ((('commonName', 'example.com'),),)} + >>> ssl.match_hostname(cert, "example.com") + >>> ssl.match_hostname(cert, "example.org") + Traceback (most recent call last): + File "", line 1, in + File "/home/py3k/Lib/ssl.py", line 130, in match_hostname + ssl.CertificateError: hostname 'example.org' doesn't match 'example.com' + + .. versionadded:: 3.2 + + .. versionchanged:: 3.3.3 + The function now follows :rfc:`6125`, section 6.4.3 and does neither + match multiple wildcards (e.g. ``*.*.com`` or ``*a*.example.org``) nor + a wildcard inside an internationalized domain names (IDN) fragment. + IDN A-labels such as ``www*.xn--pthon-kva.org`` are still supported, + but ``x*.python.org`` no longer matches ``xn--tda.python.org``. + + .. versionchanged:: 3.5 + Matching of IP addresses, when present in the subjectAltName field + of the certificate, is now supported. + + .. versionchanged:: 3.7 + The function is no longer used to TLS connections. Hostname matching + is now performed by OpenSSL. + + Allow wildcard when it is the leftmost and the only character + in that segment. Partial wildcards like ``www*.example.com`` are no + longer supported. + + .. deprecated:: 3.7 + +.. function:: cert_time_to_seconds(cert_time) + + Return the time in seconds since the Epoch, given the ``cert_time`` + string representing the "notBefore" or "notAfter" date from a + certificate in ``"%b %d %H:%M:%S %Y %Z"`` strptime format (C + locale). + + Here's an example: + + .. doctest:: newcontext + + >>> import ssl + >>> timestamp = ssl.cert_time_to_seconds("Jan 5 09:34:43 2018 GMT") + >>> timestamp # doctest: +SKIP + 1515144883 + >>> from datetime import datetime + >>> print(datetime.utcfromtimestamp(timestamp)) # doctest: +SKIP + 2018-01-05 09:34:43 + + "notBefore" or "notAfter" dates must use GMT (:rfc:`5280`). + + .. versionchanged:: 3.5 + Interpret the input time as a time in UTC as specified by 'GMT' + timezone in the input string. Local timezone was used + previously. Return an integer (no fractions of a second in the + input format) + +.. function:: get_server_certificate(addr, ssl_version=PROTOCOL_TLS, ca_certs=None) + + Given the address ``addr`` of an SSL-protected server, as a (*hostname*, + *port-number*) pair, fetches the server's certificate, and returns it as a + PEM-encoded string. If ``ssl_version`` is specified, uses that version of + the SSL protocol to attempt to connect to the server. If ``ca_certs`` is + specified, it should be a file containing a list of root certificates, the + same format as used for the same parameter in + :meth:`SSLContext.wrap_socket`. The call will attempt to validate the + server certificate against that set of root certificates, and will fail + if the validation attempt fails. + + .. versionchanged:: 3.3 + This function is now IPv6-compatible. + + .. versionchanged:: 3.5 + The default *ssl_version* is changed from :data:`PROTOCOL_SSLv3` to + :data:`PROTOCOL_TLS` for maximum compatibility with modern servers. + +.. function:: DER_cert_to_PEM_cert(DER_cert_bytes) + + Given a certificate as a DER-encoded blob of bytes, returns a PEM-encoded + string version of the same certificate. + +.. function:: PEM_cert_to_DER_cert(PEM_cert_string) + + Given a certificate as an ASCII PEM string, returns a DER-encoded sequence of + bytes for that same certificate. + +.. function:: get_default_verify_paths() + + Returns a named tuple with paths to OpenSSL's default cafile and capath. + The paths are the same as used by + :meth:`SSLContext.set_default_verify_paths`. The return value is a + :term:`named tuple` ``DefaultVerifyPaths``: + + * :attr:`cafile` - resolved path to cafile or ``None`` if the file doesn't exist, + * :attr:`capath` - resolved path to capath or ``None`` if the directory doesn't exist, + * :attr:`openssl_cafile_env` - OpenSSL's environment key that points to a cafile, + * :attr:`openssl_cafile` - hard coded path to a cafile, + * :attr:`openssl_capath_env` - OpenSSL's environment key that points to a capath, + * :attr:`openssl_capath` - hard coded path to a capath directory + + .. availability:: LibreSSL ignores the environment vars + :attr:`openssl_cafile_env` and :attr:`openssl_capath_env`. + + .. versionadded:: 3.4 + +.. function:: enum_certificates(store_name) + + Retrieve certificates from Windows' system cert store. *store_name* may be + one of ``CA``, ``ROOT`` or ``MY``. Windows may provide additional cert + stores, too. + + The function returns a list of (cert_bytes, encoding_type, trust) tuples. + The encoding_type specifies the encoding of cert_bytes. It is either + :const:`x509_asn` for X.509 ASN.1 data or :const:`pkcs_7_asn` for + PKCS#7 ASN.1 data. Trust specifies the purpose of the certificate as a set + of OIDS or exactly ``True`` if the certificate is trustworthy for all + purposes. + + Example:: + + >>> ssl.enum_certificates("CA") + [(b'data...', 'x509_asn', {'1.3.6.1.5.5.7.3.1', '1.3.6.1.5.5.7.3.2'}), + (b'data...', 'x509_asn', True)] + + .. availability:: Windows. + + .. versionadded:: 3.4 + +.. function:: enum_crls(store_name) + + Retrieve CRLs from Windows' system cert store. *store_name* may be + one of ``CA``, ``ROOT`` or ``MY``. Windows may provide additional cert + stores, too. + + The function returns a list of (cert_bytes, encoding_type, trust) tuples. + The encoding_type specifies the encoding of cert_bytes. It is either + :const:`x509_asn` for X.509 ASN.1 data or :const:`pkcs_7_asn` for + PKCS#7 ASN.1 data. + + .. availability:: Windows. + + .. versionadded:: 3.4 + +.. function:: wrap_socket(sock, keyfile=None, certfile=None, \ + server_side=False, cert_reqs=CERT_NONE, ssl_version=PROTOCOL_TLS, \ + ca_certs=None, do_handshake_on_connect=True, \ + suppress_ragged_eofs=True, ciphers=None) + + Takes an instance ``sock`` of :class:`socket.socket`, and returns an instance + of :class:`ssl.SSLSocket`, a subtype of :class:`socket.socket`, which wraps + the underlying socket in an SSL context. ``sock`` must be a + :data:`~socket.SOCK_STREAM` socket; other socket types are unsupported. + + Internally, function creates a :class:`SSLContext` with protocol + *ssl_version* and :attr:`SSLContext.options` set to *cert_reqs*. If + parameters *keyfile*, *certfile*, *ca_certs* or *ciphers* are set, then + the values are passed to :meth:`SSLContext.load_cert_chain`, + :meth:`SSLContext.load_verify_locations`, and + :meth:`SSLContext.set_ciphers`. + + The arguments *server_side*, *do_handshake_on_connect*, and + *suppress_ragged_eofs* have the same meaning as + :meth:`SSLContext.wrap_socket`. + + .. deprecated:: 3.7 + + Since Python 3.2 and 2.7.9, it is recommended to use the + :meth:`SSLContext.wrap_socket` instead of :func:`wrap_socket`. The + top-level function is limited and creates an insecure client socket + without server name indication or hostname matching. + +Constants +^^^^^^^^^ + + All constants are now :class:`enum.IntEnum` or :class:`enum.IntFlag` collections. + + .. versionadded:: 3.6 + +.. data:: CERT_NONE + + Possible value for :attr:`SSLContext.verify_mode`, or the ``cert_reqs`` + parameter to :func:`wrap_socket`. Except for :const:`PROTOCOL_TLS_CLIENT`, + it is the default mode. With client-side sockets, just about any + cert is accepted. Validation errors, such as untrusted or expired cert, + are ignored and do not abort the TLS/SSL handshake. + + In server mode, no certificate is requested from the client, so the client + does not send any for client cert authentication. + + See the discussion of :ref:`ssl-security` below. + +.. data:: CERT_OPTIONAL + + Possible value for :attr:`SSLContext.verify_mode`, or the ``cert_reqs`` + parameter to :func:`wrap_socket`. In client mode, :const:`CERT_OPTIONAL` + has the same meaning as :const:`CERT_REQUIRED`. It is recommended to + use :const:`CERT_REQUIRED` for client-side sockets instead. + + In server mode, a client certificate request is sent to the client. The + client may either ignore the request or send a certificate in order + perform TLS client cert authentication. If the client chooses to send + a certificate, it is verified. Any verification error immediately aborts + the TLS handshake. + + Use of this setting requires a valid set of CA certificates to + be passed, either to :meth:`SSLContext.load_verify_locations` or as a + value of the ``ca_certs`` parameter to :func:`wrap_socket`. + +.. data:: CERT_REQUIRED + + Possible value for :attr:`SSLContext.verify_mode`, or the ``cert_reqs`` + parameter to :func:`wrap_socket`. In this mode, certificates are + required from the other side of the socket connection; an :class:`SSLError` + will be raised if no certificate is provided, or if its validation fails. + This mode is **not** sufficient to verify a certificate in client mode as + it does not match hostnames. :attr:`~SSLContext.check_hostname` must be + enabled as well to verify the authenticity of a cert. + :const:`PROTOCOL_TLS_CLIENT` uses :const:`CERT_REQUIRED` and + enables :attr:`~SSLContext.check_hostname` by default. + + With server socket, this mode provides mandatory TLS client cert + authentication. A client certificate request is sent to the client and + the client must provide a valid and trusted certificate. + + Use of this setting requires a valid set of CA certificates to + be passed, either to :meth:`SSLContext.load_verify_locations` or as a + value of the ``ca_certs`` parameter to :func:`wrap_socket`. + +.. class:: VerifyMode + + :class:`enum.IntEnum` collection of CERT_* constants. + + .. versionadded:: 3.6 + +.. data:: VERIFY_DEFAULT + + Possible value for :attr:`SSLContext.verify_flags`. In this mode, certificate + revocation lists (CRLs) are not checked. By default OpenSSL does neither + require nor verify CRLs. + + .. versionadded:: 3.4 + +.. data:: VERIFY_CRL_CHECK_LEAF + + Possible value for :attr:`SSLContext.verify_flags`. In this mode, only the + peer cert is check but non of the intermediate CA certificates. The mode + requires a valid CRL that is signed by the peer cert's issuer (its direct + ancestor CA). If no proper has been loaded + :attr:`SSLContext.load_verify_locations`, validation will fail. + + .. versionadded:: 3.4 + +.. data:: VERIFY_CRL_CHECK_CHAIN + + Possible value for :attr:`SSLContext.verify_flags`. In this mode, CRLs of + all certificates in the peer cert chain are checked. + + .. versionadded:: 3.4 + +.. data:: VERIFY_X509_STRICT + + Possible value for :attr:`SSLContext.verify_flags` to disable workarounds + for broken X.509 certificates. + + .. versionadded:: 3.4 + +.. data:: VERIFY_X509_TRUSTED_FIRST + + Possible value for :attr:`SSLContext.verify_flags`. It instructs OpenSSL to + prefer trusted certificates when building the trust chain to validate a + certificate. This flag is enabled by default. + + .. versionadded:: 3.4.4 + +.. class:: VerifyFlags + + :class:`enum.IntFlag` collection of VERIFY_* constants. + + .. versionadded:: 3.6 + +.. data:: PROTOCOL_TLS + + Selects the highest protocol version that both the client and server support. + Despite the name, this option can select both "SSL" and "TLS" protocols. + + .. versionadded:: 3.6 + +.. data:: PROTOCOL_TLS_CLIENT + + Auto-negotiate the highest protocol version like :data:`PROTOCOL_TLS`, + but only support client-side :class:`SSLSocket` connections. The protocol + enables :data:`CERT_REQUIRED` and :attr:`~SSLContext.check_hostname` by + default. + + .. versionadded:: 3.6 + +.. data:: PROTOCOL_TLS_SERVER + + Auto-negotiate the highest protocol version like :data:`PROTOCOL_TLS`, + but only support server-side :class:`SSLSocket` connections. + + .. versionadded:: 3.6 + +.. data:: PROTOCOL_SSLv23 + + Alias for :data:`PROTOCOL_TLS`. + + .. deprecated:: 3.6 + + Use :data:`PROTOCOL_TLS` instead. + +.. data:: PROTOCOL_SSLv2 + + Selects SSL version 2 as the channel encryption protocol. + + This protocol is not available if OpenSSL is compiled with the + ``OPENSSL_NO_SSL2`` flag. + + .. warning:: + + SSL version 2 is insecure. Its use is highly discouraged. + + .. deprecated:: 3.6 + + OpenSSL has removed support for SSLv2. + +.. data:: PROTOCOL_SSLv3 + + Selects SSL version 3 as the channel encryption protocol. + + This protocol is not be available if OpenSSL is compiled with the + ``OPENSSL_NO_SSLv3`` flag. + + .. warning:: + + SSL version 3 is insecure. Its use is highly discouraged. + + .. deprecated:: 3.6 + + OpenSSL has deprecated all version specific protocols. Use the default + protocol :data:`PROTOCOL_TLS` with flags like :data:`OP_NO_SSLv3` instead. + +.. data:: PROTOCOL_TLSv1 + + Selects TLS version 1.0 as the channel encryption protocol. + + .. deprecated:: 3.6 + + OpenSSL has deprecated all version specific protocols. Use the default + protocol :data:`PROTOCOL_TLS` with flags like :data:`OP_NO_SSLv3` instead. + +.. data:: PROTOCOL_TLSv1_1 + + Selects TLS version 1.1 as the channel encryption protocol. + Available only with openssl version 1.0.1+. + + .. versionadded:: 3.4 + + .. deprecated:: 3.6 + + OpenSSL has deprecated all version specific protocols. Use the default + protocol :data:`PROTOCOL_TLS` with flags like :data:`OP_NO_SSLv3` instead. + +.. data:: PROTOCOL_TLSv1_2 + + Selects TLS version 1.2 as the channel encryption protocol. This is the + most modern version, and probably the best choice for maximum protection, + if both sides can speak it. Available only with openssl version 1.0.1+. + + .. versionadded:: 3.4 + + .. deprecated:: 3.6 + + OpenSSL has deprecated all version specific protocols. Use the default + protocol :data:`PROTOCOL_TLS` with flags like :data:`OP_NO_SSLv3` instead. + +.. data:: OP_ALL + + Enables workarounds for various bugs present in other SSL implementations. + This option is set by default. It does not necessarily set the same + flags as OpenSSL's ``SSL_OP_ALL`` constant. + + .. versionadded:: 3.2 + +.. data:: OP_NO_SSLv2 + + Prevents an SSLv2 connection. This option is only applicable in + conjunction with :const:`PROTOCOL_TLS`. It prevents the peers from + choosing SSLv2 as the protocol version. + + .. versionadded:: 3.2 + + .. deprecated:: 3.6 + + SSLv2 is deprecated + + +.. data:: OP_NO_SSLv3 + + Prevents an SSLv3 connection. This option is only applicable in + conjunction with :const:`PROTOCOL_TLS`. It prevents the peers from + choosing SSLv3 as the protocol version. + + .. versionadded:: 3.2 + + .. deprecated:: 3.6 + + SSLv3 is deprecated + +.. data:: OP_NO_TLSv1 + + Prevents a TLSv1 connection. This option is only applicable in + conjunction with :const:`PROTOCOL_TLS`. It prevents the peers from + choosing TLSv1 as the protocol version. + + .. versionadded:: 3.2 + + .. deprecated:: 3.7 + The option is deprecated since OpenSSL 1.1.0, use the new + :attr:`SSLContext.minimum_version` and + :attr:`SSLContext.maximum_version` instead. + +.. data:: OP_NO_TLSv1_1 + + Prevents a TLSv1.1 connection. This option is only applicable in conjunction + with :const:`PROTOCOL_TLS`. It prevents the peers from choosing TLSv1.1 as + the protocol version. Available only with openssl version 1.0.1+. + + .. versionadded:: 3.4 + + .. deprecated:: 3.7 + The option is deprecated since OpenSSL 1.1.0. + +.. data:: OP_NO_TLSv1_2 + + Prevents a TLSv1.2 connection. This option is only applicable in conjunction + with :const:`PROTOCOL_TLS`. It prevents the peers from choosing TLSv1.2 as + the protocol version. Available only with openssl version 1.0.1+. + + .. versionadded:: 3.4 + + .. deprecated:: 3.7 + The option is deprecated since OpenSSL 1.1.0. + +.. data:: OP_NO_TLSv1_3 + + Prevents a TLSv1.3 connection. This option is only applicable in conjunction + with :const:`PROTOCOL_TLS`. It prevents the peers from choosing TLSv1.3 as + the protocol version. TLS 1.3 is available with OpenSSL 1.1.1 or later. + When Python has been compiled against an older version of OpenSSL, the + flag defaults to *0*. + + .. versionadded:: 3.7 + + .. deprecated:: 3.7 + The option is deprecated since OpenSSL 1.1.0. It was added to 2.7.15, + 3.6.3 and 3.7.0 for backwards compatibility with OpenSSL 1.0.2. + +.. data:: OP_NO_RENEGOTIATION + + Disable all renegotiation in TLSv1.2 and earlier. Do not send + HelloRequest messages, and ignore renegotiation requests via ClientHello. + + This option is only available with OpenSSL 1.1.0h and later. + + .. versionadded:: 3.7 + +.. data:: OP_CIPHER_SERVER_PREFERENCE + + Use the server's cipher ordering preference, rather than the client's. + This option has no effect on client sockets and SSLv2 server sockets. + + .. versionadded:: 3.3 + +.. data:: OP_SINGLE_DH_USE + + Prevents re-use of the same DH key for distinct SSL sessions. This + improves forward secrecy but requires more computational resources. + This option only applies to server sockets. + + .. versionadded:: 3.3 + +.. data:: OP_SINGLE_ECDH_USE + + Prevents re-use of the same ECDH key for distinct SSL sessions. This + improves forward secrecy but requires more computational resources. + This option only applies to server sockets. + + .. versionadded:: 3.3 + +.. data:: OP_ENABLE_MIDDLEBOX_COMPAT + + Send dummy Change Cipher Spec (CCS) messages in TLS 1.3 handshake to make + a TLS 1.3 connection look more like a TLS 1.2 connection. + + This option is only available with OpenSSL 1.1.1 and later. + + .. versionadded:: 3.8 + +.. data:: OP_NO_COMPRESSION + + Disable compression on the SSL channel. This is useful if the application + protocol supports its own compression scheme. + + This option is only available with OpenSSL 1.0.0 and later. + + .. versionadded:: 3.3 + +.. class:: Options + + :class:`enum.IntFlag` collection of OP_* constants. + +.. data:: OP_NO_TICKET + + Prevent client side from requesting a session ticket. + + .. versionadded:: 3.6 + +.. data:: HAS_ALPN + + Whether the OpenSSL library has built-in support for the *Application-Layer + Protocol Negotiation* TLS extension as described in :rfc:`7301`. + + .. versionadded:: 3.5 + +.. data:: HAS_NEVER_CHECK_COMMON_NAME + + Whether the OpenSSL library has built-in support not checking subject + common name and :attr:`SSLContext.hostname_checks_common_name` is + writeable. + + .. versionadded:: 3.7 + +.. data:: HAS_ECDH + + Whether the OpenSSL library has built-in support for the Elliptic Curve-based + Diffie-Hellman key exchange. This should be true unless the feature was + explicitly disabled by the distributor. + + .. versionadded:: 3.3 + +.. data:: HAS_SNI + + Whether the OpenSSL library has built-in support for the *Server Name + Indication* extension (as defined in :rfc:`6066`). + + .. versionadded:: 3.2 + +.. data:: HAS_NPN + + Whether the OpenSSL library has built-in support for the *Next Protocol + Negotiation* as described in the `Application Layer Protocol + Negotiation `_. + When true, you can use the :meth:`SSLContext.set_npn_protocols` method to advertise + which protocols you want to support. + + .. versionadded:: 3.3 + +.. data:: HAS_SSLv2 + + Whether the OpenSSL library has built-in support for the SSL 2.0 protocol. + + .. versionadded:: 3.7 + +.. data:: HAS_SSLv3 + + Whether the OpenSSL library has built-in support for the SSL 3.0 protocol. + + .. versionadded:: 3.7 + +.. data:: HAS_TLSv1 + + Whether the OpenSSL library has built-in support for the TLS 1.0 protocol. + + .. versionadded:: 3.7 + +.. data:: HAS_TLSv1_1 + + Whether the OpenSSL library has built-in support for the TLS 1.1 protocol. + + .. versionadded:: 3.7 + +.. data:: HAS_TLSv1_2 + + Whether the OpenSSL library has built-in support for the TLS 1.2 protocol. + + .. versionadded:: 3.7 + +.. data:: HAS_TLSv1_3 + + Whether the OpenSSL library has built-in support for the TLS 1.3 protocol. + + .. versionadded:: 3.7 + +.. data:: CHANNEL_BINDING_TYPES + + List of supported TLS channel binding types. Strings in this list + can be used as arguments to :meth:`SSLSocket.get_channel_binding`. + + .. versionadded:: 3.3 + +.. data:: OPENSSL_VERSION + + The version string of the OpenSSL library loaded by the interpreter:: + + >>> ssl.OPENSSL_VERSION + 'OpenSSL 1.0.2k 26 Jan 2017' + + .. versionadded:: 3.2 + +.. data:: OPENSSL_VERSION_INFO + + A tuple of five integers representing version information about the + OpenSSL library:: + + >>> ssl.OPENSSL_VERSION_INFO + (1, 0, 2, 11, 15) + + .. versionadded:: 3.2 + +.. data:: OPENSSL_VERSION_NUMBER + + The raw version number of the OpenSSL library, as a single integer:: + + >>> ssl.OPENSSL_VERSION_NUMBER + 268443839 + >>> hex(ssl.OPENSSL_VERSION_NUMBER) + '0x100020bf' + + .. versionadded:: 3.2 + +.. data:: ALERT_DESCRIPTION_HANDSHAKE_FAILURE + ALERT_DESCRIPTION_INTERNAL_ERROR + ALERT_DESCRIPTION_* + + Alert Descriptions from :rfc:`5246` and others. The `IANA TLS Alert Registry + `_ + contains this list and references to the RFCs where their meaning is defined. + + Used as the return value of the callback function in + :meth:`SSLContext.set_servername_callback`. + + .. versionadded:: 3.4 + +.. class:: AlertDescription + + :class:`enum.IntEnum` collection of ALERT_DESCRIPTION_* constants. + + .. versionadded:: 3.6 + +.. data:: Purpose.SERVER_AUTH + + Option for :func:`create_default_context` and + :meth:`SSLContext.load_default_certs`. This value indicates that the + context may be used to authenticate Web servers (therefore, it will + be used to create client-side sockets). + + .. versionadded:: 3.4 + +.. data:: Purpose.CLIENT_AUTH + + Option for :func:`create_default_context` and + :meth:`SSLContext.load_default_certs`. This value indicates that the + context may be used to authenticate Web clients (therefore, it will + be used to create server-side sockets). + + .. versionadded:: 3.4 + +.. class:: SSLErrorNumber + + :class:`enum.IntEnum` collection of SSL_ERROR_* constants. + + .. versionadded:: 3.6 + +.. class:: TLSVersion + + :class:`enum.IntEnum` collection of SSL and TLS versions for + :attr:`SSLContext.maximum_version` and :attr:`SSLContext.minimum_version`. + + .. versionadded:: 3.7 + +.. attribute:: TLSVersion.MINIMUM_SUPPORTED +.. attribute:: TLSVersion.MAXIMUM_SUPPORTED + + The minimum or maximum supported SSL or TLS version. These are magic + constants. Their values don't reflect the lowest and highest available + TLS/SSL versions. + +.. attribute:: TLSVersion.SSLv3 +.. attribute:: TLSVersion.TLSv1 +.. attribute:: TLSVersion.TLSv1_1 +.. attribute:: TLSVersion.TLSv1_2 +.. attribute:: TLSVersion.TLSv1_3 + + SSL 3.0 to TLS 1.3. + +SSL Sockets +----------- + +.. class:: SSLSocket(socket.socket) + + SSL sockets provide the following methods of :ref:`socket-objects`: + + - :meth:`~socket.socket.accept()` + - :meth:`~socket.socket.bind()` + - :meth:`~socket.socket.close()` + - :meth:`~socket.socket.connect()` + - :meth:`~socket.socket.detach()` + - :meth:`~socket.socket.fileno()` + - :meth:`~socket.socket.getpeername()`, :meth:`~socket.socket.getsockname()` + - :meth:`~socket.socket.getsockopt()`, :meth:`~socket.socket.setsockopt()` + - :meth:`~socket.socket.gettimeout()`, :meth:`~socket.socket.settimeout()`, + :meth:`~socket.socket.setblocking()` + - :meth:`~socket.socket.listen()` + - :meth:`~socket.socket.makefile()` + - :meth:`~socket.socket.recv()`, :meth:`~socket.socket.recv_into()` + (but passing a non-zero ``flags`` argument is not allowed) + - :meth:`~socket.socket.send()`, :meth:`~socket.socket.sendall()` (with + the same limitation) + - :meth:`~socket.socket.sendfile()` (but :mod:`os.sendfile` will be used + for plain-text sockets only, else :meth:`~socket.socket.send()` will be used) + - :meth:`~socket.socket.shutdown()` + + However, since the SSL (and TLS) protocol has its own framing atop + of TCP, the SSL sockets abstraction can, in certain respects, diverge from + the specification of normal, OS-level sockets. See especially the + :ref:`notes on non-blocking sockets `. + + Instances of :class:`SSLSocket` must be created using the + :meth:`SSLContext.wrap_socket` method. + + .. versionchanged:: 3.5 + The :meth:`sendfile` method was added. + + .. versionchanged:: 3.5 + The :meth:`shutdown` does not reset the socket timeout each time bytes + are received or sent. The socket timeout is now to maximum total duration + of the shutdown. + + .. deprecated:: 3.6 + It is deprecated to create a :class:`SSLSocket` instance directly, use + :meth:`SSLContext.wrap_socket` to wrap a socket. + + .. versionchanged:: 3.7 + :class:`SSLSocket` instances must to created with + :meth:`~SSLContext.wrap_socket`. In earlier versions, it was possible + to create instances directly. This was never documented or officially + supported. + +SSL sockets also have the following additional methods and attributes: + +.. method:: SSLSocket.read(len=1024, buffer=None) + + Read up to *len* bytes of data from the SSL socket and return the result as + a ``bytes`` instance. If *buffer* is specified, then read into the buffer + instead, and return the number of bytes read. + + Raise :exc:`SSLWantReadError` or :exc:`SSLWantWriteError` if the socket is + :ref:`non-blocking ` and the read would block. + + As at any time a re-negotiation is possible, a call to :meth:`read` can also + cause write operations. + + .. versionchanged:: 3.5 + The socket timeout is no more reset each time bytes are received or sent. + The socket timeout is now to maximum total duration to read up to *len* + bytes. + + .. deprecated:: 3.6 + Use :meth:`~SSLSocket.recv` instead of :meth:`~SSLSocket.read`. + +.. method:: SSLSocket.write(buf) + + Write *buf* to the SSL socket and return the number of bytes written. The + *buf* argument must be an object supporting the buffer interface. + + Raise :exc:`SSLWantReadError` or :exc:`SSLWantWriteError` if the socket is + :ref:`non-blocking ` and the write would block. + + As at any time a re-negotiation is possible, a call to :meth:`write` can + also cause read operations. + + .. versionchanged:: 3.5 + The socket timeout is no more reset each time bytes are received or sent. + The socket timeout is now to maximum total duration to write *buf*. + + .. deprecated:: 3.6 + Use :meth:`~SSLSocket.send` instead of :meth:`~SSLSocket.write`. + +.. note:: + + The :meth:`~SSLSocket.read` and :meth:`~SSLSocket.write` methods are the + low-level methods that read and write unencrypted, application-level data + and decrypt/encrypt it to encrypted, wire-level data. These methods + require an active SSL connection, i.e. the handshake was completed and + :meth:`SSLSocket.unwrap` was not called. + + Normally you should use the socket API methods like + :meth:`~socket.socket.recv` and :meth:`~socket.socket.send` instead of these + methods. + +.. method:: SSLSocket.do_handshake() + + Perform the SSL setup handshake. + + .. versionchanged:: 3.4 + The handshake method also performs :func:`match_hostname` when the + :attr:`~SSLContext.check_hostname` attribute of the socket's + :attr:`~SSLSocket.context` is true. + + .. versionchanged:: 3.5 + The socket timeout is no more reset each time bytes are received or sent. + The socket timeout is now to maximum total duration of the handshake. + + .. versionchanged:: 3.7 + Hostname or IP address is matched by OpenSSL during handshake. The + function :func:`match_hostname` is no longer used. In case OpenSSL + refuses a hostname or IP address, the handshake is aborted early and + a TLS alert message is send to the peer. + +.. method:: SSLSocket.getpeercert(binary_form=False) + + If there is no certificate for the peer on the other end of the connection, + return ``None``. If the SSL handshake hasn't been done yet, raise + :exc:`ValueError`. + + If the ``binary_form`` parameter is :const:`False`, and a certificate was + received from the peer, this method returns a :class:`dict` instance. If the + certificate was not validated, the dict is empty. If the certificate was + validated, it returns a dict with several keys, amongst them ``subject`` + (the principal for which the certificate was issued) and ``issuer`` + (the principal issuing the certificate). If a certificate contains an + instance of the *Subject Alternative Name* extension (see :rfc:`3280`), + there will also be a ``subjectAltName`` key in the dictionary. + + The ``subject`` and ``issuer`` fields are tuples containing the sequence + of relative distinguished names (RDNs) given in the certificate's data + structure for the respective fields, and each RDN is a sequence of + name-value pairs. Here is a real-world example:: + + {'issuer': ((('countryName', 'IL'),), + (('organizationName', 'StartCom Ltd.'),), + (('organizationalUnitName', + 'Secure Digital Certificate Signing'),), + (('commonName', + 'StartCom Class 2 Primary Intermediate Server CA'),)), + 'notAfter': 'Nov 22 08:15:19 2013 GMT', + 'notBefore': 'Nov 21 03:09:52 2011 GMT', + 'serialNumber': '95F0', + 'subject': ((('description', '571208-SLe257oHY9fVQ07Z'),), + (('countryName', 'US'),), + (('stateOrProvinceName', 'California'),), + (('localityName', 'San Francisco'),), + (('organizationName', 'Electronic Frontier Foundation, Inc.'),), + (('commonName', '*.eff.org'),), + (('emailAddress', 'hostmaster@eff.org'),)), + 'subjectAltName': (('DNS', '*.eff.org'), ('DNS', 'eff.org')), + 'version': 3} + + .. note:: + + To validate a certificate for a particular service, you can use the + :func:`match_hostname` function. + + If the ``binary_form`` parameter is :const:`True`, and a certificate was + provided, this method returns the DER-encoded form of the entire certificate + as a sequence of bytes, or :const:`None` if the peer did not provide a + certificate. Whether the peer provides a certificate depends on the SSL + socket's role: + + * for a client SSL socket, the server will always provide a certificate, + regardless of whether validation was required; + + * for a server SSL socket, the client will only provide a certificate + when requested by the server; therefore :meth:`getpeercert` will return + :const:`None` if you used :const:`CERT_NONE` (rather than + :const:`CERT_OPTIONAL` or :const:`CERT_REQUIRED`). + + .. versionchanged:: 3.2 + The returned dictionary includes additional items such as ``issuer`` + and ``notBefore``. + + .. versionchanged:: 3.4 + :exc:`ValueError` is raised when the handshake isn't done. + The returned dictionary includes additional X509v3 extension items + such as ``crlDistributionPoints``, ``caIssuers`` and ``OCSP`` URIs. + +.. method:: SSLSocket.cipher() + + Returns a three-value tuple containing the name of the cipher being used, the + version of the SSL protocol that defines its use, and the number of secret + bits being used. If no connection has been established, returns ``None``. + +.. method:: SSLSocket.shared_ciphers() + + Return the list of ciphers shared by the client during the handshake. Each + entry of the returned list is a three-value tuple containing the name of the + cipher, the version of the SSL protocol that defines its use, and the number + of secret bits the cipher uses. :meth:`~SSLSocket.shared_ciphers` returns + ``None`` if no connection has been established or the socket is a client + socket. + + .. versionadded:: 3.5 + +.. method:: SSLSocket.compression() + + Return the compression algorithm being used as a string, or ``None`` + if the connection isn't compressed. + + If the higher-level protocol supports its own compression mechanism, + you can use :data:`OP_NO_COMPRESSION` to disable SSL-level compression. + + .. versionadded:: 3.3 + +.. method:: SSLSocket.get_channel_binding(cb_type="tls-unique") + + Get channel binding data for current connection, as a bytes object. Returns + ``None`` if not connected or the handshake has not been completed. + + The *cb_type* parameter allow selection of the desired channel binding + type. Valid channel binding types are listed in the + :data:`CHANNEL_BINDING_TYPES` list. Currently only the 'tls-unique' channel + binding, defined by :rfc:`5929`, is supported. :exc:`ValueError` will be + raised if an unsupported channel binding type is requested. + + .. versionadded:: 3.3 + +.. method:: SSLSocket.selected_alpn_protocol() + + Return the protocol that was selected during the TLS handshake. If + :meth:`SSLContext.set_alpn_protocols` was not called, if the other party does + not support ALPN, if this socket does not support any of the client's + proposed protocols, or if the handshake has not happened yet, ``None`` is + returned. + + .. versionadded:: 3.5 + +.. method:: SSLSocket.selected_npn_protocol() + + Return the higher-level protocol that was selected during the TLS/SSL + handshake. If :meth:`SSLContext.set_npn_protocols` was not called, or + if the other party does not support NPN, or if the handshake has not yet + happened, this will return ``None``. + + .. versionadded:: 3.3 + +.. method:: SSLSocket.unwrap() + + Performs the SSL shutdown handshake, which removes the TLS layer from the + underlying socket, and returns the underlying socket object. This can be + used to go from encrypted operation over a connection to unencrypted. The + returned socket should always be used for further communication with the + other side of the connection, rather than the original socket. + +.. method:: SSLSocket.verify_client_post_handshake() + + Requests post-handshake authentication (PHA) from a TLS 1.3 client. PHA + can only be initiated for a TLS 1.3 connection from a server-side socket, + after the initial TLS handshake and with PHA enabled on both sides, see + :attr:`SSLContext.post_handshake_auth`. + + The method does not perform a cert exchange immediately. The server-side + sends a CertificateRequest during the next write event and expects the + client to respond with a certificate on the next read event. + + If any precondition isn't met (e.g. not TLS 1.3, PHA not enabled), an + :exc:`SSLError` is raised. + + .. note:: + Only available with OpenSSL 1.1.1 and TLS 1.3 enabled. Without TLS 1.3 + support, the method raises :exc:`NotImplementedError`. + + .. versionadded:: 3.7.1 + +.. method:: SSLSocket.version() + + Return the actual SSL protocol version negotiated by the connection + as a string, or ``None`` is no secure connection is established. + As of this writing, possible return values include ``"SSLv2"``, + ``"SSLv3"``, ``"TLSv1"``, ``"TLSv1.1"`` and ``"TLSv1.2"``. + Recent OpenSSL versions may define more return values. + + .. versionadded:: 3.5 + +.. method:: SSLSocket.pending() + + Returns the number of already decrypted bytes available for read, pending on + the connection. + +.. attribute:: SSLSocket.context + + The :class:`SSLContext` object this SSL socket is tied to. If the SSL + socket was created using the deprecated :func:`wrap_socket` function + (rather than :meth:`SSLContext.wrap_socket`), this is a custom context + object created for this SSL socket. + + .. versionadded:: 3.2 + +.. attribute:: SSLSocket.server_side + + A boolean which is ``True`` for server-side sockets and ``False`` for + client-side sockets. + + .. versionadded:: 3.2 + +.. attribute:: SSLSocket.server_hostname + + Hostname of the server: :class:`str` type, or ``None`` for server-side + socket or if the hostname was not specified in the constructor. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.7 + The attribute is now always ASCII text. When ``server_hostname`` is + an internationalized domain name (IDN), this attribute now stores the + A-label form (``"xn--pythn-mua.org"``), rather than the U-label form + (``"pythön.org"``). + +.. attribute:: SSLSocket.session + + The :class:`SSLSession` for this SSL connection. The session is available + for client and server side sockets after the TLS handshake has been + performed. For client sockets the session can be set before + :meth:`~SSLSocket.do_handshake` has been called to reuse a session. + + .. versionadded:: 3.6 + +.. attribute:: SSLSocket.session_reused + + .. versionadded:: 3.6 + + +SSL Contexts +------------ + +.. versionadded:: 3.2 + +An SSL context holds various data longer-lived than single SSL connections, +such as SSL configuration options, certificate(s) and private key(s). +It also manages a cache of SSL sessions for server-side sockets, in order +to speed up repeated connections from the same clients. + +.. class:: SSLContext(protocol=PROTOCOL_TLS) + + Create a new SSL context. You may pass *protocol* which must be one + of the ``PROTOCOL_*`` constants defined in this module. The parameter + specifies which version of the SSL protocol to use. Typically, the + server chooses a particular protocol version, and the client must adapt + to the server's choice. Most of the versions are not interoperable + with the other versions. If not specified, the default is + :data:`PROTOCOL_TLS`; it provides the most compatibility with other + versions. + + Here's a table showing which versions in a client (down the side) can connect + to which versions in a server (along the top): + + .. table:: + + ======================== ============ ============ ============= ========= =========== =========== + *client* / **server** **SSLv2** **SSLv3** **TLS** [3]_ **TLSv1** **TLSv1.1** **TLSv1.2** + ------------------------ ------------ ------------ ------------- --------- ----------- ----------- + *SSLv2* yes no no [1]_ no no no + *SSLv3* no yes no [2]_ no no no + *TLS* (*SSLv23*) [3]_ no [1]_ no [2]_ yes yes yes yes + *TLSv1* no no yes yes no no + *TLSv1.1* no no yes no yes no + *TLSv1.2* no no yes no no yes + ======================== ============ ============ ============= ========= =========== =========== + + .. rubric:: Footnotes + .. [1] :class:`SSLContext` disables SSLv2 with :data:`OP_NO_SSLv2` by default. + .. [2] :class:`SSLContext` disables SSLv3 with :data:`OP_NO_SSLv3` by default. + .. [3] TLS 1.3 protocol will be available with :data:`PROTOCOL_TLS` in + OpenSSL >= 1.1.1. There is no dedicated PROTOCOL constant for just + TLS 1.3. + + .. seealso:: + :func:`create_default_context` lets the :mod:`ssl` module choose + security settings for a given purpose. + + .. versionchanged:: 3.6 + + The context is created with secure default values. The options + :data:`OP_NO_COMPRESSION`, :data:`OP_CIPHER_SERVER_PREFERENCE`, + :data:`OP_SINGLE_DH_USE`, :data:`OP_SINGLE_ECDH_USE`, + :data:`OP_NO_SSLv2` (except for :data:`PROTOCOL_SSLv2`), + and :data:`OP_NO_SSLv3` (except for :data:`PROTOCOL_SSLv3`) are + set by default. The initial cipher suite list contains only ``HIGH`` + ciphers, no ``NULL`` ciphers and no ``MD5`` ciphers (except for + :data:`PROTOCOL_SSLv2`). + + +:class:`SSLContext` objects have the following methods and attributes: + +.. method:: SSLContext.cert_store_stats() + + Get statistics about quantities of loaded X.509 certificates, count of + X.509 certificates flagged as CA certificates and certificate revocation + lists as dictionary. + + Example for a context with one CA cert and one other cert:: + + >>> context.cert_store_stats() + {'crl': 0, 'x509_ca': 1, 'x509': 2} + + .. versionadded:: 3.4 + + +.. method:: SSLContext.load_cert_chain(certfile, keyfile=None, password=None) + + Load a private key and the corresponding certificate. The *certfile* + string must be the path to a single file in PEM format containing the + certificate as well as any number of CA certificates needed to establish + the certificate's authenticity. The *keyfile* string, if present, must + point to a file containing the private key in. Otherwise the private + key will be taken from *certfile* as well. See the discussion of + :ref:`ssl-certificates` for more information on how the certificate + is stored in the *certfile*. + + The *password* argument may be a function to call to get the password for + decrypting the private key. It will only be called if the private key is + encrypted and a password is necessary. It will be called with no arguments, + and it should return a string, bytes, or bytearray. If the return value is + a string it will be encoded as UTF-8 before using it to decrypt the key. + Alternatively a string, bytes, or bytearray value may be supplied directly + as the *password* argument. It will be ignored if the private key is not + encrypted and no password is needed. + + If the *password* argument is not specified and a password is required, + OpenSSL's built-in password prompting mechanism will be used to + interactively prompt the user for a password. + + An :class:`SSLError` is raised if the private key doesn't + match with the certificate. + + .. versionchanged:: 3.3 + New optional argument *password*. + +.. method:: SSLContext.load_default_certs(purpose=Purpose.SERVER_AUTH) + + Load a set of default "certification authority" (CA) certificates from + default locations. On Windows it loads CA certs from the ``CA`` and + ``ROOT`` system stores. On other systems it calls + :meth:`SSLContext.set_default_verify_paths`. In the future the method may + load CA certificates from other locations, too. + + The *purpose* flag specifies what kind of CA certificates are loaded. The + default settings :data:`Purpose.SERVER_AUTH` loads certificates, that are + flagged and trusted for TLS web server authentication (client side + sockets). :data:`Purpose.CLIENT_AUTH` loads CA certificates for client + certificate verification on the server side. + + .. versionadded:: 3.4 + +.. method:: SSLContext.load_verify_locations(cafile=None, capath=None, cadata=None) + + Load a set of "certification authority" (CA) certificates used to validate + other peers' certificates when :data:`verify_mode` is other than + :data:`CERT_NONE`. At least one of *cafile* or *capath* must be specified. + + This method can also load certification revocation lists (CRLs) in PEM or + DER format. In order to make use of CRLs, :attr:`SSLContext.verify_flags` + must be configured properly. + + The *cafile* string, if present, is the path to a file of concatenated + CA certificates in PEM format. See the discussion of + :ref:`ssl-certificates` for more information about how to arrange the + certificates in this file. + + The *capath* string, if present, is + the path to a directory containing several CA certificates in PEM format, + following an `OpenSSL specific layout + `_. + + The *cadata* object, if present, is either an ASCII string of one or more + PEM-encoded certificates or a :term:`bytes-like object` of DER-encoded + certificates. Like with *capath* extra lines around PEM-encoded + certificates are ignored but at least one certificate must be present. + + .. versionchanged:: 3.4 + New optional argument *cadata* + +.. method:: SSLContext.get_ca_certs(binary_form=False) + + Get a list of loaded "certification authority" (CA) certificates. If the + ``binary_form`` parameter is :const:`False` each list + entry is a dict like the output of :meth:`SSLSocket.getpeercert`. Otherwise + the method returns a list of DER-encoded certificates. The returned list + does not contain certificates from *capath* unless a certificate was + requested and loaded by a SSL connection. + + .. note:: + Certificates in a capath directory aren't loaded unless they have + been used at least once. + + .. versionadded:: 3.4 + +.. method:: SSLContext.get_ciphers() + + Get a list of enabled ciphers. The list is in order of cipher priority. + See :meth:`SSLContext.set_ciphers`. + + Example:: + + >>> ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23) + >>> ctx.set_ciphers('ECDHE+AESGCM:!ECDSA') + >>> ctx.get_ciphers() # OpenSSL 1.0.x + [{'alg_bits': 256, + 'description': 'ECDHE-RSA-AES256-GCM-SHA384 TLSv1.2 Kx=ECDH Au=RSA ' + 'Enc=AESGCM(256) Mac=AEAD', + 'id': 50380848, + 'name': 'ECDHE-RSA-AES256-GCM-SHA384', + 'protocol': 'TLSv1/SSLv3', + 'strength_bits': 256}, + {'alg_bits': 128, + 'description': 'ECDHE-RSA-AES128-GCM-SHA256 TLSv1.2 Kx=ECDH Au=RSA ' + 'Enc=AESGCM(128) Mac=AEAD', + 'id': 50380847, + 'name': 'ECDHE-RSA-AES128-GCM-SHA256', + 'protocol': 'TLSv1/SSLv3', + 'strength_bits': 128}] + + On OpenSSL 1.1 and newer the cipher dict contains additional fields:: + + >>> ctx.get_ciphers() # OpenSSL 1.1+ + [{'aead': True, + 'alg_bits': 256, + 'auth': 'auth-rsa', + 'description': 'ECDHE-RSA-AES256-GCM-SHA384 TLSv1.2 Kx=ECDH Au=RSA ' + 'Enc=AESGCM(256) Mac=AEAD', + 'digest': None, + 'id': 50380848, + 'kea': 'kx-ecdhe', + 'name': 'ECDHE-RSA-AES256-GCM-SHA384', + 'protocol': 'TLSv1.2', + 'strength_bits': 256, + 'symmetric': 'aes-256-gcm'}, + {'aead': True, + 'alg_bits': 128, + 'auth': 'auth-rsa', + 'description': 'ECDHE-RSA-AES128-GCM-SHA256 TLSv1.2 Kx=ECDH Au=RSA ' + 'Enc=AESGCM(128) Mac=AEAD', + 'digest': None, + 'id': 50380847, + 'kea': 'kx-ecdhe', + 'name': 'ECDHE-RSA-AES128-GCM-SHA256', + 'protocol': 'TLSv1.2', + 'strength_bits': 128, + 'symmetric': 'aes-128-gcm'}] + + .. availability:: OpenSSL 1.0.2+. + + .. versionadded:: 3.6 + +.. method:: SSLContext.set_default_verify_paths() + + Load a set of default "certification authority" (CA) certificates from + a filesystem path defined when building the OpenSSL library. Unfortunately, + there's no easy way to know whether this method succeeds: no error is + returned if no certificates are to be found. When the OpenSSL library is + provided as part of the operating system, though, it is likely to be + configured properly. + +.. method:: SSLContext.set_ciphers(ciphers) + + Set the available ciphers for sockets created with this context. + It should be a string in the `OpenSSL cipher list format + `_. + If no cipher can be selected (because compile-time options or other + configuration forbids use of all the specified ciphers), an + :class:`SSLError` will be raised. + + .. note:: + when connected, the :meth:`SSLSocket.cipher` method of SSL sockets will + give the currently selected cipher. + + OpenSSL 1.1.1 has TLS 1.3 cipher suites enabled by default. The suites + cannot be disabled with :meth:`~SSLContext.set_ciphers`. + +.. method:: SSLContext.set_alpn_protocols(protocols) + + Specify which protocols the socket should advertise during the SSL/TLS + handshake. It should be a list of ASCII strings, like ``['http/1.1', + 'spdy/2']``, ordered by preference. The selection of a protocol will happen + during the handshake, and will play out according to :rfc:`7301`. After a + successful handshake, the :meth:`SSLSocket.selected_alpn_protocol` method will + return the agreed-upon protocol. + + This method will raise :exc:`NotImplementedError` if :data:`HAS_ALPN` is + False. + + OpenSSL 1.1.0 to 1.1.0e will abort the handshake and raise :exc:`SSLError` + when both sides support ALPN but cannot agree on a protocol. 1.1.0f+ + behaves like 1.0.2, :meth:`SSLSocket.selected_alpn_protocol` returns None. + + .. versionadded:: 3.5 + +.. method:: SSLContext.set_npn_protocols(protocols) + + Specify which protocols the socket should advertise during the SSL/TLS + handshake. It should be a list of strings, like ``['http/1.1', 'spdy/2']``, + ordered by preference. The selection of a protocol will happen during the + handshake, and will play out according to the `Application Layer Protocol Negotiation + `_. After a + successful handshake, the :meth:`SSLSocket.selected_npn_protocol` method will + return the agreed-upon protocol. + + This method will raise :exc:`NotImplementedError` if :data:`HAS_NPN` is + False. + + .. versionadded:: 3.3 + +.. attribute:: SSLContext.sni_callback + + Register a callback function that will be called after the TLS Client Hello + handshake message has been received by the SSL/TLS server when the TLS client + specifies a server name indication. The server name indication mechanism + is specified in :rfc:`6066` section 3 - Server Name Indication. + + Only one callback can be set per ``SSLContext``. If *sni_callback* + is set to ``None`` then the callback is disabled. Calling this function a + subsequent time will disable the previously registered callback. + + The callback function will be called with three + arguments; the first being the :class:`ssl.SSLSocket`, the second is a string + that represents the server name that the client is intending to communicate + (or :const:`None` if the TLS Client Hello does not contain a server name) + and the third argument is the original :class:`SSLContext`. The server name + argument is text. For internationalized domain name, the server + name is an IDN A-label (``"xn--pythn-mua.org"``). + + A typical use of this callback is to change the :class:`ssl.SSLSocket`'s + :attr:`SSLSocket.context` attribute to a new object of type + :class:`SSLContext` representing a certificate chain that matches the server + name. + + Due to the early negotiation phase of the TLS connection, only limited + methods and attributes are usable like + :meth:`SSLSocket.selected_alpn_protocol` and :attr:`SSLSocket.context`. + :meth:`SSLSocket.getpeercert`, :meth:`SSLSocket.getpeercert`, + :meth:`SSLSocket.cipher` and :meth:`SSLSocket.compress` methods require that + the TLS connection has progressed beyond the TLS Client Hello and therefore + will not contain return meaningful values nor can they be called safely. + + The *sni_callback* function must return ``None`` to allow the + TLS negotiation to continue. If a TLS failure is required, a constant + :const:`ALERT_DESCRIPTION_* ` can be + returned. Other return values will result in a TLS fatal error with + :const:`ALERT_DESCRIPTION_INTERNAL_ERROR`. + + If an exception is raised from the *sni_callback* function the TLS + connection will terminate with a fatal TLS alert message + :const:`ALERT_DESCRIPTION_HANDSHAKE_FAILURE`. + + This method will raise :exc:`NotImplementedError` if the OpenSSL library + had OPENSSL_NO_TLSEXT defined when it was built. + + .. versionadded:: 3.7 + +.. attribute:: SSLContext.set_servername_callback(server_name_callback) + + This is a legacy API retained for backwards compatibility. When possible, + you should use :attr:`sni_callback` instead. The given *server_name_callback* + is similar to *sni_callback*, except that when the server hostname is an + IDN-encoded internationalized domain name, the *server_name_callback* + receives a decoded U-label (``"pythön.org"``). + + If there is an decoding error on the server name, the TLS connection will + terminate with an :const:`ALERT_DESCRIPTION_INTERNAL_ERROR` fatal TLS + alert message to the client. + + .. versionadded:: 3.4 + +.. method:: SSLContext.load_dh_params(dhfile) + + Load the key generation parameters for Diffie-Hellman (DH) key exchange. + Using DH key exchange improves forward secrecy at the expense of + computational resources (both on the server and on the client). + The *dhfile* parameter should be the path to a file containing DH + parameters in PEM format. + + This setting doesn't apply to client sockets. You can also use the + :data:`OP_SINGLE_DH_USE` option to further improve security. + + .. versionadded:: 3.3 + +.. method:: SSLContext.set_ecdh_curve(curve_name) + + Set the curve name for Elliptic Curve-based Diffie-Hellman (ECDH) key + exchange. ECDH is significantly faster than regular DH while arguably + as secure. The *curve_name* parameter should be a string describing + a well-known elliptic curve, for example ``prime256v1`` for a widely + supported curve. + + This setting doesn't apply to client sockets. You can also use the + :data:`OP_SINGLE_ECDH_USE` option to further improve security. + + This method is not available if :data:`HAS_ECDH` is ``False``. + + .. versionadded:: 3.3 + + .. seealso:: + `SSL/TLS & Perfect Forward Secrecy `_ + Vincent Bernat. + +.. method:: SSLContext.wrap_socket(sock, server_side=False, \ + do_handshake_on_connect=True, suppress_ragged_eofs=True, \ + server_hostname=None, session=None) + + Wrap an existing Python socket *sock* and return an instance of + :attr:`SSLContext.sslsocket_class` (default :class:`SSLSocket`). The + returned SSL socket is tied to the context, its settings and certificates. + *sock* must be a :data:`~socket.SOCK_STREAM` socket; other + socket types are unsupported. + + The parameter ``server_side`` is a boolean which identifies whether + server-side or client-side behavior is desired from this socket. + + For client-side sockets, the context construction is lazy; if the + underlying socket isn't connected yet, the context construction will be + performed after :meth:`connect` is called on the socket. For + server-side sockets, if the socket has no remote peer, it is assumed + to be a listening socket, and the server-side SSL wrapping is + automatically performed on client connections accepted via the + :meth:`accept` method. The method may raise :exc:`SSLError`. + + On client connections, the optional parameter *server_hostname* specifies + the hostname of the service which we are connecting to. This allows a + single server to host multiple SSL-based services with distinct certificates, + quite similarly to HTTP virtual hosts. Specifying *server_hostname* will + raise a :exc:`ValueError` if *server_side* is true. + + The parameter ``do_handshake_on_connect`` specifies whether to do the SSL + handshake automatically after doing a :meth:`socket.connect`, or whether the + application program will call it explicitly, by invoking the + :meth:`SSLSocket.do_handshake` method. Calling + :meth:`SSLSocket.do_handshake` explicitly gives the program control over the + blocking behavior of the socket I/O involved in the handshake. + + The parameter ``suppress_ragged_eofs`` specifies how the + :meth:`SSLSocket.recv` method should signal unexpected EOF from the other end + of the connection. If specified as :const:`True` (the default), it returns a + normal EOF (an empty bytes object) in response to unexpected EOF errors + raised from the underlying socket; if :const:`False`, it will raise the + exceptions back to the caller. + + *session*, see :attr:`~SSLSocket.session`. + + .. versionchanged:: 3.5 + Always allow a server_hostname to be passed, even if OpenSSL does not + have SNI. + + .. versionchanged:: 3.6 + *session* argument was added. + + .. versionchanged:: 3.7 + The method returns on instance of :attr:`SSLContext.sslsocket_class` + instead of hard-coded :class:`SSLSocket`. + +.. attribute:: SSLContext.sslsocket_class + + The return type of :meth:`SSLContext.wrap_socket`, defaults to + :class:`SSLSocket`. The attribute can be overridden on instance of class + in order to return a custom subclass of :class:`SSLSocket`. + + .. versionadded:: 3.7 + +.. method:: SSLContext.wrap_bio(incoming, outgoing, server_side=False, \ + server_hostname=None, session=None) + + Wrap the BIO objects *incoming* and *outgoing* and return an instance of + :attr:`SSLContext.sslobject_class` (default :class:`SSLObject`). The SSL + routines will read input data from the incoming BIO and write data to the + outgoing BIO. + + The *server_side*, *server_hostname* and *session* parameters have the + same meaning as in :meth:`SSLContext.wrap_socket`. + + .. versionchanged:: 3.6 + *session* argument was added. + + .. versionchanged:: 3.7 + The method returns on instance of :attr:`SSLContext.sslobject_class` + instead of hard-coded :class:`SSLObject`. + +.. attribute:: SSLContext.sslobject_class + + The return type of :meth:`SSLContext.wrap_bio`, defaults to + :class:`SSLObject`. The attribute can be overridden on instance of class + in order to return a custom subclass of :class:`SSLObject`. + + .. versionadded:: 3.7 + +.. method:: SSLContext.session_stats() + + Get statistics about the SSL sessions created or managed by this context. + A dictionary is returned which maps the names of each `piece of information `_ to their + numeric values. For example, here is the total number of hits and misses + in the session cache since the context was created:: + + >>> stats = context.session_stats() + >>> stats['hits'], stats['misses'] + (0, 0) + +.. attribute:: SSLContext.check_hostname + + Whether to match the peer cert's hostname with :func:`match_hostname` in + :meth:`SSLSocket.do_handshake`. The context's + :attr:`~SSLContext.verify_mode` must be set to :data:`CERT_OPTIONAL` or + :data:`CERT_REQUIRED`, and you must pass *server_hostname* to + :meth:`~SSLContext.wrap_socket` in order to match the hostname. Enabling + hostname checking automatically sets :attr:`~SSLContext.verify_mode` from + :data:`CERT_NONE` to :data:`CERT_REQUIRED`. It cannot be set back to + :data:`CERT_NONE` as long as hostname checking is enabled. + + Example:: + + import socket, ssl + + context = ssl.SSLContext() + context.verify_mode = ssl.CERT_REQUIRED + context.check_hostname = True + context.load_default_certs() + + s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + ssl_sock = context.wrap_socket(s, server_hostname='www.verisign.com') + ssl_sock.connect(('www.verisign.com', 443)) + + .. versionadded:: 3.4 + + .. versionchanged:: 3.7 + + :attr:`~SSLContext.verify_mode` is now automatically changed + to :data:`CERT_REQUIRED` when hostname checking is enabled and + :attr:`~SSLContext.verify_mode` is :data:`CERT_NONE`. Previously + the same operation would have failed with a :exc:`ValueError`. + + .. note:: + + This features requires OpenSSL 0.9.8f or newer. + +.. attribute:: SSLContext.maximum_version + + A :class:`TLSVersion` enum member representing the highest supported + TLS version. The value defaults to :attr:`TLSVersion.MAXIMUM_SUPPORTED`. + The attribute is read-only for protocols other than :attr:`PROTOCOL_TLS`, + :attr:`PROTOCOL_TLS_CLIENT`, and :attr:`PROTOCOL_TLS_SERVER`. + + The attributes :attr:`~SSLContext.maximum_version`, + :attr:`~SSLContext.minimum_version` and + :attr:`SSLContext.options` all affect the supported SSL + and TLS versions of the context. The implementation does not prevent + invalid combination. For example a context with + :attr:`OP_NO_TLSv1_2` in :attr:`~SSLContext.options` and + :attr:`~SSLContext.maximum_version` set to :attr:`TLSVersion.TLSv1_2` + will not be able to establish a TLS 1.2 connection. + + .. note:: + + This attribute is not available unless the ssl module is compiled + with OpenSSL 1.1.0g or newer. + + .. versionadded:: 3.7 + +.. attribute:: SSLContext.minimum_version + + Like :attr:`SSLContext.maximum_version` except it is the lowest + supported version or :attr:`TLSVersion.MINIMUM_SUPPORTED`. + + .. note:: + + This attribute is not available unless the ssl module is compiled + with OpenSSL 1.1.0g or newer. + + .. versionadded:: 3.7 + +.. attribute:: SSLContext.options + + An integer representing the set of SSL options enabled on this context. + The default value is :data:`OP_ALL`, but you can specify other options + such as :data:`OP_NO_SSLv2` by ORing them together. + + .. note:: + With versions of OpenSSL older than 0.9.8m, it is only possible + to set options, not to clear them. Attempting to clear an option + (by resetting the corresponding bits) will raise a :exc:`ValueError`. + + .. versionchanged:: 3.6 + :attr:`SSLContext.options` returns :class:`Options` flags: + + >>> ssl.create_default_context().options # doctest: +SKIP + + +.. attribute:: SSLContext.post_handshake_auth + + Enable TLS 1.3 post-handshake client authentication. Post-handshake auth + is disabled by default and a server can only request a TLS client + certificate during the initial handshake. When enabled, a server may + request a TLS client certificate at any time after the handshake. + + When enabled on client-side sockets, the client signals the server that + it supports post-handshake authentication. + + When enabled on server-side sockets, :attr:`SSLContext.verify_mode` must + be set to :data:`CERT_OPTIONAL` or :data:`CERT_REQUIRED`, too. The + actual client cert exchange is delayed until + :meth:`SSLSocket.verify_client_post_handshake` is called and some I/O is + performed. + + .. note:: + Only available with OpenSSL 1.1.1 and TLS 1.3 enabled. Without TLS 1.3 + support, the property value is None and can't be modified + + .. versionadded:: 3.7.1 + +.. attribute:: SSLContext.protocol + + The protocol version chosen when constructing the context. This attribute + is read-only. + +.. attribute:: SSLContext.hostname_checks_common_name + + Whether :attr:`~SSLContext.check_hostname` falls back to verify the cert's + subject common name in the absence of a subject alternative name + extension (default: true). + + .. note:: + Only writeable with OpenSSL 1.1.0 or higher. + + .. versionadded:: 3.7 + +.. attribute:: SSLContext.verify_flags + + The flags for certificate verification operations. You can set flags like + :data:`VERIFY_CRL_CHECK_LEAF` by ORing them together. By default OpenSSL + does neither require nor verify certificate revocation lists (CRLs). + Available only with openssl version 0.9.8+. + + .. versionadded:: 3.4 + + .. versionchanged:: 3.6 + :attr:`SSLContext.verify_flags` returns :class:`VerifyFlags` flags: + + >>> ssl.create_default_context().verify_flags # doctest: +SKIP + + +.. attribute:: SSLContext.verify_mode + + Whether to try to verify other peers' certificates and how to behave + if verification fails. This attribute must be one of + :data:`CERT_NONE`, :data:`CERT_OPTIONAL` or :data:`CERT_REQUIRED`. + + .. versionchanged:: 3.6 + :attr:`SSLContext.verify_mode` returns :class:`VerifyMode` enum: + + >>> ssl.create_default_context().verify_mode + + +.. index:: single: certificates + +.. index:: single: X509 certificate + +.. _ssl-certificates: + +Certificates +------------ + +Certificates in general are part of a public-key / private-key system. In this +system, each *principal*, (which may be a machine, or a person, or an +organization) is assigned a unique two-part encryption key. One part of the key +is public, and is called the *public key*; the other part is kept secret, and is +called the *private key*. The two parts are related, in that if you encrypt a +message with one of the parts, you can decrypt it with the other part, and +**only** with the other part. + +A certificate contains information about two principals. It contains the name +of a *subject*, and the subject's public key. It also contains a statement by a +second principal, the *issuer*, that the subject is who they claim to be, and +that this is indeed the subject's public key. The issuer's statement is signed +with the issuer's private key, which only the issuer knows. However, anyone can +verify the issuer's statement by finding the issuer's public key, decrypting the +statement with it, and comparing it to the other information in the certificate. +The certificate also contains information about the time period over which it is +valid. This is expressed as two fields, called "notBefore" and "notAfter". + +In the Python use of certificates, a client or server can use a certificate to +prove who they are. The other side of a network connection can also be required +to produce a certificate, and that certificate can be validated to the +satisfaction of the client or server that requires such validation. The +connection attempt can be set to raise an exception if the validation fails. +Validation is done automatically, by the underlying OpenSSL framework; the +application need not concern itself with its mechanics. But the application +does usually need to provide sets of certificates to allow this process to take +place. + +Python uses files to contain certificates. They should be formatted as "PEM" +(see :rfc:`1422`), which is a base-64 encoded form wrapped with a header line +and a footer line:: + + -----BEGIN CERTIFICATE----- + ... (certificate in base64 PEM encoding) ... + -----END CERTIFICATE----- + +Certificate chains +^^^^^^^^^^^^^^^^^^ + +The Python files which contain certificates can contain a sequence of +certificates, sometimes called a *certificate chain*. This chain should start +with the specific certificate for the principal who "is" the client or server, +and then the certificate for the issuer of that certificate, and then the +certificate for the issuer of *that* certificate, and so on up the chain till +you get to a certificate which is *self-signed*, that is, a certificate which +has the same subject and issuer, sometimes called a *root certificate*. The +certificates should just be concatenated together in the certificate file. For +example, suppose we had a three certificate chain, from our server certificate +to the certificate of the certification authority that signed our server +certificate, to the root certificate of the agency which issued the +certification authority's certificate:: + + -----BEGIN CERTIFICATE----- + ... (certificate for your server)... + -----END CERTIFICATE----- + -----BEGIN CERTIFICATE----- + ... (the certificate for the CA)... + -----END CERTIFICATE----- + -----BEGIN CERTIFICATE----- + ... (the root certificate for the CA's issuer)... + -----END CERTIFICATE----- + +CA certificates +^^^^^^^^^^^^^^^ + +If you are going to require validation of the other side of the connection's +certificate, you need to provide a "CA certs" file, filled with the certificate +chains for each issuer you are willing to trust. Again, this file just contains +these chains concatenated together. For validation, Python will use the first +chain it finds in the file which matches. The platform's certificates file can +be used by calling :meth:`SSLContext.load_default_certs`, this is done +automatically with :func:`.create_default_context`. + +Combined key and certificate +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Often the private key is stored in the same file as the certificate; in this +case, only the ``certfile`` parameter to :meth:`SSLContext.load_cert_chain` +and :func:`wrap_socket` needs to be passed. If the private key is stored +with the certificate, it should come before the first certificate in +the certificate chain:: + + -----BEGIN RSA PRIVATE KEY----- + ... (private key in base64 encoding) ... + -----END RSA PRIVATE KEY----- + -----BEGIN CERTIFICATE----- + ... (certificate in base64 PEM encoding) ... + -----END CERTIFICATE----- + +Self-signed certificates +^^^^^^^^^^^^^^^^^^^^^^^^ + +If you are going to create a server that provides SSL-encrypted connection +services, you will need to acquire a certificate for that service. There are +many ways of acquiring appropriate certificates, such as buying one from a +certification authority. Another common practice is to generate a self-signed +certificate. The simplest way to do this is with the OpenSSL package, using +something like the following:: + + % openssl req -new -x509 -days 365 -nodes -out cert.pem -keyout cert.pem + Generating a 1024 bit RSA private key + .......++++++ + .............................++++++ + writing new private key to 'cert.pem' + ----- + You are about to be asked to enter information that will be incorporated + into your certificate request. + What you are about to enter is what is called a Distinguished Name or a DN. + There are quite a few fields but you can leave some blank + For some fields there will be a default value, + If you enter '.', the field will be left blank. + ----- + Country Name (2 letter code) [AU]:US + State or Province Name (full name) [Some-State]:MyState + Locality Name (eg, city) []:Some City + Organization Name (eg, company) [Internet Widgits Pty Ltd]:My Organization, Inc. + Organizational Unit Name (eg, section) []:My Group + Common Name (eg, YOUR name) []:myserver.mygroup.myorganization.com + Email Address []:ops@myserver.mygroup.myorganization.com + % + +The disadvantage of a self-signed certificate is that it is its own root +certificate, and no one else will have it in their cache of known (and trusted) +root certificates. + + +Examples +-------- + +Testing for SSL support +^^^^^^^^^^^^^^^^^^^^^^^ + +To test for the presence of SSL support in a Python installation, user code +should use the following idiom:: + + try: + import ssl + except ImportError: + pass + else: + ... # do something that requires SSL support + +Client-side operation +^^^^^^^^^^^^^^^^^^^^^ + +This example creates a SSL context with the recommended security settings +for client sockets, including automatic certificate verification:: + + >>> context = ssl.create_default_context() + +If you prefer to tune security settings yourself, you might create +a context from scratch (but beware that you might not get the settings +right):: + + >>> context = ssl.SSLContext() + >>> context.verify_mode = ssl.CERT_REQUIRED + >>> context.check_hostname = True + >>> context.load_verify_locations("/etc/ssl/certs/ca-bundle.crt") + +(this snippet assumes your operating system places a bundle of all CA +certificates in ``/etc/ssl/certs/ca-bundle.crt``; if not, you'll get an +error and have to adjust the location) + +When you use the context to connect to a server, :const:`CERT_REQUIRED` +validates the server certificate: it ensures that the server certificate +was signed with one of the CA certificates, and checks the signature for +correctness:: + + >>> conn = context.wrap_socket(socket.socket(socket.AF_INET), + ... server_hostname="www.python.org") + >>> conn.connect(("www.python.org", 443)) + +You may then fetch the certificate:: + + >>> cert = conn.getpeercert() + +Visual inspection shows that the certificate does identify the desired service +(that is, the HTTPS host ``www.python.org``):: + + >>> pprint.pprint(cert) + {'OCSP': ('http://ocsp.digicert.com',), + 'caIssuers': ('http://cacerts.digicert.com/DigiCertSHA2ExtendedValidationServerCA.crt',), + 'crlDistributionPoints': ('http://crl3.digicert.com/sha2-ev-server-g1.crl', + 'http://crl4.digicert.com/sha2-ev-server-g1.crl'), + 'issuer': ((('countryName', 'US'),), + (('organizationName', 'DigiCert Inc'),), + (('organizationalUnitName', 'www.digicert.com'),), + (('commonName', 'DigiCert SHA2 Extended Validation Server CA'),)), + 'notAfter': 'Sep 9 12:00:00 2016 GMT', + 'notBefore': 'Sep 5 00:00:00 2014 GMT', + 'serialNumber': '01BB6F00122B177F36CAB49CEA8B6B26', + 'subject': ((('businessCategory', 'Private Organization'),), + (('1.3.6.1.4.1.311.60.2.1.3', 'US'),), + (('1.3.6.1.4.1.311.60.2.1.2', 'Delaware'),), + (('serialNumber', '3359300'),), + (('streetAddress', '16 Allen Rd'),), + (('postalCode', '03894-4801'),), + (('countryName', 'US'),), + (('stateOrProvinceName', 'NH'),), + (('localityName', 'Wolfeboro,'),), + (('organizationName', 'Python Software Foundation'),), + (('commonName', 'www.python.org'),)), + 'subjectAltName': (('DNS', 'www.python.org'), + ('DNS', 'python.org'), + ('DNS', 'pypi.org'), + ('DNS', 'docs.python.org'), + ('DNS', 'testpypi.org'), + ('DNS', 'bugs.python.org'), + ('DNS', 'wiki.python.org'), + ('DNS', 'hg.python.org'), + ('DNS', 'mail.python.org'), + ('DNS', 'packaging.python.org'), + ('DNS', 'pythonhosted.org'), + ('DNS', 'www.pythonhosted.org'), + ('DNS', 'test.pythonhosted.org'), + ('DNS', 'us.pycon.org'), + ('DNS', 'id.python.org')), + 'version': 3} + +Now the SSL channel is established and the certificate verified, you can +proceed to talk with the server:: + + >>> conn.sendall(b"HEAD / HTTP/1.0\r\nHost: linuxfr.org\r\n\r\n") + >>> pprint.pprint(conn.recv(1024).split(b"\r\n")) + [b'HTTP/1.1 200 OK', + b'Date: Sat, 18 Oct 2014 18:27:20 GMT', + b'Server: nginx', + b'Content-Type: text/html; charset=utf-8', + b'X-Frame-Options: SAMEORIGIN', + b'Content-Length: 45679', + b'Accept-Ranges: bytes', + b'Via: 1.1 varnish', + b'Age: 2188', + b'X-Served-By: cache-lcy1134-LCY', + b'X-Cache: HIT', + b'X-Cache-Hits: 11', + b'Vary: Cookie', + b'Strict-Transport-Security: max-age=63072000; includeSubDomains', + b'Connection: close', + b'', + b''] + +See the discussion of :ref:`ssl-security` below. + + +Server-side operation +^^^^^^^^^^^^^^^^^^^^^ + +For server operation, typically you'll need to have a server certificate, and +private key, each in a file. You'll first create a context holding the key +and the certificate, so that clients can check your authenticity. Then +you'll open a socket, bind it to a port, call :meth:`listen` on it, and start +waiting for clients to connect:: + + import socket, ssl + + context = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH) + context.load_cert_chain(certfile="mycertfile", keyfile="mykeyfile") + + bindsocket = socket.socket() + bindsocket.bind(('myaddr.mydomain.com', 10023)) + bindsocket.listen(5) + +When a client connects, you'll call :meth:`accept` on the socket to get the +new socket from the other end, and use the context's :meth:`SSLContext.wrap_socket` +method to create a server-side SSL socket for the connection:: + + while True: + newsocket, fromaddr = bindsocket.accept() + connstream = context.wrap_socket(newsocket, server_side=True) + try: + deal_with_client(connstream) + finally: + connstream.shutdown(socket.SHUT_RDWR) + connstream.close() + +Then you'll read data from the ``connstream`` and do something with it till you +are finished with the client (or the client is finished with you):: + + def deal_with_client(connstream): + data = connstream.recv(1024) + # empty data means the client is finished with us + while data: + if not do_something(connstream, data): + # we'll assume do_something returns False + # when we're finished with client + break + data = connstream.recv(1024) + # finished with client + +And go back to listening for new client connections (of course, a real server +would probably handle each client connection in a separate thread, or put +the sockets in :ref:`non-blocking mode ` and use an event loop). + + +.. _ssl-nonblocking: + +Notes on non-blocking sockets +----------------------------- + +SSL sockets behave slightly different than regular sockets in +non-blocking mode. When working with non-blocking sockets, there are +thus several things you need to be aware of: + +- Most :class:`SSLSocket` methods will raise either + :exc:`SSLWantWriteError` or :exc:`SSLWantReadError` instead of + :exc:`BlockingIOError` if an I/O operation would + block. :exc:`SSLWantReadError` will be raised if a read operation on + the underlying socket is necessary, and :exc:`SSLWantWriteError` for + a write operation on the underlying socket. Note that attempts to + *write* to an SSL socket may require *reading* from the underlying + socket first, and attempts to *read* from the SSL socket may require + a prior *write* to the underlying socket. + + .. versionchanged:: 3.5 + + In earlier Python versions, the :meth:`!SSLSocket.send` method + returned zero instead of raising :exc:`SSLWantWriteError` or + :exc:`SSLWantReadError`. + +- Calling :func:`~select.select` tells you that the OS-level socket can be + read from (or written to), but it does not imply that there is sufficient + data at the upper SSL layer. For example, only part of an SSL frame might + have arrived. Therefore, you must be ready to handle :meth:`SSLSocket.recv` + and :meth:`SSLSocket.send` failures, and retry after another call to + :func:`~select.select`. + +- Conversely, since the SSL layer has its own framing, a SSL socket may + still have data available for reading without :func:`~select.select` + being aware of it. Therefore, you should first call + :meth:`SSLSocket.recv` to drain any potentially available data, and then + only block on a :func:`~select.select` call if still necessary. + + (of course, similar provisions apply when using other primitives such as + :func:`~select.poll`, or those in the :mod:`selectors` module) + +- The SSL handshake itself will be non-blocking: the + :meth:`SSLSocket.do_handshake` method has to be retried until it returns + successfully. Here is a synopsis using :func:`~select.select` to wait for + the socket's readiness:: + + while True: + try: + sock.do_handshake() + break + except ssl.SSLWantReadError: + select.select([sock], [], []) + except ssl.SSLWantWriteError: + select.select([], [sock], []) + +.. seealso:: + + The :mod:`asyncio` module supports :ref:`non-blocking SSL sockets + ` and provides a + higher level API. It polls for events using the :mod:`selectors` module and + handles :exc:`SSLWantWriteError`, :exc:`SSLWantReadError` and + :exc:`BlockingIOError` exceptions. It runs the SSL handshake asynchronously + as well. + + +Memory BIO Support +------------------ + +.. versionadded:: 3.5 + +Ever since the SSL module was introduced in Python 2.6, the :class:`SSLSocket` +class has provided two related but distinct areas of functionality: + +- SSL protocol handling +- Network IO + +The network IO API is identical to that provided by :class:`socket.socket`, +from which :class:`SSLSocket` also inherits. This allows an SSL socket to be +used as a drop-in replacement for a regular socket, making it very easy to add +SSL support to an existing application. + +Combining SSL protocol handling and network IO usually works well, but there +are some cases where it doesn't. An example is async IO frameworks that want to +use a different IO multiplexing model than the "select/poll on a file +descriptor" (readiness based) model that is assumed by :class:`socket.socket` +and by the internal OpenSSL socket IO routines. This is mostly relevant for +platforms like Windows where this model is not efficient. For this purpose, a +reduced scope variant of :class:`SSLSocket` called :class:`SSLObject` is +provided. + +.. class:: SSLObject + + A reduced-scope variant of :class:`SSLSocket` representing an SSL protocol + instance that does not contain any network IO methods. This class is + typically used by framework authors that want to implement asynchronous IO + for SSL through memory buffers. + + This class implements an interface on top of a low-level SSL object as + implemented by OpenSSL. This object captures the state of an SSL connection + but does not provide any network IO itself. IO needs to be performed through + separate "BIO" objects which are OpenSSL's IO abstraction layer. + + This class has no public constructor. An :class:`SSLObject` instance + must be created using the :meth:`~SSLContext.wrap_bio` method. This + method will create the :class:`SSLObject` instance and bind it to a + pair of BIOs. The *incoming* BIO is used to pass data from Python to the + SSL protocol instance, while the *outgoing* BIO is used to pass data the + other way around. + + The following methods are available: + + - :attr:`~SSLSocket.context` + - :attr:`~SSLSocket.server_side` + - :attr:`~SSLSocket.server_hostname` + - :attr:`~SSLSocket.session` + - :attr:`~SSLSocket.session_reused` + - :meth:`~SSLSocket.read` + - :meth:`~SSLSocket.write` + - :meth:`~SSLSocket.getpeercert` + - :meth:`~SSLSocket.selected_npn_protocol` + - :meth:`~SSLSocket.cipher` + - :meth:`~SSLSocket.shared_ciphers` + - :meth:`~SSLSocket.compression` + - :meth:`~SSLSocket.pending` + - :meth:`~SSLSocket.do_handshake` + - :meth:`~SSLSocket.unwrap` + - :meth:`~SSLSocket.get_channel_binding` + + When compared to :class:`SSLSocket`, this object lacks the following + features: + + - Any form of network IO; ``recv()`` and ``send()`` read and write only to + the underlying :class:`MemoryBIO` buffers. + + - There is no *do_handshake_on_connect* machinery. You must always manually + call :meth:`~SSLSocket.do_handshake` to start the handshake. + + - There is no handling of *suppress_ragged_eofs*. All end-of-file conditions + that are in violation of the protocol are reported via the + :exc:`SSLEOFError` exception. + + - The method :meth:`~SSLSocket.unwrap` call does not return anything, + unlike for an SSL socket where it returns the underlying socket. + + - The *server_name_callback* callback passed to + :meth:`SSLContext.set_servername_callback` will get an :class:`SSLObject` + instance instead of a :class:`SSLSocket` instance as its first parameter. + + Some notes related to the use of :class:`SSLObject`: + + - All IO on an :class:`SSLObject` is :ref:`non-blocking `. + This means that for example :meth:`~SSLSocket.read` will raise an + :exc:`SSLWantReadError` if it needs more data than the incoming BIO has + available. + + - There is no module-level ``wrap_bio()`` call like there is for + :meth:`~SSLContext.wrap_socket`. An :class:`SSLObject` is always created + via an :class:`SSLContext`. + + .. versionchanged:: 3.7 + :class:`SSLObject` instances must to created with + :meth:`~SSLContext.wrap_bio`. In earlier versions, it was possible to + create instances directly. This was never documented or officially + supported. + +An SSLObject communicates with the outside world using memory buffers. The +class :class:`MemoryBIO` provides a memory buffer that can be used for this +purpose. It wraps an OpenSSL memory BIO (Basic IO) object: + +.. class:: MemoryBIO + + A memory buffer that can be used to pass data between Python and an SSL + protocol instance. + + .. attribute:: MemoryBIO.pending + + Return the number of bytes currently in the memory buffer. + + .. attribute:: MemoryBIO.eof + + A boolean indicating whether the memory BIO is current at the end-of-file + position. + + .. method:: MemoryBIO.read(n=-1) + + Read up to *n* bytes from the memory buffer. If *n* is not specified or + negative, all bytes are returned. + + .. method:: MemoryBIO.write(buf) + + Write the bytes from *buf* to the memory BIO. The *buf* argument must be an + object supporting the buffer protocol. + + The return value is the number of bytes written, which is always equal to + the length of *buf*. + + .. method:: MemoryBIO.write_eof() + + Write an EOF marker to the memory BIO. After this method has been called, it + is illegal to call :meth:`~MemoryBIO.write`. The attribute :attr:`eof` will + become true after all data currently in the buffer has been read. + + +SSL session +----------- + +.. versionadded:: 3.6 + +.. class:: SSLSession + + Session object used by :attr:`~SSLSocket.session`. + + .. attribute:: id + .. attribute:: time + .. attribute:: timeout + .. attribute:: ticket_lifetime_hint + .. attribute:: has_ticket + + +.. _ssl-security: + +Security considerations +----------------------- + +Best defaults +^^^^^^^^^^^^^ + +For **client use**, if you don't have any special requirements for your +security policy, it is highly recommended that you use the +:func:`create_default_context` function to create your SSL context. +It will load the system's trusted CA certificates, enable certificate +validation and hostname checking, and try to choose reasonably secure +protocol and cipher settings. + +For example, here is how you would use the :class:`smtplib.SMTP` class to +create a trusted, secure connection to a SMTP server:: + + >>> import ssl, smtplib + >>> smtp = smtplib.SMTP("mail.python.org", port=587) + >>> context = ssl.create_default_context() + >>> smtp.starttls(context=context) + (220, b'2.0.0 Ready to start TLS') + +If a client certificate is needed for the connection, it can be added with +:meth:`SSLContext.load_cert_chain`. + +By contrast, if you create the SSL context by calling the :class:`SSLContext` +constructor yourself, it will not have certificate validation nor hostname +checking enabled by default. If you do so, please read the paragraphs below +to achieve a good security level. + +Manual settings +^^^^^^^^^^^^^^^ + +Verifying certificates +'''''''''''''''''''''' + +When calling the :class:`SSLContext` constructor directly, +:const:`CERT_NONE` is the default. Since it does not authenticate the other +peer, it can be insecure, especially in client mode where most of time you +would like to ensure the authenticity of the server you're talking to. +Therefore, when in client mode, it is highly recommended to use +:const:`CERT_REQUIRED`. However, it is in itself not sufficient; you also +have to check that the server certificate, which can be obtained by calling +:meth:`SSLSocket.getpeercert`, matches the desired service. For many +protocols and applications, the service can be identified by the hostname; +in this case, the :func:`match_hostname` function can be used. This common +check is automatically performed when :attr:`SSLContext.check_hostname` is +enabled. + +.. versionchanged:: 3.7 + Hostname matchings is now performed by OpenSSL. Python no longer uses + :func:`match_hostname`. + +In server mode, if you want to authenticate your clients using the SSL layer +(rather than using a higher-level authentication mechanism), you'll also have +to specify :const:`CERT_REQUIRED` and similarly check the client certificate. + + +Protocol versions +''''''''''''''''' + +SSL versions 2 and 3 are considered insecure and are therefore dangerous to +use. If you want maximum compatibility between clients and servers, it is +recommended to use :const:`PROTOCOL_TLS_CLIENT` or +:const:`PROTOCOL_TLS_SERVER` as the protocol version. SSLv2 and SSLv3 are +disabled by default. + +:: + + >>> client_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT) + >>> client_context.options |= ssl.OP_NO_TLSv1 + >>> client_context.options |= ssl.OP_NO_TLSv1_1 + + +The SSL context created above will only allow TLSv1.2 and later (if +supported by your system) connections to a server. :const:`PROTOCOL_TLS_CLIENT` +implies certificate validation and hostname checks by default. You have to +load certificates into the context. + + +Cipher selection +'''''''''''''''' + +If you have advanced security requirements, fine-tuning of the ciphers +enabled when negotiating a SSL session is possible through the +:meth:`SSLContext.set_ciphers` method. Starting from Python 3.2.3, the +ssl module disables certain weak ciphers by default, but you may want +to further restrict the cipher choice. Be sure to read OpenSSL's documentation +about the `cipher list format `_. +If you want to check which ciphers are enabled by a given cipher list, use +:meth:`SSLContext.get_ciphers` or the ``openssl ciphers`` command on your +system. + +Multi-processing +^^^^^^^^^^^^^^^^ + +If using this module as part of a multi-processed application (using, +for example the :mod:`multiprocessing` or :mod:`concurrent.futures` modules), +be aware that OpenSSL's internal random number generator does not properly +handle forked processes. Applications must change the PRNG state of the +parent process if they use any SSL feature with :func:`os.fork`. Any +successful call of :func:`~ssl.RAND_add`, :func:`~ssl.RAND_bytes` or +:func:`~ssl.RAND_pseudo_bytes` is sufficient. + + +.. _ssl-tlsv1_3: + +TLS 1.3 +------- + +.. versionadded:: 3.7 + +Python has provisional and experimental support for TLS 1.3 with OpenSSL +1.1.1. The new protocol behaves slightly differently than previous version +of TLS/SSL. Some new TLS 1.3 features are not yet available. + +- TLS 1.3 uses a disjunct set of cipher suites. All AES-GCM and + ChaCha20 cipher suites are enabled by default. The method + :meth:`SSLContext.set_ciphers` cannot enable or disable any TLS 1.3 + ciphers yet, but :meth:`SSLContext.get_ciphers` returns them. +- Session tickets are no longer sent as part of the initial handshake and + are handled differently. :attr:`SSLSocket.session` and :class:`SSLSession` + are not compatible with TLS 1.3. +- Client-side certificates are also no longer verified during the initial + handshake. A server can request a certificate at any time. Clients + process certificate requests while they send or receive application data + from the server. +- TLS 1.3 features like early data, deferred TLS client cert request, + signature algorithm configuration, and rekeying are not supported yet. + + +.. _ssl-libressl: + +LibreSSL support +---------------- + +LibreSSL is a fork of OpenSSL 1.0.1. The ssl module has limited support for +LibreSSL. Some features are not available when the ssl module is compiled +with LibreSSL. + +* LibreSSL >= 2.6.1 no longer supports NPN. The methods + :meth:`SSLContext.set_npn_protocols` and + :meth:`SSLSocket.selected_npn_protocol` are not available. +* :meth:`SSLContext.set_default_verify_paths` ignores the env vars + :envvar:`SSL_CERT_FILE` and :envvar:`SSL_CERT_PATH` although + :func:`get_default_verify_paths` still reports them. + + +.. seealso:: + + Class :class:`socket.socket` + Documentation of underlying :mod:`socket` class + + `SSL/TLS Strong Encryption: An Introduction `_ + Intro from the Apache HTTP Server documentation + + :rfc:`RFC 1422: Privacy Enhancement for Internet Electronic Mail: Part II: Certificate-Based Key Management <1422>` + Steve Kent + + :rfc:`RFC 4086: Randomness Requirements for Security <4086>` + Donald E., Jeffrey I. Schiller + + :rfc:`RFC 5280: Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile <5280>` + D. Cooper + + :rfc:`RFC 5246: The Transport Layer Security (TLS) Protocol Version 1.2 <5246>` + T. Dierks et. al. + + :rfc:`RFC 6066: Transport Layer Security (TLS) Extensions <6066>` + D. Eastlake + + `IANA TLS: Transport Layer Security (TLS) Parameters `_ + IANA + + :rfc:`RFC 7525: Recommendations for Secure Use of Transport Layer Security (TLS) and Datagram Transport Layer Security (DTLS) <7525>` + IETF + + `Mozilla's Server Side TLS recommendations `_ + Mozilla diff --git a/python-3.7.4-docs-html/_sources/library/stat.rst.txt b/python-3.7.4-docs-html/_sources/library/stat.rst.txt new file mode 100644 index 0000000..c8f6904 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/stat.rst.txt @@ -0,0 +1,427 @@ +:mod:`stat` --- Interpreting :func:`~os.stat` results +===================================================== + +.. module:: stat + :synopsis: Utilities for interpreting the results of os.stat(), + os.lstat() and os.fstat(). + +.. sectionauthor:: Skip Montanaro + +**Source code:** :source:`Lib/stat.py` + +-------------- + +The :mod:`stat` module defines constants and functions for interpreting the +results of :func:`os.stat`, :func:`os.fstat` and :func:`os.lstat` (if they +exist). For complete details about the :c:func:`stat`, :c:func:`fstat` and +:c:func:`lstat` calls, consult the documentation for your system. + +.. versionchanged:: 3.4 + The stat module is backed by a C implementation. + +The :mod:`stat` module defines the following functions to test for specific file +types: + + +.. function:: S_ISDIR(mode) + + Return non-zero if the mode is from a directory. + + +.. function:: S_ISCHR(mode) + + Return non-zero if the mode is from a character special device file. + + +.. function:: S_ISBLK(mode) + + Return non-zero if the mode is from a block special device file. + + +.. function:: S_ISREG(mode) + + Return non-zero if the mode is from a regular file. + + +.. function:: S_ISFIFO(mode) + + Return non-zero if the mode is from a FIFO (named pipe). + + +.. function:: S_ISLNK(mode) + + Return non-zero if the mode is from a symbolic link. + + +.. function:: S_ISSOCK(mode) + + Return non-zero if the mode is from a socket. + +.. function:: S_ISDOOR(mode) + + Return non-zero if the mode is from a door. + + .. versionadded:: 3.4 + +.. function:: S_ISPORT(mode) + + Return non-zero if the mode is from an event port. + + .. versionadded:: 3.4 + +.. function:: S_ISWHT(mode) + + Return non-zero if the mode is from a whiteout. + + .. versionadded:: 3.4 + +Two additional functions are defined for more general manipulation of the file's +mode: + + +.. function:: S_IMODE(mode) + + Return the portion of the file's mode that can be set by + :func:`os.chmod`\ ---that is, the file's permission bits, plus the sticky + bit, set-group-id, and set-user-id bits (on systems that support them). + + +.. function:: S_IFMT(mode) + + Return the portion of the file's mode that describes the file type (used by the + :func:`S_IS\*` functions above). + +Normally, you would use the :func:`os.path.is\*` functions for testing the type +of a file; the functions here are useful when you are doing multiple tests of +the same file and wish to avoid the overhead of the :c:func:`stat` system call +for each test. These are also useful when checking for information about a file +that isn't handled by :mod:`os.path`, like the tests for block and character +devices. + +Example:: + + import os, sys + from stat import * + + def walktree(top, callback): + '''recursively descend the directory tree rooted at top, + calling the callback function for each regular file''' + + for f in os.listdir(top): + pathname = os.path.join(top, f) + mode = os.stat(pathname).st_mode + if S_ISDIR(mode): + # It's a directory, recurse into it + walktree(pathname, callback) + elif S_ISREG(mode): + # It's a file, call the callback function + callback(pathname) + else: + # Unknown file type, print a message + print('Skipping %s' % pathname) + + def visitfile(file): + print('visiting', file) + + if __name__ == '__main__': + walktree(sys.argv[1], visitfile) + +An additional utility function is provided to convert a file's mode in a human +readable string: + +.. function:: filemode(mode) + + Convert a file's mode to a string of the form '-rwxrwxrwx'. + + .. versionadded:: 3.3 + + .. versionchanged:: 3.4 + The function supports :data:`S_IFDOOR`, :data:`S_IFPORT` and + :data:`S_IFWHT`. + + +All the variables below are simply symbolic indexes into the 10-tuple returned +by :func:`os.stat`, :func:`os.fstat` or :func:`os.lstat`. + + +.. data:: ST_MODE + + Inode protection mode. + + +.. data:: ST_INO + + Inode number. + + +.. data:: ST_DEV + + Device inode resides on. + + +.. data:: ST_NLINK + + Number of links to the inode. + + +.. data:: ST_UID + + User id of the owner. + + +.. data:: ST_GID + + Group id of the owner. + + +.. data:: ST_SIZE + + Size in bytes of a plain file; amount of data waiting on some special files. + + +.. data:: ST_ATIME + + Time of last access. + + +.. data:: ST_MTIME + + Time of last modification. + + +.. data:: ST_CTIME + + The "ctime" as reported by the operating system. On some systems (like Unix) is + the time of the last metadata change, and, on others (like Windows), is the + creation time (see platform documentation for details). + +The interpretation of "file size" changes according to the file type. For plain +files this is the size of the file in bytes. For FIFOs and sockets under most +flavors of Unix (including Linux in particular), the "size" is the number of +bytes waiting to be read at the time of the call to :func:`os.stat`, +:func:`os.fstat`, or :func:`os.lstat`; this can sometimes be useful, especially +for polling one of these special files after a non-blocking open. The meaning +of the size field for other character and block devices varies more, depending +on the implementation of the underlying system call. + +The variables below define the flags used in the :data:`ST_MODE` field. + +Use of the functions above is more portable than use of the first set of flags: + +.. data:: S_IFSOCK + + Socket. + +.. data:: S_IFLNK + + Symbolic link. + +.. data:: S_IFREG + + Regular file. + +.. data:: S_IFBLK + + Block device. + +.. data:: S_IFDIR + + Directory. + +.. data:: S_IFCHR + + Character device. + +.. data:: S_IFIFO + + FIFO. + +.. data:: S_IFDOOR + + Door. + + .. versionadded:: 3.4 + +.. data:: S_IFPORT + + Event port. + + .. versionadded:: 3.4 + +.. data:: S_IFWHT + + Whiteout. + + .. versionadded:: 3.4 + +.. note:: + + :data:`S_IFDOOR`, :data:`S_IFPORT` or :data:`S_IFWHT` are defined as + 0 when the platform does not have support for the file types. + +The following flags can also be used in the *mode* argument of :func:`os.chmod`: + +.. data:: S_ISUID + + Set UID bit. + +.. data:: S_ISGID + + Set-group-ID bit. This bit has several special uses. For a directory + it indicates that BSD semantics is to be used for that directory: + files created there inherit their group ID from the directory, not + from the effective group ID of the creating process, and directories + created there will also get the :data:`S_ISGID` bit set. For a + file that does not have the group execution bit (:data:`S_IXGRP`) + set, the set-group-ID bit indicates mandatory file/record locking + (see also :data:`S_ENFMT`). + +.. data:: S_ISVTX + + Sticky bit. When this bit is set on a directory it means that a file + in that directory can be renamed or deleted only by the owner of the + file, by the owner of the directory, or by a privileged process. + +.. data:: S_IRWXU + + Mask for file owner permissions. + +.. data:: S_IRUSR + + Owner has read permission. + +.. data:: S_IWUSR + + Owner has write permission. + +.. data:: S_IXUSR + + Owner has execute permission. + +.. data:: S_IRWXG + + Mask for group permissions. + +.. data:: S_IRGRP + + Group has read permission. + +.. data:: S_IWGRP + + Group has write permission. + +.. data:: S_IXGRP + + Group has execute permission. + +.. data:: S_IRWXO + + Mask for permissions for others (not in group). + +.. data:: S_IROTH + + Others have read permission. + +.. data:: S_IWOTH + + Others have write permission. + +.. data:: S_IXOTH + + Others have execute permission. + +.. data:: S_ENFMT + + System V file locking enforcement. This flag is shared with :data:`S_ISGID`: + file/record locking is enforced on files that do not have the group + execution bit (:data:`S_IXGRP`) set. + +.. data:: S_IREAD + + Unix V7 synonym for :data:`S_IRUSR`. + +.. data:: S_IWRITE + + Unix V7 synonym for :data:`S_IWUSR`. + +.. data:: S_IEXEC + + Unix V7 synonym for :data:`S_IXUSR`. + +The following flags can be used in the *flags* argument of :func:`os.chflags`: + +.. data:: UF_NODUMP + + Do not dump the file. + +.. data:: UF_IMMUTABLE + + The file may not be changed. + +.. data:: UF_APPEND + + The file may only be appended to. + +.. data:: UF_OPAQUE + + The directory is opaque when viewed through a union stack. + +.. data:: UF_NOUNLINK + + The file may not be renamed or deleted. + +.. data:: UF_COMPRESSED + + The file is stored compressed (Mac OS X 10.6+). + +.. data:: UF_HIDDEN + + The file should not be displayed in a GUI (Mac OS X 10.5+). + +.. data:: SF_ARCHIVED + + The file may be archived. + +.. data:: SF_IMMUTABLE + + The file may not be changed. + +.. data:: SF_APPEND + + The file may only be appended to. + +.. data:: SF_NOUNLINK + + The file may not be renamed or deleted. + +.. data:: SF_SNAPSHOT + + The file is a snapshot file. + +See the \*BSD or Mac OS systems man page :manpage:`chflags(2)` for more information. + +On Windows, the following file attribute constants are available for use when +testing bits in the ``st_file_attributes`` member returned by :func:`os.stat`. +See the `Windows API documentation +`_ +for more detail on the meaning of these constants. + +.. data:: FILE_ATTRIBUTE_ARCHIVE + FILE_ATTRIBUTE_COMPRESSED + FILE_ATTRIBUTE_DEVICE + FILE_ATTRIBUTE_DIRECTORY + FILE_ATTRIBUTE_ENCRYPTED + FILE_ATTRIBUTE_HIDDEN + FILE_ATTRIBUTE_INTEGRITY_STREAM + FILE_ATTRIBUTE_NORMAL + FILE_ATTRIBUTE_NOT_CONTENT_INDEXED + FILE_ATTRIBUTE_NO_SCRUB_DATA + FILE_ATTRIBUTE_OFFLINE + FILE_ATTRIBUTE_READONLY + FILE_ATTRIBUTE_REPARSE_POINT + FILE_ATTRIBUTE_SPARSE_FILE + FILE_ATTRIBUTE_SYSTEM + FILE_ATTRIBUTE_TEMPORARY + FILE_ATTRIBUTE_VIRTUAL + + .. versionadded:: 3.5 diff --git a/python-3.7.4-docs-html/_sources/library/statistics.rst.txt b/python-3.7.4-docs-html/_sources/library/statistics.rst.txt new file mode 100644 index 0000000..26bb592 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/statistics.rst.txt @@ -0,0 +1,454 @@ +:mod:`statistics` --- Mathematical statistics functions +======================================================= + +.. module:: statistics + :synopsis: mathematical statistics functions + +.. moduleauthor:: Steven D'Aprano +.. sectionauthor:: Steven D'Aprano + +.. versionadded:: 3.4 + +**Source code:** :source:`Lib/statistics.py` + +.. testsetup:: * + + from statistics import * + __name__ = '' + +-------------- + +This module provides functions for calculating mathematical statistics of +numeric (:class:`Real`-valued) data. + +.. note:: + + Unless explicitly noted otherwise, these functions support :class:`int`, + :class:`float`, :class:`decimal.Decimal` and :class:`fractions.Fraction`. + Behaviour with other types (whether in the numeric tower or not) is + currently unsupported. Mixed types are also undefined and + implementation-dependent. If your input data consists of mixed types, + you may be able to use :func:`map` to ensure a consistent result, e.g. + ``map(float, input_data)``. + +Averages and measures of central location +----------------------------------------- + +These functions calculate an average or typical value from a population +or sample. + +======================= ============================================= +:func:`mean` Arithmetic mean ("average") of data. +:func:`harmonic_mean` Harmonic mean of data. +:func:`median` Median (middle value) of data. +:func:`median_low` Low median of data. +:func:`median_high` High median of data. +:func:`median_grouped` Median, or 50th percentile, of grouped data. +:func:`mode` Mode (most common value) of discrete data. +======================= ============================================= + +Measures of spread +------------------ + +These functions calculate a measure of how much the population or sample +tends to deviate from the typical or average values. + +======================= ============================================= +:func:`pstdev` Population standard deviation of data. +:func:`pvariance` Population variance of data. +:func:`stdev` Sample standard deviation of data. +:func:`variance` Sample variance of data. +======================= ============================================= + + +Function details +---------------- + +Note: The functions do not require the data given to them to be sorted. +However, for reading convenience, most of the examples show sorted sequences. + +.. function:: mean(data) + + Return the sample arithmetic mean of *data* which can be a sequence or iterator. + + The arithmetic mean is the sum of the data divided by the number of data + points. It is commonly called "the average", although it is only one of many + different mathematical averages. It is a measure of the central location of + the data. + + If *data* is empty, :exc:`StatisticsError` will be raised. + + Some examples of use: + + .. doctest:: + + >>> mean([1, 2, 3, 4, 4]) + 2.8 + >>> mean([-1.0, 2.5, 3.25, 5.75]) + 2.625 + + >>> from fractions import Fraction as F + >>> mean([F(3, 7), F(1, 21), F(5, 3), F(1, 3)]) + Fraction(13, 21) + + >>> from decimal import Decimal as D + >>> mean([D("0.5"), D("0.75"), D("0.625"), D("0.375")]) + Decimal('0.5625') + + .. note:: + + The mean is strongly affected by outliers and is not a robust estimator + for central location: the mean is not necessarily a typical example of the + data points. For more robust, although less efficient, measures of + central location, see :func:`median` and :func:`mode`. (In this case, + "efficient" refers to statistical efficiency rather than computational + efficiency.) + + The sample mean gives an unbiased estimate of the true population mean, + which means that, taken on average over all the possible samples, + ``mean(sample)`` converges on the true mean of the entire population. If + *data* represents the entire population rather than a sample, then + ``mean(data)`` is equivalent to calculating the true population mean μ. + + +.. function:: harmonic_mean(data) + + Return the harmonic mean of *data*, a sequence or iterator of + real-valued numbers. + + The harmonic mean, sometimes called the subcontrary mean, is the + reciprocal of the arithmetic :func:`mean` of the reciprocals of the + data. For example, the harmonic mean of three values *a*, *b* and *c* + will be equivalent to ``3/(1/a + 1/b + 1/c)``. + + The harmonic mean is a type of average, a measure of the central + location of the data. It is often appropriate when averaging quantities + which are rates or ratios, for example speeds. For example: + + Suppose an investor purchases an equal value of shares in each of + three companies, with P/E (price/earning) ratios of 2.5, 3 and 10. + What is the average P/E ratio for the investor's portfolio? + + .. doctest:: + + >>> harmonic_mean([2.5, 3, 10]) # For an equal investment portfolio. + 3.6 + + Using the arithmetic mean would give an average of about 5.167, which + is too high. + + :exc:`StatisticsError` is raised if *data* is empty, or any element + is less than zero. + + .. versionadded:: 3.6 + + +.. function:: median(data) + + Return the median (middle value) of numeric data, using the common "mean of + middle two" method. If *data* is empty, :exc:`StatisticsError` is raised. + *data* can be a sequence or iterator. + + The median is a robust measure of central location, and is less affected by + the presence of outliers in your data. When the number of data points is + odd, the middle data point is returned: + + .. doctest:: + + >>> median([1, 3, 5]) + 3 + + When the number of data points is even, the median is interpolated by taking + the average of the two middle values: + + .. doctest:: + + >>> median([1, 3, 5, 7]) + 4.0 + + This is suited for when your data is discrete, and you don't mind that the + median may not be an actual data point. + + If your data is ordinal (supports order operations) but not numeric (doesn't + support addition), you should use :func:`median_low` or :func:`median_high` + instead. + + .. seealso:: :func:`median_low`, :func:`median_high`, :func:`median_grouped` + + +.. function:: median_low(data) + + Return the low median of numeric data. If *data* is empty, + :exc:`StatisticsError` is raised. *data* can be a sequence or iterator. + + The low median is always a member of the data set. When the number of data + points is odd, the middle value is returned. When it is even, the smaller of + the two middle values is returned. + + .. doctest:: + + >>> median_low([1, 3, 5]) + 3 + >>> median_low([1, 3, 5, 7]) + 3 + + Use the low median when your data are discrete and you prefer the median to + be an actual data point rather than interpolated. + + +.. function:: median_high(data) + + Return the high median of data. If *data* is empty, :exc:`StatisticsError` + is raised. *data* can be a sequence or iterator. + + The high median is always a member of the data set. When the number of data + points is odd, the middle value is returned. When it is even, the larger of + the two middle values is returned. + + .. doctest:: + + >>> median_high([1, 3, 5]) + 3 + >>> median_high([1, 3, 5, 7]) + 5 + + Use the high median when your data are discrete and you prefer the median to + be an actual data point rather than interpolated. + + +.. function:: median_grouped(data, interval=1) + + Return the median of grouped continuous data, calculated as the 50th + percentile, using interpolation. If *data* is empty, :exc:`StatisticsError` + is raised. *data* can be a sequence or iterator. + + .. doctest:: + + >>> median_grouped([52, 52, 53, 54]) + 52.5 + + In the following example, the data are rounded, so that each value represents + the midpoint of data classes, e.g. 1 is the midpoint of the class 0.5--1.5, 2 + is the midpoint of 1.5--2.5, 3 is the midpoint of 2.5--3.5, etc. With the data + given, the middle value falls somewhere in the class 3.5--4.5, and + interpolation is used to estimate it: + + .. doctest:: + + >>> median_grouped([1, 2, 2, 3, 4, 4, 4, 4, 4, 5]) + 3.7 + + Optional argument *interval* represents the class interval, and defaults + to 1. Changing the class interval naturally will change the interpolation: + + .. doctest:: + + >>> median_grouped([1, 3, 3, 5, 7], interval=1) + 3.25 + >>> median_grouped([1, 3, 3, 5, 7], interval=2) + 3.5 + + This function does not check whether the data points are at least + *interval* apart. + + .. impl-detail:: + + Under some circumstances, :func:`median_grouped` may coerce data points to + floats. This behaviour is likely to change in the future. + + .. seealso:: + + * "Statistics for the Behavioral Sciences", Frederick J Gravetter and + Larry B Wallnau (8th Edition). + + * The `SSMEDIAN + `_ + function in the Gnome Gnumeric spreadsheet, including `this discussion + `_. + + +.. function:: mode(data) + + Return the most common data point from discrete or nominal *data*. The mode + (when it exists) is the most typical value, and is a robust measure of + central location. + + If *data* is empty, or if there is not exactly one most common value, + :exc:`StatisticsError` is raised. + + ``mode`` assumes discrete data, and returns a single value. This is the + standard treatment of the mode as commonly taught in schools: + + .. doctest:: + + >>> mode([1, 1, 2, 3, 3, 3, 3, 4]) + 3 + + The mode is unique in that it is the only statistic which also applies + to nominal (non-numeric) data: + + .. doctest:: + + >>> mode(["red", "blue", "blue", "red", "green", "red", "red"]) + 'red' + + +.. function:: pstdev(data, mu=None) + + Return the population standard deviation (the square root of the population + variance). See :func:`pvariance` for arguments and other details. + + .. doctest:: + + >>> pstdev([1.5, 2.5, 2.5, 2.75, 3.25, 4.75]) + 0.986893273527251 + + +.. function:: pvariance(data, mu=None) + + Return the population variance of *data*, a non-empty iterable of real-valued + numbers. Variance, or second moment about the mean, is a measure of the + variability (spread or dispersion) of data. A large variance indicates that + the data is spread out; a small variance indicates it is clustered closely + around the mean. + + If the optional second argument *mu* is given, it should be the mean of + *data*. If it is missing or ``None`` (the default), the mean is + automatically calculated. + + Use this function to calculate the variance from the entire population. To + estimate the variance from a sample, the :func:`variance` function is usually + a better choice. + + Raises :exc:`StatisticsError` if *data* is empty. + + Examples: + + .. doctest:: + + >>> data = [0.0, 0.25, 0.25, 1.25, 1.5, 1.75, 2.75, 3.25] + >>> pvariance(data) + 1.25 + + If you have already calculated the mean of your data, you can pass it as the + optional second argument *mu* to avoid recalculation: + + .. doctest:: + + >>> mu = mean(data) + >>> pvariance(data, mu) + 1.25 + + This function does not attempt to verify that you have passed the actual mean + as *mu*. Using arbitrary values for *mu* may lead to invalid or impossible + results. + + Decimals and Fractions are supported: + + .. doctest:: + + >>> from decimal import Decimal as D + >>> pvariance([D("27.5"), D("30.25"), D("30.25"), D("34.5"), D("41.75")]) + Decimal('24.815') + + >>> from fractions import Fraction as F + >>> pvariance([F(1, 4), F(5, 4), F(1, 2)]) + Fraction(13, 72) + + .. note:: + + When called with the entire population, this gives the population variance + σ². When called on a sample instead, this is the biased sample variance + s², also known as variance with N degrees of freedom. + + If you somehow know the true population mean μ, you may use this function + to calculate the variance of a sample, giving the known population mean as + the second argument. Provided the data points are representative + (e.g. independent and identically distributed), the result will be an + unbiased estimate of the population variance. + + +.. function:: stdev(data, xbar=None) + + Return the sample standard deviation (the square root of the sample + variance). See :func:`variance` for arguments and other details. + + .. doctest:: + + >>> stdev([1.5, 2.5, 2.5, 2.75, 3.25, 4.75]) + 1.0810874155219827 + + +.. function:: variance(data, xbar=None) + + Return the sample variance of *data*, an iterable of at least two real-valued + numbers. Variance, or second moment about the mean, is a measure of the + variability (spread or dispersion) of data. A large variance indicates that + the data is spread out; a small variance indicates it is clustered closely + around the mean. + + If the optional second argument *xbar* is given, it should be the mean of + *data*. If it is missing or ``None`` (the default), the mean is + automatically calculated. + + Use this function when your data is a sample from a population. To calculate + the variance from the entire population, see :func:`pvariance`. + + Raises :exc:`StatisticsError` if *data* has fewer than two values. + + Examples: + + .. doctest:: + + >>> data = [2.75, 1.75, 1.25, 0.25, 0.5, 1.25, 3.5] + >>> variance(data) + 1.3720238095238095 + + If you have already calculated the mean of your data, you can pass it as the + optional second argument *xbar* to avoid recalculation: + + .. doctest:: + + >>> m = mean(data) + >>> variance(data, m) + 1.3720238095238095 + + This function does not attempt to verify that you have passed the actual mean + as *xbar*. Using arbitrary values for *xbar* can lead to invalid or + impossible results. + + Decimal and Fraction values are supported: + + .. doctest:: + + >>> from decimal import Decimal as D + >>> variance([D("27.5"), D("30.25"), D("30.25"), D("34.5"), D("41.75")]) + Decimal('31.01875') + + >>> from fractions import Fraction as F + >>> variance([F(1, 6), F(1, 2), F(5, 3)]) + Fraction(67, 108) + + .. note:: + + This is the sample variance s² with Bessel's correction, also known as + variance with N-1 degrees of freedom. Provided that the data points are + representative (e.g. independent and identically distributed), the result + should be an unbiased estimate of the true population variance. + + If you somehow know the actual population mean μ you should pass it to the + :func:`pvariance` function as the *mu* parameter to get the variance of a + sample. + +Exceptions +---------- + +A single exception is defined: + +.. exception:: StatisticsError + + Subclass of :exc:`ValueError` for statistics-related exceptions. + +.. + # This modelines must appear within the last ten lines of the file. + kate: indent-width 3; remove-trailing-space on; replace-tabs on; encoding utf-8; diff --git a/python-3.7.4-docs-html/_sources/library/stdtypes.rst.txt b/python-3.7.4-docs-html/_sources/library/stdtypes.rst.txt new file mode 100644 index 0000000..d35c171 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/stdtypes.rst.txt @@ -0,0 +1,4744 @@ +.. XXX: reference/datamodel and this have quite a few overlaps! + + +.. _bltin-types: + +************** +Built-in Types +************** + +The following sections describe the standard types that are built into the +interpreter. + +.. index:: pair: built-in; types + +The principal built-in types are numerics, sequences, mappings, classes, +instances and exceptions. + +Some collection classes are mutable. The methods that add, subtract, or +rearrange their members in place, and don't return a specific item, never return +the collection instance itself but ``None``. + +Some operations are supported by several object types; in particular, +practically all objects can be compared, tested for truth value, and converted +to a string (with the :func:`repr` function or the slightly different +:func:`str` function). The latter function is implicitly used when an object is +written by the :func:`print` function. + + +.. _truth: + +Truth Value Testing +=================== + +.. index:: + statement: if + statement: while + pair: truth; value + pair: Boolean; operations + single: false + +Any object can be tested for truth value, for use in an :keyword:`if` or +:keyword:`while` condition or as operand of the Boolean operations below. + +.. index:: single: true + +By default, an object is considered true unless its class defines either a +:meth:`__bool__` method that returns ``False`` or a :meth:`__len__` method that +returns zero, when called with the object. [1]_ Here are most of the built-in +objects considered false: + + .. index:: + single: None (Built-in object) + single: False (Built-in object) + +* constants defined to be false: ``None`` and ``False``. + +* zero of any numeric type: ``0``, ``0.0``, ``0j``, ``Decimal(0)``, + ``Fraction(0, 1)`` + +* empty sequences and collections: ``''``, ``()``, ``[]``, ``{}``, ``set()``, + ``range(0)`` + +.. index:: + operator: or + operator: and + single: False + single: True + +Operations and built-in functions that have a Boolean result always return ``0`` +or ``False`` for false and ``1`` or ``True`` for true, unless otherwise stated. +(Important exception: the Boolean operations ``or`` and ``and`` always return +one of their operands.) + + +.. _boolean: + +Boolean Operations --- :keyword:`!and`, :keyword:`!or`, :keyword:`!not` +======================================================================= + +.. index:: pair: Boolean; operations + +These are the Boolean operations, ordered by ascending priority: + ++-------------+---------------------------------+-------+ +| Operation | Result | Notes | ++=============+=================================+=======+ +| ``x or y`` | if *x* is false, then *y*, else | \(1) | +| | *x* | | ++-------------+---------------------------------+-------+ +| ``x and y`` | if *x* is false, then *x*, else | \(2) | +| | *y* | | ++-------------+---------------------------------+-------+ +| ``not x`` | if *x* is false, then ``True``, | \(3) | +| | else ``False`` | | ++-------------+---------------------------------+-------+ + +.. index:: + operator: and + operator: or + operator: not + +Notes: + +(1) + This is a short-circuit operator, so it only evaluates the second + argument if the first one is false. + +(2) + This is a short-circuit operator, so it only evaluates the second + argument if the first one is true. + +(3) + ``not`` has a lower priority than non-Boolean operators, so ``not a == b`` is + interpreted as ``not (a == b)``, and ``a == not b`` is a syntax error. + + +.. _stdcomparisons: + +Comparisons +=========== + +.. index:: + pair: chaining; comparisons + pair: operator; comparison + operator: == + operator: < (less) + operator: <= + operator: > (greater) + operator: >= + operator: != + operator: is + operator: is not + +There are eight comparison operations in Python. They all have the same +priority (which is higher than that of the Boolean operations). Comparisons can +be chained arbitrarily; for example, ``x < y <= z`` is equivalent to ``x < y and +y <= z``, except that *y* is evaluated only once (but in both cases *z* is not +evaluated at all when ``x < y`` is found to be false). + +This table summarizes the comparison operations: + ++------------+-------------------------+ +| Operation | Meaning | ++============+=========================+ +| ``<`` | strictly less than | ++------------+-------------------------+ +| ``<=`` | less than or equal | ++------------+-------------------------+ +| ``>`` | strictly greater than | ++------------+-------------------------+ +| ``>=`` | greater than or equal | ++------------+-------------------------+ +| ``==`` | equal | ++------------+-------------------------+ +| ``!=`` | not equal | ++------------+-------------------------+ +| ``is`` | object identity | ++------------+-------------------------+ +| ``is not`` | negated object identity | ++------------+-------------------------+ + +.. index:: + pair: object; numeric + pair: objects; comparing + +Objects of different types, except different numeric types, never compare equal. +Furthermore, some types (for example, function objects) support only a degenerate +notion of comparison where any two objects of that type are unequal. The ``<``, +``<=``, ``>`` and ``>=`` operators will raise a :exc:`TypeError` exception when +comparing a complex number with another built-in numeric type, when the objects +are of different types that cannot be compared, or in other cases where there is +no defined ordering. + +.. index:: + single: __eq__() (instance method) + single: __ne__() (instance method) + single: __lt__() (instance method) + single: __le__() (instance method) + single: __gt__() (instance method) + single: __ge__() (instance method) + +Non-identical instances of a class normally compare as non-equal unless the +class defines the :meth:`__eq__` method. + +Instances of a class cannot be ordered with respect to other instances of the +same class, or other types of object, unless the class defines enough of the +methods :meth:`__lt__`, :meth:`__le__`, :meth:`__gt__`, and :meth:`__ge__` (in +general, :meth:`__lt__` and :meth:`__eq__` are sufficient, if you want the +conventional meanings of the comparison operators). + +The behavior of the :keyword:`is` and :keyword:`is not` operators cannot be +customized; also they can be applied to any two objects and never raise an +exception. + +.. index:: + operator: in + operator: not in + +Two more operations with the same syntactic priority, :keyword:`in` and +:keyword:`not in`, are supported by types that are :term:`iterable` or +implement the :meth:`__contains__` method. + +.. _typesnumeric: + +Numeric Types --- :class:`int`, :class:`float`, :class:`complex` +================================================================ + +.. index:: + object: numeric + object: Boolean + object: integer + object: floating point + object: complex number + pair: C; language + +There are three distinct numeric types: :dfn:`integers`, :dfn:`floating +point numbers`, and :dfn:`complex numbers`. In addition, Booleans are a +subtype of integers. Integers have unlimited precision. Floating point +numbers are usually implemented using :c:type:`double` in C; information +about the precision and internal representation of floating point +numbers for the machine on which your program is running is available +in :data:`sys.float_info`. Complex numbers have a real and imaginary +part, which are each a floating point number. To extract these parts +from a complex number *z*, use ``z.real`` and ``z.imag``. (The standard +library includes additional numeric types, :mod:`fractions` that hold +rationals, and :mod:`decimal` that hold floating-point numbers with +user-definable precision.) + +.. index:: + pair: numeric; literals + pair: integer; literals + pair: floating point; literals + pair: complex number; literals + pair: hexadecimal; literals + pair: octal; literals + pair: binary; literals + +Numbers are created by numeric literals or as the result of built-in functions +and operators. Unadorned integer literals (including hex, octal and binary +numbers) yield integers. Numeric literals containing a decimal point or an +exponent sign yield floating point numbers. Appending ``'j'`` or ``'J'`` to a +numeric literal yields an imaginary number (a complex number with a zero real +part) which you can add to an integer or float to get a complex number with real +and imaginary parts. + +.. index:: + single: arithmetic + builtin: int + builtin: float + builtin: complex + single: operator; + (plus) + single: + (plus); unary operator + single: + (plus); binary operator + single: operator; - (minus) + single: - (minus); unary operator + single: - (minus); binary operator + operator: * (asterisk) + operator: / (slash) + operator: // + operator: % (percent) + operator: ** + +Python fully supports mixed arithmetic: when a binary arithmetic operator has +operands of different numeric types, the operand with the "narrower" type is +widened to that of the other, where integer is narrower than floating point, +which is narrower than complex. Comparisons between numbers of mixed type use +the same rule. [2]_ The constructors :func:`int`, :func:`float`, and +:func:`complex` can be used to produce numbers of a specific type. + +All numeric types (except complex) support the following operations, sorted by +ascending priority (all numeric operations have a higher priority than +comparison operations): + ++---------------------+---------------------------------+---------+--------------------+ +| Operation | Result | Notes | Full documentation | ++=====================+=================================+=========+====================+ +| ``x + y`` | sum of *x* and *y* | | | ++---------------------+---------------------------------+---------+--------------------+ +| ``x - y`` | difference of *x* and *y* | | | ++---------------------+---------------------------------+---------+--------------------+ +| ``x * y`` | product of *x* and *y* | | | ++---------------------+---------------------------------+---------+--------------------+ +| ``x / y`` | quotient of *x* and *y* | | | ++---------------------+---------------------------------+---------+--------------------+ +| ``x // y`` | floored quotient of *x* and | \(1) | | +| | *y* | | | ++---------------------+---------------------------------+---------+--------------------+ +| ``x % y`` | remainder of ``x / y`` | \(2) | | ++---------------------+---------------------------------+---------+--------------------+ +| ``-x`` | *x* negated | | | ++---------------------+---------------------------------+---------+--------------------+ +| ``+x`` | *x* unchanged | | | ++---------------------+---------------------------------+---------+--------------------+ +| ``abs(x)`` | absolute value or magnitude of | | :func:`abs` | +| | *x* | | | ++---------------------+---------------------------------+---------+--------------------+ +| ``int(x)`` | *x* converted to integer | \(3)\(6)| :func:`int` | ++---------------------+---------------------------------+---------+--------------------+ +| ``float(x)`` | *x* converted to floating point | \(4)\(6)| :func:`float` | ++---------------------+---------------------------------+---------+--------------------+ +| ``complex(re, im)`` | a complex number with real part | \(6) | :func:`complex` | +| | *re*, imaginary part *im*. | | | +| | *im* defaults to zero. | | | ++---------------------+---------------------------------+---------+--------------------+ +| ``c.conjugate()`` | conjugate of the complex number | | | +| | *c* | | | ++---------------------+---------------------------------+---------+--------------------+ +| ``divmod(x, y)`` | the pair ``(x // y, x % y)`` | \(2) | :func:`divmod` | ++---------------------+---------------------------------+---------+--------------------+ +| ``pow(x, y)`` | *x* to the power *y* | \(5) | :func:`pow` | ++---------------------+---------------------------------+---------+--------------------+ +| ``x ** y`` | *x* to the power *y* | \(5) | | ++---------------------+---------------------------------+---------+--------------------+ + +.. index:: + triple: operations on; numeric; types + single: conjugate() (complex number method) + +Notes: + +(1) + Also referred to as integer division. The resultant value is a whole + integer, though the result's type is not necessarily int. The result is + always rounded towards minus infinity: ``1//2`` is ``0``, ``(-1)//2`` is + ``-1``, ``1//(-2)`` is ``-1``, and ``(-1)//(-2)`` is ``0``. + +(2) + Not for complex numbers. Instead convert to floats using :func:`abs` if + appropriate. + +(3) + .. index:: + module: math + single: floor() (in module math) + single: ceil() (in module math) + single: trunc() (in module math) + pair: numeric; conversions + pair: C; language + + Conversion from floating point to integer may round or truncate + as in C; see functions :func:`math.floor` and :func:`math.ceil` for + well-defined conversions. + +(4) + float also accepts the strings "nan" and "inf" with an optional prefix "+" + or "-" for Not a Number (NaN) and positive or negative infinity. + +(5) + Python defines ``pow(0, 0)`` and ``0 ** 0`` to be ``1``, as is common for + programming languages. + +(6) + The numeric literals accepted include the digits ``0`` to ``9`` or any + Unicode equivalent (code points with the ``Nd`` property). + + See http://www.unicode.org/Public/10.0.0/ucd/extracted/DerivedNumericType.txt + for a complete list of code points with the ``Nd`` property. + + +All :class:`numbers.Real` types (:class:`int` and :class:`float`) also include +the following operations: + ++--------------------+---------------------------------------------+ +| Operation | Result | ++====================+=============================================+ +| :func:`math.trunc(\| *x* truncated to :class:`~numbers.Integral` | +| x) ` | | ++--------------------+---------------------------------------------+ +| :func:`round(x[, | *x* rounded to *n* digits, | +| n]) ` | rounding half to even. If *n* is | +| | omitted, it defaults to 0. | ++--------------------+---------------------------------------------+ +| :func:`math.floor(\| the greatest :class:`~numbers.Integral` | +| x) ` | <= *x* | ++--------------------+---------------------------------------------+ +| :func:`math.ceil(x)| the least :class:`~numbers.Integral` >= *x* | +| ` | | ++--------------------+---------------------------------------------+ + +For additional numeric operations see the :mod:`math` and :mod:`cmath` +modules. + +.. XXXJH exceptions: overflow (when? what operations?) zerodivision + + +.. _bitstring-ops: + +Bitwise Operations on Integer Types +----------------------------------- + +.. index:: + triple: operations on; integer; types + pair: bitwise; operations + pair: shifting; operations + pair: masking; operations + operator: | (vertical bar) + operator: ^ (caret) + operator: & (ampersand) + operator: << + operator: >> + operator: ~ (tilde) + +Bitwise operations only make sense for integers. The result of bitwise +operations is calculated as though carried out in two's complement with an +infinite number of sign bits. + +The priorities of the binary bitwise operations are all lower than the numeric +operations and higher than the comparisons; the unary operation ``~`` has the +same priority as the other unary numeric operations (``+`` and ``-``). + +This table lists the bitwise operations sorted in ascending priority: + ++------------+--------------------------------+----------+ +| Operation | Result | Notes | ++============+================================+==========+ +| ``x | y`` | bitwise :dfn:`or` of *x* and | \(4) | +| | *y* | | ++------------+--------------------------------+----------+ +| ``x ^ y`` | bitwise :dfn:`exclusive or` of | \(4) | +| | *x* and *y* | | ++------------+--------------------------------+----------+ +| ``x & y`` | bitwise :dfn:`and` of *x* and | \(4) | +| | *y* | | ++------------+--------------------------------+----------+ +| ``x << n`` | *x* shifted left by *n* bits | (1)(2) | ++------------+--------------------------------+----------+ +| ``x >> n`` | *x* shifted right by *n* bits | (1)(3) | ++------------+--------------------------------+----------+ +| ``~x`` | the bits of *x* inverted | | ++------------+--------------------------------+----------+ + +Notes: + +(1) + Negative shift counts are illegal and cause a :exc:`ValueError` to be raised. + +(2) + A left shift by *n* bits is equivalent to multiplication by ``pow(2, n)`` + without overflow check. + +(3) + A right shift by *n* bits is equivalent to division by ``pow(2, n)`` without + overflow check. + +(4) + Performing these calculations with at least one extra sign extension bit in + a finite two's complement representation (a working bit-width of + ``1 + max(x.bit_length(), y.bit_length())`` or more) is sufficient to get the + same result as if there were an infinite number of sign bits. + + +Additional Methods on Integer Types +----------------------------------- + +The int type implements the :class:`numbers.Integral` :term:`abstract base +class`. In addition, it provides a few more methods: + +.. method:: int.bit_length() + + Return the number of bits necessary to represent an integer in binary, + excluding the sign and leading zeros:: + + >>> n = -37 + >>> bin(n) + '-0b100101' + >>> n.bit_length() + 6 + + More precisely, if ``x`` is nonzero, then ``x.bit_length()`` is the + unique positive integer ``k`` such that ``2**(k-1) <= abs(x) < 2**k``. + Equivalently, when ``abs(x)`` is small enough to have a correctly + rounded logarithm, then ``k = 1 + int(log(abs(x), 2))``. + If ``x`` is zero, then ``x.bit_length()`` returns ``0``. + + Equivalent to:: + + def bit_length(self): + s = bin(self) # binary representation: bin(-37) --> '-0b100101' + s = s.lstrip('-0b') # remove leading zeros and minus sign + return len(s) # len('100101') --> 6 + + .. versionadded:: 3.1 + +.. method:: int.to_bytes(length, byteorder, \*, signed=False) + + Return an array of bytes representing an integer. + + >>> (1024).to_bytes(2, byteorder='big') + b'\x04\x00' + >>> (1024).to_bytes(10, byteorder='big') + b'\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00' + >>> (-1024).to_bytes(10, byteorder='big', signed=True) + b'\xff\xff\xff\xff\xff\xff\xff\xff\xfc\x00' + >>> x = 1000 + >>> x.to_bytes((x.bit_length() + 7) // 8, byteorder='little') + b'\xe8\x03' + + The integer is represented using *length* bytes. An :exc:`OverflowError` + is raised if the integer is not representable with the given number of + bytes. + + The *byteorder* argument determines the byte order used to represent the + integer. If *byteorder* is ``"big"``, the most significant byte is at the + beginning of the byte array. If *byteorder* is ``"little"``, the most + significant byte is at the end of the byte array. To request the native + byte order of the host system, use :data:`sys.byteorder` as the byte order + value. + + The *signed* argument determines whether two's complement is used to + represent the integer. If *signed* is ``False`` and a negative integer is + given, an :exc:`OverflowError` is raised. The default value for *signed* + is ``False``. + + .. versionadded:: 3.2 + +.. classmethod:: int.from_bytes(bytes, byteorder, \*, signed=False) + + Return the integer represented by the given array of bytes. + + >>> int.from_bytes(b'\x00\x10', byteorder='big') + 16 + >>> int.from_bytes(b'\x00\x10', byteorder='little') + 4096 + >>> int.from_bytes(b'\xfc\x00', byteorder='big', signed=True) + -1024 + >>> int.from_bytes(b'\xfc\x00', byteorder='big', signed=False) + 64512 + >>> int.from_bytes([255, 0, 0], byteorder='big') + 16711680 + + The argument *bytes* must either be a :term:`bytes-like object` or an + iterable producing bytes. + + The *byteorder* argument determines the byte order used to represent the + integer. If *byteorder* is ``"big"``, the most significant byte is at the + beginning of the byte array. If *byteorder* is ``"little"``, the most + significant byte is at the end of the byte array. To request the native + byte order of the host system, use :data:`sys.byteorder` as the byte order + value. + + The *signed* argument indicates whether two's complement is used to + represent the integer. + + .. versionadded:: 3.2 + + +Additional Methods on Float +--------------------------- + +The float type implements the :class:`numbers.Real` :term:`abstract base +class`. float also has the following additional methods. + +.. method:: float.as_integer_ratio() + + Return a pair of integers whose ratio is exactly equal to the + original float and with a positive denominator. Raises + :exc:`OverflowError` on infinities and a :exc:`ValueError` on + NaNs. + +.. method:: float.is_integer() + + Return ``True`` if the float instance is finite with integral + value, and ``False`` otherwise:: + + >>> (-2.0).is_integer() + True + >>> (3.2).is_integer() + False + +Two methods support conversion to +and from hexadecimal strings. Since Python's floats are stored +internally as binary numbers, converting a float to or from a +*decimal* string usually involves a small rounding error. In +contrast, hexadecimal strings allow exact representation and +specification of floating-point numbers. This can be useful when +debugging, and in numerical work. + + +.. method:: float.hex() + + Return a representation of a floating-point number as a hexadecimal + string. For finite floating-point numbers, this representation + will always include a leading ``0x`` and a trailing ``p`` and + exponent. + + +.. classmethod:: float.fromhex(s) + + Class method to return the float represented by a hexadecimal + string *s*. The string *s* may have leading and trailing + whitespace. + + +Note that :meth:`float.hex` is an instance method, while +:meth:`float.fromhex` is a class method. + +A hexadecimal string takes the form:: + + [sign] ['0x'] integer ['.' fraction] ['p' exponent] + +where the optional ``sign`` may by either ``+`` or ``-``, ``integer`` +and ``fraction`` are strings of hexadecimal digits, and ``exponent`` +is a decimal integer with an optional leading sign. Case is not +significant, and there must be at least one hexadecimal digit in +either the integer or the fraction. This syntax is similar to the +syntax specified in section 6.4.4.2 of the C99 standard, and also to +the syntax used in Java 1.5 onwards. In particular, the output of +:meth:`float.hex` is usable as a hexadecimal floating-point literal in +C or Java code, and hexadecimal strings produced by C's ``%a`` format +character or Java's ``Double.toHexString`` are accepted by +:meth:`float.fromhex`. + + +Note that the exponent is written in decimal rather than hexadecimal, +and that it gives the power of 2 by which to multiply the coefficient. +For example, the hexadecimal string ``0x3.a7p10`` represents the +floating-point number ``(3 + 10./16 + 7./16**2) * 2.0**10``, or +``3740.0``:: + + >>> float.fromhex('0x3.a7p10') + 3740.0 + + +Applying the reverse conversion to ``3740.0`` gives a different +hexadecimal string representing the same number:: + + >>> float.hex(3740.0) + '0x1.d380000000000p+11' + + +.. _numeric-hash: + +Hashing of numeric types +------------------------ + +For numbers ``x`` and ``y``, possibly of different types, it's a requirement +that ``hash(x) == hash(y)`` whenever ``x == y`` (see the :meth:`__hash__` +method documentation for more details). For ease of implementation and +efficiency across a variety of numeric types (including :class:`int`, +:class:`float`, :class:`decimal.Decimal` and :class:`fractions.Fraction`) +Python's hash for numeric types is based on a single mathematical function +that's defined for any rational number, and hence applies to all instances of +:class:`int` and :class:`fractions.Fraction`, and all finite instances of +:class:`float` and :class:`decimal.Decimal`. Essentially, this function is +given by reduction modulo ``P`` for a fixed prime ``P``. The value of ``P`` is +made available to Python as the :attr:`modulus` attribute of +:data:`sys.hash_info`. + +.. impl-detail:: + + Currently, the prime used is ``P = 2**31 - 1`` on machines with 32-bit C + longs and ``P = 2**61 - 1`` on machines with 64-bit C longs. + +Here are the rules in detail: + +- If ``x = m / n`` is a nonnegative rational number and ``n`` is not divisible + by ``P``, define ``hash(x)`` as ``m * invmod(n, P) % P``, where ``invmod(n, + P)`` gives the inverse of ``n`` modulo ``P``. + +- If ``x = m / n`` is a nonnegative rational number and ``n`` is + divisible by ``P`` (but ``m`` is not) then ``n`` has no inverse + modulo ``P`` and the rule above doesn't apply; in this case define + ``hash(x)`` to be the constant value ``sys.hash_info.inf``. + +- If ``x = m / n`` is a negative rational number define ``hash(x)`` + as ``-hash(-x)``. If the resulting hash is ``-1``, replace it with + ``-2``. + +- The particular values ``sys.hash_info.inf``, ``-sys.hash_info.inf`` + and ``sys.hash_info.nan`` are used as hash values for positive + infinity, negative infinity, or nans (respectively). (All hashable + nans have the same hash value.) + +- For a :class:`complex` number ``z``, the hash values of the real + and imaginary parts are combined by computing ``hash(z.real) + + sys.hash_info.imag * hash(z.imag)``, reduced modulo + ``2**sys.hash_info.width`` so that it lies in + ``range(-2**(sys.hash_info.width - 1), 2**(sys.hash_info.width - + 1))``. Again, if the result is ``-1``, it's replaced with ``-2``. + + +To clarify the above rules, here's some example Python code, +equivalent to the built-in hash, for computing the hash of a rational +number, :class:`float`, or :class:`complex`:: + + + import sys, math + + def hash_fraction(m, n): + """Compute the hash of a rational number m / n. + + Assumes m and n are integers, with n positive. + Equivalent to hash(fractions.Fraction(m, n)). + + """ + P = sys.hash_info.modulus + # Remove common factors of P. (Unnecessary if m and n already coprime.) + while m % P == n % P == 0: + m, n = m // P, n // P + + if n % P == 0: + hash_value = sys.hash_info.inf + else: + # Fermat's Little Theorem: pow(n, P-1, P) is 1, so + # pow(n, P-2, P) gives the inverse of n modulo P. + hash_value = (abs(m) % P) * pow(n, P - 2, P) % P + if m < 0: + hash_value = -hash_value + if hash_value == -1: + hash_value = -2 + return hash_value + + def hash_float(x): + """Compute the hash of a float x.""" + + if math.isnan(x): + return sys.hash_info.nan + elif math.isinf(x): + return sys.hash_info.inf if x > 0 else -sys.hash_info.inf + else: + return hash_fraction(*x.as_integer_ratio()) + + def hash_complex(z): + """Compute the hash of a complex number z.""" + + hash_value = hash_float(z.real) + sys.hash_info.imag * hash_float(z.imag) + # do a signed reduction modulo 2**sys.hash_info.width + M = 2**(sys.hash_info.width - 1) + hash_value = (hash_value & (M - 1)) - (hash_value & M) + if hash_value == -1: + hash_value = -2 + return hash_value + +.. _typeiter: + +Iterator Types +============== + +.. index:: + single: iterator protocol + single: protocol; iterator + single: sequence; iteration + single: container; iteration over + +Python supports a concept of iteration over containers. This is implemented +using two distinct methods; these are used to allow user-defined classes to +support iteration. Sequences, described below in more detail, always support +the iteration methods. + +One method needs to be defined for container objects to provide iteration +support: + +.. XXX duplicated in reference/datamodel! + +.. method:: container.__iter__() + + Return an iterator object. The object is required to support the iterator + protocol described below. If a container supports different types of + iteration, additional methods can be provided to specifically request + iterators for those iteration types. (An example of an object supporting + multiple forms of iteration would be a tree structure which supports both + breadth-first and depth-first traversal.) This method corresponds to the + :c:member:`~PyTypeObject.tp_iter` slot of the type structure for Python objects in the Python/C + API. + +The iterator objects themselves are required to support the following two +methods, which together form the :dfn:`iterator protocol`: + + +.. method:: iterator.__iter__() + + Return the iterator object itself. This is required to allow both containers + and iterators to be used with the :keyword:`for` and :keyword:`in` statements. + This method corresponds to the :c:member:`~PyTypeObject.tp_iter` slot of the type structure for + Python objects in the Python/C API. + + +.. method:: iterator.__next__() + + Return the next item from the container. If there are no further items, raise + the :exc:`StopIteration` exception. This method corresponds to the + :c:member:`~PyTypeObject.tp_iternext` slot of the type structure for Python objects in the + Python/C API. + +Python defines several iterator objects to support iteration over general and +specific sequence types, dictionaries, and other more specialized forms. The +specific types are not important beyond their implementation of the iterator +protocol. + +Once an iterator's :meth:`~iterator.__next__` method raises +:exc:`StopIteration`, it must continue to do so on subsequent calls. +Implementations that do not obey this property are deemed broken. + + +.. _generator-types: + +Generator Types +--------------- + +Python's :term:`generator`\s provide a convenient way to implement the iterator +protocol. If a container object's :meth:`__iter__` method is implemented as a +generator, it will automatically return an iterator object (technically, a +generator object) supplying the :meth:`__iter__` and :meth:`~generator.__next__` +methods. +More information about generators can be found in :ref:`the documentation for +the yield expression `. + + +.. _typesseq: + +Sequence Types --- :class:`list`, :class:`tuple`, :class:`range` +================================================================ + +There are three basic sequence types: lists, tuples, and range objects. +Additional sequence types tailored for processing of +:ref:`binary data ` and :ref:`text strings ` are +described in dedicated sections. + + +.. _typesseq-common: + +Common Sequence Operations +-------------------------- + +.. index:: object: sequence + +The operations in the following table are supported by most sequence types, +both mutable and immutable. The :class:`collections.abc.Sequence` ABC is +provided to make it easier to correctly implement these operations on +custom sequence types. + +This table lists the sequence operations sorted in ascending priority. In the +table, *s* and *t* are sequences of the same type, *n*, *i*, *j* and *k* are +integers and *x* is an arbitrary object that meets any type and value +restrictions imposed by *s*. + +The ``in`` and ``not in`` operations have the same priorities as the +comparison operations. The ``+`` (concatenation) and ``*`` (repetition) +operations have the same priority as the corresponding numeric operations. [3]_ + +.. index:: + triple: operations on; sequence; types + builtin: len + builtin: min + builtin: max + pair: concatenation; operation + pair: repetition; operation + pair: subscript; operation + pair: slice; operation + operator: in + operator: not in + single: count() (sequence method) + single: index() (sequence method) + ++--------------------------+--------------------------------+----------+ +| Operation | Result | Notes | ++==========================+================================+==========+ +| ``x in s`` | ``True`` if an item of *s* is | \(1) | +| | equal to *x*, else ``False`` | | ++--------------------------+--------------------------------+----------+ +| ``x not in s`` | ``False`` if an item of *s* is | \(1) | +| | equal to *x*, else ``True`` | | ++--------------------------+--------------------------------+----------+ +| ``s + t`` | the concatenation of *s* and | (6)(7) | +| | *t* | | ++--------------------------+--------------------------------+----------+ +| ``s * n`` or | equivalent to adding *s* to | (2)(7) | +| ``n * s`` | itself *n* times | | ++--------------------------+--------------------------------+----------+ +| ``s[i]`` | *i*\ th item of *s*, origin 0 | \(3) | ++--------------------------+--------------------------------+----------+ +| ``s[i:j]`` | slice of *s* from *i* to *j* | (3)(4) | ++--------------------------+--------------------------------+----------+ +| ``s[i:j:k]`` | slice of *s* from *i* to *j* | (3)(5) | +| | with step *k* | | ++--------------------------+--------------------------------+----------+ +| ``len(s)`` | length of *s* | | ++--------------------------+--------------------------------+----------+ +| ``min(s)`` | smallest item of *s* | | ++--------------------------+--------------------------------+----------+ +| ``max(s)`` | largest item of *s* | | ++--------------------------+--------------------------------+----------+ +| ``s.index(x[, i[, j]])`` | index of the first occurrence | \(8) | +| | of *x* in *s* (at or after | | +| | index *i* and before index *j*)| | ++--------------------------+--------------------------------+----------+ +| ``s.count(x)`` | total number of occurrences of | | +| | *x* in *s* | | ++--------------------------+--------------------------------+----------+ + +Sequences of the same type also support comparisons. In particular, tuples +and lists are compared lexicographically by comparing corresponding elements. +This means that to compare equal, every element must compare equal and the +two sequences must be of the same type and have the same length. (For full +details see :ref:`comparisons` in the language reference.) + +Notes: + +(1) + While the ``in`` and ``not in`` operations are used only for simple + containment testing in the general case, some specialised sequences + (such as :class:`str`, :class:`bytes` and :class:`bytearray`) also use + them for subsequence testing:: + + >>> "gg" in "eggs" + True + +(2) + Values of *n* less than ``0`` are treated as ``0`` (which yields an empty + sequence of the same type as *s*). Note that items in the sequence *s* + are not copied; they are referenced multiple times. This often haunts + new Python programmers; consider:: + + >>> lists = [[]] * 3 + >>> lists + [[], [], []] + >>> lists[0].append(3) + >>> lists + [[3], [3], [3]] + + What has happened is that ``[[]]`` is a one-element list containing an empty + list, so all three elements of ``[[]] * 3`` are references to this single empty + list. Modifying any of the elements of ``lists`` modifies this single list. + You can create a list of different lists this way:: + + >>> lists = [[] for i in range(3)] + >>> lists[0].append(3) + >>> lists[1].append(5) + >>> lists[2].append(7) + >>> lists + [[3], [5], [7]] + + Further explanation is available in the FAQ entry + :ref:`faq-multidimensional-list`. + +(3) + If *i* or *j* is negative, the index is relative to the end of sequence *s*: + ``len(s) + i`` or ``len(s) + j`` is substituted. But note that ``-0`` is + still ``0``. + +(4) + The slice of *s* from *i* to *j* is defined as the sequence of items with index + *k* such that ``i <= k < j``. If *i* or *j* is greater than ``len(s)``, use + ``len(s)``. If *i* is omitted or ``None``, use ``0``. If *j* is omitted or + ``None``, use ``len(s)``. If *i* is greater than or equal to *j*, the slice is + empty. + +(5) + The slice of *s* from *i* to *j* with step *k* is defined as the sequence of + items with index ``x = i + n*k`` such that ``0 <= n < (j-i)/k``. In other words, + the indices are ``i``, ``i+k``, ``i+2*k``, ``i+3*k`` and so on, stopping when + *j* is reached (but never including *j*). When *k* is positive, + *i* and *j* are reduced to ``len(s)`` if they are greater. + When *k* is negative, *i* and *j* are reduced to ``len(s) - 1`` if + they are greater. If *i* or *j* are omitted or ``None``, they become + "end" values (which end depends on the sign of *k*). Note, *k* cannot be zero. + If *k* is ``None``, it is treated like ``1``. + +(6) + Concatenating immutable sequences always results in a new object. This + means that building up a sequence by repeated concatenation will have a + quadratic runtime cost in the total sequence length. To get a linear + runtime cost, you must switch to one of the alternatives below: + + * if concatenating :class:`str` objects, you can build a list and use + :meth:`str.join` at the end or else write to an :class:`io.StringIO` + instance and retrieve its value when complete + + * if concatenating :class:`bytes` objects, you can similarly use + :meth:`bytes.join` or :class:`io.BytesIO`, or you can do in-place + concatenation with a :class:`bytearray` object. :class:`bytearray` + objects are mutable and have an efficient overallocation mechanism + + * if concatenating :class:`tuple` objects, extend a :class:`list` instead + + * for other types, investigate the relevant class documentation + + +(7) + Some sequence types (such as :class:`range`) only support item sequences + that follow specific patterns, and hence don't support sequence + concatenation or repetition. + +(8) + ``index`` raises :exc:`ValueError` when *x* is not found in *s*. + Not all implementations support passing the additional arguments *i* and *j*. + These arguments allow efficient searching of subsections of the sequence. Passing + the extra arguments is roughly equivalent to using ``s[i:j].index(x)``, only + without copying any data and with the returned index being relative to + the start of the sequence rather than the start of the slice. + + +.. _typesseq-immutable: + +Immutable Sequence Types +------------------------ + +.. index:: + triple: immutable; sequence; types + object: tuple + builtin: hash + +The only operation that immutable sequence types generally implement that is +not also implemented by mutable sequence types is support for the :func:`hash` +built-in. + +This support allows immutable sequences, such as :class:`tuple` instances, to +be used as :class:`dict` keys and stored in :class:`set` and :class:`frozenset` +instances. + +Attempting to hash an immutable sequence that contains unhashable values will +result in :exc:`TypeError`. + + +.. _typesseq-mutable: + +Mutable Sequence Types +---------------------- + +.. index:: + triple: mutable; sequence; types + object: list + object: bytearray + +The operations in the following table are defined on mutable sequence types. +The :class:`collections.abc.MutableSequence` ABC is provided to make it +easier to correctly implement these operations on custom sequence types. + +In the table *s* is an instance of a mutable sequence type, *t* is any +iterable object and *x* is an arbitrary object that meets any type +and value restrictions imposed by *s* (for example, :class:`bytearray` only +accepts integers that meet the value restriction ``0 <= x <= 255``). + + +.. index:: + triple: operations on; sequence; types + triple: operations on; list; type + pair: subscript; assignment + pair: slice; assignment + statement: del + single: append() (sequence method) + single: clear() (sequence method) + single: copy() (sequence method) + single: extend() (sequence method) + single: insert() (sequence method) + single: pop() (sequence method) + single: remove() (sequence method) + single: reverse() (sequence method) + ++------------------------------+--------------------------------+---------------------+ +| Operation | Result | Notes | ++==============================+================================+=====================+ +| ``s[i] = x`` | item *i* of *s* is replaced by | | +| | *x* | | ++------------------------------+--------------------------------+---------------------+ +| ``s[i:j] = t`` | slice of *s* from *i* to *j* | | +| | is replaced by the contents of | | +| | the iterable *t* | | ++------------------------------+--------------------------------+---------------------+ +| ``del s[i:j]`` | same as ``s[i:j] = []`` | | ++------------------------------+--------------------------------+---------------------+ +| ``s[i:j:k] = t`` | the elements of ``s[i:j:k]`` | \(1) | +| | are replaced by those of *t* | | ++------------------------------+--------------------------------+---------------------+ +| ``del s[i:j:k]`` | removes the elements of | | +| | ``s[i:j:k]`` from the list | | ++------------------------------+--------------------------------+---------------------+ +| ``s.append(x)`` | appends *x* to the end of the | | +| | sequence (same as | | +| | ``s[len(s):len(s)] = [x]``) | | ++------------------------------+--------------------------------+---------------------+ +| ``s.clear()`` | removes all items from *s* | \(5) | +| | (same as ``del s[:]``) | | ++------------------------------+--------------------------------+---------------------+ +| ``s.copy()`` | creates a shallow copy of *s* | \(5) | +| | (same as ``s[:]``) | | ++------------------------------+--------------------------------+---------------------+ +| ``s.extend(t)`` or | extends *s* with the | | +| ``s += t`` | contents of *t* (for the | | +| | most part the same as | | +| | ``s[len(s):len(s)] = t``) | | ++------------------------------+--------------------------------+---------------------+ +| ``s *= n`` | updates *s* with its contents | \(6) | +| | repeated *n* times | | ++------------------------------+--------------------------------+---------------------+ +| ``s.insert(i, x)`` | inserts *x* into *s* at the | | +| | index given by *i* | | +| | (same as ``s[i:i] = [x]``) | | ++------------------------------+--------------------------------+---------------------+ +| ``s.pop([i])`` | retrieves the item at *i* and | \(2) | +| | also removes it from *s* | | ++------------------------------+--------------------------------+---------------------+ +| ``s.remove(x)`` | remove the first item from *s* | \(3) | +| | where ``s[i]`` is equal to *x* | | ++------------------------------+--------------------------------+---------------------+ +| ``s.reverse()`` | reverses the items of *s* in | \(4) | +| | place | | ++------------------------------+--------------------------------+---------------------+ + + +Notes: + +(1) + *t* must have the same length as the slice it is replacing. + +(2) + The optional argument *i* defaults to ``-1``, so that by default the last + item is removed and returned. + +(3) + ``remove`` raises :exc:`ValueError` when *x* is not found in *s*. + +(4) + The :meth:`reverse` method modifies the sequence in place for economy of + space when reversing a large sequence. To remind users that it operates by + side effect, it does not return the reversed sequence. + +(5) + :meth:`clear` and :meth:`!copy` are included for consistency with the + interfaces of mutable containers that don't support slicing operations + (such as :class:`dict` and :class:`set`) + + .. versionadded:: 3.3 + :meth:`clear` and :meth:`!copy` methods. + +(6) + The value *n* is an integer, or an object implementing + :meth:`~object.__index__`. Zero and negative values of *n* clear + the sequence. Items in the sequence are not copied; they are referenced + multiple times, as explained for ``s * n`` under :ref:`typesseq-common`. + + +.. _typesseq-list: + +Lists +----- + +.. index:: object: list + +Lists are mutable sequences, typically used to store collections of +homogeneous items (where the precise degree of similarity will vary by +application). + +.. class:: list([iterable]) + + Lists may be constructed in several ways: + + * Using a pair of square brackets to denote the empty list: ``[]`` + * Using square brackets, separating items with commas: ``[a]``, ``[a, b, c]`` + * Using a list comprehension: ``[x for x in iterable]`` + * Using the type constructor: ``list()`` or ``list(iterable)`` + + The constructor builds a list whose items are the same and in the same + order as *iterable*'s items. *iterable* may be either a sequence, a + container that supports iteration, or an iterator object. If *iterable* + is already a list, a copy is made and returned, similar to ``iterable[:]``. + For example, ``list('abc')`` returns ``['a', 'b', 'c']`` and + ``list( (1, 2, 3) )`` returns ``[1, 2, 3]``. + If no argument is given, the constructor creates a new empty list, ``[]``. + + + Many other operations also produce lists, including the :func:`sorted` + built-in. + + Lists implement all of the :ref:`common ` and + :ref:`mutable ` sequence operations. Lists also provide the + following additional method: + + .. method:: list.sort(*, key=None, reverse=False) + + This method sorts the list in place, using only ``<`` comparisons + between items. Exceptions are not suppressed - if any comparison operations + fail, the entire sort operation will fail (and the list will likely be left + in a partially modified state). + + :meth:`sort` accepts two arguments that can only be passed by keyword + (:ref:`keyword-only arguments `): + + *key* specifies a function of one argument that is used to extract a + comparison key from each list element (for example, ``key=str.lower``). + The key corresponding to each item in the list is calculated once and + then used for the entire sorting process. The default value of ``None`` + means that list items are sorted directly without calculating a separate + key value. + + The :func:`functools.cmp_to_key` utility is available to convert a 2.x + style *cmp* function to a *key* function. + + *reverse* is a boolean value. If set to ``True``, then the list elements + are sorted as if each comparison were reversed. + + This method modifies the sequence in place for economy of space when + sorting a large sequence. To remind users that it operates by side + effect, it does not return the sorted sequence (use :func:`sorted` to + explicitly request a new sorted list instance). + + The :meth:`sort` method is guaranteed to be stable. A sort is stable if it + guarantees not to change the relative order of elements that compare equal + --- this is helpful for sorting in multiple passes (for example, sort by + department, then by salary grade). + + .. impl-detail:: + + While a list is being sorted, the effect of attempting to mutate, or even + inspect, the list is undefined. The C implementation of Python makes the + list appear empty for the duration, and raises :exc:`ValueError` if it can + detect that the list has been mutated during a sort. + + +.. _typesseq-tuple: + +Tuples +------ + +.. index:: object: tuple + +Tuples are immutable sequences, typically used to store collections of +heterogeneous data (such as the 2-tuples produced by the :func:`enumerate` +built-in). Tuples are also used for cases where an immutable sequence of +homogeneous data is needed (such as allowing storage in a :class:`set` or +:class:`dict` instance). + +.. class:: tuple([iterable]) + + Tuples may be constructed in a number of ways: + + * Using a pair of parentheses to denote the empty tuple: ``()`` + * Using a trailing comma for a singleton tuple: ``a,`` or ``(a,)`` + * Separating items with commas: ``a, b, c`` or ``(a, b, c)`` + * Using the :func:`tuple` built-in: ``tuple()`` or ``tuple(iterable)`` + + The constructor builds a tuple whose items are the same and in the same + order as *iterable*'s items. *iterable* may be either a sequence, a + container that supports iteration, or an iterator object. If *iterable* + is already a tuple, it is returned unchanged. For example, + ``tuple('abc')`` returns ``('a', 'b', 'c')`` and + ``tuple( [1, 2, 3] )`` returns ``(1, 2, 3)``. + If no argument is given, the constructor creates a new empty tuple, ``()``. + + Note that it is actually the comma which makes a tuple, not the parentheses. + The parentheses are optional, except in the empty tuple case, or + when they are needed to avoid syntactic ambiguity. For example, + ``f(a, b, c)`` is a function call with three arguments, while + ``f((a, b, c))`` is a function call with a 3-tuple as the sole argument. + + Tuples implement all of the :ref:`common ` sequence + operations. + +For heterogeneous collections of data where access by name is clearer than +access by index, :func:`collections.namedtuple` may be a more appropriate +choice than a simple tuple object. + + +.. _typesseq-range: + +Ranges +------ + +.. index:: object: range + +The :class:`range` type represents an immutable sequence of numbers and is +commonly used for looping a specific number of times in :keyword:`for` +loops. + +.. class:: range(stop) + range(start, stop[, step]) + + The arguments to the range constructor must be integers (either built-in + :class:`int` or any object that implements the ``__index__`` special + method). If the *step* argument is omitted, it defaults to ``1``. + If the *start* argument is omitted, it defaults to ``0``. + If *step* is zero, :exc:`ValueError` is raised. + + For a positive *step*, the contents of a range ``r`` are determined by the + formula ``r[i] = start + step*i`` where ``i >= 0`` and + ``r[i] < stop``. + + For a negative *step*, the contents of the range are still determined by + the formula ``r[i] = start + step*i``, but the constraints are ``i >= 0`` + and ``r[i] > stop``. + + A range object will be empty if ``r[0]`` does not meet the value + constraint. Ranges do support negative indices, but these are interpreted + as indexing from the end of the sequence determined by the positive + indices. + + Ranges containing absolute values larger than :data:`sys.maxsize` are + permitted but some features (such as :func:`len`) may raise + :exc:`OverflowError`. + + Range examples:: + + >>> list(range(10)) + [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] + >>> list(range(1, 11)) + [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] + >>> list(range(0, 30, 5)) + [0, 5, 10, 15, 20, 25] + >>> list(range(0, 10, 3)) + [0, 3, 6, 9] + >>> list(range(0, -10, -1)) + [0, -1, -2, -3, -4, -5, -6, -7, -8, -9] + >>> list(range(0)) + [] + >>> list(range(1, 0)) + [] + + Ranges implement all of the :ref:`common ` sequence operations + except concatenation and repetition (due to the fact that range objects can + only represent sequences that follow a strict pattern and repetition and + concatenation will usually violate that pattern). + + .. attribute:: start + + The value of the *start* parameter (or ``0`` if the parameter was + not supplied) + + .. attribute:: stop + + The value of the *stop* parameter + + .. attribute:: step + + The value of the *step* parameter (or ``1`` if the parameter was + not supplied) + +The advantage of the :class:`range` type over a regular :class:`list` or +:class:`tuple` is that a :class:`range` object will always take the same +(small) amount of memory, no matter the size of the range it represents (as it +only stores the ``start``, ``stop`` and ``step`` values, calculating individual +items and subranges as needed). + +Range objects implement the :class:`collections.abc.Sequence` ABC, and provide +features such as containment tests, element index lookup, slicing and +support for negative indices (see :ref:`typesseq`): + + >>> r = range(0, 20, 2) + >>> r + range(0, 20, 2) + >>> 11 in r + False + >>> 10 in r + True + >>> r.index(10) + 5 + >>> r[5] + 10 + >>> r[:5] + range(0, 10, 2) + >>> r[-1] + 18 + +Testing range objects for equality with ``==`` and ``!=`` compares +them as sequences. That is, two range objects are considered equal if +they represent the same sequence of values. (Note that two range +objects that compare equal might have different :attr:`~range.start`, +:attr:`~range.stop` and :attr:`~range.step` attributes, for example +``range(0) == range(2, 1, 3)`` or ``range(0, 3, 2) == range(0, 4, 2)``.) + +.. versionchanged:: 3.2 + Implement the Sequence ABC. + Support slicing and negative indices. + Test :class:`int` objects for membership in constant time instead of + iterating through all items. + +.. versionchanged:: 3.3 + Define '==' and '!=' to compare range objects based on the + sequence of values they define (instead of comparing based on + object identity). + +.. versionadded:: 3.3 + The :attr:`~range.start`, :attr:`~range.stop` and :attr:`~range.step` + attributes. + +.. seealso:: + + * The `linspace recipe `_ + shows how to implement a lazy version of range suitable for floating + point applications. + +.. index:: + single: string; text sequence type + single: str (built-in class); (see also string) + object: string + +.. _textseq: + +Text Sequence Type --- :class:`str` +=================================== + +Textual data in Python is handled with :class:`str` objects, or :dfn:`strings`. +Strings are immutable +:ref:`sequences ` of Unicode code points. String literals are +written in a variety of ways: + +* Single quotes: ``'allows embedded "double" quotes'`` +* Double quotes: ``"allows embedded 'single' quotes"``. +* Triple quoted: ``'''Three single quotes'''``, ``"""Three double quotes"""`` + +Triple quoted strings may span multiple lines - all associated whitespace will +be included in the string literal. + +String literals that are part of a single expression and have only whitespace +between them will be implicitly converted to a single string literal. That +is, ``("spam " "eggs") == "spam eggs"``. + +See :ref:`strings` for more about the various forms of string literal, +including supported escape sequences, and the ``r`` ("raw") prefix that +disables most escape sequence processing. + +Strings may also be created from other objects using the :class:`str` +constructor. + +Since there is no separate "character" type, indexing a string produces +strings of length 1. That is, for a non-empty string *s*, ``s[0] == s[0:1]``. + +.. index:: + object: io.StringIO + +There is also no mutable string type, but :meth:`str.join` or +:class:`io.StringIO` can be used to efficiently construct strings from +multiple fragments. + +.. versionchanged:: 3.3 + For backwards compatibility with the Python 2 series, the ``u`` prefix is + once again permitted on string literals. It has no effect on the meaning + of string literals and cannot be combined with the ``r`` prefix. + + +.. index:: + single: string; str (built-in class) + +.. class:: str(object='') + str(object=b'', encoding='utf-8', errors='strict') + + Return a :ref:`string ` version of *object*. If *object* is not + provided, returns the empty string. Otherwise, the behavior of ``str()`` + depends on whether *encoding* or *errors* is given, as follows. + + If neither *encoding* nor *errors* is given, ``str(object)`` returns + :meth:`object.__str__() `, which is the "informal" or nicely + printable string representation of *object*. For string objects, this is + the string itself. If *object* does not have a :meth:`~object.__str__` + method, then :func:`str` falls back to returning + :meth:`repr(object) `. + + .. index:: + single: buffer protocol; str (built-in class) + single: bytes; str (built-in class) + + If at least one of *encoding* or *errors* is given, *object* should be a + :term:`bytes-like object` (e.g. :class:`bytes` or :class:`bytearray`). In + this case, if *object* is a :class:`bytes` (or :class:`bytearray`) object, + then ``str(bytes, encoding, errors)`` is equivalent to + :meth:`bytes.decode(encoding, errors) `. Otherwise, the bytes + object underlying the buffer object is obtained before calling + :meth:`bytes.decode`. See :ref:`binaryseq` and + :ref:`bufferobjects` for information on buffer objects. + + Passing a :class:`bytes` object to :func:`str` without the *encoding* + or *errors* arguments falls under the first case of returning the informal + string representation (see also the :option:`-b` command-line option to + Python). For example:: + + >>> str(b'Zoot!') + "b'Zoot!'" + + For more information on the ``str`` class and its methods, see + :ref:`textseq` and the :ref:`string-methods` section below. To output + formatted strings, see the :ref:`f-strings` and :ref:`formatstrings` + sections. In addition, see the :ref:`stringservices` section. + + +.. index:: + pair: string; methods + +.. _string-methods: + +String Methods +-------------- + +.. index:: + module: re + +Strings implement all of the :ref:`common ` sequence +operations, along with the additional methods described below. + +Strings also support two styles of string formatting, one providing a large +degree of flexibility and customization (see :meth:`str.format`, +:ref:`formatstrings` and :ref:`string-formatting`) and the other based on C +``printf`` style formatting that handles a narrower range of types and is +slightly harder to use correctly, but is often faster for the cases it can +handle (:ref:`old-string-formatting`). + +The :ref:`textservices` section of the standard library covers a number of +other modules that provide various text related utilities (including regular +expression support in the :mod:`re` module). + +.. method:: str.capitalize() + + Return a copy of the string with its first character capitalized and the + rest lowercased. + + +.. method:: str.casefold() + + Return a casefolded copy of the string. Casefolded strings may be used for + caseless matching. + + Casefolding is similar to lowercasing but more aggressive because it is + intended to remove all case distinctions in a string. For example, the German + lowercase letter ``'ß'`` is equivalent to ``"ss"``. Since it is already + lowercase, :meth:`lower` would do nothing to ``'ß'``; :meth:`casefold` + converts it to ``"ss"``. + + The casefolding algorithm is described in section 3.13 of the Unicode + Standard. + + .. versionadded:: 3.3 + + +.. method:: str.center(width[, fillchar]) + + Return centered in a string of length *width*. Padding is done using the + specified *fillchar* (default is an ASCII space). The original string is + returned if *width* is less than or equal to ``len(s)``. + + + +.. method:: str.count(sub[, start[, end]]) + + Return the number of non-overlapping occurrences of substring *sub* in the + range [*start*, *end*]. Optional arguments *start* and *end* are + interpreted as in slice notation. + + +.. method:: str.encode(encoding="utf-8", errors="strict") + + Return an encoded version of the string as a bytes object. Default encoding + is ``'utf-8'``. *errors* may be given to set a different error handling scheme. + The default for *errors* is ``'strict'``, meaning that encoding errors raise + a :exc:`UnicodeError`. Other possible + values are ``'ignore'``, ``'replace'``, ``'xmlcharrefreplace'``, + ``'backslashreplace'`` and any other name registered via + :func:`codecs.register_error`, see section :ref:`error-handlers`. For a + list of possible encodings, see section :ref:`standard-encodings`. + + .. versionchanged:: 3.1 + Support for keyword arguments added. + + +.. method:: str.endswith(suffix[, start[, end]]) + + Return ``True`` if the string ends with the specified *suffix*, otherwise return + ``False``. *suffix* can also be a tuple of suffixes to look for. With optional + *start*, test beginning at that position. With optional *end*, stop comparing + at that position. + + +.. method:: str.expandtabs(tabsize=8) + + Return a copy of the string where all tab characters are replaced by one or + more spaces, depending on the current column and the given tab size. Tab + positions occur every *tabsize* characters (default is 8, giving tab + positions at columns 0, 8, 16 and so on). To expand the string, the current + column is set to zero and the string is examined character by character. If + the character is a tab (``\t``), one or more space characters are inserted + in the result until the current column is equal to the next tab position. + (The tab character itself is not copied.) If the character is a newline + (``\n``) or return (``\r``), it is copied and the current column is reset to + zero. Any other character is copied unchanged and the current column is + incremented by one regardless of how the character is represented when + printed. + + >>> '01\t012\t0123\t01234'.expandtabs() + '01 012 0123 01234' + >>> '01\t012\t0123\t01234'.expandtabs(4) + '01 012 0123 01234' + + +.. method:: str.find(sub[, start[, end]]) + + Return the lowest index in the string where substring *sub* is found within + the slice ``s[start:end]``. Optional arguments *start* and *end* are + interpreted as in slice notation. Return ``-1`` if *sub* is not found. + + .. note:: + + The :meth:`~str.find` method should be used only if you need to know the + position of *sub*. To check if *sub* is a substring or not, use the + :keyword:`in` operator:: + + >>> 'Py' in 'Python' + True + + +.. method:: str.format(*args, **kwargs) + + Perform a string formatting operation. The string on which this method is + called can contain literal text or replacement fields delimited by braces + ``{}``. Each replacement field contains either the numeric index of a + positional argument, or the name of a keyword argument. Returns a copy of + the string where each replacement field is replaced with the string value of + the corresponding argument. + + >>> "The sum of 1 + 2 is {0}".format(1+2) + 'The sum of 1 + 2 is 3' + + See :ref:`formatstrings` for a description of the various formatting options + that can be specified in format strings. + + .. note:: + When formatting a number (:class:`int`, :class:`float`, :class:`complex`, + :class:`decimal.Decimal` and subclasses) with the ``n`` type + (ex: ``'{:n}'.format(1234)``), the function temporarily sets the + ``LC_CTYPE`` locale to the ``LC_NUMERIC`` locale to decode + ``decimal_point`` and ``thousands_sep`` fields of :c:func:`localeconv` if + they are non-ASCII or longer than 1 byte, and the ``LC_NUMERIC`` locale is + different than the ``LC_CTYPE`` locale. This temporary change affects + other threads. + + .. versionchanged:: 3.7 + When formatting a number with the ``n`` type, the function sets + temporarily the ``LC_CTYPE`` locale to the ``LC_NUMERIC`` locale in some + cases. + + +.. method:: str.format_map(mapping) + + Similar to ``str.format(**mapping)``, except that ``mapping`` is + used directly and not copied to a :class:`dict`. This is useful + if for example ``mapping`` is a dict subclass: + + >>> class Default(dict): + ... def __missing__(self, key): + ... return key + ... + >>> '{name} was born in {country}'.format_map(Default(name='Guido')) + 'Guido was born in country' + + .. versionadded:: 3.2 + + +.. method:: str.index(sub[, start[, end]]) + + Like :meth:`~str.find`, but raise :exc:`ValueError` when the substring is + not found. + + +.. method:: str.isalnum() + + Return true if all characters in the string are alphanumeric and there is at + least one character, false otherwise. A character ``c`` is alphanumeric if one + of the following returns ``True``: ``c.isalpha()``, ``c.isdecimal()``, + ``c.isdigit()``, or ``c.isnumeric()``. + + +.. method:: str.isalpha() + + Return true if all characters in the string are alphabetic and there is at least + one character, false otherwise. Alphabetic characters are those characters defined + in the Unicode character database as "Letter", i.e., those with general category + property being one of "Lm", "Lt", "Lu", "Ll", or "Lo". Note that this is different + from the "Alphabetic" property defined in the Unicode Standard. + + +.. method:: str.isascii() + + Return true if the string is empty or all characters in the string are ASCII, + false otherwise. + ASCII characters have code points in the range U+0000-U+007F. + + .. versionadded:: 3.7 + + +.. method:: str.isdecimal() + + Return true if all characters in the string are decimal + characters and there is at least one character, false + otherwise. Decimal characters are those that can be used to form + numbers in base 10, e.g. U+0660, ARABIC-INDIC DIGIT + ZERO. Formally a decimal character is a character in the Unicode + General Category "Nd". + + +.. method:: str.isdigit() + + Return true if all characters in the string are digits and there is at least one + character, false otherwise. Digits include decimal characters and digits that need + special handling, such as the compatibility superscript digits. + This covers digits which cannot be used to form numbers in base 10, + like the Kharosthi numbers. Formally, a digit is a character that has the + property value Numeric_Type=Digit or Numeric_Type=Decimal. + + +.. method:: str.isidentifier() + + Return true if the string is a valid identifier according to the language + definition, section :ref:`identifiers`. + + Use :func:`keyword.iskeyword` to test for reserved identifiers such as + :keyword:`def` and :keyword:`class`. + +.. method:: str.islower() + + Return true if all cased characters [4]_ in the string are lowercase and + there is at least one cased character, false otherwise. + + +.. method:: str.isnumeric() + + Return true if all characters in the string are numeric + characters, and there is at least one character, false + otherwise. Numeric characters include digit characters, and all characters + that have the Unicode numeric value property, e.g. U+2155, + VULGAR FRACTION ONE FIFTH. Formally, numeric characters are those with the property + value Numeric_Type=Digit, Numeric_Type=Decimal or Numeric_Type=Numeric. + + +.. method:: str.isprintable() + + Return true if all characters in the string are printable or the string is + empty, false otherwise. Nonprintable characters are those characters defined + in the Unicode character database as "Other" or "Separator", excepting the + ASCII space (0x20) which is considered printable. (Note that printable + characters in this context are those which should not be escaped when + :func:`repr` is invoked on a string. It has no bearing on the handling of + strings written to :data:`sys.stdout` or :data:`sys.stderr`.) + + +.. method:: str.isspace() + + Return true if there are only whitespace characters in the string and there is + at least one character, false otherwise. Whitespace characters are those + characters defined in the Unicode character database as "Other" or "Separator" + and those with bidirectional property being one of "WS", "B", or "S". + +.. method:: str.istitle() + + Return true if the string is a titlecased string and there is at least one + character, for example uppercase characters may only follow uncased characters + and lowercase characters only cased ones. Return false otherwise. + + +.. method:: str.isupper() + + Return true if all cased characters [4]_ in the string are uppercase and + there is at least one cased character, false otherwise. + + +.. method:: str.join(iterable) + + Return a string which is the concatenation of the strings in *iterable*. + A :exc:`TypeError` will be raised if there are any non-string values in + *iterable*, including :class:`bytes` objects. The separator between + elements is the string providing this method. + + +.. method:: str.ljust(width[, fillchar]) + + Return the string left justified in a string of length *width*. Padding is + done using the specified *fillchar* (default is an ASCII space). The + original string is returned if *width* is less than or equal to ``len(s)``. + + +.. method:: str.lower() + + Return a copy of the string with all the cased characters [4]_ converted to + lowercase. + + The lowercasing algorithm used is described in section 3.13 of the Unicode + Standard. + + +.. method:: str.lstrip([chars]) + + Return a copy of the string with leading characters removed. The *chars* + argument is a string specifying the set of characters to be removed. If omitted + or ``None``, the *chars* argument defaults to removing whitespace. The *chars* + argument is not a prefix; rather, all combinations of its values are stripped:: + + >>> ' spacious '.lstrip() + 'spacious ' + >>> 'www.example.com'.lstrip('cmowz.') + 'example.com' + + +.. staticmethod:: str.maketrans(x[, y[, z]]) + + This static method returns a translation table usable for :meth:`str.translate`. + + If there is only one argument, it must be a dictionary mapping Unicode + ordinals (integers) or characters (strings of length 1) to Unicode ordinals, + strings (of arbitrary lengths) or ``None``. Character keys will then be + converted to ordinals. + + If there are two arguments, they must be strings of equal length, and in the + resulting dictionary, each character in x will be mapped to the character at + the same position in y. If there is a third argument, it must be a string, + whose characters will be mapped to ``None`` in the result. + + +.. method:: str.partition(sep) + + Split the string at the first occurrence of *sep*, and return a 3-tuple + containing the part before the separator, the separator itself, and the part + after the separator. If the separator is not found, return a 3-tuple containing + the string itself, followed by two empty strings. + + +.. method:: str.replace(old, new[, count]) + + Return a copy of the string with all occurrences of substring *old* replaced by + *new*. If the optional argument *count* is given, only the first *count* + occurrences are replaced. + + +.. method:: str.rfind(sub[, start[, end]]) + + Return the highest index in the string where substring *sub* is found, such + that *sub* is contained within ``s[start:end]``. Optional arguments *start* + and *end* are interpreted as in slice notation. Return ``-1`` on failure. + + +.. method:: str.rindex(sub[, start[, end]]) + + Like :meth:`rfind` but raises :exc:`ValueError` when the substring *sub* is not + found. + + +.. method:: str.rjust(width[, fillchar]) + + Return the string right justified in a string of length *width*. Padding is + done using the specified *fillchar* (default is an ASCII space). The + original string is returned if *width* is less than or equal to ``len(s)``. + + +.. method:: str.rpartition(sep) + + Split the string at the last occurrence of *sep*, and return a 3-tuple + containing the part before the separator, the separator itself, and the part + after the separator. If the separator is not found, return a 3-tuple containing + two empty strings, followed by the string itself. + + +.. method:: str.rsplit(sep=None, maxsplit=-1) + + Return a list of the words in the string, using *sep* as the delimiter string. + If *maxsplit* is given, at most *maxsplit* splits are done, the *rightmost* + ones. If *sep* is not specified or ``None``, any whitespace string is a + separator. Except for splitting from the right, :meth:`rsplit` behaves like + :meth:`split` which is described in detail below. + + +.. method:: str.rstrip([chars]) + + Return a copy of the string with trailing characters removed. The *chars* + argument is a string specifying the set of characters to be removed. If omitted + or ``None``, the *chars* argument defaults to removing whitespace. The *chars* + argument is not a suffix; rather, all combinations of its values are stripped:: + + >>> ' spacious '.rstrip() + ' spacious' + >>> 'mississippi'.rstrip('ipz') + 'mississ' + + +.. method:: str.split(sep=None, maxsplit=-1) + + Return a list of the words in the string, using *sep* as the delimiter + string. If *maxsplit* is given, at most *maxsplit* splits are done (thus, + the list will have at most ``maxsplit+1`` elements). If *maxsplit* is not + specified or ``-1``, then there is no limit on the number of splits + (all possible splits are made). + + If *sep* is given, consecutive delimiters are not grouped together and are + deemed to delimit empty strings (for example, ``'1,,2'.split(',')`` returns + ``['1', '', '2']``). The *sep* argument may consist of multiple characters + (for example, ``'1<>2<>3'.split('<>')`` returns ``['1', '2', '3']``). + Splitting an empty string with a specified separator returns ``['']``. + + For example:: + + >>> '1,2,3'.split(',') + ['1', '2', '3'] + >>> '1,2,3'.split(',', maxsplit=1) + ['1', '2,3'] + >>> '1,2,,3,'.split(',') + ['1', '2', '', '3', ''] + + If *sep* is not specified or is ``None``, a different splitting algorithm is + applied: runs of consecutive whitespace are regarded as a single separator, + and the result will contain no empty strings at the start or end if the + string has leading or trailing whitespace. Consequently, splitting an empty + string or a string consisting of just whitespace with a ``None`` separator + returns ``[]``. + + For example:: + + >>> '1 2 3'.split() + ['1', '2', '3'] + >>> '1 2 3'.split(maxsplit=1) + ['1', '2 3'] + >>> ' 1 2 3 '.split() + ['1', '2', '3'] + + +.. index:: + single: universal newlines; str.splitlines method + +.. method:: str.splitlines([keepends]) + + Return a list of the lines in the string, breaking at line boundaries. Line + breaks are not included in the resulting list unless *keepends* is given and + true. + + This method splits on the following line boundaries. In particular, the + boundaries are a superset of :term:`universal newlines`. + + +-----------------------+-----------------------------+ + | Representation | Description | + +=======================+=============================+ + | ``\n`` | Line Feed | + +-----------------------+-----------------------------+ + | ``\r`` | Carriage Return | + +-----------------------+-----------------------------+ + | ``\r\n`` | Carriage Return + Line Feed | + +-----------------------+-----------------------------+ + | ``\v`` or ``\x0b`` | Line Tabulation | + +-----------------------+-----------------------------+ + | ``\f`` or ``\x0c`` | Form Feed | + +-----------------------+-----------------------------+ + | ``\x1c`` | File Separator | + +-----------------------+-----------------------------+ + | ``\x1d`` | Group Separator | + +-----------------------+-----------------------------+ + | ``\x1e`` | Record Separator | + +-----------------------+-----------------------------+ + | ``\x85`` | Next Line (C1 Control Code) | + +-----------------------+-----------------------------+ + | ``\u2028`` | Line Separator | + +-----------------------+-----------------------------+ + | ``\u2029`` | Paragraph Separator | + +-----------------------+-----------------------------+ + + .. versionchanged:: 3.2 + + ``\v`` and ``\f`` added to list of line boundaries. + + For example:: + + >>> 'ab c\n\nde fg\rkl\r\n'.splitlines() + ['ab c', '', 'de fg', 'kl'] + >>> 'ab c\n\nde fg\rkl\r\n'.splitlines(keepends=True) + ['ab c\n', '\n', 'de fg\r', 'kl\r\n'] + + Unlike :meth:`~str.split` when a delimiter string *sep* is given, this + method returns an empty list for the empty string, and a terminal line + break does not result in an extra line:: + + >>> "".splitlines() + [] + >>> "One line\n".splitlines() + ['One line'] + + For comparison, ``split('\n')`` gives:: + + >>> ''.split('\n') + [''] + >>> 'Two lines\n'.split('\n') + ['Two lines', ''] + + +.. method:: str.startswith(prefix[, start[, end]]) + + Return ``True`` if string starts with the *prefix*, otherwise return ``False``. + *prefix* can also be a tuple of prefixes to look for. With optional *start*, + test string beginning at that position. With optional *end*, stop comparing + string at that position. + + +.. method:: str.strip([chars]) + + Return a copy of the string with the leading and trailing characters removed. + The *chars* argument is a string specifying the set of characters to be removed. + If omitted or ``None``, the *chars* argument defaults to removing whitespace. + The *chars* argument is not a prefix or suffix; rather, all combinations of its + values are stripped:: + + >>> ' spacious '.strip() + 'spacious' + >>> 'www.example.com'.strip('cmowz.') + 'example' + + The outermost leading and trailing *chars* argument values are stripped + from the string. Characters are removed from the leading end until + reaching a string character that is not contained in the set of + characters in *chars*. A similar action takes place on the trailing end. + For example:: + + >>> comment_string = '#....... Section 3.2.1 Issue #32 .......' + >>> comment_string.strip('.#! ') + 'Section 3.2.1 Issue #32' + + +.. method:: str.swapcase() + + Return a copy of the string with uppercase characters converted to lowercase and + vice versa. Note that it is not necessarily true that + ``s.swapcase().swapcase() == s``. + + +.. method:: str.title() + + Return a titlecased version of the string where words start with an uppercase + character and the remaining characters are lowercase. + + For example:: + + >>> 'Hello world'.title() + 'Hello World' + + The algorithm uses a simple language-independent definition of a word as + groups of consecutive letters. The definition works in many contexts but + it means that apostrophes in contractions and possessives form word + boundaries, which may not be the desired result:: + + >>> "they're bill's friends from the UK".title() + "They'Re Bill'S Friends From The Uk" + + A workaround for apostrophes can be constructed using regular expressions:: + + >>> import re + >>> def titlecase(s): + ... return re.sub(r"[A-Za-z]+('[A-Za-z]+)?", + ... lambda mo: mo.group(0)[0].upper() + + ... mo.group(0)[1:].lower(), + ... s) + ... + >>> titlecase("they're bill's friends.") + "They're Bill's Friends." + + +.. method:: str.translate(table) + + Return a copy of the string in which each character has been mapped through + the given translation table. The table must be an object that implements + indexing via :meth:`__getitem__`, typically a :term:`mapping` or + :term:`sequence`. When indexed by a Unicode ordinal (an integer), the + table object can do any of the following: return a Unicode ordinal or a + string, to map the character to one or more other characters; return + ``None``, to delete the character from the return string; or raise a + :exc:`LookupError` exception, to map the character to itself. + + You can use :meth:`str.maketrans` to create a translation map from + character-to-character mappings in different formats. + + See also the :mod:`codecs` module for a more flexible approach to custom + character mappings. + + +.. method:: str.upper() + + Return a copy of the string with all the cased characters [4]_ converted to + uppercase. Note that ``s.upper().isupper()`` might be ``False`` if ``s`` + contains uncased characters or if the Unicode category of the resulting + character(s) is not "Lu" (Letter, uppercase), but e.g. "Lt" (Letter, + titlecase). + + The uppercasing algorithm used is described in section 3.13 of the Unicode + Standard. + + +.. method:: str.zfill(width) + + Return a copy of the string left filled with ASCII ``'0'`` digits to + make a string of length *width*. A leading sign prefix (``'+'``/``'-'``) + is handled by inserting the padding *after* the sign character rather + than before. The original string is returned if *width* is less than + or equal to ``len(s)``. + + For example:: + + >>> "42".zfill(5) + '00042' + >>> "-42".zfill(5) + '-0042' + + + +.. _old-string-formatting: + +``printf``-style String Formatting +---------------------------------- + +.. index:: + single: formatting, string (%) + single: interpolation, string (%) + single: string; formatting, printf + single: string; interpolation, printf + single: printf-style formatting + single: sprintf-style formatting + single: % (percent); printf-style formatting + +.. note:: + + The formatting operations described here exhibit a variety of quirks that + lead to a number of common errors (such as failing to display tuples and + dictionaries correctly). Using the newer :ref:`formatted string literals + `, the :meth:`str.format` interface, or :ref:`template strings + ` may help avoid these errors. Each of these + alternatives provides their own trade-offs and benefits of simplicity, + flexibility, and/or extensibility. + +String objects have one unique built-in operation: the ``%`` operator (modulo). +This is also known as the string *formatting* or *interpolation* operator. +Given ``format % values`` (where *format* is a string), ``%`` conversion +specifications in *format* are replaced with zero or more elements of *values*. +The effect is similar to using the :c:func:`sprintf` in the C language. + +If *format* requires a single argument, *values* may be a single non-tuple +object. [5]_ Otherwise, *values* must be a tuple with exactly the number of +items specified by the format string, or a single mapping object (for example, a +dictionary). + +.. index:: + single: () (parentheses); in printf-style formatting + single: * (asterisk); in printf-style formatting + single: . (dot); in printf-style formatting + +A conversion specifier contains two or more characters and has the following +components, which must occur in this order: + +#. The ``'%'`` character, which marks the start of the specifier. + +#. Mapping key (optional), consisting of a parenthesised sequence of characters + (for example, ``(somename)``). + +#. Conversion flags (optional), which affect the result of some conversion + types. + +#. Minimum field width (optional). If specified as an ``'*'`` (asterisk), the + actual width is read from the next element of the tuple in *values*, and the + object to convert comes after the minimum field width and optional precision. + +#. Precision (optional), given as a ``'.'`` (dot) followed by the precision. If + specified as ``'*'`` (an asterisk), the actual precision is read from the next + element of the tuple in *values*, and the value to convert comes after the + precision. + +#. Length modifier (optional). + +#. Conversion type. + +When the right argument is a dictionary (or other mapping type), then the +formats in the string *must* include a parenthesised mapping key into that +dictionary inserted immediately after the ``'%'`` character. The mapping key +selects the value to be formatted from the mapping. For example: + + >>> print('%(language)s has %(number)03d quote types.' % + ... {'language': "Python", "number": 2}) + Python has 002 quote types. + +In this case no ``*`` specifiers may occur in a format (since they require a +sequential parameter list). + +The conversion flag characters are: + +.. index:: + single: # (hash); in printf-style formatting + single: - (minus); in printf-style formatting + single: + (plus); in printf-style formatting + single: space; in printf-style formatting + ++---------+---------------------------------------------------------------------+ +| Flag | Meaning | ++=========+=====================================================================+ +| ``'#'`` | The value conversion will use the "alternate form" (where defined | +| | below). | ++---------+---------------------------------------------------------------------+ +| ``'0'`` | The conversion will be zero padded for numeric values. | ++---------+---------------------------------------------------------------------+ +| ``'-'`` | The converted value is left adjusted (overrides the ``'0'`` | +| | conversion if both are given). | ++---------+---------------------------------------------------------------------+ +| ``' '`` | (a space) A blank should be left before a positive number (or empty | +| | string) produced by a signed conversion. | ++---------+---------------------------------------------------------------------+ +| ``'+'`` | A sign character (``'+'`` or ``'-'``) will precede the conversion | +| | (overrides a "space" flag). | ++---------+---------------------------------------------------------------------+ + +A length modifier (``h``, ``l``, or ``L``) may be present, but is ignored as it +is not necessary for Python -- so e.g. ``%ld`` is identical to ``%d``. + +The conversion types are: + ++------------+-----------------------------------------------------+-------+ +| Conversion | Meaning | Notes | ++============+=====================================================+=======+ +| ``'d'`` | Signed integer decimal. | | ++------------+-----------------------------------------------------+-------+ +| ``'i'`` | Signed integer decimal. | | ++------------+-----------------------------------------------------+-------+ +| ``'o'`` | Signed octal value. | \(1) | ++------------+-----------------------------------------------------+-------+ +| ``'u'`` | Obsolete type -- it is identical to ``'d'``. | \(6) | ++------------+-----------------------------------------------------+-------+ +| ``'x'`` | Signed hexadecimal (lowercase). | \(2) | ++------------+-----------------------------------------------------+-------+ +| ``'X'`` | Signed hexadecimal (uppercase). | \(2) | ++------------+-----------------------------------------------------+-------+ +| ``'e'`` | Floating point exponential format (lowercase). | \(3) | ++------------+-----------------------------------------------------+-------+ +| ``'E'`` | Floating point exponential format (uppercase). | \(3) | ++------------+-----------------------------------------------------+-------+ +| ``'f'`` | Floating point decimal format. | \(3) | ++------------+-----------------------------------------------------+-------+ +| ``'F'`` | Floating point decimal format. | \(3) | ++------------+-----------------------------------------------------+-------+ +| ``'g'`` | Floating point format. Uses lowercase exponential | \(4) | +| | format if exponent is less than -4 or not less than | | +| | precision, decimal format otherwise. | | ++------------+-----------------------------------------------------+-------+ +| ``'G'`` | Floating point format. Uses uppercase exponential | \(4) | +| | format if exponent is less than -4 or not less than | | +| | precision, decimal format otherwise. | | ++------------+-----------------------------------------------------+-------+ +| ``'c'`` | Single character (accepts integer or single | | +| | character string). | | ++------------+-----------------------------------------------------+-------+ +| ``'r'`` | String (converts any Python object using | \(5) | +| | :func:`repr`). | | ++------------+-----------------------------------------------------+-------+ +| ``'s'`` | String (converts any Python object using | \(5) | +| | :func:`str`). | | ++------------+-----------------------------------------------------+-------+ +| ``'a'`` | String (converts any Python object using | \(5) | +| | :func:`ascii`). | | ++------------+-----------------------------------------------------+-------+ +| ``'%'`` | No argument is converted, results in a ``'%'`` | | +| | character in the result. | | ++------------+-----------------------------------------------------+-------+ + +Notes: + +(1) + The alternate form causes a leading octal specifier (``'0o'``) to be + inserted before the first digit. + +(2) + The alternate form causes a leading ``'0x'`` or ``'0X'`` (depending on whether + the ``'x'`` or ``'X'`` format was used) to be inserted before the first digit. + +(3) + The alternate form causes the result to always contain a decimal point, even if + no digits follow it. + + The precision determines the number of digits after the decimal point and + defaults to 6. + +(4) + The alternate form causes the result to always contain a decimal point, and + trailing zeroes are not removed as they would otherwise be. + + The precision determines the number of significant digits before and after the + decimal point and defaults to 6. + +(5) + If precision is ``N``, the output is truncated to ``N`` characters. + +(6) + See :pep:`237`. + +Since Python strings have an explicit length, ``%s`` conversions do not assume +that ``'\0'`` is the end of the string. + +.. XXX Examples? + +.. versionchanged:: 3.1 + ``%f`` conversions for numbers whose absolute value is over 1e50 are no + longer replaced by ``%g`` conversions. + + +.. index:: + single: buffer protocol; binary sequence types + +.. _binaryseq: + +Binary Sequence Types --- :class:`bytes`, :class:`bytearray`, :class:`memoryview` +================================================================================= + +.. index:: + object: bytes + object: bytearray + object: memoryview + module: array + +The core built-in types for manipulating binary data are :class:`bytes` and +:class:`bytearray`. They are supported by :class:`memoryview` which uses +the :ref:`buffer protocol ` to access the memory of other +binary objects without needing to make a copy. + +The :mod:`array` module supports efficient storage of basic data types like +32-bit integers and IEEE754 double-precision floating values. + +.. _typebytes: + +Bytes Objects +------------- + +.. index:: object: bytes + +Bytes objects are immutable sequences of single bytes. Since many major +binary protocols are based on the ASCII text encoding, bytes objects offer +several methods that are only valid when working with ASCII compatible +data and are closely related to string objects in a variety of other ways. + +.. class:: bytes([source[, encoding[, errors]]]) + + Firstly, the syntax for bytes literals is largely the same as that for string + literals, except that a ``b`` prefix is added: + + * Single quotes: ``b'still allows embedded "double" quotes'`` + * Double quotes: ``b"still allows embedded 'single' quotes"``. + * Triple quoted: ``b'''3 single quotes'''``, ``b"""3 double quotes"""`` + + Only ASCII characters are permitted in bytes literals (regardless of the + declared source code encoding). Any binary values over 127 must be entered + into bytes literals using the appropriate escape sequence. + + As with string literals, bytes literals may also use a ``r`` prefix to disable + processing of escape sequences. See :ref:`strings` for more about the various + forms of bytes literal, including supported escape sequences. + + While bytes literals and representations are based on ASCII text, bytes + objects actually behave like immutable sequences of integers, with each + value in the sequence restricted such that ``0 <= x < 256`` (attempts to + violate this restriction will trigger :exc:`ValueError`). This is done + deliberately to emphasise that while many binary formats include ASCII based + elements and can be usefully manipulated with some text-oriented algorithms, + this is not generally the case for arbitrary binary data (blindly applying + text processing algorithms to binary data formats that are not ASCII + compatible will usually lead to data corruption). + + In addition to the literal forms, bytes objects can be created in a number of + other ways: + + * A zero-filled bytes object of a specified length: ``bytes(10)`` + * From an iterable of integers: ``bytes(range(20))`` + * Copying existing binary data via the buffer protocol: ``bytes(obj)`` + + Also see the :ref:`bytes ` built-in. + + Since 2 hexadecimal digits correspond precisely to a single byte, hexadecimal + numbers are a commonly used format for describing binary data. Accordingly, + the bytes type has an additional class method to read data in that format: + + .. classmethod:: fromhex(string) + + This :class:`bytes` class method returns a bytes object, decoding the + given string object. The string must contain two hexadecimal digits per + byte, with ASCII whitespace being ignored. + + >>> bytes.fromhex('2Ef0 F1f2 ') + b'.\xf0\xf1\xf2' + + .. versionchanged:: 3.7 + :meth:`bytes.fromhex` now skips all ASCII whitespace in the string, + not just spaces. + + A reverse conversion function exists to transform a bytes object into its + hexadecimal representation. + + .. method:: hex() + + Return a string object containing two hexadecimal digits for each + byte in the instance. + + >>> b'\xf0\xf1\xf2'.hex() + 'f0f1f2' + + .. versionadded:: 3.5 + +Since bytes objects are sequences of integers (akin to a tuple), for a bytes +object *b*, ``b[0]`` will be an integer, while ``b[0:1]`` will be a bytes +object of length 1. (This contrasts with text strings, where both indexing +and slicing will produce a string of length 1) + +The representation of bytes objects uses the literal format (``b'...'``) +since it is often more useful than e.g. ``bytes([46, 46, 46])``. You can +always convert a bytes object into a list of integers using ``list(b)``. + +.. note:: + For Python 2.x users: In the Python 2.x series, a variety of implicit + conversions between 8-bit strings (the closest thing 2.x offers to a + built-in binary data type) and Unicode strings were permitted. This was a + backwards compatibility workaround to account for the fact that Python + originally only supported 8-bit text, and Unicode text was a later + addition. In Python 3.x, those implicit conversions are gone - conversions + between 8-bit binary data and Unicode text must be explicit, and bytes and + string objects will always compare unequal. + + +.. _typebytearray: + +Bytearray Objects +----------------- + +.. index:: object: bytearray + +:class:`bytearray` objects are a mutable counterpart to :class:`bytes` +objects. + +.. class:: bytearray([source[, encoding[, errors]]]) + + There is no dedicated literal syntax for bytearray objects, instead + they are always created by calling the constructor: + + * Creating an empty instance: ``bytearray()`` + * Creating a zero-filled instance with a given length: ``bytearray(10)`` + * From an iterable of integers: ``bytearray(range(20))`` + * Copying existing binary data via the buffer protocol: ``bytearray(b'Hi!')`` + + As bytearray objects are mutable, they support the + :ref:`mutable ` sequence operations in addition to the + common bytes and bytearray operations described in :ref:`bytes-methods`. + + Also see the :ref:`bytearray ` built-in. + + Since 2 hexadecimal digits correspond precisely to a single byte, hexadecimal + numbers are a commonly used format for describing binary data. Accordingly, + the bytearray type has an additional class method to read data in that format: + + .. classmethod:: fromhex(string) + + This :class:`bytearray` class method returns bytearray object, decoding + the given string object. The string must contain two hexadecimal digits + per byte, with ASCII whitespace being ignored. + + >>> bytearray.fromhex('2Ef0 F1f2 ') + bytearray(b'.\xf0\xf1\xf2') + + .. versionchanged:: 3.7 + :meth:`bytearray.fromhex` now skips all ASCII whitespace in the string, + not just spaces. + + A reverse conversion function exists to transform a bytearray object into its + hexadecimal representation. + + .. method:: hex() + + Return a string object containing two hexadecimal digits for each + byte in the instance. + + >>> bytearray(b'\xf0\xf1\xf2').hex() + 'f0f1f2' + + .. versionadded:: 3.5 + +Since bytearray objects are sequences of integers (akin to a list), for a +bytearray object *b*, ``b[0]`` will be an integer, while ``b[0:1]`` will be +a bytearray object of length 1. (This contrasts with text strings, where +both indexing and slicing will produce a string of length 1) + +The representation of bytearray objects uses the bytes literal format +(``bytearray(b'...')``) since it is often more useful than e.g. +``bytearray([46, 46, 46])``. You can always convert a bytearray object into +a list of integers using ``list(b)``. + + +.. _bytes-methods: + +Bytes and Bytearray Operations +------------------------------ + +.. index:: pair: bytes; methods + pair: bytearray; methods + +Both bytes and bytearray objects support the :ref:`common ` +sequence operations. They interoperate not just with operands of the same +type, but with any :term:`bytes-like object`. Due to this flexibility, they can be +freely mixed in operations without causing errors. However, the return type +of the result may depend on the order of operands. + +.. note:: + + The methods on bytes and bytearray objects don't accept strings as their + arguments, just as the methods on strings don't accept bytes as their + arguments. For example, you have to write:: + + a = "abc" + b = a.replace("a", "f") + + and:: + + a = b"abc" + b = a.replace(b"a", b"f") + +Some bytes and bytearray operations assume the use of ASCII compatible +binary formats, and hence should be avoided when working with arbitrary +binary data. These restrictions are covered below. + +.. note:: + Using these ASCII based operations to manipulate binary data that is not + stored in an ASCII based format may lead to data corruption. + +The following methods on bytes and bytearray objects can be used with +arbitrary binary data. + +.. method:: bytes.count(sub[, start[, end]]) + bytearray.count(sub[, start[, end]]) + + Return the number of non-overlapping occurrences of subsequence *sub* in + the range [*start*, *end*]. Optional arguments *start* and *end* are + interpreted as in slice notation. + + The subsequence to search for may be any :term:`bytes-like object` or an + integer in the range 0 to 255. + + .. versionchanged:: 3.3 + Also accept an integer in the range 0 to 255 as the subsequence. + + +.. method:: bytes.decode(encoding="utf-8", errors="strict") + bytearray.decode(encoding="utf-8", errors="strict") + + Return a string decoded from the given bytes. Default encoding is + ``'utf-8'``. *errors* may be given to set a different + error handling scheme. The default for *errors* is ``'strict'``, meaning + that encoding errors raise a :exc:`UnicodeError`. Other possible values are + ``'ignore'``, ``'replace'`` and any other name registered via + :func:`codecs.register_error`, see section :ref:`error-handlers`. For a + list of possible encodings, see section :ref:`standard-encodings`. + + .. note:: + + Passing the *encoding* argument to :class:`str` allows decoding any + :term:`bytes-like object` directly, without needing to make a temporary + bytes or bytearray object. + + .. versionchanged:: 3.1 + Added support for keyword arguments. + + +.. method:: bytes.endswith(suffix[, start[, end]]) + bytearray.endswith(suffix[, start[, end]]) + + Return ``True`` if the binary data ends with the specified *suffix*, + otherwise return ``False``. *suffix* can also be a tuple of suffixes to + look for. With optional *start*, test beginning at that position. With + optional *end*, stop comparing at that position. + + The suffix(es) to search for may be any :term:`bytes-like object`. + + +.. method:: bytes.find(sub[, start[, end]]) + bytearray.find(sub[, start[, end]]) + + Return the lowest index in the data where the subsequence *sub* is found, + such that *sub* is contained in the slice ``s[start:end]``. Optional + arguments *start* and *end* are interpreted as in slice notation. Return + ``-1`` if *sub* is not found. + + The subsequence to search for may be any :term:`bytes-like object` or an + integer in the range 0 to 255. + + .. note:: + + The :meth:`~bytes.find` method should be used only if you need to know the + position of *sub*. To check if *sub* is a substring or not, use the + :keyword:`in` operator:: + + >>> b'Py' in b'Python' + True + + .. versionchanged:: 3.3 + Also accept an integer in the range 0 to 255 as the subsequence. + + +.. method:: bytes.index(sub[, start[, end]]) + bytearray.index(sub[, start[, end]]) + + Like :meth:`~bytes.find`, but raise :exc:`ValueError` when the + subsequence is not found. + + The subsequence to search for may be any :term:`bytes-like object` or an + integer in the range 0 to 255. + + .. versionchanged:: 3.3 + Also accept an integer in the range 0 to 255 as the subsequence. + + +.. method:: bytes.join(iterable) + bytearray.join(iterable) + + Return a bytes or bytearray object which is the concatenation of the + binary data sequences in *iterable*. A :exc:`TypeError` will be raised + if there are any values in *iterable* that are not :term:`bytes-like + objects `, including :class:`str` objects. The + separator between elements is the contents of the bytes or + bytearray object providing this method. + + +.. staticmethod:: bytes.maketrans(from, to) + bytearray.maketrans(from, to) + + This static method returns a translation table usable for + :meth:`bytes.translate` that will map each character in *from* into the + character at the same position in *to*; *from* and *to* must both be + :term:`bytes-like objects ` and have the same length. + + .. versionadded:: 3.1 + + +.. method:: bytes.partition(sep) + bytearray.partition(sep) + + Split the sequence at the first occurrence of *sep*, and return a 3-tuple + containing the part before the separator, the separator itself or its + bytearray copy, and the part after the separator. + If the separator is not found, return a 3-tuple + containing a copy of the original sequence, followed by two empty bytes or + bytearray objects. + + The separator to search for may be any :term:`bytes-like object`. + + +.. method:: bytes.replace(old, new[, count]) + bytearray.replace(old, new[, count]) + + Return a copy of the sequence with all occurrences of subsequence *old* + replaced by *new*. If the optional argument *count* is given, only the + first *count* occurrences are replaced. + + The subsequence to search for and its replacement may be any + :term:`bytes-like object`. + + .. note:: + + The bytearray version of this method does *not* operate in place - it + always produces a new object, even if no changes were made. + + +.. method:: bytes.rfind(sub[, start[, end]]) + bytearray.rfind(sub[, start[, end]]) + + Return the highest index in the sequence where the subsequence *sub* is + found, such that *sub* is contained within ``s[start:end]``. Optional + arguments *start* and *end* are interpreted as in slice notation. Return + ``-1`` on failure. + + The subsequence to search for may be any :term:`bytes-like object` or an + integer in the range 0 to 255. + + .. versionchanged:: 3.3 + Also accept an integer in the range 0 to 255 as the subsequence. + + +.. method:: bytes.rindex(sub[, start[, end]]) + bytearray.rindex(sub[, start[, end]]) + + Like :meth:`~bytes.rfind` but raises :exc:`ValueError` when the + subsequence *sub* is not found. + + The subsequence to search for may be any :term:`bytes-like object` or an + integer in the range 0 to 255. + + .. versionchanged:: 3.3 + Also accept an integer in the range 0 to 255 as the subsequence. + + +.. method:: bytes.rpartition(sep) + bytearray.rpartition(sep) + + Split the sequence at the last occurrence of *sep*, and return a 3-tuple + containing the part before the separator, the separator itself or its + bytearray copy, and the part after the separator. + If the separator is not found, return a 3-tuple + containing two empty bytes or bytearray objects, followed by a copy of the + original sequence. + + The separator to search for may be any :term:`bytes-like object`. + + +.. method:: bytes.startswith(prefix[, start[, end]]) + bytearray.startswith(prefix[, start[, end]]) + + Return ``True`` if the binary data starts with the specified *prefix*, + otherwise return ``False``. *prefix* can also be a tuple of prefixes to + look for. With optional *start*, test beginning at that position. With + optional *end*, stop comparing at that position. + + The prefix(es) to search for may be any :term:`bytes-like object`. + + +.. method:: bytes.translate(table, delete=b'') + bytearray.translate(table, delete=b'') + + Return a copy of the bytes or bytearray object where all bytes occurring in + the optional argument *delete* are removed, and the remaining bytes have + been mapped through the given translation table, which must be a bytes + object of length 256. + + You can use the :func:`bytes.maketrans` method to create a translation + table. + + Set the *table* argument to ``None`` for translations that only delete + characters:: + + >>> b'read this short text'.translate(None, b'aeiou') + b'rd ths shrt txt' + + .. versionchanged:: 3.6 + *delete* is now supported as a keyword argument. + + +The following methods on bytes and bytearray objects have default behaviours +that assume the use of ASCII compatible binary formats, but can still be used +with arbitrary binary data by passing appropriate arguments. Note that all of +the bytearray methods in this section do *not* operate in place, and instead +produce new objects. + +.. method:: bytes.center(width[, fillbyte]) + bytearray.center(width[, fillbyte]) + + Return a copy of the object centered in a sequence of length *width*. + Padding is done using the specified *fillbyte* (default is an ASCII + space). For :class:`bytes` objects, the original sequence is returned if + *width* is less than or equal to ``len(s)``. + + .. note:: + + The bytearray version of this method does *not* operate in place - + it always produces a new object, even if no changes were made. + + +.. method:: bytes.ljust(width[, fillbyte]) + bytearray.ljust(width[, fillbyte]) + + Return a copy of the object left justified in a sequence of length *width*. + Padding is done using the specified *fillbyte* (default is an ASCII + space). For :class:`bytes` objects, the original sequence is returned if + *width* is less than or equal to ``len(s)``. + + .. note:: + + The bytearray version of this method does *not* operate in place - + it always produces a new object, even if no changes were made. + + +.. method:: bytes.lstrip([chars]) + bytearray.lstrip([chars]) + + Return a copy of the sequence with specified leading bytes removed. The + *chars* argument is a binary sequence specifying the set of byte values to + be removed - the name refers to the fact this method is usually used with + ASCII characters. If omitted or ``None``, the *chars* argument defaults + to removing ASCII whitespace. The *chars* argument is not a prefix; + rather, all combinations of its values are stripped:: + + >>> b' spacious '.lstrip() + b'spacious ' + >>> b'www.example.com'.lstrip(b'cmowz.') + b'example.com' + + The binary sequence of byte values to remove may be any + :term:`bytes-like object`. + + .. note:: + + The bytearray version of this method does *not* operate in place - + it always produces a new object, even if no changes were made. + + +.. method:: bytes.rjust(width[, fillbyte]) + bytearray.rjust(width[, fillbyte]) + + Return a copy of the object right justified in a sequence of length *width*. + Padding is done using the specified *fillbyte* (default is an ASCII + space). For :class:`bytes` objects, the original sequence is returned if + *width* is less than or equal to ``len(s)``. + + .. note:: + + The bytearray version of this method does *not* operate in place - + it always produces a new object, even if no changes were made. + + +.. method:: bytes.rsplit(sep=None, maxsplit=-1) + bytearray.rsplit(sep=None, maxsplit=-1) + + Split the binary sequence into subsequences of the same type, using *sep* + as the delimiter string. If *maxsplit* is given, at most *maxsplit* splits + are done, the *rightmost* ones. If *sep* is not specified or ``None``, + any subsequence consisting solely of ASCII whitespace is a separator. + Except for splitting from the right, :meth:`rsplit` behaves like + :meth:`split` which is described in detail below. + + +.. method:: bytes.rstrip([chars]) + bytearray.rstrip([chars]) + + Return a copy of the sequence with specified trailing bytes removed. The + *chars* argument is a binary sequence specifying the set of byte values to + be removed - the name refers to the fact this method is usually used with + ASCII characters. If omitted or ``None``, the *chars* argument defaults to + removing ASCII whitespace. The *chars* argument is not a suffix; rather, + all combinations of its values are stripped:: + + >>> b' spacious '.rstrip() + b' spacious' + >>> b'mississippi'.rstrip(b'ipz') + b'mississ' + + The binary sequence of byte values to remove may be any + :term:`bytes-like object`. + + .. note:: + + The bytearray version of this method does *not* operate in place - + it always produces a new object, even if no changes were made. + + +.. method:: bytes.split(sep=None, maxsplit=-1) + bytearray.split(sep=None, maxsplit=-1) + + Split the binary sequence into subsequences of the same type, using *sep* + as the delimiter string. If *maxsplit* is given and non-negative, at most + *maxsplit* splits are done (thus, the list will have at most ``maxsplit+1`` + elements). If *maxsplit* is not specified or is ``-1``, then there is no + limit on the number of splits (all possible splits are made). + + If *sep* is given, consecutive delimiters are not grouped together and are + deemed to delimit empty subsequences (for example, ``b'1,,2'.split(b',')`` + returns ``[b'1', b'', b'2']``). The *sep* argument may consist of a + multibyte sequence (for example, ``b'1<>2<>3'.split(b'<>')`` returns + ``[b'1', b'2', b'3']``). Splitting an empty sequence with a specified + separator returns ``[b'']`` or ``[bytearray(b'')]`` depending on the type + of object being split. The *sep* argument may be any + :term:`bytes-like object`. + + For example:: + + >>> b'1,2,3'.split(b',') + [b'1', b'2', b'3'] + >>> b'1,2,3'.split(b',', maxsplit=1) + [b'1', b'2,3'] + >>> b'1,2,,3,'.split(b',') + [b'1', b'2', b'', b'3', b''] + + If *sep* is not specified or is ``None``, a different splitting algorithm + is applied: runs of consecutive ASCII whitespace are regarded as a single + separator, and the result will contain no empty strings at the start or + end if the sequence has leading or trailing whitespace. Consequently, + splitting an empty sequence or a sequence consisting solely of ASCII + whitespace without a specified separator returns ``[]``. + + For example:: + + + >>> b'1 2 3'.split() + [b'1', b'2', b'3'] + >>> b'1 2 3'.split(maxsplit=1) + [b'1', b'2 3'] + >>> b' 1 2 3 '.split() + [b'1', b'2', b'3'] + + +.. method:: bytes.strip([chars]) + bytearray.strip([chars]) + + Return a copy of the sequence with specified leading and trailing bytes + removed. The *chars* argument is a binary sequence specifying the set of + byte values to be removed - the name refers to the fact this method is + usually used with ASCII characters. If omitted or ``None``, the *chars* + argument defaults to removing ASCII whitespace. The *chars* argument is + not a prefix or suffix; rather, all combinations of its values are + stripped:: + + >>> b' spacious '.strip() + b'spacious' + >>> b'www.example.com'.strip(b'cmowz.') + b'example' + + The binary sequence of byte values to remove may be any + :term:`bytes-like object`. + + .. note:: + + The bytearray version of this method does *not* operate in place - + it always produces a new object, even if no changes were made. + + +The following methods on bytes and bytearray objects assume the use of ASCII +compatible binary formats and should not be applied to arbitrary binary data. +Note that all of the bytearray methods in this section do *not* operate in +place, and instead produce new objects. + +.. method:: bytes.capitalize() + bytearray.capitalize() + + Return a copy of the sequence with each byte interpreted as an ASCII + character, and the first byte capitalized and the rest lowercased. + Non-ASCII byte values are passed through unchanged. + + .. note:: + + The bytearray version of this method does *not* operate in place - it + always produces a new object, even if no changes were made. + + +.. method:: bytes.expandtabs(tabsize=8) + bytearray.expandtabs(tabsize=8) + + Return a copy of the sequence where all ASCII tab characters are replaced + by one or more ASCII spaces, depending on the current column and the given + tab size. Tab positions occur every *tabsize* bytes (default is 8, + giving tab positions at columns 0, 8, 16 and so on). To expand the + sequence, the current column is set to zero and the sequence is examined + byte by byte. If the byte is an ASCII tab character (``b'\t'``), one or + more space characters are inserted in the result until the current column + is equal to the next tab position. (The tab character itself is not + copied.) If the current byte is an ASCII newline (``b'\n'``) or + carriage return (``b'\r'``), it is copied and the current column is reset + to zero. Any other byte value is copied unchanged and the current column + is incremented by one regardless of how the byte value is represented when + printed:: + + >>> b'01\t012\t0123\t01234'.expandtabs() + b'01 012 0123 01234' + >>> b'01\t012\t0123\t01234'.expandtabs(4) + b'01 012 0123 01234' + + .. note:: + + The bytearray version of this method does *not* operate in place - it + always produces a new object, even if no changes were made. + + +.. method:: bytes.isalnum() + bytearray.isalnum() + + Return true if all bytes in the sequence are alphabetical ASCII characters + or ASCII decimal digits and the sequence is not empty, false otherwise. + Alphabetic ASCII characters are those byte values in the sequence + ``b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'``. ASCII decimal + digits are those byte values in the sequence ``b'0123456789'``. + + For example:: + + >>> b'ABCabc1'.isalnum() + True + >>> b'ABC abc1'.isalnum() + False + + +.. method:: bytes.isalpha() + bytearray.isalpha() + + Return true if all bytes in the sequence are alphabetic ASCII characters + and the sequence is not empty, false otherwise. Alphabetic ASCII + characters are those byte values in the sequence + ``b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'``. + + For example:: + + >>> b'ABCabc'.isalpha() + True + >>> b'ABCabc1'.isalpha() + False + + +.. method:: bytes.isascii() + bytearray.isascii() + + Return true if the sequence is empty or all bytes in the sequence are ASCII, + false otherwise. + ASCII bytes are in the range 0-0x7F. + + .. versionadded:: 3.7 + + +.. method:: bytes.isdigit() + bytearray.isdigit() + + Return true if all bytes in the sequence are ASCII decimal digits + and the sequence is not empty, false otherwise. ASCII decimal digits are + those byte values in the sequence ``b'0123456789'``. + + For example:: + + >>> b'1234'.isdigit() + True + >>> b'1.23'.isdigit() + False + + +.. method:: bytes.islower() + bytearray.islower() + + Return true if there is at least one lowercase ASCII character + in the sequence and no uppercase ASCII characters, false otherwise. + + For example:: + + >>> b'hello world'.islower() + True + >>> b'Hello world'.islower() + False + + Lowercase ASCII characters are those byte values in the sequence + ``b'abcdefghijklmnopqrstuvwxyz'``. Uppercase ASCII characters + are those byte values in the sequence ``b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'``. + + +.. method:: bytes.isspace() + bytearray.isspace() + + Return true if all bytes in the sequence are ASCII whitespace and the + sequence is not empty, false otherwise. ASCII whitespace characters are + those byte values in the sequence ``b' \t\n\r\x0b\f'`` (space, tab, newline, + carriage return, vertical tab, form feed). + + +.. method:: bytes.istitle() + bytearray.istitle() + + Return true if the sequence is ASCII titlecase and the sequence is not + empty, false otherwise. See :meth:`bytes.title` for more details on the + definition of "titlecase". + + For example:: + + >>> b'Hello World'.istitle() + True + >>> b'Hello world'.istitle() + False + + +.. method:: bytes.isupper() + bytearray.isupper() + + Return true if there is at least one uppercase alphabetic ASCII character + in the sequence and no lowercase ASCII characters, false otherwise. + + For example:: + + >>> b'HELLO WORLD'.isupper() + True + >>> b'Hello world'.isupper() + False + + Lowercase ASCII characters are those byte values in the sequence + ``b'abcdefghijklmnopqrstuvwxyz'``. Uppercase ASCII characters + are those byte values in the sequence ``b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'``. + + +.. method:: bytes.lower() + bytearray.lower() + + Return a copy of the sequence with all the uppercase ASCII characters + converted to their corresponding lowercase counterpart. + + For example:: + + >>> b'Hello World'.lower() + b'hello world' + + Lowercase ASCII characters are those byte values in the sequence + ``b'abcdefghijklmnopqrstuvwxyz'``. Uppercase ASCII characters + are those byte values in the sequence ``b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'``. + + .. note:: + + The bytearray version of this method does *not* operate in place - it + always produces a new object, even if no changes were made. + + +.. index:: + single: universal newlines; bytes.splitlines method + single: universal newlines; bytearray.splitlines method + +.. method:: bytes.splitlines(keepends=False) + bytearray.splitlines(keepends=False) + + Return a list of the lines in the binary sequence, breaking at ASCII + line boundaries. This method uses the :term:`universal newlines` approach + to splitting lines. Line breaks are not included in the resulting list + unless *keepends* is given and true. + + For example:: + + >>> b'ab c\n\nde fg\rkl\r\n'.splitlines() + [b'ab c', b'', b'de fg', b'kl'] + >>> b'ab c\n\nde fg\rkl\r\n'.splitlines(keepends=True) + [b'ab c\n', b'\n', b'de fg\r', b'kl\r\n'] + + Unlike :meth:`~bytes.split` when a delimiter string *sep* is given, this + method returns an empty list for the empty string, and a terminal line + break does not result in an extra line:: + + >>> b"".split(b'\n'), b"Two lines\n".split(b'\n') + ([b''], [b'Two lines', b'']) + >>> b"".splitlines(), b"One line\n".splitlines() + ([], [b'One line']) + + +.. method:: bytes.swapcase() + bytearray.swapcase() + + Return a copy of the sequence with all the lowercase ASCII characters + converted to their corresponding uppercase counterpart and vice-versa. + + For example:: + + >>> b'Hello World'.swapcase() + b'hELLO wORLD' + + Lowercase ASCII characters are those byte values in the sequence + ``b'abcdefghijklmnopqrstuvwxyz'``. Uppercase ASCII characters + are those byte values in the sequence ``b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'``. + + Unlike :func:`str.swapcase()`, it is always the case that + ``bin.swapcase().swapcase() == bin`` for the binary versions. Case + conversions are symmetrical in ASCII, even though that is not generally + true for arbitrary Unicode code points. + + .. note:: + + The bytearray version of this method does *not* operate in place - it + always produces a new object, even if no changes were made. + + +.. method:: bytes.title() + bytearray.title() + + Return a titlecased version of the binary sequence where words start with + an uppercase ASCII character and the remaining characters are lowercase. + Uncased byte values are left unmodified. + + For example:: + + >>> b'Hello world'.title() + b'Hello World' + + Lowercase ASCII characters are those byte values in the sequence + ``b'abcdefghijklmnopqrstuvwxyz'``. Uppercase ASCII characters + are those byte values in the sequence ``b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'``. + All other byte values are uncased. + + The algorithm uses a simple language-independent definition of a word as + groups of consecutive letters. The definition works in many contexts but + it means that apostrophes in contractions and possessives form word + boundaries, which may not be the desired result:: + + >>> b"they're bill's friends from the UK".title() + b"They'Re Bill'S Friends From The Uk" + + A workaround for apostrophes can be constructed using regular expressions:: + + >>> import re + >>> def titlecase(s): + ... return re.sub(rb"[A-Za-z]+('[A-Za-z]+)?", + ... lambda mo: mo.group(0)[0:1].upper() + + ... mo.group(0)[1:].lower(), + ... s) + ... + >>> titlecase(b"they're bill's friends.") + b"They're Bill's Friends." + + .. note:: + + The bytearray version of this method does *not* operate in place - it + always produces a new object, even if no changes were made. + + +.. method:: bytes.upper() + bytearray.upper() + + Return a copy of the sequence with all the lowercase ASCII characters + converted to their corresponding uppercase counterpart. + + For example:: + + >>> b'Hello World'.upper() + b'HELLO WORLD' + + Lowercase ASCII characters are those byte values in the sequence + ``b'abcdefghijklmnopqrstuvwxyz'``. Uppercase ASCII characters + are those byte values in the sequence ``b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'``. + + .. note:: + + The bytearray version of this method does *not* operate in place - it + always produces a new object, even if no changes were made. + + +.. method:: bytes.zfill(width) + bytearray.zfill(width) + + Return a copy of the sequence left filled with ASCII ``b'0'`` digits to + make a sequence of length *width*. A leading sign prefix (``b'+'``/ + ``b'-'``) is handled by inserting the padding *after* the sign character + rather than before. For :class:`bytes` objects, the original sequence is + returned if *width* is less than or equal to ``len(seq)``. + + For example:: + + >>> b"42".zfill(5) + b'00042' + >>> b"-42".zfill(5) + b'-0042' + + .. note:: + + The bytearray version of this method does *not* operate in place - it + always produces a new object, even if no changes were made. + + +.. _bytes-formatting: + +``printf``-style Bytes Formatting +---------------------------------- + +.. index:: + single: formatting; bytes (%) + single: formatting; bytearray (%) + single: interpolation; bytes (%) + single: interpolation; bytearray (%) + single: bytes; formatting + single: bytearray; formatting + single: bytes; interpolation + single: bytearray; interpolation + single: printf-style formatting + single: sprintf-style formatting + single: % (percent); printf-style formatting + +.. note:: + + The formatting operations described here exhibit a variety of quirks that + lead to a number of common errors (such as failing to display tuples and + dictionaries correctly). If the value being printed may be a tuple or + dictionary, wrap it in a tuple. + +Bytes objects (``bytes``/``bytearray``) have one unique built-in operation: +the ``%`` operator (modulo). +This is also known as the bytes *formatting* or *interpolation* operator. +Given ``format % values`` (where *format* is a bytes object), ``%`` conversion +specifications in *format* are replaced with zero or more elements of *values*. +The effect is similar to using the :c:func:`sprintf` in the C language. + +If *format* requires a single argument, *values* may be a single non-tuple +object. [5]_ Otherwise, *values* must be a tuple with exactly the number of +items specified by the format bytes object, or a single mapping object (for +example, a dictionary). + +.. index:: + single: () (parentheses); in printf-style formatting + single: * (asterisk); in printf-style formatting + single: . (dot); in printf-style formatting + +A conversion specifier contains two or more characters and has the following +components, which must occur in this order: + +#. The ``'%'`` character, which marks the start of the specifier. + +#. Mapping key (optional), consisting of a parenthesised sequence of characters + (for example, ``(somename)``). + +#. Conversion flags (optional), which affect the result of some conversion + types. + +#. Minimum field width (optional). If specified as an ``'*'`` (asterisk), the + actual width is read from the next element of the tuple in *values*, and the + object to convert comes after the minimum field width and optional precision. + +#. Precision (optional), given as a ``'.'`` (dot) followed by the precision. If + specified as ``'*'`` (an asterisk), the actual precision is read from the next + element of the tuple in *values*, and the value to convert comes after the + precision. + +#. Length modifier (optional). + +#. Conversion type. + +When the right argument is a dictionary (or other mapping type), then the +formats in the bytes object *must* include a parenthesised mapping key into that +dictionary inserted immediately after the ``'%'`` character. The mapping key +selects the value to be formatted from the mapping. For example: + + >>> print(b'%(language)s has %(number)03d quote types.' % + ... {b'language': b"Python", b"number": 2}) + b'Python has 002 quote types.' + +In this case no ``*`` specifiers may occur in a format (since they require a +sequential parameter list). + +The conversion flag characters are: + +.. index:: + single: # (hash); in printf-style formatting + single: - (minus); in printf-style formatting + single: + (plus); in printf-style formatting + single: space; in printf-style formatting + ++---------+---------------------------------------------------------------------+ +| Flag | Meaning | ++=========+=====================================================================+ +| ``'#'`` | The value conversion will use the "alternate form" (where defined | +| | below). | ++---------+---------------------------------------------------------------------+ +| ``'0'`` | The conversion will be zero padded for numeric values. | ++---------+---------------------------------------------------------------------+ +| ``'-'`` | The converted value is left adjusted (overrides the ``'0'`` | +| | conversion if both are given). | ++---------+---------------------------------------------------------------------+ +| ``' '`` | (a space) A blank should be left before a positive number (or empty | +| | string) produced by a signed conversion. | ++---------+---------------------------------------------------------------------+ +| ``'+'`` | A sign character (``'+'`` or ``'-'``) will precede the conversion | +| | (overrides a "space" flag). | ++---------+---------------------------------------------------------------------+ + +A length modifier (``h``, ``l``, or ``L``) may be present, but is ignored as it +is not necessary for Python -- so e.g. ``%ld`` is identical to ``%d``. + +The conversion types are: + ++------------+-----------------------------------------------------+-------+ +| Conversion | Meaning | Notes | ++============+=====================================================+=======+ +| ``'d'`` | Signed integer decimal. | | ++------------+-----------------------------------------------------+-------+ +| ``'i'`` | Signed integer decimal. | | ++------------+-----------------------------------------------------+-------+ +| ``'o'`` | Signed octal value. | \(1) | ++------------+-----------------------------------------------------+-------+ +| ``'u'`` | Obsolete type -- it is identical to ``'d'``. | \(8) | ++------------+-----------------------------------------------------+-------+ +| ``'x'`` | Signed hexadecimal (lowercase). | \(2) | ++------------+-----------------------------------------------------+-------+ +| ``'X'`` | Signed hexadecimal (uppercase). | \(2) | ++------------+-----------------------------------------------------+-------+ +| ``'e'`` | Floating point exponential format (lowercase). | \(3) | ++------------+-----------------------------------------------------+-------+ +| ``'E'`` | Floating point exponential format (uppercase). | \(3) | ++------------+-----------------------------------------------------+-------+ +| ``'f'`` | Floating point decimal format. | \(3) | ++------------+-----------------------------------------------------+-------+ +| ``'F'`` | Floating point decimal format. | \(3) | ++------------+-----------------------------------------------------+-------+ +| ``'g'`` | Floating point format. Uses lowercase exponential | \(4) | +| | format if exponent is less than -4 or not less than | | +| | precision, decimal format otherwise. | | ++------------+-----------------------------------------------------+-------+ +| ``'G'`` | Floating point format. Uses uppercase exponential | \(4) | +| | format if exponent is less than -4 or not less than | | +| | precision, decimal format otherwise. | | ++------------+-----------------------------------------------------+-------+ +| ``'c'`` | Single byte (accepts integer or single | | +| | byte objects). | | ++------------+-----------------------------------------------------+-------+ +| ``'b'`` | Bytes (any object that follows the | \(5) | +| | :ref:`buffer protocol ` or has | | +| | :meth:`__bytes__`). | | ++------------+-----------------------------------------------------+-------+ +| ``'s'`` | ``'s'`` is an alias for ``'b'`` and should only | \(6) | +| | be used for Python2/3 code bases. | | ++------------+-----------------------------------------------------+-------+ +| ``'a'`` | Bytes (converts any Python object using | \(5) | +| | ``repr(obj).encode('ascii','backslashreplace)``). | | ++------------+-----------------------------------------------------+-------+ +| ``'r'`` | ``'r'`` is an alias for ``'a'`` and should only | \(7) | +| | be used for Python2/3 code bases. | | ++------------+-----------------------------------------------------+-------+ +| ``'%'`` | No argument is converted, results in a ``'%'`` | | +| | character in the result. | | ++------------+-----------------------------------------------------+-------+ + +Notes: + +(1) + The alternate form causes a leading octal specifier (``'0o'``) to be + inserted before the first digit. + +(2) + The alternate form causes a leading ``'0x'`` or ``'0X'`` (depending on whether + the ``'x'`` or ``'X'`` format was used) to be inserted before the first digit. + +(3) + The alternate form causes the result to always contain a decimal point, even if + no digits follow it. + + The precision determines the number of digits after the decimal point and + defaults to 6. + +(4) + The alternate form causes the result to always contain a decimal point, and + trailing zeroes are not removed as they would otherwise be. + + The precision determines the number of significant digits before and after the + decimal point and defaults to 6. + +(5) + If precision is ``N``, the output is truncated to ``N`` characters. + +(6) + ``b'%s'`` is deprecated, but will not be removed during the 3.x series. + +(7) + ``b'%r'`` is deprecated, but will not be removed during the 3.x series. + +(8) + See :pep:`237`. + +.. note:: + + The bytearray version of this method does *not* operate in place - it + always produces a new object, even if no changes were made. + +.. seealso:: + + :pep:`461` - Adding % formatting to bytes and bytearray + +.. versionadded:: 3.5 + +.. _typememoryview: + +Memory Views +------------ + +:class:`memoryview` objects allow Python code to access the internal data +of an object that supports the :ref:`buffer protocol ` without +copying. + +.. class:: memoryview(obj) + + Create a :class:`memoryview` that references *obj*. *obj* must support the + buffer protocol. Built-in objects that support the buffer protocol include + :class:`bytes` and :class:`bytearray`. + + A :class:`memoryview` has the notion of an *element*, which is the + atomic memory unit handled by the originating object *obj*. For many + simple types such as :class:`bytes` and :class:`bytearray`, an element + is a single byte, but other types such as :class:`array.array` may have + bigger elements. + + ``len(view)`` is equal to the length of :class:`~memoryview.tolist`. + If ``view.ndim = 0``, the length is 1. If ``view.ndim = 1``, the length + is equal to the number of elements in the view. For higher dimensions, + the length is equal to the length of the nested list representation of + the view. The :class:`~memoryview.itemsize` attribute will give you the + number of bytes in a single element. + + A :class:`memoryview` supports slicing and indexing to expose its data. + One-dimensional slicing will result in a subview:: + + >>> v = memoryview(b'abcefg') + >>> v[1] + 98 + >>> v[-1] + 103 + >>> v[1:4] + + >>> bytes(v[1:4]) + b'bce' + + If :class:`~memoryview.format` is one of the native format specifiers + from the :mod:`struct` module, indexing with an integer or a tuple of + integers is also supported and returns a single *element* with + the correct type. One-dimensional memoryviews can be indexed + with an integer or a one-integer tuple. Multi-dimensional memoryviews + can be indexed with tuples of exactly *ndim* integers where *ndim* is + the number of dimensions. Zero-dimensional memoryviews can be indexed + with the empty tuple. + + Here is an example with a non-byte format:: + + >>> import array + >>> a = array.array('l', [-11111111, 22222222, -33333333, 44444444]) + >>> m = memoryview(a) + >>> m[0] + -11111111 + >>> m[-1] + 44444444 + >>> m[::2].tolist() + [-11111111, -33333333] + + If the underlying object is writable, the memoryview supports + one-dimensional slice assignment. Resizing is not allowed:: + + >>> data = bytearray(b'abcefg') + >>> v = memoryview(data) + >>> v.readonly + False + >>> v[0] = ord(b'z') + >>> data + bytearray(b'zbcefg') + >>> v[1:4] = b'123' + >>> data + bytearray(b'z123fg') + >>> v[2:3] = b'spam' + Traceback (most recent call last): + File "", line 1, in + ValueError: memoryview assignment: lvalue and rvalue have different structures + >>> v[2:6] = b'spam' + >>> data + bytearray(b'z1spam') + + One-dimensional memoryviews of hashable (read-only) types with formats + 'B', 'b' or 'c' are also hashable. The hash is defined as + ``hash(m) == hash(m.tobytes())``:: + + >>> v = memoryview(b'abcefg') + >>> hash(v) == hash(b'abcefg') + True + >>> hash(v[2:4]) == hash(b'ce') + True + >>> hash(v[::-2]) == hash(b'abcefg'[::-2]) + True + + .. versionchanged:: 3.3 + One-dimensional memoryviews can now be sliced. + One-dimensional memoryviews with formats 'B', 'b' or 'c' are now hashable. + + .. versionchanged:: 3.4 + memoryview is now registered automatically with + :class:`collections.abc.Sequence` + + .. versionchanged:: 3.5 + memoryviews can now be indexed with tuple of integers. + + :class:`memoryview` has several methods: + + .. method:: __eq__(exporter) + + A memoryview and a :pep:`3118` exporter are equal if their shapes are + equivalent and if all corresponding values are equal when the operands' + respective format codes are interpreted using :mod:`struct` syntax. + + For the subset of :mod:`struct` format strings currently supported by + :meth:`tolist`, ``v`` and ``w`` are equal if ``v.tolist() == w.tolist()``:: + + >>> import array + >>> a = array.array('I', [1, 2, 3, 4, 5]) + >>> b = array.array('d', [1.0, 2.0, 3.0, 4.0, 5.0]) + >>> c = array.array('b', [5, 3, 1]) + >>> x = memoryview(a) + >>> y = memoryview(b) + >>> x == a == y == b + True + >>> x.tolist() == a.tolist() == y.tolist() == b.tolist() + True + >>> z = y[::-2] + >>> z == c + True + >>> z.tolist() == c.tolist() + True + + If either format string is not supported by the :mod:`struct` module, + then the objects will always compare as unequal (even if the format + strings and buffer contents are identical):: + + >>> from ctypes import BigEndianStructure, c_long + >>> class BEPoint(BigEndianStructure): + ... _fields_ = [("x", c_long), ("y", c_long)] + ... + >>> point = BEPoint(100, 200) + >>> a = memoryview(point) + >>> b = memoryview(point) + >>> a == point + False + >>> a == b + False + + Note that, as with floating point numbers, ``v is w`` does *not* imply + ``v == w`` for memoryview objects. + + .. versionchanged:: 3.3 + Previous versions compared the raw memory disregarding the item format + and the logical array structure. + + .. method:: tobytes() + + Return the data in the buffer as a bytestring. This is equivalent to + calling the :class:`bytes` constructor on the memoryview. :: + + >>> m = memoryview(b"abc") + >>> m.tobytes() + b'abc' + >>> bytes(m) + b'abc' + + For non-contiguous arrays the result is equal to the flattened list + representation with all elements converted to bytes. :meth:`tobytes` + supports all format strings, including those that are not in + :mod:`struct` module syntax. + + .. method:: hex() + + Return a string object containing two hexadecimal digits for each + byte in the buffer. :: + + >>> m = memoryview(b"abc") + >>> m.hex() + '616263' + + .. versionadded:: 3.5 + + .. method:: tolist() + + Return the data in the buffer as a list of elements. :: + + >>> memoryview(b'abc').tolist() + [97, 98, 99] + >>> import array + >>> a = array.array('d', [1.1, 2.2, 3.3]) + >>> m = memoryview(a) + >>> m.tolist() + [1.1, 2.2, 3.3] + + .. versionchanged:: 3.3 + :meth:`tolist` now supports all single character native formats in + :mod:`struct` module syntax as well as multi-dimensional + representations. + + .. method:: release() + + Release the underlying buffer exposed by the memoryview object. Many + objects take special actions when a view is held on them (for example, + a :class:`bytearray` would temporarily forbid resizing); therefore, + calling release() is handy to remove these restrictions (and free any + dangling resources) as soon as possible. + + After this method has been called, any further operation on the view + raises a :class:`ValueError` (except :meth:`release()` itself which can + be called multiple times):: + + >>> m = memoryview(b'abc') + >>> m.release() + >>> m[0] + Traceback (most recent call last): + File "", line 1, in + ValueError: operation forbidden on released memoryview object + + The context management protocol can be used for a similar effect, + using the ``with`` statement:: + + >>> with memoryview(b'abc') as m: + ... m[0] + ... + 97 + >>> m[0] + Traceback (most recent call last): + File "", line 1, in + ValueError: operation forbidden on released memoryview object + + .. versionadded:: 3.2 + + .. method:: cast(format[, shape]) + + Cast a memoryview to a new format or shape. *shape* defaults to + ``[byte_length//new_itemsize]``, which means that the result view + will be one-dimensional. The return value is a new memoryview, but + the buffer itself is not copied. Supported casts are 1D -> C-:term:`contiguous` + and C-contiguous -> 1D. + + The destination format is restricted to a single element native format in + :mod:`struct` syntax. One of the formats must be a byte format + ('B', 'b' or 'c'). The byte length of the result must be the same + as the original length. + + Cast 1D/long to 1D/unsigned bytes:: + + >>> import array + >>> a = array.array('l', [1,2,3]) + >>> x = memoryview(a) + >>> x.format + 'l' + >>> x.itemsize + 8 + >>> len(x) + 3 + >>> x.nbytes + 24 + >>> y = x.cast('B') + >>> y.format + 'B' + >>> y.itemsize + 1 + >>> len(y) + 24 + >>> y.nbytes + 24 + + Cast 1D/unsigned bytes to 1D/char:: + + >>> b = bytearray(b'zyz') + >>> x = memoryview(b) + >>> x[0] = b'a' + Traceback (most recent call last): + File "", line 1, in + ValueError: memoryview: invalid value for format "B" + >>> y = x.cast('c') + >>> y[0] = b'a' + >>> b + bytearray(b'ayz') + + Cast 1D/bytes to 3D/ints to 1D/signed char:: + + >>> import struct + >>> buf = struct.pack("i"*12, *list(range(12))) + >>> x = memoryview(buf) + >>> y = x.cast('i', shape=[2,2,3]) + >>> y.tolist() + [[[0, 1, 2], [3, 4, 5]], [[6, 7, 8], [9, 10, 11]]] + >>> y.format + 'i' + >>> y.itemsize + 4 + >>> len(y) + 2 + >>> y.nbytes + 48 + >>> z = y.cast('b') + >>> z.format + 'b' + >>> z.itemsize + 1 + >>> len(z) + 48 + >>> z.nbytes + 48 + + Cast 1D/unsigned long to 2D/unsigned long:: + + >>> buf = struct.pack("L"*6, *list(range(6))) + >>> x = memoryview(buf) + >>> y = x.cast('L', shape=[2,3]) + >>> len(y) + 2 + >>> y.nbytes + 48 + >>> y.tolist() + [[0, 1, 2], [3, 4, 5]] + + .. versionadded:: 3.3 + + .. versionchanged:: 3.5 + The source format is no longer restricted when casting to a byte view. + + There are also several readonly attributes available: + + .. attribute:: obj + + The underlying object of the memoryview:: + + >>> b = bytearray(b'xyz') + >>> m = memoryview(b) + >>> m.obj is b + True + + .. versionadded:: 3.3 + + .. attribute:: nbytes + + ``nbytes == product(shape) * itemsize == len(m.tobytes())``. This is + the amount of space in bytes that the array would use in a contiguous + representation. It is not necessarily equal to ``len(m)``:: + + >>> import array + >>> a = array.array('i', [1,2,3,4,5]) + >>> m = memoryview(a) + >>> len(m) + 5 + >>> m.nbytes + 20 + >>> y = m[::2] + >>> len(y) + 3 + >>> y.nbytes + 12 + >>> len(y.tobytes()) + 12 + + Multi-dimensional arrays:: + + >>> import struct + >>> buf = struct.pack("d"*12, *[1.5*x for x in range(12)]) + >>> x = memoryview(buf) + >>> y = x.cast('d', shape=[3,4]) + >>> y.tolist() + [[0.0, 1.5, 3.0, 4.5], [6.0, 7.5, 9.0, 10.5], [12.0, 13.5, 15.0, 16.5]] + >>> len(y) + 3 + >>> y.nbytes + 96 + + .. versionadded:: 3.3 + + .. attribute:: readonly + + A bool indicating whether the memory is read only. + + .. attribute:: format + + A string containing the format (in :mod:`struct` module style) for each + element in the view. A memoryview can be created from exporters with + arbitrary format strings, but some methods (e.g. :meth:`tolist`) are + restricted to native single element formats. + + .. versionchanged:: 3.3 + format ``'B'`` is now handled according to the struct module syntax. + This means that ``memoryview(b'abc')[0] == b'abc'[0] == 97``. + + .. attribute:: itemsize + + The size in bytes of each element of the memoryview:: + + >>> import array, struct + >>> m = memoryview(array.array('H', [32000, 32001, 32002])) + >>> m.itemsize + 2 + >>> m[0] + 32000 + >>> struct.calcsize('H') == m.itemsize + True + + .. attribute:: ndim + + An integer indicating how many dimensions of a multi-dimensional array the + memory represents. + + .. attribute:: shape + + A tuple of integers the length of :attr:`ndim` giving the shape of the + memory as an N-dimensional array. + + .. versionchanged:: 3.3 + An empty tuple instead of ``None`` when ndim = 0. + + .. attribute:: strides + + A tuple of integers the length of :attr:`ndim` giving the size in bytes to + access each element for each dimension of the array. + + .. versionchanged:: 3.3 + An empty tuple instead of ``None`` when ndim = 0. + + .. attribute:: suboffsets + + Used internally for PIL-style arrays. The value is informational only. + + .. attribute:: c_contiguous + + A bool indicating whether the memory is C-:term:`contiguous`. + + .. versionadded:: 3.3 + + .. attribute:: f_contiguous + + A bool indicating whether the memory is Fortran :term:`contiguous`. + + .. versionadded:: 3.3 + + .. attribute:: contiguous + + A bool indicating whether the memory is :term:`contiguous`. + + .. versionadded:: 3.3 + + +.. _types-set: + +Set Types --- :class:`set`, :class:`frozenset` +============================================== + +.. index:: object: set + +A :dfn:`set` object is an unordered collection of distinct :term:`hashable` objects. +Common uses include membership testing, removing duplicates from a sequence, and +computing mathematical operations such as intersection, union, difference, and +symmetric difference. +(For other containers see the built-in :class:`dict`, :class:`list`, +and :class:`tuple` classes, and the :mod:`collections` module.) + +Like other collections, sets support ``x in set``, ``len(set)``, and ``for x in +set``. Being an unordered collection, sets do not record element position or +order of insertion. Accordingly, sets do not support indexing, slicing, or +other sequence-like behavior. + +There are currently two built-in set types, :class:`set` and :class:`frozenset`. +The :class:`set` type is mutable --- the contents can be changed using methods +like :meth:`~set.add` and :meth:`~set.remove`. Since it is mutable, it has no +hash value and cannot be used as either a dictionary key or as an element of +another set. The :class:`frozenset` type is immutable and :term:`hashable` --- +its contents cannot be altered after it is created; it can therefore be used as +a dictionary key or as an element of another set. + +Non-empty sets (not frozensets) can be created by placing a comma-separated list +of elements within braces, for example: ``{'jack', 'sjoerd'}``, in addition to the +:class:`set` constructor. + +The constructors for both classes work the same: + +.. class:: set([iterable]) + frozenset([iterable]) + + Return a new set or frozenset object whose elements are taken from + *iterable*. The elements of a set must be :term:`hashable`. To + represent sets of sets, the inner sets must be :class:`frozenset` + objects. If *iterable* is not specified, a new empty set is + returned. + + Instances of :class:`set` and :class:`frozenset` provide the following + operations: + + .. describe:: len(s) + + Return the number of elements in set *s* (cardinality of *s*). + + .. describe:: x in s + + Test *x* for membership in *s*. + + .. describe:: x not in s + + Test *x* for non-membership in *s*. + + .. method:: isdisjoint(other) + + Return ``True`` if the set has no elements in common with *other*. Sets are + disjoint if and only if their intersection is the empty set. + + .. method:: issubset(other) + set <= other + + Test whether every element in the set is in *other*. + + .. method:: set < other + + Test whether the set is a proper subset of *other*, that is, + ``set <= other and set != other``. + + .. method:: issuperset(other) + set >= other + + Test whether every element in *other* is in the set. + + .. method:: set > other + + Test whether the set is a proper superset of *other*, that is, ``set >= + other and set != other``. + + .. method:: union(*others) + set | other | ... + + Return a new set with elements from the set and all others. + + .. method:: intersection(*others) + set & other & ... + + Return a new set with elements common to the set and all others. + + .. method:: difference(*others) + set - other - ... + + Return a new set with elements in the set that are not in the others. + + .. method:: symmetric_difference(other) + set ^ other + + Return a new set with elements in either the set or *other* but not both. + + .. method:: copy() + + Return a shallow copy of the set. + + + Note, the non-operator versions of :meth:`union`, :meth:`intersection`, + :meth:`difference`, and :meth:`symmetric_difference`, :meth:`issubset`, and + :meth:`issuperset` methods will accept any iterable as an argument. In + contrast, their operator based counterparts require their arguments to be + sets. This precludes error-prone constructions like ``set('abc') & 'cbs'`` + in favor of the more readable ``set('abc').intersection('cbs')``. + + Both :class:`set` and :class:`frozenset` support set to set comparisons. Two + sets are equal if and only if every element of each set is contained in the + other (each is a subset of the other). A set is less than another set if and + only if the first set is a proper subset of the second set (is a subset, but + is not equal). A set is greater than another set if and only if the first set + is a proper superset of the second set (is a superset, but is not equal). + + Instances of :class:`set` are compared to instances of :class:`frozenset` + based on their members. For example, ``set('abc') == frozenset('abc')`` + returns ``True`` and so does ``set('abc') in set([frozenset('abc')])``. + + The subset and equality comparisons do not generalize to a total ordering + function. For example, any two nonempty disjoint sets are not equal and are not + subsets of each other, so *all* of the following return ``False``: ``ab``. + + Since sets only define partial ordering (subset relationships), the output of + the :meth:`list.sort` method is undefined for lists of sets. + + Set elements, like dictionary keys, must be :term:`hashable`. + + Binary operations that mix :class:`set` instances with :class:`frozenset` + return the type of the first operand. For example: ``frozenset('ab') | + set('bc')`` returns an instance of :class:`frozenset`. + + The following table lists operations available for :class:`set` that do not + apply to immutable instances of :class:`frozenset`: + + .. method:: update(*others) + set |= other | ... + + Update the set, adding elements from all others. + + .. method:: intersection_update(*others) + set &= other & ... + + Update the set, keeping only elements found in it and all others. + + .. method:: difference_update(*others) + set -= other | ... + + Update the set, removing elements found in others. + + .. method:: symmetric_difference_update(other) + set ^= other + + Update the set, keeping only elements found in either set, but not in both. + + .. method:: add(elem) + + Add element *elem* to the set. + + .. method:: remove(elem) + + Remove element *elem* from the set. Raises :exc:`KeyError` if *elem* is + not contained in the set. + + .. method:: discard(elem) + + Remove element *elem* from the set if it is present. + + .. method:: pop() + + Remove and return an arbitrary element from the set. Raises + :exc:`KeyError` if the set is empty. + + .. method:: clear() + + Remove all elements from the set. + + + Note, the non-operator versions of the :meth:`update`, + :meth:`intersection_update`, :meth:`difference_update`, and + :meth:`symmetric_difference_update` methods will accept any iterable as an + argument. + + Note, the *elem* argument to the :meth:`__contains__`, :meth:`remove`, and + :meth:`discard` methods may be a set. To support searching for an equivalent + frozenset, a temporary one is created from *elem*. + + +.. _typesmapping: + +Mapping Types --- :class:`dict` +=============================== + +.. index:: + object: mapping + object: dictionary + triple: operations on; mapping; types + triple: operations on; dictionary; type + statement: del + builtin: len + +A :term:`mapping` object maps :term:`hashable` values to arbitrary objects. +Mappings are mutable objects. There is currently only one standard mapping +type, the :dfn:`dictionary`. (For other containers see the built-in +:class:`list`, :class:`set`, and :class:`tuple` classes, and the +:mod:`collections` module.) + +A dictionary's keys are *almost* arbitrary values. Values that are not +:term:`hashable`, that is, values containing lists, dictionaries or other +mutable types (that are compared by value rather than by object identity) may +not be used as keys. Numeric types used for keys obey the normal rules for +numeric comparison: if two numbers compare equal (such as ``1`` and ``1.0``) +then they can be used interchangeably to index the same dictionary entry. (Note +however, that since computers store floating-point numbers as approximations it +is usually unwise to use them as dictionary keys.) + +Dictionaries can be created by placing a comma-separated list of ``key: value`` +pairs within braces, for example: ``{'jack': 4098, 'sjoerd': 4127}`` or ``{4098: +'jack', 4127: 'sjoerd'}``, or by the :class:`dict` constructor. + +.. class:: dict(**kwarg) + dict(mapping, **kwarg) + dict(iterable, **kwarg) + + Return a new dictionary initialized from an optional positional argument + and a possibly empty set of keyword arguments. + + If no positional argument is given, an empty dictionary is created. + If a positional argument is given and it is a mapping object, a dictionary + is created with the same key-value pairs as the mapping object. Otherwise, + the positional argument must be an :term:`iterable` object. Each item in + the iterable must itself be an iterable with exactly two objects. The + first object of each item becomes a key in the new dictionary, and the + second object the corresponding value. If a key occurs more than once, the + last value for that key becomes the corresponding value in the new + dictionary. + + If keyword arguments are given, the keyword arguments and their values are + added to the dictionary created from the positional argument. If a key + being added is already present, the value from the keyword argument + replaces the value from the positional argument. + + To illustrate, the following examples all return a dictionary equal to + ``{"one": 1, "two": 2, "three": 3}``:: + + >>> a = dict(one=1, two=2, three=3) + >>> b = {'one': 1, 'two': 2, 'three': 3} + >>> c = dict(zip(['one', 'two', 'three'], [1, 2, 3])) + >>> d = dict([('two', 2), ('one', 1), ('three', 3)]) + >>> e = dict({'three': 3, 'one': 1, 'two': 2}) + >>> a == b == c == d == e + True + + Providing keyword arguments as in the first example only works for keys that + are valid Python identifiers. Otherwise, any valid keys can be used. + + + These are the operations that dictionaries support (and therefore, custom + mapping types should support too): + + .. describe:: len(d) + + Return the number of items in the dictionary *d*. + + .. describe:: d[key] + + Return the item of *d* with key *key*. Raises a :exc:`KeyError` if *key* is + not in the map. + + .. index:: __missing__() + + If a subclass of dict defines a method :meth:`__missing__` and *key* + is not present, the ``d[key]`` operation calls that method with the key *key* + as argument. The ``d[key]`` operation then returns or raises whatever is + returned or raised by the ``__missing__(key)`` call. + No other operations or methods invoke :meth:`__missing__`. If + :meth:`__missing__` is not defined, :exc:`KeyError` is raised. + :meth:`__missing__` must be a method; it cannot be an instance variable:: + + >>> class Counter(dict): + ... def __missing__(self, key): + ... return 0 + >>> c = Counter() + >>> c['red'] + 0 + >>> c['red'] += 1 + >>> c['red'] + 1 + + The example above shows part of the implementation of + :class:`collections.Counter`. A different ``__missing__`` method is used + by :class:`collections.defaultdict`. + + .. describe:: d[key] = value + + Set ``d[key]`` to *value*. + + .. describe:: del d[key] + + Remove ``d[key]`` from *d*. Raises a :exc:`KeyError` if *key* is not in the + map. + + .. describe:: key in d + + Return ``True`` if *d* has a key *key*, else ``False``. + + .. describe:: key not in d + + Equivalent to ``not key in d``. + + .. describe:: iter(d) + + Return an iterator over the keys of the dictionary. This is a shortcut + for ``iter(d.keys())``. + + .. method:: clear() + + Remove all items from the dictionary. + + .. method:: copy() + + Return a shallow copy of the dictionary. + + .. classmethod:: fromkeys(iterable[, value]) + + Create a new dictionary with keys from *iterable* and values set to *value*. + + :meth:`fromkeys` is a class method that returns a new dictionary. *value* + defaults to ``None``. + + .. method:: get(key[, default]) + + Return the value for *key* if *key* is in the dictionary, else *default*. + If *default* is not given, it defaults to ``None``, so that this method + never raises a :exc:`KeyError`. + + .. method:: items() + + Return a new view of the dictionary's items (``(key, value)`` pairs). + See the :ref:`documentation of view objects `. + + .. method:: keys() + + Return a new view of the dictionary's keys. See the :ref:`documentation + of view objects `. + + .. method:: pop(key[, default]) + + If *key* is in the dictionary, remove it and return its value, else return + *default*. If *default* is not given and *key* is not in the dictionary, + a :exc:`KeyError` is raised. + + .. method:: popitem() + + Remove and return a ``(key, value)`` pair from the dictionary. + Pairs are returned in :abbr:`LIFO (last-in, first-out)` order. + + :meth:`popitem` is useful to destructively iterate over a dictionary, as + often used in set algorithms. If the dictionary is empty, calling + :meth:`popitem` raises a :exc:`KeyError`. + + .. versionchanged:: 3.7 + LIFO order is now guaranteed. In prior versions, :meth:`popitem` would + return an arbitrary key/value pair. + + .. method:: setdefault(key[, default]) + + If *key* is in the dictionary, return its value. If not, insert *key* + with a value of *default* and return *default*. *default* defaults to + ``None``. + + .. method:: update([other]) + + Update the dictionary with the key/value pairs from *other*, overwriting + existing keys. Return ``None``. + + :meth:`update` accepts either another dictionary object or an iterable of + key/value pairs (as tuples or other iterables of length two). If keyword + arguments are specified, the dictionary is then updated with those + key/value pairs: ``d.update(red=1, blue=2)``. + + .. method:: values() + + Return a new view of the dictionary's values. See the + :ref:`documentation of view objects `. + + Dictionaries compare equal if and only if they have the same ``(key, + value)`` pairs. Order comparisons ('<', '<=', '>=', '>') raise + :exc:`TypeError`. + + Dictionaries preserve insertion order. Note that updating a key does not + affect the order. Keys added after deletion are inserted at the end. :: + + >>> d = {"one": 1, "two": 2, "three": 3, "four": 4} + >>> d + {'one': 1, 'two': 2, 'three': 3, 'four': 4} + >>> list(d) + ['one', 'two', 'three', 'four'] + >>> list(d.values()) + [1, 2, 3, 4] + >>> d["one"] = 42 + >>> d + {'one': 42, 'two': 2, 'three': 3, 'four': 4} + >>> del d["two"] + >>> d["two"] = None + >>> d + {'one': 42, 'three': 3, 'four': 4, 'two': None} + + .. versionchanged:: 3.7 + Dictionary order is guaranteed to be insertion order. This behavior was + an implementation detail of CPython from 3.6. + +.. seealso:: + :class:`types.MappingProxyType` can be used to create a read-only view + of a :class:`dict`. + + +.. _dict-views: + +Dictionary view objects +----------------------- + +The objects returned by :meth:`dict.keys`, :meth:`dict.values` and +:meth:`dict.items` are *view objects*. They provide a dynamic view on the +dictionary's entries, which means that when the dictionary changes, the view +reflects these changes. + +Dictionary views can be iterated over to yield their respective data, and +support membership tests: + +.. describe:: len(dictview) + + Return the number of entries in the dictionary. + +.. describe:: iter(dictview) + + Return an iterator over the keys, values or items (represented as tuples of + ``(key, value)``) in the dictionary. + + Keys and values are iterated over in insertion order. + This allows the creation of ``(value, key)`` pairs + using :func:`zip`: ``pairs = zip(d.values(), d.keys())``. Another way to + create the same list is ``pairs = [(v, k) for (k, v) in d.items()]``. + + Iterating views while adding or deleting entries in the dictionary may raise + a :exc:`RuntimeError` or fail to iterate over all entries. + + .. versionchanged:: 3.7 + Dictionary order is guaranteed to be insertion order. + +.. describe:: x in dictview + + Return ``True`` if *x* is in the underlying dictionary's keys, values or + items (in the latter case, *x* should be a ``(key, value)`` tuple). + + +Keys views are set-like since their entries are unique and hashable. If all +values are hashable, so that ``(key, value)`` pairs are unique and hashable, +then the items view is also set-like. (Values views are not treated as set-like +since the entries are generally not unique.) For set-like views, all of the +operations defined for the abstract base class :class:`collections.abc.Set` are +available (for example, ``==``, ``<``, or ``^``). + +An example of dictionary view usage:: + + >>> dishes = {'eggs': 2, 'sausage': 1, 'bacon': 1, 'spam': 500} + >>> keys = dishes.keys() + >>> values = dishes.values() + + >>> # iteration + >>> n = 0 + >>> for val in values: + ... n += val + >>> print(n) + 504 + + >>> # keys and values are iterated over in the same order (insertion order) + >>> list(keys) + ['eggs', 'sausage', 'bacon', 'spam'] + >>> list(values) + [2, 1, 1, 500] + + >>> # view objects are dynamic and reflect dict changes + >>> del dishes['eggs'] + >>> del dishes['sausage'] + >>> list(keys) + ['bacon', 'spam'] + + >>> # set operations + >>> keys & {'eggs', 'bacon', 'salad'} + {'bacon'} + >>> keys ^ {'sausage', 'juice'} + {'juice', 'sausage', 'bacon', 'spam'} + + +.. _typecontextmanager: + +Context Manager Types +===================== + +.. index:: + single: context manager + single: context management protocol + single: protocol; context management + +Python's :keyword:`with` statement supports the concept of a runtime context +defined by a context manager. This is implemented using a pair of methods +that allow user-defined classes to define a runtime context that is entered +before the statement body is executed and exited when the statement ends: + + +.. method:: contextmanager.__enter__() + + Enter the runtime context and return either this object or another object + related to the runtime context. The value returned by this method is bound to + the identifier in the :keyword:`!as` clause of :keyword:`with` statements using + this context manager. + + An example of a context manager that returns itself is a :term:`file object`. + File objects return themselves from __enter__() to allow :func:`open` to be + used as the context expression in a :keyword:`with` statement. + + An example of a context manager that returns a related object is the one + returned by :func:`decimal.localcontext`. These managers set the active + decimal context to a copy of the original decimal context and then return the + copy. This allows changes to be made to the current decimal context in the body + of the :keyword:`with` statement without affecting code outside the + :keyword:`!with` statement. + + +.. method:: contextmanager.__exit__(exc_type, exc_val, exc_tb) + + Exit the runtime context and return a Boolean flag indicating if any exception + that occurred should be suppressed. If an exception occurred while executing the + body of the :keyword:`with` statement, the arguments contain the exception type, + value and traceback information. Otherwise, all three arguments are ``None``. + + Returning a true value from this method will cause the :keyword:`with` statement + to suppress the exception and continue execution with the statement immediately + following the :keyword:`!with` statement. Otherwise the exception continues + propagating after this method has finished executing. Exceptions that occur + during execution of this method will replace any exception that occurred in the + body of the :keyword:`!with` statement. + + The exception passed in should never be reraised explicitly - instead, this + method should return a false value to indicate that the method completed + successfully and does not want to suppress the raised exception. This allows + context management code to easily detect whether or not an :meth:`__exit__` + method has actually failed. + +Python defines several context managers to support easy thread synchronisation, +prompt closure of files or other objects, and simpler manipulation of the active +decimal arithmetic context. The specific types are not treated specially beyond +their implementation of the context management protocol. See the +:mod:`contextlib` module for some examples. + +Python's :term:`generator`\s and the :class:`contextlib.contextmanager` decorator +provide a convenient way to implement these protocols. If a generator function is +decorated with the :class:`contextlib.contextmanager` decorator, it will return a +context manager implementing the necessary :meth:`__enter__` and +:meth:`__exit__` methods, rather than the iterator produced by an undecorated +generator function. + +Note that there is no specific slot for any of these methods in the type +structure for Python objects in the Python/C API. Extension types wanting to +define these methods must provide them as a normal Python accessible method. +Compared to the overhead of setting up the runtime context, the overhead of a +single class dictionary lookup is negligible. + + +.. _typesother: + +Other Built-in Types +==================== + +The interpreter supports several other kinds of objects. Most of these support +only one or two operations. + + +.. _typesmodules: + +Modules +------- + +The only special operation on a module is attribute access: ``m.name``, where +*m* is a module and *name* accesses a name defined in *m*'s symbol table. +Module attributes can be assigned to. (Note that the :keyword:`import` +statement is not, strictly speaking, an operation on a module object; ``import +foo`` does not require a module object named *foo* to exist, rather it requires +an (external) *definition* for a module named *foo* somewhere.) + +A special attribute of every module is :attr:`~object.__dict__`. This is the +dictionary containing the module's symbol table. Modifying this dictionary will +actually change the module's symbol table, but direct assignment to the +:attr:`~object.__dict__` attribute is not possible (you can write +``m.__dict__['a'] = 1``, which defines ``m.a`` to be ``1``, but you can't write +``m.__dict__ = {}``). Modifying :attr:`~object.__dict__` directly is +not recommended. + +Modules built into the interpreter are written like this: ````. If loaded from a file, they are written as ````. + + +.. _typesobjects: + +Classes and Class Instances +--------------------------- + +See :ref:`objects` and :ref:`class` for these. + + +.. _typesfunctions: + +Functions +--------- + +Function objects are created by function definitions. The only operation on a +function object is to call it: ``func(argument-list)``. + +There are really two flavors of function objects: built-in functions and +user-defined functions. Both support the same operation (to call the function), +but the implementation is different, hence the different object types. + +See :ref:`function` for more information. + + +.. _typesmethods: + +Methods +------- + +.. index:: object: method + +Methods are functions that are called using the attribute notation. There are +two flavors: built-in methods (such as :meth:`append` on lists) and class +instance methods. Built-in methods are described with the types that support +them. + +If you access a method (a function defined in a class namespace) through an +instance, you get a special object: a :dfn:`bound method` (also called +:dfn:`instance method`) object. When called, it will add the ``self`` argument +to the argument list. Bound methods have two special read-only attributes: +``m.__self__`` is the object on which the method operates, and ``m.__func__`` is +the function implementing the method. Calling ``m(arg-1, arg-2, ..., arg-n)`` +is completely equivalent to calling ``m.__func__(m.__self__, arg-1, arg-2, ..., +arg-n)``. + +Like function objects, bound method objects support getting arbitrary +attributes. However, since method attributes are actually stored on the +underlying function object (``meth.__func__``), setting method attributes on +bound methods is disallowed. Attempting to set an attribute on a method +results in an :exc:`AttributeError` being raised. In order to set a method +attribute, you need to explicitly set it on the underlying function object:: + + >>> class C: + ... def method(self): + ... pass + ... + >>> c = C() + >>> c.method.whoami = 'my name is method' # can't set on the method + Traceback (most recent call last): + File "", line 1, in + AttributeError: 'method' object has no attribute 'whoami' + >>> c.method.__func__.whoami = 'my name is method' + >>> c.method.whoami + 'my name is method' + +See :ref:`types` for more information. + + +.. index:: object; code, code object + +.. _bltin-code-objects: + +Code Objects +------------ + +.. index:: + builtin: compile + single: __code__ (function object attribute) + +Code objects are used by the implementation to represent "pseudo-compiled" +executable Python code such as a function body. They differ from function +objects because they don't contain a reference to their global execution +environment. Code objects are returned by the built-in :func:`compile` function +and can be extracted from function objects through their :attr:`__code__` +attribute. See also the :mod:`code` module. + +.. index:: + builtin: exec + builtin: eval + +A code object can be executed or evaluated by passing it (instead of a source +string) to the :func:`exec` or :func:`eval` built-in functions. + +See :ref:`types` for more information. + + +.. _bltin-type-objects: + +Type Objects +------------ + +.. index:: + builtin: type + module: types + +Type objects represent the various object types. An object's type is accessed +by the built-in function :func:`type`. There are no special operations on +types. The standard module :mod:`types` defines names for all standard built-in +types. + +Types are written like this: ````. + + +.. _bltin-null-object: + +The Null Object +--------------- + +This object is returned by functions that don't explicitly return a value. It +supports no special operations. There is exactly one null object, named +``None`` (a built-in name). ``type(None)()`` produces the same singleton. + +It is written as ``None``. + + +.. index:: single: ...; ellipsis literal +.. _bltin-ellipsis-object: + +The Ellipsis Object +------------------- + +This object is commonly used by slicing (see :ref:`slicings`). It supports no +special operations. There is exactly one ellipsis object, named +:const:`Ellipsis` (a built-in name). ``type(Ellipsis)()`` produces the +:const:`Ellipsis` singleton. + +It is written as ``Ellipsis`` or ``...``. + + +.. _bltin-notimplemented-object: + +The NotImplemented Object +------------------------- + +This object is returned from comparisons and binary operations when they are +asked to operate on types they don't support. See :ref:`comparisons` for more +information. There is exactly one ``NotImplemented`` object. +``type(NotImplemented)()`` produces the singleton instance. + +It is written as ``NotImplemented``. + + +.. _bltin-boolean-values: + +Boolean Values +-------------- + +Boolean values are the two constant objects ``False`` and ``True``. They are +used to represent truth values (although other values can also be considered +false or true). In numeric contexts (for example when used as the argument to +an arithmetic operator), they behave like the integers 0 and 1, respectively. +The built-in function :func:`bool` can be used to convert any value to a +Boolean, if the value can be interpreted as a truth value (see section +:ref:`truth` above). + +.. index:: + single: False + single: True + pair: Boolean; values + +They are written as ``False`` and ``True``, respectively. + + +.. _typesinternal: + +Internal Objects +---------------- + +See :ref:`types` for this information. It describes stack frame objects, +traceback objects, and slice objects. + + +.. _specialattrs: + +Special Attributes +================== + +The implementation adds a few special read-only attributes to several object +types, where they are relevant. Some of these are not reported by the +:func:`dir` built-in function. + + +.. attribute:: object.__dict__ + + A dictionary or other mapping object used to store an object's (writable) + attributes. + + +.. attribute:: instance.__class__ + + The class to which a class instance belongs. + + +.. attribute:: class.__bases__ + + The tuple of base classes of a class object. + + +.. attribute:: definition.__name__ + + The name of the class, function, method, descriptor, or + generator instance. + + +.. attribute:: definition.__qualname__ + + The :term:`qualified name` of the class, function, method, descriptor, + or generator instance. + + .. versionadded:: 3.3 + + +.. attribute:: class.__mro__ + + This attribute is a tuple of classes that are considered when looking for + base classes during method resolution. + + +.. method:: class.mro() + + This method can be overridden by a metaclass to customize the method + resolution order for its instances. It is called at class instantiation, and + its result is stored in :attr:`~class.__mro__`. + + +.. method:: class.__subclasses__ + + Each class keeps a list of weak references to its immediate subclasses. This + method returns a list of all those references still alive. + Example:: + + >>> int.__subclasses__() + [] + + +.. rubric:: Footnotes + +.. [1] Additional information on these special methods may be found in the Python + Reference Manual (:ref:`customization`). + +.. [2] As a consequence, the list ``[1, 2]`` is considered equal to ``[1.0, 2.0]``, and + similarly for tuples. + +.. [3] They must have since the parser can't tell the type of the operands. + +.. [4] Cased characters are those with general category property being one of + "Lu" (Letter, uppercase), "Ll" (Letter, lowercase), or "Lt" (Letter, titlecase). + +.. [5] To format only a tuple you should therefore provide a singleton tuple whose only + element is the tuple to be formatted. + diff --git a/python-3.7.4-docs-html/_sources/library/string.rst.txt b/python-3.7.4-docs-html/_sources/library/string.rst.txt new file mode 100644 index 0000000..46b2bfc --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/string.rst.txt @@ -0,0 +1,845 @@ +:mod:`string` --- Common string operations +========================================== + +.. module:: string + :synopsis: Common string operations. + +**Source code:** :source:`Lib/string.py` + +-------------- + +.. seealso:: + + :ref:`textseq` + + :ref:`string-methods` + +String constants +---------------- + +The constants defined in this module are: + + +.. data:: ascii_letters + + The concatenation of the :const:`ascii_lowercase` and :const:`ascii_uppercase` + constants described below. This value is not locale-dependent. + + +.. data:: ascii_lowercase + + The lowercase letters ``'abcdefghijklmnopqrstuvwxyz'``. This value is not + locale-dependent and will not change. + + +.. data:: ascii_uppercase + + The uppercase letters ``'ABCDEFGHIJKLMNOPQRSTUVWXYZ'``. This value is not + locale-dependent and will not change. + + +.. data:: digits + + The string ``'0123456789'``. + + +.. data:: hexdigits + + The string ``'0123456789abcdefABCDEF'``. + + +.. data:: octdigits + + The string ``'01234567'``. + + +.. data:: punctuation + + String of ASCII characters which are considered punctuation characters + in the ``C`` locale. + + +.. data:: printable + + String of ASCII characters which are considered printable. This is a + combination of :const:`digits`, :const:`ascii_letters`, :const:`punctuation`, + and :const:`whitespace`. + + +.. data:: whitespace + + A string containing all ASCII characters that are considered whitespace. + This includes the characters space, tab, linefeed, return, formfeed, and + vertical tab. + + +.. _string-formatting: + +Custom String Formatting +------------------------ + +The built-in string class provides the ability to do complex variable +substitutions and value formatting via the :meth:`~str.format` method described in +:pep:`3101`. The :class:`Formatter` class in the :mod:`string` module allows +you to create and customize your own string formatting behaviors using the same +implementation as the built-in :meth:`~str.format` method. + + +.. class:: Formatter + + The :class:`Formatter` class has the following public methods: + + .. method:: format(format_string, *args, **kwargs) + + The primary API method. It takes a format string and + an arbitrary set of positional and keyword arguments. + It is just a wrapper that calls :meth:`vformat`. + + .. versionchanged:: 3.7 + A format string argument is now :ref:`positional-only + `. + + .. method:: vformat(format_string, args, kwargs) + + This function does the actual work of formatting. It is exposed as a + separate function for cases where you want to pass in a predefined + dictionary of arguments, rather than unpacking and repacking the + dictionary as individual arguments using the ``*args`` and ``**kwargs`` + syntax. :meth:`vformat` does the work of breaking up the format string + into character data and replacement fields. It calls the various + methods described below. + + In addition, the :class:`Formatter` defines a number of methods that are + intended to be replaced by subclasses: + + .. method:: parse(format_string) + + Loop over the format_string and return an iterable of tuples + (*literal_text*, *field_name*, *format_spec*, *conversion*). This is used + by :meth:`vformat` to break the string into either literal text, or + replacement fields. + + The values in the tuple conceptually represent a span of literal text + followed by a single replacement field. If there is no literal text + (which can happen if two replacement fields occur consecutively), then + *literal_text* will be a zero-length string. If there is no replacement + field, then the values of *field_name*, *format_spec* and *conversion* + will be ``None``. + + .. method:: get_field(field_name, args, kwargs) + + Given *field_name* as returned by :meth:`parse` (see above), convert it to + an object to be formatted. Returns a tuple (obj, used_key). The default + version takes strings of the form defined in :pep:`3101`, such as + "0[name]" or "label.title". *args* and *kwargs* are as passed in to + :meth:`vformat`. The return value *used_key* has the same meaning as the + *key* parameter to :meth:`get_value`. + + .. method:: get_value(key, args, kwargs) + + Retrieve a given field value. The *key* argument will be either an + integer or a string. If it is an integer, it represents the index of the + positional argument in *args*; if it is a string, then it represents a + named argument in *kwargs*. + + The *args* parameter is set to the list of positional arguments to + :meth:`vformat`, and the *kwargs* parameter is set to the dictionary of + keyword arguments. + + For compound field names, these functions are only called for the first + component of the field name; Subsequent components are handled through + normal attribute and indexing operations. + + So for example, the field expression '0.name' would cause + :meth:`get_value` to be called with a *key* argument of 0. The ``name`` + attribute will be looked up after :meth:`get_value` returns by calling the + built-in :func:`getattr` function. + + If the index or keyword refers to an item that does not exist, then an + :exc:`IndexError` or :exc:`KeyError` should be raised. + + .. method:: check_unused_args(used_args, args, kwargs) + + Implement checking for unused arguments if desired. The arguments to this + function is the set of all argument keys that were actually referred to in + the format string (integers for positional arguments, and strings for + named arguments), and a reference to the *args* and *kwargs* that was + passed to vformat. The set of unused args can be calculated from these + parameters. :meth:`check_unused_args` is assumed to raise an exception if + the check fails. + + .. method:: format_field(value, format_spec) + + :meth:`format_field` simply calls the global :func:`format` built-in. The + method is provided so that subclasses can override it. + + .. method:: convert_field(value, conversion) + + Converts the value (returned by :meth:`get_field`) given a conversion type + (as in the tuple returned by the :meth:`parse` method). The default + version understands 's' (str), 'r' (repr) and 'a' (ascii) conversion + types. + + +.. _formatstrings: + +Format String Syntax +-------------------- + +The :meth:`str.format` method and the :class:`Formatter` class share the same +syntax for format strings (although in the case of :class:`Formatter`, +subclasses can define their own format string syntax). The syntax is +related to that of :ref:`formatted string literals `, but +there are differences. + +.. index:: + single: {} (curly brackets); in string formatting + single: . (dot); in string formatting + single: [] (square brackets); in string formatting + single: ! (exclamation); in string formatting + single: : (colon); in string formatting + +Format strings contain "replacement fields" surrounded by curly braces ``{}``. +Anything that is not contained in braces is considered literal text, which is +copied unchanged to the output. If you need to include a brace character in the +literal text, it can be escaped by doubling: ``{{`` and ``}}``. + +The grammar for a replacement field is as follows: + + .. productionlist:: sf + replacement_field: "{" [`field_name`] ["!" `conversion`] [":" `format_spec`] "}" + field_name: arg_name ("." `attribute_name` | "[" `element_index` "]")* + arg_name: [`identifier` | `digit`+] + attribute_name: `identifier` + element_index: `digit`+ | `index_string` + index_string: + + conversion: "r" | "s" | "a" + format_spec: + +In less formal terms, the replacement field can start with a *field_name* that specifies +the object whose value is to be formatted and inserted +into the output instead of the replacement field. +The *field_name* is optionally followed by a *conversion* field, which is +preceded by an exclamation point ``'!'``, and a *format_spec*, which is preceded +by a colon ``':'``. These specify a non-default format for the replacement value. + +See also the :ref:`formatspec` section. + +The *field_name* itself begins with an *arg_name* that is either a number or a +keyword. If it's a number, it refers to a positional argument, and if it's a keyword, +it refers to a named keyword argument. If the numerical arg_names in a format string +are 0, 1, 2, ... in sequence, they can all be omitted (not just some) +and the numbers 0, 1, 2, ... will be automatically inserted in that order. +Because *arg_name* is not quote-delimited, it is not possible to specify arbitrary +dictionary keys (e.g., the strings ``'10'`` or ``':-]'``) within a format string. +The *arg_name* can be followed by any number of index or +attribute expressions. An expression of the form ``'.name'`` selects the named +attribute using :func:`getattr`, while an expression of the form ``'[index]'`` +does an index lookup using :func:`__getitem__`. + +.. versionchanged:: 3.1 + The positional argument specifiers can be omitted for :meth:`str.format`, + so ``'{} {}'.format(a, b)`` is equivalent to ``'{0} {1}'.format(a, b)``. + +.. versionchanged:: 3.4 + The positional argument specifiers can be omitted for :class:`Formatter`. + +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'. + +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 +itself. However, in some cases it is desirable to force a type to be formatted +as a string, overriding its own definition of formatting. By converting the +value to a string before calling :meth:`__format__`, the normal formatting logic +is bypassed. + +Three conversion flags are currently supported: ``'!s'`` which calls :func:`str` +on the value, ``'!r'`` which calls :func:`repr` and ``'!a'`` which calls +:func:`ascii`. + +Some examples:: + + "Harold's a clever {0!s}" # Calls str() on the argument first + "Bring out the holy {name!r}" # Calls repr() on the argument first + "More {!a}" # Calls ascii() on the argument first + +The *format_spec* field contains a specification of how the value should be +presented, including such details as field width, alignment, padding, decimal +precision and so on. Each value type can define its own "formatting +mini-language" or interpretation of the *format_spec*. + +Most built-in types support a common formatting mini-language, which is +described in the next section. + +A *format_spec* field can also include nested replacement fields within it. +These nested replacement fields may contain a field name, conversion flag +and format specification, but deeper nesting is +not allowed. The replacement fields within the +format_spec are substituted before the *format_spec* string is interpreted. +This allows the formatting of a value to be dynamically specified. + +See the :ref:`formatexamples` section for some examples. + + +.. _formatspec: + +Format Specification Mini-Language +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +"Format specifications" are used within replacement fields contained within a +format string to define how individual values are presented (see +:ref:`formatstrings` and :ref:`f-strings`). +They can also be passed directly to the built-in +:func:`format` function. Each formattable type may define how the format +specification is to be interpreted. + +Most built-in types implement the following options for format specifications, +although some of the formatting options are only supported by the numeric types. + +A general convention is that an empty format string (``""``) produces +the same result as if you had called :func:`str` on the value. A +non-empty format string typically modifies the result. + +The general form of a *standard format specifier* is: + +.. productionlist:: sf + format_spec: [[`fill`]`align`][`sign`][#][0][`width`][`grouping_option`][.`precision`][`type`] + fill: + align: "<" | ">" | "=" | "^" + sign: "+" | "-" | " " + width: `digit`+ + grouping_option: "_" | "," + precision: `digit`+ + type: "b" | "c" | "d" | "e" | "E" | "f" | "F" | "g" | "G" | "n" | "o" | "s" | "x" | "X" | "%" + +If a valid *align* value is specified, it can be preceded by a *fill* +character that can be any character and defaults to a space if omitted. +It is not possible to use a literal curly brace ("``{``" or "``}``") as +the *fill* character in a :ref:`formatted string literal +` or when using the :meth:`str.format` +method. However, it is possible to insert a curly brace +with a nested replacement field. This limitation doesn't +affect the :func:`format` function. + +The meaning of the various alignment options is as follows: + + .. index:: + single: < (less); in string formatting + single: > (greater); in string formatting + single: = (equals); in string formatting + single: ^ (caret); in string formatting + + +---------+----------------------------------------------------------+ + | Option | Meaning | + +=========+==========================================================+ + | ``'<'`` | Forces the field to be left-aligned within the available | + | | space (this is the default for most objects). | + +---------+----------------------------------------------------------+ + | ``'>'`` | Forces the field to be right-aligned within the | + | | available space (this is the default for numbers). | + +---------+----------------------------------------------------------+ + | ``'='`` | Forces the padding to be placed after the sign (if any) | + | | but before the digits. This is used for printing fields | + | | in the form '+000000120'. This alignment option is only | + | | valid for numeric types. It becomes the default when '0'| + | | immediately precedes the field width. | + +---------+----------------------------------------------------------+ + | ``'^'`` | Forces the field to be centered within the available | + | | space. | + +---------+----------------------------------------------------------+ + +Note that unless a minimum field width is defined, the field width will always +be the same size as the data to fill it, so that the alignment option has no +meaning in this case. + +The *sign* option is only valid for number types, and can be one of the +following: + + .. index:: + single: + (plus); in string formatting + single: - (minus); in string formatting + single: space; in string formatting + + +---------+----------------------------------------------------------+ + | Option | Meaning | + +=========+==========================================================+ + | ``'+'`` | indicates that a sign should be used for both | + | | positive as well as negative numbers. | + +---------+----------------------------------------------------------+ + | ``'-'`` | indicates that a sign should be used only for negative | + | | numbers (this is the default behavior). | + +---------+----------------------------------------------------------+ + | space | indicates that a leading space should be used on | + | | positive numbers, and a minus sign on negative numbers. | + +---------+----------------------------------------------------------+ + + +.. index:: single: # (hash); in string formatting + +The ``'#'`` option causes the "alternate form" to be used for the +conversion. The alternate form is defined differently for different +types. This option is only valid for integer, float, complex and +Decimal types. For integers, when binary, octal, or hexadecimal output +is used, this option adds the prefix respective ``'0b'``, ``'0o'``, or +``'0x'`` to the output value. For floats, complex and Decimal the +alternate form causes the result of the conversion to always contain a +decimal-point character, even if no digits follow it. Normally, a +decimal-point character appears in the result of these conversions +only if a digit follows it. In addition, for ``'g'`` and ``'G'`` +conversions, trailing zeros are not removed from the result. + +.. index:: single: , (comma); in string formatting + +The ``','`` option signals the use of a comma for a thousands separator. +For a locale aware separator, use the ``'n'`` integer presentation type +instead. + +.. versionchanged:: 3.1 + Added the ``','`` option (see also :pep:`378`). + +.. index:: single: _ (underscore); in string formatting + +The ``'_'`` option signals the use of an underscore for a thousands +separator for floating point presentation types and for integer +presentation type ``'d'``. For integer presentation types ``'b'``, +``'o'``, ``'x'``, and ``'X'``, underscores will be inserted every 4 +digits. For other presentation types, specifying this option is an +error. + +.. versionchanged:: 3.6 + Added the ``'_'`` option (see also :pep:`515`). + +*width* is a decimal integer defining the minimum field width. If not +specified, then the field width will be determined by the content. + +When no explicit alignment is given, preceding the *width* field by a zero +(``'0'``) character enables +sign-aware zero-padding for numeric types. This is equivalent to a *fill* +character of ``'0'`` with an *alignment* type of ``'='``. + +The *precision* is a decimal number indicating how many digits should be +displayed after the decimal point for a floating point value formatted with +``'f'`` and ``'F'``, or before and after the decimal point for a floating point +value formatted with ``'g'`` or ``'G'``. For non-number types the field +indicates the maximum field size - in other words, how many characters will be +used from the field content. The *precision* is not allowed for integer values. + +Finally, the *type* determines how the data should be presented. + +The available string presentation types are: + + +---------+----------------------------------------------------------+ + | Type | Meaning | + +=========+==========================================================+ + | ``'s'`` | String format. This is the default type for strings and | + | | may be omitted. | + +---------+----------------------------------------------------------+ + | None | The same as ``'s'``. | + +---------+----------------------------------------------------------+ + +The available integer presentation types are: + + +---------+----------------------------------------------------------+ + | Type | Meaning | + +=========+==========================================================+ + | ``'b'`` | Binary format. Outputs the number in base 2. | + +---------+----------------------------------------------------------+ + | ``'c'`` | Character. Converts the integer to the corresponding | + | | unicode character before printing. | + +---------+----------------------------------------------------------+ + | ``'d'`` | Decimal Integer. Outputs the number in base 10. | + +---------+----------------------------------------------------------+ + | ``'o'`` | Octal format. Outputs the number in base 8. | + +---------+----------------------------------------------------------+ + | ``'x'`` | Hex format. Outputs the number in base 16, using | + | | lower-case letters for the digits above 9. | + +---------+----------------------------------------------------------+ + | ``'X'`` | Hex format. Outputs the number in base 16, using | + | | upper-case letters for the digits above 9. | + +---------+----------------------------------------------------------+ + | ``'n'`` | Number. This is the same as ``'d'``, except that it uses | + | | the current locale setting to insert the appropriate | + | | number separator characters. | + +---------+----------------------------------------------------------+ + | None | The same as ``'d'``. | + +---------+----------------------------------------------------------+ + +In addition to the above presentation types, integers can be formatted +with the floating point presentation types listed below (except +``'n'`` and ``None``). When doing so, :func:`float` is used to convert the +integer to a floating point number before formatting. + +The available presentation types for floating point and decimal values are: + + +---------+----------------------------------------------------------+ + | Type | Meaning | + +=========+==========================================================+ + | ``'e'`` | Exponent notation. Prints the number in scientific | + | | notation using the letter 'e' to indicate the exponent. | + | | The default precision is ``6``. | + +---------+----------------------------------------------------------+ + | ``'E'`` | Exponent notation. Same as ``'e'`` except it uses an | + | | upper case 'E' as the separator character. | + +---------+----------------------------------------------------------+ + | ``'f'`` | Fixed-point notation. Displays the number as a | + | | fixed-point number. The default precision is ``6``. | + +---------+----------------------------------------------------------+ + | ``'F'`` | Fixed-point notation. Same as ``'f'``, but converts | + | | ``nan`` to ``NAN`` and ``inf`` to ``INF``. | + +---------+----------------------------------------------------------+ + | ``'g'`` | General format. For a given precision ``p >= 1``, | + | | this rounds the number to ``p`` significant digits and | + | | then formats the result in either fixed-point format | + | | or in scientific notation, depending on its magnitude. | + | | | + | | The precise rules are as follows: suppose that the | + | | result formatted with presentation type ``'e'`` and | + | | precision ``p-1`` would have exponent ``exp``. Then | + | | if ``-4 <= exp < p``, the number is formatted | + | | with presentation type ``'f'`` and precision | + | | ``p-1-exp``. Otherwise, the number is formatted | + | | with presentation type ``'e'`` and precision ``p-1``. | + | | In both cases insignificant trailing zeros are removed | + | | from the significand, and the decimal point is also | + | | removed if there are no remaining digits following it. | + | | | + | | Positive and negative infinity, positive and negative | + | | zero, and nans, are formatted as ``inf``, ``-inf``, | + | | ``0``, ``-0`` and ``nan`` respectively, regardless of | + | | the precision. | + | | | + | | A precision of ``0`` is treated as equivalent to a | + | | precision of ``1``. The default precision is ``6``. | + +---------+----------------------------------------------------------+ + | ``'G'`` | General format. Same as ``'g'`` except switches to | + | | ``'E'`` if the number gets too large. The | + | | representations of infinity and NaN are uppercased, too. | + +---------+----------------------------------------------------------+ + | ``'n'`` | Number. This is the same as ``'g'``, except that it uses | + | | the current locale setting to insert the appropriate | + | | number separator characters. | + +---------+----------------------------------------------------------+ + | ``'%'`` | Percentage. Multiplies the number by 100 and displays | + | | in fixed (``'f'``) format, followed by a percent sign. | + +---------+----------------------------------------------------------+ + | None | Similar to ``'g'``, except that fixed-point notation, | + | | when used, has at least one digit past the decimal point.| + | | The default precision is as high as needed to represent | + | | the particular value. The overall effect is to match the | + | | output of :func:`str` as altered by the other format | + | | modifiers. | + +---------+----------------------------------------------------------+ + + +.. _formatexamples: + +Format examples +^^^^^^^^^^^^^^^ + +This section contains examples of the :meth:`str.format` syntax and +comparison with the old ``%``-formatting. + +In most of the cases the syntax is similar to the old ``%``-formatting, with the +addition of the ``{}`` and with ``:`` used instead of ``%``. +For example, ``'%03.2f'`` can be translated to ``'{:03.2f}'``. + +The new format syntax also supports new and different options, shown in the +following examples. + +Accessing arguments by position:: + + >>> '{0}, {1}, {2}'.format('a', 'b', 'c') + 'a, b, c' + >>> '{}, {}, {}'.format('a', 'b', 'c') # 3.1+ only + 'a, b, c' + >>> '{2}, {1}, {0}'.format('a', 'b', 'c') + 'c, b, a' + >>> '{2}, {1}, {0}'.format(*'abc') # unpacking argument sequence + 'c, b, a' + >>> '{0}{1}{0}'.format('abra', 'cad') # arguments' indices can be repeated + 'abracadabra' + +Accessing arguments by name:: + + >>> 'Coordinates: {latitude}, {longitude}'.format(latitude='37.24N', longitude='-115.81W') + 'Coordinates: 37.24N, -115.81W' + >>> coord = {'latitude': '37.24N', 'longitude': '-115.81W'} + >>> 'Coordinates: {latitude}, {longitude}'.format(**coord) + 'Coordinates: 37.24N, -115.81W' + +Accessing arguments' attributes:: + + >>> c = 3-5j + >>> ('The complex number {0} is formed from the real part {0.real} ' + ... 'and the imaginary part {0.imag}.').format(c) + 'The complex number (3-5j) is formed from the real part 3.0 and the imaginary part -5.0.' + >>> class Point: + ... def __init__(self, x, y): + ... self.x, self.y = x, y + ... def __str__(self): + ... return 'Point({self.x}, {self.y})'.format(self=self) + ... + >>> str(Point(4, 2)) + 'Point(4, 2)' + +Accessing arguments' items:: + + >>> coord = (3, 5) + >>> 'X: {0[0]}; Y: {0[1]}'.format(coord) + 'X: 3; Y: 5' + +Replacing ``%s`` and ``%r``:: + + >>> "repr() shows quotes: {!r}; str() doesn't: {!s}".format('test1', 'test2') + "repr() shows quotes: 'test1'; str() doesn't: test2" + +Aligning the text and specifying a width:: + + >>> '{:<30}'.format('left aligned') + 'left aligned ' + >>> '{:>30}'.format('right aligned') + ' right aligned' + >>> '{:^30}'.format('centered') + ' centered ' + >>> '{:*^30}'.format('centered') # use '*' as a fill char + '***********centered***********' + +Replacing ``%+f``, ``%-f``, and ``% f`` and specifying a sign:: + + >>> '{:+f}; {:+f}'.format(3.14, -3.14) # show it always + '+3.140000; -3.140000' + >>> '{: f}; {: f}'.format(3.14, -3.14) # show a space for positive numbers + ' 3.140000; -3.140000' + >>> '{:-f}; {:-f}'.format(3.14, -3.14) # show only the minus -- same as '{:f}; {:f}' + '3.140000; -3.140000' + +Replacing ``%x`` and ``%o`` and converting the value to different bases:: + + >>> # format also supports binary numbers + >>> "int: {0:d}; hex: {0:x}; oct: {0:o}; bin: {0:b}".format(42) + 'int: 42; hex: 2a; oct: 52; bin: 101010' + >>> # with 0x, 0o, or 0b as prefix: + >>> "int: {0:d}; hex: {0:#x}; oct: {0:#o}; bin: {0:#b}".format(42) + 'int: 42; hex: 0x2a; oct: 0o52; bin: 0b101010' + +Using the comma as a thousands separator:: + + >>> '{:,}'.format(1234567890) + '1,234,567,890' + +Expressing a percentage:: + + >>> points = 19 + >>> total = 22 + >>> 'Correct answers: {:.2%}'.format(points/total) + 'Correct answers: 86.36%' + +Using type-specific formatting:: + + >>> import datetime + >>> d = datetime.datetime(2010, 7, 4, 12, 15, 58) + >>> '{:%Y-%m-%d %H:%M:%S}'.format(d) + '2010-07-04 12:15:58' + +Nesting arguments and more complex examples:: + + >>> for align, text in zip('<^>', ['left', 'center', 'right']): + ... '{0:{fill}{align}16}'.format(text, fill=align, align=align) + ... + 'left<<<<<<<<<<<<' + '^^^^^center^^^^^' + '>>>>>>>>>>>right' + >>> + >>> octets = [192, 168, 0, 1] + >>> '{:02X}{:02X}{:02X}{:02X}'.format(*octets) + 'C0A80001' + >>> int(_, 16) + 3232235521 + >>> + >>> width = 5 + >>> for num in range(5,12): #doctest: +NORMALIZE_WHITESPACE + ... for base in 'dXob': + ... print('{0:{width}{base}}'.format(num, base=base, width=width), end=' ') + ... print() + ... + 5 5 5 101 + 6 6 6 110 + 7 7 7 111 + 8 8 10 1000 + 9 9 11 1001 + 10 A 12 1010 + 11 B 13 1011 + + + +.. _template-strings: + +Template strings +---------------- + +Template strings provide simpler string substitutions as described in +:pep:`292`. A primary use case for template strings is for +internationalization (i18n) since in that context, the simpler syntax and +functionality makes it easier to translate than other built-in string +formatting facilities in Python. As an example of a library built on template +strings for i18n, see the +`flufl.i18n `_ package. + +.. index:: single: $ (dollar); in template strings + +Template strings support ``$``-based substitutions, using the following rules: + +* ``$$`` is an escape; it is replaced with a single ``$``. + +* ``$identifier`` names a substitution placeholder matching a mapping key of + ``"identifier"``. By default, ``"identifier"`` is restricted to any + case-insensitive ASCII alphanumeric string (including underscores) that + starts with an underscore or ASCII letter. The first non-identifier + character after the ``$`` character terminates this placeholder + specification. + +* ``${identifier}`` is equivalent to ``$identifier``. It is required when + valid identifier characters follow the placeholder but are not part of the + placeholder, such as ``"${noun}ification"``. + +Any other appearance of ``$`` in the string will result in a :exc:`ValueError` +being raised. + +The :mod:`string` module provides a :class:`Template` class that implements +these rules. The methods of :class:`Template` are: + + +.. class:: Template(template) + + The constructor takes a single argument which is the template string. + + + .. method:: substitute(mapping, **kwds) + + Performs the template substitution, returning a new string. *mapping* is + any dictionary-like object with keys that match the placeholders in the + template. Alternatively, you can provide keyword arguments, where the + keywords are the placeholders. When both *mapping* and *kwds* are given + and there are duplicates, the placeholders from *kwds* take precedence. + + + .. method:: safe_substitute(mapping, **kwds) + + Like :meth:`substitute`, except that if placeholders are missing from + *mapping* and *kwds*, instead of raising a :exc:`KeyError` exception, the + original placeholder will appear in the resulting string intact. Also, + unlike with :meth:`substitute`, any other appearances of the ``$`` will + simply return ``$`` instead of raising :exc:`ValueError`. + + While other exceptions may still occur, this method is called "safe" + because it always tries to return a usable string instead of + raising an exception. In another sense, :meth:`safe_substitute` may be + anything other than safe, since it will silently ignore malformed + templates containing dangling delimiters, unmatched braces, or + placeholders that are not valid Python identifiers. + + :class:`Template` instances also provide one public data attribute: + + .. attribute:: template + + This is the object passed to the constructor's *template* argument. In + general, you shouldn't change it, but read-only access is not enforced. + +Here is an example of how to use a Template:: + + >>> from string import Template + >>> s = Template('$who likes $what') + >>> s.substitute(who='tim', what='kung pao') + 'tim likes kung pao' + >>> d = dict(who='tim') + >>> Template('Give $who $100').substitute(d) + Traceback (most recent call last): + ... + ValueError: Invalid placeholder in string: line 1, col 11 + >>> Template('$who likes $what').substitute(d) + Traceback (most recent call last): + ... + KeyError: 'what' + >>> Template('$who likes $what').safe_substitute(d) + 'tim likes $what' + +Advanced usage: you can derive subclasses of :class:`Template` to customize +the placeholder syntax, delimiter character, or the entire regular expression +used to parse template strings. To do this, you can override these class +attributes: + +* *delimiter* -- This is the literal string describing a placeholder + introducing delimiter. The default value is ``$``. Note that this should + *not* be a regular expression, as the implementation will call + :meth:`re.escape` on this string as needed. Note further that you cannot + change the delimiter after class creation (i.e. a different delimiter must + be set in the subclass's class namespace). + +* *idpattern* -- This is the regular expression describing the pattern for + non-braced placeholders. The default value is the regular expression + ``(?a:[_a-z][_a-z0-9]*)``. If this is given and *braceidpattern* is + ``None`` this pattern will also apply to braced placeholders. + + .. note:: + + Since default *flags* is ``re.IGNORECASE``, pattern ``[a-z]`` can match + with some non-ASCII characters. That's why we use the local ``a`` flag + here. + + .. versionchanged:: 3.7 + *braceidpattern* can be used to define separate patterns used inside and + outside the braces. + +* *braceidpattern* -- This is like *idpattern* but describes the pattern for + braced placeholders. Defaults to ``None`` which means to fall back to + *idpattern* (i.e. the same pattern is used both inside and outside braces). + If given, this allows you to define different patterns for braced and + unbraced placeholders. + + .. versionadded:: 3.7 + +* *flags* -- The regular expression flags that will be applied when compiling + the regular expression used for recognizing substitutions. The default value + is ``re.IGNORECASE``. Note that ``re.VERBOSE`` will always be added to the + flags, so custom *idpattern*\ s must follow conventions for verbose regular + expressions. + + .. versionadded:: 3.2 + +Alternatively, you can provide the entire regular expression pattern by +overriding the class attribute *pattern*. If you do this, the value must be a +regular expression object with four named capturing groups. The capturing +groups correspond to the rules given above, along with the invalid placeholder +rule: + +* *escaped* -- This group matches the escape sequence, e.g. ``$$``, in the + default pattern. + +* *named* -- This group matches the unbraced placeholder name; it should not + include the delimiter in capturing group. + +* *braced* -- This group matches the brace enclosed placeholder name; it should + not include either the delimiter or braces in the capturing group. + +* *invalid* -- This group matches any other delimiter pattern (usually a single + delimiter), and it should appear last in the regular expression. + + +Helper functions +---------------- + +.. function:: capwords(s, sep=None) + + Split the argument into words using :meth:`str.split`, capitalize each word + using :meth:`str.capitalize`, and join the capitalized words using + :meth:`str.join`. If the optional second argument *sep* is absent + or ``None``, runs of whitespace characters are replaced by a single space + and leading and trailing whitespace are removed, otherwise *sep* is used to + split and join the words. diff --git a/python-3.7.4-docs-html/_sources/library/stringprep.rst.txt b/python-3.7.4-docs-html/_sources/library/stringprep.rst.txt new file mode 100644 index 0000000..330032b --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/stringprep.rst.txt @@ -0,0 +1,143 @@ +:mod:`stringprep` --- Internet String Preparation +================================================= + +.. module:: stringprep + :synopsis: String preparation, as per RFC 3453 + +.. moduleauthor:: Martin v. Löwis +.. sectionauthor:: Martin v. Löwis + +**Source code:** :source:`Lib/stringprep.py` + +-------------- + +When identifying things (such as host names) in the internet, it is often +necessary to compare such identifications for "equality". Exactly how this +comparison is executed may depend on the application domain, e.g. whether it +should be case-insensitive or not. It may be also necessary to restrict the +possible identifications, to allow only identifications consisting of +"printable" characters. + +:rfc:`3454` defines a procedure for "preparing" Unicode strings in internet +protocols. Before passing strings onto the wire, they are processed with the +preparation procedure, after which they have a certain normalized form. The RFC +defines a set of tables, which can be combined into profiles. Each profile must +define which tables it uses, and what other optional parts of the ``stringprep`` +procedure are part of the profile. One example of a ``stringprep`` profile is +``nameprep``, which is used for internationalized domain names. + +The module :mod:`stringprep` only exposes the tables from :rfc:`3454`. As these +tables would be very large to represent them as dictionaries or lists, the +module uses the Unicode character database internally. The module source code +itself was generated using the ``mkstringprep.py`` utility. + +As a result, these tables are exposed as functions, not as data structures. +There are two kinds of tables in the RFC: sets and mappings. For a set, +:mod:`stringprep` provides the "characteristic function", i.e. a function that +returns true if the parameter is part of the set. For mappings, it provides the +mapping function: given the key, it returns the associated value. Below is a +list of all functions available in the module. + + +.. function:: in_table_a1(code) + + Determine whether *code* is in tableA.1 (Unassigned code points in Unicode 3.2). + + +.. function:: in_table_b1(code) + + Determine whether *code* is in tableB.1 (Commonly mapped to nothing). + + +.. function:: map_table_b2(code) + + Return the mapped value for *code* according to tableB.2 (Mapping for + case-folding used with NFKC). + + +.. function:: map_table_b3(code) + + Return the mapped value for *code* according to tableB.3 (Mapping for + case-folding used with no normalization). + + +.. function:: in_table_c11(code) + + Determine whether *code* is in tableC.1.1 (ASCII space characters). + + +.. function:: in_table_c12(code) + + Determine whether *code* is in tableC.1.2 (Non-ASCII space characters). + + +.. function:: in_table_c11_c12(code) + + Determine whether *code* is in tableC.1 (Space characters, union of C.1.1 and + C.1.2). + + +.. function:: in_table_c21(code) + + Determine whether *code* is in tableC.2.1 (ASCII control characters). + + +.. function:: in_table_c22(code) + + Determine whether *code* is in tableC.2.2 (Non-ASCII control characters). + + +.. function:: in_table_c21_c22(code) + + Determine whether *code* is in tableC.2 (Control characters, union of C.2.1 and + C.2.2). + + +.. function:: in_table_c3(code) + + Determine whether *code* is in tableC.3 (Private use). + + +.. function:: in_table_c4(code) + + Determine whether *code* is in tableC.4 (Non-character code points). + + +.. function:: in_table_c5(code) + + Determine whether *code* is in tableC.5 (Surrogate codes). + + +.. function:: in_table_c6(code) + + Determine whether *code* is in tableC.6 (Inappropriate for plain text). + + +.. function:: in_table_c7(code) + + Determine whether *code* is in tableC.7 (Inappropriate for canonical + representation). + + +.. function:: in_table_c8(code) + + Determine whether *code* is in tableC.8 (Change display properties or are + deprecated). + + +.. function:: in_table_c9(code) + + Determine whether *code* is in tableC.9 (Tagging characters). + + +.. function:: in_table_d1(code) + + Determine whether *code* is in tableD.1 (Characters with bidirectional property + "R" or "AL"). + + +.. function:: in_table_d2(code) + + Determine whether *code* is in tableD.2 (Characters with bidirectional property + "L"). + diff --git a/python-3.7.4-docs-html/_sources/library/struct.rst.txt b/python-3.7.4-docs-html/_sources/library/struct.rst.txt new file mode 100644 index 0000000..df2416e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/struct.rst.txt @@ -0,0 +1,474 @@ +:mod:`struct` --- Interpret bytes as packed binary data +======================================================= + +.. module:: struct + :synopsis: Interpret bytes as packed binary data. + +**Source code:** :source:`Lib/struct.py` + +.. index:: + pair: C; structures + triple: packing; binary; data + +-------------- + +This module performs conversions between Python values and C structs represented +as Python :class:`bytes` objects. This can be used in handling binary data +stored in files or from network connections, among other sources. It uses +:ref:`struct-format-strings` as compact descriptions of the layout of the C +structs and the intended conversion to/from Python values. + +.. note:: + + By default, the result of packing a given C struct includes pad bytes in + order to maintain proper alignment for the C types involved; similarly, + alignment is taken into account when unpacking. This behavior is chosen so + that the bytes of a packed struct correspond exactly to the layout in memory + of the corresponding C struct. To handle platform-independent data formats + or omit implicit pad bytes, use ``standard`` size and alignment instead of + ``native`` size and alignment: see :ref:`struct-alignment` for details. + +Several :mod:`struct` functions (and methods of :class:`Struct`) take a *buffer* +argument. This refers to objects that implement the :ref:`bufferobjects` and +provide either a readable or read-writable buffer. The most common types used +for that purpose are :class:`bytes` and :class:`bytearray`, but many other types +that can be viewed as an array of bytes implement the buffer protocol, so that +they can be read/filled without additional copying from a :class:`bytes` object. + + +Functions and Exceptions +------------------------ + +The module defines the following exception and functions: + + +.. exception:: error + + Exception raised on various occasions; argument is a string describing what + is wrong. + + +.. function:: pack(format, v1, v2, ...) + + Return a bytes object containing the values *v1*, *v2*, ... packed according + to the format string *format*. The arguments must match the values required by + the format exactly. + + +.. function:: pack_into(format, buffer, offset, v1, v2, ...) + + Pack the values *v1*, *v2*, ... according to the format string *format* and + write the packed bytes into the writable buffer *buffer* starting at + position *offset*. Note that *offset* is a required argument. + + +.. function:: unpack(format, buffer) + + Unpack from the buffer *buffer* (presumably packed by ``pack(format, ...)``) + according to the format string *format*. The result is a tuple even if it + contains exactly one item. The buffer's size in bytes must match the + size required by the format, as reflected by :func:`calcsize`. + + +.. function:: unpack_from(format, buffer, offset=0) + + Unpack from *buffer* starting at position *offset*, according to the format + string *format*. The result is a tuple even if it contains exactly one + item. The buffer's size in bytes, minus *offset*, must be at least + the size required by the format, as reflected by :func:`calcsize`. + + +.. function:: iter_unpack(format, buffer) + + Iteratively unpack from the buffer *buffer* according to the format + string *format*. This function returns an iterator which will read + equally-sized chunks from the buffer until all its contents have been + consumed. The buffer's size in bytes must be a multiple of the size + required by the format, as reflected by :func:`calcsize`. + + Each iteration yields a tuple as specified by the format string. + + .. versionadded:: 3.4 + + +.. function:: calcsize(format) + + Return the size of the struct (and hence of the bytes object produced by + ``pack(format, ...)``) corresponding to the format string *format*. + + +.. _struct-format-strings: + +Format Strings +-------------- + +Format strings are the mechanism used to specify the expected layout when +packing and unpacking data. They are built up from :ref:`format-characters`, +which specify the type of data being packed/unpacked. In addition, there are +special characters for controlling the :ref:`struct-alignment`. + + +.. _struct-alignment: + +Byte Order, Size, and Alignment +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +By default, C types are represented in the machine's native format and byte +order, and properly aligned by skipping pad bytes if necessary (according to the +rules used by the C compiler). + +.. index:: + single: @ (at); in struct format strings + single: = (equals); in struct format strings + single: < (less); in struct format strings + single: > (greater); in struct format strings + single: ! (exclamation); in struct format strings + +Alternatively, the first character of the format string can be used to indicate +the byte order, size and alignment of the packed data, according to the +following table: + ++-----------+------------------------+----------+-----------+ +| Character | Byte order | Size | Alignment | ++===========+========================+==========+===========+ +| ``@`` | native | native | native | ++-----------+------------------------+----------+-----------+ +| ``=`` | native | standard | none | ++-----------+------------------------+----------+-----------+ +| ``<`` | little-endian | standard | none | ++-----------+------------------------+----------+-----------+ +| ``>`` | big-endian | standard | none | ++-----------+------------------------+----------+-----------+ +| ``!`` | network (= big-endian) | standard | none | ++-----------+------------------------+----------+-----------+ + +If the first character is not one of these, ``'@'`` is assumed. + +Native byte order is big-endian or little-endian, depending on the host +system. For example, Intel x86 and AMD64 (x86-64) are little-endian; +Motorola 68000 and PowerPC G5 are big-endian; ARM and Intel Itanium feature +switchable endianness (bi-endian). Use ``sys.byteorder`` to check the +endianness of your system. + +Native size and alignment are determined using the C compiler's +``sizeof`` expression. This is always combined with native byte order. + +Standard size depends only on the format character; see the table in +the :ref:`format-characters` section. + +Note the difference between ``'@'`` and ``'='``: both use native byte order, but +the size and alignment of the latter is standardized. + +The form ``'!'`` is available for those poor souls who claim they can't remember +whether network byte order is big-endian or little-endian. + +There is no way to indicate non-native byte order (force byte-swapping); use the +appropriate choice of ``'<'`` or ``'>'``. + +Notes: + +(1) Padding is only automatically added between successive structure members. + No padding is added at the beginning or the end of the encoded struct. + +(2) No padding is added when using non-native size and alignment, e.g. + with '<', '>', '=', and '!'. + +(3) To align the end of a structure to the alignment requirement of a + particular type, end the format with the code for that type with a repeat + count of zero. See :ref:`struct-examples`. + + +.. _format-characters: + +Format Characters +^^^^^^^^^^^^^^^^^ + +Format characters have the following meaning; the conversion between C and +Python values should be obvious given their types. The 'Standard size' column +refers to the size of the packed value in bytes when using standard size; that +is, when the format string starts with one of ``'<'``, ``'>'``, ``'!'`` or +``'='``. When using native size, the size of the packed value is +platform-dependent. + ++--------+--------------------------+--------------------+----------------+------------+ +| Format | C Type | Python type | Standard size | Notes | ++========+==========================+====================+================+============+ +| ``x`` | pad byte | no value | | | ++--------+--------------------------+--------------------+----------------+------------+ +| ``c`` | :c:type:`char` | bytes of length 1 | 1 | | ++--------+--------------------------+--------------------+----------------+------------+ +| ``b`` | :c:type:`signed char` | integer | 1 | \(1),\(3) | ++--------+--------------------------+--------------------+----------------+------------+ +| ``B`` | :c:type:`unsigned char` | integer | 1 | \(3) | ++--------+--------------------------+--------------------+----------------+------------+ +| ``?`` | :c:type:`_Bool` | bool | 1 | \(1) | ++--------+--------------------------+--------------------+----------------+------------+ +| ``h`` | :c:type:`short` | integer | 2 | \(3) | ++--------+--------------------------+--------------------+----------------+------------+ +| ``H`` | :c:type:`unsigned short` | integer | 2 | \(3) | ++--------+--------------------------+--------------------+----------------+------------+ +| ``i`` | :c:type:`int` | integer | 4 | \(3) | ++--------+--------------------------+--------------------+----------------+------------+ +| ``I`` | :c:type:`unsigned int` | integer | 4 | \(3) | ++--------+--------------------------+--------------------+----------------+------------+ +| ``l`` | :c:type:`long` | integer | 4 | \(3) | ++--------+--------------------------+--------------------+----------------+------------+ +| ``L`` | :c:type:`unsigned long` | integer | 4 | \(3) | ++--------+--------------------------+--------------------+----------------+------------+ +| ``q`` | :c:type:`long long` | integer | 8 | \(2), \(3) | ++--------+--------------------------+--------------------+----------------+------------+ +| ``Q`` | :c:type:`unsigned long | integer | 8 | \(2), \(3) | +| | long` | | | | ++--------+--------------------------+--------------------+----------------+------------+ +| ``n`` | :c:type:`ssize_t` | integer | | \(4) | ++--------+--------------------------+--------------------+----------------+------------+ +| ``N`` | :c:type:`size_t` | integer | | \(4) | ++--------+--------------------------+--------------------+----------------+------------+ +| ``e`` | \(7) | float | 2 | \(5) | ++--------+--------------------------+--------------------+----------------+------------+ +| ``f`` | :c:type:`float` | float | 4 | \(5) | ++--------+--------------------------+--------------------+----------------+------------+ +| ``d`` | :c:type:`double` | float | 8 | \(5) | ++--------+--------------------------+--------------------+----------------+------------+ +| ``s`` | :c:type:`char[]` | bytes | | | ++--------+--------------------------+--------------------+----------------+------------+ +| ``p`` | :c:type:`char[]` | bytes | | | ++--------+--------------------------+--------------------+----------------+------------+ +| ``P`` | :c:type:`void \*` | integer | | \(6) | ++--------+--------------------------+--------------------+----------------+------------+ + +.. versionchanged:: 3.3 + Added support for the ``'n'`` and ``'N'`` formats. + +.. versionchanged:: 3.6 + Added support for the ``'e'`` format. + + +Notes: + +(1) + .. index:: single: ? (question mark); in struct format strings + + The ``'?'`` conversion code corresponds to the :c:type:`_Bool` type defined by + C99. If this type is not available, it is simulated using a :c:type:`char`. In + standard mode, it is always represented by one byte. + +(2) + The ``'q'`` and ``'Q'`` conversion codes are available in native mode only if + the platform C compiler supports C :c:type:`long long`, or, on Windows, + :c:type:`__int64`. They are always available in standard modes. + +(3) + When attempting to pack a non-integer using any of the integer conversion + codes, if the non-integer has a :meth:`__index__` method then that method is + called to convert the argument to an integer before packing. + + .. versionchanged:: 3.2 + Use of the :meth:`__index__` method for non-integers is new in 3.2. + +(4) + The ``'n'`` and ``'N'`` conversion codes are only available for the native + size (selected as the default or with the ``'@'`` byte order character). + For the standard size, you can use whichever of the other integer formats + fits your application. + +(5) + For the ``'f'``, ``'d'`` and ``'e'`` conversion codes, the packed + representation uses the IEEE 754 binary32, binary64 or binary16 format (for + ``'f'``, ``'d'`` or ``'e'`` respectively), regardless of the floating-point + format used by the platform. + +(6) + The ``'P'`` format character is only available for the native byte ordering + (selected as the default or with the ``'@'`` byte order character). The byte + order character ``'='`` chooses to use little- or big-endian ordering based + on the host system. The struct module does not interpret this as native + ordering, so the ``'P'`` format is not available. + +(7) + The IEEE 754 binary16 "half precision" type was introduced in the 2008 + revision of the `IEEE 754 standard `_. It has a sign + bit, a 5-bit exponent and 11-bit precision (with 10 bits explicitly stored), + and can represent numbers between approximately ``6.1e-05`` and ``6.5e+04`` + at full precision. This type is not widely supported by C compilers: on a + typical machine, an unsigned short can be used for storage, but not for math + operations. See the Wikipedia page on the `half-precision floating-point + format `_ for more information. + + +A format character may be preceded by an integral repeat count. For example, +the format string ``'4h'`` means exactly the same as ``'hhhh'``. + +Whitespace characters between formats are ignored; a count and its format must +not contain whitespace though. + +For the ``'s'`` format character, the count is interpreted as the length of the +bytes, not a repeat count like for the other format characters; for example, +``'10s'`` means a single 10-byte string, while ``'10c'`` means 10 characters. +If a count is not given, it defaults to 1. For packing, the string is +truncated or padded with null bytes as appropriate to make it fit. For +unpacking, the resulting bytes object always has exactly the specified number +of bytes. As a special case, ``'0s'`` means a single, empty string (while +``'0c'`` means 0 characters). + +When packing a value ``x`` using one of the integer formats (``'b'``, +``'B'``, ``'h'``, ``'H'``, ``'i'``, ``'I'``, ``'l'``, ``'L'``, +``'q'``, ``'Q'``), if ``x`` is outside the valid range for that format +then :exc:`struct.error` is raised. + +.. versionchanged:: 3.1 + In 3.0, some of the integer formats wrapped out-of-range values and + raised :exc:`DeprecationWarning` instead of :exc:`struct.error`. + +The ``'p'`` format character encodes a "Pascal string", meaning a short +variable-length string stored in a *fixed number of bytes*, given by the count. +The first byte stored is the length of the string, or 255, whichever is +smaller. The bytes of the string follow. If the string passed in to +:func:`pack` is too long (longer than the count minus 1), only the leading +``count-1`` bytes of the string are stored. If the string is shorter than +``count-1``, it is padded with null bytes so that exactly count bytes in all +are used. Note that for :func:`unpack`, the ``'p'`` format character consumes +``count`` bytes, but that the string returned can never contain more than 255 +bytes. + +.. index:: single: ? (question mark); in struct format strings + +For the ``'?'`` format character, the return value is either :const:`True` or +:const:`False`. When packing, the truth value of the argument object is used. +Either 0 or 1 in the native or standard bool representation will be packed, and +any non-zero value will be ``True`` when unpacking. + + + +.. _struct-examples: + +Examples +^^^^^^^^ + +.. note:: + All examples assume a native byte order, size, and alignment with a + big-endian machine. + +A basic example of packing/unpacking three integers:: + + >>> from struct import * + >>> pack('hhl', 1, 2, 3) + b'\x00\x01\x00\x02\x00\x00\x00\x03' + >>> unpack('hhl', b'\x00\x01\x00\x02\x00\x00\x00\x03') + (1, 2, 3) + >>> calcsize('hhl') + 8 + +Unpacked fields can be named by assigning them to variables or by wrapping +the result in a named tuple:: + + >>> record = b'raymond \x32\x12\x08\x01\x08' + >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) + + >>> from collections import namedtuple + >>> Student = namedtuple('Student', 'name serialnum school gradelevel') + >>> Student._make(unpack('<10sHHb', record)) + Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8) + +The ordering of format characters may have an impact on size since the padding +needed to satisfy alignment requirements is different:: + + >>> pack('ci', b'*', 0x12131415) + b'*\x00\x00\x00\x12\x13\x14\x15' + >>> pack('ic', 0x12131415, b'*') + b'\x12\x13\x14\x15*' + >>> calcsize('ci') + 8 + >>> calcsize('ic') + 5 + +The following format ``'llh0l'`` specifies two pad bytes at the end, assuming +longs are aligned on 4-byte boundaries:: + + >>> pack('llh0l', 1, 2, 3) + b'\x00\x00\x00\x01\x00\x00\x00\x02\x00\x03\x00\x00' + +This only works when native size and alignment are in effect; standard size and +alignment does not enforce any alignment. + + +.. seealso:: + + Module :mod:`array` + Packed binary storage of homogeneous data. + + Module :mod:`xdrlib` + Packing and unpacking of XDR data. + + +.. _struct-objects: + +Classes +------- + +The :mod:`struct` module also defines the following type: + + +.. class:: Struct(format) + + Return a new Struct object which writes and reads binary data according to + the format string *format*. Creating a Struct object once and calling its + methods is more efficient than calling the :mod:`struct` functions with the + same format since the format string only needs to be compiled once. + + .. note:: + + The compiled versions of the most recent format strings passed to + :class:`Struct` and the module-level functions are cached, so programs + that use only a few format strings needn't worry about reusing a single + :class:`Struct` instance. + + Compiled Struct objects support the following methods and attributes: + + .. method:: pack(v1, v2, ...) + + Identical to the :func:`pack` function, using the compiled format. + (``len(result)`` will equal :attr:`size`.) + + + .. method:: pack_into(buffer, offset, v1, v2, ...) + + Identical to the :func:`pack_into` function, using the compiled format. + + + .. method:: unpack(buffer) + + Identical to the :func:`unpack` function, using the compiled format. + The buffer's size in bytes must equal :attr:`size`. + + + .. method:: unpack_from(buffer, offset=0) + + Identical to the :func:`unpack_from` function, using the compiled format. + The buffer's size in bytes, minus *offset*, must be at least + :attr:`size`. + + + .. method:: iter_unpack(buffer) + + Identical to the :func:`iter_unpack` function, using the compiled format. + The buffer's size in bytes must be a multiple of :attr:`size`. + + .. versionadded:: 3.4 + + .. attribute:: format + + The format string used to construct this Struct object. + + .. versionchanged:: 3.7 + The format string type is now :class:`str` instead of :class:`bytes`. + + .. attribute:: size + + The calculated size of the struct (and hence of the bytes object produced + by the :meth:`pack` method) corresponding to :attr:`format`. + + +.. _half precision format: https://en.wikipedia.org/wiki/Half-precision_floating-point_format + +.. _ieee 754 standard: https://en.wikipedia.org/wiki/IEEE_floating_point#IEEE_754-2008 diff --git a/python-3.7.4-docs-html/_sources/library/subprocess.rst.txt b/python-3.7.4-docs-html/_sources/library/subprocess.rst.txt new file mode 100644 index 0000000..f9ace66 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/subprocess.rst.txt @@ -0,0 +1,1401 @@ +:mod:`subprocess` --- Subprocess management +=========================================== + +.. module:: subprocess + :synopsis: Subprocess management. + +.. moduleauthor:: Peter Åstrand +.. sectionauthor:: Peter Åstrand + +**Source code:** :source:`Lib/subprocess.py` + +-------------- + +The :mod:`subprocess` module allows you to spawn new processes, connect to their +input/output/error pipes, and obtain their return codes. This module intends to +replace several older modules and functions:: + + os.system + os.spawn* + +Information about how the :mod:`subprocess` module can be used to replace these +modules and functions can be found in the following sections. + +.. seealso:: + + :pep:`324` -- PEP proposing the subprocess module + + +Using the :mod:`subprocess` Module +---------------------------------- + +The recommended approach to invoking subprocesses is to use the :func:`run` +function for all use cases it can handle. For more advanced use cases, the +underlying :class:`Popen` interface can be used directly. + +The :func:`run` function was added in Python 3.5; if you need to retain +compatibility with older versions, see the :ref:`call-function-trio` section. + + +.. function:: run(args, *, stdin=None, input=None, stdout=None, stderr=None,\ + capture_output=False, shell=False, cwd=None, timeout=None, \ + check=False, encoding=None, errors=None, text=None, env=None, \ + universal_newlines=None) + + Run the command described by *args*. Wait for command to complete, then + return a :class:`CompletedProcess` instance. + + The arguments shown above are merely the most common ones, described below + in :ref:`frequently-used-arguments` (hence the use of keyword-only notation + in the abbreviated signature). The full function signature is largely the + same as that of the :class:`Popen` constructor - most of the arguments to + this function are passed through to that interface. (*timeout*, *input*, + *check*, and *capture_output* are not.) + + If *capture_output* is true, stdout and stderr will be captured. + When used, the internal :class:`Popen` object is automatically created with + ``stdout=PIPE`` and ``stderr=PIPE``. The *stdout* and *stderr* arguments may + not be supplied at the same time as *capture_output*. If you wish to capture + and combine both streams into one, use ``stdout=PIPE`` and ``stderr=STDOUT`` + instead of *capture_output*. + + The *timeout* argument is passed to :meth:`Popen.communicate`. If the timeout + expires, the child process will be killed and waited for. The + :exc:`TimeoutExpired` exception will be re-raised after the child process + has terminated. + + The *input* argument is passed to :meth:`Popen.communicate` and thus to the + subprocess's stdin. If used it must be a byte sequence, or a string if + *encoding* or *errors* is specified or *text* is true. When + used, the internal :class:`Popen` object is automatically created with + ``stdin=PIPE``, and the *stdin* argument may not be used as well. + + If *check* is true, and the process exits with a non-zero exit code, a + :exc:`CalledProcessError` exception will be raised. Attributes of that + exception hold the arguments, the exit code, and stdout and stderr if they + were captured. + + If *encoding* or *errors* are specified, or *text* is true, + file objects for stdin, stdout and stderr are opened in text mode using the + specified *encoding* and *errors* or the :class:`io.TextIOWrapper` default. + The *universal_newlines* argument is equivalent to *text* and is provided + for backwards compatibility. By default, file objects are opened in binary mode. + + If *env* is not ``None``, it must be a mapping that defines the environment + variables for the new process; these are used instead of the default + behavior of inheriting the current process' environment. It is passed directly + to :class:`Popen`. + + Examples:: + + >>> subprocess.run(["ls", "-l"]) # doesn't capture output + CompletedProcess(args=['ls', '-l'], returncode=0) + + >>> subprocess.run("exit 1", shell=True, check=True) + Traceback (most recent call last): + ... + subprocess.CalledProcessError: Command 'exit 1' returned non-zero exit status 1 + + >>> subprocess.run(["ls", "-l", "/dev/null"], capture_output=True) + CompletedProcess(args=['ls', '-l', '/dev/null'], returncode=0, + stdout=b'crw-rw-rw- 1 root root 1, 3 Jan 23 16:23 /dev/null\n', stderr=b'') + + .. versionadded:: 3.5 + + .. versionchanged:: 3.6 + + Added *encoding* and *errors* parameters + + .. versionchanged:: 3.7 + + Added the *text* parameter, as a more understandable alias of *universal_newlines*. + Added the *capture_output* parameter. + +.. class:: CompletedProcess + + The return value from :func:`run`, representing a process that has finished. + + .. attribute:: args + + The arguments used to launch the process. This may be a list or a string. + + .. attribute:: returncode + + Exit status of the child process. Typically, an exit status of 0 indicates + that it ran successfully. + + A negative value ``-N`` indicates that the child was terminated by signal + ``N`` (POSIX only). + + .. attribute:: stdout + + Captured stdout from the child process. A bytes sequence, or a string if + :func:`run` was called with an encoding, errors, or text=True. + ``None`` if stdout was not captured. + + If you ran the process with ``stderr=subprocess.STDOUT``, stdout and + stderr will be combined in this attribute, and :attr:`stderr` will be + ``None``. + + .. attribute:: stderr + + Captured stderr from the child process. A bytes sequence, or a string if + :func:`run` was called with an encoding, errors, or text=True. + ``None`` if stderr was not captured. + + .. method:: check_returncode() + + If :attr:`returncode` is non-zero, raise a :exc:`CalledProcessError`. + + .. versionadded:: 3.5 + +.. data:: DEVNULL + + Special value that can be used as the *stdin*, *stdout* or *stderr* argument + to :class:`Popen` and indicates that the special file :data:`os.devnull` + will be used. + + .. versionadded:: 3.3 + + +.. data:: PIPE + + Special value that can be used as the *stdin*, *stdout* or *stderr* argument + to :class:`Popen` and indicates that a pipe to the standard stream should be + opened. Most useful with :meth:`Popen.communicate`. + + +.. data:: STDOUT + + Special value that can be used as the *stderr* argument to :class:`Popen` and + indicates that standard error should go into the same handle as standard + output. + + +.. exception:: SubprocessError + + Base class for all other exceptions from this module. + + .. versionadded:: 3.3 + + +.. exception:: TimeoutExpired + + Subclass of :exc:`SubprocessError`, raised when a timeout expires + while waiting for a child process. + + .. attribute:: cmd + + Command that was used to spawn the child process. + + .. attribute:: timeout + + Timeout in seconds. + + .. attribute:: output + + Output of the child process if it was captured by :func:`run` or + :func:`check_output`. Otherwise, ``None``. + + .. attribute:: stdout + + Alias for output, for symmetry with :attr:`stderr`. + + .. attribute:: stderr + + Stderr output of the child process if it was captured by :func:`run`. + Otherwise, ``None``. + + .. versionadded:: 3.3 + + .. versionchanged:: 3.5 + *stdout* and *stderr* attributes added + +.. exception:: CalledProcessError + + Subclass of :exc:`SubprocessError`, raised when a process run by + :func:`check_call` or :func:`check_output` returns a non-zero exit status. + + .. attribute:: returncode + + Exit status of the child process. If the process exited due to a + signal, this will be the negative signal number. + + .. attribute:: cmd + + Command that was used to spawn the child process. + + .. attribute:: output + + Output of the child process if it was captured by :func:`run` or + :func:`check_output`. Otherwise, ``None``. + + .. attribute:: stdout + + Alias for output, for symmetry with :attr:`stderr`. + + .. attribute:: stderr + + Stderr output of the child process if it was captured by :func:`run`. + Otherwise, ``None``. + + .. versionchanged:: 3.5 + *stdout* and *stderr* attributes added + + +.. _frequently-used-arguments: + +Frequently Used Arguments +^^^^^^^^^^^^^^^^^^^^^^^^^ + +To support a wide variety of use cases, the :class:`Popen` constructor (and +the convenience functions) accept a large number of optional arguments. For +most typical use cases, many of these arguments can be safely left at their +default values. The arguments that are most commonly needed are: + + *args* is required for all calls and should be a string, or a sequence of + program arguments. Providing a sequence of arguments is generally + preferred, as it allows the module to take care of any required escaping + and quoting of arguments (e.g. to permit spaces in file names). If passing + a single string, either *shell* must be :const:`True` (see below) or else + the string must simply name the program to be executed without specifying + any arguments. + + *stdin*, *stdout* and *stderr* specify the executed program's standard input, + standard output and standard error file handles, respectively. Valid values + are :data:`PIPE`, :data:`DEVNULL`, an existing file descriptor (a positive + integer), an existing file object, and ``None``. :data:`PIPE` indicates + that a new pipe to the child should be created. :data:`DEVNULL` indicates + that the special file :data:`os.devnull` will be used. With the default + settings of ``None``, no redirection will occur; the child's file handles + will be inherited from the parent. Additionally, *stderr* can be + :data:`STDOUT`, which indicates that the stderr data from the child + process should be captured into the same file handle as for *stdout*. + + .. index:: + single: universal newlines; subprocess module + + If *encoding* or *errors* are specified, or *text* (also known as + *universal_newlines*) is true, + the file objects *stdin*, *stdout* and *stderr* will be opened in text + mode using the *encoding* and *errors* specified in the call or the + defaults for :class:`io.TextIOWrapper`. + + For *stdin*, line ending characters ``'\n'`` in the input will be converted + to the default line separator :data:`os.linesep`. For *stdout* and *stderr*, + all line endings in the output will be converted to ``'\n'``. For more + information see the documentation of the :class:`io.TextIOWrapper` class + when the *newline* argument to its constructor is ``None``. + + If text mode is not used, *stdin*, *stdout* and *stderr* will be opened as + binary streams. No encoding or line ending conversion is performed. + + .. versionadded:: 3.6 + Added *encoding* and *errors* parameters. + + .. versionadded:: 3.7 + Added the *text* parameter as an alias for *universal_newlines*. + + .. note:: + + The newlines attribute of the file objects :attr:`Popen.stdin`, + :attr:`Popen.stdout` and :attr:`Popen.stderr` are not updated by + the :meth:`Popen.communicate` method. + + If *shell* is ``True``, the specified command will be executed through + the shell. This can be useful if you are using Python primarily for the + enhanced control flow it offers over most system shells and still want + convenient access to other shell features such as shell pipes, filename + wildcards, environment variable expansion, and expansion of ``~`` to a + user's home directory. However, note that Python itself offers + implementations of many shell-like features (in particular, :mod:`glob`, + :mod:`fnmatch`, :func:`os.walk`, :func:`os.path.expandvars`, + :func:`os.path.expanduser`, and :mod:`shutil`). + + .. versionchanged:: 3.3 + When *universal_newlines* is ``True``, the class uses the encoding + :func:`locale.getpreferredencoding(False) ` + instead of ``locale.getpreferredencoding()``. See the + :class:`io.TextIOWrapper` class for more information on this change. + + .. note:: + + Read the `Security Considerations`_ section before using ``shell=True``. + +These options, along with all of the other options, are described in more +detail in the :class:`Popen` constructor documentation. + + +Popen Constructor +^^^^^^^^^^^^^^^^^ + +The underlying process creation and management in this module is handled by +the :class:`Popen` class. It offers a lot of flexibility so that developers +are able to handle the less common cases not covered by the convenience +functions. + + +.. class:: Popen(args, bufsize=-1, executable=None, stdin=None, stdout=None, \ + stderr=None, preexec_fn=None, close_fds=True, shell=False, \ + cwd=None, env=None, universal_newlines=None, \ + startupinfo=None, creationflags=0, restore_signals=True, \ + start_new_session=False, pass_fds=(), *, \ + encoding=None, errors=None, text=None) + + Execute a child program in a new process. On POSIX, the class uses + :meth:`os.execvp`-like behavior to execute the child program. On Windows, + the class uses the Windows ``CreateProcess()`` function. The arguments to + :class:`Popen` are as follows. + + *args* should be a sequence of program arguments or else a single string. + By default, the program to execute is the first item in *args* if *args* is + a sequence. If *args* is a string, the interpretation is + platform-dependent and described below. See the *shell* and *executable* + arguments for additional differences from the default behavior. Unless + otherwise stated, it is recommended to pass *args* as a sequence. + + On POSIX, if *args* is a string, the string is interpreted as the name or + path of the program to execute. However, this can only be done if not + passing arguments to the program. + + .. note:: + + :meth:`shlex.split` can be useful when determining the correct + tokenization for *args*, especially in complex cases:: + + >>> import shlex, subprocess + >>> command_line = input() + /bin/vikings -input eggs.txt -output "spam spam.txt" -cmd "echo '$MONEY'" + >>> args = shlex.split(command_line) + >>> print(args) + ['/bin/vikings', '-input', 'eggs.txt', '-output', 'spam spam.txt', '-cmd', "echo '$MONEY'"] + >>> p = subprocess.Popen(args) # Success! + + Note in particular that options (such as *-input*) and arguments (such + as *eggs.txt*) that are separated by whitespace in the shell go in separate + list elements, while arguments that need quoting or backslash escaping when + used in the shell (such as filenames containing spaces or the *echo* command + shown above) are single list elements. + + On Windows, if *args* is a sequence, it will be converted to a string in a + manner described in :ref:`converting-argument-sequence`. This is because + the underlying ``CreateProcess()`` operates on strings. + + The *shell* argument (which defaults to ``False``) specifies whether to use + the shell as the program to execute. If *shell* is ``True``, it is + recommended to pass *args* as a string rather than as a sequence. + + On POSIX with ``shell=True``, the shell defaults to :file:`/bin/sh`. If + *args* is a string, the string specifies the command + to execute through the shell. This means that the string must be + formatted exactly as it would be when typed at the shell prompt. This + includes, for example, quoting or backslash escaping filenames with spaces in + them. If *args* is a sequence, the first item specifies the command string, and + any additional items will be treated as additional arguments to the shell + itself. That is to say, :class:`Popen` does the equivalent of:: + + Popen(['/bin/sh', '-c', args[0], args[1], ...]) + + On Windows with ``shell=True``, the :envvar:`COMSPEC` environment variable + specifies the default shell. The only time you need to specify + ``shell=True`` on Windows is when the command you wish to execute is built + into the shell (e.g. :command:`dir` or :command:`copy`). You do not need + ``shell=True`` to run a batch file or console-based executable. + + .. note:: + + Read the `Security Considerations`_ section before using ``shell=True``. + + *bufsize* will be supplied as the corresponding argument to the + :func:`open` function when creating the stdin/stdout/stderr pipe + file objects: + + - :const:`0` means unbuffered (read and write are one + system call and can return short) + - :const:`1` means line buffered + (only usable if ``universal_newlines=True`` i.e., in a text mode) + - any other positive value means use a buffer of approximately that + size + - negative bufsize (the default) means the system default of + io.DEFAULT_BUFFER_SIZE will be used. + + .. versionchanged:: 3.3.1 + *bufsize* now defaults to -1 to enable buffering by default to match the + behavior that most code expects. In versions prior to Python 3.2.4 and + 3.3.1 it incorrectly defaulted to :const:`0` which was unbuffered + and allowed short reads. This was unintentional and did not match the + behavior of Python 2 as most code expected. + + The *executable* argument specifies a replacement program to execute. It + is very seldom needed. When ``shell=False``, *executable* replaces the + program to execute specified by *args*. However, the original *args* is + still passed to the program. Most programs treat the program specified + by *args* as the command name, which can then be different from the program + actually executed. On POSIX, the *args* name + becomes the display name for the executable in utilities such as + :program:`ps`. If ``shell=True``, on POSIX the *executable* argument + specifies a replacement shell for the default :file:`/bin/sh`. + + *stdin*, *stdout* and *stderr* specify the executed program's standard input, + standard output and standard error file handles, respectively. Valid values + are :data:`PIPE`, :data:`DEVNULL`, an existing file descriptor (a positive + integer), an existing :term:`file object`, and ``None``. :data:`PIPE` + indicates that a new pipe to the child should be created. :data:`DEVNULL` + indicates that the special file :data:`os.devnull` will be used. With the + default settings of ``None``, no redirection will occur; the child's file + handles will be inherited from the parent. Additionally, *stderr* can be + :data:`STDOUT`, which indicates that the stderr data from the applications + should be captured into the same file handle as for stdout. + + If *preexec_fn* is set to a callable object, this object will be called in the + child process just before the child is executed. + (POSIX only) + + .. warning:: + + The *preexec_fn* parameter is not safe to use in the presence of threads + in your application. The child process could deadlock before exec is + called. + If you must use it, keep it trivial! Minimize the number of libraries + you call into. + + .. note:: + + If you need to modify the environment for the child use the *env* + parameter rather than doing it in a *preexec_fn*. + The *start_new_session* parameter can take the place of a previously + common use of *preexec_fn* to call os.setsid() in the child. + + If *close_fds* is true, all file descriptors except :const:`0`, :const:`1` and + :const:`2` will be closed before the child process is executed. Otherwise + when *close_fds* is false, file descriptors obey their inheritable flag + as described in :ref:`fd_inheritance`. + + On Windows, if *close_fds* is true then no handles will be inherited by the + child process unless explicitly passed in the ``handle_list`` element of + :attr:`STARTUPINFO.lpAttributeList`, or by standard handle redirection. + + .. versionchanged:: 3.2 + The default for *close_fds* was changed from :const:`False` to + what is described above. + + .. versionchanged:: 3.7 + On Windows the default for *close_fds* was changed from :const:`False` to + :const:`True` when redirecting the standard handles. It's now possible to + set *close_fds* to :const:`True` when redirecting the standard handles. + + *pass_fds* is an optional sequence of file descriptors to keep open + between the parent and child. Providing any *pass_fds* forces + *close_fds* to be :const:`True`. (POSIX only) + + .. versionadded:: 3.2 + The *pass_fds* parameter was added. + + If *cwd* is not ``None``, the function changes the working directory to + *cwd* before executing the child. *cwd* can be a :class:`str` and + :term:`path-like ` object. In particular, the function + looks for *executable* (or for the first item in *args*) relative to *cwd* + if the executable path is a relative path. + + .. versionchanged:: 3.6 + *cwd* parameter accepts a :term:`path-like object`. + + If *restore_signals* is true (the default) all signals that Python has set to + SIG_IGN are restored to SIG_DFL in the child process before the exec. + Currently this includes the SIGPIPE, SIGXFZ and SIGXFSZ signals. + (POSIX only) + + .. versionchanged:: 3.2 + *restore_signals* was added. + + If *start_new_session* is true the setsid() system call will be made in the + child process prior to the execution of the subprocess. (POSIX only) + + .. versionchanged:: 3.2 + *start_new_session* was added. + + If *env* is not ``None``, it must be a mapping that defines the environment + variables for the new process; these are used instead of the default + behavior of inheriting the current process' environment. + + .. note:: + + If specified, *env* must provide any variables required for the program to + execute. On Windows, in order to run a `side-by-side assembly`_ the + specified *env* **must** include a valid :envvar:`SystemRoot`. + + .. _side-by-side assembly: https://en.wikipedia.org/wiki/Side-by-Side_Assembly + + If *encoding* or *errors* are specified, or *text* is true, the file objects + *stdin*, *stdout* and *stderr* are opened in text mode with the specified + encoding and *errors*, as described above in :ref:`frequently-used-arguments`. + The *universal_newlines* argument is equivalent to *text* and is provided + for backwards compatibility. By default, file objects are opened in binary mode. + + .. versionadded:: 3.6 + *encoding* and *errors* were added. + + .. versionadded:: 3.7 + *text* was added as a more readable alias for *universal_newlines*. + + If given, *startupinfo* will be a :class:`STARTUPINFO` object, which is + passed to the underlying ``CreateProcess`` function. + *creationflags*, if given, can be one or more of the following flags: + + * :data:`CREATE_NEW_CONSOLE` + * :data:`CREATE_NEW_PROCESS_GROUP` + * :data:`ABOVE_NORMAL_PRIORITY_CLASS` + * :data:`BELOW_NORMAL_PRIORITY_CLASS` + * :data:`HIGH_PRIORITY_CLASS` + * :data:`IDLE_PRIORITY_CLASS` + * :data:`NORMAL_PRIORITY_CLASS` + * :data:`REALTIME_PRIORITY_CLASS` + * :data:`CREATE_NO_WINDOW` + * :data:`DETACHED_PROCESS` + * :data:`CREATE_DEFAULT_ERROR_MODE` + * :data:`CREATE_BREAKAWAY_FROM_JOB` + + Popen objects are supported as context managers via the :keyword:`with` statement: + on exit, standard file descriptors are closed, and the process is waited for. + :: + + with Popen(["ifconfig"], stdout=PIPE) as proc: + log.write(proc.stdout.read()) + + .. versionchanged:: 3.2 + Added context manager support. + + .. versionchanged:: 3.6 + Popen destructor now emits a :exc:`ResourceWarning` warning if the child + process is still running. + + +Exceptions +^^^^^^^^^^ + +Exceptions raised in the child process, before the new program has started to +execute, will be re-raised in the parent. + +The most common exception raised is :exc:`OSError`. This occurs, for example, +when trying to execute a non-existent file. Applications should prepare for +:exc:`OSError` exceptions. + +A :exc:`ValueError` will be raised if :class:`Popen` is called with invalid +arguments. + +:func:`check_call` and :func:`check_output` will raise +:exc:`CalledProcessError` if the called process returns a non-zero return +code. + +All of the functions and methods that accept a *timeout* parameter, such as +:func:`call` and :meth:`Popen.communicate` will raise :exc:`TimeoutExpired` if +the timeout expires before the process exits. + +Exceptions defined in this module all inherit from :exc:`SubprocessError`. + + .. versionadded:: 3.3 + The :exc:`SubprocessError` base class was added. + + +Security Considerations +----------------------- + +Unlike some other popen functions, this implementation will never +implicitly call a system shell. This means that all characters, +including shell metacharacters, can safely be passed to child processes. +If the shell is invoked explicitly, via ``shell=True``, it is the application's +responsibility to ensure that all whitespace and metacharacters are +quoted appropriately to avoid +`shell injection `_ +vulnerabilities. + +When using ``shell=True``, the :func:`shlex.quote` function can be +used to properly escape whitespace and shell metacharacters in strings +that are going to be used to construct shell commands. + + +Popen Objects +------------- + +Instances of the :class:`Popen` class have the following methods: + + +.. method:: Popen.poll() + + Check if child process has terminated. Set and return + :attr:`~Popen.returncode` attribute. Otherwise, returns ``None``. + + +.. method:: Popen.wait(timeout=None) + + Wait for child process to terminate. Set and return + :attr:`~Popen.returncode` attribute. + + If the process does not terminate after *timeout* seconds, raise a + :exc:`TimeoutExpired` exception. It is safe to catch this exception and + retry the wait. + + .. note:: + + This will deadlock when using ``stdout=PIPE`` or ``stderr=PIPE`` + and the child process generates enough output to a pipe such that + it blocks waiting for the OS pipe buffer to accept more data. + Use :meth:`Popen.communicate` when using pipes to avoid that. + + .. note:: + + The function is implemented using a busy loop (non-blocking call and + short sleeps). Use the :mod:`asyncio` module for an asynchronous wait: + see :class:`asyncio.create_subprocess_exec`. + + .. versionchanged:: 3.3 + *timeout* was added. + +.. method:: Popen.communicate(input=None, timeout=None) + + Interact with process: Send data to stdin. Read data from stdout and stderr, + until end-of-file is reached. Wait for process to terminate. The optional + *input* argument should be data to be sent to the child process, or + ``None``, if no data should be sent to the child. If streams were opened in + text mode, *input* must be a string. Otherwise, it must be bytes. + + :meth:`communicate` returns a tuple ``(stdout_data, stderr_data)``. + The data will be strings if streams were opened in text mode; otherwise, + bytes. + + Note that if you want to send data to the process's stdin, you need to create + the Popen object with ``stdin=PIPE``. Similarly, to get anything other than + ``None`` in the result tuple, you need to give ``stdout=PIPE`` and/or + ``stderr=PIPE`` too. + + If the process does not terminate after *timeout* seconds, a + :exc:`TimeoutExpired` exception will be raised. Catching this exception and + retrying communication will not lose any output. + + The child process is not killed if the timeout expires, so in order to + cleanup properly a well-behaved application should kill the child process and + finish communication:: + + proc = subprocess.Popen(...) + try: + outs, errs = proc.communicate(timeout=15) + except TimeoutExpired: + proc.kill() + outs, errs = proc.communicate() + + .. note:: + + The data read is buffered in memory, so do not use this method if the data + size is large or unlimited. + + .. versionchanged:: 3.3 + *timeout* was added. + + +.. method:: Popen.send_signal(signal) + + Sends the signal *signal* to the child. + + .. note:: + + On Windows, SIGTERM is an alias for :meth:`terminate`. CTRL_C_EVENT and + CTRL_BREAK_EVENT can be sent to processes started with a *creationflags* + parameter which includes `CREATE_NEW_PROCESS_GROUP`. + + +.. method:: Popen.terminate() + + Stop the child. On Posix OSs the method sends SIGTERM to the + child. On Windows the Win32 API function :c:func:`TerminateProcess` is called + to stop the child. + + +.. method:: Popen.kill() + + Kills the child. On Posix OSs the function sends SIGKILL to the child. + On Windows :meth:`kill` is an alias for :meth:`terminate`. + + +The following attributes are also available: + +.. attribute:: Popen.args + + The *args* argument as it was passed to :class:`Popen` -- a + sequence of program arguments or else a single string. + + .. versionadded:: 3.3 + +.. attribute:: Popen.stdin + + If the *stdin* argument was :data:`PIPE`, this attribute is a writeable + stream object as returned by :func:`open`. If the *encoding* or *errors* + arguments were specified or the *universal_newlines* argument was ``True``, + the stream is a text stream, otherwise it is a byte stream. If the *stdin* + argument was not :data:`PIPE`, this attribute is ``None``. + + +.. attribute:: Popen.stdout + + If the *stdout* argument was :data:`PIPE`, this attribute is a readable + stream object as returned by :func:`open`. Reading from the stream provides + output from the child process. If the *encoding* or *errors* arguments were + specified or the *universal_newlines* argument was ``True``, the stream is a + text stream, otherwise it is a byte stream. If the *stdout* argument was not + :data:`PIPE`, this attribute is ``None``. + + +.. attribute:: Popen.stderr + + If the *stderr* argument was :data:`PIPE`, this attribute is a readable + stream object as returned by :func:`open`. Reading from the stream provides + error output from the child process. If the *encoding* or *errors* arguments + were specified or the *universal_newlines* argument was ``True``, the stream + is a text stream, otherwise it is a byte stream. If the *stderr* argument was + not :data:`PIPE`, this attribute is ``None``. + +.. warning:: + + Use :meth:`~Popen.communicate` rather than :attr:`.stdin.write `, + :attr:`.stdout.read ` or :attr:`.stderr.read ` to avoid + deadlocks due to any of the other OS pipe buffers filling up and blocking the + child process. + + +.. attribute:: Popen.pid + + The process ID of the child process. + + Note that if you set the *shell* argument to ``True``, this is the process ID + of the spawned shell. + + +.. attribute:: Popen.returncode + + The child return code, set by :meth:`poll` and :meth:`wait` (and indirectly + by :meth:`communicate`). A ``None`` value indicates that the process + hasn't terminated yet. + + A negative value ``-N`` indicates that the child was terminated by signal + ``N`` (POSIX only). + + +Windows Popen Helpers +--------------------- + +The :class:`STARTUPINFO` class and following constants are only available +on Windows. + +.. class:: STARTUPINFO(*, dwFlags=0, hStdInput=None, hStdOutput=None, \ + hStdError=None, wShowWindow=0, lpAttributeList=None) + + Partial support of the Windows + `STARTUPINFO `__ + structure is used for :class:`Popen` creation. The following attributes can + be set by passing them as keyword-only arguments. + + .. versionchanged:: 3.7 + Keyword-only argument support was added. + + .. attribute:: dwFlags + + A bit field that determines whether certain :class:`STARTUPINFO` + attributes are used when the process creates a window. :: + + si = subprocess.STARTUPINFO() + si.dwFlags = subprocess.STARTF_USESTDHANDLES | subprocess.STARTF_USESHOWWINDOW + + .. attribute:: hStdInput + + If :attr:`dwFlags` specifies :data:`STARTF_USESTDHANDLES`, this attribute + is the standard input handle for the process. If + :data:`STARTF_USESTDHANDLES` is not specified, the default for standard + input is the keyboard buffer. + + .. attribute:: hStdOutput + + If :attr:`dwFlags` specifies :data:`STARTF_USESTDHANDLES`, this attribute + is the standard output handle for the process. Otherwise, this attribute + is ignored and the default for standard output is the console window's + buffer. + + .. attribute:: hStdError + + If :attr:`dwFlags` specifies :data:`STARTF_USESTDHANDLES`, this attribute + is the standard error handle for the process. Otherwise, this attribute is + ignored and the default for standard error is the console window's buffer. + + .. attribute:: wShowWindow + + If :attr:`dwFlags` specifies :data:`STARTF_USESHOWWINDOW`, this attribute + can be any of the values that can be specified in the ``nCmdShow`` + parameter for the + `ShowWindow `__ + function, except for ``SW_SHOWDEFAULT``. Otherwise, this attribute is + ignored. + + :data:`SW_HIDE` is provided for this attribute. It is used when + :class:`Popen` is called with ``shell=True``. + + .. attribute:: lpAttributeList + + A dictionary of additional attributes for process creation as given in + ``STARTUPINFOEX``, see + `UpdateProcThreadAttribute `__. + + Supported attributes: + + **handle_list** + Sequence of handles that will be inherited. *close_fds* must be true if + non-empty. + + The handles must be temporarily made inheritable by + :func:`os.set_handle_inheritable` when passed to the :class:`Popen` + constructor, else :class:`OSError` will be raised with Windows error + ``ERROR_INVALID_PARAMETER`` (87). + + .. warning:: + + In a multithreaded process, use caution to avoid leaking handles + that are marked inheritable when combining this feature with + concurrent calls to other process creation functions that inherit + all handles such as :func:`os.system`. This also applies to + standard handle redirection, which temporarily creates inheritable + handles. + + .. versionadded:: 3.7 + +Windows Constants +^^^^^^^^^^^^^^^^^ + +The :mod:`subprocess` module exposes the following constants. + +.. data:: STD_INPUT_HANDLE + + The standard input device. Initially, this is the console input buffer, + ``CONIN$``. + +.. data:: STD_OUTPUT_HANDLE + + The standard output device. Initially, this is the active console screen + buffer, ``CONOUT$``. + +.. data:: STD_ERROR_HANDLE + + The standard error device. Initially, this is the active console screen + buffer, ``CONOUT$``. + +.. data:: SW_HIDE + + Hides the window. Another window will be activated. + +.. data:: STARTF_USESTDHANDLES + + Specifies that the :attr:`STARTUPINFO.hStdInput`, + :attr:`STARTUPINFO.hStdOutput`, and :attr:`STARTUPINFO.hStdError` attributes + contain additional information. + +.. data:: STARTF_USESHOWWINDOW + + Specifies that the :attr:`STARTUPINFO.wShowWindow` attribute contains + additional information. + +.. data:: CREATE_NEW_CONSOLE + + The new process has a new console, instead of inheriting its parent's + console (the default). + +.. data:: CREATE_NEW_PROCESS_GROUP + + A :class:`Popen` ``creationflags`` parameter to specify that a new process + group will be created. This flag is necessary for using :func:`os.kill` + on the subprocess. + + This flag is ignored if :data:`CREATE_NEW_CONSOLE` is specified. + +.. data:: ABOVE_NORMAL_PRIORITY_CLASS + + A :class:`Popen` ``creationflags`` parameter to specify that a new process + will have an above average priority. + + .. versionadded:: 3.7 + +.. data:: BELOW_NORMAL_PRIORITY_CLASS + + A :class:`Popen` ``creationflags`` parameter to specify that a new process + will have a below average priority. + + .. versionadded:: 3.7 + +.. data:: HIGH_PRIORITY_CLASS + + A :class:`Popen` ``creationflags`` parameter to specify that a new process + will have a high priority. + + .. versionadded:: 3.7 + +.. data:: IDLE_PRIORITY_CLASS + + A :class:`Popen` ``creationflags`` parameter to specify that a new process + will have an idle (lowest) priority. + + .. versionadded:: 3.7 + +.. data:: NORMAL_PRIORITY_CLASS + + A :class:`Popen` ``creationflags`` parameter to specify that a new process + will have an normal priority. (default) + + .. versionadded:: 3.7 + +.. data:: REALTIME_PRIORITY_CLASS + + A :class:`Popen` ``creationflags`` parameter to specify that a new process + will have realtime priority. + You should almost never use REALTIME_PRIORITY_CLASS, because this interrupts + system threads that manage mouse input, keyboard input, and background disk + flushing. This class can be appropriate for applications that "talk" directly + to hardware or that perform brief tasks that should have limited interruptions. + + .. versionadded:: 3.7 + +.. data:: CREATE_NO_WINDOW + + A :class:`Popen` ``creationflags`` parameter to specify that a new process + will not create a window. + + .. versionadded:: 3.7 + +.. data:: DETACHED_PROCESS + + A :class:`Popen` ``creationflags`` parameter to specify that a new process + will not inherit its parent's console. + This value cannot be used with CREATE_NEW_CONSOLE. + + .. versionadded:: 3.7 + +.. data:: CREATE_DEFAULT_ERROR_MODE + + A :class:`Popen` ``creationflags`` parameter to specify that a new process + does not inherit the error mode of the calling process. Instead, the new + process gets the default error mode. + This feature is particularly useful for multithreaded shell applications + that run with hard errors disabled. + + .. versionadded:: 3.7 + +.. data:: CREATE_BREAKAWAY_FROM_JOB + + A :class:`Popen` ``creationflags`` parameter to specify that a new process + is not associated with the job. + + .. versionadded:: 3.7 + +.. _call-function-trio: + +Older high-level API +-------------------- + +Prior to Python 3.5, these three functions comprised the high level API to +subprocess. You can now use :func:`run` in many cases, but lots of existing code +calls these functions. + +.. function:: call(args, *, stdin=None, stdout=None, stderr=None, shell=False, cwd=None, timeout=None) + + Run the command described by *args*. Wait for command to complete, then + return the :attr:`~Popen.returncode` attribute. + + Code needing to capture stdout or stderr should use :func:`run` instead: + + run(...).returncode + + To suppress stdout or stderr, supply a value of :data:`DEVNULL`. + + The arguments shown above are merely some common ones. + The full function signature is the + same as that of the :class:`Popen` constructor - this function passes all + supplied arguments other than *timeout* directly through to that interface. + + .. note:: + + Do not use ``stdout=PIPE`` or ``stderr=PIPE`` with this + function. The child process will block if it generates enough + output to a pipe to fill up the OS pipe buffer as the pipes are + not being read from. + + .. versionchanged:: 3.3 + *timeout* was added. + +.. function:: check_call(args, *, stdin=None, stdout=None, stderr=None, shell=False, cwd=None, timeout=None) + + Run command with arguments. Wait for command to complete. If the return + code was zero then return, otherwise raise :exc:`CalledProcessError`. The + :exc:`CalledProcessError` object will have the return code in the + :attr:`~CalledProcessError.returncode` attribute. + + Code needing to capture stdout or stderr should use :func:`run` instead: + + run(..., check=True) + + To suppress stdout or stderr, supply a value of :data:`DEVNULL`. + + The arguments shown above are merely some common ones. + The full function signature is the + same as that of the :class:`Popen` constructor - this function passes all + supplied arguments other than *timeout* directly through to that interface. + + .. note:: + + Do not use ``stdout=PIPE`` or ``stderr=PIPE`` with this + function. The child process will block if it generates enough + output to a pipe to fill up the OS pipe buffer as the pipes are + not being read from. + + .. versionchanged:: 3.3 + *timeout* was added. + + +.. function:: check_output(args, *, stdin=None, stderr=None, shell=False, \ + cwd=None, encoding=None, errors=None, \ + universal_newlines=None, timeout=None, text=None) + + Run command with arguments and return its output. + + If the return code was non-zero it raises a :exc:`CalledProcessError`. The + :exc:`CalledProcessError` object will have the return code in the + :attr:`~CalledProcessError.returncode` attribute and any output in the + :attr:`~CalledProcessError.output` attribute. + + This is equivalent to:: + + run(..., check=True, stdout=PIPE).stdout + + The arguments shown above are merely some common ones. + The full function signature is largely the same as that of :func:`run` - + most arguments are passed directly through to that interface. + However, explicitly passing ``input=None`` to inherit the parent's + standard input file handle is not supported. + + By default, this function will return the data as encoded bytes. The actual + encoding of the output data may depend on the command being invoked, so the + decoding to text will often need to be handled at the application level. + + This behaviour may be overridden by setting *text*, *encoding*, *errors*, + or *universal_newlines* to ``True`` as described in + :ref:`frequently-used-arguments` and :func:`run`. + + To also capture standard error in the result, use + ``stderr=subprocess.STDOUT``:: + + >>> subprocess.check_output( + ... "ls non_existent_file; exit 0", + ... stderr=subprocess.STDOUT, + ... shell=True) + 'ls: non_existent_file: No such file or directory\n' + + .. versionadded:: 3.1 + + .. versionchanged:: 3.3 + *timeout* was added. + + .. versionchanged:: 3.4 + Support for the *input* keyword argument was added. + + .. versionchanged:: 3.6 + *encoding* and *errors* were added. See :func:`run` for details. + + .. versionadded:: 3.7 + *text* was added as a more readable alias for *universal_newlines*. + + +.. _subprocess-replacements: + +Replacing Older Functions with the :mod:`subprocess` Module +----------------------------------------------------------- + +In this section, "a becomes b" means that b can be used as a replacement for a. + +.. note:: + + All "a" functions in this section fail (more or less) silently if the + executed program cannot be found; the "b" replacements raise :exc:`OSError` + instead. + + In addition, the replacements using :func:`check_output` will fail with a + :exc:`CalledProcessError` if the requested operation produces a non-zero + return code. The output is still available as the + :attr:`~CalledProcessError.output` attribute of the raised exception. + +In the following examples, we assume that the relevant functions have already +been imported from the :mod:`subprocess` module. + + +Replacing /bin/sh shell backquote +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: bash + + output=`mycmd myarg` + +becomes:: + + output = check_output(["mycmd", "myarg"]) + +Replacing shell pipeline +^^^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: bash + + output=`dmesg | grep hda` + +becomes:: + + p1 = Popen(["dmesg"], stdout=PIPE) + p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE) + p1.stdout.close() # Allow p1 to receive a SIGPIPE if p2 exits. + output = p2.communicate()[0] + +The p1.stdout.close() call after starting the p2 is important in order for p1 +to receive a SIGPIPE if p2 exits before p1. + +Alternatively, for trusted input, the shell's own pipeline support may still +be used directly: + +.. code-block:: bash + + output=`dmesg | grep hda` + +becomes:: + + output=check_output("dmesg | grep hda", shell=True) + + +Replacing :func:`os.system` +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:: + + sts = os.system("mycmd" + " myarg") + # becomes + sts = call("mycmd" + " myarg", shell=True) + +Notes: + +* Calling the program through the shell is usually not required. + +A more realistic example would look like this:: + + try: + retcode = call("mycmd" + " myarg", shell=True) + if retcode < 0: + print("Child was terminated by signal", -retcode, file=sys.stderr) + else: + print("Child returned", retcode, file=sys.stderr) + except OSError as e: + print("Execution failed:", e, file=sys.stderr) + + +Replacing the :func:`os.spawn ` family +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +P_NOWAIT example:: + + pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg") + ==> + pid = Popen(["/bin/mycmd", "myarg"]).pid + +P_WAIT example:: + + retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg") + ==> + retcode = call(["/bin/mycmd", "myarg"]) + +Vector example:: + + os.spawnvp(os.P_NOWAIT, path, args) + ==> + Popen([path] + args[1:]) + +Environment example:: + + os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env) + ==> + Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"}) + + + +Replacing :func:`os.popen`, :func:`os.popen2`, :func:`os.popen3` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:: + + (child_stdin, child_stdout) = os.popen2(cmd, mode, bufsize) + ==> + p = Popen(cmd, shell=True, bufsize=bufsize, + stdin=PIPE, stdout=PIPE, close_fds=True) + (child_stdin, child_stdout) = (p.stdin, p.stdout) + +:: + + (child_stdin, + child_stdout, + child_stderr) = os.popen3(cmd, mode, bufsize) + ==> + p = Popen(cmd, shell=True, bufsize=bufsize, + stdin=PIPE, stdout=PIPE, stderr=PIPE, close_fds=True) + (child_stdin, + child_stdout, + child_stderr) = (p.stdin, p.stdout, p.stderr) + +:: + + (child_stdin, child_stdout_and_stderr) = os.popen4(cmd, mode, bufsize) + ==> + p = Popen(cmd, shell=True, bufsize=bufsize, + stdin=PIPE, stdout=PIPE, stderr=STDOUT, close_fds=True) + (child_stdin, child_stdout_and_stderr) = (p.stdin, p.stdout) + +Return code handling translates as follows:: + + pipe = os.popen(cmd, 'w') + ... + rc = pipe.close() + if rc is not None and rc >> 8: + print("There were some errors") + ==> + process = Popen(cmd, stdin=PIPE) + ... + process.stdin.close() + if process.wait() != 0: + print("There were some errors") + + +Replacing functions from the :mod:`popen2` module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. note:: + + If the cmd argument to popen2 functions is a string, the command is executed + through /bin/sh. If it is a list, the command is directly executed. + +:: + + (child_stdout, child_stdin) = popen2.popen2("somestring", bufsize, mode) + ==> + p = Popen("somestring", shell=True, bufsize=bufsize, + stdin=PIPE, stdout=PIPE, close_fds=True) + (child_stdout, child_stdin) = (p.stdout, p.stdin) + +:: + + (child_stdout, child_stdin) = popen2.popen2(["mycmd", "myarg"], bufsize, mode) + ==> + p = Popen(["mycmd", "myarg"], bufsize=bufsize, + stdin=PIPE, stdout=PIPE, close_fds=True) + (child_stdout, child_stdin) = (p.stdout, p.stdin) + +:class:`popen2.Popen3` and :class:`popen2.Popen4` basically work as +:class:`subprocess.Popen`, except that: + +* :class:`Popen` raises an exception if the execution fails. + +* The *capturestderr* argument is replaced with the *stderr* argument. + +* ``stdin=PIPE`` and ``stdout=PIPE`` must be specified. + +* popen2 closes all file descriptors by default, but you have to specify + ``close_fds=True`` with :class:`Popen` to guarantee this behavior on + all platforms or past Python versions. + + +Legacy Shell Invocation Functions +--------------------------------- + +This module also provides the following legacy functions from the 2.x +``commands`` module. These operations implicitly invoke the system shell and +none of the guarantees described above regarding security and exception +handling consistency are valid for these functions. + +.. function:: getstatusoutput(cmd) + + Return ``(exitcode, output)`` of executing *cmd* in a shell. + + Execute the string *cmd* in a shell with :meth:`Popen.check_output` and + return a 2-tuple ``(exitcode, output)``. The locale encoding is used; + see the notes on :ref:`frequently-used-arguments` for more details. + + A trailing newline is stripped from the output. + The exit code for the command can be interpreted as the return code + of subprocess. Example:: + + >>> subprocess.getstatusoutput('ls /bin/ls') + (0, '/bin/ls') + >>> subprocess.getstatusoutput('cat /bin/junk') + (1, 'cat: /bin/junk: No such file or directory') + >>> subprocess.getstatusoutput('/bin/junk') + (127, 'sh: /bin/junk: not found') + >>> subprocess.getstatusoutput('/bin/kill $$') + (-15, '') + + .. availability:: POSIX & Windows. + + .. versionchanged:: 3.3.4 + Windows support was added. + + The function now returns (exitcode, output) instead of (status, output) + as it did in Python 3.3.3 and earlier. exitcode has the same value as + :attr:`~Popen.returncode`. + + +.. function:: getoutput(cmd) + + Return output (stdout and stderr) of executing *cmd* in a shell. + + Like :func:`getstatusoutput`, except the exit code is ignored and the return + value is a string containing the command's output. Example:: + + >>> subprocess.getoutput('ls /bin/ls') + '/bin/ls' + + .. availability:: POSIX & Windows. + + .. versionchanged:: 3.3.4 + Windows support added + + +Notes +----- + +.. _converting-argument-sequence: + +Converting an argument sequence to a string on Windows +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +On Windows, an *args* sequence is converted to a string that can be parsed +using the following rules (which correspond to the rules used by the MS C +runtime): + +1. Arguments are delimited by white space, which is either a + space or a tab. + +2. A string surrounded by double quotation marks is + interpreted as a single argument, regardless of white space + contained within. A quoted string can be embedded in an + argument. + +3. A double quotation mark preceded by a backslash is + interpreted as a literal double quotation mark. + +4. Backslashes are interpreted literally, unless they + immediately precede a double quotation mark. + +5. If backslashes immediately precede a double quotation mark, + every pair of backslashes is interpreted as a literal + backslash. If the number of backslashes is odd, the last + backslash escapes the next double quotation mark as + described in rule 3. + + +.. seealso:: + + :mod:`shlex` + Module which provides function to parse and escape command lines. diff --git a/python-3.7.4-docs-html/_sources/library/sunau.rst.txt b/python-3.7.4-docs-html/_sources/library/sunau.rst.txt new file mode 100644 index 0000000..2064fd7 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/sunau.rst.txt @@ -0,0 +1,276 @@ +:mod:`sunau` --- Read and write Sun AU files +============================================ + +.. module:: sunau + :synopsis: Provide an interface to the Sun AU sound format. + +.. sectionauthor:: Moshe Zadka + +**Source code:** :source:`Lib/sunau.py` + +-------------- + +The :mod:`sunau` module provides a convenient interface to the Sun AU sound +format. Note that this module is interface-compatible with the modules +:mod:`aifc` and :mod:`wave`. + +An audio file consists of a header followed by the data. The fields of the +header are: + ++---------------+-----------------------------------------------+ +| Field | Contents | ++===============+===============================================+ +| magic word | The four bytes ``.snd``. | ++---------------+-----------------------------------------------+ +| header size | Size of the header, including info, in bytes. | ++---------------+-----------------------------------------------+ +| data size | Physical size of the data, in bytes. | ++---------------+-----------------------------------------------+ +| encoding | Indicates how the audio samples are encoded. | ++---------------+-----------------------------------------------+ +| sample rate | The sampling rate. | ++---------------+-----------------------------------------------+ +| # of channels | The number of channels in the samples. | ++---------------+-----------------------------------------------+ +| info | ASCII string giving a description of the | +| | audio file (padded with null bytes). | ++---------------+-----------------------------------------------+ + +Apart from the info field, all header fields are 4 bytes in size. They are all +32-bit unsigned integers encoded in big-endian byte order. + +The :mod:`sunau` module defines the following functions: + + +.. function:: open(file, mode) + + If *file* is a string, open the file by that name, otherwise treat it as a + seekable file-like object. *mode* can be any of + + ``'r'`` + Read only mode. + + ``'w'`` + Write only mode. + + Note that it does not allow read/write files. + + A *mode* of ``'r'`` returns an :class:`AU_read` object, while a *mode* of ``'w'`` + or ``'wb'`` returns an :class:`AU_write` object. + + +.. function:: openfp(file, mode) + + A synonym for :func:`.open`, maintained for backwards compatibility. + + .. deprecated-removed:: 3.7 3.9 + + +The :mod:`sunau` module defines the following exception: + +.. exception:: Error + + An error raised when something is impossible because of Sun AU specs or + implementation deficiency. + + +The :mod:`sunau` module defines the following data items: + +.. data:: AUDIO_FILE_MAGIC + + An integer every valid Sun AU file begins with, stored in big-endian form. This + is the string ``.snd`` interpreted as an integer. + + +.. data:: AUDIO_FILE_ENCODING_MULAW_8 + AUDIO_FILE_ENCODING_LINEAR_8 + AUDIO_FILE_ENCODING_LINEAR_16 + AUDIO_FILE_ENCODING_LINEAR_24 + AUDIO_FILE_ENCODING_LINEAR_32 + AUDIO_FILE_ENCODING_ALAW_8 + + Values of the encoding field from the AU header which are supported by this + module. + + +.. data:: AUDIO_FILE_ENCODING_FLOAT + AUDIO_FILE_ENCODING_DOUBLE + AUDIO_FILE_ENCODING_ADPCM_G721 + AUDIO_FILE_ENCODING_ADPCM_G722 + AUDIO_FILE_ENCODING_ADPCM_G723_3 + AUDIO_FILE_ENCODING_ADPCM_G723_5 + + Additional known values of the encoding field from the AU header, but which are + not supported by this module. + + +.. _au-read-objects: + +AU_read Objects +--------------- + +AU_read objects, as returned by :func:`.open` above, have the following methods: + + +.. method:: AU_read.close() + + Close the stream, and make the instance unusable. (This is called automatically + on deletion.) + + +.. method:: AU_read.getnchannels() + + Returns number of audio channels (1 for mono, 2 for stereo). + + +.. method:: AU_read.getsampwidth() + + Returns sample width in bytes. + + +.. method:: AU_read.getframerate() + + Returns sampling frequency. + + +.. method:: AU_read.getnframes() + + Returns number of audio frames. + + +.. method:: AU_read.getcomptype() + + Returns compression type. Supported compression types are ``'ULAW'``, ``'ALAW'`` + and ``'NONE'``. + + +.. method:: AU_read.getcompname() + + Human-readable version of :meth:`getcomptype`. The supported types have the + respective names ``'CCITT G.711 u-law'``, ``'CCITT G.711 A-law'`` and ``'not + compressed'``. + + +.. method:: AU_read.getparams() + + Returns a :func:`~collections.namedtuple` ``(nchannels, sampwidth, + framerate, nframes, comptype, compname)``, equivalent to output of the + :meth:`get\*` methods. + + +.. method:: AU_read.readframes(n) + + Reads and returns at most *n* frames of audio, as a :class:`bytes` object. The data + will be returned in linear format. If the original data is in u-LAW format, it + will be converted. + + +.. method:: AU_read.rewind() + + Rewind the file pointer to the beginning of the audio stream. + +The following two methods define a term "position" which is compatible between +them, and is otherwise implementation dependent. + + +.. method:: AU_read.setpos(pos) + + Set the file pointer to the specified position. Only values returned from + :meth:`tell` should be used for *pos*. + + +.. method:: AU_read.tell() + + Return current file pointer position. Note that the returned value has nothing + to do with the actual position in the file. + +The following two functions are defined for compatibility with the :mod:`aifc`, +and don't do anything interesting. + + +.. method:: AU_read.getmarkers() + + Returns ``None``. + + +.. method:: AU_read.getmark(id) + + Raise an error. + + +.. _au-write-objects: + +AU_write Objects +---------------- + +AU_write objects, as returned by :func:`.open` above, have the following methods: + + +.. method:: AU_write.setnchannels(n) + + Set the number of channels. + + +.. method:: AU_write.setsampwidth(n) + + Set the sample width (in bytes.) + + .. versionchanged:: 3.4 + Added support for 24-bit samples. + + +.. method:: AU_write.setframerate(n) + + Set the frame rate. + + +.. method:: AU_write.setnframes(n) + + Set the number of frames. This can be later changed, when and if more frames + are written. + + +.. method:: AU_write.setcomptype(type, name) + + Set the compression type and description. Only ``'NONE'`` and ``'ULAW'`` are + supported on output. + + +.. method:: AU_write.setparams(tuple) + + The *tuple* should be ``(nchannels, sampwidth, framerate, nframes, comptype, + compname)``, with values valid for the :meth:`set\*` methods. Set all + parameters. + + +.. method:: AU_write.tell() + + Return current position in the file, with the same disclaimer for the + :meth:`AU_read.tell` and :meth:`AU_read.setpos` methods. + + +.. method:: AU_write.writeframesraw(data) + + Write audio frames, without correcting *nframes*. + + .. versionchanged:: 3.4 + Any :term:`bytes-like object` is now accepted. + + +.. method:: AU_write.writeframes(data) + + Write audio frames and make sure *nframes* is correct. + + .. versionchanged:: 3.4 + Any :term:`bytes-like object` is now accepted. + + +.. method:: AU_write.close() + + Make sure *nframes* is correct, and close the file. + + This method is called upon deletion. + +Note that it is invalid to set any parameters after calling :meth:`writeframes` +or :meth:`writeframesraw`. + diff --git a/python-3.7.4-docs-html/_sources/library/superseded.rst.txt b/python-3.7.4-docs-html/_sources/library/superseded.rst.txt new file mode 100644 index 0000000..50a5983 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/superseded.rst.txt @@ -0,0 +1,14 @@ +.. _superseded: + +****************** +Superseded Modules +****************** + +The modules described in this chapter are deprecated and only kept for +backwards compatibility. They have been superseded by other modules. + + +.. toctree:: + + optparse.rst + imp.rst diff --git a/python-3.7.4-docs-html/_sources/library/symbol.rst.txt b/python-3.7.4-docs-html/_sources/library/symbol.rst.txt new file mode 100644 index 0000000..4499693 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/symbol.rst.txt @@ -0,0 +1,27 @@ +:mod:`symbol` --- Constants used with Python parse trees +======================================================== + +.. module:: symbol + :synopsis: Constants representing internal nodes of the parse tree. + +.. sectionauthor:: Fred L. Drake, Jr. + +**Source code:** :source:`Lib/symbol.py` + +-------------- + +This module provides constants which represent the numeric values of internal +nodes of the parse tree. Unlike most Python constants, these use lower-case +names. Refer to the file :file:`Grammar/Grammar` in the Python distribution for +the definitions of the names in the context of the language grammar. The +specific numeric values which the names map to may change between Python +versions. + +This module also provides one additional data object: + + +.. data:: sym_name + + Dictionary mapping the numeric values of the constants defined in this module + back to name strings, allowing more human-readable representation of parse trees + to be generated. diff --git a/python-3.7.4-docs-html/_sources/library/symtable.rst.txt b/python-3.7.4-docs-html/_sources/library/symtable.rst.txt new file mode 100644 index 0000000..ba2caff --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/symtable.rst.txt @@ -0,0 +1,188 @@ +:mod:`symtable` --- Access to the compiler's symbol tables +========================================================== + +.. module:: symtable + :synopsis: Interface to the compiler's internal symbol tables. + +**Source code:** :source:`Lib/symtable.py` + +-------------- + +.. moduleauthor:: Jeremy Hylton +.. sectionauthor:: Benjamin Peterson + + +Symbol tables are generated by the compiler from AST just before bytecode is +generated. The symbol table is responsible for calculating the scope of every +identifier in the code. :mod:`symtable` provides an interface to examine these +tables. + + +Generating Symbol Tables +------------------------ + +.. function:: symtable(code, filename, compile_type) + + Return the toplevel :class:`SymbolTable` for the Python source *code*. + *filename* is the name of the file containing the code. *compile_type* is + like the *mode* argument to :func:`compile`. + + +Examining Symbol Tables +----------------------- + +.. class:: SymbolTable + + A namespace table for a block. The constructor is not public. + + .. method:: get_type() + + Return the type of the symbol table. Possible values are ``'class'``, + ``'module'``, and ``'function'``. + + .. method:: get_id() + + Return the table's identifier. + + .. method:: get_name() + + Return the table's name. This is the name of the class if the table is + for a class, the name of the function if the table is for a function, or + ``'top'`` if the table is global (:meth:`get_type` returns ``'module'``). + + .. method:: get_lineno() + + Return the number of the first line in the block this table represents. + + .. method:: is_optimized() + + Return ``True`` if the locals in this table can be optimized. + + .. method:: is_nested() + + Return ``True`` if the block is a nested class or function. + + .. method:: has_children() + + Return ``True`` if the block has nested namespaces within it. These can + be obtained with :meth:`get_children`. + + .. method:: has_exec() + + Return ``True`` if the block uses ``exec``. + + .. method:: get_identifiers() + + Return a list of names of symbols in this table. + + .. method:: lookup(name) + + Lookup *name* in the table and return a :class:`Symbol` instance. + + .. method:: get_symbols() + + Return a list of :class:`Symbol` instances for names in the table. + + .. method:: get_children() + + Return a list of the nested symbol tables. + + +.. class:: Function + + A namespace for a function or method. This class inherits + :class:`SymbolTable`. + + .. method:: get_parameters() + + Return a tuple containing names of parameters to this function. + + .. method:: get_locals() + + Return a tuple containing names of locals in this function. + + .. method:: get_globals() + + Return a tuple containing names of globals in this function. + + .. method:: get_frees() + + Return a tuple containing names of free variables in this function. + + +.. class:: Class + + A namespace of a class. This class inherits :class:`SymbolTable`. + + .. method:: get_methods() + + Return a tuple containing the names of methods declared in the class. + + +.. class:: Symbol + + An entry in a :class:`SymbolTable` corresponding to an identifier in the + source. The constructor is not public. + + .. method:: get_name() + + Return the symbol's name. + + .. method:: is_referenced() + + Return ``True`` if the symbol is used in its block. + + .. method:: is_imported() + + Return ``True`` if the symbol is created from an import statement. + + .. method:: is_parameter() + + Return ``True`` if the symbol is a parameter. + + .. method:: is_global() + + Return ``True`` if the symbol is global. + + .. method:: is_declared_global() + + Return ``True`` if the symbol is declared global with a global statement. + + .. method:: is_local() + + Return ``True`` if the symbol is local to its block. + + .. method:: is_free() + + Return ``True`` if the symbol is referenced in its block, but not assigned + to. + + .. method:: is_assigned() + + Return ``True`` if the symbol is assigned to in its block. + + .. method:: is_namespace() + + Return ``True`` if name binding introduces new namespace. + + If the name is used as the target of a function or class statement, this + will be true. + + For example:: + + >>> table = symtable.symtable("def some_func(): pass", "string", "exec") + >>> table.lookup("some_func").is_namespace() + True + + Note that a single name can be bound to multiple objects. If the result + is ``True``, the name may also be bound to other objects, like an int or + list, that does not introduce a new namespace. + + .. method:: get_namespaces() + + Return a list of namespaces bound to this name. + + .. method:: get_namespace() + + Return the namespace bound to this name. If more than one namespace is + bound, :exc:`ValueError` is raised. diff --git a/python-3.7.4-docs-html/_sources/library/sys.rst.txt b/python-3.7.4-docs-html/_sources/library/sys.rst.txt new file mode 100644 index 0000000..9a8c2ca --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/sys.rst.txt @@ -0,0 +1,1530 @@ +:mod:`sys` --- System-specific parameters and functions +======================================================= + +.. module:: sys + :synopsis: Access system-specific parameters and functions. + +-------------- + +This module provides access to some variables used or maintained by the +interpreter and to functions that interact strongly with the interpreter. It is +always available. + + +.. data:: abiflags + + On POSIX systems where Python was built with the standard ``configure`` + script, this contains the ABI flags as specified by :pep:`3149`. + + .. versionadded:: 3.2 + + +.. data:: argv + + The list of command line arguments passed to a Python script. ``argv[0]`` is the + script name (it is operating system dependent whether this is a full pathname or + not). If the command was executed using the :option:`-c` command line option to + the interpreter, ``argv[0]`` is set to the string ``'-c'``. If no script name + was passed to the Python interpreter, ``argv[0]`` is the empty string. + + To loop over the standard input, or the list of files given on the + command line, see the :mod:`fileinput` module. + + .. note:: + On Unix, command line arguments are passed by bytes from OS. Python decodes + them with filesystem encoding and "surrogateescape" error handler. + When you need original bytes, you can get it by + ``[os.fsencode(arg) for arg in sys.argv]``. + + +.. data:: base_exec_prefix + + Set during Python startup, before ``site.py`` is run, to the same value as + :data:`exec_prefix`. If not running in a + :ref:`virtual environment `, the values will stay the same; if + ``site.py`` finds that a virtual environment is in use, the values of + :data:`prefix` and :data:`exec_prefix` will be changed to point to the + virtual environment, whereas :data:`base_prefix` and + :data:`base_exec_prefix` will remain pointing to the base Python + installation (the one which the virtual environment was created from). + + .. versionadded:: 3.3 + + +.. data:: base_prefix + + Set during Python startup, before ``site.py`` is run, to the same value as + :data:`prefix`. If not running in a :ref:`virtual environment `, the values + will stay the same; if ``site.py`` finds that a virtual environment is in + use, the values of :data:`prefix` and :data:`exec_prefix` will be changed to + point to the virtual environment, whereas :data:`base_prefix` and + :data:`base_exec_prefix` will remain pointing to the base Python + installation (the one which the virtual environment was created from). + + .. versionadded:: 3.3 + + +.. data:: byteorder + + An indicator of the native byte order. This will have the value ``'big'`` on + big-endian (most-significant byte first) platforms, and ``'little'`` on + little-endian (least-significant byte first) platforms. + + +.. data:: builtin_module_names + + A tuple of strings giving the names of all modules that are compiled into this + Python interpreter. (This information is not available in any other way --- + ``modules.keys()`` only lists the imported modules.) + + +.. function:: call_tracing(func, args) + + Call ``func(*args)``, while tracing is enabled. The tracing state is saved, + and restored afterwards. This is intended to be called from a debugger from + a checkpoint, to recursively debug some other code. + + +.. data:: copyright + + A string containing the copyright pertaining to the Python interpreter. + + +.. function:: _clear_type_cache() + + Clear the internal type cache. The type cache is used to speed up attribute + and method lookups. Use the function *only* to drop unnecessary references + during reference leak debugging. + + This function should be used for internal and specialized purposes only. + + +.. function:: _current_frames() + + Return a dictionary mapping each thread's identifier to the topmost stack frame + currently active in that thread at the time the function is called. Note that + functions in the :mod:`traceback` module can build the call stack given such a + frame. + + This is most useful for debugging deadlock: this function does not require the + deadlocked threads' cooperation, and such threads' call stacks are frozen for as + long as they remain deadlocked. The frame returned for a non-deadlocked thread + may bear no relationship to that thread's current activity by the time calling + code examines the frame. + + This function should be used for internal and specialized purposes only. + + +.. function:: breakpointhook() + + This hook function is called by built-in :func:`breakpoint`. By default, + it drops you into the :mod:`pdb` debugger, but it can be set to any other + function so that you can choose which debugger gets used. + + The signature of this function is dependent on what it calls. For example, + the default binding (e.g. ``pdb.set_trace()``) expects no arguments, but + you might bind it to a function that expects additional arguments + (positional and/or keyword). The built-in ``breakpoint()`` function passes + its ``*args`` and ``**kws`` straight through. Whatever + ``breakpointhooks()`` returns is returned from ``breakpoint()``. + + The default implementation first consults the environment variable + :envvar:`PYTHONBREAKPOINT`. If that is set to ``"0"`` then this function + returns immediately; i.e. it is a no-op. If the environment variable is + not set, or is set to the empty string, ``pdb.set_trace()`` is called. + Otherwise this variable should name a function to run, using Python's + dotted-import nomenclature, e.g. ``package.subpackage.module.function``. + In this case, ``package.subpackage.module`` would be imported and the + resulting module must have a callable named ``function()``. This is run, + passing in ``*args`` and ``**kws``, and whatever ``function()`` returns, + ``sys.breakpointhook()`` returns to the built-in :func:`breakpoint` + function. + + Note that if anything goes wrong while importing the callable named by + :envvar:`PYTHONBREAKPOINT`, a :exc:`RuntimeWarning` is reported and the + breakpoint is ignored. + + Also note that if ``sys.breakpointhook()`` is overridden programmatically, + :envvar:`PYTHONBREAKPOINT` is *not* consulted. + + .. versionadded:: 3.7 + +.. function:: _debugmallocstats() + + Print low-level information to stderr about the state of CPython's memory + allocator. + + If Python is configured --with-pydebug, it also performs some expensive + internal consistency checks. + + .. versionadded:: 3.3 + + .. impl-detail:: + + This function is specific to CPython. The exact output format is not + defined here, and may change. + + +.. data:: dllhandle + + Integer specifying the handle of the Python DLL. + + .. availability:: Windows. + + +.. function:: displayhook(value) + + If *value* is not ``None``, this function prints ``repr(value)`` to + ``sys.stdout``, and saves *value* in ``builtins._``. If ``repr(value)`` is + not encodable to ``sys.stdout.encoding`` with ``sys.stdout.errors`` error + handler (which is probably ``'strict'``), encode it to + ``sys.stdout.encoding`` with ``'backslashreplace'`` error handler. + + ``sys.displayhook`` is called on the result of evaluating an :term:`expression` + entered in an interactive Python session. The display of these values can be + customized by assigning another one-argument function to ``sys.displayhook``. + + Pseudo-code:: + + def displayhook(value): + if value is None: + return + # Set '_' to None to avoid recursion + builtins._ = None + text = repr(value) + try: + sys.stdout.write(text) + except UnicodeEncodeError: + bytes = text.encode(sys.stdout.encoding, 'backslashreplace') + if hasattr(sys.stdout, 'buffer'): + sys.stdout.buffer.write(bytes) + else: + text = bytes.decode(sys.stdout.encoding, 'strict') + sys.stdout.write(text) + sys.stdout.write("\n") + builtins._ = value + + .. versionchanged:: 3.2 + Use ``'backslashreplace'`` error handler on :exc:`UnicodeEncodeError`. + + +.. data:: dont_write_bytecode + + If this is true, Python won't try to write ``.pyc`` files on the + import of source modules. This value is initially set to ``True`` or + ``False`` depending on the :option:`-B` command line option and the + :envvar:`PYTHONDONTWRITEBYTECODE` environment variable, but you can set it + yourself to control bytecode file generation. + + +.. function:: excepthook(type, value, traceback) + + This function prints out a given traceback and exception to ``sys.stderr``. + + When an exception is raised and uncaught, the interpreter calls + ``sys.excepthook`` with three arguments, the exception class, exception + instance, and a traceback object. In an interactive session this happens just + before control is returned to the prompt; in a Python program this happens just + before the program exits. The handling of such top-level exceptions can be + customized by assigning another three-argument function to ``sys.excepthook``. + + +.. data:: __breakpointhook__ + __displayhook__ + __excepthook__ + + These objects contain the original values of ``breakpointhook``, + ``displayhook``, and ``excepthook`` at the start of the program. They are + saved so that ``breakpointhook``, ``displayhook`` and ``excepthook`` can be + restored in case they happen to get replaced with broken or alternative + objects. + + .. versionadded:: 3.7 + __breakpointhook__ + + +.. function:: exc_info() + + This function returns a tuple of three values that give information about the + exception that is currently being handled. The information returned is specific + both to the current thread and to the current stack frame. If the current stack + frame is not handling an exception, the information is taken from the calling + stack frame, or its caller, and so on until a stack frame is found that is + handling an exception. Here, "handling an exception" is defined as "executing + an except clause." For any stack frame, only information about the exception + being currently handled is accessible. + + .. index:: object: traceback + + If no exception is being handled anywhere on the stack, a tuple containing + three ``None`` values is returned. Otherwise, the values returned are + ``(type, value, traceback)``. Their meaning is: *type* gets the type of the + exception being handled (a subclass of :exc:`BaseException`); *value* gets + the exception instance (an instance of the exception type); *traceback* gets + a traceback object (see the Reference Manual) which encapsulates the call + stack at the point where the exception originally occurred. + + +.. data:: exec_prefix + + A string giving the site-specific directory prefix where the platform-dependent + Python files are installed; by default, this is also ``'/usr/local'``. This can + be set at build time with the ``--exec-prefix`` argument to the + :program:`configure` script. Specifically, all configuration files (e.g. the + :file:`pyconfig.h` header file) are installed in the directory + :file:`{exec_prefix}/lib/python{X.Y}/config`, and shared library modules are + installed in :file:`{exec_prefix}/lib/python{X.Y}/lib-dynload`, where *X.Y* + is the version number of Python, for example ``3.2``. + + .. note:: + + If a :ref:`virtual environment ` is in effect, this + value will be changed in ``site.py`` to point to the virtual environment. + The value for the Python installation will still be available, via + :data:`base_exec_prefix`. + + +.. data:: executable + + A string giving the absolute path of the executable binary for the Python + interpreter, on systems where this makes sense. If Python is unable to retrieve + the real path to its executable, :data:`sys.executable` will be an empty string + or ``None``. + + +.. function:: exit([arg]) + + Exit from Python. This is implemented by raising the :exc:`SystemExit` + exception, so cleanup actions specified by finally clauses of :keyword:`try` + statements are honored, and it is possible to intercept the exit attempt at + an outer level. + + The optional argument *arg* can be an integer giving the exit status + (defaulting to zero), or another type of object. If it is an integer, zero + is considered "successful termination" and any nonzero value is considered + "abnormal termination" by shells and the like. Most systems require it to be + in the range 0--127, and produce undefined results otherwise. Some systems + have a convention for assigning specific meanings to specific exit codes, but + these are generally underdeveloped; Unix programs generally use 2 for command + line syntax errors and 1 for all other kind of errors. If another type of + object is passed, ``None`` is equivalent to passing zero, and any other + object is printed to :data:`stderr` and results in an exit code of 1. In + particular, ``sys.exit("some error message")`` is a quick way to exit a + program when an error occurs. + + Since :func:`exit` ultimately "only" raises an exception, it will only exit + the process when called from the main thread, and the exception is not + intercepted. + + .. versionchanged:: 3.6 + If an error occurs in the cleanup after the Python interpreter + has caught :exc:`SystemExit` (such as an error flushing buffered data + in the standard streams), the exit status is changed to 120. + + +.. data:: flags + + The :term:`struct sequence` *flags* exposes the status of command line + flags. The attributes are read only. + + ============================= ============================= + attribute flag + ============================= ============================= + :const:`debug` :option:`-d` + :const:`inspect` :option:`-i` + :const:`interactive` :option:`-i` + :const:`isolated` :option:`-I` + :const:`optimize` :option:`-O` or :option:`-OO` + :const:`dont_write_bytecode` :option:`-B` + :const:`no_user_site` :option:`-s` + :const:`no_site` :option:`-S` + :const:`ignore_environment` :option:`-E` + :const:`verbose` :option:`-v` + :const:`bytes_warning` :option:`-b` + :const:`quiet` :option:`-q` + :const:`hash_randomization` :option:`-R` + :const:`dev_mode` :option:`-X` ``dev`` + :const:`utf8_mode` :option:`-X` ``utf8`` + ============================= ============================= + + .. versionchanged:: 3.2 + Added ``quiet`` attribute for the new :option:`-q` flag. + + .. versionadded:: 3.2.3 + The ``hash_randomization`` attribute. + + .. versionchanged:: 3.3 + Removed obsolete ``division_warning`` attribute. + + .. versionchanged:: 3.4 + Added ``isolated`` attribute for :option:`-I` ``isolated`` flag. + + .. versionchanged:: 3.7 + Added ``dev_mode`` attribute for the new :option:`-X` ``dev`` flag + and ``utf8_mode`` attribute for the new :option:`-X` ``utf8`` flag. + + +.. data:: float_info + + A :term:`struct sequence` holding information about the float type. It + contains low level information about the precision and internal + representation. The values correspond to the various floating-point + constants defined in the standard header file :file:`float.h` for the 'C' + programming language; see section 5.2.4.2.2 of the 1999 ISO/IEC C standard + [C99]_, 'Characteristics of floating types', for details. + + .. tabularcolumns:: |l|l|L| + + +---------------------+----------------+--------------------------------------------------+ + | attribute | float.h macro | explanation | + +=====================+================+==================================================+ + | :const:`epsilon` | DBL_EPSILON | difference between 1 and the least value greater | + | | | than 1 that is representable as a float | + +---------------------+----------------+--------------------------------------------------+ + | :const:`dig` | DBL_DIG | maximum number of decimal digits that can be | + | | | faithfully represented in a float; see below | + +---------------------+----------------+--------------------------------------------------+ + | :const:`mant_dig` | DBL_MANT_DIG | float precision: the number of base-``radix`` | + | | | digits in the significand of a float | + +---------------------+----------------+--------------------------------------------------+ + | :const:`max` | DBL_MAX | maximum representable finite float | + +---------------------+----------------+--------------------------------------------------+ + | :const:`max_exp` | DBL_MAX_EXP | maximum integer e such that ``radix**(e-1)`` is | + | | | a representable finite float | + +---------------------+----------------+--------------------------------------------------+ + | :const:`max_10_exp` | DBL_MAX_10_EXP | maximum integer e such that ``10**e`` is in the | + | | | range of representable finite floats | + +---------------------+----------------+--------------------------------------------------+ + | :const:`min` | DBL_MIN | minimum positive normalized float | + +---------------------+----------------+--------------------------------------------------+ + | :const:`min_exp` | DBL_MIN_EXP | minimum integer e such that ``radix**(e-1)`` is | + | | | a normalized float | + +---------------------+----------------+--------------------------------------------------+ + | :const:`min_10_exp` | DBL_MIN_10_EXP | minimum integer e such that ``10**e`` is a | + | | | normalized float | + +---------------------+----------------+--------------------------------------------------+ + | :const:`radix` | FLT_RADIX | radix of exponent representation | + +---------------------+----------------+--------------------------------------------------+ + | :const:`rounds` | FLT_ROUNDS | integer constant representing the rounding mode | + | | | used for arithmetic operations. This reflects | + | | | the value of the system FLT_ROUNDS macro at | + | | | interpreter startup time. See section 5.2.4.2.2 | + | | | of the C99 standard for an explanation of the | + | | | possible values and their meanings. | + +---------------------+----------------+--------------------------------------------------+ + + The attribute :attr:`sys.float_info.dig` needs further explanation. If + ``s`` is any string representing a decimal number with at most + :attr:`sys.float_info.dig` significant digits, then converting ``s`` to a + float and back again will recover a string representing the same decimal + value:: + + >>> import sys + >>> sys.float_info.dig + 15 + >>> s = '3.14159265358979' # decimal string with 15 significant digits + >>> format(float(s), '.15g') # convert to float and back -> same value + '3.14159265358979' + + But for strings with more than :attr:`sys.float_info.dig` significant digits, + this isn't always true:: + + >>> s = '9876543211234567' # 16 significant digits is too many! + >>> format(float(s), '.16g') # conversion changes value + '9876543211234568' + +.. data:: float_repr_style + + A string indicating how the :func:`repr` function behaves for + floats. If the string has value ``'short'`` then for a finite + float ``x``, ``repr(x)`` aims to produce a short string with the + property that ``float(repr(x)) == x``. This is the usual behaviour + in Python 3.1 and later. Otherwise, ``float_repr_style`` has value + ``'legacy'`` and ``repr(x)`` behaves in the same way as it did in + versions of Python prior to 3.1. + + .. versionadded:: 3.1 + + +.. function:: getallocatedblocks() + + Return the number of memory blocks currently allocated by the interpreter, + regardless of their size. This function is mainly useful for tracking + and debugging memory leaks. Because of the interpreter's internal + caches, the result can vary from call to call; you may have to call + :func:`_clear_type_cache()` and :func:`gc.collect()` to get more + predictable results. + + If a Python build or implementation cannot reasonably compute this + information, :func:`getallocatedblocks()` is allowed to return 0 instead. + + .. versionadded:: 3.4 + + +.. function:: getandroidapilevel() + + Return the build time API version of Android as an integer. + + .. availability:: Android. + + .. versionadded:: 3.7 + + +.. function:: getcheckinterval() + + Return the interpreter's "check interval"; see :func:`setcheckinterval`. + + .. deprecated:: 3.2 + Use :func:`getswitchinterval` instead. + + +.. function:: getdefaultencoding() + + Return the name of the current default string encoding used by the Unicode + implementation. + + +.. function:: getdlopenflags() + + Return the current value of the flags that are used for + :c:func:`dlopen` calls. Symbolic names for the flag values can be + found in the :mod:`os` module (``RTLD_xxx`` constants, e.g. + :data:`os.RTLD_LAZY`). + + .. availability:: Unix. + + +.. function:: getfilesystemencoding() + + Return the name of the encoding used to convert between Unicode + filenames and bytes filenames. For best compatibility, str should be + used for filenames in all cases, although representing filenames as bytes + is also supported. Functions accepting or returning filenames should support + either str or bytes and internally convert to the system's preferred + representation. + + This encoding is always ASCII-compatible. + + :func:`os.fsencode` and :func:`os.fsdecode` should be used to ensure that + the correct encoding and errors mode are used. + + * In the UTF-8 mode, the encoding is ``utf-8`` on any platform. + + * On Mac OS X, the encoding is ``'utf-8'``. + + * On Unix, the encoding is the locale encoding. + + * On Windows, the encoding may be ``'utf-8'`` or ``'mbcs'``, depending + on user configuration. + + .. versionchanged:: 3.2 + :func:`getfilesystemencoding` result cannot be ``None`` anymore. + + .. versionchanged:: 3.6 + Windows is no longer guaranteed to return ``'mbcs'``. See :pep:`529` + and :func:`_enablelegacywindowsfsencoding` for more information. + + .. versionchanged:: 3.7 + Return 'utf-8' in the UTF-8 mode. + + +.. function:: getfilesystemencodeerrors() + + Return the name of the error mode used to convert between Unicode filenames + and bytes filenames. The encoding name is returned from + :func:`getfilesystemencoding`. + + :func:`os.fsencode` and :func:`os.fsdecode` should be used to ensure that + the correct encoding and errors mode are used. + + .. versionadded:: 3.6 + +.. function:: getrefcount(object) + + Return the reference count of the *object*. The count returned is generally one + higher than you might expect, because it includes the (temporary) reference as + an argument to :func:`getrefcount`. + + +.. function:: getrecursionlimit() + + Return the current value of the recursion limit, the maximum depth of the Python + interpreter stack. This limit prevents infinite recursion from causing an + overflow of the C stack and crashing Python. It can be set by + :func:`setrecursionlimit`. + + +.. function:: getsizeof(object[, default]) + + Return the size of an object in bytes. The object can be any type of + object. All built-in objects will return correct results, but this + does not have to hold true for third-party extensions as it is implementation + specific. + + Only the memory consumption directly attributed to the object is + accounted for, not the memory consumption of objects it refers to. + + If given, *default* will be returned if the object does not provide means to + retrieve the size. Otherwise a :exc:`TypeError` will be raised. + + :func:`getsizeof` calls the object's ``__sizeof__`` method and adds an + additional garbage collector overhead if the object is managed by the garbage + collector. + + See `recursive sizeof recipe `_ + for an example of using :func:`getsizeof` recursively to find the size of + containers and all their contents. + +.. function:: getswitchinterval() + + Return the interpreter's "thread switch interval"; see + :func:`setswitchinterval`. + + .. versionadded:: 3.2 + + +.. function:: _getframe([depth]) + + Return a frame object from the call stack. If optional integer *depth* is + given, return the frame object that many calls below the top of the stack. If + that is deeper than the call stack, :exc:`ValueError` is raised. The default + for *depth* is zero, returning the frame at the top of the call stack. + + .. impl-detail:: + + This function should be used for internal and specialized purposes only. + It is not guaranteed to exist in all implementations of Python. + + +.. function:: getprofile() + + .. index:: + single: profile function + single: profiler + + Get the profiler function as set by :func:`setprofile`. + + +.. function:: gettrace() + + .. index:: + single: trace function + single: debugger + + Get the trace function as set by :func:`settrace`. + + .. impl-detail:: + + The :func:`gettrace` function is intended only for implementing debuggers, + profilers, coverage tools and the like. Its behavior is part of the + implementation platform, rather than part of the language definition, and + thus may not be available in all Python implementations. + + +.. function:: getwindowsversion() + + Return a named tuple describing the Windows version + currently running. The named elements are *major*, *minor*, + *build*, *platform*, *service_pack*, *service_pack_minor*, + *service_pack_major*, *suite_mask*, *product_type* and + *platform_version*. *service_pack* contains a string, + *platform_version* a 3-tuple and all other values are + integers. The components can also be accessed by name, so + ``sys.getwindowsversion()[0]`` is equivalent to + ``sys.getwindowsversion().major``. For compatibility with prior + versions, only the first 5 elements are retrievable by indexing. + + *platform* will be :const:`2 (VER_PLATFORM_WIN32_NT)`. + + *product_type* may be one of the following values: + + +---------------------------------------+---------------------------------+ + | Constant | Meaning | + +=======================================+=================================+ + | :const:`1 (VER_NT_WORKSTATION)` | The system is a workstation. | + +---------------------------------------+---------------------------------+ + | :const:`2 (VER_NT_DOMAIN_CONTROLLER)` | The system is a domain | + | | controller. | + +---------------------------------------+---------------------------------+ + | :const:`3 (VER_NT_SERVER)` | The system is a server, but not | + | | a domain controller. | + +---------------------------------------+---------------------------------+ + + This function wraps the Win32 :c:func:`GetVersionEx` function; see the + Microsoft documentation on :c:func:`OSVERSIONINFOEX` for more information + about these fields. + + *platform_version* returns the accurate major version, minor version and + build number of the current operating system, rather than the version that + is being emulated for the process. It is intended for use in logging rather + than for feature detection. + + .. availability:: Windows. + + .. versionchanged:: 3.2 + Changed to a named tuple and added *service_pack_minor*, + *service_pack_major*, *suite_mask*, and *product_type*. + + .. versionchanged:: 3.6 + Added *platform_version* + + +.. function:: get_asyncgen_hooks() + + Returns an *asyncgen_hooks* object, which is similar to a + :class:`~collections.namedtuple` of the form `(firstiter, finalizer)`, + where *firstiter* and *finalizer* are expected to be either ``None`` or + functions which take an :term:`asynchronous generator iterator` as an + argument, and are used to schedule finalization of an asynchronous + generator by an event loop. + + .. versionadded:: 3.6 + See :pep:`525` for more details. + + .. note:: + This function has been added on a provisional basis (see :pep:`411` + for details.) + + +.. function:: get_coroutine_origin_tracking_depth() + + Get the current coroutine origin tracking depth, as set by + :func:`set_coroutine_origin_tracking_depth`. + + .. versionadded:: 3.7 + + .. note:: + This function has been added on a provisional basis (see :pep:`411` + for details.) Use it only for debugging purposes. + + +.. function:: get_coroutine_wrapper() + + Returns ``None``, or a wrapper set by :func:`set_coroutine_wrapper`. + + .. versionadded:: 3.5 + See :pep:`492` for more details. + + .. note:: + This function has been added on a provisional basis (see :pep:`411` + for details.) Use it only for debugging purposes. + + .. deprecated:: 3.7 + The coroutine wrapper functionality has been deprecated, and + will be removed in 3.8. See :issue:`32591` for details. + + +.. data:: hash_info + + A :term:`struct sequence` giving parameters of the numeric hash + implementation. For more details about hashing of numeric types, see + :ref:`numeric-hash`. + + +---------------------+--------------------------------------------------+ + | attribute | explanation | + +=====================+==================================================+ + | :const:`width` | width in bits used for hash values | + +---------------------+--------------------------------------------------+ + | :const:`modulus` | prime modulus P used for numeric hash scheme | + +---------------------+--------------------------------------------------+ + | :const:`inf` | hash value returned for a positive infinity | + +---------------------+--------------------------------------------------+ + | :const:`nan` | hash value returned for a nan | + +---------------------+--------------------------------------------------+ + | :const:`imag` | multiplier used for the imaginary part of a | + | | complex number | + +---------------------+--------------------------------------------------+ + | :const:`algorithm` | name of the algorithm for hashing of str, bytes, | + | | and memoryview | + +---------------------+--------------------------------------------------+ + | :const:`hash_bits` | internal output size of the hash algorithm | + +---------------------+--------------------------------------------------+ + | :const:`seed_bits` | size of the seed key of the hash algorithm | + +---------------------+--------------------------------------------------+ + + + .. versionadded:: 3.2 + + .. versionchanged:: 3.4 + Added *algorithm*, *hash_bits* and *seed_bits* + + +.. data:: hexversion + + The version number encoded as a single integer. This is guaranteed to increase + with each version, including proper support for non-production releases. For + example, to test that the Python interpreter is at least version 1.5.2, use:: + + if sys.hexversion >= 0x010502F0: + # use some advanced feature + ... + else: + # use an alternative implementation or warn the user + ... + + This is called ``hexversion`` since it only really looks meaningful when viewed + as the result of passing it to the built-in :func:`hex` function. The + :term:`struct sequence` :data:`sys.version_info` may be used for a more + human-friendly encoding of the same information. + + More details of ``hexversion`` can be found at :ref:`apiabiversion`. + + +.. data:: implementation + + An object containing information about the implementation of the + currently running Python interpreter. The following attributes are + required to exist in all Python implementations. + + *name* is the implementation's identifier, e.g. ``'cpython'``. The actual + string is defined by the Python implementation, but it is guaranteed to be + lower case. + + *version* is a named tuple, in the same format as + :data:`sys.version_info`. It represents the version of the Python + *implementation*. This has a distinct meaning from the specific + version of the Python *language* to which the currently running + interpreter conforms, which ``sys.version_info`` represents. For + example, for PyPy 1.8 ``sys.implementation.version`` might be + ``sys.version_info(1, 8, 0, 'final', 0)``, whereas ``sys.version_info`` + would be ``sys.version_info(2, 7, 2, 'final', 0)``. For CPython they + are the same value, since it is the reference implementation. + + *hexversion* is the implementation version in hexadecimal format, like + :data:`sys.hexversion`. + + *cache_tag* is the tag used by the import machinery in the filenames of + cached modules. By convention, it would be a composite of the + implementation's name and version, like ``'cpython-33'``. However, a + Python implementation may use some other value if appropriate. If + ``cache_tag`` is set to ``None``, it indicates that module caching should + be disabled. + + :data:`sys.implementation` may contain additional attributes specific to + the Python implementation. These non-standard attributes must start with + an underscore, and are not described here. Regardless of its contents, + :data:`sys.implementation` will not change during a run of the interpreter, + nor between implementation versions. (It may change between Python + language versions, however.) See :pep:`421` for more information. + + .. versionadded:: 3.3 + + +.. data:: int_info + + A :term:`struct sequence` that holds information about Python's internal + representation of integers. The attributes are read only. + + .. tabularcolumns:: |l|L| + + +-------------------------+----------------------------------------------+ + | Attribute | Explanation | + +=========================+==============================================+ + | :const:`bits_per_digit` | number of bits held in each digit. Python | + | | integers are stored internally in base | + | | ``2**int_info.bits_per_digit`` | + +-------------------------+----------------------------------------------+ + | :const:`sizeof_digit` | size in bytes of the C type used to | + | | represent a digit | + +-------------------------+----------------------------------------------+ + + .. versionadded:: 3.1 + + +.. data:: __interactivehook__ + + When this attribute exists, its value is automatically called (with no + arguments) when the interpreter is launched in :ref:`interactive mode + `. This is done after the :envvar:`PYTHONSTARTUP` file is + read, so that you can set this hook there. The :mod:`site` module + :ref:`sets this `. + + .. versionadded:: 3.4 + + +.. function:: intern(string) + + Enter *string* in the table of "interned" strings and return the interned string + -- which is *string* itself or a copy. Interning strings is useful to gain a + little performance on dictionary lookup -- if the keys in a dictionary are + interned, and the lookup key is interned, the key comparisons (after hashing) + can be done by a pointer compare instead of a string compare. Normally, the + names used in Python programs are automatically interned, and the dictionaries + used to hold module, class or instance attributes have interned keys. + + Interned strings are not immortal; you must keep a reference to the return + value of :func:`intern` around to benefit from it. + + +.. function:: is_finalizing() + + Return :const:`True` if the Python interpreter is + :term:`shutting down `, :const:`False` otherwise. + + .. versionadded:: 3.5 + + +.. data:: last_type + last_value + last_traceback + + These three variables are not always defined; they are set when an exception is + not handled and the interpreter prints an error message and a stack traceback. + Their intended use is to allow an interactive user to import a debugger module + and engage in post-mortem debugging without having to re-execute the command + that caused the error. (Typical use is ``import pdb; pdb.pm()`` to enter the + post-mortem debugger; see :mod:`pdb` module for + more information.) + + The meaning of the variables is the same as that of the return values from + :func:`exc_info` above. + + +.. data:: maxsize + + An integer giving the maximum value a variable of type :c:type:`Py_ssize_t` can + take. It's usually ``2**31 - 1`` on a 32-bit platform and ``2**63 - 1`` on a + 64-bit platform. + + +.. data:: maxunicode + + An integer giving the value of the largest Unicode code point, + i.e. ``1114111`` (``0x10FFFF`` in hexadecimal). + + .. versionchanged:: 3.3 + Before :pep:`393`, ``sys.maxunicode`` used to be either ``0xFFFF`` + or ``0x10FFFF``, depending on the configuration option that specified + whether Unicode characters were stored as UCS-2 or UCS-4. + + +.. data:: meta_path + + A list of :term:`meta path finder` objects that have their + :meth:`~importlib.abc.MetaPathFinder.find_spec` methods called to see if one + of the objects can find the module to be imported. The + :meth:`~importlib.abc.MetaPathFinder.find_spec` method is called with at + least the absolute name of the module being imported. If the module to be + imported is contained in a package, then the parent package's :attr:`__path__` + attribute is passed in as a second argument. The method returns a + :term:`module spec`, or ``None`` if the module cannot be found. + + .. seealso:: + + :class:`importlib.abc.MetaPathFinder` + The abstract base class defining the interface of finder objects on + :data:`meta_path`. + :class:`importlib.machinery.ModuleSpec` + The concrete class which + :meth:`~importlib.abc.MetaPathFinder.find_spec` should return + instances of. + + .. versionchanged:: 3.4 + + :term:`Module specs ` were introduced in Python 3.4, by + :pep:`451`. Earlier versions of Python looked for a method called + :meth:`~importlib.abc.MetaPathFinder.find_module`. + This is still called as a fallback if a :data:`meta_path` entry doesn't + have a :meth:`~importlib.abc.MetaPathFinder.find_spec` method. + +.. data:: modules + + This is a dictionary that maps module names to modules which have already been + loaded. This can be manipulated to force reloading of modules and other tricks. + However, replacing the dictionary will not necessarily work as expected and + deleting essential items from the dictionary may cause Python to fail. + + +.. data:: path + + .. index:: triple: module; search; path + + A list of strings that specifies the search path for modules. Initialized from + the environment variable :envvar:`PYTHONPATH`, plus an installation-dependent + default. + + As initialized upon program startup, the first item of this list, ``path[0]``, + is the directory containing the script that was used to invoke the Python + interpreter. If the script directory is not available (e.g. if the interpreter + is invoked interactively or if the script is read from standard input), + ``path[0]`` is the empty string, which directs Python to search modules in the + current directory first. Notice that the script directory is inserted *before* + the entries inserted as a result of :envvar:`PYTHONPATH`. + + A program is free to modify this list for its own purposes. Only strings + and bytes should be added to :data:`sys.path`; all other data types are + ignored during import. + + + .. seealso:: + Module :mod:`site` This describes how to use .pth files to extend + :data:`sys.path`. + + +.. data:: path_hooks + + A list of callables that take a path argument to try to create a + :term:`finder` for the path. If a finder can be created, it is to be + returned by the callable, else raise :exc:`ImportError`. + + Originally specified in :pep:`302`. + + +.. data:: path_importer_cache + + A dictionary acting as a cache for :term:`finder` objects. The keys are + paths that have been passed to :data:`sys.path_hooks` and the values are + the finders that are found. If a path is a valid file system path but no + finder is found on :data:`sys.path_hooks` then ``None`` is + stored. + + Originally specified in :pep:`302`. + + .. versionchanged:: 3.3 + ``None`` is stored instead of :class:`imp.NullImporter` when no finder + is found. + + +.. data:: platform + + This string contains a platform identifier that can be used to append + platform-specific components to :data:`sys.path`, for instance. + + For Unix systems, except on Linux, this is the lowercased OS name as + returned by ``uname -s`` with the first part of the version as returned by + ``uname -r`` appended, e.g. ``'sunos5'`` or ``'freebsd8'``, *at the time + when Python was built*. Unless you want to test for a specific system + version, it is therefore recommended to use the following idiom:: + + if sys.platform.startswith('freebsd'): + # FreeBSD-specific code here... + elif sys.platform.startswith('linux'): + # Linux-specific code here... + + For other systems, the values are: + + ================ =========================== + System ``platform`` value + ================ =========================== + Linux ``'linux'`` + Windows ``'win32'`` + Windows/Cygwin ``'cygwin'`` + Mac OS X ``'darwin'`` + ================ =========================== + + .. versionchanged:: 3.3 + On Linux, :attr:`sys.platform` doesn't contain the major version anymore. + It is always ``'linux'``, instead of ``'linux2'`` or ``'linux3'``. Since + older Python versions include the version number, it is recommended to + always use the ``startswith`` idiom presented above. + + .. seealso:: + + :attr:`os.name` has a coarser granularity. :func:`os.uname` gives + system-dependent version information. + + The :mod:`platform` module provides detailed checks for the + system's identity. + + +.. data:: prefix + + A string giving the site-specific directory prefix where the platform + independent Python files are installed; by default, this is the string + ``'/usr/local'``. This can be set at build time with the ``--prefix`` + argument to the :program:`configure` script. The main collection of Python + library modules is installed in the directory :file:`{prefix}/lib/python{X.Y}` + while the platform independent header files (all except :file:`pyconfig.h`) are + stored in :file:`{prefix}/include/python{X.Y}`, where *X.Y* is the version + number of Python, for example ``3.2``. + + .. note:: If a :ref:`virtual environment ` is in effect, this + value will be changed in ``site.py`` to point to the virtual + environment. The value for the Python installation will still be + available, via :data:`base_prefix`. + + +.. data:: ps1 + ps2 + + .. index:: + single: interpreter prompts + single: prompts, interpreter + single: >>>; interpreter prompt + single: ...; interpreter prompt + + Strings specifying the primary and secondary prompt of the interpreter. These + are only defined if the interpreter is in interactive mode. Their initial + values in this case are ``'>>> '`` and ``'... '``. If a non-string object is + assigned to either variable, its :func:`str` is re-evaluated each time the + interpreter prepares to read a new interactive command; this can be used to + implement a dynamic prompt. + + +.. function:: setcheckinterval(interval) + + Set the interpreter's "check interval". This integer value determines how often + the interpreter checks for periodic things such as thread switches and signal + handlers. The default is ``100``, meaning the check is performed every 100 + Python virtual instructions. Setting it to a larger value may increase + performance for programs using threads. Setting it to a value ``<=`` 0 checks + every virtual instruction, maximizing responsiveness as well as overhead. + + .. deprecated:: 3.2 + This function doesn't have an effect anymore, as the internal logic for + thread switching and asynchronous tasks has been rewritten. Use + :func:`setswitchinterval` instead. + + +.. function:: setdlopenflags(n) + + Set the flags used by the interpreter for :c:func:`dlopen` calls, such as when + the interpreter loads extension modules. Among other things, this will enable a + lazy resolving of symbols when importing a module, if called as + ``sys.setdlopenflags(0)``. To share symbols across extension modules, call as + ``sys.setdlopenflags(os.RTLD_GLOBAL)``. Symbolic names for the flag values + can be found in the :mod:`os` module (``RTLD_xxx`` constants, e.g. + :data:`os.RTLD_LAZY`). + + .. availability:: Unix. + +.. function:: setprofile(profilefunc) + + .. index:: + single: profile function + single: profiler + + Set the system's profile function, which allows you to implement a Python source + code profiler in Python. See chapter :ref:`profile` for more information on the + Python profiler. The system's profile function is called similarly to the + system's trace function (see :func:`settrace`), but it is called with different events, + for example it isn't called for each executed line of code (only on call and return, + but the return event is reported even when an exception has been set). The function is + thread-specific, but there is no way for the profiler to know about context switches between + threads, so it does not make sense to use this in the presence of multiple threads. Also, + its return value is not used, so it can simply return ``None``. Error in the profile + function will cause itself unset. + + Profile functions should have three arguments: *frame*, *event*, and + *arg*. *frame* is the current stack frame. *event* is a string: ``'call'``, + ``'return'``, ``'c_call'``, ``'c_return'``, or ``'c_exception'``. *arg* depends + on the event type. + + The events have the following meaning: + + ``'call'`` + A function is called (or some other code block entered). The + profile function is called; *arg* is ``None``. + + ``'return'`` + A function (or other code block) is about to return. The profile + function is called; *arg* is the value that will be returned, or ``None`` + if the event is caused by an exception being raised. + + ``'c_call'`` + A C function is about to be called. This may be an extension function or + a built-in. *arg* is the C function object. + + ``'c_return'`` + A C function has returned. *arg* is the C function object. + + ``'c_exception'`` + A C function has raised an exception. *arg* is the C function object. + +.. function:: setrecursionlimit(limit) + + Set the maximum depth of the Python interpreter stack to *limit*. This limit + prevents infinite recursion from causing an overflow of the C stack and crashing + Python. + + The highest possible limit is platform-dependent. A user may need to set the + limit higher when they have a program that requires deep recursion and a platform + that supports a higher limit. This should be done with care, because a too-high + limit can lead to a crash. + + If the new limit is too low at the current recursion depth, a + :exc:`RecursionError` exception is raised. + + .. versionchanged:: 3.5.1 + A :exc:`RecursionError` exception is now raised if the new limit is too + low at the current recursion depth. + + +.. function:: setswitchinterval(interval) + + Set the interpreter's thread switch interval (in seconds). This floating-point + value determines the ideal duration of the "timeslices" allocated to + concurrently running Python threads. Please note that the actual value + can be higher, especially if long-running internal functions or methods + are used. Also, which thread becomes scheduled at the end of the interval + is the operating system's decision. The interpreter doesn't have its + own scheduler. + + .. versionadded:: 3.2 + + +.. function:: settrace(tracefunc) + + .. index:: + single: trace function + single: debugger + + Set the system's trace function, which allows you to implement a Python + source code debugger in Python. The function is thread-specific; for a + debugger to support multiple threads, it must register a trace function using + :func:`settrace` for each thread being debugged or use :func:`threading.settrace`. + + Trace functions should have three arguments: *frame*, *event*, and + *arg*. *frame* is the current stack frame. *event* is a string: ``'call'``, + ``'line'``, ``'return'``, ``'exception'`` or ``'opcode'``. *arg* depends on + the event type. + + The trace function is invoked (with *event* set to ``'call'``) whenever a new + local scope is entered; it should return a reference to a local trace + function to be used that scope, or ``None`` if the scope shouldn't be traced. + + The local trace function should return a reference to itself (or to another + function for further tracing in that scope), or ``None`` to turn off tracing + in that scope. + + If there is any error occurred in the trace function, it will be unset, just + like ``settrace(None)`` is called. + + The events have the following meaning: + + ``'call'`` + A function is called (or some other code block entered). The + global trace function is called; *arg* is ``None``; the return value + specifies the local trace function. + + ``'line'`` + The interpreter is about to execute a new line of code or re-execute the + condition of a loop. The local trace function is called; *arg* is + ``None``; the return value specifies the new local trace function. See + :file:`Objects/lnotab_notes.txt` for a detailed explanation of how this + works. + Per-line events may be disabled for a frame by setting + :attr:`f_trace_lines` to :const:`False` on that frame. + + ``'return'`` + A function (or other code block) is about to return. The local trace + function is called; *arg* is the value that will be returned, or ``None`` + if the event is caused by an exception being raised. The trace function's + return value is ignored. + + ``'exception'`` + An exception has occurred. The local trace function is called; *arg* is a + tuple ``(exception, value, traceback)``; the return value specifies the + new local trace function. + + ``'opcode'`` + The interpreter is about to execute a new opcode (see :mod:`dis` for + opcode details). The local trace function is called; *arg* is + ``None``; the return value specifies the new local trace function. + Per-opcode events are not emitted by default: they must be explicitly + requested by setting :attr:`f_trace_opcodes` to :const:`True` on the + frame. + + Note that as an exception is propagated down the chain of callers, an + ``'exception'`` event is generated at each level. + + For more information on code and frame objects, refer to :ref:`types`. + + .. impl-detail:: + + The :func:`settrace` function is intended only for implementing debuggers, + profilers, coverage tools and the like. Its behavior is part of the + implementation platform, rather than part of the language definition, and + thus may not be available in all Python implementations. + + .. versionchanged:: 3.7 + + ``'opcode'`` event type added; :attr:`f_trace_lines` and + :attr:`f_trace_opcodes` attributes added to frames + +.. function:: set_asyncgen_hooks(firstiter, finalizer) + + Accepts two optional keyword arguments which are callables that accept an + :term:`asynchronous generator iterator` as an argument. The *firstiter* + callable will be called when an asynchronous generator is iterated for the + first time. The *finalizer* will be called when an asynchronous generator + is about to be garbage collected. + + .. versionadded:: 3.6 + See :pep:`525` for more details, and for a reference example of a + *finalizer* method see the implementation of + ``asyncio.Loop.shutdown_asyncgens`` in + :source:`Lib/asyncio/base_events.py` + + .. note:: + This function has been added on a provisional basis (see :pep:`411` + for details.) + +.. function:: set_coroutine_origin_tracking_depth(depth) + + Allows enabling or disabling coroutine origin tracking. When + enabled, the ``cr_origin`` attribute on coroutine objects will + contain a tuple of (filename, line number, function name) tuples + describing the traceback where the coroutine object was created, + with the most recent call first. When disabled, ``cr_origin`` will + be None. + + To enable, pass a *depth* value greater than zero; this sets the + number of frames whose information will be captured. To disable, + pass set *depth* to zero. + + This setting is thread-specific. + + .. versionadded:: 3.7 + + .. note:: + This function has been added on a provisional basis (see :pep:`411` + for details.) Use it only for debugging purposes. + +.. function:: set_coroutine_wrapper(wrapper) + + Allows intercepting creation of :term:`coroutine` objects (only ones that + are created by an :keyword:`async def` function; generators decorated with + :func:`types.coroutine` or :func:`asyncio.coroutine` will not be + intercepted). + + The *wrapper* argument must be either: + + * a callable that accepts one argument (a coroutine object); + * ``None``, to reset the wrapper. + + If called twice, the new wrapper replaces the previous one. The function + is thread-specific. + + The *wrapper* callable cannot define new coroutines directly or indirectly:: + + def wrapper(coro): + async def wrap(coro): + return await coro + return wrap(coro) + sys.set_coroutine_wrapper(wrapper) + + async def foo(): + pass + + # The following line will fail with a RuntimeError, because + # ``wrapper`` creates a ``wrap(coro)`` coroutine: + foo() + + See also :func:`get_coroutine_wrapper`. + + .. versionadded:: 3.5 + See :pep:`492` for more details. + + .. note:: + This function has been added on a provisional basis (see :pep:`411` + for details.) Use it only for debugging purposes. + + .. deprecated:: 3.7 + The coroutine wrapper functionality has been deprecated, and + will be removed in 3.8. See :issue:`32591` for details. + +.. function:: _enablelegacywindowsfsencoding() + + Changes the default filesystem encoding and errors mode to 'mbcs' and + 'replace' respectively, for consistency with versions of Python prior to 3.6. + + This is equivalent to defining the :envvar:`PYTHONLEGACYWINDOWSFSENCODING` + environment variable before launching Python. + + .. availability:: Windows. + + .. versionadded:: 3.6 + See :pep:`529` for more details. + +.. data:: stdin + stdout + stderr + + :term:`File objects ` used by the interpreter for standard + input, output and errors: + + * ``stdin`` is used for all interactive input (including calls to + :func:`input`); + * ``stdout`` is used for the output of :func:`print` and :term:`expression` + statements and for the prompts of :func:`input`; + * The interpreter's own prompts and its error messages go to ``stderr``. + + These streams are regular :term:`text files ` like those + returned by the :func:`open` function. Their parameters are chosen as + follows: + + * The character encoding is platform-dependent. Non-Windows + platforms use the locale encoding (see + :meth:`locale.getpreferredencoding()`). + + On Windows, UTF-8 is used for the console device. Non-character + devices such as disk files and pipes use the system locale + encoding (i.e. the ANSI codepage). Non-console character + devices such as NUL (i.e. where isatty() returns True) use the + value of the console input and output codepages at startup, + respectively for stdin and stdout/stderr. This defaults to the + system locale encoding if the process is not initially attached + to a console. + + The special behaviour of the console can be overridden + by setting the environment variable PYTHONLEGACYWINDOWSSTDIO + before starting Python. In that case, the console codepages are + used as for any other character device. + + Under all platforms, you can override the character encoding by + setting the :envvar:`PYTHONIOENCODING` environment variable before + starting Python or by using the new :option:`-X` ``utf8`` command + line option and :envvar:`PYTHONUTF8` environment variable. However, + for the Windows console, this only applies when + :envvar:`PYTHONLEGACYWINDOWSSTDIO` is also set. + + * When interactive, ``stdout`` and ``stderr`` streams are line-buffered. + Otherwise, they are block-buffered like regular text files. You can + override this value with the :option:`-u` command-line option. + + .. note:: + + To write or read binary data from/to the standard streams, use the + underlying binary :data:`~io.TextIOBase.buffer` object. For example, to + write bytes to :data:`stdout`, use ``sys.stdout.buffer.write(b'abc')``. + + However, if you are writing a library (and do not control in which + context its code will be executed), be aware that the standard streams + may be replaced with file-like objects like :class:`io.StringIO` which + do not support the :attr:`~io.BufferedIOBase.buffer` attribute. + + +.. data:: __stdin__ + __stdout__ + __stderr__ + + These objects contain the original values of ``stdin``, ``stderr`` and + ``stdout`` at the start of the program. They are used during finalization, + and could be useful to print to the actual standard stream no matter if the + ``sys.std*`` object has been redirected. + + It can also be used to restore the actual files to known working file objects + in case they have been overwritten with a broken object. However, the + preferred way to do this is to explicitly save the previous stream before + replacing it, and restore the saved object. + + .. note:: + Under some conditions ``stdin``, ``stdout`` and ``stderr`` as well as the + original values ``__stdin__``, ``__stdout__`` and ``__stderr__`` can be + ``None``. It is usually the case for Windows GUI apps that aren't connected + to a console and Python apps started with :program:`pythonw`. + + +.. data:: thread_info + + A :term:`struct sequence` holding information about the thread + implementation. + + .. tabularcolumns:: |l|p{0.7\linewidth}| + + +------------------+---------------------------------------------------------+ + | Attribute | Explanation | + +==================+=========================================================+ + | :const:`name` | Name of the thread implementation: | + | | | + | | * ``'nt'``: Windows threads | + | | * ``'pthread'``: POSIX threads | + | | * ``'solaris'``: Solaris threads | + +------------------+---------------------------------------------------------+ + | :const:`lock` | Name of the lock implementation: | + | | | + | | * ``'semaphore'``: a lock uses a semaphore | + | | * ``'mutex+cond'``: a lock uses a mutex | + | | and a condition variable | + | | * ``None`` if this information is unknown | + +------------------+---------------------------------------------------------+ + | :const:`version` | Name and version of the thread library. It is a string, | + | | or ``None`` if this information is unknown. | + +------------------+---------------------------------------------------------+ + + .. versionadded:: 3.3 + + +.. data:: tracebacklimit + + When this variable is set to an integer value, it determines the maximum number + of levels of traceback information printed when an unhandled exception occurs. + The default is ``1000``. When set to ``0`` or less, all traceback information + is suppressed and only the exception type and value are printed. + + +.. data:: version + + A string containing the version number of the Python interpreter plus additional + information on the build number and compiler used. This string is displayed + when the interactive interpreter is started. Do not extract version information + out of it, rather, use :data:`version_info` and the functions provided by the + :mod:`platform` module. + + +.. data:: api_version + + The C API version for this interpreter. Programmers may find this useful when + debugging version conflicts between Python and extension modules. + + +.. data:: version_info + + A tuple containing the five components of the version number: *major*, *minor*, + *micro*, *releaselevel*, and *serial*. All values except *releaselevel* are + integers; the release level is ``'alpha'``, ``'beta'``, ``'candidate'``, or + ``'final'``. The ``version_info`` value corresponding to the Python version 2.0 + is ``(2, 0, 0, 'final', 0)``. The components can also be accessed by name, + so ``sys.version_info[0]`` is equivalent to ``sys.version_info.major`` + and so on. + + .. versionchanged:: 3.1 + Added named component attributes. + +.. data:: warnoptions + + This is an implementation detail of the warnings framework; do not modify this + value. Refer to the :mod:`warnings` module for more information on the warnings + framework. + + +.. data:: winver + + The version number used to form registry keys on Windows platforms. This is + stored as string resource 1000 in the Python DLL. The value is normally the + first three characters of :const:`version`. It is provided in the :mod:`sys` + module for informational purposes; modifying this value has no effect on the + registry keys used by Python. + + .. availability:: Windows. + + +.. data:: _xoptions + + A dictionary of the various implementation-specific flags passed through + the :option:`-X` command-line option. Option names are either mapped to + their values, if given explicitly, or to :const:`True`. Example: + + .. code-block:: shell-session + + $ ./python -Xa=b -Xc + Python 3.2a3+ (py3k, Oct 16 2010, 20:14:50) + [GCC 4.4.3] on linux2 + Type "help", "copyright", "credits" or "license" for more information. + >>> import sys + >>> sys._xoptions + {'a': 'b', 'c': True} + + .. impl-detail:: + + This is a CPython-specific way of accessing options passed through + :option:`-X`. Other implementations may export them through other + means, or not at all. + + .. versionadded:: 3.2 + + +.. rubric:: Citations + +.. [C99] ISO/IEC 9899:1999. "Programming languages -- C." A public draft of this standard is available at http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1256.pdf\ . diff --git a/python-3.7.4-docs-html/_sources/library/sysconfig.rst.txt b/python-3.7.4-docs-html/_sources/library/sysconfig.rst.txt new file mode 100644 index 0000000..b5a1da8 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/sysconfig.rst.txt @@ -0,0 +1,258 @@ +:mod:`sysconfig` --- Provide access to Python's configuration information +========================================================================= + +.. module:: sysconfig + :synopsis: Python's configuration information + +.. moduleauthor:: Tarek Ziadé +.. sectionauthor:: Tarek Ziadé + +.. versionadded:: 3.2 + +**Source code:** :source:`Lib/sysconfig.py` + +.. index:: + single: configuration information + +-------------- + +The :mod:`sysconfig` module provides access to Python's configuration +information like the list of installation paths and the configuration variables +relevant for the current platform. + +Configuration variables +----------------------- + +A Python distribution contains a :file:`Makefile` and a :file:`pyconfig.h` +header file that are necessary to build both the Python binary itself and +third-party C extensions compiled using :mod:`distutils`. + +:mod:`sysconfig` puts all variables found in these files in a dictionary that +can be accessed using :func:`get_config_vars` or :func:`get_config_var`. + +Notice that on Windows, it's a much smaller set. + +.. function:: get_config_vars(\*args) + + With no arguments, return a dictionary of all configuration variables + relevant for the current platform. + + With arguments, return a list of values that result from looking up each + argument in the configuration variable dictionary. + + For each argument, if the value is not found, return ``None``. + + +.. function:: get_config_var(name) + + Return the value of a single variable *name*. Equivalent to + ``get_config_vars().get(name)``. + + If *name* is not found, return ``None``. + +Example of usage:: + + >>> import sysconfig + >>> sysconfig.get_config_var('Py_ENABLE_SHARED') + 0 + >>> sysconfig.get_config_var('LIBDIR') + '/usr/local/lib' + >>> sysconfig.get_config_vars('AR', 'CXX') + ['ar', 'g++'] + + +Installation paths +------------------ + +Python uses an installation scheme that differs depending on the platform and on +the installation options. These schemes are stored in :mod:`sysconfig` under +unique identifiers based on the value returned by :const:`os.name`. + +Every new component that is installed using :mod:`distutils` or a +Distutils-based system will follow the same scheme to copy its file in the right +places. + +Python currently supports seven schemes: + +- *posix_prefix*: scheme for Posix platforms like Linux or Mac OS X. This is + the default scheme used when Python or a component is installed. +- *posix_home*: scheme for Posix platforms used when a *home* option is used + upon installation. This scheme is used when a component is installed through + Distutils with a specific home prefix. +- *posix_user*: scheme for Posix platforms used when a component is installed + through Distutils and the *user* option is used. This scheme defines paths + located under the user home directory. +- *nt*: scheme for NT platforms like Windows. +- *nt_user*: scheme for NT platforms, when the *user* option is used. + +Each scheme is itself composed of a series of paths and each path has a unique +identifier. Python currently uses eight paths: + +- *stdlib*: directory containing the standard Python library files that are not + platform-specific. +- *platstdlib*: directory containing the standard Python library files that are + platform-specific. +- *platlib*: directory for site-specific, platform-specific files. +- *purelib*: directory for site-specific, non-platform-specific files. +- *include*: directory for non-platform-specific header files. +- *platinclude*: directory for platform-specific header files. +- *scripts*: directory for script files. +- *data*: directory for data files. + +:mod:`sysconfig` provides some functions to determine these paths. + +.. function:: get_scheme_names() + + Return a tuple containing all schemes currently supported in + :mod:`sysconfig`. + + +.. function:: get_path_names() + + Return a tuple containing all path names currently supported in + :mod:`sysconfig`. + + +.. function:: get_path(name, [scheme, [vars, [expand]]]) + + Return an installation path corresponding to the path *name*, from the + install scheme named *scheme*. + + *name* has to be a value from the list returned by :func:`get_path_names`. + + :mod:`sysconfig` stores installation paths corresponding to each path name, + for each platform, with variables to be expanded. For instance the *stdlib* + path for the *nt* scheme is: ``{base}/Lib``. + + :func:`get_path` will use the variables returned by :func:`get_config_vars` + to expand the path. All variables have default values for each platform so + one may call this function and get the default value. + + If *scheme* is provided, it must be a value from the list returned by + :func:`get_scheme_names`. Otherwise, the default scheme for the current + platform is used. + + If *vars* is provided, it must be a dictionary of variables that will update + the dictionary return by :func:`get_config_vars`. + + If *expand* is set to ``False``, the path will not be expanded using the + variables. + + If *name* is not found, return ``None``. + + +.. function:: get_paths([scheme, [vars, [expand]]]) + + Return a dictionary containing all installation paths corresponding to an + installation scheme. See :func:`get_path` for more information. + + If *scheme* is not provided, will use the default scheme for the current + platform. + + If *vars* is provided, it must be a dictionary of variables that will + update the dictionary used to expand the paths. + + If *expand* is set to false, the paths will not be expanded. + + If *scheme* is not an existing scheme, :func:`get_paths` will raise a + :exc:`KeyError`. + + +Other functions +--------------- + +.. function:: get_python_version() + + Return the ``MAJOR.MINOR`` Python version number as a string. Similar to + ``'%d.%d' % sys.version_info[:2]``. + + +.. function:: get_platform() + + Return a string that identifies the current platform. + + This is used mainly to distinguish platform-specific build directories and + platform-specific built distributions. Typically includes the OS name and + version and the architecture (as supplied by 'os.uname()'), although the + exact information included depends on the OS; e.g., on Linux, the kernel + version isn't particularly important. + + Examples of returned values: + + - linux-i586 + - linux-alpha (?) + - solaris-2.6-sun4u + + Windows will return one of: + + - win-amd64 (64bit Windows on AMD64, aka x86_64, Intel64, and EM64T) + - win32 (all others - specifically, sys.platform is returned) + + Mac OS X can return: + + - macosx-10.6-ppc + - macosx-10.4-ppc64 + - macosx-10.3-i386 + - macosx-10.4-fat + + For other non-POSIX platforms, currently just returns :data:`sys.platform`. + + +.. function:: is_python_build() + + Return ``True`` if the running Python interpreter was built from source and + is being run from its built location, and not from a location resulting from + e.g. running ``make install`` or installing via a binary installer. + + +.. function:: parse_config_h(fp[, vars]) + + Parse a :file:`config.h`\-style file. + + *fp* is a file-like object pointing to the :file:`config.h`\-like file. + + A dictionary containing name/value pairs is returned. If an optional + dictionary is passed in as the second argument, it is used instead of a new + dictionary, and updated with the values read in the file. + + +.. function:: get_config_h_filename() + + Return the path of :file:`pyconfig.h`. + +.. function:: get_makefile_filename() + + Return the path of :file:`Makefile`. + +Using :mod:`sysconfig` as a script +---------------------------------- + +You can use :mod:`sysconfig` as a script with Python's *-m* option: + +.. code-block:: shell-session + + $ python -m sysconfig + Platform: "macosx-10.4-i386" + Python version: "3.2" + Current installation scheme: "posix_prefix" + + Paths: + data = "/usr/local" + include = "/Users/tarek/Dev/svn.python.org/py3k/Include" + platinclude = "." + platlib = "/usr/local/lib/python3.2/site-packages" + platstdlib = "/usr/local/lib/python3.2" + purelib = "/usr/local/lib/python3.2/site-packages" + scripts = "/usr/local/bin" + stdlib = "/usr/local/lib/python3.2" + + Variables: + AC_APPLE_UNIVERSAL_BUILD = "0" + AIX_GENUINE_CPLUSPLUS = "0" + AR = "ar" + ARFLAGS = "rc" + ... + +This call will print in the standard output the information returned by +:func:`get_platform`, :func:`get_python_version`, :func:`get_path` and +:func:`get_config_vars`. diff --git a/python-3.7.4-docs-html/_sources/library/syslog.rst.txt b/python-3.7.4-docs-html/_sources/library/syslog.rst.txt new file mode 100644 index 0000000..7151527 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/syslog.rst.txt @@ -0,0 +1,112 @@ +:mod:`syslog` --- Unix syslog library routines +============================================== + +.. module:: syslog + :platform: Unix + :synopsis: An interface to the Unix syslog library routines. + +-------------- + +This module provides an interface to the Unix ``syslog`` library routines. +Refer to the Unix manual pages for a detailed description of the ``syslog`` +facility. + +This module wraps the system ``syslog`` family of routines. A pure Python +library that can speak to a syslog server is available in the +:mod:`logging.handlers` module as :class:`SysLogHandler`. + +The module defines the following functions: + + +.. function:: syslog(message) + syslog(priority, message) + + Send the string *message* to the system logger. A trailing newline is added + if necessary. Each message is tagged with a priority composed of a + *facility* and a *level*. The optional *priority* argument, which defaults + to :const:`LOG_INFO`, determines the message priority. If the facility is + not encoded in *priority* using logical-or (``LOG_INFO | LOG_USER``), the + value given in the :func:`openlog` call is used. + + If :func:`openlog` has not been called prior to the call to :func:`syslog`, + ``openlog()`` will be called with no arguments. + + +.. function:: openlog([ident[, logoption[, facility]]]) + + Logging options of subsequent :func:`syslog` calls can be set by calling + :func:`openlog`. :func:`syslog` will call :func:`openlog` with no arguments + if the log is not currently open. + + The optional *ident* keyword argument is a string which is prepended to every + message, and defaults to ``sys.argv[0]`` with leading path components + stripped. The optional *logoption* keyword argument (default is 0) is a bit + field -- see below for possible values to combine. The optional *facility* + keyword argument (default is :const:`LOG_USER`) sets the default facility for + messages which do not have a facility explicitly encoded. + + .. versionchanged:: 3.2 + In previous versions, keyword arguments were not allowed, and *ident* was + required. The default for *ident* was dependent on the system libraries, + and often was ``python`` instead of the name of the Python program file. + + +.. function:: closelog() + + Reset the syslog module values and call the system library ``closelog()``. + + This causes the module to behave as it does when initially imported. For + example, :func:`openlog` will be called on the first :func:`syslog` call (if + :func:`openlog` hasn't already been called), and *ident* and other + :func:`openlog` parameters are reset to defaults. + + +.. function:: setlogmask(maskpri) + + Set the priority mask to *maskpri* and return the previous mask value. Calls + to :func:`syslog` with a priority level not set in *maskpri* are ignored. + The default is to log all priorities. The function ``LOG_MASK(pri)`` + calculates the mask for the individual priority *pri*. The function + ``LOG_UPTO(pri)`` calculates the mask for all priorities up to and including + *pri*. + +The module defines the following constants: + +Priority levels (high to low): + :const:`LOG_EMERG`, :const:`LOG_ALERT`, :const:`LOG_CRIT`, :const:`LOG_ERR`, + :const:`LOG_WARNING`, :const:`LOG_NOTICE`, :const:`LOG_INFO`, + :const:`LOG_DEBUG`. + +Facilities: + :const:`LOG_KERN`, :const:`LOG_USER`, :const:`LOG_MAIL`, :const:`LOG_DAEMON`, + :const:`LOG_AUTH`, :const:`LOG_LPR`, :const:`LOG_NEWS`, :const:`LOG_UUCP`, + :const:`LOG_CRON`, :const:`LOG_SYSLOG`, :const:`LOG_LOCAL0` to + :const:`LOG_LOCAL7`, and, if defined in ````, + :const:`LOG_AUTHPRIV`. + +Log options: + :const:`LOG_PID`, :const:`LOG_CONS`, :const:`LOG_NDELAY`, and, if defined + in ````, :const:`LOG_ODELAY`, :const:`LOG_NOWAIT`, and + :const:`LOG_PERROR`. + + +Examples +-------- + +Simple example +~~~~~~~~~~~~~~ + +A simple set of examples:: + + import syslog + + syslog.syslog('Processing started') + if error: + syslog.syslog(syslog.LOG_ERR, 'Processing started') + +An example of setting some log options, these would include the process ID in +logged messages, and write the messages to the destination facility used for +mail logging:: + + syslog.openlog(logoption=syslog.LOG_PID, facility=syslog.LOG_MAIL) + syslog.syslog('E-mail processing initiated...') diff --git a/python-3.7.4-docs-html/_sources/library/tabnanny.rst.txt b/python-3.7.4-docs-html/_sources/library/tabnanny.rst.txt new file mode 100644 index 0000000..dfe688a --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/tabnanny.rst.txt @@ -0,0 +1,67 @@ +:mod:`tabnanny` --- Detection of ambiguous indentation +====================================================== + +.. module:: tabnanny + :synopsis: Tool for detecting white space related problems in Python + source files in a directory tree. + +.. moduleauthor:: Tim Peters +.. sectionauthor:: Peter Funk + +.. rudimentary documentation based on module comments + +**Source code:** :source:`Lib/tabnanny.py` + +-------------- + +For the time being this module is intended to be called as a script. However it +is possible to import it into an IDE and use the function :func:`check` +described below. + +.. note:: + + The API provided by this module is likely to change in future releases; such + changes may not be backward compatible. + + +.. function:: check(file_or_dir) + + If *file_or_dir* is a directory and not a symbolic link, then recursively + descend the directory tree named by *file_or_dir*, checking all :file:`.py` + files along the way. If *file_or_dir* is an ordinary Python source file, it + is checked for whitespace related problems. The diagnostic messages are + written to standard output using the :func:`print` function. + + +.. data:: verbose + + Flag indicating whether to print verbose messages. This is incremented by the + ``-v`` option if called as a script. + + +.. data:: filename_only + + Flag indicating whether to print only the filenames of files containing + whitespace related problems. This is set to true by the ``-q`` option if called + as a script. + + +.. exception:: NannyNag + + Raised by :func:`process_tokens` if detecting an ambiguous indent. Captured and + handled in :func:`check`. + + +.. function:: process_tokens(tokens) + + This function is used by :func:`check` to process tokens generated by the + :mod:`tokenize` module. + +.. XXX document errprint, format_witnesses, Whitespace, check_equal, indents, + reset_globals + + +.. seealso:: + + Module :mod:`tokenize` + Lexical scanner for Python source code. diff --git a/python-3.7.4-docs-html/_sources/library/tarfile.rst.txt b/python-3.7.4-docs-html/_sources/library/tarfile.rst.txt new file mode 100644 index 0000000..9cd0715 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/tarfile.rst.txt @@ -0,0 +1,877 @@ +:mod:`tarfile` --- Read and write tar archive files +=================================================== + +.. module:: tarfile + :synopsis: Read and write tar-format archive files. + +.. moduleauthor:: Lars Gustäbel +.. sectionauthor:: Lars Gustäbel + +**Source code:** :source:`Lib/tarfile.py` + +-------------- + +The :mod:`tarfile` module makes it possible to read and write tar +archives, including those using gzip, bz2 and lzma compression. +Use the :mod:`zipfile` module to read or write :file:`.zip` files, or the +higher-level functions in :ref:`shutil `. + +Some facts and figures: + +* reads and writes :mod:`gzip`, :mod:`bz2` and :mod:`lzma` compressed archives + if the respective modules are available. + +* read/write support for the POSIX.1-1988 (ustar) format. + +* read/write support for the GNU tar format including *longname* and *longlink* + extensions, read-only support for all variants of the *sparse* extension + including restoration of sparse files. + +* read/write support for the POSIX.1-2001 (pax) format. + +* handles directories, regular files, hardlinks, symbolic links, fifos, + character devices and block devices and is able to acquire and restore file + information like timestamp, access permissions and owner. + +.. versionchanged:: 3.3 + Added support for :mod:`lzma` compression. + + +.. function:: open(name=None, mode='r', fileobj=None, bufsize=10240, \*\*kwargs) + + Return a :class:`TarFile` object for the pathname *name*. For detailed + information on :class:`TarFile` objects and the keyword arguments that are + allowed, see :ref:`tarfile-objects`. + + *mode* has to be a string of the form ``'filemode[:compression]'``, it defaults + to ``'r'``. Here is a full list of mode combinations: + + +------------------+---------------------------------------------+ + | mode | action | + +==================+=============================================+ + | ``'r' or 'r:*'`` | Open for reading with transparent | + | | compression (recommended). | + +------------------+---------------------------------------------+ + | ``'r:'`` | Open for reading exclusively without | + | | compression. | + +------------------+---------------------------------------------+ + | ``'r:gz'`` | Open for reading with gzip compression. | + +------------------+---------------------------------------------+ + | ``'r:bz2'`` | Open for reading with bzip2 compression. | + +------------------+---------------------------------------------+ + | ``'r:xz'`` | Open for reading with lzma compression. | + +------------------+---------------------------------------------+ + | ``'x'`` or | Create a tarfile exclusively without | + | ``'x:'`` | compression. | + | | Raise an :exc:`FileExistsError` exception | + | | if it already exists. | + +------------------+---------------------------------------------+ + | ``'x:gz'`` | Create a tarfile with gzip compression. | + | | Raise an :exc:`FileExistsError` exception | + | | if it already exists. | + +------------------+---------------------------------------------+ + | ``'x:bz2'`` | Create a tarfile with bzip2 compression. | + | | Raise an :exc:`FileExistsError` exception | + | | if it already exists. | + +------------------+---------------------------------------------+ + | ``'x:xz'`` | Create a tarfile with lzma compression. | + | | Raise an :exc:`FileExistsError` exception | + | | if it already exists. | + +------------------+---------------------------------------------+ + | ``'a' or 'a:'`` | Open for appending with no compression. The | + | | file is created if it does not exist. | + +------------------+---------------------------------------------+ + | ``'w' or 'w:'`` | Open for uncompressed writing. | + +------------------+---------------------------------------------+ + | ``'w:gz'`` | Open for gzip compressed writing. | + +------------------+---------------------------------------------+ + | ``'w:bz2'`` | Open for bzip2 compressed writing. | + +------------------+---------------------------------------------+ + | ``'w:xz'`` | Open for lzma compressed writing. | + +------------------+---------------------------------------------+ + + Note that ``'a:gz'``, ``'a:bz2'`` or ``'a:xz'`` is not possible. If *mode* + is not suitable to open a certain (compressed) file for reading, + :exc:`ReadError` is raised. Use *mode* ``'r'`` to avoid this. If a + compression method is not supported, :exc:`CompressionError` is raised. + + If *fileobj* is specified, it is used as an alternative to a :term:`file object` + opened in binary mode for *name*. It is supposed to be at position 0. + + For modes ``'w:gz'``, ``'r:gz'``, ``'w:bz2'``, ``'r:bz2'``, ``'x:gz'``, + ``'x:bz2'``, :func:`tarfile.open` accepts the keyword argument + *compresslevel* (default ``9``) to specify the compression level of the file. + + For special purposes, there is a second format for *mode*: + ``'filemode|[compression]'``. :func:`tarfile.open` will return a :class:`TarFile` + object that processes its data as a stream of blocks. No random seeking will + be done on the file. If given, *fileobj* may be any object that has a + :meth:`read` or :meth:`write` method (depending on the *mode*). *bufsize* + specifies the blocksize and defaults to ``20 * 512`` bytes. Use this variant + in combination with e.g. ``sys.stdin``, a socket :term:`file object` or a tape + device. However, such a :class:`TarFile` object is limited in that it does + not allow random access, see :ref:`tar-examples`. The currently + possible modes: + + +-------------+--------------------------------------------+ + | Mode | Action | + +=============+============================================+ + | ``'r|*'`` | Open a *stream* of tar blocks for reading | + | | with transparent compression. | + +-------------+--------------------------------------------+ + | ``'r|'`` | Open a *stream* of uncompressed tar blocks | + | | for reading. | + +-------------+--------------------------------------------+ + | ``'r|gz'`` | Open a gzip compressed *stream* for | + | | reading. | + +-------------+--------------------------------------------+ + | ``'r|bz2'`` | Open a bzip2 compressed *stream* for | + | | reading. | + +-------------+--------------------------------------------+ + | ``'r|xz'`` | Open an lzma compressed *stream* for | + | | reading. | + +-------------+--------------------------------------------+ + | ``'w|'`` | Open an uncompressed *stream* for writing. | + +-------------+--------------------------------------------+ + | ``'w|gz'`` | Open a gzip compressed *stream* for | + | | writing. | + +-------------+--------------------------------------------+ + | ``'w|bz2'`` | Open a bzip2 compressed *stream* for | + | | writing. | + +-------------+--------------------------------------------+ + | ``'w|xz'`` | Open an lzma compressed *stream* for | + | | writing. | + +-------------+--------------------------------------------+ + + .. versionchanged:: 3.5 + The ``'x'`` (exclusive creation) mode was added. + + .. versionchanged:: 3.6 + The *name* parameter accepts a :term:`path-like object`. + + +.. class:: TarFile + + Class for reading and writing tar archives. Do not use this class directly: + use :func:`tarfile.open` instead. See :ref:`tarfile-objects`. + + +.. function:: is_tarfile(name) + + Return :const:`True` if *name* is a tar archive file, that the :mod:`tarfile` + module can read. + + +The :mod:`tarfile` module defines the following exceptions: + + +.. exception:: TarError + + Base class for all :mod:`tarfile` exceptions. + + +.. exception:: ReadError + + Is raised when a tar archive is opened, that either cannot be handled by the + :mod:`tarfile` module or is somehow invalid. + + +.. exception:: CompressionError + + Is raised when a compression method is not supported or when the data cannot be + decoded properly. + + +.. exception:: StreamError + + Is raised for the limitations that are typical for stream-like :class:`TarFile` + objects. + + +.. exception:: ExtractError + + Is raised for *non-fatal* errors when using :meth:`TarFile.extract`, but only if + :attr:`TarFile.errorlevel`\ ``== 2``. + + +.. exception:: HeaderError + + Is raised by :meth:`TarInfo.frombuf` if the buffer it gets is invalid. + + +The following constants are available at the module level: + +.. data:: ENCODING + + The default character encoding: ``'utf-8'`` on Windows, the value returned by + :func:`sys.getfilesystemencoding` otherwise. + + +Each of the following constants defines a tar archive format that the +:mod:`tarfile` module is able to create. See section :ref:`tar-formats` for +details. + + +.. data:: USTAR_FORMAT + + POSIX.1-1988 (ustar) format. + + +.. data:: GNU_FORMAT + + GNU tar format. + + +.. data:: PAX_FORMAT + + POSIX.1-2001 (pax) format. + + +.. data:: DEFAULT_FORMAT + + The default format for creating archives. This is currently :const:`GNU_FORMAT`. + + +.. seealso:: + + Module :mod:`zipfile` + Documentation of the :mod:`zipfile` standard module. + + :ref:`archiving-operations` + Documentation of the higher-level archiving facilities provided by the + standard :mod:`shutil` module. + + `GNU tar manual, Basic Tar Format `_ + Documentation for tar archive files, including GNU tar extensions. + + +.. _tarfile-objects: + +TarFile Objects +--------------- + +The :class:`TarFile` object provides an interface to a tar archive. A tar +archive is a sequence of blocks. An archive member (a stored file) is made up of +a header block followed by data blocks. It is possible to store a file in a tar +archive several times. Each archive member is represented by a :class:`TarInfo` +object, see :ref:`tarinfo-objects` for details. + +A :class:`TarFile` object can be used as a context manager in a :keyword:`with` +statement. It will automatically be closed when the block is completed. Please +note that in the event of an exception an archive opened for writing will not +be finalized; only the internally used file object will be closed. See the +:ref:`tar-examples` section for a use case. + +.. versionadded:: 3.2 + Added support for the context management protocol. + +.. class:: TarFile(name=None, mode='r', fileobj=None, format=DEFAULT_FORMAT, tarinfo=TarInfo, dereference=False, ignore_zeros=False, encoding=ENCODING, errors='surrogateescape', pax_headers=None, debug=0, errorlevel=0) + + All following arguments are optional and can be accessed as instance attributes + as well. + + *name* is the pathname of the archive. *name* may be a :term:`path-like object`. + It can be omitted if *fileobj* is given. + In this case, the file object's :attr:`name` attribute is used if it exists. + + *mode* is either ``'r'`` to read from an existing archive, ``'a'`` to append + data to an existing file, ``'w'`` to create a new file overwriting an existing + one, or ``'x'`` to create a new file only if it does not already exist. + + If *fileobj* is given, it is used for reading or writing data. If it can be + determined, *mode* is overridden by *fileobj*'s mode. *fileobj* will be used + from position 0. + + .. note:: + + *fileobj* is not closed, when :class:`TarFile` is closed. + + *format* controls the archive format. It must be one of the constants + :const:`USTAR_FORMAT`, :const:`GNU_FORMAT` or :const:`PAX_FORMAT` that are + defined at module level. + + The *tarinfo* argument can be used to replace the default :class:`TarInfo` class + with a different one. + + If *dereference* is :const:`False`, add symbolic and hard links to the archive. If it + is :const:`True`, add the content of the target files to the archive. This has no + effect on systems that do not support symbolic links. + + If *ignore_zeros* is :const:`False`, treat an empty block as the end of the archive. + If it is :const:`True`, skip empty (and invalid) blocks and try to get as many members + as possible. This is only useful for reading concatenated or damaged archives. + + *debug* can be set from ``0`` (no debug messages) up to ``3`` (all debug + messages). The messages are written to ``sys.stderr``. + + If *errorlevel* is ``0``, all errors are ignored when using :meth:`TarFile.extract`. + Nevertheless, they appear as error messages in the debug output, when debugging + is enabled. If ``1``, all *fatal* errors are raised as :exc:`OSError` + exceptions. If ``2``, all *non-fatal* errors are raised as :exc:`TarError` + exceptions as well. + + The *encoding* and *errors* arguments define the character encoding to be + used for reading or writing the archive and how conversion errors are going + to be handled. The default settings will work for most users. + See section :ref:`tar-unicode` for in-depth information. + + The *pax_headers* argument is an optional dictionary of strings which + will be added as a pax global header if *format* is :const:`PAX_FORMAT`. + + .. versionchanged:: 3.2 + Use ``'surrogateescape'`` as the default for the *errors* argument. + + .. versionchanged:: 3.5 + The ``'x'`` (exclusive creation) mode was added. + + .. versionchanged:: 3.6 + The *name* parameter accepts a :term:`path-like object`. + + +.. classmethod:: TarFile.open(...) + + Alternative constructor. The :func:`tarfile.open` function is actually a + shortcut to this classmethod. + + +.. method:: TarFile.getmember(name) + + Return a :class:`TarInfo` object for member *name*. If *name* can not be found + in the archive, :exc:`KeyError` is raised. + + .. note:: + + If a member occurs more than once in the archive, its last occurrence is assumed + to be the most up-to-date version. + + +.. method:: TarFile.getmembers() + + Return the members of the archive as a list of :class:`TarInfo` objects. The + list has the same order as the members in the archive. + + +.. method:: TarFile.getnames() + + Return the members as a list of their names. It has the same order as the list + returned by :meth:`getmembers`. + + +.. method:: TarFile.list(verbose=True, *, members=None) + + Print a table of contents to ``sys.stdout``. If *verbose* is :const:`False`, + only the names of the members are printed. If it is :const:`True`, output + similar to that of :program:`ls -l` is produced. If optional *members* is + given, it must be a subset of the list returned by :meth:`getmembers`. + + .. versionchanged:: 3.5 + Added the *members* parameter. + + +.. method:: TarFile.next() + + Return the next member of the archive as a :class:`TarInfo` object, when + :class:`TarFile` is opened for reading. Return :const:`None` if there is no more + available. + + +.. method:: TarFile.extractall(path=".", members=None, *, numeric_owner=False) + + Extract all members from the archive to the current working directory or + directory *path*. If optional *members* is given, it must be a subset of the + list returned by :meth:`getmembers`. Directory information like owner, + modification time and permissions are set after all members have been extracted. + This is done to work around two problems: A directory's modification time is + reset each time a file is created in it. And, if a directory's permissions do + not allow writing, extracting files to it will fail. + + If *numeric_owner* is :const:`True`, the uid and gid numbers from the tarfile + are used to set the owner/group for the extracted files. Otherwise, the named + values from the tarfile are used. + + .. warning:: + + Never extract archives from untrusted sources without prior inspection. + It is possible that files are created outside of *path*, e.g. members + that have absolute filenames starting with ``"/"`` or filenames with two + dots ``".."``. + + .. versionchanged:: 3.5 + Added the *numeric_owner* parameter. + + .. versionchanged:: 3.6 + The *path* parameter accepts a :term:`path-like object`. + + +.. method:: TarFile.extract(member, path="", set_attrs=True, *, numeric_owner=False) + + Extract a member from the archive to the current working directory, using its + full name. Its file information is extracted as accurately as possible. *member* + may be a filename or a :class:`TarInfo` object. You can specify a different + directory using *path*. *path* may be a :term:`path-like object`. + File attributes (owner, mtime, mode) are set unless *set_attrs* is false. + + If *numeric_owner* is :const:`True`, the uid and gid numbers from the tarfile + are used to set the owner/group for the extracted files. Otherwise, the named + values from the tarfile are used. + + .. note:: + + The :meth:`extract` method does not take care of several extraction issues. + In most cases you should consider using the :meth:`extractall` method. + + .. warning:: + + See the warning for :meth:`extractall`. + + .. versionchanged:: 3.2 + Added the *set_attrs* parameter. + + .. versionchanged:: 3.5 + Added the *numeric_owner* parameter. + + .. versionchanged:: 3.6 + The *path* parameter accepts a :term:`path-like object`. + + +.. method:: TarFile.extractfile(member) + + Extract a member from the archive as a file object. *member* may be a filename + or a :class:`TarInfo` object. If *member* is a regular file or a link, an + :class:`io.BufferedReader` object is returned. Otherwise, :const:`None` is + returned. + + .. versionchanged:: 3.3 + Return an :class:`io.BufferedReader` object. + + +.. method:: TarFile.add(name, arcname=None, recursive=True, *, filter=None) + + Add the file *name* to the archive. *name* may be any type of file + (directory, fifo, symbolic link, etc.). If given, *arcname* specifies an + alternative name for the file in the archive. Directories are added + recursively by default. This can be avoided by setting *recursive* to + :const:`False`. Recursion adds entries in sorted order. + If *filter* is given, it + should be a function that takes a :class:`TarInfo` object argument and + returns the changed :class:`TarInfo` object. If it instead returns + :const:`None` the :class:`TarInfo` object will be excluded from the + archive. See :ref:`tar-examples` for an example. + + .. versionchanged:: 3.2 + Added the *filter* parameter. + + .. versionchanged:: 3.7 + Recursion adds entries in sorted order. + + +.. method:: TarFile.addfile(tarinfo, fileobj=None) + + Add the :class:`TarInfo` object *tarinfo* to the archive. If *fileobj* is given, + it should be a :term:`binary file`, and + ``tarinfo.size`` bytes are read from it and added to the archive. You can + create :class:`TarInfo` objects directly, or by using :meth:`gettarinfo`. + + +.. method:: TarFile.gettarinfo(name=None, arcname=None, fileobj=None) + + Create a :class:`TarInfo` object from the result of :func:`os.stat` or + equivalent on an existing file. The file is either named by *name*, or + specified as a :term:`file object` *fileobj* with a file descriptor. + *name* may be a :term:`path-like object`. If + given, *arcname* specifies an alternative name for the file in the + archive, otherwise, the name is taken from *fileobj*’s + :attr:`~io.FileIO.name` attribute, or the *name* argument. The name + should be a text string. + + You can modify + some of the :class:`TarInfo`’s attributes before you add it using :meth:`addfile`. + If the file object is not an ordinary file object positioned at the + beginning of the file, attributes such as :attr:`~TarInfo.size` may need + modifying. This is the case for objects such as :class:`~gzip.GzipFile`. + The :attr:`~TarInfo.name` may also be modified, in which case *arcname* + could be a dummy string. + + .. versionchanged:: 3.6 + The *name* parameter accepts a :term:`path-like object`. + + +.. method:: TarFile.close() + + Close the :class:`TarFile`. In write mode, two finishing zero blocks are + appended to the archive. + + +.. attribute:: TarFile.pax_headers + + A dictionary containing key-value pairs of pax global headers. + + + +.. _tarinfo-objects: + +TarInfo Objects +--------------- + +A :class:`TarInfo` object represents one member in a :class:`TarFile`. Aside +from storing all required attributes of a file (like file type, size, time, +permissions, owner etc.), it provides some useful methods to determine its type. +It does *not* contain the file's data itself. + +:class:`TarInfo` objects are returned by :class:`TarFile`'s methods +:meth:`getmember`, :meth:`getmembers` and :meth:`gettarinfo`. + + +.. class:: TarInfo(name="") + + Create a :class:`TarInfo` object. + + +.. classmethod:: TarInfo.frombuf(buf, encoding, errors) + + Create and return a :class:`TarInfo` object from string buffer *buf*. + + Raises :exc:`HeaderError` if the buffer is invalid. + + +.. classmethod:: TarInfo.fromtarfile(tarfile) + + Read the next member from the :class:`TarFile` object *tarfile* and return it as + a :class:`TarInfo` object. + + +.. method:: TarInfo.tobuf(format=DEFAULT_FORMAT, encoding=ENCODING, errors='surrogateescape') + + Create a string buffer from a :class:`TarInfo` object. For information on the + arguments see the constructor of the :class:`TarFile` class. + + .. versionchanged:: 3.2 + Use ``'surrogateescape'`` as the default for the *errors* argument. + + +A ``TarInfo`` object has the following public data attributes: + + +.. attribute:: TarInfo.name + + Name of the archive member. + + +.. attribute:: TarInfo.size + + Size in bytes. + + +.. attribute:: TarInfo.mtime + + Time of last modification. + + +.. attribute:: TarInfo.mode + + Permission bits. + + +.. attribute:: TarInfo.type + + File type. *type* is usually one of these constants: :const:`REGTYPE`, + :const:`AREGTYPE`, :const:`LNKTYPE`, :const:`SYMTYPE`, :const:`DIRTYPE`, + :const:`FIFOTYPE`, :const:`CONTTYPE`, :const:`CHRTYPE`, :const:`BLKTYPE`, + :const:`GNUTYPE_SPARSE`. To determine the type of a :class:`TarInfo` object + more conveniently, use the ``is*()`` methods below. + + +.. attribute:: TarInfo.linkname + + Name of the target file name, which is only present in :class:`TarInfo` objects + of type :const:`LNKTYPE` and :const:`SYMTYPE`. + + +.. attribute:: TarInfo.uid + + User ID of the user who originally stored this member. + + +.. attribute:: TarInfo.gid + + Group ID of the user who originally stored this member. + + +.. attribute:: TarInfo.uname + + User name. + + +.. attribute:: TarInfo.gname + + Group name. + + +.. attribute:: TarInfo.pax_headers + + A dictionary containing key-value pairs of an associated pax extended header. + + +A :class:`TarInfo` object also provides some convenient query methods: + + +.. method:: TarInfo.isfile() + + Return :const:`True` if the :class:`Tarinfo` object is a regular file. + + +.. method:: TarInfo.isreg() + + Same as :meth:`isfile`. + + +.. method:: TarInfo.isdir() + + Return :const:`True` if it is a directory. + + +.. method:: TarInfo.issym() + + Return :const:`True` if it is a symbolic link. + + +.. method:: TarInfo.islnk() + + Return :const:`True` if it is a hard link. + + +.. method:: TarInfo.ischr() + + Return :const:`True` if it is a character device. + + +.. method:: TarInfo.isblk() + + Return :const:`True` if it is a block device. + + +.. method:: TarInfo.isfifo() + + Return :const:`True` if it is a FIFO. + + +.. method:: TarInfo.isdev() + + Return :const:`True` if it is one of character device, block device or FIFO. + + +.. _tarfile-commandline: +.. program:: tarfile + +Command-Line Interface +---------------------- + +.. versionadded:: 3.4 + +The :mod:`tarfile` module provides a simple command-line interface to interact +with tar archives. + +If you want to create a new tar archive, specify its name after the :option:`-c` +option and then list the filename(s) that should be included: + +.. code-block:: shell-session + + $ python -m tarfile -c monty.tar spam.txt eggs.txt + +Passing a directory is also acceptable: + +.. code-block:: shell-session + + $ python -m tarfile -c monty.tar life-of-brian_1979/ + +If you want to extract a tar archive into the current directory, use +the :option:`-e` option: + +.. code-block:: shell-session + + $ python -m tarfile -e monty.tar + +You can also extract a tar archive into a different directory by passing the +directory's name: + +.. code-block:: shell-session + + $ python -m tarfile -e monty.tar other-dir/ + +For a list of the files in a tar archive, use the :option:`-l` option: + +.. code-block:: shell-session + + $ python -m tarfile -l monty.tar + + +Command-line options +~~~~~~~~~~~~~~~~~~~~ + +.. cmdoption:: -l + --list + + List files in a tarfile. + +.. cmdoption:: -c ... + --create ... + + Create tarfile from source files. + +.. cmdoption:: -e [] + --extract [] + + Extract tarfile into the current directory if *output_dir* is not specified. + +.. cmdoption:: -t + --test + + Test whether the tarfile is valid or not. + +.. cmdoption:: -v, --verbose + + Verbose output. + +.. _tar-examples: + +Examples +-------- + +How to extract an entire tar archive to the current working directory:: + + import tarfile + tar = tarfile.open("sample.tar.gz") + tar.extractall() + tar.close() + +How to extract a subset of a tar archive with :meth:`TarFile.extractall` using +a generator function instead of a list:: + + import os + import tarfile + + def py_files(members): + for tarinfo in members: + if os.path.splitext(tarinfo.name)[1] == ".py": + yield tarinfo + + tar = tarfile.open("sample.tar.gz") + tar.extractall(members=py_files(tar)) + tar.close() + +How to create an uncompressed tar archive from a list of filenames:: + + import tarfile + tar = tarfile.open("sample.tar", "w") + for name in ["foo", "bar", "quux"]: + tar.add(name) + tar.close() + +The same example using the :keyword:`with` statement:: + + import tarfile + with tarfile.open("sample.tar", "w") as tar: + for name in ["foo", "bar", "quux"]: + tar.add(name) + +How to read a gzip compressed tar archive and display some member information:: + + import tarfile + tar = tarfile.open("sample.tar.gz", "r:gz") + for tarinfo in tar: + print(tarinfo.name, "is", tarinfo.size, "bytes in size and is", end="") + if tarinfo.isreg(): + print("a regular file.") + elif tarinfo.isdir(): + print("a directory.") + else: + print("something else.") + tar.close() + +How to create an archive and reset the user information using the *filter* +parameter in :meth:`TarFile.add`:: + + import tarfile + def reset(tarinfo): + tarinfo.uid = tarinfo.gid = 0 + tarinfo.uname = tarinfo.gname = "root" + return tarinfo + tar = tarfile.open("sample.tar.gz", "w:gz") + tar.add("foo", filter=reset) + tar.close() + + +.. _tar-formats: + +Supported tar formats +--------------------- + +There are three tar formats that can be created with the :mod:`tarfile` module: + +* The POSIX.1-1988 ustar format (:const:`USTAR_FORMAT`). It supports filenames + up to a length of at best 256 characters and linknames up to 100 characters. The + maximum file size is 8 GiB. This is an old and limited but widely + supported format. + +* The GNU tar format (:const:`GNU_FORMAT`). It supports long filenames and + linknames, files bigger than 8 GiB and sparse files. It is the de facto + standard on GNU/Linux systems. :mod:`tarfile` fully supports the GNU tar + extensions for long names, sparse file support is read-only. + +* The POSIX.1-2001 pax format (:const:`PAX_FORMAT`). It is the most flexible + format with virtually no limits. It supports long filenames and linknames, large + files and stores pathnames in a portable way. However, not all tar + implementations today are able to handle pax archives properly. + + The *pax* format is an extension to the existing *ustar* format. It uses extra + headers for information that cannot be stored otherwise. There are two flavours + of pax headers: Extended headers only affect the subsequent file header, global + headers are valid for the complete archive and affect all following files. All + the data in a pax header is encoded in *UTF-8* for portability reasons. + +There are some more variants of the tar format which can be read, but not +created: + +* The ancient V7 format. This is the first tar format from Unix Seventh Edition, + storing only regular files and directories. Names must not be longer than 100 + characters, there is no user/group name information. Some archives have + miscalculated header checksums in case of fields with non-ASCII characters. + +* The SunOS tar extended format. This format is a variant of the POSIX.1-2001 + pax format, but is not compatible. + +.. _tar-unicode: + +Unicode issues +-------------- + +The tar format was originally conceived to make backups on tape drives with the +main focus on preserving file system information. Nowadays tar archives are +commonly used for file distribution and exchanging archives over networks. One +problem of the original format (which is the basis of all other formats) is +that there is no concept of supporting different character encodings. For +example, an ordinary tar archive created on a *UTF-8* system cannot be read +correctly on a *Latin-1* system if it contains non-*ASCII* characters. Textual +metadata (like filenames, linknames, user/group names) will appear damaged. +Unfortunately, there is no way to autodetect the encoding of an archive. The +pax format was designed to solve this problem. It stores non-ASCII metadata +using the universal character encoding *UTF-8*. + +The details of character conversion in :mod:`tarfile` are controlled by the +*encoding* and *errors* keyword arguments of the :class:`TarFile` class. + +*encoding* defines the character encoding to use for the metadata in the +archive. The default value is :func:`sys.getfilesystemencoding` or ``'ascii'`` +as a fallback. Depending on whether the archive is read or written, the +metadata must be either decoded or encoded. If *encoding* is not set +appropriately, this conversion may fail. + +The *errors* argument defines how characters are treated that cannot be +converted. Possible values are listed in section :ref:`error-handlers`. +The default scheme is ``'surrogateescape'`` which Python also uses for its +file system calls, see :ref:`os-filenames`. + +In case of :const:`PAX_FORMAT` archives, *encoding* is generally not needed +because all the metadata is stored using *UTF-8*. *encoding* is only used in +the rare cases when binary pax headers are decoded or when strings with +surrogate characters are stored. diff --git a/python-3.7.4-docs-html/_sources/library/telnetlib.rst.txt b/python-3.7.4-docs-html/_sources/library/telnetlib.rst.txt new file mode 100644 index 0000000..4ba4264 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/telnetlib.rst.txt @@ -0,0 +1,252 @@ +:mod:`telnetlib` --- Telnet client +================================== + +.. module:: telnetlib + :synopsis: Telnet client class. + +.. sectionauthor:: Skip Montanaro + +**Source code:** :source:`Lib/telnetlib.py` + +.. index:: single: protocol; Telnet + +-------------- + +The :mod:`telnetlib` module provides a :class:`Telnet` class that implements the +Telnet protocol. See :rfc:`854` for details about the protocol. In addition, it +provides symbolic constants for the protocol characters (see below), and for the +telnet options. The symbolic names of the telnet options follow the definitions +in ``arpa/telnet.h``, with the leading ``TELOPT_`` removed. For symbolic names +of options which are traditionally not included in ``arpa/telnet.h``, see the +module source itself. + +The symbolic constants for the telnet commands are: IAC, DONT, DO, WONT, WILL, +SE (Subnegotiation End), NOP (No Operation), DM (Data Mark), BRK (Break), IP +(Interrupt process), AO (Abort output), AYT (Are You There), EC (Erase +Character), EL (Erase Line), GA (Go Ahead), SB (Subnegotiation Begin). + + +.. class:: Telnet(host=None, port=0[, timeout]) + + :class:`Telnet` represents a connection to a Telnet server. The instance is + initially not connected by default; the :meth:`open` method must be used to + establish a connection. Alternatively, the host name and optional port + number can be passed to the constructor too, in which case the connection to + the server will be established before the constructor returns. The optional + *timeout* parameter specifies a timeout in seconds for blocking operations + like the connection attempt (if not specified, the global default timeout + setting will be used). + + Do not reopen an already connected instance. + + This class has many :meth:`read_\*` methods. Note that some of them raise + :exc:`EOFError` when the end of the connection is read, because they can return + an empty string for other reasons. See the individual descriptions below. + + A :class:`Telnet` object is a context manager and can be used in a + :keyword:`with` statement. When the :keyword:`!with` block ends, the + :meth:`close` method is called:: + + >>> from telnetlib import Telnet + >>> with Telnet('localhost', 23) as tn: + ... tn.interact() + ... + + .. versionchanged:: 3.6 Context manager support added + + +.. seealso:: + + :rfc:`854` - Telnet Protocol Specification + Definition of the Telnet protocol. + + +.. _telnet-objects: + +Telnet Objects +-------------- + +:class:`Telnet` instances have the following methods: + + +.. method:: Telnet.read_until(expected, timeout=None) + + Read until a given byte string, *expected*, is encountered or until *timeout* + seconds have passed. + + When no match is found, return whatever is available instead, possibly empty + bytes. Raise :exc:`EOFError` if the connection is closed and no cooked data + is available. + + +.. method:: Telnet.read_all() + + Read all data until EOF as bytes; block until connection closed. + + +.. method:: Telnet.read_some() + + Read at least one byte of cooked data unless EOF is hit. Return ``b''`` if + EOF is hit. Block if no data is immediately available. + + +.. method:: Telnet.read_very_eager() + + Read everything that can be without blocking in I/O (eager). + + Raise :exc:`EOFError` if connection closed and no cooked data available. + Return ``b''`` if no cooked data available otherwise. Do not block unless in + the midst of an IAC sequence. + + +.. method:: Telnet.read_eager() + + Read readily available data. + + Raise :exc:`EOFError` if connection closed and no cooked data available. + Return ``b''`` if no cooked data available otherwise. Do not block unless in + the midst of an IAC sequence. + + +.. method:: Telnet.read_lazy() + + Process and return data already in the queues (lazy). + + Raise :exc:`EOFError` if connection closed and no data available. Return + ``b''`` if no cooked data available otherwise. Do not block unless in the + midst of an IAC sequence. + + +.. method:: Telnet.read_very_lazy() + + Return any data available in the cooked queue (very lazy). + + Raise :exc:`EOFError` if connection closed and no data available. Return + ``b''`` if no cooked data available otherwise. This method never blocks. + + +.. method:: Telnet.read_sb_data() + + Return the data collected between a SB/SE pair (suboption begin/end). The + callback should access these data when it was invoked with a ``SE`` command. + This method never blocks. + + +.. method:: Telnet.open(host, port=0[, timeout]) + + Connect to a host. The optional second argument is the port number, which + defaults to the standard Telnet port (23). The optional *timeout* parameter + specifies a timeout in seconds for blocking operations like the connection + attempt (if not specified, the global default timeout setting will be used). + + Do not try to reopen an already connected instance. + + +.. method:: Telnet.msg(msg, *args) + + Print a debug message when the debug level is ``>`` 0. If extra arguments are + present, they are substituted in the message using the standard string + formatting operator. + + +.. method:: Telnet.set_debuglevel(debuglevel) + + Set the debug level. The higher the value of *debuglevel*, the more debug + output you get (on ``sys.stdout``). + + +.. method:: Telnet.close() + + Close the connection. + + +.. method:: Telnet.get_socket() + + Return the socket object used internally. + + +.. method:: Telnet.fileno() + + Return the file descriptor of the socket object used internally. + + +.. method:: Telnet.write(buffer) + + Write a byte string to the socket, doubling any IAC characters. This can + block if the connection is blocked. May raise :exc:`OSError` if the + connection is closed. + + .. versionchanged:: 3.3 + This method used to raise :exc:`socket.error`, which is now an alias + of :exc:`OSError`. + + +.. method:: Telnet.interact() + + Interaction function, emulates a very dumb Telnet client. + + +.. method:: Telnet.mt_interact() + + Multithreaded version of :meth:`interact`. + + +.. method:: Telnet.expect(list, timeout=None) + + Read until one from a list of a regular expressions matches. + + The first argument is a list of regular expressions, either compiled + (:ref:`regex objects `) or uncompiled (byte strings). The + optional second argument is a timeout, in seconds; the default is to block + indefinitely. + + Return a tuple of three items: the index in the list of the first regular + expression that matches; the match object returned; and the bytes read up + till and including the match. + + If end of file is found and no bytes were read, raise :exc:`EOFError`. + Otherwise, when nothing matches, return ``(-1, None, data)`` where *data* is + the bytes received so far (may be empty bytes if a timeout happened). + + If a regular expression ends with a greedy match (such as ``.*``) or if more + than one expression can match the same input, the results are + non-deterministic, and may depend on the I/O timing. + + +.. method:: Telnet.set_option_negotiation_callback(callback) + + Each time a telnet option is read on the input flow, this *callback* (if set) is + called with the following parameters: callback(telnet socket, command + (DO/DONT/WILL/WONT), option). No other action is done afterwards by telnetlib. + + +.. _telnet-example: + +Telnet Example +-------------- + +.. sectionauthor:: Peter Funk + + +A simple example illustrating typical use:: + + import getpass + import telnetlib + + HOST = "localhost" + user = input("Enter your remote account: ") + password = getpass.getpass() + + tn = telnetlib.Telnet(HOST) + + tn.read_until(b"login: ") + tn.write(user.encode('ascii') + b"\n") + if password: + tn.read_until(b"Password: ") + tn.write(password.encode('ascii') + b"\n") + + tn.write(b"ls\n") + tn.write(b"exit\n") + + print(tn.read_all().decode('ascii')) + diff --git a/python-3.7.4-docs-html/_sources/library/tempfile.rst.txt b/python-3.7.4-docs-html/_sources/library/tempfile.rst.txt new file mode 100644 index 0000000..746adb1 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/tempfile.rst.txt @@ -0,0 +1,333 @@ +:mod:`tempfile` --- Generate temporary files and directories +============================================================ + +.. module:: tempfile + :synopsis: Generate temporary files and directories. + +.. sectionauthor:: Zack Weinberg + +**Source code:** :source:`Lib/tempfile.py` + +.. index:: + pair: temporary; file name + pair: temporary; file + +-------------- + +This module creates temporary files and directories. It works on all +supported platforms. :class:`TemporaryFile`, :class:`NamedTemporaryFile`, +:class:`TemporaryDirectory`, and :class:`SpooledTemporaryFile` are high-level +interfaces which provide automatic cleanup and can be used as +context managers. :func:`mkstemp` and +:func:`mkdtemp` are lower-level functions which require manual cleanup. + +All the user-callable functions and constructors take additional arguments which +allow direct control over the location and name of temporary files and +directories. Files names used by this module include a string of +random characters which allows those files to be securely created in +shared temporary directories. +To maintain backward compatibility, the argument order is somewhat odd; it +is recommended to use keyword arguments for clarity. + +The module defines the following user-callable items: + +.. function:: TemporaryFile(mode='w+b', buffering=None, encoding=None, newline=None, suffix=None, prefix=None, dir=None) + + Return a :term:`file-like object` that can be used as a temporary storage area. + The file is created securely, using the same rules as :func:`mkstemp`. It will be destroyed as soon + as it is closed (including an implicit close when the object is garbage + collected). Under Unix, the directory entry for the file is either not created at all or is removed + immediately after the file is created. Other platforms do not support + this; your code should not rely on a temporary file created using this + function having or not having a visible name in the file system. + + The resulting object can be used as a context manager (see + :ref:`tempfile-examples`). On completion of the context or + destruction of the file object the temporary file will be removed + from the filesystem. + + The *mode* parameter defaults to ``'w+b'`` so that the file created can + be read and written without being closed. Binary mode is used so that it + behaves consistently on all platforms without regard for the data that is + stored. *buffering*, *encoding* and *newline* are interpreted as for + :func:`open`. + + The *dir*, *prefix* and *suffix* parameters have the same meaning and + defaults as with :func:`mkstemp`. + + The returned object is a true file object on POSIX platforms. On other + platforms, it is a file-like object whose :attr:`!file` attribute is the + underlying true file object. + + The :py:data:`os.O_TMPFILE` flag is used if it is available and works + (Linux-specific, requires Linux kernel 3.11 or later). + + .. versionchanged:: 3.5 + + The :py:data:`os.O_TMPFILE` flag is now used if available. + + +.. function:: NamedTemporaryFile(mode='w+b', buffering=None, encoding=None, newline=None, suffix=None, prefix=None, dir=None, delete=True) + + This function operates exactly as :func:`TemporaryFile` does, except that + the file is guaranteed to have a visible name in the file system (on + Unix, the directory entry is not unlinked). That name can be retrieved + from the :attr:`name` attribute of the returned + file-like object. Whether the name can be + used to open the file a second time, while the named temporary file is + still open, varies across platforms (it can be so used on Unix; it cannot + on Windows NT or later). If *delete* is true (the default), the file is + deleted as soon as it is closed. + The returned object is always a file-like object whose :attr:`!file` + attribute is the underlying true file object. This file-like object can + be used in a :keyword:`with` statement, just like a normal file. + + +.. function:: SpooledTemporaryFile(max_size=0, mode='w+b', buffering=None, encoding=None, newline=None, suffix=None, prefix=None, dir=None) + + This function operates exactly as :func:`TemporaryFile` does, except that + data is spooled in memory until the file size exceeds *max_size*, or + until the file's :func:`fileno` method is called, at which point the + contents are written to disk and operation proceeds as with + :func:`TemporaryFile`. + + The resulting file has one additional method, :func:`rollover`, which + causes the file to roll over to an on-disk file regardless of its size. + + The returned object is a file-like object whose :attr:`_file` attribute + is either an :class:`io.BytesIO` or :class:`io.StringIO` object (depending on + whether binary or text *mode* was specified) or a true file + object, depending on whether :func:`rollover` has been called. This + file-like object can be used in a :keyword:`with` statement, just like + a normal file. + + .. versionchanged:: 3.3 + the truncate method now accepts a ``size`` argument. + + +.. function:: TemporaryDirectory(suffix=None, prefix=None, dir=None) + + This function securely creates a temporary directory using the same rules as :func:`mkdtemp`. + The resulting object can be used as a context manager (see + :ref:`tempfile-examples`). On completion of the context or destruction + of the temporary directory object the newly created temporary directory + and all its contents are removed from the filesystem. + + The directory name can be retrieved from the :attr:`name` attribute of the + returned object. When the returned object is used as a context manager, the + :attr:`name` will be assigned to the target of the :keyword:`!as` clause in + the :keyword:`with` statement, if there is one. + + The directory can be explicitly cleaned up by calling the + :func:`cleanup` method. + + .. versionadded:: 3.2 + + +.. function:: mkstemp(suffix=None, prefix=None, dir=None, text=False) + + Creates a temporary file in the most secure manner possible. There are + no race conditions in the file's creation, assuming that the platform + properly implements the :const:`os.O_EXCL` flag for :func:`os.open`. The + file is readable and writable only by the creating user ID. If the + platform uses permission bits to indicate whether a file is executable, + the file is executable by no one. The file descriptor is not inherited + by child processes. + + Unlike :func:`TemporaryFile`, the user of :func:`mkstemp` is responsible + for deleting the temporary file when done with it. + + If *suffix* is not ``None``, the file name will end with that suffix, + otherwise there will be no suffix. :func:`mkstemp` does not put a dot + between the file name and the suffix; if you need one, put it at the + beginning of *suffix*. + + If *prefix* is not ``None``, the file name will begin with that prefix; + otherwise, a default prefix is used. The default is the return value of + :func:`gettempprefix` or :func:`gettempprefixb`, as appropriate. + + If *dir* is not ``None``, the file will be created in that directory; + otherwise, a default directory is used. The default directory is chosen + from a platform-dependent list, but the user of the application can + control the directory location by setting the *TMPDIR*, *TEMP* or *TMP* + environment variables. There is thus no guarantee that the generated + filename will have any nice properties, such as not requiring quoting + when passed to external commands via ``os.popen()``. + + If any of *suffix*, *prefix*, and *dir* are not + ``None``, they must be the same type. + If they are bytes, the returned name will be bytes instead of str. + If you want to force a bytes return value with otherwise default behavior, + pass ``suffix=b''``. + + If *text* is specified, it indicates whether to open the file in binary + mode (the default) or text mode. On some platforms, this makes no + difference. + + :func:`mkstemp` returns a tuple containing an OS-level handle to an open + file (as would be returned by :func:`os.open`) and the absolute pathname + of that file, in that order. + + .. versionchanged:: 3.5 + *suffix*, *prefix*, and *dir* may now be supplied in bytes in order to + obtain a bytes return value. Prior to this, only str was allowed. + *suffix* and *prefix* now accept and default to ``None`` to cause + an appropriate default value to be used. + + +.. function:: mkdtemp(suffix=None, prefix=None, dir=None) + + Creates a temporary directory in the most secure manner possible. There + are no race conditions in the directory's creation. The directory is + readable, writable, and searchable only by the creating user ID. + + The user of :func:`mkdtemp` is responsible for deleting the temporary + directory and its contents when done with it. + + The *prefix*, *suffix*, and *dir* arguments are the same as for + :func:`mkstemp`. + + :func:`mkdtemp` returns the absolute pathname of the new directory. + + .. versionchanged:: 3.5 + *suffix*, *prefix*, and *dir* may now be supplied in bytes in order to + obtain a bytes return value. Prior to this, only str was allowed. + *suffix* and *prefix* now accept and default to ``None`` to cause + an appropriate default value to be used. + + +.. function:: gettempdir() + + Return the name of the directory used for temporary files. This + defines the default value for the *dir* argument to all functions + in this module. + + Python searches a standard list of directories to find one which + the calling user can create files in. The list is: + + #. The directory named by the :envvar:`TMPDIR` environment variable. + + #. The directory named by the :envvar:`TEMP` environment variable. + + #. The directory named by the :envvar:`TMP` environment variable. + + #. A platform-specific location: + + * On Windows, the directories :file:`C:\\TEMP`, :file:`C:\\TMP`, + :file:`\\TEMP`, and :file:`\\TMP`, in that order. + + * On all other platforms, the directories :file:`/tmp`, :file:`/var/tmp`, and + :file:`/usr/tmp`, in that order. + + #. As a last resort, the current working directory. + + The result of this search is cached, see the description of + :data:`tempdir` below. + +.. function:: gettempdirb() + + Same as :func:`gettempdir` but the return value is in bytes. + + .. versionadded:: 3.5 + +.. function:: gettempprefix() + + Return the filename prefix used to create temporary files. This does not + contain the directory component. + +.. function:: gettempprefixb() + + Same as :func:`gettempprefix` but the return value is in bytes. + + .. versionadded:: 3.5 + +The module uses a global variable to store the name of the directory +used for temporary files returned by :func:`gettempdir`. It can be +set directly to override the selection process, but this is discouraged. +All functions in this module take a *dir* argument which can be used +to specify the directory and this is the recommended approach. + +.. data:: tempdir + + When set to a value other than ``None``, this variable defines the + default value for the *dir* argument to the functions defined in this + module. + + If ``tempdir`` is ``None`` (the default) at any call to any of the above + functions except :func:`gettempprefix` it is initialized following the + algorithm described in :func:`gettempdir`. + +.. _tempfile-examples: + +Examples +-------- + +Here are some examples of typical usage of the :mod:`tempfile` module:: + + >>> import tempfile + + # create a temporary file and write some data to it + >>> fp = tempfile.TemporaryFile() + >>> fp.write(b'Hello world!') + # read data from file + >>> fp.seek(0) + >>> fp.read() + b'Hello world!' + # close the file, it will be removed + >>> fp.close() + + # create a temporary file using a context manager + >>> with tempfile.TemporaryFile() as fp: + ... fp.write(b'Hello world!') + ... fp.seek(0) + ... fp.read() + b'Hello world!' + >>> + # file is now closed and removed + + # create a temporary directory using the context manager + >>> with tempfile.TemporaryDirectory() as tmpdirname: + ... print('created temporary directory', tmpdirname) + >>> + # directory and contents have been removed + + +Deprecated functions and variables +---------------------------------- + +A historical way to create temporary files was to first generate a +file name with the :func:`mktemp` function and then create a file +using this name. Unfortunately this is not secure, because a different +process may create a file with this name in the time between the call +to :func:`mktemp` and the subsequent attempt to create the file by the +first process. The solution is to combine the two steps and create the +file immediately. This approach is used by :func:`mkstemp` and the +other functions described above. + +.. function:: mktemp(suffix='', prefix='tmp', dir=None) + + .. deprecated:: 2.3 + Use :func:`mkstemp` instead. + + Return an absolute pathname of a file that did not exist at the time the + call is made. The *prefix*, *suffix*, and *dir* arguments are similar + to those of :func:`mkstemp`, except that bytes file names, ``suffix=None`` + and ``prefix=None`` are not supported. + + .. warning:: + + Use of this function may introduce a security hole in your program. By + the time you get around to doing anything with the file name it returns, + someone else may have beaten you to the punch. :func:`mktemp` usage can + be replaced easily with :func:`NamedTemporaryFile`, passing it the + ``delete=False`` parameter:: + + >>> f = NamedTemporaryFile(delete=False) + >>> f.name + '/tmp/tmptjujjt' + >>> f.write(b"Hello World!\n") + 13 + >>> f.close() + >>> os.unlink(f.name) + >>> os.path.exists(f.name) + False diff --git a/python-3.7.4-docs-html/_sources/library/termios.rst.txt b/python-3.7.4-docs-html/_sources/library/termios.rst.txt new file mode 100644 index 0000000..d75a87c --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/termios.rst.txt @@ -0,0 +1,105 @@ +:mod:`termios` --- POSIX style tty control +========================================== + +.. module:: termios + :platform: Unix + :synopsis: POSIX style tty control. + +.. index:: + pair: POSIX; I/O control + pair: tty; I/O control + +-------------- + +This module provides an interface to the POSIX calls for tty I/O control. For a +complete description of these calls, see :manpage:`termios(3)` Unix manual +page. It is only available for those Unix versions that support POSIX +*termios* style tty I/O control configured during installation. + +All functions in this module take a file descriptor *fd* as their first +argument. This can be an integer file descriptor, such as returned by +``sys.stdin.fileno()``, or a :term:`file object`, such as ``sys.stdin`` itself. + +This module also defines all the constants needed to work with the functions +provided here; these have the same name as their counterparts in C. Please +refer to your system documentation for more information on using these terminal +control interfaces. + +The module defines the following functions: + + +.. function:: tcgetattr(fd) + + Return a list containing the tty attributes for file descriptor *fd*, as + follows: ``[iflag, oflag, cflag, lflag, ispeed, ospeed, cc]`` where *cc* is a + list of the tty special characters (each a string of length 1, except the + items with indices :const:`VMIN` and :const:`VTIME`, which are integers when + these fields are defined). The interpretation of the flags and the speeds as + well as the indexing in the *cc* array must be done using the symbolic + constants defined in the :mod:`termios` module. + + +.. function:: tcsetattr(fd, when, attributes) + + Set the tty attributes for file descriptor *fd* from the *attributes*, which is + a list like the one returned by :func:`tcgetattr`. The *when* argument + determines when the attributes are changed: :const:`TCSANOW` to change + immediately, :const:`TCSADRAIN` to change after transmitting all queued output, + or :const:`TCSAFLUSH` to change after transmitting all queued output and + discarding all queued input. + + +.. function:: tcsendbreak(fd, duration) + + Send a break on file descriptor *fd*. A zero *duration* sends a break for + 0.25--0.5 seconds; a nonzero *duration* has a system dependent meaning. + + +.. function:: tcdrain(fd) + + Wait until all output written to file descriptor *fd* has been transmitted. + + +.. function:: tcflush(fd, queue) + + Discard queued data on file descriptor *fd*. The *queue* selector specifies + which queue: :const:`TCIFLUSH` for the input queue, :const:`TCOFLUSH` for the + output queue, or :const:`TCIOFLUSH` for both queues. + + +.. function:: tcflow(fd, action) + + Suspend or resume input or output on file descriptor *fd*. The *action* + argument can be :const:`TCOOFF` to suspend output, :const:`TCOON` to restart + output, :const:`TCIOFF` to suspend input, or :const:`TCION` to restart input. + + +.. seealso:: + + Module :mod:`tty` + Convenience functions for common terminal control operations. + + +.. _termios-example: + +Example +------- + +Here's a function that prompts for a password with echoing turned off. Note the +technique using a separate :func:`tcgetattr` call and a :keyword:`try` ... +:keyword:`finally` statement to ensure that the old tty attributes are restored +exactly no matter what happens:: + + def getpass(prompt="Password: "): + import termios, sys + fd = sys.stdin.fileno() + old = termios.tcgetattr(fd) + new = termios.tcgetattr(fd) + new[3] = new[3] & ~termios.ECHO # lflags + try: + termios.tcsetattr(fd, termios.TCSADRAIN, new) + passwd = input(prompt) + finally: + termios.tcsetattr(fd, termios.TCSADRAIN, old) + return passwd + diff --git a/python-3.7.4-docs-html/_sources/library/test.rst.txt b/python-3.7.4-docs-html/_sources/library/test.rst.txt new file mode 100644 index 0000000..de79cdf --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/test.rst.txt @@ -0,0 +1,1406 @@ +:mod:`test` --- Regression tests package for Python +=================================================== + +.. module:: test + :synopsis: Regression tests package containing the testing suite for Python. + +.. sectionauthor:: Brett Cannon + +.. note:: + The :mod:`test` package is meant for internal use by Python only. It is + documented for the benefit of the core developers of Python. Any use of + this package outside of Python's standard library is discouraged as code + mentioned here can change or be removed without notice between releases of + Python. + +-------------- + +The :mod:`test` package contains all regression tests for Python as well as the +modules :mod:`test.support` and :mod:`test.regrtest`. +:mod:`test.support` is used to enhance your tests while +:mod:`test.regrtest` drives the testing suite. + +Each module in the :mod:`test` package whose name starts with ``test_`` is a +testing suite for a specific module or feature. All new tests should be written +using the :mod:`unittest` or :mod:`doctest` module. Some older tests are +written using a "traditional" testing style that compares output printed to +``sys.stdout``; this style of test is considered deprecated. + + +.. seealso:: + + Module :mod:`unittest` + Writing PyUnit regression tests. + + Module :mod:`doctest` + Tests embedded in documentation strings. + + +.. _writing-tests: + +Writing Unit Tests for the :mod:`test` package +---------------------------------------------- + +It is preferred that tests that use the :mod:`unittest` module follow a few +guidelines. One is to name the test module by starting it with ``test_`` and end +it with the name of the module being tested. The test methods in the test module +should start with ``test_`` and end with a description of what the method is +testing. This is needed so that the methods are recognized by the test driver as +test methods. Also, no documentation string for the method should be included. A +comment (such as ``# Tests function returns only True or False``) should be used +to provide documentation for test methods. This is done because documentation +strings get printed out if they exist and thus what test is being run is not +stated. + +A basic boilerplate is often used:: + + import unittest + from test import support + + class MyTestCase1(unittest.TestCase): + + # Only use setUp() and tearDown() if necessary + + def setUp(self): + ... code to execute in preparation for tests ... + + def tearDown(self): + ... code to execute to clean up after tests ... + + def test_feature_one(self): + # Test feature one. + ... testing code ... + + def test_feature_two(self): + # Test feature two. + ... testing code ... + + ... more test methods ... + + class MyTestCase2(unittest.TestCase): + ... same structure as MyTestCase1 ... + + ... more test classes ... + + if __name__ == '__main__': + unittest.main() + +This code pattern allows the testing suite to be run by :mod:`test.regrtest`, +on its own as a script that supports the :mod:`unittest` CLI, or via the +``python -m unittest`` CLI. + +The goal for regression testing is to try to break code. This leads to a few +guidelines to be followed: + +* The testing suite should exercise all classes, functions, and constants. This + includes not just the external API that is to be presented to the outside + world but also "private" code. + +* Whitebox testing (examining the code being tested when the tests are being + written) is preferred. Blackbox testing (testing only the published user + interface) is not complete enough to make sure all boundary and edge cases + are tested. + +* Make sure all possible values are tested including invalid ones. This makes + sure that not only all valid values are acceptable but also that improper + values are handled correctly. + +* Exhaust as many code paths as possible. Test where branching occurs and thus + tailor input to make sure as many different paths through the code are taken. + +* Add an explicit test for any bugs discovered for the tested code. This will + make sure that the error does not crop up again if the code is changed in the + future. + +* Make sure to clean up after your tests (such as close and remove all temporary + files). + +* If a test is dependent on a specific condition of the operating system then + verify the condition already exists before attempting the test. + +* Import as few modules as possible and do it as soon as possible. This + minimizes external dependencies of tests and also minimizes possible anomalous + behavior from side-effects of importing a module. + +* Try to maximize code reuse. On occasion, tests will vary by something as small + as what type of input is used. Minimize code duplication by subclassing a + basic test class with a class that specifies the input:: + + class TestFuncAcceptsSequencesMixin: + + func = mySuperWhammyFunction + + def test_func(self): + self.func(self.arg) + + class AcceptLists(TestFuncAcceptsSequencesMixin, unittest.TestCase): + arg = [1, 2, 3] + + class AcceptStrings(TestFuncAcceptsSequencesMixin, unittest.TestCase): + arg = 'abc' + + class AcceptTuples(TestFuncAcceptsSequencesMixin, unittest.TestCase): + arg = (1, 2, 3) + + When using this pattern, remember that all classes that inherit from + :class:`unittest.TestCase` are run as tests. The :class:`Mixin` class in the example above + does not have any data and so can't be run by itself, thus it does not + inherit from :class:`unittest.TestCase`. + + +.. seealso:: + + Test Driven Development + A book by Kent Beck on writing tests before code. + + +.. _regrtest: + +Running tests using the command-line interface +---------------------------------------------- + +The :mod:`test` package can be run as a script to drive Python's regression +test suite, thanks to the :option:`-m` option: :program:`python -m test`. Under +the hood, it uses :mod:`test.regrtest`; the call :program:`python -m +test.regrtest` used in previous Python versions still works. Running the +script by itself automatically starts running all regression tests in the +:mod:`test` package. It does this by finding all modules in the package whose +name starts with ``test_``, importing them, and executing the function +:func:`test_main` if present or loading the tests via +unittest.TestLoader.loadTestsFromModule if ``test_main`` does not exist. The +names of tests to execute may also be passed to the script. Specifying a single +regression test (:program:`python -m test test_spam`) will minimize output and +only print whether the test passed or failed. + +Running :mod:`test` directly allows what resources are available for +tests to use to be set. You do this by using the ``-u`` command-line +option. Specifying ``all`` as the value for the ``-u`` option enables all +possible resources: :program:`python -m test -uall`. +If all but one resource is desired (a more common case), a +comma-separated list of resources that are not desired may be listed after +``all``. The command :program:`python -m test -uall,-audio,-largefile` +will run :mod:`test` with all resources except the ``audio`` and +``largefile`` resources. For a list of all resources and more command-line +options, run :program:`python -m test -h`. + +Some other ways to execute the regression tests depend on what platform the +tests are being executed on. On Unix, you can run :program:`make test` at the +top-level directory where Python was built. On Windows, +executing :program:`rt.bat` from your :file:`PCbuild` directory will run all +regression tests. + + +:mod:`test.support` --- Utilities for the Python test suite +=========================================================== + +.. module:: test.support + :synopsis: Support for Python's regression test suite. + + +The :mod:`test.support` module provides support for Python's regression +test suite. + +.. note:: + + :mod:`test.support` is not a public module. It is documented here to help + Python developers write tests. The API of this module is subject to change + without backwards compatibility concerns between releases. + + +This module defines the following exceptions: + +.. exception:: TestFailed + + Exception to be raised when a test fails. This is deprecated in favor of + :mod:`unittest`\ -based tests and :class:`unittest.TestCase`'s assertion + methods. + + +.. exception:: ResourceDenied + + Subclass of :exc:`unittest.SkipTest`. Raised when a resource (such as a + network connection) is not available. Raised by the :func:`requires` + function. + + +The :mod:`test.support` module defines the following constants: + +.. data:: verbose + + ``True`` when verbose output is enabled. Should be checked when more + detailed information is desired about a running test. *verbose* is set by + :mod:`test.regrtest`. + + +.. data:: is_jython + + ``True`` if the running interpreter is Jython. + + +.. data:: is_android + + ``True`` if the system is Android. + + +.. data:: unix_shell + + Path for shell if not on Windows; otherwise ``None``. + + +.. data:: FS_NONASCII + + A non-ASCII character encodable by :func:`os.fsencode`. + + +.. data:: TESTFN + + Set to a name that is safe to use as the name of a temporary file. Any + temporary file that is created should be closed and unlinked (removed). + + +.. data:: TESTFN_UNICODE + + Set to a non-ASCII name for a temporary file. + + +.. data:: TESTFN_ENCODING + + Set to :func:`sys.getfilesystemencoding`. + + +.. data:: TESTFN_UNENCODABLE + + Set to a filename (str type) that should not be able to be encoded by file + system encoding in strict mode. It may be ``None`` if it's not possible to + generate such a filename. + + +.. data:: TESTFN_UNDECODABLE + + Set to a filename (bytes type) that should not be able to be decoded by + file system encoding in strict mode. It may be ``None`` if it's not + possible to generate such a filename. + + +.. data:: TESTFN_NONASCII + + Set to a filename containing the :data:`FS_NONASCII` character. + + +.. data:: IPV6_ENABLED + + Set to ``True`` if IPV6 is enabled on this host, ``False`` otherwise. + + +.. data:: SAVEDCWD + + Set to :func:`os.getcwd`. + + +.. data:: PGO + + Set when tests can be skipped when they are not useful for PGO. + + +.. data:: PIPE_MAX_SIZE + + A constant that is likely larger than the underlying OS pipe buffer size, + to make writes blocking. + + +.. data:: SOCK_MAX_SIZE + + A constant that is likely larger than the underlying OS socket buffer size, + to make writes blocking. + + +.. data:: TEST_SUPPORT_DIR + + Set to the top level directory that contains :mod:`test.support`. + + +.. data:: TEST_HOME_DIR + + Set to the top level directory for the test package. + + +.. data:: TEST_DATA_DIR + + Set to the ``data`` directory within the test package. + + +.. data:: MAX_Py_ssize_t + + Set to :data:`sys.maxsize` for big memory tests. + + +.. data:: max_memuse + + Set by :func:`set_memlimit` as the memory limit for big memory tests. + Limited by :data:`MAX_Py_ssize_t`. + + +.. data:: real_max_memuse + + Set by :func:`set_memlimit` as the memory limit for big memory tests. Not + limited by :data:`MAX_Py_ssize_t`. + + +.. data:: MISSING_C_DOCSTRINGS + + Return ``True`` if running on CPython, not on Windows, and configuration + not set with ``WITH_DOC_STRINGS``. + + +.. data:: HAVE_DOCSTRINGS + + Check for presence of docstrings. + +.. data:: TEST_HTTP_URL + + Define the URL of a dedicated HTTP server for the network tests. + + + +The :mod:`test.support` module defines the following functions: + +.. function:: forget(module_name) + + Remove the module named *module_name* from ``sys.modules`` and delete any + byte-compiled files of the module. + + +.. function:: unload(name) + + Delete *name* from ``sys.modules``. + + +.. function:: unlink(filename) + + Call :func:`os.unlink` on *filename*. On Windows platforms, this is + wrapped with a wait loop that checks for the existence fo the file. + + +.. function:: rmdir(filename) + + Call :func:`os.rmdir` on *filename*. On Windows platforms, this is + wrapped with a wait loop that checks for the existence of the file. + + +.. function:: rmtree(path) + + Call :func:`shutil.rmtree` on *path* or call :func:`os.lstat` and + :func:`os.rmdir` to remove a path and its contents. On Windows platforms, + this is wrapped with a wait loop that checks for the existence of the files. + + +.. function:: make_legacy_pyc(source) + + Move a PEP 3147/488 pyc file to its legacy pyc location and return the file + system path to the legacy pyc file. The *source* value is the file system + path to the source file. It does not need to exist, however the PEP + 3147/488 pyc file must exist. + + +.. function:: is_resource_enabled(resource) + + Return ``True`` if *resource* is enabled and available. The list of + available resources is only set when :mod:`test.regrtest` is executing the + tests. + + +.. function:: python_is_optimized() + + Return ``True`` if Python was not built with ``-O0`` or ``-Og``. + + +.. function:: with_pymalloc() + + Return :data:`_testcapi.WITH_PYMALLOC`. + + +.. function:: requires(resource, msg=None) + + Raise :exc:`ResourceDenied` if *resource* is not available. *msg* is the + argument to :exc:`ResourceDenied` if it is raised. Always returns + ``True`` if called by a function whose ``__name__`` is ``'__main__'``. + Used when tests are executed by :mod:`test.regrtest`. + + +.. function:: system_must_validate_cert(f) + + Raise :exc:`unittest.SkipTest` on TLS certification validation failures. + + +.. function:: sortdict(dict) + + Return a repr of *dict* with keys sorted. + + +.. function:: findfile(filename, subdir=None) + + Return the path to the file named *filename*. If no match is found + *filename* is returned. This does not equal a failure since it could be the + path to the file. + + Setting *subdir* indicates a relative path to use to find the file + rather than looking directly in the path directories. + + +.. function:: create_empty_file(filename) + + Create an empty file with *filename*. If it already exists, truncate it. + + +.. function:: fd_count() + + Count the number of open file descriptors. + + +.. function:: match_test(test) + + Match *test* to patterns set in :func:`set_match_tests`. + + +.. function:: set_match_tests(patterns) + + Define match test with regular expression *patterns*. + + +.. function:: run_unittest(\*classes) + + Execute :class:`unittest.TestCase` subclasses passed to the function. The + function scans the classes for methods starting with the prefix ``test_`` + and executes the tests individually. + + It is also legal to pass strings as parameters; these should be keys in + ``sys.modules``. Each associated module will be scanned by + ``unittest.TestLoader.loadTestsFromModule()``. This is usually seen in the + following :func:`test_main` function:: + + def test_main(): + support.run_unittest(__name__) + + This will run all tests defined in the named module. + + +.. function:: run_doctest(module, verbosity=None, optionflags=0) + + Run :func:`doctest.testmod` on the given *module*. Return + ``(failure_count, test_count)``. + + If *verbosity* is ``None``, :func:`doctest.testmod` is run with verbosity + set to :data:`verbose`. Otherwise, it is run with verbosity set to + ``None``. *optionflags* is passed as ``optionflags`` to + :func:`doctest.testmod`. + + +.. function:: setswitchinterval(interval) + + Set the :func:`sys.setswitchinterval` to the given *interval*. Defines + a minimum interval for Android systems to prevent the system from hanging. + + +.. function:: check_impl_detail(**guards) + + Use this check to guard CPython's implementation-specific tests or to + run them only on the implementations guarded by the arguments:: + + check_impl_detail() # Only on CPython (default). + check_impl_detail(jython=True) # Only on Jython. + check_impl_detail(cpython=False) # Everywhere except CPython. + + +.. function:: check_warnings(\*filters, quiet=True) + + A convenience wrapper for :func:`warnings.catch_warnings()` that makes it + easier to test that a warning was correctly raised. It is approximately + equivalent to calling ``warnings.catch_warnings(record=True)`` with + :meth:`warnings.simplefilter` set to ``always`` and with the option to + automatically validate the results that are recorded. + + ``check_warnings`` accepts 2-tuples of the form ``("message regexp", + WarningCategory)`` as positional arguments. If one or more *filters* are + provided, or if the optional keyword argument *quiet* is ``False``, + it checks to make sure the warnings are as expected: each specified filter + must match at least one of the warnings raised by the enclosed code or the + test fails, and if any warnings are raised that do not match any of the + specified filters the test fails. To disable the first of these checks, + set *quiet* to ``True``. + + If no arguments are specified, it defaults to:: + + check_warnings(("", Warning), quiet=True) + + In this case all warnings are caught and no errors are raised. + + On entry to the context manager, a :class:`WarningRecorder` instance is + returned. The underlying warnings list from + :func:`~warnings.catch_warnings` is available via the recorder object's + :attr:`warnings` attribute. As a convenience, the attributes of the object + representing the most recent warning can also be accessed directly through + the recorder object (see example below). If no warning has been raised, + then any of the attributes that would otherwise be expected on an object + representing a warning will return ``None``. + + The recorder object also has a :meth:`reset` method, which clears the + warnings list. + + The context manager is designed to be used like this:: + + with check_warnings(("assertion is always true", SyntaxWarning), + ("", UserWarning)): + exec('assert(False, "Hey!")') + warnings.warn(UserWarning("Hide me!")) + + In this case if either warning was not raised, or some other warning was + raised, :func:`check_warnings` would raise an error. + + When a test needs to look more deeply into the warnings, rather than + just checking whether or not they occurred, code like this can be used:: + + with check_warnings(quiet=True) as w: + warnings.warn("foo") + assert str(w.args[0]) == "foo" + warnings.warn("bar") + assert str(w.args[0]) == "bar" + assert str(w.warnings[0].args[0]) == "foo" + assert str(w.warnings[1].args[0]) == "bar" + w.reset() + assert len(w.warnings) == 0 + + + Here all warnings will be caught, and the test code tests the captured + warnings directly. + + .. versionchanged:: 3.2 + New optional arguments *filters* and *quiet*. + + +.. function:: check_no_resource_warning(testcase) + + Context manager to check that no :exc:`ResourceWarning` was raised. You + must remove the object which may emit :exc:`ResourceWarning` before the + end of the context manager. + + +.. function:: set_memlimit(limit) + + Set the values for :data:`max_memuse` and :data:`real_max_memuse` for big + memory tests. + + +.. function:: record_original_stdout(stdout) + + Store the value from *stdout*. It is meant to hold the stdout at the + time the regrtest began. + + +.. function:: get_original_stdout + + Return the original stdout set by :func:`record_original_stdout` or + ``sys.stdout`` if it's not set. + + +.. function:: strip_python_strerr(stderr) + + Strip the *stderr* of a Python process from potential debug output + emitted by the interpreter. This will typically be run on the result of + :meth:`subprocess.Popen.communicate`. + + +.. function:: args_from_interpreter_flags() + + Return a list of command line arguments reproducing the current settings + in ``sys.flags`` and ``sys.warnoptions``. + + +.. function:: optim_args_from_interpreter_flags() + + Return a list of command line arguments reproducing the current + optimization settings in ``sys.flags``. + + +.. function:: captured_stdin() + captured_stdout() + captured_stderr() + + A context managers that temporarily replaces the named stream with + :class:`io.StringIO` object. + + Example use with output streams:: + + with captured_stdout() as stdout, captured_stderr() as stderr: + print("hello") + print("error", file=sys.stderr) + assert stdout.getvalue() == "hello\n" + assert stderr.getvalue() == "error\n" + + Example use with input stream:: + + with captured_stdin() as stdin: + stdin.write('hello\n') + stdin.seek(0) + # call test code that consumes from sys.stdin + captured = input() + self.assertEqual(captured, "hello") + + +.. function:: temp_dir(path=None, quiet=False) + + A context manager that creates a temporary directory at *path* and + yields the directory. + + If *path* is ``None``, the temporary directory is created using + :func:`tempfile.mkdtemp`. If *quiet* is ``False``, the context manager + raises an exception on error. Otherwise, if *path* is specified and + cannot be created, only a warning is issued. + + +.. function:: change_cwd(path, quiet=False) + + A context manager that temporarily changes the current working + directory to *path* and yields the directory. + + If *quiet* is ``False``, the context manager raises an exception + on error. Otherwise, it issues only a warning and keeps the current + working directory the same. + + +.. function:: temp_cwd(name='tempcwd', quiet=False) + + A context manager that temporarily creates a new directory and + changes the current working directory (CWD). + + The context manager creates a temporary directory in the current + directory with name *name* before temporarily changing the current + working directory. If *name* is ``None``, the temporary directory is + created using :func:`tempfile.mkdtemp`. + + If *quiet* is ``False`` and it is not possible to create or change + the CWD, an error is raised. Otherwise, only a warning is raised + and the original CWD is used. + + +.. function:: temp_umask(umask) + + A context manager that temporarily sets the process umask. + + +.. function:: transient_internet(resource_name, *, timeout=30.0, errnos=()) + + A context manager that raises :exc:`ResourceDenied` when various issues + with the internet connection manifest themselves as exceptions. + + +.. function:: disable_faulthandler() + + A context manager that replaces ``sys.stderr`` with ``sys.__stderr__``. + + +.. function:: gc_collect() + + Force as many objects as possible to be collected. This is needed because + timely deallocation is not guaranteed by the garbage collector. This means + that ``__del__`` methods may be called later than expected and weakrefs + may remain alive for longer than expected. + + +.. function:: disable_gc() + + A context manager that disables the garbage collector upon entry and + reenables it upon exit. + + +.. function:: swap_attr(obj, attr, new_val) + + Context manager to swap out an attribute with a new object. + + Usage:: + + with swap_attr(obj, "attr", 5): + ... + + This will set ``obj.attr`` to 5 for the duration of the ``with`` block, + restoring the old value at the end of the block. If ``attr`` doesn't + exist on ``obj``, it will be created and then deleted at the end of the + block. + + The old value (or ``None`` if it doesn't exist) will be assigned to the + target of the "as" clause, if there is one. + + +.. function:: swap_item(obj, attr, new_val) + + Context manager to swap out an item with a new object. + + Usage:: + + with swap_item(obj, "item", 5): + ... + + This will set ``obj["item"]`` to 5 for the duration of the ``with`` block, + restoring the old value at the end of the block. If ``item`` doesn't + exist on ``obj``, it will be created and then deleted at the end of the + block. + + The old value (or ``None`` if it doesn't exist) will be assigned to the + target of the "as" clause, if there is one. + + +.. function:: wait_threads_exit(timeout=60.0) + + Context manager to wait until all threads created in the ``with`` statement + exit. + + +.. function:: start_threads(threads, unlock=None) + + Context manager to start *threads*. It attempts to join the threads upon + exit. + + +.. function:: calcobjsize(fmt) + + Return :func:`struct.calcsize` for ``nP{fmt}0n`` or, if ``gettotalrefcount`` + exists, ``2PnP{fmt}0P``. + + +.. function:: calcvobjsize(fmt) + + Return :func:`struct.calcsize` for ``nPn{fmt}0n`` or, if ``gettotalrefcount`` + exists, ``2PnPn{fmt}0P``. + + +.. function:: checksizeof(test, o, size) + + For testcase *test*, assert that the ``sys.getsizeof`` for *o* plus the GC + header size equals *size*. + + +.. function:: can_symlink() + + Return ``True`` if the OS supports symbolic links, ``False`` + otherwise. + + +.. function:: can_xattr() + + Return ``True`` if the OS supports xattr, ``False`` + otherwise. + + +.. decorator:: skip_unless_symlink + + A decorator for running tests that require support for symbolic links. + + +.. decorator:: skip_unless_xattr + + A decorator for running tests that require support for xattr. + + +.. decorator:: skip_unless_bind_unix_socket + + A decorator for running tests that require a functional bind() for Unix + sockets. + + +.. decorator:: anticipate_failure(condition) + + A decorator to conditionally mark tests with + :func:`unittest.expectedFailure`. Any use of this decorator should + have an associated comment identifying the relevant tracker issue. + + +.. decorator:: run_with_locale(catstr, *locales) + + A decorator for running a function in a different locale, correctly + resetting it after it has finished. *catstr* is the locale category as + a string (for example ``"LC_ALL"``). The *locales* passed will be tried + sequentially, and the first valid locale will be used. + + +.. decorator:: run_with_tz(tz) + + A decorator for running a function in a specific timezone, correctly + resetting it after it has finished. + + +.. decorator:: requires_freebsd_version(*min_version) + + Decorator for the minimum version when running test on FreeBSD. If the + FreeBSD version is less than the minimum, raise :exc:`unittest.SkipTest`. + + +.. decorator:: requires_linux_version(*min_version) + + Decorator for the minimum version when running test on Linux. If the + Linux version is less than the minimum, raise :exc:`unittest.SkipTest`. + + +.. decorator:: requires_mac_version(*min_version) + + Decorator for the minimum version when running test on Mac OS X. If the + MAC OS X version is less than the minimum, raise :exc:`unittest.SkipTest`. + + +.. decorator:: requires_IEEE_754 + + Decorator for skipping tests on non-IEEE 754 platforms. + + +.. decorator:: requires_zlib + + Decorator for skipping tests if :mod:`zlib` doesn't exist. + + +.. decorator:: requires_gzip + + Decorator for skipping tests if :mod:`gzip` doesn't exist. + + +.. decorator:: requires_bz2 + + Decorator for skipping tests if :mod:`bz2` doesn't exist. + + +.. decorator:: requires_lzma + + Decorator for skipping tests if :mod:`lzma` doesn't exist. + + +.. decorator:: requires_resource(resource) + + Decorator for skipping tests if *resource* is not available. + + +.. decorator:: requires_docstrings + + Decorator for only running the test if :data:`HAVE_DOCSTRINGS`. + + +.. decorator:: cpython_only(test) + + Decorator for tests only applicable to CPython. + + +.. decorator:: impl_detail(msg=None, **guards) + + Decorator for invoking :func:`check_impl_detail` on *guards*. If that + returns ``False``, then uses *msg* as the reason for skipping the test. + + +.. decorator:: no_tracing(func) + + Decorator to temporarily turn off tracing for the duration of the test. + + +.. decorator:: refcount_test(test) + + Decorator for tests which involve reference counting. The decorator does + not run the test if it is not run by CPython. Any trace function is unset + for the duration of the test to prevent unexpected refcounts caused by + the trace function. + + +.. decorator:: reap_threads(func) + + Decorator to ensure the threads are cleaned up even if the test fails. + + +.. decorator:: bigmemtest(size, memuse, dry_run=True) + + Decorator for bigmem tests. + + *size* is a requested size for the test (in arbitrary, test-interpreted + units.) *memuse* is the number of bytes per unit for the test, or a good + estimate of it. For example, a test that needs two byte buffers, of 4 GiB + each, could be decorated with ``@bigmemtest(size=_4G, memuse=2)``. + + The *size* argument is normally passed to the decorated test method as an + extra argument. If *dry_run* is ``True``, the value passed to the test + method may be less than the requested value. If *dry_run* is ``False``, it + means the test doesn't support dummy runs when ``-M`` is not specified. + + +.. decorator:: bigaddrspacetest(f) + + Decorator for tests that fill the address space. *f* is the function to + wrap. + + +.. function:: make_bad_fd() + + Create an invalid file descriptor by opening and closing a temporary file, + and returning its descriptor. + + +.. function:: check_syntax_error(testcase, statement, errtext='', *, lineno=None, offset=None) + + Test for syntax errors in *statement* by attempting to compile *statement*. + *testcase* is the :mod:`unittest` instance for the test. *errtext* is the + text of the error raised by :exc:`SyntaxError`. If *lineno* is not None, + compares to the line of the :exc:`SyntaxError`. If *offset* is not None, + compares to the offset of the :exc:`SyntaxError`. + + +.. function:: open_urlresource(url, *args, **kw) + + Open *url*. If open fails, raises :exc:`TestFailed`. + + +.. function:: import_module(name, deprecated=False, *, required_on()) + + This function imports and returns the named module. Unlike a normal + import, this function raises :exc:`unittest.SkipTest` if the module + cannot be imported. + + Module and package deprecation messages are suppressed during this import + if *deprecated* is ``True``. If a module is required on a platform but + optional for others, set *required_on* to an iterable of platform prefixes + which will be compared against :data:`sys.platform`. + + .. versionadded:: 3.1 + + +.. function:: import_fresh_module(name, fresh=(), blocked=(), deprecated=False) + + This function imports and returns a fresh copy of the named Python module + by removing the named module from ``sys.modules`` before doing the import. + Note that unlike :func:`reload`, the original module is not affected by + this operation. + + *fresh* is an iterable of additional module names that are also removed + from the ``sys.modules`` cache before doing the import. + + *blocked* is an iterable of module names that are replaced with ``None`` + in the module cache during the import to ensure that attempts to import + them raise :exc:`ImportError`. + + The named module and any modules named in the *fresh* and *blocked* + parameters are saved before starting the import and then reinserted into + ``sys.modules`` when the fresh import is complete. + + Module and package deprecation messages are suppressed during this import + if *deprecated* is ``True``. + + This function will raise :exc:`ImportError` if the named module cannot be + imported. + + Example use:: + + # Get copies of the warnings module for testing without affecting the + # version being used by the rest of the test suite. One copy uses the + # C implementation, the other is forced to use the pure Python fallback + # implementation + py_warnings = import_fresh_module('warnings', blocked=['_warnings']) + c_warnings = import_fresh_module('warnings', fresh=['_warnings']) + + .. versionadded:: 3.1 + + +.. function:: modules_setup() + + Return a copy of :data:`sys.modules`. + + +.. function:: modules_cleanup(oldmodules) + + Remove modules except for *oldmodules* and ``encodings`` in order to + preserve internal cache. + + +.. function:: threading_setup() + + Return current thread count and copy of dangling threads. + + +.. function:: threading_cleanup(*original_values) + + Cleanup up threads not specified in *original_values*. Designed to emit + a warning if a test leaves running threads in the background. + + +.. function:: join_thread(thread, timeout=30.0) + + Join a *thread* within *timeout*. Raise an :exc:`AssertionError` if thread + is still alive after *timeout* seconds. + + +.. function:: reap_children() + + Use this at the end of ``test_main`` whenever sub-processes are started. + This will help ensure that no extra children (zombies) stick around to + hog resources and create problems when looking for refleaks. + + +.. function:: get_attribute(obj, name) + + Get an attribute, raising :exc:`unittest.SkipTest` if :exc:`AttributeError` + is raised. + + +.. function:: bind_port(sock, host=HOST) + + Bind the socket to a free port and return the port number. Relies on + ephemeral ports in order to ensure we are using an unbound port. This is + important as many tests may be running simultaneously, especially in a + buildbot environment. This method raises an exception if the + ``sock.family`` is :const:`~socket.AF_INET` and ``sock.type`` is + :const:`~socket.SOCK_STREAM`, and the socket has + :const:`~socket.SO_REUSEADDR` or :const:`~socket.SO_REUSEPORT` set on it. + Tests should never set these socket options for TCP/IP sockets. + The only case for setting these options is testing multicasting via + multiple UDP sockets. + + Additionally, if the :const:`~socket.SO_EXCLUSIVEADDRUSE` socket option is + available (i.e. on Windows), it will be set on the socket. This will + prevent anyone else from binding to our host/port for the duration of the + test. + + +.. function:: bind_unix_socket(sock, addr) + + Bind a unix socket, raising :exc:`unittest.SkipTest` if + :exc:`PermissionError` is raised. + + +.. function:: find_unused_port(family=socket.AF_INET, socktype=socket.SOCK_STREAM) + + Returns an unused port that should be suitable for binding. This is + achieved by creating a temporary socket with the same family and type as + the ``sock`` parameter (default is :const:`~socket.AF_INET`, + :const:`~socket.SOCK_STREAM`), + and binding it to the specified host address (defaults to ``0.0.0.0``) + with the port set to 0, eliciting an unused ephemeral port from the OS. + The temporary socket is then closed and deleted, and the ephemeral port is + returned. + + Either this method or :func:`bind_port` should be used for any tests + where a server socket needs to be bound to a particular port for the + duration of the test. + Which one to use depends on whether the calling code is creating a Python + socket, or if an unused port needs to be provided in a constructor + or passed to an external program (i.e. the ``-accept`` argument to + openssl's s_server mode). Always prefer :func:`bind_port` over + :func:`find_unused_port` where possible. Using a hard coded port is + discouraged since it can make multiple instances of the test impossible to + run simultaneously, which is a problem for buildbots. + + +.. function:: load_package_tests(pkg_dir, loader, standard_tests, pattern) + + Generic implementation of the :mod:`unittest` ``load_tests`` protocol for + use in test packages. *pkg_dir* is the root directory of the package; + *loader*, *standard_tests*, and *pattern* are the arguments expected by + ``load_tests``. In simple cases, the test package's ``__init__.py`` + can be the following:: + + import os + from test.support import load_package_tests + + def load_tests(*args): + return load_package_tests(os.path.dirname(__file__), *args) + + +.. function:: fs_is_case_insensitive(directory) + + Return ``True`` if the file system for *directory* is case-insensitive. + + +.. function:: detect_api_mismatch(ref_api, other_api, *, ignore=()) + + Returns the set of attributes, functions or methods of *ref_api* not + found on *other_api*, except for a defined list of items to be + ignored in this check specified in *ignore*. + + By default this skips private attributes beginning with '_' but + includes all magic methods, i.e. those starting and ending in '__'. + + .. versionadded:: 3.5 + + +.. function:: patch(test_instance, object_to_patch, attr_name, new_value) + + Override *object_to_patch.attr_name* with *new_value*. Also add + cleanup procedure to *test_instance* to restore *object_to_patch* for + *attr_name*. The *attr_name* should be a valid attribute for + *object_to_patch*. + + +.. function:: run_in_subinterp(code) + + Run *code* in subinterpreter. Raise :exc:`unittest.SkipTest` if + :mod:`tracemalloc` is enabled. + + +.. function:: check_free_after_iterating(test, iter, cls, args=()) + + Assert that *iter* is deallocated after iterating. + + +.. function:: missing_compiler_executable(cmd_names=[]) + + Check for the existence of the compiler executables whose names are listed + in *cmd_names* or all the compiler executables when *cmd_names* is empty + and return the first missing executable or ``None`` when none is found + missing. + + +.. function:: check__all__(test_case, module, name_of_module=None, extra=(), blacklist=()) + + Assert that the ``__all__`` variable of *module* contains all public names. + + The module's public names (its API) are detected automatically + based on whether they match the public name convention and were defined in + *module*. + + The *name_of_module* argument can specify (as a string or tuple thereof) what + module(s) an API could be defined in order to be detected as a public + API. One case for this is when *module* imports part of its public API from + other modules, possibly a C backend (like ``csv`` and its ``_csv``). + + The *extra* argument can be a set of names that wouldn't otherwise be automatically + detected as "public", like objects without a proper ``__module__`` + attribute. If provided, it will be added to the automatically detected ones. + + The *blacklist* argument can be a set of names that must not be treated as part of + the public API even though their names indicate otherwise. + + Example use:: + + import bar + import foo + import unittest + from test import support + + class MiscTestCase(unittest.TestCase): + def test__all__(self): + support.check__all__(self, foo) + + class OtherTestCase(unittest.TestCase): + def test__all__(self): + extra = {'BAR_CONST', 'FOO_CONST'} + blacklist = {'baz'} # Undocumented name. + # bar imports part of its API from _bar. + support.check__all__(self, bar, ('bar', '_bar'), + extra=extra, blacklist=blacklist) + + .. versionadded:: 3.6 + + +The :mod:`test.support` module defines the following classes: + +.. class:: TransientResource(exc, **kwargs) + + Instances are a context manager that raises :exc:`ResourceDenied` if the + specified exception type is raised. Any keyword arguments are treated as + attribute/value pairs to be compared against any exception raised within the + :keyword:`with` statement. Only if all pairs match properly against + attributes on the exception is :exc:`ResourceDenied` raised. + + +.. class:: EnvironmentVarGuard() + + Class used to temporarily set or unset environment variables. Instances can + be used as a context manager and have a complete dictionary interface for + querying/modifying the underlying ``os.environ``. After exit from the + context manager all changes to environment variables done through this + instance will be rolled back. + + .. versionchanged:: 3.1 + Added dictionary interface. + +.. method:: EnvironmentVarGuard.set(envvar, value) + + Temporarily set the environment variable ``envvar`` to the value of + ``value``. + + +.. method:: EnvironmentVarGuard.unset(envvar) + + Temporarily unset the environment variable ``envvar``. + + +.. class:: SuppressCrashReport() + + A context manager used to try to prevent crash dialog popups on tests that + are expected to crash a subprocess. + + On Windows, it disables Windows Error Reporting dialogs using + `SetErrorMode `_. + + On UNIX, :func:`resource.setrlimit` is used to set + :attr:`resource.RLIMIT_CORE`'s soft limit to 0 to prevent coredump file + creation. + + On both platforms, the old value is restored by :meth:`__exit__`. + + +.. class:: CleanImport(*module_names) + + A context manager to force import to return a new module reference. This + is useful for testing module-level behaviors, such as the emission of a + DeprecationWarning on import. Example usage:: + + with CleanImport('foo'): + importlib.import_module('foo') # New reference. + + +.. class:: DirsOnSysPath(*paths) + + A context manager to temporarily add directories to sys.path. + + This makes a copy of :data:`sys.path`, appends any directories given + as positional arguments, then reverts :data:`sys.path` to the copied + settings when the context ends. + + Note that *all* :data:`sys.path` modifications in the body of the + context manager, including replacement of the object, + will be reverted at the end of the block. + + +.. class:: SaveSignals() + + Class to save and restore signal handlers registered by the Python signal + handler. + + +.. class:: Matcher() + + .. method:: matches(self, d, **kwargs) + + Try to match a single dict with the supplied arguments. + + + .. method:: match_value(self, k, dv, v) + + Try to match a single stored value (*dv*) with a supplied value (*v*). + + +.. class:: WarningsRecorder() + + Class used to record warnings for unit tests. See documentation of + :func:`check_warnings` above for more details. + + +.. class:: BasicTestRunner() + + .. method:: run(test) + + Run *test* and return the result. + + +.. class:: TestHandler(logging.handlers.BufferingHandler) + + Class for logging support. + + +.. class:: FakePath(path) + + Simple :term:`path-like object`. It implements the :meth:`__fspath__` + method which just returns the *path* argument. If *path* is an exception, + it will be raised in :meth:`!__fspath__`. + + +:mod:`test.support.script_helper` --- Utilities for the Python execution tests +============================================================================== + +.. module:: test.support.script_helper + :synopsis: Support for Python's script execution tests. + + +The :mod:`test.support.script_helper` module provides support for Python's +script execution tests. + +.. function:: interpreter_requires_environment() + + Return ``True`` if ``sys.executable interpreter`` requires environment + variables in order to be able to run at all. + + This is designed to be used with ``@unittest.skipIf()`` to annotate tests + that need to use an ``assert_python*()`` function to launch an isolated + mode (``-I``) or no environment mode (``-E``) sub-interpreter process. + + A normal build & test does not run into this situation but it can happen + when trying to run the standard library test suite from an interpreter that + doesn't have an obvious home with Python's current home finding logic. + + Setting :envvar:`PYTHONHOME` is one way to get most of the testsuite to run + in that situation. :envvar:`PYTHONPATH` or :envvar:`PYTHONUSERSITE` are + other common environment variables that might impact whether or not the + interpreter can start. + + +.. function:: run_python_until_end(*args, **env_vars) + + Set up the environment based on *env_vars* for running the interpreter + in a subprocess. The values can include ``__isolated``, ``__cleanenv``, + ``__cwd``, and ``TERM``. + + +.. function:: assert_python_ok(*args, **env_vars) + + Assert that running the interpreter with *args* and optional environment + variables *env_vars* succeeds (``rc == 0``) and return a ``(return code, + stdout, stderr)`` tuple. + + If the ``__cleanenv`` keyword is set, *env_vars* is used as a fresh + environment. + + Python is started in isolated mode (command line option ``-I``), + except if the ``__isolated`` keyword is set to ``False``. + + +.. function:: assert_python_failure(*args, **env_vars) + + Assert that running the interpreter with *args* and optional environment + variables *env_vars* fails (``rc != 0``) and return a ``(return code, + stdout, stderr)`` tuple. + + See :func:`assert_python_ok` for more options. + + +.. function:: spawn_python(*args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, **kw) + + Run a Python subprocess with the given arguments. + + *kw* is extra keyword args to pass to :func:`subprocess.Popen`. Returns a + :class:`subprocess.Popen` object. + + +.. function:: kill_python(p) + + Run the given :class:`subprocess.Popen` process until completion and return + stdout. + + +.. function:: make_script(script_dir, script_basename, source, omit_suffix=False) + + Create script containing *source* in path *script_dir* and *script_basename*. + If *omit_suffix* is ``False``, append ``.py`` to the name. Return the full + script path. + + +.. function:: make_zip_script(zip_dir, zip_basename, script_name, name_in_zip=None) + + Create zip file at *zip_dir* and *zip_basename* with extension ``zip`` which + contains the files in *script_name*. *name_in_zip* is the archive name. + Return a tuple containing ``(full path, full path of archive name)``. + + +.. function:: make_pkg(pkg_dir, init_source='') + + Create a directory named *pkg_dir* containing an ``__init__`` file with + *init_source* as its contents. + + +.. function:: make_zip_pkg(zip_dir, zip_basename, pkg_name, script_basename, \ + source, depth=1, compiled=False) + + Create a zip package directory with a path of *zip_dir* and *zip_basename* + containing an empty ``__init__`` file and a file *script_basename* + containing the *source*. If *compiled* is ``True``, both source files will + be compiled and added to the zip package. Return a tuple of the full zip + path and the archive name for the zip file. diff --git a/python-3.7.4-docs-html/_sources/library/text.rst.txt b/python-3.7.4-docs-html/_sources/library/text.rst.txt new file mode 100644 index 0000000..47b6784 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/text.rst.txt @@ -0,0 +1,26 @@ +.. _stringservices: +.. _textservices: + +************************ +Text Processing Services +************************ + +The modules described in this chapter provide a wide range of string +manipulation operations and other text processing services. + +The :mod:`codecs` module described under :ref:`binaryservices` is also +highly relevant to text processing. In addition, see the documentation for +Python's built-in string type in :ref:`textseq`. + + +.. toctree:: + + string.rst + re.rst + difflib.rst + textwrap.rst + unicodedata.rst + stringprep.rst + readline.rst + rlcompleter.rst + diff --git a/python-3.7.4-docs-html/_sources/library/textwrap.rst.txt b/python-3.7.4-docs-html/_sources/library/textwrap.rst.txt new file mode 100644 index 0000000..0f11ef4 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/textwrap.rst.txt @@ -0,0 +1,299 @@ +:mod:`textwrap` --- Text wrapping and filling +============================================= + +.. module:: textwrap + :synopsis: Text wrapping and filling + +.. moduleauthor:: Greg Ward +.. sectionauthor:: Greg Ward + +**Source code:** :source:`Lib/textwrap.py` + +-------------- + +The :mod:`textwrap` module provides some convenience functions, +as well as :class:`TextWrapper`, the class that does all the work. +If you're just wrapping or filling one or two text strings, the convenience +functions should be good enough; otherwise, you should use an instance of +:class:`TextWrapper` for efficiency. + +.. function:: wrap(text, width=70, **kwargs) + + Wraps the single paragraph in *text* (a string) so every line is at most + *width* characters long. Returns a list of output lines, without final + newlines. + + Optional keyword arguments correspond to the instance attributes of + :class:`TextWrapper`, documented below. *width* defaults to ``70``. + + See the :meth:`TextWrapper.wrap` method for additional details on how + :func:`wrap` behaves. + + +.. function:: fill(text, width=70, **kwargs) + + Wraps the single paragraph in *text*, and returns a single string containing the + wrapped paragraph. :func:`fill` is shorthand for :: + + "\n".join(wrap(text, ...)) + + In particular, :func:`fill` accepts exactly the same keyword arguments as + :func:`wrap`. + + +.. function:: shorten(text, width, **kwargs) + + Collapse and truncate the given *text* to fit in the given *width*. + + First the whitespace in *text* is collapsed (all whitespace is replaced by + single spaces). If the result fits in the *width*, it is returned. + Otherwise, enough words are dropped from the end so that the remaining words + plus the :attr:`placeholder` fit within :attr:`width`:: + + >>> textwrap.shorten("Hello world!", width=12) + 'Hello world!' + >>> textwrap.shorten("Hello world!", width=11) + 'Hello [...]' + >>> textwrap.shorten("Hello world", width=10, placeholder="...") + 'Hello...' + + Optional keyword arguments correspond to the instance attributes of + :class:`TextWrapper`, documented below. Note that the whitespace is + collapsed before the text is passed to the :class:`TextWrapper` :meth:`fill` + function, so changing the value of :attr:`.tabsize`, :attr:`.expand_tabs`, + :attr:`.drop_whitespace`, and :attr:`.replace_whitespace` will have no effect. + + .. versionadded:: 3.4 + + +.. function:: dedent(text) + + Remove any common leading whitespace from every line in *text*. + + This can be used to make triple-quoted strings line up with the left edge of the + display, while still presenting them in the source code in indented form. + + Note that tabs and spaces are both treated as whitespace, but they are not + equal: the lines ``" hello"`` and ``"\thello"`` are considered to have no + common leading whitespace. + + Lines containing only whitespace are ignored in the input and normalized to a + single newline character in the output. + + For example:: + + def test(): + # end first line with \ to avoid the empty line! + s = '''\ + hello + world + ''' + print(repr(s)) # prints ' hello\n world\n ' + print(repr(dedent(s))) # prints 'hello\n world\n' + + +.. function:: indent(text, prefix, predicate=None) + + Add *prefix* to the beginning of selected lines in *text*. + + Lines are separated by calling ``text.splitlines(True)``. + + By default, *prefix* is added to all lines that do not consist + solely of whitespace (including any line endings). + + For example:: + + >>> s = 'hello\n\n \nworld' + >>> indent(s, ' ') + ' hello\n\n \n world' + + The optional *predicate* argument can be used to control which lines + are indented. For example, it is easy to add *prefix* to even empty + and whitespace-only lines:: + + >>> print(indent(s, '+ ', lambda line: True)) + + hello + + + + + + world + + .. versionadded:: 3.3 + + +:func:`wrap`, :func:`fill` and :func:`shorten` work by creating a +:class:`TextWrapper` instance and calling a single method on it. That +instance is not reused, so for applications that process many text +strings using :func:`wrap` and/or :func:`fill`, it may be more efficient to +create your own :class:`TextWrapper` object. + +Text is preferably wrapped on whitespaces and right after the hyphens in +hyphenated words; only then will long words be broken if necessary, unless +:attr:`TextWrapper.break_long_words` is set to false. + +.. class:: TextWrapper(**kwargs) + + The :class:`TextWrapper` constructor accepts a number of optional keyword + arguments. Each keyword argument corresponds to an instance attribute, so + for example :: + + wrapper = TextWrapper(initial_indent="* ") + + is the same as :: + + wrapper = TextWrapper() + wrapper.initial_indent = "* " + + You can re-use the same :class:`TextWrapper` object many times, and you can + change any of its options through direct assignment to instance attributes + between uses. + + The :class:`TextWrapper` instance attributes (and keyword arguments to the + constructor) are as follows: + + + .. attribute:: width + + (default: ``70``) The maximum length of wrapped lines. As long as there + are no individual words in the input text longer than :attr:`width`, + :class:`TextWrapper` guarantees that no output line will be longer than + :attr:`width` characters. + + + .. attribute:: expand_tabs + + (default: ``True``) If true, then all tab characters in *text* will be + expanded to spaces using the :meth:`expandtabs` method of *text*. + + + .. attribute:: tabsize + + (default: ``8``) If :attr:`expand_tabs` is true, then all tab characters + in *text* will be expanded to zero or more spaces, depending on the + current column and the given tab size. + + .. versionadded:: 3.3 + + + .. attribute:: replace_whitespace + + (default: ``True``) If true, after tab expansion but before wrapping, + the :meth:`wrap` method will replace each whitespace character + with a single space. The whitespace characters replaced are + as follows: tab, newline, vertical tab, formfeed, and carriage + return (``'\t\n\v\f\r'``). + + .. note:: + + If :attr:`expand_tabs` is false and :attr:`replace_whitespace` is true, + each tab character will be replaced by a single space, which is *not* + the same as tab expansion. + + .. note:: + + If :attr:`replace_whitespace` is false, newlines may appear in the + middle of a line and cause strange output. For this reason, text should + be split into paragraphs (using :meth:`str.splitlines` or similar) + which are wrapped separately. + + + .. attribute:: drop_whitespace + + (default: ``True``) If true, whitespace at the beginning and ending of + every line (after wrapping but before indenting) is dropped. + Whitespace at the beginning of the paragraph, however, is not dropped + if non-whitespace follows it. If whitespace being dropped takes up an + entire line, the whole line is dropped. + + + .. attribute:: initial_indent + + (default: ``''``) String that will be prepended to the first line of + wrapped output. Counts towards the length of the first line. The empty + string is not indented. + + + .. attribute:: subsequent_indent + + (default: ``''``) String that will be prepended to all lines of wrapped + output except the first. Counts towards the length of each line except + the first. + + + .. attribute:: fix_sentence_endings + + (default: ``False``) If true, :class:`TextWrapper` attempts to detect + sentence endings and ensure that sentences are always separated by exactly + two spaces. This is generally desired for text in a monospaced font. + However, the sentence detection algorithm is imperfect: it assumes that a + sentence ending consists of a lowercase letter followed by one of ``'.'``, + ``'!'``, or ``'?'``, possibly followed by one of ``'"'`` or ``"'"``, + followed by a space. One problem with this is algorithm is that it is + unable to detect the difference between "Dr." in :: + + [...] Dr. Frankenstein's monster [...] + + and "Spot." in :: + + [...] See Spot. See Spot run [...] + + :attr:`fix_sentence_endings` is false by default. + + Since the sentence detection algorithm relies on ``string.lowercase`` for + the definition of "lowercase letter," and a convention of using two spaces + after a period to separate sentences on the same line, it is specific to + English-language texts. + + + .. attribute:: break_long_words + + (default: ``True``) If true, then words longer than :attr:`width` will be + broken in order to ensure that no lines are longer than :attr:`width`. If + it is false, long words will not be broken, and some lines may be longer + than :attr:`width`. (Long words will be put on a line by themselves, in + order to minimize the amount by which :attr:`width` is exceeded.) + + + .. attribute:: break_on_hyphens + + (default: ``True``) If true, wrapping will occur preferably on whitespaces + and right after hyphens in compound words, as it is customary in English. + If false, only whitespaces will be considered as potentially good places + for line breaks, but you need to set :attr:`break_long_words` to false if + you want truly insecable words. Default behaviour in previous versions + was to always allow breaking hyphenated words. + + + .. attribute:: max_lines + + (default: ``None``) If not ``None``, then the output will contain at most + *max_lines* lines, with *placeholder* appearing at the end of the output. + + .. versionadded:: 3.4 + + + .. index:: single: ...; placeholder + + .. attribute:: placeholder + + (default: ``' [...]'``) String that will appear at the end of the output + text if it has been truncated. + + .. versionadded:: 3.4 + + + :class:`TextWrapper` also provides some public methods, analogous to the + module-level convenience functions: + + .. method:: wrap(text) + + Wraps the single paragraph in *text* (a string) so every line is at most + :attr:`width` characters long. All wrapping options are taken from + instance attributes of the :class:`TextWrapper` instance. Returns a list + of output lines, without final newlines. If the wrapped output has no + content, the returned list is empty. + + + .. method:: fill(text) + + Wraps the single paragraph in *text*, and returns a single string + containing the wrapped paragraph. diff --git a/python-3.7.4-docs-html/_sources/library/threading.rst.txt b/python-3.7.4-docs-html/_sources/library/threading.rst.txt new file mode 100644 index 0000000..c58a6ad --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/threading.rst.txt @@ -0,0 +1,998 @@ +:mod:`threading` --- Thread-based parallelism +============================================= + +.. module:: threading + :synopsis: Thread-based parallelism. + +**Source code:** :source:`Lib/threading.py` + +-------------- + +This module constructs higher-level threading interfaces on top of the lower +level :mod:`_thread` module. See also the :mod:`queue` module. + +.. versionchanged:: 3.7 + This module used to be optional, it is now always available. + +.. note:: + + While they are not listed below, the ``camelCase`` names used for some + methods and functions in this module in the Python 2.x series are still + supported by this module. + + +This module defines the following functions: + + +.. function:: active_count() + + Return the number of :class:`Thread` objects currently alive. The returned + count is equal to the length of the list returned by :func:`.enumerate`. + + +.. function:: current_thread() + + Return the current :class:`Thread` object, corresponding to the caller's thread + of control. If the caller's thread of control was not created through the + :mod:`threading` module, a dummy thread object with limited functionality is + returned. + + +.. function:: get_ident() + + Return the 'thread identifier' of the current thread. This is a nonzero + integer. Its value has no direct meaning; it is intended as a magic cookie + to be used e.g. to index a dictionary of thread-specific data. Thread + identifiers may be recycled when a thread exits and another thread is + created. + + .. versionadded:: 3.3 + + +.. function:: enumerate() + + Return a list of all :class:`Thread` objects currently alive. The list + includes daemonic threads, dummy thread objects created by + :func:`current_thread`, and the main thread. It excludes terminated threads + and threads that have not yet been started. + + +.. function:: main_thread() + + Return the main :class:`Thread` object. In normal conditions, the + main thread is the thread from which the Python interpreter was + started. + + .. versionadded:: 3.4 + + +.. function:: settrace(func) + + .. index:: single: trace function + + Set a trace function for all threads started from the :mod:`threading` module. + The *func* will be passed to :func:`sys.settrace` for each thread, before its + :meth:`~Thread.run` method is called. + + +.. function:: setprofile(func) + + .. index:: single: profile function + + Set a profile function for all threads started from the :mod:`threading` module. + The *func* will be passed to :func:`sys.setprofile` for each thread, before its + :meth:`~Thread.run` method is called. + + +.. function:: stack_size([size]) + + Return the thread stack size used when creating new threads. The optional + *size* argument specifies the stack size to be used for subsequently created + threads, and must be 0 (use platform or configured default) or a positive + integer value of at least 32,768 (32 KiB). If *size* is not specified, + 0 is used. If changing the thread stack size is + unsupported, a :exc:`RuntimeError` is raised. If the specified stack size is + invalid, a :exc:`ValueError` is raised and the stack size is unmodified. 32 KiB + is currently the minimum supported stack size value to guarantee sufficient + stack space for the interpreter itself. Note that some platforms may have + particular restrictions on values for the stack size, such as requiring a + minimum stack size > 32 KiB or requiring allocation in multiples of the system + memory page size - platform documentation should be referred to for more + information (4 KiB pages are common; using multiples of 4096 for the stack size is + the suggested approach in the absence of more specific information). + + .. availability:: Windows, systems with POSIX threads. + + +This module also defines the following constant: + +.. data:: TIMEOUT_MAX + + The maximum value allowed for the *timeout* parameter of blocking functions + (:meth:`Lock.acquire`, :meth:`RLock.acquire`, :meth:`Condition.wait`, etc.). + Specifying a timeout greater than this value will raise an + :exc:`OverflowError`. + + .. versionadded:: 3.2 + + +This module defines a number of classes, which are detailed in the sections +below. + +The design of this module is loosely based on Java's threading model. However, +where Java makes locks and condition variables basic behavior of every object, +they are separate objects in Python. Python's :class:`Thread` class supports a +subset of the behavior of Java's Thread class; currently, there are no +priorities, no thread groups, and threads cannot be destroyed, stopped, +suspended, resumed, or interrupted. The static methods of Java's Thread class, +when implemented, are mapped to module-level functions. + +All of the methods described below are executed atomically. + + +Thread-Local Data +----------------- + +Thread-local data is data whose values are thread specific. To manage +thread-local data, just create an instance of :class:`local` (or a +subclass) and store attributes on it:: + + mydata = threading.local() + mydata.x = 1 + +The instance's values will be different for separate threads. + + +.. class:: local() + + A class that represents thread-local data. + + For more details and extensive examples, see the documentation string of the + :mod:`_threading_local` module. + + +.. _thread-objects: + +Thread Objects +-------------- + +The :class:`Thread` class represents an activity that is run in a separate +thread of control. There are two ways to specify the activity: by passing a +callable object to the constructor, or by overriding the :meth:`~Thread.run` +method in a subclass. No other methods (except for the constructor) should be +overridden in a subclass. In other words, *only* override the +:meth:`~Thread.__init__` and :meth:`~Thread.run` methods of this class. + +Once a thread object is created, its activity must be started by calling the +thread's :meth:`~Thread.start` method. This invokes the :meth:`~Thread.run` +method in a separate thread of control. + +Once the thread's activity is started, the thread is considered 'alive'. It +stops being alive when its :meth:`~Thread.run` method terminates -- either +normally, or by raising an unhandled exception. The :meth:`~Thread.is_alive` +method tests whether the thread is alive. + +Other threads can call a thread's :meth:`~Thread.join` method. This blocks +the calling thread until the thread whose :meth:`~Thread.join` method is +called is terminated. + +A thread has a name. The name can be passed to the constructor, and read or +changed through the :attr:`~Thread.name` attribute. + +A thread can be flagged as a "daemon thread". The significance of this flag is +that the entire Python program exits when only daemon threads are left. The +initial value is inherited from the creating thread. The flag can be set +through the :attr:`~Thread.daemon` property or the *daemon* constructor +argument. + +.. note:: + Daemon threads are abruptly stopped at shutdown. Their resources (such + as open files, database transactions, etc.) may not be released properly. + If you want your threads to stop gracefully, make them non-daemonic and + use a suitable signalling mechanism such as an :class:`Event`. + +There is a "main thread" object; this corresponds to the initial thread of +control in the Python program. It is not a daemon thread. + +There is the possibility that "dummy thread objects" are created. These are +thread objects corresponding to "alien threads", which are threads of control +started outside the threading module, such as directly from C code. Dummy +thread objects have limited functionality; they are always considered alive and +daemonic, and cannot be :meth:`~Thread.join`\ ed. They are never deleted, +since it is impossible to detect the termination of alien threads. + + +.. class:: Thread(group=None, target=None, name=None, args=(), kwargs={}, *, \ + daemon=None) + + This constructor should always be called with keyword arguments. Arguments + are: + + *group* should be ``None``; reserved for future extension when a + :class:`ThreadGroup` class is implemented. + + *target* is the callable object to be invoked by the :meth:`run` method. + Defaults to ``None``, meaning nothing is called. + + *name* is the thread name. By default, a unique name is constructed of the + form "Thread-*N*" where *N* is a small decimal number. + + *args* is the argument tuple for the target invocation. Defaults to ``()``. + + *kwargs* is a dictionary of keyword arguments for the target invocation. + Defaults to ``{}``. + + If not ``None``, *daemon* explicitly sets whether the thread is daemonic. + If ``None`` (the default), the daemonic property is inherited from the + current thread. + + If the subclass overrides the constructor, it must make sure to invoke the + base class constructor (``Thread.__init__()``) before doing anything else to + the thread. + + .. versionchanged:: 3.3 + Added the *daemon* argument. + + .. method:: start() + + Start the thread's activity. + + It must be called at most once per thread object. It arranges for the + object's :meth:`~Thread.run` method to be invoked in a separate thread + of control. + + This method will raise a :exc:`RuntimeError` if called more than once + on the same thread object. + + .. method:: run() + + Method representing the thread's activity. + + You may override this method in a subclass. The standard :meth:`run` + method invokes the callable object passed to the object's constructor as + the *target* argument, if any, with positional and keyword arguments taken + from the *args* and *kwargs* arguments, respectively. + + .. method:: join(timeout=None) + + Wait until the thread terminates. This blocks the calling thread until + the thread whose :meth:`~Thread.join` method is called terminates -- either + normally or through an unhandled exception -- or until the optional + timeout occurs. + + When the *timeout* argument is present and not ``None``, it should be a + floating point number specifying a timeout for the operation in seconds + (or fractions thereof). As :meth:`~Thread.join` always returns ``None``, + you must call :meth:`~Thread.is_alive` after :meth:`~Thread.join` to + decide whether a timeout happened -- if the thread is still alive, the + :meth:`~Thread.join` call timed out. + + When the *timeout* argument is not present or ``None``, the operation will + block until the thread terminates. + + A thread can be :meth:`~Thread.join`\ ed many times. + + :meth:`~Thread.join` raises a :exc:`RuntimeError` if an attempt is made + to join the current thread as that would cause a deadlock. It is also + an error to :meth:`~Thread.join` a thread before it has been started + and attempts to do so raise the same exception. + + .. attribute:: name + + A string used for identification purposes only. It has no semantics. + Multiple threads may be given the same name. The initial name is set by + the constructor. + + .. method:: getName() + setName() + + Old getter/setter API for :attr:`~Thread.name`; use it directly as a + property instead. + + .. attribute:: ident + + The 'thread identifier' of this thread or ``None`` if the thread has not + been started. This is a nonzero integer. See the :func:`get_ident` + function. Thread identifiers may be recycled when a thread exits and + another thread is created. The identifier is available even after the + thread has exited. + + .. method:: is_alive() + + Return whether the thread is alive. + + This method returns ``True`` just before the :meth:`~Thread.run` method + starts until just after the :meth:`~Thread.run` method terminates. The + module function :func:`.enumerate` returns a list of all alive threads. + + .. attribute:: daemon + + A boolean value indicating whether this thread is a daemon thread (True) + or not (False). This must be set before :meth:`~Thread.start` is called, + otherwise :exc:`RuntimeError` is raised. Its initial value is inherited + from the creating thread; the main thread is not a daemon thread and + therefore all threads created in the main thread default to + :attr:`~Thread.daemon` = ``False``. + + The entire Python program exits when no alive non-daemon threads are left. + + .. method:: isDaemon() + setDaemon() + + Old getter/setter API for :attr:`~Thread.daemon`; use it directly as a + property instead. + + +.. impl-detail:: + + In CPython, due to the :term:`Global Interpreter Lock`, only one thread + can execute Python code at once (even though certain performance-oriented + libraries might overcome this limitation). + If you want your application to make better use of the computational + resources of multi-core machines, you are advised to use + :mod:`multiprocessing` or :class:`concurrent.futures.ProcessPoolExecutor`. + However, threading is still an appropriate model if you want to run + multiple I/O-bound tasks simultaneously. + + +.. _lock-objects: + +Lock Objects +------------ + +A primitive lock is a synchronization primitive that is not owned by a +particular thread when locked. In Python, it is currently the lowest level +synchronization primitive available, implemented directly by the :mod:`_thread` +extension module. + +A primitive lock is in one of two states, "locked" or "unlocked". It is created +in the unlocked state. It has two basic methods, :meth:`~Lock.acquire` and +:meth:`~Lock.release`. When the state is unlocked, :meth:`~Lock.acquire` +changes the state to locked and returns immediately. When the state is locked, +:meth:`~Lock.acquire` blocks until a call to :meth:`~Lock.release` in another +thread changes it to unlocked, then the :meth:`~Lock.acquire` call resets it +to locked and returns. The :meth:`~Lock.release` method should only be +called in the locked state; it changes the state to unlocked and returns +immediately. If an attempt is made to release an unlocked lock, a +:exc:`RuntimeError` will be raised. + +Locks also support the :ref:`context management protocol `. + +When more than one thread is blocked in :meth:`~Lock.acquire` waiting for the +state to turn to unlocked, only one thread proceeds when a :meth:`~Lock.release` +call resets the state to unlocked; which one of the waiting threads proceeds +is not defined, and may vary across implementations. + +All methods are executed atomically. + + +.. class:: Lock() + + The class implementing primitive lock objects. Once a thread has acquired a + lock, subsequent attempts to acquire it block, until it is released; any + thread may release it. + + Note that ``Lock`` is actually a factory function which returns an instance + of the most efficient version of the concrete Lock class that is supported + by the platform. + + + .. method:: acquire(blocking=True, timeout=-1) + + Acquire a lock, blocking or non-blocking. + + When invoked with the *blocking* argument set to ``True`` (the default), + block until the lock is unlocked, then set it to locked and return ``True``. + + When invoked with the *blocking* argument set to ``False``, do not block. + If a call with *blocking* set to ``True`` would block, return ``False`` + immediately; otherwise, set the lock to locked and return ``True``. + + When invoked with the floating-point *timeout* argument set to a positive + value, block for at most the number of seconds specified by *timeout* + and as long as the lock cannot be acquired. A *timeout* argument of ``-1`` + specifies an unbounded wait. It is forbidden to specify a *timeout* + when *blocking* is false. + + The return value is ``True`` if the lock is acquired successfully, + ``False`` if not (for example if the *timeout* expired). + + .. versionchanged:: 3.2 + The *timeout* parameter is new. + + .. versionchanged:: 3.2 + Lock acquisition can now be interrupted by signals on POSIX if the + underlying threading implementation supports it. + + + .. method:: release() + + Release a lock. This can be called from any thread, not only the thread + which has acquired the lock. + + When the lock is locked, reset it to unlocked, and return. If any other threads + are blocked waiting for the lock to become unlocked, allow exactly one of them + to proceed. + + When invoked on an unlocked lock, a :exc:`RuntimeError` is raised. + + There is no return value. + + +.. _rlock-objects: + +RLock Objects +------------- + +A reentrant lock is a synchronization primitive that may be acquired multiple +times by the same thread. Internally, it uses the concepts of "owning thread" +and "recursion level" in addition to the locked/unlocked state used by primitive +locks. In the locked state, some thread owns the lock; in the unlocked state, +no thread owns it. + +To lock the lock, a thread calls its :meth:`~RLock.acquire` method; this +returns once the thread owns the lock. To unlock the lock, a thread calls +its :meth:`~Lock.release` method. :meth:`~Lock.acquire`/:meth:`~Lock.release` +call pairs may be nested; only the final :meth:`~Lock.release` (the +:meth:`~Lock.release` of the outermost pair) resets the lock to unlocked and +allows another thread blocked in :meth:`~Lock.acquire` to proceed. + +Reentrant locks also support the :ref:`context management protocol `. + + +.. class:: RLock() + + This class implements reentrant lock objects. A reentrant lock must be + released by the thread that acquired it. Once a thread has acquired a + reentrant lock, the same thread may acquire it again without blocking; the + thread must release it once for each time it has acquired it. + + Note that ``RLock`` is actually a factory function which returns an instance + of the most efficient version of the concrete RLock class that is supported + by the platform. + + + .. method:: acquire(blocking=True, timeout=-1) + + Acquire a lock, blocking or non-blocking. + + When invoked without arguments: if this thread already owns the lock, increment + the recursion level by one, and return immediately. Otherwise, if another + thread owns the lock, block until the lock is unlocked. Once the lock is + unlocked (not owned by any thread), then grab ownership, set the recursion level + to one, and return. If more than one thread is blocked waiting until the lock + is unlocked, only one at a time will be able to grab ownership of the lock. + There is no return value in this case. + + When invoked with the *blocking* argument set to true, do the same thing as when + called without arguments, and return true. + + When invoked with the *blocking* argument set to false, do not block. If a call + without an argument would block, return false immediately; otherwise, do the + same thing as when called without arguments, and return true. + + When invoked with the floating-point *timeout* argument set to a positive + value, block for at most the number of seconds specified by *timeout* + and as long as the lock cannot be acquired. Return true if the lock has + been acquired, false if the timeout has elapsed. + + .. versionchanged:: 3.2 + The *timeout* parameter is new. + + + .. method:: release() + + Release a lock, decrementing the recursion level. If after the decrement it is + zero, reset the lock to unlocked (not owned by any thread), and if any other + threads are blocked waiting for the lock to become unlocked, allow exactly one + of them to proceed. If after the decrement the recursion level is still + nonzero, the lock remains locked and owned by the calling thread. + + Only call this method when the calling thread owns the lock. A + :exc:`RuntimeError` is raised if this method is called when the lock is + unlocked. + + There is no return value. + + +.. _condition-objects: + +Condition Objects +----------------- + +A condition variable is always associated with some kind of lock; this can be +passed in or one will be created by default. Passing one in is useful when +several condition variables must share the same lock. The lock is part of +the condition object: you don't have to track it separately. + +A condition variable obeys the :ref:`context management protocol `: +using the ``with`` statement acquires the associated lock for the duration of +the enclosed block. The :meth:`~Condition.acquire` and +:meth:`~Condition.release` methods also call the corresponding methods of +the associated lock. + +Other methods must be called with the associated lock held. The +:meth:`~Condition.wait` method releases the lock, and then blocks until +another thread awakens it by calling :meth:`~Condition.notify` or +:meth:`~Condition.notify_all`. Once awakened, :meth:`~Condition.wait` +re-acquires the lock and returns. It is also possible to specify a timeout. + +The :meth:`~Condition.notify` method wakes up one of the threads waiting for +the condition variable, if any are waiting. The :meth:`~Condition.notify_all` +method wakes up all threads waiting for the condition variable. + +Note: the :meth:`~Condition.notify` and :meth:`~Condition.notify_all` methods +don't release the lock; this means that the thread or threads awakened will +not return from their :meth:`~Condition.wait` call immediately, but only when +the thread that called :meth:`~Condition.notify` or :meth:`~Condition.notify_all` +finally relinquishes ownership of the lock. + +The typical programming style using condition variables uses the lock to +synchronize access to some shared state; threads that are interested in a +particular change of state call :meth:`~Condition.wait` repeatedly until they +see the desired state, while threads that modify the state call +:meth:`~Condition.notify` or :meth:`~Condition.notify_all` when they change +the state in such a way that it could possibly be a desired state for one +of the waiters. For example, the following code is a generic +producer-consumer situation with unlimited buffer capacity:: + + # Consume one item + with cv: + while not an_item_is_available(): + cv.wait() + get_an_available_item() + + # Produce one item + with cv: + make_an_item_available() + cv.notify() + +The ``while`` loop checking for the application's condition is necessary +because :meth:`~Condition.wait` can return after an arbitrary long time, +and the condition which prompted the :meth:`~Condition.notify` call may +no longer hold true. This is inherent to multi-threaded programming. The +:meth:`~Condition.wait_for` method can be used to automate the condition +checking, and eases the computation of timeouts:: + + # Consume an item + with cv: + cv.wait_for(an_item_is_available) + get_an_available_item() + +To choose between :meth:`~Condition.notify` and :meth:`~Condition.notify_all`, +consider whether one state change can be interesting for only one or several +waiting threads. E.g. in a typical producer-consumer situation, adding one +item to the buffer only needs to wake up one consumer thread. + + +.. class:: Condition(lock=None) + + This class implements condition variable objects. A condition variable + allows one or more threads to wait until they are notified by another thread. + + If the *lock* argument is given and not ``None``, it must be a :class:`Lock` + or :class:`RLock` object, and it is used as the underlying lock. Otherwise, + a new :class:`RLock` object is created and used as the underlying lock. + + .. versionchanged:: 3.3 + changed from a factory function to a class. + + .. method:: acquire(*args) + + Acquire the underlying lock. This method calls the corresponding method on + the underlying lock; the return value is whatever that method returns. + + .. method:: release() + + Release the underlying lock. This method calls the corresponding method on + the underlying lock; there is no return value. + + .. method:: wait(timeout=None) + + Wait until notified or until a timeout occurs. If the calling thread has + not acquired the lock when this method is called, a :exc:`RuntimeError` is + raised. + + This method releases the underlying lock, and then blocks until it is + awakened by a :meth:`notify` or :meth:`notify_all` call for the same + condition variable in another thread, or until the optional timeout + occurs. Once awakened or timed out, it re-acquires the lock and returns. + + When the *timeout* argument is present and not ``None``, it should be a + floating point number specifying a timeout for the operation in seconds + (or fractions thereof). + + When the underlying lock is an :class:`RLock`, it is not released using + its :meth:`release` method, since this may not actually unlock the lock + when it was acquired multiple times recursively. Instead, an internal + interface of the :class:`RLock` class is used, which really unlocks it + even when it has been recursively acquired several times. Another internal + interface is then used to restore the recursion level when the lock is + reacquired. + + The return value is ``True`` unless a given *timeout* expired, in which + case it is ``False``. + + .. versionchanged:: 3.2 + Previously, the method always returned ``None``. + + .. method:: wait_for(predicate, timeout=None) + + Wait until a condition evaluates to true. *predicate* should be a + callable which result will be interpreted as a boolean value. + A *timeout* may be provided giving the maximum time to wait. + + This utility method may call :meth:`wait` repeatedly until the predicate + is satisfied, or until a timeout occurs. The return value is + the last return value of the predicate and will evaluate to + ``False`` if the method timed out. + + Ignoring the timeout feature, calling this method is roughly equivalent to + writing:: + + while not predicate(): + cv.wait() + + Therefore, the same rules apply as with :meth:`wait`: The lock must be + held when called and is re-acquired on return. The predicate is evaluated + with the lock held. + + .. versionadded:: 3.2 + + .. method:: notify(n=1) + + By default, wake up one thread waiting on this condition, if any. If the + calling thread has not acquired the lock when this method is called, a + :exc:`RuntimeError` is raised. + + This method wakes up at most *n* of the threads waiting for the condition + variable; it is a no-op if no threads are waiting. + + The current implementation wakes up exactly *n* threads, if at least *n* + threads are waiting. However, it's not safe to rely on this behavior. + A future, optimized implementation may occasionally wake up more than + *n* threads. + + Note: an awakened thread does not actually return from its :meth:`wait` + call until it can reacquire the lock. Since :meth:`notify` does not + release the lock, its caller should. + + .. method:: notify_all() + + Wake up all threads waiting on this condition. This method acts like + :meth:`notify`, but wakes up all waiting threads instead of one. If the + calling thread has not acquired the lock when this method is called, a + :exc:`RuntimeError` is raised. + + +.. _semaphore-objects: + +Semaphore Objects +----------------- + +This is one of the oldest synchronization primitives in the history of computer +science, invented by the early Dutch computer scientist Edsger W. Dijkstra (he +used the names ``P()`` and ``V()`` instead of :meth:`~Semaphore.acquire` and +:meth:`~Semaphore.release`). + +A semaphore manages an internal counter which is decremented by each +:meth:`~Semaphore.acquire` call and incremented by each :meth:`~Semaphore.release` +call. The counter can never go below zero; when :meth:`~Semaphore.acquire` +finds that it is zero, it blocks, waiting until some other thread calls +:meth:`~Semaphore.release`. + +Semaphores also support the :ref:`context management protocol `. + + +.. class:: Semaphore(value=1) + + This class implements semaphore objects. A semaphore manages an atomic + counter representing the number of :meth:`release` calls minus the number of + :meth:`acquire` calls, plus an initial value. The :meth:`acquire` method + blocks if necessary until it can return without making the counter negative. + If not given, *value* defaults to 1. + + The optional argument gives the initial *value* for the internal counter; it + defaults to ``1``. If the *value* given is less than 0, :exc:`ValueError` is + raised. + + .. versionchanged:: 3.3 + changed from a factory function to a class. + + .. method:: acquire(blocking=True, timeout=None) + + Acquire a semaphore. + + When invoked without arguments: + + * If the internal counter is larger than zero on entry, decrement it by + one and return true immediately. + * If the internal counter is zero on entry, block until awoken by a call to + :meth:`~Semaphore.release`. Once awoken (and the counter is greater + than 0), decrement the counter by 1 and return true. Exactly one + thread will be awoken by each call to :meth:`~Semaphore.release`. The + order in which threads are awoken should not be relied on. + + When invoked with *blocking* set to false, do not block. If a call + without an argument would block, return false immediately; otherwise, do + the same thing as when called without arguments, and return true. + + When invoked with a *timeout* other than ``None``, it will block for at + most *timeout* seconds. If acquire does not complete successfully in + that interval, return false. Return true otherwise. + + .. versionchanged:: 3.2 + The *timeout* parameter is new. + + .. method:: release() + + Release a semaphore, incrementing the internal counter by one. When it + was zero on entry and another thread is waiting for it to become larger + than zero again, wake up that thread. + + +.. class:: BoundedSemaphore(value=1) + + Class implementing bounded semaphore objects. A bounded semaphore checks to + make sure its current value doesn't exceed its initial value. If it does, + :exc:`ValueError` is raised. In most situations semaphores are used to guard + resources with limited capacity. If the semaphore is released too many times + it's a sign of a bug. If not given, *value* defaults to 1. + + .. versionchanged:: 3.3 + changed from a factory function to a class. + + +.. _semaphore-examples: + +:class:`Semaphore` Example +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Semaphores are often used to guard resources with limited capacity, for example, +a database server. In any situation where the size of the resource is fixed, +you should use a bounded semaphore. Before spawning any worker threads, your +main thread would initialize the semaphore:: + + maxconnections = 5 + # ... + pool_sema = BoundedSemaphore(value=maxconnections) + +Once spawned, worker threads call the semaphore's acquire and release methods +when they need to connect to the server:: + + with pool_sema: + conn = connectdb() + try: + # ... use connection ... + finally: + conn.close() + +The use of a bounded semaphore reduces the chance that a programming error which +causes the semaphore to be released more than it's acquired will go undetected. + + +.. _event-objects: + +Event Objects +------------- + +This is one of the simplest mechanisms for communication between threads: one +thread signals an event and other threads wait for it. + +An event object manages an internal flag that can be set to true with the +:meth:`~Event.set` method and reset to false with the :meth:`~Event.clear` +method. The :meth:`~Event.wait` method blocks until the flag is true. + + +.. class:: Event() + + Class implementing event objects. An event manages a flag that can be set to + true with the :meth:`~Event.set` method and reset to false with the + :meth:`clear` method. The :meth:`wait` method blocks until the flag is true. + The flag is initially false. + + .. versionchanged:: 3.3 + changed from a factory function to a class. + + .. method:: is_set() + + Return true if and only if the internal flag is true. + + .. method:: set() + + Set the internal flag to true. All threads waiting for it to become true + are awakened. Threads that call :meth:`wait` once the flag is true will + not block at all. + + .. method:: clear() + + Reset the internal flag to false. Subsequently, threads calling + :meth:`wait` will block until :meth:`.set` is called to set the internal + flag to true again. + + .. method:: wait(timeout=None) + + Block until the internal flag is true. If the internal flag is true on + entry, return immediately. Otherwise, block until another thread calls + :meth:`.set` to set the flag to true, or until the optional timeout occurs. + + When the timeout argument is present and not ``None``, it should be a + floating point number specifying a timeout for the operation in seconds + (or fractions thereof). + + This method returns true if and only if the internal flag has been set to + true, either before the wait call or after the wait starts, so it will + always return ``True`` except if a timeout is given and the operation + times out. + + .. versionchanged:: 3.1 + Previously, the method always returned ``None``. + + +.. _timer-objects: + +Timer Objects +------------- + +This class represents an action that should be run only after a certain amount +of time has passed --- a timer. :class:`Timer` is a subclass of :class:`Thread` +and as such also functions as an example of creating custom threads. + +Timers are started, as with threads, by calling their :meth:`~Timer.start` +method. The timer can be stopped (before its action has begun) by calling the +:meth:`~Timer.cancel` method. The interval the timer will wait before +executing its action may not be exactly the same as the interval specified by +the user. + +For example:: + + def hello(): + print("hello, world") + + t = Timer(30.0, hello) + t.start() # after 30 seconds, "hello, world" will be printed + + +.. class:: Timer(interval, function, args=None, kwargs=None) + + Create a timer that will run *function* with arguments *args* and keyword + arguments *kwargs*, after *interval* seconds have passed. + If *args* is ``None`` (the default) then an empty list will be used. + If *kwargs* is ``None`` (the default) then an empty dict will be used. + + .. versionchanged:: 3.3 + changed from a factory function to a class. + + .. method:: cancel() + + Stop the timer, and cancel the execution of the timer's action. This will + only work if the timer is still in its waiting stage. + + +Barrier Objects +--------------- + +.. versionadded:: 3.2 + +This class provides a simple synchronization primitive for use by a fixed number +of threads that need to wait for each other. Each of the threads tries to pass +the barrier by calling the :meth:`~Barrier.wait` method and will block until +all of the threads have made their :meth:`~Barrier.wait` calls. At this point, +the threads are released simultaneously. + +The barrier can be reused any number of times for the same number of threads. + +As an example, here is a simple way to synchronize a client and server thread:: + + b = Barrier(2, timeout=5) + + def server(): + start_server() + b.wait() + while True: + connection = accept_connection() + process_server_connection(connection) + + def client(): + b.wait() + while True: + connection = make_connection() + process_client_connection(connection) + + +.. class:: Barrier(parties, action=None, timeout=None) + + Create a barrier object for *parties* number of threads. An *action*, when + provided, is a callable to be called by one of the threads when they are + released. *timeout* is the default timeout value if none is specified for + the :meth:`wait` method. + + .. method:: wait(timeout=None) + + Pass the barrier. When all the threads party to the barrier have called + this function, they are all released simultaneously. If a *timeout* is + provided, it is used in preference to any that was supplied to the class + constructor. + + The return value is an integer in the range 0 to *parties* -- 1, different + for each thread. This can be used to select a thread to do some special + housekeeping, e.g.:: + + i = barrier.wait() + if i == 0: + # Only one thread needs to print this + print("passed the barrier") + + If an *action* was provided to the constructor, one of the threads will + have called it prior to being released. Should this call raise an error, + the barrier is put into the broken state. + + If the call times out, the barrier is put into the broken state. + + This method may raise a :class:`BrokenBarrierError` exception if the + barrier is broken or reset while a thread is waiting. + + .. method:: reset() + + Return the barrier to the default, empty state. Any threads waiting on it + will receive the :class:`BrokenBarrierError` exception. + + Note that using this function may can require some external + synchronization if there are other threads whose state is unknown. If a + barrier is broken it may be better to just leave it and create a new one. + + .. method:: abort() + + Put the barrier into a broken state. This causes any active or future + calls to :meth:`wait` to fail with the :class:`BrokenBarrierError`. Use + this for example if one of the needs to abort, to avoid deadlocking the + application. + + It may be preferable to simply create the barrier with a sensible + *timeout* value to automatically guard against one of the threads going + awry. + + .. attribute:: parties + + The number of threads required to pass the barrier. + + .. attribute:: n_waiting + + The number of threads currently waiting in the barrier. + + .. attribute:: broken + + A boolean that is ``True`` if the barrier is in the broken state. + + +.. exception:: BrokenBarrierError + + This exception, a subclass of :exc:`RuntimeError`, is raised when the + :class:`Barrier` object is reset or broken. + + +.. _with-locks: + +Using locks, conditions, and semaphores in the :keyword:`!with` statement +------------------------------------------------------------------------- + +All of the objects provided by this module that have :meth:`acquire` and +:meth:`release` methods can be used as context managers for a :keyword:`with` +statement. The :meth:`acquire` method will be called when the block is +entered, and :meth:`release` will be called when the block is exited. Hence, +the following snippet:: + + with some_lock: + # do something... + +is equivalent to:: + + some_lock.acquire() + try: + # do something... + finally: + some_lock.release() + +Currently, :class:`Lock`, :class:`RLock`, :class:`Condition`, +:class:`Semaphore`, and :class:`BoundedSemaphore` objects may be used as +:keyword:`with` statement context managers. diff --git a/python-3.7.4-docs-html/_sources/library/time.rst.txt b/python-3.7.4-docs-html/_sources/library/time.rst.txt new file mode 100644 index 0000000..4230c19 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/time.rst.txt @@ -0,0 +1,887 @@ +:mod:`time` --- Time access and conversions +=========================================== + +.. module:: time + :synopsis: Time access and conversions. + +-------------- + +This module provides various time-related functions. For related +functionality, see also the :mod:`datetime` and :mod:`calendar` modules. + +Although this module is always available, +not all functions are available on all platforms. Most of the functions +defined in this module call platform C library functions with the same name. It +may sometimes be helpful to consult the platform documentation, because the +semantics of these functions varies among platforms. + +An explanation of some terminology and conventions is in order. + +.. _epoch: + +.. index:: single: epoch + +* The :dfn:`epoch` is the point where the time starts, and is platform + dependent. For Unix, the epoch is January 1, 1970, 00:00:00 (UTC). + To find out what the epoch is on a given platform, look at + ``time.gmtime(0)``. + +.. _leap seconds: https://en.wikipedia.org/wiki/Leap_second + +.. index:: seconds since the epoch + +* The term :dfn:`seconds since the epoch` refers to the total number + of elapsed seconds since the epoch, typically excluding + `leap seconds`_. Leap seconds are excluded from this total on all + POSIX-compliant platforms. + +.. index:: single: Year 2038 + +* The functions in this module may not handle dates and times before the epoch or + far in the future. The cut-off point in the future is determined by the C + library; for 32-bit systems, it is typically in 2038. + +.. index:: + single: Year 2000 + single: Y2K + +.. _time-y2kissues: + +* **Year 2000 (Y2K) issues**: Python depends on the platform's C library, which + generally doesn't have year 2000 issues, since all dates and times are + represented internally as seconds since the epoch. Function :func:`strptime` + can parse 2-digit years when given ``%y`` format code. When 2-digit years are + parsed, they are converted according to the POSIX and ISO C standards: values + 69--99 are mapped to 1969--1999, and values 0--68 are mapped to 2000--2068. + +.. index:: + single: UTC + single: Coordinated Universal Time + single: Greenwich Mean Time + +* UTC is Coordinated Universal Time (formerly known as Greenwich Mean Time, or + GMT). The acronym UTC is not a mistake but a compromise between English and + French. + +.. index:: single: Daylight Saving Time + +* DST is Daylight Saving Time, an adjustment of the timezone by (usually) one + hour during part of the year. DST rules are magic (determined by local law) and + can change from year to year. The C library has a table containing the local + rules (often it is read from a system file for flexibility) and is the only + source of True Wisdom in this respect. + +* The precision of the various real-time functions may be less than suggested by + the units in which their value or argument is expressed. E.g. on most Unix + systems, the clock "ticks" only 50 or 100 times a second. + +* On the other hand, the precision of :func:`.time` and :func:`sleep` is better + than their Unix equivalents: times are expressed as floating point numbers, + :func:`.time` returns the most accurate time available (using Unix + :c:func:`gettimeofday` where available), and :func:`sleep` will accept a time + with a nonzero fraction (Unix :c:func:`select` is used to implement this, where + available). + +* The time value as returned by :func:`gmtime`, :func:`localtime`, and + :func:`strptime`, and accepted by :func:`asctime`, :func:`mktime` and + :func:`strftime`, is a sequence of 9 integers. The return values of + :func:`gmtime`, :func:`localtime`, and :func:`strptime` also offer attribute + names for individual fields. + + See :class:`struct_time` for a description of these objects. + + .. versionchanged:: 3.3 + The :class:`struct_time` type was extended to provide the :attr:`tm_gmtoff` + and :attr:`tm_zone` attributes when platform supports corresponding + ``struct tm`` members. + + .. versionchanged:: 3.6 + The :class:`struct_time` attributes :attr:`tm_gmtoff` and :attr:`tm_zone` + are now available on all platforms. + +* Use the following functions to convert between time representations: + + +-------------------------+-------------------------+-------------------------+ + | From | To | Use | + +=========================+=========================+=========================+ + | seconds since the epoch | :class:`struct_time` in | :func:`gmtime` | + | | UTC | | + +-------------------------+-------------------------+-------------------------+ + | seconds since the epoch | :class:`struct_time` in | :func:`localtime` | + | | local time | | + +-------------------------+-------------------------+-------------------------+ + | :class:`struct_time` in | seconds since the epoch | :func:`calendar.timegm` | + | UTC | | | + +-------------------------+-------------------------+-------------------------+ + | :class:`struct_time` in | seconds since the epoch | :func:`mktime` | + | local time | | | + +-------------------------+-------------------------+-------------------------+ + + +.. _time-functions: + +Functions +--------- + +.. function:: asctime([t]) + + Convert a tuple or :class:`struct_time` representing a time as returned by + :func:`gmtime` or :func:`localtime` to a string of the following + form: ``'Sun Jun 20 23:21:05 1993'``. If *t* is not provided, the current time + as returned by :func:`localtime` is used. Locale information is not used by + :func:`asctime`. + + .. note:: + + Unlike the C function of the same name, :func:`asctime` does not add a + trailing newline. + + +.. function:: clock() + + .. index:: + single: CPU time + single: processor time + single: benchmarking + + On Unix, return the current processor time as a floating point number expressed + in seconds. The precision, and in fact the very definition of the meaning of + "processor time", depends on that of the C function of the same name. + + On Windows, this function returns wall-clock seconds elapsed since the first + call to this function, as a floating point number, based on the Win32 function + :c:func:`QueryPerformanceCounter`. The resolution is typically better than one + microsecond. + + .. deprecated-removed:: 3.3 3.8 + The behaviour of this function depends on the platform: use + :func:`perf_counter` or :func:`process_time` instead, depending on your + requirements, to have a well defined behaviour. + +.. function:: pthread_getcpuclockid(thread_id) + + Return the *clk_id* of the thread-specific CPU-time clock for the specified *thread_id*. + + Use :func:`threading.get_ident` or the :attr:`~threading.Thread.ident` + attribute of :class:`threading.Thread` objects to get a suitable value + for *thread_id*. + + .. warning:: + Passing an invalid or expired *thread_id* may result in + undefined behavior, such as segmentation fault. + + .. availability:: Unix (see the man page for :manpage:`pthread_getcpuclockid(3)` for + further information). + + .. versionadded:: 3.7 + +.. function:: clock_getres(clk_id) + + Return the resolution (precision) of the specified clock *clk_id*. Refer to + :ref:`time-clock-id-constants` for a list of accepted values for *clk_id*. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. function:: clock_gettime(clk_id) -> float + + Return the time of the specified clock *clk_id*. Refer to + :ref:`time-clock-id-constants` for a list of accepted values for *clk_id*. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. function:: clock_gettime_ns(clk_id) -> int + + Similar to :func:`clock_gettime` but return time as nanoseconds. + + .. availability:: Unix. + + .. versionadded:: 3.7 + + +.. function:: clock_settime(clk_id, time: float) + + Set the time of the specified clock *clk_id*. Currently, + :data:`CLOCK_REALTIME` is the only accepted value for *clk_id*. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. function:: clock_settime_ns(clk_id, time: int) + + Similar to :func:`clock_settime` but set time with nanoseconds. + + .. availability:: Unix. + + .. versionadded:: 3.7 + + +.. function:: ctime([secs]) + + Convert a time expressed in seconds since the epoch to a string representing + local time. If *secs* is not provided or :const:`None`, the current time as + returned by :func:`.time` is used. ``ctime(secs)`` is equivalent to + ``asctime(localtime(secs))``. Locale information is not used by :func:`ctime`. + + +.. function:: get_clock_info(name) + + Get information on the specified clock as a namespace object. + Supported clock names and the corresponding functions to read their value + are: + + * ``'clock'``: :func:`time.clock` + * ``'monotonic'``: :func:`time.monotonic` + * ``'perf_counter'``: :func:`time.perf_counter` + * ``'process_time'``: :func:`time.process_time` + * ``'thread_time'``: :func:`time.thread_time` + * ``'time'``: :func:`time.time` + + The result has the following attributes: + + - *adjustable*: ``True`` if the clock can be changed automatically (e.g. by + a NTP daemon) or manually by the system administrator, ``False`` otherwise + - *implementation*: The name of the underlying C function used to get + the clock value. Refer to :ref:`time-clock-id-constants` for possible values. + - *monotonic*: ``True`` if the clock cannot go backward, + ``False`` otherwise + - *resolution*: The resolution of the clock in seconds (:class:`float`) + + .. versionadded:: 3.3 + + +.. function:: gmtime([secs]) + + Convert a time expressed in seconds since the epoch to a :class:`struct_time` in + UTC in which the dst flag is always zero. If *secs* is not provided or + :const:`None`, the current time as returned by :func:`.time` is used. Fractions + of a second are ignored. See above for a description of the + :class:`struct_time` object. See :func:`calendar.timegm` for the inverse of this + function. + + +.. function:: localtime([secs]) + + Like :func:`gmtime` but converts to local time. If *secs* is not provided or + :const:`None`, the current time as returned by :func:`.time` is used. The dst + flag is set to ``1`` when DST applies to the given time. + + +.. function:: mktime(t) + + This is the inverse function of :func:`localtime`. Its argument is the + :class:`struct_time` or full 9-tuple (since the dst flag is needed; use ``-1`` + as the dst flag if it is unknown) which expresses the time in *local* time, not + UTC. It returns a floating point number, for compatibility with :func:`.time`. + If the input value cannot be represented as a valid time, either + :exc:`OverflowError` or :exc:`ValueError` will be raised (which depends on + whether the invalid value is caught by Python or the underlying C libraries). + The earliest date for which it can generate a time is platform-dependent. + + +.. function:: monotonic() -> float + + Return the value (in fractional seconds) of a monotonic clock, i.e. a clock + that cannot go backwards. The clock is not affected by system clock updates. + The reference point of the returned value is undefined, so that only the + difference between the results of consecutive calls is valid. + + .. versionadded:: 3.3 + .. versionchanged:: 3.5 + The function is now always available and always system-wide. + + +.. function:: monotonic_ns() -> int + + Similar to :func:`monotonic`, but return time as nanoseconds. + + .. versionadded:: 3.7 + +.. function:: perf_counter() -> float + + .. index:: + single: benchmarking + + Return the value (in fractional seconds) of a performance counter, i.e. a + clock with the highest available resolution to measure a short duration. It + does include time elapsed during sleep and is system-wide. The reference + point of the returned value is undefined, so that only the difference between + the results of consecutive calls is valid. + + .. versionadded:: 3.3 + +.. function:: perf_counter_ns() -> int + + Similar to :func:`perf_counter`, but return time as nanoseconds. + + .. versionadded:: 3.7 + + +.. function:: process_time() -> float + + .. index:: + single: CPU time + single: processor time + single: benchmarking + + Return the value (in fractional seconds) of the sum of the system and user + CPU time of the current process. It does not include time elapsed during + sleep. It is process-wide by definition. The reference point of the + returned value is undefined, so that only the difference between the results + of consecutive calls is valid. + + .. versionadded:: 3.3 + +.. function:: process_time_ns() -> int + + Similar to :func:`process_time` but return time as nanoseconds. + + .. versionadded:: 3.7 + +.. function:: sleep(secs) + + Suspend execution of the calling thread for the given number of seconds. + The argument may be a floating point number to indicate a more precise sleep + time. The actual suspension time may be less than that requested because any + caught signal will terminate the :func:`sleep` following execution of that + signal's catching routine. Also, the suspension time may be longer than + requested by an arbitrary amount because of the scheduling of other activity + in the system. + + .. versionchanged:: 3.5 + The function now sleeps at least *secs* even if the sleep is interrupted + by a signal, except if the signal handler raises an exception (see + :pep:`475` for the rationale). + + +.. index:: + single: % (percent); datetime format + +.. function:: strftime(format[, t]) + + Convert a tuple or :class:`struct_time` representing a time as returned by + :func:`gmtime` or :func:`localtime` to a string as specified by the *format* + argument. If *t* is not provided, the current time as returned by + :func:`localtime` is used. *format* must be a string. :exc:`ValueError` is + raised if any field in *t* is outside of the allowed range. + + 0 is a legal argument for any position in the time tuple; if it is normally + illegal the value is forced to a correct one. + + The following directives can be embedded in the *format* string. They are shown + without the optional field width and precision specification, and are replaced + by the indicated characters in the :func:`strftime` result: + + +-----------+------------------------------------------------+-------+ + | Directive | Meaning | Notes | + +===========+================================================+=======+ + | ``%a`` | Locale's abbreviated weekday name. | | + | | | | + +-----------+------------------------------------------------+-------+ + | ``%A`` | Locale's full weekday name. | | + +-----------+------------------------------------------------+-------+ + | ``%b`` | Locale's abbreviated month name. | | + | | | | + +-----------+------------------------------------------------+-------+ + | ``%B`` | Locale's full month name. | | + +-----------+------------------------------------------------+-------+ + | ``%c`` | Locale's appropriate date and time | | + | | representation. | | + +-----------+------------------------------------------------+-------+ + | ``%d`` | Day of the month as a decimal number [01,31]. | | + | | | | + +-----------+------------------------------------------------+-------+ + | ``%H`` | Hour (24-hour clock) as a decimal number | | + | | [00,23]. | | + +-----------+------------------------------------------------+-------+ + | ``%I`` | Hour (12-hour clock) as a decimal number | | + | | [01,12]. | | + +-----------+------------------------------------------------+-------+ + | ``%j`` | Day of the year as a decimal number [001,366]. | | + | | | | + +-----------+------------------------------------------------+-------+ + | ``%m`` | Month as a decimal number [01,12]. | | + | | | | + +-----------+------------------------------------------------+-------+ + | ``%M`` | Minute as a decimal number [00,59]. | | + | | | | + +-----------+------------------------------------------------+-------+ + | ``%p`` | Locale's equivalent of either AM or PM. | \(1) | + | | | | + +-----------+------------------------------------------------+-------+ + | ``%S`` | Second as a decimal number [00,61]. | \(2) | + | | | | + +-----------+------------------------------------------------+-------+ + | ``%U`` | Week number of the year (Sunday as the first | \(3) | + | | day of the week) as a decimal number [00,53]. | | + | | All days in a new year preceding the first | | + | | Sunday are considered to be in week 0. | | + | | | | + | | | | + | | | | + +-----------+------------------------------------------------+-------+ + | ``%w`` | Weekday as a decimal number [0(Sunday),6]. | | + | | | | + +-----------+------------------------------------------------+-------+ + | ``%W`` | Week number of the year (Monday as the first | \(3) | + | | day of the week) as a decimal number [00,53]. | | + | | All days in a new year preceding the first | | + | | Monday are considered to be in week 0. | | + | | | | + | | | | + | | | | + +-----------+------------------------------------------------+-------+ + | ``%x`` | Locale's appropriate date representation. | | + | | | | + +-----------+------------------------------------------------+-------+ + | ``%X`` | Locale's appropriate time representation. | | + | | | | + +-----------+------------------------------------------------+-------+ + | ``%y`` | Year without century as a decimal number | | + | | [00,99]. | | + +-----------+------------------------------------------------+-------+ + | ``%Y`` | Year with century as a decimal number. | | + | | | | + +-----------+------------------------------------------------+-------+ + | ``%z`` | Time zone offset indicating a positive or | | + | | negative time difference from UTC/GMT of the | | + | | form +HHMM or -HHMM, where H represents decimal| | + | | hour digits and M represents decimal minute | | + | | digits [-23:59, +23:59]. | | + +-----------+------------------------------------------------+-------+ + | ``%Z`` | Time zone name (no characters if no time zone | | + | | exists). | | + +-----------+------------------------------------------------+-------+ + | ``%%`` | A literal ``'%'`` character. | | + +-----------+------------------------------------------------+-------+ + + Notes: + + (1) + When used with the :func:`strptime` function, the ``%p`` directive only affects + the output hour field if the ``%I`` directive is used to parse the hour. + + (2) + The range really is ``0`` to ``61``; value ``60`` is valid in + timestamps representing `leap seconds`_ and value ``61`` is supported + for historical reasons. + + (3) + When used with the :func:`strptime` function, ``%U`` and ``%W`` are only used in + calculations when the day of the week and the year are specified. + + Here is an example, a format for dates compatible with that specified in the + :rfc:`2822` Internet email standard. [#]_ :: + + >>> from time import gmtime, strftime + >>> strftime("%a, %d %b %Y %H:%M:%S +0000", gmtime()) + 'Thu, 28 Jun 2001 14:17:15 +0000' + + Additional directives may be supported on certain platforms, but only the + ones listed here have a meaning standardized by ANSI C. To see the full set + of format codes supported on your platform, consult the :manpage:`strftime(3)` + documentation. + + On some platforms, an optional field width and precision specification can + immediately follow the initial ``'%'`` of a directive in the following order; + this is also not portable. The field width is normally 2 except for ``%j`` where + it is 3. + + +.. index:: + single: % (percent); datetime format + +.. function:: strptime(string[, format]) + + Parse a string representing a time according to a format. The return value + is a :class:`struct_time` as returned by :func:`gmtime` or + :func:`localtime`. + + The *format* parameter uses the same directives as those used by + :func:`strftime`; it defaults to ``"%a %b %d %H:%M:%S %Y"`` which matches the + formatting returned by :func:`ctime`. If *string* cannot be parsed according + to *format*, or if it has excess data after parsing, :exc:`ValueError` is + raised. The default values used to fill in any missing data when more + accurate values cannot be inferred are ``(1900, 1, 1, 0, 0, 0, 0, 1, -1)``. + Both *string* and *format* must be strings. + + For example: + + >>> import time + >>> time.strptime("30 Nov 00", "%d %b %y") # doctest: +NORMALIZE_WHITESPACE + time.struct_time(tm_year=2000, tm_mon=11, tm_mday=30, tm_hour=0, tm_min=0, + tm_sec=0, tm_wday=3, tm_yday=335, tm_isdst=-1) + + Support for the ``%Z`` directive is based on the values contained in ``tzname`` + and whether ``daylight`` is true. Because of this, it is platform-specific + except for recognizing UTC and GMT which are always known (and are considered to + be non-daylight savings timezones). + + Only the directives specified in the documentation are supported. Because + ``strftime()`` is implemented per platform it can sometimes offer more + directives than those listed. But ``strptime()`` is independent of any platform + and thus does not necessarily support all directives available that are not + documented as supported. + + +.. class:: struct_time + + The type of the time value sequence returned by :func:`gmtime`, + :func:`localtime`, and :func:`strptime`. It is an object with a :term:`named + tuple` interface: values can be accessed by index and by attribute name. The + following values are present: + + +-------+-------------------+---------------------------------+ + | Index | Attribute | Values | + +=======+===================+=================================+ + | 0 | :attr:`tm_year` | (for example, 1993) | + +-------+-------------------+---------------------------------+ + | 1 | :attr:`tm_mon` | range [1, 12] | + +-------+-------------------+---------------------------------+ + | 2 | :attr:`tm_mday` | range [1, 31] | + +-------+-------------------+---------------------------------+ + | 3 | :attr:`tm_hour` | range [0, 23] | + +-------+-------------------+---------------------------------+ + | 4 | :attr:`tm_min` | range [0, 59] | + +-------+-------------------+---------------------------------+ + | 5 | :attr:`tm_sec` | range [0, 61]; see **(2)** in | + | | | :func:`strftime` description | + +-------+-------------------+---------------------------------+ + | 6 | :attr:`tm_wday` | range [0, 6], Monday is 0 | + +-------+-------------------+---------------------------------+ + | 7 | :attr:`tm_yday` | range [1, 366] | + +-------+-------------------+---------------------------------+ + | 8 | :attr:`tm_isdst` | 0, 1 or -1; see below | + +-------+-------------------+---------------------------------+ + | N/A | :attr:`tm_zone` | abbreviation of timezone name | + +-------+-------------------+---------------------------------+ + | N/A | :attr:`tm_gmtoff` | offset east of UTC in seconds | + +-------+-------------------+---------------------------------+ + + Note that unlike the C structure, the month value is a range of [1, 12], not + [0, 11]. + + In calls to :func:`mktime`, :attr:`tm_isdst` may be set to 1 when daylight + savings time is in effect, and 0 when it is not. A value of -1 indicates that + this is not known, and will usually result in the correct state being filled in. + + When a tuple with an incorrect length is passed to a function expecting a + :class:`struct_time`, or having elements of the wrong type, a + :exc:`TypeError` is raised. + +.. function:: time() -> float + + Return the time in seconds since the epoch_ as a floating point + number. The specific date of the epoch and the handling of + `leap seconds`_ is platform dependent. + On Windows and most Unix systems, the epoch is January 1, 1970, + 00:00:00 (UTC) and leap seconds are not counted towards the time + in seconds since the epoch. This is commonly referred to as + `Unix time `_. + To find out what the epoch is on a given platform, look at + ``gmtime(0)``. + + Note that even though the time is always returned as a floating point + number, not all systems provide time with a better precision than 1 second. + While this function normally returns non-decreasing values, it can return a + lower value than a previous call if the system clock has been set back + between the two calls. + + The number returned by :func:`.time` may be converted into a more common + time format (i.e. year, month, day, hour, etc...) in UTC by passing it to + :func:`gmtime` function or in local time by passing it to the + :func:`localtime` function. In both cases a + :class:`struct_time` object is returned, from which the components + of the calendar date may be accessed as attributes. + + +.. function:: thread_time() -> float + + .. index:: + single: CPU time + single: processor time + single: benchmarking + + Return the value (in fractional seconds) of the sum of the system and user + CPU time of the current thread. It does not include time elapsed during + sleep. It is thread-specific by definition. The reference point of the + returned value is undefined, so that only the difference between the results + of consecutive calls in the same thread is valid. + + .. availability:: Windows, Linux, Unix systems supporting + ``CLOCK_THREAD_CPUTIME_ID``. + + .. versionadded:: 3.7 + + +.. function:: thread_time_ns() -> int + + Similar to :func:`thread_time` but return time as nanoseconds. + + .. versionadded:: 3.7 + + +.. function:: time_ns() -> int + + Similar to :func:`time` but returns time as an integer number of nanoseconds + since the epoch_. + + .. versionadded:: 3.7 + +.. function:: tzset() + + Reset the time conversion rules used by the library routines. The environment + variable :envvar:`TZ` specifies how this is done. It will also set the variables + ``tzname`` (from the :envvar:`TZ` environment variable), ``timezone`` (non-DST + seconds West of UTC), ``altzone`` (DST seconds west of UTC) and ``daylight`` + (to 0 if this timezone does not have any daylight saving time rules, or to + nonzero if there is a time, past, present or future when daylight saving time + applies). + + .. availability:: Unix. + + .. note:: + + Although in many cases, changing the :envvar:`TZ` environment variable may + affect the output of functions like :func:`localtime` without calling + :func:`tzset`, this behavior should not be relied on. + + The :envvar:`TZ` environment variable should contain no whitespace. + + The standard format of the :envvar:`TZ` environment variable is (whitespace + added for clarity):: + + std offset [dst [offset [,start[/time], end[/time]]]] + + Where the components are: + + ``std`` and ``dst`` + Three or more alphanumerics giving the timezone abbreviations. These will be + propagated into time.tzname + + ``offset`` + The offset has the form: ``± hh[:mm[:ss]]``. This indicates the value + added the local time to arrive at UTC. If preceded by a '-', the timezone + is east of the Prime Meridian; otherwise, it is west. If no offset follows + dst, summer time is assumed to be one hour ahead of standard time. + + ``start[/time], end[/time]`` + Indicates when to change to and back from DST. The format of the + start and end dates are one of the following: + + :samp:`J{n}` + The Julian day *n* (1 <= *n* <= 365). Leap days are not counted, so in + all years February 28 is day 59 and March 1 is day 60. + + :samp:`{n}` + The zero-based Julian day (0 <= *n* <= 365). Leap days are counted, and + it is possible to refer to February 29. + + :samp:`M{m}.{n}.{d}` + The *d*'th day (0 <= *d* <= 6) of week *n* of month *m* of the year (1 + <= *n* <= 5, 1 <= *m* <= 12, where week 5 means "the last *d* day in + month *m*" which may occur in either the fourth or the fifth + week). Week 1 is the first week in which the *d*'th day occurs. Day + zero is a Sunday. + + ``time`` has the same format as ``offset`` except that no leading sign + ('-' or '+') is allowed. The default, if time is not given, is 02:00:00. + + :: + + >>> os.environ['TZ'] = 'EST+05EDT,M4.1.0,M10.5.0' + >>> time.tzset() + >>> time.strftime('%X %x %Z') + '02:07:36 05/08/03 EDT' + >>> os.environ['TZ'] = 'AEST-10AEDT-11,M10.5.0,M3.5.0' + >>> time.tzset() + >>> time.strftime('%X %x %Z') + '16:08:12 05/08/03 AEST' + + On many Unix systems (including \*BSD, Linux, Solaris, and Darwin), it is more + convenient to use the system's zoneinfo (:manpage:`tzfile(5)`) database to + specify the timezone rules. To do this, set the :envvar:`TZ` environment + variable to the path of the required timezone datafile, relative to the root of + the systems 'zoneinfo' timezone database, usually located at + :file:`/usr/share/zoneinfo`. For example, ``'US/Eastern'``, + ``'Australia/Melbourne'``, ``'Egypt'`` or ``'Europe/Amsterdam'``. :: + + >>> os.environ['TZ'] = 'US/Eastern' + >>> time.tzset() + >>> time.tzname + ('EST', 'EDT') + >>> os.environ['TZ'] = 'Egypt' + >>> time.tzset() + >>> time.tzname + ('EET', 'EEST') + + +.. _time-clock-id-constants: + +Clock ID Constants +------------------ + +These constants are used as parameters for :func:`clock_getres` and +:func:`clock_gettime`. + +.. data:: CLOCK_BOOTTIME + + Identical to :data:`CLOCK_MONOTONIC`, except it also includes any time that + the system is suspended. + + This allows applications to get a suspend-aware monotonic clock without + having to deal with the complications of :data:`CLOCK_REALTIME`, which may + have discontinuities if the time is changed using ``settimeofday()`` or + similar. + + .. availability:: Linux 2.6.39 or later. + + .. versionadded:: 3.7 + + +.. data:: CLOCK_HIGHRES + + The Solaris OS has a ``CLOCK_HIGHRES`` timer that attempts to use an optimal + hardware source, and may give close to nanosecond resolution. + ``CLOCK_HIGHRES`` is the nonadjustable, high-resolution clock. + + .. availability:: Solaris. + + .. versionadded:: 3.3 + + +.. data:: CLOCK_MONOTONIC + + Clock that cannot be set and represents monotonic time since some unspecified + starting point. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. data:: CLOCK_MONOTONIC_RAW + + Similar to :data:`CLOCK_MONOTONIC`, but provides access to a raw + hardware-based time that is not subject to NTP adjustments. + + .. availability:: Linux 2.6.28 and newer, macOS 10.12 and newer. + + .. versionadded:: 3.3 + + +.. data:: CLOCK_PROCESS_CPUTIME_ID + + High-resolution per-process timer from the CPU. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. data:: CLOCK_PROF + + High-resolution per-process timer from the CPU. + + .. availability:: FreeBSD, NetBSD 7 or later, OpenBSD. + + .. versionadded:: 3.7 + + +.. data:: CLOCK_THREAD_CPUTIME_ID + + Thread-specific CPU-time clock. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. data:: CLOCK_UPTIME + + Time whose absolute value is the time the system has been running and not + suspended, providing accurate uptime measurement, both absolute and + interval. + + .. availability:: FreeBSD, OpenBSD 5.5 or later. + + .. versionadded:: 3.7 + + +The following constant is the only parameter that can be sent to +:func:`clock_settime`. + +.. data:: CLOCK_REALTIME + + System-wide real-time clock. Setting this clock requires appropriate + privileges. + + .. availability:: Unix. + + .. versionadded:: 3.3 + + +.. _time-timezone-constants: + +Timezone Constants +------------------- + +.. data:: altzone + + The offset of the local DST timezone, in seconds west of UTC, if one is defined. + This is negative if the local DST timezone is east of UTC (as in Western Europe, + including the UK). Only use this if ``daylight`` is nonzero. See note below. + +.. data:: daylight + + Nonzero if a DST timezone is defined. See note below. + +.. data:: timezone + + The offset of the local (non-DST) timezone, in seconds west of UTC (negative in + most of Western Europe, positive in the US, zero in the UK). See note below. + +.. data:: tzname + + A tuple of two strings: the first is the name of the local non-DST timezone, the + second is the name of the local DST timezone. If no DST timezone is defined, + the second string should not be used. See note below. + +.. note:: + + For the above Timezone constants (:data:`altzone`, :data:`daylight`, :data:`timezone`, + and :data:`tzname`), the value is determined by the timezone rules in effect + at module load time or the last time :func:`tzset` is called and may be incorrect + for times in the past. It is recommended to use the :attr:`tm_gmtoff` and + :attr:`tm_zone` results from :func:`localtime` to obtain timezone information. + + +.. seealso:: + + Module :mod:`datetime` + More object-oriented interface to dates and times. + + Module :mod:`locale` + Internationalization services. The locale setting affects the interpretation + of many format specifiers in :func:`strftime` and :func:`strptime`. + + Module :mod:`calendar` + General calendar-related functions. :func:`~calendar.timegm` is the + inverse of :func:`gmtime` from this module. + +.. rubric:: Footnotes + +.. [#] The use of ``%Z`` is now deprecated, but the ``%z`` escape that expands to the + preferred hour/minute offset is not supported by all ANSI C libraries. Also, a + strict reading of the original 1982 :rfc:`822` standard calls for a two-digit + year (%y rather than %Y), but practice moved to 4-digit years long before the + year 2000. After that, :rfc:`822` became obsolete and the 4-digit year has + been first recommended by :rfc:`1123` and then mandated by :rfc:`2822`. + diff --git a/python-3.7.4-docs-html/_sources/library/timeit.rst.txt b/python-3.7.4-docs-html/_sources/library/timeit.rst.txt new file mode 100644 index 0000000..ef7a4e4 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/timeit.rst.txt @@ -0,0 +1,371 @@ +:mod:`timeit` --- Measure execution time of small code snippets +=============================================================== + +.. module:: timeit + :synopsis: Measure the execution time of small code snippets. + +**Source code:** :source:`Lib/timeit.py` + +.. index:: + single: Benchmarking + single: Performance + +-------------- + +This module provides a simple way to time small bits of Python code. It has both +a :ref:`timeit-command-line-interface` as well as a :ref:`callable ` +one. It avoids a number of common traps for measuring execution times. +See also Tim Peters' introduction to the "Algorithms" chapter in the *Python +Cookbook*, published by O'Reilly. + + +Basic Examples +-------------- + +The following example shows how the :ref:`timeit-command-line-interface` +can be used to compare three different expressions: + +.. code-block:: shell-session + + $ python3 -m timeit '"-".join(str(n) for n in range(100))' + 10000 loops, best of 5: 30.2 usec per loop + $ python3 -m timeit '"-".join([str(n) for n in range(100)])' + 10000 loops, best of 5: 27.5 usec per loop + $ python3 -m timeit '"-".join(map(str, range(100)))' + 10000 loops, best of 5: 23.2 usec per loop + +This can be achieved from the :ref:`python-interface` with:: + + >>> import timeit + >>> timeit.timeit('"-".join(str(n) for n in range(100))', number=10000) + 0.3018611848820001 + >>> timeit.timeit('"-".join([str(n) for n in range(100)])', number=10000) + 0.2727368790656328 + >>> timeit.timeit('"-".join(map(str, range(100)))', number=10000) + 0.23702679807320237 + +A callable can also be passed from the :ref:`python-interface`:: + + >>> timeit.timeit(lambda: "-".join(map(str, range(100))), number=10000) + 0.19665591977536678 + +Note however that :func:`.timeit` will automatically determine the number of +repetitions only when the command-line interface is used. In the +:ref:`timeit-examples` section you can find more advanced examples. + + +.. _python-interface: + +Python Interface +---------------- + +The module defines three convenience functions and a public class: + + +.. function:: timeit(stmt='pass', setup='pass', timer=, number=1000000, globals=None) + + Create a :class:`Timer` instance with the given statement, *setup* code and + *timer* function and run its :meth:`.timeit` method with *number* executions. + The optional *globals* argument specifies a namespace in which to execute the + code. + + .. versionchanged:: 3.5 + The optional *globals* parameter was added. + + +.. function:: repeat(stmt='pass', setup='pass', timer=, repeat=5, number=1000000, globals=None) + + Create a :class:`Timer` instance with the given statement, *setup* code and + *timer* function and run its :meth:`.repeat` method with the given *repeat* + count and *number* executions. The optional *globals* argument specifies a + namespace in which to execute the code. + + .. versionchanged:: 3.5 + The optional *globals* parameter was added. + + .. versionchanged:: 3.7 + Default value of *repeat* changed from 3 to 5. + +.. function:: default_timer() + + The default timer, which is always :func:`time.perf_counter`. + + .. versionchanged:: 3.3 + :func:`time.perf_counter` is now the default timer. + + +.. class:: Timer(stmt='pass', setup='pass', timer=, globals=None) + + Class for timing execution speed of small code snippets. + + The constructor takes a statement to be timed, an additional statement used + for setup, and a timer function. Both statements default to ``'pass'``; + the timer function is platform-dependent (see the module doc string). + *stmt* and *setup* may also contain multiple statements separated by ``;`` + or newlines, as long as they don't contain multi-line string literals. The + statement will by default be executed within timeit's namespace; this behavior + can be controlled by passing a namespace to *globals*. + + To measure the execution time of the first statement, use the :meth:`.timeit` + method. The :meth:`.repeat` and :meth:`.autorange` methods are convenience + methods to call :meth:`.timeit` multiple times. + + The execution time of *setup* is excluded from the overall timed execution run. + + The *stmt* and *setup* parameters can also take objects that are callable + without arguments. This will embed calls to them in a timer function that + will then be executed by :meth:`.timeit`. Note that the timing overhead is a + little larger in this case because of the extra function calls. + + .. versionchanged:: 3.5 + The optional *globals* parameter was added. + + .. method:: Timer.timeit(number=1000000) + + Time *number* executions of the main statement. This executes the setup + statement once, and then returns the time it takes to execute the main + statement a number of times, measured in seconds as a float. + The argument is the number of times through the loop, defaulting to one + million. The main statement, the setup statement and the timer function + to be used are passed to the constructor. + + .. note:: + + By default, :meth:`.timeit` temporarily turns off :term:`garbage + collection` during the timing. The advantage of this approach is that + it makes independent timings more comparable. The disadvantage is + that GC may be an important component of the performance of the + function being measured. If so, GC can be re-enabled as the first + statement in the *setup* string. For example:: + + timeit.Timer('for i in range(10): oct(i)', 'gc.enable()').timeit() + + + .. method:: Timer.autorange(callback=None) + + Automatically determine how many times to call :meth:`.timeit`. + + This is a convenience function that calls :meth:`.timeit` repeatedly + so that the total time >= 0.2 second, returning the eventual + (number of loops, time taken for that number of loops). It calls + :meth:`.timeit` with increasing numbers from the sequence 1, 2, 5, + 10, 20, 50, ... until the time taken is at least 0.2 second. + + If *callback* is given and is not ``None``, it will be called after + each trial with two arguments: ``callback(number, time_taken)``. + + .. versionadded:: 3.6 + + + .. method:: Timer.repeat(repeat=5, number=1000000) + + Call :meth:`.timeit` a few times. + + This is a convenience function that calls the :meth:`.timeit` repeatedly, + returning a list of results. The first argument specifies how many times + to call :meth:`.timeit`. The second argument specifies the *number* + argument for :meth:`.timeit`. + + .. note:: + + It's tempting to calculate mean and standard deviation from the result + vector and report these. However, this is not very useful. + In a typical case, the lowest value gives a lower bound for how fast + your machine can run the given code snippet; higher values in the + result vector are typically not caused by variability in Python's + speed, but by other processes interfering with your timing accuracy. + So the :func:`min` of the result is probably the only number you + should be interested in. After that, you should look at the entire + vector and apply common sense rather than statistics. + + .. versionchanged:: 3.7 + Default value of *repeat* changed from 3 to 5. + + + .. method:: Timer.print_exc(file=None) + + Helper to print a traceback from the timed code. + + Typical use:: + + t = Timer(...) # outside the try/except + try: + t.timeit(...) # or t.repeat(...) + except Exception: + t.print_exc() + + The advantage over the standard traceback is that source lines in the + compiled template will be displayed. The optional *file* argument directs + where the traceback is sent; it defaults to :data:`sys.stderr`. + + +.. _timeit-command-line-interface: + +Command-Line Interface +---------------------- + +When called as a program from the command line, the following form is used:: + + python -m timeit [-n N] [-r N] [-u U] [-s S] [-h] [statement ...] + +Where the following options are understood: + +.. program:: timeit + +.. cmdoption:: -n N, --number=N + + how many times to execute 'statement' + +.. cmdoption:: -r N, --repeat=N + + how many times to repeat the timer (default 5) + +.. cmdoption:: -s S, --setup=S + + statement to be executed once initially (default ``pass``) + +.. cmdoption:: -p, --process + + measure process time, not wallclock time, using :func:`time.process_time` + instead of :func:`time.perf_counter`, which is the default + + .. versionadded:: 3.3 + +.. cmdoption:: -u, --unit=U + + specify a time unit for timer output; can select nsec, usec, msec, or sec + + .. versionadded:: 3.5 + +.. cmdoption:: -v, --verbose + + print raw timing results; repeat for more digits precision + +.. cmdoption:: -h, --help + + print a short usage message and exit + +A multi-line statement may be given by specifying each line as a separate +statement argument; indented lines are possible by enclosing an argument in +quotes and using leading spaces. Multiple :option:`-s` options are treated +similarly. + +If :option:`-n` is not given, a suitable number of loops is calculated by trying +successive powers of 10 until the total time is at least 0.2 seconds. + +:func:`default_timer` measurements can be affected by other programs running on +the same machine, so the best thing to do when accurate timing is necessary is +to repeat the timing a few times and use the best time. The :option:`-r` +option is good for this; the default of 5 repetitions is probably enough in +most cases. You can use :func:`time.process_time` to measure CPU time. + +.. note:: + + There is a certain baseline overhead associated with executing a pass statement. + The code here doesn't try to hide it, but you should be aware of it. The + baseline overhead can be measured by invoking the program without arguments, + and it might differ between Python versions. + + +.. _timeit-examples: + +Examples +-------- + +It is possible to provide a setup statement that is executed only once at the beginning: + +.. code-block:: shell-session + + $ python -m timeit -s 'text = "sample string"; char = "g"' 'char in text' + 5000000 loops, best of 5: 0.0877 usec per loop + $ python -m timeit -s 'text = "sample string"; char = "g"' 'text.find(char)' + 1000000 loops, best of 5: 0.342 usec per loop + +:: + + >>> import timeit + >>> timeit.timeit('char in text', setup='text = "sample string"; char = "g"') + 0.41440500499993504 + >>> timeit.timeit('text.find(char)', setup='text = "sample string"; char = "g"') + 1.7246671520006203 + +The same can be done using the :class:`Timer` class and its methods:: + + >>> import timeit + >>> t = timeit.Timer('char in text', setup='text = "sample string"; char = "g"') + >>> t.timeit() + 0.3955516149999312 + >>> t.repeat() + [0.40183617287970225, 0.37027556854118704, 0.38344867356679524, 0.3712595970846668, 0.37866875250654886] + + +The following examples show how to time expressions that contain multiple lines. +Here we compare the cost of using :func:`hasattr` vs. :keyword:`try`/:keyword:`except` +to test for missing and present object attributes: + +.. code-block:: shell-session + + $ python -m timeit 'try:' ' str.__bool__' 'except AttributeError:' ' pass' + 20000 loops, best of 5: 15.7 usec per loop + $ python -m timeit 'if hasattr(str, "__bool__"): pass' + 50000 loops, best of 5: 4.26 usec per loop + + $ python -m timeit 'try:' ' int.__bool__' 'except AttributeError:' ' pass' + 200000 loops, best of 5: 1.43 usec per loop + $ python -m timeit 'if hasattr(int, "__bool__"): pass' + 100000 loops, best of 5: 2.23 usec per loop + +:: + + >>> import timeit + >>> # attribute is missing + >>> s = """\ + ... try: + ... str.__bool__ + ... except AttributeError: + ... pass + ... """ + >>> timeit.timeit(stmt=s, number=100000) + 0.9138244460009446 + >>> s = "if hasattr(str, '__bool__'): pass" + >>> timeit.timeit(stmt=s, number=100000) + 0.5829014980008651 + >>> + >>> # attribute is present + >>> s = """\ + ... try: + ... int.__bool__ + ... except AttributeError: + ... pass + ... """ + >>> timeit.timeit(stmt=s, number=100000) + 0.04215312199994514 + >>> s = "if hasattr(int, '__bool__'): pass" + >>> timeit.timeit(stmt=s, number=100000) + 0.08588060699912603 + + +To give the :mod:`timeit` module access to functions you define, you can pass a +*setup* parameter which contains an import statement:: + + def test(): + """Stupid test function""" + L = [i for i in range(100)] + + if __name__ == '__main__': + import timeit + print(timeit.timeit("test()", setup="from __main__ import test")) + +Another option is to pass :func:`globals` to the *globals* parameter, which will cause the code +to be executed within your current global namespace. This can be more convenient +than individually specifying imports:: + + def f(x): + return x**2 + def g(x): + return x**4 + def h(x): + return x**8 + + import timeit + print(timeit.timeit('[func(42) for func in (f,g,h)]', globals=globals())) diff --git a/python-3.7.4-docs-html/_sources/library/tk.rst.txt b/python-3.7.4-docs-html/_sources/library/tk.rst.txt new file mode 100644 index 0000000..95cd1c7 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/tk.rst.txt @@ -0,0 +1,46 @@ +.. _tkinter: + +********************************* +Graphical User Interfaces with Tk +********************************* + +.. index:: + single: GUI + single: Graphical User Interface + single: Tkinter + single: Tk + +Tk/Tcl has long been an integral part of Python. It provides a robust and +platform independent windowing toolkit, that is available to Python programmers +using the :mod:`tkinter` package, and its extension, the :mod:`tkinter.tix` and +the :mod:`tkinter.ttk` modules. + +The :mod:`tkinter` package is a thin object-oriented layer on top of Tcl/Tk. To +use :mod:`tkinter`, you don't need to write Tcl code, but you will need to +consult the Tk documentation, and occasionally the Tcl documentation. +:mod:`tkinter` is a set of wrappers that implement the Tk widgets as Python +classes. In addition, the internal module :mod:`_tkinter` provides a threadsafe +mechanism which allows Python and Tcl to interact. + +:mod:`tkinter`'s chief virtues are that it is fast, and that it usually comes +bundled with Python. Although its standard documentation is weak, good +material is available, which includes: references, tutorials, a book and +others. :mod:`tkinter` is also famous for having an outdated look and feel, +which has been vastly improved in Tk 8.5. Nevertheless, there are many other +GUI libraries that you could be interested in. For more information about +alternatives, see the :ref:`other-gui-packages` section. + +.. toctree:: + + tkinter.rst + tkinter.ttk.rst + tkinter.tix.rst + tkinter.scrolledtext.rst + idle.rst + othergui.rst + +.. Other sections I have in mind are + Tkinter internals + Freezing Tkinter applications + + diff --git a/python-3.7.4-docs-html/_sources/library/tkinter.rst.txt b/python-3.7.4-docs-html/_sources/library/tkinter.rst.txt new file mode 100644 index 0000000..e1fc051 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/tkinter.rst.txt @@ -0,0 +1,863 @@ +:mod:`tkinter` --- Python interface to Tcl/Tk +============================================= + +.. module:: tkinter + :synopsis: Interface to Tcl/Tk for graphical user interfaces + +.. moduleauthor:: Guido van Rossum + +**Source code:** :source:`Lib/tkinter/__init__.py` + +-------------- + +The :mod:`tkinter` package ("Tk interface") is the standard Python interface to +the Tk GUI toolkit. Both Tk and :mod:`tkinter` are available on most Unix +platforms, as well as on Windows systems. (Tk itself is not part of Python; it +is maintained at ActiveState.) + +Running ``python -m tkinter`` from the command line should open a window +demonstrating a simple Tk interface, letting you know that :mod:`tkinter` is +properly installed on your system, and also showing what version of Tcl/Tk is +installed, so you can read the Tcl/Tk documentation specific to that version. + +.. seealso:: + + Tkinter documentation: + + `Python Tkinter Resources `_ + The Python Tkinter Topic Guide provides a great deal of information on using Tk + from Python and links to other sources of information on Tk. + + `TKDocs `_ + Extensive tutorial plus friendlier widget pages for some of the widgets. + + `Tkinter 8.5 reference: a GUI for Python `_ + On-line reference material. + + `Tkinter docs from effbot `_ + Online reference for tkinter supported by effbot.org. + + `Programming Python `_ + Book by Mark Lutz, has excellent coverage of Tkinter. + + `Modern Tkinter for Busy Python Developers `_ + Book by Mark Roseman about building attractive and modern graphical user interfaces with Python and Tkinter. + + `Python and Tkinter Programming `_ + Book by John Grayson (ISBN 1-884777-81-3). + + Tcl/Tk documentation: + + `Tk commands `_ + Most commands are available as :mod:`tkinter` or :mod:`tkinter.ttk` classes. + Change '8.6' to match the version of your Tcl/Tk installation. + + `Tcl/Tk recent man pages `_ + Recent Tcl/Tk manuals on www.tcl.tk. + + `ActiveState Tcl Home Page `_ + The Tk/Tcl development is largely taking place at ActiveState. + + `Tcl and the Tk Toolkit `_ + Book by John Ousterhout, the inventor of Tcl. + + `Practical Programming in Tcl and Tk `_ + Brent Welch's encyclopedic book. + + +Tkinter Modules +--------------- + +Most of the time, :mod:`tkinter` is all you really need, but a number of +additional modules are available as well. The Tk interface is located in a +binary module named :mod:`_tkinter`. This module contains the low-level +interface to Tk, and should never be used directly by application programmers. +It is usually a shared library (or DLL), but might in some cases be statically +linked with the Python interpreter. + +In addition to the Tk interface module, :mod:`tkinter` includes a number of +Python modules, :mod:`tkinter.constants` being one of the most important. +Importing :mod:`tkinter` will automatically import :mod:`tkinter.constants`, +so, usually, to use Tkinter all you need is a simple import statement:: + + import tkinter + +Or, more often:: + + from tkinter import * + + +.. class:: Tk(screenName=None, baseName=None, className='Tk', useTk=1) + + The :class:`Tk` class is instantiated without arguments. This creates a toplevel + widget of Tk which usually is the main window of an application. Each instance + has its own associated Tcl interpreter. + + .. FIXME: The following keyword arguments are currently recognized: + + +.. function:: Tcl(screenName=None, baseName=None, className='Tk', useTk=0) + + The :func:`Tcl` function is a factory function which creates an object much like + that created by the :class:`Tk` class, except that it does not initialize the Tk + subsystem. This is most often useful when driving the Tcl interpreter in an + environment where one doesn't want to create extraneous toplevel windows, or + where one cannot (such as Unix/Linux systems without an X server). An object + created by the :func:`Tcl` object can have a Toplevel window created (and the Tk + subsystem initialized) by calling its :meth:`loadtk` method. + + +Other modules that provide Tk support include: + +:mod:`tkinter.scrolledtext` + Text widget with a vertical scroll bar built in. + +:mod:`tkinter.colorchooser` + Dialog to let the user choose a color. + +:mod:`tkinter.commondialog` + Base class for the dialogs defined in the other modules listed here. + +:mod:`tkinter.filedialog` + Common dialogs to allow the user to specify a file to open or save. + +:mod:`tkinter.font` + Utilities to help work with fonts. + +:mod:`tkinter.messagebox` + Access to standard Tk dialog boxes. + +:mod:`tkinter.simpledialog` + Basic dialogs and convenience functions. + +:mod:`tkinter.dnd` + Drag-and-drop support for :mod:`tkinter`. This is experimental and should + become deprecated when it is replaced with the Tk DND. + +:mod:`turtle` + Turtle graphics in a Tk window. + + +Tkinter Life Preserver +---------------------- + +.. sectionauthor:: Matt Conway + + +This section is not designed to be an exhaustive tutorial on either Tk or +Tkinter. Rather, it is intended as a stop gap, providing some introductory +orientation on the system. + +Credits: + +* Tk was written by John Ousterhout while at Berkeley. + +* Tkinter was written by Steen Lumholt and Guido van Rossum. + +* This Life Preserver was written by Matt Conway at the University of Virginia. + +* The HTML rendering, and some liberal editing, was produced from a FrameMaker + version by Ken Manheimer. + +* Fredrik Lundh elaborated and revised the class interface descriptions, to get + them current with Tk 4.2. + +* Mike Clarkson converted the documentation to LaTeX, and compiled the User + Interface chapter of the reference manual. + + +How To Use This Section +^^^^^^^^^^^^^^^^^^^^^^^ + +This section is designed in two parts: the first half (roughly) covers +background material, while the second half can be taken to the keyboard as a +handy reference. + +When trying to answer questions of the form "how do I do blah", it is often best +to find out how to do "blah" in straight Tk, and then convert this back into the +corresponding :mod:`tkinter` call. Python programmers can often guess at the +correct Python command by looking at the Tk documentation. This means that in +order to use Tkinter, you will have to know a little bit about Tk. This document +can't fulfill that role, so the best we can do is point you to the best +documentation that exists. Here are some hints: + +* The authors strongly suggest getting a copy of the Tk man pages. + Specifically, the man pages in the ``manN`` directory are most useful. + The ``man3`` man pages describe the C interface to the Tk library and thus + are not especially helpful for script writers. + +* Addison-Wesley publishes a book called Tcl and the Tk Toolkit by John + Ousterhout (ISBN 0-201-63337-X) which is a good introduction to Tcl and Tk for + the novice. The book is not exhaustive, and for many details it defers to the + man pages. + +* :file:`tkinter/__init__.py` is a last resort for most, but can be a good + place to go when nothing else makes sense. + + +A Simple Hello World Program +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:: + + import tkinter as tk + + class Application(tk.Frame): + def __init__(self, master=None): + super().__init__(master) + self.master = master + self.pack() + self.create_widgets() + + def create_widgets(self): + self.hi_there = tk.Button(self) + self.hi_there["text"] = "Hello World\n(click me)" + self.hi_there["command"] = self.say_hi + self.hi_there.pack(side="top") + + self.quit = tk.Button(self, text="QUIT", fg="red", + command=self.master.destroy) + self.quit.pack(side="bottom") + + def say_hi(self): + print("hi there, everyone!") + + root = tk.Tk() + app = Application(master=root) + app.mainloop() + + +A (Very) Quick Look at Tcl/Tk +----------------------------- + +The class hierarchy looks complicated, but in actual practice, application +programmers almost always refer to the classes at the very bottom of the +hierarchy. + +Notes: + +* These classes are provided for the purposes of organizing certain functions + under one namespace. They aren't meant to be instantiated independently. + +* The :class:`Tk` class is meant to be instantiated only once in an application. + Application programmers need not instantiate one explicitly, the system creates + one whenever any of the other classes are instantiated. + +* The :class:`Widget` class is not meant to be instantiated, it is meant only + for subclassing to make "real" widgets (in C++, this is called an 'abstract + class'). + +To make use of this reference material, there will be times when you will need +to know how to read short passages of Tk and how to identify the various parts +of a Tk command. (See section :ref:`tkinter-basic-mapping` for the +:mod:`tkinter` equivalents of what's below.) + +Tk scripts are Tcl programs. Like all Tcl programs, Tk scripts are just lists +of tokens separated by spaces. A Tk widget is just its *class*, the *options* +that help configure it, and the *actions* that make it do useful things. + +To make a widget in Tk, the command is always of the form:: + + classCommand newPathname options + +*classCommand* + denotes which kind of widget to make (a button, a label, a menu...) + +.. index:: single: . (dot); in Tkinter + +*newPathname* + is the new name for this widget. All names in Tk must be unique. To help + enforce this, widgets in Tk are named with *pathnames*, just like files in a + file system. The top level widget, the *root*, is called ``.`` (period) and + children are delimited by more periods. For example, + ``.myApp.controlPanel.okButton`` might be the name of a widget. + +*options* + configure the widget's appearance and in some cases, its behavior. The options + come in the form of a list of flags and values. Flags are preceded by a '-', + like Unix shell command flags, and values are put in quotes if they are more + than one word. + +For example:: + + button .fred -fg red -text "hi there" + ^ ^ \______________________/ + | | | + class new options + command widget (-opt val -opt val ...) + +Once created, the pathname to the widget becomes a new command. This new +*widget command* is the programmer's handle for getting the new widget to +perform some *action*. In C, you'd express this as someAction(fred, +someOptions), in C++, you would express this as fred.someAction(someOptions), +and in Tk, you say:: + + .fred someAction someOptions + +Note that the object name, ``.fred``, starts with a dot. + +As you'd expect, the legal values for *someAction* will depend on the widget's +class: ``.fred disable`` works if fred is a button (fred gets greyed out), but +does not work if fred is a label (disabling of labels is not supported in Tk). + +The legal values of *someOptions* is action dependent. Some actions, like +``disable``, require no arguments, others, like a text-entry box's ``delete`` +command, would need arguments to specify what range of text to delete. + + +.. _tkinter-basic-mapping: + +Mapping Basic Tk into Tkinter +----------------------------- + +Class commands in Tk correspond to class constructors in Tkinter. :: + + button .fred =====> fred = Button() + +The master of an object is implicit in the new name given to it at creation +time. In Tkinter, masters are specified explicitly. :: + + button .panel.fred =====> fred = Button(panel) + +The configuration options in Tk are given in lists of hyphened tags followed by +values. In Tkinter, options are specified as keyword-arguments in the instance +constructor, and keyword-args for configure calls or as instance indices, in +dictionary style, for established instances. See section +:ref:`tkinter-setting-options` on setting options. :: + + button .fred -fg red =====> fred = Button(panel, fg="red") + .fred configure -fg red =====> fred["fg"] = red + OR ==> fred.config(fg="red") + +In Tk, to perform an action on a widget, use the widget name as a command, and +follow it with an action name, possibly with arguments (options). In Tkinter, +you call methods on the class instance to invoke actions on the widget. The +actions (methods) that a given widget can perform are listed in +:file:`tkinter/__init__.py`. :: + + .fred invoke =====> fred.invoke() + +To give a widget to the packer (geometry manager), you call pack with optional +arguments. In Tkinter, the Pack class holds all this functionality, and the +various forms of the pack command are implemented as methods. All widgets in +:mod:`tkinter` are subclassed from the Packer, and so inherit all the packing +methods. See the :mod:`tkinter.tix` module documentation for additional +information on the Form geometry manager. :: + + pack .fred -side left =====> fred.pack(side="left") + + +How Tk and Tkinter are Related +------------------------------ + +From the top down: + +Your App Here (Python) + A Python application makes a :mod:`tkinter` call. + +tkinter (Python Package) + This call (say, for example, creating a button widget), is implemented in + the :mod:`tkinter` package, which is written in Python. This Python + function will parse the commands and the arguments and convert them into a + form that makes them look as if they had come from a Tk script instead of + a Python script. + +_tkinter (C) + These commands and their arguments will be passed to a C function in the + :mod:`_tkinter` - note the underscore - extension module. + +Tk Widgets (C and Tcl) + This C function is able to make calls into other C modules, including the C + functions that make up the Tk library. Tk is implemented in C and some Tcl. + The Tcl part of the Tk widgets is used to bind certain default behaviors to + widgets, and is executed once at the point where the Python :mod:`tkinter` + package is imported. (The user never sees this stage). + +Tk (C) + The Tk part of the Tk Widgets implement the final mapping to ... + +Xlib (C) + the Xlib library to draw graphics on the screen. + + +Handy Reference +--------------- + + +.. _tkinter-setting-options: + +Setting Options +^^^^^^^^^^^^^^^ + +Options control things like the color and border width of a widget. Options can +be set in three ways: + +At object creation time, using keyword arguments + :: + + fred = Button(self, fg="red", bg="blue") + +After object creation, treating the option name like a dictionary index + :: + + fred["fg"] = "red" + fred["bg"] = "blue" + +Use the config() method to update multiple attrs subsequent to object creation + :: + + fred.config(fg="red", bg="blue") + +For a complete explanation of a given option and its behavior, see the Tk man +pages for the widget in question. + +Note that the man pages list "STANDARD OPTIONS" and "WIDGET SPECIFIC OPTIONS" +for each widget. The former is a list of options that are common to many +widgets, the latter are the options that are idiosyncratic to that particular +widget. The Standard Options are documented on the :manpage:`options(3)` man +page. + +No distinction between standard and widget-specific options is made in this +document. Some options don't apply to some kinds of widgets. Whether a given +widget responds to a particular option depends on the class of the widget; +buttons have a ``command`` option, labels do not. + +The options supported by a given widget are listed in that widget's man page, or +can be queried at runtime by calling the :meth:`config` method without +arguments, or by calling the :meth:`keys` method on that widget. The return +value of these calls is a dictionary whose key is the name of the option as a +string (for example, ``'relief'``) and whose values are 5-tuples. + +Some options, like ``bg`` are synonyms for common options with long names +(``bg`` is shorthand for "background"). Passing the ``config()`` method the name +of a shorthand option will return a 2-tuple, not 5-tuple. The 2-tuple passed +back will contain the name of the synonym and the "real" option (such as +``('bg', 'background')``). + ++-------+---------------------------------+--------------+ +| Index | Meaning | Example | ++=======+=================================+==============+ +| 0 | option name | ``'relief'`` | ++-------+---------------------------------+--------------+ +| 1 | option name for database lookup | ``'relief'`` | ++-------+---------------------------------+--------------+ +| 2 | option class for database | ``'Relief'`` | +| | lookup | | ++-------+---------------------------------+--------------+ +| 3 | default value | ``'raised'`` | ++-------+---------------------------------+--------------+ +| 4 | current value | ``'groove'`` | ++-------+---------------------------------+--------------+ + +Example:: + + >>> print(fred.config()) + {'relief': ('relief', 'relief', 'Relief', 'raised', 'groove')} + +Of course, the dictionary printed will include all the options available and +their values. This is meant only as an example. + + +The Packer +^^^^^^^^^^ + +.. index:: single: packing (widgets) + +The packer is one of Tk's geometry-management mechanisms. Geometry managers +are used to specify the relative positioning of the positioning of widgets +within their container - their mutual *master*. In contrast to the more +cumbersome *placer* (which is used less commonly, and we do not cover here), the +packer takes qualitative relationship specification - *above*, *to the left of*, +*filling*, etc - and works everything out to determine the exact placement +coordinates for you. + +The size of any *master* widget is determined by the size of the "slave widgets" +inside. The packer is used to control where slave widgets appear inside the +master into which they are packed. You can pack widgets into frames, and frames +into other frames, in order to achieve the kind of layout you desire. +Additionally, the arrangement is dynamically adjusted to accommodate incremental +changes to the configuration, once it is packed. + +Note that widgets do not appear until they have had their geometry specified +with a geometry manager. It's a common early mistake to leave out the geometry +specification, and then be surprised when the widget is created but nothing +appears. A widget will appear only after it has had, for example, the packer's +:meth:`pack` method applied to it. + +The pack() method can be called with keyword-option/value pairs that control +where the widget is to appear within its container, and how it is to behave when +the main application window is resized. Here are some examples:: + + fred.pack() # defaults to side = "top" + fred.pack(side="left") + fred.pack(expand=1) + + +Packer Options +^^^^^^^^^^^^^^ + +For more extensive information on the packer and the options that it can take, +see the man pages and page 183 of John Ousterhout's book. + +anchor + Anchor type. Denotes where the packer is to place each slave in its parcel. + +expand + Boolean, ``0`` or ``1``. + +fill + Legal values: ``'x'``, ``'y'``, ``'both'``, ``'none'``. + +ipadx and ipady + A distance - designating internal padding on each side of the slave widget. + +padx and pady + A distance - designating external padding on each side of the slave widget. + +side + Legal values are: ``'left'``, ``'right'``, ``'top'``, ``'bottom'``. + + +Coupling Widget Variables +^^^^^^^^^^^^^^^^^^^^^^^^^ + +The current-value setting of some widgets (like text entry widgets) can be +connected directly to application variables by using special options. These +options are ``variable``, ``textvariable``, ``onvalue``, ``offvalue``, and +``value``. This connection works both ways: if the variable changes for any +reason, the widget it's connected to will be updated to reflect the new value. + +Unfortunately, in the current implementation of :mod:`tkinter` it is not +possible to hand over an arbitrary Python variable to a widget through a +``variable`` or ``textvariable`` option. The only kinds of variables for which +this works are variables that are subclassed from a class called Variable, +defined in :mod:`tkinter`. + +There are many useful subclasses of Variable already defined: +:class:`StringVar`, :class:`IntVar`, :class:`DoubleVar`, and +:class:`BooleanVar`. To read the current value of such a variable, call the +:meth:`get` method on it, and to change its value you call the :meth:`!set` +method. If you follow this protocol, the widget will always track the value of +the variable, with no further intervention on your part. + +For example:: + + class App(Frame): + def __init__(self, master=None): + super().__init__(master) + self.pack() + + self.entrythingy = Entry() + self.entrythingy.pack() + + # here is the application variable + self.contents = StringVar() + # set it to some value + self.contents.set("this is a variable") + # tell the entry widget to watch this variable + self.entrythingy["textvariable"] = self.contents + + # and here we get a callback when the user hits return. + # we will have the program print out the value of the + # application variable when the user hits return + self.entrythingy.bind('', + self.print_contents) + + def print_contents(self, event): + print("hi. contents of entry is now ---->", + self.contents.get()) + + +The Window Manager +^^^^^^^^^^^^^^^^^^ + +.. index:: single: window manager (widgets) + +In Tk, there is a utility command, ``wm``, for interacting with the window +manager. Options to the ``wm`` command allow you to control things like titles, +placement, icon bitmaps, and the like. In :mod:`tkinter`, these commands have +been implemented as methods on the :class:`Wm` class. Toplevel widgets are +subclassed from the :class:`Wm` class, and so can call the :class:`Wm` methods +directly. + +To get at the toplevel window that contains a given widget, you can often just +refer to the widget's master. Of course if the widget has been packed inside of +a frame, the master won't represent a toplevel window. To get at the toplevel +window that contains an arbitrary widget, you can call the :meth:`_root` method. +This method begins with an underscore to denote the fact that this function is +part of the implementation, and not an interface to Tk functionality. + +Here are some examples of typical usage:: + + import tkinter as tk + + class App(tk.Frame): + def __init__(self, master=None): + super().__init__(master) + self.pack() + + # create the application + myapp = App() + + # + # here are method calls to the window manager class + # + myapp.master.title("My Do-Nothing Application") + myapp.master.maxsize(1000, 400) + + # start the program + myapp.mainloop() + + +Tk Option Data Types +^^^^^^^^^^^^^^^^^^^^ + +.. index:: single: Tk Option Data Types + +anchor + Legal values are points of the compass: ``"n"``, ``"ne"``, ``"e"``, ``"se"``, + ``"s"``, ``"sw"``, ``"w"``, ``"nw"``, and also ``"center"``. + +bitmap + There are eight built-in, named bitmaps: ``'error'``, ``'gray25'``, + ``'gray50'``, ``'hourglass'``, ``'info'``, ``'questhead'``, ``'question'``, + ``'warning'``. To specify an X bitmap filename, give the full path to the file, + preceded with an ``@``, as in ``"@/usr/contrib/bitmap/gumby.bit"``. + +boolean + You can pass integers 0 or 1 or the strings ``"yes"`` or ``"no"``. + +callback + This is any Python function that takes no arguments. For example:: + + def print_it(): + print("hi there") + fred["command"] = print_it + +color + Colors can be given as the names of X colors in the rgb.txt file, or as strings + representing RGB values in 4 bit: ``"#RGB"``, 8 bit: ``"#RRGGBB"``, 12 bit" + ``"#RRRGGGBBB"``, or 16 bit ``"#RRRRGGGGBBBB"`` ranges, where R,G,B here + represent any legal hex digit. See page 160 of Ousterhout's book for details. + +cursor + The standard X cursor names from :file:`cursorfont.h` can be used, without the + ``XC_`` prefix. For example to get a hand cursor (:const:`XC_hand2`), use the + string ``"hand2"``. You can also specify a bitmap and mask file of your own. + See page 179 of Ousterhout's book. + +distance + Screen distances can be specified in either pixels or absolute distances. + Pixels are given as numbers and absolute distances as strings, with the trailing + character denoting units: ``c`` for centimetres, ``i`` for inches, ``m`` for + millimetres, ``p`` for printer's points. For example, 3.5 inches is expressed + as ``"3.5i"``. + +font + Tk uses a list font name format, such as ``{courier 10 bold}``. Font sizes with + positive numbers are measured in points; sizes with negative numbers are + measured in pixels. + +geometry + This is a string of the form ``widthxheight``, where width and height are + measured in pixels for most widgets (in characters for widgets displaying text). + For example: ``fred["geometry"] = "200x100"``. + +justify + Legal values are the strings: ``"left"``, ``"center"``, ``"right"``, and + ``"fill"``. + +region + This is a string with four space-delimited elements, each of which is a legal + distance (see above). For example: ``"2 3 4 5"`` and ``"3i 2i 4.5i 2i"`` and + ``"3c 2c 4c 10.43c"`` are all legal regions. + +relief + Determines what the border style of a widget will be. Legal values are: + ``"raised"``, ``"sunken"``, ``"flat"``, ``"groove"``, and ``"ridge"``. + +scrollcommand + This is almost always the :meth:`!set` method of some scrollbar widget, but can + be any widget method that takes a single argument. + +wrap: + Must be one of: ``"none"``, ``"char"``, or ``"word"``. + + +Bindings and Events +^^^^^^^^^^^^^^^^^^^ + +.. index:: + single: bind (widgets) + single: events (widgets) + +The bind method from the widget command allows you to watch for certain events +and to have a callback function trigger when that event type occurs. The form +of the bind method is:: + + def bind(self, sequence, func, add=''): + +where: + +sequence + is a string that denotes the target kind of event. (See the bind man page and + page 201 of John Ousterhout's book for details). + +func + is a Python function, taking one argument, to be invoked when the event occurs. + An Event instance will be passed as the argument. (Functions deployed this way + are commonly known as *callbacks*.) + +add + is optional, either ``''`` or ``'+'``. Passing an empty string denotes that + this binding is to replace any other bindings that this event is associated + with. Passing a ``'+'`` means that this function is to be added to the list + of functions bound to this event type. + +For example:: + + def turn_red(self, event): + event.widget["activeforeground"] = "red" + + self.button.bind("", self.turn_red) + +Notice how the widget field of the event is being accessed in the +``turn_red()`` callback. This field contains the widget that caught the X +event. The following table lists the other event fields you can access, and how +they are denoted in Tk, which can be useful when referring to the Tk man pages. + ++----+---------------------+----+---------------------+ +| Tk | Tkinter Event Field | Tk | Tkinter Event Field | ++====+=====================+====+=====================+ +| %f | focus | %A | char | ++----+---------------------+----+---------------------+ +| %h | height | %E | send_event | ++----+---------------------+----+---------------------+ +| %k | keycode | %K | keysym | ++----+---------------------+----+---------------------+ +| %s | state | %N | keysym_num | ++----+---------------------+----+---------------------+ +| %t | time | %T | type | ++----+---------------------+----+---------------------+ +| %w | width | %W | widget | ++----+---------------------+----+---------------------+ +| %x | x | %X | x_root | ++----+---------------------+----+---------------------+ +| %y | y | %Y | y_root | ++----+---------------------+----+---------------------+ + + +The index Parameter +^^^^^^^^^^^^^^^^^^^ + +A number of widgets require "index" parameters to be passed. These are used to +point at a specific place in a Text widget, or to particular characters in an +Entry widget, or to particular menu items in a Menu widget. + +Entry widget indexes (index, view index, etc.) + Entry widgets have options that refer to character positions in the text being + displayed. You can use these :mod:`tkinter` functions to access these special + points in text widgets: + +Text widget indexes + The index notation for Text widgets is very rich and is best described in the Tk + man pages. + +Menu indexes (menu.invoke(), menu.entryconfig(), etc.) + Some options and methods for menus manipulate specific menu entries. Anytime a + menu index is needed for an option or a parameter, you may pass in: + + * an integer which refers to the numeric position of the entry in the widget, + counted from the top, starting with 0; + + * the string ``"active"``, which refers to the menu position that is currently + under the cursor; + + * the string ``"last"`` which refers to the last menu item; + + * An integer preceded by ``@``, as in ``@6``, where the integer is interpreted + as a y pixel coordinate in the menu's coordinate system; + + * the string ``"none"``, which indicates no menu entry at all, most often used + with menu.activate() to deactivate all entries, and finally, + + * a text string that is pattern matched against the label of the menu entry, as + scanned from the top of the menu to the bottom. Note that this index type is + considered after all the others, which means that matches for menu items + labelled ``last``, ``active``, or ``none`` may be interpreted as the above + literals, instead. + + +Images +^^^^^^ + +Images of different formats can be created through the corresponding subclass +of :class:`tkinter.Image`: + +* :class:`BitmapImage` for images in XBM format. + +* :class:`PhotoImage` for images in PGM, PPM, GIF and PNG formats. The latter + is supported starting with Tk 8.6. + +Either type of image is created through either the ``file`` or the ``data`` +option (other options are available as well). + +The image object can then be used wherever an ``image`` option is supported by +some widget (e.g. labels, buttons, menus). In these cases, Tk will not keep a +reference to the image. When the last Python reference to the image object is +deleted, the image data is deleted as well, and Tk will display an empty box +wherever the image was used. + +.. seealso:: + + The `Pillow `_ package adds support for + formats such as BMP, JPEG, TIFF, and WebP, among others. + +.. _tkinter-file-handlers: + +File Handlers +------------- + +Tk allows you to register and unregister a callback function which will be +called from the Tk mainloop when I/O is possible on a file descriptor. +Only one handler may be registered per file descriptor. Example code:: + + import tkinter + widget = tkinter.Tk() + mask = tkinter.READABLE | tkinter.WRITABLE + widget.tk.createfilehandler(file, mask, callback) + ... + widget.tk.deletefilehandler(file) + +This feature is not available on Windows. + +Since you don't know how many bytes are available for reading, you may not +want to use the :class:`~io.BufferedIOBase` or :class:`~io.TextIOBase` +:meth:`~io.BufferedIOBase.read` or :meth:`~io.IOBase.readline` methods, +since these will insist on reading a predefined number of bytes. +For sockets, the :meth:`~socket.socket.recv` or +:meth:`~socket.socket.recvfrom` methods will work fine; for other files, +use raw reads or ``os.read(file.fileno(), maxbytecount)``. + + +.. method:: Widget.tk.createfilehandler(file, mask, func) + + Registers the file handler callback function *func*. The *file* argument + may either be an object with a :meth:`~io.IOBase.fileno` method (such as + a file or socket object), or an integer file descriptor. The *mask* + argument is an ORed combination of any of the three constants below. + The callback is called as follows:: + + callback(file, mask) + + +.. method:: Widget.tk.deletefilehandler(file) + + Unregisters a file handler. + + +.. data:: READABLE + WRITABLE + EXCEPTION + + Constants used in the *mask* arguments. diff --git a/python-3.7.4-docs-html/_sources/library/tkinter.scrolledtext.rst.txt b/python-3.7.4-docs-html/_sources/library/tkinter.scrolledtext.rst.txt new file mode 100644 index 0000000..138720e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/tkinter.scrolledtext.rst.txt @@ -0,0 +1,36 @@ +:mod:`tkinter.scrolledtext` --- Scrolled Text Widget +==================================================== + +.. module:: tkinter.scrolledtext + :platform: Tk + :synopsis: Text widget with a vertical scroll bar. + +.. sectionauthor:: Fred L. Drake, Jr. + +**Source code:** :source:`Lib/tkinter/scrolledtext.py` + +-------------- + +The :mod:`tkinter.scrolledtext` module provides a class of the same name which +implements a basic text widget which has a vertical scroll bar configured to do +the "right thing." Using the :class:`ScrolledText` class is a lot easier than +setting up a text widget and scroll bar directly. The constructor is the same +as that of the :class:`tkinter.Text` class. + +The text widget and scrollbar are packed together in a :class:`Frame`, and the +methods of the :class:`Grid` and :class:`Pack` geometry managers are acquired +from the :class:`Frame` object. This allows the :class:`ScrolledText` widget to +be used directly to achieve most normal geometry management behavior. + +Should more specific control be necessary, the following attributes are +available: + + +.. attribute:: ScrolledText.frame + + The frame which surrounds the text and scroll bar widgets. + + +.. attribute:: ScrolledText.vbar + + The scroll bar widget. diff --git a/python-3.7.4-docs-html/_sources/library/tkinter.tix.rst.txt b/python-3.7.4-docs-html/_sources/library/tkinter.tix.rst.txt new file mode 100644 index 0000000..88b936c --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/tkinter.tix.rst.txt @@ -0,0 +1,583 @@ +:mod:`tkinter.tix` --- Extension widgets for Tk +=============================================== + +.. module:: tkinter.tix + :synopsis: Tk Extension Widgets for Tkinter + +.. sectionauthor:: Mike Clarkson + +**Source code:** :source:`Lib/tkinter/tix.py` + +.. index:: single: Tix + +.. deprecated:: 3.6 + This Tk extension is unmaintained and should not be used in new code. Use + :mod:`tkinter.ttk` instead. + +-------------- + +The :mod:`tkinter.tix` (Tk Interface Extension) module provides an additional +rich set of widgets. Although the standard Tk library has many useful widgets, +they are far from complete. The :mod:`tkinter.tix` library provides most of the +commonly needed widgets that are missing from standard Tk: :class:`HList`, +:class:`ComboBox`, :class:`Control` (a.k.a. SpinBox) and an assortment of +scrollable widgets. +:mod:`tkinter.tix` also includes many more widgets that are generally useful in +a wide range of applications: :class:`NoteBook`, :class:`FileEntry`, +:class:`PanedWindow`, etc; there are more than 40 of them. + +With all these new widgets, you can introduce new interaction techniques into +applications, creating more useful and more intuitive user interfaces. You can +design your application by choosing the most appropriate widgets to match the +special needs of your application and users. + +.. seealso:: + + `Tix Homepage `_ + The home page for :mod:`Tix`. This includes links to additional documentation + and downloads. + + `Tix Man Pages `_ + On-line version of the man pages and reference material. + + `Tix Programming Guide `_ + On-line version of the programmer's reference material. + + `Tix Development Applications `_ + Tix applications for development of Tix and Tkinter programs. Tide applications + work under Tk or Tkinter, and include :program:`TixInspect`, an inspector to + remotely modify and debug Tix/Tk/Tkinter applications. + + +Using Tix +--------- + + +.. class:: Tk(screenName=None, baseName=None, className='Tix') + + Toplevel widget of Tix which represents mostly the main window of an + application. It has an associated Tcl interpreter. + + Classes in the :mod:`tkinter.tix` module subclasses the classes in the + :mod:`tkinter`. The former imports the latter, so to use :mod:`tkinter.tix` + with Tkinter, all you need to do is to import one module. In general, you + can just import :mod:`tkinter.tix`, and replace the toplevel call to + :class:`tkinter.Tk` with :class:`tix.Tk`:: + + from tkinter import tix + from tkinter.constants import * + root = tix.Tk() + +To use :mod:`tkinter.tix`, you must have the Tix widgets installed, usually +alongside your installation of the Tk widgets. To test your installation, try +the following:: + + from tkinter import tix + root = tix.Tk() + root.tk.eval('package require Tix') + + +Tix Widgets +----------- + +`Tix `_ +introduces over 40 widget classes to the :mod:`tkinter` repertoire. + + +Basic Widgets +^^^^^^^^^^^^^ + + +.. class:: Balloon() + + A `Balloon + `_ that + pops up over a widget to provide help. When the user moves the cursor inside a + widget to which a Balloon widget has been bound, a small pop-up window with a + descriptive message will be shown on the screen. + +.. Python Demo of: +.. \ulink{Balloon}{http://tix.sourceforge.net/dist/current/demos/samples/Balloon.tcl} + + +.. class:: ButtonBox() + + The `ButtonBox + `_ + widget creates a box of buttons, such as is commonly used for ``Ok Cancel``. + +.. Python Demo of: +.. \ulink{ButtonBox}{http://tix.sourceforge.net/dist/current/demos/samples/BtnBox.tcl} + + +.. class:: ComboBox() + + The `ComboBox + `_ + widget is similar to the combo box control in MS Windows. The user can select a + choice by either typing in the entry subwidget or selecting from the listbox + subwidget. + +.. Python Demo of: +.. \ulink{ComboBox}{http://tix.sourceforge.net/dist/current/demos/samples/ComboBox.tcl} + + +.. class:: Control() + + The `Control + `_ + widget is also known as the :class:`SpinBox` widget. The user can adjust the + value by pressing the two arrow buttons or by entering the value directly into + the entry. The new value will be checked against the user-defined upper and + lower limits. + +.. Python Demo of: +.. \ulink{Control}{http://tix.sourceforge.net/dist/current/demos/samples/Control.tcl} + + +.. class:: LabelEntry() + + The `LabelEntry + `_ + widget packages an entry widget and a label into one mega widget. It can + be used to simplify the creation of "entry-form" type of interface. + +.. Python Demo of: +.. \ulink{LabelEntry}{http://tix.sourceforge.net/dist/current/demos/samples/LabEntry.tcl} + + +.. class:: LabelFrame() + + The `LabelFrame + `_ + widget packages a frame widget and a label into one mega widget. To create + widgets inside a LabelFrame widget, one creates the new widgets relative to the + :attr:`frame` subwidget and manage them inside the :attr:`frame` subwidget. + +.. Python Demo of: +.. \ulink{LabelFrame}{http://tix.sourceforge.net/dist/current/demos/samples/LabFrame.tcl} + + +.. class:: Meter() + + The `Meter + `_ widget + can be used to show the progress of a background job which may take a long time + to execute. + +.. Python Demo of: +.. \ulink{Meter}{http://tix.sourceforge.net/dist/current/demos/samples/Meter.tcl} + + +.. class:: OptionMenu() + + The `OptionMenu + `_ + creates a menu button of options. + +.. Python Demo of: +.. \ulink{OptionMenu}{http://tix.sourceforge.net/dist/current/demos/samples/OptMenu.tcl} + + +.. class:: PopupMenu() + + The `PopupMenu + `_ + widget can be used as a replacement of the ``tk_popup`` command. The advantage + of the :mod:`Tix` :class:`PopupMenu` widget is it requires less application code + to manipulate. + +.. Python Demo of: +.. \ulink{PopupMenu}{http://tix.sourceforge.net/dist/current/demos/samples/PopMenu.tcl} + + +.. class:: Select() + + The `Select + `_ widget + is a container of button subwidgets. It can be used to provide radio-box or + check-box style of selection options for the user. + +.. Python Demo of: +.. \ulink{Select}{http://tix.sourceforge.net/dist/current/demos/samples/Select.tcl} + + +.. class:: StdButtonBox() + + The `StdButtonBox + `_ + widget is a group of standard buttons for Motif-like dialog boxes. + +.. Python Demo of: +.. \ulink{StdButtonBox}{http://tix.sourceforge.net/dist/current/demos/samples/StdBBox.tcl} + + +File Selectors +^^^^^^^^^^^^^^ + + +.. class:: DirList() + + The `DirList + `_ + widget displays a list view of a directory, its previous directories and its + sub-directories. The user can choose one of the directories displayed in the + list or change to another directory. + +.. Python Demo of: +.. \ulink{DirList}{http://tix.sourceforge.net/dist/current/demos/samples/DirList.tcl} + + +.. class:: DirTree() + + The `DirTree + `_ + widget displays a tree view of a directory, its previous directories and its + sub-directories. The user can choose one of the directories displayed in the + list or change to another directory. + +.. Python Demo of: +.. \ulink{DirTree}{http://tix.sourceforge.net/dist/current/demos/samples/DirTree.tcl} + + +.. class:: DirSelectDialog() + + The `DirSelectDialog + `_ + widget presents the directories in the file system in a dialog window. The user + can use this dialog window to navigate through the file system to select the + desired directory. + +.. Python Demo of: +.. \ulink{DirSelectDialog}{http://tix.sourceforge.net/dist/current/demos/samples/DirDlg.tcl} + + +.. class:: DirSelectBox() + + The :class:`DirSelectBox` is similar to the standard Motif(TM) + directory-selection box. It is generally used for the user to choose a + directory. DirSelectBox stores the directories mostly recently selected into + a ComboBox widget so that they can be quickly selected again. + + +.. class:: ExFileSelectBox() + + The `ExFileSelectBox + `_ + widget is usually embedded in a tixExFileSelectDialog widget. It provides a + convenient method for the user to select files. The style of the + :class:`ExFileSelectBox` widget is very similar to the standard file dialog on + MS Windows 3.1. + +.. Python Demo of: +.. \ulink{ExFileSelectDialog}{http://tix.sourceforge.net/dist/current/demos/samples/EFileDlg.tcl} + + +.. class:: FileSelectBox() + + The `FileSelectBox + `_ + is similar to the standard Motif(TM) file-selection box. It is generally used + for the user to choose a file. FileSelectBox stores the files mostly recently + selected into a :class:`ComboBox` widget so that they can be quickly selected + again. + +.. Python Demo of: +.. \ulink{FileSelectDialog}{http://tix.sourceforge.net/dist/current/demos/samples/FileDlg.tcl} + + +.. class:: FileEntry() + + The `FileEntry + `_ + widget can be used to input a filename. The user can type in the filename + manually. Alternatively, the user can press the button widget that sits next to + the entry, which will bring up a file selection dialog. + +.. Python Demo of: +.. \ulink{FileEntry}{http://tix.sourceforge.net/dist/current/demos/samples/FileEnt.tcl} + + +Hierarchical ListBox +^^^^^^^^^^^^^^^^^^^^ + + +.. class:: HList() + + The `HList + `_ widget + can be used to display any data that have a hierarchical structure, for example, + file system directory trees. The list entries are indented and connected by + branch lines according to their places in the hierarchy. + +.. Python Demo of: +.. \ulink{HList}{http://tix.sourceforge.net/dist/current/demos/samples/HList1.tcl} + + +.. class:: CheckList() + + The `CheckList + `_ + widget displays a list of items to be selected by the user. CheckList acts + similarly to the Tk checkbutton or radiobutton widgets, except it is capable of + handling many more items than checkbuttons or radiobuttons. + +.. Python Demo of: +.. \ulink{ CheckList}{http://tix.sourceforge.net/dist/current/demos/samples/ChkList.tcl} +.. Python Demo of: +.. \ulink{ScrolledHList (1)}{http://tix.sourceforge.net/dist/current/demos/samples/SHList.tcl} +.. Python Demo of: +.. \ulink{ScrolledHList (2)}{http://tix.sourceforge.net/dist/current/demos/samples/SHList2.tcl} + + +.. class:: Tree() + + The `Tree + `_ widget + can be used to display hierarchical data in a tree form. The user can adjust the + view of the tree by opening or closing parts of the tree. + +.. Python Demo of: +.. \ulink{Tree}{http://tix.sourceforge.net/dist/current/demos/samples/Tree.tcl} +.. Python Demo of: +.. \ulink{Tree (Dynamic)}{http://tix.sourceforge.net/dist/current/demos/samples/DynTree.tcl} + + +Tabular ListBox +^^^^^^^^^^^^^^^ + + +.. class:: TList() + + The `TList + `_ widget + can be used to display data in a tabular format. The list entries of a + :class:`TList` widget are similar to the entries in the Tk listbox widget. The + main differences are (1) the :class:`TList` widget can display the list entries + in a two dimensional format and (2) you can use graphical images as well as + multiple colors and fonts for the list entries. + +.. Python Demo of: +.. \ulink{ScrolledTList (1)}{http://tix.sourceforge.net/dist/current/demos/samples/STList1.tcl} +.. Python Demo of: +.. \ulink{ScrolledTList (2)}{http://tix.sourceforge.net/dist/current/demos/samples/STList2.tcl} +.. Grid has yet to be added to Python +.. \subsubsection{Grid Widget} +.. Python Demo of: +.. \ulink{Simple Grid}{http://tix.sourceforge.net/dist/current/demos/samples/SGrid0.tcl} +.. Python Demo of: +.. \ulink{ScrolledGrid}{http://tix.sourceforge.net/dist/current/demos/samples/SGrid1.tcl} +.. Python Demo of: +.. \ulink{Editable Grid}{http://tix.sourceforge.net/dist/current/demos/samples/EditGrid.tcl} + + +Manager Widgets +^^^^^^^^^^^^^^^ + + +.. class:: PanedWindow() + + The `PanedWindow + `_ + widget allows the user to interactively manipulate the sizes of several panes. + The panes can be arranged either vertically or horizontally. The user changes + the sizes of the panes by dragging the resize handle between two panes. + +.. Python Demo of: +.. \ulink{PanedWindow}{http://tix.sourceforge.net/dist/current/demos/samples/PanedWin.tcl} + + +.. class:: ListNoteBook() + + The `ListNoteBook + `_ + widget is very similar to the :class:`TixNoteBook` widget: it can be used to + display many windows in a limited space using a notebook metaphor. The notebook + is divided into a stack of pages (windows). At one time only one of these pages + can be shown. The user can navigate through these pages by choosing the name of + the desired page in the :attr:`hlist` subwidget. + +.. Python Demo of: +.. \ulink{ListNoteBook}{http://tix.sourceforge.net/dist/current/demos/samples/ListNBK.tcl} + + +.. class:: NoteBook() + + The `NoteBook + `_ + widget can be used to display many windows in a limited space using a notebook + metaphor. The notebook is divided into a stack of pages. At one time only one of + these pages can be shown. The user can navigate through these pages by choosing + the visual "tabs" at the top of the NoteBook widget. + +.. Python Demo of: +.. \ulink{NoteBook}{http://tix.sourceforge.net/dist/current/demos/samples/NoteBook.tcl} + +.. \subsubsection{Scrolled Widgets} +.. Python Demo of: +.. \ulink{ScrolledListBox}{http://tix.sourceforge.net/dist/current/demos/samples/SListBox.tcl} +.. Python Demo of: +.. \ulink{ScrolledText}{http://tix.sourceforge.net/dist/current/demos/samples/SText.tcl} +.. Python Demo of: +.. \ulink{ScrolledWindow}{http://tix.sourceforge.net/dist/current/demos/samples/SWindow.tcl} +.. Python Demo of: +.. \ulink{Canvas Object View}{http://tix.sourceforge.net/dist/current/demos/samples/CObjView.tcl} + + +Image Types +^^^^^^^^^^^ + +The :mod:`tkinter.tix` module adds: + +* `pixmap `_ + capabilities to all :mod:`tkinter.tix` and :mod:`tkinter` widgets to create + color images from XPM files. + + .. Python Demo of: + .. \ulink{XPM Image In Button}{http://tix.sourceforge.net/dist/current/demos/samples/Xpm.tcl} + .. Python Demo of: + .. \ulink{XPM Image In Menu}{http://tix.sourceforge.net/dist/current/demos/samples/Xpm1.tcl} + +* `Compound + `_ image + types can be used to create images that consists of multiple horizontal lines; + each line is composed of a series of items (texts, bitmaps, images or spaces) + arranged from left to right. For example, a compound image can be used to + display a bitmap and a text string simultaneously in a Tk :class:`Button` + widget. + + .. Python Demo of: + .. \ulink{Compound Image In Buttons}{http://tix.sourceforge.net/dist/current/demos/samples/CmpImg.tcl} + .. Python Demo of: + .. \ulink{Compound Image In NoteBook}{http://tix.sourceforge.net/dist/current/demos/samples/CmpImg2.tcl} + .. Python Demo of: + .. \ulink{Compound Image Notebook Color Tabs}{http://tix.sourceforge.net/dist/current/demos/samples/CmpImg4.tcl} + .. Python Demo of: + .. \ulink{Compound Image Icons}{http://tix.sourceforge.net/dist/current/demos/samples/CmpImg3.tcl} + + +Miscellaneous Widgets +^^^^^^^^^^^^^^^^^^^^^ + + +.. class:: InputOnly() + + The `InputOnly + `_ + widgets are to accept inputs from the user, which can be done with the ``bind`` + command (Unix only). + + +Form Geometry Manager +^^^^^^^^^^^^^^^^^^^^^ + +In addition, :mod:`tkinter.tix` augments :mod:`tkinter` by providing: + + +.. class:: Form() + + The `Form + `_ geometry + manager based on attachment rules for all Tk widgets. + + +Tix Commands +------------ + + +.. class:: tixCommand() + + The `tix commands + `_ provide + access to miscellaneous elements of :mod:`Tix`'s internal state and the + :mod:`Tix` application context. Most of the information manipulated by these + methods pertains to the application as a whole, or to a screen or display, + rather than to a particular window. + + To view the current settings, the common usage is:: + + from tkinter import tix + root = tix.Tk() + print(root.tix_configure()) + + +.. method:: tixCommand.tix_configure(cnf=None, **kw) + + Query or modify the configuration options of the Tix application context. If no + option is specified, returns a dictionary all of the available options. If + option is specified with no value, then the method returns a list describing the + one named option (this list will be identical to the corresponding sublist of + the value returned if no option is specified). If one or more option-value + pairs are specified, then the method modifies the given option(s) to have the + given value(s); in this case the method returns an empty string. Option may be + any of the configuration options. + + +.. method:: tixCommand.tix_cget(option) + + Returns the current value of the configuration option given by *option*. Option + may be any of the configuration options. + + +.. method:: tixCommand.tix_getbitmap(name) + + Locates a bitmap file of the name ``name.xpm`` or ``name`` in one of the bitmap + directories (see the :meth:`tix_addbitmapdir` method). By using + :meth:`tix_getbitmap`, you can avoid hard coding the pathnames of the bitmap + files in your application. When successful, it returns the complete pathname of + the bitmap file, prefixed with the character ``@``. The returned value can be + used to configure the ``bitmap`` option of the Tk and Tix widgets. + + +.. method:: tixCommand.tix_addbitmapdir(directory) + + Tix maintains a list of directories under which the :meth:`tix_getimage` and + :meth:`tix_getbitmap` methods will search for image files. The standard bitmap + directory is :file:`$TIX_LIBRARY/bitmaps`. The :meth:`tix_addbitmapdir` method + adds *directory* into this list. By using this method, the image files of an + applications can also be located using the :meth:`tix_getimage` or + :meth:`tix_getbitmap` method. + + +.. method:: tixCommand.tix_filedialog([dlgclass]) + + Returns the file selection dialog that may be shared among different calls from + this application. This method will create a file selection dialog widget when + it is called the first time. This dialog will be returned by all subsequent + calls to :meth:`tix_filedialog`. An optional dlgclass parameter can be passed + as a string to specified what type of file selection dialog widget is desired. + Possible options are ``tix``, ``FileSelectDialog`` or ``tixExFileSelectDialog``. + + +.. method:: tixCommand.tix_getimage(self, name) + + Locates an image file of the name :file:`name.xpm`, :file:`name.xbm` or + :file:`name.ppm` in one of the bitmap directories (see the + :meth:`tix_addbitmapdir` method above). If more than one file with the same name + (but different extensions) exist, then the image type is chosen according to the + depth of the X display: xbm images are chosen on monochrome displays and color + images are chosen on color displays. By using :meth:`tix_getimage`, you can + avoid hard coding the pathnames of the image files in your application. When + successful, this method returns the name of the newly created image, which can + be used to configure the ``image`` option of the Tk and Tix widgets. + + +.. method:: tixCommand.tix_option_get(name) + + Gets the options maintained by the Tix scheme mechanism. + + +.. method:: tixCommand.tix_resetoptions(newScheme, newFontSet[, newScmPrio]) + + Resets the scheme and fontset of the Tix application to *newScheme* and + *newFontSet*, respectively. This affects only those widgets created after this + call. Therefore, it is best to call the resetoptions method before the creation + of any widgets in a Tix application. + + The optional parameter *newScmPrio* can be given to reset the priority level of + the Tk options set by the Tix schemes. + + Because of the way Tk handles the X option database, after Tix has been has + imported and inited, it is not possible to reset the color schemes and font sets + using the :meth:`tix_config` method. Instead, the :meth:`tix_resetoptions` + method must be used. diff --git a/python-3.7.4-docs-html/_sources/library/tkinter.ttk.rst.txt b/python-3.7.4-docs-html/_sources/library/tkinter.ttk.rst.txt new file mode 100644 index 0000000..76ecfcc --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/tkinter.ttk.rst.txt @@ -0,0 +1,1528 @@ +:mod:`tkinter.ttk` --- Tk themed widgets +======================================== + +.. module:: tkinter.ttk + :synopsis: Tk themed widget set + +.. sectionauthor:: Guilherme Polo + +**Source code:** :source:`Lib/tkinter/ttk.py` + +.. index:: single: ttk + +-------------- + +The :mod:`tkinter.ttk` module provides access to the Tk themed widget set, +introduced in Tk 8.5. If Python has not been compiled against Tk 8.5, this +module can still be accessed if *Tile* has been installed. The former +method using Tk 8.5 provides additional benefits including anti-aliased font +rendering under X11 and window transparency (requiring a composition +window manager on X11). + +The basic idea for :mod:`tkinter.ttk` is to separate, to the extent possible, +the code implementing a widget's behavior from the code implementing its +appearance. + + +.. seealso:: + + `Tk Widget Styling Support `_ + A document introducing theming support for Tk + + +Using Ttk +--------- + +To start using Ttk, import its module:: + + from tkinter import ttk + +To override the basic Tk widgets, the import should follow the Tk import:: + + from tkinter import * + from tkinter.ttk import * + +That code causes several :mod:`tkinter.ttk` widgets (:class:`Button`, +:class:`Checkbutton`, :class:`Entry`, :class:`Frame`, :class:`Label`, +:class:`LabelFrame`, :class:`Menubutton`, :class:`PanedWindow`, +:class:`Radiobutton`, :class:`Scale` and :class:`Scrollbar`) to +automatically replace the Tk widgets. + +This has the direct benefit of using the new widgets which gives a better +look and feel across platforms; however, the replacement widgets are not +completely compatible. The main difference is that widget options such as +"fg", "bg" and others related to widget styling are no +longer present in Ttk widgets. Instead, use the :class:`ttk.Style` class +for improved styling effects. + + +.. seealso:: + + `Converting existing applications to use Tile widgets `_ + A monograph (using Tcl terminology) about differences typically + encountered when moving applications to use the new widgets. + + +Ttk Widgets +----------- + +Ttk comes with 18 widgets, twelve of which already existed in tkinter: +:class:`Button`, :class:`Checkbutton`, :class:`Entry`, :class:`Frame`, +:class:`Label`, :class:`LabelFrame`, :class:`Menubutton`, :class:`PanedWindow`, +:class:`Radiobutton`, :class:`Scale`, :class:`Scrollbar`, and :class:`Spinbox`. +The other six are new: :class:`Combobox`, :class:`Notebook`, +:class:`Progressbar`, :class:`Separator`, :class:`Sizegrip` and +:class:`Treeview`. And all them are subclasses of :class:`Widget`. + +Using the Ttk widgets gives the application an improved look and feel. +As discussed above, there are differences in how the styling is coded. + +Tk code:: + + l1 = tkinter.Label(text="Test", fg="black", bg="white") + l2 = tkinter.Label(text="Test", fg="black", bg="white") + + +Ttk code:: + + style = ttk.Style() + style.configure("BW.TLabel", foreground="black", background="white") + + l1 = ttk.Label(text="Test", style="BW.TLabel") + l2 = ttk.Label(text="Test", style="BW.TLabel") + +For more information about TtkStyling_, see the :class:`Style` class +documentation. + +Widget +------ + +:class:`ttk.Widget` defines standard options and methods supported by Tk +themed widgets and is not supposed to be directly instantiated. + + +Standard Options +^^^^^^^^^^^^^^^^ + +All the :mod:`ttk` Widgets accepts the following options: + + .. tabularcolumns:: |l|L| + + +-----------+--------------------------------------------------------------+ + | Option | Description | + +===========+==============================================================+ + | class | Specifies the window class. The class is used when querying | + | | the option database for the window's other options, to | + | | determine the default bindtags for the window, and to select | + | | the widget's default layout and style. This option is | + | | read-only, and may only be specified when the window is | + | | created. | + +-----------+--------------------------------------------------------------+ + | cursor | Specifies the mouse cursor to be used for the widget. If set | + | | to the empty string (the default), the cursor is inherited | + | | for the parent widget. | + +-----------+--------------------------------------------------------------+ + | takefocus | Determines whether the window accepts the focus during | + | | keyboard traversal. 0, 1 or an empty string is returned. | + | | If 0 is returned, it means that the window should be skipped | + | | entirely during keyboard traversal. If 1, it means that the | + | | window should receive the input focus as long as it is | + | | viewable. And an empty string means that the traversal | + | | scripts make the decision about whether or not to focus | + | | on the window. | + +-----------+--------------------------------------------------------------+ + | style | May be used to specify a custom widget style. | + +-----------+--------------------------------------------------------------+ + + +Scrollable Widget Options +^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following options are supported by widgets that are controlled by a +scrollbar. + + .. tabularcolumns:: |l|L| + + +----------------+---------------------------------------------------------+ + | Option | Description | + +================+=========================================================+ + | xscrollcommand | Used to communicate with horizontal scrollbars. | + | | | + | | When the view in the widget's window change, the widget | + | | will generate a Tcl command based on the scrollcommand. | + | | | + | | Usually this option consists of the method | + | | :meth:`Scrollbar.set` of some scrollbar. This will cause| + | | the scrollbar to be updated whenever the view in the | + | | window changes. | + +----------------+---------------------------------------------------------+ + | yscrollcommand | Used to communicate with vertical scrollbars. | + | | For some more information, see above. | + +----------------+---------------------------------------------------------+ + + +Label Options +^^^^^^^^^^^^^ + +The following options are supported by labels, buttons and other button-like +widgets. + + .. tabularcolumns:: |l|p{0.7\linewidth}| + + +--------------+-----------------------------------------------------------+ + | Option | Description | + +==============+===========================================================+ + | text | Specifies a text string to be displayed inside the widget.| + +--------------+-----------------------------------------------------------+ + | textvariable | Specifies a name whose value will be used in place of the | + | | text option resource. | + +--------------+-----------------------------------------------------------+ + | underline | If set, specifies the index (0-based) of a character to | + | | underline in the text string. The underline character is | + | | used for mnemonic activation. | + +--------------+-----------------------------------------------------------+ + | image | Specifies an image to display. This is a list of 1 or more| + | | elements. The first element is the default image name. The| + | | rest of the list if a sequence of statespec/value pairs as| + | | defined by :meth:`Style.map`, specifying different images | + | | to use when the widget is in a particular state or a | + | | combination of states. All images in the list should have | + | | the same size. | + +--------------+-----------------------------------------------------------+ + | compound | Specifies how to display the image relative to the text, | + | | in the case both text and images options are present. | + | | Valid values are: | + | | | + | | * text: display text only | + | | * image: display image only | + | | * top, bottom, left, right: display image above, below, | + | | left of, or right of the text, respectively. | + | | * none: the default. display the image if present, | + | | otherwise the text. | + +--------------+-----------------------------------------------------------+ + | width | If greater than zero, specifies how much space, in | + | | character widths, to allocate for the text label, if less | + | | than zero, specifies a minimum width. If zero or | + | | unspecified, the natural width of the text label is used. | + +--------------+-----------------------------------------------------------+ + + +Compatibility Options +^^^^^^^^^^^^^^^^^^^^^ + + .. tabularcolumns:: |l|L| + + +--------+----------------------------------------------------------------+ + | Option | Description | + +========+================================================================+ + | state | May be set to "normal" or "disabled" to control the "disabled" | + | | state bit. This is a write-only option: setting it changes the | + | | widget state, but the :meth:`Widget.state` method does not | + | | affect this option. | + +--------+----------------------------------------------------------------+ + +Widget States +^^^^^^^^^^^^^ + +The widget state is a bitmap of independent state flags. + + .. tabularcolumns:: |l|L| + + +------------+-------------------------------------------------------------+ + | Flag | Description | + +============+=============================================================+ + | active | The mouse cursor is over the widget and pressing a mouse | + | | button will cause some action to occur | + +------------+-------------------------------------------------------------+ + | disabled | Widget is disabled under program control | + +------------+-------------------------------------------------------------+ + | focus | Widget has keyboard focus | + +------------+-------------------------------------------------------------+ + | pressed | Widget is being pressed | + +------------+-------------------------------------------------------------+ + | selected | "On", "true", or "current" for things like Checkbuttons and | + | | radiobuttons | + +------------+-------------------------------------------------------------+ + | background | Windows and Mac have a notion of an "active" or foreground | + | | window. The *background* state is set for widgets in a | + | | background window, and cleared for those in the foreground | + | | window | + +------------+-------------------------------------------------------------+ + | readonly | Widget should not allow user modification | + +------------+-------------------------------------------------------------+ + | alternate | A widget-specific alternate display format | + +------------+-------------------------------------------------------------+ + | invalid | The widget's value is invalid | + +------------+-------------------------------------------------------------+ + +A state specification is a sequence of state names, optionally prefixed with +an exclamation point indicating that the bit is off. + + +ttk.Widget +^^^^^^^^^^ + +Besides the methods described below, the :class:`ttk.Widget` supports the +methods :meth:`tkinter.Widget.cget` and :meth:`tkinter.Widget.configure`. + +.. class:: Widget + + .. method:: identify(x, y) + + Returns the name of the element at position *x* *y*, or the empty string + if the point does not lie within any element. + + *x* and *y* are pixel coordinates relative to the widget. + + + .. method:: instate(statespec, callback=None, *args, **kw) + + Test the widget's state. If a callback is not specified, returns ``True`` + if the widget state matches *statespec* and ``False`` otherwise. If callback + is specified then it is called with args if widget state matches + *statespec*. + + + .. method:: state(statespec=None) + + Modify or inquire widget state. If *statespec* is specified, sets the + widget state according to it and return a new *statespec* indicating + which flags were changed. If *statespec* is not specified, returns + the currently-enabled state flags. + + *statespec* will usually be a list or a tuple. + + +Combobox +-------- + +The :class:`ttk.Combobox` widget combines a text field with a pop-down list of +values. This widget is a subclass of :class:`Entry`. + +Besides the methods inherited from :class:`Widget`: :meth:`Widget.cget`, +:meth:`Widget.configure`, :meth:`Widget.identify`, :meth:`Widget.instate` +and :meth:`Widget.state`, and the following inherited from :class:`Entry`: +:meth:`Entry.bbox`, :meth:`Entry.delete`, :meth:`Entry.icursor`, +:meth:`Entry.index`, :meth:`Entry.insert`, :meth:`Entry.selection`, +:meth:`Entry.xview`, it has some other methods, described at +:class:`ttk.Combobox`. + + +Options +^^^^^^^ + +This widget accepts the following specific options: + + .. tabularcolumns:: |l|L| + + +-----------------+--------------------------------------------------------+ + | Option | Description | + +=================+========================================================+ + | exportselection | Boolean value. If set, the widget selection is linked | + | | to the Window Manager selection (which can be returned | + | | by invoking Misc.selection_get, for example). | + +-----------------+--------------------------------------------------------+ + | justify | Specifies how the text is aligned within the widget. | + | | One of "left", "center", or "right". | + +-----------------+--------------------------------------------------------+ + | height | Specifies the height of the pop-down listbox, in rows. | + +-----------------+--------------------------------------------------------+ + | postcommand | A script (possibly registered with Misc.register) that | + | | is called immediately before displaying the values. It | + | | may specify which values to display. | + +-----------------+--------------------------------------------------------+ + | state | One of "normal", "readonly", or "disabled". In the | + | | "readonly" state, the value may not be edited directly,| + | | and the user can only selection of the values from the | + | | dropdown list. In the "normal" state, the text field is| + | | directly editable. In the "disabled" state, no | + | | interaction is possible. | + +-----------------+--------------------------------------------------------+ + | textvariable | Specifies a name whose value is linked to the widget | + | | value. Whenever the value associated with that name | + | | changes, the widget value is updated, and vice versa. | + | | See :class:`tkinter.StringVar`. | + +-----------------+--------------------------------------------------------+ + | values | Specifies the list of values to display in the | + | | drop-down listbox. | + +-----------------+--------------------------------------------------------+ + | width | Specifies an integer value indicating the desired width| + | | of the entry window, in average-size characters of the | + | | widget's font. | + +-----------------+--------------------------------------------------------+ + + +Virtual events +^^^^^^^^^^^^^^ + +The combobox widgets generates a **<>** virtual event +when the user selects an element from the list of values. + + +ttk.Combobox +^^^^^^^^^^^^ + +.. class:: Combobox + + .. method:: current(newindex=None) + + If *newindex* is specified, sets the combobox value to the element + position *newindex*. Otherwise, returns the index of the current value or + -1 if the current value is not in the values list. + + + .. method:: get() + + Returns the current value of the combobox. + + + .. method:: set(value) + + Sets the value of the combobox to *value*. + + +Spinbox +------- +The :class:`ttk.Spinbox` widget is a :class:`ttk.Entry` enhanced with increment +and decrement arrows. It can be used for numbers or lists of string values. +This widget is a subclass of :class:`Entry`. + +Besides the methods inherited from :class:`Widget`: :meth:`Widget.cget`, +:meth:`Widget.configure`, :meth:`Widget.identify`, :meth:`Widget.instate` +and :meth:`Widget.state`, and the following inherited from :class:`Entry`: +:meth:`Entry.bbox`, :meth:`Entry.delete`, :meth:`Entry.icursor`, +:meth:`Entry.index`, :meth:`Entry.insert`, :meth:`Entry.xview`, +it has some other methods, described at :class:`ttk.Spinbox`. + +Options +^^^^^^^ + +This widget accepts the following specific options: + + .. tabularcolumns:: |l|L| + ++----------------------+------------------------------------------------------+ +| Option | Description | ++======================+======================================================+ +| from | Float value. If set, this is the minimum value to | +| | which the decrement button will decrement. Must be | +| | spelled as ``from_`` when used as an argument, since | +| | ``from`` is a Python keyword. | ++----------------------+------------------------------------------------------+ +| to | Float value. If set, this is the maximum value to | +| | which the increment button will increment. | ++----------------------+------------------------------------------------------+ +| increment | Float value. Specifies the amount which the | +| | increment/decrement buttons change the | +| | value. Defaults to 1.0. | ++----------------------+------------------------------------------------------+ +| values | Sequence of string or float values. If specified, | +| | the increment/decrement buttons will cycle through | +| | the items in this sequence rather than incrementing | +| | or decrementing numbers. | +| | | ++----------------------+------------------------------------------------------+ +| wrap | Boolean value. If ``True``, increment and decrement | +| | buttons will cycle from the ``to`` value to the | +| | ``from`` value or the ``from`` value to the ``to`` | +| | value, respectively. | ++----------------------+------------------------------------------------------+ +| format | String value. This specifies the format of numbers | +| | set by the increment/decrement buttons. It must be | +| | in the form "%W.Pf", where W is the padded width of | +| | the value, P is the precision, and '%' and 'f' are | +| | literal. | ++----------------------+------------------------------------------------------+ +| command | Python callable. Will be called with no arguments | +| | whenever either of the increment or decrement buttons| +| | are pressed. | +| | | ++----------------------+------------------------------------------------------+ + + +Virtual events +^^^^^^^^^^^^^^ + +The spinbox widget generates an **<>** virtual event when the +user presses , and a **<>** virtual event when the user +presses . + +ttk.Spinbox +^^^^^^^^^^^^ + +.. class:: Spinbox + + .. method:: get() + + Returns the current value of the spinbox. + + + .. method:: set(value) + + Sets the value of the spinbox to *value*. + + +Notebook +-------- + +Ttk Notebook widget manages a collection of windows and displays a single +one at a time. Each child window is associated with a tab, which the user +may select to change the currently-displayed window. + + +Options +^^^^^^^ + +This widget accepts the following specific options: + + .. tabularcolumns:: |l|L| + + +---------+----------------------------------------------------------------+ + | Option | Description | + +=========+================================================================+ + | height | If present and greater than zero, specifies the desired height | + | | of the pane area (not including internal padding or tabs). | + | | Otherwise, the maximum height of all panes is used. | + +---------+----------------------------------------------------------------+ + | padding | Specifies the amount of extra space to add around the outside | + | | of the notebook. The padding is a list up to four length | + | | specifications left top right bottom. If fewer than four | + | | elements are specified, bottom defaults to top, right defaults | + | | to left, and top defaults to left. | + +---------+----------------------------------------------------------------+ + | width | If present and greater than zero, specified the desired width | + | | of the pane area (not including internal padding). Otherwise, | + | | the maximum width of all panes is used. | + +---------+----------------------------------------------------------------+ + + +Tab Options +^^^^^^^^^^^ + +There are also specific options for tabs: + + .. tabularcolumns:: |l|L| + + +-----------+--------------------------------------------------------------+ + | Option | Description | + +===========+==============================================================+ + | state | Either "normal", "disabled" or "hidden". If "disabled", then | + | | the tab is not selectable. If "hidden", then the tab is not | + | | shown. | + +-----------+--------------------------------------------------------------+ + | sticky | Specifies how the child window is positioned within the pane | + | | area. Value is a string containing zero or more of the | + | | characters "n", "s", "e" or "w". Each letter refers to a | + | | side (north, south, east or west) that the child window will | + | | stick to, as per the :meth:`grid` geometry manager. | + +-----------+--------------------------------------------------------------+ + | padding | Specifies the amount of extra space to add between the | + | | notebook and this pane. Syntax is the same as for the option | + | | padding used by this widget. | + +-----------+--------------------------------------------------------------+ + | text | Specifies a text to be displayed in the tab. | + +-----------+--------------------------------------------------------------+ + | image | Specifies an image to display in the tab. See the option | + | | image described in :class:`Widget`. | + +-----------+--------------------------------------------------------------+ + | compound | Specifies how to display the image relative to the text, in | + | | the case both options text and image are present. See | + | | `Label Options`_ for legal values. | + +-----------+--------------------------------------------------------------+ + | underline | Specifies the index (0-based) of a character to underline in | + | | the text string. The underlined character is used for | + | | mnemonic activation if :meth:`Notebook.enable_traversal` is | + | | called. | + +-----------+--------------------------------------------------------------+ + + +Tab Identifiers +^^^^^^^^^^^^^^^ + +The tab_id present in several methods of :class:`ttk.Notebook` may take any +of the following forms: + +* An integer between zero and the number of tabs +* The name of a child window +* A positional specification of the form "@x,y", which identifies the tab +* The literal string "current", which identifies the currently-selected tab +* The literal string "end", which returns the number of tabs (only valid for + :meth:`Notebook.index`) + + +Virtual Events +^^^^^^^^^^^^^^ + +This widget generates a **<>** virtual event after a new +tab is selected. + + +ttk.Notebook +^^^^^^^^^^^^ + +.. class:: Notebook + + .. method:: add(child, **kw) + + Adds a new tab to the notebook. + + If window is currently managed by the notebook but hidden, it is + restored to its previous position. + + See `Tab Options`_ for the list of available options. + + + .. method:: forget(tab_id) + + Removes the tab specified by *tab_id*, unmaps and unmanages the + associated window. + + + .. method:: hide(tab_id) + + Hides the tab specified by *tab_id*. + + The tab will not be displayed, but the associated window remains + managed by the notebook and its configuration remembered. Hidden tabs + may be restored with the :meth:`add` command. + + + .. method:: identify(x, y) + + Returns the name of the tab element at position *x*, *y*, or the empty + string if none. + + + .. method:: index(tab_id) + + Returns the numeric index of the tab specified by *tab_id*, or the total + number of tabs if *tab_id* is the string "end". + + + .. method:: insert(pos, child, **kw) + + Inserts a pane at the specified position. + + *pos* is either the string "end", an integer index, or the name of a + managed child. If *child* is already managed by the notebook, moves it to + the specified position. + + See `Tab Options`_ for the list of available options. + + + .. method:: select(tab_id=None) + + Selects the specified *tab_id*. + + The associated child window will be displayed, and the + previously-selected window (if different) is unmapped. If *tab_id* is + omitted, returns the widget name of the currently selected pane. + + + .. method:: tab(tab_id, option=None, **kw) + + Query or modify the options of the specific *tab_id*. + + If *kw* is not given, returns a dictionary of the tab option values. If + *option* is specified, returns the value of that *option*. Otherwise, + sets the options to the corresponding values. + + + .. method:: tabs() + + Returns a list of windows managed by the notebook. + + + .. method:: enable_traversal() + + Enable keyboard traversal for a toplevel window containing this notebook. + + This will extend the bindings for the toplevel window containing the + notebook as follows: + + * :kbd:`Control-Tab`: selects the tab following the currently selected one. + * :kbd:`Shift-Control-Tab`: selects the tab preceding the currently selected one. + * :kbd:`Alt-K`: where *K* is the mnemonic (underlined) character of any tab, will + select that tab. + + Multiple notebooks in a single toplevel may be enabled for traversal, + including nested notebooks. However, notebook traversal only works + properly if all panes have the notebook they are in as master. + + +Progressbar +----------- + +The :class:`ttk.Progressbar` widget shows the status of a long-running +operation. It can operate in two modes: 1) the determinate mode which shows the +amount completed relative to the total amount of work to be done and 2) the +indeterminate mode which provides an animated display to let the user know that +work is progressing. + + +Options +^^^^^^^ + +This widget accepts the following specific options: + + .. tabularcolumns:: |l|L| + + +----------+---------------------------------------------------------------+ + | Option | Description | + +==========+===============================================================+ + | orient | One of "horizontal" or "vertical". Specifies the orientation | + | | of the progress bar. | + +----------+---------------------------------------------------------------+ + | length | Specifies the length of the long axis of the progress bar | + | | (width if horizontal, height if vertical). | + +----------+---------------------------------------------------------------+ + | mode | One of "determinate" or "indeterminate". | + +----------+---------------------------------------------------------------+ + | maximum | A number specifying the maximum value. Defaults to 100. | + +----------+---------------------------------------------------------------+ + | value | The current value of the progress bar. In "determinate" mode, | + | | this represents the amount of work completed. In | + | | "indeterminate" mode, it is interpreted as modulo *maximum*; | + | | that is, the progress bar completes one "cycle" when its value| + | | increases by *maximum*. | + +----------+---------------------------------------------------------------+ + | variable | A name which is linked to the option value. If specified, the | + | | value of the progress bar is automatically set to the value of| + | | this name whenever the latter is modified. | + +----------+---------------------------------------------------------------+ + | phase | Read-only option. The widget periodically increments the value| + | | of this option whenever its value is greater than 0 and, in | + | | determinate mode, less than maximum. This option may be used | + | | by the current theme to provide additional animation effects. | + +----------+---------------------------------------------------------------+ + + +ttk.Progressbar +^^^^^^^^^^^^^^^ + +.. class:: Progressbar + + .. method:: start(interval=None) + + Begin autoincrement mode: schedules a recurring timer event that calls + :meth:`Progressbar.step` every *interval* milliseconds. If omitted, + *interval* defaults to 50 milliseconds. + + + .. method:: step(amount=None) + + Increments the progress bar's value by *amount*. + + *amount* defaults to 1.0 if omitted. + + + .. method:: stop() + + Stop autoincrement mode: cancels any recurring timer event initiated by + :meth:`Progressbar.start` for this progress bar. + + +Separator +--------- + +The :class:`ttk.Separator` widget displays a horizontal or vertical separator +bar. + +It has no other methods besides the ones inherited from :class:`ttk.Widget`. + + +Options +^^^^^^^ + +This widget accepts the following specific option: + + .. tabularcolumns:: |l|L| + + +--------+----------------------------------------------------------------+ + | Option | Description | + +========+================================================================+ + | orient | One of "horizontal" or "vertical". Specifies the orientation of| + | | the separator. | + +--------+----------------------------------------------------------------+ + + +Sizegrip +-------- + +The :class:`ttk.Sizegrip` widget (also known as a grow box) allows the user to +resize the containing toplevel window by pressing and dragging the grip. + +This widget has neither specific options nor specific methods, besides the +ones inherited from :class:`ttk.Widget`. + + +Platform-specific notes +^^^^^^^^^^^^^^^^^^^^^^^ + +* On MacOS X, toplevel windows automatically include a built-in size grip + by default. Adding a :class:`Sizegrip` is harmless, since the built-in + grip will just mask the widget. + + +Bugs +^^^^ + +* If the containing toplevel's position was specified relative to the right + or bottom of the screen (e.g. ....), the :class:`Sizegrip` widget will + not resize the window. +* This widget supports only "southeast" resizing. + + +Treeview +-------- + +The :class:`ttk.Treeview` widget displays a hierarchical collection of items. +Each item has a textual label, an optional image, and an optional list of data +values. The data values are displayed in successive columns after the tree +label. + +The order in which data values are displayed may be controlled by setting +the widget option ``displaycolumns``. The tree widget can also display column +headings. Columns may be accessed by number or symbolic names listed in the +widget option columns. See `Column Identifiers`_. + +Each item is identified by a unique name. The widget will generate item IDs +if they are not supplied by the caller. There is a distinguished root item, +named ``{}``. The root item itself is not displayed; its children appear at the +top level of the hierarchy. + +Each item also has a list of tags, which can be used to associate event bindings +with individual items and control the appearance of the item. + +The Treeview widget supports horizontal and vertical scrolling, according to +the options described in `Scrollable Widget Options`_ and the methods +:meth:`Treeview.xview` and :meth:`Treeview.yview`. + + +Options +^^^^^^^ + +This widget accepts the following specific options: + + .. tabularcolumns:: |l|p{0.7\linewidth}| + + +----------------+--------------------------------------------------------+ + | Option | Description | + +================+========================================================+ + | columns | A list of column identifiers, specifying the number of | + | | columns and their names. | + +----------------+--------------------------------------------------------+ + | displaycolumns | A list of column identifiers (either symbolic or | + | | integer indices) specifying which data columns are | + | | displayed and the order in which they appear, or the | + | | string "#all". | + +----------------+--------------------------------------------------------+ + | height | Specifies the number of rows which should be visible. | + | | Note: the requested width is determined from the sum | + | | of the column widths. | + +----------------+--------------------------------------------------------+ + | padding | Specifies the internal padding for the widget. The | + | | padding is a list of up to four length specifications. | + +----------------+--------------------------------------------------------+ + | selectmode | Controls how the built-in class bindings manage the | + | | selection. One of "extended", "browse" or "none". | + | | If set to "extended" (the default), multiple items may | + | | be selected. If "browse", only a single item will be | + | | selected at a time. If "none", the selection will not | + | | be changed. | + | | | + | | Note that the application code and tag bindings can set| + | | the selection however they wish, regardless of the | + | | value of this option. | + +----------------+--------------------------------------------------------+ + | show | A list containing zero or more of the following values,| + | | specifying which elements of the tree to display. | + | | | + | | * tree: display tree labels in column #0. | + | | * headings: display the heading row. | + | | | + | | The default is "tree headings", i.e., show all | + | | elements. | + | | | + | | **Note**: Column #0 always refers to the tree column, | + | | even if show="tree" is not specified. | + +----------------+--------------------------------------------------------+ + + +Item Options +^^^^^^^^^^^^ + +The following item options may be specified for items in the insert and item +widget commands. + + .. tabularcolumns:: |l|L| + + +--------+---------------------------------------------------------------+ + | Option | Description | + +========+===============================================================+ + | text | The textual label to display for the item. | + +--------+---------------------------------------------------------------+ + | image | A Tk Image, displayed to the left of the label. | + +--------+---------------------------------------------------------------+ + | values | The list of values associated with the item. | + | | | + | | Each item should have the same number of values as the widget | + | | option columns. If there are fewer values than columns, the | + | | remaining values are assumed empty. If there are more values | + | | than columns, the extra values are ignored. | + +--------+---------------------------------------------------------------+ + | open | True/False value indicating whether the item's children should| + | | be displayed or hidden. | + +--------+---------------------------------------------------------------+ + | tags | A list of tags associated with this item. | + +--------+---------------------------------------------------------------+ + + +Tag Options +^^^^^^^^^^^ + +The following options may be specified on tags: + + .. tabularcolumns:: |l|L| + + +------------+-----------------------------------------------------------+ + | Option | Description | + +============+===========================================================+ + | foreground | Specifies the text foreground color. | + +------------+-----------------------------------------------------------+ + | background | Specifies the cell or item background color. | + +------------+-----------------------------------------------------------+ + | font | Specifies the font to use when drawing text. | + +------------+-----------------------------------------------------------+ + | image | Specifies the item image, in case the item's image option | + | | is empty. | + +------------+-----------------------------------------------------------+ + + +Column Identifiers +^^^^^^^^^^^^^^^^^^ + +Column identifiers take any of the following forms: + +* A symbolic name from the list of columns option. +* An integer n, specifying the nth data column. +* A string of the form #n, where n is an integer, specifying the nth display + column. + +Notes: + +* Item's option values may be displayed in a different order than the order + in which they are stored. +* Column #0 always refers to the tree column, even if show="tree" is not + specified. + +A data column number is an index into an item's option values list; a display +column number is the column number in the tree where the values are displayed. +Tree labels are displayed in column #0. If option displaycolumns is not set, +then data column n is displayed in column #n+1. Again, **column #0 always +refers to the tree column**. + + +Virtual Events +^^^^^^^^^^^^^^ + +The Treeview widget generates the following virtual events. + + .. tabularcolumns:: |l|L| + + +--------------------+--------------------------------------------------+ + | Event | Description | + +====================+==================================================+ + | <> | Generated whenever the selection changes. | + +--------------------+--------------------------------------------------+ + | <> | Generated just before settings the focus item to | + | | open=True. | + +--------------------+--------------------------------------------------+ + | <> | Generated just after setting the focus item to | + | | open=False. | + +--------------------+--------------------------------------------------+ + +The :meth:`Treeview.focus` and :meth:`Treeview.selection` methods can be used +to determine the affected item or items. + + +ttk.Treeview +^^^^^^^^^^^^ + +.. class:: Treeview + + .. method:: bbox(item, column=None) + + Returns the bounding box (relative to the treeview widget's window) of + the specified *item* in the form (x, y, width, height). + + If *column* is specified, returns the bounding box of that cell. If the + *item* is not visible (i.e., if it is a descendant of a closed item or is + scrolled offscreen), returns an empty string. + + + .. method:: get_children(item=None) + + Returns the list of children belonging to *item*. + + If *item* is not specified, returns root children. + + + .. method:: set_children(item, *newchildren) + + Replaces *item*'s child with *newchildren*. + + Children present in *item* that are not present in *newchildren* are + detached from the tree. No items in *newchildren* may be an ancestor of + *item*. Note that not specifying *newchildren* results in detaching + *item*'s children. + + + .. method:: column(column, option=None, **kw) + + Query or modify the options for the specified *column*. + + If *kw* is not given, returns a dict of the column option values. If + *option* is specified then the value for that *option* is returned. + Otherwise, sets the options to the corresponding values. + + The valid options/values are: + + * id + Returns the column name. This is a read-only option. + * anchor: One of the standard Tk anchor values. + Specifies how the text in this column should be aligned with respect + to the cell. + * minwidth: width + The minimum width of the column in pixels. The treeview widget will + not make the column any smaller than specified by this option when + the widget is resized or the user drags a column. + * stretch: True/False + Specifies whether the column's width should be adjusted when + the widget is resized. + * width: width + The width of the column in pixels. + + To configure the tree column, call this with column = "#0" + + .. method:: delete(*items) + + Delete all specified *items* and all their descendants. + + The root item may not be deleted. + + + .. method:: detach(*items) + + Unlinks all of the specified *items* from the tree. + + The items and all of their descendants are still present, and may be + reinserted at another point in the tree, but will not be displayed. + + The root item may not be detached. + + + .. method:: exists(item) + + Returns ``True`` if the specified *item* is present in the tree. + + + .. method:: focus(item=None) + + If *item* is specified, sets the focus item to *item*. Otherwise, returns + the current focus item, or '' if there is none. + + + .. method:: heading(column, option=None, **kw) + + Query or modify the heading options for the specified *column*. + + If *kw* is not given, returns a dict of the heading option values. If + *option* is specified then the value for that *option* is returned. + Otherwise, sets the options to the corresponding values. + + The valid options/values are: + + * text: text + The text to display in the column heading. + * image: imageName + Specifies an image to display to the right of the column heading. + * anchor: anchor + Specifies how the heading text should be aligned. One of the standard + Tk anchor values. + * command: callback + A callback to be invoked when the heading label is pressed. + + To configure the tree column heading, call this with column = "#0". + + + .. method:: identify(component, x, y) + + Returns a description of the specified *component* under the point given + by *x* and *y*, or the empty string if no such *component* is present at + that position. + + + .. method:: identify_row(y) + + Returns the item ID of the item at position *y*. + + + .. method:: identify_column(x) + + Returns the data column identifier of the cell at position *x*. + + The tree column has ID #0. + + + .. method:: identify_region(x, y) + + Returns one of: + + +-----------+--------------------------------------+ + | region | meaning | + +===========+======================================+ + | heading | Tree heading area. | + +-----------+--------------------------------------+ + | separator | Space between two columns headings. | + +-----------+--------------------------------------+ + | tree | The tree area. | + +-----------+--------------------------------------+ + | cell | A data cell. | + +-----------+--------------------------------------+ + + Availability: Tk 8.6. + + + .. method:: identify_element(x, y) + + Returns the element at position *x*, *y*. + + Availability: Tk 8.6. + + + .. method:: index(item) + + Returns the integer index of *item* within its parent's list of children. + + + .. method:: insert(parent, index, iid=None, **kw) + + Creates a new item and returns the item identifier of the newly created + item. + + *parent* is the item ID of the parent item, or the empty string to create + a new top-level item. *index* is an integer, or the value "end", + specifying where in the list of parent's children to insert the new item. + If *index* is less than or equal to zero, the new node is inserted at + the beginning; if *index* is greater than or equal to the current number + of children, it is inserted at the end. If *iid* is specified, it is used + as the item identifier; *iid* must not already exist in the tree. + Otherwise, a new unique identifier is generated. + + See `Item Options`_ for the list of available points. + + + .. method:: item(item, option=None, **kw) + + Query or modify the options for the specified *item*. + + If no options are given, a dict with options/values for the item is + returned. + If *option* is specified then the value for that option is returned. + Otherwise, sets the options to the corresponding values as given by *kw*. + + + .. method:: move(item, parent, index) + + Moves *item* to position *index* in *parent*'s list of children. + + It is illegal to move an item under one of its descendants. If *index* is + less than or equal to zero, *item* is moved to the beginning; if greater + than or equal to the number of children, it is moved to the end. If *item* + was detached it is reattached. + + + .. method:: next(item) + + Returns the identifier of *item*'s next sibling, or '' if *item* is the + last child of its parent. + + + .. method:: parent(item) + + Returns the ID of the parent of *item*, or '' if *item* is at the top + level of the hierarchy. + + + .. method:: prev(item) + + Returns the identifier of *item*'s previous sibling, or '' if *item* is + the first child of its parent. + + + .. method:: reattach(item, parent, index) + + An alias for :meth:`Treeview.move`. + + + .. method:: see(item) + + Ensure that *item* is visible. + + Sets all of *item*'s ancestors open option to ``True``, and scrolls the + widget if necessary so that *item* is within the visible portion of + the tree. + + + .. method:: selection(selop=None, items=None) + + If *selop* is not specified, returns selected items. Otherwise, it will + act according to the following selection methods. + + .. deprecated-removed:: 3.6 3.8 + Using ``selection()`` for changing the selection state is deprecated. + Use the following selection methods instead. + + + .. method:: selection_set(*items) + + *items* becomes the new selection. + + .. versionchanged:: 3.6 + *items* can be passed as separate arguments, not just as a single tuple. + + + .. method:: selection_add(*items) + + Add *items* to the selection. + + .. versionchanged:: 3.6 + *items* can be passed as separate arguments, not just as a single tuple. + + + .. method:: selection_remove(*items) + + Remove *items* from the selection. + + .. versionchanged:: 3.6 + *items* can be passed as separate arguments, not just as a single tuple. + + + .. method:: selection_toggle(*items) + + Toggle the selection state of each item in *items*. + + .. versionchanged:: 3.6 + *items* can be passed as separate arguments, not just as a single tuple. + + + .. method:: set(item, column=None, value=None) + + With one argument, returns a dictionary of column/value pairs for the + specified *item*. With two arguments, returns the current value of the + specified *column*. With three arguments, sets the value of given + *column* in given *item* to the specified *value*. + + + .. method:: tag_bind(tagname, sequence=None, callback=None) + + Bind a callback for the given event *sequence* to the tag *tagname*. + When an event is delivered to an item, the callbacks for each of the + item's tags option are called. + + + .. method:: tag_configure(tagname, option=None, **kw) + + Query or modify the options for the specified *tagname*. + + If *kw* is not given, returns a dict of the option settings for + *tagname*. If *option* is specified, returns the value for that *option* + for the specified *tagname*. Otherwise, sets the options to the + corresponding values for the given *tagname*. + + + .. method:: tag_has(tagname, item=None) + + If *item* is specified, returns 1 or 0 depending on whether the specified + *item* has the given *tagname*. Otherwise, returns a list of all items + that have the specified tag. + + Availability: Tk 8.6 + + + .. method:: xview(*args) + + Query or modify horizontal position of the treeview. + + + .. method:: yview(*args) + + Query or modify vertical position of the treeview. + + +.. _TtkStyling: + +Ttk Styling +----------- + +Each widget in :mod:`ttk` is assigned a style, which specifies the set of +elements making up the widget and how they are arranged, along with dynamic +and default settings for element options. By default the style name is the +same as the widget's class name, but it may be overridden by the widget's style +option. If you don't know the class name of a widget, use the method +:meth:`Misc.winfo_class` (somewidget.winfo_class()). + +.. seealso:: + + `Tcl'2004 conference presentation `_ + This document explains how the theme engine works + + +.. class:: Style + + This class is used to manipulate the style database. + + + .. method:: configure(style, query_opt=None, **kw) + + Query or set the default value of the specified option(s) in *style*. + + Each key in *kw* is an option and each value is a string identifying + the value for that option. + + For example, to change every default button to be a flat button with + some padding and a different background color:: + + from tkinter import ttk + import tkinter + + root = tkinter.Tk() + + ttk.Style().configure("TButton", padding=6, relief="flat", + background="#ccc") + + btn = ttk.Button(text="Sample") + btn.pack() + + root.mainloop() + + + .. method:: map(style, query_opt=None, **kw) + + Query or sets dynamic values of the specified option(s) in *style*. + + Each key in *kw* is an option and each value should be a list or a + tuple (usually) containing statespecs grouped in tuples, lists, or + some other preference. A statespec is a compound of one + or more states and then a value. + + An example may make it more understandable:: + + import tkinter + from tkinter import ttk + + root = tkinter.Tk() + + style = ttk.Style() + style.map("C.TButton", + foreground=[('pressed', 'red'), ('active', 'blue')], + background=[('pressed', '!disabled', 'black'), ('active', 'white')] + ) + + colored_btn = ttk.Button(text="Test", style="C.TButton").pack() + + root.mainloop() + + + Note that the order of the (states, value) sequences for an option does + matter, if the order is changed to ``[('active', 'blue'), ('pressed', + 'red')]`` in the foreground option, for example, the result would be a + blue foreground when the widget were in active or pressed states. + + + .. method:: lookup(style, option, state=None, default=None) + + Returns the value specified for *option* in *style*. + + If *state* is specified, it is expected to be a sequence of one or more + states. If the *default* argument is set, it is used as a fallback value + in case no specification for option is found. + + To check what font a Button uses by default:: + + from tkinter import ttk + + print(ttk.Style().lookup("TButton", "font")) + + + .. method:: layout(style, layoutspec=None) + + Define the widget layout for given *style*. If *layoutspec* is omitted, + return the layout specification for given style. + + *layoutspec*, if specified, is expected to be a list or some other + sequence type (excluding strings), where each item should be a tuple and + the first item is the layout name and the second item should have the + format described in `Layouts`_. + + To understand the format, see the following example (it is not + intended to do anything useful):: + + from tkinter import ttk + import tkinter + + root = tkinter.Tk() + + style = ttk.Style() + style.layout("TMenubutton", [ + ("Menubutton.background", None), + ("Menubutton.button", {"children": + [("Menubutton.focus", {"children": + [("Menubutton.padding", {"children": + [("Menubutton.label", {"side": "left", "expand": 1})] + })] + })] + }), + ]) + + mbtn = ttk.Menubutton(text='Text') + mbtn.pack() + root.mainloop() + + + .. method:: element_create(elementname, etype, *args, **kw) + + Create a new element in the current theme, of the given *etype* which is + expected to be either "image", "from" or "vsapi". The latter is only + available in Tk 8.6a for Windows XP and Vista and is not described here. + + If "image" is used, *args* should contain the default image name followed + by statespec/value pairs (this is the imagespec), and *kw* may have the + following options: + + * border=padding + padding is a list of up to four integers, specifying the left, top, + right, and bottom borders, respectively. + + * height=height + Specifies a minimum height for the element. If less than zero, the + base image's height is used as a default. + + * padding=padding + Specifies the element's interior padding. Defaults to border's value + if not specified. + + * sticky=spec + Specifies how the image is placed within the final parcel. spec + contains zero or more characters "n", "s", "w", or "e". + + * width=width + Specifies a minimum width for the element. If less than zero, the + base image's width is used as a default. + + If "from" is used as the value of *etype*, + :meth:`element_create` will clone an existing + element. *args* is expected to contain a themename, from which + the element will be cloned, and optionally an element to clone from. + If this element to clone from is not specified, an empty element will + be used. *kw* is discarded. + + + .. method:: element_names() + + Returns the list of elements defined in the current theme. + + + .. method:: element_options(elementname) + + Returns the list of *elementname*'s options. + + + .. method:: theme_create(themename, parent=None, settings=None) + + Create a new theme. + + It is an error if *themename* already exists. If *parent* is specified, + the new theme will inherit styles, elements and layouts from the parent + theme. If *settings* are present they are expected to have the same + syntax used for :meth:`theme_settings`. + + + .. method:: theme_settings(themename, settings) + + Temporarily sets the current theme to *themename*, apply specified + *settings* and then restore the previous theme. + + Each key in *settings* is a style and each value may contain the keys + 'configure', 'map', 'layout' and 'element create' and they are expected + to have the same format as specified by the methods + :meth:`Style.configure`, :meth:`Style.map`, :meth:`Style.layout` and + :meth:`Style.element_create` respectively. + + As an example, let's change the Combobox for the default theme a bit:: + + from tkinter import ttk + import tkinter + + root = tkinter.Tk() + + style = ttk.Style() + style.theme_settings("default", { + "TCombobox": { + "configure": {"padding": 5}, + "map": { + "background": [("active", "green2"), + ("!disabled", "green4")], + "fieldbackground": [("!disabled", "green3")], + "foreground": [("focus", "OliveDrab1"), + ("!disabled", "OliveDrab2")] + } + } + }) + + combo = ttk.Combobox().pack() + + root.mainloop() + + + .. method:: theme_names() + + Returns a list of all known themes. + + + .. method:: theme_use(themename=None) + + If *themename* is not given, returns the theme in use. Otherwise, sets + the current theme to *themename*, refreshes all widgets and emits a + <> event. + + +Layouts +^^^^^^^ + +A layout can be just ``None``, if it takes no options, or a dict of +options specifying how to arrange the element. The layout mechanism +uses a simplified version of the pack geometry manager: given an +initial cavity, each element is allocated a parcel. Valid +options/values are: + + * side: whichside + Specifies which side of the cavity to place the element; one of + top, right, bottom or left. If omitted, the element occupies the + entire cavity. + + * sticky: nswe + Specifies where the element is placed inside its allocated parcel. + + * unit: 0 or 1 + If set to 1, causes the element and all of its descendants to be treated as + a single element for the purposes of :meth:`Widget.identify` et al. It's + used for things like scrollbar thumbs with grips. + + * children: [sublayout... ] + Specifies a list of elements to place inside the element. Each + element is a tuple (or other sequence type) where the first item is + the layout name, and the other is a `Layout`_. + +.. _Layout: `Layouts`_ diff --git a/python-3.7.4-docs-html/_sources/library/token.rst.txt b/python-3.7.4-docs-html/_sources/library/token.rst.txt new file mode 100644 index 0000000..3739910 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/token.rst.txt @@ -0,0 +1,137 @@ +:mod:`token` --- Constants used with Python parse trees +======================================================= + +.. module:: token + :synopsis: Constants representing terminal nodes of the parse tree. + +.. sectionauthor:: Fred L. Drake, Jr. + +**Source code:** :source:`Lib/token.py` + +-------------- + +This module provides constants which represent the numeric values of leaf nodes +of the parse tree (terminal tokens). Refer to the file :file:`Grammar/Grammar` +in the Python distribution for the definitions of the names in the context of +the language grammar. The specific numeric values which the names map to may +change between Python versions. + +The module also provides a mapping from numeric codes to names and some +functions. The functions mirror definitions in the Python C header files. + + +.. data:: tok_name + + Dictionary mapping the numeric values of the constants defined in this module + back to name strings, allowing more human-readable representation of parse trees + to be generated. + + +.. function:: ISTERMINAL(x) + + Return true for terminal token values. + + +.. function:: ISNONTERMINAL(x) + + Return true for non-terminal token values. + + +.. function:: ISEOF(x) + + Return true if *x* is the marker indicating the end of input. + + +The token constants are: + +.. data:: ENDMARKER + NAME + NUMBER + STRING + NEWLINE + INDENT + DEDENT + LPAR + RPAR + LSQB + RSQB + COLON + COMMA + SEMI + PLUS + MINUS + STAR + SLASH + VBAR + AMPER + LESS + GREATER + EQUAL + DOT + PERCENT + LBRACE + RBRACE + EQEQUAL + NOTEQUAL + LESSEQUAL + GREATEREQUAL + TILDE + CIRCUMFLEX + LEFTSHIFT + RIGHTSHIFT + DOUBLESTAR + PLUSEQUAL + MINEQUAL + STAREQUAL + SLASHEQUAL + PERCENTEQUAL + AMPEREQUAL + VBAREQUAL + CIRCUMFLEXEQUAL + LEFTSHIFTEQUAL + RIGHTSHIFTEQUAL + DOUBLESTAREQUAL + DOUBLESLASH + DOUBLESLASHEQUAL + AT + ATEQUAL + RARROW + ELLIPSIS + OP + ERRORTOKEN + N_TOKENS + NT_OFFSET + + +The following token type values aren't used by the C tokenizer but are needed for +the :mod:`tokenize` module. + +.. data:: COMMENT + + Token value used to indicate a comment. + + +.. data:: NL + + Token value used to indicate a non-terminating newline. The + :data:`NEWLINE` token indicates the end of a logical line of Python code; + ``NL`` tokens are generated when a logical line of code is continued over + multiple physical lines. + + +.. data:: ENCODING + + Token value that indicates the encoding used to decode the source bytes + into text. The first token returned by :func:`tokenize.tokenize` will + always be an ``ENCODING`` token. + + +.. versionchanged:: 3.5 + Added :data:`AWAIT` and :data:`ASYNC` tokens. + +.. versionchanged:: 3.7 + Added :data:`COMMENT`, :data:`NL` and :data:`ENCODING` tokens. + +.. versionchanged:: 3.7 + Removed :data:`AWAIT` and :data:`ASYNC` tokens. "async" and "await" are + now tokenized as :data:`NAME` tokens. diff --git a/python-3.7.4-docs-html/_sources/library/tokenize.rst.txt b/python-3.7.4-docs-html/_sources/library/tokenize.rst.txt new file mode 100644 index 0000000..4c0a0ce --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/tokenize.rst.txt @@ -0,0 +1,269 @@ +:mod:`tokenize` --- Tokenizer for Python source +=============================================== + +.. module:: tokenize + :synopsis: Lexical scanner for Python source code. + +.. moduleauthor:: Ka Ping Yee +.. sectionauthor:: Fred L. Drake, Jr. + +**Source code:** :source:`Lib/tokenize.py` + +-------------- + +The :mod:`tokenize` module provides a lexical scanner for Python source code, +implemented in Python. The scanner in this module returns comments as tokens +as well, making it useful for implementing "pretty-printers," including +colorizers for on-screen displays. + +To simplify token stream handling, all :ref:`operator ` and +:ref:`delimiter ` tokens and :data:`Ellipsis` are returned using +the generic :data:`~token.OP` token type. The exact +type can be determined by checking the ``exact_type`` property on the +:term:`named tuple` returned from :func:`tokenize.tokenize`. + +Tokenizing Input +---------------- + +The primary entry point is a :term:`generator`: + +.. function:: tokenize(readline) + + The :func:`.tokenize` generator requires one argument, *readline*, which + must be a callable object which provides the same interface as the + :meth:`io.IOBase.readline` method of file objects. Each call to the + function should return one line of input as bytes. + + The generator produces 5-tuples with these members: the token type; the + token string; a 2-tuple ``(srow, scol)`` of ints specifying the row and + column where the token begins in the source; a 2-tuple ``(erow, ecol)`` of + ints specifying the row and column where the token ends in the source; and + the line on which the token was found. The line passed (the last tuple item) + is the *logical* line; continuation lines are included. The 5 tuple is + returned as a :term:`named tuple` with the field names: + ``type string start end line``. + + The returned :term:`named tuple` has an additional property named + ``exact_type`` that contains the exact operator type for + :data:`~token.OP` tokens. For all other token types ``exact_type`` + equals the named tuple ``type`` field. + + .. versionchanged:: 3.1 + Added support for named tuples. + + .. versionchanged:: 3.3 + Added support for ``exact_type``. + + :func:`.tokenize` determines the source encoding of the file by looking for a + UTF-8 BOM or encoding cookie, according to :pep:`263`. + + +All constants from the :mod:`token` module are also exported from +:mod:`tokenize`. + +Another function is provided to reverse the tokenization process. This is +useful for creating tools that tokenize a script, modify the token stream, and +write back the modified script. + + +.. function:: untokenize(iterable) + + Converts tokens back into Python source code. The *iterable* must return + sequences with at least two elements, the token type and the token string. + Any additional sequence elements are ignored. + + The reconstructed script is returned as a single string. The result is + guaranteed to tokenize back to match the input so that the conversion is + lossless and round-trips are assured. The guarantee applies only to the + token type and token string as the spacing between tokens (column + positions) may change. + + It returns bytes, encoded using the :data:`~token.ENCODING` token, which + is the first token sequence output by :func:`.tokenize`. + + +:func:`.tokenize` needs to detect the encoding of source files it tokenizes. The +function it uses to do this is available: + +.. function:: detect_encoding(readline) + + The :func:`detect_encoding` function is used to detect the encoding that + should be used to decode a Python source file. It requires one argument, + readline, in the same way as the :func:`.tokenize` generator. + + It will call readline a maximum of twice, and return the encoding used + (as a string) and a list of any lines (not decoded from bytes) it has read + in. + + It detects the encoding from the presence of a UTF-8 BOM or an encoding + cookie as specified in :pep:`263`. If both a BOM and a cookie are present, + but disagree, a :exc:`SyntaxError` will be raised. Note that if the BOM is found, + ``'utf-8-sig'`` will be returned as an encoding. + + If no encoding is specified, then the default of ``'utf-8'`` will be + returned. + + Use :func:`.open` to open Python source files: it uses + :func:`detect_encoding` to detect the file encoding. + + +.. function:: open(filename) + + Open a file in read only mode using the encoding detected by + :func:`detect_encoding`. + + .. versionadded:: 3.2 + +.. exception:: TokenError + + Raised when either a docstring or expression that may be split over several + lines is not completed anywhere in the file, for example:: + + """Beginning of + docstring + + or:: + + [1, + 2, + 3 + +Note that unclosed single-quoted strings do not cause an error to be +raised. They are tokenized as :data:`~token.ERRORTOKEN`, followed by the +tokenization of their contents. + + +.. _tokenize-cli: + +Command-Line Usage +------------------ + +.. versionadded:: 3.3 + +The :mod:`tokenize` module can be executed as a script from the command line. +It is as simple as: + +.. code-block:: sh + + python -m tokenize [-e] [filename.py] + +The following options are accepted: + +.. program:: tokenize + +.. cmdoption:: -h, --help + + show this help message and exit + +.. cmdoption:: -e, --exact + + display token names using the exact type + +If :file:`filename.py` is specified its contents are tokenized to stdout. +Otherwise, tokenization is performed on stdin. + +Examples +------------------ + +Example of a script rewriter that transforms float literals into Decimal +objects:: + + from tokenize import tokenize, untokenize, NUMBER, STRING, NAME, OP + from io import BytesIO + + def decistmt(s): + """Substitute Decimals for floats in a string of statements. + + >>> from decimal import Decimal + >>> s = 'print(+21.3e-5*-.1234/81.7)' + >>> decistmt(s) + "print (+Decimal ('21.3e-5')*-Decimal ('.1234')/Decimal ('81.7'))" + + The format of the exponent is inherited from the platform C library. + Known cases are "e-007" (Windows) and "e-07" (not Windows). Since + 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 + -3.21716034272e-0...7 + + Output from calculations with Decimal should be identical across all + platforms. + + >>> exec(decistmt(s)) + -3.217160342717258261933904529E-7 + """ + result = [] + 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'), + (OP, '('), + (STRING, repr(tokval)), + (OP, ')') + ]) + else: + result.append((toknum, tokval)) + return untokenize(result).decode('utf-8') + +Example of tokenizing from the command line. The script:: + + def say_hello(): + print("Hello, World!") + + say_hello() + +will be tokenized to the following output where the first column is the range +of the line/column coordinates where the token is found, the second column is +the name of the token, and the final column is the value of the token (if any) + +.. code-block:: shell-session + + $ python -m tokenize hello.py + 0,0-0,0: ENCODING 'utf-8' + 1,0-1,3: NAME 'def' + 1,4-1,13: NAME 'say_hello' + 1,13-1,14: OP '(' + 1,14-1,15: OP ')' + 1,15-1,16: OP ':' + 1,16-1,17: NEWLINE '\n' + 2,0-2,4: INDENT ' ' + 2,4-2,9: NAME 'print' + 2,9-2,10: OP '(' + 2,10-2,25: STRING '"Hello, World!"' + 2,25-2,26: OP ')' + 2,26-2,27: NEWLINE '\n' + 3,0-3,1: NL '\n' + 4,0-4,0: DEDENT '' + 4,0-4,9: NAME 'say_hello' + 4,9-4,10: OP '(' + 4,10-4,11: OP ')' + 4,11-4,12: NEWLINE '\n' + 5,0-5,0: ENDMARKER '' + +The exact token type names can be displayed using the :option:`-e` option: + +.. code-block:: shell-session + + $ python -m tokenize -e hello.py + 0,0-0,0: ENCODING 'utf-8' + 1,0-1,3: NAME 'def' + 1,4-1,13: NAME 'say_hello' + 1,13-1,14: LPAR '(' + 1,14-1,15: RPAR ')' + 1,15-1,16: COLON ':' + 1,16-1,17: NEWLINE '\n' + 2,0-2,4: INDENT ' ' + 2,4-2,9: NAME 'print' + 2,9-2,10: LPAR '(' + 2,10-2,25: STRING '"Hello, World!"' + 2,25-2,26: RPAR ')' + 2,26-2,27: NEWLINE '\n' + 3,0-3,1: NL '\n' + 4,0-4,0: DEDENT '' + 4,0-4,9: NAME 'say_hello' + 4,9-4,10: LPAR '(' + 4,10-4,11: RPAR ')' + 4,11-4,12: NEWLINE '\n' + 5,0-5,0: ENDMARKER '' diff --git a/python-3.7.4-docs-html/_sources/library/trace.rst.txt b/python-3.7.4-docs-html/_sources/library/trace.rst.txt new file mode 100644 index 0000000..5cb7029 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/trace.rst.txt @@ -0,0 +1,213 @@ +:mod:`trace` --- Trace or track Python statement execution +========================================================== + +.. module:: trace + :synopsis: Trace or track Python statement execution. + +**Source code:** :source:`Lib/trace.py` + +-------------- + +The :mod:`trace` module allows you to trace program execution, generate +annotated statement coverage listings, print caller/callee relationships and +list functions executed during a program run. It can be used in another program +or from the command line. + +.. seealso:: + + `Coverage.py `_ + A popular third-party coverage tool that provides HTML + output along with advanced features such as branch coverage. + +.. _trace-cli: + +Command-Line Usage +------------------ + +The :mod:`trace` module can be invoked from the command line. It can be as +simple as :: + + python -m trace --count -C . somefile.py ... + +The above will execute :file:`somefile.py` and generate annotated listings of +all Python modules imported during the execution into the current directory. + +.. program:: trace + +.. cmdoption:: --help + + Display usage and exit. + +.. cmdoption:: --version + + Display the version of the module and exit. + +Main options +^^^^^^^^^^^^ + +At least one of the following options must be specified when invoking +:mod:`trace`. The :option:`--listfuncs <-l>` option is mutually exclusive with +the :option:`--trace <-t>` and :option:`--count <-c>` options. When +:option:`--listfuncs <-l>` is provided, neither :option:`--count <-c>` nor +:option:`--trace <-t>` are accepted, and vice versa. + +.. program:: trace + +.. cmdoption:: -c, --count + + Produce a set of annotated listing files upon program completion that shows + how many times each statement was executed. See also + :option:`--coverdir <-C>`, :option:`--file <-f>` and + :option:`--no-report <-R>` below. + +.. cmdoption:: -t, --trace + + Display lines as they are executed. + +.. cmdoption:: -l, --listfuncs + + Display the functions executed by running the program. + +.. cmdoption:: -r, --report + + Produce an annotated list from an earlier program run that used the + :option:`--count <-c>` and :option:`--file <-f>` option. This does not + execute any code. + +.. cmdoption:: -T, --trackcalls + + Display the calling relationships exposed by running the program. + +Modifiers +^^^^^^^^^ + +.. program:: trace + +.. cmdoption:: -f, --file= + + Name of a file to accumulate counts over several tracing runs. Should be + used with the :option:`--count <-c>` option. + +.. cmdoption:: -C, --coverdir= + + Directory where the report files go. The coverage report for + ``package.module`` is written to file :file:`{dir}/{package}/{module}.cover`. + +.. cmdoption:: -m, --missing + + When generating annotated listings, mark lines which were not executed with + ``>>>>>>``. + +.. cmdoption:: -s, --summary + + When using :option:`--count <-c>` or :option:`--report <-r>`, write a brief + summary to stdout for each file processed. + +.. cmdoption:: -R, --no-report + + Do not generate annotated listings. This is useful if you intend to make + several runs with :option:`--count <-c>`, and then produce a single set of + annotated listings at the end. + +.. cmdoption:: -g, --timing + + Prefix each line with the time since the program started. Only used while + tracing. + +Filters +^^^^^^^ + +These options may be repeated multiple times. + +.. program:: trace + +.. cmdoption:: --ignore-module= + + Ignore each of the given module names and its submodules (if it is a + package). The argument can be a list of names separated by a comma. + +.. cmdoption:: --ignore-dir= + + Ignore all modules and packages in the named directory and subdirectories. + The argument can be a list of directories separated by :data:`os.pathsep`. + +.. _trace-api: + +Programmatic Interface +---------------------- + +.. class:: Trace(count=1, trace=1, countfuncs=0, countcallers=0, ignoremods=(),\ + ignoredirs=(), infile=None, outfile=None, timing=False) + + Create an object to trace execution of a single statement or expression. All + parameters are optional. *count* enables counting of line numbers. *trace* + enables line execution tracing. *countfuncs* enables listing of the + functions called during the run. *countcallers* enables call relationship + tracking. *ignoremods* is a list of modules or packages to ignore. + *ignoredirs* is a list of directories whose modules or packages should be + ignored. *infile* is the name of the file from which to read stored count + information. *outfile* is the name of the file in which to write updated + count information. *timing* enables a timestamp relative to when tracing was + started to be displayed. + + .. method:: run(cmd) + + Execute the command and gather statistics from the execution with + the current tracing parameters. *cmd* must be a string or code object, + suitable for passing into :func:`exec`. + + .. method:: runctx(cmd, globals=None, locals=None) + + Execute the command and gather statistics from the execution with the + current tracing parameters, in the defined global and local + environments. If not defined, *globals* and *locals* default to empty + dictionaries. + + .. method:: runfunc(func, *args, **kwds) + + Call *func* with the given arguments under control of the :class:`Trace` + object with the current tracing parameters. + + .. method:: results() + + Return a :class:`CoverageResults` object that contains the cumulative + results of all previous calls to ``run``, ``runctx`` and ``runfunc`` + for the given :class:`Trace` instance. Does not reset the accumulated + trace results. + +.. class:: CoverageResults + + A container for coverage results, created by :meth:`Trace.results`. Should + not be created directly by the user. + + .. method:: update(other) + + Merge in data from another :class:`CoverageResults` object. + + .. method:: write_results(show_missing=True, summary=False, coverdir=None) + + Write coverage results. Set *show_missing* to show lines that had no + hits. Set *summary* to include in the output the coverage summary per + module. *coverdir* specifies the directory into which the coverage + result files will be output. If ``None``, the results for each source + file are placed in its directory. + +A simple example demonstrating the use of the programmatic interface:: + + import sys + import trace + + # create a Trace object, telling it what to ignore, and whether to + # do tracing or line-counting or both. + tracer = trace.Trace( + ignoredirs=[sys.prefix, sys.exec_prefix], + trace=0, + count=1) + + # run the new command using the given tracer + tracer.run('main()') + + # make a report, placing output in the current directory + r = tracer.results() + r.write_results(show_missing=True, coverdir=".") + diff --git a/python-3.7.4-docs-html/_sources/library/traceback.rst.txt b/python-3.7.4-docs-html/_sources/library/traceback.rst.txt new file mode 100644 index 0000000..462a6a5 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/traceback.rst.txt @@ -0,0 +1,486 @@ +:mod:`traceback` --- Print or retrieve a stack traceback +======================================================== + +.. module:: traceback + :synopsis: Print or retrieve a stack traceback. + +**Source code:** :source:`Lib/traceback.py` + +-------------- + +This module provides a standard interface to extract, format and print stack +traces of Python programs. It exactly mimics the behavior of the Python +interpreter when it prints a stack trace. This is useful when you want to print +stack traces under program control, such as in a "wrapper" around the +interpreter. + +.. index:: object: traceback + +The module uses traceback objects --- this is the object type that is stored in +the :data:`sys.last_traceback` variable and returned as the third item from +:func:`sys.exc_info`. + +The module defines the following functions: + + +.. function:: print_tb(tb, limit=None, file=None) + + Print up to *limit* stack trace entries from traceback object *tb* (starting + from the caller's frame) if *limit* is positive. Otherwise, print the last + ``abs(limit)`` entries. If *limit* is omitted or ``None``, all entries are + printed. If *file* is omitted or ``None``, the output goes to + ``sys.stderr``; otherwise it should be an open file or file-like object to + receive the output. + + .. versionchanged:: 3.5 + Added negative *limit* support. + + +.. function:: print_exception(etype, value, tb, limit=None, file=None, chain=True) + + Print exception information and stack trace entries from traceback object + *tb* to *file*. This differs from :func:`print_tb` in the following + ways: + + * if *tb* is not ``None``, it prints a header ``Traceback (most recent + call last):`` + + * it prints the exception *etype* and *value* after the stack trace + + .. index:: single: ^ (caret); marker + + * if *type(value)* is :exc:`SyntaxError` and *value* has the appropriate + format, it prints the line where the syntax error occurred with a caret + indicating the approximate position of the error. + + The optional *limit* argument has the same meaning as for :func:`print_tb`. + If *chain* is true (the default), then chained exceptions (the + :attr:`__cause__` or :attr:`__context__` attributes of the exception) will be + printed as well, like the interpreter itself does when printing an unhandled + exception. + + .. versionchanged:: 3.5 + The *etype* argument is ignored and inferred from the type of *value*. + + +.. function:: print_exc(limit=None, file=None, chain=True) + + This is a shorthand for ``print_exception(*sys.exc_info(), limit, file, + chain)``. + + +.. function:: print_last(limit=None, file=None, chain=True) + + This is a shorthand for ``print_exception(sys.last_type, sys.last_value, + sys.last_traceback, limit, file, chain)``. In general it will work only + after an exception has reached an interactive prompt (see + :data:`sys.last_type`). + + +.. function:: print_stack(f=None, limit=None, file=None) + + Print up to *limit* stack trace entries (starting from the invocation + point) if *limit* is positive. Otherwise, print the last ``abs(limit)`` + entries. If *limit* is omitted or ``None``, all entries are printed. + The optional *f* argument can be used to specify an alternate stack frame + to start. The optional *file* argument has the same meaning as for + :func:`print_tb`. + + .. versionchanged:: 3.5 + Added negative *limit* support. + + +.. function:: extract_tb(tb, limit=None) + + Return a :class:`StackSummary` object representing a list of "pre-processed" + stack trace entries extracted from the traceback object *tb*. It is useful + for alternate formatting of stack traces. The optional *limit* argument has + the same meaning as for :func:`print_tb`. A "pre-processed" stack trace + entry is a :class:`FrameSummary` object containing attributes + :attr:`~FrameSummary.filename`, :attr:`~FrameSummary.lineno`, + :attr:`~FrameSummary.name`, and :attr:`~FrameSummary.line` representing the + information that is usually printed for a stack trace. The + :attr:`~FrameSummary.line` is a string with leading and trailing + whitespace stripped; if the source is not available it is ``None``. + + +.. function:: extract_stack(f=None, limit=None) + + Extract the raw traceback from the current stack frame. The return value has + the same format as for :func:`extract_tb`. The optional *f* and *limit* + arguments have the same meaning as for :func:`print_stack`. + + +.. function:: format_list(extracted_list) + + Given a list of tuples or :class:`FrameSummary` objects as returned by + :func:`extract_tb` or :func:`extract_stack`, return a list of strings ready + for printing. Each string in the resulting list corresponds to the item with + the same index in the argument list. Each string ends in a newline; the + strings may contain internal newlines as well, for those items whose source + text line is not ``None``. + + +.. function:: format_exception_only(etype, value) + + Format the exception part of a traceback. The arguments are the exception + type and value such as given by ``sys.last_type`` and ``sys.last_value``. + The return value is a list of strings, each ending in a newline. Normally, + the list contains a single string; however, for :exc:`SyntaxError` + exceptions, it contains several lines that (when printed) display detailed + information about where the syntax error occurred. The message indicating + which exception occurred is the always last string in the list. + + +.. function:: format_exception(etype, value, tb, limit=None, chain=True) + + Format a stack trace and the exception information. The arguments have the + same meaning as the corresponding arguments to :func:`print_exception`. The + return value is a list of strings, each ending in a newline and some + containing internal newlines. When these lines are concatenated and printed, + exactly the same text is printed as does :func:`print_exception`. + + .. versionchanged:: 3.5 + The *etype* argument is ignored and inferred from the type of *value*. + + +.. function:: format_exc(limit=None, chain=True) + + This is like ``print_exc(limit)`` but returns a string instead of printing to + a file. + + +.. function:: format_tb(tb, limit=None) + + A shorthand for ``format_list(extract_tb(tb, limit))``. + + +.. function:: format_stack(f=None, limit=None) + + A shorthand for ``format_list(extract_stack(f, limit))``. + +.. function:: clear_frames(tb) + + Clears the local variables of all the stack frames in a traceback *tb* + by calling the :meth:`clear` method of each frame object. + + .. versionadded:: 3.4 + +.. function:: walk_stack(f) + + Walk a stack following ``f.f_back`` from the given frame, yielding the frame + and line number for each frame. If *f* is ``None``, the current stack is + used. This helper is used with :meth:`StackSummary.extract`. + + .. versionadded:: 3.5 + +.. function:: walk_tb(tb) + + Walk a traceback following ``tb_next`` yielding the frame and line number + for each frame. This helper is used with :meth:`StackSummary.extract`. + + .. versionadded:: 3.5 + +The module also defines the following classes: + +:class:`TracebackException` Objects +----------------------------------- + +.. versionadded:: 3.5 + +:class:`TracebackException` objects are created from actual exceptions to +capture data for later printing in a lightweight fashion. + +.. class:: TracebackException(exc_type, exc_value, exc_traceback, *, limit=None, lookup_lines=True, capture_locals=False) + + Capture an exception for later rendering. *limit*, *lookup_lines* and + *capture_locals* are as for the :class:`StackSummary` class. + + Note that when locals are captured, they are also shown in the traceback. + + .. attribute:: __cause__ + + A :class:`TracebackException` of the original ``__cause__``. + + .. attribute:: __context__ + + A :class:`TracebackException` of the original ``__context__``. + + .. attribute:: __suppress_context__ + + The ``__suppress_context__`` value from the original exception. + + .. attribute:: stack + + A :class:`StackSummary` representing the traceback. + + .. attribute:: exc_type + + The class of the original traceback. + + .. attribute:: filename + + For syntax errors - the file name where the error occurred. + + .. attribute:: lineno + + For syntax errors - the line number where the error occurred. + + .. attribute:: text + + For syntax errors - the text where the error occurred. + + .. attribute:: offset + + For syntax errors - the offset into the text where the error occurred. + + .. attribute:: msg + + For syntax errors - the compiler error message. + + .. classmethod:: from_exception(exc, *, limit=None, lookup_lines=True, capture_locals=False) + + Capture an exception for later rendering. *limit*, *lookup_lines* and + *capture_locals* are as for the :class:`StackSummary` class. + + Note that when locals are captured, they are also shown in the traceback. + + .. method:: format(*, chain=True) + + Format the exception. + + If *chain* is not ``True``, ``__cause__`` and ``__context__`` will not + be formatted. + + The return value is a generator of strings, each ending in a newline and + some containing internal newlines. :func:`~traceback.print_exception` + is a wrapper around this method which just prints the lines to a file. + + The message indicating which exception occurred is always the last + string in the output. + + .. method:: format_exception_only() + + Format the exception part of the traceback. + + The return value is a generator of strings, each ending in a newline. + + Normally, the generator emits a single string; however, for + :exc:`SyntaxError` exceptions, it emits several lines that (when + printed) display detailed information about where the syntax + error occurred. + + The message indicating which exception occurred is always the last + string in the output. + + +:class:`StackSummary` Objects +----------------------------- + +.. versionadded:: 3.5 + +:class:`StackSummary` objects represent a call stack ready for formatting. + +.. class:: StackSummary + + .. classmethod:: extract(frame_gen, *, limit=None, lookup_lines=True, capture_locals=False) + + Construct a :class:`StackSummary` object from a frame generator (such as + is returned by :func:`~traceback.walk_stack` or + :func:`~traceback.walk_tb`). + + If *limit* is supplied, only this many frames are taken from *frame_gen*. + If *lookup_lines* is ``False``, the returned :class:`FrameSummary` + objects will not have read their lines in yet, making the cost of + creating the :class:`StackSummary` cheaper (which may be valuable if it + may not actually get formatted). If *capture_locals* is ``True`` the + local variables in each :class:`FrameSummary` are captured as object + representations. + + .. classmethod:: from_list(a_list) + + Construct a :class:`StackSummary` object from a supplied list of + :class:`FrameSummary` objects or old-style list of tuples. Each tuple + should be a 4-tuple with filename, lineno, name, line as the elements. + + .. method:: format() + + Returns a list of strings ready for printing. Each string in the + resulting list corresponds to a single frame from the stack. + Each string ends in a newline; the strings may contain internal + newlines as well, for those items with source text lines. + + For long sequences of the same frame and line, the first few + repetitions are shown, followed by a summary line stating the exact + number of further repetitions. + + .. versionchanged:: 3.6 + Long sequences of repeated frames are now abbreviated. + + +:class:`FrameSummary` Objects +----------------------------- + +.. versionadded:: 3.5 + +:class:`FrameSummary` objects represent a single frame in a traceback. + +.. class:: FrameSummary(filename, lineno, name, lookup_line=True, locals=None, line=None) + + Represent a single frame in the traceback or stack that is being formatted + or printed. It may optionally have a stringified version of the frames + locals included in it. If *lookup_line* is ``False``, the source code is not + looked up until the :class:`FrameSummary` has the :attr:`~FrameSummary.line` + attribute accessed (which also happens when casting it to a tuple). + :attr:`~FrameSummary.line` may be directly provided, and will prevent line + lookups happening at all. *locals* is an optional local variable + dictionary, and if supplied the variable representations are stored in the + summary for later display. + +.. _traceback-example: + +Traceback Examples +------------------ + +This simple example implements a basic read-eval-print loop, similar to (but +less useful than) the standard Python interactive interpreter loop. For a more +complete implementation of the interpreter loop, refer to the :mod:`code` +module. :: + + import sys, traceback + + def run_user_code(envdir): + source = input(">>> ") + try: + exec(source, envdir) + except Exception: + print("Exception in user code:") + print("-"*60) + traceback.print_exc(file=sys.stdout) + print("-"*60) + + envdir = {} + while True: + run_user_code(envdir) + + +The following example demonstrates the different ways to print and format the +exception and traceback: + +.. testcode:: + + import sys, traceback + + def lumberjack(): + bright_side_of_death() + + def bright_side_of_death(): + return tuple()[0] + + try: + lumberjack() + except IndexError: + exc_type, exc_value, exc_traceback = sys.exc_info() + print("*** print_tb:") + traceback.print_tb(exc_traceback, limit=1, file=sys.stdout) + print("*** print_exception:") + # exc_type below is ignored on 3.5 and later + traceback.print_exception(exc_type, exc_value, exc_traceback, + limit=2, file=sys.stdout) + print("*** print_exc:") + traceback.print_exc(limit=2, file=sys.stdout) + print("*** format_exc, first and last line:") + formatted_lines = traceback.format_exc().splitlines() + print(formatted_lines[0]) + print(formatted_lines[-1]) + print("*** format_exception:") + # exc_type below is ignored on 3.5 and later + print(repr(traceback.format_exception(exc_type, exc_value, + exc_traceback))) + print("*** extract_tb:") + print(repr(traceback.extract_tb(exc_traceback))) + print("*** format_tb:") + print(repr(traceback.format_tb(exc_traceback))) + print("*** tb_lineno:", exc_traceback.tb_lineno) + +The output for the example would look similar to this: + +.. testoutput:: + :options: +NORMALIZE_WHITESPACE + + *** print_tb: + File "", line 10, in + lumberjack() + *** print_exception: + Traceback (most recent call last): + File "", line 10, in + lumberjack() + File "", line 4, in lumberjack + bright_side_of_death() + IndexError: tuple index out of range + *** print_exc: + Traceback (most recent call last): + File "", line 10, in + lumberjack() + File "", line 4, in lumberjack + bright_side_of_death() + IndexError: tuple index out of range + *** format_exc, first and last line: + Traceback (most recent call last): + IndexError: tuple index out of range + *** format_exception: + ['Traceback (most recent call last):\n', + ' File "", line 10, in \n lumberjack()\n', + ' File "", line 4, in lumberjack\n bright_side_of_death()\n', + ' File "", line 7, in bright_side_of_death\n return tuple()[0]\n', + 'IndexError: tuple index out of range\n'] + *** extract_tb: + [, line 10 in >, + , line 4 in lumberjack>, + , line 7 in bright_side_of_death>] + *** format_tb: + [' File "", line 10, in \n lumberjack()\n', + ' File "", line 4, in lumberjack\n bright_side_of_death()\n', + ' File "", line 7, in bright_side_of_death\n return tuple()[0]\n'] + *** tb_lineno: 10 + + +The following example shows the different ways to print and format the stack:: + + >>> import traceback + >>> def another_function(): + ... lumberstack() + ... + >>> def lumberstack(): + ... traceback.print_stack() + ... print(repr(traceback.extract_stack())) + ... print(repr(traceback.format_stack())) + ... + >>> another_function() + File "", line 10, in + another_function() + File "", line 3, in another_function + lumberstack() + File "", line 6, in lumberstack + traceback.print_stack() + [('', 10, '', 'another_function()'), + ('', 3, 'another_function', 'lumberstack()'), + ('', 7, 'lumberstack', 'print(repr(traceback.extract_stack()))')] + [' File "", line 10, in \n another_function()\n', + ' File "", line 3, in another_function\n lumberstack()\n', + ' File "", line 8, in lumberstack\n print(repr(traceback.format_stack()))\n'] + + +This last example demonstrates the final few formatting functions: + +.. doctest:: + :options: +NORMALIZE_WHITESPACE + + >>> import traceback + >>> traceback.format_list([('spam.py', 3, '', 'spam.eggs()'), + ... ('eggs.py', 42, 'eggs', 'return "bacon"')]) + [' File "spam.py", line 3, in \n spam.eggs()\n', + ' File "eggs.py", line 42, in eggs\n return "bacon"\n'] + >>> an_error = IndexError('tuple index out of range') + >>> traceback.format_exception_only(type(an_error), an_error) + ['IndexError: tuple index out of range\n'] diff --git a/python-3.7.4-docs-html/_sources/library/tracemalloc.rst.txt b/python-3.7.4-docs-html/_sources/library/tracemalloc.rst.txt new file mode 100644 index 0000000..2d327c0 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/tracemalloc.rst.txt @@ -0,0 +1,693 @@ +:mod:`tracemalloc` --- Trace memory allocations +=============================================== + +.. module:: tracemalloc + :synopsis: Trace memory allocations. + +.. versionadded:: 3.4 + +**Source code:** :source:`Lib/tracemalloc.py` + +-------------- + +The tracemalloc module is a debug tool to trace memory blocks allocated by +Python. It provides the following information: + +* Traceback where an object was allocated +* Statistics on allocated memory blocks per filename and per line number: + total size, number and average size of allocated memory blocks +* Compute the differences between two snapshots to detect memory leaks + +To trace most memory blocks allocated by Python, the module should be started +as early as possible by setting the :envvar:`PYTHONTRACEMALLOC` environment +variable to ``1``, or by using :option:`-X` ``tracemalloc`` command line +option. The :func:`tracemalloc.start` function can be called at runtime to +start tracing Python memory allocations. + +By default, a trace of an allocated memory block only stores the most recent +frame (1 frame). To store 25 frames at startup: set the +:envvar:`PYTHONTRACEMALLOC` environment variable to ``25``, or use the +:option:`-X` ``tracemalloc=25`` command line option. + + +Examples +-------- + +Display the top 10 +^^^^^^^^^^^^^^^^^^ + +Display the 10 files allocating the most memory:: + + import tracemalloc + + tracemalloc.start() + + # ... run your application ... + + snapshot = tracemalloc.take_snapshot() + top_stats = snapshot.statistics('lineno') + + print("[ Top 10 ]") + for stat in top_stats[:10]: + print(stat) + + +Example of output of the Python test suite:: + + [ Top 10 ] + :716: size=4855 KiB, count=39328, average=126 B + :284: size=521 KiB, count=3199, average=167 B + /usr/lib/python3.4/collections/__init__.py:368: size=244 KiB, count=2315, average=108 B + /usr/lib/python3.4/unittest/case.py:381: size=185 KiB, count=779, average=243 B + /usr/lib/python3.4/unittest/case.py:402: size=154 KiB, count=378, average=416 B + /usr/lib/python3.4/abc.py:133: size=88.7 KiB, count=347, average=262 B + :1446: size=70.4 KiB, count=911, average=79 B + :1454: size=52.0 KiB, count=25, average=2131 B + :5: size=49.7 KiB, count=148, average=344 B + /usr/lib/python3.4/sysconfig.py:411: size=48.0 KiB, count=1, average=48.0 KiB + +We can see that Python loaded ``4855 KiB`` data (bytecode and constants) from +modules and that the :mod:`collections` module allocated ``244 KiB`` to build +:class:`~collections.namedtuple` types. + +See :meth:`Snapshot.statistics` for more options. + + +Compute differences +^^^^^^^^^^^^^^^^^^^ + +Take two snapshots and display the differences:: + + import tracemalloc + tracemalloc.start() + # ... start your application ... + + snapshot1 = tracemalloc.take_snapshot() + # ... call the function leaking memory ... + snapshot2 = tracemalloc.take_snapshot() + + top_stats = snapshot2.compare_to(snapshot1, 'lineno') + + print("[ Top 10 differences ]") + for stat in top_stats[:10]: + print(stat) + +Example of output before/after running some tests of the Python test suite:: + + [ Top 10 differences ] + :716: size=8173 KiB (+4428 KiB), count=71332 (+39369), average=117 B + /usr/lib/python3.4/linecache.py:127: size=940 KiB (+940 KiB), count=8106 (+8106), average=119 B + /usr/lib/python3.4/unittest/case.py:571: size=298 KiB (+298 KiB), count=589 (+589), average=519 B + :284: size=1005 KiB (+166 KiB), count=7423 (+1526), average=139 B + /usr/lib/python3.4/mimetypes.py:217: size=112 KiB (+112 KiB), count=1334 (+1334), average=86 B + /usr/lib/python3.4/http/server.py:848: size=96.0 KiB (+96.0 KiB), count=1 (+1), average=96.0 KiB + /usr/lib/python3.4/inspect.py:1465: size=83.5 KiB (+83.5 KiB), count=109 (+109), average=784 B + /usr/lib/python3.4/unittest/mock.py:491: size=77.7 KiB (+77.7 KiB), count=143 (+143), average=557 B + /usr/lib/python3.4/urllib/parse.py:476: size=71.8 KiB (+71.8 KiB), count=969 (+969), average=76 B + /usr/lib/python3.4/contextlib.py:38: size=67.2 KiB (+67.2 KiB), count=126 (+126), average=546 B + +We can see that Python has loaded ``8173 KiB`` of module data (bytecode and +constants), and that this is ``4428 KiB`` more than had been loaded before the +tests, when the previous snapshot was taken. Similarly, the :mod:`linecache` +module has cached ``940 KiB`` of Python source code to format tracebacks, all +of it since the previous snapshot. + +If the system has little free memory, snapshots can be written on disk using +the :meth:`Snapshot.dump` method to analyze the snapshot offline. Then use the +:meth:`Snapshot.load` method reload the snapshot. + + +Get the traceback of a memory block +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Code to display the traceback of the biggest memory block:: + + import tracemalloc + + # Store 25 frames + tracemalloc.start(25) + + # ... run your application ... + + snapshot = tracemalloc.take_snapshot() + top_stats = snapshot.statistics('traceback') + + # pick the biggest memory block + stat = top_stats[0] + print("%s memory blocks: %.1f KiB" % (stat.count, stat.size / 1024)) + for line in stat.traceback.format(): + print(line) + +Example of output of the Python test suite (traceback limited to 25 frames):: + + 903 memory blocks: 870.1 KiB + File "", line 716 + File "", line 1036 + File "", line 934 + File "", line 1068 + File "", line 619 + File "", line 1581 + File "", line 1614 + File "/usr/lib/python3.4/doctest.py", line 101 + import pdb + File "", line 284 + File "", line 938 + File "", line 1068 + File "", line 619 + File "", line 1581 + File "", line 1614 + File "/usr/lib/python3.4/test/support/__init__.py", line 1728 + import doctest + File "/usr/lib/python3.4/test/test_pickletools.py", line 21 + support.run_doctest(pickletools) + File "/usr/lib/python3.4/test/regrtest.py", line 1276 + test_runner() + File "/usr/lib/python3.4/test/regrtest.py", line 976 + display_failure=not verbose) + File "/usr/lib/python3.4/test/regrtest.py", line 761 + match_tests=ns.match_tests) + File "/usr/lib/python3.4/test/regrtest.py", line 1563 + main() + File "/usr/lib/python3.4/test/__main__.py", line 3 + regrtest.main_in_temp_cwd() + File "/usr/lib/python3.4/runpy.py", line 73 + exec(code, run_globals) + File "/usr/lib/python3.4/runpy.py", line 160 + "__main__", fname, loader, pkg_name) + +We can see that the most memory was allocated in the :mod:`importlib` module to +load data (bytecode and constants) from modules: ``870.1 KiB``. The traceback is +where the :mod:`importlib` loaded data most recently: on the ``import pdb`` +line of the :mod:`doctest` module. The traceback may change if a new module is +loaded. + + +Pretty top +^^^^^^^^^^ + +Code to display the 10 lines allocating the most memory with a pretty output, +ignoring ```` and ```` files:: + + import linecache + import os + import tracemalloc + + def display_top(snapshot, key_type='lineno', limit=10): + snapshot = snapshot.filter_traces(( + tracemalloc.Filter(False, ""), + tracemalloc.Filter(False, ""), + )) + top_stats = snapshot.statistics(key_type) + + print("Top %s lines" % limit) + for index, stat in enumerate(top_stats[:limit], 1): + frame = stat.traceback[0] + # replace "/path/to/module/file.py" with "module/file.py" + filename = os.sep.join(frame.filename.split(os.sep)[-2:]) + print("#%s: %s:%s: %.1f KiB" + % (index, filename, frame.lineno, stat.size / 1024)) + line = linecache.getline(frame.filename, frame.lineno).strip() + if line: + print(' %s' % line) + + other = top_stats[limit:] + if other: + size = sum(stat.size for stat in other) + print("%s other: %.1f KiB" % (len(other), size / 1024)) + total = sum(stat.size for stat in top_stats) + print("Total allocated size: %.1f KiB" % (total / 1024)) + + tracemalloc.start() + + # ... run your application ... + + snapshot = tracemalloc.take_snapshot() + display_top(snapshot) + +Example of output of the Python test suite:: + + Top 10 lines + #1: Lib/base64.py:414: 419.8 KiB + _b85chars2 = [(a + b) for a in _b85chars for b in _b85chars] + #2: Lib/base64.py:306: 419.8 KiB + _a85chars2 = [(a + b) for a in _a85chars for b in _a85chars] + #3: collections/__init__.py:368: 293.6 KiB + exec(class_definition, namespace) + #4: Lib/abc.py:133: 115.2 KiB + cls = super().__new__(mcls, name, bases, namespace) + #5: unittest/case.py:574: 103.1 KiB + testMethod() + #6: Lib/linecache.py:127: 95.4 KiB + lines = fp.readlines() + #7: urllib/parse.py:476: 71.8 KiB + for a in _hexdig for b in _hexdig} + #8: :5: 62.0 KiB + #9: Lib/_weakrefset.py:37: 60.0 KiB + self.data = set() + #10: Lib/base64.py:142: 59.8 KiB + _b32tab2 = [a + b for a in _b32tab for b in _b32tab] + 6220 other: 3602.8 KiB + Total allocated size: 5303.1 KiB + +See :meth:`Snapshot.statistics` for more options. + + +API +--- + +Functions +^^^^^^^^^ + +.. function:: clear_traces() + + Clear traces of memory blocks allocated by Python. + + See also :func:`stop`. + + +.. function:: get_object_traceback(obj) + + Get the traceback where the Python object *obj* was allocated. + Return a :class:`Traceback` instance, or ``None`` if the :mod:`tracemalloc` + module is not tracing memory allocations or did not trace the allocation of + the object. + + See also :func:`gc.get_referrers` and :func:`sys.getsizeof` functions. + + +.. function:: get_traceback_limit() + + Get the maximum number of frames stored in the traceback of a trace. + + The :mod:`tracemalloc` module must be tracing memory allocations to + get the limit, otherwise an exception is raised. + + The limit is set by the :func:`start` function. + + +.. function:: get_traced_memory() + + Get the current size and peak size of memory blocks traced by the + :mod:`tracemalloc` module as a tuple: ``(current: int, peak: int)``. + + +.. function:: get_tracemalloc_memory() + + Get the memory usage in bytes of the :mod:`tracemalloc` module used to store + traces of memory blocks. + Return an :class:`int`. + + +.. function:: is_tracing() + + ``True`` if the :mod:`tracemalloc` module is tracing Python memory + allocations, ``False`` otherwise. + + See also :func:`start` and :func:`stop` functions. + + +.. function:: start(nframe: int=1) + + Start tracing Python memory allocations: install hooks on Python memory + allocators. Collected tracebacks of traces will be limited to *nframe* + frames. By default, a trace of a memory block only stores the most recent + frame: the limit is ``1``. *nframe* must be greater or equal to ``1``. + + Storing more than ``1`` frame is only useful to compute statistics grouped + by ``'traceback'`` or to compute cumulative statistics: see the + :meth:`Snapshot.compare_to` and :meth:`Snapshot.statistics` methods. + + Storing more frames increases the memory and CPU overhead of the + :mod:`tracemalloc` module. Use the :func:`get_tracemalloc_memory` function + to measure how much memory is used by the :mod:`tracemalloc` module. + + The :envvar:`PYTHONTRACEMALLOC` environment variable + (``PYTHONTRACEMALLOC=NFRAME``) and the :option:`-X` ``tracemalloc=NFRAME`` + command line option can be used to start tracing at startup. + + See also :func:`stop`, :func:`is_tracing` and :func:`get_traceback_limit` + functions. + + +.. function:: stop() + + Stop tracing Python memory allocations: uninstall hooks on Python memory + allocators. Also clears all previously collected traces of memory blocks + allocated by Python. + + Call :func:`take_snapshot` function to take a snapshot of traces before + clearing them. + + See also :func:`start`, :func:`is_tracing` and :func:`clear_traces` + functions. + + +.. function:: take_snapshot() + + Take a snapshot of traces of memory blocks allocated by Python. Return a new + :class:`Snapshot` instance. + + The snapshot does not include memory blocks allocated before the + :mod:`tracemalloc` module started to trace memory allocations. + + Tracebacks of traces are limited to :func:`get_traceback_limit` frames. Use + the *nframe* parameter of the :func:`start` function to store more frames. + + The :mod:`tracemalloc` module must be tracing memory allocations to take a + snapshot, see the :func:`start` function. + + See also the :func:`get_object_traceback` function. + + +DomainFilter +^^^^^^^^^^^^ + +.. class:: DomainFilter(inclusive: bool, domain: int) + + Filter traces of memory blocks by their address space (domain). + + .. versionadded:: 3.6 + + .. attribute:: inclusive + + If *inclusive* is ``True`` (include), match memory blocks allocated + in the address space :attr:`domain`. + + If *inclusive* is ``False`` (exclude), match memory blocks not allocated + in the address space :attr:`domain`. + + .. attribute:: domain + + Address space of a memory block (``int``). Read-only property. + + +Filter +^^^^^^ + +.. class:: Filter(inclusive: bool, filename_pattern: str, lineno: int=None, all_frames: bool=False, domain: int=None) + + Filter on traces of memory blocks. + + See the :func:`fnmatch.fnmatch` function for the syntax of + *filename_pattern*. The ``'.pyc'`` file extension is + replaced with ``'.py'``. + + Examples: + + * ``Filter(True, subprocess.__file__)`` only includes traces of the + :mod:`subprocess` module + * ``Filter(False, tracemalloc.__file__)`` excludes traces of the + :mod:`tracemalloc` module + * ``Filter(False, "")`` excludes empty tracebacks + + + .. versionchanged:: 3.5 + The ``'.pyo'`` file extension is no longer replaced with ``'.py'``. + + .. versionchanged:: 3.6 + Added the :attr:`domain` attribute. + + + .. attribute:: domain + + Address space of a memory block (``int`` or ``None``). + + tracemalloc uses the domain ``0`` to trace memory allocations made by + Python. C extensions can use other domains to trace other resources. + + .. attribute:: inclusive + + If *inclusive* is ``True`` (include), only match memory blocks allocated + in a file with a name matching :attr:`filename_pattern` at line number + :attr:`lineno`. + + If *inclusive* is ``False`` (exclude), ignore memory blocks allocated in + a file with a name matching :attr:`filename_pattern` at line number + :attr:`lineno`. + + .. attribute:: lineno + + Line number (``int``) of the filter. If *lineno* is ``None``, the filter + matches any line number. + + .. attribute:: filename_pattern + + Filename pattern of the filter (``str``). Read-only property. + + .. attribute:: all_frames + + If *all_frames* is ``True``, all frames of the traceback are checked. If + *all_frames* is ``False``, only the most recent frame is checked. + + This attribute has no effect if the traceback limit is ``1``. See the + :func:`get_traceback_limit` function and :attr:`Snapshot.traceback_limit` + attribute. + + +Frame +^^^^^ + +.. class:: Frame + + Frame of a traceback. + + The :class:`Traceback` class is a sequence of :class:`Frame` instances. + + .. attribute:: filename + + Filename (``str``). + + .. attribute:: lineno + + Line number (``int``). + + +Snapshot +^^^^^^^^ + +.. class:: Snapshot + + Snapshot of traces of memory blocks allocated by Python. + + The :func:`take_snapshot` function creates a snapshot instance. + + .. method:: compare_to(old_snapshot: Snapshot, key_type: str, cumulative: bool=False) + + Compute the differences with an old snapshot. Get statistics as a sorted + list of :class:`StatisticDiff` instances grouped by *key_type*. + + See the :meth:`Snapshot.statistics` method for *key_type* and *cumulative* + parameters. + + The result is sorted from the biggest to the smallest by: absolute value + of :attr:`StatisticDiff.size_diff`, :attr:`StatisticDiff.size`, absolute + value of :attr:`StatisticDiff.count_diff`, :attr:`Statistic.count` and + then by :attr:`StatisticDiff.traceback`. + + + .. method:: dump(filename) + + Write the snapshot into a file. + + Use :meth:`load` to reload the snapshot. + + + .. method:: filter_traces(filters) + + Create a new :class:`Snapshot` instance with a filtered :attr:`traces` + sequence, *filters* is a list of :class:`DomainFilter` and + :class:`Filter` instances. If *filters* is an empty list, return a new + :class:`Snapshot` instance with a copy of the traces. + + All inclusive filters are applied at once, a trace is ignored if no + inclusive filters match it. A trace is ignored if at least one exclusive + filter matches it. + + .. versionchanged:: 3.6 + :class:`DomainFilter` instances are now also accepted in *filters*. + + + .. classmethod:: load(filename) + + Load a snapshot from a file. + + See also :meth:`dump`. + + + .. method:: statistics(key_type: str, cumulative: bool=False) + + Get statistics as a sorted list of :class:`Statistic` instances grouped + by *key_type*: + + ===================== ======================== + key_type description + ===================== ======================== + ``'filename'`` filename + ``'lineno'`` filename and line number + ``'traceback'`` traceback + ===================== ======================== + + If *cumulative* is ``True``, cumulate size and count of memory blocks of + all frames of the traceback of a trace, not only the most recent frame. + The cumulative mode can only be used with *key_type* equals to + ``'filename'`` and ``'lineno'``. + + The result is sorted from the biggest to the smallest by: + :attr:`Statistic.size`, :attr:`Statistic.count` and then by + :attr:`Statistic.traceback`. + + + .. attribute:: traceback_limit + + Maximum number of frames stored in the traceback of :attr:`traces`: + result of the :func:`get_traceback_limit` when the snapshot was taken. + + .. attribute:: traces + + Traces of all memory blocks allocated by Python: sequence of + :class:`Trace` instances. + + The sequence has an undefined order. Use the :meth:`Snapshot.statistics` + method to get a sorted list of statistics. + + +Statistic +^^^^^^^^^ + +.. class:: Statistic + + Statistic on memory allocations. + + :func:`Snapshot.statistics` returns a list of :class:`Statistic` instances. + + See also the :class:`StatisticDiff` class. + + .. attribute:: count + + Number of memory blocks (``int``). + + .. attribute:: size + + Total size of memory blocks in bytes (``int``). + + .. attribute:: traceback + + Traceback where the memory block was allocated, :class:`Traceback` + instance. + + +StatisticDiff +^^^^^^^^^^^^^ + +.. class:: StatisticDiff + + Statistic difference on memory allocations between an old and a new + :class:`Snapshot` instance. + + :func:`Snapshot.compare_to` returns a list of :class:`StatisticDiff` + instances. See also the :class:`Statistic` class. + + .. attribute:: count + + Number of memory blocks in the new snapshot (``int``): ``0`` if + the memory blocks have been released in the new snapshot. + + .. attribute:: count_diff + + Difference of number of memory blocks between the old and the new + snapshots (``int``): ``0`` if the memory blocks have been allocated in + the new snapshot. + + .. attribute:: size + + Total size of memory blocks in bytes in the new snapshot (``int``): + ``0`` if the memory blocks have been released in the new snapshot. + + .. attribute:: size_diff + + Difference of total size of memory blocks in bytes between the old and + the new snapshots (``int``): ``0`` if the memory blocks have been + allocated in the new snapshot. + + .. attribute:: traceback + + Traceback where the memory blocks were allocated, :class:`Traceback` + instance. + + +Trace +^^^^^ + +.. class:: Trace + + Trace of a memory block. + + The :attr:`Snapshot.traces` attribute is a sequence of :class:`Trace` + instances. + + .. versionchanged:: 3.6 + Added the :attr:`domain` attribute. + + .. attribute:: domain + + Address space of a memory block (``int``). Read-only property. + + tracemalloc uses the domain ``0`` to trace memory allocations made by + Python. C extensions can use other domains to trace other resources. + + .. attribute:: size + + Size of the memory block in bytes (``int``). + + .. attribute:: traceback + + Traceback where the memory block was allocated, :class:`Traceback` + instance. + + +Traceback +^^^^^^^^^ + +.. class:: Traceback + + Sequence of :class:`Frame` instances sorted from the oldest frame to the + most recent frame. + + A traceback contains at least ``1`` frame. If the ``tracemalloc`` module + failed to get a frame, the filename ``""`` at line number ``0`` is + used. + + When a snapshot is taken, tracebacks of traces are limited to + :func:`get_traceback_limit` frames. See the :func:`take_snapshot` function. + + The :attr:`Trace.traceback` attribute is an instance of :class:`Traceback` + instance. + + .. versionchanged:: 3.7 + Frames are now sorted from the oldest to the most recent, instead of most recent to oldest. + + .. method:: format(limit=None, most_recent_first=False) + + Format the traceback as a list of lines with newlines. Use the + :mod:`linecache` module to retrieve lines from the source code. + If *limit* is set, format the *limit* most recent frames if *limit* + is positive. Otherwise, format the ``abs(limit)`` oldest frames. + If *most_recent_first* is ``True``, the order of the formatted frames + is reversed, returning the most recent frame first instead of last. + + Similar to the :func:`traceback.format_tb` function, except that + :meth:`.format` does not include newlines. + + Example:: + + print("Traceback (most recent call first):") + for line in traceback: + print(line) + + Output:: + + Traceback (most recent call first): + File "test.py", line 9 + obj = Object() + File "test.py", line 12 + tb = tracemalloc.get_object_traceback(f()) diff --git a/python-3.7.4-docs-html/_sources/library/tty.rst.txt b/python-3.7.4-docs-html/_sources/library/tty.rst.txt new file mode 100644 index 0000000..b30bc3c --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/tty.rst.txt @@ -0,0 +1,41 @@ +:mod:`tty` --- Terminal control functions +========================================= + +.. module:: tty + :platform: Unix + :synopsis: Utility functions that perform common terminal control operations. + +.. moduleauthor:: Steen Lumholt +.. sectionauthor:: Moshe Zadka + +**Source code:** :source:`Lib/tty.py` + +-------------- + +The :mod:`tty` module defines functions for putting the tty into cbreak and raw +modes. + +Because it requires the :mod:`termios` module, it will work only on Unix. + +The :mod:`tty` module defines the following functions: + + +.. function:: setraw(fd, when=termios.TCSAFLUSH) + + Change the mode of the file descriptor *fd* to raw. If *when* is omitted, it + defaults to :const:`termios.TCSAFLUSH`, and is passed to + :func:`termios.tcsetattr`. + + +.. function:: setcbreak(fd, when=termios.TCSAFLUSH) + + Change the mode of file descriptor *fd* to cbreak. If *when* is omitted, it + defaults to :const:`termios.TCSAFLUSH`, and is passed to + :func:`termios.tcsetattr`. + + +.. seealso:: + + Module :mod:`termios` + Low-level terminal control interface. + diff --git a/python-3.7.4-docs-html/_sources/library/turtle.rst.txt b/python-3.7.4-docs-html/_sources/library/turtle.rst.txt new file mode 100644 index 0000000..5d7f060 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/turtle.rst.txt @@ -0,0 +1,2440 @@ +================================= +:mod:`turtle` --- Turtle graphics +================================= + +.. module:: turtle + :synopsis: An educational framework for simple graphics applications + +.. sectionauthor:: Gregor Lingl + +**Source code:** :source:`Lib/turtle.py` + +.. testsetup:: default + + from turtle import * + turtle = Turtle() + +-------------- + +Introduction +============ + +Turtle graphics is a popular way for introducing programming to kids. It was +part of the original Logo programming language developed by Wally Feurzeig, +Seymour Papert and Cynthia Solomon in 1967. + +Imagine a robotic turtle starting at (0, 0) in the x-y plane. After an ``import turtle``, give it the +command ``turtle.forward(15)``, and it moves (on-screen!) 15 pixels in the +direction it is facing, drawing a line as it moves. Give it the command +``turtle.right(25)``, and it rotates in-place 25 degrees clockwise. + +.. sidebar:: Turtle star + + Turtle can draw intricate shapes using programs that repeat simple + moves. + + .. image:: turtle-star.* + :align: center + + .. literalinclude:: ../includes/turtle-star.py + +By combining together these and similar commands, intricate shapes and pictures +can easily be drawn. + +The :mod:`turtle` module is an extended reimplementation of the same-named +module from the Python standard distribution up to version Python 2.5. + +It tries to keep the merits of the old turtle module and to be (nearly) 100% +compatible with it. This means in the first place to enable the learning +programmer to use all the commands, classes and methods interactively when using +the module from within IDLE run with the ``-n`` switch. + +The turtle module provides turtle graphics primitives, in both object-oriented +and procedure-oriented ways. Because it uses :mod:`tkinter` for the underlying +graphics, it needs a version of Python installed with Tk support. + +The object-oriented interface uses essentially two+two classes: + +1. The :class:`TurtleScreen` class defines graphics windows as a playground for + the drawing turtles. Its constructor needs a :class:`tkinter.Canvas` or a + :class:`ScrolledCanvas` as argument. It should be used when :mod:`turtle` is + used as part of some application. + + The function :func:`Screen` returns a singleton object of a + :class:`TurtleScreen` subclass. This function should be used when + :mod:`turtle` is used as a standalone tool for doing graphics. + As a singleton object, inheriting from its class is not possible. + + All methods of TurtleScreen/Screen also exist as functions, i.e. as part of + the procedure-oriented interface. + +2. :class:`RawTurtle` (alias: :class:`RawPen`) defines Turtle objects which draw + on a :class:`TurtleScreen`. Its constructor needs a Canvas, ScrolledCanvas + or TurtleScreen as argument, so the RawTurtle objects know where to draw. + + Derived from RawTurtle is the subclass :class:`Turtle` (alias: :class:`Pen`), + which draws on "the" :class:`Screen` instance which is automatically + created, if not already present. + + All methods of RawTurtle/Turtle also exist as functions, i.e. part of the + procedure-oriented interface. + +The procedural interface provides functions which are derived from the methods +of the classes :class:`Screen` and :class:`Turtle`. They have the same names as +the corresponding methods. A screen object is automatically created whenever a +function derived from a Screen method is called. An (unnamed) turtle object is +automatically created whenever any of the functions derived from a Turtle method +is called. + +To use multiple turtles on a screen one has to use the object-oriented interface. + +.. note:: + In the following documentation the argument list for functions is given. + Methods, of course, have the additional first argument *self* which is + omitted here. + + +Overview of available Turtle and Screen methods +================================================= + +Turtle methods +-------------- + +Turtle motion + Move and draw + | :func:`forward` | :func:`fd` + | :func:`backward` | :func:`bk` | :func:`back` + | :func:`right` | :func:`rt` + | :func:`left` | :func:`lt` + | :func:`goto` | :func:`setpos` | :func:`setposition` + | :func:`setx` + | :func:`sety` + | :func:`setheading` | :func:`seth` + | :func:`home` + | :func:`circle` + | :func:`dot` + | :func:`stamp` + | :func:`clearstamp` + | :func:`clearstamps` + | :func:`undo` + | :func:`speed` + + Tell Turtle's state + | :func:`position` | :func:`pos` + | :func:`towards` + | :func:`xcor` + | :func:`ycor` + | :func:`heading` + | :func:`distance` + + Setting and measurement + | :func:`degrees` + | :func:`radians` + +Pen control + Drawing state + | :func:`pendown` | :func:`pd` | :func:`down` + | :func:`penup` | :func:`pu` | :func:`up` + | :func:`pensize` | :func:`width` + | :func:`pen` + | :func:`isdown` + + Color control + | :func:`color` + | :func:`pencolor` + | :func:`fillcolor` + + Filling + | :func:`filling` + | :func:`begin_fill` + | :func:`end_fill` + + More drawing control + | :func:`reset` + | :func:`clear` + | :func:`write` + +Turtle state + Visibility + | :func:`showturtle` | :func:`st` + | :func:`hideturtle` | :func:`ht` + | :func:`isvisible` + + Appearance + | :func:`shape` + | :func:`resizemode` + | :func:`shapesize` | :func:`turtlesize` + | :func:`shearfactor` + | :func:`settiltangle` + | :func:`tiltangle` + | :func:`tilt` + | :func:`shapetransform` + | :func:`get_shapepoly` + +Using events + | :func:`onclick` + | :func:`onrelease` + | :func:`ondrag` + +Special Turtle methods + | :func:`begin_poly` + | :func:`end_poly` + | :func:`get_poly` + | :func:`clone` + | :func:`getturtle` | :func:`getpen` + | :func:`getscreen` + | :func:`setundobuffer` + | :func:`undobufferentries` + + +Methods of TurtleScreen/Screen +------------------------------ + +Window control + | :func:`bgcolor` + | :func:`bgpic` + | :func:`clear` | :func:`clearscreen` + | :func:`reset` | :func:`resetscreen` + | :func:`screensize` + | :func:`setworldcoordinates` + +Animation control + | :func:`delay` + | :func:`tracer` + | :func:`update` + +Using screen events + | :func:`listen` + | :func:`onkey` | :func:`onkeyrelease` + | :func:`onkeypress` + | :func:`onclick` | :func:`onscreenclick` + | :func:`ontimer` + | :func:`mainloop` | :func:`done` + +Settings and special methods + | :func:`mode` + | :func:`colormode` + | :func:`getcanvas` + | :func:`getshapes` + | :func:`register_shape` | :func:`addshape` + | :func:`turtles` + | :func:`window_height` + | :func:`window_width` + +Input methods + | :func:`textinput` + | :func:`numinput` + +Methods specific to Screen + | :func:`bye` + | :func:`exitonclick` + | :func:`setup` + | :func:`title` + + +Methods of RawTurtle/Turtle and corresponding functions +======================================================= + +Most of the examples in this section refer to a Turtle instance called +``turtle``. + +Turtle motion +------------- + +.. function:: forward(distance) + fd(distance) + + :param distance: a number (integer or float) + + Move the turtle forward by the specified *distance*, in the direction the + turtle is headed. + + .. doctest:: + + >>> turtle.position() + (0.00,0.00) + >>> turtle.forward(25) + >>> turtle.position() + (25.00,0.00) + >>> turtle.forward(-75) + >>> turtle.position() + (-50.00,0.00) + + +.. function:: back(distance) + bk(distance) + backward(distance) + + :param distance: a number + + Move the turtle backward by *distance*, opposite to the direction the + turtle is headed. Do not change the turtle's heading. + + .. doctest:: + :hide: + + >>> turtle.goto(0, 0) + + .. doctest:: + + >>> turtle.position() + (0.00,0.00) + >>> turtle.backward(30) + >>> turtle.position() + (-30.00,0.00) + + +.. function:: right(angle) + rt(angle) + + :param angle: a number (integer or float) + + Turn turtle right by *angle* units. (Units are by default degrees, but + can be set via the :func:`degrees` and :func:`radians` functions.) Angle + orientation depends on the turtle mode, see :func:`mode`. + + .. doctest:: + :hide: + + >>> turtle.setheading(22) + + .. doctest:: + + >>> turtle.heading() + 22.0 + >>> turtle.right(45) + >>> turtle.heading() + 337.0 + + +.. function:: left(angle) + lt(angle) + + :param angle: a number (integer or float) + + Turn turtle left by *angle* units. (Units are by default degrees, but + can be set via the :func:`degrees` and :func:`radians` functions.) Angle + orientation depends on the turtle mode, see :func:`mode`. + + .. doctest:: + :hide: + + >>> turtle.setheading(22) + + .. doctest:: + + >>> turtle.heading() + 22.0 + >>> turtle.left(45) + >>> turtle.heading() + 67.0 + + +.. function:: goto(x, y=None) + setpos(x, y=None) + setposition(x, y=None) + + :param x: a number or a pair/vector of numbers + :param y: a number or ``None`` + + If *y* is ``None``, *x* must be a pair of coordinates or a :class:`Vec2D` + (e.g. as returned by :func:`pos`). + + Move turtle to an absolute position. If the pen is down, draw line. Do + not change the turtle's orientation. + + .. doctest:: + :hide: + + >>> turtle.goto(0, 0) + + .. doctest:: + + >>> tp = turtle.pos() + >>> tp + (0.00,0.00) + >>> turtle.setpos(60,30) + >>> turtle.pos() + (60.00,30.00) + >>> turtle.setpos((20,80)) + >>> turtle.pos() + (20.00,80.00) + >>> turtle.setpos(tp) + >>> turtle.pos() + (0.00,0.00) + + +.. function:: setx(x) + + :param x: a number (integer or float) + + Set the turtle's first coordinate to *x*, leave second coordinate + unchanged. + + .. doctest:: + :hide: + + >>> turtle.goto(0, 240) + + .. doctest:: + + >>> turtle.position() + (0.00,240.00) + >>> turtle.setx(10) + >>> turtle.position() + (10.00,240.00) + + +.. function:: sety(y) + + :param y: a number (integer or float) + + Set the turtle's second coordinate to *y*, leave first coordinate unchanged. + + .. doctest:: + :hide: + + >>> turtle.goto(0, 40) + + .. doctest:: + + >>> turtle.position() + (0.00,40.00) + >>> turtle.sety(-10) + >>> turtle.position() + (0.00,-10.00) + + +.. function:: setheading(to_angle) + seth(to_angle) + + :param to_angle: a number (integer or float) + + Set the orientation of the turtle to *to_angle*. Here are some common + directions in degrees: + + =================== ==================== + standard mode logo mode + =================== ==================== + 0 - east 0 - north + 90 - north 90 - east + 180 - west 180 - south + 270 - south 270 - west + =================== ==================== + + .. doctest:: + + >>> turtle.setheading(90) + >>> turtle.heading() + 90.0 + + +.. function:: home() + + Move turtle to the origin -- coordinates (0,0) -- and set its heading to + its start-orientation (which depends on the mode, see :func:`mode`). + + .. doctest:: + :hide: + + >>> turtle.setheading(90) + >>> turtle.goto(0, -10) + + .. doctest:: + + >>> turtle.heading() + 90.0 + >>> turtle.position() + (0.00,-10.00) + >>> turtle.home() + >>> turtle.position() + (0.00,0.00) + >>> turtle.heading() + 0.0 + + +.. function:: circle(radius, extent=None, steps=None) + + :param radius: a number + :param extent: a number (or ``None``) + :param steps: an integer (or ``None``) + + Draw a circle with given *radius*. The center is *radius* units left of + the turtle; *extent* -- an angle -- determines which part of the circle + is drawn. If *extent* is not given, draw the entire circle. If *extent* + is not a full circle, one endpoint of the arc is the current pen + position. Draw the arc in counterclockwise direction if *radius* is + positive, otherwise in clockwise direction. Finally the direction of the + turtle is changed by the amount of *extent*. + + As the circle is approximated by an inscribed regular polygon, *steps* + determines the number of steps to use. If not given, it will be + calculated automatically. May be used to draw regular polygons. + + .. doctest:: + + >>> turtle.home() + >>> turtle.position() + (0.00,0.00) + >>> turtle.heading() + 0.0 + >>> turtle.circle(50) + >>> turtle.position() + (-0.00,0.00) + >>> turtle.heading() + 0.0 + >>> turtle.circle(120, 180) # draw a semicircle + >>> turtle.position() + (0.00,240.00) + >>> turtle.heading() + 180.0 + + +.. function:: dot(size=None, *color) + + :param size: an integer >= 1 (if given) + :param color: a colorstring or a numeric color tuple + + Draw a circular dot with diameter *size*, using *color*. If *size* is + not given, the maximum of pensize+4 and 2*pensize is used. + + + .. doctest:: + + >>> turtle.home() + >>> turtle.dot() + >>> turtle.fd(50); turtle.dot(20, "blue"); turtle.fd(50) + >>> turtle.position() + (100.00,-0.00) + >>> turtle.heading() + 0.0 + + +.. function:: stamp() + + Stamp a copy of the turtle shape onto the canvas at the current turtle + position. Return a stamp_id for that stamp, which can be used to delete + it by calling ``clearstamp(stamp_id)``. + + .. doctest:: + + >>> turtle.color("blue") + >>> turtle.stamp() + 11 + >>> turtle.fd(50) + + +.. function:: clearstamp(stampid) + + :param stampid: an integer, must be return value of previous + :func:`stamp` call + + Delete stamp with given *stampid*. + + .. doctest:: + + >>> turtle.position() + (150.00,-0.00) + >>> turtle.color("blue") + >>> astamp = turtle.stamp() + >>> turtle.fd(50) + >>> turtle.position() + (200.00,-0.00) + >>> turtle.clearstamp(astamp) + >>> turtle.position() + (200.00,-0.00) + + +.. function:: clearstamps(n=None) + + :param n: an integer (or ``None``) + + Delete all or first/last *n* of turtle's stamps. If *n* is ``None``, delete + all stamps, if *n* > 0 delete first *n* stamps, else if *n* < 0 delete + last *n* stamps. + + .. doctest:: + + >>> for i in range(8): + ... turtle.stamp(); turtle.fd(30) + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + >>> turtle.clearstamps(2) + >>> turtle.clearstamps(-2) + >>> turtle.clearstamps() + + +.. function:: undo() + + Undo (repeatedly) the last turtle action(s). Number of available + undo actions is determined by the size of the undobuffer. + + .. doctest:: + + >>> for i in range(4): + ... turtle.fd(50); turtle.lt(80) + ... + >>> for i in range(8): + ... turtle.undo() + + +.. function:: speed(speed=None) + + :param speed: an integer in the range 0..10 or a speedstring (see below) + + Set the turtle's speed to an integer value in the range 0..10. If no + argument is given, return current speed. + + If input is a number greater than 10 or smaller than 0.5, speed is set + to 0. Speedstrings are mapped to speedvalues as follows: + + * "fastest": 0 + * "fast": 10 + * "normal": 6 + * "slow": 3 + * "slowest": 1 + + Speeds from 1 to 10 enforce increasingly faster animation of line drawing + and turtle turning. + + Attention: *speed* = 0 means that *no* animation takes + place. forward/back makes turtle jump and likewise left/right make the + turtle turn instantly. + + .. doctest:: + + >>> turtle.speed() + 3 + >>> turtle.speed('normal') + >>> turtle.speed() + 6 + >>> turtle.speed(9) + >>> turtle.speed() + 9 + + +Tell Turtle's state +------------------- + +.. function:: position() + pos() + + Return the turtle's current location (x,y) (as a :class:`Vec2D` vector). + + .. doctest:: + + >>> turtle.pos() + (440.00,-0.00) + + +.. function:: towards(x, y=None) + + :param x: a number or a pair/vector of numbers or a turtle instance + :param y: a number if *x* is a number, else ``None`` + + Return the angle between the line from turtle position to position specified + by (x,y), the vector or the other turtle. This depends on the turtle's start + orientation which depends on the mode - "standard"/"world" or "logo"). + + .. doctest:: + + >>> turtle.goto(10, 10) + >>> turtle.towards(0,0) + 225.0 + + +.. function:: xcor() + + Return the turtle's x coordinate. + + .. doctest:: + + >>> turtle.home() + >>> turtle.left(50) + >>> turtle.forward(100) + >>> turtle.pos() + (64.28,76.60) + >>> print(round(turtle.xcor(), 5)) + 64.27876 + + +.. function:: ycor() + + Return the turtle's y coordinate. + + .. doctest:: + + >>> turtle.home() + >>> turtle.left(60) + >>> turtle.forward(100) + >>> print(turtle.pos()) + (50.00,86.60) + >>> print(round(turtle.ycor(), 5)) + 86.60254 + + +.. function:: heading() + + Return the turtle's current heading (value depends on the turtle mode, see + :func:`mode`). + + .. doctest:: + + >>> turtle.home() + >>> turtle.left(67) + >>> turtle.heading() + 67.0 + + +.. function:: distance(x, y=None) + + :param x: a number or a pair/vector of numbers or a turtle instance + :param y: a number if *x* is a number, else ``None`` + + Return the distance from the turtle to (x,y), the given vector, or the given + other turtle, in turtle step units. + + .. doctest:: + + >>> turtle.home() + >>> turtle.distance(30,40) + 50.0 + >>> turtle.distance((30,40)) + 50.0 + >>> joe = Turtle() + >>> joe.forward(77) + >>> turtle.distance(joe) + 77.0 + + +Settings for measurement +------------------------ + +.. function:: degrees(fullcircle=360.0) + + :param fullcircle: a number + + Set angle measurement units, i.e. set number of "degrees" for a full circle. + Default value is 360 degrees. + + .. doctest:: + + >>> turtle.home() + >>> turtle.left(90) + >>> turtle.heading() + 90.0 + + Change angle measurement unit to grad (also known as gon, + grade, or gradian and equals 1/100-th of the right angle.) + >>> turtle.degrees(400.0) + >>> turtle.heading() + 100.0 + >>> turtle.degrees(360) + >>> turtle.heading() + 90.0 + + +.. function:: radians() + + Set the angle measurement units to radians. Equivalent to + ``degrees(2*math.pi)``. + + .. doctest:: + + >>> turtle.home() + >>> turtle.left(90) + >>> turtle.heading() + 90.0 + >>> turtle.radians() + >>> turtle.heading() + 1.5707963267948966 + + .. doctest:: + :hide: + + >>> turtle.degrees(360) + + +Pen control +----------- + +Drawing state +~~~~~~~~~~~~~ + +.. function:: pendown() + pd() + down() + + Pull the pen down -- drawing when moving. + + +.. function:: penup() + pu() + up() + + Pull the pen up -- no drawing when moving. + + +.. function:: pensize(width=None) + width(width=None) + + :param width: a positive number + + Set the line thickness to *width* or return it. If resizemode is set to + "auto" and turtleshape is a polygon, that polygon is drawn with the same line + thickness. If no argument is given, the current pensize is returned. + + .. doctest:: + + >>> turtle.pensize() + 1 + >>> turtle.pensize(10) # from here on lines of width 10 are drawn + + +.. function:: pen(pen=None, **pendict) + + :param pen: a dictionary with some or all of the below listed keys + :param pendict: one or more keyword-arguments with the below listed keys as keywords + + Return or set the pen's attributes in a "pen-dictionary" with the following + key/value pairs: + + * "shown": True/False + * "pendown": True/False + * "pencolor": color-string or color-tuple + * "fillcolor": color-string or color-tuple + * "pensize": positive number + * "speed": number in range 0..10 + * "resizemode": "auto" or "user" or "noresize" + * "stretchfactor": (positive number, positive number) + * "outline": positive number + * "tilt": number + + This dictionary can be used as argument for a subsequent call to :func:`pen` + to restore the former pen-state. Moreover one or more of these attributes + can be provided as keyword-arguments. This can be used to set several pen + attributes in one statement. + + .. doctest:: + :options: +NORMALIZE_WHITESPACE + + >>> turtle.pen(fillcolor="black", pencolor="red", pensize=10) + >>> sorted(turtle.pen().items()) + [('fillcolor', 'black'), ('outline', 1), ('pencolor', 'red'), + ('pendown', True), ('pensize', 10), ('resizemode', 'noresize'), + ('shearfactor', 0.0), ('shown', True), ('speed', 9), + ('stretchfactor', (1.0, 1.0)), ('tilt', 0.0)] + >>> penstate=turtle.pen() + >>> turtle.color("yellow", "") + >>> turtle.penup() + >>> sorted(turtle.pen().items())[:3] + [('fillcolor', ''), ('outline', 1), ('pencolor', 'yellow')] + >>> turtle.pen(penstate, fillcolor="green") + >>> sorted(turtle.pen().items())[:3] + [('fillcolor', 'green'), ('outline', 1), ('pencolor', 'red')] + +.. function:: isdown() + + Return ``True`` if pen is down, ``False`` if it's up. + + .. doctest:: + + >>> turtle.penup() + >>> turtle.isdown() + False + >>> turtle.pendown() + >>> turtle.isdown() + True + + +Color control +~~~~~~~~~~~~~ + +.. function:: pencolor(*args) + + Return or set the pencolor. + + Four input formats are allowed: + + ``pencolor()`` + Return the current pencolor as color specification string or + as a tuple (see example). May be used as input to another + color/pencolor/fillcolor call. + + ``pencolor(colorstring)`` + Set pencolor to *colorstring*, which is a Tk color specification string, + such as ``"red"``, ``"yellow"``, or ``"#33cc8c"``. + + ``pencolor((r, g, b))`` + Set pencolor to the RGB color represented by the tuple of *r*, *g*, and + *b*. Each of *r*, *g*, and *b* must be in the range 0..colormode, where + colormode is either 1.0 or 255 (see :func:`colormode`). + + ``pencolor(r, g, b)`` + Set pencolor to the RGB color represented by *r*, *g*, and *b*. Each of + *r*, *g*, and *b* must be in the range 0..colormode. + + If turtleshape is a polygon, the outline of that polygon is drawn with the + newly set pencolor. + + .. doctest:: + + >>> colormode() + 1.0 + >>> turtle.pencolor() + 'red' + >>> turtle.pencolor("brown") + >>> turtle.pencolor() + 'brown' + >>> tup = (0.2, 0.8, 0.55) + >>> turtle.pencolor(tup) + >>> turtle.pencolor() + (0.2, 0.8, 0.5490196078431373) + >>> colormode(255) + >>> turtle.pencolor() + (51.0, 204.0, 140.0) + >>> turtle.pencolor('#32c18f') + >>> turtle.pencolor() + (50.0, 193.0, 143.0) + + +.. function:: fillcolor(*args) + + Return or set the fillcolor. + + Four input formats are allowed: + + ``fillcolor()`` + Return the current fillcolor as color specification string, possibly + in tuple format (see example). May be used as input to another + color/pencolor/fillcolor call. + + ``fillcolor(colorstring)`` + Set fillcolor to *colorstring*, which is a Tk color specification string, + such as ``"red"``, ``"yellow"``, or ``"#33cc8c"``. + + ``fillcolor((r, g, b))`` + Set fillcolor to the RGB color represented by the tuple of *r*, *g*, and + *b*. Each of *r*, *g*, and *b* must be in the range 0..colormode, where + colormode is either 1.0 or 255 (see :func:`colormode`). + + ``fillcolor(r, g, b)`` + Set fillcolor to the RGB color represented by *r*, *g*, and *b*. Each of + *r*, *g*, and *b* must be in the range 0..colormode. + + If turtleshape is a polygon, the interior of that polygon is drawn + with the newly set fillcolor. + + .. doctest:: + + >>> turtle.fillcolor("violet") + >>> turtle.fillcolor() + 'violet' + >>> turtle.pencolor() + (50.0, 193.0, 143.0) + >>> turtle.fillcolor((50, 193, 143)) # Integers, not floats + >>> turtle.fillcolor() + (50.0, 193.0, 143.0) + >>> turtle.fillcolor('#ffffff') + >>> turtle.fillcolor() + (255.0, 255.0, 255.0) + + +.. function:: color(*args) + + Return or set pencolor and fillcolor. + + Several input formats are allowed. They use 0 to 3 arguments as + follows: + + ``color()`` + Return the current pencolor and the current fillcolor as a pair of color + specification strings or tuples as returned by :func:`pencolor` and + :func:`fillcolor`. + + ``color(colorstring)``, ``color((r,g,b))``, ``color(r,g,b)`` + Inputs as in :func:`pencolor`, set both, fillcolor and pencolor, to the + given value. + + ``color(colorstring1, colorstring2)``, ``color((r1,g1,b1), (r2,g2,b2))`` + Equivalent to ``pencolor(colorstring1)`` and ``fillcolor(colorstring2)`` + and analogously if the other input format is used. + + If turtleshape is a polygon, outline and interior of that polygon is drawn + with the newly set colors. + + .. doctest:: + + >>> turtle.color("red", "green") + >>> turtle.color() + ('red', 'green') + >>> color("#285078", "#a0c8f0") + >>> color() + ((40.0, 80.0, 120.0), (160.0, 200.0, 240.0)) + + +See also: Screen method :func:`colormode`. + + +Filling +~~~~~~~ + +.. doctest:: + :hide: + + >>> turtle.home() + +.. function:: filling() + + Return fillstate (``True`` if filling, ``False`` else). + + .. doctest:: + + >>> turtle.begin_fill() + >>> if turtle.filling(): + ... turtle.pensize(5) + ... else: + ... turtle.pensize(3) + + + +.. function:: begin_fill() + + To be called just before drawing a shape to be filled. + + +.. function:: end_fill() + + Fill the shape drawn after the last call to :func:`begin_fill`. + + .. doctest:: + + >>> turtle.color("black", "red") + >>> turtle.begin_fill() + >>> turtle.circle(80) + >>> turtle.end_fill() + + +More drawing control +~~~~~~~~~~~~~~~~~~~~ + +.. function:: reset() + + Delete the turtle's drawings from the screen, re-center the turtle and set + variables to the default values. + + .. doctest:: + + >>> turtle.goto(0,-22) + >>> turtle.left(100) + >>> turtle.position() + (0.00,-22.00) + >>> turtle.heading() + 100.0 + >>> turtle.reset() + >>> turtle.position() + (0.00,0.00) + >>> turtle.heading() + 0.0 + + +.. function:: clear() + + Delete the turtle's drawings from the screen. Do not move turtle. State and + position of the turtle as well as drawings of other turtles are not affected. + + +.. function:: write(arg, move=False, align="left", font=("Arial", 8, "normal")) + + :param arg: object to be written to the TurtleScreen + :param move: True/False + :param align: one of the strings "left", "center" or right" + :param font: a triple (fontname, fontsize, fonttype) + + Write text - the string representation of *arg* - at the current turtle + position according to *align* ("left", "center" or right") and with the given + font. If *move* is true, the pen is moved to the bottom-right corner of the + text. By default, *move* is ``False``. + + >>> turtle.write("Home = ", True, align="center") + >>> turtle.write((0,0), True) + + +Turtle state +------------ + +Visibility +~~~~~~~~~~ + +.. function:: hideturtle() + ht() + + Make the turtle invisible. It's a good idea to do this while you're in the + middle of doing some complex drawing, because hiding the turtle speeds up the + drawing observably. + + .. doctest:: + + >>> turtle.hideturtle() + + +.. function:: showturtle() + st() + + Make the turtle visible. + + .. doctest:: + + >>> turtle.showturtle() + + +.. function:: isvisible() + + Return ``True`` if the Turtle is shown, ``False`` if it's hidden. + + >>> turtle.hideturtle() + >>> turtle.isvisible() + False + >>> turtle.showturtle() + >>> turtle.isvisible() + True + + +Appearance +~~~~~~~~~~ + +.. function:: shape(name=None) + + :param name: a string which is a valid shapename + + Set turtle shape to shape with given *name* or, if name is not given, return + name of current shape. Shape with *name* must exist in the TurtleScreen's + shape dictionary. Initially there are the following polygon shapes: "arrow", + "turtle", "circle", "square", "triangle", "classic". To learn about how to + deal with shapes see Screen method :func:`register_shape`. + + .. doctest:: + + >>> turtle.shape() + 'classic' + >>> turtle.shape("turtle") + >>> turtle.shape() + 'turtle' + + +.. function:: resizemode(rmode=None) + + :param rmode: one of the strings "auto", "user", "noresize" + + Set resizemode to one of the values: "auto", "user", "noresize". If *rmode* + is not given, return current resizemode. Different resizemodes have the + following effects: + + - "auto": adapts the appearance of the turtle corresponding to the value of pensize. + - "user": adapts the appearance of the turtle according to the values of + stretchfactor and outlinewidth (outline), which are set by + :func:`shapesize`. + - "noresize": no adaption of the turtle's appearance takes place. + + resizemode("user") is called by :func:`shapesize` when used with arguments. + + .. doctest:: + + >>> turtle.resizemode() + 'noresize' + >>> turtle.resizemode("auto") + >>> turtle.resizemode() + 'auto' + + +.. function:: shapesize(stretch_wid=None, stretch_len=None, outline=None) + turtlesize(stretch_wid=None, stretch_len=None, outline=None) + + :param stretch_wid: positive number + :param stretch_len: positive number + :param outline: positive number + + Return or set the pen's attributes x/y-stretchfactors and/or outline. Set + resizemode to "user". If and only if resizemode is set to "user", the turtle + will be displayed stretched according to its stretchfactors: *stretch_wid* is + stretchfactor perpendicular to its orientation, *stretch_len* is + stretchfactor in direction of its orientation, *outline* determines the width + of the shapes's outline. + + .. doctest:: + + >>> turtle.shapesize() + (1.0, 1.0, 1) + >>> turtle.resizemode("user") + >>> turtle.shapesize(5, 5, 12) + >>> turtle.shapesize() + (5, 5, 12) + >>> turtle.shapesize(outline=8) + >>> turtle.shapesize() + (5, 5, 8) + + +.. function:: shearfactor(shear=None) + + :param shear: number (optional) + + Set or return the current shearfactor. Shear the turtleshape according to + the given shearfactor shear, which is the tangent of the shear angle. + Do *not* change the turtle's heading (direction of movement). + If shear is not given: return the current shearfactor, i. e. the + tangent of the shear angle, by which lines parallel to the + heading of the turtle are sheared. + + .. doctest:: + + >>> turtle.shape("circle") + >>> turtle.shapesize(5,2) + >>> turtle.shearfactor(0.5) + >>> turtle.shearfactor() + 0.5 + + +.. function:: tilt(angle) + + :param angle: a number + + Rotate the turtleshape by *angle* from its current tilt-angle, but do *not* + change the turtle's heading (direction of movement). + + .. doctest:: + + >>> turtle.reset() + >>> turtle.shape("circle") + >>> turtle.shapesize(5,2) + >>> turtle.tilt(30) + >>> turtle.fd(50) + >>> turtle.tilt(30) + >>> turtle.fd(50) + + +.. function:: settiltangle(angle) + + :param angle: a number + + Rotate the turtleshape to point in the direction specified by *angle*, + regardless of its current tilt-angle. *Do not* change the turtle's heading + (direction of movement). + + .. doctest:: + + >>> turtle.reset() + >>> turtle.shape("circle") + >>> turtle.shapesize(5,2) + >>> turtle.settiltangle(45) + >>> turtle.fd(50) + >>> turtle.settiltangle(-45) + >>> turtle.fd(50) + + .. deprecated:: 3.1 + + +.. function:: tiltangle(angle=None) + + :param angle: a number (optional) + + Set or return the current tilt-angle. If angle is given, rotate the + turtleshape to point in the direction specified by angle, + regardless of its current tilt-angle. Do *not* change the turtle's + heading (direction of movement). + If angle is not given: return the current tilt-angle, i. e. the angle + between the orientation of the turtleshape and the heading of the + turtle (its direction of movement). + + .. doctest:: + + >>> turtle.reset() + >>> turtle.shape("circle") + >>> turtle.shapesize(5,2) + >>> turtle.tilt(45) + >>> turtle.tiltangle() + 45.0 + + +.. function:: shapetransform(t11=None, t12=None, t21=None, t22=None) + + :param t11: a number (optional) + :param t12: a number (optional) + :param t21: a number (optional) + :param t12: a number (optional) + + Set or return the current transformation matrix of the turtle shape. + + If none of the matrix elements are given, return the transformation + matrix as a tuple of 4 elements. + Otherwise set the given elements and transform the turtleshape + according to the matrix consisting of first row t11, t12 and + second row t21, 22. The determinant t11 * t22 - t12 * t21 must not be + zero, otherwise an error is raised. + Modify stretchfactor, shearfactor and tiltangle according to the + given matrix. + + .. doctest:: + + >>> turtle = Turtle() + >>> turtle.shape("square") + >>> turtle.shapesize(4,2) + >>> turtle.shearfactor(-0.5) + >>> turtle.shapetransform() + (4.0, -1.0, -0.0, 2.0) + + +.. function:: get_shapepoly() + + Return the current shape polygon as tuple of coordinate pairs. This + can be used to define a new shape or components of a compound shape. + + .. doctest:: + + >>> turtle.shape("square") + >>> turtle.shapetransform(4, -1, 0, 2) + >>> turtle.get_shapepoly() + ((50, -20), (30, 20), (-50, 20), (-30, -20)) + + +Using events +------------ + +.. function:: onclick(fun, btn=1, add=None) + + :param fun: a function with two arguments which will be called with the + coordinates of the clicked point on the canvas + :param btn: number of the mouse-button, defaults to 1 (left mouse button) + :param add: ``True`` or ``False`` -- if ``True``, a new binding will be + added, otherwise it will replace a former binding + + Bind *fun* to mouse-click events on this turtle. If *fun* is ``None``, + existing bindings are removed. Example for the anonymous turtle, i.e. the + procedural way: + + .. doctest:: + + >>> def turn(x, y): + ... left(180) + ... + >>> onclick(turn) # Now clicking into the turtle will turn it. + >>> onclick(None) # event-binding will be removed + + +.. function:: onrelease(fun, btn=1, add=None) + + :param fun: a function with two arguments which will be called with the + coordinates of the clicked point on the canvas + :param btn: number of the mouse-button, defaults to 1 (left mouse button) + :param add: ``True`` or ``False`` -- if ``True``, a new binding will be + added, otherwise it will replace a former binding + + Bind *fun* to mouse-button-release events on this turtle. If *fun* is + ``None``, existing bindings are removed. + + .. doctest:: + + >>> class MyTurtle(Turtle): + ... def glow(self,x,y): + ... self.fillcolor("red") + ... def unglow(self,x,y): + ... self.fillcolor("") + ... + >>> turtle = MyTurtle() + >>> turtle.onclick(turtle.glow) # clicking on turtle turns fillcolor red, + >>> turtle.onrelease(turtle.unglow) # releasing turns it to transparent. + + +.. function:: ondrag(fun, btn=1, add=None) + + :param fun: a function with two arguments which will be called with the + coordinates of the clicked point on the canvas + :param btn: number of the mouse-button, defaults to 1 (left mouse button) + :param add: ``True`` or ``False`` -- if ``True``, a new binding will be + added, otherwise it will replace a former binding + + Bind *fun* to mouse-move events on this turtle. If *fun* is ``None``, + existing bindings are removed. + + Remark: Every sequence of mouse-move-events on a turtle is preceded by a + mouse-click event on that turtle. + + .. doctest:: + + >>> turtle.ondrag(turtle.goto) + + Subsequently, clicking and dragging the Turtle will move it across + the screen thereby producing handdrawings (if pen is down). + + +Special Turtle methods +---------------------- + +.. function:: begin_poly() + + Start recording the vertices of a polygon. Current turtle position is first + vertex of polygon. + + +.. function:: end_poly() + + Stop recording the vertices of a polygon. Current turtle position is last + vertex of polygon. This will be connected with the first vertex. + + +.. function:: get_poly() + + Return the last recorded polygon. + + .. doctest:: + + >>> turtle.home() + >>> turtle.begin_poly() + >>> turtle.fd(100) + >>> turtle.left(20) + >>> turtle.fd(30) + >>> turtle.left(60) + >>> turtle.fd(50) + >>> turtle.end_poly() + >>> p = turtle.get_poly() + >>> register_shape("myFavouriteShape", p) + + +.. function:: clone() + + Create and return a clone of the turtle with same position, heading and + turtle properties. + + .. doctest:: + + >>> mick = Turtle() + >>> joe = mick.clone() + + +.. function:: getturtle() + getpen() + + Return the Turtle object itself. Only reasonable use: as a function to + return the "anonymous turtle": + + .. doctest:: + + >>> pet = getturtle() + >>> pet.fd(50) + >>> pet + + + +.. function:: getscreen() + + Return the :class:`TurtleScreen` object the turtle is drawing on. + TurtleScreen methods can then be called for that object. + + .. doctest:: + + >>> ts = turtle.getscreen() + >>> ts + + >>> ts.bgcolor("pink") + + +.. function:: setundobuffer(size) + + :param size: an integer or ``None`` + + Set or disable undobuffer. If *size* is an integer an empty undobuffer of + given size is installed. *size* gives the maximum number of turtle actions + that can be undone by the :func:`undo` method/function. If *size* is + ``None``, the undobuffer is disabled. + + .. doctest:: + + >>> turtle.setundobuffer(42) + + +.. function:: undobufferentries() + + Return number of entries in the undobuffer. + + .. doctest:: + + >>> while undobufferentries(): + ... undo() + + + +.. _compoundshapes: + +Compound shapes +--------------- + +To use compound turtle shapes, which consist of several polygons of different +color, you must use the helper class :class:`Shape` explicitly as described +below: + +1. Create an empty Shape object of type "compound". +2. Add as many components to this object as desired, using the + :meth:`addcomponent` method. + + For example: + + .. doctest:: + + >>> s = Shape("compound") + >>> poly1 = ((0,0),(10,-5),(0,10),(-10,-5)) + >>> s.addcomponent(poly1, "red", "blue") + >>> poly2 = ((0,0),(10,-5),(-10,-5)) + >>> s.addcomponent(poly2, "blue", "red") + +3. Now add the Shape to the Screen's shapelist and use it: + + .. doctest:: + + >>> register_shape("myshape", s) + >>> shape("myshape") + + +.. note:: + + The :class:`Shape` class is used internally by the :func:`register_shape` + method in different ways. The application programmer has to deal with the + Shape class *only* when using compound shapes like shown above! + + +Methods of TurtleScreen/Screen and corresponding functions +========================================================== + +Most of the examples in this section refer to a TurtleScreen instance called +``screen``. + +.. doctest:: + :hide: + + >>> screen = Screen() + +Window control +-------------- + +.. function:: bgcolor(*args) + + :param args: a color string or three numbers in the range 0..colormode or a + 3-tuple of such numbers + + + Set or return background color of the TurtleScreen. + + .. doctest:: + + >>> screen.bgcolor("orange") + >>> screen.bgcolor() + 'orange' + >>> screen.bgcolor("#800080") + >>> screen.bgcolor() + (128.0, 0.0, 128.0) + + +.. function:: bgpic(picname=None) + + :param picname: a string, name of a gif-file or ``"nopic"``, or ``None`` + + Set background image or return name of current backgroundimage. If *picname* + is a filename, set the corresponding image as background. If *picname* is + ``"nopic"``, delete background image, if present. If *picname* is ``None``, + return the filename of the current backgroundimage. :: + + >>> screen.bgpic() + 'nopic' + >>> screen.bgpic("landscape.gif") + >>> screen.bgpic() + "landscape.gif" + + +.. function:: clear() + clearscreen() + + Delete all drawings and all turtles from the TurtleScreen. Reset the now + empty TurtleScreen to its initial state: white background, no background + image, no event bindings and tracing on. + + .. note:: + This TurtleScreen method is available as a global function only under the + name ``clearscreen``. The global function ``clear`` is a different one + derived from the Turtle method ``clear``. + + +.. function:: reset() + resetscreen() + + Reset all Turtles on the Screen to their initial state. + + .. note:: + This TurtleScreen method is available as a global function only under the + name ``resetscreen``. The global function ``reset`` is another one + derived from the Turtle method ``reset``. + + +.. function:: screensize(canvwidth=None, canvheight=None, bg=None) + + :param canvwidth: positive integer, new width of canvas in pixels + :param canvheight: positive integer, new height of canvas in pixels + :param bg: colorstring or color-tuple, new background color + + If no arguments are given, return current (canvaswidth, canvasheight). Else + resize the canvas the turtles are drawing on. Do not alter the drawing + window. To observe hidden parts of the canvas, use the scrollbars. With this + method, one can make visible those parts of a drawing which were outside the + canvas before. + + >>> screen.screensize() + (400, 300) + >>> screen.screensize(2000,1500) + >>> screen.screensize() + (2000, 1500) + + e.g. to search for an erroneously escaped turtle ;-) + + +.. function:: setworldcoordinates(llx, lly, urx, ury) + + :param llx: a number, x-coordinate of lower left corner of canvas + :param lly: a number, y-coordinate of lower left corner of canvas + :param urx: a number, x-coordinate of upper right corner of canvas + :param ury: a number, y-coordinate of upper right corner of canvas + + Set up user-defined coordinate system and switch to mode "world" if + necessary. This performs a ``screen.reset()``. If mode "world" is already + active, all drawings are redrawn according to the new coordinates. + + **ATTENTION**: in user-defined coordinate systems angles may appear + distorted. + + .. doctest:: + + >>> screen.reset() + >>> screen.setworldcoordinates(-50,-7.5,50,7.5) + >>> for _ in range(72): + ... left(10) + ... + >>> for _ in range(8): + ... left(45); fd(2) # a regular octagon + + .. doctest:: + :hide: + + >>> screen.reset() + >>> for t in turtles(): + ... t.reset() + + +Animation control +----------------- + +.. function:: delay(delay=None) + + :param delay: positive integer + + Set or return the drawing *delay* in milliseconds. (This is approximately + the time interval between two consecutive canvas updates.) The longer the + drawing delay, the slower the animation. + + Optional argument: + + .. doctest:: + + >>> screen.delay() + 10 + >>> screen.delay(5) + >>> screen.delay() + 5 + + +.. function:: tracer(n=None, delay=None) + + :param n: nonnegative integer + :param delay: nonnegative integer + + Turn turtle animation on/off and set delay for update drawings. If + *n* is given, only each n-th regular screen update is really + performed. (Can be used to accelerate the drawing of complex + graphics.) When called without arguments, returns the currently + stored value of n. Second argument sets delay value (see + :func:`delay`). + + .. doctest:: + + >>> screen.tracer(8, 25) + >>> dist = 2 + >>> for i in range(200): + ... fd(dist) + ... rt(90) + ... dist += 2 + + +.. function:: update() + + Perform a TurtleScreen update. To be used when tracer is turned off. + +See also the RawTurtle/Turtle method :func:`speed`. + + +Using screen events +------------------- + +.. function:: listen(xdummy=None, ydummy=None) + + Set focus on TurtleScreen (in order to collect key-events). Dummy arguments + are provided in order to be able to pass :func:`listen` to the onclick method. + + +.. function:: onkey(fun, key) + onkeyrelease(fun, key) + + :param fun: a function with no arguments or ``None`` + :param key: a string: key (e.g. "a") or key-symbol (e.g. "space") + + Bind *fun* to key-release event of key. If *fun* is ``None``, event bindings + are removed. Remark: in order to be able to register key-events, TurtleScreen + must have the focus. (See method :func:`listen`.) + + .. doctest:: + + >>> def f(): + ... fd(50) + ... lt(60) + ... + >>> screen.onkey(f, "Up") + >>> screen.listen() + + +.. function:: onkeypress(fun, key=None) + + :param fun: a function with no arguments or ``None`` + :param key: a string: key (e.g. "a") or key-symbol (e.g. "space") + + Bind *fun* to key-press event of key if key is given, + or to any key-press-event if no key is given. + Remark: in order to be able to register key-events, TurtleScreen + must have focus. (See method :func:`listen`.) + + .. doctest:: + + >>> def f(): + ... fd(50) + ... + >>> screen.onkey(f, "Up") + >>> screen.listen() + + +.. function:: onclick(fun, btn=1, add=None) + onscreenclick(fun, btn=1, add=None) + + :param fun: a function with two arguments which will be called with the + coordinates of the clicked point on the canvas + :param btn: number of the mouse-button, defaults to 1 (left mouse button) + :param add: ``True`` or ``False`` -- if ``True``, a new binding will be + added, otherwise it will replace a former binding + + Bind *fun* to mouse-click events on this screen. If *fun* is ``None``, + existing bindings are removed. + + Example for a TurtleScreen instance named ``screen`` and a Turtle instance + named turtle: + + .. doctest:: + + >>> screen.onclick(turtle.goto) # Subsequently clicking into the TurtleScreen will + >>> # make the turtle move to the clicked point. + >>> screen.onclick(None) # remove event binding again + + .. note:: + This TurtleScreen method is available as a global function only under the + name ``onscreenclick``. The global function ``onclick`` is another one + derived from the Turtle method ``onclick``. + + +.. function:: ontimer(fun, t=0) + + :param fun: a function with no arguments + :param t: a number >= 0 + + Install a timer that calls *fun* after *t* milliseconds. + + .. doctest:: + + >>> running = True + >>> def f(): + ... if running: + ... fd(50) + ... lt(60) + ... screen.ontimer(f, 250) + >>> f() ### makes the turtle march around + >>> running = False + + +.. function:: mainloop() + done() + + Starts event loop - calling Tkinter's mainloop function. + Must be the last statement in a turtle graphics program. + Must *not* be used if a script is run from within IDLE in -n mode + (No subprocess) - for interactive use of turtle graphics. :: + + >>> screen.mainloop() + + +Input methods +------------- + +.. function:: textinput(title, prompt) + + :param title: string + :param prompt: string + + Pop up a dialog window for input of a string. Parameter title is + the title of the dialog window, prompt is a text mostly describing + what information to input. + Return the string input. If the dialog is canceled, return ``None``. :: + + >>> screen.textinput("NIM", "Name of first player:") + + +.. function:: numinput(title, prompt, default=None, minval=None, maxval=None) + + :param title: string + :param prompt: string + :param default: number (optional) + :param minval: number (optional) + :param maxval: number (optional) + + Pop up a dialog window for input of a number. title is the title of the + dialog window, prompt is a text mostly describing what numerical information + to input. default: default value, minval: minimum value for input, + maxval: maximum value for input + The number input must be in the range minval .. maxval if these are + given. If not, a hint is issued and the dialog remains open for + correction. + Return the number input. If the dialog is canceled, return ``None``. :: + + >>> screen.numinput("Poker", "Your stakes:", 1000, minval=10, maxval=10000) + + +Settings and special methods +---------------------------- + +.. function:: mode(mode=None) + + :param mode: one of the strings "standard", "logo" or "world" + + Set turtle mode ("standard", "logo" or "world") and perform reset. If mode + is not given, current mode is returned. + + Mode "standard" is compatible with old :mod:`turtle`. Mode "logo" is + compatible with most Logo turtle graphics. Mode "world" uses user-defined + "world coordinates". **Attention**: in this mode angles appear distorted if + ``x/y`` unit-ratio doesn't equal 1. + + ============ ========================= =================== + Mode Initial turtle heading positive angles + ============ ========================= =================== + "standard" to the right (east) counterclockwise + "logo" upward (north) clockwise + ============ ========================= =================== + + .. doctest:: + + >>> mode("logo") # resets turtle heading to north + >>> mode() + 'logo' + + +.. function:: colormode(cmode=None) + + :param cmode: one of the values 1.0 or 255 + + Return the colormode or set it to 1.0 or 255. Subsequently *r*, *g*, *b* + values of color triples have to be in the range 0..\ *cmode*. + + .. doctest:: + + >>> screen.colormode(1) + >>> turtle.pencolor(240, 160, 80) + Traceback (most recent call last): + ... + TurtleGraphicsError: bad color sequence: (240, 160, 80) + >>> screen.colormode() + 1.0 + >>> screen.colormode(255) + >>> screen.colormode() + 255 + >>> turtle.pencolor(240,160,80) + + +.. function:: getcanvas() + + Return the Canvas of this TurtleScreen. Useful for insiders who know what to + do with a Tkinter Canvas. + + .. doctest:: + + >>> cv = screen.getcanvas() + >>> cv + + + +.. function:: getshapes() + + Return a list of names of all currently available turtle shapes. + + .. doctest:: + + >>> screen.getshapes() + ['arrow', 'blank', 'circle', ..., 'turtle'] + + +.. function:: register_shape(name, shape=None) + addshape(name, shape=None) + + There are three different ways to call this function: + + (1) *name* is the name of a gif-file and *shape* is ``None``: Install the + corresponding image shape. :: + + >>> screen.register_shape("turtle.gif") + + .. note:: + Image shapes *do not* rotate when turning the turtle, so they do not + display the heading of the turtle! + + (2) *name* is an arbitrary string and *shape* is a tuple of pairs of + coordinates: Install the corresponding polygon shape. + + .. doctest:: + + >>> screen.register_shape("triangle", ((5,-3), (0,5), (-5,-3))) + + (3) *name* is an arbitrary string and shape is a (compound) :class:`Shape` + object: Install the corresponding compound shape. + + Add a turtle shape to TurtleScreen's shapelist. Only thusly registered + shapes can be used by issuing the command ``shape(shapename)``. + + +.. function:: turtles() + + Return the list of turtles on the screen. + + .. doctest:: + + >>> for turtle in screen.turtles(): + ... turtle.color("red") + + +.. function:: window_height() + + Return the height of the turtle window. :: + + >>> screen.window_height() + 480 + + +.. function:: window_width() + + Return the width of the turtle window. :: + + >>> screen.window_width() + 640 + + +.. _screenspecific: + +Methods specific to Screen, not inherited from TurtleScreen +----------------------------------------------------------- + +.. function:: bye() + + Shut the turtlegraphics window. + + +.. function:: exitonclick() + + Bind bye() method to mouse clicks on the Screen. + + + If the value "using_IDLE" in the configuration dictionary is ``False`` + (default value), also enter mainloop. Remark: If IDLE with the ``-n`` switch + (no subprocess) is used, this value should be set to ``True`` in + :file:`turtle.cfg`. In this case IDLE's own mainloop is active also for the + client script. + + +.. function:: setup(width=_CFG["width"], height=_CFG["height"], startx=_CFG["leftright"], starty=_CFG["topbottom"]) + + Set the size and position of the main window. Default values of arguments + are stored in the configuration dictionary and can be changed via a + :file:`turtle.cfg` file. + + :param width: if an integer, a size in pixels, if a float, a fraction of the + screen; default is 50% of screen + :param height: if an integer, the height in pixels, if a float, a fraction of + the screen; default is 75% of screen + :param startx: if positive, starting position in pixels from the left + edge of the screen, if negative from the right edge, if ``None``, + center window horizontally + :param starty: if positive, starting position in pixels from the top + edge of the screen, if negative from the bottom edge, if ``None``, + center window vertically + + .. doctest:: + + >>> screen.setup (width=200, height=200, startx=0, starty=0) + >>> # sets window to 200x200 pixels, in upper left of screen + >>> screen.setup(width=.75, height=0.5, startx=None, starty=None) + >>> # sets window to 75% of screen by 50% of screen and centers + + +.. function:: title(titlestring) + + :param titlestring: a string that is shown in the titlebar of the turtle + graphics window + + Set title of turtle window to *titlestring*. + + .. doctest:: + + >>> screen.title("Welcome to the turtle zoo!") + + +Public classes +============== + + +.. class:: RawTurtle(canvas) + RawPen(canvas) + + :param canvas: a :class:`tkinter.Canvas`, a :class:`ScrolledCanvas` or a + :class:`TurtleScreen` + + Create a turtle. The turtle has all methods described above as "methods of + Turtle/RawTurtle". + + +.. class:: Turtle() + + Subclass of RawTurtle, has the same interface but draws on a default + :class:`Screen` object created automatically when needed for the first time. + + +.. class:: TurtleScreen(cv) + + :param cv: a :class:`tkinter.Canvas` + + Provides screen oriented methods like :func:`setbg` etc. that are described + above. + +.. class:: Screen() + + Subclass of TurtleScreen, with :ref:`four methods added `. + + +.. class:: ScrolledCanvas(master) + + :param master: some Tkinter widget to contain the ScrolledCanvas, i.e. + a Tkinter-canvas with scrollbars added + + Used by class Screen, which thus automatically provides a ScrolledCanvas as + playground for the turtles. + +.. class:: Shape(type_, data) + + :param type\_: one of the strings "polygon", "image", "compound" + + Data structure modeling shapes. The pair ``(type_, data)`` must follow this + specification: + + + =========== =========== + *type_* *data* + =========== =========== + "polygon" a polygon-tuple, i.e. a tuple of pairs of coordinates + "image" an image (in this form only used internally!) + "compound" ``None`` (a compound shape has to be constructed using the + :meth:`addcomponent` method) + =========== =========== + + .. method:: addcomponent(poly, fill, outline=None) + + :param poly: a polygon, i.e. a tuple of pairs of numbers + :param fill: a color the *poly* will be filled with + :param outline: a color for the poly's outline (if given) + + Example: + + .. doctest:: + + >>> poly = ((0,0),(10,-5),(0,10),(-10,-5)) + >>> s = Shape("compound") + >>> s.addcomponent(poly, "red", "blue") + >>> # ... add more components and then use register_shape() + + See :ref:`compoundshapes`. + + +.. class:: Vec2D(x, y) + + A two-dimensional vector class, used as a helper class for implementing + turtle graphics. May be useful for turtle graphics programs too. Derived + from tuple, so a vector is a tuple! + + Provides (for *a*, *b* vectors, *k* number): + + * ``a + b`` vector addition + * ``a - b`` vector subtraction + * ``a * b`` inner product + * ``k * a`` and ``a * k`` multiplication with scalar + * ``abs(a)`` absolute value of a + * ``a.rotate(angle)`` rotation + + +Help and configuration +====================== + +How to use help +--------------- + +The public methods of the Screen and Turtle classes are documented extensively +via docstrings. So these can be used as online-help via the Python help +facilities: + +- When using IDLE, tooltips show the signatures and first lines of the + docstrings of typed in function-/method calls. + +- Calling :func:`help` on methods or functions displays the docstrings:: + + >>> help(Screen.bgcolor) + Help on method bgcolor in module turtle: + + bgcolor(self, *args) unbound turtle.Screen method + Set or return backgroundcolor of the TurtleScreen. + + Arguments (if given): a color string or three numbers + in the range 0..colormode or a 3-tuple of such numbers. + + + >>> screen.bgcolor("orange") + >>> screen.bgcolor() + "orange" + >>> screen.bgcolor(0.5,0,0.5) + >>> screen.bgcolor() + "#800080" + + >>> help(Turtle.penup) + Help on method penup in module turtle: + + penup(self) unbound turtle.Turtle method + Pull the pen up -- no drawing when moving. + + Aliases: penup | pu | up + + No argument + + >>> turtle.penup() + +- The docstrings of the functions which are derived from methods have a modified + form:: + + >>> help(bgcolor) + Help on function bgcolor in module turtle: + + bgcolor(*args) + Set or return backgroundcolor of the TurtleScreen. + + Arguments (if given): a color string or three numbers + in the range 0..colormode or a 3-tuple of such numbers. + + Example:: + + >>> bgcolor("orange") + >>> bgcolor() + "orange" + >>> bgcolor(0.5,0,0.5) + >>> bgcolor() + "#800080" + + >>> help(penup) + Help on function penup in module turtle: + + penup() + Pull the pen up -- no drawing when moving. + + Aliases: penup | pu | up + + No argument + + Example: + >>> penup() + +These modified docstrings are created automatically together with the function +definitions that are derived from the methods at import time. + + +Translation of docstrings into different languages +-------------------------------------------------- + +There is a utility to create a dictionary the keys of which are the method names +and the values of which are the docstrings of the public methods of the classes +Screen and Turtle. + +.. function:: write_docstringdict(filename="turtle_docstringdict") + + :param filename: a string, used as filename + + Create and write docstring-dictionary to a Python script with the given + filename. This function has to be called explicitly (it is not used by the + turtle graphics classes). The docstring dictionary will be written to the + Python script :file:`{filename}.py`. It is intended to serve as a template + for translation of the docstrings into different languages. + +If you (or your students) want to use :mod:`turtle` with online help in your +native language, you have to translate the docstrings and save the resulting +file as e.g. :file:`turtle_docstringdict_german.py`. + +If you have an appropriate entry in your :file:`turtle.cfg` file this dictionary +will be read in at import time and will replace the original English docstrings. + +At the time of this writing there are docstring dictionaries in German and in +Italian. (Requests please to glingl@aon.at.) + + + +How to configure Screen and Turtles +----------------------------------- + +The built-in default configuration mimics the appearance and behaviour of the +old turtle module in order to retain best possible compatibility with it. + +If you want to use a different configuration which better reflects the features +of this module or which better fits to your needs, e.g. for use in a classroom, +you can prepare a configuration file ``turtle.cfg`` which will be read at import +time and modify the configuration according to its settings. + +The built in configuration would correspond to the following turtle.cfg:: + + width = 0.5 + height = 0.75 + leftright = None + topbottom = None + canvwidth = 400 + canvheight = 300 + mode = standard + colormode = 1.0 + delay = 10 + undobuffersize = 1000 + shape = classic + pencolor = black + fillcolor = black + resizemode = noresize + visible = True + language = english + exampleturtle = turtle + examplescreen = screen + title = Python Turtle Graphics + using_IDLE = False + +Short explanation of selected entries: + +- The first four lines correspond to the arguments of the :meth:`Screen.setup` + method. +- Line 5 and 6 correspond to the arguments of the method + :meth:`Screen.screensize`. +- *shape* can be any of the built-in shapes, e.g: arrow, turtle, etc. For more + info try ``help(shape)``. +- If you want to use no fillcolor (i.e. make the turtle transparent), you have + to write ``fillcolor = ""`` (but all nonempty strings must not have quotes in + the cfg-file). +- If you want to reflect the turtle its state, you have to use ``resizemode = + auto``. +- If you set e.g. ``language = italian`` the docstringdict + :file:`turtle_docstringdict_italian.py` will be loaded at import time (if + present on the import path, e.g. in the same directory as :mod:`turtle`. +- The entries *exampleturtle* and *examplescreen* define the names of these + objects as they occur in the docstrings. The transformation of + method-docstrings to function-docstrings will delete these names from the + docstrings. +- *using_IDLE*: Set this to ``True`` if you regularly work with IDLE and its -n + switch ("no subprocess"). This will prevent :func:`exitonclick` to enter the + mainloop. + +There can be a :file:`turtle.cfg` file in the directory where :mod:`turtle` is +stored and an additional one in the current working directory. The latter will +override the settings of the first one. + +The :file:`Lib/turtledemo` directory contains a :file:`turtle.cfg` file. You can +study it as an example and see its effects when running the demos (preferably +not from within the demo-viewer). + + +:mod:`turtledemo` --- Demo scripts +================================== + +.. module:: turtledemo + :synopsis: A viewer for example turtle scripts + +The :mod:`turtledemo` package includes a set of demo scripts. These +scripts can be run and viewed using the supplied demo viewer as follows:: + + python -m turtledemo + +Alternatively, you can run the demo scripts individually. For example, :: + + python -m turtledemo.bytedesign + +The :mod:`turtledemo` package directory contains: + +- A demo viewer :file:`__main__.py` which can be used to view the sourcecode + of the scripts and run them at the same time. +- Multiple scripts demonstrating different features of the :mod:`turtle` + module. Examples can be accessed via the Examples menu. They can also + be run standalone. +- A :file:`turtle.cfg` file which serves as an example of how to write + and use such files. + +The demo scripts are: + +.. tabularcolumns:: |l|L|L| + ++----------------+------------------------------+-----------------------+ +| Name | Description | Features | ++================+==============================+=======================+ +| bytedesign | complex classical | :func:`tracer`, delay,| +| | turtle graphics pattern | :func:`update` | ++----------------+------------------------------+-----------------------+ +| chaos | graphs Verhulst dynamics, | world coordinates | +| | shows that computer's | | +| | computations can generate | | +| | results sometimes against the| | +| | common sense expectations | | ++----------------+------------------------------+-----------------------+ +| clock | analog clock showing time | turtles as clock's | +| | of your computer | hands, ontimer | ++----------------+------------------------------+-----------------------+ +| colormixer | experiment with r, g, b | :func:`ondrag` | ++----------------+------------------------------+-----------------------+ +| forest | 3 breadth-first trees | randomization | ++----------------+------------------------------+-----------------------+ +| fractalcurves | Hilbert & Koch curves | recursion | ++----------------+------------------------------+-----------------------+ +| lindenmayer | ethnomathematics | L-System | +| | (indian kolams) | | ++----------------+------------------------------+-----------------------+ +| minimal_hanoi | Towers of Hanoi | Rectangular Turtles | +| | | as Hanoi discs | +| | | (shape, shapesize) | ++----------------+------------------------------+-----------------------+ +| nim | play the classical nim game | turtles as nimsticks, | +| | with three heaps of sticks | event driven (mouse, | +| | against the computer. | keyboard) | ++----------------+------------------------------+-----------------------+ +| paint | super minimalistic | :func:`onclick` | +| | drawing program | | ++----------------+------------------------------+-----------------------+ +| peace | elementary | turtle: appearance | +| | | and animation | ++----------------+------------------------------+-----------------------+ +| penrose | aperiodic tiling with | :func:`stamp` | +| | kites and darts | | ++----------------+------------------------------+-----------------------+ +| planet_and_moon| simulation of | compound shapes, | +| | gravitational system | :class:`Vec2D` | ++----------------+------------------------------+-----------------------+ +| round_dance | dancing turtles rotating | compound shapes, clone| +| | pairwise in opposite | shapesize, tilt, | +| | direction | get_shapepoly, update | ++----------------+------------------------------+-----------------------+ +| sorting_animate| visual demonstration of | simple alignment, | +| | different sorting methods | randomization | ++----------------+------------------------------+-----------------------+ +| tree | a (graphical) breadth | :func:`clone` | +| | first tree (using generators)| | ++----------------+------------------------------+-----------------------+ +| two_canvases | simple design | turtles on two | +| | | canvases | ++----------------+------------------------------+-----------------------+ +| wikipedia | a pattern from the wikipedia | :func:`clone`, | +| | article on turtle graphics | :func:`undo` | ++----------------+------------------------------+-----------------------+ +| yinyang | another elementary example | :func:`circle` | ++----------------+------------------------------+-----------------------+ + +Have fun! + + +Changes since Python 2.6 +======================== + +- The methods :meth:`Turtle.tracer`, :meth:`Turtle.window_width` and + :meth:`Turtle.window_height` have been eliminated. + Methods with these names and functionality are now available only + as methods of :class:`Screen`. The functions derived from these remain + available. (In fact already in Python 2.6 these methods were merely + duplications of the corresponding + :class:`TurtleScreen`/:class:`Screen`-methods.) + +- The method :meth:`Turtle.fill` has been eliminated. + The behaviour of :meth:`begin_fill` and :meth:`end_fill` + have changed slightly: now every filling-process must be completed with an + ``end_fill()`` call. + +- A method :meth:`Turtle.filling` has been added. It returns a boolean + value: ``True`` if a filling process is under way, ``False`` otherwise. + This behaviour corresponds to a ``fill()`` call without arguments in + Python 2.6. + +Changes since Python 3.0 +======================== + +- The methods :meth:`Turtle.shearfactor`, :meth:`Turtle.shapetransform` and + :meth:`Turtle.get_shapepoly` have been added. Thus the full range of + regular linear transforms is now available for transforming turtle shapes. + :meth:`Turtle.tiltangle` has been enhanced in functionality: it now can + be used to get or set the tiltangle. :meth:`Turtle.settiltangle` has been + deprecated. + +- The method :meth:`Screen.onkeypress` has been added as a complement to + :meth:`Screen.onkey` which in fact binds actions to the keyrelease event. + Accordingly the latter has got an alias: :meth:`Screen.onkeyrelease`. + +- The method :meth:`Screen.mainloop` has been added. So when working only + with Screen and Turtle objects one must not additionally import + :func:`mainloop` anymore. + +- Two input methods has been added :meth:`Screen.textinput` and + :meth:`Screen.numinput`. These popup input dialogs and return + strings and numbers respectively. + +- Two example scripts :file:`tdemo_nim.py` and :file:`tdemo_round_dance.py` + have been added to the :file:`Lib/turtledemo` directory. + + +.. doctest:: + :hide: + + >>> for turtle in turtles(): + ... turtle.reset() + >>> turtle.penup() + >>> turtle.goto(-200,25) + >>> turtle.pendown() + >>> turtle.write("No one expects the Spanish Inquisition!", + ... font=("Arial", 20, "normal")) + >>> turtle.penup() + >>> turtle.goto(-100,-50) + >>> turtle.pendown() + >>> turtle.write("Our two chief Turtles are...", + ... font=("Arial", 16, "normal")) + >>> turtle.penup() + >>> turtle.goto(-450,-75) + >>> turtle.write(str(turtles())) diff --git a/python-3.7.4-docs-html/_sources/library/types.rst.txt b/python-3.7.4-docs-html/_sources/library/types.rst.txt new file mode 100644 index 0000000..b19aa02 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/types.rst.txt @@ -0,0 +1,374 @@ +:mod:`types` --- Dynamic type creation and names for built-in types +=================================================================== + +.. module:: types + :synopsis: Names for built-in types. + +**Source code:** :source:`Lib/types.py` + +-------------- + +This module defines utility functions to assist in dynamic creation of +new types. + +It also defines names for some object types that are used by the standard +Python interpreter, but not exposed as builtins like :class:`int` or +:class:`str` are. + +Finally, it provides some additional type-related utility classes and functions +that are not fundamental enough to be builtins. + + +Dynamic Type Creation +--------------------- + +.. function:: new_class(name, bases=(), kwds=None, exec_body=None) + + Creates a class object dynamically using the appropriate metaclass. + + The first three arguments are the components that make up a class + definition header: the class name, the base classes (in order), the + keyword arguments (such as ``metaclass``). + + The *exec_body* argument is a callback that is used to populate the + freshly created class namespace. It should accept the class namespace + as its sole argument and update the namespace directly with the class + contents. If no callback is provided, it has the same effect as passing + in ``lambda ns: ns``. + + .. versionadded:: 3.3 + +.. function:: prepare_class(name, bases=(), kwds=None) + + Calculates the appropriate metaclass and creates the class namespace. + + The arguments are the components that make up a class definition header: + the class name, the base classes (in order) and the keyword arguments + (such as ``metaclass``). + + The return value is a 3-tuple: ``metaclass, namespace, kwds`` + + *metaclass* is the appropriate metaclass, *namespace* is the + prepared class namespace and *kwds* is an updated copy of the passed + in *kwds* argument with any ``'metaclass'`` entry removed. If no *kwds* + argument is passed in, this will be an empty dict. + + .. versionadded:: 3.3 + + .. versionchanged:: 3.6 + + The default value for the ``namespace`` element of the returned + tuple has changed. Now an insertion-order-preserving mapping is + used when the metaclass does not have a ``__prepare__`` method. + +.. seealso:: + + :ref:`metaclasses` + Full details of the class creation process supported by these functions + + :pep:`3115` - Metaclasses in Python 3000 + Introduced the ``__prepare__`` namespace hook + +.. function:: resolve_bases(bases) + + Resolve MRO entries dynamically as specified by :pep:`560`. + + This function looks for items in *bases* that are not instances of + :class:`type`, and returns a tuple where each such object that has + an ``__mro_entries__`` method is replaced with an unpacked result of + calling this method. If a *bases* item is an instance of :class:`type`, + or it doesn't have an ``__mro_entries__`` method, then it is included in + the return tuple unchanged. + + .. versionadded:: 3.7 + +.. seealso:: + + :pep:`560` - Core support for typing module and generic types + + +Standard Interpreter Types +-------------------------- + +This module provides names for many of the types that are required to +implement a Python interpreter. It deliberately avoids including some of +the types that arise only incidentally during processing such as the +``listiterator`` type. + +Typical use of these names is for :func:`isinstance` or +:func:`issubclass` checks. + +Standard names are defined for the following types: + +.. data:: FunctionType + LambdaType + + The type of user-defined functions and functions created by + :keyword:`lambda` expressions. + + +.. data:: GeneratorType + + The type of :term:`generator`-iterator objects, created by + generator functions. + + +.. data:: CoroutineType + + The type of :term:`coroutine` objects, created by + :keyword:`async def` functions. + + .. versionadded:: 3.5 + + +.. data:: AsyncGeneratorType + + The type of :term:`asynchronous generator`-iterator objects, created by + asynchronous generator functions. + + .. versionadded:: 3.6 + + +.. data:: CodeType + + .. index:: builtin: compile + + The type for code objects such as returned by :func:`compile`. + + +.. data:: MethodType + + The type of methods of user-defined class instances. + + +.. data:: BuiltinFunctionType + BuiltinMethodType + + The type of built-in functions like :func:`len` or :func:`sys.exit`, and + methods of built-in classes. (Here, the term "built-in" means "written in + C".) + + +.. data:: WrapperDescriptorType + + The type of methods of some built-in data types and base classes such as + :meth:`object.__init__` or :meth:`object.__lt__`. + + .. versionadded:: 3.7 + + +.. data:: MethodWrapperType + + The type of *bound* methods of some built-in data types and base classes. + For example it is the type of :code:`object().__str__`. + + .. versionadded:: 3.7 + + +.. data:: MethodDescriptorType + + The type of methods of some built-in data types such as :meth:`str.join`. + + .. versionadded:: 3.7 + + +.. data:: ClassMethodDescriptorType + + The type of *unbound* class methods of some built-in data types such as + ``dict.__dict__['fromkeys']``. + + .. versionadded:: 3.7 + + +.. class:: ModuleType(name, doc=None) + + The type of :term:`modules `. Constructor takes the name of the + module to be created and optionally its :term:`docstring`. + + .. note:: + Use :func:`importlib.util.module_from_spec` to create a new module if you + wish to set the various import-controlled attributes. + + .. attribute:: __doc__ + + The :term:`docstring` of the module. Defaults to ``None``. + + .. attribute:: __loader__ + + The :term:`loader` which loaded the module. Defaults to ``None``. + + .. versionchanged:: 3.4 + Defaults to ``None``. Previously the attribute was optional. + + .. attribute:: __name__ + + The name of the module. + + .. attribute:: __package__ + + Which :term:`package` a module belongs to. If the module is top-level + (i.e. not a part of any specific package) then the attribute should be set + to ``''``, else it should be set to the name of the package (which can be + :attr:`__name__` if the module is a package itself). Defaults to ``None``. + + .. versionchanged:: 3.4 + Defaults to ``None``. Previously the attribute was optional. + + +.. class:: TracebackType(tb_next, tb_frame, tb_lasti, tb_lineno) + + The type of traceback objects such as found in ``sys.exc_info()[2]``. + + See :ref:`the language reference ` for details of the + available attributes and operations, and guidance on creating tracebacks + dynamically. + + +.. data:: FrameType + + The type of frame objects such as found in ``tb.tb_frame`` if ``tb`` is a + traceback object. + + See :ref:`the language reference ` for details of the + available attributes and operations. + + +.. data:: GetSetDescriptorType + + The type of objects defined in extension modules with ``PyGetSetDef``, such + as ``FrameType.f_locals`` or ``array.array.typecode``. This type is used as + descriptor for object attributes; it has the same purpose as the + :class:`property` type, but for classes defined in extension modules. + + +.. data:: MemberDescriptorType + + The type of objects defined in extension modules with ``PyMemberDef``, such + as ``datetime.timedelta.days``. This type is used as descriptor for simple C + data members which use standard conversion functions; it has the same purpose + as the :class:`property` type, but for classes defined in extension modules. + + .. impl-detail:: + + In other implementations of Python, this type may be identical to + ``GetSetDescriptorType``. + +.. class:: MappingProxyType(mapping) + + Read-only proxy of a mapping. It provides a dynamic view on the mapping's + entries, which means that when the mapping changes, the view reflects these + changes. + + .. versionadded:: 3.3 + + .. describe:: key in proxy + + Return ``True`` if the underlying mapping has a key *key*, else + ``False``. + + .. describe:: proxy[key] + + Return the item of the underlying mapping with key *key*. Raises a + :exc:`KeyError` if *key* is not in the underlying mapping. + + .. describe:: iter(proxy) + + Return an iterator over the keys of the underlying mapping. This is a + shortcut for ``iter(proxy.keys())``. + + .. describe:: len(proxy) + + Return the number of items in the underlying mapping. + + .. method:: copy() + + Return a shallow copy of the underlying mapping. + + .. method:: get(key[, default]) + + Return the value for *key* if *key* is in the underlying mapping, else + *default*. If *default* is not given, it defaults to ``None``, so that + this method never raises a :exc:`KeyError`. + + .. method:: items() + + Return a new view of the underlying mapping's items (``(key, value)`` + pairs). + + .. method:: keys() + + Return a new view of the underlying mapping's keys. + + .. method:: values() + + Return a new view of the underlying mapping's values. + + +Additional Utility Classes and Functions +---------------------------------------- + +.. class:: SimpleNamespace + + A simple :class:`object` subclass that provides attribute access to its + namespace, as well as a meaningful repr. + + Unlike :class:`object`, with ``SimpleNamespace`` you can add and remove + attributes. If a ``SimpleNamespace`` object is initialized with keyword + arguments, those are directly added to the underlying namespace. + + The type is roughly equivalent to the following code:: + + 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__ + + ``SimpleNamespace`` may be useful as a replacement for ``class NS: pass``. + However, for a structured record type use :func:`~collections.namedtuple` + instead. + + .. versionadded:: 3.3 + + +.. function:: DynamicClassAttribute(fget=None, fset=None, fdel=None, doc=None) + + Route attribute access on a class to __getattr__. + + This is a descriptor, used to define attributes that act differently when + accessed through an instance and through a class. Instance access remains + normal, but access to an attribute through a class will be routed to the + class's __getattr__ method; this is done by raising AttributeError. + + This allows one to have properties active on an instance, and have virtual + attributes on the class with the same name (see Enum for an example). + + .. versionadded:: 3.4 + + +Coroutine Utility Functions +--------------------------- + +.. function:: coroutine(gen_func) + + This function transforms a :term:`generator` function into a + :term:`coroutine function` which returns a generator-based coroutine. + The generator-based coroutine is still a :term:`generator iterator`, + but is also considered to be a :term:`coroutine` object and is + :term:`awaitable`. However, it may not necessarily implement + the :meth:`__await__` method. + + If *gen_func* is a generator function, it will be modified in-place. + + If *gen_func* is not a generator function, it will be wrapped. If it + returns an instance of :class:`collections.abc.Generator`, the instance + will be wrapped in an *awaitable* proxy object. All other types + of objects will be returned as is. + + .. versionadded:: 3.5 diff --git a/python-3.7.4-docs-html/_sources/library/typing.rst.txt b/python-3.7.4-docs-html/_sources/library/typing.rst.txt new file mode 100644 index 0000000..5adc81c --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/typing.rst.txt @@ -0,0 +1,1143 @@ +:mod:`typing` --- Support for type hints +======================================== + +.. module:: typing + :synopsis: Support for type hints (see PEP 484). + +.. versionadded:: 3.5 + +**Source code:** :source:`Lib/typing.py` + +.. note:: + + The typing module has been included in the standard library on a + :term:`provisional basis `. New features might + be added and API may change even between minor releases if deemed + necessary by the core developers. + +-------------- + +This module supports type hints as specified by :pep:`484` and :pep:`526`. +The most fundamental support consists of the types :data:`Any`, :data:`Union`, +:data:`Tuple`, :data:`Callable`, :class:`TypeVar`, and +:class:`Generic`. For full specification please see :pep:`484`. For +a simplified introduction to type hints see :pep:`483`. + + +The function below takes and returns a string and is annotated as follows:: + + def greeting(name: str) -> str: + return 'Hello ' + name + +In the function ``greeting``, the argument ``name`` is expected to be of type +:class:`str` and the return type :class:`str`. Subtypes are accepted as +arguments. + +Type aliases +------------ + +A type alias is defined by assigning the type to the alias. In this example, +``Vector`` and ``List[float]`` will be treated as interchangeable synonyms:: + + from typing import List + Vector = List[float] + + def scale(scalar: float, vector: Vector) -> Vector: + return [scalar * num for num in vector] + + # typechecks; a list of floats qualifies as a Vector. + new_vector = scale(2.0, [1.0, -4.2, 5.4]) + +Type aliases are useful for simplifying complex type signatures. For example:: + + from typing import Dict, Tuple, Sequence + + ConnectionOptions = Dict[str, str] + Address = Tuple[str, int] + Server = Tuple[Address, ConnectionOptions] + + def broadcast_message(message: str, servers: Sequence[Server]) -> None: + ... + + # The static type checker will treat the previous type signature as + # being exactly equivalent to this one. + def broadcast_message( + message: str, + servers: Sequence[Tuple[Tuple[str, int], Dict[str, str]]]) -> None: + ... + +Note that ``None`` as a type hint is a special case and is replaced by +``type(None)``. + +.. _distinct: + +NewType +------- + +Use the :func:`NewType` helper function to create distinct types:: + + from typing import NewType + + UserId = NewType('UserId', int) + some_id = UserId(524313) + +The static type checker will treat the new type as if it were a subclass +of the original type. This is useful in helping catch logical errors:: + + def get_user_name(user_id: UserId) -> str: + ... + + # typechecks + user_a = get_user_name(UserId(42351)) + + # does not typecheck; an int is not a UserId + user_b = get_user_name(-1) + +You may still perform all ``int`` operations on a variable of type ``UserId``, +but the result will always be of type ``int``. This lets you pass in a +``UserId`` wherever an ``int`` might be expected, but will prevent you from +accidentally creating a ``UserId`` in an invalid way:: + + # 'output' is of type 'int', not 'UserId' + output = UserId(23413) + UserId(54341) + +Note that these checks are enforced only by the static type checker. At runtime +the statement ``Derived = NewType('Derived', Base)`` will make ``Derived`` a +function that immediately returns whatever parameter you pass it. That means +the expression ``Derived(some_value)`` does not create a new class or introduce +any overhead beyond that of a regular function call. + +More precisely, the expression ``some_value is Derived(some_value)`` is always +true at runtime. + +This also means that it is not possible to create a subtype of ``Derived`` +since it is an identity function at runtime, not an actual type:: + + from typing import NewType + + UserId = NewType('UserId', int) + + # Fails at runtime and does not typecheck + class AdminUserId(UserId): pass + +However, it is possible to create a :func:`NewType` based on a 'derived' ``NewType``:: + + from typing import NewType + + UserId = NewType('UserId', int) + + ProUserId = NewType('ProUserId', UserId) + +and typechecking for ``ProUserId`` will work as expected. + +See :pep:`484` for more details. + +.. note:: + + Recall that the use of a type alias declares two types to be *equivalent* to + one another. Doing ``Alias = Original`` will make the static type checker + treat ``Alias`` as being *exactly equivalent* to ``Original`` in all cases. + This is useful when you want to simplify complex type signatures. + + In contrast, ``NewType`` declares one type to be a *subtype* of another. + Doing ``Derived = NewType('Derived', Original)`` will make the static type + checker treat ``Derived`` as a *subclass* of ``Original``, which means a + value of type ``Original`` cannot be used in places where a value of type + ``Derived`` is expected. This is useful when you want to prevent logic + errors with minimal runtime cost. + +.. versionadded:: 3.5.2 + +Callable +-------- + +Frameworks expecting callback functions of specific signatures might be +type hinted using ``Callable[[Arg1Type, Arg2Type], ReturnType]``. + +For example:: + + from typing import Callable + + def feeder(get_next_item: Callable[[], str]) -> None: + # Body + + def async_query(on_success: Callable[[int], None], + on_error: Callable[[int, Exception], None]) -> None: + # Body + +It is possible to declare the return type of a callable without specifying +the call signature by substituting a literal ellipsis +for the list of arguments in the type hint: ``Callable[..., ReturnType]``. + +.. _generics: + +Generics +-------- + +Since type information about objects kept in containers cannot be statically +inferred in a generic way, abstract base classes have been extended to support +subscription to denote expected types for container elements. + +:: + + from typing import Mapping, Sequence + + def notify_by_email(employees: Sequence[Employee], + overrides: Mapping[str, str]) -> None: ... + +Generics can be parameterized by using a new factory available in typing +called :class:`TypeVar`. + +:: + + from typing import Sequence, TypeVar + + T = TypeVar('T') # Declare type variable + + def first(l: Sequence[T]) -> T: # Generic function + return l[0] + + +User-defined generic types +-------------------------- + +A user-defined class can be defined as a generic class. + +:: + + from typing import TypeVar, Generic + from logging import Logger + + T = TypeVar('T') + + class LoggedVar(Generic[T]): + def __init__(self, value: T, name: str, logger: Logger) -> None: + self.name = name + self.logger = logger + self.value = value + + def set(self, new: T) -> None: + self.log('Set ' + repr(self.value)) + self.value = new + + def get(self) -> T: + self.log('Get ' + repr(self.value)) + return self.value + + def log(self, message: str) -> None: + self.logger.info('%s: %s', self.name, message) + +``Generic[T]`` as a base class defines that the class ``LoggedVar`` takes a +single type parameter ``T`` . This also makes ``T`` valid as a type within the +class body. + +The :class:`Generic` base class uses a metaclass that defines +:meth:`__getitem__` so that ``LoggedVar[t]`` is valid as a type:: + + from typing import Iterable + + def zero_all_vars(vars: Iterable[LoggedVar[int]]) -> None: + for var in vars: + var.set(0) + +A generic type can have any number of type variables, and type variables may +be constrained:: + + from typing import TypeVar, Generic + ... + + T = TypeVar('T') + S = TypeVar('S', int, str) + + class StrangePair(Generic[T, S]): + ... + +Each type variable argument to :class:`Generic` must be distinct. +This is thus invalid:: + + from typing import TypeVar, Generic + ... + + T = TypeVar('T') + + class Pair(Generic[T, T]): # INVALID + ... + +You can use multiple inheritance with :class:`Generic`:: + + from typing import TypeVar, Generic, Sized + + T = TypeVar('T') + + class LinkedList(Sized, Generic[T]): + ... + +When inheriting from generic classes, some type variables could be fixed:: + + from typing import TypeVar, Mapping + + T = TypeVar('T') + + class MyDict(Mapping[str, T]): + ... + +In this case ``MyDict`` has a single parameter, ``T``. + +Using a generic class without specifying type parameters assumes +:data:`Any` for each position. In the following example, ``MyIterable`` is +not generic but implicitly inherits from ``Iterable[Any]``:: + + from typing import Iterable + + class MyIterable(Iterable): # Same as Iterable[Any] + +User defined generic type aliases are also supported. Examples:: + + from typing import TypeVar, Iterable, Tuple, Union + S = TypeVar('S') + Response = Union[Iterable[S], int] + + # Return type here is same as Union[Iterable[str], int] + def response(query: str) -> Response[str]: + ... + + T = TypeVar('T', int, float, complex) + Vec = Iterable[Tuple[T, T]] + + def inproduct(v: Vec[T]) -> T: # Same as Iterable[Tuple[T, T]] + return sum(x*y for x, y in v) + +The metaclass used by :class:`Generic` is a subclass of :class:`abc.ABCMeta`. +A generic class can be an ABC by including abstract methods or properties, +and generic classes can also have ABCs as base classes without a metaclass +conflict. Generic metaclasses are not supported. The outcome of parameterizing +generics is cached, and most types in the typing module are hashable and +comparable for equality. + + +The :data:`Any` type +-------------------- + +A special kind of type is :data:`Any`. A static type checker will treat +every type as being compatible with :data:`Any` and :data:`Any` as being +compatible with every type. + +This means that it is possible to perform any operation or method call on a +value of type on :data:`Any` and assign it to any variable:: + + from typing import Any + + a = None # type: Any + a = [] # OK + a = 2 # OK + + s = '' # type: str + s = a # OK + + def foo(item: Any) -> int: + # Typechecks; 'item' could be any type, + # and that type might have a 'bar' method + item.bar() + ... + +Notice that no typechecking is performed when assigning a value of type +:data:`Any` to a more precise type. For example, the static type checker did +not report an error when assigning ``a`` to ``s`` even though ``s`` was +declared to be of type :class:`str` and receives an :class:`int` value at +runtime! + +Furthermore, all functions without a return type or parameter types will +implicitly default to using :data:`Any`:: + + def legacy_parser(text): + ... + return data + + # A static type checker will treat the above + # as having the same signature as: + def legacy_parser(text: Any) -> Any: + ... + return data + +This behavior allows :data:`Any` to be used as an *escape hatch* when you +need to mix dynamically and statically typed code. + +Contrast the behavior of :data:`Any` with the behavior of :class:`object`. +Similar to :data:`Any`, every type is a subtype of :class:`object`. However, +unlike :data:`Any`, the reverse is not true: :class:`object` is *not* a +subtype of every other type. + +That means when the type of a value is :class:`object`, a type checker will +reject almost all operations on it, and assigning it to a variable (or using +it as a return value) of a more specialized type is a type error. For example:: + + def hash_a(item: object) -> int: + # Fails; an object does not have a 'magic' method. + item.magic() + ... + + def hash_b(item: Any) -> int: + # Typechecks + item.magic() + ... + + # Typechecks, since ints and strs are subclasses of object + hash_a(42) + hash_a("foo") + + # Typechecks, since Any is compatible with all types + hash_b(42) + hash_b("foo") + +Use :class:`object` to indicate that a value could be any type in a typesafe +manner. Use :data:`Any` to indicate that a value is dynamically typed. + +Classes, functions, and decorators +---------------------------------- + +The module defines the following classes, functions and decorators: + +.. class:: TypeVar + + Type variable. + + Usage:: + + T = TypeVar('T') # Can be anything + A = TypeVar('A', str, bytes) # Must be str or bytes + + Type variables exist primarily for the benefit of static type + checkers. They serve as the parameters for generic types as well + as for generic function definitions. See class Generic for more + information on generic types. Generic functions work as follows:: + + def repeat(x: T, n: int) -> Sequence[T]: + """Return a list containing n references to x.""" + return [x]*n + + def longest(x: A, y: A) -> A: + """Return the longest of two strings.""" + return x if len(x) >= len(y) else y + + The latter example's signature is essentially the overloading + of ``(str, str) -> str`` and ``(bytes, bytes) -> bytes``. Also note + that if the arguments are instances of some subclass of :class:`str`, + the return type is still plain :class:`str`. + + At runtime, ``isinstance(x, T)`` will raise :exc:`TypeError`. In general, + :func:`isinstance` and :func:`issubclass` should not be used with types. + + Type variables may be marked covariant or contravariant by passing + ``covariant=True`` or ``contravariant=True``. See :pep:`484` for more + details. By default type variables are invariant. Alternatively, + a type variable may specify an upper bound using ``bound=``. + This means that an actual type substituted (explicitly or implicitly) + for the type variable must be a subclass of the boundary type, + see :pep:`484`. + +.. class:: Generic + + Abstract base class for generic types. + + A generic type is typically declared by inheriting from an + instantiation of this class with one or more type variables. + For example, a generic mapping type might be defined as:: + + class Mapping(Generic[KT, VT]): + def __getitem__(self, key: KT) -> VT: + ... + # Etc. + + This class can then be used as follows:: + + X = TypeVar('X') + Y = TypeVar('Y') + + def lookup_name(mapping: Mapping[X, Y], key: X, default: Y) -> Y: + try: + return mapping[key] + except KeyError: + return default + +.. class:: Type(Generic[CT_co]) + + A variable annotated with ``C`` may accept a value of type ``C``. In + contrast, a variable annotated with ``Type[C]`` may accept values that are + classes themselves -- specifically, it will accept the *class object* of + ``C``. For example:: + + a = 3 # Has type 'int' + b = int # Has type 'Type[int]' + c = type(a) # Also has type 'Type[int]' + + Note that ``Type[C]`` is covariant:: + + class User: ... + class BasicUser(User): ... + class ProUser(User): ... + class TeamUser(User): ... + + # Accepts User, BasicUser, ProUser, TeamUser, ... + def make_new_user(user_class: Type[User]) -> User: + # ... + return user_class() + + The fact that ``Type[C]`` is covariant implies that all subclasses of + ``C`` should implement the same constructor signature and class method + signatures as ``C``. The type checker should flag violations of this, + but should also allow constructor calls in subclasses that match the + constructor calls in the indicated base class. How the type checker is + required to handle this particular case may change in future revisions of + :pep:`484`. + + The only legal parameters for :class:`Type` are classes, :data:`Any`, + :ref:`type variables `, and unions of any of these types. + For example:: + + def new_non_team_user(user_class: Type[Union[BaseUser, ProUser]]): ... + + ``Type[Any]`` is equivalent to ``Type`` which in turn is equivalent + to ``type``, which is the root of Python's metaclass hierarchy. + + .. versionadded:: 3.5.2 + +.. class:: Iterable(Generic[T_co]) + + A generic version of :class:`collections.abc.Iterable`. + +.. class:: Iterator(Iterable[T_co]) + + A generic version of :class:`collections.abc.Iterator`. + +.. class:: Reversible(Iterable[T_co]) + + A generic version of :class:`collections.abc.Reversible`. + +.. class:: SupportsInt + + An ABC with one abstract method ``__int__``. + +.. class:: SupportsFloat + + An ABC with one abstract method ``__float__``. + +.. class:: SupportsComplex + + An ABC with one abstract method ``__complex__``. + +.. class:: SupportsBytes + + An ABC with one abstract method ``__bytes__``. + +.. class:: SupportsAbs + + An ABC with one abstract method ``__abs__`` that is covariant + in its return type. + +.. class:: SupportsRound + + An ABC with one abstract method ``__round__`` + that is covariant in its return type. + +.. class:: Container(Generic[T_co]) + + A generic version of :class:`collections.abc.Container`. + +.. class:: Hashable + + An alias to :class:`collections.abc.Hashable` + +.. class:: Sized + + An alias to :class:`collections.abc.Sized` + +.. class:: Collection(Sized, Iterable[T_co], Container[T_co]) + + A generic version of :class:`collections.abc.Collection` + + .. versionadded:: 3.6.0 + +.. class:: AbstractSet(Sized, Collection[T_co]) + + A generic version of :class:`collections.abc.Set`. + +.. class:: MutableSet(AbstractSet[T]) + + A generic version of :class:`collections.abc.MutableSet`. + +.. class:: Mapping(Sized, Collection[KT], Generic[VT_co]) + + A generic version of :class:`collections.abc.Mapping`. + This type can be used as follows:: + + def get_position_in_index(word_list: Mapping[str, int], word: str) -> int: + return word_list[word] + +.. class:: MutableMapping(Mapping[KT, VT]) + + A generic version of :class:`collections.abc.MutableMapping`. + +.. class:: Sequence(Reversible[T_co], Collection[T_co]) + + A generic version of :class:`collections.abc.Sequence`. + +.. class:: MutableSequence(Sequence[T]) + + A generic version of :class:`collections.abc.MutableSequence`. + +.. class:: ByteString(Sequence[int]) + + A generic version of :class:`collections.abc.ByteString`. + + This type represents the types :class:`bytes`, :class:`bytearray`, + and :class:`memoryview`. + + As a shorthand for this type, :class:`bytes` can be used to + annotate arguments of any of the types mentioned above. + +.. class:: Deque(deque, MutableSequence[T]) + + A generic version of :class:`collections.deque`. + + .. versionadded:: 3.5.4 + .. versionadded:: 3.6.1 + +.. class:: List(list, MutableSequence[T]) + + Generic version of :class:`list`. + Useful for annotating return types. To annotate arguments it is preferred + to use an abstract collection type such as :class:`Sequence` or + :class:`Iterable`. + + This type may be used as follows:: + + T = TypeVar('T', int, float) + + def vec2(x: T, y: T) -> List[T]: + return [x, y] + + def keep_positives(vector: Sequence[T]) -> List[T]: + return [item for item in vector if item > 0] + +.. class:: Set(set, MutableSet[T]) + + A generic version of :class:`builtins.set `. + Useful for annotating return types. To annotate arguments it is preferred + to use an abstract collection type such as :class:`AbstractSet`. + +.. class:: FrozenSet(frozenset, AbstractSet[T_co]) + + A generic version of :class:`builtins.frozenset `. + +.. class:: MappingView(Sized, Iterable[T_co]) + + A generic version of :class:`collections.abc.MappingView`. + +.. class:: KeysView(MappingView[KT_co], AbstractSet[KT_co]) + + A generic version of :class:`collections.abc.KeysView`. + +.. class:: ItemsView(MappingView, Generic[KT_co, VT_co]) + + A generic version of :class:`collections.abc.ItemsView`. + +.. class:: ValuesView(MappingView[VT_co]) + + A generic version of :class:`collections.abc.ValuesView`. + +.. class:: Awaitable(Generic[T_co]) + + A generic version of :class:`collections.abc.Awaitable`. + + .. versionadded:: 3.5.2 + +.. class:: Coroutine(Awaitable[V_co], Generic[T_co T_contra, V_co]) + + A generic version of :class:`collections.abc.Coroutine`. + The variance and order of type variables + correspond to those of :class:`Generator`, for example:: + + from typing import List, Coroutine + c = None # type: Coroutine[List[str], str, int] + ... + x = c.send('hi') # type: List[str] + async def bar() -> None: + x = await c # type: int + + .. versionadded:: 3.5.3 + +.. class:: AsyncIterable(Generic[T_co]) + + A generic version of :class:`collections.abc.AsyncIterable`. + + .. versionadded:: 3.5.2 + +.. class:: AsyncIterator(AsyncIterable[T_co]) + + A generic version of :class:`collections.abc.AsyncIterator`. + + .. versionadded:: 3.5.2 + +.. class:: ContextManager(Generic[T_co]) + + A generic version of :class:`contextlib.AbstractContextManager`. + + .. versionadded:: 3.5.4 + .. versionadded:: 3.6.0 + +.. class:: AsyncContextManager(Generic[T_co]) + + A generic version of :class:`contextlib.AbstractAsyncContextManager`. + + .. versionadded:: 3.5.4 + .. versionadded:: 3.6.2 + +.. class:: Dict(dict, MutableMapping[KT, VT]) + + A generic version of :class:`dict`. + Useful for annotating return types. To annotate arguments it is preferred + to use an abstract collection type such as :class:`Mapping`. + + This type can be used as follows:: + + def count_words(text: str) -> Dict[str, int]: + ... + +.. class:: DefaultDict(collections.defaultdict, MutableMapping[KT, VT]) + + A generic version of :class:`collections.defaultdict`. + + .. versionadded:: 3.5.2 + +.. class:: OrderedDict(collections.OrderedDict, MutableMapping[KT, VT]) + + A generic version of :class:`collections.OrderedDict`. + + .. versionadded:: 3.7.2 + +.. class:: Counter(collections.Counter, Dict[T, int]) + + A generic version of :class:`collections.Counter`. + + .. versionadded:: 3.5.4 + .. versionadded:: 3.6.1 + +.. class:: ChainMap(collections.ChainMap, MutableMapping[KT, VT]) + + A generic version of :class:`collections.ChainMap`. + + .. versionadded:: 3.5.4 + .. versionadded:: 3.6.1 + +.. class:: Generator(Iterator[T_co], Generic[T_co, T_contra, V_co]) + + A generator can be annotated by the generic type + ``Generator[YieldType, SendType, ReturnType]``. For example:: + + def echo_round() -> Generator[int, float, str]: + sent = yield 0 + while sent >= 0: + sent = yield round(sent) + return 'Done' + + Note that unlike many other generics in the typing module, the ``SendType`` + of :class:`Generator` behaves contravariantly, not covariantly or + invariantly. + + If your generator will only yield values, set the ``SendType`` and + ``ReturnType`` to ``None``:: + + def infinite_stream(start: int) -> Generator[int, None, None]: + while True: + yield start + start += 1 + + Alternatively, annotate your generator as having a return type of + either ``Iterable[YieldType]`` or ``Iterator[YieldType]``:: + + def infinite_stream(start: int) -> Iterator[int]: + while True: + yield start + start += 1 + +.. class:: AsyncGenerator(AsyncIterator[T_co], Generic[T_co, T_contra]) + + An async generator can be annotated by the generic type + ``AsyncGenerator[YieldType, SendType]``. For example:: + + async def echo_round() -> AsyncGenerator[int, float]: + sent = yield 0 + while sent >= 0.0: + rounded = await round(sent) + sent = yield rounded + + Unlike normal generators, async generators cannot return a value, so there + is no ``ReturnType`` type parameter. As with :class:`Generator`, the + ``SendType`` behaves contravariantly. + + If your generator will only yield values, set the ``SendType`` to + ``None``:: + + async def infinite_stream(start: int) -> AsyncGenerator[int, None]: + while True: + yield start + start = await increment(start) + + Alternatively, annotate your generator as having a return type of + either ``AsyncIterable[YieldType]`` or ``AsyncIterator[YieldType]``:: + + async def infinite_stream(start: int) -> AsyncIterator[int]: + while True: + yield start + start = await increment(start) + + .. versionadded:: 3.6.1 + +.. class:: Text + + ``Text`` is an alias for ``str``. It is provided to supply a forward + compatible path for Python 2 code: in Python 2, ``Text`` is an alias for + ``unicode``. + + Use ``Text`` to indicate that a value must contain a unicode string in + a manner that is compatible with both Python 2 and Python 3:: + + def add_unicode_checkmark(text: Text) -> Text: + return text + u' \u2713' + + .. versionadded:: 3.5.2 + +.. class:: IO + TextIO + BinaryIO + + Generic type ``IO[AnyStr]`` and its subclasses ``TextIO(IO[str])`` + and ``BinaryIO(IO[bytes])`` + represent the types of I/O streams such as returned by + :func:`open`. + +.. class:: Pattern + Match + + These type aliases + correspond to the return types from :func:`re.compile` and + :func:`re.match`. These types (and the corresponding functions) + are generic in ``AnyStr`` and can be made specific by writing + ``Pattern[str]``, ``Pattern[bytes]``, ``Match[str]``, or + ``Match[bytes]``. + +.. class:: NamedTuple + + Typed version of :func:`collections.namedtuple`. + + Usage:: + + class Employee(NamedTuple): + name: str + id: int + + This is equivalent to:: + + Employee = collections.namedtuple('Employee', ['name', 'id']) + + To give a field a default value, you can assign to it in the class body:: + + class Employee(NamedTuple): + name: str + id: int = 3 + + employee = Employee('Guido') + assert employee.id == 3 + + Fields with a default value must come after any fields without a default. + + The resulting class has two extra attributes: ``_field_types``, + giving a dict mapping field names to types, and ``_field_defaults``, a dict + mapping field names to default values. (The field names are in the + ``_fields`` attribute, which is part of the namedtuple API.) + + ``NamedTuple`` subclasses can also have docstrings and methods:: + + class Employee(NamedTuple): + """Represents an employee.""" + name: str + id: int = 3 + + def __repr__(self) -> str: + return f'' + + Backward-compatible usage:: + + Employee = NamedTuple('Employee', [('name', str), ('id', int)]) + + .. versionchanged:: 3.6 + Added support for :pep:`526` variable annotation syntax. + + .. versionchanged:: 3.6.1 + Added support for default values, methods, and docstrings. + +.. class:: ForwardRef + + A class used for internal typing representation of string forward references. + For example, ``List["SomeClass"]`` is implicitly transformed into + ``List[ForwardRef("SomeClass")]``. This class should not be instantiated by + a user, but may be used by introspection tools. + +.. function:: NewType(typ) + + A helper function to indicate a distinct types to a typechecker, + see :ref:`distinct`. At runtime it returns a function that returns + its argument. Usage:: + + UserId = NewType('UserId', int) + first_user = UserId(1) + + .. versionadded:: 3.5.2 + +.. function:: cast(typ, val) + + Cast a value to a type. + + This returns the value unchanged. To the type checker this + signals that the return value has the designated type, but at + runtime we intentionally don't check anything (we want this + to be as fast as possible). + +.. function:: get_type_hints(obj[, globals[, locals]]) + + Return a dictionary containing type hints for a function, method, module + or class object. + + This is often the same as ``obj.__annotations__``. In addition, + forward references encoded as string literals are handled by evaluating + them in ``globals`` and ``locals`` namespaces. If necessary, + ``Optional[t]`` is added for function and method annotations if a default + value equal to ``None`` is set. For a class ``C``, return + a dictionary constructed by merging all the ``__annotations__`` along + ``C.__mro__`` in reverse order. + +.. decorator:: overload + + The ``@overload`` decorator allows describing functions and methods + that support multiple different combinations of argument types. A series + of ``@overload``-decorated definitions must be followed by exactly one + non-``@overload``-decorated definition (for the same function/method). + The ``@overload``-decorated definitions are for the benefit of the + type checker only, since they will be overwritten by the + non-``@overload``-decorated definition, while the latter is used at + runtime but should be ignored by a type checker. At runtime, calling + a ``@overload``-decorated function directly will raise + :exc:`NotImplementedError`. An example of overload that gives a more + precise type than can be expressed using a union or a type variable:: + + @overload + def process(response: None) -> None: + ... + @overload + def process(response: int) -> Tuple[int, str]: + ... + @overload + def process(response: bytes) -> str: + ... + def process(response): + + + See :pep:`484` for details and comparison with other typing semantics. + +.. decorator:: no_type_check + + Decorator to indicate that annotations are not type hints. + + This works as class or function :term:`decorator`. With a class, it + applies recursively to all methods defined in that class (but not + to methods defined in its superclasses or subclasses). + + This mutates the function(s) in place. + +.. decorator:: no_type_check_decorator + + Decorator to give another decorator the :func:`no_type_check` effect. + + This wraps the decorator with something that wraps the decorated + function in :func:`no_type_check`. + +.. decorator:: type_check_only + + Decorator to mark a class or function to be unavailable at runtime. + + This decorator is itself not available at runtime. It is mainly + intended to mark classes that are defined in type stub files if + an implementation returns an instance of a private class:: + + @type_check_only + class Response: # private or not available at runtime + code: int + def get_header(self, name: str) -> str: ... + + def fetch_response() -> Response: ... + + Note that returning instances of private classes is not recommended. + It is usually preferable to make such classes public. + +.. data:: Any + + Special type indicating an unconstrained type. + + * Every type is compatible with :data:`Any`. + * :data:`Any` is compatible with every type. + +.. data:: NoReturn + + Special type indicating that a function never returns. + For example:: + + from typing import NoReturn + + def stop() -> NoReturn: + raise RuntimeError('no way') + + .. versionadded:: 3.5.4 + .. versionadded:: 3.6.2 + +.. data:: Union + + Union type; ``Union[X, Y]`` means either X or Y. + + To define a union, use e.g. ``Union[int, str]``. Details: + + * The arguments must be types and there must be at least one. + + * Unions of unions are flattened, e.g.:: + + Union[Union[int, str], float] == Union[int, str, float] + + * Unions of a single argument vanish, e.g.:: + + Union[int] == int # The constructor actually returns int + + * Redundant arguments are skipped, e.g.:: + + Union[int, str, int] == Union[int, str] + + * When comparing unions, the argument order is ignored, e.g.:: + + Union[int, str] == Union[str, int] + + * You cannot subclass or instantiate a union. + + * You cannot write ``Union[X][Y]``. + + * You can use ``Optional[X]`` as a shorthand for ``Union[X, None]``. + + .. versionchanged:: 3.7 + Don't remove explicit subclasses from unions at runtime. + +.. data:: Optional + + Optional type. + + ``Optional[X]`` is equivalent to ``Union[X, None]``. + + Note that this is not the same concept as an optional argument, + which is one that has a default. An optional argument with a + default does not require the ``Optional`` qualifier on its type + annotation just because it is optional. For example:: + + def foo(arg: int = 0) -> None: + ... + + On the other hand, if an explicit value of ``None`` is allowed, the + use of ``Optional`` is appropriate, whether the argument is optional + or not. For example:: + + def foo(arg: Optional[int] = None) -> None: + ... + +.. data:: Tuple + + Tuple type; ``Tuple[X, Y]`` is the type of a tuple of two items + with the first item of type X and the second of type Y. + + Example: ``Tuple[T1, T2]`` is a tuple of two elements corresponding + to type variables T1 and T2. ``Tuple[int, float, str]`` is a tuple + of an int, a float and a string. + + To specify a variable-length tuple of homogeneous type, + use literal ellipsis, e.g. ``Tuple[int, ...]``. A plain :data:`Tuple` + is equivalent to ``Tuple[Any, ...]``, and in turn to :class:`tuple`. + +.. data:: Callable + + Callable type; ``Callable[[int], str]`` is a function of (int) -> str. + + The subscription syntax must always be used with exactly two + values: the argument list and the return type. The argument list + must be a list of types or an ellipsis; the return type must be + a single type. + + There is no syntax to indicate optional or keyword arguments; + such function types are rarely used as callback types. + ``Callable[..., ReturnType]`` (literal ellipsis) can be used to + type hint a callable taking any number of arguments and returning + ``ReturnType``. A plain :data:`Callable` is equivalent to + ``Callable[..., Any]``, and in turn to + :class:`collections.abc.Callable`. + +.. data:: ClassVar + + Special type construct to mark class variables. + + As introduced in :pep:`526`, a variable annotation wrapped in ClassVar + indicates that a given attribute is intended to be used as a class variable + and should not be set on instances of that class. Usage:: + + class Starship: + stats: ClassVar[Dict[str, int]] = {} # class variable + damage: int = 10 # instance variable + + :data:`ClassVar` accepts only types and cannot be further subscribed. + + :data:`ClassVar` is not a class itself, and should not + be used with :func:`isinstance` or :func:`issubclass`. + :data:`ClassVar` does not change Python runtime behavior, but + it can be used by third-party type checkers. For example, a type checker + might flag the following code as an error:: + + enterprise_d = Starship(3000) + enterprise_d.stats = {} # Error, setting class variable on instance + Starship.stats = {} # This is OK + + .. versionadded:: 3.5.3 + +.. data:: AnyStr + + ``AnyStr`` is a type variable defined as + ``AnyStr = TypeVar('AnyStr', str, bytes)``. + + It is meant to be used for functions that may accept any kind of string + without allowing different kinds of strings to mix. For example:: + + def concat(a: AnyStr, b: AnyStr) -> AnyStr: + return a + b + + concat(u"foo", u"bar") # Ok, output has type 'unicode' + concat(b"foo", b"bar") # Ok, output has type 'bytes' + concat(u"foo", b"bar") # Error, cannot mix unicode and bytes + +.. data:: TYPE_CHECKING + + A special constant that is assumed to be ``True`` by 3rd party static + type checkers. It is ``False`` at runtime. Usage:: + + if TYPE_CHECKING: + import expensive_mod + + def fun(arg: 'expensive_mod.SomeType') -> None: + local_var: expensive_mod.AnotherType = other_fun() + + Note that the first type annotation must be enclosed in quotes, making it a + "forward reference", to hide the ``expensive_mod`` reference from the + interpreter runtime. Type annotations for local variables are not + evaluated, so the second annotation does not need to be enclosed in quotes. + + .. versionadded:: 3.5.2 diff --git a/python-3.7.4-docs-html/_sources/library/undoc.rst.txt b/python-3.7.4-docs-html/_sources/library/undoc.rst.txt new file mode 100644 index 0000000..2444080 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/undoc.rst.txt @@ -0,0 +1,26 @@ +.. _undoc: + +******************** +Undocumented Modules +******************** + +Here's a quick listing of modules that are currently undocumented, but that +should be documented. Feel free to contribute documentation for them! (Send +via email to docs@python.org.) + +The idea and original contents for this chapter were taken from a posting by +Fredrik Lundh; the specific contents of this chapter have been substantially +revised. + + +Platform specific modules +========================= + +These modules are used to implement the :mod:`os.path` module, and are not +documented beyond this mention. There's little need to document these. + +:mod:`ntpath` + --- Implementation of :mod:`os.path` on Win32 and Win64 platforms. + +:mod:`posixpath` + --- Implementation of :mod:`os.path` on POSIX. diff --git a/python-3.7.4-docs-html/_sources/library/unicodedata.rst.txt b/python-3.7.4-docs-html/_sources/library/unicodedata.rst.txt new file mode 100644 index 0000000..59548f3 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/unicodedata.rst.txt @@ -0,0 +1,173 @@ +:mod:`unicodedata` --- Unicode Database +======================================= + +.. module:: unicodedata + :synopsis: Access the Unicode Database. + +.. moduleauthor:: Marc-André Lemburg +.. sectionauthor:: Marc-André Lemburg +.. sectionauthor:: Martin v. Löwis + +.. index:: + single: Unicode + single: character + pair: Unicode; database + +-------------- + +This module provides access to the Unicode Character Database (UCD) which +defines character properties for all Unicode characters. The data contained in +this database is compiled from the `UCD version 11.0.0 +`_. + +The module uses the same names and symbols as defined by Unicode +Standard Annex #44, `"Unicode Character Database" +`_. It defines the +following functions: + + +.. function:: lookup(name) + + Look up character by name. If a character with the given name is found, return + the corresponding character. If not found, :exc:`KeyError` is raised. + + .. versionchanged:: 3.3 + Support for name aliases [#]_ and named sequences [#]_ has been added. + + +.. function:: name(chr[, default]) + + Returns the name assigned to the character *chr* as a string. If no + name is defined, *default* is returned, or, if not given, :exc:`ValueError` is + raised. + + +.. function:: decimal(chr[, default]) + + Returns the decimal value assigned to the character *chr* as integer. + If no such value is defined, *default* is returned, or, if not given, + :exc:`ValueError` is raised. + + +.. function:: digit(chr[, default]) + + Returns the digit value assigned to the character *chr* as integer. + If no such value is defined, *default* is returned, or, if not given, + :exc:`ValueError` is raised. + + +.. function:: numeric(chr[, default]) + + Returns the numeric value assigned to the character *chr* as float. + If no such value is defined, *default* is returned, or, if not given, + :exc:`ValueError` is raised. + + +.. function:: category(chr) + + Returns the general category assigned to the character *chr* as + string. + + +.. function:: bidirectional(chr) + + Returns the bidirectional class assigned to the character *chr* as + string. If no such value is defined, an empty string is returned. + + +.. function:: combining(chr) + + Returns the canonical combining class assigned to the character *chr* + as integer. Returns ``0`` if no combining class is defined. + + +.. function:: east_asian_width(chr) + + Returns the east asian width assigned to the character *chr* as + string. + + +.. function:: mirrored(chr) + + Returns the mirrored property assigned to the character *chr* as + integer. Returns ``1`` if the character has been identified as a "mirrored" + character in bidirectional text, ``0`` otherwise. + + +.. function:: decomposition(chr) + + Returns the character decomposition mapping assigned to the character + *chr* as string. An empty string is returned in case no such mapping is + defined. + + +.. function:: normalize(form, unistr) + + Return the normal form *form* for the Unicode string *unistr*. Valid values for + *form* are 'NFC', 'NFKC', 'NFD', and 'NFKD'. + + The Unicode standard defines various normalization forms of a Unicode string, + based on the definition of canonical equivalence and compatibility equivalence. + In Unicode, several characters can be expressed in various way. For example, the + character U+00C7 (LATIN CAPITAL LETTER C WITH CEDILLA) can also be expressed as + the sequence U+0043 (LATIN CAPITAL LETTER C) U+0327 (COMBINING CEDILLA). + + For each character, there are two normal forms: normal form C and normal form D. + Normal form D (NFD) is also known as canonical decomposition, and translates + each character into its decomposed form. Normal form C (NFC) first applies a + canonical decomposition, then composes pre-combined characters again. + + In addition to these two forms, there are two additional normal forms based on + compatibility equivalence. In Unicode, certain characters are supported which + normally would be unified with other characters. For example, U+2160 (ROMAN + NUMERAL ONE) is really the same thing as U+0049 (LATIN CAPITAL LETTER I). + However, it is supported in Unicode for compatibility with existing character + sets (e.g. gb2312). + + The normal form KD (NFKD) will apply the compatibility decomposition, i.e. + replace all compatibility characters with their equivalents. The normal form KC + (NFKC) first applies the compatibility decomposition, followed by the canonical + composition. + + Even if two unicode strings are normalized and look the same to + a human reader, if one has combining characters and the other + doesn't, they may not compare equal. + + +In addition, the module exposes the following constant: + +.. data:: unidata_version + + The version of the Unicode database used in this module. + + +.. data:: ucd_3_2_0 + + This is an object that has the same methods as the entire module, but uses the + Unicode database version 3.2 instead, for applications that require this + specific version of the Unicode database (such as IDNA). + +Examples: + + >>> import unicodedata + >>> unicodedata.lookup('LEFT CURLY BRACKET') + '{' + >>> unicodedata.name('/') + 'SOLIDUS' + >>> unicodedata.decimal('9') + 9 + >>> unicodedata.decimal('a') + Traceback (most recent call last): + File "", line 1, in + ValueError: not a decimal + >>> unicodedata.category('A') # 'L'etter, 'u'ppercase + 'Lu' + >>> unicodedata.bidirectional('\u0660') # 'A'rabic, 'N'umber + 'AN' + + +.. rubric:: Footnotes + +.. [#] http://www.unicode.org/Public/11.0.0/ucd/NameAliases.txt + +.. [#] http://www.unicode.org/Public/11.0.0/ucd/NamedSequences.txt diff --git a/python-3.7.4-docs-html/_sources/library/unittest.mock-examples.rst.txt b/python-3.7.4-docs-html/_sources/library/unittest.mock-examples.rst.txt new file mode 100644 index 0000000..00b9bc1 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/unittest.mock-examples.rst.txt @@ -0,0 +1,1266 @@ +:mod:`unittest.mock` --- getting started +======================================== + +.. moduleauthor:: Michael Foord +.. currentmodule:: unittest.mock + +.. versionadded:: 3.3 + + +.. _getting-started: + +Using Mock +---------- + +Mock Patching Methods +~~~~~~~~~~~~~~~~~~~~~ + +Common uses for :class:`Mock` objects include: + +* Patching methods +* Recording method calls on objects + +You might want to replace a method on an object to check that +it is called with the correct arguments by another part of the system: + + >>> real = SomeClass() + >>> real.method = MagicMock(name='method') + >>> real.method(3, 4, 5, key='value') + + +Once our mock has been used (``real.method`` in this example) it has methods +and attributes that allow you to make assertions about how it has been used. + +.. note:: + + In most of these examples the :class:`Mock` and :class:`MagicMock` classes + are interchangeable. As the ``MagicMock`` is the more capable class it makes + a sensible one to use by default. + +Once the mock has been called its :attr:`~Mock.called` attribute is set to +``True``. More importantly we can use the :meth:`~Mock.assert_called_with` or +:meth:`~Mock.assert_called_once_with` method to check that it was called with +the correct arguments. + +This example tests that calling ``ProductionClass().method`` results in a call to +the ``something`` method: + + >>> class ProductionClass: + ... def method(self): + ... self.something(1, 2, 3) + ... def something(self, a, b, c): + ... pass + ... + >>> real = ProductionClass() + >>> real.something = MagicMock() + >>> real.method() + >>> real.something.assert_called_once_with(1, 2, 3) + + + +Mock for Method Calls on an Object +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In the last example we patched a method directly on an object to check that it +was called correctly. Another common use case is to pass an object into a +method (or some part of the system under test) and then check that it is used +in the correct way. + +The simple ``ProductionClass`` below has a ``closer`` method. If it is called with +an object then it calls ``close`` on it. + + >>> class ProductionClass: + ... def closer(self, something): + ... something.close() + ... + +So to test it we need to pass in an object with a ``close`` method and check +that it was called correctly. + + >>> real = ProductionClass() + >>> mock = Mock() + >>> real.closer(mock) + >>> mock.close.assert_called_with() + +We don't have to do any work to provide the 'close' method on our mock. +Accessing close creates it. So, if 'close' hasn't already been called then +accessing it in the test will create it, but :meth:`~Mock.assert_called_with` +will raise a failure exception. + + +Mocking Classes +~~~~~~~~~~~~~~~ + +A common use case is to mock out classes instantiated by your code under test. +When you patch a class, then that class is replaced with a mock. Instances +are created by *calling the class*. This means you access the "mock instance" +by looking at the return value of the mocked class. + +In the example below we have a function ``some_function`` that instantiates ``Foo`` +and calls a method on it. The call to :func:`patch` replaces the class ``Foo`` with a +mock. The ``Foo`` instance is the result of calling the mock, so it is configured +by modifying the mock :attr:`~Mock.return_value`. + + >>> def some_function(): + ... instance = module.Foo() + ... return instance.method() + ... + >>> with patch('module.Foo') as mock: + ... instance = mock.return_value + ... instance.method.return_value = 'the result' + ... result = some_function() + ... assert result == 'the result' + + +Naming your mocks +~~~~~~~~~~~~~~~~~ + +It can be useful to give your mocks a name. The name is shown in the repr of +the mock and can be helpful when the mock appears in test failure messages. The +name is also propagated to attributes or methods of the mock: + + >>> mock = MagicMock(name='foo') + >>> mock + + >>> mock.method + + + +Tracking all Calls +~~~~~~~~~~~~~~~~~~ + +Often you want to track more than a single call to a method. The +:attr:`~Mock.mock_calls` attribute records all calls +to child attributes of the mock - and also to their children. + + >>> mock = MagicMock() + >>> mock.method() + + >>> mock.attribute.method(10, x=53) + + >>> mock.mock_calls + [call.method(), call.attribute.method(10, x=53)] + +If you make an assertion about ``mock_calls`` and any unexpected methods +have been called, then the assertion will fail. This is useful because as well +as asserting that the calls you expected have been made, you are also checking +that they were made in the right order and with no additional calls: + +You use the :data:`call` object to construct lists for comparing with +``mock_calls``: + + >>> expected = [call.method(), call.attribute.method(10, x=53)] + >>> mock.mock_calls == expected + True + +However, parameters to calls that return mocks are not recorded, which means it is not +possible to track nested calls where the parameters used to create ancestors are important: + + >>> m = Mock() + >>> m.factory(important=True).deliver() + + >>> m.mock_calls[-1] == call.factory(important=False).deliver() + True + + +Setting Return Values and Attributes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Setting the return values on a mock object is trivially easy: + + >>> mock = Mock() + >>> mock.return_value = 3 + >>> mock() + 3 + +Of course you can do the same for methods on the mock: + + >>> mock = Mock() + >>> mock.method.return_value = 3 + >>> mock.method() + 3 + +The return value can also be set in the constructor: + + >>> mock = Mock(return_value=3) + >>> mock() + 3 + +If you need an attribute setting on your mock, just do it: + + >>> mock = Mock() + >>> mock.x = 3 + >>> mock.x + 3 + +Sometimes you want to mock up a more complex situation, like for example +``mock.connection.cursor().execute("SELECT 1")``. If we wanted this call to +return a list, then we have to configure the result of the nested call. + +We can use :data:`call` to construct the set of calls in a "chained call" like +this for easy assertion afterwards: + + >>> mock = Mock() + >>> cursor = mock.connection.cursor.return_value + >>> cursor.execute.return_value = ['foo'] + >>> mock.connection.cursor().execute("SELECT 1") + ['foo'] + >>> expected = call.connection.cursor().execute("SELECT 1").call_list() + >>> mock.mock_calls + [call.connection.cursor(), call.connection.cursor().execute('SELECT 1')] + >>> mock.mock_calls == expected + True + +It is the call to ``.call_list()`` that turns our call object into a list of +calls representing the chained calls. + + +Raising exceptions with mocks +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A useful attribute is :attr:`~Mock.side_effect`. If you set this to an +exception class or instance then the exception will be raised when the mock +is called. + + >>> mock = Mock(side_effect=Exception('Boom!')) + >>> mock() + Traceback (most recent call last): + ... + Exception: Boom! + + +Side effect functions and iterables +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +``side_effect`` can also be set to a function or an iterable. The use case for +``side_effect`` as an iterable is where your mock is going to be called several +times, and you want each call to return a different value. When you set +``side_effect`` to an iterable every call to the mock returns the next value +from the iterable: + + >>> mock = MagicMock(side_effect=[4, 5, 6]) + >>> mock() + 4 + >>> mock() + 5 + >>> mock() + 6 + + +For more advanced use cases, like dynamically varying the return values +depending on what the mock is called with, ``side_effect`` can be a function. +The function will be called with the same arguments as the mock. Whatever the +function returns is what the call returns: + + >>> vals = {(1, 2): 1, (2, 3): 2} + >>> def side_effect(*args): + ... return vals[args] + ... + >>> mock = MagicMock(side_effect=side_effect) + >>> mock(1, 2) + 1 + >>> mock(2, 3) + 2 + + +Creating a Mock from an Existing Object +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +One problem with over use of mocking is that it couples your tests to the +implementation of your mocks rather than your real code. Suppose you have a +class that implements ``some_method``. In a test for another class, you +provide a mock of this object that *also* provides ``some_method``. If later +you refactor the first class, so that it no longer has ``some_method`` - then +your tests will continue to pass even though your code is now broken! + +:class:`Mock` allows you to provide an object as a specification for the mock, +using the *spec* keyword argument. Accessing methods / attributes on the +mock that don't exist on your specification object will immediately raise an +attribute error. If you change the implementation of your specification, then +tests that use that class will start failing immediately without you having to +instantiate the class in those tests. + + >>> mock = Mock(spec=SomeClass) + >>> mock.old_method() + Traceback (most recent call last): + ... + AttributeError: object has no attribute 'old_method' + +Using a specification also enables a smarter matching of calls made to the +mock, regardless of whether some parameters were passed as positional or +named arguments:: + + >>> def f(a, b, c): pass + ... + >>> mock = Mock(spec=f) + >>> mock(1, 2, 3) + + >>> mock.assert_called_with(a=1, b=2, c=3) + +If you want this smarter matching to also work with method calls on the mock, +you can use :ref:`auto-speccing `. + +If you want a stronger form of specification that prevents the setting +of arbitrary attributes as well as the getting of them then you can use +*spec_set* instead of *spec*. + + + +Patch Decorators +---------------- + +.. note:: + + With :func:`patch` it matters that you patch objects in the namespace where + they are looked up. This is normally straightforward, but for a quick guide + read :ref:`where to patch `. + + +A common need in tests is to patch a class attribute or a module attribute, +for example patching a builtin or patching a class in a module to test that it +is instantiated. Modules and classes are effectively global, so patching on +them has to be undone after the test or the patch will persist into other +tests and cause hard to diagnose problems. + +mock provides three convenient decorators for this: :func:`patch`, :func:`patch.object` and +:func:`patch.dict`. ``patch`` takes a single string, of the form +``package.module.Class.attribute`` to specify the attribute you are patching. It +also optionally takes a value that you want the attribute (or class or +whatever) to be replaced with. 'patch.object' takes an object and the name of +the attribute you would like patched, plus optionally the value to patch it +with. + +``patch.object``: + + >>> original = SomeClass.attribute + >>> @patch.object(SomeClass, 'attribute', sentinel.attribute) + ... def test(): + ... assert SomeClass.attribute == sentinel.attribute + ... + >>> test() + >>> assert SomeClass.attribute == original + + >>> @patch('package.module.attribute', sentinel.attribute) + ... def test(): + ... from package.module import attribute + ... assert attribute is sentinel.attribute + ... + >>> test() + +If you are patching a module (including :mod:`builtins`) then use :func:`patch` +instead of :func:`patch.object`: + + >>> mock = MagicMock(return_value=sentinel.file_handle) + >>> with patch('builtins.open', mock): + ... handle = open('filename', 'r') + ... + >>> mock.assert_called_with('filename', 'r') + >>> assert handle == sentinel.file_handle, "incorrect file handle returned" + +The module name can be 'dotted', in the form ``package.module`` if needed: + + >>> @patch('package.module.ClassName.attribute', sentinel.attribute) + ... def test(): + ... from package.module import ClassName + ... assert ClassName.attribute == sentinel.attribute + ... + >>> test() + +A nice pattern is to actually decorate test methods themselves: + + >>> class MyTest(unittest.TestCase): + ... @patch.object(SomeClass, 'attribute', sentinel.attribute) + ... def test_something(self): + ... self.assertEqual(SomeClass.attribute, sentinel.attribute) + ... + >>> original = SomeClass.attribute + >>> MyTest('test_something').test_something() + >>> assert SomeClass.attribute == original + +If you want to patch with a Mock, you can use :func:`patch` with only one argument +(or :func:`patch.object` with two arguments). The mock will be created for you and +passed into the test function / method: + + >>> class MyTest(unittest.TestCase): + ... @patch.object(SomeClass, 'static_method') + ... def test_something(self, mock_method): + ... SomeClass.static_method() + ... mock_method.assert_called_with() + ... + >>> MyTest('test_something').test_something() + +You can stack up multiple patch decorators using this pattern: + + >>> class MyTest(unittest.TestCase): + ... @patch('package.module.ClassName1') + ... @patch('package.module.ClassName2') + ... def test_something(self, MockClass2, MockClass1): + ... self.assertIs(package.module.ClassName1, MockClass1) + ... self.assertIs(package.module.ClassName2, MockClass2) + ... + >>> MyTest('test_something').test_something() + +When you nest patch decorators the mocks are passed in to the decorated +function in the same order they applied (the normal *Python* order that +decorators are applied). This means from the bottom up, so in the example +above the mock for ``test_module.ClassName2`` is passed in first. + +There is also :func:`patch.dict` for setting values in a dictionary just +during a scope and restoring the dictionary to its original state when the test +ends: + + >>> foo = {'key': 'value'} + >>> original = foo.copy() + >>> with patch.dict(foo, {'newkey': 'newvalue'}, clear=True): + ... assert foo == {'newkey': 'newvalue'} + ... + >>> assert foo == original + +``patch``, ``patch.object`` and ``patch.dict`` can all be used as context managers. + +Where you use :func:`patch` to create a mock for you, you can get a reference to the +mock using the "as" form of the with statement: + + >>> class ProductionClass: + ... def method(self): + ... pass + ... + >>> with patch.object(ProductionClass, 'method') as mock_method: + ... mock_method.return_value = None + ... real = ProductionClass() + ... real.method(1, 2, 3) + ... + >>> mock_method.assert_called_with(1, 2, 3) + + +As an alternative ``patch``, ``patch.object`` and ``patch.dict`` can be used as +class decorators. When used in this way it is the same as applying the +decorator individually to every method whose name starts with "test". + + +.. _further-examples: + +Further Examples +---------------- + + +Here are some more examples for some slightly more advanced scenarios. + + +Mocking chained calls +~~~~~~~~~~~~~~~~~~~~~ + +Mocking chained calls is actually straightforward with mock once you +understand the :attr:`~Mock.return_value` attribute. When a mock is called for +the first time, or you fetch its ``return_value`` before it has been called, a +new :class:`Mock` is created. + +This means that you can see how the object returned from a call to a mocked +object has been used by interrogating the ``return_value`` mock: + + >>> mock = Mock() + >>> mock().foo(a=2, b=3) + + >>> mock.return_value.foo.assert_called_with(a=2, b=3) + +From here it is a simple step to configure and then make assertions about +chained calls. Of course another alternative is writing your code in a more +testable way in the first place... + +So, suppose we have some code that looks a little bit like this: + + >>> class Something: + ... def __init__(self): + ... self.backend = BackendProvider() + ... def method(self): + ... response = self.backend.get_endpoint('foobar').create_call('spam', 'eggs').start_call() + ... # more code + +Assuming that ``BackendProvider`` is already well tested, how do we test +``method()``? Specifically, we want to test that the code section ``# more +code`` uses the response object in the correct way. + +As this chain of calls is made from an instance attribute we can monkey patch +the ``backend`` attribute on a ``Something`` instance. In this particular case +we are only interested in the return value from the final call to +``start_call`` so we don't have much configuration to do. Let's assume the +object it returns is 'file-like', so we'll ensure that our response object +uses the builtin :func:`open` as its ``spec``. + +To do this we create a mock instance as our mock backend and create a mock +response object for it. To set the response as the return value for that final +``start_call`` we could do this:: + + mock_backend.get_endpoint.return_value.create_call.return_value.start_call.return_value = mock_response + +We can do that in a slightly nicer way using the :meth:`~Mock.configure_mock` +method to directly set the return value for us: + + >>> something = Something() + >>> mock_response = Mock(spec=open) + >>> mock_backend = Mock() + >>> config = {'get_endpoint.return_value.create_call.return_value.start_call.return_value': mock_response} + >>> mock_backend.configure_mock(**config) + +With these we monkey patch the "mock backend" in place and can make the real +call: + + >>> something.backend = mock_backend + >>> something.method() + +Using :attr:`~Mock.mock_calls` we can check the chained call with a single +assert. A chained call is several calls in one line of code, so there will be +several entries in ``mock_calls``. We can use :meth:`call.call_list` to create +this list of calls for us: + + >>> chained = call.get_endpoint('foobar').create_call('spam', 'eggs').start_call() + >>> call_list = chained.call_list() + >>> assert mock_backend.mock_calls == call_list + + +Partial mocking +~~~~~~~~~~~~~~~ + +In some tests I wanted to mock out a call to :meth:`datetime.date.today` +to return a known date, but I didn't want to prevent the code under test from +creating new date objects. Unfortunately :class:`datetime.date` is written in C, and +so I couldn't just monkey-patch out the static :meth:`date.today` method. + +I found a simple way of doing this that involved effectively wrapping the date +class with a mock, but passing through calls to the constructor to the real +class (and returning real instances). + +The :func:`patch decorator ` is used here to +mock out the ``date`` class in the module under test. The :attr:`side_effect` +attribute on the mock date class is then set to a lambda function that returns +a real date. When the mock date class is called a real date will be +constructed and returned by ``side_effect``. + + >>> from datetime import date + >>> with patch('mymodule.date') as mock_date: + ... mock_date.today.return_value = date(2010, 10, 8) + ... mock_date.side_effect = lambda *args, **kw: date(*args, **kw) + ... + ... assert mymodule.date.today() == date(2010, 10, 8) + ... assert mymodule.date(2009, 6, 8) == date(2009, 6, 8) + ... + +Note that we don't patch :class:`datetime.date` globally, we patch ``date`` in the +module that *uses* it. See :ref:`where to patch `. + +When ``date.today()`` is called a known date is returned, but calls to the +``date(...)`` constructor still return normal dates. Without this you can find +yourself having to calculate an expected result using exactly the same +algorithm as the code under test, which is a classic testing anti-pattern. + +Calls to the date constructor are recorded in the ``mock_date`` attributes +(``call_count`` and friends) which may also be useful for your tests. + +An alternative way of dealing with mocking dates, or other builtin classes, +is discussed in `this blog entry +`_. + + +Mocking a Generator Method +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A Python generator is a function or method that uses the :keyword:`yield` statement +to return a series of values when iterated over [#]_. + +A generator method / function is called to return the generator object. It is +the generator object that is then iterated over. The protocol method for +iteration is :meth:`~container.__iter__`, so we can +mock this using a :class:`MagicMock`. + +Here's an example class with an "iter" method implemented as a generator: + + >>> class Foo: + ... def iter(self): + ... for i in [1, 2, 3]: + ... yield i + ... + >>> foo = Foo() + >>> list(foo.iter()) + [1, 2, 3] + + +How would we mock this class, and in particular its "iter" method? + +To configure the values returned from the iteration (implicit in the call to +:class:`list`), we need to configure the object returned by the call to ``foo.iter()``. + + >>> mock_foo = MagicMock() + >>> mock_foo.iter.return_value = iter([1, 2, 3]) + >>> list(mock_foo.iter()) + [1, 2, 3] + +.. [#] There are also generator expressions and more `advanced uses + `_ of generators, but we aren't + concerned about them here. A very good introduction to generators and how + powerful they are is: `Generator Tricks for Systems Programmers + `_. + + +Applying the same patch to every test method +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If you want several patches in place for multiple test methods the obvious way +is to apply the patch decorators to every method. This can feel like unnecessary +repetition. For Python 2.6 or more recent you can use :func:`patch` (in all its +various forms) as a class decorator. This applies the patches to all test +methods on the class. A test method is identified by methods whose names start +with ``test``: + + >>> @patch('mymodule.SomeClass') + ... class MyTest(TestCase): + ... + ... def test_one(self, MockSomeClass): + ... self.assertIs(mymodule.SomeClass, MockSomeClass) + ... + ... def test_two(self, MockSomeClass): + ... self.assertIs(mymodule.SomeClass, MockSomeClass) + ... + ... def not_a_test(self): + ... return 'something' + ... + >>> MyTest('test_one').test_one() + >>> MyTest('test_two').test_two() + >>> MyTest('test_two').not_a_test() + 'something' + +An alternative way of managing patches is to use the :ref:`start-and-stop`. +These allow you to move the patching into your ``setUp`` and ``tearDown`` methods. + + >>> class MyTest(TestCase): + ... def setUp(self): + ... self.patcher = patch('mymodule.foo') + ... self.mock_foo = self.patcher.start() + ... + ... def test_foo(self): + ... self.assertIs(mymodule.foo, self.mock_foo) + ... + ... def tearDown(self): + ... self.patcher.stop() + ... + >>> MyTest('test_foo').run() + +If you use this technique you must ensure that the patching is "undone" by +calling ``stop``. This can be fiddlier than you might think, because if an +exception is raised in the setUp then tearDown is not called. +:meth:`unittest.TestCase.addCleanup` makes this easier: + + >>> class MyTest(TestCase): + ... def setUp(self): + ... patcher = patch('mymodule.foo') + ... self.addCleanup(patcher.stop) + ... self.mock_foo = patcher.start() + ... + ... def test_foo(self): + ... self.assertIs(mymodule.foo, self.mock_foo) + ... + >>> MyTest('test_foo').run() + + +Mocking Unbound Methods +~~~~~~~~~~~~~~~~~~~~~~~ + +Whilst writing tests today I needed to patch an *unbound method* (patching the +method on the class rather than on the instance). I needed self to be passed +in as the first argument because I want to make asserts about which objects +were calling this particular method. The issue is that you can't patch with a +mock for this, because if you replace an unbound method with a mock it doesn't +become a bound method when fetched from the instance, and so it doesn't get +self passed in. The workaround is to patch the unbound method with a real +function instead. The :func:`patch` decorator makes it so simple to +patch out methods with a mock that having to create a real function becomes a +nuisance. + +If you pass ``autospec=True`` to patch then it does the patching with a +*real* function object. This function object has the same signature as the one +it is replacing, but delegates to a mock under the hood. You still get your +mock auto-created in exactly the same way as before. What it means though, is +that if you use it to patch out an unbound method on a class the mocked +function will be turned into a bound method if it is fetched from an instance. +It will have ``self`` passed in as the first argument, which is exactly what I +wanted: + + >>> class Foo: + ... def foo(self): + ... pass + ... + >>> with patch.object(Foo, 'foo', autospec=True) as mock_foo: + ... mock_foo.return_value = 'foo' + ... foo = Foo() + ... foo.foo() + ... + 'foo' + >>> mock_foo.assert_called_once_with(foo) + +If we don't use ``autospec=True`` then the unbound method is patched out +with a Mock instance instead, and isn't called with ``self``. + + +Checking multiple calls with mock +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +mock has a nice API for making assertions about how your mock objects are used. + + >>> mock = Mock() + >>> mock.foo_bar.return_value = None + >>> mock.foo_bar('baz', spam='eggs') + >>> mock.foo_bar.assert_called_with('baz', spam='eggs') + +If your mock is only being called once you can use the +:meth:`assert_called_once_with` method that also asserts that the +:attr:`call_count` is one. + + >>> mock.foo_bar.assert_called_once_with('baz', spam='eggs') + >>> mock.foo_bar() + >>> mock.foo_bar.assert_called_once_with('baz', spam='eggs') + Traceback (most recent call last): + ... + AssertionError: Expected to be called once. Called 2 times. + +Both ``assert_called_with`` and ``assert_called_once_with`` make assertions about +the *most recent* call. If your mock is going to be called several times, and +you want to make assertions about *all* those calls you can use +:attr:`~Mock.call_args_list`: + + >>> mock = Mock(return_value=None) + >>> mock(1, 2, 3) + >>> mock(4, 5, 6) + >>> mock() + >>> mock.call_args_list + [call(1, 2, 3), call(4, 5, 6), call()] + +The :data:`call` helper makes it easy to make assertions about these calls. You +can build up a list of expected calls and compare it to ``call_args_list``. This +looks remarkably similar to the repr of the ``call_args_list``: + + >>> expected = [call(1, 2, 3), call(4, 5, 6), call()] + >>> mock.call_args_list == expected + True + + +Coping with mutable arguments +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Another situation is rare, but can bite you, is when your mock is called with +mutable arguments. ``call_args`` and ``call_args_list`` store *references* to the +arguments. If the arguments are mutated by the code under test then you can no +longer make assertions about what the values were when the mock was called. + +Here's some example code that shows the problem. Imagine the following functions +defined in 'mymodule':: + + def frob(val): + pass + + def grob(val): + "First frob and then clear val" + frob(val) + val.clear() + +When we try to test that ``grob`` calls ``frob`` with the correct argument look +what happens: + + >>> with patch('mymodule.frob') as mock_frob: + ... val = {6} + ... mymodule.grob(val) + ... + >>> val + set() + >>> mock_frob.assert_called_with({6}) + Traceback (most recent call last): + ... + AssertionError: Expected: (({6},), {}) + Called with: ((set(),), {}) + +One possibility would be for mock to copy the arguments you pass in. This +could then cause problems if you do assertions that rely on object identity +for equality. + +Here's one solution that uses the :attr:`side_effect` +functionality. If you provide a ``side_effect`` function for a mock then +``side_effect`` will be called with the same args as the mock. This gives us an +opportunity to copy the arguments and store them for later assertions. In this +example I'm using *another* mock to store the arguments so that I can use the +mock methods for doing the assertion. Again a helper function sets this up for +me. + + >>> from copy import deepcopy + >>> from unittest.mock import Mock, patch, DEFAULT + >>> def copy_call_args(mock): + ... new_mock = Mock() + ... def side_effect(*args, **kwargs): + ... args = deepcopy(args) + ... kwargs = deepcopy(kwargs) + ... new_mock(*args, **kwargs) + ... return DEFAULT + ... mock.side_effect = side_effect + ... return new_mock + ... + >>> with patch('mymodule.frob') as mock_frob: + ... new_mock = copy_call_args(mock_frob) + ... val = {6} + ... mymodule.grob(val) + ... + >>> new_mock.assert_called_with({6}) + >>> new_mock.call_args + call({6}) + +``copy_call_args`` is called with the mock that will be called. It returns a new +mock that we do the assertion on. The ``side_effect`` function makes a copy of +the args and calls our ``new_mock`` with the copy. + +.. note:: + + If your mock is only going to be used once there is an easier way of + checking arguments at the point they are called. You can simply do the + checking inside a ``side_effect`` function. + + >>> def side_effect(arg): + ... assert arg == {6} + ... + >>> mock = Mock(side_effect=side_effect) + >>> mock({6}) + >>> mock(set()) + Traceback (most recent call last): + ... + AssertionError + +An alternative approach is to create a subclass of :class:`Mock` or +:class:`MagicMock` that copies (using :func:`copy.deepcopy`) the arguments. +Here's an example implementation: + + >>> from copy import deepcopy + >>> class CopyingMock(MagicMock): + ... def __call__(self, *args, **kwargs): + ... args = deepcopy(args) + ... kwargs = deepcopy(kwargs) + ... return super(CopyingMock, self).__call__(*args, **kwargs) + ... + >>> c = CopyingMock(return_value=None) + >>> arg = set() + >>> c(arg) + >>> arg.add(1) + >>> c.assert_called_with(set()) + >>> c.assert_called_with(arg) + Traceback (most recent call last): + ... + AssertionError: Expected call: mock({1}) + Actual call: mock(set()) + >>> c.foo + + +When you subclass ``Mock`` or ``MagicMock`` all dynamically created attributes, +and the ``return_value`` will use your subclass automatically. That means all +children of a ``CopyingMock`` will also have the type ``CopyingMock``. + + +Nesting Patches +~~~~~~~~~~~~~~~ + +Using patch as a context manager is nice, but if you do multiple patches you +can end up with nested with statements indenting further and further to the +right: + + >>> class MyTest(TestCase): + ... + ... def test_foo(self): + ... with patch('mymodule.Foo') as mock_foo: + ... with patch('mymodule.Bar') as mock_bar: + ... with patch('mymodule.Spam') as mock_spam: + ... assert mymodule.Foo is mock_foo + ... assert mymodule.Bar is mock_bar + ... assert mymodule.Spam is mock_spam + ... + >>> original = mymodule.Foo + >>> MyTest('test_foo').test_foo() + >>> assert mymodule.Foo is original + +With unittest ``cleanup`` functions and the :ref:`start-and-stop` we can +achieve the same effect without the nested indentation. A simple helper +method, ``create_patch``, puts the patch in place and returns the created mock +for us: + + >>> class MyTest(TestCase): + ... + ... def create_patch(self, name): + ... patcher = patch(name) + ... thing = patcher.start() + ... self.addCleanup(patcher.stop) + ... return thing + ... + ... def test_foo(self): + ... mock_foo = self.create_patch('mymodule.Foo') + ... mock_bar = self.create_patch('mymodule.Bar') + ... mock_spam = self.create_patch('mymodule.Spam') + ... + ... assert mymodule.Foo is mock_foo + ... assert mymodule.Bar is mock_bar + ... assert mymodule.Spam is mock_spam + ... + >>> original = mymodule.Foo + >>> MyTest('test_foo').run() + >>> assert mymodule.Foo is original + + +Mocking a dictionary with MagicMock +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You may want to mock a dictionary, or other container object, recording all +access to it whilst having it still behave like a dictionary. + +We can do this with :class:`MagicMock`, which will behave like a dictionary, +and using :data:`~Mock.side_effect` to delegate dictionary access to a real +underlying dictionary that is under our control. + +When the :meth:`__getitem__` and :meth:`__setitem__` methods of our ``MagicMock`` are called +(normal dictionary access) then ``side_effect`` is called with the key (and in +the case of ``__setitem__`` the value too). We can also control what is returned. + +After the ``MagicMock`` has been used we can use attributes like +:data:`~Mock.call_args_list` to assert about how the dictionary was used: + + >>> my_dict = {'a': 1, 'b': 2, 'c': 3} + >>> def getitem(name): + ... return my_dict[name] + ... + >>> def setitem(name, val): + ... my_dict[name] = val + ... + >>> mock = MagicMock() + >>> mock.__getitem__.side_effect = getitem + >>> mock.__setitem__.side_effect = setitem + +.. note:: + + An alternative to using ``MagicMock`` is to use ``Mock`` and *only* provide + the magic methods you specifically want: + + >>> mock = Mock() + >>> mock.__getitem__ = Mock(side_effect=getitem) + >>> mock.__setitem__ = Mock(side_effect=setitem) + + A *third* option is to use ``MagicMock`` but passing in ``dict`` as the *spec* + (or *spec_set*) argument so that the ``MagicMock`` created only has + dictionary magic methods available: + + >>> mock = MagicMock(spec_set=dict) + >>> mock.__getitem__.side_effect = getitem + >>> mock.__setitem__.side_effect = setitem + +With these side effect functions in place, the ``mock`` will behave like a normal +dictionary but recording the access. It even raises a :exc:`KeyError` if you try +to access a key that doesn't exist. + + >>> mock['a'] + 1 + >>> mock['c'] + 3 + >>> mock['d'] + Traceback (most recent call last): + ... + KeyError: 'd' + >>> mock['b'] = 'fish' + >>> mock['d'] = 'eggs' + >>> mock['b'] + 'fish' + >>> mock['d'] + 'eggs' + +After it has been used you can make assertions about the access using the normal +mock methods and attributes: + + >>> mock.__getitem__.call_args_list + [call('a'), call('c'), call('d'), call('b'), call('d')] + >>> mock.__setitem__.call_args_list + [call('b', 'fish'), call('d', 'eggs')] + >>> my_dict + {'a': 1, 'c': 3, 'b': 'fish', 'd': 'eggs'} + + +Mock subclasses and their attributes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +There are various reasons why you might want to subclass :class:`Mock`. One +reason might be to add helper methods. Here's a silly example: + + >>> class MyMock(MagicMock): + ... def has_been_called(self): + ... return self.called + ... + >>> mymock = MyMock(return_value=None) + >>> mymock + + >>> mymock.has_been_called() + False + >>> mymock() + >>> mymock.has_been_called() + True + +The standard behaviour for ``Mock`` instances is that attributes and the return +value mocks are of the same type as the mock they are accessed on. This ensures +that ``Mock`` attributes are ``Mocks`` and ``MagicMock`` attributes are ``MagicMocks`` +[#]_. So if you're subclassing to add helper methods then they'll also be +available on the attributes and return value mock of instances of your +subclass. + + >>> mymock.foo + + >>> mymock.foo.has_been_called() + False + >>> mymock.foo() + + >>> mymock.foo.has_been_called() + True + +Sometimes this is inconvenient. For example, `one user +`_ is subclassing mock to +created a `Twisted adaptor +`_. +Having this applied to attributes too actually causes errors. + +``Mock`` (in all its flavours) uses a method called ``_get_child_mock`` to create +these "sub-mocks" for attributes and return values. You can prevent your +subclass being used for attributes by overriding this method. The signature is +that it takes arbitrary keyword arguments (``**kwargs``) which are then passed +onto the mock constructor: + + >>> class Subclass(MagicMock): + ... def _get_child_mock(self, **kwargs): + ... return MagicMock(**kwargs) + ... + >>> mymock = Subclass() + >>> mymock.foo + + >>> assert isinstance(mymock, Subclass) + >>> assert not isinstance(mymock.foo, Subclass) + >>> assert not isinstance(mymock(), Subclass) + +.. [#] An exception to this rule are the non-callable mocks. Attributes use the + callable variant because otherwise non-callable mocks couldn't have callable + methods. + + +Mocking imports with patch.dict +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +One situation where mocking can be hard is where you have a local import inside +a function. These are harder to mock because they aren't using an object from +the module namespace that we can patch out. + +Generally local imports are to be avoided. They are sometimes done to prevent +circular dependencies, for which there is *usually* a much better way to solve +the problem (refactor the code) or to prevent "up front costs" by delaying the +import. This can also be solved in better ways than an unconditional local +import (store the module as a class or module attribute and only do the import +on first use). + +That aside there is a way to use ``mock`` to affect the results of an import. +Importing fetches an *object* from the :data:`sys.modules` dictionary. Note that it +fetches an *object*, which need not be a module. Importing a module for the +first time results in a module object being put in `sys.modules`, so usually +when you import something you get a module back. This need not be the case +however. + +This means you can use :func:`patch.dict` to *temporarily* put a mock in place +in :data:`sys.modules`. Any imports whilst this patch is active will fetch the mock. +When the patch is complete (the decorated function exits, the with statement +body is complete or ``patcher.stop()`` is called) then whatever was there +previously will be restored safely. + +Here's an example that mocks out the 'fooble' module. + + >>> mock = Mock() + >>> with patch.dict('sys.modules', {'fooble': mock}): + ... import fooble + ... fooble.blob() + ... + + >>> assert 'fooble' not in sys.modules + >>> mock.blob.assert_called_once_with() + +As you can see the ``import fooble`` succeeds, but on exit there is no 'fooble' +left in :data:`sys.modules`. + +This also works for the ``from module import name`` form: + + >>> mock = Mock() + >>> with patch.dict('sys.modules', {'fooble': mock}): + ... from fooble import blob + ... blob.blip() + ... + + >>> mock.blob.blip.assert_called_once_with() + +With slightly more work you can also mock package imports: + + >>> mock = Mock() + >>> modules = {'package': mock, 'package.module': mock.module} + >>> with patch.dict('sys.modules', modules): + ... from package.module import fooble + ... fooble() + ... + + >>> mock.module.fooble.assert_called_once_with() + + +Tracking order of calls and less verbose call assertions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The :class:`Mock` class allows you to track the *order* of method calls on +your mock objects through the :attr:`~Mock.method_calls` attribute. This +doesn't allow you to track the order of calls between separate mock objects, +however we can use :attr:`~Mock.mock_calls` to achieve the same effect. + +Because mocks track calls to child mocks in ``mock_calls``, and accessing an +arbitrary attribute of a mock creates a child mock, we can create our separate +mocks from a parent one. Calls to those child mock will then all be recorded, +in order, in the ``mock_calls`` of the parent: + + >>> manager = Mock() + >>> mock_foo = manager.foo + >>> mock_bar = manager.bar + + >>> mock_foo.something() + + >>> mock_bar.other.thing() + + + >>> manager.mock_calls + [call.foo.something(), call.bar.other.thing()] + +We can then assert about the calls, including the order, by comparing with +the ``mock_calls`` attribute on the manager mock: + + >>> expected_calls = [call.foo.something(), call.bar.other.thing()] + >>> manager.mock_calls == expected_calls + True + +If ``patch`` is creating, and putting in place, your mocks then you can attach +them to a manager mock using the :meth:`~Mock.attach_mock` method. After +attaching calls will be recorded in ``mock_calls`` of the manager. + + >>> manager = MagicMock() + >>> with patch('mymodule.Class1') as MockClass1: + ... with patch('mymodule.Class2') as MockClass2: + ... manager.attach_mock(MockClass1, 'MockClass1') + ... manager.attach_mock(MockClass2, 'MockClass2') + ... MockClass1().foo() + ... MockClass2().bar() + ... + + + >>> manager.mock_calls + [call.MockClass1(), + call.MockClass1().foo(), + call.MockClass2(), + call.MockClass2().bar()] + +If many calls have been made, but you're only interested in a particular +sequence of them then an alternative is to use the +:meth:`~Mock.assert_has_calls` method. This takes a list of calls (constructed +with the :data:`call` object). If that sequence of calls are in +:attr:`~Mock.mock_calls` then the assert succeeds. + + >>> m = MagicMock() + >>> m().foo().bar().baz() + + >>> m.one().two().three() + + >>> calls = call.one().two().three().call_list() + >>> m.assert_has_calls(calls) + +Even though the chained call ``m.one().two().three()`` aren't the only calls that +have been made to the mock, the assert still succeeds. + +Sometimes a mock may have several calls made to it, and you are only interested +in asserting about *some* of those calls. You may not even care about the +order. In this case you can pass ``any_order=True`` to ``assert_has_calls``: + + >>> m = MagicMock() + >>> m(1), m.two(2, 3), m.seven(7), m.fifty('50') + (...) + >>> calls = [call.fifty('50'), call(1), call.seven(7)] + >>> m.assert_has_calls(calls, any_order=True) + + +More complex argument matching +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Using the same basic concept as :data:`ANY` we can implement matchers to do more +complex assertions on objects used as arguments to mocks. + +Suppose we expect some object to be passed to a mock that by default +compares equal based on object identity (which is the Python default for user +defined classes). To use :meth:`~Mock.assert_called_with` we would need to pass +in the exact same object. If we are only interested in some of the attributes +of this object then we can create a matcher that will check these attributes +for us. + +You can see in this example how a 'standard' call to ``assert_called_with`` isn't +sufficient: + + >>> class Foo: + ... def __init__(self, a, b): + ... self.a, self.b = a, b + ... + >>> mock = Mock(return_value=None) + >>> mock(Foo(1, 2)) + >>> mock.assert_called_with(Foo(1, 2)) + Traceback (most recent call last): + ... + AssertionError: Expected: call(<__main__.Foo object at 0x...>) + Actual call: call(<__main__.Foo object at 0x...>) + +A comparison function for our ``Foo`` class might look something like this: + + >>> def compare(self, other): + ... if not type(self) == type(other): + ... return False + ... if self.a != other.a: + ... return False + ... if self.b != other.b: + ... return False + ... return True + ... + +And a matcher object that can use comparison functions like this for its +equality operation would look something like this: + + >>> class Matcher: + ... def __init__(self, compare, some_obj): + ... self.compare = compare + ... self.some_obj = some_obj + ... def __eq__(self, other): + ... return self.compare(self.some_obj, other) + ... + +Putting all this together: + + >>> match_foo = Matcher(compare, Foo(1, 2)) + >>> mock.assert_called_with(match_foo) + +The ``Matcher`` is instantiated with our compare function and the ``Foo`` object +we want to compare against. In ``assert_called_with`` the ``Matcher`` equality +method will be called, which compares the object the mock was called with +against the one we created our matcher with. If they match then +``assert_called_with`` passes, and if they don't an :exc:`AssertionError` is raised: + + >>> match_wrong = Matcher(compare, Foo(3, 4)) + >>> mock.assert_called_with(match_wrong) + Traceback (most recent call last): + ... + AssertionError: Expected: ((,), {}) + Called with: ((,), {}) + +With a bit of tweaking you could have the comparison function raise the +:exc:`AssertionError` directly and provide a more useful failure message. + +As of version 1.5, the Python testing library `PyHamcrest +`_ provides similar functionality, +that may be useful here, in the form of its equality matcher +(`hamcrest.library.integration.match_equality +`_). diff --git a/python-3.7.4-docs-html/_sources/library/unittest.mock.rst.txt b/python-3.7.4-docs-html/_sources/library/unittest.mock.rst.txt new file mode 100644 index 0000000..b76ae71 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/unittest.mock.rst.txt @@ -0,0 +1,2426 @@ + +:mod:`unittest.mock` --- mock object library +============================================ + +.. module:: unittest.mock + :synopsis: Mock object library. + +.. moduleauthor:: Michael Foord +.. currentmodule:: unittest.mock + +.. versionadded:: 3.3 + +**Source code:** :source:`Lib/unittest/mock.py` + +-------------- + +:mod:`unittest.mock` is a library for testing in Python. It allows you to +replace parts of your system under test with mock objects and make assertions +about how they have been used. + +:mod:`unittest.mock` provides a core :class:`Mock` class removing the need to +create a host of stubs throughout your test suite. After performing an +action, you can make assertions about which methods / attributes were used +and arguments they were called with. You can also specify return values and +set needed attributes in the normal way. + +Additionally, mock provides a :func:`patch` decorator that handles patching +module and class level attributes within the scope of a test, along with +:const:`sentinel` for creating unique objects. See the `quick guide`_ for +some examples of how to use :class:`Mock`, :class:`MagicMock` and +:func:`patch`. + +Mock is very easy to use and is designed for use with :mod:`unittest`. Mock +is based on the 'action -> assertion' pattern instead of 'record -> replay' +used by many mocking frameworks. + +There is a backport of :mod:`unittest.mock` for earlier versions of Python, +available as `mock on PyPI `_. + + +Quick Guide +----------- + +:class:`Mock` and :class:`MagicMock` objects create all attributes and +methods as you access them and store details of how they have been used. You +can configure them, to specify return values or limit what attributes are +available, and then make assertions about how they have been used: + + >>> from unittest.mock import MagicMock + >>> thing = ProductionClass() + >>> thing.method = MagicMock(return_value=3) + >>> thing.method(3, 4, 5, key='value') + 3 + >>> thing.method.assert_called_with(3, 4, 5, key='value') + +:attr:`side_effect` allows you to perform side effects, including raising an +exception when a mock is called: + + >>> mock = Mock(side_effect=KeyError('foo')) + >>> mock() + Traceback (most recent call last): + ... + KeyError: 'foo' + + >>> values = {'a': 1, 'b': 2, 'c': 3} + >>> def side_effect(arg): + ... return values[arg] + ... + >>> mock.side_effect = side_effect + >>> mock('a'), mock('b'), mock('c') + (1, 2, 3) + >>> mock.side_effect = [5, 4, 3, 2, 1] + >>> mock(), mock(), mock() + (5, 4, 3) + +Mock has many other ways you can configure it and control its behaviour. For +example the *spec* argument configures the mock to take its specification +from another object. Attempting to access attributes or methods on the mock +that don't exist on the spec will fail with an :exc:`AttributeError`. + +The :func:`patch` decorator / context manager makes it easy to mock classes or +objects in a module under test. The object you specify will be replaced with a +mock (or other object) during the test and restored when the test ends: + + >>> from unittest.mock import patch + >>> @patch('module.ClassName2') + ... @patch('module.ClassName1') + ... def test(MockClass1, MockClass2): + ... module.ClassName1() + ... module.ClassName2() + ... assert MockClass1 is module.ClassName1 + ... assert MockClass2 is module.ClassName2 + ... assert MockClass1.called + ... assert MockClass2.called + ... + >>> test() + +.. note:: + + When you nest patch decorators the mocks are passed in to the decorated + function in the same order they applied (the normal *Python* order that + decorators are applied). This means from the bottom up, so in the example + above the mock for ``module.ClassName1`` is passed in first. + + With :func:`patch` it matters that you patch objects in the namespace where they + are looked up. This is normally straightforward, but for a quick guide + read :ref:`where to patch `. + +As well as a decorator :func:`patch` can be used as a context manager in a with +statement: + + >>> with patch.object(ProductionClass, 'method', return_value=None) as mock_method: + ... thing = ProductionClass() + ... thing.method(1, 2, 3) + ... + >>> mock_method.assert_called_once_with(1, 2, 3) + + +There is also :func:`patch.dict` for setting values in a dictionary just +during a scope and restoring the dictionary to its original state when the test +ends: + + >>> foo = {'key': 'value'} + >>> original = foo.copy() + >>> with patch.dict(foo, {'newkey': 'newvalue'}, clear=True): + ... assert foo == {'newkey': 'newvalue'} + ... + >>> assert foo == original + +Mock supports the mocking of Python :ref:`magic methods `. The +easiest way of using magic methods is with the :class:`MagicMock` class. It +allows you to do things like: + + >>> mock = MagicMock() + >>> mock.__str__.return_value = 'foobarbaz' + >>> str(mock) + 'foobarbaz' + >>> mock.__str__.assert_called_with() + +Mock allows you to assign functions (or other Mock instances) to magic methods +and they will be called appropriately. The :class:`MagicMock` class is just a Mock +variant that has all of the magic methods pre-created for you (well, all the +useful ones anyway). + +The following is an example of using magic methods with the ordinary Mock +class: + + >>> mock = Mock() + >>> mock.__str__ = Mock(return_value='wheeeeee') + >>> str(mock) + 'wheeeeee' + +For ensuring that the mock objects in your tests have the same api as the +objects they are replacing, you can use :ref:`auto-speccing `. +Auto-speccing can be done through the *autospec* argument to patch, or the +:func:`create_autospec` function. Auto-speccing creates mock objects that +have the same attributes and methods as the objects they are replacing, and +any functions and methods (including constructors) have the same call +signature as the real object. + +This ensures that your mocks will fail in the same way as your production +code if they are used incorrectly: + + >>> from unittest.mock import create_autospec + >>> def function(a, b, c): + ... pass + ... + >>> mock_function = create_autospec(function, return_value='fishy') + >>> mock_function(1, 2, 3) + 'fishy' + >>> mock_function.assert_called_once_with(1, 2, 3) + >>> mock_function('wrong arguments') + Traceback (most recent call last): + ... + TypeError: () takes exactly 3 arguments (1 given) + +:func:`create_autospec` can also be used on classes, where it copies the signature of +the ``__init__`` method, and on callable objects where it copies the signature of +the ``__call__`` method. + + + +The Mock Class +-------------- + + +:class:`Mock` is a flexible mock object intended to replace the use of stubs and +test doubles throughout your code. Mocks are callable and create attributes as +new mocks when you access them [#]_. Accessing the same attribute will always +return the same mock. Mocks record how you use them, allowing you to make +assertions about what your code has done to them. + +:class:`MagicMock` is a subclass of :class:`Mock` with all the magic methods +pre-created and ready to use. There are also non-callable variants, useful +when you are mocking out objects that aren't callable: +:class:`NonCallableMock` and :class:`NonCallableMagicMock` + +The :func:`patch` decorators makes it easy to temporarily replace classes +in a particular module with a :class:`Mock` object. By default :func:`patch` will create +a :class:`MagicMock` for you. You can specify an alternative class of :class:`Mock` using +the *new_callable* argument to :func:`patch`. + + +.. class:: Mock(spec=None, side_effect=None, return_value=DEFAULT, wraps=None, name=None, spec_set=None, unsafe=False, **kwargs) + + Create a new :class:`Mock` object. :class:`Mock` takes several optional arguments + that specify the behaviour of the Mock object: + + * *spec*: This can be either a list of strings or an existing object (a + class or instance) that acts as the specification for the mock object. If + you pass in an object then a list of strings is formed by calling dir on + the object (excluding unsupported magic attributes and methods). + Accessing any attribute not in this list will raise an :exc:`AttributeError`. + + If *spec* is an object (rather than a list of strings) then + :attr:`~instance.__class__` returns the class of the spec object. This + allows mocks to pass :func:`isinstance` tests. + + * *spec_set*: A stricter variant of *spec*. If used, attempting to *set* + or get an attribute on the mock that isn't on the object passed as + *spec_set* will raise an :exc:`AttributeError`. + + * *side_effect*: A function to be called whenever the Mock is called. See + the :attr:`~Mock.side_effect` attribute. Useful for raising exceptions or + dynamically changing return values. The function is called with the same + arguments as the mock, and unless it returns :data:`DEFAULT`, the return + value of this function is used as the return value. + + Alternatively *side_effect* can be an exception class or instance. In + this case the exception will be raised when the mock is called. + + If *side_effect* is an iterable then each call to the mock will return + the next value from the iterable. + + A *side_effect* can be cleared by setting it to ``None``. + + * *return_value*: The value returned when the mock is called. By default + this is a new Mock (created on first access). See the + :attr:`return_value` attribute. + + * *unsafe*: By default if any attribute starts with *assert* or + *assret* will raise an :exc:`AttributeError`. Passing ``unsafe=True`` + will allow access to these attributes. + + .. versionadded:: 3.5 + + * *wraps*: Item for the mock object to wrap. If *wraps* is not ``None`` then + calling the Mock will pass the call through to the wrapped object + (returning the real result). Attribute access on the mock will return a + Mock object that wraps the corresponding attribute of the wrapped + object (so attempting to access an attribute that doesn't exist will + raise an :exc:`AttributeError`). + + If the mock has an explicit *return_value* set then calls are not passed + to the wrapped object and the *return_value* is returned instead. + + * *name*: If the mock has a name then it will be used in the repr of the + mock. This can be useful for debugging. The name is propagated to child + mocks. + + Mocks can also be called with arbitrary keyword arguments. These will be + used to set attributes on the mock after it is created. See the + :meth:`configure_mock` method for details. + + .. method:: assert_called(*args, **kwargs) + + Assert that the mock was called at least once. + + >>> mock = Mock() + >>> mock.method() + + >>> mock.method.assert_called() + + .. versionadded:: 3.6 + + .. method:: assert_called_once(*args, **kwargs) + + Assert that the mock was called exactly once. + + >>> mock = Mock() + >>> mock.method() + + >>> mock.method.assert_called_once() + >>> mock.method() + + >>> mock.method.assert_called_once() + Traceback (most recent call last): + ... + AssertionError: Expected 'method' to have been called once. Called 2 times. + + .. versionadded:: 3.6 + + + .. method:: assert_called_with(*args, **kwargs) + + This method is a convenient way of asserting that calls are made in a + particular way: + + >>> mock = Mock() + >>> mock.method(1, 2, 3, test='wow') + + >>> mock.method.assert_called_with(1, 2, 3, test='wow') + + .. method:: assert_called_once_with(*args, **kwargs) + + Assert that the mock was called exactly once and that that call was + with the specified arguments. + + >>> mock = Mock(return_value=None) + >>> mock('foo', bar='baz') + >>> mock.assert_called_once_with('foo', bar='baz') + >>> mock('other', bar='values') + >>> mock.assert_called_once_with('other', bar='values') + Traceback (most recent call last): + ... + AssertionError: Expected 'mock' to be called once. Called 2 times. + + + .. method:: assert_any_call(*args, **kwargs) + + assert the mock has been called with the specified arguments. + + The assert passes if the mock has *ever* been called, unlike + :meth:`assert_called_with` and :meth:`assert_called_once_with` that + only pass if the call is the most recent one, and in the case of + :meth:`assert_called_once_with` it must also be the only call. + + >>> mock = Mock(return_value=None) + >>> mock(1, 2, arg='thing') + >>> mock('some', 'thing', 'else') + >>> mock.assert_any_call(1, 2, arg='thing') + + + .. method:: assert_has_calls(calls, any_order=False) + + assert the mock has been called with the specified calls. + The :attr:`mock_calls` list is checked for the calls. + + If *any_order* is false (the default) then the calls must be + sequential. There can be extra calls before or after the + specified calls. + + If *any_order* is true then the calls can be in any order, but + they must all appear in :attr:`mock_calls`. + + >>> mock = Mock(return_value=None) + >>> mock(1) + >>> mock(2) + >>> mock(3) + >>> mock(4) + >>> calls = [call(2), call(3)] + >>> mock.assert_has_calls(calls) + >>> calls = [call(4), call(2), call(3)] + >>> mock.assert_has_calls(calls, any_order=True) + + .. method:: assert_not_called() + + Assert the mock was never called. + + >>> m = Mock() + >>> m.hello.assert_not_called() + >>> obj = m.hello() + >>> m.hello.assert_not_called() + Traceback (most recent call last): + ... + AssertionError: Expected 'hello' to not have been called. Called 1 times. + + .. versionadded:: 3.5 + + + .. method:: reset_mock(*, return_value=False, side_effect=False) + + The reset_mock method resets all the call attributes on a mock object: + + >>> mock = Mock(return_value=None) + >>> mock('hello') + >>> mock.called + True + >>> mock.reset_mock() + >>> mock.called + False + + .. versionchanged:: 3.6 + Added two keyword only argument to the reset_mock function. + + This can be useful where you want to make a series of assertions that + reuse the same object. Note that :meth:`reset_mock` *doesn't* clear the + return value, :attr:`side_effect` or any child attributes you have + set using normal assignment by default. In case you want to reset + *return_value* or :attr:`side_effect`, then pass the corresponding + parameter as ``True``. Child mocks and the return value mock + (if any) are reset as well. + + .. note:: *return_value*, and :attr:`side_effect` are keyword only + argument. + + + .. method:: mock_add_spec(spec, spec_set=False) + + Add a spec to a mock. *spec* can either be an object or a + list of strings. Only attributes on the *spec* can be fetched as + attributes from the mock. + + If *spec_set* is true then only attributes on the spec can be set. + + + .. method:: attach_mock(mock, attribute) + + Attach a mock as an attribute of this one, replacing its name and + parent. Calls to the attached mock will be recorded in the + :attr:`method_calls` and :attr:`mock_calls` attributes of this one. + + + .. method:: configure_mock(**kwargs) + + Set attributes on the mock through keyword arguments. + + Attributes plus return values and side effects can be set on child + mocks using standard dot notation and unpacking a dictionary in the + method call: + + >>> mock = Mock() + >>> attrs = {'method.return_value': 3, 'other.side_effect': KeyError} + >>> mock.configure_mock(**attrs) + >>> mock.method() + 3 + >>> mock.other() + Traceback (most recent call last): + ... + KeyError + + The same thing can be achieved in the constructor call to mocks: + + >>> attrs = {'method.return_value': 3, 'other.side_effect': KeyError} + >>> mock = Mock(some_attribute='eggs', **attrs) + >>> mock.some_attribute + 'eggs' + >>> mock.method() + 3 + >>> mock.other() + Traceback (most recent call last): + ... + KeyError + + :meth:`configure_mock` exists to make it easier to do configuration + after the mock has been created. + + + .. method:: __dir__() + + :class:`Mock` objects limit the results of ``dir(some_mock)`` to useful results. + For mocks with a *spec* this includes all the permitted attributes + for the mock. + + See :data:`FILTER_DIR` for what this filtering does, and how to + switch it off. + + + .. method:: _get_child_mock(**kw) + + Create the child mocks for attributes and return value. + By default child mocks will be the same type as the parent. + Subclasses of Mock may want to override this to customize the way + child mocks are made. + + For non-callable mocks the callable variant will be used (rather than + any custom subclass). + + + .. attribute:: called + + A boolean representing whether or not the mock object has been called: + + >>> mock = Mock(return_value=None) + >>> mock.called + False + >>> mock() + >>> mock.called + True + + .. attribute:: call_count + + An integer telling you how many times the mock object has been called: + + >>> mock = Mock(return_value=None) + >>> mock.call_count + 0 + >>> mock() + >>> mock() + >>> mock.call_count + 2 + + + .. attribute:: return_value + + Set this to configure the value returned by calling the mock: + + >>> mock = Mock() + >>> mock.return_value = 'fish' + >>> mock() + 'fish' + + The default return value is a mock object and you can configure it in + the normal way: + + >>> mock = Mock() + >>> mock.return_value.attribute = sentinel.Attribute + >>> mock.return_value() + + >>> mock.return_value.assert_called_with() + + :attr:`return_value` can also be set in the constructor: + + >>> mock = Mock(return_value=3) + >>> mock.return_value + 3 + >>> mock() + 3 + + + .. attribute:: side_effect + + This can either be a function to be called when the mock is called, + an iterable or an exception (class or instance) to be raised. + + If you pass in a function it will be called with same arguments as the + mock and unless the function returns the :data:`DEFAULT` singleton the + call to the mock will then return whatever the function returns. If the + function returns :data:`DEFAULT` then the mock will return its normal + value (from the :attr:`return_value`). + + If you pass in an iterable, it is used to retrieve an iterator which + must yield a value on every call. This value can either be an exception + instance to be raised, or a value to be returned from the call to the + mock (:data:`DEFAULT` handling is identical to the function case). + + An example of a mock that raises an exception (to test exception + handling of an API): + + >>> mock = Mock() + >>> mock.side_effect = Exception('Boom!') + >>> mock() + Traceback (most recent call last): + ... + Exception: Boom! + + Using :attr:`side_effect` to return a sequence of values: + + >>> mock = Mock() + >>> mock.side_effect = [3, 2, 1] + >>> mock(), mock(), mock() + (3, 2, 1) + + Using a callable: + + >>> mock = Mock(return_value=3) + >>> def side_effect(*args, **kwargs): + ... return DEFAULT + ... + >>> mock.side_effect = side_effect + >>> mock() + 3 + + :attr:`side_effect` can be set in the constructor. Here's an example that + adds one to the value the mock is called with and returns it: + + >>> side_effect = lambda value: value + 1 + >>> mock = Mock(side_effect=side_effect) + >>> mock(3) + 4 + >>> mock(-8) + -7 + + Setting :attr:`side_effect` to ``None`` clears it: + + >>> m = Mock(side_effect=KeyError, return_value=3) + >>> m() + Traceback (most recent call last): + ... + KeyError + >>> m.side_effect = None + >>> m() + 3 + + + .. attribute:: call_args + + This is either ``None`` (if the mock hasn't been called), or the + arguments that the mock was last called with. This will be in the + form of a tuple: the first member is any ordered arguments the mock + was called with (or an empty tuple) and the second member is any + keyword arguments (or an empty dictionary). + + >>> mock = Mock(return_value=None) + >>> print(mock.call_args) + None + >>> mock() + >>> mock.call_args + call() + >>> mock.call_args == () + True + >>> mock(3, 4) + >>> mock.call_args + call(3, 4) + >>> mock.call_args == ((3, 4),) + True + >>> mock(3, 4, 5, key='fish', next='w00t!') + >>> mock.call_args + call(3, 4, 5, key='fish', next='w00t!') + + :attr:`call_args`, along with members of the lists :attr:`call_args_list`, + :attr:`method_calls` and :attr:`mock_calls` are :data:`call` objects. + These are tuples, so they can be unpacked to get at the individual + arguments and make more complex assertions. See + :ref:`calls as tuples `. + + + .. attribute:: call_args_list + + This is a list of all the calls made to the mock object in sequence + (so the length of the list is the number of times it has been + called). Before any calls have been made it is an empty list. The + :data:`call` object can be used for conveniently constructing lists of + calls to compare with :attr:`call_args_list`. + + >>> mock = Mock(return_value=None) + >>> mock() + >>> mock(3, 4) + >>> mock(key='fish', next='w00t!') + >>> mock.call_args_list + [call(), call(3, 4), call(key='fish', next='w00t!')] + >>> expected = [(), ((3, 4),), ({'key': 'fish', 'next': 'w00t!'},)] + >>> mock.call_args_list == expected + True + + Members of :attr:`call_args_list` are :data:`call` objects. These can be + unpacked as tuples to get at the individual arguments. See + :ref:`calls as tuples `. + + + .. attribute:: method_calls + + As well as tracking calls to themselves, mocks also track calls to + methods and attributes, and *their* methods and attributes: + + >>> mock = Mock() + >>> mock.method() + + >>> mock.property.method.attribute() + + >>> mock.method_calls + [call.method(), call.property.method.attribute()] + + Members of :attr:`method_calls` are :data:`call` objects. These can be + unpacked as tuples to get at the individual arguments. See + :ref:`calls as tuples `. + + + .. attribute:: mock_calls + + :attr:`mock_calls` records *all* calls to the mock object, its methods, + magic methods *and* return value mocks. + + >>> mock = MagicMock() + >>> result = mock(1, 2, 3) + >>> mock.first(a=3) + + >>> mock.second() + + >>> int(mock) + 1 + >>> result(1) + + >>> expected = [call(1, 2, 3), call.first(a=3), call.second(), + ... call.__int__(), call()(1)] + >>> mock.mock_calls == expected + True + + Members of :attr:`mock_calls` are :data:`call` objects. These can be + unpacked as tuples to get at the individual arguments. See + :ref:`calls as tuples `. + + .. note:: + + The way :attr:`mock_calls` are recorded means that where nested + calls are made, the parameters of ancestor calls are not recorded + and so will always compare equal: + + >>> mock = MagicMock() + >>> mock.top(a=3).bottom() + + >>> mock.mock_calls + [call.top(a=3), call.top().bottom()] + >>> mock.mock_calls[-1] == call.top(a=-1).bottom() + True + + .. attribute:: __class__ + + Normally the :attr:`__class__` attribute of an object will return its type. + For a mock object with a :attr:`spec`, ``__class__`` returns the spec class + instead. This allows mock objects to pass :func:`isinstance` tests for the + object they are replacing / masquerading as: + + >>> mock = Mock(spec=3) + >>> isinstance(mock, int) + True + + :attr:`__class__` is assignable to, this allows a mock to pass an + :func:`isinstance` check without forcing you to use a spec: + + >>> mock = Mock() + >>> mock.__class__ = dict + >>> isinstance(mock, dict) + True + +.. class:: NonCallableMock(spec=None, wraps=None, name=None, spec_set=None, **kwargs) + + A non-callable version of :class:`Mock`. The constructor parameters have the same + meaning of :class:`Mock`, with the exception of *return_value* and *side_effect* + which have no meaning on a non-callable mock. + +Mock objects that use a class or an instance as a :attr:`spec` or +:attr:`spec_set` are able to pass :func:`isinstance` tests: + + >>> mock = Mock(spec=SomeClass) + >>> isinstance(mock, SomeClass) + True + >>> mock = Mock(spec_set=SomeClass()) + >>> isinstance(mock, SomeClass) + True + +The :class:`Mock` classes have support for mocking magic methods. See :ref:`magic +methods ` for the full details. + +The mock classes and the :func:`patch` decorators all take arbitrary keyword +arguments for configuration. For the :func:`patch` decorators the keywords are +passed to the constructor of the mock being created. The keyword arguments +are for configuring attributes of the mock: + + >>> m = MagicMock(attribute=3, other='fish') + >>> m.attribute + 3 + >>> m.other + 'fish' + +The return value and side effect of child mocks can be set in the same way, +using dotted notation. As you can't use dotted names directly in a call you +have to create a dictionary and unpack it using ``**``: + + >>> attrs = {'method.return_value': 3, 'other.side_effect': KeyError} + >>> mock = Mock(some_attribute='eggs', **attrs) + >>> mock.some_attribute + 'eggs' + >>> mock.method() + 3 + >>> mock.other() + Traceback (most recent call last): + ... + KeyError + +A callable mock which was created with a *spec* (or a *spec_set*) will +introspect the specification object's signature when matching calls to +the mock. Therefore, it can match the actual call's arguments regardless +of whether they were passed positionally or by name:: + + >>> def f(a, b, c): pass + ... + >>> mock = Mock(spec=f) + >>> mock(1, 2, c=3) + + >>> mock.assert_called_with(1, 2, 3) + >>> mock.assert_called_with(a=1, b=2, c=3) + +This applies to :meth:`~Mock.assert_called_with`, +:meth:`~Mock.assert_called_once_with`, :meth:`~Mock.assert_has_calls` and +:meth:`~Mock.assert_any_call`. When :ref:`auto-speccing`, it will also +apply to method calls on the mock object. + + .. versionchanged:: 3.4 + Added signature introspection on specced and autospecced mock objects. + + +.. class:: PropertyMock(*args, **kwargs) + + A mock intended to be used as a property, or other descriptor, on a class. + :class:`PropertyMock` provides :meth:`__get__` and :meth:`__set__` methods + so you can specify a return value when it is fetched. + + Fetching a :class:`PropertyMock` instance from an object calls the mock, with + no args. Setting it calls the mock with the value being set. + + >>> class Foo: + ... @property + ... def foo(self): + ... return 'something' + ... @foo.setter + ... def foo(self, value): + ... pass + ... + >>> with patch('__main__.Foo.foo', new_callable=PropertyMock) as mock_foo: + ... mock_foo.return_value = 'mockity-mock' + ... this_foo = Foo() + ... print(this_foo.foo) + ... this_foo.foo = 6 + ... + mockity-mock + >>> mock_foo.mock_calls + [call(), call(6)] + +Because of the way mock attributes are stored you can't directly attach a +:class:`PropertyMock` to a mock object. Instead you can attach it to the mock type +object:: + + >>> m = MagicMock() + >>> p = PropertyMock(return_value=3) + >>> type(m).foo = p + >>> m.foo + 3 + >>> p.assert_called_once_with() + + +Calling +~~~~~~~ + +Mock objects are callable. The call will return the value set as the +:attr:`~Mock.return_value` attribute. The default return value is a new Mock +object; it is created the first time the return value is accessed (either +explicitly or by calling the Mock) - but it is stored and the same one +returned each time. + +Calls made to the object will be recorded in the attributes +like :attr:`~Mock.call_args` and :attr:`~Mock.call_args_list`. + +If :attr:`~Mock.side_effect` is set then it will be called after the call has +been recorded, so if :attr:`side_effect` raises an exception the call is still +recorded. + +The simplest way to make a mock raise an exception when called is to make +:attr:`~Mock.side_effect` an exception class or instance: + + >>> m = MagicMock(side_effect=IndexError) + >>> m(1, 2, 3) + Traceback (most recent call last): + ... + IndexError + >>> m.mock_calls + [call(1, 2, 3)] + >>> m.side_effect = KeyError('Bang!') + >>> m('two', 'three', 'four') + Traceback (most recent call last): + ... + KeyError: 'Bang!' + >>> m.mock_calls + [call(1, 2, 3), call('two', 'three', 'four')] + +If :attr:`side_effect` is a function then whatever that function returns is what +calls to the mock return. The :attr:`side_effect` function is called with the +same arguments as the mock. This allows you to vary the return value of the +call dynamically, based on the input: + + >>> def side_effect(value): + ... return value + 1 + ... + >>> m = MagicMock(side_effect=side_effect) + >>> m(1) + 2 + >>> m(2) + 3 + >>> m.mock_calls + [call(1), call(2)] + +If you want the mock to still return the default return value (a new mock), or +any set return value, then there are two ways of doing this. Either return +:attr:`mock.return_value` from inside :attr:`side_effect`, or return :data:`DEFAULT`: + + >>> m = MagicMock() + >>> def side_effect(*args, **kwargs): + ... return m.return_value + ... + >>> m.side_effect = side_effect + >>> m.return_value = 3 + >>> m() + 3 + >>> def side_effect(*args, **kwargs): + ... return DEFAULT + ... + >>> m.side_effect = side_effect + >>> m() + 3 + +To remove a :attr:`side_effect`, and return to the default behaviour, set the +:attr:`side_effect` to ``None``: + + >>> m = MagicMock(return_value=6) + >>> def side_effect(*args, **kwargs): + ... return 3 + ... + >>> m.side_effect = side_effect + >>> m() + 3 + >>> m.side_effect = None + >>> m() + 6 + +The :attr:`side_effect` can also be any iterable object. Repeated calls to the mock +will return values from the iterable (until the iterable is exhausted and +a :exc:`StopIteration` is raised): + + >>> m = MagicMock(side_effect=[1, 2, 3]) + >>> m() + 1 + >>> m() + 2 + >>> m() + 3 + >>> m() + Traceback (most recent call last): + ... + StopIteration + +If any members of the iterable are exceptions they will be raised instead of +returned:: + + >>> iterable = (33, ValueError, 66) + >>> m = MagicMock(side_effect=iterable) + >>> m() + 33 + >>> m() + Traceback (most recent call last): + ... + ValueError + >>> m() + 66 + + +.. _deleting-attributes: + +Deleting Attributes +~~~~~~~~~~~~~~~~~~~ + +Mock objects create attributes on demand. This allows them to pretend to be +objects of any type. + +You may want a mock object to return ``False`` to a :func:`hasattr` call, or raise an +:exc:`AttributeError` when an attribute is fetched. You can do this by providing +an object as a :attr:`spec` for a mock, but that isn't always convenient. + +You "block" attributes by deleting them. Once deleted, accessing an attribute +will raise an :exc:`AttributeError`. + + >>> mock = MagicMock() + >>> hasattr(mock, 'm') + True + >>> del mock.m + >>> hasattr(mock, 'm') + False + >>> del mock.f + >>> mock.f + Traceback (most recent call last): + ... + AttributeError: f + + +Mock names and the name attribute +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Since "name" is an argument to the :class:`Mock` constructor, if you want your +mock object to have a "name" attribute you can't just pass it in at creation +time. There are two alternatives. One option is to use +:meth:`~Mock.configure_mock`:: + + >>> mock = MagicMock() + >>> mock.configure_mock(name='my_name') + >>> mock.name + 'my_name' + +A simpler option is to simply set the "name" attribute after mock creation:: + + >>> mock = MagicMock() + >>> mock.name = "foo" + + +Attaching Mocks as Attributes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +When you attach a mock as an attribute of another mock (or as the return +value) it becomes a "child" of that mock. Calls to the child are recorded in +the :attr:`~Mock.method_calls` and :attr:`~Mock.mock_calls` attributes of the +parent. This is useful for configuring child mocks and then attaching them to +the parent, or for attaching mocks to a parent that records all calls to the +children and allows you to make assertions about the order of calls between +mocks: + + >>> parent = MagicMock() + >>> child1 = MagicMock(return_value=None) + >>> child2 = MagicMock(return_value=None) + >>> parent.child1 = child1 + >>> parent.child2 = child2 + >>> child1(1) + >>> child2(2) + >>> parent.mock_calls + [call.child1(1), call.child2(2)] + +The exception to this is if the mock has a name. This allows you to prevent +the "parenting" if for some reason you don't want it to happen. + + >>> mock = MagicMock() + >>> not_a_child = MagicMock(name='not-a-child') + >>> mock.attribute = not_a_child + >>> mock.attribute() + + >>> mock.mock_calls + [] + +Mocks created for you by :func:`patch` are automatically given names. To +attach mocks that have names to a parent you use the :meth:`~Mock.attach_mock` +method: + + >>> thing1 = object() + >>> thing2 = object() + >>> parent = MagicMock() + >>> with patch('__main__.thing1', return_value=None) as child1: + ... with patch('__main__.thing2', return_value=None) as child2: + ... parent.attach_mock(child1, 'child1') + ... parent.attach_mock(child2, 'child2') + ... child1('one') + ... child2('two') + ... + >>> parent.mock_calls + [call.child1('one'), call.child2('two')] + + +.. [#] The only exceptions are magic methods and attributes (those that have + leading and trailing double underscores). Mock doesn't create these but + instead raises an :exc:`AttributeError`. This is because the interpreter + will often implicitly request these methods, and gets *very* confused to + get a new Mock object when it expects a magic method. If you need magic + method support see :ref:`magic methods `. + + +The patchers +------------ + +The patch decorators are used for patching objects only within the scope of +the function they decorate. They automatically handle the unpatching for you, +even if exceptions are raised. All of these functions can also be used in with +statements or as class decorators. + + +patch +~~~~~ + +.. note:: + + :func:`patch` is straightforward to use. The key is to do the patching in the + right namespace. See the section `where to patch`_. + +.. function:: patch(target, new=DEFAULT, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs) + + :func:`patch` acts as a function decorator, class decorator or a context + manager. Inside the body of the function or with statement, the *target* + is patched with a *new* object. When the function/with statement exits + the patch is undone. + + If *new* is omitted, then the target is replaced with a + :class:`MagicMock`. If :func:`patch` is used as a decorator and *new* is + omitted, the created mock is passed in as an extra argument to the + decorated function. If :func:`patch` is used as a context manager the created + mock is returned by the context manager. + + *target* should be a string in the form ``'package.module.ClassName'``. The + *target* is imported and the specified object replaced with the *new* + object, so the *target* must be importable from the environment you are + calling :func:`patch` from. The target is imported when the decorated function + is executed, not at decoration time. + + The *spec* and *spec_set* keyword arguments are passed to the :class:`MagicMock` + if patch is creating one for you. + + In addition you can pass ``spec=True`` or ``spec_set=True``, which causes + patch to pass in the object being mocked as the spec/spec_set object. + + *new_callable* allows you to specify a different class, or callable object, + that will be called to create the *new* object. By default :class:`MagicMock` is + used. + + A more powerful form of *spec* is *autospec*. If you set ``autospec=True`` + then the mock will be created with a spec from the object being replaced. + All attributes of the mock will also have the spec of the corresponding + attribute of the object being replaced. Methods and functions being mocked + will have their arguments checked and will raise a :exc:`TypeError` if they are + called with the wrong signature. For mocks + replacing a class, their return value (the 'instance') will have the same + spec as the class. See the :func:`create_autospec` function and + :ref:`auto-speccing`. + + Instead of ``autospec=True`` you can pass ``autospec=some_object`` to use an + arbitrary object as the spec instead of the one being replaced. + + By default :func:`patch` will fail to replace attributes that don't exist. + If you pass in ``create=True``, and the attribute doesn't exist, patch will + create the attribute for you when the patched function is called, and delete + it again after the patched function has exited. This is useful for writing + tests against attributes that your production code creates at runtime. It is + off by default because it can be dangerous. With it switched on you can + write passing tests against APIs that don't actually exist! + + .. note:: + + .. versionchanged:: 3.5 + If you are patching builtins in a module then you don't + need to pass ``create=True``, it will be added by default. + + Patch can be used as a :class:`TestCase` class decorator. It works by + decorating each test method in the class. This reduces the boilerplate + code when your test methods share a common patchings set. :func:`patch` finds + tests by looking for method names that start with ``patch.TEST_PREFIX``. + By default this is ``'test'``, which matches the way :mod:`unittest` finds tests. + You can specify an alternative prefix by setting ``patch.TEST_PREFIX``. + + Patch can be used as a context manager, with the with statement. Here the + patching applies to the indented block after the with statement. If you + use "as" then the patched object will be bound to the name after the + "as"; very useful if :func:`patch` is creating a mock object for you. + + :func:`patch` takes arbitrary keyword arguments. These will be passed to + the :class:`Mock` (or *new_callable*) on construction. + + ``patch.dict(...)``, ``patch.multiple(...)`` and ``patch.object(...)`` are + available for alternate use-cases. + +:func:`patch` as function decorator, creating the mock for you and passing it into +the decorated function: + + >>> @patch('__main__.SomeClass') + ... def function(normal_argument, mock_class): + ... print(mock_class is SomeClass) + ... + >>> function(None) + True + +Patching a class replaces the class with a :class:`MagicMock` *instance*. If the +class is instantiated in the code under test then it will be the +:attr:`~Mock.return_value` of the mock that will be used. + +If the class is instantiated multiple times you could use +:attr:`~Mock.side_effect` to return a new mock each time. Alternatively you +can set the *return_value* to be anything you want. + +To configure return values on methods of *instances* on the patched class +you must do this on the :attr:`return_value`. For example: + + >>> class Class: + ... def method(self): + ... pass + ... + >>> with patch('__main__.Class') as MockClass: + ... instance = MockClass.return_value + ... instance.method.return_value = 'foo' + ... assert Class() is instance + ... assert Class().method() == 'foo' + ... + +If you use *spec* or *spec_set* and :func:`patch` is replacing a *class*, then the +return value of the created mock will have the same spec. + + >>> Original = Class + >>> patcher = patch('__main__.Class', spec=True) + >>> MockClass = patcher.start() + >>> instance = MockClass() + >>> assert isinstance(instance, Original) + >>> patcher.stop() + +The *new_callable* argument is useful where you want to use an alternative +class to the default :class:`MagicMock` for the created mock. For example, if +you wanted a :class:`NonCallableMock` to be used: + + >>> thing = object() + >>> with patch('__main__.thing', new_callable=NonCallableMock) as mock_thing: + ... assert thing is mock_thing + ... thing() + ... + Traceback (most recent call last): + ... + TypeError: 'NonCallableMock' object is not callable + +Another use case might be to replace an object with an :class:`io.StringIO` instance: + + >>> from io import StringIO + >>> def foo(): + ... print('Something') + ... + >>> @patch('sys.stdout', new_callable=StringIO) + ... def test(mock_stdout): + ... foo() + ... assert mock_stdout.getvalue() == 'Something\n' + ... + >>> test() + +When :func:`patch` is creating a mock for you, it is common that the first thing +you need to do is to configure the mock. Some of that configuration can be done +in the call to patch. Any arbitrary keywords you pass into the call will be +used to set attributes on the created mock: + + >>> patcher = patch('__main__.thing', first='one', second='two') + >>> mock_thing = patcher.start() + >>> mock_thing.first + 'one' + >>> mock_thing.second + 'two' + +As well as attributes on the created mock attributes, like the +:attr:`~Mock.return_value` and :attr:`~Mock.side_effect`, of child mocks can +also be configured. These aren't syntactically valid to pass in directly as +keyword arguments, but a dictionary with these as keys can still be expanded +into a :func:`patch` call using ``**``: + + >>> config = {'method.return_value': 3, 'other.side_effect': KeyError} + >>> patcher = patch('__main__.thing', **config) + >>> mock_thing = patcher.start() + >>> mock_thing.method() + 3 + >>> mock_thing.other() + Traceback (most recent call last): + ... + KeyError + +By default, attempting to patch a function in a module (or a method or an +attribute in a class) that does not exist will fail with :exc:`AttributeError`:: + + >>> @patch('sys.non_existing_attribute', 42) + ... def test(): + ... assert sys.non_existing_attribute == 42 + ... + >>> test() + Traceback (most recent call last): + ... + AttributeError: does not have the attribute 'non_existing' + +but adding ``create=True`` in the call to :func:`patch` will make the previous example +work as expected:: + + >>> @patch('sys.non_existing_attribute', 42, create=True) + ... def test(mock_stdout): + ... assert sys.non_existing_attribute == 42 + ... + >>> test() + + +patch.object +~~~~~~~~~~~~ + +.. function:: patch.object(target, attribute, new=DEFAULT, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs) + + patch the named member (*attribute*) on an object (*target*) with a mock + object. + + :func:`patch.object` can be used as a decorator, class decorator or a context + manager. Arguments *new*, *spec*, *create*, *spec_set*, *autospec* and + *new_callable* have the same meaning as for :func:`patch`. Like :func:`patch`, + :func:`patch.object` takes arbitrary keyword arguments for configuring the mock + object it creates. + + When used as a class decorator :func:`patch.object` honours ``patch.TEST_PREFIX`` + for choosing which methods to wrap. + +You can either call :func:`patch.object` with three arguments or two arguments. The +three argument form takes the object to be patched, the attribute name and the +object to replace the attribute with. + +When calling with the two argument form you omit the replacement object, and a +mock is created for you and passed in as an extra argument to the decorated +function: + + >>> @patch.object(SomeClass, 'class_method') + ... def test(mock_method): + ... SomeClass.class_method(3) + ... mock_method.assert_called_with(3) + ... + >>> test() + +*spec*, *create* and the other arguments to :func:`patch.object` have the same +meaning as they do for :func:`patch`. + + +patch.dict +~~~~~~~~~~ + +.. function:: patch.dict(in_dict, values=(), clear=False, **kwargs) + + Patch a dictionary, or dictionary like object, and restore the dictionary + to its original state after the test. + + *in_dict* can be a dictionary or a mapping like container. If it is a + mapping then it must at least support getting, setting and deleting items + plus iterating over keys. + + *in_dict* can also be a string specifying the name of the dictionary, which + will then be fetched by importing it. + + *values* can be a dictionary of values to set in the dictionary. *values* + can also be an iterable of ``(key, value)`` pairs. + + If *clear* is true then the dictionary will be cleared before the new + values are set. + + :func:`patch.dict` can also be called with arbitrary keyword arguments to set + values in the dictionary. + + :func:`patch.dict` can be used as a context manager, decorator or class + decorator. When used as a class decorator :func:`patch.dict` honours + ``patch.TEST_PREFIX`` for choosing which methods to wrap. + +:func:`patch.dict` can be used to add members to a dictionary, or simply let a test +change a dictionary, and ensure the dictionary is restored when the test +ends. + + >>> foo = {} + >>> with patch.dict(foo, {'newkey': 'newvalue'}): + ... assert foo == {'newkey': 'newvalue'} + ... + >>> assert foo == {} + + >>> import os + >>> with patch.dict('os.environ', {'newkey': 'newvalue'}): + ... print(os.environ['newkey']) + ... + newvalue + >>> assert 'newkey' not in os.environ + +Keywords can be used in the :func:`patch.dict` call to set values in the dictionary: + + >>> mymodule = MagicMock() + >>> mymodule.function.return_value = 'fish' + >>> with patch.dict('sys.modules', mymodule=mymodule): + ... import mymodule + ... mymodule.function('some', 'args') + ... + 'fish' + +:func:`patch.dict` can be used with dictionary like objects that aren't actually +dictionaries. At the very minimum they must support item getting, setting, +deleting and either iteration or membership test. This corresponds to the +magic methods :meth:`__getitem__`, :meth:`__setitem__`, :meth:`__delitem__` and either +:meth:`__iter__` or :meth:`__contains__`. + + >>> class Container: + ... def __init__(self): + ... self.values = {} + ... def __getitem__(self, name): + ... return self.values[name] + ... def __setitem__(self, name, value): + ... self.values[name] = value + ... def __delitem__(self, name): + ... del self.values[name] + ... def __iter__(self): + ... return iter(self.values) + ... + >>> thing = Container() + >>> thing['one'] = 1 + >>> with patch.dict(thing, one=2, two=3): + ... assert thing['one'] == 2 + ... assert thing['two'] == 3 + ... + >>> assert thing['one'] == 1 + >>> assert list(thing) == ['one'] + + +patch.multiple +~~~~~~~~~~~~~~ + +.. function:: patch.multiple(target, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs) + + Perform multiple patches in a single call. It takes the object to be + patched (either as an object or a string to fetch the object by importing) + and keyword arguments for the patches:: + + with patch.multiple(settings, FIRST_PATCH='one', SECOND_PATCH='two'): + ... + + Use :data:`DEFAULT` as the value if you want :func:`patch.multiple` to create + mocks for you. In this case the created mocks are passed into a decorated + function by keyword, and a dictionary is returned when :func:`patch.multiple` is + used as a context manager. + + :func:`patch.multiple` can be used as a decorator, class decorator or a context + manager. The arguments *spec*, *spec_set*, *create*, *autospec* and + *new_callable* have the same meaning as for :func:`patch`. These arguments will + be applied to *all* patches done by :func:`patch.multiple`. + + When used as a class decorator :func:`patch.multiple` honours ``patch.TEST_PREFIX`` + for choosing which methods to wrap. + +If you want :func:`patch.multiple` to create mocks for you, then you can use +:data:`DEFAULT` as the value. If you use :func:`patch.multiple` as a decorator +then the created mocks are passed into the decorated function by keyword. + + >>> thing = object() + >>> other = object() + + >>> @patch.multiple('__main__', thing=DEFAULT, other=DEFAULT) + ... def test_function(thing, other): + ... assert isinstance(thing, MagicMock) + ... assert isinstance(other, MagicMock) + ... + >>> test_function() + +:func:`patch.multiple` can be nested with other ``patch`` decorators, but put arguments +passed by keyword *after* any of the standard arguments created by :func:`patch`: + + >>> @patch('sys.exit') + ... @patch.multiple('__main__', thing=DEFAULT, other=DEFAULT) + ... def test_function(mock_exit, other, thing): + ... assert 'other' in repr(other) + ... assert 'thing' in repr(thing) + ... assert 'exit' in repr(mock_exit) + ... + >>> test_function() + +If :func:`patch.multiple` is used as a context manager, the value returned by the +context manager is a dictionary where created mocks are keyed by name:: + + >>> with patch.multiple('__main__', thing=DEFAULT, other=DEFAULT) as values: + ... assert 'other' in repr(values['other']) + ... assert 'thing' in repr(values['thing']) + ... assert values['thing'] is thing + ... assert values['other'] is other + ... + + +.. _start-and-stop: + +patch methods: start and stop +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +All the patchers have :meth:`start` and :meth:`stop` methods. These make it simpler to do +patching in ``setUp`` methods or where you want to do multiple patches without +nesting decorators or with statements. + +To use them call :func:`patch`, :func:`patch.object` or :func:`patch.dict` as +normal and keep a reference to the returned ``patcher`` object. You can then +call :meth:`start` to put the patch in place and :meth:`stop` to undo it. + +If you are using :func:`patch` to create a mock for you then it will be returned by +the call to ``patcher.start``. + + >>> patcher = patch('package.module.ClassName') + >>> from package import module + >>> original = module.ClassName + >>> new_mock = patcher.start() + >>> assert module.ClassName is not original + >>> assert module.ClassName is new_mock + >>> patcher.stop() + >>> assert module.ClassName is original + >>> assert module.ClassName is not new_mock + + +A typical use case for this might be for doing multiple patches in the ``setUp`` +method of a :class:`TestCase`: + + >>> class MyTest(TestCase): + ... def setUp(self): + ... self.patcher1 = patch('package.module.Class1') + ... self.patcher2 = patch('package.module.Class2') + ... self.MockClass1 = self.patcher1.start() + ... self.MockClass2 = self.patcher2.start() + ... + ... def tearDown(self): + ... self.patcher1.stop() + ... self.patcher2.stop() + ... + ... def test_something(self): + ... assert package.module.Class1 is self.MockClass1 + ... assert package.module.Class2 is self.MockClass2 + ... + >>> MyTest('test_something').run() + +.. caution:: + + If you use this technique you must ensure that the patching is "undone" by + calling ``stop``. This can be fiddlier than you might think, because if an + exception is raised in the ``setUp`` then ``tearDown`` is not called. + :meth:`unittest.TestCase.addCleanup` makes this easier: + + >>> class MyTest(TestCase): + ... def setUp(self): + ... patcher = patch('package.module.Class') + ... self.MockClass = patcher.start() + ... self.addCleanup(patcher.stop) + ... + ... def test_something(self): + ... assert package.module.Class is self.MockClass + ... + + As an added bonus you no longer need to keep a reference to the ``patcher`` + object. + +It is also possible to stop all patches which have been started by using +:func:`patch.stopall`. + +.. function:: patch.stopall + + Stop all active patches. Only stops patches started with ``start``. + + +.. _patch-builtins: + +patch builtins +~~~~~~~~~~~~~~ +You can patch any builtins within a module. The following example patches +builtin :func:`ord`: + + >>> @patch('__main__.ord') + ... def test(mock_ord): + ... mock_ord.return_value = 101 + ... print(ord('c')) + ... + >>> test() + 101 + + +TEST_PREFIX +~~~~~~~~~~~ + +All of the patchers can be used as class decorators. When used in this way +they wrap every test method on the class. The patchers recognise methods that +start with ``'test'`` as being test methods. This is the same way that the +:class:`unittest.TestLoader` finds test methods by default. + +It is possible that you want to use a different prefix for your tests. You can +inform the patchers of the different prefix by setting ``patch.TEST_PREFIX``: + + >>> patch.TEST_PREFIX = 'foo' + >>> value = 3 + >>> + >>> @patch('__main__.value', 'not three') + ... class Thing: + ... def foo_one(self): + ... print(value) + ... def foo_two(self): + ... print(value) + ... + >>> + >>> Thing().foo_one() + not three + >>> Thing().foo_two() + not three + >>> value + 3 + + +Nesting Patch Decorators +~~~~~~~~~~~~~~~~~~~~~~~~ + +If you want to perform multiple patches then you can simply stack up the +decorators. + +You can stack up multiple patch decorators using this pattern: + + >>> @patch.object(SomeClass, 'class_method') + ... @patch.object(SomeClass, 'static_method') + ... def test(mock1, mock2): + ... assert SomeClass.static_method is mock1 + ... assert SomeClass.class_method is mock2 + ... SomeClass.static_method('foo') + ... SomeClass.class_method('bar') + ... return mock1, mock2 + ... + >>> mock1, mock2 = test() + >>> mock1.assert_called_once_with('foo') + >>> mock2.assert_called_once_with('bar') + + +Note that the decorators are applied from the bottom upwards. This is the +standard way that Python applies decorators. The order of the created mocks +passed into your test function matches this order. + + +.. _where-to-patch: + +Where to patch +~~~~~~~~~~~~~~ + +:func:`patch` works by (temporarily) changing the object that a *name* points to with +another one. There can be many names pointing to any individual object, so +for patching to work you must ensure that you patch the name used by the system +under test. + +The basic principle is that you patch where an object is *looked up*, which +is not necessarily the same place as where it is defined. A couple of +examples will help to clarify this. + +Imagine we have a project that we want to test with the following structure:: + + a.py + -> Defines SomeClass + + b.py + -> from a import SomeClass + -> some_function instantiates SomeClass + +Now we want to test ``some_function`` but we want to mock out ``SomeClass`` using +:func:`patch`. The problem is that when we import module b, which we will have to +do then it imports ``SomeClass`` from module a. If we use :func:`patch` to mock out +``a.SomeClass`` then it will have no effect on our test; module b already has a +reference to the *real* ``SomeClass`` and it looks like our patching had no +effect. + +The key is to patch out ``SomeClass`` where it is used (or where it is looked up). +In this case ``some_function`` will actually look up ``SomeClass`` in module b, +where we have imported it. The patching should look like:: + + @patch('b.SomeClass') + +However, consider the alternative scenario where instead of ``from a import +SomeClass`` module b does ``import a`` and ``some_function`` uses ``a.SomeClass``. Both +of these import forms are common. In this case the class we want to patch is +being looked up in the module and so we have to patch ``a.SomeClass`` instead:: + + @patch('a.SomeClass') + + +Patching Descriptors and Proxy Objects +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Both patch_ and patch.object_ correctly patch and restore descriptors: class +methods, static methods and properties. You should patch these on the *class* +rather than an instance. They also work with *some* objects +that proxy attribute access, like the `django settings object +`_. + + +MagicMock and magic method support +---------------------------------- + +.. _magic-methods: + +Mocking Magic Methods +~~~~~~~~~~~~~~~~~~~~~ + +:class:`Mock` supports mocking the Python protocol methods, also known as +"magic methods". This allows mock objects to replace containers or other +objects that implement Python protocols. + +Because magic methods are looked up differently from normal methods [#]_, this +support has been specially implemented. This means that only specific magic +methods are supported. The supported list includes *almost* all of them. If +there are any missing that you need please let us know. + +You mock magic methods by setting the method you are interested in to a function +or a mock instance. If you are using a function then it *must* take ``self`` as +the first argument [#]_. + + >>> def __str__(self): + ... return 'fooble' + ... + >>> mock = Mock() + >>> mock.__str__ = __str__ + >>> str(mock) + 'fooble' + + >>> mock = Mock() + >>> mock.__str__ = Mock() + >>> mock.__str__.return_value = 'fooble' + >>> str(mock) + 'fooble' + + >>> mock = Mock() + >>> mock.__iter__ = Mock(return_value=iter([])) + >>> list(mock) + [] + +One use case for this is for mocking objects used as context managers in a +:keyword:`with` statement: + + >>> mock = Mock() + >>> mock.__enter__ = Mock(return_value='foo') + >>> mock.__exit__ = Mock(return_value=False) + >>> with mock as m: + ... assert m == 'foo' + ... + >>> mock.__enter__.assert_called_with() + >>> mock.__exit__.assert_called_with(None, None, None) + +Calls to magic methods do not appear in :attr:`~Mock.method_calls`, but they +are recorded in :attr:`~Mock.mock_calls`. + +.. note:: + + If you use the *spec* keyword argument to create a mock then attempting to + set a magic method that isn't in the spec will raise an :exc:`AttributeError`. + +The full list of supported magic methods is: + +* ``__hash__``, ``__sizeof__``, ``__repr__`` and ``__str__`` +* ``__dir__``, ``__format__`` and ``__subclasses__`` +* ``__floor__``, ``__trunc__`` and ``__ceil__`` +* Comparisons: ``__lt__``, ``__gt__``, ``__le__``, ``__ge__``, + ``__eq__`` and ``__ne__`` +* Container methods: ``__getitem__``, ``__setitem__``, ``__delitem__``, + ``__contains__``, ``__len__``, ``__iter__``, ``__reversed__`` + and ``__missing__`` +* Context manager: ``__enter__`` and ``__exit__`` +* Unary numeric methods: ``__neg__``, ``__pos__`` and ``__invert__`` +* The numeric methods (including right hand and in-place variants): + ``__add__``, ``__sub__``, ``__mul__``, ``__matmul__``, ``__div__``, ``__truediv__``, + ``__floordiv__``, ``__mod__``, ``__divmod__``, ``__lshift__``, + ``__rshift__``, ``__and__``, ``__xor__``, ``__or__``, and ``__pow__`` +* Numeric conversion methods: ``__complex__``, ``__int__``, ``__float__`` + and ``__index__`` +* Descriptor methods: ``__get__``, ``__set__`` and ``__delete__`` +* Pickling: ``__reduce__``, ``__reduce_ex__``, ``__getinitargs__``, + ``__getnewargs__``, ``__getstate__`` and ``__setstate__`` + + +The following methods exist but are *not* supported as they are either in use +by mock, can't be set dynamically, or can cause problems: + +* ``__getattr__``, ``__setattr__``, ``__init__`` and ``__new__`` +* ``__prepare__``, ``__instancecheck__``, ``__subclasscheck__``, ``__del__`` + + + +Magic Mock +~~~~~~~~~~ + +There are two ``MagicMock`` variants: :class:`MagicMock` and :class:`NonCallableMagicMock`. + + +.. class:: MagicMock(*args, **kw) + + ``MagicMock`` is a subclass of :class:`Mock` with default implementations + of most of the magic methods. You can use ``MagicMock`` without having to + configure the magic methods yourself. + + The constructor parameters have the same meaning as for :class:`Mock`. + + If you use the *spec* or *spec_set* arguments then *only* magic methods + that exist in the spec will be created. + + +.. class:: NonCallableMagicMock(*args, **kw) + + A non-callable version of :class:`MagicMock`. + + The constructor parameters have the same meaning as for + :class:`MagicMock`, with the exception of *return_value* and + *side_effect* which have no meaning on a non-callable mock. + +The magic methods are setup with :class:`MagicMock` objects, so you can configure them +and use them in the usual way: + + >>> mock = MagicMock() + >>> mock[3] = 'fish' + >>> mock.__setitem__.assert_called_with(3, 'fish') + >>> mock.__getitem__.return_value = 'result' + >>> mock[2] + 'result' + +By default many of the protocol methods are required to return objects of a +specific type. These methods are preconfigured with a default return value, so +that they can be used without you having to do anything if you aren't interested +in the return value. You can still *set* the return value manually if you want +to change the default. + +Methods and their defaults: + +* ``__lt__``: NotImplemented +* ``__gt__``: NotImplemented +* ``__le__``: NotImplemented +* ``__ge__``: NotImplemented +* ``__int__``: 1 +* ``__contains__``: False +* ``__len__``: 0 +* ``__iter__``: iter([]) +* ``__exit__``: False +* ``__complex__``: 1j +* ``__float__``: 1.0 +* ``__bool__``: True +* ``__index__``: 1 +* ``__hash__``: default hash for the mock +* ``__str__``: default str for the mock +* ``__sizeof__``: default sizeof for the mock + +For example: + + >>> mock = MagicMock() + >>> int(mock) + 1 + >>> len(mock) + 0 + >>> list(mock) + [] + >>> object() in mock + False + +The two equality methods, :meth:`__eq__` and :meth:`__ne__`, are special. +They do the default equality comparison on identity, using the +:attr:`~Mock.side_effect` attribute, unless you change their return value to +return something else:: + + >>> MagicMock() == 3 + False + >>> MagicMock() != 3 + True + >>> mock = MagicMock() + >>> mock.__eq__.return_value = True + >>> mock == 3 + True + +The return value of :meth:`MagicMock.__iter__` can be any iterable object and isn't +required to be an iterator: + + >>> mock = MagicMock() + >>> mock.__iter__.return_value = ['a', 'b', 'c'] + >>> list(mock) + ['a', 'b', 'c'] + >>> list(mock) + ['a', 'b', 'c'] + +If the return value *is* an iterator, then iterating over it once will consume +it and subsequent iterations will result in an empty list: + + >>> mock.__iter__.return_value = iter(['a', 'b', 'c']) + >>> list(mock) + ['a', 'b', 'c'] + >>> list(mock) + [] + +``MagicMock`` has all of the supported magic methods configured except for some +of the obscure and obsolete ones. You can still set these up if you want. + +Magic methods that are supported but not setup by default in ``MagicMock`` are: + +* ``__subclasses__`` +* ``__dir__`` +* ``__format__`` +* ``__get__``, ``__set__`` and ``__delete__`` +* ``__reversed__`` and ``__missing__`` +* ``__reduce__``, ``__reduce_ex__``, ``__getinitargs__``, ``__getnewargs__``, + ``__getstate__`` and ``__setstate__`` +* ``__getformat__`` and ``__setformat__`` + + + +.. [#] Magic methods *should* be looked up on the class rather than the + instance. Different versions of Python are inconsistent about applying this + rule. The supported protocol methods should work with all supported versions + of Python. +.. [#] The function is basically hooked up to the class, but each ``Mock`` + instance is kept isolated from the others. + + +Helpers +------- + +sentinel +~~~~~~~~ + +.. data:: sentinel + + The ``sentinel`` object provides a convenient way of providing unique + objects for your tests. + + Attributes are created on demand when you access them by name. Accessing + the same attribute will always return the same object. The objects + returned have a sensible repr so that test failure messages are readable. + + .. versionchanged:: 3.7 + The ``sentinel`` attributes now preserve their identity when they are + :mod:`copied ` or :mod:`pickled `. + +Sometimes when testing you need to test that a specific object is passed as an +argument to another method, or returned. It can be common to create named +sentinel objects to test this. :data:`sentinel` provides a convenient way of +creating and testing the identity of objects like this. + +In this example we monkey patch ``method`` to return ``sentinel.some_object``: + + >>> real = ProductionClass() + >>> real.method = Mock(name="method") + >>> real.method.return_value = sentinel.some_object + >>> result = real.method() + >>> assert result is sentinel.some_object + >>> sentinel.some_object + sentinel.some_object + + +DEFAULT +~~~~~~~ + + +.. data:: DEFAULT + + The :data:`DEFAULT` object is a pre-created sentinel (actually + ``sentinel.DEFAULT``). It can be used by :attr:`~Mock.side_effect` + functions to indicate that the normal return value should be used. + + +call +~~~~ + +.. function:: call(*args, **kwargs) + + :func:`call` is a helper object for making simpler assertions, for comparing with + :attr:`~Mock.call_args`, :attr:`~Mock.call_args_list`, + :attr:`~Mock.mock_calls` and :attr:`~Mock.method_calls`. :func:`call` can also be + used with :meth:`~Mock.assert_has_calls`. + + >>> m = MagicMock(return_value=None) + >>> m(1, 2, a='foo', b='bar') + >>> m() + >>> m.call_args_list == [call(1, 2, a='foo', b='bar'), call()] + True + +.. method:: call.call_list() + + For a call object that represents multiple calls, :meth:`call_list` + returns a list of all the intermediate calls as well as the + final call. + +``call_list`` is particularly useful for making assertions on "chained calls". A +chained call is multiple calls on a single line of code. This results in +multiple entries in :attr:`~Mock.mock_calls` on a mock. Manually constructing +the sequence of calls can be tedious. + +:meth:`~call.call_list` can construct the sequence of calls from the same +chained call: + + >>> m = MagicMock() + >>> m(1).method(arg='foo').other('bar')(2.0) + + >>> kall = call(1).method(arg='foo').other('bar')(2.0) + >>> kall.call_list() + [call(1), + call().method(arg='foo'), + call().method().other('bar'), + call().method().other()(2.0)] + >>> m.mock_calls == kall.call_list() + True + +.. _calls-as-tuples: + +A ``call`` object is either a tuple of (positional args, keyword args) or +(name, positional args, keyword args) depending on how it was constructed. When +you construct them yourself this isn't particularly interesting, but the ``call`` +objects that are in the :attr:`Mock.call_args`, :attr:`Mock.call_args_list` and +:attr:`Mock.mock_calls` attributes can be introspected to get at the individual +arguments they contain. + +The ``call`` objects in :attr:`Mock.call_args` and :attr:`Mock.call_args_list` +are two-tuples of (positional args, keyword args) whereas the ``call`` objects +in :attr:`Mock.mock_calls`, along with ones you construct yourself, are +three-tuples of (name, positional args, keyword args). + +You can use their "tupleness" to pull out the individual arguments for more +complex introspection and assertions. The positional arguments are a tuple +(an empty tuple if there are no positional arguments) and the keyword +arguments are a dictionary: + + >>> m = MagicMock(return_value=None) + >>> m(1, 2, 3, arg='one', arg2='two') + >>> kall = m.call_args + >>> args, kwargs = kall + >>> args + (1, 2, 3) + >>> kwargs + {'arg2': 'two', 'arg': 'one'} + >>> args is kall[0] + True + >>> kwargs is kall[1] + True + + >>> m = MagicMock() + >>> m.foo(4, 5, 6, arg='two', arg2='three') + + >>> kall = m.mock_calls[0] + >>> name, args, kwargs = kall + >>> name + 'foo' + >>> args + (4, 5, 6) + >>> kwargs + {'arg2': 'three', 'arg': 'two'} + >>> name is m.mock_calls[0][0] + True + + +create_autospec +~~~~~~~~~~~~~~~ + +.. function:: create_autospec(spec, spec_set=False, instance=False, **kwargs) + + Create a mock object using another object as a spec. Attributes on the + mock will use the corresponding attribute on the *spec* object as their + spec. + + Functions or methods being mocked will have their arguments checked to + ensure that they are called with the correct signature. + + If *spec_set* is ``True`` then attempting to set attributes that don't exist + on the spec object will raise an :exc:`AttributeError`. + + If a class is used as a spec then the return value of the mock (the + instance of the class) will have the same spec. You can use a class as the + spec for an instance object by passing ``instance=True``. The returned mock + will only be callable if instances of the mock are callable. + + :func:`create_autospec` also takes arbitrary keyword arguments that are passed to + the constructor of the created mock. + +See :ref:`auto-speccing` for examples of how to use auto-speccing with +:func:`create_autospec` and the *autospec* argument to :func:`patch`. + + +ANY +~~~ + +.. data:: ANY + +Sometimes you may need to make assertions about *some* of the arguments in a +call to mock, but either not care about some of the arguments or want to pull +them individually out of :attr:`~Mock.call_args` and make more complex +assertions on them. + +To ignore certain arguments you can pass in objects that compare equal to +*everything*. Calls to :meth:`~Mock.assert_called_with` and +:meth:`~Mock.assert_called_once_with` will then succeed no matter what was +passed in. + + >>> mock = Mock(return_value=None) + >>> mock('foo', bar=object()) + >>> mock.assert_called_once_with('foo', bar=ANY) + +:data:`ANY` can also be used in comparisons with call lists like +:attr:`~Mock.mock_calls`: + + >>> m = MagicMock(return_value=None) + >>> m(1) + >>> m(1, 2) + >>> m(object()) + >>> m.mock_calls == [call(1), call(1, 2), ANY] + True + + + +FILTER_DIR +~~~~~~~~~~ + +.. data:: FILTER_DIR + +:data:`FILTER_DIR` is a module level variable that controls the way mock objects +respond to :func:`dir` (only for Python 2.6 or more recent). The default is ``True``, +which uses the filtering described below, to only show useful members. If you +dislike this filtering, or need to switch it off for diagnostic purposes, then +set ``mock.FILTER_DIR = False``. + +With filtering on, ``dir(some_mock)`` shows only useful attributes and will +include any dynamically created attributes that wouldn't normally be shown. +If the mock was created with a *spec* (or *autospec* of course) then all the +attributes from the original are shown, even if they haven't been accessed +yet: + + >>> dir(Mock()) + ['assert_any_call', + 'assert_called_once_with', + 'assert_called_with', + 'assert_has_calls', + 'attach_mock', + ... + >>> from urllib import request + >>> dir(Mock(spec=request)) + ['AbstractBasicAuthHandler', + 'AbstractDigestAuthHandler', + 'AbstractHTTPHandler', + 'BaseHandler', + ... + +Many of the not-very-useful (private to :class:`Mock` rather than the thing being +mocked) underscore and double underscore prefixed attributes have been +filtered from the result of calling :func:`dir` on a :class:`Mock`. If you dislike this +behaviour you can switch it off by setting the module level switch +:data:`FILTER_DIR`: + + >>> from unittest import mock + >>> mock.FILTER_DIR = False + >>> dir(mock.Mock()) + ['_NonCallableMock__get_return_value', + '_NonCallableMock__get_side_effect', + '_NonCallableMock__return_value_doc', + '_NonCallableMock__set_return_value', + '_NonCallableMock__set_side_effect', + '__call__', + '__class__', + ... + +Alternatively you can just use ``vars(my_mock)`` (instance members) and +``dir(type(my_mock))`` (type members) to bypass the filtering irrespective of +:data:`mock.FILTER_DIR`. + + +mock_open +~~~~~~~~~ + +.. function:: mock_open(mock=None, read_data=None) + + A helper function to create a mock to replace the use of :func:`open`. It works + for :func:`open` called directly or used as a context manager. + + The *mock* argument is the mock object to configure. If ``None`` (the + default) then a :class:`MagicMock` will be created for you, with the API limited + to methods or attributes available on standard file handles. + + *read_data* is a string for the :meth:`~io.IOBase.read`, + :meth:`~io.IOBase.readline`, and :meth:`~io.IOBase.readlines` methods + of the file handle to return. Calls to those methods will take data from + *read_data* until it is depleted. The mock of these methods is pretty + simplistic: every time the *mock* is called, the *read_data* is rewound to + the start. If you need more control over the data that you are feeding to + the tested code you will need to customize this mock for yourself. When that + is insufficient, one of the in-memory filesystem packages on `PyPI + `_ can offer a realistic filesystem for testing. + + .. versionchanged:: 3.4 + Added :meth:`~io.IOBase.readline` and :meth:`~io.IOBase.readlines` support. + The mock of :meth:`~io.IOBase.read` changed to consume *read_data* rather + than returning it on each call. + + .. versionchanged:: 3.5 + *read_data* is now reset on each call to the *mock*. + + .. versionchanged:: 3.7.1 + Added :meth:`__iter__` to implementation so that iteration (such as in for + loops) correctly consumes *read_data*. + +Using :func:`open` as a context manager is a great way to ensure your file handles +are closed properly and is becoming common:: + + with open('/some/path', 'w') as f: + f.write('something') + +The issue is that even if you mock out the call to :func:`open` it is the +*returned object* that is used as a context manager (and has :meth:`__enter__` and +:meth:`__exit__` called). + +Mocking context managers with a :class:`MagicMock` is common enough and fiddly +enough that a helper function is useful. + + >>> m = mock_open() + >>> with patch('__main__.open', m): + ... with open('foo', 'w') as h: + ... h.write('some stuff') + ... + >>> m.mock_calls + [call('foo', 'w'), + call().__enter__(), + call().write('some stuff'), + call().__exit__(None, None, None)] + >>> m.assert_called_once_with('foo', 'w') + >>> handle = m() + >>> handle.write.assert_called_once_with('some stuff') + +And for reading files: + + >>> with patch('__main__.open', mock_open(read_data='bibble')) as m: + ... with open('foo') as h: + ... result = h.read() + ... + >>> m.assert_called_once_with('foo') + >>> assert result == 'bibble' + + +.. _auto-speccing: + +Autospeccing +~~~~~~~~~~~~ + +Autospeccing is based on the existing :attr:`spec` feature of mock. It limits the +api of mocks to the api of an original object (the spec), but it is recursive +(implemented lazily) so that attributes of mocks only have the same api as +the attributes of the spec. In addition mocked functions / methods have the +same call signature as the original so they raise a :exc:`TypeError` if they are +called incorrectly. + +Before I explain how auto-speccing works, here's why it is needed. + +:class:`Mock` is a very powerful and flexible object, but it suffers from two flaws +when used to mock out objects from a system under test. One of these flaws is +specific to the :class:`Mock` api and the other is a more general problem with using +mock objects. + +First the problem specific to :class:`Mock`. :class:`Mock` has two assert methods that are +extremely handy: :meth:`~Mock.assert_called_with` and +:meth:`~Mock.assert_called_once_with`. + + >>> mock = Mock(name='Thing', return_value=None) + >>> mock(1, 2, 3) + >>> mock.assert_called_once_with(1, 2, 3) + >>> mock(1, 2, 3) + >>> mock.assert_called_once_with(1, 2, 3) + Traceback (most recent call last): + ... + AssertionError: Expected 'mock' to be called once. Called 2 times. + +Because mocks auto-create attributes on demand, and allow you to call them +with arbitrary arguments, if you misspell one of these assert methods then +your assertion is gone: + +.. code-block:: pycon + + >>> mock = Mock(name='Thing', return_value=None) + >>> mock(1, 2, 3) + >>> mock.assret_called_once_with(4, 5, 6) + +Your tests can pass silently and incorrectly because of the typo. + +The second issue is more general to mocking. If you refactor some of your +code, rename members and so on, any tests for code that is still using the +*old api* but uses mocks instead of the real objects will still pass. This +means your tests can all pass even though your code is broken. + +Note that this is another reason why you need integration tests as well as +unit tests. Testing everything in isolation is all fine and dandy, but if you +don't test how your units are "wired together" there is still lots of room +for bugs that tests might have caught. + +:mod:`mock` already provides a feature to help with this, called speccing. If you +use a class or instance as the :attr:`spec` for a mock then you can only access +attributes on the mock that exist on the real class: + + >>> from urllib import request + >>> mock = Mock(spec=request.Request) + >>> mock.assret_called_with + Traceback (most recent call last): + ... + AttributeError: Mock object has no attribute 'assret_called_with' + +The spec only applies to the mock itself, so we still have the same issue +with any methods on the mock: + +.. code-block:: pycon + + >>> mock.has_data() + + >>> mock.has_data.assret_called_with() + +Auto-speccing solves this problem. You can either pass ``autospec=True`` to +:func:`patch` / :func:`patch.object` or use the :func:`create_autospec` function to create a +mock with a spec. If you use the ``autospec=True`` argument to :func:`patch` then the +object that is being replaced will be used as the spec object. Because the +speccing is done "lazily" (the spec is created as attributes on the mock are +accessed) you can use it with very complex or deeply nested objects (like +modules that import modules that import modules) without a big performance +hit. + +Here's an example of it in use: + + >>> from urllib import request + >>> patcher = patch('__main__.request', autospec=True) + >>> mock_request = patcher.start() + >>> request is mock_request + True + >>> mock_request.Request + + +You can see that :class:`request.Request` has a spec. :class:`request.Request` takes two +arguments in the constructor (one of which is *self*). Here's what happens if +we try to call it incorrectly: + + >>> req = request.Request() + Traceback (most recent call last): + ... + TypeError: () takes at least 2 arguments (1 given) + +The spec also applies to instantiated classes (i.e. the return value of +specced mocks): + + >>> req = request.Request('foo') + >>> req + + +:class:`Request` objects are not callable, so the return value of instantiating our +mocked out :class:`request.Request` is a non-callable mock. With the spec in place +any typos in our asserts will raise the correct error: + + >>> req.add_header('spam', 'eggs') + + >>> req.add_header.assret_called_with + Traceback (most recent call last): + ... + AttributeError: Mock object has no attribute 'assret_called_with' + >>> req.add_header.assert_called_with('spam', 'eggs') + +In many cases you will just be able to add ``autospec=True`` to your existing +:func:`patch` calls and then be protected against bugs due to typos and api +changes. + +As well as using *autospec* through :func:`patch` there is a +:func:`create_autospec` for creating autospecced mocks directly: + + >>> from urllib import request + >>> mock_request = create_autospec(request) + >>> mock_request.Request('foo', 'bar') + + +This isn't without caveats and limitations however, which is why it is not +the default behaviour. In order to know what attributes are available on the +spec object, autospec has to introspect (access attributes) the spec. As you +traverse attributes on the mock a corresponding traversal of the original +object is happening under the hood. If any of your specced objects have +properties or descriptors that can trigger code execution then you may not be +able to use autospec. On the other hand it is much better to design your +objects so that introspection is safe [#]_. + +A more serious problem is that it is common for instance attributes to be +created in the :meth:`__init__` method and not to exist on the class at all. +*autospec* can't know about any dynamically created attributes and restricts +the api to visible attributes. + + >>> class Something: + ... def __init__(self): + ... self.a = 33 + ... + >>> with patch('__main__.Something', autospec=True): + ... thing = Something() + ... thing.a + ... + Traceback (most recent call last): + ... + AttributeError: Mock object has no attribute 'a' + +There are a few different ways of resolving this problem. The easiest, but +not necessarily the least annoying, way is to simply set the required +attributes on the mock after creation. Just because *autospec* doesn't allow +you to fetch attributes that don't exist on the spec it doesn't prevent you +setting them: + + >>> with patch('__main__.Something', autospec=True): + ... thing = Something() + ... thing.a = 33 + ... + +There is a more aggressive version of both *spec* and *autospec* that *does* +prevent you setting non-existent attributes. This is useful if you want to +ensure your code only *sets* valid attributes too, but obviously it prevents +this particular scenario: + + >>> with patch('__main__.Something', autospec=True, spec_set=True): + ... thing = Something() + ... thing.a = 33 + ... + Traceback (most recent call last): + ... + AttributeError: Mock object has no attribute 'a' + +Probably the best way of solving the problem is to add class attributes as +default values for instance members initialised in :meth:`__init__`. Note that if +you are only setting default attributes in :meth:`__init__` then providing them via +class attributes (shared between instances of course) is faster too. e.g. + +.. code-block:: python + + class Something: + a = 33 + +This brings up another issue. It is relatively common to provide a default +value of ``None`` for members that will later be an object of a different type. +``None`` would be useless as a spec because it wouldn't let you access *any* +attributes or methods on it. As ``None`` is *never* going to be useful as a +spec, and probably indicates a member that will normally of some other type, +autospec doesn't use a spec for members that are set to ``None``. These will +just be ordinary mocks (well - MagicMocks): + + >>> class Something: + ... member = None + ... + >>> mock = create_autospec(Something) + >>> mock.member.foo.bar.baz() + + +If modifying your production classes to add defaults isn't to your liking +then there are more options. One of these is simply to use an instance as the +spec rather than the class. The other is to create a subclass of the +production class and add the defaults to the subclass without affecting the +production class. Both of these require you to use an alternative object as +the spec. Thankfully :func:`patch` supports this - you can simply pass the +alternative object as the *autospec* argument: + + >>> class Something: + ... def __init__(self): + ... self.a = 33 + ... + >>> class SomethingForTest(Something): + ... a = 33 + ... + >>> p = patch('__main__.Something', autospec=SomethingForTest) + >>> mock = p.start() + >>> mock.a + + + +.. [#] This only applies to classes or already instantiated objects. Calling + a mocked class to create a mock instance *does not* create a real instance. + It is only attribute lookups - along with calls to :func:`dir` - that are done. + +Sealing mocks +~~~~~~~~~~~~~ + +.. function:: seal(mock) + + Seal will disable the automatic creation of mocks when accessing an attribute of + the mock being sealed or any of its attributes that are already mocks recursively. + + If a mock instance with a name or a spec is assigned to an attribute + it won't be considered in the sealing chain. This allows one to prevent seal from + fixing part of the mock object. + + >>> mock = Mock() + >>> mock.submock.attribute1 = 2 + >>> mock.not_submock = mock.Mock(name="sample_name") + >>> seal(mock) + >>> mock.new_attribute # This will raise AttributeError. + >>> mock.submock.attribute2 # This will raise AttributeError. + >>> mock.not_submock.attribute2 # This won't raise. + + .. versionadded:: 3.7 diff --git a/python-3.7.4-docs-html/_sources/library/unittest.rst.txt b/python-3.7.4-docs-html/_sources/library/unittest.rst.txt new file mode 100644 index 0000000..bbe1429 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/unittest.rst.txt @@ -0,0 +1,2337 @@ +:mod:`unittest` --- Unit testing framework +========================================== + +.. module:: unittest + :synopsis: Unit testing framework for Python. + +.. moduleauthor:: Steve Purcell +.. sectionauthor:: Steve Purcell +.. sectionauthor:: Fred L. Drake, Jr. +.. sectionauthor:: Raymond Hettinger + +**Source code:** :source:`Lib/unittest/__init__.py` + +-------------- + +(If you are already familiar with the basic concepts of testing, you might want +to skip to :ref:`the list of assert methods `.) + +The :mod:`unittest` unit testing framework was originally inspired by JUnit +and has a similar flavor as major unit testing frameworks in other +languages. It supports test automation, sharing of setup and shutdown code +for tests, aggregation of tests into collections, and independence of the +tests from the reporting framework. + +To achieve this, :mod:`unittest` supports some important concepts in an +object-oriented way: + +test fixture + A :dfn:`test fixture` represents the preparation needed to perform one or more + tests, and any associate cleanup actions. This may involve, for example, + creating temporary or proxy databases, directories, or starting a server + process. + +test case + A :dfn:`test case` is the individual unit of testing. It checks for a specific + response to a particular set of inputs. :mod:`unittest` provides a base class, + :class:`TestCase`, which may be used to create new test cases. + +test suite + A :dfn:`test suite` is a collection of test cases, test suites, or both. It is + used to aggregate tests that should be executed together. + +test runner + A :dfn:`test runner` is a component which orchestrates the execution of tests + and provides the outcome to the user. The runner may use a graphical interface, + a textual interface, or return a special value to indicate the results of + executing the tests. + + +.. seealso:: + + Module :mod:`doctest` + Another test-support module with a very different flavor. + + `Simple Smalltalk Testing: With Patterns `_ + Kent Beck's original paper on testing frameworks using the pattern shared + by :mod:`unittest`. + + `Nose `_ and `pytest `_ + Third-party unittest frameworks with a lighter-weight syntax for writing + tests. For example, ``assert func(10) == 42``. + + `The Python Testing Tools Taxonomy `_ + An extensive list of Python testing tools including functional testing + frameworks and mock object libraries. + + `Testing in Python Mailing List `_ + A special-interest-group for discussion of testing, and testing tools, + in Python. + + The script :file:`Tools/unittestgui/unittestgui.py` in the Python source distribution is + a GUI tool for test discovery and execution. This is intended largely for ease of use + for those new to unit testing. For production environments it is + recommended that tests be driven by a continuous integration system such as + `Buildbot `_, `Jenkins `_ + or `Hudson `_. + + +.. _unittest-minimal-example: + +Basic example +------------- + +The :mod:`unittest` module provides a rich set of tools for constructing and +running tests. This section demonstrates that a small subset of the tools +suffice to meet the needs of most users. + +Here is a short script to test three string methods:: + + import unittest + + 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) + + if __name__ == '__main__': + unittest.main() + + +A testcase is created by subclassing :class:`unittest.TestCase`. The three +individual tests are defined with methods whose names start with the letters +``test``. This naming convention informs the test runner about which methods +represent tests. + +The crux of each test is a call to :meth:`~TestCase.assertEqual` to check for an +expected result; :meth:`~TestCase.assertTrue` or :meth:`~TestCase.assertFalse` +to verify a condition; or :meth:`~TestCase.assertRaises` to verify that a +specific exception gets raised. These methods are used instead of the +:keyword:`assert` statement so the test runner can accumulate all test results +and produce a report. + +The :meth:`~TestCase.setUp` and :meth:`~TestCase.tearDown` methods allow you +to define instructions that will be executed before and after each test method. +They are covered in more detail in the section :ref:`organizing-tests`. + +The final block shows a simple way to run the tests. :func:`unittest.main` +provides a command-line interface to the test script. When run from the command +line, the above script produces an output that looks like this:: + + ... + ---------------------------------------------------------------------- + Ran 3 tests in 0.000s + + OK + +Passing the ``-v`` option to your test script will instruct :func:`unittest.main` +to enable a higher level of verbosity, and produce the following output:: + + test_isupper (__main__.TestStringMethods) ... ok + test_split (__main__.TestStringMethods) ... ok + test_upper (__main__.TestStringMethods) ... ok + + ---------------------------------------------------------------------- + Ran 3 tests in 0.001s + + OK + +The above examples show the most commonly used :mod:`unittest` features which +are sufficient to meet many everyday testing needs. The remainder of the +documentation explores the full feature set from first principles. + + +.. _unittest-command-line-interface: + +Command-Line Interface +---------------------- + +The unittest module can be used from the command line to run tests from +modules, classes or even individual test methods:: + + python -m unittest test_module1 test_module2 + python -m unittest test_module.TestClass + python -m unittest test_module.TestClass.test_method + +You can pass in a list with any combination of module names, and fully +qualified class or method names. + +Test modules can be specified by file path as well:: + + python -m unittest tests/test_something.py + +This allows you to use the shell filename completion to specify the test module. +The file specified must still be importable as a module. The path is converted +to a module name by removing the '.py' and converting path separators into '.'. +If you want to execute a test file that isn't importable as a module you should +execute the file directly instead. + +You can run tests with more detail (higher verbosity) by passing in the -v flag:: + + python -m unittest -v test_module + +When executed without arguments :ref:`unittest-test-discovery` is started:: + + python -m unittest + +For a list of all the command-line options:: + + python -m unittest -h + +.. versionchanged:: 3.2 + In earlier versions it was only possible to run individual test methods and + not modules or classes. + + +Command-line options +~~~~~~~~~~~~~~~~~~~~ + +:program:`unittest` supports these command-line options: + +.. program:: unittest + +.. cmdoption:: -b, --buffer + + The standard output and standard error streams are buffered during the test + run. Output during a passing test is discarded. Output is echoed normally + on test fail or error and is added to the failure messages. + +.. cmdoption:: -c, --catch + + :kbd:`Control-C` during the test run waits for the current test to end and then + reports all the results so far. A second :kbd:`Control-C` raises the normal + :exc:`KeyboardInterrupt` exception. + + See `Signal Handling`_ for the functions that provide this functionality. + +.. cmdoption:: -f, --failfast + + Stop the test run on the first error or failure. + +.. cmdoption:: -k + + Only run test methods and classes that match the pattern or substring. + This option may be used multiple times, in which case all test cases that + match of the given patterns are included. + + Patterns that contain a wildcard character (``*``) are matched against the + test name using :meth:`fnmatch.fnmatchcase`; otherwise simple case-sensitive + substring matching is used. + + Patterns are matched against the fully qualified test method name as + imported by the test loader. + + For example, ``-k foo`` matches ``foo_tests.SomeTest.test_something``, + ``bar_tests.SomeTest.test_foo``, but not ``bar_tests.FooTest.test_something``. + +.. cmdoption:: --locals + + Show local variables in tracebacks. + +.. versionadded:: 3.2 + The command-line options ``-b``, ``-c`` and ``-f`` were added. + +.. versionadded:: 3.5 + The command-line option ``--locals``. + +.. versionadded:: 3.7 + The command-line option ``-k``. + +The command line can also be used for test discovery, for running all of the +tests in a project or just a subset. + + +.. _unittest-test-discovery: + +Test Discovery +-------------- + +.. versionadded:: 3.2 + +Unittest supports simple test discovery. In order to be compatible with test +discovery, all of the test files must be :ref:`modules ` or +:ref:`packages ` (including :term:`namespace packages +`) importable from the top-level directory of +the project (this means that their filenames must be valid :ref:`identifiers +`). + +Test discovery is implemented in :meth:`TestLoader.discover`, but can also be +used from the command line. The basic command-line usage is:: + + cd project_directory + python -m unittest discover + +.. note:: + + As a shortcut, ``python -m unittest`` is the equivalent of + ``python -m unittest discover``. If you want to pass arguments to test + discovery the ``discover`` sub-command must be used explicitly. + +The ``discover`` sub-command has the following options: + +.. program:: unittest discover + +.. cmdoption:: -v, --verbose + + Verbose output + +.. cmdoption:: -s, --start-directory directory + + Directory to start discovery (``.`` default) + +.. cmdoption:: -p, --pattern pattern + + Pattern to match test files (``test*.py`` default) + +.. cmdoption:: -t, --top-level-directory directory + + Top level directory of project (defaults to start directory) + +The :option:`-s`, :option:`-p`, and :option:`-t` options can be passed in +as positional arguments in that order. The following two command lines +are equivalent:: + + python -m unittest discover -s project_directory -p "*_test.py" + python -m unittest discover project_directory "*_test.py" + +As well as being a path it is possible to pass a package name, for example +``myproject.subpackage.test``, as the start directory. The package name you +supply will then be imported and its location on the filesystem will be used +as the start directory. + +.. caution:: + + Test discovery loads tests by importing them. Once test discovery has found + all the test files from the start directory you specify it turns the paths + into package names to import. For example :file:`foo/bar/baz.py` will be + imported as ``foo.bar.baz``. + + If you have a package installed globally and attempt test discovery on + a different copy of the package then the import *could* happen from the + wrong place. If this happens test discovery will warn you and exit. + + If you supply the start directory as a package name rather than a + path to a directory then discover assumes that whichever location it + imports from is the location you intended, so you will not get the + warning. + +Test modules and packages can customize test loading and discovery by through +the `load_tests protocol`_. + +.. versionchanged:: 3.4 + Test discovery supports :term:`namespace packages `. + + +.. _organizing-tests: + +Organizing test code +-------------------- + +The basic building blocks of unit testing are :dfn:`test cases` --- single +scenarios that must be set up and checked for correctness. In :mod:`unittest`, +test cases are represented by :class:`unittest.TestCase` instances. +To make your own test cases you must write subclasses of +:class:`TestCase` or use :class:`FunctionTestCase`. + +The testing code of a :class:`TestCase` instance should be entirely self +contained, such that it can be run either in isolation or in arbitrary +combination with any number of other test cases. + +The simplest :class:`TestCase` subclass will simply implement a test method +(i.e. a method whose name starts with ``test``) in order to perform specific +testing code:: + + import unittest + + class DefaultWidgetSizeTestCase(unittest.TestCase): + def test_default_widget_size(self): + widget = Widget('The widget') + self.assertEqual(widget.size(), (50, 50)) + +Note that in order to test something, we use one of the :meth:`assert\*` +methods provided by the :class:`TestCase` base class. If the test fails, an +exception will be raised with an explanatory message, and :mod:`unittest` +will identify the test case as a :dfn:`failure`. Any other exceptions will be +treated as :dfn:`errors`. + +Tests can be numerous, and their set-up can be repetitive. Luckily, we +can factor out set-up code by implementing a method called +:meth:`~TestCase.setUp`, which the testing framework will automatically +call for every single test we run:: + + import unittest + + class WidgetTestCase(unittest.TestCase): + def setUp(self): + self.widget = Widget('The widget') + + def test_default_widget_size(self): + self.assertEqual(self.widget.size(), (50,50), + 'incorrect default size') + + def test_widget_resize(self): + self.widget.resize(100,150) + self.assertEqual(self.widget.size(), (100,150), + 'wrong size after resize') + +.. note:: + The order in which the various tests will be run is determined + by sorting the test method names with respect to the built-in + ordering for strings. + +If the :meth:`~TestCase.setUp` method raises an exception while the test is +running, the framework will consider the test to have suffered an error, and +the test method will not be executed. + +Similarly, we can provide a :meth:`~TestCase.tearDown` method that tidies up +after the test method has been run:: + + import unittest + + class WidgetTestCase(unittest.TestCase): + def setUp(self): + self.widget = Widget('The widget') + + def tearDown(self): + self.widget.dispose() + +If :meth:`~TestCase.setUp` succeeded, :meth:`~TestCase.tearDown` will be +run whether the test method succeeded or not. + +Such a working environment for the testing code is called a +:dfn:`test fixture`. A new TestCase instance is created as a unique +test fixture used to execute each individual test method. Thus +:meth:`~TestCase.setUp`, :meth:`~TestCase.tearDown`, and :meth:`~TestCase.__init__` +will be called once per test. + +It is recommended that you use TestCase implementations to group tests together +according to the features they test. :mod:`unittest` provides a mechanism for +this: the :dfn:`test suite`, represented by :mod:`unittest`'s +:class:`TestSuite` class. In most cases, calling :func:`unittest.main` will do +the right thing and collect all the module's test cases for you and execute +them. + +However, should you want to customize the building of your test suite, +you can do it yourself:: + + def suite(): + suite = unittest.TestSuite() + suite.addTest(WidgetTestCase('test_default_widget_size')) + suite.addTest(WidgetTestCase('test_widget_resize')) + return suite + + if __name__ == '__main__': + runner = unittest.TextTestRunner() + runner.run(suite()) + +You can place the definitions of test cases and test suites in the same modules +as the code they are to test (such as :file:`widget.py`), but there are several +advantages to placing the test code in a separate module, such as +:file:`test_widget.py`: + +* The test module can be run standalone from the command line. + +* The test code can more easily be separated from shipped code. + +* There is less temptation to change test code to fit the code it tests without + a good reason. + +* Test code should be modified much less frequently than the code it tests. + +* Tested code can be refactored more easily. + +* Tests for modules written in C must be in separate modules anyway, so why not + be consistent? + +* If the testing strategy changes, there is no need to change the source code. + + +.. _legacy-unit-tests: + +Re-using old test code +---------------------- + +Some users will find that they have existing test code that they would like to +run from :mod:`unittest`, without converting every old test function to a +:class:`TestCase` subclass. + +For this reason, :mod:`unittest` provides a :class:`FunctionTestCase` class. +This subclass of :class:`TestCase` can be used to wrap an existing test +function. Set-up and tear-down functions can also be provided. + +Given the following test function:: + + def testSomething(): + something = makeSomething() + assert something.name is not None + # ... + +one can create an equivalent test case instance as follows, with optional +set-up and tear-down methods:: + + testcase = unittest.FunctionTestCase(testSomething, + setUp=makeSomethingDB, + tearDown=deleteSomethingDB) + +.. note:: + + Even though :class:`FunctionTestCase` can be used to quickly convert an + existing test base over to a :mod:`unittest`\ -based system, this approach is + not recommended. Taking the time to set up proper :class:`TestCase` + subclasses will make future test refactorings infinitely easier. + +In some cases, the existing tests may have been written using the :mod:`doctest` +module. If so, :mod:`doctest` provides a :class:`DocTestSuite` class that can +automatically build :class:`unittest.TestSuite` instances from the existing +:mod:`doctest`\ -based tests. + + +.. _unittest-skipping: + +Skipping tests and expected failures +------------------------------------ + +.. versionadded:: 3.1 + +Unittest supports skipping individual test methods and even whole classes of +tests. In addition, it supports marking a test as an "expected failure," a test +that is broken and will fail, but shouldn't be counted as a failure on a +:class:`TestResult`. + +Skipping a test is simply a matter of using the :func:`skip` :term:`decorator` +or one of its conditional variants, calling :meth:`TestCase.skipTest` within a +:meth:`~TestCase.setUp` or test method, or raising :exc:`SkipTest` directly. + +Basic skipping looks like this:: + + class MyTestCase(unittest.TestCase): + + @unittest.skip("demonstrating skipping") + def test_nothing(self): + self.fail("shouldn't happen") + + @unittest.skipIf(mylib.__version__ < (1, 3), + "not supported in this library version") + def test_format(self): + # Tests that work for only a certain version of the library. + pass + + @unittest.skipUnless(sys.platform.startswith("win"), "requires Windows") + def test_windows_support(self): + # windows specific testing code + pass + + def test_maybe_skipped(self): + if not external_resource_available(): + self.skipTest("external resource not available") + # test code that depends on the external resource + pass + +This is the output of running the example above in verbose mode:: + + test_format (__main__.MyTestCase) ... skipped 'not supported in this library version' + test_nothing (__main__.MyTestCase) ... skipped 'demonstrating skipping' + test_maybe_skipped (__main__.MyTestCase) ... skipped 'external resource not available' + test_windows_support (__main__.MyTestCase) ... skipped 'requires Windows' + + ---------------------------------------------------------------------- + Ran 4 tests in 0.005s + + OK (skipped=4) + +Classes can be skipped just like methods:: + + @unittest.skip("showing class skipping") + class MySkippedTestCase(unittest.TestCase): + def test_not_run(self): + pass + +:meth:`TestCase.setUp` can also skip the test. This is useful when a resource +that needs to be set up is not available. + +Expected failures use the :func:`expectedFailure` decorator. :: + + class ExpectedFailureTestCase(unittest.TestCase): + @unittest.expectedFailure + def test_fail(self): + self.assertEqual(1, 0, "broken") + +It's easy to roll your own skipping decorators by making a decorator that calls +:func:`skip` on the test when it wants it to be skipped. This decorator skips +the test unless the passed object has a certain attribute:: + + def skipUnlessHasattr(obj, attr): + if hasattr(obj, attr): + return lambda func: func + return unittest.skip("{!r} doesn't have {!r}".format(obj, attr)) + +The following decorators and exception implement test skipping and expected failures: + +.. decorator:: skip(reason) + + Unconditionally skip the decorated test. *reason* should describe why the + test is being skipped. + +.. decorator:: skipIf(condition, reason) + + Skip the decorated test if *condition* is true. + +.. decorator:: skipUnless(condition, reason) + + Skip the decorated test unless *condition* is true. + +.. decorator:: expectedFailure + + Mark the test as an expected failure. If the test fails it will be + considered a success. If the test passes, it will be considered a failure. + +.. exception:: SkipTest(reason) + + This exception is raised to skip a test. + + Usually you can use :meth:`TestCase.skipTest` or one of the skipping + decorators instead of raising this directly. + +Skipped tests will not have :meth:`~TestCase.setUp` or :meth:`~TestCase.tearDown` run around them. +Skipped classes will not have :meth:`~TestCase.setUpClass` or :meth:`~TestCase.tearDownClass` run. +Skipped modules will not have :func:`setUpModule` or :func:`tearDownModule` run. + + +.. _subtests: + +Distinguishing test iterations using subtests +--------------------------------------------- + +.. versionadded:: 3.4 + +When there are very small differences among your tests, for +instance some parameters, unittest allows you to distinguish them inside +the body of a test method using the :meth:`~TestCase.subTest` context manager. + +For example, the following test:: + + class NumbersTest(unittest.TestCase): + + def test_even(self): + """ + Test that numbers between 0 and 5 are all even. + """ + for i in range(0, 6): + with self.subTest(i=i): + self.assertEqual(i % 2, 0) + +will produce the following output:: + + ====================================================================== + FAIL: test_even (__main__.NumbersTest) (i=1) + ---------------------------------------------------------------------- + Traceback (most recent call last): + File "subtests.py", line 32, in test_even + self.assertEqual(i % 2, 0) + AssertionError: 1 != 0 + + ====================================================================== + FAIL: test_even (__main__.NumbersTest) (i=3) + ---------------------------------------------------------------------- + Traceback (most recent call last): + File "subtests.py", line 32, in test_even + self.assertEqual(i % 2, 0) + AssertionError: 1 != 0 + + ====================================================================== + FAIL: test_even (__main__.NumbersTest) (i=5) + ---------------------------------------------------------------------- + Traceback (most recent call last): + File "subtests.py", line 32, in test_even + self.assertEqual(i % 2, 0) + AssertionError: 1 != 0 + +Without using a subtest, execution would stop after the first failure, +and the error would be less easy to diagnose because the value of ``i`` +wouldn't be displayed:: + + ====================================================================== + FAIL: test_even (__main__.NumbersTest) + ---------------------------------------------------------------------- + Traceback (most recent call last): + File "subtests.py", line 32, in test_even + self.assertEqual(i % 2, 0) + AssertionError: 1 != 0 + + +.. _unittest-contents: + +Classes and functions +--------------------- + +This section describes in depth the API of :mod:`unittest`. + + +.. _testcase-objects: + +Test cases +~~~~~~~~~~ + +.. class:: TestCase(methodName='runTest') + + Instances of the :class:`TestCase` class represent the logical test units + in the :mod:`unittest` universe. This class is intended to be used as a base + class, with specific tests being implemented by concrete subclasses. This class + implements the interface needed by the test runner to allow it to drive the + tests, and methods that the test code can use to check for and report various + kinds of failure. + + Each instance of :class:`TestCase` will run a single base method: the method + named *methodName*. + In most uses of :class:`TestCase`, you will neither change + the *methodName* nor reimplement the default ``runTest()`` method. + + .. versionchanged:: 3.2 + :class:`TestCase` can be instantiated successfully without providing a + *methodName*. This makes it easier to experiment with :class:`TestCase` + from the interactive interpreter. + + :class:`TestCase` instances provide three groups of methods: one group used + to run the test, another used by the test implementation to check conditions + and report failures, and some inquiry methods allowing information about the + test itself to be gathered. + + Methods in the first group (running the test) are: + + .. method:: setUp() + + Method called to prepare the test fixture. This is called immediately + before calling the test method; other than :exc:`AssertionError` or :exc:`SkipTest`, + any exception raised by this method will be considered an error rather than + a test failure. The default implementation does nothing. + + + .. method:: tearDown() + + Method called immediately after the test method has been called and the + result recorded. This is called even if the test method raised an + exception, so the implementation in subclasses may need to be particularly + careful about checking internal state. Any exception, other than + :exc:`AssertionError` or :exc:`SkipTest`, raised by this method will be + considered an additional error rather than a test failure (thus increasing + the total number of reported errors). This method will only be called if + the :meth:`setUp` succeeds, regardless of the outcome of the test method. + The default implementation does nothing. + + + .. method:: setUpClass() + + A class method called before tests in an individual class are run. + ``setUpClass`` is called with the class as the only argument + and must be decorated as a :func:`classmethod`:: + + @classmethod + def setUpClass(cls): + ... + + See `Class and Module Fixtures`_ for more details. + + .. versionadded:: 3.2 + + + .. method:: tearDownClass() + + A class method called after tests in an individual class have run. + ``tearDownClass`` is called with the class as the only argument + and must be decorated as a :meth:`classmethod`:: + + @classmethod + def tearDownClass(cls): + ... + + See `Class and Module Fixtures`_ for more details. + + .. versionadded:: 3.2 + + + .. method:: run(result=None) + + Run the test, collecting the result into the :class:`TestResult` object + passed as *result*. If *result* is omitted or ``None``, a temporary + result object is created (by calling the :meth:`defaultTestResult` + method) and used. The result object is returned to :meth:`run`'s + caller. + + The same effect may be had by simply calling the :class:`TestCase` + instance. + + .. versionchanged:: 3.3 + Previous versions of ``run`` did not return the result. Neither did + calling an instance. + + .. method:: skipTest(reason) + + Calling this during a test method or :meth:`setUp` skips the current + test. See :ref:`unittest-skipping` for more information. + + .. versionadded:: 3.1 + + + .. method:: subTest(msg=None, **params) + + Return a context manager which executes the enclosed code block as a + subtest. *msg* and *params* are optional, arbitrary values which are + displayed whenever a subtest fails, allowing you to identify them + clearly. + + A test case can contain any number of subtest declarations, and + they can be arbitrarily nested. + + See :ref:`subtests` for more information. + + .. versionadded:: 3.4 + + + .. method:: debug() + + Run the test without collecting the result. This allows exceptions raised + by the test to be propagated to the caller, and can be used to support + running tests under a debugger. + + .. _assert-methods: + + The :class:`TestCase` class provides several assert methods to check for and + report failures. The following table lists the most commonly used methods + (see the tables below for more assert methods): + + +-----------------------------------------+-----------------------------+---------------+ + | Method | Checks that | New in | + +=========================================+=============================+===============+ + | :meth:`assertEqual(a, b) | ``a == b`` | | + | ` | | | + +-----------------------------------------+-----------------------------+---------------+ + | :meth:`assertNotEqual(a, b) | ``a != b`` | | + | ` | | | + +-----------------------------------------+-----------------------------+---------------+ + | :meth:`assertTrue(x) | ``bool(x) is True`` | | + | ` | | | + +-----------------------------------------+-----------------------------+---------------+ + | :meth:`assertFalse(x) | ``bool(x) is False`` | | + | ` | | | + +-----------------------------------------+-----------------------------+---------------+ + | :meth:`assertIs(a, b) | ``a is b`` | 3.1 | + | ` | | | + +-----------------------------------------+-----------------------------+---------------+ + | :meth:`assertIsNot(a, b) | ``a is not b`` | 3.1 | + | ` | | | + +-----------------------------------------+-----------------------------+---------------+ + | :meth:`assertIsNone(x) | ``x is None`` | 3.1 | + | ` | | | + +-----------------------------------------+-----------------------------+---------------+ + | :meth:`assertIsNotNone(x) | ``x is not None`` | 3.1 | + | ` | | | + +-----------------------------------------+-----------------------------+---------------+ + | :meth:`assertIn(a, b) | ``a in b`` | 3.1 | + | ` | | | + +-----------------------------------------+-----------------------------+---------------+ + | :meth:`assertNotIn(a, b) | ``a not in b`` | 3.1 | + | ` | | | + +-----------------------------------------+-----------------------------+---------------+ + | :meth:`assertIsInstance(a, b) | ``isinstance(a, b)`` | 3.2 | + | ` | | | + +-----------------------------------------+-----------------------------+---------------+ + | :meth:`assertNotIsInstance(a, b) | ``not isinstance(a, b)`` | 3.2 | + | ` | | | + +-----------------------------------------+-----------------------------+---------------+ + + All the assert methods accept a *msg* argument that, if specified, is used + as the error message on failure (see also :data:`longMessage`). + Note that the *msg* keyword argument can be passed to :meth:`assertRaises`, + :meth:`assertRaisesRegex`, :meth:`assertWarns`, :meth:`assertWarnsRegex` + only when they are used as a context manager. + + .. method:: assertEqual(first, second, msg=None) + + Test that *first* and *second* are equal. If the values do not + compare equal, the test will fail. + + In addition, if *first* and *second* are the exact same type and one of + list, tuple, dict, set, frozenset or str or any type that a subclass + registers with :meth:`addTypeEqualityFunc` the type-specific equality + function will be called in order to generate a more useful default + error message (see also the :ref:`list of type-specific methods + `). + + .. versionchanged:: 3.1 + Added the automatic calling of type-specific equality function. + + .. versionchanged:: 3.2 + :meth:`assertMultiLineEqual` added as the default type equality + function for comparing strings. + + + .. method:: assertNotEqual(first, second, msg=None) + + Test that *first* and *second* are not equal. If the values do + compare equal, the test will fail. + + .. method:: assertTrue(expr, msg=None) + assertFalse(expr, msg=None) + + Test that *expr* is true (or false). + + Note that this is equivalent to ``bool(expr) is True`` and not to ``expr + is True`` (use ``assertIs(expr, True)`` for the latter). This method + should also be avoided when more specific methods are available (e.g. + ``assertEqual(a, b)`` instead of ``assertTrue(a == b)``), because they + provide a better error message in case of failure. + + + .. method:: assertIs(first, second, msg=None) + assertIsNot(first, second, msg=None) + + Test that *first* and *second* evaluate (or don't evaluate) to the + same object. + + .. versionadded:: 3.1 + + + .. method:: assertIsNone(expr, msg=None) + assertIsNotNone(expr, msg=None) + + Test that *expr* is (or is not) ``None``. + + .. versionadded:: 3.1 + + + .. method:: assertIn(first, second, msg=None) + assertNotIn(first, second, msg=None) + + Test that *first* is (or is not) in *second*. + + .. versionadded:: 3.1 + + + .. method:: assertIsInstance(obj, cls, msg=None) + assertNotIsInstance(obj, cls, msg=None) + + Test that *obj* is (or is not) an instance of *cls* (which can be a + class or a tuple of classes, as supported by :func:`isinstance`). + To check for the exact type, use :func:`assertIs(type(obj), cls) `. + + .. versionadded:: 3.2 + + + + It is also possible to check the production of exceptions, warnings, and + log messages using the following methods: + + +---------------------------------------------------------+--------------------------------------+------------+ + | Method | Checks that | New in | + +=========================================================+======================================+============+ + | :meth:`assertRaises(exc, fun, *args, **kwds) | ``fun(*args, **kwds)`` raises *exc* | | + | ` | | | + +---------------------------------------------------------+--------------------------------------+------------+ + | :meth:`assertRaisesRegex(exc, r, fun, *args, **kwds) | ``fun(*args, **kwds)`` raises *exc* | 3.1 | + | ` | and the message matches regex *r* | | + +---------------------------------------------------------+--------------------------------------+------------+ + | :meth:`assertWarns(warn, fun, *args, **kwds) | ``fun(*args, **kwds)`` raises *warn* | 3.2 | + | ` | | | + +---------------------------------------------------------+--------------------------------------+------------+ + | :meth:`assertWarnsRegex(warn, r, fun, *args, **kwds) | ``fun(*args, **kwds)`` raises *warn* | 3.2 | + | ` | and the message matches regex *r* | | + +---------------------------------------------------------+--------------------------------------+------------+ + | :meth:`assertLogs(logger, level) | The ``with`` block logs on *logger* | 3.4 | + | ` | with minimum *level* | | + +---------------------------------------------------------+--------------------------------------+------------+ + + .. method:: assertRaises(exception, callable, *args, **kwds) + assertRaises(exception, *, msg=None) + + Test that an exception is raised when *callable* is called with any + positional or keyword arguments that are also passed to + :meth:`assertRaises`. The test passes if *exception* is raised, is an + error if another exception is raised, or fails if no exception is raised. + To catch any of a group of exceptions, a tuple containing the exception + classes may be passed as *exception*. + + If only the *exception* and possibly the *msg* arguments are given, + return a context manager so that the code under test can be written + inline rather than as a function:: + + with self.assertRaises(SomeException): + do_something() + + When used as a context manager, :meth:`assertRaises` accepts the + additional keyword argument *msg*. + + The context manager will store the caught exception object in its + :attr:`exception` attribute. This can be useful if the intention + is to perform additional checks on the exception raised:: + + with self.assertRaises(SomeException) as cm: + do_something() + + the_exception = cm.exception + self.assertEqual(the_exception.error_code, 3) + + .. versionchanged:: 3.1 + Added the ability to use :meth:`assertRaises` as a context manager. + + .. versionchanged:: 3.2 + Added the :attr:`exception` attribute. + + .. versionchanged:: 3.3 + Added the *msg* keyword argument when used as a context manager. + + + .. method:: assertRaisesRegex(exception, regex, callable, *args, **kwds) + assertRaisesRegex(exception, regex, *, msg=None) + + Like :meth:`assertRaises` but also tests that *regex* matches + on the string representation of the raised exception. *regex* may be + a regular expression object or a string containing a regular expression + suitable for use by :func:`re.search`. Examples:: + + self.assertRaisesRegex(ValueError, "invalid literal for.*XYZ'$", + int, 'XYZ') + + or:: + + with self.assertRaisesRegex(ValueError, 'literal'): + int('XYZ') + + .. versionadded:: 3.1 + Added under the name ``assertRaisesRegexp``. + + .. versionchanged:: 3.2 + Renamed to :meth:`assertRaisesRegex`. + + .. versionchanged:: 3.3 + Added the *msg* keyword argument when used as a context manager. + + + .. method:: assertWarns(warning, callable, *args, **kwds) + assertWarns(warning, *, msg=None) + + Test that a warning is triggered when *callable* is called with any + positional or keyword arguments that are also passed to + :meth:`assertWarns`. The test passes if *warning* is triggered and + fails if it isn't. Any exception is an error. + To catch any of a group of warnings, a tuple containing the warning + classes may be passed as *warnings*. + + If only the *warning* and possibly the *msg* arguments are given, + return a context manager so that the code under test can be written + inline rather than as a function:: + + with self.assertWarns(SomeWarning): + do_something() + + When used as a context manager, :meth:`assertWarns` accepts the + additional keyword argument *msg*. + + The context manager will store the caught warning object in its + :attr:`warning` attribute, and the source line which triggered the + warnings in the :attr:`filename` and :attr:`lineno` attributes. + This can be useful if the intention is to perform additional checks + on the warning caught:: + + with self.assertWarns(SomeWarning) as cm: + do_something() + + self.assertIn('myfile.py', cm.filename) + self.assertEqual(320, cm.lineno) + + This method works regardless of the warning filters in place when it + is called. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.3 + Added the *msg* keyword argument when used as a context manager. + + + .. method:: assertWarnsRegex(warning, regex, callable, *args, **kwds) + assertWarnsRegex(warning, regex, *, msg=None) + + Like :meth:`assertWarns` but also tests that *regex* matches on the + message of the triggered warning. *regex* may be a regular expression + object or a string containing a regular expression suitable for use + by :func:`re.search`. Example:: + + self.assertWarnsRegex(DeprecationWarning, + r'legacy_function\(\) is deprecated', + legacy_function, 'XYZ') + + or:: + + with self.assertWarnsRegex(RuntimeWarning, 'unsafe frobnicating'): + frobnicate('/etc/passwd') + + .. versionadded:: 3.2 + + .. versionchanged:: 3.3 + Added the *msg* keyword argument when used as a context manager. + + .. method:: assertLogs(logger=None, level=None) + + A context manager to test that at least one message is logged on + the *logger* or one of its children, with at least the given + *level*. + + If given, *logger* should be a :class:`logging.Logger` object or a + :class:`str` giving the name of a logger. The default is the root + logger, which will catch all messages. + + If given, *level* should be either a numeric logging level or + its string equivalent (for example either ``"ERROR"`` or + :attr:`logging.ERROR`). The default is :attr:`logging.INFO`. + + The test passes if at least one message emitted inside the ``with`` + block matches the *logger* and *level* conditions, otherwise it fails. + + The object returned by the context manager is a recording helper + which keeps tracks of the matching log messages. It has two + attributes: + + .. attribute:: records + + A list of :class:`logging.LogRecord` objects of the matching + log messages. + + .. attribute:: output + + A list of :class:`str` objects with the formatted output of + matching messages. + + Example:: + + with self.assertLogs('foo', level='INFO') as cm: + logging.getLogger('foo').info('first message') + logging.getLogger('foo.bar').error('second message') + self.assertEqual(cm.output, ['INFO:foo:first message', + 'ERROR:foo.bar:second message']) + + .. versionadded:: 3.4 + + + There are also other methods used to perform more specific checks, such as: + + +---------------------------------------+--------------------------------+--------------+ + | Method | Checks that | New in | + +=======================================+================================+==============+ + | :meth:`assertAlmostEqual(a, b) | ``round(a-b, 7) == 0`` | | + | ` | | | + +---------------------------------------+--------------------------------+--------------+ + | :meth:`assertNotAlmostEqual(a, b) | ``round(a-b, 7) != 0`` | | + | ` | | | + +---------------------------------------+--------------------------------+--------------+ + | :meth:`assertGreater(a, b) | ``a > b`` | 3.1 | + | ` | | | + +---------------------------------------+--------------------------------+--------------+ + | :meth:`assertGreaterEqual(a, b) | ``a >= b`` | 3.1 | + | ` | | | + +---------------------------------------+--------------------------------+--------------+ + | :meth:`assertLess(a, b) | ``a < b`` | 3.1 | + | ` | | | + +---------------------------------------+--------------------------------+--------------+ + | :meth:`assertLessEqual(a, b) | ``a <= b`` | 3.1 | + | ` | | | + +---------------------------------------+--------------------------------+--------------+ + | :meth:`assertRegex(s, r) | ``r.search(s)`` | 3.1 | + | ` | | | + +---------------------------------------+--------------------------------+--------------+ + | :meth:`assertNotRegex(s, r) | ``not r.search(s)`` | 3.2 | + | ` | | | + +---------------------------------------+--------------------------------+--------------+ + | :meth:`assertCountEqual(a, b) | *a* and *b* have the same | 3.2 | + | ` | elements in the same number, | | + | | regardless of their order. | | + +---------------------------------------+--------------------------------+--------------+ + + + .. method:: assertAlmostEqual(first, second, places=7, msg=None, delta=None) + assertNotAlmostEqual(first, second, places=7, msg=None, delta=None) + + Test that *first* and *second* are approximately (or not approximately) + equal by computing the difference, rounding to the given number of + decimal *places* (default 7), and comparing to zero. Note that these + methods round the values to the given number of *decimal places* (i.e. + like the :func:`round` function) and not *significant digits*. + + If *delta* is supplied instead of *places* then the difference + between *first* and *second* must be less or equal to (or greater than) *delta*. + + Supplying both *delta* and *places* raises a :exc:`TypeError`. + + .. versionchanged:: 3.2 + :meth:`assertAlmostEqual` automatically considers almost equal objects + that compare equal. :meth:`assertNotAlmostEqual` automatically fails + if the objects compare equal. Added the *delta* keyword argument. + + + .. method:: assertGreater(first, second, msg=None) + assertGreaterEqual(first, second, msg=None) + assertLess(first, second, msg=None) + assertLessEqual(first, second, msg=None) + + Test that *first* is respectively >, >=, < or <= than *second* depending + on the method name. If not, the test will fail:: + + >>> self.assertGreaterEqual(3, 4) + AssertionError: "3" unexpectedly not greater than or equal to "4" + + .. versionadded:: 3.1 + + + .. method:: assertRegex(text, regex, msg=None) + assertNotRegex(text, regex, msg=None) + + Test that a *regex* search matches (or does not match) *text*. In case + of failure, the error message will include the pattern and the *text* (or + the pattern and the part of *text* that unexpectedly matched). *regex* + may be a regular expression object or a string containing a regular + expression suitable for use by :func:`re.search`. + + .. versionadded:: 3.1 + Added under the name ``assertRegexpMatches``. + .. versionchanged:: 3.2 + The method ``assertRegexpMatches()`` has been renamed to + :meth:`.assertRegex`. + .. versionadded:: 3.2 + :meth:`.assertNotRegex`. + .. versionadded:: 3.5 + The name ``assertNotRegexpMatches`` is a deprecated alias + for :meth:`.assertNotRegex`. + + + .. method:: assertCountEqual(first, second, msg=None) + + Test that sequence *first* contains the same elements as *second*, + regardless of their order. When they don't, an error message listing the + differences between the sequences will be generated. + + Duplicate elements are *not* ignored when comparing *first* and + *second*. It verifies whether each element has the same count in both + sequences. Equivalent to: + ``assertEqual(Counter(list(first)), Counter(list(second)))`` + but works with sequences of unhashable objects as well. + + .. versionadded:: 3.2 + + + .. _type-specific-methods: + + The :meth:`assertEqual` method dispatches the equality check for objects of + the same type to different type-specific methods. These methods are already + implemented for most of the built-in types, but it's also possible to + register new methods using :meth:`addTypeEqualityFunc`: + + .. method:: addTypeEqualityFunc(typeobj, function) + + Registers a type-specific method called by :meth:`assertEqual` to check + if two objects of exactly the same *typeobj* (not subclasses) compare + equal. *function* must take two positional arguments and a third msg=None + keyword argument just as :meth:`assertEqual` does. It must raise + :data:`self.failureException(msg) ` when inequality + between the first two parameters is detected -- possibly providing useful + information and explaining the inequalities in details in the error + message. + + .. versionadded:: 3.1 + + The list of type-specific methods automatically used by + :meth:`~TestCase.assertEqual` are summarized in the following table. Note + that it's usually not necessary to invoke these methods directly. + + +-----------------------------------------+-----------------------------+--------------+ + | Method | Used to compare | New in | + +=========================================+=============================+==============+ + | :meth:`assertMultiLineEqual(a, b) | strings | 3.1 | + | ` | | | + +-----------------------------------------+-----------------------------+--------------+ + | :meth:`assertSequenceEqual(a, b) | sequences | 3.1 | + | ` | | | + +-----------------------------------------+-----------------------------+--------------+ + | :meth:`assertListEqual(a, b) | lists | 3.1 | + | ` | | | + +-----------------------------------------+-----------------------------+--------------+ + | :meth:`assertTupleEqual(a, b) | tuples | 3.1 | + | ` | | | + +-----------------------------------------+-----------------------------+--------------+ + | :meth:`assertSetEqual(a, b) | sets or frozensets | 3.1 | + | ` | | | + +-----------------------------------------+-----------------------------+--------------+ + | :meth:`assertDictEqual(a, b) | dicts | 3.1 | + | ` | | | + +-----------------------------------------+-----------------------------+--------------+ + + + + .. method:: assertMultiLineEqual(first, second, msg=None) + + Test that the multiline string *first* is equal to the string *second*. + When not equal a diff of the two strings highlighting the differences + will be included in the error message. This method is used by default + when comparing strings with :meth:`assertEqual`. + + .. versionadded:: 3.1 + + + .. method:: assertSequenceEqual(first, second, msg=None, seq_type=None) + + Tests that two sequences are equal. If a *seq_type* is supplied, both + *first* and *second* must be instances of *seq_type* or a failure will + be raised. If the sequences are different an error message is + constructed that shows the difference between the two. + + This method is not called directly by :meth:`assertEqual`, but + it's used to implement :meth:`assertListEqual` and + :meth:`assertTupleEqual`. + + .. versionadded:: 3.1 + + + .. method:: assertListEqual(first, second, msg=None) + assertTupleEqual(first, second, msg=None) + + Tests that two lists or tuples are equal. If not, an error message is + constructed that shows only the differences between the two. An error + is also raised if either of the parameters are of the wrong type. + These methods are used by default when comparing lists or tuples with + :meth:`assertEqual`. + + .. versionadded:: 3.1 + + + .. method:: assertSetEqual(first, second, msg=None) + + Tests that two sets are equal. If not, an error message is constructed + that lists the differences between the sets. This method is used by + default when comparing sets or frozensets with :meth:`assertEqual`. + + Fails if either of *first* or *second* does not have a :meth:`set.difference` + method. + + .. versionadded:: 3.1 + + + .. method:: assertDictEqual(first, second, msg=None) + + Test that two dictionaries are equal. If not, an error message is + constructed that shows the differences in the dictionaries. This + method will be used by default to compare dictionaries in + calls to :meth:`assertEqual`. + + .. versionadded:: 3.1 + + + + .. _other-methods-and-attrs: + + Finally the :class:`TestCase` provides the following methods and attributes: + + + .. method:: fail(msg=None) + + Signals a test failure unconditionally, with *msg* or ``None`` for + the error message. + + + .. attribute:: failureException + + This class attribute gives the exception raised by the test method. If a + test framework needs to use a specialized exception, possibly to carry + additional information, it must subclass this exception in order to "play + fair" with the framework. The initial value of this attribute is + :exc:`AssertionError`. + + + .. attribute:: longMessage + + This class attribute determines what happens when a custom failure message + is passed as the msg argument to an assertXYY call that fails. + ``True`` is the default value. In this case, the custom message is appended + to the end of the standard failure message. + When set to ``False``, the custom message replaces the standard message. + + The class setting can be overridden in individual test methods by assigning + an instance attribute, self.longMessage, to ``True`` or ``False`` before + calling the assert methods. + + The class setting gets reset before each test call. + + .. versionadded:: 3.1 + + + .. attribute:: maxDiff + + This attribute controls the maximum length of diffs output by assert + methods that report diffs on failure. It defaults to 80*8 characters. + Assert methods affected by this attribute are + :meth:`assertSequenceEqual` (including all the sequence comparison + methods that delegate to it), :meth:`assertDictEqual` and + :meth:`assertMultiLineEqual`. + + Setting ``maxDiff`` to ``None`` means that there is no maximum length of + diffs. + + .. versionadded:: 3.2 + + + Testing frameworks can use the following methods to collect information on + the test: + + + .. method:: countTestCases() + + Return the number of tests represented by this test object. For + :class:`TestCase` instances, this will always be ``1``. + + + .. method:: defaultTestResult() + + Return an instance of the test result class that should be used for this + test case class (if no other result instance is provided to the + :meth:`run` method). + + For :class:`TestCase` instances, this will always be an instance of + :class:`TestResult`; subclasses of :class:`TestCase` should override this + as necessary. + + + .. method:: id() + + Return a string identifying the specific test case. This is usually the + full name of the test method, including the module and class name. + + + .. method:: shortDescription() + + Returns a description of the test, or ``None`` if no description + has been provided. The default implementation of this method + returns the first line of the test method's docstring, if available, + or ``None``. + + .. versionchanged:: 3.1 + In 3.1 this was changed to add the test name to the short description + even in the presence of a docstring. This caused compatibility issues + with unittest extensions and adding the test name was moved to the + :class:`TextTestResult` in Python 3.2. + + + .. method:: addCleanup(function, *args, **kwargs) + + Add a function to be called after :meth:`tearDown` to cleanup resources + used during the test. Functions will be called in reverse order to the + order they are added (:abbr:`LIFO (last-in, first-out)`). They + are called with any arguments and keyword arguments passed into + :meth:`addCleanup` when they are added. + + If :meth:`setUp` fails, meaning that :meth:`tearDown` is not called, + then any cleanup functions added will still be called. + + .. versionadded:: 3.1 + + + .. method:: doCleanups() + + This method is called unconditionally after :meth:`tearDown`, or + after :meth:`setUp` if :meth:`setUp` raises an exception. + + It is responsible for calling all the cleanup functions added by + :meth:`addCleanup`. If you need cleanup functions to be called + *prior* to :meth:`tearDown` then you can call :meth:`doCleanups` + yourself. + + :meth:`doCleanups` pops methods off the stack of cleanup + functions one at a time, so it can be called at any time. + + .. versionadded:: 3.1 + + +.. class:: FunctionTestCase(testFunc, setUp=None, tearDown=None, description=None) + + This class implements the portion of the :class:`TestCase` interface which + allows the test runner to drive the test, but does not provide the methods + which test code can use to check and report errors. This is used to create + test cases using legacy test code, allowing it to be integrated into a + :mod:`unittest`-based test framework. + + +.. _deprecated-aliases: + +Deprecated aliases +################## + +For historical reasons, some of the :class:`TestCase` methods had one or more +aliases that are now deprecated. The following table lists the correct names +along with their deprecated aliases: + + ============================== ====================== ======================= + Method Name Deprecated alias Deprecated alias + ============================== ====================== ======================= + :meth:`.assertEqual` failUnlessEqual assertEquals + :meth:`.assertNotEqual` failIfEqual assertNotEquals + :meth:`.assertTrue` failUnless assert\_ + :meth:`.assertFalse` failIf + :meth:`.assertRaises` failUnlessRaises + :meth:`.assertAlmostEqual` failUnlessAlmostEqual assertAlmostEquals + :meth:`.assertNotAlmostEqual` failIfAlmostEqual assertNotAlmostEquals + :meth:`.assertRegex` assertRegexpMatches + :meth:`.assertNotRegex` assertNotRegexpMatches + :meth:`.assertRaisesRegex` assertRaisesRegexp + ============================== ====================== ======================= + + .. deprecated:: 3.1 + The fail* aliases listed in the second column have been deprecated. + .. deprecated:: 3.2 + The assert* aliases listed in the third column have been deprecated. + .. deprecated:: 3.2 + ``assertRegexpMatches`` and ``assertRaisesRegexp`` have been renamed to + :meth:`.assertRegex` and :meth:`.assertRaisesRegex`. + .. deprecated:: 3.5 + The ``assertNotRegexpMatches`` name is deprecated in favor of :meth:`.assertNotRegex`. + +.. _testsuite-objects: + +Grouping tests +~~~~~~~~~~~~~~ + +.. class:: TestSuite(tests=()) + + This class represents an aggregation of individual test cases and test suites. + The class presents the interface needed by the test runner to allow it to be run + as any other test case. Running a :class:`TestSuite` instance is the same as + iterating over the suite, running each test individually. + + If *tests* is given, it must be an iterable of individual test cases or other + test suites that will be used to build the suite initially. Additional methods + are provided to add test cases and suites to the collection later on. + + :class:`TestSuite` objects behave much like :class:`TestCase` objects, except + they do not actually implement a test. Instead, they are used to aggregate + tests into groups of tests that should be run together. Some additional + methods are available to add tests to :class:`TestSuite` instances: + + + .. method:: TestSuite.addTest(test) + + Add a :class:`TestCase` or :class:`TestSuite` to the suite. + + + .. method:: TestSuite.addTests(tests) + + Add all the tests from an iterable of :class:`TestCase` and :class:`TestSuite` + instances to this test suite. + + This is equivalent to iterating over *tests*, calling :meth:`addTest` for + each element. + + :class:`TestSuite` shares the following methods with :class:`TestCase`: + + + .. method:: run(result) + + Run the tests associated with this suite, collecting the result into the + test result object passed as *result*. Note that unlike + :meth:`TestCase.run`, :meth:`TestSuite.run` requires the result object to + be passed in. + + + .. method:: debug() + + Run the tests associated with this suite without collecting the + result. This allows exceptions raised by the test to be propagated to the + caller and can be used to support running tests under a debugger. + + + .. method:: countTestCases() + + Return the number of tests represented by this test object, including all + individual tests and sub-suites. + + + .. method:: __iter__() + + Tests grouped by a :class:`TestSuite` are always accessed by iteration. + Subclasses can lazily provide tests by overriding :meth:`__iter__`. Note + that this method may be called several times on a single suite (for + example when counting tests or comparing for equality) so the tests + returned by repeated iterations before :meth:`TestSuite.run` must be the + same for each call iteration. After :meth:`TestSuite.run`, callers should + not rely on the tests returned by this method unless the caller uses a + subclass that overrides :meth:`TestSuite._removeTestAtIndex` to preserve + test references. + + .. versionchanged:: 3.2 + In earlier versions the :class:`TestSuite` accessed tests directly rather + than through iteration, so overriding :meth:`__iter__` wasn't sufficient + for providing tests. + + .. versionchanged:: 3.4 + In earlier versions the :class:`TestSuite` held references to each + :class:`TestCase` after :meth:`TestSuite.run`. Subclasses can restore + that behavior by overriding :meth:`TestSuite._removeTestAtIndex`. + + In the typical usage of a :class:`TestSuite` object, the :meth:`run` method + is invoked by a :class:`TestRunner` rather than by the end-user test harness. + + +Loading and running tests +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. class:: TestLoader() + + The :class:`TestLoader` class is used to create test suites from classes and + modules. Normally, there is no need to create an instance of this class; the + :mod:`unittest` module provides an instance that can be shared as + :data:`unittest.defaultTestLoader`. Using a subclass or instance, however, + allows customization of some configurable properties. + + :class:`TestLoader` objects have the following attributes: + + + .. attribute:: errors + + A list of the non-fatal errors encountered while loading tests. Not reset + by the loader at any point. Fatal errors are signalled by the relevant + a method raising an exception to the caller. Non-fatal errors are also + indicated by a synthetic test that will raise the original error when + run. + + .. versionadded:: 3.5 + + + :class:`TestLoader` objects have the following methods: + + + .. method:: loadTestsFromTestCase(testCaseClass) + + Return a suite of all test cases contained in the :class:`TestCase`\ -derived + :class:`testCaseClass`. + + A test case instance is created for each method named by + :meth:`getTestCaseNames`. By default these are the method names + beginning with ``test``. If :meth:`getTestCaseNames` returns no + methods, but the :meth:`runTest` method is implemented, a single test + case is created for that method instead. + + + .. method:: loadTestsFromModule(module, pattern=None) + + Return a suite of all test cases contained in the given module. This + method searches *module* for classes derived from :class:`TestCase` and + creates an instance of the class for each test method defined for the + class. + + .. note:: + + While using a hierarchy of :class:`TestCase`\ -derived classes can be + convenient in sharing fixtures and helper functions, defining test + methods on base classes that are not intended to be instantiated + directly does not play well with this method. Doing so, however, can + be useful when the fixtures are different and defined in subclasses. + + If a module provides a ``load_tests`` function it will be called to + load the tests. This allows modules to customize test loading. + This is the `load_tests protocol`_. The *pattern* argument is passed as + the third argument to ``load_tests``. + + .. versionchanged:: 3.2 + Support for ``load_tests`` added. + + .. versionchanged:: 3.5 + The undocumented and unofficial *use_load_tests* default argument is + deprecated and ignored, although it is still accepted for backward + compatibility. The method also now accepts a keyword-only argument + *pattern* which is passed to ``load_tests`` as the third argument. + + + .. method:: loadTestsFromName(name, module=None) + + Return a suite of all test cases given a string specifier. + + The specifier *name* is a "dotted name" that may resolve either to a + module, a test case class, a test method within a test case class, a + :class:`TestSuite` instance, or a callable object which returns a + :class:`TestCase` or :class:`TestSuite` instance. These checks are + applied in the order listed here; that is, a method on a possible test + case class will be picked up as "a test method within a test case class", + rather than "a callable object". + + For example, if you have a module :mod:`SampleTests` containing a + :class:`TestCase`\ -derived class :class:`SampleTestCase` with three test + methods (:meth:`test_one`, :meth:`test_two`, and :meth:`test_three`), the + specifier ``'SampleTests.SampleTestCase'`` would cause this method to + return a suite which will run all three test methods. Using the specifier + ``'SampleTests.SampleTestCase.test_two'`` would cause it to return a test + suite which will run only the :meth:`test_two` test method. The specifier + can refer to modules and packages which have not been imported; they will + be imported as a side-effect. + + The method optionally resolves *name* relative to the given *module*. + + .. versionchanged:: 3.5 + If an :exc:`ImportError` or :exc:`AttributeError` occurs while traversing + *name* then a synthetic test that raises that error when run will be + returned. These errors are included in the errors accumulated by + self.errors. + + + .. method:: loadTestsFromNames(names, module=None) + + Similar to :meth:`loadTestsFromName`, but takes a sequence of names rather + than a single name. The return value is a test suite which supports all + the tests defined for each name. + + + .. method:: getTestCaseNames(testCaseClass) + + Return a sorted sequence of method names found within *testCaseClass*; + this should be a subclass of :class:`TestCase`. + + + .. method:: discover(start_dir, pattern='test*.py', top_level_dir=None) + + Find all the test modules by recursing into subdirectories from the + specified start directory, and return a TestSuite object containing them. + Only test files that match *pattern* will be loaded. (Using shell style + pattern matching.) Only module names that are importable (i.e. are valid + Python identifiers) will be loaded. + + All test modules must be importable from the top level of the project. If + the start directory is not the top level directory then the top level + directory must be specified separately. + + If importing a module fails, for example due to a syntax error, then + this will be recorded as a single error and discovery will continue. If + the import failure is due to :exc:`SkipTest` being raised, it will be + recorded as a skip instead of an error. + + If a package (a directory containing a file named :file:`__init__.py`) is + found, the package will be checked for a ``load_tests`` function. If this + exists then it will be called + ``package.load_tests(loader, tests, pattern)``. Test discovery takes care + to ensure that a package is only checked for tests once during an + invocation, even if the load_tests function itself calls + ``loader.discover``. + + If ``load_tests`` exists then discovery does *not* recurse into the + package, ``load_tests`` is responsible for loading all tests in the + package. + + The pattern is deliberately not stored as a loader attribute so that + packages can continue discovery themselves. *top_level_dir* is stored so + ``load_tests`` does not need to pass this argument in to + ``loader.discover()``. + + *start_dir* can be a dotted module name as well as a directory. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.4 + Modules that raise :exc:`SkipTest` on import are recorded as skips, + not errors. + Discovery works for :term:`namespace packages `. + Paths are sorted before being imported so that execution order is + the same even if the underlying file system's ordering is not + dependent on file name. + + .. versionchanged:: 3.5 + Found packages are now checked for ``load_tests`` regardless of + whether their path matches *pattern*, because it is impossible for + a package name to match the default pattern. + + + The following attributes of a :class:`TestLoader` can be configured either by + subclassing or assignment on an instance: + + + .. attribute:: testMethodPrefix + + String giving the prefix of method names which will be interpreted as test + methods. The default value is ``'test'``. + + This affects :meth:`getTestCaseNames` and all the :meth:`loadTestsFrom\*` + methods. + + + .. attribute:: sortTestMethodsUsing + + Function to be used to compare method names when sorting them in + :meth:`getTestCaseNames` and all the :meth:`loadTestsFrom\*` methods. + + + .. attribute:: suiteClass + + Callable object that constructs a test suite from a list of tests. No + methods on the resulting object are needed. The default value is the + :class:`TestSuite` class. + + This affects all the :meth:`loadTestsFrom\*` methods. + + .. attribute:: testNamePatterns + + List of Unix shell-style wildcard test name patterns that test methods + have to match to be included in test suites (see ``-v`` option). + + If this attribute is not ``None`` (the default), all test methods to be + included in test suites must match one of the patterns in this list. + Note that matches are always performed using :meth:`fnmatch.fnmatchcase`, + so unlike patterns passed to the ``-v`` option, simple substring patterns + will have to be converted using ``*`` wildcards. + + This affects all the :meth:`loadTestsFrom\*` methods. + + .. versionadded:: 3.7 + + +.. class:: TestResult + + This class is used to compile information about which tests have succeeded + and which have failed. + + A :class:`TestResult` object stores the results of a set of tests. The + :class:`TestCase` and :class:`TestSuite` classes ensure that results are + properly recorded; test authors do not need to worry about recording the + outcome of tests. + + Testing frameworks built on top of :mod:`unittest` may want access to the + :class:`TestResult` object generated by running a set of tests for reporting + purposes; a :class:`TestResult` instance is returned by the + :meth:`TestRunner.run` method for this purpose. + + :class:`TestResult` instances have the following attributes that will be of + interest when inspecting the results of running a set of tests: + + + .. attribute:: errors + + A list containing 2-tuples of :class:`TestCase` instances and strings + holding formatted tracebacks. Each tuple represents a test which raised an + unexpected exception. + + .. attribute:: failures + + A list containing 2-tuples of :class:`TestCase` instances and strings + holding formatted tracebacks. Each tuple represents a test where a failure + was explicitly signalled using the :meth:`TestCase.assert\*` methods. + + .. attribute:: skipped + + A list containing 2-tuples of :class:`TestCase` instances and strings + holding the reason for skipping the test. + + .. versionadded:: 3.1 + + .. attribute:: expectedFailures + + A list containing 2-tuples of :class:`TestCase` instances and strings + holding formatted tracebacks. Each tuple represents an expected failure + of the test case. + + .. attribute:: unexpectedSuccesses + + A list containing :class:`TestCase` instances that were marked as expected + failures, but succeeded. + + .. attribute:: shouldStop + + Set to ``True`` when the execution of tests should stop by :meth:`stop`. + + .. attribute:: testsRun + + The total number of tests run so far. + + .. attribute:: buffer + + If set to true, ``sys.stdout`` and ``sys.stderr`` will be buffered in between + :meth:`startTest` and :meth:`stopTest` being called. Collected output will + only be echoed onto the real ``sys.stdout`` and ``sys.stderr`` if the test + fails or errors. Any output is also attached to the failure / error message. + + .. versionadded:: 3.2 + + .. attribute:: failfast + + If set to true :meth:`stop` will be called on the first failure or error, + halting the test run. + + .. versionadded:: 3.2 + + .. attribute:: tb_locals + + If set to true then local variables will be shown in tracebacks. + + .. versionadded:: 3.5 + + .. method:: wasSuccessful() + + Return ``True`` if all tests run so far have passed, otherwise returns + ``False``. + + .. versionchanged:: 3.4 + Returns ``False`` if there were any :attr:`unexpectedSuccesses` + from tests marked with the :func:`expectedFailure` decorator. + + .. method:: stop() + + This method can be called to signal that the set of tests being run should + be aborted by setting the :attr:`shouldStop` attribute to ``True``. + :class:`TestRunner` objects should respect this flag and return without + running any additional tests. + + For example, this feature is used by the :class:`TextTestRunner` class to + stop the test framework when the user signals an interrupt from the + keyboard. Interactive tools which provide :class:`TestRunner` + implementations can use this in a similar manner. + + The following methods of the :class:`TestResult` class are used to maintain + the internal data structures, and may be extended in subclasses to support + additional reporting requirements. This is particularly useful in building + tools which support interactive reporting while tests are being run. + + + .. method:: startTest(test) + + Called when the test case *test* is about to be run. + + .. method:: stopTest(test) + + Called after the test case *test* has been executed, regardless of the + outcome. + + .. method:: startTestRun() + + Called once before any tests are executed. + + .. versionadded:: 3.1 + + + .. method:: stopTestRun() + + Called once after all tests are executed. + + .. versionadded:: 3.1 + + + .. method:: addError(test, err) + + Called when the test case *test* raises an unexpected exception. *err* is a + tuple of the form returned by :func:`sys.exc_info`: ``(type, value, + traceback)``. + + The default implementation appends a tuple ``(test, formatted_err)`` to + the instance's :attr:`errors` attribute, where *formatted_err* is a + formatted traceback derived from *err*. + + + .. method:: addFailure(test, err) + + Called when the test case *test* signals a failure. *err* is a tuple of + the form returned by :func:`sys.exc_info`: ``(type, value, traceback)``. + + The default implementation appends a tuple ``(test, formatted_err)`` to + the instance's :attr:`failures` attribute, where *formatted_err* is a + formatted traceback derived from *err*. + + + .. method:: addSuccess(test) + + Called when the test case *test* succeeds. + + The default implementation does nothing. + + + .. method:: addSkip(test, reason) + + Called when the test case *test* is skipped. *reason* is the reason the + test gave for skipping. + + The default implementation appends a tuple ``(test, reason)`` to the + instance's :attr:`skipped` attribute. + + + .. method:: addExpectedFailure(test, err) + + Called when the test case *test* fails, but was marked with the + :func:`expectedFailure` decorator. + + The default implementation appends a tuple ``(test, formatted_err)`` to + the instance's :attr:`expectedFailures` attribute, where *formatted_err* + is a formatted traceback derived from *err*. + + + .. method:: addUnexpectedSuccess(test) + + Called when the test case *test* was marked with the + :func:`expectedFailure` decorator, but succeeded. + + The default implementation appends the test to the instance's + :attr:`unexpectedSuccesses` attribute. + + + .. method:: addSubTest(test, subtest, outcome) + + Called when a subtest finishes. *test* is the test case + corresponding to the test method. *subtest* is a custom + :class:`TestCase` instance describing the subtest. + + If *outcome* is :const:`None`, the subtest succeeded. Otherwise, + it failed with an exception where *outcome* is a tuple of the form + returned by :func:`sys.exc_info`: ``(type, value, traceback)``. + + The default implementation does nothing when the outcome is a + success, and records subtest failures as normal failures. + + .. versionadded:: 3.4 + + +.. class:: TextTestResult(stream, descriptions, verbosity) + + A concrete implementation of :class:`TestResult` used by the + :class:`TextTestRunner`. + + .. versionadded:: 3.2 + This class was previously named ``_TextTestResult``. The old name still + exists as an alias but is deprecated. + + +.. data:: defaultTestLoader + + Instance of the :class:`TestLoader` class intended to be shared. If no + customization of the :class:`TestLoader` is needed, this instance can be used + instead of repeatedly creating new instances. + + +.. class:: TextTestRunner(stream=None, descriptions=True, verbosity=1, failfast=False, \ + buffer=False, resultclass=None, warnings=None, *, tb_locals=False) + + A basic test runner implementation that outputs results to a stream. If *stream* + is ``None``, the default, :data:`sys.stderr` is used as the output stream. This class + has a few configurable parameters, but is essentially very simple. Graphical + applications which run test suites should provide alternate implementations. Such + implementations should accept ``**kwargs`` as the interface to construct runners + changes when features are added to unittest. + + By default this runner shows :exc:`DeprecationWarning`, + :exc:`PendingDeprecationWarning`, :exc:`ResourceWarning` and + :exc:`ImportWarning` even if they are :ref:`ignored by default + `. Deprecation warnings caused by :ref:`deprecated unittest + methods ` are also special-cased and, when the warning + filters are ``'default'`` or ``'always'``, they will appear only once + per-module, in order to avoid too many warning messages. This behavior can + be overridden using Python's :option:`!-Wd` or :option:`!-Wa` options + (see :ref:`Warning control `) and leaving + *warnings* to ``None``. + + .. versionchanged:: 3.2 + Added the ``warnings`` argument. + + .. versionchanged:: 3.2 + The default stream is set to :data:`sys.stderr` at instantiation time rather + than import time. + + .. versionchanged:: 3.5 + Added the tb_locals parameter. + + .. method:: _makeResult() + + This method returns the instance of ``TestResult`` used by :meth:`run`. + It is not intended to be called directly, but can be overridden in + subclasses to provide a custom ``TestResult``. + + ``_makeResult()`` instantiates the class or callable passed in the + ``TextTestRunner`` constructor as the ``resultclass`` argument. It + defaults to :class:`TextTestResult` if no ``resultclass`` is provided. + The result class is instantiated with the following arguments:: + + stream, descriptions, verbosity + + .. method:: run(test) + + This method is the main public interface to the ``TextTestRunner``. This + method takes a :class:`TestSuite` or :class:`TestCase` instance. A + :class:`TestResult` is created by calling + :func:`_makeResult` and the test(s) are run and the + results printed to stdout. + + +.. function:: main(module='__main__', defaultTest=None, argv=None, testRunner=None, \ + testLoader=unittest.defaultTestLoader, exit=True, verbosity=1, \ + failfast=None, catchbreak=None, buffer=None, warnings=None) + + A command-line program that loads a set of tests from *module* and runs them; + this is primarily for making test modules conveniently executable. + The simplest use for this function is to include the following line at the + end of a test script:: + + if __name__ == '__main__': + unittest.main() + + You can run tests with more detailed information by passing in the verbosity + argument:: + + if __name__ == '__main__': + unittest.main(verbosity=2) + + The *defaultTest* argument is either the name of a single test or an + iterable of test names to run if no test names are specified via *argv*. If + not specified or ``None`` and no test names are provided via *argv*, all + tests found in *module* are run. + + The *argv* argument can be a list of options passed to the program, with the + first element being the program name. If not specified or ``None``, + the values of :data:`sys.argv` are used. + + The *testRunner* argument can either be a test runner class or an already + created instance of it. By default ``main`` calls :func:`sys.exit` with + an exit code indicating success or failure of the tests run. + + The *testLoader* argument has to be a :class:`TestLoader` instance, + and defaults to :data:`defaultTestLoader`. + + ``main`` supports being used from the interactive interpreter by passing in the + argument ``exit=False``. This displays the result on standard output without + calling :func:`sys.exit`:: + + >>> from unittest import main + >>> main(module='test_module', exit=False) + + The *failfast*, *catchbreak* and *buffer* parameters have the same + effect as the same-name `command-line options`_. + + The *warnings* argument specifies the :ref:`warning filter ` + that should be used while running the tests. If it's not specified, it will + remain ``None`` if a :option:`!-W` option is passed to :program:`python` + (see :ref:`Warning control `), + otherwise it will be set to ``'default'``. + + Calling ``main`` actually returns an instance of the ``TestProgram`` class. + This stores the result of the tests run as the ``result`` attribute. + + .. versionchanged:: 3.1 + The *exit* parameter was added. + + .. versionchanged:: 3.2 + The *verbosity*, *failfast*, *catchbreak*, *buffer* + and *warnings* parameters were added. + + .. versionchanged:: 3.4 + The *defaultTest* parameter was changed to also accept an iterable of + test names. + + +load_tests Protocol +################### + +.. versionadded:: 3.2 + +Modules or packages can customize how tests are loaded from them during normal +test runs or test discovery by implementing a function called ``load_tests``. + +If a test module defines ``load_tests`` it will be called by +:meth:`TestLoader.loadTestsFromModule` with the following arguments:: + + load_tests(loader, standard_tests, pattern) + +where *pattern* is passed straight through from ``loadTestsFromModule``. It +defaults to ``None``. + +It should return a :class:`TestSuite`. + +*loader* is the instance of :class:`TestLoader` doing the loading. +*standard_tests* are the tests that would be loaded by default from the +module. It is common for test modules to only want to add or remove tests +from the standard set of tests. +The third argument is used when loading packages as part of test discovery. + +A typical ``load_tests`` function that loads tests from a specific set of +:class:`TestCase` classes may look like:: + + test_cases = (TestCase1, TestCase2, TestCase3) + + def load_tests(loader, tests, pattern): + suite = TestSuite() + for test_class in test_cases: + tests = loader.loadTestsFromTestCase(test_class) + suite.addTests(tests) + return suite + +If discovery is started in a directory containing a package, either from the +command line or by calling :meth:`TestLoader.discover`, then the package +:file:`__init__.py` will be checked for ``load_tests``. If that function does +not exist, discovery will recurse into the package as though it were just +another directory. Otherwise, discovery of the package's tests will be left up +to ``load_tests`` which is called with the following arguments:: + + load_tests(loader, standard_tests, pattern) + +This should return a :class:`TestSuite` representing all the tests +from the package. (``standard_tests`` will only contain tests +collected from :file:`__init__.py`.) + +Because the pattern is passed into ``load_tests`` the package is free to +continue (and potentially modify) test discovery. A 'do nothing' +``load_tests`` function for a test package would look like:: + + def load_tests(loader, standard_tests, pattern): + # top level directory cached on loader instance + this_dir = os.path.dirname(__file__) + package_tests = loader.discover(start_dir=this_dir, pattern=pattern) + standard_tests.addTests(package_tests) + return standard_tests + +.. versionchanged:: 3.5 + Discovery no longer checks package names for matching *pattern* due to the + impossibility of package names matching the default pattern. + + + +Class and Module Fixtures +------------------------- + +Class and module level fixtures are implemented in :class:`TestSuite`. When +the test suite encounters a test from a new class then :meth:`tearDownClass` +from the previous class (if there is one) is called, followed by +:meth:`setUpClass` from the new class. + +Similarly if a test is from a different module from the previous test then +``tearDownModule`` from the previous module is run, followed by +``setUpModule`` from the new module. + +After all the tests have run the final ``tearDownClass`` and +``tearDownModule`` are run. + +Note that shared fixtures do not play well with [potential] features like test +parallelization and they break test isolation. They should be used with care. + +The default ordering of tests created by the unittest test loaders is to group +all tests from the same modules and classes together. This will lead to +``setUpClass`` / ``setUpModule`` (etc) being called exactly once per class and +module. If you randomize the order, so that tests from different modules and +classes are adjacent to each other, then these shared fixture functions may be +called multiple times in a single test run. + +Shared fixtures are not intended to work with suites with non-standard +ordering. A ``BaseTestSuite`` still exists for frameworks that don't want to +support shared fixtures. + +If there are any exceptions raised during one of the shared fixture functions +the test is reported as an error. Because there is no corresponding test +instance an ``_ErrorHolder`` object (that has the same interface as a +:class:`TestCase`) is created to represent the error. If you are just using +the standard unittest test runner then this detail doesn't matter, but if you +are a framework author it may be relevant. + + +setUpClass and tearDownClass +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +These must be implemented as class methods:: + + import unittest + + class Test(unittest.TestCase): + @classmethod + def setUpClass(cls): + cls._connection = createExpensiveConnectionObject() + + @classmethod + def tearDownClass(cls): + cls._connection.destroy() + +If you want the ``setUpClass`` and ``tearDownClass`` on base classes called +then you must call up to them yourself. The implementations in +:class:`TestCase` are empty. + +If an exception is raised during a ``setUpClass`` then the tests in the class +are not run and the ``tearDownClass`` is not run. Skipped classes will not +have ``setUpClass`` or ``tearDownClass`` run. If the exception is a +:exc:`SkipTest` exception then the class will be reported as having been skipped +instead of as an error. + + +setUpModule and tearDownModule +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +These should be implemented as functions:: + + def setUpModule(): + createConnection() + + def tearDownModule(): + closeConnection() + +If an exception is raised in a ``setUpModule`` then none of the tests in the +module will be run and the ``tearDownModule`` will not be run. If the exception is a +:exc:`SkipTest` exception then the module will be reported as having been skipped +instead of as an error. + + +Signal Handling +--------------- + +.. versionadded:: 3.2 + +The :option:`-c/--catch ` command-line option to unittest, +along with the ``catchbreak`` parameter to :func:`unittest.main()`, provide +more friendly handling of control-C during a test run. With catch break +behavior enabled control-C will allow the currently running test to complete, +and the test run will then end and report all the results so far. A second +control-c will raise a :exc:`KeyboardInterrupt` in the usual way. + +The control-c handling signal handler attempts to remain compatible with code or +tests that install their own :const:`signal.SIGINT` handler. If the ``unittest`` +handler is called but *isn't* the installed :const:`signal.SIGINT` handler, +i.e. it has been replaced by the system under test and delegated to, then it +calls the default handler. This will normally be the expected behavior by code +that replaces an installed handler and delegates to it. For individual tests +that need ``unittest`` control-c handling disabled the :func:`removeHandler` +decorator can be used. + +There are a few utility functions for framework authors to enable control-c +handling functionality within test frameworks. + +.. function:: installHandler() + + Install the control-c handler. When a :const:`signal.SIGINT` is received + (usually in response to the user pressing control-c) all registered results + have :meth:`~TestResult.stop` called. + + +.. function:: registerResult(result) + + Register a :class:`TestResult` object for control-c handling. Registering a + result stores a weak reference to it, so it doesn't prevent the result from + being garbage collected. + + Registering a :class:`TestResult` object has no side-effects if control-c + handling is not enabled, so test frameworks can unconditionally register + all results they create independently of whether or not handling is enabled. + + +.. function:: removeResult(result) + + Remove a registered result. Once a result has been removed then + :meth:`~TestResult.stop` will no longer be called on that result object in + response to a control-c. + + +.. function:: removeHandler(function=None) + + When called without arguments this function removes the control-c handler + if it has been installed. This function can also be used as a test decorator + to temporarily remove the handler while the test is being executed:: + + @unittest.removeHandler + def test_signal_handling(self): + ... diff --git a/python-3.7.4-docs-html/_sources/library/unix.rst.txt b/python-3.7.4-docs-html/_sources/library/unix.rst.txt new file mode 100644 index 0000000..04d4081 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/unix.rst.txt @@ -0,0 +1,26 @@ +.. _unix: + +********************** +Unix Specific Services +********************** + +The modules described in this chapter provide interfaces to features that are +unique to the Unix operating system, or in some cases to some or many variants +of it. Here's an overview: + + +.. toctree:: + + posix.rst + pwd.rst + spwd.rst + grp.rst + crypt.rst + termios.rst + tty.rst + pty.rst + fcntl.rst + pipes.rst + resource.rst + nis.rst + syslog.rst diff --git a/python-3.7.4-docs-html/_sources/library/urllib.error.rst.txt b/python-3.7.4-docs-html/_sources/library/urllib.error.rst.txt new file mode 100644 index 0000000..f7d47ed --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/urllib.error.rst.txt @@ -0,0 +1,66 @@ +:mod:`urllib.error` --- Exception classes raised by urllib.request +================================================================== + +.. module:: urllib.error + :synopsis: Exception classes raised by urllib.request. + +.. moduleauthor:: Jeremy Hylton +.. sectionauthor:: Senthil Kumaran + +**Source code:** :source:`Lib/urllib/error.py` + +-------------- + +The :mod:`urllib.error` module defines the exception classes for exceptions +raised by :mod:`urllib.request`. The base exception class is :exc:`URLError`. + +The following exceptions are raised by :mod:`urllib.error` as appropriate: + +.. exception:: URLError + + The handlers raise this exception (or derived exceptions) when they run into + a problem. It is a subclass of :exc:`OSError`. + + .. attribute:: reason + + The reason for this error. It can be a message string or another + exception instance. + + .. versionchanged:: 3.3 + :exc:`URLError` has been made a subclass of :exc:`OSError` instead + of :exc:`IOError`. + + +.. exception:: HTTPError + + Though being an exception (a subclass of :exc:`URLError`), an + :exc:`HTTPError` can also function as a non-exceptional file-like return + value (the same thing that :func:`~urllib.request.urlopen` returns). This + is useful when handling exotic HTTP errors, such as requests for + authentication. + + .. attribute:: code + + An HTTP status code as defined in :rfc:`2616`. This numeric value corresponds + to a value found in the dictionary of codes as found in + :attr:`http.server.BaseHTTPRequestHandler.responses`. + + .. attribute:: reason + + This is usually a string explaining the reason for this error. + + .. attribute:: headers + + The HTTP response headers for the HTTP request that caused the + :exc:`HTTPError`. + + .. versionadded:: 3.4 + +.. exception:: ContentTooShortError(msg, content) + + This exception is raised when the :func:`~urllib.request.urlretrieve` + function detects that + the amount of the downloaded data is less than the expected amount (given by + the *Content-Length* header). The :attr:`content` attribute stores the + downloaded (and supposedly truncated) data. + diff --git a/python-3.7.4-docs-html/_sources/library/urllib.parse.rst.txt b/python-3.7.4-docs-html/_sources/library/urllib.parse.rst.txt new file mode 100644 index 0000000..ddc3ee2 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/urllib.parse.rst.txt @@ -0,0 +1,666 @@ +:mod:`urllib.parse` --- Parse URLs into components +================================================== + +.. module:: urllib.parse + :synopsis: Parse URLs into or assemble them from components. + +**Source code:** :source:`Lib/urllib/parse.py` + +.. index:: + single: WWW + single: World Wide Web + single: URL + pair: URL; parsing + pair: relative; URL + +-------------- + +This module defines a standard interface to break Uniform Resource Locator (URL) +strings up in components (addressing scheme, network location, path etc.), to +combine the components back into a URL string, and to convert a "relative URL" +to an absolute URL given a "base URL." + +The module has been designed to match the Internet RFC on Relative Uniform +Resource Locators. It supports the following URL schemes: ``file``, ``ftp``, +``gopher``, ``hdl``, ``http``, ``https``, ``imap``, ``mailto``, ``mms``, +``news``, ``nntp``, ``prospero``, ``rsync``, ``rtsp``, ``rtspu``, ``sftp``, +``shttp``, ``sip``, ``sips``, ``snews``, ``svn``, ``svn+ssh``, ``telnet``, +``wais``, ``ws``, ``wss``. + +The :mod:`urllib.parse` module defines functions that fall into two broad +categories: URL parsing and URL quoting. These are covered in detail in +the following sections. + +URL Parsing +----------- + +The URL parsing functions focus on splitting a URL string into its components, +or on combining URL components into a URL string. + +.. function:: urlparse(urlstring, scheme='', allow_fragments=True) + + Parse a URL into six components, returning a 6-item :term:`named tuple`. This + corresponds to the general structure of a URL: + ``scheme://netloc/path;parameters?query#fragment``. + Each tuple item is a string, possibly empty. The components are not broken up in + smaller parts (for example, the network location is a single string), and % + escapes are not expanded. The delimiters as shown above are not part of the + result, except for a leading slash in the *path* component, which is retained if + present. For example: + + >>> from urllib.parse import urlparse + >>> o = urlparse('http://www.cwi.nl:80/%7Eguido/Python.html') + >>> o # doctest: +NORMALIZE_WHITESPACE + ParseResult(scheme='http', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html', + params='', query='', fragment='') + >>> o.scheme + 'http' + >>> o.port + 80 + >>> o.geturl() + 'http://www.cwi.nl:80/%7Eguido/Python.html' + + Following the syntax specifications in :rfc:`1808`, urlparse recognizes + a netloc only if it is properly introduced by '//'. Otherwise the + input is presumed to be a relative URL and thus to start with + a path component. + + .. doctest:: + :options: +NORMALIZE_WHITESPACE + + >>> from urllib.parse import urlparse + >>> urlparse('//www.cwi.nl:80/%7Eguido/Python.html') + ParseResult(scheme='', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html', + params='', query='', fragment='') + >>> urlparse('www.cwi.nl/%7Eguido/Python.html') + ParseResult(scheme='', netloc='', path='www.cwi.nl/%7Eguido/Python.html', + params='', query='', fragment='') + >>> urlparse('help/Python.html') + ParseResult(scheme='', netloc='', path='help/Python.html', params='', + query='', fragment='') + + The *scheme* argument gives the default addressing scheme, to be + used only if the URL does not specify one. It should be the same type + (text or bytes) as *urlstring*, except that the default value ``''`` is + always allowed, and is automatically converted to ``b''`` if appropriate. + + If the *allow_fragments* argument is false, fragment identifiers are not + recognized. Instead, they are parsed as part of the path, parameters + or query component, and :attr:`fragment` is set to the empty string in + the return value. + + The return value is a :term:`named tuple`, which means that its items can + be accessed by index or as named attributes, which are: + + +------------------+-------+--------------------------+----------------------+ + | Attribute | Index | Value | Value if not present | + +==================+=======+==========================+======================+ + | :attr:`scheme` | 0 | URL scheme specifier | *scheme* parameter | + +------------------+-------+--------------------------+----------------------+ + | :attr:`netloc` | 1 | Network location part | empty string | + +------------------+-------+--------------------------+----------------------+ + | :attr:`path` | 2 | Hierarchical path | empty string | + +------------------+-------+--------------------------+----------------------+ + | :attr:`params` | 3 | Parameters for last path | empty string | + | | | element | | + +------------------+-------+--------------------------+----------------------+ + | :attr:`query` | 4 | Query component | empty string | + +------------------+-------+--------------------------+----------------------+ + | :attr:`fragment` | 5 | Fragment identifier | empty string | + +------------------+-------+--------------------------+----------------------+ + | :attr:`username` | | User name | :const:`None` | + +------------------+-------+--------------------------+----------------------+ + | :attr:`password` | | Password | :const:`None` | + +------------------+-------+--------------------------+----------------------+ + | :attr:`hostname` | | Host name (lower case) | :const:`None` | + +------------------+-------+--------------------------+----------------------+ + | :attr:`port` | | Port number as integer, | :const:`None` | + | | | if present | | + +------------------+-------+--------------------------+----------------------+ + + Reading the :attr:`port` attribute will raise a :exc:`ValueError` if + an invalid port is specified in the URL. See section + :ref:`urlparse-result-object` for more information on the result object. + + Unmatched square brackets in the :attr:`netloc` attribute will raise a + :exc:`ValueError`. + + Characters in the :attr:`netloc` attribute that decompose under NFKC + normalization (as used by the IDNA encoding) into any of ``/``, ``?``, + ``#``, ``@``, or ``:`` will raise a :exc:`ValueError`. If the URL is + decomposed before parsing, no error will be raised. + + As is the case with all named tuples, the subclass has a few additional methods + and attributes that are particularly useful. One such method is :meth:`_replace`. + The :meth:`_replace` method will return a new ParseResult object replacing specified + fields with new values. + + .. doctest:: + :options: +NORMALIZE_WHITESPACE + + >>> from urllib.parse import urlparse + >>> u = urlparse('//www.cwi.nl:80/%7Eguido/Python.html') + >>> u + ParseResult(scheme='', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html', + params='', query='', fragment='') + >>> u._replace(scheme='http') + ParseResult(scheme='http', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html', + params='', query='', fragment='') + + + .. versionchanged:: 3.2 + Added IPv6 URL parsing capabilities. + + .. versionchanged:: 3.3 + The fragment is now parsed for all URL schemes (unless *allow_fragment* is + false), in accordance with :rfc:`3986`. Previously, a whitelist of + schemes that support fragments existed. + + .. versionchanged:: 3.6 + Out-of-range port numbers now raise :exc:`ValueError`, instead of + returning :const:`None`. + + .. versionchanged:: 3.7.3 + Characters that affect netloc parsing under NFKC normalization will + now raise :exc:`ValueError`. + + +.. function:: parse_qs(qs, keep_blank_values=False, strict_parsing=False, encoding='utf-8', errors='replace', max_num_fields=None) + + Parse a query string given as a string argument (data of type + :mimetype:`application/x-www-form-urlencoded`). Data are returned as a + dictionary. The dictionary keys are the unique query variable names and the + values are lists of values for each name. + + The optional argument *keep_blank_values* is a flag indicating whether blank + values in percent-encoded queries should be treated as blank strings. A true value + indicates that blanks should be retained as blank strings. The default false + value indicates that blank values are to be ignored and treated as if they were + not included. + + The optional argument *strict_parsing* is a flag indicating what to do with + parsing errors. If false (the default), errors are silently ignored. If true, + errors raise a :exc:`ValueError` exception. + + The optional *encoding* and *errors* parameters specify how to decode + percent-encoded sequences into Unicode characters, as accepted by the + :meth:`bytes.decode` method. + + The optional argument *max_num_fields* is the maximum number of fields to + read. If set, then throws a :exc:`ValueError` if there are more than + *max_num_fields* fields read. + + Use the :func:`urllib.parse.urlencode` function (with the ``doseq`` + parameter set to ``True``) to convert such dictionaries into query + strings. + + .. versionchanged:: 3.2 + Add *encoding* and *errors* parameters. + + .. versionchanged:: 3.7.2 + Added *max_num_fields* parameter. + + +.. function:: parse_qsl(qs, keep_blank_values=False, strict_parsing=False, encoding='utf-8', errors='replace', max_num_fields=None) + + Parse a query string given as a string argument (data of type + :mimetype:`application/x-www-form-urlencoded`). Data are returned as a list of + name, value pairs. + + The optional argument *keep_blank_values* is a flag indicating whether blank + values in percent-encoded queries should be treated as blank strings. A true value + indicates that blanks should be retained as blank strings. The default false + value indicates that blank values are to be ignored and treated as if they were + not included. + + The optional argument *strict_parsing* is a flag indicating what to do with + parsing errors. If false (the default), errors are silently ignored. If true, + errors raise a :exc:`ValueError` exception. + + The optional *encoding* and *errors* parameters specify how to decode + percent-encoded sequences into Unicode characters, as accepted by the + :meth:`bytes.decode` method. + + The optional argument *max_num_fields* is the maximum number of fields to + read. If set, then throws a :exc:`ValueError` if there are more than + *max_num_fields* fields read. + + Use the :func:`urllib.parse.urlencode` function to convert such lists of pairs into + query strings. + + .. versionchanged:: 3.2 + Add *encoding* and *errors* parameters. + + .. versionchanged:: 3.7.2 + Added *max_num_fields* parameter. + +.. function:: urlunparse(parts) + + Construct a URL from a tuple as returned by ``urlparse()``. The *parts* + argument can be any six-item iterable. This may result in a slightly + different, but equivalent URL, if the URL that was parsed originally had + unnecessary delimiters (for example, a ``?`` with an empty query; the RFC + states that these are equivalent). + + +.. function:: urlsplit(urlstring, scheme='', allow_fragments=True) + + This is similar to :func:`urlparse`, but does not split the params from the URL. + This should generally be used instead of :func:`urlparse` if the more recent URL + syntax allowing parameters to be applied to each segment of the *path* portion + of the URL (see :rfc:`2396`) is wanted. A separate function is needed to + separate the path segments and parameters. This function returns a 5-item + :term:`named tuple`:: + + (addressing scheme, network location, path, query, fragment identifier). + + The return value is a :term:`named tuple`, its items can be accessed by index + or as named attributes: + + +------------------+-------+-------------------------+----------------------+ + | Attribute | Index | Value | Value if not present | + +==================+=======+=========================+======================+ + | :attr:`scheme` | 0 | URL scheme specifier | *scheme* parameter | + +------------------+-------+-------------------------+----------------------+ + | :attr:`netloc` | 1 | Network location part | empty string | + +------------------+-------+-------------------------+----------------------+ + | :attr:`path` | 2 | Hierarchical path | empty string | + +------------------+-------+-------------------------+----------------------+ + | :attr:`query` | 3 | Query component | empty string | + +------------------+-------+-------------------------+----------------------+ + | :attr:`fragment` | 4 | Fragment identifier | empty string | + +------------------+-------+-------------------------+----------------------+ + | :attr:`username` | | User name | :const:`None` | + +------------------+-------+-------------------------+----------------------+ + | :attr:`password` | | Password | :const:`None` | + +------------------+-------+-------------------------+----------------------+ + | :attr:`hostname` | | Host name (lower case) | :const:`None` | + +------------------+-------+-------------------------+----------------------+ + | :attr:`port` | | Port number as integer, | :const:`None` | + | | | if present | | + +------------------+-------+-------------------------+----------------------+ + + Reading the :attr:`port` attribute will raise a :exc:`ValueError` if + an invalid port is specified in the URL. See section + :ref:`urlparse-result-object` for more information on the result object. + + Unmatched square brackets in the :attr:`netloc` attribute will raise a + :exc:`ValueError`. + + Characters in the :attr:`netloc` attribute that decompose under NFKC + normalization (as used by the IDNA encoding) into any of ``/``, ``?``, + ``#``, ``@``, or ``:`` will raise a :exc:`ValueError`. If the URL is + decomposed before parsing, no error will be raised. + + .. versionchanged:: 3.6 + Out-of-range port numbers now raise :exc:`ValueError`, instead of + returning :const:`None`. + + .. versionchanged:: 3.7.3 + Characters that affect netloc parsing under NFKC normalization will + now raise :exc:`ValueError`. + + +.. function:: urlunsplit(parts) + + Combine the elements of a tuple as returned by :func:`urlsplit` into a + complete URL as a string. The *parts* argument can be any five-item + iterable. This may result in a slightly different, but equivalent URL, if the + URL that was parsed originally had unnecessary delimiters (for example, a ? + with an empty query; the RFC states that these are equivalent). + + +.. function:: urljoin(base, url, allow_fragments=True) + + Construct a full ("absolute") URL by combining a "base URL" (*base*) with + another URL (*url*). Informally, this uses components of the base URL, in + particular the addressing scheme, the network location and (part of) the + path, to provide missing components in the relative URL. For example: + + >>> from urllib.parse import urljoin + >>> urljoin('http://www.cwi.nl/%7Eguido/Python.html', 'FAQ.html') + 'http://www.cwi.nl/%7Eguido/FAQ.html' + + The *allow_fragments* argument has the same meaning and default as for + :func:`urlparse`. + + .. note:: + + If *url* is an absolute URL (that is, starting with ``//`` or ``scheme://``), + the *url*'s host name and/or scheme will be present in the result. For example: + + .. doctest:: + + >>> urljoin('http://www.cwi.nl/%7Eguido/Python.html', + ... '//www.python.org/%7Eguido') + 'http://www.python.org/%7Eguido' + + If you do not want that behavior, preprocess the *url* with :func:`urlsplit` and + :func:`urlunsplit`, removing possible *scheme* and *netloc* parts. + + + .. versionchanged:: 3.5 + + Behaviour updated to match the semantics defined in :rfc:`3986`. + + +.. function:: urldefrag(url) + + If *url* contains a fragment identifier, return a modified version of *url* + with no fragment identifier, and the fragment identifier as a separate + string. If there is no fragment identifier in *url*, return *url* unmodified + and an empty string. + + The return value is a :term:`named tuple`, its items can be accessed by index + or as named attributes: + + +------------------+-------+-------------------------+----------------------+ + | Attribute | Index | Value | Value if not present | + +==================+=======+=========================+======================+ + | :attr:`url` | 0 | URL with no fragment | empty string | + +------------------+-------+-------------------------+----------------------+ + | :attr:`fragment` | 1 | Fragment identifier | empty string | + +------------------+-------+-------------------------+----------------------+ + + See section :ref:`urlparse-result-object` for more information on the result + object. + + .. versionchanged:: 3.2 + Result is a structured object rather than a simple 2-tuple. + +.. _parsing-ascii-encoded-bytes: + +Parsing ASCII Encoded Bytes +--------------------------- + +The URL parsing functions were originally designed to operate on character +strings only. In practice, it is useful to be able to manipulate properly +quoted and encoded URLs as sequences of ASCII bytes. Accordingly, the +URL parsing functions in this module all operate on :class:`bytes` and +:class:`bytearray` objects in addition to :class:`str` objects. + +If :class:`str` data is passed in, the result will also contain only +:class:`str` data. If :class:`bytes` or :class:`bytearray` data is +passed in, the result will contain only :class:`bytes` data. + +Attempting to mix :class:`str` data with :class:`bytes` or +:class:`bytearray` in a single function call will result in a +:exc:`TypeError` being raised, while attempting to pass in non-ASCII +byte values will trigger :exc:`UnicodeDecodeError`. + +To support easier conversion of result objects between :class:`str` and +:class:`bytes`, all return values from URL parsing functions provide +either an :meth:`encode` method (when the result contains :class:`str` +data) or a :meth:`decode` method (when the result contains :class:`bytes` +data). The signatures of these methods match those of the corresponding +:class:`str` and :class:`bytes` methods (except that the default encoding +is ``'ascii'`` rather than ``'utf-8'``). Each produces a value of a +corresponding type that contains either :class:`bytes` data (for +:meth:`encode` methods) or :class:`str` data (for +:meth:`decode` methods). + +Applications that need to operate on potentially improperly quoted URLs +that may contain non-ASCII data will need to do their own decoding from +bytes to characters before invoking the URL parsing methods. + +The behaviour described in this section applies only to the URL parsing +functions. The URL quoting functions use their own rules when producing +or consuming byte sequences as detailed in the documentation of the +individual URL quoting functions. + +.. versionchanged:: 3.2 + URL parsing functions now accept ASCII encoded byte sequences + + +.. _urlparse-result-object: + +Structured Parse Results +------------------------ + +The result objects from the :func:`urlparse`, :func:`urlsplit` and +:func:`urldefrag` functions are subclasses of the :class:`tuple` type. +These subclasses add the attributes listed in the documentation for +those functions, the encoding and decoding support described in the +previous section, as well as an additional method: + +.. method:: urllib.parse.SplitResult.geturl() + + Return the re-combined version of the original URL as a string. This may + differ from the original URL in that the scheme may be normalized to lower + case and empty components may be dropped. Specifically, empty parameters, + queries, and fragment identifiers will be removed. + + For :func:`urldefrag` results, only empty fragment identifiers will be removed. + For :func:`urlsplit` and :func:`urlparse` results, all noted changes will be + made to the URL returned by this method. + + The result of this method remains unchanged if passed back through the original + parsing function: + + >>> from urllib.parse import urlsplit + >>> url = 'HTTP://www.Python.org/doc/#' + >>> r1 = urlsplit(url) + >>> r1.geturl() + 'http://www.Python.org/doc/' + >>> r2 = urlsplit(r1.geturl()) + >>> r2.geturl() + 'http://www.Python.org/doc/' + + +The following classes provide the implementations of the structured parse +results when operating on :class:`str` objects: + +.. class:: DefragResult(url, fragment) + + Concrete class for :func:`urldefrag` results containing :class:`str` + data. The :meth:`encode` method returns a :class:`DefragResultBytes` + instance. + + .. versionadded:: 3.2 + +.. class:: ParseResult(scheme, netloc, path, params, query, fragment) + + Concrete class for :func:`urlparse` results containing :class:`str` + data. The :meth:`encode` method returns a :class:`ParseResultBytes` + instance. + +.. class:: SplitResult(scheme, netloc, path, query, fragment) + + Concrete class for :func:`urlsplit` results containing :class:`str` + data. The :meth:`encode` method returns a :class:`SplitResultBytes` + instance. + + +The following classes provide the implementations of the parse results when +operating on :class:`bytes` or :class:`bytearray` objects: + +.. class:: DefragResultBytes(url, fragment) + + Concrete class for :func:`urldefrag` results containing :class:`bytes` + data. The :meth:`decode` method returns a :class:`DefragResult` + instance. + + .. versionadded:: 3.2 + +.. class:: ParseResultBytes(scheme, netloc, path, params, query, fragment) + + Concrete class for :func:`urlparse` results containing :class:`bytes` + data. The :meth:`decode` method returns a :class:`ParseResult` + instance. + + .. versionadded:: 3.2 + +.. class:: SplitResultBytes(scheme, netloc, path, query, fragment) + + Concrete class for :func:`urlsplit` results containing :class:`bytes` + data. The :meth:`decode` method returns a :class:`SplitResult` + instance. + + .. versionadded:: 3.2 + + +URL Quoting +----------- + +The URL quoting functions focus on taking program data and making it safe +for use as URL components by quoting special characters and appropriately +encoding non-ASCII text. They also support reversing these operations to +recreate the original data from the contents of a URL component if that +task isn't already covered by the URL parsing functions above. + +.. function:: quote(string, safe='/', encoding=None, errors=None) + + Replace special characters in *string* using the ``%xx`` escape. Letters, + digits, and the characters ``'_.-~'`` are never quoted. By default, this + function is intended for quoting the path section of URL. The optional *safe* + parameter specifies additional ASCII characters that should not be quoted + --- its default value is ``'/'``. + + *string* may be either a :class:`str` or a :class:`bytes`. + + .. versionchanged:: 3.7 + Moved from :rfc:`2396` to :rfc:`3986` for quoting URL strings. "~" is now + included in the set of reserved characters. + + The optional *encoding* and *errors* parameters specify how to deal with + non-ASCII characters, as accepted by the :meth:`str.encode` method. + *encoding* defaults to ``'utf-8'``. + *errors* defaults to ``'strict'``, meaning unsupported characters raise a + :class:`UnicodeEncodeError`. + *encoding* and *errors* must not be supplied if *string* is a + :class:`bytes`, or a :class:`TypeError` is raised. + + Note that ``quote(string, safe, encoding, errors)`` is equivalent to + ``quote_from_bytes(string.encode(encoding, errors), safe)``. + + Example: ``quote('/El Niño/')`` yields ``'/El%20Ni%C3%B1o/'``. + + +.. function:: quote_plus(string, safe='', encoding=None, errors=None) + + Like :func:`quote`, but also replace spaces by plus signs, as required for + quoting HTML form values when building up a query string to go into a URL. + Plus signs in the original string are escaped unless they are included in + *safe*. It also does not have *safe* default to ``'/'``. + + Example: ``quote_plus('/El Niño/')`` yields ``'%2FEl+Ni%C3%B1o%2F'``. + + +.. function:: quote_from_bytes(bytes, safe='/') + + Like :func:`quote`, but accepts a :class:`bytes` object rather than a + :class:`str`, and does not perform string-to-bytes encoding. + + Example: ``quote_from_bytes(b'a&\xef')`` yields + ``'a%26%EF'``. + + +.. function:: unquote(string, encoding='utf-8', errors='replace') + + Replace ``%xx`` escapes by their single-character equivalent. + The optional *encoding* and *errors* parameters specify how to decode + percent-encoded sequences into Unicode characters, as accepted by the + :meth:`bytes.decode` method. + + *string* must be a :class:`str`. + + *encoding* defaults to ``'utf-8'``. + *errors* defaults to ``'replace'``, meaning invalid sequences are replaced + by a placeholder character. + + Example: ``unquote('/El%20Ni%C3%B1o/')`` yields ``'/El Niño/'``. + + +.. function:: unquote_plus(string, encoding='utf-8', errors='replace') + + Like :func:`unquote`, but also replace plus signs by spaces, as required for + unquoting HTML form values. + + *string* must be a :class:`str`. + + Example: ``unquote_plus('/El+Ni%C3%B1o/')`` yields ``'/El Niño/'``. + + +.. function:: unquote_to_bytes(string) + + Replace ``%xx`` escapes by their single-octet equivalent, and return a + :class:`bytes` object. + + *string* may be either a :class:`str` or a :class:`bytes`. + + If it is a :class:`str`, unescaped non-ASCII characters in *string* + are encoded into UTF-8 bytes. + + Example: ``unquote_to_bytes('a%26%EF')`` yields ``b'a&\xef'``. + + +.. function:: urlencode(query, doseq=False, safe='', encoding=None, \ + errors=None, quote_via=quote_plus) + + Convert a mapping object or a sequence of two-element tuples, which may + contain :class:`str` or :class:`bytes` objects, to a percent-encoded ASCII + text string. If the resultant string is to be used as a *data* for POST + operation with the :func:`~urllib.request.urlopen` function, then + it should be encoded to bytes, otherwise it would result in a + :exc:`TypeError`. + + The resulting string is a series of ``key=value`` pairs separated by ``'&'`` + characters, where both *key* and *value* are quoted using the *quote_via* + function. By default, :func:`quote_plus` is used to quote the values, which + means spaces are quoted as a ``'+'`` character and '/' characters are + encoded as ``%2F``, which follows the standard for GET requests + (``application/x-www-form-urlencoded``). An alternate function that can be + passed as *quote_via* is :func:`quote`, which will encode spaces as ``%20`` + and not encode '/' characters. For maximum control of what is quoted, use + ``quote`` and specify a value for *safe*. + + When a sequence of two-element tuples is used as the *query* + argument, the first element of each tuple is a key and the second is a + value. The value element in itself can be a sequence and in that case, if + the optional parameter *doseq* is evaluates to ``True``, individual + ``key=value`` pairs separated by ``'&'`` are generated for each element of + the value sequence for the key. The order of parameters in the encoded + string will match the order of parameter tuples in the sequence. + + The *safe*, *encoding*, and *errors* parameters are passed down to + *quote_via* (the *encoding* and *errors* parameters are only passed + when a query element is a :class:`str`). + + To reverse this encoding process, :func:`parse_qs` and :func:`parse_qsl` are + provided in this module to parse query strings into Python data structures. + + Refer to :ref:`urllib examples ` to find out how urlencode + method can be used for generating query string for a URL or data for POST. + + .. versionchanged:: 3.2 + Query parameter supports bytes and string objects. + + .. versionadded:: 3.5 + *quote_via* parameter. + + +.. seealso:: + + :rfc:`3986` - Uniform Resource Identifiers + This is the current standard (STD66). Any changes to urllib.parse module + should conform to this. Certain deviations could be observed, which are + mostly for backward compatibility purposes and for certain de-facto + parsing requirements as commonly observed in major browsers. + + :rfc:`2732` - Format for Literal IPv6 Addresses in URL's. + This specifies the parsing requirements of IPv6 URLs. + + :rfc:`2396` - Uniform Resource Identifiers (URI): Generic Syntax + Document describing the generic syntactic requirements for both Uniform Resource + Names (URNs) and Uniform Resource Locators (URLs). + + :rfc:`2368` - The mailto URL scheme. + Parsing requirements for mailto URL schemes. + + :rfc:`1808` - Relative Uniform Resource Locators + This Request For Comments includes the rules for joining an absolute and a + relative URL, including a fair number of "Abnormal Examples" which govern the + treatment of border cases. + + :rfc:`1738` - Uniform Resource Locators (URL) + This specifies the formal syntax and semantics of absolute URLs. diff --git a/python-3.7.4-docs-html/_sources/library/urllib.request.rst.txt b/python-3.7.4-docs-html/_sources/library/urllib.request.rst.txt new file mode 100644 index 0000000..1bc81e0 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/urllib.request.rst.txt @@ -0,0 +1,1586 @@ +:mod:`urllib.request` --- Extensible library for opening URLs +============================================================= + +.. module:: urllib.request + :synopsis: Extensible library for opening URLs. + +.. moduleauthor:: Jeremy Hylton +.. sectionauthor:: Moshe Zadka +.. sectionauthor:: Senthil Kumaran + +**Source code:** :source:`Lib/urllib/request.py` + +-------------- + +The :mod:`urllib.request` module defines functions and classes which help in +opening URLs (mostly HTTP) in a complex world --- basic and digest +authentication, redirections, cookies and more. + +.. seealso:: + + The `Requests package `_ + is recommended for a higher-level HTTP client interface. + + +The :mod:`urllib.request` module defines the following functions: + + +.. function:: urlopen(url, data=None[, timeout], *, cafile=None, capath=None, cadefault=False, context=None) + + Open the URL *url*, which can be either a string or a + :class:`Request` object. + + *data* must be an object specifying additional data to be sent to the + server, or ``None`` if no such data is needed. See :class:`Request` + for details. + + urllib.request module uses HTTP/1.1 and includes ``Connection:close`` header + in its HTTP requests. + + The optional *timeout* parameter specifies a timeout in seconds for + blocking operations like the connection attempt (if not specified, + the global default timeout setting will be used). This actually + only works for HTTP, HTTPS and FTP connections. + + If *context* is specified, it must be a :class:`ssl.SSLContext` instance + describing the various SSL options. See :class:`~http.client.HTTPSConnection` + for more details. + + The optional *cafile* and *capath* parameters specify a set of trusted + CA certificates for HTTPS requests. *cafile* should point to a single + file containing a bundle of CA certificates, whereas *capath* should + point to a directory of hashed certificate files. More information can + be found in :meth:`ssl.SSLContext.load_verify_locations`. + + The *cadefault* parameter is ignored. + + This function always returns an object which can work as a + :term:`context manager` and has methods such as + + * :meth:`~urllib.response.addinfourl.geturl` --- return the URL of the resource retrieved, + commonly used to determine if a redirect was followed + + * :meth:`~urllib.response.addinfourl.info` --- return the meta-information of the page, such as headers, + in the form of an :func:`email.message_from_string` instance (see + `Quick Reference to HTTP Headers `_) + + * :meth:`~urllib.response.addinfourl.getcode` -- return the HTTP status code of the response. + + For HTTP and HTTPS URLs, this function returns a + :class:`http.client.HTTPResponse` object slightly modified. In addition + to the three new methods above, the msg attribute contains the + same information as the :attr:`~http.client.HTTPResponse.reason` + attribute --- the reason phrase returned by server --- instead of + the response headers as it is specified in the documentation for + :class:`~http.client.HTTPResponse`. + + For FTP, file, and data URLs and requests explicitly handled by legacy + :class:`URLopener` and :class:`FancyURLopener` classes, this function + returns a :class:`urllib.response.addinfourl` object. + + Raises :exc:`~urllib.error.URLError` on protocol errors. + + Note that ``None`` may be returned if no handler handles the request (though + the default installed global :class:`OpenerDirector` uses + :class:`UnknownHandler` to ensure this never happens). + + In addition, if proxy settings are detected (for example, when a ``*_proxy`` + environment variable like :envvar:`http_proxy` is set), + :class:`ProxyHandler` is default installed and makes sure the requests are + handled through the proxy. + + The legacy ``urllib.urlopen`` function from Python 2.6 and earlier has been + discontinued; :func:`urllib.request.urlopen` corresponds to the old + ``urllib2.urlopen``. Proxy handling, which was done by passing a dictionary + parameter to ``urllib.urlopen``, can be obtained by using + :class:`ProxyHandler` objects. + + .. versionchanged:: 3.2 + *cafile* and *capath* were added. + + .. versionchanged:: 3.2 + HTTPS virtual hosts are now supported if possible (that is, if + :data:`ssl.HAS_SNI` is true). + + .. versionadded:: 3.2 + *data* can be an iterable object. + + .. versionchanged:: 3.3 + *cadefault* was added. + + .. versionchanged:: 3.4.3 + *context* was added. + + .. deprecated:: 3.6 + + *cafile*, *capath* and *cadefault* are deprecated in favor of *context*. + Please use :meth:`ssl.SSLContext.load_cert_chain` instead, or let + :func:`ssl.create_default_context` select the system's trusted CA + certificates for you. + +.. function:: install_opener(opener) + + Install an :class:`OpenerDirector` instance as the default global opener. + Installing an opener is only necessary if you want urlopen to use that + opener; otherwise, simply call :meth:`OpenerDirector.open` instead of + :func:`~urllib.request.urlopen`. The code does not check for a real + :class:`OpenerDirector`, and any class with the appropriate interface will + work. + + +.. function:: build_opener([handler, ...]) + + Return an :class:`OpenerDirector` instance, which chains the handlers in the + order given. *handler*\s can be either instances of :class:`BaseHandler`, or + subclasses of :class:`BaseHandler` (in which case it must be possible to call + the constructor without any parameters). Instances of the following classes + will be in front of the *handler*\s, unless the *handler*\s contain them, + instances of them or subclasses of them: :class:`ProxyHandler` (if proxy + settings are detected), :class:`UnknownHandler`, :class:`HTTPHandler`, + :class:`HTTPDefaultErrorHandler`, :class:`HTTPRedirectHandler`, + :class:`FTPHandler`, :class:`FileHandler`, :class:`HTTPErrorProcessor`. + + If the Python installation has SSL support (i.e., if the :mod:`ssl` module + can be imported), :class:`HTTPSHandler` will also be added. + + A :class:`BaseHandler` subclass may also change its :attr:`handler_order` + attribute to modify its position in the handlers list. + + +.. function:: pathname2url(path) + + Convert the pathname *path* from the local syntax for a path to the form used in + the path component of a URL. This does not produce a complete URL. The return + value will already be quoted using the :func:`~urllib.parse.quote` function. + + +.. function:: url2pathname(path) + + Convert the path component *path* from a percent-encoded URL to the local syntax for a + path. This does not accept a complete URL. This function uses + :func:`~urllib.parse.unquote` to decode *path*. + +.. function:: getproxies() + + This helper function returns a dictionary of scheme to proxy server URL + mappings. It scans the environment for variables named ``_proxy``, + in a case insensitive approach, for all operating systems first, and when it + cannot find it, looks for proxy information from Mac OSX System + Configuration for Mac OS X and Windows Systems Registry for Windows. + If both lowercase and uppercase environment variables exist (and disagree), + lowercase is preferred. + + .. note:: + + If the environment variable ``REQUEST_METHOD`` is set, which usually + indicates your script is running in a CGI environment, the environment + variable ``HTTP_PROXY`` (uppercase ``_PROXY``) will be ignored. This is + because that variable can be injected by a client using the "Proxy:" HTTP + header. If you need to use an HTTP proxy in a CGI environment, either use + ``ProxyHandler`` explicitly, or make sure the variable name is in + lowercase (or at least the ``_proxy`` suffix). + + +The following classes are provided: + +.. class:: Request(url, data=None, headers={}, origin_req_host=None, unverifiable=False, method=None) + + This class is an abstraction of a URL request. + + *url* should be a string containing a valid URL. + + *data* must be an object specifying additional data to send to the + server, or ``None`` if no such data is needed. Currently HTTP + requests are the only ones that use *data*. The supported object + types include bytes, file-like objects, and iterables. If no + ``Content-Length`` nor ``Transfer-Encoding`` header field + has been provided, :class:`HTTPHandler` will set these headers according + to the type of *data*. ``Content-Length`` will be used to send + bytes objects, while ``Transfer-Encoding: chunked`` as specified in + :rfc:`7230`, Section 3.3.1 will be used to send files and other iterables. + + For an HTTP POST request method, *data* should be a buffer in the + standard :mimetype:`application/x-www-form-urlencoded` format. The + :func:`urllib.parse.urlencode` function takes a mapping or sequence + of 2-tuples and returns an ASCII string in this format. It should + be encoded to bytes before being used as the *data* parameter. + + *headers* should be a dictionary, and will be treated as if + :meth:`add_header` was called with each key and value as arguments. + This is often used to "spoof" the ``User-Agent`` header value, which is + used by a browser to identify itself -- some HTTP servers only + allow requests coming from common browsers as opposed to scripts. + For example, Mozilla Firefox may identify itself as ``"Mozilla/5.0 + (X11; U; Linux i686) Gecko/20071127 Firefox/2.0.0.11"``, while + :mod:`urllib`'s default user agent string is + ``"Python-urllib/2.6"`` (on Python 2.6). + + An appropriate ``Content-Type`` header should be included if the *data* + argument is present. If this header has not been provided and *data* + is not None, ``Content-Type: application/x-www-form-urlencoded`` will + be added as a default. + + The final two arguments are only of interest for correct handling + of third-party HTTP cookies: + + *origin_req_host* should be the request-host of the origin + transaction, as defined by :rfc:`2965`. It defaults to + ``http.cookiejar.request_host(self)``. This is the host name or IP + address of the original request that was initiated by the user. + For example, if the request is for an image in an HTML document, + this should be the request-host of the request for the page + containing the image. + + *unverifiable* should indicate whether the request is unverifiable, + as defined by :rfc:`2965`. It defaults to ``False``. An unverifiable + request is one whose URL the user did not have the option to + approve. For example, if the request is for an image in an HTML + document, and the user had no option to approve the automatic + fetching of the image, this should be true. + + *method* should be a string that indicates the HTTP request method that + will be used (e.g. ``'HEAD'``). If provided, its value is stored in the + :attr:`~Request.method` attribute and is used by :meth:`get_method()`. + The default is ``'GET'`` if *data* is ``None`` or ``'POST'`` otherwise. + Subclasses may indicate a different default method by setting the + :attr:`~Request.method` attribute in the class itself. + + .. note:: + The request will not work as expected if the data object is unable + to deliver its content more than once (e.g. a file or an iterable + that can produce the content only once) and the request is retried + for HTTP redirects or authentication. The *data* is sent to the + HTTP server right away after the headers. There is no support for + a 100-continue expectation in the library. + + .. versionchanged:: 3.3 + :attr:`Request.method` argument is added to the Request class. + + .. versionchanged:: 3.4 + Default :attr:`Request.method` may be indicated at the class level. + + .. versionchanged:: 3.6 + Do not raise an error if the ``Content-Length`` has not been + provided and *data* is neither ``None`` nor a bytes object. + Fall back to use chunked transfer encoding instead. + +.. class:: OpenerDirector() + + The :class:`OpenerDirector` class opens URLs via :class:`BaseHandler`\ s chained + together. It manages the chaining of handlers, and recovery from errors. + + +.. class:: BaseHandler() + + This is the base class for all registered handlers --- and handles only the + simple mechanics of registration. + + +.. class:: HTTPDefaultErrorHandler() + + A class which defines a default handler for HTTP error responses; all responses + are turned into :exc:`~urllib.error.HTTPError` exceptions. + + +.. class:: HTTPRedirectHandler() + + A class to handle redirections. + + +.. class:: HTTPCookieProcessor(cookiejar=None) + + A class to handle HTTP Cookies. + + +.. class:: ProxyHandler(proxies=None) + + Cause requests to go through a proxy. If *proxies* is given, it must be a + dictionary mapping protocol names to URLs of proxies. The default is to read + the list of proxies from the environment variables + ``_proxy``. If no proxy environment variables are set, then + in a Windows environment proxy settings are obtained from the registry's + Internet Settings section, and in a Mac OS X environment proxy information + is retrieved from the OS X System Configuration Framework. + + To disable autodetected proxy pass an empty dictionary. + + The :envvar:`no_proxy` environment variable can be used to specify hosts + which shouldn't be reached via proxy; if set, it should be a comma-separated + list of hostname suffixes, optionally with ``:port`` appended, for example + ``cern.ch,ncsa.uiuc.edu,some.host:8080``. + + .. note:: + + ``HTTP_PROXY`` will be ignored if a variable ``REQUEST_METHOD`` is set; + see the documentation on :func:`~urllib.request.getproxies`. + + +.. class:: HTTPPasswordMgr() + + Keep a database of ``(realm, uri) -> (user, password)`` mappings. + + +.. class:: HTTPPasswordMgrWithDefaultRealm() + + Keep a database of ``(realm, uri) -> (user, password)`` mappings. A realm of + ``None`` is considered a catch-all realm, which is searched if no other realm + fits. + + +.. class:: HTTPPasswordMgrWithPriorAuth() + + A variant of :class:`HTTPPasswordMgrWithDefaultRealm` that also has a + database of ``uri -> is_authenticated`` mappings. Can be used by a + BasicAuth handler to determine when to send authentication credentials + immediately instead of waiting for a ``401`` response first. + + .. versionadded:: 3.5 + + +.. class:: AbstractBasicAuthHandler(password_mgr=None) + + This is a mixin class that helps with HTTP authentication, both to the remote + host and to a proxy. *password_mgr*, if given, should be something that is + compatible with :class:`HTTPPasswordMgr`; refer to section + :ref:`http-password-mgr` for information on the interface that must be + supported. If *passwd_mgr* also provides ``is_authenticated`` and + ``update_authenticated`` methods (see + :ref:`http-password-mgr-with-prior-auth`), then the handler will use the + ``is_authenticated`` result for a given URI to determine whether or not to + send authentication credentials with the request. If ``is_authenticated`` + returns ``True`` for the URI, credentials are sent. If ``is_authenticated`` + is ``False``, credentials are not sent, and then if a ``401`` response is + received the request is re-sent with the authentication credentials. If + authentication succeeds, ``update_authenticated`` is called to set + ``is_authenticated`` ``True`` for the URI, so that subsequent requests to + the URI or any of its super-URIs will automatically include the + authentication credentials. + + .. versionadded:: 3.5 + Added ``is_authenticated`` support. + + +.. class:: HTTPBasicAuthHandler(password_mgr=None) + + Handle authentication with the remote host. *password_mgr*, if given, should + be something that is compatible with :class:`HTTPPasswordMgr`; refer to + section :ref:`http-password-mgr` for information on the interface that must + be supported. HTTPBasicAuthHandler will raise a :exc:`ValueError` when + presented with a wrong Authentication scheme. + + +.. class:: ProxyBasicAuthHandler(password_mgr=None) + + Handle authentication with the proxy. *password_mgr*, if given, should be + something that is compatible with :class:`HTTPPasswordMgr`; refer to section + :ref:`http-password-mgr` for information on the interface that must be + supported. + + +.. class:: AbstractDigestAuthHandler(password_mgr=None) + + This is a mixin class that helps with HTTP authentication, both to the remote + host and to a proxy. *password_mgr*, if given, should be something that is + compatible with :class:`HTTPPasswordMgr`; refer to section + :ref:`http-password-mgr` for information on the interface that must be + supported. + + +.. class:: HTTPDigestAuthHandler(password_mgr=None) + + Handle authentication with the remote host. *password_mgr*, if given, should + be something that is compatible with :class:`HTTPPasswordMgr`; refer to + section :ref:`http-password-mgr` for information on the interface that must + be supported. When both Digest Authentication Handler and Basic + Authentication Handler are both added, Digest Authentication is always tried + first. If the Digest Authentication returns a 40x response again, it is sent + to Basic Authentication handler to Handle. This Handler method will raise a + :exc:`ValueError` when presented with an authentication scheme other than + Digest or Basic. + + .. versionchanged:: 3.3 + Raise :exc:`ValueError` on unsupported Authentication Scheme. + + + +.. class:: ProxyDigestAuthHandler(password_mgr=None) + + Handle authentication with the proxy. *password_mgr*, if given, should be + something that is compatible with :class:`HTTPPasswordMgr`; refer to section + :ref:`http-password-mgr` for information on the interface that must be + supported. + + +.. class:: HTTPHandler() + + A class to handle opening of HTTP URLs. + + +.. class:: HTTPSHandler(debuglevel=0, context=None, check_hostname=None) + + A class to handle opening of HTTPS URLs. *context* and *check_hostname* + have the same meaning as in :class:`http.client.HTTPSConnection`. + + .. versionchanged:: 3.2 + *context* and *check_hostname* were added. + + +.. class:: FileHandler() + + Open local files. + +.. class:: DataHandler() + + Open data URLs. + + .. versionadded:: 3.4 + +.. class:: FTPHandler() + + Open FTP URLs. + + +.. class:: CacheFTPHandler() + + Open FTP URLs, keeping a cache of open FTP connections to minimize delays. + + +.. class:: UnknownHandler() + + A catch-all class to handle unknown URLs. + + +.. class:: HTTPErrorProcessor() + + Process HTTP error responses. + + +.. _request-objects: + +Request Objects +--------------- + +The following methods describe :class:`Request`'s public interface, +and so all may be overridden in subclasses. It also defines several +public attributes that can be used by clients to inspect the parsed +request. + +.. attribute:: Request.full_url + + The original URL passed to the constructor. + + .. versionchanged:: 3.4 + + Request.full_url is a property with setter, getter and a deleter. Getting + :attr:`~Request.full_url` returns the original request URL with the + fragment, if it was present. + +.. attribute:: Request.type + + The URI scheme. + +.. attribute:: Request.host + + The URI authority, typically a host, but may also contain a port + separated by a colon. + +.. attribute:: Request.origin_req_host + + The original host for the request, without port. + +.. attribute:: Request.selector + + The URI path. If the :class:`Request` uses a proxy, then selector + will be the full URL that is passed to the proxy. + +.. attribute:: Request.data + + The entity body for the request, or ``None`` if not specified. + + .. versionchanged:: 3.4 + Changing value of :attr:`Request.data` now deletes "Content-Length" + header if it was previously set or calculated. + +.. attribute:: Request.unverifiable + + boolean, indicates whether the request is unverifiable as defined + by :rfc:`2965`. + +.. attribute:: Request.method + + The HTTP request method to use. By default its value is :const:`None`, + which means that :meth:`~Request.get_method` will do its normal computation + of the method to be used. Its value can be set (thus overriding the default + computation in :meth:`~Request.get_method`) either by providing a default + value by setting it at the class level in a :class:`Request` subclass, or by + passing a value in to the :class:`Request` constructor via the *method* + argument. + + .. versionadded:: 3.3 + + .. versionchanged:: 3.4 + A default value can now be set in subclasses; previously it could only + be set via the constructor argument. + + +.. method:: Request.get_method() + + Return a string indicating the HTTP request method. If + :attr:`Request.method` is not ``None``, return its value, otherwise return + ``'GET'`` if :attr:`Request.data` is ``None``, or ``'POST'`` if it's not. + This is only meaningful for HTTP requests. + + .. versionchanged:: 3.3 + get_method now looks at the value of :attr:`Request.method`. + + +.. method:: Request.add_header(key, val) + + Add another header to the request. Headers are currently ignored by all + handlers except HTTP handlers, where they are added to the list of headers sent + to the server. Note that there cannot be more than one header with the same + name, and later calls will overwrite previous calls in case the *key* collides. + Currently, this is no loss of HTTP functionality, since all headers which have + meaning when used more than once have a (header-specific) way of gaining the + same functionality using only one header. + + +.. method:: Request.add_unredirected_header(key, header) + + Add a header that will not be added to a redirected request. + + +.. method:: Request.has_header(header) + + Return whether the instance has the named header (checks both regular and + unredirected). + + +.. method:: Request.remove_header(header) + + Remove named header from the request instance (both from regular and + unredirected headers). + + .. versionadded:: 3.4 + + +.. method:: Request.get_full_url() + + Return the URL given in the constructor. + + .. versionchanged:: 3.4 + + Returns :attr:`Request.full_url` + + +.. method:: Request.set_proxy(host, type) + + Prepare the request by connecting to a proxy server. The *host* and *type* will + replace those of the instance, and the instance's selector will be the original + URL given in the constructor. + + +.. method:: Request.get_header(header_name, default=None) + + Return the value of the given header. If the header is not present, return + the default value. + + +.. method:: Request.header_items() + + Return a list of tuples (header_name, header_value) of the Request headers. + +.. versionchanged:: 3.4 + The request methods add_data, has_data, get_data, get_type, get_host, + get_selector, get_origin_req_host and is_unverifiable that were deprecated + since 3.3 have been removed. + + +.. _opener-director-objects: + +OpenerDirector Objects +---------------------- + +:class:`OpenerDirector` instances have the following methods: + + +.. method:: OpenerDirector.add_handler(handler) + + *handler* should be an instance of :class:`BaseHandler`. The following methods + are searched, and added to the possible chains (note that HTTP errors are a + special case). Note that, in the following, *protocol* should be replaced + with the actual protocol to handle, for example :meth:`http_response` would + be the HTTP protocol response handler. Also *type* should be replaced with + the actual HTTP code, for example :meth:`http_error_404` would handle HTTP + 404 errors. + + * :meth:`_open` --- signal that the handler knows how to open *protocol* + URLs. + + See |protocol_open|_ for more information. + + * :meth:`http_error_\` --- signal that the handler knows how to handle HTTP + errors with HTTP error code *type*. + + See |http_error_nnn|_ for more information. + + * :meth:`_error` --- signal that the handler knows how to handle errors + from (non-\ ``http``) *protocol*. + + * :meth:`_request` --- signal that the handler knows how to pre-process + *protocol* requests. + + See |protocol_request|_ for more information. + + * :meth:`_response` --- signal that the handler knows how to + post-process *protocol* responses. + + See |protocol_response|_ for more information. + +.. |protocol_open| replace:: :meth:`BaseHandler._open` +.. |http_error_nnn| replace:: :meth:`BaseHandler.http_error_\` +.. |protocol_request| replace:: :meth:`BaseHandler._request` +.. |protocol_response| replace:: :meth:`BaseHandler._response` + +.. method:: OpenerDirector.open(url, data=None[, timeout]) + + Open the given *url* (which can be a request object or a string), optionally + passing the given *data*. Arguments, return values and exceptions raised are + the same as those of :func:`urlopen` (which simply calls the :meth:`open` + method on the currently installed global :class:`OpenerDirector`). The + optional *timeout* parameter specifies a timeout in seconds for blocking + operations like the connection attempt (if not specified, the global default + timeout setting will be used). The timeout feature actually works only for + HTTP, HTTPS and FTP connections). + + +.. method:: OpenerDirector.error(proto, *args) + + Handle an error of the given protocol. This will call the registered error + handlers for the given protocol with the given arguments (which are protocol + specific). The HTTP protocol is a special case which uses the HTTP response + code to determine the specific error handler; refer to the :meth:`http_error_\` + methods of the handler classes. + + Return values and exceptions raised are the same as those of :func:`urlopen`. + +OpenerDirector objects open URLs in three stages: + +The order in which these methods are called within each stage is determined by +sorting the handler instances. + +#. Every handler with a method named like :meth:`_request` has that + method called to pre-process the request. + +#. Handlers with a method named like :meth:`_open` are called to handle + the request. This stage ends when a handler either returns a non-\ :const:`None` + value (ie. a response), or raises an exception (usually + :exc:`~urllib.error.URLError`). Exceptions are allowed to propagate. + + In fact, the above algorithm is first tried for methods named + :meth:`default_open`. If all such methods return :const:`None`, the algorithm + is repeated for methods named like :meth:`_open`. If all such methods + return :const:`None`, the algorithm is repeated for methods named + :meth:`unknown_open`. + + Note that the implementation of these methods may involve calls of the parent + :class:`OpenerDirector` instance's :meth:`~OpenerDirector.open` and + :meth:`~OpenerDirector.error` methods. + +#. Every handler with a method named like :meth:`_response` has that + method called to post-process the response. + + +.. _base-handler-objects: + +BaseHandler Objects +------------------- + +:class:`BaseHandler` objects provide a couple of methods that are directly +useful, and others that are meant to be used by derived classes. These are +intended for direct use: + + +.. method:: BaseHandler.add_parent(director) + + Add a director as parent. + + +.. method:: BaseHandler.close() + + Remove any parents. + +The following attribute and methods should only be used by classes derived from +:class:`BaseHandler`. + +.. note:: + + The convention has been adopted that subclasses defining + :meth:`_request` or :meth:`_response` methods are named + :class:`\*Processor`; all others are named :class:`\*Handler`. + + +.. attribute:: BaseHandler.parent + + A valid :class:`OpenerDirector`, which can be used to open using a different + protocol, or handle errors. + + +.. method:: BaseHandler.default_open(req) + + This method is *not* defined in :class:`BaseHandler`, but subclasses should + define it if they want to catch all URLs. + + This method, if implemented, will be called by the parent + :class:`OpenerDirector`. It should return a file-like object as described in + the return value of the :meth:`open` of :class:`OpenerDirector`, or ``None``. + It should raise :exc:`~urllib.error.URLError`, unless a truly exceptional + thing happens (for example, :exc:`MemoryError` should not be mapped to + :exc:`URLError`). + + This method will be called before any protocol-specific open method. + + +.. _protocol_open: +.. method:: BaseHandler._open(req) + :noindex: + + This method is *not* defined in :class:`BaseHandler`, but subclasses should + define it if they want to handle URLs with the given protocol. + + This method, if defined, will be called by the parent :class:`OpenerDirector`. + Return values should be the same as for :meth:`default_open`. + + +.. method:: BaseHandler.unknown_open(req) + + This method is *not* defined in :class:`BaseHandler`, but subclasses should + define it if they want to catch all URLs with no specific registered handler to + open it. + + This method, if implemented, will be called by the :attr:`parent` + :class:`OpenerDirector`. Return values should be the same as for + :meth:`default_open`. + + +.. method:: BaseHandler.http_error_default(req, fp, code, msg, hdrs) + + This method is *not* defined in :class:`BaseHandler`, but subclasses should + override it if they intend to provide a catch-all for otherwise unhandled HTTP + errors. It will be called automatically by the :class:`OpenerDirector` getting + the error, and should not normally be called in other circumstances. + + *req* will be a :class:`Request` object, *fp* will be a file-like object with + the HTTP error body, *code* will be the three-digit code of the error, *msg* + will be the user-visible explanation of the code and *hdrs* will be a mapping + object with the headers of the error. + + Return values and exceptions raised should be the same as those of + :func:`urlopen`. + + +.. _http_error_nnn: +.. method:: BaseHandler.http_error_(req, fp, code, msg, hdrs) + + *nnn* should be a three-digit HTTP error code. This method is also not defined + in :class:`BaseHandler`, but will be called, if it exists, on an instance of a + subclass, when an HTTP error with code *nnn* occurs. + + Subclasses should override this method to handle specific HTTP errors. + + Arguments, return values and exceptions raised should be the same as for + :meth:`http_error_default`. + + +.. _protocol_request: +.. method:: BaseHandler._request(req) + :noindex: + + This method is *not* defined in :class:`BaseHandler`, but subclasses should + define it if they want to pre-process requests of the given protocol. + + This method, if defined, will be called by the parent :class:`OpenerDirector`. + *req* will be a :class:`Request` object. The return value should be a + :class:`Request` object. + + +.. _protocol_response: +.. method:: BaseHandler._response(req, response) + :noindex: + + This method is *not* defined in :class:`BaseHandler`, but subclasses should + define it if they want to post-process responses of the given protocol. + + This method, if defined, will be called by the parent :class:`OpenerDirector`. + *req* will be a :class:`Request` object. *response* will be an object + implementing the same interface as the return value of :func:`urlopen`. The + return value should implement the same interface as the return value of + :func:`urlopen`. + + +.. _http-redirect-handler: + +HTTPRedirectHandler Objects +--------------------------- + +.. note:: + + Some HTTP redirections require action from this module's client code. If this + is the case, :exc:`~urllib.error.HTTPError` is raised. See :rfc:`2616` for + details of the precise meanings of the various redirection codes. + + An :class:`HTTPError` exception raised as a security consideration if the + HTTPRedirectHandler is presented with a redirected URL which is not an HTTP, + HTTPS or FTP URL. + + +.. method:: HTTPRedirectHandler.redirect_request(req, fp, code, msg, hdrs, newurl) + + Return a :class:`Request` or ``None`` in response to a redirect. This is called + by the default implementations of the :meth:`http_error_30\*` methods when a + redirection is received from the server. If a redirection should take place, + return a new :class:`Request` to allow :meth:`http_error_30\*` to perform the + redirect to *newurl*. Otherwise, raise :exc:`~urllib.error.HTTPError` if + no other handler should try to handle this URL, or return ``None`` if you + can't but another handler might. + + .. note:: + + The default implementation of this method does not strictly follow :rfc:`2616`, + which says that 301 and 302 responses to ``POST`` requests must not be + automatically redirected without confirmation by the user. In reality, browsers + do allow automatic redirection of these responses, changing the POST to a + ``GET``, and the default implementation reproduces this behavior. + + +.. method:: HTTPRedirectHandler.http_error_301(req, fp, code, msg, hdrs) + + Redirect to the ``Location:`` or ``URI:`` URL. This method is called by the + parent :class:`OpenerDirector` when getting an HTTP 'moved permanently' response. + + +.. method:: HTTPRedirectHandler.http_error_302(req, fp, code, msg, hdrs) + + The same as :meth:`http_error_301`, but called for the 'found' response. + + +.. method:: HTTPRedirectHandler.http_error_303(req, fp, code, msg, hdrs) + + The same as :meth:`http_error_301`, but called for the 'see other' response. + + +.. method:: HTTPRedirectHandler.http_error_307(req, fp, code, msg, hdrs) + + The same as :meth:`http_error_301`, but called for the 'temporary redirect' + response. + + +.. _http-cookie-processor: + +HTTPCookieProcessor Objects +--------------------------- + +:class:`HTTPCookieProcessor` instances have one attribute: + +.. attribute:: HTTPCookieProcessor.cookiejar + + The :class:`http.cookiejar.CookieJar` in which cookies are stored. + + +.. _proxy-handler: + +ProxyHandler Objects +-------------------- + + +.. method:: ProxyHandler._open(request) + :noindex: + + The :class:`ProxyHandler` will have a method :meth:`_open` for every + *protocol* which has a proxy in the *proxies* dictionary given in the + constructor. The method will modify requests to go through the proxy, by + calling ``request.set_proxy()``, and call the next handler in the chain to + actually execute the protocol. + + +.. _http-password-mgr: + +HTTPPasswordMgr Objects +----------------------- + +These methods are available on :class:`HTTPPasswordMgr` and +:class:`HTTPPasswordMgrWithDefaultRealm` objects. + + +.. method:: HTTPPasswordMgr.add_password(realm, uri, user, passwd) + + *uri* can be either a single URI, or a sequence of URIs. *realm*, *user* and + *passwd* must be strings. This causes ``(user, passwd)`` to be used as + authentication tokens when authentication for *realm* and a super-URI of any of + the given URIs is given. + + +.. method:: HTTPPasswordMgr.find_user_password(realm, authuri) + + Get user/password for given realm and URI, if any. This method will return + ``(None, None)`` if there is no matching user/password. + + For :class:`HTTPPasswordMgrWithDefaultRealm` objects, the realm ``None`` will be + searched if the given *realm* has no matching user/password. + + +.. _http-password-mgr-with-prior-auth: + +HTTPPasswordMgrWithPriorAuth Objects +------------------------------------ + +This password manager extends :class:`HTTPPasswordMgrWithDefaultRealm` to support +tracking URIs for which authentication credentials should always be sent. + + +.. method:: HTTPPasswordMgrWithPriorAuth.add_password(realm, uri, user, \ + passwd, is_authenticated=False) + + *realm*, *uri*, *user*, *passwd* are as for + :meth:`HTTPPasswordMgr.add_password`. *is_authenticated* sets the initial + value of the ``is_authenticated`` flag for the given URI or list of URIs. + If *is_authenticated* is specified as ``True``, *realm* is ignored. + + +.. method:: HTTPPasswordMgr.find_user_password(realm, authuri) + + Same as for :class:`HTTPPasswordMgrWithDefaultRealm` objects + + +.. method:: HTTPPasswordMgrWithPriorAuth.update_authenticated(self, uri, \ + is_authenticated=False) + + Update the ``is_authenticated`` flag for the given *uri* or list + of URIs. + + +.. method:: HTTPPasswordMgrWithPriorAuth.is_authenticated(self, authuri) + + Returns the current state of the ``is_authenticated`` flag for + the given URI. + + +.. _abstract-basic-auth-handler: + +AbstractBasicAuthHandler Objects +-------------------------------- + + +.. method:: AbstractBasicAuthHandler.http_error_auth_reqed(authreq, host, req, headers) + + Handle an authentication request by getting a user/password pair, and re-trying + the request. *authreq* should be the name of the header where the information + about the realm is included in the request, *host* specifies the URL and path to + authenticate for, *req* should be the (failed) :class:`Request` object, and + *headers* should be the error headers. + + *host* is either an authority (e.g. ``"python.org"``) or a URL containing an + authority component (e.g. ``"http://python.org/"``). In either case, the + authority must not contain a userinfo component (so, ``"python.org"`` and + ``"python.org:80"`` are fine, ``"joe:password@python.org"`` is not). + + +.. _http-basic-auth-handler: + +HTTPBasicAuthHandler Objects +---------------------------- + + +.. method:: HTTPBasicAuthHandler.http_error_401(req, fp, code, msg, hdrs) + + Retry the request with authentication information, if available. + + +.. _proxy-basic-auth-handler: + +ProxyBasicAuthHandler Objects +----------------------------- + + +.. method:: ProxyBasicAuthHandler.http_error_407(req, fp, code, msg, hdrs) + + Retry the request with authentication information, if available. + + +.. _abstract-digest-auth-handler: + +AbstractDigestAuthHandler Objects +--------------------------------- + + +.. method:: AbstractDigestAuthHandler.http_error_auth_reqed(authreq, host, req, headers) + + *authreq* should be the name of the header where the information about the realm + is included in the request, *host* should be the host to authenticate to, *req* + should be the (failed) :class:`Request` object, and *headers* should be the + error headers. + + +.. _http-digest-auth-handler: + +HTTPDigestAuthHandler Objects +----------------------------- + + +.. method:: HTTPDigestAuthHandler.http_error_401(req, fp, code, msg, hdrs) + + Retry the request with authentication information, if available. + + +.. _proxy-digest-auth-handler: + +ProxyDigestAuthHandler Objects +------------------------------ + + +.. method:: ProxyDigestAuthHandler.http_error_407(req, fp, code, msg, hdrs) + + Retry the request with authentication information, if available. + + +.. _http-handler-objects: + +HTTPHandler Objects +------------------- + + +.. method:: HTTPHandler.http_open(req) + + Send an HTTP request, which can be either GET or POST, depending on + ``req.has_data()``. + + +.. _https-handler-objects: + +HTTPSHandler Objects +-------------------- + + +.. method:: HTTPSHandler.https_open(req) + + Send an HTTPS request, which can be either GET or POST, depending on + ``req.has_data()``. + + +.. _file-handler-objects: + +FileHandler Objects +------------------- + + +.. method:: FileHandler.file_open(req) + + Open the file locally, if there is no host name, or the host name is + ``'localhost'``. + + .. versionchanged:: 3.2 + This method is applicable only for local hostnames. When a remote + hostname is given, an :exc:`~urllib.error.URLError` is raised. + + +.. _data-handler-objects: + +DataHandler Objects +------------------- + +.. method:: DataHandler.data_open(req) + + Read a data URL. This kind of URL contains the content encoded in the URL + itself. The data URL syntax is specified in :rfc:`2397`. This implementation + ignores white spaces in base64 encoded data URLs so the URL may be wrapped + in whatever source file it comes from. But even though some browsers don't + mind about a missing padding at the end of a base64 encoded data URL, this + implementation will raise an :exc:`ValueError` in that case. + + +.. _ftp-handler-objects: + +FTPHandler Objects +------------------ + + +.. method:: FTPHandler.ftp_open(req) + + Open the FTP file indicated by *req*. The login is always done with empty + username and password. + + +.. _cacheftp-handler-objects: + +CacheFTPHandler Objects +----------------------- + +:class:`CacheFTPHandler` objects are :class:`FTPHandler` objects with the +following additional methods: + + +.. method:: CacheFTPHandler.setTimeout(t) + + Set timeout of connections to *t* seconds. + + +.. method:: CacheFTPHandler.setMaxConns(m) + + Set maximum number of cached connections to *m*. + + +.. _unknown-handler-objects: + +UnknownHandler Objects +---------------------- + + +.. method:: UnknownHandler.unknown_open() + + Raise a :exc:`~urllib.error.URLError` exception. + + +.. _http-error-processor-objects: + +HTTPErrorProcessor Objects +-------------------------- + +.. method:: HTTPErrorProcessor.http_response(request, response) + + Process HTTP error responses. + + For 200 error codes, the response object is returned immediately. + + For non-200 error codes, this simply passes the job on to the + :meth:`http_error_\` handler methods, via :meth:`OpenerDirector.error`. + Eventually, :class:`HTTPDefaultErrorHandler` will raise an + :exc:`~urllib.error.HTTPError` if no other handler handles the error. + + +.. method:: HTTPErrorProcessor.https_response(request, response) + + Process HTTPS error responses. + + The behavior is same as :meth:`http_response`. + + +.. _urllib-request-examples: + +Examples +-------- + +In addition to the examples below, more examples are given in +:ref:`urllib-howto`. + +This example gets the python.org main page and displays the first 300 bytes of +it. :: + + >>> import urllib.request + >>> with urllib.request.urlopen('http://www.python.org/') as f: + ... print(f.read(300)) + ... + b'\n\n\n\n\n\n + \n + Python Programming ' + +Note that urlopen returns a bytes object. This is because there is no way +for urlopen to automatically determine the encoding of the byte stream +it receives from the HTTP server. In general, a program will decode +the returned bytes object to string once it determines or guesses +the appropriate encoding. + +The following W3C document, https://www.w3.org/International/O-charset\ , lists +the various ways in which an (X)HTML or an XML document could have specified its +encoding information. + +As the python.org website uses *utf-8* encoding as specified in its meta tag, we +will use the same for decoding the bytes object. :: + + >>> with urllib.request.urlopen('http://www.python.org/') as f: + ... print(f.read(100).decode('utf-8')) + ... + <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtm + +It is also possible to achieve the same result without using the +:term:`context manager` approach. :: + + >>> import urllib.request + >>> f = urllib.request.urlopen('http://www.python.org/') + >>> print(f.read(100).decode('utf-8')) + <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtm + +In the following example, we are sending a data-stream to the stdin of a CGI +and reading the data it returns to us. Note that this example will only work +when the Python installation supports SSL. :: + + >>> import urllib.request + >>> req = urllib.request.Request(url='https://localhost/cgi-bin/test.cgi', + ... data=b'This data is passed to stdin of the CGI') + >>> with urllib.request.urlopen(req) as f: + ... print(f.read().decode('utf-8')) + ... + Got Data: "This data is passed to stdin of the CGI" + +The code for the sample CGI used in the above example is:: + + #!/usr/bin/env python + import sys + data = sys.stdin.read() + print('Content-type: text/plain\n\nGot Data: "%s"' % data) + +Here is an example of doing a ``PUT`` request using :class:`Request`:: + + import urllib.request + DATA = b'some data' + req = urllib.request.Request(url='http://localhost:8080', data=DATA,method='PUT') + with urllib.request.urlopen(req) as f: + pass + print(f.status) + print(f.reason) + +Use of Basic HTTP Authentication:: + + import urllib.request + # Create an OpenerDirector with support for Basic HTTP Authentication... + auth_handler = urllib.request.HTTPBasicAuthHandler() + auth_handler.add_password(realm='PDQ Application', + uri='https://mahler:8092/site-updates.py', + user='klem', + passwd='kadidd!ehopper') + opener = urllib.request.build_opener(auth_handler) + # ...and install it globally so it can be used with urlopen. + urllib.request.install_opener(opener) + urllib.request.urlopen('http://www.example.com/login.html') + +:func:`build_opener` provides many handlers by default, including a +:class:`ProxyHandler`. By default, :class:`ProxyHandler` uses the environment +variables named ``<scheme>_proxy``, where ``<scheme>`` is the URL scheme +involved. For example, the :envvar:`http_proxy` environment variable is read to +obtain the HTTP proxy's URL. + +This example replaces the default :class:`ProxyHandler` with one that uses +programmatically-supplied proxy URLs, and adds proxy authorization support with +:class:`ProxyBasicAuthHandler`. :: + + proxy_handler = urllib.request.ProxyHandler({'http': 'http://www.example.com:3128/'}) + proxy_auth_handler = urllib.request.ProxyBasicAuthHandler() + proxy_auth_handler.add_password('realm', 'host', 'username', 'password') + + opener = urllib.request.build_opener(proxy_handler, proxy_auth_handler) + # This time, rather than install the OpenerDirector, we use it directly: + opener.open('http://www.example.com/login.html') + +Adding HTTP headers: + +Use the *headers* argument to the :class:`Request` constructor, or:: + + import urllib.request + req = urllib.request.Request('http://www.example.com/') + req.add_header('Referer', 'http://www.python.org/') + # Customize the default User-Agent header value: + req.add_header('User-Agent', 'urllib-example/0.1 (Contact: . . .)') + r = urllib.request.urlopen(req) + +:class:`OpenerDirector` automatically adds a :mailheader:`User-Agent` header to +every :class:`Request`. To change this:: + + import urllib.request + opener = urllib.request.build_opener() + opener.addheaders = [('User-agent', 'Mozilla/5.0')] + opener.open('http://www.example.com/') + +Also, remember that a few standard headers (:mailheader:`Content-Length`, +:mailheader:`Content-Type` and :mailheader:`Host`) +are added when the :class:`Request` is passed to :func:`urlopen` (or +:meth:`OpenerDirector.open`). + +.. _urllib-examples: + +Here is an example session that uses the ``GET`` method to retrieve a URL +containing parameters:: + + >>> import urllib.request + >>> import urllib.parse + >>> params = urllib.parse.urlencode({'spam': 1, 'eggs': 2, 'bacon': 0}) + >>> url = "http://www.musi-cal.com/cgi-bin/query?%s" % params + >>> with urllib.request.urlopen(url) as f: + ... print(f.read().decode('utf-8')) + ... + +The following example uses the ``POST`` method instead. Note that params output +from urlencode is encoded to bytes before it is sent to urlopen as data:: + + >>> import urllib.request + >>> import urllib.parse + >>> data = urllib.parse.urlencode({'spam': 1, 'eggs': 2, 'bacon': 0}) + >>> data = data.encode('ascii') + >>> with urllib.request.urlopen("http://requestb.in/xrbl82xr", data) as f: + ... print(f.read().decode('utf-8')) + ... + +The following example uses an explicitly specified HTTP proxy, overriding +environment settings:: + + >>> import urllib.request + >>> proxies = {'http': 'http://proxy.example.com:8080/'} + >>> opener = urllib.request.FancyURLopener(proxies) + >>> with opener.open("http://www.python.org") as f: + ... f.read().decode('utf-8') + ... + +The following example uses no proxies at all, overriding environment settings:: + + >>> import urllib.request + >>> opener = urllib.request.FancyURLopener({}) + >>> with opener.open("http://www.python.org/") as f: + ... f.read().decode('utf-8') + ... + + +Legacy interface +---------------- + +The following functions and classes are ported from the Python 2 module +``urllib`` (as opposed to ``urllib2``). They might become deprecated at +some point in the future. + +.. function:: urlretrieve(url, filename=None, reporthook=None, data=None) + + Copy a network object denoted by a URL to a local file. If the URL + points to a local file, the object will not be copied unless filename is supplied. + Return a tuple ``(filename, headers)`` where *filename* is the + local file name under which the object can be found, and *headers* is whatever + the :meth:`info` method of the object returned by :func:`urlopen` returned (for + a remote object). Exceptions are the same as for :func:`urlopen`. + + The second argument, if present, specifies the file location to copy to (if + absent, the location will be a tempfile with a generated name). The third + argument, if present, is a callable that will be called once on + establishment of the network connection and once after each block read + thereafter. The callable will be passed three arguments; a count of blocks + transferred so far, a block size in bytes, and the total size of the file. The + third argument may be ``-1`` on older FTP servers which do not return a file + size in response to a retrieval request. + + The following example illustrates the most common usage scenario:: + + >>> import urllib.request + >>> local_filename, headers = urllib.request.urlretrieve('http://python.org/') + >>> html = open(local_filename) + >>> html.close() + + If the *url* uses the :file:`http:` scheme identifier, the optional *data* + argument may be given to specify a ``POST`` request (normally the request + type is ``GET``). The *data* argument must be a bytes object in standard + :mimetype:`application/x-www-form-urlencoded` format; see the + :func:`urllib.parse.urlencode` function. + + :func:`urlretrieve` will raise :exc:`ContentTooShortError` when it detects that + the amount of data available was less than the expected amount (which is the + size reported by a *Content-Length* header). This can occur, for example, when + the download is interrupted. + + The *Content-Length* is treated as a lower bound: if there's more data to read, + urlretrieve reads more data, but if less data is available, it raises the + exception. + + You can still retrieve the downloaded data in this case, it is stored in the + :attr:`content` attribute of the exception instance. + + If no *Content-Length* header was supplied, urlretrieve can not check the size + of the data it has downloaded, and just returns it. In this case you just have + to assume that the download was successful. + +.. function:: urlcleanup() + + Cleans up temporary files that may have been left behind by previous + calls to :func:`urlretrieve`. + +.. class:: URLopener(proxies=None, **x509) + + .. deprecated:: 3.3 + + Base class for opening and reading URLs. Unless you need to support opening + objects using schemes other than :file:`http:`, :file:`ftp:`, or :file:`file:`, + you probably want to use :class:`FancyURLopener`. + + By default, the :class:`URLopener` class sends a :mailheader:`User-Agent` header + of ``urllib/VVV``, where *VVV* is the :mod:`urllib` version number. + Applications can define their own :mailheader:`User-Agent` header by subclassing + :class:`URLopener` or :class:`FancyURLopener` and setting the class attribute + :attr:`version` to an appropriate string value in the subclass definition. + + The optional *proxies* parameter should be a dictionary mapping scheme names to + proxy URLs, where an empty dictionary turns proxies off completely. Its default + value is ``None``, in which case environmental proxy settings will be used if + present, as discussed in the definition of :func:`urlopen`, above. + + Additional keyword parameters, collected in *x509*, may be used for + authentication of the client when using the :file:`https:` scheme. The keywords + *key_file* and *cert_file* are supported to provide an SSL key and certificate; + both are needed to support client authentication. + + :class:`URLopener` objects will raise an :exc:`OSError` exception if the server + returns an error code. + + .. method:: open(fullurl, data=None) + + Open *fullurl* using the appropriate protocol. This method sets up cache and + proxy information, then calls the appropriate open method with its input + arguments. If the scheme is not recognized, :meth:`open_unknown` is called. + The *data* argument has the same meaning as the *data* argument of + :func:`urlopen`. + + This method always quotes *fullurl* using :func:`~urllib.parse.quote`. + + .. method:: open_unknown(fullurl, data=None) + + Overridable interface to open unknown URL types. + + + .. method:: retrieve(url, filename=None, reporthook=None, data=None) + + Retrieves the contents of *url* and places it in *filename*. The return value + is a tuple consisting of a local filename and either an + :class:`email.message.Message` object containing the response headers (for remote + URLs) or ``None`` (for local URLs). The caller must then open and read the + contents of *filename*. If *filename* is not given and the URL refers to a + local file, the input filename is returned. If the URL is non-local and + *filename* is not given, the filename is the output of :func:`tempfile.mktemp` + with a suffix that matches the suffix of the last path component of the input + URL. If *reporthook* is given, it must be a function accepting three numeric + parameters: A chunk number, the maximum size chunks are read in and the total size of the download + (-1 if unknown). It will be called once at the start and after each chunk of data is read from the + network. *reporthook* is ignored for local URLs. + + If the *url* uses the :file:`http:` scheme identifier, the optional *data* + argument may be given to specify a ``POST`` request (normally the request type + is ``GET``). The *data* argument must in standard + :mimetype:`application/x-www-form-urlencoded` format; see the + :func:`urllib.parse.urlencode` function. + + + .. attribute:: version + + Variable that specifies the user agent of the opener object. To get + :mod:`urllib` to tell servers that it is a particular user agent, set this in a + subclass as a class variable or in the constructor before calling the base + constructor. + + +.. class:: FancyURLopener(...) + + .. deprecated:: 3.3 + + :class:`FancyURLopener` subclasses :class:`URLopener` providing default handling + for the following HTTP response codes: 301, 302, 303, 307 and 401. For the 30x + response codes listed above, the :mailheader:`Location` header is used to fetch + the actual URL. For 401 response codes (authentication required), basic HTTP + authentication is performed. For the 30x response codes, recursion is bounded + by the value of the *maxtries* attribute, which defaults to 10. + + For all other response codes, the method :meth:`http_error_default` is called + which you can override in subclasses to handle the error appropriately. + + .. note:: + + According to the letter of :rfc:`2616`, 301 and 302 responses to POST requests + must not be automatically redirected without confirmation by the user. In + reality, browsers do allow automatic redirection of these responses, changing + the POST to a GET, and :mod:`urllib` reproduces this behaviour. + + The parameters to the constructor are the same as those for :class:`URLopener`. + + .. note:: + + When performing basic authentication, a :class:`FancyURLopener` instance calls + its :meth:`prompt_user_passwd` method. The default implementation asks the + users for the required information on the controlling terminal. A subclass may + override this method to support more appropriate behavior if needed. + + The :class:`FancyURLopener` class offers one additional method that should be + overloaded to provide the appropriate behavior: + + .. method:: prompt_user_passwd(host, realm) + + Return information needed to authenticate the user at the given host in the + specified security realm. The return value should be a tuple, ``(user, + password)``, which can be used for basic authentication. + + The implementation prompts for this information on the terminal; an application + should override this method to use an appropriate interaction model in the local + environment. + + +:mod:`urllib.request` Restrictions +---------------------------------- + + .. index:: + pair: HTTP; protocol + pair: FTP; protocol + +* Currently, only the following protocols are supported: HTTP (versions 0.9 and + 1.0), FTP, local files, and data URLs. + + .. versionchanged:: 3.4 Added support for data URLs. + +* The caching feature of :func:`urlretrieve` has been disabled until someone + finds the time to hack proper processing of Expiration time headers. + +* There should be a function to query whether a particular URL is in the cache. + +* For backward compatibility, if a URL appears to point to a local file but the + file can't be opened, the URL is re-interpreted using the FTP protocol. This + can sometimes cause confusing error messages. + +* The :func:`urlopen` and :func:`urlretrieve` functions can cause arbitrarily + long delays while waiting for a network connection to be set up. This means + that it is difficult to build an interactive Web client using these functions + without using threads. + + .. index:: + single: HTML + pair: HTTP; protocol + +* The data returned by :func:`urlopen` or :func:`urlretrieve` is the raw data + returned by the server. This may be binary data (such as an image), plain text + or (for example) HTML. The HTTP protocol provides type information in the reply + header, which can be inspected by looking at the :mailheader:`Content-Type` + header. If the returned data is HTML, you can use the module + :mod:`html.parser` to parse it. + + .. index:: single: FTP + +* The code handling the FTP protocol cannot differentiate between a file and a + directory. This can lead to unexpected behavior when attempting to read a URL + that points to a file that is not accessible. If the URL ends in a ``/``, it is + assumed to refer to a directory and will be handled accordingly. But if an + attempt to read a file leads to a 550 error (meaning the URL cannot be found or + is not accessible, often for permission reasons), then the path is treated as a + directory in order to handle the case when a directory is specified by a URL but + the trailing ``/`` has been left off. This can cause misleading results when + you try to fetch a file whose read permissions make it inaccessible; the FTP + code will try to read it, fail with a 550 error, and then perform a directory + listing for the unreadable file. If fine-grained control is needed, consider + using the :mod:`ftplib` module, subclassing :class:`FancyURLopener`, or changing + *_urlopener* to meet your needs. + + + +:mod:`urllib.response` --- Response classes used by urllib +========================================================== + +.. module:: urllib.response + :synopsis: Response classes used by urllib. + +The :mod:`urllib.response` module defines functions and classes which define a +minimal file like interface, including ``read()`` and ``readline()``. The +typical response object is an addinfourl instance, which defines an ``info()`` +method and that returns headers and a ``geturl()`` method that returns the url. +Functions defined by this module are used internally by the +:mod:`urllib.request` module. + diff --git a/python-3.7.4-docs-html/_sources/library/urllib.robotparser.rst.txt b/python-3.7.4-docs-html/_sources/library/urllib.robotparser.rst.txt new file mode 100644 index 0000000..e3b90e6 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/urllib.robotparser.rst.txt @@ -0,0 +1,97 @@ +:mod:`urllib.robotparser` --- Parser for robots.txt +==================================================== + +.. module:: urllib.robotparser + :synopsis: Load a robots.txt file and answer questions about + fetchability of other URLs. + +.. sectionauthor:: Skip Montanaro <skip@pobox.com> + +**Source code:** :source:`Lib/urllib/robotparser.py` + +.. index:: + single: WWW + single: World Wide Web + single: URL + single: robots.txt + +-------------- + +This module provides a single class, :class:`RobotFileParser`, which answers +questions about whether or not a particular user agent can fetch a URL on the +Web site that published the :file:`robots.txt` file. For more details on the +structure of :file:`robots.txt` files, see http://www.robotstxt.org/orig.html. + + +.. class:: RobotFileParser(url='') + + This class provides methods to read, parse and answer questions about the + :file:`robots.txt` file at *url*. + + .. method:: set_url(url) + + Sets the URL referring to a :file:`robots.txt` file. + + .. method:: read() + + Reads the :file:`robots.txt` URL and feeds it to the parser. + + .. method:: parse(lines) + + Parses the lines argument. + + .. method:: can_fetch(useragent, url) + + Returns ``True`` if the *useragent* is allowed to fetch the *url* + according to the rules contained in the parsed :file:`robots.txt` + file. + + .. method:: mtime() + + Returns the time the ``robots.txt`` file was last fetched. This is + useful for long-running web spiders that need to check for new + ``robots.txt`` files periodically. + + .. method:: modified() + + Sets the time the ``robots.txt`` file was last fetched to the current + time. + + .. method:: crawl_delay(useragent) + + Returns the value of the ``Crawl-delay`` parameter from ``robots.txt`` + for the *useragent* in question. If there is no such parameter or it + doesn't apply to the *useragent* specified or the ``robots.txt`` entry + for this parameter has invalid syntax, return ``None``. + + .. versionadded:: 3.6 + + .. method:: request_rate(useragent) + + Returns the contents of the ``Request-rate`` parameter from + ``robots.txt`` as a :term:`named tuple` ``RequestRate(requests, seconds)``. + If there is no such parameter or it doesn't apply to the *useragent* + specified or the ``robots.txt`` entry for this parameter has invalid + syntax, return ``None``. + + .. versionadded:: 3.6 + + +The following example demonstrates basic use of the :class:`RobotFileParser` +class:: + + >>> import urllib.robotparser + >>> rp = urllib.robotparser.RobotFileParser() + >>> rp.set_url("http://www.musi-cal.com/robots.txt") + >>> rp.read() + >>> rrate = rp.request_rate("*") + >>> rrate.requests + 3 + >>> rrate.seconds + 20 + >>> rp.crawl_delay("*") + 6 + >>> rp.can_fetch("*", "http://www.musi-cal.com/cgi-bin/search?city=San+Francisco") + False + >>> rp.can_fetch("*", "http://www.musi-cal.com/") + True diff --git a/python-3.7.4-docs-html/_sources/library/urllib.rst.txt b/python-3.7.4-docs-html/_sources/library/urllib.rst.txt new file mode 100644 index 0000000..624e164 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/urllib.rst.txt @@ -0,0 +1,15 @@ +:mod:`urllib` --- URL handling modules +====================================== + +.. module:: urllib + +**Source code:** :source:`Lib/urllib/` + +-------------- + +``urllib`` is a package that collects several modules for working with URLs: + +* :mod:`urllib.request` for opening and reading URLs +* :mod:`urllib.error` containing the exceptions raised by :mod:`urllib.request` +* :mod:`urllib.parse` for parsing URLs +* :mod:`urllib.robotparser` for parsing ``robots.txt`` files diff --git a/python-3.7.4-docs-html/_sources/library/uu.rst.txt b/python-3.7.4-docs-html/_sources/library/uu.rst.txt new file mode 100644 index 0000000..0bc8021 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/uu.rst.txt @@ -0,0 +1,66 @@ +:mod:`uu` --- Encode and decode uuencode files +============================================== + +.. module:: uu + :synopsis: Encode and decode files in uuencode format. + +.. moduleauthor:: Lance Ellinghouse + +**Source code:** :source:`Lib/uu.py` + +-------------- + +This module encodes and decodes files in uuencode format, allowing arbitrary +binary data to be transferred over ASCII-only connections. Wherever a file +argument is expected, the methods accept a file-like object. For backwards +compatibility, a string containing a pathname is also accepted, and the +corresponding file will be opened for reading and writing; the pathname ``'-'`` +is understood to mean the standard input or output. However, this interface is +deprecated; it's better for the caller to open the file itself, and be sure +that, when required, the mode is ``'rb'`` or ``'wb'`` on Windows. + +.. index:: + single: Jansen, Jack + single: Ellinghouse, Lance + +This code was contributed by Lance Ellinghouse, and modified by Jack Jansen. + +The :mod:`uu` module defines the following functions: + + +.. function:: encode(in_file, out_file, name=None, mode=None, *, backtick=False) + + Uuencode file *in_file* into file *out_file*. The uuencoded file will have + the header specifying *name* and *mode* as the defaults for the results of + decoding the file. The default defaults are taken from *in_file*, or ``'-'`` + and ``0o666`` respectively. If *backtick* is true, zeros are represented by + ``'`'`` instead of spaces. + + .. versionchanged:: 3.7 + Added the *backtick* parameter. + + +.. function:: decode(in_file, out_file=None, mode=None, quiet=False) + + This call decodes uuencoded file *in_file* placing the result on file + *out_file*. If *out_file* is a pathname, *mode* is used to set the permission + bits if the file must be created. Defaults for *out_file* and *mode* are taken + from the uuencode header. However, if the file specified in the header already + exists, a :exc:`uu.Error` is raised. + + :func:`decode` may print a warning to standard error if the input was produced + by an incorrect uuencoder and Python could recover from that error. Setting + *quiet* to a true value silences this warning. + + +.. exception:: Error() + + Subclass of :exc:`Exception`, this can be raised by :func:`uu.decode` under + various situations, such as described above, but also including a badly + formatted header, or truncated input file. + + +.. seealso:: + + Module :mod:`binascii` + Support module containing ASCII-to-binary and binary-to-ASCII conversions. diff --git a/python-3.7.4-docs-html/_sources/library/uuid.rst.txt b/python-3.7.4-docs-html/_sources/library/uuid.rst.txt new file mode 100644 index 0000000..415e25b --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/uuid.rst.txt @@ -0,0 +1,303 @@ +:mod:`uuid` --- UUID objects according to :rfc:`4122` +===================================================== + +.. module:: uuid + :synopsis: UUID objects (universally unique identifiers) according to RFC 4122 +.. moduleauthor:: Ka-Ping Yee <ping@zesty.ca> +.. sectionauthor:: George Yoshida <quiver@users.sourceforge.net> + +**Source code:** :source:`Lib/uuid.py` + +-------------- + +This module provides immutable :class:`UUID` objects (the :class:`UUID` class) +and the functions :func:`uuid1`, :func:`uuid3`, :func:`uuid4`, :func:`uuid5` for +generating version 1, 3, 4, and 5 UUIDs as specified in :rfc:`4122`. + +If all you want is a unique ID, you should probably call :func:`uuid1` or +:func:`uuid4`. Note that :func:`uuid1` may compromise privacy since it creates +a UUID containing the computer's network address. :func:`uuid4` creates a +random UUID. + +Depending on support from the underlying platform, :func:`uuid1` may or may +not return a "safe" UUID. A safe UUID is one which is generated using +synchronization methods that ensure no two processes can obtain the same +UUID. All instances of :class:`UUID` have an :attr:`is_safe` attribute +which relays any information about the UUID's safety, using this enumeration: + +.. class:: SafeUUID + + .. versionadded:: 3.7 + + .. attribute:: SafeUUID.safe + + The UUID was generated by the platform in a multiprocessing-safe way. + + .. attribute:: SafeUUID.unsafe + + The UUID was not generated in a multiprocessing-safe way. + + .. attribute:: SafeUUID.unknown + + The platform does not provide information on whether the UUID was + generated safely or not. + +.. class:: UUID(hex=None, bytes=None, bytes_le=None, fields=None, int=None, version=None, *, is_safe=SafeUUID.unknown) + + Create a UUID from either a string of 32 hexadecimal digits, a string of 16 + bytes in big-endian order as the *bytes* argument, a string of 16 bytes in + little-endian order as the *bytes_le* argument, a tuple of six integers + (32-bit *time_low*, 16-bit *time_mid*, 16-bit *time_hi_version*, + 8-bit *clock_seq_hi_variant*, 8-bit *clock_seq_low*, 48-bit *node*) as the + *fields* argument, or a single 128-bit integer as the *int* argument. + When a string of hex digits is given, curly braces, hyphens, + and a URN prefix are all optional. For example, these + expressions all yield the same UUID:: + + UUID('{12345678-1234-5678-1234-567812345678}') + UUID('12345678123456781234567812345678') + UUID('urn:uuid:12345678-1234-5678-1234-567812345678') + UUID(bytes=b'\x12\x34\x56\x78'*4) + UUID(bytes_le=b'\x78\x56\x34\x12\x34\x12\x78\x56' + + b'\x12\x34\x56\x78\x12\x34\x56\x78') + UUID(fields=(0x12345678, 0x1234, 0x5678, 0x12, 0x34, 0x567812345678)) + UUID(int=0x12345678123456781234567812345678) + + Exactly one of *hex*, *bytes*, *bytes_le*, *fields*, or *int* must be given. + The *version* argument is optional; if given, the resulting UUID will have its + variant and version number set according to :rfc:`4122`, overriding bits in the + given *hex*, *bytes*, *bytes_le*, *fields*, or *int*. + + Comparison of UUID objects are made by way of comparing their + :attr:`UUID.int` attributes. Comparison with a non-UUID object + raises a :exc:`TypeError`. + + ``str(uuid)`` returns a string in the form + ``12345678-1234-5678-1234-567812345678`` where the 32 hexadecimal digits + represent the UUID. + +:class:`UUID` instances have these read-only attributes: + +.. attribute:: UUID.bytes + + The UUID as a 16-byte string (containing the six integer fields in big-endian + byte order). + + +.. attribute:: UUID.bytes_le + + The UUID as a 16-byte string (with *time_low*, *time_mid*, and *time_hi_version* + in little-endian byte order). + + +.. attribute:: UUID.fields + + A tuple of the six integer fields of the UUID, which are also available as six + individual attributes and two derived attributes: + + +------------------------------+-------------------------------+ + | Field | Meaning | + +==============================+===============================+ + | :attr:`time_low` | the first 32 bits of the UUID | + +------------------------------+-------------------------------+ + | :attr:`time_mid` | the next 16 bits of the UUID | + +------------------------------+-------------------------------+ + | :attr:`time_hi_version` | the next 16 bits of the UUID | + +------------------------------+-------------------------------+ + | :attr:`clock_seq_hi_variant` | the next 8 bits of the UUID | + +------------------------------+-------------------------------+ + | :attr:`clock_seq_low` | the next 8 bits of the UUID | + +------------------------------+-------------------------------+ + | :attr:`node` | the last 48 bits of the UUID | + +------------------------------+-------------------------------+ + | :attr:`time` | the 60-bit timestamp | + +------------------------------+-------------------------------+ + | :attr:`clock_seq` | the 14-bit sequence number | + +------------------------------+-------------------------------+ + + +.. attribute:: UUID.hex + + The UUID as a 32-character hexadecimal string. + + +.. attribute:: UUID.int + + The UUID as a 128-bit integer. + + +.. attribute:: UUID.urn + + The UUID as a URN as specified in :rfc:`4122`. + + +.. attribute:: UUID.variant + + The UUID variant, which determines the internal layout of the UUID. This will be + one of the constants :const:`RESERVED_NCS`, :const:`RFC_4122`, + :const:`RESERVED_MICROSOFT`, or :const:`RESERVED_FUTURE`. + + +.. attribute:: UUID.version + + The UUID version number (1 through 5, meaningful only when the variant is + :const:`RFC_4122`). + +.. attribute:: UUID.is_safe + + An enumeration of :class:`SafeUUID` which indicates whether the platform + generated the UUID in a multiprocessing-safe way. + + .. versionadded:: 3.7 + +The :mod:`uuid` module defines the following functions: + + +.. function:: getnode() + + Get the hardware address as a 48-bit positive integer. The first time this + runs, it may launch a separate program, which could be quite slow. If all + attempts to obtain the hardware address fail, we choose a random 48-bit + number with the multicast bit (least significant bit of the first octet) + set to 1 as recommended in :rfc:`4122`. "Hardware address" means the MAC + address of a network interface. On a machine with multiple network + interfaces, universally administered MAC addresses (i.e. where the second + least significant bit of the first octet is *unset*) will be preferred over + locally administered MAC addresses, but with no other ordering guarantees. + + .. versionchanged:: 3.7 + Universally administered MAC addresses are preferred over locally + administered MAC addresses, since the former are guaranteed to be + globally unique, while the latter are not. + +.. index:: single: getnode + + +.. function:: uuid1(node=None, clock_seq=None) + + Generate a UUID from a host ID, sequence number, and the current time. If *node* + is not given, :func:`getnode` is used to obtain the hardware address. If + *clock_seq* is given, it is used as the sequence number; otherwise a random + 14-bit sequence number is chosen. + +.. index:: single: uuid1 + + +.. function:: uuid3(namespace, name) + + Generate a UUID based on the MD5 hash of a namespace identifier (which is a + UUID) and a name (which is a string). + +.. index:: single: uuid3 + + +.. function:: uuid4() + + Generate a random UUID. + +.. index:: single: uuid4 + + +.. function:: uuid5(namespace, name) + + Generate a UUID based on the SHA-1 hash of a namespace identifier (which is a + UUID) and a name (which is a string). + +.. index:: single: uuid5 + +The :mod:`uuid` module defines the following namespace identifiers for use with +:func:`uuid3` or :func:`uuid5`. + + +.. data:: NAMESPACE_DNS + + When this namespace is specified, the *name* string is a fully-qualified domain + name. + + +.. data:: NAMESPACE_URL + + When this namespace is specified, the *name* string is a URL. + + +.. data:: NAMESPACE_OID + + When this namespace is specified, the *name* string is an ISO OID. + + +.. data:: NAMESPACE_X500 + + When this namespace is specified, the *name* string is an X.500 DN in DER or a + text output format. + +The :mod:`uuid` module defines the following constants for the possible values +of the :attr:`variant` attribute: + + +.. data:: RESERVED_NCS + + Reserved for NCS compatibility. + + +.. data:: RFC_4122 + + Specifies the UUID layout given in :rfc:`4122`. + + +.. data:: RESERVED_MICROSOFT + + Reserved for Microsoft compatibility. + + +.. data:: RESERVED_FUTURE + + Reserved for future definition. + + +.. seealso:: + + :rfc:`4122` - A Universally Unique IDentifier (UUID) URN Namespace + This specification defines a Uniform Resource Name namespace for UUIDs, the + internal format of UUIDs, and methods of generating UUIDs. + + +.. _uuid-example: + +Example +------- + +Here are some examples of typical usage of the :mod:`uuid` module:: + + >>> import uuid + + >>> # make a UUID based on the host ID and current time + >>> uuid.uuid1() + UUID('a8098c1a-f86e-11da-bd1a-00112444be1e') + + >>> # make a UUID using an MD5 hash of a namespace UUID and a name + >>> uuid.uuid3(uuid.NAMESPACE_DNS, 'python.org') + UUID('6fa459ea-ee8a-3ca4-894e-db77e160355e') + + >>> # make a random UUID + >>> uuid.uuid4() + UUID('16fd2706-8baf-433b-82eb-8c7fada847da') + + >>> # make a UUID using a SHA-1 hash of a namespace UUID and a name + >>> uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org') + UUID('886313e1-3b8a-5372-9b90-0c9aee199e5d') + + >>> # make a UUID from a string of hex digits (braces and hyphens ignored) + >>> x = uuid.UUID('{00010203-0405-0607-0809-0a0b0c0d0e0f}') + + >>> # convert a UUID to a string of hex digits in standard form + >>> str(x) + '00010203-0405-0607-0809-0a0b0c0d0e0f' + + >>> # get the raw 16 bytes of the UUID + >>> x.bytes + b'\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\r\x0e\x0f' + + >>> # make a UUID from a 16-byte string + >>> uuid.UUID(bytes=x.bytes) + UUID('00010203-0405-0607-0809-0a0b0c0d0e0f') + diff --git a/python-3.7.4-docs-html/_sources/library/venv.rst.txt b/python-3.7.4-docs-html/_sources/library/venv.rst.txt new file mode 100644 index 0000000..d61df48 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/venv.rst.txt @@ -0,0 +1,478 @@ +:mod:`venv` --- Creation of virtual environments +================================================ + +.. module:: venv + :synopsis: Creation of virtual environments. + +.. moduleauthor:: Vinay Sajip <vinay_sajip@yahoo.co.uk> +.. sectionauthor:: Vinay Sajip <vinay_sajip@yahoo.co.uk> + +.. versionadded:: 3.3 + +**Source code:** :source:`Lib/venv/` + +.. index:: pair: Environments; virtual + +-------------- + +The :mod:`venv` module provides support for creating lightweight "virtual +environments" with their own site directories, optionally isolated from system +site directories. Each virtual environment has its own Python binary (which +matches the version of the binary that was used to create this environment) and +can have its own independent set of installed Python packages in its site +directories. + +See :pep:`405` for more information about Python virtual environments. + +.. seealso:: + + `Python Packaging User Guide: Creating and using virtual environments + <https://packaging.python.org/installing/#creating-virtual-environments>`__ + +.. note:: + The ``pyvenv`` script has been deprecated as of Python 3.6 in favor of using + ``python3 -m venv`` to help prevent any potential confusion as to which + Python interpreter a virtual environment will be based on. + + +Creating virtual environments +----------------------------- + +.. include:: /using/venv-create.inc + + +.. _venv-def: + +.. note:: A virtual environment is a Python environment such that the Python + interpreter, libraries and scripts installed into it are isolated from those + installed in other virtual environments, and (by default) any libraries + installed in a "system" Python, i.e., one which is installed as part of your + operating system. + + A virtual environment is a directory tree which contains Python executable + files and other files which indicate that it is a virtual environment. + + Common installation tools such as ``Setuptools`` and ``pip`` work as + expected with virtual environments. In other words, when a virtual + environment is active, they install Python packages into the virtual + environment without needing to be told to do so explicitly. + + When a virtual environment is active (i.e., the virtual environment's Python + interpreter is running), the attributes :attr:`sys.prefix` and + :attr:`sys.exec_prefix` point to the base directory of the virtual + environment, whereas :attr:`sys.base_prefix` and + :attr:`sys.base_exec_prefix` point to the non-virtual environment Python + installation which was used to create the virtual environment. If a virtual + environment is not active, then :attr:`sys.prefix` is the same as + :attr:`sys.base_prefix` and :attr:`sys.exec_prefix` is the same as + :attr:`sys.base_exec_prefix` (they all point to a non-virtual environment + Python installation). + + When a virtual environment is active, any options that change the + installation path will be ignored from all distutils configuration files to + prevent projects being inadvertently installed outside of the virtual + environment. + + When working in a command shell, users can make a virtual environment active + by running an ``activate`` script in the virtual environment's executables + directory (the precise filename is shell-dependent), which prepends the + virtual environment's directory for executables to the ``PATH`` environment + variable for the running shell. There should be no need in other + circumstances to activate a virtual environment—scripts installed into + virtual environments have a "shebang" line which points to the virtual + environment's Python interpreter. This means that the script will run with + that interpreter regardless of the value of ``PATH``. On Windows, "shebang" + line processing is supported if you have the Python Launcher for Windows + installed (this was added to Python in 3.3 - see :pep:`397` for more + details). Thus, double-clicking an installed script in a Windows Explorer + window should run the script with the correct interpreter without there + needing to be any reference to its virtual environment in ``PATH``. + + +.. _venv-api: + +API +--- + +.. highlight:: python + +The high-level method described above makes use of a simple API which provides +mechanisms for third-party virtual environment creators to customize environment +creation according to their needs, the :class:`EnvBuilder` class. + +.. class:: EnvBuilder(system_site_packages=False, clear=False, \ + symlinks=False, upgrade=False, with_pip=False, \ + prompt=None) + + The :class:`EnvBuilder` class accepts the following keyword arguments on + instantiation: + + * ``system_site_packages`` -- a Boolean value indicating that the system Python + site-packages should be available to the environment (defaults to ``False``). + + * ``clear`` -- a Boolean value which, if true, will delete the contents of + any existing target directory, before creating the environment. + + * ``symlinks`` -- a Boolean value indicating whether to attempt to symlink the + Python binary rather than copying. + + * ``upgrade`` -- a Boolean value which, if true, will upgrade an existing + environment with the running Python - for use when that Python has been + upgraded in-place (defaults to ``False``). + + * ``with_pip`` -- a Boolean value which, if true, ensures pip is + installed in the virtual environment. This uses :mod:`ensurepip` with + the ``--default-pip`` option. + + * ``prompt`` -- a String to be used after virtual environment is activated + (defaults to ``None`` which means directory name of the environment would + be used). + + .. versionchanged:: 3.4 + Added the ``with_pip`` parameter + + .. versionadded:: 3.6 + Added the ``prompt`` parameter + + Creators of third-party virtual environment tools will be free to use the + provided ``EnvBuilder`` class as a base class. + + The returned env-builder is an object which has a method, ``create``: + + .. method:: create(env_dir) + + This method takes as required argument the path (absolute or relative to + the current directory) of the target directory which is to contain the + virtual environment. The ``create`` method will either create the + environment in the specified directory, or raise an appropriate + exception. + + The ``create`` method of the ``EnvBuilder`` class illustrates the hooks + available for subclass customization:: + + def create(self, env_dir): + """ + Create a virtualized Python environment in a directory. + env_dir is the target directory to create an environment in. + """ + env_dir = os.path.abspath(env_dir) + context = self.ensure_directories(env_dir) + self.create_configuration(context) + self.setup_python(context) + self.setup_scripts(context) + self.post_setup(context) + + Each of the methods :meth:`ensure_directories`, + :meth:`create_configuration`, :meth:`setup_python`, + :meth:`setup_scripts` and :meth:`post_setup` can be overridden. + + .. method:: ensure_directories(env_dir) + + Creates the environment directory and all necessary directories, and + returns a context object. This is just a holder for attributes (such as + paths), for use by the other methods. The directories are allowed to + exist already, as long as either ``clear`` or ``upgrade`` were + specified to allow operating on an existing environment directory. + + .. method:: create_configuration(context) + + Creates the ``pyvenv.cfg`` configuration file in the environment. + + .. method:: setup_python(context) + + Creates a copy or symlink to the Python executable in the environment. + On POSIX systems, if a specific executable ``python3.x`` was used, + symlinks to ``python`` and ``python3`` will be created pointing to that + executable, unless files with those names already exist. + + .. method:: setup_scripts(context) + + Installs activation scripts appropriate to the platform into the virtual + environment. + + .. method:: post_setup(context) + + A placeholder method which can be overridden in third party + implementations to pre-install packages in the virtual environment or + perform other post-creation steps. + + .. versionchanged:: 3.7.2 + Windows now uses redirector scripts for ``python[w].exe`` instead of + copying the actual binaries. In 3.7.2 only :meth:`setup_python` does + nothing unless running from a build in the source tree. + + .. versionchanged:: 3.7.3 + Windows copies the redirector scripts as part of :meth:`setup_python` + instead of :meth:`setup_scripts`. This was not the case in 3.7.2. + When using symlinks, the original executables will be linked. + + In addition, :class:`EnvBuilder` provides this utility method that can be + called from :meth:`setup_scripts` or :meth:`post_setup` in subclasses to + assist in installing custom scripts into the virtual environment. + + .. method:: install_scripts(context, path) + + *path* is the path to a directory that should contain subdirectories + "common", "posix", "nt", each containing scripts destined for the bin + directory in the environment. The contents of "common" and the + directory corresponding to :data:`os.name` are copied after some text + replacement of placeholders: + + * ``__VENV_DIR__`` is replaced with the absolute path of the environment + directory. + + * ``__VENV_NAME__`` is replaced with the environment name (final path + segment of environment directory). + + * ``__VENV_PROMPT__`` is replaced with the prompt (the environment + name surrounded by parentheses and with a following space) + + * ``__VENV_BIN_NAME__`` is replaced with the name of the bin directory + (either ``bin`` or ``Scripts``). + + * ``__VENV_PYTHON__`` is replaced with the absolute path of the + environment's executable. + + The directories are allowed to exist (for when an existing environment + is being upgraded). + +There is also a module-level convenience function: + +.. function:: create(env_dir, system_site_packages=False, clear=False, \ + symlinks=False, with_pip=False, prompt=None) + + Create an :class:`EnvBuilder` with the given keyword arguments, and call its + :meth:`~EnvBuilder.create` method with the *env_dir* argument. + + .. versionadded:: 3.3 + + .. versionchanged:: 3.4 + Added the ``with_pip`` parameter + + .. versionchanged:: 3.6 + Added the ``prompt`` parameter + +An example of extending ``EnvBuilder`` +-------------------------------------- + +The following script shows how to extend :class:`EnvBuilder` by implementing a +subclass which installs setuptools and pip into a created virtual environment:: + + import os + import os.path + from subprocess import Popen, PIPE + import sys + from threading import Thread + from urllib.parse import urlparse + from urllib.request import urlretrieve + import venv + + class ExtendedEnvBuilder(venv.EnvBuilder): + """ + This builder installs setuptools and pip so that you can pip or + easy_install other packages into the created virtual environment. + + :param nodist: If True, setuptools and pip are not installed into the + created virtual environment. + :param nopip: If True, pip is not installed into the created + virtual environment. + :param progress: If setuptools or pip are installed, the progress of the + installation can be monitored by passing a progress + callable. If specified, it is called with two + arguments: a string indicating some progress, and a + context indicating where the string is coming from. + The context argument can have one of three values: + 'main', indicating that it is called from virtualize() + itself, and 'stdout' and 'stderr', which are obtained + by reading lines from the output streams of a subprocess + which is used to install the app. + + If a callable is not specified, default progress + information is output to sys.stderr. + """ + + def __init__(self, *args, **kwargs): + self.nodist = kwargs.pop('nodist', False) + self.nopip = kwargs.pop('nopip', False) + self.progress = kwargs.pop('progress', None) + self.verbose = kwargs.pop('verbose', False) + super().__init__(*args, **kwargs) + + def post_setup(self, context): + """ + Set up any packages which need to be pre-installed into the + virtual environment being created. + + :param context: The information for the virtual environment + creation request being processed. + """ + os.environ['VIRTUAL_ENV'] = context.env_dir + if not self.nodist: + self.install_setuptools(context) + # Can't install pip without setuptools + if not self.nopip and not self.nodist: + self.install_pip(context) + + def reader(self, stream, context): + """ + Read lines from a subprocess' output stream and either pass to a progress + callable (if specified) or write progress information to sys.stderr. + """ + progress = self.progress + while True: + s = stream.readline() + if not s: + break + if progress is not None: + progress(s, context) + else: + if not self.verbose: + sys.stderr.write('.') + else: + sys.stderr.write(s.decode('utf-8')) + sys.stderr.flush() + stream.close() + + def install_script(self, context, name, url): + _, _, path, _, _, _ = urlparse(url) + fn = os.path.split(path)[-1] + binpath = context.bin_path + distpath = os.path.join(binpath, fn) + # Download script into the virtual environment's binaries folder + urlretrieve(url, distpath) + progress = self.progress + if self.verbose: + term = '\n' + else: + term = '' + if progress is not None: + progress('Installing %s ...%s' % (name, term), 'main') + else: + sys.stderr.write('Installing %s ...%s' % (name, term)) + sys.stderr.flush() + # Install in the virtual environment + args = [context.env_exe, fn] + p = Popen(args, stdout=PIPE, stderr=PIPE, cwd=binpath) + t1 = Thread(target=self.reader, args=(p.stdout, 'stdout')) + t1.start() + t2 = Thread(target=self.reader, args=(p.stderr, 'stderr')) + t2.start() + p.wait() + t1.join() + t2.join() + if progress is not None: + progress('done.', 'main') + else: + sys.stderr.write('done.\n') + # Clean up - no longer needed + os.unlink(distpath) + + def install_setuptools(self, context): + """ + Install setuptools in the virtual environment. + + :param context: The information for the virtual environment + creation request being processed. + """ + url = 'https://bitbucket.org/pypa/setuptools/downloads/ez_setup.py' + self.install_script(context, 'setuptools', url) + # clear up the setuptools archive which gets downloaded + pred = lambda o: o.startswith('setuptools-') and o.endswith('.tar.gz') + files = filter(pred, os.listdir(context.bin_path)) + for f in files: + f = os.path.join(context.bin_path, f) + os.unlink(f) + + def install_pip(self, context): + """ + Install pip in the virtual environment. + + :param context: The information for the virtual environment + creation request being processed. + """ + url = 'https://raw.github.com/pypa/pip/master/contrib/get-pip.py' + self.install_script(context, 'pip', url) + + def main(args=None): + compatible = True + if sys.version_info < (3, 3): + compatible = False + elif not hasattr(sys, 'base_prefix'): + compatible = False + if not compatible: + raise ValueError('This script is only for use with ' + 'Python 3.3 or later') + else: + import argparse + + parser = argparse.ArgumentParser(prog=__name__, + description='Creates virtual Python ' + 'environments in one or ' + 'more target ' + 'directories.') + parser.add_argument('dirs', metavar='ENV_DIR', nargs='+', + help='A directory in which to create the + 'virtual environment.') + parser.add_argument('--no-setuptools', default=False, + action='store_true', dest='nodist', + help="Don't install setuptools or pip in the " + "virtual environment.") + parser.add_argument('--no-pip', default=False, + action='store_true', dest='nopip', + help="Don't install pip in the virtual " + "environment.") + parser.add_argument('--system-site-packages', default=False, + action='store_true', dest='system_site', + help='Give the virtual environment access to the ' + 'system site-packages dir.') + if os.name == 'nt': + use_symlinks = False + else: + use_symlinks = True + parser.add_argument('--symlinks', default=use_symlinks, + action='store_true', dest='symlinks', + help='Try to use symlinks rather than copies, ' + 'when symlinks are not the default for ' + 'the platform.') + parser.add_argument('--clear', default=False, action='store_true', + dest='clear', help='Delete the contents of the ' + 'virtual environment ' + 'directory if it already ' + 'exists, before virtual ' + 'environment creation.') + parser.add_argument('--upgrade', default=False, action='store_true', + dest='upgrade', help='Upgrade the virtual ' + 'environment directory to ' + 'use this version of ' + 'Python, assuming Python ' + 'has been upgraded ' + 'in-place.') + parser.add_argument('--verbose', default=False, action='store_true', + dest='verbose', help='Display the output ' + 'from the scripts which ' + 'install setuptools and pip.') + options = parser.parse_args(args) + if options.upgrade and options.clear: + raise ValueError('you cannot supply --upgrade and --clear together.') + builder = ExtendedEnvBuilder(system_site_packages=options.system_site, + clear=options.clear, + symlinks=options.symlinks, + upgrade=options.upgrade, + nodist=options.nodist, + nopip=options.nopip, + verbose=options.verbose) + for d in options.dirs: + builder.create(d) + + if __name__ == '__main__': + rc = 1 + try: + main() + rc = 0 + except Exception as e: + print('Error: %s' % e, file=sys.stderr) + sys.exit(rc) + + +This script is also available for download `online +<https://gist.github.com/vsajip/4673395>`_. diff --git a/python-3.7.4-docs-html/_sources/library/warnings.rst.txt b/python-3.7.4-docs-html/_sources/library/warnings.rst.txt new file mode 100644 index 0000000..d121f32 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/warnings.rst.txt @@ -0,0 +1,516 @@ +:mod:`warnings` --- Warning control +=================================== + +.. module:: warnings + :synopsis: Issue warning messages and control their disposition. + +**Source code:** :source:`Lib/warnings.py` + +.. index:: single: warnings + +-------------- + +Warning messages are typically issued in situations where it is useful to alert +the user of some condition in a program, where that condition (normally) doesn't +warrant raising an exception and terminating the program. For example, one +might want to issue a warning when a program uses an obsolete module. + +Python programmers issue warnings by calling the :func:`warn` function defined +in this module. (C programmers use :c:func:`PyErr_WarnEx`; see +:ref:`exceptionhandling` for details). + +Warning messages are normally written to ``sys.stderr``, but their disposition +can be changed flexibly, from ignoring all warnings to turning them into +exceptions. The disposition of warnings can vary based on the warning category +(see below), the text of the warning message, and the source location where it +is issued. Repetitions of a particular warning for the same source location are +typically suppressed. + +There are two stages in warning control: first, each time a warning is issued, a +determination is made whether a message should be issued or not; next, if a +message is to be issued, it is formatted and printed using a user-settable hook. + +The determination whether to issue a warning message is controlled by the +warning filter, which is a sequence of matching rules and actions. Rules can be +added to the filter by calling :func:`filterwarnings` and reset to its default +state by calling :func:`resetwarnings`. + +The printing of warning messages is done by calling :func:`showwarning`, which +may be overridden; the default implementation of this function formats the +message by calling :func:`formatwarning`, which is also available for use by +custom implementations. + +.. seealso:: + :func:`logging.captureWarnings` allows you to handle all warnings with + the standard logging infrastructure. + + +.. _warning-categories: + +Warning Categories +------------------ + +There are a number of built-in exceptions that represent warning categories. +This categorization is useful to be able to filter out groups of warnings. + +While these are technically +:ref:`built-in exceptions <warning-categories-as-exceptions>`, they are +documented here, because conceptually they belong to the warnings mechanism. + +User code can define additional warning categories by subclassing one of the +standard warning categories. A warning category must always be a subclass of +the :exc:`Warning` class. + +The following warnings category classes are currently defined: + +.. tabularcolumns:: |l|p{0.6\linewidth}| + ++----------------------------------+-----------------------------------------------+ +| Class | Description | ++==================================+===============================================+ +| :exc:`Warning` | This is the base class of all warning | +| | category classes. It is a subclass of | +| | :exc:`Exception`. | ++----------------------------------+-----------------------------------------------+ +| :exc:`UserWarning` | The default category for :func:`warn`. | ++----------------------------------+-----------------------------------------------+ +| :exc:`DeprecationWarning` | Base category for warnings about deprecated | +| | features when those warnings are intended for | +| | other Python developers (ignored by default, | +| | unless triggered by code in ``__main__``). | ++----------------------------------+-----------------------------------------------+ +| :exc:`SyntaxWarning` | Base category for warnings about dubious | +| | syntactic features. | ++----------------------------------+-----------------------------------------------+ +| :exc:`RuntimeWarning` | Base category for warnings about dubious | +| | runtime features. | ++----------------------------------+-----------------------------------------------+ +| :exc:`FutureWarning` | Base category for warnings about deprecated | +| | features when those warnings are intended for | +| | end users of applications that are written in | +| | Python. | ++----------------------------------+-----------------------------------------------+ +| :exc:`PendingDeprecationWarning` | Base category for warnings about features | +| | that will be deprecated in the future | +| | (ignored by default). | ++----------------------------------+-----------------------------------------------+ +| :exc:`ImportWarning` | Base category for warnings triggered during | +| | the process of importing a module (ignored by | +| | default). | ++----------------------------------+-----------------------------------------------+ +| :exc:`UnicodeWarning` | Base category for warnings related to | +| | Unicode. | ++----------------------------------+-----------------------------------------------+ +| :exc:`BytesWarning` | Base category for warnings related to | +| | :class:`bytes` and :class:`bytearray`. | ++----------------------------------+-----------------------------------------------+ +| :exc:`ResourceWarning` | Base category for warnings related to | +| | resource usage. | ++----------------------------------+-----------------------------------------------+ + +.. versionchanged:: 3.7 + Previously :exc:`DeprecationWarning` and :exc:`FutureWarning` were + distinguished based on whether a feature was being removed entirely or + changing its behaviour. They are now distinguished based on their + intended audience and the way they're handled by the default warnings + filters. + + +.. _warning-filter: + +The Warnings Filter +------------------- + +The warnings filter controls whether warnings are ignored, displayed, or turned +into errors (raising an exception). + +Conceptually, the warnings filter maintains an ordered list of filter +specifications; any specific warning is matched against each filter +specification in the list in turn until a match is found; the filter determines +the disposition of the match. Each entry is a tuple of the form (*action*, +*message*, *category*, *module*, *lineno*), where: + +* *action* is one of the following strings: + + +---------------+----------------------------------------------+ + | Value | Disposition | + +===============+==============================================+ + | ``"default"`` | print the first occurrence of matching | + | | warnings for each location (module + | + | | line number) where the warning is issued | + +---------------+----------------------------------------------+ + | ``"error"`` | turn matching warnings into exceptions | + +---------------+----------------------------------------------+ + | ``"ignore"`` | never print matching warnings | + +---------------+----------------------------------------------+ + | ``"always"`` | always print matching warnings | + +---------------+----------------------------------------------+ + | ``"module"`` | print the first occurrence of matching | + | | warnings for each module where the warning | + | | is issued (regardless of line number) | + +---------------+----------------------------------------------+ + | ``"once"`` | print only the first occurrence of matching | + | | warnings, regardless of location | + +---------------+----------------------------------------------+ + +* *message* is a string containing a regular expression that the start of + the warning message must match. The expression is compiled to always be + case-insensitive. + +* *category* is a class (a subclass of :exc:`Warning`) of which the warning + category must be a subclass in order to match. + +* *module* is a string containing a regular expression that the module name must + match. The expression is compiled to be case-sensitive. + +* *lineno* is an integer that the line number where the warning occurred must + match, or ``0`` to match all line numbers. + +Since the :exc:`Warning` class is derived from the built-in :exc:`Exception` +class, to turn a warning into an error we simply raise ``category(message)``. + +If a warning is reported and doesn't match any registered filter then the +"default" action is applied (hence its name). + + +.. _describing-warning-filters: + +Describing Warning Filters +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The warnings filter is initialized by :option:`-W` options passed to the Python +interpreter command line and the :envvar:`PYTHONWARNINGS` environment variable. +The interpreter saves the arguments for all supplied entries without +interpretation in ``sys.warnoptions``; the :mod:`warnings` module parses these +when it is first imported (invalid options are ignored, after printing a +message to ``sys.stderr``). + +Individual warnings filters are specified as a sequence of fields separated by +colons:: + + action:message:category:module:line + +The meaning of each of these fields is as described in :ref:`warning-filter`. +When listing multiple filters on a single line (as for +:envvar:`PYTHONWARNINGS`), the individual filters are separated by commas,and +the filters listed later take precedence over those listed before them (as +they're applied left-to-right, and the most recently applied filters take +precedence over earlier ones). + +Commonly used warning filters apply to either all warnings, warnings in a +particular category, or warnings raised by particular modules or packages. +Some examples:: + + default # Show all warnings (even those ignored by default) + ignore # Ignore all warnings + error # Convert all warnings to errors + error::ResourceWarning # Treat ResourceWarning messages as errors + default::DeprecationWarning # Show DeprecationWarning messages + ignore,default:::mymodule # Only report warnings triggered by "mymodule" + error:::mymodule[.*] # Convert warnings to errors in "mymodule" + # and any subpackages of "mymodule" + + +.. _default-warning-filter: + +Default Warning Filter +~~~~~~~~~~~~~~~~~~~~~~ + +By default, Python installs several warning filters, which can be overridden by +the :option:`-W` command-line option, the :envvar:`PYTHONWARNINGS` environment +variable and calls to :func:`filterwarnings`. + +In regular release builds, the default warning filter has the following entries +(in order of precedence):: + + default::DeprecationWarning:__main__ + ignore::DeprecationWarning + ignore::PendingDeprecationWarning + ignore::ImportWarning + ignore::ResourceWarning + +In debug builds, the list of default warning filters is empty. + +.. versionchanged:: 3.2 + :exc:`DeprecationWarning` is now ignored by default in addition to + :exc:`PendingDeprecationWarning`. + +.. versionchanged:: 3.7 + :exc:`DeprecationWarning` is once again shown by default when triggered + directly by code in ``__main__``. + +.. versionchanged:: 3.7 + :exc:`BytesWarning` no longer appears in the default filter list and is + instead configured via :data:`sys.warnoptions` when :option:`-b` is specified + twice. + + +.. _warning-disable: + +Overriding the default filter +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Developers of applications written in Python may wish to hide *all* Python level +warnings from their users by default, and only display them when running tests +or otherwise working on the application. The :data:`sys.warnoptions` attribute +used to pass filter configurations to the interpreter can be used as a marker to +indicate whether or not warnings should be disabled:: + + import sys + + if not sys.warnoptions: + import warnings + warnings.simplefilter("ignore") + +Developers of test runners for Python code are advised to instead ensure that +*all* warnings are displayed by default for the code under test, using code +like:: + + import sys + + if not sys.warnoptions: + import os, warnings + warnings.simplefilter("default") # Change the filter in this process + os.environ["PYTHONWARNINGS"] = "default" # Also affect subprocesses + +Finally, developers of interactive shells that run user code in a namespace +other than ``__main__`` are advised to ensure that :exc:`DeprecationWarning` +messages are made visible by default, using code like the following (where +``user_ns`` is the module used to execute code entered interactively):: + + import warnings + warnings.filterwarnings("default", category=DeprecationWarning, + module=user_ns.get("__name__")) + + +.. _warning-suppress: + +Temporarily Suppressing Warnings +-------------------------------- + +If you are using code that you know will raise a warning, such as a deprecated +function, but do not want to see the warning (even when warnings have been +explicitly configured via the command line), then it is possible to suppress +the warning using the :class:`catch_warnings` context manager:: + + import warnings + + def fxn(): + warnings.warn("deprecated", DeprecationWarning) + + with warnings.catch_warnings(): + warnings.simplefilter("ignore") + fxn() + +While within the context manager all warnings will simply be ignored. This +allows you to use known-deprecated code without having to see the warning while +not suppressing the warning for other code that might not be aware of its use +of deprecated code. Note: this can only be guaranteed in a single-threaded +application. If two or more threads use the :class:`catch_warnings` context +manager at the same time, the behavior is undefined. + + + +.. _warning-testing: + +Testing Warnings +---------------- + +To test warnings raised by code, use the :class:`catch_warnings` context +manager. With it you can temporarily mutate the warnings filter to facilitate +your testing. For instance, do the following to capture all raised warnings to +check:: + + import warnings + + def fxn(): + warnings.warn("deprecated", DeprecationWarning) + + with warnings.catch_warnings(record=True) as w: + # Cause all warnings to always be triggered. + warnings.simplefilter("always") + # Trigger a warning. + fxn() + # Verify some things + assert len(w) == 1 + assert issubclass(w[-1].category, DeprecationWarning) + assert "deprecated" in str(w[-1].message) + +One can also cause all warnings to be exceptions by using ``error`` instead of +``always``. One thing to be aware of is that if a warning has already been +raised because of a ``once``/``default`` rule, then no matter what filters are +set the warning will not be seen again unless the warnings registry related to +the warning has been cleared. + +Once the context manager exits, the warnings filter is restored to its state +when the context was entered. This prevents tests from changing the warnings +filter in unexpected ways between tests and leading to indeterminate test +results. The :func:`showwarning` function in the module is also restored to +its original value. Note: this can only be guaranteed in a single-threaded +application. If two or more threads use the :class:`catch_warnings` context +manager at the same time, the behavior is undefined. + +When testing multiple operations that raise the same kind of warning, it +is important to test them in a manner that confirms each operation is raising +a new warning (e.g. set warnings to be raised as exceptions and check the +operations raise exceptions, check that the length of the warning list +continues to increase after each operation, or else delete the previous +entries from the warnings list before each new operation). + + +.. _warning-ignored: + +Updating Code For New Versions of Dependencies +---------------------------------------------- + +Warning categories that are primarily of interest to Python developers (rather +than end users of applications written in Python) are ignored by default. + +Notably, this "ignored by default" list includes :exc:`DeprecationWarning` +(for every module except ``__main__``), which means developers should make sure +to test their code with typically ignored warnings made visible in order to +receive timely notifications of future breaking API changes (whether in the +standard library or third party packages). + +In the ideal case, the code will have a suitable test suite, and the test runner +will take care of implicitly enabling all warnings when running tests +(the test runner provided by the :mod:`unittest` module does this). + +In less ideal cases, applications can be checked for use of deprecated +interfaces by passing :option:`-Wd <-W>` to the Python interpreter (this is +shorthand for :option:`!-W default`) or setting ``PYTHONWARNINGS=default`` in +the environment. This enables default handling for all warnings, including those +that are ignored by default. To change what action is taken for encountered +warnings you can change what argument is passed to :option:`-W` (e.g. +:option:`!-W error`). See the :option:`-W` flag for more details on what is +possible. + + +.. _warning-functions: + +Available Functions +------------------- + + +.. function:: warn(message, category=None, stacklevel=1, source=None) + + Issue a warning, or maybe ignore it or raise an exception. The *category* + argument, if given, must be a warning category class (see above); it defaults to + :exc:`UserWarning`. Alternatively *message* can be a :exc:`Warning` instance, + in which case *category* will be ignored and ``message.__class__`` will be used. + In this case the message text will be ``str(message)``. This function raises an + exception if the particular warning issued is changed into an error by the + warnings filter see above. The *stacklevel* argument can be used by wrapper + functions written in Python, like this:: + + def deprecation(message): + warnings.warn(message, DeprecationWarning, stacklevel=2) + + This makes the warning refer to :func:`deprecation`'s caller, rather than to the + source of :func:`deprecation` itself (since the latter would defeat the purpose + of the warning message). + + *source*, if supplied, is the destroyed object which emitted a + :exc:`ResourceWarning`. + + .. versionchanged:: 3.6 + Added *source* parameter. + + +.. function:: warn_explicit(message, category, filename, lineno, module=None, registry=None, module_globals=None, source=None) + + This is a low-level interface to the functionality of :func:`warn`, passing in + explicitly the message, category, filename and line number, and optionally the + module name and the registry (which should be the ``__warningregistry__`` + dictionary of the module). The module name defaults to the filename with + ``.py`` stripped; if no registry is passed, the warning is never suppressed. + *message* must be a string and *category* a subclass of :exc:`Warning` or + *message* may be a :exc:`Warning` instance, in which case *category* will be + ignored. + + *module_globals*, if supplied, should be the global namespace in use by the code + for which the warning is issued. (This argument is used to support displaying + source for modules found in zipfiles or other non-filesystem import + sources). + + *source*, if supplied, is the destroyed object which emitted a + :exc:`ResourceWarning`. + + .. versionchanged:: 3.6 + Add the *source* parameter. + + +.. function:: showwarning(message, category, filename, lineno, file=None, line=None) + + Write a warning to a file. The default implementation calls + ``formatwarning(message, category, filename, lineno, line)`` and writes the + resulting string to *file*, which defaults to ``sys.stderr``. You may replace + this function with any callable by assigning to ``warnings.showwarning``. + *line* is a line of source code to be included in the warning + message; if *line* is not supplied, :func:`showwarning` will + try to read the line specified by *filename* and *lineno*. + + +.. function:: formatwarning(message, category, filename, lineno, line=None) + + Format a warning the standard way. This returns a string which may contain + embedded newlines and ends in a newline. *line* is a line of source code to + be included in the warning message; if *line* is not supplied, + :func:`formatwarning` will try to read the line specified by *filename* and + *lineno*. + + +.. function:: filterwarnings(action, message='', category=Warning, module='', lineno=0, append=False) + + Insert an entry into the list of :ref:`warnings filter specifications + <warning-filter>`. The entry is inserted at the front by default; if + *append* is true, it is inserted at the end. This checks the types of the + arguments, compiles the *message* and *module* regular expressions, and + inserts them as a tuple in the list of warnings filters. Entries closer to + the front of the list override entries later in the list, if both match a + particular warning. Omitted arguments default to a value that matches + everything. + + +.. function:: simplefilter(action, category=Warning, lineno=0, append=False) + + Insert a simple entry into the list of :ref:`warnings filter specifications + <warning-filter>`. The meaning of the function parameters is as for + :func:`filterwarnings`, but regular expressions are not needed as the filter + inserted always matches any message in any module as long as the category and + line number match. + + +.. function:: resetwarnings() + + Reset the warnings filter. This discards the effect of all previous calls to + :func:`filterwarnings`, including that of the :option:`-W` command line options + and calls to :func:`simplefilter`. + + +Available Context Managers +-------------------------- + +.. class:: catch_warnings(\*, record=False, module=None) + + A context manager that copies and, upon exit, restores the warnings filter + and the :func:`showwarning` function. + If the *record* argument is :const:`False` (the default) the context manager + returns :class:`None` on entry. If *record* is :const:`True`, a list is + returned that is progressively populated with objects as seen by a custom + :func:`showwarning` function (which also suppresses output to ``sys.stdout``). + Each object in the list has attributes with the same names as the arguments to + :func:`showwarning`. + + The *module* argument takes a module that will be used instead of the + module returned when you import :mod:`warnings` whose filter will be + protected. This argument exists primarily for testing the :mod:`warnings` + module itself. + + .. note:: + + The :class:`catch_warnings` manager works by replacing and + then later restoring the module's + :func:`showwarning` function and internal list of filter + specifications. This means the context manager is modifying + global state and therefore is not thread-safe. diff --git a/python-3.7.4-docs-html/_sources/library/wave.rst.txt b/python-3.7.4-docs-html/_sources/library/wave.rst.txt new file mode 100644 index 0000000..60d19a8 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/wave.rst.txt @@ -0,0 +1,249 @@ +:mod:`wave` --- Read and write WAV files +======================================== + +.. module:: wave + :synopsis: Provide an interface to the WAV sound format. + +.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> +.. Documentations stolen from comments in file. + +**Source code:** :source:`Lib/wave.py` + +-------------- + +The :mod:`wave` module provides a convenient interface to the WAV sound format. +It does not support compression/decompression, but it does support mono/stereo. + +The :mod:`wave` module defines the following function and exception: + + +.. function:: open(file, mode=None) + + If *file* is a string, open the file by that name, otherwise treat it as a + file-like object. *mode* can be: + + ``'rb'`` + Read only mode. + + ``'wb'`` + Write only mode. + + Note that it does not allow read/write WAV files. + + A *mode* of ``'rb'`` returns a :class:`Wave_read` object, while a *mode* of + ``'wb'`` returns a :class:`Wave_write` object. If *mode* is omitted and a + file-like object is passed as *file*, ``file.mode`` is used as the default + value for *mode*. + + If you pass in a file-like object, the wave object will not close it when its + :meth:`close` method is called; it is the caller's responsibility to close + the file object. + + The :func:`.open` function may be used in a :keyword:`with` statement. When + the :keyword:`!with` block completes, the :meth:`Wave_read.close() + <wave.Wave_read.close>` or :meth:`Wave_write.close() + <wave.Wave_write.close()>` method is called. + + .. versionchanged:: 3.4 + Added support for unseekable files. + +.. function:: openfp(file, mode) + + A synonym for :func:`.open`, maintained for backwards compatibility. + + .. deprecated-removed:: 3.7 3.9 + + +.. exception:: Error + + An error raised when something is impossible because it violates the WAV + specification or hits an implementation deficiency. + + +.. _wave-read-objects: + +Wave_read Objects +----------------- + +Wave_read objects, as returned by :func:`.open`, have the following methods: + + +.. method:: Wave_read.close() + + Close the stream if it was opened by :mod:`wave`, and make the instance + unusable. This is called automatically on object collection. + + +.. method:: Wave_read.getnchannels() + + Returns number of audio channels (``1`` for mono, ``2`` for stereo). + + +.. method:: Wave_read.getsampwidth() + + Returns sample width in bytes. + + +.. method:: Wave_read.getframerate() + + Returns sampling frequency. + + +.. method:: Wave_read.getnframes() + + Returns number of audio frames. + + +.. method:: Wave_read.getcomptype() + + Returns compression type (``'NONE'`` is the only supported type). + + +.. method:: Wave_read.getcompname() + + Human-readable version of :meth:`getcomptype`. Usually ``'not compressed'`` + parallels ``'NONE'``. + + +.. method:: Wave_read.getparams() + + Returns a :func:`~collections.namedtuple` ``(nchannels, sampwidth, + framerate, nframes, comptype, compname)``, equivalent to output of the + :meth:`get\*` methods. + + +.. method:: Wave_read.readframes(n) + + Reads and returns at most *n* frames of audio, as a :class:`bytes` object. + + +.. method:: Wave_read.rewind() + + Rewind the file pointer to the beginning of the audio stream. + +The following two methods are defined for compatibility with the :mod:`aifc` +module, and don't do anything interesting. + + +.. method:: Wave_read.getmarkers() + + Returns ``None``. + + +.. method:: Wave_read.getmark(id) + + Raise an error. + +The following two methods define a term "position" which is compatible between +them, and is otherwise implementation dependent. + + +.. method:: Wave_read.setpos(pos) + + Set the file pointer to the specified position. + + +.. method:: Wave_read.tell() + + Return current file pointer position. + + +.. _wave-write-objects: + +Wave_write Objects +------------------ + +For seekable output streams, the ``wave`` header will automatically be updated +to reflect the number of frames actually written. For unseekable streams, the +*nframes* value must be accurate when the first frame data is written. An +accurate *nframes* value can be achieved either by calling +:meth:`~Wave_write.setnframes` or :meth:`~Wave_write.setparams` with the number +of frames that will be written before :meth:`~Wave_write.close` is called and +then using :meth:`~Wave_write.writeframesraw` to write the frame data, or by +calling :meth:`~Wave_write.writeframes` with all of the frame data to be +written. In the latter case :meth:`~Wave_write.writeframes` will calculate +the number of frames in the data and set *nframes* accordingly before writing +the frame data. + +Wave_write objects, as returned by :func:`.open`, have the following methods: + +.. versionchanged:: 3.4 + Added support for unseekable files. + + +.. method:: Wave_write.close() + + Make sure *nframes* is correct, and close the file if it was opened by + :mod:`wave`. This method is called upon object collection. It will raise + an exception if the output stream is not seekable and *nframes* does not + match the number of frames actually written. + + +.. method:: Wave_write.setnchannels(n) + + Set the number of channels. + + +.. method:: Wave_write.setsampwidth(n) + + Set the sample width to *n* bytes. + + +.. method:: Wave_write.setframerate(n) + + Set the frame rate to *n*. + + .. versionchanged:: 3.2 + A non-integral input to this method is rounded to the nearest + integer. + + +.. method:: Wave_write.setnframes(n) + + Set the number of frames to *n*. This will be changed later if the number + of frames actually written is different (this update attempt will + raise an error if the output stream is not seekable). + + +.. method:: Wave_write.setcomptype(type, name) + + Set the compression type and description. At the moment, only compression type + ``NONE`` is supported, meaning no compression. + + +.. method:: Wave_write.setparams(tuple) + + The *tuple* should be ``(nchannels, sampwidth, framerate, nframes, comptype, + compname)``, with values valid for the :meth:`set\*` methods. Sets all + parameters. + + +.. method:: Wave_write.tell() + + Return current position in the file, with the same disclaimer for the + :meth:`Wave_read.tell` and :meth:`Wave_read.setpos` methods. + + +.. method:: Wave_write.writeframesraw(data) + + Write audio frames, without correcting *nframes*. + + .. versionchanged:: 3.4 + Any :term:`bytes-like object` is now accepted. + + +.. method:: Wave_write.writeframes(data) + + Write audio frames and make sure *nframes* is correct. It will raise an + error if the output stream is not seekable and the total number of frames + that have been written after *data* has been written does not match the + previously set value for *nframes*. + + .. versionchanged:: 3.4 + Any :term:`bytes-like object` is now accepted. + + +Note that it is invalid to set any parameters after calling :meth:`writeframes` +or :meth:`writeframesraw`, and any attempt to do so will raise +:exc:`wave.Error`. + diff --git a/python-3.7.4-docs-html/_sources/library/weakref.rst.txt b/python-3.7.4-docs-html/_sources/library/weakref.rst.txt new file mode 100644 index 0000000..8d8a0b5 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/weakref.rst.txt @@ -0,0 +1,578 @@ +:mod:`weakref` --- Weak references +================================== + +.. module:: weakref + :synopsis: Support for weak references and weak dictionaries. + +.. moduleauthor:: Fred L. Drake, Jr. <fdrake@acm.org> +.. moduleauthor:: Neil Schemenauer <nas@arctrix.com> +.. moduleauthor:: Martin von Löwis <martin@loewis.home.cs.tu-berlin.de> +.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> + +**Source code:** :source:`Lib/weakref.py` + +-------------- + +The :mod:`weakref` module allows the Python programmer to create :dfn:`weak +references` to objects. + +.. When making changes to the examples in this file, be sure to update + Lib/test/test_weakref.py::libreftest too! + +In the following, the term :dfn:`referent` means the object which is referred to +by a weak reference. + +A weak reference to an object is not enough to keep the object alive: when the +only remaining references to a referent are weak references, +:term:`garbage collection` is free to destroy the referent and reuse its memory +for something else. However, until the object is actually destroyed the weak +reference may return the object even if there are no strong references to it. + +A primary use for weak references is to implement caches or +mappings holding large objects, where it's desired that a large object not be +kept alive solely because it appears in a cache or mapping. + +For example, if you have a number of large binary image objects, you may wish to +associate a name with each. If you used a Python dictionary to map names to +images, or images to names, the image objects would remain alive just because +they appeared as values or keys in the dictionaries. The +:class:`WeakKeyDictionary` and :class:`WeakValueDictionary` classes supplied by +the :mod:`weakref` module are an alternative, using weak references to construct +mappings that don't keep objects alive solely because they appear in the mapping +objects. If, for example, an image object is a value in a +:class:`WeakValueDictionary`, then when the last remaining references to that +image object are the weak references held by weak mappings, garbage collection +can reclaim the object, and its corresponding entries in weak mappings are +simply deleted. + +:class:`WeakKeyDictionary` and :class:`WeakValueDictionary` use weak references +in their implementation, setting up callback functions on the weak references +that notify the weak dictionaries when a key or value has been reclaimed by +garbage collection. :class:`WeakSet` implements the :class:`set` interface, +but keeps weak references to its elements, just like a +:class:`WeakKeyDictionary` does. + +:class:`finalize` provides a straight forward way to register a +cleanup function to be called when an object is garbage collected. +This is simpler to use than setting up a callback function on a raw +weak reference, since the module automatically ensures that the finalizer +remains alive until the object is collected. + +Most programs should find that using one of these weak container types +or :class:`finalize` is all they need -- it's not usually necessary to +create your own weak references directly. The low-level machinery is +exposed by the :mod:`weakref` module for the benefit of advanced uses. + +Not all objects can be weakly referenced; those objects which can include class +instances, functions written in Python (but not in C), instance methods, sets, +frozensets, some :term:`file objects <file object>`, :term:`generators <generator>`, +type objects, sockets, arrays, deques, regular expression pattern objects, and code +objects. + +.. versionchanged:: 3.2 + Added support for thread.lock, threading.Lock, and code objects. + +Several built-in types such as :class:`list` and :class:`dict` do not directly +support weak references but can add support through subclassing:: + + class Dict(dict): + pass + + obj = Dict(red=1, green=2, blue=3) # this object is weak referenceable + +.. impl-detail:: + + Other built-in types such as :class:`tuple` and :class:`int` do not support weak + references even when subclassed. + +Extension types can easily be made to support weak references; see +:ref:`weakref-support`. + + +.. class:: ref(object[, callback]) + + Return a weak reference to *object*. The original object can be retrieved by + calling the reference object if the referent is still alive; if the referent is + no longer alive, calling the reference object will cause :const:`None` to be + returned. If *callback* is provided and not :const:`None`, and the returned + weakref object is still alive, the callback will be called when the object is + about to be finalized; the weak reference object will be passed as the only + parameter to the callback; the referent will no longer be available. + + It is allowable for many weak references to be constructed for the same object. + Callbacks registered for each weak reference will be called from the most + recently registered callback to the oldest registered callback. + + Exceptions raised by the callback will be noted on the standard error output, + but cannot be propagated; they are handled in exactly the same way as exceptions + raised from an object's :meth:`__del__` method. + + Weak references are :term:`hashable` if the *object* is hashable. They will + maintain their hash value even after the *object* was deleted. If + :func:`hash` is called the first time only after the *object* was deleted, + the call will raise :exc:`TypeError`. + + Weak references support tests for equality, but not ordering. If the referents + are still alive, two references have the same equality relationship as their + referents (regardless of the *callback*). If either referent has been deleted, + the references are equal only if the reference objects are the same object. + + This is a subclassable type rather than a factory function. + + .. attribute:: __callback__ + + This read-only attribute returns the callback currently associated to the + weakref. If there is no callback or if the referent of the weakref is + no longer alive then this attribute will have value ``None``. + + .. versionchanged:: 3.4 + Added the :attr:`__callback__` attribute. + + +.. function:: proxy(object[, callback]) + + Return a proxy to *object* which uses a weak reference. This supports use of + the proxy in most contexts instead of requiring the explicit dereferencing used + with weak reference objects. The returned object will have a type of either + ``ProxyType`` or ``CallableProxyType``, depending on whether *object* is + callable. Proxy objects are not :term:`hashable` regardless of the referent; this + avoids a number of problems related to their fundamentally mutable nature, and + prevent their use as dictionary keys. *callback* is the same as the parameter + of the same name to the :func:`ref` function. + + +.. function:: getweakrefcount(object) + + Return the number of weak references and proxies which refer to *object*. + + +.. function:: getweakrefs(object) + + Return a list of all weak reference and proxy objects which refer to *object*. + + +.. class:: WeakKeyDictionary([dict]) + + Mapping class that references keys weakly. Entries in the dictionary will be + discarded when there is no longer a strong reference to the key. This can be + used to associate additional data with an object owned by other parts of an + application without adding attributes to those objects. This can be especially + useful with objects that override attribute accesses. + + .. note:: + + Caution: Because a :class:`WeakKeyDictionary` is built on top of a Python + dictionary, it must not change size when iterating over it. This can be + difficult to ensure for a :class:`WeakKeyDictionary` because actions + performed by the program during iteration may cause items in the + dictionary to vanish "by magic" (as a side effect of garbage collection). + +:class:`WeakKeyDictionary` objects have an additional method that +exposes the internal references directly. The references are not guaranteed to +be "live" at the time they are used, so the result of calling the references +needs to be checked before being used. This can be used to avoid creating +references that will cause the garbage collector to keep the keys around longer +than needed. + + +.. method:: WeakKeyDictionary.keyrefs() + + Return an iterable of the weak references to the keys. + + +.. class:: WeakValueDictionary([dict]) + + Mapping class that references values weakly. Entries in the dictionary will be + discarded when no strong reference to the value exists any more. + + .. note:: + + Caution: Because a :class:`WeakValueDictionary` is built on top of a Python + dictionary, it must not change size when iterating over it. This can be + difficult to ensure for a :class:`WeakValueDictionary` because actions performed + by the program during iteration may cause items in the dictionary to vanish "by + magic" (as a side effect of garbage collection). + +:class:`WeakValueDictionary` objects have an additional method that has the +same issues as the :meth:`keyrefs` method of :class:`WeakKeyDictionary` +objects. + + +.. method:: WeakValueDictionary.valuerefs() + + Return an iterable of the weak references to the values. + + +.. class:: WeakSet([elements]) + + Set class that keeps weak references to its elements. An element will be + discarded when no strong reference to it exists any more. + + +.. class:: WeakMethod(method) + + A custom :class:`ref` subclass which simulates a weak reference to a bound + method (i.e., a method defined on a class and looked up on an instance). + Since a bound method is ephemeral, a standard weak reference cannot keep + hold of it. :class:`WeakMethod` has special code to recreate the bound + method until either the object or the original function dies:: + + >>> class C: + ... def method(self): + ... print("method called!") + ... + >>> c = C() + >>> r = weakref.ref(c.method) + >>> r() + >>> r = weakref.WeakMethod(c.method) + >>> r() + <bound method C.method of <__main__.C object at 0x7fc859830220>> + >>> r()() + method called! + >>> del c + >>> gc.collect() + 0 + >>> r() + >>> + + .. versionadded:: 3.4 + +.. class:: finalize(obj, func, *args, **kwargs) + + Return a callable finalizer object which will be called when *obj* + is garbage collected. Unlike an ordinary weak reference, a finalizer + will always survive until the reference object is collected, greatly + simplifying lifecycle management. + + A finalizer is considered *alive* until it is called (either explicitly + or at garbage collection), and after that it is *dead*. Calling a live + finalizer returns the result of evaluating ``func(*arg, **kwargs)``, + whereas calling a dead finalizer returns :const:`None`. + + Exceptions raised by finalizer callbacks during garbage collection + will be shown on the standard error output, but cannot be + propagated. They are handled in the same way as exceptions raised + from an object's :meth:`__del__` method or a weak reference's + callback. + + When the program exits, each remaining live finalizer is called + unless its :attr:`atexit` attribute has been set to false. They + are called in reverse order of creation. + + A finalizer will never invoke its callback during the later part of + the :term:`interpreter shutdown` when module globals are liable to have + been replaced by :const:`None`. + + .. method:: __call__() + + If *self* is alive then mark it as dead and return the result of + calling ``func(*args, **kwargs)``. If *self* is dead then return + :const:`None`. + + .. method:: detach() + + If *self* is alive then mark it as dead and return the tuple + ``(obj, func, args, kwargs)``. If *self* is dead then return + :const:`None`. + + .. method:: peek() + + If *self* is alive then return the tuple ``(obj, func, args, + kwargs)``. If *self* is dead then return :const:`None`. + + .. attribute:: alive + + Property which is true if the finalizer is alive, false otherwise. + + .. attribute:: atexit + + A writable boolean property which by default is true. When the + program exits, it calls all remaining live finalizers for which + :attr:`.atexit` is true. They are called in reverse order of + creation. + + .. note:: + + It is important to ensure that *func*, *args* and *kwargs* do + not own any references to *obj*, either directly or indirectly, + since otherwise *obj* will never be garbage collected. In + particular, *func* should not be a bound method of *obj*. + + .. versionadded:: 3.4 + + +.. data:: ReferenceType + + The type object for weak references objects. + + +.. data:: ProxyType + + The type object for proxies of objects which are not callable. + + +.. data:: CallableProxyType + + The type object for proxies of callable objects. + + +.. data:: ProxyTypes + + Sequence containing all the type objects for proxies. This can make it simpler + to test if an object is a proxy without being dependent on naming both proxy + types. + + +.. exception:: ReferenceError + + Exception raised when a proxy object is used but the underlying object has been + collected. This is the same as the standard :exc:`ReferenceError` exception. + + +.. seealso:: + + :pep:`205` - Weak References + The proposal and rationale for this feature, including links to earlier + implementations and information about similar features in other languages. + + +.. _weakref-objects: + +Weak Reference Objects +---------------------- + +Weak reference objects have no methods and no attributes besides +:attr:`ref.__callback__`. A weak reference object allows the referent to be +obtained, if it still exists, by calling it: + + >>> import weakref + >>> class Object: + ... pass + ... + >>> o = Object() + >>> r = weakref.ref(o) + >>> o2 = r() + >>> o is o2 + True + +If the referent no longer exists, calling the reference object returns +:const:`None`: + + >>> del o, o2 + >>> print(r()) + None + +Testing that a weak reference object is still live should be done using the +expression ``ref() is not None``. Normally, application code that needs to use +a reference object should follow this pattern:: + + # r is a weak reference object + o = r() + if o is None: + # referent has been garbage collected + print("Object has been deallocated; can't frobnicate.") + else: + print("Object is still live!") + o.do_something_useful() + +Using a separate test for "liveness" creates race conditions in threaded +applications; another thread can cause a weak reference to become invalidated +before the weak reference is called; the idiom shown above is safe in threaded +applications as well as single-threaded applications. + +Specialized versions of :class:`ref` objects can be created through subclassing. +This is used in the implementation of the :class:`WeakValueDictionary` to reduce +the memory overhead for each entry in the mapping. This may be most useful to +associate additional information with a reference, but could also be used to +insert additional processing on calls to retrieve the referent. + +This example shows how a subclass of :class:`ref` can be used to store +additional information about an object and affect the value that's returned when +the referent is accessed:: + + import weakref + + class ExtendedRef(weakref.ref): + def __init__(self, ob, callback=None, **annotations): + super(ExtendedRef, self).__init__(ob, callback) + self.__counter = 0 + for k, v in annotations.items(): + setattr(self, k, v) + + def __call__(self): + """Return a pair containing the referent and the number of + times the reference has been called. + """ + ob = super(ExtendedRef, self).__call__() + if ob is not None: + self.__counter += 1 + ob = (ob, self.__counter) + return ob + + +.. _weakref-example: + +Example +------- + +This simple example shows how an application can use object IDs to retrieve +objects that it has seen before. The IDs of the objects can then be used in +other data structures without forcing the objects to remain alive, but the +objects can still be retrieved by ID if they do. + +.. Example contributed by Tim Peters. + +:: + + import weakref + + _id2obj_dict = weakref.WeakValueDictionary() + + def remember(obj): + oid = id(obj) + _id2obj_dict[oid] = obj + return oid + + def id2obj(oid): + return _id2obj_dict[oid] + + +.. _finalize-examples: + +Finalizer Objects +----------------- + +The main benefit of using :class:`finalize` is that it makes it simple +to register a callback without needing to preserve the returned finalizer +object. For instance + + >>> import weakref + >>> class Object: + ... pass + ... + >>> kenny = Object() + >>> weakref.finalize(kenny, print, "You killed Kenny!") #doctest:+ELLIPSIS + <finalize object at ...; for 'Object' at ...> + >>> del kenny + You killed Kenny! + +The finalizer can be called directly as well. However the finalizer +will invoke the callback at most once. + + >>> def callback(x, y, z): + ... print("CALLBACK") + ... return x + y + z + ... + >>> obj = Object() + >>> f = weakref.finalize(obj, callback, 1, 2, z=3) + >>> assert f.alive + >>> assert f() == 6 + CALLBACK + >>> assert not f.alive + >>> f() # callback not called because finalizer dead + >>> del obj # callback not called because finalizer dead + +You can unregister a finalizer using its :meth:`~finalize.detach` +method. This kills the finalizer and returns the arguments passed to +the constructor when it was created. + + >>> obj = Object() + >>> f = weakref.finalize(obj, callback, 1, 2, z=3) + >>> f.detach() #doctest:+ELLIPSIS + (<...Object object ...>, <function callback ...>, (1, 2), {'z': 3}) + >>> newobj, func, args, kwargs = _ + >>> assert not f.alive + >>> assert newobj is obj + >>> assert func(*args, **kwargs) == 6 + CALLBACK + +Unless you set the :attr:`~finalize.atexit` attribute to +:const:`False`, a finalizer will be called when the program exits if it +is still alive. For instance + +.. doctest:: + :options: +SKIP + + >>> obj = Object() + >>> weakref.finalize(obj, print, "obj dead or exiting") + <finalize object at ...; for 'Object' at ...> + >>> exit() + obj dead or exiting + + +Comparing finalizers with :meth:`__del__` methods +------------------------------------------------- + +Suppose we want to create a class whose instances represent temporary +directories. The directories should be deleted with their contents +when the first of the following events occurs: + +* the object is garbage collected, +* the object's :meth:`remove` method is called, or +* the program exits. + +We might try to implement the class using a :meth:`__del__` method as +follows:: + + class TempDir: + def __init__(self): + self.name = tempfile.mkdtemp() + + def remove(self): + if self.name is not None: + shutil.rmtree(self.name) + self.name = None + + @property + def removed(self): + return self.name is None + + def __del__(self): + self.remove() + +Starting with Python 3.4, :meth:`__del__` methods no longer prevent +reference cycles from being garbage collected, and module globals are +no longer forced to :const:`None` during :term:`interpreter shutdown`. +So this code should work without any issues on CPython. + +However, handling of :meth:`__del__` methods is notoriously implementation +specific, since it depends on internal details of the interpreter's garbage +collector implementation. + +A more robust alternative can be to define a finalizer which only references +the specific functions and objects that it needs, rather than having access +to the full state of the object:: + + class TempDir: + def __init__(self): + self.name = tempfile.mkdtemp() + self._finalizer = weakref.finalize(self, shutil.rmtree, self.name) + + def remove(self): + self._finalizer() + + @property + def removed(self): + return not self._finalizer.alive + +Defined like this, our finalizer only receives a reference to the details +it needs to clean up the directory appropriately. If the object never gets +garbage collected the finalizer will still be called at exit. + +The other advantage of weakref based finalizers is that they can be used to +register finalizers for classes where the definition is controlled by a +third party, such as running code when a module is unloaded:: + + import weakref, sys + def unloading_module(): + # implicit reference to the module globals from the function body + weakref.finalize(sys.modules[__name__], unloading_module) + + +.. note:: + + If you create a finalizer object in a daemonic thread just as the program + exits then there is the possibility that the finalizer + does not get called at exit. However, in a daemonic thread + :func:`atexit.register`, ``try: ... finally: ...`` and ``with: ...`` + do not guarantee that cleanup occurs either. diff --git a/python-3.7.4-docs-html/_sources/library/webbrowser.rst.txt b/python-3.7.4-docs-html/_sources/library/webbrowser.rst.txt new file mode 100644 index 0000000..9dc5551 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/webbrowser.rst.txt @@ -0,0 +1,218 @@ +:mod:`webbrowser` --- Convenient Web-browser controller +======================================================= + +.. module:: webbrowser + :synopsis: Easy-to-use controller for Web browsers. + +.. moduleauthor:: Fred L. Drake, Jr. <fdrake@acm.org> +.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> + +**Source code:** :source:`Lib/webbrowser.py` + +-------------- + +The :mod:`webbrowser` module provides a high-level interface to allow displaying +Web-based documents to users. Under most circumstances, simply calling the +:func:`.open` function from this module will do the right thing. + +Under Unix, graphical browsers are preferred under X11, but text-mode browsers +will be used if graphical browsers are not available or an X11 display isn't +available. If text-mode browsers are used, the calling process will block until +the user exits the browser. + +If the environment variable :envvar:`BROWSER` exists, it is interpreted as the +:data:`os.pathsep`-separated list of browsers to try ahead of the platform +defaults. When the value of a list part contains the string ``%s``, then it is +interpreted as a literal browser command line to be used with the argument URL +substituted for ``%s``; if the part does not contain ``%s``, it is simply +interpreted as the name of the browser to launch. [1]_ + +For non-Unix platforms, or when a remote browser is available on Unix, the +controlling process will not wait for the user to finish with the browser, but +allow the remote browser to maintain its own windows on the display. If remote +browsers are not available on Unix, the controlling process will launch a new +browser and wait. + +The script :program:`webbrowser` can be used as a command-line interface for the +module. It accepts a URL as the argument. It accepts the following optional +parameters: ``-n`` opens the URL in a new browser window, if possible; +``-t`` opens the URL in a new browser page ("tab"). The options are, +naturally, mutually exclusive. Usage example:: + + python -m webbrowser -t "http://www.python.org" + +The following exception is defined: + + +.. exception:: Error + + Exception raised when a browser control error occurs. + +The following functions are defined: + + +.. function:: open(url, new=0, autoraise=True) + + Display *url* using the default browser. If *new* is 0, the *url* is opened + in the same browser window if possible. If *new* is 1, a new browser window + is opened if possible. If *new* is 2, a new browser page ("tab") is opened + if possible. If *autoraise* is ``True``, the window is raised if possible + (note that under many window managers this will occur regardless of the + setting of this variable). + + Note that on some platforms, trying to open a filename using this function, + may work and start the operating system's associated program. However, this + is neither supported nor portable. + + +.. function:: open_new(url) + + Open *url* in a new window of the default browser, if possible, otherwise, open + *url* in the only browser window. + +.. function:: open_new_tab(url) + + Open *url* in a new page ("tab") of the default browser, if possible, otherwise + equivalent to :func:`open_new`. + + +.. function:: get(using=None) + + Return a controller object for the browser type *using*. If *using* is + ``None``, return a controller for a default browser appropriate to the + caller's environment. + + +.. function:: register(name, constructor, instance=None, *, preferred=False) + + Register the browser type *name*. Once a browser type is registered, the + :func:`get` function can return a controller for that browser type. If + *instance* is not provided, or is ``None``, *constructor* will be called without + parameters to create an instance when needed. If *instance* is provided, + *constructor* will never be called, and may be ``None``. + + Setting *preferred* to ``True`` makes this browser a preferred result for + a :func:`get` call with no argument. Otherwise, this entry point is only + useful if you plan to either set the :envvar:`BROWSER` variable or call + :func:`get` with a nonempty argument matching the name of a handler you + declare. + + .. versionchanged:: 3.7 + *preferred* keyword-only parameter was added. + +A number of browser types are predefined. This table gives the type names that +may be passed to the :func:`get` function and the corresponding instantiations +for the controller classes, all defined in this module. + ++------------------------+-----------------------------------------+-------+ +| Type Name | Class Name | Notes | ++========================+=========================================+=======+ +| ``'mozilla'`` | :class:`Mozilla('mozilla')` | | ++------------------------+-----------------------------------------+-------+ +| ``'firefox'`` | :class:`Mozilla('mozilla')` | | ++------------------------+-----------------------------------------+-------+ +| ``'netscape'`` | :class:`Mozilla('netscape')` | | ++------------------------+-----------------------------------------+-------+ +| ``'galeon'`` | :class:`Galeon('galeon')` | | ++------------------------+-----------------------------------------+-------+ +| ``'epiphany'`` | :class:`Galeon('epiphany')` | | ++------------------------+-----------------------------------------+-------+ +| ``'skipstone'`` | :class:`BackgroundBrowser('skipstone')` | | ++------------------------+-----------------------------------------+-------+ +| ``'kfmclient'`` | :class:`Konqueror()` | \(1) | ++------------------------+-----------------------------------------+-------+ +| ``'konqueror'`` | :class:`Konqueror()` | \(1) | ++------------------------+-----------------------------------------+-------+ +| ``'kfm'`` | :class:`Konqueror()` | \(1) | ++------------------------+-----------------------------------------+-------+ +| ``'mosaic'`` | :class:`BackgroundBrowser('mosaic')` | | ++------------------------+-----------------------------------------+-------+ +| ``'opera'`` | :class:`Opera()` | | ++------------------------+-----------------------------------------+-------+ +| ``'grail'`` | :class:`Grail()` | | ++------------------------+-----------------------------------------+-------+ +| ``'links'`` | :class:`GenericBrowser('links')` | | ++------------------------+-----------------------------------------+-------+ +| ``'elinks'`` | :class:`Elinks('elinks')` | | ++------------------------+-----------------------------------------+-------+ +| ``'lynx'`` | :class:`GenericBrowser('lynx')` | | ++------------------------+-----------------------------------------+-------+ +| ``'w3m'`` | :class:`GenericBrowser('w3m')` | | ++------------------------+-----------------------------------------+-------+ +| ``'windows-default'`` | :class:`WindowsDefault` | \(2) | ++------------------------+-----------------------------------------+-------+ +| ``'macosx'`` | :class:`MacOSX('default')` | \(3) | ++------------------------+-----------------------------------------+-------+ +| ``'safari'`` | :class:`MacOSX('safari')` | \(3) | ++------------------------+-----------------------------------------+-------+ +| ``'google-chrome'`` | :class:`Chrome('google-chrome')` | | ++------------------------+-----------------------------------------+-------+ +| ``'chrome'`` | :class:`Chrome('chrome')` | | ++------------------------+-----------------------------------------+-------+ +| ``'chromium'`` | :class:`Chromium('chromium')` | | ++------------------------+-----------------------------------------+-------+ +| ``'chromium-browser'`` | :class:`Chromium('chromium-browser')` | | ++------------------------+-----------------------------------------+-------+ + +Notes: + +(1) + "Konqueror" is the file manager for the KDE desktop environment for Unix, and + only makes sense to use if KDE is running. Some way of reliably detecting KDE + would be nice; the :envvar:`KDEDIR` variable is not sufficient. Note also that + the name "kfm" is used even when using the :program:`konqueror` command with KDE + 2 --- the implementation selects the best strategy for running Konqueror. + +(2) + Only on Windows platforms. + +(3) + Only on Mac OS X platform. + +.. versionadded:: 3.3 + Support for Chrome/Chromium has been added. + +Here are some simple examples:: + + url = 'http://docs.python.org/' + + # Open URL in a new tab, if a browser window is already open. + webbrowser.open_new_tab(url) + + # Open URL in new window, raising the window if possible. + webbrowser.open_new(url) + + +.. _browser-controllers: + +Browser Controller Objects +-------------------------- + +Browser controllers provide these methods which parallel three of the +module-level convenience functions: + + +.. method:: controller.open(url, new=0, autoraise=True) + + Display *url* using the browser handled by this controller. If *new* is 1, a new + browser window is opened if possible. If *new* is 2, a new browser page ("tab") + is opened if possible. + + +.. method:: controller.open_new(url) + + Open *url* in a new window of the browser handled by this controller, if + possible, otherwise, open *url* in the only browser window. Alias + :func:`open_new`. + + +.. method:: controller.open_new_tab(url) + + Open *url* in a new page ("tab") of the browser handled by this controller, if + possible, otherwise equivalent to :func:`open_new`. + + +.. rubric:: Footnotes + +.. [1] Executables named here without a full path will be searched in the + directories given in the :envvar:`PATH` environment variable. diff --git a/python-3.7.4-docs-html/_sources/library/windows.rst.txt b/python-3.7.4-docs-html/_sources/library/windows.rst.txt new file mode 100644 index 0000000..b60d4e4 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/windows.rst.txt @@ -0,0 +1,15 @@ +.. _mswin-specific-services: + +**************************** +MS Windows Specific Services +**************************** + +This chapter describes modules that are only available on MS Windows platforms. + + +.. toctree:: + + msilib.rst + msvcrt.rst + winreg.rst + winsound.rst diff --git a/python-3.7.4-docs-html/_sources/library/winreg.rst.txt b/python-3.7.4-docs-html/_sources/library/winreg.rst.txt new file mode 100644 index 0000000..e9c0261 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/winreg.rst.txt @@ -0,0 +1,756 @@ +:mod:`winreg` --- Windows registry access +========================================= + +.. module:: winreg + :platform: Windows + :synopsis: Routines and objects for manipulating the Windows registry. + +.. sectionauthor:: Mark Hammond <MarkH@ActiveState.com> + +-------------- + +These functions expose the Windows registry API to Python. Instead of using an +integer as the registry handle, a :ref:`handle object <handle-object>` is used +to ensure that the handles are closed correctly, even if the programmer neglects +to explicitly close them. + +.. _exception-changed: + +.. versionchanged:: 3.3 + Several functions in this module used to raise a + :exc:`WindowsError`, which is now an alias of :exc:`OSError`. + +.. _functions: + +Functions +------------------ + +This module offers the following functions: + + +.. function:: CloseKey(hkey) + + Closes a previously opened registry key. The *hkey* argument specifies a + previously opened key. + + .. note:: + + If *hkey* is not closed using this method (or via :meth:`hkey.Close() + <PyHKEY.Close>`), it is closed when the *hkey* object is destroyed by + Python. + + +.. function:: ConnectRegistry(computer_name, key) + + Establishes a connection to a predefined registry handle on another computer, + and returns a :ref:`handle object <handle-object>`. + + *computer_name* is the name of the remote computer, of the form + ``r"\\computername"``. If ``None``, the local computer is used. + + *key* is the predefined handle to connect to. + + The return value is the handle of the opened key. If the function fails, an + :exc:`OSError` exception is raised. + + .. versionchanged:: 3.3 + See :ref:`above <exception-changed>`. + + +.. function:: CreateKey(key, sub_key) + + Creates or opens the specified key, returning a + :ref:`handle object <handle-object>`. + + *key* is an already open key, or one of the predefined + :ref:`HKEY_* constants <hkey-constants>`. + + *sub_key* is a string that names the key this method opens or creates. + + If *key* is one of the predefined keys, *sub_key* may be ``None``. In that + case, the handle returned is the same key handle passed in to the function. + + If the key already exists, this function opens the existing key. + + The return value is the handle of the opened key. If the function fails, an + :exc:`OSError` exception is raised. + + .. versionchanged:: 3.3 + See :ref:`above <exception-changed>`. + + +.. function:: CreateKeyEx(key, sub_key, reserved=0, access=KEY_WRITE) + + Creates or opens the specified key, returning a + :ref:`handle object <handle-object>`. + + *key* is an already open key, or one of the predefined + :ref:`HKEY_* constants <hkey-constants>`. + + *sub_key* is a string that names the key this method opens or creates. + + *reserved* is a reserved integer, and must be zero. The default is zero. + + *access* is an integer that specifies an access mask that describes the desired + security access for the key. Default is :const:`KEY_WRITE`. See + :ref:`Access Rights <access-rights>` for other allowed values. + + If *key* is one of the predefined keys, *sub_key* may be ``None``. In that + case, the handle returned is the same key handle passed in to the function. + + If the key already exists, this function opens the existing key. + + The return value is the handle of the opened key. If the function fails, an + :exc:`OSError` exception is raised. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.3 + See :ref:`above <exception-changed>`. + + +.. function:: DeleteKey(key, sub_key) + + Deletes the specified key. + + *key* is an already open key, or one of the predefined + :ref:`HKEY_* constants <hkey-constants>`. + + *sub_key* is a string that must be a subkey of the key identified by the *key* + parameter. This value must not be ``None``, and the key may not have subkeys. + + *This method can not delete keys with subkeys.* + + If the method succeeds, the entire key, including all of its values, is removed. + If the method fails, an :exc:`OSError` exception is raised. + + .. versionchanged:: 3.3 + See :ref:`above <exception-changed>`. + + +.. function:: DeleteKeyEx(key, sub_key, access=KEY_WOW64_64KEY, reserved=0) + + Deletes the specified key. + + .. note:: + The :func:`DeleteKeyEx` function is implemented with the RegDeleteKeyEx + Windows API function, which is specific to 64-bit versions of Windows. + See the `RegDeleteKeyEx documentation + <https://msdn.microsoft.com/en-us/library/ms724847%28VS.85%29.aspx>`__. + + *key* is an already open key, or one of the predefined + :ref:`HKEY_* constants <hkey-constants>`. + + *sub_key* is a string that must be a subkey of the key identified by the + *key* parameter. This value must not be ``None``, and the key may not have + subkeys. + + *reserved* is a reserved integer, and must be zero. The default is zero. + + *access* is an integer that specifies an access mask that describes the desired + security access for the key. Default is :const:`KEY_WOW64_64KEY`. See + :ref:`Access Rights <access-rights>` for other allowed values. + + *This method can not delete keys with subkeys.* + + If the method succeeds, the entire key, including all of its values, is + removed. If the method fails, an :exc:`OSError` exception is raised. + + On unsupported Windows versions, :exc:`NotImplementedError` is raised. + + .. versionadded:: 3.2 + + .. versionchanged:: 3.3 + See :ref:`above <exception-changed>`. + + +.. function:: DeleteValue(key, value) + + Removes a named value from a registry key. + + *key* is an already open key, or one of the predefined + :ref:`HKEY_* constants <hkey-constants>`. + + *value* is a string that identifies the value to remove. + + +.. function:: EnumKey(key, index) + + Enumerates subkeys of an open registry key, returning a string. + + *key* is an already open key, or one of the predefined + :ref:`HKEY_* constants <hkey-constants>`. + + *index* is an integer that identifies the index of the key to retrieve. + + The function retrieves the name of one subkey each time it is called. It is + typically called repeatedly until an :exc:`OSError` exception is + raised, indicating, no more values are available. + + .. versionchanged:: 3.3 + See :ref:`above <exception-changed>`. + + +.. function:: EnumValue(key, index) + + Enumerates values of an open registry key, returning a tuple. + + *key* is an already open key, or one of the predefined + :ref:`HKEY_* constants <hkey-constants>`. + + *index* is an integer that identifies the index of the value to retrieve. + + The function retrieves the name of one subkey each time it is called. It is + typically called repeatedly, until an :exc:`OSError` exception is + raised, indicating no more values. + + The result is a tuple of 3 items: + + +-------+--------------------------------------------+ + | Index | Meaning | + +=======+============================================+ + | ``0`` | A string that identifies the value name | + +-------+--------------------------------------------+ + | ``1`` | An object that holds the value data, and | + | | whose type depends on the underlying | + | | registry type | + +-------+--------------------------------------------+ + | ``2`` | An integer that identifies the type of the | + | | value data (see table in docs for | + | | :meth:`SetValueEx`) | + +-------+--------------------------------------------+ + + .. versionchanged:: 3.3 + See :ref:`above <exception-changed>`. + + +.. index:: + single: % (percent); environment variables expansion (Windows) + +.. function:: ExpandEnvironmentStrings(str) + + Expands environment variable placeholders ``%NAME%`` in strings like + :const:`REG_EXPAND_SZ`:: + + >>> ExpandEnvironmentStrings('%windir%') + 'C:\\Windows' + + +.. function:: FlushKey(key) + + Writes all the attributes of a key to the registry. + + *key* is an already open key, or one of the predefined + :ref:`HKEY_* constants <hkey-constants>`. + + It is not necessary to call :func:`FlushKey` to change a key. Registry changes are + flushed to disk by the registry using its lazy flusher. Registry changes are + also flushed to disk at system shutdown. Unlike :func:`CloseKey`, the + :func:`FlushKey` method returns only when all the data has been written to the + registry. An application should only call :func:`FlushKey` if it requires + absolute certainty that registry changes are on disk. + + .. note:: + + If you don't know whether a :func:`FlushKey` call is required, it probably + isn't. + + +.. function:: LoadKey(key, sub_key, file_name) + + Creates a subkey under the specified key and stores registration information + from a specified file into that subkey. + + *key* is a handle returned by :func:`ConnectRegistry` or one of the constants + :const:`HKEY_USERS` or :const:`HKEY_LOCAL_MACHINE`. + + *sub_key* is a string that identifies the subkey to load. + + *file_name* is the name of the file to load registry data from. This file must + have been created with the :func:`SaveKey` function. Under the file allocation + table (FAT) file system, the filename may not have an extension. + + A call to :func:`LoadKey` fails if the calling process does not have the + :const:`SE_RESTORE_PRIVILEGE` privilege. Note that privileges are different + from permissions -- see the `RegLoadKey documentation + <https://msdn.microsoft.com/en-us/library/ms724889%28v=VS.85%29.aspx>`__ for + more details. + + If *key* is a handle returned by :func:`ConnectRegistry`, then the path + specified in *file_name* is relative to the remote computer. + + +.. function:: OpenKey(key, sub_key, reserved=0, access=KEY_READ) + OpenKeyEx(key, sub_key, reserved=0, access=KEY_READ) + + Opens the specified key, returning a :ref:`handle object <handle-object>`. + + *key* is an already open key, or one of the predefined + :ref:`HKEY_* constants <hkey-constants>`. + + *sub_key* is a string that identifies the sub_key to open. + + *reserved* is a reserved integer, and must be zero. The default is zero. + + *access* is an integer that specifies an access mask that describes the desired + security access for the key. Default is :const:`KEY_READ`. See :ref:`Access + Rights <access-rights>` for other allowed values. + + The result is a new handle to the specified key. + + If the function fails, :exc:`OSError` is raised. + + .. versionchanged:: 3.2 + Allow the use of named arguments. + + .. versionchanged:: 3.3 + See :ref:`above <exception-changed>`. + + +.. function:: QueryInfoKey(key) + + Returns information about a key, as a tuple. + + *key* is an already open key, or one of the predefined + :ref:`HKEY_* constants <hkey-constants>`. + + The result is a tuple of 3 items: + + +-------+---------------------------------------------+ + | Index | Meaning | + +=======+=============================================+ + | ``0`` | An integer giving the number of sub keys | + | | this key has. | + +-------+---------------------------------------------+ + | ``1`` | An integer giving the number of values this | + | | key has. | + +-------+---------------------------------------------+ + | ``2`` | An integer giving when the key was last | + | | modified (if available) as 100's of | + | | nanoseconds since Jan 1, 1601. | + +-------+---------------------------------------------+ + + +.. function:: QueryValue(key, sub_key) + + Retrieves the unnamed value for a key, as a string. + + *key* is an already open key, or one of the predefined + :ref:`HKEY_* constants <hkey-constants>`. + + *sub_key* is a string that holds the name of the subkey with which the value is + associated. If this parameter is ``None`` or empty, the function retrieves the + value set by the :func:`SetValue` method for the key identified by *key*. + + Values in the registry have name, type, and data components. This method + retrieves the data for a key's first value that has a NULL name. But the + underlying API call doesn't return the type, so always use + :func:`QueryValueEx` if possible. + + +.. function:: QueryValueEx(key, value_name) + + Retrieves the type and data for a specified value name associated with + an open registry key. + + *key* is an already open key, or one of the predefined + :ref:`HKEY_* constants <hkey-constants>`. + + *value_name* is a string indicating the value to query. + + The result is a tuple of 2 items: + + +-------+-----------------------------------------+ + | Index | Meaning | + +=======+=========================================+ + | ``0`` | The value of the registry item. | + +-------+-----------------------------------------+ + | ``1`` | An integer giving the registry type for | + | | this value (see table in docs for | + | | :meth:`SetValueEx`) | + +-------+-----------------------------------------+ + + +.. function:: SaveKey(key, file_name) + + Saves the specified key, and all its subkeys to the specified file. + + *key* is an already open key, or one of the predefined + :ref:`HKEY_* constants <hkey-constants>`. + + *file_name* is the name of the file to save registry data to. This file + cannot already exist. If this filename includes an extension, it cannot be + used on file allocation table (FAT) file systems by the :meth:`LoadKey` + method. + + If *key* represents a key on a remote computer, the path described by + *file_name* is relative to the remote computer. The caller of this method must + possess the :const:`SeBackupPrivilege` security privilege. Note that + privileges are different than permissions -- see the + `Conflicts Between User Rights and Permissions documentation + <https://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx>`__ + for more details. + + This function passes NULL for *security_attributes* to the API. + + +.. function:: SetValue(key, sub_key, type, value) + + Associates a value with a specified key. + + *key* is an already open key, or one of the predefined + :ref:`HKEY_* constants <hkey-constants>`. + + *sub_key* is a string that names the subkey with which the value is associated. + + *type* is an integer that specifies the type of the data. Currently this must be + :const:`REG_SZ`, meaning only strings are supported. Use the :func:`SetValueEx` + function for support for other data types. + + *value* is a string that specifies the new value. + + If the key specified by the *sub_key* parameter does not exist, the SetValue + function creates it. + + Value lengths are limited by available memory. Long values (more than 2048 + bytes) should be stored as files with the filenames stored in the configuration + registry. This helps the registry perform efficiently. + + The key identified by the *key* parameter must have been opened with + :const:`KEY_SET_VALUE` access. + + +.. function:: SetValueEx(key, value_name, reserved, type, value) + + Stores data in the value field of an open registry key. + + *key* is an already open key, or one of the predefined + :ref:`HKEY_* constants <hkey-constants>`. + + *value_name* is a string that names the subkey with which the value is + associated. + + *reserved* can be anything -- zero is always passed to the API. + + *type* is an integer that specifies the type of the data. See + :ref:`Value Types <value-types>` for the available types. + + *value* is a string that specifies the new value. + + This method can also set additional value and type information for the specified + key. The key identified by the key parameter must have been opened with + :const:`KEY_SET_VALUE` access. + + To open the key, use the :func:`CreateKey` or :func:`OpenKey` methods. + + Value lengths are limited by available memory. Long values (more than 2048 + bytes) should be stored as files with the filenames stored in the configuration + registry. This helps the registry perform efficiently. + + +.. function:: DisableReflectionKey(key) + + Disables registry reflection for 32-bit processes running on a 64-bit + operating system. + + *key* is an already open key, or one of the predefined :ref:`HKEY_* constants + <hkey-constants>`. + + Will generally raise :exc:`NotImplemented` if executed on a 32-bit operating + system. + + If the key is not on the reflection list, the function succeeds but has no + effect. Disabling reflection for a key does not affect reflection of any + subkeys. + + +.. function:: EnableReflectionKey(key) + + Restores registry reflection for the specified disabled key. + + *key* is an already open key, or one of the predefined :ref:`HKEY_* constants + <hkey-constants>`. + + Will generally raise :exc:`NotImplemented` if executed on a 32-bit operating + system. + + Restoring reflection for a key does not affect reflection of any subkeys. + + +.. function:: QueryReflectionKey(key) + + Determines the reflection state for the specified key. + + *key* is an already open key, or one of the predefined + :ref:`HKEY_* constants <hkey-constants>`. + + Returns ``True`` if reflection is disabled. + + Will generally raise :exc:`NotImplemented` if executed on a 32-bit + operating system. + + +.. _constants: + +Constants +------------------ + +The following constants are defined for use in many :mod:`_winreg` functions. + +.. _hkey-constants: + +HKEY_* Constants +++++++++++++++++ + +.. data:: HKEY_CLASSES_ROOT + + Registry entries subordinate to this key define types (or classes) of + documents and the properties associated with those types. Shell and + COM applications use the information stored under this key. + + +.. data:: HKEY_CURRENT_USER + + Registry entries subordinate to this key define the preferences of + the current user. These preferences include the settings of + environment variables, data about program groups, colors, printers, + network connections, and application preferences. + +.. data:: HKEY_LOCAL_MACHINE + + Registry entries subordinate to this key define the physical state + of the computer, including data about the bus type, system memory, + and installed hardware and software. + +.. data:: HKEY_USERS + + Registry entries subordinate to this key define the default user + configuration for new users on the local computer and the user + configuration for the current user. + +.. data:: HKEY_PERFORMANCE_DATA + + Registry entries subordinate to this key allow you to access + performance data. The data is not actually stored in the registry; + the registry functions cause the system to collect the data from + its source. + + +.. data:: HKEY_CURRENT_CONFIG + + Contains information about the current hardware profile of the + local computer system. + +.. data:: HKEY_DYN_DATA + + This key is not used in versions of Windows after 98. + + +.. _access-rights: + +Access Rights ++++++++++++++ + +For more information, see `Registry Key Security and Access +<https://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx>`__. + +.. data:: KEY_ALL_ACCESS + + Combines the STANDARD_RIGHTS_REQUIRED, :const:`KEY_QUERY_VALUE`, + :const:`KEY_SET_VALUE`, :const:`KEY_CREATE_SUB_KEY`, + :const:`KEY_ENUMERATE_SUB_KEYS`, :const:`KEY_NOTIFY`, + and :const:`KEY_CREATE_LINK` access rights. + +.. data:: KEY_WRITE + + Combines the STANDARD_RIGHTS_WRITE, :const:`KEY_SET_VALUE`, and + :const:`KEY_CREATE_SUB_KEY` access rights. + +.. data:: KEY_READ + + Combines the STANDARD_RIGHTS_READ, :const:`KEY_QUERY_VALUE`, + :const:`KEY_ENUMERATE_SUB_KEYS`, and :const:`KEY_NOTIFY` values. + +.. data:: KEY_EXECUTE + + Equivalent to :const:`KEY_READ`. + +.. data:: KEY_QUERY_VALUE + + Required to query the values of a registry key. + +.. data:: KEY_SET_VALUE + + Required to create, delete, or set a registry value. + +.. data:: KEY_CREATE_SUB_KEY + + Required to create a subkey of a registry key. + +.. data:: KEY_ENUMERATE_SUB_KEYS + + Required to enumerate the subkeys of a registry key. + +.. data:: KEY_NOTIFY + + Required to request change notifications for a registry key or for + subkeys of a registry key. + +.. data:: KEY_CREATE_LINK + + Reserved for system use. + + +.. _64-bit-access-rights: + +64-bit Specific +*************** + +For more information, see `Accessing an Alternate Registry View +<https://msdn.microsoft.com/en-us/library/aa384129(v=VS.85).aspx>`__. + +.. data:: KEY_WOW64_64KEY + + Indicates that an application on 64-bit Windows should operate on + the 64-bit registry view. + +.. data:: KEY_WOW64_32KEY + + Indicates that an application on 64-bit Windows should operate on + the 32-bit registry view. + + +.. _value-types: + +Value Types ++++++++++++ + +For more information, see `Registry Value Types +<https://msdn.microsoft.com/en-us/library/ms724884%28v=VS.85%29.aspx>`__. + +.. data:: REG_BINARY + + Binary data in any form. + +.. data:: REG_DWORD + + 32-bit number. + +.. data:: REG_DWORD_LITTLE_ENDIAN + + A 32-bit number in little-endian format. Equivalent to :const:`REG_DWORD`. + +.. data:: REG_DWORD_BIG_ENDIAN + + A 32-bit number in big-endian format. + +.. data:: REG_EXPAND_SZ + + Null-terminated string containing references to environment + variables (``%PATH%``). + +.. data:: REG_LINK + + A Unicode symbolic link. + +.. data:: REG_MULTI_SZ + + A sequence of null-terminated strings, terminated by two null characters. + (Python handles this termination automatically.) + +.. data:: REG_NONE + + No defined value type. + +.. data:: REG_QWORD + + A 64-bit number. + + .. versionadded:: 3.6 + +.. data:: REG_QWORD_LITTLE_ENDIAN + + A 64-bit number in little-endian format. Equivalent to :const:`REG_QWORD`. + + .. versionadded:: 3.6 + +.. data:: REG_RESOURCE_LIST + + A device-driver resource list. + +.. data:: REG_FULL_RESOURCE_DESCRIPTOR + + A hardware setting. + +.. data:: REG_RESOURCE_REQUIREMENTS_LIST + + A hardware resource list. + +.. data:: REG_SZ + + A null-terminated string. + + +.. _handle-object: + +Registry Handle Objects +----------------------- + +This object wraps a Windows HKEY object, automatically closing it when the +object is destroyed. To guarantee cleanup, you can call either the +:meth:`~PyHKEY.Close` method on the object, or the :func:`CloseKey` function. + +All registry functions in this module return one of these objects. + +All registry functions in this module which accept a handle object also accept +an integer, however, use of the handle object is encouraged. + +Handle objects provide semantics for :meth:`__bool__` -- thus :: + + if handle: + print("Yes") + +will print ``Yes`` if the handle is currently valid (has not been closed or +detached). + +The object also support comparison semantics, so handle objects will compare +true if they both reference the same underlying Windows handle value. + +Handle objects can be converted to an integer (e.g., using the built-in +:func:`int` function), in which case the underlying Windows handle value is +returned. You can also use the :meth:`~PyHKEY.Detach` method to return the +integer handle, and also disconnect the Windows handle from the handle object. + + +.. method:: PyHKEY.Close() + + Closes the underlying Windows handle. + + If the handle is already closed, no error is raised. + + +.. method:: PyHKEY.Detach() + + Detaches the Windows handle from the handle object. + + The result is an integer that holds the value of the handle before it is + detached. If the handle is already detached or closed, this will return + zero. + + After calling this function, the handle is effectively invalidated, but the + handle is not closed. You would call this function when you need the + underlying Win32 handle to exist beyond the lifetime of the handle object. + +.. method:: PyHKEY.__enter__() + PyHKEY.__exit__(\*exc_info) + + The HKEY object implements :meth:`~object.__enter__` and + :meth:`~object.__exit__` and thus supports the context protocol for the + :keyword:`with` statement:: + + with OpenKey(HKEY_LOCAL_MACHINE, "foo") as key: + ... # work with key + + will automatically close *key* when control leaves the :keyword:`with` block. + + diff --git a/python-3.7.4-docs-html/_sources/library/winsound.rst.txt b/python-3.7.4-docs-html/_sources/library/winsound.rst.txt new file mode 100644 index 0000000..372f792 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/winsound.rst.txt @@ -0,0 +1,161 @@ +:mod:`winsound` --- Sound-playing interface for Windows +======================================================= + +.. module:: winsound + :platform: Windows + :synopsis: Access to the sound-playing machinery for Windows. + +.. moduleauthor:: Toby Dickenson <htrd90@zepler.org> +.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> + +-------------- + +The :mod:`winsound` module provides access to the basic sound-playing machinery +provided by Windows platforms. It includes functions and several constants. + + +.. function:: Beep(frequency, duration) + + Beep the PC's speaker. The *frequency* parameter specifies frequency, in hertz, + of the sound, and must be in the range 37 through 32,767. The *duration* + parameter specifies the number of milliseconds the sound should last. If the + system is not able to beep the speaker, :exc:`RuntimeError` is raised. + + +.. function:: PlaySound(sound, flags) + + Call the underlying :c:func:`PlaySound` function from the Platform API. The + *sound* parameter may be a filename, a system sound alias, audio data as a + :term:`bytes-like object`, or ``None``. Its + interpretation depends on the value of *flags*, which can be a bitwise ORed + combination of the constants described below. If the *sound* parameter is + ``None``, any currently playing waveform sound is stopped. If the system + indicates an error, :exc:`RuntimeError` is raised. + + +.. function:: MessageBeep(type=MB_OK) + + Call the underlying :c:func:`MessageBeep` function from the Platform API. This + plays a sound as specified in the registry. The *type* argument specifies which + sound to play; possible values are ``-1``, ``MB_ICONASTERISK``, + ``MB_ICONEXCLAMATION``, ``MB_ICONHAND``, ``MB_ICONQUESTION``, and ``MB_OK``, all + described below. The value ``-1`` produces a "simple beep"; this is the final + fallback if a sound cannot be played otherwise. If the system indicates an + error, :exc:`RuntimeError` is raised. + + +.. data:: SND_FILENAME + + The *sound* parameter is the name of a WAV file. Do not use with + :const:`SND_ALIAS`. + + +.. data:: SND_ALIAS + + The *sound* parameter is a sound association name from the registry. If the + registry contains no such name, play the system default sound unless + :const:`SND_NODEFAULT` is also specified. If no default sound is registered, + raise :exc:`RuntimeError`. Do not use with :const:`SND_FILENAME`. + + All Win32 systems support at least the following; most systems support many + more: + + +--------------------------+----------------------------------------+ + | :func:`PlaySound` *name* | Corresponding Control Panel Sound name | + +==========================+========================================+ + | ``'SystemAsterisk'`` | Asterisk | + +--------------------------+----------------------------------------+ + | ``'SystemExclamation'`` | Exclamation | + +--------------------------+----------------------------------------+ + | ``'SystemExit'`` | Exit Windows | + +--------------------------+----------------------------------------+ + | ``'SystemHand'`` | Critical Stop | + +--------------------------+----------------------------------------+ + | ``'SystemQuestion'`` | Question | + +--------------------------+----------------------------------------+ + + For example:: + + import winsound + # Play Windows exit sound. + winsound.PlaySound("SystemExit", winsound.SND_ALIAS) + + # Probably play Windows default sound, if any is registered (because + # "*" probably isn't the registered name of any sound). + winsound.PlaySound("*", winsound.SND_ALIAS) + + +.. data:: SND_LOOP + + Play the sound repeatedly. The :const:`SND_ASYNC` flag must also be used to + avoid blocking. Cannot be used with :const:`SND_MEMORY`. + + +.. data:: SND_MEMORY + + The *sound* parameter to :func:`PlaySound` is a memory image of a WAV file, as a + :term:`bytes-like object`. + + .. note:: + + This module does not support playing from a memory image asynchronously, so a + combination of this flag and :const:`SND_ASYNC` will raise :exc:`RuntimeError`. + + +.. data:: SND_PURGE + + Stop playing all instances of the specified sound. + + .. note:: + + This flag is not supported on modern Windows platforms. + + +.. data:: SND_ASYNC + + Return immediately, allowing sounds to play asynchronously. + + +.. data:: SND_NODEFAULT + + If the specified sound cannot be found, do not play the system default sound. + + +.. data:: SND_NOSTOP + + Do not interrupt sounds currently playing. + + +.. data:: SND_NOWAIT + + Return immediately if the sound driver is busy. + + .. note:: + + This flag is not supported on modern Windows platforms. + + +.. data:: MB_ICONASTERISK + + Play the ``SystemDefault`` sound. + + +.. data:: MB_ICONEXCLAMATION + + Play the ``SystemExclamation`` sound. + + +.. data:: MB_ICONHAND + + Play the ``SystemHand`` sound. + + +.. data:: MB_ICONQUESTION + + Play the ``SystemQuestion`` sound. + + +.. data:: MB_OK + + Play the ``SystemDefault`` sound. + diff --git a/python-3.7.4-docs-html/_sources/library/wsgiref.rst.txt b/python-3.7.4-docs-html/_sources/library/wsgiref.rst.txt new file mode 100644 index 0000000..2d9b7b3 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/wsgiref.rst.txt @@ -0,0 +1,781 @@ +:mod:`wsgiref` --- WSGI Utilities and Reference Implementation +============================================================== + +.. module:: wsgiref + :synopsis: WSGI Utilities and Reference Implementation. + +.. moduleauthor:: Phillip J. Eby <pje@telecommunity.com> +.. sectionauthor:: Phillip J. Eby <pje@telecommunity.com> + +-------------- + +The Web Server Gateway Interface (WSGI) is a standard interface between web +server software and web applications written in Python. Having a standard +interface makes it easy to use an application that supports WSGI with a number +of different web servers. + +Only authors of web servers and programming frameworks need to know every detail +and corner case of the WSGI design. You don't need to understand every detail +of WSGI just to install a WSGI application or to write a web application using +an existing framework. + +:mod:`wsgiref` is a reference implementation of the WSGI specification that can +be used to add WSGI support to a web server or framework. It provides utilities +for manipulating WSGI environment variables and response headers, base classes +for implementing WSGI servers, a demo HTTP server that serves WSGI applications, +and a validation tool that checks WSGI servers and applications for conformance +to the WSGI specification (:pep:`3333`). + +See `wsgi.readthedocs.io <https://wsgi.readthedocs.io/>`_ for more information about WSGI, and links +to tutorials and other resources. + +.. XXX If you're just trying to write a web application... + + +:mod:`wsgiref.util` -- WSGI environment utilities +------------------------------------------------- + +.. module:: wsgiref.util + :synopsis: WSGI environment utilities. + + +This module provides a variety of utility functions for working with WSGI +environments. A WSGI environment is a dictionary containing HTTP request +variables as described in :pep:`3333`. All of the functions taking an *environ* +parameter expect a WSGI-compliant dictionary to be supplied; please see +:pep:`3333` for a detailed specification. + + +.. function:: guess_scheme(environ) + + Return a guess for whether ``wsgi.url_scheme`` should be "http" or "https", by + checking for a ``HTTPS`` environment variable in the *environ* dictionary. The + return value is a string. + + This function is useful when creating a gateway that wraps CGI or a CGI-like + protocol such as FastCGI. Typically, servers providing such protocols will + include a ``HTTPS`` variable with a value of "1" "yes", or "on" when a request + is received via SSL. So, this function returns "https" if such a value is + found, and "http" otherwise. + + +.. function:: request_uri(environ, include_query=True) + + Return the full request URI, optionally including the query string, using the + algorithm found in the "URL Reconstruction" section of :pep:`3333`. If + *include_query* is false, the query string is not included in the resulting URI. + + +.. function:: application_uri(environ) + + Similar to :func:`request_uri`, except that the ``PATH_INFO`` and + ``QUERY_STRING`` variables are ignored. The result is the base URI of the + application object addressed by the request. + + +.. function:: shift_path_info(environ) + + Shift a single name from ``PATH_INFO`` to ``SCRIPT_NAME`` and return the name. + The *environ* dictionary is *modified* in-place; use a copy if you need to keep + the original ``PATH_INFO`` or ``SCRIPT_NAME`` intact. + + If there are no remaining path segments in ``PATH_INFO``, ``None`` is returned. + + Typically, this routine is used to process each portion of a request URI path, + for example to treat the path as a series of dictionary keys. This routine + modifies the passed-in environment to make it suitable for invoking another WSGI + application that is located at the target URI. For example, if there is a WSGI + application at ``/foo``, and the request URI path is ``/foo/bar/baz``, and the + WSGI application at ``/foo`` calls :func:`shift_path_info`, it will receive the + string "bar", and the environment will be updated to be suitable for passing to + a WSGI application at ``/foo/bar``. That is, ``SCRIPT_NAME`` will change from + ``/foo`` to ``/foo/bar``, and ``PATH_INFO`` will change from ``/bar/baz`` to + ``/baz``. + + When ``PATH_INFO`` is just a "/", this routine returns an empty string and + appends a trailing slash to ``SCRIPT_NAME``, even though empty path segments are + normally ignored, and ``SCRIPT_NAME`` doesn't normally end in a slash. This is + intentional behavior, to ensure that an application can tell the difference + between URIs ending in ``/x`` from ones ending in ``/x/`` when using this + routine to do object traversal. + + +.. function:: setup_testing_defaults(environ) + + Update *environ* with trivial defaults for testing purposes. + + This routine adds various parameters required for WSGI, including ``HTTP_HOST``, + ``SERVER_NAME``, ``SERVER_PORT``, ``REQUEST_METHOD``, ``SCRIPT_NAME``, + ``PATH_INFO``, and all of the :pep:`3333`\ -defined ``wsgi.*`` variables. It + only supplies default values, and does not replace any existing settings for + these variables. + + This routine is intended to make it easier for unit tests of WSGI servers and + applications to set up dummy environments. It should NOT be used by actual WSGI + servers or applications, since the data is fake! + + Example usage:: + + from wsgiref.util import setup_testing_defaults + from wsgiref.simple_server import make_server + + # A relatively simple WSGI application. It's going to print out the + # environment dictionary after being updated by setup_testing_defaults + def simple_app(environ, start_response): + setup_testing_defaults(environ) + + status = '200 OK' + headers = [('Content-type', 'text/plain; charset=utf-8')] + + start_response(status, headers) + + ret = [("%s: %s\n" % (key, value)).encode("utf-8") + for key, value in environ.items()] + return ret + + with make_server('', 8000, simple_app) as httpd: + print("Serving on port 8000...") + httpd.serve_forever() + + +In addition to the environment functions above, the :mod:`wsgiref.util` module +also provides these miscellaneous utilities: + + +.. function:: is_hop_by_hop(header_name) + + Return true if 'header_name' is an HTTP/1.1 "Hop-by-Hop" header, as defined by + :rfc:`2616`. + + +.. class:: FileWrapper(filelike, blksize=8192) + + A wrapper to convert a file-like object to an :term:`iterator`. The resulting objects + support both :meth:`__getitem__` and :meth:`__iter__` iteration styles, for + compatibility with Python 2.1 and Jython. As the object is iterated over, the + optional *blksize* parameter will be repeatedly passed to the *filelike* + object's :meth:`read` method to obtain bytestrings to yield. When :meth:`read` + returns an empty bytestring, iteration is ended and is not resumable. + + If *filelike* has a :meth:`close` method, the returned object will also have a + :meth:`close` method, and it will invoke the *filelike* object's :meth:`close` + method when called. + + Example usage:: + + from io import StringIO + from wsgiref.util import FileWrapper + + # We're using a StringIO-buffer for as the file-like object + filelike = StringIO("This is an example file-like object"*10) + wrapper = FileWrapper(filelike, blksize=5) + + for chunk in wrapper: + print(chunk) + + + +:mod:`wsgiref.headers` -- WSGI response header tools +---------------------------------------------------- + +.. module:: wsgiref.headers + :synopsis: WSGI response header tools. + + +This module provides a single class, :class:`Headers`, for convenient +manipulation of WSGI response headers using a mapping-like interface. + + +.. class:: Headers([headers]) + + Create a mapping-like object wrapping *headers*, which must be a list of header + name/value tuples as described in :pep:`3333`. The default value of *headers* is + an empty list. + + :class:`Headers` objects support typical mapping operations including + :meth:`__getitem__`, :meth:`get`, :meth:`__setitem__`, :meth:`setdefault`, + :meth:`__delitem__` and :meth:`__contains__`. For each of + these methods, the key is the header name (treated case-insensitively), and the + value is the first value associated with that header name. Setting a header + deletes any existing values for that header, then adds a new value at the end of + the wrapped header list. Headers' existing order is generally maintained, with + new headers added to the end of the wrapped list. + + Unlike a dictionary, :class:`Headers` objects do not raise an error when you try + to get or delete a key that isn't in the wrapped header list. Getting a + nonexistent header just returns ``None``, and deleting a nonexistent header does + nothing. + + :class:`Headers` objects also support :meth:`keys`, :meth:`values`, and + :meth:`items` methods. The lists returned by :meth:`keys` and :meth:`items` can + include the same key more than once if there is a multi-valued header. The + ``len()`` of a :class:`Headers` object is the same as the length of its + :meth:`items`, which is the same as the length of the wrapped header list. In + fact, the :meth:`items` method just returns a copy of the wrapped header list. + + Calling ``bytes()`` on a :class:`Headers` object returns a formatted bytestring + suitable for transmission as HTTP response headers. Each header is placed on a + line with its value, separated by a colon and a space. Each line is terminated + by a carriage return and line feed, and the bytestring is terminated with a + blank line. + + In addition to their mapping interface and formatting features, :class:`Headers` + objects also have the following methods for querying and adding multi-valued + headers, and for adding headers with MIME parameters: + + + .. method:: Headers.get_all(name) + + Return a list of all the values for the named header. + + The returned list will be sorted in the order they appeared in the original + header list or were added to this instance, and may contain duplicates. Any + fields deleted and re-inserted are always appended to the header list. If no + fields exist with the given name, returns an empty list. + + + .. method:: Headers.add_header(name, value, **_params) + + Add a (possibly multi-valued) header, with optional MIME parameters specified + via keyword arguments. + + *name* is the header field to add. Keyword arguments can be used to set MIME + parameters for the header field. Each parameter must be a string or ``None``. + Underscores in parameter names are converted to dashes, since dashes are illegal + in Python identifiers, but many MIME parameter names include dashes. If the + parameter value is a string, it is added to the header value parameters in the + form ``name="value"``. If it is ``None``, only the parameter name is added. + (This is used for MIME parameters without a value.) Example usage:: + + h.add_header('content-disposition', 'attachment', filename='bud.gif') + + The above will add a header that looks like this:: + + Content-Disposition: attachment; filename="bud.gif" + + + .. versionchanged:: 3.5 + *headers* parameter is optional. + + +:mod:`wsgiref.simple_server` -- a simple WSGI HTTP server +--------------------------------------------------------- + +.. module:: wsgiref.simple_server + :synopsis: A simple WSGI HTTP server. + + +This module implements a simple HTTP server (based on :mod:`http.server`) +that serves WSGI applications. Each server instance serves a single WSGI +application on a given host and port. If you want to serve multiple +applications on a single host and port, you should create a WSGI application +that parses ``PATH_INFO`` to select which application to invoke for each +request. (E.g., using the :func:`shift_path_info` function from +:mod:`wsgiref.util`.) + + +.. function:: make_server(host, port, app, server_class=WSGIServer, handler_class=WSGIRequestHandler) + + Create a new WSGI server listening on *host* and *port*, accepting connections + for *app*. The return value is an instance of the supplied *server_class*, and + will process requests using the specified *handler_class*. *app* must be a WSGI + application object, as defined by :pep:`3333`. + + Example usage:: + + from wsgiref.simple_server import make_server, demo_app + + with make_server('', 8000, demo_app) as httpd: + print("Serving HTTP on port 8000...") + + # Respond to requests until process is killed + httpd.serve_forever() + + # Alternative: serve one request, then exit + httpd.handle_request() + + +.. function:: demo_app(environ, start_response) + + This function is a small but complete WSGI application that returns a text page + containing the message "Hello world!" and a list of the key/value pairs provided + in the *environ* parameter. It's useful for verifying that a WSGI server (such + as :mod:`wsgiref.simple_server`) is able to run a simple WSGI application + correctly. + + +.. class:: WSGIServer(server_address, RequestHandlerClass) + + Create a :class:`WSGIServer` instance. *server_address* should be a + ``(host,port)`` tuple, and *RequestHandlerClass* should be the subclass of + :class:`http.server.BaseHTTPRequestHandler` that will be used to process + requests. + + You do not normally need to call this constructor, as the :func:`make_server` + function can handle all the details for you. + + :class:`WSGIServer` is a subclass of :class:`http.server.HTTPServer`, so all + of its methods (such as :meth:`serve_forever` and :meth:`handle_request`) are + available. :class:`WSGIServer` also provides these WSGI-specific methods: + + + .. method:: WSGIServer.set_app(application) + + Sets the callable *application* as the WSGI application that will receive + requests. + + + .. method:: WSGIServer.get_app() + + Returns the currently-set application callable. + + Normally, however, you do not need to use these additional methods, as + :meth:`set_app` is normally called by :func:`make_server`, and the + :meth:`get_app` exists mainly for the benefit of request handler instances. + + +.. class:: WSGIRequestHandler(request, client_address, server) + + Create an HTTP handler for the given *request* (i.e. a socket), *client_address* + (a ``(host,port)`` tuple), and *server* (:class:`WSGIServer` instance). + + You do not need to create instances of this class directly; they are + automatically created as needed by :class:`WSGIServer` objects. You can, + however, subclass this class and supply it as a *handler_class* to the + :func:`make_server` function. Some possibly relevant methods for overriding in + subclasses: + + + .. method:: WSGIRequestHandler.get_environ() + + Returns a dictionary containing the WSGI environment for a request. The default + implementation copies the contents of the :class:`WSGIServer` object's + :attr:`base_environ` dictionary attribute and then adds various headers derived + from the HTTP request. Each call to this method should return a new dictionary + containing all of the relevant CGI environment variables as specified in + :pep:`3333`. + + + .. method:: WSGIRequestHandler.get_stderr() + + Return the object that should be used as the ``wsgi.errors`` stream. The default + implementation just returns ``sys.stderr``. + + + .. method:: WSGIRequestHandler.handle() + + Process the HTTP request. The default implementation creates a handler instance + using a :mod:`wsgiref.handlers` class to implement the actual WSGI application + interface. + + +:mod:`wsgiref.validate` --- WSGI conformance checker +---------------------------------------------------- + +.. module:: wsgiref.validate + :synopsis: WSGI conformance checker. + + +When creating new WSGI application objects, frameworks, servers, or middleware, +it can be useful to validate the new code's conformance using +:mod:`wsgiref.validate`. This module provides a function that creates WSGI +application objects that validate communications between a WSGI server or +gateway and a WSGI application object, to check both sides for protocol +conformance. + +Note that this utility does not guarantee complete :pep:`3333` compliance; an +absence of errors from this module does not necessarily mean that errors do not +exist. However, if this module does produce an error, then it is virtually +certain that either the server or application is not 100% compliant. + +This module is based on the :mod:`paste.lint` module from Ian Bicking's "Python +Paste" library. + + +.. function:: validator(application) + + Wrap *application* and return a new WSGI application object. The returned + application will forward all requests to the original *application*, and will + check that both the *application* and the server invoking it are conforming to + the WSGI specification and to :rfc:`2616`. + + Any detected nonconformance results in an :exc:`AssertionError` being raised; + note, however, that how these errors are handled is server-dependent. For + example, :mod:`wsgiref.simple_server` and other servers based on + :mod:`wsgiref.handlers` (that don't override the error handling methods to do + something else) will simply output a message that an error has occurred, and + dump the traceback to ``sys.stderr`` or some other error stream. + + This wrapper may also generate output using the :mod:`warnings` module to + indicate behaviors that are questionable but which may not actually be + prohibited by :pep:`3333`. Unless they are suppressed using Python command-line + options or the :mod:`warnings` API, any such warnings will be written to + ``sys.stderr`` (*not* ``wsgi.errors``, unless they happen to be the same + object). + + Example usage:: + + from wsgiref.validate import validator + from wsgiref.simple_server import make_server + + # 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 + start_response(status, headers) + + # This is going to break because we need to return a list, and + # the validator is going to inform us + return b"Hello World" + + # This is the application wrapped in a validator + validator_app = validator(simple_app) + + with make_server('', 8000, validator_app) as httpd: + print("Listening on port 8000....") + httpd.serve_forever() + + +:mod:`wsgiref.handlers` -- server/gateway base classes +------------------------------------------------------ + +.. module:: wsgiref.handlers + :synopsis: WSGI server/gateway base classes. + + +This module provides base handler classes for implementing WSGI servers and +gateways. These base classes handle most of the work of communicating with a +WSGI application, as long as they are given a CGI-like environment, along with +input, output, and error streams. + + +.. class:: CGIHandler() + + CGI-based invocation via ``sys.stdin``, ``sys.stdout``, ``sys.stderr`` and + ``os.environ``. This is useful when you have a WSGI application and want to run + it as a CGI script. Simply invoke ``CGIHandler().run(app)``, where ``app`` is + the WSGI application object you wish to invoke. + + This class is a subclass of :class:`BaseCGIHandler` that sets ``wsgi.run_once`` + to true, ``wsgi.multithread`` to false, and ``wsgi.multiprocess`` to true, and + always uses :mod:`sys` and :mod:`os` to obtain the necessary CGI streams and + environment. + + +.. class:: IISCGIHandler() + + A specialized alternative to :class:`CGIHandler`, for use when deploying on + Microsoft's IIS web server, without having set the config allowPathInfo + option (IIS>=7) or metabase allowPathInfoForScriptMappings (IIS<7). + + By default, IIS gives a ``PATH_INFO`` that duplicates the ``SCRIPT_NAME`` at + the front, causing problems for WSGI applications that wish to implement + routing. This handler strips any such duplicated path. + + IIS can be configured to pass the correct ``PATH_INFO``, but this causes + another bug where ``PATH_TRANSLATED`` is wrong. Luckily this variable is + rarely used and is not guaranteed by WSGI. On IIS<7, though, the + setting can only be made on a vhost level, affecting all other script + mappings, many of which break when exposed to the ``PATH_TRANSLATED`` bug. + For this reason IIS<7 is almost never deployed with the fix. (Even IIS7 + rarely uses it because there is still no UI for it.) + + There is no way for CGI code to tell whether the option was set, so a + separate handler class is provided. It is used in the same way as + :class:`CGIHandler`, i.e., by calling ``IISCGIHandler().run(app)``, where + ``app`` is the WSGI application object you wish to invoke. + + .. versionadded:: 3.2 + + +.. class:: BaseCGIHandler(stdin, stdout, stderr, environ, multithread=True, multiprocess=False) + + Similar to :class:`CGIHandler`, but instead of using the :mod:`sys` and + :mod:`os` modules, the CGI environment and I/O streams are specified explicitly. + The *multithread* and *multiprocess* values are used to set the + ``wsgi.multithread`` and ``wsgi.multiprocess`` flags for any applications run by + the handler instance. + + This class is a subclass of :class:`SimpleHandler` intended for use with + software other than HTTP "origin servers". If you are writing a gateway + protocol implementation (such as CGI, FastCGI, SCGI, etc.) that uses a + ``Status:`` header to send an HTTP status, you probably want to subclass this + instead of :class:`SimpleHandler`. + + +.. class:: SimpleHandler(stdin, stdout, stderr, environ, multithread=True, multiprocess=False) + + Similar to :class:`BaseCGIHandler`, but designed for use with HTTP origin + servers. If you are writing an HTTP server implementation, you will probably + want to subclass this instead of :class:`BaseCGIHandler`. + + This class is a subclass of :class:`BaseHandler`. It overrides the + :meth:`__init__`, :meth:`get_stdin`, :meth:`get_stderr`, :meth:`add_cgi_vars`, + :meth:`_write`, and :meth:`_flush` methods to support explicitly setting the + environment and streams via the constructor. The supplied environment and + streams are stored in the :attr:`stdin`, :attr:`stdout`, :attr:`stderr`, and + :attr:`environ` attributes. + + The :meth:`~io.BufferedIOBase.write` method of *stdout* should write + each chunk in full, like :class:`io.BufferedIOBase`. + + +.. class:: BaseHandler() + + This is an abstract base class for running WSGI applications. Each instance + will handle a single HTTP request, although in principle you could create a + subclass that was reusable for multiple requests. + + :class:`BaseHandler` instances have only one method intended for external use: + + + .. method:: BaseHandler.run(app) + + Run the specified WSGI application, *app*. + + All of the other :class:`BaseHandler` methods are invoked by this method in the + process of running the application, and thus exist primarily to allow + customizing the process. + + The following methods MUST be overridden in a subclass: + + + .. method:: BaseHandler._write(data) + + Buffer the bytes *data* for transmission to the client. It's okay if this + method actually transmits the data; :class:`BaseHandler` just separates write + and flush operations for greater efficiency when the underlying system actually + has such a distinction. + + + .. method:: BaseHandler._flush() + + Force buffered data to be transmitted to the client. It's okay if this method + is a no-op (i.e., if :meth:`_write` actually sends the data). + + + .. method:: BaseHandler.get_stdin() + + Return an input stream object suitable for use as the ``wsgi.input`` of the + request currently being processed. + + + .. method:: BaseHandler.get_stderr() + + Return an output stream object suitable for use as the ``wsgi.errors`` of the + request currently being processed. + + + .. method:: BaseHandler.add_cgi_vars() + + Insert CGI variables for the current request into the :attr:`environ` attribute. + + Here are some other methods and attributes you may wish to override. This list + is only a summary, however, and does not include every method that can be + overridden. You should consult the docstrings and source code for additional + information before attempting to create a customized :class:`BaseHandler` + subclass. + + Attributes and methods for customizing the WSGI environment: + + + .. attribute:: BaseHandler.wsgi_multithread + + The value to be used for the ``wsgi.multithread`` environment variable. It + defaults to true in :class:`BaseHandler`, but may have a different default (or + be set by the constructor) in the other subclasses. + + + .. attribute:: BaseHandler.wsgi_multiprocess + + The value to be used for the ``wsgi.multiprocess`` environment variable. It + defaults to true in :class:`BaseHandler`, but may have a different default (or + be set by the constructor) in the other subclasses. + + + .. attribute:: BaseHandler.wsgi_run_once + + The value to be used for the ``wsgi.run_once`` environment variable. It + defaults to false in :class:`BaseHandler`, but :class:`CGIHandler` sets it to + true by default. + + + .. attribute:: BaseHandler.os_environ + + The default environment variables to be included in every request's WSGI + environment. By default, this is a copy of ``os.environ`` at the time that + :mod:`wsgiref.handlers` was imported, but subclasses can either create their own + at the class or instance level. Note that the dictionary should be considered + read-only, since the default value is shared between multiple classes and + instances. + + + .. attribute:: BaseHandler.server_software + + If the :attr:`origin_server` attribute is set, this attribute's value is used to + set the default ``SERVER_SOFTWARE`` WSGI environment variable, and also to set a + default ``Server:`` header in HTTP responses. It is ignored for handlers (such + as :class:`BaseCGIHandler` and :class:`CGIHandler`) that are not HTTP origin + servers. + + .. versionchanged:: 3.3 + The term "Python" is replaced with implementation specific term like + "CPython", "Jython" etc. + + .. method:: BaseHandler.get_scheme() + + Return the URL scheme being used for the current request. The default + implementation uses the :func:`guess_scheme` function from :mod:`wsgiref.util` + to guess whether the scheme should be "http" or "https", based on the current + request's :attr:`environ` variables. + + + .. method:: BaseHandler.setup_environ() + + Set the :attr:`environ` attribute to a fully-populated WSGI environment. The + default implementation uses all of the above methods and attributes, plus the + :meth:`get_stdin`, :meth:`get_stderr`, and :meth:`add_cgi_vars` methods and the + :attr:`wsgi_file_wrapper` attribute. It also inserts a ``SERVER_SOFTWARE`` key + if not present, as long as the :attr:`origin_server` attribute is a true value + and the :attr:`server_software` attribute is set. + + Methods and attributes for customizing exception handling: + + + .. method:: BaseHandler.log_exception(exc_info) + + Log the *exc_info* tuple in the server log. *exc_info* is a ``(type, value, + traceback)`` tuple. The default implementation simply writes the traceback to + the request's ``wsgi.errors`` stream and flushes it. Subclasses can override + this method to change the format or retarget the output, mail the traceback to + an administrator, or whatever other action may be deemed suitable. + + + .. attribute:: BaseHandler.traceback_limit + + The maximum number of frames to include in tracebacks output by the default + :meth:`log_exception` method. If ``None``, all frames are included. + + + .. method:: BaseHandler.error_output(environ, start_response) + + This method is a WSGI application to generate an error page for the user. It is + only invoked if an error occurs before headers are sent to the client. + + This method can access the current error information using ``sys.exc_info()``, + and should pass that information to *start_response* when calling it (as + described in the "Error Handling" section of :pep:`3333`). + + The default implementation just uses the :attr:`error_status`, + :attr:`error_headers`, and :attr:`error_body` attributes to generate an output + page. Subclasses can override this to produce more dynamic error output. + + Note, however, that it's not recommended from a security perspective to spit out + diagnostics to any old user; ideally, you should have to do something special to + enable diagnostic output, which is why the default implementation doesn't + include any. + + + .. attribute:: BaseHandler.error_status + + The HTTP status used for error responses. This should be a status string as + defined in :pep:`3333`; it defaults to a 500 code and message. + + + .. attribute:: BaseHandler.error_headers + + The HTTP headers used for error responses. This should be a list of WSGI + response headers (``(name, value)`` tuples), as described in :pep:`3333`. The + default list just sets the content type to ``text/plain``. + + + .. attribute:: BaseHandler.error_body + + The error response body. This should be an HTTP response body bytestring. It + defaults to the plain text, "A server error occurred. Please contact the + administrator." + + Methods and attributes for :pep:`3333`'s "Optional Platform-Specific File + Handling" feature: + + + .. attribute:: BaseHandler.wsgi_file_wrapper + + A ``wsgi.file_wrapper`` factory, or ``None``. The default value of this + attribute is the :class:`wsgiref.util.FileWrapper` class. + + + .. method:: BaseHandler.sendfile() + + Override to implement platform-specific file transmission. This method is + called only if the application's return value is an instance of the class + specified by the :attr:`wsgi_file_wrapper` attribute. It should return a true + value if it was able to successfully transmit the file, so that the default + transmission code will not be executed. The default implementation of this + method just returns a false value. + + Miscellaneous methods and attributes: + + + .. attribute:: BaseHandler.origin_server + + This attribute should be set to a true value if the handler's :meth:`_write` and + :meth:`_flush` are being used to communicate directly to the client, rather than + via a CGI-like gateway protocol that wants the HTTP status in a special + ``Status:`` header. + + This attribute's default value is true in :class:`BaseHandler`, but false in + :class:`BaseCGIHandler` and :class:`CGIHandler`. + + + .. attribute:: BaseHandler.http_version + + If :attr:`origin_server` is true, this string attribute is used to set the HTTP + version of the response set to the client. It defaults to ``"1.0"``. + + +.. function:: read_environ() + + Transcode CGI variables from ``os.environ`` to PEP 3333 "bytes in unicode" + strings, returning a new dictionary. This function is used by + :class:`CGIHandler` and :class:`IISCGIHandler` in place of directly using + ``os.environ``, which is not necessarily WSGI-compliant on all platforms + and web servers using Python 3 -- specifically, ones where the OS's + actual environment is Unicode (i.e. Windows), or ones where the environment + is bytes, but the system encoding used by Python to decode it is anything + other than ISO-8859-1 (e.g. Unix systems using UTF-8). + + If you are implementing a CGI-based handler of your own, you probably want + to use this routine instead of just copying values out of ``os.environ`` + directly. + + .. versionadded:: 3.2 + + +Examples +-------- + +This is a working "Hello World" WSGI application:: + + from wsgiref.simple_server import make_server + + # Every WSGI application must have an application object - a callable + # object that accepts two arguments. For that purpose, we're going to + # use a function (note that you're not limited to a function, you can + # use a class for example). The first argument passed to the function + # 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 + start_response(status, headers) + + # The returned object is going to be printed + return [b"Hello World"] + + with make_server('', 8000, hello_world_app) as httpd: + print("Serving on port 8000...") + + # Serve until process is killed + httpd.serve_forever() diff --git a/python-3.7.4-docs-html/_sources/library/xdrlib.rst.txt b/python-3.7.4-docs-html/_sources/library/xdrlib.rst.txt new file mode 100644 index 0000000..42a03a4 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/xdrlib.rst.txt @@ -0,0 +1,278 @@ +:mod:`xdrlib` --- Encode and decode XDR data +============================================ + +.. module:: xdrlib + :synopsis: Encoders and decoders for the External Data Representation (XDR). + +**Source code:** :source:`Lib/xdrlib.py` + +.. index:: + single: XDR + single: External Data Representation + +-------------- + +The :mod:`xdrlib` module supports the External Data Representation Standard as +described in :rfc:`1014`, written by Sun Microsystems, Inc. June 1987. It +supports most of the data types described in the RFC. + +The :mod:`xdrlib` module defines two classes, one for packing variables into XDR +representation, and another for unpacking from XDR representation. There are +also two exception classes. + + +.. class:: Packer() + + :class:`Packer` is the class for packing data into XDR representation. The + :class:`Packer` class is instantiated with no arguments. + + +.. class:: Unpacker(data) + + ``Unpacker`` is the complementary class which unpacks XDR data values from a + string buffer. The input buffer is given as *data*. + + +.. seealso:: + + :rfc:`1014` - XDR: External Data Representation Standard + This RFC defined the encoding of data which was XDR at the time this module was + originally written. It has apparently been obsoleted by :rfc:`1832`. + + :rfc:`1832` - XDR: External Data Representation Standard + Newer RFC that provides a revised definition of XDR. + + +.. _xdr-packer-objects: + +Packer Objects +-------------- + +:class:`Packer` instances have the following methods: + + +.. method:: Packer.get_buffer() + + Returns the current pack buffer as a string. + + +.. method:: Packer.reset() + + Resets the pack buffer to the empty string. + +In general, you can pack any of the most common XDR data types by calling the +appropriate ``pack_type()`` method. Each method takes a single argument, the +value to pack. The following simple data type packing methods are supported: +:meth:`pack_uint`, :meth:`pack_int`, :meth:`pack_enum`, :meth:`pack_bool`, +:meth:`pack_uhyper`, and :meth:`pack_hyper`. + + +.. method:: Packer.pack_float(value) + + Packs the single-precision floating point number *value*. + + +.. method:: Packer.pack_double(value) + + Packs the double-precision floating point number *value*. + +The following methods support packing strings, bytes, and opaque data: + + +.. method:: Packer.pack_fstring(n, s) + + Packs a fixed length string, *s*. *n* is the length of the string but it is + *not* packed into the data buffer. The string is padded with null bytes if + necessary to guaranteed 4 byte alignment. + + +.. method:: Packer.pack_fopaque(n, data) + + Packs a fixed length opaque data stream, similarly to :meth:`pack_fstring`. + + +.. method:: Packer.pack_string(s) + + Packs a variable length string, *s*. The length of the string is first packed + as an unsigned integer, then the string data is packed with + :meth:`pack_fstring`. + + +.. method:: Packer.pack_opaque(data) + + Packs a variable length opaque data string, similarly to :meth:`pack_string`. + + +.. method:: Packer.pack_bytes(bytes) + + Packs a variable length byte stream, similarly to :meth:`pack_string`. + +The following methods support packing arrays and lists: + + +.. method:: Packer.pack_list(list, pack_item) + + Packs a *list* of homogeneous items. This method is useful for lists with an + indeterminate size; i.e. the size is not available until the entire list has + been walked. For each item in the list, an unsigned integer ``1`` is packed + first, followed by the data value from the list. *pack_item* is the function + that is called to pack the individual item. At the end of the list, an unsigned + integer ``0`` is packed. + + For example, to pack a list of integers, the code might appear like this:: + + import xdrlib + p = xdrlib.Packer() + p.pack_list([1, 2, 3], p.pack_int) + + +.. method:: Packer.pack_farray(n, array, pack_item) + + Packs a fixed length list (*array*) of homogeneous items. *n* is the length of + the list; it is *not* packed into the buffer, but a :exc:`ValueError` exception + is raised if ``len(array)`` is not equal to *n*. As above, *pack_item* is the + function used to pack each element. + + +.. method:: Packer.pack_array(list, pack_item) + + Packs a variable length *list* of homogeneous items. First, the length of the + list is packed as an unsigned integer, then each element is packed as in + :meth:`pack_farray` above. + + +.. _xdr-unpacker-objects: + +Unpacker Objects +---------------- + +The :class:`Unpacker` class offers the following methods: + + +.. method:: Unpacker.reset(data) + + Resets the string buffer with the given *data*. + + +.. method:: Unpacker.get_position() + + Returns the current unpack position in the data buffer. + + +.. method:: Unpacker.set_position(position) + + Sets the data buffer unpack position to *position*. You should be careful about + using :meth:`get_position` and :meth:`set_position`. + + +.. method:: Unpacker.get_buffer() + + Returns the current unpack data buffer as a string. + + +.. method:: Unpacker.done() + + Indicates unpack completion. Raises an :exc:`Error` exception if all of the + data has not been unpacked. + +In addition, every data type that can be packed with a :class:`Packer`, can be +unpacked with an :class:`Unpacker`. Unpacking methods are of the form +``unpack_type()``, and take no arguments. They return the unpacked object. + + +.. method:: Unpacker.unpack_float() + + Unpacks a single-precision floating point number. + + +.. method:: Unpacker.unpack_double() + + Unpacks a double-precision floating point number, similarly to + :meth:`unpack_float`. + +In addition, the following methods unpack strings, bytes, and opaque data: + + +.. method:: Unpacker.unpack_fstring(n) + + Unpacks and returns a fixed length string. *n* is the number of characters + expected. Padding with null bytes to guaranteed 4 byte alignment is assumed. + + +.. method:: Unpacker.unpack_fopaque(n) + + Unpacks and returns a fixed length opaque data stream, similarly to + :meth:`unpack_fstring`. + + +.. method:: Unpacker.unpack_string() + + Unpacks and returns a variable length string. The length of the string is first + unpacked as an unsigned integer, then the string data is unpacked with + :meth:`unpack_fstring`. + + +.. method:: Unpacker.unpack_opaque() + + Unpacks and returns a variable length opaque data string, similarly to + :meth:`unpack_string`. + + +.. method:: Unpacker.unpack_bytes() + + Unpacks and returns a variable length byte stream, similarly to + :meth:`unpack_string`. + +The following methods support unpacking arrays and lists: + + +.. method:: Unpacker.unpack_list(unpack_item) + + Unpacks and returns a list of homogeneous items. The list is unpacked one + element at a time by first unpacking an unsigned integer flag. If the flag is + ``1``, then the item is unpacked and appended to the list. A flag of ``0`` + indicates the end of the list. *unpack_item* is the function that is called to + unpack the items. + + +.. method:: Unpacker.unpack_farray(n, unpack_item) + + Unpacks and returns (as a list) a fixed length array of homogeneous items. *n* + is number of list elements to expect in the buffer. As above, *unpack_item* is + the function used to unpack each element. + + +.. method:: Unpacker.unpack_array(unpack_item) + + Unpacks and returns a variable length *list* of homogeneous items. First, the + length of the list is unpacked as an unsigned integer, then each element is + unpacked as in :meth:`unpack_farray` above. + + +.. _xdr-exceptions: + +Exceptions +---------- + +Exceptions in this module are coded as class instances: + + +.. exception:: Error + + The base exception class. :exc:`Error` has a single public attribute + :attr:`msg` containing the description of the error. + + +.. exception:: ConversionError + + Class derived from :exc:`Error`. Contains no additional instance variables. + +Here is an example of how you would catch one of these exceptions:: + + import xdrlib + p = xdrlib.Packer() + try: + p.pack_double(8.01) + except xdrlib.ConversionError as instance: + print('packing the double failed:', instance.msg) + diff --git a/python-3.7.4-docs-html/_sources/library/xml.dom.minidom.rst.txt b/python-3.7.4-docs-html/_sources/library/xml.dom.minidom.rst.txt new file mode 100644 index 0000000..c68b037 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/xml.dom.minidom.rst.txt @@ -0,0 +1,243 @@ +:mod:`xml.dom.minidom` --- Minimal DOM implementation +===================================================== + +.. module:: xml.dom.minidom + :synopsis: Minimal Document Object Model (DOM) implementation. + +.. moduleauthor:: Paul Prescod <paul@prescod.net> +.. sectionauthor:: Paul Prescod <paul@prescod.net> +.. sectionauthor:: Martin v. Löwis <martin@v.loewis.de> + +**Source code:** :source:`Lib/xml/dom/minidom.py` + +-------------- + +:mod:`xml.dom.minidom` is a minimal implementation of the Document Object +Model interface, with an API similar to that in other languages. It is intended +to be simpler than the full DOM and also significantly smaller. Users who are +not already proficient with the DOM should consider using the +:mod:`xml.etree.ElementTree` module for their XML processing instead. + + +.. warning:: + + The :mod:`xml.dom.minidom` module is not secure against + maliciously constructed data. If you need to parse untrusted or + unauthenticated data see :ref:`xml-vulnerabilities`. + + +DOM applications typically start by parsing some XML into a DOM. With +:mod:`xml.dom.minidom`, this is done through the parse functions:: + + from xml.dom.minidom import parse, parseString + + 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 + + dom3 = parseString('<myxml>Some data<empty/> some more data</myxml>') + +The :func:`parse` function can take either a filename or an open file object. + + +.. function:: parse(filename_or_file, parser=None, bufsize=None) + + Return a :class:`Document` from the given input. *filename_or_file* may be + either a file name, or a file-like object. *parser*, if given, must be a SAX2 + parser object. This function will change the document handler of the parser and + activate namespace support; other parser configuration (like setting an entity + resolver) must have been done in advance. + +If you have XML in a string, you can use the :func:`parseString` function +instead: + + +.. function:: parseString(string, parser=None) + + Return a :class:`Document` that represents the *string*. This method creates an + :class:`io.StringIO` object for the string and passes that on to :func:`parse`. + +Both functions return a :class:`Document` object representing the content of the +document. + +What the :func:`parse` and :func:`parseString` functions do is connect an XML +parser with a "DOM builder" that can accept parse events from any SAX parser and +convert them into a DOM tree. The name of the functions are perhaps misleading, +but are easy to grasp when learning the interfaces. The parsing of the document +will be completed before these functions return; it's simply that these +functions do not provide a parser implementation themselves. + +You can also create a :class:`Document` by calling a method on a "DOM +Implementation" object. You can get this object either by calling the +:func:`getDOMImplementation` function in the :mod:`xml.dom` package or the +:mod:`xml.dom.minidom` module. Once you have a :class:`Document`, you +can add child nodes to it to populate the DOM:: + + from xml.dom.minidom import getDOMImplementation + + impl = getDOMImplementation() + + newdoc = impl.createDocument(None, "some_tag", None) + top_element = newdoc.documentElement + text = newdoc.createTextNode('Some textual content.') + top_element.appendChild(text) + +Once you have a DOM document object, you can access the parts of your XML +document through its properties and methods. These properties are defined in +the DOM specification. The main property of the document object is the +:attr:`documentElement` property. It gives you the main element in the XML +document: the one that holds all others. Here is an example program:: + + dom3 = parseString("<myxml>Some data</myxml>") + assert dom3.documentElement.tagName == "myxml" + +When you are finished with a DOM tree, you may optionally call the +:meth:`unlink` method to encourage early cleanup of the now-unneeded +objects. :meth:`unlink` is an :mod:`xml.dom.minidom`\ -specific +extension to the DOM API that renders the node and its descendants are +essentially useless. Otherwise, Python's garbage collector will +eventually take care of the objects in the tree. + +.. seealso:: + + `Document Object Model (DOM) Level 1 Specification <https://www.w3.org/TR/REC-DOM-Level-1/>`_ + The W3C recommendation for the DOM supported by :mod:`xml.dom.minidom`. + + +.. _minidom-objects: + +DOM Objects +----------- + +The definition of the DOM API for Python is given as part of the :mod:`xml.dom` +module documentation. This section lists the differences between the API and +:mod:`xml.dom.minidom`. + + +.. method:: Node.unlink() + + Break internal references within the DOM so that it will be garbage collected on + versions of Python without cyclic GC. Even when cyclic GC is available, using + this can make large amounts of memory available sooner, so calling this on DOM + objects as soon as they are no longer needed is good practice. This only needs + to be called on the :class:`Document` object, but may be called on child nodes + to discard children of that node. + + You can avoid calling this method explicitly by using the :keyword:`with` + statement. The following code will automatically unlink *dom* when the + :keyword:`!with` block is exited:: + + with xml.dom.minidom.parse(datasource) as dom: + ... # Work with dom. + + +.. method:: Node.writexml(writer, indent="", addindent="", newl="") + + Write XML to the writer object. The writer receives texts but not bytes as input, + it should have a :meth:`write` method which matches that of the file object + interface. The *indent* parameter is the indentation of the current node. + The *addindent* parameter is the incremental indentation to use for subnodes + of the current one. The *newl* parameter specifies the string to use to + terminate newlines. + + For the :class:`Document` node, an additional keyword argument *encoding* can + be used to specify the encoding field of the XML header. + + +.. method:: Node.toxml(encoding=None) + + Return a string or byte string containing the XML represented by + the DOM node. + + With an explicit *encoding* [1]_ argument, the result is a byte + string in the specified encoding. + With no *encoding* argument, the result is a Unicode string, and the + XML declaration in the resulting string does not specify an + encoding. Encoding this string in an encoding other than UTF-8 is + likely incorrect, since UTF-8 is the default encoding of XML. + +.. method:: Node.toprettyxml(indent="\\t", newl="\\n", encoding=None) + + Return a pretty-printed version of the document. *indent* specifies the + indentation string and defaults to a tabulator; *newl* specifies the string + emitted at the end of each line and defaults to ``\n``. + + The *encoding* argument behaves like the corresponding argument of + :meth:`toxml`. + + +.. _dom-example: + +DOM Example +----------- + +This example program is a fairly realistic example of a simple program. In this +particular case, we do not take much advantage of the flexibility of the DOM. + +.. literalinclude:: ../includes/minidom-example.py + + +.. _minidom-and-dom: + +minidom and the DOM standard +---------------------------- + +The :mod:`xml.dom.minidom` module is essentially a DOM 1.0-compatible DOM with +some DOM 2 features (primarily namespace features). + +Usage of the DOM interface in Python is straight-forward. The following mapping +rules apply: + +* Interfaces are accessed through instance objects. Applications should not + instantiate the classes themselves; they should use the creator functions + available on the :class:`Document` object. Derived interfaces support all + operations (and attributes) from the base interfaces, plus any new operations. + +* Operations are used as methods. Since the DOM uses only :keyword:`in` + parameters, the arguments are passed in normal order (from left to right). + There are no optional arguments. ``void`` operations return ``None``. + +* IDL attributes map to instance attributes. For compatibility with the OMG IDL + language mapping for Python, an attribute ``foo`` can also be accessed through + accessor methods :meth:`_get_foo` and :meth:`_set_foo`. ``readonly`` + attributes must not be changed; this is not enforced at runtime. + +* The types ``short int``, ``unsigned int``, ``unsigned long long``, and + ``boolean`` all map to Python integer objects. + +* The type ``DOMString`` maps to Python strings. :mod:`xml.dom.minidom` supports + either bytes or strings, but will normally produce strings. + Values of type ``DOMString`` may also be ``None`` where allowed to have the IDL + ``null`` value by the DOM specification from the W3C. + +* ``const`` declarations map to variables in their respective scope (e.g. + ``xml.dom.minidom.Node.PROCESSING_INSTRUCTION_NODE``); they must not be changed. + +* ``DOMException`` is currently not supported in :mod:`xml.dom.minidom`. + Instead, :mod:`xml.dom.minidom` uses standard Python exceptions such as + :exc:`TypeError` and :exc:`AttributeError`. + +* :class:`NodeList` objects are implemented using Python's built-in list type. + These objects provide the interface defined in the DOM specification, but with + earlier versions of Python they do not support the official API. They are, + however, much more "Pythonic" than the interface defined in the W3C + recommendations. + +The following interfaces have no implementation in :mod:`xml.dom.minidom`: + +* :class:`DOMTimeStamp` + +* :class:`EntityReference` + +Most of these reflect information in the XML document that is not of general +utility to most DOM users. + +.. rubric:: Footnotes + +.. [1] The encoding name included in the XML output should conform to + the appropriate standards. For example, "UTF-8" is valid, but + "UTF8" is not valid in an XML document's declaration, even though + Python accepts it as an encoding name. + See https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl + and https://www.iana.org/assignments/character-sets/character-sets.xhtml. diff --git a/python-3.7.4-docs-html/_sources/library/xml.dom.pulldom.rst.txt b/python-3.7.4-docs-html/_sources/library/xml.dom.pulldom.rst.txt new file mode 100644 index 0000000..b4974f9 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/xml.dom.pulldom.rst.txt @@ -0,0 +1,145 @@ +:mod:`xml.dom.pulldom` --- Support for building partial DOM trees +================================================================= + +.. module:: xml.dom.pulldom + :synopsis: Support for building partial DOM trees from SAX events. + +.. moduleauthor:: Paul Prescod <paul@prescod.net> + +**Source code:** :source:`Lib/xml/dom/pulldom.py` + +-------------- + +The :mod:`xml.dom.pulldom` module provides a "pull parser" which can also be +asked to produce DOM-accessible fragments of the document where necessary. The +basic concept involves pulling "events" from a stream of incoming XML and +processing them. In contrast to SAX which also employs an event-driven +processing model together with callbacks, the user of a pull parser is +responsible for explicitly pulling events from the stream, looping over those +events until either processing is finished or an error condition occurs. + + +.. warning:: + + The :mod:`xml.dom.pulldom` module is not secure against + maliciously constructed data. If you need to parse untrusted or + unauthenticated data see :ref:`xml-vulnerabilities`. + +.. versionchanged:: 3.7.1 + + The SAX parser no longer processes general external entities by default to + increase security by default. To enable processing of external entities, + pass a custom parser instance in:: + + from xml.dom.pulldom import parse + from xml.sax import make_parser + from xml.sax.handler import feature_external_ges + + parser = make_parser() + parser.setFeature(feature_external_ges, True) + parse(filename, parser=parser) + + +Example:: + + from xml.dom import pulldom + + doc = pulldom.parse('sales_items.xml') + for event, node in doc: + if event == pulldom.START_ELEMENT and node.tagName == 'item': + if int(node.getAttribute('price')) > 50: + doc.expandNode(node) + print(node.toxml()) + +``event`` is a constant and can be one of: + +* :data:`START_ELEMENT` +* :data:`END_ELEMENT` +* :data:`COMMENT` +* :data:`START_DOCUMENT` +* :data:`END_DOCUMENT` +* :data:`CHARACTERS` +* :data:`PROCESSING_INSTRUCTION` +* :data:`IGNORABLE_WHITESPACE` + +``node`` is an object of type :class:`xml.dom.minidom.Document`, +:class:`xml.dom.minidom.Element` or :class:`xml.dom.minidom.Text`. + +Since the document is treated as a "flat" stream of events, the document "tree" +is implicitly traversed and the desired elements are found regardless of their +depth in the tree. In other words, one does not need to consider hierarchical +issues such as recursive searching of the document nodes, although if the +context of elements were important, one would either need to maintain some +context-related state (i.e. remembering where one is in the document at any +given point) or to make use of the :func:`DOMEventStream.expandNode` method +and switch to DOM-related processing. + + +.. class:: PullDom(documentFactory=None) + + Subclass of :class:`xml.sax.handler.ContentHandler`. + + +.. class:: SAX2DOM(documentFactory=None) + + Subclass of :class:`xml.sax.handler.ContentHandler`. + + +.. function:: parse(stream_or_string, parser=None, bufsize=None) + + Return a :class:`DOMEventStream` from the given input. *stream_or_string* may be + either a file name, or a file-like object. *parser*, if given, must be an + :class:`~xml.sax.xmlreader.XMLReader` object. This function will change the + document handler of the + parser and activate namespace support; other parser configuration (like + setting an entity resolver) must have been done in advance. + +If you have XML in a string, you can use the :func:`parseString` function instead: + +.. function:: parseString(string, parser=None) + + Return a :class:`DOMEventStream` that represents the (Unicode) *string*. + +.. data:: default_bufsize + + Default value for the *bufsize* parameter to :func:`parse`. + + The value of this variable can be changed before calling :func:`parse` and + the new value will take effect. + +.. _domeventstream-objects: + +DOMEventStream Objects +---------------------- + +.. class:: DOMEventStream(stream, parser, bufsize) + + + .. method:: getEvent() + + Return a tuple containing *event* and the current *node* as + :class:`xml.dom.minidom.Document` if event equals :data:`START_DOCUMENT`, + :class:`xml.dom.minidom.Element` if event equals :data:`START_ELEMENT` or + :data:`END_ELEMENT` or :class:`xml.dom.minidom.Text` if event equals + :data:`CHARACTERS`. + The current node does not contain information about its children, unless + :func:`expandNode` is called. + + .. method:: expandNode(node) + + Expands all children of *node* into *node*. Example:: + + from xml.dom import pulldom + + xml = '<html><title>Foo

    Some text

    and more

    ' + doc = pulldom.parseString(xml) + for event, node in doc: + if event == pulldom.START_ELEMENT and node.tagName == 'p': + # Following statement only prints '

    ' + print(node.toxml()) + doc.expandNode(node) + # Following statement prints node with all its children '

    Some text

    and more

    ' + print(node.toxml()) + + .. method:: DOMEventStream.reset() + diff --git a/python-3.7.4-docs-html/_sources/library/xml.dom.rst.txt b/python-3.7.4-docs-html/_sources/library/xml.dom.rst.txt new file mode 100644 index 0000000..18519a7 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/xml.dom.rst.txt @@ -0,0 +1,1033 @@ +:mod:`xml.dom` --- The Document Object Model API +================================================ + +.. module:: xml.dom + :synopsis: Document Object Model API for Python. + +.. sectionauthor:: Paul Prescod +.. sectionauthor:: Martin v. Löwis + +**Source code:** :source:`Lib/xml/dom/__init__.py` + +-------------- + +The Document Object Model, or "DOM," is a cross-language API from the World Wide +Web Consortium (W3C) for accessing and modifying XML documents. A DOM +implementation presents an XML document as a tree structure, or allows client +code to build such a structure from scratch. It then gives access to the +structure through a set of objects which provided well-known interfaces. + +The DOM is extremely useful for random-access applications. SAX only allows you +a view of one bit of the document at a time. If you are looking at one SAX +element, you have no access to another. If you are looking at a text node, you +have no access to a containing element. When you write a SAX application, you +need to keep track of your program's position in the document somewhere in your +own code. SAX does not do it for you. Also, if you need to look ahead in the +XML document, you are just out of luck. + +Some applications are simply impossible in an event driven model with no access +to a tree. Of course you could build some sort of tree yourself in SAX events, +but the DOM allows you to avoid writing that code. The DOM is a standard tree +representation for XML data. + +The Document Object Model is being defined by the W3C in stages, or "levels" in +their terminology. The Python mapping of the API is substantially based on the +DOM Level 2 recommendation. + +.. What if your needs are somewhere between SAX and the DOM? Perhaps + you cannot afford to load the entire tree in memory but you find the + SAX model somewhat cumbersome and low-level. There is also a module + called xml.dom.pulldom that allows you to build trees of only the + parts of a document that you need structured access to. It also has + features that allow you to find your way around the DOM. + See http://www.prescod.net/python/pulldom + +DOM applications typically start by parsing some XML into a DOM. How this is +accomplished is not covered at all by DOM Level 1, and Level 2 provides only +limited improvements: There is a :class:`DOMImplementation` object class which +provides access to :class:`Document` creation methods, but no way to access an +XML reader/parser/Document builder in an implementation-independent way. There +is also no well-defined way to access these methods without an existing +:class:`Document` object. In Python, each DOM implementation will provide a +function :func:`getDOMImplementation`. DOM Level 3 adds a Load/Store +specification, which defines an interface to the reader, but this is not yet +available in the Python standard library. + +Once you have a DOM document object, you can access the parts of your XML +document through its properties and methods. These properties are defined in +the DOM specification; this portion of the reference manual describes the +interpretation of the specification in Python. + +The specification provided by the W3C defines the DOM API for Java, ECMAScript, +and OMG IDL. The Python mapping defined here is based in large part on the IDL +version of the specification, but strict compliance is not required (though +implementations are free to support the strict mapping from IDL). See section +:ref:`dom-conformance` for a detailed discussion of mapping requirements. + + +.. seealso:: + + `Document Object Model (DOM) Level 2 Specification `_ + The W3C recommendation upon which the Python DOM API is based. + + `Document Object Model (DOM) Level 1 Specification `_ + The W3C recommendation for the DOM supported by :mod:`xml.dom.minidom`. + + `Python Language Mapping Specification `_ + This specifies the mapping from OMG IDL to Python. + + +Module Contents +--------------- + +The :mod:`xml.dom` contains the following functions: + + +.. function:: registerDOMImplementation(name, factory) + + Register the *factory* function with the name *name*. The factory function + should return an object which implements the :class:`DOMImplementation` + interface. The factory function can return the same object every time, or a new + one for each call, as appropriate for the specific implementation (e.g. if that + implementation supports some customization). + + +.. function:: getDOMImplementation(name=None, features=()) + + Return a suitable DOM implementation. The *name* is either well-known, the + module name of a DOM implementation, or ``None``. If it is not ``None``, imports + the corresponding module and returns a :class:`DOMImplementation` object if the + import succeeds. If no name is given, and if the environment variable + :envvar:`PYTHON_DOM` is set, this variable is used to find the implementation. + + If name is not given, this examines the available implementations to find one + with the required feature set. If no implementation can be found, raise an + :exc:`ImportError`. The features list must be a sequence of ``(feature, + version)`` pairs which are passed to the :meth:`hasFeature` method on available + :class:`DOMImplementation` objects. + +Some convenience constants are also provided: + + +.. data:: EMPTY_NAMESPACE + + The value used to indicate that no namespace is associated with a node in the + DOM. This is typically found as the :attr:`namespaceURI` of a node, or used as + the *namespaceURI* parameter to a namespaces-specific method. + + +.. data:: XML_NAMESPACE + + The namespace URI associated with the reserved prefix ``xml``, as defined by + `Namespaces in XML `_ (section 4). + + +.. data:: XMLNS_NAMESPACE + + The namespace URI for namespace declarations, as defined by `Document Object + Model (DOM) Level 2 Core Specification + `_ (section 1.1.8). + + +.. data:: XHTML_NAMESPACE + + The URI of the XHTML namespace as defined by `XHTML 1.0: The Extensible + HyperText Markup Language `_ (section 3.1.1). + + +In addition, :mod:`xml.dom` contains a base :class:`Node` class and the DOM +exception classes. The :class:`Node` class provided by this module does not +implement any of the methods or attributes defined by the DOM specification; +concrete DOM implementations must provide those. The :class:`Node` class +provided as part of this module does provide the constants used for the +:attr:`nodeType` attribute on concrete :class:`Node` objects; they are located +within the class rather than at the module level to conform with the DOM +specifications. + +.. Should the Node documentation go here? + + +.. _dom-objects: + +Objects in the DOM +------------------ + +The definitive documentation for the DOM is the DOM specification from the W3C. + +Note that DOM attributes may also be manipulated as nodes instead of as simple +strings. It is fairly rare that you must do this, however, so this usage is not +yet documented. + ++--------------------------------+-----------------------------------+---------------------------------+ +| Interface | Section | Purpose | ++================================+===================================+=================================+ +| :class:`DOMImplementation` | :ref:`dom-implementation-objects` | Interface to the underlying | +| | | implementation. | ++--------------------------------+-----------------------------------+---------------------------------+ +| :class:`Node` | :ref:`dom-node-objects` | Base interface for most objects | +| | | in a document. | ++--------------------------------+-----------------------------------+---------------------------------+ +| :class:`NodeList` | :ref:`dom-nodelist-objects` | Interface for a sequence of | +| | | nodes. | ++--------------------------------+-----------------------------------+---------------------------------+ +| :class:`DocumentType` | :ref:`dom-documenttype-objects` | Information about the | +| | | declarations needed to process | +| | | a document. | ++--------------------------------+-----------------------------------+---------------------------------+ +| :class:`Document` | :ref:`dom-document-objects` | Object which represents an | +| | | entire document. | ++--------------------------------+-----------------------------------+---------------------------------+ +| :class:`Element` | :ref:`dom-element-objects` | Element nodes in the document | +| | | hierarchy. | ++--------------------------------+-----------------------------------+---------------------------------+ +| :class:`Attr` | :ref:`dom-attr-objects` | Attribute value nodes on | +| | | element nodes. | ++--------------------------------+-----------------------------------+---------------------------------+ +| :class:`Comment` | :ref:`dom-comment-objects` | Representation of comments in | +| | | the source document. | ++--------------------------------+-----------------------------------+---------------------------------+ +| :class:`Text` | :ref:`dom-text-objects` | Nodes containing textual | +| | | content from the document. | ++--------------------------------+-----------------------------------+---------------------------------+ +| :class:`ProcessingInstruction` | :ref:`dom-pi-objects` | Processing instruction | +| | | representation. | ++--------------------------------+-----------------------------------+---------------------------------+ + +An additional section describes the exceptions defined for working with the DOM +in Python. + + +.. _dom-implementation-objects: + +DOMImplementation Objects +^^^^^^^^^^^^^^^^^^^^^^^^^ + +The :class:`DOMImplementation` interface provides a way for applications to +determine the availability of particular features in the DOM they are using. +DOM Level 2 added the ability to create new :class:`Document` and +:class:`DocumentType` objects using the :class:`DOMImplementation` as well. + + +.. method:: DOMImplementation.hasFeature(feature, version) + + Return true if the feature identified by the pair of strings *feature* and + *version* is implemented. + + +.. method:: DOMImplementation.createDocument(namespaceUri, qualifiedName, doctype) + + Return a new :class:`Document` object (the root of the DOM), with a child + :class:`Element` object having the given *namespaceUri* and *qualifiedName*. The + *doctype* must be a :class:`DocumentType` object created by + :meth:`createDocumentType`, or ``None``. In the Python DOM API, the first two + arguments can also be ``None`` in order to indicate that no :class:`Element` + child is to be created. + + +.. method:: DOMImplementation.createDocumentType(qualifiedName, publicId, systemId) + + Return a new :class:`DocumentType` object that encapsulates the given + *qualifiedName*, *publicId*, and *systemId* strings, representing the + information contained in an XML document type declaration. + + +.. _dom-node-objects: + +Node Objects +^^^^^^^^^^^^ + +All of the components of an XML document are subclasses of :class:`Node`. + + +.. attribute:: Node.nodeType + + An integer representing the node type. Symbolic constants for the types are on + the :class:`Node` object: :const:`ELEMENT_NODE`, :const:`ATTRIBUTE_NODE`, + :const:`TEXT_NODE`, :const:`CDATA_SECTION_NODE`, :const:`ENTITY_NODE`, + :const:`PROCESSING_INSTRUCTION_NODE`, :const:`COMMENT_NODE`, + :const:`DOCUMENT_NODE`, :const:`DOCUMENT_TYPE_NODE`, :const:`NOTATION_NODE`. + This is a read-only attribute. + + +.. attribute:: Node.parentNode + + The parent of the current node, or ``None`` for the document node. The value is + always a :class:`Node` object or ``None``. For :class:`Element` nodes, this + will be the parent element, except for the root element, in which case it will + be the :class:`Document` object. For :class:`Attr` nodes, this is always + ``None``. This is a read-only attribute. + + +.. attribute:: Node.attributes + + A :class:`NamedNodeMap` of attribute objects. Only elements have actual values + for this; others provide ``None`` for this attribute. This is a read-only + attribute. + + +.. attribute:: Node.previousSibling + + The node that immediately precedes this one with the same parent. For + instance the element with an end-tag that comes just before the *self* + element's start-tag. Of course, XML documents are made up of more than just + elements so the previous sibling could be text, a comment, or something else. + If this node is the first child of the parent, this attribute will be + ``None``. This is a read-only attribute. + + +.. attribute:: Node.nextSibling + + The node that immediately follows this one with the same parent. See also + :attr:`previousSibling`. If this is the last child of the parent, this + attribute will be ``None``. This is a read-only attribute. + + +.. attribute:: Node.childNodes + + A list of nodes contained within this node. This is a read-only attribute. + + +.. attribute:: Node.firstChild + + The first child of the node, if there are any, or ``None``. This is a read-only + attribute. + + +.. attribute:: Node.lastChild + + The last child of the node, if there are any, or ``None``. This is a read-only + attribute. + + +.. attribute:: Node.localName + + The part of the :attr:`tagName` following the colon if there is one, else the + entire :attr:`tagName`. The value is a string. + + +.. attribute:: Node.prefix + + The part of the :attr:`tagName` preceding the colon if there is one, else the + empty string. The value is a string, or ``None``. + + +.. attribute:: Node.namespaceURI + + The namespace associated with the element name. This will be a string or + ``None``. This is a read-only attribute. + + +.. attribute:: Node.nodeName + + This has a different meaning for each node type; see the DOM specification for + details. You can always get the information you would get here from another + property such as the :attr:`tagName` property for elements or the :attr:`name` + property for attributes. For all node types, the value of this attribute will be + either a string or ``None``. This is a read-only attribute. + + +.. attribute:: Node.nodeValue + + This has a different meaning for each node type; see the DOM specification for + details. The situation is similar to that with :attr:`nodeName`. The value is + a string or ``None``. + + +.. method:: Node.hasAttributes() + + Returns true if the node has any attributes. + + +.. method:: Node.hasChildNodes() + + Returns true if the node has any child nodes. + + +.. method:: Node.isSameNode(other) + + Returns true if *other* refers to the same node as this node. This is especially + useful for DOM implementations which use any sort of proxy architecture (because + more than one object can refer to the same node). + + .. note:: + + This is based on a proposed DOM Level 3 API which is still in the "working + draft" stage, but this particular interface appears uncontroversial. Changes + from the W3C will not necessarily affect this method in the Python DOM interface + (though any new W3C API for this would also be supported). + + +.. method:: Node.appendChild(newChild) + + Add a new child node to this node at the end of the list of + children, returning *newChild*. If the node was already in + the tree, it is removed first. + + +.. method:: Node.insertBefore(newChild, refChild) + + Insert a new child node before an existing child. It must be the case that + *refChild* is a child of this node; if not, :exc:`ValueError` is raised. + *newChild* is returned. If *refChild* is ``None``, it inserts *newChild* at the + end of the children's list. + + +.. method:: Node.removeChild(oldChild) + + Remove a child node. *oldChild* must be a child of this node; if not, + :exc:`ValueError` is raised. *oldChild* is returned on success. If *oldChild* + will not be used further, its :meth:`unlink` method should be called. + + +.. method:: Node.replaceChild(newChild, oldChild) + + Replace an existing node with a new node. It must be the case that *oldChild* + is a child of this node; if not, :exc:`ValueError` is raised. + + +.. method:: Node.normalize() + + Join adjacent text nodes so that all stretches of text are stored as single + :class:`Text` instances. This simplifies processing text from a DOM tree for + many applications. + + +.. method:: Node.cloneNode(deep) + + Clone this node. Setting *deep* means to clone all child nodes as well. This + returns the clone. + + +.. _dom-nodelist-objects: + +NodeList Objects +^^^^^^^^^^^^^^^^ + +A :class:`NodeList` represents a sequence of nodes. These objects are used in +two ways in the DOM Core recommendation: an :class:`Element` object provides +one as its list of child nodes, and the :meth:`getElementsByTagName` and +:meth:`getElementsByTagNameNS` methods of :class:`Node` return objects with this +interface to represent query results. + +The DOM Level 2 recommendation defines one method and one attribute for these +objects: + + +.. method:: NodeList.item(i) + + Return the *i*'th item from the sequence, if there is one, or ``None``. The + index *i* is not allowed to be less than zero or greater than or equal to the + length of the sequence. + + +.. attribute:: NodeList.length + + The number of nodes in the sequence. + +In addition, the Python DOM interface requires that some additional support is +provided to allow :class:`NodeList` objects to be used as Python sequences. All +:class:`NodeList` implementations must include support for +:meth:`~object.__len__` and +:meth:`~object.__getitem__`; this allows iteration over the :class:`NodeList` in +:keyword:`for` statements and proper support for the :func:`len` built-in +function. + +If a DOM implementation supports modification of the document, the +:class:`NodeList` implementation must also support the +:meth:`~object.__setitem__` and :meth:`~object.__delitem__` methods. + + +.. _dom-documenttype-objects: + +DocumentType Objects +^^^^^^^^^^^^^^^^^^^^ + +Information about the notations and entities declared by a document (including +the external subset if the parser uses it and can provide the information) is +available from a :class:`DocumentType` object. The :class:`DocumentType` for a +document is available from the :class:`Document` object's :attr:`doctype` +attribute; if there is no ``DOCTYPE`` declaration for the document, the +document's :attr:`doctype` attribute will be set to ``None`` instead of an +instance of this interface. + +:class:`DocumentType` is a specialization of :class:`Node`, and adds the +following attributes: + + +.. attribute:: DocumentType.publicId + + The public identifier for the external subset of the document type definition. + This will be a string or ``None``. + + +.. attribute:: DocumentType.systemId + + The system identifier for the external subset of the document type definition. + This will be a URI as a string, or ``None``. + + +.. attribute:: DocumentType.internalSubset + + A string giving the complete internal subset from the document. This does not + include the brackets which enclose the subset. If the document has no internal + subset, this should be ``None``. + + +.. attribute:: DocumentType.name + + The name of the root element as given in the ``DOCTYPE`` declaration, if + present. + + +.. attribute:: DocumentType.entities + + This is a :class:`NamedNodeMap` giving the definitions of external entities. + For entity names defined more than once, only the first definition is provided + (others are ignored as required by the XML recommendation). This may be + ``None`` if the information is not provided by the parser, or if no entities are + defined. + + +.. attribute:: DocumentType.notations + + This is a :class:`NamedNodeMap` giving the definitions of notations. For + notation names defined more than once, only the first definition is provided + (others are ignored as required by the XML recommendation). This may be + ``None`` if the information is not provided by the parser, or if no notations + are defined. + + +.. _dom-document-objects: + +Document Objects +^^^^^^^^^^^^^^^^ + +A :class:`Document` represents an entire XML document, including its constituent +elements, attributes, processing instructions, comments etc. Remember that it +inherits properties from :class:`Node`. + + +.. attribute:: Document.documentElement + + The one and only root element of the document. + + +.. method:: Document.createElement(tagName) + + Create and return a new element node. The element is not inserted into the + document when it is created. You need to explicitly insert it with one of the + other methods such as :meth:`insertBefore` or :meth:`appendChild`. + + +.. method:: Document.createElementNS(namespaceURI, tagName) + + Create and return a new element with a namespace. The *tagName* may have a + prefix. The element is not inserted into the document when it is created. You + need to explicitly insert it with one of the other methods such as + :meth:`insertBefore` or :meth:`appendChild`. + + +.. method:: Document.createTextNode(data) + + Create and return a text node containing the data passed as a parameter. As + with the other creation methods, this one does not insert the node into the + tree. + + +.. method:: Document.createComment(data) + + Create and return a comment node containing the data passed as a parameter. As + with the other creation methods, this one does not insert the node into the + tree. + + +.. method:: Document.createProcessingInstruction(target, data) + + Create and return a processing instruction node containing the *target* and + *data* passed as parameters. As with the other creation methods, this one does + not insert the node into the tree. + + +.. method:: Document.createAttribute(name) + + Create and return an attribute node. This method does not associate the + attribute node with any particular element. You must use + :meth:`setAttributeNode` on the appropriate :class:`Element` object to use the + newly created attribute instance. + + +.. method:: Document.createAttributeNS(namespaceURI, qualifiedName) + + Create and return an attribute node with a namespace. The *tagName* may have a + prefix. This method does not associate the attribute node with any particular + element. You must use :meth:`setAttributeNode` on the appropriate + :class:`Element` object to use the newly created attribute instance. + + +.. method:: Document.getElementsByTagName(tagName) + + Search for all descendants (direct children, children's children, etc.) with a + particular element type name. + + +.. method:: Document.getElementsByTagNameNS(namespaceURI, localName) + + Search for all descendants (direct children, children's children, etc.) with a + particular namespace URI and localname. The localname is the part of the + namespace after the prefix. + + +.. _dom-element-objects: + +Element Objects +^^^^^^^^^^^^^^^ + +:class:`Element` is a subclass of :class:`Node`, so inherits all the attributes +of that class. + + +.. attribute:: Element.tagName + + The element type name. In a namespace-using document it may have colons in it. + The value is a string. + + +.. method:: Element.getElementsByTagName(tagName) + + Same as equivalent method in the :class:`Document` class. + + +.. method:: Element.getElementsByTagNameNS(namespaceURI, localName) + + Same as equivalent method in the :class:`Document` class. + + +.. method:: Element.hasAttribute(name) + + Returns true if the element has an attribute named by *name*. + + +.. method:: Element.hasAttributeNS(namespaceURI, localName) + + Returns true if the element has an attribute named by *namespaceURI* and + *localName*. + + +.. method:: Element.getAttribute(name) + + Return the value of the attribute named by *name* as a string. If no such + attribute exists, an empty string is returned, as if the attribute had no value. + + +.. method:: Element.getAttributeNode(attrname) + + Return the :class:`Attr` node for the attribute named by *attrname*. + + +.. method:: Element.getAttributeNS(namespaceURI, localName) + + Return the value of the attribute named by *namespaceURI* and *localName* as a + string. If no such attribute exists, an empty string is returned, as if the + attribute had no value. + + +.. method:: Element.getAttributeNodeNS(namespaceURI, localName) + + Return an attribute value as a node, given a *namespaceURI* and *localName*. + + +.. method:: Element.removeAttribute(name) + + Remove an attribute by name. If there is no matching attribute, a + :exc:`NotFoundErr` is raised. + + +.. method:: Element.removeAttributeNode(oldAttr) + + Remove and return *oldAttr* from the attribute list, if present. If *oldAttr* is + not present, :exc:`NotFoundErr` is raised. + + +.. method:: Element.removeAttributeNS(namespaceURI, localName) + + Remove an attribute by name. Note that it uses a localName, not a qname. No + exception is raised if there is no matching attribute. + + +.. method:: Element.setAttribute(name, value) + + Set an attribute value from a string. + + +.. method:: Element.setAttributeNode(newAttr) + + Add a new attribute node to the element, replacing an existing attribute if + necessary if the :attr:`name` attribute matches. If a replacement occurs, the + old attribute node will be returned. If *newAttr* is already in use, + :exc:`InuseAttributeErr` will be raised. + + +.. method:: Element.setAttributeNodeNS(newAttr) + + Add a new attribute node to the element, replacing an existing attribute if + necessary if the :attr:`namespaceURI` and :attr:`localName` attributes match. + If a replacement occurs, the old attribute node will be returned. If *newAttr* + is already in use, :exc:`InuseAttributeErr` will be raised. + + +.. method:: Element.setAttributeNS(namespaceURI, qname, value) + + Set an attribute value from a string, given a *namespaceURI* and a *qname*. + Note that a qname is the whole attribute name. This is different than above. + + +.. _dom-attr-objects: + +Attr Objects +^^^^^^^^^^^^ + +:class:`Attr` inherits from :class:`Node`, so inherits all its attributes. + + +.. attribute:: Attr.name + + The attribute name. + In a namespace-using document it may include a colon. + + +.. attribute:: Attr.localName + + The part of the name following the colon if there is one, else the + entire name. + This is a read-only attribute. + + +.. attribute:: Attr.prefix + + The part of the name preceding the colon if there is one, else the + empty string. + + +.. attribute:: Attr.value + + The text value of the attribute. This is a synonym for the + :attr:`nodeValue` attribute. + + +.. _dom-attributelist-objects: + +NamedNodeMap Objects +^^^^^^^^^^^^^^^^^^^^ + +:class:`NamedNodeMap` does *not* inherit from :class:`Node`. + + +.. attribute:: NamedNodeMap.length + + The length of the attribute list. + + +.. method:: NamedNodeMap.item(index) + + Return an attribute with a particular index. The order you get the attributes + in is arbitrary but will be consistent for the life of a DOM. Each item is an + attribute node. Get its value with the :attr:`value` attribute. + +There are also experimental methods that give this class more mapping behavior. +You can use them or you can use the standardized :meth:`getAttribute\*` family +of methods on the :class:`Element` objects. + + +.. _dom-comment-objects: + +Comment Objects +^^^^^^^^^^^^^^^ + +:class:`Comment` represents a comment in the XML document. It is a subclass of +:class:`Node`, but cannot have child nodes. + + +.. attribute:: Comment.data + + The content of the comment as a string. The attribute contains all characters + between the leading ````, but does not + include them. + + +.. _dom-text-objects: + +Text and CDATASection Objects +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The :class:`Text` interface represents text in the XML document. If the parser +and DOM implementation support the DOM's XML extension, portions of the text +enclosed in CDATA marked sections are stored in :class:`CDATASection` objects. +These two interfaces are identical, but provide different values for the +:attr:`nodeType` attribute. + +These interfaces extend the :class:`Node` interface. They cannot have child +nodes. + + +.. attribute:: Text.data + + The content of the text node as a string. + +.. note:: + + The use of a :class:`CDATASection` node does not indicate that the node + represents a complete CDATA marked section, only that the content of the node + was part of a CDATA section. A single CDATA section may be represented by more + than one node in the document tree. There is no way to determine whether two + adjacent :class:`CDATASection` nodes represent different CDATA marked sections. + + +.. _dom-pi-objects: + +ProcessingInstruction Objects +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Represents a processing instruction in the XML document; this inherits from the +:class:`Node` interface and cannot have child nodes. + + +.. attribute:: ProcessingInstruction.target + + The content of the processing instruction up to the first whitespace character. + This is a read-only attribute. + + +.. attribute:: ProcessingInstruction.data + + The content of the processing instruction following the first whitespace + character. + + +.. _dom-exceptions: + +Exceptions +^^^^^^^^^^ + +The DOM Level 2 recommendation defines a single exception, :exc:`DOMException`, +and a number of constants that allow applications to determine what sort of +error occurred. :exc:`DOMException` instances carry a :attr:`code` attribute +that provides the appropriate value for the specific exception. + +The Python DOM interface provides the constants, but also expands the set of +exceptions so that a specific exception exists for each of the exception codes +defined by the DOM. The implementations must raise the appropriate specific +exception, each of which carries the appropriate value for the :attr:`code` +attribute. + + +.. exception:: DOMException + + Base exception class used for all specific DOM exceptions. This exception class + cannot be directly instantiated. + + +.. exception:: DomstringSizeErr + + Raised when a specified range of text does not fit into a string. This is not + known to be used in the Python DOM implementations, but may be received from DOM + implementations not written in Python. + + +.. exception:: HierarchyRequestErr + + Raised when an attempt is made to insert a node where the node type is not + allowed. + + +.. exception:: IndexSizeErr + + Raised when an index or size parameter to a method is negative or exceeds the + allowed values. + + +.. exception:: InuseAttributeErr + + Raised when an attempt is made to insert an :class:`Attr` node that is already + present elsewhere in the document. + + +.. exception:: InvalidAccessErr + + Raised if a parameter or an operation is not supported on the underlying object. + + +.. exception:: InvalidCharacterErr + + This exception is raised when a string parameter contains a character that is + not permitted in the context it's being used in by the XML 1.0 recommendation. + For example, attempting to create an :class:`Element` node with a space in the + element type name will cause this error to be raised. + + +.. exception:: InvalidModificationErr + + Raised when an attempt is made to modify the type of a node. + + +.. exception:: InvalidStateErr + + Raised when an attempt is made to use an object that is not defined or is no + longer usable. + + +.. exception:: NamespaceErr + + If an attempt is made to change any object in a way that is not permitted with + regard to the `Namespaces in XML `_ + recommendation, this exception is raised. + + +.. exception:: NotFoundErr + + Exception when a node does not exist in the referenced context. For example, + :meth:`NamedNodeMap.removeNamedItem` will raise this if the node passed in does + not exist in the map. + + +.. exception:: NotSupportedErr + + Raised when the implementation does not support the requested type of object or + operation. + + +.. exception:: NoDataAllowedErr + + This is raised if data is specified for a node which does not support data. + + .. XXX a better explanation is needed! + + +.. exception:: NoModificationAllowedErr + + Raised on attempts to modify an object where modifications are not allowed (such + as for read-only nodes). + + +.. exception:: SyntaxErr + + Raised when an invalid or illegal string is specified. + + .. XXX how is this different from InvalidCharacterErr? + + +.. exception:: WrongDocumentErr + + Raised when a node is inserted in a different document than it currently belongs + to, and the implementation does not support migrating the node from one document + to the other. + +The exception codes defined in the DOM recommendation map to the exceptions +described above according to this table: + ++--------------------------------------+---------------------------------+ +| Constant | Exception | ++======================================+=================================+ +| :const:`DOMSTRING_SIZE_ERR` | :exc:`DomstringSizeErr` | ++--------------------------------------+---------------------------------+ +| :const:`HIERARCHY_REQUEST_ERR` | :exc:`HierarchyRequestErr` | ++--------------------------------------+---------------------------------+ +| :const:`INDEX_SIZE_ERR` | :exc:`IndexSizeErr` | ++--------------------------------------+---------------------------------+ +| :const:`INUSE_ATTRIBUTE_ERR` | :exc:`InuseAttributeErr` | ++--------------------------------------+---------------------------------+ +| :const:`INVALID_ACCESS_ERR` | :exc:`InvalidAccessErr` | ++--------------------------------------+---------------------------------+ +| :const:`INVALID_CHARACTER_ERR` | :exc:`InvalidCharacterErr` | ++--------------------------------------+---------------------------------+ +| :const:`INVALID_MODIFICATION_ERR` | :exc:`InvalidModificationErr` | ++--------------------------------------+---------------------------------+ +| :const:`INVALID_STATE_ERR` | :exc:`InvalidStateErr` | ++--------------------------------------+---------------------------------+ +| :const:`NAMESPACE_ERR` | :exc:`NamespaceErr` | ++--------------------------------------+---------------------------------+ +| :const:`NOT_FOUND_ERR` | :exc:`NotFoundErr` | ++--------------------------------------+---------------------------------+ +| :const:`NOT_SUPPORTED_ERR` | :exc:`NotSupportedErr` | ++--------------------------------------+---------------------------------+ +| :const:`NO_DATA_ALLOWED_ERR` | :exc:`NoDataAllowedErr` | ++--------------------------------------+---------------------------------+ +| :const:`NO_MODIFICATION_ALLOWED_ERR` | :exc:`NoModificationAllowedErr` | ++--------------------------------------+---------------------------------+ +| :const:`SYNTAX_ERR` | :exc:`SyntaxErr` | ++--------------------------------------+---------------------------------+ +| :const:`WRONG_DOCUMENT_ERR` | :exc:`WrongDocumentErr` | ++--------------------------------------+---------------------------------+ + + +.. _dom-conformance: + +Conformance +----------- + +This section describes the conformance requirements and relationships between +the Python DOM API, the W3C DOM recommendations, and the OMG IDL mapping for +Python. + + +.. _dom-type-mapping: + +Type Mapping +^^^^^^^^^^^^ + +The IDL types used in the DOM specification are mapped to Python types +according to the following table. + ++------------------+-------------------------------------------+ +| IDL Type | Python Type | ++==================+===========================================+ +| ``boolean`` | ``bool`` or ``int`` | ++------------------+-------------------------------------------+ +| ``int`` | ``int`` | ++------------------+-------------------------------------------+ +| ``long int`` | ``int`` | ++------------------+-------------------------------------------+ +| ``unsigned int`` | ``int`` | ++------------------+-------------------------------------------+ +| ``DOMString`` | ``str`` or ``bytes`` | ++------------------+-------------------------------------------+ +| ``null`` | ``None`` | ++------------------+-------------------------------------------+ + +.. _dom-accessor-methods: + +Accessor Methods +^^^^^^^^^^^^^^^^ + +The mapping from OMG IDL to Python defines accessor functions for IDL +``attribute`` declarations in much the way the Java mapping does. +Mapping the IDL declarations :: + + readonly attribute string someValue; + attribute string anotherValue; + +yields three accessor functions: a "get" method for :attr:`someValue` +(:meth:`_get_someValue`), and "get" and "set" methods for :attr:`anotherValue` +(:meth:`_get_anotherValue` and :meth:`_set_anotherValue`). The mapping, in +particular, does not require that the IDL attributes are accessible as normal +Python attributes: ``object.someValue`` is *not* required to work, and may +raise an :exc:`AttributeError`. + +The Python DOM API, however, *does* require that normal attribute access work. +This means that the typical surrogates generated by Python IDL compilers are not +likely to work, and wrapper objects may be needed on the client if the DOM +objects are accessed via CORBA. While this does require some additional +consideration for CORBA DOM clients, the implementers with experience using DOM +over CORBA from Python do not consider this a problem. Attributes that are +declared ``readonly`` may not restrict write access in all DOM +implementations. + +In the Python DOM API, accessor functions are not required. If provided, they +should take the form defined by the Python IDL mapping, but these methods are +considered unnecessary since the attributes are accessible directly from Python. +"Set" accessors should never be provided for ``readonly`` attributes. + +The IDL definitions do not fully embody the requirements of the W3C DOM API, +such as the notion of certain objects, such as the return value of +:meth:`getElementsByTagName`, being "live". The Python DOM API does not require +implementations to enforce such requirements. + diff --git a/python-3.7.4-docs-html/_sources/library/xml.etree.elementtree.rst.txt b/python-3.7.4-docs-html/_sources/library/xml.etree.elementtree.rst.txt new file mode 100644 index 0000000..5f799ab --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/xml.etree.elementtree.rst.txt @@ -0,0 +1,1205 @@ +:mod:`xml.etree.ElementTree` --- The ElementTree XML API +======================================================== + +.. module:: xml.etree.ElementTree + :synopsis: Implementation of the ElementTree API. + +.. moduleauthor:: Fredrik Lundh + +**Source code:** :source:`Lib/xml/etree/ElementTree.py` + +-------------- + +The :mod:`xml.etree.ElementTree` module implements a simple and efficient API +for parsing and creating XML data. + +.. versionchanged:: 3.3 + This module will use a fast implementation whenever available. + The :mod:`xml.etree.cElementTree` module is deprecated. + + +.. warning:: + + The :mod:`xml.etree.ElementTree` module is not secure against + maliciously constructed data. If you need to parse untrusted or + unauthenticated data see :ref:`xml-vulnerabilities`. + +Tutorial +-------- + +This is a short tutorial for using :mod:`xml.etree.ElementTree` (``ET`` in +short). The goal is to demonstrate some of the building blocks and basic +concepts of the module. + +XML tree and elements +^^^^^^^^^^^^^^^^^^^^^ + +XML is an inherently hierarchical data format, and the most natural way to +represent it is with a tree. ``ET`` has two classes for this purpose - +:class:`ElementTree` represents the whole XML document as a tree, and +:class:`Element` represents a single node in this tree. Interactions with +the whole document (reading and writing to/from files) are usually done +on the :class:`ElementTree` level. Interactions with a single XML element +and its sub-elements are done on the :class:`Element` level. + +.. _elementtree-parsing-xml: + +Parsing XML +^^^^^^^^^^^ + +We'll be using the following XML document as the sample data for this section: + +.. code-block:: xml + + + + + 1 + 2008 + 141100 + + + + + 4 + 2011 + 59900 + + + + 68 + 2011 + 13600 + + + + + +We can import this data by reading from a file:: + + import xml.etree.ElementTree as ET + tree = ET.parse('country_data.xml') + root = tree.getroot() + +Or directly from a string:: + + root = ET.fromstring(country_data_as_string) + +:func:`fromstring` parses XML from a string directly into an :class:`Element`, +which is the root element of the parsed tree. Other parsing functions may +create an :class:`ElementTree`. Check the documentation to be sure. + +As an :class:`Element`, ``root`` has a tag and a dictionary of attributes:: + + >>> root.tag + 'data' + >>> root.attrib + {} + +It also has children nodes over which we can iterate:: + + >>> for child in root: + ... print(child.tag, child.attrib) + ... + country {'name': 'Liechtenstein'} + country {'name': 'Singapore'} + country {'name': 'Panama'} + +Children are nested, and we can access specific child nodes by index:: + + >>> root[0][1].text + '2008' + + +.. note:: + + Not all elements of the XML input will end up as elements of the + parsed tree. Currently, this module skips over any XML comments, + processing instructions, and document type declarations in the + input. Nevertheless, trees built using this module's API rather + than parsing from XML text can have comments and processing + instructions in them; they will be included when generating XML + output. A document type declaration may be accessed by passing a + custom :class:`TreeBuilder` instance to the :class:`XMLParser` + constructor. + + +.. _elementtree-pull-parsing: + +Pull API for non-blocking parsing +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Most parsing functions provided by this module require the whole document +to be read at once before returning any result. It is possible to use an +:class:`XMLParser` and feed data into it incrementally, but it is a push API that +calls methods on a callback target, which is too low-level and inconvenient for +most needs. Sometimes what the user really wants is to be able to parse XML +incrementally, without blocking operations, while enjoying the convenience of +fully constructed :class:`Element` objects. + +The most powerful tool for doing this is :class:`XMLPullParser`. It does not +require a blocking read to obtain the XML data, and is instead fed with data +incrementally with :meth:`XMLPullParser.feed` calls. To get the parsed XML +elements, call :meth:`XMLPullParser.read_events`. Here is an example:: + + >>> parser = ET.XMLPullParser(['start', 'end']) + >>> parser.feed('sometext') + >>> list(parser.read_events()) + [('start', )] + >>> parser.feed(' more text') + >>> for event, elem in parser.read_events(): + ... print(event) + ... print(elem.tag, 'text=', elem.text) + ... + end + +The obvious use case is applications that operate in a non-blocking fashion +where the XML data is being received from a socket or read incrementally from +some storage device. In such cases, blocking reads are unacceptable. + +Because it's so flexible, :class:`XMLPullParser` can be inconvenient to use for +simpler use-cases. If you don't mind your application blocking on reading XML +data but would still like to have incremental parsing capabilities, take a look +at :func:`iterparse`. It can be useful when you're reading a large XML document +and don't want to hold it wholly in memory. + +Finding interesting elements +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:class:`Element` has some useful methods that help iterate recursively over all +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) + ... + {'name': 'Austria', 'direction': 'E'} + {'name': 'Switzerland', 'direction': 'W'} + {'name': 'Malaysia', 'direction': 'N'} + {'name': 'Costa Rica', 'direction': 'W'} + {'name': 'Colombia', 'direction': 'E'} + +:meth:`Element.findall` finds only elements with a tag which are direct +children of the current element. :meth:`Element.find` finds the *first* child +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) + ... + Liechtenstein 1 + Singapore 4 + Panama 68 + +More sophisticated specification of which elements to look for is possible by +using :ref:`XPath `. + +Modifying an XML File +^^^^^^^^^^^^^^^^^^^^^ + +:class:`ElementTree` provides a simple way to build XML documents and write them to files. +The :meth:`ElementTree.write` method serves this purpose. + +Once created, an :class:`Element` object may be manipulated by directly changing +its fields (such as :attr:`Element.text`), adding and modifying attributes +(:meth:`Element.set` method), as well as adding new children (for example +with :meth:`Element.append`). + +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') + ... + >>> tree.write('output.xml') + +Our XML now looks like this: + +.. code-block:: xml + + + + + 2 + 2008 + 141100 + + + + + 5 + 2011 + 59900 + + + + 69 + 2011 + 13600 + + + + + +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) + ... + >>> tree.write('output.xml') + +Our XML now looks like this: + +.. code-block:: xml + + + + + 2 + 2008 + 141100 + + + + + 5 + 2011 + 59900 + + + + +Building XML documents +^^^^^^^^^^^^^^^^^^^^^^ + +The :func:`SubElement` function also provides a convenient way to create new +sub-elements for a given element:: + + >>> a = ET.Element('a') + >>> b = ET.SubElement(a, 'b') + >>> c = ET.SubElement(a, 'c') + >>> d = ET.SubElement(c, 'd') + >>> ET.dump(a) +
    + +Parsing XML with Namespaces +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If the XML input has `namespaces +`__, tags and attributes +with prefixes in the form ``prefix:sometag`` get expanded to +``{uri}sometag`` where the *prefix* is replaced by the full *URI*. +Also, if there is a `default namespace +`__, +that full URI gets prepended to all of the non-prefixed tags. + +Here is an XML example that incorporates two namespaces, one with the +prefix "fictional" and the other serving as the default namespace: + +.. code-block:: xml + + + + + John Cleese + Lancelot + Archie Leach + + + Eric Idle + Sir Robin + Gunther + Commander Clement + + + +One way to search and explore this XML example is to manually add the +URI to every tag or attribute in the xpath of a +:meth:`~Element.find` or :meth:`~Element.findall`:: + + root = fromstring(xml_text) + for actor in root.findall('{http://people.example.com}actor'): + name = actor.find('{http://people.example.com}name') + print(name.text) + for char in actor.findall('{http://characters.example.com}character'): + print(' |-->', char.text) + +A better way to search the namespaced XML example is to create a +dictionary with your own prefixes and use those in the search functions:: + + ns = {'real_person': 'http://people.example.com', + 'role': 'http://characters.example.com'} + + for actor in root.findall('real_person:actor', ns): + name = actor.find('real_person:name', ns) + print(name.text) + for char in actor.findall('role:character', ns): + print(' |-->', char.text) + +These two approaches both output:: + + John Cleese + |--> Lancelot + |--> Archie Leach + Eric Idle + |--> Sir Robin + |--> Gunther + |--> Commander Clement + + +Additional resources +^^^^^^^^^^^^^^^^^^^^ + +See http://effbot.org/zone/element-index.htm for tutorials and links to other +docs. + + +.. _elementtree-xpath: + +XPath support +------------- + +This module provides limited support for +`XPath expressions `_ for locating elements in a +tree. The goal is to support a small subset of the abbreviated syntax; a full +XPath engine is outside the scope of the module. + +Example +^^^^^^^ + +Here's an example that demonstrates some of the XPath capabilities of the +module. We'll be using the ``countrydata`` XML document from the +:ref:`Parsing XML ` section:: + + import xml.etree.ElementTree as ET + + root = ET.fromstring(countrydata) + + # Top-level elements + root.findall(".") + + # All 'neighbor' grand-children of 'country' children of the top-level + # elements + root.findall("./country/neighbor") + + # Nodes with name='Singapore' that have a 'year' child + root.findall(".//year/..[@name='Singapore']") + + # 'year' nodes that are children of nodes with name='Singapore' + root.findall(".//*[@name='Singapore']/year") + + # All 'neighbor' nodes that are the second child of their parent + root.findall(".//neighbor[2]") + +Supported XPath syntax +^^^^^^^^^^^^^^^^^^^^^^ + +.. tabularcolumns:: |l|L| + ++-----------------------+------------------------------------------------------+ +| Syntax | Meaning | ++=======================+======================================================+ +| ``tag`` | Selects all child elements with the given tag. | +| | For example, ``spam`` selects all child elements | +| | named ``spam``, and ``spam/egg`` selects all | +| | grandchildren named ``egg`` in all children named | +| | ``spam``. | ++-----------------------+------------------------------------------------------+ +| ``*`` | Selects all child elements. For example, ``*/egg`` | +| | selects all grandchildren named ``egg``. | ++-----------------------+------------------------------------------------------+ +| ``.`` | Selects the current node. This is mostly useful | +| | at the beginning of the path, to indicate that it's | +| | a relative path. | ++-----------------------+------------------------------------------------------+ +| ``//`` | Selects all subelements, on all levels beneath the | +| | current element. For example, ``.//egg`` selects | +| | all ``egg`` elements in the entire tree. | ++-----------------------+------------------------------------------------------+ +| ``..`` | Selects the parent element. Returns ``None`` if the | +| | path attempts to reach the ancestors of the start | +| | element (the element ``find`` was called on). | ++-----------------------+------------------------------------------------------+ +| ``[@attrib]`` | Selects all elements that have the given attribute. | ++-----------------------+------------------------------------------------------+ +| ``[@attrib='value']`` | Selects all elements for which the given attribute | +| | has the given value. The value cannot contain | +| | quotes. | ++-----------------------+------------------------------------------------------+ +| ``[tag]`` | Selects all elements that have a child named | +| | ``tag``. Only immediate children are supported. | ++-----------------------+------------------------------------------------------+ +| ``[.='text']`` | Selects all elements whose complete text content, | +| | including descendants, equals the given ``text``. | +| | | +| | .. versionadded:: 3.7 | ++-----------------------+------------------------------------------------------+ +| ``[tag='text']`` | Selects all elements that have a child named | +| | ``tag`` whose complete text content, including | +| | descendants, equals the given ``text``. | ++-----------------------+------------------------------------------------------+ +| ``[position]`` | Selects all elements that are located at the given | +| | position. The position can be either an integer | +| | (1 is the first position), the expression ``last()`` | +| | (for the last position), or a position relative to | +| | the last position (e.g. ``last()-1``). | ++-----------------------+------------------------------------------------------+ + +Predicates (expressions within square brackets) must be preceded by a tag +name, an asterisk, or another predicate. ``position`` predicates must be +preceded by a tag name. + +Reference +--------- + +.. _elementtree-functions: + +Functions +^^^^^^^^^ + + +.. function:: Comment(text=None) + + Comment element factory. This factory function creates a special element + that will be serialized as an XML comment by the standard serializer. The + comment string can be either a bytestring or a Unicode string. *text* is a + string containing the comment string. Returns an element instance + representing a comment. + + Note that :class:`XMLParser` skips over comments in the input + instead of creating comment objects for them. An :class:`ElementTree` will + only contain comment nodes if they have been inserted into to + the tree using one of the :class:`Element` methods. + +.. function:: dump(elem) + + Writes an element tree or element structure to sys.stdout. This function + should be used for debugging only. + + The exact output format is implementation dependent. In this version, it's + written as an ordinary XML file. + + *elem* is an element tree or an individual element. + + +.. function:: fromstring(text, parser=None) + + Parses an XML section from a string constant. Same as :func:`XML`. *text* + is a string containing XML data. *parser* is an optional parser instance. + If not given, the standard :class:`XMLParser` parser is used. + Returns an :class:`Element` instance. + + +.. function:: fromstringlist(sequence, parser=None) + + Parses an XML document from a sequence of string fragments. *sequence* is a + list or other sequence containing XML data fragments. *parser* is an + optional parser instance. If not given, the standard :class:`XMLParser` + parser is used. Returns an :class:`Element` instance. + + .. versionadded:: 3.2 + + +.. function:: iselement(element) + + Checks if an object appears to be a valid element object. *element* is an + element instance. Returns a true value if this is an element object. + + +.. function:: iterparse(source, events=None, parser=None) + + Parses an XML section into an element tree incrementally, and reports what's + going on to the user. *source* is a filename or :term:`file object` + containing XML data. *events* is a sequence of events to report back. The + supported events are the strings ``"start"``, ``"end"``, ``"start-ns"`` and + ``"end-ns"`` (the "ns" events are used to get detailed namespace + information). If *events* is omitted, only ``"end"`` events are reported. + *parser* is an optional parser instance. If not given, the standard + :class:`XMLParser` parser is used. *parser* must be a subclass of + :class:`XMLParser` and can only use the default :class:`TreeBuilder` as a + target. Returns an :term:`iterator` providing ``(event, elem)`` pairs. + + Note that while :func:`iterparse` builds the tree incrementally, it issues + blocking reads on *source* (or the file it names). As such, it's unsuitable + for applications where blocking reads can't be made. For fully non-blocking + parsing, see :class:`XMLPullParser`. + + .. note:: + + :func:`iterparse` only guarantees that it has seen the ">" character of a + starting tag when it emits a "start" event, so the attributes are defined, + but the contents of the text and tail attributes are undefined at that + point. The same applies to the element children; they may or may not be + present. + + If you need a fully populated element, look for "end" events instead. + + .. deprecated:: 3.4 + The *parser* argument. + +.. function:: parse(source, parser=None) + + Parses an XML section into an element tree. *source* is a filename or file + object containing XML data. *parser* is an optional parser instance. If + not given, the standard :class:`XMLParser` parser is used. Returns an + :class:`ElementTree` instance. + + +.. function:: ProcessingInstruction(target, text=None) + + PI element factory. This factory function creates a special element that + will be serialized as an XML processing instruction. *target* is a string + containing the PI target. *text* is a string containing the PI contents, if + given. Returns an element instance, representing a processing instruction. + + Note that :class:`XMLParser` skips over processing instructions + in the input instead of creating comment objects for them. An + :class:`ElementTree` will only contain processing instruction nodes if + they have been inserted into to the tree using one of the + :class:`Element` methods. + +.. function:: register_namespace(prefix, uri) + + Registers a namespace prefix. The registry is global, and any existing + mapping for either the given prefix or the namespace URI will be removed. + *prefix* is a namespace prefix. *uri* is a namespace uri. Tags and + attributes in this namespace will be serialized with the given prefix, if at + all possible. + + .. versionadded:: 3.2 + + +.. function:: SubElement(parent, tag, attrib={}, **extra) + + Subelement factory. This function creates an element instance, and appends + it to an existing element. + + The element name, attribute names, and attribute values can be either + bytestrings or Unicode strings. *parent* is the parent element. *tag* is + the subelement name. *attrib* is an optional dictionary, containing element + attributes. *extra* contains additional attributes, given as keyword + arguments. Returns an element instance. + + +.. function:: tostring(element, encoding="us-ascii", method="xml", *, \ + short_empty_elements=True) + + Generates a string representation of an XML element, including all + subelements. *element* is an :class:`Element` instance. *encoding* [1]_ is + the output encoding (default is US-ASCII). Use ``encoding="unicode"`` to + generate a Unicode string (otherwise, a bytestring is generated). *method* + is either ``"xml"``, ``"html"`` or ``"text"`` (default is ``"xml"``). + *short_empty_elements* has the same meaning as in :meth:`ElementTree.write`. + Returns an (optionally) encoded string containing the XML data. + + .. versionadded:: 3.4 + The *short_empty_elements* parameter. + + +.. function:: tostringlist(element, encoding="us-ascii", method="xml", *, \ + short_empty_elements=True) + + Generates a string representation of an XML element, including all + subelements. *element* is an :class:`Element` instance. *encoding* [1]_ is + the output encoding (default is US-ASCII). Use ``encoding="unicode"`` to + generate a Unicode string (otherwise, a bytestring is generated). *method* + is either ``"xml"``, ``"html"`` or ``"text"`` (default is ``"xml"``). + *short_empty_elements* has the same meaning as in :meth:`ElementTree.write`. + Returns a list of (optionally) encoded strings containing the XML data. + It does not guarantee any specific sequence, except that + ``b"".join(tostringlist(element)) == tostring(element)``. + + .. versionadded:: 3.2 + + .. versionadded:: 3.4 + The *short_empty_elements* parameter. + + +.. function:: XML(text, parser=None) + + Parses an XML section from a string constant. This function can be used to + embed "XML literals" in Python code. *text* is a string containing XML + data. *parser* is an optional parser instance. If not given, the standard + :class:`XMLParser` parser is used. Returns an :class:`Element` instance. + + +.. function:: XMLID(text, parser=None) + + Parses an XML section from a string constant, and also returns a dictionary + which maps from element id:s to elements. *text* is a string containing XML + data. *parser* is an optional parser instance. If not given, the standard + :class:`XMLParser` parser is used. Returns a tuple containing an + :class:`Element` instance and a dictionary. + + +.. _elementtree-element-objects: + +Element Objects +^^^^^^^^^^^^^^^ + +.. class:: Element(tag, attrib={}, **extra) + + Element class. This class defines the Element interface, and provides a + reference implementation of this interface. + + The element name, attribute names, and attribute values can be either + bytestrings or Unicode strings. *tag* is the element name. *attrib* is + an optional dictionary, containing element attributes. *extra* contains + additional attributes, given as keyword arguments. + + + .. attribute:: tag + + A string identifying what kind of data this element represents (the + element type, in other words). + + + .. attribute:: text + tail + + These attributes can be used to hold additional data associated with + the element. Their values are usually strings but may be any + application-specific object. If the element is created from + an XML file, the *text* attribute holds either the text between + the element's start tag and its first child or end tag, or ``None``, and + the *tail* attribute holds either the text between the element's + end tag and the next tag, or ``None``. For the XML data + + .. code-block:: xml + + 1234 + + the *a* element has ``None`` for both *text* and *tail* attributes, + the *b* element has *text* ``"1"`` and *tail* ``"4"``, + the *c* element has *text* ``"2"`` and *tail* ``None``, + and the *d* element has *text* ``None`` and *tail* ``"3"``. + + To collect the inner text of an element, see :meth:`itertext`, for + example ``"".join(element.itertext())``. + + Applications may store arbitrary objects in these attributes. + + + .. attribute:: attrib + + A dictionary containing the element's attributes. Note that while the + *attrib* value is always a real mutable Python dictionary, an ElementTree + implementation may choose to use another internal representation, and + create the dictionary only if someone asks for it. To take advantage of + such implementations, use the dictionary methods below whenever possible. + + The following dictionary-like methods work on the element attributes. + + + .. method:: clear() + + Resets an element. This function removes all subelements, clears all + attributes, and sets the text and tail attributes to ``None``. + + + .. method:: get(key, default=None) + + Gets the element attribute named *key*. + + Returns the attribute value, or *default* if the attribute was not found. + + + .. method:: items() + + Returns the element attributes as a sequence of (name, value) pairs. The + attributes are returned in an arbitrary order. + + + .. method:: keys() + + Returns the elements attribute names as a list. The names are returned + in an arbitrary order. + + + .. method:: set(key, value) + + Set the attribute *key* on the element to *value*. + + The following methods work on the element's children (subelements). + + + .. method:: append(subelement) + + Adds the element *subelement* to the end of this element's internal list + of subelements. Raises :exc:`TypeError` if *subelement* is not an + :class:`Element`. + + + .. method:: extend(subelements) + + Appends *subelements* from a sequence object with zero or more elements. + Raises :exc:`TypeError` if a subelement is not an :class:`Element`. + + .. versionadded:: 3.2 + + + .. method:: find(match, namespaces=None) + + Finds the first subelement matching *match*. *match* may be a tag name + or a :ref:`path `. Returns an element instance + or ``None``. *namespaces* is an optional mapping from namespace prefix + to full name. + + + .. method:: findall(match, namespaces=None) + + Finds all matching subelements, by tag name or + :ref:`path `. Returns a list containing all matching + elements in document order. *namespaces* is an optional mapping from + namespace prefix to full name. + + + .. method:: findtext(match, default=None, namespaces=None) + + Finds text for the first subelement matching *match*. *match* may be + a tag name or a :ref:`path `. Returns the text content + of the first matching element, or *default* if no element was found. + Note that if the matching element has no text content an empty string + is returned. *namespaces* is an optional mapping from namespace prefix + to full name. + + + .. method:: getchildren() + + .. deprecated:: 3.2 + Use ``list(elem)`` or iteration. + + + .. method:: getiterator(tag=None) + + .. deprecated:: 3.2 + Use method :meth:`Element.iter` instead. + + + .. method:: insert(index, subelement) + + Inserts *subelement* at the given position in this element. Raises + :exc:`TypeError` if *subelement* is not an :class:`Element`. + + + .. method:: iter(tag=None) + + Creates a tree :term:`iterator` with the current element as the root. + The iterator iterates over this element and all elements below it, in + document (depth first) order. If *tag* is not ``None`` or ``'*'``, only + elements whose tag equals *tag* are returned from the iterator. If the + tree structure is modified during iteration, the result is undefined. + + .. versionadded:: 3.2 + + + .. method:: iterfind(match, namespaces=None) + + Finds all matching subelements, by tag name or + :ref:`path `. Returns an iterable yielding all + matching elements in document order. *namespaces* is an optional mapping + from namespace prefix to full name. + + + .. versionadded:: 3.2 + + + .. method:: itertext() + + Creates a text iterator. The iterator loops over this element and all + subelements, in document order, and returns all inner text. + + .. versionadded:: 3.2 + + + .. method:: makeelement(tag, attrib) + + Creates a new element object of the same type as this element. Do not + call this method, use the :func:`SubElement` factory function instead. + + + .. method:: remove(subelement) + + Removes *subelement* from the element. Unlike the find\* methods this + method compares elements based on the instance identity, not on tag value + or contents. + + :class:`Element` objects also support the following sequence type methods + for working with subelements: :meth:`~object.__delitem__`, + :meth:`~object.__getitem__`, :meth:`~object.__setitem__`, + :meth:`~object.__len__`. + + Caution: Elements with no subelements will test as ``False``. This behavior + will change in future versions. Use specific ``len(elem)`` or ``elem is + None`` test instead. :: + + element = root.find('foo') + + if not element: # careful! + print("element not found, or element has no subelements") + + if element is None: + print("element not found") + + +.. _elementtree-elementtree-objects: + +ElementTree Objects +^^^^^^^^^^^^^^^^^^^ + + +.. class:: ElementTree(element=None, file=None) + + ElementTree wrapper class. This class represents an entire element + hierarchy, and adds some extra support for serialization to and from + standard XML. + + *element* is the root element. The tree is initialized with the contents + of the XML *file* if given. + + + .. method:: _setroot(element) + + Replaces the root element for this tree. This discards the current + contents of the tree, and replaces it with the given element. Use with + care. *element* is an element instance. + + + .. method:: find(match, namespaces=None) + + Same as :meth:`Element.find`, starting at the root of the tree. + + + .. method:: findall(match, namespaces=None) + + Same as :meth:`Element.findall`, starting at the root of the tree. + + + .. method:: findtext(match, default=None, namespaces=None) + + Same as :meth:`Element.findtext`, starting at the root of the tree. + + + .. method:: getiterator(tag=None) + + .. deprecated:: 3.2 + Use method :meth:`ElementTree.iter` instead. + + + .. method:: getroot() + + Returns the root element for this tree. + + + .. method:: iter(tag=None) + + Creates and returns a tree iterator for the root element. The iterator + loops over all elements in this tree, in section order. *tag* is the tag + to look for (default is to return all elements). + + + .. method:: iterfind(match, namespaces=None) + + Same as :meth:`Element.iterfind`, starting at the root of the tree. + + .. versionadded:: 3.2 + + + .. method:: parse(source, parser=None) + + Loads an external XML section into this element tree. *source* is a file + name or :term:`file object`. *parser* is an optional parser instance. + If not given, the standard :class:`XMLParser` parser is used. Returns the + section root element. + + + .. method:: write(file, encoding="us-ascii", xml_declaration=None, \ + default_namespace=None, method="xml", *, \ + short_empty_elements=True) + + Writes the element tree to a file, as XML. *file* is a file name, or a + :term:`file object` opened for writing. *encoding* [1]_ is the output + encoding (default is US-ASCII). + *xml_declaration* controls if an XML declaration should be added to the + file. Use ``False`` for never, ``True`` for always, ``None`` + for only if not US-ASCII or UTF-8 or Unicode (default is ``None``). + *default_namespace* sets the default XML namespace (for "xmlns"). + *method* is either ``"xml"``, ``"html"`` or ``"text"`` (default is + ``"xml"``). + The keyword-only *short_empty_elements* parameter controls the formatting + of elements that contain no content. If ``True`` (the default), they are + emitted as a single self-closed tag, otherwise they are emitted as a pair + of start/end tags. + + The output is either a string (:class:`str`) or binary (:class:`bytes`). + This is controlled by the *encoding* argument. If *encoding* is + ``"unicode"``, the output is a string; otherwise, it's binary. Note that + this may conflict with the type of *file* if it's an open + :term:`file object`; make sure you do not try to write a string to a + binary stream and vice versa. + + .. versionadded:: 3.4 + The *short_empty_elements* parameter. + + +This is the XML file that is going to be manipulated:: + + + + Example page + + +

    Moved to example.org + or example.com.

    + + + +Example of changing the attribute "target" of every link in first paragraph:: + + >>> from xml.etree.ElementTree import ElementTree + >>> tree = ElementTree() + >>> tree.parse("index.xhtml") + + >>> p = tree.find("body/p") # Finds first occurrence of tag p in body + >>> p + + >>> links = list(p.iter("a")) # Returns list of all links + >>> links + [, ] + >>> for i in links: # Iterates through all found links + ... i.attrib["target"] = "blank" + >>> tree.write("output.xhtml") + +.. _elementtree-qname-objects: + +QName Objects +^^^^^^^^^^^^^ + + +.. class:: QName(text_or_uri, tag=None) + + QName wrapper. This can be used to wrap a QName attribute value, in order + to get proper namespace handling on output. *text_or_uri* is a string + containing the QName value, in the form {uri}local, or, if the tag argument + is given, the URI part of a QName. If *tag* is given, the first argument is + interpreted as a URI, and this argument is interpreted as a local name. + :class:`QName` instances are opaque. + + + +.. _elementtree-treebuilder-objects: + +TreeBuilder Objects +^^^^^^^^^^^^^^^^^^^ + + +.. class:: TreeBuilder(element_factory=None) + + Generic element structure builder. This builder converts a sequence of + start, data, and end method calls to a well-formed element structure. You + can use this class to build an element structure using a custom XML parser, + or a parser for some other XML-like format. *element_factory*, when given, + must be a callable accepting two positional arguments: a tag and + a dict of attributes. It is expected to return a new element instance. + + .. method:: close() + + Flushes the builder buffers, and returns the toplevel document + element. Returns an :class:`Element` instance. + + + .. method:: data(data) + + Adds text to the current element. *data* is a string. This should be + either a bytestring, or a Unicode string. + + + .. method:: end(tag) + + Closes the current element. *tag* is the element name. Returns the + closed element. + + + .. method:: start(tag, attrs) + + Opens a new element. *tag* is the element name. *attrs* is a dictionary + containing element attributes. Returns the opened element. + + + In addition, a custom :class:`TreeBuilder` object can provide the + following method: + + .. method:: doctype(name, pubid, system) + + Handles a doctype declaration. *name* is the doctype name. *pubid* is + the public identifier. *system* is the system identifier. This method + does not exist on the default :class:`TreeBuilder` class. + + .. versionadded:: 3.2 + + +.. _elementtree-xmlparser-objects: + +XMLParser Objects +^^^^^^^^^^^^^^^^^ + + +.. class:: XMLParser(html=0, target=None, encoding=None) + + This class is the low-level building block of the module. It uses + :mod:`xml.parsers.expat` for efficient, event-based parsing of XML. It can + be fed XML data incrementally with the :meth:`feed` method, and parsing + events are translated to a push API - by invoking callbacks on the *target* + object. If *target* is omitted, the standard :class:`TreeBuilder` is used. + The *html* argument was historically used for backwards compatibility and is + now deprecated. If *encoding* [1]_ is given, the value overrides the + encoding specified in the XML file. + + .. deprecated:: 3.4 + The *html* argument. The remaining arguments should be passed via + keyword to prepare for the removal of the *html* argument. + + .. method:: close() + + Finishes feeding data to the parser. Returns the result of calling the + ``close()`` method of the *target* passed during construction; by default, + this is the toplevel document element. + + + .. method:: doctype(name, pubid, system) + + .. deprecated:: 3.2 + Define the :meth:`TreeBuilder.doctype` method on a custom TreeBuilder + target. + + + .. method:: feed(data) + + Feeds data to the parser. *data* is encoded data. + + :meth:`XMLParser.feed` calls *target*\'s ``start(tag, attrs_dict)`` method + for each opening tag, its ``end(tag)`` method for each closing tag, and data + is processed by method ``data(data)``. :meth:`XMLParser.close` calls + *target*\'s method ``close()``. :class:`XMLParser` can be used not only for + building a tree structure. This is an example of counting the maximum depth + of an XML file:: + + >>> from xml.etree.ElementTree import XMLParser + >>> class MaxDepth: # The target object of the parser + ... maxDepth = 0 + ... depth = 0 + ... def start(self, tag, attrib): # Called for each opening tag. + ... self.depth += 1 + ... if self.depth > self.maxDepth: + ... self.maxDepth = self.depth + ... def end(self, tag): # Called for each closing tag. + ... self.depth -= 1 + ... def data(self, data): + ... pass # We do not need to do anything with data. + ... def close(self): # Called when all data has been parsed. + ... return self.maxDepth + ... + >>> target = MaxDepth() + >>> parser = XMLParser(target=target) + >>> exampleXml = """ + ... + ... + ... + ... + ... + ... + ... + ... + ... + ... """ + >>> parser.feed(exampleXml) + >>> parser.close() + 4 + + +.. _elementtree-xmlpullparser-objects: + +XMLPullParser Objects +^^^^^^^^^^^^^^^^^^^^^ + +.. class:: XMLPullParser(events=None) + + A pull parser suitable for non-blocking applications. Its input-side API is + similar to that of :class:`XMLParser`, but instead of pushing calls to a + callback target, :class:`XMLPullParser` collects an internal list of parsing + events and lets the user read from it. *events* is a sequence of events to + report back. The supported events are the strings ``"start"``, ``"end"``, + ``"start-ns"`` and ``"end-ns"`` (the "ns" events are used to get detailed + namespace information). If *events* is omitted, only ``"end"`` events are + reported. + + .. method:: feed(data) + + Feed the given bytes data to the parser. + + .. method:: close() + + Signal the parser that the data stream is terminated. Unlike + :meth:`XMLParser.close`, this method always returns :const:`None`. + Any events not yet retrieved when the parser is closed can still be + read with :meth:`read_events`. + + .. method:: read_events() + + Return an iterator over the events which have been encountered in the + data fed to the + parser. The iterator yields ``(event, elem)`` pairs, where *event* is a + string representing the type of event (e.g. ``"end"``) and *elem* is the + encountered :class:`Element` object. + + Events provided in a previous call to :meth:`read_events` will not be + yielded again. Events are consumed from the internal queue only when + they are retrieved from the iterator, so multiple readers iterating in + parallel over iterators obtained from :meth:`read_events` will have + unpredictable results. + + .. note:: + + :class:`XMLPullParser` only guarantees that it has seen the ">" + character of a starting tag when it emits a "start" event, so the + attributes are defined, but the contents of the text and tail attributes + are undefined at that point. The same applies to the element children; + they may or may not be present. + + If you need a fully populated element, look for "end" events instead. + + .. versionadded:: 3.4 + +Exceptions +^^^^^^^^^^ + +.. class:: ParseError + + XML parse error, raised by the various parsing methods in this module when + parsing fails. The string representation of an instance of this exception + will contain a user-friendly error message. In addition, it will have + the following attributes available: + + .. attribute:: code + + A numeric error code from the expat parser. See the documentation of + :mod:`xml.parsers.expat` for the list of error codes and their meanings. + + .. attribute:: position + + A tuple of *line*, *column* numbers, specifying where the error occurred. + +.. rubric:: Footnotes + +.. [1] The encoding string included in XML output should conform to the + appropriate standards. For example, "UTF-8" is valid, but "UTF8" is + not. See https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl + and https://www.iana.org/assignments/character-sets/character-sets.xhtml. diff --git a/python-3.7.4-docs-html/_sources/library/xml.rst.txt b/python-3.7.4-docs-html/_sources/library/xml.rst.txt new file mode 100644 index 0000000..fb86b6f --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/xml.rst.txt @@ -0,0 +1,139 @@ +.. _xml: + +XML Processing Modules +====================== + +.. module:: xml + :synopsis: Package containing XML processing modules + +.. sectionauthor:: Christian Heimes +.. sectionauthor:: Georg Brandl + +**Source code:** :source:`Lib/xml/` + +-------------- + +Python's interfaces for processing XML are grouped in the ``xml`` package. + +.. warning:: + + The XML modules are not secure against erroneous or maliciously + constructed data. If you need to parse untrusted or + unauthenticated data see the :ref:`xml-vulnerabilities` and + :ref:`defused-packages` sections. + +It is important to note that modules in the :mod:`xml` package require that +there be at least one SAX-compliant XML parser available. The Expat parser is +included with Python, so the :mod:`xml.parsers.expat` module will always be +available. + +The documentation for the :mod:`xml.dom` and :mod:`xml.sax` packages are the +definition of the Python bindings for the DOM and SAX interfaces. + +The XML handling submodules are: + +* :mod:`xml.etree.ElementTree`: the ElementTree API, a simple and lightweight + XML processor + +.. + +* :mod:`xml.dom`: the DOM API definition +* :mod:`xml.dom.minidom`: a minimal DOM implementation +* :mod:`xml.dom.pulldom`: support for building partial DOM trees + +.. + +* :mod:`xml.sax`: SAX2 base classes and convenience functions +* :mod:`xml.parsers.expat`: the Expat parser binding + + +.. _xml-vulnerabilities: + +XML vulnerabilities +------------------- + +The XML processing modules are not secure against maliciously constructed data. +An attacker can abuse XML features to carry out denial of service attacks, +access local files, generate network connections to other machines, or +circumvent firewalls. + +The following table gives an overview of the known attacks and whether +the various modules are vulnerable to them. + +========================= ============== =============== ============== ============== ============== +kind sax etree minidom pulldom xmlrpc +========================= ============== =============== ============== ============== ============== +billion laughs **Vulnerable** **Vulnerable** **Vulnerable** **Vulnerable** **Vulnerable** +quadratic blowup **Vulnerable** **Vulnerable** **Vulnerable** **Vulnerable** **Vulnerable** +external entity expansion Safe (4) Safe (1) Safe (2) Safe (4) Safe (3) +`DTD`_ retrieval Safe (4) Safe Safe Safe (4) Safe +decompression bomb Safe Safe Safe Safe **Vulnerable** +========================= ============== =============== ============== ============== ============== + +1. :mod:`xml.etree.ElementTree` doesn't expand external entities and raises a + :exc:`ParserError` when an entity occurs. +2. :mod:`xml.dom.minidom` doesn't expand external entities and simply returns + the unexpanded entity verbatim. +3. :mod:`xmlrpclib` doesn't expand external entities and omits them. +4. Since Python 3.7.1, external general entities are no longer processed by + default. + + +billion laughs / exponential entity expansion + The `Billion Laughs`_ attack -- also known as exponential entity expansion -- + uses multiple levels of nested entities. Each entity refers to another entity + several times, and the final entity definition contains a small string. + The exponential expansion results in several gigabytes of text and + consumes lots of memory and CPU time. + +quadratic blowup entity expansion + A quadratic blowup attack is similar to a `Billion Laughs`_ attack; it abuses + entity expansion, too. Instead of nested entities it repeats one large entity + with a couple of thousand chars over and over again. The attack isn't as + efficient as the exponential case but it avoids triggering parser countermeasures + that forbid deeply-nested entities. + +external entity expansion + Entity declarations can contain more than just text for replacement. They can + also point to external resources or local files. The XML + parser accesses the resource and embeds the content into the XML document. + +`DTD`_ retrieval + Some XML libraries like Python's :mod:`xml.dom.pulldom` retrieve document type + definitions from remote or local locations. The feature has similar + implications as the external entity expansion issue. + +decompression bomb + Decompression bombs (aka `ZIP bomb`_) apply to all XML libraries + that can parse compressed XML streams such as gzipped HTTP streams or + LZMA-compressed + files. For an attacker it can reduce the amount of transmitted data by three + magnitudes or more. + +The documentation for `defusedxml`_ on PyPI has further information about +all known attack vectors with examples and references. + +.. _defused-packages: + +The :mod:`defusedxml` and :mod:`defusedexpat` Packages +------------------------------------------------------ + +`defusedxml`_ is a pure Python package with modified subclasses of all stdlib +XML parsers that prevent any potentially malicious operation. Use of this +package is recommended for any server code that parses untrusted XML data. The +package also ships with example exploits and extended documentation on more +XML exploits such as XPath injection. + +`defusedexpat`_ provides a modified libexpat and a patched +:mod:`pyexpat` module that have countermeasures against entity expansion +DoS attacks. The :mod:`defusedexpat` module still allows a sane and configurable amount of entity +expansions. The modifications may be included in some future release of Python, +but will not be included in any bugfix releases of +Python because they break backward compatibility. + + +.. _defusedxml: https://pypi.org/project/defusedxml/ +.. _defusedexpat: https://pypi.org/project/defusedexpat/ +.. _Billion Laughs: https://en.wikipedia.org/wiki/Billion_laughs +.. _ZIP bomb: https://en.wikipedia.org/wiki/Zip_bomb +.. _DTD: https://en.wikipedia.org/wiki/Document_type_definition diff --git a/python-3.7.4-docs-html/_sources/library/xml.sax.handler.rst.txt b/python-3.7.4-docs-html/_sources/library/xml.sax.handler.rst.txt new file mode 100644 index 0000000..ae0877c --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/xml.sax.handler.rst.txt @@ -0,0 +1,415 @@ +:mod:`xml.sax.handler` --- Base classes for SAX handlers +======================================================== + +.. module:: xml.sax.handler + :synopsis: Base classes for SAX event handlers. + +.. moduleauthor:: Lars Marius Garshol +.. sectionauthor:: Martin v. Löwis + +**Source code:** :source:`Lib/xml/sax/handler.py` + +-------------- + +The SAX API defines four kinds of handlers: content handlers, DTD handlers, +error handlers, and entity resolvers. Applications normally only need to +implement those interfaces whose events they are interested in; they can +implement the interfaces in a single object or in multiple objects. Handler +implementations should inherit from the base classes provided in the module +:mod:`xml.sax.handler`, so that all methods get default implementations. + + +.. class:: ContentHandler + + This is the main callback interface in SAX, and the one most important to + applications. The order of events in this interface mirrors the order of the + information in the document. + + +.. class:: DTDHandler + + Handle DTD events. + + This interface specifies only those DTD events required for basic parsing + (unparsed entities and attributes). + + +.. class:: EntityResolver + + Basic interface for resolving entities. If you create an object implementing + this interface, then register the object with your Parser, the parser will call + the method in your object to resolve all external entities. + + +.. class:: ErrorHandler + + Interface used by the parser to present error and warning messages to the + application. The methods of this object control whether errors are immediately + converted to exceptions or are handled in some other way. + +In addition to these classes, :mod:`xml.sax.handler` provides symbolic constants +for the feature and property names. + + +.. data:: feature_namespaces + + | value: ``"http://xml.org/sax/features/namespaces"`` + | true: Perform Namespace processing. + | false: Optionally do not perform Namespace processing (implies + namespace-prefixes; default). + | access: (parsing) read-only; (not parsing) read/write + + +.. data:: feature_namespace_prefixes + + | value: ``"http://xml.org/sax/features/namespace-prefixes"`` + | true: Report the original prefixed names and attributes used for Namespace + declarations. + | false: Do not report attributes used for Namespace declarations, and + optionally do not report original prefixed names (default). + | access: (parsing) read-only; (not parsing) read/write + + +.. data:: feature_string_interning + + | value: ``"http://xml.org/sax/features/string-interning"`` + | true: All element names, prefixes, attribute names, Namespace URIs, and + local names are interned using the built-in intern function. + | false: Names are not necessarily interned, although they may be (default). + | access: (parsing) read-only; (not parsing) read/write + + +.. data:: feature_validation + + | value: ``"http://xml.org/sax/features/validation"`` + | true: Report all validation errors (implies external-general-entities and + external-parameter-entities). + | false: Do not report validation errors. + | access: (parsing) read-only; (not parsing) read/write + + +.. data:: feature_external_ges + + | value: ``"http://xml.org/sax/features/external-general-entities"`` + | true: Include all external general (text) entities. + | false: Do not include external general entities. + | access: (parsing) read-only; (not parsing) read/write + + +.. data:: feature_external_pes + + | value: ``"http://xml.org/sax/features/external-parameter-entities"`` + | true: Include all external parameter entities, including the external DTD + subset. + | false: Do not include any external parameter entities, even the external + DTD subset. + | access: (parsing) read-only; (not parsing) read/write + + +.. data:: all_features + + List of all features. + + +.. data:: property_lexical_handler + + | value: ``"http://xml.org/sax/properties/lexical-handler"`` + | data type: xml.sax.sax2lib.LexicalHandler (not supported in Python 2) + | description: An optional extension handler for lexical events like + comments. + | access: read/write + + +.. data:: property_declaration_handler + + | value: ``"http://xml.org/sax/properties/declaration-handler"`` + | data type: xml.sax.sax2lib.DeclHandler (not supported in Python 2) + | description: An optional extension handler for DTD-related events other + than notations and unparsed entities. + | access: read/write + + +.. data:: property_dom_node + + | value: ``"http://xml.org/sax/properties/dom-node"`` + | data type: org.w3c.dom.Node (not supported in Python 2) + | description: When parsing, the current DOM node being visited if this is + a DOM iterator; when not parsing, the root DOM node for iteration. + | access: (parsing) read-only; (not parsing) read/write + + +.. data:: property_xml_string + + | value: ``"http://xml.org/sax/properties/xml-string"`` + | data type: String + | description: The literal string of characters that was the source for the + current event. + | access: read-only + + +.. data:: all_properties + + List of all known property names. + + +.. _content-handler-objects: + +ContentHandler Objects +---------------------- + +Users are expected to subclass :class:`ContentHandler` to support their +application. The following methods are called by the parser on the appropriate +events in the input document: + + +.. method:: ContentHandler.setDocumentLocator(locator) + + Called by the parser to give the application a locator for locating the origin + of document events. + + SAX parsers are strongly encouraged (though not absolutely required) to supply a + locator: if it does so, it must supply the locator to the application by + invoking this method before invoking any of the other methods in the + DocumentHandler interface. + + The locator allows the application to determine the end position of any + document-related event, even if the parser is not reporting an error. Typically, + the application will use this information for reporting its own errors (such as + character content that does not match an application's business rules). The + information returned by the locator is probably not sufficient for use with a + search engine. + + Note that the locator will return correct information only during the invocation + of the events in this interface. The application should not attempt to use it at + any other time. + + +.. method:: ContentHandler.startDocument() + + Receive notification of the beginning of a document. + + The SAX parser will invoke this method only once, before any other methods in + this interface or in DTDHandler (except for :meth:`setDocumentLocator`). + + +.. method:: ContentHandler.endDocument() + + Receive notification of the end of a document. + + The SAX parser will invoke this method only once, and it will be the last method + invoked during the parse. The parser shall not invoke this method until it has + either abandoned parsing (because of an unrecoverable error) or reached the end + of input. + + +.. method:: ContentHandler.startPrefixMapping(prefix, uri) + + Begin the scope of a prefix-URI Namespace mapping. + + The information from this event is not necessary for normal Namespace + processing: the SAX XML reader will automatically replace prefixes for element + and attribute names when the ``feature_namespaces`` feature is enabled (the + default). + + There are cases, however, when applications need to use prefixes in character + data or in attribute values, where they cannot safely be expanded automatically; + the :meth:`startPrefixMapping` and :meth:`endPrefixMapping` events supply the + information to the application to expand prefixes in those contexts itself, if + necessary. + + .. XXX This is not really the default, is it? MvL + + Note that :meth:`startPrefixMapping` and :meth:`endPrefixMapping` events are not + guaranteed to be properly nested relative to each-other: all + :meth:`startPrefixMapping` events will occur before the corresponding + :meth:`startElement` event, and all :meth:`endPrefixMapping` events will occur + after the corresponding :meth:`endElement` event, but their order is not + guaranteed. + + +.. method:: ContentHandler.endPrefixMapping(prefix) + + End the scope of a prefix-URI mapping. + + See :meth:`startPrefixMapping` for details. This event will always occur after + the corresponding :meth:`endElement` event, but the order of + :meth:`endPrefixMapping` events is not otherwise guaranteed. + + +.. method:: ContentHandler.startElement(name, attrs) + + Signals the start of an element in non-namespace mode. + + The *name* parameter contains the raw XML 1.0 name of the element type as a + string and the *attrs* parameter holds an object of the + :class:`~xml.sax.xmlreader.Attributes` + interface (see :ref:`attributes-objects`) containing the attributes of + the element. The object passed as *attrs* may be re-used by the parser; holding + on to a reference to it is not a reliable way to keep a copy of the attributes. + To keep a copy of the attributes, use the :meth:`copy` method of the *attrs* + object. + + +.. method:: ContentHandler.endElement(name) + + Signals the end of an element in non-namespace mode. + + The *name* parameter contains the name of the element type, just as with the + :meth:`startElement` event. + + +.. method:: ContentHandler.startElementNS(name, qname, attrs) + + Signals the start of an element in namespace mode. + + The *name* parameter contains the name of the element type as a ``(uri, + localname)`` tuple, the *qname* parameter contains the raw XML 1.0 name used in + the source document, and the *attrs* parameter holds an instance of the + :class:`~xml.sax.xmlreader.AttributesNS` interface (see + :ref:`attributes-ns-objects`) + containing the attributes of the element. If no namespace is associated with + the element, the *uri* component of *name* will be ``None``. The object passed + as *attrs* may be re-used by the parser; holding on to a reference to it is not + a reliable way to keep a copy of the attributes. To keep a copy of the + attributes, use the :meth:`copy` method of the *attrs* object. + + Parsers may set the *qname* parameter to ``None``, unless the + ``feature_namespace_prefixes`` feature is activated. + + +.. method:: ContentHandler.endElementNS(name, qname) + + Signals the end of an element in namespace mode. + + The *name* parameter contains the name of the element type, just as with the + :meth:`startElementNS` method, likewise the *qname* parameter. + + +.. method:: ContentHandler.characters(content) + + Receive notification of character data. + + The Parser will call this method to report each chunk of character data. SAX + parsers may return all contiguous character data in a single chunk, or they may + split it into several chunks; however, all of the characters in any single event + must come from the same external entity so that the Locator provides useful + information. + + *content* may be a string or bytes instance; the ``expat`` reader module + always produces strings. + + .. note:: + + The earlier SAX 1 interface provided by the Python XML Special Interest Group + used a more Java-like interface for this method. Since most parsers used from + Python did not take advantage of the older interface, the simpler signature was + chosen to replace it. To convert old code to the new interface, use *content* + instead of slicing content with the old *offset* and *length* parameters. + + +.. method:: ContentHandler.ignorableWhitespace(whitespace) + + Receive notification of ignorable whitespace in element content. + + Validating Parsers must use this method to report each chunk of ignorable + whitespace (see the W3C XML 1.0 recommendation, section 2.10): non-validating + parsers may also use this method if they are capable of parsing and using + content models. + + SAX parsers may return all contiguous whitespace in a single chunk, or they may + split it into several chunks; however, all of the characters in any single event + must come from the same external entity, so that the Locator provides useful + information. + + +.. method:: ContentHandler.processingInstruction(target, data) + + Receive notification of a processing instruction. + + The Parser will invoke this method once for each processing instruction found: + note that processing instructions may occur before or after the main document + element. + + A SAX parser should never report an XML declaration (XML 1.0, section 2.8) or a + text declaration (XML 1.0, section 4.3.1) using this method. + + +.. method:: ContentHandler.skippedEntity(name) + + Receive notification of a skipped entity. + + The Parser will invoke this method once for each entity skipped. Non-validating + processors may skip entities if they have not seen the declarations (because, + for example, the entity was declared in an external DTD subset). All processors + may skip external entities, depending on the values of the + ``feature_external_ges`` and the ``feature_external_pes`` properties. + + +.. _dtd-handler-objects: + +DTDHandler Objects +------------------ + +:class:`DTDHandler` instances provide the following methods: + + +.. method:: DTDHandler.notationDecl(name, publicId, systemId) + + Handle a notation declaration event. + + +.. method:: DTDHandler.unparsedEntityDecl(name, publicId, systemId, ndata) + + Handle an unparsed entity declaration event. + + +.. _entity-resolver-objects: + +EntityResolver Objects +---------------------- + + +.. method:: EntityResolver.resolveEntity(publicId, systemId) + + Resolve the system identifier of an entity and return either the system + identifier to read from as a string, or an InputSource to read from. The default + implementation returns *systemId*. + + +.. _sax-error-handler: + +ErrorHandler Objects +-------------------- + +Objects with this interface are used to receive error and warning information +from the :class:`~xml.sax.xmlreader.XMLReader`. If you create an object that +implements this interface, then register the object with your +:class:`~xml.sax.xmlreader.XMLReader`, the parser +will call the methods in your object to report all warnings and errors. There +are three levels of errors available: warnings, (possibly) recoverable errors, +and unrecoverable errors. All methods take a :exc:`SAXParseException` as the +only parameter. Errors and warnings may be converted to an exception by raising +the passed-in exception object. + + +.. method:: ErrorHandler.error(exception) + + Called when the parser encounters a recoverable error. If this method does not + raise an exception, parsing may continue, but further document information + should not be expected by the application. Allowing the parser to continue may + allow additional errors to be discovered in the input document. + + +.. method:: ErrorHandler.fatalError(exception) + + Called when the parser encounters an error it cannot recover from; parsing is + expected to terminate when this method returns. + + +.. method:: ErrorHandler.warning(exception) + + Called when the parser presents minor warning information to the application. + Parsing is expected to continue when this method returns, and document + information will continue to be passed to the application. Raising an exception + in this method will cause parsing to end. + diff --git a/python-3.7.4-docs-html/_sources/library/xml.sax.reader.rst.txt b/python-3.7.4-docs-html/_sources/library/xml.sax.reader.rst.txt new file mode 100644 index 0000000..1b6e431 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/xml.sax.reader.rst.txt @@ -0,0 +1,393 @@ +:mod:`xml.sax.xmlreader` --- Interface for XML parsers +====================================================== + +.. module:: xml.sax.xmlreader + :synopsis: Interface which SAX-compliant XML parsers must implement. + +.. moduleauthor:: Lars Marius Garshol +.. sectionauthor:: Martin v. Löwis + +**Source code:** :source:`Lib/xml/sax/xmlreader.py` + +-------------- + +SAX parsers implement the :class:`XMLReader` interface. They are implemented in +a Python module, which must provide a function :func:`create_parser`. This +function is invoked by :func:`xml.sax.make_parser` with no arguments to create +a new parser object. + + +.. class:: XMLReader() + + Base class which can be inherited by SAX parsers. + + +.. class:: IncrementalParser() + + In some cases, it is desirable not to parse an input source at once, but to feed + chunks of the document as they get available. Note that the reader will normally + not read the entire file, but read it in chunks as well; still :meth:`parse` + won't return until the entire document is processed. So these interfaces should + be used if the blocking behaviour of :meth:`parse` is not desirable. + + When the parser is instantiated it is ready to begin accepting data from the + feed method immediately. After parsing has been finished with a call to close + the reset method must be called to make the parser ready to accept new data, + either from feed or using the parse method. + + Note that these methods must *not* be called during parsing, that is, after + parse has been called and before it returns. + + By default, the class also implements the parse method of the XMLReader + interface using the feed, close and reset methods of the IncrementalParser + interface as a convenience to SAX 2.0 driver writers. + + +.. class:: Locator() + + Interface for associating a SAX event with a document location. A locator object + will return valid results only during calls to DocumentHandler methods; at any + other time, the results are unpredictable. If information is not available, + methods may return ``None``. + + +.. class:: InputSource(system_id=None) + + Encapsulation of the information needed by the :class:`XMLReader` to read + entities. + + This class may include information about the public identifier, system + identifier, byte stream (possibly with character encoding information) and/or + the character stream of an entity. + + Applications will create objects of this class for use in the + :meth:`XMLReader.parse` method and for returning from + EntityResolver.resolveEntity. + + An :class:`InputSource` belongs to the application, the :class:`XMLReader` is + not allowed to modify :class:`InputSource` objects passed to it from the + application, although it may make copies and modify those. + + +.. class:: AttributesImpl(attrs) + + This is an implementation of the :class:`Attributes` interface (see section + :ref:`attributes-objects`). This is a dictionary-like object which + represents the element attributes in a :meth:`startElement` call. In addition + to the most useful dictionary operations, it supports a number of other + methods as described by the interface. Objects of this class should be + instantiated by readers; *attrs* must be a dictionary-like object containing + a mapping from attribute names to attribute values. + + +.. class:: AttributesNSImpl(attrs, qnames) + + Namespace-aware variant of :class:`AttributesImpl`, which will be passed to + :meth:`startElementNS`. It is derived from :class:`AttributesImpl`, but + understands attribute names as two-tuples of *namespaceURI* and + *localname*. In addition, it provides a number of methods expecting qualified + names as they appear in the original document. This class implements the + :class:`AttributesNS` interface (see section :ref:`attributes-ns-objects`). + + +.. _xmlreader-objects: + +XMLReader Objects +----------------- + +The :class:`XMLReader` interface supports the following methods: + + +.. method:: XMLReader.parse(source) + + Process an input source, producing SAX events. The *source* object can be a + system identifier (a string identifying the input source -- typically a file + name or a URL), a file-like object, or an :class:`InputSource` object. When + :meth:`parse` returns, the input is completely processed, and the parser object + can be discarded or reset. + + .. versionchanged:: 3.5 + Added support of character streams. + + +.. method:: XMLReader.getContentHandler() + + Return the current :class:`~xml.sax.handler.ContentHandler`. + + +.. method:: XMLReader.setContentHandler(handler) + + Set the current :class:`~xml.sax.handler.ContentHandler`. If no + :class:`~xml.sax.handler.ContentHandler` is set, content events will be + discarded. + + +.. method:: XMLReader.getDTDHandler() + + Return the current :class:`~xml.sax.handler.DTDHandler`. + + +.. method:: XMLReader.setDTDHandler(handler) + + Set the current :class:`~xml.sax.handler.DTDHandler`. If no + :class:`~xml.sax.handler.DTDHandler` is set, DTD + events will be discarded. + + +.. method:: XMLReader.getEntityResolver() + + Return the current :class:`~xml.sax.handler.EntityResolver`. + + +.. method:: XMLReader.setEntityResolver(handler) + + Set the current :class:`~xml.sax.handler.EntityResolver`. If no + :class:`~xml.sax.handler.EntityResolver` is set, + attempts to resolve an external entity will result in opening the system + identifier for the entity, and fail if it is not available. + + +.. method:: XMLReader.getErrorHandler() + + Return the current :class:`~xml.sax.handler.ErrorHandler`. + + +.. method:: XMLReader.setErrorHandler(handler) + + Set the current error handler. If no :class:`~xml.sax.handler.ErrorHandler` + is set, errors will be raised as exceptions, and warnings will be printed. + + +.. method:: XMLReader.setLocale(locale) + + Allow an application to set the locale for errors and warnings. + + SAX parsers are not required to provide localization for errors and warnings; if + they cannot support the requested locale, however, they must raise a SAX + exception. Applications may request a locale change in the middle of a parse. + + +.. method:: XMLReader.getFeature(featurename) + + Return the current setting for feature *featurename*. If the feature is not + recognized, :exc:`SAXNotRecognizedException` is raised. The well-known + featurenames are listed in the module :mod:`xml.sax.handler`. + + +.. method:: XMLReader.setFeature(featurename, value) + + Set the *featurename* to *value*. If the feature is not recognized, + :exc:`SAXNotRecognizedException` is raised. If the feature or its setting is not + supported by the parser, *SAXNotSupportedException* is raised. + + +.. method:: XMLReader.getProperty(propertyname) + + Return the current setting for property *propertyname*. If the property is not + recognized, a :exc:`SAXNotRecognizedException` is raised. The well-known + propertynames are listed in the module :mod:`xml.sax.handler`. + + +.. method:: XMLReader.setProperty(propertyname, value) + + Set the *propertyname* to *value*. If the property is not recognized, + :exc:`SAXNotRecognizedException` is raised. If the property or its setting is + not supported by the parser, *SAXNotSupportedException* is raised. + + +.. _incremental-parser-objects: + +IncrementalParser Objects +------------------------- + +Instances of :class:`IncrementalParser` offer the following additional methods: + + +.. method:: IncrementalParser.feed(data) + + Process a chunk of *data*. + + +.. method:: IncrementalParser.close() + + Assume the end of the document. That will check well-formedness conditions that + can be checked only at the end, invoke handlers, and may clean up resources + allocated during parsing. + + +.. method:: IncrementalParser.reset() + + This method is called after close has been called to reset the parser so that it + is ready to parse new documents. The results of calling parse or feed after + close without calling reset are undefined. + + +.. _locator-objects: + +Locator Objects +--------------- + +Instances of :class:`Locator` provide these methods: + + +.. method:: Locator.getColumnNumber() + + Return the column number where the current event begins. + + +.. method:: Locator.getLineNumber() + + Return the line number where the current event begins. + + +.. method:: Locator.getPublicId() + + Return the public identifier for the current event. + + +.. method:: Locator.getSystemId() + + Return the system identifier for the current event. + + +.. _input-source-objects: + +InputSource Objects +------------------- + + +.. method:: InputSource.setPublicId(id) + + Sets the public identifier of this :class:`InputSource`. + + +.. method:: InputSource.getPublicId() + + Returns the public identifier of this :class:`InputSource`. + + +.. method:: InputSource.setSystemId(id) + + Sets the system identifier of this :class:`InputSource`. + + +.. method:: InputSource.getSystemId() + + Returns the system identifier of this :class:`InputSource`. + + +.. method:: InputSource.setEncoding(encoding) + + Sets the character encoding of this :class:`InputSource`. + + The encoding must be a string acceptable for an XML encoding declaration (see + section 4.3.3 of the XML recommendation). + + The encoding attribute of the :class:`InputSource` is ignored if the + :class:`InputSource` also contains a character stream. + + +.. method:: InputSource.getEncoding() + + Get the character encoding of this InputSource. + + +.. method:: InputSource.setByteStream(bytefile) + + Set the byte stream (a :term:`binary file`) for this input source. + + The SAX parser will ignore this if there is also a character stream specified, + but it will use a byte stream in preference to opening a URI connection itself. + + If the application knows the character encoding of the byte stream, it should + set it with the setEncoding method. + + +.. method:: InputSource.getByteStream() + + Get the byte stream for this input source. + + The getEncoding method will return the character encoding for this byte stream, + or ``None`` if unknown. + + +.. method:: InputSource.setCharacterStream(charfile) + + Set the character stream (a :term:`text file`) for this input source. + + If there is a character stream specified, the SAX parser will ignore any byte + stream and will not attempt to open a URI connection to the system identifier. + + +.. method:: InputSource.getCharacterStream() + + Get the character stream for this input source. + + +.. _attributes-objects: + +The :class:`Attributes` Interface +--------------------------------- + +:class:`Attributes` objects implement a portion of the :term:`mapping protocol +`, including the methods :meth:`~collections.abc.Mapping.copy`, +:meth:`~collections.abc.Mapping.get`, :meth:`~object.__contains__`, +:meth:`~collections.abc.Mapping.items`, :meth:`~collections.abc.Mapping.keys`, +and :meth:`~collections.abc.Mapping.values`. The following methods +are also provided: + + +.. method:: Attributes.getLength() + + Return the number of attributes. + + +.. method:: Attributes.getNames() + + Return the names of the attributes. + + +.. method:: Attributes.getType(name) + + Returns the type of the attribute *name*, which is normally ``'CDATA'``. + + +.. method:: Attributes.getValue(name) + + Return the value of attribute *name*. + +.. getValueByQName, getNameByQName, getQNameByName, getQNames available +.. here already, but documented only for derived class. + + +.. _attributes-ns-objects: + +The :class:`AttributesNS` Interface +----------------------------------- + +This interface is a subtype of the :class:`Attributes` interface (see section +:ref:`attributes-objects`). All methods supported by that interface are also +available on :class:`AttributesNS` objects. + +The following methods are also available: + + +.. method:: AttributesNS.getValueByQName(name) + + Return the value for a qualified name. + + +.. method:: AttributesNS.getNameByQName(name) + + Return the ``(namespace, localname)`` pair for a qualified *name*. + + +.. method:: AttributesNS.getQNameByName(name) + + Return the qualified name for a ``(namespace, localname)`` pair. + + +.. method:: AttributesNS.getQNames() + + Return the qualified names of all attributes. + diff --git a/python-3.7.4-docs-html/_sources/library/xml.sax.rst.txt b/python-3.7.4-docs-html/_sources/library/xml.sax.rst.txt new file mode 100644 index 0000000..e3460e5 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/xml.sax.rst.txt @@ -0,0 +1,173 @@ +:mod:`xml.sax` --- Support for SAX2 parsers +=========================================== + +.. module:: xml.sax + :synopsis: Package containing SAX2 base classes and convenience functions. + +.. moduleauthor:: Lars Marius Garshol +.. sectionauthor:: Fred L. Drake, Jr. +.. sectionauthor:: Martin v. Löwis + +**Source code:** :source:`Lib/xml/sax/__init__.py` + +-------------- + +The :mod:`xml.sax` package provides a number of modules which implement the +Simple API for XML (SAX) interface for Python. The package itself provides the +SAX exceptions and the convenience functions which will be most used by users of +the SAX API. + + +.. warning:: + + The :mod:`xml.sax` module is not secure against maliciously + constructed data. If you need to parse untrusted or unauthenticated data see + :ref:`xml-vulnerabilities`. + +.. versionchanged:: 3.7.1 + + The SAX parser no longer processes general external entities by default + to increase security. Before, the parser created network connections + to fetch remote files or loaded local files from the file + system for DTD and entities. The feature can be enabled again with method + :meth:`~xml.sax.xmlreader.XMLReader.setFeature` on the parser object + and argument :data:`~xml.sax.handler.feature_external_ges`. + +The convenience functions are: + + +.. function:: make_parser(parser_list=[]) + + Create and return a SAX :class:`~xml.sax.xmlreader.XMLReader` object. The + first parser found will + be used. If *parser_list* is provided, it must be a list of strings which + name modules that have a function named :func:`create_parser`. Modules listed + in *parser_list* will be used before modules in the default list of parsers. + + +.. function:: parse(filename_or_stream, handler, error_handler=handler.ErrorHandler()) + + Create a SAX parser and use it to parse a document. The document, passed in as + *filename_or_stream*, can be a filename or a file object. The *handler* + parameter needs to be a SAX :class:`~handler.ContentHandler` instance. If + *error_handler* is given, it must be a SAX :class:`~handler.ErrorHandler` + instance; if + omitted, :exc:`SAXParseException` will be raised on all errors. There is no + return value; all work must be done by the *handler* passed in. + + +.. function:: parseString(string, handler, error_handler=handler.ErrorHandler()) + + Similar to :func:`parse`, but parses from a buffer *string* received as a + parameter. *string* must be a :class:`str` instance or a + :term:`bytes-like object`. + + .. versionchanged:: 3.5 + Added support of :class:`str` instances. + +A typical SAX application uses three kinds of objects: readers, handlers and +input sources. "Reader" in this context is another term for parser, i.e. some +piece of code that reads the bytes or characters from the input source, and +produces a sequence of events. The events then get distributed to the handler +objects, i.e. the reader invokes a method on the handler. A SAX application +must therefore obtain a reader object, create or open the input sources, create +the handlers, and connect these objects all together. As the final step of +preparation, the reader is called to parse the input. During parsing, methods on +the handler objects are called based on structural and syntactic events from the +input data. + +For these objects, only the interfaces are relevant; they are normally not +instantiated by the application itself. Since Python does not have an explicit +notion of interface, they are formally introduced as classes, but applications +may use implementations which do not inherit from the provided classes. The +:class:`~xml.sax.xmlreader.InputSource`, :class:`~xml.sax.xmlreader.Locator`, +:class:`~xml.sax.xmlreader.Attributes`, :class:`~xml.sax.xmlreader.AttributesNS`, +and :class:`~xml.sax.xmlreader.XMLReader` interfaces are defined in the +module :mod:`xml.sax.xmlreader`. The handler interfaces are defined in +:mod:`xml.sax.handler`. For convenience, +:class:`~xml.sax.xmlreader.InputSource` (which is often +instantiated directly) and the handler classes are also available from +:mod:`xml.sax`. These interfaces are described below. + +In addition to these classes, :mod:`xml.sax` provides the following exception +classes. + + +.. exception:: SAXException(msg, exception=None) + + Encapsulate an XML error or warning. This class can contain basic error or + warning information from either the XML parser or the application: it can be + subclassed to provide additional functionality or to add localization. Note + that although the handlers defined in the + :class:`~xml.sax.handler.ErrorHandler` interface + receive instances of this exception, it is not required to actually raise the + exception --- it is also useful as a container for information. + + When instantiated, *msg* should be a human-readable description of the error. + The optional *exception* parameter, if given, should be ``None`` or an exception + that was caught by the parsing code and is being passed along as information. + + This is the base class for the other SAX exception classes. + + +.. exception:: SAXParseException(msg, exception, locator) + + Subclass of :exc:`SAXException` raised on parse errors. Instances of this + class are passed to the methods of the SAX + :class:`~xml.sax.handler.ErrorHandler` interface to provide information + about the parse error. This class supports the SAX + :class:`~xml.sax.xmlreader.Locator` interface as well as the + :class:`SAXException` interface. + + +.. exception:: SAXNotRecognizedException(msg, exception=None) + + Subclass of :exc:`SAXException` raised when a SAX + :class:`~xml.sax.xmlreader.XMLReader` is + confronted with an unrecognized feature or property. SAX applications and + extensions may use this class for similar purposes. + + +.. exception:: SAXNotSupportedException(msg, exception=None) + + Subclass of :exc:`SAXException` raised when a SAX + :class:`~xml.sax.xmlreader.XMLReader` is asked to + enable a feature that is not supported, or to set a property to a value that the + implementation does not support. SAX applications and extensions may use this + class for similar purposes. + + +.. seealso:: + + `SAX: The Simple API for XML `_ + This site is the focal point for the definition of the SAX API. It provides a + Java implementation and online documentation. Links to implementations and + historical information are also available. + + Module :mod:`xml.sax.handler` + Definitions of the interfaces for application-provided objects. + + Module :mod:`xml.sax.saxutils` + Convenience functions for use in SAX applications. + + Module :mod:`xml.sax.xmlreader` + Definitions of the interfaces for parser-provided objects. + + +.. _sax-exception-objects: + +SAXException Objects +-------------------- + +The :class:`SAXException` exception class supports the following methods: + + +.. method:: SAXException.getMessage() + + Return a human-readable message describing the error condition. + + +.. method:: SAXException.getException() + + Return an encapsulated exception object, or ``None``. + diff --git a/python-3.7.4-docs-html/_sources/library/xml.sax.utils.rst.txt b/python-3.7.4-docs-html/_sources/library/xml.sax.utils.rst.txt new file mode 100644 index 0000000..e46fefd --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/xml.sax.utils.rst.txt @@ -0,0 +1,91 @@ +:mod:`xml.sax.saxutils` --- SAX Utilities +========================================= + +.. module:: xml.sax.saxutils + :synopsis: Convenience functions and classes for use with SAX. + +.. moduleauthor:: Lars Marius Garshol +.. sectionauthor:: Martin v. Löwis + +**Source code:** :source:`Lib/xml/sax/saxutils.py` + +-------------- + +The module :mod:`xml.sax.saxutils` contains a number of classes and functions +that are commonly useful when creating SAX applications, either in direct use, +or as base classes. + + +.. function:: escape(data, entities={}) + + Escape ``'&'``, ``'<'``, and ``'>'`` in a string of data. + + You can escape other strings of data by passing a dictionary as the optional + *entities* parameter. The keys and values must all be strings; each key will be + replaced with its corresponding value. The characters ``'&'``, ``'<'`` and + ``'>'`` are always escaped, even if *entities* is provided. + + +.. function:: unescape(data, entities={}) + + Unescape ``'&'``, ``'<'``, and ``'>'`` in a string of data. + + You can unescape other strings of data by passing a dictionary as the optional + *entities* parameter. The keys and values must all be strings; each key will be + replaced with its corresponding value. ``'&'``, ``'<'``, and ``'>'`` + are always unescaped, even if *entities* is provided. + + +.. function:: quoteattr(data, entities={}) + + Similar to :func:`escape`, but also prepares *data* to be used as an + attribute value. The return value is a quoted version of *data* with any + additional required replacements. :func:`quoteattr` will select a quote + character based on the content of *data*, attempting to avoid encoding any + quote characters in the string. If both single- and double-quote characters + are already in *data*, the double-quote characters will be encoded and *data* + will be wrapped in double-quotes. The resulting string can be used directly + as an attribute value:: + + >>> print("" % quoteattr("ab ' cd \" ef")) + + + This function is useful when generating attribute values for HTML or any SGML + using the reference concrete syntax. + + +.. class:: XMLGenerator(out=None, encoding='iso-8859-1', short_empty_elements=False) + + This class implements the :class:`~xml.sax.handler.ContentHandler` interface + by writing SAX + events back into an XML document. In other words, using an :class:`XMLGenerator` + as the content handler will reproduce the original document being parsed. *out* + should be a file-like object which will default to *sys.stdout*. *encoding* is + the encoding of the output stream which defaults to ``'iso-8859-1'``. + *short_empty_elements* controls the formatting of elements that contain no + content: if ``False`` (the default) they are emitted as a pair of start/end + tags, if set to ``True`` they are emitted as a single self-closed tag. + + .. versionadded:: 3.2 + The *short_empty_elements* parameter. + + +.. class:: XMLFilterBase(base) + + This class is designed to sit between an + :class:`~xml.sax.xmlreader.XMLReader` and the client + application's event handlers. By default, it does nothing but pass requests up + to the reader and events on to the handlers unmodified, but subclasses can + override specific methods to modify the event stream or the configuration + requests as they pass through. + + +.. function:: prepare_input_source(source, base='') + + This function takes an input source and an optional base URL and returns a + fully resolved :class:`~xml.sax.xmlreader.InputSource` object ready for + reading. The input source can be given as a string, a file-like object, or + an :class:`~xml.sax.xmlreader.InputSource` object; parsers will use this + function to implement the polymorphic *source* argument to their + :meth:`parse` method. + diff --git a/python-3.7.4-docs-html/_sources/library/xmlrpc.client.rst.txt b/python-3.7.4-docs-html/_sources/library/xmlrpc.client.rst.txt new file mode 100644 index 0000000..27d92e3 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/xmlrpc.client.rst.txt @@ -0,0 +1,606 @@ +:mod:`xmlrpc.client` --- XML-RPC client access +============================================== + +.. module:: xmlrpc.client + :synopsis: XML-RPC client access. + +.. moduleauthor:: Fredrik Lundh +.. sectionauthor:: Eric S. Raymond + +**Source code:** :source:`Lib/xmlrpc/client.py` + +.. XXX Not everything is documented yet. It might be good to describe + Marshaller, Unmarshaller, getparser and Transport. + +-------------- + +XML-RPC is a Remote Procedure Call method that uses XML passed via HTTP(S) as a +transport. With it, a client can call methods with parameters on a remote +server (the server is named by a URI) and get back structured data. This module +supports writing XML-RPC client code; it handles all the details of translating +between conformable Python objects and XML on the wire. + + +.. warning:: + + The :mod:`xmlrpc.client` module is not secure against maliciously + constructed data. If you need to parse untrusted or unauthenticated data see + :ref:`xml-vulnerabilities`. + +.. versionchanged:: 3.5 + + For HTTPS URIs, :mod:`xmlrpc.client` now performs all the necessary + certificate and hostname checks by default. + +.. class:: ServerProxy(uri, transport=None, encoding=None, verbose=False, \ + allow_none=False, use_datetime=False, \ + use_builtin_types=False, *, context=None) + + .. versionchanged:: 3.3 + The *use_builtin_types* flag was added. + + A :class:`ServerProxy` instance is an object that manages communication with a + remote XML-RPC server. The required first argument is a URI (Uniform Resource + Indicator), and will normally be the URL of the server. The optional second + argument is a transport factory instance; by default it is an internal + :class:`SafeTransport` instance for https: URLs and an internal HTTP + :class:`Transport` instance otherwise. The optional third argument is an + encoding, by default UTF-8. The optional fourth argument is a debugging flag. + + The following parameters govern the use of the returned proxy instance. + If *allow_none* is true, the Python constant ``None`` will be translated into + XML; the default behaviour is for ``None`` to raise a :exc:`TypeError`. This is + a commonly-used extension to the XML-RPC specification, but isn't supported by + all clients and servers; see `http://ontosys.com/xml-rpc/extensions.php + `_ + for a description. + The *use_builtin_types* flag can be used to cause date/time values + to be presented as :class:`datetime.datetime` objects and binary data to be + presented as :class:`bytes` objects; this flag is false by default. + :class:`datetime.datetime`, :class:`bytes` and :class:`bytearray` objects + may be passed to calls. + The obsolete *use_datetime* flag is similar to *use_builtin_types* but it + applies only to date/time values. + + Both the HTTP and HTTPS transports support the URL syntax extension for HTTP + Basic Authentication: ``http://user:pass@host:port/path``. The ``user:pass`` + portion will be base64-encoded as an HTTP 'Authorization' header, and sent to + the remote server as part of the connection process when invoking an XML-RPC + method. You only need to use this if the remote server requires a Basic + Authentication user and password. If an HTTPS URL is provided, *context* may + be :class:`ssl.SSLContext` and configures the SSL settings of the underlying + HTTPS connection. + + The returned instance is a proxy object with methods that can be used to invoke + corresponding RPC calls on the remote server. If the remote server supports the + introspection API, the proxy can also be used to query the remote server for the + methods it supports (service discovery) and fetch other server-associated + metadata. + + Types that are conformable (e.g. that can be marshalled through XML), + include the following (and except where noted, they are unmarshalled + as the same Python type): + + .. tabularcolumns:: |l|L| + + +----------------------+-------------------------------------------------------+ + | XML-RPC type | Python type | + +======================+=======================================================+ + | ``boolean`` | :class:`bool` | + +----------------------+-------------------------------------------------------+ + | ``int``, ``i1``, | :class:`int` in range from -2147483648 to 2147483647. | + | ``i2``, ``i4``, | Values get the ```` tag. | + | ``i8`` or | | + | ``biginteger`` | | + +----------------------+-------------------------------------------------------+ + | ``double`` or | :class:`float`. Values get the ```` tag. | + | ``float`` | | + +----------------------+-------------------------------------------------------+ + | ``string`` | :class:`str` | + +----------------------+-------------------------------------------------------+ + | ``array`` | :class:`list` or :class:`tuple` containing | + | | conformable elements. Arrays are returned as | + | | :class:`lists `. | + +----------------------+-------------------------------------------------------+ + | ``struct`` | :class:`dict`. Keys must be strings, values may be | + | | any conformable type. Objects of user-defined | + | | classes can be passed in; only their | + | | :attr:`~object.__dict__` attribute is transmitted. | + +----------------------+-------------------------------------------------------+ + | ``dateTime.iso8601`` | :class:`DateTime` or :class:`datetime.datetime`. | + | | Returned type depends on values of | + | | *use_builtin_types* and *use_datetime* flags. | + +----------------------+-------------------------------------------------------+ + | ``base64`` | :class:`Binary`, :class:`bytes` or | + | | :class:`bytearray`. Returned type depends on the | + | | value of the *use_builtin_types* flag. | + +----------------------+-------------------------------------------------------+ + | ``nil`` | The ``None`` constant. Passing is allowed only if | + | | *allow_none* is true. | + +----------------------+-------------------------------------------------------+ + | ``bigdecimal`` | :class:`decimal.Decimal`. Returned type only. | + +----------------------+-------------------------------------------------------+ + + This is the full set of data types supported by XML-RPC. Method calls may also + raise a special :exc:`Fault` instance, used to signal XML-RPC server errors, or + :exc:`ProtocolError` used to signal an error in the HTTP/HTTPS transport layer. + Both :exc:`Fault` and :exc:`ProtocolError` derive from a base class called + :exc:`Error`. Note that the xmlrpc client module currently does not marshal + instances of subclasses of built-in types. + + When passing strings, characters special to XML such as ``<``, ``>``, and ``&`` + will be automatically escaped. However, it's the caller's responsibility to + ensure that the string is free of characters that aren't allowed in XML, such as + the control characters with ASCII values between 0 and 31 (except, of course, + tab, newline and carriage return); failing to do this will result in an XML-RPC + request that isn't well-formed XML. If you have to pass arbitrary bytes + via XML-RPC, use :class:`bytes` or :class:`bytearray` classes or the + :class:`Binary` wrapper class described below. + + :class:`Server` is retained as an alias for :class:`ServerProxy` for backwards + compatibility. New code should use :class:`ServerProxy`. + + .. versionchanged:: 3.5 + Added the *context* argument. + + .. versionchanged:: 3.6 + Added support of type tags with prefixes (e.g. ``ex:nil``). + Added support of unmarshalling additional types used by Apache XML-RPC + implementation for numerics: ``i1``, ``i2``, ``i8``, ``biginteger``, + ``float`` and ``bigdecimal``. + See http://ws.apache.org/xmlrpc/types.html for a description. + + +.. seealso:: + + `XML-RPC HOWTO `_ + A good description of XML-RPC operation and client software in several languages. + Contains pretty much everything an XML-RPC client developer needs to know. + + `XML-RPC Introspection `_ + Describes the XML-RPC protocol extension for introspection. + + `XML-RPC Specification `_ + The official specification. + + `Unofficial XML-RPC Errata `_ + Fredrik Lundh's "unofficial errata, intended to clarify certain + details in the XML-RPC specification, as well as hint at + 'best practices' to use when designing your own XML-RPC + implementations." + +.. _serverproxy-objects: + +ServerProxy Objects +------------------- + +A :class:`ServerProxy` instance has a method corresponding to each remote +procedure call accepted by the XML-RPC server. Calling the method performs an +RPC, dispatched by both name and argument signature (e.g. the same method name +can be overloaded with multiple argument signatures). The RPC finishes by +returning a value, which may be either returned data in a conformant type or a +:class:`Fault` or :class:`ProtocolError` object indicating an error. + +Servers that support the XML introspection API support some common methods +grouped under the reserved :attr:`~ServerProxy.system` attribute: + + +.. method:: ServerProxy.system.listMethods() + + This method returns a list of strings, one for each (non-system) method + supported by the XML-RPC server. + + +.. method:: ServerProxy.system.methodSignature(name) + + This method takes one parameter, the name of a method implemented by the XML-RPC + server. It returns an array of possible signatures for this method. A signature + is an array of types. The first of these types is the return type of the method, + the rest are parameters. + + Because multiple signatures (ie. overloading) is permitted, this method returns + a list of signatures rather than a singleton. + + Signatures themselves are restricted to the top level parameters expected by a + method. For instance if a method expects one array of structs as a parameter, + and it returns a string, its signature is simply "string, array". If it expects + three integers and returns a string, its signature is "string, int, int, int". + + If no signature is defined for the method, a non-array value is returned. In + Python this means that the type of the returned value will be something other + than list. + + +.. method:: ServerProxy.system.methodHelp(name) + + This method takes one parameter, the name of a method implemented by the XML-RPC + server. It returns a documentation string describing the use of that method. If + no such string is available, an empty string is returned. The documentation + string may contain HTML markup. + +.. versionchanged:: 3.5 + + Instances of :class:`ServerProxy` support the :term:`context manager` protocol + for closing the underlying transport. + + +A working example follows. The server code:: + + from xmlrpc.server import SimpleXMLRPCServer + + def is_even(n): + return n % 2 == 0 + + server = SimpleXMLRPCServer(("localhost", 8000)) + print("Listening on port 8000...") + server.register_function(is_even, "is_even") + server.serve_forever() + +The client code for the preceding server:: + + import xmlrpc.client + + with xmlrpc.client.ServerProxy("http://localhost:8000/") as proxy: + print("3 is even: %s" % str(proxy.is_even(3))) + print("100 is even: %s" % str(proxy.is_even(100))) + +.. _datetime-objects: + +DateTime Objects +---------------- + +.. class:: DateTime + + This class may be initialized with seconds since the epoch, a time + tuple, an ISO 8601 time/date string, or a :class:`datetime.datetime` + instance. It has the following methods, supported mainly for internal + use by the marshalling/unmarshalling code: + + + .. method:: decode(string) + + Accept a string as the instance's new time value. + + + .. method:: encode(out) + + Write the XML-RPC encoding of this :class:`DateTime` item to the *out* stream + object. + + It also supports certain of Python's built-in operators through rich comparison + and :meth:`__repr__` methods. + +A working example follows. The server code:: + + import datetime + from xmlrpc.server import SimpleXMLRPCServer + import xmlrpc.client + + def today(): + today = datetime.datetime.today() + return xmlrpc.client.DateTime(today) + + server = SimpleXMLRPCServer(("localhost", 8000)) + print("Listening on port 8000...") + server.register_function(today, "today") + server.serve_forever() + +The client code for the preceding server:: + + import xmlrpc.client + import datetime + + proxy = xmlrpc.client.ServerProxy("http://localhost:8000/") + + today = proxy.today() + # convert the ISO8601 string to a datetime object + converted = datetime.datetime.strptime(today.value, "%Y%m%dT%H:%M:%S") + print("Today: %s" % converted.strftime("%d.%m.%Y, %H:%M")) + +.. _binary-objects: + +Binary Objects +-------------- + +.. class:: Binary + + This class may be initialized from bytes data (which may include NULs). The + primary access to the content of a :class:`Binary` object is provided by an + attribute: + + + .. attribute:: data + + The binary data encapsulated by the :class:`Binary` instance. The data is + provided as a :class:`bytes` object. + + :class:`Binary` objects have the following methods, supported mainly for + internal use by the marshalling/unmarshalling code: + + + .. method:: decode(bytes) + + Accept a base64 :class:`bytes` object and decode it as the instance's new data. + + + .. method:: encode(out) + + Write the XML-RPC base 64 encoding of this binary item to the *out* stream object. + + The encoded data will have newlines every 76 characters as per + :rfc:`RFC 2045 section 6.8 <2045#section-6.8>`, + which was the de facto standard base64 specification when the + XML-RPC spec was written. + + It also supports certain of Python's built-in operators through :meth:`__eq__` + and :meth:`__ne__` methods. + +Example usage of the binary objects. We're going to transfer an image over +XMLRPC:: + + from xmlrpc.server import SimpleXMLRPCServer + import xmlrpc.client + + def python_logo(): + with open("python_logo.jpg", "rb") as handle: + return xmlrpc.client.Binary(handle.read()) + + server = SimpleXMLRPCServer(("localhost", 8000)) + print("Listening on port 8000...") + server.register_function(python_logo, 'python_logo') + + server.serve_forever() + +The client gets the image and saves it to a file:: + + import xmlrpc.client + + proxy = xmlrpc.client.ServerProxy("http://localhost:8000/") + with open("fetched_python_logo.jpg", "wb") as handle: + handle.write(proxy.python_logo().data) + +.. _fault-objects: + +Fault Objects +------------- + +.. class:: Fault + + A :class:`Fault` object encapsulates the content of an XML-RPC fault tag. Fault + objects have the following attributes: + + + .. attribute:: faultCode + + A string indicating the fault type. + + + .. attribute:: faultString + + A string containing a diagnostic message associated with the fault. + +In the following example we're going to intentionally cause a :exc:`Fault` by +returning a complex type object. The server code:: + + from xmlrpc.server import SimpleXMLRPCServer + + # A marshalling error is going to occur because we're returning a + # complex number + def add(x, y): + return x+y+0j + + server = SimpleXMLRPCServer(("localhost", 8000)) + print("Listening on port 8000...") + server.register_function(add, 'add') + + server.serve_forever() + +The client code for the preceding server:: + + import xmlrpc.client + + proxy = xmlrpc.client.ServerProxy("http://localhost:8000/") + try: + proxy.add(2, 5) + except xmlrpc.client.Fault as err: + print("A fault occurred") + print("Fault code: %d" % err.faultCode) + print("Fault string: %s" % err.faultString) + + + +.. _protocol-error-objects: + +ProtocolError Objects +--------------------- + +.. class:: ProtocolError + + A :class:`ProtocolError` object describes a protocol error in the underlying + transport layer (such as a 404 'not found' error if the server named by the URI + does not exist). It has the following attributes: + + + .. attribute:: url + + The URI or URL that triggered the error. + + + .. attribute:: errcode + + The error code. + + + .. attribute:: errmsg + + The error message or diagnostic string. + + + .. attribute:: headers + + A dict containing the headers of the HTTP/HTTPS request that triggered the + error. + +In the following example we're going to intentionally cause a :exc:`ProtocolError` +by providing an invalid URI:: + + import xmlrpc.client + + # create a ServerProxy with a URI that doesn't respond to XMLRPC requests + proxy = xmlrpc.client.ServerProxy("http://google.com/") + + try: + proxy.some_method() + except xmlrpc.client.ProtocolError as err: + print("A protocol error occurred") + print("URL: %s" % err.url) + print("HTTP/HTTPS headers: %s" % err.headers) + print("Error code: %d" % err.errcode) + print("Error message: %s" % err.errmsg) + +MultiCall Objects +----------------- + +The :class:`MultiCall` object provides a way to encapsulate multiple calls to a +remote server into a single request [#]_. + + +.. class:: MultiCall(server) + + Create an object used to boxcar method calls. *server* is the eventual target of + the call. Calls can be made to the result object, but they will immediately + return ``None``, and only store the call name and parameters in the + :class:`MultiCall` object. Calling the object itself causes all stored calls to + be transmitted as a single ``system.multicall`` request. The result of this call + is a :term:`generator`; iterating over this generator yields the individual + results. + +A usage example of this class follows. The server code:: + + from xmlrpc.server import SimpleXMLRPCServer + + def add(x, y): + return x + y + + def subtract(x, y): + return x - y + + def multiply(x, y): + return x * y + + def divide(x, y): + return x // y + + # A simple server with simple arithmetic functions + server = SimpleXMLRPCServer(("localhost", 8000)) + print("Listening on port 8000...") + server.register_multicall_functions() + server.register_function(add, 'add') + server.register_function(subtract, 'subtract') + server.register_function(multiply, 'multiply') + server.register_function(divide, 'divide') + server.serve_forever() + +The client code for the preceding server:: + + import xmlrpc.client + + proxy = xmlrpc.client.ServerProxy("http://localhost:8000/") + multicall = xmlrpc.client.MultiCall(proxy) + multicall.add(7, 3) + multicall.subtract(7, 3) + multicall.multiply(7, 3) + multicall.divide(7, 3) + result = multicall() + + print("7+3=%d, 7-3=%d, 7*3=%d, 7//3=%d" % tuple(result)) + + +Convenience Functions +--------------------- + +.. function:: dumps(params, methodname=None, methodresponse=None, encoding=None, allow_none=False) + + Convert *params* into an XML-RPC request. or into a response if *methodresponse* + is true. *params* can be either a tuple of arguments or an instance of the + :exc:`Fault` exception class. If *methodresponse* is true, only a single value + can be returned, meaning that *params* must be of length 1. *encoding*, if + supplied, is the encoding to use in the generated XML; the default is UTF-8. + Python's :const:`None` value cannot be used in standard XML-RPC; to allow using + it via an extension, provide a true value for *allow_none*. + + +.. function:: loads(data, use_datetime=False, use_builtin_types=False) + + Convert an XML-RPC request or response into Python objects, a ``(params, + methodname)``. *params* is a tuple of argument; *methodname* is a string, or + ``None`` if no method name is present in the packet. If the XML-RPC packet + represents a fault condition, this function will raise a :exc:`Fault` exception. + The *use_builtin_types* flag can be used to cause date/time values to be + presented as :class:`datetime.datetime` objects and binary data to be + presented as :class:`bytes` objects; this flag is false by default. + + The obsolete *use_datetime* flag is similar to *use_builtin_types* but it + applies only to date/time values. + + .. versionchanged:: 3.3 + The *use_builtin_types* flag was added. + + +.. _xmlrpc-client-example: + +Example of Client Usage +----------------------- + +:: + + # simple test program (from the XML-RPC specification) + from xmlrpc.client import ServerProxy, Error + + # server = ServerProxy("http://localhost:8000") # local server + with ServerProxy("http://betty.userland.com") as proxy: + + print(proxy) + + try: + print(proxy.examples.getStateName(41)) + except Error as v: + print("ERROR", v) + +To access an XML-RPC server through a HTTP proxy, you need to define a custom +transport. The following example shows how:: + + import http.client + import xmlrpc.client + + class ProxiedTransport(xmlrpc.client.Transport): + + def set_proxy(self, host, port=None, headers=None): + self.proxy = host, port + self.proxy_headers = headers + + def make_connection(self, host): + connection = http.client.HTTPConnection(*self.proxy) + connection.set_tunnel(host, headers=self.proxy_headers) + self._connection = host, connection + return connection + + transport = ProxiedTransport() + transport.set_proxy('proxy-server', 8080) + server = xmlrpc.client.ServerProxy('http://betty.userland.com', transport=transport) + print(server.examples.getStateName(41)) + + +Example of Client and Server Usage +---------------------------------- + +See :ref:`simplexmlrpcserver-example`. + + +.. rubric:: Footnotes + +.. [#] This approach has been first presented in `a discussion on xmlrpc.com + `_. +.. the link now points to webarchive since the one at +.. http://www.xmlrpc.com/discuss/msgReader%241208 is broken (and webadmin +.. doesn't reply) diff --git a/python-3.7.4-docs-html/_sources/library/xmlrpc.rst.txt b/python-3.7.4-docs-html/_sources/library/xmlrpc.rst.txt new file mode 100644 index 0000000..ae68157 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/xmlrpc.rst.txt @@ -0,0 +1,12 @@ +:mod:`xmlrpc` --- XMLRPC server and client modules +================================================== + +XML-RPC is a Remote Procedure Call method that uses XML passed via HTTP as a +transport. With it, a client can call methods with parameters on a remote +server (the server is named by a URI) and get back structured data. + +``xmlrpc`` is a package that collects server and client modules implementing +XML-RPC. The modules are: + +* :mod:`xmlrpc.client` +* :mod:`xmlrpc.server` diff --git a/python-3.7.4-docs-html/_sources/library/xmlrpc.server.rst.txt b/python-3.7.4-docs-html/_sources/library/xmlrpc.server.rst.txt new file mode 100644 index 0000000..7d561e2 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/xmlrpc.server.rst.txt @@ -0,0 +1,445 @@ +:mod:`xmlrpc.server` --- Basic XML-RPC servers +============================================== + +.. module:: xmlrpc.server + :synopsis: Basic XML-RPC server implementations. + +.. moduleauthor:: Brian Quinlan +.. sectionauthor:: Fred L. Drake, Jr. + +**Source code:** :source:`Lib/xmlrpc/server.py` + +-------------- + +The :mod:`xmlrpc.server` module provides a basic server framework for XML-RPC +servers written in Python. Servers can either be free standing, using +:class:`SimpleXMLRPCServer`, or embedded in a CGI environment, using +:class:`CGIXMLRPCRequestHandler`. + + +.. warning:: + + The :mod:`xmlrpc.server` module is not secure against maliciously + constructed data. If you need to parse untrusted or unauthenticated data see + :ref:`xml-vulnerabilities`. + + +.. class:: SimpleXMLRPCServer(addr, requestHandler=SimpleXMLRPCRequestHandler,\ + logRequests=True, allow_none=False, encoding=None,\ + bind_and_activate=True, use_builtin_types=False) + + Create a new server instance. This class provides methods for registration of + functions that can be called by the XML-RPC protocol. The *requestHandler* + parameter should be a factory for request handler instances; it defaults to + :class:`SimpleXMLRPCRequestHandler`. The *addr* and *requestHandler* parameters + are passed to the :class:`socketserver.TCPServer` constructor. If *logRequests* + is true (the default), requests will be logged; setting this parameter to false + will turn off logging. The *allow_none* and *encoding* parameters are passed + on to :mod:`xmlrpc.client` and control the XML-RPC responses that will be returned + from the server. The *bind_and_activate* parameter controls whether + :meth:`server_bind` and :meth:`server_activate` are called immediately by the + constructor; it defaults to true. Setting it to false allows code to manipulate + the *allow_reuse_address* class variable before the address is bound. + The *use_builtin_types* parameter is passed to the + :func:`~xmlrpc.client.loads` function and controls which types are processed + when date/times values or binary data are received; it defaults to false. + + .. versionchanged:: 3.3 + The *use_builtin_types* flag was added. + + +.. class:: CGIXMLRPCRequestHandler(allow_none=False, encoding=None,\ + use_builtin_types=False) + + Create a new instance to handle XML-RPC requests in a CGI environment. The + *allow_none* and *encoding* parameters are passed on to :mod:`xmlrpc.client` + and control the XML-RPC responses that will be returned from the server. + The *use_builtin_types* parameter is passed to the + :func:`~xmlrpc.client.loads` function and controls which types are processed + when date/times values or binary data are received; it defaults to false. + + .. versionchanged:: 3.3 + The *use_builtin_types* flag was added. + + +.. class:: SimpleXMLRPCRequestHandler() + + Create a new request handler instance. This request handler supports ``POST`` + requests and modifies logging so that the *logRequests* parameter to the + :class:`SimpleXMLRPCServer` constructor parameter is honored. + + +.. _simple-xmlrpc-servers: + +SimpleXMLRPCServer Objects +-------------------------- + +The :class:`SimpleXMLRPCServer` class is based on +:class:`socketserver.TCPServer` and provides a means of creating simple, stand +alone XML-RPC servers. + + +.. method:: SimpleXMLRPCServer.register_function(function=None, name=None) + + Register a function that can respond to XML-RPC requests. If *name* is given, + it will be the method name associated with *function*, otherwise + ``function.__name__`` will be used. *name* is a string, and may contain + characters not legal in Python identifiers, including the period character. + + This method can also be used as a decorator. When used as a decorator, + *name* can only be given as a keyword argument to register *function* under + *name*. If no *name* is given, ``function.__name__`` will be used. + + .. versionchanged:: 3.7 + :meth:`register_function` can be used as a decorator. + + +.. method:: SimpleXMLRPCServer.register_instance(instance, allow_dotted_names=False) + + Register an object which is used to expose method names which have not been + registered using :meth:`register_function`. If *instance* contains a + :meth:`_dispatch` method, it is called with the requested method name and the + parameters from the request. Its API is ``def _dispatch(self, method, params)`` + (note that *params* does not represent a variable argument list). If it calls + an underlying function to perform its task, that function is called as + ``func(*params)``, expanding the parameter list. The return value from + :meth:`_dispatch` is returned to the client as the result. If *instance* does + not have a :meth:`_dispatch` method, it is searched for an attribute matching + the name of the requested method. + + If the optional *allow_dotted_names* argument is true and the instance does not + have a :meth:`_dispatch` method, then if the requested method name contains + periods, each component of the method name is searched for individually, with + the effect that a simple hierarchical search is performed. The value found from + this search is then called with the parameters from the request, and the return + value is passed back to the client. + + .. warning:: + + Enabling the *allow_dotted_names* option allows intruders to access your + module's global variables and may allow intruders to execute arbitrary code on + your machine. Only use this option on a secure, closed network. + + +.. method:: SimpleXMLRPCServer.register_introspection_functions() + + Registers the XML-RPC introspection functions ``system.listMethods``, + ``system.methodHelp`` and ``system.methodSignature``. + + +.. method:: SimpleXMLRPCServer.register_multicall_functions() + + Registers the XML-RPC multicall function system.multicall. + + +.. attribute:: SimpleXMLRPCRequestHandler.rpc_paths + + An attribute value that must be a tuple listing valid path portions of the URL + for receiving XML-RPC requests. Requests posted to other paths will result in a + 404 "no such page" HTTP error. If this tuple is empty, all paths will be + considered valid. The default value is ``('/', '/RPC2')``. + + +.. _simplexmlrpcserver-example: + +SimpleXMLRPCServer Example +^^^^^^^^^^^^^^^^^^^^^^^^^^ +Server code:: + + from xmlrpc.server import SimpleXMLRPCServer + from xmlrpc.server import SimpleXMLRPCRequestHandler + + # Restrict to a particular path. + class RequestHandler(SimpleXMLRPCRequestHandler): + rpc_paths = ('/RPC2',) + + # Create server + with SimpleXMLRPCServer(('localhost', 8000), + requestHandler=RequestHandler) as server: + server.register_introspection_functions() + + # Register pow() function; this will use the value of + # pow.__name__ as the name, which is just 'pow'. + server.register_function(pow) + + # Register a function under a different name + def adder_function(x, y): + return x + y + server.register_function(adder_function, 'add') + + # Register an instance; all the methods of the instance are + # published as XML-RPC methods (in this case, just 'mul'). + class MyFuncs: + def mul(self, x, y): + return x * y + + server.register_instance(MyFuncs()) + + # Run the server's main loop + server.serve_forever() + +The following client code will call the methods made available by the preceding +server:: + + import xmlrpc.client + + s = xmlrpc.client.ServerProxy('http://localhost:8000') + print(s.pow(2,3)) # Returns 2**3 = 8 + print(s.add(2,3)) # Returns 5 + print(s.mul(5,2)) # Returns 5*2 = 10 + + # Print list of available methods + print(s.system.listMethods()) + +:meth:`register_function` can also be used as a decorator. The previous server +example can register functions in a decorator way:: + + from xmlrpc.server import SimpleXMLRPCServer + from xmlrpc.server import SimpleXMLRPCRequestHandler + + class RequestHandler(SimpleXMLRPCRequestHandler): + rpc_paths = ('/RPC2',) + + with SimpleXMLRPCServer(('localhost', 8000), + requestHandler=RequestHandler) as server: + server.register_introspection_functions() + + # Register pow() function; this will use the value of + # pow.__name__ as the name, which is just 'pow'. + server.register_function(pow) + + # Register a function under a different name, using + # register_function as a decorator. *name* can only be given + # as a keyword argument. + @server.register_function(name='add') + def adder_function(x, y): + return x + y + + # Register a function under function.__name__. + @server.register_function + def mul(x, y): + return x * y + + server.serve_forever() + +The following example included in the :file:`Lib/xmlrpc/server.py` module shows +a server allowing dotted names and registering a multicall function. + +.. warning:: + + Enabling the *allow_dotted_names* option allows intruders to access your + module's global variables and may allow intruders to execute arbitrary code on + your machine. Only use this example only within a secure, closed network. + +:: + + import datetime + + class ExampleService: + def getData(self): + return '42' + + class currentTime: + @staticmethod + def getCurrentTime(): + return datetime.datetime.now() + + with SimpleXMLRPCServer(("localhost", 8000)) as server: + server.register_function(pow) + server.register_function(lambda x,y: x+y, 'add') + server.register_instance(ExampleService(), allow_dotted_names=True) + server.register_multicall_functions() + print('Serving XML-RPC on localhost port 8000') + try: + server.serve_forever() + except KeyboardInterrupt: + print("\nKeyboard interrupt received, exiting.") + sys.exit(0) + +This ExampleService demo can be invoked from the command line:: + + python -m xmlrpc.server + + +The client that interacts with the above server is included in +`Lib/xmlrpc/client.py`:: + + server = ServerProxy("http://localhost:8000") + + try: + print(server.currentTime.getCurrentTime()) + except Error as v: + print("ERROR", v) + + multi = MultiCall(server) + multi.getData() + multi.pow(2,9) + multi.add(1,2) + try: + for response in multi(): + print(response) + except Error as v: + print("ERROR", v) + +This client which interacts with the demo XMLRPC server can be invoked as:: + + python -m xmlrpc.client + + +CGIXMLRPCRequestHandler +----------------------- + +The :class:`CGIXMLRPCRequestHandler` class can be used to handle XML-RPC +requests sent to Python CGI scripts. + + +.. method:: CGIXMLRPCRequestHandler.register_function(function=None, name=None) + + Register a function that can respond to XML-RPC requests. If *name* is given, + it will be the method name associated with *function*, otherwise + ``function.__name__`` will be used. *name* is a string, and may contain + characters not legal in Python identifiers, including the period character. + + This method can also be used as a decorator. When used as a decorator, + *name* can only be given as a keyword argument to register *function* under + *name*. If no *name* is given, ``function.__name__`` will be used. + + .. versionchanged:: 3.7 + :meth:`register_function` can be used as a decorator. + + +.. method:: CGIXMLRPCRequestHandler.register_instance(instance) + + Register an object which is used to expose method names which have not been + registered using :meth:`register_function`. If instance contains a + :meth:`_dispatch` method, it is called with the requested method name and the + parameters from the request; the return value is returned to the client as the + result. If instance does not have a :meth:`_dispatch` method, it is searched + for an attribute matching the name of the requested method; if the requested + method name contains periods, each component of the method name is searched for + individually, with the effect that a simple hierarchical search is performed. + The value found from this search is then called with the parameters from the + request, and the return value is passed back to the client. + + +.. method:: CGIXMLRPCRequestHandler.register_introspection_functions() + + Register the XML-RPC introspection functions ``system.listMethods``, + ``system.methodHelp`` and ``system.methodSignature``. + + +.. method:: CGIXMLRPCRequestHandler.register_multicall_functions() + + Register the XML-RPC multicall function ``system.multicall``. + + +.. method:: CGIXMLRPCRequestHandler.handle_request(request_text=None) + + Handle an XML-RPC request. If *request_text* is given, it should be the POST + data provided by the HTTP server, otherwise the contents of stdin will be used. + +Example:: + + class MyFuncs: + def mul(self, x, y): + return x * y + + + handler = CGIXMLRPCRequestHandler() + handler.register_function(pow) + handler.register_function(lambda x,y: x+y, 'add') + handler.register_introspection_functions() + handler.register_instance(MyFuncs()) + handler.handle_request() + + +Documenting XMLRPC server +------------------------- + +These classes extend the above classes to serve HTML documentation in response +to HTTP GET requests. Servers can either be free standing, using +:class:`DocXMLRPCServer`, or embedded in a CGI environment, using +:class:`DocCGIXMLRPCRequestHandler`. + + +.. class:: DocXMLRPCServer(addr, requestHandler=DocXMLRPCRequestHandler,\ + logRequests=True, allow_none=False, encoding=None,\ + bind_and_activate=True, use_builtin_types=True) + + Create a new server instance. All parameters have the same meaning as for + :class:`SimpleXMLRPCServer`; *requestHandler* defaults to + :class:`DocXMLRPCRequestHandler`. + + .. versionchanged:: 3.3 + The *use_builtin_types* flag was added. + + +.. class:: DocCGIXMLRPCRequestHandler() + + Create a new instance to handle XML-RPC requests in a CGI environment. + + +.. class:: DocXMLRPCRequestHandler() + + Create a new request handler instance. This request handler supports XML-RPC + POST requests, documentation GET requests, and modifies logging so that the + *logRequests* parameter to the :class:`DocXMLRPCServer` constructor parameter is + honored. + + +.. _doc-xmlrpc-servers: + +DocXMLRPCServer Objects +----------------------- + +The :class:`DocXMLRPCServer` class is derived from :class:`SimpleXMLRPCServer` +and provides a means of creating self-documenting, stand alone XML-RPC +servers. HTTP POST requests are handled as XML-RPC method calls. HTTP GET +requests are handled by generating pydoc-style HTML documentation. This allows a +server to provide its own web-based documentation. + + +.. method:: DocXMLRPCServer.set_server_title(server_title) + + Set the title used in the generated HTML documentation. This title will be used + inside the HTML "title" element. + + +.. method:: DocXMLRPCServer.set_server_name(server_name) + + Set the name used in the generated HTML documentation. This name will appear at + the top of the generated documentation inside a "h1" element. + + +.. method:: DocXMLRPCServer.set_server_documentation(server_documentation) + + Set the description used in the generated HTML documentation. This description + will appear as a paragraph, below the server name, in the documentation. + + +DocCGIXMLRPCRequestHandler +-------------------------- + +The :class:`DocCGIXMLRPCRequestHandler` class is derived from +:class:`CGIXMLRPCRequestHandler` and provides a means of creating +self-documenting, XML-RPC CGI scripts. HTTP POST requests are handled as XML-RPC +method calls. HTTP GET requests are handled by generating pydoc-style HTML +documentation. This allows a server to provide its own web-based documentation. + + +.. method:: DocCGIXMLRPCRequestHandler.set_server_title(server_title) + + Set the title used in the generated HTML documentation. This title will be used + inside the HTML "title" element. + + +.. method:: DocCGIXMLRPCRequestHandler.set_server_name(server_name) + + Set the name used in the generated HTML documentation. This name will appear at + the top of the generated documentation inside a "h1" element. + + +.. method:: DocCGIXMLRPCRequestHandler.set_server_documentation(server_documentation) + + Set the description used in the generated HTML documentation. This description + will appear as a paragraph, below the server name, in the documentation. diff --git a/python-3.7.4-docs-html/_sources/library/zipapp.rst.txt b/python-3.7.4-docs-html/_sources/library/zipapp.rst.txt new file mode 100644 index 0000000..7283152 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/zipapp.rst.txt @@ -0,0 +1,449 @@ +:mod:`zipapp` --- Manage executable Python zip archives +======================================================= + +.. module:: zipapp + :synopsis: Manage executable Python zip archives + +.. versionadded:: 3.5 + +**Source code:** :source:`Lib/zipapp.py` + +.. index:: + single: Executable Zip Files + +-------------- + +This module provides tools to manage the creation of zip files containing +Python code, which can be :ref:`executed directly by the Python interpreter +`. The module provides both a +:ref:`zipapp-command-line-interface` and a :ref:`zipapp-python-api`. + + +Basic Example +------------- + +The following example shows how the :ref:`zipapp-command-line-interface` +can be used to create an executable archive from a directory containing +Python code. When run, the archive will execute the ``main`` function from +the module ``myapp`` in the archive. + +.. code-block:: shell-session + + $ python -m zipapp myapp -m "myapp:main" + $ python myapp.pyz + + + +.. _zipapp-command-line-interface: + +Command-Line Interface +---------------------- + +When called as a program from the command line, the following form is used: + +.. code-block:: shell-session + + $ python -m zipapp source [options] + +If *source* is a directory, this will create an archive from the contents of +*source*. If *source* is a file, it should be an archive, and it will be +copied to the target archive (or the contents of its shebang line will be +displayed if the --info option is specified). + +The following options are understood: + +.. program:: zipapp + +.. cmdoption:: -o , --output= + + Write the output to a file named *output*. If this option is not specified, + the output filename will be the same as the input *source*, with the + extension ``.pyz`` added. If an explicit filename is given, it is used as + is (so a ``.pyz`` extension should be included if required). + + An output filename must be specified if the *source* is an archive (and in + that case, *output* must not be the same as *source*). + +.. cmdoption:: -p , --python= + + Add a ``#!`` line to the archive specifying *interpreter* as the command + to run. Also, on POSIX, make the archive executable. The default is to + write no ``#!`` line, and not make the file executable. + +.. cmdoption:: -m , --main= + + Write a ``__main__.py`` file to the archive that executes *mainfn*. The + *mainfn* argument should have the form "pkg.mod:fn", where "pkg.mod" is a + package/module in the archive, and "fn" is a callable in the given module. + The ``__main__.py`` file will execute that callable. + + :option:`--main` cannot be specified when copying an archive. + +.. cmdoption:: -c, --compress + + Compress files with the deflate method, reducing the size of the output + file. By default, files are stored uncompressed in the archive. + + :option:`--compress` has no effect when copying an archive. + + .. versionadded:: 3.7 + +.. cmdoption:: --info + + Display the interpreter embedded in the archive, for diagnostic purposes. In + this case, any other options are ignored and SOURCE must be an archive, not a + directory. + +.. cmdoption:: -h, --help + + Print a short usage message and exit. + + +.. _zipapp-python-api: + +Python API +---------- + +The module defines two convenience functions: + + +.. function:: create_archive(source, target=None, interpreter=None, main=None, filter=None, compressed=False) + + Create an application archive from *source*. The source can be any + of the following: + + * The name of a directory, or a :term:`path-like object` referring + to a directory, in which case a new application archive will be + created from the content of that directory. + * The name of an existing application archive file, or a :term:`path-like object` + referring to such a file, in which case the file is copied to + the target (modifying it to reflect the value given for the *interpreter* + argument). The file name should include the ``.pyz`` extension, if required. + * A file object open for reading in bytes mode. The content of the + file should be an application archive, and the file object is + assumed to be positioned at the start of the archive. + + The *target* argument determines where the resulting archive will be + written: + + * If it is the name of a file, or a :term:`path-like object`, + the archive will be written to that file. + * If it is an open file object, the archive will be written to that + file object, which must be open for writing in bytes mode. + * If the target is omitted (or ``None``), the source must be a directory + and the target will be a file with the same name as the source, with + a ``.pyz`` extension added. + + The *interpreter* argument specifies the name of the Python + interpreter with which the archive will be executed. It is written as + a "shebang" line at the start of the archive. On POSIX, this will be + interpreted by the OS, and on Windows it will be handled by the Python + launcher. Omitting the *interpreter* results in no shebang line being + written. If an interpreter is specified, and the target is a + filename, the executable bit of the target file will be set. + + The *main* argument specifies the name of a callable which will be + used as the main program for the archive. It can only be specified if + the source is a directory, and the source does not already contain a + ``__main__.py`` file. The *main* argument should take the form + "pkg.module:callable" and the archive will be run by importing + "pkg.module" and executing the given callable with no arguments. It + is an error to omit *main* if the source is a directory and does not + contain a ``__main__.py`` file, as otherwise the resulting archive + would not be executable. + + The optional *filter* argument specifies a callback function that + is passed a Path object representing the path to the file being added + (relative to the source directory). It should return ``True`` if the + file is to be added. + + The optional *compressed* argument determines whether files are + compressed. If set to ``True``, files in the archive are compressed + with the deflate method; otherwise, files are stored uncompressed. + This argument has no effect when copying an existing archive. + + If a file object is specified for *source* or *target*, it is the + caller's responsibility to close it after calling create_archive. + + When copying an existing archive, file objects supplied only need + ``read`` and ``readline``, or ``write`` methods. When creating an + archive from a directory, if the target is a file object it will be + passed to the ``zipfile.ZipFile`` class, and must supply the methods + needed by that class. + + .. versionadded:: 3.7 + Added the *filter* and *compressed* arguments. + +.. function:: get_interpreter(archive) + + Return the interpreter specified in the ``#!`` line at the start of the + archive. If there is no ``#!`` line, return :const:`None`. + The *archive* argument can be a filename or a file-like object open + for reading in bytes mode. It is assumed to be at the start of the archive. + + +.. _zipapp-examples: + +Examples +-------- + +Pack up a directory into an archive, and run it. + +.. code-block:: shell-session + + $ python -m zipapp myapp + $ python myapp.pyz + + +The same can be done using the :func:`create_archive` function:: + + >>> import zipapp + >>> zipapp.create_archive('myapp.pyz', 'myapp') + +To make the application directly executable on POSIX, specify an interpreter +to use. + +.. code-block:: shell-session + + $ python -m zipapp myapp -p "/usr/bin/env python" + $ ./myapp.pyz + + +To replace the shebang line on an existing archive, create a modified archive +using the :func:`create_archive` function:: + + >>> import zipapp + >>> zipapp.create_archive('old_archive.pyz', 'new_archive.pyz', '/usr/bin/python3') + +To update the file in place, do the replacement in memory using a :class:`BytesIO` +object, and then overwrite the source afterwards. Note that there is a risk +when overwriting a file in place that an error will result in the loss of +the original file. This code does not protect against such errors, but +production code should do so. Also, this method will only work if the archive +fits in memory:: + + >>> import zipapp + >>> import io + >>> temp = io.BytesIO() + >>> zipapp.create_archive('myapp.pyz', temp, '/usr/bin/python2') + >>> with open('myapp.pyz', 'wb') as f: + >>> f.write(temp.getvalue()) + + +.. _zipapp-specifying-the-interpreter: + +Specifying the Interpreter +-------------------------- + +Note that if you specify an interpreter and then distribute your application +archive, you need to ensure that the interpreter used is portable. The Python +launcher for Windows supports most common forms of POSIX ``#!`` line, but there +are other issues to consider: + +* If you use "/usr/bin/env python" (or other forms of the "python" command, + such as "/usr/bin/python"), you need to consider that your users may have + either Python 2 or Python 3 as their default, and write your code to work + under both versions. +* If you use an explicit version, for example "/usr/bin/env python3" your + application will not work for users who do not have that version. (This + may be what you want if you have not made your code Python 2 compatible). +* There is no way to say "python X.Y or later", so be careful of using an + exact version like "/usr/bin/env python3.4" as you will need to change your + shebang line for users of Python 3.5, for example. + +Typically, you should use an "/usr/bin/env python2" or "/usr/bin/env python3", +depending on whether your code is written for Python 2 or 3. + + +Creating Standalone Applications with zipapp +-------------------------------------------- + +Using the :mod:`zipapp` module, it is possible to create self-contained Python +programs, which can be distributed to end users who only need to have a +suitable version of Python installed on their system. The key to doing this +is to bundle all of the application's dependencies into the archive, along +with the application code. + +The steps to create a standalone archive are as follows: + +1. Create your application in a directory as normal, so you have a ``myapp`` + directory containing a ``__main__.py`` file, and any supporting application + code. + +2. Install all of your application's dependencies into the ``myapp`` directory, + using pip: + + .. code-block:: shell-session + + $ python -m pip install -r requirements.txt --target myapp + + (this assumes you have your project requirements in a ``requirements.txt`` + file - if not, you can just list the dependencies manually on the pip command + line). + +3. Optionally, delete the ``.dist-info`` directories created by pip in the + ``myapp`` directory. These hold metadata for pip to manage the packages, and + as you won't be making any further use of pip they aren't required - + although it won't do any harm if you leave them. + +4. Package the application using: + + .. code-block:: shell-session + + $ python -m zipapp -p "interpreter" myapp + +This will produce a standalone executable, which can be run on any machine with +the appropriate interpreter available. See :ref:`zipapp-specifying-the-interpreter` +for details. It can be shipped to users as a single file. + +On Unix, the ``myapp.pyz`` file is executable as it stands. You can rename the +file to remove the ``.pyz`` extension if you prefer a "plain" command name. On +Windows, the ``myapp.pyz[w]`` file is executable by virtue of the fact that +the Python interpreter registers the ``.pyz`` and ``.pyzw`` file extensions +when installed. + + +Making a Windows executable +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +On Windows, registration of the ``.pyz`` extension is optional, and +furthermore, there are certain places that don't recognise registered +extensions "transparently" (the simplest example is that +``subprocess.run(['myapp'])`` won't find your application - you need to +explicitly specify the extension). + +On Windows, therefore, it is often preferable to create an executable from the +zipapp. This is relatively easy, although it does require a C compiler. The +basic approach relies on the fact that zipfiles can have arbitrary data +prepended, and Windows exe files can have arbitrary data appended. So by +creating a suitable launcher and tacking the ``.pyz`` file onto the end of it, +you end up with a single-file executable that runs your application. + +A suitable launcher can be as simple as the following:: + + #define Py_LIMITED_API 1 + #include "Python.h" + + #define WIN32_LEAN_AND_MEAN + #include + + #ifdef WINDOWS + int WINAPI wWinMain( + HINSTANCE hInstance, /* handle to current instance */ + HINSTANCE hPrevInstance, /* handle to previous instance */ + LPWSTR lpCmdLine, /* pointer to command line */ + int nCmdShow /* show state of window */ + ) + #else + int wmain() + #endif + { + wchar_t **myargv = _alloca((__argc + 1) * sizeof(wchar_t*)); + myargv[0] = __wargv[0]; + memcpy(myargv + 1, __wargv, __argc * sizeof(wchar_t *)); + return Py_Main(__argc+1, myargv); + } + +If you define the ``WINDOWS`` preprocessor symbol, this will generate a +GUI executable, and without it, a console executable. + +To compile the executable, you can either just use the standard MSVC +command line tools, or you can take advantage of the fact that distutils +knows how to compile Python source:: + + >>> from distutils.ccompiler import new_compiler + >>> import distutils.sysconfig + >>> import sys + >>> import os + >>> from pathlib import Path + + >>> def compile(src): + >>> src = Path(src) + >>> cc = new_compiler() + >>> exe = src.stem + >>> cc.add_include_dir(distutils.sysconfig.get_python_inc()) + >>> cc.add_library_dir(os.path.join(sys.base_exec_prefix, 'libs')) + >>> # First the CLI executable + >>> objs = cc.compile([str(src)]) + >>> cc.link_executable(objs, exe) + >>> # Now the GUI executable + >>> cc.define_macro('WINDOWS') + >>> objs = cc.compile([str(src)]) + >>> cc.link_executable(objs, exe + 'w') + + >>> if __name__ == "__main__": + >>> compile("zastub.c") + +The resulting launcher uses the "Limited ABI", so it will run unchanged with +any version of Python 3.x. All it needs is for Python (``python3.dll``) to be +on the user's ``PATH``. + +For a fully standalone distribution, you can distribute the launcher with your +application appended, bundled with the Python "embedded" distribution. This +will run on any PC with the appropriate architecture (32 bit or 64 bit). + + +Caveats +~~~~~~~ + +There are some limitations to the process of bundling your application into +a single file. In most, if not all, cases they can be addressed without +needing major changes to your application. + +1. If your application depends on a package that includes a C extension, that + package cannot be run from a zip file (this is an OS limitation, as executable + code must be present in the filesystem for the OS loader to load it). In this + case, you can exclude that dependency from the zipfile, and either require + your users to have it installed, or ship it alongside your zipfile and add code + to your ``__main__.py`` to include the directory containing the unzipped + module in ``sys.path``. In this case, you will need to make sure to ship + appropriate binaries for your target architecture(s) (and potentially pick the + correct version to add to ``sys.path`` at runtime, based on the user's machine). + +2. If you are shipping a Windows executable as described above, you either need to + ensure that your users have ``python3.dll`` on their PATH (which is not the + default behaviour of the installer) or you should bundle your application with + the embedded distribution. + +3. The suggested launcher above uses the Python embedding API. This means that in + your application, ``sys.executable`` will be your application, and *not* a + conventional Python interpreter. Your code and its dependencies need to be + prepared for this possibility. For example, if your application uses the + :mod:`multiprocessing` module, it will need to call + :func:`multiprocessing.set_executable` to let the module know where to find the + standard Python interpreter. + + +The Python Zip Application Archive Format +----------------------------------------- + +Python has been able to execute zip files which contain a ``__main__.py`` file +since version 2.6. In order to be executed by Python, an application archive +simply has to be a standard zip file containing a ``__main__.py`` file which +will be run as the entry point for the application. As usual for any Python +script, the parent of the script (in this case the zip file) will be placed on +:data:`sys.path` and thus further modules can be imported from the zip file. + +The zip file format allows arbitrary data to be prepended to a zip file. The +zip application format uses this ability to prepend a standard POSIX "shebang" +line to the file (``#!/path/to/interpreter``). + +Formally, the Python zip application format is therefore: + +1. An optional shebang line, containing the characters ``b'#!'`` followed by an + interpreter name, and then a newline (``b'\n'``) character. The interpreter + name can be anything acceptable to the OS "shebang" processing, or the Python + launcher on Windows. The interpreter should be encoded in UTF-8 on Windows, + and in :func:`sys.getfilesystemencoding()` on POSIX. +2. Standard zipfile data, as generated by the :mod:`zipfile` module. The + zipfile content *must* include a file called ``__main__.py`` (which must be + in the "root" of the zipfile - i.e., it cannot be in a subdirectory). The + zipfile data can be compressed or uncompressed. + +If an application archive has a shebang line, it may have the executable bit set +on POSIX systems, to allow it to be executed directly. + +There is no requirement that the tools in this module are used to create +application archives - the module is a convenience, but archives in the above +format created by any means are acceptable to Python. + diff --git a/python-3.7.4-docs-html/_sources/library/zipfile.rst.txt b/python-3.7.4-docs-html/_sources/library/zipfile.rst.txt new file mode 100644 index 0000000..6fb03a0 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/zipfile.rst.txt @@ -0,0 +1,734 @@ +:mod:`zipfile` --- Work with ZIP archives +========================================= + +.. module:: zipfile + :synopsis: Read and write ZIP-format archive files. + +.. moduleauthor:: James C. Ahlstrom +.. sectionauthor:: James C. Ahlstrom + +**Source code:** :source:`Lib/zipfile.py` + +-------------- + +The ZIP file format is a common archive and compression standard. This module +provides tools to create, read, write, append, and list a ZIP file. Any +advanced use of this module will require an understanding of the format, as +defined in `PKZIP Application Note`_. + +This module does not currently handle multi-disk ZIP files. +It can handle ZIP files that use the ZIP64 extensions +(that is ZIP files that are more than 4 GiB in size). It supports +decryption of encrypted files in ZIP archives, but it currently cannot +create an encrypted file. Decryption is extremely slow as it is +implemented in native Python rather than C. + +The module defines the following items: + +.. exception:: BadZipFile + + The error raised for bad ZIP files. + + .. versionadded:: 3.2 + + +.. exception:: BadZipfile + + Alias of :exc:`BadZipFile`, for compatibility with older Python versions. + + .. deprecated:: 3.2 + + +.. exception:: LargeZipFile + + The error raised when a ZIP file would require ZIP64 functionality but that has + not been enabled. + + +.. class:: ZipFile + :noindex: + + The class for reading and writing ZIP files. See section + :ref:`zipfile-objects` for constructor details. + + +.. class:: PyZipFile + :noindex: + + Class for creating ZIP archives containing Python libraries. + + +.. class:: ZipInfo(filename='NoName', date_time=(1980,1,1,0,0,0)) + + Class used to represent information about a member of an archive. Instances + of this class are returned by the :meth:`.getinfo` and :meth:`.infolist` + methods of :class:`ZipFile` objects. Most users of the :mod:`zipfile` module + will not need to create these, but only use those created by this + module. *filename* should be the full name of the archive member, and + *date_time* should be a tuple containing six fields which describe the time + of the last modification to the file; the fields are described in section + :ref:`zipinfo-objects`. + + +.. function:: is_zipfile(filename) + + Returns ``True`` if *filename* is a valid ZIP file based on its magic number, + otherwise returns ``False``. *filename* may be a file or file-like object too. + + .. versionchanged:: 3.1 + Support for file and file-like objects. + + +.. data:: ZIP_STORED + + The numeric constant for an uncompressed archive member. + + +.. data:: ZIP_DEFLATED + + The numeric constant for the usual ZIP compression method. This requires the + :mod:`zlib` module. + + +.. data:: ZIP_BZIP2 + + The numeric constant for the BZIP2 compression method. This requires the + :mod:`bz2` module. + + .. versionadded:: 3.3 + +.. data:: ZIP_LZMA + + The numeric constant for the LZMA compression method. This requires the + :mod:`lzma` module. + + .. versionadded:: 3.3 + + .. note:: + + The ZIP file format specification has included support for bzip2 compression + since 2001, and for LZMA compression since 2006. However, some tools + (including older Python releases) do not support these compression + methods, and may either refuse to process the ZIP file altogether, + or fail to extract individual files. + + +.. seealso:: + + `PKZIP Application Note`_ + Documentation on the ZIP file format by Phil Katz, the creator of the format and + algorithms used. + + `Info-ZIP Home Page `_ + Information about the Info-ZIP project's ZIP archive programs and development + libraries. + + +.. _zipfile-objects: + +ZipFile Objects +--------------- + + +.. class:: ZipFile(file, mode='r', compression=ZIP_STORED, allowZip64=True, \ + compresslevel=None) + + Open a ZIP file, where *file* can be a path to a file (a string), a + file-like object or a :term:`path-like object`. + + The *mode* parameter should be ``'r'`` to read an existing + file, ``'w'`` to truncate and write a new file, ``'a'`` to append to an + existing file, or ``'x'`` to exclusively create and write a new file. + If *mode* is ``'x'`` and *file* refers to an existing file, + a :exc:`FileExistsError` will be raised. + If *mode* is ``'a'`` and *file* refers to an existing ZIP + file, then additional files are added to it. If *file* does not refer to a + ZIP file, then a new ZIP archive is appended to the file. This is meant for + adding a ZIP archive to another file (such as :file:`python.exe`). If + *mode* is ``'a'`` and the file does not exist at all, it is created. + If *mode* is ``'r'`` or ``'a'``, the file should be seekable. + + *compression* is the ZIP compression method to use when writing the archive, + and should be :const:`ZIP_STORED`, :const:`ZIP_DEFLATED`, + :const:`ZIP_BZIP2` or :const:`ZIP_LZMA`; unrecognized + values will cause :exc:`NotImplementedError` to be raised. If + :const:`ZIP_DEFLATED`, :const:`ZIP_BZIP2` or :const:`ZIP_LZMA` is specified + but the corresponding module (:mod:`zlib`, :mod:`bz2` or :mod:`lzma`) is not + available, :exc:`RuntimeError` is raised. The default is :const:`ZIP_STORED`. + + If *allowZip64* is ``True`` (the default) zipfile will create ZIP files that + use the ZIP64 extensions when the zipfile is larger than 4 GiB. If it is + ``false`` :mod:`zipfile` will raise an exception when the ZIP file would + require ZIP64 extensions. + + The *compresslevel* parameter controls the compression level to use when + writing files to the archive. + When using :const:`ZIP_STORED` or :const:`ZIP_LZMA` it has no effect. + When using :const:`ZIP_DEFLATED` integers ``0`` through ``9`` are accepted + (see :class:`zlib ` for more information). + When using :const:`ZIP_BZIP2` integers ``1`` through ``9`` are accepted + (see :class:`bz2 ` for more information). + + If the file is created with mode ``'w'``, ``'x'`` or ``'a'`` and then + :meth:`closed ` without adding any files to the archive, the appropriate + ZIP structures for an empty archive will be written to the file. + + ZipFile is also a context manager and therefore supports the + :keyword:`with` statement. In the example, *myzip* is closed after the + :keyword:`!with` statement's suite is finished---even if an exception occurs:: + + with ZipFile('spam.zip', 'w') as myzip: + myzip.write('eggs.txt') + + .. versionadded:: 3.2 + Added the ability to use :class:`ZipFile` as a context manager. + + .. versionchanged:: 3.3 + Added support for :mod:`bzip2 ` and :mod:`lzma` compression. + + .. versionchanged:: 3.4 + ZIP64 extensions are enabled by default. + + .. versionchanged:: 3.5 + Added support for writing to unseekable streams. + Added support for the ``'x'`` mode. + + .. versionchanged:: 3.6 + Previously, a plain :exc:`RuntimeError` was raised for unrecognized + compression values. + + .. versionchanged:: 3.6.2 + The *file* parameter accepts a :term:`path-like object`. + + .. versionchanged:: 3.7 + Add the *compresslevel* parameter. + + +.. method:: ZipFile.close() + + Close the archive file. You must call :meth:`close` before exiting your program + or essential records will not be written. + + +.. method:: ZipFile.getinfo(name) + + Return a :class:`ZipInfo` object with information about the archive member + *name*. Calling :meth:`getinfo` for a name not currently contained in the + archive will raise a :exc:`KeyError`. + + +.. method:: ZipFile.infolist() + + Return a list containing a :class:`ZipInfo` object for each member of the + archive. The objects are in the same order as their entries in the actual ZIP + file on disk if an existing archive was opened. + + +.. method:: ZipFile.namelist() + + Return a list of archive members by name. + + +.. method:: ZipFile.open(name, mode='r', pwd=None, *, force_zip64=False) + + Access a member of the archive as a binary file-like object. *name* + can be either the name of a file within the archive or a :class:`ZipInfo` + object. The *mode* parameter, if included, must be ``'r'`` (the default) + or ``'w'``. *pwd* is the password used to decrypt encrypted ZIP files. + + :meth:`~ZipFile.open` is also a context manager and therefore supports the + :keyword:`with` statement:: + + with ZipFile('spam.zip') as myzip: + with myzip.open('eggs.txt') as myfile: + print(myfile.read()) + + With *mode* ``'r'`` the file-like object + (``ZipExtFile``) is read-only and provides the following methods: + :meth:`~io.BufferedIOBase.read`, :meth:`~io.IOBase.readline`, + :meth:`~io.IOBase.readlines`, :meth:`~io.IOBase.seek`, + :meth:`~io.IOBase.tell`, :meth:`__iter__`, :meth:`~iterator.__next__`. + These objects can operate independently of the ZipFile. + + With ``mode='w'``, a writable file handle is returned, which supports the + :meth:`~io.BufferedIOBase.write` method. While a writable file handle is open, + attempting to read or write other files in the ZIP file will raise a + :exc:`ValueError`. + + When writing a file, if the file size is not known in advance but may exceed + 2 GiB, pass ``force_zip64=True`` to ensure that the header format is + capable of supporting large files. If the file size is known in advance, + construct a :class:`ZipInfo` object with :attr:`~ZipInfo.file_size` set, and + use that as the *name* parameter. + + .. note:: + + The :meth:`.open`, :meth:`read` and :meth:`extract` methods can take a filename + or a :class:`ZipInfo` object. You will appreciate this when trying to read a + ZIP file that contains members with duplicate names. + + .. versionchanged:: 3.6 + Removed support of ``mode='U'``. Use :class:`io.TextIOWrapper` for reading + compressed text files in :term:`universal newlines` mode. + + .. versionchanged:: 3.6 + :meth:`open` can now be used to write files into the archive with the + ``mode='w'`` option. + + .. versionchanged:: 3.6 + Calling :meth:`.open` on a closed ZipFile will raise a :exc:`ValueError`. + Previously, a :exc:`RuntimeError` was raised. + + +.. method:: ZipFile.extract(member, path=None, pwd=None) + + Extract a member from the archive to the current working directory; *member* + must be its full name or a :class:`ZipInfo` object. Its file information is + extracted as accurately as possible. *path* specifies a different directory + to extract to. *member* can be a filename or a :class:`ZipInfo` object. + *pwd* is the password used for encrypted files. + + Returns the normalized path created (a directory or new file). + + .. note:: + + If a member filename is an absolute path, a drive/UNC sharepoint and + leading (back)slashes will be stripped, e.g.: ``///foo/bar`` becomes + ``foo/bar`` on Unix, and ``C:\foo\bar`` becomes ``foo\bar`` on Windows. + And all ``".."`` components in a member filename will be removed, e.g.: + ``../../foo../../ba..r`` becomes ``foo../ba..r``. On Windows illegal + characters (``:``, ``<``, ``>``, ``|``, ``"``, ``?``, and ``*``) + replaced by underscore (``_``). + + .. versionchanged:: 3.6 + Calling :meth:`extract` on a closed ZipFile will raise a + :exc:`ValueError`. Previously, a :exc:`RuntimeError` was raised. + + .. versionchanged:: 3.6.2 + The *path* parameter accepts a :term:`path-like object`. + + +.. method:: ZipFile.extractall(path=None, members=None, pwd=None) + + Extract all members from the archive to the current working directory. *path* + specifies a different directory to extract to. *members* is optional and must + be a subset of the list returned by :meth:`namelist`. *pwd* is the password + used for encrypted files. + + .. warning:: + + Never extract archives from untrusted sources without prior inspection. + It is possible that files are created outside of *path*, e.g. members + that have absolute filenames starting with ``"/"`` or filenames with two + dots ``".."``. This module attempts to prevent that. + See :meth:`extract` note. + + .. versionchanged:: 3.6 + Calling :meth:`extractall` on a closed ZipFile will raise a + :exc:`ValueError`. Previously, a :exc:`RuntimeError` was raised. + + .. versionchanged:: 3.6.2 + The *path* parameter accepts a :term:`path-like object`. + + +.. method:: ZipFile.printdir() + + Print a table of contents for the archive to ``sys.stdout``. + + +.. method:: ZipFile.setpassword(pwd) + + Set *pwd* as default password to extract encrypted files. + + +.. method:: ZipFile.read(name, pwd=None) + + Return the bytes of the file *name* in the archive. *name* is the name of the + file in the archive, or a :class:`ZipInfo` object. The archive must be open for + read or append. *pwd* is the password used for encrypted files and, if specified, + it will override the default password set with :meth:`setpassword`. Calling + :meth:`read` on a ZipFile that uses a compression method other than + :const:`ZIP_STORED`, :const:`ZIP_DEFLATED`, :const:`ZIP_BZIP2` or + :const:`ZIP_LZMA` will raise a :exc:`NotImplementedError`. An error will also + be raised if the corresponding compression module is not available. + + .. versionchanged:: 3.6 + Calling :meth:`read` on a closed ZipFile will raise a :exc:`ValueError`. + Previously, a :exc:`RuntimeError` was raised. + + +.. method:: ZipFile.testzip() + + Read all the files in the archive and check their CRC's and file headers. + Return the name of the first bad file, or else return ``None``. + + .. versionchanged:: 3.6 + Calling :meth:`testzip` on a closed ZipFile will raise a + :exc:`ValueError`. Previously, a :exc:`RuntimeError` was raised. + + +.. method:: ZipFile.write(filename, arcname=None, compress_type=None, \ + compresslevel=None) + + Write the file named *filename* to the archive, giving it the archive name + *arcname* (by default, this will be the same as *filename*, but without a drive + letter and with leading path separators removed). If given, *compress_type* + overrides the value given for the *compression* parameter to the constructor for + the new entry. Similarly, *compresslevel* will override the constructor if + given. + The archive must be open with mode ``'w'``, ``'x'`` or ``'a'``. + + .. note:: + + Archive names should be relative to the archive root, that is, they should not + start with a path separator. + + .. note:: + + If ``arcname`` (or ``filename``, if ``arcname`` is not given) contains a null + byte, the name of the file in the archive will be truncated at the null byte. + + .. versionchanged:: 3.6 + Calling :meth:`write` on a ZipFile created with mode ``'r'`` or + a closed ZipFile will raise a :exc:`ValueError`. Previously, + a :exc:`RuntimeError` was raised. + + +.. method:: ZipFile.writestr(zinfo_or_arcname, data, compress_type=None, \ + compresslevel=None) + + Write a file into the archive. The contents is *data*, which may be either + a :class:`str` or a :class:`bytes` instance; if it is a :class:`str`, + it is encoded as UTF-8 first. *zinfo_or_arcname* is either the file + name it will be given in the archive, or a :class:`ZipInfo` instance. If it's + an instance, at least the filename, date, and time must be given. If it's a + name, the date and time is set to the current date and time. + The archive must be opened with mode ``'w'``, ``'x'`` or ``'a'``. + + If given, *compress_type* overrides the value given for the *compression* + parameter to the constructor for the new entry, or in the *zinfo_or_arcname* + (if that is a :class:`ZipInfo` instance). Similarly, *compresslevel* will + override the constructor if given. + + .. note:: + + When passing a :class:`ZipInfo` instance as the *zinfo_or_arcname* parameter, + the compression method used will be that specified in the *compress_type* + member of the given :class:`ZipInfo` instance. By default, the + :class:`ZipInfo` constructor sets this member to :const:`ZIP_STORED`. + + .. versionchanged:: 3.2 + The *compress_type* argument. + + .. versionchanged:: 3.6 + Calling :meth:`writestr` on a ZipFile created with mode ``'r'`` or + a closed ZipFile will raise a :exc:`ValueError`. Previously, + a :exc:`RuntimeError` was raised. + + +The following data attributes are also available: + +.. attribute:: ZipFile.filename + + Name of the ZIP file. + +.. attribute:: ZipFile.debug + + The level of debug output to use. This may be set from ``0`` (the default, no + output) to ``3`` (the most output). Debugging information is written to + ``sys.stdout``. + +.. attribute:: ZipFile.comment + + The comment associated with the ZIP file as a :class:`bytes` object. + If assigning a comment to a + :class:`ZipFile` instance created with mode ``'w'``, ``'x'`` or ``'a'``, + it should be no longer than 65535 bytes. Comments longer than this will be + truncated. + + +.. _pyzipfile-objects: + +PyZipFile Objects +----------------- + +The :class:`PyZipFile` constructor takes the same parameters as the +:class:`ZipFile` constructor, and one additional parameter, *optimize*. + +.. class:: PyZipFile(file, mode='r', compression=ZIP_STORED, allowZip64=True, \ + optimize=-1) + + .. versionadded:: 3.2 + The *optimize* parameter. + + .. versionchanged:: 3.4 + ZIP64 extensions are enabled by default. + + Instances have one method in addition to those of :class:`ZipFile` objects: + + .. method:: PyZipFile.writepy(pathname, basename='', filterfunc=None) + + Search for files :file:`\*.py` and add the corresponding file to the + archive. + + If the *optimize* parameter to :class:`PyZipFile` was not given or ``-1``, + the corresponding file is a :file:`\*.pyc` file, compiling if necessary. + + If the *optimize* parameter to :class:`PyZipFile` was ``0``, ``1`` or + ``2``, only files with that optimization level (see :func:`compile`) are + added to the archive, compiling if necessary. + + If *pathname* is a file, the filename must end with :file:`.py`, and + just the (corresponding :file:`\*.pyc`) file is added at the top level + (no path information). If *pathname* is a file that does not end with + :file:`.py`, a :exc:`RuntimeError` will be raised. If it is a directory, + and the directory is not a package directory, then all the files + :file:`\*.pyc` are added at the top level. If the directory is a + package directory, then all :file:`\*.pyc` are added under the package + name as a file path, and if any subdirectories are package directories, + all of these are added recursively in sorted order. + + *basename* is intended for internal use only. + + *filterfunc*, if given, must be a function taking a single string + argument. It will be passed each path (including each individual full + file path) before it is added to the archive. If *filterfunc* returns a + false value, the path will not be added, and if it is a directory its + contents will be ignored. For example, if our test files are all either + in ``test`` directories or start with the string ``test_``, we can use a + *filterfunc* to exclude them:: + + >>> zf = PyZipFile('myprog.zip') + >>> def notests(s): + ... fn = os.path.basename(s) + ... return (not (fn == 'test' or fn.startswith('test_'))) + >>> zf.writepy('myprog', filterfunc=notests) + + The :meth:`writepy` method makes archives with file names like + this:: + + string.pyc # Top level name + test/__init__.pyc # Package directory + test/testall.pyc # Module test.testall + test/bogus/__init__.pyc # Subpackage directory + test/bogus/myfile.pyc # Submodule test.bogus.myfile + + .. versionadded:: 3.4 + The *filterfunc* parameter. + + .. versionchanged:: 3.6.2 + The *pathname* parameter accepts a :term:`path-like object`. + + .. versionchanged:: 3.7 + Recursion sorts directory entries. + + +.. _zipinfo-objects: + +ZipInfo Objects +--------------- + +Instances of the :class:`ZipInfo` class are returned by the :meth:`.getinfo` and +:meth:`.infolist` methods of :class:`ZipFile` objects. Each object stores +information about a single member of the ZIP archive. + +There is one classmethod to make a :class:`ZipInfo` instance for a filesystem +file: + +.. classmethod:: ZipInfo.from_file(filename, arcname=None) + + Construct a :class:`ZipInfo` instance for a file on the filesystem, in + preparation for adding it to a zip file. + + *filename* should be the path to a file or directory on the filesystem. + + If *arcname* is specified, it is used as the name within the archive. + If *arcname* is not specified, the name will be the same as *filename*, but + with any drive letter and leading path separators removed. + + .. versionadded:: 3.6 + + .. versionchanged:: 3.6.2 + The *filename* parameter accepts a :term:`path-like object`. + + +Instances have the following methods and attributes: + +.. method:: ZipInfo.is_dir() + + Return ``True`` if this archive member is a directory. + + This uses the entry's name: directories should always end with ``/``. + + .. versionadded:: 3.6 + + +.. attribute:: ZipInfo.filename + + Name of the file in the archive. + + +.. attribute:: ZipInfo.date_time + + The time and date of the last modification to the archive member. This is a + tuple of six values: + + +-------+--------------------------+ + | Index | Value | + +=======+==========================+ + | ``0`` | Year (>= 1980) | + +-------+--------------------------+ + | ``1`` | Month (one-based) | + +-------+--------------------------+ + | ``2`` | Day of month (one-based) | + +-------+--------------------------+ + | ``3`` | Hours (zero-based) | + +-------+--------------------------+ + | ``4`` | Minutes (zero-based) | + +-------+--------------------------+ + | ``5`` | Seconds (zero-based) | + +-------+--------------------------+ + + .. note:: + + The ZIP file format does not support timestamps before 1980. + + +.. attribute:: ZipInfo.compress_type + + Type of compression for the archive member. + + +.. attribute:: ZipInfo.comment + + Comment for the individual archive member as a :class:`bytes` object. + + +.. attribute:: ZipInfo.extra + + Expansion field data. The `PKZIP Application Note`_ contains + some comments on the internal structure of the data contained in this + :class:`bytes` object. + + +.. attribute:: ZipInfo.create_system + + System which created ZIP archive. + + +.. attribute:: ZipInfo.create_version + + PKZIP version which created ZIP archive. + + +.. attribute:: ZipInfo.extract_version + + PKZIP version needed to extract archive. + + +.. attribute:: ZipInfo.reserved + + Must be zero. + + +.. attribute:: ZipInfo.flag_bits + + ZIP flag bits. + + +.. attribute:: ZipInfo.volume + + Volume number of file header. + + +.. attribute:: ZipInfo.internal_attr + + Internal attributes. + + +.. attribute:: ZipInfo.external_attr + + External file attributes. + + +.. attribute:: ZipInfo.header_offset + + Byte offset to the file header. + + +.. attribute:: ZipInfo.CRC + + CRC-32 of the uncompressed file. + + +.. attribute:: ZipInfo.compress_size + + Size of the compressed data. + + +.. attribute:: ZipInfo.file_size + + Size of the uncompressed file. + + +.. _zipfile-commandline: +.. program:: zipfile + +Command-Line Interface +---------------------- + +The :mod:`zipfile` module provides a simple command-line interface to interact +with ZIP archives. + +If you want to create a new ZIP archive, specify its name after the :option:`-c` +option and then list the filename(s) that should be included: + +.. code-block:: shell-session + + $ python -m zipfile -c monty.zip spam.txt eggs.txt + +Passing a directory is also acceptable: + +.. code-block:: shell-session + + $ python -m zipfile -c monty.zip life-of-brian_1979/ + +If you want to extract a ZIP archive into the specified directory, use +the :option:`-e` option: + +.. code-block:: shell-session + + $ python -m zipfile -e monty.zip target-dir/ + +For a list of the files in a ZIP archive, use the :option:`-l` option: + +.. code-block:: shell-session + + $ python -m zipfile -l monty.zip + + +Command-line options +~~~~~~~~~~~~~~~~~~~~ + +.. cmdoption:: -l + --list + + List files in a zipfile. + +.. cmdoption:: -c ... + --create ... + + Create zipfile from source files. + +.. cmdoption:: -e + --extract + + Extract zipfile into target directory. + +.. cmdoption:: -t + --test + + Test whether the zipfile is valid or not. + + +.. _PKZIP Application Note: https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT diff --git a/python-3.7.4-docs-html/_sources/library/zipimport.rst.txt b/python-3.7.4-docs-html/_sources/library/zipimport.rst.txt new file mode 100644 index 0000000..eaae2bb --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/zipimport.rst.txt @@ -0,0 +1,167 @@ +:mod:`zipimport` --- Import modules from Zip archives +===================================================== + +.. module:: zipimport + :synopsis: support for importing Python modules from ZIP archives. + +.. moduleauthor:: Just van Rossum + +-------------- + +This module adds the ability to import Python modules (:file:`\*.py`, +:file:`\*.pyc`) and packages from ZIP-format archives. It is usually not +needed to use the :mod:`zipimport` module explicitly; it is automatically used +by the built-in :keyword:`import` mechanism for :data:`sys.path` items that are paths +to ZIP archives. + +Typically, :data:`sys.path` is a list of directory names as strings. This module +also allows an item of :data:`sys.path` to be a string naming a ZIP file archive. +The ZIP archive can contain a subdirectory structure to support package imports, +and a path within the archive can be specified to only import from a +subdirectory. For example, the path :file:`example.zip/lib/` would only +import from the :file:`lib/` subdirectory within the archive. + +Any files may be present in the ZIP archive, but only files :file:`.py` and +:file:`.pyc` are available for import. ZIP import of dynamic modules +(:file:`.pyd`, :file:`.so`) is disallowed. Note that if an archive only contains +:file:`.py` files, Python will not attempt to modify the archive by adding the +corresponding :file:`.pyc` file, meaning that if a ZIP archive +doesn't contain :file:`.pyc` files, importing may be rather slow. + +ZIP archives with an archive comment are currently not supported. + +.. seealso:: + + `PKZIP Application Note `_ + Documentation on the ZIP file format by Phil Katz, the creator of the format and + algorithms used. + + :pep:`273` - Import Modules from Zip Archives + Written by James C. Ahlstrom, who also provided an implementation. Python 2.3 + follows the specification in PEP 273, but uses an implementation written by Just + van Rossum that uses the import hooks described in PEP 302. + + :pep:`302` - New Import Hooks + The PEP to add the import hooks that help this module work. + + +This module defines an exception: + +.. exception:: ZipImportError + + Exception raised by zipimporter objects. It's a subclass of :exc:`ImportError`, + so it can be caught as :exc:`ImportError`, too. + + +.. _zipimporter-objects: + +zipimporter Objects +------------------- + +:class:`zipimporter` is the class for importing ZIP files. + +.. class:: zipimporter(archivepath) + + Create a new zipimporter instance. *archivepath* must be a path to a ZIP + file, or to a specific path within a ZIP file. For example, an *archivepath* + of :file:`foo/bar.zip/lib` will look for modules in the :file:`lib` directory + inside the ZIP file :file:`foo/bar.zip` (provided that it exists). + + :exc:`ZipImportError` is raised if *archivepath* doesn't point to a valid ZIP + archive. + + .. method:: find_module(fullname[, path]) + + Search for a module specified by *fullname*. *fullname* must be the fully + qualified (dotted) module name. It returns the zipimporter instance itself + if the module was found, or :const:`None` if it wasn't. The optional + *path* argument is ignored---it's there for compatibility with the + importer protocol. + + + .. method:: get_code(fullname) + + Return the code object for the specified module. Raise + :exc:`ZipImportError` if the module couldn't be found. + + + .. method:: get_data(pathname) + + Return the data associated with *pathname*. Raise :exc:`OSError` if the + file wasn't found. + + .. versionchanged:: 3.3 + :exc:`IOError` used to be raised instead of :exc:`OSError`. + + + .. method:: get_filename(fullname) + + Return the value ``__file__`` would be set to if the specified module + was imported. Raise :exc:`ZipImportError` if the module couldn't be + found. + + .. versionadded:: 3.1 + + + .. method:: get_source(fullname) + + Return the source code for the specified module. Raise + :exc:`ZipImportError` if the module couldn't be found, return + :const:`None` if the archive does contain the module, but has no source + for it. + + + .. method:: is_package(fullname) + + Return ``True`` if the module specified by *fullname* is a package. Raise + :exc:`ZipImportError` if the module couldn't be found. + + + .. method:: load_module(fullname) + + Load the module specified by *fullname*. *fullname* must be the fully + qualified (dotted) module name. It returns the imported module, or raises + :exc:`ZipImportError` if it wasn't found. + + + .. attribute:: archive + + The file name of the importer's associated ZIP file, without a possible + subpath. + + + .. attribute:: prefix + + The subpath within the ZIP file where modules are searched. This is the + empty string for zipimporter objects which point to the root of the ZIP + file. + + The :attr:`archive` and :attr:`prefix` attributes, when combined with a + slash, equal the original *archivepath* argument given to the + :class:`zipimporter` constructor. + + +.. _zipimport-examples: + +Examples +-------- + +Here is an example that imports a module from a ZIP archive - note that the +:mod:`zipimport` module is not explicitly used. + +.. code-block:: shell-session + + $ unzip -l example.zip + Archive: example.zip + Length Date Time Name + -------- ---- ---- ---- + 8467 11-26-02 22:30 jwzthreading.py + -------- ------- + 8467 1 file + $ ./python + Python 2.3 (#1, Aug 1 2003, 19:54:32) + >>> import sys + >>> sys.path.insert(0, 'example.zip') # Add .zip file to front of path + >>> import jwzthreading + >>> jwzthreading.__file__ + 'example.zip/jwzthreading.py' diff --git a/python-3.7.4-docs-html/_sources/library/zlib.rst.txt b/python-3.7.4-docs-html/_sources/library/zlib.rst.txt new file mode 100644 index 0000000..8a531c9 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/library/zlib.rst.txt @@ -0,0 +1,330 @@ +:mod:`zlib` --- Compression compatible with :program:`gzip` +=========================================================== + +.. module:: zlib + :synopsis: Low-level interface to compression and decompression routines + compatible with gzip. + +-------------- + +For applications that require data compression, the functions in this module +allow compression and decompression, using the zlib library. The zlib library +has its own home page at http://www.zlib.net. There are known +incompatibilities between the Python module and versions of the zlib library +earlier than 1.1.3; 1.1.3 has a security vulnerability, so we recommend using +1.1.4 or later. + +zlib's functions have many options and often need to be used in a particular +order. This documentation doesn't attempt to cover all of the permutations; +consult the zlib manual at http://www.zlib.net/manual.html for authoritative +information. + +For reading and writing ``.gz`` files see the :mod:`gzip` module. + +The available exception and functions in this module are: + + +.. exception:: error + + Exception raised on compression and decompression errors. + + +.. function:: adler32(data[, value]) + + Computes an Adler-32 checksum of *data*. (An Adler-32 checksum is almost as + reliable as a CRC32 but can be computed much more quickly.) The result + is an unsigned 32-bit integer. If *value* is present, it is used as + the starting value of the checksum; otherwise, a default value of 1 + is used. Passing in *value* allows computing a running checksum over the + concatenation of several inputs. The algorithm is not cryptographically + strong, and should not be used for authentication or digital signatures. Since + the algorithm is designed for use as a checksum algorithm, it is not suitable + for use as a general hash algorithm. + + .. versionchanged:: 3.0 + Always returns an unsigned value. + To generate the same numeric value across all Python versions and + platforms, use ``adler32(data) & 0xffffffff``. + + +.. function:: compress(data, level=-1) + + Compresses the bytes in *data*, returning a bytes object containing compressed data. + *level* is an integer from ``0`` to ``9`` or ``-1`` controlling the level of compression; + ``1`` (Z_BEST_SPEED) is fastest and produces the least compression, ``9`` (Z_BEST_COMPRESSION) + is slowest and produces the most. ``0`` (Z_NO_COMPRESSION) is no compression. + The default value is ``-1`` (Z_DEFAULT_COMPRESSION). Z_DEFAULT_COMPRESSION represents a default + compromise between speed and compression (currently equivalent to level 6). + Raises the :exc:`error` exception if any error occurs. + + .. versionchanged:: 3.6 + *level* can now be used as a keyword parameter. + + +.. function:: compressobj(level=-1, method=DEFLATED, wbits=MAX_WBITS, memLevel=DEF_MEM_LEVEL, strategy=Z_DEFAULT_STRATEGY[, zdict]) + + Returns a compression object, to be used for compressing data streams that won't + fit into memory at once. + + *level* is the compression level -- an integer from ``0`` to ``9`` or ``-1``. + A value of ``1`` (Z_BEST_SPEED) is fastest and produces the least compression, + while a value of ``9`` (Z_BEST_COMPRESSION) is slowest and produces the most. + ``0`` (Z_NO_COMPRESSION) is no compression. The default value is ``-1`` (Z_DEFAULT_COMPRESSION). + Z_DEFAULT_COMPRESSION represents a default compromise between speed and compression + (currently equivalent to level 6). + + *method* is the compression algorithm. Currently, the only supported value is + :const:`DEFLATED`. + + The *wbits* argument controls the size of the history buffer (or the + "window size") used when compressing data, and whether a header and + trailer is included in the output. It can take several ranges of values, + defaulting to ``15`` (MAX_WBITS): + + * +9 to +15: The base-two logarithm of the window size, which + therefore ranges between 512 and 32768. Larger values produce + better compression at the expense of greater memory usage. The + resulting output will include a zlib-specific header and trailer. + + * −9 to −15: Uses the absolute value of *wbits* as the + window size logarithm, while producing a raw output stream with no + header or trailing checksum. + + * +25 to +31 = 16 + (9 to 15): Uses the low 4 bits of the value as the + window size logarithm, while including a basic :program:`gzip` header + and trailing checksum in the output. + + The *memLevel* argument controls the amount of memory used for the + internal compression state. Valid values range from ``1`` to ``9``. + Higher values use more memory, but are faster and produce smaller output. + + *strategy* is used to tune the compression algorithm. Possible values are + :const:`Z_DEFAULT_STRATEGY`, :const:`Z_FILTERED`, :const:`Z_HUFFMAN_ONLY`, + :const:`Z_RLE` (zlib 1.2.0.1) and :const:`Z_FIXED` (zlib 1.2.2.2). + + *zdict* is a predefined compression dictionary. This is a sequence of bytes + (such as a :class:`bytes` object) containing subsequences that are expected + to occur frequently in the data that is to be compressed. Those subsequences + that are expected to be most common should come at the end of the dictionary. + + .. versionchanged:: 3.3 + Added the *zdict* parameter and keyword argument support. + + +.. function:: crc32(data[, value]) + + .. index:: + single: Cyclic Redundancy Check + single: checksum; Cyclic Redundancy Check + + Computes a CRC (Cyclic Redundancy Check) checksum of *data*. The + result is an unsigned 32-bit integer. If *value* is present, it is used + as the starting value of the checksum; otherwise, a default value of 0 + is used. Passing in *value* allows computing a running checksum over the + concatenation of several inputs. The algorithm is not cryptographically + strong, and should not be used for authentication or digital signatures. Since + the algorithm is designed for use as a checksum algorithm, it is not suitable + for use as a general hash algorithm. + + .. versionchanged:: 3.0 + Always returns an unsigned value. + To generate the same numeric value across all Python versions and + platforms, use ``crc32(data) & 0xffffffff``. + + +.. function:: decompress(data, wbits=MAX_WBITS, bufsize=DEF_BUF_SIZE) + + Decompresses the bytes in *data*, returning a bytes object containing the + uncompressed data. The *wbits* parameter depends on + the format of *data*, and is discussed further below. + If *bufsize* is given, it is used as the initial size of the output + buffer. Raises the :exc:`error` exception if any error occurs. + + .. _decompress-wbits: + + The *wbits* parameter controls the size of the history buffer + (or "window size"), and what header and trailer format is expected. + It is similar to the parameter for :func:`compressobj`, but accepts + more ranges of values: + + * +8 to +15: The base-two logarithm of the window size. The input + must include a zlib header and trailer. + + * 0: Automatically determine the window size from the zlib header. + Only supported since zlib 1.2.3.5. + + * −8 to −15: Uses the absolute value of *wbits* as the window size + logarithm. The input must be a raw stream with no header or trailer. + + * +24 to +31 = 16 + (8 to 15): Uses the low 4 bits of the value as + the window size logarithm. The input must include a gzip header and + trailer. + + * +40 to +47 = 32 + (8 to 15): Uses the low 4 bits of the value as + the window size logarithm, and automatically accepts either + the zlib or gzip format. + + When decompressing a stream, the window size must not be smaller + than the size originally used to compress the stream; using a too-small + value may result in an :exc:`error` exception. The default *wbits* value + corresponds to the largest window size and requires a zlib header and + trailer to be included. + + *bufsize* is the initial size of the buffer used to hold decompressed data. If + more space is required, the buffer size will be increased as needed, so you + don't have to get this value exactly right; tuning it will only save a few calls + to :c:func:`malloc`. + + .. versionchanged:: 3.6 + *wbits* and *bufsize* can be used as keyword arguments. + +.. function:: decompressobj(wbits=MAX_WBITS[, zdict]) + + Returns a decompression object, to be used for decompressing data streams that + won't fit into memory at once. + + The *wbits* parameter controls the size of the history buffer (or the + "window size"), and what header and trailer format is expected. It has + the same meaning as `described for decompress() <#decompress-wbits>`__. + + The *zdict* parameter specifies a predefined compression dictionary. If + provided, this must be the same dictionary as was used by the compressor that + produced the data that is to be decompressed. + + .. note:: + + If *zdict* is a mutable object (such as a :class:`bytearray`), you must not + modify its contents between the call to :func:`decompressobj` and the first + call to the decompressor's ``decompress()`` method. + + .. versionchanged:: 3.3 + Added the *zdict* parameter. + + +Compression objects support the following methods: + + +.. method:: Compress.compress(data) + + Compress *data*, returning a bytes object containing compressed data for at least + part of the data in *data*. This data should be concatenated to the output + produced by any preceding calls to the :meth:`compress` method. Some input may + be kept in internal buffers for later processing. + + +.. method:: Compress.flush([mode]) + + All pending input is processed, and a bytes object containing the remaining compressed + output is returned. *mode* can be selected from the constants + :const:`Z_NO_FLUSH`, :const:`Z_PARTIAL_FLUSH`, :const:`Z_SYNC_FLUSH`, + :const:`Z_FULL_FLUSH`, :const:`Z_BLOCK` (zlib 1.2.3.4), or :const:`Z_FINISH`, + defaulting to :const:`Z_FINISH`. Except :const:`Z_FINISH`, all constants + allow compressing further bytestrings of data, while :const:`Z_FINISH` finishes the + compressed stream and prevents compressing any more data. After calling :meth:`flush` + with *mode* set to :const:`Z_FINISH`, the :meth:`compress` method cannot be called again; + the only realistic action is to delete the object. + + +.. method:: Compress.copy() + + Returns a copy of the compression object. This can be used to efficiently + compress a set of data that share a common initial prefix. + + +Decompression objects support the following methods and attributes: + + +.. attribute:: Decompress.unused_data + + A bytes object which contains any bytes past the end of the compressed data. That is, + this remains ``b""`` until the last byte that contains compression data is + available. If the whole bytestring turned out to contain compressed data, this is + ``b""``, an empty bytes object. + + +.. attribute:: Decompress.unconsumed_tail + + A bytes object that contains any data that was not consumed by the last + :meth:`decompress` call because it exceeded the limit for the uncompressed data + buffer. This data has not yet been seen by the zlib machinery, so you must feed + it (possibly with further data concatenated to it) back to a subsequent + :meth:`decompress` method call in order to get correct output. + + +.. attribute:: Decompress.eof + + A boolean indicating whether the end of the compressed data stream has been + reached. + + This makes it possible to distinguish between a properly-formed compressed + stream, and an incomplete or truncated one. + + .. versionadded:: 3.3 + + +.. method:: Decompress.decompress(data, max_length=0) + + Decompress *data*, returning a bytes object containing the uncompressed data + corresponding to at least part of the data in *string*. This data should be + concatenated to the output produced by any preceding calls to the + :meth:`decompress` method. Some of the input data may be preserved in internal + buffers for later processing. + + If the optional parameter *max_length* is non-zero then the return value will be + no longer than *max_length*. This may mean that not all of the compressed input + can be processed; and unconsumed data will be stored in the attribute + :attr:`unconsumed_tail`. This bytestring must be passed to a subsequent call to + :meth:`decompress` if decompression is to continue. If *max_length* is zero + then the whole input is decompressed, and :attr:`unconsumed_tail` is empty. + + .. versionchanged:: 3.6 + *max_length* can be used as a keyword argument. + + +.. method:: Decompress.flush([length]) + + All pending input is processed, and a bytes object containing the remaining + uncompressed output is returned. After calling :meth:`flush`, the + :meth:`decompress` method cannot be called again; the only realistic action is + to delete the object. + + The optional parameter *length* sets the initial size of the output buffer. + + +.. method:: Decompress.copy() + + Returns a copy of the decompression object. This can be used to save the state + of the decompressor midway through the data stream in order to speed up random + seeks into the stream at a future point. + + +Information about the version of the zlib library in use is available through +the following constants: + + +.. data:: ZLIB_VERSION + + The version string of the zlib library that was used for building the module. + This may be different from the zlib library actually used at runtime, which + is available as :const:`ZLIB_RUNTIME_VERSION`. + + +.. data:: ZLIB_RUNTIME_VERSION + + The version string of the zlib library actually loaded by the interpreter. + + .. versionadded:: 3.3 + + +.. seealso:: + + Module :mod:`gzip` + Reading and writing :program:`gzip`\ -format files. + + http://www.zlib.net + The zlib library home page. + + http://www.zlib.net/manual.html + The zlib manual explains the semantics and usage of the library's many + functions. + diff --git a/python-3.7.4-docs-html/_sources/license.rst.txt b/python-3.7.4-docs-html/_sources/license.rst.txt new file mode 100644 index 0000000..ac0e2b3 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/license.rst.txt @@ -0,0 +1,915 @@ +.. highlightlang:: none + +.. _history-and-license: + +******************* +History and License +******************* + + +History of the software +======================= + +Python was created in the early 1990s by Guido van Rossum at Stichting +Mathematisch Centrum (CWI, see https://www.cwi.nl/) in the Netherlands as a +successor of a language called ABC. Guido remains Python's principal author, +although it includes many contributions from others. + +In 1995, Guido continued his work on Python at the Corporation for National +Research Initiatives (CNRI, see https://www.cnri.reston.va.us/) in Reston, +Virginia where he released several versions of the software. + +In May 2000, Guido and the Python core development team moved to BeOpen.com to +form the BeOpen PythonLabs team. In October of the same year, the PythonLabs +team moved to Digital Creations (now Zope Corporation; see +http://www.zope.com/). In 2001, the Python Software Foundation (PSF, see +https://www.python.org/psf/) was formed, a non-profit organization created +specifically to own Python-related Intellectual Property. Zope Corporation is a +sponsoring member of the PSF. + +All Python releases are Open Source (see https://opensource.org/ for the Open +Source Definition). Historically, most, but not all, Python releases have also +been GPL-compatible; the table below summarizes the various releases. + ++----------------+--------------+------------+------------+-----------------+ +| Release | Derived from | Year | Owner | GPL compatible? | ++================+==============+============+============+=================+ +| 0.9.0 thru 1.2 | n/a | 1991-1995 | CWI | yes | ++----------------+--------------+------------+------------+-----------------+ +| 1.3 thru 1.5.2 | 1.2 | 1995-1999 | CNRI | yes | ++----------------+--------------+------------+------------+-----------------+ +| 1.6 | 1.5.2 | 2000 | CNRI | no | ++----------------+--------------+------------+------------+-----------------+ +| 2.0 | 1.6 | 2000 | BeOpen.com | no | ++----------------+--------------+------------+------------+-----------------+ +| 1.6.1 | 1.6 | 2001 | CNRI | no | ++----------------+--------------+------------+------------+-----------------+ +| 2.1 | 2.0+1.6.1 | 2001 | PSF | no | ++----------------+--------------+------------+------------+-----------------+ +| 2.0.1 | 2.0+1.6.1 | 2001 | PSF | yes | ++----------------+--------------+------------+------------+-----------------+ +| 2.1.1 | 2.1+2.0.1 | 2001 | PSF | yes | ++----------------+--------------+------------+------------+-----------------+ +| 2.1.2 | 2.1.1 | 2002 | PSF | yes | ++----------------+--------------+------------+------------+-----------------+ +| 2.1.3 | 2.1.2 | 2002 | PSF | yes | ++----------------+--------------+------------+------------+-----------------+ +| 2.2 and above | 2.1.1 | 2001-now | PSF | yes | ++----------------+--------------+------------+------------+-----------------+ + +.. note:: + + GPL-compatible doesn't mean that we're distributing Python under the GPL. All + Python licenses, unlike the GPL, let you distribute a modified version without + making your changes open source. The GPL-compatible licenses make it possible to + combine Python with other software that is released under the GPL; the others + don't. + +Thanks to the many outside volunteers who have worked under Guido's direction to +make these releases possible. + + +Terms and conditions for accessing or otherwise using Python +============================================================ + + +PSF LICENSE AGREEMENT FOR PYTHON |release| +------------------------------------------ + +.. parsed-literal:: + + 1. This LICENSE AGREEMENT is between the Python Software Foundation ("PSF"), and + the Individual or Organization ("Licensee") accessing and otherwise using Python + |release| software in source or binary form and its associated documentation. + + 2. Subject to the terms and conditions of this License Agreement, PSF hereby + grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce, + analyze, test, perform and/or display publicly, prepare derivative works, + distribute, and otherwise use Python |release| alone or in any derivative + version, provided, however, that PSF's License Agreement and PSF's notice of + copyright, i.e., "Copyright © 2001-2019 Python Software Foundation; All Rights + Reserved" are retained in Python |release| alone or in any derivative version + prepared by Licensee. + + 3. In the event Licensee prepares a derivative work that is based on or + incorporates Python |release| or any part thereof, and wants to make the + derivative work available to others as provided herein, then Licensee hereby + agrees to include in any such work a brief summary of the changes made to Python + |release|. + + 4. PSF is making Python |release| available to Licensee on an "AS IS" basis. + PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED. BY WAY OF + EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND DISCLAIMS ANY REPRESENTATION OR + WARRANTY OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE + USE OF PYTHON |release| WILL NOT INFRINGE ANY THIRD PARTY RIGHTS. + + 5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON |release| + FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF + MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON |release|, OR ANY DERIVATIVE + THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF. + + 6. This License Agreement will automatically terminate upon a material breach of + its terms and conditions. + + 7. Nothing in this License Agreement shall be deemed to create any relationship + of agency, partnership, or joint venture between PSF and Licensee. This License + Agreement does not grant permission to use PSF trademarks or trade name in a + trademark sense to endorse or promote products or services of Licensee, or any + third party. + + 8. By copying, installing or otherwise using Python |release|, Licensee agrees + to be bound by the terms and conditions of this License Agreement. + + +BEOPEN.COM LICENSE AGREEMENT FOR PYTHON 2.0 +------------------------------------------- + +BEOPEN PYTHON OPEN SOURCE LICENSE AGREEMENT VERSION 1 + +.. parsed-literal:: + + 1. This LICENSE AGREEMENT is between BeOpen.com ("BeOpen"), having an office at + 160 Saratoga Avenue, Santa Clara, CA 95051, and the Individual or Organization + ("Licensee") accessing and otherwise using this software in source or binary + form and its associated documentation ("the Software"). + + 2. Subject to the terms and conditions of this BeOpen Python License Agreement, + BeOpen hereby grants Licensee a non-exclusive, royalty-free, world-wide license + to reproduce, analyze, test, perform and/or display publicly, prepare derivative + works, distribute, and otherwise use the Software alone or in any derivative + version, provided, however, that the BeOpen Python License is retained in the + Software, alone or in any derivative version prepared by Licensee. + + 3. BeOpen is making the Software available to Licensee on an "AS IS" basis. + BEOPEN MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED. BY WAY OF + EXAMPLE, BUT NOT LIMITATION, BEOPEN MAKES NO AND DISCLAIMS ANY REPRESENTATION OR + WARRANTY OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE + USE OF THE SOFTWARE WILL NOT INFRINGE ANY THIRD PARTY RIGHTS. + + 4. BEOPEN SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF THE SOFTWARE FOR + ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF USING, + MODIFYING OR DISTRIBUTING THE SOFTWARE, OR ANY DERIVATIVE THEREOF, EVEN IF + ADVISED OF THE POSSIBILITY THEREOF. + + 5. This License Agreement will automatically terminate upon a material breach of + its terms and conditions. + + 6. This License Agreement shall be governed by and interpreted in all respects + by the law of the State of California, excluding conflict of law provisions. + Nothing in this License Agreement shall be deemed to create any relationship of + agency, partnership, or joint venture between BeOpen and Licensee. This License + Agreement does not grant permission to use BeOpen trademarks or trade names in a + trademark sense to endorse or promote products or services of Licensee, or any + third party. As an exception, the "BeOpen Python" logos available at + http://www.pythonlabs.com/logos.html may be used according to the permissions + granted on that web page. + + 7. By copying, installing or otherwise using the software, Licensee agrees to be + bound by the terms and conditions of this License Agreement. + + +CNRI LICENSE AGREEMENT FOR PYTHON 1.6.1 +--------------------------------------- + +.. parsed-literal:: + + 1. This LICENSE AGREEMENT is between the Corporation for National Research + Initiatives, having an office at 1895 Preston White Drive, Reston, VA 20191 + ("CNRI"), and the Individual or Organization ("Licensee") accessing and + otherwise using Python 1.6.1 software in source or binary form and its + associated documentation. + + 2. Subject to the terms and conditions of this License Agreement, CNRI hereby + grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce, + analyze, test, perform and/or display publicly, prepare derivative works, + distribute, and otherwise use Python 1.6.1 alone or in any derivative version, + provided, however, that CNRI's License Agreement and CNRI's notice of copyright, + i.e., "Copyright © 1995-2001 Corporation for National Research Initiatives; All + Rights Reserved" are retained in Python 1.6.1 alone or in any derivative version + prepared by Licensee. Alternately, in lieu of CNRI's License Agreement, + Licensee may substitute the following text (omitting the quotes): "Python 1.6.1 + is made available subject to the terms and conditions in CNRI's License + Agreement. This Agreement together with Python 1.6.1 may be located on the + Internet using the following unique, persistent identifier (known as a handle): + 1895.22/1013. This Agreement may also be obtained from a proxy server on the + Internet using the following URL: http://hdl.handle.net/1895.22/1013." + + 3. In the event Licensee prepares a derivative work that is based on or + incorporates Python 1.6.1 or any part thereof, and wants to make the derivative + work available to others as provided herein, then Licensee hereby agrees to + include in any such work a brief summary of the changes made to Python 1.6.1. + + 4. CNRI is making Python 1.6.1 available to Licensee on an "AS IS" basis. CNRI + MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED. BY WAY OF EXAMPLE, + BUT NOT LIMITATION, CNRI MAKES NO AND DISCLAIMS ANY REPRESENTATION OR WARRANTY + OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF + PYTHON 1.6.1 WILL NOT INFRINGE ANY THIRD PARTY RIGHTS. + + 5. CNRI SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON 1.6.1 FOR + ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF + MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 1.6.1, OR ANY DERIVATIVE + THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF. + + 6. This License Agreement will automatically terminate upon a material breach of + its terms and conditions. + + 7. This License Agreement shall be governed by the federal intellectual property + law of the United States, including without limitation the federal copyright + law, and, to the extent such U.S. federal law does not apply, by the law of the + Commonwealth of Virginia, excluding Virginia's conflict of law provisions. + Notwithstanding the foregoing, with regard to derivative works based on Python + 1.6.1 that incorporate non-separable material that was previously distributed + under the GNU General Public License (GPL), the law of the Commonwealth of + Virginia shall govern this License Agreement only as to issues arising under or + with respect to Paragraphs 4, 5, and 7 of this License Agreement. Nothing in + this License Agreement shall be deemed to create any relationship of agency, + partnership, or joint venture between CNRI and Licensee. This License Agreement + does not grant permission to use CNRI trademarks or trade name in a trademark + sense to endorse or promote products or services of Licensee, or any third + party. + + 8. By clicking on the "ACCEPT" button where indicated, or by copying, installing + or otherwise using Python 1.6.1, Licensee agrees to be bound by the terms and + conditions of this License Agreement. + + +CWI LICENSE AGREEMENT FOR PYTHON 0.9.0 THROUGH 1.2 +-------------------------------------------------- + +.. parsed-literal:: + + Copyright © 1991 - 1995, Stichting Mathematisch Centrum Amsterdam, The + Netherlands. All rights reserved. + + Permission to use, copy, modify, and distribute this software and its + documentation for any purpose and without fee is hereby granted, provided that + the above copyright notice appear in all copies and that both that copyright + notice and this permission notice appear in supporting documentation, and that + the name of Stichting Mathematisch Centrum or CWI not be used in advertising or + publicity pertaining to distribution of the software without specific, written + prior permission. + + STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS + SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO + EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE FOR ANY SPECIAL, INDIRECT + OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, + DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS + ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS + SOFTWARE. + + +Licenses and Acknowledgements for Incorporated Software +======================================================= + +This section is an incomplete, but growing list of licenses and acknowledgements +for third-party software incorporated in the Python distribution. + + +Mersenne Twister +---------------- + +The :mod:`_random` module includes code based on a download from +http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/emt19937ar.html. The following are +the verbatim comments from the original code:: + + A C-program for MT19937, with initialization improved 2002/1/26. + Coded by Takuji Nishimura and Makoto Matsumoto. + + Before using, initialize the state by using init_genrand(seed) + or init_by_array(init_key, key_length). + + Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura, + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + 1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + + 3. The names of its contributors may not be used to endorse or promote + products derived from this software without specific prior written + permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + + Any feedback is very welcome. + http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html + email: m-mat @ math.sci.hiroshima-u.ac.jp (remove space) + + +Sockets +------- + +The :mod:`socket` module uses the functions, :func:`getaddrinfo`, and +:func:`getnameinfo`, which are coded in separate source files from the WIDE +Project, http://www.wide.ad.jp/. :: + + Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + 1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + 3. Neither the name of the project nor the names of its contributors + may be used to endorse or promote products derived from this software + without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND + ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE + FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + SUCH DAMAGE. + + +Asynchronous socket services +---------------------------- + +The :mod:`asynchat` and :mod:`asyncore` modules contain the following notice:: + + Copyright 1996 by Sam Rushing + + All Rights Reserved + + Permission to use, copy, modify, and distribute this software and + its documentation for any purpose and without fee is hereby + granted, provided that the above copyright notice appear in all + copies and that both that copyright notice and this permission + notice appear in supporting documentation, and that the name of Sam + Rushing not be used in advertising or publicity pertaining to + distribution of the software without specific, written prior + permission. + + SAM RUSHING DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, + INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN + NO EVENT SHALL SAM RUSHING BE LIABLE FOR ANY SPECIAL, INDIRECT OR + CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS + OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, + NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN + CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + + +Cookie management +----------------- + +The :mod:`http.cookies` module contains the following notice:: + + Copyright 2000 by Timothy O'Malley + + All Rights Reserved + + Permission to use, copy, modify, and distribute this software + and its documentation for any purpose and without fee is hereby + granted, provided that the above copyright notice appear in all + copies and that both that copyright notice and this permission + notice appear in supporting documentation, and that the name of + Timothy O'Malley not be used in advertising or publicity + pertaining to distribution of the software without specific, written + prior permission. + + Timothy O'Malley DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS + SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY + AND FITNESS, IN NO EVENT SHALL Timothy O'Malley BE LIABLE FOR + ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, + WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS + ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR + PERFORMANCE OF THIS SOFTWARE. + + +Execution tracing +----------------- + +The :mod:`trace` module contains the following notice:: + + portions copyright 2001, Autonomous Zones Industries, Inc., all rights... + err... reserved and offered to the public under the terms of the + Python 2.2 license. + Author: Zooko O'Whielacronx + http://zooko.com/ + mailto:zooko@zooko.com + + Copyright 2000, Mojam Media, Inc., all rights reserved. + Author: Skip Montanaro + + Copyright 1999, Bioreason, Inc., all rights reserved. + Author: Andrew Dalke + + Copyright 1995-1997, Automatrix, Inc., all rights reserved. + Author: Skip Montanaro + + Copyright 1991-1995, Stichting Mathematisch Centrum, all rights reserved. + + + Permission to use, copy, modify, and distribute this Python software and + its associated documentation for any purpose without fee is hereby + granted, provided that the above copyright notice appears in all copies, + and that both that copyright notice and this permission notice appear in + supporting documentation, and that the name of neither Automatrix, + Bioreason or Mojam Media be used in advertising or publicity pertaining to + distribution of the software without specific, written prior permission. + + +UUencode and UUdecode functions +------------------------------- + +The :mod:`uu` module contains the following notice:: + + Copyright 1994 by Lance Ellinghouse + Cathedral City, California Republic, United States of America. + All Rights Reserved + Permission to use, copy, modify, and distribute this software and its + documentation for any purpose and without fee is hereby granted, + provided that the above copyright notice appear in all copies and that + both that copyright notice and this permission notice appear in + supporting documentation, and that the name of Lance Ellinghouse + not be used in advertising or publicity pertaining to distribution + of the software without specific, written prior permission. + LANCE ELLINGHOUSE DISCLAIMS ALL WARRANTIES WITH REGARD TO + THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND + FITNESS, IN NO EVENT SHALL LANCE ELLINGHOUSE CENTRUM BE LIABLE + FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT + OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + + Modified by Jack Jansen, CWI, July 1995: + - Use binascii module to do the actual line-by-line conversion + between ascii and binary. This results in a 1000-fold speedup. The C + version is still 5 times faster, though. + - Arguments more compliant with Python standard + + +XML Remote Procedure Calls +-------------------------- + +The :mod:`xmlrpc.client` module contains the following notice:: + + The XML-RPC client interface is + + Copyright (c) 1999-2002 by Secret Labs AB + Copyright (c) 1999-2002 by Fredrik Lundh + + By obtaining, using, and/or copying this software and/or its + associated documentation, you agree that you have read, understood, + and will comply with the following terms and conditions: + + Permission to use, copy, modify, and distribute this software and + its associated documentation for any purpose and without fee is + hereby granted, provided that the above copyright notice appears in + all copies, and that both that copyright notice and this permission + notice appear in supporting documentation, and that the name of + Secret Labs AB or the author not be used in advertising or publicity + pertaining to distribution of the software without specific, written + prior permission. + + SECRET LABS AB AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD + TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANT- + ABILITY AND FITNESS. IN NO EVENT SHALL SECRET LABS AB OR THE AUTHOR + BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY + DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, + WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS + ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE + OF THIS SOFTWARE. + + +test_epoll +---------- + +The :mod:`test_epoll` module contains the following notice:: + + Copyright (c) 2001-2006 Twisted Matrix Laboratories. + + Permission is hereby granted, free of charge, to any person obtaining + a copy of this software and associated documentation files (the + "Software"), to deal in the Software without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Software, and to + permit persons to whom the Software is furnished to do so, subject to + the following conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +Select kqueue +------------- + +The :mod:`select` module contains the following notice for the kqueue +interface:: + + Copyright (c) 2000 Doug White, 2006 James Knight, 2007 Christian Heimes + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + 1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + + THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND + ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + SUCH DAMAGE. + + +SipHash24 +--------- + +The file :file:`Python/pyhash.c` contains Marek Majkowski' implementation of +Dan Bernstein's SipHash24 algorithm. It contains the following note:: + + + Copyright (c) 2013 Marek Majkowski + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software. + + + Original location: + https://github.com/majek/csiphash/ + + Solution inspired by code from: + Samuel Neves (supercop/crypto_auth/siphash24/little) + djb (supercop/crypto_auth/siphash24/little2) + Jean-Philippe Aumasson (https://131002.net/siphash/siphash24.c) + + +strtod and dtoa +--------------- + +The file :file:`Python/dtoa.c`, which supplies C functions dtoa and +strtod for conversion of C doubles to and from strings, is derived +from the file of the same name by David M. Gay, currently available +from http://www.netlib.org/fp/. The original file, as retrieved on +March 16, 2009, contains the following copyright and licensing +notice:: + + /**************************************************************** + * + * The author of this software is David M. Gay. + * + * Copyright (c) 1991, 2000, 2001 by Lucent Technologies. + * + * Permission to use, copy, modify, and distribute this software for any + * purpose without fee is hereby granted, provided that this entire notice + * is included in all copies of any software which is or includes a copy + * or modification of this software and in all copies of the supporting + * documentation for such software. + * + * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED + * WARRANTY. IN PARTICULAR, NEITHER THE AUTHOR NOR LUCENT MAKES ANY + * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE MERCHANTABILITY + * OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR PURPOSE. + * + ***************************************************************/ + + +OpenSSL +------- + +The modules :mod:`hashlib`, :mod:`posix`, :mod:`ssl`, :mod:`crypt` use +the OpenSSL library for added performance if made available by the +operating system. Additionally, the Windows and Mac OS X installers for +Python may include a copy of the OpenSSL libraries, so we include a copy +of the OpenSSL license here:: + + + LICENSE ISSUES + ============== + + The OpenSSL toolkit stays under a dual license, i.e. both the conditions of + the OpenSSL License and the original SSLeay license apply to the toolkit. + See below for the actual license texts. Actually both licenses are BSD-style + Open Source licenses. In case of any license issues related to OpenSSL + please contact openssl-core@openssl.org. + + OpenSSL License + --------------- + + /* ==================================================================== + * Copyright (c) 1998-2008 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + + Original SSLeay License + ----------------------- + + /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + + +expat +----- + +The :mod:`pyexpat` extension is built using an included copy of the expat +sources unless the build is configured ``--with-system-expat``:: + + Copyright (c) 1998, 1999, 2000 Thai Open Source Software Center Ltd + and Clark Cooper + + Permission is hereby granted, free of charge, to any person obtaining + a copy of this software and associated documentation files (the + "Software"), to deal in the Software without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Software, and to + permit persons to whom the Software is furnished to do so, subject to + the following conditions: + + The above copyright notice and this permission notice shall be included + in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. + IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY + CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, + TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE + SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + +libffi +------ + +The :mod:`_ctypes` extension is built using an included copy of the libffi +sources unless the build is configured ``--with-system-libffi``:: + + Copyright (c) 1996-2008 Red Hat, Inc and others. + + Permission is hereby granted, free of charge, to any person obtaining + a copy of this software and associated documentation files (the + ``Software''), to deal in the Software without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Software, and to + permit persons to whom the Software is furnished to do so, subject to + the following conditions: + + The above copyright notice and this permission notice shall be included + in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED ``AS IS'', WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + DEALINGS IN THE SOFTWARE. + + +zlib +---- + +The :mod:`zlib` extension is built using an included copy of the zlib +sources if the zlib version found on the system is too old to be +used for the build:: + + Copyright (C) 1995-2011 Jean-loup Gailly and Mark Adler + + This software is provided 'as-is', without any express or implied + warranty. In no event will the authors be held liable for any damages + arising from the use of this software. + + Permission is granted to anyone to use this software for any purpose, + including commercial applications, and to alter it and redistribute it + freely, subject to the following restrictions: + + 1. The origin of this software must not be misrepresented; you must not + claim that you wrote the original software. If you use this software + in a product, an acknowledgment in the product documentation would be + appreciated but is not required. + + 2. Altered source versions must be plainly marked as such, and must not be + misrepresented as being the original software. + + 3. This notice may not be removed or altered from any source distribution. + + Jean-loup Gailly Mark Adler + jloup@gzip.org madler@alumni.caltech.edu + + +cfuhash +------- + +The implementation of the hash table used by the :mod:`tracemalloc` is based +on the cfuhash project:: + + Copyright (c) 2005 Don Owens + All rights reserved. + + This code is released under the BSD license: + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + + * Neither the name of the author nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + OF THE POSSIBILITY OF SUCH DAMAGE. + + +libmpdec +-------- + +The :mod:`_decimal` module is built using an included copy of the libmpdec +library unless the build is configured ``--with-system-libmpdec``:: + + Copyright (c) 2008-2016 Stefan Krah. All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + 1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + + THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND + ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + SUCH DAMAGE. diff --git a/python-3.7.4-docs-html/_sources/reference/compound_stmts.rst.txt b/python-3.7.4-docs-html/_sources/reference/compound_stmts.rst.txt new file mode 100644 index 0000000..1d84274 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/reference/compound_stmts.rst.txt @@ -0,0 +1,853 @@ +.. _compound: + +******************* +Compound statements +******************* + +.. index:: pair: compound; statement + +Compound statements contain (groups of) other statements; they affect or control +the execution of those other statements in some way. In general, compound +statements span multiple lines, although in simple incarnations a whole compound +statement may be contained in one line. + +The :keyword:`if`, :keyword:`while` and :keyword:`for` statements implement +traditional control flow constructs. :keyword:`try` specifies exception +handlers and/or cleanup code for a group of statements, while the +:keyword:`with` statement allows the execution of initialization and +finalization code around a block of code. Function and class definitions are +also syntactically compound statements. + +.. index:: + single: clause + single: suite + single: ; (semicolon) + +A compound statement consists of one or more 'clauses.' A clause consists of a +header and a 'suite.' The clause headers of a particular compound statement are +all at the same indentation level. Each clause header begins with a uniquely +identifying keyword and ends with a colon. A suite is a group of statements +controlled by a clause. A suite can be one or more semicolon-separated simple +statements on the same line as the header, following the header's colon, or it +can be one or more indented statements on subsequent lines. Only the latter +form of a suite can contain nested compound statements; the following is illegal, +mostly because it wouldn't be clear to which :keyword:`if` clause a following +:keyword:`else` clause would belong:: + + if test1: if test2: print(x) + +Also note that the semicolon binds tighter than the colon in this context, so +that in the following example, either all or none of the :func:`print` calls are +executed:: + + if x < y < z: print(x); print(y); print(z) + +Summarizing: + +.. productionlist:: + compound_stmt: `if_stmt` + : | `while_stmt` + : | `for_stmt` + : | `try_stmt` + : | `with_stmt` + : | `funcdef` + : | `classdef` + : | `async_with_stmt` + : | `async_for_stmt` + : | `async_funcdef` + suite: `stmt_list` NEWLINE | NEWLINE INDENT `statement`+ DEDENT + statement: `stmt_list` NEWLINE | `compound_stmt` + stmt_list: `simple_stmt` (";" `simple_stmt`)* [";"] + +.. index:: + single: NEWLINE token + single: DEDENT token + pair: dangling; else + +Note that statements always end in a ``NEWLINE`` possibly followed by a +``DEDENT``. Also note that optional continuation clauses always begin with a +keyword that cannot start a statement, thus there are no ambiguities (the +'dangling :keyword:`else`' problem is solved in Python by requiring nested +:keyword:`if` statements to be indented). + +The formatting of the grammar rules in the following sections places each clause +on a separate line for clarity. + + +.. _if: +.. _elif: +.. _else: + +The :keyword:`!if` statement +============================ + +.. index:: + ! statement: if + keyword: elif + keyword: else + single: : (colon); compound statement + +The :keyword:`if` statement is used for conditional execution: + +.. productionlist:: + if_stmt: "if" `expression` ":" `suite` + : ("elif" `expression` ":" `suite`)* + : ["else" ":" `suite`] + +It selects exactly one of the suites by evaluating the expressions one by one +until one is found to be true (see section :ref:`booleans` for the definition of +true and false); then that suite is executed (and no other part of the +:keyword:`if` statement is executed or evaluated). If all expressions are +false, the suite of the :keyword:`else` clause, if present, is executed. + + +.. _while: + +The :keyword:`!while` statement +=============================== + +.. index:: + ! statement: while + keyword: else + pair: loop; statement + single: : (colon); compound statement + +The :keyword:`while` statement is used for repeated execution as long as an +expression is true: + +.. productionlist:: + while_stmt: "while" `expression` ":" `suite` + : ["else" ":" `suite`] + +This repeatedly tests the expression and, if it is true, executes the first +suite; if the expression is false (which may be the first time it is tested) the +suite of the :keyword:`!else` clause, if present, is executed and the loop +terminates. + +.. index:: + statement: break + statement: continue + +A :keyword:`break` statement executed in the first suite terminates the loop +without executing the :keyword:`!else` clause's suite. A :keyword:`continue` +statement executed in the first suite skips the rest of the suite and goes back +to testing the expression. + + +.. _for: + +The :keyword:`!for` statement +============================= + +.. index:: + ! statement: for + keyword: in + keyword: else + pair: target; list + pair: loop; statement + object: sequence + single: : (colon); compound statement + +The :keyword:`for` statement is used to iterate over the elements of a sequence +(such as a string, tuple or list) or other iterable object: + +.. productionlist:: + for_stmt: "for" `target_list` "in" `expression_list` ":" `suite` + : ["else" ":" `suite`] + +The expression list is evaluated once; it should yield an iterable object. An +iterator is created for the result of the ``expression_list``. The suite is +then executed once for each item provided by the iterator, in the order returned +by the iterator. Each item in turn is assigned to the target list using the +standard rules for assignments (see :ref:`assignment`), and then the suite is +executed. When the items are exhausted (which is immediately when the sequence +is empty or an iterator raises a :exc:`StopIteration` exception), the suite in +the :keyword:`!else` clause, if present, is executed, and the loop terminates. + +.. index:: + statement: break + statement: continue + +A :keyword:`break` statement executed in the first suite terminates the loop +without executing the :keyword:`!else` clause's suite. A :keyword:`continue` +statement executed in the first suite skips the rest of the suite and continues +with the next item, or with the :keyword:`!else` clause if there is no next +item. + +The for-loop makes assignments to the variables(s) in the target list. +This overwrites all previous assignments to those variables including +those made in the suite of the for-loop:: + + for i in range(10): + print(i) + i = 5 # this will not affect the for-loop + # because i will be overwritten with the next + # index in the range + + +.. index:: + builtin: range + +Names in the target list are not deleted when the loop is finished, but if the +sequence is empty, they will not have been assigned to at all by the loop. Hint: +the built-in function :func:`range` returns an iterator of integers suitable to +emulate the effect of Pascal's ``for i := a to b do``; e.g., ``list(range(3))`` +returns the list ``[0, 1, 2]``. + +.. note:: + + .. index:: + single: loop; over mutable sequence + single: mutable sequence; loop over + + There is a subtlety when the sequence is being modified by the loop (this can + only occur for mutable sequences, e.g. lists). An internal counter is used + to keep track of which item is used next, and this is incremented on each + iteration. When this counter has reached the length of the sequence the loop + terminates. This means that if the suite deletes the current (or a previous) + item from the sequence, the next item will be skipped (since it gets the + index of the current item which has already been treated). Likewise, if the + suite inserts an item in the sequence before the current item, the current + item will be treated again the next time through the loop. This can lead to + nasty bugs that can be avoided by making a temporary copy using a slice of + the whole sequence, e.g., :: + + for x in a[:]: + if x < 0: a.remove(x) + + +.. _try: +.. _except: +.. _finally: + +The :keyword:`!try` statement +============================= + +.. index:: + ! statement: try + keyword: except + keyword: finally + keyword: else + keyword: as + single: : (colon); compound statement + +The :keyword:`try` statement specifies exception handlers and/or cleanup code +for a group of statements: + +.. productionlist:: + try_stmt: `try1_stmt` | `try2_stmt` + try1_stmt: "try" ":" `suite` + : ("except" [`expression` ["as" `identifier`]] ":" `suite`)+ + : ["else" ":" `suite`] + : ["finally" ":" `suite`] + try2_stmt: "try" ":" `suite` + : "finally" ":" `suite` + + +The :keyword:`except` clause(s) specify one or more exception handlers. When no +exception occurs in the :keyword:`try` clause, no exception handler is executed. +When an exception occurs in the :keyword:`!try` suite, a search for an exception +handler is started. This search inspects the except clauses in turn until one +is found that matches the exception. An expression-less except clause, if +present, must be last; it matches any exception. For an except clause with an +expression, that expression is evaluated, and the clause matches the exception +if the resulting object is "compatible" with the exception. An object is +compatible with an exception if it is the class or a base class of the exception +object or a tuple containing an item compatible with the exception. + +If no except clause matches the exception, the search for an exception handler +continues in the surrounding code and on the invocation stack. [#]_ + +If the evaluation of an expression in the header of an except clause raises an +exception, the original search for a handler is canceled and a search starts for +the new exception in the surrounding code and on the call stack (it is treated +as if the entire :keyword:`try` statement raised the exception). + +.. index:: single: as; except clause + +When a matching except clause is found, the exception is assigned to the target +specified after the :keyword:`!as` keyword in that except clause, if present, and +the except clause's suite is executed. All except clauses must have an +executable block. When the end of this block is reached, execution continues +normally after the entire try statement. (This means that if two nested +handlers exist for the same exception, and the exception occurs in the try +clause of the inner handler, the outer handler will not handle the exception.) + +When an exception has been assigned using ``as target``, it is cleared at the +end of the except clause. This is as if :: + + except E as N: + foo + +was translated to :: + + except E as N: + try: + foo + finally: + del N + +This means the exception must be assigned to a different name to be able to +refer to it after the except clause. Exceptions are cleared because with the +traceback attached to them, they form a reference cycle with the stack frame, +keeping all locals in that frame alive until the next garbage collection occurs. + +.. index:: + module: sys + object: traceback + +Before an except clause's suite is executed, details about the exception are +stored in the :mod:`sys` module and can be accessed via :func:`sys.exc_info`. +:func:`sys.exc_info` returns a 3-tuple consisting of the exception class, the +exception instance and a traceback object (see section :ref:`types`) identifying +the point in the program where the exception occurred. :func:`sys.exc_info` +values are restored to their previous values (before the call) when returning +from a function that handled an exception. + +.. index:: + keyword: else + statement: return + statement: break + statement: continue + +The optional :keyword:`!else` clause is executed if the control flow leaves the +:keyword:`try` suite, no exception was raised, and no :keyword:`return`, +:keyword:`continue`, or :keyword:`break` statement was executed. Exceptions in +the :keyword:`!else` clause are not handled by the preceding :keyword:`except` +clauses. + +.. index:: keyword: finally + +If :keyword:`finally` is present, it specifies a 'cleanup' handler. The +:keyword:`try` clause is executed, including any :keyword:`except` and +:keyword:`!else` clauses. If an exception occurs in any of the clauses and is +not handled, the exception is temporarily saved. The :keyword:`!finally` clause +is executed. If there is a saved exception it is re-raised at the end of the +:keyword:`!finally` clause. If the :keyword:`!finally` clause raises another +exception, the saved exception is set as the context of the new exception. +If the :keyword:`!finally` clause executes a :keyword:`return` or :keyword:`break` +statement, the saved exception is discarded:: + + >>> def f(): + ... try: + ... 1/0 + ... finally: + ... return 42 + ... + >>> f() + 42 + +The exception information is not available to the program during execution of +the :keyword:`finally` clause. + +.. index:: + statement: return + statement: break + statement: continue + +When a :keyword:`return`, :keyword:`break` or :keyword:`continue` statement is +executed in the :keyword:`try` suite of a :keyword:`!try`...\ :keyword:`!finally` +statement, the :keyword:`finally` clause is also executed 'on the way out.' A +:keyword:`continue` statement is illegal in the :keyword:`!finally` clause. (The +reason is a problem with the current implementation --- this restriction may be +lifted in the future). + +The return value of a function is determined by the last :keyword:`return` +statement executed. Since the :keyword:`finally` clause always executes, a +:keyword:`!return` statement executed in the :keyword:`!finally` clause will +always be the last one executed:: + + >>> def foo(): + ... try: + ... return 'try' + ... finally: + ... return 'finally' + ... + >>> foo() + 'finally' + +Additional information on exceptions can be found in section :ref:`exceptions`, +and information on using the :keyword:`raise` statement to generate exceptions +may be found in section :ref:`raise`. + + +.. _with: +.. _as: + +The :keyword:`!with` statement +============================== + +.. index:: + ! statement: with + keyword: as + single: as; with statement + single: , (comma); with statement + single: : (colon); compound statement + +The :keyword:`with` statement is used to wrap the execution of a block with +methods defined by a context manager (see section :ref:`context-managers`). +This allows common :keyword:`try`...\ :keyword:`except`...\ :keyword:`finally` +usage patterns to be encapsulated for convenient reuse. + +.. productionlist:: + with_stmt: "with" `with_item` ("," `with_item`)* ":" `suite` + with_item: `expression` ["as" `target`] + +The execution of the :keyword:`with` statement with one "item" proceeds as follows: + +#. The context expression (the expression given in the :token:`with_item`) is + evaluated to obtain a context manager. + +#. The context manager's :meth:`__exit__` is loaded for later use. + +#. The context manager's :meth:`__enter__` method is invoked. + +#. If a target was included in the :keyword:`with` statement, the return value + from :meth:`__enter__` is assigned to it. + + .. note:: + + The :keyword:`with` statement guarantees that if the :meth:`__enter__` + method returns without an error, then :meth:`__exit__` will always be + called. Thus, if an error occurs during the assignment to the target list, + it will be treated the same as an error occurring within the suite would + be. See step 6 below. + +#. The suite is executed. + +#. The context manager's :meth:`__exit__` method is invoked. If an exception + caused the suite to be exited, its type, value, and traceback are passed as + arguments to :meth:`__exit__`. Otherwise, three :const:`None` arguments are + supplied. + + If the suite was exited due to an exception, and the return value from the + :meth:`__exit__` method was false, the exception is reraised. If the return + value was true, the exception is suppressed, and execution continues with the + statement following the :keyword:`with` statement. + + If the suite was exited for any reason other than an exception, the return + value from :meth:`__exit__` is ignored, and execution proceeds at the normal + location for the kind of exit that was taken. + +With more than one item, the context managers are processed as if multiple +:keyword:`with` statements were nested:: + + with A() as a, B() as b: + suite + +is equivalent to :: + + with A() as a: + with B() as b: + suite + +.. versionchanged:: 3.1 + Support for multiple context expressions. + +.. seealso:: + + :pep:`343` - The "with" statement + The specification, background, and examples for the Python :keyword:`with` + statement. + + +.. index:: + single: parameter; function definition + +.. _function: +.. _def: + +Function definitions +==================== + +.. index:: + statement: def + pair: function; definition + pair: function; name + pair: name; binding + object: user-defined function + object: function + pair: function; name + pair: name; binding + single: () (parentheses); function definition + single: , (comma); parameter list + single: : (colon); compound statement + +A function definition defines a user-defined function object (see section +:ref:`types`): + +.. productionlist:: + funcdef: [`decorators`] "def" `funcname` "(" [`parameter_list`] ")" + : ["->" `expression`] ":" `suite` + decorators: `decorator`+ + decorator: "@" `dotted_name` ["(" [`argument_list` [","]] ")"] NEWLINE + dotted_name: `identifier` ("." `identifier`)* + parameter_list: `defparameter` ("," `defparameter`)* ["," [`parameter_list_starargs`]] + : | `parameter_list_starargs` + parameter_list_starargs: "*" [`parameter`] ("," `defparameter`)* ["," ["**" `parameter` [","]]] + : | "**" `parameter` [","] + parameter: `identifier` [":" `expression`] + defparameter: `parameter` ["=" `expression`] + funcname: `identifier` + + +A function definition is an executable statement. Its execution binds the +function name in the current local namespace to a function object (a wrapper +around the executable code for the function). This function object contains a +reference to the current global namespace as the global namespace to be used +when the function is called. + +The function definition does not execute the function body; this gets executed +only when the function is called. [#]_ + +.. index:: + single: @ (at); function definition + +A function definition may be wrapped by one or more :term:`decorator` expressions. +Decorator expressions are evaluated when the function is defined, in the scope +that contains the function definition. The result must be a callable, which is +invoked with the function object as the only argument. The returned value is +bound to the function name instead of the function object. Multiple decorators +are applied in nested fashion. For example, the following code :: + + @f1(arg) + @f2 + def func(): pass + +is roughly equivalent to :: + + def func(): pass + func = f1(arg)(f2(func)) + +except that the original function is not temporarily bound to the name ``func``. + +.. index:: + triple: default; parameter; value + single: argument; function definition + single: = (equals); function definition + +When one or more :term:`parameters ` have the form *parameter* ``=`` +*expression*, the function is said to have "default parameter values." For a +parameter with a default value, the corresponding :term:`argument` may be +omitted from a call, in which +case the parameter's default value is substituted. If a parameter has a default +value, all following parameters up until the "``*``" must also have a default +value --- this is a syntactic restriction that is not expressed by the grammar. + +**Default parameter values are evaluated from left to right when the function +definition is executed.** This means that the expression is evaluated once, when +the function is defined, and that the same "pre-computed" value is used for each +call. This is especially important to understand when a default parameter is a +mutable object, such as a list or a dictionary: if the function modifies the +object (e.g. by appending an item to a list), the default value is in effect +modified. This is generally not what was intended. A way around this is to use +``None`` as the default, and explicitly test for it in the body of the function, +e.g.:: + + def whats_on_the_telly(penguin=None): + if penguin is None: + penguin = [] + penguin.append("property of the zoo") + return penguin + +.. index:: + single: * (asterisk); function definition + single: **; function definition + +Function call semantics are described in more detail in section :ref:`calls`. A +function call always assigns values to all parameters mentioned in the parameter +list, either from position arguments, from keyword arguments, or from default +values. If the form "``*identifier``" is present, it is initialized to a tuple +receiving any excess positional parameters, defaulting to the empty tuple. +If the form "``**identifier``" is present, it is initialized to a new +ordered mapping receiving any excess keyword arguments, defaulting to a +new empty mapping of the same type. Parameters after "``*``" or +"``*identifier``" are keyword-only parameters and may only be passed +used keyword arguments. + +.. index:: + pair: function; annotations + single: ->; function annotations + single: : (colon); function annotations + +Parameters may have an :term:`annotation ` of the form "``: expression``" +following the parameter name. Any parameter may have an annotation, even those of the form +``*identifier`` or ``**identifier``. Functions may have "return" annotation of +the form "``-> expression``" after the parameter list. These annotations can be +any valid Python expression. The presence of annotations does not change the +semantics of a function. The annotation values are available as values of +a dictionary keyed by the parameters' names in the :attr:`__annotations__` +attribute of the function object. If the ``annotations`` import from +:mod:`__future__` is used, annotations are preserved as strings at runtime which +enables postponed evaluation. Otherwise, they are evaluated when the function +definition is executed. In this case annotations may be evaluated in +a different order than they appear in the source code. + +.. index:: pair: lambda; expression + +It is also possible to create anonymous functions (functions not bound to a +name), for immediate use in expressions. This uses lambda expressions, described in +section :ref:`lambda`. Note that the lambda expression is merely a shorthand for a +simplified function definition; a function defined in a ":keyword:`def`" +statement can be passed around or assigned to another name just like a function +defined by a lambda expression. The ":keyword:`!def`" form is actually more powerful +since it allows the execution of multiple statements and annotations. + +**Programmer's note:** Functions are first-class objects. A "``def``" statement +executed inside a function definition defines a local function that can be +returned or passed around. Free variables used in the nested function can +access the local variables of the function containing the def. See section +:ref:`naming` for details. + +.. seealso:: + + :pep:`3107` - Function Annotations + The original specification for function annotations. + + :pep:`484` - Type Hints + Definition of a standard meaning for annotations: type hints. + + :pep:`526` - Syntax for Variable Annotations + Ability to type hint variable declarations, including class + variables and instance variables + + :pep:`563` - Postponed Evaluation of Annotations + Support for forward references within annotations by preserving + annotations in a string form at runtime instead of eager evaluation. + + +.. _class: + +Class definitions +================= + +.. index:: + object: class + statement: class + pair: class; definition + pair: class; name + pair: name; binding + pair: execution; frame + single: inheritance + single: docstring + single: () (parentheses); class definition + single: , (comma); expression list + single: : (colon); compound statement + +A class definition defines a class object (see section :ref:`types`): + +.. productionlist:: + classdef: [`decorators`] "class" `classname` [`inheritance`] ":" `suite` + inheritance: "(" [`argument_list`] ")" + classname: `identifier` + +A class definition is an executable statement. The inheritance list usually +gives a list of base classes (see :ref:`metaclasses` for more advanced uses), so +each item in the list should evaluate to a class object which allows +subclassing. Classes without an inheritance list inherit, by default, from the +base class :class:`object`; hence, :: + + class Foo: + pass + +is equivalent to :: + + class Foo(object): + pass + +The class's suite is then executed in a new execution frame (see :ref:`naming`), +using a newly created local namespace and the original global namespace. +(Usually, the suite contains mostly function definitions.) When the class's +suite finishes execution, its execution frame is discarded but its local +namespace is saved. [#]_ A class object is then created using the inheritance +list for the base classes and the saved local namespace for the attribute +dictionary. The class name is bound to this class object in the original local +namespace. + +The order in which attributes are defined in the class body is preserved +in the new class's ``__dict__``. Note that this is reliable only right +after the class is created and only for classes that were defined using +the definition syntax. + +Class creation can be customized heavily using :ref:`metaclasses `. + +.. index:: + single: @ (at); class definition + +Classes can also be decorated: just like when decorating functions, :: + + @f1(arg) + @f2 + class Foo: pass + +is roughly equivalent to :: + + class Foo: pass + Foo = f1(arg)(f2(Foo)) + +The evaluation rules for the decorator expressions are the same as for function +decorators. The result is then bound to the class name. + +**Programmer's note:** Variables defined in the class definition are class +attributes; they are shared by instances. Instance attributes can be set in a +method with ``self.name = value``. Both class and instance attributes are +accessible through the notation "``self.name``", and an instance attribute hides +a class attribute with the same name when accessed in this way. Class +attributes can be used as defaults for instance attributes, but using mutable +values there can lead to unexpected results. :ref:`Descriptors ` +can be used to create instance variables with different implementation details. + + +.. seealso:: + + :pep:`3115` - Metaclasses in Python 3000 + The proposal that changed the declaration of metaclasses to the current + syntax, and the semantics for how classes with metaclasses are + constructed. + + :pep:`3129` - Class Decorators + The proposal that added class decorators. Function and method decorators + were introduced in :pep:`318`. + + +.. _async: + +Coroutines +========== + +.. versionadded:: 3.5 + +.. index:: statement: async def +.. _`async def`: + +Coroutine function definition +----------------------------- + +.. productionlist:: + async_funcdef: [`decorators`] "async" "def" `funcname` "(" [`parameter_list`] ")" + : ["->" `expression`] ":" `suite` + +.. index:: + keyword: async + keyword: await + +Execution of Python coroutines can be suspended and resumed at many points +(see :term:`coroutine`). Inside the body of a coroutine function, ``await`` and +``async`` identifiers become reserved keywords; :keyword:`await` expressions, +:keyword:`async for` and :keyword:`async with` can only be used in +coroutine function bodies. + +Functions defined with ``async def`` syntax are always coroutine functions, +even if they do not contain ``await`` or ``async`` keywords. + +It is a :exc:`SyntaxError` to use a ``yield from`` expression inside the body +of a coroutine function. + +An example of a coroutine function:: + + async def func(param1, param2): + do_stuff() + await some_coroutine() + + +.. index:: statement: async for +.. _`async for`: + +The :keyword:`!async for` statement +----------------------------------- + +.. productionlist:: + async_for_stmt: "async" `for_stmt` + +An :term:`asynchronous iterable` is able to call asynchronous code in its +*iter* implementation, and :term:`asynchronous iterator` can call asynchronous +code in its *next* method. + +The ``async for`` statement allows convenient iteration over asynchronous +iterators. + +The following code:: + + async for TARGET in ITER: + BLOCK + else: + BLOCK2 + +Is semantically equivalent to:: + + iter = (ITER) + iter = type(iter).__aiter__(iter) + running = True + while running: + try: + TARGET = await type(iter).__anext__(iter) + except StopAsyncIteration: + running = False + else: + BLOCK + else: + BLOCK2 + +See also :meth:`__aiter__` and :meth:`__anext__` for details. + +It is a :exc:`SyntaxError` to use an ``async for`` statement outside the +body of a coroutine function. + + +.. index:: statement: async with +.. _`async with`: + +The :keyword:`!async with` statement +------------------------------------ + +.. productionlist:: + async_with_stmt: "async" `with_stmt` + +An :term:`asynchronous context manager` is a :term:`context manager` that is +able to suspend execution in its *enter* and *exit* methods. + +The following code:: + + async with EXPR as VAR: + BLOCK + +Is semantically equivalent to:: + + mgr = (EXPR) + aexit = type(mgr).__aexit__ + aenter = type(mgr).__aenter__(mgr) + + VAR = await aenter + try: + BLOCK + except: + if not await aexit(mgr, *sys.exc_info()): + raise + else: + await aexit(mgr, None, None, None) + +See also :meth:`__aenter__` and :meth:`__aexit__` for details. + +It is a :exc:`SyntaxError` to use an ``async with`` statement outside the +body of a coroutine function. + +.. seealso:: + + :pep:`492` - Coroutines with async and await syntax + The proposal that made coroutines a proper standalone concept in Python, + and added supporting syntax. + + +.. rubric:: Footnotes + +.. [#] The exception is propagated to the invocation stack unless + there is a :keyword:`finally` clause which happens to raise another + exception. That new exception causes the old one to be lost. + +.. [#] A string literal appearing as the first statement in the function body is + transformed into the function's ``__doc__`` attribute and therefore the + function's :term:`docstring`. + +.. [#] A string literal appearing as the first statement in the class body is + transformed into the namespace's ``__doc__`` item and therefore the class's + :term:`docstring`. diff --git a/python-3.7.4-docs-html/_sources/reference/datamodel.rst.txt b/python-3.7.4-docs-html/_sources/reference/datamodel.rst.txt new file mode 100644 index 0000000..962ec7e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/reference/datamodel.rst.txt @@ -0,0 +1,2727 @@ + +.. _datamodel: + +********** +Data model +********** + + +.. _objects: + +Objects, values and types +========================= + +.. index:: + single: object + single: data + +:dfn:`Objects` are Python's abstraction for data. All data in a Python program +is represented by objects or by relations between objects. (In a sense, and in +conformance to Von Neumann's model of a "stored program computer," code is also +represented by objects.) + +.. index:: + builtin: id + builtin: type + single: identity of an object + single: value of an object + single: type of an object + single: mutable object + single: immutable object + +.. XXX it *is* now possible in some cases to change an object's + type, under certain controlled conditions + +Every object has an identity, a type and a value. An object's *identity* never +changes once it has been created; you may think of it as the object's address in +memory. The ':keyword:`is`' operator compares the identity of two objects; the +:func:`id` function returns an integer representing its identity. + +.. impl-detail:: + + For CPython, ``id(x)`` is the memory address where ``x`` is stored. + +An object's type determines the operations that the object supports (e.g., "does +it have a length?") and also defines the possible values for objects of that +type. The :func:`type` function returns an object's type (which is an object +itself). Like its identity, an object's :dfn:`type` is also unchangeable. +[#]_ + +The *value* of some objects can change. Objects whose value can +change are said to be *mutable*; objects whose value is unchangeable once they +are created are called *immutable*. (The value of an immutable container object +that contains a reference to a mutable object can change when the latter's value +is changed; however the container is still considered immutable, because the +collection of objects it contains cannot be changed. So, immutability is not +strictly the same as having an unchangeable value, it is more subtle.) An +object's mutability is determined by its type; for instance, numbers, strings +and tuples are immutable, while dictionaries and lists are mutable. + +.. index:: + single: garbage collection + single: reference counting + single: unreachable object + +Objects are never explicitly destroyed; however, when they become unreachable +they may be garbage-collected. An implementation is allowed to postpone garbage +collection or omit it altogether --- it is a matter of implementation quality +how garbage collection is implemented, as long as no objects are collected that +are still reachable. + +.. impl-detail:: + + CPython currently uses a reference-counting scheme with (optional) delayed + detection of cyclically linked garbage, which collects most objects as soon + as they become unreachable, but is not guaranteed to collect garbage + containing circular references. See the documentation of the :mod:`gc` + module for information on controlling the collection of cyclic garbage. + Other implementations act differently and CPython may change. + Do not depend on immediate finalization of objects when they become + unreachable (so you should always close files explicitly). + +Note that the use of the implementation's tracing or debugging facilities may +keep objects alive that would normally be collectable. Also note that catching +an exception with a ':keyword:`try`...\ :keyword:`except`' statement may keep +objects alive. + +Some objects contain references to "external" resources such as open files or +windows. It is understood that these resources are freed when the object is +garbage-collected, but since garbage collection is not guaranteed to happen, +such objects also provide an explicit way to release the external resource, +usually a :meth:`close` method. Programs are strongly recommended to explicitly +close such objects. The ':keyword:`try`...\ :keyword:`finally`' statement +and the ':keyword:`with`' statement provide convenient ways to do this. + +.. index:: single: container + +Some objects contain references to other objects; these are called *containers*. +Examples of containers are tuples, lists and dictionaries. The references are +part of a container's value. In most cases, when we talk about the value of a +container, we imply the values, not the identities of the contained objects; +however, when we talk about the mutability of a container, only the identities +of the immediately contained objects are implied. So, if an immutable container +(like a tuple) contains a reference to a mutable object, its value changes if +that mutable object is changed. + +Types affect almost all aspects of object behavior. Even the importance of +object identity is affected in some sense: for immutable types, operations that +compute new values may actually return a reference to any existing object with +the same type and value, while for mutable objects this is not allowed. E.g., +after ``a = 1; b = 1``, ``a`` and ``b`` may or may not refer to the same object +with the value one, depending on the implementation, but after ``c = []; d = +[]``, ``c`` and ``d`` are guaranteed to refer to two different, unique, newly +created empty lists. (Note that ``c = d = []`` assigns the same object to both +``c`` and ``d``.) + + +.. _types: + +The standard type hierarchy +=========================== + +.. index:: + single: type + pair: data; type + pair: type; hierarchy + pair: extension; module + pair: C; language + +Below is a list of the types that are built into Python. Extension modules +(written in C, Java, or other languages, depending on the implementation) can +define additional types. Future versions of Python may add types to the type +hierarchy (e.g., rational numbers, efficiently stored arrays of integers, etc.), +although such additions will often be provided via the standard library instead. + +.. index:: + single: attribute + pair: special; attribute + triple: generic; special; attribute + +Some of the type descriptions below contain a paragraph listing 'special +attributes.' These are attributes that provide access to the implementation and +are not intended for general use. Their definition may change in the future. + +None + .. index:: object: None + + This type has a single value. There is a single object with this value. This + object is accessed through the built-in name ``None``. It is used to signify the + absence of a value in many situations, e.g., it is returned from functions that + don't explicitly return anything. Its truth value is false. + +NotImplemented + .. index:: object: NotImplemented + + This type has a single value. There is a single object with this value. This + object is accessed through the built-in name ``NotImplemented``. Numeric methods + and rich comparison methods should return this value if they do not implement the + operation for the operands provided. (The interpreter will then try the + reflected operation, or some other fallback, depending on the operator.) Its + truth value is true. + + See + :ref:`implementing-the-arithmetic-operations` + for more details. + + +Ellipsis + .. index:: + object: Ellipsis + single: ...; ellipsis literal + + This type has a single value. There is a single object with this value. This + object is accessed through the literal ``...`` or the built-in name + ``Ellipsis``. Its truth value is true. + +:class:`numbers.Number` + .. index:: object: numeric + + These are created by numeric literals and returned as results by arithmetic + operators and arithmetic built-in functions. Numeric objects are immutable; + once created their value never changes. Python numbers are of course strongly + related to mathematical numbers, but subject to the limitations of numerical + representation in computers. + + Python distinguishes between integers, floating point numbers, and complex + numbers: + + :class:`numbers.Integral` + .. index:: object: integer + + These represent elements from the mathematical set of integers (positive and + negative). + + There are two types of integers: + + Integers (:class:`int`) + + These represent numbers in an unlimited range, subject to available (virtual) + memory only. For the purpose of shift and mask operations, a binary + representation is assumed, and negative numbers are represented in a variant of + 2's complement which gives the illusion of an infinite string of sign bits + extending to the left. + + Booleans (:class:`bool`) + .. index:: + object: Boolean + single: False + single: True + + These represent the truth values False and True. The two objects representing + the values ``False`` and ``True`` are the only Boolean objects. The Boolean type is a + subtype of the integer type, and Boolean values behave like the values 0 and 1, + respectively, in almost all contexts, the exception being that when converted to + a string, the strings ``"False"`` or ``"True"`` are returned, respectively. + + .. index:: pair: integer; representation + + The rules for integer representation are intended to give the most meaningful + interpretation of shift and mask operations involving negative integers. + + :class:`numbers.Real` (:class:`float`) + .. index:: + object: floating point + pair: floating point; number + pair: C; language + pair: Java; language + + These represent machine-level double precision floating point numbers. You are + at the mercy of the underlying machine architecture (and C or Java + implementation) for the accepted range and handling of overflow. Python does not + support single-precision floating point numbers; the savings in processor and + memory usage that are usually the reason for using these are dwarfed by the + overhead of using objects in Python, so there is no reason to complicate the + language with two kinds of floating point numbers. + + :class:`numbers.Complex` (:class:`complex`) + .. index:: + object: complex + pair: complex; number + + These represent complex numbers as a pair of machine-level double precision + floating point numbers. The same caveats apply as for floating point numbers. + The real and imaginary parts of a complex number ``z`` can be retrieved through + the read-only attributes ``z.real`` and ``z.imag``. + +Sequences + .. index:: + builtin: len + object: sequence + single: index operation + single: item selection + single: subscription + + These represent finite ordered sets indexed by non-negative numbers. The + built-in function :func:`len` returns the number of items of a sequence. When + the length of a sequence is *n*, the index set contains the numbers 0, 1, + ..., *n*-1. Item *i* of sequence *a* is selected by ``a[i]``. + + .. index:: single: slicing + + Sequences also support slicing: ``a[i:j]`` selects all items with index *k* such + that *i* ``<=`` *k* ``<`` *j*. When used as an expression, a slice is a + sequence of the same type. This implies that the index set is renumbered so + that it starts at 0. + + Some sequences also support "extended slicing" with a third "step" parameter: + ``a[i:j:k]`` selects all items of *a* with index *x* where ``x = i + n*k``, *n* + ``>=`` ``0`` and *i* ``<=`` *x* ``<`` *j*. + + Sequences are distinguished according to their mutability: + + Immutable sequences + .. index:: + object: immutable sequence + object: immutable + + An object of an immutable sequence type cannot change once it is created. (If + the object contains references to other objects, these other objects may be + mutable and may be changed; however, the collection of objects directly + referenced by an immutable object cannot change.) + + The following types are immutable sequences: + + .. index:: + single: string; immutable sequences + + Strings + .. index:: + builtin: chr + builtin: ord + single: character + single: integer + single: Unicode + + A string is a sequence of values that represent Unicode code points. + All the code points in the range ``U+0000 - U+10FFFF`` can be + represented in a string. Python doesn't have a :c:type:`char` type; + instead, every code point in the string is represented as a string + object with length ``1``. The built-in function :func:`ord` + converts a code point from its string form to an integer in the + range ``0 - 10FFFF``; :func:`chr` converts an integer in the range + ``0 - 10FFFF`` to the corresponding length ``1`` string object. + :meth:`str.encode` can be used to convert a :class:`str` to + :class:`bytes` using the given text encoding, and + :meth:`bytes.decode` can be used to achieve the opposite. + + Tuples + .. index:: + object: tuple + pair: singleton; tuple + pair: empty; tuple + + The items of a tuple are arbitrary Python objects. Tuples of two or + more items are formed by comma-separated lists of expressions. A tuple + of one item (a 'singleton') can be formed by affixing a comma to an + expression (an expression by itself does not create a tuple, since + parentheses must be usable for grouping of expressions). An empty + tuple can be formed by an empty pair of parentheses. + + Bytes + .. index:: bytes, byte + + A bytes object is an immutable array. The items are 8-bit bytes, + represented by integers in the range 0 <= x < 256. Bytes literals + (like ``b'abc'``) and the built-in :func:`bytes()` constructor + can be used to create bytes objects. Also, bytes objects can be + decoded to strings via the :meth:`~bytes.decode` method. + + Mutable sequences + .. index:: + object: mutable sequence + object: mutable + pair: assignment; statement + single: subscription + single: slicing + + Mutable sequences can be changed after they are created. The subscription and + slicing notations can be used as the target of assignment and :keyword:`del` + (delete) statements. + + There are currently two intrinsic mutable sequence types: + + Lists + .. index:: object: list + + The items of a list are arbitrary Python objects. Lists are formed by + placing a comma-separated list of expressions in square brackets. (Note + that there are no special cases needed to form lists of length 0 or 1.) + + Byte Arrays + .. index:: bytearray + + A bytearray object is a mutable array. They are created by the built-in + :func:`bytearray` constructor. Aside from being mutable + (and hence unhashable), byte arrays otherwise provide the same interface + and functionality as immutable :class:`bytes` objects. + + .. index:: module: array + + The extension module :mod:`array` provides an additional example of a + mutable sequence type, as does the :mod:`collections` module. + +Set types + .. index:: + builtin: len + object: set type + + These represent unordered, finite sets of unique, immutable objects. As such, + they cannot be indexed by any subscript. However, they can be iterated over, and + the built-in function :func:`len` returns the number of items in a set. Common + uses for sets are fast membership testing, removing duplicates from a sequence, + and computing mathematical operations such as intersection, union, difference, + and symmetric difference. + + For set elements, the same immutability rules apply as for dictionary keys. Note + that numeric types obey the normal rules for numeric comparison: if two numbers + compare equal (e.g., ``1`` and ``1.0``), only one of them can be contained in a + set. + + There are currently two intrinsic set types: + + Sets + .. index:: object: set + + These represent a mutable set. They are created by the built-in :func:`set` + constructor and can be modified afterwards by several methods, such as + :meth:`~set.add`. + + Frozen sets + .. index:: object: frozenset + + These represent an immutable set. They are created by the built-in + :func:`frozenset` constructor. As a frozenset is immutable and + :term:`hashable`, it can be used again as an element of another set, or as + a dictionary key. + +Mappings + .. index:: + builtin: len + single: subscription + object: mapping + + These represent finite sets of objects indexed by arbitrary index sets. The + subscript notation ``a[k]`` selects the item indexed by ``k`` from the mapping + ``a``; this can be used in expressions and as the target of assignments or + :keyword:`del` statements. The built-in function :func:`len` returns the number + of items in a mapping. + + There is currently a single intrinsic mapping type: + + Dictionaries + .. index:: object: dictionary + + These represent finite sets of objects indexed by nearly arbitrary values. The + only types of values not acceptable as keys are values containing lists or + dictionaries or other mutable types that are compared by value rather than by + object identity, the reason being that the efficient implementation of + dictionaries requires a key's hash value to remain constant. Numeric types used + for keys obey the normal rules for numeric comparison: if two numbers compare + equal (e.g., ``1`` and ``1.0``) then they can be used interchangeably to index + the same dictionary entry. + + Dictionaries are mutable; they can be created by the ``{...}`` notation (see + section :ref:`dict`). + + .. index:: + module: dbm.ndbm + module: dbm.gnu + + The extension modules :mod:`dbm.ndbm` and :mod:`dbm.gnu` provide + additional examples of mapping types, as does the :mod:`collections` + module. + +Callable types + .. index:: + object: callable + pair: function; call + single: invocation + pair: function; argument + + These are the types to which the function call operation (see section + :ref:`calls`) can be applied: + + User-defined functions + .. index:: + pair: user-defined; function + object: function + object: user-defined function + + A user-defined function object is created by a function definition (see + section :ref:`function`). It should be called with an argument list + containing the same number of items as the function's formal parameter + list. + + Special attributes: + + .. tabularcolumns:: |l|L|l| + + .. index:: + single: __doc__ (function attribute) + single: __name__ (function attribute) + single: __module__ (function attribute) + single: __dict__ (function attribute) + single: __defaults__ (function attribute) + single: __closure__ (function attribute) + single: __code__ (function attribute) + single: __globals__ (function attribute) + single: __annotations__ (function attribute) + single: __kwdefaults__ (function attribute) + pair: global; namespace + + +-------------------------+-------------------------------+-----------+ + | Attribute | Meaning | | + +=========================+===============================+===========+ + | :attr:`__doc__` | The function's documentation | Writable | + | | string, or ``None`` if | | + | | unavailable; not inherited by | | + | | subclasses. | | + +-------------------------+-------------------------------+-----------+ + | :attr:`~definition.\ | The function's name. | Writable | + | __name__` | | | + +-------------------------+-------------------------------+-----------+ + | :attr:`~definition.\ | The function's | Writable | + | __qualname__` | :term:`qualified name`. | | + | | | | + | | .. versionadded:: 3.3 | | + +-------------------------+-------------------------------+-----------+ + | :attr:`__module__` | The name of the module the | Writable | + | | function was defined in, or | | + | | ``None`` if unavailable. | | + +-------------------------+-------------------------------+-----------+ + | :attr:`__defaults__` | A tuple containing default | Writable | + | | argument values for those | | + | | arguments that have defaults, | | + | | or ``None`` if no arguments | | + | | have a default value. | | + +-------------------------+-------------------------------+-----------+ + | :attr:`__code__` | The code object representing | Writable | + | | the compiled function body. | | + +-------------------------+-------------------------------+-----------+ + | :attr:`__globals__` | A reference to the dictionary | Read-only | + | | that holds the function's | | + | | global variables --- the | | + | | global namespace of the | | + | | module in which the function | | + | | was defined. | | + +-------------------------+-------------------------------+-----------+ + | :attr:`~object.__dict__`| The namespace supporting | Writable | + | | arbitrary function | | + | | attributes. | | + +-------------------------+-------------------------------+-----------+ + | :attr:`__closure__` | ``None`` or a tuple of cells | Read-only | + | | that contain bindings for the | | + | | function's free variables. | | + | | See below for information on | | + | | the ``cell_contents`` | | + | | attribute. | | + +-------------------------+-------------------------------+-----------+ + | :attr:`__annotations__` | A dict containing annotations | Writable | + | | of parameters. The keys of | | + | | the dict are the parameter | | + | | names, and ``'return'`` for | | + | | the return annotation, if | | + | | provided. | | + +-------------------------+-------------------------------+-----------+ + | :attr:`__kwdefaults__` | A dict containing defaults | Writable | + | | for keyword-only parameters. | | + +-------------------------+-------------------------------+-----------+ + + Most of the attributes labelled "Writable" check the type of the assigned value. + + Function objects also support getting and setting arbitrary attributes, which + can be used, for example, to attach metadata to functions. Regular attribute + dot-notation is used to get and set such attributes. *Note that the current + implementation only supports function attributes on user-defined functions. + Function attributes on built-in functions may be supported in the future.* + + A cell object has the attribute ``cell_contents``. This can be used to get + the value of the cell, as well as set the value. + + Additional information about a function's definition can be retrieved from its + code object; see the description of internal types below. + + Instance methods + .. index:: + object: method + object: user-defined method + pair: user-defined; method + + An instance method object combines a class, a class instance and any + callable object (normally a user-defined function). + + .. index:: + single: __func__ (method attribute) + single: __self__ (method attribute) + single: __doc__ (method attribute) + single: __name__ (method attribute) + single: __module__ (method attribute) + + Special read-only attributes: :attr:`__self__` is the class instance object, + :attr:`__func__` is the function object; :attr:`__doc__` is the method's + documentation (same as ``__func__.__doc__``); :attr:`~definition.__name__` is the + method name (same as ``__func__.__name__``); :attr:`__module__` is the + name of the module the method was defined in, or ``None`` if unavailable. + + Methods also support accessing (but not setting) the arbitrary function + attributes on the underlying function object. + + User-defined method objects may be created when getting an attribute of a + class (perhaps via an instance of that class), if that attribute is a + user-defined function object or a class method object. + + When an instance method object is created by retrieving a user-defined + function object from a class via one of its instances, its + :attr:`__self__` attribute is the instance, and the method object is said + to be bound. The new method's :attr:`__func__` attribute is the original + function object. + + When a user-defined method object is created by retrieving another method + object from a class or instance, the behaviour is the same as for a + function object, except that the :attr:`__func__` attribute of the new + instance is not the original method object but its :attr:`__func__` + attribute. + + When an instance method object is created by retrieving a class method + object from a class or instance, its :attr:`__self__` attribute is the + class itself, and its :attr:`__func__` attribute is the function object + underlying the class method. + + When an instance method object is called, the underlying function + (:attr:`__func__`) is called, inserting the class instance + (:attr:`__self__`) in front of the argument list. For instance, when + :class:`C` is a class which contains a definition for a function + :meth:`f`, and ``x`` is an instance of :class:`C`, calling ``x.f(1)`` is + equivalent to calling ``C.f(x, 1)``. + + When an instance method object is derived from a class method object, the + "class instance" stored in :attr:`__self__` will actually be the class + itself, so that calling either ``x.f(1)`` or ``C.f(1)`` is equivalent to + calling ``f(C,1)`` where ``f`` is the underlying function. + + Note that the transformation from function object to instance method + object happens each time the attribute is retrieved from the instance. In + some cases, a fruitful optimization is to assign the attribute to a local + variable and call that local variable. Also notice that this + transformation only happens for user-defined functions; other callable + objects (and all non-callable objects) are retrieved without + transformation. It is also important to note that user-defined functions + which are attributes of a class instance are not converted to bound + methods; this *only* happens when the function is an attribute of the + class. + + Generator functions + .. index:: + single: generator; function + single: generator; iterator + + A function or method which uses the :keyword:`yield` statement (see section + :ref:`yield`) is called a :dfn:`generator function`. Such a function, when + called, always returns an iterator object which can be used to execute the + body of the function: calling the iterator's :meth:`iterator.__next__` + method will cause the function to execute until it provides a value + using the :keyword:`!yield` statement. When the function executes a + :keyword:`return` statement or falls off the end, a :exc:`StopIteration` + exception is raised and the iterator will have reached the end of the set of + values to be returned. + + Coroutine functions + .. index:: + single: coroutine; function + + A function or method which is defined using :keyword:`async def` is called + a :dfn:`coroutine function`. Such a function, when called, returns a + :term:`coroutine` object. It may contain :keyword:`await` expressions, + as well as :keyword:`async with` and :keyword:`async for` statements. See + also the :ref:`coroutine-objects` section. + + Asynchronous generator functions + .. index:: + single: asynchronous generator; function + single: asynchronous generator; asynchronous iterator + + A function or method which is defined using :keyword:`async def` and + which uses the :keyword:`yield` statement is called a + :dfn:`asynchronous generator function`. Such a function, when called, + returns an asynchronous iterator object which can be used in an + :keyword:`async for` statement to execute the body of the function. + + Calling the asynchronous iterator's :meth:`aiterator.__anext__` method + will return an :term:`awaitable` which when awaited + will execute until it provides a value using the :keyword:`yield` + expression. When the function executes an empty :keyword:`return` + statement or falls off the end, a :exc:`StopAsyncIteration` exception + is raised and the asynchronous iterator will have reached the end of + the set of values to be yielded. + + Built-in functions + .. index:: + object: built-in function + object: function + pair: C; language + + A built-in function object is a wrapper around a C function. Examples of + built-in functions are :func:`len` and :func:`math.sin` (:mod:`math` is a + standard built-in module). The number and type of the arguments are + determined by the C function. Special read-only attributes: + :attr:`__doc__` is the function's documentation string, or ``None`` if + unavailable; :attr:`~definition.__name__` is the function's name; :attr:`__self__` is + set to ``None`` (but see the next item); :attr:`__module__` is the name of + the module the function was defined in or ``None`` if unavailable. + + Built-in methods + .. index:: + object: built-in method + object: method + pair: built-in; method + + This is really a different disguise of a built-in function, this time containing + an object passed to the C function as an implicit extra argument. An example of + a built-in method is ``alist.append()``, assuming *alist* is a list object. In + this case, the special read-only attribute :attr:`__self__` is set to the object + denoted by *alist*. + + Classes + Classes are callable. These objects normally act as factories for new + instances of themselves, but variations are possible for class types that + override :meth:`__new__`. The arguments of the call are passed to + :meth:`__new__` and, in the typical case, to :meth:`__init__` to + initialize the new instance. + + Class Instances + Instances of arbitrary classes can be made callable by defining a + :meth:`__call__` method in their class. + + +Modules + .. index:: + statement: import + object: module + + Modules are a basic organizational unit of Python code, and are created by + the :ref:`import system ` as invoked either by the + :keyword:`import` statement, or by calling + functions such as :func:`importlib.import_module` and built-in + :func:`__import__`. A module object has a namespace implemented by a + dictionary object (this is the dictionary referenced by the ``__globals__`` + attribute of functions defined in the module). Attribute references are + translated to lookups in this dictionary, e.g., ``m.x`` is equivalent to + ``m.__dict__["x"]``. A module object does not contain the code object used + to initialize the module (since it isn't needed once the initialization is + done). + + Attribute assignment updates the module's namespace dictionary, e.g., + ``m.x = 1`` is equivalent to ``m.__dict__["x"] = 1``. + + .. index:: + single: __name__ (module attribute) + single: __doc__ (module attribute) + single: __file__ (module attribute) + single: __annotations__ (module attribute) + pair: module; namespace + + Predefined (writable) attributes: :attr:`__name__` is the module's name; + :attr:`__doc__` is the module's documentation string, or ``None`` if + unavailable; :attr:`__annotations__` (optional) is a dictionary containing + :term:`variable annotations ` collected during module + body execution; :attr:`__file__` is the pathname of the file from which the + module was loaded, if it was loaded from a file. The :attr:`__file__` + attribute may be missing for certain types of modules, such as C modules + that are statically linked into the interpreter; for extension modules + loaded dynamically from a shared library, it is the pathname of the shared + library file. + + .. index:: single: __dict__ (module attribute) + + Special read-only attribute: :attr:`~object.__dict__` is the module's + namespace as a dictionary object. + + .. impl-detail:: + + Because of the way CPython clears module dictionaries, the module + dictionary will be cleared when the module falls out of scope even if the + dictionary still has live references. To avoid this, copy the dictionary + or keep the module around while using its dictionary directly. + +Custom classes + Custom class types are typically created by class definitions (see section + :ref:`class`). A class has a namespace implemented by a dictionary object. + Class attribute references are translated to lookups in this dictionary, e.g., + ``C.x`` is translated to ``C.__dict__["x"]`` (although there are a number of + hooks which allow for other means of locating attributes). When the attribute + name is not found there, the attribute search continues in the base classes. + This search of the base classes uses the C3 method resolution order which + behaves correctly even in the presence of 'diamond' inheritance structures + where there are multiple inheritance paths leading back to a common ancestor. + Additional details on the C3 MRO used by Python can be found in the + documentation accompanying the 2.3 release at + https://www.python.org/download/releases/2.3/mro/. + + .. XXX: Could we add that MRO doc as an appendix to the language ref? + + .. index:: + object: class + object: class instance + object: instance + pair: class object; call + single: container + object: dictionary + pair: class; attribute + + When a class attribute reference (for class :class:`C`, say) would yield a + class method object, it is transformed into an instance method object whose + :attr:`__self__` attribute is :class:`C`. When it would yield a static + method object, it is transformed into the object wrapped by the static method + object. See section :ref:`descriptors` for another way in which attributes + retrieved from a class may differ from those actually contained in its + :attr:`~object.__dict__`. + + .. index:: triple: class; attribute; assignment + + Class attribute assignments update the class's dictionary, never the dictionary + of a base class. + + .. index:: pair: class object; call + + A class object can be called (see above) to yield a class instance (see below). + + .. index:: + single: __name__ (class attribute) + single: __module__ (class attribute) + single: __dict__ (class attribute) + single: __bases__ (class attribute) + single: __doc__ (class attribute) + single: __annotations__ (class attribute) + + Special attributes: :attr:`~definition.__name__` is the class name; :attr:`__module__` is + the module name in which the class was defined; :attr:`~object.__dict__` is the + dictionary containing the class's namespace; :attr:`~class.__bases__` is a + tuple containing the base classes, in the order of their occurrence in the + base class list; :attr:`__doc__` is the class's documentation string, + or ``None`` if undefined; :attr:`__annotations__` (optional) is a dictionary + containing :term:`variable annotations ` collected during + class body execution. + +Class instances + .. index:: + object: class instance + object: instance + pair: class; instance + pair: class instance; attribute + + A class instance is created by calling a class object (see above). A class + instance has a namespace implemented as a dictionary which is the first place + in which attribute references are searched. When an attribute is not found + there, and the instance's class has an attribute by that name, the search + continues with the class attributes. If a class attribute is found that is a + user-defined function object, it is transformed into an instance method + object whose :attr:`__self__` attribute is the instance. Static method and + class method objects are also transformed; see above under "Classes". See + section :ref:`descriptors` for another way in which attributes of a class + retrieved via its instances may differ from the objects actually stored in + the class's :attr:`~object.__dict__`. If no class attribute is found, and the + object's class has a :meth:`__getattr__` method, that is called to satisfy + the lookup. + + .. index:: triple: class instance; attribute; assignment + + Attribute assignments and deletions update the instance's dictionary, never a + class's dictionary. If the class has a :meth:`__setattr__` or + :meth:`__delattr__` method, this is called instead of updating the instance + dictionary directly. + + .. index:: + object: numeric + object: sequence + object: mapping + + Class instances can pretend to be numbers, sequences, or mappings if they have + methods with certain special names. See section :ref:`specialnames`. + + .. index:: + single: __dict__ (instance attribute) + single: __class__ (instance attribute) + + Special attributes: :attr:`~object.__dict__` is the attribute dictionary; + :attr:`~instance.__class__` is the instance's class. + +I/O objects (also known as file objects) + .. index:: + builtin: open + module: io + single: popen() (in module os) + single: makefile() (socket method) + single: sys.stdin + single: sys.stdout + single: sys.stderr + single: stdio + single: stdin (in module sys) + single: stdout (in module sys) + single: stderr (in module sys) + + A :term:`file object` represents an open file. Various shortcuts are + available to create file objects: the :func:`open` built-in function, and + also :func:`os.popen`, :func:`os.fdopen`, and the + :meth:`~socket.socket.makefile` method of socket objects (and perhaps by + other functions or methods provided by extension modules). + + The objects ``sys.stdin``, ``sys.stdout`` and ``sys.stderr`` are + initialized to file objects corresponding to the interpreter's standard + input, output and error streams; they are all open in text mode and + therefore follow the interface defined by the :class:`io.TextIOBase` + abstract class. + +Internal types + .. index:: + single: internal type + single: types, internal + + A few types used internally by the interpreter are exposed to the user. Their + definitions may change with future versions of the interpreter, but they are + mentioned here for completeness. + + .. index:: bytecode, object; code, code object + + Code objects + Code objects represent *byte-compiled* executable Python code, or :term:`bytecode`. + The difference between a code object and a function object is that the function + object contains an explicit reference to the function's globals (the module in + which it was defined), while a code object contains no context; also the default + argument values are stored in the function object, not in the code object + (because they represent values calculated at run-time). Unlike function + objects, code objects are immutable and contain no references (directly or + indirectly) to mutable objects. + + .. index:: + single: co_argcount (code object attribute) + single: co_code (code object attribute) + single: co_consts (code object attribute) + single: co_filename (code object attribute) + single: co_firstlineno (code object attribute) + single: co_flags (code object attribute) + single: co_lnotab (code object attribute) + single: co_name (code object attribute) + single: co_names (code object attribute) + single: co_nlocals (code object attribute) + single: co_stacksize (code object attribute) + single: co_varnames (code object attribute) + single: co_cellvars (code object attribute) + single: co_freevars (code object attribute) + + Special read-only attributes: :attr:`co_name` gives the function name; + :attr:`co_argcount` is the number of positional arguments (including arguments + with default values); :attr:`co_nlocals` is the number of local variables used + by the function (including arguments); :attr:`co_varnames` is a tuple containing + the names of the local variables (starting with the argument names); + :attr:`co_cellvars` is a tuple containing the names of local variables that are + referenced by nested functions; :attr:`co_freevars` is a tuple containing the + names of free variables; :attr:`co_code` is a string representing the sequence + of bytecode instructions; :attr:`co_consts` is a tuple containing the literals + used by the bytecode; :attr:`co_names` is a tuple containing the names used by + the bytecode; :attr:`co_filename` is the filename from which the code was + compiled; :attr:`co_firstlineno` is the first line number of the function; + :attr:`co_lnotab` is a string encoding the mapping from bytecode offsets to + line numbers (for details see the source code of the interpreter); + :attr:`co_stacksize` is the required stack size (including local variables); + :attr:`co_flags` is an integer encoding a number of flags for the interpreter. + + .. index:: object: generator + + The following flag bits are defined for :attr:`co_flags`: bit ``0x04`` is set if + the function uses the ``*arguments`` syntax to accept an arbitrary number of + positional arguments; bit ``0x08`` is set if the function uses the + ``**keywords`` syntax to accept arbitrary keyword arguments; bit ``0x20`` is set + if the function is a generator. + + Future feature declarations (``from __future__ import division``) also use bits + in :attr:`co_flags` to indicate whether a code object was compiled with a + particular feature enabled: bit ``0x2000`` is set if the function was compiled + with future division enabled; bits ``0x10`` and ``0x1000`` were used in earlier + versions of Python. + + Other bits in :attr:`co_flags` are reserved for internal use. + + .. index:: single: documentation string + + If a code object represents a function, the first item in :attr:`co_consts` is + the documentation string of the function, or ``None`` if undefined. + + .. _frame-objects: + + Frame objects + .. index:: object: frame + + Frame objects represent execution frames. They may occur in traceback objects + (see below), and are also passed to registered trace functions. + + .. index:: + single: f_back (frame attribute) + single: f_code (frame attribute) + single: f_globals (frame attribute) + single: f_locals (frame attribute) + single: f_lasti (frame attribute) + single: f_builtins (frame attribute) + + Special read-only attributes: :attr:`f_back` is to the previous stack frame + (towards the caller), or ``None`` if this is the bottom stack frame; + :attr:`f_code` is the code object being executed in this frame; :attr:`f_locals` + is the dictionary used to look up local variables; :attr:`f_globals` is used for + global variables; :attr:`f_builtins` is used for built-in (intrinsic) names; + :attr:`f_lasti` gives the precise instruction (this is an index into the + bytecode string of the code object). + + .. index:: + single: f_trace (frame attribute) + single: f_trace_lines (frame attribute) + single: f_trace_opcodes (frame attribute) + single: f_lineno (frame attribute) + + Special writable attributes: :attr:`f_trace`, if not ``None``, is a function + called for various events during code execution (this is used by the debugger). + Normally an event is triggered for each new source line - this can be + disabled by setting :attr:`f_trace_lines` to :const:`False`. + + Implementations *may* allow per-opcode events to be requested by setting + :attr:`f_trace_opcodes` to :const:`True`. Note that this may lead to + undefined interpreter behaviour if exceptions raised by the trace + function escape to the function being traced. + + :attr:`f_lineno` is the current line number of the frame --- writing to this + from within a trace function jumps to the given line (only for the bottom-most + frame). A debugger can implement a Jump command (aka Set Next Statement) + by writing to f_lineno. + + Frame objects support one method: + + .. method:: frame.clear() + + This method clears all references to local variables held by the + frame. Also, if the frame belonged to a generator, the generator + is finalized. This helps break reference cycles involving frame + objects (for example when catching an exception and storing its + traceback for later use). + + :exc:`RuntimeError` is raised if the frame is currently executing. + + .. versionadded:: 3.4 + + .. _traceback-objects: + + Traceback objects + .. index:: + object: traceback + pair: stack; trace + pair: exception; handler + pair: execution; stack + single: exc_info (in module sys) + single: last_traceback (in module sys) + single: sys.exc_info + single: sys.last_traceback + + Traceback objects represent a stack trace of an exception. A traceback object + is implicitly created when an exception occurs, and may also be explicitly + created by calling :class:`types.TracebackType`. + + For implicitly created tracebacks, when the search for an exception handler + unwinds the execution stack, at each unwound level a traceback object is + inserted in front of the current traceback. When an exception handler is + entered, the stack trace is made available to the program. (See section + :ref:`try`.) It is accessible as the third item of the + tuple returned by ``sys.exc_info()``, and as the ``__traceback__`` attribute + of the caught exception. + + When the program contains no suitable + handler, the stack trace is written (nicely formatted) to the standard error + stream; if the interpreter is interactive, it is also made available to the user + as ``sys.last_traceback``. + + For explicitly created tracebacks, it is up to the creator of the traceback + to determine how the ``tb_next`` attributes should be linked to form a + full stack trace. + + .. index:: + single: tb_frame (traceback attribute) + single: tb_lineno (traceback attribute) + single: tb_lasti (traceback attribute) + statement: try + + Special read-only attributes: + :attr:`tb_frame` points to the execution frame of the current level; + :attr:`tb_lineno` gives the line number where the exception occurred; + :attr:`tb_lasti` indicates the precise instruction. + The line number and last instruction in the traceback may differ from the + line number of its frame object if the exception occurred in a + :keyword:`try` statement with no matching except clause or with a + finally clause. + + .. index:: + single: tb_next (traceback attribute) + + Special writable attribute: :attr:`tb_next` is the next level in the stack + trace (towards the frame where the exception occurred), or ``None`` if + there is no next level. + + .. versionchanged:: 3.7 + Traceback objects can now be explicitly instantiated from Python code, + and the ``tb_next`` attribute of existing instances can be updated. + + Slice objects + .. index:: builtin: slice + + Slice objects are used to represent slices for :meth:`__getitem__` + methods. They are also created by the built-in :func:`slice` function. + + .. index:: + single: start (slice object attribute) + single: stop (slice object attribute) + single: step (slice object attribute) + + Special read-only attributes: :attr:`~slice.start` is the lower bound; + :attr:`~slice.stop` is the upper bound; :attr:`~slice.step` is the step + value; each is ``None`` if omitted. These attributes can have any type. + + Slice objects support one method: + + .. method:: slice.indices(self, length) + + This method takes a single integer argument *length* and computes + information about the slice that the slice object would describe if + applied to a sequence of *length* items. It returns a tuple of three + integers; respectively these are the *start* and *stop* indices and the + *step* or stride length of the slice. Missing or out-of-bounds indices + are handled in a manner consistent with regular slices. + + Static method objects + Static method objects provide a way of defeating the transformation of function + objects to method objects described above. A static method object is a wrapper + around any other object, usually a user-defined method object. When a static + method object is retrieved from a class or a class instance, the object actually + returned is the wrapped object, which is not subject to any further + transformation. Static method objects are not themselves callable, although the + objects they wrap usually are. Static method objects are created by the built-in + :func:`staticmethod` constructor. + + Class method objects + A class method object, like a static method object, is a wrapper around another + object that alters the way in which that object is retrieved from classes and + class instances. The behaviour of class method objects upon such retrieval is + described above, under "User-defined methods". Class method objects are created + by the built-in :func:`classmethod` constructor. + + +.. _specialnames: + +Special method names +==================== + +.. index:: + pair: operator; overloading + single: __getitem__() (mapping object method) + +A class can implement certain operations that are invoked by special syntax +(such as arithmetic operations or subscripting and slicing) by defining methods +with special names. This is Python's approach to :dfn:`operator overloading`, +allowing classes to define their own behavior with respect to language +operators. For instance, if a class defines a method named :meth:`__getitem__`, +and ``x`` is an instance of this class, then ``x[i]`` is roughly equivalent +to ``type(x).__getitem__(x, i)``. Except where mentioned, attempts to execute an +operation raise an exception when no appropriate method is defined (typically +:exc:`AttributeError` or :exc:`TypeError`). + +Setting a special method to ``None`` indicates that the corresponding +operation is not available. For example, if a class sets +:meth:`__iter__` to ``None``, the class is not iterable, so calling +:func:`iter` on its instances will raise a :exc:`TypeError` (without +falling back to :meth:`__getitem__`). [#]_ + +When implementing a class that emulates any built-in type, it is important that +the emulation only be implemented to the degree that it makes sense for the +object being modelled. For example, some sequences may work well with retrieval +of individual elements, but extracting a slice may not make sense. (One example +of this is the :class:`~xml.dom.NodeList` interface in the W3C's Document +Object Model.) + + +.. _customization: + +Basic customization +------------------- + +.. method:: object.__new__(cls[, ...]) + + .. index:: pair: subclassing; immutable types + + Called to create a new instance of class *cls*. :meth:`__new__` is a static + method (special-cased so you need not declare it as such) that takes the class + of which an instance was requested as its first argument. The remaining + arguments are those passed to the object constructor expression (the call to the + class). The return value of :meth:`__new__` should be the new object instance + (usually an instance of *cls*). + + Typical implementations create a new instance of the class by invoking the + superclass's :meth:`__new__` method using ``super().__new__(cls[, ...])`` + with appropriate arguments and then modifying the newly-created instance + as necessary before returning it. + + If :meth:`__new__` returns an instance of *cls*, then the new instance's + :meth:`__init__` method will be invoked like ``__init__(self[, ...])``, where + *self* is the new instance and the remaining arguments are the same as were + passed to :meth:`__new__`. + + If :meth:`__new__` does not return an instance of *cls*, then the new instance's + :meth:`__init__` method will not be invoked. + + :meth:`__new__` is intended mainly to allow subclasses of immutable types (like + int, str, or tuple) to customize instance creation. It is also commonly + overridden in custom metaclasses in order to customize class creation. + + +.. method:: object.__init__(self[, ...]) + + .. index:: pair: class; constructor + + Called after the instance has been created (by :meth:`__new__`), but before + it is returned to the caller. The arguments are those passed to the + class constructor expression. If a base class has an :meth:`__init__` + method, the derived class's :meth:`__init__` method, if any, must explicitly + call it to ensure proper initialization of the base class part of the + instance; for example: ``super().__init__([args...])``. + + Because :meth:`__new__` and :meth:`__init__` work together in constructing + objects (:meth:`__new__` to create it, and :meth:`__init__` to customize it), + no non-``None`` value may be returned by :meth:`__init__`; doing so will + cause a :exc:`TypeError` to be raised at runtime. + + +.. method:: object.__del__(self) + + .. index:: + single: destructor + single: finalizer + statement: del + + Called when the instance is about to be destroyed. This is also called a + finalizer or (improperly) a destructor. If a base class has a + :meth:`__del__` method, the derived class's :meth:`__del__` method, + if any, must explicitly call it to ensure proper deletion of the base + class part of the instance. + + It is possible (though not recommended!) for the :meth:`__del__` method + to postpone destruction of the instance by creating a new reference to + it. This is called object *resurrection*. It is implementation-dependent + whether :meth:`__del__` is called a second time when a resurrected object + is about to be destroyed; the current :term:`CPython` implementation + only calls it once. + + It is not guaranteed that :meth:`__del__` methods are called for objects + that still exist when the interpreter exits. + + .. note:: + + ``del x`` doesn't directly call ``x.__del__()`` --- the former decrements + the reference count for ``x`` by one, and the latter is only called when + ``x``'s reference count reaches zero. + + .. impl-detail:: + It is possible for a reference cycle to prevent the reference count + of an object from going to zero. In this case, the cycle will be + later detected and deleted by the :term:`cyclic garbage collector + `. A common cause of reference cycles is when + an exception has been caught in a local variable. The frame's + locals then reference the exception, which references its own + traceback, which references the locals of all frames caught in the + traceback. + + .. seealso:: + Documentation for the :mod:`gc` module. + + .. warning:: + + Due to the precarious circumstances under which :meth:`__del__` methods are + invoked, exceptions that occur during their execution are ignored, and a warning + is printed to ``sys.stderr`` instead. In particular: + + * :meth:`__del__` can be invoked when arbitrary code is being executed, + including from any arbitrary thread. If :meth:`__del__` needs to take + a lock or invoke any other blocking resource, it may deadlock as + the resource may already be taken by the code that gets interrupted + to execute :meth:`__del__`. + + * :meth:`__del__` can be executed during interpreter shutdown. As a + consequence, the global variables it needs to access (including other + modules) may already have been deleted or set to ``None``. Python + guarantees that globals whose name begins with a single underscore + are deleted from their module before other globals are deleted; if + no other references to such globals exist, this may help in assuring + that imported modules are still available at the time when the + :meth:`__del__` method is called. + + + .. index:: + single: repr() (built-in function); __repr__() (object method) + +.. method:: object.__repr__(self) + + Called by the :func:`repr` built-in function to compute the "official" string + representation of an object. If at all possible, this should look like a + valid Python expression that could be used to recreate an object with the + same value (given an appropriate environment). If this is not possible, a + string of the form ``<...some useful description...>`` should be returned. + The return value must be a string object. If a class defines :meth:`__repr__` + but not :meth:`__str__`, then :meth:`__repr__` is also used when an + "informal" string representation of instances of that class is required. + + This is typically used for debugging, so it is important that the representation + is information-rich and unambiguous. + + .. index:: + single: string; __str__() (object method) + single: format() (built-in function); __str__() (object method) + single: print() (built-in function); __str__() (object method) + + +.. method:: object.__str__(self) + + Called by :func:`str(object) ` and the built-in functions + :func:`format` and :func:`print` to compute the "informal" or nicely + printable string representation of an object. The return value must be a + :ref:`string ` object. + + This method differs from :meth:`object.__repr__` in that there is no + expectation that :meth:`__str__` return a valid Python expression: a more + convenient or concise representation can be used. + + The default implementation defined by the built-in type :class:`object` + calls :meth:`object.__repr__`. + + .. XXX what about subclasses of string? + + +.. method:: object.__bytes__(self) + + .. index:: builtin: bytes + + Called by :ref:`bytes ` to compute a byte-string representation + of an object. This should return a :class:`bytes` object. + + .. index:: + single: string; __format__() (object method) + pair: string; conversion + builtin: print + + +.. method:: object.__format__(self, format_spec) + + Called by the :func:`format` built-in function, + and by extension, evaluation of :ref:`formatted string literals + ` and the :meth:`str.format` method, to produce a "formatted" + string representation of an object. The *format_spec* argument is + a string that contains a description of the formatting options desired. + The interpretation of the *format_spec* argument is up to the type + implementing :meth:`__format__`, however most classes will either + delegate formatting to one of the built-in types, or use a similar + formatting option syntax. + + See :ref:`formatspec` for a description of the standard formatting syntax. + + The return value must be a string object. + + .. versionchanged:: 3.4 + The __format__ method of ``object`` itself raises a :exc:`TypeError` + if passed any non-empty string. + + .. versionchanged:: 3.7 + ``object.__format__(x, '')`` is now equivalent to ``str(x)`` rather + than ``format(str(self), '')``. + + +.. _richcmpfuncs: +.. method:: object.__lt__(self, other) + object.__le__(self, other) + object.__eq__(self, other) + object.__ne__(self, other) + object.__gt__(self, other) + object.__ge__(self, other) + + .. index:: + single: comparisons + + These are the so-called "rich comparison" methods. The correspondence between + operator symbols and method names is as follows: ``xy`` calls ``x.__gt__(y)``, and ``x>=y`` calls + ``x.__ge__(y)``. + + A rich comparison method may return the singleton ``NotImplemented`` if it does + not implement the operation for a given pair of arguments. By convention, + ``False`` and ``True`` are returned for a successful comparison. However, these + methods can return any value, so if the comparison operator is used in a Boolean + context (e.g., in the condition of an ``if`` statement), Python will call + :func:`bool` on the value to determine if the result is true or false. + + By default, :meth:`__ne__` delegates to :meth:`__eq__` and + inverts the result unless it is ``NotImplemented``. There are no other + implied relationships among the comparison operators, for example, + the truth of ``(x.__hash__``. + + If a class that does not override :meth:`__eq__` wishes to suppress hash + support, it should include ``__hash__ = None`` in the class definition. + A class which defines its own :meth:`__hash__` that explicitly raises + a :exc:`TypeError` would be incorrectly identified as hashable by + an ``isinstance(obj, collections.abc.Hashable)`` call. + + + .. note:: + + By default, the :meth:`__hash__` values of str, bytes and datetime + objects are "salted" with an unpredictable random value. Although they + remain constant within an individual Python process, they are not + predictable between repeated invocations of Python. + + This is intended to provide protection against a denial-of-service caused + by carefully-chosen inputs that exploit the worst case performance of a + dict insertion, O(n^2) complexity. See + http://www.ocert.org/advisories/ocert-2011-003.html for details. + + Changing hash values affects the iteration order of sets. + Python has never made guarantees about this ordering + (and it typically varies between 32-bit and 64-bit builds). + + See also :envvar:`PYTHONHASHSEED`. + + .. versionchanged:: 3.3 + Hash randomization is enabled by default. + + +.. method:: object.__bool__(self) + + .. index:: single: __len__() (mapping object method) + + Called to implement truth value testing and the built-in operation + ``bool()``; should return ``False`` or ``True``. When this method is not + defined, :meth:`__len__` is called, if it is defined, and the object is + considered true if its result is nonzero. If a class defines neither + :meth:`__len__` nor :meth:`__bool__`, all its instances are considered + true. + + +.. _attribute-access: + +Customizing attribute access +---------------------------- + +The following methods can be defined to customize the meaning of attribute +access (use of, assignment to, or deletion of ``x.name``) for class instances. + +.. XXX explain how descriptors interfere here! + + +.. method:: object.__getattr__(self, name) + + Called when the default attribute access fails with an :exc:`AttributeError` + (either :meth:`__getattribute__` raises an :exc:`AttributeError` because + *name* is not an instance attribute or an attribute in the class tree + for ``self``; or :meth:`__get__` of a *name* property raises + :exc:`AttributeError`). This method should either return the (computed) + attribute value or raise an :exc:`AttributeError` exception. + + Note that if the attribute is found through the normal mechanism, + :meth:`__getattr__` is not called. (This is an intentional asymmetry between + :meth:`__getattr__` and :meth:`__setattr__`.) This is done both for efficiency + reasons and because otherwise :meth:`__getattr__` would have no way to access + other attributes of the instance. Note that at least for instance variables, + you can fake total control by not inserting any values in the instance attribute + dictionary (but instead inserting them in another object). See the + :meth:`__getattribute__` method below for a way to actually get total control + over attribute access. + + +.. method:: object.__getattribute__(self, name) + + Called unconditionally to implement attribute accesses for instances of the + class. If the class also defines :meth:`__getattr__`, the latter will not be + called unless :meth:`__getattribute__` either calls it explicitly or raises an + :exc:`AttributeError`. This method should return the (computed) attribute value + or raise an :exc:`AttributeError` exception. In order to avoid infinite + recursion in this method, its implementation should always call the base class + method with the same name to access any attributes it needs, for example, + ``object.__getattribute__(self, name)``. + + .. note:: + + This method may still be bypassed when looking up special methods as the + result of implicit invocation via language syntax or built-in functions. + See :ref:`special-lookup`. + + +.. method:: object.__setattr__(self, name, value) + + Called when an attribute assignment is attempted. This is called instead of + the normal mechanism (i.e. store the value in the instance dictionary). + *name* is the attribute name, *value* is the value to be assigned to it. + + If :meth:`__setattr__` wants to assign to an instance attribute, it should + call the base class method with the same name, for example, + ``object.__setattr__(self, name, value)``. + + +.. method:: object.__delattr__(self, name) + + Like :meth:`__setattr__` but for attribute deletion instead of assignment. This + should only be implemented if ``del obj.name`` is meaningful for the object. + + +.. method:: object.__dir__(self) + + Called when :func:`dir` is called on the object. A sequence must be + returned. :func:`dir` converts the returned sequence to a list and sorts it. + + +Customizing module attribute access +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. index:: + single: __getattr__ (module attribute) + single: __dir__ (module attribute) + single: __class__ (module attribute) + +Special names ``__getattr__`` and ``__dir__`` can be also used to customize +access to module attributes. The ``__getattr__`` function at the module level +should accept one argument which is the name of an attribute and return the +computed value or raise an :exc:`AttributeError`. If an attribute is +not found on a module object through the normal lookup, i.e. +:meth:`object.__getattribute__`, then ``__getattr__`` is searched in +the module ``__dict__`` before raising an :exc:`AttributeError`. If found, +it is called with the attribute name and the result is returned. + +The ``__dir__`` function should accept no arguments, and return a list of +strings that represents the names accessible on module. If present, this +function overrides the standard :func:`dir` search on a module. + +For a more fine grained customization of the module behavior (setting +attributes, properties, etc.), one can set the ``__class__`` attribute of +a module object to a subclass of :class:`types.ModuleType`. For example:: + + import sys + from types import ModuleType + + class VerboseModule(ModuleType): + def __repr__(self): + return f'Verbose {self.__name__}' + + def __setattr__(self, attr, value): + print(f'Setting {attr}...') + super().__setattr__(attr, value) + + sys.modules[__name__].__class__ = VerboseModule + +.. note:: + Defining module ``__getattr__`` and setting module ``__class__`` only + affect lookups made using the attribute access syntax -- directly accessing + the module globals (whether by code within the module, or via a reference + to the module's globals dictionary) is unaffected. + +.. versionchanged:: 3.5 + ``__class__`` module attribute is now writable. + +.. versionadded:: 3.7 + ``__getattr__`` and ``__dir__`` module attributes. + +.. seealso:: + + :pep:`562` - Module __getattr__ and __dir__ + Describes the ``__getattr__`` and ``__dir__`` functions on modules. + + +.. _descriptors: + +Implementing Descriptors +^^^^^^^^^^^^^^^^^^^^^^^^ + +The following methods only apply when an instance of the class containing the +method (a so-called *descriptor* class) appears in an *owner* class (the +descriptor must be in either the owner's class dictionary or in the class +dictionary for one of its parents). In the examples below, "the attribute" +refers to the attribute whose name is the key of the property in the owner +class' :attr:`~object.__dict__`. + + +.. method:: object.__get__(self, instance, owner) + + Called to get the attribute of the owner class (class attribute access) or of an + instance of that class (instance attribute access). *owner* is always the owner + class, while *instance* is the instance that the attribute was accessed through, + or ``None`` when the attribute is accessed through the *owner*. This method + should return the (computed) attribute value or raise an :exc:`AttributeError` + exception. + + +.. method:: object.__set__(self, instance, value) + + Called to set the attribute on an instance *instance* of the owner class to a + new value, *value*. + + +.. method:: object.__delete__(self, instance) + + Called to delete the attribute on an instance *instance* of the owner class. + + +.. method:: object.__set_name__(self, owner, name) + + Called at the time the owning class *owner* is created. The + descriptor has been assigned to *name*. + + .. versionadded:: 3.6 + + +The attribute :attr:`__objclass__` is interpreted by the :mod:`inspect` module +as specifying the class where this object was defined (setting this +appropriately can assist in runtime introspection of dynamic class attributes). +For callables, it may indicate that an instance of the given type (or a +subclass) is expected or required as the first positional argument (for example, +CPython sets this attribute for unbound methods that are implemented in C). + + +.. _descriptor-invocation: + +Invoking Descriptors +^^^^^^^^^^^^^^^^^^^^ + +In general, a descriptor is an object attribute with "binding behavior", one +whose attribute access has been overridden by methods in the descriptor +protocol: :meth:`__get__`, :meth:`__set__`, and :meth:`__delete__`. If any of +those methods are defined for an object, it is said to be a descriptor. + +The default behavior for attribute access is to get, set, or delete the +attribute from an object's dictionary. For instance, ``a.x`` has a lookup chain +starting with ``a.__dict__['x']``, then ``type(a).__dict__['x']``, and +continuing through the base classes of ``type(a)`` excluding metaclasses. + +However, if the looked-up value is an object defining one of the descriptor +methods, then Python may override the default behavior and invoke the descriptor +method instead. Where this occurs in the precedence chain depends on which +descriptor methods were defined and how they were called. + +The starting point for descriptor invocation is a binding, ``a.x``. How the +arguments are assembled depends on ``a``: + +Direct Call + The simplest and least common call is when user code directly invokes a + descriptor method: ``x.__get__(a)``. + +Instance Binding + If binding to an object instance, ``a.x`` is transformed into the call: + ``type(a).__dict__['x'].__get__(a, type(a))``. + +Class Binding + If binding to a class, ``A.x`` is transformed into the call: + ``A.__dict__['x'].__get__(None, A)``. + +Super Binding + If ``a`` is an instance of :class:`super`, then the binding ``super(B, obj).m()`` + searches ``obj.__class__.__mro__`` for the base class ``A`` + immediately preceding ``B`` and then invokes the descriptor with the call: + ``A.__dict__['m'].__get__(obj, obj.__class__)``. + +For instance bindings, the precedence of descriptor invocation depends on the +which descriptor methods are defined. A descriptor can define any combination +of :meth:`__get__`, :meth:`__set__` and :meth:`__delete__`. If it does not +define :meth:`__get__`, then accessing the attribute will return the descriptor +object itself unless there is a value in the object's instance dictionary. If +the descriptor defines :meth:`__set__` and/or :meth:`__delete__`, it is a data +descriptor; if it defines neither, it is a non-data descriptor. Normally, data +descriptors define both :meth:`__get__` and :meth:`__set__`, while non-data +descriptors have just the :meth:`__get__` method. Data descriptors with +:meth:`__set__` and :meth:`__get__` defined always override a redefinition in an +instance dictionary. In contrast, non-data descriptors can be overridden by +instances. + +Python methods (including :func:`staticmethod` and :func:`classmethod`) are +implemented as non-data descriptors. Accordingly, instances can redefine and +override methods. This allows individual instances to acquire behaviors that +differ from other instances of the same class. + +The :func:`property` function is implemented as a data descriptor. Accordingly, +instances cannot override the behavior of a property. + + +.. _slots: + +__slots__ +^^^^^^^^^ + +*__slots__* allow us to explicitly declare data members (like +properties) and deny the creation of *__dict__* and *__weakref__* +(unless explicitly declared in *__slots__* or available in a parent.) + +The space saved over using *__dict__* can be significant. +Attribute lookup speed can be significantly improved as well. + +.. data:: object.__slots__ + + This class variable can be assigned a string, iterable, or sequence of + strings with variable names used by instances. *__slots__* reserves space + for the declared variables and prevents the automatic creation of *__dict__* + and *__weakref__* for each instance. + + +Notes on using *__slots__* +"""""""""""""""""""""""""" + +* When inheriting from a class without *__slots__*, the *__dict__* and + *__weakref__* attribute of the instances will always be accessible. + +* Without a *__dict__* variable, instances cannot be assigned new variables not + listed in the *__slots__* definition. Attempts to assign to an unlisted + variable name raises :exc:`AttributeError`. If dynamic assignment of new + variables is desired, then add ``'__dict__'`` to the sequence of strings in + the *__slots__* declaration. + +* Without a *__weakref__* variable for each instance, classes defining + *__slots__* do not support weak references to its instances. If weak reference + support is needed, then add ``'__weakref__'`` to the sequence of strings in the + *__slots__* declaration. + +* *__slots__* are implemented at the class level by creating descriptors + (:ref:`descriptors`) for each variable name. As a result, class attributes + cannot be used to set default values for instance variables defined by + *__slots__*; otherwise, the class attribute would overwrite the descriptor + assignment. + +* The action of a *__slots__* declaration is not limited to the class + where it is defined. *__slots__* declared in parents are available in + child classes. However, child subclasses will get a *__dict__* and + *__weakref__* unless they also define *__slots__* (which should only + contain names of any *additional* slots). + +* If a class defines a slot also defined in a base class, the instance variable + defined by the base class slot is inaccessible (except by retrieving its + descriptor directly from the base class). This renders the meaning of the + program undefined. In the future, a check may be added to prevent this. + +* Nonempty *__slots__* does not work for classes derived from "variable-length" + built-in types such as :class:`int`, :class:`bytes` and :class:`tuple`. + +* Any non-string iterable may be assigned to *__slots__*. Mappings may also be + used; however, in the future, special meaning may be assigned to the values + corresponding to each key. + +* *__class__* assignment works only if both classes have the same *__slots__*. + +* Multiple inheritance with multiple slotted parent classes can be used, + but only one parent is allowed to have attributes created by slots + (the other bases must have empty slot layouts) - violations raise + :exc:`TypeError`. + +.. _class-customization: + +Customizing class creation +-------------------------- + +Whenever a class inherits from another class, *__init_subclass__* is +called on that class. This way, it is possible to write classes which +change the behavior of subclasses. This is closely related to class +decorators, but where class decorators only affect the specific class they're +applied to, ``__init_subclass__`` solely applies to future subclasses of the +class defining the method. + +.. classmethod:: object.__init_subclass__(cls) + + This method is called whenever the containing class is subclassed. + *cls* is then the new subclass. If defined as a normal instance method, + this method is implicitly converted to a class method. + + Keyword arguments which are given to a new class are passed to + the parent's class ``__init_subclass__``. For compatibility with + other classes using ``__init_subclass__``, one should take out the + needed keyword arguments and pass the others over to the base + class, as in:: + + class Philosopher: + def __init_subclass__(cls, default_name, **kwargs): + super().__init_subclass__(**kwargs) + cls.default_name = default_name + + class AustralianPhilosopher(Philosopher, default_name="Bruce"): + pass + + The default implementation ``object.__init_subclass__`` does + nothing, but raises an error if it is called with any arguments. + + .. note:: + + The metaclass hint ``metaclass`` is consumed by the rest of the type + machinery, and is never passed to ``__init_subclass__`` implementations. + The actual metaclass (rather than the explicit hint) can be accessed as + ``type(cls)``. + + .. versionadded:: 3.6 + + +.. _metaclasses: + +Metaclasses +^^^^^^^^^^^ + +.. index:: + single: metaclass + builtin: type + single: = (equals); class definition + +By default, classes are constructed using :func:`type`. The class body is +executed in a new namespace and the class name is bound locally to the +result of ``type(name, bases, namespace)``. + +The class creation process can be customized by passing the ``metaclass`` +keyword argument in the class definition line, or by inheriting from an +existing class that included such an argument. In the following example, +both ``MyClass`` and ``MySubclass`` are instances of ``Meta``:: + + class Meta(type): + pass + + class MyClass(metaclass=Meta): + pass + + class MySubclass(MyClass): + pass + +Any other keyword arguments that are specified in the class definition are +passed through to all metaclass operations described below. + +When a class definition is executed, the following steps occur: + +* MRO entries are resolved; +* the appropriate metaclass is determined; +* the class namespace is prepared; +* the class body is executed; +* the class object is created. + + +Resolving MRO entries +^^^^^^^^^^^^^^^^^^^^^ + +If a base that appears in class definition is not an instance of :class:`type`, +then an ``__mro_entries__`` method is searched on it. If found, it is called +with the original bases tuple. This method must return a tuple of classes that +will be used instead of this base. The tuple may be empty, in such case +the original base is ignored. + +.. seealso:: + + :pep:`560` - Core support for typing module and generic types + + +Determining the appropriate metaclass +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. index:: + single: metaclass hint + +The appropriate metaclass for a class definition is determined as follows: + +* if no bases and no explicit metaclass are given, then :func:`type` is used; +* if an explicit metaclass is given and it is *not* an instance of + :func:`type`, then it is used directly as the metaclass; +* if an instance of :func:`type` is given as the explicit metaclass, or + bases are defined, then the most derived metaclass is used. + +The most derived metaclass is selected from the explicitly specified +metaclass (if any) and the metaclasses (i.e. ``type(cls)``) of all specified +base classes. The most derived metaclass is one which is a subtype of *all* +of these candidate metaclasses. If none of the candidate metaclasses meets +that criterion, then the class definition will fail with ``TypeError``. + + +.. _prepare: + +Preparing the class namespace +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. index:: + single: __prepare__ (metaclass method) + +Once the appropriate metaclass has been identified, then the class namespace +is prepared. If the metaclass has a ``__prepare__`` attribute, it is called +as ``namespace = metaclass.__prepare__(name, bases, **kwds)`` (where the +additional keyword arguments, if any, come from the class definition). + +If the metaclass has no ``__prepare__`` attribute, then the class namespace +is initialised as an empty ordered mapping. + +.. seealso:: + + :pep:`3115` - Metaclasses in Python 3000 + Introduced the ``__prepare__`` namespace hook + + +Executing the class body +^^^^^^^^^^^^^^^^^^^^^^^^ + +.. index:: + single: class; body + +The class body is executed (approximately) as +``exec(body, globals(), namespace)``. The key difference from a normal +call to :func:`exec` is that lexical scoping allows the class body (including +any methods) to reference names from the current and outer scopes when the +class definition occurs inside a function. + +However, even when the class definition occurs inside the function, methods +defined inside the class still cannot see names defined at the class scope. +Class variables must be accessed through the first parameter of instance or +class methods, or through the implicit lexically scoped ``__class__`` reference +described in the next section. + +.. _class-object-creation: + +Creating the class object +^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. index:: + single: __class__ (method cell) + single: __classcell__ (class namespace entry) + + +Once the class namespace has been populated by executing the class body, +the class object is created by calling +``metaclass(name, bases, namespace, **kwds)`` (the additional keywords +passed here are the same as those passed to ``__prepare__``). + +This class object is the one that will be referenced by the zero-argument +form of :func:`super`. ``__class__`` is an implicit closure reference +created by the compiler if any methods in a class body refer to either +``__class__`` or ``super``. This allows the zero argument form of +:func:`super` to correctly identify the class being defined based on +lexical scoping, while the class or instance that was used to make the +current call is identified based on the first argument passed to the method. + +.. impl-detail:: + + In CPython 3.6 and later, the ``__class__`` cell is passed to the metaclass + as a ``__classcell__`` entry in the class namespace. If present, this must + be propagated up to the ``type.__new__`` call in order for the class to be + initialised correctly. + Failing to do so will result in a :exc:`DeprecationWarning` in Python 3.6, + and a :exc:`RuntimeError` in Python 3.8. + +When using the default metaclass :class:`type`, or any metaclass that ultimately +calls ``type.__new__``, the following additional customisation steps are +invoked after creating the class object: + +* first, ``type.__new__`` collects all of the descriptors in the class + namespace that define a :meth:`~object.__set_name__` method; +* second, all of these ``__set_name__`` methods are called with the class + being defined and the assigned name of that particular descriptor; +* finally, the :meth:`~object.__init_subclass__` hook is called on the + immediate parent of the new class in its method resolution order. + +After the class object is created, it is passed to the class decorators +included in the class definition (if any) and the resulting object is bound +in the local namespace as the defined class. + +When a new class is created by ``type.__new__``, the object provided as the +namespace parameter is copied to a new ordered mapping and the original +object is discarded. The new copy is wrapped in a read-only proxy, which +becomes the :attr:`~object.__dict__` attribute of the class object. + +.. seealso:: + + :pep:`3135` - New super + Describes the implicit ``__class__`` closure reference + + +Uses for metaclasses +^^^^^^^^^^^^^^^^^^^^ + +The potential uses for metaclasses are boundless. Some ideas that have been +explored include enum, logging, interface checking, automatic delegation, +automatic property creation, proxies, frameworks, and automatic resource +locking/synchronization. + + +Customizing instance and subclass checks +---------------------------------------- + +The following methods are used to override the default behavior of the +:func:`isinstance` and :func:`issubclass` built-in functions. + +In particular, the metaclass :class:`abc.ABCMeta` implements these methods in +order to allow the addition of Abstract Base Classes (ABCs) as "virtual base +classes" to any class or type (including built-in types), including other +ABCs. + +.. method:: class.__instancecheck__(self, instance) + + Return true if *instance* should be considered a (direct or indirect) + instance of *class*. If defined, called to implement ``isinstance(instance, + class)``. + + +.. method:: class.__subclasscheck__(self, subclass) + + Return true if *subclass* should be considered a (direct or indirect) + subclass of *class*. If defined, called to implement ``issubclass(subclass, + class)``. + + +Note that these methods are looked up on the type (metaclass) of a class. They +cannot be defined as class methods in the actual class. This is consistent with +the lookup of special methods that are called on instances, only in this +case the instance is itself a class. + +.. seealso:: + + :pep:`3119` - Introducing Abstract Base Classes + Includes the specification for customizing :func:`isinstance` and + :func:`issubclass` behavior through :meth:`~class.__instancecheck__` and + :meth:`~class.__subclasscheck__`, with motivation for this functionality + in the context of adding Abstract Base Classes (see the :mod:`abc` + module) to the language. + + +Emulating generic types +----------------------- + +One can implement the generic class syntax as specified by :pep:`484` +(for example ``List[int]``) by defining a special method: + +.. classmethod:: object.__class_getitem__(cls, key) + + Return an object representing the specialization of a generic class + by type arguments found in *key*. + +This method is looked up on the class object itself, and when defined in +the class body, this method is implicitly a class method. Note, this +mechanism is primarily reserved for use with static type hints, other usage +is discouraged. + +.. seealso:: + + :pep:`560` - Core support for typing module and generic types + + +.. _callable-types: + +Emulating callable objects +-------------------------- + + +.. method:: object.__call__(self[, args...]) + + .. index:: pair: call; instance + + Called when the instance is "called" as a function; if this method is defined, + ``x(arg1, arg2, ...)`` is a shorthand for ``x.__call__(arg1, arg2, ...)``. + + +.. _sequence-types: + +Emulating container types +------------------------- + +The following methods can be defined to implement container objects. Containers +usually are sequences (such as lists or tuples) or mappings (like dictionaries), +but can represent other containers as well. The first set of methods is used +either to emulate a sequence or to emulate a mapping; the difference is that for +a sequence, the allowable keys should be the integers *k* for which ``0 <= k < +N`` where *N* is the length of the sequence, or slice objects, which define a +range of items. It is also recommended that mappings provide the methods +:meth:`keys`, :meth:`values`, :meth:`items`, :meth:`get`, :meth:`clear`, +:meth:`setdefault`, :meth:`pop`, :meth:`popitem`, :meth:`!copy`, and +:meth:`update` behaving similar to those for Python's standard dictionary +objects. The :mod:`collections.abc` module provides a +:class:`~collections.abc.MutableMapping` +abstract base class to help create those methods from a base set of +:meth:`__getitem__`, :meth:`__setitem__`, :meth:`__delitem__`, and :meth:`keys`. +Mutable sequences should provide methods :meth:`append`, :meth:`count`, +:meth:`index`, :meth:`extend`, :meth:`insert`, :meth:`pop`, :meth:`remove`, +:meth:`reverse` and :meth:`sort`, like Python standard list objects. Finally, +sequence types should implement addition (meaning concatenation) and +multiplication (meaning repetition) by defining the methods :meth:`__add__`, +:meth:`__radd__`, :meth:`__iadd__`, :meth:`__mul__`, :meth:`__rmul__` and +:meth:`__imul__` described below; they should not define other numerical +operators. It is recommended that both mappings and sequences implement the +:meth:`__contains__` method to allow efficient use of the ``in`` operator; for +mappings, ``in`` should search the mapping's keys; for sequences, it should +search through the values. It is further recommended that both mappings and +sequences implement the :meth:`__iter__` method to allow efficient iteration +through the container; for mappings, :meth:`__iter__` should be the same as +:meth:`keys`; for sequences, it should iterate through the values. + +.. method:: object.__len__(self) + + .. index:: + builtin: len + single: __bool__() (object method) + + Called to implement the built-in function :func:`len`. Should return the length + of the object, an integer ``>=`` 0. Also, an object that doesn't define a + :meth:`__bool__` method and whose :meth:`__len__` method returns zero is + considered to be false in a Boolean context. + + .. impl-detail:: + + In CPython, the length is required to be at most :attr:`sys.maxsize`. + If the length is larger than :attr:`!sys.maxsize` some features (such as + :func:`len`) may raise :exc:`OverflowError`. To prevent raising + :exc:`!OverflowError` by truth value testing, an object must define a + :meth:`__bool__` method. + + +.. method:: object.__length_hint__(self) + + Called to implement :func:`operator.length_hint`. Should return an estimated + length for the object (which may be greater or less than the actual length). + The length must be an integer ``>=`` 0. This method is purely an + optimization and is never required for correctness. + + .. versionadded:: 3.4 + + +.. index:: object: slice + +.. note:: + + Slicing is done exclusively with the following three methods. A call like :: + + a[1:2] = b + + is translated to :: + + a[slice(1, 2, None)] = b + + and so forth. Missing slice items are always filled in with ``None``. + + +.. method:: object.__getitem__(self, key) + + Called to implement evaluation of ``self[key]``. For sequence types, the + accepted keys should be integers and slice objects. Note that the special + interpretation of negative indexes (if the class wishes to emulate a sequence + type) is up to the :meth:`__getitem__` method. If *key* is of an inappropriate + type, :exc:`TypeError` may be raised; if of a value outside the set of indexes + for the sequence (after any special interpretation of negative values), + :exc:`IndexError` should be raised. For mapping types, if *key* is missing (not + in the container), :exc:`KeyError` should be raised. + + .. note:: + + :keyword:`for` loops expect that an :exc:`IndexError` will be raised for illegal + indexes to allow proper detection of the end of the sequence. + + +.. method:: object.__setitem__(self, key, value) + + Called to implement assignment to ``self[key]``. Same note as for + :meth:`__getitem__`. This should only be implemented for mappings if the + objects support changes to the values for keys, or if new keys can be added, or + for sequences if elements can be replaced. The same exceptions should be raised + for improper *key* values as for the :meth:`__getitem__` method. + + +.. method:: object.__delitem__(self, key) + + Called to implement deletion of ``self[key]``. Same note as for + :meth:`__getitem__`. This should only be implemented for mappings if the + objects support removal of keys, or for sequences if elements can be removed + from the sequence. The same exceptions should be raised for improper *key* + values as for the :meth:`__getitem__` method. + + +.. method:: object.__missing__(self, key) + + Called by :class:`dict`\ .\ :meth:`__getitem__` to implement ``self[key]`` for dict subclasses + when key is not in the dictionary. + + +.. method:: object.__iter__(self) + + This method is called when an iterator is required for a container. This method + should return a new iterator object that can iterate over all the objects in the + container. For mappings, it should iterate over the keys of the container. + + Iterator objects also need to implement this method; they are required to return + themselves. For more information on iterator objects, see :ref:`typeiter`. + + +.. method:: object.__reversed__(self) + + Called (if present) by the :func:`reversed` built-in to implement + reverse iteration. It should return a new iterator object that iterates + over all the objects in the container in reverse order. + + If the :meth:`__reversed__` method is not provided, the :func:`reversed` + built-in will fall back to using the sequence protocol (:meth:`__len__` and + :meth:`__getitem__`). Objects that support the sequence protocol should + only provide :meth:`__reversed__` if they can provide an implementation + that is more efficient than the one provided by :func:`reversed`. + + +The membership test operators (:keyword:`in` and :keyword:`not in`) are normally +implemented as an iteration through a sequence. However, container objects can +supply the following special method with a more efficient implementation, which +also does not require the object be a sequence. + +.. method:: object.__contains__(self, item) + + Called to implement membership test operators. Should return true if *item* + is in *self*, false otherwise. For mapping objects, this should consider the + keys of the mapping rather than the values or the key-item pairs. + + For objects that don't define :meth:`__contains__`, the membership test first + tries iteration via :meth:`__iter__`, then the old sequence iteration + protocol via :meth:`__getitem__`, see :ref:`this section in the language + reference `. + + +.. _numeric-types: + +Emulating numeric types +----------------------- + +The following methods can be defined to emulate numeric objects. Methods +corresponding to operations that are not supported by the particular kind of +number implemented (e.g., bitwise operations for non-integral numbers) should be +left undefined. + + +.. method:: object.__add__(self, other) + object.__sub__(self, other) + object.__mul__(self, other) + object.__matmul__(self, other) + object.__truediv__(self, other) + object.__floordiv__(self, other) + object.__mod__(self, other) + object.__divmod__(self, other) + object.__pow__(self, other[, modulo]) + object.__lshift__(self, other) + object.__rshift__(self, other) + object.__and__(self, other) + object.__xor__(self, other) + object.__or__(self, other) + + .. index:: + builtin: divmod + builtin: pow + builtin: pow + + These methods are called to implement the binary arithmetic operations + (``+``, ``-``, ``*``, ``@``, ``/``, ``//``, ``%``, :func:`divmod`, + :func:`pow`, ``**``, ``<<``, ``>>``, ``&``, ``^``, ``|``). For instance, to + evaluate the expression ``x + y``, where *x* is an instance of a class that + has an :meth:`__add__` method, ``x.__add__(y)`` is called. The + :meth:`__divmod__` method should be the equivalent to using + :meth:`__floordiv__` and :meth:`__mod__`; it should not be related to + :meth:`__truediv__`. Note that :meth:`__pow__` should be defined to accept + an optional third argument if the ternary version of the built-in :func:`pow` + function is to be supported. + + If one of those methods does not support the operation with the supplied + arguments, it should return ``NotImplemented``. + + +.. method:: object.__radd__(self, other) + object.__rsub__(self, other) + object.__rmul__(self, other) + object.__rmatmul__(self, other) + object.__rtruediv__(self, other) + object.__rfloordiv__(self, other) + object.__rmod__(self, other) + object.__rdivmod__(self, other) + object.__rpow__(self, other) + object.__rlshift__(self, other) + object.__rrshift__(self, other) + object.__rand__(self, other) + object.__rxor__(self, other) + object.__ror__(self, other) + + .. index:: + builtin: divmod + builtin: pow + + These methods are called to implement the binary arithmetic operations + (``+``, ``-``, ``*``, ``@``, ``/``, ``//``, ``%``, :func:`divmod`, + :func:`pow`, ``**``, ``<<``, ``>>``, ``&``, ``^``, ``|``) with reflected + (swapped) operands. These functions are only called if the left operand does + not support the corresponding operation [#]_ and the operands are of different + types. [#]_ For instance, to evaluate the expression ``x - y``, where *y* is + an instance of a class that has an :meth:`__rsub__` method, ``y.__rsub__(x)`` + is called if ``x.__sub__(y)`` returns *NotImplemented*. + + .. index:: builtin: pow + + Note that ternary :func:`pow` will not try calling :meth:`__rpow__` (the + coercion rules would become too complicated). + + .. note:: + + If the right operand's type is a subclass of the left operand's type and that + subclass provides the reflected method for the operation, this method will be + called before the left operand's non-reflected method. This behavior allows + subclasses to override their ancestors' operations. + + +.. method:: object.__iadd__(self, other) + object.__isub__(self, other) + object.__imul__(self, other) + object.__imatmul__(self, other) + object.__itruediv__(self, other) + object.__ifloordiv__(self, other) + object.__imod__(self, other) + object.__ipow__(self, other[, modulo]) + object.__ilshift__(self, other) + object.__irshift__(self, other) + object.__iand__(self, other) + object.__ixor__(self, other) + object.__ior__(self, other) + + These methods are called to implement the augmented arithmetic assignments + (``+=``, ``-=``, ``*=``, ``@=``, ``/=``, ``//=``, ``%=``, ``**=``, ``<<=``, + ``>>=``, ``&=``, ``^=``, ``|=``). These methods should attempt to do the + operation in-place (modifying *self*) and return the result (which could be, + but does not have to be, *self*). If a specific method is not defined, the + augmented assignment falls back to the normal methods. For instance, if *x* + is an instance of a class with an :meth:`__iadd__` method, ``x += y`` is + equivalent to ``x = x.__iadd__(y)`` . Otherwise, ``x.__add__(y)`` and + ``y.__radd__(x)`` are considered, as with the evaluation of ``x + y``. In + certain situations, augmented assignment can result in unexpected errors (see + :ref:`faq-augmented-assignment-tuple-error`), but this behavior is in fact + part of the data model. + + +.. method:: object.__neg__(self) + object.__pos__(self) + object.__abs__(self) + object.__invert__(self) + + .. index:: builtin: abs + + Called to implement the unary arithmetic operations (``-``, ``+``, :func:`abs` + and ``~``). + + +.. method:: object.__complex__(self) + object.__int__(self) + object.__float__(self) + + .. index:: + builtin: complex + builtin: int + builtin: float + + Called to implement the built-in functions :func:`complex`, + :func:`int` and :func:`float`. Should return a value + of the appropriate type. + + +.. method:: object.__index__(self) + + Called to implement :func:`operator.index`, and whenever Python needs to + losslessly convert the numeric object to an integer object (such as in + slicing, or in the built-in :func:`bin`, :func:`hex` and :func:`oct` + functions). Presence of this method indicates that the numeric object is + an integer type. Must return an integer. + + .. note:: + + In order to have a coherent integer type class, when :meth:`__index__` is + defined :meth:`__int__` should also be defined, and both should return + the same value. + + +.. method:: object.__round__(self, [,ndigits]) + object.__trunc__(self) + object.__floor__(self) + object.__ceil__(self) + + .. index:: builtin: round + + Called to implement the built-in function :func:`round` and :mod:`math` + functions :func:`~math.trunc`, :func:`~math.floor` and :func:`~math.ceil`. + Unless *ndigits* is passed to :meth:`!__round__` all these methods should + return the value of the object truncated to an :class:`~numbers.Integral` + (typically an :class:`int`). + + If :meth:`__int__` is not defined then the built-in function :func:`int` + falls back to :meth:`__trunc__`. + + +.. _context-managers: + +With Statement Context Managers +------------------------------- + +A :dfn:`context manager` is an object that defines the runtime context to be +established when executing a :keyword:`with` statement. The context manager +handles the entry into, and the exit from, the desired runtime context for the +execution of the block of code. Context managers are normally invoked using the +:keyword:`!with` statement (described in section :ref:`with`), but can also be +used by directly invoking their methods. + +.. index:: + statement: with + single: context manager + +Typical uses of context managers include saving and restoring various kinds of +global state, locking and unlocking resources, closing opened files, etc. + +For more information on context managers, see :ref:`typecontextmanager`. + + +.. method:: object.__enter__(self) + + Enter the runtime context related to this object. The :keyword:`with` statement + will bind this method's return value to the target(s) specified in the + :keyword:`!as` clause of the statement, if any. + + +.. method:: object.__exit__(self, exc_type, exc_value, traceback) + + Exit the runtime context related to this object. The parameters describe the + exception that caused the context to be exited. If the context was exited + without an exception, all three arguments will be :const:`None`. + + If an exception is supplied, and the method wishes to suppress the exception + (i.e., prevent it from being propagated), it should return a true value. + Otherwise, the exception will be processed normally upon exit from this method. + + Note that :meth:`__exit__` methods should not reraise the passed-in exception; + this is the caller's responsibility. + + +.. seealso:: + + :pep:`343` - The "with" statement + The specification, background, and examples for the Python :keyword:`with` + statement. + + +.. _special-lookup: + +Special method lookup +--------------------- + +For custom classes, implicit invocations of special methods are only guaranteed +to work correctly if defined on an object's type, not in the object's instance +dictionary. That behaviour is the reason why the following code raises an +exception:: + + >>> class C: + ... pass + ... + >>> c = C() + >>> c.__len__ = lambda: 5 + >>> len(c) + Traceback (most recent call last): + File "", line 1, in + TypeError: object of type 'C' has no len() + +The rationale behind this behaviour lies with a number of special methods such +as :meth:`__hash__` and :meth:`__repr__` that are implemented by all objects, +including type objects. If the implicit lookup of these methods used the +conventional lookup process, they would fail when invoked on the type object +itself:: + + >>> 1 .__hash__() == hash(1) + True + >>> int.__hash__() == hash(int) + Traceback (most recent call last): + File "", line 1, in + TypeError: descriptor '__hash__' of 'int' object needs an argument + +Incorrectly attempting to invoke an unbound method of a class in this way is +sometimes referred to as 'metaclass confusion', and is avoided by bypassing +the instance when looking up special methods:: + + >>> type(1).__hash__(1) == hash(1) + True + >>> type(int).__hash__(int) == hash(int) + True + +In addition to bypassing any instance attributes in the interest of +correctness, implicit special method lookup generally also bypasses the +:meth:`__getattribute__` method even of the object's metaclass:: + + >>> class Meta(type): + ... def __getattribute__(*args): + ... print("Metaclass getattribute invoked") + ... return type.__getattribute__(*args) + ... + >>> class C(object, metaclass=Meta): + ... def __len__(self): + ... return 10 + ... def __getattribute__(*args): + ... print("Class getattribute invoked") + ... return object.__getattribute__(*args) + ... + >>> c = C() + >>> c.__len__() # Explicit lookup via instance + Class getattribute invoked + 10 + >>> type(c).__len__(c) # Explicit lookup via type + Metaclass getattribute invoked + 10 + >>> len(c) # Implicit lookup + 10 + +Bypassing the :meth:`__getattribute__` machinery in this fashion +provides significant scope for speed optimisations within the +interpreter, at the cost of some flexibility in the handling of +special methods (the special method *must* be set on the class +object itself in order to be consistently invoked by the interpreter). + + +.. index:: + single: coroutine + +Coroutines +========== + + +Awaitable Objects +----------------- + +An :term:`awaitable` object generally implements an :meth:`__await__` method. +:term:`Coroutine` objects returned from :keyword:`async def` functions +are awaitable. + +.. note:: + + The :term:`generator iterator` objects returned from generators + decorated with :func:`types.coroutine` or :func:`asyncio.coroutine` + are also awaitable, but they do not implement :meth:`__await__`. + +.. method:: object.__await__(self) + + Must return an :term:`iterator`. Should be used to implement + :term:`awaitable` objects. For instance, :class:`asyncio.Future` implements + this method to be compatible with the :keyword:`await` expression. + +.. versionadded:: 3.5 + +.. seealso:: :pep:`492` for additional information about awaitable objects. + + +.. _coroutine-objects: + +Coroutine Objects +----------------- + +:term:`Coroutine` objects are :term:`awaitable` objects. +A coroutine's execution can be controlled by calling :meth:`__await__` and +iterating over the result. When the coroutine has finished executing and +returns, the iterator raises :exc:`StopIteration`, and the exception's +:attr:`~StopIteration.value` attribute holds the return value. If the +coroutine raises an exception, it is propagated by the iterator. Coroutines +should not directly raise unhandled :exc:`StopIteration` exceptions. + +Coroutines also have the methods listed below, which are analogous to +those of generators (see :ref:`generator-methods`). However, unlike +generators, coroutines do not directly support iteration. + +.. versionchanged:: 3.5.2 + It is a :exc:`RuntimeError` to await on a coroutine more than once. + + +.. method:: coroutine.send(value) + + Starts or resumes execution of the coroutine. If *value* is ``None``, + this is equivalent to advancing the iterator returned by + :meth:`__await__`. If *value* is not ``None``, this method delegates + to the :meth:`~generator.send` method of the iterator that caused + the coroutine to suspend. The result (return value, + :exc:`StopIteration`, or other exception) is the same as when + iterating over the :meth:`__await__` return value, described above. + +.. method:: coroutine.throw(type[, value[, traceback]]) + + Raises the specified exception in the coroutine. This method delegates + to the :meth:`~generator.throw` method of the iterator that caused + the coroutine to suspend, if it has such a method. Otherwise, + the exception is raised at the suspension point. The result + (return value, :exc:`StopIteration`, or other exception) is the same as + when iterating over the :meth:`__await__` return value, described + above. If the exception is not caught in the coroutine, it propagates + back to the caller. + +.. method:: coroutine.close() + + Causes the coroutine to clean itself up and exit. If the coroutine + is suspended, this method first delegates to the :meth:`~generator.close` + method of the iterator that caused the coroutine to suspend, if it + has such a method. Then it raises :exc:`GeneratorExit` at the + suspension point, causing the coroutine to immediately clean itself up. + Finally, the coroutine is marked as having finished executing, even if + it was never started. + + Coroutine objects are automatically closed using the above process when + they are about to be destroyed. + +.. _async-iterators: + +Asynchronous Iterators +---------------------- + +An *asynchronous iterator* can call asynchronous code in +its ``__anext__`` method. + +Asynchronous iterators can be used in an :keyword:`async for` statement. + +.. method:: object.__aiter__(self) + + Must return an *asynchronous iterator* object. + +.. method:: object.__anext__(self) + + Must return an *awaitable* resulting in a next value of the iterator. Should + raise a :exc:`StopAsyncIteration` error when the iteration is over. + +An example of an asynchronous iterable object:: + + class Reader: + async def readline(self): + ... + + def __aiter__(self): + return self + + async def __anext__(self): + val = await self.readline() + if val == b'': + raise StopAsyncIteration + return val + +.. versionadded:: 3.5 + +.. versionchanged:: 3.7 + Prior to Python 3.7, ``__aiter__`` could return an *awaitable* + that would resolve to an + :term:`asynchronous iterator `. + + Starting with Python 3.7, ``__aiter__`` must return an + asynchronous iterator object. Returning anything else + will result in a :exc:`TypeError` error. + + +.. _async-context-managers: + +Asynchronous Context Managers +----------------------------- + +An *asynchronous context manager* is a *context manager* that is able to +suspend execution in its ``__aenter__`` and ``__aexit__`` methods. + +Asynchronous context managers can be used in an :keyword:`async with` statement. + +.. method:: object.__aenter__(self) + + This method is semantically similar to the :meth:`__enter__`, with only + difference that it must return an *awaitable*. + +.. method:: object.__aexit__(self, exc_type, exc_value, traceback) + + This method is semantically similar to the :meth:`__exit__`, with only + difference that it must return an *awaitable*. + +An example of an asynchronous context manager class:: + + class AsyncContextManager: + async def __aenter__(self): + await log('entering context') + + async def __aexit__(self, exc_type, exc, tb): + await log('exiting context') + +.. versionadded:: 3.5 + + +.. rubric:: Footnotes + +.. [#] It *is* possible in some cases to change an object's type, under certain + controlled conditions. It generally isn't a good idea though, since it can + lead to some very strange behaviour if it is handled incorrectly. + +.. [#] The :meth:`__hash__`, :meth:`__iter__`, :meth:`__reversed__`, and + :meth:`__contains__` methods have special handling for this; others + will still raise a :exc:`TypeError`, but may do so by relying on + the behavior that ``None`` is not callable. + +.. [#] "Does not support" here means that the class has no such method, or + the method returns ``NotImplemented``. Do not set the method to + ``None`` if you want to force fallback to the right operand's reflected + method—that will instead have the opposite effect of explicitly + *blocking* such fallback. + +.. [#] For operands of the same type, it is assumed that if the non-reflected method + (such as :meth:`__add__`) fails the operation is not supported, which is why the + reflected method is not called. diff --git a/python-3.7.4-docs-html/_sources/reference/executionmodel.rst.txt b/python-3.7.4-docs-html/_sources/reference/executionmodel.rst.txt new file mode 100644 index 0000000..49cb86b --- /dev/null +++ b/python-3.7.4-docs-html/_sources/reference/executionmodel.rst.txt @@ -0,0 +1,266 @@ + +.. _execmodel: + +*************** +Execution model +*************** + +.. index:: + single: execution model + pair: code; block + +.. _prog_structure: + +Structure of a program +====================== + +.. index:: block + +A Python program is constructed from code blocks. +A :dfn:`block` is a piece of Python program text that is executed as a unit. +The following are blocks: a module, a function body, and a class definition. +Each command typed interactively is a block. A script file (a file given as +standard input to the interpreter or specified as a command line argument to the +interpreter) is a code block. A script command (a command specified on the +interpreter command line with the :option:`-c` option) is a code block. The string +argument passed to the built-in functions :func:`eval` and :func:`exec` is a +code block. + +.. index:: pair: execution; frame + +A code block is executed in an :dfn:`execution frame`. A frame contains some +administrative information (used for debugging) and determines where and how +execution continues after the code block's execution has completed. + +.. _naming: + +Naming and binding +================== + +.. index:: + single: namespace + single: scope + +.. _bind_names: + +Binding of names +---------------- + +.. index:: + single: name + pair: binding; name + +:dfn:`Names` refer to objects. Names are introduced by name binding operations. + +.. index:: single: from; import statement + +The following constructs bind names: formal parameters to functions, +:keyword:`import` statements, class and function definitions (these bind the +class or function name in the defining block), and targets that are identifiers +if occurring in an assignment, :keyword:`for` loop header, or after +:keyword:`!as` in a :keyword:`with` statement or :keyword:`except` clause. +The :keyword:`!import` statement +of the form ``from ... import *`` binds all names defined in the imported +module, except those beginning with an underscore. This form may only be used +at the module level. + +A target occurring in a :keyword:`del` statement is also considered bound for +this purpose (though the actual semantics are to unbind the name). + +Each assignment or import statement occurs within a block defined by a class or +function definition or at the module level (the top-level code block). + +.. index:: pair: free; variable + +If a name is bound in a block, it is a local variable of that block, unless +declared as :keyword:`nonlocal` or :keyword:`global`. If a name is bound at +the module level, it is a global variable. (The variables of the module code +block are local and global.) If a variable is used in a code block but not +defined there, it is a :dfn:`free variable`. + +Each occurrence of a name in the program text refers to the :dfn:`binding` of +that name established by the following name resolution rules. + +.. _resolve_names: + +Resolution of names +------------------- + +.. index:: scope + +A :dfn:`scope` defines the visibility of a name within a block. If a local +variable is defined in a block, its scope includes that block. If the +definition occurs in a function block, the scope extends to any blocks contained +within the defining one, unless a contained block introduces a different binding +for the name. + +.. index:: single: environment + +When a name is used in a code block, it is resolved using the nearest enclosing +scope. The set of all such scopes visible to a code block is called the block's +:dfn:`environment`. + +.. index:: + single: NameError (built-in exception) + single: UnboundLocalError + +When a name is not found at all, a :exc:`NameError` exception is raised. +If the current scope is a function scope, and the name refers to a local +variable that has not yet been bound to a value at the point where the name is +used, an :exc:`UnboundLocalError` exception is raised. +:exc:`UnboundLocalError` is a subclass of :exc:`NameError`. + +If a name binding operation occurs anywhere within a code block, all uses of the +name within the block are treated as references to the current block. This can +lead to errors when a name is used within a block before it is bound. This rule +is subtle. Python lacks declarations and allows name binding operations to +occur anywhere within a code block. The local variables of a code block can be +determined by scanning the entire text of the block for name binding operations. + +If the :keyword:`global` statement occurs within a block, all uses of the name +specified in the statement refer to the binding of that name in the top-level +namespace. Names are resolved in the top-level namespace by searching the +global namespace, i.e. the namespace of the module containing the code block, +and the builtins namespace, the namespace of the module :mod:`builtins`. The +global namespace is searched first. If the name is not found there, the +builtins namespace is searched. The :keyword:`!global` statement must precede +all uses of the name. + +The :keyword:`global` statement has the same scope as a name binding operation +in the same block. If the nearest enclosing scope for a free variable contains +a global statement, the free variable is treated as a global. + +.. XXX say more about "nonlocal" semantics here + +The :keyword:`nonlocal` statement causes corresponding names to refer +to previously bound variables in the nearest enclosing function scope. +:exc:`SyntaxError` is raised at compile time if the given name does not +exist in any enclosing function scope. + +.. index:: module: __main__ + +The namespace for a module is automatically created the first time a module is +imported. The main module for a script is always called :mod:`__main__`. + +Class definition blocks and arguments to :func:`exec` and :func:`eval` are +special in the context of name resolution. +A class definition is an executable statement that may use and define names. +These references follow the normal rules for name resolution with an exception +that unbound local variables are looked up in the global namespace. +The namespace of the class definition becomes the attribute dictionary of +the class. The scope of names defined in a class block is limited to the +class block; it does not extend to the code blocks of methods -- this includes +comprehensions and generator expressions since they are implemented using a +function scope. This means that the following will fail:: + + class A: + a = 42 + b = list(a + i for i in range(10)) + +.. _restrict_exec: + +Builtins and restricted execution +--------------------------------- + +.. index:: pair: restricted; execution + +.. impl-detail:: + + Users should not touch ``__builtins__``; it is strictly an implementation + detail. Users wanting to override values in the builtins namespace should + :keyword:`import` the :mod:`builtins` module and modify its + attributes appropriately. + +The builtins namespace associated with the execution of a code block +is actually found by looking up the name ``__builtins__`` in its +global namespace; this should be a dictionary or a module (in the +latter case the module's dictionary is used). By default, when in the +:mod:`__main__` module, ``__builtins__`` is the built-in module +:mod:`builtins`; when in any other module, ``__builtins__`` is an +alias for the dictionary of the :mod:`builtins` module itself. + + +.. _dynamic-features: + +Interaction with dynamic features +--------------------------------- + +Name resolution of free variables occurs at runtime, not at compile time. +This means that the following code will print 42:: + + i = 10 + def f(): + print(i) + i = 42 + f() + +.. XXX from * also invalid with relative imports (at least currently) + +The :func:`eval` and :func:`exec` functions do not have access to the full +environment for resolving names. Names may be resolved in the local and global +namespaces of the caller. Free variables are not resolved in the nearest +enclosing namespace, but in the global namespace. [#]_ The :func:`exec` and +:func:`eval` functions have optional arguments to override the global and local +namespace. If only one namespace is specified, it is used for both. + + +.. _exceptions: + +Exceptions +========== + +.. index:: single: exception + +.. index:: + single: raise an exception + single: handle an exception + single: exception handler + single: errors + single: error handling + +Exceptions are a means of breaking out of the normal flow of control of a code +block in order to handle errors or other exceptional conditions. An exception +is *raised* at the point where the error is detected; it may be *handled* by the +surrounding code block or by any code block that directly or indirectly invoked +the code block where the error occurred. + +The Python interpreter raises an exception when it detects a run-time error +(such as division by zero). A Python program can also explicitly raise an +exception with the :keyword:`raise` statement. Exception handlers are specified +with the :keyword:`try` ... :keyword:`except` statement. The :keyword:`finally` +clause of such a statement can be used to specify cleanup code which does not +handle the exception, but is executed whether an exception occurred or not in +the preceding code. + +.. index:: single: termination model + +Python uses the "termination" model of error handling: an exception handler can +find out what happened and continue execution at an outer level, but it cannot +repair the cause of the error and retry the failing operation (except by +re-entering the offending piece of code from the top). + +.. index:: single: SystemExit (built-in exception) + +When an exception is not handled at all, the interpreter terminates execution of +the program, or returns to its interactive main loop. In either case, it prints +a stack traceback, except when the exception is :exc:`SystemExit`. + +Exceptions are identified by class instances. The :keyword:`except` clause is +selected depending on the class of the instance: it must reference the class of +the instance or a base class thereof. The instance can be received by the +handler and can carry additional information about the exceptional condition. + +.. note:: + + Exception messages are not part of the Python API. Their contents may change + from one version of Python to the next without warning and should not be + relied on by code which will run under multiple versions of the interpreter. + +See also the description of the :keyword:`try` statement in section :ref:`try` +and :keyword:`raise` statement in section :ref:`raise`. + + +.. rubric:: Footnotes + +.. [#] This limitation occurs because the code that is executed by these operations + is not available at the time the module is compiled. diff --git a/python-3.7.4-docs-html/_sources/reference/expressions.rst.txt b/python-3.7.4-docs-html/_sources/reference/expressions.rst.txt new file mode 100644 index 0000000..990600e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/reference/expressions.rst.txt @@ -0,0 +1,1887 @@ + +.. _expressions: + +*********** +Expressions +*********** + +.. index:: expression, BNF + +This chapter explains the meaning of the elements of expressions in Python. + +**Syntax Notes:** In this and the following chapters, extended BNF notation will +be used to describe syntax, not lexical analysis. When (one alternative of) a +syntax rule has the form + +.. productionlist:: * + name: `othername` + +and no semantics are given, the semantics of this form of ``name`` are the same +as for ``othername``. + + +.. _conversions: + +Arithmetic conversions +====================== + +.. index:: pair: arithmetic; conversion + +When a description of an arithmetic operator below uses the phrase "the numeric +arguments are converted to a common type," this means that the operator +implementation for built-in types works as follows: + +* If either argument is a complex number, the other is converted to complex; + +* otherwise, if either argument is a floating point number, the other is + converted to floating point; + +* otherwise, both must be integers and no conversion is necessary. + +Some additional rules apply for certain operators (e.g., a string as a left +argument to the '%' operator). Extensions must define their own conversion +behavior. + + +.. _atoms: + +Atoms +===== + +.. index:: atom + +Atoms are the most basic elements of expressions. The simplest atoms are +identifiers or literals. Forms enclosed in parentheses, brackets or braces are +also categorized syntactically as atoms. The syntax for atoms is: + +.. productionlist:: + atom: `identifier` | `literal` | `enclosure` + enclosure: `parenth_form` | `list_display` | `dict_display` | `set_display` + : | `generator_expression` | `yield_atom` + + +.. _atom-identifiers: + +Identifiers (Names) +------------------- + +.. index:: name, identifier + +An identifier occurring as an atom is a name. See section :ref:`identifiers` +for lexical definition and section :ref:`naming` for documentation of naming and +binding. + +.. index:: exception: NameError + +When the name is bound to an object, evaluation of the atom yields that object. +When a name is not bound, an attempt to evaluate it raises a :exc:`NameError` +exception. + +.. index:: + pair: name; mangling + pair: private; names + +**Private name mangling:** When an identifier that textually occurs in a class +definition begins with two or more underscore characters and does not end in two +or more underscores, it is considered a :dfn:`private name` of that class. +Private names are transformed to a longer form before code is generated for +them. The transformation inserts the class name, with leading underscores +removed and a single underscore inserted, in front of the name. For example, +the identifier ``__spam`` occurring in a class named ``Ham`` will be transformed +to ``_Ham__spam``. This transformation is independent of the syntactical +context in which the identifier is used. If the transformed name is extremely +long (longer than 255 characters), implementation defined truncation may happen. +If the class name consists only of underscores, no transformation is done. + + +.. _atom-literals: + +Literals +-------- + +.. index:: single: literal + +Python supports string and bytes literals and various numeric literals: + +.. productionlist:: + literal: `stringliteral` | `bytesliteral` + : | `integer` | `floatnumber` | `imagnumber` + +Evaluation of a literal yields an object of the given type (string, bytes, +integer, floating point number, complex number) with the given value. The value +may be approximated in the case of floating point and imaginary (complex) +literals. See section :ref:`literals` for details. + +.. index:: + triple: immutable; data; type + pair: immutable; object + +All literals correspond to immutable data types, and hence the object's identity +is less important than its value. Multiple evaluations of literals with the +same value (either the same occurrence in the program text or a different +occurrence) may obtain the same object or a different object with the same +value. + + +.. _parenthesized: + +Parenthesized forms +------------------- + +.. index:: + single: parenthesized form + single: () (parentheses); tuple display + +A parenthesized form is an optional expression list enclosed in parentheses: + +.. productionlist:: + parenth_form: "(" [`starred_expression`] ")" + +A parenthesized expression list yields whatever that expression list yields: if +the list contains at least one comma, it yields a tuple; otherwise, it yields +the single expression that makes up the expression list. + +.. index:: pair: empty; tuple + +An empty pair of parentheses yields an empty tuple object. Since tuples are +immutable, the same rules as for literals apply (i.e., two occurrences of the empty +tuple may or may not yield the same object). + +.. index:: + single: comma; tuple display + pair: tuple; display + single: , (comma); tuple display + +Note that tuples are not formed by the parentheses, but rather by use of the +comma operator. The exception is the empty tuple, for which parentheses *are* +required --- allowing unparenthesized "nothing" in expressions would cause +ambiguities and allow common typos to pass uncaught. + + +.. _comprehensions: + +Displays for lists, sets and dictionaries +----------------------------------------- + +For constructing a list, a set or a dictionary Python provides special syntax +called "displays", each of them in two flavors: + +* either the container contents are listed explicitly, or + +* they are computed via a set of looping and filtering instructions, called a + :dfn:`comprehension`. + +.. index:: + single: for; in comprehensions + single: if; in comprehensions + single: async for; in comprehensions + +Common syntax elements for comprehensions are: + +.. productionlist:: + comprehension: `expression` `comp_for` + comp_for: ["async"] "for" `target_list` "in" `or_test` [`comp_iter`] + comp_iter: `comp_for` | `comp_if` + comp_if: "if" `expression_nocond` [`comp_iter`] + +The comprehension consists of a single expression followed by at least one +:keyword:`!for` clause and zero or more :keyword:`!for` or :keyword:`!if` clauses. +In this case, the elements of the new container are those that would be produced +by considering each of the :keyword:`!for` or :keyword:`!if` clauses a block, +nesting from left to right, and evaluating the expression to produce an element +each time the innermost block is reached. + +However, aside from the iterable expression in the leftmost :keyword:`!for` clause, +the comprehension is executed in a separate implicitly nested scope. This ensures +that names assigned to in the target list don't "leak" into the enclosing scope. + +The iterable expression in the leftmost :keyword:`!for` clause is evaluated +directly in the enclosing scope and then passed as an argument to the implictly +nested scope. Subsequent :keyword:`!for` clauses and any filter condition in the +leftmost :keyword:`!for` clause cannot be evaluated in the enclosing scope as +they may depend on the values obtained from the leftmost iterable. For example: +``[x*y for x in range(10) for y in range(x, x+10)]``. + +To ensure the comprehension always results in a container of the appropriate +type, ``yield`` and ``yield from`` expressions are prohibited in the implicitly +nested scope (in Python 3.7, such expressions emit :exc:`DeprecationWarning` +when compiled, in Python 3.8+ they will emit :exc:`SyntaxError`). + +.. index:: + single: await; in comprehensions + +Since Python 3.6, in an :keyword:`async def` function, an :keyword:`!async for` +clause may be used to iterate over a :term:`asynchronous iterator`. +A comprehension in an :keyword:`!async def` function may consist of either a +:keyword:`!for` or :keyword:`!async for` clause following the leading +expression, may contain additional :keyword:`!for` or :keyword:`!async for` +clauses, and may also use :keyword:`await` expressions. +If a comprehension contains either :keyword:`!async for` clauses +or :keyword:`!await` expressions it is called an +:dfn:`asynchronous comprehension`. An asynchronous comprehension may +suspend the execution of the coroutine function in which it appears. +See also :pep:`530`. + +.. versionadded:: 3.6 + Asynchronous comprehensions were introduced. + +.. deprecated:: 3.7 + ``yield`` and ``yield from`` deprecated in the implicitly nested scope. + + +.. _lists: + +List displays +------------- + +.. index:: + pair: list; display + pair: list; comprehensions + pair: empty; list + object: list + single: [] (square brackets); list expression + single: , (comma); expression list + +A list display is a possibly empty series of expressions enclosed in square +brackets: + +.. productionlist:: + list_display: "[" [`starred_list` | `comprehension`] "]" + +A list display yields a new list object, the contents being specified by either +a list of expressions or a comprehension. When a comma-separated list of +expressions is supplied, its elements are evaluated from left to right and +placed into the list object in that order. When a comprehension is supplied, +the list is constructed from the elements resulting from the comprehension. + + +.. _set: + +Set displays +------------ + +.. index:: + pair: set; display + object: set + single: {} (curly brackets); set expression + single: , (comma); expression list + +A set display is denoted by curly braces and distinguishable from dictionary +displays by the lack of colons separating keys and values: + +.. productionlist:: + set_display: "{" (`starred_list` | `comprehension`) "}" + +A set display yields a new mutable set object, the contents being specified by +either a sequence of expressions or a comprehension. When a comma-separated +list of expressions is supplied, its elements are evaluated from left to right +and added to the set object. When a comprehension is supplied, the set is +constructed from the elements resulting from the comprehension. + +An empty set cannot be constructed with ``{}``; this literal constructs an empty +dictionary. + + +.. _dict: + +Dictionary displays +------------------- + +.. index:: + pair: dictionary; display + key, datum, key/datum pair + object: dictionary + single: {} (curly brackets); dictionary expression + single: : (colon); in dictionary expressions + single: , (comma); in dictionary displays + +A dictionary display is a possibly empty series of key/datum pairs enclosed in +curly braces: + +.. productionlist:: + dict_display: "{" [`key_datum_list` | `dict_comprehension`] "}" + key_datum_list: `key_datum` ("," `key_datum`)* [","] + key_datum: `expression` ":" `expression` | "**" `or_expr` + dict_comprehension: `expression` ":" `expression` `comp_for` + +A dictionary display yields a new dictionary object. + +If a comma-separated sequence of key/datum pairs is given, they are evaluated +from left to right to define the entries of the dictionary: each key object is +used as a key into the dictionary to store the corresponding datum. This means +that you can specify the same key multiple times in the key/datum list, and the +final dictionary's value for that key will be the last one given. + +.. index:: + unpacking; dictionary + single: **; in dictionary displays + +A double asterisk ``**`` denotes :dfn:`dictionary unpacking`. +Its operand must be a :term:`mapping`. Each mapping item is added +to the new dictionary. Later values replace values already set by +earlier key/datum pairs and earlier dictionary unpackings. + +.. versionadded:: 3.5 + Unpacking into dictionary displays, originally proposed by :pep:`448`. + +A dict comprehension, in contrast to list and set comprehensions, needs two +expressions separated with a colon followed by the usual "for" and "if" clauses. +When the comprehension is run, the resulting key and value elements are inserted +in the new dictionary in the order they are produced. + +.. index:: pair: immutable; object + hashable + +Restrictions on the types of the key values are listed earlier in section +:ref:`types`. (To summarize, the key type should be :term:`hashable`, which excludes +all mutable objects.) Clashes between duplicate keys are not detected; the last +datum (textually rightmost in the display) stored for a given key value +prevails. + + +.. _genexpr: + +Generator expressions +--------------------- + +.. index:: + pair: generator; expression + object: generator + single: () (parentheses); generator expression + +A generator expression is a compact generator notation in parentheses: + +.. productionlist:: + generator_expression: "(" `expression` `comp_for` ")" + +A generator expression yields a new generator object. Its syntax is the same as +for comprehensions, except that it is enclosed in parentheses instead of +brackets or curly braces. + +Variables used in the generator expression are evaluated lazily when the +:meth:`~generator.__next__` method is called for the generator object (in the same +fashion as normal generators). However, the iterable expression in the +leftmost :keyword:`!for` clause is immediately evaluated, so that an error +produced by it will be emitted at the point where the generator expression +is defined, rather than at the point where the first value is retrieved. +Subsequent :keyword:`!for` clauses and any filter condition in the leftmost +:keyword:`!for` clause cannot be evaluated in the enclosing scope as they may +depend on the values obtained from the leftmost iterable. For example: +``(x*y for x in range(10) for y in range(x, x+10))``. + +The parentheses can be omitted on calls with only one argument. See section +:ref:`calls` for details. + +To avoid interfering with the expected operation of the generator expression +itself, ``yield`` and ``yield from`` expressions are prohibited in the +implicitly defined generator (in Python 3.7, such expressions emit +:exc:`DeprecationWarning` when compiled, in Python 3.8+ they will emit +:exc:`SyntaxError`). + +If a generator expression contains either :keyword:`!async for` +clauses or :keyword:`await` expressions it is called an +:dfn:`asynchronous generator expression`. An asynchronous generator +expression returns a new asynchronous generator object, +which is an asynchronous iterator (see :ref:`async-iterators`). + +.. versionadded:: 3.6 + Asynchronous generator expressions were introduced. + +.. versionchanged:: 3.7 + Prior to Python 3.7, asynchronous generator expressions could + only appear in :keyword:`async def` coroutines. Starting + with 3.7, any function can use asynchronous generator expressions. + +.. deprecated:: 3.7 + ``yield`` and ``yield from`` deprecated in the implicitly nested scope. + + +.. _yieldexpr: + +Yield expressions +----------------- + +.. index:: + keyword: yield + keyword: from + pair: yield; expression + pair: generator; function + +.. productionlist:: + yield_atom: "(" `yield_expression` ")" + yield_expression: "yield" [`expression_list` | "from" `expression`] + +The yield expression is used when defining a :term:`generator` function +or an :term:`asynchronous generator` function and +thus can only be used in the body of a function definition. Using a yield +expression in a function's body causes that function to be a generator, +and using it in an :keyword:`async def` function's body causes that +coroutine function to be an asynchronous generator. For example:: + + def gen(): # defines a generator function + yield 123 + + async def agen(): # defines an asynchronous generator function + yield 123 + +Due to their side effects on the containing scope, ``yield`` expressions +are not permitted as part of the implicitly defined scopes used to +implement comprehensions and generator expressions (in Python 3.7, such +expressions emit :exc:`DeprecationWarning` when compiled, in Python 3.8+ +they will emit :exc:`SyntaxError`).. + +.. deprecated:: 3.7 + Yield expressions deprecated in the implicitly nested scopes used to + implement comprehensions and generator expressions. + +Generator functions are described below, while asynchronous generator +functions are described separately in section +:ref:`asynchronous-generator-functions`. + +When a generator function is called, it returns an iterator known as a +generator. That generator then controls the execution of the generator function. +The execution starts when one of the generator's methods is called. At that +time, the execution proceeds to the first yield expression, where it is +suspended again, returning the value of :token:`expression_list` to the generator's +caller. By suspended, we mean that all local state is retained, including the +current bindings of local variables, the instruction pointer, the internal +evaluation stack, and the state of any exception handling. When the execution +is resumed by calling one of the +generator's methods, the function can proceed exactly as if the yield expression +were just another external call. The value of the yield expression after +resuming depends on the method which resumed the execution. If +:meth:`~generator.__next__` is used (typically via either a :keyword:`for` or +the :func:`next` builtin) then the result is :const:`None`. Otherwise, if +:meth:`~generator.send` is used, then the result will be the value passed in to +that method. + +.. index:: single: coroutine + +All of this makes generator functions quite similar to coroutines; they yield +multiple times, they have more than one entry point and their execution can be +suspended. The only difference is that a generator function cannot control +where the execution should continue after it yields; the control is always +transferred to the generator's caller. + +Yield expressions are allowed anywhere in a :keyword:`try` construct. If the +generator is not resumed before it is +finalized (by reaching a zero reference count or by being garbage collected), +the generator-iterator's :meth:`~generator.close` method will be called, +allowing any pending :keyword:`finally` clauses to execute. + +.. index:: + single: from; yield from expression + +When ``yield from `` is used, it treats the supplied expression as +a subiterator. All values produced by that subiterator are passed directly +to the caller of the current generator's methods. Any values passed in with +:meth:`~generator.send` and any exceptions passed in with +:meth:`~generator.throw` are passed to the underlying iterator if it has the +appropriate methods. If this is not the case, then :meth:`~generator.send` +will raise :exc:`AttributeError` or :exc:`TypeError`, while +:meth:`~generator.throw` will just raise the passed in exception immediately. + +When the underlying iterator is complete, the :attr:`~StopIteration.value` +attribute of the raised :exc:`StopIteration` instance becomes the value of +the yield expression. It can be either set explicitly when raising +:exc:`StopIteration`, or automatically when the subiterator is a generator +(by returning a value from the subgenerator). + + .. versionchanged:: 3.3 + Added ``yield from `` to delegate control flow to a subiterator. + +The parentheses may be omitted when the yield expression is the sole expression +on the right hand side of an assignment statement. + +.. seealso:: + + :pep:`255` - Simple Generators + The proposal for adding generators and the :keyword:`yield` statement to Python. + + :pep:`342` - Coroutines via Enhanced Generators + The proposal to enhance the API and syntax of generators, making them + usable as simple coroutines. + + :pep:`380` - Syntax for Delegating to a Subgenerator + The proposal to introduce the :token:`yield_from` syntax, making delegation + to subgenerators easy. + + :pep:`525` - Asynchronous Generators + The proposal that expanded on :pep:`492` by adding generator capabilities to + coroutine functions. + +.. index:: object: generator +.. _generator-methods: + +Generator-iterator methods +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This subsection describes the methods of a generator iterator. They can +be used to control the execution of a generator function. + +Note that calling any of the generator methods below when the generator +is already executing raises a :exc:`ValueError` exception. + +.. index:: exception: StopIteration + + +.. method:: generator.__next__() + + Starts the execution of a generator function or resumes it at the last + executed yield expression. When a generator function is resumed with a + :meth:`~generator.__next__` method, the current yield expression always + evaluates to :const:`None`. The execution then continues to the next yield + expression, where the generator is suspended again, and the value of the + :token:`expression_list` is returned to :meth:`__next__`'s caller. If the + generator exits without yielding another value, a :exc:`StopIteration` + exception is raised. + + This method is normally called implicitly, e.g. by a :keyword:`for` loop, or + by the built-in :func:`next` function. + + +.. method:: generator.send(value) + + Resumes the execution and "sends" a value into the generator function. The + *value* argument becomes the result of the current yield expression. The + :meth:`send` method returns the next value yielded by the generator, or + raises :exc:`StopIteration` if the generator exits without yielding another + value. When :meth:`send` is called to start the generator, it must be called + with :const:`None` as the argument, because there is no yield expression that + could receive the value. + + +.. method:: generator.throw(type[, value[, traceback]]) + + Raises an exception of type ``type`` at the point where the generator was paused, + and returns the next value yielded by the generator function. If the generator + exits without yielding another value, a :exc:`StopIteration` exception is + raised. If the generator function does not catch the passed-in exception, or + raises a different exception, then that exception propagates to the caller. + +.. index:: exception: GeneratorExit + + +.. method:: generator.close() + + Raises a :exc:`GeneratorExit` at the point where the generator function was + paused. If the generator function then exits gracefully, is already closed, + or raises :exc:`GeneratorExit` (by not catching the exception), close + returns to its caller. If the generator yields a value, a + :exc:`RuntimeError` is raised. If the generator raises any other exception, + it is propagated to the caller. :meth:`close` does nothing if the generator + has already exited due to an exception or normal exit. + +.. index:: single: yield; examples + +Examples +^^^^^^^^ + +Here is a simple example that demonstrates the behavior of generators and +generator functions:: + + >>> def echo(value=None): + ... print("Execution starts when 'next()' is called for the first time.") + ... try: + ... while True: + ... try: + ... value = (yield value) + ... except Exception as e: + ... value = e + ... finally: + ... print("Don't forget to clean up when 'close()' is called.") + ... + >>> generator = echo(1) + >>> print(next(generator)) + Execution starts when 'next()' is called for the first time. + 1 + >>> print(next(generator)) + None + >>> print(generator.send(2)) + 2 + >>> generator.throw(TypeError, "spam") + TypeError('spam',) + >>> generator.close() + Don't forget to clean up when 'close()' is called. + +For examples using ``yield from``, see :ref:`pep-380` in "What's New in +Python." + +.. _asynchronous-generator-functions: + +Asynchronous generator functions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The presence of a yield expression in a function or method defined using +:keyword:`async def` further defines the function as an +:term:`asynchronous generator` function. + +When an asynchronous generator function is called, it returns an +asynchronous iterator known as an asynchronous generator object. +That object then controls the execution of the generator function. +An asynchronous generator object is typically used in an +:keyword:`async for` statement in a coroutine function analogously to +how a generator object would be used in a :keyword:`for` statement. + +Calling one of the asynchronous generator's methods returns an +:term:`awaitable` object, and the execution starts when this object +is awaited on. At that time, the execution proceeds to the first yield +expression, where it is suspended again, returning the value of +:token:`expression_list` to the awaiting coroutine. As with a generator, +suspension means that all local state is retained, including the +current bindings of local variables, the instruction pointer, the internal +evaluation stack, and the state of any exception handling. When the execution +is resumed by awaiting on the next object returned by the asynchronous +generator's methods, the function can proceed exactly as if the yield +expression were just another external call. The value of the yield expression +after resuming depends on the method which resumed the execution. If +:meth:`~agen.__anext__` is used then the result is :const:`None`. Otherwise, if +:meth:`~agen.asend` is used, then the result will be the value passed in to +that method. + +In an asynchronous generator function, yield expressions are allowed anywhere +in a :keyword:`try` construct. However, if an asynchronous generator is not +resumed before it is finalized (by reaching a zero reference count or by +being garbage collected), then a yield expression within a :keyword:`!try` +construct could result in a failure to execute pending :keyword:`finally` +clauses. In this case, it is the responsibility of the event loop or +scheduler running the asynchronous generator to call the asynchronous +generator-iterator's :meth:`~agen.aclose` method and run the resulting +coroutine object, thus allowing any pending :keyword:`!finally` clauses +to execute. + +To take care of finalization, an event loop should define +a *finalizer* function which takes an asynchronous generator-iterator +and presumably calls :meth:`~agen.aclose` and executes the coroutine. +This *finalizer* may be registered by calling :func:`sys.set_asyncgen_hooks`. +When first iterated over, an asynchronous generator-iterator will store the +registered *finalizer* to be called upon finalization. For a reference example +of a *finalizer* method see the implementation of +``asyncio.Loop.shutdown_asyncgens`` in :source:`Lib/asyncio/base_events.py`. + +The expression ``yield from `` is a syntax error when used in an +asynchronous generator function. + +.. index:: object: asynchronous-generator +.. _asynchronous-generator-methods: + +Asynchronous generator-iterator methods +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This subsection describes the methods of an asynchronous generator iterator, +which are used to control the execution of a generator function. + + +.. index:: exception: StopAsyncIteration + +.. coroutinemethod:: agen.__anext__() + + Returns an awaitable which when run starts to execute the asynchronous + generator or resumes it at the last executed yield expression. When an + asynchronous generator function is resumed with an :meth:`~agen.__anext__` + method, the current yield expression always evaluates to :const:`None` in + the returned awaitable, which when run will continue to the next yield + expression. The value of the :token:`expression_list` of the yield + expression is the value of the :exc:`StopIteration` exception raised by + the completing coroutine. If the asynchronous generator exits without + yielding another value, the awaitable instead raises a + :exc:`StopAsyncIteration` exception, signalling that the asynchronous + iteration has completed. + + This method is normally called implicitly by a :keyword:`async for` loop. + + +.. coroutinemethod:: agen.asend(value) + + Returns an awaitable which when run resumes the execution of the + asynchronous generator. As with the :meth:`~generator.send()` method for a + generator, this "sends" a value into the asynchronous generator function, + and the *value* argument becomes the result of the current yield expression. + The awaitable returned by the :meth:`asend` method will return the next + value yielded by the generator as the value of the raised + :exc:`StopIteration`, or raises :exc:`StopAsyncIteration` if the + asynchronous generator exits without yielding another value. When + :meth:`asend` is called to start the asynchronous + generator, it must be called with :const:`None` as the argument, + because there is no yield expression that could receive the value. + + +.. coroutinemethod:: agen.athrow(type[, value[, traceback]]) + + Returns an awaitable that raises an exception of type ``type`` at the point + where the asynchronous generator was paused, and returns the next value + yielded by the generator function as the value of the raised + :exc:`StopIteration` exception. If the asynchronous generator exits + without yielding another value, a :exc:`StopAsyncIteration` exception is + raised by the awaitable. + If the generator function does not catch the passed-in exception, or + raises a different exception, then when the awaitable is run that exception + propagates to the caller of the awaitable. + +.. index:: exception: GeneratorExit + + +.. coroutinemethod:: agen.aclose() + + Returns an awaitable that when run will throw a :exc:`GeneratorExit` into + the asynchronous generator function at the point where it was paused. + If the asynchronous generator function then exits gracefully, is already + closed, or raises :exc:`GeneratorExit` (by not catching the exception), + then the returned awaitable will raise a :exc:`StopIteration` exception. + Any further awaitables returned by subsequent calls to the asynchronous + generator will raise a :exc:`StopAsyncIteration` exception. If the + asynchronous generator yields a value, a :exc:`RuntimeError` is raised + by the awaitable. If the asynchronous generator raises any other exception, + it is propagated to the caller of the awaitable. If the asynchronous + generator has already exited due to an exception or normal exit, then + further calls to :meth:`aclose` will return an awaitable that does nothing. + +.. _primaries: + +Primaries +========= + +.. index:: single: primary + +Primaries represent the most tightly bound operations of the language. Their +syntax is: + +.. productionlist:: + primary: `atom` | `attributeref` | `subscription` | `slicing` | `call` + + +.. _attribute-references: + +Attribute references +-------------------- + +.. index:: + pair: attribute; reference + single: . (dot); attribute reference + +An attribute reference is a primary followed by a period and a name: + +.. productionlist:: + attributeref: `primary` "." `identifier` + +.. index:: + exception: AttributeError + object: module + object: list + +The primary must evaluate to an object of a type that supports attribute +references, which most objects do. This object is then asked to produce the +attribute whose name is the identifier. This production can be customized by +overriding the :meth:`__getattr__` method. If this attribute is not available, +the exception :exc:`AttributeError` is raised. Otherwise, the type and value of +the object produced is determined by the object. Multiple evaluations of the +same attribute reference may yield different objects. + + +.. _subscriptions: + +Subscriptions +------------- + +.. index:: + single: subscription + single: [] (square brackets); subscription + +.. index:: + object: sequence + object: mapping + object: string + object: tuple + object: list + object: dictionary + pair: sequence; item + +A subscription selects an item of a sequence (string, tuple or list) or mapping +(dictionary) object: + +.. productionlist:: + subscription: `primary` "[" `expression_list` "]" + +The primary must evaluate to an object that supports subscription (lists or +dictionaries for example). User-defined objects can support subscription by +defining a :meth:`__getitem__` method. + +For built-in objects, there are two types of objects that support subscription: + +If the primary is a mapping, the expression list must evaluate to an object +whose value is one of the keys of the mapping, and the subscription selects the +value in the mapping that corresponds to that key. (The expression list is a +tuple except if it has exactly one item.) + +If the primary is a sequence, the expression list must evaluate to an integer +or a slice (as discussed in the following section). + +The formal syntax makes no special provision for negative indices in +sequences; however, built-in sequences all provide a :meth:`__getitem__` +method that interprets negative indices by adding the length of the sequence +to the index (so that ``x[-1]`` selects the last item of ``x``). The +resulting value must be a nonnegative integer less than the number of items in +the sequence, and the subscription selects the item whose index is that value +(counting from zero). Since the support for negative indices and slicing +occurs in the object's :meth:`__getitem__` method, subclasses overriding +this method will need to explicitly add that support. + +.. index:: + single: character + pair: string; item + +A string's items are characters. A character is not a separate data type but a +string of exactly one character. + + +.. _slicings: + +Slicings +-------- + +.. index:: + single: slicing + single: slice + single: : (colon); slicing + single: , (comma); slicing + +.. index:: + object: sequence + object: string + object: tuple + object: list + +A slicing selects a range of items in a sequence object (e.g., a string, tuple +or list). Slicings may be used as expressions or as targets in assignment or +:keyword:`del` statements. The syntax for a slicing: + +.. productionlist:: + slicing: `primary` "[" `slice_list` "]" + slice_list: `slice_item` ("," `slice_item`)* [","] + slice_item: `expression` | `proper_slice` + proper_slice: [`lower_bound`] ":" [`upper_bound`] [ ":" [`stride`] ] + lower_bound: `expression` + upper_bound: `expression` + stride: `expression` + +There is ambiguity in the formal syntax here: anything that looks like an +expression list also looks like a slice list, so any subscription can be +interpreted as a slicing. Rather than further complicating the syntax, this is +disambiguated by defining that in this case the interpretation as a subscription +takes priority over the interpretation as a slicing (this is the case if the +slice list contains no proper slice). + +.. index:: + single: start (slice object attribute) + single: stop (slice object attribute) + single: step (slice object attribute) + +The semantics for a slicing are as follows. The primary is indexed (using the +same :meth:`__getitem__` method as +normal subscription) with a key that is constructed from the slice list, as +follows. If the slice list contains at least one comma, the key is a tuple +containing the conversion of the slice items; otherwise, the conversion of the +lone slice item is the key. The conversion of a slice item that is an +expression is that expression. The conversion of a proper slice is a slice +object (see section :ref:`types`) whose :attr:`~slice.start`, +:attr:`~slice.stop` and :attr:`~slice.step` attributes are the values of the +expressions given as lower bound, upper bound and stride, respectively, +substituting ``None`` for missing expressions. + + +.. index:: + object: callable + single: call + single: argument; call semantics + single: () (parentheses); call + single: , (comma); argument list + single: = (equals); in function calls + +.. _calls: + +Calls +----- + +A call calls a callable object (e.g., a :term:`function`) with a possibly empty +series of :term:`arguments `: + +.. productionlist:: + call: `primary` "(" [`argument_list` [","] | `comprehension`] ")" + argument_list: `positional_arguments` ["," `starred_and_keywords`] + : ["," `keywords_arguments`] + : | `starred_and_keywords` ["," `keywords_arguments`] + : | `keywords_arguments` + positional_arguments: ["*"] `expression` ("," ["*"] `expression`)* + starred_and_keywords: ("*" `expression` | `keyword_item`) + : ("," "*" `expression` | "," `keyword_item`)* + keywords_arguments: (`keyword_item` | "**" `expression`) + : ("," `keyword_item` | "," "**" `expression`)* + keyword_item: `identifier` "=" `expression` + +An optional trailing comma may be present after the positional and keyword arguments +but does not affect the semantics. + +.. index:: + single: parameter; call semantics + +The primary must evaluate to a callable object (user-defined functions, built-in +functions, methods of built-in objects, class objects, methods of class +instances, and all objects having a :meth:`__call__` method are callable). All +argument expressions are evaluated before the call is attempted. Please refer +to section :ref:`function` for the syntax of formal :term:`parameter` lists. + +.. XXX update with kwonly args PEP + +If keyword arguments are present, they are first converted to positional +arguments, as follows. First, a list of unfilled slots is created for the +formal parameters. If there are N positional arguments, they are placed in the +first N slots. Next, for each keyword argument, the identifier is used to +determine the corresponding slot (if the identifier is the same as the first +formal parameter name, the first slot is used, and so on). If the slot is +already filled, a :exc:`TypeError` exception is raised. Otherwise, the value of +the argument is placed in the slot, filling it (even if the expression is +``None``, it fills the slot). When all arguments have been processed, the slots +that are still unfilled are filled with the corresponding default value from the +function definition. (Default values are calculated, once, when the function is +defined; thus, a mutable object such as a list or dictionary used as default +value will be shared by all calls that don't specify an argument value for the +corresponding slot; this should usually be avoided.) If there are any unfilled +slots for which no default value is specified, a :exc:`TypeError` exception is +raised. Otherwise, the list of filled slots is used as the argument list for +the call. + +.. impl-detail:: + + An implementation may provide built-in functions whose positional parameters + do not have names, even if they are 'named' for the purpose of documentation, + and which therefore cannot be supplied by keyword. In CPython, this is the + case for functions implemented in C that use :c:func:`PyArg_ParseTuple` to + parse their arguments. + +If there are more positional arguments than there are formal parameter slots, a +:exc:`TypeError` exception is raised, unless a formal parameter using the syntax +``*identifier`` is present; in this case, that formal parameter receives a tuple +containing the excess positional arguments (or an empty tuple if there were no +excess positional arguments). + +If any keyword argument does not correspond to a formal parameter name, a +:exc:`TypeError` exception is raised, unless a formal parameter using the syntax +``**identifier`` is present; in this case, that formal parameter receives a +dictionary containing the excess keyword arguments (using the keywords as keys +and the argument values as corresponding values), or a (new) empty dictionary if +there were no excess keyword arguments. + +.. index:: + single: * (asterisk); in function calls + single: unpacking; in function calls + +If the syntax ``*expression`` appears in the function call, ``expression`` must +evaluate to an :term:`iterable`. Elements from these iterables are +treated as if they were additional positional arguments. For the call +``f(x1, x2, *y, x3, x4)``, if *y* evaluates to a sequence *y1*, ..., *yM*, +this is equivalent to a call with M+4 positional arguments *x1*, *x2*, +*y1*, ..., *yM*, *x3*, *x4*. + +A consequence of this is that although the ``*expression`` syntax may appear +*after* explicit keyword arguments, it is processed *before* the +keyword arguments (and any ``**expression`` arguments -- see below). So:: + + >>> def f(a, b): + ... print(a, b) + ... + >>> f(b=1, *(2,)) + 2 1 + >>> f(a=1, *(2,)) + Traceback (most recent call last): + File "", line 1, in + TypeError: f() got multiple values for keyword argument 'a' + >>> f(1, *(2,)) + 1 2 + +It is unusual for both keyword arguments and the ``*expression`` syntax to be +used in the same call, so in practice this confusion does not arise. + +.. index:: + single: **; in function calls + +If the syntax ``**expression`` appears in the function call, ``expression`` must +evaluate to a :term:`mapping`, the contents of which are treated as +additional keyword arguments. If a keyword is already present +(as an explicit keyword argument, or from another unpacking), +a :exc:`TypeError` exception is raised. + +Formal parameters using the syntax ``*identifier`` or ``**identifier`` cannot be +used as positional argument slots or as keyword argument names. + +.. versionchanged:: 3.5 + Function calls accept any number of ``*`` and ``**`` unpackings, + positional arguments may follow iterable unpackings (``*``), + and keyword arguments may follow dictionary unpackings (``**``). + Originally proposed by :pep:`448`. + +A call always returns some value, possibly ``None``, unless it raises an +exception. How this value is computed depends on the type of the callable +object. + +If it is--- + +a user-defined function: + .. index:: + pair: function; call + triple: user-defined; function; call + object: user-defined function + object: function + + The code block for the function is executed, passing it the argument list. The + first thing the code block will do is bind the formal parameters to the + arguments; this is described in section :ref:`function`. When the code block + executes a :keyword:`return` statement, this specifies the return value of the + function call. + +a built-in function or method: + .. index:: + pair: function; call + pair: built-in function; call + pair: method; call + pair: built-in method; call + object: built-in method + object: built-in function + object: method + object: function + + The result is up to the interpreter; see :ref:`built-in-funcs` for the + descriptions of built-in functions and methods. + +a class object: + .. index:: + object: class + pair: class object; call + + A new instance of that class is returned. + +a class instance method: + .. index:: + object: class instance + object: instance + pair: class instance; call + + The corresponding user-defined function is called, with an argument list that is + one longer than the argument list of the call: the instance becomes the first + argument. + +a class instance: + .. index:: + pair: instance; call + single: __call__() (object method) + + The class must define a :meth:`__call__` method; the effect is then the same as + if that method was called. + + +.. index:: keyword: await +.. _await: + +Await expression +================ + +Suspend the execution of :term:`coroutine` on an :term:`awaitable` object. +Can only be used inside a :term:`coroutine function`. + +.. productionlist:: + await_expr: "await" `primary` + +.. versionadded:: 3.5 + + +.. _power: + +The power operator +================== + +.. index:: + pair: power; operation + operator: ** + +The power operator binds more tightly than unary operators on its left; it binds +less tightly than unary operators on its right. The syntax is: + +.. productionlist:: + power: (`await_expr` | `primary`) ["**" `u_expr`] + +Thus, in an unparenthesized sequence of power and unary operators, the operators +are evaluated from right to left (this does not constrain the evaluation order +for the operands): ``-1**2`` results in ``-1``. + +The power operator has the same semantics as the built-in :func:`pow` function, +when called with two arguments: it yields its left argument raised to the power +of its right argument. The numeric arguments are first converted to a common +type, and the result is of that type. + +For int operands, the result has the same type as the operands unless the second +argument is negative; in that case, all arguments are converted to float and a +float result is delivered. For example, ``10**2`` returns ``100``, but +``10**-2`` returns ``0.01``. + +Raising ``0.0`` to a negative power results in a :exc:`ZeroDivisionError`. +Raising a negative number to a fractional power results in a :class:`complex` +number. (In earlier versions it raised a :exc:`ValueError`.) + + +.. _unary: + +Unary arithmetic and bitwise operations +======================================= + +.. index:: + triple: unary; arithmetic; operation + triple: unary; bitwise; operation + +All unary arithmetic and bitwise operations have the same priority: + +.. productionlist:: + u_expr: `power` | "-" `u_expr` | "+" `u_expr` | "~" `u_expr` + +.. index:: + single: negation + single: minus + single: operator; - (minus) + single: - (minus); unary operator + +The unary ``-`` (minus) operator yields the negation of its numeric argument. + +.. index:: + single: plus + single: operator; + (plus) + single: + (plus); unary operator + +The unary ``+`` (plus) operator yields its numeric argument unchanged. + +.. index:: + single: inversion + operator: ~ (tilde) + +The unary ``~`` (invert) operator yields the bitwise inversion of its integer +argument. The bitwise inversion of ``x`` is defined as ``-(x+1)``. It only +applies to integral numbers. + +.. index:: exception: TypeError + +In all three cases, if the argument does not have the proper type, a +:exc:`TypeError` exception is raised. + + +.. _binary: + +Binary arithmetic operations +============================ + +.. index:: triple: binary; arithmetic; operation + +The binary arithmetic operations have the conventional priority levels. Note +that some of these operations also apply to certain non-numeric types. Apart +from the power operator, there are only two levels, one for multiplicative +operators and one for additive operators: + +.. productionlist:: + m_expr: `u_expr` | `m_expr` "*" `u_expr` | `m_expr` "@" `m_expr` | + : `m_expr` "//" `u_expr` | `m_expr` "/" `u_expr` | + : `m_expr` "%" `u_expr` + a_expr: `m_expr` | `a_expr` "+" `m_expr` | `a_expr` "-" `m_expr` + +.. index:: + single: multiplication + operator: * (asterisk) + +The ``*`` (multiplication) operator yields the product of its arguments. The +arguments must either both be numbers, or one argument must be an integer and +the other must be a sequence. In the former case, the numbers are converted to a +common type and then multiplied together. In the latter case, sequence +repetition is performed; a negative repetition factor yields an empty sequence. + +.. index:: + single: matrix multiplication + operator: @ (at) + +The ``@`` (at) operator is intended to be used for matrix multiplication. No +builtin Python types implement this operator. + +.. versionadded:: 3.5 + +.. index:: + exception: ZeroDivisionError + single: division + operator: / (slash) + operator: // + +The ``/`` (division) and ``//`` (floor division) operators yield the quotient of +their arguments. The numeric arguments are first converted to a common type. +Division of integers yields a float, while floor division of integers results in an +integer; the result is that of mathematical division with the 'floor' function +applied to the result. Division by zero raises the :exc:`ZeroDivisionError` +exception. + +.. index:: + single: modulo + operator: % (percent) + +The ``%`` (modulo) operator yields the remainder from the division of the first +argument by the second. The numeric arguments are first converted to a common +type. A zero right argument raises the :exc:`ZeroDivisionError` exception. The +arguments may be floating point numbers, e.g., ``3.14%0.7`` equals ``0.34`` +(since ``3.14`` equals ``4*0.7 + 0.34``.) The modulo operator always yields a +result with the same sign as its second operand (or zero); the absolute value of +the result is strictly smaller than the absolute value of the second operand +[#]_. + +The floor division and modulo operators are connected by the following +identity: ``x == (x//y)*y + (x%y)``. Floor division and modulo are also +connected with the built-in function :func:`divmod`: ``divmod(x, y) == (x//y, +x%y)``. [#]_. + +In addition to performing the modulo operation on numbers, the ``%`` operator is +also overloaded by string objects to perform old-style string formatting (also +known as interpolation). The syntax for string formatting is described in the +Python Library Reference, section :ref:`old-string-formatting`. + +The floor division operator, the modulo operator, and the :func:`divmod` +function are not defined for complex numbers. Instead, convert to a floating +point number using the :func:`abs` function if appropriate. + +.. index:: + single: addition + single: operator; + (plus) + single: + (plus); binary operator + +The ``+`` (addition) operator yields the sum of its arguments. The arguments +must either both be numbers or both be sequences of the same type. In the +former case, the numbers are converted to a common type and then added together. +In the latter case, the sequences are concatenated. + +.. index:: + single: subtraction + single: operator; - (minus) + single: - (minus); binary operator + +The ``-`` (subtraction) operator yields the difference of its arguments. The +numeric arguments are first converted to a common type. + + +.. _shifting: + +Shifting operations +=================== + +.. index:: + pair: shifting; operation + operator: << + operator: >> + +The shifting operations have lower priority than the arithmetic operations: + +.. productionlist:: + shift_expr: `a_expr` | `shift_expr` ("<<" | ">>") `a_expr` + +These operators accept integers as arguments. They shift the first argument to +the left or right by the number of bits given by the second argument. + +.. index:: exception: ValueError + +A right shift by *n* bits is defined as floor division by ``pow(2,n)``. A left +shift by *n* bits is defined as multiplication with ``pow(2,n)``. + + +.. _bitwise: + +Binary bitwise operations +========================= + +.. index:: triple: binary; bitwise; operation + +Each of the three bitwise operations has a different priority level: + +.. productionlist:: + and_expr: `shift_expr` | `and_expr` "&" `shift_expr` + xor_expr: `and_expr` | `xor_expr` "^" `and_expr` + or_expr: `xor_expr` | `or_expr` "|" `xor_expr` + +.. index:: + pair: bitwise; and + operator: & (ampersand) + +The ``&`` operator yields the bitwise AND of its arguments, which must be +integers. + +.. index:: + pair: bitwise; xor + pair: exclusive; or + operator: ^ (caret) + +The ``^`` operator yields the bitwise XOR (exclusive OR) of its arguments, which +must be integers. + +.. index:: + pair: bitwise; or + pair: inclusive; or + operator: | (vertical bar) + +The ``|`` operator yields the bitwise (inclusive) OR of its arguments, which +must be integers. + + +.. _comparisons: + +Comparisons +=========== + +.. index:: + single: comparison + pair: C; language + operator: < (less) + operator: > (greater) + operator: <= + operator: >= + operator: == + operator: != + +Unlike C, all comparison operations in Python have the same priority, which is +lower than that of any arithmetic, shifting or bitwise operation. Also unlike +C, expressions like ``a < b < c`` have the interpretation that is conventional +in mathematics: + +.. productionlist:: + comparison: `or_expr` (`comp_operator` `or_expr`)* + comp_operator: "<" | ">" | "==" | ">=" | "<=" | "!=" + : | "is" ["not"] | ["not"] "in" + +Comparisons yield boolean values: ``True`` or ``False``. + +.. index:: pair: chaining; comparisons + +Comparisons can be chained arbitrarily, e.g., ``x < y <= z`` is equivalent to +``x < y and y <= z``, except that ``y`` is evaluated only once (but in both +cases ``z`` is not evaluated at all when ``x < y`` is found to be false). + +Formally, if *a*, *b*, *c*, ..., *y*, *z* are expressions and *op1*, *op2*, ..., +*opN* are comparison operators, then ``a op1 b op2 c ... y opN z`` is equivalent +to ``a op1 b and b op2 c and ... y opN z``, except that each expression is +evaluated at most once. + +Note that ``a op1 b op2 c`` doesn't imply any kind of comparison between *a* and +*c*, so that, e.g., ``x < y > z`` is perfectly legal (though perhaps not +pretty). + +Value comparisons +----------------- + +The operators ``<``, ``>``, ``==``, ``>=``, ``<=``, and ``!=`` compare the +values of two objects. The objects do not need to have the same type. + +Chapter :ref:`objects` states that objects have a value (in addition to type +and identity). The value of an object is a rather abstract notion in Python: +For example, there is no canonical access method for an object's value. Also, +there is no requirement that the value of an object should be constructed in a +particular way, e.g. comprised of all its data attributes. Comparison operators +implement a particular notion of what the value of an object is. One can think +of them as defining the value of an object indirectly, by means of their +comparison implementation. + +Because all types are (direct or indirect) subtypes of :class:`object`, they +inherit the default comparison behavior from :class:`object`. Types can +customize their comparison behavior by implementing +:dfn:`rich comparison methods` like :meth:`__lt__`, described in +:ref:`customization`. + +The default behavior for equality comparison (``==`` and ``!=``) is based on +the identity of the objects. Hence, equality comparison of instances with the +same identity results in equality, and equality comparison of instances with +different identities results in inequality. A motivation for this default +behavior is the desire that all objects should be reflexive (i.e. ``x is y`` +implies ``x == y``). + +A default order comparison (``<``, ``>``, ``<=``, and ``>=``) is not provided; +an attempt raises :exc:`TypeError`. A motivation for this default behavior is +the lack of a similar invariant as for equality. + +The behavior of the default equality comparison, that instances with different +identities are always unequal, may be in contrast to what types will need that +have a sensible definition of object value and value-based equality. Such +types will need to customize their comparison behavior, and in fact, a number +of built-in types have done that. + +The following list describes the comparison behavior of the most important +built-in types. + +* Numbers of built-in numeric types (:ref:`typesnumeric`) and of the standard + library types :class:`fractions.Fraction` and :class:`decimal.Decimal` can be + compared within and across their types, with the restriction that complex + numbers do not support order comparison. Within the limits of the types + involved, they compare mathematically (algorithmically) correct without loss + of precision. + + The not-a-number values ``float('NaN')`` and ``decimal.Decimal('NaN')`` are + special. Any ordered comparison of a number to a not-a-number value is false. + A counter-intuitive implication is that not-a-number values are not equal to + themselves. For example, if ``x = float('NaN')``, ``3 < x``, ``x < 3``, ``x + == x``, ``x != x`` are all false. This behavior is compliant with IEEE 754. + +* Binary sequences (instances of :class:`bytes` or :class:`bytearray`) can be + compared within and across their types. They compare lexicographically using + the numeric values of their elements. + +* Strings (instances of :class:`str`) compare lexicographically using the + numerical Unicode code points (the result of the built-in function + :func:`ord`) of their characters. [#]_ + + Strings and binary sequences cannot be directly compared. + +* Sequences (instances of :class:`tuple`, :class:`list`, or :class:`range`) can + be compared only within each of their types, with the restriction that ranges + do not support order comparison. Equality comparison across these types + results in inequality, and ordering comparison across these types raises + :exc:`TypeError`. + + Sequences compare lexicographically using comparison of corresponding + elements, whereby reflexivity of the elements is enforced. + + In enforcing reflexivity of elements, the comparison of collections assumes + that for a collection element ``x``, ``x == x`` is always true. Based on + that assumption, element identity is compared first, and element comparison + is performed only for distinct elements. This approach yields the same + result as a strict element comparison would, if the compared elements are + reflexive. For non-reflexive elements, the result is different than for + strict element comparison, and may be surprising: The non-reflexive + not-a-number values for example result in the following comparison behavior + when used in a list:: + + >>> nan = float('NaN') + >>> nan is nan + True + >>> nan == nan + False <-- the defined non-reflexive behavior of NaN + >>> [nan] == [nan] + True <-- list enforces reflexivity and tests identity first + + Lexicographical comparison between built-in collections works as follows: + + - For two collections to compare equal, they must be of the same type, have + the same length, and each pair of corresponding elements must compare + equal (for example, ``[1,2] == (1,2)`` is false because the type is not the + same). + + - Collections that support order comparison are ordered the same as their + first unequal elements (for example, ``[1,2,x] <= [1,2,y]`` has the same + value as ``x <= y``). If a corresponding element does not exist, the + shorter collection is ordered first (for example, ``[1,2] < [1,2,3]`` is + true). + +* Mappings (instances of :class:`dict`) compare equal if and only if they have + equal `(key, value)` pairs. Equality comparison of the keys and values + enforces reflexivity. + + Order comparisons (``<``, ``>``, ``<=``, and ``>=``) raise :exc:`TypeError`. + +* Sets (instances of :class:`set` or :class:`frozenset`) can be compared within + and across their types. + + They define order + comparison operators to mean subset and superset tests. Those relations do + not define total orderings (for example, the two sets ``{1,2}`` and ``{2,3}`` + are not equal, nor subsets of one another, nor supersets of one + another). Accordingly, sets are not appropriate arguments for functions + which depend on total ordering (for example, :func:`min`, :func:`max`, and + :func:`sorted` produce undefined results given a list of sets as inputs). + + Comparison of sets enforces reflexivity of its elements. + +* Most other built-in types have no comparison methods implemented, so they + inherit the default comparison behavior. + +User-defined classes that customize their comparison behavior should follow +some consistency rules, if possible: + +* Equality comparison should be reflexive. + In other words, identical objects should compare equal: + + ``x is y`` implies ``x == y`` + +* Comparison should be symmetric. + In other words, the following expressions should have the same result: + + ``x == y`` and ``y == x`` + + ``x != y`` and ``y != x`` + + ``x < y`` and ``y > x`` + + ``x <= y`` and ``y >= x`` + +* Comparison should be transitive. + The following (non-exhaustive) examples illustrate that: + + ``x > y and y > z`` implies ``x > z`` + + ``x < y and y <= z`` implies ``x < z`` + +* Inverse comparison should result in the boolean negation. + In other words, the following expressions should have the same result: + + ``x == y`` and ``not x != y`` + + ``x < y`` and ``not x >= y`` (for total ordering) + + ``x > y`` and ``not x <= y`` (for total ordering) + + The last two expressions apply to totally ordered collections (e.g. to + sequences, but not to sets or mappings). See also the + :func:`~functools.total_ordering` decorator. + +* The :func:`hash` result should be consistent with equality. + Objects that are equal should either have the same hash value, + or be marked as unhashable. + +Python does not enforce these consistency rules. In fact, the not-a-number +values are an example for not following these rules. + + +.. _in: +.. _not in: +.. _membership-test-details: + +Membership test operations +-------------------------- + +The operators :keyword:`in` and :keyword:`not in` test for membership. ``x in +s`` evaluates to ``True`` if *x* is a member of *s*, and ``False`` otherwise. +``x not in s`` returns the negation of ``x in s``. All built-in sequences and +set types support this as well as dictionary, for which :keyword:`!in` tests +whether the dictionary has a given key. For container types such as list, tuple, +set, frozenset, dict, or collections.deque, the expression ``x in y`` is equivalent +to ``any(x is e or x == e for e in y)``. + +For the string and bytes types, ``x in y`` is ``True`` if and only if *x* is a +substring of *y*. An equivalent test is ``y.find(x) != -1``. Empty strings are +always considered to be a substring of any other string, so ``"" in "abc"`` will +return ``True``. + +For user-defined classes which define the :meth:`__contains__` method, ``x in +y`` returns ``True`` if ``y.__contains__(x)`` returns a true value, and +``False`` otherwise. + +For user-defined classes which do not define :meth:`__contains__` but do define +:meth:`__iter__`, ``x in y`` is ``True`` if some value ``z``, for which the +expression ``x is z or x == z`` is true, is produced while iterating over ``y``. +If an exception is raised during the iteration, it is as if :keyword:`in` raised +that exception. + +Lastly, the old-style iteration protocol is tried: if a class defines +:meth:`__getitem__`, ``x in y`` is ``True`` if and only if there is a non-negative +integer index *i* such that ``x is y[i] or x == y[i]``, and no lower integer index +raises the :exc:`IndexError` exception. (If any other exception is raised, it is as +if :keyword:`in` raised that exception). + +.. index:: + operator: in + operator: not in + pair: membership; test + object: sequence + +The operator :keyword:`not in` is defined to have the inverse truth value of +:keyword:`in`. + +.. index:: + operator: is + operator: is not + pair: identity; test + + +.. _is: +.. _is not: + +Identity comparisons +-------------------- + +The operators :keyword:`is` and :keyword:`is not` test for an object's identity: ``x +is y`` is true if and only if *x* and *y* are the same object. An Object's identity +is determined using the :meth:`id` function. ``x is not y`` yields the inverse +truth value. [#]_ + + +.. _booleans: +.. _and: +.. _or: +.. _not: + +Boolean operations +================== + +.. index:: + pair: Conditional; expression + pair: Boolean; operation + +.. productionlist:: + or_test: `and_test` | `or_test` "or" `and_test` + and_test: `not_test` | `and_test` "and" `not_test` + not_test: `comparison` | "not" `not_test` + +In the context of Boolean operations, and also when expressions are used by +control flow statements, the following values are interpreted as false: +``False``, ``None``, numeric zero of all types, and empty strings and containers +(including strings, tuples, lists, dictionaries, sets and frozensets). All +other values are interpreted as true. User-defined objects can customize their +truth value by providing a :meth:`__bool__` method. + +.. index:: operator: not + +The operator :keyword:`not` yields ``True`` if its argument is false, ``False`` +otherwise. + +.. index:: operator: and + +The expression ``x and y`` first evaluates *x*; if *x* is false, its value is +returned; otherwise, *y* is evaluated and the resulting value is returned. + +.. index:: operator: or + +The expression ``x or y`` first evaluates *x*; if *x* is true, its value is +returned; otherwise, *y* is evaluated and the resulting value is returned. + +Note that neither :keyword:`and` nor :keyword:`or` restrict the value and type +they return to ``False`` and ``True``, but rather return the last evaluated +argument. This is sometimes useful, e.g., if ``s`` is a string that should be +replaced by a default value if it is empty, the expression ``s or 'foo'`` yields +the desired value. Because :keyword:`not` has to create a new value, it +returns a boolean value regardless of the type of its argument +(for example, ``not 'foo'`` produces ``False`` rather than ``''``.) + + +.. _if_expr: + +Conditional expressions +======================= + +.. index:: + pair: conditional; expression + pair: ternary; operator + single: if; conditional expression + single: else; conditional expression + +.. productionlist:: + conditional_expression: `or_test` ["if" `or_test` "else" `expression`] + expression: `conditional_expression` | `lambda_expr` + expression_nocond: `or_test` | `lambda_expr_nocond` + +Conditional expressions (sometimes called a "ternary operator") have the lowest +priority of all Python operations. + +The expression ``x if C else y`` first evaluates the condition, *C* rather than *x*. +If *C* is true, *x* is evaluated and its value is returned; otherwise, *y* is +evaluated and its value is returned. + +See :pep:`308` for more details about conditional expressions. + + +.. _lambdas: +.. _lambda: + +Lambdas +======= + +.. index:: + pair: lambda; expression + pair: lambda; form + pair: anonymous; function + single: : (colon); lambda expression + +.. productionlist:: + lambda_expr: "lambda" [`parameter_list`] ":" `expression` + lambda_expr_nocond: "lambda" [`parameter_list`] ":" `expression_nocond` + +Lambda expressions (sometimes called lambda forms) are used to create anonymous +functions. The expression ``lambda parameters: expression`` yields a function +object. The unnamed object behaves like a function object defined with: + +.. code-block:: none + + def (parameters): + return expression + +See section :ref:`function` for the syntax of parameter lists. Note that +functions created with lambda expressions cannot contain statements or +annotations. + + +.. _exprlists: + +Expression lists +================ + +.. index:: + pair: expression; list + single: , (comma); expression list + +.. productionlist:: + expression_list: `expression` ("," `expression`)* [","] + starred_list: `starred_item` ("," `starred_item`)* [","] + starred_expression: `expression` | (`starred_item` ",")* [`starred_item`] + starred_item: `expression` | "*" `or_expr` + +.. index:: object: tuple + +Except when part of a list or set display, an expression list +containing at least one comma yields a tuple. The length of +the tuple is the number of expressions in the list. The expressions are +evaluated from left to right. + +.. index:: + pair: iterable; unpacking + single: * (asterisk); in expression lists + +An asterisk ``*`` denotes :dfn:`iterable unpacking`. Its operand must be +an :term:`iterable`. The iterable is expanded into a sequence of items, +which are included in the new tuple, list, or set, at the site of +the unpacking. + +.. versionadded:: 3.5 + Iterable unpacking in expression lists, originally proposed by :pep:`448`. + +.. index:: pair: trailing; comma + +The trailing comma is required only to create a single tuple (a.k.a. a +*singleton*); it is optional in all other cases. A single expression without a +trailing comma doesn't create a tuple, but rather yields the value of that +expression. (To create an empty tuple, use an empty pair of parentheses: +``()``.) + + +.. _evalorder: + +Evaluation order +================ + +.. index:: pair: evaluation; order + +Python evaluates expressions from left to right. Notice that while evaluating +an assignment, the right-hand side is evaluated before the left-hand side. + +In the following lines, expressions will be evaluated in the arithmetic order of +their suffixes:: + + expr1, expr2, expr3, expr4 + (expr1, expr2, expr3, expr4) + {expr1: expr2, expr3: expr4} + expr1 + expr2 * (expr3 - expr4) + expr1(expr2, expr3, *expr4, **expr5) + expr3, expr4 = expr1, expr2 + + +.. _operator-summary: + +Operator precedence +=================== + +.. index:: + pair: operator; precedence + +The following table summarizes the operator precedence in Python, from lowest +precedence (least binding) to highest precedence (most binding). Operators in +the same box have the same precedence. Unless the syntax is explicitly given, +operators are binary. Operators in the same box group left to right (except for +exponentiation, which groups from right to left). + +Note that comparisons, membership tests, and identity tests, all have the same +precedence and have a left-to-right chaining feature as described in the +:ref:`comparisons` section. + + ++-----------------------------------------------+-------------------------------------+ +| Operator | Description | ++===============================================+=====================================+ +| :keyword:`lambda` | Lambda expression | ++-----------------------------------------------+-------------------------------------+ +| :keyword:`if ` -- :keyword:`!else` | Conditional expression | ++-----------------------------------------------+-------------------------------------+ +| :keyword:`or` | Boolean OR | ++-----------------------------------------------+-------------------------------------+ +| :keyword:`and` | Boolean AND | ++-----------------------------------------------+-------------------------------------+ +| :keyword:`not` ``x`` | Boolean NOT | ++-----------------------------------------------+-------------------------------------+ +| :keyword:`in`, :keyword:`not in`, | Comparisons, including membership | +| :keyword:`is`, :keyword:`is not`, ``<``, | tests and identity tests | +| ``<=``, ``>``, ``>=``, ``!=``, ``==`` | | ++-----------------------------------------------+-------------------------------------+ +| ``|`` | Bitwise OR | ++-----------------------------------------------+-------------------------------------+ +| ``^`` | Bitwise XOR | ++-----------------------------------------------+-------------------------------------+ +| ``&`` | Bitwise AND | ++-----------------------------------------------+-------------------------------------+ +| ``<<``, ``>>`` | Shifts | ++-----------------------------------------------+-------------------------------------+ +| ``+``, ``-`` | Addition and subtraction | ++-----------------------------------------------+-------------------------------------+ +| ``*``, ``@``, ``/``, ``//``, ``%`` | Multiplication, matrix | +| | multiplication, division, floor | +| | division, remainder [#]_ | ++-----------------------------------------------+-------------------------------------+ +| ``+x``, ``-x``, ``~x`` | Positive, negative, bitwise NOT | ++-----------------------------------------------+-------------------------------------+ +| ``**`` | Exponentiation [#]_ | ++-----------------------------------------------+-------------------------------------+ +| :keyword:`await` ``x`` | Await expression | ++-----------------------------------------------+-------------------------------------+ +| ``x[index]``, ``x[index:index]``, | Subscription, slicing, | +| ``x(arguments...)``, ``x.attribute`` | call, attribute reference | ++-----------------------------------------------+-------------------------------------+ +| ``(expressions...)``, | Binding or tuple display, | +| ``[expressions...]``, | list display, | +| ``{key: value...}``, | dictionary display, | +| ``{expressions...}`` | set display | ++-----------------------------------------------+-------------------------------------+ + + +.. rubric:: Footnotes + +.. [#] While ``abs(x%y) < abs(y)`` is true mathematically, for floats it may not be + true numerically due to roundoff. For example, and assuming a platform on which + a Python float is an IEEE 754 double-precision number, in order that ``-1e-100 % + 1e100`` have the same sign as ``1e100``, the computed result is ``-1e-100 + + 1e100``, which is numerically exactly equal to ``1e100``. The function + :func:`math.fmod` returns a result whose sign matches the sign of the + first argument instead, and so returns ``-1e-100`` in this case. Which approach + is more appropriate depends on the application. + +.. [#] If x is very close to an exact integer multiple of y, it's possible for + ``x//y`` to be one larger than ``(x-x%y)//y`` due to rounding. In such + cases, Python returns the latter result, in order to preserve that + ``divmod(x,y)[0] * y + x % y`` be very close to ``x``. + +.. [#] The Unicode standard distinguishes between :dfn:`code points` + (e.g. U+0041) and :dfn:`abstract characters` (e.g. "LATIN CAPITAL LETTER A"). + While most abstract characters in Unicode are only represented using one + code point, there is a number of abstract characters that can in addition be + represented using a sequence of more than one code point. For example, the + abstract character "LATIN CAPITAL LETTER C WITH CEDILLA" can be represented + as a single :dfn:`precomposed character` at code position U+00C7, or as a + sequence of a :dfn:`base character` at code position U+0043 (LATIN CAPITAL + LETTER C), followed by a :dfn:`combining character` at code position U+0327 + (COMBINING CEDILLA). + + The comparison operators on strings compare at the level of Unicode code + points. This may be counter-intuitive to humans. For example, + ``"\u00C7" == "\u0043\u0327"`` is ``False``, even though both strings + represent the same abstract character "LATIN CAPITAL LETTER C WITH CEDILLA". + + To compare strings at the level of abstract characters (that is, in a way + intuitive to humans), use :func:`unicodedata.normalize`. + +.. [#] Due to automatic garbage-collection, free lists, and the dynamic nature of + descriptors, you may notice seemingly unusual behaviour in certain uses of + the :keyword:`is` operator, like those involving comparisons between instance + methods, or constants. Check their documentation for more info. + +.. [#] The ``%`` operator is also used for string formatting; the same + precedence applies. + +.. [#] The power operator ``**`` binds less tightly than an arithmetic or + bitwise unary operator on its right, that is, ``2**-1`` is ``0.5``. diff --git a/python-3.7.4-docs-html/_sources/reference/grammar.rst.txt b/python-3.7.4-docs-html/_sources/reference/grammar.rst.txt new file mode 100644 index 0000000..83d0f85 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/reference/grammar.rst.txt @@ -0,0 +1,7 @@ +Full Grammar specification +========================== + +This is the full Python grammar, as it is read by the parser generator and used +to parse Python source files: + +.. literalinclude:: ../../Grammar/Grammar diff --git a/python-3.7.4-docs-html/_sources/reference/import.rst.txt b/python-3.7.4-docs-html/_sources/reference/import.rst.txt new file mode 100644 index 0000000..88290c8 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/reference/import.rst.txt @@ -0,0 +1,1073 @@ + +.. _importsystem: + +***************** +The import system +***************** + +.. index:: single: import machinery + +Python code in one :term:`module` gains access to the code in another module +by the process of :term:`importing` it. The :keyword:`import` statement is +the most common way of invoking the import machinery, but it is not the only +way. Functions such as :func:`importlib.import_module` and built-in +:func:`__import__` can also be used to invoke the import machinery. + +The :keyword:`import` statement combines two operations; it searches for the +named module, then it binds the results of that search to a name in the local +scope. The search operation of the :keyword:`!import` statement is defined as +a call to the :func:`__import__` function, with the appropriate arguments. +The return value of :func:`__import__` is used to perform the name +binding operation of the :keyword:`!import` statement. See the +:keyword:`!import` statement for the exact details of that name binding +operation. + +A direct call to :func:`__import__` performs only the module search and, if +found, the module creation operation. While certain side-effects may occur, +such as the importing of parent packages, and the updating of various caches +(including :data:`sys.modules`), only the :keyword:`import` statement performs +a name binding operation. + +When an :keyword:`import` statement is executed, the standard builtin +:func:`__import__` function is called. Other mechanisms for invoking the +import system (such as :func:`importlib.import_module`) may choose to bypass +:func:`__import__` and use their own solutions to implement import semantics. + +When a module is first imported, Python searches for the module and if found, +it creates a module object [#fnmo]_, initializing it. If the named module +cannot be found, a :exc:`ModuleNotFoundError` is raised. Python implements various +strategies to search for the named module when the import machinery is +invoked. These strategies can be modified and extended by using various hooks +described in the sections below. + +.. versionchanged:: 3.3 + The import system has been updated to fully implement the second phase + of :pep:`302`. There is no longer any implicit import machinery - the full + import system is exposed through :data:`sys.meta_path`. In addition, + native namespace package support has been implemented (see :pep:`420`). + + +:mod:`importlib` +================ + +The :mod:`importlib` module provides a rich API for interacting with the +import system. For example :func:`importlib.import_module` provides a +recommended, simpler API than built-in :func:`__import__` for invoking the +import machinery. Refer to the :mod:`importlib` library documentation for +additional detail. + + + +Packages +======== + +.. index:: + single: package + +Python has only one type of module object, and all modules are of this type, +regardless of whether the module is implemented in Python, C, or something +else. To help organize modules and provide a naming hierarchy, Python has a +concept of :term:`packages `. + +You can think of packages as the directories on a file system and modules as +files within directories, but don't take this analogy too literally since +packages and modules need not originate from the file system. For the +purposes of this documentation, we'll use this convenient analogy of +directories and files. Like file system directories, packages are organized +hierarchically, and packages may themselves contain subpackages, as well as +regular modules. + +It's important to keep in mind that all packages are modules, but not all +modules are packages. Or put another way, packages are just a special kind of +module. Specifically, any module that contains a ``__path__`` attribute is +considered a package. + +All modules have a name. Subpackage names are separated from their parent +package name by dots, akin to Python's standard attribute access syntax. Thus +you might have a module called :mod:`sys` and a package called :mod:`email`, +which in turn has a subpackage called :mod:`email.mime` and a module within +that subpackage called :mod:`email.mime.text`. + + +Regular packages +---------------- + +.. index:: + pair: package; regular + +Python defines two types of packages, :term:`regular packages ` and :term:`namespace packages `. Regular +packages are traditional packages as they existed in Python 3.2 and earlier. +A regular package is typically implemented as a directory containing an +``__init__.py`` file. When a regular package is imported, this +``__init__.py`` file is implicitly executed, and the objects it defines are +bound to names in the package's namespace. The ``__init__.py`` file can +contain the same Python code that any other module can contain, and Python +will add some additional attributes to the module when it is imported. + +For example, the following file system layout defines a top level ``parent`` +package with three subpackages:: + + parent/ + __init__.py + one/ + __init__.py + two/ + __init__.py + three/ + __init__.py + +Importing ``parent.one`` will implicitly execute ``parent/__init__.py`` and +``parent/one/__init__.py``. Subsequent imports of ``parent.two`` or +``parent.three`` will execute ``parent/two/__init__.py`` and +``parent/three/__init__.py`` respectively. + + +Namespace packages +------------------ + +.. index:: + pair: package; namespace + pair: package; portion + +A namespace package is a composite of various :term:`portions `, +where each portion contributes a subpackage to the parent package. Portions +may reside in different locations on the file system. Portions may also be +found in zip files, on the network, or anywhere else that Python searches +during import. Namespace packages may or may not correspond directly to +objects on the file system; they may be virtual modules that have no concrete +representation. + +Namespace packages do not use an ordinary list for their ``__path__`` +attribute. They instead use a custom iterable type which will automatically +perform a new search for package portions on the next import attempt within +that package if the path of their parent package (or :data:`sys.path` for a +top level package) changes. + +With namespace packages, there is no ``parent/__init__.py`` file. In fact, +there may be multiple ``parent`` directories found during import search, where +each one is provided by a different portion. Thus ``parent/one`` may not be +physically located next to ``parent/two``. In this case, Python will create a +namespace package for the top-level ``parent`` package whenever it or one of +its subpackages is imported. + +See also :pep:`420` for the namespace package specification. + + +Searching +========= + +To begin the search, Python needs the :term:`fully qualified ` +name of the module (or package, but for the purposes of this discussion, the +difference is immaterial) being imported. This name may come from various +arguments to the :keyword:`import` statement, or from the parameters to the +:func:`importlib.import_module` or :func:`__import__` functions. + +This name will be used in various phases of the import search, and it may be +the dotted path to a submodule, e.g. ``foo.bar.baz``. In this case, Python +first tries to import ``foo``, then ``foo.bar``, and finally ``foo.bar.baz``. +If any of the intermediate imports fail, a :exc:`ModuleNotFoundError` is raised. + + +The module cache +---------------- + +.. index:: + single: sys.modules + +The first place checked during import search is :data:`sys.modules`. This +mapping serves as a cache of all modules that have been previously imported, +including the intermediate paths. So if ``foo.bar.baz`` was previously +imported, :data:`sys.modules` will contain entries for ``foo``, ``foo.bar``, +and ``foo.bar.baz``. Each key will have as its value the corresponding module +object. + +During import, the module name is looked up in :data:`sys.modules` and if +present, the associated value is the module satisfying the import, and the +process completes. However, if the value is ``None``, then a +:exc:`ModuleNotFoundError` is raised. If the module name is missing, Python will +continue searching for the module. + +:data:`sys.modules` is writable. Deleting a key may not destroy the +associated module (as other modules may hold references to it), +but it will invalidate the cache entry for the named module, causing +Python to search anew for the named module upon its next +import. The key can also be assigned to ``None``, forcing the next import +of the module to result in a :exc:`ModuleNotFoundError`. + +Beware though, as if you keep a reference to the module object, +invalidate its cache entry in :data:`sys.modules`, and then re-import the +named module, the two module objects will *not* be the same. By contrast, +:func:`importlib.reload` will reuse the *same* module object, and simply +reinitialise the module contents by rerunning the module's code. + + +Finders and loaders +------------------- + +.. index:: + single: finder + single: loader + single: module spec + +If the named module is not found in :data:`sys.modules`, then Python's import +protocol is invoked to find and load the module. This protocol consists of +two conceptual objects, :term:`finders ` and :term:`loaders `. +A finder's job is to determine whether it can find the named module using +whatever strategy it knows about. Objects that implement both of these +interfaces are referred to as :term:`importers ` - they return +themselves when they find that they can load the requested module. + +Python includes a number of default finders and importers. The first one +knows how to locate built-in modules, and the second knows how to locate +frozen modules. A third default finder searches an :term:`import path` +for modules. The :term:`import path` is a list of locations that may +name file system paths or zip files. It can also be extended to search +for any locatable resource, such as those identified by URLs. + +The import machinery is extensible, so new finders can be added to extend the +range and scope of module searching. + +Finders do not actually load modules. If they can find the named module, they +return a :dfn:`module spec`, an encapsulation of the module's import-related +information, which the import machinery then uses when loading the module. + +The following sections describe the protocol for finders and loaders in more +detail, including how you can create and register new ones to extend the +import machinery. + +.. versionchanged:: 3.4 + In previous versions of Python, finders returned :term:`loaders ` + directly, whereas now they return module specs which *contain* loaders. + Loaders are still used during import but have fewer responsibilities. + +Import hooks +------------ + +.. index:: + single: import hooks + single: meta hooks + single: path hooks + pair: hooks; import + pair: hooks; meta + pair: hooks; path + +The import machinery is designed to be extensible; the primary mechanism for +this are the *import hooks*. There are two types of import hooks: *meta +hooks* and *import path hooks*. + +Meta hooks are called at the start of import processing, before any other +import processing has occurred, other than :data:`sys.modules` cache look up. +This allows meta hooks to override :data:`sys.path` processing, frozen +modules, or even built-in modules. Meta hooks are registered by adding new +finder objects to :data:`sys.meta_path`, as described below. + +Import path hooks are called as part of :data:`sys.path` (or +``package.__path__``) processing, at the point where their associated path +item is encountered. Import path hooks are registered by adding new callables +to :data:`sys.path_hooks` as described below. + + +The meta path +------------- + +.. index:: + single: sys.meta_path + pair: finder; find_spec + +When the named module is not found in :data:`sys.modules`, Python next +searches :data:`sys.meta_path`, which contains a list of meta path finder +objects. These finders are queried in order to see if they know how to handle +the named module. Meta path finders must implement a method called +:meth:`~importlib.abc.MetaPathFinder.find_spec()` which takes three arguments: +a name, an import path, and (optionally) a target module. The meta path +finder can use any strategy it wants to determine whether it can handle +the named module or not. + +If the meta path finder knows how to handle the named module, it returns a +spec object. If it cannot handle the named module, it returns ``None``. If +:data:`sys.meta_path` processing reaches the end of its list without returning +a spec, then a :exc:`ModuleNotFoundError` is raised. Any other exceptions +raised are simply propagated up, aborting the import process. + +The :meth:`~importlib.abc.MetaPathFinder.find_spec()` method of meta path +finders is called with two or three arguments. The first is the fully +qualified name of the module being imported, for example ``foo.bar.baz``. +The second argument is the path entries to use for the module search. For +top-level modules, the second argument is ``None``, but for submodules or +subpackages, the second argument is the value of the parent package's +``__path__`` attribute. If the appropriate ``__path__`` attribute cannot +be accessed, a :exc:`ModuleNotFoundError` is raised. The third argument +is an existing module object that will be the target of loading later. +The import system passes in a target module only during reload. + +The meta path may be traversed multiple times for a single import request. +For example, assuming none of the modules involved has already been cached, +importing ``foo.bar.baz`` will first perform a top level import, calling +``mpf.find_spec("foo", None, None)`` on each meta path finder (``mpf``). After +``foo`` has been imported, ``foo.bar`` will be imported by traversing the +meta path a second time, calling +``mpf.find_spec("foo.bar", foo.__path__, None)``. Once ``foo.bar`` has been +imported, the final traversal will call +``mpf.find_spec("foo.bar.baz", foo.bar.__path__, None)``. + +Some meta path finders only support top level imports. These importers will +always return ``None`` when anything other than ``None`` is passed as the +second argument. + +Python's default :data:`sys.meta_path` has three meta path finders, one that +knows how to import built-in modules, one that knows how to import frozen +modules, and one that knows how to import modules from an :term:`import path` +(i.e. the :term:`path based finder`). + +.. versionchanged:: 3.4 + The :meth:`~importlib.abc.MetaPathFinder.find_spec` method of meta path + finders replaced :meth:`~importlib.abc.MetaPathFinder.find_module`, which + is now deprecated. While it will continue to work without change, the + import machinery will try it only if the finder does not implement + ``find_spec()``. + + +Loading +======= + +If and when a module spec is found, the import machinery will use it (and +the loader it contains) when loading the module. Here is an approximation +of what happens during the loading portion of import:: + + module = None + if spec.loader is not None and hasattr(spec.loader, 'create_module'): + # It is assumed 'exec_module' will also be defined on the loader. + module = spec.loader.create_module(spec) + if module is None: + module = ModuleType(spec.name) + # The import-related module attributes get set here: + _init_module_attrs(spec, module) + + if spec.loader is None: + if spec.submodule_search_locations is not None: + # namespace package + sys.modules[spec.name] = module + else: + # unsupported + raise ImportError + elif not hasattr(spec.loader, 'exec_module'): + module = spec.loader.load_module(spec.name) + # Set __loader__ and __package__ if missing. + else: + sys.modules[spec.name] = module + try: + spec.loader.exec_module(module) + except BaseException: + try: + del sys.modules[spec.name] + except KeyError: + pass + raise + return sys.modules[spec.name] + +Note the following details: + + * If there is an existing module object with the given name in + :data:`sys.modules`, import will have already returned it. + + * The module will exist in :data:`sys.modules` before the loader + executes the module code. This is crucial because the module code may + (directly or indirectly) import itself; adding it to :data:`sys.modules` + beforehand prevents unbounded recursion in the worst case and multiple + loading in the best. + + * If loading fails, the failing module -- and only the failing module -- + gets removed from :data:`sys.modules`. Any module already in the + :data:`sys.modules` cache, and any module that was successfully loaded + as a side-effect, must remain in the cache. This contrasts with + reloading where even the failing module is left in :data:`sys.modules`. + + * After the module is created but before execution, the import machinery + sets the import-related module attributes ("_init_module_attrs" in + the pseudo-code example above), as summarized in a + :ref:`later section `. + + * Module execution is the key moment of loading in which the module's + namespace gets populated. Execution is entirely delegated to the + loader, which gets to decide what gets populated and how. + + * The module created during loading and passed to exec_module() may + not be the one returned at the end of import [#fnlo]_. + +.. versionchanged:: 3.4 + The import system has taken over the boilerplate responsibilities of + loaders. These were previously performed by the + :meth:`importlib.abc.Loader.load_module` method. + +Loaders +------- + +Module loaders provide the critical function of loading: module execution. +The import machinery calls the :meth:`importlib.abc.Loader.exec_module` +method with a single argument, the module object to execute. Any value +returned from :meth:`~importlib.abc.Loader.exec_module` is ignored. + +Loaders must satisfy the following requirements: + + * If the module is a Python module (as opposed to a built-in module or a + dynamically loaded extension), the loader should execute the module's code + in the module's global name space (``module.__dict__``). + + * If the loader cannot execute the module, it should raise an + :exc:`ImportError`, although any other exception raised during + :meth:`~importlib.abc.Loader.exec_module` will be propagated. + +In many cases, the finder and loader can be the same object; in such cases the +:meth:`~importlib.abc.MetaPathFinder.find_spec` method would just return a +spec with the loader set to ``self``. + +Module loaders may opt in to creating the module object during loading +by implementing a :meth:`~importlib.abc.Loader.create_module` method. +It takes one argument, the module spec, and returns the new module object +to use during loading. ``create_module()`` does not need to set any attributes +on the module object. If the method returns ``None``, the +import machinery will create the new module itself. + +.. versionadded:: 3.4 + The :meth:`~importlib.abc.Loader.create_module` method of loaders. + +.. versionchanged:: 3.4 + The :meth:`~importlib.abc.Loader.load_module` method was replaced by + :meth:`~importlib.abc.Loader.exec_module` and the import + machinery assumed all the boilerplate responsibilities of loading. + + For compatibility with existing loaders, the import machinery will use + the ``load_module()`` method of loaders if it exists and the loader does + not also implement ``exec_module()``. However, ``load_module()`` has been + deprecated and loaders should implement ``exec_module()`` instead. + + The ``load_module()`` method must implement all the boilerplate loading + functionality described above in addition to executing the module. All + the same constraints apply, with some additional clarification: + + * If there is an existing module object with the given name in + :data:`sys.modules`, the loader must use that existing module. + (Otherwise, :func:`importlib.reload` will not work correctly.) If the + named module does not exist in :data:`sys.modules`, the loader + must create a new module object and add it to :data:`sys.modules`. + + * The module *must* exist in :data:`sys.modules` before the loader + executes the module code, to prevent unbounded recursion or multiple + loading. + + * If loading fails, the loader must remove any modules it has inserted + into :data:`sys.modules`, but it must remove **only** the failing + module(s), and only if the loader itself has loaded the module(s) + explicitly. + +.. versionchanged:: 3.5 + A :exc:`DeprecationWarning` is raised when ``exec_module()`` is defined but + ``create_module()`` is not. + +.. versionchanged:: 3.6 + An :exc:`ImportError` is raised when ``exec_module()`` is defined but + ``create_module()`` is not. + +Submodules +---------- + +When a submodule is loaded using any mechanism (e.g. ``importlib`` APIs, the +``import`` or ``import-from`` statements, or built-in ``__import__()``) a +binding is placed in the parent module's namespace to the submodule object. +For example, if package ``spam`` has a submodule ``foo``, after importing +``spam.foo``, ``spam`` will have an attribute ``foo`` which is bound to the +submodule. Let's say you have the following directory structure:: + + spam/ + __init__.py + foo.py + bar.py + +and ``spam/__init__.py`` has the following lines in it:: + + from .foo import Foo + from .bar import Bar + +then executing the following puts a name binding to ``foo`` and ``bar`` in the +``spam`` module:: + + >>> import spam + >>> spam.foo + + >>> spam.bar + + +Given Python's familiar name binding rules this might seem surprising, but +it's actually a fundamental feature of the import system. The invariant +holding is that if you have ``sys.modules['spam']`` and +``sys.modules['spam.foo']`` (as you would after the above import), the latter +must appear as the ``foo`` attribute of the former. + +Module spec +----------- + +The import machinery uses a variety of information about each module +during import, especially before loading. Most of the information is +common to all modules. The purpose of a module's spec is to encapsulate +this import-related information on a per-module basis. + +Using a spec during import allows state to be transferred between import +system components, e.g. between the finder that creates the module spec +and the loader that executes it. Most importantly, it allows the +import machinery to perform the boilerplate operations of loading, +whereas without a module spec the loader had that responsibility. + +The module's spec is exposed as the ``__spec__`` attribute on a module object. +See :class:`~importlib.machinery.ModuleSpec` for details on the contents of +the module spec. + +.. versionadded:: 3.4 + +.. _import-mod-attrs: + +Import-related module attributes +-------------------------------- + +The import machinery fills in these attributes on each module object +during loading, based on the module's spec, before the loader executes +the module. + +.. attribute:: __name__ + + The ``__name__`` attribute must be set to the fully-qualified name of + the module. This name is used to uniquely identify the module in + the import system. + +.. attribute:: __loader__ + + The ``__loader__`` attribute must be set to the loader object that + the import machinery used when loading the module. This is mostly + for introspection, but can be used for additional loader-specific + functionality, for example getting data associated with a loader. + +.. attribute:: __package__ + + The module's ``__package__`` attribute must be set. Its value must + be a string, but it can be the same value as its ``__name__``. When + the module is a package, its ``__package__`` value should be set to + its ``__name__``. When the module is not a package, ``__package__`` + should be set to the empty string for top-level modules, or for + submodules, to the parent package's name. See :pep:`366` for further + details. + + This attribute is used instead of ``__name__`` to calculate explicit + relative imports for main modules, as defined in :pep:`366`. It is + expected to have the same value as ``__spec__.parent``. + + .. versionchanged:: 3.6 + The value of ``__package__`` is expected to be the same as + ``__spec__.parent``. + +.. attribute:: __spec__ + + The ``__spec__`` attribute must be set to the module spec that was + used when importing the module. Setting ``__spec__`` + appropriately applies equally to :ref:`modules initialized during + interpreter startup `. The one exception is ``__main__``, + where ``__spec__`` is :ref:`set to None in some cases `. + + When ``__package__`` is not defined, ``__spec__.parent`` is used as + a fallback. + + .. versionadded:: 3.4 + + .. versionchanged:: 3.6 + ``__spec__.parent`` is used as a fallback when ``__package__`` is + not defined. + +.. attribute:: __path__ + + If the module is a package (either regular or namespace), the module + object's ``__path__`` attribute must be set. The value must be + iterable, but may be empty if ``__path__`` has no further significance. + If ``__path__`` is not empty, it must produce strings when iterated + over. More details on the semantics of ``__path__`` are given + :ref:`below `. + + Non-package modules should not have a ``__path__`` attribute. + +.. attribute:: __file__ +.. attribute:: __cached__ + + ``__file__`` is optional. If set, this attribute's value must be a + string. The import system may opt to leave ``__file__`` unset if it + has no semantic meaning (e.g. a module loaded from a database). + + If ``__file__`` is set, it may also be appropriate to set the + ``__cached__`` attribute which is the path to any compiled version of + the code (e.g. byte-compiled file). The file does not need to exist + to set this attribute; the path can simply point to where the + compiled file would exist (see :pep:`3147`). + + It is also appropriate to set ``__cached__`` when ``__file__`` is not + set. However, that scenario is quite atypical. Ultimately, the + loader is what makes use of ``__file__`` and/or ``__cached__``. So + if a loader can load from a cached module but otherwise does not load + from a file, that atypical scenario may be appropriate. + +.. _package-path-rules: + +module.__path__ +--------------- + +By definition, if a module has a ``__path__`` attribute, it is a package. + +A package's ``__path__`` attribute is used during imports of its subpackages. +Within the import machinery, it functions much the same as :data:`sys.path`, +i.e. providing a list of locations to search for modules during import. +However, ``__path__`` is typically much more constrained than +:data:`sys.path`. + +``__path__`` must be an iterable of strings, but it may be empty. +The same rules used for :data:`sys.path` also apply to a package's +``__path__``, and :data:`sys.path_hooks` (described below) are +consulted when traversing a package's ``__path__``. + +A package's ``__init__.py`` file may set or alter the package's ``__path__`` +attribute, and this was typically the way namespace packages were implemented +prior to :pep:`420`. With the adoption of :pep:`420`, namespace packages no +longer need to supply ``__init__.py`` files containing only ``__path__`` +manipulation code; the import machinery automatically sets ``__path__`` +correctly for the namespace package. + +Module reprs +------------ + +By default, all modules have a usable repr, however depending on the +attributes set above, and in the module's spec, you can more explicitly +control the repr of module objects. + +If the module has a spec (``__spec__``), the import machinery will try +to generate a repr from it. If that fails or there is no spec, the import +system will craft a default repr using whatever information is available +on the module. It will try to use the ``module.__name__``, +``module.__file__``, and ``module.__loader__`` as input into the repr, +with defaults for whatever information is missing. + +Here are the exact rules used: + + * If the module has a ``__spec__`` attribute, the information in the spec + is used to generate the repr. The "name", "loader", "origin", and + "has_location" attributes are consulted. + + * If the module has a ``__file__`` attribute, this is used as part of the + module's repr. + + * If the module has no ``__file__`` but does have a ``__loader__`` that is not + ``None``, then the loader's repr is used as part of the module's repr. + + * Otherwise, just use the module's ``__name__`` in the repr. + +.. versionchanged:: 3.4 + Use of :meth:`loader.module_repr() ` + has been deprecated and the module spec is now used by the import + machinery to generate a module repr. + + For backward compatibility with Python 3.3, the module repr will be + generated by calling the loader's + :meth:`~importlib.abc.Loader.module_repr` method, if defined, before + trying either approach described above. However, the method is deprecated. + +.. _pyc-invalidation: + +Cached bytecode invalidation +---------------------------- + +Before Python loads cached bytecode from ``.pyc`` file, it checks whether the +cache is up-to-date with the source ``.py`` file. By default, Python does this +by storing the source's last-modified timestamp and size in the cache file when +writing it. At runtime, the import system then validates the cache file by +checking the stored metadata in the cache file against at source's +metadata. + +Python also supports "hash-based" cache files, which store a hash of the source +file's contents rather than its metadata. There are two variants of hash-based +``.pyc`` files: checked and unchecked. For checked hash-based ``.pyc`` files, +Python validates the cache file by hashing the source file and comparing the +resulting hash with the hash in the cache file. If a checked hash-based cache +file is found to be invalid, Python regenerates it and writes a new checked +hash-based cache file. For unchecked hash-based ``.pyc`` files, Python simply +assumes the cache file is valid if it exists. Hash-based ``.pyc`` files +validation behavior may be overridden with the :option:`--check-hash-based-pycs` +flag. + +.. versionchanged:: 3.7 + Added hash-based ``.pyc`` files. Previously, Python only supported + timestamp-based invalidation of bytecode caches. + + +The Path Based Finder +===================== + +.. index:: + single: path based finder + +As mentioned previously, Python comes with several default meta path finders. +One of these, called the :term:`path based finder` +(:class:`~importlib.machinery.PathFinder`), searches an :term:`import path`, +which contains a list of :term:`path entries `. Each path +entry names a location to search for modules. + +The path based finder itself doesn't know how to import anything. Instead, it +traverses the individual path entries, associating each of them with a +path entry finder that knows how to handle that particular kind of path. + +The default set of path entry finders implement all the semantics for finding +modules on the file system, handling special file types such as Python source +code (``.py`` files), Python byte code (``.pyc`` files) and +shared libraries (e.g. ``.so`` files). When supported by the :mod:`zipimport` +module in the standard library, the default path entry finders also handle +loading all of these file types (other than shared libraries) from zipfiles. + +Path entries need not be limited to file system locations. They can refer to +URLs, database queries, or any other location that can be specified as a +string. + +The path based finder provides additional hooks and protocols so that you +can extend and customize the types of searchable path entries. For example, +if you wanted to support path entries as network URLs, you could write a hook +that implements HTTP semantics to find modules on the web. This hook (a +callable) would return a :term:`path entry finder` supporting the protocol +described below, which was then used to get a loader for the module from the +web. + +A word of warning: this section and the previous both use the term *finder*, +distinguishing between them by using the terms :term:`meta path finder` and +:term:`path entry finder`. These two types of finders are very similar, +support similar protocols, and function in similar ways during the import +process, but it's important to keep in mind that they are subtly different. +In particular, meta path finders operate at the beginning of the import +process, as keyed off the :data:`sys.meta_path` traversal. + +By contrast, path entry finders are in a sense an implementation detail +of the path based finder, and in fact, if the path based finder were to be +removed from :data:`sys.meta_path`, none of the path entry finder semantics +would be invoked. + + +Path entry finders +------------------ + +.. index:: + single: sys.path + single: sys.path_hooks + single: sys.path_importer_cache + single: PYTHONPATH + +The :term:`path based finder` is responsible for finding and loading +Python modules and packages whose location is specified with a string +:term:`path entry`. Most path entries name locations in the file system, +but they need not be limited to this. + +As a meta path finder, the :term:`path based finder` implements the +:meth:`~importlib.abc.MetaPathFinder.find_spec` protocol previously +described, however it exposes additional hooks that can be used to +customize how modules are found and loaded from the :term:`import path`. + +Three variables are used by the :term:`path based finder`, :data:`sys.path`, +:data:`sys.path_hooks` and :data:`sys.path_importer_cache`. The ``__path__`` +attributes on package objects are also used. These provide additional ways +that the import machinery can be customized. + +:data:`sys.path` contains a list of strings providing search locations for +modules and packages. It is initialized from the :data:`PYTHONPATH` +environment variable and various other installation- and +implementation-specific defaults. Entries in :data:`sys.path` can name +directories on the file system, zip files, and potentially other "locations" +(see the :mod:`site` module) that should be searched for modules, such as +URLs, or database queries. Only strings and bytes should be present on +:data:`sys.path`; all other data types are ignored. The encoding of bytes +entries is determined by the individual :term:`path entry finders `. + +The :term:`path based finder` is a :term:`meta path finder`, so the import +machinery begins the :term:`import path` search by calling the path +based finder's :meth:`~importlib.machinery.PathFinder.find_spec` method as +described previously. When the ``path`` argument to +:meth:`~importlib.machinery.PathFinder.find_spec` is given, it will be a +list of string paths to traverse - typically a package's ``__path__`` +attribute for an import within that package. If the ``path`` argument is +``None``, this indicates a top level import and :data:`sys.path` is used. + +The path based finder iterates over every entry in the search path, and +for each of these, looks for an appropriate :term:`path entry finder` +(:class:`~importlib.abc.PathEntryFinder`) for the +path entry. Because this can be an expensive operation (e.g. there may be +`stat()` call overheads for this search), the path based finder maintains +a cache mapping path entries to path entry finders. This cache is maintained +in :data:`sys.path_importer_cache` (despite the name, this cache actually +stores finder objects rather than being limited to :term:`importer` objects). +In this way, the expensive search for a particular :term:`path entry` +location's :term:`path entry finder` need only be done once. User code is +free to remove cache entries from :data:`sys.path_importer_cache` forcing +the path based finder to perform the path entry search again [#fnpic]_. + +If the path entry is not present in the cache, the path based finder iterates +over every callable in :data:`sys.path_hooks`. Each of the :term:`path entry +hooks ` in this list is called with a single argument, the +path entry to be searched. This callable may either return a :term:`path +entry finder` that can handle the path entry, or it may raise +:exc:`ImportError`. An :exc:`ImportError` is used by the path based finder to +signal that the hook cannot find a :term:`path entry finder` +for that :term:`path entry`. The +exception is ignored and :term:`import path` iteration continues. The hook +should expect either a string or bytes object; the encoding of bytes objects +is up to the hook (e.g. it may be a file system encoding, UTF-8, or something +else), and if the hook cannot decode the argument, it should raise +:exc:`ImportError`. + +If :data:`sys.path_hooks` iteration ends with no :term:`path entry finder` +being returned, then the path based finder's +:meth:`~importlib.machinery.PathFinder.find_spec` method will store ``None`` +in :data:`sys.path_importer_cache` (to indicate that there is no finder for +this path entry) and return ``None``, indicating that this +:term:`meta path finder` could not find the module. + +If a :term:`path entry finder` *is* returned by one of the :term:`path entry +hook` callables on :data:`sys.path_hooks`, then the following protocol is used +to ask the finder for a module spec, which is then used when loading the +module. + +The current working directory -- denoted by an empty string -- is handled +slightly differently from other entries on :data:`sys.path`. First, if the +current working directory is found to not exist, no value is stored in +:data:`sys.path_importer_cache`. Second, the value for the current working +directory is looked up fresh for each module lookup. Third, the path used for +:data:`sys.path_importer_cache` and returned by +:meth:`importlib.machinery.PathFinder.find_spec` will be the actual current +working directory and not the empty string. + +Path entry finder protocol +-------------------------- + +In order to support imports of modules and initialized packages and also to +contribute portions to namespace packages, path entry finders must implement +the :meth:`~importlib.abc.PathEntryFinder.find_spec` method. + +:meth:`~importlib.abc.PathEntryFinder.find_spec` takes two argument, the +fully qualified name of the module being imported, and the (optional) target +module. ``find_spec()`` returns a fully populated spec for the module. +This spec will always have "loader" set (with one exception). + +To indicate to the import machinery that the spec represents a namespace +:term:`portion`. the path entry finder sets "loader" on the spec to +``None`` and "submodule_search_locations" to a list containing the +portion. + +.. versionchanged:: 3.4 + :meth:`~importlib.abc.PathEntryFinder.find_spec` replaced + :meth:`~importlib.abc.PathEntryFinder.find_loader` and + :meth:`~importlib.abc.PathEntryFinder.find_module`, both of which + are now deprecated, but will be used if ``find_spec()`` is not defined. + + Older path entry finders may implement one of these two deprecated methods + instead of ``find_spec()``. The methods are still respected for the + sake of backward compatibility. However, if ``find_spec()`` is + implemented on the path entry finder, the legacy methods are ignored. + + :meth:`~importlib.abc.PathEntryFinder.find_loader` takes one argument, the + fully qualified name of the module being imported. ``find_loader()`` + returns a 2-tuple where the first item is the loader and the second item + is a namespace :term:`portion`. When the first item (i.e. the loader) is + ``None``, this means that while the path entry finder does not have a + loader for the named module, it knows that the path entry contributes to + a namespace portion for the named module. This will almost always be the + case where Python is asked to import a namespace package that has no + physical presence on the file system. When a path entry finder returns + ``None`` for the loader, the second item of the 2-tuple return value must + be a sequence, although it can be empty. + + If ``find_loader()`` returns a non-``None`` loader value, the portion is + ignored and the loader is returned from the path based finder, terminating + the search through the path entries. + + For backwards compatibility with other implementations of the import + protocol, many path entry finders also support the same, + traditional ``find_module()`` method that meta path finders support. + However path entry finder ``find_module()`` methods are never called + with a ``path`` argument (they are expected to record the appropriate + path information from the initial call to the path hook). + + The ``find_module()`` method on path entry finders is deprecated, + as it does not allow the path entry finder to contribute portions to + namespace packages. If both ``find_loader()`` and ``find_module()`` + exist on a path entry finder, the import system will always call + ``find_loader()`` in preference to ``find_module()``. + + +Replacing the standard import system +==================================== + +The most reliable mechanism for replacing the entire import system is to +delete the default contents of :data:`sys.meta_path`, replacing them +entirely with a custom meta path hook. + +If it is acceptable to only alter the behaviour of import statements +without affecting other APIs that access the import system, then replacing +the builtin :func:`__import__` function may be sufficient. This technique +may also be employed at the module level to only alter the behaviour of +import statements within that module. + +To selectively prevent import of some modules from a hook early on the +meta path (rather than disabling the standard import system entirely), +it is sufficient to raise :exc:`ModuleNotFoundError` directly from +:meth:`~importlib.abc.MetaPathFinder.find_spec` instead of returning +``None``. The latter indicates that the meta path search should continue, +while raising an exception terminates it immediately. + +.. _relativeimports: + +Package Relative Imports +======================== + +Relative imports use leading dots. A single leading dot indicates a relative +import, starting with the current package. Two or more leading dots indicate a +relative import to the parent(s) of the current package, one level per dot +after the first. For example, given the following package layout:: + + package/ + __init__.py + subpackage1/ + __init__.py + moduleX.py + moduleY.py + subpackage2/ + __init__.py + moduleZ.py + moduleA.py + +In either ``subpackage1/moduleX.py`` or ``subpackage1/__init__.py``, +the following are valid relative imports:: + + from .moduleY import spam + from .moduleY import spam as ham + from . import moduleY + from ..subpackage1 import moduleY + from ..subpackage2.moduleZ import eggs + from ..moduleA import foo + +Absolute imports may use either the ``import <>`` or ``from <> import <>`` +syntax, but relative imports may only use the second form; the reason +for this is that:: + + import XXX.YYY.ZZZ + +should expose ``XXX.YYY.ZZZ`` as a usable expression, but .moduleY is +not a valid expression. + + +Special considerations for __main__ +=================================== + +The :mod:`__main__` module is a special case relative to Python's import +system. As noted :ref:`elsewhere `, the ``__main__`` module +is directly initialized at interpreter startup, much like :mod:`sys` and +:mod:`builtins`. However, unlike those two, it doesn't strictly +qualify as a built-in module. This is because the manner in which +``__main__`` is initialized depends on the flags and other options with +which the interpreter is invoked. + +.. _main_spec: + +__main__.__spec__ +----------------- + +Depending on how :mod:`__main__` is initialized, ``__main__.__spec__`` +gets set appropriately or to ``None``. + +When Python is started with the :option:`-m` option, ``__spec__`` is set +to the module spec of the corresponding module or package. ``__spec__`` is +also populated when the ``__main__`` module is loaded as part of executing a +directory, zipfile or other :data:`sys.path` entry. + +In :ref:`the remaining cases ` +``__main__.__spec__`` is set to ``None``, as the code used to populate the +:mod:`__main__` does not correspond directly with an importable module: + +- interactive prompt +- :option:`-c` option +- running from stdin +- running directly from a source or bytecode file + +Note that ``__main__.__spec__`` is always ``None`` in the last case, +*even if* the file could technically be imported directly as a module +instead. Use the :option:`-m` switch if valid module metadata is desired +in :mod:`__main__`. + +Note also that even when ``__main__`` corresponds with an importable module +and ``__main__.__spec__`` is set accordingly, they're still considered +*distinct* modules. This is due to the fact that blocks guarded by +``if __name__ == "__main__":`` checks only execute when the module is used +to populate the ``__main__`` namespace, and not during normal import. + + +Open issues +=========== + +XXX It would be really nice to have a diagram. + +XXX * (import_machinery.rst) how about a section devoted just to the +attributes of modules and packages, perhaps expanding upon or supplanting the +related entries in the data model reference page? + +XXX runpy, pkgutil, et al in the library manual should all get "See Also" +links at the top pointing to the new import system section. + +XXX Add more explanation regarding the different ways in which +``__main__`` is initialized? + +XXX Add more info on ``__main__`` quirks/pitfalls (i.e. copy from +:pep:`395`). + + +References +========== + +The import machinery has evolved considerably since Python's early days. The +original `specification for packages +`_ is still available to read, +although some details have changed since the writing of that document. + +The original specification for :data:`sys.meta_path` was :pep:`302`, with +subsequent extension in :pep:`420`. + +:pep:`420` introduced :term:`namespace packages ` for +Python 3.3. :pep:`420` also introduced the :meth:`find_loader` protocol as an +alternative to :meth:`find_module`. + +:pep:`366` describes the addition of the ``__package__`` attribute for +explicit relative imports in main modules. + +:pep:`328` introduced absolute and explicit relative imports and initially +proposed ``__name__`` for semantics :pep:`366` would eventually specify for +``__package__``. + +:pep:`338` defines executing modules as scripts. + +:pep:`451` adds the encapsulation of per-module import state in spec +objects. It also off-loads most of the boilerplate responsibilities of +loaders back onto the import machinery. These changes allow the +deprecation of several APIs in the import system and also addition of new +methods to finders and loaders. + +.. rubric:: Footnotes + +.. [#fnmo] See :class:`types.ModuleType`. + +.. [#fnlo] The importlib implementation avoids using the return value + directly. Instead, it gets the module object by looking the module name up + in :data:`sys.modules`. The indirect effect of this is that an imported + module may replace itself in :data:`sys.modules`. This is + implementation-specific behavior that is not guaranteed to work in other + Python implementations. + +.. [#fnpic] In legacy code, it is possible to find instances of + :class:`imp.NullImporter` in the :data:`sys.path_importer_cache`. It + is recommended that code be changed to use ``None`` instead. See + :ref:`portingpythoncode` for more details. diff --git a/python-3.7.4-docs-html/_sources/reference/index.rst.txt b/python-3.7.4-docs-html/_sources/reference/index.rst.txt new file mode 100644 index 0000000..a66673b --- /dev/null +++ b/python-3.7.4-docs-html/_sources/reference/index.rst.txt @@ -0,0 +1,29 @@ +.. _reference-index: + +################################# + The Python Language Reference +################################# + +This reference manual describes the syntax and "core semantics" of the +language. It is terse, but attempts to be exact and complete. The semantics of +non-essential built-in object types and of the built-in functions and modules +are described in :ref:`library-index`. For an informal introduction to the +language, see :ref:`tutorial-index`. For C or C++ programmers, two additional +manuals exist: :ref:`extending-index` describes the high-level picture of how to +write a Python extension module, and the :ref:`c-api-index` describes the +interfaces available to C/C++ programmers in detail. + +.. toctree:: + :maxdepth: 2 + :numbered: + + introduction.rst + lexical_analysis.rst + datamodel.rst + executionmodel.rst + import.rst + expressions.rst + simple_stmts.rst + compound_stmts.rst + toplevel_components.rst + grammar.rst diff --git a/python-3.7.4-docs-html/_sources/reference/introduction.rst.txt b/python-3.7.4-docs-html/_sources/reference/introduction.rst.txt new file mode 100644 index 0000000..bb7e390 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/reference/introduction.rst.txt @@ -0,0 +1,132 @@ + +.. _introduction: + +************ +Introduction +************ + +This reference manual describes the Python programming language. It is not +intended as a tutorial. + +While I am trying to be as precise as possible, I chose to use English rather +than formal specifications for everything except syntax and lexical analysis. +This should make the document more understandable to the average reader, but +will leave room for ambiguities. Consequently, if you were coming from Mars and +tried to re-implement Python from this document alone, you might have to guess +things and in fact you would probably end up implementing quite a different +language. On the other hand, if you are using Python and wonder what the precise +rules about a particular area of the language are, you should definitely be able +to find them here. If you would like to see a more formal definition of the +language, maybe you could volunteer your time --- or invent a cloning machine +:-). + +It is dangerous to add too many implementation details to a language reference +document --- the implementation may change, and other implementations of the +same language may work differently. On the other hand, CPython is the one +Python implementation in widespread use (although alternate implementations +continue to gain support), and its particular quirks are sometimes worth being +mentioned, especially where the implementation imposes additional limitations. +Therefore, you'll find short "implementation notes" sprinkled throughout the +text. + +Every Python implementation comes with a number of built-in and standard +modules. These are documented in :ref:`library-index`. A few built-in modules +are mentioned when they interact in a significant way with the language +definition. + + +.. _implementations: + +Alternate Implementations +========================= + +Though there is one Python implementation which is by far the most popular, +there are some alternate implementations which are of particular interest to +different audiences. + +Known implementations include: + +CPython + This is the original and most-maintained implementation of Python, written in C. + New language features generally appear here first. + +Jython + Python implemented in Java. This implementation can be used as a scripting + language for Java applications, or can be used to create applications using the + Java class libraries. It is also often used to create tests for Java libraries. + More information can be found at `the Jython website `_. + +Python for .NET + This implementation actually uses the CPython implementation, but is a managed + .NET application and makes .NET libraries available. It was created by Brian + Lloyd. For more information, see the `Python for .NET home page + `_. + +IronPython + An alternate Python for .NET. Unlike Python.NET, this is a complete Python + implementation that generates IL, and compiles Python code directly to .NET + assemblies. It was created by Jim Hugunin, the original creator of Jython. For + more information, see `the IronPython website `_. + +PyPy + An implementation of Python written completely in Python. It supports several + advanced features not found in other implementations like stackless support + and a Just in Time compiler. One of the goals of the project is to encourage + experimentation with the language itself by making it easier to modify the + interpreter (since it is written in Python). Additional information is + available on `the PyPy project's home page `_. + +Each of these implementations varies in some way from the language as documented +in this manual, or introduces specific information beyond what's covered in the +standard Python documentation. Please refer to the implementation-specific +documentation to determine what else you need to know about the specific +implementation you're using. + + +.. _notation: + +Notation +======== + +.. index:: BNF, grammar, syntax, notation + +The descriptions of lexical analysis and syntax use a modified BNF grammar +notation. This uses the following style of definition: + +.. productionlist:: * + name: `lc_letter` (`lc_letter` | "_")* + lc_letter: "a"..."z" + +The first line says that a ``name`` is an ``lc_letter`` followed by a sequence +of zero or more ``lc_letter``\ s and underscores. An ``lc_letter`` in turn is +any of the single characters ``'a'`` through ``'z'``. (This rule is actually +adhered to for the names defined in lexical and grammar rules in this document.) + +Each rule begins with a name (which is the name defined by the rule) and +``::=``. A vertical bar (``|``) is used to separate alternatives; it is the +least binding operator in this notation. A star (``*``) means zero or more +repetitions of the preceding item; likewise, a plus (``+``) means one or more +repetitions, and a phrase enclosed in square brackets (``[ ]``) means zero or +one occurrences (in other words, the enclosed phrase is optional). The ``*`` +and ``+`` operators bind as tightly as possible; parentheses are used for +grouping. Literal strings are enclosed in quotes. White space is only +meaningful to separate tokens. Rules are normally contained on a single line; +rules with many alternatives may be formatted alternatively with each line after +the first beginning with a vertical bar. + +.. index:: lexical definitions, ASCII + +In lexical definitions (as the example above), two more conventions are used: +Two literal characters separated by three dots mean a choice of any single +character in the given (inclusive) range of ASCII characters. A phrase between +angular brackets (``<...>``) gives an informal description of the symbol +defined; e.g., this could be used to describe the notion of 'control character' +if needed. + +Even though the notation used is almost the same, there is a big difference +between the meaning of lexical and syntactic definitions: a lexical definition +operates on the individual characters of the input source, while a syntax +definition operates on the stream of tokens generated by the lexical analysis. +All uses of BNF in the next chapter ("Lexical Analysis") are lexical +definitions; uses in subsequent chapters are syntactic definitions. + diff --git a/python-3.7.4-docs-html/_sources/reference/lexical_analysis.rst.txt b/python-3.7.4-docs-html/_sources/reference/lexical_analysis.rst.txt new file mode 100644 index 0000000..7b90f3b --- /dev/null +++ b/python-3.7.4-docs-html/_sources/reference/lexical_analysis.rst.txt @@ -0,0 +1,930 @@ + +.. _lexical: + +**************** +Lexical analysis +**************** + +.. index:: lexical analysis, parser, token + +A Python program is read by a *parser*. Input to the parser is a stream of +*tokens*, generated by the *lexical analyzer*. This chapter describes how the +lexical analyzer breaks a file into tokens. + +Python reads program text as Unicode code points; the encoding of a source file +can be given by an encoding declaration and defaults to UTF-8, see :pep:`3120` +for details. If the source file cannot be decoded, a :exc:`SyntaxError` is +raised. + + +.. _line-structure: + +Line structure +============== + +.. index:: line structure + +A Python program is divided into a number of *logical lines*. + + +.. _logical-lines: + +Logical lines +------------- + +.. index:: logical line, physical line, line joining, NEWLINE token + +The end of a logical line is represented by the token NEWLINE. Statements +cannot cross logical line boundaries except where NEWLINE is allowed by the +syntax (e.g., between statements in compound statements). A logical line is +constructed from one or more *physical lines* by following the explicit or +implicit *line joining* rules. + + +.. _physical-lines: + +Physical lines +-------------- + +A physical line is a sequence of characters terminated by an end-of-line +sequence. In source files and strings, any of the standard platform line +termination sequences can be used - the Unix form using ASCII LF (linefeed), +the Windows form using the ASCII sequence CR LF (return followed by linefeed), +or the old Macintosh form using the ASCII CR (return) character. All of these +forms can be used equally, regardless of platform. The end of input also serves +as an implicit terminator for the final physical line. + +When embedding Python, source code strings should be passed to Python APIs using +the standard C conventions for newline characters (the ``\n`` character, +representing ASCII LF, is the line terminator). + + +.. _comments: + +Comments +-------- + +.. index:: comment, hash character + single: # (hash); comment + +A comment starts with a hash character (``#``) that is not part of a string +literal, and ends at the end of the physical line. A comment signifies the end +of the logical line unless the implicit line joining rules are invoked. Comments +are ignored by the syntax. + + +.. _encodings: + +Encoding declarations +--------------------- + +.. index:: source character set, encoding declarations (source file) + single: # (hash); source encoding declaration + +If a comment in the first or second line of the Python script matches the +regular expression ``coding[=:]\s*([-\w.]+)``, this comment is processed as an +encoding declaration; the first group of this expression names the encoding of +the source code file. The encoding declaration must appear on a line of its +own. If it is the second line, the first line must also be a comment-only line. +The recommended forms of an encoding expression are :: + + # -*- coding: -*- + +which is recognized also by GNU Emacs, and :: + + # vim:fileencoding= + +which is recognized by Bram Moolenaar's VIM. + +If no encoding declaration is found, the default encoding is UTF-8. In +addition, if the first bytes of the file are the UTF-8 byte-order mark +(``b'\xef\xbb\xbf'``), the declared file encoding is UTF-8 (this is supported, +among others, by Microsoft's :program:`notepad`). + +If an encoding is declared, the encoding name must be recognized by Python. The +encoding is used for all lexical analysis, including string literals, comments +and identifiers. + +.. XXX there should be a list of supported encodings. + + +.. _explicit-joining: + +Explicit line joining +--------------------- + +.. index:: physical line, line joining, line continuation, backslash character + +Two or more physical lines may be joined into logical lines using backslash +characters (``\``), as follows: when a physical line ends in a backslash that is +not part of a string literal or comment, it is joined with the following forming +a single logical line, deleting the backslash and the following end-of-line +character. For example:: + + if 1900 < year < 2100 and 1 <= month <= 12 \ + and 1 <= day <= 31 and 0 <= hour < 24 \ + and 0 <= minute < 60 and 0 <= second < 60: # Looks like a valid date + return 1 + +A line ending in a backslash cannot carry a comment. A backslash does not +continue a comment. A backslash does not continue a token except for string +literals (i.e., tokens other than string literals cannot be split across +physical lines using a backslash). A backslash is illegal elsewhere on a line +outside a string literal. + + +.. _implicit-joining: + +Implicit line joining +--------------------- + +Expressions in parentheses, square brackets or curly braces can be split over +more than one physical line without using backslashes. For example:: + + month_names = ['Januari', 'Februari', 'Maart', # These are the + 'April', 'Mei', 'Juni', # Dutch names + 'Juli', 'Augustus', 'September', # for the months + 'Oktober', 'November', 'December'] # of the year + +Implicitly continued lines can carry comments. The indentation of the +continuation lines is not important. Blank continuation lines are allowed. +There is no NEWLINE token between implicit continuation lines. Implicitly +continued lines can also occur within triple-quoted strings (see below); in that +case they cannot carry comments. + + +.. _blank-lines: + +Blank lines +----------- + +.. index:: single: blank line + +A logical line that contains only spaces, tabs, formfeeds and possibly a +comment, is ignored (i.e., no NEWLINE token is generated). During interactive +input of statements, handling of a blank line may differ depending on the +implementation of the read-eval-print loop. In the standard interactive +interpreter, an entirely blank logical line (i.e. one containing not even +whitespace or a comment) terminates a multi-line statement. + + +.. _indentation: + +Indentation +----------- + +.. index:: indentation, leading whitespace, space, tab, grouping, statement grouping + +Leading whitespace (spaces and tabs) at the beginning of a logical line is used +to compute the indentation level of the line, which in turn is used to determine +the grouping of statements. + +Tabs are replaced (from left to right) by one to eight spaces such that the +total number of characters up to and including the replacement is a multiple of +eight (this is intended to be the same rule as used by Unix). The total number +of spaces preceding the first non-blank character then determines the line's +indentation. Indentation cannot be split over multiple physical lines using +backslashes; the whitespace up to the first backslash determines the +indentation. + +Indentation is rejected as inconsistent if a source file mixes tabs and spaces +in a way that makes the meaning dependent on the worth of a tab in spaces; a +:exc:`TabError` is raised in that case. + +**Cross-platform compatibility note:** because of the nature of text editors on +non-UNIX platforms, it is unwise to use a mixture of spaces and tabs for the +indentation in a single source file. It should also be noted that different +platforms may explicitly limit the maximum indentation level. + +A formfeed character may be present at the start of the line; it will be ignored +for the indentation calculations above. Formfeed characters occurring elsewhere +in the leading whitespace have an undefined effect (for instance, they may reset +the space count to zero). + +.. index:: INDENT token, DEDENT token + +The indentation levels of consecutive lines are used to generate INDENT and +DEDENT tokens, using a stack, as follows. + +Before the first line of the file is read, a single zero is pushed on the stack; +this will never be popped off again. The numbers pushed on the stack will +always be strictly increasing from bottom to top. At the beginning of each +logical line, the line's indentation level is compared to the top of the stack. +If it is equal, nothing happens. If it is larger, it is pushed on the stack, and +one INDENT token is generated. If it is smaller, it *must* be one of the +numbers occurring on the stack; all numbers on the stack that are larger are +popped off, and for each number popped off a DEDENT token is generated. At the +end of the file, a DEDENT token is generated for each number remaining on the +stack that is larger than zero. + +Here is an example of a correctly (though confusingly) indented piece of Python +code:: + + def perm(l): + # Compute the list of all permutations of l + if len(l) <= 1: + return [l] + r = [] + for i in range(len(l)): + s = l[:i] + l[i+1:] + p = perm(s) + for x in p: + r.append(l[i:i+1] + x) + return r + +The following example shows various indentation errors:: + + def perm(l): # error: first line indented + for i in range(len(l)): # error: not indented + s = l[:i] + l[i+1:] + p = perm(l[:i] + l[i+1:]) # error: unexpected indent + for x in p: + r.append(l[i:i+1] + x) + return r # error: inconsistent dedent + +(Actually, the first three errors are detected by the parser; only the last +error is found by the lexical analyzer --- the indentation of ``return r`` does +not match a level popped off the stack.) + + +.. _whitespace: + +Whitespace between tokens +------------------------- + +Except at the beginning of a logical line or in string literals, the whitespace +characters space, tab and formfeed can be used interchangeably to separate +tokens. Whitespace is needed between two tokens only if their concatenation +could otherwise be interpreted as a different token (e.g., ab is one token, but +a b is two tokens). + + +.. _other-tokens: + +Other tokens +============ + +Besides NEWLINE, INDENT and DEDENT, the following categories of tokens exist: +*identifiers*, *keywords*, *literals*, *operators*, and *delimiters*. Whitespace +characters (other than line terminators, discussed earlier) are not tokens, but +serve to delimit tokens. Where ambiguity exists, a token comprises the longest +possible string that forms a legal token, when read from left to right. + + +.. _identifiers: + +Identifiers and keywords +======================== + +.. index:: identifier, name + +Identifiers (also referred to as *names*) are described by the following lexical +definitions. + +The syntax of identifiers in Python is based on the Unicode standard annex +UAX-31, with elaboration and changes as defined below; see also :pep:`3131` for +further details. + +Within the ASCII range (U+0001..U+007F), the valid characters for identifiers +are the same as in Python 2.x: the uppercase and lowercase letters ``A`` through +``Z``, the underscore ``_`` and, except for the first character, the digits +``0`` through ``9``. + +Python 3.0 introduces additional characters from outside the ASCII range (see +:pep:`3131`). For these characters, the classification uses the version of the +Unicode Character Database as included in the :mod:`unicodedata` module. + +Identifiers are unlimited in length. Case is significant. + +.. productionlist:: + identifier: `xid_start` `xid_continue`* + id_start: + id_continue: + xid_start: + xid_continue: + +The Unicode category codes mentioned above stand for: + +* *Lu* - uppercase letters +* *Ll* - lowercase letters +* *Lt* - titlecase letters +* *Lm* - modifier letters +* *Lo* - other letters +* *Nl* - letter numbers +* *Mn* - nonspacing marks +* *Mc* - spacing combining marks +* *Nd* - decimal numbers +* *Pc* - connector punctuations +* *Other_ID_Start* - explicit list of characters in `PropList.txt + `_ to support backwards + compatibility +* *Other_ID_Continue* - likewise + +All identifiers are converted into the normal form NFKC while parsing; comparison +of identifiers is based on NFKC. + +A non-normative HTML file listing all valid identifier characters for Unicode +4.1 can be found at +https://www.dcl.hpi.uni-potsdam.de/home/loewis/table-3131.html. + + +.. _keywords: + +Keywords +-------- + +.. index:: + single: keyword + single: reserved word + +The following identifiers are used as reserved words, or *keywords* of the +language, and cannot be used as ordinary identifiers. They must be spelled +exactly as written here: + +.. sourcecode:: text + + False await else import pass + None break except in raise + True class finally is return + and continue for lambda try + as def from nonlocal while + assert del global not with + async elif if or yield + +.. index:: + single: _, identifiers + single: __, identifiers +.. _id-classes: + +Reserved classes of identifiers +------------------------------- + +Certain classes of identifiers (besides keywords) have special meanings. These +classes are identified by the patterns of leading and trailing underscore +characters: + +``_*`` + Not imported by ``from module import *``. The special identifier ``_`` is used + in the interactive interpreter to store the result of the last evaluation; it is + stored in the :mod:`builtins` module. When not in interactive mode, ``_`` + has no special meaning and is not defined. See section :ref:`import`. + + .. note:: + + The name ``_`` is often used in conjunction with internationalization; + refer to the documentation for the :mod:`gettext` module for more + information on this convention. + +``__*__`` + System-defined names. These names are defined by the interpreter and its + implementation (including the standard library). Current system names are + discussed in the :ref:`specialnames` section and elsewhere. More will likely + be defined in future versions of Python. *Any* use of ``__*__`` names, in + any context, that does not follow explicitly documented use, is subject to + breakage without warning. + +``__*`` + Class-private names. Names in this category, when used within the context of a + class definition, are re-written to use a mangled form to help avoid name + clashes between "private" attributes of base and derived classes. See section + :ref:`atom-identifiers`. + + +.. _literals: + +Literals +======== + +.. index:: literal, constant + +Literals are notations for constant values of some built-in types. + + +.. index:: string literal, bytes literal, ASCII + single: ' (single quote); string literal + single: " (double quote); string literal + single: u'; string literal + single: u"; string literal +.. _strings: + +String and Bytes literals +------------------------- + +String literals are described by the following lexical definitions: + +.. productionlist:: + stringliteral: [`stringprefix`](`shortstring` | `longstring`) + stringprefix: "r" | "u" | "R" | "U" | "f" | "F" + : | "fr" | "Fr" | "fR" | "FR" | "rf" | "rF" | "Rf" | "RF" + shortstring: "'" `shortstringitem`* "'" | '"' `shortstringitem`* '"' + longstring: "'''" `longstringitem`* "'''" | '"""' `longstringitem`* '"""' + shortstringitem: `shortstringchar` | `stringescapeseq` + longstringitem: `longstringchar` | `stringescapeseq` + shortstringchar: + longstringchar: + stringescapeseq: "\" + +.. productionlist:: + bytesliteral: `bytesprefix`(`shortbytes` | `longbytes`) + bytesprefix: "b" | "B" | "br" | "Br" | "bR" | "BR" | "rb" | "rB" | "Rb" | "RB" + shortbytes: "'" `shortbytesitem`* "'" | '"' `shortbytesitem`* '"' + longbytes: "'''" `longbytesitem`* "'''" | '"""' `longbytesitem`* '"""' + shortbytesitem: `shortbyteschar` | `bytesescapeseq` + longbytesitem: `longbyteschar` | `bytesescapeseq` + shortbyteschar: + longbyteschar: + bytesescapeseq: "\" + +One syntactic restriction not indicated by these productions is that whitespace +is not allowed between the :token:`stringprefix` or :token:`bytesprefix` and the +rest of the literal. The source character set is defined by the encoding +declaration; it is UTF-8 if no encoding declaration is given in the source file; +see section :ref:`encodings`. + +.. index:: triple-quoted string, Unicode Consortium, raw string + single: """; string literal + single: '''; string literal + +In plain English: Both types of literals can be enclosed in matching single quotes +(``'``) or double quotes (``"``). They can also be enclosed in matching groups +of three single or double quotes (these are generally referred to as +*triple-quoted strings*). The backslash (``\``) character is used to escape +characters that otherwise have a special meaning, such as newline, backslash +itself, or the quote character. + +.. index:: + single: b'; bytes literal + single: b"; bytes literal + +Bytes literals are always prefixed with ``'b'`` or ``'B'``; they produce an +instance of the :class:`bytes` type instead of the :class:`str` type. They +may only contain ASCII characters; bytes with a numeric value of 128 or greater +must be expressed with escapes. + +.. index:: + single: r'; raw string literal + single: r"; raw string literal + +Both string and bytes literals may optionally be prefixed with a letter ``'r'`` +or ``'R'``; such strings are called :dfn:`raw strings` and treat backslashes as +literal characters. As a result, in string literals, ``'\U'`` and ``'\u'`` +escapes in raw strings are not treated specially. Given that Python 2.x's raw +unicode literals behave differently than Python 3.x's the ``'ur'`` syntax +is not supported. + +.. versionadded:: 3.3 + The ``'rb'`` prefix of raw bytes literals has been added as a synonym + of ``'br'``. + +.. versionadded:: 3.3 + Support for the unicode legacy literal (``u'value'``) was reintroduced + to simplify the maintenance of dual Python 2.x and 3.x codebases. + See :pep:`414` for more information. + +.. index:: + single: f'; formatted string literal + single: f"; formatted string literal + +A string literal with ``'f'`` or ``'F'`` in its prefix is a +:dfn:`formatted string literal`; see :ref:`f-strings`. The ``'f'`` may be +combined with ``'r'``, but not with ``'b'`` or ``'u'``, therefore raw +formatted strings are possible, but formatted bytes literals are not. + +In triple-quoted literals, unescaped newlines and quotes are allowed (and are +retained), except that three unescaped quotes in a row terminate the literal. (A +"quote" is the character used to open the literal, i.e. either ``'`` or ``"``.) + +.. index:: physical line, escape sequence, Standard C, C + single: \ (backslash); escape sequence + single: \\; escape sequence + single: \a; escape sequence + single: \b; escape sequence + single: \f; escape sequence + single: \n; escape sequence + single: \r; escape sequence + single: \t; escape sequence + single: \v; escape sequence + single: \x; escape sequence + single: \N; escape sequence + single: \u; escape sequence + single: \U; escape sequence + +Unless an ``'r'`` or ``'R'`` prefix is present, escape sequences in string and +bytes literals are interpreted according to rules similar to those used by +Standard C. The recognized escape sequences are: + ++-----------------+---------------------------------+-------+ +| Escape Sequence | Meaning | Notes | ++=================+=================================+=======+ +| ``\newline`` | Backslash and newline ignored | | ++-----------------+---------------------------------+-------+ +| ``\\`` | Backslash (``\``) | | ++-----------------+---------------------------------+-------+ +| ``\'`` | Single quote (``'``) | | ++-----------------+---------------------------------+-------+ +| ``\"`` | Double quote (``"``) | | ++-----------------+---------------------------------+-------+ +| ``\a`` | ASCII Bell (BEL) | | ++-----------------+---------------------------------+-------+ +| ``\b`` | ASCII Backspace (BS) | | ++-----------------+---------------------------------+-------+ +| ``\f`` | ASCII Formfeed (FF) | | ++-----------------+---------------------------------+-------+ +| ``\n`` | ASCII Linefeed (LF) | | ++-----------------+---------------------------------+-------+ +| ``\r`` | ASCII Carriage Return (CR) | | ++-----------------+---------------------------------+-------+ +| ``\t`` | ASCII Horizontal Tab (TAB) | | ++-----------------+---------------------------------+-------+ +| ``\v`` | ASCII Vertical Tab (VT) | | ++-----------------+---------------------------------+-------+ +| ``\ooo`` | Character with octal value | (1,3) | +| | *ooo* | | ++-----------------+---------------------------------+-------+ +| ``\xhh`` | Character with hex value *hh* | (2,3) | ++-----------------+---------------------------------+-------+ + +Escape sequences only recognized in string literals are: + ++-----------------+---------------------------------+-------+ +| Escape Sequence | Meaning | Notes | ++=================+=================================+=======+ +| ``\N{name}`` | Character named *name* in the | \(4) | +| | Unicode database | | ++-----------------+---------------------------------+-------+ +| ``\uxxxx`` | Character with 16-bit hex value | \(5) | +| | *xxxx* | | ++-----------------+---------------------------------+-------+ +| ``\Uxxxxxxxx`` | Character with 32-bit hex value | \(6) | +| | *xxxxxxxx* | | ++-----------------+---------------------------------+-------+ + +Notes: + +(1) + As in Standard C, up to three octal digits are accepted. + +(2) + Unlike in Standard C, exactly two hex digits are required. + +(3) + In a bytes literal, hexadecimal and octal escapes denote the byte with the + given value. In a string literal, these escapes denote a Unicode character + with the given value. + +(4) + .. versionchanged:: 3.3 + Support for name aliases [#]_ has been added. + +(5) + Exactly four hex digits are required. + +(6) + Any Unicode character can be encoded this way. Exactly eight hex digits + are required. + + +.. index:: unrecognized escape sequence + +Unlike Standard C, all unrecognized escape sequences are left in the string +unchanged, i.e., *the backslash is left in the result*. (This behavior is +useful when debugging: if an escape sequence is mistyped, the resulting output +is more easily recognized as broken.) It is also important to note that the +escape sequences only recognized in string literals fall into the category of +unrecognized escapes for bytes literals. + + .. versionchanged:: 3.6 + Unrecognized escape sequences produce a DeprecationWarning. In + some future version of Python they will be a SyntaxError. + +Even in a raw literal, quotes can be escaped with a backslash, but the +backslash remains in the result; for example, ``r"\""`` is a valid string +literal consisting of two characters: a backslash and a double quote; ``r"\"`` +is not a valid string literal (even a raw string cannot end in an odd number of +backslashes). Specifically, *a raw literal cannot end in a single backslash* +(since the backslash would escape the following quote character). Note also +that a single backslash followed by a newline is interpreted as those two +characters as part of the literal, *not* as a line continuation. + + +.. _string-concatenation: + +String literal concatenation +---------------------------- + +Multiple adjacent string or bytes literals (delimited by whitespace), possibly +using different quoting conventions, are allowed, and their meaning is the same +as their concatenation. Thus, ``"hello" 'world'`` is equivalent to +``"helloworld"``. This feature can be used to reduce the number of backslashes +needed, to split long strings conveniently across long lines, or even to add +comments to parts of strings, for example:: + + re.compile("[A-Za-z_]" # letter or underscore + "[A-Za-z0-9_]*" # letter, digit or underscore + ) + +Note that this feature is defined at the syntactical level, but implemented at +compile time. The '+' operator must be used to concatenate string expressions +at run time. Also note that literal concatenation can use different quoting +styles for each component (even mixing raw strings and triple quoted strings), +and formatted string literals may be concatenated with plain string literals. + + +.. index:: + single: formatted string literal + single: interpolated string literal + single: string; formatted literal + single: string; interpolated literal + single: f-string + single: {} (curly brackets); in formatted string literal + single: ! (exclamation); in formatted string literal + single: : (colon); in formatted string literal +.. _f-strings: + +Formatted string literals +------------------------- + +.. versionadded:: 3.6 + +A :dfn:`formatted string literal` or :dfn:`f-string` is a string literal +that is prefixed with ``'f'`` or ``'F'``. These strings may contain +replacement fields, which are expressions delimited by curly braces ``{}``. +While other string literals always have a constant value, formatted strings +are really expressions evaluated at run time. + +Escape sequences are decoded like in ordinary string literals (except when +a literal is also marked as a raw string). After decoding, the grammar +for the contents of the string is: + +.. productionlist:: + f_string: (`literal_char` | "{{" | "}}" | `replacement_field`)* + replacement_field: "{" `f_expression` ["!" `conversion`] [":" `format_spec`] "}" + f_expression: (`conditional_expression` | "*" `or_expr`) + : ("," `conditional_expression` | "," "*" `or_expr`)* [","] + : | `yield_expression` + conversion: "s" | "r" | "a" + format_spec: (`literal_char` | NULL | `replacement_field`)* + literal_char: + +The parts of the string outside curly braces are treated literally, +except that any doubled curly braces ``'{{'`` or ``'}}'`` are replaced +with the corresponding single curly brace. A single opening curly +bracket ``'{'`` marks a replacement field, which starts with a +Python expression. After the expression, there may be a conversion field, +introduced by an exclamation point ``'!'``. A format specifier may also +be appended, introduced by a colon ``':'``. A replacement field ends +with a closing curly bracket ``'}'``. + +Expressions in formatted string literals are treated like regular +Python expressions surrounded by parentheses, with a few exceptions. +An empty expression is not allowed, and a :keyword:`lambda` expression +must be surrounded by explicit parentheses. Replacement expressions +can contain line breaks (e.g. in triple-quoted strings), but they +cannot contain comments. Each expression is evaluated in the context +where the formatted string literal appears, in order from left to right. + +If a conversion is specified, the result of evaluating the expression +is converted before formatting. Conversion ``'!s'`` calls :func:`str` on +the result, ``'!r'`` calls :func:`repr`, and ``'!a'`` calls :func:`ascii`. + +The result is then formatted using the :func:`format` protocol. The +format specifier is passed to the :meth:`__format__` method of the +expression or conversion result. An empty string is passed when the +format specifier is omitted. The formatted result is then included in +the final value of the whole string. + +Top-level format specifiers may include nested replacement fields. These nested +fields may include their own conversion fields and :ref:`format specifiers +`, but may not include more deeply-nested replacement fields. The +:ref:`format specifier mini-language ` is the same as that used by +the string .format() method. + +Formatted string literals may be concatenated, but replacement fields +cannot be split across literals. + +Some examples of formatted string literals:: + + >>> name = "Fred" + >>> f"He said his name is {name!r}." + "He said his name is 'Fred'." + >>> f"He said his name is {repr(name)}." # repr() is equivalent to !r + "He said his name is 'Fred'." + >>> width = 10 + >>> precision = 4 + >>> value = decimal.Decimal("12.34567") + >>> f"result: {value:{width}.{precision}}" # nested fields + 'result: 12.35' + >>> today = datetime(year=2017, month=1, day=27) + >>> f"{today:%B %d, %Y}" # using date format specifier + 'January 27, 2017' + >>> number = 1024 + >>> f"{number:#0x}" # using integer format specifier + '0x400' + +A consequence of sharing the same syntax as regular string literals is +that characters in the replacement fields must not conflict with the +quoting used in the outer formatted string literal:: + + f"abc {a["x"]} def" # error: outer string literal ended prematurely + f"abc {a['x']} def" # workaround: use different quoting + +Backslashes are not allowed in format expressions and will raise +an error:: + + f"newline: {ord('\n')}" # raises SyntaxError + +To include a value in which a backslash escape is required, create +a temporary variable. + + >>> newline = ord('\n') + >>> f"newline: {newline}" + 'newline: 10' + +Formatted string literals cannot be used as docstrings, even if they do not +include expressions. + +:: + + >>> def foo(): + ... f"Not a docstring" + ... + >>> foo.__doc__ is None + True + +See also :pep:`498` for the proposal that added formatted string literals, +and :meth:`str.format`, which uses a related format string mechanism. + + +.. _numbers: + +Numeric literals +---------------- + +.. index:: number, numeric literal, integer literal + floating point literal, hexadecimal literal + octal literal, binary literal, decimal literal, imaginary literal, complex literal + +There are three types of numeric literals: integers, floating point numbers, and +imaginary numbers. There are no complex literals (complex numbers can be formed +by adding a real number and an imaginary number). + +Note that numeric literals do not include a sign; a phrase like ``-1`` is +actually an expression composed of the unary operator '``-``' and the literal +``1``. + + +.. index:: + single: 0b; integer literal + single: 0o; integer literal + single: 0x; integer literal + single: _ (underscore); in numeric literal + +.. _integers: + +Integer literals +---------------- + +Integer literals are described by the following lexical definitions: + +.. productionlist:: + integer: `decinteger` | `bininteger` | `octinteger` | `hexinteger` + decinteger: `nonzerodigit` (["_"] `digit`)* | "0"+ (["_"] "0")* + bininteger: "0" ("b" | "B") (["_"] `bindigit`)+ + octinteger: "0" ("o" | "O") (["_"] `octdigit`)+ + hexinteger: "0" ("x" | "X") (["_"] `hexdigit`)+ + nonzerodigit: "1"..."9" + digit: "0"..."9" + bindigit: "0" | "1" + octdigit: "0"..."7" + hexdigit: `digit` | "a"..."f" | "A"..."F" + +There is no limit for the length of integer literals apart from what can be +stored in available memory. + +Underscores are ignored for determining the numeric value of the literal. They +can be used to group digits for enhanced readability. One underscore can occur +between digits, and after base specifiers like ``0x``. + +Note that leading zeros in a non-zero decimal number are not allowed. This is +for disambiguation with C-style octal literals, which Python used before version +3.0. + +Some examples of integer literals:: + + 7 2147483647 0o177 0b100110111 + 3 79228162514264337593543950336 0o377 0xdeadbeef + 100_000_000_000 0b_1110_0101 + +.. versionchanged:: 3.6 + Underscores are now allowed for grouping purposes in literals. + + +.. index:: + single: . (dot); in numeric literal + single: e; in numeric literal + single: _ (underscore); in numeric literal +.. _floating: + +Floating point literals +----------------------- + +Floating point literals are described by the following lexical definitions: + +.. productionlist:: + floatnumber: `pointfloat` | `exponentfloat` + pointfloat: [`digitpart`] `fraction` | `digitpart` "." + exponentfloat: (`digitpart` | `pointfloat`) `exponent` + digitpart: `digit` (["_"] `digit`)* + fraction: "." `digitpart` + exponent: ("e" | "E") ["+" | "-"] `digitpart` + +Note that the integer and exponent parts are always interpreted using radix 10. +For example, ``077e010`` is legal, and denotes the same number as ``77e10``. The +allowed range of floating point literals is implementation-dependent. As in +integer literals, underscores are supported for digit grouping. + +Some examples of floating point literals:: + + 3.14 10. .001 1e100 3.14e-10 0e0 3.14_15_93 + +.. versionchanged:: 3.6 + Underscores are now allowed for grouping purposes in literals. + + +.. index:: + single: j; in numeric literal +.. _imaginary: + +Imaginary literals +------------------ + +Imaginary literals are described by the following lexical definitions: + +.. productionlist:: + imagnumber: (`floatnumber` | `digitpart`) ("j" | "J") + +An imaginary literal yields a complex number with a real part of 0.0. Complex +numbers are represented as a pair of floating point numbers and have the same +restrictions on their range. To create a complex number with a nonzero real +part, add a floating point number to it, e.g., ``(3+4j)``. Some examples of +imaginary literals:: + + 3.14j 10.j 10j .001j 1e100j 3.14e-10j 3.14_15_93j + + +.. _operators: + +Operators +========= + +.. index:: single: operators + +The following tokens are operators: + +.. code-block:: none + + + + - * ** / // % @ + << >> & | ^ ~ + < > <= >= == != + + +.. _delimiters: + +Delimiters +========== + +.. index:: single: delimiters + +The following tokens serve as delimiters in the grammar: + +.. code-block:: none + + ( ) [ ] { } + , : . ; @ = -> + += -= *= /= //= %= @= + &= |= ^= >>= <<= **= + +The period can also occur in floating-point and imaginary literals. A sequence +of three periods has a special meaning as an ellipsis literal. The second half +of the list, the augmented assignment operators, serve lexically as delimiters, +but also perform an operation. + +The following printing ASCII characters have special meaning as part of other +tokens or are otherwise significant to the lexical analyzer: + +.. code-block:: none + + ' " # \ + +The following printing ASCII characters are not used in Python. Their +occurrence outside string literals and comments is an unconditional error: + +.. code-block:: none + + $ ? ` + + +.. rubric:: Footnotes + +.. [#] http://www.unicode.org/Public/11.0.0/ucd/NameAliases.txt diff --git a/python-3.7.4-docs-html/_sources/reference/simple_stmts.rst.txt b/python-3.7.4-docs-html/_sources/reference/simple_stmts.rst.txt new file mode 100644 index 0000000..1779832 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/reference/simple_stmts.rst.txt @@ -0,0 +1,1008 @@ + +.. _simple: + +***************** +Simple statements +***************** + +.. index:: pair: simple; statement + +A simple statement is comprised within a single logical line. Several simple +statements may occur on a single line separated by semicolons. The syntax for +simple statements is: + +.. productionlist:: + simple_stmt: `expression_stmt` + : | `assert_stmt` + : | `assignment_stmt` + : | `augmented_assignment_stmt` + : | `annotated_assignment_stmt` + : | `pass_stmt` + : | `del_stmt` + : | `return_stmt` + : | `yield_stmt` + : | `raise_stmt` + : | `break_stmt` + : | `continue_stmt` + : | `import_stmt` + : | `future_stmt` + : | `global_stmt` + : | `nonlocal_stmt` + + +.. _exprstmts: + +Expression statements +===================== + +.. index:: + pair: expression; statement + pair: expression; list +.. index:: pair: expression; list + +Expression statements are used (mostly interactively) to compute and write a +value, or (usually) to call a procedure (a function that returns no meaningful +result; in Python, procedures return the value ``None``). Other uses of +expression statements are allowed and occasionally useful. The syntax for an +expression statement is: + +.. productionlist:: + expression_stmt: `starred_expression` + +An expression statement evaluates the expression list (which may be a single +expression). + +.. index:: + builtin: repr + object: None + pair: string; conversion + single: output + pair: standard; output + pair: writing; values + pair: procedure; call + +In interactive mode, if the value is not ``None``, it is converted to a string +using the built-in :func:`repr` function and the resulting string is written to +standard output on a line by itself (except if the result is ``None``, so that +procedure calls do not cause any output.) + +.. _assignment: + +Assignment statements +===================== + +.. index:: + single: = (equals); assignment statement + pair: assignment; statement + pair: binding; name + pair: rebinding; name + object: mutable + pair: attribute; assignment + +Assignment statements are used to (re)bind names to values and to modify +attributes or items of mutable objects: + +.. productionlist:: + assignment_stmt: (`target_list` "=")+ (`starred_expression` | `yield_expression`) + target_list: `target` ("," `target`)* [","] + target: `identifier` + : | "(" [`target_list`] ")" + : | "[" [`target_list`] "]" + : | `attributeref` + : | `subscription` + : | `slicing` + : | "*" `target` + +(See section :ref:`primaries` for the syntax definitions for *attributeref*, +*subscription*, and *slicing*.) + +An assignment statement evaluates the expression list (remember that this can be +a single expression or a comma-separated list, the latter yielding a tuple) and +assigns the single resulting object to each of the target lists, from left to +right. + +.. index:: + single: target + pair: target; list + +Assignment is defined recursively depending on the form of the target (list). +When a target is part of a mutable object (an attribute reference, subscription +or slicing), the mutable object must ultimately perform the assignment and +decide about its validity, and may raise an exception if the assignment is +unacceptable. The rules observed by various types and the exceptions raised are +given with the definition of the object types (see section :ref:`types`). + +.. index:: triple: target; list; assignment + single: , (comma); in target list + single: * (asterisk); in assignment target list + single: [] (square brackets); in assignment target list + single: () (parentheses); in assignment target list + +Assignment of an object to a target list, optionally enclosed in parentheses or +square brackets, is recursively defined as follows. + +* If the target list is a single target with no trailing comma, + optionally in parentheses, the object is assigned to that target. + +* Else: The object must be an iterable with the same number of + items as there are targets in the target list, and the items are assigned, + from left to right, to the corresponding targets. + + * If the target list contains one target prefixed with an asterisk, called a + "starred" target: The object must be an iterable with at least as many items + as there are targets in the target list, minus one. The first items of the + iterable are assigned, from left to right, to the targets before the starred + target. The final items of the iterable are assigned to the targets after + the starred target. A list of the remaining items in the iterable is then + assigned to the starred target (the list can be empty). + + * Else: The object must be an iterable with the same number of items as there + are targets in the target list, and the items are assigned, from left to + right, to the corresponding targets. + +Assignment of an object to a single target is recursively defined as follows. + +* If the target is an identifier (name): + + * If the name does not occur in a :keyword:`global` or :keyword:`nonlocal` + statement in the current code block: the name is bound to the object in the + current local namespace. + + * Otherwise: the name is bound to the object in the global namespace or the + outer namespace determined by :keyword:`nonlocal`, respectively. + + .. index:: single: destructor + + The name is rebound if it was already bound. This may cause the reference + count for the object previously bound to the name to reach zero, causing the + object to be deallocated and its destructor (if it has one) to be called. + + .. index:: pair: attribute; assignment + +* If the target is an attribute reference: The primary expression in the + reference is evaluated. It should yield an object with assignable attributes; + if this is not the case, :exc:`TypeError` is raised. That object is then + asked to assign the assigned object to the given attribute; if it cannot + perform the assignment, it raises an exception (usually but not necessarily + :exc:`AttributeError`). + + .. _attr-target-note: + + Note: If the object is a class instance and the attribute reference occurs on + both sides of the assignment operator, the RHS expression, ``a.x`` can access + either an instance attribute or (if no instance attribute exists) a class + attribute. The LHS target ``a.x`` is always set as an instance attribute, + creating it if necessary. Thus, the two occurrences of ``a.x`` do not + necessarily refer to the same attribute: if the RHS expression refers to a + class attribute, the LHS creates a new instance attribute as the target of the + assignment:: + + class Cls: + x = 3 # class variable + inst = Cls() + inst.x = inst.x + 1 # writes inst.x as 4 leaving Cls.x as 3 + + This description does not necessarily apply to descriptor attributes, such as + properties created with :func:`property`. + + .. index:: + pair: subscription; assignment + object: mutable + +* If the target is a subscription: The primary expression in the reference is + evaluated. It should yield either a mutable sequence object (such as a list) + or a mapping object (such as a dictionary). Next, the subscript expression is + evaluated. + + .. index:: + object: sequence + object: list + + If the primary is a mutable sequence object (such as a list), the subscript + must yield an integer. If it is negative, the sequence's length is added to + it. The resulting value must be a nonnegative integer less than the + sequence's length, and the sequence is asked to assign the assigned object to + its item with that index. If the index is out of range, :exc:`IndexError` is + raised (assignment to a subscripted sequence cannot add new items to a list). + + .. index:: + object: mapping + object: dictionary + + If the primary is a mapping object (such as a dictionary), the subscript must + have a type compatible with the mapping's key type, and the mapping is then + asked to create a key/datum pair which maps the subscript to the assigned + object. This can either replace an existing key/value pair with the same key + value, or insert a new key/value pair (if no key with the same value existed). + + For user-defined objects, the :meth:`__setitem__` method is called with + appropriate arguments. + + .. index:: pair: slicing; assignment + +* If the target is a slicing: The primary expression in the reference is + evaluated. It should yield a mutable sequence object (such as a list). The + assigned object should be a sequence object of the same type. Next, the lower + and upper bound expressions are evaluated, insofar they are present; defaults + are zero and the sequence's length. The bounds should evaluate to integers. + If either bound is negative, the sequence's length is added to it. The + resulting bounds are clipped to lie between zero and the sequence's length, + inclusive. Finally, the sequence object is asked to replace the slice with + the items of the assigned sequence. The length of the slice may be different + from the length of the assigned sequence, thus changing the length of the + target sequence, if the target sequence allows it. + +.. impl-detail:: + + In the current implementation, the syntax for targets is taken to be the same + as for expressions, and invalid syntax is rejected during the code generation + phase, causing less detailed error messages. + +Although the definition of assignment implies that overlaps between the +left-hand side and the right-hand side are 'simultaneous' (for example ``a, b = +b, a`` swaps two variables), overlaps *within* the collection of assigned-to +variables occur left-to-right, sometimes resulting in confusion. For instance, +the following program prints ``[0, 2]``:: + + x = [0, 1] + i = 0 + i, x[i] = 1, 2 # i is updated, then x[i] is updated + print(x) + + +.. seealso:: + + :pep:`3132` - Extended Iterable Unpacking + The specification for the ``*target`` feature. + + +.. _augassign: + +Augmented assignment statements +------------------------------- + +.. index:: + pair: augmented; assignment + single: statement; assignment, augmented + single: +=; augmented assignment + single: -=; augmented assignment + single: *=; augmented assignment + single: /=; augmented assignment + single: %=; augmented assignment + single: &=; augmented assignment + single: ^=; augmented assignment + single: |=; augmented assignment + single: **=; augmented assignment + single: //=; augmented assignment + single: >>=; augmented assignment + single: <<=; augmented assignment + +Augmented assignment is the combination, in a single statement, of a binary +operation and an assignment statement: + +.. productionlist:: + augmented_assignment_stmt: `augtarget` `augop` (`expression_list` | `yield_expression`) + augtarget: `identifier` | `attributeref` | `subscription` | `slicing` + augop: "+=" | "-=" | "*=" | "@=" | "/=" | "//=" | "%=" | "**=" + : | ">>=" | "<<=" | "&=" | "^=" | "|=" + +(See section :ref:`primaries` for the syntax definitions of the last three +symbols.) + +An augmented assignment evaluates the target (which, unlike normal assignment +statements, cannot be an unpacking) and the expression list, performs the binary +operation specific to the type of assignment on the two operands, and assigns +the result to the original target. The target is only evaluated once. + +An augmented assignment expression like ``x += 1`` can be rewritten as ``x = x + +1`` to achieve a similar, but not exactly equal effect. In the augmented +version, ``x`` is only evaluated once. Also, when possible, the actual operation +is performed *in-place*, meaning that rather than creating a new object and +assigning that to the target, the old object is modified instead. + +Unlike normal assignments, augmented assignments evaluate the left-hand side +*before* evaluating the right-hand side. For example, ``a[i] += f(x)`` first +looks-up ``a[i]``, then it evaluates ``f(x)`` and performs the addition, and +lastly, it writes the result back to ``a[i]``. + +With the exception of assigning to tuples and multiple targets in a single +statement, the assignment done by augmented assignment statements is handled the +same way as normal assignments. Similarly, with the exception of the possible +*in-place* behavior, the binary operation performed by augmented assignment is +the same as the normal binary operations. + +For targets which are attribute references, the same :ref:`caveat about class +and instance attributes ` applies as for regular assignments. + + +.. _annassign: + +Annotated assignment statements +------------------------------- + +.. index:: + pair: annotated; assignment + single: statement; assignment, annotated + single: : (colon); annotated variable + +:term:`Annotation ` assignment is the combination, in a single +statement, of a variable or attribute annotation and an optional assignment statement: + +.. productionlist:: + annotated_assignment_stmt: `augtarget` ":" `expression` ["=" `expression`] + +The difference from normal :ref:`assignment` is that only single target and +only single right hand side value is allowed. + +For simple names as assignment targets, if in class or module scope, +the annotations are evaluated and stored in a special class or module +attribute :attr:`__annotations__` +that is a dictionary mapping from variable names (mangled if private) to +evaluated annotations. This attribute is writable and is automatically +created at the start of class or module body execution, if annotations +are found statically. + +For expressions as assignment targets, the annotations are evaluated if +in class or module scope, but not stored. + +If a name is annotated in a function scope, then this name is local for +that scope. Annotations are never evaluated and stored in function scopes. + +If the right hand side is present, an annotated +assignment performs the actual assignment before evaluating annotations +(where applicable). If the right hand side is not present for an expression +target, then the interpreter evaluates the target except for the last +:meth:`__setitem__` or :meth:`__setattr__` call. + +.. seealso:: + + :pep:`526` - Syntax for Variable Annotations + The proposal that added syntax for annotating the types of variables + (including class variables and instance variables), instead of expressing + them through comments. + + :pep:`484` - Type hints + The proposal that added the :mod:`typing` module to provide a standard + syntax for type annotations that can be used in static analysis tools and + IDEs. + + +.. _assert: + +The :keyword:`!assert` statement +================================ + +.. index:: + ! statement: assert + pair: debugging; assertions + single: , (comma); expression list + +Assert statements are a convenient way to insert debugging assertions into a +program: + +.. productionlist:: + assert_stmt: "assert" `expression` ["," `expression`] + +The simple form, ``assert expression``, is equivalent to :: + + if __debug__: + if not expression: raise AssertionError + +The extended form, ``assert expression1, expression2``, is equivalent to :: + + if __debug__: + if not expression1: raise AssertionError(expression2) + +.. index:: + single: __debug__ + exception: AssertionError + +These equivalences assume that :const:`__debug__` and :exc:`AssertionError` refer to +the built-in variables with those names. In the current implementation, the +built-in variable :const:`__debug__` is ``True`` under normal circumstances, +``False`` when optimization is requested (command line option :option:`-O`). The current +code generator emits no code for an assert statement when optimization is +requested at compile time. Note that it is unnecessary to include the source +code for the expression that failed in the error message; it will be displayed +as part of the stack trace. + +Assignments to :const:`__debug__` are illegal. The value for the built-in variable +is determined when the interpreter starts. + + +.. _pass: + +The :keyword:`!pass` statement +============================== + +.. index:: + statement: pass + pair: null; operation + pair: null; operation + +.. productionlist:: + pass_stmt: "pass" + +:keyword:`pass` is a null operation --- when it is executed, nothing happens. +It is useful as a placeholder when a statement is required syntactically, but no +code needs to be executed, for example:: + + def f(arg): pass # a function that does nothing (yet) + + class C: pass # a class with no methods (yet) + + +.. _del: + +The :keyword:`!del` statement +============================= + +.. index:: + ! statement: del + pair: deletion; target + triple: deletion; target; list + +.. productionlist:: + del_stmt: "del" `target_list` + +Deletion is recursively defined very similar to the way assignment is defined. +Rather than spelling it out in full details, here are some hints. + +Deletion of a target list recursively deletes each target, from left to right. + +.. index:: + statement: global + pair: unbinding; name + +Deletion of a name removes the binding of that name from the local or global +namespace, depending on whether the name occurs in a :keyword:`global` statement +in the same code block. If the name is unbound, a :exc:`NameError` exception +will be raised. + +.. index:: pair: attribute; deletion + +Deletion of attribute references, subscriptions and slicings is passed to the +primary object involved; deletion of a slicing is in general equivalent to +assignment of an empty slice of the right type (but even this is determined by +the sliced object). + +.. versionchanged:: 3.2 + Previously it was illegal to delete a name from the local namespace if it + occurs as a free variable in a nested block. + + +.. _return: + +The :keyword:`!return` statement +================================ + +.. index:: + ! statement: return + pair: function; definition + pair: class; definition + +.. productionlist:: + return_stmt: "return" [`expression_list`] + +:keyword:`return` may only occur syntactically nested in a function definition, +not within a nested class definition. + +If an expression list is present, it is evaluated, else ``None`` is substituted. + +:keyword:`return` leaves the current function call with the expression list (or +``None``) as return value. + +.. index:: keyword: finally + +When :keyword:`return` passes control out of a :keyword:`try` statement with a +:keyword:`finally` clause, that :keyword:`!finally` clause is executed before +really leaving the function. + +In a generator function, the :keyword:`return` statement indicates that the +generator is done and will cause :exc:`StopIteration` to be raised. The returned +value (if any) is used as an argument to construct :exc:`StopIteration` and +becomes the :attr:`StopIteration.value` attribute. + +In an asynchronous generator function, an empty :keyword:`return` statement +indicates that the asynchronous generator is done and will cause +:exc:`StopAsyncIteration` to be raised. A non-empty :keyword:`!return` +statement is a syntax error in an asynchronous generator function. + +.. _yield: + +The :keyword:`!yield` statement +=============================== + +.. index:: + statement: yield + single: generator; function + single: generator; iterator + single: function; generator + exception: StopIteration + +.. productionlist:: + yield_stmt: `yield_expression` + +A :keyword:`yield` statement is semantically equivalent to a :ref:`yield +expression `. The yield statement can be used to omit the parentheses +that would otherwise be required in the equivalent yield expression +statement. For example, the yield statements :: + + yield + yield from + +are equivalent to the yield expression statements :: + + (yield ) + (yield from ) + +Yield expressions and statements are only used when defining a :term:`generator` +function, and are only used in the body of the generator function. Using yield +in a function definition is sufficient to cause that definition to create a +generator function instead of a normal function. + +For full details of :keyword:`yield` semantics, refer to the +:ref:`yieldexpr` section. + +.. _raise: + +The :keyword:`!raise` statement +=============================== + +.. index:: + ! statement: raise + single: exception + pair: raising; exception + single: __traceback__ (exception attribute) + +.. productionlist:: + raise_stmt: "raise" [`expression` ["from" `expression`]] + +If no expressions are present, :keyword:`raise` re-raises the last exception +that was active in the current scope. If no exception is active in the current +scope, a :exc:`RuntimeError` exception is raised indicating that this is an +error. + +Otherwise, :keyword:`raise` evaluates the first expression as the exception +object. It must be either a subclass or an instance of :class:`BaseException`. +If it is a class, the exception instance will be obtained when needed by +instantiating the class with no arguments. + +The :dfn:`type` of the exception is the exception instance's class, the +:dfn:`value` is the instance itself. + +.. index:: object: traceback + +A traceback object is normally created automatically when an exception is raised +and attached to it as the :attr:`__traceback__` attribute, which is writable. +You can create an exception and set your own traceback in one step using the +:meth:`with_traceback` exception method (which returns the same exception +instance, with its traceback set to its argument), like so:: + + raise Exception("foo occurred").with_traceback(tracebackobj) + +.. index:: pair: exception; chaining + __cause__ (exception attribute) + __context__ (exception attribute) + +The ``from`` clause is used for exception chaining: if given, the second +*expression* must be another exception class or instance, which will then be +attached to the raised exception as the :attr:`__cause__` attribute (which is +writable). If the raised exception is not handled, both exceptions will be +printed:: + + >>> try: + ... print(1 / 0) + ... except Exception as exc: + ... raise RuntimeError("Something bad happened") from exc + ... + Traceback (most recent call last): + File "", line 2, in + ZeroDivisionError: division by zero + + The above exception was the direct cause of the following exception: + + Traceback (most recent call last): + File "", line 4, in + RuntimeError: Something bad happened + +A similar mechanism works implicitly if an exception is raised inside an +exception handler or a :keyword:`finally` clause: the previous exception is then +attached as the new exception's :attr:`__context__` attribute:: + + >>> try: + ... print(1 / 0) + ... except: + ... raise RuntimeError("Something bad happened") + ... + Traceback (most recent call last): + File "", line 2, in + ZeroDivisionError: division by zero + + During handling of the above exception, another exception occurred: + + Traceback (most recent call last): + File "", line 4, in + RuntimeError: Something bad happened + +Exception chaining can be explicitly suppressed by specifying :const:`None` in +the ``from`` clause:: + + >>> try: + ... print(1 / 0) + ... except: + ... raise RuntimeError("Something bad happened") from None + ... + Traceback (most recent call last): + File "", line 4, in + RuntimeError: Something bad happened + +Additional information on exceptions can be found in section :ref:`exceptions`, +and information about handling exceptions is in section :ref:`try`. + +.. versionchanged:: 3.3 + :const:`None` is now permitted as ``Y`` in ``raise X from Y``. + +.. versionadded:: 3.3 + The ``__suppress_context__`` attribute to suppress automatic display of the + exception context. + +.. _break: + +The :keyword:`!break` statement +=============================== + +.. index:: + ! statement: break + statement: for + statement: while + pair: loop; statement + +.. productionlist:: + break_stmt: "break" + +:keyword:`break` may only occur syntactically nested in a :keyword:`for` or +:keyword:`while` loop, but not nested in a function or class definition within +that loop. + +.. index:: keyword: else + pair: loop control; target + +It terminates the nearest enclosing loop, skipping the optional :keyword:`!else` +clause if the loop has one. + +If a :keyword:`for` loop is terminated by :keyword:`break`, the loop control +target keeps its current value. + +.. index:: keyword: finally + +When :keyword:`break` passes control out of a :keyword:`try` statement with a +:keyword:`finally` clause, that :keyword:`!finally` clause is executed before +really leaving the loop. + + +.. _continue: + +The :keyword:`!continue` statement +================================== + +.. index:: + ! statement: continue + statement: for + statement: while + pair: loop; statement + keyword: finally + +.. productionlist:: + continue_stmt: "continue" + +:keyword:`continue` may only occur syntactically nested in a :keyword:`for` or +:keyword:`while` loop, but not nested in a function or class definition or +:keyword:`finally` clause within that loop. It continues with the next +cycle of the nearest enclosing loop. + +When :keyword:`continue` passes control out of a :keyword:`try` statement with a +:keyword:`finally` clause, that :keyword:`!finally` clause is executed before +really starting the next loop cycle. + + +.. _import: +.. _from: + +The :keyword:`!import` statement +================================ + +.. index:: + ! statement: import + single: module; importing + pair: name; binding + keyword: from + keyword: as + exception: ImportError + single: , (comma); import statement + +.. productionlist:: + import_stmt: "import" `module` ["as" `identifier`] ("," `module` ["as" `identifier`])* + : | "from" `relative_module` "import" `identifier` ["as" `identifier`] + : ("," `identifier` ["as" `identifier`])* + : | "from" `relative_module` "import" "(" `identifier` ["as" `identifier`] + : ("," `identifier` ["as" `identifier`])* [","] ")" + : | "from" `module` "import" "*" + module: (`identifier` ".")* `identifier` + relative_module: "."* `module` | "."+ + +The basic import statement (no :keyword:`from` clause) is executed in two +steps: + +#. find a module, loading and initializing it if necessary +#. define a name or names in the local namespace for the scope where + the :keyword:`import` statement occurs. + +When the statement contains multiple clauses (separated by +commas) the two steps are carried out separately for each clause, just +as though the clauses had been separated out into individual import +statements. + +The details of the first step, finding and loading modules are described in +greater detail in the section on the :ref:`import system `, +which also describes the various types of packages and modules that can +be imported, as well as all the hooks that can be used to customize +the import system. Note that failures in this step may indicate either +that the module could not be located, *or* that an error occurred while +initializing the module, which includes execution of the module's code. + +If the requested module is retrieved successfully, it will be made +available in the local namespace in one of three ways: + +.. index:: single: as; import statement + +* If the module name is followed by :keyword:`!as`, then the name + following :keyword:`!as` is bound directly to the imported module. +* If no other name is specified, and the module being imported is a top + level module, the module's name is bound in the local namespace as a + reference to the imported module +* If the module being imported is *not* a top level module, then the name + of the top level package that contains the module is bound in the local + namespace as a reference to the top level package. The imported module + must be accessed using its full qualified name rather than directly + + +.. index:: + pair: name; binding + single: from; import statement + +The :keyword:`from` form uses a slightly more complex process: + +#. find the module specified in the :keyword:`from` clause, loading and + initializing it if necessary; +#. for each of the identifiers specified in the :keyword:`import` clauses: + + #. check if the imported module has an attribute by that name + #. if not, attempt to import a submodule with that name and then + check the imported module again for that attribute + #. if the attribute is not found, :exc:`ImportError` is raised. + #. otherwise, a reference to that value is stored in the local namespace, + using the name in the :keyword:`!as` clause if it is present, + otherwise using the attribute name + +Examples:: + + import foo # foo imported and bound locally + import foo.bar.baz # foo.bar.baz imported, foo bound locally + import foo.bar.baz as fbb # foo.bar.baz imported and bound as fbb + from foo.bar import baz # foo.bar.baz imported and bound as baz + from foo import attr # foo imported and foo.attr bound as attr + +.. index:: single: * (asterisk); import statement + +If the list of identifiers is replaced by a star (``'*'``), all public +names defined in the module are bound in the local namespace for the scope +where the :keyword:`import` statement occurs. + +.. index:: single: __all__ (optional module attribute) + +The *public names* defined by a module are determined by checking the module's +namespace for a variable named ``__all__``; if defined, it must be a sequence +of strings which are names defined or imported by that module. The names +given in ``__all__`` are all considered public and are required to exist. If +``__all__`` is not defined, the set of public names includes all names found +in the module's namespace which do not begin with an underscore character +(``'_'``). ``__all__`` should contain the entire public API. It is intended +to avoid accidentally exporting items that are not part of the API (such as +library modules which were imported and used within the module). + +The wild card form of import --- ``from module import *`` --- is only allowed at +the module level. Attempting to use it in class or function definitions will +raise a :exc:`SyntaxError`. + +.. index:: + single: relative; import + +When specifying what module to import you do not have to specify the absolute +name of the module. When a module or package is contained within another +package it is possible to make a relative import within the same top package +without having to mention the package name. By using leading dots in the +specified module or package after :keyword:`from` you can specify how high to +traverse up the current package hierarchy without specifying exact names. One +leading dot means the current package where the module making the import +exists. Two dots means up one package level. Three dots is up two levels, etc. +So if you execute ``from . import mod`` from a module in the ``pkg`` package +then you will end up importing ``pkg.mod``. If you execute ``from ..subpkg2 +import mod`` from within ``pkg.subpkg1`` you will import ``pkg.subpkg2.mod``. +The specification for relative imports is contained in +the :ref:`relativeimports` section. + +:func:`importlib.import_module` is provided to support applications that +determine dynamically the modules to be loaded. + + +.. _future: + +Future statements +----------------- + +.. index:: + pair: future; statement + single: __future__; future statement + +A :dfn:`future statement` is a directive to the compiler that a particular +module should be compiled using syntax or semantics that will be available in a +specified future release of Python where the feature becomes standard. + +The future statement is intended to ease migration to future versions of Python +that introduce incompatible changes to the language. It allows use of the new +features on a per-module basis before the release in which the feature becomes +standard. + +.. productionlist:: * + future_stmt: "from" "__future__" "import" `feature` ["as" `identifier`] + : ("," `feature` ["as" `identifier`])* + : | "from" "__future__" "import" "(" `feature` ["as" `identifier`] + : ("," `feature` ["as" `identifier`])* [","] ")" + feature: `identifier` + +A future statement must appear near the top of the module. The only lines that +can appear before a future statement are: + +* the module docstring (if any), +* comments, +* blank lines, and +* other future statements. + +The only feature in Python 3.7 that requires using the future statement is +``annotations``. + +All historical features enabled by the future statement are still recognized +by Python 3. The list includes ``absolute_import``, ``division``, +``generators``, ``generator_stop``, ``unicode_literals``, +``print_function``, ``nested_scopes`` and ``with_statement``. They are +all redundant because they are always enabled, and only kept for +backwards compatibility. + +A future statement is recognized and treated specially at compile time: Changes +to the semantics of core constructs are often implemented by generating +different code. It may even be the case that a new feature introduces new +incompatible syntax (such as a new reserved word), in which case the compiler +may need to parse the module differently. Such decisions cannot be pushed off +until runtime. + +For any given release, the compiler knows which feature names have been defined, +and raises a compile-time error if a future statement contains a feature not +known to it. + +The direct runtime semantics are the same as for any import statement: there is +a standard module :mod:`__future__`, described later, and it will be imported in +the usual way at the time the future statement is executed. + +The interesting runtime semantics depend on the specific feature enabled by the +future statement. + +Note that there is nothing special about the statement:: + + import __future__ [as name] + +That is not a future statement; it's an ordinary import statement with no +special semantics or syntax restrictions. + +Code compiled by calls to the built-in functions :func:`exec` and :func:`compile` +that occur in a module :mod:`M` containing a future statement will, by default, +use the new syntax or semantics associated with the future statement. This can +be controlled by optional arguments to :func:`compile` --- see the documentation +of that function for details. + +A future statement typed at an interactive interpreter prompt will take effect +for the rest of the interpreter session. If an interpreter is started with the +:option:`-i` option, is passed a script name to execute, and the script includes +a future statement, it will be in effect in the interactive session started +after the script is executed. + +.. seealso:: + + :pep:`236` - Back to the __future__ + The original proposal for the __future__ mechanism. + + +.. _global: + +The :keyword:`!global` statement +================================ + +.. index:: + ! statement: global + triple: global; name; binding + single: , (comma); identifier list + +.. productionlist:: + global_stmt: "global" `identifier` ("," `identifier`)* + +The :keyword:`global` statement is a declaration which holds for the entire +current code block. It means that the listed identifiers are to be interpreted +as globals. It would be impossible to assign to a global variable without +:keyword:`!global`, although free variables may refer to globals without being +declared global. + +Names listed in a :keyword:`global` statement must not be used in the same code +block textually preceding that :keyword:`!global` statement. + +Names listed in a :keyword:`global` statement must not be defined as formal +parameters or in a :keyword:`for` loop control target, :keyword:`class` +definition, function definition, :keyword:`import` statement, or variable +annotation. + +.. impl-detail:: + + The current implementation does not enforce some of these restrictions, but + programs should not abuse this freedom, as future implementations may enforce + them or silently change the meaning of the program. + +.. index:: + builtin: exec + builtin: eval + builtin: compile + +**Programmer's note:** :keyword:`global` is a directive to the parser. It +applies only to code parsed at the same time as the :keyword:`!global` statement. +In particular, a :keyword:`!global` statement contained in a string or code +object supplied to the built-in :func:`exec` function does not affect the code +block *containing* the function call, and code contained in such a string is +unaffected by :keyword:`!global` statements in the code containing the function +call. The same applies to the :func:`eval` and :func:`compile` functions. + + +.. _nonlocal: + +The :keyword:`!nonlocal` statement +================================== + +.. index:: statement: nonlocal + single: , (comma); identifier list + +.. productionlist:: + nonlocal_stmt: "nonlocal" `identifier` ("," `identifier`)* + +.. XXX add when implemented + : ["=" (`target_list` "=")+ starred_expression] + : | "nonlocal" identifier augop expression_list + +The :keyword:`nonlocal` statement causes the listed identifiers to refer to +previously bound variables in the nearest enclosing scope excluding globals. +This is important because the default behavior for binding is to search the +local namespace first. The statement allows encapsulated code to rebind +variables outside of the local scope besides the global (module) scope. + +.. XXX not implemented + The :keyword:`nonlocal` statement may prepend an assignment or augmented + assignment, but not an expression. + +Names listed in a :keyword:`nonlocal` statement, unlike those listed in a +:keyword:`global` statement, must refer to pre-existing bindings in an +enclosing scope (the scope in which a new binding should be created cannot +be determined unambiguously). + +Names listed in a :keyword:`nonlocal` statement must not collide with +pre-existing bindings in the local scope. + +.. seealso:: + + :pep:`3104` - Access to Names in Outer Scopes + The specification for the :keyword:`nonlocal` statement. diff --git a/python-3.7.4-docs-html/_sources/reference/toplevel_components.rst.txt b/python-3.7.4-docs-html/_sources/reference/toplevel_components.rst.txt new file mode 100644 index 0000000..d5ffb37 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/reference/toplevel_components.rst.txt @@ -0,0 +1,107 @@ + +.. _top-level: + +******************** +Top-level components +******************** + +.. index:: single: interpreter + +The Python interpreter can get its input from a number of sources: from a script +passed to it as standard input or as program argument, typed in interactively, +from a module source file, etc. This chapter gives the syntax used in these +cases. + + +.. _programs: + +Complete Python programs +======================== + +.. index:: single: program + +.. index:: + module: sys + module: __main__ + module: builtins + +While a language specification need not prescribe how the language interpreter +is invoked, it is useful to have a notion of a complete Python program. A +complete Python program is executed in a minimally initialized environment: all +built-in and standard modules are available, but none have been initialized, +except for :mod:`sys` (various system services), :mod:`builtins` (built-in +functions, exceptions and ``None``) and :mod:`__main__`. The latter is used to +provide the local and global namespace for execution of the complete program. + +The syntax for a complete Python program is that for file input, described in +the next section. + +.. index:: + single: interactive mode + module: __main__ + +The interpreter may also be invoked in interactive mode; in this case, it does +not read and execute a complete program but reads and executes one statement +(possibly compound) at a time. The initial environment is identical to that of +a complete program; each statement is executed in the namespace of +:mod:`__main__`. + +.. index:: + single: UNIX + single: Windows + single: command line + single: standard input + +A complete program can be passed to the interpreter +in three forms: with the :option:`-c` *string* command line option, as a file +passed as the first command line argument, or as standard input. If the file +or standard input is a tty device, the interpreter enters interactive mode; +otherwise, it executes the file as a complete program. + + +.. _file-input: + +File input +========== + +All input read from non-interactive files has the same form: + +.. productionlist:: + file_input: (NEWLINE | `statement`)* + +This syntax is used in the following situations: + +* when parsing a complete Python program (from a file or from a string); + +* when parsing a module; + +* when parsing a string passed to the :func:`exec` function; + + +.. _interactive: + +Interactive input +================= + +Input in interactive mode is parsed using the following grammar: + +.. productionlist:: + interactive_input: [`stmt_list`] NEWLINE | `compound_stmt` NEWLINE + +Note that a (top-level) compound statement must be followed by a blank line in +interactive mode; this is needed to help the parser detect the end of the input. + + +.. _expression-input: + +Expression input +================ + +.. index:: single: input +.. index:: builtin: eval + +:func:`eval` is used for expression input. It ignores leading whitespace. The +string argument to :func:`eval` must have the following form: + +.. productionlist:: + eval_input: `expression_list` NEWLINE* diff --git a/python-3.7.4-docs-html/_sources/tutorial/appendix.rst.txt b/python-3.7.4-docs-html/_sources/tutorial/appendix.rst.txt new file mode 100644 index 0000000..241a812 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/tutorial/appendix.rst.txt @@ -0,0 +1,124 @@ +.. _tut-appendix: + +******** +Appendix +******** + + +.. _tut-interac: + +Interactive Mode +================ + +.. _tut-error: + +Error Handling +-------------- + +When an error occurs, the interpreter prints an error message and a stack trace. +In interactive mode, it then returns to the primary prompt; when input came from +a file, it exits with a nonzero exit status after printing the stack trace. +(Exceptions handled by an :keyword:`except` clause in a :keyword:`try` statement +are not errors in this context.) Some errors are unconditionally fatal and +cause an exit with a nonzero exit; this applies to internal inconsistencies and +some cases of running out of memory. All error messages are written to the +standard error stream; normal output from executed commands is written to +standard output. + +Typing the interrupt character (usually :kbd:`Control-C` or :kbd:`Delete`) to the primary or +secondary prompt cancels the input and returns to the primary prompt. [#]_ +Typing an interrupt while a command is executing raises the +:exc:`KeyboardInterrupt` exception, which may be handled by a :keyword:`try` +statement. + + +.. _tut-scripts: + +Executable Python Scripts +------------------------- + +On BSD'ish Unix systems, Python scripts can be made directly executable, like +shell scripts, by putting the line :: + + #!/usr/bin/env python3.5 + +(assuming that the interpreter is on the user's :envvar:`PATH`) at the beginning +of the script and giving the file an executable mode. The ``#!`` must be the +first two characters of the file. On some platforms, this first line must end +with a Unix-style line ending (``'\n'``), not a Windows (``'\r\n'``) line +ending. Note that the hash, or pound, character, ``'#'``, is used to start a +comment in Python. + +The script can be given an executable mode, or permission, using the +:program:`chmod` command. + +.. code-block:: shell-session + + $ chmod +x myscript.py + +On Windows systems, there is no notion of an "executable mode". The Python +installer automatically associates ``.py`` files with ``python.exe`` so that +a double-click on a Python file will run it as a script. The extension can +also be ``.pyw``, in that case, the console window that normally appears is +suppressed. + + +.. _tut-startup: + +The Interactive Startup File +---------------------------- + +When you use Python interactively, it is frequently handy to have some standard +commands executed every time the interpreter is started. You can do this by +setting an environment variable named :envvar:`PYTHONSTARTUP` to the name of a +file containing your start-up commands. This is similar to the :file:`.profile` +feature of the Unix shells. + +This file is only read in interactive sessions, not when Python reads commands +from a script, and not when :file:`/dev/tty` is given as the explicit source of +commands (which otherwise behaves like an interactive session). It is executed +in the same namespace where interactive commands are executed, so that objects +that it defines or imports can be used without qualification in the interactive +session. You can also change the prompts ``sys.ps1`` and ``sys.ps2`` in this +file. + +If you want to read an additional start-up file from the current directory, you +can program this in the global start-up file using code like ``if +os.path.isfile('.pythonrc.py'): exec(open('.pythonrc.py').read())``. +If you want to use the startup file in a script, you must do this explicitly +in the script:: + + import os + filename = os.environ.get('PYTHONSTARTUP') + if filename and os.path.isfile(filename): + with open(filename) as fobj: + startup_file = fobj.read() + exec(startup_file) + + +.. _tut-customize: + +The Customization Modules +------------------------- + +Python provides two hooks to let you customize it: :mod:`sitecustomize` and +:mod:`usercustomize`. To see how it works, you need first to find the location +of your user site-packages directory. Start Python and run this code:: + + >>> import site + >>> site.getusersitepackages() + '/home/user/.local/lib/python3.5/site-packages' + +Now you can create a file named :file:`usercustomize.py` in that directory and +put anything you want in it. It will affect every invocation of Python, unless +it is started with the :option:`-s` option to disable the automatic import. + +:mod:`sitecustomize` works in the same way, but is typically created by an +administrator of the computer in the global site-packages directory, and is +imported before :mod:`usercustomize`. See the documentation of the :mod:`site` +module for more details. + + +.. rubric:: Footnotes + +.. [#] A problem with the GNU Readline package may prevent this. diff --git a/python-3.7.4-docs-html/_sources/tutorial/appetite.rst.txt b/python-3.7.4-docs-html/_sources/tutorial/appetite.rst.txt new file mode 100644 index 0000000..26e5168 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/tutorial/appetite.rst.txt @@ -0,0 +1,87 @@ +.. _tut-intro: + +********************** +Whetting Your Appetite +********************** + +If you do much work on computers, eventually you find that there's some task +you'd like to automate. For example, you may wish to perform a +search-and-replace over a large number of text files, or rename and rearrange a +bunch of photo files in a complicated way. Perhaps you'd like to write a small +custom database, or a specialized GUI application, or a simple game. + +If you're a professional software developer, you may have to work with several +C/C++/Java libraries but find the usual write/compile/test/re-compile cycle is +too slow. Perhaps you're writing a test suite for such a library and find +writing the testing code a tedious task. Or maybe you've written a program that +could use an extension language, and you don't want to design and implement a +whole new language for your application. + +Python is just the language for you. + +You could write a Unix shell script or Windows batch files for some of these +tasks, but shell scripts are best at moving around files and changing text data, +not well-suited for GUI applications or games. You could write a C/C++/Java +program, but it can take a lot of development time to get even a first-draft +program. Python is simpler to use, available on Windows, Mac OS X, and Unix +operating systems, and will help you get the job done more quickly. + +Python is simple to use, but it is a real programming language, offering much +more structure and support for large programs than shell scripts or batch files +can offer. On the other hand, Python also offers much more error checking than +C, and, being a *very-high-level language*, it has high-level data types built +in, such as flexible arrays and dictionaries. Because of its more general data +types Python is applicable to a much larger problem domain than Awk or even +Perl, yet many things are at least as easy in Python as in those languages. + +Python allows you to split your program into modules that can be reused in other +Python programs. It comes with a large collection of standard modules that you +can use as the basis of your programs --- or as examples to start learning to +program in Python. Some of these modules provide things like file I/O, system +calls, sockets, and even interfaces to graphical user interface toolkits like +Tk. + +Python is an interpreted language, which can save you considerable time during +program development because no compilation and linking is necessary. The +interpreter can be used interactively, which makes it easy to experiment with +features of the language, to write throw-away programs, or to test functions +during bottom-up program development. It is also a handy desk calculator. + +Python enables programs to be written compactly and readably. Programs written +in Python are typically much shorter than equivalent C, C++, or Java programs, +for several reasons: + +* the high-level data types allow you to express complex operations in a single + statement; + +* statement grouping is done by indentation instead of beginning and ending + brackets; + +* no variable or argument declarations are necessary. + +Python is *extensible*: if you know how to program in C it is easy to add a new +built-in function or module to the interpreter, either to perform critical +operations at maximum speed, or to link Python programs to libraries that may +only be available in binary form (such as a vendor-specific graphics library). +Once you are really hooked, you can link the Python interpreter into an +application written in C and use it as an extension or command language for that +application. + +By the way, the language is named after the BBC show "Monty Python's Flying +Circus" and has nothing to do with reptiles. Making references to Monty +Python skits in documentation is not only allowed, it is encouraged! + +Now that you are all excited about Python, you'll want to examine it in some +more detail. Since the best way to learn a language is to use it, the tutorial +invites you to play with the Python interpreter as you read. + +In the next chapter, the mechanics of using the interpreter are explained. This +is rather mundane information, but essential for trying out the examples shown +later. + +The rest of the tutorial introduces various features of the Python language and +system through examples, beginning with simple expressions, statements and data +types, through functions and modules, and finally touching upon advanced +concepts like exceptions and user-defined classes. + + diff --git a/python-3.7.4-docs-html/_sources/tutorial/classes.rst.txt b/python-3.7.4-docs-html/_sources/tutorial/classes.rst.txt new file mode 100644 index 0000000..2538c31 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/tutorial/classes.rst.txt @@ -0,0 +1,922 @@ +.. _tut-classes: + +******* +Classes +******* + +Classes provide a means of bundling data and functionality together. Creating +a new class creates a new *type* of object, allowing new *instances* of that +type to be made. Each class instance can have attributes attached to it for +maintaining its state. Class instances can also have methods (defined by its +class) for modifying its state. + +Compared with other programming languages, Python's class mechanism adds classes +with a minimum of new syntax and semantics. It is a mixture of the class +mechanisms found in C++ and Modula-3. Python classes provide all the standard +features of Object Oriented Programming: the class inheritance mechanism allows +multiple base classes, a derived class can override any methods of its base +class or classes, and a method can call the method of a base class with the same +name. Objects can contain arbitrary amounts and kinds of data. As is true for +modules, classes partake of the dynamic nature of Python: they are created at +runtime, and can be modified further after creation. + +In C++ terminology, normally class members (including the data members) are +*public* (except see below :ref:`tut-private`), and all member functions are +*virtual*. As in Modula-3, there are no shorthands for referencing the object's +members from its methods: the method function is declared with an explicit first +argument representing the object, which is provided implicitly by the call. As +in Smalltalk, classes themselves are objects. This provides semantics for +importing and renaming. Unlike C++ and Modula-3, built-in types can be used as +base classes for extension by the user. Also, like in C++, most built-in +operators with special syntax (arithmetic operators, subscripting etc.) can be +redefined for class instances. + +(Lacking universally accepted terminology to talk about classes, I will make +occasional use of Smalltalk and C++ terms. I would use Modula-3 terms, since +its object-oriented semantics are closer to those of Python than C++, but I +expect that few readers have heard of it.) + + +.. _tut-object: + +A Word About Names and Objects +============================== + +Objects have individuality, and multiple names (in multiple scopes) can be bound +to the same object. This is known as aliasing in other languages. This is +usually not appreciated on a first glance at Python, and can be safely ignored +when dealing with immutable basic types (numbers, strings, tuples). However, +aliasing has a possibly surprising effect on the semantics of Python code +involving mutable objects such as lists, dictionaries, and most other types. +This is usually used to the benefit of the program, since aliases behave like +pointers in some respects. For example, passing an object is cheap since only a +pointer is passed by the implementation; and if a function modifies an object +passed as an argument, the caller will see the change --- this eliminates the +need for two different argument passing mechanisms as in Pascal. + + +.. _tut-scopes: + +Python Scopes and Namespaces +============================ + +Before introducing classes, I first have to tell you something about Python's +scope rules. Class definitions play some neat tricks with namespaces, and you +need to know how scopes and namespaces work to fully understand what's going on. +Incidentally, knowledge about this subject is useful for any advanced Python +programmer. + +Let's begin with some definitions. + +A *namespace* is a mapping from names to objects. Most namespaces are currently +implemented as Python dictionaries, but that's normally not noticeable in any +way (except for performance), and it may change in the future. Examples of +namespaces are: the set of built-in names (containing functions such as :func:`abs`, and +built-in exception names); the global names in a module; and the local names in +a function invocation. In a sense the set of attributes of an object also form +a namespace. The important thing to know about namespaces is that there is +absolutely no relation between names in different namespaces; for instance, two +different modules may both define a function ``maximize`` without confusion --- +users of the modules must prefix it with the module name. + +By the way, I use the word *attribute* for any name following a dot --- for +example, in the expression ``z.real``, ``real`` is an attribute of the object +``z``. Strictly speaking, references to names in modules are attribute +references: in the expression ``modname.funcname``, ``modname`` is a module +object and ``funcname`` is an attribute of it. In this case there happens to be +a straightforward mapping between the module's attributes and the global names +defined in the module: they share the same namespace! [#]_ + +Attributes may be read-only or writable. In the latter case, assignment to +attributes is possible. Module attributes are writable: you can write +``modname.the_answer = 42``. Writable attributes may also be deleted with the +:keyword:`del` statement. For example, ``del modname.the_answer`` will remove +the attribute :attr:`the_answer` from the object named by ``modname``. + +Namespaces are created at different moments and have different lifetimes. The +namespace containing the built-in names is created when the Python interpreter +starts up, and is never deleted. The global namespace for a module is created +when the module definition is read in; normally, module namespaces also last +until the interpreter quits. The statements executed by the top-level +invocation of the interpreter, either read from a script file or interactively, +are considered part of a module called :mod:`__main__`, so they have their own +global namespace. (The built-in names actually also live in a module; this is +called :mod:`builtins`.) + +The local namespace for a function is created when the function is called, and +deleted when the function returns or raises an exception that is not handled +within the function. (Actually, forgetting would be a better way to describe +what actually happens.) Of course, recursive invocations each have their own +local namespace. + +A *scope* is a textual region of a Python program where a namespace is directly +accessible. "Directly accessible" here means that an unqualified reference to a +name attempts to find the name in the namespace. + +Although scopes are determined statically, they are used dynamically. At any +time during execution, there are at least three nested scopes whose namespaces +are directly accessible: + +* the innermost scope, which is searched first, contains the local names +* the scopes of any enclosing functions, which are searched starting with the + nearest enclosing scope, contains non-local, but also non-global names +* the next-to-last scope contains the current module's global names +* the outermost scope (searched last) is the namespace containing built-in names + +If a name is declared global, then all references and assignments go directly to +the middle scope containing the module's global names. To rebind variables +found outside of the innermost scope, the :keyword:`nonlocal` statement can be +used; if not declared nonlocal, those variables are read-only (an attempt to +write to such a variable will simply create a *new* local variable in the +innermost scope, leaving the identically named outer variable unchanged). + +Usually, the local scope references the local names of the (textually) current +function. Outside functions, the local scope references the same namespace as +the global scope: the module's namespace. Class definitions place yet another +namespace in the local scope. + +It is important to realize that scopes are determined textually: the global +scope of a function defined in a module is that module's namespace, no matter +from where or by what alias the function is called. On the other hand, the +actual search for names is done dynamically, at run time --- however, the +language definition is evolving towards static name resolution, at "compile" +time, so don't rely on dynamic name resolution! (In fact, local variables are +already determined statically.) + +A special quirk of Python is that -- if no :keyword:`global` statement is in +effect -- assignments to names always go into the innermost scope. Assignments +do not copy data --- they just bind names to objects. The same is true for +deletions: the statement ``del x`` removes the binding of ``x`` from the +namespace referenced by the local scope. In fact, all operations that introduce +new names use the local scope: in particular, :keyword:`import` statements and +function definitions bind the module or function name in the local scope. + +The :keyword:`global` statement can be used to indicate that particular +variables live in the global scope and should be rebound there; the +:keyword:`nonlocal` statement indicates that particular variables live in +an enclosing scope and should be rebound there. + +.. _tut-scopeexample: + +Scopes and Namespaces Example +----------------------------- + +This is an example demonstrating how to reference the different scopes and +namespaces, and how :keyword:`global` and :keyword:`nonlocal` affect variable +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) + do_nonlocal() + print("After nonlocal assignment:", spam) + do_global() + print("After global assignment:", spam) + + scope_test() + print("In global scope:", spam) + +The output of the example code is: + +.. code-block:: none + + After local assignment: test spam + After nonlocal assignment: nonlocal spam + After global assignment: nonlocal spam + In global scope: global spam + +Note how the *local* assignment (which is default) didn't change *scope_test*\'s +binding of *spam*. The :keyword:`nonlocal` assignment changed *scope_test*\'s +binding of *spam*, and the :keyword:`global` assignment changed the module-level +binding. + +You can also see that there was no previous binding for *spam* before the +:keyword:`global` assignment. + + +.. _tut-firstclasses: + +A First Look at Classes +======================= + +Classes introduce a little bit of new syntax, three new object types, and some +new semantics. + + +.. _tut-classdefinition: + +Class Definition Syntax +----------------------- + +The simplest form of class definition looks like this:: + + class ClassName: + + . + . + . + + +Class definitions, like function definitions (:keyword:`def` statements) must be +executed before they have any effect. (You could conceivably place a class +definition in a branch of an :keyword:`if` statement, or inside a function.) + +In practice, the statements inside a class definition will usually be function +definitions, but other statements are allowed, and sometimes useful --- we'll +come back to this later. The function definitions inside a class normally have +a peculiar form of argument list, dictated by the calling conventions for +methods --- again, this is explained later. + +When a class definition is entered, a new namespace is created, and used as the +local scope --- thus, all assignments to local variables go into this new +namespace. In particular, function definitions bind the name of the new +function here. + +When a class definition is left normally (via the end), a *class object* is +created. This is basically a wrapper around the contents of the namespace +created by the class definition; we'll learn more about class objects in the +next section. The original local scope (the one in effect just before the class +definition was entered) is reinstated, and the class object is bound here to the +class name given in the class definition header (:class:`ClassName` in the +example). + + +.. _tut-classobjects: + +Class Objects +------------- + +Class objects support two kinds of operations: attribute references and +instantiation. + +*Attribute references* use the standard syntax used for all attribute references +in Python: ``obj.name``. Valid attribute names are all the names that were in +the class's namespace when the class object was created. So, if the class +definition looked like this:: + + class MyClass: + """A simple example class""" + i = 12345 + + def f(self): + return 'hello world' + +then ``MyClass.i`` and ``MyClass.f`` are valid attribute references, returning +an integer and a function object, respectively. Class attributes can also be +assigned to, so you can change the value of ``MyClass.i`` by assignment. +:attr:`__doc__` is also a valid attribute, returning the docstring belonging to +the class: ``"A simple example class"``. + +Class *instantiation* uses function notation. Just pretend that the class +object is a parameterless function that returns a new instance of the class. +For example (assuming the above class):: + + x = MyClass() + +creates a new *instance* of the class and assigns this object to the local +variable ``x``. + +The instantiation operation ("calling" a class object) creates an empty object. +Many classes like to create objects with instances customized to a specific +initial state. Therefore a class may define a special method named +:meth:`__init__`, like this:: + + def __init__(self): + self.data = [] + +When a class defines an :meth:`__init__` method, class instantiation +automatically invokes :meth:`__init__` for the newly-created class instance. So +in this example, a new, initialized instance can be obtained by:: + + x = MyClass() + +Of course, the :meth:`__init__` method may have arguments for greater +flexibility. In that case, arguments given to the class instantiation operator +are passed on to :meth:`__init__`. For example, :: + + >>> class Complex: + ... def __init__(self, realpart, imagpart): + ... self.r = realpart + ... self.i = imagpart + ... + >>> x = Complex(3.0, -4.5) + >>> x.r, x.i + (3.0, -4.5) + + +.. _tut-instanceobjects: + +Instance Objects +---------------- + +Now what can we do with instance objects? The only operations understood by +instance objects are attribute references. There are two kinds of valid +attribute names, data attributes and methods. + +*data attributes* correspond to "instance variables" in Smalltalk, and to "data +members" in C++. Data attributes need not be declared; like local variables, +they spring into existence when they are first assigned to. For example, if +``x`` is the instance of :class:`MyClass` created above, the following piece of +code will print the value ``16``, without leaving a trace:: + + x.counter = 1 + while x.counter < 10: + x.counter = x.counter * 2 + print(x.counter) + del x.counter + +The other kind of instance attribute reference is a *method*. A method is a +function that "belongs to" an object. (In Python, the term method is not unique +to class instances: other object types can have methods as well. For example, +list objects have methods called append, insert, remove, sort, and so on. +However, in the following discussion, we'll use the term method exclusively to +mean methods of class instance objects, unless explicitly stated otherwise.) + +.. index:: object: method + +Valid method names of an instance object depend on its class. By definition, +all attributes of a class that are function objects define corresponding +methods of its instances. So in our example, ``x.f`` is a valid method +reference, since ``MyClass.f`` is a function, but ``x.i`` is not, since +``MyClass.i`` is not. But ``x.f`` is not the same thing as ``MyClass.f`` --- it +is a *method object*, not a function object. + + +.. _tut-methodobjects: + +Method Objects +-------------- + +Usually, a method is called right after it is bound:: + + x.f() + +In the :class:`MyClass` example, this will return the string ``'hello world'``. +However, it is not necessary to call a method right away: ``x.f`` is a method +object, and can be stored away and called at a later time. For example:: + + xf = x.f + while True: + print(xf()) + +will continue to print ``hello world`` until the end of time. + +What exactly happens when a method is called? You may have noticed that +``x.f()`` was called without an argument above, even though the function +definition for :meth:`f` specified an argument. What happened to the argument? +Surely Python raises an exception when a function that requires an argument is +called without any --- even if the argument isn't actually used... + +Actually, you may have guessed the answer: the special thing about methods is +that the instance object is passed as the first argument of the function. In our +example, the call ``x.f()`` is exactly equivalent to ``MyClass.f(x)``. In +general, calling a method with a list of *n* arguments is equivalent to calling +the corresponding function with an argument list that is created by inserting +the method's instance object before the first argument. + +If you still don't understand how methods work, a look at the implementation can +perhaps clarify matters. When a non-data attribute of an instance is +referenced, the instance's class is searched. If the name denotes a valid class +attribute that is a function object, a method object is created by packing +(pointers to) the instance object and the function object just found together in +an abstract object: this is the method object. When the method object is called +with an argument list, a new argument list is constructed from the instance +object and the argument list, and the function object is called with this new +argument list. + + +.. _tut-class-and-instance-variables: + +Class and Instance Variables +---------------------------- + +Generally speaking, instance variables are for data unique to each instance +and class variables are for attributes and methods shared by all instances +of the class:: + + class Dog: + + kind = 'canine' # class variable shared by all instances + + def __init__(self, name): + self.name = name # instance variable unique to each instance + + >>> d = Dog('Fido') + >>> e = Dog('Buddy') + >>> d.kind # shared by all dogs + 'canine' + >>> e.kind # shared by all dogs + 'canine' + >>> d.name # unique to d + 'Fido' + >>> e.name # unique to e + 'Buddy' + +As discussed in :ref:`tut-object`, shared data can have possibly surprising +effects with involving :term:`mutable` objects such as lists and dictionaries. +For example, the *tricks* list in the following code should not be used as a +class variable because just a single list would be shared by all *Dog* +instances:: + + class Dog: + + tricks = [] # mistaken use of a class variable + + def __init__(self, name): + self.name = name + + def add_trick(self, trick): + self.tricks.append(trick) + + >>> d = Dog('Fido') + >>> e = Dog('Buddy') + >>> d.add_trick('roll over') + >>> e.add_trick('play dead') + >>> d.tricks # unexpectedly shared by all dogs + ['roll over', 'play dead'] + +Correct design of the class should use an instance variable instead:: + + class Dog: + + def __init__(self, name): + self.name = name + self.tricks = [] # creates a new empty list for each dog + + def add_trick(self, trick): + self.tricks.append(trick) + + >>> d = Dog('Fido') + >>> e = Dog('Buddy') + >>> d.add_trick('roll over') + >>> e.add_trick('play dead') + >>> d.tricks + ['roll over'] + >>> e.tricks + ['play dead'] + + +.. _tut-remarks: + +Random Remarks +============== + +.. These should perhaps be placed more carefully... + +Data attributes override method attributes with the same name; to avoid +accidental name conflicts, which may cause hard-to-find bugs in large programs, +it is wise to use some kind of convention that minimizes the chance of +conflicts. Possible conventions include capitalizing method names, prefixing +data attribute names with a small unique string (perhaps just an underscore), or +using verbs for methods and nouns for data attributes. + +Data attributes may be referenced by methods as well as by ordinary users +("clients") of an object. In other words, classes are not usable to implement +pure abstract data types. In fact, nothing in Python makes it possible to +enforce data hiding --- it is all based upon convention. (On the other hand, +the Python implementation, written in C, can completely hide implementation +details and control access to an object if necessary; this can be used by +extensions to Python written in C.) + +Clients should use data attributes with care --- clients may mess up invariants +maintained by the methods by stamping on their data attributes. Note that +clients may add data attributes of their own to an instance object without +affecting the validity of the methods, as long as name conflicts are avoided --- +again, a naming convention can save a lot of headaches here. + +There is no shorthand for referencing data attributes (or other methods!) from +within methods. I find that this actually increases the readability of methods: +there is no chance of confusing local variables and instance variables when +glancing through a method. + +Often, the first argument of a method is called ``self``. This is nothing more +than a convention: the name ``self`` has absolutely no special meaning to +Python. Note, however, that by not following the convention your code may be +less readable to other Python programmers, and it is also conceivable that a +*class browser* program might be written that relies upon such a convention. + +Any function object that is a class attribute defines a method for instances of +that class. It is not necessary that the function definition is textually +enclosed in the class definition: assigning a function object to a local +variable in the class is also ok. For example:: + + # Function defined outside the class + def f1(self, x, y): + return min(x, x+y) + + 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 +function objects, and consequently they are all methods of instances of +:class:`C` --- ``h`` being exactly equivalent to ``g``. Note that this practice +usually only serves to confuse the reader of a program. + +Methods may call other methods by using method attributes of the ``self`` +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) + +Methods may reference global names in the same way as ordinary functions. The +global scope associated with a method is the module containing its +definition. (A class is never used as a global scope.) While one +rarely encounters a good reason for using global data in a method, there are +many legitimate uses of the global scope: for one thing, functions and modules +imported into the global scope can be used by methods, as well as functions and +classes defined in it. Usually, the class containing the method is itself +defined in this global scope, and in the next section we'll find some good +reasons why a method would want to reference its own class. + +Each value is an object, and therefore has a *class* (also called its *type*). +It is stored as ``object.__class__``. + + +.. _tut-inheritance: + +Inheritance +=========== + +Of course, a language feature would not be worthy of the name "class" without +supporting inheritance. The syntax for a derived class definition looks like +this:: + + class DerivedClassName(BaseClassName): + + . + . + . + + +The name :class:`BaseClassName` must be defined in a scope containing the +derived class definition. In place of a base class name, other arbitrary +expressions are also allowed. This can be useful, for example, when the base +class is defined in another module:: + + class DerivedClassName(modname.BaseClassName): + +Execution of a derived class definition proceeds the same as for a base class. +When the class object is constructed, the base class is remembered. This is +used for resolving attribute references: if a requested attribute is not found +in the class, the search proceeds to look in the base class. This rule is +applied recursively if the base class itself is derived from some other class. + +There's nothing special about instantiation of derived classes: +``DerivedClassName()`` creates a new instance of the class. Method references +are resolved as follows: the corresponding class attribute is searched, +descending down the chain of base classes if necessary, and the method reference +is valid if this yields a function object. + +Derived classes may override methods of their base classes. Because methods +have no special privileges when calling other methods of the same object, a +method of a base class that calls another method defined in the same base class +may end up calling a method of a derived class that overrides it. (For C++ +programmers: all methods in Python are effectively ``virtual``.) + +An overriding method in a derived class may in fact want to extend rather than +simply replace the base class method of the same name. There is a simple way to +call the base class method directly: just call ``BaseClassName.methodname(self, +arguments)``. This is occasionally useful to clients as well. (Note that this +only works if the base class is accessible as ``BaseClassName`` in the global +scope.) + +Python has two built-in functions that work with inheritance: + +* Use :func:`isinstance` to check an instance's type: ``isinstance(obj, int)`` + will be ``True`` only if ``obj.__class__`` is :class:`int` or some class + derived from :class:`int`. + +* Use :func:`issubclass` to check class inheritance: ``issubclass(bool, int)`` + is ``True`` since :class:`bool` is a subclass of :class:`int`. However, + ``issubclass(float, int)`` is ``False`` since :class:`float` is not a + subclass of :class:`int`. + + + +.. _tut-multiple: + +Multiple Inheritance +-------------------- + +Python supports a form of multiple inheritance as well. A class definition with +multiple base classes looks like this:: + + class DerivedClassName(Base1, Base2, Base3): + + . + . + . + + +For most purposes, in the simplest cases, you can think of the search for +attributes inherited from a parent class as depth-first, left-to-right, not +searching twice in the same class where there is an overlap in the hierarchy. +Thus, if an attribute is not found in :class:`DerivedClassName`, it is searched +for in :class:`Base1`, then (recursively) in the base classes of :class:`Base1`, +and if it was not found there, it was searched for in :class:`Base2`, and so on. + +In fact, it is slightly more complex than that; the method resolution order +changes dynamically to support cooperative calls to :func:`super`. This +approach is known in some other multiple-inheritance languages as +call-next-method and is more powerful than the super call found in +single-inheritance languages. + +Dynamic ordering is necessary because all cases of multiple inheritance exhibit +one or more diamond relationships (where at least one of the parent classes +can be accessed through multiple paths from the bottommost class). For example, +all classes inherit from :class:`object`, so any case of multiple inheritance +provides more than one path to reach :class:`object`. To keep the base classes +from being accessed more than once, the dynamic algorithm linearizes the search +order in a way that preserves the left-to-right ordering specified in each +class, that calls each parent only once, and that is monotonic (meaning that a +class can be subclassed without affecting the precedence order of its parents). +Taken together, these properties make it possible to design reliable and +extensible classes with multiple inheritance. For more detail, see +https://www.python.org/download/releases/2.3/mro/. + + +.. _tut-private: + +Private Variables +================= + +"Private" instance variables that cannot be accessed except from inside an +object don't exist in Python. However, there is a convention that is followed +by most Python code: a name prefixed with an underscore (e.g. ``_spam``) should +be treated as a non-public part of the API (whether it is a function, a method +or a data member). It should be considered an implementation detail and subject +to change without notice. + +.. index:: + pair: name; mangling + +Since there is a valid use-case for class-private members (namely to avoid name +clashes of names with names defined by subclasses), there is limited support for +such a mechanism, called :dfn:`name mangling`. Any identifier of the form +``__spam`` (at least two leading underscores, at most one trailing underscore) +is textually replaced with ``_classname__spam``, where ``classname`` is the +current class name with leading underscore(s) stripped. This mangling is done +without regard to the syntactic position of the identifier, as long as it +occurs within the definition of a class. + +Name mangling is helpful for letting subclasses override methods without +breaking intraclass method calls. For example:: + + class Mapping: + def __init__(self, iterable): + self.items_list = [] + self.__update(iterable) + + def update(self, iterable): + for item in iterable: + self.items_list.append(item) + + __update = update # private copy of original update() method + + class MappingSubclass(Mapping): + + def update(self, keys, values): + # provides new signature for update() + # but does not break __init__() + for item in zip(keys, values): + self.items_list.append(item) + +The above example would work even if ``MappingSubclass`` were to introduce a +``__update`` identifier since it is replaced with ``_Mapping__update`` in the +``Mapping`` class and ``_MappingSubclass__update`` in the ``MappingSubclass`` +class respectively. + +Note that the mangling rules are designed mostly to avoid accidents; it still is +possible to access or modify a variable that is considered private. This can +even be useful in special circumstances, such as in the debugger. + +Notice that code passed to ``exec()`` or ``eval()`` does not consider the +classname of the invoking class to be the current class; this is similar to the +effect of the ``global`` statement, the effect of which is likewise restricted +to code that is byte-compiled together. The same restriction applies to +``getattr()``, ``setattr()`` and ``delattr()``, as well as when referencing +``__dict__`` directly. + + +.. _tut-odds: + +Odds and Ends +============= + +Sometimes it is useful to have a data type similar to the Pascal "record" or C +"struct", bundling together a few named data items. An empty class definition +will do nicely:: + + class Employee: + pass + + john = Employee() # Create an empty employee record + + # Fill the fields of the record + john.name = 'John Doe' + john.dept = 'computer lab' + john.salary = 1000 + +A piece of Python code that expects a particular abstract data type can often be +passed a class that emulates the methods of that data type instead. For +instance, if you have a function that formats some data from a file object, you +can define a class with methods :meth:`read` and :meth:`!readline` that get the +data from a string buffer instead, and pass it as an argument. + +.. (Unfortunately, this technique has its limitations: a class can't define + operations that are accessed by special syntax such as sequence subscripting + or arithmetic operators, and assigning such a "pseudo-file" to sys.stdin will + not cause the interpreter to read further input from it.) + +Instance method objects have attributes, too: ``m.__self__`` is the instance +object with the method :meth:`m`, and ``m.__func__`` is the function object +corresponding to the method. + + +.. _tut-iterators: + +Iterators +========= + +By now you have probably noticed that most container objects can be looped over +using a :keyword:`for` statement:: + + for element in [1, 2, 3]: + print(element) + for element in (1, 2, 3): + print(element) + for key in {'one':1, 'two':2}: + print(key) + for char in "123": + print(char) + for line in open("myfile.txt"): + print(line, end='') + +This style of access is clear, concise, and convenient. The use of iterators +pervades and unifies Python. Behind the scenes, the :keyword:`for` statement +calls :func:`iter` on the container object. The function returns an iterator +object that defines the method :meth:`~iterator.__next__` which accesses +elements in the container one at a time. When there are no more elements, +:meth:`~iterator.__next__` raises a :exc:`StopIteration` exception which tells the +:keyword:`!for` loop to terminate. You can call the :meth:`~iterator.__next__` method +using the :func:`next` built-in function; this example shows how it all works:: + + >>> s = 'abc' + >>> it = iter(s) + >>> it + + >>> next(it) + 'a' + >>> next(it) + 'b' + >>> next(it) + 'c' + >>> next(it) + Traceback (most recent call last): + File "", line 1, in + next(it) + StopIteration + +Having seen the mechanics behind the iterator protocol, it is easy to add +iterator behavior to your classes. Define an :meth:`__iter__` method which +returns an object with a :meth:`~iterator.__next__` method. If the class +defines :meth:`__next__`, then :meth:`__iter__` can just return ``self``:: + + class Reverse: + """Iterator for looping over a sequence backwards.""" + 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 + self.index = self.index - 1 + return self.data[self.index] + +:: + + >>> rev = Reverse('spam') + >>> iter(rev) + <__main__.Reverse object at 0x00A1DB50> + >>> for char in rev: + ... print(char) + ... + m + a + p + s + + +.. _tut-generators: + +Generators +========== + +:term:`Generator`\s are a simple and powerful tool for creating iterators. They +are written like regular functions but use the :keyword:`yield` statement +whenever they want to return data. Each time :func:`next` is called on it, the +generator resumes where it left off (it remembers all the data values and which +statement was last executed). An example shows that generators can be trivially +easy to create:: + + def reverse(data): + for index in range(len(data)-1, -1, -1): + yield data[index] + +:: + + >>> for char in reverse('golf'): + ... print(char) + ... + f + l + o + g + +Anything that can be done with generators can also be done with class-based +iterators as described in the previous section. What makes generators so +compact is that the :meth:`__iter__` and :meth:`~generator.__next__` methods +are created automatically. + +Another key feature is that the local variables and execution state are +automatically saved between calls. This made the function easier to write and +much more clear than an approach using instance variables like ``self.index`` +and ``self.data``. + +In addition to automatic method creation and saving program state, when +generators terminate, they automatically raise :exc:`StopIteration`. In +combination, these features make it easy to create iterators with no more effort +than writing a regular function. + + +.. _tut-genexps: + +Generator Expressions +===================== + +Some simple generators can be coded succinctly as expressions using a syntax +similar to list comprehensions but with parentheses instead of square brackets. +These expressions are designed for situations where the generator is used right +away by an enclosing function. Generator expressions are more compact but less +versatile than full generator definitions and tend to be more memory friendly +than equivalent list comprehensions. + +Examples:: + + >>> sum(i*i for i in range(10)) # sum of squares + 285 + + >>> xvec = [10, 20, 30] + >>> yvec = [7, 5, 3] + >>> sum(x*y for x,y in zip(xvec, yvec)) # dot product + 260 + + >>> from math import pi, sin + >>> sine_table = {x: sin(x*pi/180) for x in range(0, 91)} + + >>> unique_words = set(word for line in page for word in line.split()) + + >>> valedictorian = max((student.gpa, student.name) for student in graduates) + + >>> data = 'golf' + >>> list(data[i] for i in range(len(data)-1, -1, -1)) + ['f', 'l', 'o', 'g'] + + + +.. rubric:: Footnotes + +.. [#] Except for one thing. Module objects have a secret read-only attribute called + :attr:`~object.__dict__` which returns the dictionary used to implement the module's + namespace; the name :attr:`~object.__dict__` is an attribute but not a global name. + Obviously, using this violates the abstraction of namespace implementation, and + should be restricted to things like post-mortem debuggers. diff --git a/python-3.7.4-docs-html/_sources/tutorial/controlflow.rst.txt b/python-3.7.4-docs-html/_sources/tutorial/controlflow.rst.txt new file mode 100644 index 0000000..482a343 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/tutorial/controlflow.rst.txt @@ -0,0 +1,764 @@ +.. _tut-morecontrol: + +*********************** +More Control Flow Tools +*********************** + +Besides the :keyword:`while` statement just introduced, Python knows the usual +control flow statements known from other languages, with some twists. + + +.. _tut-if: + +:keyword:`!if` Statements +========================= + +Perhaps the most well-known statement type is the :keyword:`if` statement. For +example:: + + >>> x = int(input("Please enter an integer: ")) + Please enter an integer: 42 + >>> if x < 0: + ... x = 0 + ... print('Negative changed to zero') + ... elif x == 0: + ... print('Zero') + ... elif x == 1: + ... print('Single') + ... else: + ... print('More') + ... + More + +There can be zero or more :keyword:`elif` parts, and the :keyword:`else` part is +optional. The keyword ':keyword:`!elif`' is short for 'else if', and is useful +to avoid excessive indentation. An :keyword:`!if` ... :keyword:`!elif` ... +:keyword:`!elif` ... sequence is a substitute for the ``switch`` or +``case`` statements found in other languages. + + +.. _tut-for: + +:keyword:`!for` Statements +========================== + +.. index:: + statement: for + +The :keyword:`for` statement in Python differs a bit from what you may be used +to in C or Pascal. Rather than always iterating over an arithmetic progression +of numbers (like in Pascal), or giving the user the ability to define both the +iteration step and halting condition (as C), Python's :keyword:`!for` statement +iterates over the items of any sequence (a list or a string), in the order that +they appear in the sequence. For example (no pun intended): + +.. One suggestion was to give a real C example here, but that may only serve to + confuse non-C programmers. + +:: + + >>> # Measure some strings: + ... words = ['cat', 'window', 'defenestrate'] + >>> for w in words: + ... print(w, len(w)) + ... + cat 3 + window 6 + defenestrate 12 + +If you need to modify the sequence you are iterating over while inside the loop +(for example to duplicate selected items), it is recommended that you first +make a copy. Iterating over a sequence does not implicitly make a copy. The +slice notation makes this especially convenient:: + + >>> for w in words[:]: # Loop over a slice copy of the entire list. + ... if len(w) > 6: + ... words.insert(0, w) + ... + >>> words + ['defenestrate', 'cat', 'window', 'defenestrate'] + +With ``for w in words:``, the example would attempt to create an infinite list, +inserting ``defenestrate`` over and over again. + + +.. _tut-range: + +The :func:`range` Function +========================== + +If you do need to iterate over a sequence of numbers, the built-in function +:func:`range` comes in handy. It generates arithmetic progressions:: + + >>> for i in range(5): + ... print(i) + ... + 0 + 1 + 2 + 3 + 4 + +The given end point is never part of the generated sequence; ``range(10)`` generates +10 values, the legal indices for items of a sequence of length 10. It +is possible to let the range start at another number, or to specify a different +increment (even negative; sometimes this is called the 'step'):: + + range(5, 10) + 5, 6, 7, 8, 9 + + range(0, 10, 3) + 0, 3, 6, 9 + + range(-10, -100, -30) + -10, -40, -70 + +To iterate over the indices of a sequence, you can combine :func:`range` and +:func:`len` as follows:: + + >>> a = ['Mary', 'had', 'a', 'little', 'lamb'] + >>> for i in range(len(a)): + ... print(i, a[i]) + ... + 0 Mary + 1 had + 2 a + 3 little + 4 lamb + +In most such cases, however, it is convenient to use the :func:`enumerate` +function, see :ref:`tut-loopidioms`. + +A strange thing happens if you just print a range:: + + >>> print(range(10)) + range(0, 10) + +In many ways the object returned by :func:`range` behaves as if it is a list, +but in fact it isn't. It is an object which returns the successive items of +the desired sequence when you iterate over it, but it doesn't really make +the list, thus saving space. + +We say such an object is *iterable*, that is, suitable as a target for +functions and constructs that expect something from which they can +obtain successive items until the supply is exhausted. We have seen that +the :keyword:`for` statement is such an *iterator*. The function :func:`list` +is another; it creates lists from iterables:: + + + >>> list(range(5)) + [0, 1, 2, 3, 4] + +Later we will see more functions that return iterables and take iterables as argument. + + +.. _tut-break: + +:keyword:`!break` and :keyword:`!continue` Statements, and :keyword:`!else` Clauses on Loops +============================================================================================ + +The :keyword:`break` statement, like in C, breaks out of the innermost enclosing +:keyword:`for` or :keyword:`while` loop. + +Loop statements may have an :keyword:`!else` clause; it is executed when the loop +terminates through exhaustion of the list (with :keyword:`for`) or when the +condition becomes false (with :keyword:`while`), but not when the loop is +terminated by a :keyword:`break` statement. This is exemplified by the +following loop, which searches for prime numbers:: + + >>> for n in range(2, 10): + ... for x in range(2, n): + ... if n % x == 0: + ... print(n, 'equals', x, '*', n//x) + ... break + ... else: + ... # loop fell through without finding a factor + ... print(n, 'is a prime number') + ... + 2 is a prime number + 3 is a prime number + 4 equals 2 * 2 + 5 is a prime number + 6 equals 2 * 3 + 7 is a prime number + 8 equals 2 * 4 + 9 equals 3 * 3 + +(Yes, this is the correct code. Look closely: the ``else`` clause belongs to +the :keyword:`for` loop, **not** the :keyword:`if` statement.) + +When used with a loop, the ``else`` clause has more in common with the +``else`` clause of a :keyword:`try` statement than it does that of +:keyword:`if` statements: a :keyword:`!try` statement's ``else`` clause runs +when no exception occurs, and a loop's ``else`` clause runs when no ``break`` +occurs. For more on the :keyword:`!try` statement and exceptions, see +:ref:`tut-handling`. + +The :keyword:`continue` statement, also borrowed from C, continues with the next +iteration of the loop:: + + >>> for num in range(2, 10): + ... if num % 2 == 0: + ... print("Found an even number", num) + ... continue + ... print("Found a number", num) + Found an even number 2 + Found a number 3 + Found an even number 4 + Found a number 5 + Found an even number 6 + Found a number 7 + Found an even number 8 + Found a number 9 + +.. _tut-pass: + +:keyword:`!pass` Statements +=========================== + +The :keyword:`pass` statement does nothing. It can be used when a statement is +required syntactically but the program requires no action. For example:: + + >>> while True: + ... pass # Busy-wait for keyboard interrupt (Ctrl+C) + ... + +This is commonly used for creating minimal classes:: + + >>> class MyEmptyClass: + ... pass + ... + +Another place :keyword:`pass` can be used is as a place-holder for a function or +conditional body when you are working on new code, allowing you to keep thinking +at a more abstract level. The :keyword:`!pass` is silently ignored:: + + >>> def initlog(*args): + ... pass # Remember to implement this! + ... + +.. _tut-functions: + +Defining Functions +================== + +We can create a function that writes the Fibonacci series to an arbitrary +boundary:: + + >>> def fib(n): # write Fibonacci series up to n + ... """Print a Fibonacci series up to n.""" + ... a, b = 0, 1 + ... while a < n: + ... print(a, end=' ') + ... a, b = b, a+b + ... print() + ... + >>> # Now call the function we just defined: + ... fib(2000) + 0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987 1597 + +.. index:: + single: documentation strings + single: docstrings + single: strings, documentation + +The keyword :keyword:`def` introduces a function *definition*. It must be +followed by the function name and the parenthesized list of formal parameters. +The statements that form the body of the function start at the next line, and +must be indented. + +The first statement of the function body can optionally be a string literal; +this string literal is the function's documentation string, or :dfn:`docstring`. +(More about docstrings can be found in the section :ref:`tut-docstrings`.) +There are tools which use docstrings to automatically produce online or printed +documentation, or to let the user interactively browse through code; it's good +practice to include docstrings in code that you write, so make a habit of it. + +The *execution* of a function introduces a new symbol table used for the local +variables of the function. More precisely, all variable assignments in a +function store the value in the local symbol table; whereas variable references +first look in the local symbol table, then in the local symbol tables of +enclosing functions, then in the global symbol table, and finally in the table +of built-in names. Thus, global variables and variables of enclosing functions +cannot be directly assigned a value within a function (unless, for global +variables, named in a :keyword:`global` statement, or, for variables of enclosing +functions, named in a :keyword:`nonlocal` statement), although they may be +referenced. + +The actual parameters (arguments) to a function call are introduced in the local +symbol table of the called function when it is called; thus, arguments are +passed using *call by value* (where the *value* is always an object *reference*, +not the value of the object). [#]_ When a function calls another function, a new +local symbol table is created for that call. + +A function definition introduces the function name in the current symbol table. +The value of the function name has a type that is recognized by the interpreter +as a user-defined function. This value can be assigned to another name which +can then also be used as a function. This serves as a general renaming +mechanism:: + + >>> fib + + >>> f = fib + >>> f(100) + 0 1 1 2 3 5 8 13 21 34 55 89 + +Coming from other languages, you might object that ``fib`` is not a function but +a procedure since it doesn't return a value. In fact, even functions without a +:keyword:`return` statement do return a value, albeit a rather boring one. This +value is called ``None`` (it's a built-in name). Writing the value ``None`` is +normally suppressed by the interpreter if it would be the only value written. +You can see it if you really want to using :func:`print`:: + + >>> fib(0) + >>> print(fib(0)) + None + +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 + ... """Return a list containing the Fibonacci series up to n.""" + ... result = [] + ... a, b = 0, 1 + ... while a < n: + ... result.append(a) # see below + ... a, b = b, a+b + ... return result + ... + >>> f100 = fib2(100) # call it + >>> f100 # write the result + [0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89] + +This example, as usual, demonstrates some new Python features: + +* The :keyword:`return` statement returns with a value from a function. + :keyword:`!return` without an expression argument returns ``None``. Falling off + the end of a function also returns ``None``. + +* The statement ``result.append(a)`` calls a *method* of the list object + ``result``. A method is a function that 'belongs' to an object and is named + ``obj.methodname``, where ``obj`` is some object (this may be an expression), + and ``methodname`` is the name of a method that is defined by the object's type. + Different types define different methods. Methods of different types may have + the same name without causing ambiguity. (It is possible to define your own + object types and methods, using *classes*, see :ref:`tut-classes`) + The method :meth:`append` shown in the example is defined for list objects; it + adds a new element at the end of the list. In this example it is equivalent to + ``result = result + [a]``, but more efficient. + + +.. _tut-defining: + +More on Defining Functions +========================== + +It is also possible to define functions with a variable number of arguments. +There are three forms, which can be combined. + + +.. _tut-defaultargs: + +Default Argument Values +----------------------- + +The most useful form is to specify a default value for one or more arguments. +This creates a function that can be called with fewer arguments than it is +defined to allow. For example:: + + def ask_ok(prompt, retries=4, reminder='Please try again!'): + while True: + ok = input(prompt) + if ok in ('y', 'ye', 'yes'): + return True + if ok in ('n', 'no', 'nop', 'nope'): + return False + retries = retries - 1 + if retries < 0: + raise ValueError('invalid user response') + print(reminder) + +This function can be called in several ways: + +* giving only the mandatory argument: + ``ask_ok('Do you really want to quit?')`` +* giving one of the optional arguments: + ``ask_ok('OK to overwrite the file?', 2)`` +* or even giving all arguments: + ``ask_ok('OK to overwrite the file?', 2, 'Come on, only yes or no!')`` + +This example also introduces the :keyword:`in` keyword. This tests whether or +not a sequence contains a certain value. + +The default values are evaluated at the point of function definition in the +*defining* scope, so that :: + + i = 5 + + def f(arg=i): + print(arg) + + i = 6 + f() + +will print ``5``. + +**Important warning:** The default value is evaluated only once. This makes a +difference when the default is a mutable object such as a list, dictionary, or +instances of most classes. For example, the following function accumulates the +arguments passed to it on subsequent calls:: + + def f(a, L=[]): + L.append(a) + return L + + print(f(1)) + print(f(2)) + print(f(3)) + +This will print :: + + [1] + [1, 2] + [1, 2, 3] + +If you don't want the default to be shared between subsequent calls, you can +write the function like this instead:: + + def f(a, L=None): + if L is None: + L = [] + L.append(a) + return L + + +.. _tut-keywordargs: + +Keyword Arguments +----------------- + +Functions can also be called using :term:`keyword arguments ` +of the form ``kwarg=value``. For instance, the following function:: + + def parrot(voltage, state='a stiff', action='voom', type='Norwegian Blue'): + print("-- This parrot wouldn't", action, end=' ') + print("if you put", voltage, "volts through it.") + print("-- Lovely plumage, the", type) + print("-- It's", state, "!") + +accepts one required argument (``voltage``) and three optional arguments +(``state``, ``action``, and ``type``). This function can be called in any +of the following ways:: + + parrot(1000) # 1 positional argument + parrot(voltage=1000) # 1 keyword argument + parrot(voltage=1000000, action='VOOOOOM') # 2 keyword arguments + parrot(action='VOOOOOM', voltage=1000000) # 2 keyword arguments + parrot('a million', 'bereft of life', 'jump') # 3 positional arguments + parrot('a thousand', state='pushing up the daisies') # 1 positional, 1 keyword + +but all the following calls would be invalid:: + + parrot() # required argument missing + parrot(voltage=5.0, 'dead') # non-keyword argument after a keyword argument + parrot(110, voltage=220) # duplicate value for the same argument + parrot(actor='John Cleese') # unknown keyword argument + +In a function call, keyword arguments must follow positional arguments. +All the keyword arguments passed must match one of the arguments +accepted by the function (e.g. ``actor`` is not a valid argument for the +``parrot`` function), and their order is not important. This also includes +non-optional arguments (e.g. ``parrot(voltage=1000)`` is valid too). +No argument may receive a value more than once. +Here's an example that fails due to this restriction:: + + >>> def function(a): + ... pass + ... + >>> function(0, a=0) + Traceback (most recent call last): + File "", line 1, in + TypeError: function() got multiple values for keyword argument 'a' + +When a final formal parameter of the form ``**name`` is present, it receives a +dictionary (see :ref:`typesmapping`) containing all keyword arguments except for +those corresponding to a formal parameter. This may be combined with a formal +parameter of the form ``*name`` (described in the next subsection) which +receives a :ref:`tuple ` containing the positional +arguments beyond the formal parameter list. (``*name`` must occur +before ``**name``.) For example, if we define a function like this:: + + def cheeseshop(kind, *arguments, **keywords): + print("-- Do you have any", kind, "?") + print("-- I'm sorry, we're all out of", kind) + for arg in arguments: + print(arg) + print("-" * 40) + for kw in keywords: + print(kw, ":", keywords[kw]) + +It could be called like this:: + + cheeseshop("Limburger", "It's very runny, sir.", + "It's really very, VERY runny, sir.", + shopkeeper="Michael Palin", + client="John Cleese", + sketch="Cheese Shop Sketch") + +and of course it would print: + +.. code-block:: none + + -- Do you have any Limburger ? + -- I'm sorry, we're all out of Limburger + It's very runny, sir. + It's really very, VERY runny, sir. + ---------------------------------------- + shopkeeper : Michael Palin + client : John Cleese + sketch : Cheese Shop Sketch + +Note that the order in which the keyword arguments are printed is guaranteed +to match the order in which they were provided in the function call. + + +.. _tut-arbitraryargs: + +Arbitrary Argument Lists +------------------------ + +.. index:: + single: * (asterisk); in function calls + +Finally, the least frequently used option is to specify that a function can be +called with an arbitrary number of arguments. These arguments will be wrapped +up in a tuple (see :ref:`tut-tuples`). Before the variable number of arguments, +zero or more normal arguments may occur. :: + + def write_multiple_items(file, separator, *args): + file.write(separator.join(args)) + + +Normally, these ``variadic`` arguments will be last in the list of formal +parameters, because they scoop up all remaining input arguments that are +passed to the function. Any formal parameters which occur after the ``*args`` +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) + ... + >>> concat("earth", "mars", "venus") + 'earth/mars/venus' + >>> concat("earth", "mars", "venus", sep=".") + 'earth.mars.venus' + +.. _tut-unpacking-arguments: + +Unpacking Argument Lists +------------------------ + +The reverse situation occurs when the arguments are already in a list or tuple +but need to be unpacked for a function call requiring separate positional +arguments. For instance, the built-in :func:`range` function expects separate +*start* and *stop* arguments. If they are not available separately, write the +function call with the ``*`` operator to unpack the arguments out of a list +or tuple:: + + >>> list(range(3, 6)) # normal call with separate arguments + [3, 4, 5] + >>> args = [3, 6] + >>> list(range(*args)) # call with arguments unpacked from a list + [3, 4, 5] + +.. index:: + single: **; in function calls + +In the same fashion, dictionaries can deliver keyword arguments with the +``**`` operator:: + + >>> def parrot(voltage, state='a stiff', action='voom'): + ... print("-- This parrot wouldn't", action, end=' ') + ... print("if you put", voltage, "volts through it.", end=' ') + ... print("E's", state, "!") + ... + >>> d = {"voltage": "four million", "state": "bleedin' demised", "action": "VOOM"} + >>> parrot(**d) + -- This parrot wouldn't VOOM if you put four million volts through it. E's bleedin' demised ! + + +.. _tut-lambda: + +Lambda Expressions +------------------ + +Small anonymous functions can be created with the :keyword:`lambda` keyword. +This function returns the sum of its two arguments: ``lambda a, b: a+b``. +Lambda functions can be used wherever function objects are required. They are +syntactically restricted to a single expression. Semantically, they are just +syntactic sugar for a normal function definition. Like nested function +definitions, lambda functions can reference variables from the containing +scope:: + + >>> def make_incrementor(n): + ... return lambda x: x + n + ... + >>> f = make_incrementor(42) + >>> f(0) + 42 + >>> f(1) + 43 + +The above example uses a lambda expression to return a function. Another use +is to pass a small function as an argument:: + + >>> pairs = [(1, 'one'), (2, 'two'), (3, 'three'), (4, 'four')] + >>> pairs.sort(key=lambda pair: pair[1]) + >>> pairs + [(4, 'four'), (1, 'one'), (3, 'three'), (2, 'two')] + + +.. _tut-docstrings: + +Documentation Strings +--------------------- + +.. index:: + single: docstrings + single: documentation strings + single: strings, documentation + +Here are some conventions about the content and formatting of documentation +strings. + +The first line should always be a short, concise summary of the object's +purpose. For brevity, it should not explicitly state the object's name or type, +since these are available by other means (except if the name happens to be a +verb describing a function's operation). This line should begin with a capital +letter and end with a period. + +If there are more lines in the documentation string, the second line should be +blank, visually separating the summary from the rest of the description. The +following lines should be one or more paragraphs describing the object's calling +conventions, its side effects, etc. + +The Python parser does not strip indentation from multi-line string literals in +Python, so tools that process documentation have to strip indentation if +desired. This is done using the following convention. The first non-blank line +*after* the first line of the string determines the amount of indentation for +the entire documentation string. (We can't use the first line since it is +generally adjacent to the string's opening quotes so its indentation is not +apparent in the string literal.) Whitespace "equivalent" to this indentation is +then stripped from the start of all lines of the string. Lines that are +indented less should not occur, but if they occur all their leading whitespace +should be stripped. Equivalence of whitespace should be tested after expansion +of tabs (to 8 spaces, normally). + +Here is an example of a multi-line docstring:: + + >>> def my_function(): + ... """Do nothing, but document it. + ... + ... No, really, it doesn't do anything. + ... """ + ... pass + ... + >>> print(my_function.__doc__) + Do nothing, but document it. + + No, really, it doesn't do anything. + + +.. _tut-annotations: + +Function Annotations +-------------------- + +.. sectionauthor:: Zachary Ware +.. index:: + pair: function; annotations + single: ->; function annotations + single: : (colon); function annotations + +:ref:`Function annotations ` are completely optional metadata +information about the types used by user-defined functions (see :pep:`3107` and +:pep:`484` for more information). + +:term:`Annotations ` are stored in the :attr:`__annotations__` +attribute of the function as a dictionary and have no effect on any other part of the +function. Parameter annotations are defined by a colon after the parameter name, followed +by an expression evaluating to the value of the annotation. Return annotations are +defined by a literal ``->``, followed by an expression, between the parameter +list and the colon denoting the end of the :keyword:`def` statement. The +following example has a positional argument, a keyword argument, and the return +value annotated:: + + >>> def f(ham: str, eggs: str = 'eggs') -> str: + ... print("Annotations:", f.__annotations__) + ... print("Arguments:", ham, eggs) + ... return ham + ' and ' + eggs + ... + >>> f('spam') + Annotations: {'ham': , 'return': , 'eggs': } + Arguments: spam eggs + 'spam and eggs' + +.. _tut-codingstyle: + +Intermezzo: Coding Style +======================== + +.. sectionauthor:: Georg Brandl +.. index:: pair: coding; style + +Now that you are about to write longer, more complex pieces of Python, it is a +good time to talk about *coding style*. Most languages can be written (or more +concise, *formatted*) in different styles; some are more readable than others. +Making it easy for others to read your code is always a good idea, and adopting +a nice coding style helps tremendously for that. + +For Python, :pep:`8` has emerged as the style guide that most projects adhere to; +it promotes a very readable and eye-pleasing coding style. Every Python +developer should read it at some point; here are the most important points +extracted for you: + +* Use 4-space indentation, and no tabs. + + 4 spaces are a good compromise between small indentation (allows greater + nesting depth) and large indentation (easier to read). Tabs introduce + confusion, and are best left out. + +* Wrap lines so that they don't exceed 79 characters. + + This helps users with small displays and makes it possible to have several + code files side-by-side on larger displays. + +* Use blank lines to separate functions and classes, and larger blocks of + code inside functions. + +* When possible, put comments on a line of their own. + +* Use docstrings. + +* Use spaces around operators and after commas, but not directly inside + bracketing constructs: ``a = f(1, 2) + g(3, 4)``. + +* Name your classes and functions consistently; the convention is to use + ``UpperCamelCase`` for classes and ``lowercase_with_underscores`` for functions + and methods. Always use ``self`` as the name for the first method argument + (see :ref:`tut-firstclasses` for more on classes and methods). + +* Don't use fancy encodings if your code is meant to be used in international + environments. Python's default, UTF-8, or even plain ASCII work best in any + case. + +* Likewise, don't use non-ASCII characters in identifiers if there is only the + slightest chance people speaking a different language will read or maintain + the code. + + +.. rubric:: Footnotes + +.. [#] Actually, *call by object reference* would be a better description, + since if a mutable object is passed, the caller will see any changes the + callee makes to it (items inserted into a list). diff --git a/python-3.7.4-docs-html/_sources/tutorial/datastructures.rst.txt b/python-3.7.4-docs-html/_sources/tutorial/datastructures.rst.txt new file mode 100644 index 0000000..b4db3f0 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/tutorial/datastructures.rst.txt @@ -0,0 +1,712 @@ +.. _tut-structures: + +*************** +Data Structures +*************** + +This chapter describes some things you've learned about already in more detail, +and adds some new things as well. + +.. _tut-morelists: + +More on Lists +============= + +The list data type has some more methods. Here are all of the methods of list +objects: + + +.. method:: list.append(x) + :noindex: + + Add an item to the end of the list. Equivalent to ``a[len(a):] = [x]``. + + +.. method:: list.extend(iterable) + :noindex: + + Extend the list by appending all the items from the iterable. Equivalent to + ``a[len(a):] = iterable``. + + +.. method:: list.insert(i, x) + :noindex: + + Insert an item at a given position. The first argument is the index of the + element before which to insert, so ``a.insert(0, x)`` inserts at the front of + the list, and ``a.insert(len(a), x)`` is equivalent to ``a.append(x)``. + + +.. method:: list.remove(x) + :noindex: + + Remove the first item from the list whose value is equal to *x*. It raises a + :exc:`ValueError` if there is no such item. + + +.. method:: list.pop([i]) + :noindex: + + Remove the item at the given position in the list, and return it. If no index + is specified, ``a.pop()`` removes and returns the last item in the list. (The + square brackets around the *i* in the method signature denote that the parameter + is optional, not that you should type square brackets at that position. You + will see this notation frequently in the Python Library Reference.) + + +.. method:: list.clear() + :noindex: + + Remove all items from the list. Equivalent to ``del a[:]``. + + +.. method:: list.index(x[, start[, end]]) + :noindex: + + Return zero-based index in the list of the first item whose value is equal to *x*. + Raises a :exc:`ValueError` if there is no such item. + + The optional arguments *start* and *end* are interpreted as in the slice + notation and are used to limit the search to a particular subsequence of + the list. The returned index is computed relative to the beginning of the full + sequence rather than the *start* argument. + + +.. method:: list.count(x) + :noindex: + + Return the number of times *x* appears in the list. + + +.. method:: list.sort(key=None, reverse=False) + :noindex: + + Sort the items of the list in place (the arguments can be used for sort + customization, see :func:`sorted` for their explanation). + + +.. method:: list.reverse() + :noindex: + + Reverse the elements of the list in place. + + +.. method:: list.copy() + :noindex: + + Return a shallow copy of the list. Equivalent to ``a[:]``. + + +An example that uses most of the list methods:: + + >>> fruits = ['orange', 'apple', 'pear', 'banana', 'kiwi', 'apple', 'banana'] + >>> fruits.count('apple') + 2 + >>> fruits.count('tangerine') + 0 + >>> fruits.index('banana') + 3 + >>> fruits.index('banana', 4) # Find next banana starting a position 4 + 6 + >>> fruits.reverse() + >>> fruits + ['banana', 'apple', 'kiwi', 'banana', 'pear', 'apple', 'orange'] + >>> fruits.append('grape') + >>> fruits + ['banana', 'apple', 'kiwi', 'banana', 'pear', 'apple', 'orange', 'grape'] + >>> fruits.sort() + >>> fruits + ['apple', 'apple', 'banana', 'banana', 'grape', 'kiwi', 'orange', 'pear'] + >>> fruits.pop() + 'pear' + +You might have noticed that methods like ``insert``, ``remove`` or ``sort`` that +only modify the list have no return value printed -- they return the default +``None``. [1]_ This is a design principle for all mutable data structures in +Python. + + +.. _tut-lists-as-stacks: + +Using Lists as Stacks +--------------------- + +.. sectionauthor:: Ka-Ping Yee + + +The list methods make it very easy to use a list as a stack, where the last +element added is the first element retrieved ("last-in, first-out"). To add an +item to the top of the stack, use :meth:`append`. To retrieve an item from the +top of the stack, use :meth:`pop` without an explicit index. For example:: + + >>> stack = [3, 4, 5] + >>> stack.append(6) + >>> stack.append(7) + >>> stack + [3, 4, 5, 6, 7] + >>> stack.pop() + 7 + >>> stack + [3, 4, 5, 6] + >>> stack.pop() + 6 + >>> stack.pop() + 5 + >>> stack + [3, 4] + + +.. _tut-lists-as-queues: + +Using Lists as Queues +--------------------- + +.. sectionauthor:: Ka-Ping Yee + +It is also possible to use a list as a queue, where the first element added is +the first element retrieved ("first-in, first-out"); however, lists are not +efficient for this purpose. While appends and pops from the end of list are +fast, doing inserts or pops from the beginning of a list is slow (because all +of the other elements have to be shifted by one). + +To implement a queue, use :class:`collections.deque` which was designed to +have fast appends and pops from both ends. For example:: + + >>> from collections import deque + >>> queue = deque(["Eric", "John", "Michael"]) + >>> queue.append("Terry") # Terry arrives + >>> queue.append("Graham") # Graham arrives + >>> queue.popleft() # The first to arrive now leaves + 'Eric' + >>> queue.popleft() # The second to arrive now leaves + 'John' + >>> queue # Remaining queue in order of arrival + deque(['Michael', 'Terry', 'Graham']) + + +.. _tut-listcomps: + +List Comprehensions +------------------- + +List comprehensions provide a concise way to create lists. +Common applications are to make new lists where each element is the result of +some operations applied to each member of another sequence or iterable, or to +create a subsequence of those elements that satisfy a certain condition. + +For example, assume we want to create a list of squares, like:: + + >>> squares = [] + >>> for x in range(10): + ... squares.append(x**2) + ... + >>> squares + [0, 1, 4, 9, 16, 25, 36, 49, 64, 81] + +Note that this creates (or overwrites) a variable named ``x`` that still exists +after the loop completes. We can calculate the list of squares without any +side effects using:: + + squares = list(map(lambda x: x**2, range(10))) + +or, equivalently:: + + squares = [x**2 for x in range(10)] + +which is more concise and readable. + +A list comprehension consists of brackets containing an expression followed +by a :keyword:`!for` clause, then zero or more :keyword:`!for` or :keyword:`!if` +clauses. The result will be a new list resulting from evaluating the expression +in the context of the :keyword:`!for` and :keyword:`!if` clauses which follow it. +For example, this listcomp combines the elements of two lists if they are not +equal:: + + >>> [(x, y) for x in [1,2,3] for y in [3,1,4] if x != y] + [(1, 3), (1, 4), (2, 3), (2, 1), (2, 4), (3, 1), (3, 4)] + +and it's equivalent to:: + + >>> combs = [] + >>> for x in [1,2,3]: + ... for y in [3,1,4]: + ... if x != y: + ... combs.append((x, y)) + ... + >>> combs + [(1, 3), (1, 4), (2, 3), (2, 1), (2, 4), (3, 1), (3, 4)] + +Note how the order of the :keyword:`for` and :keyword:`if` statements is the +same in both these snippets. + +If the expression is a tuple (e.g. the ``(x, y)`` in the previous example), +it must be parenthesized. :: + + >>> vec = [-4, -2, 0, 2, 4] + >>> # create a new list with the values doubled + >>> [x*2 for x in vec] + [-8, -4, 0, 4, 8] + >>> # filter the list to exclude negative numbers + >>> [x for x in vec if x >= 0] + [0, 2, 4] + >>> # apply a function to all the elements + >>> [abs(x) for x in vec] + [4, 2, 0, 2, 4] + >>> # call a method on each element + >>> freshfruit = [' banana', ' loganberry ', 'passion fruit '] + >>> [weapon.strip() for weapon in freshfruit] + ['banana', 'loganberry', 'passion fruit'] + >>> # create a list of 2-tuples like (number, square) + >>> [(x, x**2) for x in range(6)] + [(0, 0), (1, 1), (2, 4), (3, 9), (4, 16), (5, 25)] + >>> # the tuple must be parenthesized, otherwise an error is raised + >>> [x, x**2 for x in range(6)] + File "", line 1, in + [x, x**2 for x in range(6)] + ^ + SyntaxError: invalid syntax + >>> # flatten a list using a listcomp with two 'for' + >>> vec = [[1,2,3], [4,5,6], [7,8,9]] + >>> [num for elem in vec for num in elem] + [1, 2, 3, 4, 5, 6, 7, 8, 9] + +List comprehensions can contain complex expressions and nested functions:: + + >>> from math import pi + >>> [str(round(pi, i)) for i in range(1, 6)] + ['3.1', '3.14', '3.142', '3.1416', '3.14159'] + +Nested List Comprehensions +-------------------------- + +The initial expression in a list comprehension can be any arbitrary expression, +including another list comprehension. + +Consider the following example of a 3x4 matrix implemented as a list of +3 lists of length 4:: + + >>> matrix = [ + ... [1, 2, 3, 4], + ... [5, 6, 7, 8], + ... [9, 10, 11, 12], + ... ] + +The following list comprehension will transpose rows and columns:: + + >>> [[row[i] for row in matrix] for i in range(4)] + [[1, 5, 9], [2, 6, 10], [3, 7, 11], [4, 8, 12]] + +As we saw in the previous section, the nested listcomp is evaluated in +the context of the :keyword:`for` that follows it, so this example is +equivalent to:: + + >>> transposed = [] + >>> for i in range(4): + ... transposed.append([row[i] for row in matrix]) + ... + >>> transposed + [[1, 5, 9], [2, 6, 10], [3, 7, 11], [4, 8, 12]] + +which, in turn, is the same as:: + + >>> transposed = [] + >>> for i in range(4): + ... # the following 3 lines implement the nested listcomp + ... transposed_row = [] + ... for row in matrix: + ... transposed_row.append(row[i]) + ... transposed.append(transposed_row) + ... + >>> transposed + [[1, 5, 9], [2, 6, 10], [3, 7, 11], [4, 8, 12]] + +In the real world, you should prefer built-in functions to complex flow statements. +The :func:`zip` function would do a great job for this use case:: + + >>> list(zip(*matrix)) + [(1, 5, 9), (2, 6, 10), (3, 7, 11), (4, 8, 12)] + +See :ref:`tut-unpacking-arguments` for details on the asterisk in this line. + +.. _tut-del: + +The :keyword:`!del` statement +============================= + +There is a way to remove an item from a list given its index instead of its +value: the :keyword:`del` statement. This differs from the :meth:`pop` method +which returns a value. The :keyword:`!del` statement can also be used to remove +slices from a list or clear the entire list (which we did earlier by assignment +of an empty list to the slice). For example:: + + >>> a = [-1, 1, 66.25, 333, 333, 1234.5] + >>> del a[0] + >>> a + [1, 66.25, 333, 333, 1234.5] + >>> del a[2:4] + >>> a + [1, 66.25, 1234.5] + >>> del a[:] + >>> a + [] + +:keyword:`del` can also be used to delete entire variables:: + + >>> del a + +Referencing the name ``a`` hereafter is an error (at least until another value +is assigned to it). We'll find other uses for :keyword:`del` later. + + +.. _tut-tuples: + +Tuples and Sequences +==================== + +We saw that lists and strings have many common properties, such as indexing and +slicing operations. They are two examples of *sequence* data types (see +:ref:`typesseq`). Since Python is an evolving language, other sequence data +types may be added. There is also another standard sequence data type: the +*tuple*. + +A tuple consists of a number of values separated by commas, for instance:: + + >>> t = 12345, 54321, 'hello!' + >>> t[0] + 12345 + >>> t + (12345, 54321, 'hello!') + >>> # Tuples may be nested: + ... u = t, (1, 2, 3, 4, 5) + >>> u + ((12345, 54321, 'hello!'), (1, 2, 3, 4, 5)) + >>> # Tuples are immutable: + ... t[0] = 88888 + Traceback (most recent call last): + File "", line 1, in + TypeError: 'tuple' object does not support item assignment + >>> # but they can contain mutable objects: + ... v = ([1, 2, 3], [3, 2, 1]) + >>> v + ([1, 2, 3], [3, 2, 1]) + + +As you see, on output tuples are always enclosed in parentheses, so that nested +tuples are interpreted correctly; they may be input with or without surrounding +parentheses, although often parentheses are necessary anyway (if the tuple is +part of a larger expression). It is not possible to assign to the individual +items of a tuple, however it is possible to create tuples which contain mutable +objects, such as lists. + +Though tuples may seem similar to lists, they are often used in different +situations and for different purposes. +Tuples are :term:`immutable`, and usually contain a heterogeneous sequence of +elements that are accessed via unpacking (see later in this section) or indexing +(or even by attribute in the case of :func:`namedtuples `). +Lists are :term:`mutable`, and their elements are usually homogeneous and are +accessed by iterating over the list. + +A special problem is the construction of tuples containing 0 or 1 items: the +syntax has some extra quirks to accommodate these. Empty tuples are constructed +by an empty pair of parentheses; a tuple with one item is constructed by +following a value with a comma (it is not sufficient to enclose a single value +in parentheses). Ugly, but effective. For example:: + + >>> empty = () + >>> singleton = 'hello', # <-- note trailing comma + >>> len(empty) + 0 + >>> len(singleton) + 1 + >>> singleton + ('hello',) + +The statement ``t = 12345, 54321, 'hello!'`` is an example of *tuple packing*: +the values ``12345``, ``54321`` and ``'hello!'`` are packed together in a tuple. +The reverse operation is also possible:: + + >>> x, y, z = t + +This is called, appropriately enough, *sequence unpacking* and works for any +sequence on the right-hand side. Sequence unpacking requires that there are as +many variables on the left side of the equals sign as there are elements in the +sequence. Note that multiple assignment is really just a combination of tuple +packing and sequence unpacking. + + +.. _tut-sets: + +Sets +==== + +Python also includes a data type for *sets*. A set is an unordered collection +with no duplicate elements. Basic uses include membership testing and +eliminating duplicate entries. Set objects also support mathematical operations +like union, intersection, difference, and symmetric difference. + +Curly braces or the :func:`set` function can be used to create sets. Note: to +create an empty set you have to use ``set()``, not ``{}``; the latter creates an +empty dictionary, a data structure that we discuss in the next section. + +Here is a brief demonstration:: + + >>> basket = {'apple', 'orange', 'apple', 'pear', 'orange', 'banana'} + >>> print(basket) # show that duplicates have been removed + {'orange', 'banana', 'pear', 'apple'} + >>> 'orange' in basket # fast membership testing + True + >>> 'crabgrass' in basket + False + + >>> # Demonstrate set operations on unique letters from two words + ... + >>> a = set('abracadabra') + >>> b = set('alacazam') + >>> a # unique letters in a + {'a', 'r', 'b', 'c', 'd'} + >>> a - b # letters in a but not in b + {'r', 'd', 'b'} + >>> a | b # letters in a or b or both + {'a', 'c', 'r', 'd', 'b', 'm', 'z', 'l'} + >>> a & b # letters in both a and b + {'a', 'c'} + >>> a ^ b # letters in a or b but not both + {'r', 'd', 'b', 'm', 'z', 'l'} + +Similarly to :ref:`list comprehensions `, set comprehensions +are also supported:: + + >>> a = {x for x in 'abracadabra' if x not in 'abc'} + >>> a + {'r', 'd'} + + +.. _tut-dictionaries: + +Dictionaries +============ + +Another useful data type built into Python is the *dictionary* (see +:ref:`typesmapping`). Dictionaries are sometimes found in other languages as +"associative memories" or "associative arrays". Unlike sequences, which are +indexed by a range of numbers, dictionaries are indexed by *keys*, which can be +any immutable type; strings and numbers can always be keys. Tuples can be used +as keys if they contain only strings, numbers, or tuples; if a tuple contains +any mutable object either directly or indirectly, it cannot be used as a key. +You can't use lists as keys, since lists can be modified in place using index +assignments, slice assignments, or methods like :meth:`append` and +:meth:`extend`. + +It is best to think of a dictionary as a set of *key: value* pairs, +with the requirement that the keys are unique (within one dictionary). A pair of +braces creates an empty dictionary: ``{}``. Placing a comma-separated list of +key:value pairs within the braces adds initial key:value pairs to the +dictionary; this is also the way dictionaries are written on output. + +The main operations on a dictionary are storing a value with some key and +extracting the value given the key. It is also possible to delete a key:value +pair with ``del``. If you store using a key that is already in use, the old +value associated with that key is forgotten. It is an error to extract a value +using a non-existent key. + +Performing ``list(d)`` on a dictionary returns a list of all the keys +used in the dictionary, in insertion order (if you want it sorted, just use +``sorted(d)`` instead). To check whether a single key is in the +dictionary, use the :keyword:`in` keyword. + +Here is a small example using a dictionary:: + + >>> tel = {'jack': 4098, 'sape': 4139} + >>> tel['guido'] = 4127 + >>> tel + {'jack': 4098, 'sape': 4139, 'guido': 4127} + >>> tel['jack'] + 4098 + >>> del tel['sape'] + >>> tel['irv'] = 4127 + >>> tel + {'jack': 4098, 'guido': 4127, 'irv': 4127} + >>> list(tel) + ['jack', 'guido', 'irv'] + >>> sorted(tel) + ['guido', 'irv', 'jack'] + >>> 'guido' in tel + True + >>> 'jack' not in tel + False + +The :func:`dict` constructor builds dictionaries directly from sequences of +key-value pairs:: + + >>> dict([('sape', 4139), ('guido', 4127), ('jack', 4098)]) + {'sape': 4139, 'guido': 4127, 'jack': 4098} + +In addition, dict comprehensions can be used to create dictionaries from +arbitrary key and value expressions:: + + >>> {x: x**2 for x in (2, 4, 6)} + {2: 4, 4: 16, 6: 36} + +When the keys are simple strings, it is sometimes easier to specify pairs using +keyword arguments:: + + >>> dict(sape=4139, guido=4127, jack=4098) + {'sape': 4139, 'guido': 4127, 'jack': 4098} + + +.. _tut-loopidioms: + +Looping Techniques +================== + +When looping through dictionaries, the key and corresponding value can be +retrieved at the same time using the :meth:`items` method. :: + + >>> knights = {'gallahad': 'the pure', 'robin': 'the brave'} + >>> for k, v in knights.items(): + ... print(k, v) + ... + gallahad the pure + robin the brave + +When looping through a sequence, the position index and corresponding value can +be retrieved at the same time using the :func:`enumerate` function. :: + + >>> for i, v in enumerate(['tic', 'tac', 'toe']): + ... print(i, v) + ... + 0 tic + 1 tac + 2 toe + +To loop over two or more sequences at the same time, the entries can be paired +with the :func:`zip` function. :: + + >>> questions = ['name', 'quest', 'favorite color'] + >>> answers = ['lancelot', 'the holy grail', 'blue'] + >>> for q, a in zip(questions, answers): + ... print('What is your {0}? It is {1}.'.format(q, a)) + ... + What is your name? It is lancelot. + What is your quest? It is the holy grail. + What is your favorite color? It is blue. + +To loop over a sequence in reverse, first specify the sequence in a forward +direction and then call the :func:`reversed` function. :: + + >>> for i in reversed(range(1, 10, 2)): + ... print(i) + ... + 9 + 7 + 5 + 3 + 1 + +To loop over a sequence in sorted order, use the :func:`sorted` function which +returns a new sorted list while leaving the source unaltered. :: + + >>> basket = ['apple', 'orange', 'apple', 'pear', 'orange', 'banana'] + >>> for f in sorted(set(basket)): + ... print(f) + ... + apple + banana + orange + pear + +It is sometimes tempting to change a list while you are looping over it; +however, it is often simpler and safer to create a new list instead. :: + + >>> import math + >>> raw_data = [56.2, float('NaN'), 51.7, 55.3, 52.5, float('NaN'), 47.8] + >>> filtered_data = [] + >>> for value in raw_data: + ... if not math.isnan(value): + ... filtered_data.append(value) + ... + >>> filtered_data + [56.2, 51.7, 55.3, 52.5, 47.8] + + +.. _tut-conditions: + +More on Conditions +================== + +The conditions used in ``while`` and ``if`` statements can contain any +operators, not just comparisons. + +The comparison operators ``in`` and ``not in`` check whether a value occurs +(does not occur) in a sequence. The operators ``is`` and ``is not`` compare +whether two objects are really the same object; this only matters for mutable +objects like lists. All comparison operators have the same priority, which is +lower than that of all numerical operators. + +Comparisons can be chained. For example, ``a < b == c`` tests whether ``a`` is +less than ``b`` and moreover ``b`` equals ``c``. + +Comparisons may be combined using the Boolean operators ``and`` and ``or``, and +the outcome of a comparison (or of any other Boolean expression) may be negated +with ``not``. These have lower priorities than comparison operators; between +them, ``not`` has the highest priority and ``or`` the lowest, so that ``A and +not B or C`` is equivalent to ``(A and (not B)) or C``. As always, parentheses +can be used to express the desired composition. + +The Boolean operators ``and`` and ``or`` are so-called *short-circuit* +operators: their arguments are evaluated from left to right, and evaluation +stops as soon as the outcome is determined. For example, if ``A`` and ``C`` are +true but ``B`` is false, ``A and B and C`` does not evaluate the expression +``C``. When used as a general value and not as a Boolean, the return value of a +short-circuit operator is the last evaluated argument. + +It is possible to assign the result of a comparison or other Boolean expression +to a variable. For example, :: + + >>> string1, string2, string3 = '', 'Trondheim', 'Hammer Dance' + >>> non_null = string1 or string2 or string3 + >>> non_null + 'Trondheim' + +Note that in Python, unlike C, assignment cannot occur inside expressions. C +programmers may grumble about this, but it avoids a common class of problems +encountered in C programs: typing ``=`` in an expression when ``==`` was +intended. + + +.. _tut-comparing: + +Comparing Sequences and Other Types +=================================== + +Sequence objects may be compared to other objects with the same sequence type. +The comparison uses *lexicographical* ordering: first the first two items are +compared, and if they differ this determines the outcome of the comparison; if +they are equal, the next two items are compared, and so on, until either +sequence is exhausted. If two items to be compared are themselves sequences of +the same type, the lexicographical comparison is carried out recursively. If +all items of two sequences compare equal, the sequences are considered equal. +If one sequence is an initial sub-sequence of the other, the shorter sequence is +the smaller (lesser) one. Lexicographical ordering for strings uses the Unicode +code point number to order individual characters. Some examples of comparisons +between sequences of the same type:: + + (1, 2, 3) < (1, 2, 4) + [1, 2, 3] < [1, 2, 4] + 'ABC' < 'C' < 'Pascal' < 'Python' + (1, 2, 3, 4) < (1, 2, 4) + (1, 2) < (1, 2, -1) + (1, 2, 3) == (1.0, 2.0, 3.0) + (1, 2, ('aa', 'ab')) < (1, 2, ('abc', 'a'), 4) + +Note that comparing objects of different types with ``<`` or ``>`` is legal +provided that the objects have appropriate comparison methods. For example, +mixed numeric types are compared according to their numeric value, so 0 equals +0.0, etc. Otherwise, rather than providing an arbitrary ordering, the +interpreter will raise a :exc:`TypeError` exception. + + +.. rubric:: Footnotes + +.. [1] Other languages may return the mutated object, which allows method + chaining, such as ``d->insert("a")->remove("b")->sort();``. diff --git a/python-3.7.4-docs-html/_sources/tutorial/errors.rst.txt b/python-3.7.4-docs-html/_sources/tutorial/errors.rst.txt new file mode 100644 index 0000000..4e287bb --- /dev/null +++ b/python-3.7.4-docs-html/_sources/tutorial/errors.rst.txt @@ -0,0 +1,414 @@ +.. _tut-errors: + +********************* +Errors and Exceptions +********************* + +Until now error messages haven't been more than mentioned, but if you have tried +out the examples you have probably seen some. There are (at least) two +distinguishable kinds of errors: *syntax errors* and *exceptions*. + + +.. _tut-syntaxerrors: + +Syntax Errors +============= + +Syntax errors, also known as parsing errors, are perhaps the most common kind of +complaint you get while you are still learning Python:: + + >>> while True print('Hello world') + File "", line 1 + while True print('Hello world') + ^ + SyntaxError: invalid syntax + +The parser repeats the offending line and displays a little 'arrow' pointing at +the earliest point in the line where the error was detected. The error is +caused by (or at least detected at) the token *preceding* the arrow: in the +example, the error is detected at the function :func:`print`, since a colon +(``':'``) is missing before it. File name and line number are printed so you +know where to look in case the input came from a script. + + +.. _tut-exceptions: + +Exceptions +========== + +Even if a statement or expression is syntactically correct, it may cause an +error when an attempt is made to execute it. Errors detected during execution +are called *exceptions* and are not unconditionally fatal: you will soon learn +how to handle them in Python programs. Most exceptions are not handled by +programs, however, and result in error messages as shown here:: + + >>> 10 * (1/0) + Traceback (most recent call last): + File "", line 1, in + ZeroDivisionError: division by zero + >>> 4 + spam*3 + Traceback (most recent call last): + File "", line 1, in + NameError: name 'spam' is not defined + >>> '2' + 2 + Traceback (most recent call last): + File "", line 1, in + TypeError: Can't convert 'int' object to str implicitly + +The last line of the error message indicates what happened. Exceptions come in +different types, and the type is printed as part of the message: the types in +the example are :exc:`ZeroDivisionError`, :exc:`NameError` and :exc:`TypeError`. +The string printed as the exception type is the name of the built-in exception +that occurred. This is true for all built-in exceptions, but need not be true +for user-defined exceptions (although it is a useful convention). Standard +exception names are built-in identifiers (not reserved keywords). + +The rest of the line provides detail based on the type of exception and what +caused it. + +The preceding part of the error message shows the context where the exception +happened, in the form of a stack traceback. In general it contains a stack +traceback listing source lines; however, it will not display lines read from +standard input. + +:ref:`bltin-exceptions` lists the built-in exceptions and their meanings. + + +.. _tut-handling: + +Handling Exceptions +=================== + +It is possible to write programs that handle selected exceptions. Look at the +following example, which asks the user for input until a valid integer has been +entered, but allows the user to interrupt the program (using :kbd:`Control-C` or +whatever the operating system supports); note that a user-generated interruption +is signalled by raising the :exc:`KeyboardInterrupt` exception. :: + + >>> while True: + ... try: + ... x = int(input("Please enter a number: ")) + ... break + ... except ValueError: + ... print("Oops! That was no valid number. Try again...") + ... + +The :keyword:`try` statement works as follows. + +* First, the *try clause* (the statement(s) between the :keyword:`try` and + :keyword:`except` keywords) is executed. + +* If no exception occurs, the *except clause* is skipped and execution of the + :keyword:`try` statement is finished. + +* If an exception occurs during execution of the try clause, the rest of the + clause is skipped. Then if its type matches the exception named after the + :keyword:`except` keyword, the except clause is executed, and then execution + continues after the :keyword:`try` statement. + +* If an exception occurs which does not match the exception named in the except + clause, it is passed on to outer :keyword:`try` statements; if no handler is + found, it is an *unhandled exception* and execution stops with a message as + shown above. + +A :keyword:`try` statement may have more than one except clause, to specify +handlers for different exceptions. At most one handler will be executed. +Handlers only handle exceptions that occur in the corresponding try clause, not +in other handlers of the same :keyword:`!try` statement. An except clause may +name multiple exceptions as a parenthesized tuple, for example:: + + ... except (RuntimeError, TypeError, NameError): + ... pass + +A class in an :keyword:`except` clause is compatible with an exception if it is +the same class or a base class thereof (but not the other way around --- an +except clause listing a derived class is not compatible with a base class). For +example, the following code will print B, C, D in that order:: + + class B(Exception): + pass + + class C(B): + pass + + class D(C): + pass + + for cls in [B, C, D]: + try: + raise cls() + except D: + print("D") + except C: + print("C") + except B: + print("B") + +Note that if the except clauses were reversed (with ``except B`` first), it +would have printed B, B, B --- the first matching except clause is triggered. + +The last except clause may omit the exception name(s), to serve as a wildcard. +Use this with extreme caution, since it is easy to mask a real programming error +in this way! It can also be used to print an error message and then re-raise +the exception (allowing a caller to handle the exception as well):: + + import sys + + try: + f = open('myfile.txt') + s = f.readline() + i = int(s.strip()) + except OSError as err: + print("OS error: {0}".format(err)) + except ValueError: + print("Could not convert data to an integer.") + except: + print("Unexpected error:", sys.exc_info()[0]) + raise + +The :keyword:`try` ... :keyword:`except` statement has an optional *else +clause*, which, when present, must follow all except clauses. It is useful for +code that must be executed if the try clause does not raise an exception. For +example:: + + for arg in sys.argv[1:]: + try: + f = open(arg, 'r') + except OSError: + print('cannot open', arg) + else: + print(arg, 'has', len(f.readlines()), 'lines') + f.close() + +The use of the :keyword:`!else` clause is better than adding additional code to +the :keyword:`try` clause because it avoids accidentally catching an exception +that wasn't raised by the code being protected by the :keyword:`!try` ... +:keyword:`!except` statement. + +When an exception occurs, it may have an associated value, also known as the +exception's *argument*. The presence and type of the argument depend on the +exception type. + +The except clause may specify a variable after the exception name. The +variable is bound to an exception instance with the arguments stored in +``instance.args``. For convenience, the exception instance defines +:meth:`__str__` so the arguments can be printed directly without having to +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') + ... 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) + ... + + ('spam', 'eggs') + ('spam', 'eggs') + x = spam + y = eggs + +If an exception has arguments, they are printed as the last part ('detail') of +the message for unhandled exceptions. + +Exception handlers don't just handle exceptions if they occur immediately in the +try clause, but also if they occur inside functions that are called (even +indirectly) in the try clause. For example:: + + >>> def this_fails(): + ... x = 1/0 + ... + >>> try: + ... this_fails() + ... except ZeroDivisionError as err: + ... print('Handling run-time error:', err) + ... + Handling run-time error: division by zero + + +.. _tut-raising: + +Raising Exceptions +================== + +The :keyword:`raise` statement allows the programmer to force a specified +exception to occur. For example:: + + >>> raise NameError('HiThere') + Traceback (most recent call last): + File "", line 1, in + NameError: HiThere + +The sole argument to :keyword:`raise` indicates the exception to be raised. +This must be either an exception instance or an exception class (a class that +derives from :class:`Exception`). If an exception class is passed, it will +be implicitly instantiated by calling its constructor with no arguments:: + + raise ValueError # shorthand for 'raise ValueError()' + +If you need to determine whether an exception was raised but don't intend to +handle it, a simpler form of the :keyword:`raise` statement allows you to +re-raise the exception:: + + >>> try: + ... raise NameError('HiThere') + ... except NameError: + ... print('An exception flew by!') + ... raise + ... + An exception flew by! + Traceback (most recent call last): + File "", line 2, in + NameError: HiThere + + +.. _tut-userexceptions: + +User-defined Exceptions +======================= + +Programs may name their own exceptions by creating a new exception class (see +:ref:`tut-classes` for more about Python classes). Exceptions should typically +be derived from the :exc:`Exception` class, either directly or indirectly. + +Exception classes can be defined which do anything any other class can do, but +are usually kept simple, often only offering a number of attributes that allow +information about the error to be extracted by handlers for the exception. When +creating a module that can raise several distinct errors, a common practice is +to create a base class for exceptions defined by that module, and subclass that +to create specific exception classes for different error conditions:: + + class Error(Exception): + """Base class for exceptions in this module.""" + pass + + class InputError(Error): + """Exception raised for errors in the input. + + Attributes: + expression -- input expression in which the error occurred + message -- explanation of the error + """ + + def __init__(self, expression, message): + self.expression = expression + self.message = message + + class TransitionError(Error): + """Raised when an operation attempts a state transition that's not + allowed. + + Attributes: + previous -- state at beginning of transition + next -- attempted new state + message -- explanation of why the specific transition is not allowed + """ + + def __init__(self, previous, next, message): + self.previous = previous + self.next = next + self.message = message + +Most exceptions are defined with names that end in "Error", similar to the +naming of the standard exceptions. + +Many standard modules define their own exceptions to report errors that may +occur in functions they define. More information on classes is presented in +chapter :ref:`tut-classes`. + + +.. _tut-cleanup: + +Defining Clean-up Actions +========================= + +The :keyword:`try` statement has another optional clause which is intended to +define clean-up actions that must be executed under all circumstances. For +example:: + + >>> try: + ... raise KeyboardInterrupt + ... finally: + ... print('Goodbye, world!') + ... + Goodbye, world! + Traceback (most recent call last): + File "", line 2, in + KeyboardInterrupt + +A *finally clause* is always executed before leaving the :keyword:`try` +statement, whether an exception has occurred or not. When an exception has +occurred in the :keyword:`!try` clause and has not been handled by an +:keyword:`except` clause (or it has occurred in an :keyword:`!except` or +:keyword:`!else` clause), it is re-raised after the :keyword:`finally` clause has +been executed. The :keyword:`!finally` clause is also executed "on the way out" +when any other clause of the :keyword:`!try` statement is left via a +:keyword:`break`, :keyword:`continue` or :keyword:`return` statement. A more +complicated example:: + + >>> def divide(x, y): + ... try: + ... result = x / y + ... except ZeroDivisionError: + ... print("division by zero!") + ... else: + ... print("result is", result) + ... finally: + ... print("executing finally clause") + ... + >>> divide(2, 1) + result is 2.0 + executing finally clause + >>> divide(2, 0) + division by zero! + executing finally clause + >>> divide("2", "1") + executing finally clause + Traceback (most recent call last): + File "", line 1, in + File "", line 3, in divide + TypeError: unsupported operand type(s) for /: 'str' and 'str' + +As you can see, the :keyword:`finally` clause is executed in any event. The +:exc:`TypeError` raised by dividing two strings is not handled by the +:keyword:`except` clause and therefore re-raised after the :keyword:`!finally` +clause has been executed. + +In real world applications, the :keyword:`finally` clause is useful for +releasing external resources (such as files or network connections), regardless +of whether the use of the resource was successful. + + +.. _tut-cleanup-with: + +Predefined Clean-up Actions +=========================== + +Some objects define standard clean-up actions to be undertaken when the object +is no longer needed, regardless of whether or not the operation using the object +succeeded or failed. Look at the following example, which tries to open a file +and print its contents to the screen. :: + + for line in open("myfile.txt"): + print(line, end="") + +The problem with this code is that it leaves the file open for an indeterminate +amount of time after this part of the code has finished executing. +This is not an issue in simple scripts, but can be a problem for larger +applications. The :keyword:`with` statement allows objects like files to be +used in a way that ensures they are always cleaned up promptly and correctly. :: + + with open("myfile.txt") as f: + for line in f: + print(line, end="") + +After the statement is executed, the file *f* is always closed, even if a +problem was encountered while processing the lines. Objects which, like files, +provide predefined clean-up actions will indicate this in their documentation. + + diff --git a/python-3.7.4-docs-html/_sources/tutorial/floatingpoint.rst.txt b/python-3.7.4-docs-html/_sources/tutorial/floatingpoint.rst.txt new file mode 100644 index 0000000..0c0eb52 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/tutorial/floatingpoint.rst.txt @@ -0,0 +1,300 @@ +.. testsetup:: + + import math + +.. _tut-fp-issues: + +************************************************** +Floating Point Arithmetic: Issues and Limitations +************************************************** + +.. sectionauthor:: Tim Peters + + +Floating-point numbers are represented in computer hardware as base 2 (binary) +fractions. For example, the decimal fraction :: + + 0.125 + +has value 1/10 + 2/100 + 5/1000, and in the same way the binary fraction :: + + 0.001 + +has value 0/2 + 0/4 + 1/8. These two fractions have identical values, the only +real difference being that the first is written in base 10 fractional notation, +and the second in base 2. + +Unfortunately, most decimal fractions cannot be represented exactly as binary +fractions. A consequence is that, in general, the decimal floating-point +numbers you enter are only approximated by the binary floating-point numbers +actually stored in the machine. + +The problem is easier to understand at first in base 10. Consider the fraction +1/3. You can approximate that as a base 10 fraction:: + + 0.3 + +or, better, :: + + 0.33 + +or, better, :: + + 0.333 + +and so on. No matter how many digits you're willing to write down, the result +will never be exactly 1/3, but will be an increasingly better approximation of +1/3. + +In the same way, no matter how many base 2 digits you're willing to use, the +decimal value 0.1 cannot be represented exactly as a base 2 fraction. In base +2, 1/10 is the infinitely repeating fraction :: + + 0.0001100110011001100110011001100110011001100110011... + +Stop at any finite number of bits, and you get an approximation. On most +machines today, floats are approximated using a binary fraction with +the numerator using the first 53 bits starting with the most significant bit and +with the denominator as a power of two. In the case of 1/10, the binary fraction +is ``3602879701896397 / 2 ** 55`` which is close to but not exactly +equal to the true value of 1/10. + +Many users are not aware of the approximation because of the way values are +displayed. Python only prints a decimal approximation to the true decimal +value of the binary approximation stored by the machine. On most machines, if +Python were to print the true decimal value of the binary approximation stored +for 0.1, it would have to display :: + + >>> 0.1 + 0.1000000000000000055511151231257827021181583404541015625 + +That is more digits than most people find useful, so Python keeps the number +of digits manageable by displaying a rounded value instead :: + + >>> 1 / 10 + 0.1 + +Just remember, even though the printed result looks like the exact value +of 1/10, the actual stored value is the nearest representable binary fraction. + +Interestingly, there are many different decimal numbers that share the same +nearest approximate binary fraction. For example, the numbers ``0.1`` and +``0.10000000000000001`` and +``0.1000000000000000055511151231257827021181583404541015625`` are all +approximated by ``3602879701896397 / 2 ** 55``. Since all of these decimal +values share the same approximation, any one of them could be displayed +while still preserving the invariant ``eval(repr(x)) == x``. + +Historically, the Python prompt and built-in :func:`repr` function would choose +the one with 17 significant digits, ``0.10000000000000001``. Starting with +Python 3.1, Python (on most systems) is now able to choose the shortest of +these and simply display ``0.1``. + +Note that this is in the very nature of binary floating-point: this is not a bug +in Python, and it is not a bug in your code either. You'll see the same kind of +thing in all languages that support your hardware's floating-point arithmetic +(although some languages may not *display* the difference by default, or in all +output modes). + +For more pleasant output, you may wish to use string formatting to produce a limited number of significant digits:: + + >>> format(math.pi, '.12g') # give 12 significant digits + '3.14159265359' + + >>> format(math.pi, '.2f') # give 2 digits after the point + '3.14' + + >>> repr(math.pi) + '3.141592653589793' + + +It's important to realize that this is, in a real sense, an illusion: you're +simply rounding the *display* of the true machine value. + +One illusion may beget another. For example, since 0.1 is not exactly 1/10, +summing three values of 0.1 may not yield exactly 0.3, either:: + + >>> .1 + .1 + .1 == .3 + False + +Also, since the 0.1 cannot get any closer to the exact value of 1/10 and +0.3 cannot get any closer to the exact value of 3/10, then pre-rounding with +:func:`round` function cannot help:: + + >>> round(.1, 1) + round(.1, 1) + round(.1, 1) == round(.3, 1) + False + +Though the numbers cannot be made closer to their intended exact values, +the :func:`round` function can be useful for post-rounding so that results +with inexact values become comparable to one another:: + + >>> round(.1 + .1 + .1, 10) == round(.3, 10) + True + +Binary floating-point arithmetic holds many surprises like this. The problem +with "0.1" is explained in precise detail below, in the "Representation Error" +section. See `The Perils of Floating Point `_ +for a more complete account of other common surprises. + +As that says near the end, "there are no easy answers." Still, don't be unduly +wary of floating-point! The errors in Python float operations are inherited +from the floating-point hardware, and on most machines are on the order of no +more than 1 part in 2\*\*53 per operation. That's more than adequate for most +tasks, but you do need to keep in mind that it's not decimal arithmetic and +that every float operation can suffer a new rounding error. + +While pathological cases do exist, for most casual use of floating-point +arithmetic you'll see the result you expect in the end if you simply round the +display of your final results to the number of decimal digits you expect. +:func:`str` usually suffices, and for finer control see the :meth:`str.format` +method's format specifiers in :ref:`formatstrings`. + +For use cases which require exact decimal representation, try using the +:mod:`decimal` module which implements decimal arithmetic suitable for +accounting applications and high-precision applications. + +Another form of exact arithmetic is supported by the :mod:`fractions` module +which implements arithmetic based on rational numbers (so the numbers like +1/3 can be represented exactly). + +If you are a heavy user of floating point operations you should take a look +at the Numerical Python package and many other packages for mathematical and +statistical operations supplied by the SciPy project. See . + +Python provides tools that may help on those rare occasions when you really +*do* want to know the exact value of a float. The +:meth:`float.as_integer_ratio` method expresses the value of a float as a +fraction:: + + >>> x = 3.14159 + >>> x.as_integer_ratio() + (3537115888337719, 1125899906842624) + +Since the ratio is exact, it can be used to losslessly recreate the +original value:: + + >>> x == 3537115888337719 / 1125899906842624 + True + +The :meth:`float.hex` method expresses a float in hexadecimal (base +16), again giving the exact value stored by your computer:: + + >>> x.hex() + '0x1.921f9f01b866ep+1' + +This precise hexadecimal representation can be used to reconstruct +the float value exactly:: + + >>> x == float.fromhex('0x1.921f9f01b866ep+1') + True + +Since the representation is exact, it is useful for reliably porting values +across different versions of Python (platform independence) and exchanging +data with other languages that support the same format (such as Java and C99). + +Another helpful tool is the :func:`math.fsum` function which helps mitigate +loss-of-precision during summation. It tracks "lost digits" as values are +added onto a running total. That can make a difference in overall accuracy +so that the errors do not accumulate to the point where they affect the +final total: + + >>> sum([0.1] * 10) == 1.0 + False + >>> math.fsum([0.1] * 10) == 1.0 + True + +.. _tut-fp-error: + +Representation Error +==================== + +This section explains the "0.1" example in detail, and shows how you can perform +an exact analysis of cases like this yourself. Basic familiarity with binary +floating-point representation is assumed. + +:dfn:`Representation error` refers to the fact that some (most, actually) +decimal fractions cannot be represented exactly as binary (base 2) fractions. +This is the chief reason why Python (or Perl, C, C++, Java, Fortran, and many +others) often won't display the exact decimal number you expect. + +Why is that? 1/10 is not exactly representable as a binary fraction. Almost all +machines today (November 2000) use IEEE-754 floating point arithmetic, and +almost all platforms map Python floats to IEEE-754 "double precision". 754 +doubles contain 53 bits of precision, so on input the computer strives to +convert 0.1 to the closest fraction it can of the form *J*/2**\ *N* where *J* is +an integer containing exactly 53 bits. Rewriting :: + + 1 / 10 ~= J / (2**N) + +as :: + + J ~= 2**N / 10 + +and recalling that *J* has exactly 53 bits (is ``>= 2**52`` but ``< 2**53``), +the best value for *N* is 56:: + + >>> 2**52 <= 2**56 // 10 < 2**53 + True + +That is, 56 is the only value for *N* that leaves *J* with exactly 53 bits. The +best possible value for *J* is then that quotient rounded:: + + >>> q, r = divmod(2**56, 10) + >>> r + 6 + +Since the remainder is more than half of 10, the best approximation is obtained +by rounding up:: + + >>> q+1 + 7205759403792794 + +Therefore the best possible approximation to 1/10 in 754 double precision is:: + + 7205759403792794 / 2 ** 56 + +Dividing both the numerator and denominator by two reduces the fraction to:: + + 3602879701896397 / 2 ** 55 + +Note that since we rounded up, this is actually a little bit larger than 1/10; +if we had not rounded up, the quotient would have been a little bit smaller than +1/10. But in no case can it be *exactly* 1/10! + +So the computer never "sees" 1/10: what it sees is the exact fraction given +above, the best 754 double approximation it can get:: + + >>> 0.1 * 2 ** 55 + 3602879701896397.0 + +If we multiply that fraction by 10\*\*55, we can see the value out to +55 decimal digits:: + + >>> 3602879701896397 * 10 ** 55 // 2 ** 55 + 1000000000000000055511151231257827021181583404541015625 + +meaning that the exact number stored in the computer is equal to +the decimal value 0.1000000000000000055511151231257827021181583404541015625. +Instead of displaying the full decimal value, many languages (including +older versions of Python), round the result to 17 significant digits:: + + >>> format(0.1, '.17f') + '0.10000000000000001' + +The :mod:`fractions` and :mod:`decimal` modules make these calculations +easy:: + + >>> from decimal import Decimal + >>> from fractions import Fraction + + >>> Fraction.from_float(0.1) + Fraction(3602879701896397, 36028797018963968) + + >>> (0.1).as_integer_ratio() + (3602879701896397, 36028797018963968) + + >>> Decimal.from_float(0.1) + Decimal('0.1000000000000000055511151231257827021181583404541015625') + + >>> format(Decimal.from_float(0.1), '.17') + '0.10000000000000001' diff --git a/python-3.7.4-docs-html/_sources/tutorial/index.rst.txt b/python-3.7.4-docs-html/_sources/tutorial/index.rst.txt new file mode 100644 index 0000000..8ee011e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/tutorial/index.rst.txt @@ -0,0 +1,60 @@ +.. _tutorial-index: + +###################### + The Python Tutorial +###################### + +Python is an easy to learn, powerful programming language. It has efficient +high-level data structures and a simple but effective approach to +object-oriented programming. Python's elegant syntax and dynamic typing, +together with its interpreted nature, make it an ideal language for scripting +and rapid application development in many areas on most platforms. + +The Python interpreter and the extensive standard library are freely available +in source or binary form for all major platforms from the Python Web site, +https://www.python.org/, and may be freely distributed. The same site also +contains distributions of and pointers to many free third party Python modules, +programs and tools, and additional documentation. + +The Python interpreter is easily extended with new functions and data types +implemented in C or C++ (or other languages callable from C). Python is also +suitable as an extension language for customizable applications. + +This tutorial introduces the reader informally to the basic concepts and +features of the Python language and system. It helps to have a Python +interpreter handy for hands-on experience, but all examples are self-contained, +so the tutorial can be read off-line as well. + +For a description of standard objects and modules, see :ref:`library-index`. +:ref:`reference-index` gives a more formal definition of the language. To write +extensions in C or C++, read :ref:`extending-index` and +:ref:`c-api-index`. There are also several books covering Python in depth. + +This tutorial does not attempt to be comprehensive and cover every single +feature, or even every commonly used feature. Instead, it introduces many of +Python's most noteworthy features, and will give you a good idea of the +language's flavor and style. After reading it, you will be able to read and +write Python modules and programs, and you will be ready to learn more about the +various Python library modules described in :ref:`library-index`. + +The :ref:`glossary` is also worth going through. + +.. toctree:: + :numbered: + + appetite.rst + interpreter.rst + introduction.rst + controlflow.rst + datastructures.rst + modules.rst + inputoutput.rst + errors.rst + classes.rst + stdlib.rst + stdlib2.rst + venv.rst + whatnow.rst + interactive.rst + floatingpoint.rst + appendix.rst diff --git a/python-3.7.4-docs-html/_sources/tutorial/inputoutput.rst.txt b/python-3.7.4-docs-html/_sources/tutorial/inputoutput.rst.txt new file mode 100644 index 0000000..7942786 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/tutorial/inputoutput.rst.txt @@ -0,0 +1,503 @@ +.. _tut-io: + +**************** +Input and Output +**************** + +There are several ways to present the output of a program; data can be printed +in a human-readable form, or written to a file for future use. This chapter will +discuss some of the possibilities. + + +.. _tut-formatting: + +Fancier Output Formatting +========================= + +So far we've encountered two ways of writing values: *expression statements* and +the :func:`print` function. (A third way is using the :meth:`write` method +of file objects; the standard output file can be referenced as ``sys.stdout``. +See the Library Reference for more information on this.) + +Often you'll want more control over the formatting of your output than simply +printing space-separated values. There are several ways to format output. + +* To use :ref:`formatted string literals `, begin a string + with ``f`` or ``F`` before the opening quotation mark or triple quotation mark. + Inside this string, you can write a Python expression between ``{`` and ``}`` + characters that can refer to variables or literal values. + + :: + + >>> year = 2016 + >>> event = 'Referendum' + >>> f'Results of the {year} {event}' + 'Results of the 2016 Referendum' + +* The :meth:`str.format` method of strings requires more manual + effort. You'll still use ``{`` and ``}`` to mark where a variable + will be substituted and can provide detailed formatting directives, + but you'll also need to provide the information to be formatted. + + :: + + >>> yes_votes = 42_572_654 + >>> no_votes = 43_132_495 + >>> percentage = yes_votes / (yes_votes + no_votes) + >>> '{:-9} YES votes {:2.2%}'.format(yes_votes, percentage) + ' 42572654 YES votes 49.67%' + +* Finally, you can do all the string handling yourself by using string slicing and + concatenation operations to create any layout you can imagine. The + string type has some methods that perform useful operations for padding + strings to a given column width. + +When you don't need fancy output but just want a quick display of some +variables for debugging purposes, you can convert any value to a string with +the :func:`repr` or :func:`str` functions. + +The :func:`str` function is meant to return representations of values which are +fairly human-readable, while :func:`repr` is meant to generate representations +which can be read by the interpreter (or will force a :exc:`SyntaxError` if +there is no equivalent syntax). For objects which don't have a particular +representation for human consumption, :func:`str` will return the same value as +:func:`repr`. Many values, such as numbers or structures like lists and +dictionaries, have the same representation using either function. Strings, in +particular, have two distinct representations. + +Some examples:: + + >>> s = 'Hello, world.' + >>> str(s) + 'Hello, world.' + >>> repr(s) + "'Hello, world.'" + >>> str(1/7) + '0.14285714285714285' + >>> x = 10 * 3.25 + >>> y = 200 * 200 + >>> s = 'The value of x is ' + repr(x) + ', and y is ' + repr(y) + '...' + >>> print(s) + The value of x is 32.5, and y is 40000... + >>> # The repr() of a string adds string quotes and backslashes: + ... hello = 'hello, world\n' + >>> hellos = repr(hello) + >>> print(hellos) + 'hello, world\n' + >>> # The argument to repr() may be any Python object: + ... repr((x, y, ('spam', 'eggs'))) + "(32.5, 40000, ('spam', 'eggs'))" + +The :mod:`string` module contains a :class:`~string.Template` class that offers +yet another way to substitute values into strings, using placeholders like +``$x`` and replacing them with values from a dictionary, but offers much less +control of the formatting. + + +.. _tut-f-strings: + +Formatted String Literals +------------------------- + +:ref:`Formatted string literals ` (also called f-strings for +short) let you include the value of Python expressions inside a string by +prefixing the string with ``f`` or ``F`` and writing expressions as +``{expression}``. + +An optional format specifier can follow the expression. This allows greater +control over how the value is formatted. The following example rounds pi to +three places after the decimal:: + + >>> import math + >>> print(f'The value of pi is approximately {math.pi:.3f}.') + The value of pi is approximately 3.142. + +Passing an integer after the ``':'`` will cause that field to be a minimum +number of characters wide. This is useful for making columns line up. :: + + >>> table = {'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 7678} + >>> for name, phone in table.items(): + ... print(f'{name:10} ==> {phone:10d}') + ... + Sjoerd ==> 4127 + Jack ==> 4098 + Dcab ==> 7678 + +Other modifiers can be used to convert the value before it is formatted. +``'!a'`` applies :func:`ascii`, ``'!s'`` applies :func:`str`, and ``'!r'`` +applies :func:`repr`:: + + >>> animals = 'eels' + >>> print(f'My hovercraft is full of {animals}.') + My hovercraft is full of eels. + >>> print(f'My hovercraft is full of {animals!r}.') + My hovercraft is full of 'eels'. + +For a reference on these format specifications, see +the reference guide for the :ref:`formatspec`. + +.. _tut-string-format: + +The String format() Method +-------------------------- + +Basic usage of the :meth:`str.format` method looks like this:: + + >>> print('We are the {} who say "{}!"'.format('knights', 'Ni')) + We are the knights who say "Ni!" + +The brackets and characters within them (called format fields) are replaced with +the objects passed into the :meth:`str.format` method. A number in the +brackets can be used to refer to the position of the object passed into the +:meth:`str.format` method. :: + + >>> print('{0} and {1}'.format('spam', 'eggs')) + spam and eggs + >>> print('{1} and {0}'.format('spam', 'eggs')) + eggs and spam + +If keyword arguments are used in the :meth:`str.format` method, their values +are referred to by using the name of the argument. :: + + >>> print('This {food} is {adjective}.'.format( + ... food='spam', adjective='absolutely horrible')) + This spam is absolutely horrible. + +Positional and keyword arguments can be arbitrarily combined:: + + >>> print('The story of {0}, {1}, and {other}.'.format('Bill', 'Manfred', + other='Georg')) + The story of Bill, Manfred, and Georg. + +If you have a really long format string that you don't want to split up, it +would be nice if you could reference the variables to be formatted by name +instead of by position. This can be done by simply passing the dict and using +square brackets ``'[]'`` to access the keys :: + + >>> table = {'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 8637678} + >>> print('Jack: {0[Jack]:d}; Sjoerd: {0[Sjoerd]:d}; ' + ... 'Dcab: {0[Dcab]:d}'.format(table)) + Jack: 4098; Sjoerd: 4127; Dcab: 8637678 + +This could also be done by passing the table as keyword arguments with the '**' +notation. :: + + >>> table = {'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 8637678} + >>> print('Jack: {Jack:d}; Sjoerd: {Sjoerd:d}; Dcab: {Dcab:d}'.format(**table)) + Jack: 4098; Sjoerd: 4127; Dcab: 8637678 + +This is particularly useful in combination with the built-in function +:func:`vars`, which returns a dictionary containing all local variables. + +As an example, the following lines produce a tidily-aligned +set of columns giving integers and their squares and cubes:: + + >>> for x in range(1, 11): + ... print('{0:2d} {1:3d} {2:4d}'.format(x, x*x, x*x*x)) + ... + 1 1 1 + 2 4 8 + 3 9 27 + 4 16 64 + 5 25 125 + 6 36 216 + 7 49 343 + 8 64 512 + 9 81 729 + 10 100 1000 + +For a complete overview of string formatting with :meth:`str.format`, see +:ref:`formatstrings`. + + +Manual String Formatting +------------------------ + +Here's the same table of squares and cubes, formatted manually:: + + >>> for x in range(1, 11): + ... print(repr(x).rjust(2), repr(x*x).rjust(3), end=' ') + ... # Note use of 'end' on previous line + ... print(repr(x*x*x).rjust(4)) + ... + 1 1 1 + 2 4 8 + 3 9 27 + 4 16 64 + 5 25 125 + 6 36 216 + 7 49 343 + 8 64 512 + 9 81 729 + 10 100 1000 + +(Note that the one space between each column was added by the +way :func:`print` works: it always adds spaces between its arguments.) + +The :meth:`str.rjust` method of string objects right-justifies a string in a +field of a given width by padding it with spaces on the left. There are +similar methods :meth:`str.ljust` and :meth:`str.center`. These methods do +not write anything, they just return a new string. If the input string is too +long, they don't truncate it, but return it unchanged; this will mess up your +column lay-out but that's usually better than the alternative, which would be +lying about a value. (If you really want truncation you can always add a +slice operation, as in ``x.ljust(n)[:n]``.) + +There is another method, :meth:`str.zfill`, which pads a numeric string on the +left with zeros. It understands about plus and minus signs:: + + >>> '12'.zfill(5) + '00012' + >>> '-3.14'.zfill(7) + '-003.14' + >>> '3.14159265359'.zfill(5) + '3.14159265359' + + +Old string formatting +--------------------- + +The ``%`` operator can also be used for string formatting. It interprets the +left argument much like a :c:func:`sprintf`\ -style format string to be applied +to the right argument, and returns the string resulting from this formatting +operation. For example:: + + >>> import math + >>> print('The value of pi is approximately %5.3f.' % math.pi) + The value of pi is approximately 3.142. + +More information can be found in the :ref:`old-string-formatting` section. + + +.. _tut-files: + +Reading and Writing Files +========================= + +.. index:: + builtin: open + object: file + +:func:`open` returns a :term:`file object`, and is most commonly used with +two arguments: ``open(filename, mode)``. + +:: + + >>> f = open('workfile', 'w') + +.. XXX str(f) is + + >>> print(f) + + +The first argument is a string containing the filename. The second argument is +another string containing a few characters describing the way in which the file +will be used. *mode* can be ``'r'`` when the file will only be read, ``'w'`` +for only writing (an existing file with the same name will be erased), and +``'a'`` opens the file for appending; any data written to the file is +automatically added to the end. ``'r+'`` opens the file for both reading and +writing. The *mode* argument is optional; ``'r'`` will be assumed if it's +omitted. + +Normally, files are opened in :dfn:`text mode`, that means, you read and write +strings from and to the file, which are encoded in a specific encoding. If +encoding is not specified, the default is platform dependent (see +:func:`open`). ``'b'`` appended to the mode opens the file in +:dfn:`binary mode`: now the data is read and written in the form of bytes +objects. This mode should be used for all files that don't contain text. + +In text mode, the default when reading is to convert platform-specific line +endings (``\n`` on Unix, ``\r\n`` on Windows) to just ``\n``. When writing in +text mode, the default is to convert occurrences of ``\n`` back to +platform-specific line endings. This behind-the-scenes modification +to file data is fine for text files, but will corrupt binary data like that in +:file:`JPEG` or :file:`EXE` files. Be very careful to use binary mode when +reading and writing such files. + +It is good practice to use the :keyword:`with` keyword when dealing +with file objects. The advantage is that the file is properly closed +after its suite finishes, even if an exception is raised at some +point. Using :keyword:`!with` is also much shorter than writing +equivalent :keyword:`try`\ -\ :keyword:`finally` blocks:: + + >>> with open('workfile') as f: + ... read_data = f.read() + >>> f.closed + True + +If you're not using the :keyword:`with` keyword, then you should call +``f.close()`` to close the file and immediately free up any system +resources used by it. If you don't explicitly close a file, Python's +garbage collector will eventually destroy the object and close the +open file for you, but the file may stay open for a while. Another +risk is that different Python implementations will do this clean-up at +different times. + +After a file object is closed, either by a :keyword:`with` statement +or by calling ``f.close()``, attempts to use the file object will +automatically fail. :: + + >>> f.close() + >>> f.read() + Traceback (most recent call last): + File "", line 1, in + ValueError: I/O operation on closed file. + + +.. _tut-filemethods: + +Methods of File Objects +----------------------- + +The rest of the examples in this section will assume that a file object called +``f`` has already been created. + +To read a file's contents, call ``f.read(size)``, which reads some quantity of +data and returns it as a string (in text mode) or bytes object (in binary mode). +*size* is an optional numeric argument. When *size* is omitted or negative, the +entire contents of the file will be read and returned; it's your problem if the +file is twice as large as your machine's memory. Otherwise, at most *size* bytes +are read and returned. +If the end of the file has been reached, ``f.read()`` will return an empty +string (``''``). :: + + >>> f.read() + 'This is the entire file.\n' + >>> f.read() + '' + +``f.readline()`` reads a single line from the file; a newline character (``\n``) +is left at the end of the string, and is only omitted on the last line of the +file if the file doesn't end in a newline. This makes the return value +unambiguous; if ``f.readline()`` returns an empty string, the end of the file +has been reached, while a blank line is represented by ``'\n'``, a string +containing only a single newline. :: + + >>> f.readline() + 'This is the first line of the file.\n' + >>> f.readline() + 'Second line of the file\n' + >>> f.readline() + '' + +For reading lines from a file, you can loop over the file object. This is memory +efficient, fast, and leads to simple code:: + + >>> for line in f: + ... print(line, end='') + ... + This is the first line of the file. + Second line of the file + +If you want to read all the lines of a file in a list you can also use +``list(f)`` or ``f.readlines()``. + +``f.write(string)`` writes the contents of *string* to the file, returning +the number of characters written. :: + + >>> f.write('This is a test\n') + 15 + +Other types of objects need to be converted -- either to a string (in text mode) +or a bytes object (in binary mode) -- before writing them:: + + >>> value = ('the answer', 42) + >>> s = str(value) # convert the tuple to string + >>> f.write(s) + 18 + +``f.tell()`` returns an integer giving the file object's current position in the file +represented as number of bytes from the beginning of the file when in binary mode and +an opaque number when in text mode. + +To change the file object's position, use ``f.seek(offset, from_what)``. The position is computed +from adding *offset* to a reference point; the reference point is selected by +the *from_what* argument. A *from_what* value of 0 measures from the beginning +of the file, 1 uses the current file position, and 2 uses the end of the file as +the reference point. *from_what* can be omitted and defaults to 0, using the +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 + 5 + >>> f.read(1) + b'5' + >>> f.seek(-3, 2) # Go to the 3rd byte before the end + 13 + >>> f.read(1) + b'd' + +In text files (those opened without a ``b`` in the mode string), only seeks +relative to the beginning of the file are allowed (the exception being seeking +to the very file end with ``seek(0, 2)``) and the only valid *offset* values are +those returned from the ``f.tell()``, or zero. Any other *offset* value produces +undefined behaviour. + +File objects have some additional methods, such as :meth:`~file.isatty` and +:meth:`~file.truncate` which are less frequently used; consult the Library +Reference for a complete guide to file objects. + + +.. _tut-json: + +Saving structured data with :mod:`json` +--------------------------------------- + +.. index:: module: json + +Strings can easily be written to and read from a file. Numbers take a bit more +effort, since the :meth:`read` method only returns strings, which will have to +be passed to a function like :func:`int`, which takes a string like ``'123'`` +and returns its numeric value 123. When you want to save more complex data +types like nested lists and dictionaries, parsing and serializing by hand +becomes complicated. + +Rather than having users constantly writing and debugging code to save +complicated data types to files, Python allows you to use the popular data +interchange format called `JSON (JavaScript Object Notation) +`_. The standard module called :mod:`json` can take Python +data hierarchies, and convert them to string representations; this process is +called :dfn:`serializing`. Reconstructing the data from the string representation +is called :dfn:`deserializing`. Between serializing and deserializing, the +string representing the object may have been stored in a file or data, or +sent over a network connection to some distant machine. + +.. note:: + The JSON format is commonly used by modern applications to allow for data + exchange. Many programmers are already familiar with it, which makes + it a good choice for interoperability. + +If you have an object ``x``, you can view its JSON string representation with a +simple line of code:: + + >>> import json + >>> json.dumps([1, 'simple', 'list']) + '[1, "simple", "list"]' + +Another variant of the :func:`~json.dumps` function, called :func:`~json.dump`, +simply serializes the object to a :term:`text file`. So if ``f`` is a +:term:`text file` object opened for writing, we can do this:: + + json.dump(x, f) + +To decode the object again, if ``f`` is a :term:`text file` object which has +been opened for reading:: + + x = json.load(f) + +This simple serialization technique can handle lists and dictionaries, but +serializing arbitrary class instances in JSON requires a bit of extra effort. +The reference for the :mod:`json` module contains an explanation of this. + +.. seealso:: + + :mod:`pickle` - the pickle module + + Contrary to :ref:`JSON `, *pickle* is a protocol which allows + the serialization of arbitrarily complex Python objects. As such, it is + specific to Python and cannot be used to communicate with applications + written in other languages. It is also insecure by default: + deserializing pickle data coming from an untrusted source can execute + arbitrary code, if the data was crafted by a skilled attacker. diff --git a/python-3.7.4-docs-html/_sources/tutorial/interactive.rst.txt b/python-3.7.4-docs-html/_sources/tutorial/interactive.rst.txt new file mode 100644 index 0000000..c0eb1fe --- /dev/null +++ b/python-3.7.4-docs-html/_sources/tutorial/interactive.rst.txt @@ -0,0 +1,54 @@ +.. _tut-interacting: + +************************************************** +Interactive Input Editing and History Substitution +************************************************** + +Some versions of the Python interpreter support editing of the current input +line and history substitution, similar to facilities found in the Korn shell and +the GNU Bash shell. This is implemented using the `GNU Readline`_ library, +which supports various styles of editing. This library has its own +documentation which we won't duplicate here. + + +.. _tut-keybindings: + +Tab Completion and History Editing +================================== + +Completion of variable and module names is +:ref:`automatically enabled ` at interpreter startup so +that the :kbd:`Tab` key invokes the completion function; it looks at +Python statement names, the current local variables, and the available +module names. For dotted expressions such as ``string.a``, it will evaluate +the expression up to the final ``'.'`` and then suggest completions from +the attributes of the resulting object. Note that this may execute +application-defined code if an object with a :meth:`__getattr__` method +is part of the expression. The default configuration also saves your +history into a file named :file:`.python_history` in your user directory. +The history will be available again during the next interactive interpreter +session. + + +.. _tut-commentary: + +Alternatives to the Interactive Interpreter +=========================================== + +This facility is an enormous step forward compared to earlier versions of the +interpreter; however, some wishes are left: It would be nice if the proper +indentation were suggested on continuation lines (the parser knows if an indent +token is required next). The completion mechanism might use the interpreter's +symbol table. A command to check (or even suggest) matching parentheses, +quotes, etc., would also be useful. + +One alternative enhanced interactive interpreter that has been around for quite +some time is IPython_, which features tab completion, object exploration and +advanced history management. It can also be thoroughly customized and embedded +into other applications. Another similar enhanced interactive environment is +bpython_. + + +.. _GNU Readline: https://tiswww.case.edu/php/chet/readline/rltop.html +.. _IPython: https://ipython.org/ +.. _bpython: https://www.bpython-interpreter.org/ diff --git a/python-3.7.4-docs-html/_sources/tutorial/interpreter.rst.txt b/python-3.7.4-docs-html/_sources/tutorial/interpreter.rst.txt new file mode 100644 index 0000000..647dd72 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/tutorial/interpreter.rst.txt @@ -0,0 +1,162 @@ +.. _tut-using: + +**************************** +Using the Python Interpreter +**************************** + + +.. _tut-invoking: + +Invoking the Interpreter +======================== + +The Python interpreter is usually installed as :file:`/usr/local/bin/python3.7` +on those machines where it is available; putting :file:`/usr/local/bin` in your +Unix shell's search path makes it possible to start it by typing the command: + +.. code-block:: text + + python3.7 + +to the shell. [#]_ Since the choice of the directory where the interpreter lives +is an installation option, other places are possible; check with your local +Python guru or system administrator. (E.g., :file:`/usr/local/python` is a +popular alternative location.) + +On Windows machines where you have installed from the :ref:`Microsoft Store +`, the :file:`python3.7` command will be available. If you have +the :ref:`py.exe launcher ` installed, you can use the :file:`py` +command. See :ref:`setting-envvars` for other ways to launch Python. + +Typing an end-of-file character (:kbd:`Control-D` on Unix, :kbd:`Control-Z` on +Windows) at the primary prompt causes the interpreter to exit with a zero exit +status. If that doesn't work, you can exit the interpreter by typing the +following command: ``quit()``. + +The interpreter's line-editing features include interactive editing, history +substitution and code completion on systems that support readline. Perhaps the +quickest check to see whether command line editing is supported is typing +:kbd:`Control-P` to the first Python prompt you get. If it beeps, you have command +line editing; see Appendix :ref:`tut-interacting` for an introduction to the +keys. If nothing appears to happen, or if ``^P`` is echoed, command line +editing isn't available; you'll only be able to use backspace to remove +characters from the current line. + +The interpreter operates somewhat like the Unix shell: when called with standard +input connected to a tty device, it reads and executes commands interactively; +when called with a file name argument or with a file as standard input, it reads +and executes a *script* from that file. + +A second way of starting the interpreter is ``python -c command [arg] ...``, +which executes the statement(s) in *command*, analogous to the shell's +:option:`-c` option. Since Python statements often contain spaces or other +characters that are special to the shell, it is usually advised to quote +*command* in its entirety with single quotes. + +Some Python modules are also useful as scripts. These can be invoked using +``python -m module [arg] ...``, which executes the source file for *module* as +if you had spelled out its full name on the command line. + +When a script file is used, it is sometimes useful to be able to run the script +and enter interactive mode afterwards. This can be done by passing :option:`-i` +before the script. + +All command line options are described in :ref:`using-on-general`. + + +.. _tut-argpassing: + +Argument Passing +---------------- + +When known to the interpreter, the script name and additional arguments +thereafter are turned into a list of strings and assigned to the ``argv`` +variable in the ``sys`` module. You can access this list by executing ``import +sys``. The length of the list is at least one; when no script and no arguments +are given, ``sys.argv[0]`` is an empty string. When the script name is given as +``'-'`` (meaning standard input), ``sys.argv[0]`` is set to ``'-'``. When +:option:`-c` *command* is used, ``sys.argv[0]`` is set to ``'-c'``. When +:option:`-m` *module* is used, ``sys.argv[0]`` is set to the full name of the +located module. Options found after :option:`-c` *command* or :option:`-m` +*module* are not consumed by the Python interpreter's option processing but +left in ``sys.argv`` for the command or module to handle. + + +.. _tut-interactive: + +Interactive Mode +---------------- + +When commands are read from a tty, the interpreter is said to be in *interactive +mode*. In this mode it prompts for the next command with the *primary prompt*, +usually three greater-than signs (``>>>``); for continuation lines it prompts +with the *secondary prompt*, by default three dots (``...``). The interpreter +prints a welcome message stating its version number and a copyright notice +before printing the first prompt: + +.. code-block:: shell-session + + $ python3.7 + Python 3.7 (default, Sep 16 2015, 09:25:04) + [GCC 4.8.2] on linux + Type "help", "copyright", "credits" or "license" for more information. + >>> + +.. XXX update for new releases + +Continuation lines are needed when entering a multi-line construct. As an +example, take a look at this :keyword:`if` statement:: + + >>> the_world_is_flat = True + >>> if the_world_is_flat: + ... print("Be careful not to fall off!") + ... + Be careful not to fall off! + + +For more on interactive mode, see :ref:`tut-interac`. + + +.. _tut-interp: + +The Interpreter and Its Environment +=================================== + + +.. _tut-source-encoding: + +Source Code Encoding +-------------------- + +By default, Python source files are treated as encoded in UTF-8. In that +encoding, characters of most languages in the world can be used simultaneously +in string literals, identifiers and comments --- although the standard library +only uses ASCII characters for identifiers, a convention that any portable code +should follow. To display all these characters properly, your editor must +recognize that the file is UTF-8, and it must use a font that supports all the +characters in the file. + +To declare an encoding other than the default one, a special comment line +should be added as the *first* line of the file. The syntax is as follows:: + + # -*- coding: encoding -*- + +where *encoding* is one of the valid :mod:`codecs` supported by Python. + +For example, to declare that Windows-1252 encoding is to be used, the first +line of your source code file should be:: + + # -*- coding: cp1252 -*- + +One exception to the *first line* rule is when the source code starts with a +:ref:`UNIX "shebang" line `. In this case, the encoding +declaration should be added as the second line of the file. For example:: + + #!/usr/bin/env python3 + # -*- coding: cp1252 -*- + +.. rubric:: Footnotes + +.. [#] On Unix, the Python 3.x interpreter is by default not installed with the + executable named ``python``, so that it does not conflict with a + simultaneously installed Python 2.x executable. diff --git a/python-3.7.4-docs-html/_sources/tutorial/introduction.rst.txt b/python-3.7.4-docs-html/_sources/tutorial/introduction.rst.txt new file mode 100644 index 0000000..a4dbd63 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/tutorial/introduction.rst.txt @@ -0,0 +1,545 @@ +.. _tut-informal: + +********************************** +An Informal Introduction to Python +********************************** + +In the following examples, input and output are distinguished by the presence or +absence of prompts (:term:`>>>` and :term:`...`): to repeat the example, you must type +everything after the prompt, when the prompt appears; lines that do not begin +with a prompt are output from the interpreter. Note that a secondary prompt on a +line by itself in an example means you must type a blank line; this is used to +end a multi-line command. + +.. index:: single: # (hash); comment + +Many of the examples in this manual, even those entered at the interactive +prompt, include comments. Comments in Python start with the hash character, +``#``, and extend to the end of the physical line. A comment may appear at the +start of a line or following whitespace or code, but not within a string +literal. A hash character within a string literal is just a hash character. +Since comments are to clarify code and are not interpreted by Python, they may +be omitted when typing in examples. + +Some examples:: + + # this is the first comment + spam = 1 # and this is the second comment + # ... and now a third! + text = "# This is not a comment because it's inside quotes." + + +.. _tut-calculator: + +Using Python as a Calculator +============================ + +Let's try some simple Python commands. Start the interpreter and wait for the +primary prompt, ``>>>``. (It shouldn't take long.) + + +.. _tut-numbers: + +Numbers +------- + +The interpreter acts as a simple calculator: you can type an expression at it +and it will write the value. Expression syntax is straightforward: the +operators ``+``, ``-``, ``*`` and ``/`` work just like in most other languages +(for example, Pascal or C); parentheses (``()``) can be used for grouping. +For example:: + + >>> 2 + 2 + 4 + >>> 50 - 5*6 + 20 + >>> (50 - 5*6) / 4 + 5.0 + >>> 8 / 5 # division always returns a floating point number + 1.6 + +The integer numbers (e.g. ``2``, ``4``, ``20``) have type :class:`int`, +the ones with a fractional part (e.g. ``5.0``, ``1.6``) have type +:class:`float`. We will see more about numeric types later in the tutorial. + +Division (``/``) always returns a float. To do :term:`floor division` and +get an integer result (discarding any fractional result) you can use the ``//`` +operator; to calculate the remainder you can use ``%``:: + + >>> 17 / 3 # classic division returns a float + 5.666666666666667 + >>> + >>> 17 // 3 # floor division discards the fractional part + 5 + >>> 17 % 3 # the % operator returns the remainder of the division + 2 + >>> 5 * 3 + 2 # result * divisor + remainder + 17 + +With Python, it is possible to use the ``**`` operator to calculate powers [#]_:: + + >>> 5 ** 2 # 5 squared + 25 + >>> 2 ** 7 # 2 to the power of 7 + 128 + +The equal sign (``=``) is used to assign a value to a variable. Afterwards, no +result is displayed before the next interactive prompt:: + + >>> width = 20 + >>> height = 5 * 9 + >>> width * height + 900 + +If a variable is not "defined" (assigned a value), trying to use it will +give you an error:: + + >>> n # try to access an undefined variable + Traceback (most recent call last): + File "", line 1, in + NameError: name 'n' is not defined + +There is full support for floating point; operators with mixed type operands +convert the integer operand to floating point:: + + >>> 4 * 3.75 - 1 + 14.0 + +In interactive mode, the last printed expression is assigned to the variable +``_``. This means that when you are using Python as a desk calculator, it is +somewhat easier to continue calculations, for example:: + + >>> tax = 12.5 / 100 + >>> price = 100.50 + >>> price * tax + 12.5625 + >>> price + _ + 113.0625 + >>> round(_, 2) + 113.06 + +This variable should be treated as read-only by the user. Don't explicitly +assign a value to it --- you would create an independent local variable with the +same name masking the built-in variable with its magic behavior. + +In addition to :class:`int` and :class:`float`, Python supports other types of +numbers, such as :class:`~decimal.Decimal` and :class:`~fractions.Fraction`. +Python also has built-in support for :ref:`complex numbers `, +and uses the ``j`` or ``J`` suffix to indicate the imaginary part +(e.g. ``3+5j``). + + +.. _tut-strings: + +Strings +------- + +Besides numbers, Python can also manipulate strings, which can be expressed +in several ways. They can be enclosed in single quotes (``'...'``) or +double quotes (``"..."``) with the same result [#]_. ``\`` can be used +to escape quotes:: + + >>> 'spam eggs' # single quotes + 'spam eggs' + >>> 'doesn\'t' # use \' to escape the single quote... + "doesn't" + >>> "doesn't" # ...or use double quotes instead + "doesn't" + >>> '"Yes," they said.' + '"Yes," they said.' + >>> "\"Yes,\" they said." + '"Yes," they said.' + >>> '"Isn\'t," they said.' + '"Isn\'t," they said.' + +In the interactive interpreter, the output string is enclosed in quotes and +special characters are escaped with backslashes. While this might sometimes +look different from the input (the enclosing quotes could change), the two +strings are equivalent. The string is enclosed in double quotes if +the string contains a single quote and no double quotes, otherwise it is +enclosed in single quotes. The :func:`print` function produces a more +readable output, by omitting the enclosing quotes and by printing escaped +and special characters:: + + >>> '"Isn\'t," they said.' + '"Isn\'t," they said.' + >>> print('"Isn\'t," they said.') + "Isn't," they said. + >>> s = 'First line.\nSecond line.' # \n means newline + >>> s # without print(), \n is included in the output + 'First line.\nSecond line.' + >>> print(s) # with print(), \n produces a new line + First line. + Second line. + +If you don't want characters prefaced by ``\`` to be interpreted as +special characters, you can use *raw strings* by adding an ``r`` before +the first quote:: + + >>> print('C:\some\name') # here \n means newline! + C:\some + ame + >>> print(r'C:\some\name') # note the r before the quote + C:\some\name + +String literals can span multiple lines. One way is using triple-quotes: +``"""..."""`` or ``'''...'''``. End of lines are automatically +included in the string, but it's possible to prevent this by adding a ``\`` at +the end of the line. The following example:: + + print("""\ + Usage: thingy [OPTIONS] + -h Display this usage message + -H hostname Hostname to connect to + """) + +produces the following output (note that the initial newline is not included): + +.. code-block:: text + + Usage: thingy [OPTIONS] + -h Display this usage message + -H hostname Hostname to connect to + +Strings can be concatenated (glued together) with the ``+`` operator, and +repeated with ``*``:: + + >>> # 3 times 'un', followed by 'ium' + >>> 3 * 'un' + 'ium' + 'unununium' + +Two or more *string literals* (i.e. the ones enclosed between quotes) next +to each other are automatically concatenated. :: + + >>> 'Py' 'thon' + 'Python' + +This feature is particularly useful when you want to break long strings:: + + >>> text = ('Put several strings within parentheses ' + ... 'to have them joined together.') + >>> text + 'Put several strings within parentheses to have them joined together.' + +This only works with two literals though, not with variables or expressions:: + + >>> prefix = 'Py' + >>> prefix 'thon' # can't concatenate a variable and a string literal + File "", line 1 + prefix 'thon' + ^ + SyntaxError: invalid syntax + >>> ('un' * 3) 'ium' + File "", line 1 + ('un' * 3) 'ium' + ^ + SyntaxError: invalid syntax + +If you want to concatenate variables or a variable and a literal, use ``+``:: + + >>> prefix + 'thon' + 'Python' + +Strings can be *indexed* (subscripted), with the first character having index 0. +There is no separate character type; a character is simply a string of size +one:: + + >>> word = 'Python' + >>> word[0] # character in position 0 + 'P' + >>> word[5] # character in position 5 + 'n' + +Indices may also be negative numbers, to start counting from the right:: + + >>> word[-1] # last character + 'n' + >>> word[-2] # second-last character + 'o' + >>> word[-6] + 'P' + +Note that since -0 is the same as 0, negative indices start from -1. + +In addition to indexing, *slicing* is also supported. While indexing is used +to obtain individual characters, *slicing* allows you to obtain substring:: + + >>> word[0:2] # characters from position 0 (included) to 2 (excluded) + 'Py' + >>> word[2:5] # characters from position 2 (included) to 5 (excluded) + 'tho' + +Note how the start is always included, and the end always excluded. This +makes sure that ``s[:i] + s[i:]`` is always equal to ``s``:: + + >>> word[:2] + word[2:] + 'Python' + >>> word[:4] + word[4:] + 'Python' + +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) + 'Py' + >>> word[4:] # characters from position 4 (included) to the end + 'on' + >>> 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 +*between* characters, with the left edge of the first character numbered 0. +Then the right edge of the last character of a string of *n* characters has +index *n*, for example:: + + +---+---+---+---+---+---+ + | P | y | t | h | o | n | + +---+---+---+---+---+---+ + 0 1 2 3 4 5 6 + -6 -5 -4 -3 -2 -1 + +The first row of numbers gives the position of the indices 0...6 in the string; +the second row gives the corresponding negative indices. The slice from *i* to +*j* consists of all characters between the edges labeled *i* and *j*, +respectively. + +For non-negative indices, the length of a slice is the difference of the +indices, if both are within bounds. For example, the length of ``word[1:3]`` is +2. + +Attempting to use an index that is too large will result in an error:: + + >>> word[42] # the word only has 6 characters + Traceback (most recent call last): + File "", line 1, in + IndexError: string index out of range + +However, out of range slice indexes are handled gracefully when used for +slicing:: + + >>> word[4:42] + 'on' + >>> word[42:] + '' + +Python strings cannot be changed --- they are :term:`immutable`. +Therefore, assigning to an indexed position in the string results in an error:: + + >>> word[0] = 'J' + Traceback (most recent call last): + File "", line 1, in + TypeError: 'str' object does not support item assignment + >>> word[2:] = 'py' + Traceback (most recent call last): + File "", line 1, in + TypeError: 'str' object does not support item assignment + +If you need a different string, you should create a new one:: + + >>> 'J' + word[1:] + 'Jython' + >>> word[:2] + 'py' + 'Pypy' + +The built-in function :func:`len` returns the length of a string:: + + >>> s = 'supercalifragilisticexpialidocious' + >>> len(s) + 34 + + +.. seealso:: + + :ref:`textseq` + Strings are examples of *sequence types*, and support the common + operations supported by such types. + + :ref:`string-methods` + Strings support a large number of methods for + basic transformations and searching. + + :ref:`f-strings` + String literals that have embedded expressions. + + :ref:`formatstrings` + Information about string formatting with :meth:`str.format`. + + :ref:`old-string-formatting` + The old formatting operations invoked when strings are + the left operand of the ``%`` operator are described in more detail here. + + +.. _tut-lists: + +Lists +----- + +Python knows a number of *compound* data types, used to group together other +values. The most versatile is the *list*, which can be written as a list of +comma-separated values (items) between square brackets. Lists might contain +items of different types, but usually the items all have the same type. :: + + >>> squares = [1, 4, 9, 16, 25] + >>> squares + [1, 4, 9, 16, 25] + +Like strings (and all other built-in :term:`sequence` types), lists can be +indexed and sliced:: + + >>> squares[0] # indexing returns the item + 1 + >>> squares[-1] + 25 + >>> squares[-3:] # slicing returns a new list + [9, 16, 25] + +All slice operations return a new list containing the requested elements. This +means that the following slice returns a new (shallow) copy of the list:: + + >>> squares[:] + [1, 4, 9, 16, 25] + +Lists also support operations like concatenation:: + + >>> squares + [36, 49, 64, 81, 100] + [1, 4, 9, 16, 25, 36, 49, 64, 81, 100] + +Unlike strings, which are :term:`immutable`, lists are a :term:`mutable` +type, i.e. it is possible to change their content:: + + >>> cubes = [1, 8, 27, 65, 125] # something's wrong here + >>> 4 ** 3 # the cube of 4 is 64, not 65! + 64 + >>> cubes[3] = 64 # replace the wrong value + >>> cubes + [1, 8, 27, 64, 125] + +You can also add new items at the end of the list, by using +the :meth:`~list.append` *method* (we will see more about methods later):: + + >>> cubes.append(216) # add the cube of 6 + >>> cubes.append(7 ** 3) # and the cube of 7 + >>> cubes + [1, 8, 27, 64, 125, 216, 343] + +Assignment to slices is also possible, and this can even change the size of the +list or clear it entirely:: + + >>> letters = ['a', 'b', 'c', 'd', 'e', 'f', 'g'] + >>> letters + ['a', 'b', 'c', 'd', 'e', 'f', 'g'] + >>> # replace some values + >>> letters[2:5] = ['C', 'D', 'E'] + >>> letters + ['a', 'b', 'C', 'D', 'E', 'f', 'g'] + >>> # now remove them + >>> letters[2:5] = [] + >>> letters + ['a', 'b', 'f', 'g'] + >>> # clear the list by replacing all the elements with an empty list + >>> letters[:] = [] + >>> letters + [] + +The built-in function :func:`len` also applies to lists:: + + >>> letters = ['a', 'b', 'c', 'd'] + >>> len(letters) + 4 + +It is possible to nest lists (create lists containing other lists), for +example:: + + >>> a = ['a', 'b', 'c'] + >>> n = [1, 2, 3] + >>> x = [a, n] + >>> x + [['a', 'b', 'c'], [1, 2, 3]] + >>> x[0] + ['a', 'b', 'c'] + >>> x[0][1] + 'b' + +.. _tut-firststeps: + +First Steps Towards Programming +=============================== + +Of course, we can use Python for more complicated tasks than adding two and two +together. For instance, we can write an initial sub-sequence of the +`Fibonacci series `_ +as follows:: + + >>> # Fibonacci series: + ... # the sum of two elements defines the next + ... a, b = 0, 1 + >>> while a < 10: + ... print(a) + ... a, b = b, a+b + ... + 0 + 1 + 1 + 2 + 3 + 5 + 8 + +This example introduces several new features. + +* The first line contains a *multiple assignment*: the variables ``a`` and ``b`` + simultaneously get the new values 0 and 1. On the last line this is used again, + demonstrating that the expressions on the right-hand side are all evaluated + first before any of the assignments take place. The right-hand side expressions + are evaluated from the left to the right. + +* The :keyword:`while` loop executes as long as the condition (here: ``a < 10``) + remains true. In Python, like in C, any non-zero integer value is true; zero is + false. The condition may also be a string or list value, in fact any sequence; + anything with a non-zero length is true, empty sequences are false. The test + used in the example is a simple comparison. The standard comparison operators + are written the same as in C: ``<`` (less than), ``>`` (greater than), ``==`` + (equal to), ``<=`` (less than or equal to), ``>=`` (greater than or equal to) + and ``!=`` (not equal to). + +* The *body* of the loop is *indented*: indentation is Python's way of grouping + statements. At the interactive prompt, you have to type a tab or space(s) for + each indented line. In practice you will prepare more complicated input + for Python with a text editor; all decent text editors have an auto-indent + facility. When a compound statement is entered interactively, it must be + followed by a blank line to indicate completion (since the parser cannot + guess when you have typed the last line). Note that each line within a basic + block must be indented by the same amount. + +* The :func:`print` function writes the value of the argument(s) it is given. + It differs from just writing the expression you want to write (as we did + earlier in the calculator examples) in the way it handles multiple arguments, + floating point quantities, and strings. Strings are printed without quotes, + and a space is inserted between items, so you can format things nicely, like + this:: + + >>> i = 256*256 + >>> print('The value of i is', i) + The value of i is 65536 + + The keyword argument *end* can be used to avoid the newline after the output, + or end the output with a different string:: + + >>> a, b = 0, 1 + >>> while a < 1000: + ... print(a, end=',') + ... a, b = b, a+b + ... + 0,1,1,2,3,5,8,13,21,34,55,89,144,233,377,610,987, + + +.. rubric:: Footnotes + +.. [#] Since ``**`` has higher precedence than ``-``, ``-3**2`` will be + interpreted as ``-(3**2)`` and thus result in ``-9``. To avoid this + and get ``9``, you can use ``(-3)**2``. + +.. [#] Unlike other languages, special characters such as ``\n`` have the + same meaning with both single (``'...'``) and double (``"..."``) quotes. + The only difference between the two is that within single quotes you don't + need to escape ``"`` (but you have to escape ``\'``) and vice versa. diff --git a/python-3.7.4-docs-html/_sources/tutorial/modules.rst.txt b/python-3.7.4-docs-html/_sources/tutorial/modules.rst.txt new file mode 100644 index 0000000..d0a68fa --- /dev/null +++ b/python-3.7.4-docs-html/_sources/tutorial/modules.rst.txt @@ -0,0 +1,572 @@ +.. _tut-modules: + +******* +Modules +******* + +If you quit from the Python interpreter and enter it again, the definitions you +have made (functions and variables) are lost. Therefore, if you want to write a +somewhat longer program, you are better off using a text editor to prepare the +input for the interpreter and running it with that file as input instead. This +is known as creating a *script*. As your program gets longer, you may want to +split it into several files for easier maintenance. You may also want to use a +handy function that you've written in several programs without copying its +definition into each program. + +To support this, Python has a way to put definitions in a file and use them in a +script or in an interactive instance of the interpreter. Such a file is called a +*module*; definitions from a module can be *imported* into other modules or into +the *main* module (the collection of variables that you have access to in a +script executed at the top level and in calculator mode). + +A module is a file containing Python definitions and statements. The file name +is the module name with the suffix :file:`.py` appended. Within a module, the +module's name (as a string) is available as the value of the global variable +``__name__``. For instance, use your favorite text editor to create a file +called :file:`fibo.py` in the current directory with the following contents:: + + # Fibonacci numbers module + + def fib(n): # write Fibonacci series up to n + a, b = 0, 1 + while a < n: + print(a, end=' ') + a, b = b, a+b + print() + + def fib2(n): # return Fibonacci series up to n + result = [] + a, b = 0, 1 + while a < n: + result.append(a) + a, b = b, a+b + return result + +Now enter the Python interpreter and import this module with the following +command:: + + >>> import fibo + +This does not enter the names of the functions defined in ``fibo`` directly in +the current symbol table; it only enters the module name ``fibo`` there. Using +the module name you can access the functions:: + + >>> fibo.fib(1000) + 0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987 + >>> fibo.fib2(100) + [0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89] + >>> fibo.__name__ + 'fibo' + +If you intend to use a function often you can assign it to a local name:: + + >>> fib = fibo.fib + >>> fib(500) + 0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 + + +.. _tut-moremodules: + +More on Modules +=============== + +A module can contain executable statements as well as function definitions. +These statements are intended to initialize the module. They are executed only +the *first* time the module name is encountered in an import statement. [#]_ +(They are also run if the file is executed as a script.) + +Each module has its own private symbol table, which is used as the global symbol +table by all functions defined in the module. Thus, the author of a module can +use global variables in the module without worrying about accidental clashes +with a user's global variables. On the other hand, if you know what you are +doing you can touch a module's global variables with the same notation used to +refer to its functions, ``modname.itemname``. + +Modules can import other modules. It is customary but not required to place all +:keyword:`import` statements at the beginning of a module (or script, for that +matter). The imported module names are placed in the importing module's global +symbol table. + +There is a variant of the :keyword:`import` statement that imports names from a +module directly into the importing module's symbol table. For example:: + + >>> from fibo import fib, fib2 + >>> fib(500) + 0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 + +This does not introduce the module name from which the imports are taken in the +local symbol table (so in the example, ``fibo`` is not defined). + +There is even a variant to import all names that a module defines:: + + >>> from fibo import * + >>> fib(500) + 0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 + +This imports all names except those beginning with an underscore (``_``). +In most cases Python programmers do not use this facility since it introduces +an unknown set of names into the interpreter, possibly hiding some things +you have already defined. + +Note that in general the practice of importing ``*`` from a module or package is +frowned upon, since it often causes poorly readable code. However, it is okay to +use it to save typing in interactive sessions. + +If the module name is followed by :keyword:`!as`, then the name +following :keyword:`!as` is bound directly to the imported module. + +:: + + >>> import fibo as fib + >>> fib.fib(500) + 0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 + +This is effectively importing the module in the same way that ``import fibo`` +will do, with the only difference of it being available as ``fib``. + +It can also be used when utilising :keyword:`from` with similar effects:: + + >>> from fibo import fib as fibonacci + >>> fibonacci(500) + 0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 + + +.. note:: + + For efficiency reasons, each module is only imported once per interpreter + session. Therefore, if you change your modules, you must restart the + interpreter -- or, if it's just one module you want to test interactively, + use :func:`importlib.reload`, e.g. ``import importlib; + importlib.reload(modulename)``. + + +.. _tut-modulesasscripts: + +Executing modules as scripts +---------------------------- + +When you run a Python module with :: + + python fibo.py + +the code in the module will be executed, just as if you imported it, but with +the ``__name__`` set to ``"__main__"``. That means that by adding this code at +the end of your module:: + + if __name__ == "__main__": + import sys + fib(int(sys.argv[1])) + +you can make the file usable as a script as well as an importable module, +because the code that parses the command line only runs if the module is +executed as the "main" file: + +.. code-block:: shell-session + + $ python fibo.py 50 + 0 1 1 2 3 5 8 13 21 34 + +If the module is imported, the code is not run:: + + >>> import fibo + >>> + +This is often used either to provide a convenient user interface to a module, or +for testing purposes (running the module as a script executes a test suite). + + +.. _tut-searchpath: + +The Module Search Path +---------------------- + +.. index:: triple: module; search; path + +When a module named :mod:`spam` is imported, the interpreter first searches for +a built-in module with that name. If not found, it then searches for a file +named :file:`spam.py` in a list of directories given by the variable +:data:`sys.path`. :data:`sys.path` is initialized from these locations: + +* The directory containing the input script (or the current directory when no + file is specified). +* :envvar:`PYTHONPATH` (a list of directory names, with the same syntax as the + shell variable :envvar:`PATH`). +* The installation-dependent default. + +.. note:: + On file systems which support symlinks, the directory containing the input + script is calculated after the symlink is followed. In other words the + directory containing the symlink is **not** added to the module search path. + +After initialization, Python programs can modify :data:`sys.path`. The +directory containing the script being run is placed at the beginning of the +search path, ahead of the standard library path. This means that scripts in that +directory will be loaded instead of modules of the same name in the library +directory. This is an error unless the replacement is intended. See section +:ref:`tut-standardmodules` for more information. + +.. % + Do we need stuff on zip files etc. ? DUBOIS + +"Compiled" Python files +----------------------- + +To speed up loading modules, Python caches the compiled version of each module +in the ``__pycache__`` directory under the name :file:`module.{version}.pyc`, +where the version encodes the format of the compiled file; it generally contains +the Python version number. For example, in CPython release 3.3 the compiled +version of spam.py would be cached as ``__pycache__/spam.cpython-33.pyc``. This +naming convention allows compiled modules from different releases and different +versions of Python to coexist. + +Python checks the modification date of the source against the compiled version +to see if it's out of date and needs to be recompiled. This is a completely +automatic process. Also, the compiled modules are platform-independent, so the +same library can be shared among systems with different architectures. + +Python does not check the cache in two circumstances. First, it always +recompiles and does not store the result for the module that's loaded directly +from the command line. Second, it does not check the cache if there is no +source module. To support a non-source (compiled only) distribution, the +compiled module must be in the source directory, and there must not be a source +module. + +Some tips for experts: + +* You can use the :option:`-O` or :option:`-OO` switches on the Python command + to reduce the size of a compiled module. The ``-O`` switch removes assert + statements, the ``-OO`` switch removes both assert statements and __doc__ + strings. Since some programs may rely on having these available, you should + only use this option if you know what you're doing. "Optimized" modules have + an ``opt-`` tag and are usually smaller. Future releases may + change the effects of optimization. + +* A program doesn't run any faster when it is read from a ``.pyc`` + file than when it is read from a ``.py`` file; the only thing that's faster + about ``.pyc`` files is the speed with which they are loaded. + +* The module :mod:`compileall` can create .pyc files for all modules in a + directory. + +* There is more detail on this process, including a flow chart of the + decisions, in :pep:`3147`. + + +.. _tut-standardmodules: + +Standard Modules +================ + +.. index:: module: sys + +Python comes with a library of standard modules, described in a separate +document, the Python Library Reference ("Library Reference" hereafter). Some +modules are built into the interpreter; these provide access to operations that +are not part of the core of the language but are nevertheless built in, either +for efficiency or to provide access to operating system primitives such as +system calls. The set of such modules is a configuration option which also +depends on the underlying platform. For example, the :mod:`winreg` module is only +provided on Windows systems. One particular module deserves some attention: +:mod:`sys`, which is built into every Python interpreter. The variables +``sys.ps1`` and ``sys.ps2`` define the strings used as primary and secondary +prompts:: + + >>> import sys + >>> sys.ps1 + '>>> ' + >>> sys.ps2 + '... ' + >>> sys.ps1 = 'C> ' + C> print('Yuck!') + Yuck! + C> + + +These two variables are only defined if the interpreter is in interactive mode. + +The variable ``sys.path`` is a list of strings that determines the interpreter's +search path for modules. It is initialized to a default path taken from the +environment variable :envvar:`PYTHONPATH`, or from a built-in default if +:envvar:`PYTHONPATH` is not set. You can modify it using standard list +operations:: + + >>> import sys + >>> sys.path.append('/ufs/guido/lib/python') + + +.. _tut-dir: + +The :func:`dir` Function +======================== + +The built-in function :func:`dir` is used to find out which names a module +defines. It returns a sorted list of strings:: + + >>> import fibo, sys + >>> dir(fibo) + ['__name__', 'fib', 'fib2'] + >>> dir(sys) # doctest: +NORMALIZE_WHITESPACE + ['__displayhook__', '__doc__', '__excepthook__', '__loader__', '__name__', + '__package__', '__stderr__', '__stdin__', '__stdout__', + '_clear_type_cache', '_current_frames', '_debugmallocstats', '_getframe', + '_home', '_mercurial', '_xoptions', 'abiflags', 'api_version', 'argv', + 'base_exec_prefix', 'base_prefix', 'builtin_module_names', 'byteorder', + 'call_tracing', 'callstats', 'copyright', 'displayhook', + 'dont_write_bytecode', 'exc_info', 'excepthook', 'exec_prefix', + 'executable', 'exit', 'flags', 'float_info', 'float_repr_style', + 'getcheckinterval', 'getdefaultencoding', 'getdlopenflags', + 'getfilesystemencoding', 'getobjects', 'getprofile', 'getrecursionlimit', + 'getrefcount', 'getsizeof', 'getswitchinterval', 'gettotalrefcount', + 'gettrace', 'hash_info', 'hexversion', 'implementation', 'int_info', + 'intern', 'maxsize', 'maxunicode', 'meta_path', 'modules', 'path', + 'path_hooks', 'path_importer_cache', 'platform', 'prefix', 'ps1', + 'setcheckinterval', 'setdlopenflags', 'setprofile', 'setrecursionlimit', + 'setswitchinterval', 'settrace', 'stderr', 'stdin', 'stdout', + 'thread_info', 'version', 'version_info', 'warnoptions'] + +Without arguments, :func:`dir` lists the names you have defined currently:: + + >>> a = [1, 2, 3, 4, 5] + >>> import fibo + >>> fib = fibo.fib + >>> dir() + ['__builtins__', '__name__', 'a', 'fib', 'fibo', 'sys'] + +Note that it lists all types of names: variables, modules, functions, etc. + +.. index:: module: builtins + +:func:`dir` does not list the names of built-in functions and variables. If you +want a list of those, they are defined in the standard module +:mod:`builtins`:: + + >>> import builtins + >>> dir(builtins) # doctest: +NORMALIZE_WHITESPACE + ['ArithmeticError', 'AssertionError', 'AttributeError', 'BaseException', + 'BlockingIOError', 'BrokenPipeError', 'BufferError', 'BytesWarning', + 'ChildProcessError', 'ConnectionAbortedError', 'ConnectionError', + 'ConnectionRefusedError', 'ConnectionResetError', 'DeprecationWarning', + 'EOFError', 'Ellipsis', 'EnvironmentError', 'Exception', 'False', + 'FileExistsError', 'FileNotFoundError', 'FloatingPointError', + 'FutureWarning', 'GeneratorExit', 'IOError', 'ImportError', + 'ImportWarning', 'IndentationError', 'IndexError', 'InterruptedError', + 'IsADirectoryError', 'KeyError', 'KeyboardInterrupt', 'LookupError', + 'MemoryError', 'NameError', 'None', 'NotADirectoryError', 'NotImplemented', + 'NotImplementedError', 'OSError', 'OverflowError', + 'PendingDeprecationWarning', 'PermissionError', 'ProcessLookupError', + 'ReferenceError', 'ResourceWarning', 'RuntimeError', 'RuntimeWarning', + 'StopIteration', 'SyntaxError', 'SyntaxWarning', 'SystemError', + 'SystemExit', 'TabError', 'TimeoutError', 'True', 'TypeError', + 'UnboundLocalError', 'UnicodeDecodeError', 'UnicodeEncodeError', + 'UnicodeError', 'UnicodeTranslateError', 'UnicodeWarning', 'UserWarning', + 'ValueError', 'Warning', 'ZeroDivisionError', '_', '__build_class__', + '__debug__', '__doc__', '__import__', '__name__', '__package__', 'abs', + 'all', 'any', 'ascii', 'bin', 'bool', 'bytearray', 'bytes', 'callable', + 'chr', 'classmethod', 'compile', 'complex', 'copyright', 'credits', + 'delattr', 'dict', 'dir', 'divmod', 'enumerate', 'eval', 'exec', 'exit', + 'filter', 'float', 'format', 'frozenset', 'getattr', 'globals', 'hasattr', + 'hash', 'help', 'hex', 'id', 'input', 'int', 'isinstance', 'issubclass', + 'iter', 'len', 'license', 'list', 'locals', 'map', 'max', 'memoryview', + 'min', 'next', 'object', 'oct', 'open', 'ord', 'pow', 'print', 'property', + 'quit', 'range', 'repr', 'reversed', 'round', 'set', 'setattr', 'slice', + 'sorted', 'staticmethod', 'str', 'sum', 'super', 'tuple', 'type', 'vars', + 'zip'] + +.. _tut-packages: + +Packages +======== + +Packages are a way of structuring Python's module namespace by using "dotted +module names". For example, the module name :mod:`A.B` designates a submodule +named ``B`` in a package named ``A``. Just like the use of modules saves the +authors of different modules from having to worry about each other's global +variable names, the use of dotted module names saves the authors of multi-module +packages like NumPy or Pillow from having to worry about +each other's module names. + +Suppose you want to design a collection of modules (a "package") for the uniform +handling of sound files and sound data. There are many different sound file +formats (usually recognized by their extension, for example: :file:`.wav`, +:file:`.aiff`, :file:`.au`), so you may need to create and maintain a growing +collection of modules for the conversion between the various file formats. +There are also many different operations you might want to perform on sound data +(such as mixing, adding echo, applying an equalizer function, creating an +artificial stereo effect), so in addition you will be writing a never-ending +stream of modules to perform these operations. Here's a possible structure for +your package (expressed in terms of a hierarchical filesystem): + +.. code-block:: text + + sound/ Top-level package + __init__.py Initialize the sound package + formats/ Subpackage for file format conversions + __init__.py + wavread.py + wavwrite.py + aiffread.py + aiffwrite.py + auread.py + auwrite.py + ... + effects/ Subpackage for sound effects + __init__.py + echo.py + surround.py + reverse.py + ... + filters/ Subpackage for filters + __init__.py + equalizer.py + vocoder.py + karaoke.py + ... + +When importing the package, Python searches through the directories on +``sys.path`` looking for the package subdirectory. + +The :file:`__init__.py` files are required to make Python treat directories +containing the file as packages. This prevents directories with a common name, +such as ``string``, unintentionally hiding valid modules that occur later +on the module search path. In the simplest case, :file:`__init__.py` can just be +an empty file, but it can also execute initialization code for the package or +set the ``__all__`` variable, described later. + +Users of the package can import individual modules from the package, for +example:: + + import sound.effects.echo + +This loads the submodule :mod:`sound.effects.echo`. It must be referenced with +its full name. :: + + sound.effects.echo.echofilter(input, output, delay=0.7, atten=4) + +An alternative way of importing the submodule is:: + + from sound.effects import echo + +This also loads the submodule :mod:`echo`, and makes it available without its +package prefix, so it can be used as follows:: + + echo.echofilter(input, output, delay=0.7, atten=4) + +Yet another variation is to import the desired function or variable directly:: + + from sound.effects.echo import echofilter + +Again, this loads the submodule :mod:`echo`, but this makes its function +:func:`echofilter` directly available:: + + echofilter(input, output, delay=0.7, atten=4) + +Note that when using ``from package import item``, the item can be either a +submodule (or subpackage) of the package, or some other name defined in the +package, like a function, class or variable. The ``import`` statement first +tests whether the item is defined in the package; if not, it assumes it is a +module and attempts to load it. If it fails to find it, an :exc:`ImportError` +exception is raised. + +Contrarily, when using syntax like ``import item.subitem.subsubitem``, each item +except for the last must be a package; the last item can be a module or a +package but can't be a class or function or variable defined in the previous +item. + + +.. _tut-pkg-import-star: + +Importing \* From a Package +--------------------------- + +.. index:: single: __all__ + +Now what happens when the user writes ``from sound.effects import *``? Ideally, +one would hope that this somehow goes out to the filesystem, finds which +submodules are present in the package, and imports them all. This could take a +long time and importing sub-modules might have unwanted side-effects that should +only happen when the sub-module is explicitly imported. + +The only solution is for the package author to provide an explicit index of the +package. The :keyword:`import` statement uses the following convention: if a package's +:file:`__init__.py` code defines a list named ``__all__``, it is taken to be the +list of module names that should be imported when ``from package import *`` is +encountered. It is up to the package author to keep this list up-to-date when a +new version of the package is released. Package authors may also decide not to +support it, if they don't see a use for importing \* from their package. For +example, the file :file:`sound/effects/__init__.py` could contain the following +code:: + + __all__ = ["echo", "surround", "reverse"] + +This would mean that ``from sound.effects import *`` would import the three +named submodules of the :mod:`sound` package. + +If ``__all__`` is not defined, the statement ``from sound.effects import *`` +does *not* import all submodules from the package :mod:`sound.effects` into the +current namespace; it only ensures that the package :mod:`sound.effects` has +been imported (possibly running any initialization code in :file:`__init__.py`) +and then imports whatever names are defined in the package. This includes any +names defined (and submodules explicitly loaded) by :file:`__init__.py`. It +also includes any submodules of the package that were explicitly loaded by +previous :keyword:`import` statements. Consider this code:: + + import sound.effects.echo + import sound.effects.surround + from sound.effects import * + +In this example, the :mod:`echo` and :mod:`surround` modules are imported in the +current namespace because they are defined in the :mod:`sound.effects` package +when the ``from...import`` statement is executed. (This also works when +``__all__`` is defined.) + +Although certain modules are designed to export only names that follow certain +patterns when you use ``import *``, it is still considered bad practice in +production code. + +Remember, there is nothing wrong with using ``from package import +specific_submodule``! In fact, this is the recommended notation unless the +importing module needs to use submodules with the same name from different +packages. + + +Intra-package References +------------------------ + +When packages are structured into subpackages (as with the :mod:`sound` package +in the example), you can use absolute imports to refer to submodules of siblings +packages. For example, if the module :mod:`sound.filters.vocoder` needs to use +the :mod:`echo` module in the :mod:`sound.effects` package, it can use ``from +sound.effects import echo``. + +You can also write relative imports, with the ``from module import name`` form +of import statement. These imports use leading dots to indicate the current and +parent packages involved in the relative import. From the :mod:`surround` +module for example, you might use:: + + from . import echo + from .. import formats + from ..filters import equalizer + +Note that relative imports are based on the name of the current module. Since +the name of the main module is always ``"__main__"``, modules intended for use +as the main module of a Python application must always use absolute imports. + + +Packages in Multiple Directories +-------------------------------- + +Packages support one more special attribute, :attr:`__path__`. This is +initialized to be a list containing the name of the directory holding the +package's :file:`__init__.py` before the code in that file is executed. This +variable can be modified; doing so affects future searches for modules and +subpackages contained in the package. + +While this feature is not often needed, it can be used to extend the set of +modules found in a package. + + +.. rubric:: Footnotes + +.. [#] In fact function definitions are also 'statements' that are 'executed'; the + execution of a module-level function definition enters the function name in + the module's global symbol table. diff --git a/python-3.7.4-docs-html/_sources/tutorial/stdlib.rst.txt b/python-3.7.4-docs-html/_sources/tutorial/stdlib.rst.txt new file mode 100644 index 0000000..f5ec8ac --- /dev/null +++ b/python-3.7.4-docs-html/_sources/tutorial/stdlib.rst.txt @@ -0,0 +1,340 @@ +.. _tut-brieftour: + +********************************** +Brief Tour of the Standard Library +********************************** + + +.. _tut-os-interface: + +Operating System Interface +========================== + +The :mod:`os` module provides dozens of functions for interacting with the +operating system:: + + >>> import os + >>> os.getcwd() # Return the current working directory + 'C:\\Python37' + >>> os.chdir('/server/accesslogs') # Change current working directory + >>> os.system('mkdir today') # Run the command mkdir in the system shell + 0 + +Be sure to use the ``import os`` style instead of ``from os import *``. This +will keep :func:`os.open` from shadowing the built-in :func:`open` function which +operates much differently. + +.. index:: builtin: help + +The built-in :func:`dir` and :func:`help` functions are useful as interactive +aids for working with large modules like :mod:`os`:: + + >>> import os + >>> dir(os) + + >>> help(os) + + +For daily file and directory management tasks, the :mod:`shutil` module provides +a higher level interface that is easier to use:: + + >>> import shutil + >>> shutil.copyfile('data.db', 'archive.db') + 'archive.db' + >>> shutil.move('/build/executables', 'installdir') + 'installdir' + + +.. _tut-file-wildcards: + +File Wildcards +============== + +The :mod:`glob` module provides a function for making file lists from directory +wildcard searches:: + + >>> import glob + >>> glob.glob('*.py') + ['primes.py', 'random.py', 'quote.py'] + + +.. _tut-command-line-arguments: + +Command Line Arguments +====================== + +Common utility scripts often need to process command line arguments. These +arguments are stored in the :mod:`sys` module's *argv* attribute as a list. For +instance the following output results from running ``python demo.py one two +three`` at the command line:: + + >>> import sys + >>> print(sys.argv) + ['demo.py', 'one', 'two', 'three'] + +The :mod:`getopt` module processes *sys.argv* using the conventions of the Unix +:func:`getopt` function. More powerful and flexible command line processing is +provided by the :mod:`argparse` module. + + +.. _tut-stderr: + +Error Output Redirection and Program Termination +================================================ + +The :mod:`sys` module also has attributes for *stdin*, *stdout*, and *stderr*. +The latter is useful for emitting warnings and error messages to make them +visible even when *stdout* has been redirected:: + + >>> sys.stderr.write('Warning, log file not found starting a new one\n') + Warning, log file not found starting a new one + +The most direct way to terminate a script is to use ``sys.exit()``. + + +.. _tut-string-pattern-matching: + +String Pattern Matching +======================= + +The :mod:`re` module provides regular expression tools for advanced string +processing. For complex matching and manipulation, regular expressions offer +succinct, optimized solutions:: + + >>> import re + >>> re.findall(r'\bf[a-z]*', 'which foot or hand fell fastest') + ['foot', 'fell', 'fastest'] + >>> re.sub(r'(\b[a-z]+) \1', r'\1', 'cat in the the hat') + 'cat in the hat' + +When only simple capabilities are needed, string methods are preferred because +they are easier to read and debug:: + + >>> 'tea for too'.replace('too', 'two') + 'tea for two' + + +.. _tut-mathematics: + +Mathematics +=========== + +The :mod:`math` module gives access to the underlying C library functions for +floating point math:: + + >>> import math + >>> math.cos(math.pi / 4) + 0.70710678118654757 + >>> math.log(1024, 2) + 10.0 + +The :mod:`random` module provides tools for making random selections:: + + >>> import random + >>> random.choice(['apple', 'pear', 'banana']) + 'apple' + >>> random.sample(range(100), 10) # sampling without replacement + [30, 83, 16, 4, 8, 81, 41, 50, 18, 33] + >>> random.random() # random float + 0.17970987693706186 + >>> random.randrange(6) # random integer chosen from range(6) + 4 + +The :mod:`statistics` module calculates basic statistical properties +(the mean, median, variance, etc.) of numeric data:: + + >>> import statistics + >>> data = [2.75, 1.75, 1.25, 0.25, 0.5, 1.25, 3.5] + >>> statistics.mean(data) + 1.6071428571428572 + >>> statistics.median(data) + 1.25 + >>> statistics.variance(data) + 1.3720238095238095 + +The SciPy project has many other modules for numerical +computations. + +.. _tut-internet-access: + +Internet Access +=============== + +There are a number of modules for accessing the internet and processing internet +protocols. Two of the simplest are :mod:`urllib.request` for retrieving data +from URLs and :mod:`smtplib` for sending mail:: + + >>> from urllib.request import urlopen + >>> with urlopen('http://tycho.usno.navy.mil/cgi-bin/timer.pl') as response: + ... for line in response: + ... line = line.decode('utf-8') # Decoding the binary data to text. + ... if 'EST' in line or 'EDT' in line: # look for Eastern Time + ... print(line) + +
    Nov. 25, 09:43:32 PM EST + + >>> import smtplib + >>> server = smtplib.SMTP('localhost') + >>> server.sendmail('soothsayer@example.org', 'jcaesar@example.org', + ... """To: jcaesar@example.org + ... From: soothsayer@example.org + ... + ... Beware the Ides of March. + ... """) + >>> server.quit() + +(Note that the second example needs a mailserver running on localhost.) + + +.. _tut-dates-and-times: + +Dates and Times +=============== + +The :mod:`datetime` module supplies classes for manipulating dates and times in +both simple and complex ways. While date and time arithmetic is supported, the +focus of the implementation is on efficient member extraction for output +formatting and manipulation. The module also supports objects that are timezone +aware. :: + + >>> # dates are easily constructed and formatted + >>> from datetime import date + >>> now = date.today() + >>> now + datetime.date(2003, 12, 2) + >>> now.strftime("%m-%d-%y. %d %b %Y is a %A on the %d day of %B.") + '12-02-03. 02 Dec 2003 is a Tuesday on the 02 day of December.' + + >>> # dates support calendar arithmetic + >>> birthday = date(1964, 7, 31) + >>> age = now - birthday + >>> age.days + 14368 + + +.. _tut-data-compression: + +Data Compression +================ + +Common data archiving and compression formats are directly supported by modules +including: :mod:`zlib`, :mod:`gzip`, :mod:`bz2`, :mod:`lzma`, :mod:`zipfile` and +:mod:`tarfile`. :: + + >>> import zlib + >>> s = b'witch which has which witches wrist watch' + >>> len(s) + 41 + >>> t = zlib.compress(s) + >>> len(t) + 37 + >>> zlib.decompress(t) + b'witch which has which witches wrist watch' + >>> zlib.crc32(s) + 226805979 + + +.. _tut-performance-measurement: + +Performance Measurement +======================= + +Some Python users develop a deep interest in knowing the relative performance of +different approaches to the same problem. Python provides a measurement tool +that answers those questions immediately. + +For example, it may be tempting to use the tuple packing and unpacking feature +instead of the traditional approach to swapping arguments. The :mod:`timeit` +module quickly demonstrates a modest performance advantage:: + + >>> from timeit import Timer + >>> Timer('t=a; a=b; b=t', 'a=1; b=2').timeit() + 0.57535828626024577 + >>> Timer('a,b = b,a', 'a=1; b=2').timeit() + 0.54962537085770791 + +In contrast to :mod:`timeit`'s fine level of granularity, the :mod:`profile` and +:mod:`pstats` modules provide tools for identifying time critical sections in +larger blocks of code. + + +.. _tut-quality-control: + +Quality Control +=============== + +One approach for developing high quality software is to write tests for each +function as it is developed and to run those tests frequently during the +development process. + +The :mod:`doctest` module provides a tool for scanning a module and validating +tests embedded in a program's docstrings. Test construction is as simple as +cutting-and-pasting a typical call along with its results into the docstring. +This improves the documentation by providing the user with an example and it +allows the doctest module to make sure the code remains true to the +documentation:: + + def average(values): + """Computes the arithmetic mean of a list of numbers. + + >>> print(average([20, 30, 70])) + 40.0 + """ + return sum(values) / len(values) + + import doctest + doctest.testmod() # automatically validate the embedded tests + +The :mod:`unittest` module is not as effortless as the :mod:`doctest` module, +but it allows a more comprehensive set of tests to be maintained in a separate +file:: + + import unittest + + class TestStatisticalFunctions(unittest.TestCase): + + def test_average(self): + self.assertEqual(average([20, 30, 70]), 40.0) + self.assertEqual(round(average([1, 5, 7]), 1), 4.3) + with self.assertRaises(ZeroDivisionError): + average([]) + with self.assertRaises(TypeError): + average(20, 30, 70) + + unittest.main() # Calling from the command line invokes all tests + + +.. _tut-batteries-included: + +Batteries Included +================== + +Python has a "batteries included" philosophy. This is best seen through the +sophisticated and robust capabilities of its larger packages. For example: + +* The :mod:`xmlrpc.client` and :mod:`xmlrpc.server` modules make implementing + remote procedure calls into an almost trivial task. Despite the modules + names, no direct knowledge or handling of XML is needed. + +* The :mod:`email` package is a library for managing email messages, including + MIME and other :rfc:`2822`-based message documents. Unlike :mod:`smtplib` and + :mod:`poplib` which actually send and receive messages, the email package has + a complete toolset for building or decoding complex message structures + (including attachments) and for implementing internet encoding and header + protocols. + +* The :mod:`json` package provides robust support for parsing this + popular data interchange format. The :mod:`csv` module supports + direct reading and writing of files in Comma-Separated Value format, + commonly supported by databases and spreadsheets. XML processing is + supported by the :mod:`xml.etree.ElementTree`, :mod:`xml.dom` and + :mod:`xml.sax` packages. Together, these modules and packages + greatly simplify data interchange between Python applications and + other tools. + +* The :mod:`sqlite3` module is a wrapper for the SQLite database + library, providing a persistent database that can be updated and + accessed using slightly nonstandard SQL syntax. + +* Internationalization is supported by a number of modules including + :mod:`gettext`, :mod:`locale`, and the :mod:`codecs` package. diff --git a/python-3.7.4-docs-html/_sources/tutorial/stdlib2.rst.txt b/python-3.7.4-docs-html/_sources/tutorial/stdlib2.rst.txt new file mode 100644 index 0000000..9947231 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/tutorial/stdlib2.rst.txt @@ -0,0 +1,405 @@ +.. _tut-brieftourtwo: + +********************************************** +Brief Tour of the Standard Library --- Part II +********************************************** + +This second tour covers more advanced modules that support professional +programming needs. These modules rarely occur in small scripts. + + +.. _tut-output-formatting: + +Output Formatting +================= + +The :mod:`reprlib` module provides a version of :func:`repr` customized for +abbreviated displays of large or deeply nested containers:: + + >>> import reprlib + >>> reprlib.repr(set('supercalifragilisticexpialidocious')) + "{'a', 'c', 'd', 'e', 'f', 'g', ...}" + +The :mod:`pprint` module offers more sophisticated control over printing both +built-in and user defined objects in a way that is readable by the interpreter. +When the result is longer than one line, the "pretty printer" adds line breaks +and indentation to more clearly reveal data structure:: + + >>> import pprint + >>> t = [[[['black', 'cyan'], 'white', ['green', 'red']], [['magenta', + ... 'yellow'], 'blue']]] + ... + >>> pprint.pprint(t, width=30) + [[[['black', 'cyan'], + 'white', + ['green', 'red']], + [['magenta', 'yellow'], + 'blue']]] + +The :mod:`textwrap` module formats paragraphs of text to fit a given screen +width:: + + >>> import textwrap + >>> doc = """The wrap() method is just like fill() except that it returns + ... a list of strings instead of one big string with newlines to separate + ... the wrapped lines.""" + ... + >>> print(textwrap.fill(doc, width=40)) + The wrap() method is just like fill() + except that it returns a list of strings + instead of one big string with newlines + to separate the wrapped lines. + +The :mod:`locale` module accesses a database of culture specific data formats. +The grouping attribute of locale's format function provides a direct way of +formatting numbers with group separators:: + + >>> import locale + >>> locale.setlocale(locale.LC_ALL, 'English_United States.1252') + 'English_United States.1252' + >>> conv = locale.localeconv() # get a mapping of conventions + >>> x = 1234567.8 + >>> locale.format("%d", x, grouping=True) + '1,234,567' + >>> locale.format_string("%s%.*f", (conv['currency_symbol'], + ... conv['frac_digits'], x), grouping=True) + '$1,234,567.80' + + +.. _tut-templating: + +Templating +========== + +The :mod:`string` module includes a versatile :class:`~string.Template` class +with a simplified syntax suitable for editing by end-users. This allows users +to customize their applications without having to alter the application. + +The format uses placeholder names formed by ``$`` with valid Python identifiers +(alphanumeric characters and underscores). Surrounding the placeholder with +braces allows it to be followed by more alphanumeric letters with no intervening +spaces. Writing ``$$`` creates a single escaped ``$``:: + + >>> from string import Template + >>> t = Template('${village}folk send $$10 to $cause.') + >>> t.substitute(village='Nottingham', cause='the ditch fund') + 'Nottinghamfolk send $10 to the ditch fund.' + +The :meth:`~string.Template.substitute` method raises a :exc:`KeyError` when a +placeholder is not supplied in a dictionary or a keyword argument. For +mail-merge style applications, user supplied data may be incomplete and the +:meth:`~string.Template.safe_substitute` method may be more appropriate --- +it will leave placeholders unchanged if data is missing:: + + >>> t = Template('Return the $item to $owner.') + >>> d = dict(item='unladen swallow') + >>> t.substitute(d) + Traceback (most recent call last): + ... + KeyError: 'owner' + >>> t.safe_substitute(d) + 'Return the unladen swallow to $owner.' + +Template subclasses can specify a custom delimiter. For example, a batch +renaming utility for a photo browser may elect to use percent signs for +placeholders such as the current date, image sequence number, or file format:: + + >>> import time, os.path + >>> photofiles = ['img_1074.jpg', 'img_1076.jpg', 'img_1077.jpg'] + >>> class BatchRename(Template): + ... delimiter = '%' + >>> fmt = input('Enter rename style (%d-date %n-seqnum %f-format): ') + Enter rename style (%d-date %n-seqnum %f-format): Ashley_%n%f + + >>> t = BatchRename(fmt) + >>> date = time.strftime('%d%b%y') + >>> for i, filename in enumerate(photofiles): + ... base, ext = os.path.splitext(filename) + ... newname = t.substitute(d=date, n=i, f=ext) + ... print('{0} --> {1}'.format(filename, newname)) + + img_1074.jpg --> Ashley_0.jpg + img_1076.jpg --> Ashley_1.jpg + img_1077.jpg --> Ashley_2.jpg + +Another application for templating is separating program logic from the details +of multiple output formats. This makes it possible to substitute custom +templates for XML files, plain text reports, and HTML web reports. + + +.. _tut-binary-formats: + +Working with Binary Data Record Layouts +======================================= + +The :mod:`struct` module provides :func:`~struct.pack` and +:func:`~struct.unpack` functions for working with variable length binary +record formats. The following example shows +how to loop through header information in a ZIP file without using the +:mod:`zipfile` module. Pack codes ``"H"`` and ``"I"`` represent two and four +byte unsigned numbers respectively. The ``"<"`` indicates that they are +standard size and in little-endian byte order:: + + import struct + + with open('myfile.zip', 'rb') as f: + data = f.read() + + start = 0 + for i in range(3): # show the first 3 file headers + start += 14 + fields = struct.unpack('>> import weakref, gc + >>> class A: + ... def __init__(self, value): + ... self.value = value + ... def __repr__(self): + ... return str(self.value) + ... + >>> a = A(10) # create a reference + >>> d = weakref.WeakValueDictionary() + >>> d['primary'] = a # does not create a reference + >>> d['primary'] # fetch the object if it is still alive + 10 + >>> del a # remove the one reference + >>> gc.collect() # run garbage collection right away + 0 + >>> d['primary'] # entry was automatically removed + Traceback (most recent call last): + File "", line 1, in + d['primary'] # entry was automatically removed + File "C:/python37/lib/weakref.py", line 46, in __getitem__ + o = self.data[key]() + KeyError: 'primary' + + +.. _tut-list-tools: + +Tools for Working with Lists +============================ + +Many data structure needs can be met with the built-in list type. However, +sometimes there is a need for alternative implementations with different +performance trade-offs. + +The :mod:`array` module provides an :class:`~array.array()` object that is like +a list that stores only homogeneous data and stores it more compactly. The +following example shows an array of numbers stored as two byte unsigned binary +numbers (typecode ``"H"``) rather than the usual 16 bytes per entry for regular +lists of Python int objects:: + + >>> from array import array + >>> a = array('H', [4000, 10, 700, 22222]) + >>> sum(a) + 26932 + >>> a[1:3] + array('H', [10, 700]) + +The :mod:`collections` module provides a :class:`~collections.deque()` object +that is like a list with faster appends and pops from the left side but slower +lookups in the middle. These objects are well suited for implementing queues +and breadth first tree searches:: + + >>> from collections import deque + >>> d = deque(["task1", "task2", "task3"]) + >>> d.append("task4") + >>> print("Handling", d.popleft()) + Handling task1 + +:: + + unsearched = deque([starting_node]) + def breadth_first_search(unsearched): + node = unsearched.popleft() + for m in gen_moves(node): + if is_goal(m): + return m + unsearched.append(m) + +In addition to alternative list implementations, the library also offers other +tools such as the :mod:`bisect` module with functions for manipulating sorted +lists:: + + >>> import bisect + >>> scores = [(100, 'perl'), (200, 'tcl'), (400, 'lua'), (500, 'python')] + >>> bisect.insort(scores, (300, 'ruby')) + >>> scores + [(100, 'perl'), (200, 'tcl'), (300, 'ruby'), (400, 'lua'), (500, 'python')] + +The :mod:`heapq` module provides functions for implementing heaps based on +regular lists. The lowest valued entry is always kept at position zero. This +is useful for applications which repeatedly access the smallest element but do +not want to run a full list sort:: + + >>> from heapq import heapify, heappop, heappush + >>> data = [1, 3, 5, 7, 9, 2, 4, 6, 8, 0] + >>> heapify(data) # rearrange the list into heap order + >>> heappush(data, -5) # add a new entry + >>> [heappop(data) for i in range(3)] # fetch the three smallest entries + [-5, 0, 1] + + +.. _tut-decimal-fp: + +Decimal Floating Point Arithmetic +================================= + +The :mod:`decimal` module offers a :class:`~decimal.Decimal` datatype for +decimal floating point arithmetic. Compared to the built-in :class:`float` +implementation of binary floating point, the class is especially helpful for + +* financial applications and other uses which require exact decimal + representation, +* control over precision, +* control over rounding to meet legal or regulatory requirements, +* tracking of significant decimal places, or +* applications where the user expects the results to match calculations done by + hand. + +For example, calculating a 5% tax on a 70 cent phone charge gives different +results in decimal floating point and binary floating point. The difference +becomes significant if the results are rounded to the nearest cent:: + + >>> from decimal import * + >>> round(Decimal('0.70') * Decimal('1.05'), 2) + Decimal('0.74') + >>> round(.70 * 1.05, 2) + 0.73 + +The :class:`~decimal.Decimal` result keeps a trailing zero, automatically +inferring four place significance from multiplicands with two place +significance. Decimal reproduces mathematics as done by hand and avoids +issues that can arise when binary floating point cannot exactly represent +decimal quantities. + +Exact representation enables the :class:`~decimal.Decimal` class to perform +modulo calculations and equality tests that are unsuitable for binary floating +point:: + + >>> Decimal('1.00') % Decimal('.10') + Decimal('0.00') + >>> 1.00 % 0.10 + 0.09999999999999995 + + >>> sum([Decimal('0.1')]*10) == Decimal('1.0') + True + >>> sum([0.1]*10) == 1.0 + False + +The :mod:`decimal` module provides arithmetic with as much precision as needed:: + + >>> getcontext().prec = 36 + >>> Decimal(1) / Decimal(7) + Decimal('0.142857142857142857142857142857142857') + + diff --git a/python-3.7.4-docs-html/_sources/tutorial/venv.rst.txt b/python-3.7.4-docs-html/_sources/tutorial/venv.rst.txt new file mode 100644 index 0000000..dc4136e --- /dev/null +++ b/python-3.7.4-docs-html/_sources/tutorial/venv.rst.txt @@ -0,0 +1,210 @@ + +.. _tut-venv: + +********************************* +Virtual Environments and Packages +********************************* + +Introduction +============ + +Python applications will often use packages and modules that don't +come as part of the standard library. Applications will sometimes +need a specific version of a library, because the application may +require that a particular bug has been fixed or the application may be +written using an obsolete version of the library's interface. + +This means it may not be possible for one Python installation to meet +the requirements of every application. If application A needs version +1.0 of a particular module but application B needs version 2.0, then +the requirements are in conflict and installing either version 1.0 or 2.0 +will leave one application unable to run. + +The solution for this problem is to create a :term:`virtual environment`, a +self-contained directory tree that contains a Python installation for a +particular version of Python, plus a number of additional packages. + +Different applications can then use different virtual environments. +To resolve the earlier example of conflicting requirements, +application A can have its own virtual environment with version 1.0 +installed while application B has another virtual environment with version 2.0. +If application B requires a library be upgraded to version 3.0, this will +not affect application A's environment. + + +Creating Virtual Environments +============================= + +The module used to create and manage virtual environments is called +:mod:`venv`. :mod:`venv` will usually install the most recent version of +Python that you have available. If you have multiple versions of Python on your +system, you can select a specific Python version by running ``python3`` or +whichever version you want. + +To create a virtual environment, decide upon a directory where you want to +place it, and run the :mod:`venv` module as a script with the directory path:: + + python3 -m venv tutorial-env + +This will create the ``tutorial-env`` directory if it doesn't exist, +and also create directories inside it containing a copy of the Python +interpreter, the standard library, and various supporting files. + +Once you've created a virtual environment, you may activate it. + +On Windows, run:: + + tutorial-env\Scripts\activate.bat + +On Unix or MacOS, run:: + + source tutorial-env/bin/activate + +(This script is written for the bash shell. If you use the +:program:`csh` or :program:`fish` shells, there are alternate +``activate.csh`` and ``activate.fish`` scripts you should use +instead.) + +Activating the virtual environment will change your shell's prompt to show what +virtual environment you're using, and modify the environment so that running +``python`` will get you that particular version and installation of Python. +For example: + +.. code-block:: bash + + $ source ~/envs/tutorial-env/bin/activate + (tutorial-env) $ python + Python 3.5.1 (default, May 6 2016, 10:59:36) + ... + >>> import sys + >>> sys.path + ['', '/usr/local/lib/python35.zip', ..., + '~/envs/tutorial-env/lib/python3.5/site-packages'] + >>> + + +Managing Packages with pip +========================== + +You can install, upgrade, and remove packages using a program called +:program:`pip`. By default ``pip`` will install packages from the Python +Package Index, . You can browse the Python +Package Index by going to it in your web browser, or you can use ``pip``'s +limited search feature: + +.. code-block:: bash + + (tutorial-env) $ pip search astronomy + skyfield - Elegant astronomy for Python + gary - Galactic astronomy and gravitational dynamics. + novas - The United States Naval Observatory NOVAS astronomy library + astroobs - Provides astronomy ephemeris to plan telescope observations + PyAstronomy - A collection of astronomy related tools for Python. + ... + +``pip`` has a number of subcommands: "search", "install", "uninstall", +"freeze", etc. (Consult the :ref:`installing-index` guide for +complete documentation for ``pip``.) + +You can install the latest version of a package by specifying a package's name: + +.. code-block:: bash + + (tutorial-env) $ pip install novas + Collecting novas + Downloading novas-3.1.1.3.tar.gz (136kB) + Installing collected packages: novas + Running setup.py install for novas + Successfully installed novas-3.1.1.3 + +You can also install a specific version of a package by giving the +package name followed by ``==`` and the version number: + +.. code-block:: bash + + (tutorial-env) $ pip install requests==2.6.0 + Collecting requests==2.6.0 + Using cached requests-2.6.0-py2.py3-none-any.whl + Installing collected packages: requests + Successfully installed requests-2.6.0 + +If you re-run this command, ``pip`` will notice that the requested +version is already installed and do nothing. You can supply a +different version number to get that version, or you can run ``pip +install --upgrade`` to upgrade the package to the latest version: + +.. code-block:: bash + + (tutorial-env) $ pip install --upgrade requests + Collecting requests + Installing collected packages: requests + Found existing installation: requests 2.6.0 + Uninstalling requests-2.6.0: + Successfully uninstalled requests-2.6.0 + Successfully installed requests-2.7.0 + +``pip uninstall`` followed by one or more package names will remove the +packages from the virtual environment. + +``pip show`` will display information about a particular package: + +.. code-block:: bash + + (tutorial-env) $ pip show requests + --- + Metadata-Version: 2.0 + Name: requests + Version: 2.7.0 + Summary: Python HTTP for Humans. + Home-page: http://python-requests.org + Author: Kenneth Reitz + Author-email: me@kennethreitz.com + License: Apache 2.0 + Location: /Users/akuchling/envs/tutorial-env/lib/python3.4/site-packages + Requires: + +``pip list`` will display all of the packages installed in the virtual +environment: + +.. code-block:: bash + + (tutorial-env) $ pip list + novas (3.1.1.3) + numpy (1.9.2) + pip (7.0.3) + requests (2.7.0) + setuptools (16.0) + +``pip freeze`` will produce a similar list of the installed packages, +but the output uses the format that ``pip install`` expects. +A common convention is to put this list in a ``requirements.txt`` file: + +.. code-block:: bash + + (tutorial-env) $ pip freeze > requirements.txt + (tutorial-env) $ cat requirements.txt + novas==3.1.1.3 + numpy==1.9.2 + requests==2.7.0 + +The ``requirements.txt`` can then be committed to version control and +shipped as part of an application. Users can then install all the +necessary packages with ``install -r``: + +.. code-block:: bash + + (tutorial-env) $ pip install -r requirements.txt + Collecting novas==3.1.1.3 (from -r requirements.txt (line 1)) + ... + Collecting numpy==1.9.2 (from -r requirements.txt (line 2)) + ... + Collecting requests==2.7.0 (from -r requirements.txt (line 3)) + ... + Installing collected packages: novas, numpy, requests + Running setup.py install for novas + Successfully installed novas-3.1.1.3 numpy-1.9.2 requests-2.7.0 + +``pip`` has many more options. Consult the :ref:`installing-index` +guide for complete documentation for ``pip``. When you've written +a package and want to make it available on the Python Package Index, +consult the :ref:`distributing-index` guide. diff --git a/python-3.7.4-docs-html/_sources/tutorial/whatnow.rst.txt b/python-3.7.4-docs-html/_sources/tutorial/whatnow.rst.txt new file mode 100644 index 0000000..3208201 --- /dev/null +++ b/python-3.7.4-docs-html/_sources/tutorial/whatnow.rst.txt @@ -0,0 +1,76 @@ +.. _tut-whatnow: + +********* +What Now? +********* + +Reading this tutorial has probably reinforced your interest in using Python --- +you should be eager to apply Python to solving your real-world problems. Where +should you go to learn more? + +This tutorial is part of Python's documentation set. Some other documents in +the set are: + +* :ref:`library-index`: + + You should browse through this manual, which gives complete (though terse) + reference material about types, functions, and the modules in the standard + library. The standard Python distribution includes a *lot* of additional code. + There are modules to read Unix mailboxes, retrieve documents via HTTP, generate + random numbers, parse command-line options, write CGI programs, compress data, + and many other tasks. Skimming through the Library Reference will give you an + idea of what's available. + +* :ref:`installing-index` explains how to install additional modules written + by other Python users. + +* :ref:`reference-index`: A detailed explanation of Python's syntax and + semantics. It's heavy reading, but is useful as a complete guide to the + language itself. + +More Python resources: + +* https://www.python.org: The major Python Web site. It contains code, + documentation, and pointers to Python-related pages around the Web. This Web + site is mirrored in various places around the world, such as Europe, Japan, and + Australia; a mirror may be faster than the main site, depending on your + geographical location. + +* https://docs.python.org: Fast access to Python's documentation. + +* https://pypi.org: The Python Package Index, previously also nicknamed + the Cheese Shop [#]_, is an index of user-created Python modules that are available + for download. Once you begin releasing code, you can register it here so that + others can find it. + +* https://code.activestate.com/recipes/langs/python/: The Python Cookbook is a + sizable collection of code examples, larger modules, and useful scripts. + Particularly notable contributions are collected in a book also titled Python + Cookbook (O'Reilly & Associates, ISBN 0-596-00797-3.) + +* http://www.pyvideo.org collects links to Python-related videos from + conferences and user-group meetings. + +* https://scipy.org: The Scientific Python project includes modules for fast + array computations and manipulations plus a host of packages for such + things as linear algebra, Fourier transforms, non-linear solvers, + random number distributions, statistical analysis and the like. + +For Python-related questions and problem reports, you can post to the newsgroup +:newsgroup:`comp.lang.python`, or send them to the mailing list at +python-list@python.org. The newsgroup and mailing list are gatewayed, so +messages posted to one will automatically be forwarded to the other. There are +hundreds of postings a day, asking (and +answering) questions, suggesting new features, and announcing new modules. +Mailing list archives are available at https://mail.python.org/pipermail/. + +Before posting, be sure to check the list of +:ref:`Frequently Asked Questions ` (also called the FAQ). The +FAQ answers many of the questions that come up again and again, and may +already contain the solution for your problem. + +.. rubric:: Footnotes + +.. [#] "Cheese Shop" is a Monty Python's sketch: a customer enters a cheese shop, + but whatever cheese he asks for, the clerk says it's missing. + diff --git a/python-3.7.4-docs-html/_sources/using/cmdline.rst.txt b/python-3.7.4-docs-html/_sources/using/cmdline.rst.txt new file mode 100644 index 0000000..dca89ec --- /dev/null +++ b/python-3.7.4-docs-html/_sources/using/cmdline.rst.txt @@ -0,0 +1,918 @@ +.. highlightlang:: sh + +.. ATTENTION: You probably should update Misc/python.man, too, if you modify + this file. + +.. _using-on-general: + +Command line and environment +============================ + +The CPython interpreter scans the command line and the environment for various +settings. + +.. impl-detail:: + + Other implementations' command line schemes may differ. See + :ref:`implementations` for further resources. + + +.. _using-on-cmdline: + +Command line +------------ + +When invoking Python, you may specify any of these options:: + + python [-bBdEhiIOqsSuvVWx?] [-c command | -m module-name | script | - ] [args] + +The most common use case is, of course, a simple invocation of a script:: + + python myscript.py + + +.. _using-on-interface-options: + +Interface options +~~~~~~~~~~~~~~~~~ + +The interpreter interface resembles that of the UNIX shell, but provides some +additional methods of invocation: + +* When called with standard input connected to a tty device, it prompts for + commands and executes them until an EOF (an end-of-file character, you can + produce that with :kbd:`Ctrl-D` on UNIX or :kbd:`Ctrl-Z, Enter` on Windows) is read. +* When called with a file name argument or with a file as standard input, it + reads and executes a script from that file. +* When called with a directory name argument, it reads and executes an + appropriately named script from that directory. +* When called with ``-c command``, it executes the Python statement(s) given as + *command*. Here *command* may contain multiple statements separated by + newlines. Leading whitespace is significant in Python statements! +* When called with ``-m module-name``, the given module is located on the + Python module path and executed as a script. + +In non-interactive mode, the entire input is parsed before it is executed. + +An interface option terminates the list of options consumed by the interpreter, +all consecutive arguments will end up in :data:`sys.argv` -- note that the first +element, subscript zero (``sys.argv[0]``), is a string reflecting the program's +source. + +.. cmdoption:: -c + + Execute the Python code in *command*. *command* can be one or more + statements separated by newlines, with significant leading whitespace as in + normal module code. + + If this option is given, the first element of :data:`sys.argv` will be + ``"-c"`` and the current directory will be added to the start of + :data:`sys.path` (allowing modules in that directory to be imported as top + level modules). + + +.. cmdoption:: -m + + Search :data:`sys.path` for the named module and execute its contents as + the :mod:`__main__` module. + + Since the argument is a *module* name, you must not give a file extension + (``.py``). The module name should be a valid absolute Python module name, but + the implementation may not always enforce this (e.g. it may allow you to + use a name that includes a hyphen). + + Package names (including namespace packages) are also permitted. When a + package name is supplied instead + of a normal module, the interpreter will execute ``.__main__`` as + the main module. This behaviour is deliberately similar to the handling + of directories and zipfiles that are passed to the interpreter as the + script argument. + + .. note:: + + This option cannot be used with built-in modules and extension modules + written in C, since they do not have Python module files. However, it + can still be used for precompiled modules, even if the original source + file is not available. + + If this option is given, the first element of :data:`sys.argv` will be the + full path to the module file (while the module file is being located, the + first element will be set to ``"-m"``). As with the :option:`-c` option, + the current directory will be added to the start of :data:`sys.path`. + + Many standard library modules contain code that is invoked on their execution + as a script. An example is the :mod:`timeit` module:: + + python -mtimeit -s 'setup here' 'benchmarked code here' + python -mtimeit -h # for details + + .. seealso:: + :func:`runpy.run_module` + Equivalent functionality directly available to Python code + + :pep:`338` -- Executing modules as scripts + + + .. versionchanged:: 3.1 + Supply the package name to run a ``__main__`` submodule. + + .. versionchanged:: 3.4 + namespace packages are also supported + + +.. describe:: - + + Read commands from standard input (:data:`sys.stdin`). If standard input is + a terminal, :option:`-i` is implied. + + If this option is given, the first element of :data:`sys.argv` will be + ``"-"`` and the current directory will be added to the start of + :data:`sys.path`. + + +.. describe:: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    About these documents

    +

    These documents are generated from reStructuredText sources by Sphinx, a +document processor specifically written for the Python documentation.

    +

    Development of the documentation and its toolchain is an entirely volunteer +effort, just like Python itself. If you want to contribute, please take a +look at the Dealing with Bugs page for information on how to do so. New +volunteers are always welcome!

    +

    Many thanks go to:

    +
      +
    • Fred L. Drake, Jr., the creator of the original Python documentation toolset +and writer of much of the content;

    • +
    • the Docutils project for creating +reStructuredText and the Docutils suite;

    • +
    • Fredrik Lundh for his Alternative Python Reference project from which Sphinx got many good +ideas.

    • +
    +
    +

    Contributors to the Python Documentation

    +

    Many people have contributed to the Python language, the Python standard +library, and the Python documentation. See Misc/ACKS in the Python +source distribution for a partial list of contributors.

    +

    It is only with the input and contributions of the Python community +that Python has such wonderful documentation – Thank You!

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/bugs.html b/python-3.7.4-docs-html/bugs.html new file mode 100644 index 0000000..7ac419e --- /dev/null +++ b/python-3.7.4-docs-html/bugs.html @@ -0,0 +1,257 @@ + + + + + + + Dealing with Bugs — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Dealing with Bugs

    +

    Python is a mature programming language which has established a reputation for +stability. In order to maintain this reputation, the developers would like to +know of any deficiencies you find in Python.

    +

    It can be sometimes faster to fix bugs yourself and contribute patches to +Python as it streamlines the process and involves less people. Learn how to +contribute.

    +
    +

    Documentation bugs

    +

    If you find a bug in this documentation or would like to propose an improvement, +please submit a bug report on the tracker. If you +have a suggestion on how to fix it, include that as well.

    +

    If you’re short on time, you can also email documentation bug reports to +docs@python.org (behavioral bugs can be sent to python-list@python.org). +‘docs@’ is a mailing list run by volunteers; your request will be noticed, +though it may take a while to be processed.

    +
    +

    See also

    +

    Documentation bugs on the Python issue tracker

    +
    +
    +
    +

    Using the Python issue tracker

    +

    Bug reports for Python itself should be submitted via the Python Bug Tracker +(https://bugs.python.org/). The bug tracker offers a Web form which allows +pertinent information to be entered and submitted to the developers.

    +

    The first step in filing a report is to determine whether the problem has +already been reported. The advantage in doing so, aside from saving the +developers time, is that you learn what has been done to fix it; it may be that +the problem has already been fixed for the next release, or additional +information is needed (in which case you are welcome to provide it if you can!). +To do this, search the bug database using the search box on the top of the page.

    +

    If the problem you’re reporting is not already in the bug tracker, go back to +the Python Bug Tracker and log in. If you don’t already have a tracker account, +select the “Register” link or, if you use OpenID, one of the OpenID provider +logos in the sidebar. It is not possible to submit a bug report anonymously.

    +

    Being now logged in, you can submit a bug. Select the “Create New” link in the +sidebar to open the bug reporting form.

    +

    The submission form has a number of fields. For the “Title” field, enter a +very short description of the problem; less than ten words is good. In the +“Type” field, select the type of your problem; also select the “Component” and +“Versions” to which the bug relates.

    +

    In the “Comment” field, describe the problem in detail, including what you +expected to happen and what did happen. Be sure to include whether any +extension modules were involved, and what hardware and software platform you +were using (including version information as appropriate).

    +

    Each bug report will be assigned to a developer who will determine what needs to +be done to correct the problem. You will receive an update each time action is +taken on the bug.

    +
    +

    See also

    +
    +
    How to Report Bugs Effectively

    Article which goes into some detail about how to create a useful bug report. +This describes what kind of information is useful and why it is useful.

    +
    +
    Bug Writing Guidelines

    Information about writing a good bug report. Some of this is specific to the +Mozilla project, but describes general good practices.

    +
    +
    +
    +
    +
    +

    Getting started contributing to Python yourself

    +

    Beyond just reporting bugs that you find, you are also welcome to submit +patches to fix them. You can find more information on how to get started +patching Python in the Python Developer’s Guide. If you have questions, +the core-mentorship mailing list is a friendly place to get answers to +any and all questions pertaining to the process of fixing issues in Python.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/abstract.html b/python-3.7.4-docs-html/c-api/abstract.html new file mode 100644 index 0000000..ab606db --- /dev/null +++ b/python-3.7.4-docs-html/c-api/abstract.html @@ -0,0 +1,216 @@ + + + + + + + Abstract Objects Layer — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Abstract Objects Layer

    +

    The functions in this chapter interact with Python objects regardless of their +type, or with wide classes of object types (e.g. all numerical types, or all +sequence types). When used on object types for which they do not apply, they +will raise a Python exception.

    +

    It is not possible to use these functions on objects that are not properly +initialized, such as a list object that has been created by PyList_New(), +but whose items have not been set to some non-NULL value yet.

    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/allocation.html b/python-3.7.4-docs-html/c-api/allocation.html new file mode 100644 index 0000000..0b7586c --- /dev/null +++ b/python-3.7.4-docs-html/c-api/allocation.html @@ -0,0 +1,258 @@ + + + + + + + Allocating Objects on the Heap — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Allocating Objects on the Heap

    +
    +
    +PyObject* _PyObject_New(PyTypeObject *type)
    +
    Return value: New reference.
    + +
    +
    +PyVarObject* _PyObject_NewVar(PyTypeObject *type, Py_ssize_t size)
    +
    Return value: New reference.
    + +
    +
    +PyObject* PyObject_Init(PyObject *op, PyTypeObject *type)
    +
    Return value: Borrowed reference.

    Initialize a newly-allocated object op with its type and initial +reference. Returns the initialized object. If type indicates that the +object participates in the cyclic garbage detector, it is added to the +detector’s set of observed objects. Other fields of the object are not +affected.

    +
    + +
    +
    +PyVarObject* PyObject_InitVar(PyVarObject *op, PyTypeObject *type, Py_ssize_t size)
    +
    Return value: Borrowed reference.

    This does everything PyObject_Init() does, and also initializes the +length information for a variable-size object.

    +
    + +
    +
    +TYPE* PyObject_New(TYPE, PyTypeObject *type)
    +
    Return value: New reference.

    Allocate a new Python object using the C structure type TYPE and the +Python type object type. Fields not defined by the Python object header +are not initialized; the object’s reference count will be one. The size of +the memory allocation is determined from the tp_basicsize field of +the type object.

    +
    + +
    +
    +TYPE* PyObject_NewVar(TYPE, PyTypeObject *type, Py_ssize_t size)
    +
    Return value: New reference.

    Allocate a new Python object using the C structure type TYPE and the +Python type object type. Fields not defined by the Python object header +are not initialized. The allocated memory allows for the TYPE structure +plus size fields of the size given by the tp_itemsize field of +type. This is useful for implementing objects like tuples, which are +able to determine their size at construction time. Embedding the array of +fields into the same allocation decreases the number of allocations, +improving the memory management efficiency.

    +
    + +
    +
    +void PyObject_Del(void *op)
    +

    Releases memory allocated to an object using PyObject_New() or +PyObject_NewVar(). This is normally called from the +tp_dealloc handler specified in the object’s type. The fields of +the object should not be accessed after this call as the memory is no +longer a valid Python object.

    +
    + +
    +
    +PyObject _Py_NoneStruct
    +

    Object which is visible in Python as None. This should only be accessed +using the Py_None macro, which evaluates to a pointer to this +object.

    +
    + +
    +

    See also

    +
    +
    PyModule_Create()

    To allocate and create extension modules.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/apiabiversion.html b/python-3.7.4-docs-html/c-api/apiabiversion.html new file mode 100644 index 0000000..b8dadae --- /dev/null +++ b/python-3.7.4-docs-html/c-api/apiabiversion.html @@ -0,0 +1,231 @@ + + + + + + + API and ABI Versioning — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    API and ABI Versioning

    +

    PY_VERSION_HEX is the Python version number encoded in a single integer.

    +

    For example if the PY_VERSION_HEX is set to 0x030401a2, the underlying +version information can be found by treating it as a 32 bit number in +the following manner:

    +
    +
    +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Bytes

    Bits (big endian order)

    Meaning

    1

    1-8

    PY_MAJOR_VERSION (the 3 in +3.4.1a2)

    2

    9-16

    PY_MINOR_VERSION (the 4 in +3.4.1a2)

    3

    17-24

    PY_MICRO_VERSION (the 1 in +3.4.1a2)

    4

    25-28

    PY_RELEASE_LEVEL (0xA for alpha, +0xB for beta, 0xC for release +candidate and 0xF for final), in this +case it is alpha.

    29-32

    PY_RELEASE_SERIAL (the 2 in +3.4.1a2, zero for final releases)

    +
    +

    Thus 3.4.1a2 is hexversion 0x030401a2.

    +

    All the given macros are defined in Include/patchlevel.h.

    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/arg.html b/python-3.7.4-docs-html/c-api/arg.html new file mode 100644 index 0000000..b3de1c6 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/arg.html @@ -0,0 +1,782 @@ + + + + + + + Parsing arguments and building values — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Parsing arguments and building values

    +

    These functions are useful when creating your own extensions functions and +methods. Additional information and examples are available in +Extending and Embedding the Python Interpreter.

    +

    The first three of these functions described, PyArg_ParseTuple(), +PyArg_ParseTupleAndKeywords(), and PyArg_Parse(), all use format +strings which are used to tell the function about the expected arguments. The +format strings use the same syntax for each of these functions.

    +
    +

    Parsing arguments

    +

    A format string consists of zero or more “format units.” A format unit +describes one Python object; it is usually a single character or a parenthesized +sequence of format units. With a few exceptions, a format unit that is not a +parenthesized sequence normally corresponds to a single address argument to +these functions. In the following description, the quoted form is the format +unit; the entry in (round) parentheses is the Python object type that matches +the format unit; and the entry in [square] brackets is the type of the C +variable(s) whose address should be passed.

    +
    +

    Strings and buffers

    +

    These formats allow accessing an object as a contiguous chunk of memory. +You don’t have to provide raw storage for the returned unicode or bytes +area.

    +

    In general, when a format sets a pointer to a buffer, the buffer is +managed by the corresponding Python object, and the buffer shares +the lifetime of this object. You won’t have to release any memory yourself. +The only exceptions are es, es#, et and et#.

    +

    However, when a Py_buffer structure gets filled, the underlying +buffer is locked so that the caller can subsequently use the buffer even +inside a Py_BEGIN_ALLOW_THREADS block without the risk of mutable data +being resized or destroyed. As a result, you have to call +PyBuffer_Release() after you have finished processing the data (or +in any early abort case).

    +

    Unless otherwise stated, buffers are not NUL-terminated.

    +

    Some formats require a read-only bytes-like object, and set a +pointer instead of a buffer structure. They work by checking that +the object’s PyBufferProcs.bf_releasebuffer field is NULL, +which disallows mutable objects such as bytearray.

    +
    +

    Note

    +

    For all # variants of formats (s#, y#, etc.), the type of +the length argument (int or Py_ssize_t) is controlled by +defining the macro PY_SSIZE_T_CLEAN before including +Python.h. If the macro was defined, length is a +Py_ssize_t rather than an int. This behavior will change +in a future Python version to only support Py_ssize_t and +drop int support. It is best to always define PY_SSIZE_T_CLEAN.

    +
    +
    +
    s (str) [const char *]

    Convert a Unicode object to a C pointer to a character string. +A pointer to an existing string is stored in the character pointer +variable whose address you pass. The C string is NUL-terminated. +The Python string must not contain embedded null code points; if it does, +a ValueError exception is raised. Unicode objects are converted +to C strings using 'utf-8' encoding. If this conversion fails, a +UnicodeError is raised.

    +
    +

    Note

    +

    This format does not accept bytes-like objects. If you want to accept +filesystem paths and convert them to C character strings, it is +preferable to use the O& format with PyUnicode_FSConverter() +as converter.

    +
    +
    +

    Changed in version 3.5: Previously, TypeError was raised when embedded null code points +were encountered in the Python string.

    +
    +
    +
    s* (str or bytes-like object) [Py_buffer]

    This format accepts Unicode objects as well as bytes-like objects. +It fills a Py_buffer structure provided by the caller. +In this case the resulting C string may contain embedded NUL bytes. +Unicode objects are converted to C strings using 'utf-8' encoding.

    +
    +
    s# (str, read-only bytes-like object) [const char *, int or Py_ssize_t]

    Like s*, except that it doesn’t accept mutable objects. +The result is stored into two C variables, +the first one a pointer to a C string, the second one its length. +The string may contain embedded null bytes. Unicode objects are converted +to C strings using 'utf-8' encoding.

    +
    +
    z (str or None) [const char *]

    Like s, but the Python object may also be None, in which case the C +pointer is set to NULL.

    +
    +
    z* (str, bytes-like object or None) [Py_buffer]

    Like s*, but the Python object may also be None, in which case the +buf member of the Py_buffer structure is set to NULL.

    +
    +
    z# (str, read-only bytes-like object or None) [const char *, int]

    Like s#, but the Python object may also be None, in which case the C +pointer is set to NULL.

    +
    +
    y (read-only bytes-like object) [const char *]

    This format converts a bytes-like object to a C pointer to a character +string; it does not accept Unicode objects. The bytes buffer must not +contain embedded null bytes; if it does, a ValueError +exception is raised.

    +
    +

    Changed in version 3.5: Previously, TypeError was raised when embedded null bytes were +encountered in the bytes buffer.

    +
    +
    +
    y* (bytes-like object) [Py_buffer]

    This variant on s* doesn’t accept Unicode objects, only +bytes-like objects. This is the recommended way to accept +binary data.

    +
    +
    y# (read-only bytes-like object) [const char *, int]

    This variant on s# doesn’t accept Unicode objects, only bytes-like +objects.

    +
    +
    S (bytes) [PyBytesObject *]

    Requires that the Python object is a bytes object, without +attempting any conversion. Raises TypeError if the object is not +a bytes object. The C variable may also be declared as PyObject*.

    +
    +
    Y (bytearray) [PyByteArrayObject *]

    Requires that the Python object is a bytearray object, without +attempting any conversion. Raises TypeError if the object is not +a bytearray object. The C variable may also be declared as PyObject*.

    +
    +
    u (str) [const Py_UNICODE *]

    Convert a Python Unicode object to a C pointer to a NUL-terminated buffer of +Unicode characters. You must pass the address of a Py_UNICODE +pointer variable, which will be filled with the pointer to an existing +Unicode buffer. Please note that the width of a Py_UNICODE +character depends on compilation options (it is either 16 or 32 bits). +The Python string must not contain embedded null code points; if it does, +a ValueError exception is raised.

    +
    +

    Changed in version 3.5: Previously, TypeError was raised when embedded null code points +were encountered in the Python string.

    +
    +
    +

    Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Py_UNICODE API; please migrate to using +PyUnicode_AsWideCharString().

    +
    +
    +
    u# (str) [const Py_UNICODE *, int]

    This variant on u stores into two C variables, the first one a pointer to a +Unicode data buffer, the second one its length. This variant allows +null code points.

    +
    +

    Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Py_UNICODE API; please migrate to using +PyUnicode_AsWideCharString().

    +
    +
    +
    Z (str or None) [const Py_UNICODE *]

    Like u, but the Python object may also be None, in which case the +Py_UNICODE pointer is set to NULL.

    +
    +

    Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Py_UNICODE API; please migrate to using +PyUnicode_AsWideCharString().

    +
    +
    +
    Z# (str or None) [const Py_UNICODE *, int]

    Like u#, but the Python object may also be None, in which case the +Py_UNICODE pointer is set to NULL.

    +
    +

    Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Py_UNICODE API; please migrate to using +PyUnicode_AsWideCharString().

    +
    +
    +
    U (str) [PyObject *]

    Requires that the Python object is a Unicode object, without attempting +any conversion. Raises TypeError if the object is not a Unicode +object. The C variable may also be declared as PyObject*.

    +
    +
    w* (read-write bytes-like object) [Py_buffer]

    This format accepts any object which implements the read-write buffer +interface. It fills a Py_buffer structure provided by the caller. +The buffer may contain embedded null bytes. The caller have to call +PyBuffer_Release() when it is done with the buffer.

    +
    +
    es (str) [const char *encoding, char **buffer]

    This variant on s is used for encoding Unicode into a character buffer. +It only works for encoded data without embedded NUL bytes.

    +

    This format requires two arguments. The first is only used as input, and +must be a const char* which points to the name of an encoding as a +NUL-terminated string, or NULL, in which case 'utf-8' encoding is used. +An exception is raised if the named encoding is not known to Python. The +second argument must be a char**; the value of the pointer it +references will be set to a buffer with the contents of the argument text. +The text will be encoded in the encoding specified by the first argument.

    +

    PyArg_ParseTuple() will allocate a buffer of the needed size, copy the +encoded data into this buffer and adjust *buffer to reference the newly +allocated storage. The caller is responsible for calling PyMem_Free() to +free the allocated buffer after use.

    +
    +
    et (str, bytes or bytearray) [const char *encoding, char **buffer]

    Same as es except that byte string objects are passed through without +recoding them. Instead, the implementation assumes that the byte string object uses +the encoding passed in as parameter.

    +
    +
    es# (str) [const char *encoding, char **buffer, int *buffer_length]

    This variant on s# is used for encoding Unicode into a character buffer. +Unlike the es format, this variant allows input data which contains NUL +characters.

    +

    It requires three arguments. The first is only used as input, and must be a +const char* which points to the name of an encoding as a +NUL-terminated string, or NULL, in which case 'utf-8' encoding is used. +An exception is raised if the named encoding is not known to Python. The +second argument must be a char**; the value of the pointer it +references will be set to a buffer with the contents of the argument text. +The text will be encoded in the encoding specified by the first argument. +The third argument must be a pointer to an integer; the referenced integer +will be set to the number of bytes in the output buffer.

    +

    There are two modes of operation:

    +

    If *buffer points a NULL pointer, the function will allocate a buffer of +the needed size, copy the encoded data into this buffer and set *buffer to +reference the newly allocated storage. The caller is responsible for calling +PyMem_Free() to free the allocated buffer after usage.

    +

    If *buffer points to a non-NULL pointer (an already allocated buffer), +PyArg_ParseTuple() will use this location as the buffer and interpret the +initial value of *buffer_length as the buffer size. It will then copy the +encoded data into the buffer and NUL-terminate it. If the buffer is not large +enough, a ValueError will be set.

    +

    In both cases, *buffer_length is set to the length of the encoded data +without the trailing NUL byte.

    +
    +
    et# (str, bytes or bytearray) [const char *encoding, char **buffer, int *buffer_length]

    Same as es# except that byte string objects are passed through without recoding +them. Instead, the implementation assumes that the byte string object uses the +encoding passed in as parameter.

    +
    +
    +
    +
    +

    Numbers

    +
    +
    b (int) [unsigned char]

    Convert a nonnegative Python integer to an unsigned tiny int, stored in a C +unsigned char.

    +
    +
    B (int) [unsigned char]

    Convert a Python integer to a tiny int without overflow checking, stored in a C +unsigned char.

    +
    +
    h (int) [short int]

    Convert a Python integer to a C short int.

    +
    +
    H (int) [unsigned short int]

    Convert a Python integer to a C unsigned short int, without overflow +checking.

    +
    +
    i (int) [int]

    Convert a Python integer to a plain C int.

    +
    +
    I (int) [unsigned int]

    Convert a Python integer to a C unsigned int, without overflow +checking.

    +
    +
    l (int) [long int]

    Convert a Python integer to a C long int.

    +
    +
    k (int) [unsigned long]

    Convert a Python integer to a C unsigned long without +overflow checking.

    +
    +
    L (int) [long long]

    Convert a Python integer to a C long long.

    +
    +
    K (int) [unsigned long long]

    Convert a Python integer to a C unsigned long long +without overflow checking.

    +
    +
    n (int) [Py_ssize_t]

    Convert a Python integer to a C Py_ssize_t.

    +
    +
    c (bytes or bytearray of length 1) [char]

    Convert a Python byte, represented as a bytes or +bytearray object of length 1, to a C char.

    +
    +

    Changed in version 3.3: Allow bytearray objects.

    +
    +
    +
    C (str of length 1) [int]

    Convert a Python character, represented as a str object of +length 1, to a C int.

    +
    +
    f (float) [float]

    Convert a Python floating point number to a C float.

    +
    +
    d (float) [double]

    Convert a Python floating point number to a C double.

    +
    +
    D (complex) [Py_complex]

    Convert a Python complex number to a C Py_complex structure.

    +
    +
    +
    +
    +

    Other objects

    +
    +
    O (object) [PyObject *]

    Store a Python object (without any conversion) in a C object pointer. The C +program thus receives the actual object that was passed. The object’s reference +count is not increased. The pointer stored is not NULL.

    +
    +
    O! (object) [typeobject, PyObject *]

    Store a Python object in a C object pointer. This is similar to O, but +takes two C arguments: the first is the address of a Python type object, the +second is the address of the C variable (of type PyObject*) into which +the object pointer is stored. If the Python object does not have the required +type, TypeError is raised.

    +
    +
    +
    +
    O& (object) [converter, anything]

    Convert a Python object to a C variable through a converter function. This +takes two arguments: the first is a function, the second is the address of a C +variable (of arbitrary type), converted to void *. The converter +function in turn is called as follows:

    +
    status = converter(object, address);
    +
    +
    +

    where object is the Python object to be converted and address is the +void* argument that was passed to the PyArg_Parse*() function. +The returned status should be 1 for a successful conversion and 0 if +the conversion has failed. When the conversion fails, the converter function +should raise an exception and leave the content of address unmodified.

    +

    If the converter returns Py_CLEANUP_SUPPORTED, it may get called a +second time if the argument parsing eventually fails, giving the converter a +chance to release any memory that it had already allocated. In this second +call, the object parameter will be NULL; address will have the same value +as in the original call.

    +
    +

    Changed in version 3.1: Py_CLEANUP_SUPPORTED was added.

    +
    +
    +
    p (bool) [int]

    Tests the value passed in for truth (a boolean predicate) and converts +the result to its equivalent C true/false integer value. +Sets the int to 1 if the expression was true and 0 if it was false. +This accepts any valid Python value. See Truth Value Testing for more +information about how Python tests values for truth.

    +
    +

    New in version 3.3.

    +
    +
    +
    (items) (tuple) [matching-items]

    The object must be a Python sequence whose length is the number of format units +in items. The C arguments must correspond to the individual format units in +items. Format units for sequences may be nested.

    +
    +
    +

    It is possible to pass “long” integers (integers whose value exceeds the +platform’s LONG_MAX) however no proper range checking is done — the +most significant bits are silently truncated when the receiving field is too +small to receive the value (actually, the semantics are inherited from downcasts +in C — your mileage may vary).

    +

    A few other characters have a meaning in a format string. These may not occur +inside nested parentheses. They are:

    +
    +
    |

    Indicates that the remaining arguments in the Python argument list are optional. +The C variables corresponding to optional arguments should be initialized to +their default value — when an optional argument is not specified, +PyArg_ParseTuple() does not touch the contents of the corresponding C +variable(s).

    +
    +
    $

    PyArg_ParseTupleAndKeywords() only: +Indicates that the remaining arguments in the Python argument list are +keyword-only. Currently, all keyword-only arguments must also be optional +arguments, so | must always be specified before $ in the format +string.

    +
    +

    New in version 3.3.

    +
    +
    +
    :

    The list of format units ends here; the string after the colon is used as the +function name in error messages (the “associated value” of the exception that +PyArg_ParseTuple() raises).

    +
    +
    ;

    The list of format units ends here; the string after the semicolon is used as +the error message instead of the default error message. : and ; +mutually exclude each other.

    +
    +
    +

    Note that any Python object references which are provided to the caller are +borrowed references; do not decrement their reference count!

    +

    Additional arguments passed to these functions must be addresses of variables +whose type is determined by the format string; these are used to store values +from the input tuple. There are a few cases, as described in the list of format +units above, where these parameters are used as input values; they should match +what is specified for the corresponding format unit in that case.

    +

    For the conversion to succeed, the arg object must match the format +and the format must be exhausted. On success, the +PyArg_Parse*() functions return true, otherwise they return +false and raise an appropriate exception. When the +PyArg_Parse*() functions fail due to conversion failure in one +of the format units, the variables at the addresses corresponding to that +and the following format units are left untouched.

    +
    +
    +

    API Functions

    +
    +
    +int PyArg_ParseTuple(PyObject *args, const char *format, ...)
    +

    Parse the parameters of a function that takes only positional parameters into +local variables. Returns true on success; on failure, it returns false and +raises the appropriate exception.

    +
    + +
    +
    +int PyArg_VaParse(PyObject *args, const char *format, va_list vargs)
    +

    Identical to PyArg_ParseTuple(), except that it accepts a va_list rather +than a variable number of arguments.

    +
    + +
    +
    +int PyArg_ParseTupleAndKeywords(PyObject *args, PyObject *kw, const char *format, char *keywords[], ...)
    +

    Parse the parameters of a function that takes both positional and keyword +parameters into local variables. The keywords argument is a +NULL-terminated array of keyword parameter names. Empty names denote +positional-only parameters. +Returns true on success; on failure, it returns false and raises the +appropriate exception.

    +
    +

    Changed in version 3.6: Added support for positional-only parameters.

    +
    +
    + +
    +
    +int PyArg_VaParseTupleAndKeywords(PyObject *args, PyObject *kw, const char *format, char *keywords[], va_list vargs)
    +

    Identical to PyArg_ParseTupleAndKeywords(), except that it accepts a +va_list rather than a variable number of arguments.

    +
    + +
    +
    +int PyArg_ValidateKeywordArguments(PyObject *)
    +

    Ensure that the keys in the keywords argument dictionary are strings. This +is only needed if PyArg_ParseTupleAndKeywords() is not used, since the +latter already does this check.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +int PyArg_Parse(PyObject *args, const char *format, ...)
    +

    Function used to deconstruct the argument lists of “old-style” functions — +these are functions which use the METH_OLDARGS parameter parsing +method, which has been removed in Python 3. This is not recommended for use +in parameter parsing in new code, and most code in the standard interpreter +has been modified to no longer use this for that purpose. It does remain a +convenient way to decompose other tuples, however, and may continue to be +used for that purpose.

    +
    + +
    +
    +int PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
    +

    A simpler form of parameter retrieval which does not use a format string to +specify the types of the arguments. Functions which use this method to retrieve +their parameters should be declared as METH_VARARGS in function or +method tables. The tuple containing the actual parameters should be passed as +args; it must actually be a tuple. The length of the tuple must be at least +min and no more than max; min and max may be equal. Additional +arguments must be passed to the function, each of which should be a pointer to a +PyObject* variable; these will be filled in with the values from +args; they will contain borrowed references. The variables which correspond +to optional parameters not given by args will not be filled in; these should +be initialized by the caller. This function returns true on success and false if +args is not a tuple or contains the wrong number of elements; an exception +will be set if there was a failure.

    +

    This is an example of the use of this function, taken from the sources for the +_weakref helper module for weak references:

    +
    static PyObject *
    +weakref_ref(PyObject *self, PyObject *args)
    +{
    +    PyObject *object;
    +    PyObject *callback = NULL;
    +    PyObject *result = NULL;
    +
    +    if (PyArg_UnpackTuple(args, "ref", 1, 2, &object, &callback)) {
    +        result = PyWeakref_NewRef(object, callback);
    +    }
    +    return result;
    +}
    +
    +
    +

    The call to PyArg_UnpackTuple() in this example is entirely equivalent to +this call to PyArg_ParseTuple():

    +
    PyArg_ParseTuple(args, "O|O:ref", &object, &callback)
    +
    +
    +
    + +
    +
    +
    +

    Building values

    +
    +
    +PyObject* Py_BuildValue(const char *format, ...)
    +
    Return value: New reference.

    Create a new value based on a format string similar to those accepted by the +PyArg_Parse*() family of functions and a sequence of values. Returns +the value or NULL in the case of an error; an exception will be raised if +NULL is returned.

    +

    Py_BuildValue() does not always build a tuple. It builds a tuple only if +its format string contains two or more format units. If the format string is +empty, it returns None; if it contains exactly one format unit, it returns +whatever object is described by that format unit. To force it to return a tuple +of size 0 or one, parenthesize the format string.

    +

    When memory buffers are passed as parameters to supply data to build objects, as +for the s and s# formats, the required data is copied. Buffers provided +by the caller are never referenced by the objects created by +Py_BuildValue(). In other words, if your code invokes malloc() +and passes the allocated memory to Py_BuildValue(), your code is +responsible for calling free() for that memory once +Py_BuildValue() returns.

    +

    In the following description, the quoted form is the format unit; the entry in +(round) parentheses is the Python object type that the format unit will return; +and the entry in [square] brackets is the type of the C value(s) to be passed.

    +

    The characters space, tab, colon and comma are ignored in format strings (but +not within format units such as s#). This can be used to make long format +strings a tad more readable.

    +
    +
    s (str or None) [const char *]

    Convert a null-terminated C string to a Python str object using 'utf-8' +encoding. If the C string pointer is NULL, None is used.

    +
    +
    s# (str or None) [const char *, int]

    Convert a C string and its length to a Python str object using 'utf-8' +encoding. If the C string pointer is NULL, the length is ignored and +None is returned.

    +
    +
    y (bytes) [const char *]

    This converts a C string to a Python bytes object. If the C +string pointer is NULL, None is returned.

    +
    +
    y# (bytes) [const char *, int]

    This converts a C string and its lengths to a Python object. If the C +string pointer is NULL, None is returned.

    +
    +
    z (str or None) [const char *]

    Same as s.

    +
    +
    z# (str or None) [const char *, int]

    Same as s#.

    +
    +
    u (str) [const wchar_t *]

    Convert a null-terminated wchar_t buffer of Unicode (UTF-16 or UCS-4) +data to a Python Unicode object. If the Unicode buffer pointer is NULL, +None is returned.

    +
    +
    u# (str) [const wchar_t *, int]

    Convert a Unicode (UTF-16 or UCS-4) data buffer and its length to a Python +Unicode object. If the Unicode buffer pointer is NULL, the length is ignored +and None is returned.

    +
    +
    U (str or None) [const char *]

    Same as s.

    +
    +
    U# (str or None) [const char *, int]

    Same as s#.

    +
    +
    i (int) [int]

    Convert a plain C int to a Python integer object.

    +
    +
    b (int) [char]

    Convert a plain C char to a Python integer object.

    +
    +
    h (int) [short int]

    Convert a plain C short int to a Python integer object.

    +
    +
    l (int) [long int]

    Convert a C long int to a Python integer object.

    +
    +
    B (int) [unsigned char]

    Convert a C unsigned char to a Python integer object.

    +
    +
    H (int) [unsigned short int]

    Convert a C unsigned short int to a Python integer object.

    +
    +
    I (int) [unsigned int]

    Convert a C unsigned int to a Python integer object.

    +
    +
    k (int) [unsigned long]

    Convert a C unsigned long to a Python integer object.

    +
    +
    L (int) [long long]

    Convert a C long long to a Python integer object.

    +
    +
    K (int) [unsigned long long]

    Convert a C unsigned long long to a Python integer object.

    +
    +
    n (int) [Py_ssize_t]

    Convert a C Py_ssize_t to a Python integer.

    +
    +
    c (bytes of length 1) [char]

    Convert a C int representing a byte to a Python bytes object of +length 1.

    +
    +
    C (str of length 1) [int]

    Convert a C int representing a character to Python str +object of length 1.

    +
    +
    d (float) [double]

    Convert a C double to a Python floating point number.

    +
    +
    f (float) [float]

    Convert a C float to a Python floating point number.

    +
    +
    D (complex) [Py_complex *]

    Convert a C Py_complex structure to a Python complex number.

    +
    +
    O (object) [PyObject *]

    Pass a Python object untouched (except for its reference count, which is +incremented by one). If the object passed in is a NULL pointer, it is assumed +that this was caused because the call producing the argument found an error and +set an exception. Therefore, Py_BuildValue() will return NULL but won’t +raise an exception. If no exception has been raised yet, SystemError is +set.

    +
    +
    S (object) [PyObject *]

    Same as O.

    +
    +
    N (object) [PyObject *]

    Same as O, except it doesn’t increment the reference count on the object. +Useful when the object is created by a call to an object constructor in the +argument list.

    +
    +
    O& (object) [converter, anything]

    Convert anything to a Python object through a converter function. The +function is called with anything (which should be compatible with void +*) as its argument and should return a “new” Python object, or NULL if an +error occurred.

    +
    +
    (items) (tuple) [matching-items]

    Convert a sequence of C values to a Python tuple with the same number of items.

    +
    +
    [items] (list) [matching-items]

    Convert a sequence of C values to a Python list with the same number of items.

    +
    +
    {items} (dict) [matching-items]

    Convert a sequence of C values to a Python dictionary. Each pair of consecutive +C values adds one item to the dictionary, serving as key and value, +respectively.

    +
    +
    +

    If there is an error in the format string, the SystemError exception is +set and NULL returned.

    +
    + +
    +
    +PyObject* Py_VaBuildValue(const char *format, va_list vargs)
    +
    Return value: New reference.

    Identical to Py_BuildValue(), except that it accepts a va_list +rather than a variable number of arguments.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/bool.html b/python-3.7.4-docs-html/c-api/bool.html new file mode 100644 index 0000000..05acfdd --- /dev/null +++ b/python-3.7.4-docs-html/c-api/bool.html @@ -0,0 +1,228 @@ + + + + + + + Boolean Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Boolean Objects

    +

    Booleans in Python are implemented as a subclass of integers. There are only +two booleans, Py_False and Py_True. As such, the normal +creation and deletion functions don’t apply to booleans. The following macros +are available, however.

    +
    +
    +int PyBool_Check(PyObject *o)
    +

    Return true if o is of type PyBool_Type.

    +
    + +
    +
    +PyObject* Py_False
    +

    The Python False object. This object has no methods. It needs to be +treated just like any other object with respect to reference counts.

    +
    + +
    +
    +PyObject* Py_True
    +

    The Python True object. This object has no methods. It needs to be treated +just like any other object with respect to reference counts.

    +
    + +
    +
    +Py_RETURN_FALSE
    +

    Return Py_False from a function, properly incrementing its reference +count.

    +
    + +
    +
    +Py_RETURN_TRUE
    +

    Return Py_True from a function, properly incrementing its reference +count.

    +
    + +
    +
    +PyObject* PyBool_FromLong(long v)
    +
    Return value: New reference.

    Return a new reference to Py_True or Py_False depending on the +truth value of v.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/buffer.html b/python-3.7.4-docs-html/c-api/buffer.html new file mode 100644 index 0000000..ac01b25 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/buffer.html @@ -0,0 +1,870 @@ + + + + + + + Buffer Protocol — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Buffer Protocol

    +

    Certain objects available in Python wrap access to an underlying memory +array or buffer. Such objects include the built-in bytes and +bytearray, and some extension types like array.array. +Third-party libraries may define their own types for special purposes, such +as image processing or numeric analysis.

    +

    While each of these types have their own semantics, they share the common +characteristic of being backed by a possibly large memory buffer. It is +then desirable, in some situations, to access that buffer directly and +without intermediate copying.

    +

    Python provides such a facility at the C level in the form of the buffer +protocol. This protocol has two sides:

    +
      +
    • on the producer side, a type can export a “buffer interface” which allows +objects of that type to expose information about their underlying buffer. +This interface is described in the section Buffer Object Structures;

    • +
    • on the consumer side, several means are available to obtain a pointer to +the raw underlying data of an object (for example a method parameter).

    • +
    +

    Simple objects such as bytes and bytearray expose their +underlying buffer in byte-oriented form. Other forms are possible; for example, +the elements exposed by an array.array can be multi-byte values.

    +

    An example consumer of the buffer interface is the write() +method of file objects: any object that can export a series of bytes through +the buffer interface can be written to a file. While write() only +needs read-only access to the internal contents of the object passed to it, +other methods such as readinto() need write access +to the contents of their argument. The buffer interface allows objects to +selectively allow or reject exporting of read-write and read-only buffers.

    +

    There are two ways for a consumer of the buffer interface to acquire a buffer +over a target object:

    + +

    In both cases, PyBuffer_Release() must be called when the buffer +isn’t needed anymore. Failure to do so could lead to various issues such as +resource leaks.

    +
    +

    Buffer structure

    +

    Buffer structures (or simply “buffers”) are useful as a way to expose the +binary data from another object to the Python programmer. They can also be +used as a zero-copy slicing mechanism. Using their ability to reference a +block of memory, it is possible to expose any data to the Python programmer +quite easily. The memory could be a large, constant array in a C extension, +it could be a raw block of memory for manipulation before passing to an +operating system library, or it could be used to pass around structured data +in its native, in-memory format.

    +

    Contrary to most data types exposed by the Python interpreter, buffers +are not PyObject pointers but rather simple C structures. This +allows them to be created and copied very simply. When a generic wrapper +around a buffer is needed, a memoryview object +can be created.

    +

    For short instructions how to write an exporting object, see +Buffer Object Structures. For obtaining +a buffer, see PyObject_GetBuffer().

    +
    +
    +Py_buffer
    +
    +
    +void *buf
    +

    A pointer to the start of the logical structure described by the buffer +fields. This can be any location within the underlying physical memory +block of the exporter. For example, with negative strides +the value may point to the end of the memory block.

    +

    For contiguous arrays, the value points to the beginning of +the memory block.

    +
    + +
    +
    +void *obj
    +

    A new reference to the exporting object. The reference is owned by +the consumer and automatically decremented and set to NULL by +PyBuffer_Release(). The field is the equivalent of the return +value of any standard C-API function.

    +

    As a special case, for temporary buffers that are wrapped by +PyMemoryView_FromBuffer() or PyBuffer_FillInfo() +this field is NULL. In general, exporting objects MUST NOT +use this scheme.

    +
    + +
    +
    +Py_ssize_t len
    +

    product(shape) * itemsize. For contiguous arrays, this is the length +of the underlying memory block. For non-contiguous arrays, it is the length +that the logical structure would have if it were copied to a contiguous +representation.

    +

    Accessing ((char *)buf)[0] up to ((char *)buf)[len-1] is only valid +if the buffer has been obtained by a request that guarantees contiguity. In +most cases such a request will be PyBUF_SIMPLE or PyBUF_WRITABLE.

    +
    + +
    +
    +int readonly
    +

    An indicator of whether the buffer is read-only. This field is controlled +by the PyBUF_WRITABLE flag.

    +
    + +
    +
    +Py_ssize_t itemsize
    +

    Item size in bytes of a single element. Same as the value of struct.calcsize() +called on non-NULL format values.

    +

    Important exception: If a consumer requests a buffer without the +PyBUF_FORMAT flag, format will +be set to NULL, but itemsize still has +the value for the original format.

    +

    If shape is present, the equality +product(shape) * itemsize == len still holds and the consumer +can use itemsize to navigate the buffer.

    +

    If shape is NULL as a result of a PyBUF_SIMPLE +or a PyBUF_WRITABLE request, the consumer must disregard +itemsize and assume itemsize == 1.

    +
    + +
    +
    +const char *format
    +

    A NUL terminated string in struct module style syntax describing +the contents of a single item. If this is NULL, "B" (unsigned bytes) +is assumed.

    +

    This field is controlled by the PyBUF_FORMAT flag.

    +
    + +
    +
    +int ndim
    +

    The number of dimensions the memory represents as an n-dimensional array. +If it is 0, buf points to a single item representing +a scalar. In this case, shape, strides +and suboffsets MUST be NULL.

    +

    The macro PyBUF_MAX_NDIM limits the maximum number of dimensions +to 64. Exporters MUST respect this limit, consumers of multi-dimensional +buffers SHOULD be able to handle up to PyBUF_MAX_NDIM dimensions.

    +
    + +
    +
    +Py_ssize_t *shape
    +

    An array of Py_ssize_t of length ndim +indicating the shape of the memory as an n-dimensional array. Note that +shape[0] * ... * shape[ndim-1] * itemsize MUST be equal to +len.

    +

    Shape values are restricted to shape[n] >= 0. The case +shape[n] == 0 requires special attention. See complex arrays +for further information.

    +

    The shape array is read-only for the consumer.

    +
    + +
    +
    +Py_ssize_t *strides
    +

    An array of Py_ssize_t of length ndim +giving the number of bytes to skip to get to a new element in each +dimension.

    +

    Stride values can be any integer. For regular arrays, strides are +usually positive, but a consumer MUST be able to handle the case +strides[n] <= 0. See complex arrays for further information.

    +

    The strides array is read-only for the consumer.

    +
    + +
    +
    +Py_ssize_t *suboffsets
    +

    An array of Py_ssize_t of length ndim. +If suboffsets[n] >= 0, the values stored along the nth dimension are +pointers and the suboffset value dictates how many bytes to add to each +pointer after de-referencing. A suboffset value that is negative +indicates that no de-referencing should occur (striding in a contiguous +memory block).

    +

    If all suboffsets are negative (i.e. no de-referencing is needed), then +this field must be NULL (the default value).

    +

    This type of array representation is used by the Python Imaging Library +(PIL). See complex arrays for further information how to access elements +of such an array.

    +

    The suboffsets array is read-only for the consumer.

    +
    + +
    +
    +void *internal
    +

    This is for use internally by the exporting object. For example, this +might be re-cast as an integer by the exporter and used to store flags +about whether or not the shape, strides, and suboffsets arrays must be +freed when the buffer is released. The consumer MUST NOT alter this +value.

    +
    + +
    + +
    +
    +

    Buffer request types

    +

    Buffers are usually obtained by sending a buffer request to an exporting +object via PyObject_GetBuffer(). Since the complexity of the logical +structure of the memory can vary drastically, the consumer uses the flags +argument to specify the exact buffer type it can handle.

    +

    All Py_buffer fields are unambiguously defined by the request +type.

    +
    +

    request-independent fields

    +

    The following fields are not influenced by flags and must always be filled in +with the correct values: obj, buf, +len, itemsize, ndim.

    +
    +
    +

    readonly, format

    +
    +
    +
    +PyBUF_WRITABLE
    +

    Controls the readonly field. If set, the exporter +MUST provide a writable buffer or else report failure. Otherwise, the +exporter MAY provide either a read-only or writable buffer, but the choice +MUST be consistent for all consumers.

    +
    + +
    +
    +PyBUF_FORMAT
    +

    Controls the format field. If set, this field MUST +be filled in correctly. Otherwise, this field MUST be NULL.

    +
    + +
    +

    PyBUF_WRITABLE can be |’d to any of the flags in the next section. +Since PyBUF_SIMPLE is defined as 0, PyBUF_WRITABLE +can be used as a stand-alone flag to request a simple writable buffer.

    +

    PyBUF_FORMAT can be |’d to any of the flags except PyBUF_SIMPLE. +The latter already implies format B (unsigned bytes).

    +
    +
    +

    shape, strides, suboffsets

    +

    The flags that control the logical structure of the memory are listed +in decreasing order of complexity. Note that each flag contains all bits +of the flags below it.

    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Request

    shape

    strides

    suboffsets

    +
    +PyBUF_INDIRECT
    +
    + +

    yes

    yes

    if needed

    +
    +PyBUF_STRIDES
    +
    + +

    yes

    yes

    NULL

    +
    +PyBUF_ND
    +
    + +

    yes

    NULL

    NULL

    +
    +PyBUF_SIMPLE
    +
    + +

    NULL

    NULL

    NULL

    +
    +
    +

    contiguity requests

    +

    C or Fortran contiguity can be explicitly requested, +with and without stride information. Without stride information, the buffer +must be C-contiguous.

    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Request

    shape

    strides

    suboffsets

    contig

    +
    +PyBUF_C_CONTIGUOUS
    +
    + +

    yes

    yes

    NULL

    C

    +
    +PyBUF_F_CONTIGUOUS
    +
    + +

    yes

    yes

    NULL

    F

    +
    +PyBUF_ANY_CONTIGUOUS
    +
    + +

    yes

    yes

    NULL

    C or F

    +
    +PyBUF_ND
    +
    + +

    yes

    NULL

    NULL

    C

    +
    +
    +

    compound requests

    +

    All possible requests are fully defined by some combination of the flags in +the previous section. For convenience, the buffer protocol provides frequently +used combinations as single flags.

    +

    In the following table U stands for undefined contiguity. The consumer would +have to call PyBuffer_IsContiguous() to determine contiguity.

    + +++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Request

    shape

    strides

    suboffsets

    contig

    readonly

    format

    +
    +PyBUF_FULL
    +
    + +

    yes

    yes

    if needed

    U

    0

    yes

    +
    +PyBUF_FULL_RO
    +
    + +

    yes

    yes

    if needed

    U

    1 or 0

    yes

    +
    +PyBUF_RECORDS
    +
    + +

    yes

    yes

    NULL

    U

    0

    yes

    +
    +PyBUF_RECORDS_RO
    +
    + +

    yes

    yes

    NULL

    U

    1 or 0

    yes

    +
    +PyBUF_STRIDED
    +
    + +

    yes

    yes

    NULL

    U

    0

    NULL

    +
    +PyBUF_STRIDED_RO
    +
    + +

    yes

    yes

    NULL

    U

    1 or 0

    NULL

    +
    +PyBUF_CONTIG
    +
    + +

    yes

    NULL

    NULL

    C

    0

    NULL

    +
    +PyBUF_CONTIG_RO
    +
    + +

    yes

    NULL

    NULL

    C

    1 or 0

    NULL

    +
    +
    +
    +

    Complex arrays

    +
    +

    NumPy-style: shape and strides

    +

    The logical structure of NumPy-style arrays is defined by itemsize, +ndim, shape and strides.

    +

    If ndim == 0, the memory location pointed to by buf is +interpreted as a scalar of size itemsize. In that case, +both shape and strides are NULL.

    +

    If strides is NULL, the array is interpreted as +a standard n-dimensional C-array. Otherwise, the consumer must access an +n-dimensional array as follows:

    +
    +

    ptr = (char *)buf + indices[0] * strides[0] + ... + indices[n-1] * strides[n-1] +item = *((typeof(item) *)ptr);

    +
    +

    As noted above, buf can point to any location within +the actual memory block. An exporter can check the validity of a buffer with +this function:

    +
    def verify_structure(memlen, itemsize, ndim, shape, strides, offset):
    +    """Verify that the parameters represent a valid array within
    +       the bounds of the allocated memory:
    +           char *mem: start of the physical memory block
    +           memlen: length of the physical memory block
    +           offset: (char *)buf - mem
    +    """
    +    if offset % itemsize:
    +        return False
    +    if offset < 0 or offset+itemsize > memlen:
    +        return False
    +    if any(v % itemsize for v in strides):
    +        return False
    +
    +    if ndim <= 0:
    +        return ndim == 0 and not shape and not strides
    +    if 0 in shape:
    +        return True
    +
    +    imin = sum(strides[j]*(shape[j]-1) for j in range(ndim)
    +               if strides[j] <= 0)
    +    imax = sum(strides[j]*(shape[j]-1) for j in range(ndim)
    +               if strides[j] > 0)
    +
    +    return 0 <= offset+imin and offset+imax+itemsize <= memlen
    +
    +
    +
    +
    +

    PIL-style: shape, strides and suboffsets

    +

    In addition to the regular items, PIL-style arrays can contain pointers +that must be followed in order to get to the next element in a dimension. +For example, the regular three-dimensional C-array char v[2][2][3] can +also be viewed as an array of 2 pointers to 2 two-dimensional arrays: +char (*v[2])[2][3]. In suboffsets representation, those two pointers +can be embedded at the start of buf, pointing +to two char x[2][3] arrays that can be located anywhere in memory.

    +

    Here is a function that returns a pointer to the element in an N-D array +pointed to by an N-dimensional index when there are both non-NULL strides +and suboffsets:

    +
    void *get_item_pointer(int ndim, void *buf, Py_ssize_t *strides,
    +                       Py_ssize_t *suboffsets, Py_ssize_t *indices) {
    +    char *pointer = (char*)buf;
    +    int i;
    +    for (i = 0; i < ndim; i++) {
    +        pointer += strides[i] * indices[i];
    +        if (suboffsets[i] >=0 ) {
    +            pointer = *((char**)pointer) + suboffsets[i];
    +        }
    +    }
    +    return (void*)pointer;
    +}
    +
    +
    +
    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/bytearray.html b/python-3.7.4-docs-html/c-api/bytearray.html new file mode 100644 index 0000000..84b87c5 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/bytearray.html @@ -0,0 +1,282 @@ + + + + + + + Byte Array Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Byte Array Objects

    +
    +
    +PyByteArrayObject
    +

    This subtype of PyObject represents a Python bytearray object.

    +
    + +
    +
    +PyTypeObject PyByteArray_Type
    +

    This instance of PyTypeObject represents the Python bytearray type; +it is the same object as bytearray in the Python layer.

    +
    + +
    +

    Type check macros

    +
    +
    +int PyByteArray_Check(PyObject *o)
    +

    Return true if the object o is a bytearray object or an instance of a +subtype of the bytearray type.

    +
    + +
    +
    +int PyByteArray_CheckExact(PyObject *o)
    +

    Return true if the object o is a bytearray object, but not an instance of a +subtype of the bytearray type.

    +
    + +
    +
    +

    Direct API functions

    +
    +
    +PyObject* PyByteArray_FromObject(PyObject *o)
    +
    Return value: New reference.

    Return a new bytearray object from any object, o, that implements the +buffer protocol.

    +
    + +
    +
    +PyObject* PyByteArray_FromStringAndSize(const char *string, Py_ssize_t len)
    +
    Return value: New reference.

    Create a new bytearray object from string and its length, len. On +failure, NULL is returned.

    +
    + +
    +
    +PyObject* PyByteArray_Concat(PyObject *a, PyObject *b)
    +
    Return value: New reference.

    Concat bytearrays a and b and return a new bytearray with the result.

    +
    + +
    +
    +Py_ssize_t PyByteArray_Size(PyObject *bytearray)
    +

    Return the size of bytearray after checking for a NULL pointer.

    +
    + +
    +
    +char* PyByteArray_AsString(PyObject *bytearray)
    +

    Return the contents of bytearray as a char array after checking for a +NULL pointer. The returned array always has an extra +null byte appended.

    +
    + +
    +
    +int PyByteArray_Resize(PyObject *bytearray, Py_ssize_t len)
    +

    Resize the internal buffer of bytearray to len.

    +
    + +
    +
    +

    Macros

    +

    These macros trade safety for speed and they don’t check pointers.

    +
    +
    +char* PyByteArray_AS_STRING(PyObject *bytearray)
    +

    Macro version of PyByteArray_AsString().

    +
    + +
    +
    +Py_ssize_t PyByteArray_GET_SIZE(PyObject *bytearray)
    +

    Macro version of PyByteArray_Size().

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/bytes.html b/python-3.7.4-docs-html/c-api/bytes.html new file mode 100644 index 0000000..4d96365 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/bytes.html @@ -0,0 +1,423 @@ + + + + + + + Bytes Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Bytes Objects

    +

    These functions raise TypeError when expecting a bytes parameter and are +called with a non-bytes parameter.

    +
    +
    +PyBytesObject
    +

    This subtype of PyObject represents a Python bytes object.

    +
    + +
    +
    +PyTypeObject PyBytes_Type
    +

    This instance of PyTypeObject represents the Python bytes type; it +is the same object as bytes in the Python layer.

    +
    + +
    +
    +int PyBytes_Check(PyObject *o)
    +

    Return true if the object o is a bytes object or an instance of a subtype +of the bytes type.

    +
    + +
    +
    +int PyBytes_CheckExact(PyObject *o)
    +

    Return true if the object o is a bytes object, but not an instance of a +subtype of the bytes type.

    +
    + +
    +
    +PyObject* PyBytes_FromString(const char *v)
    +
    Return value: New reference.

    Return a new bytes object with a copy of the string v as value on success, +and NULL on failure. The parameter v must not be NULL; it will not be +checked.

    +
    + +
    +
    +PyObject* PyBytes_FromStringAndSize(const char *v, Py_ssize_t len)
    +
    Return value: New reference.

    Return a new bytes object with a copy of the string v as value and length +len on success, and NULL on failure. If v is NULL, the contents of +the bytes object are uninitialized.

    +
    + +
    +
    +PyObject* PyBytes_FromFormat(const char *format, ...)
    +
    Return value: New reference.

    Take a C printf()-style format string and a variable number of +arguments, calculate the size of the resulting Python bytes object and return +a bytes object with the values formatted into it. The variable arguments +must be C types and must correspond exactly to the format characters in the +format string. The following format characters are allowed:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Format Characters

    Type

    Comment

    %%

    n/a

    The literal % character.

    %c

    int

    A single byte, +represented as a C int.

    %d

    int

    Equivalent to +printf("%d"). 1

    %u

    unsigned int

    Equivalent to +printf("%u"). 1

    %ld

    long

    Equivalent to +printf("%ld"). 1

    %lu

    unsigned long

    Equivalent to +printf("%lu"). 1

    %zd

    Py_ssize_t

    Equivalent to +printf("%zd"). 1

    %zu

    size_t

    Equivalent to +printf("%zu"). 1

    %i

    int

    Equivalent to +printf("%i"). 1

    %x

    int

    Equivalent to +printf("%x"). 1

    %s

    const char*

    A null-terminated C character +array.

    %p

    const void*

    The hex representation of a C +pointer. Mostly equivalent to +printf("%p") except that +it is guaranteed to start with +the literal 0x regardless +of what the platform’s +printf yields.

    +

    An unrecognized format character causes all the rest of the format string to be +copied as-is to the result object, and any extra arguments discarded.

    +
    +
    1(1,2,3,4,5,6,7,8)
    +

    For integer specifiers (d, u, ld, lu, zd, zu, i, x): the 0-conversion +flag has effect even when a precision is given.

    +
    +
    +
    + +
    +
    +PyObject* PyBytes_FromFormatV(const char *format, va_list vargs)
    +
    Return value: New reference.

    Identical to PyBytes_FromFormat() except that it takes exactly two +arguments.

    +
    + +
    +
    +PyObject* PyBytes_FromObject(PyObject *o)
    +
    Return value: New reference.

    Return the bytes representation of object o that implements the buffer +protocol.

    +
    + +
    +
    +Py_ssize_t PyBytes_Size(PyObject *o)
    +

    Return the length of the bytes in bytes object o.

    +
    + +
    +
    +Py_ssize_t PyBytes_GET_SIZE(PyObject *o)
    +

    Macro form of PyBytes_Size() but without error checking.

    +
    + +
    +
    +char* PyBytes_AsString(PyObject *o)
    +

    Return a pointer to the contents of o. The pointer +refers to the internal buffer of o, which consists of len(o) + 1 +bytes. The last byte in the buffer is always null, regardless of +whether there are any other null bytes. The data must not be +modified in any way, unless the object was just created using +PyBytes_FromStringAndSize(NULL, size). It must not be deallocated. If +o is not a bytes object at all, PyBytes_AsString() returns NULL +and raises TypeError.

    +
    + +
    +
    +char* PyBytes_AS_STRING(PyObject *string)
    +

    Macro form of PyBytes_AsString() but without error checking.

    +
    + +
    +
    +int PyBytes_AsStringAndSize(PyObject *obj, char **buffer, Py_ssize_t *length)
    +

    Return the null-terminated contents of the object obj +through the output variables buffer and length.

    +

    If length is NULL, the bytes object +may not contain embedded null bytes; +if it does, the function returns -1 and a ValueError is raised.

    +

    The buffer refers to an internal buffer of obj, which includes an +additional null byte at the end (not counted in length). The data +must not be modified in any way, unless the object was just created using +PyBytes_FromStringAndSize(NULL, size). It must not be deallocated. If +obj is not a bytes object at all, PyBytes_AsStringAndSize() +returns -1 and raises TypeError.

    +
    +

    Changed in version 3.5: Previously, TypeError was raised when embedded null bytes were +encountered in the bytes object.

    +
    +
    + +
    +
    +void PyBytes_Concat(PyObject **bytes, PyObject *newpart)
    +

    Create a new bytes object in *bytes containing the contents of newpart +appended to bytes; the caller will own the new reference. The reference to +the old value of bytes will be stolen. If the new object cannot be +created, the old reference to bytes will still be discarded and the value +of *bytes will be set to NULL; the appropriate exception will be set.

    +
    + +
    +
    +void PyBytes_ConcatAndDel(PyObject **bytes, PyObject *newpart)
    +

    Create a new bytes object in *bytes containing the contents of newpart +appended to bytes. This version decrements the reference count of +newpart.

    +
    + +
    +
    +int _PyBytes_Resize(PyObject **bytes, Py_ssize_t newsize)
    +

    A way to resize a bytes object even though it is “immutable”. Only use this +to build up a brand new bytes object; don’t use this if the bytes may already +be known in other parts of the code. It is an error to call this function if +the refcount on the input bytes object is not one. Pass the address of an +existing bytes object as an lvalue (it may be written into), and the new size +desired. On success, *bytes holds the resized bytes object and 0 is +returned; the address in *bytes may differ from its input value. If the +reallocation fails, the original bytes object at *bytes is deallocated, +*bytes is set to NULL, MemoryError is set, and -1 is +returned.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/capsule.html b/python-3.7.4-docs-html/c-api/capsule.html new file mode 100644 index 0000000..b788996 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/capsule.html @@ -0,0 +1,331 @@ + + + + + + + Capsules — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Capsules

    +

    Refer to Providing a C API for an Extension Module for more information on using these objects.

    +
    +

    New in version 3.1.

    +
    +
    +
    +PyCapsule
    +

    This subtype of PyObject represents an opaque value, useful for C +extension modules who need to pass an opaque value (as a void* +pointer) through Python code to other C code. It is often used to make a C +function pointer defined in one module available to other modules, so the +regular import mechanism can be used to access C APIs defined in dynamically +loaded modules.

    +
    + +
    +
    +PyCapsule_Destructor
    +

    The type of a destructor callback for a capsule. Defined as:

    +
    typedef void (*PyCapsule_Destructor)(PyObject *);
    +
    +
    +

    See PyCapsule_New() for the semantics of PyCapsule_Destructor +callbacks.

    +
    + +
    +
    +int PyCapsule_CheckExact(PyObject *p)
    +

    Return true if its argument is a PyCapsule.

    +
    + +
    +
    +PyObject* PyCapsule_New(void *pointer, const char *name, PyCapsule_Destructor destructor)
    +
    Return value: New reference.

    Create a PyCapsule encapsulating the pointer. The pointer +argument may not be NULL.

    +

    On failure, set an exception and return NULL.

    +

    The name string may either be NULL or a pointer to a valid C string. If +non-NULL, this string must outlive the capsule. (Though it is permitted to +free it inside the destructor.)

    +

    If the destructor argument is not NULL, it will be called with the +capsule as its argument when it is destroyed.

    +

    If this capsule will be stored as an attribute of a module, the name should +be specified as modulename.attributename. This will enable other modules +to import the capsule using PyCapsule_Import().

    +
    + +
    +
    +void* PyCapsule_GetPointer(PyObject *capsule, const char *name)
    +

    Retrieve the pointer stored in the capsule. On failure, set an exception +and return NULL.

    +

    The name parameter must compare exactly to the name stored in the capsule. +If the name stored in the capsule is NULL, the name passed in must also +be NULL. Python uses the C function strcmp() to compare capsule +names.

    +
    + +
    +
    +PyCapsule_Destructor PyCapsule_GetDestructor(PyObject *capsule)
    +

    Return the current destructor stored in the capsule. On failure, set an +exception and return NULL.

    +

    It is legal for a capsule to have a NULL destructor. This makes a NULL +return code somewhat ambiguous; use PyCapsule_IsValid() or +PyErr_Occurred() to disambiguate.

    +
    + +
    +
    +void* PyCapsule_GetContext(PyObject *capsule)
    +

    Return the current context stored in the capsule. On failure, set an +exception and return NULL.

    +

    It is legal for a capsule to have a NULL context. This makes a NULL +return code somewhat ambiguous; use PyCapsule_IsValid() or +PyErr_Occurred() to disambiguate.

    +
    + +
    +
    +const char* PyCapsule_GetName(PyObject *capsule)
    +

    Return the current name stored in the capsule. On failure, set an exception +and return NULL.

    +

    It is legal for a capsule to have a NULL name. This makes a NULL return +code somewhat ambiguous; use PyCapsule_IsValid() or +PyErr_Occurred() to disambiguate.

    +
    + +
    +
    +void* PyCapsule_Import(const char *name, int no_block)
    +

    Import a pointer to a C object from a capsule attribute in a module. The +name parameter should specify the full name to the attribute, as in +module.attribute. The name stored in the capsule must match this +string exactly. If no_block is true, import the module without blocking +(using PyImport_ImportModuleNoBlock()). If no_block is false, +import the module conventionally (using PyImport_ImportModule()).

    +

    Return the capsule’s internal pointer on success. On failure, set an +exception and return NULL.

    +
    + +
    +
    +int PyCapsule_IsValid(PyObject *capsule, const char *name)
    +

    Determines whether or not capsule is a valid capsule. A valid capsule is +non-NULL, passes PyCapsule_CheckExact(), has a non-NULL pointer +stored in it, and its internal name matches the name parameter. (See +PyCapsule_GetPointer() for information on how capsule names are +compared.)

    +

    In other words, if PyCapsule_IsValid() returns a true value, calls to +any of the accessors (any function starting with PyCapsule_Get()) are +guaranteed to succeed.

    +

    Return a nonzero value if the object is valid and matches the name passed in. +Return 0 otherwise. This function will not fail.

    +
    + +
    +
    +int PyCapsule_SetContext(PyObject *capsule, void *context)
    +

    Set the context pointer inside capsule to context.

    +

    Return 0 on success. Return nonzero and set an exception on failure.

    +
    + +
    +
    +int PyCapsule_SetDestructor(PyObject *capsule, PyCapsule_Destructor destructor)
    +

    Set the destructor inside capsule to destructor.

    +

    Return 0 on success. Return nonzero and set an exception on failure.

    +
    + +
    +
    +int PyCapsule_SetName(PyObject *capsule, const char *name)
    +

    Set the name inside capsule to name. If non-NULL, the name must +outlive the capsule. If the previous name stored in the capsule was not +NULL, no attempt is made to free it.

    +

    Return 0 on success. Return nonzero and set an exception on failure.

    +
    + +
    +
    +int PyCapsule_SetPointer(PyObject *capsule, void *pointer)
    +

    Set the void pointer inside capsule to pointer. The pointer may not be +NULL.

    +

    Return 0 on success. Return nonzero and set an exception on failure.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/cell.html b/python-3.7.4-docs-html/c-api/cell.html new file mode 100644 index 0000000..02c3339 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/cell.html @@ -0,0 +1,246 @@ + + + + + + + Cell Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Cell Objects

    +

    “Cell” objects are used to implement variables referenced by multiple scopes. +For each such variable, a cell object is created to store the value; the local +variables of each stack frame that references the value contains a reference to +the cells from outer scopes which also use that variable. When the value is +accessed, the value contained in the cell is used instead of the cell object +itself. This de-referencing of the cell object requires support from the +generated byte-code; these are not automatically de-referenced when accessed. +Cell objects are not likely to be useful elsewhere.

    +
    +
    +PyCellObject
    +

    The C structure used for cell objects.

    +
    + +
    +
    +PyTypeObject PyCell_Type
    +

    The type object corresponding to cell objects.

    +
    + +
    +
    +int PyCell_Check(ob)
    +

    Return true if ob is a cell object; ob must not be NULL.

    +
    + +
    +
    +PyObject* PyCell_New(PyObject *ob)
    +
    Return value: New reference.

    Create and return a new cell object containing the value ob. The parameter may +be NULL.

    +
    + +
    +
    +PyObject* PyCell_Get(PyObject *cell)
    +
    Return value: New reference.

    Return the contents of the cell cell.

    +
    + +
    +
    +PyObject* PyCell_GET(PyObject *cell)
    +
    Return value: Borrowed reference.

    Return the contents of the cell cell, but without checking that cell is +non-NULL and a cell object.

    +
    + +
    +
    +int PyCell_Set(PyObject *cell, PyObject *value)
    +

    Set the contents of the cell object cell to value. This releases the +reference to any current content of the cell. value may be NULL. cell +must be non-NULL; if it is not a cell object, -1 will be returned. On +success, 0 will be returned.

    +
    + +
    +
    +void PyCell_SET(PyObject *cell, PyObject *value)
    +

    Sets the value of the cell object cell to value. No reference counts are +adjusted, and no checks are made for safety; cell must be non-NULL and must +be a cell object.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/code.html b/python-3.7.4-docs-html/c-api/code.html new file mode 100644 index 0000000..6579458 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/code.html @@ -0,0 +1,229 @@ + + + + + + + Code Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Code Objects

    +

    Code objects are a low-level detail of the CPython implementation. +Each one represents a chunk of executable code that hasn’t yet been +bound into a function.

    +
    +
    +PyCodeObject
    +

    The C structure of the objects used to describe code objects. The +fields of this type are subject to change at any time.

    +
    + +
    +
    +PyTypeObject PyCode_Type
    +

    This is an instance of PyTypeObject representing the Python +code type.

    +
    + +
    +
    +int PyCode_Check(PyObject *co)
    +

    Return true if co is a code object.

    +
    + +
    +
    +int PyCode_GetNumFree(PyCodeObject *co)
    +

    Return the number of free variables in co.

    +
    + +
    +
    +PyCodeObject* PyCode_New(int argcount, int kwonlyargcount, int nlocals, int stacksize, int flags, PyObject *code, PyObject *consts, PyObject *names, PyObject *varnames, PyObject *freevars, PyObject *cellvars, PyObject *filename, PyObject *name, int firstlineno, PyObject *lnotab)
    +
    Return value: New reference.

    Return a new code object. If you need a dummy code object to +create a frame, use PyCode_NewEmpty() instead. Calling +PyCode_New() directly can bind you to a precise Python +version since the definition of the bytecode changes often.

    +
    + +
    +
    +PyCodeObject* PyCode_NewEmpty(const char *filename, const char *funcname, int firstlineno)
    +
    Return value: New reference.

    Return a new empty code object with the specified filename, +function name, and first line number. It is illegal to +exec() or eval() the resulting code object.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/codec.html b/python-3.7.4-docs-html/c-api/codec.html new file mode 100644 index 0000000..7f7ff35 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/codec.html @@ -0,0 +1,340 @@ + + + + + + + Codec registry and support functions — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Codec registry and support functions

    +
    +
    +int PyCodec_Register(PyObject *search_function)
    +

    Register a new codec search function.

    +

    As side effect, this tries to load the encodings package, if not yet +done, to make sure that it is always first in the list of search functions.

    +
    + +
    +
    +int PyCodec_KnownEncoding(const char *encoding)
    +

    Return 1 or 0 depending on whether there is a registered codec for +the given encoding. This function always succeeds.

    +
    + +
    +
    +PyObject* PyCodec_Encode(PyObject *object, const char *encoding, const char *errors)
    +
    Return value: New reference.

    Generic codec based encoding API.

    +

    object is passed through the encoder function found for the given +encoding using the error handling method defined by errors. errors may +be NULL to use the default method defined for the codec. Raises a +LookupError if no encoder can be found.

    +
    + +
    +
    +PyObject* PyCodec_Decode(PyObject *object, const char *encoding, const char *errors)
    +
    Return value: New reference.

    Generic codec based decoding API.

    +

    object is passed through the decoder function found for the given +encoding using the error handling method defined by errors. errors may +be NULL to use the default method defined for the codec. Raises a +LookupError if no encoder can be found.

    +
    + +
    +

    Codec lookup API

    +

    In the following functions, the encoding string is looked up converted to all +lower-case characters, which makes encodings looked up through this mechanism +effectively case-insensitive. If no codec is found, a KeyError is set +and NULL returned.

    +
    +
    +PyObject* PyCodec_Encoder(const char *encoding)
    +
    Return value: New reference.

    Get an encoder function for the given encoding.

    +
    + +
    +
    +PyObject* PyCodec_Decoder(const char *encoding)
    +
    Return value: New reference.

    Get a decoder function for the given encoding.

    +
    + +
    +
    +PyObject* PyCodec_IncrementalEncoder(const char *encoding, const char *errors)
    +
    Return value: New reference.

    Get an IncrementalEncoder object for the given encoding.

    +
    + +
    +
    +PyObject* PyCodec_IncrementalDecoder(const char *encoding, const char *errors)
    +
    Return value: New reference.

    Get an IncrementalDecoder object for the given encoding.

    +
    + +
    +
    +PyObject* PyCodec_StreamReader(const char *encoding, PyObject *stream, const char *errors)
    +
    Return value: New reference.

    Get a StreamReader factory function for the given encoding.

    +
    + +
    +
    +PyObject* PyCodec_StreamWriter(const char *encoding, PyObject *stream, const char *errors)
    +
    Return value: New reference.

    Get a StreamWriter factory function for the given encoding.

    +
    + +
    +
    +

    Registry API for Unicode encoding error handlers

    +
    +
    +int PyCodec_RegisterError(const char *name, PyObject *error)
    +

    Register the error handling callback function error under the given name. +This callback function will be called by a codec when it encounters +unencodable characters/undecodable bytes and name is specified as the error +parameter in the call to the encode/decode function.

    +

    The callback gets a single argument, an instance of +UnicodeEncodeError, UnicodeDecodeError or +UnicodeTranslateError that holds information about the problematic +sequence of characters or bytes and their offset in the original string (see +Unicode Exception Objects for functions to extract this information). The +callback must either raise the given exception, or return a two-item tuple +containing the replacement for the problematic sequence, and an integer +giving the offset in the original string at which encoding/decoding should be +resumed.

    +

    Return 0 on success, -1 on error.

    +
    + +
    +
    +PyObject* PyCodec_LookupError(const char *name)
    +
    Return value: New reference.

    Lookup the error handling callback function registered under name. As a +special case NULL can be passed, in which case the error handling callback +for “strict” will be returned.

    +
    + +
    +
    +PyObject* PyCodec_StrictErrors(PyObject *exc)
    +
    Return value: Always NULL.

    Raise exc as an exception.

    +
    + +
    +
    +PyObject* PyCodec_IgnoreErrors(PyObject *exc)
    +
    Return value: New reference.

    Ignore the unicode error, skipping the faulty input.

    +
    + +
    +
    +PyObject* PyCodec_ReplaceErrors(PyObject *exc)
    +
    Return value: New reference.

    Replace the unicode encode error with ? or U+FFFD.

    +
    + +
    +
    +PyObject* PyCodec_XMLCharRefReplaceErrors(PyObject *exc)
    +
    Return value: New reference.

    Replace the unicode encode error with XML character references.

    +
    + +
    +
    +PyObject* PyCodec_BackslashReplaceErrors(PyObject *exc)
    +
    Return value: New reference.

    Replace the unicode encode error with backslash escapes (\x, \u and +\U).

    +
    + +
    +
    +PyObject* PyCodec_NameReplaceErrors(PyObject *exc)
    +
    Return value: New reference.

    Replace the unicode encode error with \N{...} escapes.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/complex.html b/python-3.7.4-docs-html/c-api/complex.html new file mode 100644 index 0000000..cc486c7 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/complex.html @@ -0,0 +1,326 @@ + + + + + + + Complex Number Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Complex Number Objects

    +

    Python’s complex number objects are implemented as two distinct types when +viewed from the C API: one is the Python object exposed to Python programs, and +the other is a C structure which represents the actual complex number value. +The API provides functions for working with both.

    +
    +

    Complex Numbers as C Structures

    +

    Note that the functions which accept these structures as parameters and return +them as results do so by value rather than dereferencing them through +pointers. This is consistent throughout the API.

    +
    +
    +Py_complex
    +

    The C structure which corresponds to the value portion of a Python complex +number object. Most of the functions for dealing with complex number objects +use structures of this type as input or output values, as appropriate. It is +defined as:

    +
    typedef struct {
    +   double real;
    +   double imag;
    +} Py_complex;
    +
    +
    +
    + +
    +
    +Py_complex _Py_c_sum(Py_complex left, Py_complex right)
    +

    Return the sum of two complex numbers, using the C Py_complex +representation.

    +
    + +
    +
    +Py_complex _Py_c_diff(Py_complex left, Py_complex right)
    +

    Return the difference between two complex numbers, using the C +Py_complex representation.

    +
    + +
    +
    +Py_complex _Py_c_neg(Py_complex complex)
    +

    Return the negation of the complex number complex, using the C +Py_complex representation.

    +
    + +
    +
    +Py_complex _Py_c_prod(Py_complex left, Py_complex right)
    +

    Return the product of two complex numbers, using the C Py_complex +representation.

    +
    + +
    +
    +Py_complex _Py_c_quot(Py_complex dividend, Py_complex divisor)
    +

    Return the quotient of two complex numbers, using the C Py_complex +representation.

    +

    If divisor is null, this method returns zero and sets +errno to EDOM.

    +
    + +
    +
    +Py_complex _Py_c_pow(Py_complex num, Py_complex exp)
    +

    Return the exponentiation of num by exp, using the C Py_complex +representation.

    +

    If num is null and exp is not a positive real number, +this method returns zero and sets errno to EDOM.

    +
    + +
    +
    +

    Complex Numbers as Python Objects

    +
    +
    +PyComplexObject
    +

    This subtype of PyObject represents a Python complex number object.

    +
    + +
    +
    +PyTypeObject PyComplex_Type
    +

    This instance of PyTypeObject represents the Python complex number +type. It is the same object as complex in the Python layer.

    +
    + +
    +
    +int PyComplex_Check(PyObject *p)
    +

    Return true if its argument is a PyComplexObject or a subtype of +PyComplexObject.

    +
    + +
    +
    +int PyComplex_CheckExact(PyObject *p)
    +

    Return true if its argument is a PyComplexObject, but not a subtype of +PyComplexObject.

    +
    + +
    +
    +PyObject* PyComplex_FromCComplex(Py_complex v)
    +
    Return value: New reference.

    Create a new Python complex number object from a C Py_complex value.

    +
    + +
    +
    +PyObject* PyComplex_FromDoubles(double real, double imag)
    +
    Return value: New reference.

    Return a new PyComplexObject object from real and imag.

    +
    + +
    +
    +double PyComplex_RealAsDouble(PyObject *op)
    +

    Return the real part of op as a C double.

    +
    + +
    +
    +double PyComplex_ImagAsDouble(PyObject *op)
    +

    Return the imaginary part of op as a C double.

    +
    + +
    +
    +Py_complex PyComplex_AsCComplex(PyObject *op)
    +

    Return the Py_complex value of the complex number op.

    +

    If op is not a Python complex number object but has a __complex__() +method, this method will first be called to convert op to a Python complex +number object. Upon failure, this method returns -1.0 as a real value.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/concrete.html b/python-3.7.4-docs-html/c-api/concrete.html new file mode 100644 index 0000000..836c7b6 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/concrete.html @@ -0,0 +1,332 @@ + + + + + + + Concrete Objects Layer — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Concrete Objects Layer

    +

    The functions in this chapter are specific to certain Python object types. +Passing them an object of the wrong type is not a good idea; if you receive an +object from a Python program and you are not sure that it has the right type, +you must perform a type check first; for example, to check that an object is a +dictionary, use PyDict_Check(). The chapter is structured like the +“family tree” of Python object types.

    +
    +

    Warning

    +

    While the functions described in this chapter carefully check the type of the +objects which are passed in, many of them do not check for NULL being passed +instead of a valid object. Allowing NULL to be passed in can cause memory +access violations and immediate termination of the interpreter.

    +
    +
    +

    Fundamental Objects

    +

    This section describes Python type objects and the singleton object None.

    + +
    + + +
    +

    Container Objects

    + +
    + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/contextvars.html b/python-3.7.4-docs-html/c-api/contextvars.html new file mode 100644 index 0000000..c7597b5 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/contextvars.html @@ -0,0 +1,350 @@ + + + + + + + Context Variables Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Context Variables Objects

    +
    +
    +

    Note

    +Changed in version 3.7.1:

    In Python 3.7.1 the signatures of all context variables +C APIs were changed to use PyObject pointers instead +of PyContext, PyContextVar, and +PyContextToken, e.g.:

    +
    // in 3.7.0:
    +PyContext *PyContext_New(void);
    +
    +// in 3.7.1+:
    +PyObject *PyContext_New(void);
    +
    +
    +

    See bpo-34762 for more details.

    +
    +
    +
    +

    New in version 3.7.

    +
    +

    This section details the public C API for the contextvars module.

    +
    +
    +PyContext
    +

    The C structure used to represent a contextvars.Context +object.

    +
    + +
    +
    +PyContextVar
    +

    The C structure used to represent a contextvars.ContextVar +object.

    +
    + +
    +
    +PyContextToken
    +

    The C structure used to represent a contextvars.Token object.

    +
    + +
    +
    +PyTypeObject PyContext_Type
    +

    The type object representing the context type.

    +
    + +
    +
    +PyTypeObject PyContextVar_Type
    +

    The type object representing the context variable type.

    +
    + +
    +
    +PyTypeObject PyContextToken_Type
    +

    The type object representing the context variable token type.

    +
    + +

    Type-check macros:

    +
    +
    +int PyContext_CheckExact(PyObject *o)
    +

    Return true if o is of type PyContext_Type. o must not be +NULL. This function always succeeds.

    +
    + +
    +
    +int PyContextVar_CheckExact(PyObject *o)
    +

    Return true if o is of type PyContextVar_Type. o must not be +NULL. This function always succeeds.

    +
    + +
    +
    +int PyContextToken_CheckExact(PyObject *o)
    +

    Return true if o is of type PyContextToken_Type. +o must not be NULL. This function always succeeds.

    +
    + +

    Context object management functions:

    +
    +
    +PyObject *PyContext_New(void)
    +
    Return value: New reference.

    Create a new empty context object. Returns NULL if an error +has occurred.

    +
    + +
    +
    +PyObject *PyContext_Copy(PyObject *ctx)
    +
    Return value: New reference.

    Create a shallow copy of the passed ctx context object. +Returns NULL if an error has occurred.

    +
    + +
    +
    +PyObject *PyContext_CopyCurrent(void)
    +
    Return value: New reference.

    Create a shallow copy of the current thread context. +Returns NULL if an error has occurred.

    +
    + +
    +
    +int PyContext_Enter(PyObject *ctx)
    +

    Set ctx as the current context for the current thread. +Returns 0 on success, and -1 on error.

    +
    + +
    +
    +int PyContext_Exit(PyObject *ctx)
    +

    Deactivate the ctx context and restore the previous context as the +current context for the current thread. Returns 0 on success, +and -1 on error.

    +
    + +
    +
    +int PyContext_ClearFreeList()
    +

    Clear the context variable free list. Return the total number of +freed items. This function always succeeds.

    +
    + +

    Context variable functions:

    +
    +
    +PyObject *PyContextVar_New(const char *name, PyObject *def)
    +
    Return value: New reference.

    Create a new ContextVar object. The name parameter is used +for introspection and debug purposes. The def parameter may optionally +specify the default value for the context variable. If an error has +occurred, this function returns NULL.

    +
    + +
    +
    +int PyContextVar_Get(PyObject *var, PyObject *default_value, PyObject **value)
    +

    Get the value of a context variable. Returns -1 if an error has +occurred during lookup, and 0 if no error occurred, whether or not +a value was found.

    +

    If the context variable was found, value will be a pointer to it. +If the context variable was not found, value will point to:

    +
      +
    • default_value, if not NULL;

    • +
    • the default value of var, if not NULL;

    • +
    • NULL

    • +
    +

    If the value was found, the function will create a new reference to it.

    +
    + +
    +
    +PyObject *PyContextVar_Set(PyObject *var, PyObject *value)
    +
    Return value: New reference.

    Set the value of var to value in the current context. Returns a +pointer to a PyObject object, or NULL if an error +has occurred.

    +
    + +
    +
    +int PyContextVar_Reset(PyObject *var, PyObject *token)
    +

    Reset the state of the var context variable to that it was in before +PyContextVar_Set() that returned the token was called. +This function returns 0 on success and -1 on error.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/conversion.html b/python-3.7.4-docs-html/c-api/conversion.html new file mode 100644 index 0000000..43ee002 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/conversion.html @@ -0,0 +1,300 @@ + + + + + + + String conversion and formatting — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    String conversion and formatting

    +

    Functions for number conversion and formatted string output.

    +
    +
    +int PyOS_snprintf(char *str, size_t size, const char *format, ...)
    +

    Output not more than size bytes to str according to the format string +format and the extra arguments. See the Unix man page snprintf(2).

    +
    + +
    +
    +int PyOS_vsnprintf(char *str, size_t size, const char *format, va_list va)
    +

    Output not more than size bytes to str according to the format string +format and the variable argument list va. Unix man page +vsnprintf(2).

    +
    + +

    PyOS_snprintf() and PyOS_vsnprintf() wrap the Standard C library +functions snprintf() and vsnprintf(). Their purpose is to +guarantee consistent behavior in corner cases, which the Standard C functions do +not.

    +

    The wrappers ensure that str*[*size-1] is always '\0' upon return. They +never write more than size bytes (including the trailing '\0') into str. +Both functions require that str != NULL, size > 0 and format != +NULL.

    +

    If the platform doesn’t have vsnprintf() and the buffer size needed to +avoid truncation exceeds size by more than 512 bytes, Python aborts with a +Py_FatalError.

    +

    The return value (rv) for these functions should be interpreted as follows:

    +
      +
    • When 0 <= rv < size, the output conversion was successful and rv +characters were written to str (excluding the trailing '\0' byte at +str*[*rv]).

    • +
    • When rv >= size, the output conversion was truncated and a buffer with +rv + 1 bytes would have been needed to succeed. str*[*size-1] is '\0' +in this case.

    • +
    • When rv < 0, “something bad happened.” str*[*size-1] is '\0' in +this case too, but the rest of str is undefined. The exact cause of the error +depends on the underlying platform.

    • +
    +

    The following functions provide locale-independent string to number conversions.

    +
    +
    +double PyOS_string_to_double(const char *s, char **endptr, PyObject *overflow_exception)
    +

    Convert a string s to a double, raising a Python +exception on failure. The set of accepted strings corresponds to +the set of strings accepted by Python’s float() constructor, +except that s must not have leading or trailing whitespace. +The conversion is independent of the current locale.

    +

    If endptr is NULL, convert the whole string. Raise +ValueError and return -1.0 if the string is not a valid +representation of a floating-point number.

    +

    If endptr is not NULL, convert as much of the string as +possible and set *endptr to point to the first unconverted +character. If no initial segment of the string is the valid +representation of a floating-point number, set *endptr to point +to the beginning of the string, raise ValueError, and return +-1.0.

    +

    If s represents a value that is too large to store in a float +(for example, "1e500" is such a string on many platforms) then +if overflow_exception is NULL return Py_HUGE_VAL (with +an appropriate sign) and don’t set any exception. Otherwise, +overflow_exception must point to a Python exception object; +raise that exception and return -1.0. In both cases, set +*endptr to point to the first character after the converted value.

    +

    If any other error occurs during the conversion (for example an +out-of-memory error), set the appropriate Python exception and +return -1.0.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +char* PyOS_double_to_string(double val, char format_code, int precision, int flags, int *ptype)
    +

    Convert a double val to a string using supplied +format_code, precision, and flags.

    +

    format_code must be one of 'e', 'E', 'f', 'F', +'g', 'G' or 'r'. For 'r', the supplied precision +must be 0 and is ignored. The 'r' format code specifies the +standard repr() format.

    +

    flags can be zero or more of the values Py_DTSF_SIGN, +Py_DTSF_ADD_DOT_0, or Py_DTSF_ALT, or-ed together:

    +
      +
    • Py_DTSF_SIGN means to always precede the returned string with a sign +character, even if val is non-negative.

    • +
    • Py_DTSF_ADD_DOT_0 means to ensure that the returned string will not look +like an integer.

    • +
    • Py_DTSF_ALT means to apply “alternate” formatting rules. See the +documentation for the PyOS_snprintf() '#' specifier for +details.

    • +
    +

    If ptype is non-NULL, then the value it points to will be set to one of +Py_DTST_FINITE, Py_DTST_INFINITE, or Py_DTST_NAN, signifying that +val is a finite number, an infinite number, or not a number, respectively.

    +

    The return value is a pointer to buffer with the converted string or +NULL if the conversion failed. The caller is responsible for freeing the +returned string by calling PyMem_Free().

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +int PyOS_stricmp(const char *s1, const char *s2)
    +

    Case insensitive comparison of strings. The function works almost +identically to strcmp() except that it ignores the case.

    +
    + +
    +
    +int PyOS_strnicmp(const char *s1, const char *s2, Py_ssize_t  size)
    +

    Case insensitive comparison of strings. The function works almost +identically to strncmp() except that it ignores the case.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/coro.html b/python-3.7.4-docs-html/c-api/coro.html new file mode 100644 index 0000000..4614040 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/coro.html @@ -0,0 +1,215 @@ + + + + + + + Coroutine Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Coroutine Objects

    +
    +

    New in version 3.5.

    +
    +

    Coroutine objects are what functions declared with an async keyword +return.

    +
    +
    +PyCoroObject
    +

    The C structure used for coroutine objects.

    +
    + +
    +
    +PyTypeObject PyCoro_Type
    +

    The type object corresponding to coroutine objects.

    +
    + +
    +
    +int PyCoro_CheckExact(PyObject *ob)
    +

    Return true if ob’s type is PyCoro_Type; ob must not be NULL.

    +
    + +
    +
    +PyObject* PyCoro_New(PyFrameObject *frame, PyObject *name, PyObject *qualname)
    +
    Return value: New reference.

    Create and return a new coroutine object based on the frame object, +with __name__ and __qualname__ set to name and qualname. +A reference to frame is stolen by this function. The frame argument +must not be NULL.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/datetime.html b/python-3.7.4-docs-html/c-api/datetime.html new file mode 100644 index 0000000..d182408 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/datetime.html @@ -0,0 +1,463 @@ + + + + + + + DateTime Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    DateTime Objects

    +

    Various date and time objects are supplied by the datetime module. +Before using any of these functions, the header file datetime.h must be +included in your source (note that this is not included by Python.h), +and the macro PyDateTime_IMPORT must be invoked, usually as part of +the module initialisation function. The macro puts a pointer to a C structure +into a static variable, PyDateTimeAPI, that is used by the following +macros.

    +

    Macro for access to the UTC singleton:

    +
    +
    +PyObject* PyDateTime_TimeZone_UTC
    +

    Returns the time zone singleton representing UTC, the same object as +datetime.timezone.utc.

    +
    +

    New in version 3.7.

    +
    +
    + +

    Type-check macros:

    +
    +
    +int PyDate_Check(PyObject *ob)
    +

    Return true if ob is of type PyDateTime_DateType or a subtype of +PyDateTime_DateType. ob must not be NULL.

    +
    + +
    +
    +int PyDate_CheckExact(PyObject *ob)
    +

    Return true if ob is of type PyDateTime_DateType. ob must not be +NULL.

    +
    + +
    +
    +int PyDateTime_Check(PyObject *ob)
    +

    Return true if ob is of type PyDateTime_DateTimeType or a subtype of +PyDateTime_DateTimeType. ob must not be NULL.

    +
    + +
    +
    +int PyDateTime_CheckExact(PyObject *ob)
    +

    Return true if ob is of type PyDateTime_DateTimeType. ob must not +be NULL.

    +
    + +
    +
    +int PyTime_Check(PyObject *ob)
    +

    Return true if ob is of type PyDateTime_TimeType or a subtype of +PyDateTime_TimeType. ob must not be NULL.

    +
    + +
    +
    +int PyTime_CheckExact(PyObject *ob)
    +

    Return true if ob is of type PyDateTime_TimeType. ob must not be +NULL.

    +
    + +
    +
    +int PyDelta_Check(PyObject *ob)
    +

    Return true if ob is of type PyDateTime_DeltaType or a subtype of +PyDateTime_DeltaType. ob must not be NULL.

    +
    + +
    +
    +int PyDelta_CheckExact(PyObject *ob)
    +

    Return true if ob is of type PyDateTime_DeltaType. ob must not be +NULL.

    +
    + +
    +
    +int PyTZInfo_Check(PyObject *ob)
    +

    Return true if ob is of type PyDateTime_TZInfoType or a subtype of +PyDateTime_TZInfoType. ob must not be NULL.

    +
    + +
    +
    +int PyTZInfo_CheckExact(PyObject *ob)
    +

    Return true if ob is of type PyDateTime_TZInfoType. ob must not be +NULL.

    +
    + +

    Macros to create objects:

    +
    +
    +PyObject* PyDate_FromDate(int year, int month, int day)
    +
    Return value: New reference.

    Return a datetime.date object with the specified year, month and day.

    +
    + +
    +
    +PyObject* PyDateTime_FromDateAndTime(int year, int month, int day, int hour, int minute, int second, int usecond)
    +
    Return value: New reference.

    Return a datetime.datetime object with the specified year, month, day, hour, +minute, second and microsecond.

    +
    + +
    +
    +PyObject* PyDateTime_FromDateAndTimeAndFold(int year, int month, int day, int hour, int minute, int second, int usecond, int fold)
    +
    Return value: New reference.

    Return a datetime.datetime object with the specified year, month, day, hour, +minute, second, microsecond and fold.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +PyObject* PyTime_FromTime(int hour, int minute, int second, int usecond)
    +
    Return value: New reference.

    Return a datetime.time object with the specified hour, minute, second and +microsecond.

    +
    + +
    +
    +PyObject* PyTime_FromTimeAndFold(int hour, int minute, int second, int usecond, int fold)
    +
    Return value: New reference.

    Return a datetime.time object with the specified hour, minute, second, +microsecond and fold.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +PyObject* PyDelta_FromDSU(int days, int seconds, int useconds)
    +
    Return value: New reference.

    Return a datetime.timedelta object representing the given number +of days, seconds and microseconds. Normalization is performed so that the +resulting number of microseconds and seconds lie in the ranges documented for +datetime.timedelta objects.

    +
    + +
    +
    +PyObject* PyTimeZone_FromOffset(PyDateTime_DeltaType* offset)
    +
    Return value: New reference.

    Return a datetime.timezone object with an unnamed fixed offset +represented by the offset argument.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +PyObject* PyTimeZone_FromOffsetAndName(PyDateTime_DeltaType* offset, PyUnicode* name)
    +
    Return value: New reference.

    Return a datetime.timezone object with a fixed offset represented +by the offset argument and with tzname name.

    +
    +

    New in version 3.7.

    +
    +
    + +

    Macros to extract fields from date objects. The argument must be an instance of +PyDateTime_Date, including subclasses (such as +PyDateTime_DateTime). The argument must not be NULL, and the type is +not checked:

    +
    +
    +int PyDateTime_GET_YEAR(PyDateTime_Date *o)
    +

    Return the year, as a positive int.

    +
    + +
    +
    +int PyDateTime_GET_MONTH(PyDateTime_Date *o)
    +

    Return the month, as an int from 1 through 12.

    +
    + +
    +
    +int PyDateTime_GET_DAY(PyDateTime_Date *o)
    +

    Return the day, as an int from 1 through 31.

    +
    + +

    Macros to extract fields from datetime objects. The argument must be an +instance of PyDateTime_DateTime, including subclasses. The argument +must not be NULL, and the type is not checked:

    +
    +
    +int PyDateTime_DATE_GET_HOUR(PyDateTime_DateTime *o)
    +

    Return the hour, as an int from 0 through 23.

    +
    + +
    +
    +int PyDateTime_DATE_GET_MINUTE(PyDateTime_DateTime *o)
    +

    Return the minute, as an int from 0 through 59.

    +
    + +
    +
    +int PyDateTime_DATE_GET_SECOND(PyDateTime_DateTime *o)
    +

    Return the second, as an int from 0 through 59.

    +
    + +
    +
    +int PyDateTime_DATE_GET_MICROSECOND(PyDateTime_DateTime *o)
    +

    Return the microsecond, as an int from 0 through 999999.

    +
    + +

    Macros to extract fields from time objects. The argument must be an instance of +PyDateTime_Time, including subclasses. The argument must not be NULL, +and the type is not checked:

    +
    +
    +int PyDateTime_TIME_GET_HOUR(PyDateTime_Time *o)
    +

    Return the hour, as an int from 0 through 23.

    +
    + +
    +
    +int PyDateTime_TIME_GET_MINUTE(PyDateTime_Time *o)
    +

    Return the minute, as an int from 0 through 59.

    +
    + +
    +
    +int PyDateTime_TIME_GET_SECOND(PyDateTime_Time *o)
    +

    Return the second, as an int from 0 through 59.

    +
    + +
    +
    +int PyDateTime_TIME_GET_MICROSECOND(PyDateTime_Time *o)
    +

    Return the microsecond, as an int from 0 through 999999.

    +
    + +

    Macros to extract fields from time delta objects. The argument must be an +instance of PyDateTime_Delta, including subclasses. The argument must +not be NULL, and the type is not checked:

    +
    +
    +int PyDateTime_DELTA_GET_DAYS(PyDateTime_Delta *o)
    +

    Return the number of days, as an int from -999999999 to 999999999.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +int PyDateTime_DELTA_GET_SECONDS(PyDateTime_Delta *o)
    +

    Return the number of seconds, as an int from 0 through 86399.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +int PyDateTime_DELTA_GET_MICROSECONDS(PyDateTime_Delta *o)
    +

    Return the number of microseconds, as an int from 0 through 999999.

    +
    +

    New in version 3.3.

    +
    +
    + +

    Macros for the convenience of modules implementing the DB API:

    +
    +
    +PyObject* PyDateTime_FromTimestamp(PyObject *args)
    +
    Return value: New reference.

    Create and return a new datetime.datetime object given an argument +tuple suitable for passing to datetime.datetime.fromtimestamp().

    +
    + +
    +
    +PyObject* PyDate_FromTimestamp(PyObject *args)
    +
    Return value: New reference.

    Create and return a new datetime.date object given an argument +tuple suitable for passing to datetime.date.fromtimestamp().

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/descriptor.html b/python-3.7.4-docs-html/c-api/descriptor.html new file mode 100644 index 0000000..c507f6f --- /dev/null +++ b/python-3.7.4-docs-html/c-api/descriptor.html @@ -0,0 +1,229 @@ + + + + + + + Descriptor Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Descriptor Objects

    +

    “Descriptors” are objects that describe some attribute of an object. They are +found in the dictionary of type objects.

    +
    +
    +PyTypeObject PyProperty_Type
    +

    The type object for the built-in descriptor types.

    +
    + +
    +
    +PyObject* PyDescr_NewGetSet(PyTypeObject *type, struct PyGetSetDef *getset)
    +
    Return value: New reference.
    + +
    +
    +PyObject* PyDescr_NewMember(PyTypeObject *type, struct PyMemberDef *meth)
    +
    Return value: New reference.
    + +
    +
    +PyObject* PyDescr_NewMethod(PyTypeObject *type, struct PyMethodDef *meth)
    +
    Return value: New reference.
    + +
    +
    +PyObject* PyDescr_NewWrapper(PyTypeObject *type, struct wrapperbase *wrapper, void *wrapped)
    +
    Return value: New reference.
    + +
    +
    +PyObject* PyDescr_NewClassMethod(PyTypeObject *type, PyMethodDef *method)
    +
    Return value: New reference.
    + +
    +
    +int PyDescr_IsData(PyObject *descr)
    +

    Return true if the descriptor objects descr describes a data attribute, or +false if it describes a method. descr must be a descriptor object; there is +no error checking.

    +
    + +
    +
    +PyObject* PyWrapper_New(PyObject *, PyObject *)
    +
    Return value: New reference.
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/dict.html b/python-3.7.4-docs-html/c-api/dict.html new file mode 100644 index 0000000..0a5cc6a --- /dev/null +++ b/python-3.7.4-docs-html/c-api/dict.html @@ -0,0 +1,439 @@ + + + + + + + Dictionary Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Dictionary Objects

    +
    +
    +PyDictObject
    +

    This subtype of PyObject represents a Python dictionary object.

    +
    + +
    +
    +PyTypeObject PyDict_Type
    +

    This instance of PyTypeObject represents the Python dictionary +type. This is the same object as dict in the Python layer.

    +
    + +
    +
    +int PyDict_Check(PyObject *p)
    +

    Return true if p is a dict object or an instance of a subtype of the dict +type.

    +
    + +
    +
    +int PyDict_CheckExact(PyObject *p)
    +

    Return true if p is a dict object, but not an instance of a subtype of +the dict type.

    +
    + +
    +
    +PyObject* PyDict_New()
    +
    Return value: New reference.

    Return a new empty dictionary, or NULL on failure.

    +
    + +
    +
    +PyObject* PyDictProxy_New(PyObject *mapping)
    +
    Return value: New reference.

    Return a types.MappingProxyType object for a mapping which +enforces read-only behavior. This is normally used to create a view to +prevent modification of the dictionary for non-dynamic class types.

    +
    + +
    +
    +void PyDict_Clear(PyObject *p)
    +

    Empty an existing dictionary of all key-value pairs.

    +
    + +
    +
    +int PyDict_Contains(PyObject *p, PyObject *key)
    +

    Determine if dictionary p contains key. If an item in p is matches +key, return 1, otherwise return 0. On error, return -1. +This is equivalent to the Python expression key in p.

    +
    + +
    +
    +PyObject* PyDict_Copy(PyObject *p)
    +
    Return value: New reference.

    Return a new dictionary that contains the same key-value pairs as p.

    +
    + +
    +
    +int PyDict_SetItem(PyObject *p, PyObject *key, PyObject *val)
    +

    Insert value into the dictionary p with a key of key. key must be +hashable; if it isn’t, TypeError will be raised. Return +0 on success or -1 on failure.

    +
    + +
    +
    +int PyDict_SetItemString(PyObject *p, const char *key, PyObject *val)
    +

    Insert value into the dictionary p using key as a key. key should +be a const char*. The key object is created using +PyUnicode_FromString(key). Return 0 on success or -1 on +failure.

    +
    + +
    +
    +int PyDict_DelItem(PyObject *p, PyObject *key)
    +

    Remove the entry in dictionary p with key key. key must be hashable; +if it isn’t, TypeError is raised. Return 0 on success or -1 +on failure.

    +
    + +
    +
    +int PyDict_DelItemString(PyObject *p, const char *key)
    +

    Remove the entry in dictionary p which has a key specified by the string +key. Return 0 on success or -1 on failure.

    +
    + +
    +
    +PyObject* PyDict_GetItem(PyObject *p, PyObject *key)
    +
    Return value: Borrowed reference.

    Return the object from dictionary p which has a key key. Return NULL +if the key key is not present, but without setting an exception.

    +

    Note that exceptions which occur while calling __hash__() and +__eq__() methods will get suppressed. +To get error reporting use PyDict_GetItemWithError() instead.

    +
    + +
    +
    +PyObject* PyDict_GetItemWithError(PyObject *p, PyObject *key)
    +
    Return value: Borrowed reference.

    Variant of PyDict_GetItem() that does not suppress +exceptions. Return NULL with an exception set if an exception +occurred. Return NULL without an exception set if the key +wasn’t present.

    +
    + +
    +
    +PyObject* PyDict_GetItemString(PyObject *p, const char *key)
    +
    Return value: Borrowed reference.

    This is the same as PyDict_GetItem(), but key is specified as a +const char*, rather than a PyObject*.

    +

    Note that exceptions which occur while calling __hash__() and +__eq__() methods and creating a temporary string object +will get suppressed. +To get error reporting use PyDict_GetItemWithError() instead.

    +
    + +
    +
    +PyObject* PyDict_SetDefault(PyObject *p, PyObject *key, PyObject *defaultobj)
    +
    Return value: Borrowed reference.

    This is the same as the Python-level dict.setdefault(). If present, it +returns the value corresponding to key from the dictionary p. If the key +is not in the dict, it is inserted with value defaultobj and defaultobj +is returned. This function evaluates the hash function of key only once, +instead of evaluating it independently for the lookup and the insertion.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +PyObject* PyDict_Items(PyObject *p)
    +
    Return value: New reference.

    Return a PyListObject containing all the items from the dictionary.

    +
    + +
    +
    +PyObject* PyDict_Keys(PyObject *p)
    +
    Return value: New reference.

    Return a PyListObject containing all the keys from the dictionary.

    +
    + +
    +
    +PyObject* PyDict_Values(PyObject *p)
    +
    Return value: New reference.

    Return a PyListObject containing all the values from the dictionary +p.

    +
    + +
    +
    +Py_ssize_t PyDict_Size(PyObject *p)
    +

    Return the number of items in the dictionary. This is equivalent to +len(p) on a dictionary.

    +
    + +
    +
    +int PyDict_Next(PyObject *p, Py_ssize_t *ppos, PyObject **pkey, PyObject **pvalue)
    +

    Iterate over all key-value pairs in the dictionary p. The +Py_ssize_t referred to by ppos must be initialized to 0 +prior to the first call to this function to start the iteration; the +function returns true for each pair in the dictionary, and false once all +pairs have been reported. The parameters pkey and pvalue should either +point to PyObject* variables that will be filled in with each key +and value, respectively, or may be NULL. Any references returned through +them are borrowed. ppos should not be altered during iteration. Its +value represents offsets within the internal dictionary structure, and +since the structure is sparse, the offsets are not consecutive.

    +

    For example:

    +
    PyObject *key, *value;
    +Py_ssize_t pos = 0;
    +
    +while (PyDict_Next(self->dict, &pos, &key, &value)) {
    +    /* do something interesting with the values... */
    +    ...
    +}
    +
    +
    +

    The dictionary p should not be mutated during iteration. It is safe to +modify the values of the keys as you iterate over the dictionary, but only +so long as the set of keys does not change. For example:

    +
    PyObject *key, *value;
    +Py_ssize_t pos = 0;
    +
    +while (PyDict_Next(self->dict, &pos, &key, &value)) {
    +    long i = PyLong_AsLong(value);
    +    if (i == -1 && PyErr_Occurred()) {
    +        return -1;
    +    }
    +    PyObject *o = PyLong_FromLong(i + 1);
    +    if (o == NULL)
    +        return -1;
    +    if (PyDict_SetItem(self->dict, key, o) < 0) {
    +        Py_DECREF(o);
    +        return -1;
    +    }
    +    Py_DECREF(o);
    +}
    +
    +
    +
    + +
    +
    +int PyDict_Merge(PyObject *a, PyObject *b, int override)
    +

    Iterate over mapping object b adding key-value pairs to dictionary a. +b may be a dictionary, or any object supporting PyMapping_Keys() +and PyObject_GetItem(). If override is true, existing pairs in a +will be replaced if a matching key is found in b, otherwise pairs will +only be added if there is not a matching key in a. Return 0 on +success or -1 if an exception was raised.

    +
    + +
    +
    +int PyDict_Update(PyObject *a, PyObject *b)
    +

    This is the same as PyDict_Merge(a, b, 1) in C, and is similar to +a.update(b) in Python except that PyDict_Update() doesn’t fall +back to the iterating over a sequence of key value pairs if the second +argument has no “keys” attribute. Return 0 on success or -1 if an +exception was raised.

    +
    + +
    +
    +int PyDict_MergeFromSeq2(PyObject *a, PyObject *seq2, int override)
    +

    Update or merge into dictionary a, from the key-value pairs in seq2. +seq2 must be an iterable object producing iterable objects of length 2, +viewed as key-value pairs. In case of duplicate keys, the last wins if +override is true, else the first wins. Return 0 on success or -1 +if an exception was raised. Equivalent Python (except for the return +value):

    +
    def PyDict_MergeFromSeq2(a, seq2, override):
    +    for key, value in seq2:
    +        if override or key not in a:
    +            a[key] = value
    +
    +
    +
    + +
    +
    +int PyDict_ClearFreeList()
    +

    Clear the free list. Return the total number of freed items.

    +
    +

    New in version 3.3.

    +
    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/exceptions.html b/python-3.7.4-docs-html/c-api/exceptions.html new file mode 100644 index 0000000..5d87fa5 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/exceptions.html @@ -0,0 +1,1364 @@ + + + + + + + Exception Handling — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Exception Handling

    +

    The functions described in this chapter will let you handle and raise Python +exceptions. It is important to understand some of the basics of Python +exception handling. It works somewhat like the POSIX errno variable: +there is a global indicator (per thread) of the last error that occurred. Most +C API functions don’t clear this on success, but will set it to indicate the +cause of the error on failure. Most C API functions also return an error +indicator, usually NULL if they are supposed to return a pointer, or -1 +if they return an integer (exception: the PyArg_*() functions +return 1 for success and 0 for failure).

    +

    Concretely, the error indicator consists of three object pointers: the +exception’s type, the exception’s value, and the traceback object. Any +of those pointers can be NULL if non-set (although some combinations are +forbidden, for example you can’t have a non-NULL traceback if the exception +type is NULL).

    +

    When a function must fail because some function it called failed, it generally +doesn’t set the error indicator; the function it called already set it. It is +responsible for either handling the error and clearing the exception or +returning after cleaning up any resources it holds (such as object references or +memory allocations); it should not continue normally if it is not prepared to +handle the error. If returning due to an error, it is important to indicate to +the caller that an error has been set. If the error is not handled or carefully +propagated, additional calls into the Python/C API may not behave as intended +and may fail in mysterious ways.

    +
    +

    Note

    +

    The error indicator is not the result of sys.exc_info(). +The former corresponds to an exception that is not yet caught (and is +therefore still propagating), while the latter returns an exception after +it is caught (and has therefore stopped propagating).

    +
    +
    +

    Printing and clearing

    +
    +
    +void PyErr_Clear()
    +

    Clear the error indicator. If the error indicator is not set, there is no +effect.

    +
    + +
    +
    +void PyErr_PrintEx(int set_sys_last_vars)
    +

    Print a standard traceback to sys.stderr and clear the error indicator. +Unless the error is a SystemExit. In that case the no traceback +is printed and Python process will exit with the error code specified by +the SystemExit instance.

    +

    Call this function only when the error indicator is set. Otherwise it +will cause a fatal error!

    +

    If set_sys_last_vars is nonzero, the variables sys.last_type, +sys.last_value and sys.last_traceback will be set to the +type, value and traceback of the printed exception, respectively.

    +
    + +
    +
    +void PyErr_Print()
    +

    Alias for PyErr_PrintEx(1).

    +
    + +
    +
    +void PyErr_WriteUnraisable(PyObject *obj)
    +

    This utility function prints a warning message to sys.stderr when an +exception has been set but it is impossible for the interpreter to actually +raise the exception. It is used, for example, when an exception occurs in an +__del__() method.

    +

    The function is called with a single argument obj that identifies the context +in which the unraisable exception occurred. If possible, +the repr of obj will be printed in the warning message.

    +

    An exception must be set when calling this function.

    +
    + +
    +
    +

    Raising exceptions

    +

    These functions help you set the current thread’s error indicator. +For convenience, some of these functions will always return a +NULL pointer for use in a return statement.

    +
    +
    +void PyErr_SetString(PyObject *type, const char *message)
    +

    This is the most common way to set the error indicator. The first argument +specifies the exception type; it is normally one of the standard exceptions, +e.g. PyExc_RuntimeError. You need not increment its reference count. +The second argument is an error message; it is decoded from 'utf-8’.

    +
    + +
    +
    +void PyErr_SetObject(PyObject *type, PyObject *value)
    +

    This function is similar to PyErr_SetString() but lets you specify an +arbitrary Python object for the “value” of the exception.

    +
    + +
    +
    +PyObject* PyErr_Format(PyObject *exception, const char *format, ...)
    +
    Return value: Always NULL.

    This function sets the error indicator and returns NULL. exception +should be a Python exception class. The format and subsequent +parameters help format the error message; they have the same meaning and +values as in PyUnicode_FromFormat(). format is an ASCII-encoded +string.

    +
    + +
    +
    +PyObject* PyErr_FormatV(PyObject *exception, const char *format, va_list vargs)
    +
    Return value: Always NULL.

    Same as PyErr_Format(), but taking a va_list argument rather +than a variable number of arguments.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +void PyErr_SetNone(PyObject *type)
    +

    This is a shorthand for PyErr_SetObject(type, Py_None).

    +
    + +
    +
    +int PyErr_BadArgument()
    +

    This is a shorthand for PyErr_SetString(PyExc_TypeError, message), where +message indicates that a built-in operation was invoked with an illegal +argument. It is mostly for internal use.

    +
    + +
    +
    +PyObject* PyErr_NoMemory()
    +
    Return value: Always NULL.

    This is a shorthand for PyErr_SetNone(PyExc_MemoryError); it returns NULL +so an object allocation function can write return PyErr_NoMemory(); when it +runs out of memory.

    +
    + +
    +
    +PyObject* PyErr_SetFromErrno(PyObject *type)
    +
    Return value: Always NULL.

    This is a convenience function to raise an exception when a C library function +has returned an error and set the C variable errno. It constructs a +tuple object whose first item is the integer errno value and whose +second item is the corresponding error message (gotten from strerror()), +and then calls PyErr_SetObject(type, object). On Unix, when the +errno value is EINTR, indicating an interrupted system call, +this calls PyErr_CheckSignals(), and if that set the error indicator, +leaves it set to that. The function always returns NULL, so a wrapper +function around a system call can write return PyErr_SetFromErrno(type); +when the system call returns an error.

    +
    + +
    +
    +PyObject* PyErr_SetFromErrnoWithFilenameObject(PyObject *type, PyObject *filenameObject)
    +
    Return value: Always NULL.

    Similar to PyErr_SetFromErrno(), with the additional behavior that if +filenameObject is not NULL, it is passed to the constructor of type as +a third parameter. In the case of OSError exception, +this is used to define the filename attribute of the +exception instance.

    +
    + +
    +
    +PyObject* PyErr_SetFromErrnoWithFilenameObjects(PyObject *type, PyObject *filenameObject, PyObject *filenameObject2)
    +
    Return value: Always NULL.

    Similar to PyErr_SetFromErrnoWithFilenameObject(), but takes a second +filename object, for raising errors when a function that takes two filenames +fails.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +PyObject* PyErr_SetFromErrnoWithFilename(PyObject *type, const char *filename)
    +
    Return value: Always NULL.

    Similar to PyErr_SetFromErrnoWithFilenameObject(), but the filename +is given as a C string. filename is decoded from the filesystem encoding +(os.fsdecode()).

    +
    + +
    +
    +PyObject* PyErr_SetFromWindowsErr(int ierr)
    +
    Return value: Always NULL.

    This is a convenience function to raise WindowsError. If called with +ierr of 0, the error code returned by a call to GetLastError() +is used instead. It calls the Win32 function FormatMessage() to retrieve +the Windows description of error code given by ierr or GetLastError(), +then it constructs a tuple object whose first item is the ierr value and whose +second item is the corresponding error message (gotten from +FormatMessage()), and then calls PyErr_SetObject(PyExc_WindowsError, +object). This function always returns NULL.

    +

    Availability: Windows.

    +
    + +
    +
    +PyObject* PyErr_SetExcFromWindowsErr(PyObject *type, int ierr)
    +
    Return value: Always NULL.

    Similar to PyErr_SetFromWindowsErr(), with an additional parameter +specifying the exception type to be raised.

    +

    Availability: Windows.

    +
    + +
    +
    +PyObject* PyErr_SetFromWindowsErrWithFilename(int ierr, const char *filename)
    +
    Return value: Always NULL.

    Similar to PyErr_SetFromWindowsErrWithFilenameObject(), but the +filename is given as a C string. filename is decoded from the filesystem +encoding (os.fsdecode()).

    +

    Availability: Windows.

    +
    + +
    +
    +PyObject* PyErr_SetExcFromWindowsErrWithFilenameObject(PyObject *type, int ierr, PyObject *filename)
    +
    Return value: Always NULL.

    Similar to PyErr_SetFromWindowsErrWithFilenameObject(), with an +additional parameter specifying the exception type to be raised.

    +

    Availability: Windows.

    +
    + +
    +
    +PyObject* PyErr_SetExcFromWindowsErrWithFilenameObjects(PyObject *type, int ierr, PyObject *filename, PyObject *filename2)
    +
    Return value: Always NULL.

    Similar to PyErr_SetExcFromWindowsErrWithFilenameObject(), +but accepts a second filename object.

    +

    Availability: Windows.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +PyObject* PyErr_SetExcFromWindowsErrWithFilename(PyObject *type, int ierr, const char *filename)
    +
    Return value: Always NULL.

    Similar to PyErr_SetFromWindowsErrWithFilename(), with an additional +parameter specifying the exception type to be raised.

    +

    Availability: Windows.

    +
    + +
    +
    +PyObject* PyErr_SetImportError(PyObject *msg, PyObject *name, PyObject *path)
    +
    Return value: Always NULL.

    This is a convenience function to raise ImportError. msg will be +set as the exception’s message string. name and path, both of which can +be NULL, will be set as the ImportError’s respective name +and path attributes.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +void PyErr_SyntaxLocationObject(PyObject *filename, int lineno, int col_offset)
    +

    Set file, line, and offset information for the current exception. If the +current exception is not a SyntaxError, then it sets additional +attributes, which make the exception printing subsystem think the exception +is a SyntaxError.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +void PyErr_SyntaxLocationEx(const char *filename, int lineno, int col_offset)
    +

    Like PyErr_SyntaxLocationObject(), but filename is a byte string +decoded from the filesystem encoding (os.fsdecode()).

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +void PyErr_SyntaxLocation(const char *filename, int lineno)
    +

    Like PyErr_SyntaxLocationEx(), but the col_offset parameter is +omitted.

    +
    + +
    +
    +void PyErr_BadInternalCall()
    +

    This is a shorthand for PyErr_SetString(PyExc_SystemError, message), +where message indicates that an internal operation (e.g. a Python/C API +function) was invoked with an illegal argument. It is mostly for internal +use.

    +
    + +
    +
    +

    Issuing warnings

    +

    Use these functions to issue warnings from C code. They mirror similar +functions exported by the Python warnings module. They normally +print a warning message to sys.stderr; however, it is +also possible that the user has specified that warnings are to be turned into +errors, and in that case they will raise an exception. It is also possible that +the functions raise an exception because of a problem with the warning machinery. +The return value is 0 if no exception is raised, or -1 if an exception +is raised. (It is not possible to determine whether a warning message is +actually printed, nor what the reason is for the exception; this is +intentional.) If an exception is raised, the caller should do its normal +exception handling (for example, Py_DECREF() owned references and return +an error value).

    +
    +
    +int PyErr_WarnEx(PyObject *category, const char *message, Py_ssize_t stack_level)
    +

    Issue a warning message. The category argument is a warning category (see +below) or NULL; the message argument is a UTF-8 encoded string. stack_level is a +positive number giving a number of stack frames; the warning will be issued from +the currently executing line of code in that stack frame. A stack_level of 1 +is the function calling PyErr_WarnEx(), 2 is the function above that, +and so forth.

    +

    Warning categories must be subclasses of PyExc_Warning; +PyExc_Warning is a subclass of PyExc_Exception; +the default warning category is PyExc_RuntimeWarning. The standard +Python warning categories are available as global variables whose names are +enumerated at Standard Warning Categories.

    +

    For information about warning control, see the documentation for the +warnings module and the -W option in the command line +documentation. There is no C API for warning control.

    +
    + +
    +
    +PyObject* PyErr_SetImportErrorSubclass(PyObject *exception, PyObject *msg, PyObject *name, PyObject *path)
    +
    Return value: Always NULL.

    Much like PyErr_SetImportError() but this function allows for +specifying a subclass of ImportError to raise.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +int PyErr_WarnExplicitObject(PyObject *category, PyObject *message, PyObject *filename, int lineno, PyObject *module, PyObject *registry)
    +

    Issue a warning message with explicit control over all warning attributes. This +is a straightforward wrapper around the Python function +warnings.warn_explicit(), see there for more information. The module +and registry arguments may be set to NULL to get the default effect +described there.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +int PyErr_WarnExplicit(PyObject *category, const char *message, const char *filename, int lineno, const char *module, PyObject *registry)
    +

    Similar to PyErr_WarnExplicitObject() except that message and +module are UTF-8 encoded strings, and filename is decoded from the +filesystem encoding (os.fsdecode()).

    +
    + +
    +
    +int PyErr_WarnFormat(PyObject *category, Py_ssize_t stack_level, const char *format, ...)
    +

    Function similar to PyErr_WarnEx(), but use +PyUnicode_FromFormat() to format the warning message. format is +an ASCII-encoded string.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +int PyErr_ResourceWarning(PyObject *source, Py_ssize_t stack_level, const char *format, ...)
    +

    Function similar to PyErr_WarnFormat(), but category is +ResourceWarning and pass source to warnings.WarningMessage().

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +

    Querying the error indicator

    +
    +
    +PyObject* PyErr_Occurred()
    +
    Return value: Borrowed reference.

    Test whether the error indicator is set. If set, return the exception type +(the first argument to the last call to one of the PyErr_Set*() +functions or to PyErr_Restore()). If not set, return NULL. You do not +own a reference to the return value, so you do not need to Py_DECREF() +it.

    +
    +

    Note

    +

    Do not compare the return value to a specific exception; use +PyErr_ExceptionMatches() instead, shown below. (The comparison could +easily fail since the exception may be an instance instead of a class, in the +case of a class exception, or it may be a subclass of the expected exception.)

    +
    +
    + +
    +
    +int PyErr_ExceptionMatches(PyObject *exc)
    +

    Equivalent to PyErr_GivenExceptionMatches(PyErr_Occurred(), exc). This +should only be called when an exception is actually set; a memory access +violation will occur if no exception has been raised.

    +
    + +
    +
    +int PyErr_GivenExceptionMatches(PyObject *given, PyObject *exc)
    +

    Return true if the given exception matches the exception type in exc. If +exc is a class object, this also returns true when given is an instance +of a subclass. If exc is a tuple, all exception types in the tuple (and +recursively in subtuples) are searched for a match.

    +
    + +
    +
    +void PyErr_Fetch(PyObject **ptype, PyObject **pvalue, PyObject **ptraceback)
    +

    Retrieve the error indicator into three variables whose addresses are passed. +If the error indicator is not set, set all three variables to NULL. If it is +set, it will be cleared and you own a reference to each object retrieved. The +value and traceback object may be NULL even when the type object is not.

    +
    +

    Note

    +

    This function is normally only used by code that needs to catch exceptions or +by code that needs to save and restore the error indicator temporarily, e.g.:

    +
    {
    +   PyObject *type, *value, *traceback;
    +   PyErr_Fetch(&type, &value, &traceback);
    +
    +   /* ... code that might produce other errors ... */
    +
    +   PyErr_Restore(type, value, traceback);
    +}
    +
    +
    +
    +
    + +
    +
    +void PyErr_Restore(PyObject *type, PyObject *value, PyObject *traceback)
    +

    Set the error indicator from the three objects. If the error indicator is +already set, it is cleared first. If the objects are NULL, the error +indicator is cleared. Do not pass a NULL type and non-NULL value or +traceback. The exception type should be a class. Do not pass an invalid +exception type or value. (Violating these rules will cause subtle problems +later.) This call takes away a reference to each object: you must own a +reference to each object before the call and after the call you no longer own +these references. (If you don’t understand this, don’t use this function. I +warned you.)

    +
    +

    Note

    +

    This function is normally only used by code that needs to save and restore the +error indicator temporarily. Use PyErr_Fetch() to save the current +error indicator.

    +
    +
    + +
    +
    +void PyErr_NormalizeException(PyObject**exc, PyObject**val, PyObject**tb)
    +

    Under certain circumstances, the values returned by PyErr_Fetch() below +can be “unnormalized”, meaning that *exc is a class object but *val is +not an instance of the same class. This function can be used to instantiate +the class in that case. If the values are already normalized, nothing happens. +The delayed normalization is implemented to improve performance.

    +
    +

    Note

    +

    This function does not implicitly set the __traceback__ +attribute on the exception value. If setting the traceback +appropriately is desired, the following additional snippet is needed:

    +
    if (tb != NULL) {
    +  PyException_SetTraceback(val, tb);
    +}
    +
    +
    +
    +
    + +
    +
    +void PyErr_GetExcInfo(PyObject **ptype, PyObject **pvalue, PyObject **ptraceback)
    +

    Retrieve the exception info, as known from sys.exc_info(). This refers +to an exception that was already caught, not to an exception that was +freshly raised. Returns new references for the three objects, any of which +may be NULL. Does not modify the exception info state.

    +
    +

    Note

    +

    This function is not normally used by code that wants to handle exceptions. +Rather, it can be used when code needs to save and restore the exception +state temporarily. Use PyErr_SetExcInfo() to restore or clear the +exception state.

    +
    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +void PyErr_SetExcInfo(PyObject *type, PyObject *value, PyObject *traceback)
    +

    Set the exception info, as known from sys.exc_info(). This refers +to an exception that was already caught, not to an exception that was +freshly raised. This function steals the references of the arguments. +To clear the exception state, pass NULL for all three arguments. +For general rules about the three arguments, see PyErr_Restore().

    +
    +

    Note

    +

    This function is not normally used by code that wants to handle exceptions. +Rather, it can be used when code needs to save and restore the exception +state temporarily. Use PyErr_GetExcInfo() to read the exception +state.

    +
    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +

    Signal Handling

    +
    +
    +int PyErr_CheckSignals()
    +

    This function interacts with Python’s signal handling. It checks whether a +signal has been sent to the processes and if so, invokes the corresponding +signal handler. If the signal module is supported, this can invoke a +signal handler written in Python. In all cases, the default effect for +SIGINT is to raise the KeyboardInterrupt exception. If an +exception is raised the error indicator is set and the function returns -1; +otherwise the function returns 0. The error indicator may or may not be +cleared if it was previously set.

    +
    + +
    +
    +void PyErr_SetInterrupt()
    +

    Simulate the effect of a SIGINT signal arriving. The next time +PyErr_CheckSignals() is called, the Python signal handler for +SIGINT will be called.

    +

    If SIGINT isn’t handled by Python (it was set to +signal.SIG_DFL or signal.SIG_IGN), this function does +nothing.

    +
    + +
    +
    +int PySignal_SetWakeupFd(int fd)
    +

    This utility function specifies a file descriptor to which the signal number +is written as a single byte whenever a signal is received. fd must be +non-blocking. It returns the previous such file descriptor.

    +

    The value -1 disables the feature; this is the initial state. +This is equivalent to signal.set_wakeup_fd() in Python, but without any +error checking. fd should be a valid file descriptor. The function should +only be called from the main thread.

    +
    +

    Changed in version 3.5: On Windows, the function now also supports socket handles.

    +
    +
    + +
    +
    +

    Exception Classes

    +
    +
    +PyObject* PyErr_NewException(const char *name, PyObject *base, PyObject *dict)
    +
    Return value: New reference.

    This utility function creates and returns a new exception class. The name +argument must be the name of the new exception, a C string of the form +module.classname. The base and dict arguments are normally NULL. +This creates a class object derived from Exception (accessible in C as +PyExc_Exception).

    +

    The __module__ attribute of the new class is set to the first part (up +to the last dot) of the name argument, and the class name is set to the last +part (after the last dot). The base argument can be used to specify alternate +base classes; it can either be only one class or a tuple of classes. The dict +argument can be used to specify a dictionary of class variables and methods.

    +
    + +
    +
    +PyObject* PyErr_NewExceptionWithDoc(const char *name, const char *doc, PyObject *base, PyObject *dict)
    +
    Return value: New reference.

    Same as PyErr_NewException(), except that the new exception class can +easily be given a docstring: If doc is non-NULL, it will be used as the +docstring for the exception class.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +

    Exception Objects

    +
    +
    +PyObject* PyException_GetTraceback(PyObject *ex)
    +
    Return value: New reference.

    Return the traceback associated with the exception as a new reference, as +accessible from Python through __traceback__. If there is no +traceback associated, this returns NULL.

    +
    + +
    +
    +int PyException_SetTraceback(PyObject *ex, PyObject *tb)
    +

    Set the traceback associated with the exception to tb. Use Py_None to +clear it.

    +
    + +
    +
    +PyObject* PyException_GetContext(PyObject *ex)
    +
    Return value: New reference.

    Return the context (another exception instance during whose handling ex was +raised) associated with the exception as a new reference, as accessible from +Python through __context__. If there is no context associated, this +returns NULL.

    +
    + +
    +
    +void PyException_SetContext(PyObject *ex, PyObject *ctx)
    +

    Set the context associated with the exception to ctx. Use NULL to clear +it. There is no type check to make sure that ctx is an exception instance. +This steals a reference to ctx.

    +
    + +
    +
    +PyObject* PyException_GetCause(PyObject *ex)
    +
    Return value: New reference.

    Return the cause (either an exception instance, or None, +set by raise ... from ...) associated with the exception as a new +reference, as accessible from Python through __cause__.

    +
    + +
    +
    +void PyException_SetCause(PyObject *ex, PyObject *cause)
    +

    Set the cause associated with the exception to cause. Use NULL to clear +it. There is no type check to make sure that cause is either an exception +instance or None. This steals a reference to cause.

    +

    __suppress_context__ is implicitly set to True by this function.

    +
    + +
    +
    +

    Unicode Exception Objects

    +

    The following functions are used to create and modify Unicode exceptions from C.

    +
    +
    +PyObject* PyUnicodeDecodeError_Create(const char *encoding, const char *object, Py_ssize_t length, Py_ssize_t start, Py_ssize_t end, const char *reason)
    +
    Return value: New reference.

    Create a UnicodeDecodeError object with the attributes encoding, +object, length, start, end and reason. encoding and reason are +UTF-8 encoded strings.

    +
    + +
    +
    +PyObject* PyUnicodeEncodeError_Create(const char *encoding, const Py_UNICODE *object, Py_ssize_t length, Py_ssize_t start, Py_ssize_t end, const char *reason)
    +
    Return value: New reference.

    Create a UnicodeEncodeError object with the attributes encoding, +object, length, start, end and reason. encoding and reason are +UTF-8 encoded strings.

    +
    + +
    +
    +PyObject* PyUnicodeTranslateError_Create(const Py_UNICODE *object, Py_ssize_t length, Py_ssize_t start, Py_ssize_t end, const char *reason)
    +
    Return value: New reference.

    Create a UnicodeTranslateError object with the attributes object, +length, start, end and reason. reason is a UTF-8 encoded string.

    +
    + +
    +
    +PyObject* PyUnicodeDecodeError_GetEncoding(PyObject *exc)
    +
    +PyObject* PyUnicodeEncodeError_GetEncoding(PyObject *exc)
    +
    Return value: New reference.

    Return the encoding attribute of the given exception object.

    +
    + +
    +
    +PyObject* PyUnicodeDecodeError_GetObject(PyObject *exc)
    +
    +PyObject* PyUnicodeEncodeError_GetObject(PyObject *exc)
    +
    +PyObject* PyUnicodeTranslateError_GetObject(PyObject *exc)
    +
    Return value: New reference.

    Return the object attribute of the given exception object.

    +
    + +
    +
    +int PyUnicodeDecodeError_GetStart(PyObject *exc, Py_ssize_t *start)
    +
    +int PyUnicodeEncodeError_GetStart(PyObject *exc, Py_ssize_t *start)
    +
    +int PyUnicodeTranslateError_GetStart(PyObject *exc, Py_ssize_t *start)
    +

    Get the start attribute of the given exception object and place it into +*start. start must not be NULL. Return 0 on success, -1 on +failure.

    +
    + +
    +
    +int PyUnicodeDecodeError_SetStart(PyObject *exc, Py_ssize_t start)
    +
    +int PyUnicodeEncodeError_SetStart(PyObject *exc, Py_ssize_t start)
    +
    +int PyUnicodeTranslateError_SetStart(PyObject *exc, Py_ssize_t start)
    +

    Set the start attribute of the given exception object to start. Return +0 on success, -1 on failure.

    +
    + +
    +
    +int PyUnicodeDecodeError_GetEnd(PyObject *exc, Py_ssize_t *end)
    +
    +int PyUnicodeEncodeError_GetEnd(PyObject *exc, Py_ssize_t *end)
    +
    +int PyUnicodeTranslateError_GetEnd(PyObject *exc, Py_ssize_t *end)
    +

    Get the end attribute of the given exception object and place it into +*end. end must not be NULL. Return 0 on success, -1 on +failure.

    +
    + +
    +
    +int PyUnicodeDecodeError_SetEnd(PyObject *exc, Py_ssize_t end)
    +
    +int PyUnicodeEncodeError_SetEnd(PyObject *exc, Py_ssize_t end)
    +
    +int PyUnicodeTranslateError_SetEnd(PyObject *exc, Py_ssize_t end)
    +

    Set the end attribute of the given exception object to end. Return 0 +on success, -1 on failure.

    +
    + +
    +
    +PyObject* PyUnicodeDecodeError_GetReason(PyObject *exc)
    +
    +PyObject* PyUnicodeEncodeError_GetReason(PyObject *exc)
    +
    +PyObject* PyUnicodeTranslateError_GetReason(PyObject *exc)
    +
    Return value: New reference.

    Return the reason attribute of the given exception object.

    +
    + +
    +
    +int PyUnicodeDecodeError_SetReason(PyObject *exc, const char *reason)
    +
    +int PyUnicodeEncodeError_SetReason(PyObject *exc, const char *reason)
    +
    +int PyUnicodeTranslateError_SetReason(PyObject *exc, const char *reason)
    +

    Set the reason attribute of the given exception object to reason. Return +0 on success, -1 on failure.

    +
    + +
    +
    +

    Recursion Control

    +

    These two functions provide a way to perform safe recursive calls at the C +level, both in the core and in extension modules. They are needed if the +recursive code does not necessarily invoke Python code (which tracks its +recursion depth automatically).

    +
    +
    +int Py_EnterRecursiveCall(const char *where)
    +

    Marks a point where a recursive C-level call is about to be performed.

    +

    If USE_STACKCHECK is defined, this function checks if the OS +stack overflowed using PyOS_CheckStack(). In this is the case, it +sets a MemoryError and returns a nonzero value.

    +

    The function then checks if the recursion limit is reached. If this is the +case, a RecursionError is set and a nonzero value is returned. +Otherwise, zero is returned.

    +

    where should be a string such as " in instance check" to be +concatenated to the RecursionError message caused by the recursion +depth limit.

    +
    + +
    +
    +void Py_LeaveRecursiveCall()
    +

    Ends a Py_EnterRecursiveCall(). Must be called once for each +successful invocation of Py_EnterRecursiveCall().

    +
    + +

    Properly implementing tp_repr for container types requires +special recursion handling. In addition to protecting the stack, +tp_repr also needs to track objects to prevent cycles. The +following two functions facilitate this functionality. Effectively, +these are the C equivalent to reprlib.recursive_repr().

    +
    +
    +int Py_ReprEnter(PyObject *object)
    +

    Called at the beginning of the tp_repr implementation to +detect cycles.

    +

    If the object has already been processed, the function returns a +positive integer. In that case the tp_repr implementation +should return a string object indicating a cycle. As examples, +dict objects return {...} and list objects +return [...].

    +

    The function will return a negative integer if the recursion limit +is reached. In that case the tp_repr implementation should +typically return NULL.

    +

    Otherwise, the function returns zero and the tp_repr +implementation can continue normally.

    +
    + +
    +
    +void Py_ReprLeave(PyObject *object)
    +

    Ends a Py_ReprEnter(). Must be called once for each +invocation of Py_ReprEnter() that returns zero.

    +
    + +
    +
    +

    Standard Exceptions

    +

    All standard Python exceptions are available as global variables whose names are +PyExc_ followed by the Python exception name. These have the type +PyObject*; they are all class objects. For completeness, here are all +the variables:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    C Name

    Python Name

    Notes

    PyExc_BaseException

    BaseException

    (1)

    PyExc_Exception

    Exception

    (1)

    PyExc_ArithmeticError

    ArithmeticError

    (1)

    PyExc_AssertionError

    AssertionError

    PyExc_AttributeError

    AttributeError

    PyExc_BlockingIOError

    BlockingIOError

    PyExc_BrokenPipeError

    BrokenPipeError

    PyExc_BufferError

    BufferError

    PyExc_ChildProcessError

    ChildProcessError

    PyExc_ConnectionAbortedError

    ConnectionAbortedError

    PyExc_ConnectionError

    ConnectionError

    PyExc_ConnectionRefusedError

    ConnectionRefusedError

    PyExc_ConnectionResetError

    ConnectionResetError

    PyExc_EOFError

    EOFError

    PyExc_FileExistsError

    FileExistsError

    PyExc_FileNotFoundError

    FileNotFoundError

    PyExc_FloatingPointError

    FloatingPointError

    PyExc_GeneratorExit

    GeneratorExit

    PyExc_ImportError

    ImportError

    PyExc_IndentationError

    IndentationError

    PyExc_IndexError

    IndexError

    PyExc_InterruptedError

    InterruptedError

    PyExc_IsADirectoryError

    IsADirectoryError

    PyExc_KeyError

    KeyError

    PyExc_KeyboardInterrupt

    KeyboardInterrupt

    PyExc_LookupError

    LookupError

    (1)

    PyExc_MemoryError

    MemoryError

    PyExc_ModuleNotFoundError

    ModuleNotFoundError

    PyExc_NameError

    NameError

    PyExc_NotADirectoryError

    NotADirectoryError

    PyExc_NotImplementedError

    NotImplementedError

    PyExc_OSError

    OSError

    (1)

    PyExc_OverflowError

    OverflowError

    PyExc_PermissionError

    PermissionError

    PyExc_ProcessLookupError

    ProcessLookupError

    PyExc_RecursionError

    RecursionError

    PyExc_ReferenceError

    ReferenceError

    (2)

    PyExc_RuntimeError

    RuntimeError

    PyExc_StopAsyncIteration

    StopAsyncIteration

    PyExc_StopIteration

    StopIteration

    PyExc_SyntaxError

    SyntaxError

    PyExc_SystemError

    SystemError

    PyExc_SystemExit

    SystemExit

    PyExc_TabError

    TabError

    PyExc_TimeoutError

    TimeoutError

    PyExc_TypeError

    TypeError

    PyExc_UnboundLocalError

    UnboundLocalError

    PyExc_UnicodeDecodeError

    UnicodeDecodeError

    PyExc_UnicodeEncodeError

    UnicodeEncodeError

    PyExc_UnicodeError

    UnicodeError

    PyExc_UnicodeTranslateError

    UnicodeTranslateError

    PyExc_ValueError

    ValueError

    PyExc_ZeroDivisionError

    ZeroDivisionError

    +
    +

    New in version 3.3: PyExc_BlockingIOError, PyExc_BrokenPipeError, +PyExc_ChildProcessError, PyExc_ConnectionError, +PyExc_ConnectionAbortedError, PyExc_ConnectionRefusedError, +PyExc_ConnectionResetError, PyExc_FileExistsError, +PyExc_FileNotFoundError, PyExc_InterruptedError, +PyExc_IsADirectoryError, PyExc_NotADirectoryError, +PyExc_PermissionError, PyExc_ProcessLookupError +and PyExc_TimeoutError were introduced following PEP 3151.

    +
    +
    +

    New in version 3.5: PyExc_StopAsyncIteration and PyExc_RecursionError.

    +
    +
    +

    New in version 3.6: PyExc_ModuleNotFoundError.

    +
    +

    These are compatibility aliases to PyExc_OSError:

    + ++++ + + + + + + + + + + + + + + + + +

    C Name

    Notes

    PyExc_EnvironmentError

    PyExc_IOError

    PyExc_WindowsError

    (3)

    +
    +

    Changed in version 3.3: These aliases used to be separate exception types.

    +
    +

    Notes:

    +
      +
    1. This is a base class for other standard exceptions.

    2. +
    3. This is the same as weakref.ReferenceError.

    4. +
    5. Only defined on Windows; protect code that uses this by testing that the +preprocessor macro MS_WINDOWS is defined.

    6. +
    +
    +
    +

    Standard Warning Categories

    +

    All standard Python warning categories are available as global variables whose +names are PyExc_ followed by the Python exception name. These have the type +PyObject*; they are all class objects. For completeness, here are all +the variables:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    C Name

    Python Name

    Notes

    PyExc_Warning

    Warning

    (1)

    PyExc_BytesWarning

    BytesWarning

    PyExc_DeprecationWarning

    DeprecationWarning

    PyExc_FutureWarning

    FutureWarning

    PyExc_ImportWarning

    ImportWarning

    PyExc_PendingDeprecationWarning

    PendingDeprecationWarning

    PyExc_ResourceWarning

    ResourceWarning

    PyExc_RuntimeWarning

    RuntimeWarning

    PyExc_SyntaxWarning

    SyntaxWarning

    PyExc_UnicodeWarning

    UnicodeWarning

    PyExc_UserWarning

    UserWarning

    +
    +

    New in version 3.2: PyExc_ResourceWarning.

    +
    +

    Notes:

    +
      +
    1. This is a base class for other standard warning categories.

    2. +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/file.html b/python-3.7.4-docs-html/c-api/file.html new file mode 100644 index 0000000..110581e --- /dev/null +++ b/python-3.7.4-docs-html/c-api/file.html @@ -0,0 +1,251 @@ + + + + + + + File Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    File Objects

    +

    These APIs are a minimal emulation of the Python 2 C API for built-in file +objects, which used to rely on the buffered I/O (FILE*) support +from the C standard library. In Python 3, files and streams use the new +io module, which defines several layers over the low-level unbuffered +I/O of the operating system. The functions described below are +convenience C wrappers over these new APIs, and meant mostly for internal +error reporting in the interpreter; third-party code is advised to access +the io APIs instead.

    +
    +
    +PyFile_FromFd(int fd, const char *name, const char *mode, int buffering, const char *encoding, const char *errors, const char *newline, int closefd)
    +
    Return value: New reference.

    Create a Python file object from the file descriptor of an already +opened file fd. The arguments name, encoding, errors and newline +can be NULL to use the defaults; buffering can be -1 to use the +default. name is ignored and kept for backward compatibility. Return +NULL on failure. For a more comprehensive description of the arguments, +please refer to the io.open() function documentation.

    +
    +

    Warning

    +

    Since Python streams have their own buffering layer, mixing them with +OS-level file descriptors can produce various issues (such as unexpected +ordering of data).

    +
    +
    +

    Changed in version 3.2: Ignore name attribute.

    +
    +
    + +
    +
    +int PyObject_AsFileDescriptor(PyObject *p)
    +

    Return the file descriptor associated with p as an int. If the +object is an integer, its value is returned. If not, the +object’s fileno() method is called if it exists; the +method must return an integer, which is returned as the file descriptor +value. Sets an exception and returns -1 on failure.

    +
    + +
    +
    +PyObject* PyFile_GetLine(PyObject *p, int n)
    +
    Return value: New reference.

    Equivalent to p.readline([n]), this function reads one line from the +object p. p may be a file object or any object with a +readline() +method. If n is 0, exactly one line is read, regardless of the length of +the line. If n is greater than 0, no more than n bytes will be read +from the file; a partial line can be returned. In both cases, an empty string +is returned if the end of the file is reached immediately. If n is less than +0, however, one line is read regardless of length, but EOFError is +raised if the end of the file is reached immediately.

    +
    + +
    +
    +int PyFile_WriteObject(PyObject *obj, PyObject *p, int flags)
    +

    Write object obj to file object p. The only supported flag for flags is +Py_PRINT_RAW; if given, the str() of the object is written +instead of the repr(). Return 0 on success or -1 on failure; the +appropriate exception will be set.

    +
    + +
    +
    +int PyFile_WriteString(const char *s, PyObject *p)
    +

    Write string s to file object p. Return 0 on success or -1 on +failure; the appropriate exception will be set.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/float.html b/python-3.7.4-docs-html/c-api/float.html new file mode 100644 index 0000000..f7087c6 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/float.html @@ -0,0 +1,267 @@ + + + + + + + Floating Point Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Floating Point Objects

    +
    +
    +PyFloatObject
    +

    This subtype of PyObject represents a Python floating point object.

    +
    + +
    +
    +PyTypeObject PyFloat_Type
    +

    This instance of PyTypeObject represents the Python floating point +type. This is the same object as float in the Python layer.

    +
    + +
    +
    +int PyFloat_Check(PyObject *p)
    +

    Return true if its argument is a PyFloatObject or a subtype of +PyFloatObject.

    +
    + +
    +
    +int PyFloat_CheckExact(PyObject *p)
    +

    Return true if its argument is a PyFloatObject, but not a subtype of +PyFloatObject.

    +
    + +
    +
    +PyObject* PyFloat_FromString(PyObject *str)
    +
    Return value: New reference.

    Create a PyFloatObject object based on the string value in str, or +NULL on failure.

    +
    + +
    +
    +PyObject* PyFloat_FromDouble(double v)
    +
    Return value: New reference.

    Create a PyFloatObject object from v, or NULL on failure.

    +
    + +
    +
    +double PyFloat_AsDouble(PyObject *pyfloat)
    +

    Return a C double representation of the contents of pyfloat. If +pyfloat is not a Python floating point object but has a __float__() +method, this method will first be called to convert pyfloat into a float. +This method returns -1.0 upon failure, so one should call +PyErr_Occurred() to check for errors.

    +
    + +
    +
    +double PyFloat_AS_DOUBLE(PyObject *pyfloat)
    +

    Return a C double representation of the contents of pyfloat, but +without error checking.

    +
    + +
    +
    +PyObject* PyFloat_GetInfo(void)
    +
    Return value: New reference.

    Return a structseq instance which contains information about the +precision, minimum and maximum values of a float. It’s a thin wrapper +around the header file float.h.

    +
    + +
    +
    +double PyFloat_GetMax()
    +

    Return the maximum representable finite float DBL_MAX as C double.

    +
    + +
    +
    +double PyFloat_GetMin()
    +

    Return the minimum normalized positive float DBL_MIN as C double.

    +
    + +
    +
    +int PyFloat_ClearFreeList()
    +

    Clear the float free list. Return the number of items that could not +be freed.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/function.html b/python-3.7.4-docs-html/c-api/function.html new file mode 100644 index 0000000..ea7d3b4 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/function.html @@ -0,0 +1,291 @@ + + + + + + + Function Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Function Objects

    +

    There are a few functions specific to Python functions.

    +
    +
    +PyFunctionObject
    +

    The C structure used for functions.

    +
    + +
    +
    +PyTypeObject PyFunction_Type
    +

    This is an instance of PyTypeObject and represents the Python function +type. It is exposed to Python programmers as types.FunctionType.

    +
    + +
    +
    +int PyFunction_Check(PyObject *o)
    +

    Return true if o is a function object (has type PyFunction_Type). +The parameter must not be NULL.

    +
    + +
    +
    +PyObject* PyFunction_New(PyObject *code, PyObject *globals)
    +
    Return value: New reference.

    Return a new function object associated with the code object code. globals +must be a dictionary with the global variables accessible to the function.

    +

    The function’s docstring and name are retrieved from the code object. __module__ +is retrieved from globals. The argument defaults, annotations and closure are +set to NULL. __qualname__ is set to the same value as the function’s name.

    +
    + +
    +
    +PyObject* PyFunction_NewWithQualName(PyObject *code, PyObject *globals, PyObject *qualname)
    +
    Return value: New reference.

    As PyFunction_New(), but also allows setting the function object’s +__qualname__ attribute. qualname should be a unicode object or NULL; +if NULL, the __qualname__ attribute is set to the same value as its +__name__ attribute.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +PyObject* PyFunction_GetCode(PyObject *op)
    +
    Return value: Borrowed reference.

    Return the code object associated with the function object op.

    +
    + +
    +
    +PyObject* PyFunction_GetGlobals(PyObject *op)
    +
    Return value: Borrowed reference.

    Return the globals dictionary associated with the function object op.

    +
    + +
    +
    +PyObject* PyFunction_GetModule(PyObject *op)
    +
    Return value: Borrowed reference.

    Return the __module__ attribute of the function object op. This is normally +a string containing the module name, but can be set to any other object by +Python code.

    +
    + +
    +
    +PyObject* PyFunction_GetDefaults(PyObject *op)
    +
    Return value: Borrowed reference.

    Return the argument default values of the function object op. This can be a +tuple of arguments or NULL.

    +
    + +
    +
    +int PyFunction_SetDefaults(PyObject *op, PyObject *defaults)
    +

    Set the argument default values for the function object op. defaults must be +Py_None or a tuple.

    +

    Raises SystemError and returns -1 on failure.

    +
    + +
    +
    +PyObject* PyFunction_GetClosure(PyObject *op)
    +
    Return value: Borrowed reference.

    Return the closure associated with the function object op. This can be NULL +or a tuple of cell objects.

    +
    + +
    +
    +int PyFunction_SetClosure(PyObject *op, PyObject *closure)
    +

    Set the closure associated with the function object op. closure must be +Py_None or a tuple of cell objects.

    +

    Raises SystemError and returns -1 on failure.

    +
    + +
    +
    +PyObject *PyFunction_GetAnnotations(PyObject *op)
    +
    Return value: Borrowed reference.

    Return the annotations of the function object op. This can be a +mutable dictionary or NULL.

    +
    + +
    +
    +int PyFunction_SetAnnotations(PyObject *op, PyObject *annotations)
    +

    Set the annotations for the function object op. annotations +must be a dictionary or Py_None.

    +

    Raises SystemError and returns -1 on failure.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/gcsupport.html b/python-3.7.4-docs-html/c-api/gcsupport.html new file mode 100644 index 0000000..ca09d74 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/gcsupport.html @@ -0,0 +1,341 @@ + + + + + + + Supporting Cyclic Garbage Collection — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Supporting Cyclic Garbage Collection

    +

    Python’s support for detecting and collecting garbage which involves circular +references requires support from object types which are “containers” for other +objects which may also be containers. Types which do not store references to +other objects, or which only store references to atomic types (such as numbers +or strings), do not need to provide any explicit support for garbage +collection.

    +

    To create a container type, the tp_flags field of the type object must +include the Py_TPFLAGS_HAVE_GC and provide an implementation of the +tp_traverse handler. If instances of the type are mutable, a +tp_clear implementation must also be provided.

    +
    +
    +Py_TPFLAGS_HAVE_GC
    +

    Objects with a type with this flag set must conform with the rules +documented here. For convenience these objects will be referred to as +container objects.

    +
    + +

    Constructors for container types must conform to two rules:

    +
      +
    1. The memory for the object must be allocated using PyObject_GC_New() +or PyObject_GC_NewVar().

    2. +
    3. Once all the fields which may contain references to other containers are +initialized, it must call PyObject_GC_Track().

    4. +
    +
    +
    +TYPE* PyObject_GC_New(TYPE, PyTypeObject *type)
    +

    Analogous to PyObject_New() but for container objects with the +Py_TPFLAGS_HAVE_GC flag set.

    +
    + +
    +
    +TYPE* PyObject_GC_NewVar(TYPE, PyTypeObject *type, Py_ssize_t size)
    +

    Analogous to PyObject_NewVar() but for container objects with the +Py_TPFLAGS_HAVE_GC flag set.

    +
    + +
    +
    +TYPE* PyObject_GC_Resize(TYPE, PyVarObject *op, Py_ssize_t newsize)
    +

    Resize an object allocated by PyObject_NewVar(). Returns the +resized object or NULL on failure. op must not be tracked by the collector yet.

    +
    + +
    +
    +void PyObject_GC_Track(PyObject *op)
    +

    Adds the object op to the set of container objects tracked by the +collector. The collector can run at unexpected times so objects must be +valid while being tracked. This should be called once all the fields +followed by the tp_traverse handler become valid, usually near the +end of the constructor.

    +
    + +
    +
    +void _PyObject_GC_TRACK(PyObject *op)
    +

    A macro version of PyObject_GC_Track(). It should not be used for +extension modules.

    +
    +

    Deprecated since version 3.6: This macro is removed from Python 3.8.

    +
    +
    + +

    Similarly, the deallocator for the object must conform to a similar pair of +rules:

    +
      +
    1. Before fields which refer to other containers are invalidated, +PyObject_GC_UnTrack() must be called.

    2. +
    3. The object’s memory must be deallocated using PyObject_GC_Del().

    4. +
    +
    +
    +void PyObject_GC_Del(void *op)
    +

    Releases memory allocated to an object using PyObject_GC_New() or +PyObject_GC_NewVar().

    +
    + +
    +
    +void PyObject_GC_UnTrack(void *op)
    +

    Remove the object op from the set of container objects tracked by the +collector. Note that PyObject_GC_Track() can be called again on +this object to add it back to the set of tracked objects. The deallocator +(tp_dealloc handler) should call this for the object before any of +the fields used by the tp_traverse handler become invalid.

    +
    + +
    +
    +void _PyObject_GC_UNTRACK(PyObject *op)
    +

    A macro version of PyObject_GC_UnTrack(). It should not be used for +extension modules.

    +
    +

    Deprecated since version 3.6: This macro is removed from Python 3.8.

    +
    +
    + +

    The tp_traverse handler accepts a function parameter of this type:

    +
    +
    +int (*visitproc)(PyObject *object, void *arg)
    +

    Type of the visitor function passed to the tp_traverse handler. +The function should be called with an object to traverse as object and +the third parameter to the tp_traverse handler as arg. The +Python core uses several visitor functions to implement cyclic garbage +detection; it’s not expected that users will need to write their own +visitor functions.

    +
    + +

    The tp_traverse handler must have the following type:

    +
    +
    +int (*traverseproc)(PyObject *self, visitproc visit, void *arg)
    +

    Traversal function for a container object. Implementations must call the +visit function for each object directly contained by self, with the +parameters to visit being the contained object and the arg value passed +to the handler. The visit function must not be called with a NULL +object argument. If visit returns a non-zero value that value should be +returned immediately.

    +
    + +

    To simplify writing tp_traverse handlers, a Py_VISIT() macro is +provided. In order to use this macro, the tp_traverse implementation +must name its arguments exactly visit and arg:

    +
    +
    +void Py_VISIT(PyObject *o)
    +

    If o is not NULL, call the visit callback, with arguments o +and arg. If visit returns a non-zero value, then return it. +Using this macro, tp_traverse handlers +look like:

    +
    static int
    +my_traverse(Noddy *self, visitproc visit, void *arg)
    +{
    +    Py_VISIT(self->foo);
    +    Py_VISIT(self->bar);
    +    return 0;
    +}
    +
    +
    +
    + +

    The tp_clear handler must be of the inquiry type, or NULL +if the object is immutable.

    +
    +
    +int (*inquiry)(PyObject *self)
    +

    Drop references that may have created reference cycles. Immutable objects +do not have to define this method since they can never directly create +reference cycles. Note that the object must still be valid after calling +this method (don’t just call Py_DECREF() on a reference). The +collector will call this method if it detects that this object is involved +in a reference cycle.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/gen.html b/python-3.7.4-docs-html/c-api/gen.html new file mode 100644 index 0000000..f2873c3 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/gen.html @@ -0,0 +1,227 @@ + + + + + + + Generator Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Generator Objects

    +

    Generator objects are what Python uses to implement generator iterators. They +are normally created by iterating over a function that yields values, rather +than explicitly calling PyGen_New() or PyGen_NewWithQualName().

    +
    +
    +PyGenObject
    +

    The C structure used for generator objects.

    +
    + +
    +
    +PyTypeObject PyGen_Type
    +

    The type object corresponding to generator objects.

    +
    + +
    +
    +int PyGen_Check(PyObject *ob)
    +

    Return true if ob is a generator object; ob must not be NULL.

    +
    + +
    +
    +int PyGen_CheckExact(PyObject *ob)
    +

    Return true if ob’s type is PyGen_Type; ob must not be NULL.

    +
    + +
    +
    +PyObject* PyGen_New(PyFrameObject *frame)
    +
    Return value: New reference.

    Create and return a new generator object based on the frame object. +A reference to frame is stolen by this function. The argument must not be +NULL.

    +
    + +
    +
    +PyObject* PyGen_NewWithQualName(PyFrameObject *frame, PyObject *name, PyObject *qualname)
    +
    Return value: New reference.

    Create and return a new generator object based on the frame object, +with __name__ and __qualname__ set to name and qualname. +A reference to frame is stolen by this function. The frame argument +must not be NULL.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/import.html b/python-3.7.4-docs-html/c-api/import.html new file mode 100644 index 0000000..36f4a75 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/import.html @@ -0,0 +1,514 @@ + + + + + + + Importing Modules — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Importing Modules

    +
    +
    +PyObject* PyImport_ImportModule(const char *name)
    +
    Return value: New reference.

    This is a simplified interface to PyImport_ImportModuleEx() below, +leaving the globals and locals arguments set to NULL and level set +to 0. When the name +argument contains a dot (when it specifies a submodule of a package), the +fromlist argument is set to the list ['*'] so that the return value is the +named module rather than the top-level package containing it as would otherwise +be the case. (Unfortunately, this has an additional side effect when name in +fact specifies a subpackage instead of a submodule: the submodules specified in +the package’s __all__ variable are loaded.) Return a new reference to the +imported module, or NULL with an exception set on failure. A failing +import of a module doesn’t leave the module in sys.modules.

    +

    This function always uses absolute imports.

    +
    + +
    +
    +PyObject* PyImport_ImportModuleNoBlock(const char *name)
    +
    Return value: New reference.

    This function is a deprecated alias of PyImport_ImportModule().

    +
    +

    Changed in version 3.3: This function used to fail immediately when the import lock was held +by another thread. In Python 3.3 though, the locking scheme switched +to per-module locks for most purposes, so this function’s special +behaviour isn’t needed anymore.

    +
    +
    + +
    +
    +PyObject* PyImport_ImportModuleEx(const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist)
    +
    Return value: New reference.

    Import a module. This is best described by referring to the built-in Python +function __import__().

    +

    The return value is a new reference to the imported module or top-level +package, or NULL with an exception set on failure. Like for +__import__(), the return value when a submodule of a package was +requested is normally the top-level package, unless a non-empty fromlist +was given.

    +

    Failing imports remove incomplete module objects, like with +PyImport_ImportModule().

    +
    + +
    +
    +PyObject* PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)
    +
    Return value: New reference.

    Import a module. This is best described by referring to the built-in Python +function __import__(), as the standard __import__() function calls +this function directly.

    +

    The return value is a new reference to the imported module or top-level package, +or NULL with an exception set on failure. Like for __import__(), +the return value when a submodule of a package was requested is normally the +top-level package, unless a non-empty fromlist was given.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +PyObject* PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)
    +
    Return value: New reference.

    Similar to PyImport_ImportModuleLevelObject(), but the name is a +UTF-8 encoded string instead of a Unicode object.

    +
    +

    Changed in version 3.3: Negative values for level are no longer accepted.

    +
    +
    + +
    +
    +PyObject* PyImport_Import(PyObject *name)
    +
    Return value: New reference.

    This is a higher-level interface that calls the current “import hook +function” (with an explicit level of 0, meaning absolute import). It +invokes the __import__() function from the __builtins__ of the +current globals. This means that the import is done using whatever import +hooks are installed in the current environment.

    +

    This function always uses absolute imports.

    +
    + +
    +
    +PyObject* PyImport_ReloadModule(PyObject *m)
    +
    Return value: New reference.

    Reload a module. Return a new reference to the reloaded module, or NULL with +an exception set on failure (the module still exists in this case).

    +
    + +
    +
    +PyObject* PyImport_AddModuleObject(PyObject *name)
    +
    Return value: Borrowed reference.

    Return the module object corresponding to a module name. The name argument +may be of the form package.module. First check the modules dictionary if +there’s one there, and if not, create a new one and insert it in the modules +dictionary. Return NULL with an exception set on failure.

    +
    +

    Note

    +

    This function does not load or import the module; if the module wasn’t already +loaded, you will get an empty module object. Use PyImport_ImportModule() +or one of its variants to import a module. Package structures implied by a +dotted name for name are not created if not already present.

    +
    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +PyObject* PyImport_AddModule(const char *name)
    +
    Return value: Borrowed reference.

    Similar to PyImport_AddModuleObject(), but the name is a UTF-8 +encoded string instead of a Unicode object.

    +
    + +
    +
    +PyObject* PyImport_ExecCodeModule(const char *name, PyObject *co)
    +
    Return value: New reference.

    Given a module name (possibly of the form package.module) and a code object +read from a Python bytecode file or obtained from the built-in function +compile(), load the module. Return a new reference to the module object, +or NULL with an exception set if an error occurred. name +is removed from sys.modules in error cases, even if name was already +in sys.modules on entry to PyImport_ExecCodeModule(). Leaving +incompletely initialized modules in sys.modules is dangerous, as imports of +such modules have no way to know that the module object is an unknown (and +probably damaged with respect to the module author’s intents) state.

    +

    The module’s __spec__ and __loader__ will be set, if +not set already, with the appropriate values. The spec’s loader will +be set to the module’s __loader__ (if set) and to an instance of +SourceFileLoader otherwise.

    +

    The module’s __file__ attribute will be set to the code object’s +co_filename. If applicable, __cached__ will also +be set.

    +

    This function will reload the module if it was already imported. See +PyImport_ReloadModule() for the intended way to reload a module.

    +

    If name points to a dotted name of the form package.module, any package +structures not already created will still not be created.

    +

    See also PyImport_ExecCodeModuleEx() and +PyImport_ExecCodeModuleWithPathnames().

    +
    + +
    +
    +PyObject* PyImport_ExecCodeModuleEx(const char *name, PyObject *co, const char *pathname)
    +
    Return value: New reference.

    Like PyImport_ExecCodeModule(), but the __file__ attribute of +the module object is set to pathname if it is non-NULL.

    +

    See also PyImport_ExecCodeModuleWithPathnames().

    +
    + +
    +
    +PyObject* PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname, PyObject *cpathname)
    +
    Return value: New reference.

    Like PyImport_ExecCodeModuleEx(), but the __cached__ +attribute of the module object is set to cpathname if it is +non-NULL. Of the three functions, this is the preferred one to use.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +PyObject* PyImport_ExecCodeModuleWithPathnames(const char *name, PyObject *co, const char *pathname, const char *cpathname)
    +
    Return value: New reference.

    Like PyImport_ExecCodeModuleObject(), but name, pathname and +cpathname are UTF-8 encoded strings. Attempts are also made to figure out +what the value for pathname should be from cpathname if the former is +set to NULL.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.3: Uses imp.source_from_cache() in calculating the source path if +only the bytecode path is provided.

    +
    +
    + +
    +
    +long PyImport_GetMagicNumber()
    +

    Return the magic number for Python bytecode files (a.k.a. .pyc file). +The magic number should be present in the first four bytes of the bytecode +file, in little-endian byte order. Returns -1 on error.

    +
    +

    Changed in version 3.3: Return value of -1 upon failure.

    +
    +
    + +
    +
    +const char * PyImport_GetMagicTag()
    +

    Return the magic tag string for PEP 3147 format Python bytecode file +names. Keep in mind that the value at sys.implementation.cache_tag is +authoritative and should be used instead of this function.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +PyObject* PyImport_GetModuleDict()
    +
    Return value: Borrowed reference.

    Return the dictionary used for the module administration (a.k.a. +sys.modules). Note that this is a per-interpreter variable.

    +
    + +
    +
    +PyObject* PyImport_GetModule(PyObject *name)
    +
    Return value: New reference.

    Return the already imported module with the given name. If the +module has not been imported yet then returns NULL but does not set +an error. Returns NULL and sets an error if the lookup failed.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +PyObject* PyImport_GetImporter(PyObject *path)
    +
    Return value: New reference.

    Return a finder object for a sys.path/pkg.__path__ item +path, possibly by fetching it from the sys.path_importer_cache +dict. If it wasn’t yet cached, traverse sys.path_hooks until a hook +is found that can handle the path item. Return None if no hook could; +this tells our caller that the path based finder could not find a +finder for this path item. Cache the result in sys.path_importer_cache. +Return a new reference to the finder object.

    +
    + +
    +
    +void _PyImport_Init()
    +

    Initialize the import mechanism. For internal use only.

    +
    + +
    +
    +void PyImport_Cleanup()
    +

    Empty the module table. For internal use only.

    +
    + +
    +
    +void _PyImport_Fini()
    +

    Finalize the import mechanism. For internal use only.

    +
    + +
    +
    +int PyImport_ImportFrozenModuleObject(PyObject *name)
    +
    Return value: New reference.

    Load a frozen module named name. Return 1 for success, 0 if the +module is not found, and -1 with an exception set if the initialization +failed. To access the imported module on a successful load, use +PyImport_ImportModule(). (Note the misnomer — this function would +reload the module if it was already imported.)

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.4: The __file__ attribute is no longer set on the module.

    +
    +
    + +
    +
    +int PyImport_ImportFrozenModule(const char *name)
    +

    Similar to PyImport_ImportFrozenModuleObject(), but the name is a +UTF-8 encoded string instead of a Unicode object.

    +
    + +
    +
    +struct _frozen
    +

    This is the structure type definition for frozen module descriptors, as +generated by the freeze utility (see Tools/freeze/ in the +Python source distribution). Its definition, found in Include/import.h, +is:

    +
    struct _frozen {
    +    const char *name;
    +    const unsigned char *code;
    +    int size;
    +};
    +
    +
    +
    + +
    +
    +const struct _frozen* PyImport_FrozenModules
    +

    This pointer is initialized to point to an array of struct _frozen +records, terminated by one whose members are all NULL or zero. When a frozen +module is imported, it is searched in this table. Third-party code could play +tricks with this to provide a dynamically created collection of frozen modules.

    +
    + +
    +
    +int PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
    +

    Add a single module to the existing table of built-in modules. This is a +convenience wrapper around PyImport_ExtendInittab(), returning -1 if +the table could not be extended. The new module can be imported by the name +name, and uses the function initfunc as the initialization function called +on the first attempted import. This should be called before +Py_Initialize().

    +
    + +
    +
    +struct _inittab
    +

    Structure describing a single entry in the list of built-in modules. Each of +these structures gives the name and initialization function for a module built +into the interpreter. The name is an ASCII encoded string. Programs which +embed Python may use an array of these structures in conjunction with +PyImport_ExtendInittab() to provide additional built-in modules. +The structure is defined in Include/import.h as:

    +
    struct _inittab {
    +    const char *name;           /* ASCII encoded string */
    +    PyObject* (*initfunc)(void);
    +};
    +
    +
    +
    + +
    +
    +int PyImport_ExtendInittab(struct _inittab *newtab)
    +

    Add a collection of modules to the table of built-in modules. The newtab +array must end with a sentinel entry which contains NULL for the name +field; failure to provide the sentinel value can result in a memory fault. +Returns 0 on success or -1 if insufficient memory could be allocated to +extend the internal table. In the event of failure, no modules are added to the +internal table. This should be called before Py_Initialize().

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/index.html b/python-3.7.4-docs-html/c-api/index.html new file mode 100644 index 0000000..9c4096e --- /dev/null +++ b/python-3.7.4-docs-html/c-api/index.html @@ -0,0 +1,283 @@ + + + + + + + Python/C API Reference Manual — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Python/C API Reference Manual

    +

    This manual documents the API used by C and C++ programmers who want to write +extension modules or embed Python. It is a companion to Extending and Embedding the Python Interpreter, +which describes the general principles of extension writing but does not +document the API functions in detail.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/init.html b/python-3.7.4-docs-html/c-api/init.html new file mode 100644 index 0000000..efa06d9 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/init.html @@ -0,0 +1,1737 @@ + + + + + + + Initialization, Finalization, and Threads — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Initialization, Finalization, and Threads

    +
    +

    Before Python Initialization

    +

    In an application embedding Python, the Py_Initialize() function must +be called before using any other Python/C API functions; with the exception of +a few functions and the global configuration variables.

    +

    The following functions can be safely called before Python is initialized:

    + + +
    +
    +

    Global configuration variables

    +

    Python has variables for the global configuration to control different features +and options. By default, these flags are controlled by command line +options.

    +

    When a flag is set by an option, the value of the flag is the number of times +that the option was set. For example, -b sets Py_BytesWarningFlag +to 1 and -bb sets Py_BytesWarningFlag to 2.

    +
    +
    +Py_BytesWarningFlag
    +

    Issue a warning when comparing bytes or bytearray with +str or bytes with int. Issue an error if greater +or equal to 2.

    +

    Set by the -b option.

    +
    + +
    +
    +Py_DebugFlag
    +

    Turn on parser debugging output (for expert only, depending on compilation +options).

    +

    Set by the -d option and the PYTHONDEBUG environment +variable.

    +
    + +
    +
    +Py_DontWriteBytecodeFlag
    +

    If set to non-zero, Python won’t try to write .pyc files on the +import of source modules.

    +

    Set by the -B option and the PYTHONDONTWRITEBYTECODE +environment variable.

    +
    + +
    +
    +Py_FrozenFlag
    +

    Suppress error messages when calculating the module search path in +Py_GetPath().

    +

    Private flag used by _freeze_importlib and frozenmain programs.

    +
    + +
    +
    +Py_HashRandomizationFlag
    +

    Set to 1 if the PYTHONHASHSEED environment variable is set to +a non-empty string.

    +

    If the flag is non-zero, read the PYTHONHASHSEED environment +variable to initialize the secret hash seed.

    +
    + +
    +
    +Py_IgnoreEnvironmentFlag
    +

    Ignore all PYTHON* environment variables, e.g. +PYTHONPATH and PYTHONHOME, that might be set.

    +

    Set by the -E and -I options.

    +
    + +
    +
    +Py_InspectFlag
    +

    When a script is passed as first argument or the -c option is used, +enter interactive mode after executing the script or the command, even when +sys.stdin does not appear to be a terminal.

    +

    Set by the -i option and the PYTHONINSPECT environment +variable.

    +
    + +
    +
    +Py_InteractiveFlag
    +

    Set by the -i option.

    +
    + +
    +
    +Py_IsolatedFlag
    +

    Run Python in isolated mode. In isolated mode sys.path contains +neither the script’s directory nor the user’s site-packages directory.

    +

    Set by the -I option.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +Py_LegacyWindowsFSEncodingFlag
    +

    If the flag is non-zero, use the mbcs encoding instead of the UTF-8 +encoding for the filesystem encoding.

    +

    Set to 1 if the PYTHONLEGACYWINDOWSFSENCODING environment +variable is set to a non-empty string.

    +

    See PEP 529 for more details.

    +

    Availability: Windows.

    +
    + +
    +
    +Py_LegacyWindowsStdioFlag
    +

    If the flag is non-zero, use io.FileIO instead of +WindowsConsoleIO for sys standard streams.

    +

    Set to 1 if the PYTHONLEGACYWINDOWSSTDIO environment +variable is set to a non-empty string.

    +

    See PEP 528 for more details.

    +

    Availability: Windows.

    +
    + +
    +
    +Py_NoSiteFlag
    +

    Disable the import of the module site and the site-dependent +manipulations of sys.path that it entails. Also disable these +manipulations if site is explicitly imported later (call +site.main() if you want them to be triggered).

    +

    Set by the -S option.

    +
    + +
    +
    +Py_NoUserSiteDirectory
    +

    Don’t add the user site-packages directory to +sys.path.

    +

    Set by the -s and -I options, and the +PYTHONNOUSERSITE environment variable.

    +
    + +
    +
    +Py_OptimizeFlag
    +

    Set by the -O option and the PYTHONOPTIMIZE environment +variable.

    +
    + +
    +
    +Py_QuietFlag
    +

    Don’t display the copyright and version messages even in interactive mode.

    +

    Set by the -q option.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +Py_UnbufferedStdioFlag
    +

    Force the stdout and stderr streams to be unbuffered.

    +

    Set by the -u option and the PYTHONUNBUFFERED +environment variable.

    +
    + +
    +
    +Py_VerboseFlag
    +

    Print a message each time a module is initialized, showing the place +(filename or built-in module) from which it is loaded. If greater or equal +to 2, print a message for each file that is checked for when +searching for a module. Also provides information on module cleanup at exit.

    +

    Set by the -v option and the PYTHONVERBOSE environment +variable.

    +
    + +
    +
    +

    Initializing and finalizing the interpreter

    +
    +
    +void Py_Initialize()
    +

    Initialize the Python interpreter. In an application embedding Python, +this should be called before using any other Python/C API functions; see +Before Python Initialization for the few exceptions.

    +

    This initializes +the table of loaded modules (sys.modules), and creates the fundamental +modules builtins, __main__ and sys. It also initializes +the module search path (sys.path). It does not set sys.argv; use +PySys_SetArgvEx() for that. This is a no-op when called for a second time +(without calling Py_FinalizeEx() first). There is no return value; it is a +fatal error if the initialization fails.

    +
    +

    Note

    +

    On Windows, changes the console mode from O_TEXT to O_BINARY, which will +also affect non-Python uses of the console using the C Runtime.

    +
    +
    + +
    +
    +void Py_InitializeEx(int initsigs)
    +

    This function works like Py_Initialize() if initsigs is 1. If +initsigs is 0, it skips initialization registration of signal handlers, which +might be useful when Python is embedded.

    +
    + +
    +
    +int Py_IsInitialized()
    +

    Return true (nonzero) when the Python interpreter has been initialized, false +(zero) if not. After Py_FinalizeEx() is called, this returns false until +Py_Initialize() is called again.

    +
    + +
    +
    +int Py_FinalizeEx()
    +

    Undo all initializations made by Py_Initialize() and subsequent use of +Python/C API functions, and destroy all sub-interpreters (see +Py_NewInterpreter() below) that were created and not yet destroyed since +the last call to Py_Initialize(). Ideally, this frees all memory +allocated by the Python interpreter. This is a no-op when called for a second +time (without calling Py_Initialize() again first). Normally the +return value is 0. If there were errors during finalization +(flushing buffered data), -1 is returned.

    +

    This function is provided for a number of reasons. An embedding application +might want to restart Python without having to restart the application itself. +An application that has loaded the Python interpreter from a dynamically +loadable library (or DLL) might want to free all memory allocated by Python +before unloading the DLL. During a hunt for memory leaks in an application a +developer might want to free all memory allocated by Python before exiting from +the application.

    +

    Bugs and caveats: The destruction of modules and objects in modules is done +in random order; this may cause destructors (__del__() methods) to fail +when they depend on other objects (even functions) or modules. Dynamically +loaded extension modules loaded by Python are not unloaded. Small amounts of +memory allocated by the Python interpreter may not be freed (if you find a leak, +please report it). Memory tied up in circular references between objects is not +freed. Some memory allocated by extension modules may not be freed. Some +extensions may not work properly if their initialization routine is called more +than once; this can happen if an application calls Py_Initialize() and +Py_FinalizeEx() more than once.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +void Py_Finalize()
    +

    This is a backwards-compatible version of Py_FinalizeEx() that +disregards the return value.

    +
    + +
    +
    +

    Process-wide parameters

    +
    +
    +int Py_SetStandardStreamEncoding(const char *encoding, const char *errors)
    +

    This function should be called before Py_Initialize(), if it is +called at all. It specifies which encoding and error handling to use +with standard IO, with the same meanings as in str.encode().

    +

    It overrides PYTHONIOENCODING values, and allows embedding code +to control IO encoding when the environment variable does not work.

    +

    encoding and/or errors may be NULL to use +PYTHONIOENCODING and/or default values (depending on other +settings).

    +

    Note that sys.stderr always uses the “backslashreplace” error +handler, regardless of this (or any other) setting.

    +

    If Py_FinalizeEx() is called, this function will need to be called +again in order to affect subsequent calls to Py_Initialize().

    +

    Returns 0 if successful, a nonzero value on error (e.g. calling after the +interpreter has already been initialized).

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +void Py_SetProgramName(const wchar_t *name)
    +

    This function should be called before Py_Initialize() is called for +the first time, if it is called at all. It tells the interpreter the value +of the argv[0] argument to the main() function of the program +(converted to wide characters). +This is used by Py_GetPath() and some other functions below to find +the Python run-time libraries relative to the interpreter executable. The +default value is 'python'. The argument should point to a +zero-terminated wide character string in static storage whose contents will not +change for the duration of the program’s execution. No code in the Python +interpreter will change the contents of this storage.

    +

    Use Py_DecodeLocale() to decode a bytes string to get a +wchar_* string.

    +
    + +
    +
    +wchar* Py_GetProgramName()
    +

    Return the program name set with Py_SetProgramName(), or the default. +The returned string points into static storage; the caller should not modify its +value.

    +
    + +
    +
    +wchar_t* Py_GetPrefix()
    +

    Return the prefix for installed platform-independent files. This is derived +through a number of complicated rules from the program name set with +Py_SetProgramName() and some environment variables; for example, if the +program name is '/usr/local/bin/python', the prefix is '/usr/local'. The +returned string points into static storage; the caller should not modify its +value. This corresponds to the prefix variable in the top-level +Makefile and the --prefix argument to the configure +script at build time. The value is available to Python code as sys.prefix. +It is only useful on Unix. See also the next function.

    +
    + +
    +
    +wchar_t* Py_GetExecPrefix()
    +

    Return the exec-prefix for installed platform-dependent files. This is +derived through a number of complicated rules from the program name set with +Py_SetProgramName() and some environment variables; for example, if the +program name is '/usr/local/bin/python', the exec-prefix is +'/usr/local'. The returned string points into static storage; the caller +should not modify its value. This corresponds to the exec_prefix +variable in the top-level Makefile and the --exec-prefix +argument to the configure script at build time. The value is +available to Python code as sys.exec_prefix. It is only useful on Unix.

    +

    Background: The exec-prefix differs from the prefix when platform dependent +files (such as executables and shared libraries) are installed in a different +directory tree. In a typical installation, platform dependent files may be +installed in the /usr/local/plat subtree while platform independent may +be installed in /usr/local.

    +

    Generally speaking, a platform is a combination of hardware and software +families, e.g. Sparc machines running the Solaris 2.x operating system are +considered the same platform, but Intel machines running Solaris 2.x are another +platform, and Intel machines running Linux are yet another platform. Different +major revisions of the same operating system generally also form different +platforms. Non-Unix operating systems are a different story; the installation +strategies on those systems are so different that the prefix and exec-prefix are +meaningless, and set to the empty string. Note that compiled Python bytecode +files are platform independent (but not independent from the Python version by +which they were compiled!).

    +

    System administrators will know how to configure the mount or +automount programs to share /usr/local between platforms +while having /usr/local/plat be a different filesystem for each +platform.

    +
    + +
    +
    +wchar_t* Py_GetProgramFullPath()
    +

    Return the full program name of the Python executable; this is computed as a +side-effect of deriving the default module search path from the program name +(set by Py_SetProgramName() above). The returned string points into +static storage; the caller should not modify its value. The value is available +to Python code as sys.executable.

    +
    + +
    +
    +wchar_t* Py_GetPath()
    +

    Return the default module search path; this is computed from the program name +(set by Py_SetProgramName() above) and some environment variables. +The returned string consists of a series of directory names separated by a +platform dependent delimiter character. The delimiter character is ':' +on Unix and Mac OS X, ';' on Windows. The returned string points into +static storage; the caller should not modify its value. The list +sys.path is initialized with this value on interpreter startup; it +can be (and usually is) modified later to change the search path for loading +modules.

    +
    + +
    +
    +void Py_SetPath(const wchar_t *)
    +

    Set the default module search path. If this function is called before +Py_Initialize(), then Py_GetPath() won’t attempt to compute a +default search path but uses the one provided instead. This is useful if +Python is embedded by an application that has full knowledge of the location +of all modules. The path components should be separated by the platform +dependent delimiter character, which is ':' on Unix and Mac OS X, ';' +on Windows.

    +

    This also causes sys.executable to be set only to the raw program +name (see Py_SetProgramName()) and for sys.prefix and +sys.exec_prefix to be empty. It is up to the caller to modify these +if required after calling Py_Initialize().

    +

    Use Py_DecodeLocale() to decode a bytes string to get a +wchar_* string.

    +

    The path argument is copied internally, so the caller may free it after the +call completes.

    +
    + +
    +
    +const char* Py_GetVersion()
    +

    Return the version of this Python interpreter. This is a string that looks +something like

    +
    "3.0a5+ (py3k:63103M, May 12 2008, 00:53:55) \n[GCC 4.2.3]"
    +
    +
    +

    The first word (up to the first space character) is the current Python version; +the first three characters are the major and minor version separated by a +period. The returned string points into static storage; the caller should not +modify its value. The value is available to Python code as sys.version.

    +
    + +
    +
    +const char* Py_GetPlatform()
    +

    Return the platform identifier for the current platform. On Unix, this is +formed from the “official” name of the operating system, converted to lower +case, followed by the major revision number; e.g., for Solaris 2.x, which is +also known as SunOS 5.x, the value is 'sunos5'. On Mac OS X, it is +'darwin'. On Windows, it is 'win'. The returned string points into +static storage; the caller should not modify its value. The value is available +to Python code as sys.platform.

    +
    + +
    +
    +const char* Py_GetCopyright()
    +

    Return the official copyright string for the current Python version, for example

    +

    'Copyright 1991-1995 Stichting Mathematisch Centrum, Amsterdam'

    +

    The returned string points into static storage; the caller should not modify its +value. The value is available to Python code as sys.copyright.

    +
    + +
    +
    +const char* Py_GetCompiler()
    +

    Return an indication of the compiler used to build the current Python version, +in square brackets, for example:

    +
    "[GCC 2.7.2.2]"
    +
    +
    +

    The returned string points into static storage; the caller should not modify its +value. The value is available to Python code as part of the variable +sys.version.

    +
    + +
    +
    +const char* Py_GetBuildInfo()
    +

    Return information about the sequence number and build date and time of the +current Python interpreter instance, for example

    +
    "#67, Aug  1 1997, 22:34:28"
    +
    +
    +

    The returned string points into static storage; the caller should not modify its +value. The value is available to Python code as part of the variable +sys.version.

    +
    + +
    +
    +void PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath)
    +

    Set sys.argv based on argc and argv. These parameters are +similar to those passed to the program’s main() function with the +difference that the first entry should refer to the script file to be +executed rather than the executable hosting the Python interpreter. If there +isn’t a script that will be run, the first entry in argv can be an empty +string. If this function fails to initialize sys.argv, a fatal +condition is signalled using Py_FatalError().

    +

    If updatepath is zero, this is all the function does. If updatepath +is non-zero, the function also modifies sys.path according to the +following algorithm:

    +
      +
    • If the name of an existing script is passed in argv[0], the absolute +path of the directory where the script is located is prepended to +sys.path.

    • +
    • Otherwise (that is, if argc is 0 or argv[0] doesn’t point +to an existing file name), an empty string is prepended to +sys.path, which is the same as prepending the current working +directory (".").

    • +
    +

    Use Py_DecodeLocale() to decode a bytes string to get a +wchar_* string.

    +
    +

    Note

    +

    It is recommended that applications embedding the Python interpreter +for purposes other than executing a single script pass 0 as updatepath, +and update sys.path themselves if desired. +See CVE-2008-5983.

    +

    On versions before 3.1.3, you can achieve the same effect by manually +popping the first sys.path element after having called +PySys_SetArgv(), for example using:

    +
    PyRun_SimpleString("import sys; sys.path.pop(0)\n");
    +
    +
    +
    +
    +

    New in version 3.1.3.

    +
    +
    + +
    +
    +void PySys_SetArgv(int argc, wchar_t **argv)
    +

    This function works like PySys_SetArgvEx() with updatepath set +to 1 unless the python interpreter was started with the +-I.

    +

    Use Py_DecodeLocale() to decode a bytes string to get a +wchar_* string.

    +
    +

    Changed in version 3.4: The updatepath value depends on -I.

    +
    +
    + +
    +
    +void Py_SetPythonHome(const wchar_t *home)
    +

    Set the default “home” directory, that is, the location of the standard +Python libraries. See PYTHONHOME for the meaning of the +argument string.

    +

    The argument should point to a zero-terminated character string in static +storage whose contents will not change for the duration of the program’s +execution. No code in the Python interpreter will change the contents of +this storage.

    +

    Use Py_DecodeLocale() to decode a bytes string to get a +wchar_* string.

    +
    + +
    +
    +w_char* Py_GetPythonHome()
    +

    Return the default “home”, that is, the value set by a previous call to +Py_SetPythonHome(), or the value of the PYTHONHOME +environment variable if it is set.

    +
    + +
    +
    +

    Thread State and the Global Interpreter Lock

    +

    The Python interpreter is not fully thread-safe. In order to support +multi-threaded Python programs, there’s a global lock, called the global +interpreter lock or GIL, that must be held by the current thread before +it can safely access Python objects. Without the lock, even the simplest +operations could cause problems in a multi-threaded program: for example, when +two threads simultaneously increment the reference count of the same object, the +reference count could end up being incremented only once instead of twice.

    +

    Therefore, the rule exists that only the thread that has acquired the +GIL may operate on Python objects or call Python/C API functions. +In order to emulate concurrency of execution, the interpreter regularly +tries to switch threads (see sys.setswitchinterval()). The lock is also +released around potentially blocking I/O operations like reading or writing +a file, so that other Python threads can run in the meantime.

    +

    The Python interpreter keeps some thread-specific bookkeeping information +inside a data structure called PyThreadState. There’s also one +global variable pointing to the current PyThreadState: it can +be retrieved using PyThreadState_Get().

    +
    +

    Releasing the GIL from extension code

    +

    Most extension code manipulating the GIL has the following simple +structure:

    +
    Save the thread state in a local variable.
    +Release the global interpreter lock.
    +... Do some blocking I/O operation ...
    +Reacquire the global interpreter lock.
    +Restore the thread state from the local variable.
    +
    +
    +

    This is so common that a pair of macros exists to simplify it:

    +
    Py_BEGIN_ALLOW_THREADS
    +... Do some blocking I/O operation ...
    +Py_END_ALLOW_THREADS
    +
    +
    +

    The Py_BEGIN_ALLOW_THREADS macro opens a new block and declares a +hidden local variable; the Py_END_ALLOW_THREADS macro closes the +block.

    +

    The block above expands to the following code:

    +
    PyThreadState *_save;
    +
    +_save = PyEval_SaveThread();
    +... Do some blocking I/O operation ...
    +PyEval_RestoreThread(_save);
    +
    +
    +

    Here is how these functions work: the global interpreter lock is used to protect the pointer to the +current thread state. When releasing the lock and saving the thread state, +the current thread state pointer must be retrieved before the lock is released +(since another thread could immediately acquire the lock and store its own thread +state in the global variable). Conversely, when acquiring the lock and restoring +the thread state, the lock must be acquired before storing the thread state +pointer.

    +
    +

    Note

    +

    Calling system I/O functions is the most common use case for releasing +the GIL, but it can also be useful before calling long-running computations +which don’t need access to Python objects, such as compression or +cryptographic functions operating over memory buffers. For example, the +standard zlib and hashlib modules release the GIL when +compressing or hashing data.

    +
    +
    +
    +

    Non-Python created threads

    +

    When threads are created using the dedicated Python APIs (such as the +threading module), a thread state is automatically associated to them +and the code showed above is therefore correct. However, when threads are +created from C (for example by a third-party library with its own thread +management), they don’t hold the GIL, nor is there a thread state structure +for them.

    +

    If you need to call Python code from these threads (often this will be part +of a callback API provided by the aforementioned third-party library), +you must first register these threads with the interpreter by +creating a thread state data structure, then acquiring the GIL, and finally +storing their thread state pointer, before you can start using the Python/C +API. When you are done, you should reset the thread state pointer, release +the GIL, and finally free the thread state data structure.

    +

    The PyGILState_Ensure() and PyGILState_Release() functions do +all of the above automatically. The typical idiom for calling into Python +from a C thread is:

    +
    PyGILState_STATE gstate;
    +gstate = PyGILState_Ensure();
    +
    +/* Perform Python actions here. */
    +result = CallSomeFunction();
    +/* evaluate result or handle exception */
    +
    +/* Release the thread. No Python API allowed beyond this point. */
    +PyGILState_Release(gstate);
    +
    +
    +

    Note that the PyGILState_*() functions assume there is only one global +interpreter (created automatically by Py_Initialize()). Python +supports the creation of additional interpreters (using +Py_NewInterpreter()), but mixing multiple interpreters and the +PyGILState_*() API is unsupported.

    +

    Another important thing to note about threads is their behaviour in the face +of the C fork() call. On most systems with fork(), after a +process forks only the thread that issued the fork will exist. That also +means any locks held by other threads will never be released. Python solves +this for os.fork() by acquiring the locks it uses internally before +the fork, and releasing them afterwards. In addition, it resets any +Lock Objects in the child. When extending or embedding Python, there +is no way to inform Python of additional (non-Python) locks that need to be +acquired before or reset after a fork. OS facilities such as +pthread_atfork() would need to be used to accomplish the same thing. +Additionally, when extending or embedding Python, calling fork() +directly rather than through os.fork() (and returning to or calling +into Python) may result in a deadlock by one of Python’s internal locks +being held by a thread that is defunct after the fork. +PyOS_AfterFork_Child() tries to reset the necessary locks, but is not +always able to.

    +
    +
    +

    High-level API

    +

    These are the most commonly used types and functions when writing C extension +code, or when embedding the Python interpreter:

    +
    +
    +PyInterpreterState
    +

    This data structure represents the state shared by a number of cooperating +threads. Threads belonging to the same interpreter share their module +administration and a few other internal items. There are no public members in +this structure.

    +

    Threads belonging to different interpreters initially share nothing, except +process state like available memory, open file descriptors and such. The global +interpreter lock is also shared by all threads, regardless of to which +interpreter they belong.

    +
    + +
    +
    +PyThreadState
    +

    This data structure represents the state of a single thread. The only public +data member is PyInterpreterState *interp, which points to +this thread’s interpreter state.

    +
    + +
    +
    +void PyEval_InitThreads()
    +

    Initialize and acquire the global interpreter lock. It should be called in the +main thread before creating a second thread or engaging in any other thread +operations such as PyEval_ReleaseThread(tstate). It is not needed before +calling PyEval_SaveThread() or PyEval_RestoreThread().

    +

    This is a no-op when called for a second time.

    +
    +

    Changed in version 3.7: This function is now called by Py_Initialize(), so you don’t +have to call it yourself anymore.

    +
    +
    +

    Changed in version 3.2: This function cannot be called before Py_Initialize() anymore.

    +
    +
    + +
    +
    +int PyEval_ThreadsInitialized()
    +

    Returns a non-zero value if PyEval_InitThreads() has been called. This +function can be called without holding the GIL, and therefore can be used to +avoid calls to the locking API when running single-threaded.

    +
    +

    Changed in version 3.7: The GIL is now initialized by Py_Initialize().

    +
    +
    + +
    +
    +PyThreadState* PyEval_SaveThread()
    +

    Release the global interpreter lock (if it has been created and thread +support is enabled) and reset the thread state to NULL, returning the +previous thread state (which is not NULL). If the lock has been created, +the current thread must have acquired it.

    +
    + +
    +
    +void PyEval_RestoreThread(PyThreadState *tstate)
    +

    Acquire the global interpreter lock (if it has been created and thread +support is enabled) and set the thread state to tstate, which must not be +NULL. If the lock has been created, the current thread must not have +acquired it, otherwise deadlock ensues.

    +
    +

    Note

    +

    Calling this function from a thread when the runtime is finalizing +will terminate the thread, even if the thread was not created by Python. +You can use _Py_IsFinalizing() or sys.is_finalizing() to +check if the interpreter is in process of being finalized before calling +this function to avoid unwanted termination.

    +
    +
    + +
    +
    +PyThreadState* PyThreadState_Get()
    +

    Return the current thread state. The global interpreter lock must be held. +When the current thread state is NULL, this issues a fatal error (so that +the caller needn’t check for NULL).

    +
    + +
    +
    +PyThreadState* PyThreadState_Swap(PyThreadState *tstate)
    +

    Swap the current thread state with the thread state given by the argument +tstate, which may be NULL. The global interpreter lock must be held +and is not released.

    +
    + +
    +
    +void PyEval_ReInitThreads()
    +

    This function is called from PyOS_AfterFork_Child() to ensure +that newly created child processes don’t hold locks referring to threads +which are not running in the child process.

    +
    + +

    The following functions use thread-local storage, and are not compatible +with sub-interpreters:

    +
    +
    +PyGILState_STATE PyGILState_Ensure()
    +

    Ensure that the current thread is ready to call the Python C API regardless +of the current state of Python, or of the global interpreter lock. This may +be called as many times as desired by a thread as long as each call is +matched with a call to PyGILState_Release(). In general, other +thread-related APIs may be used between PyGILState_Ensure() and +PyGILState_Release() calls as long as the thread state is restored to +its previous state before the Release(). For example, normal usage of the +Py_BEGIN_ALLOW_THREADS and Py_END_ALLOW_THREADS macros is +acceptable.

    +

    The return value is an opaque “handle” to the thread state when +PyGILState_Ensure() was called, and must be passed to +PyGILState_Release() to ensure Python is left in the same state. Even +though recursive calls are allowed, these handles cannot be shared - each +unique call to PyGILState_Ensure() must save the handle for its call +to PyGILState_Release().

    +

    When the function returns, the current thread will hold the GIL and be able +to call arbitrary Python code. Failure is a fatal error.

    +
    +

    Note

    +

    Calling this function from a thread when the runtime is finalizing +will terminate the thread, even if the thread was not created by Python. +You can use _Py_IsFinalizing() or sys.is_finalizing() to +check if the interpreter is in process of being finalized before calling +this function to avoid unwanted termination.

    +
    +
    + +
    +
    +void PyGILState_Release(PyGILState_STATE)
    +

    Release any resources previously acquired. After this call, Python’s state will +be the same as it was prior to the corresponding PyGILState_Ensure() call +(but generally this state will be unknown to the caller, hence the use of the +GILState API).

    +

    Every call to PyGILState_Ensure() must be matched by a call to +PyGILState_Release() on the same thread.

    +
    + +
    +
    +PyThreadState* PyGILState_GetThisThreadState()
    +

    Get the current thread state for this thread. May return NULL if no +GILState API has been used on the current thread. Note that the main thread +always has such a thread-state, even if no auto-thread-state call has been +made on the main thread. This is mainly a helper/diagnostic function.

    +
    + +
    +
    +int PyGILState_Check()
    +

    Return 1 if the current thread is holding the GIL and 0 otherwise. +This function can be called from any thread at any time. +Only if it has had its Python thread state initialized and currently is +holding the GIL will it return 1. +This is mainly a helper/diagnostic function. It can be useful +for example in callback contexts or memory allocation functions when +knowing that the GIL is locked can allow the caller to perform sensitive +actions or otherwise behave differently.

    +
    +

    New in version 3.4.

    +
    +
    + +

    The following macros are normally used without a trailing semicolon; look for +example usage in the Python source distribution.

    +
    +
    +Py_BEGIN_ALLOW_THREADS
    +

    This macro expands to { PyThreadState *_save; _save = PyEval_SaveThread();. +Note that it contains an opening brace; it must be matched with a following +Py_END_ALLOW_THREADS macro. See above for further discussion of this +macro.

    +
    + +
    +
    +Py_END_ALLOW_THREADS
    +

    This macro expands to PyEval_RestoreThread(_save); }. Note that it contains +a closing brace; it must be matched with an earlier +Py_BEGIN_ALLOW_THREADS macro. See above for further discussion of +this macro.

    +
    + +
    +
    +Py_BLOCK_THREADS
    +

    This macro expands to PyEval_RestoreThread(_save);: it is equivalent to +Py_END_ALLOW_THREADS without the closing brace.

    +
    + +
    +
    +Py_UNBLOCK_THREADS
    +

    This macro expands to _save = PyEval_SaveThread();: it is equivalent to +Py_BEGIN_ALLOW_THREADS without the opening brace and variable +declaration.

    +
    + +
    +
    +

    Low-level API

    +

    All of the following functions must be called after Py_Initialize().

    +
    +

    Changed in version 3.7: Py_Initialize() now initializes the GIL.

    +
    +
    +
    +PyInterpreterState* PyInterpreterState_New()
    +

    Create a new interpreter state object. The global interpreter lock need not +be held, but may be held if it is necessary to serialize calls to this +function.

    +
    + +
    +
    +void PyInterpreterState_Clear(PyInterpreterState *interp)
    +

    Reset all information in an interpreter state object. The global interpreter +lock must be held.

    +
    + +
    +
    +void PyInterpreterState_Delete(PyInterpreterState *interp)
    +

    Destroy an interpreter state object. The global interpreter lock need not be +held. The interpreter state must have been reset with a previous call to +PyInterpreterState_Clear().

    +
    + +
    +
    +PyThreadState* PyThreadState_New(PyInterpreterState *interp)
    +

    Create a new thread state object belonging to the given interpreter object. +The global interpreter lock need not be held, but may be held if it is +necessary to serialize calls to this function.

    +
    + +
    +
    +void PyThreadState_Clear(PyThreadState *tstate)
    +

    Reset all information in a thread state object. The global interpreter lock +must be held.

    +
    + +
    +
    +void PyThreadState_Delete(PyThreadState *tstate)
    +

    Destroy a thread state object. The global interpreter lock need not be held. +The thread state must have been reset with a previous call to +PyThreadState_Clear().

    +
    + +
    +
    +PY_INT64_T PyInterpreterState_GetID(PyInterpreterState *interp)
    +

    Return the interpreter’s unique ID. If there was any error in doing +so then -1 is returned and an error is set.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +PyObject* PyThreadState_GetDict()
    +
    Return value: Borrowed reference.

    Return a dictionary in which extensions can store thread-specific state +information. Each extension should use a unique key to use to store state in +the dictionary. It is okay to call this function when no current thread state +is available. If this function returns NULL, no exception has been raised and +the caller should assume no current thread state is available.

    +
    + +
    +
    +int PyThreadState_SetAsyncExc(unsigned long id, PyObject *exc)
    +

    Asynchronously raise an exception in a thread. The id argument is the thread +id of the target thread; exc is the exception object to be raised. This +function does not steal any references to exc. To prevent naive misuse, you +must write your own C extension to call this. Must be called with the GIL held. +Returns the number of thread states modified; this is normally one, but will be +zero if the thread id isn’t found. If exc is NULL, the pending +exception (if any) for the thread is cleared. This raises no exceptions.

    +
    +

    Changed in version 3.7: The type of the id parameter changed from long to +unsigned long.

    +
    +
    + +
    +
    +void PyEval_AcquireThread(PyThreadState *tstate)
    +

    Acquire the global interpreter lock and set the current thread state to +tstate, which should not be NULL. The lock must have been created earlier. +If this thread already has the lock, deadlock ensues.

    +

    PyEval_RestoreThread() is a higher-level function which is always +available (even when threads have not been initialized).

    +
    + +
    +
    +void PyEval_ReleaseThread(PyThreadState *tstate)
    +

    Reset the current thread state to NULL and release the global interpreter +lock. The lock must have been created earlier and must be held by the current +thread. The tstate argument, which must not be NULL, is only used to check +that it represents the current thread state — if it isn’t, a fatal error is +reported.

    +

    PyEval_SaveThread() is a higher-level function which is always +available (even when threads have not been initialized).

    +
    + +
    +
    +void PyEval_AcquireLock()
    +

    Acquire the global interpreter lock. The lock must have been created earlier. +If this thread already has the lock, a deadlock ensues.

    +
    +

    Deprecated since version 3.2: This function does not update the current thread state. Please use +PyEval_RestoreThread() or PyEval_AcquireThread() +instead.

    +
    +
    + +
    +
    +void PyEval_ReleaseLock()
    +

    Release the global interpreter lock. The lock must have been created earlier.

    +
    +

    Deprecated since version 3.2: This function does not update the current thread state. Please use +PyEval_SaveThread() or PyEval_ReleaseThread() +instead.

    +
    +
    + +
    +
    +
    +

    Sub-interpreter support

    +

    While in most uses, you will only embed a single Python interpreter, there +are cases where you need to create several independent interpreters in the +same process and perhaps even in the same thread. Sub-interpreters allow +you to do that. You can switch between sub-interpreters using the +PyThreadState_Swap() function. You can create and destroy them +using the following functions:

    +
    +
    +PyThreadState* Py_NewInterpreter()
    +

    Create a new sub-interpreter. This is an (almost) totally separate environment +for the execution of Python code. In particular, the new interpreter has +separate, independent versions of all imported modules, including the +fundamental modules builtins, __main__ and sys. The +table of loaded modules (sys.modules) and the module search path +(sys.path) are also separate. The new environment has no sys.argv +variable. It has new standard I/O stream file objects sys.stdin, +sys.stdout and sys.stderr (however these refer to the same underlying +file descriptors).

    +

    The return value points to the first thread state created in the new +sub-interpreter. This thread state is made in the current thread state. +Note that no actual thread is created; see the discussion of thread states +below. If creation of the new interpreter is unsuccessful, NULL is +returned; no exception is set since the exception state is stored in the +current thread state and there may not be a current thread state. (Like all +other Python/C API functions, the global interpreter lock must be held before +calling this function and is still held when it returns; however, unlike most +other Python/C API functions, there needn’t be a current thread state on +entry.)

    +

    Extension modules are shared between (sub-)interpreters as follows: the first +time a particular extension is imported, it is initialized normally, and a +(shallow) copy of its module’s dictionary is squirreled away. When the same +extension is imported by another (sub-)interpreter, a new module is initialized +and filled with the contents of this copy; the extension’s init function is +not called. Note that this is different from what happens when an extension is +imported after the interpreter has been completely re-initialized by calling +Py_FinalizeEx() and Py_Initialize(); in that case, the extension’s +initmodule function is called again.

    +
    + +
    +
    +void Py_EndInterpreter(PyThreadState *tstate)
    +

    Destroy the (sub-)interpreter represented by the given thread state. The given +thread state must be the current thread state. See the discussion of thread +states below. When the call returns, the current thread state is NULL. All +thread states associated with this interpreter are destroyed. (The global +interpreter lock must be held before calling this function and is still held +when it returns.) Py_FinalizeEx() will destroy all sub-interpreters that +haven’t been explicitly destroyed at that point.

    +
    + +
    +

    Bugs and caveats

    +

    Because sub-interpreters (and the main interpreter) are part of the same +process, the insulation between them isn’t perfect — for example, using +low-level file operations like os.close() they can +(accidentally or maliciously) affect each other’s open files. Because of the +way extensions are shared between (sub-)interpreters, some extensions may not +work properly; this is especially likely when the extension makes use of +(static) global variables, or when the extension manipulates its module’s +dictionary after its initialization. It is possible to insert objects created +in one sub-interpreter into a namespace of another sub-interpreter; this should +be done with great care to avoid sharing user-defined functions, methods, +instances or classes between sub-interpreters, since import operations executed +by such objects may affect the wrong (sub-)interpreter’s dictionary of loaded +modules.

    +

    Also note that combining this functionality with PyGILState_*() APIs +is delicate, because these APIs assume a bijection between Python thread states +and OS-level threads, an assumption broken by the presence of sub-interpreters. +It is highly recommended that you don’t switch sub-interpreters between a pair +of matching PyGILState_Ensure() and PyGILState_Release() calls. +Furthermore, extensions (such as ctypes) using these APIs to allow calling +of Python code from non-Python created threads will probably be broken when using +sub-interpreters.

    +
    +
    +
    +

    Asynchronous Notifications

    +

    A mechanism is provided to make asynchronous notifications to the main +interpreter thread. These notifications take the form of a function +pointer and a void pointer argument.

    +
    +
    +int Py_AddPendingCall(int (*func)(void *), void *arg)
    +

    Schedule a function to be called from the main interpreter thread. On +success, 0 is returned and func is queued for being called in the +main thread. On failure, -1 is returned without setting any exception.

    +

    When successfully queued, func will be eventually called from the +main interpreter thread with the argument arg. It will be called +asynchronously with respect to normally running Python code, but with +both these conditions met:

    + +

    func must return 0 on success, or -1 on failure with an exception +set. func won’t be interrupted to perform another asynchronous +notification recursively, but it can still be interrupted to switch +threads if the global interpreter lock is released.

    +

    This function doesn’t need a current thread state to run, and it doesn’t +need the global interpreter lock.

    +
    +

    Warning

    +

    This is a low-level function, only useful for very special cases. +There is no guarantee that func will be called as quick as +possible. If the main thread is busy executing a system call, +func won’t be called before the system call returns. This +function is generally not suitable for calling Python code from +arbitrary C threads. Instead, use the PyGILState API.

    +
    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +

    Profiling and Tracing

    +

    The Python interpreter provides some low-level support for attaching profiling +and execution tracing facilities. These are used for profiling, debugging, and +coverage analysis tools.

    +

    This C interface allows the profiling or tracing code to avoid the overhead of +calling through Python-level callable objects, making a direct C function call +instead. The essential attributes of the facility have not changed; the +interface allows trace functions to be installed per-thread, and the basic +events reported to the trace function are the same as had been reported to the +Python-level trace functions in previous versions.

    +
    +
    +int (*Py_tracefunc)(PyObject *obj, PyFrameObject *frame, int what, PyObject *arg)
    +

    The type of the trace function registered using PyEval_SetProfile() and +PyEval_SetTrace(). The first parameter is the object passed to the +registration function as obj, frame is the frame object to which the event +pertains, what is one of the constants PyTrace_CALL, +PyTrace_EXCEPTION, PyTrace_LINE, PyTrace_RETURN, +PyTrace_C_CALL, PyTrace_C_EXCEPTION, PyTrace_C_RETURN, +or PyTrace_OPCODE, and arg depends on the value of what:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Value of what

    Meaning of arg

    PyTrace_CALL

    Always Py_None.

    PyTrace_EXCEPTION

    Exception information as returned by +sys.exc_info().

    PyTrace_LINE

    Always Py_None.

    PyTrace_RETURN

    Value being returned to the caller, +or NULL if caused by an exception.

    PyTrace_C_CALL

    Function object being called.

    PyTrace_C_EXCEPTION

    Function object being called.

    PyTrace_C_RETURN

    Function object being called.

    PyTrace_OPCODE

    Always Py_None.

    +
    + +
    +
    +int PyTrace_CALL
    +

    The value of the what parameter to a Py_tracefunc function when a new +call to a function or method is being reported, or a new entry into a generator. +Note that the creation of the iterator for a generator function is not reported +as there is no control transfer to the Python bytecode in the corresponding +frame.

    +
    + +
    +
    +int PyTrace_EXCEPTION
    +

    The value of the what parameter to a Py_tracefunc function when an +exception has been raised. The callback function is called with this value for +what when after any bytecode is processed after which the exception becomes +set within the frame being executed. The effect of this is that as exception +propagation causes the Python stack to unwind, the callback is called upon +return to each frame as the exception propagates. Only trace functions receives +these events; they are not needed by the profiler.

    +
    + +
    +
    +int PyTrace_LINE
    +

    The value passed as the what parameter to a Py_tracefunc function +(but not a profiling function) when a line-number event is being reported. +It may be disabled for a frame by setting f_trace_lines to 0 on that frame.

    +
    + +
    +
    +int PyTrace_RETURN
    +

    The value for the what parameter to Py_tracefunc functions when a +call is about to return.

    +
    + +
    +
    +int PyTrace_C_CALL
    +

    The value for the what parameter to Py_tracefunc functions when a C +function is about to be called.

    +
    + +
    +
    +int PyTrace_C_EXCEPTION
    +

    The value for the what parameter to Py_tracefunc functions when a C +function has raised an exception.

    +
    + +
    +
    +int PyTrace_C_RETURN
    +

    The value for the what parameter to Py_tracefunc functions when a C +function has returned.

    +
    + +
    +
    +int PyTrace_OPCODE
    +

    The value for the what parameter to Py_tracefunc functions (but not +profiling functions) when a new opcode is about to be executed. This event is +not emitted by default: it must be explicitly requested by setting +f_trace_opcodes to 1 on the frame.

    +
    + +
    +
    +void PyEval_SetProfile(Py_tracefunc func, PyObject *obj)
    +

    Set the profiler function to func. The obj parameter is passed to the +function as its first parameter, and may be any Python object, or NULL. If +the profile function needs to maintain state, using a different value for obj +for each thread provides a convenient and thread-safe place to store it. The +profile function is called for all monitored events except PyTrace_LINE +PyTrace_OPCODE and PyTrace_EXCEPTION.

    +
    + +
    +
    +void PyEval_SetTrace(Py_tracefunc func, PyObject *obj)
    +

    Set the tracing function to func. This is similar to +PyEval_SetProfile(), except the tracing function does receive line-number +events and per-opcode events, but does not receive any event related to C function +objects being called. Any trace function registered using PyEval_SetTrace() +will not receive PyTrace_C_CALL, PyTrace_C_EXCEPTION or +PyTrace_C_RETURN as a value for the what parameter.

    +
    + +
    +
    +

    Advanced Debugger Support

    +

    These functions are only intended to be used by advanced debugging tools.

    +
    +
    +PyInterpreterState* PyInterpreterState_Head()
    +

    Return the interpreter state object at the head of the list of all such objects.

    +
    + +
    +
    +PyInterpreterState* PyInterpreterState_Main()
    +

    Return the main interpreter state object.

    +
    + +
    +
    +PyInterpreterState* PyInterpreterState_Next(PyInterpreterState *interp)
    +

    Return the next interpreter state object after interp from the list of all +such objects.

    +
    + +
    +
    +PyThreadState * PyInterpreterState_ThreadHead(PyInterpreterState *interp)
    +

    Return the pointer to the first PyThreadState object in the list of +threads associated with the interpreter interp.

    +
    + +
    +
    +PyThreadState* PyThreadState_Next(PyThreadState *tstate)
    +

    Return the next thread state object after tstate from the list of all such +objects belonging to the same PyInterpreterState object.

    +
    + +
    +
    +

    Thread Local Storage Support

    +

    The Python interpreter provides low-level support for thread-local storage +(TLS) which wraps the underlying native TLS implementation to support the +Python-level thread local storage API (threading.local). The +CPython C level APIs are similar to those offered by pthreads and Windows: +use a thread key and functions to associate a void* value per +thread.

    +

    The GIL does not need to be held when calling these functions; they supply +their own locking.

    +

    Note that Python.h does not include the declaration of the TLS APIs, +you need to include pythread.h to use thread-local storage.

    +
    +

    Note

    +

    None of these API functions handle memory management on behalf of the +void* values. You need to allocate and deallocate them yourself. +If the void* values happen to be PyObject*, these +functions don’t do refcount operations on them either.

    +
    +
    +

    Thread Specific Storage (TSS) API

    +

    TSS API is introduced to supersede the use of the existing TLS API within the +CPython interpreter. This API uses a new type Py_tss_t instead of +int to represent thread keys.

    +
    +

    New in version 3.7.

    +
    +
    +

    See also

    +

    “A New C-API for Thread-Local Storage in CPython” (PEP 539)

    +
    +
    +
    +Py_tss_t
    +

    This data structure represents the state of a thread key, the definition of +which may depend on the underlying TLS implementation, and it has an +internal field representing the key’s initialization state. There are no +public members in this structure.

    +

    When Py_LIMITED_API is not defined, static allocation of +this type by Py_tss_NEEDS_INIT is allowed.

    +
    + +
    +
    +Py_tss_NEEDS_INIT
    +

    This macro expands to the initializer for Py_tss_t variables. +Note that this macro won’t be defined with Py_LIMITED_API.

    +
    + +
    +

    Dynamic Allocation

    +

    Dynamic allocation of the Py_tss_t, required in extension modules +built with Py_LIMITED_API, where static allocation of this type +is not possible due to its implementation being opaque at build time.

    +
    +
    +Py_tss_t* PyThread_tss_alloc()
    +

    Return a value which is the same state as a value initialized with +Py_tss_NEEDS_INIT, or NULL in the case of dynamic allocation +failure.

    +
    + +
    +
    +void PyThread_tss_free(Py_tss_t *key)
    +

    Free the given key allocated by PyThread_tss_alloc(), after +first calling PyThread_tss_delete() to ensure any associated +thread locals have been unassigned. This is a no-op if the key +argument is NULL.

    +
    +

    Note

    +

    A freed key becomes a dangling pointer, you should reset the key to +NULL.

    +
    +
    + +
    +
    +

    Methods

    +

    The parameter key of these functions must not be NULL. Moreover, the +behaviors of PyThread_tss_set() and PyThread_tss_get() are +undefined if the given Py_tss_t has not been initialized by +PyThread_tss_create().

    +
    +
    +int PyThread_tss_is_created(Py_tss_t *key)
    +

    Return a non-zero value if the given Py_tss_t has been initialized +by PyThread_tss_create().

    +
    + +
    +
    +int PyThread_tss_create(Py_tss_t *key)
    +

    Return a zero value on successful initialization of a TSS key. The behavior +is undefined if the value pointed to by the key argument is not +initialized by Py_tss_NEEDS_INIT. This function can be called +repeatedly on the same key – calling it on an already initialized key is a +no-op and immediately returns success.

    +
    + +
    +
    +void PyThread_tss_delete(Py_tss_t *key)
    +

    Destroy a TSS key to forget the values associated with the key across all +threads, and change the key’s initialization state to uninitialized. A +destroyed key is able to be initialized again by +PyThread_tss_create(). This function can be called repeatedly on +the same key – calling it on an already destroyed key is a no-op.

    +
    + +
    +
    +int PyThread_tss_set(Py_tss_t *key, void *value)
    +

    Return a zero value to indicate successfully associating a void* +value with a TSS key in the current thread. Each thread has a distinct +mapping of the key to a void* value.

    +
    + +
    +
    +void* PyThread_tss_get(Py_tss_t *key)
    +

    Return the void* value associated with a TSS key in the current +thread. This returns NULL if no value is associated with the key in the +current thread.

    +
    + +
    +
    +
    +

    Thread Local Storage (TLS) API

    +
    +

    Deprecated since version 3.7: This API is superseded by +Thread Specific Storage (TSS) API.

    +
    +
    +

    Note

    +

    This version of the API does not support platforms where the native TLS key +is defined in a way that cannot be safely cast to int. On such platforms, +PyThread_create_key() will return immediately with a failure status, +and the other TLS functions will all be no-ops on such platforms.

    +
    +

    Due to the compatibility problem noted above, this version of the API should not +be used in new code.

    +
    +
    +int PyThread_create_key()
    +
    + +
    +
    +void PyThread_delete_key(int key)
    +
    + +
    +
    +int PyThread_set_key_value(int key, void *value)
    +
    + +
    +
    +void* PyThread_get_key_value(int key)
    +
    + +
    +
    +void PyThread_delete_key_value(int key)
    +
    + +
    +
    +void PyThread_ReInitTLS()
    +
    + +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/intro.html b/python-3.7.4-docs-html/c-api/intro.html new file mode 100644 index 0000000..166c73b --- /dev/null +++ b/python-3.7.4-docs-html/c-api/intro.html @@ -0,0 +1,803 @@ + + + + + + + Introduction — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Introduction

    +

    The Application Programmer’s Interface to Python gives C and C++ programmers +access to the Python interpreter at a variety of levels. The API is equally +usable from C++, but for brevity it is generally referred to as the Python/C +API. There are two fundamentally different reasons for using the Python/C API. +The first reason is to write extension modules for specific purposes; these +are C modules that extend the Python interpreter. This is probably the most +common use. The second reason is to use Python as a component in a larger +application; this technique is generally referred to as embedding Python +in an application.

    +

    Writing an extension module is a relatively well-understood process, where a +“cookbook” approach works well. There are several tools that automate the +process to some extent. While people have embedded Python in other +applications since its early existence, the process of embedding Python is +less straightforward than writing an extension.

    +

    Many API functions are useful independent of whether you’re embedding or +extending Python; moreover, most applications that embed Python will need to +provide a custom extension as well, so it’s probably a good idea to become +familiar with writing an extension before attempting to embed Python in a real +application.

    +
    +

    Coding standards

    +

    If you’re writing C code for inclusion in CPython, you must follow the +guidelines and standards defined in PEP 7. These guidelines apply +regardless of the version of Python you are contributing to. Following these +conventions is not necessary for your own third party extension modules, +unless you eventually expect to contribute them to Python.

    +
    +
    +

    Include Files

    +

    All function, type and macro definitions needed to use the Python/C API are +included in your code by the following line:

    +
    #define PY_SSIZE_T_CLEAN
    +#include <Python.h>
    +
    +
    +

    This implies inclusion of the following standard headers: <stdio.h>, +<string.h>, <errno.h>, <limits.h>, <assert.h> and <stdlib.h> +(if available).

    +
    +

    Note

    +

    Since Python may define some pre-processor definitions which affect the standard +headers on some systems, you must include Python.h before any standard +headers are included.

    +

    It is recommended to always define PY_SSIZE_T_CLEAN before including +Python.h. See Parsing arguments and building values for a description of this macro.

    +
    +

    All user visible names defined by Python.h (except those defined by the included +standard headers) have one of the prefixes Py or _Py. Names beginning +with _Py are for internal use by the Python implementation and should not be +used by extension writers. Structure member names do not have a reserved prefix.

    +

    Important: user code should never define names that begin with Py or +_Py. This confuses the reader, and jeopardizes the portability of the user +code to future Python versions, which may define additional names beginning with +one of these prefixes.

    +

    The header files are typically installed with Python. On Unix, these are +located in the directories prefix/include/pythonversion/ and +exec_prefix/include/pythonversion/, where prefix and +exec_prefix are defined by the corresponding parameters to Python’s +configure script and version is +'%d.%d' % sys.version_info[:2]. On Windows, the headers are installed +in prefix/include, where prefix is the installation +directory specified to the installer.

    +

    To include the headers, place both directories (if different) on your compiler’s +search path for includes. Do not place the parent directories on the search +path and then use #include <pythonX.Y/Python.h>; this will break on +multi-platform builds since the platform independent headers under +prefix include the platform specific headers from +exec_prefix.

    +

    C++ users should note that though the API is defined entirely using C, the +header files do properly declare the entry points to be extern "C", so there +is no need to do anything special to use the API from C++.

    +
    +
    +

    Useful macros

    +

    Several useful macros are defined in the Python header files. Many are +defined closer to where they are useful (e.g. Py_RETURN_NONE). +Others of a more general utility are defined here. This is not necessarily a +complete listing.

    +
    +
    +Py_UNREACHABLE()
    +

    Use this when you have a code path that you do not expect to be reached. +For example, in the default: clause in a switch statement for which +all possible values are covered in case statements. Use this in places +where you might be tempted to put an assert(0) or abort() call.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +Py_ABS(x)
    +

    Return the absolute value of x.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +Py_MIN(x, y)
    +

    Return the minimum value between x and y.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +Py_MAX(x, y)
    +

    Return the maximum value between x and y.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +Py_STRINGIFY(x)
    +

    Convert x to a C string. E.g. Py_STRINGIFY(123) returns +"123".

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +Py_MEMBER_SIZE(type, member)
    +

    Return the size of a structure (type) member in bytes.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +Py_CHARMASK(c)
    +

    Argument must be a character or an integer in the range [-128, 127] or [0, +255]. This macro returns c cast to an unsigned char.

    +
    + +
    +
    +Py_GETENV(s)
    +

    Like getenv(s), but returns NULL if -E was passed on the +command line (i.e. if Py_IgnoreEnvironmentFlag is set).

    +
    + +
    +
    +Py_UNUSED(arg)
    +

    Use this for unused arguments in a function definition to silence compiler +warnings, e.g. PyObject* func(PyObject *Py_UNUSED(ignored)).

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +

    Objects, Types and Reference Counts

    +

    Most Python/C API functions have one or more arguments as well as a return value +of type PyObject*. This type is a pointer to an opaque data type +representing an arbitrary Python object. Since all Python object types are +treated the same way by the Python language in most situations (e.g., +assignments, scope rules, and argument passing), it is only fitting that they +should be represented by a single C type. Almost all Python objects live on the +heap: you never declare an automatic or static variable of type +PyObject, only pointer variables of type PyObject* can be +declared. The sole exception are the type objects; since these must never be +deallocated, they are typically static PyTypeObject objects.

    +

    All Python objects (even Python integers) have a type and a +reference count. An object’s type determines what kind of object it is +(e.g., an integer, a list, or a user-defined function; there are many more as +explained in The standard type hierarchy). For each of the well-known types there is a macro +to check whether an object is of that type; for instance, PyList_Check(a) is +true if (and only if) the object pointed to by a is a Python list.

    +
    +

    Reference Counts

    +

    The reference count is important because today’s computers have a finite (and +often severely limited) memory size; it counts how many different places there +are that have a reference to an object. Such a place could be another object, +or a global (or static) C variable, or a local variable in some C function. +When an object’s reference count becomes zero, the object is deallocated. If +it contains references to other objects, their reference count is decremented. +Those other objects may be deallocated in turn, if this decrement makes their +reference count become zero, and so on. (There’s an obvious problem with +objects that reference each other here; for now, the solution is “don’t do +that.”)

    +

    Reference counts are always manipulated explicitly. The normal way is to use +the macro Py_INCREF() to increment an object’s reference count by one, +and Py_DECREF() to decrement it by one. The Py_DECREF() macro +is considerably more complex than the incref one, since it must check whether +the reference count becomes zero and then cause the object’s deallocator to be +called. The deallocator is a function pointer contained in the object’s type +structure. The type-specific deallocator takes care of decrementing the +reference counts for other objects contained in the object if this is a compound +object type, such as a list, as well as performing any additional finalization +that’s needed. There’s no chance that the reference count can overflow; at +least as many bits are used to hold the reference count as there are distinct +memory locations in virtual memory (assuming sizeof(Py_ssize_t) >= sizeof(void*)). +Thus, the reference count increment is a simple operation.

    +

    It is not necessary to increment an object’s reference count for every local +variable that contains a pointer to an object. In theory, the object’s +reference count goes up by one when the variable is made to point to it and it +goes down by one when the variable goes out of scope. However, these two +cancel each other out, so at the end the reference count hasn’t changed. The +only real reason to use the reference count is to prevent the object from being +deallocated as long as our variable is pointing to it. If we know that there +is at least one other reference to the object that lives at least as long as +our variable, there is no need to increment the reference count temporarily. +An important situation where this arises is in objects that are passed as +arguments to C functions in an extension module that are called from Python; +the call mechanism guarantees to hold a reference to every argument for the +duration of the call.

    +

    However, a common pitfall is to extract an object from a list and hold on to it +for a while without incrementing its reference count. Some other operation might +conceivably remove the object from the list, decrementing its reference count +and possible deallocating it. The real danger is that innocent-looking +operations may invoke arbitrary Python code which could do this; there is a code +path which allows control to flow back to the user from a Py_DECREF(), so +almost any operation is potentially dangerous.

    +

    A safe approach is to always use the generic operations (functions whose name +begins with PyObject_, PyNumber_, PySequence_ or PyMapping_). +These operations always increment the reference count of the object they return. +This leaves the caller with the responsibility to call Py_DECREF() when +they are done with the result; this soon becomes second nature.

    +
    +

    Reference Count Details

    +

    The reference count behavior of functions in the Python/C API is best explained +in terms of ownership of references. Ownership pertains to references, never +to objects (objects are not owned: they are always shared). “Owning a +reference” means being responsible for calling Py_DECREF on it when the +reference is no longer needed. Ownership can also be transferred, meaning that +the code that receives ownership of the reference then becomes responsible for +eventually decref’ing it by calling Py_DECREF() or Py_XDECREF() +when it’s no longer needed—or passing on this responsibility (usually to its +caller). When a function passes ownership of a reference on to its caller, the +caller is said to receive a new reference. When no ownership is transferred, +the caller is said to borrow the reference. Nothing needs to be done for a +borrowed reference.

    +

    Conversely, when a calling function passes in a reference to an object, there +are two possibilities: the function steals a reference to the object, or it +does not. Stealing a reference means that when you pass a reference to a +function, that function assumes that it now owns that reference, and you are not +responsible for it any longer.

    +

    Few functions steal references; the two notable exceptions are +PyList_SetItem() and PyTuple_SetItem(), which steal a reference +to the item (but not to the tuple or list into which the item is put!). These +functions were designed to steal a reference because of a common idiom for +populating a tuple or list with newly created objects; for example, the code to +create the tuple (1, 2, "three") could look like this (forgetting about +error handling for the moment; a better way to code this is shown below):

    +
    PyObject *t;
    +
    +t = PyTuple_New(3);
    +PyTuple_SetItem(t, 0, PyLong_FromLong(1L));
    +PyTuple_SetItem(t, 1, PyLong_FromLong(2L));
    +PyTuple_SetItem(t, 2, PyUnicode_FromString("three"));
    +
    +
    +

    Here, PyLong_FromLong() returns a new reference which is immediately +stolen by PyTuple_SetItem(). When you want to keep using an object +although the reference to it will be stolen, use Py_INCREF() to grab +another reference before calling the reference-stealing function.

    +

    Incidentally, PyTuple_SetItem() is the only way to set tuple items; +PySequence_SetItem() and PyObject_SetItem() refuse to do this +since tuples are an immutable data type. You should only use +PyTuple_SetItem() for tuples that you are creating yourself.

    +

    Equivalent code for populating a list can be written using PyList_New() +and PyList_SetItem().

    +

    However, in practice, you will rarely use these ways of creating and populating +a tuple or list. There’s a generic function, Py_BuildValue(), that can +create most common objects from C values, directed by a format string. +For example, the above two blocks of code could be replaced by the following +(which also takes care of the error checking):

    +
    PyObject *tuple, *list;
    +
    +tuple = Py_BuildValue("(iis)", 1, 2, "three");
    +list = Py_BuildValue("[iis]", 1, 2, "three");
    +
    +
    +

    It is much more common to use PyObject_SetItem() and friends with items +whose references you are only borrowing, like arguments that were passed in to +the function you are writing. In that case, their behaviour regarding reference +counts is much saner, since you don’t have to increment a reference count so you +can give a reference away (“have it be stolen”). For example, this function +sets all items of a list (actually, any mutable sequence) to a given item:

    +
    int
    +set_all(PyObject *target, PyObject *item)
    +{
    +    Py_ssize_t i, n;
    +
    +    n = PyObject_Length(target);
    +    if (n < 0)
    +        return -1;
    +    for (i = 0; i < n; i++) {
    +        PyObject *index = PyLong_FromSsize_t(i);
    +        if (!index)
    +            return -1;
    +        if (PyObject_SetItem(target, index, item) < 0) {
    +            Py_DECREF(index);
    +            return -1;
    +        }
    +        Py_DECREF(index);
    +    }
    +    return 0;
    +}
    +
    +
    +

    The situation is slightly different for function return values. While passing +a reference to most functions does not change your ownership responsibilities +for that reference, many functions that return a reference to an object give +you ownership of the reference. The reason is simple: in many cases, the +returned object is created on the fly, and the reference you get is the only +reference to the object. Therefore, the generic functions that return object +references, like PyObject_GetItem() and PySequence_GetItem(), +always return a new reference (the caller becomes the owner of the reference).

    +

    It is important to realize that whether you own a reference returned by a +function depends on which function you call only — the plumage (the type of +the object passed as an argument to the function) doesn’t enter into it! +Thus, if you extract an item from a list using PyList_GetItem(), you +don’t own the reference — but if you obtain the same item from the same list +using PySequence_GetItem() (which happens to take exactly the same +arguments), you do own a reference to the returned object.

    +

    Here is an example of how you could write a function that computes the sum of +the items in a list of integers; once using PyList_GetItem(), and once +using PySequence_GetItem().

    +
    long
    +sum_list(PyObject *list)
    +{
    +    Py_ssize_t i, n;
    +    long total = 0, value;
    +    PyObject *item;
    +
    +    n = PyList_Size(list);
    +    if (n < 0)
    +        return -1; /* Not a list */
    +    for (i = 0; i < n; i++) {
    +        item = PyList_GetItem(list, i); /* Can't fail */
    +        if (!PyLong_Check(item)) continue; /* Skip non-integers */
    +        value = PyLong_AsLong(item);
    +        if (value == -1 && PyErr_Occurred())
    +            /* Integer too big to fit in a C long, bail out */
    +            return -1;
    +        total += value;
    +    }
    +    return total;
    +}
    +
    +
    +
    long
    +sum_sequence(PyObject *sequence)
    +{
    +    Py_ssize_t i, n;
    +    long total = 0, value;
    +    PyObject *item;
    +    n = PySequence_Length(sequence);
    +    if (n < 0)
    +        return -1; /* Has no length */
    +    for (i = 0; i < n; i++) {
    +        item = PySequence_GetItem(sequence, i);
    +        if (item == NULL)
    +            return -1; /* Not a sequence, or other failure */
    +        if (PyLong_Check(item)) {
    +            value = PyLong_AsLong(item);
    +            Py_DECREF(item);
    +            if (value == -1 && PyErr_Occurred())
    +                /* Integer too big to fit in a C long, bail out */
    +                return -1;
    +            total += value;
    +        }
    +        else {
    +            Py_DECREF(item); /* Discard reference ownership */
    +        }
    +    }
    +    return total;
    +}
    +
    +
    +
    +
    +
    +

    Types

    +

    There are few other data types that play a significant role in the Python/C +API; most are simple C types such as int, long, +double and char*. A few structure types are used to +describe static tables used to list the functions exported by a module or the +data attributes of a new object type, and another is used to describe the value +of a complex number. These will be discussed together with the functions that +use them.

    +
    +
    +
    +

    Exceptions

    +

    The Python programmer only needs to deal with exceptions if specific error +handling is required; unhandled exceptions are automatically propagated to the +caller, then to the caller’s caller, and so on, until they reach the top-level +interpreter, where they are reported to the user accompanied by a stack +traceback.

    +

    For C programmers, however, error checking always has to be explicit. All +functions in the Python/C API can raise exceptions, unless an explicit claim is +made otherwise in a function’s documentation. In general, when a function +encounters an error, it sets an exception, discards any object references that +it owns, and returns an error indicator. If not documented otherwise, this +indicator is either NULL or -1, depending on the function’s return type. +A few functions return a Boolean true/false result, with false indicating an +error. Very few functions return no explicit error indicator or have an +ambiguous return value, and require explicit testing for errors with +PyErr_Occurred(). These exceptions are always explicitly documented.

    +

    Exception state is maintained in per-thread storage (this is equivalent to +using global storage in an unthreaded application). A thread can be in one of +two states: an exception has occurred, or not. The function +PyErr_Occurred() can be used to check for this: it returns a borrowed +reference to the exception type object when an exception has occurred, and +NULL otherwise. There are a number of functions to set the exception state: +PyErr_SetString() is the most common (though not the most general) +function to set the exception state, and PyErr_Clear() clears the +exception state.

    +

    The full exception state consists of three objects (all of which can be +NULL): the exception type, the corresponding exception value, and the +traceback. These have the same meanings as the Python result of +sys.exc_info(); however, they are not the same: the Python objects represent +the last exception being handled by a Python try … +except statement, while the C level exception state only exists while +an exception is being passed on between C functions until it reaches the Python +bytecode interpreter’s main loop, which takes care of transferring it to +sys.exc_info() and friends.

    +

    Note that starting with Python 1.5, the preferred, thread-safe way to access the +exception state from Python code is to call the function sys.exc_info(), +which returns the per-thread exception state for Python code. Also, the +semantics of both ways to access the exception state have changed so that a +function which catches an exception will save and restore its thread’s exception +state so as to preserve the exception state of its caller. This prevents common +bugs in exception handling code caused by an innocent-looking function +overwriting the exception being handled; it also reduces the often unwanted +lifetime extension for objects that are referenced by the stack frames in the +traceback.

    +

    As a general principle, a function that calls another function to perform some +task should check whether the called function raised an exception, and if so, +pass the exception state on to its caller. It should discard any object +references that it owns, and return an error indicator, but it should not set +another exception — that would overwrite the exception that was just raised, +and lose important information about the exact cause of the error.

    +

    A simple example of detecting exceptions and passing them on is shown in the +sum_sequence() example above. It so happens that this example doesn’t +need to clean up any owned references when it detects an error. The following +example function shows some error cleanup. First, to remind you why you like +Python, we show the equivalent Python code:

    +
    def incr_item(dict, key):
    +    try:
    +        item = dict[key]
    +    except KeyError:
    +        item = 0
    +    dict[key] = item + 1
    +
    +
    +

    Here is the corresponding C code, in all its glory:

    +
    int
    +incr_item(PyObject *dict, PyObject *key)
    +{
    +    /* Objects all initialized to NULL for Py_XDECREF */
    +    PyObject *item = NULL, *const_one = NULL, *incremented_item = NULL;
    +    int rv = -1; /* Return value initialized to -1 (failure) */
    +
    +    item = PyObject_GetItem(dict, key);
    +    if (item == NULL) {
    +        /* Handle KeyError only: */
    +        if (!PyErr_ExceptionMatches(PyExc_KeyError))
    +            goto error;
    +
    +        /* Clear the error and use zero: */
    +        PyErr_Clear();
    +        item = PyLong_FromLong(0L);
    +        if (item == NULL)
    +            goto error;
    +    }
    +    const_one = PyLong_FromLong(1L);
    +    if (const_one == NULL)
    +        goto error;
    +
    +    incremented_item = PyNumber_Add(item, const_one);
    +    if (incremented_item == NULL)
    +        goto error;
    +
    +    if (PyObject_SetItem(dict, key, incremented_item) < 0)
    +        goto error;
    +    rv = 0; /* Success */
    +    /* Continue with cleanup code */
    +
    + error:
    +    /* Cleanup code, shared by success and failure path */
    +
    +    /* Use Py_XDECREF() to ignore NULL references */
    +    Py_XDECREF(item);
    +    Py_XDECREF(const_one);
    +    Py_XDECREF(incremented_item);
    +
    +    return rv; /* -1 for error, 0 for success */
    +}
    +
    +
    +

    This example represents an endorsed use of the goto statement in C! +It illustrates the use of PyErr_ExceptionMatches() and +PyErr_Clear() to handle specific exceptions, and the use of +Py_XDECREF() to dispose of owned references that may be NULL (note the +'X' in the name; Py_DECREF() would crash when confronted with a +NULL reference). It is important that the variables used to hold owned +references are initialized to NULL for this to work; likewise, the proposed +return value is initialized to -1 (failure) and only set to success after +the final call made is successful.

    +
    +
    +

    Embedding Python

    +

    The one important task that only embedders (as opposed to extension writers) of +the Python interpreter have to worry about is the initialization, and possibly +the finalization, of the Python interpreter. Most functionality of the +interpreter can only be used after the interpreter has been initialized.

    +

    The basic initialization function is Py_Initialize(). This initializes +the table of loaded modules, and creates the fundamental modules +builtins, __main__, and sys. It also +initializes the module search path (sys.path).

    +

    Py_Initialize() does not set the “script argument list” (sys.argv). +If this variable is needed by Python code that will be executed later, it must +be set explicitly with a call to PySys_SetArgvEx(argc, argv, updatepath) +after the call to Py_Initialize().

    +

    On most systems (in particular, on Unix and Windows, although the details are +slightly different), Py_Initialize() calculates the module search path +based upon its best guess for the location of the standard Python interpreter +executable, assuming that the Python library is found in a fixed location +relative to the Python interpreter executable. In particular, it looks for a +directory named lib/pythonX.Y relative to the parent directory +where the executable named python is found on the shell command search +path (the environment variable PATH).

    +

    For instance, if the Python executable is found in +/usr/local/bin/python, it will assume that the libraries are in +/usr/local/lib/pythonX.Y. (In fact, this particular path is also +the “fallback” location, used when no executable file named python is +found along PATH.) The user can override this behavior by setting the +environment variable PYTHONHOME, or insert additional directories in +front of the standard path by setting PYTHONPATH.

    +

    The embedding application can steer the search by calling +Py_SetProgramName(file) before calling Py_Initialize(). Note that +PYTHONHOME still overrides this and PYTHONPATH is still +inserted in front of the standard path. An application that requires total +control has to provide its own implementation of Py_GetPath(), +Py_GetPrefix(), Py_GetExecPrefix(), and +Py_GetProgramFullPath() (all defined in Modules/getpath.c).

    +

    Sometimes, it is desirable to “uninitialize” Python. For instance, the +application may want to start over (make another call to +Py_Initialize()) or the application is simply done with its use of +Python and wants to free memory allocated by Python. This can be accomplished +by calling Py_FinalizeEx(). The function Py_IsInitialized() returns +true if Python is currently in the initialized state. More information about +these functions is given in a later chapter. Notice that Py_FinalizeEx() +does not free all memory allocated by the Python interpreter, e.g. memory +allocated by extension modules currently cannot be released.

    +
    +
    +

    Debugging Builds

    +

    Python can be built with several macros to enable extra checks of the +interpreter and extension modules. These checks tend to add a large amount of +overhead to the runtime so they are not enabled by default.

    +

    A full list of the various types of debugging builds is in the file +Misc/SpecialBuilds.txt in the Python source distribution. Builds are +available that support tracing of reference counts, debugging the memory +allocator, or low-level profiling of the main interpreter loop. Only the most +frequently-used builds will be described in the remainder of this section.

    +

    Compiling the interpreter with the Py_DEBUG macro defined produces +what is generally meant by “a debug build” of Python. Py_DEBUG is +enabled in the Unix build by adding --with-pydebug to the +./configure command. It is also implied by the presence of the +not-Python-specific _DEBUG macro. When Py_DEBUG is enabled +in the Unix build, compiler optimization is disabled.

    +

    In addition to the reference count debugging described below, the following +extra checks are performed:

    +
      +
    • Extra checks are added to the object allocator.

    • +
    • Extra checks are added to the parser and compiler.

    • +
    • Downcasts from wide types to narrow types are checked for loss of information.

    • +
    • A number of assertions are added to the dictionary and set implementations. +In addition, the set object acquires a test_c_api() method.

    • +
    • Sanity checks of the input arguments are added to frame creation.

    • +
    • The storage for ints is initialized with a known invalid pattern to catch +reference to uninitialized digits.

    • +
    • Low-level tracing and extra exception checking are added to the runtime +virtual machine.

    • +
    • Extra checks are added to the memory arena implementation.

    • +
    • Extra debugging is added to the thread module.

    • +
    +

    There may be additional checks not mentioned here.

    +

    Defining Py_TRACE_REFS enables reference tracing. When defined, a +circular doubly linked list of active objects is maintained by adding two extra +fields to every PyObject. Total allocations are tracked as well. Upon +exit, all existing references are printed. (In interactive mode this happens +after every statement run by the interpreter.) Implied by Py_DEBUG.

    +

    Please refer to Misc/SpecialBuilds.txt in the Python source distribution +for more detailed information.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/iter.html b/python-3.7.4-docs-html/c-api/iter.html new file mode 100644 index 0000000..18df841 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/iter.html @@ -0,0 +1,225 @@ + + + + + + + Iterator Protocol — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Iterator Protocol

    +

    There are two functions specifically for working with iterators.

    +
    +
    +int PyIter_Check(PyObject *o)
    +

    Return true if the object o supports the iterator protocol.

    +
    + +
    +
    +PyObject* PyIter_Next(PyObject *o)
    +
    Return value: New reference.

    Return the next value from the iteration o. The object must be an iterator +(it is up to the caller to check this). If there are no remaining values, +returns NULL with no exception set. If an error occurs while retrieving +the item, returns NULL and passes along the exception.

    +
    + +

    To write a loop which iterates over an iterator, the C code should look +something like this:

    +
    PyObject *iterator = PyObject_GetIter(obj);
    +PyObject *item;
    +
    +if (iterator == NULL) {
    +    /* propagate error */
    +}
    +
    +while (item = PyIter_Next(iterator)) {
    +    /* do something with item */
    +    ...
    +    /* release reference when done */
    +    Py_DECREF(item);
    +}
    +
    +Py_DECREF(iterator);
    +
    +if (PyErr_Occurred()) {
    +    /* propagate error */
    +}
    +else {
    +    /* continue doing useful work */
    +}
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/iterator.html b/python-3.7.4-docs-html/c-api/iterator.html new file mode 100644 index 0000000..e31916e --- /dev/null +++ b/python-3.7.4-docs-html/c-api/iterator.html @@ -0,0 +1,232 @@ + + + + + + + Iterator Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Iterator Objects

    +

    Python provides two general-purpose iterator objects. The first, a sequence +iterator, works with an arbitrary sequence supporting the __getitem__() +method. The second works with a callable object and a sentinel value, calling +the callable for each item in the sequence, and ending the iteration when the +sentinel value is returned.

    +
    +
    +PyTypeObject PySeqIter_Type
    +

    Type object for iterator objects returned by PySeqIter_New() and the +one-argument form of the iter() built-in function for built-in sequence +types.

    +
    + +
    +
    +int PySeqIter_Check(op)
    +

    Return true if the type of op is PySeqIter_Type.

    +
    + +
    +
    +PyObject* PySeqIter_New(PyObject *seq)
    +
    Return value: New reference.

    Return an iterator that works with a general sequence object, seq. The +iteration ends when the sequence raises IndexError for the subscripting +operation.

    +
    + +
    +
    +PyTypeObject PyCallIter_Type
    +

    Type object for iterator objects returned by PyCallIter_New() and the +two-argument form of the iter() built-in function.

    +
    + +
    +
    +int PyCallIter_Check(op)
    +

    Return true if the type of op is PyCallIter_Type.

    +
    + +
    +
    +PyObject* PyCallIter_New(PyObject *callable, PyObject *sentinel)
    +
    Return value: New reference.

    Return a new iterator. The first parameter, callable, can be any Python +callable object that can be called with no parameters; each call to it should +return the next item in the iteration. When callable returns a value equal to +sentinel, the iteration will be terminated.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/list.html b/python-3.7.4-docs-html/c-api/list.html new file mode 100644 index 0000000..3205618 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/list.html @@ -0,0 +1,342 @@ + + + + + + + List Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    List Objects

    +
    +
    +PyListObject
    +

    This subtype of PyObject represents a Python list object.

    +
    + +
    +
    +PyTypeObject PyList_Type
    +

    This instance of PyTypeObject represents the Python list type. +This is the same object as list in the Python layer.

    +
    + +
    +
    +int PyList_Check(PyObject *p)
    +

    Return true if p is a list object or an instance of a subtype of the list +type.

    +
    + +
    +
    +int PyList_CheckExact(PyObject *p)
    +

    Return true if p is a list object, but not an instance of a subtype of +the list type.

    +
    + +
    +
    +PyObject* PyList_New(Py_ssize_t len)
    +
    Return value: New reference.

    Return a new list of length len on success, or NULL on failure.

    +
    +

    Note

    +

    If len is greater than zero, the returned list object’s items are +set to NULL. Thus you cannot use abstract API functions such as +PySequence_SetItem() or expose the object to Python code before +setting all items to a real object with PyList_SetItem().

    +
    +
    + +
    +
    +Py_ssize_t PyList_Size(PyObject *list)
    +

    Return the length of the list object in list; this is equivalent to +len(list) on a list object.

    +
    + +
    +
    +Py_ssize_t PyList_GET_SIZE(PyObject *list)
    +

    Macro form of PyList_Size() without error checking.

    +
    + +
    +
    +PyObject* PyList_GetItem(PyObject *list, Py_ssize_t index)
    +
    Return value: Borrowed reference.

    Return the object at position index in the list pointed to by list. The +position must be non-negative; indexing from the end of the list is not +supported. If index is out of bounds (<0 or >=len(list)), +return NULL and set an IndexError exception.

    +
    + +
    +
    +PyObject* PyList_GET_ITEM(PyObject *list, Py_ssize_t i)
    +
    Return value: Borrowed reference.

    Macro form of PyList_GetItem() without error checking.

    +
    + +
    +
    +int PyList_SetItem(PyObject *list, Py_ssize_t index, PyObject *item)
    +

    Set the item at index index in list to item. Return 0 on success +or -1 on failure.

    +
    +

    Note

    +

    This function “steals” a reference to item and discards a reference to +an item already in the list at the affected position.

    +
    +
    + +
    +
    +void PyList_SET_ITEM(PyObject *list, Py_ssize_t i, PyObject *o)
    +

    Macro form of PyList_SetItem() without error checking. This is +normally only used to fill in new lists where there is no previous content.

    +
    +

    Note

    +

    This macro “steals” a reference to item, and, unlike +PyList_SetItem(), does not discard a reference to any item that +is being replaced; any reference in list at position i will be +leaked.

    +
    +
    + +
    +
    +int PyList_Insert(PyObject *list, Py_ssize_t index, PyObject *item)
    +

    Insert the item item into list list in front of index index. Return +0 if successful; return -1 and set an exception if unsuccessful. +Analogous to list.insert(index, item).

    +
    + +
    +
    +int PyList_Append(PyObject *list, PyObject *item)
    +

    Append the object item at the end of list list. Return 0 if +successful; return -1 and set an exception if unsuccessful. Analogous +to list.append(item).

    +
    + +
    +
    +PyObject* PyList_GetSlice(PyObject *list, Py_ssize_t low, Py_ssize_t high)
    +
    Return value: New reference.

    Return a list of the objects in list containing the objects between low +and high. Return NULL and set an exception if unsuccessful. Analogous +to list[low:high]. Negative indices, as when slicing from Python, are not +supported.

    +
    + +
    +
    +int PyList_SetSlice(PyObject *list, Py_ssize_t low, Py_ssize_t high, PyObject *itemlist)
    +

    Set the slice of list between low and high to the contents of +itemlist. Analogous to list[low:high] = itemlist. The itemlist may +be NULL, indicating the assignment of an empty list (slice deletion). +Return 0 on success, -1 on failure. Negative indices, as when +slicing from Python, are not supported.

    +
    + +
    +
    +int PyList_Sort(PyObject *list)
    +

    Sort the items of list in place. Return 0 on success, -1 on +failure. This is equivalent to list.sort().

    +
    + +
    +
    +int PyList_Reverse(PyObject *list)
    +

    Reverse the items of list in place. Return 0 on success, -1 on +failure. This is the equivalent of list.reverse().

    +
    + +
    +
    +PyObject* PyList_AsTuple(PyObject *list)
    +
    Return value: New reference.

    Return a new tuple object containing the contents of list; equivalent to +tuple(list).

    +
    + +
    +
    +int PyList_ClearFreeList()
    +

    Clear the free list. Return the total number of freed items.

    +
    +

    New in version 3.3.

    +
    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/long.html b/python-3.7.4-docs-html/c-api/long.html new file mode 100644 index 0000000..8695d9c --- /dev/null +++ b/python-3.7.4-docs-html/c-api/long.html @@ -0,0 +1,452 @@ + + + + + + + Integer Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Integer Objects

    +

    All integers are implemented as “long” integer objects of arbitrary size.

    +

    On error, most PyLong_As* APIs return (return type)-1 which cannot be +distinguished from a number. Use PyErr_Occurred() to disambiguate.

    +
    +
    +PyLongObject
    +

    This subtype of PyObject represents a Python integer object.

    +
    + +
    +
    +PyTypeObject PyLong_Type
    +

    This instance of PyTypeObject represents the Python integer type. +This is the same object as int in the Python layer.

    +
    + +
    +
    +int PyLong_Check(PyObject *p)
    +

    Return true if its argument is a PyLongObject or a subtype of +PyLongObject.

    +
    + +
    +
    +int PyLong_CheckExact(PyObject *p)
    +

    Return true if its argument is a PyLongObject, but not a subtype of +PyLongObject.

    +
    + +
    +
    +PyObject* PyLong_FromLong(long v)
    +
    Return value: New reference.

    Return a new PyLongObject object from v, or NULL on failure.

    +

    The current implementation keeps an array of integer objects for all integers +between -5 and 256, when you create an int in that range you actually +just get back a reference to the existing object. So it should be possible to +change the value of 1. I suspect the behaviour of Python in this case is +undefined. :-)

    +
    + +
    +
    +PyObject* PyLong_FromUnsignedLong(unsigned long v)
    +
    Return value: New reference.

    Return a new PyLongObject object from a C unsigned long, or +NULL on failure.

    +
    + +
    +
    +PyObject* PyLong_FromSsize_t(Py_ssize_t v)
    +
    Return value: New reference.

    Return a new PyLongObject object from a C Py_ssize_t, or +NULL on failure.

    +
    + +
    +
    +PyObject* PyLong_FromSize_t(size_t v)
    +
    Return value: New reference.

    Return a new PyLongObject object from a C size_t, or +NULL on failure.

    +
    + +
    +
    +PyObject* PyLong_FromLongLong(long long v)
    +
    Return value: New reference.

    Return a new PyLongObject object from a C long long, or NULL +on failure.

    +
    + +
    +
    +PyObject* PyLong_FromUnsignedLongLong(unsigned long long v)
    +
    Return value: New reference.

    Return a new PyLongObject object from a C unsigned long long, +or NULL on failure.

    +
    + +
    +
    +PyObject* PyLong_FromDouble(double v)
    +
    Return value: New reference.

    Return a new PyLongObject object from the integer part of v, or +NULL on failure.

    +
    + +
    +
    +PyObject* PyLong_FromString(const char *str, char **pend, int base)
    +
    Return value: New reference.

    Return a new PyLongObject based on the string value in str, which +is interpreted according to the radix in base. If pend is non-NULL, +*pend will point to the first character in str which follows the +representation of the number. If base is 0, str is interpreted using +the Integer literals definition; in this case, leading zeros in a +non-zero decimal number raises a ValueError. If base is not 0, +it must be between 2 and 36, inclusive. Leading spaces and single +underscores after a base specifier and between digits are ignored. If there +are no digits, ValueError will be raised.

    +
    + +
    +
    +PyObject* PyLong_FromUnicode(Py_UNICODE *u, Py_ssize_t length, int base)
    +
    Return value: New reference.

    Convert a sequence of Unicode digits to a Python integer value. The Unicode +string is first encoded to a byte string using PyUnicode_EncodeDecimal() +and then converted using PyLong_FromString().

    +
    +

    Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Py_UNICODE API; please migrate to using +PyLong_FromUnicodeObject().

    +
    +
    + +
    +
    +PyObject* PyLong_FromUnicodeObject(PyObject *u, int base)
    +
    Return value: New reference.

    Convert a sequence of Unicode digits in the string u to a Python integer +value. The Unicode string is first encoded to a byte string using +PyUnicode_EncodeDecimal() and then converted using +PyLong_FromString().

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +PyObject* PyLong_FromVoidPtr(void *p)
    +
    Return value: New reference.

    Create a Python integer from the pointer p. The pointer value can be +retrieved from the resulting value using PyLong_AsVoidPtr().

    +
    + +
    +
    +long PyLong_AsLong(PyObject *obj)
    +

    Return a C long representation of obj. If obj is not an +instance of PyLongObject, first call its __int__() method +(if present) to convert it to a PyLongObject.

    +

    Raise OverflowError if the value of obj is out of range for a +long.

    +

    Returns -1 on error. Use PyErr_Occurred() to disambiguate.

    +
    + +
    +
    +long PyLong_AsLongAndOverflow(PyObject *obj, int *overflow)
    +

    Return a C long representation of obj. If obj is not an +instance of PyLongObject, first call its __int__() method +(if present) to convert it to a PyLongObject.

    +

    If the value of obj is greater than LONG_MAX or less than +LONG_MIN, set *overflow to 1 or -1, respectively, and +return -1; otherwise, set *overflow to 0. If any other exception +occurs set *overflow to 0 and return -1 as usual.

    +

    Returns -1 on error. Use PyErr_Occurred() to disambiguate.

    +
    + +
    +
    +long long PyLong_AsLongLong(PyObject *obj)
    +

    Return a C long long representation of obj. If obj is not an +instance of PyLongObject, first call its __int__() method +(if present) to convert it to a PyLongObject.

    +

    Raise OverflowError if the value of obj is out of range for a +long.

    +

    Returns -1 on error. Use PyErr_Occurred() to disambiguate.

    +
    + +
    +
    +long long PyLong_AsLongLongAndOverflow(PyObject *obj, int *overflow)
    +

    Return a C long long representation of obj. If obj is not an +instance of PyLongObject, first call its __int__() method +(if present) to convert it to a PyLongObject.

    +

    If the value of obj is greater than PY_LLONG_MAX or less than +PY_LLONG_MIN, set *overflow to 1 or -1, respectively, +and return -1; otherwise, set *overflow to 0. If any other +exception occurs set *overflow to 0 and return -1 as usual.

    +

    Returns -1 on error. Use PyErr_Occurred() to disambiguate.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +Py_ssize_t PyLong_AsSsize_t(PyObject *pylong)
    +

    Return a C Py_ssize_t representation of pylong. pylong must +be an instance of PyLongObject.

    +

    Raise OverflowError if the value of pylong is out of range for a +Py_ssize_t.

    +

    Returns -1 on error. Use PyErr_Occurred() to disambiguate.

    +
    + +
    +
    +unsigned long PyLong_AsUnsignedLong(PyObject *pylong)
    +

    Return a C unsigned long representation of pylong. pylong +must be an instance of PyLongObject.

    +

    Raise OverflowError if the value of pylong is out of range for a +unsigned long.

    +

    Returns (unsigned long)-1 on error. +Use PyErr_Occurred() to disambiguate.

    +
    + +
    +
    +size_t PyLong_AsSize_t(PyObject *pylong)
    +

    Return a C size_t representation of pylong. pylong must be +an instance of PyLongObject.

    +

    Raise OverflowError if the value of pylong is out of range for a +size_t.

    +

    Returns (size_t)-1 on error. +Use PyErr_Occurred() to disambiguate.

    +
    + +
    +
    +unsigned long long PyLong_AsUnsignedLongLong(PyObject *pylong)
    +

    Return a C unsigned long long representation of pylong. pylong +must be an instance of PyLongObject.

    +

    Raise OverflowError if the value of pylong is out of range for an +unsigned long long.

    +

    Returns (unsigned long long)-1 on error. +Use PyErr_Occurred() to disambiguate.

    +
    +

    Changed in version 3.1: A negative pylong now raises OverflowError, not TypeError.

    +
    +
    + +
    +
    +unsigned long PyLong_AsUnsignedLongMask(PyObject *obj)
    +

    Return a C unsigned long representation of obj. If obj +is not an instance of PyLongObject, first call its __int__() +method (if present) to convert it to a PyLongObject.

    +

    If the value of obj is out of range for an unsigned long, +return the reduction of that value modulo ULONG_MAX + 1.

    +

    Returns (unsigned long)-1 on error. Use PyErr_Occurred() to +disambiguate.

    +
    + +
    +
    +unsigned long long PyLong_AsUnsignedLongLongMask(PyObject *obj)
    +

    Return a C unsigned long long representation of obj. If obj +is not an instance of PyLongObject, first call its __int__() +method (if present) to convert it to a PyLongObject.

    +

    If the value of obj is out of range for an unsigned long long, +return the reduction of that value modulo PY_ULLONG_MAX + 1.

    +

    Returns (unsigned long long)-1 on error. Use PyErr_Occurred() +to disambiguate.

    +
    + +
    +
    +double PyLong_AsDouble(PyObject *pylong)
    +

    Return a C double representation of pylong. pylong must be +an instance of PyLongObject.

    +

    Raise OverflowError if the value of pylong is out of range for a +double.

    +

    Returns -1.0 on error. Use PyErr_Occurred() to disambiguate.

    +
    + +
    +
    +void* PyLong_AsVoidPtr(PyObject *pylong)
    +

    Convert a Python integer pylong to a C void pointer. +If pylong cannot be converted, an OverflowError will be raised. This +is only assured to produce a usable void pointer for values created +with PyLong_FromVoidPtr().

    +

    Returns NULL on error. Use PyErr_Occurred() to disambiguate.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/mapping.html b/python-3.7.4-docs-html/c-api/mapping.html new file mode 100644 index 0000000..3db0564 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/mapping.html @@ -0,0 +1,287 @@ + + + + + + + Mapping Protocol — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Mapping Protocol

    +

    See also PyObject_GetItem(), PyObject_SetItem() and +PyObject_DelItem().

    +
    +
    +int PyMapping_Check(PyObject *o)
    +

    Return 1 if the object provides mapping protocol or supports slicing, +and 0 otherwise. Note that it returns 1 for Python classes with +a __getitem__() method since in general case it is impossible to +determine what the type of keys it supports. This function always +succeeds.

    +
    + +
    +
    +Py_ssize_t PyMapping_Size(PyObject *o)
    +
    +Py_ssize_t PyMapping_Length(PyObject *o)
    +

    Returns the number of keys in object o on success, and -1 on failure. +This is equivalent to the Python expression len(o).

    +
    + +
    +
    +PyObject* PyMapping_GetItemString(PyObject *o, const char *key)
    +
    Return value: New reference.

    Return element of o corresponding to the string key or NULL on failure. +This is the equivalent of the Python expression o[key]. +See also PyObject_GetItem().

    +
    + +
    +
    +int PyMapping_SetItemString(PyObject *o, const char *key, PyObject *v)
    +

    Map the string key to the value v in object o. Returns -1 on +failure. This is the equivalent of the Python statement o[key] = v. +See also PyObject_SetItem().

    +
    + +
    +
    +int PyMapping_DelItem(PyObject *o, PyObject *key)
    +

    Remove the mapping for the object key from the object o. Return -1 +on failure. This is equivalent to the Python statement del o[key]. +This is an alias of PyObject_DelItem().

    +
    + +
    +
    +int PyMapping_DelItemString(PyObject *o, const char *key)
    +

    Remove the mapping for the string key from the object o. Return -1 +on failure. This is equivalent to the Python statement del o[key].

    +
    + +
    +
    +int PyMapping_HasKey(PyObject *o, PyObject *key)
    +

    Return 1 if the mapping object has the key key and 0 otherwise. +This is equivalent to the Python expression key in o. +This function always succeeds.

    +

    Note that exceptions which occur while calling the __getitem__() +method will get suppressed. +To get error reporting use PyObject_GetItem() instead.

    +
    + +
    +
    +int PyMapping_HasKeyString(PyObject *o, const char *key)
    +

    Return 1 if the mapping object has the key key and 0 otherwise. +This is equivalent to the Python expression key in o. +This function always succeeds.

    +

    Note that exceptions which occur while calling the __getitem__() +method and creating a temporary string object will get suppressed. +To get error reporting use PyMapping_GetItemString() instead.

    +
    + +
    +
    +PyObject* PyMapping_Keys(PyObject *o)
    +
    Return value: New reference.

    On success, return a list of the keys in object o. On failure, return +NULL.

    +
    +

    Changed in version 3.7: Previously, the function returned a list or a tuple.

    +
    +
    + +
    +
    +PyObject* PyMapping_Values(PyObject *o)
    +
    Return value: New reference.

    On success, return a list of the values in object o. On failure, return +NULL.

    +
    +

    Changed in version 3.7: Previously, the function returned a list or a tuple.

    +
    +
    + +
    +
    +PyObject* PyMapping_Items(PyObject *o)
    +
    Return value: New reference.

    On success, return a list of the items in object o, where each item is a +tuple containing a key-value pair. On failure, return NULL.

    +
    +

    Changed in version 3.7: Previously, the function returned a list or a tuple.

    +
    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/marshal.html b/python-3.7.4-docs-html/c-api/marshal.html new file mode 100644 index 0000000..697550c --- /dev/null +++ b/python-3.7.4-docs-html/c-api/marshal.html @@ -0,0 +1,268 @@ + + + + + + + Data marshalling support — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Data marshalling support

    +

    These routines allow C code to work with serialized objects using the same +data format as the marshal module. There are functions to write data +into the serialization format, and additional functions that can be used to +read the data back. Files used to store marshalled data must be opened in +binary mode.

    +

    Numeric values are stored with the least significant byte first.

    +

    The module supports two versions of the data format: version 0 is the +historical version, version 1 shares interned strings in the file, and upon +unmarshalling. Version 2 uses a binary format for floating point numbers. +Py_MARSHAL_VERSION indicates the current file format (currently 2).

    +
    +
    +void PyMarshal_WriteLongToFile(long value, FILE *file, int version)
    +

    Marshal a long integer, value, to file. This will only write +the least-significant 32 bits of value; regardless of the size of the +native long type. version indicates the file format.

    +
    + +
    +
    +void PyMarshal_WriteObjectToFile(PyObject *value, FILE *file, int version)
    +

    Marshal a Python object, value, to file. +version indicates the file format.

    +
    + +
    +
    +PyObject* PyMarshal_WriteObjectToString(PyObject *value, int version)
    +
    Return value: New reference.

    Return a bytes object containing the marshalled representation of value. +version indicates the file format.

    +
    + +

    The following functions allow marshalled values to be read back in.

    +
    +
    +long PyMarshal_ReadLongFromFile(FILE *file)
    +

    Return a C long from the data stream in a FILE* opened +for reading. Only a 32-bit value can be read in using this function, +regardless of the native size of long.

    +

    On error, sets the appropriate exception (EOFError) and returns +-1.

    +
    + +
    +
    +int PyMarshal_ReadShortFromFile(FILE *file)
    +

    Return a C short from the data stream in a FILE* opened +for reading. Only a 16-bit value can be read in using this function, +regardless of the native size of short.

    +

    On error, sets the appropriate exception (EOFError) and returns +-1.

    +
    + +
    +
    +PyObject* PyMarshal_ReadObjectFromFile(FILE *file)
    +
    Return value: New reference.

    Return a Python object from the data stream in a FILE* opened for +reading.

    +

    On error, sets the appropriate exception (EOFError, ValueError +or TypeError) and returns NULL.

    +
    + +
    +
    +PyObject* PyMarshal_ReadLastObjectFromFile(FILE *file)
    +
    Return value: New reference.

    Return a Python object from the data stream in a FILE* opened for +reading. Unlike PyMarshal_ReadObjectFromFile(), this function +assumes that no further objects will be read from the file, allowing it to +aggressively load file data into memory so that the de-serialization can +operate from data in memory rather than reading a byte at a time from the +file. Only use these variant if you are certain that you won’t be reading +anything else from the file.

    +

    On error, sets the appropriate exception (EOFError, ValueError +or TypeError) and returns NULL.

    +
    + +
    +
    +PyObject* PyMarshal_ReadObjectFromString(const char *data, Py_ssize_t len)
    +
    Return value: New reference.

    Return a Python object from the data stream in a byte buffer +containing len bytes pointed to by data.

    +

    On error, sets the appropriate exception (EOFError, ValueError +or TypeError) and returns NULL.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/memory.html b/python-3.7.4-docs-html/c-api/memory.html new file mode 100644 index 0000000..b87b9e1 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/memory.html @@ -0,0 +1,814 @@ + + + + + + + Memory Management — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Memory Management

    +
    +

    Overview

    +

    Memory management in Python involves a private heap containing all Python +objects and data structures. The management of this private heap is ensured +internally by the Python memory manager. The Python memory manager has +different components which deal with various dynamic storage management aspects, +like sharing, segmentation, preallocation or caching.

    +

    At the lowest level, a raw memory allocator ensures that there is enough room in +the private heap for storing all Python-related data by interacting with the +memory manager of the operating system. On top of the raw memory allocator, +several object-specific allocators operate on the same heap and implement +distinct memory management policies adapted to the peculiarities of every object +type. For example, integer objects are managed differently within the heap than +strings, tuples or dictionaries because integers imply different storage +requirements and speed/space tradeoffs. The Python memory manager thus delegates +some of the work to the object-specific allocators, but ensures that the latter +operate within the bounds of the private heap.

    +

    It is important to understand that the management of the Python heap is +performed by the interpreter itself and that the user has no control over it, +even if they regularly manipulate object pointers to memory blocks inside that +heap. The allocation of heap space for Python objects and other internal +buffers is performed on demand by the Python memory manager through the Python/C +API functions listed in this document.

    +

    To avoid memory corruption, extension writers should never try to operate on +Python objects with the functions exported by the C library: malloc(), +calloc(), realloc() and free(). This will result in mixed +calls between the C allocator and the Python memory manager with fatal +consequences, because they implement different algorithms and operate on +different heaps. However, one may safely allocate and release memory blocks +with the C library allocator for individual purposes, as shown in the following +example:

    +
    PyObject *res;
    +char *buf = (char *) malloc(BUFSIZ); /* for I/O */
    +
    +if (buf == NULL)
    +    return PyErr_NoMemory();
    +...Do some I/O operation involving buf...
    +res = PyBytes_FromString(buf);
    +free(buf); /* malloc'ed */
    +return res;
    +
    +
    +

    In this example, the memory request for the I/O buffer is handled by the C +library allocator. The Python memory manager is involved only in the allocation +of the bytes object returned as a result.

    +

    In most situations, however, it is recommended to allocate memory from the +Python heap specifically because the latter is under control of the Python +memory manager. For example, this is required when the interpreter is extended +with new object types written in C. Another reason for using the Python heap is +the desire to inform the Python memory manager about the memory needs of the +extension module. Even when the requested memory is used exclusively for +internal, highly-specific purposes, delegating all memory requests to the Python +memory manager causes the interpreter to have a more accurate image of its +memory footprint as a whole. Consequently, under certain circumstances, the +Python memory manager may or may not trigger appropriate actions, like garbage +collection, memory compaction or other preventive procedures. Note that by using +the C library allocator as shown in the previous example, the allocated memory +for the I/O buffer escapes completely the Python memory manager.

    +
    +

    See also

    +

    The PYTHONMALLOC environment variable can be used to configure +the memory allocators used by Python.

    +

    The PYTHONMALLOCSTATS environment variable can be used to print +statistics of the pymalloc memory allocator every time a +new pymalloc object arena is created, and on shutdown.

    +
    +
    +
    +

    Raw Memory Interface

    +

    The following function sets are wrappers to the system allocator. These +functions are thread-safe, the GIL does not +need to be held.

    +

    The default raw memory allocator uses +the following functions: malloc(), calloc(), realloc() +and free(); call malloc(1) (or calloc(1, 1)) when requesting +zero bytes.

    +
    +

    New in version 3.4.

    +
    +
    +
    +void* PyMem_RawMalloc(size_t n)
    +

    Allocates n bytes and returns a pointer of type void* to the +allocated memory, or NULL if the request fails.

    +

    Requesting zero bytes returns a distinct non-NULL pointer if possible, as +if PyMem_RawMalloc(1) had been called instead. The memory will not have +been initialized in any way.

    +
    + +
    +
    +void* PyMem_RawCalloc(size_t nelem, size_t elsize)
    +

    Allocates nelem elements each whose size in bytes is elsize and returns +a pointer of type void* to the allocated memory, or NULL if the +request fails. The memory is initialized to zeros.

    +

    Requesting zero elements or elements of size zero bytes returns a distinct +non-NULL pointer if possible, as if PyMem_RawCalloc(1, 1) had been +called instead.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +void* PyMem_RawRealloc(void *p, size_t n)
    +

    Resizes the memory block pointed to by p to n bytes. The contents will +be unchanged to the minimum of the old and the new sizes.

    +

    If p is NULL, the call is equivalent to PyMem_RawMalloc(n); else if +n is equal to zero, the memory block is resized but is not freed, and the +returned pointer is non-NULL.

    +

    Unless p is NULL, it must have been returned by a previous call to +PyMem_RawMalloc(), PyMem_RawRealloc() or +PyMem_RawCalloc().

    +

    If the request fails, PyMem_RawRealloc() returns NULL and p +remains a valid pointer to the previous memory area.

    +
    + +
    +
    +void PyMem_RawFree(void *p)
    +

    Frees the memory block pointed to by p, which must have been returned by a +previous call to PyMem_RawMalloc(), PyMem_RawRealloc() or +PyMem_RawCalloc(). Otherwise, or if PyMem_RawFree(p) has been +called before, undefined behavior occurs.

    +

    If p is NULL, no operation is performed.

    +
    + +
    +
    +

    Memory Interface

    +

    The following function sets, modeled after the ANSI C standard, but specifying +behavior when requesting zero bytes, are available for allocating and releasing +memory from the Python heap.

    +

    The default memory allocator uses the +pymalloc memory allocator.

    +
    +

    Warning

    +

    The GIL must be held when using these +functions.

    +
    +
    +

    Changed in version 3.6: The default allocator is now pymalloc instead of system malloc().

    +
    +
    +
    +void* PyMem_Malloc(size_t n)
    +

    Allocates n bytes and returns a pointer of type void* to the +allocated memory, or NULL if the request fails.

    +

    Requesting zero bytes returns a distinct non-NULL pointer if possible, as +if PyMem_Malloc(1) had been called instead. The memory will not have +been initialized in any way.

    +
    + +
    +
    +void* PyMem_Calloc(size_t nelem, size_t elsize)
    +

    Allocates nelem elements each whose size in bytes is elsize and returns +a pointer of type void* to the allocated memory, or NULL if the +request fails. The memory is initialized to zeros.

    +

    Requesting zero elements or elements of size zero bytes returns a distinct +non-NULL pointer if possible, as if PyMem_Calloc(1, 1) had been called +instead.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +void* PyMem_Realloc(void *p, size_t n)
    +

    Resizes the memory block pointed to by p to n bytes. The contents will be +unchanged to the minimum of the old and the new sizes.

    +

    If p is NULL, the call is equivalent to PyMem_Malloc(n); else if n +is equal to zero, the memory block is resized but is not freed, and the +returned pointer is non-NULL.

    +

    Unless p is NULL, it must have been returned by a previous call to +PyMem_Malloc(), PyMem_Realloc() or PyMem_Calloc().

    +

    If the request fails, PyMem_Realloc() returns NULL and p remains +a valid pointer to the previous memory area.

    +
    + +
    +
    +void PyMem_Free(void *p)
    +

    Frees the memory block pointed to by p, which must have been returned by a +previous call to PyMem_Malloc(), PyMem_Realloc() or +PyMem_Calloc(). Otherwise, or if PyMem_Free(p) has been called +before, undefined behavior occurs.

    +

    If p is NULL, no operation is performed.

    +
    + +

    The following type-oriented macros are provided for convenience. Note that +TYPE refers to any C type.

    +
    +
    +TYPE* PyMem_New(TYPE, size_t n)
    +

    Same as PyMem_Malloc(), but allocates (n * sizeof(TYPE)) bytes of +memory. Returns a pointer cast to TYPE*. The memory will not have +been initialized in any way.

    +
    + +
    +
    +TYPE* PyMem_Resize(void *p, TYPE, size_t n)
    +

    Same as PyMem_Realloc(), but the memory block is resized to (n * +sizeof(TYPE)) bytes. Returns a pointer cast to TYPE*. On return, +p will be a pointer to the new memory area, or NULL in the event of +failure.

    +

    This is a C preprocessor macro; p is always reassigned. Save the original +value of p to avoid losing memory when handling errors.

    +
    + +
    +
    +void PyMem_Del(void *p)
    +

    Same as PyMem_Free().

    +
    + +

    In addition, the following macro sets are provided for calling the Python memory +allocator directly, without involving the C API functions listed above. However, +note that their use does not preserve binary compatibility across Python +versions and is therefore deprecated in extension modules.

    +
      +
    • PyMem_MALLOC(size)

    • +
    • PyMem_NEW(type, size)

    • +
    • PyMem_REALLOC(ptr, size)

    • +
    • PyMem_RESIZE(ptr, type, size)

    • +
    • PyMem_FREE(ptr)

    • +
    • PyMem_DEL(ptr)

    • +
    +
    +
    +

    Object allocators

    +

    The following function sets, modeled after the ANSI C standard, but specifying +behavior when requesting zero bytes, are available for allocating and releasing +memory from the Python heap.

    +

    The default object allocator uses the +pymalloc memory allocator.

    +
    +

    Warning

    +

    The GIL must be held when using these +functions.

    +
    +
    +
    +void* PyObject_Malloc(size_t n)
    +

    Allocates n bytes and returns a pointer of type void* to the +allocated memory, or NULL if the request fails.

    +

    Requesting zero bytes returns a distinct non-NULL pointer if possible, as +if PyObject_Malloc(1) had been called instead. The memory will not have +been initialized in any way.

    +
    + +
    +
    +void* PyObject_Calloc(size_t nelem, size_t elsize)
    +

    Allocates nelem elements each whose size in bytes is elsize and returns +a pointer of type void* to the allocated memory, or NULL if the +request fails. The memory is initialized to zeros.

    +

    Requesting zero elements or elements of size zero bytes returns a distinct +non-NULL pointer if possible, as if PyObject_Calloc(1, 1) had been called +instead.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +void* PyObject_Realloc(void *p, size_t n)
    +

    Resizes the memory block pointed to by p to n bytes. The contents will be +unchanged to the minimum of the old and the new sizes.

    +

    If p is NULL, the call is equivalent to PyObject_Malloc(n); else if n +is equal to zero, the memory block is resized but is not freed, and the +returned pointer is non-NULL.

    +

    Unless p is NULL, it must have been returned by a previous call to +PyObject_Malloc(), PyObject_Realloc() or PyObject_Calloc().

    +

    If the request fails, PyObject_Realloc() returns NULL and p remains +a valid pointer to the previous memory area.

    +
    + +
    +
    +void PyObject_Free(void *p)
    +

    Frees the memory block pointed to by p, which must have been returned by a +previous call to PyObject_Malloc(), PyObject_Realloc() or +PyObject_Calloc(). Otherwise, or if PyObject_Free(p) has been called +before, undefined behavior occurs.

    +

    If p is NULL, no operation is performed.

    +
    + +
    +
    +

    Default Memory Allocators

    +

    Default memory allocators:

    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Configuration

    Name

    PyMem_RawMalloc

    PyMem_Malloc

    PyObject_Malloc

    Release build

    "pymalloc"

    malloc

    pymalloc

    pymalloc

    Debug build

    "pymalloc_debug"

    malloc + debug

    pymalloc + debug

    pymalloc + debug

    Release build, without pymalloc

    "malloc"

    malloc

    malloc

    malloc

    Debug build, without pymalloc

    "malloc_debug"

    malloc + debug

    malloc + debug

    malloc + debug

    +

    Legend:

    + +
    +
    +

    Customize Memory Allocators

    +
    +

    New in version 3.4.

    +
    +
    +
    +PyMemAllocatorEx
    +

    Structure used to describe a memory block allocator. The structure has +four fields:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + +

    Field

    Meaning

    void *ctx

    user context passed as first argument

    void* malloc(void *ctx, size_t size)

    allocate a memory block

    void* calloc(void *ctx, size_t nelem, size_t elsize)

    allocate a memory block initialized +with zeros

    void* realloc(void *ctx, void *ptr, size_t new_size)

    allocate or resize a memory block

    void free(void *ctx, void *ptr)

    free a memory block

    +
    +

    Changed in version 3.5: The PyMemAllocator structure was renamed to +PyMemAllocatorEx and a new calloc field was added.

    +
    +
    + +
    +
    +PyMemAllocatorDomain
    +

    Enum used to identify an allocator domain. Domains:

    +
    +
    +PYMEM_DOMAIN_RAW
    +

    Functions:

    + +
    + +
    +
    +PYMEM_DOMAIN_MEM
    +

    Functions:

    + +
    + +
    +
    +PYMEM_DOMAIN_OBJ
    +

    Functions:

    + +
    + +
    + +
    +
    +void PyMem_GetAllocator(PyMemAllocatorDomain domain, PyMemAllocatorEx *allocator)
    +

    Get the memory block allocator of the specified domain.

    +
    + +
    +
    +void PyMem_SetAllocator(PyMemAllocatorDomain domain, PyMemAllocatorEx *allocator)
    +

    Set the memory block allocator of the specified domain.

    +

    The new allocator must return a distinct non-NULL pointer when requesting +zero bytes.

    +

    For the PYMEM_DOMAIN_RAW domain, the allocator must be +thread-safe: the GIL is not held when the +allocator is called.

    +

    If the new allocator is not a hook (does not call the previous allocator), +the PyMem_SetupDebugHooks() function must be called to reinstall the +debug hooks on top on the new allocator.

    +
    + +
    +
    +void PyMem_SetupDebugHooks(void)
    +

    Setup hooks to detect bugs in the Python memory allocator functions.

    +

    Newly allocated memory is filled with the byte 0xCD (CLEANBYTE), +freed memory is filled with the byte 0xDD (DEADBYTE). Memory blocks +are surrounded by “forbidden bytes” (FORBIDDENBYTE: byte 0xFD).

    +

    Runtime checks:

    + +

    On error, the debug hooks use the tracemalloc module to get the +traceback where a memory block was allocated. The traceback is only +displayed if tracemalloc is tracing Python memory allocations and the +memory block was traced.

    +

    These hooks are installed by default if +Python is compiled in debug +mode. The PYTHONMALLOC environment variable can be used to install +debug hooks on a Python compiled in release mode.

    +
    +

    Changed in version 3.6: This function now also works on Python compiled in release mode. +On error, the debug hooks now use tracemalloc to get the traceback +where a memory block was allocated. The debug hooks now also check +if the GIL is held when functions of PYMEM_DOMAIN_OBJ and +PYMEM_DOMAIN_MEM domains are called.

    +
    +
    +

    Changed in version 3.7.3: Byte patterns 0xCB (CLEANBYTE), 0xDB (DEADBYTE) and +0xFB (FORBIDDENBYTE) have been replaced with 0xCD, 0xDD +and 0xFD to use the same values than Windows CRT debug malloc() +and free().

    +
    +
    + +
    +
    +

    The pymalloc allocator

    +

    Python has a pymalloc allocator optimized for small objects (smaller or equal +to 512 bytes) with a short lifetime. It uses memory mappings called “arenas” +with a fixed size of 256 KiB. It falls back to PyMem_RawMalloc() and +PyMem_RawRealloc() for allocations larger than 512 bytes.

    +

    pymalloc is the default allocator of the +PYMEM_DOMAIN_MEM (ex: PyMem_Malloc()) and +PYMEM_DOMAIN_OBJ (ex: PyObject_Malloc()) domains.

    +

    The arena allocator uses the following functions:

    +
      +
    • VirtualAlloc() and VirtualFree() on Windows,

    • +
    • mmap() and munmap() if available,

    • +
    • malloc() and free() otherwise.

    • +
    +
    +

    Customize pymalloc Arena Allocator

    +
    +

    New in version 3.4.

    +
    +
    +
    +PyObjectArenaAllocator
    +

    Structure used to describe an arena allocator. The structure has +three fields:

    + ++++ + + + + + + + + + + + + + + + + +

    Field

    Meaning

    void *ctx

    user context passed as first argument

    void* alloc(void *ctx, size_t size)

    allocate an arena of size bytes

    void free(void *ctx, size_t size, void *ptr)

    free an arena

    +
    + +
    +
    +PyObject_GetArenaAllocator(PyObjectArenaAllocator *allocator)
    +

    Get the arena allocator.

    +
    + +
    +
    +PyObject_SetArenaAllocator(PyObjectArenaAllocator *allocator)
    +

    Set the arena allocator.

    +
    + +
    +
    +
    +

    tracemalloc C API

    +
    +

    New in version 3.7.

    +
    +
    +
    +

    Examples

    +

    Here is the example from section Overview, rewritten so that the +I/O buffer is allocated from the Python heap by using the first function set:

    +
    PyObject *res;
    +char *buf = (char *) PyMem_Malloc(BUFSIZ); /* for I/O */
    +
    +if (buf == NULL)
    +    return PyErr_NoMemory();
    +/* ...Do some I/O operation involving buf... */
    +res = PyBytes_FromString(buf);
    +PyMem_Free(buf); /* allocated with PyMem_Malloc */
    +return res;
    +
    +
    +

    The same code using the type-oriented function set:

    +
    PyObject *res;
    +char *buf = PyMem_New(char, BUFSIZ); /* for I/O */
    +
    +if (buf == NULL)
    +    return PyErr_NoMemory();
    +/* ...Do some I/O operation involving buf... */
    +res = PyBytes_FromString(buf);
    +PyMem_Del(buf); /* allocated with PyMem_New */
    +return res;
    +
    +
    +

    Note that in the two examples above, the buffer is always manipulated via +functions belonging to the same set. Indeed, it is required to use the same +memory API family for a given memory block, so that the risk of mixing different +allocators is reduced to a minimum. The following code sequence contains two +errors, one of which is labeled as fatal because it mixes two different +allocators operating on different heaps.

    +
    char *buf1 = PyMem_New(char, BUFSIZ);
    +char *buf2 = (char *) malloc(BUFSIZ);
    +char *buf3 = (char *) PyMem_Malloc(BUFSIZ);
    +...
    +PyMem_Del(buf3);  /* Wrong -- should be PyMem_Free() */
    +free(buf2);       /* Right -- allocated via malloc() */
    +free(buf1);       /* Fatal -- should be PyMem_Del()  */
    +
    +
    +

    In addition to the functions aimed at handling raw memory blocks from the Python +heap, objects in Python are allocated and released with PyObject_New(), +PyObject_NewVar() and PyObject_Del().

    +

    These will be explained in the next chapter on defining and implementing new +object types in C.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/memoryview.html b/python-3.7.4-docs-html/c-api/memoryview.html new file mode 100644 index 0000000..7fa899c --- /dev/null +++ b/python-3.7.4-docs-html/c-api/memoryview.html @@ -0,0 +1,246 @@ + + + + + + + MemoryView objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    MemoryView objects

    +

    A memoryview object exposes the C level buffer interface as a Python object which can then be passed around like +any other object.

    +
    +
    +PyObject *PyMemoryView_FromObject(PyObject *obj)
    +
    Return value: New reference.

    Create a memoryview object from an object that provides the buffer interface. +If obj supports writable buffer exports, the memoryview object will be +read/write, otherwise it may be either read-only or read/write at the +discretion of the exporter.

    +
    + +
    +
    +PyObject *PyMemoryView_FromMemory(char *mem, Py_ssize_t size, int flags)
    +
    Return value: New reference.

    Create a memoryview object using mem as the underlying buffer. +flags can be one of PyBUF_READ or PyBUF_WRITE.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +PyObject *PyMemoryView_FromBuffer(Py_buffer *view)
    +
    Return value: New reference.

    Create a memoryview object wrapping the given buffer structure view. +For simple byte buffers, PyMemoryView_FromMemory() is the preferred +function.

    +
    + +
    +
    +PyObject *PyMemoryView_GetContiguous(PyObject *obj, int buffertype, char order)
    +
    Return value: New reference.

    Create a memoryview object to a contiguous chunk of memory (in either +‘C’ or ‘F’ortran order) from an object that defines the buffer +interface. If memory is contiguous, the memoryview object points to the +original memory. Otherwise, a copy is made and the memoryview points to a +new bytes object.

    +
    + +
    +
    +int PyMemoryView_Check(PyObject *obj)
    +

    Return true if the object obj is a memoryview object. It is not +currently allowed to create subclasses of memoryview.

    +
    + +
    +
    +Py_buffer *PyMemoryView_GET_BUFFER(PyObject *mview)
    +

    Return a pointer to the memoryview’s private copy of the exporter’s buffer. +mview must be a memoryview instance; this macro doesn’t check its type, +you must do it yourself or you will risk crashes.

    +
    + +
    +
    +Py_buffer *PyMemoryView_GET_BASE(PyObject *mview)
    +

    Return either a pointer to the exporting object that the memoryview is based +on or NULL if the memoryview has been created by one of the functions +PyMemoryView_FromMemory() or PyMemoryView_FromBuffer(). +mview must be a memoryview instance.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/method.html b/python-3.7.4-docs-html/c-api/method.html new file mode 100644 index 0000000..bdc0c08 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/method.html @@ -0,0 +1,284 @@ + + + + + + + Instance Method Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Instance Method Objects

    +

    An instance method is a wrapper for a PyCFunction and the new way +to bind a PyCFunction to a class object. It replaces the former call +PyMethod_New(func, NULL, class).

    +
    +
    +PyTypeObject PyInstanceMethod_Type
    +

    This instance of PyTypeObject represents the Python instance +method type. It is not exposed to Python programs.

    +
    + +
    +
    +int PyInstanceMethod_Check(PyObject *o)
    +

    Return true if o is an instance method object (has type +PyInstanceMethod_Type). The parameter must not be NULL.

    +
    + +
    +
    +PyObject* PyInstanceMethod_New(PyObject *func)
    +
    Return value: New reference.

    Return a new instance method object, with func being any callable object +func is the function that will be called when the instance method is +called.

    +
    + +
    +
    +PyObject* PyInstanceMethod_Function(PyObject *im)
    +
    Return value: Borrowed reference.

    Return the function object associated with the instance method im.

    +
    + +
    +
    +PyObject* PyInstanceMethod_GET_FUNCTION(PyObject *im)
    +
    Return value: Borrowed reference.

    Macro version of PyInstanceMethod_Function() which avoids error checking.

    +
    + +
    +
    +

    Method Objects

    +

    Methods are bound function objects. Methods are always bound to an instance of +a user-defined class. Unbound methods (methods bound to a class object) are +no longer available.

    +
    +
    +PyTypeObject PyMethod_Type
    +

    This instance of PyTypeObject represents the Python method type. This +is exposed to Python programs as types.MethodType.

    +
    + +
    +
    +int PyMethod_Check(PyObject *o)
    +

    Return true if o is a method object (has type PyMethod_Type). The +parameter must not be NULL.

    +
    + +
    +
    +PyObject* PyMethod_New(PyObject *func, PyObject *self)
    +
    Return value: New reference.

    Return a new method object, with func being any callable object and self +the instance the method should be bound. func is the function that will +be called when the method is called. self must not be NULL.

    +
    + +
    +
    +PyObject* PyMethod_Function(PyObject *meth)
    +
    Return value: Borrowed reference.

    Return the function object associated with the method meth.

    +
    + +
    +
    +PyObject* PyMethod_GET_FUNCTION(PyObject *meth)
    +
    Return value: Borrowed reference.

    Macro version of PyMethod_Function() which avoids error checking.

    +
    + +
    +
    +PyObject* PyMethod_Self(PyObject *meth)
    +
    Return value: Borrowed reference.

    Return the instance associated with the method meth.

    +
    + +
    +
    +PyObject* PyMethod_GET_SELF(PyObject *meth)
    +
    Return value: Borrowed reference.

    Macro version of PyMethod_Self() which avoids error checking.

    +
    + +
    +
    +int PyMethod_ClearFreeList()
    +

    Clear the free list. Return the total number of freed items.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/module.html b/python-3.7.4-docs-html/c-api/module.html new file mode 100644 index 0000000..a102100 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/module.html @@ -0,0 +1,709 @@ + + + + + + + Module Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Module Objects

    +
    +
    +PyTypeObject PyModule_Type
    +

    This instance of PyTypeObject represents the Python module type. This +is exposed to Python programs as types.ModuleType.

    +
    + +
    +
    +int PyModule_Check(PyObject *p)
    +

    Return true if p is a module object, or a subtype of a module object.

    +
    + +
    +
    +int PyModule_CheckExact(PyObject *p)
    +

    Return true if p is a module object, but not a subtype of +PyModule_Type.

    +
    + +
    +
    +PyObject* PyModule_NewObject(PyObject *name)
    +
    Return value: New reference.

    Return a new module object with the __name__ attribute set to name. +The module’s __name__, __doc__, __package__, and +__loader__ attributes are filled in (all but __name__ are set +to None); the caller is responsible for providing a __file__ +attribute.

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.4: __package__ and __loader__ are set to None.

    +
    +
    + +
    +
    +PyObject* PyModule_New(const char *name)
    +
    Return value: New reference.

    Similar to PyModule_NewObject(), but the name is a UTF-8 encoded +string instead of a Unicode object.

    +
    + +
    +
    +PyObject* PyModule_GetDict(PyObject *module)
    +
    Return value: Borrowed reference.

    Return the dictionary object that implements module’s namespace; this object +is the same as the __dict__ attribute of the module object. +If module is not a module object (or a subtype of a module object), +SystemError is raised and NULL is returned.

    +

    It is recommended extensions use other PyModule_*() and +PyObject_*() functions rather than directly manipulate a module’s +__dict__.

    +
    + +
    +
    +PyObject* PyModule_GetNameObject(PyObject *module)
    +
    Return value: New reference.

    Return module’s __name__ value. If the module does not provide one, +or if it is not a string, SystemError is raised and NULL is returned.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +const char* PyModule_GetName(PyObject *module)
    +

    Similar to PyModule_GetNameObject() but return the name encoded to +'utf-8'.

    +
    + +
    +
    +void* PyModule_GetState(PyObject *module)
    +

    Return the “state” of the module, that is, a pointer to the block of memory +allocated at module creation time, or NULL. See +PyModuleDef.m_size.

    +
    + +
    +
    +PyModuleDef* PyModule_GetDef(PyObject *module)
    +

    Return a pointer to the PyModuleDef struct from which the module was +created, or NULL if the module wasn’t created from a definition.

    +
    + +
    +
    +PyObject* PyModule_GetFilenameObject(PyObject *module)
    +
    Return value: New reference.

    Return the name of the file from which module was loaded using module’s +__file__ attribute. If this is not defined, or if it is not a +unicode string, raise SystemError and return NULL; otherwise return +a reference to a Unicode object.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +const char* PyModule_GetFilename(PyObject *module)
    +

    Similar to PyModule_GetFilenameObject() but return the filename +encoded to ‘utf-8’.

    +
    +

    Deprecated since version 3.2: PyModule_GetFilename() raises UnicodeEncodeError on +unencodable filenames, use PyModule_GetFilenameObject() instead.

    +
    +
    + +
    +

    Initializing C modules

    +

    Modules objects are usually created from extension modules (shared libraries +which export an initialization function), or compiled-in modules +(where the initialization function is added using PyImport_AppendInittab()). +See Building C and C++ Extensions or Extending Embedded Python for details.

    +

    The initialization function can either pass a module definition instance +to PyModule_Create(), and return the resulting module object, +or request “multi-phase initialization” by returning the definition struct itself.

    +
    +
    +PyModuleDef
    +

    The module definition struct, which holds all information needed to create +a module object. There is usually only one statically initialized variable +of this type for each module.

    +
    +
    +PyModuleDef_Base m_base
    +

    Always initialize this member to PyModuleDef_HEAD_INIT.

    +
    + +
    +
    +const char *m_name
    +

    Name for the new module.

    +
    + +
    +
    +const char *m_doc
    +

    Docstring for the module; usually a docstring variable created with +PyDoc_STRVAR() is used.

    +
    + +
    +
    +Py_ssize_t m_size
    +

    Module state may be kept in a per-module memory area that can be +retrieved with PyModule_GetState(), rather than in static globals. +This makes modules safe for use in multiple sub-interpreters.

    +

    This memory area is allocated based on m_size on module creation, +and freed when the module object is deallocated, after the +m_free function has been called, if present.

    +

    Setting m_size to -1 means that the module does not support +sub-interpreters, because it has global state.

    +

    Setting it to a non-negative value means that the module can be +re-initialized and specifies the additional amount of memory it requires +for its state. Non-negative m_size is required for multi-phase +initialization.

    +

    See PEP 3121 for more details.

    +
    + +
    +
    +PyMethodDef* m_methods
    +

    A pointer to a table of module-level functions, described by +PyMethodDef values. Can be NULL if no functions are present.

    +
    + +
    +
    +PyModuleDef_Slot* m_slots
    +

    An array of slot definitions for multi-phase initialization, terminated by +a {0, NULL} entry. +When using single-phase initialization, m_slots must be NULL.

    +
    +

    Changed in version 3.5: Prior to version 3.5, this member was always set to NULL, +and was defined as:

    +
    +
    +
    +inquiry m_reload
    +
    + +
    +
    +
    + +
    +
    +traverseproc m_traverse
    +

    A traversal function to call during GC traversal of the module object, or +NULL if not needed. This function may be called before module state +is allocated (PyModule_GetState() may return NULL), +and before the Py_mod_exec function is executed.

    +
    + +
    +
    +inquiry m_clear
    +

    A clear function to call during GC clearing of the module object, or +NULL if not needed. This function may be called before module state +is allocated (PyModule_GetState() may return NULL), +and before the Py_mod_exec function is executed.

    +
    + +
    +
    +freefunc m_free
    +

    A function to call during deallocation of the module object, or NULL if +not needed. This function may be called before module state +is allocated (PyModule_GetState() may return NULL), +and before the Py_mod_exec function is executed.

    +
    + +
    + +
    +

    Single-phase initialization

    +

    The module initialization function may create and return the module object +directly. This is referred to as “single-phase initialization”, and uses one +of the following two module creation functions:

    +
    +
    +PyObject* PyModule_Create(PyModuleDef *def)
    +
    Return value: New reference.

    Create a new module object, given the definition in def. This behaves +like PyModule_Create2() with module_api_version set to +PYTHON_API_VERSION.

    +
    + +
    +
    +PyObject* PyModule_Create2(PyModuleDef *def, int module_api_version)
    +
    Return value: New reference.

    Create a new module object, given the definition in def, assuming the +API version module_api_version. If that version does not match the version +of the running interpreter, a RuntimeWarning is emitted.

    +
    +

    Note

    +

    Most uses of this function should be using PyModule_Create() +instead; only use this if you are sure you need it.

    +
    +
    + +

    Before it is returned from in the initialization function, the resulting module +object is typically populated using functions like PyModule_AddObject().

    +
    +
    +

    Multi-phase initialization

    +

    An alternate way to specify extensions is to request “multi-phase initialization”. +Extension modules created this way behave more like Python modules: the +initialization is split between the creation phase, when the module object +is created, and the execution phase, when it is populated. +The distinction is similar to the __new__() and __init__() methods +of classes.

    +

    Unlike modules created using single-phase initialization, these modules are not +singletons: if the sys.modules entry is removed and the module is re-imported, +a new module object is created, and the old module is subject to normal garbage +collection – as with Python modules. +By default, multiple modules created from the same definition should be +independent: changes to one should not affect the others. +This means that all state should be specific to the module object (using e.g. +using PyModule_GetState()), or its contents (such as the module’s +__dict__ or individual classes created with PyType_FromSpec()).

    +

    All modules created using multi-phase initialization are expected to support +sub-interpreters. Making sure multiple modules +are independent is typically enough to achieve this.

    +

    To request multi-phase initialization, the initialization function +(PyInit_modulename) returns a PyModuleDef instance with non-empty +m_slots. Before it is returned, the PyModuleDef +instance must be initialized with the following function:

    +
    +
    +PyObject* PyModuleDef_Init(PyModuleDef *def)
    +
    Return value: Borrowed reference.

    Ensures a module definition is a properly initialized Python object that +correctly reports its type and reference count.

    +

    Returns def cast to PyObject*, or NULL if an error occurred.

    +
    +

    New in version 3.5.

    +
    +
    + +

    The m_slots member of the module definition must point to an array of +PyModuleDef_Slot structures:

    +
    +
    +PyModuleDef_Slot
    +
    +
    +int slot
    +

    A slot ID, chosen from the available values explained below.

    +
    + +
    +
    +void* value
    +

    Value of the slot, whose meaning depends on the slot ID.

    +
    + +
    +

    New in version 3.5.

    +
    +
    + +

    The m_slots array must be terminated by a slot with id 0.

    +

    The available slot types are:

    +
    +
    +Py_mod_create
    +

    Specifies a function that is called to create the module object itself. +The value pointer of this slot must point to a function of the signature:

    +
    +
    +PyObject* create_module(PyObject *spec, PyModuleDef *def)
    +
    + +

    The function receives a ModuleSpec +instance, as defined in PEP 451, and the module definition. +It should return a new module object, or set an error +and return NULL.

    +

    This function should be kept minimal. In particular, it should not +call arbitrary Python code, as trying to import the same module again may +result in an infinite loop.

    +

    Multiple Py_mod_create slots may not be specified in one module +definition.

    +

    If Py_mod_create is not specified, the import machinery will create +a normal module object using PyModule_New(). The name is taken from +spec, not the definition, to allow extension modules to dynamically adjust +to their place in the module hierarchy and be imported under different +names through symlinks, all while sharing a single module definition.

    +

    There is no requirement for the returned object to be an instance of +PyModule_Type. Any type can be used, as long as it supports +setting and getting import-related attributes. +However, only PyModule_Type instances may be returned if the +PyModuleDef has non-NULL m_traverse, m_clear, +m_free; non-zero m_size; or slots other than Py_mod_create.

    +
    + +
    +
    +Py_mod_exec
    +

    Specifies a function that is called to execute the module. +This is equivalent to executing the code of a Python module: typically, +this function adds classes and constants to the module. +The signature of the function is:

    +
    +
    +int exec_module(PyObject* module)
    +
    + +

    If multiple Py_mod_exec slots are specified, they are processed in the +order they appear in the m_slots array.

    +
    + +

    See PEP 489 for more details on multi-phase initialization.

    +
    +
    +

    Low-level module creation functions

    +

    The following functions are called under the hood when using multi-phase +initialization. They can be used directly, for example when creating module +objects dynamically. Note that both PyModule_FromDefAndSpec and +PyModule_ExecDef must be called to fully initialize a module.

    +
    +
    +PyObject * PyModule_FromDefAndSpec(PyModuleDef *def, PyObject *spec)
    +
    Return value: New reference.

    Create a new module object, given the definition in module and the +ModuleSpec spec. This behaves like PyModule_FromDefAndSpec2() +with module_api_version set to PYTHON_API_VERSION.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +PyObject * PyModule_FromDefAndSpec2(PyModuleDef *def, PyObject *spec, int module_api_version)
    +
    Return value: New reference.

    Create a new module object, given the definition in module and the +ModuleSpec spec, assuming the API version module_api_version. +If that version does not match the version of the running interpreter, +a RuntimeWarning is emitted.

    +
    +

    Note

    +

    Most uses of this function should be using PyModule_FromDefAndSpec() +instead; only use this if you are sure you need it.

    +
    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +int PyModule_ExecDef(PyObject *module, PyModuleDef *def)
    +

    Process any execution slots (Py_mod_exec) given in def.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +int PyModule_SetDocString(PyObject *module, const char *docstring)
    +

    Set the docstring for module to docstring. +This function is called automatically when creating a module from +PyModuleDef, using either PyModule_Create or +PyModule_FromDefAndSpec.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +int PyModule_AddFunctions(PyObject *module, PyMethodDef *functions)
    +

    Add the functions from the NULL terminated functions array to module. +Refer to the PyMethodDef documentation for details on individual +entries (due to the lack of a shared module namespace, module level +“functions” implemented in C typically receive the module as their first +parameter, making them similar to instance methods on Python classes). +This function is called automatically when creating a module from +PyModuleDef, using either PyModule_Create or +PyModule_FromDefAndSpec.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +

    Support functions

    +

    The module initialization function (if using single phase initialization) or +a function called from a module execution slot (if using multi-phase +initialization), can use the following functions to help initialize the module +state:

    +
    +
    +int PyModule_AddObject(PyObject *module, const char *name, PyObject *value)
    +

    Add an object to module as name. This is a convenience function which can +be used from the module’s initialization function. This steals a reference to +value. Return -1 on error, 0 on success.

    +
    + +
    +
    +int PyModule_AddIntConstant(PyObject *module, const char *name, long value)
    +

    Add an integer constant to module as name. This convenience function can be +used from the module’s initialization function. Return -1 on error, 0 on +success.

    +
    + +
    +
    +int PyModule_AddStringConstant(PyObject *module, const char *name, const char *value)
    +

    Add a string constant to module as name. This convenience function can be +used from the module’s initialization function. The string value must be +NULL-terminated. Return -1 on error, 0 on success.

    +
    + +
    +
    +int PyModule_AddIntMacro(PyObject *module, macro)
    +

    Add an int constant to module. The name and the value are taken from +macro. For example PyModule_AddIntMacro(module, AF_INET) adds the int +constant AF_INET with the value of AF_INET to module. +Return -1 on error, 0 on success.

    +
    + +
    +
    +int PyModule_AddStringMacro(PyObject *module, macro)
    +

    Add a string constant to module.

    +
    + +
    +
    +
    +

    Module lookup

    +

    Single-phase initialization creates singleton modules that can be looked up +in the context of the current interpreter. This allows the module object to be +retrieved later with only a reference to the module definition.

    +

    These functions will not work on modules created using multi-phase initialization, +since multiple such modules can be created from a single definition.

    +
    +
    +PyObject* PyState_FindModule(PyModuleDef *def)
    +
    Return value: Borrowed reference.

    Returns the module object that was created from def for the current interpreter. +This method requires that the module object has been attached to the interpreter state with +PyState_AddModule() beforehand. In case the corresponding module object is not +found or has not been attached to the interpreter state yet, it returns NULL.

    +
    + +
    +
    +int PyState_AddModule(PyObject *module, PyModuleDef *def)
    +

    Attaches the module object passed to the function to the interpreter state. This allows +the module object to be accessible via PyState_FindModule().

    +

    Only effective on modules created using single-phase initialization.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +int PyState_RemoveModule(PyModuleDef *def)
    +

    Removes the module object created from def from the interpreter state.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/none.html b/python-3.7.4-docs-html/c-api/none.html new file mode 100644 index 0000000..b0226fa --- /dev/null +++ b/python-3.7.4-docs-html/c-api/none.html @@ -0,0 +1,202 @@ + + + + + + + The None Object — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    The None Object

    +

    Note that the PyTypeObject for None is not directly exposed in the +Python/C API. Since None is a singleton, testing for object identity (using +== in C) is sufficient. There is no PyNone_Check() function for the +same reason.

    +
    +
    +PyObject* Py_None
    +

    The Python None object, denoting lack of value. This object has no methods. +It needs to be treated just like any other object with respect to reference +counts.

    +
    + +
    +
    +Py_RETURN_NONE
    +

    Properly handle returning Py_None from within a C function (that is, +increment the reference count of None and return it.)

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/number.html b/python-3.7.4-docs-html/c-api/number.html new file mode 100644 index 0000000..3871ad2 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/number.html @@ -0,0 +1,487 @@ + + + + + + + Number Protocol — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Number Protocol

    +
    +
    +int PyNumber_Check(PyObject *o)
    +

    Returns 1 if the object o provides numeric protocols, and false otherwise. +This function always succeeds.

    +
    + +
    +
    +PyObject* PyNumber_Add(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the result of adding o1 and o2, or NULL on failure. This is the +equivalent of the Python expression o1 + o2.

    +
    + +
    +
    +PyObject* PyNumber_Subtract(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the result of subtracting o2 from o1, or NULL on failure. This is +the equivalent of the Python expression o1 - o2.

    +
    + +
    +
    +PyObject* PyNumber_Multiply(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the result of multiplying o1 and o2, or NULL on failure. This is +the equivalent of the Python expression o1 * o2.

    +
    + +
    +
    +PyObject* PyNumber_MatrixMultiply(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the result of matrix multiplication on o1 and o2, or NULL on +failure. This is the equivalent of the Python expression o1 @ o2.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +PyObject* PyNumber_FloorDivide(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Return the floor of o1 divided by o2, or NULL on failure. This is +equivalent to the “classic” division of integers.

    +
    + +
    +
    +PyObject* PyNumber_TrueDivide(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Return a reasonable approximation for the mathematical value of o1 divided by +o2, or NULL on failure. The return value is “approximate” because binary +floating point numbers are approximate; it is not possible to represent all real +numbers in base two. This function can return a floating point value when +passed two integers.

    +
    + +
    +
    +PyObject* PyNumber_Remainder(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the remainder of dividing o1 by o2, or NULL on failure. This is +the equivalent of the Python expression o1 % o2.

    +
    + +
    +
    +PyObject* PyNumber_Divmod(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    See the built-in function divmod(). Returns NULL on failure. This is +the equivalent of the Python expression divmod(o1, o2).

    +
    + +
    +
    +PyObject* PyNumber_Power(PyObject *o1, PyObject *o2, PyObject *o3)
    +
    Return value: New reference.

    See the built-in function pow(). Returns NULL on failure. This is the +equivalent of the Python expression pow(o1, o2, o3), where o3 is optional. +If o3 is to be ignored, pass Py_None in its place (passing NULL for +o3 would cause an illegal memory access).

    +
    + +
    +
    +PyObject* PyNumber_Negative(PyObject *o)
    +
    Return value: New reference.

    Returns the negation of o on success, or NULL on failure. This is the +equivalent of the Python expression -o.

    +
    + +
    +
    +PyObject* PyNumber_Positive(PyObject *o)
    +
    Return value: New reference.

    Returns o on success, or NULL on failure. This is the equivalent of the +Python expression +o.

    +
    + +
    +
    +PyObject* PyNumber_Absolute(PyObject *o)
    +
    Return value: New reference.

    Returns the absolute value of o, or NULL on failure. This is the equivalent +of the Python expression abs(o).

    +
    + +
    +
    +PyObject* PyNumber_Invert(PyObject *o)
    +
    Return value: New reference.

    Returns the bitwise negation of o on success, or NULL on failure. This is +the equivalent of the Python expression ~o.

    +
    + +
    +
    +PyObject* PyNumber_Lshift(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the result of left shifting o1 by o2 on success, or NULL on +failure. This is the equivalent of the Python expression o1 << o2.

    +
    + +
    +
    +PyObject* PyNumber_Rshift(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the result of right shifting o1 by o2 on success, or NULL on +failure. This is the equivalent of the Python expression o1 >> o2.

    +
    + +
    +
    +PyObject* PyNumber_And(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the “bitwise and” of o1 and o2 on success and NULL on failure. +This is the equivalent of the Python expression o1 & o2.

    +
    + +
    +
    +PyObject* PyNumber_Xor(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the “bitwise exclusive or” of o1 by o2 on success, or NULL on +failure. This is the equivalent of the Python expression o1 ^ o2.

    +
    + +
    +
    +PyObject* PyNumber_Or(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the “bitwise or” of o1 and o2 on success, or NULL on failure. +This is the equivalent of the Python expression o1 | o2.

    +
    + +
    +
    +PyObject* PyNumber_InPlaceAdd(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the result of adding o1 and o2, or NULL on failure. The operation +is done in-place when o1 supports it. This is the equivalent of the Python +statement o1 += o2.

    +
    + +
    +
    +PyObject* PyNumber_InPlaceSubtract(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the result of subtracting o2 from o1, or NULL on failure. The +operation is done in-place when o1 supports it. This is the equivalent of +the Python statement o1 -= o2.

    +
    + +
    +
    +PyObject* PyNumber_InPlaceMultiply(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the result of multiplying o1 and o2, or NULL on failure. The +operation is done in-place when o1 supports it. This is the equivalent of +the Python statement o1 *= o2.

    +
    + +
    +
    +PyObject* PyNumber_InPlaceMatrixMultiply(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the result of matrix multiplication on o1 and o2, or NULL on +failure. The operation is done in-place when o1 supports it. This is +the equivalent of the Python statement o1 @= o2.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +PyObject* PyNumber_InPlaceFloorDivide(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the mathematical floor of dividing o1 by o2, or NULL on failure. +The operation is done in-place when o1 supports it. This is the equivalent +of the Python statement o1 //= o2.

    +
    + +
    +
    +PyObject* PyNumber_InPlaceTrueDivide(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Return a reasonable approximation for the mathematical value of o1 divided by +o2, or NULL on failure. The return value is “approximate” because binary +floating point numbers are approximate; it is not possible to represent all real +numbers in base two. This function can return a floating point value when +passed two integers. The operation is done in-place when o1 supports it.

    +
    + +
    +
    +PyObject* PyNumber_InPlaceRemainder(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the remainder of dividing o1 by o2, or NULL on failure. The +operation is done in-place when o1 supports it. This is the equivalent of +the Python statement o1 %= o2.

    +
    + +
    +
    +PyObject* PyNumber_InPlacePower(PyObject *o1, PyObject *o2, PyObject *o3)
    +
    Return value: New reference.

    See the built-in function pow(). Returns NULL on failure. The operation +is done in-place when o1 supports it. This is the equivalent of the Python +statement o1 **= o2 when o3 is Py_None, or an in-place variant of +pow(o1, o2, o3) otherwise. If o3 is to be ignored, pass Py_None +in its place (passing NULL for o3 would cause an illegal memory access).

    +
    + +
    +
    +PyObject* PyNumber_InPlaceLshift(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the result of left shifting o1 by o2 on success, or NULL on +failure. The operation is done in-place when o1 supports it. This is the +equivalent of the Python statement o1 <<= o2.

    +
    + +
    +
    +PyObject* PyNumber_InPlaceRshift(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the result of right shifting o1 by o2 on success, or NULL on +failure. The operation is done in-place when o1 supports it. This is the +equivalent of the Python statement o1 >>= o2.

    +
    + +
    +
    +PyObject* PyNumber_InPlaceAnd(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the “bitwise and” of o1 and o2 on success and NULL on failure. The +operation is done in-place when o1 supports it. This is the equivalent of +the Python statement o1 &= o2.

    +
    + +
    +
    +PyObject* PyNumber_InPlaceXor(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the “bitwise exclusive or” of o1 by o2 on success, or NULL on +failure. The operation is done in-place when o1 supports it. This is the +equivalent of the Python statement o1 ^= o2.

    +
    + +
    +
    +PyObject* PyNumber_InPlaceOr(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Returns the “bitwise or” of o1 and o2 on success, or NULL on failure. The +operation is done in-place when o1 supports it. This is the equivalent of +the Python statement o1 |= o2.

    +
    + +
    +
    +PyObject* PyNumber_Long(PyObject *o)
    +
    Return value: New reference.

    Returns the o converted to an integer object on success, or NULL on +failure. This is the equivalent of the Python expression int(o).

    +
    + +
    +
    +PyObject* PyNumber_Float(PyObject *o)
    +
    Return value: New reference.

    Returns the o converted to a float object on success, or NULL on failure. +This is the equivalent of the Python expression float(o).

    +
    + +
    +
    +PyObject* PyNumber_Index(PyObject *o)
    +
    Return value: New reference.

    Returns the o converted to a Python int on success or NULL with a +TypeError exception raised on failure.

    +
    + +
    +
    +PyObject* PyNumber_ToBase(PyObject *n, int base)
    +
    Return value: New reference.

    Returns the integer n converted to base base as a string. The base +argument must be one of 2, 8, 10, or 16. For base 2, 8, or 16, the +returned string is prefixed with a base marker of '0b', '0o', or +'0x', respectively. If n is not a Python int, it is converted with +PyNumber_Index() first.

    +
    + +
    +
    +Py_ssize_t PyNumber_AsSsize_t(PyObject *o, PyObject *exc)
    +

    Returns o converted to a Py_ssize_t value if o can be interpreted as an +integer. If the call fails, an exception is raised and -1 is returned.

    +

    If o can be converted to a Python int but the attempt to +convert to a Py_ssize_t value would raise an OverflowError, then the +exc argument is the type of exception that will be raised (usually +IndexError or OverflowError). If exc is NULL, then the +exception is cleared and the value is clipped to PY_SSIZE_T_MIN for a negative +integer or PY_SSIZE_T_MAX for a positive integer.

    +
    + +
    +
    +int PyIndex_Check(PyObject *o)
    +

    Returns 1 if o is an index integer (has the nb_index slot of the +tp_as_number structure filled in), and 0 otherwise. +This function always succeeds.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/objbuffer.html b/python-3.7.4-docs-html/c-api/objbuffer.html new file mode 100644 index 0000000..73b2eae --- /dev/null +++ b/python-3.7.4-docs-html/c-api/objbuffer.html @@ -0,0 +1,235 @@ + + + + + + + Old Buffer Protocol — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Old Buffer Protocol

    +
    +

    Deprecated since version 3.0.

    +
    +

    These functions were part of the “old buffer protocol” API in Python 2. +In Python 3, this protocol doesn’t exist anymore but the functions are still +exposed to ease porting 2.x code. They act as a compatibility wrapper +around the new buffer protocol, but they don’t give +you control over the lifetime of the resources acquired when a buffer is +exported.

    +

    Therefore, it is recommended that you call PyObject_GetBuffer() +(or the y* or w* format codes with the +PyArg_ParseTuple() family of functions) to get a buffer view over +an object, and PyBuffer_Release() when the buffer view can be released.

    +
    +
    +int PyObject_AsCharBuffer(PyObject *obj, const char **buffer, Py_ssize_t *buffer_len)
    +

    Returns a pointer to a read-only memory location usable as character-based +input. The obj argument must support the single-segment character buffer +interface. On success, returns 0, sets buffer to the memory location +and buffer_len to the buffer length. Returns -1 and sets a +TypeError on error.

    +
    + +
    +
    +int PyObject_AsReadBuffer(PyObject *obj, const void **buffer, Py_ssize_t *buffer_len)
    +

    Returns a pointer to a read-only memory location containing arbitrary data. +The obj argument must support the single-segment readable buffer +interface. On success, returns 0, sets buffer to the memory location +and buffer_len to the buffer length. Returns -1 and sets a +TypeError on error.

    +
    + +
    +
    +int PyObject_CheckReadBuffer(PyObject *o)
    +

    Returns 1 if o supports the single-segment readable buffer interface. +Otherwise returns 0. This function always succeeds.

    +

    Note that this function tries to get and release a buffer, and exceptions +which occur while calling corresponding functions will get suppressed. +To get error reporting use PyObject_GetBuffer() instead.

    +
    + +
    +
    +int PyObject_AsWriteBuffer(PyObject *obj, void **buffer, Py_ssize_t *buffer_len)
    +

    Returns a pointer to a writable memory location. The obj argument must +support the single-segment, character buffer interface. On success, +returns 0, sets buffer to the memory location and buffer_len to the +buffer length. Returns -1 and sets a TypeError on error.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/object.html b/python-3.7.4-docs-html/c-api/object.html new file mode 100644 index 0000000..408336c --- /dev/null +++ b/python-3.7.4-docs-html/c-api/object.html @@ -0,0 +1,639 @@ + + + + + + + Object Protocol — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Object Protocol

    +
    +
    +PyObject* Py_NotImplemented
    +

    The NotImplemented singleton, used to signal that an operation is +not implemented for the given type combination.

    +
    + +
    +
    +Py_RETURN_NOTIMPLEMENTED
    +

    Properly handle returning Py_NotImplemented from within a C +function (that is, increment the reference count of NotImplemented and +return it).

    +
    + +
    +
    +int PyObject_Print(PyObject *o, FILE *fp, int flags)
    +

    Print an object o, on file fp. Returns -1 on error. The flags argument +is used to enable certain printing options. The only option currently supported +is Py_PRINT_RAW; if given, the str() of the object is written +instead of the repr().

    +
    + +
    +
    +int PyObject_HasAttr(PyObject *o, PyObject *attr_name)
    +

    Returns 1 if o has the attribute attr_name, and 0 otherwise. This +is equivalent to the Python expression hasattr(o, attr_name). This function +always succeeds.

    +

    Note that exceptions which occur while calling __getattr__() and +__getattribute__() methods will get suppressed. +To get error reporting use PyObject_GetAttr() instead.

    +
    + +
    +
    +int PyObject_HasAttrString(PyObject *o, const char *attr_name)
    +

    Returns 1 if o has the attribute attr_name, and 0 otherwise. This +is equivalent to the Python expression hasattr(o, attr_name). This function +always succeeds.

    +

    Note that exceptions which occur while calling __getattr__() and +__getattribute__() methods and creating a temporary string object +will get suppressed. +To get error reporting use PyObject_GetAttrString() instead.

    +
    + +
    +
    +PyObject* PyObject_GetAttr(PyObject *o, PyObject *attr_name)
    +
    Return value: New reference.

    Retrieve an attribute named attr_name from object o. Returns the attribute +value on success, or NULL on failure. This is the equivalent of the Python +expression o.attr_name.

    +
    + +
    +
    +PyObject* PyObject_GetAttrString(PyObject *o, const char *attr_name)
    +
    Return value: New reference.

    Retrieve an attribute named attr_name from object o. Returns the attribute +value on success, or NULL on failure. This is the equivalent of the Python +expression o.attr_name.

    +
    + +
    +
    +PyObject* PyObject_GenericGetAttr(PyObject *o, PyObject *name)
    +
    Return value: New reference.

    Generic attribute getter function that is meant to be put into a type +object’s tp_getattro slot. It looks for a descriptor in the dictionary +of classes in the object’s MRO as well as an attribute in the object’s +__dict__ (if present). As outlined in Implementing Descriptors, +data descriptors take preference over instance attributes, while non-data +descriptors don’t. Otherwise, an AttributeError is raised.

    +
    + +
    +
    +int PyObject_SetAttr(PyObject *o, PyObject *attr_name, PyObject *v)
    +

    Set the value of the attribute named attr_name, for object o, to the value +v. Raise an exception and return -1 on failure; +return 0 on success. This is the equivalent of the Python statement +o.attr_name = v.

    +

    If v is NULL, the attribute is deleted, however this feature is +deprecated in favour of using PyObject_DelAttr().

    +
    + +
    +
    +int PyObject_SetAttrString(PyObject *o, const char *attr_name, PyObject *v)
    +

    Set the value of the attribute named attr_name, for object o, to the value +v. Raise an exception and return -1 on failure; +return 0 on success. This is the equivalent of the Python statement +o.attr_name = v.

    +

    If v is NULL, the attribute is deleted, however this feature is +deprecated in favour of using PyObject_DelAttrString().

    +
    + +
    +
    +int PyObject_GenericSetAttr(PyObject *o, PyObject *name, PyObject *value)
    +

    Generic attribute setter and deleter function that is meant +to be put into a type object’s tp_setattro +slot. It looks for a data descriptor in the +dictionary of classes in the object’s MRO, and if found it takes preference +over setting or deleting the attribute in the instance dictionary. Otherwise, the +attribute is set or deleted in the object’s __dict__ (if present). +On success, 0 is returned, otherwise an AttributeError +is raised and -1 is returned.

    +
    + +
    +
    +int PyObject_DelAttr(PyObject *o, PyObject *attr_name)
    +

    Delete attribute named attr_name, for object o. Returns -1 on failure. +This is the equivalent of the Python statement del o.attr_name.

    +
    + +
    +
    +int PyObject_DelAttrString(PyObject *o, const char *attr_name)
    +

    Delete attribute named attr_name, for object o. Returns -1 on failure. +This is the equivalent of the Python statement del o.attr_name.

    +
    + +
    +
    +PyObject* PyObject_GenericGetDict(PyObject *o, void *context)
    +
    Return value: New reference.

    A generic implementation for the getter of a __dict__ descriptor. It +creates the dictionary if necessary.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +int PyObject_GenericSetDict(PyObject *o, void *context)
    +

    A generic implementation for the setter of a __dict__ descriptor. This +implementation does not allow the dictionary to be deleted.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +PyObject* PyObject_RichCompare(PyObject *o1, PyObject *o2, int opid)
    +
    Return value: New reference.

    Compare the values of o1 and o2 using the operation specified by opid, +which must be one of Py_LT, Py_LE, Py_EQ, +Py_NE, Py_GT, or Py_GE, corresponding to <, +<=, ==, !=, >, or >= respectively. This is the equivalent of +the Python expression o1 op o2, where op is the operator corresponding +to opid. Returns the value of the comparison on success, or NULL on failure.

    +
    + +
    +
    +int PyObject_RichCompareBool(PyObject *o1, PyObject *o2, int opid)
    +

    Compare the values of o1 and o2 using the operation specified by opid, +which must be one of Py_LT, Py_LE, Py_EQ, +Py_NE, Py_GT, or Py_GE, corresponding to <, +<=, ==, !=, >, or >= respectively. Returns -1 on error, +0 if the result is false, 1 otherwise. This is the equivalent of the +Python expression o1 op o2, where op is the operator corresponding to +opid.

    +
    + +
    +

    Note

    +

    If o1 and o2 are the same object, PyObject_RichCompareBool() +will always return 1 for Py_EQ and 0 for Py_NE.

    +
    +
    +
    +PyObject* PyObject_Repr(PyObject *o)
    +
    Return value: New reference.

    Compute a string representation of object o. Returns the string +representation on success, NULL on failure. This is the equivalent of the +Python expression repr(o). Called by the repr() built-in function.

    +
    +

    Changed in version 3.4: This function now includes a debug assertion to help ensure that it +does not silently discard an active exception.

    +
    +
    + +
    +
    +PyObject* PyObject_ASCII(PyObject *o)
    +
    Return value: New reference.

    As PyObject_Repr(), compute a string representation of object o, but +escape the non-ASCII characters in the string returned by +PyObject_Repr() with \x, \u or \U escapes. This generates +a string similar to that returned by PyObject_Repr() in Python 2. +Called by the ascii() built-in function.

    +
    + +
    +
    +PyObject* PyObject_Str(PyObject *o)
    +
    Return value: New reference.

    Compute a string representation of object o. Returns the string +representation on success, NULL on failure. This is the equivalent of the +Python expression str(o). Called by the str() built-in function +and, therefore, by the print() function.

    +
    +

    Changed in version 3.4: This function now includes a debug assertion to help ensure that it +does not silently discard an active exception.

    +
    +
    + +
    +
    +PyObject* PyObject_Bytes(PyObject *o)
    +
    Return value: New reference.

    Compute a bytes representation of object o. NULL is returned on +failure and a bytes object on success. This is equivalent to the Python +expression bytes(o), when o is not an integer. Unlike bytes(o), +a TypeError is raised when o is an integer instead of a zero-initialized +bytes object.

    +
    + +
    +
    +int PyObject_IsSubclass(PyObject *derived, PyObject *cls)
    +

    Return 1 if the class derived is identical to or derived from the class +cls, otherwise return 0. In case of an error, return -1.

    +

    If cls is a tuple, the check will be done against every entry in cls. +The result will be 1 when at least one of the checks returns 1, +otherwise it will be 0.

    +

    If cls has a __subclasscheck__() method, it will be called to +determine the subclass status as described in PEP 3119. Otherwise, +derived is a subclass of cls if it is a direct or indirect subclass, +i.e. contained in cls.__mro__.

    +

    Normally only class objects, i.e. instances of type or a derived +class, are considered classes. However, objects can override this by having +a __bases__ attribute (which must be a tuple of base classes).

    +
    + +
    +
    +int PyObject_IsInstance(PyObject *inst, PyObject *cls)
    +

    Return 1 if inst is an instance of the class cls or a subclass of +cls, or 0 if not. On error, returns -1 and sets an exception.

    +

    If cls is a tuple, the check will be done against every entry in cls. +The result will be 1 when at least one of the checks returns 1, +otherwise it will be 0.

    +

    If cls has a __instancecheck__() method, it will be called to +determine the subclass status as described in PEP 3119. Otherwise, inst +is an instance of cls if its class is a subclass of cls.

    +

    An instance inst can override what is considered its class by having a +__class__ attribute.

    +

    An object cls can override if it is considered a class, and what its base +classes are, by having a __bases__ attribute (which must be a tuple +of base classes).

    +
    + +
    +
    +int PyCallable_Check(PyObject *o)
    +

    Determine if the object o is callable. Return 1 if the object is callable +and 0 otherwise. This function always succeeds.

    +
    + +
    +
    +PyObject* PyObject_Call(PyObject *callable, PyObject *args, PyObject *kwargs)
    +
    Return value: New reference.

    Call a callable Python object callable, with arguments given by the +tuple args, and named arguments given by the dictionary kwargs.

    +

    args must not be NULL, use an empty tuple if no arguments are needed. +If no named arguments are needed, kwargs can be NULL.

    +

    Return the result of the call on success, or raise an exception and return +NULL on failure.

    +

    This is the equivalent of the Python expression: +callable(*args, **kwargs).

    +
    + +
    +
    +PyObject* PyObject_CallObject(PyObject *callable, PyObject *args)
    +
    Return value: New reference.

    Call a callable Python object callable, with arguments given by the +tuple args. If no arguments are needed, then args can be NULL.

    +

    Return the result of the call on success, or raise an exception and return +NULL on failure.

    +

    This is the equivalent of the Python expression: callable(*args).

    +
    + +
    +
    +PyObject* PyObject_CallFunction(PyObject *callable, const char *format, ...)
    +
    Return value: New reference.

    Call a callable Python object callable, with a variable number of C arguments. +The C arguments are described using a Py_BuildValue() style format +string. The format can be NULL, indicating that no arguments are provided.

    +

    Return the result of the call on success, or raise an exception and return +NULL on failure.

    +

    This is the equivalent of the Python expression: callable(*args).

    +

    Note that if you only pass PyObject * args, +PyObject_CallFunctionObjArgs() is a faster alternative.

    +
    +

    Changed in version 3.4: The type of format was changed from char *.

    +
    +
    + +
    +
    +PyObject* PyObject_CallMethod(PyObject *obj, const char *name, const char *format, ...)
    +
    Return value: New reference.

    Call the method named name of object obj with a variable number of C +arguments. The C arguments are described by a Py_BuildValue() format +string that should produce a tuple.

    +

    The format can be NULL, indicating that no arguments are provided.

    +

    Return the result of the call on success, or raise an exception and return +NULL on failure.

    +

    This is the equivalent of the Python expression: +obj.name(arg1, arg2, ...).

    +

    Note that if you only pass PyObject * args, +PyObject_CallMethodObjArgs() is a faster alternative.

    +
    +

    Changed in version 3.4: The types of name and format were changed from char *.

    +
    +
    + +
    +
    +PyObject* PyObject_CallFunctionObjArgs(PyObject *callable, ..., NULL)
    +
    Return value: New reference.

    Call a callable Python object callable, with a variable number of +PyObject* arguments. The arguments are provided as a variable number +of parameters followed by NULL.

    +

    Return the result of the call on success, or raise an exception and return +NULL on failure.

    +

    This is the equivalent of the Python expression: +callable(arg1, arg2, ...).

    +
    + +
    +
    +PyObject* PyObject_CallMethodObjArgs(PyObject *obj, PyObject *name, ..., NULL)
    +
    Return value: New reference.

    Calls a method of the Python object obj, where the name of the method is given as a +Python string object in name. It is called with a variable number of +PyObject* arguments. The arguments are provided as a variable number +of parameters followed by NULL.

    +

    Return the result of the call on success, or raise an exception and return +NULL on failure.

    +
    + +
    +
    +Py_hash_t PyObject_Hash(PyObject *o)
    +

    Compute and return the hash value of an object o. On failure, return -1. +This is the equivalent of the Python expression hash(o).

    +
    +

    Changed in version 3.2: The return type is now Py_hash_t. This is a signed integer the same size +as Py_ssize_t.

    +
    +
    + +
    +
    +Py_hash_t PyObject_HashNotImplemented(PyObject *o)
    +

    Set a TypeError indicating that type(o) is not hashable and return -1. +This function receives special treatment when stored in a tp_hash slot, +allowing a type to explicitly indicate to the interpreter that it is not +hashable.

    +
    + +
    +
    +int PyObject_IsTrue(PyObject *o)
    +

    Returns 1 if the object o is considered to be true, and 0 otherwise. +This is equivalent to the Python expression not not o. On failure, return +-1.

    +
    + +
    +
    +int PyObject_Not(PyObject *o)
    +

    Returns 0 if the object o is considered to be true, and 1 otherwise. +This is equivalent to the Python expression not o. On failure, return +-1.

    +
    + +
    +
    +PyObject* PyObject_Type(PyObject *o)
    +
    Return value: New reference.

    When o is non-NULL, returns a type object corresponding to the object type +of object o. On failure, raises SystemError and returns NULL. This +is equivalent to the Python expression type(o). This function increments the +reference count of the return value. There’s really no reason to use this +function instead of the common expression o->ob_type, which returns a +pointer of type PyTypeObject*, except when the incremented reference +count is needed.

    +
    + +
    +
    +int PyObject_TypeCheck(PyObject *o, PyTypeObject *type)
    +

    Return true if the object o is of type type or a subtype of type. Both +parameters must be non-NULL.

    +
    + +
    +
    +Py_ssize_t PyObject_Size(PyObject *o)
    +
    +Py_ssize_t PyObject_Length(PyObject *o)
    +

    Return the length of object o. If the object o provides either the sequence +and mapping protocols, the sequence length is returned. On error, -1 is +returned. This is the equivalent to the Python expression len(o).

    +
    + +
    +
    +Py_ssize_t PyObject_LengthHint(PyObject *o, Py_ssize_t default)
    +

    Return an estimated length for the object o. First try to return its +actual length, then an estimate using __length_hint__(), and +finally return the default value. On error return -1. This is the +equivalent to the Python expression operator.length_hint(o, default).

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +PyObject* PyObject_GetItem(PyObject *o, PyObject *key)
    +
    Return value: New reference.

    Return element of o corresponding to the object key or NULL on failure. +This is the equivalent of the Python expression o[key].

    +
    + +
    +
    +int PyObject_SetItem(PyObject *o, PyObject *key, PyObject *v)
    +

    Map the object key to the value v. Raise an exception and +return -1 on failure; return 0 on success. This is the +equivalent of the Python statement o[key] = v.

    +
    + +
    +
    +int PyObject_DelItem(PyObject *o, PyObject *key)
    +

    Remove the mapping for the object key from the object o. Return -1 +on failure. This is equivalent to the Python statement del o[key].

    +
    + +
    +
    +PyObject* PyObject_Dir(PyObject *o)
    +
    Return value: New reference.

    This is equivalent to the Python expression dir(o), returning a (possibly +empty) list of strings appropriate for the object argument, or NULL if there +was an error. If the argument is NULL, this is like the Python dir(), +returning the names of the current locals; in this case, if no execution frame +is active then NULL is returned but PyErr_Occurred() will return false.

    +
    + +
    +
    +PyObject* PyObject_GetIter(PyObject *o)
    +
    Return value: New reference.

    This is equivalent to the Python expression iter(o). It returns a new +iterator for the object argument, or the object itself if the object is already +an iterator. Raises TypeError and returns NULL if the object cannot be +iterated.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/objimpl.html b/python-3.7.4-docs-html/c-api/objimpl.html new file mode 100644 index 0000000..c869872 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/objimpl.html @@ -0,0 +1,196 @@ + + + + + + + Object Implementation Support — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Object Implementation Support

    +

    This chapter describes the functions, types, and macros used when defining new +object types.

    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/refcounting.html b/python-3.7.4-docs-html/c-api/refcounting.html new file mode 100644 index 0000000..df2ef7c --- /dev/null +++ b/python-3.7.4-docs-html/c-api/refcounting.html @@ -0,0 +1,245 @@ + + + + + + + Reference Counting — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Reference Counting

    +

    The macros in this section are used for managing reference counts of Python +objects.

    +
    +
    +void Py_INCREF(PyObject *o)
    +

    Increment the reference count for object o. The object must not be NULL; if +you aren’t sure that it isn’t NULL, use Py_XINCREF().

    +
    + +
    +
    +void Py_XINCREF(PyObject *o)
    +

    Increment the reference count for object o. The object may be NULL, in +which case the macro has no effect.

    +
    + +
    +
    +void Py_DECREF(PyObject *o)
    +

    Decrement the reference count for object o. The object must not be NULL; if +you aren’t sure that it isn’t NULL, use Py_XDECREF(). If the reference +count reaches zero, the object’s type’s deallocation function (which must not be +NULL) is invoked.

    +
    +

    Warning

    +

    The deallocation function can cause arbitrary Python code to be invoked (e.g. +when a class instance with a __del__() method is deallocated). While +exceptions in such code are not propagated, the executed code has free access to +all Python global variables. This means that any object that is reachable from +a global variable should be in a consistent state before Py_DECREF() is +invoked. For example, code to delete an object from a list should copy a +reference to the deleted object in a temporary variable, update the list data +structure, and then call Py_DECREF() for the temporary variable.

    +
    +
    + +
    +
    +void Py_XDECREF(PyObject *o)
    +

    Decrement the reference count for object o. The object may be NULL, in +which case the macro has no effect; otherwise the effect is the same as for +Py_DECREF(), and the same warning applies.

    +
    + +
    +
    +void Py_CLEAR(PyObject *o)
    +

    Decrement the reference count for object o. The object may be NULL, in +which case the macro has no effect; otherwise the effect is the same as for +Py_DECREF(), except that the argument is also set to NULL. The warning +for Py_DECREF() does not apply with respect to the object passed because +the macro carefully uses a temporary variable and sets the argument to NULL +before decrementing its reference count.

    +

    It is a good idea to use this macro whenever decrementing the value of a +variable that might be traversed during garbage collection.

    +
    + +

    The following functions are for runtime dynamic embedding of Python: +Py_IncRef(PyObject *o), Py_DecRef(PyObject *o). They are +simply exported function versions of Py_XINCREF() and +Py_XDECREF(), respectively.

    +

    The following functions or macros are only for use within the interpreter core: +_Py_Dealloc(), _Py_ForgetReference(), _Py_NewReference(), +as well as the global variable _Py_RefTotal.

    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/reflection.html b/python-3.7.4-docs-html/c-api/reflection.html new file mode 100644 index 0000000..eb1636a --- /dev/null +++ b/python-3.7.4-docs-html/c-api/reflection.html @@ -0,0 +1,234 @@ + + + + + + + Reflection — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Reflection

    +
    +
    +PyObject* PyEval_GetBuiltins()
    +
    Return value: Borrowed reference.

    Return a dictionary of the builtins in the current execution frame, +or the interpreter of the thread state if no frame is currently executing.

    +
    + +
    +
    +PyObject* PyEval_GetLocals()
    +
    Return value: Borrowed reference.

    Return a dictionary of the local variables in the current execution frame, +or NULL if no frame is currently executing.

    +
    + +
    +
    +PyObject* PyEval_GetGlobals()
    +
    Return value: Borrowed reference.

    Return a dictionary of the global variables in the current execution frame, +or NULL if no frame is currently executing.

    +
    + +
    +
    +PyFrameObject* PyEval_GetFrame()
    +
    Return value: Borrowed reference.

    Return the current thread state’s frame, which is NULL if no frame is +currently executing.

    +
    + +
    +
    +int PyFrame_GetLineNumber(PyFrameObject *frame)
    +

    Return the line number that frame is currently executing.

    +
    + +
    +
    +const char* PyEval_GetFuncName(PyObject *func)
    +

    Return the name of func if it is a function, class or instance object, else the +name of funcs type.

    +
    + +
    +
    +const char* PyEval_GetFuncDesc(PyObject *func)
    +

    Return a description string, depending on the type of func. +Return values include “()” for functions and methods, ” constructor”, +” instance”, and ” object”. Concatenated with the result of +PyEval_GetFuncName(), the result will be a description of +func.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/sequence.html b/python-3.7.4-docs-html/c-api/sequence.html new file mode 100644 index 0000000..eeb821c --- /dev/null +++ b/python-3.7.4-docs-html/c-api/sequence.html @@ -0,0 +1,363 @@ + + + + + + + Sequence Protocol — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Sequence Protocol

    +
    +
    +int PySequence_Check(PyObject *o)
    +

    Return 1 if the object provides sequence protocol, and 0 otherwise. +Note that it returns 1 for Python classes with a __getitem__() +method unless they are dict subclasses since in general case it +is impossible to determine what the type of keys it supports. This +function always succeeds.

    +
    + +
    +
    +Py_ssize_t PySequence_Size(PyObject *o)
    +
    +Py_ssize_t PySequence_Length(PyObject *o)
    +

    Returns the number of objects in sequence o on success, and -1 on +failure. This is equivalent to the Python expression len(o).

    +
    + +
    +
    +PyObject* PySequence_Concat(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Return the concatenation of o1 and o2 on success, and NULL on failure. +This is the equivalent of the Python expression o1 + o2.

    +
    + +
    +
    +PyObject* PySequence_Repeat(PyObject *o, Py_ssize_t count)
    +
    Return value: New reference.

    Return the result of repeating sequence object o count times, or NULL on +failure. This is the equivalent of the Python expression o * count.

    +
    + +
    +
    +PyObject* PySequence_InPlaceConcat(PyObject *o1, PyObject *o2)
    +
    Return value: New reference.

    Return the concatenation of o1 and o2 on success, and NULL on failure. +The operation is done in-place when o1 supports it. This is the equivalent +of the Python expression o1 += o2.

    +
    + +
    +
    +PyObject* PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
    +
    Return value: New reference.

    Return the result of repeating sequence object o count times, or NULL on +failure. The operation is done in-place when o supports it. This is the +equivalent of the Python expression o *= count.

    +
    + +
    +
    +PyObject* PySequence_GetItem(PyObject *o, Py_ssize_t i)
    +
    Return value: New reference.

    Return the ith element of o, or NULL on failure. This is the equivalent of +the Python expression o[i].

    +
    + +
    +
    +PyObject* PySequence_GetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2)
    +
    Return value: New reference.

    Return the slice of sequence object o between i1 and i2, or NULL on +failure. This is the equivalent of the Python expression o[i1:i2].

    +
    + +
    +
    +int PySequence_SetItem(PyObject *o, Py_ssize_t i, PyObject *v)
    +

    Assign object v to the ith element of o. Raise an exception +and return -1 on failure; return 0 on success. This +is the equivalent of the Python statement o[i] = v. This function does +not steal a reference to v.

    +

    If v is NULL, the element is deleted, however this feature is +deprecated in favour of using PySequence_DelItem().

    +
    + +
    +
    +int PySequence_DelItem(PyObject *o, Py_ssize_t i)
    +

    Delete the ith element of object o. Returns -1 on failure. This is the +equivalent of the Python statement del o[i].

    +
    + +
    +
    +int PySequence_SetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2, PyObject *v)
    +

    Assign the sequence object v to the slice in sequence object o from i1 to +i2. This is the equivalent of the Python statement o[i1:i2] = v.

    +
    + +
    +
    +int PySequence_DelSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2)
    +

    Delete the slice in sequence object o from i1 to i2. Returns -1 on +failure. This is the equivalent of the Python statement del o[i1:i2].

    +
    + +
    +
    +Py_ssize_t PySequence_Count(PyObject *o, PyObject *value)
    +

    Return the number of occurrences of value in o, that is, return the number +of keys for which o[key] == value. On failure, return -1. This is +equivalent to the Python expression o.count(value).

    +
    + +
    +
    +int PySequence_Contains(PyObject *o, PyObject *value)
    +

    Determine if o contains value. If an item in o is equal to value, +return 1, otherwise return 0. On error, return -1. This is +equivalent to the Python expression value in o.

    +
    + +
    +
    +Py_ssize_t PySequence_Index(PyObject *o, PyObject *value)
    +

    Return the first index i for which o[i] == value. On error, return +-1. This is equivalent to the Python expression o.index(value).

    +
    + +
    +
    +PyObject* PySequence_List(PyObject *o)
    +
    Return value: New reference.

    Return a list object with the same contents as the sequence or iterable o, +or NULL on failure. The returned list is guaranteed to be new. This is +equivalent to the Python expression list(o).

    +
    + +
    +
    +PyObject* PySequence_Tuple(PyObject *o)
    +
    Return value: New reference.

    Return a tuple object with the same contents as the sequence or iterable o, +or NULL on failure. If o is a tuple, a new reference will be returned, +otherwise a tuple will be constructed with the appropriate contents. This is +equivalent to the Python expression tuple(o).

    +
    + +
    +
    +PyObject* PySequence_Fast(PyObject *o, const char *m)
    +
    Return value: New reference.

    Return the sequence or iterable o as a list, unless it is already a tuple or list, in +which case o is returned. Use PySequence_Fast_GET_ITEM() to access +the members of the result. Returns NULL on failure. If the object is not +a sequence or iterable, raises TypeError with m as the message text.

    +
    + +
    +
    +Py_ssize_t PySequence_Fast_GET_SIZE(PyObject *o)
    +

    Returns the length of o, assuming that o was returned by +PySequence_Fast() and that o is not NULL. The size can also be +gotten by calling PySequence_Size() on o, but +PySequence_Fast_GET_SIZE() is faster because it can assume o is a list +or tuple.

    +
    + +
    +
    +PyObject* PySequence_Fast_GET_ITEM(PyObject *o, Py_ssize_t i)
    +
    Return value: Borrowed reference.

    Return the ith element of o, assuming that o was returned by +PySequence_Fast(), o is not NULL, and that i is within bounds.

    +
    + +
    +
    +PyObject** PySequence_Fast_ITEMS(PyObject *o)
    +

    Return the underlying array of PyObject pointers. Assumes that o was returned +by PySequence_Fast() and o is not NULL.

    +

    Note, if a list gets resized, the reallocation may relocate the items array. +So, only use the underlying array pointer in contexts where the sequence +cannot change.

    +
    + +
    +
    +PyObject* PySequence_ITEM(PyObject *o, Py_ssize_t i)
    +
    Return value: New reference.

    Return the ith element of o or NULL on failure. Macro form of +PySequence_GetItem() but without checking that +PySequence_Check() on o is true and without adjustment for negative +indices.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/set.html b/python-3.7.4-docs-html/c-api/set.html new file mode 100644 index 0000000..e0de991 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/set.html @@ -0,0 +1,349 @@ + + + + + + + Set Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Set Objects

    +

    This section details the public API for set and frozenset +objects. Any functionality not listed below is best accessed using the either +the abstract object protocol (including PyObject_CallMethod(), +PyObject_RichCompareBool(), PyObject_Hash(), +PyObject_Repr(), PyObject_IsTrue(), PyObject_Print(), and +PyObject_GetIter()) or the abstract number protocol (including +PyNumber_And(), PyNumber_Subtract(), PyNumber_Or(), +PyNumber_Xor(), PyNumber_InPlaceAnd(), +PyNumber_InPlaceSubtract(), PyNumber_InPlaceOr(), and +PyNumber_InPlaceXor()).

    +
    +
    +PySetObject
    +

    This subtype of PyObject is used to hold the internal data for both +set and frozenset objects. It is like a PyDictObject +in that it is a fixed size for small sets (much like tuple storage) and will +point to a separate, variable sized block of memory for medium and large sized +sets (much like list storage). None of the fields of this structure should be +considered public and are subject to change. All access should be done through +the documented API rather than by manipulating the values in the structure.

    +
    + +
    +
    +PyTypeObject PySet_Type
    +

    This is an instance of PyTypeObject representing the Python +set type.

    +
    + +
    +
    +PyTypeObject PyFrozenSet_Type
    +

    This is an instance of PyTypeObject representing the Python +frozenset type.

    +
    + +

    The following type check macros work on pointers to any Python object. Likewise, +the constructor functions work with any iterable Python object.

    +
    +
    +int PySet_Check(PyObject *p)
    +

    Return true if p is a set object or an instance of a subtype.

    +
    + +
    +
    +int PyFrozenSet_Check(PyObject *p)
    +

    Return true if p is a frozenset object or an instance of a +subtype.

    +
    + +
    +
    +int PyAnySet_Check(PyObject *p)
    +

    Return true if p is a set object, a frozenset object, or an +instance of a subtype.

    +
    + +
    +
    +int PyAnySet_CheckExact(PyObject *p)
    +

    Return true if p is a set object or a frozenset object but +not an instance of a subtype.

    +
    + +
    +
    +int PyFrozenSet_CheckExact(PyObject *p)
    +

    Return true if p is a frozenset object but not an instance of a +subtype.

    +
    + +
    +
    +PyObject* PySet_New(PyObject *iterable)
    +
    Return value: New reference.

    Return a new set containing objects returned by the iterable. The +iterable may be NULL to create a new empty set. Return the new set on +success or NULL on failure. Raise TypeError if iterable is not +actually iterable. The constructor is also useful for copying a set +(c=set(s)).

    +
    + +
    +
    +PyObject* PyFrozenSet_New(PyObject *iterable)
    +
    Return value: New reference.

    Return a new frozenset containing objects returned by the iterable. +The iterable may be NULL to create a new empty frozenset. Return the new +set on success or NULL on failure. Raise TypeError if iterable is +not actually iterable.

    +
    + +

    The following functions and macros are available for instances of set +or frozenset or instances of their subtypes.

    +
    +
    +Py_ssize_t PySet_Size(PyObject *anyset)
    +

    Return the length of a set or frozenset object. Equivalent to +len(anyset). Raises a PyExc_SystemError if anyset is not a +set, frozenset, or an instance of a subtype.

    +
    + +
    +
    +Py_ssize_t PySet_GET_SIZE(PyObject *anyset)
    +

    Macro form of PySet_Size() without error checking.

    +
    + +
    +
    +int PySet_Contains(PyObject *anyset, PyObject *key)
    +

    Return 1 if found, 0 if not found, and -1 if an error is encountered. Unlike +the Python __contains__() method, this function does not automatically +convert unhashable sets into temporary frozensets. Raise a TypeError if +the key is unhashable. Raise PyExc_SystemError if anyset is not a +set, frozenset, or an instance of a subtype.

    +
    + +
    +
    +int PySet_Add(PyObject *set, PyObject *key)
    +

    Add key to a set instance. Also works with frozenset +instances (like PyTuple_SetItem() it can be used to fill-in the values +of brand new frozensets before they are exposed to other code). Return 0 on +success or -1 on failure. Raise a TypeError if the key is +unhashable. Raise a MemoryError if there is no room to grow. Raise a +SystemError if set is not an instance of set or its +subtype.

    +
    + +

    The following functions are available for instances of set or its +subtypes but not for instances of frozenset or its subtypes.

    +
    +
    +int PySet_Discard(PyObject *set, PyObject *key)
    +

    Return 1 if found and removed, 0 if not found (no action taken), and -1 if an +error is encountered. Does not raise KeyError for missing keys. Raise a +TypeError if the key is unhashable. Unlike the Python discard() +method, this function does not automatically convert unhashable sets into +temporary frozensets. Raise PyExc_SystemError if set is not an +instance of set or its subtype.

    +
    + +
    +
    +PyObject* PySet_Pop(PyObject *set)
    +
    Return value: New reference.

    Return a new reference to an arbitrary object in the set, and removes the +object from the set. Return NULL on failure. Raise KeyError if the +set is empty. Raise a SystemError if set is not an instance of +set or its subtype.

    +
    + +
    +
    +int PySet_Clear(PyObject *set)
    +

    Empty an existing set of all elements.

    +
    + +
    +
    +int PySet_ClearFreeList()
    +

    Clear the free list. Return the total number of freed items.

    +
    +

    New in version 3.3.

    +
    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/slice.html b/python-3.7.4-docs-html/c-api/slice.html new file mode 100644 index 0000000..e8ccf56 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/slice.html @@ -0,0 +1,311 @@ + + + + + + + Slice Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Slice Objects

    +
    +
    +PyTypeObject PySlice_Type
    +

    The type object for slice objects. This is the same as slice in the +Python layer.

    +
    + +
    +
    +int PySlice_Check(PyObject *ob)
    +

    Return true if ob is a slice object; ob must not be NULL.

    +
    + +
    +
    +PyObject* PySlice_New(PyObject *start, PyObject *stop, PyObject *step)
    +
    Return value: New reference.

    Return a new slice object with the given values. The start, stop, and +step parameters are used as the values of the slice object attributes of +the same names. Any of the values may be NULL, in which case the +None will be used for the corresponding attribute. Return NULL if +the new object could not be allocated.

    +
    + +
    +
    +int PySlice_GetIndices(PyObject *slice, Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step)
    +

    Retrieve the start, stop and step indices from the slice object slice, +assuming a sequence of length length. Treats indices greater than +length as errors.

    +

    Returns 0 on success and -1 on error with no exception set (unless one of +the indices was not None and failed to be converted to an integer, +in which case -1 is returned with an exception set).

    +

    You probably do not want to use this function.

    +
    +

    Changed in version 3.2: The parameter type for the slice parameter was PySliceObject* +before.

    +
    +
    + +
    +
    +int PySlice_GetIndicesEx(PyObject *slice, Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step, Py_ssize_t *slicelength)
    +

    Usable replacement for PySlice_GetIndices(). Retrieve the start, +stop, and step indices from the slice object slice assuming a sequence of +length length, and store the length of the slice in slicelength. Out +of bounds indices are clipped in a manner consistent with the handling of +normal slices.

    +

    Returns 0 on success and -1 on error with exception set.

    +
    +

    Note

    +

    This function is considered not safe for resizable sequences. +Its invocation should be replaced by a combination of +PySlice_Unpack() and PySlice_AdjustIndices() where

    +
    if (PySlice_GetIndicesEx(slice, length, &start, &stop, &step, &slicelength) < 0) {
    +    // return error
    +}
    +
    +
    +

    is replaced by

    +
    if (PySlice_Unpack(slice, &start, &stop, &step) < 0) {
    +    // return error
    +}
    +slicelength = PySlice_AdjustIndices(length, &start, &stop, step);
    +
    +
    +
    +
    +

    Changed in version 3.2: The parameter type for the slice parameter was PySliceObject* +before.

    +
    +
    +

    Changed in version 3.6.1: If Py_LIMITED_API is not set or set to the value between 0x03050400 +and 0x03060000 (not including) or 0x03060100 or higher +PySlice_GetIndicesEx() is implemented as a macro using +PySlice_Unpack() and PySlice_AdjustIndices(). +Arguments start, stop and step are evaluated more than once.

    +
    +
    +

    Deprecated since version 3.6.1: If Py_LIMITED_API is set to the value less than 0x03050400 or +between 0x03060000 and 0x03060100 (not including) +PySlice_GetIndicesEx() is a deprecated function.

    +
    +
    + +
    +
    +int PySlice_Unpack(PyObject *slice, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step)
    +

    Extract the start, stop and step data members from a slice object as +C integers. Silently reduce values larger than PY_SSIZE_T_MAX to +PY_SSIZE_T_MAX, silently boost the start and stop values less than +PY_SSIZE_T_MIN to PY_SSIZE_T_MIN, and silently boost the step +values less than -PY_SSIZE_T_MAX to -PY_SSIZE_T_MAX.

    +

    Return -1 on error, 0 on success.

    +
    +

    New in version 3.6.1.

    +
    +
    + +
    +
    +Py_ssize_t PySlice_AdjustIndices(Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t step)
    +

    Adjust start/end slice indices assuming a sequence of the specified length. +Out of bounds indices are clipped in a manner consistent with the handling +of normal slices.

    +

    Return the length of the slice. Always successful. Doesn’t call Python +code.

    +
    +

    New in version 3.6.1.

    +
    +
    + +
    +
    +

    Ellipsis Object

    +
    +
    +PyObject *Py_Ellipsis
    +

    The Python Ellipsis object. This object has no methods. It needs to be +treated just like any other object with respect to reference counts. Like +Py_None it is a singleton object.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/stable.html b/python-3.7.4-docs-html/c-api/stable.html new file mode 100644 index 0000000..3421abc --- /dev/null +++ b/python-3.7.4-docs-html/c-api/stable.html @@ -0,0 +1,207 @@ + + + + + + + Stable Application Binary Interface — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Stable Application Binary Interface

    +

    Traditionally, the C API of Python will change with every release. Most changes +will be source-compatible, typically by only adding API, rather than changing +existing API or removing API (although some interfaces do get removed after +being deprecated first).

    +

    Unfortunately, the API compatibility does not extend to binary compatibility +(the ABI). The reason is primarily the evolution of struct definitions, where +addition of a new field, or changing the type of a field, might not break the +API, but can break the ABI. As a consequence, extension modules need to be +recompiled for every Python release (although an exception is possible on Unix +when none of the affected interfaces are used). In addition, on Windows, +extension modules link with a specific pythonXY.dll and need to be recompiled to +link with a newer one.

    +

    Since Python 3.2, a subset of the API has been declared to guarantee a stable +ABI. Extension modules wishing to use this API (called “limited API”) need to +define Py_LIMITED_API. A number of interpreter details then become hidden +from the extension module; in return, a module is built that works on any 3.x +version (x>=2) without recompilation.

    +

    In some cases, the stable ABI needs to be extended with new functions. +Extension modules wishing to use these new APIs need to set Py_LIMITED_API +to the PY_VERSION_HEX value (see API and ABI Versioning) of the minimum Python +version they want to support (e.g. 0x03030000 for Python 3.3). Such modules +will work on all subsequent Python releases, but fail to load (because of +missing symbols) on the older releases.

    +

    As of Python 3.2, the set of functions available to the limited API is +documented in PEP 384. In the C API documentation, API elements that are not +part of the limited API are marked as “Not part of the limited API.”

    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/structures.html b/python-3.7.4-docs-html/c-api/structures.html new file mode 100644 index 0000000..80a8d43 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/structures.html @@ -0,0 +1,672 @@ + + + + + + + Common Object Structures — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Common Object Structures

    +

    There are a large number of structures which are used in the definition of +object types for Python. This section describes these structures and how they +are used.

    +

    All Python objects ultimately share a small number of fields at the beginning +of the object’s representation in memory. These are represented by the +PyObject and PyVarObject types, which are defined, in turn, +by the expansions of some macros also used, whether directly or indirectly, in +the definition of all other Python objects.

    +
    +
    +PyObject
    +

    All object types are extensions of this type. This is a type which +contains the information Python needs to treat a pointer to an object as an +object. In a normal “release” build, it contains only the object’s +reference count and a pointer to the corresponding type object. +Nothing is actually declared to be a PyObject, but every pointer +to a Python object can be cast to a PyObject*. Access to the +members must be done by using the macros Py_REFCNT and +Py_TYPE.

    +
    + +
    +
    +PyVarObject
    +

    This is an extension of PyObject that adds the ob_size +field. This is only used for objects that have some notion of length. +This type does not often appear in the Python/C API. +Access to the members must be done by using the macros +Py_REFCNT, Py_TYPE, and Py_SIZE.

    +
    + +
    +
    +PyObject_HEAD
    +

    This is a macro used when declaring new types which represent objects +without a varying length. The PyObject_HEAD macro expands to:

    +
    PyObject ob_base;
    +
    +
    +

    See documentation of PyObject above.

    +
    + +
    +
    +PyObject_VAR_HEAD
    +

    This is a macro used when declaring new types which represent objects +with a length that varies from instance to instance. +The PyObject_VAR_HEAD macro expands to:

    +
    PyVarObject ob_base;
    +
    +
    +

    See documentation of PyVarObject above.

    +
    + +
    +
    +Py_TYPE(o)
    +

    This macro is used to access the ob_type member of a Python object. +It expands to:

    +
    (((PyObject*)(o))->ob_type)
    +
    +
    +
    + +
    +
    +Py_REFCNT(o)
    +

    This macro is used to access the ob_refcnt member of a Python +object. +It expands to:

    +
    (((PyObject*)(o))->ob_refcnt)
    +
    +
    +
    + +
    +
    +Py_SIZE(o)
    +

    This macro is used to access the ob_size member of a Python object. +It expands to:

    +
    (((PyVarObject*)(o))->ob_size)
    +
    +
    +
    + +
    +
    +PyObject_HEAD_INIT(type)
    +

    This is a macro which expands to initialization values for a new +PyObject type. This macro expands to:

    +
    _PyObject_EXTRA_INIT
    +1, type,
    +
    +
    +
    + +
    +
    +PyVarObject_HEAD_INIT(type, size)
    +

    This is a macro which expands to initialization values for a new +PyVarObject type, including the ob_size field. +This macro expands to:

    +
    _PyObject_EXTRA_INIT
    +1, type, size,
    +
    +
    +
    + +
    +
    +PyCFunction
    +

    Type of the functions used to implement most Python callables in C. +Functions of this type take two PyObject* parameters and return +one such value. If the return value is NULL, an exception shall have +been set. If not NULL, the return value is interpreted as the return +value of the function as exposed in Python. The function must return a new +reference.

    +
    + +
    +
    +PyCFunctionWithKeywords
    +

    Type of the functions used to implement Python callables in C +with signature METH_VARARGS | METH_KEYWORDS.

    +
    + +
    +
    +_PyCFunctionFast
    +

    Type of the functions used to implement Python callables in C +with signature METH_FASTCALL.

    +
    + +
    +
    +_PyCFunctionFastWithKeywords
    +

    Type of the functions used to implement Python callables in C +with signature METH_FASTCALL | METH_KEYWORDS.

    +
    + +
    +
    +PyMethodDef
    +

    Structure used to describe a method of an extension type. This structure has +four fields:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + +

    Field

    C Type

    Meaning

    ml_name

    const char *

    name of the method

    ml_meth

    PyCFunction

    pointer to the C +implementation

    ml_flags

    int

    flag bits indicating how the +call should be constructed

    ml_doc

    const char *

    points to the contents of the +docstring

    +
    + +

    The ml_meth is a C function pointer. The functions may be of different +types, but they always return PyObject*. If the function is not of +the PyCFunction, the compiler will require a cast in the method table. +Even though PyCFunction defines the first parameter as +PyObject*, it is common that the method implementation uses the +specific C type of the self object.

    +

    The ml_flags field is a bitfield which can include the following flags. +The individual flags indicate either a calling convention or a binding +convention.

    +

    There are four basic calling conventions for positional arguments +and two of them can be combined with METH_KEYWORDS to support +also keyword arguments. So there are a total of 6 calling conventions:

    +
    +
    +METH_VARARGS
    +

    This is the typical calling convention, where the methods have the type +PyCFunction. The function expects two PyObject* values. +The first one is the self object for methods; for module functions, it is +the module object. The second parameter (often called args) is a tuple +object representing all arguments. This parameter is typically processed +using PyArg_ParseTuple() or PyArg_UnpackTuple().

    +
    + +
    +
    +METH_VARARGS | METH_KEYWORDS
    +

    Methods with these flags must be of type PyCFunctionWithKeywords. +The function expects three parameters: self, args, kwargs where +kwargs is a dictionary of all the keyword arguments or possibly NULL +if there are no keyword arguments. The parameters are typically processed +using PyArg_ParseTupleAndKeywords().

    +
    + +
    +
    +METH_FASTCALL
    +

    Fast calling convention supporting only positional arguments. +The methods have the type _PyCFunctionFast. +The first parameter is self, the second parameter is a C array +of PyObject* values indicating the arguments and the third +parameter is the number of arguments (the length of the array).

    +

    This is not part of the limited API.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +METH_FASTCALL | METH_KEYWORDS
    +

    Extension of METH_FASTCALL supporting also keyword arguments, +with methods of type _PyCFunctionFastWithKeywords. +Keyword arguments are passed the same way as in the vectorcall protocol: +there is an additional fourth PyObject* parameter +which is a tuple representing the names of the keyword arguments +or possibly NULL if there are no keywords. The values of the keyword +arguments are stored in the args array, after the positional arguments.

    +

    This is not part of the limited API.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +METH_NOARGS
    +

    Methods without parameters don’t need to check whether arguments are given if +they are listed with the METH_NOARGS flag. They need to be of type +PyCFunction. The first parameter is typically named self and will +hold a reference to the module or object instance. In all cases the second +parameter will be NULL.

    +
    + +
    +
    +METH_O
    +

    Methods with a single object argument can be listed with the METH_O +flag, instead of invoking PyArg_ParseTuple() with a "O" argument. +They have the type PyCFunction, with the self parameter, and a +PyObject* parameter representing the single argument.

    +
    + +

    These two constants are not used to indicate the calling convention but the +binding when use with methods of classes. These may not be used for functions +defined for modules. At most one of these flags may be set for any given +method.

    +
    +
    +METH_CLASS
    +

    The method will be passed the type object as the first parameter rather +than an instance of the type. This is used to create class methods, +similar to what is created when using the classmethod() built-in +function.

    +
    + +
    +
    +METH_STATIC
    +

    The method will be passed NULL as the first parameter rather than an +instance of the type. This is used to create static methods, similar to +what is created when using the staticmethod() built-in function.

    +
    + +

    One other constant controls whether a method is loaded in place of another +definition with the same method name.

    +
    +
    +METH_COEXIST
    +

    The method will be loaded in place of existing definitions. Without +METH_COEXIST, the default is to skip repeated definitions. Since slot +wrappers are loaded before the method table, the existence of a +sq_contains slot, for example, would generate a wrapped method named +__contains__() and preclude the loading of a corresponding +PyCFunction with the same name. With the flag defined, the PyCFunction +will be loaded in place of the wrapper object and will co-exist with the +slot. This is helpful because calls to PyCFunctions are optimized more +than wrapper object calls.

    +
    + +
    +
    +PyMemberDef
    +

    Structure which describes an attribute of a type which corresponds to a C +struct member. Its fields are:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Field

    C Type

    Meaning

    name

    const char *

    name of the member

    type

    int

    the type of the member in the +C struct

    offset

    Py_ssize_t

    the offset in bytes that the +member is located on the +type’s object struct

    flags

    int

    flag bits indicating if the +field should be read-only or +writable

    doc

    const char *

    points to the contents of the +docstring

    +

    type can be one of many T_ macros corresponding to various C +types. When the member is accessed in Python, it will be converted to the +equivalent Python type.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Macro name

    C type

    T_SHORT

    short

    T_INT

    int

    T_LONG

    long

    T_FLOAT

    float

    T_DOUBLE

    double

    T_STRING

    const char *

    T_OBJECT

    PyObject *

    T_OBJECT_EX

    PyObject *

    T_CHAR

    char

    T_BYTE

    char

    T_UBYTE

    unsigned char

    T_UINT

    unsigned int

    T_USHORT

    unsigned short

    T_ULONG

    unsigned long

    T_BOOL

    char

    T_LONGLONG

    long long

    T_ULONGLONG

    unsigned long long

    T_PYSSIZET

    Py_ssize_t

    +

    T_OBJECT and T_OBJECT_EX differ in that +T_OBJECT returns None if the member is NULL and +T_OBJECT_EX raises an AttributeError. Try to use +T_OBJECT_EX over T_OBJECT because T_OBJECT_EX +handles use of the del statement on that attribute more correctly +than T_OBJECT.

    +

    flags can be 0 for write and read access or READONLY for +read-only access. Using T_STRING for type implies +READONLY. T_STRING data is interpreted as UTF-8. +Only T_OBJECT and T_OBJECT_EX +members can be deleted. (They are set to NULL).

    +
    + +
    +
    +PyGetSetDef
    +

    Structure to define property-like access for a type. See also description of +the PyTypeObject.tp_getset slot.

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Field

    C Type

    Meaning

    name

    const char *

    attribute name

    get

    getter

    C Function to get the attribute

    set

    setter

    optional C function to set or +delete the attribute, if omitted +the attribute is readonly

    doc

    const char *

    optional docstring

    closure

    void *

    optional function pointer, +providing additional data for +getter and setter

    +

    The get function takes one PyObject* parameter (the +instance) and a function pointer (the associated closure):

    +
    typedef PyObject *(*getter)(PyObject *, void *);
    +
    +
    +

    It should return a new reference on success or NULL with a set exception +on failure.

    +

    set functions take two PyObject* parameters (the instance and +the value to be set) and a function pointer (the associated closure):

    +
    typedef int (*setter)(PyObject *, PyObject *, void *);
    +
    +
    +

    In case the attribute should be deleted the second parameter is NULL. +Should return 0 on success or -1 with a set exception on failure.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/sys.html b/python-3.7.4-docs-html/c-api/sys.html new file mode 100644 index 0000000..bab429e --- /dev/null +++ b/python-3.7.4-docs-html/c-api/sys.html @@ -0,0 +1,536 @@ + + + + + + + Operating System Utilities — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Operating System Utilities

    +
    +
    +PyObject* PyOS_FSPath(PyObject *path)
    +
    Return value: New reference.

    Return the file system representation for path. If the object is a +str or bytes object, then its reference count is +incremented. If the object implements the os.PathLike interface, +then __fspath__() is returned as long as it is a +str or bytes object. Otherwise TypeError is raised +and NULL is returned.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +int Py_FdIsInteractive(FILE *fp, const char *filename)
    +

    Return true (nonzero) if the standard I/O file fp with name filename is +deemed interactive. This is the case for files for which isatty(fileno(fp)) +is true. If the global flag Py_InteractiveFlag is true, this function +also returns true if the filename pointer is NULL or if the name is equal to +one of the strings '<stdin>' or '???'.

    +
    + +
    +
    +void PyOS_BeforeFork()
    +

    Function to prepare some internal state before a process fork. This +should be called before calling fork() or any similar function +that clones the current process. +Only available on systems where fork() is defined.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +void PyOS_AfterFork_Parent()
    +

    Function to update some internal state after a process fork. This +should be called from the parent process after calling fork() +or any similar function that clones the current process, regardless +of whether process cloning was successful. +Only available on systems where fork() is defined.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +void PyOS_AfterFork_Child()
    +

    Function to update internal interpreter state after a process fork. +This must be called from the child process after calling fork(), +or any similar function that clones the current process, if there is +any chance the process will call back into the Python interpreter. +Only available on systems where fork() is defined.

    +
    +

    New in version 3.7.

    +
    +
    +

    See also

    +

    os.register_at_fork() allows registering custom Python functions +to be called by PyOS_BeforeFork(), +PyOS_AfterFork_Parent() and PyOS_AfterFork_Child().

    +
    +
    + +
    +
    +void PyOS_AfterFork()
    +

    Function to update some internal state after a process fork; this should be +called in the new process if the Python interpreter will continue to be used. +If a new executable is loaded into the new process, this function does not need +to be called.

    +
    +

    Deprecated since version 3.7: This function is superseded by PyOS_AfterFork_Child().

    +
    +
    + +
    +
    +int PyOS_CheckStack()
    +

    Return true when the interpreter runs out of stack space. This is a reliable +check, but is only available when USE_STACKCHECK is defined (currently +on Windows using the Microsoft Visual C++ compiler). USE_STACKCHECK +will be defined automatically; you should never change the definition in your +own code.

    +
    + +
    +
    +PyOS_sighandler_t PyOS_getsig(int i)
    +

    Return the current signal handler for signal i. This is a thin wrapper around +either sigaction() or signal(). Do not call those functions +directly! PyOS_sighandler_t is a typedef alias for void +(*)(int).

    +
    + +
    +
    +PyOS_sighandler_t PyOS_setsig(int i, PyOS_sighandler_t h)
    +

    Set the signal handler for signal i to be h; return the old signal handler. +This is a thin wrapper around either sigaction() or signal(). Do +not call those functions directly! PyOS_sighandler_t is a typedef +alias for void (*)(int).

    +
    + +
    +
    +wchar_t* Py_DecodeLocale(const char* arg, size_t *size)
    +

    Decode a byte string from the locale encoding with the surrogateescape +error handler: undecodable bytes are decoded as +characters in range U+DC80..U+DCFF. If a byte sequence can be decoded as a +surrogate character, escape the bytes using the surrogateescape error +handler instead of decoding them.

    +

    Encoding, highest priority to lowest priority:

    +
      +
    • UTF-8 on macOS and Android;

    • +
    • UTF-8 if the Python UTF-8 mode is enabled;

    • +
    • ASCII if the LC_CTYPE locale is "C", +nl_langinfo(CODESET) returns the ASCII encoding (or an alias), +and mbstowcs() and wcstombs() functions uses the +ISO-8859-1 encoding.

    • +
    • the current locale encoding.

    • +
    +

    Return a pointer to a newly allocated wide character string, use +PyMem_RawFree() to free the memory. If size is not NULL, write +the number of wide characters excluding the null character into *size

    +

    Return NULL on decoding error or memory allocation error. If size is +not NULL, *size is set to (size_t)-1 on memory error or set to +(size_t)-2 on decoding error.

    +

    Decoding errors should never happen, unless there is a bug in the C +library.

    +

    Use the Py_EncodeLocale() function to encode the character string +back to a byte string.

    + +
    +

    New in version 3.5.

    +
    +
    +

    Changed in version 3.7: The function now uses the UTF-8 encoding in the UTF-8 mode.

    +
    +
    + +
    +
    +char* Py_EncodeLocale(const wchar_t *text, size_t *error_pos)
    +

    Encode a wide character string to the locale encoding with the +surrogateescape error handler: surrogate characters +in the range U+DC80..U+DCFF are converted to bytes 0x80..0xFF.

    +

    Encoding, highest priority to lowest priority:

    +
      +
    • UTF-8 on macOS and Android;

    • +
    • UTF-8 if the Python UTF-8 mode is enabled;

    • +
    • ASCII if the LC_CTYPE locale is "C", +nl_langinfo(CODESET) returns the ASCII encoding (or an alias), +and mbstowcs() and wcstombs() functions uses the +ISO-8859-1 encoding.

    • +
    • the current locale encoding.

    • +
    +

    The function uses the UTF-8 encoding in the Python UTF-8 mode.

    +

    Return a pointer to a newly allocated byte string, use PyMem_Free() +to free the memory. Return NULL on encoding error or memory allocation +error

    +

    If error_pos is not NULL, *error_pos is set to (size_t)-1 on +success, or set to the index of the invalid character on encoding error.

    +

    Use the Py_DecodeLocale() function to decode the bytes string back +to a wide character string.

    +
    +

    Changed in version 3.7: The function now uses the UTF-8 encoding in the UTF-8 mode.

    +
    +
    +

    See also

    +

    The PyUnicode_EncodeFSDefault() and +PyUnicode_EncodeLocale() functions.

    +
    +
    +

    New in version 3.5.

    +
    +
    +

    Changed in version 3.7: The function now supports the UTF-8 mode.

    +
    +
    + +
    +
    +

    System Functions

    +

    These are utility functions that make functionality from the sys module +accessible to C code. They all work with the current interpreter thread’s +sys module’s dict, which is contained in the internal thread state structure.

    +
    +
    +PyObject *PySys_GetObject(const char *name)
    +
    Return value: Borrowed reference.

    Return the object name from the sys module or NULL if it does +not exist, without setting an exception.

    +
    + +
    +
    +int PySys_SetObject(const char *name, PyObject *v)
    +

    Set name in the sys module to v unless v is NULL, in which +case name is deleted from the sys module. Returns 0 on success, -1 +on error.

    +
    + +
    +
    +void PySys_ResetWarnOptions()
    +

    Reset sys.warnoptions to an empty list. This function may be +called prior to Py_Initialize().

    +
    + +
    +
    +void PySys_AddWarnOption(const wchar_t *s)
    +

    Append s to sys.warnoptions. This function must be called prior +to Py_Initialize() in order to affect the warnings filter list.

    +
    + +
    +
    +void PySys_AddWarnOptionUnicode(PyObject *unicode)
    +

    Append unicode to sys.warnoptions.

    +

    Note: this function is not currently usable from outside the CPython +implementation, as it must be called prior to the implicit import of +warnings in Py_Initialize() to be effective, but can’t be +called until enough of the runtime has been initialized to permit the +creation of Unicode objects.

    +
    + +
    +
    +void PySys_SetPath(const wchar_t *path)
    +

    Set sys.path to a list object of paths found in path which should +be a list of paths separated with the platform’s search path delimiter +(: on Unix, ; on Windows).

    +
    + +
    +
    +void PySys_WriteStdout(const char *format, ...)
    +

    Write the output string described by format to sys.stdout. No +exceptions are raised, even if truncation occurs (see below).

    +

    format should limit the total size of the formatted output string to +1000 bytes or less – after 1000 bytes, the output string is truncated. +In particular, this means that no unrestricted “%s” formats should occur; +these should be limited using “%.<N>s” where <N> is a decimal number +calculated so that <N> plus the maximum size of other formatted text does not +exceed 1000 bytes. Also watch out for “%f”, which can print hundreds of +digits for very large numbers.

    +

    If a problem occurs, or sys.stdout is unset, the formatted message +is written to the real (C level) stdout.

    +
    + +
    +
    +void PySys_WriteStderr(const char *format, ...)
    +

    As PySys_WriteStdout(), but write to sys.stderr or stderr +instead.

    +
    + +
    +
    +void PySys_FormatStdout(const char *format, ...)
    +

    Function similar to PySys_WriteStdout() but format the message using +PyUnicode_FromFormatV() and don’t truncate the message to an +arbitrary length.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +void PySys_FormatStderr(const char *format, ...)
    +

    As PySys_FormatStdout(), but write to sys.stderr or stderr +instead.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +void PySys_AddXOption(const wchar_t *s)
    +

    Parse s as a set of -X options and add them to the current +options mapping as returned by PySys_GetXOptions(). This function +may be called prior to Py_Initialize().

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +PyObject *PySys_GetXOptions()
    +
    Return value: Borrowed reference.

    Return the current dictionary of -X options, similarly to +sys._xoptions. On error, NULL is returned and an exception is +set.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +

    Process Control

    +
    +
    +void Py_FatalError(const char *message)
    +

    Print a fatal error message and kill the process. No cleanup is performed. +This function should only be invoked when a condition is detected that would +make it dangerous to continue using the Python interpreter; e.g., when the +object administration appears to be corrupted. On Unix, the standard C library +function abort() is called which will attempt to produce a core +file.

    +
    + +
    +
    +void Py_Exit(int status)
    +

    Exit the current process. This calls Py_FinalizeEx() and then calls the +standard C library function exit(status). If Py_FinalizeEx() +indicates an error, the exit status is set to 120.

    +
    +

    Changed in version 3.6: Errors from finalization no longer ignored.

    +
    +
    + +
    +
    +int Py_AtExit(void (*func)())
    +

    Register a cleanup function to be called by Py_FinalizeEx(). The cleanup +function will be called with no arguments and should return no value. At most +32 cleanup functions can be registered. When the registration is successful, +Py_AtExit() returns 0; on failure, it returns -1. The cleanup +function registered last is called first. Each cleanup function will be called +at most once. Since Python’s internal finalization will have completed before +the cleanup function, no Python APIs should be called by func.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/tuple.html b/python-3.7.4-docs-html/c-api/tuple.html new file mode 100644 index 0000000..c56014f --- /dev/null +++ b/python-3.7.4-docs-html/c-api/tuple.html @@ -0,0 +1,459 @@ + + + + + + + Tuple Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Tuple Objects

    +
    +
    +PyTupleObject
    +

    This subtype of PyObject represents a Python tuple object.

    +
    + +
    +
    +PyTypeObject PyTuple_Type
    +

    This instance of PyTypeObject represents the Python tuple type; it +is the same object as tuple in the Python layer.

    +
    + +
    +
    +int PyTuple_Check(PyObject *p)
    +

    Return true if p is a tuple object or an instance of a subtype of the tuple +type.

    +
    + +
    +
    +int PyTuple_CheckExact(PyObject *p)
    +

    Return true if p is a tuple object, but not an instance of a subtype of the +tuple type.

    +
    + +
    +
    +PyObject* PyTuple_New(Py_ssize_t len)
    +
    Return value: New reference.

    Return a new tuple object of size len, or NULL on failure.

    +
    + +
    +
    +PyObject* PyTuple_Pack(Py_ssize_t n, ...)
    +
    Return value: New reference.

    Return a new tuple object of size n, or NULL on failure. The tuple values +are initialized to the subsequent n C arguments pointing to Python objects. +PyTuple_Pack(2, a, b) is equivalent to Py_BuildValue("(OO)", a, b).

    +
    + +
    +
    +Py_ssize_t PyTuple_Size(PyObject *p)
    +

    Take a pointer to a tuple object, and return the size of that tuple.

    +
    + +
    +
    +Py_ssize_t PyTuple_GET_SIZE(PyObject *p)
    +

    Return the size of the tuple p, which must be non-NULL and point to a tuple; +no error checking is performed.

    +
    + +
    +
    +PyObject* PyTuple_GetItem(PyObject *p, Py_ssize_t pos)
    +
    Return value: Borrowed reference.

    Return the object at position pos in the tuple pointed to by p. If pos is +out of bounds, return NULL and sets an IndexError exception.

    +
    + +
    +
    +PyObject* PyTuple_GET_ITEM(PyObject *p, Py_ssize_t pos)
    +
    Return value: Borrowed reference.

    Like PyTuple_GetItem(), but does no checking of its arguments.

    +
    + +
    +
    +PyObject* PyTuple_GetSlice(PyObject *p, Py_ssize_t low, Py_ssize_t high)
    +
    Return value: New reference.

    Take a slice of the tuple pointed to by p from low to high and return it +as a new tuple.

    +
    + +
    +
    +int PyTuple_SetItem(PyObject *p, Py_ssize_t pos, PyObject *o)
    +

    Insert a reference to object o at position pos of the tuple pointed to by +p. Return 0 on success.

    +
    +

    Note

    +

    This function “steals” a reference to o.

    +
    +
    + +
    +
    +void PyTuple_SET_ITEM(PyObject *p, Py_ssize_t pos, PyObject *o)
    +

    Like PyTuple_SetItem(), but does no error checking, and should only be +used to fill in brand new tuples.

    +
    +

    Note

    +

    This function “steals” a reference to o.

    +
    +
    + +
    +
    +int _PyTuple_Resize(PyObject **p, Py_ssize_t newsize)
    +

    Can be used to resize a tuple. newsize will be the new length of the tuple. +Because tuples are supposed to be immutable, this should only be used if there +is only one reference to the object. Do not use this if the tuple may already +be known to some other part of the code. The tuple will always grow or shrink +at the end. Think of this as destroying the old tuple and creating a new one, +only more efficiently. Returns 0 on success. Client code should never +assume that the resulting value of *p will be the same as before calling +this function. If the object referenced by *p is replaced, the original +*p is destroyed. On failure, returns -1 and sets *p to NULL, and +raises MemoryError or SystemError.

    +
    + +
    +
    +int PyTuple_ClearFreeList()
    +

    Clear the free list. Return the total number of freed items.

    +
    + +
    +
    +

    Struct Sequence Objects

    +

    Struct sequence objects are the C equivalent of namedtuple() +objects, i.e. a sequence whose items can also be accessed through attributes. +To create a struct sequence, you first have to create a specific struct sequence +type.

    +
    +
    +PyTypeObject* PyStructSequence_NewType(PyStructSequence_Desc *desc)
    +
    Return value: New reference.

    Create a new struct sequence type from the data in desc, described below. Instances +of the resulting type can be created with PyStructSequence_New().

    +
    + +
    +
    +void PyStructSequence_InitType(PyTypeObject *type, PyStructSequence_Desc *desc)
    +

    Initializes a struct sequence type type from desc in place.

    +
    + +
    +
    +int PyStructSequence_InitType2(PyTypeObject *type, PyStructSequence_Desc *desc)
    +

    The same as PyStructSequence_InitType, but returns 0 on success and -1 on +failure.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +PyStructSequence_Desc
    +

    Contains the meta information of a struct sequence type to create.

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + +

    Field

    C Type

    Meaning

    name

    const char *

    name of the struct sequence type

    doc

    const char *

    pointer to docstring for the type +or NULL to omit

    fields

    PyStructSequence_Field *

    pointer to NULL-terminated array +with field names of the new type

    n_in_sequence

    int

    number of fields visible to the +Python side (if used as tuple)

    +
    + +
    +
    +PyStructSequence_Field
    +

    Describes a field of a struct sequence. As a struct sequence is modeled as a +tuple, all fields are typed as PyObject*. The index in the +fields array of the PyStructSequence_Desc determines which +field of the struct sequence is described.

    + +++++ + + + + + + + + + + + + + + + + +

    Field

    C Type

    Meaning

    name

    const char *

    name for the field or NULL to end +the list of named fields, set to +PyStructSequence_UnnamedField to +leave unnamed

    doc

    const char *

    field docstring or NULL to omit

    +
    + +
    +
    +char* PyStructSequence_UnnamedField
    +

    Special value for a field name to leave it unnamed.

    +
    + +
    +
    +PyObject* PyStructSequence_New(PyTypeObject *type)
    +
    Return value: New reference.

    Creates an instance of type, which must have been created with +PyStructSequence_NewType().

    +
    + +
    +
    +PyObject* PyStructSequence_GetItem(PyObject *p, Py_ssize_t pos)
    +
    Return value: Borrowed reference.

    Return the object at position pos in the struct sequence pointed to by p. +No bounds checking is performed.

    +
    + +
    +
    +PyObject* PyStructSequence_GET_ITEM(PyObject *p, Py_ssize_t pos)
    +
    Return value: Borrowed reference.

    Macro equivalent of PyStructSequence_GetItem().

    +
    + +
    +
    +void PyStructSequence_SetItem(PyObject *p, Py_ssize_t pos, PyObject *o)
    +

    Sets the field at index pos of the struct sequence p to value o. Like +PyTuple_SET_ITEM(), this should only be used to fill in brand new +instances.

    +
    +

    Note

    +

    This function “steals” a reference to o.

    +
    +
    + +
    +
    +void PyStructSequence_SET_ITEM(PyObject *p, Py_ssize_t *pos, PyObject *o)
    +

    Macro equivalent of PyStructSequence_SetItem().

    +
    +

    Note

    +

    This function “steals” a reference to o.

    +
    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/type.html b/python-3.7.4-docs-html/c-api/type.html new file mode 100644 index 0000000..bbea2c3 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/type.html @@ -0,0 +1,317 @@ + + + + + + + Type Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Type Objects

    +
    +
    +PyTypeObject
    +

    The C structure of the objects used to describe built-in types.

    +
    + +
    +
    +PyObject* PyType_Type
    +

    This is the type object for type objects; it is the same object as +type in the Python layer.

    +
    + +
    +
    +int PyType_Check(PyObject *o)
    +

    Return true if the object o is a type object, including instances of types +derived from the standard type object. Return false in all other cases.

    +
    + +
    +
    +int PyType_CheckExact(PyObject *o)
    +

    Return true if the object o is a type object, but not a subtype of the +standard type object. Return false in all other cases.

    +
    + +
    +
    +unsigned int PyType_ClearCache()
    +

    Clear the internal lookup cache. Return the current version tag.

    +
    + +
    +
    +unsigned long PyType_GetFlags(PyTypeObject* type)
    +

    Return the tp_flags member of type. This function is primarily +meant for use with Py_LIMITED_API; the individual flag bits are +guaranteed to be stable across Python releases, but access to +tp_flags itself is not part of the limited API.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.4: The return type is now unsigned long rather than long.

    +
    +
    + +
    +
    +void PyType_Modified(PyTypeObject *type)
    +

    Invalidate the internal lookup cache for the type and all of its +subtypes. This function must be called after any manual +modification of the attributes or base classes of the type.

    +
    + +
    +
    +int PyType_HasFeature(PyTypeObject *o, int feature)
    +

    Return true if the type object o sets the feature feature. Type features +are denoted by single bit flags.

    +
    + +
    +
    +int PyType_IS_GC(PyTypeObject *o)
    +

    Return true if the type object includes support for the cycle detector; this +tests the type flag Py_TPFLAGS_HAVE_GC.

    +
    + +
    +
    +int PyType_IsSubtype(PyTypeObject *a, PyTypeObject *b)
    +

    Return true if a is a subtype of b.

    +

    This function only checks for actual subtypes, which means that +__subclasscheck__() is not called on b. Call +PyObject_IsSubclass() to do the same check that issubclass() +would do.

    +
    + +
    +
    +PyObject* PyType_GenericAlloc(PyTypeObject *type, Py_ssize_t nitems)
    +
    Return value: New reference.

    Generic handler for the tp_alloc slot of a type object. Use +Python’s default memory allocation mechanism to allocate a new instance and +initialize all its contents to NULL.

    +
    + +
    +
    +PyObject* PyType_GenericNew(PyTypeObject *type, PyObject *args, PyObject *kwds)
    +
    Return value: New reference.

    Generic handler for the tp_new slot of a type object. Create a +new instance using the type’s tp_alloc slot.

    +
    + +
    +
    +int PyType_Ready(PyTypeObject *type)
    +

    Finalize a type object. This should be called on all type objects to finish +their initialization. This function is responsible for adding inherited slots +from a type’s base class. Return 0 on success, or return -1 and sets an +exception on error.

    +
    + +
    +
    +PyObject* PyType_FromSpec(PyType_Spec *spec)
    +
    Return value: New reference.

    Creates and returns a heap type object from the spec passed to the function.

    +
    + +
    +
    +PyObject* PyType_FromSpecWithBases(PyType_Spec *spec, PyObject *bases)
    +
    Return value: New reference.

    Creates and returns a heap type object from the spec. In addition to that, +the created heap type contains all types contained by the bases tuple as base +types. This allows the caller to reference other heap types as base types.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +void* PyType_GetSlot(PyTypeObject *type, int slot)
    +

    Return the function pointer stored in the given slot. If the +result is NULL, this indicates that either the slot is NULL, +or that the function was called with invalid parameters. +Callers will typically cast the result pointer into the appropriate +function type.

    +
    +

    New in version 3.4.

    +
    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/typeobj.html b/python-3.7.4-docs-html/c-api/typeobj.html new file mode 100644 index 0000000..c511ef0 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/typeobj.html @@ -0,0 +1,1678 @@ + + + + + + + Type Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Type Objects

    +

    Perhaps one of the most important structures of the Python object system is the +structure that defines a new type: the PyTypeObject structure. Type +objects can be handled using any of the PyObject_*() or +PyType_*() functions, but do not offer much that’s interesting to most +Python applications. These objects are fundamental to how objects behave, so +they are very important to the interpreter itself and to any extension module +that implements new types.

    +

    Type objects are fairly large compared to most of the standard types. The reason +for the size is that each type object stores a large number of values, mostly C +function pointers, each of which implements a small part of the type’s +functionality. The fields of the type object are examined in detail in this +section. The fields will be described in the order in which they occur in the +structure.

    +

    Typedefs: unaryfunc, binaryfunc, ternaryfunc, inquiry, intargfunc, +intintargfunc, intobjargproc, intintobjargproc, objobjargproc, destructor, +freefunc, printfunc, getattrfunc, getattrofunc, setattrfunc, setattrofunc, +reprfunc, hashfunc

    +

    The structure definition for PyTypeObject can be found in +Include/object.h. For convenience of reference, this repeats the +definition found there:

    +
    typedef struct _typeobject {
    +    PyObject_VAR_HEAD
    +    const char *tp_name; /* For printing, in format "<module>.<name>" */
    +    Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */
    +
    +    /* Methods to implement standard operations */
    +
    +    destructor tp_dealloc;
    +    printfunc tp_print;
    +    getattrfunc tp_getattr;
    +    setattrfunc tp_setattr;
    +    PyAsyncMethods *tp_as_async; /* formerly known as tp_compare (Python 2)
    +                                    or tp_reserved (Python 3) */
    +    reprfunc tp_repr;
    +
    +    /* Method suites for standard classes */
    +
    +    PyNumberMethods *tp_as_number;
    +    PySequenceMethods *tp_as_sequence;
    +    PyMappingMethods *tp_as_mapping;
    +
    +    /* More standard operations (here for binary compatibility) */
    +
    +    hashfunc tp_hash;
    +    ternaryfunc tp_call;
    +    reprfunc tp_str;
    +    getattrofunc tp_getattro;
    +    setattrofunc tp_setattro;
    +
    +    /* Functions to access object as input/output buffer */
    +    PyBufferProcs *tp_as_buffer;
    +
    +    /* Flags to define presence of optional/expanded features */
    +    unsigned long tp_flags;
    +
    +    const char *tp_doc; /* Documentation string */
    +
    +    /* call function for all accessible objects */
    +    traverseproc tp_traverse;
    +
    +    /* delete references to contained objects */
    +    inquiry tp_clear;
    +
    +    /* rich comparisons */
    +    richcmpfunc tp_richcompare;
    +
    +    /* weak reference enabler */
    +    Py_ssize_t tp_weaklistoffset;
    +
    +    /* Iterators */
    +    getiterfunc tp_iter;
    +    iternextfunc tp_iternext;
    +
    +    /* Attribute descriptor and subclassing stuff */
    +    struct PyMethodDef *tp_methods;
    +    struct PyMemberDef *tp_members;
    +    struct PyGetSetDef *tp_getset;
    +    struct _typeobject *tp_base;
    +    PyObject *tp_dict;
    +    descrgetfunc tp_descr_get;
    +    descrsetfunc tp_descr_set;
    +    Py_ssize_t tp_dictoffset;
    +    initproc tp_init;
    +    allocfunc tp_alloc;
    +    newfunc tp_new;
    +    freefunc tp_free; /* Low-level free-memory routine */
    +    inquiry tp_is_gc; /* For PyObject_IS_GC */
    +    PyObject *tp_bases;
    +    PyObject *tp_mro; /* method resolution order */
    +    PyObject *tp_cache;
    +    PyObject *tp_subclasses;
    +    PyObject *tp_weaklist;
    +    destructor tp_del;
    +
    +    /* Type attribute cache version tag. Added in version 2.6 */
    +    unsigned int tp_version_tag;
    +
    +    destructor tp_finalize;
    +
    +} PyTypeObject;
    +
    +
    +

    The type object structure extends the PyVarObject structure. The +ob_size field is used for dynamic types (created by type_new(), +usually called from a class statement). Note that PyType_Type (the +metatype) initializes tp_itemsize, which means that its instances (i.e. +type objects) must have the ob_size field.

    +
    +
    +PyObject* PyObject._ob_next
    +
    +PyObject* PyObject._ob_prev
    +

    These fields are only present when the macro Py_TRACE_REFS is defined. +Their initialization to NULL is taken care of by the PyObject_HEAD_INIT +macro. For statically allocated objects, these fields always remain NULL. +For dynamically allocated objects, these two fields are used to link the object +into a doubly-linked list of all live objects on the heap. This could be used +for various debugging purposes; currently the only use is to print the objects +that are still alive at the end of a run when the environment variable +PYTHONDUMPREFS is set.

    +

    These fields are not inherited by subtypes.

    +
    + +
    +
    +Py_ssize_t PyObject.ob_refcnt
    +

    This is the type object’s reference count, initialized to 1 by the +PyObject_HEAD_INIT macro. Note that for statically allocated type objects, +the type’s instances (objects whose ob_type points back to the type) do +not count as references. But for dynamically allocated type objects, the +instances do count as references.

    +

    This field is not inherited by subtypes.

    +
    + +
    +
    +PyTypeObject* PyObject.ob_type
    +

    This is the type’s type, in other words its metatype. It is initialized by the +argument to the PyObject_HEAD_INIT macro, and its value should normally be +&PyType_Type. However, for dynamically loadable extension modules that must +be usable on Windows (at least), the compiler complains that this is not a valid +initializer. Therefore, the convention is to pass NULL to the +PyObject_HEAD_INIT macro and to initialize this field explicitly at the +start of the module’s initialization function, before doing anything else. This +is typically done like this:

    +
    Foo_Type.ob_type = &PyType_Type;
    +
    +
    +

    This should be done before any instances of the type are created. +PyType_Ready() checks if ob_type is NULL, and if so, +initializes it to the ob_type field of the base class. +PyType_Ready() will not change this field if it is non-zero.

    +

    This field is inherited by subtypes.

    +
    + +
    +
    +Py_ssize_t PyVarObject.ob_size
    +

    For statically allocated type objects, this should be initialized to zero. For +dynamically allocated type objects, this field has a special internal meaning.

    +

    This field is not inherited by subtypes.

    +
    + +
    +
    +const char* PyTypeObject.tp_name
    +

    Pointer to a NUL-terminated string containing the name of the type. For types +that are accessible as module globals, the string should be the full module +name, followed by a dot, followed by the type name; for built-in types, it +should be just the type name. If the module is a submodule of a package, the +full package name is part of the full module name. For example, a type named +T defined in module M in subpackage Q in package P +should have the tp_name initializer "P.Q.M.T".

    +

    For dynamically allocated type objects, this should just be the type name, and +the module name explicitly stored in the type dict as the value for key +'__module__'.

    +

    For statically allocated type objects, the tp_name field should contain a dot. +Everything before the last dot is made accessible as the __module__ +attribute, and everything after the last dot is made accessible as the +__name__ attribute.

    +

    If no dot is present, the entire tp_name field is made accessible as the +__name__ attribute, and the __module__ attribute is undefined +(unless explicitly set in the dictionary, as explained above). This means your +type will be impossible to pickle. Additionally, it will not be listed in +module documentations created with pydoc.

    +

    This field is not inherited by subtypes.

    +
    + +
    +
    +Py_ssize_t PyTypeObject.tp_basicsize
    +
    +Py_ssize_t PyTypeObject.tp_itemsize
    +

    These fields allow calculating the size in bytes of instances of the type.

    +

    There are two kinds of types: types with fixed-length instances have a zero +tp_itemsize field, types with variable-length instances have a non-zero +tp_itemsize field. For a type with fixed-length instances, all +instances have the same size, given in tp_basicsize.

    +

    For a type with variable-length instances, the instances must have an +ob_size field, and the instance size is tp_basicsize plus N +times tp_itemsize, where N is the “length” of the object. The value of +N is typically stored in the instance’s ob_size field. There are +exceptions: for example, ints use a negative ob_size to indicate a +negative number, and N is abs(ob_size) there. Also, the presence of an +ob_size field in the instance layout doesn’t mean that the instance +structure is variable-length (for example, the structure for the list type has +fixed-length instances, yet those instances have a meaningful ob_size +field).

    +

    The basic size includes the fields in the instance declared by the macro +PyObject_HEAD or PyObject_VAR_HEAD (whichever is used to +declare the instance struct) and this in turn includes the _ob_prev and +_ob_next fields if they are present. This means that the only correct +way to get an initializer for the tp_basicsize is to use the +sizeof operator on the struct used to declare the instance layout. +The basic size does not include the GC header size.

    +

    These fields are inherited separately by subtypes. If the base type has a +non-zero tp_itemsize, it is generally not safe to set +tp_itemsize to a different non-zero value in a subtype (though this +depends on the implementation of the base type).

    +

    A note about alignment: if the variable items require a particular alignment, +this should be taken care of by the value of tp_basicsize. Example: +suppose a type implements an array of double. tp_itemsize is +sizeof(double). It is the programmer’s responsibility that +tp_basicsize is a multiple of sizeof(double) (assuming this is the +alignment requirement for double).

    +
    + +
    +
    +destructor PyTypeObject.tp_dealloc
    +

    A pointer to the instance destructor function. This function must be defined +unless the type guarantees that its instances will never be deallocated (as is +the case for the singletons None and Ellipsis).

    +

    The destructor function is called by the Py_DECREF() and +Py_XDECREF() macros when the new reference count is zero. At this point, +the instance is still in existence, but there are no references to it. The +destructor function should free all references which the instance owns, free all +memory buffers owned by the instance (using the freeing function corresponding +to the allocation function used to allocate the buffer), and finally (as its +last action) call the type’s tp_free function. If the type is not +subtypable (doesn’t have the Py_TPFLAGS_BASETYPE flag bit set), it is +permissible to call the object deallocator directly instead of via +tp_free. The object deallocator should be the one used to allocate the +instance; this is normally PyObject_Del() if the instance was allocated +using PyObject_New() or PyObject_VarNew(), or +PyObject_GC_Del() if the instance was allocated using +PyObject_GC_New() or PyObject_GC_NewVar().

    +

    This field is inherited by subtypes.

    +
    + +
    +
    +printfunc PyTypeObject.tp_print
    +

    Reserved slot, formerly used for print formatting in Python 2.x.

    +
    + +
    +
    +getattrfunc PyTypeObject.tp_getattr
    +

    An optional pointer to the get-attribute-string function.

    +

    This field is deprecated. When it is defined, it should point to a function +that acts the same as the tp_getattro function, but taking a C string +instead of a Python string object to give the attribute name. The signature is

    +
    PyObject * tp_getattr(PyObject *o, char *attr_name);
    +
    +
    +

    This field is inherited by subtypes together with tp_getattro: a subtype +inherits both tp_getattr and tp_getattro from its base type when +the subtype’s tp_getattr and tp_getattro are both NULL.

    +
    + +
    +
    +setattrfunc PyTypeObject.tp_setattr
    +

    An optional pointer to the function for setting and deleting attributes.

    +

    This field is deprecated. When it is defined, it should point to a function +that acts the same as the tp_setattro function, but taking a C string +instead of a Python string object to give the attribute name. The signature is

    +
    PyObject * tp_setattr(PyObject *o, char *attr_name, PyObject *v);
    +
    +
    +

    The v argument is set to NULL to delete the attribute. +This field is inherited by subtypes together with tp_setattro: a subtype +inherits both tp_setattr and tp_setattro from its base type when +the subtype’s tp_setattr and tp_setattro are both NULL.

    +
    + +
    +
    +PyAsyncMethods* tp_as_async
    +

    Pointer to an additional structure that contains fields relevant only to +objects which implement awaitable and asynchronous iterator +protocols at the C-level. See Async Object Structures for details.

    +
    +

    New in version 3.5: Formerly known as tp_compare and tp_reserved.

    +
    +
    + +
    +
    +reprfunc PyTypeObject.tp_repr
    +

    An optional pointer to a function that implements the built-in function +repr().

    +

    The signature is the same as for PyObject_Repr(); it must return a string +or a Unicode object. Ideally, this function should return a string that, when +passed to eval(), given a suitable environment, returns an object with the +same value. If this is not feasible, it should return a string starting with +'<' and ending with '>' from which both the type and the value of the +object can be deduced.

    +

    When this field is not set, a string of the form <%s object at %p> is +returned, where %s is replaced by the type name, and %p by the object’s +memory address.

    +

    This field is inherited by subtypes.

    +
    + +
    +
    +PyNumberMethods* tp_as_number
    +

    Pointer to an additional structure that contains fields relevant only to +objects which implement the number protocol. These fields are documented in +Number Object Structures.

    +

    The tp_as_number field is not inherited, but the contained fields are +inherited individually.

    +
    + +
    +
    +PySequenceMethods* tp_as_sequence
    +

    Pointer to an additional structure that contains fields relevant only to +objects which implement the sequence protocol. These fields are documented +in Sequence Object Structures.

    +

    The tp_as_sequence field is not inherited, but the contained fields +are inherited individually.

    +
    + +
    +
    +PyMappingMethods* tp_as_mapping
    +

    Pointer to an additional structure that contains fields relevant only to +objects which implement the mapping protocol. These fields are documented in +Mapping Object Structures.

    +

    The tp_as_mapping field is not inherited, but the contained fields +are inherited individually.

    +
    + +
    +
    +hashfunc PyTypeObject.tp_hash
    +

    An optional pointer to a function that implements the built-in function +hash().

    +

    The signature is the same as for PyObject_Hash(); it must return a +value of the type Py_hash_t. The value -1 should not be returned as a +normal return value; when an error occurs during the computation of the hash +value, the function should set an exception and return -1.

    +

    This field can be set explicitly to PyObject_HashNotImplemented() to +block inheritance of the hash method from a parent type. This is interpreted +as the equivalent of __hash__ = None at the Python level, causing +isinstance(o, collections.Hashable) to correctly return False. Note +that the converse is also true - setting __hash__ = None on a class at +the Python level will result in the tp_hash slot being set to +PyObject_HashNotImplemented().

    +

    When this field is not set, an attempt to take the hash of the +object raises TypeError.

    +

    This field is inherited by subtypes together with +tp_richcompare: a subtype inherits both of +tp_richcompare and tp_hash, when the subtype’s +tp_richcompare and tp_hash are both NULL.

    +
    + +
    +
    +ternaryfunc PyTypeObject.tp_call
    +

    An optional pointer to a function that implements calling the object. This +should be NULL if the object is not callable. The signature is the same as +for PyObject_Call().

    +

    This field is inherited by subtypes.

    +
    + +
    +
    +reprfunc PyTypeObject.tp_str
    +

    An optional pointer to a function that implements the built-in operation +str(). (Note that str is a type now, and str() calls the +constructor for that type. This constructor calls PyObject_Str() to do +the actual work, and PyObject_Str() will call this handler.)

    +

    The signature is the same as for PyObject_Str(); it must return a string +or a Unicode object. This function should return a “friendly” string +representation of the object, as this is the representation that will be used, +among other things, by the print() function.

    +

    When this field is not set, PyObject_Repr() is called to return a string +representation.

    +

    This field is inherited by subtypes.

    +
    + +
    +
    +getattrofunc PyTypeObject.tp_getattro
    +

    An optional pointer to the get-attribute function.

    +

    The signature is the same as for PyObject_GetAttr(). It is usually +convenient to set this field to PyObject_GenericGetAttr(), which +implements the normal way of looking for object attributes.

    +

    This field is inherited by subtypes together with tp_getattr: a subtype +inherits both tp_getattr and tp_getattro from its base type when +the subtype’s tp_getattr and tp_getattro are both NULL.

    +
    + +
    +
    +setattrofunc PyTypeObject.tp_setattro
    +

    An optional pointer to the function for setting and deleting attributes.

    +

    The signature is the same as for PyObject_SetAttr(), but setting +v to NULL to delete an attribute must be supported. It is usually +convenient to set this field to PyObject_GenericSetAttr(), which +implements the normal way of setting object attributes.

    +

    This field is inherited by subtypes together with tp_setattr: a subtype +inherits both tp_setattr and tp_setattro from its base type when +the subtype’s tp_setattr and tp_setattro are both NULL.

    +
    + +
    +
    +PyBufferProcs* PyTypeObject.tp_as_buffer
    +

    Pointer to an additional structure that contains fields relevant only to objects +which implement the buffer interface. These fields are documented in +Buffer Object Structures.

    +

    The tp_as_buffer field is not inherited, but the contained fields are +inherited individually.

    +
    + +
    +
    +unsigned long PyTypeObject.tp_flags
    +

    This field is a bit mask of various flags. Some flags indicate variant +semantics for certain situations; others are used to indicate that certain +fields in the type object (or in the extension structures referenced via +tp_as_number, tp_as_sequence, tp_as_mapping, and +tp_as_buffer) that were historically not always present are valid; if +such a flag bit is clear, the type fields it guards must not be accessed and +must be considered to have a zero or NULL value instead.

    +

    Inheritance of this field is complicated. Most flag bits are inherited +individually, i.e. if the base type has a flag bit set, the subtype inherits +this flag bit. The flag bits that pertain to extension structures are strictly +inherited if the extension structure is inherited, i.e. the base type’s value of +the flag bit is copied into the subtype together with a pointer to the extension +structure. The Py_TPFLAGS_HAVE_GC flag bit is inherited together with +the tp_traverse and tp_clear fields, i.e. if the +Py_TPFLAGS_HAVE_GC flag bit is clear in the subtype and the +tp_traverse and tp_clear fields in the subtype exist and have +NULL values.

    +

    The following bit masks are currently defined; these can be ORed together using +the | operator to form the value of the tp_flags field. The macro +PyType_HasFeature() takes a type and a flags value, tp and f, and +checks whether tp->tp_flags & f is non-zero.

    +
    +
    +Py_TPFLAGS_HEAPTYPE
    +

    This bit is set when the type object itself is allocated on the heap. In this +case, the ob_type field of its instances is considered a reference to +the type, and the type object is INCREF’ed when a new instance is created, and +DECREF’ed when an instance is destroyed (this does not apply to instances of +subtypes; only the type referenced by the instance’s ob_type gets INCREF’ed or +DECREF’ed).

    +
    + +
    +
    +Py_TPFLAGS_BASETYPE
    +

    This bit is set when the type can be used as the base type of another type. If +this bit is clear, the type cannot be subtyped (similar to a “final” class in +Java).

    +
    + +
    +
    +Py_TPFLAGS_READY
    +

    This bit is set when the type object has been fully initialized by +PyType_Ready().

    +
    + +
    +
    +Py_TPFLAGS_READYING
    +

    This bit is set while PyType_Ready() is in the process of initializing +the type object.

    +
    + +
    +
    +Py_TPFLAGS_HAVE_GC
    +

    This bit is set when the object supports garbage collection. If this bit +is set, instances must be created using PyObject_GC_New() and +destroyed using PyObject_GC_Del(). More information in section +Supporting Cyclic Garbage Collection. This bit also implies that the +GC-related fields tp_traverse and tp_clear are present in +the type object.

    +
    + +
    +
    +Py_TPFLAGS_DEFAULT
    +

    This is a bitmask of all the bits that pertain to the existence of certain +fields in the type object and its extension structures. Currently, it includes +the following bits: Py_TPFLAGS_HAVE_STACKLESS_EXTENSION, +Py_TPFLAGS_HAVE_VERSION_TAG.

    +
    + +
    +
    +Py_TPFLAGS_LONG_SUBCLASS
    +
    + +
    +
    +Py_TPFLAGS_LIST_SUBCLASS
    +
    + +
    +
    +Py_TPFLAGS_TUPLE_SUBCLASS
    +
    + +
    +
    +Py_TPFLAGS_BYTES_SUBCLASS
    +
    + +
    +
    +Py_TPFLAGS_UNICODE_SUBCLASS
    +
    + +
    +
    +Py_TPFLAGS_DICT_SUBCLASS
    +
    + +
    +
    +Py_TPFLAGS_BASE_EXC_SUBCLASS
    +
    + +
    +
    +Py_TPFLAGS_TYPE_SUBCLASS
    +

    These flags are used by functions such as +PyLong_Check() to quickly determine if a type is a subclass +of a built-in type; such specific checks are faster than a generic +check, like PyObject_IsInstance(). Custom types that inherit +from built-ins should have their tp_flags +set appropriately, or the code that interacts with such types +will behave differently depending on what kind of check is used.

    +
    + +
    +
    +Py_TPFLAGS_HAVE_FINALIZE
    +

    This bit is set when the tp_finalize slot is present in the +type structure.

    +
    +

    New in version 3.4.

    +
    +
    + +
    + +
    +
    +const char* PyTypeObject.tp_doc
    +

    An optional pointer to a NUL-terminated C string giving the docstring for this +type object. This is exposed as the __doc__ attribute on the type and +instances of the type.

    +

    This field is not inherited by subtypes.

    +
    + +
    +
    +traverseproc PyTypeObject.tp_traverse
    +

    An optional pointer to a traversal function for the garbage collector. This is +only used if the Py_TPFLAGS_HAVE_GC flag bit is set. More information +about Python’s garbage collection scheme can be found in section +Supporting Cyclic Garbage Collection.

    +

    The tp_traverse pointer is used by the garbage collector to detect +reference cycles. A typical implementation of a tp_traverse function +simply calls Py_VISIT() on each of the instance’s members that are Python +objects. For example, this is function local_traverse() from the +_thread extension module:

    +
    static int
    +local_traverse(localobject *self, visitproc visit, void *arg)
    +{
    +    Py_VISIT(self->args);
    +    Py_VISIT(self->kw);
    +    Py_VISIT(self->dict);
    +    return 0;
    +}
    +
    +
    +

    Note that Py_VISIT() is called only on those members that can participate +in reference cycles. Although there is also a self->key member, it can only +be NULL or a Python string and therefore cannot be part of a reference cycle.

    +

    On the other hand, even if you know a member can never be part of a cycle, as a +debugging aid you may want to visit it anyway just so the gc module’s +get_referents() function will include it.

    +

    Note that Py_VISIT() requires the visit and arg parameters to +local_traverse() to have these specific names; don’t name them just +anything.

    +

    This field is inherited by subtypes together with tp_clear and the +Py_TPFLAGS_HAVE_GC flag bit: the flag bit, tp_traverse, and +tp_clear are all inherited from the base type if they are all zero in +the subtype.

    +
    + +
    +
    +inquiry PyTypeObject.tp_clear
    +

    An optional pointer to a clear function for the garbage collector. This is only +used if the Py_TPFLAGS_HAVE_GC flag bit is set.

    +

    The tp_clear member function is used to break reference cycles in cyclic +garbage detected by the garbage collector. Taken together, all tp_clear +functions in the system must combine to break all reference cycles. This is +subtle, and if in any doubt supply a tp_clear function. For example, +the tuple type does not implement a tp_clear function, because it’s +possible to prove that no reference cycle can be composed entirely of tuples. +Therefore the tp_clear functions of other types must be sufficient to +break any cycle containing a tuple. This isn’t immediately obvious, and there’s +rarely a good reason to avoid implementing tp_clear.

    +

    Implementations of tp_clear should drop the instance’s references to +those of its members that may be Python objects, and set its pointers to those +members to NULL, as in the following example:

    +
    static int
    +local_clear(localobject *self)
    +{
    +    Py_CLEAR(self->key);
    +    Py_CLEAR(self->args);
    +    Py_CLEAR(self->kw);
    +    Py_CLEAR(self->dict);
    +    return 0;
    +}
    +
    +
    +

    The Py_CLEAR() macro should be used, because clearing references is +delicate: the reference to the contained object must not be decremented until +after the pointer to the contained object is set to NULL. This is because +decrementing the reference count may cause the contained object to become trash, +triggering a chain of reclamation activity that may include invoking arbitrary +Python code (due to finalizers, or weakref callbacks, associated with the +contained object). If it’s possible for such code to reference self again, +it’s important that the pointer to the contained object be NULL at that time, +so that self knows the contained object can no longer be used. The +Py_CLEAR() macro performs the operations in a safe order.

    +

    Because the goal of tp_clear functions is to break reference cycles, +it’s not necessary to clear contained objects like Python strings or Python +integers, which can’t participate in reference cycles. On the other hand, it may +be convenient to clear all contained Python objects, and write the type’s +tp_dealloc function to invoke tp_clear.

    +

    More information about Python’s garbage collection scheme can be found in +section Supporting Cyclic Garbage Collection.

    +

    This field is inherited by subtypes together with tp_traverse and the +Py_TPFLAGS_HAVE_GC flag bit: the flag bit, tp_traverse, and +tp_clear are all inherited from the base type if they are all zero in +the subtype.

    +
    + +
    +
    +richcmpfunc PyTypeObject.tp_richcompare
    +

    An optional pointer to the rich comparison function, whose signature is +PyObject *tp_richcompare(PyObject *a, PyObject *b, int op). The first +parameter is guaranteed to be an instance of the type that is defined +by PyTypeObject.

    +

    The function should return the result of the comparison (usually Py_True +or Py_False). If the comparison is undefined, it must return +Py_NotImplemented, if another error occurred it must return NULL and +set an exception condition.

    +
    +

    Note

    +

    If you want to implement a type for which only a limited set of +comparisons makes sense (e.g. == and !=, but not < and +friends), directly raise TypeError in the rich comparison function.

    +
    +

    This field is inherited by subtypes together with tp_hash: +a subtype inherits tp_richcompare and tp_hash when +the subtype’s tp_richcompare and tp_hash are both +NULL.

    +

    The following constants are defined to be used as the third argument for +tp_richcompare and for PyObject_RichCompare():

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + +

    Constant

    Comparison

    Py_LT

    <

    Py_LE

    <=

    Py_EQ

    ==

    Py_NE

    !=

    Py_GT

    >

    Py_GE

    >=

    +

    The following macro is defined to ease writing rich comparison functions:

    +
    +
    +PyObject *Py_RETURN_RICHCOMPARE(VAL_A, VAL_B, int op)
    +

    Return Py_True or Py_False from the function, depending on the +result of a comparison. +VAL_A and VAL_B must be orderable by C comparison operators (for example, +they may be C ints or floats). The third argument specifies the requested +operation, as for PyObject_RichCompare().

    +

    The return value’s reference count is properly incremented.

    +

    On error, sets an exception and returns NULL from the function.

    +
    +

    New in version 3.7.

    +
    +
    + +
    + +
    +
    +Py_ssize_t PyTypeObject.tp_weaklistoffset
    +

    If the instances of this type are weakly referenceable, this field is greater +than zero and contains the offset in the instance structure of the weak +reference list head (ignoring the GC header, if present); this offset is used by +PyObject_ClearWeakRefs() and the PyWeakref_*() functions. The +instance structure needs to include a field of type PyObject* which is +initialized to NULL.

    +

    Do not confuse this field with tp_weaklist; that is the list head for +weak references to the type object itself.

    +

    This field is inherited by subtypes, but see the rules listed below. A subtype +may override this offset; this means that the subtype uses a different weak +reference list head than the base type. Since the list head is always found via +tp_weaklistoffset, this should not be a problem.

    +

    When a type defined by a class statement has no __slots__ declaration, +and none of its base types are weakly referenceable, the type is made weakly +referenceable by adding a weak reference list head slot to the instance layout +and setting the tp_weaklistoffset of that slot’s offset.

    +

    When a type’s __slots__ declaration contains a slot named +__weakref__, that slot becomes the weak reference list head for +instances of the type, and the slot’s offset is stored in the type’s +tp_weaklistoffset.

    +

    When a type’s __slots__ declaration does not contain a slot named +__weakref__, the type inherits its tp_weaklistoffset from its +base type.

    +
    + +
    +
    +getiterfunc PyTypeObject.tp_iter
    +

    An optional pointer to a function that returns an iterator for the object. Its +presence normally signals that the instances of this type are iterable (although +sequences may be iterable without this function).

    +

    This function has the same signature as PyObject_GetIter().

    +

    This field is inherited by subtypes.

    +
    + +
    +
    +iternextfunc PyTypeObject.tp_iternext
    +

    An optional pointer to a function that returns the next item in an iterator. +When the iterator is exhausted, it must return NULL; a StopIteration +exception may or may not be set. When another error occurs, it must return +NULL too. Its presence signals that the instances of this type are +iterators.

    +

    Iterator types should also define the tp_iter function, and that +function should return the iterator instance itself (not a new iterator +instance).

    +

    This function has the same signature as PyIter_Next().

    +

    This field is inherited by subtypes.

    +
    + +
    +
    +struct PyMethodDef* PyTypeObject.tp_methods
    +

    An optional pointer to a static NULL-terminated array of PyMethodDef +structures, declaring regular methods of this type.

    +

    For each entry in the array, an entry is added to the type’s dictionary (see +tp_dict below) containing a method descriptor.

    +

    This field is not inherited by subtypes (methods are inherited through a +different mechanism).

    +
    + +
    +
    +struct PyMemberDef* PyTypeObject.tp_members
    +

    An optional pointer to a static NULL-terminated array of PyMemberDef +structures, declaring regular data members (fields or slots) of instances of +this type.

    +

    For each entry in the array, an entry is added to the type’s dictionary (see +tp_dict below) containing a member descriptor.

    +

    This field is not inherited by subtypes (members are inherited through a +different mechanism).

    +
    + +
    +
    +struct PyGetSetDef* PyTypeObject.tp_getset
    +

    An optional pointer to a static NULL-terminated array of PyGetSetDef +structures, declaring computed attributes of instances of this type.

    +

    For each entry in the array, an entry is added to the type’s dictionary (see +tp_dict below) containing a getset descriptor.

    +

    This field is not inherited by subtypes (computed attributes are inherited +through a different mechanism).

    +
    + +
    +
    +PyTypeObject* PyTypeObject.tp_base
    +

    An optional pointer to a base type from which type properties are inherited. At +this level, only single inheritance is supported; multiple inheritance require +dynamically creating a type object by calling the metatype.

    +

    This field is not inherited by subtypes (obviously), but it defaults to +&PyBaseObject_Type (which to Python programmers is known as the type +object).

    +
    + +
    +
    +PyObject* PyTypeObject.tp_dict
    +

    The type’s dictionary is stored here by PyType_Ready().

    +

    This field should normally be initialized to NULL before PyType_Ready is +called; it may also be initialized to a dictionary containing initial attributes +for the type. Once PyType_Ready() has initialized the type, extra +attributes for the type may be added to this dictionary only if they don’t +correspond to overloaded operations (like __add__()).

    +

    This field is not inherited by subtypes (though the attributes defined in here +are inherited through a different mechanism).

    +
    +

    Warning

    +

    It is not safe to use PyDict_SetItem() on or otherwise modify +tp_dict with the dictionary C-API.

    +
    +
    + +
    +
    +descrgetfunc PyTypeObject.tp_descr_get
    +

    An optional pointer to a “descriptor get” function.

    +

    The function signature is

    +
    PyObject * tp_descr_get(PyObject *self, PyObject *obj, PyObject *type);
    +
    +
    +

    This field is inherited by subtypes.

    +
    + +
    +
    +descrsetfunc PyTypeObject.tp_descr_set
    +

    An optional pointer to a function for setting and deleting +a descriptor’s value.

    +

    The function signature is

    +
    int tp_descr_set(PyObject *self, PyObject *obj, PyObject *value);
    +
    +
    +

    The value argument is set to NULL to delete the value. +This field is inherited by subtypes.

    +
    + +
    +
    +Py_ssize_t PyTypeObject.tp_dictoffset
    +

    If the instances of this type have a dictionary containing instance variables, +this field is non-zero and contains the offset in the instances of the type of +the instance variable dictionary; this offset is used by +PyObject_GenericGetAttr().

    +

    Do not confuse this field with tp_dict; that is the dictionary for +attributes of the type object itself.

    +

    If the value of this field is greater than zero, it specifies the offset from +the start of the instance structure. If the value is less than zero, it +specifies the offset from the end of the instance structure. A negative +offset is more expensive to use, and should only be used when the instance +structure contains a variable-length part. This is used for example to add an +instance variable dictionary to subtypes of str or tuple. Note +that the tp_basicsize field should account for the dictionary added to +the end in that case, even though the dictionary is not included in the basic +object layout. On a system with a pointer size of 4 bytes, +tp_dictoffset should be set to -4 to indicate that the dictionary is +at the very end of the structure.

    +

    The real dictionary offset in an instance can be computed from a negative +tp_dictoffset as follows:

    +
    dictoffset = tp_basicsize + abs(ob_size)*tp_itemsize + tp_dictoffset
    +if dictoffset is not aligned on sizeof(void*):
    +    round up to sizeof(void*)
    +
    +
    +

    where tp_basicsize, tp_itemsize and tp_dictoffset are +taken from the type object, and ob_size is taken from the instance. The +absolute value is taken because ints use the sign of ob_size to +store the sign of the number. (There’s never a need to do this calculation +yourself; it is done for you by _PyObject_GetDictPtr().)

    +

    This field is inherited by subtypes, but see the rules listed below. A subtype +may override this offset; this means that the subtype instances store the +dictionary at a difference offset than the base type. Since the dictionary is +always found via tp_dictoffset, this should not be a problem.

    +

    When a type defined by a class statement has no __slots__ declaration, +and none of its base types has an instance variable dictionary, a dictionary +slot is added to the instance layout and the tp_dictoffset is set to +that slot’s offset.

    +

    When a type defined by a class statement has a __slots__ declaration, +the type inherits its tp_dictoffset from its base type.

    +

    (Adding a slot named __dict__ to the __slots__ declaration does +not have the expected effect, it just causes confusion. Maybe this should be +added as a feature just like __weakref__ though.)

    +
    + +
    +
    +initproc PyTypeObject.tp_init
    +

    An optional pointer to an instance initialization function.

    +

    This function corresponds to the __init__() method of classes. Like +__init__(), it is possible to create an instance without calling +__init__(), and it is possible to reinitialize an instance by calling its +__init__() method again.

    +

    The function signature is

    +
    int tp_init(PyObject *self, PyObject *args, PyObject *kwds)
    +
    +
    +

    The self argument is the instance to be initialized; the args and kwds +arguments represent positional and keyword arguments of the call to +__init__().

    +

    The tp_init function, if not NULL, is called when an instance is +created normally by calling its type, after the type’s tp_new function +has returned an instance of the type. If the tp_new function returns an +instance of some other type that is not a subtype of the original type, no +tp_init function is called; if tp_new returns an instance of a +subtype of the original type, the subtype’s tp_init is called.

    +

    This field is inherited by subtypes.

    +
    + +
    +
    +allocfunc PyTypeObject.tp_alloc
    +

    An optional pointer to an instance allocation function.

    +

    The function signature is

    +
    PyObject *tp_alloc(PyTypeObject *self, Py_ssize_t nitems)
    +
    +
    +

    The purpose of this function is to separate memory allocation from memory +initialization. It should return a pointer to a block of memory of adequate +length for the instance, suitably aligned, and initialized to zeros, but with +ob_refcnt set to 1 and ob_type set to the type argument. If +the type’s tp_itemsize is non-zero, the object’s ob_size field +should be initialized to nitems and the length of the allocated memory block +should be tp_basicsize + nitems*tp_itemsize, rounded up to a multiple of +sizeof(void*); otherwise, nitems is not used and the length of the block +should be tp_basicsize.

    +

    Do not use this function to do any other instance initialization, not even to +allocate additional memory; that should be done by tp_new.

    +

    This field is inherited by static subtypes, but not by dynamic subtypes +(subtypes created by a class statement); in the latter, this field is always set +to PyType_GenericAlloc(), to force a standard heap allocation strategy. +That is also the recommended value for statically defined types.

    +
    + +
    +
    +newfunc PyTypeObject.tp_new
    +

    An optional pointer to an instance creation function.

    +

    If this function is NULL for a particular type, that type cannot be called to +create new instances; presumably there is some other way to create instances, +like a factory function.

    +

    The function signature is

    +
    PyObject *tp_new(PyTypeObject *subtype, PyObject *args, PyObject *kwds)
    +
    +
    +

    The subtype argument is the type of the object being created; the args and +kwds arguments represent positional and keyword arguments of the call to the +type. Note that subtype doesn’t have to equal the type whose tp_new +function is called; it may be a subtype of that type (but not an unrelated +type).

    +

    The tp_new function should call subtype->tp_alloc(subtype, nitems) +to allocate space for the object, and then do only as much further +initialization as is absolutely necessary. Initialization that can safely be +ignored or repeated should be placed in the tp_init handler. A good +rule of thumb is that for immutable types, all initialization should take place +in tp_new, while for mutable types, most initialization should be +deferred to tp_init.

    +

    This field is inherited by subtypes, except it is not inherited by static types +whose tp_base is NULL or &PyBaseObject_Type.

    +
    + +
    +
    +destructor PyTypeObject.tp_free
    +

    An optional pointer to an instance deallocation function. Its signature is +freefunc:

    +
    void tp_free(void *)
    +
    +
    +

    An initializer that is compatible with this signature is PyObject_Free().

    +

    This field is inherited by static subtypes, but not by dynamic subtypes +(subtypes created by a class statement); in the latter, this field is set to a +deallocator suitable to match PyType_GenericAlloc() and the value of the +Py_TPFLAGS_HAVE_GC flag bit.

    +
    + +
    +
    +inquiry PyTypeObject.tp_is_gc
    +

    An optional pointer to a function called by the garbage collector.

    +

    The garbage collector needs to know whether a particular object is collectible +or not. Normally, it is sufficient to look at the object’s type’s +tp_flags field, and check the Py_TPFLAGS_HAVE_GC flag bit. But +some types have a mixture of statically and dynamically allocated instances, and +the statically allocated instances are not collectible. Such types should +define this function; it should return 1 for a collectible instance, and +0 for a non-collectible instance. The signature is

    +
    int tp_is_gc(PyObject *self)
    +
    +
    +

    (The only example of this are types themselves. The metatype, +PyType_Type, defines this function to distinguish between statically +and dynamically allocated types.)

    +

    This field is inherited by subtypes.

    +
    + +
    +
    +PyObject* PyTypeObject.tp_bases
    +

    Tuple of base types.

    +

    This is set for types created by a class statement. It should be NULL for +statically defined types.

    +

    This field is not inherited.

    +
    + +
    +
    +PyObject* PyTypeObject.tp_mro
    +

    Tuple containing the expanded set of base types, starting with the type itself +and ending with object, in Method Resolution Order.

    +

    This field is not inherited; it is calculated fresh by PyType_Ready().

    +
    + +
    +
    +destructor PyTypeObject.tp_finalize
    +

    An optional pointer to an instance finalization function. Its signature is +destructor:

    +
    void tp_finalize(PyObject *)
    +
    +
    +

    If tp_finalize is set, the interpreter calls it once when +finalizing an instance. It is called either from the garbage +collector (if the instance is part of an isolated reference cycle) or +just before the object is deallocated. Either way, it is guaranteed +to be called before attempting to break reference cycles, ensuring +that it finds the object in a sane state.

    +

    tp_finalize should not mutate the current exception status; +therefore, a recommended way to write a non-trivial finalizer is:

    +
    static void
    +local_finalize(PyObject *self)
    +{
    +    PyObject *error_type, *error_value, *error_traceback;
    +
    +    /* Save the current exception, if any. */
    +    PyErr_Fetch(&error_type, &error_value, &error_traceback);
    +
    +    /* ... */
    +
    +    /* Restore the saved exception. */
    +    PyErr_Restore(error_type, error_value, error_traceback);
    +}
    +
    +
    +

    For this field to be taken into account (even through inheritance), +you must also set the Py_TPFLAGS_HAVE_FINALIZE flags bit.

    +

    This field is inherited by subtypes.

    +
    +

    New in version 3.4.

    +
    +
    +

    See also

    +

    “Safe object finalization” (PEP 442)

    +
    +
    + +
    +
    +PyObject* PyTypeObject.tp_cache
    +

    Unused. Not inherited. Internal use only.

    +
    + +
    +
    +PyObject* PyTypeObject.tp_subclasses
    +

    List of weak references to subclasses. Not inherited. Internal use only.

    +
    + +
    +
    +PyObject* PyTypeObject.tp_weaklist
    +

    Weak reference list head, for weak references to this type object. Not +inherited. Internal use only.

    +
    + +

    The remaining fields are only defined if the feature test macro +COUNT_ALLOCS is defined, and are for internal use only. They are +documented here for completeness. None of these fields are inherited by +subtypes.

    +
    +
    +Py_ssize_t PyTypeObject.tp_allocs
    +

    Number of allocations.

    +
    + +
    +
    +Py_ssize_t PyTypeObject.tp_frees
    +

    Number of frees.

    +
    + +
    +
    +Py_ssize_t PyTypeObject.tp_maxalloc
    +

    Maximum simultaneously allocated objects.

    +
    + +
    +
    +PyTypeObject* PyTypeObject.tp_next
    +

    Pointer to the next type object with a non-zero tp_allocs field.

    +
    + +

    Also, note that, in a garbage collected Python, tp_dealloc may be called from +any Python thread, not just the thread which created the object (if the object +becomes part of a refcount cycle, that cycle might be collected by a garbage +collection on any thread). This is not a problem for Python API calls, since +the thread on which tp_dealloc is called will own the Global Interpreter Lock +(GIL). However, if the object being destroyed in turn destroys objects from some +other C or C++ library, care should be taken to ensure that destroying those +objects on the thread which called tp_dealloc will not violate any assumptions +of the library.

    +
    +
    +

    Number Object Structures

    +
    +
    +PyNumberMethods
    +

    This structure holds pointers to the functions which an object uses to +implement the number protocol. Each function is used by the function of +similar name documented in the Number Protocol section.

    +

    Here is the structure definition:

    +
    typedef struct {
    +     binaryfunc nb_add;
    +     binaryfunc nb_subtract;
    +     binaryfunc nb_multiply;
    +     binaryfunc nb_remainder;
    +     binaryfunc nb_divmod;
    +     ternaryfunc nb_power;
    +     unaryfunc nb_negative;
    +     unaryfunc nb_positive;
    +     unaryfunc nb_absolute;
    +     inquiry nb_bool;
    +     unaryfunc nb_invert;
    +     binaryfunc nb_lshift;
    +     binaryfunc nb_rshift;
    +     binaryfunc nb_and;
    +     binaryfunc nb_xor;
    +     binaryfunc nb_or;
    +     unaryfunc nb_int;
    +     void *nb_reserved;
    +     unaryfunc nb_float;
    +
    +     binaryfunc nb_inplace_add;
    +     binaryfunc nb_inplace_subtract;
    +     binaryfunc nb_inplace_multiply;
    +     binaryfunc nb_inplace_remainder;
    +     ternaryfunc nb_inplace_power;
    +     binaryfunc nb_inplace_lshift;
    +     binaryfunc nb_inplace_rshift;
    +     binaryfunc nb_inplace_and;
    +     binaryfunc nb_inplace_xor;
    +     binaryfunc nb_inplace_or;
    +
    +     binaryfunc nb_floor_divide;
    +     binaryfunc nb_true_divide;
    +     binaryfunc nb_inplace_floor_divide;
    +     binaryfunc nb_inplace_true_divide;
    +
    +     unaryfunc nb_index;
    +
    +     binaryfunc nb_matrix_multiply;
    +     binaryfunc nb_inplace_matrix_multiply;
    +} PyNumberMethods;
    +
    +
    +
    +

    Note

    +

    Binary and ternary functions must check the type of all their operands, +and implement the necessary conversions (at least one of the operands is +an instance of the defined type). If the operation is not defined for the +given operands, binary and ternary functions must return +Py_NotImplemented, if another error occurred they must return NULL +and set an exception.

    +
    +
    +

    Note

    +

    The nb_reserved field should always be NULL. It +was previously called nb_long, and was renamed in +Python 3.0.1.

    +
    +
    + +
    +
    +

    Mapping Object Structures

    +
    +
    +PyMappingMethods
    +

    This structure holds pointers to the functions which an object uses to +implement the mapping protocol. It has three members:

    +
    + +
    +
    +lenfunc PyMappingMethods.mp_length
    +

    This function is used by PyMapping_Size() and +PyObject_Size(), and has the same signature. This slot may be set to +NULL if the object has no defined length.

    +
    + +
    +
    +binaryfunc PyMappingMethods.mp_subscript
    +

    This function is used by PyObject_GetItem() and +PySequence_GetSlice(), and has the same signature as +PyObject_GetItem(). This slot must be filled for the +PyMapping_Check() function to return 1, it can be NULL +otherwise.

    +
    + +
    +
    +objobjargproc PyMappingMethods.mp_ass_subscript
    +

    This function is used by PyObject_SetItem(), +PyObject_DelItem(), PyObject_SetSlice() and +PyObject_DelSlice(). It has the same signature as +PyObject_SetItem(), but v can also be set to NULL to delete +an item. If this slot is NULL, the object does not support item +assignment and deletion.

    +
    + +
    +
    +

    Sequence Object Structures

    +
    +
    +PySequenceMethods
    +

    This structure holds pointers to the functions which an object uses to +implement the sequence protocol.

    +
    + +
    +
    +lenfunc PySequenceMethods.sq_length
    +

    This function is used by PySequence_Size() and +PyObject_Size(), and has the same signature. It is also used for +handling negative indices via the sq_item +and the sq_ass_item slots.

    +
    + +
    +
    +binaryfunc PySequenceMethods.sq_concat
    +

    This function is used by PySequence_Concat() and has the same +signature. It is also used by the + operator, after trying the numeric +addition via the nb_add slot.

    +
    + +
    +
    +ssizeargfunc PySequenceMethods.sq_repeat
    +

    This function is used by PySequence_Repeat() and has the same +signature. It is also used by the * operator, after trying numeric +multiplication via the nb_multiply slot.

    +
    + +
    +
    +ssizeargfunc PySequenceMethods.sq_item
    +

    This function is used by PySequence_GetItem() and has the same +signature. It is also used by PyObject_GetItem(), after trying +the subscription via the mp_subscript slot. +This slot must be filled for the PySequence_Check() +function to return 1, it can be NULL otherwise.

    +

    Negative indexes are handled as follows: if the sq_length slot is +filled, it is called and the sequence length is used to compute a positive +index which is passed to sq_item. If sq_length is NULL, +the index is passed as is to the function.

    +
    + +
    +
    +ssizeobjargproc PySequenceMethods.sq_ass_item
    +

    This function is used by PySequence_SetItem() and has the same +signature. It is also used by PyObject_SetItem() and +PyObject_DelItem(), after trying the item assignment and deletion +via the mp_ass_subscript slot. +This slot may be left to NULL if the object does not support +item assignment and deletion.

    +
    + +
    +
    +objobjproc PySequenceMethods.sq_contains
    +

    This function may be used by PySequence_Contains() and has the same +signature. This slot may be left to NULL, in this case +PySequence_Contains() simply traverses the sequence until it +finds a match.

    +
    + +
    +
    +binaryfunc PySequenceMethods.sq_inplace_concat
    +

    This function is used by PySequence_InPlaceConcat() and has the same +signature. It should modify its first operand, and return it. This slot +may be left to NULL, in this case PySequence_InPlaceConcat() +will fall back to PySequence_Concat(). It is also used by the +augmented assignment +=, after trying numeric in-place addition +via the nb_inplace_add slot.

    +
    + +
    +
    +ssizeargfunc PySequenceMethods.sq_inplace_repeat
    +

    This function is used by PySequence_InPlaceRepeat() and has the same +signature. It should modify its first operand, and return it. This slot +may be left to NULL, in this case PySequence_InPlaceRepeat() +will fall back to PySequence_Repeat(). It is also used by the +augmented assignment *=, after trying numeric in-place multiplication +via the nb_inplace_multiply slot.

    +
    + +
    +
    +

    Buffer Object Structures

    +
    +
    +PyBufferProcs
    +

    This structure holds pointers to the functions required by the +Buffer protocol. The protocol defines how +an exporter object can expose its internal data to consumer objects.

    +
    + +
    +
    +getbufferproc PyBufferProcs.bf_getbuffer
    +

    The signature of this function is:

    +
    int (PyObject *exporter, Py_buffer *view, int flags);
    +
    +
    +

    Handle a request to exporter to fill in view as specified by flags. +Except for point (3), an implementation of this function MUST take these +steps:

    +
      +
    1. Check if the request can be met. If not, raise PyExc_BufferError, +set view->obj to NULL and return -1.

    2. +
    3. Fill in the requested fields.

    4. +
    5. Increment an internal counter for the number of exports.

    6. +
    7. Set view->obj to exporter and increment view->obj.

    8. +
    9. Return 0.

    10. +
    +

    If exporter is part of a chain or tree of buffer providers, two main +schemes can be used:

    +
      +
    • Re-export: Each member of the tree acts as the exporting object and +sets view->obj to a new reference to itself.

    • +
    • Redirect: The buffer request is redirected to the root object of the +tree. Here, view->obj will be a new reference to the root +object.

    • +
    +

    The individual fields of view are described in section +Buffer structure, the rules how an exporter +must react to specific requests are in section +Buffer request types.

    +

    All memory pointed to in the Py_buffer structure belongs to +the exporter and must remain valid until there are no consumers left. +format, shape, +strides, suboffsets +and internal +are read-only for the consumer.

    +

    PyBuffer_FillInfo() provides an easy way of exposing a simple +bytes buffer while dealing correctly with all request types.

    +

    PyObject_GetBuffer() is the interface for the consumer that +wraps this function.

    +
    + +
    +
    +releasebufferproc PyBufferProcs.bf_releasebuffer
    +

    The signature of this function is:

    +
    void (PyObject *exporter, Py_buffer *view);
    +
    +
    +

    Handle a request to release the resources of the buffer. If no resources +need to be released, PyBufferProcs.bf_releasebuffer may be +NULL. Otherwise, a standard implementation of this function will take +these optional steps:

    +
      +
    1. Decrement an internal counter for the number of exports.

    2. +
    3. If the counter is 0, free all memory associated with view.

    4. +
    +

    The exporter MUST use the internal field to keep +track of buffer-specific resources. This field is guaranteed to remain +constant, while a consumer MAY pass a copy of the original buffer as the +view argument.

    +

    This function MUST NOT decrement view->obj, since that is +done automatically in PyBuffer_Release() (this scheme is +useful for breaking reference cycles).

    +

    PyBuffer_Release() is the interface for the consumer that +wraps this function.

    +
    + +
    +
    +

    Async Object Structures

    +
    +

    New in version 3.5.

    +
    +
    +
    +PyAsyncMethods
    +

    This structure holds pointers to the functions required to implement +awaitable and asynchronous iterator objects.

    +

    Here is the structure definition:

    +
    typedef struct {
    +    unaryfunc am_await;
    +    unaryfunc am_aiter;
    +    unaryfunc am_anext;
    +} PyAsyncMethods;
    +
    +
    +
    + +
    +
    +unaryfunc PyAsyncMethods.am_await
    +

    The signature of this function is:

    +
    PyObject *am_await(PyObject *self)
    +
    +
    +

    The returned object must be an iterator, i.e. PyIter_Check() must +return 1 for it.

    +

    This slot may be set to NULL if an object is not an awaitable.

    +
    + +
    +
    +unaryfunc PyAsyncMethods.am_aiter
    +

    The signature of this function is:

    +
    PyObject *am_aiter(PyObject *self)
    +
    +
    +

    Must return an awaitable object. See __anext__() for details.

    +

    This slot may be set to NULL if an object does not implement +asynchronous iteration protocol.

    +
    + +
    +
    +unaryfunc PyAsyncMethods.am_anext
    +

    The signature of this function is:

    +
    PyObject *am_anext(PyObject *self)
    +
    +
    +

    Must return an awaitable object. See __anext__() for details. +This slot may be set to NULL.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/unicode.html b/python-3.7.4-docs-html/c-api/unicode.html new file mode 100644 index 0000000..a956519 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/unicode.html @@ -0,0 +1,2020 @@ + + + + + + + Unicode Objects and Codecs — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Unicode Objects and Codecs

    +
    +

    Unicode Objects

    +

    Since the implementation of PEP 393 in Python 3.3, Unicode objects internally +use a variety of representations, in order to allow handling the complete range +of Unicode characters while staying memory efficient. There are special cases +for strings where all code points are below 128, 256, or 65536; otherwise, code +points must be below 1114112 (which is the full Unicode range).

    +

    Py_UNICODE* and UTF-8 representations are created on demand and cached +in the Unicode object. The Py_UNICODE* representation is deprecated +and inefficient; it should be avoided in performance- or memory-sensitive +situations.

    +

    Due to the transition between the old APIs and the new APIs, Unicode objects +can internally be in two states depending on how they were created:

    +
      +
    • “canonical” Unicode objects are all objects created by a non-deprecated +Unicode API. They use the most efficient representation allowed by the +implementation.

    • +
    • “legacy” Unicode objects have been created through one of the deprecated +APIs (typically PyUnicode_FromUnicode()) and only bear the +Py_UNICODE* representation; you will have to call +PyUnicode_READY() on them before calling any other API.

    • +
    +
    +

    Unicode Type

    +

    These are the basic Unicode object types used for the Unicode implementation in +Python:

    +
    +
    +Py_UCS4
    +
    +Py_UCS2
    +
    +Py_UCS1
    +

    These types are typedefs for unsigned integer types wide enough to contain +characters of 32 bits, 16 bits and 8 bits, respectively. When dealing with +single Unicode characters, use Py_UCS4.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +Py_UNICODE
    +

    This is a typedef of wchar_t, which is a 16-bit type or 32-bit type +depending on the platform.

    +
    +

    Changed in version 3.3: In previous versions, this was a 16-bit type or a 32-bit type depending on +whether you selected a “narrow” or “wide” Unicode version of Python at +build time.

    +
    +
    + +
    +
    +PyASCIIObject
    +
    +PyCompactUnicodeObject
    +
    +PyUnicodeObject
    +

    These subtypes of PyObject represent a Python Unicode object. In +almost all cases, they shouldn’t be used directly, since all API functions +that deal with Unicode objects take and return PyObject pointers.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +PyTypeObject PyUnicode_Type
    +

    This instance of PyTypeObject represents the Python Unicode type. It +is exposed to Python code as str.

    +
    + +

    The following APIs are really C macros and can be used to do fast checks and to +access internal read-only data of Unicode objects:

    +
    +
    +int PyUnicode_Check(PyObject *o)
    +

    Return true if the object o is a Unicode object or an instance of a Unicode +subtype.

    +
    + +
    +
    +int PyUnicode_CheckExact(PyObject *o)
    +

    Return true if the object o is a Unicode object, but not an instance of a +subtype.

    +
    + +
    +
    +int PyUnicode_READY(PyObject *o)
    +

    Ensure the string object o is in the “canonical” representation. This is +required before using any of the access macros described below.

    +

    Returns 0 on success and -1 with an exception set on failure, which in +particular happens if memory allocation fails.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +Py_ssize_t PyUnicode_GET_LENGTH(PyObject *o)
    +

    Return the length of the Unicode string, in code points. o has to be a +Unicode object in the “canonical” representation (not checked).

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +Py_UCS1* PyUnicode_1BYTE_DATA(PyObject *o)
    +
    +Py_UCS2* PyUnicode_2BYTE_DATA(PyObject *o)
    +
    +Py_UCS4* PyUnicode_4BYTE_DATA(PyObject *o)
    +

    Return a pointer to the canonical representation cast to UCS1, UCS2 or UCS4 +integer types for direct character access. No checks are performed if the +canonical representation has the correct character size; use +PyUnicode_KIND() to select the right macro. Make sure +PyUnicode_READY() has been called before accessing this.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +PyUnicode_WCHAR_KIND
    +
    +PyUnicode_1BYTE_KIND
    +
    +PyUnicode_2BYTE_KIND
    +
    +PyUnicode_4BYTE_KIND
    +

    Return values of the PyUnicode_KIND() macro.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +int PyUnicode_KIND(PyObject *o)
    +

    Return one of the PyUnicode kind constants (see above) that indicate how many +bytes per character this Unicode object uses to store its data. o has to +be a Unicode object in the “canonical” representation (not checked).

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +void* PyUnicode_DATA(PyObject *o)
    +

    Return a void pointer to the raw Unicode buffer. o has to be a Unicode +object in the “canonical” representation (not checked).

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +void PyUnicode_WRITE(int kind, void *data, Py_ssize_t index, Py_UCS4 value)
    +

    Write into a canonical representation data (as obtained with +PyUnicode_DATA()). This macro does not do any sanity checks and is +intended for usage in loops. The caller should cache the kind value and +data pointer as obtained from other macro calls. index is the index in +the string (starts at 0) and value is the new code point value which should +be written to that location.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +Py_UCS4 PyUnicode_READ(int kind, void *data, Py_ssize_t index)
    +

    Read a code point from a canonical representation data (as obtained with +PyUnicode_DATA()). No checks or ready calls are performed.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +Py_UCS4 PyUnicode_READ_CHAR(PyObject *o, Py_ssize_t index)
    +

    Read a character from a Unicode object o, which must be in the “canonical” +representation. This is less efficient than PyUnicode_READ() if you +do multiple consecutive reads.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +PyUnicode_MAX_CHAR_VALUE(PyObject *o)
    +

    Return the maximum code point that is suitable for creating another string +based on o, which must be in the “canonical” representation. This is +always an approximation but more efficient than iterating over the string.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +int PyUnicode_ClearFreeList()
    +

    Clear the free list. Return the total number of freed items.

    +
    + +
    +
    +Py_ssize_t PyUnicode_GET_SIZE(PyObject *o)
    +

    Return the size of the deprecated Py_UNICODE representation, in +code units (this includes surrogate pairs as 2 units). o has to be a +Unicode object (not checked).

    +
    +

    Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Unicode API, please migrate to using +PyUnicode_GET_LENGTH().

    +
    +
    + +
    +
    +Py_ssize_t PyUnicode_GET_DATA_SIZE(PyObject *o)
    +

    Return the size of the deprecated Py_UNICODE representation in +bytes. o has to be a Unicode object (not checked).

    +
    +

    Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Unicode API, please migrate to using +PyUnicode_GET_LENGTH().

    +
    +
    + +
    +
    +Py_UNICODE* PyUnicode_AS_UNICODE(PyObject *o)
    +
    +const char* PyUnicode_AS_DATA(PyObject *o)
    +

    Return a pointer to a Py_UNICODE representation of the object. The +returned buffer is always terminated with an extra null code point. It +may also contain embedded null code points, which would cause the string +to be truncated when used in most C functions. The AS_DATA form +casts the pointer to const char *. The o argument has to be +a Unicode object (not checked).

    +
    +

    Changed in version 3.3: This macro is now inefficient – because in many cases the +Py_UNICODE representation does not exist and needs to be created +– and can fail (return NULL with an exception set). Try to port the +code to use the new PyUnicode_nBYTE_DATA() macros or use +PyUnicode_WRITE() or PyUnicode_READ().

    +
    +
    +

    Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Unicode API, please migrate to using the +PyUnicode_nBYTE_DATA() family of macros.

    +
    +
    + +
    +
    +

    Unicode Character Properties

    +

    Unicode provides many different character properties. The most often needed ones +are available through these macros which are mapped to C functions depending on +the Python configuration.

    +
    +
    +int Py_UNICODE_ISSPACE(Py_UNICODE ch)
    +

    Return 1 or 0 depending on whether ch is a whitespace character.

    +
    + +
    +
    +int Py_UNICODE_ISLOWER(Py_UNICODE ch)
    +

    Return 1 or 0 depending on whether ch is a lowercase character.

    +
    + +
    +
    +int Py_UNICODE_ISUPPER(Py_UNICODE ch)
    +

    Return 1 or 0 depending on whether ch is an uppercase character.

    +
    + +
    +
    +int Py_UNICODE_ISTITLE(Py_UNICODE ch)
    +

    Return 1 or 0 depending on whether ch is a titlecase character.

    +
    + +
    +
    +int Py_UNICODE_ISLINEBREAK(Py_UNICODE ch)
    +

    Return 1 or 0 depending on whether ch is a linebreak character.

    +
    + +
    +
    +int Py_UNICODE_ISDECIMAL(Py_UNICODE ch)
    +

    Return 1 or 0 depending on whether ch is a decimal character.

    +
    + +
    +
    +int Py_UNICODE_ISDIGIT(Py_UNICODE ch)
    +

    Return 1 or 0 depending on whether ch is a digit character.

    +
    + +
    +
    +int Py_UNICODE_ISNUMERIC(Py_UNICODE ch)
    +

    Return 1 or 0 depending on whether ch is a numeric character.

    +
    + +
    +
    +int Py_UNICODE_ISALPHA(Py_UNICODE ch)
    +

    Return 1 or 0 depending on whether ch is an alphabetic character.

    +
    + +
    +
    +int Py_UNICODE_ISALNUM(Py_UNICODE ch)
    +

    Return 1 or 0 depending on whether ch is an alphanumeric character.

    +
    + +
    +
    +int Py_UNICODE_ISPRINTABLE(Py_UNICODE ch)
    +

    Return 1 or 0 depending on whether ch is a printable character. +Nonprintable characters are those characters defined in the Unicode character +database as “Other” or “Separator”, excepting the ASCII space (0x20) which is +considered printable. (Note that printable characters in this context are +those which should not be escaped when repr() is invoked on a string. +It has no bearing on the handling of strings written to sys.stdout or +sys.stderr.)

    +
    + +

    These APIs can be used for fast direct character conversions:

    +
    +
    +Py_UNICODE Py_UNICODE_TOLOWER(Py_UNICODE ch)
    +

    Return the character ch converted to lower case.

    +
    +

    Deprecated since version 3.3: This function uses simple case mappings.

    +
    +
    + +
    +
    +Py_UNICODE Py_UNICODE_TOUPPER(Py_UNICODE ch)
    +

    Return the character ch converted to upper case.

    +
    +

    Deprecated since version 3.3: This function uses simple case mappings.

    +
    +
    + +
    +
    +Py_UNICODE Py_UNICODE_TOTITLE(Py_UNICODE ch)
    +

    Return the character ch converted to title case.

    +
    +

    Deprecated since version 3.3: This function uses simple case mappings.

    +
    +
    + +
    +
    +int Py_UNICODE_TODECIMAL(Py_UNICODE ch)
    +

    Return the character ch converted to a decimal positive integer. Return +-1 if this is not possible. This macro does not raise exceptions.

    +
    + +
    +
    +int Py_UNICODE_TODIGIT(Py_UNICODE ch)
    +

    Return the character ch converted to a single digit integer. Return -1 if +this is not possible. This macro does not raise exceptions.

    +
    + +
    +
    +double Py_UNICODE_TONUMERIC(Py_UNICODE ch)
    +

    Return the character ch converted to a double. Return -1.0 if this is not +possible. This macro does not raise exceptions.

    +
    + +

    These APIs can be used to work with surrogates:

    +
    +
    +Py_UNICODE_IS_SURROGATE(ch)
    +

    Check if ch is a surrogate (0xD800 <= ch <= 0xDFFF).

    +
    + +
    +
    +Py_UNICODE_IS_HIGH_SURROGATE(ch)
    +

    Check if ch is a high surrogate (0xD800 <= ch <= 0xDBFF).

    +
    + +
    +
    +Py_UNICODE_IS_LOW_SURROGATE(ch)
    +

    Check if ch is a low surrogate (0xDC00 <= ch <= 0xDFFF).

    +
    + +
    +
    +Py_UNICODE_JOIN_SURROGATES(high, low)
    +

    Join two surrogate characters and return a single Py_UCS4 value. +high and low are respectively the leading and trailing surrogates in a +surrogate pair.

    +
    + +
    +
    +

    Creating and accessing Unicode strings

    +

    To create Unicode objects and access their basic sequence properties, use these +APIs:

    +
    +
    +PyObject* PyUnicode_New(Py_ssize_t size, Py_UCS4 maxchar)
    +
    Return value: New reference.

    Create a new Unicode object. maxchar should be the true maximum code point +to be placed in the string. As an approximation, it can be rounded up to the +nearest value in the sequence 127, 255, 65535, 1114111.

    +

    This is the recommended way to allocate a new Unicode object. Objects +created using this function are not resizable.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +PyObject* PyUnicode_FromKindAndData(int kind, const void *buffer, Py_ssize_t size)
    +
    Return value: New reference.

    Create a new Unicode object with the given kind (possible values are +PyUnicode_1BYTE_KIND etc., as returned by +PyUnicode_KIND()). The buffer must point to an array of size +units of 1, 2 or 4 bytes per character, as given by the kind.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +PyObject* PyUnicode_FromStringAndSize(const char *u, Py_ssize_t size)
    +
    Return value: New reference.

    Create a Unicode object from the char buffer u. The bytes will be +interpreted as being UTF-8 encoded. The buffer is copied into the new +object. If the buffer is not NULL, the return value might be a shared +object, i.e. modification of the data is not allowed.

    +

    If u is NULL, this function behaves like PyUnicode_FromUnicode() +with the buffer set to NULL. This usage is deprecated in favor of +PyUnicode_New().

    +
    + +
    +
    +PyObject *PyUnicode_FromString(const char *u)
    +
    Return value: New reference.

    Create a Unicode object from a UTF-8 encoded null-terminated char buffer +u.

    +
    + +
    +
    +PyObject* PyUnicode_FromFormat(const char *format, ...)
    +
    Return value: New reference.

    Take a C printf()-style format string and a variable number of +arguments, calculate the size of the resulting Python Unicode string and return +a string with the values formatted into it. The variable arguments must be C +types and must correspond exactly to the format characters in the format +ASCII-encoded string. The following format characters are allowed:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Format Characters

    Type

    Comment

    %%

    n/a

    The literal % character.

    %c

    int

    A single character, +represented as a C int.

    %d

    int

    Equivalent to +printf("%d"). 1

    %u

    unsigned int

    Equivalent to +printf("%u"). 1

    %ld

    long

    Equivalent to +printf("%ld"). 1

    %li

    long

    Equivalent to +printf("%li"). 1

    %lu

    unsigned long

    Equivalent to +printf("%lu"). 1

    %lld

    long long

    Equivalent to +printf("%lld"). 1

    %lli

    long long

    Equivalent to +printf("%lli"). 1

    %llu

    unsigned long long

    Equivalent to +printf("%llu"). 1

    %zd

    Py_ssize_t

    Equivalent to +printf("%zd"). 1

    %zi

    Py_ssize_t

    Equivalent to +printf("%zi"). 1

    %zu

    size_t

    Equivalent to +printf("%zu"). 1

    %i

    int

    Equivalent to +printf("%i"). 1

    %x

    int

    Equivalent to +printf("%x"). 1

    %s

    const char*

    A null-terminated C character +array.

    %p

    const void*

    The hex representation of a C +pointer. Mostly equivalent to +printf("%p") except that +it is guaranteed to start with +the literal 0x regardless +of what the platform’s +printf yields.

    %A

    PyObject*

    The result of calling +ascii().

    %U

    PyObject*

    A Unicode object.

    %V

    PyObject*, +const char*

    A Unicode object (which may be +NULL) and a null-terminated +C character array as a second +parameter (which will be used, +if the first parameter is +NULL).

    %S

    PyObject*

    The result of calling +PyObject_Str().

    %R

    PyObject*

    The result of calling +PyObject_Repr().

    +

    An unrecognized format character causes all the rest of the format string to be +copied as-is to the result string, and any extra arguments discarded.

    +
    +

    Note

    +

    The width formatter unit is number of characters rather than bytes. +The precision formatter unit is number of bytes for "%s" and +"%V" (if the PyObject* argument is NULL), and a number of +characters for "%A", "%U", "%S", "%R" and "%V" +(if the PyObject* argument is not NULL).

    +
    +
    +
    1(1,2,3,4,5,6,7,8,9,10,11,12,13)
    +

    For integer specifiers (d, u, ld, li, lu, lld, lli, llu, zd, zi, +zu, i, x): the 0-conversion flag has effect even when a precision is given.

    +
    +
    +
    +

    Changed in version 3.2: Support for "%lld" and "%llu" added.

    +
    +
    +

    Changed in version 3.3: Support for "%li", "%lli" and "%zi" added.

    +
    +
    +

    Changed in version 3.4: Support width and precision formatter for "%s", "%A", "%U", +"%V", "%S", "%R" added.

    +
    +
    + +
    +
    +PyObject* PyUnicode_FromFormatV(const char *format, va_list vargs)
    +
    Return value: New reference.

    Identical to PyUnicode_FromFormat() except that it takes exactly two +arguments.

    +
    + +
    +
    +PyObject* PyUnicode_FromEncodedObject(PyObject *obj, const char *encoding, const char *errors)
    +
    Return value: New reference.

    Decode an encoded object obj to a Unicode object.

    +

    bytes, bytearray and other +bytes-like objects +are decoded according to the given encoding and using the error handling +defined by errors. Both can be NULL to have the interface use the default +values (see Built-in Codecs for details).

    +

    All other objects, including Unicode objects, cause a TypeError to be +set.

    +

    The API returns NULL if there was an error. The caller is responsible for +decref’ing the returned objects.

    +
    + +
    +
    +Py_ssize_t PyUnicode_GetLength(PyObject *unicode)
    +

    Return the length of the Unicode object, in code points.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +Py_ssize_t PyUnicode_CopyCharacters(PyObject *to, Py_ssize_t to_start, PyObject *from, Py_ssize_t from_start, Py_ssize_t how_many)
    +

    Copy characters from one Unicode object into another. This function performs +character conversion when necessary and falls back to memcpy() if +possible. Returns -1 and sets an exception on error, otherwise returns +the number of copied characters.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +Py_ssize_t PyUnicode_Fill(PyObject *unicode, Py_ssize_t start, Py_ssize_t length, Py_UCS4 fill_char)
    +

    Fill a string with a character: write fill_char into +unicode[start:start+length].

    +

    Fail if fill_char is bigger than the string maximum character, or if the +string has more than 1 reference.

    +

    Return the number of written character, or return -1 and raise an +exception on error.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +int PyUnicode_WriteChar(PyObject *unicode, Py_ssize_t index, Py_UCS4 character)
    +

    Write a character to a string. The string must have been created through +PyUnicode_New(). Since Unicode strings are supposed to be immutable, +the string must not be shared, or have been hashed yet.

    +

    This function checks that unicode is a Unicode object, that the index is +not out of bounds, and that the object can be modified safely (i.e. that it +its reference count is one).

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +Py_UCS4 PyUnicode_ReadChar(PyObject *unicode, Py_ssize_t index)
    +

    Read a character from a string. This function checks that unicode is a +Unicode object and the index is not out of bounds, in contrast to the macro +version PyUnicode_READ_CHAR().

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +PyObject* PyUnicode_Substring(PyObject *str, Py_ssize_t start, Py_ssize_t end)
    +
    Return value: New reference.

    Return a substring of str, from character index start (included) to +character index end (excluded). Negative indices are not supported.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +Py_UCS4* PyUnicode_AsUCS4(PyObject *u, Py_UCS4 *buffer, Py_ssize_t buflen, int copy_null)
    +

    Copy the string u into a UCS4 buffer, including a null character, if +copy_null is set. Returns NULL and sets an exception on error (in +particular, a SystemError if buflen is smaller than the length of +u). buffer is returned on success.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +Py_UCS4* PyUnicode_AsUCS4Copy(PyObject *u)
    +

    Copy the string u into a new UCS4 buffer that is allocated using +PyMem_Malloc(). If this fails, NULL is returned with a +MemoryError set. The returned buffer always has an extra +null code point appended.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +

    Deprecated Py_UNICODE APIs

    +
    +

    Deprecated since version 3.3, will be removed in version 4.0.

    +
    +

    These API functions are deprecated with the implementation of PEP 393. +Extension modules can continue using them, as they will not be removed in Python +3.x, but need to be aware that their use can now cause performance and memory hits.

    +
    +
    +PyObject* PyUnicode_FromUnicode(const Py_UNICODE *u, Py_ssize_t size)
    +
    Return value: New reference.

    Create a Unicode object from the Py_UNICODE buffer u of the given size. u +may be NULL which causes the contents to be undefined. It is the user’s +responsibility to fill in the needed data. The buffer is copied into the new +object.

    +

    If the buffer is not NULL, the return value might be a shared object. +Therefore, modification of the resulting Unicode object is only allowed when +u is NULL.

    +

    If the buffer is NULL, PyUnicode_READY() must be called once the +string content has been filled before using any of the access macros such as +PyUnicode_KIND().

    +

    Please migrate to using PyUnicode_FromKindAndData(), +PyUnicode_FromWideChar() or PyUnicode_New().

    +
    + +
    +
    +Py_UNICODE* PyUnicode_AsUnicode(PyObject *unicode)
    +

    Return a read-only pointer to the Unicode object’s internal +Py_UNICODE buffer, or NULL on error. This will create the +Py_UNICODE* representation of the object if it is not yet +available. The buffer is always terminated with an extra null code point. +Note that the resulting Py_UNICODE string may also contain +embedded null code points, which would cause the string to be truncated when +used in most C functions.

    +

    Please migrate to using PyUnicode_AsUCS4(), +PyUnicode_AsWideChar(), PyUnicode_ReadChar() or similar new +APIs.

    +
    + +
    +
    +PyObject* PyUnicode_TransformDecimalToASCII(Py_UNICODE *s, Py_ssize_t size)
    +
    Return value: New reference.

    Create a Unicode object by replacing all decimal digits in +Py_UNICODE buffer of the given size by ASCII digits 0–9 +according to their decimal value. Return NULL if an exception occurs.

    +
    + +
    +
    +Py_UNICODE* PyUnicode_AsUnicodeAndSize(PyObject *unicode, Py_ssize_t *size)
    +

    Like PyUnicode_AsUnicode(), but also saves the Py_UNICODE() +array length (excluding the extra null terminator) in size. +Note that the resulting Py_UNICODE* string +may contain embedded null code points, which would cause the string to be +truncated when used in most C functions.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +Py_UNICODE* PyUnicode_AsUnicodeCopy(PyObject *unicode)
    +

    Create a copy of a Unicode string ending with a null code point. Return NULL +and raise a MemoryError exception on memory allocation failure, +otherwise return a new allocated buffer (use PyMem_Free() to free +the buffer). Note that the resulting Py_UNICODE* string may +contain embedded null code points, which would cause the string to be +truncated when used in most C functions.

    +
    +

    New in version 3.2.

    +
    +

    Please migrate to using PyUnicode_AsUCS4Copy() or similar new APIs.

    +
    + +
    +
    +Py_ssize_t PyUnicode_GetSize(PyObject *unicode)
    +

    Return the size of the deprecated Py_UNICODE representation, in +code units (this includes surrogate pairs as 2 units).

    +

    Please migrate to using PyUnicode_GetLength().

    +
    + +
    +
    +PyObject* PyUnicode_FromObject(PyObject *obj)
    +
    Return value: New reference.

    Copy an instance of a Unicode subtype to a new true Unicode object if +necessary. If obj is already a true Unicode object (not a subtype), +return the reference with incremented refcount.

    +

    Objects other than Unicode or its subtypes will cause a TypeError.

    +
    + +
    +
    +

    Locale Encoding

    +

    The current locale encoding can be used to decode text from the operating +system.

    +
    +
    +PyObject* PyUnicode_DecodeLocaleAndSize(const char *str, Py_ssize_t len, const char *errors)
    +
    Return value: New reference.

    Decode a string from UTF-8 on Android, or from the current locale encoding +on other platforms. The supported +error handlers are "strict" and "surrogateescape" +(PEP 383). The decoder uses "strict" error handler if +errors is NULL. str must end with a null character but +cannot contain embedded null characters.

    +

    Use PyUnicode_DecodeFSDefaultAndSize() to decode a string from +Py_FileSystemDefaultEncoding (the locale encoding read at +Python startup).

    +

    This function ignores the Python UTF-8 mode.

    +
    +

    See also

    +

    The Py_DecodeLocale() function.

    +
    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.7: The function now also uses the current locale encoding for the +surrogateescape error handler, except on Android. Previously, Py_DecodeLocale() +was used for the surrogateescape, and the current locale encoding was +used for strict.

    +
    +
    + +
    +
    +PyObject* PyUnicode_DecodeLocale(const char *str, const char *errors)
    +
    Return value: New reference.

    Similar to PyUnicode_DecodeLocaleAndSize(), but compute the string +length using strlen().

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +PyObject* PyUnicode_EncodeLocale(PyObject *unicode, const char *errors)
    +
    Return value: New reference.

    Encode a Unicode object to UTF-8 on Android, or to the current locale +encoding on other platforms. The +supported error handlers are "strict" and "surrogateescape" +(PEP 383). The encoder uses "strict" error handler if +errors is NULL. Return a bytes object. unicode cannot +contain embedded null characters.

    +

    Use PyUnicode_EncodeFSDefault() to encode a string to +Py_FileSystemDefaultEncoding (the locale encoding read at +Python startup).

    +

    This function ignores the Python UTF-8 mode.

    +
    +

    See also

    +

    The Py_EncodeLocale() function.

    +
    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.7: The function now also uses the current locale encoding for the +surrogateescape error handler, except on Android. Previously, +Py_EncodeLocale() +was used for the surrogateescape, and the current locale encoding was +used for strict.

    +
    +
    + +
    +
    +

    File System Encoding

    +

    To encode and decode file names and other environment strings, +Py_FileSystemDefaultEncoding should be used as the encoding, and +Py_FileSystemDefaultEncodeErrors should be used as the error handler +(PEP 383 and PEP 529). To encode file names to bytes during +argument parsing, the "O&" converter should be used, passing +PyUnicode_FSConverter() as the conversion function:

    +
    +
    +int PyUnicode_FSConverter(PyObject* obj, void* result)
    +

    ParseTuple converter: encode str objects – obtained directly or +through the os.PathLike interface – to bytes using +PyUnicode_EncodeFSDefault(); bytes objects are output as-is. +result must be a PyBytesObject* which must be released when it is +no longer used.

    +
    +

    New in version 3.1.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +

    To decode file names to str during argument parsing, the "O&" +converter should be used, passing PyUnicode_FSDecoder() as the +conversion function:

    +
    +
    +int PyUnicode_FSDecoder(PyObject* obj, void* result)
    +

    ParseTuple converter: decode bytes objects – obtained either +directly or indirectly through the os.PathLike interface – to +str using PyUnicode_DecodeFSDefaultAndSize(); str +objects are output as-is. result must be a PyUnicodeObject* which +must be released when it is no longer used.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +PyObject* PyUnicode_DecodeFSDefaultAndSize(const char *s, Py_ssize_t size)
    +
    Return value: New reference.

    Decode a string using Py_FileSystemDefaultEncoding and the +Py_FileSystemDefaultEncodeErrors error handler.

    +

    If Py_FileSystemDefaultEncoding is not set, fall back to the +locale encoding.

    +

    Py_FileSystemDefaultEncoding is initialized at startup from the +locale encoding and cannot be modified later. If you need to decode a string +from the current locale encoding, use +PyUnicode_DecodeLocaleAndSize().

    +
    +

    See also

    +

    The Py_DecodeLocale() function.

    +
    +
    +

    Changed in version 3.6: Use Py_FileSystemDefaultEncodeErrors error handler.

    +
    +
    + +
    +
    +PyObject* PyUnicode_DecodeFSDefault(const char *s)
    +
    Return value: New reference.

    Decode a null-terminated string using Py_FileSystemDefaultEncoding +and the Py_FileSystemDefaultEncodeErrors error handler.

    +

    If Py_FileSystemDefaultEncoding is not set, fall back to the +locale encoding.

    +

    Use PyUnicode_DecodeFSDefaultAndSize() if you know the string length.

    +
    +

    Changed in version 3.6: Use Py_FileSystemDefaultEncodeErrors error handler.

    +
    +
    + +
    +
    +PyObject* PyUnicode_EncodeFSDefault(PyObject *unicode)
    +
    Return value: New reference.

    Encode a Unicode object to Py_FileSystemDefaultEncoding with the +Py_FileSystemDefaultEncodeErrors error handler, and return +bytes. Note that the resulting bytes object may contain +null bytes.

    +

    If Py_FileSystemDefaultEncoding is not set, fall back to the +locale encoding.

    +

    Py_FileSystemDefaultEncoding is initialized at startup from the +locale encoding and cannot be modified later. If you need to encode a string +to the current locale encoding, use PyUnicode_EncodeLocale().

    +
    +

    See also

    +

    The Py_EncodeLocale() function.

    +
    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.6: Use Py_FileSystemDefaultEncodeErrors error handler.

    +
    +
    + +
    +
    +

    wchar_t Support

    +

    wchar_t support for platforms which support it:

    +
    +
    +PyObject* PyUnicode_FromWideChar(const wchar_t *w, Py_ssize_t size)
    +
    Return value: New reference.

    Create a Unicode object from the wchar_t buffer w of the given size. +Passing -1 as the size indicates that the function must itself compute the length, +using wcslen. +Return NULL on failure.

    +
    + +
    +
    +Py_ssize_t PyUnicode_AsWideChar(PyObject *unicode, wchar_t *w, Py_ssize_t size)
    +

    Copy the Unicode object contents into the wchar_t buffer w. At most +size wchar_t characters are copied (excluding a possibly trailing +null termination character). Return the number of wchar_t characters +copied or -1 in case of an error. Note that the resulting wchar_t* +string may or may not be null-terminated. It is the responsibility of the caller +to make sure that the wchar_t* string is null-terminated in case this is +required by the application. Also, note that the wchar_t* string +might contain null characters, which would cause the string to be truncated +when used with most C functions.

    +
    + +
    +
    +wchar_t* PyUnicode_AsWideCharString(PyObject *unicode, Py_ssize_t *size)
    +

    Convert the Unicode object to a wide character string. The output string +always ends with a null character. If size is not NULL, write the number +of wide characters (excluding the trailing null termination character) into +*size. Note that the resulting wchar_t string might contain +null characters, which would cause the string to be truncated when used with +most C functions. If size is NULL and the wchar_t* string +contains null characters a ValueError is raised.

    +

    Returns a buffer allocated by PyMem_Alloc() (use +PyMem_Free() to free it) on success. On error, returns NULL +and *size is undefined. Raises a MemoryError if memory allocation +is failed.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.7: Raises a ValueError if size is NULL and the wchar_t* +string contains null characters.

    +
    +
    + +
    +
    +
    +

    Built-in Codecs

    +

    Python provides a set of built-in codecs which are written in C for speed. All of +these codecs are directly usable via the following functions.

    +

    Many of the following APIs take two arguments encoding and errors, and they +have the same semantics as the ones of the built-in str() string object +constructor.

    +

    Setting encoding to NULL causes the default encoding to be used +which is ASCII. The file system calls should use +PyUnicode_FSConverter() for encoding file names. This uses the +variable Py_FileSystemDefaultEncoding internally. This +variable should be treated as read-only: on some systems, it will be a +pointer to a static string, on others, it will change at run-time +(such as when the application invokes setlocale).

    +

    Error handling is set by errors which may also be set to NULL meaning to use +the default handling defined for the codec. Default error handling for all +built-in codecs is “strict” (ValueError is raised).

    +

    The codecs all use a similar interface. Only deviation from the following +generic ones are documented for simplicity.

    +
    +

    Generic Codecs

    +

    These are the generic codec APIs:

    +
    +
    +PyObject* PyUnicode_Decode(const char *s, Py_ssize_t size, const char *encoding, const char *errors)
    +
    Return value: New reference.

    Create a Unicode object by decoding size bytes of the encoded string s. +encoding and errors have the same meaning as the parameters of the same name +in the str() built-in function. The codec to be used is looked up +using the Python codec registry. Return NULL if an exception was raised by +the codec.

    +
    + +
    +
    +PyObject* PyUnicode_AsEncodedString(PyObject *unicode, const char *encoding, const char *errors)
    +
    Return value: New reference.

    Encode a Unicode object and return the result as Python bytes object. +encoding and errors have the same meaning as the parameters of the same +name in the Unicode encode() method. The codec to be used is looked up +using the Python codec registry. Return NULL if an exception was raised by +the codec.

    +
    + +
    +
    +PyObject* PyUnicode_Encode(const Py_UNICODE *s, Py_ssize_t size, const char *encoding, const char *errors)
    +
    Return value: New reference.

    Encode the Py_UNICODE buffer s of the given size and return a Python +bytes object. encoding and errors have the same meaning as the +parameters of the same name in the Unicode encode() method. The codec +to be used is looked up using the Python codec registry. Return NULL if an +exception was raised by the codec.

    +
    +

    Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Py_UNICODE API; please migrate to using +PyUnicode_AsEncodedString().

    +
    +
    + +
    +
    +

    UTF-8 Codecs

    +

    These are the UTF-8 codec APIs:

    +
    +
    +PyObject* PyUnicode_DecodeUTF8(const char *s, Py_ssize_t size, const char *errors)
    +
    Return value: New reference.

    Create a Unicode object by decoding size bytes of the UTF-8 encoded string +s. Return NULL if an exception was raised by the codec.

    +
    + +
    +
    +PyObject* PyUnicode_DecodeUTF8Stateful(const char *s, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
    +
    Return value: New reference.

    If consumed is NULL, behave like PyUnicode_DecodeUTF8(). If +consumed is not NULL, trailing incomplete UTF-8 byte sequences will not be +treated as an error. Those bytes will not be decoded and the number of bytes +that have been decoded will be stored in consumed.

    +
    + +
    +
    +PyObject* PyUnicode_AsUTF8String(PyObject *unicode)
    +
    Return value: New reference.

    Encode a Unicode object using UTF-8 and return the result as Python bytes +object. Error handling is “strict”. Return NULL if an exception was +raised by the codec.

    +
    + +
    +
    +const char* PyUnicode_AsUTF8AndSize(PyObject *unicode, Py_ssize_t *size)
    +

    Return a pointer to the UTF-8 encoding of the Unicode object, and +store the size of the encoded representation (in bytes) in size. The +size argument can be NULL; in this case no size will be stored. The +returned buffer always has an extra null byte appended (not included in +size), regardless of whether there are any other null code points.

    +

    In the case of an error, NULL is returned with an exception set and no +size is stored.

    +

    This caches the UTF-8 representation of the string in the Unicode object, and +subsequent calls will return a pointer to the same buffer. The caller is not +responsible for deallocating the buffer.

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.7: The return type is now const char * rather of char *.

    +
    +
    + +
    +
    +const char* PyUnicode_AsUTF8(PyObject *unicode)
    +

    As PyUnicode_AsUTF8AndSize(), but does not store the size.

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.7: The return type is now const char * rather of char *.

    +
    +
    + +
    +
    +PyObject* PyUnicode_EncodeUTF8(const Py_UNICODE *s, Py_ssize_t size, const char *errors)
    +
    Return value: New reference.

    Encode the Py_UNICODE buffer s of the given size using UTF-8 and +return a Python bytes object. Return NULL if an exception was raised by +the codec.

    +
    +

    Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Py_UNICODE API; please migrate to using +PyUnicode_AsUTF8String(), PyUnicode_AsUTF8AndSize() or +PyUnicode_AsEncodedString().

    +
    +
    + +
    +
    +

    UTF-32 Codecs

    +

    These are the UTF-32 codec APIs:

    +
    +
    +PyObject* PyUnicode_DecodeUTF32(const char *s, Py_ssize_t size, const char *errors, int *byteorder)
    +
    Return value: New reference.

    Decode size bytes from a UTF-32 encoded buffer string and return the +corresponding Unicode object. errors (if non-NULL) defines the error +handling. It defaults to “strict”.

    +

    If byteorder is non-NULL, the decoder starts decoding using the given byte +order:

    +
    *byteorder == -1: little endian
    +*byteorder == 0:  native order
    +*byteorder == 1:  big endian
    +
    +
    +

    If *byteorder is zero, and the first four bytes of the input data are a +byte order mark (BOM), the decoder switches to this byte order and the BOM is +not copied into the resulting Unicode string. If *byteorder is -1 or +1, any byte order mark is copied to the output.

    +

    After completion, *byteorder is set to the current byte order at the end +of input data.

    +

    If byteorder is NULL, the codec starts in native order mode.

    +

    Return NULL if an exception was raised by the codec.

    +
    + +
    +
    +PyObject* PyUnicode_DecodeUTF32Stateful(const char *s, Py_ssize_t size, const char *errors, int *byteorder, Py_ssize_t *consumed)
    +
    Return value: New reference.

    If consumed is NULL, behave like PyUnicode_DecodeUTF32(). If +consumed is not NULL, PyUnicode_DecodeUTF32Stateful() will not treat +trailing incomplete UTF-32 byte sequences (such as a number of bytes not divisible +by four) as an error. Those bytes will not be decoded and the number of bytes +that have been decoded will be stored in consumed.

    +
    + +
    +
    +PyObject* PyUnicode_AsUTF32String(PyObject *unicode)
    +
    Return value: New reference.

    Return a Python byte string using the UTF-32 encoding in native byte +order. The string always starts with a BOM mark. Error handling is “strict”. +Return NULL if an exception was raised by the codec.

    +
    + +
    +
    +PyObject* PyUnicode_EncodeUTF32(const Py_UNICODE *s, Py_ssize_t size, const char *errors, int byteorder)
    +
    Return value: New reference.

    Return a Python bytes object holding the UTF-32 encoded value of the Unicode +data in s. Output is written according to the following byte order:

    +
    byteorder == -1: little endian
    +byteorder == 0:  native byte order (writes a BOM mark)
    +byteorder == 1:  big endian
    +
    +
    +

    If byteorder is 0, the output string will always start with the Unicode BOM +mark (U+FEFF). In the other two modes, no BOM mark is prepended.

    +

    If Py_UNICODE_WIDE is not defined, surrogate pairs will be output +as a single code point.

    +

    Return NULL if an exception was raised by the codec.

    +
    +

    Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Py_UNICODE API; please migrate to using +PyUnicode_AsUTF32String() or PyUnicode_AsEncodedString().

    +
    +
    + +
    +
    +

    UTF-16 Codecs

    +

    These are the UTF-16 codec APIs:

    +
    +
    +PyObject* PyUnicode_DecodeUTF16(const char *s, Py_ssize_t size, const char *errors, int *byteorder)
    +
    Return value: New reference.

    Decode size bytes from a UTF-16 encoded buffer string and return the +corresponding Unicode object. errors (if non-NULL) defines the error +handling. It defaults to “strict”.

    +

    If byteorder is non-NULL, the decoder starts decoding using the given byte +order:

    +
    *byteorder == -1: little endian
    +*byteorder == 0:  native order
    +*byteorder == 1:  big endian
    +
    +
    +

    If *byteorder is zero, and the first two bytes of the input data are a +byte order mark (BOM), the decoder switches to this byte order and the BOM is +not copied into the resulting Unicode string. If *byteorder is -1 or +1, any byte order mark is copied to the output (where it will result in +either a \ufeff or a \ufffe character).

    +

    After completion, *byteorder is set to the current byte order at the end +of input data.

    +

    If byteorder is NULL, the codec starts in native order mode.

    +

    Return NULL if an exception was raised by the codec.

    +
    + +
    +
    +PyObject* PyUnicode_DecodeUTF16Stateful(const char *s, Py_ssize_t size, const char *errors, int *byteorder, Py_ssize_t *consumed)
    +
    Return value: New reference.

    If consumed is NULL, behave like PyUnicode_DecodeUTF16(). If +consumed is not NULL, PyUnicode_DecodeUTF16Stateful() will not treat +trailing incomplete UTF-16 byte sequences (such as an odd number of bytes or a +split surrogate pair) as an error. Those bytes will not be decoded and the +number of bytes that have been decoded will be stored in consumed.

    +
    + +
    +
    +PyObject* PyUnicode_AsUTF16String(PyObject *unicode)
    +
    Return value: New reference.

    Return a Python byte string using the UTF-16 encoding in native byte +order. The string always starts with a BOM mark. Error handling is “strict”. +Return NULL if an exception was raised by the codec.

    +
    + +
    +
    +PyObject* PyUnicode_EncodeUTF16(const Py_UNICODE *s, Py_ssize_t size, const char *errors, int byteorder)
    +
    Return value: New reference.

    Return a Python bytes object holding the UTF-16 encoded value of the Unicode +data in s. Output is written according to the following byte order:

    +
    byteorder == -1: little endian
    +byteorder == 0:  native byte order (writes a BOM mark)
    +byteorder == 1:  big endian
    +
    +
    +

    If byteorder is 0, the output string will always start with the Unicode BOM +mark (U+FEFF). In the other two modes, no BOM mark is prepended.

    +

    If Py_UNICODE_WIDE is defined, a single Py_UNICODE value may get +represented as a surrogate pair. If it is not defined, each Py_UNICODE +values is interpreted as a UCS-2 character.

    +

    Return NULL if an exception was raised by the codec.

    +
    +

    Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Py_UNICODE API; please migrate to using +PyUnicode_AsUTF16String() or PyUnicode_AsEncodedString().

    +
    +
    + +
    +
    +

    UTF-7 Codecs

    +

    These are the UTF-7 codec APIs:

    +
    +
    +PyObject* PyUnicode_DecodeUTF7(const char *s, Py_ssize_t size, const char *errors)
    +
    Return value: New reference.

    Create a Unicode object by decoding size bytes of the UTF-7 encoded string +s. Return NULL if an exception was raised by the codec.

    +
    + +
    +
    +PyObject* PyUnicode_DecodeUTF7Stateful(const char *s, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
    +
    Return value: New reference.

    If consumed is NULL, behave like PyUnicode_DecodeUTF7(). If +consumed is not NULL, trailing incomplete UTF-7 base-64 sections will not +be treated as an error. Those bytes will not be decoded and the number of +bytes that have been decoded will be stored in consumed.

    +
    + +
    +
    +PyObject* PyUnicode_EncodeUTF7(const Py_UNICODE *s, Py_ssize_t size, int base64SetO, int base64WhiteSpace, const char *errors)
    +
    Return value: New reference.

    Encode the Py_UNICODE buffer of the given size using UTF-7 and +return a Python bytes object. Return NULL if an exception was raised by +the codec.

    +

    If base64SetO is nonzero, “Set O” (punctuation that has no otherwise +special meaning) will be encoded in base-64. If base64WhiteSpace is +nonzero, whitespace will be encoded in base-64. Both are set to zero for the +Python “utf-7” codec.

    +
    +

    Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Py_UNICODE API; please migrate to using +PyUnicode_AsEncodedString().

    +
    +
    + +
    +
    +

    Unicode-Escape Codecs

    +

    These are the “Unicode Escape” codec APIs:

    +
    +
    +PyObject* PyUnicode_DecodeUnicodeEscape(const char *s, Py_ssize_t size, const char *errors)
    +
    Return value: New reference.

    Create a Unicode object by decoding size bytes of the Unicode-Escape encoded +string s. Return NULL if an exception was raised by the codec.

    +
    + +
    +
    +PyObject* PyUnicode_AsUnicodeEscapeString(PyObject *unicode)
    +
    Return value: New reference.

    Encode a Unicode object using Unicode-Escape and return the result as a +bytes object. Error handling is “strict”. Return NULL if an exception was +raised by the codec.

    +
    + +
    +
    +PyObject* PyUnicode_EncodeUnicodeEscape(const Py_UNICODE *s, Py_ssize_t size)
    +
    Return value: New reference.

    Encode the Py_UNICODE buffer of the given size using Unicode-Escape and +return a bytes object. Return NULL if an exception was raised by the codec.

    +
    +

    Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Py_UNICODE API; please migrate to using +PyUnicode_AsUnicodeEscapeString().

    +
    +
    + +
    +
    +

    Raw-Unicode-Escape Codecs

    +

    These are the “Raw Unicode Escape” codec APIs:

    +
    +
    +PyObject* PyUnicode_DecodeRawUnicodeEscape(const char *s, Py_ssize_t size, const char *errors)
    +
    Return value: New reference.

    Create a Unicode object by decoding size bytes of the Raw-Unicode-Escape +encoded string s. Return NULL if an exception was raised by the codec.

    +
    + +
    +
    +PyObject* PyUnicode_AsRawUnicodeEscapeString(PyObject *unicode)
    +
    Return value: New reference.

    Encode a Unicode object using Raw-Unicode-Escape and return the result as +a bytes object. Error handling is “strict”. Return NULL if an exception +was raised by the codec.

    +
    + +
    +
    +PyObject* PyUnicode_EncodeRawUnicodeEscape(const Py_UNICODE *s, Py_ssize_t size)
    +
    Return value: New reference.

    Encode the Py_UNICODE buffer of the given size using Raw-Unicode-Escape +and return a bytes object. Return NULL if an exception was raised by the codec.

    +
    +

    Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Py_UNICODE API; please migrate to using +PyUnicode_AsRawUnicodeEscapeString() or +PyUnicode_AsEncodedString().

    +
    +
    + +
    +
    +

    Latin-1 Codecs

    +

    These are the Latin-1 codec APIs: Latin-1 corresponds to the first 256 Unicode +ordinals and only these are accepted by the codecs during encoding.

    +
    +
    +PyObject* PyUnicode_DecodeLatin1(const char *s, Py_ssize_t size, const char *errors)
    +
    Return value: New reference.

    Create a Unicode object by decoding size bytes of the Latin-1 encoded string +s. Return NULL if an exception was raised by the codec.

    +
    + +
    +
    +PyObject* PyUnicode_AsLatin1String(PyObject *unicode)
    +
    Return value: New reference.

    Encode a Unicode object using Latin-1 and return the result as Python bytes +object. Error handling is “strict”. Return NULL if an exception was +raised by the codec.

    +
    + +
    +
    +PyObject* PyUnicode_EncodeLatin1(const Py_UNICODE *s, Py_ssize_t size, const char *errors)
    +
    Return value: New reference.

    Encode the Py_UNICODE buffer of the given size using Latin-1 and +return a Python bytes object. Return NULL if an exception was raised by +the codec.

    +
    +

    Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Py_UNICODE API; please migrate to using +PyUnicode_AsLatin1String() or +PyUnicode_AsEncodedString().

    +
    +
    + +
    +
    +

    ASCII Codecs

    +

    These are the ASCII codec APIs. Only 7-bit ASCII data is accepted. All other +codes generate errors.

    +
    +
    +PyObject* PyUnicode_DecodeASCII(const char *s, Py_ssize_t size, const char *errors)
    +
    Return value: New reference.

    Create a Unicode object by decoding size bytes of the ASCII encoded string +s. Return NULL if an exception was raised by the codec.

    +
    + +
    +
    +PyObject* PyUnicode_AsASCIIString(PyObject *unicode)
    +
    Return value: New reference.

    Encode a Unicode object using ASCII and return the result as Python bytes +object. Error handling is “strict”. Return NULL if an exception was +raised by the codec.

    +
    + +
    +
    +PyObject* PyUnicode_EncodeASCII(const Py_UNICODE *s, Py_ssize_t size, const char *errors)
    +
    Return value: New reference.

    Encode the Py_UNICODE buffer of the given size using ASCII and +return a Python bytes object. Return NULL if an exception was raised by +the codec.

    +
    +

    Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Py_UNICODE API; please migrate to using +PyUnicode_AsASCIIString() or +PyUnicode_AsEncodedString().

    +
    +
    + +
    +
    +

    Character Map Codecs

    +

    This codec is special in that it can be used to implement many different codecs +(and this is in fact what was done to obtain most of the standard codecs +included in the encodings package). The codec uses mapping to encode and +decode characters. The mapping objects provided must support the +__getitem__() mapping interface; dictionaries and sequences work well.

    +

    These are the mapping codec APIs:

    +
    +
    +PyObject* PyUnicode_DecodeCharmap(const char *data, Py_ssize_t size, PyObject *mapping, const char *errors)
    +
    Return value: New reference.

    Create a Unicode object by decoding size bytes of the encoded string s +using the given mapping object. Return NULL if an exception was raised +by the codec.

    +

    If mapping is NULL, Latin-1 decoding will be applied. Else +mapping must map bytes ordinals (integers in the range from 0 to 255) +to Unicode strings, integers (which are then interpreted as Unicode +ordinals) or None. Unmapped data bytes – ones which cause a +LookupError, as well as ones which get mapped to None, +0xFFFE or '\ufffe', are treated as undefined mappings and cause +an error.

    +
    + +
    +
    +PyObject* PyUnicode_AsCharmapString(PyObject *unicode, PyObject *mapping)
    +
    Return value: New reference.

    Encode a Unicode object using the given mapping object and return the +result as a bytes object. Error handling is “strict”. Return NULL if an +exception was raised by the codec.

    +

    The mapping object must map Unicode ordinal integers to bytes objects, +integers in the range from 0 to 255 or None. Unmapped character +ordinals (ones which cause a LookupError) as well as mapped to +None are treated as “undefined mapping” and cause an error.

    +
    + +
    +
    +PyObject* PyUnicode_EncodeCharmap(const Py_UNICODE *s, Py_ssize_t size, PyObject *mapping, const char *errors)
    +
    Return value: New reference.

    Encode the Py_UNICODE buffer of the given size using the given +mapping object and return the result as a bytes object. Return NULL if +an exception was raised by the codec.

    +
    +

    Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Py_UNICODE API; please migrate to using +PyUnicode_AsCharmapString() or +PyUnicode_AsEncodedString().

    +
    +
    + +

    The following codec API is special in that maps Unicode to Unicode.

    +
    +
    +PyObject* PyUnicode_Translate(PyObject *unicode, PyObject *mapping, const char *errors)
    +
    Return value: New reference.

    Translate a Unicode object using the given mapping object and return the +resulting Unicode object. Return NULL if an exception was raised by the +codec.

    +

    The mapping object must map Unicode ordinal integers to Unicode strings, +integers (which are then interpreted as Unicode ordinals) or None +(causing deletion of the character). Unmapped character ordinals (ones +which cause a LookupError) are left untouched and are copied as-is.

    +
    + +
    +
    +PyObject* PyUnicode_TranslateCharmap(const Py_UNICODE *s, Py_ssize_t size, PyObject *mapping, const char *errors)
    +
    Return value: New reference.

    Translate a Py_UNICODE buffer of the given size by applying a +character mapping table to it and return the resulting Unicode object. +Return NULL when an exception was raised by the codec.

    +
    +

    Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Py_UNICODE API; please migrate to using +PyUnicode_Translate(). or generic codec based API

    +
    +
    + +
    +
    +

    MBCS codecs for Windows

    +

    These are the MBCS codec APIs. They are currently only available on Windows and +use the Win32 MBCS converters to implement the conversions. Note that MBCS (or +DBCS) is a class of encodings, not just one. The target encoding is defined by +the user settings on the machine running the codec.

    +
    +
    +PyObject* PyUnicode_DecodeMBCS(const char *s, Py_ssize_t size, const char *errors)
    +
    Return value: New reference.

    Create a Unicode object by decoding size bytes of the MBCS encoded string s. +Return NULL if an exception was raised by the codec.

    +
    + +
    +
    +PyObject* PyUnicode_DecodeMBCSStateful(const char *s, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
    +
    Return value: New reference.

    If consumed is NULL, behave like PyUnicode_DecodeMBCS(). If +consumed is not NULL, PyUnicode_DecodeMBCSStateful() will not decode +trailing lead byte and the number of bytes that have been decoded will be stored +in consumed.

    +
    + +
    +
    +PyObject* PyUnicode_AsMBCSString(PyObject *unicode)
    +
    Return value: New reference.

    Encode a Unicode object using MBCS and return the result as Python bytes +object. Error handling is “strict”. Return NULL if an exception was +raised by the codec.

    +
    + +
    +
    +PyObject* PyUnicode_EncodeCodePage(int code_page, PyObject *unicode, const char *errors)
    +
    Return value: New reference.

    Encode the Unicode object using the specified code page and return a Python +bytes object. Return NULL if an exception was raised by the codec. Use +CP_ACP code page to get the MBCS encoder.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +PyObject* PyUnicode_EncodeMBCS(const Py_UNICODE *s, Py_ssize_t size, const char *errors)
    +
    Return value: New reference.

    Encode the Py_UNICODE buffer of the given size using MBCS and return +a Python bytes object. Return NULL if an exception was raised by the +codec.

    +
    +

    Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style Py_UNICODE API; please migrate to using +PyUnicode_AsMBCSString(), PyUnicode_EncodeCodePage() or +PyUnicode_AsEncodedString().

    +
    +
    + +
    +
    +

    Methods & Slots

    +
    +
    +
    +

    Methods and Slot Functions

    +

    The following APIs are capable of handling Unicode objects and strings on input +(we refer to them as strings in the descriptions) and return Unicode objects or +integers as appropriate.

    +

    They all return NULL or -1 if an exception occurs.

    +
    +
    +PyObject* PyUnicode_Concat(PyObject *left, PyObject *right)
    +
    Return value: New reference.

    Concat two strings giving a new Unicode string.

    +
    + +
    +
    +PyObject* PyUnicode_Split(PyObject *s, PyObject *sep, Py_ssize_t maxsplit)
    +
    Return value: New reference.

    Split a string giving a list of Unicode strings. If sep is NULL, splitting +will be done at all whitespace substrings. Otherwise, splits occur at the given +separator. At most maxsplit splits will be done. If negative, no limit is +set. Separators are not included in the resulting list.

    +
    + +
    +
    +PyObject* PyUnicode_Splitlines(PyObject *s, int keepend)
    +
    Return value: New reference.

    Split a Unicode string at line breaks, returning a list of Unicode strings. +CRLF is considered to be one line break. If keepend is 0, the Line break +characters are not included in the resulting strings.

    +
    + +
    +
    +PyObject* PyUnicode_Translate(PyObject *str, PyObject *table, const char *errors)
    +

    Translate a string by applying a character mapping table to it and return the +resulting Unicode object.

    +

    The mapping table must map Unicode ordinal integers to Unicode ordinal integers +or None (causing deletion of the character).

    +

    Mapping tables need only provide the __getitem__() interface; dictionaries +and sequences work well. Unmapped character ordinals (ones which cause a +LookupError) are left untouched and are copied as-is.

    +

    errors has the usual meaning for codecs. It may be NULL which indicates to +use the default error handling.

    +
    + +
    +
    +PyObject* PyUnicode_Join(PyObject *separator, PyObject *seq)
    +
    Return value: New reference.

    Join a sequence of strings using the given separator and return the resulting +Unicode string.

    +
    + +
    +
    +Py_ssize_t PyUnicode_Tailmatch(PyObject *str, PyObject *substr, Py_ssize_t start, Py_ssize_t end, int direction)
    +

    Return 1 if substr matches str[start:end] at the given tail end +(direction == -1 means to do a prefix match, direction == 1 a suffix match), +0 otherwise. Return -1 if an error occurred.

    +
    + +
    +
    +Py_ssize_t PyUnicode_Find(PyObject *str, PyObject *substr, Py_ssize_t start, Py_ssize_t end, int direction)
    +

    Return the first position of substr in str[start:end] using the given +direction (direction == 1 means to do a forward search, direction == -1 a +backward search). The return value is the index of the first match; a value of +-1 indicates that no match was found, and -2 indicates that an error +occurred and an exception has been set.

    +
    + +
    +
    +Py_ssize_t PyUnicode_FindChar(PyObject *str, Py_UCS4 ch, Py_ssize_t start, Py_ssize_t end, int direction)
    +

    Return the first position of the character ch in str[start:end] using +the given direction (direction == 1 means to do a forward search, +direction == -1 a backward search). The return value is the index of the +first match; a value of -1 indicates that no match was found, and -2 +indicates that an error occurred and an exception has been set.

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.7: start and end are now adjusted to behave like str[start:end].

    +
    +
    + +
    +
    +Py_ssize_t PyUnicode_Count(PyObject *str, PyObject *substr, Py_ssize_t start, Py_ssize_t end)
    +

    Return the number of non-overlapping occurrences of substr in +str[start:end]. Return -1 if an error occurred.

    +
    + +
    +
    +PyObject* PyUnicode_Replace(PyObject *str, PyObject *substr, PyObject *replstr, Py_ssize_t maxcount)
    +
    Return value: New reference.

    Replace at most maxcount occurrences of substr in str with replstr and +return the resulting Unicode object. maxcount == -1 means replace all +occurrences.

    +
    + +
    +
    +int PyUnicode_Compare(PyObject *left, PyObject *right)
    +

    Compare two strings and return -1, 0, 1 for less than, equal, and greater than, +respectively.

    +

    This function returns -1 upon failure, so one should call +PyErr_Occurred() to check for errors.

    +
    + +
    +
    +int PyUnicode_CompareWithASCIIString(PyObject *uni, const char *string)
    +

    Compare a Unicode object, uni, with string and return -1, 0, 1 for less +than, equal, and greater than, respectively. It is best to pass only +ASCII-encoded strings, but the function interprets the input string as +ISO-8859-1 if it contains non-ASCII characters.

    +

    This function does not raise exceptions.

    +
    + +
    +
    +PyObject* PyUnicode_RichCompare(PyObject *left, PyObject *right, int op)
    +
    Return value: New reference.

    Rich compare two Unicode strings and return one of the following:

    +
      +
    • NULL in case an exception was raised

    • +
    • Py_True or Py_False for successful comparisons

    • +
    • Py_NotImplemented in case the type combination is unknown

    • +
    +

    Possible values for op are Py_GT, Py_GE, Py_EQ, +Py_NE, Py_LT, and Py_LE.

    +
    + +
    +
    +PyObject* PyUnicode_Format(PyObject *format, PyObject *args)
    +
    Return value: New reference.

    Return a new string object from format and args; this is analogous to +format % args.

    +
    + +
    +
    +int PyUnicode_Contains(PyObject *container, PyObject *element)
    +

    Check whether element is contained in container and return true or false +accordingly.

    +

    element has to coerce to a one element Unicode string. -1 is returned +if there was an error.

    +
    + +
    +
    +void PyUnicode_InternInPlace(PyObject **string)
    +

    Intern the argument *string in place. The argument must be the address of a +pointer variable pointing to a Python Unicode string object. If there is an +existing interned string that is the same as *string, it sets *string to +it (decrementing the reference count of the old string object and incrementing +the reference count of the interned string object), otherwise it leaves +*string alone and interns it (incrementing its reference count). +(Clarification: even though there is a lot of talk about reference counts, think +of this function as reference-count-neutral; you own the object after the call +if and only if you owned it before the call.)

    +
    + +
    +
    +PyObject* PyUnicode_InternFromString(const char *v)
    +
    Return value: New reference.

    A combination of PyUnicode_FromString() and +PyUnicode_InternInPlace(), returning either a new Unicode string +object that has been interned, or a new (“owned”) reference to an earlier +interned string object with the same value.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/utilities.html b/python-3.7.4-docs-html/c-api/utilities.html new file mode 100644 index 0000000..081e1ab --- /dev/null +++ b/python-3.7.4-docs-html/c-api/utilities.html @@ -0,0 +1,211 @@ + + + + + + + Utilities — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Utilities

    +

    The functions in this chapter perform various utility tasks, ranging from +helping C code be more portable across platforms, using Python modules from C, +and parsing function arguments and constructing Python values from C values.

    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/veryhigh.html b/python-3.7.4-docs-html/c-api/veryhigh.html new file mode 100644 index 0000000..49d11af --- /dev/null +++ b/python-3.7.4-docs-html/c-api/veryhigh.html @@ -0,0 +1,597 @@ + + + + + + + The Very High Level Layer — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    The Very High Level Layer

    +

    The functions in this chapter will let you execute Python source code given in a +file or a buffer, but they will not let you interact in a more detailed way with +the interpreter.

    +

    Several of these functions accept a start symbol from the grammar as a +parameter. The available start symbols are Py_eval_input, +Py_file_input, and Py_single_input. These are described +following the functions which accept them as parameters.

    +

    Note also that several of these functions take FILE* parameters. One +particular issue which needs to be handled carefully is that the FILE +structure for different C libraries can be different and incompatible. Under +Windows (at least), it is possible for dynamically linked extensions to actually +use different libraries, so care should be taken that FILE* parameters +are only passed to these functions if it is certain that they were created by +the same library that the Python runtime is using.

    +
    +
    +int Py_Main(int argc, wchar_t **argv)
    +

    The main program for the standard interpreter. This is made available for +programs which embed Python. The argc and argv parameters should be +prepared exactly as those which are passed to a C program’s main() +function (converted to wchar_t according to the user’s locale). It is +important to note that the argument list may be modified (but the contents of +the strings pointed to by the argument list are not). The return value will +be 0 if the interpreter exits normally (i.e., without an exception), +1 if the interpreter exits due to an exception, or 2 if the parameter +list does not represent a valid Python command line.

    +

    Note that if an otherwise unhandled SystemExit is raised, this +function will not return 1, but exit the process, as long as +Py_InspectFlag is not set.

    +
    + +
    +
    +int PyRun_AnyFile(FILE *fp, const char *filename)
    +

    This is a simplified interface to PyRun_AnyFileExFlags() below, leaving +closeit set to 0 and flags set to NULL.

    +
    + +
    +
    +int PyRun_AnyFileFlags(FILE *fp, const char *filename, PyCompilerFlags *flags)
    +

    This is a simplified interface to PyRun_AnyFileExFlags() below, leaving +the closeit argument set to 0.

    +
    + +
    +
    +int PyRun_AnyFileEx(FILE *fp, const char *filename, int closeit)
    +

    This is a simplified interface to PyRun_AnyFileExFlags() below, leaving +the flags argument set to NULL.

    +
    + +
    +
    +int PyRun_AnyFileExFlags(FILE *fp, const char *filename, int closeit, PyCompilerFlags *flags)
    +

    If fp refers to a file associated with an interactive device (console or +terminal input or Unix pseudo-terminal), return the value of +PyRun_InteractiveLoop(), otherwise return the result of +PyRun_SimpleFile(). filename is decoded from the filesystem +encoding (sys.getfilesystemencoding()). If filename is NULL, this +function uses "???" as the filename.

    +
    + +
    +
    +int PyRun_SimpleString(const char *command)
    +

    This is a simplified interface to PyRun_SimpleStringFlags() below, +leaving the PyCompilerFlags* argument set to NULL.

    +
    + +
    +
    +int PyRun_SimpleStringFlags(const char *command, PyCompilerFlags *flags)
    +

    Executes the Python source code from command in the __main__ module +according to the flags argument. If __main__ does not already exist, it +is created. Returns 0 on success or -1 if an exception was raised. If +there was an error, there is no way to get the exception information. For the +meaning of flags, see below.

    +

    Note that if an otherwise unhandled SystemExit is raised, this +function will not return -1, but exit the process, as long as +Py_InspectFlag is not set.

    +
    + +
    +
    +int PyRun_SimpleFile(FILE *fp, const char *filename)
    +

    This is a simplified interface to PyRun_SimpleFileExFlags() below, +leaving closeit set to 0 and flags set to NULL.

    +
    + +
    +
    +int PyRun_SimpleFileEx(FILE *fp, const char *filename, int closeit)
    +

    This is a simplified interface to PyRun_SimpleFileExFlags() below, +leaving flags set to NULL.

    +
    + +
    +
    +int PyRun_SimpleFileExFlags(FILE *fp, const char *filename, int closeit, PyCompilerFlags *flags)
    +

    Similar to PyRun_SimpleStringFlags(), but the Python source code is read +from fp instead of an in-memory string. filename should be the name of +the file, it is decoded from the filesystem encoding +(sys.getfilesystemencoding()). If closeit is true, the file is +closed before PyRun_SimpleFileExFlags returns.

    +
    +

    Note

    +

    On Windows, fp should be opened as binary mode (e.g. fopen(filename, "rb"). +Otherwise, Python may not handle script file with LF line ending correctly.

    +
    +
    + +
    +
    +int PyRun_InteractiveOne(FILE *fp, const char *filename)
    +

    This is a simplified interface to PyRun_InteractiveOneFlags() below, +leaving flags set to NULL.

    +
    + +
    +
    +int PyRun_InteractiveOneFlags(FILE *fp, const char *filename, PyCompilerFlags *flags)
    +

    Read and execute a single statement from a file associated with an +interactive device according to the flags argument. The user will be +prompted using sys.ps1 and sys.ps2. filename is decoded from the +filesystem encoding (sys.getfilesystemencoding()).

    +

    Returns 0 when the input was +executed successfully, -1 if there was an exception, or an error code +from the errcode.h include file distributed as part of Python if +there was a parse error. (Note that errcode.h is not included by +Python.h, so must be included specifically if needed.)

    +
    + +
    +
    +int PyRun_InteractiveLoop(FILE *fp, const char *filename)
    +

    This is a simplified interface to PyRun_InteractiveLoopFlags() below, +leaving flags set to NULL.

    +
    + +
    +
    +int PyRun_InteractiveLoopFlags(FILE *fp, const char *filename, PyCompilerFlags *flags)
    +

    Read and execute statements from a file associated with an interactive device +until EOF is reached. The user will be prompted using sys.ps1 and +sys.ps2. filename is decoded from the filesystem encoding +(sys.getfilesystemencoding()). Returns 0 at EOF or a negative +number upon failure.

    +
    + +
    +
    +int (*PyOS_InputHook)(void)
    +

    Can be set to point to a function with the prototype +int func(void). The function will be called when Python’s +interpreter prompt is about to become idle and wait for user input +from the terminal. The return value is ignored. Overriding this +hook can be used to integrate the interpreter’s prompt with other +event loops, as done in the Modules/_tkinter.c in the +Python source code.

    +
    + +
    +
    +char* (*PyOS_ReadlineFunctionPointer)(FILE *, FILE *, const char *)
    +

    Can be set to point to a function with the prototype +char *func(FILE *stdin, FILE *stdout, char *prompt), +overriding the default function used to read a single line of input +at the interpreter’s prompt. The function is expected to output +the string prompt if it’s not NULL, and then read a line of +input from the provided standard input file, returning the +resulting string. For example, The readline module sets +this hook to provide line-editing and tab-completion features.

    +

    The result must be a string allocated by PyMem_RawMalloc() or +PyMem_RawRealloc(), or NULL if an error occurred.

    +
    +

    Changed in version 3.4: The result must be allocated by PyMem_RawMalloc() or +PyMem_RawRealloc(), instead of being allocated by +PyMem_Malloc() or PyMem_Realloc().

    +
    +
    + +
    +
    +struct _node* PyParser_SimpleParseString(const char *str, int start)
    +

    This is a simplified interface to +PyParser_SimpleParseStringFlagsFilename() below, leaving filename set +to NULL and flags set to 0.

    +
    + +
    +
    +struct _node* PyParser_SimpleParseStringFlags(const char *str, int start, int flags)
    +

    This is a simplified interface to +PyParser_SimpleParseStringFlagsFilename() below, leaving filename set +to NULL.

    +
    + +
    +
    +struct _node* PyParser_SimpleParseStringFlagsFilename(const char *str, const char *filename, int start, int flags)
    +

    Parse Python source code from str using the start token start according to +the flags argument. The result can be used to create a code object which can +be evaluated efficiently. This is useful if a code fragment must be evaluated +many times. filename is decoded from the filesystem encoding +(sys.getfilesystemencoding()).

    +
    + +
    +
    +struct _node* PyParser_SimpleParseFile(FILE *fp, const char *filename, int start)
    +

    This is a simplified interface to PyParser_SimpleParseFileFlags() below, +leaving flags set to 0.

    +
    + +
    +
    +struct _node* PyParser_SimpleParseFileFlags(FILE *fp, const char *filename, int start, int flags)
    +

    Similar to PyParser_SimpleParseStringFlagsFilename(), but the Python +source code is read from fp instead of an in-memory string.

    +
    + +
    +
    +PyObject* PyRun_String(const char *str, int start, PyObject *globals, PyObject *locals)
    +
    Return value: New reference.

    This is a simplified interface to PyRun_StringFlags() below, leaving +flags set to NULL.

    +
    + +
    +
    +PyObject* PyRun_StringFlags(const char *str, int start, PyObject *globals, PyObject *locals, PyCompilerFlags *flags)
    +
    Return value: New reference.

    Execute Python source code from str in the context specified by the +objects globals and locals with the compiler flags specified by +flags. globals must be a dictionary; locals can be any object +that implements the mapping protocol. The parameter start specifies +the start token that should be used to parse the source code.

    +

    Returns the result of executing the code as a Python object, or NULL if an +exception was raised.

    +
    + +
    +
    +PyObject* PyRun_File(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals)
    +
    Return value: New reference.

    This is a simplified interface to PyRun_FileExFlags() below, leaving +closeit set to 0 and flags set to NULL.

    +
    + +
    +
    +PyObject* PyRun_FileEx(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, int closeit)
    +
    Return value: New reference.

    This is a simplified interface to PyRun_FileExFlags() below, leaving +flags set to NULL.

    +
    + +
    +
    +PyObject* PyRun_FileFlags(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, PyCompilerFlags *flags)
    +
    Return value: New reference.

    This is a simplified interface to PyRun_FileExFlags() below, leaving +closeit set to 0.

    +
    + +
    +
    +PyObject* PyRun_FileExFlags(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, int closeit, PyCompilerFlags *flags)
    +
    Return value: New reference.

    Similar to PyRun_StringFlags(), but the Python source code is read from +fp instead of an in-memory string. filename should be the name of the file, +it is decoded from the filesystem encoding (sys.getfilesystemencoding()). +If closeit is true, the file is closed before PyRun_FileExFlags() +returns.

    +
    + +
    +
    +PyObject* Py_CompileString(const char *str, const char *filename, int start)
    +
    Return value: New reference.

    This is a simplified interface to Py_CompileStringFlags() below, leaving +flags set to NULL.

    +
    + +
    +
    +PyObject* Py_CompileStringFlags(const char *str, const char *filename, int start, PyCompilerFlags *flags)
    +
    Return value: New reference.

    This is a simplified interface to Py_CompileStringExFlags() below, with +optimize set to -1.

    +
    + +
    +
    +PyObject* Py_CompileStringObject(const char *str, PyObject *filename, int start, PyCompilerFlags *flags, int optimize)
    +
    Return value: New reference.

    Parse and compile the Python source code in str, returning the resulting code +object. The start token is given by start; this can be used to constrain the +code which can be compiled and should be Py_eval_input, +Py_file_input, or Py_single_input. The filename specified by +filename is used to construct the code object and may appear in tracebacks or +SyntaxError exception messages. This returns NULL if the code +cannot be parsed or compiled.

    +

    The integer optimize specifies the optimization level of the compiler; a +value of -1 selects the optimization level of the interpreter as given by +-O options. Explicit levels are 0 (no optimization; +__debug__ is true), 1 (asserts are removed, __debug__ is false) +or 2 (docstrings are removed too).

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +PyObject* Py_CompileStringExFlags(const char *str, const char *filename, int start, PyCompilerFlags *flags, int optimize)
    +
    Return value: New reference.

    Like Py_CompileStringObject(), but filename is a byte string +decoded from the filesystem encoding (os.fsdecode()).

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +PyObject* PyEval_EvalCode(PyObject *co, PyObject *globals, PyObject *locals)
    +
    Return value: New reference.

    This is a simplified interface to PyEval_EvalCodeEx(), with just +the code object, and global and local variables. The other arguments are +set to NULL.

    +
    + +
    +
    +PyObject* PyEval_EvalCodeEx(PyObject *co, PyObject *globals, PyObject *locals, PyObject *const *args, int argcount, PyObject *const *kws, int kwcount, PyObject *const *defs, int defcount, PyObject *kwdefs, PyObject *closure)
    +
    Return value: New reference.

    Evaluate a precompiled code object, given a particular environment for its +evaluation. This environment consists of a dictionary of global variables, +a mapping object of local variables, arrays of arguments, keywords and +defaults, a dictionary of default values for keyword-only arguments and a closure tuple of cells.

    +
    + +
    +
    +PyFrameObject
    +

    The C structure of the objects used to describe frame objects. The +fields of this type are subject to change at any time.

    +
    + +
    +
    +PyObject* PyEval_EvalFrame(PyFrameObject *f)
    +
    Return value: New reference.

    Evaluate an execution frame. This is a simplified interface to +PyEval_EvalFrameEx(), for backward compatibility.

    +
    + +
    +
    +PyObject* PyEval_EvalFrameEx(PyFrameObject *f, int throwflag)
    +
    Return value: New reference.

    This is the main, unvarnished function of Python interpretation. It is +literally 2000 lines long. The code object associated with the execution +frame f is executed, interpreting bytecode and executing calls as needed. +The additional throwflag parameter can mostly be ignored - if true, then +it causes an exception to immediately be thrown; this is used for the +throw() methods of generator objects.

    +
    +

    Changed in version 3.4: This function now includes a debug assertion to help ensure that it +does not silently discard an active exception.

    +
    +
    + +
    +
    +int PyEval_MergeCompilerFlags(PyCompilerFlags *cf)
    +

    This function changes the flags of the current evaluation frame, and returns +true on success, false on failure.

    +
    + +
    +
    +int Py_eval_input
    +

    The start symbol from the Python grammar for isolated expressions; for use with +Py_CompileString().

    +
    + +
    +
    +int Py_file_input
    +

    The start symbol from the Python grammar for sequences of statements as read +from a file or other source; for use with Py_CompileString(). This is +the symbol to use when compiling arbitrarily long Python source code.

    +
    + +
    +
    +int Py_single_input
    +

    The start symbol from the Python grammar for a single statement; for use with +Py_CompileString(). This is the symbol used for the interactive +interpreter loop.

    +
    + +
    +
    +struct PyCompilerFlags
    +

    This is the structure used to hold compiler flags. In cases where code is only +being compiled, it is passed as int flags, and in cases where code is being +executed, it is passed as PyCompilerFlags *flags. In this case, from +__future__ import can modify flags.

    +

    Whenever PyCompilerFlags *flags is NULL, cf_flags is treated as +equal to 0, and any modification due to from __future__ import is +discarded.

    +
    struct PyCompilerFlags {
    +    int cf_flags;
    +}
    +
    +
    +
    + +
    +
    +int CO_FUTURE_DIVISION
    +

    This bit can be set in flags to cause division operator / to be +interpreted as “true division” according to PEP 238.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/c-api/weakref.html b/python-3.7.4-docs-html/c-api/weakref.html new file mode 100644 index 0000000..1eaec58 --- /dev/null +++ b/python-3.7.4-docs-html/c-api/weakref.html @@ -0,0 +1,252 @@ + + + + + + + Weak Reference Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Weak Reference Objects

    +

    Python supports weak references as first-class objects. There are two +specific object types which directly implement weak references. The first is a +simple reference object, and the second acts as a proxy for the original object +as much as it can.

    +
    +
    +int PyWeakref_Check(ob)
    +

    Return true if ob is either a reference or proxy object.

    +
    + +
    +
    +int PyWeakref_CheckRef(ob)
    +

    Return true if ob is a reference object.

    +
    + +
    +
    +int PyWeakref_CheckProxy(ob)
    +

    Return true if ob is a proxy object.

    +
    + +
    +
    +PyObject* PyWeakref_NewRef(PyObject *ob, PyObject *callback)
    +
    Return value: New reference.

    Return a weak reference object for the object ob. This will always return +a new reference, but is not guaranteed to create a new object; an existing +reference object may be returned. The second parameter, callback, can be a +callable object that receives notification when ob is garbage collected; it +should accept a single parameter, which will be the weak reference object +itself. callback may also be None or NULL. If ob is not a +weakly-referencable object, or if callback is not callable, None, or +NULL, this will return NULL and raise TypeError.

    +
    + +
    +
    +PyObject* PyWeakref_NewProxy(PyObject *ob, PyObject *callback)
    +
    Return value: New reference.

    Return a weak reference proxy object for the object ob. This will always +return a new reference, but is not guaranteed to create a new object; an +existing proxy object may be returned. The second parameter, callback, can +be a callable object that receives notification when ob is garbage +collected; it should accept a single parameter, which will be the weak +reference object itself. callback may also be None or NULL. If ob +is not a weakly-referencable object, or if callback is not callable, +None, or NULL, this will return NULL and raise TypeError.

    +
    + +
    +
    +PyObject* PyWeakref_GetObject(PyObject *ref)
    +
    Return value: Borrowed reference.

    Return the referenced object from a weak reference, ref. If the referent is +no longer live, returns Py_None.

    +
    +

    Note

    +

    This function returns a borrowed reference to the referenced object. +This means that you should always call Py_INCREF() on the object +except if you know that it cannot be destroyed while you are still +using it.

    +
    +
    + +
    +
    +PyObject* PyWeakref_GET_OBJECT(PyObject *ref)
    +
    Return value: Borrowed reference.

    Similar to PyWeakref_GetObject(), but implemented as a macro that does no +error checking.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/contents.html b/python-3.7.4-docs-html/contents.html new file mode 100644 index 0000000..86913f6 --- /dev/null +++ b/python-3.7.4-docs-html/contents.html @@ -0,0 +1,5743 @@ + + + + + + + Python Documentation contents — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Python Documentation contents

    +
    + +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/copyright.html b/python-3.7.4-docs-html/copyright.html new file mode 100644 index 0000000..bc1a0a6 --- /dev/null +++ b/python-3.7.4-docs-html/copyright.html @@ -0,0 +1,187 @@ + + + + + + + Copyright — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/distributing/index.html b/python-3.7.4-docs-html/distributing/index.html new file mode 100644 index 0000000..f4aedad --- /dev/null +++ b/python-3.7.4-docs-html/distributing/index.html @@ -0,0 +1,326 @@ + + + + + + + Distributing Python Modules — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Distributing Python Modules

    +
    +
    Email
    +

    distutils-sig@python.org

    +
    +
    +

    As a popular open source development project, Python has an active +supporting community of contributors and users that also make their software +available for other Python developers to use under open source license terms.

    +

    This allows Python users to share and collaborate effectively, benefiting +from the solutions others have already created to common (and sometimes +even rare!) problems, as well as potentially contributing their own +solutions to the common pool.

    +

    This guide covers the distribution part of the process. For a guide to +installing other Python projects, refer to the +installation guide.

    +
    +

    Note

    +

    For corporate and other institutional users, be aware that many +organisations have their own policies around using and contributing to +open source software. Please take such policies into account when making +use of the distribution and installation tools provided with Python.

    +
    +
    +

    Key terms

    +
      +
    • the Python Packaging Index is a public +repository of open source licensed packages made available for use by +other Python users

    • +
    • the Python Packaging Authority are the group of +developers and documentation authors responsible for the maintenance and +evolution of the standard packaging tools and the associated metadata and +file format standards. They maintain a variety of tools, documentation +and issue trackers on both GitHub and +BitBucket.

    • +
    • distutils is the original build and distribution system first added +to the Python standard library in 1998. While direct use of distutils +is being phased out, it still laid the foundation for the current packaging +and distribution infrastructure, and it not only remains part of the +standard library, but its name lives on in other ways (such as the name +of the mailing list used to coordinate Python packaging standards +development).

    • +
    • setuptools is a (largely) drop-in replacement for distutils first +published in 2004. Its most notable addition over the unmodified +distutils tools was the ability to declare dependencies on other +packages. It is currently recommended as a more regularly updated +alternative to distutils that offers consistent support for more +recent packaging standards across a wide range of Python versions.

    • +
    • wheel (in this context) is a project that adds the bdist_wheel +command to distutils/setuptools. This produces a cross platform +binary packaging format (called “wheels” or “wheel files” and defined in +PEP 427) that allows Python libraries, even those including binary +extensions, to be installed on a system without needing to be built +locally.

    • +
    +
    +
    +

    Open source licensing and collaboration

    +

    In most parts of the world, software is automatically covered by copyright. +This means that other developers require explicit permission to copy, use, +modify and redistribute the software.

    +

    Open source licensing is a way of explicitly granting such permission in a +relatively consistent way, allowing developers to share and collaborate +efficiently by making common solutions to various problems freely available. +This leaves many developers free to spend more time focusing on the problems +that are relatively unique to their specific situation.

    +

    The distribution tools provided with Python are designed to make it +reasonably straightforward for developers to make their own contributions +back to that common pool of software if they choose to do so.

    +

    The same distribution tools can also be used to distribute software within +an organisation, regardless of whether that software is published as open +source software or not.

    +
    +
    +

    Installing the tools

    +

    The standard library does not include build tools that support modern +Python packaging standards, as the core development team has found that it +is important to have standard tools that work consistently, even on older +versions of Python.

    +

    The currently recommended build and distribution tools can be installed +by invoking the pip module at the command line:

    +
    python -m pip install setuptools wheel twine
    +
    +
    +
    +

    Note

    +

    For POSIX users (including Mac OS X and Linux users), these instructions +assume the use of a virtual environment.

    +

    For Windows users, these instructions assume that the option to +adjust the system PATH environment variable was selected when installing +Python.

    +
    +

    The Python Packaging User Guide includes more details on the currently +recommended tools.

    +
    +
    +

    Reading the Python Packaging User Guide

    +

    The Python Packaging User Guide covers the various key steps and elements +involved in creating and publishing a project:

    + +
    +
    +

    How do I…?

    +

    These are quick answers or links for some common tasks.

    +
    +

    … choose a name for my project?

    +

    This isn’t an easy topic, but here are a few tips:

    +
      +
    • check the Python Packaging Index to see if the name is already in use

    • +
    • check popular hosting sites like GitHub, BitBucket, etc to see if there +is already a project with that name

    • +
    • check what comes up in a web search for the name you’re considering

    • +
    • avoid particularly common words, especially ones with multiple meanings, +as they can make it difficult for users to find your software when +searching for it

    • +
    +
    +
    +

    … create and distribute binary extensions?

    +

    This is actually quite a complex topic, with a variety of alternatives +available depending on exactly what you’re aiming to achieve. See the +Python Packaging User Guide for more information and recommendations.

    + +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/distutils/apiref.html b/python-3.7.4-docs-html/distutils/apiref.html new file mode 100644 index 0000000..5b77e28 --- /dev/null +++ b/python-3.7.4-docs-html/distutils/apiref.html @@ -0,0 +1,2095 @@ + + + + + + + 9. API Reference — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    9. API Reference

    +
    +

    9.1. distutils.core — Core Distutils functionality

    +

    The distutils.core module is the only module that needs to be installed +to use the Distutils. It provides the setup() (which is called from the +setup script). Indirectly provides the distutils.dist.Distribution and +distutils.cmd.Command class.

    +
    +
    +distutils.core.setup(arguments)
    +

    The basic do-everything function that does most everything you could ever ask +for from a Distutils method.

    +

    The setup function takes a large number of arguments. These are laid out in the +following table.

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    argument name

    value

    type

    name

    The name of the package

    a string

    version

    The version number of the +package; see +distutils.version

    a string

    description

    A single line describing the +package

    a string

    long_description

    Longer description of the +package

    a string

    author

    The name of the package author

    a string

    author_email

    The email address of the +package author

    a string

    maintainer

    The name of the current +maintainer, if different from +the author. Note that if +the maintainer is provided, +distutils will use it as the +author in PKG-INFO

    a string

    maintainer_email

    The email address of the +current maintainer, if +different from the author

    a string

    url

    A URL for the package +(homepage)

    a string

    download_url

    A URL to download the package

    a string

    packages

    A list of Python packages that +distutils will manipulate

    a list of strings

    py_modules

    A list of Python modules that +distutils will manipulate

    a list of strings

    scripts

    A list of standalone script +files to be built and +installed

    a list of strings

    ext_modules

    A list of Python extensions to +be built

    a list of instances of +distutils.core.Extension

    classifiers

    A list of categories for the +package

    a list of strings; valid classifiers are listed on PyPI.

    distclass

    the Distribution +class to use

    a subclass of +distutils.core.Distribution

    script_name

    The name of the setup.py +script - defaults to +sys.argv[0]

    a string

    script_args

    Arguments to supply to the +setup script

    a list of strings

    options

    default options for the setup +script

    a dictionary

    license

    The license for the package

    a string

    keywords

    Descriptive meta-data, see +PEP 314

    a list of strings or a comma-separated string

    platforms

    a list of strings or a comma-separated string

    cmdclass

    A mapping of command names to +Command subclasses

    a dictionary

    data_files

    A list of data files to +install

    a list

    package_dir

    A mapping of package to +directory names

    a dictionary

    +
    + +
    +
    +distutils.core.run_setup(script_name[, script_args=None, stop_after='run'])
    +

    Run a setup script in a somewhat controlled environment, and return the +distutils.dist.Distribution instance that drives things. This is +useful if you need to find out the distribution meta-data (passed as keyword +args from script to setup()), or the contents of the config files or +command-line.

    +

    script_name is a file that will be read and run with exec(). sys.argv[0] +will be replaced with script for the duration of the call. script_args is a +list of strings; if supplied, sys.argv[1:] will be replaced by script_args +for the duration of the call.

    +

    stop_after tells setup() when to stop processing; possible values:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    value

    description

    init

    Stop after the Distribution +instance has been created and populated +with the keyword arguments to setup()

    config

    Stop after config files have been parsed +(and their data stored in the +Distribution instance)

    commandline

    Stop after the command-line +(sys.argv[1:] or script_args) have +been parsed (and the data stored in the +Distribution instance.)

    run

    Stop after all commands have been run (the +same as if setup() had been called +in the usual way). This is the default +value.

    +
    + +

    In addition, the distutils.core module exposed a number of classes that +live elsewhere.

    + +

    A short description of each of these follows, but see the relevant module for +the full reference.

    +
    +
    +class distutils.core.Extension
    +

    The Extension class describes a single C or C++ extension module in a setup +script. It accepts the following keyword arguments in its constructor:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    argument name

    value

    type

    name

    the full name of the +extension, including any +packages — ie. not a +filename or pathname, but +Python dotted name

    a string

    sources

    list of source filenames, +relative to the distribution +root (where the setup script +lives), in Unix form +(slash-separated) for +portability. +Source files may be C, C++, +SWIG (.i), platform-specific +resource files, or whatever +else is recognized by the +build_ext command +as source for a Python +extension.

    a list of strings

    include_dirs

    list of directories to search +for C/C++ header files (in +Unix form for portability)

    a list of strings

    define_macros

    list of macros to define; each +macro is defined using a +2-tuple (name, value), +where value is +either the string to define it +to or None to define it +without a particular value +(equivalent of #define FOO +in source or -DFOO +on Unix C compiler command +line)

    a list of tuples

    undef_macros

    list of macros to undefine +explicitly

    a list of strings

    library_dirs

    list of directories to search +for C/C++ libraries at link +time

    a list of strings

    libraries

    list of library names (not +filenames or paths) to link +against

    a list of strings

    runtime_library_dirs

    list of directories to search +for C/C++ libraries at run +time (for shared extensions, +this is when the extension is +loaded)

    a list of strings

    extra_objects

    list of extra files to link +with (eg. object files not +implied by ‘sources’, static +library that must be +explicitly specified, binary +resource files, etc.)

    a list of strings

    extra_compile_args

    any extra platform- and +compiler-specific information +to use when compiling the +source files in ‘sources’. For +platforms and compilers where +a command line makes sense, +this is typically a list of +command-line arguments, but +for other platforms it could +be anything.

    a list of strings

    extra_link_args

    any extra platform- and +compiler-specific information +to use when linking object +files together to create the +extension (or to create a new +static Python interpreter). +Similar interpretation as for +‘extra_compile_args’.

    a list of strings

    export_symbols

    list of symbols to be exported +from a shared extension. Not +used on all platforms, and not +generally necessary for Python +extensions, which typically +export exactly one symbol: +init + extension_name.

    a list of strings

    depends

    list of files that the +extension depends on

    a list of strings

    language

    extension language (i.e. +'c', 'c++', +'objc'). Will be detected +from the source extensions if +not provided.

    a string

    optional

    specifies that a build failure +in the extension should not +abort the build process, but +simply skip the extension.

    a boolean

    +
    + +
    +
    +class distutils.core.Distribution
    +

    A Distribution describes how to build, install and package up a Python +software package.

    +

    See the setup() function for a list of keyword arguments accepted by the +Distribution constructor. setup() creates a Distribution instance.

    +
    +

    Changed in version 3.7: Distribution now warns if classifiers, +keywords and platforms fields are not specified as a list or +a string.

    +
    +
    + +
    +
    +class distutils.core.Command
    +

    A Command class (or rather, an instance of one of its subclasses) +implement a single distutils command.

    +
    + +
    +
    +

    9.2. distutils.ccompiler — CCompiler base class

    +

    This module provides the abstract base class for the CCompiler +classes. A CCompiler instance can be used for all the compile and +link steps needed to build a single project. Methods are provided to set +options for the compiler — macro definitions, include directories, link path, +libraries and the like.

    +

    This module provides the following functions.

    +
    +
    +distutils.ccompiler.gen_lib_options(compiler, library_dirs, runtime_library_dirs, libraries)
    +

    Generate linker options for searching library directories and linking with +specific libraries. libraries and library_dirs are, respectively, lists of +library names (not filenames!) and search directories. Returns a list of +command-line options suitable for use with some compiler (depending on the two +format strings passed in).

    +
    + +
    +
    +distutils.ccompiler.gen_preprocess_options(macros, include_dirs)
    +

    Generate C pre-processor options (-D, -U, -I) as +used by at least two types of compilers: the typical Unix compiler and Visual +C++. macros is the usual thing, a list of 1- or 2-tuples, where (name,) +means undefine (-U) macro name, and (name, value) means define +(-D) macro name to value. include_dirs is just a list of +directory names to be added to the header file search path (-I). +Returns a list of command-line options suitable for either Unix compilers or +Visual C++.

    +
    + +
    +
    +distutils.ccompiler.get_default_compiler(osname, platform)
    +

    Determine the default compiler to use for the given platform.

    +

    osname should be one of the standard Python OS names (i.e. the ones returned +by os.name) and platform the common value returned by sys.platform for +the platform in question.

    +

    The default values are os.name and sys.platform in case the parameters +are not given.

    +
    + +
    +
    +distutils.ccompiler.new_compiler(plat=None, compiler=None, verbose=0, dry_run=0, force=0)
    +

    Factory function to generate an instance of some CCompiler subclass for the +supplied platform/compiler combination. plat defaults to os.name (eg. +'posix', 'nt'), and compiler defaults to the default compiler for +that platform. Currently only 'posix' and 'nt' are supported, and the +default compilers are “traditional Unix interface” (UnixCCompiler +class) and Visual C++ (MSVCCompiler class). Note that it’s perfectly +possible to ask for a Unix compiler object under Windows, and a Microsoft +compiler object under Unix—if you supply a value for compiler, plat is +ignored.

    +
    + +
    +
    +distutils.ccompiler.show_compilers()
    +

    Print list of available compilers (used by the --help-compiler options +to build, build_ext, build_clib).

    +
    + +
    +
    +class distutils.ccompiler.CCompiler([verbose=0, dry_run=0, force=0])
    +

    The abstract base class CCompiler defines the interface that must be +implemented by real compiler classes. The class also has some utility methods +used by several compiler classes.

    +

    The basic idea behind a compiler abstraction class is that each instance can be +used for all the compile/link steps in building a single project. Thus, +attributes common to all of those compile and link steps — include +directories, macros to define, libraries to link against, etc. — are +attributes of the compiler instance. To allow for variability in how individual +files are treated, most of those attributes may be varied on a per-compilation +or per-link basis.

    +

    The constructor for each subclass creates an instance of the Compiler object. +Flags are verbose (show verbose output), dry_run (don’t actually execute the +steps) and force (rebuild everything, regardless of dependencies). All of +these flags default to 0 (off). Note that you probably don’t want to +instantiate CCompiler or one of its subclasses directly - use the +distutils.CCompiler.new_compiler() factory function instead.

    +

    The following methods allow you to manually alter compiler options for the +instance of the Compiler class.

    +
    +
    +add_include_dir(dir)
    +

    Add dir to the list of directories that will be searched for header files. +The compiler is instructed to search directories in the order in which they are +supplied by successive calls to add_include_dir().

    +
    + +
    +
    +set_include_dirs(dirs)
    +

    Set the list of directories that will be searched to dirs (a list of strings). +Overrides any preceding calls to add_include_dir(); subsequent calls to +add_include_dir() add to the list passed to set_include_dirs(). +This does not affect any list of standard include directories that the compiler +may search by default.

    +
    + +
    +
    +add_library(libname)
    +

    Add libname to the list of libraries that will be included in all links driven +by this compiler object. Note that libname should *not* be the name of a +file containing a library, but the name of the library itself: the actual +filename will be inferred by the linker, the compiler, or the compiler class +(depending on the platform).

    +

    The linker will be instructed to link against libraries in the order they were +supplied to add_library() and/or set_libraries(). It is perfectly +valid to duplicate library names; the linker will be instructed to link against +libraries as many times as they are mentioned.

    +
    + +
    +
    +set_libraries(libnames)
    +

    Set the list of libraries to be included in all links driven by this compiler +object to libnames (a list of strings). This does not affect any standard +system libraries that the linker may include by default.

    +
    + +
    +
    +add_library_dir(dir)
    +

    Add dir to the list of directories that will be searched for libraries +specified to add_library() and set_libraries(). The linker will be +instructed to search for libraries in the order they are supplied to +add_library_dir() and/or set_library_dirs().

    +
    + +
    +
    +set_library_dirs(dirs)
    +

    Set the list of library search directories to dirs (a list of strings). This +does not affect any standard library search path that the linker may search by +default.

    +
    + +
    +
    +add_runtime_library_dir(dir)
    +

    Add dir to the list of directories that will be searched for shared libraries +at runtime.

    +
    + +
    +
    +set_runtime_library_dirs(dirs)
    +

    Set the list of directories to search for shared libraries at runtime to dirs +(a list of strings). This does not affect any standard search path that the +runtime linker may search by default.

    +
    + +
    +
    +define_macro(name[, value=None])
    +

    Define a preprocessor macro for all compilations driven by this compiler object. +The optional parameter value should be a string; if it is not supplied, then +the macro will be defined without an explicit value and the exact outcome +depends on the compiler used.

    +
    + +
    +
    +undefine_macro(name)
    +

    Undefine a preprocessor macro for all compilations driven by this compiler +object. If the same macro is defined by define_macro() and +undefined by undefine_macro() the last call takes precedence +(including multiple redefinitions or undefinitions). If the macro is +redefined/undefined on a per-compilation basis (ie. in the call to +compile()), then that takes precedence.

    +
    + +
    + +

    Add object to the list of object files (or analogues, such as explicitly named +library files or the output of “resource compilers”) to be included in every +link driven by this compiler object.

    +
    + +
    + +

    Set the list of object files (or analogues) to be included in every link to +objects. This does not affect any standard object files that the linker may +include by default (such as system libraries).

    +
    + +

    The following methods implement methods for autodetection of compiler options, +providing some functionality similar to GNU autoconf.

    +
    +
    +detect_language(sources)
    +

    Detect the language of a given file, or list of files. Uses the instance +attributes language_map (a dictionary), and language_order (a +list) to do the job.

    +
    + +
    +
    +find_library_file(dirs, lib[, debug=0])
    +

    Search the specified list of directories for a static or shared library file +lib and return the full path to that file. If debug is true, look for a +debugging version (if that makes sense on the current platform). Return +None if lib wasn’t found in any of the specified directories.

    +
    + +
    +
    +has_function(funcname[, includes=None, include_dirs=None, libraries=None, library_dirs=None])
    +

    Return a boolean indicating whether funcname is supported on the current +platform. The optional arguments can be used to augment the compilation +environment by providing additional include files and paths and libraries and +paths.

    +
    + +
    +
    +library_dir_option(dir)
    +

    Return the compiler option to add dir to the list of directories searched for +libraries.

    +
    + +
    +
    +library_option(lib)
    +

    Return the compiler option to add lib to the list of libraries linked into the +shared library or executable.

    +
    + +
    +
    +runtime_library_dir_option(dir)
    +

    Return the compiler option to add dir to the list of directories searched for +runtime libraries.

    +
    + +
    +
    +set_executables(**args)
    +

    Define the executables (and options for them) that will be run to perform the +various stages of compilation. The exact set of executables that may be +specified here depends on the compiler class (via the ‘executables’ class +attribute), but most will have:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    attribute

    description

    compiler

    the C/C++ compiler

    linker_so

    linker used to create shared objects and +libraries

    linker_exe

    linker used to create binary executables

    archiver

    static library creator

    +

    On platforms with a command-line (Unix, DOS/Windows), each of these is a string +that will be split into executable name and (optional) list of arguments. +(Splitting the string is done similarly to how Unix shells operate: words are +delimited by spaces, but quotes and backslashes can override this. See +distutils.util.split_quoted().)

    +
    + +

    The following methods invoke stages in the build process.

    +
    +
    +compile(sources[, output_dir=None, macros=None, include_dirs=None, debug=0, extra_preargs=None, extra_postargs=None, depends=None])
    +

    Compile one or more source files. Generates object files (e.g. transforms a +.c file to a .o file.)

    +

    sources must be a list of filenames, most likely C/C++ files, but in reality +anything that can be handled by a particular compiler and compiler class (eg. +MSVCCompiler can handle resource files in sources). Return a list of +object filenames, one per source filename in sources. Depending on the +implementation, not all source files will necessarily be compiled, but all +corresponding object filenames will be returned.

    +

    If output_dir is given, object files will be put under it, while retaining +their original path component. That is, foo/bar.c normally compiles to +foo/bar.o (for a Unix implementation); if output_dir is build, then +it would compile to build/foo/bar.o.

    +

    macros, if given, must be a list of macro definitions. A macro definition is +either a (name, value) 2-tuple or a (name,) 1-tuple. The former defines +a macro; if the value is None, the macro is defined without an explicit +value. The 1-tuple case undefines a macro. Later +definitions/redefinitions/undefinitions take precedence.

    +

    include_dirs, if given, must be a list of strings, the directories to add to +the default include file search path for this compilation only.

    +

    debug is a boolean; if true, the compiler will be instructed to output debug +symbols in (or alongside) the object file(s).

    +

    extra_preargs and extra_postargs are implementation-dependent. On platforms +that have the notion of a command-line (e.g. Unix, DOS/Windows), they are most +likely lists of strings: extra command-line arguments to prepend/append to the +compiler command line. On other platforms, consult the implementation class +documentation. In any event, they are intended as an escape hatch for those +occasions when the abstract compiler framework doesn’t cut the mustard.

    +

    depends, if given, is a list of filenames that all targets depend on. If a +source file is older than any file in depends, then the source file will be +recompiled. This supports dependency tracking, but only at a coarse +granularity.

    +

    Raises CompileError on failure.

    +
    + +
    +
    +create_static_lib(objects, output_libname[, output_dir=None, debug=0, target_lang=None])
    +

    Link a bunch of stuff together to create a static library file. The “bunch of +stuff” consists of the list of object files supplied as objects, the extra +object files supplied to add_link_object() and/or +set_link_objects(), the libraries supplied to add_library() and/or +set_libraries(), and the libraries supplied as libraries (if any).

    +

    output_libname should be a library name, not a filename; the filename will be +inferred from the library name. output_dir is the directory where the library +file will be put.

    +

    debug is a boolean; if true, debugging information will be included in the +library (note that on most platforms, it is the compile step where this matters: +the debug flag is included here just for consistency).

    +

    target_lang is the target language for which the given objects are being +compiled. This allows specific linkage time treatment of certain languages.

    +

    Raises LibError on failure.

    +
    + +
    + +

    Link a bunch of stuff together to create an executable or shared library file.

    +

    The “bunch of stuff” consists of the list of object files supplied as objects. +output_filename should be a filename. If output_dir is supplied, +output_filename is relative to it (i.e. output_filename can provide +directory components if needed).

    +

    libraries is a list of libraries to link against. These are library names, +not filenames, since they’re translated into filenames in a platform-specific +way (eg. foo becomes libfoo.a on Unix and foo.lib on +DOS/Windows). However, they can include a directory component, which means the +linker will look in that specific directory rather than searching all the normal +locations.

    +

    library_dirs, if supplied, should be a list of directories to search for +libraries that were specified as bare library names (ie. no directory +component). These are on top of the system default and those supplied to +add_library_dir() and/or set_library_dirs(). runtime_library_dirs +is a list of directories that will be embedded into the shared library and used +to search for other shared libraries that *it* depends on at run-time. (This +may only be relevant on Unix.)

    +

    export_symbols is a list of symbols that the shared library will export. +(This appears to be relevant only on Windows.)

    +

    debug is as for compile() and create_static_lib(), with the +slight distinction that it actually matters on most platforms (as opposed to +create_static_lib(), which includes a debug flag mostly for form’s +sake).

    +

    extra_preargs and extra_postargs are as for compile() (except of +course that they supply command-line arguments for the particular linker being +used).

    +

    target_lang is the target language for which the given objects are being +compiled. This allows specific linkage time treatment of certain languages.

    +

    Raises LinkError on failure.

    +
    + +
    + +

    Link an executable. output_progname is the name of the file executable, while +objects are a list of object filenames to link in. Other arguments are as for +the link() method.

    +
    + +
    + +

    Link a shared library. output_libname is the name of the output library, +while objects is a list of object filenames to link in. Other arguments are +as for the link() method.

    +
    + +
    + +

    Link a shared object. output_filename is the name of the shared object that +will be created, while objects is a list of object filenames to link in. +Other arguments are as for the link() method.

    +
    + +
    +
    +preprocess(source[, output_file=None, macros=None, include_dirs=None, extra_preargs=None, extra_postargs=None])
    +

    Preprocess a single C/C++ source file, named in source. Output will be written +to file named output_file, or stdout if output_file not supplied. +macros is a list of macro definitions as for compile(), which will +augment the macros set with define_macro() and undefine_macro(). +include_dirs is a list of directory names that will be added to the default +list, in the same way as add_include_dir().

    +

    Raises PreprocessError on failure.

    +
    + +

    The following utility methods are defined by the CCompiler class, for +use by the various concrete subclasses.

    +
    +
    +executable_filename(basename[, strip_dir=0, output_dir=''])
    +

    Returns the filename of the executable for the given basename. Typically for +non-Windows platforms this is the same as the basename, while Windows will get +a .exe added.

    +
    + +
    +
    +library_filename(libname[, lib_type='static', strip_dir=0, output_dir=''])
    +

    Returns the filename for the given library name on the current platform. On Unix +a library with lib_type of 'static' will typically be of the form +liblibname.a, while a lib_type of 'dynamic' will be of the form +liblibname.so.

    +
    + +
    +
    +object_filenames(source_filenames[, strip_dir=0, output_dir=''])
    +

    Returns the name of the object files for the given source files. +source_filenames should be a list of filenames.

    +
    + +
    +
    +shared_object_filename(basename[, strip_dir=0, output_dir=''])
    +

    Returns the name of a shared object file for the given file name basename.

    +
    + +
    +
    +execute(func, args[, msg=None, level=1])
    +

    Invokes distutils.util.execute(). This method invokes a Python function +func with the given arguments args, after logging and taking into account +the dry_run flag.

    +
    + +
    +
    +spawn(cmd)
    +

    Invokes distutils.util.spawn(). This invokes an external process to run +the given command.

    +
    + +
    +
    +mkpath(name[, mode=511])
    +

    Invokes distutils.dir_util.mkpath(). This creates a directory and any +missing ancestor directories.

    +
    + +
    +
    +move_file(src, dst)
    +

    Invokes distutils.file_util.move_file(). Renames src to dst.

    +
    + +
    +
    +announce(msg[, level=1])
    +

    Write a message using distutils.log.debug().

    +
    + +
    +
    +warn(msg)
    +

    Write a warning message msg to standard error.

    +
    + +
    +
    +debug_print(msg)
    +

    If the debug flag is set on this CCompiler instance, print msg to +standard output, otherwise do nothing.

    +
    + +
    + +
    +
    +

    9.3. distutils.unixccompiler — Unix C Compiler

    +

    This module provides the UnixCCompiler class, a subclass of +CCompiler that handles the typical Unix-style command-line C compiler:

    +
      +
    • macros defined with -Dname[=value]

    • +
    • macros undefined with -Uname

    • +
    • include search directories specified with -Idir

    • +
    • libraries specified with -llib

    • +
    • library search directories specified with -Ldir

    • +
    • compile handled by cc (or similar) executable with -c +option: compiles .c to .o

    • +
    • link static library handled by ar command (possibly with +ranlib)

    • +
    • link shared library handled by cc -shared

    • +
    +
    +
    +

    9.4. distutils.msvccompiler — Microsoft Compiler

    +

    This module provides MSVCCompiler, an implementation of the abstract +CCompiler class for Microsoft Visual Studio. Typically, extension +modules need to be compiled with the same compiler that was used to compile +Python. For Python 2.3 and earlier, the compiler was Visual Studio 6. For Python +2.4 and 2.5, the compiler is Visual Studio .NET 2003.

    +

    MSVCCompiler will normally choose the right compiler, linker etc. on +its own. To override this choice, the environment variables DISTUTILS_USE_SDK +and MSSdk must be both set. MSSdk indicates that the current environment has +been setup by the SDK’s SetEnv.Cmd script, or that the environment variables +had been registered when the SDK was installed; DISTUTILS_USE_SDK indicates +that the distutils user has made an explicit choice to override the compiler +selection by MSVCCompiler.

    +
    +
    +

    9.5. distutils.bcppcompiler — Borland Compiler

    +

    This module provides BorlandCCompiler, a subclass of the abstract +CCompiler class for the Borland C++ compiler.

    +
    +
    +

    9.6. distutils.cygwincompiler — Cygwin Compiler

    +

    This module provides the CygwinCCompiler class, a subclass of +UnixCCompiler that handles the Cygwin port of the GNU C compiler to +Windows. It also contains the Mingw32CCompiler class which handles the mingw32 +port of GCC (same as cygwin in no-cygwin mode).

    +
    +
    +

    9.7. distutils.archive_util — Archiving utilities

    +

    This module provides a few functions for creating archive files, such as +tarballs or zipfiles.

    +
    +
    +distutils.archive_util.make_archive(base_name, format[, root_dir=None, base_dir=None, verbose=0, dry_run=0])
    +

    Create an archive file (eg. zip or tar). base_name is the name of +the file to create, minus any format-specific extension; format is the +archive format: one of zip, tar, gztar, bztar, xztar, or +ztar. root_dir is a directory that will be the root directory of the +archive; ie. we typically chdir into root_dir before creating the +archive. base_dir is the directory where we start archiving from; ie. +base_dir will be the common prefix of all files and directories in the +archive. root_dir and base_dir both default to the current directory. +Returns the name of the archive file.

    +
    +

    Changed in version 3.5: Added support for the xztar format.

    +
    +
    + +
    +
    +distutils.archive_util.make_tarball(base_name, base_dir[, compress='gzip', verbose=0, dry_run=0])
    +

    ‘Create an (optional compressed) archive as a tar file from all files in and +under base_dir. compress must be 'gzip' (the default), +'bzip2', 'xz', 'compress', or None. For the 'compress' +method the compression utility named by compress must be on the +default program search path, so this is probably Unix-specific. The output +tar file will be named base_dir.tar, possibly plus the appropriate +compression extension (.gz, .bz2, .xz or .Z). Return the +output filename.

    +
    +

    Changed in version 3.5: Added support for the xz compression.

    +
    +
    + +
    +
    +distutils.archive_util.make_zipfile(base_name, base_dir[, verbose=0, dry_run=0])
    +

    Create a zip file from all files in and under base_dir. The output zip file +will be named base_name + .zip. Uses either the zipfile Python +module (if available) or the InfoZIP zip utility (if installed and +found on the default search path). If neither tool is available, raises +DistutilsExecError. Returns the name of the output zip file.

    +
    + +
    +
    +

    9.8. distutils.dep_util — Dependency checking

    +

    This module provides functions for performing simple, timestamp-based +dependency of files and groups of files; also, functions based entirely on such +timestamp dependency analysis.

    +
    +
    +distutils.dep_util.newer(source, target)
    +

    Return true if source exists and is more recently modified than target, or +if source exists and target doesn’t. Return false if both exist and target +is the same age or newer than source. Raise DistutilsFileError if +source does not exist.

    +
    + +
    +
    +distutils.dep_util.newer_pairwise(sources, targets)
    +

    Walk two filename lists in parallel, testing if each source is newer than its +corresponding target. Return a pair of lists (sources, targets) where +source is newer than target, according to the semantics of newer().

    +
    + +
    +
    +distutils.dep_util.newer_group(sources, target[, missing='error'])
    +

    Return true if target is out-of-date with respect to any file listed in +sources. In other words, if target exists and is newer than every file in +sources, return false; otherwise return true. missing controls what we do +when a source file is missing; the default ('error') is to blow up with an +OSError from inside os.stat(); if it is 'ignore', we silently +drop any missing source files; if it is 'newer', any missing source files +make us assume that target is out-of-date (this is handy in “dry-run” mode: +it’ll make you pretend to carry out commands that wouldn’t work because inputs +are missing, but that doesn’t matter because you’re not actually going to run +the commands).

    +
    + +
    +
    +

    9.9. distutils.dir_util — Directory tree operations

    +

    This module provides functions for operating on directories and trees of +directories.

    +
    +
    +distutils.dir_util.mkpath(name[, mode=0o777, verbose=0, dry_run=0])
    +

    Create a directory and any missing ancestor directories. If the directory +already exists (or if name is the empty string, which means the current +directory, which of course exists), then do nothing. Raise +DistutilsFileError if unable to create some directory along the way (eg. +some sub-path exists, but is a file rather than a directory). If verbose is +true, print a one-line summary of each mkdir to stdout. Return the list of +directories actually created.

    +
    + +
    +
    +distutils.dir_util.create_tree(base_dir, files[, mode=0o777, verbose=0, dry_run=0])
    +

    Create all the empty directories under base_dir needed to put files there. +base_dir is just the name of a directory which doesn’t necessarily exist +yet; files is a list of filenames to be interpreted relative to base_dir. +base_dir + the directory portion of every file in files will be created if +it doesn’t already exist. mode, verbose and dry_run flags are as for +mkpath().

    +
    + +
    +
    +distutils.dir_util.copy_tree(src, dst[, preserve_mode=1, preserve_times=1, preserve_symlinks=0, update=0, verbose=0, dry_run=0])
    +

    Copy an entire directory tree src to a new location dst. Both src and +dst must be directory names. If src is not a directory, raise +DistutilsFileError. If dst does not exist, it is created with +mkpath(). The end result of the copy is that every file in src is +copied to dst, and directories under src are recursively copied to dst. +Return the list of files that were copied or might have been copied, using their +output name. The return value is unaffected by update or dry_run: it is +simply the list of all files under src, with the names changed to be under +dst.

    +

    preserve_mode and preserve_times are the same as for +distutils.file_util.copy_file(); note that they only apply to +regular files, not to +directories. If preserve_symlinks is true, symlinks will be copied as +symlinks (on platforms that support them!); otherwise (the default), the +destination of the symlink will be copied. update and verbose are the same +as for copy_file().

    +

    Files in src that begin with .nfs are skipped (more information on +these files is available in answer D2 of the NFS FAQ page).

    +
    +

    Changed in version 3.3.1: NFS files are ignored.

    +
    +
    + +
    +
    +distutils.dir_util.remove_tree(directory[, verbose=0, dry_run=0])
    +

    Recursively remove directory and all files and directories underneath it. Any +errors are ignored (apart from being reported to sys.stdout if verbose is +true).

    +
    + +
    +
    +

    9.10. distutils.file_util — Single file operations

    +

    This module contains some utility functions for operating on individual files.

    +
    +
    +distutils.file_util.copy_file(src, dst[, preserve_mode=1, preserve_times=1, update=0, link=None, verbose=0, dry_run=0])
    +

    Copy file src to dst. If dst is a directory, then src is copied there +with the same name; otherwise, it must be a filename. (If the file exists, it +will be ruthlessly clobbered.) If preserve_mode is true (the default), the +file’s mode (type and permission bits, or whatever is analogous on the +current platform) is copied. If preserve_times is true (the default), the +last-modified and last-access times are copied as well. If update is true, +src will only be copied if dst does not exist, or if dst does exist but +is older than src.

    +

    link allows you to make hard links (using os.link()) or symbolic links +(using os.symlink()) instead of copying: set it to 'hard' or +'sym'; if it is None (the default), files are copied. Don’t set link +on systems that don’t support it: copy_file() doesn’t check if hard or +symbolic linking is available. It uses _copy_file_contents() to copy file +contents.

    +

    Return a tuple (dest_name, copied): dest_name is the actual name of the +output file, and copied is true if the file was copied (or would have been +copied, if dry_run true).

    +
    + +
    +
    +distutils.file_util.move_file(src, dst[, verbose, dry_run])
    +

    Move file src to dst. If dst is a directory, the file will be moved into +it with the same name; otherwise, src is just renamed to dst. Returns the +new full name of the file.

    +
    +

    Warning

    +

    Handles cross-device moves on Unix using copy_file(). What about +other systems?

    +
    +
    + +
    +
    +distutils.file_util.write_file(filename, contents)
    +

    Create a file called filename and write contents (a sequence of strings +without line terminators) to it.

    +
    + +
    +
    +

    9.11. distutils.util — Miscellaneous other utility functions

    +

    This module contains other assorted bits and pieces that don’t fit into any +other utility module.

    +
    +
    +distutils.util.get_platform()
    +

    Return a string that identifies the current platform. This is used mainly to +distinguish platform-specific build directories and platform-specific built +distributions. Typically includes the OS name and version and the +architecture (as supplied by ‘os.uname()’), although the exact information +included depends on the OS; e.g., on Linux, the kernel version isn’t +particularly important.

    +

    Examples of returned values:

    +
      +
    • linux-i586

    • +
    • linux-alpha

    • +
    • solaris-2.6-sun4u

    • +
    +

    For non-POSIX platforms, currently just returns sys.platform.

    +

    For Mac OS X systems the OS version reflects the minimal version on which +binaries will run (that is, the value of MACOSX_DEPLOYMENT_TARGET +during the build of Python), not the OS version of the current system.

    +

    For universal binary builds on Mac OS X the architecture value reflects +the universal binary status instead of the architecture of the current +processor. For 32-bit universal binaries the architecture is fat, +for 64-bit universal binaries the architecture is fat64, and +for 4-way universal binaries the architecture is universal. Starting +from Python 2.7 and Python 3.2 the architecture fat3 is used for +a 3-way universal build (ppc, i386, x86_64) and intel is used for +a universal build with the i386 and x86_64 architectures

    +

    Examples of returned values on Mac OS X:

    +
      +
    • macosx-10.3-ppc

    • +
    • macosx-10.3-fat

    • +
    • macosx-10.5-universal

    • +
    • macosx-10.6-intel

    • +
    +
    + +
    +
    +distutils.util.convert_path(pathname)
    +

    Return ‘pathname’ as a name that will work on the native filesystem, i.e. split +it on ‘/’ and put it back together again using the current directory separator. +Needed because filenames in the setup script are always supplied in Unix style, +and have to be converted to the local convention before we can actually use them +in the filesystem. Raises ValueError on non-Unix-ish systems if +pathname either starts or ends with a slash.

    +
    + +
    +
    +distutils.util.change_root(new_root, pathname)
    +

    Return pathname with new_root prepended. If pathname is relative, this is +equivalent to os.path.join(new_root,pathname) Otherwise, it requires making +pathname relative and then joining the two, which is tricky on DOS/Windows.

    +
    + +
    +
    +distutils.util.check_environ()
    +

    Ensure that ‘os.environ’ has all the environment variables we guarantee that +users can use in config files, command-line options, etc. Currently this +includes:

    +
      +
    • HOME - user’s home directory (Unix only)

    • +
    • PLAT - description of the current platform, including hardware and +OS (see get_platform())

    • +
    +
    + +
    +
    +distutils.util.subst_vars(s, local_vars)
    +

    Perform shell/Perl-style variable substitution on s. Every occurrence of +$ followed by a name is considered a variable, and variable is substituted +by the value found in the local_vars dictionary, or in os.environ if it’s +not in local_vars. os.environ is first checked/augmented to guarantee that +it contains certain values: see check_environ(). Raise ValueError +for any variables not found in either local_vars or os.environ.

    +

    Note that this is not a fully-fledged string interpolation function. A valid +$variable can consist only of upper and lower case letters, numbers and an +underscore. No { } or ( ) style quoting is available.

    +
    + +
    +
    +distutils.util.split_quoted(s)
    +

    Split a string up according to Unix shell-like rules for quotes and backslashes. +In short: words are delimited by spaces, as long as those spaces are not escaped +by a backslash, or inside a quoted string. Single and double quotes are +equivalent, and the quote characters can be backslash-escaped. The backslash is +stripped from any two-character escape sequence, leaving only the escaped +character. The quote characters are stripped from any quoted string. Returns a +list of words.

    +
    + +
    +
    +distutils.util.execute(func, args[, msg=None, verbose=0, dry_run=0])
    +

    Perform some action that affects the outside world (for instance, writing to the +filesystem). Such actions are special because they are disabled by the +dry_run flag. This method takes care of all that bureaucracy for you; all +you have to do is supply the function to call and an argument tuple for it (to +embody the “external action” being performed), and an optional message to print.

    +
    + +
    +
    +distutils.util.strtobool(val)
    +

    Convert a string representation of truth to true (1) or false (0).

    +

    True values are y, yes, t, true, on and 1; false values +are n, no, f, false, off and 0. Raises +ValueError if val is anything else.

    +
    + +
    +
    +distutils.util.byte_compile(py_files[, optimize=0, force=0, prefix=None, base_dir=None, verbose=1, dry_run=0, direct=None])
    +

    Byte-compile a collection of Python source files to .pyc files in a +__pycache__ subdirectory (see PEP 3147 and PEP 488). +py_files is a list of files to compile; any files that don’t end in +.py are silently skipped. optimize must be one of the following:

    +
      +
    • 0 - don’t optimize

    • +
    • 1 - normal optimization (like python -O)

    • +
    • 2 - extra optimization (like python -OO)

    • +
    +

    If force is true, all files are recompiled regardless of timestamps.

    +

    The source filename encoded in each bytecode file defaults to the filenames +listed in py_files; you can modify these with prefix and basedir. +prefix is a string that will be stripped off of each source filename, and +base_dir is a directory name that will be prepended (after prefix is +stripped). You can supply either or both (or neither) of prefix and +base_dir, as you wish.

    +

    If dry_run is true, doesn’t actually do anything that would affect the +filesystem.

    +

    Byte-compilation is either done directly in this interpreter process with the +standard py_compile module, or indirectly by writing a temporary script +and executing it. Normally, you should let byte_compile() figure out to +use direct compilation or not (see the source for details). The direct flag +is used by the script generated in indirect mode; unless you know what you’re +doing, leave it set to None.

    +
    +

    Changed in version 3.2.3: Create .pyc files with an import magic tag in their name, in a __pycache__ subdirectory +instead of files without tag in the current directory.

    +
    +
    +

    Changed in version 3.5: Create .pyc files according to PEP 488.

    +
    +
    + +
    +
    +distutils.util.rfc822_escape(header)
    +

    Return a version of header escaped for inclusion in an RFC 822 header, by +ensuring there are 8 spaces space after each newline. Note that it does no other +modification of the string.

    +
    + +
    +
    +

    9.12. distutils.dist — The Distribution class

    +

    This module provides the Distribution class, which +represents the module distribution being built/installed/distributed.

    +
    +
    +

    9.13. distutils.extension — The Extension class

    +

    This module provides the Extension class, used to describe C/C++ +extension modules in setup scripts.

    +
    +
    +

    9.14. distutils.debug — Distutils debug mode

    +

    This module provides the DEBUG flag.

    +
    +
    +

    9.15. distutils.errors — Distutils exceptions

    +

    Provides exceptions used by the Distutils modules. Note that Distutils modules +may raise standard exceptions; in particular, SystemExit is usually raised for +errors that are obviously the end-user’s fault (eg. bad command-line arguments).

    +

    This module is safe to use in from ... import * mode; it only exports +symbols whose names start with Distutils and end with Error.

    +
    +
    +

    9.16. distutils.fancy_getopt — Wrapper around the standard getopt module

    +

    This module provides a wrapper around the standard getopt module that +provides the following additional features:

    +
      +
    • short and long options are tied together

    • +
    • options have help strings, so fancy_getopt() could potentially create a +complete usage summary

    • +
    • options set attributes of a passed-in object

    • +
    • boolean options can have “negative aliases” — eg. if --quiet is +the “negative alias” of --verbose, then --quiet on the +command line sets verbose to false.

    • +
    +
    +
    +distutils.fancy_getopt.fancy_getopt(options, negative_opt, object, args)
    +

    Wrapper function. options is a list of (long_option, short_option, +help_string) 3-tuples as described in the constructor for +FancyGetopt. negative_opt should be a dictionary mapping option names +to option names, both the key and value should be in the options list. +object is an object which will be used to store values (see the getopt() +method of the FancyGetopt class). args is the argument list. Will use +sys.argv[1:] if you pass None as args.

    +
    + +
    +
    +distutils.fancy_getopt.wrap_text(text, width)
    +

    Wraps text to less than width wide.

    +
    + +
    +
    +class distutils.fancy_getopt.FancyGetopt([option_table=None])
    +

    The option_table is a list of 3-tuples: (long_option, short_option, +help_string)

    +

    If an option takes an argument, its long_option should have '=' appended; +short_option should just be a single character, no ':' in any case. +short_option should be None if a long_option doesn’t have a +corresponding short_option. All option tuples must have long options.

    +
    + +

    The FancyGetopt class provides the following methods:

    +
    +
    +FancyGetopt.getopt([args=None, object=None])
    +

    Parse command-line options in args. Store as attributes on object.

    +

    If args is None or not supplied, uses sys.argv[1:]. If object is +None or not supplied, creates a new OptionDummy instance, stores +option values there, and returns a tuple (args, object). If object is +supplied, it is modified in place and getopt() just returns args; in +both cases, the returned args is a modified copy of the passed-in args list, +which is left untouched.

    +
    + +
    +
    +FancyGetopt.get_option_order()
    +

    Returns the list of (option, value) tuples processed by the previous run of +getopt() Raises RuntimeError if getopt() hasn’t been called +yet.

    +
    + +
    +
    +FancyGetopt.generate_help([header=None])
    +

    Generate help text (a list of strings, one per suggested line of output) from +the option table for this FancyGetopt object.

    +

    If supplied, prints the supplied header at the top of the help.

    +
    + +
    +
    +

    9.17. distutils.filelist — The FileList class

    +

    This module provides the FileList class, used for poking about the +filesystem and building lists of files.

    +
    +
    +

    9.18. distutils.log — Simple PEP 282-style logging

    +
    +
    +

    9.19. distutils.spawn — Spawn a sub-process

    +

    This module provides the spawn() function, a front-end to various +platform-specific functions for launching another program in a sub-process. +Also provides find_executable() to search the path for a given executable +name.

    +
    +
    +

    9.20. distutils.sysconfig — System configuration information

    +

    The distutils.sysconfig module provides access to Python’s low-level +configuration information. The specific configuration variables available +depend heavily on the platform and configuration. The specific variables depend +on the build process for the specific version of Python being run; the variables +are those found in the Makefile and configuration header that are +installed with Python on Unix systems. The configuration header is called +pyconfig.h for Python versions starting with 2.2, and config.h +for earlier versions of Python.

    +

    Some additional functions are provided which perform some useful manipulations +for other parts of the distutils package.

    +
    +
    +distutils.sysconfig.PREFIX
    +

    The result of os.path.normpath(sys.prefix).

    +
    + +
    +
    +distutils.sysconfig.EXEC_PREFIX
    +

    The result of os.path.normpath(sys.exec_prefix).

    +
    + +
    +
    +distutils.sysconfig.get_config_var(name)
    +

    Return the value of a single variable. This is equivalent to +get_config_vars().get(name).

    +
    + +
    +
    +distutils.sysconfig.get_config_vars(...)
    +

    Return a set of variable definitions. If there are no arguments, this returns a +dictionary mapping names of configuration variables to values. If arguments are +provided, they should be strings, and the return value will be a sequence giving +the associated values. If a given name does not have a corresponding value, +None will be included for that variable.

    +
    + +
    +
    +distutils.sysconfig.get_config_h_filename()
    +

    Return the full path name of the configuration header. For Unix, this will be +the header generated by the configure script; for other platforms the +header will have been supplied directly by the Python source distribution. The +file is a platform-specific text file.

    +
    + +
    +
    +distutils.sysconfig.get_makefile_filename()
    +

    Return the full path name of the Makefile used to build Python. For +Unix, this will be a file generated by the configure script; the +meaning for other platforms will vary. The file is a platform-specific text +file, if it exists. This function is only useful on POSIX platforms.

    +
    + +
    +
    +distutils.sysconfig.get_python_inc([plat_specific[, prefix]])
    +

    Return the directory for either the general or platform-dependent C include +files. If plat_specific is true, the platform-dependent include directory is +returned; if false or omitted, the platform-independent directory is returned. +If prefix is given, it is used as either the prefix instead of +PREFIX, or as the exec-prefix instead of EXEC_PREFIX if +plat_specific is true.

    +
    + +
    +
    +distutils.sysconfig.get_python_lib([plat_specific[, standard_lib[, prefix]]])
    +

    Return the directory for either the general or platform-dependent library +installation. If plat_specific is true, the platform-dependent include +directory is returned; if false or omitted, the platform-independent directory +is returned. If prefix is given, it is used as either the prefix instead of +PREFIX, or as the exec-prefix instead of EXEC_PREFIX if +plat_specific is true. If standard_lib is true, the directory for the +standard library is returned rather than the directory for the installation of +third-party extensions.

    +
    + +

    The following function is only intended for use within the distutils +package.

    +
    +
    +distutils.sysconfig.customize_compiler(compiler)
    +

    Do any platform-specific customization of a +distutils.ccompiler.CCompiler instance.

    +

    This function is only needed on Unix at this time, but should be called +consistently to support forward-compatibility. It inserts the information that +varies across Unix flavors and is stored in Python’s Makefile. This +information includes the selected compiler, compiler and linker options, and the +extension used by the linker for shared objects.

    +
    + +

    This function is even more special-purpose, and should only be used from +Python’s own build procedures.

    +
    +
    +distutils.sysconfig.set_python_build()
    +

    Inform the distutils.sysconfig module that it is being used as part of +the build process for Python. This changes a lot of relative locations for +files, allowing them to be located in the build area rather than in an installed +Python.

    +
    + +
    +
    +

    9.21. distutils.text_file — The TextFile class

    +

    This module provides the TextFile class, which gives an interface to +text files that (optionally) takes care of stripping comments, ignoring blank +lines, and joining lines with backslashes.

    +
    +
    +class distutils.text_file.TextFile([filename=None, file=None, **options])
    +

    This class provides a file-like object that takes care of all the things you +commonly want to do when processing a text file that has some line-by-line +syntax: strip comments (as long as # is your comment character), skip blank +lines, join adjacent lines by escaping the newline (ie. backslash at end of +line), strip leading and/or trailing whitespace. All of these are optional and +independently controllable.

    +

    The class provides a warn() method so you can generate warning messages +that report physical line number, even if the logical line in question spans +multiple physical lines. Also provides unreadline() for implementing +line-at-a-time lookahead.

    +

    TextFile instances are create with either filename, file, or both. +RuntimeError is raised if both are None. filename should be a +string, and file a file object (or something that provides readline() +and close() methods). It is recommended that you supply at least +filename, so that TextFile can include it in warning messages. If +file is not supplied, TextFile creates its own using the +open() built-in function.

    +

    The options are all boolean, and affect the values returned by readline()

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    option name

    description

    default

    strip_comments

    strip from '#' to +end-of-line, as well as any +whitespace leading up to the +'#'—unless it is +escaped by a backslash

    true

    lstrip_ws

    strip leading whitespace from +each line before returning it

    false

    rstrip_ws

    strip trailing whitespace +(including line terminator!) +from each line before +returning it.

    true

    skip_blanks

    skip lines that are empty +*after* stripping comments +and whitespace. (If both +lstrip_ws and rstrip_ws are +false, then some lines may +consist of solely whitespace: +these will *not* be skipped, +even if skip_blanks is +true.)

    true

    join_lines

    if a backslash is the last +non-newline character on a +line after stripping comments +and whitespace, join the +following line to it to form +one logical line; if N +consecutive lines end with a +backslash, then N+1 physical +lines will be joined to form +one logical line.

    false

    collapse_join

    strip leading whitespace from +lines that are joined to their +predecessor; only matters if +(join_lines and not +lstrip_ws)

    false

    +

    Note that since rstrip_ws can strip the trailing newline, the semantics of +readline() must differ from those of the built-in file object’s +readline() method! In particular, readline() returns None for +end-of-file: an empty string might just be a blank line (or an all-whitespace +line), if rstrip_ws is true but skip_blanks is not.

    +
    +
    +open(filename)
    +

    Open a new file filename. This overrides any file or filename +constructor arguments.

    +
    + +
    +
    +close()
    +

    Close the current file and forget everything we know about it (including the +filename and the current line number).

    +
    + +
    +
    +warn(msg[, line=None])
    +

    Print (to stderr) a warning message tied to the current logical line in the +current file. If the current logical line in the file spans multiple physical +lines, the warning refers to the whole range, such as "lines 3-5". If +line is supplied, it overrides the current line number; it may be a list or +tuple to indicate a range of physical lines, or an integer for a single +physical line.

    +
    + +
    +
    +readline()
    +

    Read and return a single logical line from the current file (or from an internal +buffer if lines have previously been “unread” with unreadline()). If the +join_lines option is true, this may involve reading multiple physical lines +concatenated into a single string. Updates the current line number, so calling +warn() after readline() emits a warning about the physical line(s) +just read. Returns None on end-of-file, since the empty string can occur +if rstrip_ws is true but strip_blanks is not.

    +
    + +
    +
    +readlines()
    +

    Read and return the list of all logical lines remaining in the current file. +This updates the current line number to the last line of the file.

    +
    + +
    +
    +unreadline(line)
    +

    Push line (a string) onto an internal buffer that will be checked by future +readline() calls. Handy for implementing a parser with line-at-a-time +lookahead. Note that lines that are “unread” with unreadline() are not +subsequently re-cleansed (whitespace stripped, or whatever) when read with +readline(). If multiple calls are made to unreadline() before a call +to readline(), the lines will be returned most in most recent first order.

    +
    + +
    + +
    +
    +

    9.22. distutils.version — Version number classes

    +
    +
    +

    9.23. distutils.cmd — Abstract base class for Distutils commands

    +

    This module supplies the abstract base class Command.

    +
    +
    +class distutils.cmd.Command(dist)
    +

    Abstract base class for defining command classes, the “worker bees” of the +Distutils. A useful analogy for command classes is to think of them as +subroutines with local variables called options. The options are declared +in initialize_options() and defined (given their final values) in +finalize_options(), both of which must be defined by every command +class. The distinction between the two is necessary because option values +might come from the outside world (command line, config file, …), and any +options dependent on other options must be computed after these outside +influences have been processed — hence finalize_options(). The body +of the subroutine, where it does all its work based on the values of its +options, is the run() method, which must also be implemented by every +command class.

    +

    The class constructor takes a single argument dist, a +Distribution instance.

    +
    + +
    +
    +

    9.24. Creating a new Distutils command

    +

    This section outlines the steps to create a new Distutils command.

    +

    A new command lives in a module in the distutils.command package. There +is a sample template in that directory called command_template. Copy +this file to a new module with the same name as the new command you’re +implementing. This module should implement a class with the same name as the +module (and the command). So, for instance, to create the command +peel_banana (so that users can run setup.py peel_banana), you’d copy +command_template to distutils/command/peel_banana.py, then edit +it so that it’s implementing the class peel_banana, a subclass of +distutils.cmd.Command.

    +

    Subclasses of Command must define the following methods.

    +
    +
    +Command.initialize_options()
    +

    Set default values for all the options that this command supports. Note that +these defaults may be overridden by other commands, by the setup script, by +config files, or by the command-line. Thus, this is not the place to code +dependencies between options; generally, initialize_options() +implementations are just a bunch of self.foo = None assignments.

    +
    + +
    +
    +Command.finalize_options()
    +

    Set final values for all the options that this command supports. This is +always called as late as possible, ie. after any option assignments from the +command-line or from other commands have been done. Thus, this is the place +to code option dependencies: if foo depends on bar, then it is safe to +set foo from bar as long as foo still has the same value it was +assigned in initialize_options().

    +
    + +
    +
    +Command.run()
    +

    A command’s raison d’etre: carry out the action it exists to perform, controlled +by the options initialized in initialize_options(), customized by other +commands, the setup script, the command-line, and config files, and finalized in +finalize_options(). All terminal output and filesystem interaction should +be done by run().

    +
    + +
    +
    +Command.sub_commands
    +

    sub_commands formalizes the notion of a “family” of commands, +e.g. install as the parent with sub-commands install_lib, +install_headers, etc. The parent of a family of commands defines +sub_commands as a class attribute; it’s a list of 2-tuples (command_name, +predicate), with command_name a string and predicate a function, a +string or None. predicate is a method of the parent command that +determines whether the corresponding command is applicable in the current +situation. (E.g. install_headers is only applicable if we have any C +header files to install.) If predicate is None, that command is always +applicable.

    +

    sub_commands is usually defined at the end of a class, because +predicates can be methods of the class, so they must already have been +defined. The canonical example is the install command.

    +
    + +
    +
    +

    9.25. distutils.command — Individual Distutils commands

    +
    +
    +

    9.26. distutils.command.bdist — Build a binary installer

    +
    +
    +

    9.27. distutils.command.bdist_packager — Abstract base class for packagers

    +
    +
    +

    9.28. distutils.command.bdist_dumb — Build a “dumb” installer

    +
    +
    +

    9.29. distutils.command.bdist_msi — Build a Microsoft Installer binary package

    +
    +
    +class distutils.command.bdist_msi.bdist_msi
    +

    Builds a Windows Installer (.msi) binary package.

    +

    In most cases, the bdist_msi installer is a better choice than the +bdist_wininst installer, because it provides better support for +Win64 platforms, allows administrators to perform non-interactive +installations, and allows installation through group policies.

    +
    + +
    +
    +

    9.30. distutils.command.bdist_rpm — Build a binary distribution as a Redhat RPM and SRPM

    +
    +
    +

    9.31. distutils.command.bdist_wininst — Build a Windows installer

    +
    +
    +

    9.32. distutils.command.sdist — Build a source distribution

    +
    +
    +

    9.33. distutils.command.build — Build all files of a package

    +
    +
    +

    9.34. distutils.command.build_clib — Build any C libraries in a package

    +
    +
    +

    9.35. distutils.command.build_ext — Build any extensions in a package

    +
    +
    +

    9.36. distutils.command.build_py — Build the .py/.pyc files of a package

    +
    +
    +class distutils.command.build_py.build_py
    +
    + +
    +
    +class distutils.command.build_py.build_py_2to3
    +

    Alternative implementation of build_py which also runs the +2to3 conversion library on each .py file that is going to be +installed. To use this in a setup.py file for a distribution +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
    +except ImportError:
    +    from distutils.command.build_py import build_py
    +
    +
    +

    to your setup.py, and later:

    +
    cmdclass = {'build_py': build_py}
    +
    +
    +

    to the invocation of setup().

    +
    + +
    +
    +

    9.37. distutils.command.build_scripts — Build the scripts of a package

    +
    +
    +

    9.38. distutils.command.clean — Clean a package build area

    +

    This command removes the temporary files created by build +and its subcommands, like intermediary compiled object files. With +the --all option, the complete build directory will be removed.

    +

    Extension modules built in place +will not be cleaned, as they are not in the build directory.

    +
    +
    +

    9.39. distutils.command.config — Perform package configuration

    +
    +
    +

    9.40. distutils.command.install — Install a package

    +
    +
    +

    9.41. distutils.command.install_data — Install data files from a package

    +
    +
    +

    9.42. distutils.command.install_headers — Install C/C++ header files from a package

    +
    +
    +

    9.43. distutils.command.install_lib — Install library files from a package

    +
    +
    +

    9.44. distutils.command.install_scripts — Install script files from a package

    +
    +
    +

    9.45. distutils.command.register — Register a module with the Python Package Index

    +

    The register command registers the package with the Python Package Index. +This is described in more detail in PEP 301.

    +
    +
    +

    9.46. distutils.command.check — Check the meta-data of a package

    +

    The check command performs some tests on the meta-data of a package. +For example, it verifies that all required meta-data are provided as +the arguments passed to the setup() function.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/distutils/builtdist.html b/python-3.7.4-docs-html/distutils/builtdist.html new file mode 100644 index 0000000..b51f11d --- /dev/null +++ b/python-3.7.4-docs-html/distutils/builtdist.html @@ -0,0 +1,667 @@ + + + + + + + 5. Creating Built Distributions — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    5. Creating Built Distributions

    +

    A “built distribution” is what you’re probably used to thinking of either as a +“binary package” or an “installer” (depending on your background). It’s not +necessarily binary, though, because it might contain only Python source code +and/or byte-code; and we don’t call it a package, because that word is already +spoken for in Python. (And “installer” is a term specific to the world of +mainstream desktop systems.)

    +

    A built distribution is how you make life as easy as possible for installers of +your module distribution: for users of RPM-based Linux systems, it’s a binary +RPM; for Windows users, it’s an executable installer; for Debian-based Linux +users, it’s a Debian package; and so forth. Obviously, no one person will be +able to create built distributions for every platform under the sun, so the +Distutils are designed to enable module developers to concentrate on their +specialty—writing code and creating source distributions—while an +intermediary species called packagers springs up to turn source distributions +into built distributions for as many platforms as there are packagers.

    +

    Of course, the module developer could be their own packager; or the packager could +be a volunteer “out there” somewhere who has access to a platform which the +original developer does not; or it could be software periodically grabbing new +source distributions and turning them into built distributions for as many +platforms as the software has access to. Regardless of who they are, a packager +uses the setup script and the bdist command family to generate built +distributions.

    +

    As a simple example, if I run the following command in the Distutils source +tree:

    +
    python setup.py bdist
    +
    +
    +

    then the Distutils builds my module distribution (the Distutils itself in this +case), does a “fake” installation (also in the build directory), and +creates the default type of built distribution for my platform. The default +format for built distributions is a “dumb” tar file on Unix, and a simple +executable installer on Windows. (That tar file is considered “dumb” because it +has to be unpacked in a specific location to work.)

    +

    Thus, the above command on a Unix system creates +Distutils-1.0.plat.tar.gz; unpacking this tarball from the right place +installs the Distutils just as though you had downloaded the source distribution +and run python setup.py install. (The “right place” is either the root of +the filesystem or Python’s prefix directory, depending on the options +given to the bdist_dumb command; the default is to make dumb +distributions relative to prefix.)

    +

    Obviously, for pure Python distributions, this isn’t any simpler than just +running python setup.py install—but for non-pure distributions, which +include extensions that would need to be compiled, it can mean the difference +between someone being able to use your extensions or not. And creating “smart” +built distributions, such as an RPM package or an executable installer for +Windows, is far more convenient for users even if your distribution doesn’t +include any extensions.

    +

    The bdist command has a --formats option, similar to the +sdist command, which you can use to select the types of built +distribution to generate: for example,

    +
    python setup.py bdist --format=zip
    +
    +
    +

    would, when run on a Unix system, create +Distutils-1.0.plat.zip—again, this archive would be unpacked +from the root directory to install the Distutils.

    +

    The available formats for built distributions are:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Format

    Description

    Notes

    gztar

    gzipped tar file +(.tar.gz)

    (1)

    bztar

    bzipped tar file +(.tar.bz2)

    xztar

    xzipped tar file +(.tar.xz)

    ztar

    compressed tar file +(.tar.Z)

    (3)

    tar

    tar file (.tar)

    zip

    zip file (.zip)

    (2),(4)

    rpm

    RPM

    (5)

    pkgtool

    Solaris pkgtool

    sdux

    HP-UX swinstall

    wininst

    self-extracting ZIP file for +Windows

    (4)

    msi

    Microsoft Installer.

    +
    +

    Changed in version 3.5: Added support for the xztar format.

    +
    +

    Notes:

    +
      +
    1. default on Unix

    2. +
    3. default on Windows

    4. +
    5. requires external compress utility.

    6. +
    7. requires either external zip utility or zipfile module (part +of the standard Python library since Python 1.6)

    8. +
    9. requires external rpm utility, version 3.0.4 or better (use rpm +--version to find out which version you have)

    10. +
    +

    You don’t have to use the bdist command with the --formats +option; you can also use the command that directly implements the format you’re +interested in. Some of these bdist “sub-commands” actually generate +several similar formats; for instance, the bdist_dumb command +generates all the “dumb” archive formats (tar, gztar, bztar, +xztar, ztar, and zip), and bdist_rpm generates both +binary and source RPMs. The bdist sub-commands, and the formats +generated by each, are:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Command

    Formats

    bdist_dumb

    tar, gztar, bztar, xztar, ztar, zip

    bdist_rpm

    rpm, srpm

    bdist_wininst

    wininst

    bdist_msi

    msi

    +

    The following sections give details on the individual bdist_* +commands.

    +
    +

    5.1. Creating RPM packages

    +

    The RPM format is used by many popular Linux distributions, including Red Hat, +SuSE, and Mandrake. If one of these (or any of the other RPM-based Linux +distributions) is your usual environment, creating RPM packages for other users +of that same distribution is trivial. Depending on the complexity of your module +distribution and differences between Linux distributions, you may also be able +to create RPMs that work on different RPM-based distributions.

    +

    The usual way to create an RPM of your module distribution is to run the +bdist_rpm command:

    +
    python setup.py bdist_rpm
    +
    +
    +

    or the bdist command with the --format option:

    +
    python setup.py bdist --formats=rpm
    +
    +
    +

    The former allows you to specify RPM-specific options; the latter allows you to +easily specify multiple formats in one run. If you need to do both, you can +explicitly specify multiple bdist_* commands and their options:

    +
    python setup.py bdist_rpm --packager="John Doe <jdoe@example.org>" \
    +                bdist_wininst --target-version="2.0"
    +
    +
    +

    Creating RPM packages is driven by a .spec file, much as using the +Distutils is driven by the setup script. To make your life easier, the +bdist_rpm command normally creates a .spec file based on the +information you supply in the setup script, on the command line, and in any +Distutils configuration files. Various options and sections in the +.spec file are derived from options in the setup script as follows:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    RPM .spec file option or section

    Distutils setup script option

    Name

    name

    Summary (in preamble)

    description

    Version

    version

    Vendor

    author and author_email, +or — & maintainer and +maintainer_email

    Copyright

    license

    Url

    url

    %description (section)

    long_description

    +

    Additionally, there are many options in .spec files that don’t have +corresponding options in the setup script. Most of these are handled through +options to the bdist_rpm command as follows:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    RPM .spec file option +or section

    bdist_rpm option

    default value

    Release

    release

    “1”

    Group

    group

    “Development/Libraries”

    Vendor

    vendor

    (see above)

    Packager

    packager

    (none)

    Provides

    provides

    (none)

    Requires

    requires

    (none)

    Conflicts

    conflicts

    (none)

    Obsoletes

    obsoletes

    (none)

    Distribution

    distribution_name

    (none)

    BuildRequires

    build_requires

    (none)

    Icon

    icon

    (none)

    +

    Obviously, supplying even a few of these options on the command-line would be +tedious and error-prone, so it’s usually best to put them in the setup +configuration file, setup.cfg—see section Writing the Setup Configuration File. If +you distribute or package many Python module distributions, you might want to +put options that apply to all of them in your personal Distutils configuration +file (~/.pydistutils.cfg). If you want to temporarily disable +this file, you can pass the --no-user-cfg option to setup.py.

    +

    There are three steps to building a binary RPM package, all of which are +handled automatically by the Distutils:

    +
      +
    1. create a .spec file, which describes the package (analogous to the +Distutils setup script; in fact, much of the information in the setup script +winds up in the .spec file)

    2. +
    3. create the source RPM

    4. +
    5. create the “binary” RPM (which may or may not contain binary code, depending +on whether your module distribution contains Python extensions)

    6. +
    +

    Normally, RPM bundles the last two steps together; when you use the Distutils, +all three steps are typically bundled together.

    +

    If you wish, you can separate these three steps. You can use the +--spec-only option to make bdist_rpm just create the +.spec file and exit; in this case, the .spec file will be +written to the “distribution directory”—normally dist/, but +customizable with the --dist-dir option. (Normally, the .spec +file winds up deep in the “build tree,” in a temporary directory created by +bdist_rpm.)

    +
    +
    +

    5.2. Creating Windows Installers

    +

    Executable installers are the natural format for binary distributions on +Windows. They display a nice graphical user interface, display some information +about the module distribution to be installed taken from the metadata in the +setup script, let the user select a few options, and start or cancel the +installation.

    +

    Since the metadata is taken from the setup script, creating Windows installers +is usually as easy as running:

    +
    python setup.py bdist_wininst
    +
    +
    +

    or the bdist command with the --formats option:

    +
    python setup.py bdist --formats=wininst
    +
    +
    +

    If you have a pure module distribution (only containing pure Python modules and +packages), the resulting installer will be version independent and have a name +like foo-1.0.win32.exe. Note that creating wininst binary +distributions in only supported on Windows systems.

    +

    If you have a non-pure distribution, the extensions can only be created on a +Windows platform, and will be Python version dependent. The installer filename +will reflect this and now has the form foo-1.0.win32-py2.0.exe. You +have to create a separate installer for every Python version you want to +support.

    +

    The installer will try to compile pure modules into bytecode after installation +on the target system in normal and optimizing mode. If you don’t want this to +happen for some reason, you can run the bdist_wininst command with +the --no-target-compile and/or the --no-target-optimize +option.

    +

    By default the installer will display the cool “Python Powered” logo when it is +run, but you can also supply your own 152x261 bitmap which must be a Windows +.bmp file with the --bitmap option.

    +

    The installer will also display a large title on the desktop background window +when it is run, which is constructed from the name of your distribution and the +version number. This can be changed to another text by using the +--title option.

    +

    The installer file will be written to the “distribution directory” — normally +dist/, but customizable with the --dist-dir option.

    +
    +
    +

    5.3. Cross-compiling on Windows

    +

    Starting with Python 2.6, distutils is capable of cross-compiling between +Windows platforms. In practice, this means that with the correct tools +installed, you can use a 32bit version of Windows to create 64bit extensions +and vice-versa.

    +

    To build for an alternate platform, specify the --plat-name option +to the build command. Valid values are currently ‘win32’, and ‘win-amd64’. +For example, on a 32bit version of Windows, you could execute:

    +
    python setup.py build --plat-name=win-amd64
    +
    +
    +

    to build a 64bit version of your extension. The Windows Installers also +support this option, so the command:

    +
    python setup.py build --plat-name=win-amd64 bdist_wininst
    +
    +
    +

    would create a 64bit installation executable on your 32bit version of Windows.

    +

    To cross-compile, you must download the Python source code and cross-compile +Python itself for the platform you are targeting - it is not possible from a +binary installation of Python (as the .lib etc file for other platforms are +not included.) In practice, this means the user of a 32 bit operating +system will need to use Visual Studio 2008 to open the +PCbuild/PCbuild.sln solution in the Python source tree and build the +“x64” configuration of the ‘pythoncore’ project before cross-compiling +extensions is possible.

    +

    Note that by default, Visual Studio 2008 does not install 64bit compilers or +tools. You may need to reexecute the Visual Studio setup process and select +these tools (using Control Panel->[Add/Remove] Programs is a convenient way to +check or modify your existing install.)

    +
    +

    5.3.1. The Postinstallation script

    +

    Starting with Python 2.3, a postinstallation script can be specified with the +--install-script option. The basename of the script must be +specified, and the script filename must also be listed in the scripts argument +to the setup function.

    +

    This script will be run at installation time on the target system after all the +files have been copied, with argv[1] set to -install, and again at +uninstallation time before the files are removed with argv[1] set to +-remove.

    +

    The installation script runs embedded in the windows installer, every output +(sys.stdout, sys.stderr) is redirected into a buffer and will be +displayed in the GUI after the script has finished.

    +

    Some functions especially useful in this context are available as additional +built-in functions in the installation script.

    +
    +
    +directory_created(path)
    +
    +file_created(path)
    +

    These functions should be called when a directory or file is created by the +postinstall script at installation time. It will register path with the +uninstaller, so that it will be removed when the distribution is uninstalled. +To be safe, directories are only removed if they are empty.

    +
    + +
    +
    +get_special_folder_path(csidl_string)
    +

    This function can be used to retrieve special folder locations on Windows like +the Start Menu or the Desktop. It returns the full path to the folder. +csidl_string must be one of the following strings:

    +
    "CSIDL_APPDATA"
    +
    +"CSIDL_COMMON_STARTMENU"
    +"CSIDL_STARTMENU"
    +
    +"CSIDL_COMMON_DESKTOPDIRECTORY"
    +"CSIDL_DESKTOPDIRECTORY"
    +
    +"CSIDL_COMMON_STARTUP"
    +"CSIDL_STARTUP"
    +
    +"CSIDL_COMMON_PROGRAMS"
    +"CSIDL_PROGRAMS"
    +
    +"CSIDL_FONTS"
    +
    +
    +

    If the folder cannot be retrieved, OSError is raised.

    +

    Which folders are available depends on the exact Windows version, and probably +also the configuration. For details refer to Microsoft’s documentation of the +SHGetSpecialFolderPath() function.

    +
    + +
    +
    +create_shortcut(target, description, filename[, arguments[, workdir[, iconpath[, iconindex]]]])
    +

    This function creates a shortcut. target is the path to the program to be +started by the shortcut. description is the description of the shortcut. +filename is the title of the shortcut that the user will see. arguments +specifies the command line arguments, if any. workdir is the working directory +for the program. iconpath is the file containing the icon for the shortcut, +and iconindex is the index of the icon in the file iconpath. Again, for +details consult the Microsoft documentation for the IShellLink +interface.

    +
    + +
    +
    +
    +

    5.4. Vista User Access Control (UAC)

    +

    Starting with Python 2.6, bdist_wininst supports a --user-access-control +option. The default is ‘none’ (meaning no UAC handling is done), and other +valid values are ‘auto’ (meaning prompt for UAC elevation if Python was +installed for all users) and ‘force’ (meaning always prompt for elevation).

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/distutils/commandref.html b/python-3.7.4-docs-html/distutils/commandref.html new file mode 100644 index 0000000..7fbc5ea --- /dev/null +++ b/python-3.7.4-docs-html/distutils/commandref.html @@ -0,0 +1,263 @@ + + + + + + + 8. Command Reference — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    8. Command Reference

    +
    +

    8.1. Installing modules: the install command family

    +

    The install command ensures that the build commands have been run and then runs +the subcommands install_lib, install_data and +install_scripts.

    +
    +

    8.1.1. install_data

    +

    This command installs all data files provided with the distribution.

    +
    +
    +

    8.1.2. install_scripts

    +

    This command installs all (Python) scripts in the distribution.

    +
    +
    +
    +

    8.2. Creating a source distribution: the sdist command

    +

    The manifest template commands are:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Command

    Description

    include pat1 pat2 ...

    include all files matching any of the listed +patterns

    exclude pat1 pat2 ...

    exclude all files matching any of the listed +patterns

    recursive-include dir pat1 pat2 +...

    include all files under dir matching any of +the listed patterns

    recursive-exclude dir pat1 pat2 +...

    exclude all files under dir matching any of +the listed patterns

    global-include pat1 pat2 ...

    include all files anywhere in the source tree +matching — & any of the listed patterns

    global-exclude pat1 pat2 ...

    exclude all files anywhere in the source tree +matching — & any of the listed patterns

    prune dir

    exclude all files under dir

    graft dir

    include all files under dir

    +

    The patterns here are Unix-style “glob” patterns: * matches any sequence of +regular filename characters, ? matches any single regular filename +character, and [range] matches any of the characters in range (e.g., +a-z, a-zA-Z, a-f0-9_.). The definition of “regular filename +character” is platform-specific: on Unix it is anything except slash; on Windows +anything except backslash or colon.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/distutils/configfile.html b/python-3.7.4-docs-html/distutils/configfile.html new file mode 100644 index 0000000..28f0bf1 --- /dev/null +++ b/python-3.7.4-docs-html/distutils/configfile.html @@ -0,0 +1,294 @@ + + + + + + + 3. Writing the Setup Configuration File — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    3. Writing the Setup Configuration File

    +

    Often, it’s not possible to write down everything needed to build a distribution +a priori: you may need to get some information from the user, or from the +user’s system, in order to proceed. As long as that information is fairly +simple—a list of directories to search for C header files or libraries, for +example—then providing a configuration file, setup.cfg, for users to +edit is a cheap and easy way to solicit it. Configuration files also let you +provide default values for any command option, which the installer can then +override either on the command-line or by editing the config file.

    +

    The setup configuration file is a useful middle-ground between the setup +script—which, ideally, would be opaque to installers 1—and the command-line to +the setup script, which is outside of your control and entirely up to the +installer. In fact, setup.cfg (and any other Distutils configuration +files present on the target system) are processed after the contents of the +setup script, but before the command-line. This has several useful +consequences:

    +
      +
    • installers can override some of what you put in setup.py by editing +setup.cfg

    • +
    • you can provide non-standard defaults for options that are not easily set in +setup.py

    • +
    • installers can override anything in setup.cfg using the command-line +options to setup.py

    • +
    +

    The basic syntax of the configuration file is simple:

    +
    [command]
    +option=value
    +...
    +
    +
    +

    where command is one of the Distutils commands (e.g. build_py, +install), and option is one of the options that command supports. +Any number of options can be supplied for each command, and any number of +command sections can be included in the file. Blank lines are ignored, as are +comments, which run from a '#' character until the end of the line. Long +option values can be split across multiple lines simply by indenting the +continuation lines.

    +

    You can find out the list of options supported by a particular command with the +universal --help option, e.g.

    +
    $ python setup.py --help build_ext
    +[...]
    +Options for 'build_ext' command:
    +  --build-lib (-b)     directory for compiled extension modules
    +  --build-temp (-t)    directory for temporary files (build by-products)
    +  --inplace (-i)       ignore build-lib and put compiled extensions into the
    +                       source directory alongside your pure Python modules
    +  --include-dirs (-I)  list of directories to search for header files
    +  --define (-D)        C preprocessor macros to define
    +  --undef (-U)         C preprocessor macros to undefine
    +  --swig-opts          list of SWIG command line options
    +[...]
    +
    +
    +

    Note that an option spelled --foo-bar on the command-line is spelled +foo_bar in configuration files.

    +

    For example, say you want your extensions to be built “in-place”—that is, you +have an extension pkg.ext, and you want the compiled extension file +(ext.so on Unix, say) to be put in the same source directory as your +pure Python modules pkg.mod1 and pkg.mod2. You can always use the +--inplace option on the command-line to ensure this:

    +
    python setup.py build_ext --inplace
    +
    +
    +

    But this requires that you always specify the build_ext command +explicitly, and remember to provide --inplace. An easier way is to +“set and forget” this option, by encoding it in setup.cfg, the +configuration file for this distribution:

    +
    [build_ext]
    +inplace=1
    +
    +
    +

    This will affect all builds of this module distribution, whether or not you +explicitly specify build_ext. If you include setup.cfg in +your source distribution, it will also affect end-user builds—which is +probably a bad idea for this option, since always building extensions in-place +would break installation of the module distribution. In certain peculiar cases, +though, modules are built right in their installation directory, so this is +conceivably a useful ability. (Distributing extensions that expect to be built +in their installation directory is almost always a bad idea, though.)

    +

    Another example: certain commands take a lot of options that don’t change from +run to run; for example, bdist_rpm needs to know everything required +to generate a “spec” file for creating an RPM distribution. Some of this +information comes from the setup script, and some is automatically generated by +the Distutils (such as the list of files installed). But some of it has to be +supplied as options to bdist_rpm, which would be very tedious to do +on the command-line for every run. Hence, here is a snippet from the Distutils’ +own setup.cfg:

    +
    [bdist_rpm]
    +release = 1
    +packager = Greg Ward <gward@python.net>
    +doc_files = CHANGES.txt
    +            README.txt
    +            USAGE.txt
    +            doc/
    +            examples/
    +
    +
    +

    Note that the doc_files option is simply a whitespace-separated string +split across multiple lines for readability.

    +
    +

    See also

    +
    +
    Syntax of config files in “Installing Python Modules”

    More information on the configuration files is available in the manual for +system administrators.

    +
    +
    +
    +

    Footnotes

    +
    +
    1
    +

    This ideal probably won’t be achieved until auto-configuration is fully +supported by the Distutils.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/distutils/examples.html b/python-3.7.4-docs-html/distutils/examples.html new file mode 100644 index 0000000..9193b5f --- /dev/null +++ b/python-3.7.4-docs-html/distutils/examples.html @@ -0,0 +1,489 @@ + + + + + + + 6. Examples — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    6. Examples

    +

    This chapter provides a number of basic examples to help get started with +distutils. Additional information about using distutils can be found in the +Distutils Cookbook.

    +
    +

    See also

    +
    +
    Distutils Cookbook

    Collection of recipes showing how to achieve more control over distutils.

    +
    +
    +
    +
    +

    6.1. Pure Python distribution (by module)

    +

    If you’re just distributing a couple of modules, especially if they don’t live +in a particular package, you can specify them individually using the +py_modules option in the setup script.

    +

    In the simplest case, you’ll have two files to worry about: a setup script and +the single module you’re distributing, foo.py in this example:

    +
    <root>/
    +        setup.py
    +        foo.py
    +
    +
    +

    (In all diagrams in this section, <root> will refer to the distribution root +directory.) A minimal setup script to describe this situation would be:

    +
    from distutils.core import setup
    +setup(name='foo',
    +      version='1.0',
    +      py_modules=['foo'],
    +      )
    +
    +
    +

    Note that the name of the distribution is specified independently with the +name option, and there’s no rule that says it has to be the same as +the name of the sole module in the distribution (although that’s probably a good +convention to follow). However, the distribution name is used to generate +filenames, so you should stick to letters, digits, underscores, and hyphens.

    +

    Since py_modules is a list, you can of course specify multiple +modules, eg. if you’re distributing modules foo and bar, your +setup might look like this:

    +
    <root>/
    +        setup.py
    +        foo.py
    +        bar.py
    +
    +
    +

    and the setup script might be

    +
    from distutils.core import setup
    +setup(name='foobar',
    +      version='1.0',
    +      py_modules=['foo', 'bar'],
    +      )
    +
    +
    +

    You can put module source files into another directory, but if you have enough +modules to do that, it’s probably easier to specify modules by package rather +than listing them individually.

    +
    +
    +

    6.2. Pure Python distribution (by package)

    +

    If you have more than a couple of modules to distribute, especially if they are +in multiple packages, it’s probably easier to specify whole packages rather than +individual modules. This works even if your modules are not in a package; you +can just tell the Distutils to process modules from the root package, and that +works the same as any other package (except that you don’t have to have an +__init__.py file).

    +

    The setup script from the last example could also be written as

    +
    from distutils.core import setup
    +setup(name='foobar',
    +      version='1.0',
    +      packages=[''],
    +      )
    +
    +
    +

    (The empty string stands for the root package.)

    +

    If those two files are moved into a subdirectory, but remain in the root +package, e.g.:

    +
    <root>/
    +        setup.py
    +        src/      foo.py
    +                  bar.py
    +
    +
    +

    then you would still specify the root package, but you have to tell the +Distutils where source files in the root package live:

    +
    from distutils.core import setup
    +setup(name='foobar',
    +      version='1.0',
    +      package_dir={'': 'src'},
    +      packages=[''],
    +      )
    +
    +
    +

    More typically, though, you will want to distribute multiple modules in the same +package (or in sub-packages). For example, if the foo and bar +modules belong in package foobar, one way to layout your source tree is

    +
    <root>/
    +        setup.py
    +        foobar/
    +                 __init__.py
    +                 foo.py
    +                 bar.py
    +
    +
    +

    This is in fact the default layout expected by the Distutils, and the one that +requires the least work to describe in your setup script:

    +
    from distutils.core import setup
    +setup(name='foobar',
    +      version='1.0',
    +      packages=['foobar'],
    +      )
    +
    +
    +

    If you want to put modules in directories not named for their package, then you +need to use the package_dir option again. For example, if the +src directory holds modules in the foobar package:

    +
    <root>/
    +        setup.py
    +        src/
    +                 __init__.py
    +                 foo.py
    +                 bar.py
    +
    +
    +

    an appropriate setup script would be

    +
    from distutils.core import setup
    +setup(name='foobar',
    +      version='1.0',
    +      package_dir={'foobar': 'src'},
    +      packages=['foobar'],
    +      )
    +
    +
    +

    Or, you might put modules from your main package right in the distribution +root:

    +
    <root>/
    +        setup.py
    +        __init__.py
    +        foo.py
    +        bar.py
    +
    +
    +

    in which case your setup script would be

    +
    from distutils.core import setup
    +setup(name='foobar',
    +      version='1.0',
    +      package_dir={'foobar': ''},
    +      packages=['foobar'],
    +      )
    +
    +
    +

    (The empty string also stands for the current directory.)

    +

    If you have sub-packages, they must be explicitly listed in packages, +but any entries in package_dir automatically extend to sub-packages. +(In other words, the Distutils does not scan your source tree, trying to +figure out which directories correspond to Python packages by looking for +__init__.py files.) Thus, if the default layout grows a sub-package:

    +
    <root>/
    +        setup.py
    +        foobar/
    +                 __init__.py
    +                 foo.py
    +                 bar.py
    +                 subfoo/
    +                           __init__.py
    +                           blah.py
    +
    +
    +

    then the corresponding setup script would be

    +
    from distutils.core import setup
    +setup(name='foobar',
    +      version='1.0',
    +      packages=['foobar', 'foobar.subfoo'],
    +      )
    +
    +
    +
    +
    +

    6.3. Single extension module

    +

    Extension modules are specified using the ext_modules option. +package_dir has no effect on where extension source files are found; +it only affects the source for pure Python modules. The simplest case, a +single extension module in a single C source file, is:

    +
    <root>/
    +        setup.py
    +        foo.c
    +
    +
    +

    If the foo extension belongs in the root package, the setup script for +this could be

    +
    from distutils.core import setup
    +from distutils.extension import Extension
    +setup(name='foobar',
    +      version='1.0',
    +      ext_modules=[Extension('foo', ['foo.c'])],
    +      )
    +
    +
    +

    If the extension actually belongs in a package, say foopkg, then

    +

    With exactly the same source tree layout, this extension can be put in the +foopkg package simply by changing the name of the extension:

    +
    from distutils.core import setup
    +from distutils.extension import Extension
    +setup(name='foobar',
    +      version='1.0',
    +      ext_modules=[Extension('foopkg.foo', ['foo.c'])],
    +      )
    +
    +
    +
    +
    +

    6.4. Checking a package

    +

    The check command allows you to verify if your package meta-data +meet the minimum requirements to build a distribution.

    +

    To run it, just call it using your setup.py script. If something is +missing, check will display a warning.

    +

    Let’s take an example with a simple script:

    +
    from distutils.core import setup
    +
    +setup(name='foobar')
    +
    +
    +

    Running the check command will display some warnings:

    +
    $ python setup.py check
    +running check
    +warning: check: missing required meta-data: version, url
    +warning: check: missing meta-data: either (author and author_email) or
    +         (maintainer and maintainer_email) must be supplied
    +
    +
    +

    If you use the reStructuredText syntax in the long_description field and +docutils is installed you can check if the syntax is fine with the +check command, using the restructuredtext option.

    +

    For example, if the setup.py script is changed like this:

    +
    from distutils.core import setup
    +
    +desc = """\
    +My description
    +==============
    +
    +This is the description of the ``foobar`` package.
    +"""
    +
    +setup(name='foobar', version='1', author='tarek',
    +    author_email='tarek@ziade.org',
    +    url='http://example.com', long_description=desc)
    +
    +
    +

    Where the long description is broken, check will be able to detect it +by using the docutils parser:

    +
    $ python setup.py check --restructuredtext
    +running check
    +warning: check: Title underline too short. (line 2)
    +warning: check: Could not finish the parsing.
    +
    +
    +
    +
    +

    6.5. Reading the metadata

    +

    The distutils.core.setup() function provides a command-line interface +that allows you to query the metadata fields of a project through the +setup.py script of a given project:

    +
    $ python setup.py --name
    +distribute
    +
    +
    +

    This call reads the name metadata by running the +distutils.core.setup() function. Although, when a source or binary +distribution is created with Distutils, the metadata fields are written +in a static file called PKG-INFO. When a Distutils-based project is +installed in Python, the PKG-INFO file is copied alongside the modules +and packages of the distribution under NAME-VERSION-pyX.X.egg-info, +where NAME is the name of the project, VERSION its version as defined +in the Metadata, and pyX.X the major and minor version of Python like +2.7 or 3.2.

    +

    You can read back this static file, by using the +distutils.dist.DistributionMetadata class and its +read_pkg_file() method:

    +
    >>> from distutils.dist import DistributionMetadata
    +>>> metadata = DistributionMetadata()
    +>>> metadata.read_pkg_file(open('distribute-0.6.8-py2.7.egg-info'))
    +>>> metadata.name
    +'distribute'
    +>>> metadata.version
    +'0.6.8'
    +>>> metadata.description
    +'Easily download, build, install, upgrade, and uninstall Python packages'
    +
    +
    +

    Notice that the class can also be instantiated with a metadata file path to +loads its values:

    +
    >>> pkg_info_path = 'distribute-0.6.8-py2.7.egg-info'
    +>>> DistributionMetadata(pkg_info_path).name
    +'distribute'
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/distutils/extending.html b/python-3.7.4-docs-html/distutils/extending.html new file mode 100644 index 0000000..72dd18f --- /dev/null +++ b/python-3.7.4-docs-html/distutils/extending.html @@ -0,0 +1,262 @@ + + + + + + + 7. Extending Distutils — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    7. Extending Distutils

    +

    Distutils can be extended in various ways. Most extensions take the form of new +commands or replacements for existing commands. New commands may be written to +support new types of platform-specific packaging, for example, while +replacements for existing commands may be made to modify details of how the +command operates on a package.

    +

    Most extensions of the distutils are made within setup.py scripts that +want to modify existing commands; many simply add a few file extensions that +should be copied into packages in addition to .py files as a +convenience.

    +

    Most distutils command implementations are subclasses of the +distutils.cmd.Command class. New commands may directly inherit from +Command, while replacements often derive from Command +indirectly, directly subclassing the command they are replacing. Commands are +required to derive from Command.

    +
    +

    7.1. Integrating new commands

    +

    There are different ways to integrate new command implementations into +distutils. The most difficult is to lobby for the inclusion of the new features +in distutils itself, and wait for (and require) a version of Python that +provides that support. This is really hard for many reasons.

    +

    The most common, and possibly the most reasonable for most needs, is to include +the new implementations with your setup.py script, and cause the +distutils.core.setup() function use them:

    +
    from distutils.command.build_py import build_py as _build_py
    +from distutils.core import setup
    +
    +class build_py(_build_py):
    +    """Specialized Python source builder."""
    +
    +    # implement whatever needs to be different...
    +
    +setup(cmdclass={'build_py': build_py},
    +      ...)
    +
    +
    +

    This approach is most valuable if the new implementations must be used to use a +particular package, as everyone interested in the package will need to have the +new command implementation.

    +

    Beginning with Python 2.4, a third option is available, intended to allow new +commands to be added which can support existing setup.py scripts without +requiring modifications to the Python installation. This is expected to allow +third-party extensions to provide support for additional packaging systems, but +the commands can be used for anything distutils commands can be used for. A new +configuration option, command_packages (command-line option +--command-packages), can be used to specify additional packages to be +searched for modules implementing commands. Like all distutils options, this +can be specified on the command line or in a configuration file. This option +can only be set in the [global] section of a configuration file, or before +any commands on the command line. If set in a configuration file, it can be +overridden from the command line; setting it to an empty string on the command +line causes the default to be used. This should never be set in a configuration +file provided with a package.

    +

    This new option can be used to add any number of packages to the list of +packages searched for command implementations; multiple package names should be +separated by commas. When not specified, the search is only performed in the +distutils.command package. When setup.py is run with the option +--command-packages distcmds,buildcmds, however, the packages +distutils.command, distcmds, and buildcmds will be searched +in that order. New commands are expected to be implemented in modules of the +same name as the command by classes sharing the same name. Given the example +command line option above, the command bdist_openpkg could be +implemented by the class distcmds.bdist_openpkg.bdist_openpkg or +buildcmds.bdist_openpkg.bdist_openpkg.

    +
    +
    +

    7.2. Adding new distribution types

    +

    Commands that create distributions (files in the dist/ directory) need +to add (command, filename) pairs to self.distribution.dist_files so that +upload can upload it to PyPI. The filename in the pair contains no +path information, only the name of the file itself. In dry-run mode, pairs +should still be added to represent what would have been created.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/distutils/index.html b/python-3.7.4-docs-html/distutils/index.html new file mode 100644 index 0000000..796158a --- /dev/null +++ b/python-3.7.4-docs-html/distutils/index.html @@ -0,0 +1,309 @@ + + + + + + + Distributing Python Modules (Legacy version) — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Distributing Python Modules (Legacy version)

    +
    +
    Authors
    +

    Greg Ward, Anthony Baxter

    +
    +
    Email
    +

    distutils-sig@python.org

    +
    +
    +
    +

    See also

    +
    +
    Distributing Python Modules

    The up to date module distribution documentations

    +
    +
    +
    +

    This document describes the Python Distribution Utilities (“Distutils”) from +the module developer’s point of view, describing how to use the Distutils to +make Python modules and extensions easily available to a wider audience with +very little overhead for build/release/install mechanics.

    +
    +

    Note

    +

    This guide only covers the basic tools for building and distributing +extensions that are provided as part of this version of Python. Third party +tools offer easier to use and more secure alternatives. Refer to the quick +recommendations section +in the Python Packaging User Guide for more information.

    +
    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/distutils/introduction.html b/python-3.7.4-docs-html/distutils/introduction.html new file mode 100644 index 0000000..fa35235 --- /dev/null +++ b/python-3.7.4-docs-html/distutils/introduction.html @@ -0,0 +1,364 @@ + + + + + + + 1. An Introduction to Distutils — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    1. An Introduction to Distutils

    +

    This document covers using the Distutils to distribute your Python modules, +concentrating on the role of developer/distributor: if you’re looking for +information on installing Python modules, you should refer to the +Installing Python Modules (Legacy version) chapter.

    +
    +

    1.1. Concepts & Terminology

    +

    Using the Distutils is quite simple, both for module developers and for +users/administrators installing third-party modules. As a developer, your +responsibilities (apart from writing solid, well-documented and well-tested +code, of course!) are:

    +
      +
    • write a setup script (setup.py by convention)

    • +
    • (optional) write a setup configuration file

    • +
    • create a source distribution

    • +
    • (optional) create one or more built (binary) distributions

    • +
    +

    Each of these tasks is covered in this document.

    +

    Not all module developers have access to a multitude of platforms, so it’s not +always feasible to expect them to create a multitude of built distributions. It +is hoped that a class of intermediaries, called packagers, will arise to +address this need. Packagers will take source distributions released by module +developers, build them on one or more platforms, and release the resulting built +distributions. Thus, users on the most popular platforms will be able to +install most popular Python module distributions in the most natural way for +their platform, without having to run a single setup script or compile a line of +code.

    +
    +
    +

    1.2. A Simple Example

    +

    The setup script is usually quite simple, although since it’s written in Python, +there are no arbitrary limits to what you can do with it, though you should be +careful about putting arbitrarily expensive operations in your setup script. +Unlike, say, Autoconf-style configure scripts, the setup script may be run +multiple times in the course of building and installing your module +distribution.

    +

    If all you want to do is distribute a module called foo, contained in a +file foo.py, then your setup script can be as simple as this:

    +
    from distutils.core import setup
    +setup(name='foo',
    +      version='1.0',
    +      py_modules=['foo'],
    +      )
    +
    +
    +

    Some observations:

    +
      +
    • most information that you supply to the Distutils is supplied as keyword +arguments to the setup() function

    • +
    • those keyword arguments fall into two categories: package metadata (name, +version number) and information about what’s in the package (a list of pure +Python modules, in this case)

    • +
    • modules are specified by module name, not filename (the same will hold true +for packages and extensions)

    • +
    • it’s recommended that you supply a little more metadata, in particular your +name, email address and a URL for the project (see section Writing the Setup Script +for an example)

    • +
    +

    To create a source distribution for this module, you would create a setup +script, setup.py, containing the above code, and run this command from a +terminal:

    +
    python setup.py sdist
    +
    +
    +

    For Windows, open a command prompt window (Start ‣ +Accessories) and change the command to:

    +
    setup.py sdist
    +
    +
    +

    sdist will create an archive file (e.g., tarball on Unix, ZIP file on Windows) +containing your setup script setup.py, and your module foo.py. +The archive file will be named foo-1.0.tar.gz (or .zip), and +will unpack into a directory foo-1.0.

    +

    If an end-user wishes to install your foo module, all they have to do is +download foo-1.0.tar.gz (or .zip), unpack it, and—from the +foo-1.0 directory—run

    +
    python setup.py install
    +
    +
    +

    which will ultimately copy foo.py to the appropriate directory for +third-party modules in their Python installation.

    +

    This simple example demonstrates some fundamental concepts of the Distutils. +First, both developers and installers have the same basic user interface, i.e. +the setup script. The difference is which Distutils commands they use: the +sdist command is almost exclusively for module developers, while +install is more often for installers (although most developers will +want to install their own code occasionally).

    +

    If you want to make things really easy for your users, you can create one or +more built distributions for them. For instance, if you are running on a +Windows machine, and want to make things easy for other Windows users, you can +create an executable installer (the most appropriate type of built distribution +for this platform) with the bdist_wininst command. For example:

    +
    python setup.py bdist_wininst
    +
    +
    +

    will create an executable installer, foo-1.0.win32.exe, in the current +directory.

    +

    Other useful built distribution formats are RPM, implemented by the +bdist_rpm command, Solaris pkgtool +(bdist_pkgtool), and HP-UX swinstall +(bdist_sdux). For example, the following command will create an RPM +file called foo-1.0.noarch.rpm:

    +
    python setup.py bdist_rpm
    +
    +
    +

    (The bdist_rpm command uses the rpm executable, therefore +this has to be run on an RPM-based system such as Red Hat Linux, SuSE Linux, or +Mandrake Linux.)

    +

    You can find out what distribution formats are available at any time by running

    +
    python setup.py bdist --help-formats
    +
    +
    +
    +
    +

    1.3. General Python terminology

    +

    If you’re reading this document, you probably have a good idea of what modules, +extensions, and so forth are. Nevertheless, just to be sure that everyone is +operating from a common starting point, we offer the following glossary of +common Python terms:

    +
    +
    module

    the basic unit of code reusability in Python: a block of code imported by some +other code. Three types of modules concern us here: pure Python modules, +extension modules, and packages.

    +
    +
    pure Python module

    a module written in Python and contained in a single .py file (and +possibly associated .pyc files). Sometimes referred to as a +“pure module.”

    +
    +
    extension module

    a module written in the low-level language of the Python implementation: C/C++ +for Python, Java for Jython. Typically contained in a single dynamically +loadable pre-compiled file, e.g. a shared object (.so) file for Python +extensions on Unix, a DLL (given the .pyd extension) for Python +extensions on Windows, or a Java class file for Jython extensions. (Note that +currently, the Distutils only handles C/C++ extensions for Python.)

    +
    +
    package

    a module that contains other modules; typically contained in a directory in the +filesystem and distinguished from other directories by the presence of a file +__init__.py.

    +
    +
    root package

    the root of the hierarchy of packages. (This isn’t really a package, since it +doesn’t have an __init__.py file. But we have to call it something.) +The vast majority of the standard library is in the root package, as are many +small, standalone third-party modules that don’t belong to a larger module +collection. Unlike regular packages, modules in the root package can be found in +many directories: in fact, every directory listed in sys.path contributes +modules to the root package.

    +
    +
    +
    +
    +

    1.4. Distutils-specific terminology

    +

    The following terms apply more specifically to the domain of distributing Python +modules using the Distutils:

    +
    +
    module distribution

    a collection of Python modules distributed together as a single downloadable +resource and meant to be installed en masse. Examples of some well-known +module distributions are NumPy, SciPy, Pillow, +or mxBase. (This would be called a package, except that term is +already taken in the Python context: a single module distribution may contain +zero, one, or many Python packages.)

    +
    +
    pure module distribution

    a module distribution that contains only pure Python modules and packages. +Sometimes referred to as a “pure distribution.”

    +
    +
    non-pure module distribution

    a module distribution that contains at least one extension module. Sometimes +referred to as a “non-pure distribution.”

    +
    +
    distribution root

    the top-level directory of your source tree (or source distribution); the +directory where setup.py exists. Generally setup.py will be +run from this directory.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/distutils/packageindex.html b/python-3.7.4-docs-html/distutils/packageindex.html new file mode 100644 index 0000000..077e5b6 --- /dev/null +++ b/python-3.7.4-docs-html/distutils/packageindex.html @@ -0,0 +1,164 @@ + + + + + + + The Python Package Index (PyPI) — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    The Python Package Index (PyPI)

    +

    The Python Package Index (PyPI) stores metadata describing distributions +packaged with distutils and other publishing tools, as well the distribution +archives themselves.

    +

    References to up to date PyPI documentation can be found at +Reading the Python Packaging User Guide.

    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/distutils/setupscript.html b/python-3.7.4-docs-html/distutils/setupscript.html new file mode 100644 index 0000000..d4ccfc0 --- /dev/null +++ b/python-3.7.4-docs-html/distutils/setupscript.html @@ -0,0 +1,886 @@ + + + + + + + 2. Writing the Setup Script — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    2. Writing the Setup Script

    +

    The setup script is the centre of all activity in building, distributing, and +installing modules using the Distutils. The main purpose of the setup script is +to describe your module distribution to the Distutils, so that the various +commands that operate on your modules do the right thing. As we saw in section +A Simple Example above, the setup script consists mainly of a call to +setup(), and most information supplied to the Distutils by the module +developer is supplied as keyword arguments to setup().

    +

    Here’s a slightly more involved example, which we’ll follow for the next couple +of sections: the Distutils’ own setup script. (Keep in mind that although the +Distutils are included with Python 1.6 and later, they also have an independent +existence so that Python 1.5.2 users can use them to install other module +distributions. The Distutils’ own setup script, shown here, is used to install +the package into Python 1.5.2.)

    +
    #!/usr/bin/env python
    +
    +from distutils.core import setup
    +
    +setup(name='Distutils',
    +      version='1.0',
    +      description='Python Distribution Utilities',
    +      author='Greg Ward',
    +      author_email='gward@python.net',
    +      url='https://www.python.org/sigs/distutils-sig/',
    +      packages=['distutils', 'distutils.command'],
    +     )
    +
    +
    +

    There are only two differences between this and the trivial one-file +distribution presented in section A Simple Example: more metadata, and the +specification of pure Python modules by package, rather than by module. This is +important since the Distutils consist of a couple of dozen modules split into +(so far) two packages; an explicit list of every module would be tedious to +generate and difficult to maintain. For more information on the additional +meta-data, see section Additional meta-data.

    +

    Note that any pathnames (files or directories) supplied in the setup script +should be written using the Unix convention, i.e. slash-separated. The +Distutils will take care of converting this platform-neutral representation into +whatever is appropriate on your current platform before actually using the +pathname. This makes your setup script portable across operating systems, which +of course is one of the major goals of the Distutils. In this spirit, all +pathnames in this document are slash-separated.

    +

    This, of course, only applies to pathnames given to Distutils functions. If +you, for example, use standard Python functions such as glob.glob() or +os.listdir() to specify files, you should be careful to write portable +code instead of hardcoding path separators:

    +
    glob.glob(os.path.join('mydir', 'subdir', '*.html'))
    +os.listdir(os.path.join('mydir', 'subdir'))
    +
    +
    +
    +

    2.1. Listing whole packages

    +

    The packages option tells the Distutils to process (build, distribute, +install, etc.) all pure Python modules found in each package mentioned in the +packages list. In order to do this, of course, there has to be a +correspondence between package names and directories in the filesystem. The +default correspondence is the most obvious one, i.e. package distutils is +found in the directory distutils relative to the distribution root. +Thus, when you say packages = ['foo'] in your setup script, you are +promising that the Distutils will find a file foo/__init__.py (which +might be spelled differently on your system, but you get the idea) relative to +the directory where your setup script lives. If you break this promise, the +Distutils will issue a warning but still process the broken package anyway.

    +

    If you use a different convention to lay out your source directory, that’s no +problem: you just have to supply the package_dir option to tell the +Distutils about your convention. For example, say you keep all Python source +under lib, so that modules in the “root package” (i.e., not in any +package at all) are in lib, modules in the foo package are in +lib/foo, and so forth. Then you would put

    +
    package_dir = {'': 'lib'}
    +
    +
    +

    in your setup script. The keys to this dictionary are package names, and an +empty package name stands for the root package. The values are directory names +relative to your distribution root. In this case, when you say packages = +['foo'], you are promising that the file lib/foo/__init__.py exists.

    +

    Another possible convention is to put the foo package right in +lib, the foo.bar package in lib/bar, etc. This would be +written in the setup script as

    +
    package_dir = {'foo': 'lib'}
    +
    +
    +

    A package: dir entry in the package_dir dictionary implicitly +applies to all packages below package, so the foo.bar case is +automatically handled here. In this example, having packages = ['foo', +'foo.bar'] tells the Distutils to look for lib/__init__.py and +lib/bar/__init__.py. (Keep in mind that although package_dir +applies recursively, you must explicitly list all packages in +packages: the Distutils will not recursively scan your source tree +looking for any directory with an __init__.py file.)

    +
    +
    +

    2.2. Listing individual modules

    +

    For a small module distribution, you might prefer to list all modules rather +than listing packages—especially the case of a single module that goes in the +“root package” (i.e., no package at all). This simplest case was shown in +section A Simple Example; here is a slightly more involved example:

    +
    py_modules = ['mod1', 'pkg.mod2']
    +
    +
    +

    This describes two modules, one of them in the “root” package, the other in the +pkg package. Again, the default package/directory layout implies that +these two modules can be found in mod1.py and pkg/mod2.py, and +that pkg/__init__.py exists as well. And again, you can override the +package/directory correspondence using the package_dir option.

    +
    +
    +

    2.3. Describing extension modules

    +

    Just as writing Python extension modules is a bit more complicated than writing +pure Python modules, describing them to the Distutils is a bit more complicated. +Unlike pure modules, it’s not enough just to list modules or packages and expect +the Distutils to go out and find the right files; you have to specify the +extension name, source file(s), and any compile/link requirements (include +directories, libraries to link with, etc.).

    +

    All of this is done through another keyword argument to setup(), the +ext_modules option. ext_modules is just a list of +Extension instances, each of which describes a +single extension module. +Suppose your distribution includes a single extension, called foo and +implemented by foo.c. If no additional instructions to the +compiler/linker are needed, describing this extension is quite simple:

    +
    Extension('foo', ['foo.c'])
    +
    +
    +

    The Extension class can be imported from distutils.core along +with setup(). Thus, the setup script for a module distribution that +contains only this one extension and nothing else might be:

    +
    from distutils.core import setup, Extension
    +setup(name='foo',
    +      version='1.0',
    +      ext_modules=[Extension('foo', ['foo.c'])],
    +      )
    +
    +
    +

    The Extension class (actually, the underlying extension-building +machinery implemented by the build_ext command) supports a great deal +of flexibility in describing Python extensions, which is explained in the +following sections.

    +
    +

    2.3.1. Extension names and packages

    +

    The first argument to the Extension constructor is +always the name of the extension, including any package names. For example,

    +
    Extension('foo', ['src/foo1.c', 'src/foo2.c'])
    +
    +
    +

    describes an extension that lives in the root package, while

    +
    Extension('pkg.foo', ['src/foo1.c', 'src/foo2.c'])
    +
    +
    +

    describes the same extension in the pkg package. The source files and +resulting object code are identical in both cases; the only difference is where +in the filesystem (and therefore where in Python’s namespace hierarchy) the +resulting extension lives.

    +

    If you have a number of extensions all in the same package (or all under the +same base package), use the ext_package keyword argument to +setup(). For example,

    +
    setup(...,
    +      ext_package='pkg',
    +      ext_modules=[Extension('foo', ['foo.c']),
    +                   Extension('subpkg.bar', ['bar.c'])],
    +     )
    +
    +
    +

    will compile foo.c to the extension pkg.foo, and bar.c to +pkg.subpkg.bar.

    +
    +
    +

    2.3.2. Extension source files

    +

    The second argument to the Extension constructor is +a list of source +files. Since the Distutils currently only support C, C++, and Objective-C +extensions, these are normally C/C++/Objective-C source files. (Be sure to use +appropriate extensions to distinguish C++ source files: .cc and +.cpp seem to be recognized by both Unix and Windows compilers.)

    +

    However, you can also include SWIG interface (.i) files in the list; the +build_ext command knows how to deal with SWIG extensions: it will run +SWIG on the interface file and compile the resulting C/C++ file into your +extension.

    +

    This warning notwithstanding, options to SWIG can be currently passed like +this:

    +
    setup(...,
    +      ext_modules=[Extension('_foo', ['foo.i'],
    +                             swig_opts=['-modern', '-I../include'])],
    +      py_modules=['foo'],
    +     )
    +
    +
    +

    Or on the commandline like this:

    +
    > python setup.py build_ext --swig-opts="-modern -I../include"
    +
    +
    +

    On some platforms, you can include non-source files that are processed by the +compiler and included in your extension. Currently, this just means Windows +message text (.mc) files and resource definition (.rc) files for +Visual C++. These will be compiled to binary resource (.res) files and +linked into the executable.

    +
    +
    +

    2.3.3. Preprocessor options

    +

    Three optional arguments to Extension will help if +you need to specify include directories to search or preprocessor macros to +define/undefine: include_dirs, define_macros, and undef_macros.

    +

    For example, if your extension requires header files in the include +directory under your distribution root, use the include_dirs option:

    +
    Extension('foo', ['foo.c'], include_dirs=['include'])
    +
    +
    +

    You can specify absolute directories there; if you know that your extension will +only be built on Unix systems with X11R6 installed to /usr, you can get +away with

    +
    Extension('foo', ['foo.c'], include_dirs=['/usr/include/X11'])
    +
    +
    +

    You should avoid this sort of non-portable usage if you plan to distribute your +code: it’s probably better to write C code like

    +
    #include <X11/Xlib.h>
    +
    +
    +

    If you need to include header files from some other Python extension, you can +take advantage of the fact that header files are installed in a consistent way +by the Distutils install_headers command. For example, the Numerical +Python header files are installed (on a standard Unix installation) to +/usr/local/include/python1.5/Numerical. (The exact location will differ +according to your platform and Python installation.) Since the Python include +directory—/usr/local/include/python1.5 in this case—is always +included in the search path when building Python extensions, the best approach +is to write C code like

    +
    #include <Numerical/arrayobject.h>
    +
    +
    +

    If you must put the Numerical include directory right into your header +search path, though, you can find that directory using the Distutils +distutils.sysconfig module:

    +
    from distutils.sysconfig import get_python_inc
    +incdir = os.path.join(get_python_inc(plat_specific=1), 'Numerical')
    +setup(...,
    +      Extension(..., include_dirs=[incdir]),
    +      )
    +
    +
    +

    Even though this is quite portable—it will work on any Python installation, +regardless of platform—it’s probably easier to just write your C code in the +sensible way.

    +

    You can define and undefine pre-processor macros with the define_macros and +undef_macros options. define_macros takes a list of (name, value) +tuples, where name is the name of the macro to define (a string) and +value is its value: either a string or None. (Defining a macro FOO +to None is the equivalent of a bare #define FOO in your C source: with +most compilers, this sets FOO to the string 1.) undef_macros is +just a list of macros to undefine.

    +

    For example:

    +
    Extension(...,
    +          define_macros=[('NDEBUG', '1'),
    +                         ('HAVE_STRFTIME', None)],
    +          undef_macros=['HAVE_FOO', 'HAVE_BAR'])
    +
    +
    +

    is the equivalent of having this at the top of every C source file:

    +
    #define NDEBUG 1
    +#define HAVE_STRFTIME
    +#undef HAVE_FOO
    +#undef HAVE_BAR
    +
    +
    +
    +
    +

    2.3.4. Library options

    +

    You can also specify the libraries to link against when building your extension, +and the directories to search for those libraries. The libraries option is +a list of libraries to link against, library_dirs is a list of directories +to search for libraries at link-time, and runtime_library_dirs is a list of +directories to search for shared (dynamically loaded) libraries at run-time.

    +

    For example, if you need to link against libraries known to be in the standard +library search path on target systems

    +
    Extension(...,
    +          libraries=['gdbm', 'readline'])
    +
    +
    +

    If you need to link with libraries in a non-standard location, you’ll have to +include the location in library_dirs:

    +
    Extension(...,
    +          library_dirs=['/usr/X11R6/lib'],
    +          libraries=['X11', 'Xt'])
    +
    +
    +

    (Again, this sort of non-portable construct should be avoided if you intend to +distribute your code.)

    +
    +
    +

    2.3.5. Other options

    +

    There are still some other options which can be used to handle special cases.

    +

    The optional option is a boolean; if it is true, +a build failure in the extension will not abort the build process, but +instead simply not install the failing extension.

    +

    The extra_objects option is a list of object files to be passed to the +linker. These files must not have extensions, as the default extension for the +compiler is used.

    +

    extra_compile_args and extra_link_args can be used to +specify additional command line options for the respective compiler and linker +command lines.

    +

    export_symbols is only useful on Windows. It can contain a list of +symbols (functions or variables) to be exported. This option is not needed when +building compiled extensions: Distutils will automatically add initmodule +to the list of exported symbols.

    +

    The depends option is a list of files that the extension depends on +(for example header files). The build command will call the compiler on the +sources to rebuild extension if any on this files has been modified since the +previous build.

    +
    +
    +
    +

    2.4. Relationships between Distributions and Packages

    +

    A distribution may relate to packages in three specific ways:

    +
      +
    1. It can require packages or modules.

    2. +
    3. It can provide packages or modules.

    4. +
    5. It can obsolete packages or modules.

    6. +
    +

    These relationships can be specified using keyword arguments to the +distutils.core.setup() function.

    +

    Dependencies on other Python modules and packages can be specified by supplying +the requires keyword argument to setup(). The value must be a list of +strings. Each string specifies a package that is required, and optionally what +versions are sufficient.

    +

    To specify that any version of a module or package is required, the string +should consist entirely of the module or package name. Examples include +'mymodule' and 'xml.parsers.expat'.

    +

    If specific versions are required, a sequence of qualifiers can be supplied in +parentheses. Each qualifier may consist of a comparison operator and a version +number. The accepted comparison operators are:

    +
    <    >    ==
    +<=   >=   !=
    +
    +
    +

    These can be combined by using multiple qualifiers separated by commas (and +optional whitespace). In this case, all of the qualifiers must be matched; a +logical AND is used to combine the evaluations.

    +

    Let’s look at a bunch of examples:

    + ++++ + + + + + + + + + + + + + +

    Requires Expression

    Explanation

    ==1.0

    Only version 1.0 is compatible

    >1.0, !=1.5.1, <2.0

    Any version after 1.0 and before 2.0 +is compatible, except 1.5.1

    +

    Now that we can specify dependencies, we also need to be able to specify what we +provide that other distributions can require. This is done using the provides +keyword argument to setup(). The value for this keyword is a list of +strings, each of which names a Python module or package, and optionally +identifies the version. If the version is not specified, it is assumed to match +that of the distribution.

    +

    Some examples:

    + ++++ + + + + + + + + + + + + + +

    Provides Expression

    Explanation

    mypkg

    Provide mypkg, using the distribution +version

    mypkg (1.1)

    Provide mypkg version 1.1, regardless of +the distribution version

    +

    A package can declare that it obsoletes other packages using the obsoletes +keyword argument. The value for this is similar to that of the requires +keyword: a list of strings giving module or package specifiers. Each specifier +consists of a module or package name optionally followed by one or more version +qualifiers. Version qualifiers are given in parentheses after the module or +package name.

    +

    The versions identified by the qualifiers are those that are obsoleted by the +distribution being described. If no qualifiers are given, all versions of the +named module or package are understood to be obsoleted.

    +
    +
    +

    2.5. Installing Scripts

    +

    So far we have been dealing with pure and non-pure Python modules, which are +usually not run by themselves but imported by scripts.

    +

    Scripts are files containing Python source code, intended to be started from the +command line. Scripts don’t require Distutils to do anything very complicated. +The only clever feature is that if the first line of the script starts with +#! and contains the word “python”, the Distutils will adjust the first line +to refer to the current interpreter location. By default, it is replaced with +the current interpreter location. The --executable (or -e) +option will allow the interpreter path to be explicitly overridden.

    +

    The scripts option simply is a list of files to be handled in this +way. From the PyXML setup script:

    +
    setup(...,
    +      scripts=['scripts/xmlproc_parse', 'scripts/xmlproc_val']
    +      )
    +
    +
    +
    +

    Changed in version 3.1: All the scripts will also be added to the MANIFEST file if no template is +provided. See Specifying the files to distribute.

    +
    +
    +
    +

    2.6. Installing Package Data

    +

    Often, additional files need to be installed into a package. These files are +often data that’s closely related to the package’s implementation, or text files +containing documentation that might be of interest to programmers using the +package. These files are called package data.

    +

    Package data can be added to packages using the package_data keyword +argument to the setup() function. The value must be a mapping from +package name to a list of relative path names that should be copied into the +package. The paths are interpreted as relative to the directory containing the +package (information from the package_dir mapping is used if appropriate); +that is, the files are expected to be part of the package in the source +directories. They may contain glob patterns as well.

    +

    The path names may contain directory portions; any necessary directories will be +created in the installation.

    +

    For example, if a package should contain a subdirectory with several data files, +the files can be arranged like this in the source tree:

    +
    setup.py
    +src/
    +    mypkg/
    +        __init__.py
    +        module.py
    +        data/
    +            tables.dat
    +            spoons.dat
    +            forks.dat
    +
    +
    +

    The corresponding call to setup() might be:

    +
    setup(...,
    +      packages=['mypkg'],
    +      package_dir={'mypkg': 'src/mypkg'},
    +      package_data={'mypkg': ['data/*.dat']},
    +      )
    +
    +
    +
    +

    Changed in version 3.1: All the files that match package_data will be added to the MANIFEST +file if no template is provided. See Specifying the files to distribute.

    +
    +
    +
    +

    2.7. Installing Additional Files

    +

    The data_files option can be used to specify additional files needed +by the module distribution: configuration files, message catalogs, data files, +anything which doesn’t fit in the previous categories.

    +

    data_files specifies a sequence of (directory, files) pairs in the +following way:

    +
    setup(...,
    +      data_files=[('bitmaps', ['bm/b1.gif', 'bm/b2.gif']),
    +                  ('config', ['cfg/data.cfg'])],
    +     )
    +
    +
    +

    Each (directory, files) pair in the sequence specifies the installation +directory and the files to install there.

    +

    Each file name in files is interpreted relative to the setup.py +script at the top of the package source distribution. Note that you can +specify the directory where the data files will be installed, but you cannot +rename the data files themselves.

    +

    The directory should be a relative path. It is interpreted relative to the +installation prefix (Python’s sys.prefix for system installations; +site.USER_BASE for user installations). Distutils allows directory to be +an absolute installation path, but this is discouraged since it is +incompatible with the wheel packaging format. No directory information from +files is used to determine the final location of the installed file; only +the name of the file is used.

    +

    You can specify the data_files options as a simple sequence of files +without specifying a target directory, but this is not recommended, and the +install command will print a warning in this case. To install data +files directly in the target directory, an empty string should be given as the +directory.

    +
    +

    Changed in version 3.1: All the files that match data_files will be added to the MANIFEST +file if no template is provided. See Specifying the files to distribute.

    +
    +
    +
    +

    2.8. Additional meta-data

    +

    The setup script may include additional meta-data beyond the name and version. +This information includes:

    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Meta-Data

    Description

    Value

    Notes

    name

    name of the package

    short string

    (1)

    version

    version of this release

    short string

    (1)(2)

    author

    package author’s name

    short string

    (3)

    author_email

    email address of the +package author

    email address

    (3)

    maintainer

    package maintainer’s name

    short string

    (3)

    maintainer_email

    email address of the +package maintainer

    email address

    (3)

    url

    home page for the package

    URL

    (1)

    description

    short, summary +description of the +package

    short string

    long_description

    longer description of the +package

    long string

    (4)

    download_url

    location where the +package may be downloaded

    URL

    classifiers

    a list of classifiers

    list of strings

    (6)(7)

    platforms

    a list of platforms

    list of strings

    (6)(8)

    keywords

    a list of keywords

    list of strings

    (6)(8)

    license

    license for the package

    short string

    (5)

    +

    Notes:

    +
      +
    1. These fields are required.

    2. +
    3. It is recommended that versions take the form major.minor[.patch[.sub]].

    4. +
    5. Either the author or the maintainer must be identified. If maintainer is +provided, distutils lists it as the author in PKG-INFO.

    6. +
    7. The long_description field is used by PyPI when you publish a package, +to build its project page.

    8. +
    9. The license field is a text indicating the license covering the +package where the license is not a selection from the “License” Trove +classifiers. See the Classifier field. Notice that +there’s a licence distribution option which is deprecated but still +acts as an alias for license.

    10. +
    11. This field must be a list.

    12. +
    13. The valid classifiers are listed on +PyPI.

    14. +
    15. To preserve backward compatibility, this field also accepts a string. If +you pass a comma-separated string 'foo, bar', it will be converted to +['foo', 'bar'], Otherwise, it will be converted to a list of one +string.

    16. +
    +
    +
    ‘short string’

    A single line of text, not more than 200 characters.

    +
    +
    ‘long string’

    Multiple lines of plain text in reStructuredText format (see +http://docutils.sourceforge.net/).

    +
    +
    ‘list of strings’

    See below.

    +
    +
    +

    Encoding the version information is an art in itself. Python packages generally +adhere to the version format major.minor[.patch][sub]. The major number is 0 +for initial, experimental releases of software. It is incremented for releases +that represent major milestones in a package. The minor number is incremented +when important new features are added to the package. The patch number +increments when bug-fix releases are made. Additional trailing version +information is sometimes used to indicate sub-releases. These are +“a1,a2,…,aN” (for alpha releases, where functionality and API may change), +“b1,b2,…,bN” (for beta releases, which only fix bugs) and “pr1,pr2,…,prN” +(for final pre-release release testing). Some examples:

    +
    +
    0.1.0

    the first, experimental release of a package

    +
    +
    1.0.1a2

    the second alpha release of the first patch version of 1.0

    +
    +
    +

    classifiers must be specified in a list:

    +
    setup(...,
    +      classifiers=[
    +          'Development Status :: 4 - Beta',
    +          'Environment :: Console',
    +          'Environment :: Web Environment',
    +          'Intended Audience :: End Users/Desktop',
    +          'Intended Audience :: Developers',
    +          'Intended Audience :: System Administrators',
    +          'License :: OSI Approved :: Python Software Foundation License',
    +          'Operating System :: MacOS :: MacOS X',
    +          'Operating System :: Microsoft :: Windows',
    +          'Operating System :: POSIX',
    +          'Programming Language :: Python',
    +          'Topic :: Communications :: Email',
    +          'Topic :: Office/Business',
    +          'Topic :: Software Development :: Bug Tracking',
    +          ],
    +      )
    +
    +
    +
    +

    Changed in version 3.7: setup now warns when classifiers, keywords +or platforms fields are not specified as a list or a string.

    +
    +
    +
    +

    2.9. Debugging the setup script

    +

    Sometimes things go wrong, and the setup script doesn’t do what the developer +wants.

    +

    Distutils catches any exceptions when running the setup script, and print a +simple error message before the script is terminated. The motivation for this +behaviour is to not confuse administrators who don’t know much about Python and +are trying to install a package. If they get a big long traceback from deep +inside the guts of Distutils, they may think the package or the Python +installation is broken because they don’t read all the way down to the bottom +and see that it’s a permission problem.

    +

    On the other hand, this doesn’t help the developer to find the cause of the +failure. For this purpose, the DISTUTILS_DEBUG environment variable can be set +to anything except an empty string, and distutils will now print detailed +information about what it is doing, dump the full traceback when an exception +occurs, and print the whole command line when an external program (like a C +compiler) fails.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/distutils/sourcedist.html b/python-3.7.4-docs-html/distutils/sourcedist.html new file mode 100644 index 0000000..39dde14 --- /dev/null +++ b/python-3.7.4-docs-html/distutils/sourcedist.html @@ -0,0 +1,403 @@ + + + + + + + 4. Creating a Source Distribution — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    4. Creating a Source Distribution

    +

    As shown in section A Simple Example, you use the sdist command +to create a source distribution. In the simplest case,

    +
    python setup.py sdist
    +
    +
    +

    (assuming you haven’t specified any sdist options in the setup script +or config file), sdist creates the archive of the default format for +the current platform. The default format is a gzip’ed tar file +(.tar.gz) on Unix, and ZIP file on Windows.

    +

    You can specify as many formats as you like using the --formats +option, for example:

    +
    python setup.py sdist --formats=gztar,zip
    +
    +
    +

    to create a gzipped tarball and a zip file. The available formats are:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Format

    Description

    Notes

    zip

    zip file (.zip)

    (1),(3)

    gztar

    gzip’ed tar file +(.tar.gz)

    (2)

    bztar

    bzip2’ed tar file +(.tar.bz2)

    xztar

    xz’ed tar file +(.tar.xz)

    ztar

    compressed tar file +(.tar.Z)

    (4)

    tar

    tar file (.tar)

    +
    +

    Changed in version 3.5: Added support for the xztar format.

    +
    +

    Notes:

    +
      +
    1. default on Windows

    2. +
    3. default on Unix

    4. +
    5. requires either external zip utility or zipfile module (part +of the standard Python library since Python 1.6)

    6. +
    7. requires the compress program. Notice that this format is now +pending for deprecation and will be removed in the future versions of Python.

    8. +
    +

    When using any tar format (gztar, bztar, xztar, ztar or +tar), under Unix you can specify the owner and group names +that will be set for each member of the archive.

    +

    For example, if you want all files of the archive to be owned by root:

    +
    python setup.py sdist --owner=root --group=root
    +
    +
    +
    +

    4.1. Specifying the files to distribute

    +

    If you don’t supply an explicit list of files (or instructions on how to +generate one), the sdist command puts a minimal default set into the +source distribution:

    +
      +
    • all Python source files implied by the py_modules and +packages options

    • +
    • all C source files mentioned in the ext_modules or +libraries options

      +
    • +
    • scripts identified by the scripts option +See Installing Scripts.

    • +
    • anything that looks like a test script: test/test*.py (currently, the +Distutils don’t do anything with test scripts except include them in source +distributions, but in the future there will be a standard for testing Python +module distributions)

    • +
    • Any of the standard README files (README, README.txt, +or README.rst), setup.py (or whatever you called your setup +script), and setup.cfg.

    • +
    • all files that matches the package_data metadata. +See Installing Package Data.

    • +
    • all files that matches the data_files metadata. +See Installing Additional Files.

    • +
    +

    Sometimes this is enough, but usually you will want to specify additional files +to distribute. The typical way to do this is to write a manifest template, +called MANIFEST.in by default. The manifest template is just a list of +instructions for how to generate your manifest file, MANIFEST, which is +the exact list of files to include in your source distribution. The +sdist command processes this template and generates a manifest based +on its instructions and what it finds in the filesystem.

    +

    If you prefer to roll your own manifest file, the format is simple: one filename +per line, regular files (or symlinks to them) only. If you do supply your own +MANIFEST, you must specify everything: the default set of files +described above does not apply in this case.

    +
    +

    Changed in version 3.1: An existing generated MANIFEST will be regenerated without +sdist comparing its modification time to the one of +MANIFEST.in or setup.py.

    +
    +
    +

    Changed in version 3.1.3: MANIFEST files start with a comment indicating they are generated. +Files without this comment are not overwritten or removed.

    +
    +
    +

    Changed in version 3.2.2: sdist will read a MANIFEST file if no MANIFEST.in +exists, like it used to do.

    +
    +
    +

    Changed in version 3.7: README.rst is now included in the list of distutils standard READMEs.

    +
    +

    The manifest template has one command per line, where each command specifies a +set of files to include or exclude from the source distribution. For an +example, again we turn to the Distutils’ own manifest template:

    +
    include *.txt
    +recursive-include examples *.txt *.py
    +prune examples/sample?/build
    +
    +
    +

    The meanings should be fairly clear: include all files in the distribution root +matching *.txt, all files anywhere under the examples directory +matching *.txt or *.py, and exclude all directories matching +examples/sample?/build. All of this is done after the standard +include set, so you can exclude files from the standard set with explicit +instructions in the manifest template. (Or, you can use the +--no-defaults option to disable the standard set entirely.) There are +several other commands available in the manifest template mini-language; see +section Creating a source distribution: the sdist command.

    +

    The order of commands in the manifest template matters: initially, we have the +list of default files as described above, and each command in the template adds +to or removes from that list of files. Once we have fully processed the +manifest template, we remove files that should not be included in the source +distribution:

    +
      +
    • all files in the Distutils “build” tree (default build/)

    • +
    • all files in directories named RCS, CVS, .svn, +.hg, .git, .bzr or _darcs

    • +
    +

    Now we have our complete list of files, which is written to the manifest for +future reference, and then used to build the source distribution archive(s).

    +

    You can disable the default set of included files with the +--no-defaults option, and you can disable the standard exclude set +with --no-prune.

    +

    Following the Distutils’ own manifest template, let’s trace how the +sdist command builds the list of files to include in the Distutils +source distribution:

    +
      +
    1. include all Python source files in the distutils and +distutils/command subdirectories (because packages corresponding to +those two directories were mentioned in the packages option in the +setup script—see section Writing the Setup Script)

    2. +
    3. include README.txt, setup.py, and setup.cfg (standard +files)

    4. +
    5. include test/test*.py (standard files)

    6. +
    7. include *.txt in the distribution root (this will find +README.txt a second time, but such redundancies are weeded out later)

    8. +
    9. include anything matching *.txt or *.py in the sub-tree +under examples,

    10. +
    11. exclude all files in the sub-trees starting at directories matching +examples/sample?/build—this may exclude files included by the +previous two steps, so it’s important that the prune command in the manifest +template comes after the recursive-include command

    12. +
    13. exclude the entire build tree, and any RCS, CVS, +.svn, .hg, .git, .bzr and _darcs +directories

    14. +
    +

    Just like in the setup script, file and directory names in the manifest template +should always be slash-separated; the Distutils will take care of converting +them to the standard representation on your platform. That way, the manifest +template is portable across operating systems.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/distutils/uploading.html b/python-3.7.4-docs-html/distutils/uploading.html new file mode 100644 index 0000000..97b574c --- /dev/null +++ b/python-3.7.4-docs-html/distutils/uploading.html @@ -0,0 +1,161 @@ + + + + + + + Uploading Packages to the Package Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Uploading Packages to the Package Index

    +

    References to up to date PyPI documentation can be found at +Reading the Python Packaging User Guide.

    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/download.html b/python-3.7.4-docs-html/download.html new file mode 100644 index 0000000..dd4be5b --- /dev/null +++ b/python-3.7.4-docs-html/download.html @@ -0,0 +1,198 @@ + + + + + + + Download — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +

    Download Python 3.7.4 Documentation

    + +

    Last updated on: Jul 13, 2019.

    + +

    To download an archive containing all the documents for this version of +Python in one of various formats, follow one of links in this table.

    + + + + + + + + + + + + + + + + + + + + + + + +
    FormatPacked as .zipPacked as .tar.bz2
    PDF (US-Letter paper size)Download (ca. 13 MiB)Download (ca. 13 MiB)
    PDF (A4 paper size)Download (ca. 13 MiB)Download (ca. 13 MiB)
    HTMLDownload (ca. 9 MiB)Download (ca. 6 MiB)
    Plain TextDownload (ca. 3 MiB)Download (ca. 2 MiB)
    EPUBDownload (ca. 5 MiB)
    + +

    These archives contain all the content in the documentation.

    + +

    HTML Help (.chm) files are made available in the "Windows" section +on the Python +download page.

    + + +

    Unpacking

    + +

    Unix users should download the .tar.bz2 archives; these are bzipped tar +archives and can be handled in the usual way using tar and the bzip2 +program. The InfoZIP unzip program can be +used to handle the ZIP archives if desired. The .tar.bz2 archives provide the +best compression and fastest download times.

    + +

    Windows users can use the ZIP archives since those are customary on that +platform. These are created on Unix using the InfoZIP zip program.

    + + +

    Problems

    + +

    If you have comments or suggestions for the Python documentation, please send +email to docs@python.org.

    + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/extending/building.html b/python-3.7.4-docs-html/extending/building.html new file mode 100644 index 0000000..3a5e380 --- /dev/null +++ b/python-3.7.4-docs-html/extending/building.html @@ -0,0 +1,325 @@ + + + + + + + 4. Building C and C++ Extensions — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    4. Building C and C++ Extensions

    +

    A C extension for CPython is a shared library (e.g. a .so file on Linux, +.pyd on Windows), which exports an initialization function.

    +

    To be importable, the shared library must be available on PYTHONPATH, +and must be named after the module name, with an appropriate extension. +When using distutils, the correct filename is generated automatically.

    +

    The initialization function has the signature:

    +
    +
    +PyObject* PyInit_modulename(void)
    +
    + +

    It returns either a fully-initialized module, or a PyModuleDef +instance. See Initializing C modules for details.

    +

    For modules with ASCII-only names, the function must be named +PyInit_<modulename>, with <modulename> replaced by the name of the +module. When using Multi-phase initialization, non-ASCII module names +are allowed. In this case, the initialization function name is +PyInitU_<modulename>, with <modulename> encoded using Python’s +punycode encoding with hyphens replaced by underscores. In Python:

    +
    def initfunc_name(name):
    +    try:
    +        suffix = b'_' + name.encode('ascii')
    +    except UnicodeEncodeError:
    +        suffix = b'U_' + name.encode('punycode').replace(b'-', b'_')
    +    return b'PyInit' + suffix
    +
    +
    +

    It is possible to export multiple modules from a single shared library by +defining multiple initialization functions. However, importing them requires +using symbolic links or a custom importer, because by default only the +function corresponding to the filename is found. +See the “Multiple modules in one library” section in PEP 489 for details.

    +
    +

    4.1. Building C and C++ Extensions with distutils

    +

    Extension modules can be built using distutils, which is included in Python. +Since distutils also supports creation of binary packages, users don’t +necessarily need a compiler and distutils to install the extension.

    +

    A distutils package contains a driver script, setup.py. This is a plain +Python file, which, in the most simple case, could look like this:

    +
    from distutils.core import setup, Extension
    +
    +module1 = Extension('demo',
    +                    sources = ['demo.c'])
    +
    +setup (name = 'PackageName',
    +       version = '1.0',
    +       description = 'This is a demo package',
    +       ext_modules = [module1])
    +
    +
    +

    With this setup.py, and a file demo.c, running

    +
    python setup.py build
    +
    +
    +

    will compile demo.c, and produce an extension module named demo in +the build directory. Depending on the system, the module file will end +up in a subdirectory build/lib.system, and may have a name like +demo.so or demo.pyd.

    +

    In the setup.py, all execution is performed by calling the setup +function. This takes a variable number of keyword arguments, of which the +example above uses only a subset. Specifically, the example specifies +meta-information to build packages, and it specifies the contents of the +package. Normally, a package will contain additional modules, like Python +source modules, documentation, subpackages, etc. Please refer to the distutils +documentation in Distributing Python Modules (Legacy version) to learn more about the features of +distutils; this section explains building extension modules only.

    +

    It is common to pre-compute arguments to setup(), to better structure the +driver script. In the example above, the ext_modules argument to +setup() is a list of extension modules, each of which is +an instance of +the Extension. In the example, the instance +defines an extension named demo which is build by compiling a single source +file, demo.c.

    +

    In many cases, building an extension is more complex, since additional +preprocessor defines and libraries may be needed. This is demonstrated in the +example below.

    +
    from distutils.core import setup, Extension
    +
    +module1 = Extension('demo',
    +                    define_macros = [('MAJOR_VERSION', '1'),
    +                                     ('MINOR_VERSION', '0')],
    +                    include_dirs = ['/usr/local/include'],
    +                    libraries = ['tcl83'],
    +                    library_dirs = ['/usr/local/lib'],
    +                    sources = ['demo.c'])
    +
    +setup (name = 'PackageName',
    +       version = '1.0',
    +       description = 'This is a demo package',
    +       author = 'Martin v. Loewis',
    +       author_email = 'martin@v.loewis.de',
    +       url = 'https://docs.python.org/extending/building',
    +       long_description = '''
    +This is really just a demo package.
    +''',
    +       ext_modules = [module1])
    +
    +
    +

    In this example, setup() is called with additional +meta-information, which +is recommended when distribution packages have to be built. For the extension +itself, it specifies preprocessor defines, include directories, library +directories, and libraries. Depending on the compiler, distutils passes this +information in different ways to the compiler. For example, on Unix, this may +result in the compilation commands

    +
    gcc -DNDEBUG -g -O3 -Wall -Wstrict-prototypes -fPIC -DMAJOR_VERSION=1 -DMINOR_VERSION=0 -I/usr/local/include -I/usr/local/include/python2.2 -c demo.c -o build/temp.linux-i686-2.2/demo.o
    +
    +gcc -shared build/temp.linux-i686-2.2/demo.o -L/usr/local/lib -ltcl83 -o build/lib.linux-i686-2.2/demo.so
    +
    +
    +

    These lines are for demonstration purposes only; distutils users should trust +that distutils gets the invocations right.

    +
    +
    +

    4.2. Distributing your extension modules

    +

    When an extension has been successfully build, there are three ways to use it.

    +

    End-users will typically want to install the module, they do so by running

    +
    python setup.py install
    +
    +
    +

    Module maintainers should produce source packages; to do so, they run

    +
    python setup.py sdist
    +
    +
    +

    In some cases, additional files need to be included in a source distribution; +this is done through a MANIFEST.in file; see Specifying the files to distribute for details.

    +

    If the source distribution has been build successfully, maintainers can also +create binary distributions. Depending on the platform, one of the following +commands can be used to do so.

    +
    python setup.py bdist_wininst
    +python setup.py bdist_rpm
    +python setup.py bdist_dumb
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/extending/embedding.html b/python-3.7.4-docs-html/extending/embedding.html new file mode 100644 index 0000000..ba5269d --- /dev/null +++ b/python-3.7.4-docs-html/extending/embedding.html @@ -0,0 +1,543 @@ + + + + + + + 1. Embedding Python in Another Application — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    1. Embedding Python in Another Application

    +

    The previous chapters discussed how to extend Python, that is, how to extend the +functionality of Python by attaching a library of C functions to it. It is also +possible to do it the other way around: enrich your C/C++ application by +embedding Python in it. Embedding provides your application with the ability to +implement some of the functionality of your application in Python rather than C +or C++. This can be used for many purposes; one example would be to allow users +to tailor the application to their needs by writing some scripts in Python. You +can also use it yourself if some of the functionality can be written in Python +more easily.

    +

    Embedding Python is similar to extending it, but not quite. The difference is +that when you extend Python, the main program of the application is still the +Python interpreter, while if you embed Python, the main program may have nothing +to do with Python — instead, some parts of the application occasionally call +the Python interpreter to run some Python code.

    +

    So if you are embedding Python, you are providing your own main program. One of +the things this main program has to do is initialize the Python interpreter. At +the very least, you have to call the function Py_Initialize(). There are +optional calls to pass command line arguments to Python. Then later you can +call the interpreter from any part of the application.

    +

    There are several different ways to call the interpreter: you can pass a string +containing Python statements to PyRun_SimpleString(), or you can pass a +stdio file pointer and a file name (for identification in error messages only) +to PyRun_SimpleFile(). You can also call the lower-level operations +described in the previous chapters to construct and use Python objects.

    +
    +

    See also

    +
    +
    Python/C API Reference Manual

    The details of Python’s C interface are given in this manual. A great deal of +necessary information can be found here.

    +
    +
    +
    +
    +

    1.1. Very High Level Embedding

    +

    The simplest form of embedding Python is the use of the very high level +interface. This interface is intended to execute a Python script without needing +to interact with the application directly. This can for example be used to +perform some operation on a file.

    +
    #define PY_SSIZE_T_CLEAN
    +#include <Python.h>
    +
    +int
    +main(int argc, char *argv[])
    +{
    +    wchar_t *program = Py_DecodeLocale(argv[0], NULL);
    +    if (program == NULL) {
    +        fprintf(stderr, "Fatal error: cannot decode argv[0]\n");
    +        exit(1);
    +    }
    +    Py_SetProgramName(program);  /* optional but recommended */
    +    Py_Initialize();
    +    PyRun_SimpleString("from time import time,ctime\n"
    +                       "print('Today is', ctime(time()))\n");
    +    if (Py_FinalizeEx() < 0) {
    +        exit(120);
    +    }
    +    PyMem_RawFree(program);
    +    return 0;
    +}
    +
    +
    +

    The Py_SetProgramName() function should be called before +Py_Initialize() to inform the interpreter about paths to Python run-time +libraries. Next, the Python interpreter is initialized with +Py_Initialize(), followed by the execution of a hard-coded Python script +that prints the date and time. Afterwards, the Py_FinalizeEx() call shuts +the interpreter down, followed by the end of the program. In a real program, +you may want to get the Python script from another source, perhaps a text-editor +routine, a file, or a database. Getting the Python code from a file can better +be done by using the PyRun_SimpleFile() function, which saves you the +trouble of allocating memory space and loading the file contents.

    +
    +
    +

    1.2. Beyond Very High Level Embedding: An overview

    +

    The high level interface gives you the ability to execute arbitrary pieces of +Python code from your application, but exchanging data values is quite +cumbersome to say the least. If you want that, you should use lower level calls. +At the cost of having to write more C code, you can achieve almost anything.

    +

    It should be noted that extending Python and embedding Python is quite the same +activity, despite the different intent. Most topics discussed in the previous +chapters are still valid. To show this, consider what the extension code from +Python to C really does:

    +
      +
    1. Convert data values from Python to C,

    2. +
    3. Perform a function call to a C routine using the converted values, and

    4. +
    5. Convert the data values from the call from C to Python.

    6. +
    +

    When embedding Python, the interface code does:

    +
      +
    1. Convert data values from C to Python,

    2. +
    3. Perform a function call to a Python interface routine using the converted +values, and

    4. +
    5. Convert the data values from the call from Python to C.

    6. +
    +

    As you can see, the data conversion steps are simply swapped to accommodate the +different direction of the cross-language transfer. The only difference is the +routine that you call between both data conversions. When extending, you call a +C routine, when embedding, you call a Python routine.

    +

    This chapter will not discuss how to convert data from Python to C and vice +versa. Also, proper use of references and dealing with errors is assumed to be +understood. Since these aspects do not differ from extending the interpreter, +you can refer to earlier chapters for the required information.

    +
    +
    +

    1.3. Pure Embedding

    +

    The first program aims to execute a function in a Python script. Like in the +section about the very high level interface, the Python interpreter does not +directly interact with the application (but that will change in the next +section).

    +

    The code to run a function defined in a Python script is:

    +
    #define PY_SSIZE_T_CLEAN
    +#include <Python.h>
    +
    +int
    +main(int argc, char *argv[])
    +{
    +    PyObject *pName, *pModule, *pFunc;
    +    PyObject *pArgs, *pValue;
    +    int i;
    +
    +    if (argc < 3) {
    +        fprintf(stderr,"Usage: call pythonfile funcname [args]\n");
    +        return 1;
    +    }
    +
    +    Py_Initialize();
    +    pName = PyUnicode_DecodeFSDefault(argv[1]);
    +    /* Error checking of pName left out */
    +
    +    pModule = PyImport_Import(pName);
    +    Py_DECREF(pName);
    +
    +    if (pModule != NULL) {
    +        pFunc = PyObject_GetAttrString(pModule, argv[2]);
    +        /* pFunc is a new reference */
    +
    +        if (pFunc && PyCallable_Check(pFunc)) {
    +            pArgs = PyTuple_New(argc - 3);
    +            for (i = 0; i < argc - 3; ++i) {
    +                pValue = PyLong_FromLong(atoi(argv[i + 3]));
    +                if (!pValue) {
    +                    Py_DECREF(pArgs);
    +                    Py_DECREF(pModule);
    +                    fprintf(stderr, "Cannot convert argument\n");
    +                    return 1;
    +                }
    +                /* pValue reference stolen here: */
    +                PyTuple_SetItem(pArgs, i, pValue);
    +            }
    +            pValue = PyObject_CallObject(pFunc, pArgs);
    +            Py_DECREF(pArgs);
    +            if (pValue != NULL) {
    +                printf("Result of call: %ld\n", PyLong_AsLong(pValue));
    +                Py_DECREF(pValue);
    +            }
    +            else {
    +                Py_DECREF(pFunc);
    +                Py_DECREF(pModule);
    +                PyErr_Print();
    +                fprintf(stderr,"Call failed\n");
    +                return 1;
    +            }
    +        }
    +        else {
    +            if (PyErr_Occurred())
    +                PyErr_Print();
    +            fprintf(stderr, "Cannot find function \"%s\"\n", argv[2]);
    +        }
    +        Py_XDECREF(pFunc);
    +        Py_DECREF(pModule);
    +    }
    +    else {
    +        PyErr_Print();
    +        fprintf(stderr, "Failed to load \"%s\"\n", argv[1]);
    +        return 1;
    +    }
    +    if (Py_FinalizeEx() < 0) {
    +        return 120;
    +    }
    +    return 0;
    +}
    +
    +
    +

    This code loads a Python script using argv[1], and calls the function named +in argv[2]. Its integer arguments are the other values of the argv +array. If you compile and link this program (let’s call +the finished executable call), and use it to execute a Python +script, such as:

    +
    def multiply(a,b):
    +    print("Will compute", a, "times", b)
    +    c = 0
    +    for i in range(0, a):
    +        c = c + b
    +    return c
    +
    +
    +

    then the result should be:

    +
    $ call multiply multiply 3 2
    +Will compute 3 times 2
    +Result of call: 6
    +
    +
    +

    Although the program is quite large for its functionality, most of the code is +for data conversion between Python and C, and for error reporting. The +interesting part with respect to embedding Python starts with

    +
    Py_Initialize();
    +pName = PyUnicode_DecodeFSDefault(argv[1]);
    +/* Error checking of pName left out */
    +pModule = PyImport_Import(pName);
    +
    +
    +

    After initializing the interpreter, the script is loaded using +PyImport_Import(). This routine needs a Python string as its argument, +which is constructed using the PyUnicode_FromString() data conversion +routine.

    +
    pFunc = PyObject_GetAttrString(pModule, argv[2]);
    +/* pFunc is a new reference */
    +
    +if (pFunc && PyCallable_Check(pFunc)) {
    +    ...
    +}
    +Py_XDECREF(pFunc);
    +
    +
    +

    Once the script is loaded, the name we’re looking for is retrieved using +PyObject_GetAttrString(). If the name exists, and the object returned is +callable, you can safely assume that it is a function. The program then +proceeds by constructing a tuple of arguments as normal. The call to the Python +function is then made with:

    +
    pValue = PyObject_CallObject(pFunc, pArgs);
    +
    +
    +

    Upon return of the function, pValue is either NULL or it contains a +reference to the return value of the function. Be sure to release the reference +after examining the value.

    +
    +
    +

    1.4. Extending Embedded Python

    +

    Until now, the embedded Python interpreter had no access to functionality from +the application itself. The Python API allows this by extending the embedded +interpreter. That is, the embedded interpreter gets extended with routines +provided by the application. While it sounds complex, it is not so bad. Simply +forget for a while that the application starts the Python interpreter. Instead, +consider the application to be a set of subroutines, and write some glue code +that gives Python access to those routines, just like you would write a normal +Python extension. For example:

    +
    static int numargs=0;
    +
    +/* Return the number of arguments of the application command line */
    +static PyObject*
    +emb_numargs(PyObject *self, PyObject *args)
    +{
    +    if(!PyArg_ParseTuple(args, ":numargs"))
    +        return NULL;
    +    return PyLong_FromLong(numargs);
    +}
    +
    +static PyMethodDef EmbMethods[] = {
    +    {"numargs", emb_numargs, METH_VARARGS,
    +     "Return the number of arguments received by the process."},
    +    {NULL, NULL, 0, NULL}
    +};
    +
    +static PyModuleDef EmbModule = {
    +    PyModuleDef_HEAD_INIT, "emb", NULL, -1, EmbMethods,
    +    NULL, NULL, NULL, NULL
    +};
    +
    +static PyObject*
    +PyInit_emb(void)
    +{
    +    return PyModule_Create(&EmbModule);
    +}
    +
    +
    +

    Insert the above code just above the main() function. Also, insert the +following two statements before the call to Py_Initialize():

    +
    numargs = argc;
    +PyImport_AppendInittab("emb", &PyInit_emb);
    +
    +
    +

    These two lines initialize the numargs variable, and make the +emb.numargs() function accessible to the embedded Python interpreter. +With these extensions, the Python script can do things like

    +
    import emb
    +print("Number of arguments", emb.numargs())
    +
    +
    +

    In a real application, the methods will expose an API of the application to +Python.

    +
    +
    +

    1.5. Embedding Python in C++

    +

    It is also possible to embed Python in a C++ program; precisely how this is done +will depend on the details of the C++ system used; in general you will need to +write the main program in C++, and use the C++ compiler to compile and link your +program. There is no need to recompile Python itself using C++.

    +
    +
    +

    1.6. Compiling and Linking under Unix-like systems

    +

    It is not necessarily trivial to find the right flags to pass to your +compiler (and linker) in order to embed the Python interpreter into your +application, particularly because Python needs to load library modules +implemented as C dynamic extensions (.so files) linked against +it.

    +

    To find out the required compiler and linker flags, you can execute the +pythonX.Y-config script which is generated as part of the +installation process (a python3-config script may also be +available). This script has several options, of which the following will +be directly useful to you:

    +
      +
    • pythonX.Y-config --cflags will give you the recommended flags when +compiling:

      +
      $ /opt/bin/python3.4-config --cflags
      +-I/opt/include/python3.4m -I/opt/include/python3.4m -DNDEBUG -g -fwrapv -O3 -Wall -Wstrict-prototypes
      +
      +
      +
    • +
    • pythonX.Y-config --ldflags will give you the recommended flags when +linking:

      +
      $ /opt/bin/python3.4-config --ldflags
      +-L/opt/lib/python3.4/config-3.4m -lpthread -ldl -lutil -lm -lpython3.4m -Xlinker -export-dynamic
      +
      +
      +
    • +
    +
    +

    Note

    +

    To avoid confusion between several Python installations (and especially +between the system Python and your own compiled Python), it is recommended +that you use the absolute path to pythonX.Y-config, as in the above +example.

    +
    +

    If this procedure doesn’t work for you (it is not guaranteed to work for +all Unix-like platforms; however, we welcome bug reports) +you will have to read your system’s documentation about dynamic linking and/or +examine Python’s Makefile (use sysconfig.get_makefile_filename() +to find its location) and compilation +options. In this case, the sysconfig module is a useful tool to +programmatically extract the configuration values that you will want to +combine together. For example:

    +
    >>> import sysconfig
    +>>> sysconfig.get_config_var('LIBS')
    +'-lpthread -ldl  -lutil'
    +>>> sysconfig.get_config_var('LINKFORSHARED')
    +'-Xlinker -export-dynamic'
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/extending/extending.html b/python-3.7.4-docs-html/extending/extending.html new file mode 100644 index 0000000..b132a02 --- /dev/null +++ b/python-3.7.4-docs-html/extending/extending.html @@ -0,0 +1,1395 @@ + + + + + + + 1. Extending Python with C or C++ — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    1. Extending Python with C or C++

    +

    It is quite easy to add new built-in modules to Python, if you know how to +program in C. Such extension modules can do two things that can’t be +done directly in Python: they can implement new built-in object types, and they +can call C library functions and system calls.

    +

    To support extensions, the Python API (Application Programmers Interface) +defines a set of functions, macros and variables that provide access to most +aspects of the Python run-time system. The Python API is incorporated in a C +source file by including the header "Python.h".

    +

    The compilation of an extension module depends on its intended use as well as on +your system setup; details are given in later chapters.

    +
    +

    Note

    +

    The C extension interface is specific to CPython, and extension modules do +not work on other Python implementations. In many cases, it is possible to +avoid writing C extensions and preserve portability to other implementations. +For example, if your use case is calling C library functions or system calls, +you should consider using the ctypes module or the cffi library rather than writing +custom C code. +These modules let you write Python code to interface with C code and are more +portable between implementations of Python than writing and compiling a C +extension module.

    +
    +
    +

    1.1. A Simple Example

    +

    Let’s create an extension module called spam (the favorite food of Monty +Python fans…) and let’s say we want to create a Python interface to the C +library function system() 1. This function takes a null-terminated +character string as argument and returns an integer. We want this function to +be callable from Python as follows:

    +
    >>> import spam
    +>>> status = spam.system("ls -l")
    +
    +
    +

    Begin by creating a file spammodule.c. (Historically, if a module is +called spam, the C file containing its implementation is called +spammodule.c; if the module name is very long, like spammify, the +module name can be just spammify.c.)

    +

    The first two lines of our file can be:

    +
    #define PY_SSIZE_T_CLEAN
    +#include <Python.h>
    +
    +
    +

    which pulls in the Python API (you can add a comment describing the purpose of +the module and a copyright notice if you like).

    +
    +

    Note

    +

    Since Python may define some pre-processor definitions which affect the standard +headers on some systems, you must include Python.h before any standard +headers are included.

    +

    It is recommended to always define PY_SSIZE_T_CLEAN before including +Python.h. See Extracting Parameters in Extension Functions for a description of this macro.

    +
    +

    All user-visible symbols defined by Python.h have a prefix of Py or +PY, except those defined in standard header files. For convenience, and +since they are used extensively by the Python interpreter, "Python.h" +includes a few standard header files: <stdio.h>, <string.h>, +<errno.h>, and <stdlib.h>. If the latter header file does not exist on +your system, it declares the functions malloc(), free() and +realloc() directly.

    +

    The next thing we add to our module file is the C function that will be called +when the Python expression spam.system(string) is evaluated (we’ll see +shortly how it ends up being called):

    +
    static PyObject *
    +spam_system(PyObject *self, PyObject *args)
    +{
    +    const char *command;
    +    int sts;
    +
    +    if (!PyArg_ParseTuple(args, "s", &command))
    +        return NULL;
    +    sts = system(command);
    +    return PyLong_FromLong(sts);
    +}
    +
    +
    +

    There is a straightforward translation from the argument list in Python (for +example, the single expression "ls -l") to the arguments passed to the C +function. The C function always has two arguments, conventionally named self +and args.

    +

    The self argument points to the module object for module-level functions; +for a method it would point to the object instance.

    +

    The args argument will be a pointer to a Python tuple object containing the +arguments. Each item of the tuple corresponds to an argument in the call’s +argument list. The arguments are Python objects — in order to do anything +with them in our C function we have to convert them to C values. The function +PyArg_ParseTuple() in the Python API checks the argument types and +converts them to C values. It uses a template string to determine the required +types of the arguments as well as the types of the C variables into which to +store the converted values. More about this later.

    +

    PyArg_ParseTuple() returns true (nonzero) if all arguments have the right +type and its components have been stored in the variables whose addresses are +passed. It returns false (zero) if an invalid argument list was passed. In the +latter case it also raises an appropriate exception so the calling function can +return NULL immediately (as we saw in the example).

    +
    +
    +

    1.2. Intermezzo: Errors and Exceptions

    +

    An important convention throughout the Python interpreter is the following: when +a function fails, it should set an exception condition and return an error value +(usually a NULL pointer). Exceptions are stored in a static global variable +inside the interpreter; if this variable is NULL no exception has occurred. A +second global variable stores the “associated value” of the exception (the +second argument to raise). A third variable contains the stack +traceback in case the error originated in Python code. These three variables +are the C equivalents of the result in Python of sys.exc_info() (see the +section on module sys in the Python Library Reference). It is important +to know about them to understand how errors are passed around.

    +

    The Python API defines a number of functions to set various types of exceptions.

    +

    The most common one is PyErr_SetString(). Its arguments are an exception +object and a C string. The exception object is usually a predefined object like +PyExc_ZeroDivisionError. The C string indicates the cause of the error +and is converted to a Python string object and stored as the “associated value” +of the exception.

    +

    Another useful function is PyErr_SetFromErrno(), which only takes an +exception argument and constructs the associated value by inspection of the +global variable errno. The most general function is +PyErr_SetObject(), which takes two object arguments, the exception and +its associated value. You don’t need to Py_INCREF() the objects passed +to any of these functions.

    +

    You can test non-destructively whether an exception has been set with +PyErr_Occurred(). This returns the current exception object, or NULL +if no exception has occurred. You normally don’t need to call +PyErr_Occurred() to see whether an error occurred in a function call, +since you should be able to tell from the return value.

    +

    When a function f that calls another function g detects that the latter +fails, f should itself return an error value (usually NULL or -1). It +should not call one of the PyErr_*() functions — one has already +been called by g. f’s caller is then supposed to also return an error +indication to its caller, again without calling PyErr_*(), and so on +— the most detailed cause of the error was already reported by the function +that first detected it. Once the error reaches the Python interpreter’s main +loop, this aborts the currently executing Python code and tries to find an +exception handler specified by the Python programmer.

    +

    (There are situations where a module can actually give a more detailed error +message by calling another PyErr_*() function, and in such cases it is +fine to do so. As a general rule, however, this is not necessary, and can cause +information about the cause of the error to be lost: most operations can fail +for a variety of reasons.)

    +

    To ignore an exception set by a function call that failed, the exception +condition must be cleared explicitly by calling PyErr_Clear(). The only +time C code should call PyErr_Clear() is if it doesn’t want to pass the +error on to the interpreter but wants to handle it completely by itself +(possibly by trying something else, or pretending nothing went wrong).

    +

    Every failing malloc() call must be turned into an exception — the +direct caller of malloc() (or realloc()) must call +PyErr_NoMemory() and return a failure indicator itself. All the +object-creating functions (for example, PyLong_FromLong()) already do +this, so this note is only relevant to those who call malloc() directly.

    +

    Also note that, with the important exception of PyArg_ParseTuple() and +friends, functions that return an integer status usually return a positive value +or zero for success and -1 for failure, like Unix system calls.

    +

    Finally, be careful to clean up garbage (by making Py_XDECREF() or +Py_DECREF() calls for objects you have already created) when you return +an error indicator!

    +

    The choice of which exception to raise is entirely yours. There are predeclared +C objects corresponding to all built-in Python exceptions, such as +PyExc_ZeroDivisionError, which you can use directly. Of course, you +should choose exceptions wisely — don’t use PyExc_TypeError to mean +that a file couldn’t be opened (that should probably be PyExc_IOError). +If something’s wrong with the argument list, the PyArg_ParseTuple() +function usually raises PyExc_TypeError. If you have an argument whose +value must be in a particular range or must satisfy other conditions, +PyExc_ValueError is appropriate.

    +

    You can also define a new exception that is unique to your module. For this, you +usually declare a static object variable at the beginning of your file:

    +
    static PyObject *SpamError;
    +
    +
    +

    and initialize it in your module’s initialization function (PyInit_spam()) +with an exception object (leaving out the error checking for now):

    +
    PyMODINIT_FUNC
    +PyInit_spam(void)
    +{
    +    PyObject *m;
    +
    +    m = PyModule_Create(&spammodule);
    +    if (m == NULL)
    +        return NULL;
    +
    +    SpamError = PyErr_NewException("spam.error", NULL, NULL);
    +    Py_INCREF(SpamError);
    +    PyModule_AddObject(m, "error", SpamError);
    +    return m;
    +}
    +
    +
    +

    Note that the Python name for the exception object is spam.error. The +PyErr_NewException() function may create a class with the base class +being Exception (unless another class is passed in instead of NULL), +described in Built-in Exceptions.

    +

    Note also that the SpamError variable retains a reference to the newly +created exception class; this is intentional! Since the exception could be +removed from the module by external code, an owned reference to the class is +needed to ensure that it will not be discarded, causing SpamError to +become a dangling pointer. Should it become a dangling pointer, C code which +raises the exception could cause a core dump or other unintended side effects.

    +

    We discuss the use of PyMODINIT_FUNC as a function return type later in this +sample.

    +

    The spam.error exception can be raised in your extension module using a +call to PyErr_SetString() as shown below:

    +
    static PyObject *
    +spam_system(PyObject *self, PyObject *args)
    +{
    +    const char *command;
    +    int sts;
    +
    +    if (!PyArg_ParseTuple(args, "s", &command))
    +        return NULL;
    +    sts = system(command);
    +    if (sts < 0) {
    +        PyErr_SetString(SpamError, "System command failed");
    +        return NULL;
    +    }
    +    return PyLong_FromLong(sts);
    +}
    +
    +
    +
    +
    +

    1.3. Back to the Example

    +

    Going back to our example function, you should now be able to understand this +statement:

    +
    if (!PyArg_ParseTuple(args, "s", &command))
    +    return NULL;
    +
    +
    +

    It returns NULL (the error indicator for functions returning object pointers) +if an error is detected in the argument list, relying on the exception set by +PyArg_ParseTuple(). Otherwise the string value of the argument has been +copied to the local variable command. This is a pointer assignment and +you are not supposed to modify the string to which it points (so in Standard C, +the variable command should properly be declared as const char +*command).

    +

    The next statement is a call to the Unix function system(), passing it +the string we just got from PyArg_ParseTuple():

    +
    sts = system(command);
    +
    +
    +

    Our spam.system() function must return the value of sts as a +Python object. This is done using the function PyLong_FromLong().

    +
    return PyLong_FromLong(sts);
    +
    +
    +

    In this case, it will return an integer object. (Yes, even integers are objects +on the heap in Python!)

    +

    If you have a C function that returns no useful argument (a function returning +void), the corresponding Python function must return None. You +need this idiom to do so (which is implemented by the Py_RETURN_NONE +macro):

    +
    Py_INCREF(Py_None);
    +return Py_None;
    +
    +
    +

    Py_None is the C name for the special Python object None. It is a +genuine Python object rather than a NULL pointer, which means “error” in most +contexts, as we have seen.

    +
    +
    +

    1.4. The Module’s Method Table and Initialization Function

    +

    I promised to show how spam_system() is called from Python programs. +First, we need to list its name and address in a “method table”:

    +
    static PyMethodDef SpamMethods[] = {
    +    ...
    +    {"system",  spam_system, METH_VARARGS,
    +     "Execute a shell command."},
    +    ...
    +    {NULL, NULL, 0, NULL}        /* Sentinel */
    +};
    +
    +
    +

    Note the third entry (METH_VARARGS). This is a flag telling the interpreter +the calling convention to be used for the C function. It should normally always +be METH_VARARGS or METH_VARARGS | METH_KEYWORDS; a value of 0 means +that an obsolete variant of PyArg_ParseTuple() is used.

    +

    When using only METH_VARARGS, the function should expect the Python-level +parameters to be passed in as a tuple acceptable for parsing via +PyArg_ParseTuple(); more information on this function is provided below.

    +

    The METH_KEYWORDS bit may be set in the third field if keyword +arguments should be passed to the function. In this case, the C function should +accept a third PyObject * parameter which will be a dictionary of keywords. +Use PyArg_ParseTupleAndKeywords() to parse the arguments to such a +function.

    +

    The method table must be referenced in the module definition structure:

    +
    static struct PyModuleDef spammodule = {
    +    PyModuleDef_HEAD_INIT,
    +    "spam",   /* name of module */
    +    spam_doc, /* module documentation, may be NULL */
    +    -1,       /* size of per-interpreter state of the module,
    +                 or -1 if the module keeps state in global variables. */
    +    SpamMethods
    +};
    +
    +
    +

    This structure, in turn, must be passed to the interpreter in the module’s +initialization function. The initialization function must be named +PyInit_name(), where name is the name of the module, and should be the +only non-static item defined in the module file:

    +
    PyMODINIT_FUNC
    +PyInit_spam(void)
    +{
    +    return PyModule_Create(&spammodule);
    +}
    +
    +
    +

    Note that PyMODINIT_FUNC declares the function as PyObject * return type, +declares any special linkage declarations required by the platform, and for C++ +declares the function as extern "C".

    +

    When the Python program imports module spam for the first time, +PyInit_spam() is called. (See below for comments about embedding Python.) +It calls PyModule_Create(), which returns a module object, and +inserts built-in function objects into the newly created module based upon the +table (an array of PyMethodDef structures) found in the module definition. +PyModule_Create() returns a pointer to the module object +that it creates. It may abort with a fatal error for +certain errors, or return NULL if the module could not be initialized +satisfactorily. The init function must return the module object to its caller, +so that it then gets inserted into sys.modules.

    +

    When embedding Python, the PyInit_spam() function is not called +automatically unless there’s an entry in the PyImport_Inittab table. +To add the module to the initialization table, use PyImport_AppendInittab(), +optionally followed by an import of the module:

    +
    int
    +main(int argc, char *argv[])
    +{
    +    wchar_t *program = Py_DecodeLocale(argv[0], NULL);
    +    if (program == NULL) {
    +        fprintf(stderr, "Fatal error: cannot decode argv[0]\n");
    +        exit(1);
    +    }
    +
    +    /* Add a built-in module, before Py_Initialize */
    +    PyImport_AppendInittab("spam", PyInit_spam);
    +
    +    /* Pass argv[0] to the Python interpreter */
    +    Py_SetProgramName(program);
    +
    +    /* Initialize the Python interpreter.  Required. */
    +    Py_Initialize();
    +
    +    /* Optionally import the module; alternatively,
    +       import can be deferred until the embedded script
    +       imports it. */
    +    PyImport_ImportModule("spam");
    +
    +    ...
    +
    +    PyMem_RawFree(program);
    +    return 0;
    +}
    +
    +
    +
    +

    Note

    +

    Removing entries from sys.modules or importing compiled modules into +multiple interpreters within a process (or following a fork() without an +intervening exec()) can create problems for some extension modules. +Extension module authors should exercise caution when initializing internal data +structures.

    +
    +

    A more substantial example module is included in the Python source distribution +as Modules/xxmodule.c. This file may be used as a template or simply +read as an example.

    +
    +

    Note

    +

    Unlike our spam example, xxmodule uses multi-phase initialization +(new in Python 3.5), where a PyModuleDef structure is returned from +PyInit_spam, and creation of the module is left to the import machinery. +For details on multi-phase initialization, see PEP 489.

    +
    +
    +
    +

    1.5. Compilation and Linkage

    +

    There are two more things to do before you can use your new extension: compiling +and linking it with the Python system. If you use dynamic loading, the details +may depend on the style of dynamic loading your system uses; see the chapters +about building extension modules (chapter Building C and C++ Extensions) and additional +information that pertains only to building on Windows (chapter +Building C and C++ Extensions on Windows) for more information about this.

    +

    If you can’t use dynamic loading, or if you want to make your module a permanent +part of the Python interpreter, you will have to change the configuration setup +and rebuild the interpreter. Luckily, this is very simple on Unix: just place +your file (spammodule.c for example) in the Modules/ directory +of an unpacked source distribution, add a line to the file +Modules/Setup.local describing your file:

    +
    spam spammodule.o
    +
    +
    +

    and rebuild the interpreter by running make in the toplevel +directory. You can also run make in the Modules/ +subdirectory, but then you must first rebuild Makefile there by running +‘make Makefile’. (This is necessary each time you change the +Setup file.)

    +

    If your module requires additional libraries to link with, these can be listed +on the line in the configuration file as well, for instance:

    +
    spam spammodule.o -lX11
    +
    +
    +
    +
    +

    1.6. Calling Python Functions from C

    +

    So far we have concentrated on making C functions callable from Python. The +reverse is also useful: calling Python functions from C. This is especially the +case for libraries that support so-called “callback” functions. If a C +interface makes use of callbacks, the equivalent Python often needs to provide a +callback mechanism to the Python programmer; the implementation will require +calling the Python callback functions from a C callback. Other uses are also +imaginable.

    +

    Fortunately, the Python interpreter is easily called recursively, and there is a +standard interface to call a Python function. (I won’t dwell on how to call the +Python parser with a particular string as input — if you’re interested, have a +look at the implementation of the -c command line option in +Modules/main.c from the Python source code.)

    +

    Calling a Python function is easy. First, the Python program must somehow pass +you the Python function object. You should provide a function (or some other +interface) to do this. When this function is called, save a pointer to the +Python function object (be careful to Py_INCREF() it!) in a global +variable — or wherever you see fit. For example, the following function might +be part of a module definition:

    +
    static PyObject *my_callback = NULL;
    +
    +static PyObject *
    +my_set_callback(PyObject *dummy, PyObject *args)
    +{
    +    PyObject *result = NULL;
    +    PyObject *temp;
    +
    +    if (PyArg_ParseTuple(args, "O:set_callback", &temp)) {
    +        if (!PyCallable_Check(temp)) {
    +            PyErr_SetString(PyExc_TypeError, "parameter must be callable");
    +            return NULL;
    +        }
    +        Py_XINCREF(temp);         /* Add a reference to new callback */
    +        Py_XDECREF(my_callback);  /* Dispose of previous callback */
    +        my_callback = temp;       /* Remember new callback */
    +        /* Boilerplate to return "None" */
    +        Py_INCREF(Py_None);
    +        result = Py_None;
    +    }
    +    return result;
    +}
    +
    +
    +

    This function must be registered with the interpreter using the +METH_VARARGS flag; this is described in section The Module’s Method Table and Initialization Function. The +PyArg_ParseTuple() function and its arguments are documented in section +Extracting Parameters in Extension Functions.

    +

    The macros Py_XINCREF() and Py_XDECREF() increment/decrement the +reference count of an object and are safe in the presence of NULL pointers +(but note that temp will not be NULL in this context). More info on them +in section Reference Counts.

    +

    Later, when it is time to call the function, you call the C function +PyObject_CallObject(). This function has two arguments, both pointers to +arbitrary Python objects: the Python function, and the argument list. The +argument list must always be a tuple object, whose length is the number of +arguments. To call the Python function with no arguments, pass in NULL, or +an empty tuple; to call it with one argument, pass a singleton tuple. +Py_BuildValue() returns a tuple when its format string consists of zero +or more format codes between parentheses. For example:

    +
    int arg;
    +PyObject *arglist;
    +PyObject *result;
    +...
    +arg = 123;
    +...
    +/* Time to call the callback */
    +arglist = Py_BuildValue("(i)", arg);
    +result = PyObject_CallObject(my_callback, arglist);
    +Py_DECREF(arglist);
    +
    +
    +

    PyObject_CallObject() returns a Python object pointer: this is the return +value of the Python function. PyObject_CallObject() is +“reference-count-neutral” with respect to its arguments. In the example a new +tuple was created to serve as the argument list, which is +Py_DECREF()-ed immediately after the PyObject_CallObject() +call.

    +

    The return value of PyObject_CallObject() is “new”: either it is a brand +new object, or it is an existing object whose reference count has been +incremented. So, unless you want to save it in a global variable, you should +somehow Py_DECREF() the result, even (especially!) if you are not +interested in its value.

    +

    Before you do this, however, it is important to check that the return value +isn’t NULL. If it is, the Python function terminated by raising an exception. +If the C code that called PyObject_CallObject() is called from Python, it +should now return an error indication to its Python caller, so the interpreter +can print a stack trace, or the calling Python code can handle the exception. +If this is not possible or desirable, the exception should be cleared by calling +PyErr_Clear(). For example:

    +
    if (result == NULL)
    +    return NULL; /* Pass error back */
    +...use result...
    +Py_DECREF(result);
    +
    +
    +

    Depending on the desired interface to the Python callback function, you may also +have to provide an argument list to PyObject_CallObject(). In some cases +the argument list is also provided by the Python program, through the same +interface that specified the callback function. It can then be saved and used +in the same manner as the function object. In other cases, you may have to +construct a new tuple to pass as the argument list. The simplest way to do this +is to call Py_BuildValue(). For example, if you want to pass an integral +event code, you might use the following code:

    +
    PyObject *arglist;
    +...
    +arglist = Py_BuildValue("(l)", eventcode);
    +result = PyObject_CallObject(my_callback, arglist);
    +Py_DECREF(arglist);
    +if (result == NULL)
    +    return NULL; /* Pass error back */
    +/* Here maybe use the result */
    +Py_DECREF(result);
    +
    +
    +

    Note the placement of Py_DECREF(arglist) immediately after the call, before +the error check! Also note that strictly speaking this code is not complete: +Py_BuildValue() may run out of memory, and this should be checked.

    +

    You may also call a function with keyword arguments by using +PyObject_Call(), which supports arguments and keyword arguments. As in +the above example, we use Py_BuildValue() to construct the dictionary.

    +
    PyObject *dict;
    +...
    +dict = Py_BuildValue("{s:i}", "name", val);
    +result = PyObject_Call(my_callback, NULL, dict);
    +Py_DECREF(dict);
    +if (result == NULL)
    +    return NULL; /* Pass error back */
    +/* Here maybe use the result */
    +Py_DECREF(result);
    +
    +
    +
    +
    +

    1.7. Extracting Parameters in Extension Functions

    +

    The PyArg_ParseTuple() function is declared as follows:

    +
    int PyArg_ParseTuple(PyObject *arg, const char *format, ...);
    +
    +
    +

    The arg argument must be a tuple object containing an argument list passed +from Python to a C function. The format argument must be a format string, +whose syntax is explained in Parsing arguments and building values in the Python/C API Reference +Manual. The remaining arguments must be addresses of variables whose type is +determined by the format string.

    +

    Note that while PyArg_ParseTuple() checks that the Python arguments have +the required types, it cannot check the validity of the addresses of C variables +passed to the call: if you make mistakes there, your code will probably crash or +at least overwrite random bits in memory. So be careful!

    +

    Note that any Python object references which are provided to the caller are +borrowed references; do not decrement their reference count!

    +

    Some example calls:

    +
    #define PY_SSIZE_T_CLEAN  /* Make "s#" use Py_ssize_t rather than int. */
    +#include <Python.h>
    +
    +
    +
    int ok;
    +int i, j;
    +long k, l;
    +const char *s;
    +Py_ssize_t size;
    +
    +ok = PyArg_ParseTuple(args, ""); /* No arguments */
    +    /* Python call: f() */
    +
    +
    +
    ok = PyArg_ParseTuple(args, "s", &s); /* A string */
    +    /* Possible Python call: f('whoops!') */
    +
    +
    +
    ok = PyArg_ParseTuple(args, "lls", &k, &l, &s); /* Two longs and a string */
    +    /* Possible Python call: f(1, 2, 'three') */
    +
    +
    +
    ok = PyArg_ParseTuple(args, "(ii)s#", &i, &j, &s, &size);
    +    /* A pair of ints and a string, whose size is also returned */
    +    /* Possible Python call: f((1, 2), 'three') */
    +
    +
    +
    {
    +    const char *file;
    +    const char *mode = "r";
    +    int bufsize = 0;
    +    ok = PyArg_ParseTuple(args, "s|si", &file, &mode, &bufsize);
    +    /* A string, and optionally another string and an integer */
    +    /* Possible Python calls:
    +       f('spam')
    +       f('spam', 'w')
    +       f('spam', 'wb', 100000) */
    +}
    +
    +
    +
    {
    +    int left, top, right, bottom, h, v;
    +    ok = PyArg_ParseTuple(args, "((ii)(ii))(ii)",
    +             &left, &top, &right, &bottom, &h, &v);
    +    /* A rectangle and a point */
    +    /* Possible Python call:
    +       f(((0, 0), (400, 300)), (10, 10)) */
    +}
    +
    +
    +
    {
    +    Py_complex c;
    +    ok = PyArg_ParseTuple(args, "D:myfunction", &c);
    +    /* a complex, also providing a function name for errors */
    +    /* Possible Python call: myfunction(1+2j) */
    +}
    +
    +
    +
    +
    +

    1.8. Keyword Parameters for Extension Functions

    +

    The PyArg_ParseTupleAndKeywords() function is declared as follows:

    +
    int PyArg_ParseTupleAndKeywords(PyObject *arg, PyObject *kwdict,
    +                                const char *format, char *kwlist[], ...);
    +
    +
    +

    The arg and format parameters are identical to those of the +PyArg_ParseTuple() function. The kwdict parameter is the dictionary of +keywords received as the third parameter from the Python runtime. The kwlist +parameter is a NULL-terminated list of strings which identify the parameters; +the names are matched with the type information from format from left to +right. On success, PyArg_ParseTupleAndKeywords() returns true, otherwise +it returns false and raises an appropriate exception.

    +
    +

    Note

    +

    Nested tuples cannot be parsed when using keyword arguments! Keyword parameters +passed in which are not present in the kwlist will cause TypeError to +be raised.

    +
    +

    Here is an example module which uses keywords, based on an example by Geoff +Philbrick (philbrick@hks.com):

    +
    #define PY_SSIZE_T_CLEAN  /* Make "s#" use Py_ssize_t rather than int. */
    +#include <Python.h>
    +
    +static PyObject *
    +keywdarg_parrot(PyObject *self, PyObject *args, PyObject *keywds)
    +{
    +    int voltage;
    +    const char *state = "a stiff";
    +    const char *action = "voom";
    +    const char *type = "Norwegian Blue";
    +
    +    static char *kwlist[] = {"voltage", "state", "action", "type", NULL};
    +
    +    if (!PyArg_ParseTupleAndKeywords(args, keywds, "i|sss", kwlist,
    +                                     &voltage, &state, &action, &type))
    +        return NULL;
    +
    +    printf("-- This parrot wouldn't %s if you put %i Volts through it.\n",
    +           action, voltage);
    +    printf("-- Lovely plumage, the %s -- It's %s!\n", type, state);
    +
    +    Py_RETURN_NONE;
    +}
    +
    +static PyMethodDef keywdarg_methods[] = {
    +    /* The cast of the function is necessary since PyCFunction values
    +     * only take two PyObject* parameters, and keywdarg_parrot() takes
    +     * three.
    +     */
    +    {"parrot", (PyCFunction)keywdarg_parrot, METH_VARARGS | METH_KEYWORDS,
    +     "Print a lovely skit to standard output."},
    +    {NULL, NULL, 0, NULL}   /* sentinel */
    +};
    +
    +static struct PyModuleDef keywdargmodule = {
    +    PyModuleDef_HEAD_INIT,
    +    "keywdarg",
    +    NULL,
    +    -1,
    +    keywdarg_methods
    +};
    +
    +PyMODINIT_FUNC
    +PyInit_keywdarg(void)
    +{
    +    return PyModule_Create(&keywdargmodule);
    +}
    +
    +
    +
    +
    +

    1.9. Building Arbitrary Values

    +

    This function is the counterpart to PyArg_ParseTuple(). It is declared +as follows:

    +
    PyObject *Py_BuildValue(const char *format, ...);
    +
    +
    +

    It recognizes a set of format units similar to the ones recognized by +PyArg_ParseTuple(), but the arguments (which are input to the function, +not output) must not be pointers, just values. It returns a new Python object, +suitable for returning from a C function called from Python.

    +

    One difference with PyArg_ParseTuple(): while the latter requires its +first argument to be a tuple (since Python argument lists are always represented +as tuples internally), Py_BuildValue() does not always build a tuple. It +builds a tuple only if its format string contains two or more format units. If +the format string is empty, it returns None; if it contains exactly one +format unit, it returns whatever object is described by that format unit. To +force it to return a tuple of size 0 or one, parenthesize the format string.

    +

    Examples (to the left the call, to the right the resulting Python value):

    +
    Py_BuildValue("")                        None
    +Py_BuildValue("i", 123)                  123
    +Py_BuildValue("iii", 123, 456, 789)      (123, 456, 789)
    +Py_BuildValue("s", "hello")              'hello'
    +Py_BuildValue("y", "hello")              b'hello'
    +Py_BuildValue("ss", "hello", "world")    ('hello', 'world')
    +Py_BuildValue("s#", "hello", 4)          'hell'
    +Py_BuildValue("y#", "hello", 4)          b'hell'
    +Py_BuildValue("()")                      ()
    +Py_BuildValue("(i)", 123)                (123,)
    +Py_BuildValue("(ii)", 123, 456)          (123, 456)
    +Py_BuildValue("(i,i)", 123, 456)         (123, 456)
    +Py_BuildValue("[i,i]", 123, 456)         [123, 456]
    +Py_BuildValue("{s:i,s:i}",
    +              "abc", 123, "def", 456)    {'abc': 123, 'def': 456}
    +Py_BuildValue("((ii)(ii)) (ii)",
    +              1, 2, 3, 4, 5, 6)          (((1, 2), (3, 4)), (5, 6))
    +
    +
    +
    +
    +

    1.10. Reference Counts

    +

    In languages like C or C++, the programmer is responsible for dynamic allocation +and deallocation of memory on the heap. In C, this is done using the functions +malloc() and free(). In C++, the operators new and +delete are used with essentially the same meaning and we’ll restrict +the following discussion to the C case.

    +

    Every block of memory allocated with malloc() should eventually be +returned to the pool of available memory by exactly one call to free(). +It is important to call free() at the right time. If a block’s address +is forgotten but free() is not called for it, the memory it occupies +cannot be reused until the program terminates. This is called a memory +leak. On the other hand, if a program calls free() for a block and then +continues to use the block, it creates a conflict with re-use of the block +through another malloc() call. This is called using freed memory. +It has the same bad consequences as referencing uninitialized data — core +dumps, wrong results, mysterious crashes.

    +

    Common causes of memory leaks are unusual paths through the code. For instance, +a function may allocate a block of memory, do some calculation, and then free +the block again. Now a change in the requirements for the function may add a +test to the calculation that detects an error condition and can return +prematurely from the function. It’s easy to forget to free the allocated memory +block when taking this premature exit, especially when it is added later to the +code. Such leaks, once introduced, often go undetected for a long time: the +error exit is taken only in a small fraction of all calls, and most modern +machines have plenty of virtual memory, so the leak only becomes apparent in a +long-running process that uses the leaking function frequently. Therefore, it’s +important to prevent leaks from happening by having a coding convention or +strategy that minimizes this kind of errors.

    +

    Since Python makes heavy use of malloc() and free(), it needs a +strategy to avoid memory leaks as well as the use of freed memory. The chosen +method is called reference counting. The principle is simple: every +object contains a counter, which is incremented when a reference to the object +is stored somewhere, and which is decremented when a reference to it is deleted. +When the counter reaches zero, the last reference to the object has been deleted +and the object is freed.

    +

    An alternative strategy is called automatic garbage collection. +(Sometimes, reference counting is also referred to as a garbage collection +strategy, hence my use of “automatic” to distinguish the two.) The big +advantage of automatic garbage collection is that the user doesn’t need to call +free() explicitly. (Another claimed advantage is an improvement in speed +or memory usage — this is no hard fact however.) The disadvantage is that for +C, there is no truly portable automatic garbage collector, while reference +counting can be implemented portably (as long as the functions malloc() +and free() are available — which the C Standard guarantees). Maybe some +day a sufficiently portable automatic garbage collector will be available for C. +Until then, we’ll have to live with reference counts.

    +

    While Python uses the traditional reference counting implementation, it also +offers a cycle detector that works to detect reference cycles. This allows +applications to not worry about creating direct or indirect circular references; +these are the weakness of garbage collection implemented using only reference +counting. Reference cycles consist of objects which contain (possibly indirect) +references to themselves, so that each object in the cycle has a reference count +which is non-zero. Typical reference counting implementations are not able to +reclaim the memory belonging to any objects in a reference cycle, or referenced +from the objects in the cycle, even though there are no further references to +the cycle itself.

    +

    The cycle detector is able to detect garbage cycles and can reclaim them. +The gc module exposes a way to run the detector (the +collect() function), as well as configuration +interfaces and the ability to disable the detector at runtime. The cycle +detector is considered an optional component; though it is included by default, +it can be disabled at build time using the --without-cycle-gc option +to the configure script on Unix platforms (including Mac OS X). If +the cycle detector is disabled in this way, the gc module will not be +available.

    +
    +

    1.10.1. Reference Counting in Python

    +

    There are two macros, Py_INCREF(x) and Py_DECREF(x), which handle the +incrementing and decrementing of the reference count. Py_DECREF() also +frees the object when the count reaches zero. For flexibility, it doesn’t call +free() directly — rather, it makes a call through a function pointer in +the object’s type object. For this purpose (and others), every object +also contains a pointer to its type object.

    +

    The big question now remains: when to use Py_INCREF(x) and Py_DECREF(x)? +Let’s first introduce some terms. Nobody “owns” an object; however, you can +own a reference to an object. An object’s reference count is now defined +as the number of owned references to it. The owner of a reference is +responsible for calling Py_DECREF() when the reference is no longer +needed. Ownership of a reference can be transferred. There are three ways to +dispose of an owned reference: pass it on, store it, or call Py_DECREF(). +Forgetting to dispose of an owned reference creates a memory leak.

    +

    It is also possible to borrow 2 a reference to an object. The +borrower of a reference should not call Py_DECREF(). The borrower must +not hold on to the object longer than the owner from which it was borrowed. +Using a borrowed reference after the owner has disposed of it risks using freed +memory and should be avoided completely 3.

    +

    The advantage of borrowing over owning a reference is that you don’t need to +take care of disposing of the reference on all possible paths through the code +— in other words, with a borrowed reference you don’t run the risk of leaking +when a premature exit is taken. The disadvantage of borrowing over owning is +that there are some subtle situations where in seemingly correct code a borrowed +reference can be used after the owner from which it was borrowed has in fact +disposed of it.

    +

    A borrowed reference can be changed into an owned reference by calling +Py_INCREF(). This does not affect the status of the owner from which the +reference was borrowed — it creates a new owned reference, and gives full +owner responsibilities (the new owner must dispose of the reference properly, as +well as the previous owner).

    +
    +
    +

    1.10.2. Ownership Rules

    +

    Whenever an object reference is passed into or out of a function, it is part of +the function’s interface specification whether ownership is transferred with the +reference or not.

    +

    Most functions that return a reference to an object pass on ownership with the +reference. In particular, all functions whose function it is to create a new +object, such as PyLong_FromLong() and Py_BuildValue(), pass +ownership to the receiver. Even if the object is not actually new, you still +receive ownership of a new reference to that object. For instance, +PyLong_FromLong() maintains a cache of popular values and can return a +reference to a cached item.

    +

    Many functions that extract objects from other objects also transfer ownership +with the reference, for instance PyObject_GetAttrString(). The picture +is less clear, here, however, since a few common routines are exceptions: +PyTuple_GetItem(), PyList_GetItem(), PyDict_GetItem(), and +PyDict_GetItemString() all return references that you borrow from the +tuple, list or dictionary.

    +

    The function PyImport_AddModule() also returns a borrowed reference, even +though it may actually create the object it returns: this is possible because an +owned reference to the object is stored in sys.modules.

    +

    When you pass an object reference into another function, in general, the +function borrows the reference from you — if it needs to store it, it will use +Py_INCREF() to become an independent owner. There are exactly two +important exceptions to this rule: PyTuple_SetItem() and +PyList_SetItem(). These functions take over ownership of the item passed +to them — even if they fail! (Note that PyDict_SetItem() and friends +don’t take over ownership — they are “normal.”)

    +

    When a C function is called from Python, it borrows references to its arguments +from the caller. The caller owns a reference to the object, so the borrowed +reference’s lifetime is guaranteed until the function returns. Only when such a +borrowed reference must be stored or passed on, it must be turned into an owned +reference by calling Py_INCREF().

    +

    The object reference returned from a C function that is called from Python must +be an owned reference — ownership is transferred from the function to its +caller.

    +
    +
    +

    1.10.3. Thin Ice

    +

    There are a few situations where seemingly harmless use of a borrowed reference +can lead to problems. These all have to do with implicit invocations of the +interpreter, which can cause the owner of a reference to dispose of it.

    +

    The first and most important case to know about is using Py_DECREF() on +an unrelated object while borrowing a reference to a list item. For instance:

    +
    void
    +bug(PyObject *list)
    +{
    +    PyObject *item = PyList_GetItem(list, 0);
    +
    +    PyList_SetItem(list, 1, PyLong_FromLong(0L));
    +    PyObject_Print(item, stdout, 0); /* BUG! */
    +}
    +
    +
    +

    This function first borrows a reference to list[0], then replaces +list[1] with the value 0, and finally prints the borrowed reference. +Looks harmless, right? But it’s not!

    +

    Let’s follow the control flow into PyList_SetItem(). The list owns +references to all its items, so when item 1 is replaced, it has to dispose of +the original item 1. Now let’s suppose the original item 1 was an instance of a +user-defined class, and let’s further suppose that the class defined a +__del__() method. If this class instance has a reference count of 1, +disposing of it will call its __del__() method.

    +

    Since it is written in Python, the __del__() method can execute arbitrary +Python code. Could it perhaps do something to invalidate the reference to +item in bug()? You bet! Assuming that the list passed into +bug() is accessible to the __del__() method, it could execute a +statement to the effect of del list[0], and assuming this was the last +reference to that object, it would free the memory associated with it, thereby +invalidating item.

    +

    The solution, once you know the source of the problem, is easy: temporarily +increment the reference count. The correct version of the function reads:

    +
    void
    +no_bug(PyObject *list)
    +{
    +    PyObject *item = PyList_GetItem(list, 0);
    +
    +    Py_INCREF(item);
    +    PyList_SetItem(list, 1, PyLong_FromLong(0L));
    +    PyObject_Print(item, stdout, 0);
    +    Py_DECREF(item);
    +}
    +
    +
    +

    This is a true story. An older version of Python contained variants of this bug +and someone spent a considerable amount of time in a C debugger to figure out +why his __del__() methods would fail…

    +

    The second case of problems with a borrowed reference is a variant involving +threads. Normally, multiple threads in the Python interpreter can’t get in each +other’s way, because there is a global lock protecting Python’s entire object +space. However, it is possible to temporarily release this lock using the macro +Py_BEGIN_ALLOW_THREADS, and to re-acquire it using +Py_END_ALLOW_THREADS. This is common around blocking I/O calls, to +let other threads use the processor while waiting for the I/O to complete. +Obviously, the following function has the same problem as the previous one:

    +
    void
    +bug(PyObject *list)
    +{
    +    PyObject *item = PyList_GetItem(list, 0);
    +    Py_BEGIN_ALLOW_THREADS
    +    ...some blocking I/O call...
    +    Py_END_ALLOW_THREADS
    +    PyObject_Print(item, stdout, 0); /* BUG! */
    +}
    +
    +
    +
    +
    +

    1.10.4. NULL Pointers

    +

    In general, functions that take object references as arguments do not expect you +to pass them NULL pointers, and will dump core (or cause later core dumps) if +you do so. Functions that return object references generally return NULL only +to indicate that an exception occurred. The reason for not testing for NULL +arguments is that functions often pass the objects they receive on to other +function — if each function were to test for NULL, there would be a lot of +redundant tests and the code would run more slowly.

    +

    It is better to test for NULL only at the “source:” when a pointer that may be +NULL is received, for example, from malloc() or from a function that +may raise an exception.

    +

    The macros Py_INCREF() and Py_DECREF() do not check for NULL +pointers — however, their variants Py_XINCREF() and Py_XDECREF() +do.

    +

    The macros for checking for a particular object type (Pytype_Check()) don’t +check for NULL pointers — again, there is much code that calls several of +these in a row to test an object against various different expected types, and +this would generate redundant tests. There are no variants with NULL +checking.

    +

    The C function calling mechanism guarantees that the argument list passed to C +functions (args in the examples) is never NULL — in fact it guarantees +that it is always a tuple 4.

    +

    It is a severe error to ever let a NULL pointer “escape” to the Python user.

    +
    +
    +
    +

    1.11. Writing Extensions in C++

    +

    It is possible to write extension modules in C++. Some restrictions apply. If +the main program (the Python interpreter) is compiled and linked by the C +compiler, global or static objects with constructors cannot be used. This is +not a problem if the main program is linked by the C++ compiler. Functions that +will be called by the Python interpreter (in particular, module initialization +functions) have to be declared using extern "C". It is unnecessary to +enclose the Python header files in extern "C" {...} — they use this form +already if the symbol __cplusplus is defined (all recent C++ compilers +define this symbol).

    +
    +
    +

    1.12. Providing a C API for an Extension Module

    +

    Many extension modules just provide new functions and types to be used from +Python, but sometimes the code in an extension module can be useful for other +extension modules. For example, an extension module could implement a type +“collection” which works like lists without order. Just like the standard Python +list type has a C API which permits extension modules to create and manipulate +lists, this new collection type should have a set of C functions for direct +manipulation from other extension modules.

    +

    At first sight this seems easy: just write the functions (without declaring them +static, of course), provide an appropriate header file, and document +the C API. And in fact this would work if all extension modules were always +linked statically with the Python interpreter. When modules are used as shared +libraries, however, the symbols defined in one module may not be visible to +another module. The details of visibility depend on the operating system; some +systems use one global namespace for the Python interpreter and all extension +modules (Windows, for example), whereas others require an explicit list of +imported symbols at module link time (AIX is one example), or offer a choice of +different strategies (most Unices). And even if symbols are globally visible, +the module whose functions one wishes to call might not have been loaded yet!

    +

    Portability therefore requires not to make any assumptions about symbol +visibility. This means that all symbols in extension modules should be declared +static, except for the module’s initialization function, in order to +avoid name clashes with other extension modules (as discussed in section +The Module’s Method Table and Initialization Function). And it means that symbols that should be accessible from +other extension modules must be exported in a different way.

    +

    Python provides a special mechanism to pass C-level information (pointers) from +one extension module to another one: Capsules. A Capsule is a Python data type +which stores a pointer (void *). Capsules can only be created and +accessed via their C API, but they can be passed around like any other Python +object. In particular, they can be assigned to a name in an extension module’s +namespace. Other extension modules can then import this module, retrieve the +value of this name, and then retrieve the pointer from the Capsule.

    +

    There are many ways in which Capsules can be used to export the C API of an +extension module. Each function could get its own Capsule, or all C API pointers +could be stored in an array whose address is published in a Capsule. And the +various tasks of storing and retrieving the pointers can be distributed in +different ways between the module providing the code and the client modules.

    +

    Whichever method you choose, it’s important to name your Capsules properly. +The function PyCapsule_New() takes a name parameter +(const char *); you’re permitted to pass in a NULL name, but +we strongly encourage you to specify a name. Properly named Capsules provide +a degree of runtime type-safety; there is no feasible way to tell one unnamed +Capsule from another.

    +

    In particular, Capsules used to expose C APIs should be given a name following +this convention:

    +
    modulename.attributename
    +
    +
    +

    The convenience function PyCapsule_Import() makes it easy to +load a C API provided via a Capsule, but only if the Capsule’s name +matches this convention. This behavior gives C API users a high degree +of certainty that the Capsule they load contains the correct C API.

    +

    The following example demonstrates an approach that puts most of the burden on +the writer of the exporting module, which is appropriate for commonly used +library modules. It stores all C API pointers (just one in the example!) in an +array of void pointers which becomes the value of a Capsule. The header +file corresponding to the module provides a macro that takes care of importing +the module and retrieving its C API pointers; client modules only have to call +this macro before accessing the C API.

    +

    The exporting module is a modification of the spam module from section +A Simple Example. The function spam.system() does not call +the C library function system() directly, but a function +PySpam_System(), which would of course do something more complicated in +reality (such as adding “spam” to every command). This function +PySpam_System() is also exported to other extension modules.

    +

    The function PySpam_System() is a plain C function, declared +static like everything else:

    +
    static int
    +PySpam_System(const char *command)
    +{
    +    return system(command);
    +}
    +
    +
    +

    The function spam_system() is modified in a trivial way:

    +
    static PyObject *
    +spam_system(PyObject *self, PyObject *args)
    +{
    +    const char *command;
    +    int sts;
    +
    +    if (!PyArg_ParseTuple(args, "s", &command))
    +        return NULL;
    +    sts = PySpam_System(command);
    +    return PyLong_FromLong(sts);
    +}
    +
    +
    +

    In the beginning of the module, right after the line

    +
    #include <Python.h>
    +
    +
    +

    two more lines must be added:

    +
    #define SPAM_MODULE
    +#include "spammodule.h"
    +
    +
    +

    The #define is used to tell the header file that it is being included in the +exporting module, not a client module. Finally, the module’s initialization +function must take care of initializing the C API pointer array:

    +
    PyMODINIT_FUNC
    +PyInit_spam(void)
    +{
    +    PyObject *m;
    +    static void *PySpam_API[PySpam_API_pointers];
    +    PyObject *c_api_object;
    +
    +    m = PyModule_Create(&spammodule);
    +    if (m == NULL)
    +        return NULL;
    +
    +    /* Initialize the C API pointer array */
    +    PySpam_API[PySpam_System_NUM] = (void *)PySpam_System;
    +
    +    /* Create a Capsule containing the API pointer array's address */
    +    c_api_object = PyCapsule_New((void *)PySpam_API, "spam._C_API", NULL);
    +
    +    if (c_api_object != NULL)
    +        PyModule_AddObject(m, "_C_API", c_api_object);
    +    return m;
    +}
    +
    +
    +

    Note that PySpam_API is declared static; otherwise the pointer +array would disappear when PyInit_spam() terminates!

    +

    The bulk of the work is in the header file spammodule.h, which looks +like this:

    +
    #ifndef Py_SPAMMODULE_H
    +#define Py_SPAMMODULE_H
    +#ifdef __cplusplus
    +extern "C" {
    +#endif
    +
    +/* Header file for spammodule */
    +
    +/* C API functions */
    +#define PySpam_System_NUM 0
    +#define PySpam_System_RETURN int
    +#define PySpam_System_PROTO (const char *command)
    +
    +/* Total number of C API pointers */
    +#define PySpam_API_pointers 1
    +
    +
    +#ifdef SPAM_MODULE
    +/* This section is used when compiling spammodule.c */
    +
    +static PySpam_System_RETURN PySpam_System PySpam_System_PROTO;
    +
    +#else
    +/* This section is used in modules that use spammodule's API */
    +
    +static void **PySpam_API;
    +
    +#define PySpam_System \
    + (*(PySpam_System_RETURN (*)PySpam_System_PROTO) PySpam_API[PySpam_System_NUM])
    +
    +/* Return -1 on error, 0 on success.
    + * PyCapsule_Import will set an exception if there's an error.
    + */
    +static int
    +import_spam(void)
    +{
    +    PySpam_API = (void **)PyCapsule_Import("spam._C_API", 0);
    +    return (PySpam_API != NULL) ? 0 : -1;
    +}
    +
    +#endif
    +
    +#ifdef __cplusplus
    +}
    +#endif
    +
    +#endif /* !defined(Py_SPAMMODULE_H) */
    +
    +
    +

    All that a client module must do in order to have access to the function +PySpam_System() is to call the function (or rather macro) +import_spam() in its initialization function:

    +
    PyMODINIT_FUNC
    +PyInit_client(void)
    +{
    +    PyObject *m;
    +
    +    m = PyModule_Create(&clientmodule);
    +    if (m == NULL)
    +        return NULL;
    +    if (import_spam() < 0)
    +        return NULL;
    +    /* additional initialization can happen here */
    +    return m;
    +}
    +
    +
    +

    The main disadvantage of this approach is that the file spammodule.h is +rather complicated. However, the basic structure is the same for each function +that is exported, so it has to be learned only once.

    +

    Finally it should be mentioned that Capsules offer additional functionality, +which is especially useful for memory allocation and deallocation of the pointer +stored in a Capsule. The details are described in the Python/C API Reference +Manual in the section Capsules and in the implementation of Capsules (files +Include/pycapsule.h and Objects/pycapsule.c in the Python source +code distribution).

    +

    Footnotes

    +
    +
    1
    +

    An interface for this function already exists in the standard module os +— it was chosen as a simple and straightforward example.

    +
    +
    2
    +

    The metaphor of “borrowing” a reference is not completely correct: the owner +still has a copy of the reference.

    +
    +
    3
    +

    Checking that the reference count is at least 1 does not work — the +reference count itself could be in freed memory and may thus be reused for +another object!

    +
    +
    4
    +

    These guarantees don’t hold when you use the “old” style calling convention — +this is still found in much existing code.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/extending/index.html b/python-3.7.4-docs-html/extending/index.html new file mode 100644 index 0000000..2df2e93 --- /dev/null +++ b/python-3.7.4-docs-html/extending/index.html @@ -0,0 +1,297 @@ + + + + + + + Extending and Embedding the Python Interpreter — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Extending and Embedding the Python Interpreter

    +

    This document describes how to write modules in C or C++ to extend the Python +interpreter with new modules. Those modules can not only define new functions +but also new object types and their methods. The document also describes how +to embed the Python interpreter in another application, for use as an extension +language. Finally, it shows how to compile and link extension modules so that +they can be loaded dynamically (at run time) into the interpreter, if the +underlying operating system supports this feature.

    +

    This document assumes basic knowledge about Python. For an informal +introduction to the language, see The Python Tutorial. The Python Language Reference +gives a more formal definition of the language. The Python Standard Library documents +the existing object types, functions and modules (both built-in and written in +Python) that give the language its wide application range.

    +

    For a detailed description of the whole Python/C API, see the separate +Python/C API Reference Manual.

    + +
    +

    Creating extensions without third party tools

    +

    This section of the guide covers creating C and C++ extensions without +assistance from third party tools. It is intended primarily for creators +of those tools, rather than being a recommended way to create your own +C extensions.

    + +
    +
    +

    Embedding the CPython runtime in a larger application

    +

    Sometimes, rather than creating an extension that runs inside the Python +interpreter as the main application, it is desirable to instead embed +the CPython runtime inside a larger application. This section covers +some of the details involved in doing that successfully.

    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/extending/newtypes.html b/python-3.7.4-docs-html/extending/newtypes.html new file mode 100644 index 0000000..45ddf7a --- /dev/null +++ b/python-3.7.4-docs-html/extending/newtypes.html @@ -0,0 +1,828 @@ + + + + + + + 3. Defining Extension Types: Assorted Topics — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    3. Defining Extension Types: Assorted Topics

    +

    This section aims to give a quick fly-by on the various type methods you can +implement and what they do.

    +

    Here is the definition of PyTypeObject, with some fields only used in +debug builds omitted:

    +
    typedef struct _typeobject {
    +    PyObject_VAR_HEAD
    +    const char *tp_name; /* For printing, in format "<module>.<name>" */
    +    Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */
    +
    +    /* Methods to implement standard operations */
    +
    +    destructor tp_dealloc;
    +    printfunc tp_print;
    +    getattrfunc tp_getattr;
    +    setattrfunc tp_setattr;
    +    PyAsyncMethods *tp_as_async; /* formerly known as tp_compare (Python 2)
    +                                    or tp_reserved (Python 3) */
    +    reprfunc tp_repr;
    +
    +    /* Method suites for standard classes */
    +
    +    PyNumberMethods *tp_as_number;
    +    PySequenceMethods *tp_as_sequence;
    +    PyMappingMethods *tp_as_mapping;
    +
    +    /* More standard operations (here for binary compatibility) */
    +
    +    hashfunc tp_hash;
    +    ternaryfunc tp_call;
    +    reprfunc tp_str;
    +    getattrofunc tp_getattro;
    +    setattrofunc tp_setattro;
    +
    +    /* Functions to access object as input/output buffer */
    +    PyBufferProcs *tp_as_buffer;
    +
    +    /* Flags to define presence of optional/expanded features */
    +    unsigned long tp_flags;
    +
    +    const char *tp_doc; /* Documentation string */
    +
    +    /* call function for all accessible objects */
    +    traverseproc tp_traverse;
    +
    +    /* delete references to contained objects */
    +    inquiry tp_clear;
    +
    +    /* rich comparisons */
    +    richcmpfunc tp_richcompare;
    +
    +    /* weak reference enabler */
    +    Py_ssize_t tp_weaklistoffset;
    +
    +    /* Iterators */
    +    getiterfunc tp_iter;
    +    iternextfunc tp_iternext;
    +
    +    /* Attribute descriptor and subclassing stuff */
    +    struct PyMethodDef *tp_methods;
    +    struct PyMemberDef *tp_members;
    +    struct PyGetSetDef *tp_getset;
    +    struct _typeobject *tp_base;
    +    PyObject *tp_dict;
    +    descrgetfunc tp_descr_get;
    +    descrsetfunc tp_descr_set;
    +    Py_ssize_t tp_dictoffset;
    +    initproc tp_init;
    +    allocfunc tp_alloc;
    +    newfunc tp_new;
    +    freefunc tp_free; /* Low-level free-memory routine */
    +    inquiry tp_is_gc; /* For PyObject_IS_GC */
    +    PyObject *tp_bases;
    +    PyObject *tp_mro; /* method resolution order */
    +    PyObject *tp_cache;
    +    PyObject *tp_subclasses;
    +    PyObject *tp_weaklist;
    +    destructor tp_del;
    +
    +    /* Type attribute cache version tag. Added in version 2.6 */
    +    unsigned int tp_version_tag;
    +
    +    destructor tp_finalize;
    +
    +} PyTypeObject;
    +
    +
    +

    Now that’s a lot of methods. Don’t worry too much though – if you have +a type you want to define, the chances are very good that you will only +implement a handful of these.

    +

    As you probably expect by now, we’re going to go over this and give more +information about the various handlers. We won’t go in the order they are +defined in the structure, because there is a lot of historical baggage that +impacts the ordering of the fields. It’s often easiest to find an example +that includes the fields you need and then change the values to suit your new +type.

    +
    const char *tp_name; /* For printing */
    +
    +
    +

    The name of the type – as mentioned in the previous chapter, this will appear in +various places, almost entirely for diagnostic purposes. Try to choose something +that will be helpful in such a situation!

    +
    Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */
    +
    +
    +

    These fields tell the runtime how much memory to allocate when new objects of +this type are created. Python has some built-in support for variable length +structures (think: strings, tuples) which is where the tp_itemsize field +comes in. This will be dealt with later.

    +
    const char *tp_doc;
    +
    +
    +

    Here you can put a string (or its address) that you want returned when the +Python script references obj.__doc__ to retrieve the doc string.

    +

    Now we come to the basic type methods – the ones most extension types will +implement.

    +
    +

    3.1. Finalization and De-allocation

    +
    destructor tp_dealloc;
    +
    +
    +

    This function is called when the reference count of the instance of your type is +reduced to zero and the Python interpreter wants to reclaim it. If your type +has memory to free or other clean-up to perform, you can put it here. The +object itself needs to be freed here as well. Here is an example of this +function:

    +
    static void
    +newdatatype_dealloc(newdatatypeobject *obj)
    +{
    +    free(obj->obj_UnderlyingDatatypePtr);
    +    Py_TYPE(obj)->tp_free(obj);
    +}
    +
    +
    +

    One important requirement of the deallocator function is that it leaves any +pending exceptions alone. This is important since deallocators are frequently +called as the interpreter unwinds the Python stack; when the stack is unwound +due to an exception (rather than normal returns), nothing is done to protect the +deallocators from seeing that an exception has already been set. Any actions +which a deallocator performs which may cause additional Python code to be +executed may detect that an exception has been set. This can lead to misleading +errors from the interpreter. The proper way to protect against this is to save +a pending exception before performing the unsafe action, and restoring it when +done. This can be done using the PyErr_Fetch() and +PyErr_Restore() functions:

    +
    static void
    +my_dealloc(PyObject *obj)
    +{
    +    MyObject *self = (MyObject *) obj;
    +    PyObject *cbresult;
    +
    +    if (self->my_callback != NULL) {
    +        PyObject *err_type, *err_value, *err_traceback;
    +
    +        /* This saves the current exception state */
    +        PyErr_Fetch(&err_type, &err_value, &err_traceback);
    +
    +        cbresult = PyObject_CallObject(self->my_callback, NULL);
    +        if (cbresult == NULL)
    +            PyErr_WriteUnraisable(self->my_callback);
    +        else
    +            Py_DECREF(cbresult);
    +
    +        /* This restores the saved exception state */
    +        PyErr_Restore(err_type, err_value, err_traceback);
    +
    +        Py_DECREF(self->my_callback);
    +    }
    +    Py_TYPE(obj)->tp_free((PyObject*)self);
    +}
    +
    +
    +
    +

    Note

    +

    There are limitations to what you can safely do in a deallocator function. +First, if your type supports garbage collection (using tp_traverse +and/or tp_clear), some of the object’s members can have been +cleared or finalized by the time tp_dealloc is called. Second, in +tp_dealloc, your object is in an unstable state: its reference +count is equal to zero. Any call to a non-trivial object or API (as in the +example above) might end up calling tp_dealloc again, causing a +double free and a crash.

    +

    Starting with Python 3.4, it is recommended not to put any complex +finalization code in tp_dealloc, and instead use the new +tp_finalize type method.

    +
    +

    See also

    +

    PEP 442 explains the new finalization scheme.

    +
    +
    +
    +
    +

    3.2. Object Presentation

    +

    In Python, there are two ways to generate a textual representation of an object: +the repr() function, and the str() function. (The print() +function just calls str().) These handlers are both optional.

    +
    reprfunc tp_repr;
    +reprfunc tp_str;
    +
    +
    +

    The tp_repr handler should return a string object containing a +representation of the instance for which it is called. Here is a simple +example:

    +
    static PyObject *
    +newdatatype_repr(newdatatypeobject * obj)
    +{
    +    return PyUnicode_FromFormat("Repr-ified_newdatatype{{size:%d}}",
    +                                obj->obj_UnderlyingDatatypePtr->size);
    +}
    +
    +
    +

    If no tp_repr handler is specified, the interpreter will supply a +representation that uses the type’s tp_name and a uniquely-identifying +value for the object.

    +

    The tp_str handler is to str() what the tp_repr handler +described above is to repr(); that is, it is called when Python code calls +str() on an instance of your object. Its implementation is very similar +to the tp_repr function, but the resulting string is intended for human +consumption. If tp_str is not specified, the tp_repr handler is +used instead.

    +

    Here is a simple example:

    +
    static PyObject *
    +newdatatype_str(newdatatypeobject * obj)
    +{
    +    return PyUnicode_FromFormat("Stringified_newdatatype{{size:%d}}",
    +                                obj->obj_UnderlyingDatatypePtr->size);
    +}
    +
    +
    +
    +
    +

    3.3. Attribute Management

    +

    For every object which can support attributes, the corresponding type must +provide the functions that control how the attributes are resolved. There needs +to be a function which can retrieve attributes (if any are defined), and another +to set attributes (if setting attributes is allowed). Removing an attribute is +a special case, for which the new value passed to the handler is NULL.

    +

    Python supports two pairs of attribute handlers; a type that supports attributes +only needs to implement the functions for one pair. The difference is that one +pair takes the name of the attribute as a char*, while the other +accepts a PyObject*. Each type can use whichever pair makes more +sense for the implementation’s convenience.

    +
    getattrfunc  tp_getattr;        /* char * version */
    +setattrfunc  tp_setattr;
    +/* ... */
    +getattrofunc tp_getattro;       /* PyObject * version */
    +setattrofunc tp_setattro;
    +
    +
    +

    If accessing attributes of an object is always a simple operation (this will be +explained shortly), there are generic implementations which can be used to +provide the PyObject* version of the attribute management functions. +The actual need for type-specific attribute handlers almost completely +disappeared starting with Python 2.2, though there are many examples which have +not been updated to use some of the new generic mechanism that is available.

    +
    +

    3.3.1. Generic Attribute Management

    +

    Most extension types only use simple attributes. So, what makes the +attributes simple? There are only a couple of conditions that must be met:

    +
      +
    1. The name of the attributes must be known when PyType_Ready() is +called.

    2. +
    3. No special processing is needed to record that an attribute was looked up or +set, nor do actions need to be taken based on the value.

    4. +
    +

    Note that this list does not place any restrictions on the values of the +attributes, when the values are computed, or how relevant data is stored.

    +

    When PyType_Ready() is called, it uses three tables referenced by the +type object to create descriptors which are placed in the dictionary of the +type object. Each descriptor controls access to one attribute of the instance +object. Each of the tables is optional; if all three are NULL, instances of +the type will only have attributes that are inherited from their base type, and +should leave the tp_getattro and tp_setattro fields NULL as +well, allowing the base type to handle attributes.

    +

    The tables are declared as three fields of the type object:

    +
    struct PyMethodDef *tp_methods;
    +struct PyMemberDef *tp_members;
    +struct PyGetSetDef *tp_getset;
    +
    +
    +

    If tp_methods is not NULL, it must refer to an array of +PyMethodDef structures. Each entry in the table is an instance of this +structure:

    +
    typedef struct PyMethodDef {
    +    const char  *ml_name;       /* method name */
    +    PyCFunction  ml_meth;       /* implementation function */
    +    int          ml_flags;      /* flags */
    +    const char  *ml_doc;        /* docstring */
    +} PyMethodDef;
    +
    +
    +

    One entry should be defined for each method provided by the type; no entries are +needed for methods inherited from a base type. One additional entry is needed +at the end; it is a sentinel that marks the end of the array. The +ml_name field of the sentinel must be NULL.

    +

    The second table is used to define attributes which map directly to data stored +in the instance. A variety of primitive C types are supported, and access may +be read-only or read-write. The structures in the table are defined as:

    +
    typedef struct PyMemberDef {
    +    const char *name;
    +    int         type;
    +    int         offset;
    +    int         flags;
    +    const char *doc;
    +} PyMemberDef;
    +
    +
    +

    For each entry in the table, a descriptor will be constructed and added to the +type which will be able to extract a value from the instance structure. The +type field should contain one of the type codes defined in the +structmember.h header; the value will be used to determine how to +convert Python values to and from C values. The flags field is used to +store flags which control how the attribute can be accessed.

    +

    The following flag constants are defined in structmember.h; they may be +combined using bitwise-OR.

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Constant

    Meaning

    READONLY

    Never writable.

    READ_RESTRICTED

    Not readable in restricted mode.

    WRITE_RESTRICTED

    Not writable in restricted mode.

    RESTRICTED

    Not readable or writable in restricted mode.

    +

    An interesting advantage of using the tp_members table to build +descriptors that are used at runtime is that any attribute defined this way can +have an associated doc string simply by providing the text in the table. An +application can use the introspection API to retrieve the descriptor from the +class object, and get the doc string using its __doc__ attribute.

    +

    As with the tp_methods table, a sentinel entry with a name value +of NULL is required.

    +
    +
    +

    3.3.2. Type-specific Attribute Management

    +

    For simplicity, only the char* version will be demonstrated here; the +type of the name parameter is the only difference between the char* +and PyObject* flavors of the interface. This example effectively does +the same thing as the generic example above, but does not use the generic +support added in Python 2.2. It explains how the handler functions are +called, so that if you do need to extend their functionality, you’ll understand +what needs to be done.

    +

    The tp_getattr handler is called when the object requires an attribute +look-up. It is called in the same situations where the __getattr__() +method of a class would be called.

    +

    Here is an example:

    +
    static PyObject *
    +newdatatype_getattr(newdatatypeobject *obj, char *name)
    +{
    +    if (strcmp(name, "data") == 0)
    +    {
    +        return PyLong_FromLong(obj->data);
    +    }
    +
    +    PyErr_Format(PyExc_AttributeError,
    +                 "'%.50s' object has no attribute '%.400s'",
    +                 tp->tp_name, name);
    +    return NULL;
    +}
    +
    +
    +

    The tp_setattr handler is called when the __setattr__() or +__delattr__() method of a class instance would be called. When an +attribute should be deleted, the third parameter will be NULL. Here is an +example that simply raises an exception; if this were really all you wanted, the +tp_setattr handler should be set to NULL.

    +
    static int
    +newdatatype_setattr(newdatatypeobject *obj, char *name, PyObject *v)
    +{
    +    PyErr_Format(PyExc_RuntimeError, "Read-only attribute: %s", name);
    +    return -1;
    +}
    +
    +
    +
    +
    +
    +

    3.4. Object Comparison

    +
    richcmpfunc tp_richcompare;
    +
    +
    +

    The tp_richcompare handler is called when comparisons are needed. It is +analogous to the rich comparison methods, like +__lt__(), and also called by PyObject_RichCompare() and +PyObject_RichCompareBool().

    +

    This function is called with two Python objects and the operator as arguments, +where the operator is one of Py_EQ, Py_NE, Py_LE, Py_GT, +Py_LT or Py_GT. It should compare the two objects with respect to the +specified operator and return Py_True or Py_False if the comparison is +successful, Py_NotImplemented to indicate that comparison is not +implemented and the other object’s comparison method should be tried, or NULL +if an exception was set.

    +

    Here is a sample implementation, for a datatype that is considered equal if the +size of an internal pointer is equal:

    +
    static PyObject *
    +newdatatype_richcmp(PyObject *obj1, PyObject *obj2, int op)
    +{
    +    PyObject *result;
    +    int c, size1, size2;
    +
    +    /* code to make sure that both arguments are of type
    +       newdatatype omitted */
    +
    +    size1 = obj1->obj_UnderlyingDatatypePtr->size;
    +    size2 = obj2->obj_UnderlyingDatatypePtr->size;
    +
    +    switch (op) {
    +    case Py_LT: c = size1 <  size2; break;
    +    case Py_LE: c = size1 <= size2; break;
    +    case Py_EQ: c = size1 == size2; break;
    +    case Py_NE: c = size1 != size2; break;
    +    case Py_GT: c = size1 >  size2; break;
    +    case Py_GE: c = size1 >= size2; break;
    +    }
    +    result = c ? Py_True : Py_False;
    +    Py_INCREF(result);
    +    return result;
    + }
    +
    +
    +
    +
    +

    3.5. Abstract Protocol Support

    +

    Python supports a variety of abstract ‘protocols;’ the specific interfaces +provided to use these interfaces are documented in Abstract Objects Layer.

    +

    A number of these abstract interfaces were defined early in the development of +the Python implementation. In particular, the number, mapping, and sequence +protocols have been part of Python since the beginning. Other protocols have +been added over time. For protocols which depend on several handler routines +from the type implementation, the older protocols have been defined as optional +blocks of handlers referenced by the type object. For newer protocols there are +additional slots in the main type object, with a flag bit being set to indicate +that the slots are present and should be checked by the interpreter. (The flag +bit does not indicate that the slot values are non-NULL. The flag may be set +to indicate the presence of a slot, but a slot may still be unfilled.)

    +
    PyNumberMethods   *tp_as_number;
    +PySequenceMethods *tp_as_sequence;
    +PyMappingMethods  *tp_as_mapping;
    +
    +
    +

    If you wish your object to be able to act like a number, a sequence, or a +mapping object, then you place the address of a structure that implements the C +type PyNumberMethods, PySequenceMethods, or +PyMappingMethods, respectively. It is up to you to fill in this +structure with appropriate values. You can find examples of the use of each of +these in the Objects directory of the Python source distribution.

    +
    hashfunc tp_hash;
    +
    +
    +

    This function, if you choose to provide it, should return a hash number for an +instance of your data type. Here is a simple example:

    +
    static Py_hash_t
    +newdatatype_hash(newdatatypeobject *obj)
    +{
    +    Py_hash_t result;
    +    result = obj->some_size + 32767 * obj->some_number;
    +    if (result == -1)
    +       result = -2;
    +    return result;
    +}
    +
    +
    +

    Py_hash_t is a signed integer type with a platform-varying width. +Returning -1 from tp_hash indicates an error, +which is why you should be careful to avoid returning it when hash computation +is successful, as seen above.

    +
    ternaryfunc tp_call;
    +
    +
    +

    This function is called when an instance of your data type is “called”, for +example, if obj1 is an instance of your data type and the Python script +contains obj1('hello'), the tp_call handler is invoked.

    +

    This function takes three arguments:

    +
      +
    1. self is the instance of the data type which is the subject of the call. +If the call is obj1('hello'), then self is obj1.

    2. +
    3. args is a tuple containing the arguments to the call. You can use +PyArg_ParseTuple() to extract the arguments.

    4. +
    5. kwds is a dictionary of keyword arguments that were passed. If this is +non-NULL and you support keyword arguments, use +PyArg_ParseTupleAndKeywords() to extract the arguments. If you +do not want to support keyword arguments and this is non-NULL, raise a +TypeError with a message saying that keyword arguments are not supported.

    6. +
    +

    Here is a toy tp_call implementation:

    +
    static PyObject *
    +newdatatype_call(newdatatypeobject *self, PyObject *args, PyObject *kwds)
    +{
    +    PyObject *result;
    +    const char *arg1;
    +    const char *arg2;
    +    const char *arg3;
    +
    +    if (!PyArg_ParseTuple(args, "sss:call", &arg1, &arg2, &arg3)) {
    +        return NULL;
    +    }
    +    result = PyUnicode_FromFormat(
    +        "Returning -- value: [%d] arg1: [%s] arg2: [%s] arg3: [%s]\n",
    +        obj->obj_UnderlyingDatatypePtr->size,
    +        arg1, arg2, arg3);
    +    return result;
    +}
    +
    +
    +
    /* Iterators */
    +getiterfunc tp_iter;
    +iternextfunc tp_iternext;
    +
    +
    +

    These functions provide support for the iterator protocol. Both handlers +take exactly one parameter, the instance for which they are being called, +and return a new reference. In the case of an error, they should set an +exception and return NULL. tp_iter corresponds +to the Python __iter__() method, while tp_iternext +corresponds to the Python __next__() method.

    +

    Any iterable object must implement the tp_iter +handler, which must return an iterator object. Here the same guidelines +apply as for Python classes:

    +
      +
    • For collections (such as lists and tuples) which can support multiple +independent iterators, a new iterator should be created and returned by +each call to tp_iter.

    • +
    • Objects which can only be iterated over once (usually due to side effects of +iteration, such as file objects) can implement tp_iter +by returning a new reference to themselves – and should also therefore +implement the tp_iternext handler.

    • +
    +

    Any iterator object should implement both tp_iter +and tp_iternext. An iterator’s +tp_iter handler should return a new reference +to the iterator. Its tp_iternext handler should +return a new reference to the next object in the iteration, if there is one. +If the iteration has reached the end, tp_iternext +may return NULL without setting an exception, or it may set +StopIteration in addition to returning NULL; avoiding +the exception can yield slightly better performance. If an actual error +occurs, tp_iternext should always set an exception +and return NULL.

    +
    +
    +

    3.6. Weak Reference Support

    +

    One of the goals of Python’s weak reference implementation is to allow any type +to participate in the weak reference mechanism without incurring the overhead on +performance-critical objects (such as numbers).

    +
    +

    See also

    +

    Documentation for the weakref module.

    +
    +

    For an object to be weakly referencable, the extension type must do two things:

    +
      +
    1. Include a PyObject* field in the C object structure dedicated to +the weak reference mechanism. The object’s constructor should leave it +NULL (which is automatic when using the default +tp_alloc).

    2. +
    3. Set the tp_weaklistoffset type member +to the offset of the aforementioned field in the C object structure, +so that the interpreter knows how to access and modify that field.

    4. +
    +

    Concretely, here is how a trivial object structure would be augmented +with the required field:

    +
    typedef struct {
    +    PyObject_HEAD
    +    PyObject *weakreflist;  /* List of weak references */
    +} TrivialObject;
    +
    +
    +

    And the corresponding member in the statically-declared type object:

    +
    static PyTypeObject TrivialType = {
    +    PyVarObject_HEAD_INIT(NULL, 0)
    +    /* ... other members omitted for brevity ... */
    +    .tp_weaklistoffset = offsetof(TrivialObject, weakreflist),
    +};
    +
    +
    +

    The only further addition is that tp_dealloc needs to clear any weak +references (by calling PyObject_ClearWeakRefs()) if the field is +non-NULL:

    +
    static void
    +Trivial_dealloc(TrivialObject *self)
    +{
    +    /* Clear weakrefs first before calling any destructors */
    +    if (self->weakreflist != NULL)
    +        PyObject_ClearWeakRefs((PyObject *) self);
    +    /* ... remainder of destruction code omitted for brevity ... */
    +    Py_TYPE(self)->tp_free((PyObject *) self);
    +}
    +
    +
    +
    +
    +

    3.7. More Suggestions

    +

    In order to learn how to implement any specific method for your new data type, +get the CPython source code. Go to the Objects directory, +then search the C source files for tp_ plus the function you want +(for example, tp_richcompare). You will find examples of the function +you want to implement.

    +

    When you need to verify that an object is a concrete instance of the type you +are implementing, use the PyObject_TypeCheck() function. A sample of +its use might be something like the following:

    +
    if (!PyObject_TypeCheck(some_object, &MyType)) {
    +    PyErr_SetString(PyExc_TypeError, "arg #1 not a mything");
    +    return NULL;
    +}
    +
    +
    +
    +

    See also

    +
    +
    Download CPython source releases.

    https://www.python.org/downloads/source/

    +
    +
    The CPython project on GitHub, where the CPython source code is developed.

    https://github.com/python/cpython

    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/extending/newtypes_tutorial.html b/python-3.7.4-docs-html/extending/newtypes_tutorial.html new file mode 100644 index 0000000..a4051bd --- /dev/null +++ b/python-3.7.4-docs-html/extending/newtypes_tutorial.html @@ -0,0 +1,1637 @@ + + + + + + + 2. Defining Extension Types: Tutorial — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    2. Defining Extension Types: Tutorial

    +

    Python allows the writer of a C extension module to define new types that +can be manipulated from Python code, much like the built-in str +and list types. The code for all extension types follows a +pattern, but there are some details that you need to understand before you +can get started. This document is a gentle introduction to the topic.

    +
    +

    2.1. The Basics

    +

    The CPython runtime sees all Python objects as variables of type +PyObject*, which serves as a “base type” for all Python objects. +The PyObject structure itself only contains the object’s +reference count and a pointer to the object’s “type object”. +This is where the action is; the type object determines which (C) functions +get called by the interpreter when, for instance, an attribute gets looked up +on an object, a method called, or it is multiplied by another object. These +C functions are called “type methods”.

    +

    So, if you want to define a new extension type, you need to create a new type +object.

    +

    This sort of thing can only be explained by example, so here’s a minimal, but +complete, module that defines a new type named Custom inside a C +extension module custom:

    +
    +

    Note

    +

    What we’re showing here is the traditional way of defining static +extension types. It should be adequate for most uses. The C API also +allows defining heap-allocated extension types using the +PyType_FromSpec() function, which isn’t covered in this tutorial.

    +
    +
    #define PY_SSIZE_T_CLEAN
    +#include <Python.h>
    +
    +typedef struct {
    +    PyObject_HEAD
    +    /* Type-specific fields go here. */
    +} CustomObject;
    +
    +static PyTypeObject CustomType = {
    +    PyVarObject_HEAD_INIT(NULL, 0)
    +    .tp_name = "custom.Custom",
    +    .tp_doc = "Custom objects",
    +    .tp_basicsize = sizeof(CustomObject),
    +    .tp_itemsize = 0,
    +    .tp_flags = Py_TPFLAGS_DEFAULT,
    +    .tp_new = PyType_GenericNew,
    +};
    +
    +static PyModuleDef custommodule = {
    +    PyModuleDef_HEAD_INIT,
    +    .m_name = "custom",
    +    .m_doc = "Example module that creates an extension type.",
    +    .m_size = -1,
    +};
    +
    +PyMODINIT_FUNC
    +PyInit_custom(void)
    +{
    +    PyObject *m;
    +    if (PyType_Ready(&CustomType) < 0)
    +        return NULL;
    +
    +    m = PyModule_Create(&custommodule);
    +    if (m == NULL)
    +        return NULL;
    +
    +    Py_INCREF(&CustomType);
    +    PyModule_AddObject(m, "Custom", (PyObject *) &CustomType);
    +    return m;
    +}
    +
    +
    +

    Now that’s quite a bit to take in at once, but hopefully bits will seem familiar +from the previous chapter. This file defines three things:

    +
      +
    1. What a Custom object contains: this is the CustomObject +struct, which is allocated once for each Custom instance.

    2. +
    3. How the Custom type behaves: this is the CustomType struct, +which defines a set of flags and function pointers that the interpreter +inspects when specific operations are requested.

    4. +
    5. How to initialize the custom module: this is the PyInit_custom +function and the associated custommodule struct.

    6. +
    +

    The first bit is:

    +
    typedef struct {
    +    PyObject_HEAD
    +} CustomObject;
    +
    +
    +

    This is what a Custom object will contain. PyObject_HEAD is mandatory +at the start of each object struct and defines a field called ob_base +of type PyObject, containing a pointer to a type object and a +reference count (these can be accessed using the macros Py_REFCNT +and Py_TYPE respectively). The reason for the macro is to +abstract away the layout and to enable additional fields in debug builds.

    +
    +

    Note

    +

    There is no semicolon above after the PyObject_HEAD macro. +Be wary of adding one by accident: some compilers will complain.

    +
    +

    Of course, objects generally store additional data besides the standard +PyObject_HEAD boilerplate; for example, here is the definition for +standard Python floats:

    +
    typedef struct {
    +    PyObject_HEAD
    +    double ob_fval;
    +} PyFloatObject;
    +
    +
    +

    The second bit is the definition of the type object.

    +
    static PyTypeObject CustomType = {
    +    PyVarObject_HEAD_INIT(NULL, 0)
    +    .tp_name = "custom.Custom",
    +    .tp_doc = "Custom objects",
    +    .tp_basicsize = sizeof(CustomObject),
    +    .tp_itemsize = 0,
    +    .tp_flags = Py_TPFLAGS_DEFAULT,
    +    .tp_new = PyType_GenericNew,
    +};
    +
    +
    +
    +

    Note

    +

    We recommend using C99-style designated initializers as above, to +avoid listing all the PyTypeObject fields that you don’t care +about and also to avoid caring about the fields’ declaration order.

    +
    +

    The actual definition of PyTypeObject in object.h has +many more fields than the definition above. The +remaining fields will be filled with zeros by the C compiler, and it’s +common practice to not specify them explicitly unless you need them.

    +

    We’re going to pick it apart, one field at a time:

    +
    PyVarObject_HEAD_INIT(NULL, 0)
    +
    +
    +

    This line is mandatory boilerplate to initialize the ob_base +field mentioned above.

    +
    .tp_name = "custom.Custom",
    +
    +
    +

    The name of our type. This will appear in the default textual representation of +our objects and in some error messages, for example:

    +
    >>> "" + custom.Custom()
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +TypeError: can only concatenate str (not "custom.Custom") to str
    +
    +
    +

    Note that the name is a dotted name that includes both the module name and the +name of the type within the module. The module in this case is custom and +the type is Custom, so we set the type name to custom.Custom. +Using the real dotted import path is important to make your type compatible +with the pydoc and pickle modules.

    +
    .tp_basicsize = sizeof(CustomObject),
    +.tp_itemsize = 0,
    +
    +
    +

    This is so that Python knows how much memory to allocate when creating +new Custom instances. tp_itemsize is +only used for variable-sized objects and should otherwise be zero.

    +
    +

    Note

    +

    If you want your type to be subclassable from Python, and your type has the same +tp_basicsize as its base type, you may have problems with multiple +inheritance. A Python subclass of your type will have to list your type first +in its __bases__, or else it will not be able to call your type’s +__new__() method without getting an error. You can avoid this problem by +ensuring that your type has a larger value for tp_basicsize than its +base type does. Most of the time, this will be true anyway, because either your +base type will be object, or else you will be adding data members to +your base type, and therefore increasing its size.

    +
    +

    We set the class flags to Py_TPFLAGS_DEFAULT.

    +
    .tp_flags = Py_TPFLAGS_DEFAULT,
    +
    +
    +

    All types should include this constant in their flags. It enables all of the +members defined until at least Python 3.3. If you need further members, +you will need to OR the corresponding flags.

    +

    We provide a doc string for the type in tp_doc.

    +
    .tp_doc = "Custom objects",
    +
    +
    +

    To enable object creation, we have to provide a tp_new +handler. This is the equivalent of the Python method __new__(), but +has to be specified explicitly. In this case, we can just use the default +implementation provided by the API function PyType_GenericNew().

    +
    .tp_new = PyType_GenericNew,
    +
    +
    +

    Everything else in the file should be familiar, except for some code in +PyInit_custom():

    +
    if (PyType_Ready(&CustomType) < 0)
    +    return;
    +
    +
    +

    This initializes the Custom type, filling in a number of members +to the appropriate default values, including ob_type that we initially +set to NULL.

    +
    PyModule_AddObject(m, "Custom", (PyObject *) &CustomType);
    +
    +
    +

    This adds the type to the module dictionary. This allows us to create +Custom instances by calling the Custom class:

    +
    >>> import custom
    +>>> mycustom = custom.Custom()
    +
    +
    +

    That’s it! All that remains is to build it; put the above code in a file called +custom.c and:

    +
    from distutils.core import setup, Extension
    +setup(name="custom", version="1.0",
    +      ext_modules=[Extension("custom", ["custom.c"])])
    +
    +
    +

    in a file called setup.py; then typing

    +
    $ python setup.py build
    +
    +
    +

    at a shell should produce a file custom.so in a subdirectory; move to +that directory and fire up Python — you should be able to import custom and +play around with Custom objects.

    +

    That wasn’t so hard, was it?

    +

    Of course, the current Custom type is pretty uninteresting. It has no data and +doesn’t do anything. It can’t even be subclassed.

    +
    +

    Note

    +

    While this documentation showcases the standard distutils module +for building C extensions, it is recommended in real-world use cases to +use the newer and better-maintained setuptools library. Documentation +on how to do this is out of scope for this document and can be found in +the Python Packaging User’s Guide.

    +
    +
    +
    +

    2.2. Adding data and methods to the Basic example

    +

    Let’s extend the basic example to add some data and methods. Let’s also make +the type usable as a base class. We’ll create a new module, custom2 that +adds these capabilities:

    +
    #define PY_SSIZE_T_CLEAN
    +#include <Python.h>
    +#include "structmember.h"
    +
    +typedef struct {
    +    PyObject_HEAD
    +    PyObject *first; /* first name */
    +    PyObject *last;  /* last name */
    +    int number;
    +} CustomObject;
    +
    +static void
    +Custom_dealloc(CustomObject *self)
    +{
    +    Py_XDECREF(self->first);
    +    Py_XDECREF(self->last);
    +    Py_TYPE(self)->tp_free((PyObject *) self);
    +}
    +
    +static PyObject *
    +Custom_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
    +{
    +    CustomObject *self;
    +    self = (CustomObject *) type->tp_alloc(type, 0);
    +    if (self != NULL) {
    +        self->first = PyUnicode_FromString("");
    +        if (self->first == NULL) {
    +            Py_DECREF(self);
    +            return NULL;
    +        }
    +        self->last = PyUnicode_FromString("");
    +        if (self->last == NULL) {
    +            Py_DECREF(self);
    +            return NULL;
    +        }
    +        self->number = 0;
    +    }
    +    return (PyObject *) self;
    +}
    +
    +static int
    +Custom_init(CustomObject *self, PyObject *args, PyObject *kwds)
    +{
    +    static char *kwlist[] = {"first", "last", "number", NULL};
    +    PyObject *first = NULL, *last = NULL, *tmp;
    +
    +    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OOi", kwlist,
    +                                     &first, &last,
    +                                     &self->number))
    +        return -1;
    +
    +    if (first) {
    +        tmp = self->first;
    +        Py_INCREF(first);
    +        self->first = first;
    +        Py_XDECREF(tmp);
    +    }
    +    if (last) {
    +        tmp = self->last;
    +        Py_INCREF(last);
    +        self->last = last;
    +        Py_XDECREF(tmp);
    +    }
    +    return 0;
    +}
    +
    +static PyMemberDef Custom_members[] = {
    +    {"first", T_OBJECT_EX, offsetof(CustomObject, first), 0,
    +     "first name"},
    +    {"last", T_OBJECT_EX, offsetof(CustomObject, last), 0,
    +     "last name"},
    +    {"number", T_INT, offsetof(CustomObject, number), 0,
    +     "custom number"},
    +    {NULL}  /* Sentinel */
    +};
    +
    +static PyObject *
    +Custom_name(CustomObject *self, PyObject *Py_UNUSED(ignored))
    +{
    +    if (self->first == NULL) {
    +        PyErr_SetString(PyExc_AttributeError, "first");
    +        return NULL;
    +    }
    +    if (self->last == NULL) {
    +        PyErr_SetString(PyExc_AttributeError, "last");
    +        return NULL;
    +    }
    +    return PyUnicode_FromFormat("%S %S", self->first, self->last);
    +}
    +
    +static PyMethodDef Custom_methods[] = {
    +    {"name", (PyCFunction) Custom_name, METH_NOARGS,
    +     "Return the name, combining the first and last name"
    +    },
    +    {NULL}  /* Sentinel */
    +};
    +
    +static PyTypeObject CustomType = {
    +    PyVarObject_HEAD_INIT(NULL, 0)
    +    .tp_name = "custom2.Custom",
    +    .tp_doc = "Custom objects",
    +    .tp_basicsize = sizeof(CustomObject),
    +    .tp_itemsize = 0,
    +    .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
    +    .tp_new = Custom_new,
    +    .tp_init = (initproc) Custom_init,
    +    .tp_dealloc = (destructor) Custom_dealloc,
    +    .tp_members = Custom_members,
    +    .tp_methods = Custom_methods,
    +};
    +
    +static PyModuleDef custommodule = {
    +    PyModuleDef_HEAD_INIT,
    +    .m_name = "custom2",
    +    .m_doc = "Example module that creates an extension type.",
    +    .m_size = -1,
    +};
    +
    +PyMODINIT_FUNC
    +PyInit_custom2(void)
    +{
    +    PyObject *m;
    +    if (PyType_Ready(&CustomType) < 0)
    +        return NULL;
    +
    +    m = PyModule_Create(&custommodule);
    +    if (m == NULL)
    +        return NULL;
    +
    +    Py_INCREF(&CustomType);
    +    PyModule_AddObject(m, "Custom", (PyObject *) &CustomType);
    +    return m;
    +}
    +
    +
    +

    This version of the module has a number of changes.

    +

    We’ve added an extra include:

    +
    #include <structmember.h>
    +
    +
    +

    This include provides declarations that we use to handle attributes, as +described a bit later.

    +

    The Custom type now has three data attributes in its C struct, +first, last, and number. The first and last variables are Python +strings containing first and last names. The number attribute is a C integer.

    +

    The object structure is updated accordingly:

    +
    typedef struct {
    +    PyObject_HEAD
    +    PyObject *first; /* first name */
    +    PyObject *last;  /* last name */
    +    int number;
    +} CustomObject;
    +
    +
    +

    Because we now have data to manage, we have to be more careful about object +allocation and deallocation. At a minimum, we need a deallocation method:

    +
    static void
    +Custom_dealloc(CustomObject *self)
    +{
    +    Py_XDECREF(self->first);
    +    Py_XDECREF(self->last);
    +    Py_TYPE(self)->tp_free((PyObject *) self);
    +}
    +
    +
    +

    which is assigned to the tp_dealloc member:

    +
    .tp_dealloc = (destructor) Custom_dealloc,
    +
    +
    +

    This method first clears the reference counts of the two Python attributes. +Py_XDECREF() correctly handles the case where its argument is +NULL (which might happen here if tp_new failed midway). It then +calls the tp_free member of the object’s type +(computed by Py_TYPE(self)) to free the object’s memory. Note that +the object’s type might not be CustomType, because the object may +be an instance of a subclass.

    +
    +

    Note

    +

    The explicit cast to destructor above is needed because we defined +Custom_dealloc to take a CustomObject * argument, but the tp_dealloc +function pointer expects to receive a PyObject * argument. Otherwise, +the compiler will emit a warning. This is object-oriented polymorphism, +in C!

    +
    +

    We want to make sure that the first and last names are initialized to empty +strings, so we provide a tp_new implementation:

    +
    static PyObject *
    +Custom_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
    +{
    +    CustomObject *self;
    +    self = (CustomObject *) type->tp_alloc(type, 0);
    +    if (self != NULL) {
    +        self->first = PyUnicode_FromString("");
    +        if (self->first == NULL) {
    +            Py_DECREF(self);
    +            return NULL;
    +        }
    +        self->last = PyUnicode_FromString("");
    +        if (self->last == NULL) {
    +            Py_DECREF(self);
    +            return NULL;
    +        }
    +        self->number = 0;
    +    }
    +    return (PyObject *) self;
    +}
    +
    +
    +

    and install it in the tp_new member:

    +
    .tp_new = Custom_new,
    +
    +
    +

    The tp_new handler is responsible for creating (as opposed to initializing) +objects of the type. It is exposed in Python as the __new__() method. +It is not required to define a tp_new member, and indeed many extension +types will simply reuse PyType_GenericNew() as done in the first +version of the Custom type above. In this case, we use the tp_new +handler to initialize the first and last attributes to non-NULL +default values.

    +

    tp_new is passed the type being instantiated (not necessarily CustomType, +if a subclass is instantiated) and any arguments passed when the type was +called, and is expected to return the instance created. tp_new handlers +always accept positional and keyword arguments, but they often ignore the +arguments, leaving the argument handling to initializer (a.k.a. tp_init +in C or __init__ in Python) methods.

    +
    +

    Note

    +

    tp_new shouldn’t call tp_init explicitly, as the interpreter +will do it itself.

    +
    +

    The tp_new implementation calls the tp_alloc +slot to allocate memory:

    +
    self = (CustomObject *) type->tp_alloc(type, 0);
    +
    +
    +

    Since memory allocation may fail, we must check the tp_alloc +result against NULL before proceeding.

    +
    +

    Note

    +

    We didn’t fill the tp_alloc slot ourselves. Rather +PyType_Ready() fills it for us by inheriting it from our base class, +which is object by default. Most types use the default allocation +strategy.

    +
    +
    +

    Note

    +

    If you are creating a co-operative tp_new (one +that calls a base type’s tp_new or __new__()), +you must not try to determine what method to call using method resolution +order at runtime. Always statically determine what type you are going to +call, and call its tp_new directly, or via +type->tp_base->tp_new. If you do not do this, Python subclasses of your +type that also inherit from other Python-defined classes may not work correctly. +(Specifically, you may not be able to create instances of such subclasses +without getting a TypeError.)

    +
    +

    We also define an initialization function which accepts arguments to provide +initial values for our instance:

    +
    static int
    +Custom_init(CustomObject *self, PyObject *args, PyObject *kwds)
    +{
    +    static char *kwlist[] = {"first", "last", "number", NULL};
    +    PyObject *first = NULL, *last = NULL, *tmp;
    +
    +    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OOi", kwlist,
    +                                     &first, &last,
    +                                     &self->number))
    +        return -1;
    +
    +    if (first) {
    +        tmp = self->first;
    +        Py_INCREF(first);
    +        self->first = first;
    +        Py_XDECREF(tmp);
    +    }
    +    if (last) {
    +        tmp = self->last;
    +        Py_INCREF(last);
    +        self->last = last;
    +        Py_XDECREF(tmp);
    +    }
    +    return 0;
    +}
    +
    +
    +

    by filling the tp_init slot.

    +
    .tp_init = (initproc) Custom_init,
    +
    +
    +

    The tp_init slot is exposed in Python as the +__init__() method. It is used to initialize an object after it’s +created. Initializers always accept positional and keyword arguments, +and they should return either 0 on success or -1 on error.

    +

    Unlike the tp_new handler, there is no guarantee that tp_init +is called at all (for example, the pickle module by default +doesn’t call __init__() on unpickled instances). It can also be +called multiple times. Anyone can call the __init__() method on +our objects. For this reason, we have to be extra careful when assigning +the new attribute values. We might be tempted, for example to assign the +first member like this:

    +
    if (first) {
    +    Py_XDECREF(self->first);
    +    Py_INCREF(first);
    +    self->first = first;
    +}
    +
    +
    +

    But this would be risky. Our type doesn’t restrict the type of the +first member, so it could be any kind of object. It could have a +destructor that causes code to be executed that tries to access the +first member; or that destructor could release the +Global interpreter Lock and let arbitrary code run in other +threads that accesses and modifies our object.

    +

    To be paranoid and protect ourselves against this possibility, we almost +always reassign members before decrementing their reference counts. When +don’t we have to do this?

    +
      +
    • when we absolutely know that the reference count is greater than 1;

    • +
    • when we know that deallocation of the object 1 will neither release +the GIL nor cause any calls back into our type’s code;

    • +
    • when decrementing a reference count in a tp_dealloc +handler on a type which doesn’t support cyclic garbage collection 2.

    • +
    +

    We want to expose our instance variables as attributes. There are a +number of ways to do that. The simplest way is to define member definitions:

    +
    static PyMemberDef Custom_members[] = {
    +    {"first", T_OBJECT_EX, offsetof(CustomObject, first), 0,
    +     "first name"},
    +    {"last", T_OBJECT_EX, offsetof(CustomObject, last), 0,
    +     "last name"},
    +    {"number", T_INT, offsetof(CustomObject, number), 0,
    +     "custom number"},
    +    {NULL}  /* Sentinel */
    +};
    +
    +
    +

    and put the definitions in the tp_members slot:

    +
    .tp_members = Custom_members,
    +
    +
    +

    Each member definition has a member name, type, offset, access flags and +documentation string. See the Generic Attribute Management section +below for details.

    +

    A disadvantage of this approach is that it doesn’t provide a way to restrict the +types of objects that can be assigned to the Python attributes. We expect the +first and last names to be strings, but any Python objects can be assigned. +Further, the attributes can be deleted, setting the C pointers to NULL. Even +though we can make sure the members are initialized to non-NULL values, the +members can be set to NULL if the attributes are deleted.

    +

    We define a single method, Custom.name(), that outputs the objects name as the +concatenation of the first and last names.

    +
    static PyObject *
    +Custom_name(CustomObject *self)
    +{
    +    if (self->first == NULL) {
    +        PyErr_SetString(PyExc_AttributeError, "first");
    +        return NULL;
    +    }
    +    if (self->last == NULL) {
    +        PyErr_SetString(PyExc_AttributeError, "last");
    +        return NULL;
    +    }
    +    return PyUnicode_FromFormat("%S %S", self->first, self->last);
    +}
    +
    +
    +

    The method is implemented as a C function that takes a Custom (or +Custom subclass) instance as the first argument. Methods always take an +instance as the first argument. Methods often take positional and keyword +arguments as well, but in this case we don’t take any and don’t need to accept +a positional argument tuple or keyword argument dictionary. This method is +equivalent to the Python method:

    +
    def name(self):
    +    return "%s %s" % (self.first, self.last)
    +
    +
    +

    Note that we have to check for the possibility that our first and +last members are NULL. This is because they can be deleted, in which +case they are set to NULL. It would be better to prevent deletion of these +attributes and to restrict the attribute values to be strings. We’ll see how to +do that in the next section.

    +

    Now that we’ve defined the method, we need to create an array of method +definitions:

    +
    static PyMethodDef Custom_methods[] = {
    +    {"name", (PyCFunction) Custom_name, METH_NOARGS,
    +     "Return the name, combining the first and last name"
    +    },
    +    {NULL}  /* Sentinel */
    +};
    +
    +
    +

    (note that we used the METH_NOARGS flag to indicate that the method +is expecting no arguments other than self)

    +

    and assign it to the tp_methods slot:

    +
    .tp_methods = Custom_methods,
    +
    +
    +

    Finally, we’ll make our type usable as a base class for subclassing. We’ve +written our methods carefully so far so that they don’t make any assumptions +about the type of the object being created or used, so all we need to do is +to add the Py_TPFLAGS_BASETYPE to our class flag definition:

    +
    .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
    +
    +
    +

    We rename PyInit_custom() to PyInit_custom2(), update the +module name in the PyModuleDef struct, and update the full class +name in the PyTypeObject struct.

    +

    Finally, we update our setup.py file to build the new module:

    +
    from distutils.core import setup, Extension
    +setup(name="custom", version="1.0",
    +      ext_modules=[
    +         Extension("custom", ["custom.c"]),
    +         Extension("custom2", ["custom2.c"]),
    +         ])
    +
    +
    +
    +
    +

    2.3. Providing finer control over data attributes

    +

    In this section, we’ll provide finer control over how the first and +last attributes are set in the Custom example. In the previous +version of our module, the instance variables first and last +could be set to non-string values or even deleted. We want to make sure that +these attributes always contain strings.

    +
    #define PY_SSIZE_T_CLEAN
    +#include <Python.h>
    +#include "structmember.h"
    +
    +typedef struct {
    +    PyObject_HEAD
    +    PyObject *first; /* first name */
    +    PyObject *last;  /* last name */
    +    int number;
    +} CustomObject;
    +
    +static void
    +Custom_dealloc(CustomObject *self)
    +{
    +    Py_XDECREF(self->first);
    +    Py_XDECREF(self->last);
    +    Py_TYPE(self)->tp_free((PyObject *) self);
    +}
    +
    +static PyObject *
    +Custom_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
    +{
    +    CustomObject *self;
    +    self = (CustomObject *) type->tp_alloc(type, 0);
    +    if (self != NULL) {
    +        self->first = PyUnicode_FromString("");
    +        if (self->first == NULL) {
    +            Py_DECREF(self);
    +            return NULL;
    +        }
    +        self->last = PyUnicode_FromString("");
    +        if (self->last == NULL) {
    +            Py_DECREF(self);
    +            return NULL;
    +        }
    +        self->number = 0;
    +    }
    +    return (PyObject *) self;
    +}
    +
    +static int
    +Custom_init(CustomObject *self, PyObject *args, PyObject *kwds)
    +{
    +    static char *kwlist[] = {"first", "last", "number", NULL};
    +    PyObject *first = NULL, *last = NULL, *tmp;
    +
    +    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|UUi", kwlist,
    +                                     &first, &last,
    +                                     &self->number))
    +        return -1;
    +
    +    if (first) {
    +        tmp = self->first;
    +        Py_INCREF(first);
    +        self->first = first;
    +        Py_DECREF(tmp);
    +    }
    +    if (last) {
    +        tmp = self->last;
    +        Py_INCREF(last);
    +        self->last = last;
    +        Py_DECREF(tmp);
    +    }
    +    return 0;
    +}
    +
    +static PyMemberDef Custom_members[] = {
    +    {"number", T_INT, offsetof(CustomObject, number), 0,
    +     "custom number"},
    +    {NULL}  /* Sentinel */
    +};
    +
    +static PyObject *
    +Custom_getfirst(CustomObject *self, void *closure)
    +{
    +    Py_INCREF(self->first);
    +    return self->first;
    +}
    +
    +static int
    +Custom_setfirst(CustomObject *self, PyObject *value, void *closure)
    +{
    +    PyObject *tmp;
    +    if (value == NULL) {
    +        PyErr_SetString(PyExc_TypeError, "Cannot delete the first attribute");
    +        return -1;
    +    }
    +    if (!PyUnicode_Check(value)) {
    +        PyErr_SetString(PyExc_TypeError,
    +                        "The first attribute value must be a string");
    +        return -1;
    +    }
    +    tmp = self->first;
    +    Py_INCREF(value);
    +    self->first = value;
    +    Py_DECREF(tmp);
    +    return 0;
    +}
    +
    +static PyObject *
    +Custom_getlast(CustomObject *self, void *closure)
    +{
    +    Py_INCREF(self->last);
    +    return self->last;
    +}
    +
    +static int
    +Custom_setlast(CustomObject *self, PyObject *value, void *closure)
    +{
    +    PyObject *tmp;
    +    if (value == NULL) {
    +        PyErr_SetString(PyExc_TypeError, "Cannot delete the last attribute");
    +        return -1;
    +    }
    +    if (!PyUnicode_Check(value)) {
    +        PyErr_SetString(PyExc_TypeError,
    +                        "The last attribute value must be a string");
    +        return -1;
    +    }
    +    tmp = self->last;
    +    Py_INCREF(value);
    +    self->last = value;
    +    Py_DECREF(tmp);
    +    return 0;
    +}
    +
    +static PyGetSetDef Custom_getsetters[] = {
    +    {"first", (getter) Custom_getfirst, (setter) Custom_setfirst,
    +     "first name", NULL},
    +    {"last", (getter) Custom_getlast, (setter) Custom_setlast,
    +     "last name", NULL},
    +    {NULL}  /* Sentinel */
    +};
    +
    +static PyObject *
    +Custom_name(CustomObject *self, PyObject *Py_UNUSED(ignored))
    +{
    +    return PyUnicode_FromFormat("%S %S", self->first, self->last);
    +}
    +
    +static PyMethodDef Custom_methods[] = {
    +    {"name", (PyCFunction) Custom_name, METH_NOARGS,
    +     "Return the name, combining the first and last name"
    +    },
    +    {NULL}  /* Sentinel */
    +};
    +
    +static PyTypeObject CustomType = {
    +    PyVarObject_HEAD_INIT(NULL, 0)
    +    .tp_name = "custom3.Custom",
    +    .tp_doc = "Custom objects",
    +    .tp_basicsize = sizeof(CustomObject),
    +    .tp_itemsize = 0,
    +    .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
    +    .tp_new = Custom_new,
    +    .tp_init = (initproc) Custom_init,
    +    .tp_dealloc = (destructor) Custom_dealloc,
    +    .tp_members = Custom_members,
    +    .tp_methods = Custom_methods,
    +    .tp_getset = Custom_getsetters,
    +};
    +
    +static PyModuleDef custommodule = {
    +    PyModuleDef_HEAD_INIT,
    +    .m_name = "custom3",
    +    .m_doc = "Example module that creates an extension type.",
    +    .m_size = -1,
    +};
    +
    +PyMODINIT_FUNC
    +PyInit_custom3(void)
    +{
    +    PyObject *m;
    +    if (PyType_Ready(&CustomType) < 0)
    +        return NULL;
    +
    +    m = PyModule_Create(&custommodule);
    +    if (m == NULL)
    +        return NULL;
    +
    +    Py_INCREF(&CustomType);
    +    PyModule_AddObject(m, "Custom", (PyObject *) &CustomType);
    +    return m;
    +}
    +
    +
    +

    To provide greater control, over the first and last attributes, +we’ll use custom getter and setter functions. Here are the functions for +getting and setting the first attribute:

    +
    static PyObject *
    +Custom_getfirst(CustomObject *self, void *closure)
    +{
    +    Py_INCREF(self->first);
    +    return self->first;
    +}
    +
    +static int
    +Custom_setfirst(CustomObject *self, PyObject *value, void *closure)
    +{
    +    PyObject *tmp;
    +    if (value == NULL) {
    +        PyErr_SetString(PyExc_TypeError, "Cannot delete the first attribute");
    +        return -1;
    +    }
    +    if (!PyUnicode_Check(value)) {
    +        PyErr_SetString(PyExc_TypeError,
    +                        "The first attribute value must be a string");
    +        return -1;
    +    }
    +    tmp = self->first;
    +    Py_INCREF(value);
    +    self->first = value;
    +    Py_DECREF(tmp);
    +    return 0;
    +}
    +
    +
    +

    The getter function is passed a Custom object and a “closure”, which is +a void pointer. In this case, the closure is ignored. (The closure supports an +advanced usage in which definition data is passed to the getter and setter. This +could, for example, be used to allow a single set of getter and setter functions +that decide the attribute to get or set based on data in the closure.)

    +

    The setter function is passed the Custom object, the new value, and the +closure. The new value may be NULL, in which case the attribute is being +deleted. In our setter, we raise an error if the attribute is deleted or if its +new value is not a string.

    +

    We create an array of PyGetSetDef structures:

    +
    static PyGetSetDef Custom_getsetters[] = {
    +    {"first", (getter) Custom_getfirst, (setter) Custom_setfirst,
    +     "first name", NULL},
    +    {"last", (getter) Custom_getlast, (setter) Custom_setlast,
    +     "last name", NULL},
    +    {NULL}  /* Sentinel */
    +};
    +
    +
    +

    and register it in the tp_getset slot:

    +
    .tp_getset = Custom_getsetters,
    +
    +
    +

    The last item in a PyGetSetDef structure is the “closure” mentioned +above. In this case, we aren’t using a closure, so we just pass NULL.

    +

    We also remove the member definitions for these attributes:

    +
    static PyMemberDef Custom_members[] = {
    +    {"number", T_INT, offsetof(CustomObject, number), 0,
    +     "custom number"},
    +    {NULL}  /* Sentinel */
    +};
    +
    +
    +

    We also need to update the tp_init handler to only +allow strings 3 to be passed:

    +
    static int
    +Custom_init(CustomObject *self, PyObject *args, PyObject *kwds)
    +{
    +    static char *kwlist[] = {"first", "last", "number", NULL};
    +    PyObject *first = NULL, *last = NULL, *tmp;
    +
    +    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|UUi", kwlist,
    +                                     &first, &last,
    +                                     &self->number))
    +        return -1;
    +
    +    if (first) {
    +        tmp = self->first;
    +        Py_INCREF(first);
    +        self->first = first;
    +        Py_DECREF(tmp);
    +    }
    +    if (last) {
    +        tmp = self->last;
    +        Py_INCREF(last);
    +        self->last = last;
    +        Py_DECREF(tmp);
    +    }
    +    return 0;
    +}
    +
    +
    +

    With these changes, we can assure that the first and last members are +never NULL so we can remove checks for NULL values in almost all cases. +This means that most of the Py_XDECREF() calls can be converted to +Py_DECREF() calls. The only place we can’t change these calls is in +the tp_dealloc implementation, where there is the possibility that the +initialization of these members failed in tp_new.

    +

    We also rename the module initialization function and module name in the +initialization function, as we did before, and we add an extra definition to the +setup.py file.

    +
    +
    +

    2.4. Supporting cyclic garbage collection

    +

    Python has a cyclic garbage collector (GC) that +can identify unneeded objects even when their reference counts are not zero. +This can happen when objects are involved in cycles. For example, consider:

    +
    >>> l = []
    +>>> l.append(l)
    +>>> del l
    +
    +
    +

    In this example, we create a list that contains itself. When we delete it, it +still has a reference from itself. Its reference count doesn’t drop to zero. +Fortunately, Python’s cyclic garbage collector will eventually figure out that +the list is garbage and free it.

    +

    In the second version of the Custom example, we allowed any kind of +object to be stored in the first or last attributes 4. +Besides, in the second and third versions, we allowed subclassing +Custom, and subclasses may add arbitrary attributes. For any of +those two reasons, Custom objects can participate in cycles:

    +
    >>> import custom3
    +>>> class Derived(custom3.Custom): pass
    +...
    +>>> n = Derived()
    +>>> n.some_attribute = n
    +
    +
    +

    To allow a Custom instance participating in a reference cycle to +be properly detected and collected by the cyclic GC, our Custom type +needs to fill two additional slots and to enable a flag that enables these slots:

    +
    #define PY_SSIZE_T_CLEAN
    +#include <Python.h>
    +#include "structmember.h"
    +
    +typedef struct {
    +    PyObject_HEAD
    +    PyObject *first; /* first name */
    +    PyObject *last;  /* last name */
    +    int number;
    +} CustomObject;
    +
    +static int
    +Custom_traverse(CustomObject *self, visitproc visit, void *arg)
    +{
    +    Py_VISIT(self->first);
    +    Py_VISIT(self->last);
    +    return 0;
    +}
    +
    +static int
    +Custom_clear(CustomObject *self)
    +{
    +    Py_CLEAR(self->first);
    +    Py_CLEAR(self->last);
    +    return 0;
    +}
    +
    +static void
    +Custom_dealloc(CustomObject *self)
    +{
    +    PyObject_GC_UnTrack(self);
    +    Custom_clear(self);
    +    Py_TYPE(self)->tp_free((PyObject *) self);
    +}
    +
    +static PyObject *
    +Custom_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
    +{
    +    CustomObject *self;
    +    self = (CustomObject *) type->tp_alloc(type, 0);
    +    if (self != NULL) {
    +        self->first = PyUnicode_FromString("");
    +        if (self->first == NULL) {
    +            Py_DECREF(self);
    +            return NULL;
    +        }
    +        self->last = PyUnicode_FromString("");
    +        if (self->last == NULL) {
    +            Py_DECREF(self);
    +            return NULL;
    +        }
    +        self->number = 0;
    +    }
    +    return (PyObject *) self;
    +}
    +
    +static int
    +Custom_init(CustomObject *self, PyObject *args, PyObject *kwds)
    +{
    +    static char *kwlist[] = {"first", "last", "number", NULL};
    +    PyObject *first = NULL, *last = NULL, *tmp;
    +
    +    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|UUi", kwlist,
    +                                     &first, &last,
    +                                     &self->number))
    +        return -1;
    +
    +    if (first) {
    +        tmp = self->first;
    +        Py_INCREF(first);
    +        self->first = first;
    +        Py_DECREF(tmp);
    +    }
    +    if (last) {
    +        tmp = self->last;
    +        Py_INCREF(last);
    +        self->last = last;
    +        Py_DECREF(tmp);
    +    }
    +    return 0;
    +}
    +
    +static PyMemberDef Custom_members[] = {
    +    {"number", T_INT, offsetof(CustomObject, number), 0,
    +     "custom number"},
    +    {NULL}  /* Sentinel */
    +};
    +
    +static PyObject *
    +Custom_getfirst(CustomObject *self, void *closure)
    +{
    +    Py_INCREF(self->first);
    +    return self->first;
    +}
    +
    +static int
    +Custom_setfirst(CustomObject *self, PyObject *value, void *closure)
    +{
    +    if (value == NULL) {
    +        PyErr_SetString(PyExc_TypeError, "Cannot delete the first attribute");
    +        return -1;
    +    }
    +    if (!PyUnicode_Check(value)) {
    +        PyErr_SetString(PyExc_TypeError,
    +                        "The first attribute value must be a string");
    +        return -1;
    +    }
    +    Py_INCREF(value);
    +    Py_CLEAR(self->first);
    +    self->first = value;
    +    return 0;
    +}
    +
    +static PyObject *
    +Custom_getlast(CustomObject *self, void *closure)
    +{
    +    Py_INCREF(self->last);
    +    return self->last;
    +}
    +
    +static int
    +Custom_setlast(CustomObject *self, PyObject *value, void *closure)
    +{
    +    if (value == NULL) {
    +        PyErr_SetString(PyExc_TypeError, "Cannot delete the last attribute");
    +        return -1;
    +    }
    +    if (!PyUnicode_Check(value)) {
    +        PyErr_SetString(PyExc_TypeError,
    +                        "The last attribute value must be a string");
    +        return -1;
    +    }
    +    Py_INCREF(value);
    +    Py_CLEAR(self->last);
    +    self->last = value;
    +    return 0;
    +}
    +
    +static PyGetSetDef Custom_getsetters[] = {
    +    {"first", (getter) Custom_getfirst, (setter) Custom_setfirst,
    +     "first name", NULL},
    +    {"last", (getter) Custom_getlast, (setter) Custom_setlast,
    +     "last name", NULL},
    +    {NULL}  /* Sentinel */
    +};
    +
    +static PyObject *
    +Custom_name(CustomObject *self, PyObject *Py_UNUSED(ignored))
    +{
    +    return PyUnicode_FromFormat("%S %S", self->first, self->last);
    +}
    +
    +static PyMethodDef Custom_methods[] = {
    +    {"name", (PyCFunction) Custom_name, METH_NOARGS,
    +     "Return the name, combining the first and last name"
    +    },
    +    {NULL}  /* Sentinel */
    +};
    +
    +static PyTypeObject CustomType = {
    +    PyVarObject_HEAD_INIT(NULL, 0)
    +    .tp_name = "custom4.Custom",
    +    .tp_doc = "Custom objects",
    +    .tp_basicsize = sizeof(CustomObject),
    +    .tp_itemsize = 0,
    +    .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
    +    .tp_new = Custom_new,
    +    .tp_init = (initproc) Custom_init,
    +    .tp_dealloc = (destructor) Custom_dealloc,
    +    .tp_traverse = (traverseproc) Custom_traverse,
    +    .tp_clear = (inquiry) Custom_clear,
    +    .tp_members = Custom_members,
    +    .tp_methods = Custom_methods,
    +    .tp_getset = Custom_getsetters,
    +};
    +
    +static PyModuleDef custommodule = {
    +    PyModuleDef_HEAD_INIT,
    +    .m_name = "custom4",
    +    .m_doc = "Example module that creates an extension type.",
    +    .m_size = -1,
    +};
    +
    +PyMODINIT_FUNC
    +PyInit_custom4(void)
    +{
    +    PyObject *m;
    +    if (PyType_Ready(&CustomType) < 0)
    +        return NULL;
    +
    +    m = PyModule_Create(&custommodule);
    +    if (m == NULL)
    +        return NULL;
    +
    +    Py_INCREF(&CustomType);
    +    PyModule_AddObject(m, "Custom", (PyObject *) &CustomType);
    +    return m;
    +}
    +
    +
    +

    First, the traversal method lets the cyclic GC know about subobjects that could +participate in cycles:

    +
    static int
    +Custom_traverse(CustomObject *self, visitproc visit, void *arg)
    +{
    +    int vret;
    +    if (self->first) {
    +        vret = visit(self->first, arg);
    +        if (vret != 0)
    +            return vret;
    +    }
    +    if (self->last) {
    +        vret = visit(self->last, arg);
    +        if (vret != 0)
    +            return vret;
    +    }
    +    return 0;
    +}
    +
    +
    +

    For each subobject that can participate in cycles, we need to call the +visit() function, which is passed to the traversal method. The +visit() function takes as arguments the subobject and the extra argument +arg passed to the traversal method. It returns an integer value that must be +returned if it is non-zero.

    +

    Python provides a Py_VISIT() macro that automates calling visit +functions. With Py_VISIT(), we can minimize the amount of boilerplate +in Custom_traverse:

    +
    static int
    +Custom_traverse(CustomObject *self, visitproc visit, void *arg)
    +{
    +    Py_VISIT(self->first);
    +    Py_VISIT(self->last);
    +    return 0;
    +}
    +
    +
    +
    +

    Note

    +

    The tp_traverse implementation must name its +arguments exactly visit and arg in order to use Py_VISIT().

    +
    +

    Second, we need to provide a method for clearing any subobjects that can +participate in cycles:

    +
    static int
    +Custom_clear(CustomObject *self)
    +{
    +    Py_CLEAR(self->first);
    +    Py_CLEAR(self->last);
    +    return 0;
    +}
    +
    +
    +

    Notice the use of the Py_CLEAR() macro. It is the recommended and safe +way to clear data attributes of arbitrary types while decrementing +their reference counts. If you were to call Py_XDECREF() instead +on the attribute before setting it to NULL, there is a possibility +that the attribute’s destructor would call back into code that reads the +attribute again (especially if there is a reference cycle).

    +
    +

    Note

    +

    You could emulate Py_CLEAR() by writing:

    +
    PyObject *tmp;
    +tmp = self->first;
    +self->first = NULL;
    +Py_XDECREF(tmp);
    +
    +
    +

    Nevertheless, it is much easier and less error-prone to always +use Py_CLEAR() when deleting an attribute. Don’t +try to micro-optimize at the expense of robustness!

    +
    +

    The deallocator Custom_dealloc may call arbitrary code when clearing +attributes. It means the circular GC can be triggered inside the function. +Since the GC assumes reference count is not zero, we need to untrack the object +from the GC by calling PyObject_GC_UnTrack() before clearing members. +Here is our reimplemented deallocator using PyObject_GC_UnTrack() +and Custom_clear:

    +
    static void
    +Custom_dealloc(CustomObject *self)
    +{
    +    PyObject_GC_UnTrack(self);
    +    Custom_clear(self);
    +    Py_TYPE(self)->tp_free((PyObject *) self);
    +}
    +
    +
    +

    Finally, we add the Py_TPFLAGS_HAVE_GC flag to the class flags:

    +
    .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
    +
    +
    +

    That’s pretty much it. If we had written custom tp_alloc or +tp_free handlers, we’d need to modify them for cyclic +garbage collection. Most extensions will use the versions automatically provided.

    +
    +
    +

    2.5. Subclassing other types

    +

    It is possible to create new extension types that are derived from existing +types. It is easiest to inherit from the built in types, since an extension can +easily use the PyTypeObject it needs. It can be difficult to share +these PyTypeObject structures between extension modules.

    +

    In this example we will create a SubList type that inherits from the +built-in list type. The new type will be completely compatible with +regular lists, but will have an additional increment() method that +increases an internal counter:

    +
    >>> import sublist
    +>>> s = sublist.SubList(range(3))
    +>>> s.extend(s)
    +>>> print(len(s))
    +6
    +>>> print(s.increment())
    +1
    +>>> print(s.increment())
    +2
    +
    +
    +
    #define PY_SSIZE_T_CLEAN
    +#include <Python.h>
    +
    +typedef struct {
    +    PyListObject list;
    +    int state;
    +} SubListObject;
    +
    +static PyObject *
    +SubList_increment(SubListObject *self, PyObject *unused)
    +{
    +    self->state++;
    +    return PyLong_FromLong(self->state);
    +}
    +
    +static PyMethodDef SubList_methods[] = {
    +    {"increment", (PyCFunction) SubList_increment, METH_NOARGS,
    +     PyDoc_STR("increment state counter")},
    +    {NULL},
    +};
    +
    +static int
    +SubList_init(SubListObject *self, PyObject *args, PyObject *kwds)
    +{
    +    if (PyList_Type.tp_init((PyObject *) self, args, kwds) < 0)
    +        return -1;
    +    self->state = 0;
    +    return 0;
    +}
    +
    +static PyTypeObject SubListType = {
    +    PyVarObject_HEAD_INIT(NULL, 0)
    +    .tp_name = "sublist.SubList",
    +    .tp_doc = "SubList objects",
    +    .tp_basicsize = sizeof(SubListObject),
    +    .tp_itemsize = 0,
    +    .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
    +    .tp_init = (initproc) SubList_init,
    +    .tp_methods = SubList_methods,
    +};
    +
    +static PyModuleDef sublistmodule = {
    +    PyModuleDef_HEAD_INIT,
    +    .m_name = "sublist",
    +    .m_doc = "Example module that creates an extension type.",
    +    .m_size = -1,
    +};
    +
    +PyMODINIT_FUNC
    +PyInit_sublist(void)
    +{
    +    PyObject *m;
    +    SubListType.tp_base = &PyList_Type;
    +    if (PyType_Ready(&SubListType) < 0)
    +        return NULL;
    +
    +    m = PyModule_Create(&sublistmodule);
    +    if (m == NULL)
    +        return NULL;
    +
    +    Py_INCREF(&SubListType);
    +    PyModule_AddObject(m, "SubList", (PyObject *) &SubListType);
    +    return m;
    +}
    +
    +
    +

    As you can see, the source code closely resembles the Custom examples in +previous sections. We will break down the main differences between them.

    +
    typedef struct {
    +    PyListObject list;
    +    int state;
    +} SubListObject;
    +
    +
    +

    The primary difference for derived type objects is that the base type’s +object structure must be the first value. The base type will already include +the PyObject_HEAD() at the beginning of its structure.

    +

    When a Python object is a SubList instance, its PyObject * pointer +can be safely cast to both PyListObject * and SubListObject *:

    +
    static int
    +SubList_init(SubListObject *self, PyObject *args, PyObject *kwds)
    +{
    +    if (PyList_Type.tp_init((PyObject *) self, args, kwds) < 0)
    +        return -1;
    +    self->state = 0;
    +    return 0;
    +}
    +
    +
    +

    We see above how to call through to the __init__ method of the base +type.

    +

    This pattern is important when writing a type with custom +tp_new and tp_dealloc +members. The tp_new handler should not actually +create the memory for the object with its tp_alloc, +but let the base class handle it by calling its own tp_new.

    +

    The PyTypeObject struct supports a tp_base +specifying the type’s concrete base class. Due to cross-platform compiler +issues, you can’t fill that field directly with a reference to +PyList_Type; it should be done later in the module initialization +function:

    +
    PyMODINIT_FUNC
    +PyInit_sublist(void)
    +{
    +    PyObject* m;
    +    SubListType.tp_base = &PyList_Type;
    +    if (PyType_Ready(&SubListType) < 0)
    +        return NULL;
    +
    +    m = PyModule_Create(&sublistmodule);
    +    if (m == NULL)
    +        return NULL;
    +
    +    Py_INCREF(&SubListType);
    +    PyModule_AddObject(m, "SubList", (PyObject *) &SubListType);
    +    return m;
    +}
    +
    +
    +

    Before calling PyType_Ready(), the type structure must have the +tp_base slot filled in. When we are deriving an +existing type, it is not necessary to fill out the tp_alloc +slot with PyType_GenericNew() – the allocation function from the base +type will be inherited.

    +

    After that, calling PyType_Ready() and adding the type object to the +module is the same as with the basic Custom examples.

    +

    Footnotes

    +
    +
    1
    +

    This is true when we know that the object is a basic type, like a string or a +float.

    +
    +
    2
    +

    We relied on this in the tp_dealloc handler +in this example, because our type doesn’t support garbage collection.

    +
    +
    3
    +

    We now know that the first and last members are strings, so perhaps we +could be less careful about decrementing their reference counts, however, +we accept instances of string subclasses. Even though deallocating normal +strings won’t call back into our objects, we can’t guarantee that deallocating +an instance of a string subclass won’t call back into our objects.

    +
    +
    4
    +

    Also, even with our attributes restricted to strings instances, the user +could pass arbitrary str subclasses and therefore still create +reference cycles.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/extending/windows.html b/python-3.7.4-docs-html/extending/windows.html new file mode 100644 index 0000000..1002820 --- /dev/null +++ b/python-3.7.4-docs-html/extending/windows.html @@ -0,0 +1,289 @@ + + + + + + + 5. Building C and C++ Extensions on Windows — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    5. Building C and C++ Extensions on Windows

    +

    This chapter briefly explains how to create a Windows extension module for +Python using Microsoft Visual C++, and follows with more detailed background +information on how it works. The explanatory material is useful for both the +Windows programmer learning to build Python extensions and the Unix programmer +interested in producing software which can be successfully built on both Unix +and Windows.

    +

    Module authors are encouraged to use the distutils approach for building +extension modules, instead of the one described in this section. You will still +need the C compiler that was used to build Python; typically Microsoft Visual +C++.

    +
    +

    Note

    +

    This chapter mentions a number of filenames that include an encoded Python +version number. These filenames are represented with the version number shown +as XY; in practice, 'X' will be the major version number and 'Y' +will be the minor version number of the Python release you’re working with. For +example, if you are using Python 2.2.1, XY will actually be 22.

    +
    +
    +

    5.1. A Cookbook Approach

    +

    There are two approaches to building extension modules on Windows, just as there +are on Unix: use the distutils package to control the build process, or +do things manually. The distutils approach works well for most extensions; +documentation on using distutils to build and package extension modules +is available in Distributing Python Modules (Legacy version). If you find you really need to do +things manually, it may be instructive to study the project file for the +winsound standard library module.

    +
    +
    +

    5.2. Differences Between Unix and Windows

    +

    Unix and Windows use completely different paradigms for run-time loading of +code. Before you try to build a module that can be dynamically loaded, be aware +of how your system works.

    +

    In Unix, a shared object (.so) file contains code to be used by the +program, and also the names of functions and data that it expects to find in the +program. When the file is joined to the program, all references to those +functions and data in the file’s code are changed to point to the actual +locations in the program where the functions and data are placed in memory. +This is basically a link operation.

    +

    In Windows, a dynamic-link library (.dll) file has no dangling +references. Instead, an access to functions or data goes through a lookup +table. So the DLL code does not have to be fixed up at runtime to refer to the +program’s memory; instead, the code already uses the DLL’s lookup table, and the +lookup table is modified at runtime to point to the functions and data.

    +

    In Unix, there is only one type of library file (.a) which contains code +from several object files (.o). During the link step to create a shared +object file (.so), the linker may find that it doesn’t know where an +identifier is defined. The linker will look for it in the object files in the +libraries; if it finds it, it will include all the code from that object file.

    +

    In Windows, there are two types of library, a static library and an import +library (both called .lib). A static library is like a Unix .a +file; it contains code to be included as necessary. An import library is +basically used only to reassure the linker that a certain identifier is legal, +and will be present in the program when the DLL is loaded. So the linker uses +the information from the import library to build the lookup table for using +identifiers that are not included in the DLL. When an application or a DLL is +linked, an import library may be generated, which will need to be used for all +future DLLs that depend on the symbols in the application or DLL.

    +

    Suppose you are building two dynamic-load modules, B and C, which should share +another block of code A. On Unix, you would not pass A.a to the +linker for B.so and C.so; that would cause it to be included +twice, so that B and C would each have their own copy. In Windows, building +A.dll will also build A.lib. You do pass A.lib to the +linker for B and C. A.lib does not contain code; it just contains +information which will be used at runtime to access A’s code.

    +

    In Windows, using an import library is sort of like using import spam; it +gives you access to spam’s names, but does not create a separate copy. On Unix, +linking with a library is more like from spam import *; it does create a +separate copy.

    +
    +
    +

    5.3. Using DLLs in Practice

    +

    Windows Python is built in Microsoft Visual C++; using other compilers may or +may not work (though Borland seems to). The rest of this section is MSVC++ +specific.

    +

    When creating DLLs in Windows, you must pass pythonXY.lib to the linker. +To build two DLLs, spam and ni (which uses C functions found in spam), you could +use these commands:

    +
    cl /LD /I/python/include spam.c ../libs/pythonXY.lib
    +cl /LD /I/python/include ni.c spam.lib ../libs/pythonXY.lib
    +
    +
    +

    The first command created three files: spam.obj, spam.dll and +spam.lib. Spam.dll does not contain any Python functions (such +as PyArg_ParseTuple()), but it does know how to find the Python code +thanks to pythonXY.lib.

    +

    The second command created ni.dll (and .obj and .lib), +which knows how to find the necessary functions from spam, and also from the +Python executable.

    +

    Not every identifier is exported to the lookup table. If you want any other +modules (including Python) to be able to see your identifiers, you have to say +_declspec(dllexport), as in void _declspec(dllexport) initspam(void) or +PyObject _declspec(dllexport) *NiGetSpamData(void).

    +

    Developer Studio will throw in a lot of import libraries that you do not really +need, adding about 100K to your executable. To get rid of them, use the Project +Settings dialog, Link tab, to specify ignore default libraries. Add the +correct msvcrtxx.lib to the list of libraries.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/faq/design.html b/python-3.7.4-docs-html/faq/design.html new file mode 100644 index 0000000..d2a0776 --- /dev/null +++ b/python-3.7.4-docs-html/faq/design.html @@ -0,0 +1,938 @@ + + + + + + + Design and History FAQ — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Design and History FAQ

    +
    +

    Contents

    + +
    +
    +

    Why does Python use indentation for grouping of statements?

    +

    Guido van Rossum believes that using indentation for grouping is extremely +elegant and contributes a lot to the clarity of the average Python program. +Most people learn to love this feature after a while.

    +

    Since there are no begin/end brackets there cannot be a disagreement between +grouping perceived by the parser and the human reader. Occasionally C +programmers will encounter a fragment of code like this:

    +
    if (x <= y)
    +        x++;
    +        y--;
    +z++;
    +
    +
    +

    Only the x++ statement is executed if the condition is true, but the +indentation leads you to believe otherwise. Even experienced C programmers will +sometimes stare at it a long time wondering why y is being decremented even +for x > y.

    +

    Because there are no begin/end brackets, Python is much less prone to +coding-style conflicts. In C there are many different ways to place the braces. +If you’re used to reading and writing code that uses one style, you will feel at +least slightly uneasy when reading (or being required to write) another style.

    +

    Many coding styles place begin/end brackets on a line by themselves. This makes +programs considerably longer and wastes valuable screen space, making it harder +to get a good overview of a program. Ideally, a function should fit on one +screen (say, 20–30 lines). 20 lines of Python can do a lot more work than 20 +lines of C. This is not solely due to the lack of begin/end brackets – the +lack of declarations and the high-level data types are also responsible – but +the indentation-based syntax certainly helps.

    +
    + +
    +

    Why are floating-point calculations so inaccurate?

    +

    Users are often surprised by results like this:

    +
    >>> 1.2 - 1.0
    +0.19999999999999996
    +
    +
    +

    and think it is a bug in Python. It’s not. This has little to do with Python, +and much more to do with how the underlying platform handles floating-point +numbers.

    +

    The float type in CPython uses a C double for storage. A +float object’s value is stored in binary floating-point with a fixed +precision (typically 53 bits) and Python uses C operations, which in turn rely +on the hardware implementation in the processor, to perform floating-point +operations. This means that as far as floating-point operations are concerned, +Python behaves like many popular languages including C and Java.

    +

    Many numbers that can be written easily in decimal notation cannot be expressed +exactly in binary floating-point. For example, after:

    +
    >>> x = 1.2
    +
    +
    +

    the value stored for x is a (very good) approximation to the decimal value +1.2, but is not exactly equal to it. On a typical machine, the actual +stored value is:

    +
    1.0011001100110011001100110011001100110011001100110011 (binary)
    +
    +
    +

    which is exactly:

    +
    1.1999999999999999555910790149937383830547332763671875 (decimal)
    +
    +
    +

    The typical precision of 53 bits provides Python floats with 15–16 +decimal digits of accuracy.

    +

    For a fuller explanation, please see the floating point arithmetic chapter in the Python tutorial.

    +
    +
    +

    Why are Python strings immutable?

    +

    There are several advantages.

    +

    One is performance: knowing that a string is immutable means we can allocate +space for it at creation time, and the storage requirements are fixed and +unchanging. This is also one of the reasons for the distinction between tuples +and lists.

    +

    Another advantage is that strings in Python are considered as “elemental” as +numbers. No amount of activity will change the value 8 to anything else, and in +Python, no amount of activity will change the string “eight” to anything else.

    +
    +
    +

    Why must ‘self’ be used explicitly in method definitions and calls?

    +

    The idea was borrowed from Modula-3. It turns out to be very useful, for a +variety of reasons.

    +

    First, it’s more obvious that you are using a method or instance attribute +instead of a local variable. Reading self.x or self.meth() makes it +absolutely clear that an instance variable or method is used even if you don’t +know the class definition by heart. In C++, you can sort of tell by the lack of +a local variable declaration (assuming globals are rare or easily recognizable) +– but in Python, there are no local variable declarations, so you’d have to +look up the class definition to be sure. Some C++ and Java coding standards +call for instance attributes to have an m_ prefix, so this explicitness is +still useful in those languages, too.

    +

    Second, it means that no special syntax is necessary if you want to explicitly +reference or call the method from a particular class. In C++, if you want to +use a method from a base class which is overridden in a derived class, you have +to use the :: operator – in Python you can write +baseclass.methodname(self, <argument list>). This is particularly useful +for __init__() methods, and in general in cases where a derived class +method wants to extend the base class method of the same name and thus has to +call the base class method somehow.

    +

    Finally, for instance variables it solves a syntactic problem with assignment: +since local variables in Python are (by definition!) those variables to which a +value is assigned in a function body (and that aren’t explicitly declared +global), there has to be some way to tell the interpreter that an assignment was +meant to assign to an instance variable instead of to a local variable, and it +should preferably be syntactic (for efficiency reasons). C++ does this through +declarations, but Python doesn’t have declarations and it would be a pity having +to introduce them just for this purpose. Using the explicit self.var solves +this nicely. Similarly, for using instance variables, having to write +self.var means that references to unqualified names inside a method don’t +have to search the instance’s directories. To put it another way, local +variables and instance variables live in two different namespaces, and you need +to tell Python which namespace to use.

    +
    +
    +

    Why can’t I use an assignment in an expression?

    +

    Many people used to C or Perl complain that they want to use this C idiom:

    +
    while (line = readline(f)) {
    +    // do something with line
    +}
    +
    +
    +

    where in Python you’re forced to write this:

    +
    while True:
    +    line = f.readline()
    +    if not line:
    +        break
    +    ...  # 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:

    +
    if (x = 0) {
    +    // error handling
    +}
    +else {
    +    // code that only works for nonzero x
    +}
    +
    +
    +

    The error is a simple typo: x = 0, which assigns 0 to the variable x, +was written while the comparison x == 0 is certainly what was intended.

    +

    Many alternatives have been proposed. Most are hacks that save some typing but +use arbitrary or cryptic syntax or keywords, and fail the simple criterion for +language change proposals: it should intuitively suggest the proper meaning to a +human reader who has not yet been introduced to the construct.

    +

    An interesting phenomenon is that most experienced Python programmers recognize +the while True idiom and don’t seem to be missing the assignment in +expression construct much; it’s only newcomers who express a strong desire to +add this to the language.

    +

    There’s an alternative way of spelling this that seems attractive but is +generally less robust than the “while True” solution:

    +
    line = f.readline()
    +while line:
    +    ...  # do something with line...
    +    line = f.readline()
    +
    +
    +

    The problem with this is that if you change your mind about exactly how you get +the next line (e.g. you want to change it into sys.stdin.readline()) you +have to remember to change two places in your program – the second occurrence +is hidden at the bottom of the loop.

    +

    The best approach is to use iterators, making it possible to loop through +objects using the for statement. For example, file objects support the iterator protocol, so you can write simply:

    +
    for line in f:
    +    ...  # do something with line...
    +
    +
    +
    +
    +

    Why does Python use methods for some functionality (e.g. list.index()) but functions for other (e.g. len(list))?

    +

    As Guido said:

    +
    +

    (a) For some operations, prefix notation just reads better than +postfix – prefix (and infix!) operations have a long tradition in +mathematics which likes notations where the visuals help the +mathematician thinking about a problem. Compare the easy with which we +rewrite a formula like x*(a+b) into x*a + x*b to the clumsiness of +doing the same thing using a raw OO notation.

    +

    (b) When I read code that says len(x) I know that it is asking for +the length of something. This tells me two things: the result is an +integer, and the argument is some kind of container. To the contrary, +when I read x.len(), I have to already know that x is some kind of +container implementing an interface or inheriting from a class that +has a standard len(). Witness the confusion we occasionally have when +a class that is not implementing a mapping has a get() or keys() +method, or something that isn’t a file has a write() method.

    +

    https://mail.python.org/pipermail/python-3000/2006-November/004643.html

    +
    +
    +
    +

    Why is join() a string method instead of a list or tuple method?

    +

    Strings became much more like other standard types starting in Python 1.6, when +methods were added which give the same functionality that has always been +available using the functions of the string module. Most of these new methods +have been widely accepted, but the one which appears to make some programmers +feel uncomfortable is:

    +
    ", ".join(['1', '2', '4', '8', '16'])
    +
    +
    +

    which gives the result:

    +
    "1, 2, 4, 8, 16"
    +
    +
    +

    There are two common arguments against this usage.

    +

    The first runs along the lines of: “It looks really ugly using a method of a +string literal (string constant)”, to which the answer is that it might, but a +string literal is just a fixed value. If the methods are to be allowed on names +bound to strings there is no logical reason to make them unavailable on +literals.

    +

    The second objection is typically cast as: “I am really telling a sequence to +join its members together with a string constant”. Sadly, you aren’t. For some +reason there seems to be much less difficulty with having split() as +a string method, since in that case it is easy to see that

    +
    "1, 2, 4, 8, 16".split(", ")
    +
    +
    +

    is an instruction to a string literal to return the substrings delimited by the +given separator (or, by default, arbitrary runs of white space).

    +

    join() is a string method because in using it you are telling the +separator string to iterate over a sequence of strings and insert itself between +adjacent elements. This method can be used with any argument which obeys the +rules for sequence objects, including any new classes you might define yourself. +Similar methods exist for bytes and bytearray objects.

    +
    +
    +

    How fast are exceptions?

    +

    A try/except block is extremely efficient if no exceptions are raised. Actually +catching an exception is expensive. In versions of Python prior to 2.0 it was +common to use this idiom:

    +
    try:
    +    value = mydict[key]
    +except KeyError:
    +    mydict[key] = getvalue(key)
    +    value = mydict[key]
    +
    +
    +

    This only made sense when you expected the dict to have the key almost all the +time. If that wasn’t the case, you coded it like this:

    +
    if key in mydict:
    +    value = mydict[key]
    +else:
    +    value = mydict[key] = getvalue(key)
    +
    +
    +

    For this specific case, you could also use value = dict.setdefault(key, +getvalue(key)), but only if the getvalue() call is cheap enough because it +is evaluated in all cases.

    +
    +
    +

    Why isn’t there a switch or case statement in Python?

    +

    You can do this easily enough with a sequence of if... elif... elif... else. +There have been some proposals for switch statement syntax, but there is no +consensus (yet) on whether and how to do range tests. See PEP 275 for +complete details and the current status.

    +

    For cases where you need to choose from a very large number of possibilities, +you can create a dictionary mapping case values to functions to call. For +example:

    +
    def function_1(...):
    +    ...
    +
    +functions = {'a': function_1,
    +             'b': function_2,
    +             'c': self.method_1, ...}
    +
    +func = functions[value]
    +func()
    +
    +
    +

    For calling methods on objects, you can simplify yet further by using the +getattr() built-in to retrieve methods with a particular name:

    +
    def visit_a(self, ...):
    +    ...
    +...
    +
    +def dispatch(self, value):
    +    method_name = 'visit_' + str(value)
    +    method = getattr(self, method_name)
    +    method()
    +
    +
    +

    It’s suggested that you use a prefix for the method names, such as visit_ in +this example. Without such a prefix, if values are coming from an untrusted +source, an attacker would be able to call any method on your object.

    +
    +
    +

    Can’t you emulate threads in the interpreter instead of relying on an OS-specific thread implementation?

    +

    Answer 1: Unfortunately, the interpreter pushes at least one C stack frame for +each Python stack frame. Also, extensions can call back into Python at almost +random moments. Therefore, a complete threads implementation requires thread +support for C.

    +

    Answer 2: Fortunately, there is Stackless Python, +which has a completely redesigned interpreter loop that avoids the C stack.

    +
    +
    +

    Why can’t lambda expressions contain statements?

    +

    Python lambda expressions cannot contain statements because Python’s syntactic +framework can’t handle statements nested inside expressions. However, in +Python, this is not a serious problem. Unlike lambda forms in other languages, +where they add functionality, Python lambdas are only a shorthand notation if +you’re too lazy to define a function.

    +

    Functions are already first class objects in Python, and can be declared in a +local scope. Therefore the only advantage of using a lambda instead of a +locally-defined function is that you don’t need to invent a name for the +function – but that’s just a local variable to which the function object (which +is exactly the same type of object that a lambda expression yields) is assigned!

    +
    +
    +

    Can Python be compiled to machine code, C or some other language?

    +

    Cython compiles a modified version of Python with +optional annotations into C extensions. Nuitka is +an up-and-coming compiler of Python into C++ code, aiming to support the full +Python language. For compiling to Java you can consider +VOC.

    +
    +
    +

    How does Python manage memory?

    +

    The details of Python memory management depend on the implementation. The +standard implementation of Python, CPython, uses reference counting to +detect inaccessible objects, and another mechanism to collect reference cycles, +periodically executing a cycle detection algorithm which looks for inaccessible +cycles and deletes the objects involved. The gc module provides functions +to perform a garbage collection, obtain debugging statistics, and tune the +collector’s parameters.

    +

    Other implementations (such as Jython or +PyPy), however, can rely on a different mechanism +such as a full-blown garbage collector. This difference can cause some +subtle porting problems if your Python code depends on the behavior of the +reference counting implementation.

    +

    In some Python implementations, the following code (which is fine in CPython) +will probably run out of file descriptors:

    +
    for file in very_long_list_of_files:
    +    f = open(file)
    +    c = f.read(1)
    +
    +
    +

    Indeed, using CPython’s reference counting and destructor scheme, each new +assignment to f closes the previous file. With a traditional GC, however, +those file objects will only get collected (and closed) at varying and possibly +long intervals.

    +

    If you want to write code that will work with any Python implementation, +you should explicitly close the file or use the with statement; +this will work regardless of memory management scheme:

    +
    for file in very_long_list_of_files:
    +    with open(file) as f:
    +        c = f.read(1)
    +
    +
    +
    +
    +

    Why doesn’t CPython use a more traditional garbage collection scheme?

    +

    For one thing, this is not a C standard feature and hence it’s not portable. +(Yes, we know about the Boehm GC library. It has bits of assembler code for +most common platforms, not for all of them, and although it is mostly +transparent, it isn’t completely transparent; patches are required to get +Python to work with it.)

    +

    Traditional GC also becomes a problem when Python is embedded into other +applications. While in a standalone Python it’s fine to replace the standard +malloc() and free() with versions provided by the GC library, an application +embedding Python may want to have its own substitute for malloc() and free(), +and may not want Python’s. Right now, CPython works with anything that +implements malloc() and free() properly.

    +
    +
    +

    Why isn’t all memory freed when CPython exits?

    +

    Objects referenced from the global namespaces of Python modules are not always +deallocated when Python exits. This may happen if there are circular +references. There are also certain bits of memory that are allocated by the C +library that are impossible to free (e.g. a tool like Purify will complain about +these). Python is, however, aggressive about cleaning up memory on exit and +does try to destroy every single object.

    +

    If you want to force Python to delete certain things on deallocation use the +atexit module to run a function that will force those deletions.

    +
    +
    +

    Why are there separate tuple and list data types?

    +

    Lists and tuples, while similar in many respects, are generally used in +fundamentally different ways. Tuples can be thought of as being similar to +Pascal records or C structs; they’re small collections of related data which may +be of different types which are operated on as a group. For example, a +Cartesian coordinate is appropriately represented as a tuple of two or three +numbers.

    +

    Lists, on the other hand, are more like arrays in other languages. They tend to +hold a varying number of objects all of which have the same type and which are +operated on one-by-one. For example, os.listdir('.') returns a list of +strings representing the files in the current directory. Functions which +operate on this output would generally not break if you added another file or +two to the directory.

    +

    Tuples are immutable, meaning that once a tuple has been created, you can’t +replace any of its elements with a new value. Lists are mutable, meaning that +you can always change a list’s elements. Only immutable elements can be used as +dictionary keys, and hence only tuples and not lists can be used as keys.

    +
    +
    +

    How are lists implemented in CPython?

    +

    CPython’s lists are really variable-length arrays, not Lisp-style linked lists. +The implementation uses a contiguous array of references to other objects, and +keeps a pointer to this array and the array’s length in a list head structure.

    +

    This makes indexing a list a[i] an operation whose cost is independent of +the size of the list or the value of the index.

    +

    When items are appended or inserted, the array of references is resized. Some +cleverness is applied to improve the performance of appending items repeatedly; +when the array must be grown, some extra space is allocated so the next few +times don’t require an actual resize.

    +
    +
    +

    How are dictionaries implemented in CPython?

    +

    CPython’s dictionaries are implemented as resizable hash tables. Compared to +B-trees, this gives better performance for lookup (the most common operation by +far) under most circumstances, and the implementation is simpler.

    +

    Dictionaries work by computing a hash code for each key stored in the dictionary +using the hash() built-in function. The hash code varies widely depending +on the key and a per-process seed; for example, “Python” could hash to +-539294296 while “python”, a string that differs by a single bit, could hash +to 1142331976. The hash code is then used to calculate a location in an +internal array where the value will be stored. Assuming that you’re storing +keys that all have different hash values, this means that dictionaries take +constant time – O(1), in Big-O notation – to retrieve a key.

    +
    +
    +

    Why must dictionary keys be immutable?

    +

    The hash table implementation of dictionaries uses a hash value calculated from +the key value to find the key. If the key were a mutable object, its value +could change, and thus its hash could also change. But since whoever changes +the key object can’t tell that it was being used as a dictionary key, it can’t +move the entry around in the dictionary. Then, when you try to look up the same +object in the dictionary it won’t be found because its hash value is different. +If you tried to look up the old value it wouldn’t be found either, because the +value of the object found in that hash bin would be different.

    +

    If you want a dictionary indexed with a list, simply convert the list to a tuple +first; the function tuple(L) creates a tuple with the same entries as the +list L. Tuples are immutable and can therefore be used as dictionary keys.

    +

    Some unacceptable solutions that have been proposed:

    +
      +
    • Hash lists by their address (object ID). This doesn’t work because if you +construct a new list with the same value it won’t be found; e.g.:

      +
      mydict = {[1, 2]: '12'}
      +print(mydict[[1, 2]])
      +
      +
      +

      would raise a KeyError exception because the id of the [1, 2] used in the +second line differs from that in the first line. In other words, dictionary +keys should be compared using ==, not using is.

      +
    • +
    • Make a copy when using a list as a key. This doesn’t work because the list, +being a mutable object, could contain a reference to itself, and then the +copying code would run into an infinite loop.

    • +
    • Allow lists as keys but tell the user not to modify them. This would allow a +class of hard-to-track bugs in programs when you forgot or modified a list by +accident. It also invalidates an important invariant of dictionaries: every +value in d.keys() is usable as a key of the dictionary.

    • +
    • Mark lists as read-only once they are used as a dictionary key. The problem +is that it’s not just the top-level object that could change its value; you +could use a tuple containing a list as a key. Entering anything as a key into +a dictionary would require marking all objects reachable from there as +read-only – and again, self-referential objects could cause an infinite loop.

    • +
    +

    There is a trick to get around this if you need to, but use it at your own risk: +You can wrap a mutable structure inside a class instance which has both a +__eq__() and a __hash__() method. You must then make sure that the +hash value for all such wrapper objects that reside in a dictionary (or other +hash based structure), remain fixed while the object is in the dictionary (or +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
    +        for i, el in enumerate(l):
    +            try:
    +                result = result + (hash(el) % 9999999) * 1001 + i
    +            except Exception:
    +                result = (result % 7777777) + i * 333
    +        return result
    +
    +
    +

    Note that the hash computation is complicated by the possibility that some +members of the list may be unhashable and also by the possibility of arithmetic +overflow.

    +

    Furthermore it must always be the case that if o1 == o2 (ie o1.__eq__(o2) +is True) then hash(o1) == hash(o2) (ie, o1.__hash__() == o2.__hash__()), +regardless of whether the object is in a dictionary or not. If you fail to meet +these restrictions dictionaries and other hash based structures will misbehave.

    +

    In the case of ListWrapper, whenever the wrapper object is in a dictionary the +wrapped list must not change to avoid anomalies. Don’t do this unless you are +prepared to think hard about the requirements and the consequences of not +meeting them correctly. Consider yourself warned.

    +
    +
    +

    Why doesn’t list.sort() return the sorted list?

    +

    In situations where performance matters, making a copy of the list just to sort +it would be wasteful. Therefore, list.sort() sorts the list in place. In +order to remind you of that fact, it does not return the sorted list. This way, +you won’t be fooled into accidentally overwriting a list when you need a sorted +copy but also need to keep the unsorted version around.

    +

    If you want to return a new list, use the built-in sorted() function +instead. This function creates a new list from a provided iterable, sorts +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]...
    +
    +
    +
    +
    +

    How do you specify and enforce an interface spec in Python?

    +

    An interface specification for a module as provided by languages such as C++ and +Java describes the prototypes for the methods and functions of the module. Many +feel that compile-time enforcement of interface specifications helps in the +construction of large programs.

    +

    Python 2.6 adds an abc module that lets you define Abstract Base Classes +(ABCs). You can then use isinstance() and issubclass() to check +whether an instance or a class implements a particular ABC. The +collections.abc module defines a set of useful ABCs such as +Iterable, Container, and +MutableMapping.

    +

    For Python, many of the advantages of interface specifications can be obtained +by an appropriate test discipline for components. There is also a tool, +PyChecker, which can be used to find problems due to subclassing.

    +

    A good test suite for a module can both provide a regression test and serve as a +module interface specification and a set of examples. Many Python modules can +be run as a script to provide a simple “self test.” Even modules which use +complex external interfaces can often be tested in isolation using trivial +“stub” emulations of the external interface. The doctest and +unittest modules or third-party test frameworks can be used to construct +exhaustive test suites that exercise every line of code in a module.

    +

    An appropriate testing discipline can help build large complex applications in +Python as well as having interface specifications would. In fact, it can be +better because an interface specification cannot test certain properties of a +program. For example, the append() method is expected to add new elements +to the end of some internal list; an interface specification cannot test that +your append() implementation will actually do this correctly, but it’s +trivial to check this property in a test suite.

    +

    Writing test suites is very helpful, and you might want to design your code with +an eye to making it easily tested. One increasingly popular technique, +test-directed development, calls for writing parts of the test suite first, +before you write any of the actual code. Of course Python allows you to be +sloppy and not write test cases at all.

    +
    +
    +

    Why is there no goto?

    +

    You can use exceptions to provide a “structured goto” that even works across +function calls. Many feel that exceptions can conveniently emulate all +reasonable uses of the “go” or “goto” constructs of C, Fortran, and other +languages. For example:

    +
    class label(Exception): pass  # declare a label
    +
    +try:
    +    ...
    +    if condition: raise label()  # goto label
    +    ...
    +except label:  # where to goto
    +    pass
    +...
    +
    +
    +

    This doesn’t allow you to jump into the middle of a loop, but that’s usually +considered an abuse of goto anyway. Use sparingly.

    +
    +
    +

    Why can’t raw strings (r-strings) end with a backslash?

    +

    More precisely, they can’t end with an odd number of backslashes: the unpaired +backslash at the end escapes the closing quote character, leaving an +unterminated string.

    +

    Raw strings were designed to ease creating input for processors (chiefly regular +expression engines) that want to do their own backslash escape processing. Such +processors consider an unmatched trailing backslash to be an error anyway, so +raw strings disallow that. In return, they allow you to pass on the string +quote character by escaping it with a backslash. These rules work well when +r-strings are used for their intended purpose.

    +

    If you’re trying to build Windows pathnames, note that all Windows system calls +accept forward slashes too:

    +
    f = open("/mydir/file.txt")  # works fine!
    +
    +
    +

    If you’re trying to build a pathname for a DOS command, try e.g. one of

    +
    dir = r"\this\is\my\dos\dir" "\\"
    +dir = r"\this\is\my\dos\dir\ "[:-1]
    +dir = "\\this\\is\\my\\dos\\dir\\"
    +
    +
    +
    +
    +

    Why doesn’t Python have a “with” statement for attribute assignments?

    +

    Python has a ‘with’ statement that wraps the execution of a block, calling code +on the entrance and exit from the block. Some language have a construct that +looks like this:

    +
    with obj:
    +    a = 1               # equivalent to obj.a = 1
    +    total = total + 1   # obj.total = obj.total + 1
    +
    +
    +

    In Python, such a construct would be ambiguous.

    +

    Other languages, such as Object Pascal, Delphi, and C++, use static types, so +it’s possible to know, in an unambiguous way, what member is being assigned +to. This is the main point of static typing – the compiler always knows the +scope of every variable at compile time.

    +

    Python uses dynamic types. It is impossible to know in advance which attribute +will be referenced at runtime. Member attributes may be added or removed from +objects on the fly. This makes it impossible to know, from a simple reading, +what attribute is being referenced: a local one, a global one, or a member +attribute?

    +

    For instance, take the following incomplete snippet:

    +
    def foo(a):
    +    with a:
    +        print(x)
    +
    +
    +

    The snippet assumes that “a” must have a member attribute called “x”. However, +there is nothing in Python that tells the interpreter this. What should happen +if “a” is, let us say, an integer? If there is a global variable named “x”, +will it be used inside the with block? As you see, the dynamic nature of Python +makes such choices much harder.

    +

    The primary benefit of “with” and similar language features (reduction of code +volume) can, however, easily be achieved in Python by assignment. Instead of:

    +
    function(args).mydict[index][index].a = 21
    +function(args).mydict[index][index].b = 42
    +function(args).mydict[index][index].c = 63
    +
    +
    +

    write this:

    +
    ref = function(args).mydict[index][index]
    +ref.a = 21
    +ref.b = 42
    +ref.c = 63
    +
    +
    +

    This also has the side-effect of increasing execution speed because name +bindings are resolved at run-time in Python, and the second version only needs +to perform the resolution once.

    +
    +
    +

    Why are colons required for the if/while/def/class statements?

    +

    The colon is required primarily to enhance readability (one of the results of +the experimental ABC language). Consider this:

    +
    if a == b
    +    print(a)
    +
    +
    +

    versus

    +
    if a == b:
    +    print(a)
    +
    +
    +

    Notice how the second one is slightly easier to read. Notice further how a +colon sets off the example in this FAQ answer; it’s a standard usage in English.

    +

    Another minor reason is that the colon makes it easier for editors with syntax +highlighting; they can look for colons to decide when indentation needs to be +increased instead of having to do a more elaborate parsing of the program text.

    +
    +
    +

    Why does Python allow commas at the end of lists and tuples?

    +

    Python lets you add a trailing comma at the end of lists, tuples, and +dictionaries:

    +
    [1, 2, 3,]
    +('a', 'b', 'c',)
    +d = {
    +    "A": [1, 5],
    +    "B": [6, 7],  # last trailing comma is optional but good style
    +}
    +
    +
    +

    There are several reasons to allow this.

    +

    When you have a literal value for a list, tuple, or dictionary spread across +multiple lines, it’s easier to add more elements because you don’t have to +remember to add a comma to the previous line. The lines can also be reordered +without creating a syntax error.

    +

    Accidentally omitting the comma can lead to errors that are hard to diagnose. +For example:

    +
    x = [
    +  "fee",
    +  "fie"
    +  "foo",
    +  "fum"
    +]
    +
    +
    +

    This list looks like it has four elements, but it actually contains three: +“fee”, “fiefoo” and “fum”. Always adding the comma avoids this source of error.

    +

    Allowing the trailing comma may also make programmatic code generation easier.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/faq/extending.html b/python-3.7.4-docs-html/faq/extending.html new file mode 100644 index 0000000..2d269ca --- /dev/null +++ b/python-3.7.4-docs-html/faq/extending.html @@ -0,0 +1,601 @@ + + + + + + + Extending/Embedding FAQ — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Extending/Embedding FAQ

    + +
    +

    Can I create my own functions in C?

    +

    Yes, you can create built-in modules containing functions, variables, exceptions +and even new types in C. This is explained in the document +Extending and Embedding the Python Interpreter.

    +

    Most intermediate or advanced Python books will also cover this topic.

    +
    +
    +

    Can I create my own functions in C++?

    +

    Yes, using the C compatibility features found in C++. Place extern "C" { +... } around the Python include files and put extern "C" before each +function that is going to be called by the Python interpreter. Global or static +C++ objects with constructors are probably not a good idea.

    +
    +
    +

    Writing C is hard; are there any alternatives?

    +

    There are a number of alternatives to writing your own C extensions, depending +on what you’re trying to do.

    +

    Cython and its relative Pyrex are compilers +that accept a slightly modified form of Python and generate the corresponding +C code. Cython and Pyrex make it possible to write an extension without having +to learn Python’s C API.

    +

    If you need to interface to some C or C++ library for which no Python extension +currently exists, you can try wrapping the library’s data types and functions +with a tool such as SWIG. SIP, CXX Boost, or Weave are also +alternatives for wrapping C++ libraries.

    +
    +
    +

    How can I execute arbitrary Python statements from C?

    +

    The highest-level function to do this is PyRun_SimpleString() which takes +a single string argument to be executed in the context of the module +__main__ and returns 0 for success and -1 when an exception occurred +(including SyntaxError). If you want more control, use +PyRun_String(); see the source for PyRun_SimpleString() in +Python/pythonrun.c.

    +
    +
    +

    How can I evaluate an arbitrary Python expression from C?

    +

    Call the function PyRun_String() from the previous question with the +start symbol Py_eval_input; it parses an expression, evaluates it and +returns its value.

    +
    +
    +

    How do I extract C values from a Python object?

    +

    That depends on the object’s type. If it’s a tuple, PyTuple_Size() +returns its length and PyTuple_GetItem() returns the item at a specified +index. Lists have similar functions, PyListSize() and +PyList_GetItem().

    +

    For bytes, PyBytes_Size() returns its length and +PyBytes_AsStringAndSize() provides a pointer to its value and its +length. Note that Python bytes objects may contain null bytes so C’s +strlen() should not be used.

    +

    To test the type of an object, first make sure it isn’t NULL, and then use +PyBytes_Check(), PyTuple_Check(), PyList_Check(), etc.

    +

    There is also a high-level API to Python objects which is provided by the +so-called ‘abstract’ interface – read Include/abstract.h for further +details. It allows interfacing with any kind of Python sequence using calls +like PySequence_Length(), PySequence_GetItem(), etc. as well +as many other useful protocols such as numbers (PyNumber_Index() et +al.) and mappings in the PyMapping APIs.

    +
    + +
    +

    How do I call an object’s method from C?

    +

    The PyObject_CallMethod() function can be used to call an arbitrary +method of an object. The parameters are the object, the name of the method to +call, a format string like that used with Py_BuildValue(), and the +argument values:

    +
    PyObject *
    +PyObject_CallMethod(PyObject *object, const char *method_name,
    +                    const char *arg_format, ...);
    +
    +
    +

    This works for any object that has methods – whether built-in or user-defined. +You are responsible for eventually Py_DECREF()’ing the return value.

    +

    To call, e.g., a file object’s “seek” method with arguments 10, 0 (assuming the +file object pointer is “f”):

    +
    res = PyObject_CallMethod(f, "seek", "(ii)", 10, 0);
    +if (res == NULL) {
    +        ... an exception occurred ...
    +}
    +else {
    +        Py_DECREF(res);
    +}
    +
    +
    +

    Note that since PyObject_CallObject() always wants a tuple for the +argument list, to call a function without arguments, pass “()” for the format, +and to call a function with one argument, surround the argument in parentheses, +e.g. “(i)”.

    +
    +
    +

    How do I catch the output from PyErr_Print() (or anything that prints to stdout/stderr)?

    +

    In Python code, define an object that supports the write() method. Assign +this object to sys.stdout and sys.stderr. Call print_error, or +just allow the standard traceback mechanism to work. Then, the output will go +wherever your write() method sends it.

    +

    The easiest way to do this is to use the io.StringIO class:

    +
    >>> import io, sys
    +>>> sys.stdout = io.StringIO()
    +>>> print('foo')
    +>>> print('hello world!')
    +>>> sys.stderr.write(sys.stdout.getvalue())
    +foo
    +hello world!
    +
    +
    +

    A custom object to do the same would look like this:

    +
    >>> import io, sys
    +>>> class StdoutCatcher(io.TextIOBase):
    +...     def __init__(self):
    +...         self.data = []
    +...     def write(self, stuff):
    +...         self.data.append(stuff)
    +...
    +>>> import sys
    +>>> sys.stdout = StdoutCatcher()
    +>>> print('foo')
    +>>> print('hello world!')
    +>>> sys.stderr.write(''.join(sys.stdout.data))
    +foo
    +hello world!
    +
    +
    +
    +
    +

    How do I access a module written in Python from C?

    +

    You can get a pointer to the module object as follows:

    +
    module = PyImport_ImportModule("<modulename>");
    +
    +
    +

    If the module hasn’t been imported yet (i.e. it is not yet present in +sys.modules), this initializes the module; otherwise it simply returns +the value of sys.modules["<modulename>"]. Note that it doesn’t enter the +module into any namespace – it only ensures it has been initialized and is +stored in sys.modules.

    +

    You can then access the module’s attributes (i.e. any name defined in the +module) as follows:

    +
    attr = PyObject_GetAttrString(module, "<attrname>");
    +
    +
    +

    Calling PyObject_SetAttrString() to assign to variables in the module +also works.

    +
    +
    +

    How do I interface to C++ objects from Python?

    +

    Depending on your requirements, there are many approaches. To do this manually, +begin by reading the “Extending and Embedding” document. Realize that for the Python run-time system, there isn’t a +whole lot of difference between C and C++ – so the strategy of building a new +Python type around a C structure (pointer) type will also work for C++ objects.

    +

    For C++ libraries, see Writing C is hard; are there any alternatives?.

    +
    +
    +

    I added a module using the Setup file and the make fails; why?

    +

    Setup must end in a newline, if there is no newline there, the build process +fails. (Fixing this requires some ugly shell script hackery, and this bug is so +minor that it doesn’t seem worth the effort.)

    +
    +
    +

    How do I debug an extension?

    +

    When using GDB with dynamically loaded extensions, you can’t set a breakpoint in +your extension until your extension is loaded.

    +

    In your .gdbinit file (or interactively), add the command:

    +
    br _PyImport_LoadDynamicModule
    +
    +
    +

    Then, when you run GDB:

    +
    $ gdb /local/bin/python
    +gdb) run myscript.py
    +gdb) continue # repeat until your extension is loaded
    +gdb) finish   # so that your extension is loaded
    +gdb) br myfunction.c:50
    +gdb) continue
    +
    +
    +
    +
    +

    I want to compile a Python module on my Linux system, but some files are missing. Why?

    +

    Most packaged versions of Python don’t include the +/usr/lib/python2.x/config/ directory, which contains various files +required for compiling Python extensions.

    +

    For Red Hat, install the python-devel RPM to get the necessary files.

    +

    For Debian, run apt-get install python-dev.

    +
    +
    +

    How do I tell “incomplete input” from “invalid input”?

    +

    Sometimes you want to emulate the Python interactive interpreter’s behavior, +where it gives you a continuation prompt when the input is incomplete (e.g. you +typed the start of an “if” statement or you didn’t close your parentheses or +triple string quotes), but it gives you a syntax error message immediately when +the input is invalid.

    +

    In Python you can use the codeop module, which approximates the parser’s +behavior sufficiently. IDLE uses this, for example.

    +

    The easiest way to do it in C is to call PyRun_InteractiveLoop() (perhaps +in a separate thread) and let the Python interpreter handle the input for +you. You can also set the PyOS_ReadlineFunctionPointer() to point at your +custom input function. See Modules/readline.c and Parser/myreadline.c +for more hints.

    +

    However sometimes you have to run the embedded Python interpreter in the same +thread as your rest application and you can’t allow the +PyRun_InteractiveLoop() to stop while waiting for user input. The one +solution then is to call PyParser_ParseString() and test for e.error +equal to E_EOF, which means the input is incomplete. Here’s a sample code +fragment, untested, inspired by code from Alex Farber:

    +
    #define PY_SSIZE_T_CLEAN
    +#include <Python.h>
    +#include <node.h>
    +#include <errcode.h>
    +#include <grammar.h>
    +#include <parsetok.h>
    +#include <compile.h>
    +
    +int testcomplete(char *code)
    +  /* code should end in \n */
    +  /* return -1 for error, 0 for incomplete, 1 for complete */
    +{
    +  node *n;
    +  perrdetail e;
    +
    +  n = PyParser_ParseString(code, &_PyParser_Grammar,
    +                           Py_file_input, &e);
    +  if (n == NULL) {
    +    if (e.error == E_EOF)
    +      return 0;
    +    return -1;
    +  }
    +
    +  PyNode_Free(n);
    +  return 1;
    +}
    +
    +
    +

    Another solution is trying to compile the received string with +Py_CompileString(). If it compiles without errors, try to execute the +returned code object by calling PyEval_EvalCode(). Otherwise save the +input for later. If the compilation fails, find out if it’s an error or just +more input is required - by extracting the message string from the exception +tuple and comparing it to the string “unexpected EOF while parsing”. Here is a +complete example using the GNU readline library (you may want to ignore +SIGINT while calling readline()):

    +
    #include <stdio.h>
    +#include <readline.h>
    +
    +#define PY_SSIZE_T_CLEAN
    +#include <Python.h>
    +#include <object.h>
    +#include <compile.h>
    +#include <eval.h>
    +
    +int main (int argc, char* argv[])
    +{
    +  int i, j, done = 0;                          /* lengths of line, code */
    +  char ps1[] = ">>> ";
    +  char ps2[] = "... ";
    +  char *prompt = ps1;
    +  char *msg, *line, *code = NULL;
    +  PyObject *src, *glb, *loc;
    +  PyObject *exc, *val, *trb, *obj, *dum;
    +
    +  Py_Initialize ();
    +  loc = PyDict_New ();
    +  glb = PyDict_New ();
    +  PyDict_SetItemString (glb, "__builtins__", PyEval_GetBuiltins ());
    +
    +  while (!done)
    +  {
    +    line = readline (prompt);
    +
    +    if (NULL == line)                          /* Ctrl-D pressed */
    +    {
    +      done = 1;
    +    }
    +    else
    +    {
    +      i = strlen (line);
    +
    +      if (i > 0)
    +        add_history (line);                    /* save non-empty lines */
    +
    +      if (NULL == code)                        /* nothing in code yet */
    +        j = 0;
    +      else
    +        j = strlen (code);
    +
    +      code = realloc (code, i + j + 2);
    +      if (NULL == code)                        /* out of memory */
    +        exit (1);
    +
    +      if (0 == j)                              /* code was empty, so */
    +        code[0] = '\0';                        /* keep strncat happy */
    +
    +      strncat (code, line, i);                 /* append line to code */
    +      code[i + j] = '\n';                      /* append '\n' to code */
    +      code[i + j + 1] = '\0';
    +
    +      src = Py_CompileString (code, "<stdin>", Py_single_input);
    +
    +      if (NULL != src)                         /* compiled just fine - */
    +      {
    +        if (ps1  == prompt ||                  /* ">>> " or */
    +            '\n' == code[i + j - 1])           /* "... " and double '\n' */
    +        {                                               /* so execute it */
    +          dum = PyEval_EvalCode (src, glb, loc);
    +          Py_XDECREF (dum);
    +          Py_XDECREF (src);
    +          free (code);
    +          code = NULL;
    +          if (PyErr_Occurred ())
    +            PyErr_Print ();
    +          prompt = ps1;
    +        }
    +      }                                        /* syntax error or E_EOF? */
    +      else if (PyErr_ExceptionMatches (PyExc_SyntaxError))
    +      {
    +        PyErr_Fetch (&exc, &val, &trb);        /* clears exception! */
    +
    +        if (PyArg_ParseTuple (val, "sO", &msg, &obj) &&
    +            !strcmp (msg, "unexpected EOF while parsing")) /* E_EOF */
    +        {
    +          Py_XDECREF (exc);
    +          Py_XDECREF (val);
    +          Py_XDECREF (trb);
    +          prompt = ps2;
    +        }
    +        else                                   /* some other syntax error */
    +        {
    +          PyErr_Restore (exc, val, trb);
    +          PyErr_Print ();
    +          free (code);
    +          code = NULL;
    +          prompt = ps1;
    +        }
    +      }
    +      else                                     /* some non-syntax error */
    +      {
    +        PyErr_Print ();
    +        free (code);
    +        code = NULL;
    +        prompt = ps1;
    +      }
    +
    +      free (line);
    +    }
    +  }
    +
    +  Py_XDECREF(glb);
    +  Py_XDECREF(loc);
    +  Py_Finalize();
    +  exit(0);
    +}
    +
    +
    +
    +
    +

    How do I find undefined g++ symbols __builtin_new or __pure_virtual?

    +

    To dynamically load g++ extension modules, you must recompile Python, relink it +using g++ (change LINKCC in the Python Modules Makefile), and link your +extension module using g++ (e.g., g++ -shared -o mymodule.so mymodule.o).

    +
    +
    +

    Can I create an object class with some methods implemented in C and others in Python (e.g. through inheritance)?

    +

    Yes, you can inherit from built-in classes such as int, list, +dict, etc.

    +

    The Boost Python Library (BPL, http://www.boost.org/libs/python/doc/index.html) +provides a way of doing this from C++ (i.e. you can inherit from an extension +class written in C++ using the BPL).

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/faq/general.html b/python-3.7.4-docs-html/faq/general.html new file mode 100644 index 0000000..6f5cb48 --- /dev/null +++ b/python-3.7.4-docs-html/faq/general.html @@ -0,0 +1,572 @@ + + + + + + + General Python FAQ — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    General Python FAQ

    + +
    +

    General Information

    +
    +

    What is Python?

    +

    Python is an interpreted, interactive, object-oriented programming language. It +incorporates modules, exceptions, dynamic typing, very high level dynamic data +types, and classes. Python combines remarkable power with very clear syntax. +It has interfaces to many system calls and libraries, as well as to various +window systems, and is extensible in C or C++. It is also usable as an +extension language for applications that need a programmable interface. +Finally, Python is portable: it runs on many Unix variants, on the Mac, and on +Windows 2000 and later.

    +

    To find out more, start with The Python Tutorial. The Beginner’s Guide to +Python links to other +introductory tutorials and resources for learning Python.

    +
    +
    +

    What is the Python Software Foundation?

    +

    The Python Software Foundation is an independent non-profit organization that +holds the copyright on Python versions 2.1 and newer. The PSF’s mission is to +advance open source technology related to the Python programming language and to +publicize the use of Python. The PSF’s home page is at +https://www.python.org/psf/.

    +

    Donations to the PSF are tax-exempt in the US. If you use Python and find it +helpful, please contribute via the PSF donation page.

    +
    + +
    +

    Why was Python created in the first place?

    +

    Here’s a very brief summary of what started it all, written by Guido van +Rossum:

    +
    +

    I had extensive experience with implementing an interpreted language in the +ABC group at CWI, and from working with this group I had learned a lot about +language design. This is the origin of many Python features, including the +use of indentation for statement grouping and the inclusion of +very-high-level data types (although the details are all different in +Python).

    +

    I had a number of gripes about the ABC language, but also liked many of its +features. It was impossible to extend the ABC language (or its +implementation) to remedy my complaints – in fact its lack of extensibility +was one of its biggest problems. I had some experience with using Modula-2+ +and talked with the designers of Modula-3 and read the Modula-3 report. +Modula-3 is the origin of the syntax and semantics used for exceptions, and +some other Python features.

    +

    I was working in the Amoeba distributed operating system group at CWI. We +needed a better way to do system administration than by writing either C +programs or Bourne shell scripts, since Amoeba had its own system call +interface which wasn’t easily accessible from the Bourne shell. My +experience with error handling in Amoeba made me acutely aware of the +importance of exceptions as a programming language feature.

    +

    It occurred to me that a scripting language with a syntax like ABC but with +access to the Amoeba system calls would fill the need. I realized that it +would be foolish to write an Amoeba-specific language, so I decided that I +needed a language that was generally extensible.

    +

    During the 1989 Christmas holidays, I had a lot of time on my hand, so I +decided to give it a try. During the next year, while still mostly working +on it in my own time, Python was used in the Amoeba project with increasing +success, and the feedback from colleagues made me add many early +improvements.

    +

    In February 1991, after just over a year of development, I decided to post to +USENET. The rest is in the Misc/HISTORY file.

    +
    +
    +
    +

    What is Python good for?

    +

    Python is a high-level general-purpose programming language that can be applied +to many different classes of problems.

    +

    The language comes with a large standard library that covers areas such as +string processing (regular expressions, Unicode, calculating differences between +files), Internet protocols (HTTP, FTP, SMTP, XML-RPC, POP, IMAP, CGI +programming), software engineering (unit testing, logging, profiling, parsing +Python code), and operating system interfaces (system calls, filesystems, TCP/IP +sockets). Look at the table of contents for The Python Standard Library to get an idea +of what’s available. A wide variety of third-party extensions are also +available. Consult the Python Package Index to +find packages of interest to you.

    +
    +
    +

    How does the Python version numbering scheme work?

    +

    Python versions are numbered A.B.C or A.B. A is the major version number – it +is only incremented for really major changes in the language. B is the minor +version number, incremented for less earth-shattering changes. C is the +micro-level – it is incremented for each bugfix release. See PEP 6 for more +information about bugfix releases.

    +

    Not all releases are bugfix releases. In the run-up to a new major release, a +series of development releases are made, denoted as alpha, beta, or release +candidate. Alphas are early releases in which interfaces aren’t yet finalized; +it’s not unexpected to see an interface change between two alpha releases. +Betas are more stable, preserving existing interfaces but possibly adding new +modules, and release candidates are frozen, making no changes except as needed +to fix critical bugs.

    +

    Alpha, beta and release candidate versions have an additional suffix. The +suffix for an alpha version is “aN” for some small number N, the suffix for a +beta version is “bN” for some small number N, and the suffix for a release +candidate version is “cN” for some small number N. In other words, all versions +labeled 2.0aN precede the versions labeled 2.0bN, which precede versions labeled +2.0cN, and those precede 2.0.

    +

    You may also find version numbers with a “+” suffix, e.g. “2.2+”. These are +unreleased versions, built directly from the CPython development repository. In +practice, after a final minor release is made, the version is incremented to the +next minor version, which becomes the “a0” version, e.g. “2.4a0”.

    +

    See also the documentation for sys.version, sys.hexversion, and +sys.version_info.

    +
    +
    +

    How do I obtain a copy of the Python source?

    +

    The latest Python source distribution is always available from python.org, at +https://www.python.org/downloads/. The latest development sources can be obtained +at https://github.com/python/cpython/.

    +

    The source distribution is a gzipped tar file containing the complete C source, +Sphinx-formatted documentation, Python library modules, example programs, and +several useful pieces of freely distributable software. The source will compile +and run out of the box on most UNIX platforms.

    +

    Consult the Getting Started section of the Python Developer’s Guide for more +information on getting the source code and compiling it.

    +
    +
    +

    How do I get documentation on Python?

    +

    The standard documentation for the current stable version of Python is available +at https://docs.python.org/3/. PDF, plain text, and downloadable HTML versions are +also available at https://docs.python.org/3/download.html.

    +

    The documentation is written in reStructuredText and processed by the Sphinx +documentation tool. The reStructuredText source for +the documentation is part of the Python source distribution.

    +
    +
    +

    I’ve never programmed before. Is there a Python tutorial?

    +

    There are numerous tutorials and books available. The standard documentation +includes The Python Tutorial.

    +

    Consult the Beginner’s Guide to +find information for beginning Python programmers, including lists of tutorials.

    +
    +
    +

    Is there a newsgroup or mailing list devoted to Python?

    +

    There is a newsgroup, comp.lang.python, and a mailing list, +python-list. The +newsgroup and mailing list are gatewayed into each other – if you can read news +it’s unnecessary to subscribe to the mailing list. +comp.lang.python is high-traffic, receiving hundreds of postings +every day, and Usenet readers are often more able to cope with this volume.

    +

    Announcements of new software releases and events can be found in +comp.lang.python.announce, a low-traffic moderated list that receives about five +postings per day. It’s available as the python-announce mailing list.

    +

    More info about other mailing lists and newsgroups +can be found at https://www.python.org/community/lists/.

    +
    +
    +

    How do I get a beta test version of Python?

    +

    Alpha and beta releases are available from https://www.python.org/downloads/. All +releases are announced on the comp.lang.python and comp.lang.python.announce +newsgroups and on the Python home page at https://www.python.org/; an RSS feed of +news is available.

    +

    You can also access the development version of Python through Git. See +The Python Developer’s Guide for details.

    +
    +
    +

    How do I submit bug reports and patches for Python?

    +

    To report a bug or submit a patch, please use the Roundup installation at +https://bugs.python.org/.

    +

    You must have a Roundup account to report bugs; this makes it possible for us to +contact you if we have follow-up questions. It will also enable Roundup to send +you updates as we act on your bug. If you had previously used SourceForge to +report bugs to Python, you can obtain your Roundup password through Roundup’s +password reset procedure.

    +

    For more information on how Python is developed, consult the Python Developer’s +Guide.

    +
    +
    +

    Are there any published articles about Python that I can reference?

    +

    It’s probably best to cite your favorite book about Python.

    +

    The very first article about Python was written in 1991 and is now quite +outdated.

    +
    +

    Guido van Rossum and Jelke de Boer, “Interactively Testing Remote Servers +Using the Python Programming Language”, CWI Quarterly, Volume 4, Issue 4 +(December 1991), Amsterdam, pp 283–303.

    +
    +
    +
    +

    Are there any books on Python?

    +

    Yes, there are many, and more are being published. See the python.org wiki at +https://wiki.python.org/moin/PythonBooks for a list.

    +

    You can also search online bookstores for “Python” and filter out the Monty +Python references; or perhaps search for “Python” and “language”.

    +
    +
    +

    Where in the world is www.python.org located?

    +

    The Python project’s infrastructure is located all over the world and is managed +by the Python Infrastructure Team. Details here.

    +
    +
    +

    Why is it called Python?

    +

    When he began implementing Python, Guido van Rossum was also reading the +published scripts from “Monty Python’s Flying Circus”, a BBC comedy series from the 1970s. Van Rossum +thought he needed a name that was short, unique, and slightly mysterious, so he +decided to call the language Python.

    +
    + +
    +
    +

    Python in the real world

    +
    +

    How stable is Python?

    +

    Very stable. New, stable releases have been coming out roughly every 6 to 18 +months since 1991, and this seems likely to continue. Currently there are +usually around 18 months between major releases.

    +

    The developers issue “bugfix” releases of older versions, so the stability of +existing releases gradually improves. Bugfix releases, indicated by a third +component of the version number (e.g. 3.5.3, 3.6.2), are managed for stability; +only fixes for known problems are included in a bugfix release, and it’s +guaranteed that interfaces will remain the same throughout a series of bugfix +releases.

    +

    The latest stable releases can always be found on the Python download page. There are two production-ready versions +of Python: 2.x and 3.x. The recommended version is 3.x, which is supported by +most widely used libraries. Although 2.x is still widely used, it will not +be maintained after January 1, 2020.

    +
    +
    +

    How many people are using Python?

    +

    There are probably tens of thousands of users, though it’s difficult to obtain +an exact count.

    +

    Python is available for free download, so there are no sales figures, and it’s +available from many different sites and packaged with many Linux distributions, +so download statistics don’t tell the whole story either.

    +

    The comp.lang.python newsgroup is very active, but not all Python users post to +the group or even read it.

    +
    +
    +

    Have any significant projects been done in Python?

    +

    See https://www.python.org/about/success for a list of projects that use Python. +Consulting the proceedings for past Python conferences will reveal contributions from many +different companies and organizations.

    +

    High-profile Python projects include the Mailman mailing list manager and the Zope application server. Several Linux distributions, most notably Red Hat, have written part or all of their installer and +system administration software in Python. Companies that use Python internally +include Google, Yahoo, and Lucasfilm Ltd.

    +
    +
    +

    What new developments are expected for Python in the future?

    +

    See https://www.python.org/dev/peps/ for the Python Enhancement Proposals +(PEPs). PEPs are design documents describing a suggested new feature for Python, +providing a concise technical specification and a rationale. Look for a PEP +titled “Python X.Y Release Schedule”, where X.Y is a version that hasn’t been +publicly released yet.

    +

    New development is discussed on the python-dev mailing list.

    +
    +
    +

    Is it reasonable to propose incompatible changes to Python?

    +

    In general, no. There are already millions of lines of Python code around the +world, so any change in the language that invalidates more than a very small +fraction of existing programs has to be frowned upon. Even if you can provide a +conversion program, there’s still the problem of updating all documentation; +many books have been written about Python, and we don’t want to invalidate them +all at a single stroke.

    +

    Providing a gradual upgrade path is necessary if a feature has to be changed. +PEP 5 describes the procedure followed for introducing backward-incompatible +changes while minimizing disruption for users.

    +
    +
    +

    Is Python a good language for beginning programmers?

    +

    Yes.

    +

    It is still common to start students with a procedural and statically typed +language such as Pascal, C, or a subset of C++ or Java. Students may be better +served by learning Python as their first language. Python has a very simple and +consistent syntax and a large standard library and, most importantly, using +Python in a beginning programming course lets students concentrate on important +programming skills such as problem decomposition and data type design. With +Python, students can be quickly introduced to basic concepts such as loops and +procedures. They can probably even work with user-defined objects in their very +first course.

    +

    For a student who has never programmed before, using a statically typed language +seems unnatural. It presents additional complexity that the student must master +and slows the pace of the course. The students are trying to learn to think +like a computer, decompose problems, design consistent interfaces, and +encapsulate data. While learning to use a statically typed language is +important in the long term, it is not necessarily the best topic to address in +the students’ first programming course.

    +

    Many other aspects of Python make it a good first language. Like Java, Python +has a large standard library so that students can be assigned programming +projects very early in the course that do something. Assignments aren’t +restricted to the standard four-function calculator and check balancing +programs. By using the standard library, students can gain the satisfaction of +working on realistic applications as they learn the fundamentals of programming. +Using the standard library also teaches students about code reuse. Third-party +modules such as PyGame are also helpful in extending the students’ reach.

    +

    Python’s interactive interpreter enables students to test language features +while they’re programming. They can keep a window with the interpreter running +while they enter their program’s source in another window. If they can’t +remember the methods for a list, they can do something like this:

    +
    >>> L = []
    +>>> dir(L) 
    +['__add__', '__class__', '__contains__', '__delattr__', '__delitem__',
    +'__dir__', '__doc__', '__eq__', '__format__', '__ge__',
    +'__getattribute__', '__getitem__', '__gt__', '__hash__', '__iadd__',
    +'__imul__', '__init__', '__iter__', '__le__', '__len__', '__lt__',
    +'__mul__', '__ne__', '__new__', '__reduce__', '__reduce_ex__',
    +'__repr__', '__reversed__', '__rmul__', '__setattr__', '__setitem__',
    +'__sizeof__', '__str__', '__subclasshook__', 'append', 'clear',
    +'copy', 'count', 'extend', 'index', 'insert', 'pop', 'remove',
    +'reverse', 'sort']
    +>>> [d for d in dir(L) if '__' not in d]
    +['append', 'clear', 'copy', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort']
    +
    +>>> help(L.append)
    +Help on built-in function append:
    +
    +append(...)
    +    L.append(object) -> None -- append object to end
    +
    +>>> L.append(1)
    +>>> L
    +[1]
    +
    +
    +

    With the interpreter, documentation is never far from the student as they are +programming.

    +

    There are also good IDEs for Python. IDLE is a cross-platform IDE for Python +that is written in Python using Tkinter. PythonWin is a Windows-specific IDE. +Emacs users will be happy to know that there is a very good Python mode for +Emacs. All of these programming environments provide syntax highlighting, +auto-indenting, and access to the interactive interpreter while coding. Consult +the Python wiki for a full list +of Python editing environments.

    +

    If you want to discuss Python’s use in education, you may be interested in +joining the edu-sig mailing list.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/faq/gui.html b/python-3.7.4-docs-html/faq/gui.html new file mode 100644 index 0000000..b401bc0 --- /dev/null +++ b/python-3.7.4-docs-html/faq/gui.html @@ -0,0 +1,336 @@ + + + + + + + Graphic User Interface FAQ — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Graphic User Interface FAQ

    + + +
    +

    What platform-independent GUI toolkits exist for Python?

    +

    Depending on what platform(s) you are aiming at, there are several. Some +of them haven’t been ported to Python 3 yet. At least Tkinter and Qt +are known to be Python 3-compatible.

    +
    +

    Tkinter

    +

    Standard builds of Python include an object-oriented interface to the Tcl/Tk +widget set, called tkinter. This is probably the easiest to +install (since it comes included with most +binary distributions of Python) and use. +For more info about Tk, including pointers to the source, see the +Tcl/Tk home page. Tcl/Tk is fully portable to the +Mac OS X, Windows, and Unix platforms.

    +
    +
    +

    wxWidgets

    +

    wxWidgets (https://www.wxwidgets.org) is a free, portable GUI class +library written in C++ that provides a native look and feel on a +number of platforms, with Windows, Mac OS X, GTK, X11, all listed as +current stable targets. Language bindings are available for a number +of languages including Python, Perl, Ruby, etc.

    +

    wxPython is the Python binding for +wxwidgets. While it often lags slightly behind the official wxWidgets +releases, it also offers a number of features via pure Python +extensions that are not available in other language bindings. There +is an active wxPython user and developer community.

    +

    Both wxWidgets and wxPython are free, open source, software with +permissive licences that allow their use in commercial products as +well as in freeware or shareware.

    +
    +
    +

    Qt

    +

    There are bindings available for the Qt toolkit (using either PyQt or PySide) and for KDE (PyKDE4). +PyQt is currently more mature than PySide, but you must buy a PyQt license from +Riverbank Computing +if you want to write proprietary applications. PySide is free for all applications.

    +

    Qt 4.5 upwards is licensed under the LGPL license; also, commercial licenses +are available from The Qt Company.

    +
    +
    +

    Gtk+

    +

    The GObject introspection bindings +for Python allow you to write GTK+ 3 applications. There is also a +Python GTK+ 3 Tutorial.

    +

    The older PyGtk bindings for the Gtk+ 2 toolkit have +been implemented by James Henstridge; see <http://www.pygtk.org>.

    +
    +
    +

    Kivy

    +

    Kivy is a cross-platform GUI library supporting both +desktop operating systems (Windows, macOS, Linux) and mobile devices (Android, +iOS). It is written in Python and Cython, and can use a range of windowing +backends.

    +

    Kivy is free and open source software distributed under the MIT license.

    +
    +
    +

    FLTK

    +

    Python bindings for the FLTK toolkit, a simple yet +powerful and mature cross-platform windowing system, are available from the +PyFLTK project.

    +
    +
    +

    OpenGL

    +

    For OpenGL bindings, see PyOpenGL.

    +
    +
    +
    +

    What platform-specific GUI toolkits exist for Python?

    +

    By installing the PyObjc Objective-C bridge, Python programs can use Mac OS X’s +Cocoa libraries.

    +

    Pythonwin by Mark Hammond includes an interface to the +Microsoft Foundation Classes and a Python programming environment +that’s written mostly in Python using the MFC classes.

    +
    +
    +

    Tkinter questions

    +
    +

    How do I freeze Tkinter applications?

    +

    Freeze is a tool to create stand-alone applications. When freezing Tkinter +applications, the applications will not be truly stand-alone, as the application +will still need the Tcl and Tk libraries.

    +

    One solution is to ship the application with the Tcl and Tk libraries, and point +to them at run-time using the TCL_LIBRARY and TK_LIBRARY +environment variables.

    +

    To get truly stand-alone applications, the Tcl scripts that form the library +have to be integrated into the application as well. One tool supporting that is +SAM (stand-alone modules), which is part of the Tix distribution +(http://tix.sourceforge.net/).

    +

    Build Tix with SAM enabled, perform the appropriate call to +Tclsam_init(), etc. inside Python’s +Modules/tkappinit.c, and link with libtclsam and libtksam (you +might include the Tix libraries as well).

    +
    +
    +

    Can I have Tk events handled while waiting for I/O?

    +

    On platforms other than Windows, yes, and you don’t even +need threads! But you’ll have to restructure your I/O +code a bit. Tk has the equivalent of Xt’s XtAddInput() call, which allows you +to register a callback function which will be called from the Tk mainloop when +I/O is possible on a file descriptor. See File Handlers.

    +
    +
    +

    I can’t get key bindings to work in Tkinter: why?

    +

    An often-heard complaint is that event handlers bound to events with the +bind() method don’t get handled even when the appropriate key is pressed.

    +

    The most common cause is that the widget to which the binding applies doesn’t +have “keyboard focus”. Check out the Tk documentation for the focus command. +Usually a widget is given the keyboard focus by clicking in it (but not for +labels; see the takefocus option).

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/faq/index.html b/python-3.7.4-docs-html/faq/index.html new file mode 100644 index 0000000..930bac0 --- /dev/null +++ b/python-3.7.4-docs-html/faq/index.html @@ -0,0 +1,191 @@ + + + + + + + Python Frequently Asked Questions — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/faq/installed.html b/python-3.7.4-docs-html/faq/installed.html new file mode 100644 index 0000000..e156fdd --- /dev/null +++ b/python-3.7.4-docs-html/faq/installed.html @@ -0,0 +1,232 @@ + + + + + + + “Why is Python Installed on my Computer?” FAQ — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    “Why is Python Installed on my Computer?” FAQ

    +
    +

    What is Python?

    +

    Python is a programming language. It’s used for many different applications. +It’s used in some high schools and colleges as an introductory programming +language because Python is easy to learn, but it’s also used by professional +software developers at places such as Google, NASA, and Lucasfilm Ltd.

    +

    If you wish to learn more about Python, start with the Beginner’s Guide to +Python.

    +
    +
    +

    Why is Python installed on my machine?

    +

    If you find Python installed on your system but don’t remember installing it, +there are several possible ways it could have gotten there.

    +
      +
    • Perhaps another user on the computer wanted to learn programming and installed +it; you’ll have to figure out who’s been using the machine and might have +installed it.

    • +
    • A third-party application installed on the machine might have been written in +Python and included a Python installation. There are many such applications, +from GUI programs to network servers and administrative scripts.

    • +
    • Some Windows machines also have Python installed. At this writing we’re aware +of computers from Hewlett-Packard and Compaq that include Python. Apparently +some of HP/Compaq’s administrative tools are written in Python.

    • +
    • Many Unix-compatible operating systems, such as Mac OS X and some Linux +distributions, have Python installed by default; it’s included in the base +installation.

    • +
    +
    +
    +

    Can I delete Python?

    +

    That depends on where Python came from.

    +

    If someone installed it deliberately, you can remove it without hurting +anything. On Windows, use the Add/Remove Programs icon in the Control Panel.

    +

    If Python was installed by a third-party application, you can also remove it, +but that application will no longer work. You should use that application’s +uninstaller rather than removing Python directly.

    +

    If Python came with your operating system, removing it is not recommended. If +you remove it, whatever tools were written in Python will no longer run, and +some of them might be important to you. Reinstalling the whole system would +then be required to fix things again.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/faq/library.html b/python-3.7.4-docs-html/faq/library.html new file mode 100644 index 0000000..3ea5227 --- /dev/null +++ b/python-3.7.4-docs-html/faq/library.html @@ -0,0 +1,865 @@ + + + + + + + Library and Extension FAQ — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Library and Extension FAQ

    +
    +

    Contents

    + +
    +
    +

    General Library Questions

    +
    +

    How do I find a module or application to perform task X?

    +

    Check the Library Reference to see if there’s a relevant +standard library module. (Eventually you’ll learn what’s in the standard +library and will be able to skip this step.)

    +

    For third-party packages, search the Python Package Index or try Google or +another Web search engine. Searching for “Python” plus a keyword or two for +your topic of interest will usually find something helpful.

    +
    +
    +

    Where is the math.py (socket.py, regex.py, etc.) source file?

    +

    If you can’t find a source file for a module it may be a built-in or +dynamically loaded module implemented in C, C++ or other compiled language. +In this case you may not have the source file or it may be something like +mathmodule.c, somewhere in a C source directory (not on the Python Path).

    +

    There are (at least) three kinds of modules in Python:

    +
      +
    1. modules written in Python (.py);

    2. +
    3. modules written in C and dynamically loaded (.dll, .pyd, .so, .sl, etc);

    4. +
    5. modules written in C and linked with the interpreter; to get a list of these, +type:

      +
      import sys
      +print(sys.builtin_module_names)
      +
      +
      +
    6. +
    +
    +
    +

    How do I make a Python script executable on Unix?

    +

    You need to do two things: the script file’s mode must be executable and the +first line must begin with #! followed by the path of the Python +interpreter.

    +

    The first is done by executing chmod +x scriptfile or perhaps chmod 755 +scriptfile.

    +

    The second can be done in a number of ways. The most straightforward way is to +write

    +
    #!/usr/local/bin/python
    +
    +
    +

    as the very first line of your file, using the pathname for where the Python +interpreter is installed on your platform.

    +

    If you would like the script to be independent of where the Python interpreter +lives, you can use the env program. Almost all Unix variants support +the following, assuming the Python interpreter is in a directory on the user’s +PATH:

    +
    #!/usr/bin/env python
    +
    +
    +

    Don’t do this for CGI scripts. The PATH variable for CGI scripts is +often very minimal, so you need to use the actual absolute pathname of the +interpreter.

    +

    Occasionally, a user’s environment is so full that the /usr/bin/env +program fails; or there’s no env program at all. In that case, you can try the +following hack (due to Alex Rezinsky):

    +
    #! /bin/sh
    +""":"
    +exec python $0 ${1+"$@"}
    +"""
    +
    +
    +

    The minor disadvantage is that this defines the script’s __doc__ string. +However, you can fix that by adding

    +
    __doc__ = """...Whatever..."""
    +
    +
    +
    +
    +

    Is there a curses/termcap package for Python?

    +

    For Unix variants: The standard Python source distribution comes with a curses +module in the Modules subdirectory, though it’s not compiled by default. +(Note that this is not available in the Windows distribution – there is no +curses module for Windows.)

    +

    The curses module supports basic curses features as well as many additional +functions from ncurses and SYSV curses such as colour, alternative character set +support, pads, and mouse support. This means the module isn’t compatible with +operating systems that only have BSD curses, but there don’t seem to be any +currently maintained OSes that fall into this category.

    +

    For Windows: use the consolelib module.

    +
    +
    +

    Is there an equivalent to C’s onexit() in Python?

    +

    The atexit module provides a register function that is similar to C’s +onexit().

    +
    +
    +

    Why don’t my signal handlers work?

    +

    The most common problem is that the signal handler is declared with the wrong +argument list. It is called as

    +
    handler(signum, frame)
    +
    +
    +

    so it should be declared with two arguments:

    +
    def handler(signum, frame):
    +    ...
    +
    +
    +
    +
    +
    +

    Common tasks

    +
    +

    How do I test a Python program or component?

    +

    Python comes with two testing frameworks. The doctest module finds +examples in the docstrings for a module and runs them, comparing the output with +the expected output given in the docstring.

    +

    The unittest module is a fancier testing framework modelled on Java and +Smalltalk testing frameworks.

    +

    To make testing easier, you should use good modular design in your program. +Your program should have almost all functionality +encapsulated in either functions or class methods – and this sometimes has the +surprising and delightful effect of making the program run faster (because local +variable accesses are faster than global accesses). Furthermore the program +should avoid depending on mutating global variables, since this makes testing +much more difficult to do.

    +

    The “global main logic” of your program may be as simple as

    +
    if __name__ == "__main__":
    +    main_logic()
    +
    +
    +

    at the bottom of the main module of your program.

    +

    Once your program is organized as a tractable collection of functions and class +behaviours you should write test functions that exercise the behaviours. A test +suite that automates a sequence of tests can be associated with each module. +This sounds like a lot of work, but since Python is so terse and flexible it’s +surprisingly easy. You can make coding much more pleasant and fun by writing +your test functions in parallel with the “production code”, since this makes it +easy to find bugs and even design flaws earlier.

    +

    “Support modules” that are not intended to be the main module of a program may +include a self-test of the module.

    +
    if __name__ == "__main__":
    +    self_test()
    +
    +
    +

    Even programs that interact with complex external interfaces may be tested when +the external interfaces are unavailable by using “fake” interfaces implemented +in Python.

    +
    +
    +

    How do I create documentation from doc strings?

    +

    The pydoc module can create HTML from the doc strings in your Python +source code. An alternative for creating API documentation purely from +docstrings is epydoc. Sphinx can also include docstring content.

    +
    +
    +

    How do I get a single keypress at a time?

    +

    For Unix variants there are several solutions. It’s straightforward to do this +using curses, but curses is a fairly large module to learn.

    +
    +
    +
    +

    Threads

    +
    +

    How do I program using threads?

    +

    Be sure to use the threading module and not the _thread module. +The threading module builds convenient abstractions on top of the +low-level primitives provided by the _thread module.

    +

    Aahz has a set of slides from his threading tutorial that are helpful; see +http://www.pythoncraft.com/OSCON2001/.

    +
    +
    +

    None of my threads seem to run: why?

    +

    As soon as the main thread exits, all threads are killed. Your main thread is +running too quickly, giving the threads no time to do any work.

    +

    A simple fix is to add a sleep to the end of the program that’s long enough for +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(10):
    +    T = threading.Thread(target=thread_task, args=(str(i), i))
    +    T.start()
    +
    +time.sleep(10)  # <---------------------------!
    +
    +
    +

    But now (on many platforms) the threads don’t run in parallel, but appear to run +sequentially, one at a time! The reason is that the OS thread scheduler doesn’t +start a new thread until the previous thread is blocked.

    +

    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(10):
    +    T = threading.Thread(target=thread_task, args=(str(i), i))
    +    T.start()
    +
    +time.sleep(10)
    +
    +
    +

    Instead of trying to guess a good delay value for time.sleep(), +it’s better to use some kind of semaphore mechanism. One idea is to use the +queue module to create a queue object, let each thread append a token to +the queue when it finishes, and let the main thread read as many tokens from the +queue as there are threads.

    +
    +
    +

    How do I parcel out work among a bunch of worker threads?

    +

    The easiest way is to use the new concurrent.futures module, +especially the ThreadPoolExecutor class.

    +

    Or, if you want fine control over the dispatching algorithm, you can write +your own logic manually. Use the queue module to create a queue +containing a list of jobs. The Queue class maintains a +list of objects and has a .put(obj) method that adds items to the queue and +a .get() method to return them. The class will take care of the locking +necessary to ensure that each job is handed out exactly once.

    +

    Here’s a trivial example:

    +
    import threading, queue, time
    +
    +# The worker thread gets jobs off the queue.  When the queue is empty, it
    +# assumes there will be no more work and exits.
    +# (Realistically workers will run until terminated.)
    +def worker():
    +    print('Running worker')
    +    time.sleep(0.1)
    +    while True:
    +        try:
    +            arg = q.get(block=False)
    +        except queue.Empty:
    +            print('Worker', threading.currentThread(), end=' ')
    +            print('queue empty')
    +            break
    +        else:
    +            print('Worker', threading.currentThread(), end=' ')
    +            print('running with argument', arg)
    +            time.sleep(0.5)
    +
    +# Create queue
    +q = queue.Queue()
    +
    +# Start a pool of 5 workers
    +for i in range(5):
    +    t = threading.Thread(target=worker, name='worker %i' % (i+1))
    +    t.start()
    +
    +# Begin adding work to the queue
    +for i in range(50):
    +    q.put(i)
    +
    +# Give threads time to run
    +print('Main thread sleeping')
    +time.sleep(5)
    +
    +
    +

    When run, this will produce the following output:

    +
    Running worker
    +Running worker
    +Running worker
    +Running worker
    +Running worker
    +Main thread sleeping
    +Worker <Thread(worker 1, started 130283832797456)> running with argument 0
    +Worker <Thread(worker 2, started 130283824404752)> running with argument 1
    +Worker <Thread(worker 3, started 130283816012048)> running with argument 2
    +Worker <Thread(worker 4, started 130283807619344)> running with argument 3
    +Worker <Thread(worker 5, started 130283799226640)> running with argument 4
    +Worker <Thread(worker 1, started 130283832797456)> running with argument 5
    +...
    +
    +
    +

    Consult the module’s documentation for more details; the Queue +class provides a featureful interface.

    +
    +
    +

    What kinds of global value mutation are thread-safe?

    +

    A global interpreter lock (GIL) is used internally to ensure that only one +thread runs in the Python VM at a time. In general, Python offers to switch +among threads only between bytecode instructions; how frequently it switches can +be set via sys.setswitchinterval(). Each bytecode instruction and +therefore all the C implementation code reached from each instruction is +therefore atomic from the point of view of a Python program.

    +

    In theory, this means an exact accounting requires an exact understanding of the +PVM bytecode implementation. In practice, it means that operations on shared +variables of built-in data types (ints, lists, dicts, etc) that “look atomic” +really are.

    +

    For example, the following operations are all atomic (L, L1, L2 are lists, D, +D1, D2 are dicts, x, y are objects, i, j are ints):

    +
    L.append(x)
    +L1.extend(L2)
    +x = L[i]
    +x = L.pop()
    +L1[i:j] = L2
    +L.sort()
    +x = y
    +x.field = y
    +D[x] = y
    +D1.update(D2)
    +D.keys()
    +
    +
    +

    These aren’t:

    +
    i = i+1
    +L.append(L[-1])
    +L[i] = L[j]
    +D[x] = D[x] + 1
    +
    +
    +

    Operations that replace other objects may invoke those other objects’ +__del__() method when their reference count reaches zero, and that can +affect things. This is especially true for the mass updates to dictionaries and +lists. When in doubt, use a mutex!

    +
    +
    +

    Can’t we get rid of the Global Interpreter Lock?

    +

    The global interpreter lock (GIL) is often seen as a hindrance to Python’s +deployment on high-end multiprocessor server machines, because a multi-threaded +Python program effectively only uses one CPU, due to the insistence that +(almost) all Python code can only run while the GIL is held.

    +

    Back in the days of Python 1.5, Greg Stein actually implemented a comprehensive +patch set (the “free threading” patches) that removed the GIL and replaced it +with fine-grained locking. Adam Olsen recently did a similar experiment +in his python-safethread +project. Unfortunately, both experiments exhibited a sharp drop in single-thread +performance (at least 30% slower), due to the amount of fine-grained locking +necessary to compensate for the removal of the GIL.

    +

    This doesn’t mean that you can’t make good use of Python on multi-CPU machines! +You just have to be creative with dividing the work up between multiple +processes rather than multiple threads. The +ProcessPoolExecutor class in the new +concurrent.futures module provides an easy way of doing so; the +multiprocessing module provides a lower-level API in case you want +more control over dispatching of tasks.

    +

    Judicious use of C extensions will also help; if you use a C extension to +perform a time-consuming task, the extension can release the GIL while the +thread of execution is in the C code and allow other threads to get some work +done. Some standard library modules such as zlib and hashlib +already do this.

    +

    It has been suggested that the GIL should be a per-interpreter-state lock rather +than truly global; interpreters then wouldn’t be able to share objects. +Unfortunately, this isn’t likely to happen either. It would be a tremendous +amount of work, because many object implementations currently have global state. +For example, small integers and short strings are cached; these caches would +have to be moved to the interpreter state. Other object types have their own +free list; these free lists would have to be moved to the interpreter state. +And so on.

    +

    And I doubt that it can even be done in finite time, because the same problem +exists for 3rd party extensions. It is likely that 3rd party extensions are +being written at a faster rate than you can convert them to store all their +global state in the interpreter state.

    +

    And finally, once you have multiple interpreters not sharing any state, what +have you gained over running each interpreter in a separate process?

    +
    +
    +
    +

    Input and Output

    +
    +

    How do I delete a file? (And other file questions…)

    +

    Use os.remove(filename) or os.unlink(filename); for documentation, see +the os module. The two functions are identical; unlink() is simply +the name of the Unix system call for this function.

    +

    To remove a directory, use os.rmdir(); use os.mkdir() to create one. +os.makedirs(path) will create any intermediate directories in path that +don’t exist. os.removedirs(path) will remove intermediate directories as +long as they’re empty; if you want to delete an entire directory tree and its +contents, use shutil.rmtree().

    +

    To rename a file, use os.rename(old_path, new_path).

    +

    To truncate a file, open it using f = open(filename, "rb+"), and use +f.truncate(offset); offset defaults to the current seek position. There’s +also os.ftruncate(fd, offset) for files opened with os.open(), where +fd is the file descriptor (a small integer).

    +

    The shutil module also contains a number of functions to work on files +including copyfile(), copytree(), and +rmtree().

    +
    +
    +

    How do I copy a file?

    +

    The shutil module contains a copyfile() function. Note +that on MacOS 9 it doesn’t copy the resource fork and Finder info.

    +
    +
    +

    How do I read (or write) binary data?

    +

    To read or write complex binary data formats, it’s best to use the struct +module. It allows you to take a string containing binary data (usually numbers) +and convert it to Python objects; and vice versa.

    +

    For example, the following code reads two 2-byte integers and one 4-byte integer +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)
    +
    +
    +

    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 +string.

    +

    For data that is more regular (e.g. a homogeneous list of ints or floats), +you can also use the array module.

    +
    +

    Note

    +

    To read and write binary data, it is mandatory to open the file in +binary mode (here, passing "rb" to open()). If you use +"r" instead (the default), the file will be open in text mode +and f.read() will return str objects rather than +bytes objects.

    +
    +
    +
    +

    I can’t seem to use os.read() on a pipe created with os.popen(); why?

    +

    os.read() is a low-level function which takes a file descriptor, a small +integer representing the opened file. os.popen() creates a high-level +file object, the same type returned by the built-in open() function. +Thus, to read n bytes from a pipe p created with os.popen(), you need to +use p.read(n).

    +
    +
    +

    How do I access the serial (RS232) port?

    +

    For Win32, POSIX (Linux, BSD, etc.), Jython:

    +
    +
    +

    For Unix, see a Usenet post by Mitch Chapman:

    +
    +
    +
    +
    +

    Why doesn’t closing sys.stdout (stdin, stderr) really close it?

    +

    Python file objects are a high-level layer of +abstraction on low-level C file descriptors.

    +

    For most file objects you create in Python via the built-in open() +function, f.close() marks the Python file object as being closed from +Python’s point of view, and also arranges to close the underlying C file +descriptor. This also happens automatically in f’s destructor, when +f becomes garbage.

    +

    But stdin, stdout and stderr are treated specially by Python, because of the +special status also given to them by C. Running sys.stdout.close() marks +the Python-level file object as being closed, but does not close the +associated C file descriptor.

    +

    To close the underlying C file descriptor for one of these three, you should +first be sure that’s what you really want to do (e.g., you may confuse +extension modules trying to do I/O). If it is, use os.close():

    +
    os.close(stdin.fileno())
    +os.close(stdout.fileno())
    +os.close(stderr.fileno())
    +
    +
    +

    Or you can use the numeric constants 0, 1 and 2, respectively.

    +
    +
    +
    +

    Network/Internet Programming

    +
    +

    What WWW tools are there for Python?

    +

    See the chapters titled Internet Protocols and Support and Internet Data Handling in the Library +Reference Manual. Python has many modules that will help you build server-side +and client-side web systems.

    +

    A summary of available frameworks is maintained by Paul Boddie at +https://wiki.python.org/moin/WebProgramming.

    +

    Cameron Laird maintains a useful set of pages about Python web technologies at +http://phaseit.net/claird/comp.lang.python/web_python.

    +
    +
    +

    How can I mimic CGI form submission (METHOD=POST)?

    +

    I would like to retrieve web pages that are the result of POSTing a form. Is +there existing code that would let me do this easily?

    +

    Yes. Here’s a simple example that uses urllib.request:

    +
    #!/usr/local/bin/python
    +
    +import urllib.request
    +
    +# build the query string
    +qs = "First=Josephine&MI=Q&Last=Public"
    +
    +# 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:
    +    msg, hdrs = req.read(), req.info()
    +
    +
    +

    Note that in general for percent-encoded POST operations, query strings must be +quoted using urllib.parse.urlencode(). For example, to send +name=Guy Steele, Jr.:

    +
    >>> import urllib.parse
    +>>> urllib.parse.urlencode({'name': 'Guy Steele, Jr.'})
    +'name=Guy+Steele%2C+Jr.'
    +
    +
    +
    +

    See also

    +

    HOWTO Fetch Internet Resources Using The urllib Package for extensive examples.

    +
    +
    +
    +

    What module should I use to help with generating HTML?

    +

    You can find a collection of useful links on the Web Programming wiki page.

    +
    +
    +

    How do I send mail from a Python script?

    +

    Use the standard library module smtplib.

    +

    Here’s a very simple interactive mail sender that uses it. This method will +work on any host that supports an SMTP listener.

    +
    import sys, smtplib
    +
    +fromaddr = input("From: ")
    +toaddrs  = input("To: ").split(',')
    +print("Enter message, end with ^D:")
    +msg = ''
    +while True:
    +    line = sys.stdin.readline()
    +    if not line:
    +        break
    +    msg += line
    +
    +# The actual mail send
    +server = smtplib.SMTP('localhost')
    +server.sendmail(fromaddr, toaddrs, msg)
    +server.quit()
    +
    +
    +

    A Unix-only alternative uses sendmail. The location of the sendmail program +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:

    +
    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")
    +p.write("\n")  # blank line separating headers from body
    +p.write("Some text\n")
    +p.write("some more text\n")
    +sts = p.close()
    +if sts != 0:
    +    print("Sendmail exit status", sts)
    +
    +
    +
    +
    +

    How do I avoid blocking in the connect() method of a socket?

    +

    The select module is commonly used to help with asynchronous I/O on +sockets.

    +

    To prevent the TCP connect from blocking, you can set the socket to non-blocking +mode. Then when you do the connect(), you will either connect immediately +(unlikely) or get an exception that contains the error number as .errno. +errno.EINPROGRESS indicates that the connection is in progress, but hasn’t +finished yet. Different OSes will return different values, so you’re going to +have to check what’s returned on your system.

    +

    You can use the connect_ex() method to avoid creating an exception. It will +just return the errno value. To poll, you can call connect_ex() again later +– 0 or errno.EISCONN indicate that you’re connected – or you can pass this +socket to select to check if it’s writable.

    +
    +

    Note

    +

    The asyncore module presents a framework-like approach to the problem +of writing non-blocking networking code. +The third-party Twisted library is +a popular and feature-rich alternative.

    +
    +
    +
    +
    +

    Databases

    +
    +

    Are there any interfaces to database packages in Python?

    +

    Yes.

    +

    Interfaces to disk-based hashes such as DBM and GDBM are also included with standard Python. There is also the +sqlite3 module, which provides a lightweight disk-based relational +database.

    +

    Support for most relational databases is available. See the +DatabaseProgramming wiki page for details.

    +
    +
    +

    How do you implement persistent objects in Python?

    +

    The pickle library module solves this in a very general way (though you +still can’t store things like open files, sockets or windows), and the +shelve library module uses pickle and (g)dbm to create persistent +mappings containing arbitrary Python objects.

    +
    +
    +
    +

    Mathematics and Numerics

    +
    +

    How do I generate random numbers in Python?

    +

    The standard module random implements a random number generator. Usage +is simple:

    +
    import random
    +random.random()
    +
    +
    +

    This returns a random floating point number in the range [0, 1).

    +

    There are also many other specialized generators in this module, such as:

    +
      +
    • randrange(a, b) chooses an integer in the range [a, b).

    • +
    • uniform(a, b) chooses a floating point number in the range [a, b).

    • +
    • normalvariate(mean, sdev) samples the normal (Gaussian) distribution.

    • +
    +

    Some higher-level functions operate on sequences directly, such as:

    +
      +
    • choice(S) chooses random element from a given sequence

    • +
    • shuffle(L) shuffles a list in-place, i.e. permutes it randomly

    • +
    +

    There’s also a Random class you can instantiate to create independent +multiple random number generators.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/faq/programming.html b/python-3.7.4-docs-html/faq/programming.html new file mode 100644 index 0000000..006edcd --- /dev/null +++ b/python-3.7.4-docs-html/faq/programming.html @@ -0,0 +1,1967 @@ + + + + + + + Programming FAQ — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Programming FAQ

    +
    +

    Contents

    + +
    +
    +

    General Questions

    +
    +

    Is there a source code level debugger with breakpoints, single-stepping, etc.?

    +

    Yes.

    +

    Several debuggers for Python are described below, and the built-in function +breakpoint() allows you to drop into any of them.

    +

    The pdb module is a simple but adequate console-mode debugger for Python. It is +part of the standard Python library, and is documented in the Library +Reference Manual. You can also write your own debugger by using the code +for pdb as an example.

    +

    The IDLE interactive development environment, which is part of the standard +Python distribution (normally available as Tools/scripts/idle), includes a +graphical debugger.

    +

    PythonWin is a Python IDE that includes a GUI debugger based on pdb. The +Pythonwin debugger colors breakpoints and has quite a few cool features such as +debugging non-Pythonwin programs. Pythonwin is available as part of the Python +for Windows Extensions project and +as a part of the ActivePython distribution (see +https://www.activestate.com/activepython).

    +

    Boa Constructor is an IDE and GUI +builder that uses wxWidgets. It offers visual frame creation and manipulation, +an object inspector, many views on the source like object browsers, inheritance +hierarchies, doc string generated html documentation, an advanced debugger, +integrated help, and Zope support.

    +

    Eric is an IDE built on PyQt +and the Scintilla editing component.

    +

    Pydb is a version of the standard Python debugger pdb, modified for use with DDD +(Data Display Debugger), a popular graphical debugger front end. Pydb can be +found at http://bashdb.sourceforge.net/pydb/ and DDD can be found at +https://www.gnu.org/software/ddd.

    +

    There are a number of commercial Python IDEs that include graphical debuggers. +They include:

    + +
    +
    +

    Is there a tool to help find bugs or perform static analysis?

    +

    Yes.

    +

    PyChecker is a static analysis tool that finds bugs in Python source code and +warns about code complexity and style. You can get PyChecker from +http://pychecker.sourceforge.net/.

    +

    Pylint is another tool that checks +if a module satisfies a coding standard, and also makes it possible to write +plug-ins to add a custom feature. In addition to the bug checking that +PyChecker performs, Pylint offers some additional features such as checking line +length, whether variable names are well-formed according to your coding +standard, whether declared interfaces are fully implemented, and more. +https://docs.pylint.org/ provides a full list of Pylint’s features.

    +

    Static type checkers such as Mypy, +Pyre, and +Pytype can check type hints in Python +source code.

    +
    +
    +

    How can I create a stand-alone binary from a Python script?

    +

    You don’t need the ability to compile Python to C code if all you want is a +stand-alone program that users can download and run without having to install +the Python distribution first. There are a number of tools that determine the +set of modules required by a program and bind these modules together with a +Python binary to produce a single executable.

    +

    One is to use the freeze tool, which is included in the Python source tree as +Tools/freeze. It converts Python byte code to C arrays; a C compiler you can +embed all your modules into a new program, which is then linked with the +standard Python modules.

    +

    It works by scanning your source recursively for import statements (in both +forms) and looking for the modules in the standard Python path as well as in the +source directory (for built-in modules). It then turns the bytecode for modules +written in Python into C code (array initializers that can be turned into code +objects using the marshal module) and creates a custom-made config file that +only contains those built-in modules which are actually used in the program. It +then compiles the generated C code and links it with the rest of the Python +interpreter to form a self-contained binary which acts exactly like your script.

    +

    Obviously, freeze requires a C compiler. There are several other utilities +which don’t. One is Thomas Heller’s py2exe (Windows only) at

    +
    +
    +

    Another tool is Anthony Tuininga’s cx_Freeze.

    +
    +
    +

    Are there coding standards or a style guide for Python programs?

    +

    Yes. The coding style required for standard library modules is documented as +PEP 8.

    +
    +
    +
    +

    Core Language

    +
    +

    Why am I getting an UnboundLocalError when the variable has a value?

    +

    It can be a surprise to get the UnboundLocalError in previously working +code when it is modified by adding an assignment statement somewhere in +the body of a function.

    +

    This code:

    +
    >>> x = 10
    +>>> def bar():
    +...     print(x)
    +>>> bar()
    +10
    +
    +
    +

    works, but this code:

    +
    >>> x = 10
    +>>> def foo():
    +...     print(x)
    +...     x += 1
    +
    +
    +

    results in an UnboundLocalError:

    +
    >>> foo()
    +Traceback (most recent call last):
    +  ...
    +UnboundLocalError: local variable 'x' referenced before assignment
    +
    +
    +

    This is because when you make an assignment to a variable in a scope, that +variable becomes local to that scope and shadows any similarly named variable +in the outer scope. Since the last statement in foo assigns a new value to +x, the compiler recognizes it as a local variable. Consequently when the +earlier print(x) attempts to print the uninitialized local variable and +an error results.

    +

    In the example above you can access the outer scope variable by declaring it +global:

    +
    >>> x = 10
    +>>> def foobar():
    +...     global x
    +...     print(x)
    +...     x += 1
    +>>> foobar()
    +10
    +
    +
    +

    This explicit declaration is required in order to remind you that (unlike the +superficially analogous situation with class and instance variables) you are +actually modifying the value of the variable in the outer scope:

    +
    >>> print(x)
    +11
    +
    +
    +

    You can do a similar thing in a nested scope using the nonlocal +keyword:

    +
    >>> def foo():
    +...    x = 10
    +...    def bar():
    +...        nonlocal x
    +...        print(x)
    +...        x += 1
    +...    bar()
    +...    print(x)
    +>>> foo()
    +10
    +11
    +
    +
    +
    +
    +

    What are the rules for local and global variables in Python?

    +

    In Python, variables that are only referenced inside a function are implicitly +global. If a variable is assigned a value anywhere within the function’s body, +it’s assumed to be a local unless explicitly declared as global.

    +

    Though a bit surprising at first, a moment’s consideration explains this. On +one hand, requiring global for assigned variables provides a bar +against unintended side-effects. On the other hand, if global was required +for all global references, you’d be using global all the time. You’d have +to declare as global every reference to a built-in function or to a component of +an imported module. This clutter would defeat the usefulness of the global +declaration for identifying side-effects.

    +
    +
    +

    Why do lambdas defined in a loop with different values all return the same result?

    +

    Assume you use a for loop to define a few different lambdas (or even plain +functions), e.g.:

    +
    >>> squares = []
    +>>> for x in range(5):
    +...     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, +4, 9, and 16. However, when you actually try you will see that +they all return 16:

    +
    >>> squares[2]()
    +16
    +>>> squares[4]()
    +16
    +
    +
    +

    This happens because x is not local to the lambdas, but is defined in +the outer scope, and it is accessed when the lambda is called — not when it +is defined. At the end of the loop, the value of x is 4, so all the +functions now return 4**2, i.e. 16. You can also verify this by +changing the value of x and see how the results of the lambdas change:

    +
    >>> x = 8
    +>>> squares[2]()
    +64
    +
    +
    +

    In order to avoid this, you need to save the values in variables local to the +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)
    +
    +
    +

    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 +that point in the loop. This means that the value of n will be 0 +in the first lambda, 1 in the second, 2 in the third, and so on. +Therefore each lambda will now return the correct result:

    +
    >>> squares[2]()
    +4
    +>>> squares[4]()
    +16
    +
    +
    +

    Note that this behaviour is not peculiar to lambdas, but applies to regular +functions too.

    +
    +
    +

    How do I share global variables across modules?

    +

    The canonical way to share information across modules within a single program is +to create a special module (often called config or cfg). Just import the config +module in all modules of your application; the module then becomes available as +a global name. Because there is only one instance of each module, any changes +made to the module object get reflected everywhere. For example:

    +

    config.py:

    +
    x = 0   # Default value of the 'x' configuration setting
    +
    +
    +

    mod.py:

    +
    import config
    +config.x = 1
    +
    +
    +

    main.py:

    +
    import config
    +import mod
    +print(config.x)
    +
    +
    +

    Note that using a module is also the basis for implementing the Singleton design +pattern, for the same reason.

    +
    +
    +

    What are the “best practices” for using import in a module?

    +

    In general, don’t use from modulename import *. Doing so clutters the +importer’s namespace, and makes it much harder for linters to detect undefined +names.

    +

    Import modules at the top of a file. Doing so makes it clear what other modules +your code requires and avoids questions of whether the module name is in scope. +Using one import per line makes it easy to add and delete module imports, but +using multiple imports per line uses less screen space.

    +

    It’s good practice if you import modules in the following order:

    +
      +
    1. standard library modules – e.g. sys, os, getopt, re

    2. +
    3. third-party library modules (anything installed in Python’s site-packages +directory) – e.g. mx.DateTime, ZODB, PIL.Image, etc.

    4. +
    5. locally-developed modules

    6. +
    +

    It is sometimes necessary to move imports to a function or class to avoid +problems with circular imports. Gordon McMillan says:

    +
    +

    Circular imports are fine where both modules use the “import <module>” form +of import. They fail when the 2nd module wants to grab a name out of the +first (“from module import name”) and the import is at the top level. That’s +because names in the 1st are not yet available, because the first module is +busy importing the 2nd.

    +
    +

    In this case, if the second module is only used in one function, then the import +can easily be moved into that function. By the time the import is called, the +first module will have finished initializing, and the second module can do its +import.

    +

    It may also be necessary to move imports out of the top level of code if some of +the modules are platform-specific. In that case, it may not even be possible to +import all of the modules at the top of the file. In this case, importing the +correct modules in the corresponding platform-specific code is a good option.

    +

    Only move imports into a local scope, such as inside a function definition, if +it’s necessary to solve a problem such as avoiding a circular import or are +trying to reduce the initialization time of a module. This technique is +especially helpful if many of the imports are unnecessary depending on how the +program executes. You may also want to move imports into a function if the +modules are only ever used in that function. Note that loading a module the +first time may be expensive because of the one time initialization of the +module, but loading a module multiple times is virtually free, costing only a +couple of dictionary lookups. Even if the module name has gone out of scope, +the module is probably available in sys.modules.

    +
    +
    +

    Why are default values shared between objects?

    +

    This type of bug commonly bites neophyte programmers. Consider this function:

    +
    def foo(mydict={}):  # Danger: shared reference to one dict for all calls
    +    ... compute something ...
    +    mydict[key] = value
    +    return mydict
    +
    +
    +

    The first time you call this function, mydict contains a single item. The +second time, mydict contains two items because when foo() begins +executing, mydict starts out with an item already in it.

    +

    It is often expected that a function call creates new objects for default +values. This is not what happens. Default values are created exactly once, when +the function is defined. If that object is changed, like the dictionary in this +example, subsequent calls to the function will refer to this changed object.

    +

    By definition, immutable objects such as numbers, strings, tuples, and None, +are safe from change. Changes to mutable objects such as dictionaries, lists, +and class instances can lead to confusion.

    +

    Because of this feature, it is good programming practice to not use mutable +objects as default values. Instead, use None as the default value and +inside the function, check if the parameter is None and create a new +list/dictionary/whatever if it is. For example, don’t write:

    +
    def foo(mydict={}):
    +    ...
    +
    +
    +

    but:

    +
    def foo(mydict=None):
    +    if mydict is None:
    +        mydict = {}  # create a new dict for local namespace
    +
    +
    +

    This feature can be useful. When you have a function that’s time-consuming to +compute, a common technique is to cache the parameters and the resulting value +of each call to the function, and return the cached value if the same value is +requested again. This is called “memoizing”, and can be implemented like this:

    +
    # Callers can only provide two parameters and optionally pass _cache by keyword
    +def expensive(arg1, arg2, *, _cache={}):
    +    if (arg1, arg2) in _cache:
    +        return _cache[(arg1, arg2)]
    +
    +    # Calculate the value
    +    result = ... expensive computation ...
    +    _cache[(arg1, arg2)] = result           # Store result in the cache
    +    return result
    +
    +
    +

    You could use a global variable containing a dictionary instead of the default +value; it’s a matter of taste.

    +
    +
    +

    How can I pass optional or keyword parameters from one function to another?

    +

    Collect the arguments using the * and ** specifiers in the function’s +parameter list; this gives you the positional arguments as a tuple and the +keyword arguments as a dictionary. You can then pass these arguments when +calling another function by using * and **:

    +
    def f(x, *args, **kwargs):
    +    ...
    +    kwargs['width'] = '14.3c'
    +    ...
    +    g(x, *args, **kwargs)
    +
    +
    +
    +
    +

    What is the difference between arguments and parameters?

    +

    Parameters are defined by the names that appear in a +function definition, whereas arguments are the values +actually passed to a function when calling it. Parameters define what types of +arguments a function can accept. For example, given the function definition:

    +
    def func(foo, bar=None, **kwargs):
    +    pass
    +
    +
    +

    foo, bar and kwargs are parameters of func. However, when calling +func, for example:

    +
    func(42, bar=314, extra=somevar)
    +
    +
    +

    the values 42, 314, and somevar are arguments.

    +
    +
    +

    Why did changing list ‘y’ also change list ‘x’?

    +

    If you wrote code like:

    +
    >>> x = []
    +>>> y = x
    +>>> y.append(10)
    +>>> y
    +[10]
    +>>> x
    +[10]
    +
    +
    +

    you might be wondering why appending an element to y changed x too.

    +

    There are two factors that produce this result:

    +
      +
    1. Variables are simply names that refer to objects. Doing y = x doesn’t +create a copy of the list – it creates a new variable y that refers to +the same object x refers to. This means that there is only one object +(the list), and both x and y refer to it.

    2. +
    3. Lists are mutable, which means that you can change their content.

    4. +
    +

    After the call to append(), the content of the mutable object has +changed from [] to [10]. Since both the variables refer to the same +object, using either name accesses the modified value [10].

    +

    If we instead assign an immutable object to x:

    +
    >>> x = 5  # ints are immutable
    +>>> y = x
    +>>> x = x + 1  # 5 can't be mutated, we are creating a new object here
    +>>> x
    +6
    +>>> y
    +5
    +
    +
    +

    we can see that in this case x and y are not equal anymore. This is +because integers are immutable, and when we do x = x + 1 we are not +mutating the int 5 by incrementing its value; instead, we are creating a +new object (the int 6) and assigning it to x (that is, changing which +object x refers to). After this assignment we have two objects (the ints +6 and 5) and two variables that refer to them (x now refers to +6 but y still refers to 5).

    +

    Some operations (for example y.append(10) and y.sort()) mutate the +object, whereas superficially similar operations (for example y = y + [10] +and sorted(y)) create a new object. In general in Python (and in all cases +in the standard library) a method that mutates an object will return None +to help avoid getting the two types of operations confused. So if you +mistakenly write y.sort() thinking it will give you a sorted copy of y, +you’ll instead end up with None, which will likely cause your program to +generate an easily diagnosed error.

    +

    However, there is one class of operations where the same operation sometimes +has different behaviors with different types: the augmented assignment +operators. For example, += mutates lists but not tuples or ints (a_list ++= [1, 2, 3] is equivalent to a_list.extend([1, 2, 3]) and mutates +a_list, whereas some_tuple += (1, 2, 3) and some_int += 1 create +new objects).

    +

    In other words:

    +
      +
    • If we have a mutable object (list, dict, set, +etc.), we can use some specific operations to mutate it and all the variables +that refer to it will see the change.

    • +
    • If we have an immutable object (str, int, tuple, +etc.), all the variables that refer to it will always see the same value, +but operations that transform that value into a new value always return a new +object.

    • +
    +

    If you want to know if two variables refer to the same object or not, you can +use the is operator, or the built-in function id().

    +
    +
    +

    How do I write a function with output parameters (call by reference)?

    +

    Remember that arguments are passed by assignment in Python. Since assignment +just creates references to objects, there’s no alias between an argument name in +the caller and callee, and so no call-by-reference per se. You can achieve the +desired effect in a number of ways.

    +
      +
    1. By returning a tuple of the results:

      +
      def func2(a, b):
      +    a = 'new-value'        # a and b are local names
      +    b = b + 1              # assigned to new objects
      +    return a, b            # return new values
      +
      +x, y = 'old-value', 99
      +x, y = func2(x, y)
      +print(x, y)                # output: new-value 100
      +
      +
      +

      This is almost always the clearest solution.

      +
    2. +
    3. By using global variables. This isn’t thread-safe, and is not recommended.

    4. +
    5. By passing a mutable (changeable in-place) object:

      +
      def func1(a):
      +    a[0] = 'new-value'     # 'a' references a mutable list
      +    a[1] = a[1] + 1        # changes a shared object
      +
      +args = ['old-value', 99]
      +func1(args)
      +print(args[0], args[1])    # output: new-value 100
      +
      +
      +
    6. +
    7. By passing in a dictionary that gets mutated:

      +
      def func3(args):
      +    args['a'] = 'new-value'     # args is a mutable dictionary
      +    args['b'] = args['b'] + 1   # change it in-place
      +
      +args = {'a': 'old-value', 'b': 99}
      +func3(args)
      +print(args['a'], args['b'])
      +
      +
      +
    8. +
    9. Or bundle up values in a class instance:

      +
      class callByRef:
      +    def __init__(self, **args):
      +        for (key, value) in args.items():
      +            setattr(self, key, value)
      +
      +def func4(args):
      +    args.a = 'new-value'        # args is a mutable callByRef
      +    args.b = args.b + 1         # change object in-place
      +
      +args = callByRef(a='old-value', b=99)
      +func4(args)
      +print(args.a, args.b)
      +
      +
      +

      There’s almost never a good reason to get this complicated.

      +
    10. +
    +

    Your best choice is to return a tuple containing the multiple results.

    +
    +
    +

    How do you make a higher order function in Python?

    +

    You have two choices: you can use nested scopes or you can use callable objects. +For example, suppose you wanted to define linear(a,b) which returns a +function f(x) that computes the value a*x+b. Using nested scopes:

    +
    def linear(a, b):
    +    def result(x):
    +        return a * x + b
    +    return result
    +
    +
    +

    Or using a callable object:

    +
    class linear:
    +
    +    def __init__(self, a, b):
    +        self.a, self.b = a, b
    +
    +    def __call__(self, x):
    +        return self.a * x + self.b
    +
    +
    +

    In both cases,

    +
    taxes = linear(0.3, 2)
    +
    +
    +

    gives a callable object where taxes(10e6) == 0.3 * 10e6 + 2.

    +

    The callable object approach has the disadvantage that it is a bit slower and +results in slightly longer code. However, note that a collection of callables +can share their signature via inheritance:

    +
    class exponential(linear):
    +    # __init__ inherited
    +    def __call__(self, x):
    +        return self.a * (x ** self.b)
    +
    +
    +

    Object can encapsulate state for several methods:

    +
    class counter:
    +
    +    value = 0
    +
    +    def set(self, x):
    +        self.value = x
    +
    +    def up(self):
    +        self.value = self.value + 1
    +
    +    def down(self):
    +        self.value = self.value - 1
    +
    +count = counter()
    +inc, dec, reset = count.up, count.down, count.set
    +
    +
    +

    Here inc(), dec() and reset() act like functions which share the +same counting variable.

    +
    +
    +

    How do I copy an object in Python?

    +

    In general, try copy.copy() or copy.deepcopy() for the general case. +Not all objects can be copied, but most can.

    +

    Some objects can be copied more easily. Dictionaries have a copy() +method:

    +
    newdict = olddict.copy()
    +
    +
    +

    Sequences can be copied by slicing:

    +
    new_l = l[:]
    +
    +
    +
    +
    +

    How can I find the methods or attributes of an object?

    +

    For an instance x of a user-defined class, dir(x) returns an alphabetized +list of the names containing the instance attributes and methods and attributes +defined by its class.

    +
    +
    +

    How can my code discover the name of an object?

    +

    Generally speaking, it can’t, because objects don’t really have names. +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)
    +<__main__.A object at 0x16D07CC>
    +>>> print(a)
    +<__main__.A object at 0x16D07CC>
    +
    +
    +

    Arguably the class has a name: even though it is bound to two names and invoked +through the name B the created instance is still reported as an instance of +class A. However, it is impossible to say whether the instance’s name is a or +b, since both names are bound to the same value.

    +

    Generally speaking it should not be necessary for your code to “know the names” +of particular values. Unless you are deliberately writing introspective +programs, this is usually an indication that a change of approach might be +beneficial.

    +

    In comp.lang.python, Fredrik Lundh once gave an excellent analogy in answer to +this question:

    +
    +

    The same way as you get the name of that cat you found on your porch: the cat +(object) itself cannot tell you its name, and it doesn’t really care – so +the only way to find out what it’s called is to ask all your neighbours +(namespaces) if it’s their cat (object)…

    +

    ….and don’t be surprised if you’ll find that it’s known by many names, or +no name at all!

    +
    +
    +
    +

    What’s up with the comma operator’s precedence?

    +

    Comma is not an operator in Python. Consider this session:

    +
    >>> "a" in "b", "a"
    +(False, 'a')
    +
    +
    +

    Since the comma is not an operator, but a separator between expressions the +above is evaluated as if you had entered:

    +
    ("a" in "b"), "a"
    +
    +
    +

    not:

    +
    "a" in ("b", "a")
    +
    +
    +

    The same is true of the various assignment operators (=, += etc). They +are not truly operators but syntactic delimiters in assignment statements.

    +
    +
    +

    Is there an equivalent of C’s “?:” ternary operator?

    +

    Yes, there is. The syntax is as follows:

    +
    [on_true] if [expression] else [on_false]
    +
    +x, y = 50, 25
    +small = x if x < y else y
    +
    +
    +

    Before this syntax was introduced in Python 2.5, a common idiom was to use +logical operators:

    +
    [expression] and [on_true] or [on_false]
    +
    +
    +

    However, this idiom is unsafe, as it can give wrong results when on_true +has a false boolean value. Therefore, it is always better to use +the ... if ... else ... form.

    +
    +
    +

    Is it possible to write obfuscated one-liners in Python?

    +

    Yes. Usually this is done by nesting lambda within +lambda. See the following three examples, due to Ulf Bartelt:

    +
    from functools import reduce
    +
    +# Primes < 1000
    +print(list(filter(None,map(lambda y:y*reduce(lambda x,y:x*y!=0,
    +map(lambda x,y=y:y%x,range(2,int(pow(y,0.5)+1))),1),range(2,1000)))))
    +
    +# First 10 Fibonacci numbers
    +print(list(map(lambda x,f=lambda x,f:(f(x-1,f)+f(x-2,f)) if x>1 else 1:
    +f(x,f), range(10))))
    +
    +# Mandelbrot set
    +print((lambda Ru,Ro,Iu,Io,IM,Sx,Sy:reduce(lambda x,y:x+y,map(lambda y,
    +Iu=Iu,Io=Io,Ru=Ru,Ro=Ro,Sy=Sy,L=lambda yc,Iu=Iu,Io=Io,Ru=Ru,Ro=Ro,i=IM,
    +Sx=Sx,Sy=Sy:reduce(lambda x,y:x+y,map(lambda x,xc=Ru,yc=yc,Ru=Ru,Ro=Ro,
    +i=i,Sx=Sx,F=lambda xc,yc,x,y,k,f=lambda xc,yc,x,y,k,f:(k<=0)or (x*x+y*y
    +>=4.0) or 1+f(xc,yc,x*x-y*y+xc,2.0*x*y+yc,k-1,f):f(xc,yc,x,y,k,f):chr(
    +64+F(Ru+x*(Ro-Ru)/Sx,yc,0,0,i)),range(Sx))):L(Iu+y*(Io-Iu)/Sy),range(Sy
    +))))(-2.1, 0.7, -1.2, 1.2, 30, 80, 24))
    +#    \___ ___/  \___ ___/  |   |   |__ lines on screen
    +#        V          V      |   |______ columns on screen
    +#        |          |      |__________ maximum of "iterations"
    +#        |          |_________________ range on y axis
    +#        |____________________________ range on x axis
    +
    +
    +

    Don’t try this at home, kids!

    +
    +
    +

    What does the slash(/) in the parameter list of a function mean?

    +

    A slash in the argument list of a function denotes that the parameters prior to +it are positional-only. Positional-only parameters are the ones without an +externally-usable name. Upon calling a function that accepts positional-only +parameters, arguments are mapped to parameters based solely on their position. +For example, pow() is a function that accepts positional-only parameters. +Its documentation looks like this:

    +
    >>> help(pow)
    +Help on built-in function pow in module builtins:
    +
    +pow(x, y, z=None, /)
    +   Equivalent to x**y (with two arguments) or x**y % z (with three arguments)
    +
    +   Some types, such as ints, are able to use a more efficient algorithm when
    +   invoked using the three argument form.
    +
    +
    +

    The slash at the end of the parameter list means that all three parameters are +positional-only. Thus, calling pow() with keyword aguments would lead to +an error:

    +
    >>> pow(x=3, y=4)
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +TypeError: pow() takes no keyword arguments
    +
    +
    +

    Note that as of this writing this is only documentational and no valid syntax +in Python, although there is PEP 570, which proposes a syntax for +position-only parameters in Python.

    +
    +
    +
    +

    Numbers and strings

    +
    +

    How do I specify hexadecimal and octal integers?

    +

    To specify an octal digit, precede the octal value with a zero, and then a lower +or uppercase “o”. For example, to set the variable “a” to the octal value “10” +(8 in decimal), type:

    +
    >>> a = 0o10
    +>>> a
    +8
    +
    +
    +

    Hexadecimal is just as easy. Simply precede the hexadecimal number with a zero, +and then a lower or uppercase “x”. Hexadecimal digits can be specified in lower +or uppercase. For example, in the Python interpreter:

    +
    >>> a = 0xa5
    +>>> a
    +165
    +>>> b = 0XB2
    +>>> b
    +178
    +
    +
    +
    +
    +

    Why does -22 // 10 return -3?

    +

    It’s primarily driven by the desire that i % j have the same sign as j. +If you want that, and also want:

    +
    i == (i // j) * j + (i % j)
    +
    +
    +

    then integer division has to return the floor. C also requires that identity to +hold, and then compilers that truncate i // j need to make i % j have +the same sign as i.

    +

    There are few real use cases for i % j when j is negative. When j +is positive, there are many, and in virtually all of them it’s more useful for +i % j to be >= 0. If the clock says 10 now, what did it say 200 hours +ago? -190 % 12 == 2 is useful; -190 % 12 == -10 is a bug waiting to +bite.

    +
    +
    +

    How do I convert a string to a number?

    +

    For integers, use the built-in int() type constructor, e.g. int('144') +== 144. Similarly, float() converts to floating-point, +e.g. float('144') == 144.0.

    +

    By default, these interpret the number as decimal, so that int('0144') == +144 and int('0x144') raises ValueError. int(string, base) takes +the base to convert from as a second optional argument, so int('0x144', 16) == +324. If the base is specified as 0, the number is interpreted using Python’s +rules: a leading ‘0o’ indicates octal, and ‘0x’ indicates a hex number.

    +

    Do not use the built-in function eval() if all you need is to convert +strings to numbers. eval() will be significantly slower and it presents a +security risk: someone could pass you a Python expression that might have +unwanted side effects. For example, someone could pass +__import__('os').system("rm -rf $HOME") which would erase your home +directory.

    +

    eval() also has the effect of interpreting numbers as Python expressions, +so that e.g. eval('09') gives a syntax error because Python does not allow +leading ‘0’ in a decimal number (except ‘0’).

    +
    +
    +

    How do I convert a number to a string?

    +

    To convert, e.g., the number 144 to the string ‘144’, use the built-in type +constructor str(). If you want a hexadecimal or octal representation, use +the built-in functions hex() or oct(). For fancy formatting, see +the Formatted string literals and Format String Syntax sections, +e.g. "{:04d}".format(144) yields +'0144' and "{:.3f}".format(1.0/3.0) yields '0.333'.

    +
    +
    +

    How do I modify a string in place?

    +

    You can’t, because strings are immutable. In most situations, you should +simply construct a new string from the various parts you want to assemble +it from. However, if you need an object with the ability to modify in-place +unicode data, try using an io.StringIO object or the array +module:

    +
    >>> import io
    +>>> s = "Hello, world"
    +>>> sio = io.StringIO(s)
    +>>> sio.getvalue()
    +'Hello, world'
    +>>> sio.seek(7)
    +7
    +>>> sio.write("there!")
    +6
    +>>> sio.getvalue()
    +'Hello, there!'
    +
    +>>> import array
    +>>> a = array.array('u', s)
    +>>> print(a)
    +array('u', 'Hello, world')
    +>>> a[0] = 'y'
    +>>> print(a)
    +array('u', 'yello, world')
    +>>> a.tounicode()
    +'yello, world'
    +
    +
    +
    +
    +

    How do I use strings to call functions/methods?

    +

    There are various techniques.

    +
      +
    • The best is to use a dictionary that maps strings to functions. The primary +advantage of this technique is that the strings do not need to match the names +of the functions. This is also the primary technique used to emulate a case +construct:

      +
      def a():
      +    pass
      +
      +def b():
      +    pass
      +
      +dispatch = {'go': a, 'stop': b}  # Note lack of parens for funcs
      +
      +dispatch[get_input()]()  # Note trailing parens to call function
      +
      +
      +
    • +
    • Use the built-in function getattr():

      +
      import foo
      +getattr(foo, 'bar')()
      +
      +
      +

      Note that getattr() works on any object, including classes, class +instances, modules, and so on.

      +

      This is used in several places in the standard library, like this:

      +
      class Foo:
      +    def do_foo(self):
      +        ...
      +
      +    def do_bar(self):
      +        ...
      +
      +f = getattr(foo_instance, 'do_' + opname)
      +f()
      +
      +
      +
    • +
    • Use locals() or eval() to resolve the function name:

      +
      def myFunc():
      +    print("hello")
      +
      +fname = "myFunc"
      +
      +f = locals()[fname]
      +f()
      +
      +f = eval(fname)
      +f()
      +
      +
      +

      Note: Using eval() is slow and dangerous. If you don’t have absolute +control over the contents of the string, someone could pass a string that +resulted in an arbitrary function being executed.

      +
    • +
    +
    +
    +

    Is there an equivalent to Perl’s chomp() for removing trailing newlines from strings?

    +

    You can use S.rstrip("\r\n") to remove all occurrences of any line +terminator from the end of the string S without removing other trailing +whitespace. If the string S represents more than one line, with several +empty lines at the end, the line terminators for all the blank lines will +be removed:

    +
    >>> lines = ("line 1 \r\n"
    +...          "\r\n"
    +...          "\r\n")
    +>>> lines.rstrip("\n\r")
    +'line 1 '
    +
    +
    +

    Since this is typically only desired when reading text one line at a time, using +S.rstrip() this way works well.

    +
    +
    +

    Is there a scanf() or sscanf() equivalent?

    +

    Not as such.

    +

    For simple input parsing, the easiest approach is usually to split the line into +whitespace-delimited words using the split() method of string objects +and then convert decimal strings to numeric values using int() or +float(). split() supports an optional “sep” parameter which is useful +if the line uses something other than whitespace as a separator.

    +

    For more complicated input parsing, regular expressions are more powerful +than C’s sscanf() and better suited for the task.

    +
    + +
    +
    +

    Performance

    +
    +

    My program is too slow. How do I speed it up?

    +

    That’s a tough one, in general. First, here are a list of things to +remember before diving further:

    +
      +
    • Performance characteristics vary across Python implementations. This FAQ +focusses on CPython.

    • +
    • Behaviour can vary across operating systems, especially when talking about +I/O or multi-threading.

    • +
    • You should always find the hot spots in your program before attempting to +optimize any code (see the profile module).

    • +
    • Writing benchmark scripts will allow you to iterate quickly when searching +for improvements (see the timeit module).

    • +
    • It is highly recommended to have good code coverage (through unit testing +or any other technique) before potentially introducing regressions hidden +in sophisticated optimizations.

    • +
    +

    That being said, there are many tricks to speed up Python code. Here are +some general principles which go a long way towards reaching acceptable +performance levels:

    +
      +
    • Making your algorithms faster (or changing to faster ones) can yield +much larger benefits than trying to sprinkle micro-optimization tricks +all over your code.

    • +
    • Use the right data structures. Study documentation for the Built-in Types +and the collections module.

    • +
    • When the standard library provides a primitive for doing something, it is +likely (although not guaranteed) to be faster than any alternative you +may come up with. This is doubly true for primitives written in C, such +as builtins and some extension types. For example, be sure to use +either the list.sort() built-in method or the related sorted() +function to do sorting (and see the Sorting HOW TO for examples +of moderately advanced usage).

    • +
    • Abstractions tend to create indirections and force the interpreter to work +more. If the levels of indirection outweigh the amount of useful work +done, your program will be slower. You should avoid excessive abstraction, +especially under the form of tiny functions or methods (which are also often +detrimental to readability).

    • +
    +

    If you have reached the limit of what pure Python can allow, there are tools +to take you further away. For example, Cython can +compile a slightly modified version of Python code into a C extension, and +can be used on many different platforms. Cython can take advantage of +compilation (and optional type annotations) to make your code significantly +faster than when interpreted. If you are confident in your C programming +skills, you can also write a C extension module +yourself.

    +
    +

    See also

    +

    The wiki page devoted to performance tips.

    +
    +
    +
    +

    What is the most efficient way to concatenate many strings together?

    +

    str and bytes objects are immutable, therefore concatenating +many strings together is inefficient as each concatenation creates a new +object. In the general case, the total runtime cost is quadratic in the +total string length.

    +

    To accumulate many str objects, the recommended idiom is to place +them into a list and call str.join() at the end:

    +
    chunks = []
    +for s in my_strings:
    +    chunks.append(s)
    +result = ''.join(chunks)
    +
    +
    +

    (another reasonably efficient idiom is to use io.StringIO)

    +

    To accumulate many bytes objects, the recommended idiom is to extend +a bytearray object using in-place concatenation (the += operator):

    +
    result = bytearray()
    +for b in my_bytes_objects:
    +    result += b
    +
    +
    +
    +
    +
    +

    Sequences (Tuples/Lists)

    +
    +

    How do I convert between tuples and lists?

    +

    The type constructor tuple(seq) converts any sequence (actually, any +iterable) into a tuple with the same items in the same order.

    +

    For example, tuple([1, 2, 3]) yields (1, 2, 3) and tuple('abc') +yields ('a', 'b', 'c'). If the argument is a tuple, it does not make a copy +but returns the same object, so it is cheap to call tuple() when you +aren’t sure that an object is already a tuple.

    +

    The type constructor list(seq) converts any sequence or iterable into a list +with the same items in the same order. For example, list((1, 2, 3)) yields +[1, 2, 3] and list('abc') yields ['a', 'b', 'c']. If the argument +is a list, it makes a copy just like seq[:] would.

    +
    +
    +

    What’s a negative index?

    +

    Python sequences are indexed with positive numbers and negative numbers. For +positive numbers 0 is the first index 1 is the second index and so forth. For +negative indices -1 is the last index and -2 is the penultimate (next to last) +index and so forth. Think of seq[-n] as the same as seq[len(seq)-n].

    +

    Using negative indices can be very convenient. For example S[:-1] is all of +the string except for its last character, which is useful for removing the +trailing newline from a string.

    +
    +
    +

    How do I iterate over a sequence in reverse order?

    +

    Use the reversed() built-in function, which is new in Python 2.4:

    +
    for x in reversed(sequence):
    +    ...  # do something with x ...
    +
    +
    +

    This won’t touch your original sequence, but build a new copy with reversed +order to iterate over.

    +

    With Python 2.3, you can use an extended slice syntax:

    +
    for x in sequence[::-1]:
    +    ...  # do something with x ...
    +
    +
    +
    +
    +

    How do you remove duplicates from a list?

    +

    See the Python Cookbook for a long discussion of many ways to do this:

    +
    +
    +

    If you don’t mind reordering the list, sort it and then scan from the end of the +list, deleting duplicates as you go:

    +
    if mylist:
    +    mylist.sort()
    +    last = mylist[-1]
    +    for i in range(len(mylist)-2, -1, -1):
    +        if last == mylist[i]:
    +            del mylist[i]
    +        else:
    +            last = mylist[i]
    +
    +
    +

    If all elements of the list may be used as set keys (i.e. they are all +hashable) this is often faster

    +
    mylist = list(set(mylist))
    +
    +
    +

    This converts the list into a set, thereby removing duplicates, and then back +into a list.

    +
    +
    +

    How do you make an array in Python?

    +

    Use a list:

    +
    ["this", 1, "is", "an", "array"]
    +
    +
    +

    Lists are equivalent to C or Pascal arrays in their time complexity; the primary +difference is that a Python list can contain objects of many different types.

    +

    The array module also provides methods for creating arrays of fixed types +with compact representations, but they are slower to index than lists. Also +note that the Numeric extensions and others define array-like structures with +various characteristics as well.

    +

    To get Lisp-style linked lists, you can emulate cons cells using tuples:

    +
    lisp_list = ("like",  ("this",  ("example", None) ) )
    +
    +
    +

    If mutability is desired, you could use lists instead of tuples. Here the +analogue of lisp car is lisp_list[0] and the analogue of cdr is +lisp_list[1]. Only do this if you’re sure you really need to, because it’s +usually a lot slower than using Python lists.

    +
    +
    +

    How do I create a multidimensional list?

    +

    You probably tried to make a multidimensional array like this:

    +
    >>> A = [[None] * 2] * 3
    +
    +
    +

    This looks correct if you print it:

    +
    >>> A
    +[[None, None], [None, None], [None, None]]
    +
    +
    +

    But when you assign a value, it shows up in multiple places:

    +
    >>> A[0][0] = 5
    +>>> A
    +[[5, None], [5, None], [5, None]]
    +
    +
    +

    The reason is that replicating a list with * doesn’t create copies, it only +creates references to the existing objects. The *3 creates a list +containing 3 references to the same list of length two. Changes to one row will +show in all rows, which is almost certainly not what you want.

    +

    The suggested approach is to create a list of the desired length first and then +fill in each element with a newly created list:

    +
    A = [None] * 3
    +for i in range(3):
    +    A[i] = [None] * 2
    +
    +
    +

    This generates a list containing 3 different lists of length two. You can also +use a list comprehension:

    +
    w, h = 2, 3
    +A = [[None] * w for i in range(h)]
    +
    +
    +

    Or, you can use an extension that provides a matrix datatype; NumPy is the best known.

    +
    +
    +

    How do I apply a method to a sequence of objects?

    +

    Use a list comprehension:

    +
    result = [obj.method() for obj in mylist]
    +
    +
    +
    +
    +

    Why does a_tuple[i] += [‘item’] raise an exception when the addition works?

    +

    This is because of a combination of the fact that augmented assignment +operators are assignment operators, and the difference between mutable and +immutable objects in Python.

    +

    This discussion applies in general when augmented assignment operators are +applied to elements of a tuple that point to mutable objects, but we’ll use +a list and += as our exemplar.

    +

    If you wrote:

    +
    >>> a_tuple = (1, 2)
    +>>> a_tuple[0] += 1
    +Traceback (most recent call last):
    +   ...
    +TypeError: 'tuple' object does not support item assignment
    +
    +
    +

    The reason for the exception should be immediately clear: 1 is added to the +object a_tuple[0] points to (1), producing the result object, 2, +but when we attempt to assign the result of the computation, 2, to element +0 of the tuple, we get an error because we can’t change what an element of +a tuple points to.

    +

    Under the covers, what this augmented assignment statement is doing is +approximately this:

    +
    >>> result = a_tuple[0] + 1
    +>>> a_tuple[0] = result
    +Traceback (most recent call last):
    +  ...
    +TypeError: 'tuple' object does not support item assignment
    +
    +
    +

    It is the assignment part of the operation that produces the error, since a +tuple is immutable.

    +

    When you write something like:

    +
    >>> a_tuple = (['foo'], 'bar')
    +>>> a_tuple[0] += ['item']
    +Traceback (most recent call last):
    +  ...
    +TypeError: 'tuple' object does not support item assignment
    +
    +
    +

    The exception is a bit more surprising, and even more surprising is the fact +that even though there was an error, the append worked:

    +
    >>> a_tuple[0]
    +['foo', 'item']
    +
    +
    +

    To see why this happens, you need to know that (a) if an object implements an +__iadd__ magic method, it gets called when the += augmented assignment +is executed, and its return value is what gets used in the assignment statement; +and (b) for lists, __iadd__ is equivalent to calling extend on the list +and returning the list. That’s why we say that for lists, += is a +“shorthand” for list.extend:

    +
    >>> a_list = []
    +>>> a_list += [1]
    +>>> a_list
    +[1]
    +
    +
    +

    This is equivalent to:

    +
    >>> result = a_list.__iadd__([1])
    +>>> a_list = result
    +
    +
    +

    The object pointed to by a_list has been mutated, and the pointer to the +mutated object is assigned back to a_list. The end result of the +assignment is a no-op, since it is a pointer to the same object that a_list +was previously pointing to, but the assignment still happens.

    +

    Thus, in our tuple example what is happening is equivalent to:

    +
    >>> result = a_tuple[0].__iadd__(['item'])
    +>>> a_tuple[0] = result
    +Traceback (most recent call last):
    +  ...
    +TypeError: 'tuple' object does not support item assignment
    +
    +
    +

    The __iadd__ succeeds, and thus the list is extended, but even though +result points to the same object that a_tuple[0] already points to, +that final assignment still results in an error, because tuples are immutable.

    +
    +
    +

    I want to do a complicated sort: can you do a Schwartzian Transform in Python?

    +

    The technique, attributed to Randal Schwartz of the Perl community, sorts the +elements of a list by a metric which maps each element to its “sort value”. In +Python, use the key argument for the list.sort() method:

    +
    Isorted = L[:]
    +Isorted.sort(key=lambda s: int(s[10:15]))
    +
    +
    +
    +
    +

    How can I sort one list by values from another list?

    +

    Merge them into an iterator of tuples, sort the resulting list, and then pick +out the element you want.

    +
    >>> list1 = ["what", "I'm", "sorting", "by"]
    +>>> list2 = ["something", "else", "to", "sort"]
    +>>> pairs = zip(list1, list2)
    +>>> pairs = sorted(pairs)
    +>>> pairs
    +[("I'm", 'else'), ('by', 'sort'), ('sorting', 'to'), ('what', 'something')]
    +>>> result = [x[1] for x in pairs]
    +>>> result
    +['else', 'sort', 'to', 'something']
    +
    +
    +

    An alternative for the last step is:

    +
    >>> result = []
    +>>> for p in pairs: result.append(p[1])
    +
    +
    +

    If you find this more legible, you might prefer to use this instead of the final +list comprehension. However, it is almost twice as slow for long lists. Why? +First, the append() operation has to reallocate memory, and while it uses +some tricks to avoid doing that each time, it still has to do it occasionally, +and that costs quite a bit. Second, the expression “result.append” requires an +extra attribute lookup, and third, there’s a speed reduction from having to make +all those function calls.

    +
    +
    +
    +

    Objects

    +
    +

    What is a class?

    +

    A class is the particular object type created by executing a class statement. +Class objects are used as templates to create instance objects, which embody +both the data (attributes) and code (methods) specific to a datatype.

    +

    A class can be based on one or more other classes, called its base class(es). It +then inherits the attributes and methods of its base classes. This allows an +object model to be successively refined by inheritance. You might have a +generic Mailbox class that provides basic accessor methods for a mailbox, +and subclasses such as MboxMailbox, MaildirMailbox, OutlookMailbox +that handle various specific mailbox formats.

    +
    +
    +

    What is a method?

    +

    A method is a function on some object x that you normally call as +x.name(arguments...). Methods are defined as functions inside the class +definition:

    +
    class C:
    +    def meth(self, arg):
    +        return arg * 2 + self.attribute
    +
    +
    +
    +
    +

    What is self?

    +

    Self is merely a conventional name for the first argument of a method. A method +defined as meth(self, a, b, c) should be called as x.meth(a, b, c) for +some instance x of the class in which the definition occurs; the called +method will think it is called as meth(x, a, b, c).

    +

    See also Why must ‘self’ be used explicitly in method definitions and calls?.

    +
    +
    +

    How do I check if an object is an instance of a given class or of a subclass of it?

    +

    Use the built-in function isinstance(obj, cls). You can check if an object +is an instance of any of a number of classes by providing a tuple instead of a +single class, e.g. isinstance(obj, (class1, class2, ...)), and can also +check whether an object is one of Python’s built-in types, e.g. +isinstance(obj, str) or isinstance(obj, (int, float, complex)).

    +

    Note that most programs do not use isinstance() on user-defined classes +very often. If you are developing the classes yourself, a more proper +object-oriented style is to define methods on the classes that encapsulate a +particular behaviour, instead of checking the object’s class and doing a +different thing based on what class it is. For example, if you have a function +that does something:

    +
    def search(obj):
    +    if isinstance(obj, Mailbox):
    +        ...  # code to search a mailbox
    +    elif isinstance(obj, Document):
    +        ...  # code to search a document
    +    elif ...
    +
    +
    +

    A better approach is to define a search() method on all the classes and just +call it:

    +
    class Mailbox:
    +    def search(self):
    +        ...  # code to search a mailbox
    +
    +class Document:
    +    def search(self):
    +        ...  # code to search a document
    +
    +obj.search()
    +
    +
    +
    +
    +

    What is delegation?

    +

    Delegation is an object oriented technique (also called a design pattern). +Let’s say you have an object x and want to change the behaviour of just one +of its methods. You can create a new class that provides a new implementation +of the method you’re interested in changing and delegates all other methods to +the corresponding method of x.

    +

    Python programmers can easily implement delegation. For example, the following +class implements a class that behaves like a file but converts all written data +to uppercase:

    +
    class UpperOut:
    +
    +    def __init__(self, outfile):
    +        self._outfile = outfile
    +
    +    def write(self, s):
    +        self._outfile.write(s.upper())
    +
    +    def __getattr__(self, name):
    +        return getattr(self._outfile, name)
    +
    +
    +

    Here the UpperOut class redefines the write() method to convert the +argument string to uppercase before calling the underlying +self.__outfile.write() method. All other methods are delegated to the +underlying self.__outfile object. The delegation is accomplished via the +__getattr__ method; consult the language reference +for more information about controlling attribute access.

    +

    Note that for more general cases delegation can get trickier. When attributes +must be set as well as retrieved, the class must define a __setattr__() +method too, and it must do so carefully. The basic implementation of +__setattr__() is roughly equivalent to the following:

    +
    class X:
    +    ...
    +    def __setattr__(self, name, value):
    +        self.__dict__[name] = value
    +    ...
    +
    +
    +

    Most __setattr__() implementations must modify self.__dict__ to store +local state for self without causing an infinite recursion.

    +
    +
    +

    How do I call a method defined in a base class from a derived class that overrides it?

    +

    Use the built-in super() function:

    +
    class Derived(Base):
    +    def meth(self):
    +        super(Derived, self).meth()
    +
    +
    +

    For version prior to 3.0, you may be using classic classes: For a class +definition such as class Derived(Base): ... you can call method meth() +defined in Base (or one of Base’s base classes) as Base.meth(self, +arguments...). Here, Base.meth is an unbound method, so you need to +provide the self argument.

    +
    +
    +

    How can I organize my code to make it easier to change the base class?

    +

    You could define an alias for the base class, assign the real base class to it +before your class definition, and use the alias throughout your class. Then all +you have to change is the value assigned to the alias. Incidentally, this trick +is also handy if you want to decide dynamically (e.g. depending on availability +of resources) which base class to use. Example:

    +
    BaseAlias = <real base class>
    +
    +class Derived(BaseAlias):
    +    def meth(self):
    +        BaseAlias.meth(self)
    +        ...
    +
    +
    +
    +
    +

    How do I create static class data and static class methods?

    +

    Both static data and static methods (in the sense of C++ or Java) are supported +in Python.

    +

    For static data, simply define a class attribute. To assign a new value to the +attribute, you have to explicitly use the class name in the assignment:

    +
    class C:
    +    count = 0   # number of times C.__init__ called
    +
    +    def __init__(self):
    +        C.count = C.count + 1
    +
    +    def getcount(self):
    +        return C.count  # or return self.count
    +
    +
    +

    c.count also refers to C.count for any c such that isinstance(c, +C) holds, unless overridden by c itself or by some class on the base-class +search path from c.__class__ back to C.

    +

    Caution: within a method of C, an assignment like self.count = 42 creates a +new and unrelated instance named “count” in self’s own dict. Rebinding of a +class-static data name must always specify the class whether inside a method or +not:

    +
    C.count = 314
    +
    +
    +

    Static methods are possible:

    +
    class C:
    +    @staticmethod
    +    def static(arg1, arg2, arg3):
    +        # No 'self' parameter!
    +        ...
    +
    +
    +

    However, a far more straightforward way to get the effect of a static method is +via a simple module-level function:

    +
    def getcount():
    +    return C.count
    +
    +
    +

    If your code is structured so as to define one class (or tightly related class +hierarchy) per module, this supplies the desired encapsulation.

    +
    +
    +

    How can I overload constructors (or methods) in Python?

    +

    This answer actually applies to all methods, but the question usually comes up +first in the context of constructors.

    +

    In C++ you’d write

    +
    class C {
    +    C() { cout << "No arguments\n"; }
    +    C(int i) { cout << "Argument is " << i << "\n"; }
    +}
    +
    +
    +

    In Python you have to write a single constructor that catches all cases using +default arguments. For example:

    +
    class C:
    +    def __init__(self, i=None):
    +        if i is None:
    +            print("No arguments")
    +        else:
    +            print("Argument is", i)
    +
    +
    +

    This is not entirely equivalent, but close enough in practice.

    +

    You could also try a variable-length argument list, e.g.

    +
    def __init__(self, *args):
    +    ...
    +
    +
    +

    The same approach works for all method definitions.

    +
    +
    +

    I try to use __spam and I get an error about _SomeClassName__spam.

    +

    Variable names with double leading underscores are “mangled” to provide a simple +but effective way to define class private variables. Any identifier of the form +__spam (at least two leading underscores, at most one trailing underscore) +is textually replaced with _classname__spam, where classname is the +current class name with any leading underscores stripped.

    +

    This doesn’t guarantee privacy: an outside user can still deliberately access +the “_classname__spam” attribute, and private values are visible in the object’s +__dict__. Many Python programmers never bother to use private variable +names at all.

    +
    +
    +

    My class defines __del__ but it is not called when I delete the object.

    +

    There are several possible reasons for this.

    +

    The del statement does not necessarily call __del__() – it simply +decrements the object’s reference count, and if this reaches zero +__del__() is called.

    +

    If your data structures contain circular links (e.g. a tree where each child has +a parent reference and each parent has a list of children) the reference counts +will never go back to zero. Once in a while Python runs an algorithm to detect +such cycles, but the garbage collector might run some time after the last +reference to your data structure vanishes, so your __del__() method may be +called at an inconvenient and random time. This is inconvenient if you’re trying +to reproduce a problem. Worse, the order in which object’s __del__() +methods are executed is arbitrary. You can run gc.collect() to force a +collection, but there are pathological cases where objects will never be +collected.

    +

    Despite the cycle collector, it’s still a good idea to define an explicit +close() method on objects to be called whenever you’re done with them. The +close() method can then remove attributes that refer to subobjects. Don’t +call __del__() directly – __del__() should call close() and +close() should make sure that it can be called more than once for the same +object.

    +

    Another way to avoid cyclical references is to use the weakref module, +which allows you to point to objects without incrementing their reference count. +Tree data structures, for instance, should use weak references for their parent +and sibling references (if they need them!).

    +

    Finally, if your __del__() method raises an exception, a warning message +is printed to sys.stderr.

    +
    +
    +

    How do I get a list of all instances of a given class?

    +

    Python does not keep track of all instances of a class (or of a built-in type). +You can program the class’s constructor to keep track of all instances by +keeping a list of weak references to each instance.

    +
    +
    +

    Why does the result of id() appear to be not unique?

    +

    The id() builtin returns an integer that is guaranteed to be unique during +the lifetime of the object. Since in CPython, this is the object’s memory +address, it happens frequently that after an object is deleted from memory, the +next freshly created object is allocated at the same position in memory. This +is illustrated by this example:

    +
    >>> id(1000) # doctest: +SKIP
    +13901272
    +>>> id(2000) # doctest: +SKIP
    +13901272
    +
    +
    +

    The two ids belong to different integer objects that are created before, and +deleted immediately after execution of the id() call. To be sure that +objects whose id you want to examine are still alive, create another reference +to the object:

    +
    >>> a = 1000; b = 2000
    +>>> id(a) # doctest: +SKIP
    +13901272
    +>>> id(b) # doctest: +SKIP
    +13891296
    +
    +
    +
    +
    +
    +

    Modules

    +
    +

    How do I create a .pyc file?

    +

    When a module is imported for the first time (or when the source file has +changed since the current compiled file was created) a .pyc file containing +the compiled code should be created in a __pycache__ subdirectory of the +directory containing the .py file. The .pyc file will have a +filename that starts with the same name as the .py file, and ends with +.pyc, with a middle component that depends on the particular python +binary that created it. (See PEP 3147 for details.)

    +

    One reason that a .pyc file may not be created is a permissions problem +with the directory containing the source file, meaning that the __pycache__ +subdirectory cannot be created. This can happen, for example, if you develop as +one user but run as another, such as if you are testing with a web server.

    +

    Unless the PYTHONDONTWRITEBYTECODE environment variable is set, +creation of a .pyc file is automatic if you’re importing a module and Python +has the ability (permissions, free space, etc…) to create a __pycache__ +subdirectory and write the compiled module to that subdirectory.

    +

    Running Python on a top level script is not considered an import and no +.pyc will be created. For example, if you have a top-level module +foo.py that imports another module xyz.py, when you run foo (by +typing python foo.py as a shell command), a .pyc will be created for +xyz because xyz is imported, but no .pyc file will be created for +foo since foo.py isn’t being imported.

    +

    If you need to create a .pyc file for foo – that is, to create a +.pyc file for a module that is not imported – you can, using the +py_compile and compileall modules.

    +

    The py_compile module can manually compile any module. One way is to use +the compile() function in that module interactively:

    +
    >>> import py_compile
    +>>> py_compile.compile('foo.py')                 
    +
    +
    +

    This will write the .pyc to a __pycache__ subdirectory in the same +location as foo.py (or you can override that with the optional parameter +cfile).

    +

    You can also automatically compile all files in a directory or directories using +the compileall module. You can do it from the shell prompt by running +compileall.py and providing the path of a directory containing Python files +to compile:

    +
    python -m compileall .
    +
    +
    +
    +
    +

    How do I find the current module name?

    +

    A module can find out its own module name by looking at the predefined global +variable __name__. If this has the value '__main__', the program is +running as a script. Many modules that are usually used by importing them also +provide a command-line interface or a self-test, and only execute this code +after checking __name__:

    +
    def main():
    +    print('Running test...')
    +    ...
    +
    +if __name__ == '__main__':
    +    main()
    +
    +
    +
    +
    +

    How can I have modules that mutually import each other?

    +

    Suppose you have the following modules:

    +

    foo.py:

    +
    from bar import bar_var
    +foo_var = 1
    +
    +
    +

    bar.py:

    +
    from foo import foo_var
    +bar_var = 2
    +
    +
    +

    The problem is that the interpreter will perform the following steps:

    +
      +
    • main imports foo

    • +
    • Empty globals for foo are created

    • +
    • foo is compiled and starts executing

    • +
    • foo imports bar

    • +
    • Empty globals for bar are created

    • +
    • bar is compiled and starts executing

    • +
    • bar imports foo (which is a no-op since there already is a module named foo)

    • +
    • bar.foo_var = foo.foo_var

    • +
    +

    The last step fails, because Python isn’t done with interpreting foo yet and +the global symbol dictionary for foo is still empty.

    +

    The same thing happens when you use import foo, and then try to access +foo.foo_var in global code.

    +

    There are (at least) three possible workarounds for this problem.

    +

    Guido van Rossum recommends avoiding all uses of from <module> import ..., +and placing all code inside functions. Initializations of global variables and +class variables should use constants or built-in functions only. This means +everything from an imported module is referenced as <module>.<name>.

    +

    Jim Roskind suggests performing steps in the following order in each module:

    +
      +
    • exports (globals, functions, and classes that don’t need imported base +classes)

    • +
    • import statements

    • +
    • active code (including globals that are initialized from imported values).

    • +
    +

    van Rossum doesn’t like this approach much because the imports appear in a +strange place, but it does work.

    +

    Matthias Urlichs recommends restructuring your code so that the recursive import +is not necessary in the first place.

    +

    These solutions are not mutually exclusive.

    +
    +
    +

    __import__(‘x.y.z’) returns <module ‘x’>; how do I get z?

    +

    Consider using the convenience function import_module() from +importlib instead:

    +
    z = importlib.import_module('x.y.z')
    +
    +
    +
    +
    +

    When I edit an imported module and reimport it, the changes don’t show up. Why does this happen?

    +

    For reasons of efficiency as well as consistency, Python only reads the module +file on the first time a module is imported. If it didn’t, in a program +consisting of many modules where each one imports the same basic module, the +basic module would be parsed and re-parsed many times. To force re-reading of a +changed module, do this:

    +
    import importlib
    +import modname
    +importlib.reload(modname)
    +
    +
    +

    Warning: this technique is not 100% fool-proof. In particular, modules +containing statements like

    +
    from modname import some_objects
    +
    +
    +

    will continue to work with the old version of the imported objects. If the +module contains class definitions, existing class instances will not be +updated to use the new class definition. This can result in the following +paradoxical behaviour:

    +
    >>> import importlib
    +>>> import cls
    +>>> c = cls.C()                # Create an instance of C
    +>>> importlib.reload(cls)
    +<module 'cls' from 'cls.py'>
    +>>> isinstance(c, cls.C)       # isinstance is false?!?
    +False
    +
    +
    +

    The nature of the problem is made clear if you print out the “identity” of the +class objects:

    +
    >>> hex(id(c.__class__))
    +'0x7352a0'
    +>>> hex(id(cls.C))
    +'0x4198d0'
    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/faq/windows.html b/python-3.7.4-docs-html/faq/windows.html new file mode 100644 index 0000000..6eebbb5 --- /dev/null +++ b/python-3.7.4-docs-html/faq/windows.html @@ -0,0 +1,434 @@ + + + + + + + Python on Windows FAQ — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Python on Windows FAQ

    + +
    +

    How do I run a Python program under Windows?

    +

    This is not necessarily a straightforward question. If you are already familiar +with running programs from the Windows command line then everything will seem +obvious; otherwise, you might need a little more guidance.

    +

    Unless you use some sort of integrated development environment, you will end up +typing Windows commands into what is variously referred to as a “DOS window” +or “Command prompt window”. Usually you can create such a window from your +search bar by searching for cmd. You should be able to recognize +when you have started such a window because you will see a Windows “command +prompt”, which usually looks like this:

    +
    C:\>
    +
    +
    +

    The letter may be different, and there might be other things after it, so you +might just as easily see something like:

    +
    D:\YourName\Projects\Python>
    +
    +
    +

    depending on how your computer has been set up and what else you have recently +done with it. Once you have started such a window, you are well on the way to +running Python programs.

    +

    You need to realize that your Python scripts have to be processed by another +program called the Python interpreter. The interpreter reads your script, +compiles it into bytecodes, and then executes the bytecodes to run your +program. So, how do you arrange for the interpreter to handle your Python?

    +

    First, you need to make sure that your command window recognises the word +“py” as an instruction to start the interpreter. If you have opened a +command window, you should try entering the command py and hitting +return:

    +
    C:\Users\YourName> py
    +
    +
    +

    You should then see something like:

    +
    Python 3.6.4 (v3.6.4:d48eceb, Dec 19 2017, 06:04:45) [MSC v.1900 32 bit (Intel)] on win32
    +Type "help", "copyright", "credits" or "license" for more information.
    +>>>
    +
    +
    +

    You have started the interpreter in “interactive mode”. That means you can enter +Python statements or expressions interactively and have them executed or +evaluated while you wait. This is one of Python’s strongest features. Check it +by entering a few expressions of your choice and seeing the results:

    +
    >>> print("Hello")
    +Hello
    +>>> "Hello" * 3
    +'HelloHelloHello'
    +
    +
    +

    Many people use the interactive mode as a convenient yet highly programmable +calculator. When you want to end your interactive Python session, +call the exit() function or hold the Ctrl key down +while you enter a Z, then hit the “Enter” key to get +back to your Windows command prompt.

    +

    You may also find that you have a Start-menu entry such as Start +‣ Programs ‣ Python 3.x ‣ Python (command line) that results in you +seeing the >>> prompt in a new window. If so, the window will disappear +after you call the exit() function or enter the Ctrl-Z +character; Windows is running a single “python” +command in the window, and closes it when you terminate the interpreter.

    +

    Now that we know the py command is recognized, you can give your +Python script to it. You’ll have to give either an absolute or a +relative path to the Python script. Let’s say your Python script is +located in your desktop and is named hello.py, and your command +prompt is nicely opened in your home directory so you’re seeing something +similar to:

    +
    C:\Users\YourName>
    +
    +
    +

    So now you’ll ask the py command to give your script to Python by +typing py followed by your script path:

    +
    C:\Users\YourName> py Desktop\hello.py
    +hello
    +
    +
    +
    +
    +

    How do I make Python scripts executable?

    +

    On Windows, the standard Python installer already associates the .py +extension with a file type (Python.File) and gives that file type an open +command that runs the interpreter (D:\Program Files\Python\python.exe "%1" +%*). This is enough to make scripts executable from the command prompt as +‘foo.py’. If you’d rather be able to execute the script by simple typing ‘foo’ +with no extension you need to add .py to the PATHEXT environment variable.

    +
    +
    +

    Why does Python sometimes take so long to start?

    +

    Usually Python starts very quickly on Windows, but occasionally there are bug +reports that Python suddenly begins to take a long time to start up. This is +made even more puzzling because Python will work fine on other Windows systems +which appear to be configured identically.

    +

    The problem may be caused by a misconfiguration of virus checking software on +the problem machine. Some virus scanners have been known to introduce startup +overhead of two orders of magnitude when the scanner is configured to monitor +all reads from the filesystem. Try checking the configuration of virus scanning +software on your systems to ensure that they are indeed configured identically. +McAfee, when configured to scan all file system read activity, is a particular +offender.

    +
    +
    +

    How do I make an executable from a Python script?

    +

    See cx_Freeze for a distutils extension +that allows you to create console and GUI executables from Python code. +py2exe, the most popular extension for building +Python 2.x-based executables, does not yet support Python 3 but a version that +does is in development.

    +
    +
    +

    Is a *.pyd file the same as a DLL?

    +

    Yes, .pyd files are dll’s, but there are a few differences. If you have a DLL +named foo.pyd, then it must have a function PyInit_foo(). You can then +write Python “import foo”, and Python will search for foo.pyd (as well as +foo.py, foo.pyc) and if it finds it, will attempt to call PyInit_foo() to +initialize it. You do not link your .exe with foo.lib, as that would cause +Windows to require the DLL to be present.

    +

    Note that the search path for foo.pyd is PYTHONPATH, not the same as the path +that Windows uses to search for foo.dll. Also, foo.pyd need not be present to +run your program, whereas if you linked your program with a dll, the dll is +required. Of course, foo.pyd is required if you want to say import foo. In +a DLL, linkage is declared in the source code with __declspec(dllexport). +In a .pyd, linkage is defined in a list of available functions.

    +
    +
    +

    How can I embed Python into a Windows application?

    +

    Embedding the Python interpreter in a Windows app can be summarized as follows:

    +
      +
    1. Do _not_ build Python into your .exe file directly. On Windows, Python must +be a DLL to handle importing modules that are themselves DLL’s. (This is the +first key undocumented fact.) Instead, link to pythonNN.dll; it is +typically installed in C:\Windows\System. NN is the Python version, a +number such as “33” for Python 3.3.

      +

      You can link to Python in two different ways. Load-time linking means +linking against pythonNN.lib, while run-time linking means linking +against pythonNN.dll. (General note: pythonNN.lib is the +so-called “import lib” corresponding to pythonNN.dll. It merely +defines symbols for the linker.)

      +

      Run-time linking greatly simplifies link options; everything happens at run +time. Your code must load pythonNN.dll using the Windows +LoadLibraryEx() routine. The code must also use access routines and data +in pythonNN.dll (that is, Python’s C API’s) using pointers obtained +by the Windows GetProcAddress() routine. Macros can make using these +pointers transparent to any C code that calls routines in Python’s C API.

      +

      Borland note: convert pythonNN.lib to OMF format using Coff2Omf.exe +first.

      +
    2. +
    3. If you use SWIG, it is easy to create a Python “extension module” that will +make the app’s data and methods available to Python. SWIG will handle just +about all the grungy details for you. The result is C code that you link +into your .exe file (!) You do _not_ have to create a DLL file, and this +also simplifies linking.

    4. +
    5. SWIG will create an init function (a C function) whose name depends on the +name of the extension module. For example, if the name of the module is leo, +the init function will be called initleo(). If you use SWIG shadow classes, +as you should, the init function will be called initleoc(). This initializes +a mostly hidden helper class used by the shadow class.

      +

      The reason you can link the C code in step 2 into your .exe file is that +calling the initialization function is equivalent to importing the module +into Python! (This is the second key undocumented fact.)

      +
    6. +
    7. In short, you can use the following code to initialize the Python interpreter +with your extension module.

      +
      #include "python.h"
      +...
      +Py_Initialize();  // Initialize Python.
      +initmyAppc();  // Initialize (import) the helper class.
      +PyRun_SimpleString("import myApp");  // Import the shadow class.
      +
      +
      +
    8. +
    9. There are two problems with Python’s C API which will become apparent if you +use a compiler other than MSVC, the compiler used to build pythonNN.dll.

      +

      Problem 1: The so-called “Very High Level” functions that take FILE * +arguments will not work in a multi-compiler environment because each +compiler’s notion of a struct FILE will be different. From an implementation +standpoint these are very _low_ level functions.

      +

      Problem 2: SWIG generates the following code when generating wrappers to void +functions:

      +
      Py_INCREF(Py_None);
      +_resultobj = Py_None;
      +return _resultobj;
      +
      +
      +

      Alas, Py_None is a macro that expands to a reference to a complex data +structure called _Py_NoneStruct inside pythonNN.dll. Again, this code will +fail in a mult-compiler environment. Replace such code by:

      +
      return Py_BuildValue("");
      +
      +
      +

      It may be possible to use SWIG’s %typemap command to make the change +automatically, though I have not been able to get this to work (I’m a +complete SWIG newbie).

      +
    10. +
    11. Using a Python shell script to put up a Python interpreter window from inside +your Windows app is not a good idea; the resulting window will be independent +of your app’s windowing system. Rather, you (or the wxPythonWindow class) +should create a “native” interpreter window. It is easy to connect that +window to the Python interpreter. You can redirect Python’s i/o to _any_ +object that supports read and write, so all you need is a Python object +(defined in your extension module) that contains read() and write() methods.

    12. +
    +
    +
    +

    How do I keep editors from inserting tabs into my Python source?

    +

    The FAQ does not recommend using tabs, and the Python style guide, PEP 8, +recommends 4 spaces for distributed Python code; this is also the Emacs +python-mode default.

    +

    Under any editor, mixing tabs and spaces is a bad idea. MSVC is no different in +this respect, and is easily configured to use spaces: Take Tools +‣ Options ‣ Tabs, and for file type “Default” set “Tab size” and “Indent +size” to 4, and select the “Insert spaces” radio button.

    +

    Python raises IndentationError or TabError if mixed tabs +and spaces are causing problems in leading whitespace. +You may also run the tabnanny module to check a directory tree +in batch mode.

    +
    +
    +

    How do I check for a keypress without blocking?

    +

    Use the msvcrt module. This is a standard Windows-specific extension module. +It defines a function kbhit() which checks whether a keyboard hit is +present, and getch() which gets one character without echoing it.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-A.html b/python-3.7.4-docs-html/genindex-A.html new file mode 100644 index 0000000..0ee9aef --- /dev/null +++ b/python-3.7.4-docs-html/genindex-A.html @@ -0,0 +1,1315 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – A

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-B.html b/python-3.7.4-docs-html/genindex-B.html new file mode 100644 index 0000000..e8b8aee --- /dev/null +++ b/python-3.7.4-docs-html/genindex-B.html @@ -0,0 +1,948 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – B

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-C.html b/python-3.7.4-docs-html/genindex-C.html new file mode 100644 index 0000000..5884b64 --- /dev/null +++ b/python-3.7.4-docs-html/genindex-C.html @@ -0,0 +1,2327 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – C

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-D.html b/python-3.7.4-docs-html/genindex-D.html new file mode 100644 index 0000000..8ce6308 --- /dev/null +++ b/python-3.7.4-docs-html/genindex-D.html @@ -0,0 +1,1301 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – D

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-E.html b/python-3.7.4-docs-html/genindex-E.html new file mode 100644 index 0000000..4a4cdc9 --- /dev/null +++ b/python-3.7.4-docs-html/genindex-E.html @@ -0,0 +1,1639 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – E

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-F.html b/python-3.7.4-docs-html/genindex-F.html new file mode 100644 index 0000000..0b22481 --- /dev/null +++ b/python-3.7.4-docs-html/genindex-F.html @@ -0,0 +1,1345 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – F

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-G.html b/python-3.7.4-docs-html/genindex-G.html new file mode 100644 index 0000000..284672e --- /dev/null +++ b/python-3.7.4-docs-html/genindex-G.html @@ -0,0 +1,1598 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – G

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-H.html b/python-3.7.4-docs-html/genindex-H.html new file mode 100644 index 0000000..e5173f8 --- /dev/null +++ b/python-3.7.4-docs-html/genindex-H.html @@ -0,0 +1,777 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – H

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-I.html b/python-3.7.4-docs-html/genindex-I.html new file mode 100644 index 0000000..27005ec --- /dev/null +++ b/python-3.7.4-docs-html/genindex-I.html @@ -0,0 +1,1777 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – I

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-J.html b/python-3.7.4-docs-html/genindex-J.html new file mode 100644 index 0000000..01f717a --- /dev/null +++ b/python-3.7.4-docs-html/genindex-J.html @@ -0,0 +1,251 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-K.html b/python-3.7.4-docs-html/genindex-K.html new file mode 100644 index 0000000..522f42b --- /dev/null +++ b/python-3.7.4-docs-html/genindex-K.html @@ -0,0 +1,293 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – K

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-L.html b/python-3.7.4-docs-html/genindex-L.html new file mode 100644 index 0000000..4ffba4d --- /dev/null +++ b/python-3.7.4-docs-html/genindex-L.html @@ -0,0 +1,956 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – L

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-M.html b/python-3.7.4-docs-html/genindex-M.html new file mode 100644 index 0000000..e7e0084 --- /dev/null +++ b/python-3.7.4-docs-html/genindex-M.html @@ -0,0 +1,1203 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – M

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-N.html b/python-3.7.4-docs-html/genindex-N.html new file mode 100644 index 0000000..5565da5 --- /dev/null +++ b/python-3.7.4-docs-html/genindex-N.html @@ -0,0 +1,782 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – N

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-O.html b/python-3.7.4-docs-html/genindex-O.html new file mode 100644 index 0000000..2c495a7 --- /dev/null +++ b/python-3.7.4-docs-html/genindex-O.html @@ -0,0 +1,867 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – O

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-P.html b/python-3.7.4-docs-html/genindex-P.html new file mode 100644 index 0000000..a43ad15 --- /dev/null +++ b/python-3.7.4-docs-html/genindex-P.html @@ -0,0 +1,4592 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – P

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-Q.html b/python-3.7.4-docs-html/genindex-Q.html new file mode 100644 index 0000000..df4be59 --- /dev/null +++ b/python-3.7.4-docs-html/genindex-Q.html @@ -0,0 +1,264 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – Q

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-R.html b/python-3.7.4-docs-html/genindex-R.html new file mode 100644 index 0000000..07d14ae --- /dev/null +++ b/python-3.7.4-docs-html/genindex-R.html @@ -0,0 +1,1882 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – R

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-S.html b/python-3.7.4-docs-html/genindex-S.html new file mode 100644 index 0000000..7d62df0 --- /dev/null +++ b/python-3.7.4-docs-html/genindex-S.html @@ -0,0 +1,2999 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – S

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-Symbols.html b/python-3.7.4-docs-html/genindex-Symbols.html new file mode 100644 index 0000000..6b972d9 --- /dev/null +++ b/python-3.7.4-docs-html/genindex-Symbols.html @@ -0,0 +1,1723 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – Symbols

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-T.html b/python-3.7.4-docs-html/genindex-T.html new file mode 100644 index 0000000..533d8b2 --- /dev/null +++ b/python-3.7.4-docs-html/genindex-T.html @@ -0,0 +1,1249 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – T

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-U.html b/python-3.7.4-docs-html/genindex-U.html new file mode 100644 index 0000000..29d7a46 --- /dev/null +++ b/python-3.7.4-docs-html/genindex-U.html @@ -0,0 +1,838 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – U

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-V.html b/python-3.7.4-docs-html/genindex-V.html new file mode 100644 index 0000000..aee4f91 --- /dev/null +++ b/python-3.7.4-docs-html/genindex-V.html @@ -0,0 +1,363 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – V

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-W.html b/python-3.7.4-docs-html/genindex-W.html new file mode 100644 index 0000000..a9c0ced --- /dev/null +++ b/python-3.7.4-docs-html/genindex-W.html @@ -0,0 +1,642 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – W

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-X.html b/python-3.7.4-docs-html/genindex-X.html new file mode 100644 index 0000000..c712cc8 --- /dev/null +++ b/python-3.7.4-docs-html/genindex-X.html @@ -0,0 +1,326 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – X

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-Y.html b/python-3.7.4-docs-html/genindex-Y.html new file mode 100644 index 0000000..4a94e3c --- /dev/null +++ b/python-3.7.4-docs-html/genindex-Y.html @@ -0,0 +1,200 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-Z.html b/python-3.7.4-docs-html/genindex-Z.html new file mode 100644 index 0000000..cbd740f --- /dev/null +++ b/python-3.7.4-docs-html/genindex-Z.html @@ -0,0 +1,243 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-_.html b/python-3.7.4-docs-html/genindex-_.html new file mode 100644 index 0000000..314aabd --- /dev/null +++ b/python-3.7.4-docs-html/genindex-_.html @@ -0,0 +1,1090 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index – _

    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex-all.html b/python-3.7.4-docs-html/genindex-all.html new file mode 100644 index 0000000..3f4fb0e --- /dev/null +++ b/python-3.7.4-docs-html/genindex-all.html @@ -0,0 +1,29854 @@ + + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index

    + +
    + Symbols + | _ + | A + | B + | C + | D + | E + | F + | G + | H + | I + | J + | K + | L + | M + | N + | O + | P + | Q + | R + | S + | T + | U + | V + | W + | X + | Y + | Z + +
    +

    Symbols

    + + + +
    + +

    _

    + + + +
    + +

    A

    + + + +
    + +

    B

    + + + +
    + +

    C

    + + + +
    + +

    D

    + + + +
    + +

    E

    + + + +
    + +

    F

    + + + +
    + +

    G

    + + + +
    + +

    H

    + + + +
    + +

    I

    + + + +
    + +

    J

    + + + +
    + +

    K

    + + + +
    + +

    L

    + + + +
    + +

    M

    + + + +
    + +

    N

    + + + +
    + +

    O

    + + + +
    + +

    P

    + + + +
    + +

    Q

    + + + +
    + +

    R

    + + + +
    + +

    S

    + + + +
    + +

    T

    + + + +
    + +

    U

    + + + +
    + +

    V

    + + + +
    + +

    W

    + + + +
    + +

    X

    + + + +
    + +

    Y

    + + + +
    + +

    Z

    + + + +
    + + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/genindex.html b/python-3.7.4-docs-html/genindex.html new file mode 100644 index 0000000..40d1ff5 --- /dev/null +++ b/python-3.7.4-docs-html/genindex.html @@ -0,0 +1,184 @@ + + + + + + + Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Index

    + +

    Index pages by letter:

    + +
    +

    Symbols + | _ + | A + | B + | C + | D + | E + | F + | G + | H + | I + | J + | K + | L + | M + | N + | O + | P + | Q + | R + | S + | T + | U + | V + | W + | X + | Y + | Z +

    + +

    Full index on one page + (can be huge)

    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/glossary.html b/python-3.7.4-docs-html/glossary.html new file mode 100644 index 0000000..c5c41de --- /dev/null +++ b/python-3.7.4-docs-html/glossary.html @@ -0,0 +1,1132 @@ + + + + + + + Glossary — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Glossary

    +
    +
    >>>

    The default Python prompt of the interactive shell. Often seen for code +examples which can be executed interactively in the interpreter.

    +
    +
    ...

    The default Python prompt of the interactive shell when entering the +code for an indented code block, when within a pair of matching left and +right delimiters (parentheses, square brackets, curly braces or triple +quotes), or after specifying a decorator.

    +
    +
    2to3

    A tool that tries to convert Python 2.x code to Python 3.x code by +handling most of the incompatibilities which can be detected by parsing the +source and traversing the parse tree.

    +

    2to3 is available in the standard library as lib2to3; a standalone +entry point is provided as Tools/scripts/2to3. See +2to3 - Automated Python 2 to 3 code translation.

    +
    +
    abstract base class

    Abstract base classes complement duck-typing by +providing a way to define interfaces when other techniques like +hasattr() would be clumsy or subtly wrong (for example with +magic methods). ABCs introduce virtual +subclasses, which are classes that don’t inherit from a class but are +still recognized by isinstance() and issubclass(); see the +abc module documentation. Python comes with many built-in ABCs for +data structures (in the collections.abc module), numbers (in the +numbers module), streams (in the io module), import finders +and loaders (in the importlib.abc module). You can create your own +ABCs with the abc module.

    +
    +
    annotation

    A label associated with a variable, a class +attribute or a function parameter or return value, +used by convention as a type hint.

    +

    Annotations of local variables cannot be accessed at runtime, but +annotations of global variables, class attributes, and functions +are stored in the __annotations__ +special attribute of modules, classes, and functions, +respectively.

    +

    See variable annotation, function annotation, PEP 484 +and PEP 526, which describe this functionality.

    +
    +
    argument

    A value passed to a function (or method) when calling the +function. There are two kinds of argument:

    +
      +
    • keyword argument: an argument preceded by an identifier (e.g. +name=) in a function call or passed as a value in a dictionary +preceded by **. For example, 3 and 5 are both keyword +arguments in the following calls to complex():

      +
      complex(real=3, imag=5)
      +complex(**{'real': 3, 'imag': 5})
      +
      +
      +
    • +
    • positional argument: an argument that is not a keyword argument. +Positional arguments can appear at the beginning of an argument list +and/or be passed as elements of an iterable preceded by *. +For example, 3 and 5 are both positional arguments in the +following calls:

      +
      complex(3, 5)
      +complex(*(3, 5))
      +
      +
      +
    • +
    +

    Arguments are assigned to the named local variables in a function body. +See the Calls section for the rules governing this assignment. +Syntactically, any expression can be used to represent an argument; the +evaluated value is assigned to the local variable.

    +

    See also the parameter glossary entry, the FAQ question on +the difference between arguments and parameters, and PEP 362.

    +
    +
    asynchronous context manager

    An object which controls the environment seen in an +async with statement by defining __aenter__() and +__aexit__() methods. Introduced by PEP 492.

    +
    +
    asynchronous generator

    A function which returns an asynchronous generator iterator. It +looks like a coroutine function defined with async def except +that it contains yield expressions for producing a series of +values usable in an async for loop.

    +

    Usually refers to an asynchronous generator function, but may refer to an +asynchronous generator iterator in some contexts. In cases where the +intended meaning isn’t clear, using the full terms avoids ambiguity.

    +

    An asynchronous generator function may contain await +expressions as well as async for, and async with +statements.

    +
    +
    asynchronous generator iterator

    An object created by a asynchronous generator function.

    +

    This is an asynchronous iterator which when called using the +__anext__() method returns an awaitable object which will execute +the body of the asynchronous generator function until the next +yield expression.

    +

    Each yield temporarily suspends processing, remembering the +location execution state (including local variables and pending +try-statements). When the asynchronous generator iterator effectively +resumes with another awaitable returned by __anext__(), it +picks up where it left off. See PEP 492 and PEP 525.

    +
    +
    asynchronous iterable

    An object, that can be used in an async for statement. +Must return an asynchronous iterator from its +__aiter__() method. Introduced by PEP 492.

    +
    +
    asynchronous iterator

    An object that implements the __aiter__() and __anext__() +methods. __anext__ must return an awaitable object. +async for resolves the awaitables returned by an asynchronous +iterator’s __anext__() method until it raises a +StopAsyncIteration exception. Introduced by PEP 492.

    +
    +
    attribute

    A value associated with an object which is referenced by name using +dotted expressions. For example, if an object o has an attribute +a it would be referenced as o.a.

    +
    +
    awaitable

    An object that can be used in an await expression. Can be +a coroutine or an object with an __await__() method. +See also PEP 492.

    +
    +
    BDFL

    Benevolent Dictator For Life, a.k.a. Guido van Rossum, Python’s creator.

    +
    +
    binary file

    A file object able to read and write +bytes-like objects. +Examples of binary files are files opened in binary mode ('rb', +'wb' or 'rb+'), sys.stdin.buffer, +sys.stdout.buffer, and instances of io.BytesIO and +gzip.GzipFile.

    +

    See also text file for a file object able to read and write +str objects.

    +
    +
    bytes-like object

    An object that supports the Buffer Protocol and can +export a C-contiguous buffer. This includes all bytes, +bytearray, and array.array objects, as well as many +common memoryview objects. Bytes-like objects can +be used for various operations that work with binary data; these include +compression, saving to a binary file, and sending over a socket.

    +

    Some operations need the binary data to be mutable. The documentation +often refers to these as “read-write bytes-like objects”. Example +mutable buffer objects include bytearray and a +memoryview of a bytearray. +Other operations require the binary data to be stored in +immutable objects (“read-only bytes-like objects”); examples +of these include bytes and a memoryview +of a bytes object.

    +
    +
    bytecode

    Python source code is compiled into bytecode, the internal representation +of a Python program in the CPython interpreter. The bytecode is also +cached in .pyc files so that executing the same file is +faster the second time (recompilation from source to bytecode can be +avoided). This “intermediate language” is said to run on a +virtual machine that executes the machine code corresponding to +each bytecode. Do note that bytecodes are not expected to work between +different Python virtual machines, nor to be stable between Python +releases.

    +

    A list of bytecode instructions can be found in the documentation for +the dis module.

    +
    +
    class

    A template for creating user-defined objects. Class definitions +normally contain method definitions which operate on instances of the +class.

    +
    +
    class variable

    A variable defined in a class and intended to be modified only at +class level (i.e., not in an instance of the class).

    +
    +
    coercion

    The implicit conversion of an instance of one type to another during an +operation which involves two arguments of the same type. For example, +int(3.15) converts the floating point number to the integer 3, but +in 3+4.5, each argument is of a different type (one int, one float), +and both must be converted to the same type before they can be added or it +will raise a TypeError. Without coercion, all arguments of even +compatible types would have to be normalized to the same value by the +programmer, e.g., float(3)+4.5 rather than just 3+4.5.

    +
    +
    complex number

    An extension of the familiar real number system in which all numbers are +expressed as a sum of a real part and an imaginary part. Imaginary +numbers are real multiples of the imaginary unit (the square root of +-1), often written i in mathematics or j in +engineering. Python has built-in support for complex numbers, which are +written with this latter notation; the imaginary part is written with a +j suffix, e.g., 3+1j. To get access to complex equivalents of the +math module, use cmath. Use of complex numbers is a fairly +advanced mathematical feature. If you’re not aware of a need for them, +it’s almost certain you can safely ignore them.

    +
    +
    context manager

    An object which controls the environment seen in a with +statement by defining __enter__() and __exit__() methods. +See PEP 343.

    +
    +
    context variable

    A variable which can have different values depending on its context. +This is similar to Thread-Local Storage in which each execution +thread may have a different value for a variable. However, with context +variables, there may be several contexts in one execution thread and the +main usage for context variables is to keep track of variables in +concurrent asynchronous tasks. +See contextvars.

    +
    +
    contiguous

    A buffer is considered contiguous exactly if it is either +C-contiguous or Fortran contiguous. Zero-dimensional buffers are +C and Fortran contiguous. In one-dimensional arrays, the items +must be laid out in memory next to each other, in order of +increasing indexes starting from zero. In multidimensional +C-contiguous arrays, the last index varies the fastest when +visiting items in order of memory address. However, in +Fortran contiguous arrays, the first index varies the fastest.

    +
    +
    coroutine

    Coroutines is a more generalized form of subroutines. Subroutines are +entered at one point and exited at another point. Coroutines can be +entered, exited, and resumed at many different points. They can be +implemented with the async def statement. See also +PEP 492.

    +
    +
    coroutine function

    A function which returns a coroutine object. A coroutine +function may be defined with the async def statement, +and may contain await, async for, and +async with keywords. These were introduced +by PEP 492.

    +
    +
    CPython

    The canonical implementation of the Python programming language, as +distributed on python.org. The term “CPython” +is used when necessary to distinguish this implementation from others +such as Jython or IronPython.

    +
    +
    decorator

    A function returning another function, usually applied as a function +transformation using the @wrapper syntax. Common examples for +decorators are classmethod() and staticmethod().

    +

    The decorator syntax is merely syntactic sugar, the following two +function definitions are semantically equivalent:

    +
    def f(...):
    +    ...
    +f = staticmethod(f)
    +
    +@staticmethod
    +def f(...):
    +    ...
    +
    +
    +

    The same concept exists for classes, but is less commonly used there. See +the documentation for function definitions and +class definitions for more about decorators.

    +
    +
    descriptor

    Any object which defines the methods __get__(), __set__(), or +__delete__(). When a class attribute is a descriptor, its special +binding behavior is triggered upon attribute lookup. Normally, using +a.b to get, set or delete an attribute looks up the object named b in +the class dictionary for a, but if b is a descriptor, the respective +descriptor method gets called. Understanding descriptors is a key to a +deep understanding of Python because they are the basis for many features +including functions, methods, properties, class methods, static methods, +and reference to super classes.

    +

    For more information about descriptors’ methods, see Implementing Descriptors.

    +
    +
    dictionary

    An associative array, where arbitrary keys are mapped to values. The +keys can be any object with __hash__() and __eq__() methods. +Called a hash in Perl.

    +
    +
    dictionary view

    The objects returned from dict.keys(), dict.values(), and +dict.items() are called dictionary views. They provide a dynamic +view on the dictionary’s entries, which means that when the dictionary +changes, the view reflects these changes. To force the +dictionary view to become a full list use list(dictview). See +Dictionary view objects.

    +
    +
    docstring

    A string literal which appears as the first expression in a class, +function or module. While ignored when the suite is executed, it is +recognized by the compiler and put into the __doc__ attribute +of the enclosing class, function or module. Since it is available via +introspection, it is the canonical place for documentation of the +object.

    +
    +
    duck-typing

    A programming style which does not look at an object’s type to determine +if it has the right interface; instead, the method or attribute is simply +called or used (“If it looks like a duck and quacks like a duck, it +must be a duck.”) By emphasizing interfaces rather than specific types, +well-designed code improves its flexibility by allowing polymorphic +substitution. Duck-typing avoids tests using type() or +isinstance(). (Note, however, that duck-typing can be complemented +with abstract base classes.) Instead, it +typically employs hasattr() tests or EAFP programming.

    +
    +
    EAFP

    Easier to ask for forgiveness than permission. This common Python coding +style assumes the existence of valid keys or attributes and catches +exceptions if the assumption proves false. This clean and fast style is +characterized by the presence of many try and except +statements. The technique contrasts with the LBYL style +common to many other languages such as C.

    +
    +
    expression

    A piece of syntax which can be evaluated to some value. In other words, +an expression is an accumulation of expression elements like literals, +names, attribute access, operators or function calls which all return a +value. In contrast to many other languages, not all language constructs +are expressions. There are also statements which cannot be used +as expressions, such as while. Assignments are also statements, +not expressions.

    +
    +
    extension module

    A module written in C or C++, using Python’s C API to interact with the +core and with user code.

    +
    +
    f-string

    String literals prefixed with 'f' or 'F' are commonly called +“f-strings” which is short for +formatted string literals. See also PEP 498.

    +
    +
    file object

    An object exposing a file-oriented API (with methods such as +read() or write()) to an underlying resource. Depending +on the way it was created, a file object can mediate access to a real +on-disk file or to another type of storage or communication device +(for example standard input/output, in-memory buffers, sockets, pipes, +etc.). File objects are also called file-like objects or +streams.

    +

    There are actually three categories of file objects: raw +binary files, buffered +binary files and text files. +Their interfaces are defined in the io module. The canonical +way to create a file object is by using the open() function.

    +
    +
    file-like object

    A synonym for file object.

    +
    +
    finder

    An object that tries to find the loader for a module that is +being imported.

    +

    Since Python 3.3, there are two types of finder: meta path finders for use with sys.meta_path, and path +entry finders for use with sys.path_hooks.

    +

    See PEP 302, PEP 420 and PEP 451 for much more detail.

    +
    +
    floor division

    Mathematical division that rounds down to nearest integer. The floor +division operator is //. For example, the expression 11 // 4 +evaluates to 2 in contrast to the 2.75 returned by float true +division. Note that (-11) // 4 is -3 because that is -2.75 +rounded downward. See PEP 238.

    +
    +
    function

    A series of statements which returns some value to a caller. It can also +be passed zero or more arguments which may be used in +the execution of the body. See also parameter, method, +and the Function definitions section.

    +
    +
    function annotation

    An annotation of a function parameter or return value.

    +

    Function annotations are usually used for +type hints: for example, this function is expected to take two +int arguments and is also expected to have an int +return value:

    +
    def sum_two_numbers(a: int, b: int) -> int:
    +   return a + b
    +
    +
    +

    Function annotation syntax is explained in section Function definitions.

    +

    See variable annotation and PEP 484, +which describe this functionality.

    +
    +
    __future__

    A pseudo-module which programmers can use to enable new language features +which are not compatible with the current interpreter.

    +

    By importing the __future__ module and evaluating its variables, +you can see when a new feature was first added to the language and when it +becomes the default:

    +
    >>> import __future__
    +>>> __future__.division
    +_Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
    +
    +
    +
    +
    garbage collection

    The process of freeing memory when it is not used anymore. Python +performs garbage collection via reference counting and a cyclic garbage +collector that is able to detect and break reference cycles. The +garbage collector can be controlled using the gc module.

    +
    +
    generator

    A function which returns a generator iterator. It looks like a +normal function except that it contains yield expressions +for producing a series of values usable in a for-loop or that can be +retrieved one at a time with the next() function.

    +

    Usually refers to a generator function, but may refer to a +generator iterator in some contexts. In cases where the intended +meaning isn’t clear, using the full terms avoids ambiguity.

    +
    +
    generator iterator

    An object created by a generator function.

    +

    Each yield temporarily suspends processing, remembering the +location execution state (including local variables and pending +try-statements). When the generator iterator resumes, it picks up where +it left off (in contrast to functions which start fresh on every +invocation).

    +
    +
    generator expression

    An expression that returns an iterator. It looks like a normal expression +followed by a for clause defining a loop variable, range, +and an optional if clause. The combined expression +generates values for an enclosing function:

    +
    >>> sum(i*i for i in range(10))         # sum of squares 0, 1, 4, ... 81
    +285
    +
    +
    +
    +
    generic function

    A function composed of multiple functions implementing the same operation +for different types. Which implementation should be used during a call is +determined by the dispatch algorithm.

    +

    See also the single dispatch glossary entry, the +functools.singledispatch() decorator, and PEP 443.

    +
    +
    GIL

    See global interpreter lock.

    +
    +
    global interpreter lock

    The mechanism used by the CPython interpreter to assure that +only one thread executes Python bytecode at a time. +This simplifies the CPython implementation by making the object model +(including critical built-in types such as dict) implicitly +safe against concurrent access. Locking the entire interpreter +makes it easier for the interpreter to be multi-threaded, at the +expense of much of the parallelism afforded by multi-processor +machines.

    +

    However, some extension modules, either standard or third-party, +are designed so as to release the GIL when doing computationally-intensive +tasks such as compression or hashing. Also, the GIL is always released +when doing I/O.

    +

    Past efforts to create a “free-threaded” interpreter (one which locks +shared data at a much finer granularity) have not been successful +because performance suffered in the common single-processor case. It +is believed that overcoming this performance issue would make the +implementation much more complicated and therefore costlier to maintain.

    +
    +
    hash-based pyc

    A bytecode cache file that uses the hash rather than the last-modified +time of the corresponding source file to determine its validity. See +Cached bytecode invalidation.

    +
    +
    hashable

    An object is hashable if it has a hash value which never changes during +its lifetime (it needs a __hash__() method), and can be compared to +other objects (it needs an __eq__() method). Hashable objects which +compare equal must have the same hash value.

    +

    Hashability makes an object usable as a dictionary key and a set member, +because these data structures use the hash value internally.

    +

    Most of Python’s immutable built-in objects are hashable; mutable +containers (such as lists or dictionaries) are not; immutable +containers (such as tuples and frozensets) are only hashable if +their elements are hashable. Objects which are +instances of user-defined classes are hashable by default. They all +compare unequal (except with themselves), and their hash value is derived +from their id().

    +
    +
    IDLE

    An Integrated Development Environment for Python. IDLE is a basic editor +and interpreter environment which ships with the standard distribution of +Python.

    +
    +
    immutable

    An object with a fixed value. Immutable objects include numbers, strings and +tuples. Such an object cannot be altered. A new object has to +be created if a different value has to be stored. They play an important +role in places where a constant hash value is needed, for example as a key +in a dictionary.

    +
    +
    import path

    A list of locations (or path entries) that are +searched by the path based finder for modules to import. During +import, this list of locations usually comes from sys.path, but +for subpackages it may also come from the parent package’s __path__ +attribute.

    +
    +
    importing

    The process by which Python code in one module is made available to +Python code in another module.

    +
    +
    importer

    An object that both finds and loads a module; both a +finder and loader object.

    +
    +
    interactive

    Python has an interactive interpreter which means you can enter +statements and expressions at the interpreter prompt, immediately +execute them and see their results. Just launch python with no +arguments (possibly by selecting it from your computer’s main +menu). It is a very powerful way to test out new ideas or inspect +modules and packages (remember help(x)).

    +
    +
    interpreted

    Python is an interpreted language, as opposed to a compiled one, +though the distinction can be blurry because of the presence of the +bytecode compiler. This means that source files can be run directly +without explicitly creating an executable which is then run. +Interpreted languages typically have a shorter development/debug cycle +than compiled ones, though their programs generally also run more +slowly. See also interactive.

    +
    +
    interpreter shutdown

    When asked to shut down, the Python interpreter enters a special phase +where it gradually releases all allocated resources, such as modules +and various critical internal structures. It also makes several calls +to the garbage collector. This can trigger +the execution of code in user-defined destructors or weakref callbacks. +Code executed during the shutdown phase can encounter various +exceptions as the resources it relies on may not function anymore +(common examples are library modules or the warnings machinery).

    +

    The main reason for interpreter shutdown is that the __main__ module +or the script being run has finished executing.

    +
    +
    iterable

    An object capable of returning its members one at a time. Examples of +iterables include all sequence types (such as list, str, +and tuple) and some non-sequence types like dict, +file objects, and objects of any classes you define +with an __iter__() method or with a __getitem__() method +that implements Sequence semantics.

    +

    Iterables can be +used in a for loop and in many other places where a sequence is +needed (zip(), map(), …). When an iterable object is passed +as an argument to the built-in function iter(), it returns an +iterator for the object. This iterator is good for one pass over the set +of values. When using iterables, it is usually not necessary to call +iter() or deal with iterator objects yourself. The for +statement does that automatically for you, creating a temporary unnamed +variable to hold the iterator for the duration of the loop. See also +iterator, sequence, and generator.

    +
    +
    iterator

    An object representing a stream of data. Repeated calls to the iterator’s +__next__() method (or passing it to the built-in function +next()) return successive items in the stream. When no more data +are available a StopIteration exception is raised instead. At this +point, the iterator object is exhausted and any further calls to its +__next__() method just raise StopIteration again. Iterators +are required to have an __iter__() method that returns the iterator +object itself so every iterator is also iterable and may be used in most +places where other iterables are accepted. One notable exception is code +which attempts multiple iteration passes. A container object (such as a +list) produces a fresh new iterator each time you pass it to the +iter() function or use it in a for loop. Attempting this +with an iterator will just return the same exhausted iterator object used +in the previous iteration pass, making it appear like an empty container.

    +

    More information can be found in Iterator Types.

    +
    +
    key function

    A key function or collation function is a callable that returns a value +used for sorting or ordering. For example, locale.strxfrm() is +used to produce a sort key that is aware of locale specific sort +conventions.

    +

    A number of tools in Python accept key functions to control how elements +are ordered or grouped. They include min(), max(), +sorted(), list.sort(), heapq.merge(), +heapq.nsmallest(), heapq.nlargest(), and +itertools.groupby().

    +

    There are several ways to create a key function. For example. the +str.lower() method can serve as a key function for case insensitive +sorts. Alternatively, a key function can be built from a +lambda expression such as lambda r: (r[0], r[2]). Also, +the operator module provides three key function constructors: +attrgetter(), itemgetter(), and +methodcaller(). See the Sorting HOW TO for examples of how to create and use key functions.

    +
    +
    keyword argument

    See argument.

    +
    +
    lambda

    An anonymous inline function consisting of a single expression +which is evaluated when the function is called. The syntax to create +a lambda function is lambda [parameters]: expression

    +
    +
    LBYL

    Look before you leap. This coding style explicitly tests for +pre-conditions before making calls or lookups. This style contrasts with +the EAFP approach and is characterized by the presence of many +if statements.

    +

    In a multi-threaded environment, the LBYL approach can risk introducing a +race condition between “the looking” and “the leaping”. For example, the +code, if key in mapping: return mapping[key] can fail if another +thread removes key from mapping after the test, but before the lookup. +This issue can be solved with locks or by using the EAFP approach.

    +
    +
    list

    A built-in Python sequence. Despite its name it is more akin +to an array in other languages than to a linked list since access to +elements is O(1).

    +
    +
    list comprehension

    A compact way to process all or part of the elements in a sequence and +return a list with the results. result = ['{:#04x}'.format(x) for x in +range(256) if x % 2 == 0] generates a list of strings containing +even hex numbers (0x..) in the range from 0 to 255. The if +clause is optional. If omitted, all elements in range(256) are +processed.

    +
    +
    loader

    An object that loads a module. It must define a method named +load_module(). A loader is typically returned by a +finder. See PEP 302 for details and +importlib.abc.Loader for an abstract base class.

    +
    +
    magic method

    An informal synonym for special method.

    +
    +
    mapping

    A container object that supports arbitrary key lookups and implements the +methods specified in the Mapping or +MutableMapping +abstract base classes. Examples +include dict, collections.defaultdict, +collections.OrderedDict and collections.Counter.

    +
    +
    meta path finder

    A finder returned by a search of sys.meta_path. Meta path +finders are related to, but different from path entry finders.

    +

    See importlib.abc.MetaPathFinder for the methods that meta path +finders implement.

    +
    +
    metaclass

    The class of a class. Class definitions create a class name, a class +dictionary, and a list of base classes. The metaclass is responsible for +taking those three arguments and creating the class. Most object oriented +programming languages provide a default implementation. What makes Python +special is that it is possible to create custom metaclasses. Most users +never need this tool, but when the need arises, metaclasses can provide +powerful, elegant solutions. They have been used for logging attribute +access, adding thread-safety, tracking object creation, implementing +singletons, and many other tasks.

    +

    More information can be found in Metaclasses.

    +
    +
    method

    A function which is defined inside a class body. If called as an attribute +of an instance of that class, the method will get the instance object as +its first argument (which is usually called self). +See function and nested scope.

    +
    +
    method resolution order

    Method Resolution Order is the order in which base classes are searched +for a member during lookup. See The Python 2.3 Method Resolution Order for details of the +algorithm used by the Python interpreter since the 2.3 release.

    +
    +
    module

    An object that serves as an organizational unit of Python code. Modules +have a namespace containing arbitrary Python objects. Modules are loaded +into Python by the process of importing.

    +

    See also package.

    +
    +
    module spec

    A namespace containing the import-related information used to load a +module. An instance of importlib.machinery.ModuleSpec.

    +
    +
    MRO

    See method resolution order.

    +
    +
    mutable

    Mutable objects can change their value but keep their id(). See +also immutable.

    +
    +
    named tuple

    Any tuple-like class whose indexable elements are also accessible using +named attributes (for example, time.localtime() returns a +tuple-like object where the year is accessible either with an +index such as t[0] or with a named attribute like t.tm_year).

    +

    A named tuple can be a built-in type such as time.struct_time, +or it can be created with a regular class definition. A full featured +named tuple can also be created with the factory function +collections.namedtuple(). The latter approach automatically +provides extra features such as a self-documenting representation like +Employee(name='jones', title='programmer').

    +
    +
    namespace

    The place where a variable is stored. Namespaces are implemented as +dictionaries. There are the local, global and built-in namespaces as well +as nested namespaces in objects (in methods). Namespaces support +modularity by preventing naming conflicts. For instance, the functions +builtins.open and os.open() are distinguished by +their namespaces. Namespaces also aid readability and maintainability by +making it clear which module implements a function. For instance, writing +random.seed() or itertools.islice() makes it clear that those +functions are implemented by the random and itertools +modules, respectively.

    +
    +
    namespace package

    A PEP 420 package which serves only as a container for +subpackages. Namespace packages may have no physical representation, +and specifically are not like a regular package because they +have no __init__.py file.

    +

    See also module.

    +
    +
    nested scope

    The ability to refer to a variable in an enclosing definition. For +instance, a function defined inside another function can refer to +variables in the outer function. Note that nested scopes by default work +only for reference and not for assignment. Local variables both read and +write in the innermost scope. Likewise, global variables read and write +to the global namespace. The nonlocal allows writing to outer +scopes.

    +
    +
    new-style class

    Old name for the flavor of classes now used for all class objects. In +earlier Python versions, only new-style classes could use Python’s newer, +versatile features like __slots__, descriptors, +properties, __getattribute__(), class methods, and static methods.

    +
    +
    object

    Any data with state (attributes or value) and defined behavior +(methods). Also the ultimate base class of any new-style +class.

    +
    +
    package

    A Python module which can contain submodules or recursively, +subpackages. Technically, a package is a Python module with an +__path__ attribute.

    +

    See also regular package and namespace package.

    +
    +
    parameter

    A named entity in a function (or method) definition that +specifies an argument (or in some cases, arguments) that the +function can accept. There are five kinds of parameter:

    +
      +
    • positional-or-keyword: specifies an argument that can be passed +either positionally or as a keyword argument. This is the default kind of parameter, for example foo +and bar in the following:

      +
      def func(foo, bar=None): ...
      +
      +
      +
    • +
    +
      +
    • positional-only: specifies an argument that can be supplied only +by position. Python has no syntax for defining positional-only +parameters. However, some built-in functions have positional-only +parameters (e.g. abs()).

    • +
    +
      +
    • keyword-only: specifies an argument that can be supplied only +by keyword. Keyword-only parameters can be defined by including a +single var-positional parameter or bare * in the parameter list +of the function definition before them, for example kw_only1 and +kw_only2 in the following:

      +
      def func(arg, *, kw_only1, kw_only2): ...
      +
      +
      +
    • +
    • var-positional: specifies that an arbitrary sequence of +positional arguments can be provided (in addition to any positional +arguments already accepted by other parameters). Such a parameter can +be defined by prepending the parameter name with *, for example +args in the following:

      +
      def func(*args, **kwargs): ...
      +
      +
      +
    • +
    • var-keyword: specifies that arbitrarily many keyword arguments +can be provided (in addition to any keyword arguments already accepted +by other parameters). Such a parameter can be defined by prepending +the parameter name with **, for example kwargs in the example +above.

    • +
    +

    Parameters can specify both optional and required arguments, as well as +default values for some optional arguments.

    +

    See also the argument glossary entry, the FAQ question on +the difference between arguments and parameters, the inspect.Parameter class, the +Function definitions section, and PEP 362.

    +
    +
    path entry

    A single location on the import path which the path +based finder consults to find modules for importing.

    +
    +
    path entry finder

    A finder returned by a callable on sys.path_hooks +(i.e. a path entry hook) which knows how to locate modules given +a path entry.

    +

    See importlib.abc.PathEntryFinder for the methods that path entry +finders implement.

    +
    +
    path entry hook

    A callable on the sys.path_hook list which returns a path +entry finder if it knows how to find modules on a specific path +entry.

    +
    +
    path based finder

    One of the default meta path finders which +searches an import path for modules.

    +
    +
    path-like object

    An object representing a file system path. A path-like object is either +a str or bytes object representing a path, or an object +implementing the os.PathLike protocol. An object that supports +the os.PathLike protocol can be converted to a str or +bytes file system path by calling the os.fspath() function; +os.fsdecode() and os.fsencode() can be used to guarantee a +str or bytes result instead, respectively. Introduced +by PEP 519.

    +
    +
    PEP

    Python Enhancement Proposal. A PEP is a design document +providing information to the Python community, or describing a new +feature for Python or its processes or environment. PEPs should +provide a concise technical specification and a rationale for proposed +features.

    +

    PEPs are intended to be the primary mechanisms for proposing major new +features, for collecting community input on an issue, and for documenting +the design decisions that have gone into Python. The PEP author is +responsible for building consensus within the community and documenting +dissenting opinions.

    +

    See PEP 1.

    +
    +
    portion

    A set of files in a single directory (possibly stored in a zip file) +that contribute to a namespace package, as defined in PEP 420.

    +
    +
    positional argument

    See argument.

    +
    +
    provisional API

    A provisional API is one which has been deliberately excluded from +the standard library’s backwards compatibility guarantees. While major +changes to such interfaces are not expected, as long as they are marked +provisional, backwards incompatible changes (up to and including removal +of the interface) may occur if deemed necessary by core developers. Such +changes will not be made gratuitously – they will occur only if serious +fundamental flaws are uncovered that were missed prior to the inclusion +of the API.

    +

    Even for provisional APIs, backwards incompatible changes are seen as +a “solution of last resort” - every attempt will still be made to find +a backwards compatible resolution to any identified problems.

    +

    This process allows the standard library to continue to evolve over +time, without locking in problematic design errors for extended periods +of time. See PEP 411 for more details.

    +
    +
    provisional package

    See provisional API.

    +
    +
    Python 3000

    Nickname for the Python 3.x release line (coined long ago when the +release of version 3 was something in the distant future.) This is also +abbreviated “Py3k”.

    +
    +
    Pythonic

    An idea or piece of code which closely follows the most common idioms +of the Python language, rather than implementing code using concepts +common to other languages. For example, a common idiom in Python is +to loop over all elements of an iterable using a for +statement. Many other languages don’t have this type of construct, so +people unfamiliar with Python sometimes use a numerical counter instead:

    +
    for i in range(len(food)):
    +    print(food[i])
    +
    +
    +

    As opposed to the cleaner, Pythonic method:

    +
    for piece in food:
    +    print(piece)
    +
    +
    +
    +
    qualified name

    A dotted name showing the “path” from a module’s global scope to a +class, function or method defined in that module, as defined in +PEP 3155. For top-level functions and classes, the qualified name +is the same as the object’s name:

    +
    >>> class C:
    +...     class D:
    +...         def meth(self):
    +...             pass
    +...
    +>>> C.__qualname__
    +'C'
    +>>> C.D.__qualname__
    +'C.D'
    +>>> C.D.meth.__qualname__
    +'C.D.meth'
    +
    +
    +

    When used to refer to modules, the fully qualified name means the +entire dotted path to the module, including any parent packages, +e.g. email.mime.text:

    +
    >>> import email.mime.text
    +>>> email.mime.text.__name__
    +'email.mime.text'
    +
    +
    +
    +
    reference count

    The number of references to an object. When the reference count of an +object drops to zero, it is deallocated. Reference counting is +generally not visible to Python code, but it is a key element of the +CPython implementation. The sys module defines a +getrefcount() function that programmers can call to return the +reference count for a particular object.

    +
    +
    regular package

    A traditional package, such as a directory containing an +__init__.py file.

    +

    See also namespace package.

    +
    +
    __slots__

    A declaration inside a class that saves memory by pre-declaring space for +instance attributes and eliminating instance dictionaries. Though +popular, the technique is somewhat tricky to get right and is best +reserved for rare cases where there are large numbers of instances in a +memory-critical application.

    +
    +
    sequence

    An iterable which supports efficient element access using integer +indices via the __getitem__() special method and defines a +__len__() method that returns the length of the sequence. +Some built-in sequence types are list, str, +tuple, and bytes. Note that dict also +supports __getitem__() and __len__(), but is considered a +mapping rather than a sequence because the lookups use arbitrary +immutable keys rather than integers.

    +

    The collections.abc.Sequence abstract base class +defines a much richer interface that goes beyond just +__getitem__() and __len__(), adding count(), +index(), __contains__(), and +__reversed__(). Types that implement this expanded +interface can be registered explicitly using +register().

    +
    +
    single dispatch

    A form of generic function dispatch where the implementation is +chosen based on the type of a single argument.

    +
    +
    slice

    An object usually containing a portion of a sequence. A slice is +created using the subscript notation, [] with colons between numbers +when several are given, such as in variable_name[1:3:5]. The bracket +(subscript) notation uses slice objects internally.

    +
    +
    special method

    A method that is called implicitly by Python to execute a certain +operation on a type, such as addition. Such methods have names starting +and ending with double underscores. Special methods are documented in +Special method names.

    +
    +
    statement

    A statement is part of a suite (a “block” of code). A statement is either +an expression or one of several constructs with a keyword, such +as if, while or for.

    +
    +
    struct sequence

    A tuple with named elements. Struct sequences expose an interface similar +to named tuple in that elements can be accessed either by +index or as an attribute. However, they do not have any of the named tuple +methods like _make() or +_asdict(). Examples of struct sequences +include sys.float_info and the return value of os.stat().

    +
    +
    text encoding

    A codec which encodes Unicode strings to bytes.

    +
    +
    text file

    A file object able to read and write str objects. +Often, a text file actually accesses a byte-oriented datastream +and handles the text encoding automatically. +Examples of text files are files opened in text mode ('r' or 'w'), +sys.stdin, sys.stdout, and instances of +io.StringIO.

    +

    See also binary file for a file object able to read and write +bytes-like objects.

    +
    +
    triple-quoted string

    A string which is bound by three instances of either a quotation mark +(“) or an apostrophe (‘). While they don’t provide any functionality +not available with single-quoted strings, they are useful for a number +of reasons. They allow you to include unescaped single and double +quotes within a string and they can span multiple lines without the +use of the continuation character, making them especially useful when +writing docstrings.

    +
    +
    type

    The type of a Python object determines what kind of object it is; every +object has a type. An object’s type is accessible as its +__class__ attribute or can be retrieved with +type(obj).

    +
    +
    type alias

    A synonym for a type, created by assigning the type to an identifier.

    +

    Type aliases are useful for simplifying type hints. +For example:

    +
    from typing import List, Tuple
    +
    +def remove_gray_shades(
    +        colors: List[Tuple[int, int, int]]) -> List[Tuple[int, int, int]]:
    +    pass
    +
    +
    +

    could be made more readable like this:

    +
    from typing import List, Tuple
    +
    +Color = Tuple[int, int, int]
    +
    +def remove_gray_shades(colors: List[Color]) -> List[Color]:
    +    pass
    +
    +
    +

    See typing and PEP 484, which describe this functionality.

    +
    +
    type hint

    An annotation that specifies the expected type for a variable, a class +attribute, or a function parameter or return value.

    +

    Type hints are optional and are not enforced by Python but +they are useful to static type analysis tools, and aid IDEs with code +completion and refactoring.

    +

    Type hints of global variables, class attributes, and functions, +but not local variables, can be accessed using +typing.get_type_hints().

    +

    See typing and PEP 484, which describe this functionality.

    +
    +
    universal newlines

    A manner of interpreting text streams in which all of the following are +recognized as ending a line: the Unix end-of-line convention '\n', +the Windows convention '\r\n', and the old Macintosh convention +'\r'. See PEP 278 and PEP 3116, as well as +bytes.splitlines() for an additional use.

    +
    +
    variable annotation

    An annotation of a variable or a class attribute.

    +

    When annotating a variable or a class attribute, assignment is optional:

    +
    class C:
    +    field: 'annotation'
    +
    +
    +

    Variable annotations are usually used for +type hints: for example this variable is expected to take +int values:

    +
    count: int = 0
    +
    +
    +

    Variable annotation syntax is explained in section Annotated assignment statements.

    +

    See function annotation, PEP 484 +and PEP 526, which describe this functionality.

    +
    +
    virtual environment

    A cooperatively isolated runtime environment that allows Python users +and applications to install and upgrade Python distribution packages +without interfering with the behaviour of other Python applications +running on the same system.

    +

    See also venv.

    +
    +
    virtual machine

    A computer defined entirely in software. Python’s virtual machine +executes the bytecode emitted by the bytecode compiler.

    +
    +
    Zen of Python

    Listing of Python design principles and philosophies that are helpful in +understanding and using the language. The listing can be found by typing +“import this” at the interactive prompt.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/howto/argparse.html b/python-3.7.4-docs-html/howto/argparse.html new file mode 100644 index 0000000..b5c5833 --- /dev/null +++ b/python-3.7.4-docs-html/howto/argparse.html @@ -0,0 +1,888 @@ + + + + + + + Argparse Tutorial — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Argparse Tutorial

    +
    +
    author
    +

    Tshepang Lekhonkhobe

    +
    +
    +

    This tutorial is intended to be a gentle introduction to argparse, the +recommended command-line parsing module in the Python standard library.

    +
    +

    Note

    +

    There are two other modules that fulfill the same task, namely +getopt (an equivalent for getopt() from the C +language) and the deprecated optparse. +Note also that argparse is based on optparse, +and therefore very similar in terms of usage.

    +
    +
    +

    Concepts

    +

    Let’s show the sort of functionality that we are going to explore in this +introductory tutorial by making use of the ls command:

    +
    $ ls
    +cpython  devguide  prog.py  pypy  rm-unused-function.patch
    +$ ls pypy
    +ctypes_configure  demo  dotviewer  include  lib_pypy  lib-python ...
    +$ ls -l
    +total 20
    +drwxr-xr-x 19 wena wena 4096 Feb 18 18:51 cpython
    +drwxr-xr-x  4 wena wena 4096 Feb  8 12:04 devguide
    +-rwxr-xr-x  1 wena wena  535 Feb 19 00:05 prog.py
    +drwxr-xr-x 14 wena wena 4096 Feb  7 00:59 pypy
    +-rw-r--r--  1 wena wena  741 Feb 18 01:01 rm-unused-function.patch
    +$ ls --help
    +Usage: ls [OPTION]... [FILE]...
    +List information about the FILEs (the current directory by default).
    +Sort entries alphabetically if none of -cftuvSUX nor --sort is specified.
    +...
    +
    +
    +

    A few concepts we can learn from the four commands:

    +
      +
    • The ls command is useful when run without any options at all. It defaults +to displaying the contents of the current directory.

    • +
    • If we want beyond what it provides by default, we tell it a bit more. In +this case, we want it to display a different directory, pypy. +What we did is specify what is known as a positional argument. It’s named so +because the program should know what to do with the value, solely based on +where it appears on the command line. This concept is more relevant +to a command like cp, whose most basic usage is cp SRC DEST. +The first position is what you want copied, and the second +position is where you want it copied to.

    • +
    • Now, say we want to change behaviour of the program. In our example, +we display more info for each file instead of just showing the file names. +The -l in that case is known as an optional argument.

    • +
    • That’s a snippet of the help text. It’s very useful in that you can +come across a program you have never used before, and can figure out +how it works simply by reading its help text.

    • +
    +
    +
    +

    The basics

    +

    Let us start with a very simple example which does (almost) nothing:

    +
    import argparse
    +parser = argparse.ArgumentParser()
    +parser.parse_args()
    +
    +
    +

    Following is a result of running the code:

    +
    $ python3 prog.py
    +$ python3 prog.py --help
    +usage: prog.py [-h]
    +
    +optional arguments:
    +  -h, --help  show this help message and exit
    +$ python3 prog.py --verbose
    +usage: prog.py [-h]
    +prog.py: error: unrecognized arguments: --verbose
    +$ python3 prog.py foo
    +usage: prog.py [-h]
    +prog.py: error: unrecognized arguments: foo
    +
    +
    +

    Here is what is happening:

    +
      +
    • Running the script without any options results in nothing displayed to +stdout. Not so useful.

    • +
    • The second one starts to display the usefulness of the argparse +module. We have done almost nothing, but already we get a nice help message.

    • +
    • The --help option, which can also be shortened to -h, is the only +option we get for free (i.e. no need to specify it). Specifying anything +else results in an error. But even then, we do get a useful usage message, +also for free.

    • +
    +
    +
    +

    Introducing Positional arguments

    +

    An example:

    +
    import argparse
    +parser = argparse.ArgumentParser()
    +parser.add_argument("echo")
    +args = parser.parse_args()
    +print(args.echo)
    +
    +
    +

    And running the code:

    +
    $ python3 prog.py
    +usage: prog.py [-h] echo
    +prog.py: error: the following arguments are required: echo
    +$ python3 prog.py --help
    +usage: prog.py [-h] echo
    +
    +positional arguments:
    +  echo
    +
    +optional arguments:
    +  -h, --help  show this help message and exit
    +$ python3 prog.py foo
    +foo
    +
    +
    +

    Here is what’s happening:

    +
      +
    • We’ve added the add_argument() method, which is what we use to specify +which command-line options the program is willing to accept. In this case, +I’ve named it echo so that it’s in line with its function.

    • +
    • Calling our program now requires us to specify an option.

    • +
    • The parse_args() method actually returns some data from the +options specified, in this case, echo.

    • +
    • The variable is some form of ‘magic’ that argparse performs for free +(i.e. no need to specify which variable that value is stored in). +You will also notice that its name matches the string argument given +to the method, echo.

    • +
    +

    Note however that, although the help display looks nice and all, it currently +is not as helpful as it can be. For example we see that we got echo as a +positional argument, but we don’t know what it does, other than by guessing or +by reading the source code. So, let’s make it a bit more useful:

    +
    import argparse
    +parser = argparse.ArgumentParser()
    +parser.add_argument("echo", help="echo the string you use here")
    +args = parser.parse_args()
    +print(args.echo)
    +
    +
    +

    And we get:

    +
    $ python3 prog.py -h
    +usage: prog.py [-h] echo
    +
    +positional arguments:
    +  echo        echo the string you use here
    +
    +optional arguments:
    +  -h, --help  show this help message and exit
    +
    +
    +

    Now, how about doing something even more useful:

    +
    import argparse
    +parser = argparse.ArgumentParser()
    +parser.add_argument("square", help="display a square of a given number")
    +args = parser.parse_args()
    +print(args.square**2)
    +
    +
    +

    Following is a result of running the code:

    +
    $ python3 prog.py 4
    +Traceback (most recent call last):
    +  File "prog.py", line 5, in <module>
    +    print(args.square**2)
    +TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'
    +
    +
    +

    That didn’t go so well. That’s because argparse treats the options we +give it as strings, unless we tell it otherwise. So, let’s tell +argparse to treat that input as an integer:

    +
    import argparse
    +parser = argparse.ArgumentParser()
    +parser.add_argument("square", help="display a square of a given number",
    +                    type=int)
    +args = parser.parse_args()
    +print(args.square**2)
    +
    +
    +

    Following is a result of running the code:

    +
    $ python3 prog.py 4
    +16
    +$ python3 prog.py four
    +usage: prog.py [-h] square
    +prog.py: error: argument square: invalid int value: 'four'
    +
    +
    +

    That went well. The program now even helpfully quits on bad illegal input +before proceeding.

    +
    +
    +

    Introducing Optional arguments

    +

    So far we have been playing with positional arguments. Let us +have a look on how to add optional ones:

    +
    import argparse
    +parser = argparse.ArgumentParser()
    +parser.add_argument("--verbosity", help="increase output verbosity")
    +args = parser.parse_args()
    +if args.verbosity:
    +    print("verbosity turned on")
    +
    +
    +

    And the output:

    +
    $ python3 prog.py --verbosity 1
    +verbosity turned on
    +$ python3 prog.py
    +$ python3 prog.py --help
    +usage: prog.py [-h] [--verbosity VERBOSITY]
    +
    +optional arguments:
    +  -h, --help            show this help message and exit
    +  --verbosity VERBOSITY
    +                        increase output verbosity
    +$ python3 prog.py --verbosity
    +usage: prog.py [-h] [--verbosity VERBOSITY]
    +prog.py: error: argument --verbosity: expected one argument
    +
    +
    +

    Here is what is happening:

    +
      +
    • The program is written so as to display something when --verbosity is +specified and display nothing when not.

    • +
    • To show that the option is actually optional, there is no error when running +the program without it. Note that by default, if an optional argument isn’t +used, the relevant variable, in this case args.verbosity, is +given None as a value, which is the reason it fails the truth +test of the if statement.

    • +
    • The help message is a bit different.

    • +
    • When using the --verbosity option, one must also specify some value, +any value.

    • +
    +

    The above example accepts arbitrary integer values for --verbosity, but for +our simple program, only two values are actually useful, True or False. +Let’s modify the code accordingly:

    +
    import argparse
    +parser = argparse.ArgumentParser()
    +parser.add_argument("--verbose", help="increase output verbosity",
    +                    action="store_true")
    +args = parser.parse_args()
    +if args.verbose:
    +    print("verbosity turned on")
    +
    +
    +

    And the output:

    +
    $ python3 prog.py --verbose
    +verbosity turned on
    +$ python3 prog.py --verbose 1
    +usage: prog.py [-h] [--verbose]
    +prog.py: error: unrecognized arguments: 1
    +$ python3 prog.py --help
    +usage: prog.py [-h] [--verbose]
    +
    +optional arguments:
    +  -h, --help  show this help message and exit
    +  --verbose   increase output verbosity
    +
    +
    +

    Here is what is happening:

    +
      +
    • The option is now more of a flag than something that requires a value. +We even changed the name of the option to match that idea. +Note that we now specify a new keyword, action, and give it the value +"store_true". This means that, if the option is specified, +assign the value True to args.verbose. +Not specifying it implies False.

    • +
    • It complains when you specify a value, in true spirit of what flags +actually are.

    • +
    • Notice the different help text.

    • +
    +
    +

    Short options

    +

    If you are familiar with command line usage, +you will notice that I haven’t yet touched on the topic of short +versions of the options. It’s quite simple:

    +
    import argparse
    +parser = argparse.ArgumentParser()
    +parser.add_argument("-v", "--verbose", help="increase output verbosity",
    +                    action="store_true")
    +args = parser.parse_args()
    +if args.verbose:
    +    print("verbosity turned on")
    +
    +
    +

    And here goes:

    +
    $ python3 prog.py -v
    +verbosity turned on
    +$ python3 prog.py --help
    +usage: prog.py [-h] [-v]
    +
    +optional arguments:
    +  -h, --help     show this help message and exit
    +  -v, --verbose  increase output verbosity
    +
    +
    +

    Note that the new ability is also reflected in the help text.

    +
    +
    +
    +

    Combining Positional and Optional arguments

    +

    Our program keeps growing in complexity:

    +
    import argparse
    +parser = argparse.ArgumentParser()
    +parser.add_argument("square", type=int,
    +                    help="display a square of a given number")
    +parser.add_argument("-v", "--verbose", action="store_true",
    +                    help="increase output verbosity")
    +args = parser.parse_args()
    +answer = args.square**2
    +if args.verbose:
    +    print("the square of {} equals {}".format(args.square, answer))
    +else:
    +    print(answer)
    +
    +
    +

    And now the output:

    +
    $ python3 prog.py
    +usage: prog.py [-h] [-v] square
    +prog.py: error: the following arguments are required: square
    +$ python3 prog.py 4
    +16
    +$ python3 prog.py 4 --verbose
    +the square of 4 equals 16
    +$ python3 prog.py --verbose 4
    +the square of 4 equals 16
    +
    +
    +
      +
    • We’ve brought back a positional argument, hence the complaint.

    • +
    • Note that the order does not matter.

    • +
    +

    How about we give this program of ours back the ability to have +multiple verbosity values, and actually get to use them:

    +
    import argparse
    +parser = argparse.ArgumentParser()
    +parser.add_argument("square", type=int,
    +                    help="display a square of a given number")
    +parser.add_argument("-v", "--verbosity", type=int,
    +                    help="increase output verbosity")
    +args = parser.parse_args()
    +answer = args.square**2
    +if args.verbosity == 2:
    +    print("the square of {} equals {}".format(args.square, answer))
    +elif args.verbosity == 1:
    +    print("{}^2 == {}".format(args.square, answer))
    +else:
    +    print(answer)
    +
    +
    +

    And the output:

    +
    $ python3 prog.py 4
    +16
    +$ python3 prog.py 4 -v
    +usage: prog.py [-h] [-v VERBOSITY] square
    +prog.py: error: argument -v/--verbosity: expected one argument
    +$ python3 prog.py 4 -v 1
    +4^2 == 16
    +$ python3 prog.py 4 -v 2
    +the square of 4 equals 16
    +$ python3 prog.py 4 -v 3
    +16
    +
    +
    +

    These all look good except the last one, which exposes a bug in our program. +Let’s fix it by restricting the values the --verbosity option can accept:

    +
    import argparse
    +parser = argparse.ArgumentParser()
    +parser.add_argument("square", type=int,
    +                    help="display a square of a given number")
    +parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2],
    +                    help="increase output verbosity")
    +args = parser.parse_args()
    +answer = args.square**2
    +if args.verbosity == 2:
    +    print("the square of {} equals {}".format(args.square, answer))
    +elif args.verbosity == 1:
    +    print("{}^2 == {}".format(args.square, answer))
    +else:
    +    print(answer)
    +
    +
    +

    And the output:

    +
    $ python3 prog.py 4 -v 3
    +usage: prog.py [-h] [-v {0,1,2}] square
    +prog.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2)
    +$ python3 prog.py 4 -h
    +usage: prog.py [-h] [-v {0,1,2}] square
    +
    +positional arguments:
    +  square                display a square of a given number
    +
    +optional arguments:
    +  -h, --help            show this help message and exit
    +  -v {0,1,2}, --verbosity {0,1,2}
    +                        increase output verbosity
    +
    +
    +

    Note that the change also reflects both in the error message as well as the +help string.

    +

    Now, let’s use a different approach of playing with verbosity, which is pretty +common. It also matches the way the CPython executable handles its own +verbosity argument (check the output of python --help):

    +
    import argparse
    +parser = argparse.ArgumentParser()
    +parser.add_argument("square", type=int,
    +                    help="display the square of a given number")
    +parser.add_argument("-v", "--verbosity", action="count",
    +                    help="increase output verbosity")
    +args = parser.parse_args()
    +answer = args.square**2
    +if args.verbosity == 2:
    +    print("the square of {} equals {}".format(args.square, answer))
    +elif args.verbosity == 1:
    +    print("{}^2 == {}".format(args.square, answer))
    +else:
    +    print(answer)
    +
    +
    +

    We have introduced another action, “count”, +to count the number of occurrences of a specific optional arguments:

    +
    $ python3 prog.py 4
    +16
    +$ python3 prog.py 4 -v
    +4^2 == 16
    +$ python3 prog.py 4 -vv
    +the square of 4 equals 16
    +$ python3 prog.py 4 --verbosity --verbosity
    +the square of 4 equals 16
    +$ python3 prog.py 4 -v 1
    +usage: prog.py [-h] [-v] square
    +prog.py: error: unrecognized arguments: 1
    +$ python3 prog.py 4 -h
    +usage: prog.py [-h] [-v] square
    +
    +positional arguments:
    +  square           display a square of a given number
    +
    +optional arguments:
    +  -h, --help       show this help message and exit
    +  -v, --verbosity  increase output verbosity
    +$ python3 prog.py 4 -vvv
    +16
    +
    +
    +
      +
    • Yes, it’s now more of a flag (similar to action="store_true") in the +previous version of our script. That should explain the complaint.

    • +
    • It also behaves similar to “store_true” action.

    • +
    • Now here’s a demonstration of what the “count” action gives. You’ve probably +seen this sort of usage before.

    • +
    • And if you don’t specify the -v flag, that flag is considered to have +None value.

    • +
    • As should be expected, specifying the long form of the flag, we should get +the same output.

    • +
    • Sadly, our help output isn’t very informative on the new ability our script +has acquired, but that can always be fixed by improving the documentation for +our script (e.g. via the help keyword argument).

    • +
    • That last output exposes a bug in our program.

    • +
    +

    Let’s fix:

    +
    import argparse
    +parser = argparse.ArgumentParser()
    +parser.add_argument("square", type=int,
    +                    help="display a square of a given number")
    +parser.add_argument("-v", "--verbosity", action="count",
    +                    help="increase output verbosity")
    +args = parser.parse_args()
    +answer = args.square**2
    +
    +# bugfix: replace == with >=
    +if args.verbosity >= 2:
    +    print("the square of {} equals {}".format(args.square, answer))
    +elif args.verbosity >= 1:
    +    print("{}^2 == {}".format(args.square, answer))
    +else:
    +    print(answer)
    +
    +
    +

    And this is what it gives:

    +
    $ python3 prog.py 4 -vvv
    +the square of 4 equals 16
    +$ python3 prog.py 4 -vvvv
    +the square of 4 equals 16
    +$ python3 prog.py 4
    +Traceback (most recent call last):
    +  File "prog.py", line 11, in <module>
    +    if args.verbosity >= 2:
    +TypeError: '>=' not supported between instances of 'NoneType' and 'int'
    +
    +
    +
      +
    • First output went well, and fixes the bug we had before. +That is, we want any value >= 2 to be as verbose as possible.

    • +
    • Third output not so good.

    • +
    +

    Let’s fix that bug:

    +
    import argparse
    +parser = argparse.ArgumentParser()
    +parser.add_argument("square", type=int,
    +                    help="display a square of a given number")
    +parser.add_argument("-v", "--verbosity", action="count", default=0,
    +                    help="increase output verbosity")
    +args = parser.parse_args()
    +answer = args.square**2
    +if args.verbosity >= 2:
    +    print("the square of {} equals {}".format(args.square, answer))
    +elif args.verbosity >= 1:
    +    print("{}^2 == {}".format(args.square, answer))
    +else:
    +    print(answer)
    +
    +
    +

    We’ve just introduced yet another keyword, default. +We’ve set it to 0 in order to make it comparable to the other int values. +Remember that by default, +if an optional argument isn’t specified, +it gets the None value, and that cannot be compared to an int value +(hence the TypeError exception).

    +

    And:

    +
    $ python3 prog.py 4
    +16
    +
    +
    +

    You can go quite far just with what we’ve learned so far, +and we have only scratched the surface. +The argparse module is very powerful, +and we’ll explore a bit more of it before we end this tutorial.

    +
    +
    +

    Getting a little more advanced

    +

    What if we wanted to expand our tiny program to perform other powers, +not just squares:

    +
    import argparse
    +parser = argparse.ArgumentParser()
    +parser.add_argument("x", type=int, help="the base")
    +parser.add_argument("y", type=int, help="the exponent")
    +parser.add_argument("-v", "--verbosity", action="count", default=0)
    +args = parser.parse_args()
    +answer = args.x**args.y
    +if args.verbosity >= 2:
    +    print("{} to the power {} equals {}".format(args.x, args.y, answer))
    +elif args.verbosity >= 1:
    +    print("{}^{} == {}".format(args.x, args.y, answer))
    +else:
    +    print(answer)
    +
    +
    +

    Output:

    +
    $ python3 prog.py
    +usage: prog.py [-h] [-v] x y
    +prog.py: error: the following arguments are required: x, y
    +$ python3 prog.py -h
    +usage: prog.py [-h] [-v] x y
    +
    +positional arguments:
    +  x                the base
    +  y                the exponent
    +
    +optional arguments:
    +  -h, --help       show this help message and exit
    +  -v, --verbosity
    +$ python3 prog.py 4 2 -v
    +4^2 == 16
    +
    +
    +

    Notice that so far we’ve been using verbosity level to change the text +that gets displayed. The following example instead uses verbosity level +to display more text instead:

    +
    import argparse
    +parser = argparse.ArgumentParser()
    +parser.add_argument("x", type=int, help="the base")
    +parser.add_argument("y", type=int, help="the exponent")
    +parser.add_argument("-v", "--verbosity", action="count", default=0)
    +args = parser.parse_args()
    +answer = args.x**args.y
    +if args.verbosity >= 2:
    +    print("Running '{}'".format(__file__))
    +if args.verbosity >= 1:
    +    print("{}^{} == ".format(args.x, args.y), end="")
    +print(answer)
    +
    +
    +

    Output:

    +
    $ python3 prog.py 4 2
    +16
    +$ python3 prog.py 4 2 -v
    +4^2 == 16
    +$ python3 prog.py 4 2 -vv
    +Running 'prog.py'
    +4^2 == 16
    +
    +
    +
    +

    Conflicting options

    +

    So far, we have been working with two methods of an +argparse.ArgumentParser instance. Let’s introduce a third one, +add_mutually_exclusive_group(). It allows for us to specify options that +conflict with each other. Let’s also change the rest of the program so that +the new functionality makes more sense: +we’ll introduce the --quiet option, +which will be the opposite of the --verbose one:

    +
    import argparse
    +
    +parser = argparse.ArgumentParser()
    +group = parser.add_mutually_exclusive_group()
    +group.add_argument("-v", "--verbose", action="store_true")
    +group.add_argument("-q", "--quiet", action="store_true")
    +parser.add_argument("x", type=int, help="the base")
    +parser.add_argument("y", type=int, help="the exponent")
    +args = parser.parse_args()
    +answer = args.x**args.y
    +
    +if args.quiet:
    +    print(answer)
    +elif args.verbose:
    +    print("{} to the power {} equals {}".format(args.x, args.y, answer))
    +else:
    +    print("{}^{} == {}".format(args.x, args.y, answer))
    +
    +
    +

    Our program is now simpler, and we’ve lost some functionality for the sake of +demonstration. Anyways, here’s the output:

    +
    $ python3 prog.py 4 2
    +4^2 == 16
    +$ python3 prog.py 4 2 -q
    +16
    +$ python3 prog.py 4 2 -v
    +4 to the power 2 equals 16
    +$ python3 prog.py 4 2 -vq
    +usage: prog.py [-h] [-v | -q] x y
    +prog.py: error: argument -q/--quiet: not allowed with argument -v/--verbose
    +$ python3 prog.py 4 2 -v --quiet
    +usage: prog.py [-h] [-v | -q] x y
    +prog.py: error: argument -q/--quiet: not allowed with argument -v/--verbose
    +
    +
    +

    That should be easy to follow. I’ve added that last output so you can see the +sort of flexibility you get, i.e. mixing long form options with short form +ones.

    +

    Before we conclude, you probably want to tell your users the main purpose of +your program, just in case they don’t know:

    +
    import argparse
    +
    +parser = argparse.ArgumentParser(description="calculate X to the power of Y")
    +group = parser.add_mutually_exclusive_group()
    +group.add_argument("-v", "--verbose", action="store_true")
    +group.add_argument("-q", "--quiet", action="store_true")
    +parser.add_argument("x", type=int, help="the base")
    +parser.add_argument("y", type=int, help="the exponent")
    +args = parser.parse_args()
    +answer = args.x**args.y
    +
    +if args.quiet:
    +    print(answer)
    +elif args.verbose:
    +    print("{} to the power {} equals {}".format(args.x, args.y, answer))
    +else:
    +    print("{}^{} == {}".format(args.x, args.y, answer))
    +
    +
    +

    Note that slight difference in the usage text. Note the [-v | -q], +which tells us that we can either use -v or -q, +but not both at the same time:

    +
    $ python3 prog.py --help
    +usage: prog.py [-h] [-v | -q] x y
    +
    +calculate X to the power of Y
    +
    +positional arguments:
    +  x              the base
    +  y              the exponent
    +
    +optional arguments:
    +  -h, --help     show this help message and exit
    +  -v, --verbose
    +  -q, --quiet
    +
    +
    +
    +
    +
    +

    Conclusion

    +

    The argparse module offers a lot more than shown here. +Its docs are quite detailed and thorough, and full of examples. +Having gone through this tutorial, you should easily digest them +without feeling overwhelmed.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/howto/clinic.html b/python-3.7.4-docs-html/howto/clinic.html new file mode 100644 index 0000000..1280d46 --- /dev/null +++ b/python-3.7.4-docs-html/howto/clinic.html @@ -0,0 +1,1806 @@ + + + + + + + Argument Clinic How-To — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Argument Clinic How-To

    +
    +
    author
    +

    Larry Hastings

    +
    +
    +
    +

    Abstract

    +

    Argument Clinic is a preprocessor for CPython C files. +Its purpose is to automate all the boilerplate involved +with writing argument parsing code for “builtins”. +This document shows you how to convert your first C +function to work with Argument Clinic, and then introduces +some advanced topics on Argument Clinic usage.

    +

    Currently Argument Clinic is considered internal-only +for CPython. Its use is not supported for files outside +CPython, and no guarantees are made regarding backwards +compatibility for future versions. In other words: if you +maintain an external C extension for CPython, you’re welcome +to experiment with Argument Clinic in your own code. But the +version of Argument Clinic that ships with the next version +of CPython could be totally incompatible and break all your code.

    +
    +
    +

    The Goals Of Argument Clinic

    +

    Argument Clinic’s primary goal +is to take over responsibility for all argument parsing code +inside CPython. This means that, when you convert a function +to work with Argument Clinic, that function should no longer +do any of its own argument parsing—the code generated by +Argument Clinic should be a “black box” to you, where CPython +calls in at the top, and your code gets called at the bottom, +with PyObject *args (and maybe PyObject *kwargs) +magically converted into the C variables and types you need.

    +

    In order for Argument Clinic to accomplish its primary goal, +it must be easy to use. Currently, working with CPython’s +argument parsing library is a chore, requiring maintaining +redundant information in a surprising number of places. +When you use Argument Clinic, you don’t have to repeat yourself.

    +

    Obviously, no one would want to use Argument Clinic unless +it’s solving their problem—and without creating new problems of +its own. +So it’s paramount that Argument Clinic generate correct code. +It’d be nice if the code was faster, too, but at the very least +it should not introduce a major speed regression. (Eventually Argument +Clinic should make a major speedup possible—we could +rewrite its code generator to produce tailor-made argument +parsing code, rather than calling the general-purpose CPython +argument parsing library. That would make for the fastest +argument parsing possible!)

    +

    Additionally, Argument Clinic must be flexible enough to +work with any approach to argument parsing. Python has +some functions with some very strange parsing behaviors; +Argument Clinic’s goal is to support all of them.

    +

    Finally, the original motivation for Argument Clinic was +to provide introspection “signatures” for CPython builtins. +It used to be, the introspection query functions would throw +an exception if you passed in a builtin. With Argument +Clinic, that’s a thing of the past!

    +

    One idea you should keep in mind, as you work with +Argument Clinic: the more information you give it, the +better job it’ll be able to do. +Argument Clinic is admittedly relatively simple right +now. But as it evolves it will get more sophisticated, +and it should be able to do many interesting and smart +things with all the information you give it.

    +
    +
    +

    Basic Concepts And Usage

    +

    Argument Clinic ships with CPython; you’ll find it in Tools/clinic/clinic.py. +If you run that script, specifying a C file as an argument:

    +
    $ python3 Tools/clinic/clinic.py foo.c
    +
    +
    +

    Argument Clinic will scan over the file looking for lines that +look exactly like this:

    +
    /*[clinic input]
    +
    +
    +

    When it finds one, it reads everything up to a line that looks +exactly like this:

    +
    [clinic start generated code]*/
    +
    +
    +

    Everything in between these two lines is input for Argument Clinic. +All of these lines, including the beginning and ending comment +lines, are collectively called an Argument Clinic “block”.

    +

    When Argument Clinic parses one of these blocks, it +generates output. This output is rewritten into the C file +immediately after the block, followed by a comment containing a checksum. +The Argument Clinic block now looks like this:

    +
    /*[clinic input]
    +... clinic input goes here ...
    +[clinic start generated code]*/
    +... clinic output goes here ...
    +/*[clinic end generated code: checksum=...]*/
    +
    +
    +

    If you run Argument Clinic on the same file a second time, Argument Clinic +will discard the old output and write out the new output with a fresh checksum +line. However, if the input hasn’t changed, the output won’t change either.

    +

    You should never modify the output portion of an Argument Clinic block. Instead, +change the input until it produces the output you want. (That’s the purpose of the +checksum—to detect if someone changed the output, as these edits would be lost +the next time Argument Clinic writes out fresh output.)

    +

    For the sake of clarity, here’s the terminology we’ll use with Argument Clinic:

    +
      +
    • The first line of the comment (/*[clinic input]) is the start line.

    • +
    • The last line of the initial comment ([clinic start generated code]*/) is the end line.

    • +
    • The last line (/*[clinic end generated code: checksum=...]*/) is the checksum line.

    • +
    • In between the start line and the end line is the input.

    • +
    • In between the end line and the checksum line is the output.

    • +
    • All the text collectively, from the start line to the checksum line inclusively, +is the block. (A block that hasn’t been successfully processed by Argument +Clinic yet doesn’t have output or a checksum line, but it’s still considered +a block.)

    • +
    +
    +
    +

    Converting Your First Function

    +

    The best way to get a sense of how Argument Clinic works is to +convert a function to work with it. Here, then, are the bare +minimum steps you’d need to follow to convert a function to +work with Argument Clinic. Note that for code you plan to +check in to CPython, you really should take the conversion farther, +using some of the advanced concepts you’ll see later on in +the document (like “return converters” and “self converters”). +But we’ll keep it simple for this walkthrough so you can learn.

    +

    Let’s dive in!

    +
      +
    1. Make sure you’re working with a freshly updated checkout +of the CPython trunk.

    2. +
    3. Find a Python builtin that calls either PyArg_ParseTuple() +or PyArg_ParseTupleAndKeywords(), and hasn’t been converted +to work with Argument Clinic yet. +For my example I’m using _pickle.Pickler.dump().

    4. +
    5. If the call to the PyArg_Parse function uses any of the +following format units:

      +
      O&
      +O!
      +es
      +es#
      +et
      +et#
      +
      +
      +

      or if it has multiple calls to PyArg_ParseTuple(), +you should choose a different function. Argument Clinic does +support all of these scenarios. But these are advanced +topics—let’s do something simpler for your first function.

      +

      Also, if the function has multiple calls to PyArg_ParseTuple() +or PyArg_ParseTupleAndKeywords() where it supports different +types for the same argument, or if the function uses something besides +PyArg_Parse functions to parse its arguments, it probably +isn’t suitable for conversion to Argument Clinic. Argument Clinic +doesn’t support generic functions or polymorphic parameters.

      +
    6. +
    7. Add the following boilerplate above the function, creating our block:

      +
      /*[clinic input]
      +[clinic start generated code]*/
      +
      +
      +
    8. +
    9. Cut the docstring and paste it in between the [clinic] lines, +removing all the junk that makes it a properly quoted C string. +When you’re done you should have just the text, based at the left +margin, with no line wider than 80 characters. +(Argument Clinic will preserve indents inside the docstring.)

      +

      If the old docstring had a first line that looked like a function +signature, throw that line away. (The docstring doesn’t need it +anymore—when you use help() on your builtin in the future, +the first line will be built automatically based on the function’s +signature.)

      +

      Sample:

      +
      /*[clinic input]
      +Write a pickled representation of obj to the open file.
      +[clinic start generated code]*/
      +
      +
      +
    10. +
    11. If your docstring doesn’t have a “summary” line, Argument Clinic will +complain. So let’s make sure it has one. The “summary” line should +be a paragraph consisting of a single 80-column line +at the beginning of the docstring.

      +

      (Our example docstring consists solely of a summary line, so the sample +code doesn’t have to change for this step.)

      +
    12. +
    13. Above the docstring, enter the name of the function, followed +by a blank line. This should be the Python name of the function, +and should be the full dotted path +to the function—it should start with the name of the module, +include any sub-modules, and if the function is a method on +a class it should include the class name too.

      +

      Sample:

      +
      /*[clinic input]
      +_pickle.Pickler.dump
      +
      +Write a pickled representation of obj to the open file.
      +[clinic start generated code]*/
      +
      +
      +
    14. +
    15. If this is the first time that module or class has been used with Argument +Clinic in this C file, +you must declare the module and/or class. Proper Argument Clinic hygiene +prefers declaring these in a separate block somewhere near the +top of the C file, in the same way that include files and statics go at +the top. (In our sample code we’ll just show the two blocks next to +each other.)

      +

      The name of the class and module should be the same as the one +seen by Python. Check the name defined in the PyModuleDef +or PyTypeObject as appropriate.

      +

      When you declare a class, you must also specify two aspects of its type +in C: the type declaration you’d use for a pointer to an instance of +this class, and a pointer to the PyTypeObject for this class.

      +

      Sample:

      +
      /*[clinic input]
      +module _pickle
      +class _pickle.Pickler "PicklerObject *" "&Pickler_Type"
      +[clinic start generated code]*/
      +
      +/*[clinic input]
      +_pickle.Pickler.dump
      +
      +Write a pickled representation of obj to the open file.
      +[clinic start generated code]*/
      +
      +
      +
    16. +
    17. Declare each of the parameters to the function. Each parameter +should get its own line. All the parameter lines should be +indented from the function name and the docstring.

      +

      The general form of these parameter lines is as follows:

      +
      name_of_parameter: converter
      +
      +
      +

      If the parameter has a default value, add that after the +converter:

      +
      name_of_parameter: converter = default_value
      +
      +
      +

      Argument Clinic’s support for “default values” is quite sophisticated; +please see the section below on default values +for more information.

      +

      Add a blank line below the parameters.

      +

      What’s a “converter”? It establishes both the type +of the variable used in C, and the method to convert the Python +value into a C value at runtime. +For now you’re going to use what’s called a “legacy converter”—a +convenience syntax intended to make porting old code into Argument +Clinic easier.

      +

      For each parameter, copy the “format unit” for that +parameter from the PyArg_Parse() format argument and +specify that as its converter, as a quoted +string. (“format unit” is the formal name for the one-to-three +character substring of the format parameter that tells +the argument parsing function what the type of the variable +is and how to convert it. For more on format units please +see Parsing arguments and building values.)

      +

      For multicharacter format units like z#, use the +entire two-or-three character string.

      +

      Sample:

      +
       /*[clinic input]
      + module _pickle
      + class _pickle.Pickler "PicklerObject *" "&Pickler_Type"
      + [clinic start generated code]*/
      +
      + /*[clinic input]
      + _pickle.Pickler.dump
      +
      +    obj: 'O'
      +
      +Write a pickled representation of obj to the open file.
      +[clinic start generated code]*/
      +
      +
      +
    18. +
    19. If your function has | in the format string, meaning some +parameters have default values, you can ignore it. Argument +Clinic infers which parameters are optional based on whether +or not they have default values.

      +

      If your function has $ in the format string, meaning it +takes keyword-only arguments, specify * on a line by +itself before the first keyword-only argument, indented the +same as the parameter lines.

      +

      (_pickle.Pickler.dump has neither, so our sample is unchanged.)

      +
    20. +
    21. If the existing C function calls PyArg_ParseTuple() +(as opposed to PyArg_ParseTupleAndKeywords()), then all its +arguments are positional-only.

      +

      To mark all parameters as positional-only in Argument Clinic, +add a / on a line by itself after the last parameter, +indented the same as the parameter lines.

      +

      Currently this is all-or-nothing; either all parameters are +positional-only, or none of them are. (In the future Argument +Clinic may relax this restriction.)

      +

      Sample:

      +
      /*[clinic input]
      +module _pickle
      +class _pickle.Pickler "PicklerObject *" "&Pickler_Type"
      +[clinic start generated code]*/
      +
      +/*[clinic input]
      +_pickle.Pickler.dump
      +
      +    obj: 'O'
      +    /
      +
      +Write a pickled representation of obj to the open file.
      +[clinic start generated code]*/
      +
      +
      +
    22. +
    23. It’s helpful to write a per-parameter docstring for each parameter. +But per-parameter docstrings are optional; you can skip this step +if you prefer.

      +

      Here’s how to add a per-parameter docstring. The first line +of the per-parameter docstring must be indented further than the +parameter definition. The left margin of this first line establishes +the left margin for the whole per-parameter docstring; all the text +you write will be outdented by this amount. You can write as much +text as you like, across multiple lines if you wish.

      +

      Sample:

      +
      /*[clinic input]
      +module _pickle
      +class _pickle.Pickler "PicklerObject *" "&Pickler_Type"
      +[clinic start generated code]*/
      +
      +/*[clinic input]
      +_pickle.Pickler.dump
      +
      +    obj: 'O'
      +        The object to be pickled.
      +    /
      +
      +Write a pickled representation of obj to the open file.
      +[clinic start generated code]*/
      +
      +
      +
    24. +
    25. Save and close the file, then run Tools/clinic/clinic.py on +it. With luck everything worked—your block now has output, and +a .c.h file has been generated! Reopen the file in your +text editor to see:

      +
      /*[clinic input]
      +_pickle.Pickler.dump
      +
      +    obj: 'O'
      +        The object to be pickled.
      +    /
      +
      +Write a pickled representation of obj to the open file.
      +[clinic start generated code]*/
      +
      +static PyObject *
      +_pickle_Pickler_dump(PicklerObject *self, PyObject *obj)
      +/*[clinic end generated code: output=87ecad1261e02ac7 input=552eb1c0f52260d9]*/
      +
      +
      +

      Obviously, if Argument Clinic didn’t produce any output, it’s because +it found an error in your input. Keep fixing your errors and retrying +until Argument Clinic processes your file without complaint.

      +

      For readability, most of the glue code has been generated to a .c.h +file. You’ll need to include that in your original .c file, +typically right after the clinic module block:

      +
      #include "clinic/_pickle.c.h"
      +
      +
      +
    26. +
    27. Double-check that the argument-parsing code Argument Clinic generated +looks basically the same as the existing code.

      +

      First, ensure both places use the same argument-parsing function. +The existing code must call either +PyArg_ParseTuple() or PyArg_ParseTupleAndKeywords(); +ensure that the code generated by Argument Clinic calls the +exact same function.

      +

      Second, the format string passed in to PyArg_ParseTuple() or +PyArg_ParseTupleAndKeywords() should be exactly the same +as the hand-written one in the existing function, up to the colon +or semi-colon.

      +

      (Argument Clinic always generates its format strings +with a : followed by the name of the function. If the +existing code’s format string ends with ;, to provide +usage help, this change is harmless—don’t worry about it.)

      +

      Third, for parameters whose format units require two arguments +(like a length variable, or an encoding string, or a pointer +to a conversion function), ensure that the second argument is +exactly the same between the two invocations.

      +

      Fourth, inside the output portion of the block you’ll find a preprocessor +macro defining the appropriate static PyMethodDef structure for +this builtin:

      +
      #define __PICKLE_PICKLER_DUMP_METHODDEF    \
      +{"dump", (PyCFunction)__pickle_Pickler_dump, METH_O, __pickle_Pickler_dump__doc__},
      +
      +
      +

      This static structure should be exactly the same as the existing static +PyMethodDef structure for this builtin.

      +

      If any of these items differ in any way, +adjust your Argument Clinic function specification and rerun +Tools/clinic/clinic.py until they are the same.

      +
    28. +
    29. Notice that the last line of its output is the declaration +of your “impl” function. This is where the builtin’s implementation goes. +Delete the existing prototype of the function you’re modifying, but leave +the opening curly brace. Now delete its argument parsing code and the +declarations of all the variables it dumps the arguments into. +Notice how the Python arguments are now arguments to this impl function; +if the implementation used different names for these variables, fix it.

      +

      Let’s reiterate, just because it’s kind of weird. Your code should now +look like this:

      +
      static return_type
      +your_function_impl(...)
      +/*[clinic end generated code: checksum=...]*/
      +{
      +...
      +
      +
      +

      Argument Clinic generated the checksum line and the function prototype just +above it. You should write the opening (and closing) curly braces for the +function, and the implementation inside.

      +

      Sample:

      +
      /*[clinic input]
      +module _pickle
      +class _pickle.Pickler "PicklerObject *" "&Pickler_Type"
      +[clinic start generated code]*/
      +/*[clinic end generated code: checksum=da39a3ee5e6b4b0d3255bfef95601890afd80709]*/
      +
      +/*[clinic input]
      +_pickle.Pickler.dump
      +
      +    obj: 'O'
      +        The object to be pickled.
      +    /
      +
      +Write a pickled representation of obj to the open file.
      +[clinic start generated code]*/
      +
      +PyDoc_STRVAR(__pickle_Pickler_dump__doc__,
      +"Write a pickled representation of obj to the open file.\n"
      +"\n"
      +...
      +static PyObject *
      +_pickle_Pickler_dump_impl(PicklerObject *self, PyObject *obj)
      +/*[clinic end generated code: checksum=3bd30745bf206a48f8b576a1da3d90f55a0a4187]*/
      +{
      +    /* Check whether the Pickler was initialized correctly (issue3664).
      +       Developers often forget to call __init__() in their subclasses, which
      +       would trigger a segfault without this check. */
      +    if (self->write == NULL) {
      +        PyErr_Format(PicklingError,
      +                     "Pickler.__init__() was not called by %s.__init__()",
      +                     Py_TYPE(self)->tp_name);
      +        return NULL;
      +    }
      +
      +    if (_Pickler_ClearBuffer(self) < 0)
      +        return NULL;
      +
      +    ...
      +
      +
      +
    30. +
    31. Remember the macro with the PyMethodDef structure for this +function? Find the existing PyMethodDef structure for this +function and replace it with a reference to the macro. (If the builtin +is at module scope, this will probably be very near the end of the file; +if the builtin is a class method, this will probably be below but relatively +near to the implementation.)

      +

      Note that the body of the macro contains a trailing comma. So when you +replace the existing static PyMethodDef structure with the macro, +don’t add a comma to the end.

      +

      Sample:

      +
      static struct PyMethodDef Pickler_methods[] = {
      +    __PICKLE_PICKLER_DUMP_METHODDEF
      +    __PICKLE_PICKLER_CLEAR_MEMO_METHODDEF
      +    {NULL, NULL}                /* sentinel */
      +};
      +
      +
      +
    32. +
    33. Compile, then run the relevant portions of the regression-test suite. +This change should not introduce any new compile-time warnings or errors, +and there should be no externally-visible change to Python’s behavior.

      +

      Well, except for one difference: inspect.signature() run on your function +should now provide a valid signature!

      +

      Congratulations, you’ve ported your first function to work with Argument Clinic!

      +
    34. +
    +
    +
    +

    Advanced Topics

    +

    Now that you’ve had some experience working with Argument Clinic, it’s time +for some advanced topics.

    +
    +

    Symbolic default values

    +

    The default value you provide for a parameter can’t be any arbitrary +expression. Currently the following are explicitly supported:

    +
      +
    • Numeric constants (integer and float)

    • +
    • String constants

    • +
    • True, False, and None

    • +
    • Simple symbolic constants like sys.maxsize, which must +start with the name of the module

    • +
    +

    In case you’re curious, this is implemented in from_builtin() +in Lib/inspect.py.

    +

    (In the future, this may need to get even more elaborate, +to allow full expressions like CONSTANT - 1.)

    +
    +
    +

    Renaming the C functions and variables generated by Argument Clinic

    +

    Argument Clinic automatically names the functions it generates for you. +Occasionally this may cause a problem, if the generated name collides with +the name of an existing C function. There’s an easy solution: override the names +used for the C functions. Just add the keyword "as" +to your function declaration line, followed by the function name you wish to use. +Argument Clinic will use that function name for the base (generated) function, +then add "_impl" to the end and use that for the name of the impl function.

    +

    For example, if we wanted to rename the C function names generated for +pickle.Pickler.dump, it’d look like this:

    +
    /*[clinic input]
    +pickle.Pickler.dump as pickler_dumper
    +
    +...
    +
    +
    +

    The base function would now be named pickler_dumper(), +and the impl function would now be named pickler_dumper_impl().

    +

    Similarly, you may have a problem where you want to give a parameter +a specific Python name, but that name may be inconvenient in C. Argument +Clinic allows you to give a parameter different names in Python and in C, +using the same "as" syntax:

    +
    /*[clinic input]
    +pickle.Pickler.dump
    +
    +    obj: object
    +    file as file_obj: object
    +    protocol: object = NULL
    +    *
    +    fix_imports: bool = True
    +
    +
    +

    Here, the name used in Python (in the signature and the keywords +array) would be file, but the C variable would be named file_obj.

    +

    You can use this to rename the self parameter too!

    +
    +
    +

    Converting functions using PyArg_UnpackTuple

    +

    To convert a function parsing its arguments with PyArg_UnpackTuple(), +simply write out all the arguments, specifying each as an object. You +may specify the type argument to cast the type as appropriate. All +arguments should be marked positional-only (add a / on a line by itself +after the last argument).

    +

    Currently the generated code will use PyArg_ParseTuple(), but this +will change soon.

    +
    +
    +

    Optional Groups

    +

    Some legacy functions have a tricky approach to parsing their arguments: +they count the number of positional arguments, then use a switch statement +to call one of several different PyArg_ParseTuple() calls depending on +how many positional arguments there are. (These functions cannot accept +keyword-only arguments.) This approach was used to simulate optional +arguments back before PyArg_ParseTupleAndKeywords() was created.

    +

    While functions using this approach can often be converted to +use PyArg_ParseTupleAndKeywords(), optional arguments, and default values, +it’s not always possible. Some of these legacy functions have +behaviors PyArg_ParseTupleAndKeywords() doesn’t directly support. +The most obvious example is the builtin function range(), which has +an optional argument on the left side of its required argument! +Another example is curses.window.addch(), which has a group of two +arguments that must always be specified together. (The arguments are +called x and y; if you call the function passing in x, +you must also pass in y—and if you don’t pass in x you may not +pass in y either.)

    +

    In any case, the goal of Argument Clinic is to support argument parsing +for all existing CPython builtins without changing their semantics. +Therefore Argument Clinic supports +this alternate approach to parsing, using what are called optional groups. +Optional groups are groups of arguments that must all be passed in together. +They can be to the left or the right of the required arguments. They +can only be used with positional-only parameters.

    +
    +

    Note

    +

    Optional groups are only intended for use when converting +functions that make multiple calls to PyArg_ParseTuple()! +Functions that use any other approach for parsing arguments +should almost never be converted to Argument Clinic using +optional groups. Functions using optional groups currently +cannot have accurate signatures in Python, because Python just +doesn’t understand the concept. Please avoid using optional +groups wherever possible.

    +
    +

    To specify an optional group, add a [ on a line by itself before +the parameters you wish to group together, and a ] on a line by itself +after these parameters. As an example, here’s how curses.window.addch +uses optional groups to make the first two parameters and the last +parameter optional:

    +
    /*[clinic input]
    +
    +curses.window.addch
    +
    +    [
    +    x: int
    +      X-coordinate.
    +    y: int
    +      Y-coordinate.
    +    ]
    +
    +    ch: object
    +      Character to add.
    +
    +    [
    +    attr: long
    +      Attributes for the character.
    +    ]
    +    /
    +
    +...
    +
    +
    +

    Notes:

    +
      +
    • For every optional group, one additional parameter will be passed into the +impl function representing the group. The parameter will be an int named +group_{direction}_{number}, +where {direction} is either right or left depending on whether the group +is before or after the required parameters, and {number} is a monotonically +increasing number (starting at 1) indicating how far away the group is from +the required parameters. When the impl is called, this parameter will be set +to zero if this group was unused, and set to non-zero if this group was used. +(By used or unused, I mean whether or not the parameters received arguments +in this invocation.)

    • +
    • If there are no required arguments, the optional groups will behave +as if they’re to the right of the required arguments.

    • +
    • In the case of ambiguity, the argument parsing code +favors parameters on the left (before the required parameters).

    • +
    • Optional groups can only contain positional-only parameters.

    • +
    • Optional groups are only intended for legacy code. Please do not +use optional groups for new code.

    • +
    +
    +
    +

    Using real Argument Clinic converters, instead of “legacy converters”

    +

    To save time, and to minimize how much you need to learn +to achieve your first port to Argument Clinic, the walkthrough above tells +you to use “legacy converters”. “Legacy converters” are a convenience, +designed explicitly to make porting existing code to Argument Clinic +easier. And to be clear, their use is acceptable when porting code for +Python 3.4.

    +

    However, in the long term we probably want all our blocks to +use Argument Clinic’s real syntax for converters. Why? A couple +reasons:

    +
      +
    • The proper converters are far easier to read and clearer in their intent.

    • +
    • There are some format units that are unsupported as “legacy converters”, +because they require arguments, and the legacy converter syntax doesn’t +support specifying arguments.

    • +
    • In the future we may have a new argument parsing library that isn’t +restricted to what PyArg_ParseTuple() supports; this flexibility +won’t be available to parameters using legacy converters.

    • +
    +

    Therefore, if you don’t mind a little extra effort, please use the normal +converters instead of legacy converters.

    +

    In a nutshell, the syntax for Argument Clinic (non-legacy) converters +looks like a Python function call. However, if there are no explicit +arguments to the function (all functions take their default values), +you may omit the parentheses. Thus bool and bool() are exactly +the same converters.

    +

    All arguments to Argument Clinic converters are keyword-only. +All Argument Clinic converters accept the following arguments:

    +
    +
    +
    c_default

    The default value for this parameter when defined in C. +Specifically, this will be the initializer for the variable declared +in the “parse function”. See the section on default values +for how to use this. +Specified as a string.

    +
    +
    annotation

    The annotation value for this parameter. Not currently supported, +because PEP 8 mandates that the Python library may not use +annotations.

    +
    +
    +
    +

    In addition, some converters accept additional arguments. Here is a list +of these arguments, along with their meanings:

    +
    +
    +
    accept

    A set of Python types (and possibly pseudo-types); +this restricts the allowable Python argument to values of these types. +(This is not a general-purpose facility; as a rule it only supports +specific lists of types as shown in the legacy converter table.)

    +

    To accept None, add NoneType to this set.

    +
    +
    bitwise

    Only supported for unsigned integers. The native integer value of this +Python argument will be written to the parameter without any range checking, +even for negative values.

    +
    +
    converter

    Only supported by the object converter. Specifies the name of a +C “converter function” +to use to convert this object to a native type.

    +
    +
    encoding

    Only supported for strings. Specifies the encoding to use when converting +this string from a Python str (Unicode) value into a C char * value.

    +
    +
    subclass_of

    Only supported for the object converter. Requires that the Python +value be a subclass of a Python type, as expressed in C.

    +
    +
    type

    Only supported for the object and self converters. Specifies +the C type that will be used to declare the variable. Default value is +"PyObject *".

    +
    +
    zeroes

    Only supported for strings. If true, embedded NUL bytes ('\\0') are +permitted inside the value. The length of the string will be passed in +to the impl function, just after the string parameter, as a parameter named +<parameter_name>_length.

    +
    +
    +
    +

    Please note, not every possible combination of arguments will work. +Usually these arguments are implemented by specific PyArg_ParseTuple +format units, with specific behavior. For example, currently you cannot +call unsigned_short without also specifying bitwise=True. +Although it’s perfectly reasonable to think this would work, these semantics don’t +map to any existing format unit. So Argument Clinic doesn’t support it. (Or, at +least, not yet.)

    +

    Below is a table showing the mapping of legacy converters into real +Argument Clinic converters. On the left is the legacy converter, +on the right is the text you’d replace it with.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    'B'

    unsigned_char(bitwise=True)

    'b'

    unsigned_char

    'c'

    char

    'C'

    int(accept={str})

    'd'

    double

    'D'

    Py_complex

    'es'

    str(encoding='name_of_encoding')

    'es#'

    str(encoding='name_of_encoding', zeroes=True)

    'et'

    str(encoding='name_of_encoding', accept={bytes, bytearray, str})

    'et#'

    str(encoding='name_of_encoding', accept={bytes, bytearray, str}, zeroes=True)

    'f'

    float

    'h'

    short

    'H'

    unsigned_short(bitwise=True)

    'i'

    int

    'I'

    unsigned_int(bitwise=True)

    'k'

    unsigned_long(bitwise=True)

    'K'

    unsigned_long_long(bitwise=True)

    'l'

    long

    'L'

    long long

    'n'

    Py_ssize_t

    'O'

    object

    'O!'

    object(subclass_of='&PySomething_Type')

    'O&'

    object(converter='name_of_c_function')

    'p'

    bool

    'S'

    PyBytesObject

    's'

    str

    's#'

    str(zeroes=True)

    's*'

    Py_buffer(accept={buffer, str})

    'U'

    unicode

    'u'

    Py_UNICODE

    'u#'

    Py_UNICODE(zeroes=True)

    'w*'

    Py_buffer(accept={rwbuffer})

    'Y'

    PyByteArrayObject

    'y'

    str(accept={bytes})

    'y#'

    str(accept={robuffer}, zeroes=True)

    'y*'

    Py_buffer

    'Z'

    Py_UNICODE(accept={str, NoneType})

    'Z#'

    Py_UNICODE(accept={str, NoneType}, zeroes=True)

    'z'

    str(accept={str, NoneType})

    'z#'

    str(accept={str, NoneType}, zeroes=True)

    'z*'

    Py_buffer(accept={buffer, str, NoneType})

    +

    As an example, here’s our sample pickle.Pickler.dump using the proper +converter:

    +
    /*[clinic input]
    +pickle.Pickler.dump
    +
    +    obj: object
    +        The object to be pickled.
    +    /
    +
    +Write a pickled representation of obj to the open file.
    +[clinic start generated code]*/
    +
    +
    +

    Argument Clinic will show you all the converters it has +available. For each converter it’ll show you all the parameters +it accepts, along with the default value for each parameter. +Just run Tools/clinic/clinic.py --converters to see the full list.

    +
    +
    +

    Py_buffer

    +

    When using the Py_buffer converter +(or the 's*', 'w*', '*y', or 'z*' legacy converters), +you must not call PyBuffer_Release() on the provided buffer. +Argument Clinic generates code that does it for you (in the parsing function).

    +
    +
    +

    Advanced converters

    +

    Remember those format units you skipped for your first +time because they were advanced? Here’s how to handle those too.

    +

    The trick is, all those format units take arguments—either +conversion functions, or types, or strings specifying an encoding. +(But “legacy converters” don’t support arguments. That’s why we +skipped them for your first function.) The argument you specified +to the format unit is now an argument to the converter; this +argument is either converter (for O&), subclass_of (for O!), +or encoding (for all the format units that start with e).

    +

    When using subclass_of, you may also want to use the other +custom argument for object(): type, which lets you set the type +actually used for the parameter. For example, if you want to ensure +that the object is a subclass of PyUnicode_Type, you probably want +to use the converter object(type='PyUnicodeObject *', subclass_of='&PyUnicode_Type').

    +

    One possible problem with using Argument Clinic: it takes away some possible +flexibility for the format units starting with e. When writing a +PyArg_Parse call by hand, you could theoretically decide at runtime what +encoding string to pass in to PyArg_ParseTuple(). But now this string must +be hard-coded at Argument-Clinic-preprocessing-time. This limitation is deliberate; +it made supporting this format unit much easier, and may allow for future optimizations. +This restriction doesn’t seem unreasonable; CPython itself always passes in static +hard-coded encoding strings for parameters whose format units start with e.

    +
    +
    +

    Parameter default values

    +

    Default values for parameters can be any of a number of values. +At their simplest, they can be string, int, or float literals:

    +
    foo: str = "abc"
    +bar: int = 123
    +bat: float = 45.6
    +
    +
    +

    They can also use any of Python’s built-in constants:

    +
    yep:  bool = True
    +nope: bool = False
    +nada: object = None
    +
    +
    +

    There’s also special support for a default value of NULL, and +for simple expressions, documented in the following sections.

    +
    +
    +

    The NULL default value

    +

    For string and object parameters, you can set them to None to indicate +that there’s no default. However, that means the C variable will be +initialized to Py_None. For convenience’s sakes, there’s a special +value called NULL for just this reason: from Python’s perspective it +behaves like a default value of None, but the C variable is initialized +with NULL.

    +
    +
    +

    Expressions specified as default values

    +

    The default value for a parameter can be more than just a literal value. +It can be an entire expression, using math operators and looking up attributes +on objects. However, this support isn’t exactly simple, because of some +non-obvious semantics.

    +

    Consider the following example:

    +
    foo: Py_ssize_t = sys.maxsize - 1
    +
    +
    +

    sys.maxsize can have different values on different platforms. Therefore +Argument Clinic can’t simply evaluate that expression locally and hard-code it +in C. So it stores the default in such a way that it will get evaluated at +runtime, when the user asks for the function’s signature.

    +

    What namespace is available when the expression is evaluated? It’s evaluated +in the context of the module the builtin came from. So, if your module has an +attribute called “max_widgets”, you may simply use it:

    +
    foo: Py_ssize_t = max_widgets
    +
    +
    +

    If the symbol isn’t found in the current module, it fails over to looking in +sys.modules. That’s how it can find sys.maxsize for example. (Since you +don’t know in advance what modules the user will load into their interpreter, +it’s best to restrict yourself to modules that are preloaded by Python itself.)

    +

    Evaluating default values only at runtime means Argument Clinic can’t compute +the correct equivalent C default value. So you need to tell it explicitly. +When you use an expression, you must also specify the equivalent expression +in C, using the c_default parameter to the converter:

    +
    foo: Py_ssize_t(c_default="PY_SSIZE_T_MAX - 1") = sys.maxsize - 1
    +
    +
    +

    Another complication: Argument Clinic can’t know in advance whether or not the +expression you supply is valid. It parses it to make sure it looks legal, but +it can’t actually know. You must be very careful when using expressions to +specify values that are guaranteed to be valid at runtime!

    +

    Finally, because expressions must be representable as static C values, there +are many restrictions on legal expressions. Here’s a list of Python features +you’re not permitted to use:

    +
      +
    • Function calls.

    • +
    • Inline if statements (3 if foo else 5).

    • +
    • Automatic sequence unpacking (*[1, 2, 3]).

    • +
    • List/set/dict comprehensions and generator expressions.

    • +
    • Tuple/list/set/dict literals.

    • +
    +
    +
    +

    Using a return converter

    +

    By default the impl function Argument Clinic generates for you returns PyObject *. +But your C function often computes some C type, then converts it into the PyObject * +at the last moment. Argument Clinic handles converting your inputs from Python types +into native C types—why not have it convert your return value from a native C type +into a Python type too?

    +

    That’s what a “return converter” does. It changes your impl function to return +some C type, then adds code to the generated (non-impl) function to handle converting +that value into the appropriate PyObject *.

    +

    The syntax for return converters is similar to that of parameter converters. +You specify the return converter like it was a return annotation on the +function itself. Return converters behave much the same as parameter converters; +they take arguments, the arguments are all keyword-only, and if you’re not changing +any of the default arguments you can omit the parentheses.

    +

    (If you use both "as" and a return converter for your function, +the "as" should come before the return converter.)

    +

    There’s one additional complication when using return converters: how do you +indicate an error has occurred? Normally, a function returns a valid (non-NULL) +pointer for success, and NULL for failure. But if you use an integer return converter, +all integers are valid. How can Argument Clinic detect an error? Its solution: each return +converter implicitly looks for a special value that indicates an error. If you return +that value, and an error has been set (PyErr_Occurred() returns a true +value), then the generated code will propagate the error. Otherwise it will +encode the value you return like normal.

    +

    Currently Argument Clinic supports only a few return converters:

    +
    bool
    +int
    +unsigned int
    +long
    +unsigned int
    +size_t
    +Py_ssize_t
    +float
    +double
    +DecodeFSDefault
    +
    +
    +

    None of these take parameters. For the first three, return -1 to indicate +error. For DecodeFSDefault, the return type is const char *; return a NULL +pointer to indicate an error.

    +

    (There’s also an experimental NoneType converter, which lets you +return Py_None on success or NULL on failure, without having +to increment the reference count on Py_None. I’m not sure it adds +enough clarity to be worth using.)

    +

    To see all the return converters Argument Clinic supports, along with +their parameters (if any), +just run Tools/clinic/clinic.py --converters for the full list.

    +
    +
    +

    Cloning existing functions

    +

    If you have a number of functions that look similar, you may be able to +use Clinic’s “clone” feature. When you clone an existing function, +you reuse:

    +
      +
    • its parameters, including

      +
        +
      • their names,

      • +
      • their converters, with all parameters,

      • +
      • their default values,

      • +
      • their per-parameter docstrings,

      • +
      • their kind (whether they’re positional only, +positional or keyword, or keyword only), and

      • +
      +
    • +
    • its return converter.

    • +
    +

    The only thing not copied from the original function is its docstring; +the syntax allows you to specify a new docstring.

    +

    Here’s the syntax for cloning a function:

    +
    /*[clinic input]
    +module.class.new_function [as c_basename] = module.class.existing_function
    +
    +Docstring for new_function goes here.
    +[clinic start generated code]*/
    +
    +
    +

    (The functions can be in different modules or classes. I wrote +module.class in the sample just to illustrate that you must +use the full path to both functions.)

    +

    Sorry, there’s no syntax for partially-cloning a function, or cloning a function +then modifying it. Cloning is an all-or nothing proposition.

    +

    Also, the function you are cloning from must have been previously defined +in the current file.

    +
    +
    +

    Calling Python code

    +

    The rest of the advanced topics require you to write Python code +which lives inside your C file and modifies Argument Clinic’s +runtime state. This is simple: you simply define a Python block.

    +

    A Python block uses different delimiter lines than an Argument +Clinic function block. It looks like this:

    +
    /*[python input]
    +# python code goes here
    +[python start generated code]*/
    +
    +
    +

    All the code inside the Python block is executed at the +time it’s parsed. All text written to stdout inside the block +is redirected into the “output” after the block.

    +

    As an example, here’s a Python block that adds a static integer +variable to the C code:

    +
    /*[python input]
    +print('static int __ignored_unused_variable__ = 0;')
    +[python start generated code]*/
    +static int __ignored_unused_variable__ = 0;
    +/*[python checksum:...]*/
    +
    +
    +
    +
    +

    Using a “self converter”

    +

    Argument Clinic automatically adds a “self” parameter for you +using a default converter. It automatically sets the type +of this parameter to the “pointer to an instance” you specified +when you declared the type. However, you can override +Argument Clinic’s converter and specify one yourself. +Just add your own self parameter as the first parameter in a +block, and ensure that its converter is an instance of +self_converter or a subclass thereof.

    +

    What’s the point? This lets you override the type of self, +or give it a different default name.

    +

    How do you specify the custom type you want to cast self to? +If you only have one or two functions with the same type for self, +you can directly use Argument Clinic’s existing self converter, +passing in the type you want to use as the type parameter:

    +
    /*[clinic input]
    +
    +_pickle.Pickler.dump
    +
    +  self: self(type="PicklerObject *")
    +  obj: object
    +  /
    +
    +Write a pickled representation of the given object to the open file.
    +[clinic start generated code]*/
    +
    +
    +

    On the other hand, if you have a lot of functions that will use the same +type for self, it’s best to create your own converter, subclassing +self_converter but overwriting the type member:

    +
    /*[python input]
    +class PicklerObject_converter(self_converter):
    +    type = "PicklerObject *"
    +[python start generated code]*/
    +
    +/*[clinic input]
    +
    +_pickle.Pickler.dump
    +
    +  self: PicklerObject
    +  obj: object
    +  /
    +
    +Write a pickled representation of the given object to the open file.
    +[clinic start generated code]*/
    +
    +
    +
    +
    +

    Writing a custom converter

    +

    As we hinted at in the previous section… you can write your own converters! +A converter is simply a Python class that inherits from CConverter. +The main purpose of a custom converter is if you have a parameter using +the O& format unit—parsing this parameter means calling +a PyArg_ParseTuple() “converter function”.

    +

    Your converter class should be named *something*_converter. +If the name follows this convention, then your converter class +will be automatically registered with Argument Clinic; its name +will be the name of your class with the _converter suffix +stripped off. (This is accomplished with a metaclass.)

    +

    You shouldn’t subclass CConverter.__init__. Instead, you should +write a converter_init() function. converter_init() +always accepts a self parameter; after that, all additional +parameters must be keyword-only. Any arguments passed in to +the converter in Argument Clinic will be passed along to your +converter_init().

    +

    There are some additional members of CConverter you may wish +to specify in your subclass. Here’s the current list:

    +
    +
    type

    The C type to use for this variable. +type should be a Python string specifying the type, e.g. int. +If this is a pointer type, the type string should end with ' *'.

    +
    +
    default

    The Python default value for this parameter, as a Python value. +Or the magic value unspecified if there is no default.

    +
    +
    py_default

    default as it should appear in Python code, +as a string. +Or None if there is no default.

    +
    +
    c_default

    default as it should appear in C code, +as a string. +Or None if there is no default.

    +
    +
    c_ignored_default

    The default value used to initialize the C variable when +there is no default, but not specifying a default may +result in an “uninitialized variable” warning. This can +easily happen when using option groups—although +properly-written code will never actually use this value, +the variable does get passed in to the impl, and the +C compiler will complain about the “use” of the +uninitialized value. This value should always be a +non-empty string.

    +
    +
    converter

    The name of the C converter function, as a string.

    +
    +
    impl_by_reference

    A boolean value. If true, +Argument Clinic will add a & in front of the name of +the variable when passing it into the impl function.

    +
    +
    parse_by_reference

    A boolean value. If true, +Argument Clinic will add a & in front of the name of +the variable when passing it into PyArg_ParseTuple().

    +
    +
    +

    Here’s the simplest example of a custom converter, from Modules/zlibmodule.c:

    +
    /*[python input]
    +
    +class ssize_t_converter(CConverter):
    +    type = 'Py_ssize_t'
    +    converter = 'ssize_t_converter'
    +
    +[python start generated code]*/
    +/*[python end generated code: output=da39a3ee5e6b4b0d input=35521e4e733823c7]*/
    +
    +
    +

    This block adds a converter to Argument Clinic named ssize_t. Parameters +declared as ssize_t will be declared as type Py_ssize_t, and will +be parsed by the 'O&' format unit, which will call the +ssize_t_converter converter function. ssize_t variables +automatically support default values.

    +

    More sophisticated custom converters can insert custom C code to +handle initialization and cleanup. +You can see more examples of custom converters in the CPython +source tree; grep the C files for the string CConverter.

    +
    +
    +

    Writing a custom return converter

    +

    Writing a custom return converter is much like writing +a custom converter. Except it’s somewhat simpler, because return +converters are themselves much simpler.

    +

    Return converters must subclass CReturnConverter. +There are no examples yet of custom return converters, +because they are not widely used yet. If you wish to +write your own return converter, please read Tools/clinic/clinic.py, +specifically the implementation of CReturnConverter and +all its subclasses.

    +
    +
    +

    METH_O and METH_NOARGS

    +

    To convert a function using METH_O, make sure the function’s +single argument is using the object converter, and mark the +arguments as positional-only:

    +
    /*[clinic input]
    +meth_o_sample
    +
    +     argument: object
    +     /
    +[clinic start generated code]*/
    +
    +
    +

    To convert a function using METH_NOARGS, just don’t specify +any arguments.

    +

    You can still use a self converter, a return converter, and specify +a type argument to the object converter for METH_O.

    +
    +
    +

    tp_new and tp_init functions

    +

    You can convert tp_new and tp_init functions. Just name +them __new__ or __init__ as appropriate. Notes:

    +
      +
    • The function name generated for __new__ doesn’t end in __new__ +like it would by default. It’s just the name of the class, converted +into a valid C identifier.

    • +
    • No PyMethodDef #define is generated for these functions.

    • +
    • __init__ functions return int, not PyObject *.

    • +
    • Use the docstring as the class docstring.

    • +
    • Although __new__ and __init__ functions must always +accept both the args and kwargs objects, when converting +you may specify any signature for these functions that you like. +(If your function doesn’t support keywords, the parsing function +generated will throw an exception if it receives any.)

    • +
    +
    +
    +

    Changing and redirecting Clinic’s output

    +

    It can be inconvenient to have Clinic’s output interspersed with +your conventional hand-edited C code. Luckily, Clinic is configurable: +you can buffer up its output for printing later (or earlier!), or write +its output to a separate file. You can also add a prefix or suffix to +every line of Clinic’s generated output.

    +

    While changing Clinic’s output in this manner can be a boon to readability, +it may result in Clinic code using types before they are defined, or +your code attempting to use Clinic-generated code before it is defined. +These problems can be easily solved by rearranging the declarations in your file, +or moving where Clinic’s generated code goes. (This is why the default behavior +of Clinic is to output everything into the current block; while many people +consider this hampers readability, it will never require rearranging your +code to fix definition-before-use problems.)

    +

    Let’s start with defining some terminology:

    +
    +
    field

    A field, in this context, is a subsection of Clinic’s output. +For example, the #define for the PyMethodDef structure +is a field, called methoddef_define. Clinic has seven +different fields it can output per function definition:

    +
    docstring_prototype
    +docstring_definition
    +methoddef_define
    +impl_prototype
    +parser_prototype
    +parser_definition
    +impl_definition
    +
    +
    +

    All the names are of the form "<a>_<b>", +where "<a>" is the semantic object represented (the parsing function, +the impl function, the docstring, or the methoddef structure) and "<b>" +represents what kind of statement the field is. Field names that end in +"_prototype" +represent forward declarations of that thing, without the actual body/data +of the thing; field names that end in "_definition" represent the actual +definition of the thing, with the body/data of the thing. ("methoddef" +is special, it’s the only one that ends with "_define", representing that +it’s a preprocessor #define.)

    +
    +
    destination

    A destination is a place Clinic can write output to. There are +five built-in destinations:

    +
    +
    block

    The default destination: printed in the output section of +the current Clinic block.

    +
    +
    buffer

    A text buffer where you can save text for later. Text sent +here is appended to the end of any existing text. It’s an +error to have any text left in the buffer when Clinic finishes +processing a file.

    +
    +
    file

    A separate “clinic file” that will be created automatically by Clinic. +The filename chosen for the file is {basename}.clinic{extension}, +where basename and extension were assigned the output +from os.path.splitext() run on the current file. (Example: +the file destination for _pickle.c would be written to +_pickle.clinic.c.)

    +

    Important: When using a file destination, you +must check in the generated file!

    +
    +
    two-pass

    A buffer like buffer. However, a two-pass buffer can only +be dumped once, and it prints out all text sent to it during +all processing, even from Clinic blocks after the dumping point.

    +
    +
    suppress

    The text is suppressed—thrown away.

    +
    +
    +
    +
    +

    Clinic defines five new directives that let you reconfigure its output.

    +

    The first new directive is dump:

    +
    dump <destination>
    +
    +
    +

    This dumps the current contents of the named destination into the output of +the current block, and empties it. This only works with buffer and +two-pass destinations.

    +

    The second new directive is output. The most basic form of output +is like this:

    +
    output <field> <destination>
    +
    +
    +

    This tells Clinic to output field to destination. output also +supports a special meta-destination, called everything, which tells +Clinic to output all fields to that destination.

    +

    output has a number of other functions:

    +
    output push
    +output pop
    +output preset <preset>
    +
    +
    +

    output push and output pop allow you to push and pop +configurations on an internal configuration stack, so that you +can temporarily modify the output configuration, then easily restore +the previous configuration. Simply push before your change to save +the current configuration, then pop when you wish to restore the +previous configuration.

    +

    output preset sets Clinic’s output to one of several built-in +preset configurations, as follows:

    +
    +
    +
    block

    Clinic’s original starting configuration. Writes everything +immediately after the input block.

    +

    Suppress the parser_prototype +and docstring_prototype, write everything else to block.

    +
    +
    file

    Designed to write everything to the “clinic file” that it can. +You then #include this file near the top of your file. +You may need to rearrange your file to make this work, though +usually this just means creating forward declarations for various +typedef and PyTypeObject definitions.

    +

    Suppress the parser_prototype +and docstring_prototype, write the impl_definition to +block, and write everything else to file.

    +

    The default filename is "{dirname}/clinic/{basename}.h".

    +
    +
    buffer

    Save up most of the output from Clinic, to be written into +your file near the end. For Python files implementing modules +or builtin types, it’s recommended that you dump the buffer +just above the static structures for your module or +builtin type; these are normally very near the end. Using +buffer may require even more editing than file, if +your file has static PyMethodDef arrays defined in the +middle of the file.

    +

    Suppress the parser_prototype, impl_prototype, +and docstring_prototype, write the impl_definition to +block, and write everything else to file.

    +
    +
    two-pass

    Similar to the buffer preset, but writes forward declarations to +the two-pass buffer, and definitions to the buffer. +This is similar to the buffer preset, but may require +less editing than buffer. Dump the two-pass buffer +near the top of your file, and dump the buffer near +the end just like you would when using the buffer preset.

    +

    Suppresses the impl_prototype, write the impl_definition +to block, write docstring_prototype, methoddef_define, +and parser_prototype to two-pass, write everything else +to buffer.

    +
    +
    partial-buffer

    Similar to the buffer preset, but writes more things to block, +only writing the really big chunks of generated code to buffer. +This avoids the definition-before-use problem of buffer completely, +at the small cost of having slightly more stuff in the block’s output. +Dump the buffer near the end, just like you would when using +the buffer preset.

    +

    Suppresses the impl_prototype, write the docstring_definition +and parser_definition to buffer, write everything else to block.

    +
    +
    +
    +

    The third new directive is destination:

    +
    destination <name> <command> [...]
    +
    +
    +

    This performs an operation on the destination named name.

    +

    There are two defined subcommands: new and clear.

    +

    The new subcommand works like this:

    +
    destination <name> new <type>
    +
    +
    +

    This creates a new destination with name <name> and type <type>.

    +

    There are five destination types:

    +
    +
    +
    suppress

    Throws the text away.

    +
    +
    block

    Writes the text to the current block. This is what Clinic +originally did.

    +
    +
    buffer

    A simple text buffer, like the “buffer” builtin destination above.

    +
    +
    file

    A text file. The file destination takes an extra argument, +a template to use for building the filename, like so:

    +
    +

    destination <name> new <type> <file_template>

    +
    +

    The template can use three strings internally that will be replaced +by bits of the filename:

    +
    +
    +
    {path}

    The full path to the file, including directory and full filename.

    +
    +
    {dirname}

    The name of the directory the file is in.

    +
    +
    {basename}

    Just the name of the file, not including the directory.

    +
    +
    {basename_root}

    Basename with the extension clipped off +(everything up to but not including the last ‘.’).

    +
    +
    {basename_extension}

    The last ‘.’ and everything after it. If the basename +does not contain a period, this will be the empty string.

    +
    +
    +
    +

    If there are no periods in the filename, {basename} and {filename} +are the same, and {extension} is empty. “{basename}{extension}” +is always exactly the same as “{filename}”.”

    +
    +
    two-pass

    A two-pass buffer, like the “two-pass” builtin destination above.

    +
    +
    +
    +

    The clear subcommand works like this:

    +
    destination <name> clear
    +
    +
    +

    It removes all the accumulated text up to this point in the destination. +(I don’t know what you’d need this for, but I thought maybe it’d be +useful while someone’s experimenting.)

    +

    The fourth new directive is set:

    +
    set line_prefix "string"
    +set line_suffix "string"
    +
    +
    +

    set lets you set two internal variables in Clinic. +line_prefix is a string that will be prepended to every line of Clinic’s output; +line_suffix is a string that will be appended to every line of Clinic’s output.

    +

    Both of these support two format strings:

    +
    +
    +
    {block comment start}

    Turns into the string /*, the start-comment text sequence for C files.

    +
    +
    {block comment end}

    Turns into the string */, the end-comment text sequence for C files.

    +
    +
    +
    +

    The final new directive is one you shouldn’t need to use directly, +called preserve:

    +
    preserve
    +
    +
    +

    This tells Clinic that the current contents of the output should be kept, unmodified. +This is used internally by Clinic when dumping output into file files; wrapping +it in a Clinic block lets Clinic use its existing checksum functionality to ensure +the file was not modified by hand before it gets overwritten.

    +
    +
    +

    The #ifdef trick

    +

    If you’re converting a function that isn’t available on all platforms, +there’s a trick you can use to make life a little easier. The existing +code probably looks like this:

    +
    #ifdef HAVE_FUNCTIONNAME
    +static module_functionname(...)
    +{
    +...
    +}
    +#endif /* HAVE_FUNCTIONNAME */
    +
    +
    +

    And then in the PyMethodDef structure at the bottom the existing code +will have:

    +
    #ifdef HAVE_FUNCTIONNAME
    +{'functionname', ... },
    +#endif /* HAVE_FUNCTIONNAME */
    +
    +
    +

    In this scenario, you should enclose the body of your impl function inside the #ifdef, +like so:

    +
    #ifdef HAVE_FUNCTIONNAME
    +/*[clinic input]
    +module.functionname
    +...
    +[clinic start generated code]*/
    +static module_functionname(...)
    +{
    +...
    +}
    +#endif /* HAVE_FUNCTIONNAME */
    +
    +
    +

    Then, remove those three lines from the PyMethodDef structure, +replacing them with the macro Argument Clinic generated:

    +
    MODULE_FUNCTIONNAME_METHODDEF
    +
    +
    +

    (You can find the real name for this macro inside the generated code. +Or you can calculate it yourself: it’s the name of your function as defined +on the first line of your block, but with periods changed to underscores, +uppercased, and "_METHODDEF" added to the end.)

    +

    Perhaps you’re wondering: what if HAVE_FUNCTIONNAME isn’t defined? +The MODULE_FUNCTIONNAME_METHODDEF macro won’t be defined either!

    +

    Here’s where Argument Clinic gets very clever. It actually detects that the +Argument Clinic block might be deactivated by the #ifdef. When that +happens, it generates a little extra code that looks like this:

    +
    #ifndef MODULE_FUNCTIONNAME_METHODDEF
    +    #define MODULE_FUNCTIONNAME_METHODDEF
    +#endif /* !defined(MODULE_FUNCTIONNAME_METHODDEF) */
    +
    +
    +

    That means the macro always works. If the function is defined, this turns +into the correct structure, including the trailing comma. If the function is +undefined, this turns into nothing.

    +

    However, this causes one ticklish problem: where should Argument Clinic put this +extra code when using the “block” output preset? It can’t go in the output block, +because that could be deactivated by the #ifdef. (That’s the whole point!)

    +

    In this situation, Argument Clinic writes the extra code to the “buffer” destination. +This may mean that you get a complaint from Argument Clinic:

    +
    Warning in file "Modules/posixmodule.c" on line 12357:
    +Destination buffer 'buffer' not empty at end of file, emptying.
    +
    +
    +

    When this happens, just open your file, find the dump buffer block that +Argument Clinic added to your file (it’ll be at the very bottom), then +move it above the PyMethodDef structure where that macro is used.

    +
    +
    +

    Using Argument Clinic in Python files

    +

    It’s actually possible to use Argument Clinic to preprocess Python files. +There’s no point to using Argument Clinic blocks, of course, as the output +wouldn’t make any sense to the Python interpreter. But using Argument Clinic +to run Python blocks lets you use Python as a Python preprocessor!

    +

    Since Python comments are different from C comments, Argument Clinic +blocks embedded in Python files look slightly different. They look like this:

    +
    #/*[python input]
    +#print("def foo(): pass")
    +#[python start generated code]*/
    +def foo(): pass
    +#/*[python checksum:...]*/
    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/howto/cporting.html b/python-3.7.4-docs-html/howto/cporting.html new file mode 100644 index 0000000..d3b2e1b --- /dev/null +++ b/python-3.7.4-docs-html/howto/cporting.html @@ -0,0 +1,564 @@ + + + + + + + Porting Extension Modules to Python 3 — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Porting Extension Modules to Python 3

    +
    +
    author
    +

    Benjamin Peterson

    +
    +
    +
    +

    Abstract

    +

    Although changing the C-API was not one of Python 3’s objectives, +the many Python-level changes made leaving Python 2’s API intact +impossible. In fact, some changes such as int() and +long() unification are more obvious on the C level. This +document endeavors to document incompatibilities and how they can +be worked around.

    +
    +
    +

    Conditional compilation

    +

    The easiest way to compile only some code for Python 3 is to check +if PY_MAJOR_VERSION is greater than or equal to 3.

    +
    #if PY_MAJOR_VERSION >= 3
    +#define IS_PY3K
    +#endif
    +
    +
    +

    API functions that are not present can be aliased to their equivalents within +conditional blocks.

    +
    +
    +

    Changes to Object APIs

    +

    Python 3 merged together some types with similar functions while cleanly +separating others.

    +
    +

    str/unicode Unification

    +

    Python 3’s str() type is equivalent to Python 2’s unicode(); the C +functions are called PyUnicode_* for both. The old 8-bit string type has become +bytes(), with C functions called PyBytes_*. Python 2.6 and later provide a compatibility header, +bytesobject.h, mapping PyBytes names to PyString ones. For best +compatibility with Python 3, PyUnicode should be used for textual data and +PyBytes for binary data. It’s also important to remember that +PyBytes and PyUnicode in Python 3 are not interchangeable like +PyString and PyUnicode are in Python 2. The following example +shows best practices with regards to PyUnicode, PyString, +and PyBytes.

    +
    #include "stdlib.h"
    +#include "Python.h"
    +#include "bytesobject.h"
    +
    +/* text example */
    +static PyObject *
    +say_hello(PyObject *self, PyObject *args) {
    +    PyObject *name, *result;
    +
    +    if (!PyArg_ParseTuple(args, "U:say_hello", &name))
    +        return NULL;
    +
    +    result = PyUnicode_FromFormat("Hello, %S!", name);
    +    return result;
    +}
    +
    +/* just a forward */
    +static char * do_encode(PyObject *);
    +
    +/* bytes example */
    +static PyObject *
    +encode_object(PyObject *self, PyObject *args) {
    +    char *encoded;
    +    PyObject *result, *myobj;
    +
    +    if (!PyArg_ParseTuple(args, "O:encode_object", &myobj))
    +        return NULL;
    +
    +    encoded = do_encode(myobj);
    +    if (encoded == NULL)
    +        return NULL;
    +    result = PyBytes_FromString(encoded);
    +    free(encoded);
    +    return result;
    +}
    +
    +
    +
    +
    +

    long/int Unification

    +

    Python 3 has only one integer type, int(). But it actually +corresponds to Python 2’s long() type—the int() type +used in Python 2 was removed. In the C-API, PyInt_* functions +are replaced by their PyLong_* equivalents.

    +
    +
    +
    +

    Module initialization and state

    +

    Python 3 has a revamped extension module initialization system. (See +PEP 3121.) Instead of storing module state in globals, they should +be stored in an interpreter specific structure. Creating modules that +act correctly in both Python 2 and Python 3 is tricky. The following +simple example demonstrates how.

    +
    #include "Python.h"
    +
    +struct module_state {
    +    PyObject *error;
    +};
    +
    +#if PY_MAJOR_VERSION >= 3
    +#define GETSTATE(m) ((struct module_state*)PyModule_GetState(m))
    +#else
    +#define GETSTATE(m) (&_state)
    +static struct module_state _state;
    +#endif
    +
    +static PyObject *
    +error_out(PyObject *m) {
    +    struct module_state *st = GETSTATE(m);
    +    PyErr_SetString(st->error, "something bad happened");
    +    return NULL;
    +}
    +
    +static PyMethodDef myextension_methods[] = {
    +    {"error_out", (PyCFunction)error_out, METH_NOARGS, NULL},
    +    {NULL, NULL}
    +};
    +
    +#if PY_MAJOR_VERSION >= 3
    +
    +static int myextension_traverse(PyObject *m, visitproc visit, void *arg) {
    +    Py_VISIT(GETSTATE(m)->error);
    +    return 0;
    +}
    +
    +static int myextension_clear(PyObject *m) {
    +    Py_CLEAR(GETSTATE(m)->error);
    +    return 0;
    +}
    +
    +
    +static struct PyModuleDef moduledef = {
    +        PyModuleDef_HEAD_INIT,
    +        "myextension",
    +        NULL,
    +        sizeof(struct module_state),
    +        myextension_methods,
    +        NULL,
    +        myextension_traverse,
    +        myextension_clear,
    +        NULL
    +};
    +
    +#define INITERROR return NULL
    +
    +PyMODINIT_FUNC
    +PyInit_myextension(void)
    +
    +#else
    +#define INITERROR return
    +
    +void
    +initmyextension(void)
    +#endif
    +{
    +#if PY_MAJOR_VERSION >= 3
    +    PyObject *module = PyModule_Create(&moduledef);
    +#else
    +    PyObject *module = Py_InitModule("myextension", myextension_methods);
    +#endif
    +
    +    if (module == NULL)
    +        INITERROR;
    +    struct module_state *st = GETSTATE(module);
    +
    +    st->error = PyErr_NewException("myextension.Error", NULL, NULL);
    +    if (st->error == NULL) {
    +        Py_DECREF(module);
    +        INITERROR;
    +    }
    +
    +#if PY_MAJOR_VERSION >= 3
    +    return module;
    +#endif
    +}
    +
    +
    +
    +
    +

    CObject replaced with Capsule

    +

    The Capsule object was introduced in Python 3.1 and 2.7 to replace +CObject. CObjects were useful, +but the CObject API was problematic: it didn’t permit distinguishing +between valid CObjects, which allowed mismatched CObjects to crash the +interpreter, and some of its APIs relied on undefined behavior in C. +(For further reading on the rationale behind Capsules, please see bpo-5630.)

    +

    If you’re currently using CObjects, and you want to migrate to 3.1 or newer, +you’ll need to switch to Capsules. +CObject was deprecated in 3.1 and 2.7 and completely removed in +Python 3.2. If you only support 2.7, or 3.1 and above, you +can simply switch to Capsule. If you need to support Python 3.0, +or versions of Python earlier than 2.7, +you’ll have to support both CObjects and Capsules. +(Note that Python 3.0 is no longer supported, and it is not recommended +for production use.)

    +

    The following example header file capsulethunk.h may +solve the problem for you. Simply write your code against the +Capsule API and include this header file after +Python.h. Your code will automatically use Capsules +in versions of Python with Capsules, and switch to CObjects +when Capsules are unavailable.

    +

    capsulethunk.h simulates Capsules using CObjects. However, +CObject provides no place to store the capsule’s “name”. As a +result the simulated Capsule objects created by capsulethunk.h +behave slightly differently from real Capsules. Specifically:

    +
    +
    +
    +

    You can find capsulethunk.h in the Python source distribution +as Doc/includes/capsulethunk.h. We also include it here for +your convenience:

    +
    #ifndef __CAPSULETHUNK_H
    +#define __CAPSULETHUNK_H
    +
    +#if (    (PY_VERSION_HEX <  0x02070000) \
    +     || ((PY_VERSION_HEX >= 0x03000000) \
    +      && (PY_VERSION_HEX <  0x03010000)) )
    +
    +#define __PyCapsule_GetField(capsule, field, default_value) \
    +    ( PyCapsule_CheckExact(capsule) \
    +        ? (((PyCObject *)capsule)->field) \
    +        : (default_value) \
    +    ) \
    +
    +#define __PyCapsule_SetField(capsule, field, value) \
    +    ( PyCapsule_CheckExact(capsule) \
    +        ? (((PyCObject *)capsule)->field = value), 1 \
    +        : 0 \
    +    ) \
    +
    +
    +#define PyCapsule_Type PyCObject_Type
    +
    +#define PyCapsule_CheckExact(capsule) (PyCObject_Check(capsule))
    +#define PyCapsule_IsValid(capsule, name) (PyCObject_Check(capsule))
    +
    +
    +#define PyCapsule_New(pointer, name, destructor) \
    +    (PyCObject_FromVoidPtr(pointer, destructor))
    +
    +
    +#define PyCapsule_GetPointer(capsule, name) \
    +    (PyCObject_AsVoidPtr(capsule))
    +
    +/* Don't call PyCObject_SetPointer here, it fails if there's a destructor */
    +#define PyCapsule_SetPointer(capsule, pointer) \
    +    __PyCapsule_SetField(capsule, cobject, pointer)
    +
    +
    +#define PyCapsule_GetDestructor(capsule) \
    +    __PyCapsule_GetField(capsule, destructor)
    +
    +#define PyCapsule_SetDestructor(capsule, dtor) \
    +    __PyCapsule_SetField(capsule, destructor, dtor)
    +
    +
    +/*
    + * Sorry, there's simply no place
    + * to store a Capsule "name" in a CObject.
    + */
    +#define PyCapsule_GetName(capsule) NULL
    +
    +static int
    +PyCapsule_SetName(PyObject *capsule, const char *unused)
    +{
    +    unused = unused;
    +    PyErr_SetString(PyExc_NotImplementedError,
    +        "can't use PyCapsule_SetName with CObjects");
    +    return 1;
    +}
    +
    +
    +
    +#define PyCapsule_GetContext(capsule) \
    +    __PyCapsule_GetField(capsule, descr)
    +
    +#define PyCapsule_SetContext(capsule, context) \
    +    __PyCapsule_SetField(capsule, descr, context)
    +
    +
    +static void *
    +PyCapsule_Import(const char *name, int no_block)
    +{
    +    PyObject *object = NULL;
    +    void *return_value = NULL;
    +    char *trace;
    +    size_t name_length = (strlen(name) + 1) * sizeof(char);
    +    char *name_dup = (char *)PyMem_MALLOC(name_length);
    +
    +    if (!name_dup) {
    +        return NULL;
    +    }
    +
    +    memcpy(name_dup, name, name_length);
    +
    +    trace = name_dup;
    +    while (trace) {
    +        char *dot = strchr(trace, '.');
    +        if (dot) {
    +            *dot++ = '\0';
    +        }
    +
    +        if (object == NULL) {
    +            if (no_block) {
    +                object = PyImport_ImportModuleNoBlock(trace);
    +            } else {
    +                object = PyImport_ImportModule(trace);
    +                if (!object) {
    +                    PyErr_Format(PyExc_ImportError,
    +                        "PyCapsule_Import could not "
    +                        "import module \"%s\"", trace);
    +                }
    +            }
    +        } else {
    +            PyObject *object2 = PyObject_GetAttrString(object, trace);
    +            Py_DECREF(object);
    +            object = object2;
    +        }
    +        if (!object) {
    +            goto EXIT;
    +        }
    +
    +        trace = dot;
    +    }
    +
    +    if (PyCObject_Check(object)) {
    +        PyCObject *cobject = (PyCObject *)object;
    +        return_value = cobject->cobject;
    +    } else {
    +        PyErr_Format(PyExc_AttributeError,
    +            "PyCapsule_Import \"%s\" is not valid",
    +            name);
    +    }
    +
    +EXIT:
    +    Py_XDECREF(object);
    +    if (name_dup) {
    +        PyMem_FREE(name_dup);
    +    }
    +    return return_value;
    +}
    +
    +#endif /* #if PY_VERSION_HEX < 0x02070000 */
    +
    +#endif /* __CAPSULETHUNK_H */
    +
    +
    +
    +
    +

    Other options

    +

    If you are writing a new extension module, you might consider Cython. It translates a Python-like language to C. The +extension modules it creates are compatible with Python 3 and Python 2.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/howto/curses.html b/python-3.7.4-docs-html/howto/curses.html new file mode 100644 index 0000000..dd573cc --- /dev/null +++ b/python-3.7.4-docs-html/howto/curses.html @@ -0,0 +1,729 @@ + + + + + + + Curses Programming with Python — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Curses Programming with Python

    +
    +
    Author
    +

    A.M. Kuchling, Eric S. Raymond

    +
    +
    Release
    +

    2.04

    +
    +
    +
    +

    Abstract

    +

    This document describes how to use the curses extension +module to control text-mode displays.

    +
    +
    +

    What is curses?

    +

    The curses library supplies a terminal-independent screen-painting and +keyboard-handling facility for text-based terminals; such terminals +include VT100s, the Linux console, and the simulated terminal provided +by various programs. Display terminals support various control codes +to perform common operations such as moving the cursor, scrolling the +screen, and erasing areas. Different terminals use widely differing +codes, and often have their own minor quirks.

    +

    In a world of graphical displays, one might ask “why bother”? It’s +true that character-cell display terminals are an obsolete technology, +but there are niches in which being able to do fancy things with them +are still valuable. One niche is on small-footprint or embedded +Unixes that don’t run an X server. Another is tools such as OS +installers and kernel configurators that may have to run before any +graphical support is available.

    +

    The curses library provides fairly basic functionality, providing the +programmer with an abstraction of a display containing multiple +non-overlapping windows of text. The contents of a window can be +changed in various ways—adding text, erasing it, changing its +appearance—and the curses library will figure out what control codes +need to be sent to the terminal to produce the right output. curses +doesn’t provide many user-interface concepts such as buttons, checkboxes, +or dialogs; if you need such features, consider a user interface library such as +Urwid.

    +

    The curses library was originally written for BSD Unix; the later System V +versions of Unix from AT&T added many enhancements and new functions. BSD curses +is no longer maintained, having been replaced by ncurses, which is an +open-source implementation of the AT&T interface. If you’re using an +open-source Unix such as Linux or FreeBSD, your system almost certainly uses +ncurses. Since most current commercial Unix versions are based on System V +code, all the functions described here will probably be available. The older +versions of curses carried by some proprietary Unixes may not support +everything, though.

    +

    The Windows version of Python doesn’t include the curses +module. A ported version called UniCurses is available. You could +also try the Console module +written by Fredrik Lundh, which doesn’t +use the same API as curses but provides cursor-addressable text output +and full support for mouse and keyboard input.

    +
    +

    The Python curses module

    +

    The Python module is a fairly simple wrapper over the C functions provided by +curses; if you’re already familiar with curses programming in C, it’s really +easy to transfer that knowledge to Python. The biggest difference is that the +Python interface makes things simpler by merging different C functions such as +addstr(), mvaddstr(), and mvwaddstr() into a single +addstr() method. You’ll see this covered in more +detail later.

    +

    This HOWTO is an introduction to writing text-mode programs with curses +and Python. It doesn’t attempt to be a complete guide to the curses API; for +that, see the Python library guide’s section on ncurses, and the C manual pages +for ncurses. It will, however, give you the basic ideas.

    +
    +
    +
    +

    Starting and ending a curses application

    +

    Before doing anything, curses must be initialized. This is done by +calling the initscr() function, which will determine the +terminal type, send any required setup codes to the terminal, and +create various internal data structures. If successful, +initscr() returns a window object representing the entire +screen; this is usually called stdscr after the name of the +corresponding C variable.

    +
    import curses
    +stdscr = curses.initscr()
    +
    +
    +

    Usually curses applications turn off automatic echoing of keys to the +screen, in order to be able to read keys and only display them under +certain circumstances. This requires calling the +noecho() function.

    +
    curses.noecho()
    +
    +
    +

    Applications will also commonly need to react to keys instantly, +without requiring the Enter key to be pressed; this is called cbreak +mode, as opposed to the usual buffered input mode.

    +
    curses.cbreak()
    +
    +
    +

    Terminals usually return special keys, such as the cursor keys or navigation +keys such as Page Up and Home, as a multibyte escape sequence. While you could +write your application to expect such sequences and process them accordingly, +curses can do it for you, returning a special value such as +curses.KEY_LEFT. To get curses to do the job, you’ll have to enable +keypad mode.

    +
    stdscr.keypad(True)
    +
    +
    +

    Terminating a curses application is much easier than starting one. You’ll need +to call:

    +
    curses.nocbreak()
    +stdscr.keypad(False)
    +curses.echo()
    +
    +
    +

    to reverse the curses-friendly terminal settings. Then call the +endwin() function to restore the terminal to its original +operating mode.

    +
    curses.endwin()
    +
    +
    +

    A common problem when debugging a curses application is to get your terminal +messed up when the application dies without restoring the terminal to its +previous state. In Python this commonly happens when your code is buggy and +raises an uncaught exception. Keys are no longer echoed to the screen when +you type them, for example, which makes using the shell difficult.

    +

    In Python you can avoid these complications and make debugging much easier by +importing the curses.wrapper() function and using it like this:

    +
    from curses import wrapper
    +
    +def main(stdscr):
    +    # Clear screen
    +    stdscr.clear()
    +
    +    # This raises ZeroDivisionError when i == 10.
    +    for i in range(0, 11):
    +        v = i-10
    +        stdscr.addstr(i, 0, '10 divided by {} is {}'.format(v, 10/v))
    +
    +    stdscr.refresh()
    +    stdscr.getkey()
    +
    +wrapper(main)
    +
    +
    +

    The wrapper() function takes a callable object and does the +initializations described above, also initializing colors if color +support is present. wrapper() then runs your provided callable. +Once the callable returns, wrapper() will restore the original +state of the terminal. The callable is called inside a +tryexcept that catches exceptions, restores +the state of the terminal, and then re-raises the exception. Therefore +your terminal won’t be left in a funny state on exception and you’ll be +able to read the exception’s message and traceback.

    +
    +
    +

    Windows and Pads

    +

    Windows are the basic abstraction in curses. A window object represents a +rectangular area of the screen, and supports methods to display text, +erase it, allow the user to input strings, and so forth.

    +

    The stdscr object returned by the initscr() function is a +window object that covers the entire screen. Many programs may need +only this single window, but you might wish to divide the screen into +smaller windows, in order to redraw or clear them separately. The +newwin() function creates a new window of a given size, +returning the new window object.

    +
    begin_x = 20; begin_y = 7
    +height = 5; width = 40
    +win = curses.newwin(height, width, begin_y, begin_x)
    +
    +
    +

    Note that the coordinate system used in curses is unusual. +Coordinates are always passed in the order y,x, and the top-left +corner of a window is coordinate (0,0). This breaks the normal +convention for handling coordinates where the x coordinate comes +first. This is an unfortunate difference from most other computer +applications, but it’s been part of curses since it was first written, +and it’s too late to change things now.

    +

    Your application can determine the size of the screen by using the +curses.LINES and curses.COLS variables to obtain the y and +x sizes. Legal coordinates will then extend from (0,0) to +(curses.LINES - 1, curses.COLS - 1).

    +

    When you call a method to display or erase text, the effect doesn’t +immediately show up on the display. Instead you must call the +refresh() method of window objects to update the +screen.

    +

    This is because curses was originally written with slow 300-baud +terminal connections in mind; with these terminals, minimizing the +time required to redraw the screen was very important. Instead curses +accumulates changes to the screen and displays them in the most +efficient manner when you call refresh(). For example, if your +program displays some text in a window and then clears the window, +there’s no need to send the original text because they’re never +visible.

    +

    In practice, explicitly telling curses to redraw a window doesn’t +really complicate programming with curses much. Most programs go into a flurry +of activity, and then pause waiting for a keypress or some other action on the +part of the user. All you have to do is to be sure that the screen has been +redrawn before pausing to wait for user input, by first calling +stdscr.refresh() or the refresh() method of some other relevant +window.

    +

    A pad is a special case of a window; it can be larger than the actual display +screen, and only a portion of the pad displayed at a time. Creating a pad +requires the pad’s height and width, while refreshing a pad requires giving the +coordinates of the on-screen area where a subsection of the pad will be +displayed.

    +
    pad = curses.newpad(100, 100)
    +# These loops fill the pad with letters; addch() is
    +# explained in the next section
    +for y in range(0, 99):
    +    for x in range(0, 99):
    +        pad.addch(y,x, ord('a') + (x*x+y*y) % 26)
    +
    +# Displays a section of the pad in the middle of the screen.
    +# (0,0) : coordinate of upper-left corner of pad area to display.
    +# (5,5) : coordinate of upper-left corner of window area to be filled
    +#         with pad content.
    +# (20, 75) : coordinate of lower-right corner of window area to be
    +#          : filled with pad content.
    +pad.refresh( 0,0, 5,5, 20,75)
    +
    +
    +

    The refresh() call displays a section of the pad in the rectangle +extending from coordinate (5,5) to coordinate (20,75) on the screen; the upper +left corner of the displayed section is coordinate (0,0) on the pad. Beyond +that difference, pads are exactly like ordinary windows and support the same +methods.

    +

    If you have multiple windows and pads on screen there is a more +efficient way to update the screen and prevent annoying screen flicker +as each part of the screen gets updated. refresh() actually +does two things:

    +
      +
    1. Calls the noutrefresh() method of each window +to update an underlying data structure representing the desired +state of the screen.

    2. +
    3. Calls the function doupdate() function to change the +physical screen to match the desired state recorded in the data structure.

    4. +
    +

    Instead you can call noutrefresh() on a number of windows to +update the data structure, and then call doupdate() to update +the screen.

    +
    +
    +

    Displaying Text

    +

    From a C programmer’s point of view, curses may sometimes look like a +twisty maze of functions, all subtly different. For example, +addstr() displays a string at the current cursor location in +the stdscr window, while mvaddstr() moves to a given y,x +coordinate first before displaying the string. waddstr() is just +like addstr(), but allows specifying a window to use instead of +using stdscr by default. mvwaddstr() allows specifying both +a window and a coordinate.

    +

    Fortunately the Python interface hides all these details. stdscr +is a window object like any other, and methods such as +addstr() accept multiple argument forms. Usually there +are four different forms.

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Form

    Description

    str or ch

    Display the string str or character ch at +the current position

    str or ch, attr

    Display the string str or character ch, +using attribute attr at the current +position

    y, x, str or ch

    Move to position y,x within the window, and +display str or ch

    y, x, str or ch, attr

    Move to position y,x within the window, and +display str or ch, using attribute attr

    +

    Attributes allow displaying text in highlighted forms such as boldface, +underline, reverse code, or in color. They’ll be explained in more detail in +the next subsection.

    +

    The addstr() method takes a Python string or +bytestring as the value to be displayed. The contents of bytestrings +are sent to the terminal as-is. Strings are encoded to bytes using +the value of the window’s encoding attribute; this defaults to +the default system encoding as returned by +locale.getpreferredencoding().

    +

    The addch() methods take a character, which can be +either a string of length 1, a bytestring of length 1, or an integer.

    +

    Constants are provided for extension characters; these constants are +integers greater than 255. For example, ACS_PLMINUS is a +/- +symbol, and ACS_ULCORNER is the upper left corner of a box +(handy for drawing borders). You can also use the appropriate Unicode +character.

    +

    Windows remember where the cursor was left after the last operation, so if you +leave out the y,x coordinates, the string or character will be displayed +wherever the last operation left off. You can also move the cursor with the +move(y,x) method. Because some terminals always display a flashing cursor, +you may want to ensure that the cursor is positioned in some location where it +won’t be distracting; it can be confusing to have the cursor blinking at some +apparently random location.

    +

    If your application doesn’t need a blinking cursor at all, you can +call curs_set(False) to make it invisible. For compatibility +with older curses versions, there’s a leaveok(bool) function +that’s a synonym for curs_set(). When bool is true, the +curses library will attempt to suppress the flashing cursor, and you +won’t need to worry about leaving it in odd locations.

    +
    +

    Attributes and Color

    +

    Characters can be displayed in different ways. Status lines in a text-based +application are commonly shown in reverse video, or a text viewer may need to +highlight certain words. curses supports this by allowing you to specify an +attribute for each cell on the screen.

    +

    An attribute is an integer, each bit representing a different +attribute. You can try to display text with multiple attribute bits +set, but curses doesn’t guarantee that all the possible combinations +are available, or that they’re all visually distinct. That depends on +the ability of the terminal being used, so it’s safest to stick to the +most commonly available attributes, listed here.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + +

    Attribute

    Description

    A_BLINK

    Blinking text

    A_BOLD

    Extra bright or bold text

    A_DIM

    Half bright text

    A_REVERSE

    Reverse-video text

    A_STANDOUT

    The best highlighting mode available

    A_UNDERLINE

    Underlined text

    +

    So, to display a reverse-video status line on the top line of the screen, you +could code:

    +
    stdscr.addstr(0, 0, "Current mode: Typing mode",
    +              curses.A_REVERSE)
    +stdscr.refresh()
    +
    +
    +

    The curses library also supports color on those terminals that provide it. The +most common such terminal is probably the Linux console, followed by color +xterms.

    +

    To use color, you must call the start_color() function soon +after calling initscr(), to initialize the default color set +(the curses.wrapper() function does this automatically). Once that’s +done, the has_colors() function returns TRUE if the terminal +in use can +actually display color. (Note: curses uses the American spelling ‘color’, +instead of the Canadian/British spelling ‘colour’. If you’re used to the +British spelling, you’ll have to resign yourself to misspelling it for the sake +of these functions.)

    +

    The curses library maintains a finite number of color pairs, containing a +foreground (or text) color and a background color. You can get the attribute +value corresponding to a color pair with the color_pair() +function; this can be bitwise-OR’ed with other attributes such as +A_REVERSE, but again, such combinations are not guaranteed to work +on all terminals.

    +

    An example, which displays a line of text using color pair 1:

    +
    stdscr.addstr("Pretty text", curses.color_pair(1))
    +stdscr.refresh()
    +
    +
    +

    As I said before, a color pair consists of a foreground and background color. +The init_pair(n, f, b) function changes the definition of color pair n, to +foreground color f and background color b. Color pair 0 is hard-wired to white +on black, and cannot be changed.

    +

    Colors are numbered, and start_color() initializes 8 basic +colors when it activates color mode. They are: 0:black, 1:red, +2:green, 3:yellow, 4:blue, 5:magenta, 6:cyan, and 7:white. The curses +module defines named constants for each of these colors: +curses.COLOR_BLACK, curses.COLOR_RED, and so forth.

    +

    Let’s put all this together. To change color 1 to red text on a white +background, you would call:

    +
    curses.init_pair(1, curses.COLOR_RED, curses.COLOR_WHITE)
    +
    +
    +

    When you change a color pair, any text already displayed using that color pair +will change to the new colors. You can also display new text in this color +with:

    +
    stdscr.addstr(0,0, "RED ALERT!", curses.color_pair(1))
    +
    +
    +

    Very fancy terminals can change the definitions of the actual colors to a given +RGB value. This lets you change color 1, which is usually red, to purple or +blue or any other color you like. Unfortunately, the Linux console doesn’t +support this, so I’m unable to try it out, and can’t provide any examples. You +can check if your terminal can do this by calling +can_change_color(), which returns True if the capability is +there. If you’re lucky enough to have such a talented terminal, consult your +system’s man pages for more information.

    +
    +
    +
    +

    User Input

    +

    The C curses library offers only very simple input mechanisms. Python’s +curses module adds a basic text-input widget. (Other libraries +such as Urwid have more extensive +collections of widgets.)

    +

    There are two methods for getting input from a window:

    +
      +
    • getch() refreshes the screen and then waits for +the user to hit a key, displaying the key if echo() has been +called earlier. You can optionally specify a coordinate to which +the cursor should be moved before pausing.

    • +
    • getkey() does the same thing but converts the +integer to a string. Individual characters are returned as +1-character strings, and special keys such as function keys return +longer strings containing a key name such as KEY_UP or ^G.

    • +
    +

    It’s possible to not wait for the user using the +nodelay() window method. After nodelay(True), +getch() and getkey() for the window become +non-blocking. To signal that no input is ready, getch() returns +curses.ERR (a value of -1) and getkey() raises an exception. +There’s also a halfdelay() function, which can be used to (in +effect) set a timer on each getch(); if no input becomes +available within a specified delay (measured in tenths of a second), +curses raises an exception.

    +

    The getch() method returns an integer; if it’s between 0 and 255, it +represents the ASCII code of the key pressed. Values greater than 255 are +special keys such as Page Up, Home, or the cursor keys. You can compare the +value returned to constants such as curses.KEY_PPAGE, +curses.KEY_HOME, or curses.KEY_LEFT. The main loop of +your program may look something like this:

    +
    while True:
    +    c = stdscr.getch()
    +    if c == ord('p'):
    +        PrintDocument()
    +    elif c == ord('q'):
    +        break  # Exit the while loop
    +    elif c == curses.KEY_HOME:
    +        x = y = 0
    +
    +
    +

    The curses.ascii module supplies ASCII class membership functions that +take either integer or 1-character string arguments; these may be useful in +writing more readable tests for such loops. It also supplies +conversion functions that take either integer or 1-character-string arguments +and return the same type. For example, curses.ascii.ctrl() returns the +control character corresponding to its argument.

    +

    There’s also a method to retrieve an entire string, +getstr(). It isn’t used very often, because its +functionality is quite limited; the only editing keys available are +the backspace key and the Enter key, which terminates the string. It +can optionally be limited to a fixed number of characters.

    +
    curses.echo()            # Enable echoing of characters
    +
    +# Get a 15-character string, with the cursor on the top line
    +s = stdscr.getstr(0,0, 15)
    +
    +
    +

    The curses.textpad module supplies a text box that supports an +Emacs-like set of keybindings. Various methods of the +Textbox class support editing with input +validation and gathering the edit results either with or without +trailing spaces. Here’s an example:

    +
    import curses
    +from curses.textpad import Textbox, rectangle
    +
    +def main(stdscr):
    +    stdscr.addstr(0, 0, "Enter IM message: (hit Ctrl-G to send)")
    +
    +    editwin = curses.newwin(5,30, 2,1)
    +    rectangle(stdscr, 1,0, 1+5+1, 1+30+1)
    +    stdscr.refresh()
    +
    +    box = Textbox(editwin)
    +
    +    # Let the user edit until Ctrl-G is struck.
    +    box.edit()
    +
    +    # Get resulting contents
    +    message = box.gather()
    +
    +
    +

    See the library documentation on curses.textpad for more details.

    +
    +
    +

    For More Information

    +

    This HOWTO doesn’t cover some advanced topics, such as reading the +contents of the screen or capturing mouse events from an xterm +instance, but the Python library page for the curses module is now +reasonably complete. You should browse it next.

    +

    If you’re in doubt about the detailed behavior of the curses +functions, consult the manual pages for your curses implementation, +whether it’s ncurses or a proprietary Unix vendor’s. The manual pages +will document any quirks, and provide complete lists of all the +functions, attributes, and ACS_* characters available to +you.

    +

    Because the curses API is so large, some functions aren’t supported in +the Python interface. Often this isn’t because they’re difficult to +implement, but because no one has needed them yet. Also, Python +doesn’t yet support the menu library associated with ncurses. +Patches adding support for these would be welcome; see +the Python Developer’s Guide to +learn more about submitting patches to Python.

    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/howto/descriptor.html b/python-3.7.4-docs-html/howto/descriptor.html new file mode 100644 index 0000000..c6a26a3 --- /dev/null +++ b/python-3.7.4-docs-html/howto/descriptor.html @@ -0,0 +1,636 @@ + + + + + + + Descriptor HowTo Guide — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Descriptor HowTo Guide

    +
    +
    Author
    +

    Raymond Hettinger

    +
    +
    Contact
    +

    <python at rcn dot com>

    +
    +
    + +
    +

    Abstract

    +

    Defines descriptors, summarizes the protocol, and shows how descriptors are +called. Examines a custom descriptor and several built-in Python descriptors +including functions, properties, static methods, and class methods. Shows how +each works by giving a pure Python equivalent and a sample application.

    +

    Learning about descriptors not only provides access to a larger toolset, it +creates a deeper understanding of how Python works and an appreciation for the +elegance of its design.

    +
    +
    +

    Definition and Introduction

    +

    In general, a descriptor is an object attribute with “binding behavior”, one +whose attribute access has been overridden by methods in the descriptor +protocol. Those methods are __get__(), __set__(), and +__delete__(). If any of those methods are defined for an object, it is +said to be a descriptor.

    +

    The default behavior for attribute access is to get, set, or delete the +attribute from an object’s dictionary. For instance, a.x has a lookup chain +starting with a.__dict__['x'], then type(a).__dict__['x'], and +continuing through the base classes of type(a) excluding metaclasses. If the +looked-up value is an object defining one of the descriptor methods, then Python +may override the default behavior and invoke the descriptor method instead. +Where this occurs in the precedence chain depends on which descriptor methods +were defined.

    +

    Descriptors are a powerful, general purpose protocol. They are the mechanism +behind properties, methods, static methods, class methods, and super(). +They are used throughout Python itself to implement the new style classes +introduced in version 2.2. Descriptors simplify the underlying C-code and offer +a flexible set of new tools for everyday Python programs.

    +
    +
    +

    Descriptor Protocol

    +

    descr.__get__(self, obj, type=None) -> value

    +

    descr.__set__(self, obj, value) -> None

    +

    descr.__delete__(self, obj) -> None

    +

    That is all there is to it. Define any of these methods and an object is +considered a descriptor and can override default behavior upon being looked up +as an attribute.

    +

    If an object defines both __get__() and __set__(), it is considered +a data descriptor. Descriptors that only define __get__() are called +non-data descriptors (they are typically used for methods but other uses are +possible).

    +

    Data and non-data descriptors differ in how overrides are calculated with +respect to entries in an instance’s dictionary. If an instance’s dictionary +has an entry with the same name as a data descriptor, the data descriptor +takes precedence. If an instance’s dictionary has an entry with the same +name as a non-data descriptor, the dictionary entry takes precedence.

    +

    To make a read-only data descriptor, define both __get__() and +__set__() with the __set__() raising an AttributeError when +called. Defining the __set__() method with an exception raising +placeholder is enough to make it a data descriptor.

    +
    +
    +

    Invoking Descriptors

    +

    A descriptor can be called directly by its method name. For example, +d.__get__(obj).

    +

    Alternatively, it is more common for a descriptor to be invoked automatically +upon attribute access. For example, obj.d looks up d in the dictionary +of obj. If d defines the method __get__(), then d.__get__(obj) +is invoked according to the precedence rules listed below.

    +

    The details of invocation depend on whether obj is an object or a class.

    +

    For objects, the machinery is in object.__getattribute__() which +transforms b.x into type(b).__dict__['x'].__get__(b, type(b)). The +implementation works through a precedence chain that gives data descriptors +priority over instance variables, instance variables priority over non-data +descriptors, and assigns lowest priority to __getattr__() if provided. +The full C implementation can be found in PyObject_GenericGetAttr() in +Objects/object.c.

    +

    For classes, the machinery is in type.__getattribute__() which transforms +B.x into B.__dict__['x'].__get__(None, B). In pure Python, it looks +like:

    +
    def __getattribute__(self, key):
    +    "Emulate type_getattro() in Objects/typeobject.c"
    +    v = object.__getattribute__(self, key)
    +    if hasattr(v, '__get__'):
    +        return v.__get__(None, self)
    +    return v
    +
    +
    +

    The important points to remember are:

    + +

    The object returned by super() also has a custom __getattribute__() +method for invoking descriptors. The call super(B, obj).m() searches +obj.__class__.__mro__ for the base class A immediately following B +and then returns A.__dict__['m'].__get__(obj, B). If not a descriptor, +m is returned unchanged. If not in the dictionary, m reverts to a +search using object.__getattribute__().

    +

    The implementation details are in super_getattro() in +Objects/typeobject.c. and a pure Python equivalent can be found in +Guido’s Tutorial.

    +

    The details above show that the mechanism for descriptors is embedded in the +__getattribute__() methods for object, type, and +super(). Classes inherit this machinery when they derive from +object or if they have a meta-class providing similar functionality. +Likewise, classes can turn-off descriptor invocation by overriding +__getattribute__().

    +
    +
    +

    Descriptor Example

    +

    The following code creates a class whose objects are data descriptors which +print a message for each get or set. Overriding __getattribute__() is +alternate approach that could do this for every attribute. However, this +descriptor is useful for monitoring just a few chosen attributes:

    +
    class RevealAccess(object):
    +    """A data descriptor that sets and returns values
    +       normally and prints a message logging their access.
    +    """
    +
    +    def __init__(self, initval=None, name='var'):
    +        self.val = initval
    +        self.name = name
    +
    +    def __get__(self, obj, objtype):
    +        print('Retrieving', self.name)
    +        return self.val
    +
    +    def __set__(self, obj, val):
    +        print('Updating', self.name)
    +        self.val = val
    +
    +>>> class MyClass(object):
    +...     x = RevealAccess(10, 'var "x"')
    +...     y = 5
    +...
    +>>> m = MyClass()
    +>>> m.x
    +Retrieving var "x"
    +10
    +>>> m.x = 20
    +Updating var "x"
    +>>> m.x
    +Retrieving var "x"
    +20
    +>>> m.y
    +5
    +
    +
    +

    The protocol is simple and offers exciting possibilities. Several use cases are +so common that they have been packaged into individual function calls. +Properties, bound methods, static methods, and class methods are all +based on the descriptor protocol.

    +
    +
    +

    Properties

    +

    Calling property() is a succinct way of building a data descriptor that +triggers function calls upon access to an attribute. Its signature is:

    +
    property(fget=None, fset=None, fdel=None, doc=None) -> property attribute
    +
    +
    +

    The documentation shows a typical use to define a managed attribute x:

    +
    class C(object):
    +    def getx(self): return self.__x
    +    def setx(self, value): self.__x = value
    +    def delx(self): del self.__x
    +    x = property(getx, setx, delx, "I'm the 'x' property.")
    +
    +
    +

    To see how property() is implemented in terms of the descriptor protocol, +here is a pure Python equivalent:

    +
    class Property(object):
    +    "Emulate PyProperty_Type() in Objects/descrobject.c"
    +
    +    def __init__(self, fget=None, fset=None, fdel=None, doc=None):
    +        self.fget = fget
    +        self.fset = fset
    +        self.fdel = fdel
    +        if doc is None and fget is not None:
    +            doc = fget.__doc__
    +        self.__doc__ = doc
    +
    +    def __get__(self, obj, objtype=None):
    +        if obj is None:
    +            return self
    +        if self.fget is None:
    +            raise AttributeError("unreadable attribute")
    +        return self.fget(obj)
    +
    +    def __set__(self, obj, value):
    +        if self.fset is None:
    +            raise AttributeError("can't set attribute")
    +        self.fset(obj, value)
    +
    +    def __delete__(self, obj):
    +        if self.fdel is None:
    +            raise AttributeError("can't delete attribute")
    +        self.fdel(obj)
    +
    +    def getter(self, fget):
    +        return type(self)(fget, self.fset, self.fdel, self.__doc__)
    +
    +    def setter(self, fset):
    +        return type(self)(self.fget, fset, self.fdel, self.__doc__)
    +
    +    def deleter(self, fdel):
    +        return type(self)(self.fget, self.fset, fdel, self.__doc__)
    +
    +
    +

    The property() builtin helps whenever a user interface has granted +attribute access and then subsequent changes require the intervention of a +method.

    +

    For instance, a spreadsheet class may grant access to a cell value through +Cell('b10').value. Subsequent improvements to the program require the cell +to be recalculated on every access; however, the programmer does not want to +affect existing client code accessing the attribute directly. The solution is +to wrap access to the value attribute in a property data descriptor:

    +
    class Cell(object):
    +    . . .
    +    def getvalue(self):
    +        "Recalculate the cell before returning value"
    +        self.recalc()
    +        return self._value
    +    value = property(getvalue)
    +
    +
    +
    +
    +

    Functions and Methods

    +

    Python’s object oriented features are built upon a function based environment. +Using non-data descriptors, the two are merged seamlessly.

    +

    Class dictionaries store methods as functions. In a class definition, methods +are written using def or lambda, the usual tools for +creating functions. Methods only differ from regular functions in that the +first argument is reserved for the object instance. By Python convention, the +instance reference is called self but may be called this or any other +variable name.

    +

    To support method calls, functions include the __get__() method for +binding methods during attribute access. This means that all functions are +non-data descriptors which return bound methods when they are invoked from an +object. In pure Python, it works like this:

    +
    class Function(object):
    +    . . .
    +    def __get__(self, obj, objtype=None):
    +        "Simulate func_descr_get() in Objects/funcobject.c"
    +        if obj is None:
    +            return self
    +        return types.MethodType(self, obj)
    +
    +
    +

    Running the interpreter shows how the function descriptor works in practice:

    +
    >>> class D(object):
    +...     def f(self, x):
    +...         return x
    +...
    +>>> d = D()
    +
    +# Access through the class dictionary does not invoke __get__.
    +# It just returns the underlying function object.
    +>>> D.__dict__['f']
    +<function D.f at 0x00C45070>
    +
    +# Dotted access from a class calls __get__() which just returns
    +# the underlying function unchanged.
    +>>> D.f
    +<function D.f at 0x00C45070>
    +
    +# The function has a __qualname__ attribute to support introspection
    +>>> D.f.__qualname__
    +'D.f'
    +
    +# Dotted access from an instance calls __get__() which returns the
    +# function wrapped in a bound method object
    +>>> d.f
    +<bound method D.f of <__main__.D object at 0x00B18C90>>
    +
    +# Internally, the bound method stores the underlying function,
    +# the bound instance, and the class of the bound instance.
    +>>> d.f.__func__
    +<function D.f at 0x1012e5ae8>
    +>>> d.f.__self__
    +<__main__.D object at 0x1012e1f98>
    +>>> d.f.__class__
    +<class 'method'>
    +
    +
    +
    +
    +

    Static Methods and Class Methods

    +

    Non-data descriptors provide a simple mechanism for variations on the usual +patterns of binding functions into methods.

    +

    To recap, functions have a __get__() method so that they can be converted +to a method when accessed as attributes. The non-data descriptor transforms an +obj.f(*args) call into f(obj, *args). Calling klass.f(*args) +becomes f(*args).

    +

    This chart summarizes the binding and its two most useful variants:

    +
    +
    +++++ + + + + + + + + + + + + + + + + + + + + +

    Transformation

    Called from an +Object

    Called from a +Class

    function

    f(obj, *args)

    f(*args)

    staticmethod

    f(*args)

    f(*args)

    classmethod

    f(type(obj), *args)

    f(klass, *args)

    +
    +

    Static methods return the underlying function without changes. Calling either +c.f or C.f is the equivalent of a direct lookup into +object.__getattribute__(c, "f") or object.__getattribute__(C, "f"). As a +result, the function becomes identically accessible from either an object or a +class.

    +

    Good candidates for static methods are methods that do not reference the +self variable.

    +

    For instance, a statistics package may include a container class for +experimental data. The class provides normal methods for computing the average, +mean, median, and other descriptive statistics that depend on the data. However, +there may be useful functions which are conceptually related but do not depend +on the data. For instance, erf(x) is handy conversion routine that comes up +in statistical work but does not directly depend on a particular dataset. +It can be called either from an object or the class: s.erf(1.5) --> .9332 or +Sample.erf(1.5) --> .9332.

    +

    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)
    +...
    +>>> E.f(3)
    +3
    +>>> E().f(3)
    +3
    +
    +
    +

    Using the non-data descriptor protocol, a pure Python version of +staticmethod() would look like this:

    +
    class StaticMethod(object):
    +    "Emulate PyStaticMethod_Type() in Objects/funcobject.c"
    +
    +    def __init__(self, f):
    +        self.f = 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)
    +...
    +>>> print(E.f(3))
    +('E', 3)
    +>>> print(E().f(3))
    +('E', 3)
    +
    +
    +

    This behavior is useful whenever the function only needs to have a class +reference and does not care about any underlying data. One use for classmethods +is to create alternate class constructors. In Python 2.3, the classmethod +dict.fromkeys() creates a new dictionary from a list of keys. The pure +Python equivalent is:

    +
    class Dict(object):
    +    . . .
    +    def fromkeys(klass, iterable, value=None):
    +        "Emulate dict_fromkeys() in Objects/dictobject.c"
    +        d = klass()
    +        for key in iterable:
    +            d[key] = value
    +        return d
    +    fromkeys = classmethod(fromkeys)
    +
    +
    +

    Now a new dictionary of unique keys can be constructed like this:

    +
    >>> Dict.fromkeys('abracadabra')
    +{'a': None, 'r': None, 'b': None, 'c': None, 'd': None}
    +
    +
    +

    Using the non-data descriptor protocol, a pure Python version of +classmethod() would look like this:

    +
    class ClassMethod(object):
    +    "Emulate PyClassMethod_Type() in Objects/funcobject.c"
    +
    +    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
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/howto/functional.html b/python-3.7.4-docs-html/howto/functional.html new file mode 100644 index 0000000..21a09ad --- /dev/null +++ b/python-3.7.4-docs-html/howto/functional.html @@ -0,0 +1,1350 @@ + + + + + + + Functional Programming HOWTO — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Functional Programming HOWTO

    +
    +
    Author
    +

    A. M. Kuchling

    +
    +
    Release
    +

    0.32

    +
    +
    +

    In this document, we’ll take a tour of Python’s features suitable for +implementing programs in a functional style. After an introduction to the +concepts of functional programming, we’ll look at language features such as +iterators and generators and relevant library modules such as +itertools and functools.

    +
    +

    Introduction

    +

    This section explains the basic concept of functional programming; if +you’re just interested in learning about Python language features, +skip to the next section on Iterators.

    +

    Programming languages support decomposing problems in several different ways:

    +
      +
    • Most programming languages are procedural: programs are lists of +instructions that tell the computer what to do with the program’s input. C, +Pascal, and even Unix shells are procedural languages.

    • +
    • In declarative languages, you write a specification that describes the +problem to be solved, and the language implementation figures out how to +perform the computation efficiently. SQL is the declarative language you’re +most likely to be familiar with; a SQL query describes the data set you want +to retrieve, and the SQL engine decides whether to scan tables or use indexes, +which subclauses should be performed first, etc.

    • +
    • Object-oriented programs manipulate collections of objects. Objects have +internal state and support methods that query or modify this internal state in +some way. Smalltalk and Java are object-oriented languages. C++ and Python +are languages that support object-oriented programming, but don’t force the +use of object-oriented features.

    • +
    • Functional programming decomposes a problem into a set of functions. +Ideally, functions only take inputs and produce outputs, and don’t have any +internal state that affects the output produced for a given input. Well-known +functional languages include the ML family (Standard ML, OCaml, and other +variants) and Haskell.

    • +
    +

    The designers of some computer languages choose to emphasize one +particular approach to programming. This often makes it difficult to +write programs that use a different approach. Other languages are +multi-paradigm languages that support several different approaches. +Lisp, C++, and Python are multi-paradigm; you can write programs or +libraries that are largely procedural, object-oriented, or functional +in all of these languages. In a large program, different sections +might be written using different approaches; the GUI might be +object-oriented while the processing logic is procedural or +functional, for example.

    +

    In a functional program, input flows through a set of functions. Each function +operates on its input and produces some output. Functional style discourages +functions with side effects that modify internal state or make other changes +that aren’t visible in the function’s return value. Functions that have no side +effects at all are called purely functional. Avoiding side effects means +not using data structures that get updated as a program runs; every function’s +output must only depend on its input.

    +

    Some languages are very strict about purity and don’t even have assignment +statements such as a=3 or c = a + b, but it’s difficult to avoid all +side effects. Printing to the screen or writing to a disk file are side +effects, for example. For example, in Python a call to the print() or +time.sleep() function both return no useful value; they’re only called for +their side effects of sending some text to the screen or pausing execution for a +second.

    +

    Python programs written in functional style usually won’t go to the extreme of +avoiding all I/O or all assignments; instead, they’ll provide a +functional-appearing interface but will use non-functional features internally. +For example, the implementation of a function will still use assignments to +local variables, but won’t modify global variables or have other side effects.

    +

    Functional programming can be considered the opposite of object-oriented +programming. Objects are little capsules containing some internal state along +with a collection of method calls that let you modify this state, and programs +consist of making the right set of state changes. Functional programming wants +to avoid state changes as much as possible and works with data flowing between +functions. In Python you might combine the two approaches by writing functions +that take and return instances representing objects in your application (e-mail +messages, transactions, etc.).

    +

    Functional design may seem like an odd constraint to work under. Why should you +avoid objects and side effects? There are theoretical and practical advantages +to the functional style:

    +
      +
    • Formal provability.

    • +
    • Modularity.

    • +
    • Composability.

    • +
    • Ease of debugging and testing.

    • +
    +
    +

    Formal provability

    +

    A theoretical benefit is that it’s easier to construct a mathematical proof that +a functional program is correct.

    +

    For a long time researchers have been interested in finding ways to +mathematically prove programs correct. This is different from testing a program +on numerous inputs and concluding that its output is usually correct, or reading +a program’s source code and concluding that the code looks right; the goal is +instead a rigorous proof that a program produces the right result for all +possible inputs.

    +

    The technique used to prove programs correct is to write down invariants, +properties of the input data and of the program’s variables that are always +true. For each line of code, you then show that if invariants X and Y are true +before the line is executed, the slightly different invariants X’ and Y’ are +true after the line is executed. This continues until you reach the end of +the program, at which point the invariants should match the desired conditions +on the program’s output.

    +

    Functional programming’s avoidance of assignments arose because assignments are +difficult to handle with this technique; assignments can break invariants that +were true before the assignment without producing any new invariants that can be +propagated onward.

    +

    Unfortunately, proving programs correct is largely impractical and not relevant +to Python software. Even trivial programs require proofs that are several pages +long; the proof of correctness for a moderately complicated program would be +enormous, and few or none of the programs you use daily (the Python interpreter, +your XML parser, your web browser) could be proven correct. Even if you wrote +down or generated a proof, there would then be the question of verifying the +proof; maybe there’s an error in it, and you wrongly believe you’ve proved the +program correct.

    +
    +
    +

    Modularity

    +

    A more practical benefit of functional programming is that it forces you to +break apart your problem into small pieces. Programs are more modular as a +result. It’s easier to specify and write a small function that does one thing +than a large function that performs a complicated transformation. Small +functions are also easier to read and to check for errors.

    +
    +
    +

    Ease of debugging and testing

    +

    Testing and debugging a functional-style program is easier.

    +

    Debugging is simplified because functions are generally small and clearly +specified. When a program doesn’t work, each function is an interface point +where you can check that the data are correct. You can look at the intermediate +inputs and outputs to quickly isolate the function that’s responsible for a bug.

    +

    Testing is easier because each function is a potential subject for a unit test. +Functions don’t depend on system state that needs to be replicated before +running a test; instead you only have to synthesize the right input and then +check that the output matches expectations.

    +
    +
    +

    Composability

    +

    As you work on a functional-style program, you’ll write a number of functions +with varying inputs and outputs. Some of these functions will be unavoidably +specialized to a particular application, but others will be useful in a wide +variety of programs. For example, a function that takes a directory path and +returns all the XML files in the directory, or a function that takes a filename +and returns its contents, can be applied to many different situations.

    +

    Over time you’ll form a personal library of utilities. Often you’ll assemble +new programs by arranging existing functions in a new configuration and writing +a few functions specialized for the current task.

    +
    +
    +
    +

    Iterators

    +

    I’ll start by looking at a Python language feature that’s an important +foundation for writing functional-style programs: iterators.

    +

    An iterator is an object representing a stream of data; this object returns the +data one element at a time. A Python iterator must support a method called +__next__() that takes no arguments and always returns the next +element of the stream. If there are no more elements in the stream, +__next__() must raise the StopIteration exception. +Iterators don’t have to be finite, though; it’s perfectly reasonable to write +an iterator that produces an infinite stream of data.

    +

    The built-in iter() function takes an arbitrary object and tries to return +an iterator that will return the object’s contents or elements, raising +TypeError if the object doesn’t support iteration. Several of Python’s +built-in data types support iteration, the most common being lists and +dictionaries. An object is called iterable if you can get an iterator +for it.

    +

    You can experiment with the iteration interface manually:

    +
    >>> L = [1, 2, 3]
    +>>> it = iter(L)
    +>>> it  #doctest: +ELLIPSIS
    +<...iterator object at ...>
    +>>> it.__next__()  # same as next(it)
    +1
    +>>> next(it)
    +2
    +>>> next(it)
    +3
    +>>> next(it)
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +StopIteration
    +>>>
    +
    +
    +

    Python expects iterable objects in several different contexts, the most +important being the for statement. In the statement for X in Y, +Y must be an iterator or some object for which iter() can create an +iterator. These two statements are equivalent:

    +
    for i in iter(obj):
    +    print(i)
    +
    +for i in obj:
    +    print(i)
    +
    +
    +

    Iterators can be materialized as lists or tuples by using the list() or +tuple() constructor functions:

    +
    >>> L = [1, 2, 3]
    +>>> iterator = iter(L)
    +>>> t = tuple(iterator)
    +>>> t
    +(1, 2, 3)
    +
    +
    +

    Sequence unpacking also supports iterators: if you know an iterator will return +N elements, you can unpack them into an N-tuple:

    +
    >>> L = [1, 2, 3]
    +>>> iterator = iter(L)
    +>>> a, b, c = iterator
    +>>> a, b, c
    +(1, 2, 3)
    +
    +
    +

    Built-in functions such as max() and min() can take a single +iterator argument and will return the largest or smallest element. The "in" +and "not in" operators also support iterators: X in iterator is true if +X is found in the stream returned by the iterator. You’ll run into obvious +problems if the iterator is infinite; max(), min() +will never return, and if the element X never appears in the stream, the +"in" and "not in" operators won’t return either.

    +

    Note that you can only go forward in an iterator; there’s no way to get the +previous element, reset the iterator, or make a copy of it. Iterator objects +can optionally provide these additional capabilities, but the iterator protocol +only specifies the __next__() method. Functions may therefore +consume all of the iterator’s output, and if you need to do something different +with the same stream, you’ll have to create a new iterator.

    +
    +

    Data Types That Support Iterators

    +

    We’ve already seen how lists and tuples support iterators. In fact, any Python +sequence type, such as strings, will automatically support creation of an +iterator.

    +

    Calling iter() on a dictionary returns an iterator that will loop over the +dictionary’s keys:

    +
    >>> m = {'Jan': 1, 'Feb': 2, 'Mar': 3, 'Apr': 4, 'May': 5, 'Jun': 6,
    +...      'Jul': 7, 'Aug': 8, 'Sep': 9, 'Oct': 10, 'Nov': 11, 'Dec': 12}
    +>>> for key in m:
    +...     print(key, m[key])
    +Jan 1
    +Feb 2
    +Mar 3
    +Apr 4
    +May 5
    +Jun 6
    +Jul 7
    +Aug 8
    +Sep 9
    +Oct 10
    +Nov 11
    +Dec 12
    +
    +
    +

    Note that starting with Python 3.7, dictionary iteration order is guaranteed +to be the same as the insertion order. In earlier versions, the behaviour was +unspecified and could vary between implementations.

    +

    Applying iter() to a dictionary always loops over the keys, but +dictionaries have methods that return other iterators. If you want to iterate +over values or key/value pairs, you can explicitly call the +values() or items() methods to get an appropriate +iterator.

    +

    The dict() constructor can accept an iterator that returns a finite stream +of (key, value) tuples:

    +
    >>> L = [('Italy', 'Rome'), ('France', 'Paris'), ('US', 'Washington DC')]
    +>>> dict(iter(L))
    +{'Italy': 'Rome', 'France': 'Paris', 'US': 'Washington DC'}
    +
    +
    +

    Files also support iteration by calling the readline() +method until there are no more lines in the file. This means you can read each +line of a file like this:

    +
    for line in file:
    +    # do something for each line
    +    ...
    +
    +
    +

    Sets can take their contents from an iterable and let you iterate over the set’s +elements:

    +
    S = {2, 3, 5, 7, 11, 13}
    +for i in S:
    +    print(i)
    +
    +
    +
    +
    +
    +

    Generator expressions and list comprehensions

    +

    Two common operations on an iterator’s output are 1) performing some operation +for every element, 2) selecting a subset of elements that meet some condition. +For example, given a list of strings, you might want to strip off trailing +whitespace from each line or extract all the strings containing a given +substring.

    +

    List comprehensions and generator expressions (short form: “listcomps” and +“genexps”) are a concise notation for such operations, borrowed from the +functional programming language Haskell (https://www.haskell.org/). You can strip +all the whitespace from a stream of strings with the following code:

    +
    line_list = ['  line 1\n', 'line 2  \n', ...]
    +
    +# Generator expression -- returns iterator
    +stripped_iter = (line.strip() for line in line_list)
    +
    +# List comprehension -- returns list
    +stripped_list = [line.strip() for line in line_list]
    +
    +
    +

    You can select only certain elements by adding an "if" condition:

    +
    stripped_list = [line.strip() for line in line_list
    +                 if line != ""]
    +
    +
    +

    With a list comprehension, you get back a Python list; stripped_list is a +list containing the resulting lines, not an iterator. Generator expressions +return an iterator that computes the values as necessary, not needing to +materialize all the values at once. This means that list comprehensions aren’t +useful if you’re working with iterators that return an infinite stream or a very +large amount of data. Generator expressions are preferable in these situations.

    +

    Generator expressions are surrounded by parentheses (“()”) and list +comprehensions are surrounded by square brackets (“[]”). Generator expressions +have the form:

    +
    ( expression for expr in sequence1
    +             if condition1
    +             for expr2 in sequence2
    +             if condition2
    +             for expr3 in sequence3 ...
    +             if condition3
    +             for exprN in sequenceN
    +             if conditionN )
    +
    +
    +

    Again, for a list comprehension only the outside brackets are different (square +brackets instead of parentheses).

    +

    The elements of the generated output will be the successive values of +expression. The if clauses are all optional; if present, expression +is only evaluated and added to the result when condition is true.

    +

    Generator expressions always have to be written inside parentheses, but the +parentheses signalling a function call also count. If you want to create an +iterator that will be immediately passed to a function you can write:

    +
    obj_total = sum(obj.count for obj in list_all_objects())
    +
    +
    +

    The for...in clauses contain the sequences to be iterated over. The +sequences do not have to be the same length, because they are iterated over from +left to right, not in parallel. For each element in sequence1, +sequence2 is looped over from the beginning. sequence3 is then looped +over for each resulting pair of elements from sequence1 and sequence2.

    +

    To put it another way, a list comprehension or generator expression is +equivalent to the following Python code:

    +
    for expr1 in sequence1:
    +    if not (condition1):
    +        continue   # Skip this element
    +    for expr2 in sequence2:
    +        if not (condition2):
    +            continue   # Skip this element
    +        ...
    +        for exprN in sequenceN:
    +            if not (conditionN):
    +                continue   # Skip this element
    +
    +            # 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 +lengths of all the sequences. If you have two lists of length 3, the output +list is 9 elements long:

    +
    >>> seq1 = 'abc'
    +>>> seq2 = (1, 2, 3)
    +>>> [(x, y) for x in seq1 for y in seq2]  #doctest: +NORMALIZE_WHITESPACE
    +[('a', 1), ('a', 2), ('a', 3),
    + ('b', 1), ('b', 2), ('b', 3),
    + ('c', 1), ('c', 2), ('c', 3)]
    +
    +
    +

    To avoid introducing an ambiguity into Python’s grammar, if expression is +creating a tuple, it must be surrounded with parentheses. The first list +comprehension below is a syntax error, while the second one is correct:

    +
    # Syntax error
    +[x, y for x in seq1 for y in seq2]
    +# Correct
    +[(x, y) for x in seq1 for y in seq2]
    +
    +
    +
    +
    +

    Generators

    +

    Generators are a special class of functions that simplify the task of writing +iterators. Regular functions compute a value and return it, but generators +return an iterator that returns a stream of values.

    +

    You’re doubtless familiar with how regular function calls work in Python or C. +When you call a function, it gets a private namespace where its local variables +are created. When the function reaches a return statement, the local +variables are destroyed and the value is returned to the caller. A later call +to the same function creates a new private namespace and a fresh set of local +variables. But, what if the local variables weren’t thrown away on exiting a +function? What if you could later resume the function where it left off? This +is what generators provide; they can be thought of as resumable functions.

    +

    Here’s the simplest example of a generator function:

    +
    >>> def generate_ints(N):
    +...    for i in range(N):
    +...        yield i
    +
    +
    +

    Any function containing a yield keyword is a generator function; +this is detected by Python’s bytecode compiler which compiles the +function specially as a result.

    +

    When you call a generator function, it doesn’t return a single value; instead it +returns a generator object that supports the iterator protocol. On executing +the yield expression, the generator outputs the value of i, similar to a +return statement. The big difference between yield and a return +statement is that on reaching a yield the generator’s state of execution is +suspended and local variables are preserved. On the next call to the +generator’s __next__() method, the function will resume +executing.

    +

    Here’s a sample usage of the generate_ints() generator:

    +
    >>> gen = generate_ints(3)
    +>>> gen  #doctest: +ELLIPSIS
    +<generator object generate_ints at ...>
    +>>> next(gen)
    +0
    +>>> next(gen)
    +1
    +>>> next(gen)
    +2
    +>>> next(gen)
    +Traceback (most recent call last):
    +  File "stdin", line 1, in <module>
    +  File "stdin", line 2, in generate_ints
    +StopIteration
    +
    +
    +

    You could equally write for i in generate_ints(5), or a, b, c = +generate_ints(3).

    +

    Inside a generator function, return value causes StopIteration(value) +to be raised from the __next__() method. Once this happens, or +the bottom of the function is reached, the procession of values ends and the +generator cannot yield any further values.

    +

    You could achieve the effect of generators manually by writing your own class +and storing all the local variables of the generator as instance variables. For +example, returning a list of integers could be done by setting self.count to +0, and having the __next__() method increment self.count and +return it. +However, for a moderately complicated generator, writing a corresponding class +can be much messier.

    +

    The test suite included with Python’s library, +Lib/test/test_generators.py, contains +a number of more interesting examples. Here’s one generator that implements an +in-order traversal of a tree using generators recursively.

    +
    # A recursive generator that generates Tree leaves in in-order.
    +def inorder(t):
    +    if t:
    +        for x in inorder(t.left):
    +            yield x
    +
    +        yield t.label
    +
    +        for x in inorder(t.right):
    +            yield x
    +
    +
    +

    Two other examples in test_generators.py produce solutions for the N-Queens +problem (placing N queens on an NxN chess board so that no queen threatens +another) and the Knight’s Tour (finding a route that takes a knight to every +square of an NxN chessboard without visiting any square twice).

    +
    +

    Passing values into a generator

    +

    In Python 2.4 and earlier, generators only produced output. Once a generator’s +code was invoked to create an iterator, there was no way to pass any new +information into the function when its execution is resumed. You could hack +together this ability by making the generator look at a global variable or by +passing in some mutable object that callers then modify, but these approaches +are messy.

    +

    In Python 2.5 there’s a simple way to pass values into a generator. +yield became an expression, returning a value that can be assigned to +a variable or otherwise operated on:

    +
    val = (yield i)
    +
    +
    +

    I recommend that you always put parentheses around a yield expression +when you’re doing something with the returned value, as in the above example. +The parentheses aren’t always necessary, but it’s easier to always add them +instead of having to remember when they’re needed.

    +

    (PEP 342 explains the exact rules, which are that a yield-expression must +always be parenthesized except when it occurs at the top-level expression on the +right-hand side of an assignment. This means you can write val = yield i +but have to use parentheses when there’s an operation, as in val = (yield i) ++ 12.)

    +

    Values are sent into a generator by calling its send(value) method. This method resumes the generator’s code and the +yield expression returns the specified value. If the regular +__next__() method is called, the yield returns None.

    +

    Here’s a simple counter that increments by 1 and allows changing the value of +the internal counter.

    +
    def counter(maximum):
    +    i = 0
    +    while i < maximum:
    +        val = (yield i)
    +        # If value provided, change counter
    +        if val is not None:
    +            i = val
    +        else:
    +            i += 1
    +
    +
    +

    And here’s an example of changing the counter:

    +
    >>> it = counter(10)  #doctest: +SKIP
    +>>> next(it)  #doctest: +SKIP
    +0
    +>>> next(it)  #doctest: +SKIP
    +1
    +>>> it.send(8)  #doctest: +SKIP
    +8
    +>>> next(it)  #doctest: +SKIP
    +9
    +>>> next(it)  #doctest: +SKIP
    +Traceback (most recent call last):
    +  File "t.py", line 15, in <module>
    +    it.next()
    +StopIteration
    +
    +
    +

    Because yield will often be returning None, you should always check for +this case. Don’t just use its value in expressions unless you’re sure that the +send() method will be the only method used to resume your +generator function.

    +

    In addition to send(), there are two other methods on +generators:

    +
      +
    • throw(type, value=None, traceback=None) is used to +raise an exception inside the generator; the exception is raised by the +yield expression where the generator’s execution is paused.

    • +
    • close() raises a GeneratorExit exception inside the +generator to terminate the iteration. On receiving this exception, the +generator’s code must either raise GeneratorExit or +StopIteration; catching the exception and doing anything else is +illegal and will trigger a RuntimeError. close() +will also be called by Python’s garbage collector when the generator is +garbage-collected.

      +

      If you need to run cleanup code when a GeneratorExit occurs, I suggest +using a try: ... finally: suite instead of catching GeneratorExit.

      +
    • +
    +

    The cumulative effect of these changes is to turn generators from one-way +producers of information into both producers and consumers.

    +

    Generators also become coroutines, a more generalized form of subroutines. +Subroutines are entered at one point and exited at another point (the top of the +function, and a return statement), but coroutines can be entered, exited, +and resumed at many different points (the yield statements).

    +
    +
    +
    +

    Built-in functions

    +

    Let’s look in more detail at built-in functions often used with iterators.

    +

    Two of Python’s built-in functions, map() and filter() duplicate the +features of generator expressions:

    +
    +
    map(f, iterA, iterB, ...) returns an iterator over the sequence

    f(iterA[0], iterB[0]), f(iterA[1], iterB[1]), f(iterA[2], iterB[2]), ....

    +
    >>> def upper(s):
    +...     return s.upper()
    +
    +
    +
    >>> list(map(upper, ['sentence', 'fragment']))
    +['SENTENCE', 'FRAGMENT']
    +>>> [upper(s) for s in ['sentence', 'fragment']]
    +['SENTENCE', 'FRAGMENT']
    +
    +
    +
    +
    +

    You can of course achieve the same effect with a list comprehension.

    +

    filter(predicate, iter) returns an iterator over all the +sequence elements that meet a certain condition, and is similarly duplicated by +list comprehensions. A predicate is a function that returns the truth +value of some condition; for use with filter(), the predicate must take a +single value.

    +
    >>> def is_even(x):
    +...     return (x % 2) == 0
    +
    +
    +
    >>> list(filter(is_even, range(10)))
    +[0, 2, 4, 6, 8]
    +
    +
    +

    This can also be written as a list comprehension:

    +
    >>> list(x for x in range(10) if is_even(x))
    +[0, 2, 4, 6, 8]
    +
    +
    +

    enumerate(iter, start=0) counts off the elements in the +iterable returning 2-tuples containing the count (from start) and +each element.

    +
    >>> for item in enumerate(['subject', 'verb', 'object']):
    +...     print(item)
    +(0, 'subject')
    +(1, 'verb')
    +(2, 'object')
    +
    +
    +

    enumerate() is often used when looping through a list and recording the +indexes at which certain conditions are met:

    +
    f = open('data.txt', 'r')
    +for i, line in enumerate(f):
    +    if line.strip() == '':
    +        print('Blank line at line #%i' % i)
    +
    +
    +

    sorted(iterable, key=None, reverse=False) collects all the +elements of the iterable into a list, sorts the list, and returns the sorted +result. The key and reverse arguments are passed through to the +constructed list’s sort() method.

    +
    >>> import random
    +>>> # Generate 8 random numbers between [0, 10000)
    +>>> rand_list = random.sample(range(10000), 8)
    +>>> rand_list  
    +[769, 7953, 9828, 6431, 8442, 9878, 6213, 2207]
    +>>> sorted(rand_list)  
    +[769, 2207, 6213, 6431, 7953, 8442, 9828, 9878]
    +>>> sorted(rand_list, reverse=True)  
    +[9878, 9828, 8442, 7953, 6431, 6213, 2207, 769]
    +
    +
    +

    (For a more detailed discussion of sorting, see the Sorting HOW TO.)

    +

    The any(iter) and all(iter) built-ins look at the +truth values of an iterable’s contents. any() returns True if any element +in the iterable is a true value, and all() returns True if all of the +elements are true values:

    +
    >>> any([0, 1, 0])
    +True
    +>>> any([0, 0, 0])
    +False
    +>>> any([1, 1, 1])
    +True
    +>>> all([0, 1, 0])
    +False
    +>>> all([0, 0, 0])
    +False
    +>>> all([1, 1, 1])
    +True
    +
    +
    +

    zip(iterA, iterB, ...) takes one element from each iterable and +returns them in a tuple:

    +
    zip(['a', 'b', 'c'], (1, 2, 3)) =>
    +  ('a', 1), ('b', 2), ('c', 3)
    +
    +
    +

    It doesn’t construct an in-memory list and exhaust all the input iterators +before returning; instead tuples are constructed and returned only if they’re +requested. (The technical term for this behaviour is lazy evaluation.)

    +

    This iterator is intended to be used with iterables that are all of the same +length. If the iterables are of different lengths, the resulting stream will be +the same length as the shortest iterable.

    +
    zip(['a', 'b'], (1, 2, 3)) =>
    +  ('a', 1), ('b', 2)
    +
    +
    +

    You should avoid doing this, though, because an element may be taken from the +longer iterators and discarded. This means you can’t go on to use the iterators +further because you risk skipping a discarded element.

    +
    +
    +

    The itertools module

    +

    The itertools module contains a number of commonly-used iterators as well +as functions for combining several iterators. This section will introduce the +module’s contents by showing small examples.

    +

    The module’s functions fall into a few broad classes:

    +
      +
    • Functions that create a new iterator based on an existing iterator.

    • +
    • Functions for treating an iterator’s elements as function arguments.

    • +
    • Functions for selecting portions of an iterator’s output.

    • +
    • A function for grouping an iterator’s output.

    • +
    +
    +

    Creating new iterators

    +

    itertools.count(start, step) returns an infinite +stream of evenly spaced values. You can optionally supply the starting number, +which defaults to 0, and the interval between numbers, which defaults to 1:

    +
    itertools.count() =>
    +  0, 1, 2, 3, 4, 5, 6, 7, 8, 9, ...
    +itertools.count(10) =>
    +  10, 11, 12, 13, 14, 15, 16, 17, 18, 19, ...
    +itertools.count(10, 5) =>
    +  10, 15, 20, 25, 30, 35, 40, 45, 50, 55, ...
    +
    +
    +

    itertools.cycle(iter) saves a copy of the contents of +a provided iterable and returns a new iterator that returns its elements from +first to last. The new iterator will repeat these elements infinitely.

    +
    itertools.cycle([1, 2, 3, 4, 5]) =>
    +  1, 2, 3, 4, 5, 1, 2, 3, 4, 5, ...
    +
    +
    +

    itertools.repeat(elem, [n]) returns the provided +element n times, or returns the element endlessly if n is not provided.

    +
    itertools.repeat('abc') =>
    +  abc, abc, abc, abc, abc, abc, abc, abc, abc, abc, ...
    +itertools.repeat('abc', 5) =>
    +  abc, abc, abc, abc, abc
    +
    +
    +

    itertools.chain(iterA, iterB, ...) takes an arbitrary +number of iterables as input, and returns all the elements of the first +iterator, then all the elements of the second, and so on, until all of the +iterables have been exhausted.

    +
    itertools.chain(['a', 'b', 'c'], (1, 2, 3)) =>
    +  a, b, c, 1, 2, 3
    +
    +
    +

    itertools.islice(iter, [start], stop, [step]) returns +a stream that’s a slice of the iterator. With a single stop argument, it +will return the first stop elements. If you supply a starting index, you’ll +get stop-start elements, and if you supply a value for step, elements +will be skipped accordingly. Unlike Python’s string and list slicing, you can’t +use negative values for start, stop, or step.

    +
    itertools.islice(range(10), 8) =>
    +  0, 1, 2, 3, 4, 5, 6, 7
    +itertools.islice(range(10), 2, 8) =>
    +  2, 3, 4, 5, 6, 7
    +itertools.islice(range(10), 2, 8, 2) =>
    +  2, 4, 6
    +
    +
    +

    itertools.tee(iter, [n]) replicates an iterator; it +returns n independent iterators that will all return the contents of the +source iterator. +If you don’t supply a value for n, the default is 2. Replicating iterators +requires saving some of the contents of the source iterator, so this can consume +significant memory if the iterator is large and one of the new iterators is +consumed more than the others.

    +
    itertools.tee( itertools.count() ) =>
    +   iterA, iterB
    +
    +where iterA ->
    +   0, 1, 2, 3, 4, 5, 6, 7, 8, 9, ...
    +
    +and   iterB ->
    +   0, 1, 2, 3, 4, 5, 6, 7, 8, 9, ...
    +
    +
    +
    +
    +

    Calling functions on elements

    +

    The operator module contains a set of functions corresponding to Python’s +operators. Some examples are operator.add(a, b) (adds +two values), operator.ne(a, b) (same as a != b), and +operator.attrgetter('id') +(returns a callable that fetches the .id attribute).

    +

    itertools.starmap(func, iter) assumes that the +iterable will return a stream of tuples, and calls func using these tuples as +the arguments:

    +
    itertools.starmap(os.path.join,
    +                  [('/bin', 'python'), ('/usr', 'bin', 'java'),
    +                   ('/usr', 'bin', 'perl'), ('/usr', 'bin', 'ruby')])
    +=>
    +  /bin/python, /usr/bin/java, /usr/bin/perl, /usr/bin/ruby
    +
    +
    +
    +
    +

    Selecting elements

    +

    Another group of functions chooses a subset of an iterator’s elements based on a +predicate.

    +

    itertools.filterfalse(predicate, iter) is the +opposite of filter(), returning all elements for which the predicate +returns false:

    +
    itertools.filterfalse(is_even, itertools.count()) =>
    +  1, 3, 5, 7, 9, 11, 13, 15, ...
    +
    +
    +

    itertools.takewhile(predicate, iter) returns +elements for as long as the predicate returns true. Once the predicate returns +false, the iterator will signal the end of its results.

    +
    def less_than_10(x):
    +    return x < 10
    +
    +itertools.takewhile(less_than_10, itertools.count()) =>
    +  0, 1, 2, 3, 4, 5, 6, 7, 8, 9
    +
    +itertools.takewhile(is_even, itertools.count()) =>
    +  0
    +
    +
    +

    itertools.dropwhile(predicate, iter) discards +elements while the predicate returns true, and then returns the rest of the +iterable’s results.

    +
    itertools.dropwhile(less_than_10, itertools.count()) =>
    +  10, 11, 12, 13, 14, 15, 16, 17, 18, 19, ...
    +
    +itertools.dropwhile(is_even, itertools.count()) =>
    +  1, 2, 3, 4, 5, 6, 7, 8, 9, 10, ...
    +
    +
    +

    itertools.compress(data, selectors) takes two +iterators and returns only those elements of data for which the corresponding +element of selectors is true, stopping whenever either one is exhausted:

    +
    itertools.compress([1, 2, 3, 4, 5], [True, True, False, False, True]) =>
    +   1, 2, 5
    +
    +
    +
    +
    +

    Combinatoric functions

    +

    The itertools.combinations(iterable, r) +returns an iterator giving all possible r-tuple combinations of the +elements contained in iterable.

    +
    itertools.combinations([1, 2, 3, 4, 5], 2) =>
    +  (1, 2), (1, 3), (1, 4), (1, 5),
    +  (2, 3), (2, 4), (2, 5),
    +  (3, 4), (3, 5),
    +  (4, 5)
    +
    +itertools.combinations([1, 2, 3, 4, 5], 3) =>
    +  (1, 2, 3), (1, 2, 4), (1, 2, 5), (1, 3, 4), (1, 3, 5), (1, 4, 5),
    +  (2, 3, 4), (2, 3, 5), (2, 4, 5),
    +  (3, 4, 5)
    +
    +
    +

    The elements within each tuple remain in the same order as +iterable returned them. For example, the number 1 is always before +2, 3, 4, or 5 in the examples above. A similar function, +itertools.permutations(iterable, r=None), +removes this constraint on the order, returning all possible +arrangements of length r:

    +
    itertools.permutations([1, 2, 3, 4, 5], 2) =>
    +  (1, 2), (1, 3), (1, 4), (1, 5),
    +  (2, 1), (2, 3), (2, 4), (2, 5),
    +  (3, 1), (3, 2), (3, 4), (3, 5),
    +  (4, 1), (4, 2), (4, 3), (4, 5),
    +  (5, 1), (5, 2), (5, 3), (5, 4)
    +
    +itertools.permutations([1, 2, 3, 4, 5]) =>
    +  (1, 2, 3, 4, 5), (1, 2, 3, 5, 4), (1, 2, 4, 3, 5),
    +  ...
    +  (5, 4, 3, 2, 1)
    +
    +
    +

    If you don’t supply a value for r the length of the iterable is used, +meaning that all the elements are permuted.

    +

    Note that these functions produce all of the possible combinations by +position and don’t require that the contents of iterable are unique:

    +
    itertools.permutations('aba', 3) =>
    +  ('a', 'b', 'a'), ('a', 'a', 'b'), ('b', 'a', 'a'),
    +  ('b', 'a', 'a'), ('a', 'a', 'b'), ('a', 'b', 'a')
    +
    +
    +

    The identical tuple ('a', 'a', 'b') occurs twice, but the two ‘a’ +strings came from different positions.

    +

    The itertools.combinations_with_replacement(iterable, r) +function relaxes a different constraint: elements can be repeated +within a single tuple. Conceptually an element is selected for the +first position of each tuple and then is replaced before the second +element is selected.

    +
    itertools.combinations_with_replacement([1, 2, 3, 4, 5], 2) =>
    +  (1, 1), (1, 2), (1, 3), (1, 4), (1, 5),
    +  (2, 2), (2, 3), (2, 4), (2, 5),
    +  (3, 3), (3, 4), (3, 5),
    +  (4, 4), (4, 5),
    +  (5, 5)
    +
    +
    +
    +
    +

    Grouping elements

    +

    The last function I’ll discuss, itertools.groupby(iter, key_func=None), is the most complicated. key_func(elem) is a function +that can compute a key value for each element returned by the iterable. If you +don’t supply a key function, the key is simply each element itself.

    +

    groupby() collects all the consecutive elements from the +underlying iterable that have the same key value, and returns a stream of +2-tuples containing a key value and an iterator for the elements with that key.

    +
    city_list = [('Decatur', 'AL'), ('Huntsville', 'AL'), ('Selma', 'AL'),
    +             ('Anchorage', 'AK'), ('Nome', 'AK'),
    +             ('Flagstaff', 'AZ'), ('Phoenix', 'AZ'), ('Tucson', 'AZ'),
    +             ...
    +            ]
    +
    +def get_state(city_state):
    +    return city_state[1]
    +
    +itertools.groupby(city_list, get_state) =>
    +  ('AL', iterator-1),
    +  ('AK', iterator-2),
    +  ('AZ', iterator-3), ...
    +
    +where
    +iterator-1 =>
    +  ('Decatur', 'AL'), ('Huntsville', 'AL'), ('Selma', 'AL')
    +iterator-2 =>
    +  ('Anchorage', 'AK'), ('Nome', 'AK')
    +iterator-3 =>
    +  ('Flagstaff', 'AZ'), ('Phoenix', 'AZ'), ('Tucson', 'AZ')
    +
    +
    +

    groupby() assumes that the underlying iterable’s contents will +already be sorted based on the key. Note that the returned iterators also use +the underlying iterable, so you have to consume the results of iterator-1 before +requesting iterator-2 and its corresponding key.

    +
    +
    +
    +

    The functools module

    +

    The functools module in Python 2.5 contains some higher-order functions. +A higher-order function takes one or more functions as input and returns a +new function. The most useful tool in this module is the +functools.partial() function.

    +

    For programs written in a functional style, you’ll sometimes want to construct +variants of existing functions that have some of the parameters filled in. +Consider a Python function f(a, b, c); you may wish to create a new function +g(b, c) that’s equivalent to f(1, b, c); you’re filling in a value for +one of f()’s parameters. This is called “partial function application”.

    +

    The constructor for partial() takes the arguments +(function, arg1, arg2, ..., kwarg1=value1, kwarg2=value2). The resulting +object is callable, so you can just call it to invoke function with the +filled-in arguments.

    +

    Here’s a small but realistic example:

    +
    import functools
    +
    +def log(message, subsystem):
    +    """Write the contents of 'message' to the specified subsystem."""
    +    print('%s: %s' % (subsystem, message))
    +    ...
    +
    +server_log = functools.partial(log, subsystem='server')
    +server_log('Unable to open socket')
    +
    +
    +

    functools.reduce(func, iter, [initial_value]) +cumulatively performs an operation on all the iterable’s elements and, +therefore, can’t be applied to infinite iterables. func must be a function +that takes two elements and returns a single value. functools.reduce() +takes the first two elements A and B returned by the iterator and calculates +func(A, B). It then requests the third element, C, calculates +func(func(A, B), C), combines this result with the fourth element returned, +and continues until the iterable is exhausted. If the iterable returns no +values at all, a TypeError exception is raised. If the initial value is +supplied, it’s used as a starting point and func(initial_value, A) is the +first calculation.

    +
    >>> import operator, functools
    +>>> functools.reduce(operator.concat, ['A', 'BB', 'C'])
    +'ABBC'
    +>>> functools.reduce(operator.concat, [])
    +Traceback (most recent call last):
    +  ...
    +TypeError: reduce() of empty sequence with no initial value
    +>>> functools.reduce(operator.mul, [1, 2, 3], 1)
    +6
    +>>> functools.reduce(operator.mul, [], 1)
    +1
    +
    +
    +

    If you use operator.add() with functools.reduce(), you’ll add up all the +elements of the iterable. This case is so common that there’s a special +built-in called sum() to compute it:

    +
    >>> import functools, operator
    +>>> functools.reduce(operator.add, [1, 2, 3, 4], 0)
    +10
    +>>> sum([1, 2, 3, 4])
    +10
    +>>> sum([])
    +0
    +
    +
    +

    For many uses of functools.reduce(), though, it can be clearer to just +write the obvious for loop:

    +
    import functools
    +# Instead of:
    +product = functools.reduce(operator.mul, [1, 2, 3], 1)
    +
    +# You can write:
    +product = 1
    +for i in [1, 2, 3]:
    +    product *= i
    +
    +
    +

    A related function is itertools.accumulate(iterable, func=operator.add). It performs the same calculation, but instead of +returning only the final result, accumulate() returns an iterator that +also yields each partial result:

    +
    itertools.accumulate([1, 2, 3, 4, 5]) =>
    +  1, 3, 6, 10, 15
    +
    +itertools.accumulate([1, 2, 3, 4, 5], operator.mul) =>
    +  1, 2, 6, 24, 120
    +
    +
    +
    +

    The operator module

    +

    The operator module was mentioned earlier. It contains a set of +functions corresponding to Python’s operators. These functions are often useful +in functional-style code because they save you from writing trivial functions +that perform a single operation.

    +

    Some of the functions in this module are:

    +
      +
    • Math operations: add(), sub(), mul(), floordiv(), abs(), …

    • +
    • Logical operations: not_(), truth().

    • +
    • Bitwise operations: and_(), or_(), invert().

    • +
    • Comparisons: eq(), ne(), lt(), le(), gt(), and ge().

    • +
    • Object identity: is_(), is_not().

    • +
    +

    Consult the operator module’s documentation for a complete list.

    +
    +
    +
    +

    Small functions and the lambda expression

    +

    When writing functional-style programs, you’ll often need little functions that +act as predicates or that combine elements in some way.

    +

    If there’s a Python built-in or a module function that’s suitable, you don’t +need to define a new function at all:

    +
    stripped_lines = [line.strip() for line in lines]
    +existing_files = filter(os.path.exists, file_list)
    +
    +
    +

    If the function you need doesn’t exist, you need to write it. One way to write +small functions is to use the lambda expression. lambda takes a +number of parameters and an expression combining these parameters, and creates +an anonymous function that returns the value of the expression:

    +
    adder = lambda x, y: x+y
    +
    +print_assign = lambda name, value: name + '=' + str(value)
    +
    +
    +

    An alternative is to just use the def statement and define a function in the +usual way:

    +
    def adder(x, y):
    +    return x + y
    +
    +def print_assign(name, value):
    +    return name + '=' + str(value)
    +
    +
    +

    Which alternative is preferable? That’s a style question; my usual course is to +avoid using lambda.

    +

    One reason for my preference is that lambda is quite limited in the +functions it can define. The result has to be computable as a single +expression, which means you can’t have multiway if... elif... else +comparisons or try... except statements. If you try to do too much in a +lambda statement, you’ll end up with an overly complicated expression that’s +hard to read. Quick, what’s the following code doing?

    +
    import functools
    +total = functools.reduce(lambda a, b: (0, a[1] + b[1]), items)[1]
    +
    +
    +

    You can figure it out, but it takes time to disentangle the expression to figure +out what’s going on. Using a short nested def statements makes things a +little bit better:

    +
    import functools
    +def combine(a, b):
    +    return 0, a[1] + b[1]
    +
    +total = functools.reduce(combine, items)[1]
    +
    +
    +

    But it would be best of all if I had simply used a for loop:

    +
    total = 0
    +for a, b in items:
    +    total += b
    +
    +
    +

    Or the sum() built-in and a generator expression:

    +
    total = sum(b for a, b in items)
    +
    +
    +

    Many uses of functools.reduce() are clearer when written as for loops.

    +

    Fredrik Lundh once suggested the following set of rules for refactoring uses of +lambda:

    +
      +
    1. Write a lambda function.

    2. +
    3. Write a comment explaining what the heck that lambda does.

    4. +
    5. Study the comment for a while, and think of a name that captures the essence +of the comment.

    6. +
    7. Convert the lambda to a def statement, using that name.

    8. +
    9. Remove the comment.

    10. +
    +

    I really like these rules, but you’re free to disagree +about whether this lambda-free style is better.

    +
    +
    +

    Revision History and Acknowledgements

    +

    The author would like to thank the following people for offering suggestions, +corrections and assistance with various drafts of this article: Ian Bicking, +Nick Coghlan, Nick Efford, Raymond Hettinger, Jim Jewett, Mike Krell, Leandro +Lameiro, Jussi Salmela, Collin Winter, Blake Winton.

    +

    Version 0.1: posted June 30 2006.

    +

    Version 0.11: posted July 1 2006. Typo fixes.

    +

    Version 0.2: posted July 10 2006. Merged genexp and listcomp sections into one. +Typo fixes.

    +

    Version 0.21: Added more references suggested on the tutor mailing list.

    +

    Version 0.30: Adds a section on the functional module written by Collin +Winter; adds short section on the operator module; a few other edits.

    +
    +
    +

    References

    +
    +

    General

    +

    Structure and Interpretation of Computer Programs, by Harold Abelson and +Gerald Jay Sussman with Julie Sussman. Full text at +https://mitpress.mit.edu/sicp/. In this classic textbook of computer science, +chapters 2 and 3 discuss the use of sequences and streams to organize the data +flow inside a program. The book uses Scheme for its examples, but many of the +design approaches described in these chapters are applicable to functional-style +Python code.

    +

    http://www.defmacro.org/ramblings/fp.html: A general introduction to functional +programming that uses Java examples and has a lengthy historical introduction.

    +

    https://en.wikipedia.org/wiki/Functional_programming: General Wikipedia entry +describing functional programming.

    +

    https://en.wikipedia.org/wiki/Coroutine: Entry for coroutines.

    +

    https://en.wikipedia.org/wiki/Currying: Entry for the concept of currying.

    +
    +
    +

    Python-specific

    +

    http://gnosis.cx/TPiP/: The first chapter of David Mertz’s book +Text Processing in Python discusses functional programming +for text processing, in the section titled “Utilizing Higher-Order Functions in +Text Processing”.

    +

    Mertz also wrote a 3-part series of articles on functional programming +for IBM’s DeveloperWorks site; see +part 1, +part 2, and +part 3,

    +
    +
    +

    Python documentation

    +

    Documentation for the itertools module.

    +

    Documentation for the functools module.

    +

    Documentation for the operator module.

    +

    PEP 289: “Generator Expressions”

    +

    PEP 342: “Coroutines via Enhanced Generators” describes the new generator +features in Python 2.5.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/howto/index.html b/python-3.7.4-docs-html/howto/index.html new file mode 100644 index 0000000..5903ebd --- /dev/null +++ b/python-3.7.4-docs-html/howto/index.html @@ -0,0 +1,205 @@ + + + + + + + Python HOWTOs — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Python HOWTOs

    +

    Python HOWTOs are documents that cover a single, specific topic, +and attempt to cover it fairly completely. Modelled on the Linux +Documentation Project’s HOWTO collection, this collection is an +effort to foster documentation that’s more detailed than the +Python Library Reference.

    +

    Currently, the HOWTOs are:

    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/howto/instrumentation.html b/python-3.7.4-docs-html/howto/instrumentation.html new file mode 100644 index 0000000..5875ec9 --- /dev/null +++ b/python-3.7.4-docs-html/howto/instrumentation.html @@ -0,0 +1,598 @@ + + + + + + + Instrumenting CPython with DTrace and SystemTap — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Instrumenting CPython with DTrace and SystemTap

    +
    +
    author
    +

    David Malcolm

    +
    +
    author
    +

    Łukasz Langa

    +
    +
    +

    DTrace and SystemTap are monitoring tools, each providing a way to inspect +what the processes on a computer system are doing. They both use +domain-specific languages allowing a user to write scripts which:

    +
    +
      +
    • filter which processes are to be observed

    • +
    • gather data from the processes of interest

    • +
    • generate reports on the data

    • +
    +
    +

    As of Python 3.6, CPython can be built with embedded “markers”, also +known as “probes”, that can be observed by a DTrace or SystemTap script, +making it easier to monitor what the CPython processes on a system are +doing.

    +
    +

    CPython implementation detail: DTrace markers are implementation details of the CPython interpreter. +No guarantees are made about probe compatibility between versions of +CPython. DTrace scripts can stop working or work incorrectly without +warning when changing CPython versions.

    +
    +
    +

    Enabling the static markers

    +

    macOS comes with built-in support for DTrace. On Linux, in order to +build CPython with the embedded markers for SystemTap, the SystemTap +development tools must be installed.

    +

    On a Linux machine, this can be done via:

    +
    $ yum install systemtap-sdt-devel
    +
    +
    +

    or:

    +
    $ sudo apt-get install systemtap-sdt-dev
    +
    +
    +

    CPython must then be configured --with-dtrace:

    +
    checking for --with-dtrace... yes
    +
    +
    +

    On macOS, you can list available DTrace probes by running a Python +process in the background and listing all probes made available by the +Python provider:

    +
    $ python3.6 -q &
    +$ sudo dtrace -l -P python$!  # or: dtrace -l -m python3.6
    +
    +   ID   PROVIDER            MODULE                          FUNCTION NAME
    +29564 python18035        python3.6          _PyEval_EvalFrameDefault function-entry
    +29565 python18035        python3.6             dtrace_function_entry function-entry
    +29566 python18035        python3.6          _PyEval_EvalFrameDefault function-return
    +29567 python18035        python3.6            dtrace_function_return function-return
    +29568 python18035        python3.6                           collect gc-done
    +29569 python18035        python3.6                           collect gc-start
    +29570 python18035        python3.6          _PyEval_EvalFrameDefault line
    +29571 python18035        python3.6                 maybe_dtrace_line line
    +
    +
    +

    On Linux, you can verify if the SystemTap static markers are present in +the built binary by seeing if it contains a “.note.stapsdt” section.

    +
    $ readelf -S ./python | grep .note.stapsdt
    +[30] .note.stapsdt        NOTE         0000000000000000 00308d78
    +
    +
    +

    If you’ve built Python as a shared library (with –enable-shared), you +need to look instead within the shared library. For example:

    +
    $ readelf -S libpython3.3dm.so.1.0 | grep .note.stapsdt
    +[29] .note.stapsdt        NOTE         0000000000000000 00365b68
    +
    +
    +

    Sufficiently modern readelf can print the metadata:

    +
    $ readelf -n ./python
    +
    +Displaying notes found at file offset 0x00000254 with length 0x00000020:
    +    Owner                 Data size          Description
    +    GNU                  0x00000010          NT_GNU_ABI_TAG (ABI version tag)
    +        OS: Linux, ABI: 2.6.32
    +
    +Displaying notes found at file offset 0x00000274 with length 0x00000024:
    +    Owner                 Data size          Description
    +    GNU                  0x00000014          NT_GNU_BUILD_ID (unique build ID bitstring)
    +        Build ID: df924a2b08a7e89f6e11251d4602022977af2670
    +
    +Displaying notes found at file offset 0x002d6c30 with length 0x00000144:
    +    Owner                 Data size          Description
    +    stapsdt              0x00000031          NT_STAPSDT (SystemTap probe descriptors)
    +        Provider: python
    +        Name: gc__start
    +        Location: 0x00000000004371c3, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6bf6
    +        Arguments: -4@%ebx
    +    stapsdt              0x00000030          NT_STAPSDT (SystemTap probe descriptors)
    +        Provider: python
    +        Name: gc__done
    +        Location: 0x00000000004374e1, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6bf8
    +        Arguments: -8@%rax
    +    stapsdt              0x00000045          NT_STAPSDT (SystemTap probe descriptors)
    +        Provider: python
    +        Name: function__entry
    +        Location: 0x000000000053db6c, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6be8
    +        Arguments: 8@%rbp 8@%r12 -4@%eax
    +    stapsdt              0x00000046          NT_STAPSDT (SystemTap probe descriptors)
    +        Provider: python
    +        Name: function__return
    +        Location: 0x000000000053dba8, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6bea
    +        Arguments: 8@%rbp 8@%r12 -4@%eax
    +
    +
    +

    The above metadata contains information for SystemTap describing how it +can patch strategically-placed machine code instructions to enable the +tracing hooks used by a SystemTap script.

    +
    +
    +

    Static DTrace probes

    +

    The following example DTrace script can be used to show the call/return +hierarchy of a Python script, only tracing within the invocation of +a function called “start”. In other words, import-time function +invocations are not going to be listed:

    +
    self int indent;
    +
    +python$target:::function-entry
    +/copyinstr(arg1) == "start"/
    +{
    +        self->trace = 1;
    +}
    +
    +python$target:::function-entry
    +/self->trace/
    +{
    +        printf("%d\t%*s:", timestamp, 15, probename);
    +        printf("%*s", self->indent, "");
    +        printf("%s:%s:%d\n", basename(copyinstr(arg0)), copyinstr(arg1), arg2);
    +        self->indent++;
    +}
    +
    +python$target:::function-return
    +/self->trace/
    +{
    +        self->indent--;
    +        printf("%d\t%*s:", timestamp, 15, probename);
    +        printf("%*s", self->indent, "");
    +        printf("%s:%s:%d\n", basename(copyinstr(arg0)), copyinstr(arg1), arg2);
    +}
    +
    +python$target:::function-return
    +/copyinstr(arg1) == "start"/
    +{
    +        self->trace = 0;
    +}
    +
    +
    +

    It can be invoked like this:

    +
    $ sudo dtrace -q -s call_stack.d -c "python3.6 script.py"
    +
    +
    +

    The output looks like this:

    +
    156641360502280  function-entry:call_stack.py:start:23
    +156641360518804  function-entry: call_stack.py:function_1:1
    +156641360532797  function-entry:  call_stack.py:function_3:9
    +156641360546807 function-return:  call_stack.py:function_3:10
    +156641360563367 function-return: call_stack.py:function_1:2
    +156641360578365  function-entry: call_stack.py:function_2:5
    +156641360591757  function-entry:  call_stack.py:function_1:1
    +156641360605556  function-entry:   call_stack.py:function_3:9
    +156641360617482 function-return:   call_stack.py:function_3:10
    +156641360629814 function-return:  call_stack.py:function_1:2
    +156641360642285 function-return: call_stack.py:function_2:6
    +156641360656770  function-entry: call_stack.py:function_3:9
    +156641360669707 function-return: call_stack.py:function_3:10
    +156641360687853  function-entry: call_stack.py:function_4:13
    +156641360700719 function-return: call_stack.py:function_4:14
    +156641360719640  function-entry: call_stack.py:function_5:18
    +156641360732567 function-return: call_stack.py:function_5:21
    +156641360747370 function-return:call_stack.py:start:28
    +
    +
    +
    +
    +

    Static SystemTap markers

    +

    The low-level way to use the SystemTap integration is to use the static +markers directly. This requires you to explicitly state the binary file +containing them.

    +

    For example, this SystemTap script can be used to show the call/return +hierarchy of a Python script:

    +
    probe process("python").mark("function__entry") {
    +     filename = user_string($arg1);
    +     funcname = user_string($arg2);
    +     lineno = $arg3;
    +
    +     printf("%s => %s in %s:%d\\n",
    +            thread_indent(1), funcname, filename, lineno);
    +}
    +
    +probe process("python").mark("function__return") {
    +    filename = user_string($arg1);
    +    funcname = user_string($arg2);
    +    lineno = $arg3;
    +
    +    printf("%s <= %s in %s:%d\\n",
    +           thread_indent(-1), funcname, filename, lineno);
    +}
    +
    +
    +

    It can be invoked like this:

    +
    $ stap \
    +  show-call-hierarchy.stp \
    +  -c "./python test.py"
    +
    +
    +

    The output looks like this:

    +
    11408 python(8274):        => __contains__ in Lib/_abcoll.py:362
    +11414 python(8274):         => __getitem__ in Lib/os.py:425
    +11418 python(8274):          => encode in Lib/os.py:490
    +11424 python(8274):          <= encode in Lib/os.py:493
    +11428 python(8274):         <= __getitem__ in Lib/os.py:426
    +11433 python(8274):        <= __contains__ in Lib/_abcoll.py:366
    +
    +
    +

    where the columns are:

    +
    +
      +
    • time in microseconds since start of script

    • +
    • name of executable

    • +
    • PID of process

    • +
    +
    +

    and the remainder indicates the call/return hierarchy as the script executes.

    +

    For a –enable-shared build of CPython, the markers are contained within the +libpython shared library, and the probe’s dotted path needs to reflect this. For +example, this line from the above example:

    +
    probe process("python").mark("function__entry") {
    +
    +
    +

    should instead read:

    +
    probe process("python").library("libpython3.6dm.so.1.0").mark("function__entry") {
    +
    +
    +

    (assuming a debug build of CPython 3.6)

    +
    +
    +

    Available static markers

    +
    +
    +function__entry(str filename, str funcname, int lineno)
    +

    This marker indicates that execution of a Python function has begun. +It is only triggered for pure-Python (bytecode) functions.

    +

    The filename, function name, and line number are provided back to the +tracing script as positional arguments, which must be accessed using +$arg1, $arg2, $arg3:

    +
    +
      +
    • $arg1 : (const char *) filename, accessible using user_string($arg1)

    • +
    • $arg2 : (const char *) function name, accessible using +user_string($arg2)

    • +
    • $arg3 : int line number

    • +
    +
    +
    + +
    +
    +function__return(str filename, str funcname, int lineno)
    +

    This marker is the converse of function__entry(), and indicates that +execution of a Python function has ended (either via return, or via an +exception). It is only triggered for pure-Python (bytecode) functions.

    +

    The arguments are the same as for function__entry()

    +
    + +
    +
    +line(str filename, str funcname, int lineno)
    +

    This marker indicates a Python line is about to be executed. It is +the equivalent of line-by-line tracing with a Python profiler. It is +not triggered within C functions.

    +

    The arguments are the same as for function__entry().

    +
    + +
    +
    +gc__start(int generation)
    +

    Fires when the Python interpreter starts a garbage collection cycle. +arg0 is the generation to scan, like gc.collect().

    +
    + +
    +
    +gc__done(long collected)
    +

    Fires when the Python interpreter finishes a garbage collection +cycle. arg0 is the number of collected objects.

    +
    + +
    +
    +import__find__load__start(str modulename)
    +

    Fires before importlib attempts to find and load the module. +arg0 is the module name.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +import__find__load__done(str modulename, int found)
    +

    Fires after importlib’s find_and_load function is called. +arg0 is the module name, arg1 indicates if module was +successfully loaded.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +

    SystemTap Tapsets

    +

    The higher-level way to use the SystemTap integration is to use a “tapset”: +SystemTap’s equivalent of a library, which hides some of the lower-level +details of the static markers.

    +

    Here is a tapset file, based on a non-shared build of CPython:

    +
    /*
    +   Provide a higher-level wrapping around the function__entry and
    +   function__return markers:
    + \*/
    +probe python.function.entry = process("python").mark("function__entry")
    +{
    +    filename = user_string($arg1);
    +    funcname = user_string($arg2);
    +    lineno = $arg3;
    +    frameptr = $arg4
    +}
    +probe python.function.return = process("python").mark("function__return")
    +{
    +    filename = user_string($arg1);
    +    funcname = user_string($arg2);
    +    lineno = $arg3;
    +    frameptr = $arg4
    +}
    +
    +
    +

    If this file is installed in SystemTap’s tapset directory (e.g. +/usr/share/systemtap/tapset), then these additional probepoints become +available:

    +
    +
    +python.function.entry(str filename, str funcname, int lineno, frameptr)
    +

    This probe point indicates that execution of a Python function has begun. +It is only triggered for pure-Python (bytecode) functions.

    +
    + +
    +
    +python.function.return(str filename, str funcname, int lineno, frameptr)
    +

    This probe point is the converse of python.function.return(), and +indicates that execution of a Python function has ended (either via +return, or via an exception). It is only triggered for pure-Python +(bytecode) functions.

    +
    + +
    +
    +

    Examples

    +

    This SystemTap script uses the tapset above to more cleanly implement the +example given above of tracing the Python function-call hierarchy, without +needing to directly name the static markers:

    +
    probe python.function.entry
    +{
    +  printf("%s => %s in %s:%d\n",
    +         thread_indent(1), funcname, filename, lineno);
    +}
    +
    +probe python.function.return
    +{
    +  printf("%s <= %s in %s:%d\n",
    +         thread_indent(-1), funcname, filename, lineno);
    +}
    +
    +
    +

    The following script uses the tapset above to provide a top-like view of all +running CPython code, showing the top 20 most frequently-entered bytecode +frames, each second, across the whole system:

    +
    global fn_calls;
    +
    +probe python.function.entry
    +{
    +    fn_calls[pid(), filename, funcname, lineno] += 1;
    +}
    +
    +probe timer.ms(1000) {
    +    printf("\033[2J\033[1;1H") /* clear screen \*/
    +    printf("%6s %80s %6s %30s %6s\n",
    +           "PID", "FILENAME", "LINE", "FUNCTION", "CALLS")
    +    foreach ([pid, filename, funcname, lineno] in fn_calls- limit 20) {
    +        printf("%6d %80s %6d %30s %6d\n",
    +            pid, filename, lineno, funcname,
    +            fn_calls[pid, filename, funcname, lineno]);
    +    }
    +    delete fn_calls;
    +}
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/howto/ipaddress.html b/python-3.7.4-docs-html/howto/ipaddress.html new file mode 100644 index 0000000..b987d7e --- /dev/null +++ b/python-3.7.4-docs-html/howto/ipaddress.html @@ -0,0 +1,510 @@ + + + + + + + An introduction to the ipaddress module — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    An introduction to the ipaddress module

    +
    +
    author
    +

    Peter Moody

    +
    +
    author
    +

    Nick Coghlan

    +
    +
    +
    +

    Overview

    +

    This document aims to provide a gentle introduction to the +ipaddress module. It is aimed primarily at users that aren’t +already familiar with IP networking terminology, but may also be useful +to network engineers wanting an overview of how ipaddress +represents IP network addressing concepts.

    +
    +
    +

    Creating Address/Network/Interface objects

    +

    Since ipaddress is a module for inspecting and manipulating IP addresses, +the first thing you’ll want to do is create some objects. You can use +ipaddress to create objects from strings and integers.

    +
    +

    A Note on IP Versions

    +

    For readers that aren’t particularly familiar with IP addressing, it’s +important to know that the Internet Protocol is currently in the process +of moving from version 4 of the protocol to version 6. This transition is +occurring largely because version 4 of the protocol doesn’t provide enough +addresses to handle the needs of the whole world, especially given the +increasing number of devices with direct connections to the internet.

    +

    Explaining the details of the differences between the two versions of the +protocol is beyond the scope of this introduction, but readers need to at +least be aware that these two versions exist, and it will sometimes be +necessary to force the use of one version or the other.

    +
    +
    +

    IP Host Addresses

    +

    Addresses, often referred to as “host addresses” are the most basic unit +when working with IP addressing. The simplest way to create addresses is +to use the ipaddress.ip_address() factory function, which automatically +determines whether to create an IPv4 or IPv6 address based on the passed in +value:

    +
    >>> ipaddress.ip_address('192.0.2.1')
    +IPv4Address('192.0.2.1')
    +>>> ipaddress.ip_address('2001:DB8::1')
    +IPv6Address('2001:db8::1')
    +
    +
    +

    Addresses can also be created directly from integers. Values that will +fit within 32 bits are assumed to be IPv4 addresses:

    +
    >>> ipaddress.ip_address(3221225985)
    +IPv4Address('192.0.2.1')
    +>>> ipaddress.ip_address(42540766411282592856903984951653826561)
    +IPv6Address('2001:db8::1')
    +
    +
    +

    To force the use of IPv4 or IPv6 addresses, the relevant classes can be +invoked directly. This is particularly useful to force creation of IPv6 +addresses for small integers:

    +
    >>> ipaddress.ip_address(1)
    +IPv4Address('0.0.0.1')
    +>>> ipaddress.IPv4Address(1)
    +IPv4Address('0.0.0.1')
    +>>> ipaddress.IPv6Address(1)
    +IPv6Address('::1')
    +
    +
    +
    +
    +

    Defining Networks

    +

    Host addresses are usually grouped together into IP networks, so +ipaddress provides a way to create, inspect and manipulate network +definitions. IP network objects are constructed from strings that define the +range of host addresses that are part of that network. The simplest form +for that information is a “network address/network prefix” pair, where the +prefix defines the number of leading bits that are compared to determine +whether or not an address is part of the network and the network address +defines the expected value of those bits.

    +

    As for addresses, a factory function is provided that determines the correct +IP version automatically:

    +
    >>> ipaddress.ip_network('192.0.2.0/24')
    +IPv4Network('192.0.2.0/24')
    +>>> ipaddress.ip_network('2001:db8::0/96')
    +IPv6Network('2001:db8::/96')
    +
    +
    +

    Network objects cannot have any host bits set. The practical effect of this +is that 192.0.2.1/24 does not describe a network. Such definitions are +referred to as interface objects since the ip-on-a-network notation is +commonly used to describe network interfaces of a computer on a given network +and are described further in the next section.

    +

    By default, attempting to create a network object with host bits set will +result in ValueError being raised. To request that the +additional bits instead be coerced to zero, the flag strict=False can +be passed to the constructor:

    +
    >>> ipaddress.ip_network('192.0.2.1/24')
    +Traceback (most recent call last):
    +   ...
    +ValueError: 192.0.2.1/24 has host bits set
    +>>> ipaddress.ip_network('192.0.2.1/24', strict=False)
    +IPv4Network('192.0.2.0/24')
    +
    +
    +

    While the string form offers significantly more flexibility, networks can +also be defined with integers, just like host addresses. In this case, the +network is considered to contain only the single address identified by the +integer, so the network prefix includes the entire network address:

    +
    >>> ipaddress.ip_network(3221225984)
    +IPv4Network('192.0.2.0/32')
    +>>> ipaddress.ip_network(42540766411282592856903984951653826560)
    +IPv6Network('2001:db8::/128')
    +
    +
    +

    As with addresses, creation of a particular kind of network can be forced +by calling the class constructor directly instead of using the factory +function.

    +
    +
    +

    Host Interfaces

    +

    As mentioned just above, if you need to describe an address on a particular +network, neither the address nor the network classes are sufficient. +Notation like 192.0.2.1/24 is commonly used by network engineers and the +people who write tools for firewalls and routers as shorthand for “the host +192.0.2.1 on the network 192.0.2.0/24”, Accordingly, ipaddress +provides a set of hybrid classes that associate an address with a particular +network. The interface for creation is identical to that for defining network +objects, except that the address portion isn’t constrained to being a network +address.

    +
    >>> ipaddress.ip_interface('192.0.2.1/24')
    +IPv4Interface('192.0.2.1/24')
    +>>> ipaddress.ip_interface('2001:db8::1/96')
    +IPv6Interface('2001:db8::1/96')
    +
    +
    +

    Integer inputs are accepted (as with networks), and use of a particular IP +version can be forced by calling the relevant constructor directly.

    +
    +
    +
    +

    Inspecting Address/Network/Interface Objects

    +

    You’ve gone to the trouble of creating an IPv(4|6)(Address|Network|Interface) +object, so you probably want to get information about it. ipaddress +tries to make doing this easy and intuitive.

    +

    Extracting the IP version:

    +
    >>> addr4 = ipaddress.ip_address('192.0.2.1')
    +>>> addr6 = ipaddress.ip_address('2001:db8::1')
    +>>> addr6.version
    +6
    +>>> addr4.version
    +4
    +
    +
    +

    Obtaining the network from an interface:

    +
    >>> host4 = ipaddress.ip_interface('192.0.2.1/24')
    +>>> host4.network
    +IPv4Network('192.0.2.0/24')
    +>>> host6 = ipaddress.ip_interface('2001:db8::1/96')
    +>>> host6.network
    +IPv6Network('2001:db8::/96')
    +
    +
    +

    Finding out how many individual addresses are in a network:

    +
    >>> net4 = ipaddress.ip_network('192.0.2.0/24')
    +>>> net4.num_addresses
    +256
    +>>> net6 = ipaddress.ip_network('2001:db8::0/96')
    +>>> net6.num_addresses
    +4294967296
    +
    +
    +

    Iterating through the “usable” addresses on a network:

    +
    >>> net4 = ipaddress.ip_network('192.0.2.0/24')
    +>>> for x in net4.hosts():
    +...     print(x)  
    +192.0.2.1
    +192.0.2.2
    +192.0.2.3
    +192.0.2.4
    +...
    +192.0.2.252
    +192.0.2.253
    +192.0.2.254
    +
    +
    +

    Obtaining the netmask (i.e. set bits corresponding to the network prefix) or +the hostmask (any bits that are not part of the netmask):

    +
    >>> net4 = ipaddress.ip_network('192.0.2.0/24')
    +>>> net4.netmask
    +IPv4Address('255.255.255.0')
    +>>> net4.hostmask
    +IPv4Address('0.0.0.255')
    +>>> net6 = ipaddress.ip_network('2001:db8::0/96')
    +>>> net6.netmask
    +IPv6Address('ffff:ffff:ffff:ffff:ffff:ffff::')
    +>>> net6.hostmask
    +IPv6Address('::ffff:ffff')
    +
    +
    +

    Exploding or compressing the address:

    +
    >>> addr6.exploded
    +'2001:0db8:0000:0000:0000:0000:0000:0001'
    +>>> addr6.compressed
    +'2001:db8::1'
    +>>> net6.exploded
    +'2001:0db8:0000:0000:0000:0000:0000:0000/96'
    +>>> net6.compressed
    +'2001:db8::/96'
    +
    +
    +

    While IPv4 doesn’t support explosion or compression, the associated objects +still provide the relevant properties so that version neutral code can +easily ensure the most concise or most verbose form is used for IPv6 +addresses while still correctly handling IPv4 addresses.

    +
    +
    +

    Networks as lists of Addresses

    +

    It’s sometimes useful to treat networks as lists. This means it is possible +to index them like this:

    +
    >>> net4[1]
    +IPv4Address('192.0.2.1')
    +>>> net4[-1]
    +IPv4Address('192.0.2.255')
    +>>> net6[1]
    +IPv6Address('2001:db8::1')
    +>>> net6[-1]
    +IPv6Address('2001:db8::ffff:ffff')
    +
    +
    +

    It also means that network objects lend themselves to using the list +membership test syntax like this:

    +
    if address in network:
    +    # do something
    +
    +
    +

    Containment testing is done efficiently based on the network prefix:

    +
    >>> addr4 = ipaddress.ip_address('192.0.2.1')
    +>>> addr4 in ipaddress.ip_network('192.0.2.0/24')
    +True
    +>>> addr4 in ipaddress.ip_network('192.0.3.0/24')
    +False
    +
    +
    +
    +
    +

    Comparisons

    +

    ipaddress provides some simple, hopefully intuitive ways to compare +objects, where it makes sense:

    +
    >>> ipaddress.ip_address('192.0.2.1') < ipaddress.ip_address('192.0.2.2')
    +True
    +
    +
    +

    A TypeError exception is raised if you try to compare objects of +different versions or different types.

    +
    +
    +

    Using IP Addresses with other modules

    +

    Other modules that use IP addresses (such as socket) usually won’t +accept objects from this module directly. Instead, they must be coerced to +an integer or string that the other module will accept:

    +
    >>> addr4 = ipaddress.ip_address('192.0.2.1')
    +>>> str(addr4)
    +'192.0.2.1'
    +>>> int(addr4)
    +3221225985
    +
    +
    +
    +
    +

    Getting more detail when instance creation fails

    +

    When creating address/network/interface objects using the version-agnostic +factory functions, any errors will be reported as ValueError with +a generic error message that simply says the passed in value was not +recognized as an object of that type. The lack of a specific error is +because it’s necessary to know whether the value is supposed to be IPv4 +or IPv6 in order to provide more detail on why it has been rejected.

    +

    To support use cases where it is useful to have access to this additional +detail, the individual class constructors actually raise the +ValueError subclasses ipaddress.AddressValueError and +ipaddress.NetmaskValueError to indicate exactly which part of +the definition failed to parse correctly.

    +

    The error messages are significantly more detailed when using the +class constructors directly. For example:

    +
    >>> ipaddress.ip_address("192.168.0.256")
    +Traceback (most recent call last):
    +  ...
    +ValueError: '192.168.0.256' does not appear to be an IPv4 or IPv6 address
    +>>> ipaddress.IPv4Address("192.168.0.256")
    +Traceback (most recent call last):
    +  ...
    +ipaddress.AddressValueError: Octet 256 (> 255) not permitted in '192.168.0.256'
    +
    +>>> ipaddress.ip_network("192.168.0.1/64")
    +Traceback (most recent call last):
    +  ...
    +ValueError: '192.168.0.1/64' does not appear to be an IPv4 or IPv6 network
    +>>> ipaddress.IPv4Network("192.168.0.1/64")
    +Traceback (most recent call last):
    +  ...
    +ipaddress.NetmaskValueError: '64' is not a valid netmask
    +
    +
    +

    However, both of the module specific exceptions have ValueError as their +parent class, so if you’re not concerned with the particular type of error, +you can still write code like the following:

    +
    try:
    +    network = ipaddress.IPv4Network(address)
    +except ValueError:
    +    print('address/netmask is invalid for IPv4:', address)
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/howto/logging-cookbook.html b/python-3.7.4-docs-html/howto/logging-cookbook.html new file mode 100644 index 0000000..d09f7fb --- /dev/null +++ b/python-3.7.4-docs-html/howto/logging-cookbook.html @@ -0,0 +1,2589 @@ + + + + + + + Logging Cookbook — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Logging Cookbook

    +
    +
    Author
    +

    Vinay Sajip <vinay_sajip at red-dove dot com>

    +
    +
    +

    This page contains a number of recipes related to logging, which have been found +useful in the past.

    +
    +

    Using logging in multiple modules

    +

    Multiple calls to logging.getLogger('someLogger') return a reference to the +same logger object. This is true not only within the same module, but also +across modules as long as it is in the same Python interpreter process. It is +true for references to the same object; additionally, application code can +define and configure a parent logger in one module and create (but not +configure) a child logger in a separate module, and all logger calls to the +child will pass up to the parent. Here is a main module:

    +
    import logging
    +import auxiliary_module
    +
    +# create logger with 'spam_application'
    +logger = logging.getLogger('spam_application')
    +logger.setLevel(logging.DEBUG)
    +# create file handler which logs even debug messages
    +fh = logging.FileHandler('spam.log')
    +fh.setLevel(logging.DEBUG)
    +# create console handler with a higher log level
    +ch = logging.StreamHandler()
    +ch.setLevel(logging.ERROR)
    +# create formatter and add it to the handlers
    +formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
    +fh.setFormatter(formatter)
    +ch.setFormatter(formatter)
    +# add the handlers to the logger
    +logger.addHandler(fh)
    +logger.addHandler(ch)
    +
    +logger.info('creating an instance of auxiliary_module.Auxiliary')
    +a = auxiliary_module.Auxiliary()
    +logger.info('created an instance of auxiliary_module.Auxiliary')
    +logger.info('calling auxiliary_module.Auxiliary.do_something')
    +a.do_something()
    +logger.info('finished auxiliary_module.Auxiliary.do_something')
    +logger.info('calling auxiliary_module.some_function()')
    +auxiliary_module.some_function()
    +logger.info('done with auxiliary_module.some_function()')
    +
    +
    +

    Here is the auxiliary module:

    +
    import logging
    +
    +# create logger
    +module_logger = logging.getLogger('spam_application.auxiliary')
    +
    +class Auxiliary:
    +    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
    +        self.logger.info('done doing something')
    +
    +def some_function():
    +    module_logger.info('received a call to "some_function"')
    +
    +
    +

    The output looks like this:

    +
    2005-03-23 23:47:11,663 - spam_application - INFO -
    +   creating an instance of auxiliary_module.Auxiliary
    +2005-03-23 23:47:11,665 - spam_application.auxiliary.Auxiliary - INFO -
    +   creating an instance of Auxiliary
    +2005-03-23 23:47:11,665 - spam_application - INFO -
    +   created an instance of auxiliary_module.Auxiliary
    +2005-03-23 23:47:11,668 - spam_application - INFO -
    +   calling auxiliary_module.Auxiliary.do_something
    +2005-03-23 23:47:11,668 - spam_application.auxiliary.Auxiliary - INFO -
    +   doing something
    +2005-03-23 23:47:11,669 - spam_application.auxiliary.Auxiliary - INFO -
    +   done doing something
    +2005-03-23 23:47:11,670 - spam_application - INFO -
    +   finished auxiliary_module.Auxiliary.do_something
    +2005-03-23 23:47:11,671 - spam_application - INFO -
    +   calling auxiliary_module.some_function()
    +2005-03-23 23:47:11,672 - spam_application.auxiliary - INFO -
    +   received a call to 'some_function'
    +2005-03-23 23:47:11,673 - spam_application - INFO -
    +   done with auxiliary_module.some_function()
    +
    +
    +
    +
    +

    Logging from multiple threads

    +

    Logging from multiple threads requires no special effort. The following example +shows logging from the main (initial) thread and another thread:

    +
    import logging
    +import threading
    +import time
    +
    +def worker(arg):
    +    while not arg['stop']:
    +        logging.debug('Hi from myfunc')
    +        time.sleep(0.5)
    +
    +def main():
    +    logging.basicConfig(level=logging.DEBUG, format='%(relativeCreated)6d %(threadName)s %(message)s')
    +    info = {'stop': False}
    +    thread = threading.Thread(target=worker, args=(info,))
    +    thread.start()
    +    while True:
    +        try:
    +            logging.debug('Hello from main')
    +            time.sleep(0.75)
    +        except KeyboardInterrupt:
    +            info['stop'] = True
    +            break
    +    thread.join()
    +
    +if __name__ == '__main__':
    +    main()
    +
    +
    +

    When run, the script should print something like the following:

    +
       0 Thread-1 Hi from myfunc
    +   3 MainThread Hello from main
    + 505 Thread-1 Hi from myfunc
    + 755 MainThread Hello from main
    +1007 Thread-1 Hi from myfunc
    +1507 MainThread Hello from main
    +1508 Thread-1 Hi from myfunc
    +2010 Thread-1 Hi from myfunc
    +2258 MainThread Hello from main
    +2512 Thread-1 Hi from myfunc
    +3009 MainThread Hello from main
    +3013 Thread-1 Hi from myfunc
    +3515 Thread-1 Hi from myfunc
    +3761 MainThread Hello from main
    +4017 Thread-1 Hi from myfunc
    +4513 MainThread Hello from main
    +4518 Thread-1 Hi from myfunc
    +
    +
    +

    This shows the logging output interspersed as one might expect. This approach +works for more threads than shown here, of course.

    +
    +
    +

    Multiple handlers and formatters

    +

    Loggers are plain Python objects. The addHandler() method has no +minimum or maximum quota for the number of handlers you may add. Sometimes it +will be beneficial for an application to log all messages of all severities to a +text file while simultaneously logging errors or above to the console. To set +this up, simply configure the appropriate handlers. The logging calls in the +application code will remain unchanged. Here is a slight modification to the +previous simple module-based configuration example:

    +
    import logging
    +
    +logger = logging.getLogger('simple_example')
    +logger.setLevel(logging.DEBUG)
    +# create file handler which logs even debug messages
    +fh = logging.FileHandler('spam.log')
    +fh.setLevel(logging.DEBUG)
    +# create console handler with a higher log level
    +ch = logging.StreamHandler()
    +ch.setLevel(logging.ERROR)
    +# create formatter and add it to the handlers
    +formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
    +ch.setFormatter(formatter)
    +fh.setFormatter(formatter)
    +# add the handlers to logger
    +logger.addHandler(ch)
    +logger.addHandler(fh)
    +
    +# 'application' code
    +logger.debug('debug message')
    +logger.info('info message')
    +logger.warning('warn message')
    +logger.error('error message')
    +logger.critical('critical message')
    +
    +
    +

    Notice that the ‘application’ code does not care about multiple handlers. All +that changed was the addition and configuration of a new handler named fh.

    +

    The ability to create new handlers with higher- or lower-severity filters can be +very helpful when writing and testing an application. Instead of using many +print statements for debugging, use logger.debug: Unlike the print +statements, which you will have to delete or comment out later, the logger.debug +statements can remain intact in the source code and remain dormant until you +need them again. At that time, the only change that needs to happen is to +modify the severity level of the logger and/or handler to debug.

    +
    +
    +

    Logging to multiple destinations

    +

    Let’s say you want to log to console and file with different message formats and +in differing circumstances. Say you want to log messages with levels of DEBUG +and higher to file, and those messages at level INFO and higher to the console. +Let’s also assume that the file should contain timestamps, but the console +messages should not. Here’s how you can achieve this:

    +
    import logging
    +
    +# set up logging to file - see previous section for more details
    +logging.basicConfig(level=logging.DEBUG,
    +                    format='%(asctime)s %(name)-12s %(levelname)-8s %(message)s',
    +                    datefmt='%m-%d %H:%M',
    +                    filename='/temp/myapp.log',
    +                    filemode='w')
    +# define a Handler which writes INFO messages or higher to the sys.stderr
    +console = logging.StreamHandler()
    +console.setLevel(logging.INFO)
    +# set a format which is simpler for console use
    +formatter = logging.Formatter('%(name)-12s: %(levelname)-8s %(message)s')
    +# tell the handler to use this format
    +console.setFormatter(formatter)
    +# add the handler to the root logger
    +logging.getLogger('').addHandler(console)
    +
    +# Now, we can log to the root logger, or any other logger. First the root...
    +logging.info('Jackdaws love my big sphinx of quartz.')
    +
    +# Now, define a couple of other loggers which might represent areas in your
    +# application:
    +
    +logger1 = logging.getLogger('myapp.area1')
    +logger2 = logging.getLogger('myapp.area2')
    +
    +logger1.debug('Quick zephyrs blow, vexing daft Jim.')
    +logger1.info('How quickly daft jumping zebras vex.')
    +logger2.warning('Jail zesty vixen who grabbed pay from quack.')
    +logger2.error('The five boxing wizards jump quickly.')
    +
    +
    +

    When you run this, on the console you will see

    +
    root        : INFO     Jackdaws love my big sphinx of quartz.
    +myapp.area1 : INFO     How quickly daft jumping zebras vex.
    +myapp.area2 : WARNING  Jail zesty vixen who grabbed pay from quack.
    +myapp.area2 : ERROR    The five boxing wizards jump quickly.
    +
    +
    +

    and in the file you will see something like

    +
    10-22 22:19 root         INFO     Jackdaws love my big sphinx of quartz.
    +10-22 22:19 myapp.area1  DEBUG    Quick zephyrs blow, vexing daft Jim.
    +10-22 22:19 myapp.area1  INFO     How quickly daft jumping zebras vex.
    +10-22 22:19 myapp.area2  WARNING  Jail zesty vixen who grabbed pay from quack.
    +10-22 22:19 myapp.area2  ERROR    The five boxing wizards jump quickly.
    +
    +
    +

    As you can see, the DEBUG message only shows up in the file. The other messages +are sent to both destinations.

    +

    This example uses console and file handlers, but you can use any number and +combination of handlers you choose.

    +
    +
    +

    Configuration server example

    +

    Here is an example of a module using the logging configuration server:

    +
    import logging
    +import logging.config
    +import time
    +import os
    +
    +# read initial config file
    +logging.config.fileConfig('logging.conf')
    +
    +# create and start listener on port 9999
    +t = logging.config.listen(9999)
    +t.start()
    +
    +logger = logging.getLogger('simpleExample')
    +
    +try:
    +    # loop through logging calls to see the difference
    +    # new configurations make, until Ctrl+C is pressed
    +    while True:
    +        logger.debug('debug message')
    +        logger.info('info message')
    +        logger.warning('warn message')
    +        logger.error('error message')
    +        logger.critical('critical message')
    +        time.sleep(5)
    +except KeyboardInterrupt:
    +    # cleanup
    +    logging.config.stopListening()
    +    t.join()
    +
    +
    +

    And here is a script that takes a filename and sends that file to the server, +properly preceded with the binary-encoded length, as the new logging +configuration:

    +
    #!/usr/bin/env python
    +import socket, sys, struct
    +
    +with open(sys.argv[1], 'rb') as f:
    +    data_to_send = f.read()
    +
    +HOST = 'localhost'
    +PORT = 9999
    +s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
    +print('connecting...')
    +s.connect((HOST, PORT))
    +print('sending config...')
    +s.send(struct.pack('>L', len(data_to_send)))
    +s.send(data_to_send)
    +s.close()
    +print('complete')
    +
    +
    +
    +
    +

    Dealing with handlers that block

    +

    Sometimes you have to get your logging handlers to do their work without +blocking the thread you’re logging from. This is common in Web applications, +though of course it also occurs in other scenarios.

    +

    A common culprit which demonstrates sluggish behaviour is the +SMTPHandler: sending emails can take a long time, for a +number of reasons outside the developer’s control (for example, a poorly +performing mail or network infrastructure). But almost any network-based +handler can block: Even a SocketHandler operation may do a +DNS query under the hood which is too slow (and this query can be deep in the +socket library code, below the Python layer, and outside your control).

    +

    One solution is to use a two-part approach. For the first part, attach only a +QueueHandler to those loggers which are accessed from +performance-critical threads. They simply write to their queue, which can be +sized to a large enough capacity or initialized with no upper bound to their +size. The write to the queue will typically be accepted quickly, though you +will probably need to catch the queue.Full exception as a precaution +in your code. If you are a library developer who has performance-critical +threads in their code, be sure to document this (together with a suggestion to +attach only QueueHandlers to your loggers) for the benefit of other +developers who will use your code.

    +

    The second part of the solution is QueueListener, which has been +designed as the counterpart to QueueHandler. A +QueueListener is very simple: it’s passed a queue and some handlers, +and it fires up an internal thread which listens to its queue for LogRecords +sent from QueueHandlers (or any other source of LogRecords, for that +matter). The LogRecords are removed from the queue and passed to the +handlers for processing.

    +

    The advantage of having a separate QueueListener class is that you +can use the same instance to service multiple QueueHandlers. This is more +resource-friendly than, say, having threaded versions of the existing handler +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
    +queue_handler = QueueHandler(que)
    +handler = logging.StreamHandler()
    +listener = QueueListener(que, handler)
    +root = logging.getLogger()
    +root.addHandler(queue_handler)
    +formatter = logging.Formatter('%(threadName)s: %(message)s')
    +handler.setFormatter(formatter)
    +listener.start()
    +# The log output will display the thread which generated
    +# the event (the main thread) rather than the internal
    +# thread which monitors the internal queue. This is what
    +# you want to happen.
    +root.warning('Look out!')
    +listener.stop()
    +
    +
    +

    which, when run, will produce:

    +
    MainThread: Look out!
    +
    +
    +
    +

    Changed in version 3.5: Prior to Python 3.5, the QueueListener always passed every message +received from the queue to every handler it was initialized with. (This was +because it was assumed that level filtering was all done on the other side, +where the queue is filled.) From 3.5 onwards, this behaviour can be changed +by passing a keyword argument respect_handler_level=True to the +listener’s constructor. When this is done, the listener compares the level +of each message with the handler’s level, and only passes a message to a +handler if it’s appropriate to do so.

    +
    +
    +
    +

    Sending and receiving logging events across a network

    +

    Let’s say you want to send logging events across a network, and handle them at +the receiving end. A simple way of doing this is attaching a +SocketHandler instance to the root logger at the sending end:

    +
    import logging, logging.handlers
    +
    +rootLogger = logging.getLogger('')
    +rootLogger.setLevel(logging.DEBUG)
    +socketHandler = logging.handlers.SocketHandler('localhost',
    +                    logging.handlers.DEFAULT_TCP_LOGGING_PORT)
    +# don't bother with a formatter, since a socket handler sends the event as
    +# an unformatted pickle
    +rootLogger.addHandler(socketHandler)
    +
    +# Now, we can log to the root logger, or any other logger. First the root...
    +logging.info('Jackdaws love my big sphinx of quartz.')
    +
    +# Now, define a couple of other loggers which might represent areas in your
    +# application:
    +
    +logger1 = logging.getLogger('myapp.area1')
    +logger2 = logging.getLogger('myapp.area2')
    +
    +logger1.debug('Quick zephyrs blow, vexing daft Jim.')
    +logger1.info('How quickly daft jumping zebras vex.')
    +logger2.warning('Jail zesty vixen who grabbed pay from quack.')
    +logger2.error('The five boxing wizards jump quickly.')
    +
    +
    +

    At the receiving end, you can set up a receiver using the socketserver +module. Here is a basic working example:

    +
    import pickle
    +import logging
    +import logging.handlers
    +import socketserver
    +import struct
    +
    +
    +class LogRecordStreamHandler(socketserver.StreamRequestHandler):
    +    """Handler for a streaming logging request.
    +
    +    This basically logs the record using whatever logging policy is
    +    configured locally.
    +    """
    +
    +    def handle(self):
    +        """
    +        Handle multiple requests - each expected to be a 4-byte length,
    +        followed by the LogRecord in pickle format. Logs the record
    +        according to whatever policy is configured locally.
    +        """
    +        while True:
    +            chunk = self.connection.recv(4)
    +            if len(chunk) < 4:
    +                break
    +            slen = struct.unpack('>L', chunk)[0]
    +            chunk = self.connection.recv(slen)
    +            while len(chunk) < slen:
    +                chunk = chunk + self.connection.recv(slen - len(chunk))
    +            obj = self.unPickle(chunk)
    +            record = logging.makeLogRecord(obj)
    +            self.handleLogRecord(record)
    +
    +    def unPickle(self, data):
    +        return pickle.loads(data)
    +
    +    def handleLogRecord(self, record):
    +        # if a name is specified, we use the named logger rather than the one
    +        # implied by the record.
    +        if self.server.logname is not None:
    +            name = self.server.logname
    +        else:
    +            name = record.name
    +        logger = logging.getLogger(name)
    +        # N.B. EVERY record gets logged. This is because Logger.handle
    +        # is normally called AFTER logger-level filtering. If you want
    +        # to do filtering, do it at the client end to save wasting
    +        # cycles and network bandwidth!
    +        logger.handle(record)
    +
    +class LogRecordSocketReceiver(socketserver.ThreadingTCPServer):
    +    """
    +    Simple TCP socket-based logging receiver suitable for testing.
    +    """
    +
    +    allow_reuse_address = True
    +
    +    def __init__(self, host='localhost',
    +                 port=logging.handlers.DEFAULT_TCP_LOGGING_PORT,
    +                 handler=LogRecordStreamHandler):
    +        socketserver.ThreadingTCPServer.__init__(self, (host, port), handler)
    +        self.abort = 0
    +        self.timeout = 1
    +        self.logname = None
    +
    +    def serve_until_stopped(self):
    +        import select
    +        abort = 0
    +        while not abort:
    +            rd, wr, ex = select.select([self.socket.fileno()],
    +                                       [], [],
    +                                       self.timeout)
    +            if rd:
    +                self.handle_request()
    +            abort = self.abort
    +
    +def main():
    +    logging.basicConfig(
    +        format='%(relativeCreated)5d %(name)-15s %(levelname)-8s %(message)s')
    +    tcpserver = LogRecordSocketReceiver()
    +    print('About to start TCP server...')
    +    tcpserver.serve_until_stopped()
    +
    +if __name__ == '__main__':
    +    main()
    +
    +
    +

    First run the server, and then the client. On the client side, nothing is +printed on the console; on the server side, you should see something like:

    +
    About to start TCP server...
    +   59 root            INFO     Jackdaws love my big sphinx of quartz.
    +   59 myapp.area1     DEBUG    Quick zephyrs blow, vexing daft Jim.
    +   69 myapp.area1     INFO     How quickly daft jumping zebras vex.
    +   69 myapp.area2     WARNING  Jail zesty vixen who grabbed pay from quack.
    +   69 myapp.area2     ERROR    The five boxing wizards jump quickly.
    +
    +
    +

    Note that there are some security issues with pickle in some scenarios. If +these affect you, you can use an alternative serialization scheme by overriding +the makePickle() method and implementing your +alternative there, as well as adapting the above script to use your alternative +serialization.

    +
    +
    +

    Adding contextual information to your logging output

    +

    Sometimes you want logging output to contain contextual information in +addition to the parameters passed to the logging call. For example, in a +networked application, it may be desirable to log client-specific information +in the log (e.g. remote client’s username, or IP address). Although you could +use the extra parameter to achieve this, it’s not always convenient to pass +the information in this way. While it might be tempting to create +Logger instances on a per-connection basis, this is not a good idea +because these instances are not garbage collected. While this is not a problem +in practice, when the number of Logger instances is dependent on the +level of granularity you want to use in logging an application, it could +be hard to manage if the number of Logger instances becomes +effectively unbounded.

    +
    +

    Using LoggerAdapters to impart contextual information

    +

    An easy way in which you can pass contextual information to be output along +with logging event information is to use the LoggerAdapter class. +This class is designed to look like a Logger, so that you can call +debug(), info(), warning(), error(), +exception(), critical() and log(). These methods have the +same signatures as their counterparts in Logger, so you can use the +two types of instances interchangeably.

    +

    When you create an instance of LoggerAdapter, you pass it a +Logger instance and a dict-like object which contains your contextual +information. When you call one of the logging methods on an instance of +LoggerAdapter, it delegates the call to the underlying instance of +Logger passed to its constructor, and arranges to pass the contextual +information in the delegated call. Here’s a snippet from the code of +LoggerAdapter:

    +
    def debug(self, msg, *args, **kwargs):
    +    """
    +    Delegate a debug call to the underlying logger, after adding
    +    contextual information from this adapter instance.
    +    """
    +    msg, kwargs = self.process(msg, kwargs)
    +    self.logger.debug(msg, *args, **kwargs)
    +
    +
    +

    The process() method of LoggerAdapter is where the +contextual information is added to the logging output. It’s passed the message +and keyword arguments of the logging call, and it passes back (potentially) +modified versions of these to use in the call to the underlying logger. The +default implementation of this method leaves the message alone, but inserts +an ‘extra’ key in the keyword argument whose value is the dict-like object +passed to the constructor. Of course, if you had passed an ‘extra’ keyword +argument in the call to the adapter, it will be silently overwritten.

    +

    The advantage of using ‘extra’ is that the values in the dict-like object are +merged into the LogRecord instance’s __dict__, allowing you to use +customized strings with your Formatter instances which know about +the keys of the dict-like object. If you need a different method, e.g. if you +want to prepend or append the contextual information to the message string, +you just need to subclass LoggerAdapter and override +process() to do what you need. Here is a simple example:

    +
    class CustomAdapter(logging.LoggerAdapter):
    +    """
    +    This example adapter expects the passed in dict-like object to have a
    +    'connid' key, whose value in brackets is prepended to the log message.
    +    """
    +    def process(self, msg, kwargs):
    +        return '[%s] %s' % (self.extra['connid'], msg), kwargs
    +
    +
    +

    which you can use like this:

    +
    logger = logging.getLogger(__name__)
    +adapter = CustomAdapter(logger, {'connid': some_conn_id})
    +
    +
    +

    Then any events that you log to the adapter will have the value of +some_conn_id prepended to the log messages.

    +
    +

    Using objects other than dicts to pass contextual information

    +

    You don’t need to pass an actual dict to a LoggerAdapter - you could +pass an instance of a class which implements __getitem__ and __iter__ so +that it looks like a dict to logging. This would be useful if you want to +generate values dynamically (whereas the values in a dict would be constant).

    +
    +
    +
    +

    Using Filters to impart contextual information

    +

    You can also add contextual information to log output using a user-defined +Filter. Filter instances are allowed to modify the LogRecords +passed to them, including adding additional attributes which can then be output +using a suitable format string, or if needed a custom Formatter.

    +

    For example in a web application, the request being processed (or at least, +the interesting parts of it) can be stored in a threadlocal +(threading.local) variable, and then accessed from a Filter to +add, say, information from the request - say, the remote IP address and remote +user’s username - to the LogRecord, using the attribute names ‘ip’ and +‘user’ as in the LoggerAdapter example above. In that case, the same format +string can be used to get similar output to that shown above. Here’s an example +script:

    +
    import logging
    +from random import choice
    +
    +class ContextFilter(logging.Filter):
    +    """
    +    This is a filter which injects contextual information into the log.
    +
    +    Rather than use actual contextual information, we just use random
    +    data in this demo.
    +    """
    +
    +    USERS = ['jim', 'fred', 'sheila']
    +    IPS = ['123.231.231.123', '127.0.0.1', '192.168.0.1']
    +
    +    def filter(self, record):
    +
    +        record.ip = choice(ContextFilter.IPS)
    +        record.user = choice(ContextFilter.USERS)
    +        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')
    +
    +
    +

    which, when run, produces something like:

    +
    2010-09-06 22:38:15,292 a.b.c DEBUG    IP: 123.231.231.123 User: fred     A debug message
    +2010-09-06 22:38:15,300 a.b.c INFO     IP: 192.168.0.1     User: sheila   An info message with some parameters
    +2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 127.0.0.1       User: sheila   A message at CRITICAL level with 2 parameters
    +2010-09-06 22:38:15,300 d.e.f ERROR    IP: 127.0.0.1       User: jim      A message at ERROR level with 2 parameters
    +2010-09-06 22:38:15,300 d.e.f DEBUG    IP: 127.0.0.1       User: sheila   A message at DEBUG level with 2 parameters
    +2010-09-06 22:38:15,300 d.e.f ERROR    IP: 123.231.231.123 User: fred     A message at ERROR level with 2 parameters
    +2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 192.168.0.1     User: jim      A message at CRITICAL level with 2 parameters
    +2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 127.0.0.1       User: sheila   A message at CRITICAL level with 2 parameters
    +2010-09-06 22:38:15,300 d.e.f DEBUG    IP: 192.168.0.1     User: jim      A message at DEBUG level with 2 parameters
    +2010-09-06 22:38:15,301 d.e.f ERROR    IP: 127.0.0.1       User: sheila   A message at ERROR level with 2 parameters
    +2010-09-06 22:38:15,301 d.e.f DEBUG    IP: 123.231.231.123 User: fred     A message at DEBUG level with 2 parameters
    +2010-09-06 22:38:15,301 d.e.f INFO     IP: 123.231.231.123 User: fred     A message at INFO level with 2 parameters
    +
    +
    +
    +
    +
    +

    Logging to a single file from multiple processes

    +

    Although logging is thread-safe, and logging to a single file from multiple +threads in a single process is supported, logging to a single file from +multiple processes is not supported, because there is no standard way to +serialize access to a single file across multiple processes in Python. If you +need to log to a single file from multiple processes, one way of doing this is +to have all the processes log to a SocketHandler, and have a +separate process which implements a socket server which reads from the socket +and logs to file. (If you prefer, you can dedicate one thread in one of the +existing processes to perform this function.) +This section documents this approach in more detail and +includes a working socket receiver which can be used as a starting point for you +to adapt in your own applications.

    +

    If you are using a recent version of Python which includes the +multiprocessing module, you could write your own handler which uses the +Lock class from this module to serialize access to the +file from your processes. The existing FileHandler and subclasses do +not make use of multiprocessing at present, though they may do so in the +future. Note that at present, the multiprocessing module does not provide +working lock functionality on all platforms (see +https://bugs.python.org/issue3770).

    +

    Alternatively, you can use a Queue and a QueueHandler to send +all logging events to one of the processes in your multi-process application. +The following example script demonstrates how you can do this; in the example +a separate listener process listens for events sent by other processes and logs +them according to its own logging configuration. Although the example only +demonstrates one way of doing it (for example, you may want to use a listener +thread rather than a separate listener process – the implementation would be +analogous) it does allow for completely different logging configurations for +the listener and the other processes in your application, and can be used as +the basis for code meeting your own specific requirements:

    +
    # You'll need these imports in your own code
    +import logging
    +import logging.handlers
    +import multiprocessing
    +
    +# Next two import lines for this demo only
    +from random import choice, random
    +import time
    +
    +#
    +# Because you'll want to define the logging configurations for listener and workers, the
    +# listener and worker process functions take a configurer parameter which is a callable
    +# for configuring logging for that process. These functions are also passed the queue,
    +# which they use for communication.
    +#
    +# In practice, you can configure the listener however you want, but note that in this
    +# simple example, the listener does not apply level or filter logic to received records.
    +# In practice, you would probably want to do this logic in the worker processes, to avoid
    +# sending events which would be filtered out between processes.
    +#
    +# The size of the rotated files is made small so you can see the results easily.
    +def listener_configurer():
    +    root = logging.getLogger()
    +    h = logging.handlers.RotatingFileHandler('mptest.log', 'a', 300, 10)
    +    f = logging.Formatter('%(asctime)s %(processName)-10s %(name)s %(levelname)-8s %(message)s')
    +    h.setFormatter(f)
    +    root.addHandler(h)
    +
    +# This is the listener process top-level loop: wait for logging events
    +# (LogRecords)on the queue and handle them, quit when you get a None for a
    +# LogRecord.
    +def listener_process(queue, configurer):
    +    configurer()
    +    while True:
    +        try:
    +            record = queue.get()
    +            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!
    +        except Exception:
    +            import sys, traceback
    +            print('Whoops! Problem:', file=sys.stderr)
    +            traceback.print_exc(file=sys.stderr)
    +
    +# Arrays used for random selections in this demo
    +
    +LEVELS = [logging.DEBUG, logging.INFO, logging.WARNING,
    +          logging.ERROR, logging.CRITICAL]
    +
    +LOGGERS = ['a.b.c', 'd.e.f']
    +
    +MESSAGES = [
    +    'Random message #1',
    +    'Random message #2',
    +    'Random message #3',
    +]
    +
    +# The worker configuration is done at the start of the worker process run.
    +# 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
    +    root = logging.getLogger()
    +    root.addHandler(h)
    +    # 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.
    +# The print messages are just so you know it's doing something!
    +def worker_process(queue, configurer):
    +    configurer(queue)
    +    name = multiprocessing.current_process().name
    +    print('Worker started: %s' % name)
    +    for i in range(10):
    +        time.sleep(random())
    +        logger = logging.getLogger(choice(LOGGERS))
    +        level = choice(LEVELS)
    +        message = choice(MESSAGES)
    +        logger.log(level, message)
    +    print('Worker finished: %s' % name)
    +
    +# Here's where the demo gets orchestrated. Create the queue, create and start
    +# the listener, create ten workers and start them, wait for them to finish,
    +# then send a None to the queue to tell the listener to finish.
    +def main():
    +    queue = multiprocessing.Queue(-1)
    +    listener = multiprocessing.Process(target=listener_process,
    +                                       args=(queue, listener_configurer))
    +    listener.start()
    +    workers = []
    +    for i in range(10):
    +        worker = multiprocessing.Process(target=worker_process,
    +                                         args=(queue, worker_configurer))
    +        workers.append(worker)
    +        worker.start()
    +    for w in workers:
    +        w.join()
    +    queue.put_nowait(None)
    +    listener.join()
    +
    +if __name__ == '__main__':
    +    main()
    +
    +
    +

    A variant of the above script keeps the logging in the main process, in a +separate thread:

    +
    import logging
    +import logging.config
    +import logging.handlers
    +from multiprocessing import Process, Queue
    +import random
    +import threading
    +import time
    +
    +def logger_thread(q):
    +    while True:
    +        record = q.get()
    +        if record is None:
    +            break
    +        logger = logging.getLogger(record.name)
    +        logger.handle(record)
    +
    +
    +def worker_process(q):
    +    qh = logging.handlers.QueueHandler(q)
    +    root = logging.getLogger()
    +    root.setLevel(logging.DEBUG)
    +    root.addHandler(qh)
    +    levels = [logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR,
    +              logging.CRITICAL]
    +    loggers = ['foo', 'foo.bar', 'foo.bar.baz',
    +               'spam', 'spam.ham', 'spam.ham.eggs']
    +    for i in range(100):
    +        lvl = random.choice(levels)
    +        logger = logging.getLogger(random.choice(loggers))
    +        logger.log(lvl, 'Message no. %d', i)
    +
    +if __name__ == '__main__':
    +    q = Queue()
    +    d = {
    +        'version': 1,
    +        'formatters': {
    +            'detailed': {
    +                'class': 'logging.Formatter',
    +                'format': '%(asctime)s %(name)-15s %(levelname)-8s %(processName)-10s %(message)s'
    +            }
    +        },
    +        'handlers': {
    +            'console': {
    +                'class': 'logging.StreamHandler',
    +                'level': 'INFO',
    +            },
    +            'file': {
    +                'class': 'logging.FileHandler',
    +                'filename': 'mplog.log',
    +                'mode': 'w',
    +                'formatter': 'detailed',
    +            },
    +            'foofile': {
    +                'class': 'logging.FileHandler',
    +                'filename': 'mplog-foo.log',
    +                'mode': 'w',
    +                'formatter': 'detailed',
    +            },
    +            'errors': {
    +                'class': 'logging.FileHandler',
    +                'filename': 'mplog-errors.log',
    +                'mode': 'w',
    +                'level': 'ERROR',
    +                'formatter': 'detailed',
    +            },
    +        },
    +        'loggers': {
    +            'foo': {
    +                'handlers': ['foofile']
    +            }
    +        },
    +        'root': {
    +            'level': 'DEBUG',
    +            'handlers': ['console', 'file', 'errors']
    +        },
    +    }
    +    workers = []
    +    for i in range(5):
    +        wp = Process(target=worker_process, name='worker %d' % (i + 1), args=(q,))
    +        workers.append(wp)
    +        wp.start()
    +    logging.config.dictConfig(d)
    +    lp = threading.Thread(target=logger_thread, args=(q,))
    +    lp.start()
    +    # At this point, the main process could do some useful work of its own
    +    # Once it's done that, it can wait for the workers to terminate...
    +    for wp in workers:
    +        wp.join()
    +    # And now tell the logging thread to finish up, too
    +    q.put(None)
    +    lp.join()
    +
    +
    +

    This variant shows how you can e.g. apply configuration for particular loggers +- e.g. the foo logger has a special handler which stores all events in the +foo subsystem in a file mplog-foo.log. This will be used by the logging +machinery in the main process (even though the logging events are generated in +the worker processes) to direct the messages to the appropriate destinations.

    +
    +
    +

    Using file rotation

    +

    Sometimes you want to let a log file grow to a certain size, then open a new +file and log to that. You may want to keep a certain number of these files, and +when that many files have been created, rotate the files so that the number of +files and the size of the files both remain bounded. For this usage pattern, the +logging package provides a RotatingFileHandler:

    +
    import glob
    +import logging
    +import logging.handlers
    +
    +LOG_FILENAME = 'logging_rotatingfile_example.out'
    +
    +# Set up a specific logger with our desired output level
    +my_logger = logging.getLogger('MyLogger')
    +my_logger.setLevel(logging.DEBUG)
    +
    +# Add the log message handler to the logger
    +handler = logging.handlers.RotatingFileHandler(
    +              LOG_FILENAME, maxBytes=20, backupCount=5)
    +
    +my_logger.addHandler(handler)
    +
    +# Log some messages
    +for i in range(20):
    +    my_logger.debug('i = %d' % i)
    +
    +# See what files are created
    +logfiles = glob.glob('%s*' % LOG_FILENAME)
    +
    +for filename in logfiles:
    +    print(filename)
    +
    +
    +

    The result should be 6 separate files, each with part of the log history for the +application:

    +
    logging_rotatingfile_example.out
    +logging_rotatingfile_example.out.1
    +logging_rotatingfile_example.out.2
    +logging_rotatingfile_example.out.3
    +logging_rotatingfile_example.out.4
    +logging_rotatingfile_example.out.5
    +
    +
    +

    The most current file is always logging_rotatingfile_example.out, +and each time it reaches the size limit it is renamed with the suffix +.1. Each of the existing backup files is renamed to increment the suffix +(.1 becomes .2, etc.) and the .6 file is erased.

    +

    Obviously this example sets the log length much too small as an extreme +example. You would want to set maxBytes to an appropriate value.

    +
    +
    +

    Use of alternative formatting styles

    +

    When logging was added to the Python standard library, the only way of +formatting messages with variable content was to use the %-formatting +method. Since then, Python has gained two new formatting approaches: +string.Template (added in Python 2.4) and str.format() +(added in Python 2.6).

    +

    Logging (as of 3.2) provides improved support for these two additional +formatting styles. The Formatter class been enhanced to take an +additional, optional keyword parameter named style. This defaults to +'%', but other possible values are '{' and '$', which correspond +to the other two formatting styles. Backwards compatibility is maintained by +default (as you would expect), but by explicitly specifying a style parameter, +you get the ability to specify format strings which work with +str.format() or string.Template. Here’s an example console +session to show the possibilities:

    +
    >>> import logging
    +>>> root = logging.getLogger()
    +>>> root.setLevel(logging.DEBUG)
    +>>> handler = logging.StreamHandler()
    +>>> bf = logging.Formatter('{asctime} {name} {levelname:8s} {message}',
    +...                        style='{')
    +>>> handler.setFormatter(bf)
    +>>> root.addHandler(handler)
    +>>> logger = logging.getLogger('foo.bar')
    +>>> logger.debug('This is a DEBUG message')
    +2010-10-28 15:11:55,341 foo.bar DEBUG    This is a DEBUG message
    +>>> logger.critical('This is a CRITICAL message')
    +2010-10-28 15:12:11,526 foo.bar CRITICAL This is a CRITICAL message
    +>>> df = logging.Formatter('$asctime $name ${levelname} $message',
    +...                        style='$')
    +>>> handler.setFormatter(df)
    +>>> logger.debug('This is a DEBUG message')
    +2010-10-28 15:13:06,924 foo.bar DEBUG This is a DEBUG message
    +>>> logger.critical('This is a CRITICAL message')
    +2010-10-28 15:13:11,494 foo.bar CRITICAL This is a CRITICAL message
    +>>>
    +
    +
    +

    Note that the formatting of logging messages for final output to logs is +completely independent of how an individual logging message is constructed. +That can still use %-formatting, as shown here:

    +
    >>> logger.error('This is an%s %s %s', 'other,', 'ERROR,', 'message')
    +2010-10-28 15:19:29,833 foo.bar ERROR This is another, ERROR, message
    +>>>
    +
    +
    +

    Logging calls (logger.debug(), logger.info() etc.) only take +positional parameters for the actual logging message itself, with keyword +parameters used only for determining options for how to handle the actual +logging call (e.g. the exc_info keyword parameter to indicate that +traceback information should be logged, or the extra keyword parameter +to indicate additional contextual information to be added to the log). So +you cannot directly make logging calls using str.format() or +string.Template syntax, because internally the logging package +uses %-formatting to merge the format string and the variable arguments. +There would be no changing this while preserving backward compatibility, since +all logging calls which are out there in existing code will be using %-format +strings.

    +

    There is, however, a way that you can use {}- and $- formatting to construct +your individual log messages. Recall that for a message you can use an +arbitrary object as a message format string, and that the logging package will +call str() on that object to get the actual format string. Consider the +following two classes:

    +
    class BraceMessage:
    +    def __init__(self, fmt, *args, **kwargs):
    +        self.fmt = fmt
    +        self.args = args
    +        self.kwargs = kwargs
    +
    +    def __str__(self):
    +        return self.fmt.format(*self.args, **self.kwargs)
    +
    +class DollarMessage:
    +    def __init__(self, fmt, **kwargs):
    +        self.fmt = fmt
    +        self.kwargs = kwargs
    +
    +    def __str__(self):
    +        from string import Template
    +        return Template(self.fmt).substitute(**self.kwargs)
    +
    +
    +

    Either of these can be used in place of a format string, to allow {}- or +$-formatting to be used to build the actual “message” part which appears in the +formatted log output in place of “%(message)s” or “{message}” or “$message”. +It’s a little unwieldy to use the class names whenever you want to log +something, but it’s quite palatable if you use an alias such as __ (double +underscore — not to be confused with _, the single underscore used as a +synonym/alias for gettext.gettext() or its brethren).

    +

    The above classes are not included in Python, though they’re easy enough to +copy and paste into your own code. They can be used as follows (assuming that +they’re declared in a module called wherever):

    +
    >>> from wherever import BraceMessage as __
    +>>> print(__('Message with {0} {name}', 2, name='placeholders'))
    +Message with 2 placeholders
    +>>> class Point: pass
    +...
    +>>> p = Point()
    +>>> p.x = 0.5
    +>>> p.y = 0.5
    +>>> print(__('Message with coordinates: ({point.x:.2f}, {point.y:.2f})',
    +...       point=p))
    +Message with coordinates: (0.50, 0.50)
    +>>> from wherever import DollarMessage as __
    +>>> print(__('Message with $num $what', num=2, what='placeholders'))
    +Message with 2 placeholders
    +>>>
    +
    +
    +

    While the above examples use print() to show how the formatting works, you +would of course use logger.debug() or similar to actually log using this +approach.

    +

    One thing to note is that you pay no significant performance penalty with this +approach: the actual formatting happens not when you make the logging call, but +when (and if) the logged message is actually about to be output to a log by a +handler. So the only slightly unusual thing which might trip you up is that the +parentheses go around the format string and the arguments, not just the format +string. That’s because the __ notation is just syntax sugar for a constructor +call to one of the XXXMessage classes.

    +

    If you prefer, you can use a LoggerAdapter to achieve a similar effect +to the above, as in the following example:

    +
    import logging
    +
    +class Message(object):
    +    def __init__(self, fmt, args):
    +        self.fmt = fmt
    +        self.args = args
    +
    +    def __str__(self):
    +        return self.fmt.format(*self.args)
    +
    +class StyleAdapter(logging.LoggerAdapter):
    +    def __init__(self, logger, extra=None):
    +        super(StyleAdapter, self).__init__(logger, extra or {})
    +
    +    def log(self, level, msg, *args, **kwargs):
    +        if self.isEnabledFor(level):
    +            msg, kwargs = self.process(msg, kwargs)
    +            self.logger._log(level, Message(msg, args), (), **kwargs)
    +
    +logger = StyleAdapter(logging.getLogger(__name__))
    +
    +def main():
    +    logger.debug('Hello, {}', 'world!')
    +
    +if __name__ == '__main__':
    +    logging.basicConfig(level=logging.DEBUG)
    +    main()
    +
    +
    +

    The above script should log the message Hello, world! when run with +Python 3.2 or later.

    +
    +
    +

    Customizing LogRecord

    +

    Every logging event is represented by a LogRecord instance. +When an event is logged and not filtered out by a logger’s level, a +LogRecord is created, populated with information about the event and +then passed to the handlers for that logger (and its ancestors, up to and +including the logger where further propagation up the hierarchy is disabled). +Before Python 3.2, there were only two places where this creation was done:

    +
      +
    • Logger.makeRecord(), which is called in the normal process of +logging an event. This invoked LogRecord directly to create an +instance.

    • +
    • makeLogRecord(), which is called with a dictionary containing +attributes to be added to the LogRecord. This is typically invoked when a +suitable dictionary has been received over the network (e.g. in pickle form +via a SocketHandler, or in JSON form via an +HTTPHandler).

    • +
    +

    This has usually meant that if you need to do anything special with a +LogRecord, you’ve had to do one of the following.

    +
      +
    • Create your own Logger subclass, which overrides +Logger.makeRecord(), and set it using setLoggerClass() +before any loggers that you care about are instantiated.

    • +
    • Add a Filter to a logger or handler, which does the +necessary special manipulation you need when its +filter() method is called.

    • +
    +

    The first approach would be a little unwieldy in the scenario where (say) +several different libraries wanted to do different things. Each would attempt +to set its own Logger subclass, and the one which did this last would +win.

    +

    The second approach works reasonably well for many cases, but does not allow +you to e.g. use a specialized subclass of LogRecord. Library +developers can set a suitable filter on their loggers, but they would have to +remember to do this every time they introduced a new logger (which they would +do simply by adding new packages or modules and doing

    +
    logger = logging.getLogger(__name__)
    +
    +
    +

    at module level). It’s probably one too many things to think about. Developers +could also add the filter to a NullHandler attached to their +top-level logger, but this would not be invoked if an application developer +attached a handler to a lower-level library logger — so output from that +handler would not reflect the intentions of the library developer.

    +

    In Python 3.2 and later, LogRecord creation is done through a +factory, which you can specify. The factory is just a callable you can set with +setLogRecordFactory(), and interrogate with +getLogRecordFactory(). The factory is invoked with the same +signature as the LogRecord constructor, as LogRecord +is the default setting for the factory.

    +

    This approach allows a custom factory to control all aspects of LogRecord +creation. For example, you could return a subclass, or just add some additional +attributes to the record once created, using a pattern similar to this:

    +
    old_factory = logging.getLogRecordFactory()
    +
    +def record_factory(*args, **kwargs):
    +    record = old_factory(*args, **kwargs)
    +    record.custom_attribute = 0xdecafbad
    +    return record
    +
    +logging.setLogRecordFactory(record_factory)
    +
    +
    +

    This pattern allows different libraries to chain factories together, and as +long as they don’t overwrite each other’s attributes or unintentionally +overwrite the attributes provided as standard, there should be no surprises. +However, it should be borne in mind that each link in the chain adds run-time +overhead to all logging operations, and the technique should only be used when +the use of a Filter does not provide the desired result.

    +
    +
    +

    Subclassing QueueHandler - a ZeroMQ example

    +

    You can use a 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
    +
    +ctx = zmq.Context()
    +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):
    +        self.queue.send_json(record.__dict__)
    +
    +
    +handler = ZeroMQSocketHandler(sock)
    +
    +
    +

    Of course there are other ways of organizing this, for example passing in the +data needed by the handler to create the socket:

    +
    class ZeroMQSocketHandler(QueueHandler):
    +    def __init__(self, uri, socktype=zmq.PUB, ctx=None):
    +        self.ctx = ctx or zmq.Context()
    +        socket = zmq.Socket(self.ctx, socktype)
    +        socket.bind(uri)
    +        super().__init__(socket)
    +
    +    def enqueue(self, record):
    +        self.queue.send_json(record.__dict__)
    +
    +    def close(self):
    +        self.queue.close()
    +
    +
    +
    +
    +

    Subclassing QueueListener - a ZeroMQ example

    +

    You can also subclass QueueListener to get messages from other kinds +of queues, for example a ZeroMQ ‘subscribe’ socket. Here’s an example:

    +
    class ZeroMQSocketListener(QueueListener):
    +    def __init__(self, uri, *handlers, **kwargs):
    +        self.ctx = kwargs.get('ctx') or zmq.Context()
    +        socket = zmq.Socket(self.ctx, zmq.SUB)
    +        socket.setsockopt_string(zmq.SUBSCRIBE, '')  # subscribe to everything
    +        socket.connect(uri)
    +        super().__init__(socket, *handlers, **kwargs)
    +
    +    def dequeue(self):
    +        msg = self.queue.recv_json()
    +        return logging.makeLogRecord(msg)
    +
    +
    +
    +

    See also

    +
    +
    Module logging

    API reference for the logging module.

    +
    +
    Module logging.config

    Configuration API for the logging module.

    +
    +
    Module logging.handlers

    Useful handlers included with the logging module.

    +
    +
    +

    A basic logging tutorial

    +

    A more advanced logging tutorial

    +
    +
    +
    +

    An example dictionary-based configuration

    +

    Below is an example of a logging configuration dictionary - it’s taken from +the documentation on the Django project. +This dictionary is passed to dictConfig() to put the configuration into effect:

    +
    LOGGING = {
    +    'version': 1,
    +    'disable_existing_loggers': True,
    +    'formatters': {
    +        'verbose': {
    +            'format': '%(levelname)s %(asctime)s %(module)s %(process)d %(thread)d %(message)s'
    +        },
    +        'simple': {
    +            'format': '%(levelname)s %(message)s'
    +        },
    +    },
    +    'filters': {
    +        'special': {
    +            '()': 'project.logging.SpecialFilter',
    +            'foo': 'bar',
    +        }
    +    },
    +    'handlers': {
    +        'null': {
    +            'level':'DEBUG',
    +            'class':'django.utils.log.NullHandler',
    +        },
    +        'console':{
    +            'level':'DEBUG',
    +            'class':'logging.StreamHandler',
    +            'formatter': 'simple'
    +        },
    +        'mail_admins': {
    +            'level': 'ERROR',
    +            'class': 'django.utils.log.AdminEmailHandler',
    +            'filters': ['special']
    +        }
    +    },
    +    'loggers': {
    +        'django': {
    +            'handlers':['null'],
    +            'propagate': True,
    +            'level':'INFO',
    +        },
    +        'django.request': {
    +            'handlers': ['mail_admins'],
    +            'level': 'ERROR',
    +            'propagate': False,
    +        },
    +        'myproject.custom': {
    +            'handlers': ['console', 'mail_admins'],
    +            'level': 'INFO',
    +            'filters': ['special']
    +        }
    +    }
    +}
    +
    +
    +

    For more information about this configuration, you can see the relevant +section +of the Django documentation.

    +
    +
    +

    Using a rotator and namer to customize log rotation processing

    +

    An example of how you can define a namer and rotator is given in the following +snippet, which shows zlib-based compression of the log file:

    +
    def namer(name):
    +    return name + ".gz"
    +
    +def rotator(source, dest):
    +    with open(source, "rb") as sf:
    +        data = sf.read()
    +        compressed = zlib.compress(data, 9)
    +        with open(dest, "wb") as df:
    +            df.write(compressed)
    +    os.remove(source)
    +
    +rh = logging.handlers.RotatingFileHandler(...)
    +rh.rotator = rotator
    +rh.namer = namer
    +
    +
    +

    These are not “true” .gz files, as they are bare compressed data, with no +“container” such as you’d find in an actual gzip file. This snippet is just +for illustration purposes.

    +
    +
    +

    A more elaborate multiprocessing example

    +

    The following working example shows how logging can be used with multiprocessing +using configuration files. The configurations are fairly simple, but serve to +illustrate how more complex ones could be implemented in a real multiprocessing +scenario.

    +

    In the example, the main process spawns a listener process and some worker +processes. Each of the main process, the listener and the workers have three +separate configurations (the workers all share the same configuration). We can +see logging in the main process, how the workers log to a QueueHandler and how +the listener implements a QueueListener and a more complex logging +configuration, and arranges to dispatch events received via the queue to the +handlers specified in the configuration. Note that these configurations are +purely illustrative, but you should be able to adapt this example to your own +scenario.

    +

    Here’s the script - the docstrings and the comments hopefully explain how it +works:

    +
    import logging
    +import logging.config
    +import logging.handlers
    +from multiprocessing import Process, Queue, Event, current_process
    +import os
    +import random
    +import time
    +
    +class MyHandler:
    +    """
    +    A simple handler for logging events. It runs in the listener process and
    +    dispatches events to loggers based on the name in the received record,
    +    which then get dispatched, by the logging system, to the handlers
    +    configured for those loggers.
    +    """
    +    def handle(self, record):
    +        logger = logging.getLogger(record.name)
    +        # The process name is transformed just to show that it's the listener
    +        # doing the logging to files and console
    +        record.processName = '%s (for %s)' % (current_process().name, record.processName)
    +        logger.handle(record)
    +
    +def listener_process(q, stop_event, config):
    +    """
    +    This could be done in the main process, but is just done in a separate
    +    process for illustrative purposes.
    +
    +    This initialises logging according to the specified configuration,
    +    starts the listener and waits for the main process to signal completion
    +    via the event. The listener is then stopped, and the process exits.
    +    """
    +    logging.config.dictConfig(config)
    +    listener = logging.handlers.QueueListener(q, MyHandler())
    +    listener.start()
    +    if os.name == 'posix':
    +        # On POSIX, the setup logger will have been configured in the
    +        # parent process, but should have been disabled following the
    +        # dictConfig call.
    +        # On Windows, since fork isn't used, the setup logger won't
    +        # exist in the child, so it would be created and the message
    +        # would appear - hence the "if posix" clause.
    +        logger = logging.getLogger('setup')
    +        logger.critical('Should not appear, because of disabled logger ...')
    +    stop_event.wait()
    +    listener.stop()
    +
    +def worker_process(config):
    +    """
    +    A number of these are spawned for the purpose of illustration. In
    +    practice, they could be a heterogeneous bunch of processes rather than
    +    ones which are identical to each other.
    +
    +    This initialises logging according to the specified configuration,
    +    and logs a hundred messages with random levels to randomly selected
    +    loggers.
    +
    +    A small sleep is added to allow other processes a chance to run. This
    +    is not strictly needed, but it mixes the output from the different
    +    processes a bit more than if it's left out.
    +    """
    +    logging.config.dictConfig(config)
    +    levels = [logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR,
    +              logging.CRITICAL]
    +    loggers = ['foo', 'foo.bar', 'foo.bar.baz',
    +               'spam', 'spam.ham', 'spam.ham.eggs']
    +    if os.name == 'posix':
    +        # On POSIX, the setup logger will have been configured in the
    +        # parent process, but should have been disabled following the
    +        # dictConfig call.
    +        # On Windows, since fork isn't used, the setup logger won't
    +        # exist in the child, so it would be created and the message
    +        # would appear - hence the "if posix" clause.
    +        logger = logging.getLogger('setup')
    +        logger.critical('Should not appear, because of disabled logger ...')
    +    for i in range(100):
    +        lvl = random.choice(levels)
    +        logger = logging.getLogger(random.choice(loggers))
    +        logger.log(lvl, 'Message no. %d', i)
    +        time.sleep(0.01)
    +
    +def main():
    +    q = Queue()
    +    # The main process gets a simple configuration which prints to the console.
    +    config_initial = {
    +        'version': 1,
    +        'formatters': {
    +            'detailed': {
    +                'class': 'logging.Formatter',
    +                'format': '%(asctime)s %(name)-15s %(levelname)-8s %(processName)-10s %(message)s'
    +            }
    +        },
    +        'handlers': {
    +            'console': {
    +                'class': 'logging.StreamHandler',
    +                'level': 'INFO',
    +            },
    +        },
    +        'root': {
    +            'level': 'DEBUG',
    +            'handlers': ['console']
    +        },
    +    }
    +    # The worker process configuration is just a QueueHandler attached to the
    +    # root logger, which allows all messages to be sent to the queue.
    +    # We disable existing loggers to disable the "setup" logger used in the
    +    # parent process. This is needed on POSIX because the logger will
    +    # be there in the child following a fork().
    +    config_worker = {
    +        'version': 1,
    +        'disable_existing_loggers': True,
    +        'handlers': {
    +            'queue': {
    +                'class': 'logging.handlers.QueueHandler',
    +                'queue': q,
    +            },
    +        },
    +        'root': {
    +            'level': 'DEBUG',
    +            'handlers': ['queue']
    +        },
    +    }
    +    # The listener process configuration shows that the full flexibility of
    +    # logging configuration is available to dispatch events to handlers however
    +    # you want.
    +    # We disable existing loggers to disable the "setup" logger used in the
    +    # parent process. This is needed on POSIX because the logger will
    +    # be there in the child following a fork().
    +    config_listener = {
    +        'version': 1,
    +        'disable_existing_loggers': True,
    +        'formatters': {
    +            'detailed': {
    +                'class': 'logging.Formatter',
    +                'format': '%(asctime)s %(name)-15s %(levelname)-8s %(processName)-10s %(message)s'
    +            },
    +            'simple': {
    +                'class': 'logging.Formatter',
    +                'format': '%(name)-15s %(levelname)-8s %(processName)-10s %(message)s'
    +            }
    +        },
    +        'handlers': {
    +            'console': {
    +                'class': 'logging.StreamHandler',
    +                'level': 'INFO',
    +                'formatter': 'simple',
    +            },
    +            'file': {
    +                'class': 'logging.FileHandler',
    +                'filename': 'mplog.log',
    +                'mode': 'w',
    +                'formatter': 'detailed',
    +            },
    +            'foofile': {
    +                'class': 'logging.FileHandler',
    +                'filename': 'mplog-foo.log',
    +                'mode': 'w',
    +                'formatter': 'detailed',
    +            },
    +            'errors': {
    +                'class': 'logging.FileHandler',
    +                'filename': 'mplog-errors.log',
    +                'mode': 'w',
    +                'level': 'ERROR',
    +                'formatter': 'detailed',
    +            },
    +        },
    +        'loggers': {
    +            'foo': {
    +                'handlers': ['foofile']
    +            }
    +        },
    +        'root': {
    +            'level': 'DEBUG',
    +            'handlers': ['console', 'file', 'errors']
    +        },
    +    }
    +    # Log some initial events, just to show that logging in the parent works
    +    # normally.
    +    logging.config.dictConfig(config_initial)
    +    logger = logging.getLogger('setup')
    +    logger.info('About to create workers ...')
    +    workers = []
    +    for i in range(5):
    +        wp = Process(target=worker_process, name='worker %d' % (i + 1),
    +                     args=(config_worker,))
    +        workers.append(wp)
    +        wp.start()
    +        logger.info('Started worker: %s', wp.name)
    +    logger.info('About to create listener ...')
    +    stop_event = Event()
    +    lp = Process(target=listener_process, name='listener',
    +                 args=(q, stop_event, config_listener))
    +    lp.start()
    +    logger.info('Started listener')
    +    # We now hang around for the workers to finish their work.
    +    for wp in workers:
    +        wp.join()
    +    # Workers all done, listening can now stop.
    +    # Logging in the parent still works normally.
    +    logger.info('Telling listener to stop ...')
    +    stop_event.set()
    +    lp.join()
    +    logger.info('All done.')
    +
    +if __name__ == '__main__':
    +    main()
    +
    +
    +
    +
    +

    Inserting a BOM into messages sent to a SysLogHandler

    +

    RFC 5424 requires that a +Unicode message be sent to a syslog daemon as a set of bytes which have the +following structure: an optional pure-ASCII component, followed by a UTF-8 Byte +Order Mark (BOM), followed by Unicode encoded using UTF-8. (See the +relevant section of the specification.)

    +

    In Python 3.1, code was added to +SysLogHandler to insert a BOM into the message, but +unfortunately, it was implemented incorrectly, with the BOM appearing at the +beginning of the message and hence not allowing any pure-ASCII component to +appear before it.

    +

    As this behaviour is broken, the incorrect BOM insertion code is being removed +from Python 3.2.4 and later. However, it is not being replaced, and if you +want to produce RFC 5424-compliant messages which include a BOM, an optional +pure-ASCII sequence before it and arbitrary Unicode after it, encoded using +UTF-8, then you need to do the following:

    +
      +
    1. Attach a Formatter instance to your +SysLogHandler instance, with a format string +such as:

      +
      'ASCII section\ufeffUnicode section'
      +
      +
      +

      The Unicode code point U+FEFF, when encoded using UTF-8, will be +encoded as a UTF-8 BOM – the byte-string b'\xef\xbb\xbf'.

      +
    2. +
    3. Replace the ASCII section with whatever placeholders you like, but make sure +that the data that appears in there after substitution is always ASCII (that +way, it will remain unchanged after UTF-8 encoding).

    4. +
    5. Replace the Unicode section with whatever placeholders you like; if the data +which appears there after substitution contains characters outside the ASCII +range, that’s fine – it will be encoded using UTF-8.

    6. +
    +

    The formatted message will be encoded using UTF-8 encoding by +SysLogHandler. If you follow the above rules, you should be able to produce +RFC 5424-compliant messages. If you don’t, logging may not complain, but your +messages will not be RFC 5424-compliant, and your syslog daemon may complain.

    +
    +
    +

    Implementing structured logging

    +

    Although most logging messages are intended for reading by humans, and thus not +readily machine-parseable, there might be circumstances where you want to output +messages in a structured format which is capable of being parsed by a program +(without needing complex regular expressions to parse the log message). This is +straightforward to achieve using the logging package. There are a number of +ways in which this could be achieved, but the following is a simple approach +which uses JSON to serialise the event in a machine-parseable manner:

    +
    import json
    +import logging
    +
    +class StructuredMessage(object):
    +    def __init__(self, message, **kwargs):
    +        self.message = message
    +        self.kwargs = kwargs
    +
    +    def __str__(self):
    +        return '%s >>> %s' % (self.message, json.dumps(self.kwargs))
    +
    +_ = StructuredMessage   # optional, to improve readability
    +
    +logging.basicConfig(level=logging.INFO, format='%(message)s')
    +logging.info(_('message 1', foo='bar', bar='baz', num=123, fnum=123.456))
    +
    +
    +

    If the above script is run, it prints:

    +
    message 1 >>> {"fnum": 123.456, "num": 123, "bar": "baz", "foo": "bar"}
    +
    +
    +

    Note that the order of items might be different according to the version of +Python used.

    +

    If you need more specialised processing, you can use a custom JSON encoder, +as in the following complete example:

    +
    from __future__ import unicode_literals
    +
    +import json
    +import logging
    +
    +# This next bit is to ensure the script runs unchanged on 2.x and 3.x
    +try:
    +    unicode
    +except NameError:
    +    unicode = str
    +
    +class Encoder(json.JSONEncoder):
    +    def default(self, o):
    +        if isinstance(o, set):
    +            return tuple(o)
    +        elif isinstance(o, unicode):
    +            return o.encode('unicode_escape').decode('ascii')
    +        return super(Encoder, self).default(o)
    +
    +class StructuredMessage(object):
    +    def __init__(self, message, **kwargs):
    +        self.message = message
    +        self.kwargs = kwargs
    +
    +    def __str__(self):
    +        s = Encoder().encode(self.kwargs)
    +        return '%s >>> %s' % (self.message, s)
    +
    +_ = StructuredMessage   # optional, to improve readability
    +
    +def main():
    +    logging.basicConfig(level=logging.INFO, format='%(message)s')
    +    logging.info(_('message 1', set_value={1, 2, 3}, snowman='\u2603'))
    +
    +if __name__ == '__main__':
    +    main()
    +
    +
    +

    When the above script is run, it prints:

    +
    message 1 >>> {"snowman": "\u2603", "set_value": [1, 2, 3]}
    +
    +
    +

    Note that the order of items might be different according to the version of +Python used.

    +
    +
    +

    Customizing handlers with dictConfig()

    +

    There are times when you want to customize logging handlers in particular ways, +and if you use dictConfig() you may be able to do this without +subclassing. As an example, consider that you may want to set the ownership of a +log file. On POSIX, this is easily done using shutil.chown(), but the file +handlers in the stdlib don’t offer built-in support. You can customize handler +creation using a plain function such as:

    +
    def owned_file_handler(filename, mode='a', encoding=None, owner=None):
    +    if owner:
    +        if not os.path.exists(filename):
    +            open(filename, 'a').close()
    +        shutil.chown(filename, *owner)
    +    return logging.FileHandler(filename, mode, encoding)
    +
    +
    +

    You can then specify, in a logging configuration passed to dictConfig(), +that a logging handler be created by calling this function:

    +
    LOGGING = {
    +    'version': 1,
    +    'disable_existing_loggers': False,
    +    'formatters': {
    +        'default': {
    +            'format': '%(asctime)s %(levelname)s %(name)s %(message)s'
    +        },
    +    },
    +    'handlers': {
    +        'file':{
    +            # The values below are popped from this dictionary and
    +            # used to create the handler, set the handler's level and
    +            # its formatter.
    +            '()': owned_file_handler,
    +            'level':'DEBUG',
    +            'formatter': 'default',
    +            # The values below are passed to the handler creator callable
    +            # as keyword arguments.
    +            'owner': ['pulse', 'pulse'],
    +            'filename': 'chowntest.log',
    +            'mode': 'w',
    +            'encoding': 'utf-8',
    +        },
    +    },
    +    'root': {
    +        'handlers': ['file'],
    +        'level': 'DEBUG',
    +    },
    +}
    +
    +
    +

    In this example I am setting the ownership using the pulse user and group, +just for the purposes of illustration. Putting it together into a working +script, chowntest.py:

    +
    import logging, logging.config, os, shutil
    +
    +def owned_file_handler(filename, mode='a', encoding=None, owner=None):
    +    if owner:
    +        if not os.path.exists(filename):
    +            open(filename, 'a').close()
    +        shutil.chown(filename, *owner)
    +    return logging.FileHandler(filename, mode, encoding)
    +
    +LOGGING = {
    +    'version': 1,
    +    'disable_existing_loggers': False,
    +    'formatters': {
    +        'default': {
    +            'format': '%(asctime)s %(levelname)s %(name)s %(message)s'
    +        },
    +    },
    +    'handlers': {
    +        'file':{
    +            # The values below are popped from this dictionary and
    +            # used to create the handler, set the handler's level and
    +            # its formatter.
    +            '()': owned_file_handler,
    +            'level':'DEBUG',
    +            'formatter': 'default',
    +            # The values below are passed to the handler creator callable
    +            # as keyword arguments.
    +            'owner': ['pulse', 'pulse'],
    +            'filename': 'chowntest.log',
    +            'mode': 'w',
    +            'encoding': 'utf-8',
    +        },
    +    },
    +    'root': {
    +        'handlers': ['file'],
    +        'level': 'DEBUG',
    +    },
    +}
    +
    +logging.config.dictConfig(LOGGING)
    +logger = logging.getLogger('mylogger')
    +logger.debug('A debug message')
    +
    +
    +

    To run this, you will probably need to run as root:

    +
    $ sudo python3.3 chowntest.py
    +$ cat chowntest.log
    +2013-11-05 09:34:51,128 DEBUG mylogger A debug message
    +$ ls -l chowntest.log
    +-rw-r--r-- 1 pulse pulse 55 2013-11-05 09:34 chowntest.log
    +
    +
    +

    Note that this example uses Python 3.3 because that’s where shutil.chown() +makes an appearance. This approach should work with any Python version that +supports dictConfig() - namely, Python 2.7, 3.2 or later. With pre-3.3 +versions, you would need to implement the actual ownership change using e.g. +os.chown().

    +

    In practice, the handler-creating function may be in a utility module somewhere +in your project. Instead of the line in the configuration:

    +
    '()': owned_file_handler,
    +
    +
    +

    you could use e.g.:

    +
    '()': 'ext://project.util.owned_file_handler',
    +
    +
    +

    where project.util can be replaced with the actual name of the package +where the function resides. In the above working script, using +'ext://__main__.owned_file_handler' should work. Here, the actual callable +is resolved by dictConfig() from the ext:// specification.

    +

    This example hopefully also points the way to how you could implement other +types of file change - e.g. setting specific POSIX permission bits - in the +same way, using os.chmod().

    +

    Of course, the approach could also be extended to types of handler other than a +FileHandler - for example, one of the rotating file handlers, +or a different type of handler altogether.

    +
    +
    +

    Using particular formatting styles throughout your application

    +

    In Python 3.2, the Formatter gained a style keyword +parameter which, while defaulting to % for backward compatibility, allowed +the specification of { or $ to support the formatting approaches +supported by str.format() and string.Template. Note that this +governs the formatting of logging messages for final output to logs, and is +completely orthogonal to how an individual logging message is constructed.

    +

    Logging calls (debug(), info() etc.) only take +positional parameters for the actual logging message itself, with keyword +parameters used only for determining options for how to handle the logging call +(e.g. the exc_info keyword parameter to indicate that traceback information +should be logged, or the extra keyword parameter to indicate additional +contextual information to be added to the log). So you cannot directly make +logging calls using str.format() or string.Template syntax, +because internally the logging package uses %-formatting to merge the format +string and the variable arguments. There would no changing this while preserving +backward compatibility, since all logging calls which are out there in existing +code will be using %-format strings.

    +

    There have been suggestions to associate format styles with specific loggers, +but that approach also runs into backward compatibility problems because any +existing code could be using a given logger name and using %-formatting.

    +

    For logging to work interoperably between any third-party libraries and your +code, decisions about formatting need to be made at the level of the +individual logging call. This opens up a couple of ways in which alternative +formatting styles can be accommodated.

    +
    +

    Using LogRecord factories

    +

    In Python 3.2, along with the Formatter changes mentioned +above, the logging package gained the ability to allow users to set their own +LogRecord subclasses, using the setLogRecordFactory() function. +You can use this to set your own subclass of LogRecord, which does the +Right Thing by overriding the getMessage() method. The base +class implementation of this method is where the msg % args formatting +happens, and where you can substitute your alternate formatting; however, you +should be careful to support all formatting styles and allow %-formatting as +the default, to ensure interoperability with other code. Care should also be +taken to call str(self.msg), just as the base implementation does.

    +

    Refer to the reference documentation on setLogRecordFactory() and +LogRecord for more information.

    +
    +
    +

    Using custom message objects

    +

    There is another, perhaps simpler way that you can use {}- and $- formatting to +construct your individual log messages. You may recall (from +Using arbitrary objects as messages) that when logging you can use an arbitrary +object as a message format string, and that the logging package will call +str() on that object to get the actual format string. Consider the +following two classes:

    +
    class BraceMessage(object):
    +    def __init__(self, fmt, *args, **kwargs):
    +        self.fmt = fmt
    +        self.args = args
    +        self.kwargs = kwargs
    +
    +    def __str__(self):
    +        return self.fmt.format(*self.args, **self.kwargs)
    +
    +class DollarMessage(object):
    +    def __init__(self, fmt, **kwargs):
    +        self.fmt = fmt
    +        self.kwargs = kwargs
    +
    +    def __str__(self):
    +        from string import Template
    +        return Template(self.fmt).substitute(**self.kwargs)
    +
    +
    +

    Either of these can be used in place of a format string, to allow {}- or +$-formatting to be used to build the actual “message” part which appears in the +formatted log output in place of “%(message)s” or “{message}” or “$message”. +If you find it a little unwieldy to use the class names whenever you want to log +something, you can make it more palatable if you use an alias such as M or +_ for the message (or perhaps __, if you are using _ for +localization).

    +

    Examples of this approach are given below. Firstly, formatting with +str.format():

    +
    >>> __ = BraceMessage
    +>>> print(__('Message with {0} {1}', 2, 'placeholders'))
    +Message with 2 placeholders
    +>>> class Point: pass
    +...
    +>>> p = Point()
    +>>> p.x = 0.5
    +>>> p.y = 0.5
    +>>> print(__('Message with coordinates: ({point.x:.2f}, {point.y:.2f})', point=p))
    +Message with coordinates: (0.50, 0.50)
    +
    +
    +

    Secondly, formatting with string.Template:

    +
    >>> __ = DollarMessage
    +>>> print(__('Message with $num $what', num=2, what='placeholders'))
    +Message with 2 placeholders
    +>>>
    +
    +
    +

    One thing to note is that you pay no significant performance penalty with this +approach: the actual formatting happens not when you make the logging call, but +when (and if) the logged message is actually about to be output to a log by a +handler. So the only slightly unusual thing which might trip you up is that the +parentheses go around the format string and the arguments, not just the format +string. That’s because the __ notation is just syntax sugar for a constructor +call to one of the XXXMessage classes shown above.

    +
    +
    +
    +

    Configuring filters with dictConfig()

    +

    You can configure filters using dictConfig(), though it +might not be obvious at first glance how to do it (hence this recipe). Since +Filter is the only filter class included in the standard +library, and it is unlikely to cater to many requirements (it’s only there as a +base class), you will typically need to define your own Filter +subclass with an overridden filter() method. To do this, +specify the () key in the configuration dictionary for the filter, +specifying a callable which will be used to create the filter (a class is the +most obvious, but you can provide any callable which returns a +Filter instance). Here is a complete example:

    +
    import logging
    +import logging.config
    +import sys
    +
    +class MyFilter(logging.Filter):
    +    def __init__(self, param=None):
    +        self.param = param
    +
    +    def filter(self, record):
    +        if self.param is None:
    +            allow = True
    +        else:
    +            allow = self.param not in record.msg
    +        if allow:
    +            record.msg = 'changed: ' + record.msg
    +        return allow
    +
    +LOGGING = {
    +    'version': 1,
    +    'filters': {
    +        'myfilter': {
    +            '()': MyFilter,
    +            'param': 'noshow',
    +        }
    +    },
    +    'handlers': {
    +        'console': {
    +            'class': 'logging.StreamHandler',
    +            'filters': ['myfilter']
    +        }
    +    },
    +    'root': {
    +        'level': 'DEBUG',
    +        'handlers': ['console']
    +    },
    +}
    +
    +if __name__ == '__main__':
    +    logging.config.dictConfig(LOGGING)
    +    logging.debug('hello')
    +    logging.debug('hello - noshow')
    +
    +
    +

    This example shows how you can pass configuration data to the callable which +constructs the instance, in the form of keyword parameters. When run, the above +script will print:

    +
    changed: hello
    +
    +
    +

    which shows that the filter is working as configured.

    +

    A couple of extra points to note:

    +
      +
    • If you can’t refer to the callable directly in the configuration (e.g. if it +lives in a different module, and you can’t import it directly where the +configuration dictionary is), you can use the form ext://... as described +in Access to external objects. For example, you could have used +the text 'ext://__main__.MyFilter' instead of MyFilter in the above +example.

    • +
    • As well as for filters, this technique can also be used to configure custom +handlers and formatters. See User-defined objects for more +information on how logging supports using user-defined objects in its +configuration, and see the other cookbook recipe Customizing handlers with dictConfig() above.

    • +
    +
    +
    +

    Customized exception formatting

    +

    There might be times when you want to do customized exception formatting - for +argument’s sake, let’s say you want exactly one line per logged event, even +when exception information is present. You can do this with a custom formatter +class, as shown in the following example:

    +
    import logging
    +
    +class OneLineExceptionFormatter(logging.Formatter):
    +    def formatException(self, exc_info):
    +        """
    +        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
    +
    +    def format(self, record):
    +        s = super(OneLineExceptionFormatter, self).format(record)
    +        if record.exc_text:
    +            s = s.replace('\n', '') + '|'
    +        return s
    +
    +def configure_logging():
    +    fh = logging.FileHandler('output.txt', 'w')
    +    f = OneLineExceptionFormatter('%(asctime)s|%(levelname)s|%(message)s|',
    +                                  '%d/%m/%Y %H:%M:%S')
    +    fh.setFormatter(f)
    +    root = logging.getLogger()
    +    root.setLevel(logging.DEBUG)
    +    root.addHandler(fh)
    +
    +def main():
    +    configure_logging()
    +    logging.info('Sample message')
    +    try:
    +        x = 1 / 0
    +    except ZeroDivisionError as e:
    +        logging.exception('ZeroDivisionError: %s', e)
    +
    +if __name__ == '__main__':
    +    main()
    +
    +
    +

    When run, this produces a file with exactly two lines:

    +
    28/01/2015 07:21:23|INFO|Sample message|
    +28/01/2015 07:21:23|ERROR|ZeroDivisionError: integer division or modulo by zero|'Traceback (most recent call last):\n  File "logtest7.py", line 30, in main\n    x = 1 / 0\nZeroDivisionError: integer division or modulo by zero'|
    +
    +
    +

    While the above treatment is simplistic, it points the way to how exception +information can be formatted to your liking. The traceback module may be +helpful for more specialized needs.

    +
    +
    +

    Speaking logging messages

    +

    There might be situations when it is desirable to have logging messages rendered +in an audible rather than a visible format. This is easy to do if you have +text-to-speech (TTS) functionality available in your system, even if it doesn’t have +a Python binding. Most TTS systems have a command line program you can run, and +this can be invoked from a handler using subprocess. It’s assumed here +that TTS command line programs won’t expect to interact with users or take a +long time to complete, and that the frequency of logged messages will be not so +high as to swamp the user with messages, and that it’s acceptable to have the +messages spoken one at a time rather than concurrently, The example implementation +below waits for one message to be spoken before the next is processed, and this +might cause other handlers to be kept waiting. Here is a short example showing +the approach, which assumes that the espeak TTS package is available:

    +
    import logging
    +import subprocess
    +import sys
    +
    +class TTSHandler(logging.Handler):
    +    def emit(self, record):
    +        msg = self.format(record)
    +        # Speak slowly in a female English voice
    +        cmd = ['espeak', '-s150', '-ven+f3', msg]
    +        p = subprocess.Popen(cmd, stdout=subprocess.PIPE,
    +                             stderr=subprocess.STDOUT)
    +        # wait for the program to finish
    +        p.communicate()
    +
    +def configure_logging():
    +    h = TTSHandler()
    +    root = logging.getLogger()
    +    root.addHandler(h)
    +    # the default formatter just returns the message
    +    root.setLevel(logging.DEBUG)
    +
    +def main():
    +    logging.info('Hello')
    +    logging.debug('Goodbye')
    +
    +if __name__ == '__main__':
    +    configure_logging()
    +    sys.exit(main())
    +
    +
    +

    When run, this script should say “Hello” and then “Goodbye” in a female voice.

    +

    The above approach can, of course, be adapted to other TTS systems and even +other systems altogether which can process messages via external programs run +from a command line.

    +
    +
    +

    Buffering logging messages and outputting them conditionally

    +

    There might be situations where you want to log messages in a temporary area +and only output them if a certain condition occurs. For example, you may want to +start logging debug events in a function, and if the function completes without +errors, you don’t want to clutter the log with the collected debug information, +but if there is an error, you want all the debug information to be output as well +as the error.

    +

    Here is an example which shows how you could do this using a decorator for your +functions where you want logging to behave this way. It makes use of the +logging.handlers.MemoryHandler, which allows buffering of logged events +until some condition occurs, at which point the buffered events are flushed +- passed to another handler (the target handler) for processing. By default, +the MemoryHandler flushed when its buffer gets filled up or an event whose +level is greater than or equal to a specified threshold is seen. You can use this +recipe with a more specialised subclass of MemoryHandler if you want custom +flushing behavior.

    +

    The example script has a simple function, foo, which just cycles through +all the logging levels, writing to sys.stderr to say what level it’s about +to log at, and then actually logging a message at that level. You can pass a +parameter to foo which, if true, will log at ERROR and CRITICAL levels - +otherwise, it only logs at DEBUG, INFO and WARNING levels.

    +

    The script just arranges to decorate foo with a decorator which will do the +conditional logging that’s required. The decorator takes a logger as a parameter +and attaches a memory handler for the duration of the call to the decorated +function. The decorator can be additionally parameterised using a target handler, +a level at which flushing should occur, and a capacity for the buffer (number of +records buffered). These default to a StreamHandler which +writes to sys.stderr, logging.ERROR and 100 respectively.

    +

    Here’s the script:

    +
    import logging
    +from logging.handlers import MemoryHandler
    +import sys
    +
    +logger = logging.getLogger(__name__)
    +logger.addHandler(logging.NullHandler())
    +
    +def log_if_errors(logger, target_handler=None, flush_level=None, capacity=None):
    +    if target_handler is None:
    +        target_handler = logging.StreamHandler()
    +    if flush_level is None:
    +        flush_level = logging.ERROR
    +    if capacity is None:
    +        capacity = 100
    +    handler = MemoryHandler(capacity, flushLevel=flush_level, target=target_handler)
    +
    +    def decorator(fn):
    +        def wrapper(*args, **kwargs):
    +            logger.addHandler(handler)
    +            try:
    +                return fn(*args, **kwargs)
    +            except Exception:
    +                logger.exception('call failed')
    +                raise
    +            finally:
    +                super(MemoryHandler, handler).flush()
    +                logger.removeHandler(handler)
    +        return wrapper
    +
    +    return decorator
    +
    +def write_line(s):
    +    sys.stderr.write('%s\n' % s)
    +
    +def foo(fail=False):
    +    write_line('about to log at DEBUG ...')
    +    logger.debug('Actually logged at DEBUG')
    +    write_line('about to log at INFO ...')
    +    logger.info('Actually logged at INFO')
    +    write_line('about to log at WARNING ...')
    +    logger.warning('Actually logged at WARNING')
    +    if fail:
    +        write_line('about to log at ERROR ...')
    +        logger.error('Actually logged at ERROR')
    +        write_line('about to log at CRITICAL ...')
    +        logger.critical('Actually logged at CRITICAL')
    +    return fail
    +
    +decorated_foo = log_if_errors(logger)(foo)
    +
    +if __name__ == '__main__':
    +    logger.setLevel(logging.DEBUG)
    +    write_line('Calling undecorated foo with False')
    +    assert not foo(False)
    +    write_line('Calling undecorated foo with True')
    +    assert foo(True)
    +    write_line('Calling decorated foo with False')
    +    assert not decorated_foo(False)
    +    write_line('Calling decorated foo with True')
    +    assert decorated_foo(True)
    +
    +
    +

    When this script is run, the following output should be observed:

    +
    Calling undecorated foo with False
    +about to log at DEBUG ...
    +about to log at INFO ...
    +about to log at WARNING ...
    +Calling undecorated foo with True
    +about to log at DEBUG ...
    +about to log at INFO ...
    +about to log at WARNING ...
    +about to log at ERROR ...
    +about to log at CRITICAL ...
    +Calling decorated foo with False
    +about to log at DEBUG ...
    +about to log at INFO ...
    +about to log at WARNING ...
    +Calling decorated foo with True
    +about to log at DEBUG ...
    +about to log at INFO ...
    +about to log at WARNING ...
    +about to log at ERROR ...
    +Actually logged at DEBUG
    +Actually logged at INFO
    +Actually logged at WARNING
    +Actually logged at ERROR
    +about to log at CRITICAL ...
    +Actually logged at CRITICAL
    +
    +
    +

    As you can see, actual logging output only occurs when an event is logged whose +severity is ERROR or greater, but in that case, any previous events at lower +severities are also logged.

    +

    You can of course use the conventional means of decoration:

    +
    @log_if_errors(logger)
    +def foo(fail=False):
    +    ...
    +
    +
    +
    +
    +

    Formatting times using UTC (GMT) via configuration

    +

    Sometimes you want to format times using UTC, which can be done using a class +such as UTCFormatter, shown below:

    +
    import logging
    +import time
    +
    +class UTCFormatter(logging.Formatter):
    +    converter = time.gmtime
    +
    +
    +

    and you can then use the UTCFormatter in your code instead of +Formatter. If you want to do that via configuration, you can +use the dictConfig() API with an approach illustrated by +the following complete example:

    +
    import logging
    +import logging.config
    +import time
    +
    +class UTCFormatter(logging.Formatter):
    +    converter = time.gmtime
    +
    +LOGGING = {
    +    'version': 1,
    +    'disable_existing_loggers': False,
    +    'formatters': {
    +        'utc': {
    +            '()': UTCFormatter,
    +            'format': '%(asctime)s %(message)s',
    +        },
    +        'local': {
    +            'format': '%(asctime)s %(message)s',
    +        }
    +    },
    +    'handlers': {
    +        'console1': {
    +            'class': 'logging.StreamHandler',
    +            'formatter': 'utc',
    +        },
    +        'console2': {
    +            'class': 'logging.StreamHandler',
    +            'formatter': 'local',
    +        },
    +    },
    +    'root': {
    +        'handlers': ['console1', 'console2'],
    +   }
    +}
    +
    +if __name__ == '__main__':
    +    logging.config.dictConfig(LOGGING)
    +    logging.warning('The local time is %s', time.asctime())
    +
    +
    +

    When this script is run, it should print something like:

    +
    2015-10-17 12:53:29,501 The local time is Sat Oct 17 13:53:29 2015
    +2015-10-17 13:53:29,501 The local time is Sat Oct 17 13:53:29 2015
    +
    +
    +

    showing how the time is formatted both as local time and UTC, one for each +handler.

    +
    +
    +

    Using a context manager for selective logging

    +

    There are times when it would be useful to temporarily change the logging +configuration and revert it back after doing something. For this, a context +manager is the most obvious way of saving and restoring the logging context. +Here is a simple example of such a context manager, which allows you to +optionally change the logging level and add a logging handler purely in the +scope of the context manager:

    +
    import logging
    +import sys
    +
    +class LoggingContext(object):
    +    def __init__(self, logger, level=None, handler=None, close=True):
    +        self.logger = logger
    +        self.level = level
    +        self.handler = handler
    +        self.close = close
    +
    +    def __enter__(self):
    +        if self.level is not None:
    +            self.old_level = self.logger.level
    +            self.logger.setLevel(self.level)
    +        if self.handler:
    +            self.logger.addHandler(self.handler)
    +
    +    def __exit__(self, et, ev, tb):
    +        if self.level is not None:
    +            self.logger.setLevel(self.old_level)
    +        if self.handler:
    +            self.logger.removeHandler(self.handler)
    +        if self.handler and self.close:
    +            self.handler.close()
    +        # implicit return of None => don't swallow exceptions
    +
    +
    +

    If you specify a level value, the logger’s level is set to that value in the +scope of the with block covered by the context manager. If you specify a +handler, it is added to the logger on entry to the block and removed on exit +from the block. You can also ask the manager to close the handler for you on +block exit - you could do this if you don’t need the handler any more.

    +

    To illustrate how it works, we can add the following block of code to the +above:

    +
    if __name__ == '__main__':
    +    logger = logging.getLogger('foo')
    +    logger.addHandler(logging.StreamHandler())
    +    logger.setLevel(logging.INFO)
    +    logger.info('1. This should appear just once on stderr.')
    +    logger.debug('2. This should not appear.')
    +    with LoggingContext(logger, level=logging.DEBUG):
    +        logger.debug('3. This should appear once on stderr.')
    +    logger.debug('4. This should not appear.')
    +    h = logging.StreamHandler(sys.stdout)
    +    with LoggingContext(logger, level=logging.DEBUG, handler=h, close=True):
    +        logger.debug('5. This should appear twice - once on stderr and once on stdout.')
    +    logger.info('6. This should appear just once on stderr.')
    +    logger.debug('7. This should not appear.')
    +
    +
    +

    We initially set the logger’s level to INFO, so message #1 appears and +message #2 doesn’t. We then change the level to DEBUG temporarily in the +following with block, and so message #3 appears. After the block exits, the +logger’s level is restored to INFO and so message #4 doesn’t appear. In the +next with block, we set the level to DEBUG again but also add a handler +writing to sys.stdout. Thus, message #5 appears twice on the console (once +via stderr and once via stdout). After the with statement’s +completion, the status is as it was before so message #6 appears (like message +#1) whereas message #7 doesn’t (just like message #2).

    +

    If we run the resulting script, the result is as follows:

    +
    $ python logctx.py
    +1. This should appear just once on stderr.
    +3. This should appear once on stderr.
    +5. This should appear twice - once on stderr and once on stdout.
    +5. This should appear twice - once on stderr and once on stdout.
    +6. This should appear just once on stderr.
    +
    +
    +

    If we run it again, but pipe stderr to /dev/null, we see the following, +which is the only message written to stdout:

    +
    $ python logctx.py 2>/dev/null
    +5. This should appear twice - once on stderr and once on stdout.
    +
    +
    +

    Once again, but piping stdout to /dev/null, we get:

    +
    $ python logctx.py >/dev/null
    +1. This should appear just once on stderr.
    +3. This should appear once on stderr.
    +5. This should appear twice - once on stderr and once on stdout.
    +6. This should appear just once on stderr.
    +
    +
    +

    In this case, the message #5 printed to stdout doesn’t appear, as expected.

    +

    Of course, the approach described here can be generalised, for example to attach +logging filters temporarily. Note that the above code works in Python 2 as well +as Python 3.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/howto/logging.html b/python-3.7.4-docs-html/howto/logging.html new file mode 100644 index 0000000..2b5b244 --- /dev/null +++ b/python-3.7.4-docs-html/howto/logging.html @@ -0,0 +1,1233 @@ + + + + + + + Logging HOWTO — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Logging HOWTO

    +
    +
    Author
    +

    Vinay Sajip <vinay_sajip at red-dove dot com>

    +
    +
    +
    +

    Basic Logging Tutorial

    +

    Logging is a means of tracking events that happen when some software runs. The +software’s developer adds logging calls to their code to indicate that certain +events have occurred. An event is described by a descriptive message which can +optionally contain variable data (i.e. data that is potentially different for +each occurrence of the event). Events also have an importance which the +developer ascribes to the event; the importance can also be called the level +or severity.

    +
    +

    When to use logging

    +

    Logging provides a set of convenience functions for simple logging usage. These +are debug(), info(), warning(), error() and +critical(). To determine when to use logging, see the table below, which +states, for each of a set of common tasks, the best tool to use for it.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + +

    Task you want to perform

    The best tool for the task

    Display console output for ordinary +usage of a command line script or +program

    print()

    Report events that occur during +normal operation of a program (e.g. +for status monitoring or fault +investigation)

    logging.info() (or +logging.debug() for very +detailed output for diagnostic +purposes)

    Issue a warning regarding a +particular runtime event

    warnings.warn() in library +code if the issue is avoidable and +the client application should be +modified to eliminate the warning

    +

    logging.warning() if there is +nothing the client application can do +about the situation, but the event +should still be noted

    +

    Report an error regarding a +particular runtime event

    Raise an exception

    Report suppression of an error +without raising an exception (e.g. +error handler in a long-running +server process)

    logging.error(), +logging.exception() or +logging.critical() as +appropriate for the specific error +and application domain

    +

    The logging functions are named after the level or severity of the events +they are used to track. The standard levels and their applicability are +described below (in increasing order of severity):

    + ++++ + + + + + + + + + + + + + + + + + + + + + + +

    Level

    When it’s used

    DEBUG

    Detailed information, typically of interest +only when diagnosing problems.

    INFO

    Confirmation that things are working as +expected.

    WARNING

    An indication that something unexpected +happened, or indicative of some problem in +the near future (e.g. ‘disk space low’). +The software is still working as expected.

    ERROR

    Due to a more serious problem, the software +has not been able to perform some function.

    CRITICAL

    A serious error, indicating that the program +itself may be unable to continue running.

    +

    The default level is WARNING, which means that only events of this level +and above will be tracked, unless the logging package is configured to do +otherwise.

    +

    Events that are tracked can be handled in different ways. The simplest way of +handling tracked events is to print them to the console. Another common way +is to write them to a disk file.

    +
    +
    +

    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
    +
    +
    +

    If you type these lines into a script and run it, you’ll see:

    +
    WARNING:root:Watch out!
    +
    +
    +

    printed out on the console. The INFO message doesn’t appear because the +default level is WARNING. The printed message includes the indication of +the level and the description of the event provided in the logging call, i.e. +‘Watch out!’. Don’t worry about the ‘root’ part for now: it will be explained +later. The actual output can be formatted quite flexibly if you need that; +formatting options will also be explained later.

    +
    +
    +

    Logging to a file

    +

    A very common situation is that of recording logging events in a file, so let’s +look at that next. Be sure to try the following in a newly-started Python +interpreter, and don’t just continue from the session described above:

    +
    import logging
    +logging.basicConfig(filename='example.log',level=logging.DEBUG)
    +logging.debug('This message should go to the log file')
    +logging.info('So should this')
    +logging.warning('And this, too')
    +
    +
    +

    And now if we open the file and look at what we have, we should find the log +messages:

    +
    DEBUG:root:This message should go to the log file
    +INFO:root:So should this
    +WARNING:root:And this, too
    +
    +
    +

    This example also shows how you can set the logging level which acts as the +threshold for tracking. In this case, because we set the threshold to +DEBUG, all of the messages were printed.

    +

    If you want to set the logging level from a command-line option such as:

    +
    --log=INFO
    +
    +
    +

    and you have the value of the parameter passed for --log in some variable +loglevel, you can use:

    +
    getattr(logging, loglevel.upper())
    +
    +
    +

    to get the value which you’ll pass to basicConfig() via the level +argument. You may want to error check any user input value, perhaps as in the +following example:

    +
    # assuming loglevel is bound to the string value obtained from the
    +# command line argument. Convert to upper case to allow the user to
    +# specify --log=DEBUG or --log=debug
    +numeric_level = getattr(logging, loglevel.upper(), None)
    +if not isinstance(numeric_level, int):
    +    raise ValueError('Invalid log level: %s' % loglevel)
    +logging.basicConfig(level=numeric_level, ...)
    +
    +
    +

    The call to basicConfig() should come before any calls to debug(), +info() etc. As it’s intended as a one-off simple configuration facility, +only the first call will actually do anything: subsequent calls are effectively +no-ops.

    +

    If you run the above script several times, the messages from successive runs +are appended to the file example.log. If you want each run to start afresh, +not remembering the messages from earlier runs, you can specify the filemode +argument, by changing the call in the above example to:

    +
    logging.basicConfig(filename='example.log', filemode='w', level=logging.DEBUG)
    +
    +
    +

    The output will be the same as before, but the log file is no longer appended +to, so the messages from earlier runs are lost.

    +
    +
    +

    Logging from multiple modules

    +

    If your program consists of multiple modules, here’s an example of how you +could organize logging in it:

    +
    # myapp.py
    +import logging
    +import mylib
    +
    +def main():
    +    logging.basicConfig(filename='myapp.log', level=logging.INFO)
    +    logging.info('Started')
    +    mylib.do_something()
    +    logging.info('Finished')
    +
    +if __name__ == '__main__':
    +    main()
    +
    +
    +
    # mylib.py
    +import logging
    +
    +def do_something():
    +    logging.info('Doing something')
    +
    +
    +

    If you run myapp.py, you should see this in myapp.log:

    +
    INFO:root:Started
    +INFO:root:Doing something
    +INFO:root:Finished
    +
    +
    +

    which is hopefully what you were expecting to see. You can generalize this to +multiple modules, using the pattern in mylib.py. Note that for this simple +usage pattern, you won’t know, by looking in the log file, where in your +application your messages came from, apart from looking at the event +description. If you want to track the location of your messages, you’ll need +to refer to the documentation beyond the tutorial level – see +Advanced Logging Tutorial.

    +
    +
    +

    Logging variable data

    +

    To log variable data, use a format string for the event description message and +append the variable data as arguments. For example:

    +
    import logging
    +logging.warning('%s before you %s', 'Look', 'leap!')
    +
    +
    +

    will display:

    +
    WARNING:root:Look before you leap!
    +
    +
    +

    As you can see, merging of variable data into the event description message +uses the old, %-style of string formatting. This is for backwards +compatibility: the logging package pre-dates newer formatting options such as +str.format() and string.Template. These newer formatting +options are supported, but exploring them is outside the scope of this +tutorial: see Using particular formatting styles throughout your application for more information.

    +
    +
    +

    Changing the format of displayed messages

    +

    To change the format which is used to display messages, you need to +specify the format you want to use:

    +
    import logging
    +logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)
    +logging.debug('This message should appear on the console')
    +logging.info('So should this')
    +logging.warning('And this, too')
    +
    +
    +

    which would print:

    +
    DEBUG:This message should appear on the console
    +INFO:So should this
    +WARNING:And this, too
    +
    +
    +

    Notice that the ‘root’ which appeared in earlier examples has disappeared. For +a full set of things that can appear in format strings, you can refer to the +documentation for LogRecord attributes, but for simple usage, you just +need the levelname (severity), message (event description, including +variable data) and perhaps to display when the event occurred. This is +described in the next section.

    +
    +
    +

    Displaying the date/time in messages

    +

    To display the date and time of an event, you would place ‘%(asctime)s’ in +your format string:

    +
    import logging
    +logging.basicConfig(format='%(asctime)s %(message)s')
    +logging.warning('is when this event was logged.')
    +
    +
    +

    which should print something like this:

    +
    2010-12-12 11:41:42,612 is when this event was logged.
    +
    +
    +

    The default format for date/time display (shown above) is like ISO8601 or +RFC 3339. If you need more control over the formatting of the date/time, provide +a datefmt argument to basicConfig, as in this example:

    +
    import logging
    +logging.basicConfig(format='%(asctime)s %(message)s', datefmt='%m/%d/%Y %I:%M:%S %p')
    +logging.warning('is when this event was logged.')
    +
    +
    +

    which would display something like this:

    +
    12/12/2010 11:46:36 AM is when this event was logged.
    +
    +
    +

    The format of the datefmt argument is the same as supported by +time.strftime().

    +
    +
    +

    Next Steps

    +

    That concludes the basic tutorial. It should be enough to get you up and +running with logging. There’s a lot more that the logging package offers, but +to get the best out of it, you’ll need to invest a little more of your time in +reading the following sections. If you’re ready for that, grab some of your +favourite beverage and carry on.

    +

    If your logging needs are simple, then use the above examples to incorporate +logging into your own scripts, and if you run into problems or don’t +understand something, please post a question on the comp.lang.python Usenet +group (available at https://groups.google.com/forum/#!forum/comp.lang.python) and you +should receive help before too long.

    +

    Still here? You can carry on reading the next few sections, which provide a +slightly more advanced/in-depth tutorial than the basic one above. After that, +you can take a look at the Logging Cookbook.

    +
    +
    +
    +

    Advanced Logging Tutorial

    +

    The logging library takes a modular approach and offers several categories +of components: loggers, handlers, filters, and formatters.

    +
      +
    • Loggers expose the interface that application code directly uses.

    • +
    • Handlers send the log records (created by loggers) to the appropriate +destination.

    • +
    • Filters provide a finer grained facility for determining which log records +to output.

    • +
    • Formatters specify the layout of log records in the final output.

    • +
    +

    Log event information is passed between loggers, handlers, filters and +formatters in a LogRecord instance.

    +

    Logging is performed by calling methods on instances of the Logger +class (hereafter called loggers). Each instance has a name, and they are +conceptually arranged in a namespace hierarchy using dots (periods) as +separators. For example, a logger named ‘scan’ is the parent of loggers +‘scan.text’, ‘scan.html’ and ‘scan.pdf’. Logger names can be anything you want, +and indicate the area of an application in which a logged message originates.

    +

    A good convention to use when naming loggers is to use a module-level logger, +in each module which uses logging, named as follows:

    +
    logger = logging.getLogger(__name__)
    +
    +
    +

    This means that logger names track the package/module hierarchy, and it’s +intuitively obvious where events are logged just from the logger name.

    +

    The root of the hierarchy of loggers is called the root logger. That’s the +logger used by the functions debug(), info(), warning(), +error() and critical(), which just call the same-named method of +the root logger. The functions and the methods have the same signatures. The +root logger’s name is printed as ‘root’ in the logged output.

    +

    It is, of course, possible to log messages to different destinations. Support +is included in the package for writing log messages to files, HTTP GET/POST +locations, email via SMTP, generic sockets, queues, or OS-specific logging +mechanisms such as syslog or the Windows NT event log. Destinations are served +by handler classes. You can create your own log destination class if +you have special requirements not met by any of the built-in handler classes.

    +

    By default, no destination is set for any logging messages. You can specify +a destination (such as console or file) by using basicConfig() as in the +tutorial examples. If you call the functions debug(), info(), +warning(), error() and critical(), they will check to see +if no destination is set; and if one is not set, they will set a destination +of the console (sys.stderr) and a default format for the displayed +message before delegating to the root logger to do the actual message output.

    +

    The default format set by basicConfig() for messages is:

    +
    severity:logger name:message
    +
    +
    +

    You can change this by passing a format string to basicConfig() with the +format keyword argument. For all options regarding how a format string is +constructed, see Formatter Objects.

    +
    +

    Logging Flow

    +

    The flow of log event information in loggers and handlers is illustrated in the +following diagram.

    +../_images/logging_flow.png +
    +
    +

    Loggers

    +

    Logger objects have a threefold job. First, they expose several +methods to application code so that applications can log messages at runtime. +Second, logger objects determine which log messages to act upon based upon +severity (the default filtering facility) or filter objects. Third, logger +objects pass along relevant log messages to all interested log handlers.

    +

    The most widely used methods on logger objects fall into two categories: +configuration and message sending.

    +

    These are the most common configuration methods:

    +
      +
    • Logger.setLevel() specifies the lowest-severity log message a logger +will handle, where debug is the lowest built-in severity level and critical +is the highest built-in severity. For example, if the severity level is +INFO, the logger will handle only INFO, WARNING, ERROR, and CRITICAL messages +and will ignore DEBUG messages.

    • +
    • Logger.addHandler() and Logger.removeHandler() add and remove +handler objects from the logger object. Handlers are covered in more detail +in Handlers.

    • +
    • Logger.addFilter() and Logger.removeFilter() add and remove filter +objects from the logger object. Filters are covered in more detail in +Filter Objects.

    • +
    +

    You don’t need to always call these methods on every logger you create. See the +last two paragraphs in this section.

    +

    With the logger object configured, the following methods create log messages:

    +
      +
    • Logger.debug(), Logger.info(), Logger.warning(), +Logger.error(), and Logger.critical() all create log records with +a message and a level that corresponds to their respective method names. The +message is actually a format string, which may contain the standard string +substitution syntax of %s, %d, %f, and so on. The +rest of their arguments is a list of objects that correspond with the +substitution fields in the message. With regard to **kwargs, the +logging methods care only about a keyword of exc_info and use it to +determine whether to log exception information.

    • +
    • Logger.exception() creates a log message similar to +Logger.error(). The difference is that Logger.exception() dumps a +stack trace along with it. Call this method only from an exception handler.

    • +
    • Logger.log() takes a log level as an explicit argument. This is a +little more verbose for logging messages than using the log level convenience +methods listed above, but this is how to log at custom log levels.

    • +
    +

    getLogger() returns a reference to a logger instance with the specified +name if it is provided, or root if not. The names are period-separated +hierarchical structures. Multiple calls to getLogger() with the same name +will return a reference to the same logger object. Loggers that are further +down in the hierarchical list are children of loggers higher up in the list. +For example, given a logger with a name of foo, loggers with names of +foo.bar, foo.bar.baz, and foo.bam are all descendants of foo.

    +

    Loggers have a concept of effective level. If a level is not explicitly set +on a logger, the level of its parent is used instead as its effective level. +If the parent has no explicit level set, its parent is examined, and so on - +all ancestors are searched until an explicitly set level is found. The root +logger always has an explicit level set (WARNING by default). When deciding +whether to process an event, the effective level of the logger is used to +determine whether the event is passed to the logger’s handlers.

    +

    Child loggers propagate messages up to the handlers associated with their +ancestor loggers. Because of this, it is unnecessary to define and configure +handlers for all the loggers an application uses. It is sufficient to +configure handlers for a top-level logger and create child loggers as needed. +(You can, however, turn off propagation by setting the propagate +attribute of a logger to False.)

    +
    +
    +

    Handlers

    +

    Handler objects are responsible for dispatching the +appropriate log messages (based on the log messages’ severity) to the handler’s +specified destination. Logger objects can add zero or more handler +objects to themselves with an addHandler() method. As an example +scenario, an application may want to send all log messages to a log file, all +log messages of error or higher to stdout, and all messages of critical to an +email address. This scenario requires three individual handlers where each +handler is responsible for sending messages of a specific severity to a specific +location.

    +

    The standard library includes quite a few handler types (see +Useful Handlers); the tutorials use mainly StreamHandler and +FileHandler in its examples.

    +

    There are very few methods in a handler for application developers to concern +themselves with. The only handler methods that seem relevant for application +developers who are using the built-in handler objects (that is, not creating +custom handlers) are the following configuration methods:

    +
      +
    • The setLevel() method, just as in logger objects, specifies the +lowest severity that will be dispatched to the appropriate destination. Why +are there two setLevel() methods? The level set in the logger +determines which severity of messages it will pass to its handlers. The level +set in each handler determines which messages that handler will send on.

    • +
    • setFormatter() selects a Formatter object for this handler to +use.

    • +
    • addFilter() and removeFilter() respectively +configure and deconfigure filter objects on handlers.

    • +
    +

    Application code should not directly instantiate and use instances of +Handler. Instead, the Handler class is a base class that +defines the interface that all handlers should have and establishes some +default behavior that child classes can use (or override).

    +
    +
    +

    Formatters

    +

    Formatter objects configure the final order, structure, and contents of the log +message. Unlike the base logging.Handler class, application code may +instantiate formatter classes, although you could likely subclass the formatter +if your application needs special behavior. The constructor takes three +optional arguments – a message format string, a date format string and a style +indicator.

    +
    +
    +logging.Formatter.__init__(fmt=None, datefmt=None, style='%')
    +
    + +

    If there is no message format string, the default is to use the +raw message. If there is no date format string, the default date format is:

    +
    %Y-%m-%d %H:%M:%S
    +
    +
    +

    with the milliseconds tacked on at the end. The style is one of %, ‘{‘ +or ‘$’. If one of these is not specified, then ‘%’ will be used.

    +

    If the style is ‘%’, the message format string uses +%(<dictionary key>)s styled string substitution; the possible keys are +documented in LogRecord attributes. If the style is ‘{‘, the message +format string is assumed to be compatible with str.format() (using +keyword arguments), while if the style is ‘$’ then the message format string +should conform to what is expected by string.Template.substitute().

    +
    +

    Changed in version 3.2: Added the style parameter.

    +
    +

    The following message format string will log the time in a human-readable +format, the severity of the message, and the contents of the message, in that +order:

    +
    '%(asctime)s - %(levelname)s - %(message)s'
    +
    +
    +

    Formatters use a user-configurable function to convert the creation time of a +record to a tuple. By default, time.localtime() is used; to change this +for a particular formatter instance, set the converter attribute of the +instance to a function with the same signature as time.localtime() or +time.gmtime(). To change it for all formatters, for example if you want +all logging times to be shown in GMT, set the converter attribute in the +Formatter class (to time.gmtime for GMT display).

    +
    +
    +

    Configuring Logging

    +

    Programmers can configure logging in three ways:

    +
      +
    1. Creating loggers, handlers, and formatters explicitly using Python +code that calls the configuration methods listed above.

    2. +
    3. Creating a logging config file and reading it using the fileConfig() +function.

    4. +
    5. Creating a dictionary of configuration information and passing it +to the dictConfig() function.

    6. +
    +

    For the reference documentation on the last two options, see +Configuration functions. The following example configures a very simple +logger, a console handler, and a simple formatter using Python code:

    +
    import logging
    +
    +# create logger
    +logger = logging.getLogger('simple_example')
    +logger.setLevel(logging.DEBUG)
    +
    +# create console handler and set level to debug
    +ch = logging.StreamHandler()
    +ch.setLevel(logging.DEBUG)
    +
    +# create formatter
    +formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
    +
    +# add formatter to ch
    +ch.setFormatter(formatter)
    +
    +# add ch to logger
    +logger.addHandler(ch)
    +
    +# 'application' code
    +logger.debug('debug message')
    +logger.info('info message')
    +logger.warning('warn message')
    +logger.error('error message')
    +logger.critical('critical message')
    +
    +
    +

    Running this module from the command line produces the following output:

    +
    $ python simple_logging_module.py
    +2005-03-19 15:10:26,618 - simple_example - DEBUG - debug message
    +2005-03-19 15:10:26,620 - simple_example - INFO - info message
    +2005-03-19 15:10:26,695 - simple_example - WARNING - warn message
    +2005-03-19 15:10:26,697 - simple_example - ERROR - error message
    +2005-03-19 15:10:26,773 - simple_example - CRITICAL - critical message
    +
    +
    +

    The following Python module creates a logger, handler, and formatter nearly +identical to those in the example listed above, with the only difference being +the names of the objects:

    +
    import logging
    +import logging.config
    +
    +logging.config.fileConfig('logging.conf')
    +
    +# create logger
    +logger = logging.getLogger('simpleExample')
    +
    +# 'application' code
    +logger.debug('debug message')
    +logger.info('info message')
    +logger.warning('warn message')
    +logger.error('error message')
    +logger.critical('critical message')
    +
    +
    +

    Here is the logging.conf file:

    +
    [loggers]
    +keys=root,simpleExample
    +
    +[handlers]
    +keys=consoleHandler
    +
    +[formatters]
    +keys=simpleFormatter
    +
    +[logger_root]
    +level=DEBUG
    +handlers=consoleHandler
    +
    +[logger_simpleExample]
    +level=DEBUG
    +handlers=consoleHandler
    +qualname=simpleExample
    +propagate=0
    +
    +[handler_consoleHandler]
    +class=StreamHandler
    +level=DEBUG
    +formatter=simpleFormatter
    +args=(sys.stdout,)
    +
    +[formatter_simpleFormatter]
    +format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
    +datefmt=
    +
    +
    +

    The output is nearly identical to that of the non-config-file-based example:

    +
    $ python simple_logging_config.py
    +2005-03-19 15:38:55,977 - simpleExample - DEBUG - debug message
    +2005-03-19 15:38:55,979 - simpleExample - INFO - info message
    +2005-03-19 15:38:56,054 - simpleExample - WARNING - warn message
    +2005-03-19 15:38:56,055 - simpleExample - ERROR - error message
    +2005-03-19 15:38:56,130 - simpleExample - CRITICAL - critical message
    +
    +
    +

    You can see that the config file approach has a few advantages over the Python +code approach, mainly separation of configuration and code and the ability of +noncoders to easily modify the logging properties.

    +
    +

    Warning

    +

    The fileConfig() function takes a default parameter, +disable_existing_loggers, which defaults to True for reasons of +backward compatibility. This may or may not be what you want, since it +will cause any non-root loggers existing before the fileConfig() +call to be disabled unless they (or an ancestor) are explicitly named in +the configuration. Please refer to the reference documentation for more +information, and specify False for this parameter if you wish.

    +

    The dictionary passed to dictConfig() can also specify a Boolean +value with key disable_existing_loggers, which if not specified +explicitly in the dictionary also defaults to being interpreted as +True. This leads to the logger-disabling behaviour described above, +which may not be what you want - in which case, provide the key +explicitly with a value of False.

    +
    +

    Note that the class names referenced in config files need to be either relative +to the logging module, or absolute values which can be resolved using normal +import mechanisms. Thus, you could use either +WatchedFileHandler (relative to the logging module) or +mypackage.mymodule.MyHandler (for a class defined in package mypackage +and module mymodule, where mypackage is available on the Python import +path).

    +

    In Python 3.2, a new means of configuring logging has been introduced, using +dictionaries to hold configuration information. This provides a superset of the +functionality of the config-file-based approach outlined above, and is the +recommended configuration method for new applications and deployments. Because +a Python dictionary is used to hold configuration information, and since you +can populate that dictionary using different means, you have more options for +configuration. For example, you can use a configuration file in JSON format, +or, if you have access to YAML processing functionality, a file in YAML +format, to populate the configuration dictionary. Or, of course, you can +construct the dictionary in Python code, receive it in pickled form over a +socket, or use whatever approach makes sense for your application.

    +

    Here’s an example of the same configuration as above, in YAML format for +the new dictionary-based approach:

    +
    version: 1
    +formatters:
    +  simple:
    +    format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
    +handlers:
    +  console:
    +    class: logging.StreamHandler
    +    level: DEBUG
    +    formatter: simple
    +    stream: ext://sys.stdout
    +loggers:
    +  simpleExample:
    +    level: DEBUG
    +    handlers: [console]
    +    propagate: no
    +root:
    +  level: DEBUG
    +  handlers: [console]
    +
    +
    +

    For more information about logging using a dictionary, see +Configuration functions.

    +
    +
    +

    What happens if no configuration is provided

    +

    If no logging configuration is provided, it is possible to have a situation +where a logging event needs to be output, but no handlers can be found to +output the event. The behaviour of the logging package in these +circumstances is dependent on the Python version.

    +

    For versions of Python prior to 3.2, the behaviour is as follows:

    +
      +
    • If logging.raiseExceptions is False (production mode), the event is +silently dropped.

    • +
    • If logging.raiseExceptions is True (development mode), a message +‘No handlers could be found for logger X.Y.Z’ is printed once.

    • +
    +

    In Python 3.2 and later, the behaviour is as follows:

    +
      +
    • The event is output using a ‘handler of last resort’, stored in +logging.lastResort. This internal handler is not associated with any +logger, and acts like a StreamHandler which writes the +event description message to the current value of sys.stderr (therefore +respecting any redirections which may be in effect). No formatting is +done on the message - just the bare event description message is printed. +The handler’s level is set to WARNING, so all events at this and +greater severities will be output.

    • +
    +

    To obtain the pre-3.2 behaviour, logging.lastResort can be set to None.

    +
    +
    +

    Configuring Logging for a Library

    +

    When developing a library which uses logging, you should take care to +document how the library uses logging - for example, the names of loggers +used. Some consideration also needs to be given to its logging configuration. +If the using application does not use logging, and library code makes logging +calls, then (as described in the previous section) events of severity +WARNING and greater will be printed to sys.stderr. This is regarded as +the best default behaviour.

    +

    If for some reason you don’t want these messages printed in the absence of +any logging configuration, you can attach a do-nothing handler to the top-level +logger for your library. This avoids the message being printed, since a handler +will always be found for the library’s events: it just doesn’t produce any +output. If the library user configures logging for application use, presumably +that configuration will add some handlers, and if levels are suitably +configured then logging calls made in library code will send output to those +handlers, as normal.

    +

    A do-nothing handler is included in the logging package: +NullHandler (since Python 3.1). An instance of this handler +could be added to the top-level logger of the logging namespace used by the +library (if you want to prevent your library’s logged events being output to +sys.stderr in the absence of logging configuration). If all logging by a +library foo is done using loggers with names matching ‘foo.x’, ‘foo.x.y’, +etc. then the code:

    +
    import logging
    +logging.getLogger('foo').addHandler(logging.NullHandler())
    +
    +
    +

    should have the desired effect. If an organisation produces a number of +libraries, then the logger name specified can be ‘orgname.foo’ rather than +just ‘foo’.

    +
    +

    Note

    +

    It is strongly advised that you do not add any handlers other +than NullHandler to your library’s loggers. This is +because the configuration of handlers is the prerogative of the application +developer who uses your library. The application developer knows their +target audience and what handlers are most appropriate for their +application: if you add handlers ‘under the hood’, you might well interfere +with their ability to carry out unit tests and deliver logs which suit their +requirements.

    +
    +
    +
    +
    +

    Logging Levels

    +

    The numeric values of logging levels are given in the following table. These are +primarily of interest if you want to define your own levels, and need them to +have specific values relative to the predefined levels. If you define a level +with the same numeric value, it overwrites the predefined value; the predefined +name is lost.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + +

    Level

    Numeric value

    CRITICAL

    50

    ERROR

    40

    WARNING

    30

    INFO

    20

    DEBUG

    10

    NOTSET

    0

    +

    Levels can also be associated with loggers, being set either by the developer or +through loading a saved logging configuration. When a logging method is called +on a logger, the logger compares its own level with the level associated with +the method call. If the logger’s level is higher than the method call’s, no +logging message is actually generated. This is the basic mechanism controlling +the verbosity of logging output.

    +

    Logging messages are encoded as instances of the LogRecord +class. When a logger decides to actually log an event, a +LogRecord instance is created from the logging message.

    +

    Logging messages are subjected to a dispatch mechanism through the use of +handlers, which are instances of subclasses of the Handler +class. Handlers are responsible for ensuring that a logged message (in the form +of a LogRecord) ends up in a particular location (or set of locations) +which is useful for the target audience for that message (such as end users, +support desk staff, system administrators, developers). Handlers are passed +LogRecord instances intended for particular destinations. Each logger +can have zero, one or more handlers associated with it (via the +addHandler() method of Logger). In addition to any +handlers directly associated with a logger, all handlers associated with all +ancestors of the logger are called to dispatch the message (unless the +propagate flag for a logger is set to a false value, at which point the +passing to ancestor handlers stops).

    +

    Just as for loggers, handlers can have levels associated with them. A handler’s +level acts as a filter in the same way as a logger’s level does. If a handler +decides to actually dispatch an event, the emit() method is used +to send the message to its destination. Most user-defined subclasses of +Handler will need to override this emit().

    +
    +

    Custom Levels

    +

    Defining your own levels is possible, but should not be necessary, as the +existing levels have been chosen on the basis of practical experience. +However, if you are convinced that you need custom levels, great care should +be exercised when doing this, and it is possibly a very bad idea to define +custom levels if you are developing a library. That’s because if multiple +library authors all define their own custom levels, there is a chance that +the logging output from such multiple libraries used together will be +difficult for the using developer to control and/or interpret, because a +given numeric value might mean different things for different libraries.

    +
    +
    +
    +

    Useful Handlers

    +

    In addition to the base Handler class, many useful subclasses are +provided:

    +
      +
    1. StreamHandler instances send messages to streams (file-like +objects).

    2. +
    3. FileHandler instances send messages to disk files.

    4. +
    5. BaseRotatingHandler is the base class for handlers that +rotate log files at a certain point. It is not meant to be instantiated +directly. Instead, use RotatingFileHandler or +TimedRotatingFileHandler.

    6. +
    7. RotatingFileHandler instances send messages to disk +files, with support for maximum log file sizes and log file rotation.

    8. +
    9. TimedRotatingFileHandler instances send messages to +disk files, rotating the log file at certain timed intervals.

    10. +
    11. SocketHandler instances send messages to TCP/IP +sockets. Since 3.4, Unix domain sockets are also supported.

    12. +
    13. DatagramHandler instances send messages to UDP +sockets. Since 3.4, Unix domain sockets are also supported.

    14. +
    15. SMTPHandler instances send messages to a designated +email address.

    16. +
    17. SysLogHandler instances send messages to a Unix +syslog daemon, possibly on a remote machine.

    18. +
    19. NTEventLogHandler instances send messages to a +Windows NT/2000/XP event log.

    20. +
    21. MemoryHandler instances send messages to a buffer +in memory, which is flushed whenever specific criteria are met.

    22. +
    23. HTTPHandler instances send messages to an HTTP +server using either GET or POST semantics.

    24. +
    25. WatchedFileHandler instances watch the file they are +logging to. If the file changes, it is closed and reopened using the file +name. This handler is only useful on Unix-like systems; Windows does not +support the underlying mechanism used.

    26. +
    27. QueueHandler instances send messages to a queue, such as +those implemented in the queue or multiprocessing modules.

    28. +
    29. NullHandler instances do nothing with error messages. They are used +by library developers who want to use logging, but want to avoid the ‘No +handlers could be found for logger XXX’ message which can be displayed if +the library user has not configured logging. See Configuring Logging for a Library for +more information.

    30. +
    +
    +

    New in version 3.1: The NullHandler class.

    +
    +
    +

    New in version 3.2: The QueueHandler class.

    +
    +

    The NullHandler, StreamHandler and FileHandler +classes are defined in the core logging package. The other handlers are +defined in a sub-module, logging.handlers. (There is also another +sub-module, logging.config, for configuration functionality.)

    +

    Logged messages are formatted for presentation through instances of the +Formatter class. They are initialized with a format string suitable for +use with the % operator and a dictionary.

    +

    For formatting multiple messages in a batch, instances of +BufferingFormatter can be used. In addition to the format +string (which is applied to each message in the batch), there is provision for +header and trailer format strings.

    +

    When filtering based on logger level and/or handler level is not enough, +instances of Filter can be added to both Logger and +Handler instances (through their addFilter() method). +Before deciding to process a message further, both loggers and handlers consult +all their filters for permission. If any filter returns a false value, the +message is not processed further.

    +

    The basic Filter functionality allows filtering by specific logger +name. If this feature is used, messages sent to the named logger and its +children are allowed through the filter, and all others dropped.

    +
    +
    +

    Exceptions raised during logging

    +

    The logging package is designed to swallow exceptions which occur while logging +in production. This is so that errors which occur while handling logging events +- such as logging misconfiguration, network or other similar errors - do not +cause the application using logging to terminate prematurely.

    +

    SystemExit and KeyboardInterrupt exceptions are never +swallowed. Other exceptions which occur during the emit() method +of a Handler subclass are passed to its handleError() +method.

    +

    The default implementation of handleError() in Handler +checks to see if a module-level variable, raiseExceptions, is set. If +set, a traceback is printed to sys.stderr. If not set, the exception is +swallowed.

    +
    +

    Note

    +

    The default value of raiseExceptions is True. This is +because during development, you typically want to be notified of any +exceptions that occur. It’s advised that you set raiseExceptions to +False for production usage.

    +
    +
    +
    +

    Using arbitrary objects as messages

    +

    In the preceding sections and examples, it has been assumed that the message +passed when logging the event is a string. However, this is not the only +possibility. You can pass an arbitrary object as a message, and its +__str__() method will be called when the logging system needs to +convert it to a string representation. In fact, if you want to, you can avoid +computing a string representation altogether - for example, the +SocketHandler emits an event by pickling it and sending it +over the wire.

    +
    +
    +

    Optimization

    +

    Formatting of message arguments is deferred until it cannot be avoided. +However, computing the arguments passed to the logging method can also be +expensive, and you may want to avoid doing it if the logger will just throw +away your event. To decide what to do, you can call the +isEnabledFor() method which takes a level argument and returns +true if the event would be created by the Logger for that level of call. +You can write code like this:

    +
    if logger.isEnabledFor(logging.DEBUG):
    +    logger.debug('Message with %s, %s', expensive_func1(),
    +                                        expensive_func2())
    +
    +
    +

    so that if the logger’s threshold is set above DEBUG, the calls to +expensive_func1() and expensive_func2() are never made.

    +
    +

    Note

    +

    In some cases, isEnabledFor() can itself be more +expensive than you’d like (e.g. for deeply nested loggers where an explicit +level is only set high up in the logger hierarchy). In such cases (or if you +want to avoid calling a method in tight loops), you can cache the result of a +call to isEnabledFor() in a local or instance variable, and use +that instead of calling the method each time. Such a cached value would only +need to be recomputed when the logging configuration changes dynamically +while the application is running (which is not all that common).

    +
    +

    There are other optimizations which can be made for specific applications which +need more precise control over what logging information is collected. Here’s a +list of things you can do to avoid processing during logging which you don’t +need:

    + ++++ + + + + + + + + + + + + + + + + +

    What you don’t want to collect

    How to avoid collecting it

    Information about where calls were made from.

    Set logging._srcfile to None. +This avoids calling +sys._getframe(), which may help +to speed up your code in environments +like PyPy (which can’t speed up code +that uses sys._getframe()), if +and when PyPy supports Python 3.x.

    Threading information.

    Set logging.logThreads to 0.

    Process information.

    Set logging.logProcesses to 0.

    +

    Also note that the core logging module only includes the basic handlers. If +you don’t import logging.handlers and logging.config, they won’t +take up any memory.

    +
    +

    See also

    +
    +
    Module logging

    API reference for the logging module.

    +
    +
    Module logging.config

    Configuration API for the logging module.

    +
    +
    Module logging.handlers

    Useful handlers included with the logging module.

    +
    +
    +

    A logging cookbook

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/howto/pyporting.html b/python-3.7.4-docs-html/howto/pyporting.html new file mode 100644 index 0000000..2e5dfa6 --- /dev/null +++ b/python-3.7.4-docs-html/howto/pyporting.html @@ -0,0 +1,594 @@ + + + + + + + Porting Python 2 Code to Python 3 — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Porting Python 2 Code to Python 3

    +
    +
    author
    +

    Brett Cannon

    +
    +
    +
    +

    Abstract

    +

    With Python 3 being the future of Python while Python 2 is still in active +use, it is good to have your project available for both major releases of +Python. This guide is meant to help you figure out how best to support both +Python 2 & 3 simultaneously.

    +

    If you are looking to port an extension module instead of pure Python code, +please see Porting Extension Modules to Python 3.

    +

    If you would like to read one core Python developer’s take on why Python 3 +came into existence, you can read Nick Coghlan’s Python 3 Q & A or +Brett Cannon’s Why Python 3 exists.

    +

    For help with porting, you can email the python-porting mailing list with +questions.

    +
    +
    +

    The Short Explanation

    +

    To make your project be single-source Python 2/3 compatible, the basic steps +are:

    +
      +
    1. Only worry about supporting Python 2.7

    2. +
    3. Make sure you have good test coverage (coverage.py can help; +pip install coverage)

    4. +
    5. Learn the differences between Python 2 & 3

    6. +
    7. Use Futurize (or Modernize) to update your code (e.g. pip install future)

    8. +
    9. Use Pylint to help make sure you don’t regress on your Python 3 support +(pip install pylint)

    10. +
    11. Use caniusepython3 to find out which of your dependencies are blocking your +use of Python 3 (pip install caniusepython3)

    12. +
    13. Once your dependencies are no longer blocking you, use continuous integration +to make sure you stay compatible with Python 2 & 3 (tox can help test +against multiple versions of Python; pip install tox)

    14. +
    15. Consider using optional static type checking to make sure your type usage +works in both Python 2 & 3 (e.g. use mypy to check your typing under both +Python 2 & Python 3).

    16. +
    +
    +
    +

    Details

    +

    A key point about supporting Python 2 & 3 simultaneously is that you can start +today! Even if your dependencies are not supporting Python 3 yet that does +not mean you can’t modernize your code now to support Python 3. Most changes +required to support Python 3 lead to cleaner code using newer practices even in +Python 2 code.

    +

    Another key point is that modernizing your Python 2 code to also support +Python 3 is largely automated for you. While you might have to make some API +decisions thanks to Python 3 clarifying text data versus binary data, the +lower-level work is now mostly done for you and thus can at least benefit from +the automated changes immediately.

    +

    Keep those key points in mind while you read on about the details of porting +your code to support Python 2 & 3 simultaneously.

    +
    +

    Drop support for Python 2.6 and older

    +

    While you can make Python 2.5 work with Python 3, it is much easier if you +only have to work with Python 2.7. If dropping Python 2.5 is not an +option then the six project can help you support Python 2.5 & 3 simultaneously +(pip install six). Do realize, though, that nearly all the projects listed +in this HOWTO will not be available to you.

    +

    If you are able to skip Python 2.5 and older, then the required changes +to your code should continue to look and feel like idiomatic Python code. At +worst you will have to use a function instead of a method in some instances or +have to import a function instead of using a built-in one, but otherwise the +overall transformation should not feel foreign to you.

    +

    But you should aim for only supporting Python 2.7. Python 2.6 is no longer +freely supported and thus is not receiving bugfixes. This means you will have +to work around any issues you come across with Python 2.6. There are also some +tools mentioned in this HOWTO which do not support Python 2.6 (e.g., Pylint), +and this will become more commonplace as time goes on. It will simply be easier +for you if you only support the versions of Python that you have to support.

    +
    +
    +

    Make sure you specify the proper version support in your setup.py file

    +

    In your setup.py file you should have the proper trove classifier +specifying what versions of Python you support. As your project does not support +Python 3 yet you should at least have +Programming Language :: Python :: 2 :: Only specified. Ideally you should +also specify each major/minor version of Python that you do support, e.g. +Programming Language :: Python :: 2.7.

    +
    +
    +

    Have good test coverage

    +

    Once you have your code supporting the oldest version of Python 2 you want it +to, you will want to make sure your test suite has good coverage. A good rule of +thumb is that if you want to be confident enough in your test suite that any +failures that appear after having tools rewrite your code are actual bugs in the +tools and not in your code. If you want a number to aim for, try to get over 80% +coverage (and don’t feel bad if you find it hard to get better than 90% +coverage). If you don’t already have a tool to measure test coverage then +coverage.py is recommended.

    +
    +
    +

    Learn the differences between Python 2 & 3

    +

    Once you have your code well-tested you are ready to begin porting your code to +Python 3! But to fully understand how your code is going to change and what +you want to look out for while you code, you will want to learn what changes +Python 3 makes in terms of Python 2. Typically the two best ways of doing that +is reading the “What’s New” doc for each release of Python 3 and the +Porting to Python 3 book (which is free online). There is also a handy +cheat sheet from the Python-Future project.

    +
    +
    +

    Update your code

    +

    Once you feel like you know what is different in Python 3 compared to Python 2, +it’s time to update your code! You have a choice between two tools in porting +your code automatically: Futurize and Modernize. Which tool you choose will +depend on how much like Python 3 you want your code to be. Futurize does its +best to make Python 3 idioms and practices exist in Python 2, e.g. backporting +the bytes type from Python 3 so that you have semantic parity between the +major versions of Python. Modernize, +on the other hand, is more conservative and targets a Python 2/3 subset of +Python, directly relying on six to help provide compatibility. As Python 3 is +the future, it might be best to consider Futurize to begin adjusting to any new +practices that Python 3 introduces which you are not accustomed to yet.

    +

    Regardless of which tool you choose, they will update your code to run under +Python 3 while staying compatible with the version of Python 2 you started with. +Depending on how conservative you want to be, you may want to run the tool over +your test suite first and visually inspect the diff to make sure the +transformation is accurate. After you have transformed your test suite and +verified that all the tests still pass as expected, then you can transform your +application code knowing that any tests which fail is a translation failure.

    +

    Unfortunately the tools can’t automate everything to make your code work under +Python 3 and so there are a handful of things you will need to update manually +to get full Python 3 support (which of these steps are necessary vary between +the tools). Read the documentation for the tool you choose to use to see what it +fixes by default and what it can do optionally to know what will (not) be fixed +for you and what you may have to fix on your own (e.g. using io.open() over +the built-in open() function is off by default in Modernize). Luckily, +though, there are only a couple of things to watch out for which can be +considered large issues that may be hard to debug if not watched for.

    +
    +

    Division

    +

    In Python 3, 5 / 2 == 2.5 and not 2; all division between int values +result in a float. This change has actually been planned since Python 2.2 +which was released in 2002. Since then users have been encouraged to add +from __future__ import division to any and all files which use the / and +// operators or to be running the interpreter with the -Q flag. If you +have not been doing this then you will need to go through your code and do two +things:

    +
      +
    1. Add from __future__ import division to your files

    2. +
    3. Update any division operator as necessary to either use // to use floor +division or continue using / and expect a float

    4. +
    +

    The reason that / isn’t simply translated to // automatically is that if +an object defines a __truediv__ method but not __floordiv__ then your +code would begin to fail (e.g. a user-defined class that uses / to +signify some operation but not // for the same thing or at all).

    +
    +
    +

    Text versus binary data

    +

    In Python 2 you could use the str type for both text and binary data. +Unfortunately this confluence of two different concepts could lead to brittle +code which sometimes worked for either kind of data, sometimes not. It also +could lead to confusing APIs if people didn’t explicitly state that something +that accepted str accepted either text or binary data instead of one +specific type. This complicated the situation especially for anyone supporting +multiple languages as APIs wouldn’t bother explicitly supporting unicode +when they claimed text data support.

    +

    To make the distinction between text and binary data clearer and more +pronounced, Python 3 did what most languages created in the age of the internet +have done and made text and binary data distinct types that cannot blindly be +mixed together (Python predates widespread access to the internet). For any code +that deals only with text or only binary data, this separation doesn’t pose an +issue. But for code that has to deal with both, it does mean you might have to +now care about when you are using text compared to binary data, which is why +this cannot be entirely automated.

    +

    To start, you will need to decide which APIs take text and which take binary +(it is highly recommended you don’t design APIs that can take both due to +the difficulty of keeping the code working; as stated earlier it is difficult to +do well). In Python 2 this means making sure the APIs that take text can work +with unicode and those that work with binary data work with the +bytes type from Python 3 (which is a subset of str in Python 2 and acts +as an alias for bytes type in Python 2). Usually the biggest issue is +realizing which methods exist on which types in Python 2 & 3 simultaneously +(for text that’s unicode in Python 2 and str in Python 3, for binary +that’s str/bytes in Python 2 and bytes in Python 3). The following +table lists the unique methods of each data type across Python 2 & 3 +(e.g., the decode() method is usable on the equivalent binary data type in +either Python 2 or 3, but it can’t be used by the textual data type consistently +between Python 2 and 3 because str in Python 3 doesn’t have the method). Do +note that as of Python 3.5 the __mod__ method was added to the bytes type.

    + ++++ + + + + + + + + + + + + + + + + + + + + +

    Text data

    Binary data

    decode

    encode

    format

    isdecimal

    isnumeric

    +

    Making the distinction easier to handle can be accomplished by encoding and +decoding between binary data and text at the edge of your code. This means that +when you receive text in binary data, you should immediately decode it. And if +your code needs to send text as binary data then encode it as late as possible. +This allows your code to work with only text internally and thus eliminates +having to keep track of what type of data you are working with.

    +

    The next issue is making sure you know whether the string literals in your code +represent text or binary data. You should add a b prefix to any +literal that presents binary data. For text you should add a u prefix to +the text literal. (there is a __future__ import to force all unspecified +literals to be Unicode, but usage has shown it isn’t as effective as adding a +b or u prefix to all literals explicitly)

    +

    As part of this dichotomy you also need to be careful about opening files. +Unless you have been working on Windows, there is a chance you have not always +bothered to add the b mode when opening a binary file (e.g., rb for +binary reading). Under Python 3, binary files and text files are clearly +distinct and mutually incompatible; see the io module for details. +Therefore, you must make a decision of whether a file will be used for +binary access (allowing binary data to be read and/or written) or textual access +(allowing text data to be read and/or written). You should also use io.open() +for opening files instead of the built-in open() function as the io +module is consistent from Python 2 to 3 while the built-in open() function +is not (in Python 3 it’s actually io.open()). Do not bother with the +outdated practice of using codecs.open() as that’s only necessary for +keeping compatibility with Python 2.5.

    +

    The constructors of both str and bytes have different semantics for the +same arguments between Python 2 & 3. Passing an integer to bytes in Python 2 +will give you the string representation of the integer: bytes(3) == '3'. +But in Python 3, an integer argument to bytes will give you a bytes object +as long as the integer specified, filled with null bytes: +bytes(3) == b'\x00\x00\x00'. A similar worry is necessary when passing a +bytes object to str. In Python 2 you just get the bytes object back: +str(b'3') == b'3'. But in Python 3 you get the string representation of the +bytes object: str(b'3') == "b'3'".

    +

    Finally, the indexing of binary data requires careful handling (slicing does +not require any special handling). In Python 2, +b'123'[1] == b'2' while in Python 3 b'123'[1] == 50. Because binary data +is simply a collection of binary numbers, Python 3 returns the integer value for +the byte you index on. But in Python 2 because bytes == str, indexing +returns a one-item slice of bytes. The six project has a function +named six.indexbytes() which will return an integer like in Python 3: +six.indexbytes(b'123', 1).

    +

    To summarize:

    +
      +
    1. Decide which of your APIs take text and which take binary data

    2. +
    3. Make sure that your code that works with text also works with unicode and +code for binary data works with bytes in Python 2 (see the table above +for what methods you cannot use for each type)

    4. +
    5. Mark all binary literals with a b prefix, textual literals with a u +prefix

    6. +
    7. Decode binary data to text as soon as possible, encode text as binary data as +late as possible

    8. +
    9. Open files using io.open() and make sure to specify the b mode when +appropriate

    10. +
    11. Be careful when indexing into binary data

    12. +
    +
    +
    +

    Use feature detection instead of version detection

    +

    Inevitably you will have code that has to choose what to do based on what +version of Python is running. The best way to do this is with feature detection +of whether the version of Python you’re running under supports what you need. +If for some reason that doesn’t work then you should make the version check be +against Python 2 and not Python 3. To help explain this, let’s look at an +example.

    +

    Let’s pretend that you need access to a feature of importlib that +is available in Python’s standard library since Python 3.3 and available for +Python 2 through importlib2 on PyPI. You might be tempted to write code to +access e.g. the importlib.abc module by doing the following:

    +
    import sys
    +
    +if sys.version_info[0] == 3:
    +    from importlib import abc
    +else:
    +    from importlib2 import abc
    +
    +
    +

    The problem with this code is what happens when Python 4 comes out? It would +be better to treat Python 2 as the exceptional case instead of Python 3 and +assume that future Python versions will be more compatible with Python 3 than +Python 2:

    +
    import sys
    +
    +if sys.version_info[0] > 2:
    +    from importlib import abc
    +else:
    +    from importlib2 import abc
    +
    +
    +

    The best solution, though, is to do no version detection at all and instead rely +on feature detection. That avoids any potential issues of getting the version +detection wrong and helps keep you future-compatible:

    +
    try:
    +    from importlib import abc
    +except ImportError:
    +    from importlib2 import abc
    +
    +
    +
    +
    +
    +

    Prevent compatibility regressions

    +

    Once you have fully translated your code to be compatible with Python 3, you +will want to make sure your code doesn’t regress and stop working under +Python 3. This is especially true if you have a dependency which is blocking you +from actually running under Python 3 at the moment.

    +

    To help with staying compatible, any new modules you create should have +at least the following block of code at the top of it:

    +
    from __future__ import absolute_import
    +from __future__ import division
    +from __future__ import print_function
    +
    +
    +

    You can also run Python 2 with the -3 flag to be warned about various +compatibility issues your code triggers during execution. If you turn warnings +into errors with -Werror then you can make sure that you don’t accidentally +miss a warning.

    +

    You can also use the Pylint project and its --py3k flag to lint your code +to receive warnings when your code begins to deviate from Python 3 +compatibility. This also prevents you from having to run Modernize or Futurize +over your code regularly to catch compatibility regressions. This does require +you only support Python 2.7 and Python 3.4 or newer as that is Pylint’s +minimum Python version support.

    +
    +
    +

    Check which dependencies block your transition

    +

    After you have made your code compatible with Python 3 you should begin to +care about whether your dependencies have also been ported. The caniusepython3 +project was created to help you determine which projects +– directly or indirectly – are blocking you from supporting Python 3. There +is both a command-line tool as well as a web interface at +https://caniusepython3.com.

    +

    The project also provides code which you can integrate into your test suite so +that you will have a failing test when you no longer have dependencies blocking +you from using Python 3. This allows you to avoid having to manually check your +dependencies and to be notified quickly when you can start running on Python 3.

    +
    +
    +

    Update your setup.py file to denote Python 3 compatibility

    +

    Once your code works under Python 3, you should update the classifiers in +your setup.py to contain Programming Language :: Python :: 3 and to not +specify sole Python 2 support. This will tell anyone using your code that you +support Python 2 and 3. Ideally you will also want to add classifiers for +each major/minor version of Python you now support.

    +
    +
    +

    Use continuous integration to stay compatible

    +

    Once you are able to fully run under Python 3 you will want to make sure your +code always works under both Python 2 & 3. Probably the best tool for running +your tests under multiple Python interpreters is tox. You can then integrate +tox with your continuous integration system so that you never accidentally break +Python 2 or 3 support.

    +

    You may also want to use the -bb flag with the Python 3 interpreter to +trigger an exception when you are comparing bytes to strings or bytes to an int +(the latter is available starting in Python 3.5). By default type-differing +comparisons simply return False, but if you made a mistake in your +separation of text/binary data handling or indexing on bytes you wouldn’t easily +find the mistake. This flag will raise an exception when these kinds of +comparisons occur, making the mistake much easier to track down.

    +

    And that’s mostly it! At this point your code base is compatible with both +Python 2 and 3 simultaneously. Your testing will also be set up so that you +don’t accidentally break Python 2 or 3 compatibility regardless of which version +you typically run your tests under while developing.

    +
    +
    +

    Consider using optional static type checking

    +

    Another way to help port your code is to use a static type checker like +mypy or pytype on your code. These tools can be used to analyze your code as +if it’s being run under Python 2, then you can run the tool a second time as if +your code is running under Python 3. By running a static type checker twice like +this you can discover if you’re e.g. misusing binary data type in one version +of Python compared to another. If you add optional type hints to your code you +can also explicitly state whether your APIs use textual or binary data, helping +to make sure everything functions as expected in both versions of Python.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/howto/regex.html b/python-3.7.4-docs-html/howto/regex.html new file mode 100644 index 0000000..817cd39 --- /dev/null +++ b/python-3.7.4-docs-html/howto/regex.html @@ -0,0 +1,1564 @@ + + + + + + + Regular Expression HOWTO — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Regular Expression HOWTO

    +
    +
    Author
    +

    A.M. Kuchling <amk@amk.ca>

    +
    +
    +
    +

    Abstract

    +

    This document is an introductory tutorial to using regular expressions in Python +with the re module. It provides a gentler introduction than the +corresponding section in the Library Reference.

    +
    +
    +

    Introduction

    +

    Regular expressions (called REs, or regexes, or regex patterns) are essentially +a tiny, highly specialized programming language embedded inside Python and made +available through the re module. Using this little language, you specify +the rules for the set of possible strings that you want to match; this set might +contain English sentences, or e-mail addresses, or TeX commands, or anything you +like. You can then ask questions such as “Does this string match the pattern?”, +or “Is there a match for the pattern anywhere in this string?”. You can also +use REs to modify a string or to split it apart in various ways.

    +

    Regular expression patterns are compiled into a series of bytecodes which are +then executed by a matching engine written in C. For advanced use, it may be +necessary to pay careful attention to how the engine will execute a given RE, +and write the RE in a certain way in order to produce bytecode that runs faster. +Optimization isn’t covered in this document, because it requires that you have a +good understanding of the matching engine’s internals.

    +

    The regular expression language is relatively small and restricted, so not all +possible string processing tasks can be done using regular expressions. There +are also tasks that can be done with regular expressions, but the expressions +turn out to be very complicated. In these cases, you may be better off writing +Python code to do the processing; while Python code will be slower than an +elaborate regular expression, it will also probably be more understandable.

    +
    +
    +

    Simple Patterns

    +

    We’ll start by learning about the simplest possible regular expressions. Since +regular expressions are used to operate on strings, we’ll begin with the most +common task: matching characters.

    +

    For a detailed explanation of the computer science underlying regular +expressions (deterministic and non-deterministic finite automata), you can refer +to almost any textbook on writing compilers.

    +
    +

    Matching Characters

    +

    Most letters and characters will simply match themselves. For example, the +regular expression test will match the string test exactly. (You can +enable a case-insensitive mode that would let this RE match Test or TEST +as well; more about this later.)

    +

    There are exceptions to this rule; some characters are special +metacharacters, and don’t match themselves. Instead, they signal that +some out-of-the-ordinary thing should be matched, or they affect other portions +of the RE by repeating them or changing their meaning. Much of this document is +devoted to discussing various metacharacters and what they do.

    +

    Here’s a complete list of the metacharacters; their meanings will be discussed +in the rest of this HOWTO.

    +
    . ^ $ * + ? { } [ ] \ | ( )
    +
    +
    +

    The first metacharacters we’ll look at are [ and ]. They’re used for +specifying a character class, which is a set of characters that you wish to +match. Characters can be listed individually, or a range of characters can be +indicated by giving two characters and separating them by a '-'. For +example, [abc] will match any of the characters a, b, or c; this +is the same as [a-c], which uses a range to express the same set of +characters. If you wanted to match only lowercase letters, your RE would be +[a-z].

    +

    Metacharacters are not active inside classes. For example, [akm$] will +match any of the characters 'a', 'k', 'm', or '$'; '$' is +usually a metacharacter, but inside a character class it’s stripped of its +special nature.

    +

    You can match the characters not listed within the class by complementing +the set. This is indicated by including a '^' as the first character of the +class. For example, [^5] will match any character except '5'. If the +caret appears elsewhere in a character class, it does not have special meaning. +For example: [5^] will match either a '5' or a '^'.

    +

    Perhaps the most important metacharacter is the backslash, \. As in Python +string literals, the backslash can be followed by various characters to signal +various special sequences. It’s also used to escape all the metacharacters so +you can still match them in patterns; for example, if you need to match a [ +or \, you can precede them with a backslash to remove their special +meaning: \[ or \\.

    +

    Some of the special sequences beginning with '\' represent +predefined sets of characters that are often useful, such as the set +of digits, the set of letters, or the set of anything that isn’t +whitespace.

    +

    Let’s take an example: \w matches any alphanumeric character. If +the regex pattern is expressed in bytes, this is equivalent to the +class [a-zA-Z0-9_]. If the regex pattern is a string, \w will +match all the characters marked as letters in the Unicode database +provided by the unicodedata module. You can use the more +restricted definition of \w in a string pattern by supplying the +re.ASCII flag when compiling the regular expression.

    +

    The following list of special sequences isn’t complete. For a complete +list of sequences and expanded class definitions for Unicode string +patterns, see the last part of Regular Expression Syntax in the Standard Library reference. In general, the +Unicode versions match any character that’s in the appropriate +category in the Unicode database.

    +
    +
    \d

    Matches any decimal digit; this is equivalent to the class [0-9].

    +
    +
    \D

    Matches any non-digit character; this is equivalent to the class [^0-9].

    +
    +
    \s

    Matches any whitespace character; this is equivalent to the class [ +\t\n\r\f\v].

    +
    +
    \S

    Matches any non-whitespace character; this is equivalent to the class [^ +\t\n\r\f\v].

    +
    +
    \w

    Matches any alphanumeric character; this is equivalent to the class +[a-zA-Z0-9_].

    +
    +
    \W

    Matches any non-alphanumeric character; this is equivalent to the class +[^a-zA-Z0-9_].

    +
    +
    +

    These sequences can be included inside a character class. For example, +[\s,.] is a character class that will match any whitespace character, or +',' or '.'.

    +

    The final metacharacter in this section is .. It matches anything except a +newline character, and there’s an alternate mode (re.DOTALL) where it will +match even a newline. . is often used where you want to match “any +character”.

    +
    +
    +

    Repeating Things

    +

    Being able to match varying sets of characters is the first thing regular +expressions can do that isn’t already possible with the methods available on +strings. However, if that was the only additional capability of regexes, they +wouldn’t be much of an advance. Another capability is that you can specify that +portions of the RE must be repeated a certain number of times.

    +

    The first metacharacter for repeating things that we’ll look at is *. * +doesn’t match the literal character '*'; instead, it specifies that the +previous character can be matched zero or more times, instead of exactly once.

    +

    For example, ca*t will match 'ct' (0 'a' characters), 'cat' (1 'a'), +'caaat' (3 'a' characters), and so forth.

    +

    Repetitions such as * are greedy; when repeating a RE, the matching +engine will try to repeat it as many times as possible. If later portions of the +pattern don’t match, the matching engine will then back up and try again with +fewer repetitions.

    +

    A step-by-step example will make this more obvious. Let’s consider the +expression a[bcd]*b. This matches the letter 'a', zero or more letters +from the class [bcd], and finally ends with a 'b'. Now imagine matching +this RE against the string 'abcbd'.

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Step

    Matched

    Explanation

    1

    a

    The a in the RE matches.

    2

    abcbd

    The engine matches [bcd]*, +going as far as it can, which +is to the end of the string.

    3

    Failure

    The engine tries to match +b, but the current position +is at the end of the string, so +it fails.

    4

    abcb

    Back up, so that [bcd]* +matches one less character.

    5

    Failure

    Try b again, but the +current position is at the last +character, which is a 'd'.

    6

    abc

    Back up again, so that +[bcd]* is only matching +bc.

    6

    abcb

    Try b again. This time +the character at the +current position is 'b', so +it succeeds.

    +

    The end of the RE has now been reached, and it has matched 'abcb'. This +demonstrates how the matching engine goes as far as it can at first, and if no +match is found it will then progressively back up and retry the rest of the RE +again and again. It will back up until it has tried zero matches for +[bcd]*, and if that subsequently fails, the engine will conclude that the +string doesn’t match the RE at all.

    +

    Another repeating metacharacter is +, which matches one or more times. Pay +careful attention to the difference between * and +; * matches +zero or more times, so whatever’s being repeated may not be present at all, +while + requires at least one occurrence. To use a similar example, +ca+t will match 'cat' (1 'a'), 'caaat' (3 'a's), but won’t +match 'ct'.

    +

    There are two more repeating qualifiers. The question mark character, ?, +matches either once or zero times; you can think of it as marking something as +being optional. For example, home-?brew matches either 'homebrew' or +'home-brew'.

    +

    The most complicated repeated qualifier is {m,n}, where m and n are +decimal integers. This qualifier means there must be at least m repetitions, +and at most n. For example, a/{1,3}b will match 'a/b', 'a//b', and +'a///b'. It won’t match 'ab', which has no slashes, or 'a////b', which +has four.

    +

    You can omit either m or n; in that case, a reasonable value is assumed for +the missing value. Omitting m is interpreted as a lower limit of 0, while +omitting n results in an upper bound of infinity.

    +

    Readers of a reductionist bent may notice that the three other qualifiers can +all be expressed using this notation. {0,} is the same as *, {1,} +is equivalent to +, and {0,1} is the same as ?. It’s better to use +*, +, or ? when you can, simply because they’re shorter and easier +to read.

    +
    +
    +
    +

    Using Regular Expressions

    +

    Now that we’ve looked at some simple regular expressions, how do we actually use +them in Python? The re module provides an interface to the regular +expression engine, allowing you to compile REs into objects and then perform +matches with them.

    +
    +

    Compiling Regular Expressions

    +

    Regular expressions are compiled into pattern objects, which have +methods for various operations such as searching for pattern matches or +performing string substitutions.

    +
    >>> import re
    +>>> p = re.compile('ab*')
    +>>> p
    +re.compile('ab*')
    +
    +
    +

    re.compile() also accepts an optional flags argument, used to enable +various special features and syntax variations. We’ll go over the available +settings later, but for now a single example will do:

    +
    >>> p = re.compile('ab*', re.IGNORECASE)
    +
    +
    +

    The RE is passed to re.compile() as a string. REs are handled as strings +because regular expressions aren’t part of the core Python language, and no +special syntax was created for expressing them. (There are applications that +don’t need REs at all, so there’s no need to bloat the language specification by +including them.) Instead, the re module is simply a C extension module +included with Python, just like the socket or zlib modules.

    +

    Putting REs in strings keeps the Python language simpler, but has one +disadvantage which is the topic of the next section.

    +
    +
    +

    The Backslash Plague

    +

    As stated earlier, regular expressions use the backslash character ('\') to +indicate special forms or to allow special characters to be used without +invoking their special meaning. This conflicts with Python’s usage of the same +character for the same purpose in string literals.

    +

    Let’s say you want to write a RE that matches the string \section, which +might be found in a LaTeX file. To figure out what to write in the program +code, start with the desired string to be matched. Next, you must escape any +backslashes and other metacharacters by preceding them with a backslash, +resulting in the string \\section. The resulting string that must be passed +to re.compile() must be \\section. However, to express this as a +Python string literal, both backslashes must be escaped again.

    + ++++ + + + + + + + + + + + + + + + + +

    Characters

    Stage

    \section

    Text string to be matched

    \\section

    Escaped backslash for re.compile()

    "\\\\section"

    Escaped backslashes for a string literal

    +

    In short, to match a literal backslash, one has to write '\\\\' as the RE +string, because the regular expression must be \\, and each backslash must +be expressed as \\ inside a regular Python string literal. In REs that +feature backslashes repeatedly, this leads to lots of repeated backslashes and +makes the resulting strings difficult to understand.

    +

    The solution is to use Python’s raw string notation for regular expressions; +backslashes are not handled in any special way in a string literal prefixed with +'r', so r"\n" is a two-character string containing '\' and 'n', +while "\n" is a one-character string containing a newline. Regular +expressions will often be written in Python code using this raw string notation.

    +

    In addition, special escape sequences that are valid in regular expressions, +but not valid as Python string literals, now result in a +DeprecationWarning and will eventually become a SyntaxError, +which means the sequences will be invalid if raw string notation or escaping +the backslashes isn’t used.

    + ++++ + + + + + + + + + + + + + + + + +

    Regular String

    Raw string

    "ab*"

    r"ab*"

    "\\\\section"

    r"\\section"

    "\\w+\\s+\\1"

    r"\w+\s+\1"

    +
    +
    +

    Performing Matches

    +

    Once you have an object representing a compiled regular expression, what do you +do with it? Pattern objects have several methods and attributes. +Only the most significant ones will be covered here; consult the re docs +for a complete listing.

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Method/Attribute

    Purpose

    match()

    Determine if the RE matches at the beginning +of the string.

    search()

    Scan through a string, looking for any +location where this RE matches.

    findall()

    Find all substrings where the RE matches, and +returns them as a list.

    finditer()

    Find all substrings where the RE matches, and +returns them as an iterator.

    +

    match() and search() return None if no match can be found. If +they’re successful, a match object instance is returned, +containing information about the match: where it starts and ends, the substring +it matched, and more.

    +

    You can learn about this by interactively experimenting with the re +module. If you have tkinter available, you may also want to look at +Tools/demo/redemo.py, a demonstration program included with the +Python distribution. It allows you to enter REs and strings, and displays +whether the RE matches or fails. redemo.py can be quite useful when +trying to debug a complicated RE.

    +

    This HOWTO uses the standard Python interpreter for its examples. First, run the +Python interpreter, import the re module, and compile a RE:

    +
    >>> import re
    +>>> p = re.compile('[a-z]+')
    +>>> p
    +re.compile('[a-z]+')
    +
    +
    +

    Now, you can try matching various strings against the RE [a-z]+. An empty +string shouldn’t match at all, since + means ‘one or more repetitions’. +match() should return None in this case, which will cause the +interpreter to print no output. You can explicitly print the result of +match() to make this clear.

    +
    >>> p.match("")
    +>>> print(p.match(""))
    +None
    +
    +
    +

    Now, let’s try it on a string that it should match, such as tempo. In this +case, match() will return a match object, so you +should store the result in a variable for later use.

    +
    >>> m = p.match('tempo')
    +>>> m
    +<re.Match object; span=(0, 5), match='tempo'>
    +
    +
    +

    Now you can query the match object for information +about the matching string. Match object instances +also have several methods and attributes; the most important ones are:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Method/Attribute

    Purpose

    group()

    Return the string matched by the RE

    start()

    Return the starting position of the match

    end()

    Return the ending position of the match

    span()

    Return a tuple containing the (start, end) +positions of the match

    +

    Trying these methods will soon clarify their meaning:

    +
    >>> m.group()
    +'tempo'
    +>>> m.start(), m.end()
    +(0, 5)
    +>>> m.span()
    +(0, 5)
    +
    +
    +

    group() returns the substring that was matched by the RE. start() +and end() return the starting and ending index of the match. span() +returns both start and end indexes in a single tuple. Since the match() +method only checks if the RE matches at the start of a string, start() +will always be zero. However, the search() method of patterns +scans through the string, so the match may not start at zero in that +case.

    +
    >>> print(p.match('::: message'))
    +None
    +>>> m = p.search('::: message'); print(m)
    +<re.Match object; span=(4, 11), match='message'>
    +>>> m.group()
    +'message'
    +>>> m.span()
    +(4, 11)
    +
    +
    +

    In actual programs, the most common style is to store the +match object in a variable, and then check if it was +None. This usually looks like:

    +
    p = re.compile( ... )
    +m = p.match( 'string goes here' )
    +if m:
    +    print('Match found: ', m.group())
    +else:
    +    print('No match')
    +
    +
    +

    Two pattern methods return all of the matches for a pattern. +findall() returns a list of matching strings:

    +
    >>> p = re.compile(r'\d+')
    +>>> p.findall('12 drummers drumming, 11 pipers piping, 10 lords a-leaping')
    +['12', '11', '10']
    +
    +
    +

    The r prefix, making the literal a raw string literal, is needed in this +example because escape sequences in a normal “cooked” string literal that are +not recognized by Python, as opposed to regular expressions, now result in a +DeprecationWarning and will eventually become a SyntaxError. See +The Backslash Plague.

    +

    findall() has to create the entire list before it can be returned as the +result. The finditer() method returns a sequence of +match object instances as an iterator:

    +
    >>> iterator = p.finditer('12 drummers drumming, 11 ... 10 ...')
    +>>> iterator  
    +<callable_iterator object at 0x...>
    +>>> for match in iterator:
    +...     print(match.span())
    +...
    +(0, 2)
    +(22, 24)
    +(29, 31)
    +
    +
    +
    +
    +

    Module-Level Functions

    +

    You don’t have to create a pattern object and call its methods; the +re module also provides top-level functions called match(), +search(), findall(), sub(), and so forth. These functions +take the same arguments as the corresponding pattern method with +the RE string added as the first argument, and still return either None or a +match object instance.

    +
    >>> print(re.match(r'From\s+', 'Fromage amk'))
    +None
    +>>> re.match(r'From\s+', 'From amk Thu May 14 19:12:10 1998')  
    +<re.Match object; span=(0, 5), match='From '>
    +
    +
    +

    Under the hood, these functions simply create a pattern object for you +and call the appropriate method on it. They also store the compiled +object in a cache, so future calls using the same RE won’t need to +parse the pattern again and again.

    +

    Should you use these module-level functions, or should you get the +pattern and call its methods yourself? If you’re accessing a regex +within a loop, pre-compiling it will save a few function calls. +Outside of loops, there’s not much difference thanks to the internal +cache.

    +
    +
    +

    Compilation Flags

    +

    Compilation flags let you modify some aspects of how regular expressions work. +Flags are available in the re module under two names, a long name such as +IGNORECASE and a short, one-letter form such as I. (If you’re +familiar with Perl’s pattern modifiers, the one-letter forms use the same +letters; the short form of re.VERBOSE is re.X, for example.) +Multiple flags can be specified by bitwise OR-ing them; re.I | re.M sets +both the I and M flags, for example.

    +

    Here’s a table of the available flags, followed by a more detailed explanation +of each one.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + +

    Flag

    Meaning

    ASCII, A

    Makes several escapes like \w, \b, +\s and \d match only on ASCII +characters with the respective property.

    DOTALL, S

    Make . match any character, including +newlines.

    IGNORECASE, I

    Do case-insensitive matches.

    LOCALE, L

    Do a locale-aware match.

    MULTILINE, M

    Multi-line matching, affecting ^ and +$.

    VERBOSE, X +(for ‘extended’)

    Enable verbose REs, which can be organized +more cleanly and understandably.

    +
    +
    +I
    +
    +IGNORECASE
    +

    Perform case-insensitive matching; character class and literal strings will +match letters by ignoring case. For example, [A-Z] will match lowercase +letters, too. Full Unicode matching also works unless the ASCII +flag is used to disable non-ASCII matches. When the Unicode patterns +[a-z] or [A-Z] are used in combination with the IGNORECASE +flag, they will match the 52 ASCII letters and 4 additional non-ASCII +letters: ‘İ’ (U+0130, Latin capital letter I with dot above), ‘ı’ (U+0131, +Latin small letter dotless i), ‘ſ’ (U+017F, Latin small letter long s) and +‘K’ (U+212A, Kelvin sign). Spam will match 'Spam', 'spam', +'spAM', or 'ſpam' (the latter is matched only in Unicode mode). +This lowercasing doesn’t take the current locale into account; +it will if you also set the LOCALE flag.

    +
    + +
    +
    +L
    +
    +LOCALE
    +

    Make \w, \W, \b, \B and case-insensitive matching dependent +on the current locale instead of the Unicode database.

    +

    Locales are a feature of the C library intended to help in writing programs +that take account of language differences. For example, if you’re +processing encoded French text, you’d want to be able to write \w+ to +match words, but \w only matches the character class [A-Za-z] in +bytes patterns; it won’t match bytes corresponding to é or ç. +If your system is configured properly and a French locale is selected, +certain C functions will tell the program that the byte corresponding to +é should also be considered a letter. +Setting the LOCALE flag when compiling a regular expression will cause +the resulting compiled object to use these C functions for \w; this is +slower, but also enables \w+ to match French words as you’d expect. +The use of this flag is discouraged in Python 3 as the locale mechanism +is very unreliable, it only handles one “culture” at a time, and it only +works with 8-bit locales. Unicode matching is already enabled by default +in Python 3 for Unicode (str) patterns, and it is able to handle different +locales/languages.

    +
    + +
    +
    +M
    +
    +MULTILINE
    +

    (^ and $ haven’t been explained yet; they’ll be introduced in section +More Metacharacters.)

    +

    Usually ^ matches only at the beginning of the string, and $ matches +only at the end of the string and immediately before the newline (if any) at the +end of the string. When this flag is specified, ^ matches at the beginning +of the string and at the beginning of each line within the string, immediately +following each newline. Similarly, the $ metacharacter matches either at +the end of the string and at the end of each line (immediately preceding each +newline).

    +
    + +
    +
    +S
    +
    +DOTALL
    +

    Makes the '.' special character match any character at all, including a +newline; without this flag, '.' will match anything except a newline.

    +
    + +
    +
    +A
    +
    +ASCII
    +

    Make \w, \W, \b, \B, \s and \S perform ASCII-only +matching instead of full Unicode matching. This is only meaningful for +Unicode patterns, and is ignored for byte patterns.

    +
    + +
    +
    +X
    +
    +VERBOSE
    +

    This flag allows you to write regular expressions that are more readable by +granting you more flexibility in how you can format them. When this flag has +been specified, whitespace within the RE string is ignored, except when the +whitespace is in a character class or preceded by an unescaped backslash; this +lets you organize and indent the RE more clearly. This flag also lets you put +comments within a RE that will be ignored by the engine; comments are marked by +a '#' that’s neither in a character class or preceded by an unescaped +backslash.

    +

    For example, here’s a RE that uses re.VERBOSE; see how much easier it +is to read?

    +
    charref = re.compile(r"""
    + &[#]                # Start of a numeric entity reference
    + (
    +     0[0-7]+         # Octal form
    +   | [0-9]+          # Decimal form
    +   | x[0-9a-fA-F]+   # Hexadecimal form
    + )
    + ;                   # Trailing semicolon
    +""", re.VERBOSE)
    +
    +
    +

    Without the verbose setting, the RE would look like this:

    +
    charref = re.compile("&#(0[0-7]+"
    +                     "|[0-9]+"
    +                     "|x[0-9a-fA-F]+);")
    +
    +
    +

    In the above example, Python’s automatic concatenation of string literals has +been used to break up the RE into smaller pieces, but it’s still more difficult +to understand than the version using re.VERBOSE.

    +
    + +
    +
    +
    +

    More Pattern Power

    +

    So far we’ve only covered a part of the features of regular expressions. In +this section, we’ll cover some new metacharacters, and how to use groups to +retrieve portions of the text that was matched.

    +
    +

    More Metacharacters

    +

    There are some metacharacters that we haven’t covered yet. Most of them will be +covered in this section.

    +

    Some of the remaining metacharacters to be discussed are zero-width +assertions. They don’t cause the engine to advance through the string; +instead, they consume no characters at all, and simply succeed or fail. For +example, \b is an assertion that the current position is located at a word +boundary; the position isn’t changed by the \b at all. This means that +zero-width assertions should never be repeated, because if they match once at a +given location, they can obviously be matched an infinite number of times.

    +
    +
    |

    Alternation, or the “or” operator. If A and B are regular expressions, +A|B will match any string that matches either A or B. | has very +low precedence in order to make it work reasonably when you’re alternating +multi-character strings. Crow|Servo will match either 'Crow' or 'Servo', +not 'Cro', a 'w' or an 'S', and 'ervo'.

    +

    To match a literal '|', use \|, or enclose it inside a character class, +as in [|].

    +
    +
    ^

    Matches at the beginning of lines. Unless the MULTILINE flag has been +set, this will only match at the beginning of the string. In MULTILINE +mode, this also matches immediately after each newline within the string.

    +

    For example, if you wish to match the word From only at the beginning of a +line, the RE to use is ^From.

    +
    >>> print(re.search('^From', 'From Here to Eternity'))  
    +<re.Match object; span=(0, 4), match='From'>
    +>>> print(re.search('^From', 'Reciting From Memory'))
    +None
    +
    +
    +

    To match a literal '^', use \^.

    +
    +
    $

    Matches at the end of a line, which is defined as either the end of the string, +or any location followed by a newline character.

    +
    >>> print(re.search('}$', '{block}'))  
    +<re.Match object; span=(6, 7), match='}'>
    +>>> print(re.search('}$', '{block} '))
    +None
    +>>> print(re.search('}$', '{block}\n'))  
    +<re.Match object; span=(6, 7), match='}'>
    +
    +
    +

    To match a literal '$', use \$ or enclose it inside a character class, +as in [$].

    +
    +
    \A

    Matches only at the start of the string. When not in MULTILINE mode, +\A and ^ are effectively the same. In MULTILINE mode, they’re +different: \A still matches only at the beginning of the string, but ^ +may match at any location inside the string that follows a newline character.

    +
    +
    \Z

    Matches only at the end of the string.

    +
    +
    \b

    Word boundary. This is a zero-width assertion that matches only at the +beginning or end of a word. A word is defined as a sequence of alphanumeric +characters, so the end of a word is indicated by whitespace or a +non-alphanumeric character.

    +

    The following example matches class only when it’s a complete word; it won’t +match when it’s contained inside another word.

    +
    >>> p = re.compile(r'\bclass\b')
    +>>> print(p.search('no class at all'))
    +<re.Match object; span=(3, 8), match='class'>
    +>>> print(p.search('the declassified algorithm'))
    +None
    +>>> print(p.search('one subclass is'))
    +None
    +
    +
    +

    There are two subtleties you should remember when using this special sequence. +First, this is the worst collision between Python’s string literals and regular +expression sequences. In Python’s string literals, \b is the backspace +character, ASCII value 8. If you’re not using raw strings, then Python will +convert the \b to a backspace, and your RE won’t match as you expect it to. +The following example looks the same as our previous RE, but omits the 'r' +in front of the RE string.

    +
    >>> p = re.compile('\bclass\b')
    +>>> print(p.search('no class at all'))
    +None
    +>>> print(p.search('\b' + 'class' + '\b'))
    +<re.Match object; span=(0, 7), match='\x08class\x08'>
    +
    +
    +

    Second, inside a character class, where there’s no use for this assertion, +\b represents the backspace character, for compatibility with Python’s +string literals.

    +
    +
    \B

    Another zero-width assertion, this is the opposite of \b, only matching when +the current position is not at a word boundary.

    +
    +
    +
    +
    +

    Grouping

    +

    Frequently you need to obtain more information than just whether the RE matched +or not. Regular expressions are often used to dissect strings by writing a RE +divided into several subgroups which match different components of interest. +For example, an RFC-822 header line is divided into a header name and a value, +separated by a ':', like this:

    +
    From: author@example.com
    +User-Agent: Thunderbird 1.5.0.9 (X11/20061227)
    +MIME-Version: 1.0
    +To: editor@example.com
    +
    +
    +

    This can be handled by writing a regular expression which matches an entire +header line, and has one group which matches the header name, and another group +which matches the header’s value.

    +

    Groups are marked by the '(', ')' metacharacters. '(' and ')' +have much the same meaning as they do in mathematical expressions; they group +together the expressions contained inside them, and you can repeat the contents +of a group with a repeating qualifier, such as *, +, ?, or +{m,n}. For example, (ab)* will match zero or more repetitions of +ab.

    +
    >>> p = re.compile('(ab)*')
    +>>> print(p.match('ababababab').span())
    +(0, 10)
    +
    +
    +

    Groups indicated with '(', ')' also capture the starting and ending +index of the text that they match; this can be retrieved by passing an argument +to group(), start(), end(), and +span(). Groups are +numbered starting with 0. Group 0 is always present; it’s the whole RE, so +match object methods all have group 0 as their default +argument. Later we’ll see how to express groups that don’t capture the span +of text that they match.

    +
    >>> p = re.compile('(a)b')
    +>>> m = p.match('ab')
    +>>> m.group()
    +'ab'
    +>>> m.group(0)
    +'ab'
    +
    +
    +

    Subgroups are numbered from left to right, from 1 upward. Groups can be nested; +to determine the number, just count the opening parenthesis characters, going +from left to right.

    +
    >>> p = re.compile('(a(b)c)d')
    +>>> m = p.match('abcd')
    +>>> m.group(0)
    +'abcd'
    +>>> m.group(1)
    +'abc'
    +>>> m.group(2)
    +'b'
    +
    +
    +

    group() can be passed multiple group numbers at a time, in which case it +will return a tuple containing the corresponding values for those groups.

    +
    >>> m.group(2,1,2)
    +('b', 'abc', 'b')
    +
    +
    +

    The groups() method returns a tuple containing the strings for all the +subgroups, from 1 up to however many there are.

    +
    >>> m.groups()
    +('abc', 'b')
    +
    +
    +

    Backreferences in a pattern allow you to specify that the contents of an earlier +capturing group must also be found at the current location in the string. For +example, \1 will succeed if the exact contents of group 1 can be found at +the current position, and fails otherwise. Remember that Python’s string +literals also use a backslash followed by numbers to allow including arbitrary +characters in a string, so be sure to use a raw string when incorporating +backreferences in a RE.

    +

    For example, the following RE detects doubled words in a string.

    +
    >>> p = re.compile(r'\b(\w+)\s+\1\b')
    +>>> p.search('Paris in the the spring').group()
    +'the the'
    +
    +
    +

    Backreferences like this aren’t often useful for just searching through a string +— there are few text formats which repeat data in this way — but you’ll soon +find out that they’re very useful when performing string substitutions.

    +
    +
    +

    Non-capturing and Named Groups

    +

    Elaborate REs may use many groups, both to capture substrings of interest, and +to group and structure the RE itself. In complex REs, it becomes difficult to +keep track of the group numbers. There are two features which help with this +problem. Both of them use a common syntax for regular expression extensions, so +we’ll look at that first.

    +

    Perl 5 is well known for its powerful additions to standard regular expressions. +For these new features the Perl developers couldn’t choose new single-keystroke metacharacters +or new special sequences beginning with \ without making Perl’s regular +expressions confusingly different from standard REs. If they chose & as a +new metacharacter, for example, old expressions would be assuming that & was +a regular character and wouldn’t have escaped it by writing \& or [&].

    +

    The solution chosen by the Perl developers was to use (?...) as the +extension syntax. ? immediately after a parenthesis was a syntax error +because the ? would have nothing to repeat, so this didn’t introduce any +compatibility problems. The characters immediately after the ? indicate +what extension is being used, so (?=foo) is one thing (a positive lookahead +assertion) and (?:foo) is something else (a non-capturing group containing +the subexpression foo).

    +

    Python supports several of Perl’s extensions and adds an extension +syntax to Perl’s extension syntax. If the first character after the +question mark is a P, you know that it’s an extension that’s +specific to Python.

    +

    Now that we’ve looked at the general extension syntax, we can return +to the features that simplify working with groups in complex REs.

    +

    Sometimes you’ll want to use a group to denote a part of a regular expression, +but aren’t interested in retrieving the group’s contents. You can make this fact +explicit by using a non-capturing group: (?:...), where you can replace the +... with any other regular expression.

    +
    >>> m = re.match("([abc])+", "abc")
    +>>> m.groups()
    +('c',)
    +>>> m = re.match("(?:[abc])+", "abc")
    +>>> m.groups()
    +()
    +
    +
    +

    Except for the fact that you can’t retrieve the contents of what the group +matched, a non-capturing group behaves exactly the same as a capturing group; +you can put anything inside it, repeat it with a repetition metacharacter such +as *, and nest it within other groups (capturing or non-capturing). +(?:...) is particularly useful when modifying an existing pattern, since you +can add new groups without changing how all the other groups are numbered. It +should be mentioned that there’s no performance difference in searching between +capturing and non-capturing groups; neither form is any faster than the other.

    +

    A more significant feature is named groups: instead of referring to them by +numbers, groups can be referenced by a name.

    +

    The syntax for a named group is one of the Python-specific extensions: +(?P<name>...). name is, obviously, the name of the group. Named groups +behave exactly like capturing groups, and additionally associate a name +with a group. The match object methods that deal with +capturing groups all accept either integers that refer to the group by number +or strings that contain the desired group’s name. Named groups are still +given numbers, so you can retrieve information about a group in two ways:

    +
    >>> p = re.compile(r'(?P<word>\b\w+\b)')
    +>>> m = p.search( '(((( Lots of punctuation )))' )
    +>>> m.group('word')
    +'Lots'
    +>>> m.group(1)
    +'Lots'
    +
    +
    +

    Named groups are handy because they let you use easily-remembered names, instead +of having to remember numbers. Here’s an example RE from the imaplib +module:

    +
    InternalDate = re.compile(r'INTERNALDATE "'
    +        r'(?P<day>[ 123][0-9])-(?P<mon>[A-Z][a-z][a-z])-'
    +        r'(?P<year>[0-9][0-9][0-9][0-9])'
    +        r' (?P<hour>[0-9][0-9]):(?P<min>[0-9][0-9]):(?P<sec>[0-9][0-9])'
    +        r' (?P<zonen>[-+])(?P<zoneh>[0-9][0-9])(?P<zonem>[0-9][0-9])'
    +        r'"')
    +
    +
    +

    It’s obviously much easier to retrieve m.group('zonem'), instead of having +to remember to retrieve group 9.

    +

    The syntax for backreferences in an expression such as (...)\1 refers to the +number of the group. There’s naturally a variant that uses the group name +instead of the number. This is another Python extension: (?P=name) indicates +that the contents of the group called name should again be matched at the +current point. The regular expression for finding doubled words, +\b(\w+)\s+\1\b can also be written as \b(?P<word>\w+)\s+(?P=word)\b:

    +
    >>> p = re.compile(r'\b(?P<word>\w+)\s+(?P=word)\b')
    +>>> p.search('Paris in the the spring').group()
    +'the the'
    +
    +
    +
    +
    +

    Lookahead Assertions

    +

    Another zero-width assertion is the lookahead assertion. Lookahead assertions +are available in both positive and negative form, and look like this:

    +
    +
    (?=...)

    Positive lookahead assertion. This succeeds if the contained regular +expression, represented here by ..., successfully matches at the current +location, and fails otherwise. But, once the contained expression has been +tried, the matching engine doesn’t advance at all; the rest of the pattern is +tried right where the assertion started.

    +
    +
    (?!...)

    Negative lookahead assertion. This is the opposite of the positive assertion; +it succeeds if the contained expression doesn’t match at the current position +in the string.

    +
    +
    +

    To make this concrete, let’s look at a case where a lookahead is useful. +Consider a simple pattern to match a filename and split it apart into a base +name and an extension, separated by a .. For example, in news.rc, +news is the base name, and rc is the filename’s extension.

    +

    The pattern to match this is quite simple:

    +

    .*[.].*$

    +

    Notice that the . needs to be treated specially because it’s a +metacharacter, so it’s inside a character class to only match that +specific character. Also notice the trailing $; this is added to +ensure that all the rest of the string must be included in the +extension. This regular expression matches foo.bar and +autoexec.bat and sendmail.cf and printers.conf.

    +

    Now, consider complicating the problem a bit; what if you want to match +filenames where the extension is not bat? Some incorrect attempts:

    +

    .*[.][^b].*$ The first attempt above tries to exclude bat by requiring +that the first character of the extension is not a b. This is wrong, +because the pattern also doesn’t match foo.bar.

    +

    .*[.]([^b]..|.[^a].|..[^t])$

    +

    The expression gets messier when you try to patch up the first solution by +requiring one of the following cases to match: the first character of the +extension isn’t b; the second character isn’t a; or the third character +isn’t t. This accepts foo.bar and rejects autoexec.bat, but it +requires a three-letter extension and won’t accept a filename with a two-letter +extension such as sendmail.cf. We’ll complicate the pattern again in an +effort to fix it.

    +

    .*[.]([^b].?.?|.[^a]?.?|..?[^t]?)$

    +

    In the third attempt, the second and third letters are all made optional in +order to allow matching extensions shorter than three characters, such as +sendmail.cf.

    +

    The pattern’s getting really complicated now, which makes it hard to read and +understand. Worse, if the problem changes and you want to exclude both bat +and exe as extensions, the pattern would get even more complicated and +confusing.

    +

    A negative lookahead cuts through all this confusion:

    +

    .*[.](?!bat$)[^.]*$ The negative lookahead means: if the expression bat +doesn’t match at this point, try the rest of the pattern; if bat$ does +match, the whole pattern will fail. The trailing $ is required to ensure +that something like sample.batch, where the extension only starts with +bat, will be allowed. The [^.]* makes sure that the pattern works +when there are multiple dots in the filename.

    +

    Excluding another filename extension is now easy; simply add it as an +alternative inside the assertion. The following pattern excludes filenames that +end in either bat or exe:

    +

    .*[.](?!bat$|exe$)[^.]*$

    +
    +
    +
    +

    Modifying Strings

    +

    Up to this point, we’ve simply performed searches against a static string. +Regular expressions are also commonly used to modify strings in various ways, +using the following pattern methods:

    + ++++ + + + + + + + + + + + + + + + + +

    Method/Attribute

    Purpose

    split()

    Split the string into a list, splitting it +wherever the RE matches

    sub()

    Find all substrings where the RE matches, and +replace them with a different string

    subn()

    Does the same thing as sub(), but +returns the new string and the number of +replacements

    +
    +

    Splitting Strings

    +

    The split() method of a pattern splits a string apart +wherever the RE matches, returning a list of the pieces. It’s similar to the +split() method of strings but provides much more generality in the +delimiters that you can split by; string split() only supports splitting by +whitespace or by a fixed string. As you’d expect, there’s a module-level +re.split() function, too.

    +
    +
    +.split(string[, maxsplit=0])
    +

    Split string by the matches of the regular expression. If capturing +parentheses are used in the RE, then their contents will also be returned as +part of the resulting list. If maxsplit is nonzero, at most maxsplit splits +are performed.

    +
    + +

    You can limit the number of splits made, by passing a value for maxsplit. +When maxsplit is nonzero, at most maxsplit splits will be made, and the +remainder of the string is returned as the final element of the list. In the +following example, the delimiter is any sequence of non-alphanumeric characters.

    +
    >>> p = re.compile(r'\W+')
    +>>> p.split('This is a test, short and sweet, of split().')
    +['This', 'is', 'a', 'test', 'short', 'and', 'sweet', 'of', 'split', '']
    +>>> p.split('This is a test, short and sweet, of split().', 3)
    +['This', 'is', 'a', 'test, short and sweet, of split().']
    +
    +
    +

    Sometimes you’re not only interested in what the text between delimiters is, but +also need to know what the delimiter was. If capturing parentheses are used in +the RE, then their values are also returned as part of the list. Compare the +following calls:

    +
    >>> p = re.compile(r'\W+')
    +>>> p2 = re.compile(r'(\W+)')
    +>>> p.split('This... is a test.')
    +['This', 'is', 'a', 'test', '']
    +>>> p2.split('This... is a test.')
    +['This', '... ', 'is', ' ', 'a', ' ', 'test', '.', '']
    +
    +
    +

    The module-level function re.split() adds the RE to be used as the first +argument, but is otherwise the same.

    +
    >>> re.split(r'[\W]+', 'Words, words, words.')
    +['Words', 'words', 'words', '']
    +>>> re.split(r'([\W]+)', 'Words, words, words.')
    +['Words', ', ', 'words', ', ', 'words', '.', '']
    +>>> re.split(r'[\W]+', 'Words, words, words.', 1)
    +['Words', 'words, words.']
    +
    +
    +
    +
    +

    Search and Replace

    +

    Another common task is to find all the matches for a pattern, and replace them +with a different string. The sub() method takes a replacement value, +which can be either a string or a function, and the string to be processed.

    +
    +
    +.sub(replacement, string[, count=0])
    +

    Returns the string obtained by replacing the leftmost non-overlapping +occurrences of the RE in string by the replacement replacement. If the +pattern isn’t found, string is returned unchanged.

    +

    The optional argument count is the maximum number of pattern occurrences to be +replaced; count must be a non-negative integer. The default value of 0 means +to replace all occurrences.

    +
    + +

    Here’s a simple example of using the sub() method. It replaces colour +names with the word colour:

    +
    >>> 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)
    +'colour socks and red shoes'
    +
    +
    +

    The 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')
    +('colour socks and colour shoes', 2)
    +>>> 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 empty match.

    +
    >>> p = re.compile('x*')
    +>>> p.sub('-', 'abxd')
    +'-a-b--d-'
    +
    +
    +

    If replacement is a string, any backslash escapes in it are processed. That +is, \n is converted to a single newline character, \r is converted to a +carriage return, and so forth. Unknown escapes such as \& are left alone. +Backreferences, such as \6, are replaced with the substring matched by the +corresponding group in the RE. This lets you incorporate portions of the +original text in the resulting replacement string.

    +

    This example matches the word section followed by a string enclosed in +{, }, and changes section to subsection:

    +
    >>> p = re.compile('section{ ( [^}]* ) }', re.VERBOSE)
    +>>> p.sub(r'subsection{\1}','section{First} section{second}')
    +'subsection{First} subsection{second}'
    +
    +
    +

    There’s also a syntax for referring to named groups as defined by the +(?P<name>...) syntax. \g<name> will use the substring matched by the +group named name, and \g<number> uses the corresponding group number. +\g<2> is therefore equivalent to \2, but isn’t ambiguous in a +replacement string such as \g<2>0. (\20 would be interpreted as a +reference to group 20, not a reference to group 2 followed by the literal +character '0'.) The following substitutions are all equivalent, but use all +three variations of the replacement string.

    +
    >>> p = re.compile('section{ (?P<name> [^}]* ) }', re.VERBOSE)
    +>>> p.sub(r'subsection{\1}','section{First}')
    +'subsection{First}'
    +>>> p.sub(r'subsection{\g<1>}','section{First}')
    +'subsection{First}'
    +>>> p.sub(r'subsection{\g<name>}','section{First}')
    +'subsection{First}'
    +
    +
    +

    replacement can also be a function, which gives you even more control. If +replacement is a function, the function is called for every non-overlapping +occurrence of pattern. On each call, the function is passed a +match object argument for the match and can use this +information to compute the desired replacement string and return it.

    +

    In the following example, the replacement function translates decimals into +hexadecimal:

    +
    >>> def hexrepl(match):
    +...     "Return the hex string for a decimal number"
    +...     value = int(match.group())
    +...     return hex(value)
    +...
    +>>> p = re.compile(r'\d+')
    +>>> p.sub(hexrepl, 'Call 65490 for printing, 49152 for user code.')
    +'Call 0xffd2 for printing, 0xc000 for user code.'
    +
    +
    +

    When using the module-level re.sub() function, the pattern is passed as +the first argument. The pattern may be provided as an object or as a string; if +you need to specify regular expression flags, you must either use a +pattern object as the first parameter, or use embedded modifiers in the +pattern string, e.g. sub("(?i)b+", "x", "bbbb BBBB") returns 'x x'.

    +
    +
    +
    +

    Common Problems

    +

    Regular expressions are a powerful tool for some applications, but in some ways +their behaviour isn’t intuitive and at times they don’t behave the way you may +expect them to. This section will point out some of the most common pitfalls.

    +
    +

    Use String Methods

    +

    Sometimes using the re module is a mistake. If you’re matching a fixed +string, or a single character class, and you’re not using any re features +such as the IGNORECASE flag, then the full power of regular expressions +may not be required. Strings have several methods for performing operations with +fixed strings and they’re usually much faster, because the implementation is a +single small C loop that’s been optimized for the purpose, instead of the large, +more generalized regular expression engine.

    +

    One example might be replacing a single fixed string with another one; for +example, you might replace word with deed. re.sub() seems like the +function to use for this, but consider the replace() method. Note that +replace() will also replace word inside words, turning swordfish +into sdeedfish, but the naive RE word would have done that, too. (To +avoid performing the substitution on parts of words, the pattern would have to +be \bword\b, in order to require that word have a word boundary on +either side. This takes the job beyond replace()’s abilities.)

    +

    Another common task is deleting every occurrence of a single character from a +string or replacing it with another single character. You might do this with +something like re.sub('\n', ' ', S), but translate() is capable of +doing both tasks and will be faster than any regular expression operation can +be.

    +

    In short, before turning to the re module, consider whether your problem +can be solved with a faster and simpler string method.

    +
    + +
    +

    Greedy versus Non-Greedy

    +

    When repeating a regular expression, as in a*, the resulting action is to +consume as much of the pattern as possible. This fact often bites you when +you’re trying to match a pair of balanced delimiters, such as the angle brackets +surrounding an HTML tag. The naive pattern for matching a single HTML tag +doesn’t work because of the greedy nature of .*.

    +
    >>> s = '<html><head><title>Title</title>'
    +>>> len(s)
    +32
    +>>> print(re.match('<.*>', s).span())
    +(0, 32)
    +>>> print(re.match('<.*>', s).group())
    +<html><head><title>Title</title>
    +
    +
    +

    The RE matches the '<' in '<html>', and the .* consumes the rest of +the string. There’s still more left in the RE, though, and the > can’t +match at the end of the string, so the regular expression engine has to +backtrack character by character until it finds a match for the >. The +final match extends from the '<' in '<html>' to the '>' in +'</title>', which isn’t what you want.

    +

    In this case, the solution is to use the non-greedy qualifiers *?, +?, +??, or {m,n}?, which match as little text as possible. In the above +example, the '>' is tried immediately after the first '<' matches, and +when it fails, the engine advances a character at a time, retrying the '>' +at every step. This produces just the right result:

    +
    >>> print(re.match('<.*?>', s).group())
    +<html>
    +
    +
    +

    (Note that parsing HTML or XML with regular expressions is painful. +Quick-and-dirty patterns will handle common cases, but HTML and XML have special +cases that will break the obvious regular expression; by the time you’ve written +a regular expression that handles all of the possible cases, the patterns will +be very complicated. Use an HTML or XML parser module for such tasks.)

    +
    +
    +

    Using re.VERBOSE

    +

    By now you’ve probably noticed that regular expressions are a very compact +notation, but they’re not terribly readable. REs of moderate complexity can +become lengthy collections of backslashes, parentheses, and metacharacters, +making them difficult to read and understand.

    +

    For such REs, specifying the re.VERBOSE flag when compiling the regular +expression can be helpful, because it allows you to format the regular +expression more clearly.

    +

    The re.VERBOSE flag has several effects. Whitespace in the regular +expression that isn’t inside a character class is ignored. This means that an +expression such as dog | cat is equivalent to the less readable dog|cat, +but [a b] will still match the characters 'a', 'b', or a space. In +addition, you can also put comments inside a RE; comments extend from a # +character to the next newline. When used with triple-quoted strings, this +enables REs to be formatted more neatly:

    +
    pat = re.compile(r"""
    + \s*                 # Skip leading whitespace
    + (?P<header>[^:]+)   # Header name
    + \s* :               # Whitespace, and a colon
    + (?P<value>.*?)      # The header's value -- *? used to
    +                     # lose the following trailing whitespace
    + \s*$                # Trailing whitespace to end-of-line
    +""", re.VERBOSE)
    +
    +
    +

    This is far more readable than:

    +
    pat = re.compile(r"\s*(?P<header>[^:]+)\s*:(?P<value>.*?)\s*$")
    +
    +
    +
    +
    +
    +

    Feedback

    +

    Regular expressions are a complicated topic. Did this document help you +understand them? Were there parts that were unclear, or Problems you +encountered that weren’t covered here? If so, please send suggestions for +improvements to the author.

    +

    The most complete book on regular expressions is almost certainly Jeffrey +Friedl’s Mastering Regular Expressions, published by O’Reilly. Unfortunately, +it exclusively concentrates on Perl and Java’s flavours of regular expressions, +and doesn’t contain any Python material at all, so it won’t be useful as a +reference for programming in Python. (The first edition covered Python’s +now-removed regex module, which won’t help you much.) Consider checking +it out from your library.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/howto/sockets.html b/python-3.7.4-docs-html/howto/sockets.html new file mode 100644 index 0000000..43f5a9b --- /dev/null +++ b/python-3.7.4-docs-html/howto/sockets.html @@ -0,0 +1,538 @@ + + + + + + + Socket Programming HOWTO — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Socket Programming HOWTO

    +
    +
    Author
    +

    Gordon McMillan

    +
    +
    +
    +

    Abstract

    +

    Sockets are used nearly everywhere, but are one of the most severely +misunderstood technologies around. This is a 10,000 foot overview of sockets. +It’s not really a tutorial - you’ll still have work to do in getting things +operational. It doesn’t cover the fine points (and there are a lot of them), but +I hope it will give you enough background to begin using them decently.

    +
    +
    +

    Sockets

    +

    I’m only going to talk about INET (i.e. IPv4) sockets, but they account for at least 99% of +the sockets in use. And I’ll only talk about STREAM (i.e. TCP) sockets - unless you really +know what you’re doing (in which case this HOWTO isn’t for you!), you’ll get +better behavior and performance from a STREAM socket than anything else. I will +try to clear up the mystery of what a socket is, as well as some hints on how to +work with blocking and non-blocking sockets. But I’ll start by talking about +blocking sockets. You’ll need to know how they work before dealing with +non-blocking sockets.

    +

    Part of the trouble with understanding these things is that “socket” can mean a +number of subtly different things, depending on context. So first, let’s make a +distinction between a “client” socket - an endpoint of a conversation, and a +“server” socket, which is more like a switchboard operator. The client +application (your browser, for example) uses “client” sockets exclusively; the +web server it’s talking to uses both “server” sockets and “client” sockets.

    +
    +

    History

    +

    Of the various forms of IPC, +sockets are by far the most popular. On any given platform, there are +likely to be other forms of IPC that are faster, but for +cross-platform communication, sockets are about the only game in town.

    +

    They were invented in Berkeley as part of the BSD flavor of Unix. They spread +like wildfire with the Internet. With good reason — the combination of sockets +with INET makes talking to arbitrary machines around the world unbelievably easy +(at least compared to other schemes).

    +
    +
    +
    +

    Creating a Socket

    +

    Roughly speaking, when you clicked on the link that brought you to this page, +your browser did something like the following:

    +
    # create an INET, STREAMing socket
    +s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
    +# now connect to the web server on port 80 - the normal http port
    +s.connect(("www.python.org", 80))
    +
    +
    +

    When the connect completes, the socket s can be used to send +in a request for the text of the page. The same socket will read the +reply, and then be destroyed. That’s right, destroyed. Client sockets +are normally only used for one exchange (or a small set of sequential +exchanges).

    +

    What happens in the web server is a bit more complex. First, the web server +creates a “server socket”:

    +
    # create an INET, STREAMing socket
    +serversocket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
    +# bind the socket to a public host, and a well-known port
    +serversocket.bind((socket.gethostname(), 80))
    +# become a server socket
    +serversocket.listen(5)
    +
    +
    +

    A couple things to notice: we used socket.gethostname() so that the socket +would be visible to the outside world. If we had used s.bind(('localhost', +80)) or s.bind(('127.0.0.1', 80)) we would still have a “server” socket, +but one that was only visible within the same machine. s.bind(('', 80)) +specifies that the socket is reachable by any address the machine happens to +have.

    +

    A second thing to note: low number ports are usually reserved for “well known” +services (HTTP, SNMP etc). If you’re playing around, use a nice high number (4 +digits).

    +

    Finally, the argument to listen tells the socket library that we want it to +queue up as many as 5 connect requests (the normal max) before refusing outside +connections. If the rest of the code is written properly, that should be plenty.

    +

    Now that we have a “server” socket, listening on port 80, we can enter the +mainloop of the web server:

    +
    while True:
    +    # accept connections from outside
    +    (clientsocket, address) = serversocket.accept()
    +    # now do something with the clientsocket
    +    # in this case, we'll pretend this is a threaded server
    +    ct = client_thread(clientsocket)
    +    ct.run()
    +
    +
    +

    There’s actually 3 general ways in which this loop could work - dispatching a +thread to handle clientsocket, create a new process to handle +clientsocket, or restructure this app to use non-blocking sockets, and +multiplex between our “server” socket and any active clientsockets using +select. More about that later. The important thing to understand now is +this: this is all a “server” socket does. It doesn’t send any data. It doesn’t +receive any data. It just produces “client” sockets. Each clientsocket is +created in response to some other “client” socket doing a connect() to the +host and port we’re bound to. As soon as we’ve created that clientsocket, we +go back to listening for more connections. The two “clients” are free to chat it +up - they are using some dynamically allocated port which will be recycled when +the conversation ends.

    +
    +

    IPC

    +

    If you need fast IPC between two processes on one machine, you should look into +pipes or shared memory. If you do decide to use AF_INET sockets, bind the +“server” socket to 'localhost'. On most platforms, this will take a +shortcut around a couple of layers of network code and be quite a bit faster.

    +
    +

    See also

    +

    The multiprocessing integrates cross-platform IPC into a higher-level +API.

    +
    +
    +
    +
    +

    Using a Socket

    +

    The first thing to note, is that the web browser’s “client” socket and the web +server’s “client” socket are identical beasts. That is, this is a “peer to peer” +conversation. Or to put it another way, as the designer, you will have to +decide what the rules of etiquette are for a conversation. Normally, the +connecting socket starts the conversation, by sending in a request, or +perhaps a signon. But that’s a design decision - it’s not a rule of sockets.

    +

    Now there are two sets of verbs to use for communication. You can use send +and recv, or you can transform your client socket into a file-like beast and +use read and write. The latter is the way Java presents its sockets. +I’m not going to talk about it here, except to warn you that you need to use +flush on sockets. These are buffered “files”, and a common mistake is to +write something, and then read for a reply. Without a flush in +there, you may wait forever for the reply, because the request may still be in +your output buffer.

    +

    Now we come to the major stumbling block of sockets - send and recv operate +on the network buffers. They do not necessarily handle all the bytes you hand +them (or expect from them), because their major focus is handling the network +buffers. In general, they return when the associated network buffers have been +filled (send) or emptied (recv). They then tell you how many bytes they +handled. It is your responsibility to call them again until your message has +been completely dealt with.

    +

    When a recv returns 0 bytes, it means the other side has closed (or is in +the process of closing) the connection. You will not receive any more data on +this connection. Ever. You may be able to send data successfully; I’ll talk +more about this later.

    +

    A protocol like HTTP uses a socket for only one transfer. The client sends a +request, then reads a reply. That’s it. The socket is discarded. This means that +a client can detect the end of the reply by receiving 0 bytes.

    +

    But if you plan to reuse your socket for further transfers, you need to realize +that there is no EOT on a socket. I repeat: if a socket +send or recv returns after handling 0 bytes, the connection has been +broken. If the connection has not been broken, you may wait on a recv +forever, because the socket will not tell you that there’s nothing more to +read (for now). Now if you think about that a bit, you’ll come to realize a +fundamental truth of sockets: messages must either be fixed length (yuck), or +be delimited (shrug), or indicate how long they are (much better), or end by +shutting down the connection. The choice is entirely yours, (but some ways are +righter than others).

    +

    Assuming you don’t want to end the connection, the simplest solution is a fixed +length message:

    +
    class MySocket:
    +    """demonstration class only
    +      - coded for clarity, not efficiency
    +    """
    +
    +    def __init__(self, sock=None):
    +        if sock is None:
    +            self.sock = socket.socket(
    +                            socket.AF_INET, socket.SOCK_STREAM)
    +        else:
    +            self.sock = sock
    +
    +    def connect(self, host, port):
    +        self.sock.connect((host, port))
    +
    +    def mysend(self, msg):
    +        totalsent = 0
    +        while totalsent < MSGLEN:
    +            sent = self.sock.send(msg[totalsent:])
    +            if sent == 0:
    +                raise RuntimeError("socket connection broken")
    +            totalsent = totalsent + sent
    +
    +    def myreceive(self):
    +        chunks = []
    +        bytes_recd = 0
    +        while bytes_recd < MSGLEN:
    +            chunk = self.sock.recv(min(MSGLEN - bytes_recd, 2048))
    +            if chunk == b'':
    +                raise RuntimeError("socket connection broken")
    +            chunks.append(chunk)
    +            bytes_recd = bytes_recd + len(chunk)
    +        return b''.join(chunks)
    +
    +
    +

    The sending code here is usable for almost any messaging scheme - in Python you +send strings, and you can use len() to determine its length (even if it has +embedded \0 characters). It’s mostly the receiving code that gets more +complex. (And in C, it’s not much worse, except you can’t use strlen if the +message has embedded \0s.)

    +

    The easiest enhancement is to make the first character of the message an +indicator of message type, and have the type determine the length. Now you have +two recvs - the first to get (at least) that first character so you can +look up the length, and the second in a loop to get the rest. If you decide to +go the delimited route, you’ll be receiving in some arbitrary chunk size, (4096 +or 8192 is frequently a good match for network buffer sizes), and scanning what +you’ve received for a delimiter.

    +

    One complication to be aware of: if your conversational protocol allows multiple +messages to be sent back to back (without some kind of reply), and you pass +recv an arbitrary chunk size, you may end up reading the start of a +following message. You’ll need to put that aside and hold onto it, until it’s +needed.

    +

    Prefixing the message with its length (say, as 5 numeric characters) gets more +complex, because (believe it or not), you may not get all 5 characters in one +recv. In playing around, you’ll get away with it; but in high network loads, +your code will very quickly break unless you use two recv loops - the first +to determine the length, the second to get the data part of the message. Nasty. +This is also when you’ll discover that send does not always manage to get +rid of everything in one pass. And despite having read this, you will eventually +get bit by it!

    +

    In the interests of space, building your character, (and preserving my +competitive position), these enhancements are left as an exercise for the +reader. Lets move on to cleaning up.

    +
    +

    Binary Data

    +

    It is perfectly possible to send binary data over a socket. The major problem is +that not all machines use the same formats for binary data. For example, a +Motorola chip will represent a 16 bit integer with the value 1 as the two hex +bytes 00 01. Intel and DEC, however, are byte-reversed - that same 1 is 01 00. +Socket libraries have calls for converting 16 and 32 bit integers - ntohl, +htonl, ntohs, htons where “n” means network and “h” means host, “s” means +short and “l” means long. Where network order is host order, these do +nothing, but where the machine is byte-reversed, these swap the bytes around +appropriately.

    +

    In these days of 32 bit machines, the ascii representation of binary data is +frequently smaller than the binary representation. That’s because a surprising +amount of the time, all those longs have the value 0, or maybe 1. The string “0” +would be two bytes, while binary is four. Of course, this doesn’t fit well with +fixed-length messages. Decisions, decisions.

    +
    +
    +
    +

    Disconnecting

    +

    Strictly speaking, you’re supposed to use shutdown on a socket before you +close it. The shutdown is an advisory to the socket at the other end. +Depending on the argument you pass it, it can mean “I’m not going to send +anymore, but I’ll still listen”, or “I’m not listening, good riddance!”. Most +socket libraries, however, are so used to programmers neglecting to use this +piece of etiquette that normally a close is the same as shutdown(); +close(). So in most situations, an explicit shutdown is not needed.

    +

    One way to use shutdown effectively is in an HTTP-like exchange. The client +sends a request and then does a shutdown(1). This tells the server “This +client is done sending, but can still receive.” The server can detect “EOF” by +a receive of 0 bytes. It can assume it has the complete request. The server +sends a reply. If the send completes successfully then, indeed, the client +was still receiving.

    +

    Python takes the automatic shutdown a step further, and says that when a socket +is garbage collected, it will automatically do a close if it’s needed. But +relying on this is a very bad habit. If your socket just disappears without +doing a close, the socket at the other end may hang indefinitely, thinking +you’re just being slow. Please close your sockets when you’re done.

    +
    +

    When Sockets Die

    +

    Probably the worst thing about using blocking sockets is what happens when the +other side comes down hard (without doing a close). Your socket is likely to +hang. TCP is a reliable protocol, and it will wait a long, long time +before giving up on a connection. If you’re using threads, the entire thread is +essentially dead. There’s not much you can do about it. As long as you aren’t +doing something dumb, like holding a lock while doing a blocking read, the +thread isn’t really consuming much in the way of resources. Do not try to kill +the thread - part of the reason that threads are more efficient than processes +is that they avoid the overhead associated with the automatic recycling of +resources. In other words, if you do manage to kill the thread, your whole +process is likely to be screwed up.

    +
    +
    +
    +

    Non-blocking Sockets

    +

    If you’ve understood the preceding, you already know most of what you need to +know about the mechanics of using sockets. You’ll still use the same calls, in +much the same ways. It’s just that, if you do it right, your app will be almost +inside-out.

    +

    In Python, you use socket.setblocking(0) to make it non-blocking. In C, it’s +more complex, (for one thing, you’ll need to choose between the BSD flavor +O_NONBLOCK and the almost indistinguishable Posix flavor O_NDELAY, which +is completely different from TCP_NODELAY), but it’s the exact same idea. You +do this after creating the socket, but before using it. (Actually, if you’re +nuts, you can switch back and forth.)

    +

    The major mechanical difference is that send, recv, connect and +accept can return without having done anything. You have (of course) a +number of choices. You can check return code and error codes and generally drive +yourself crazy. If you don’t believe me, try it sometime. Your app will grow +large, buggy and suck CPU. So let’s skip the brain-dead solutions and do it +right.

    +

    Use select.

    +

    In C, coding select is fairly complex. In Python, it’s a piece of cake, but +it’s close enough to the C version that if you understand select in Python, +you’ll have little trouble with it in C:

    +
    ready_to_read, ready_to_write, in_error = \
    +               select.select(
    +                  potential_readers,
    +                  potential_writers,
    +                  potential_errs,
    +                  timeout)
    +
    +
    +

    You pass select three lists: the first contains all sockets that you might +want to try reading; the second all the sockets you might want to try writing +to, and the last (normally left empty) those that you want to check for errors. +You should note that a socket can go into more than one list. The select +call is blocking, but you can give it a timeout. This is generally a sensible +thing to do - give it a nice long timeout (say a minute) unless you have good +reason to do otherwise.

    +

    In return, you will get three lists. They contain the sockets that are actually +readable, writable and in error. Each of these lists is a subset (possibly +empty) of the corresponding list you passed in.

    +

    If a socket is in the output readable list, you can be +as-close-to-certain-as-we-ever-get-in-this-business that a recv on that +socket will return something. Same idea for the writable list. You’ll be able +to send something. Maybe not all you want to, but something is better than +nothing. (Actually, any reasonably healthy socket will return as writable - it +just means outbound network buffer space is available.)

    +

    If you have a “server” socket, put it in the potential_readers list. If it comes +out in the readable list, your accept will (almost certainly) work. If you +have created a new socket to connect to someone else, put it in the +potential_writers list. If it shows up in the writable list, you have a decent +chance that it has connected.

    +

    Actually, select can be handy even with blocking sockets. It’s one way of +determining whether you will block - the socket returns as readable when there’s +something in the buffers. However, this still doesn’t help with the problem of +determining whether the other end is done, or just busy with something else.

    +

    Portability alert: On Unix, select works both with the sockets and +files. Don’t try this on Windows. On Windows, select works with sockets +only. Also note that in C, many of the more advanced socket options are done +differently on Windows. In fact, on Windows I usually use threads (which work +very, very well) with my sockets.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/howto/sorting.html b/python-3.7.4-docs-html/howto/sorting.html new file mode 100644 index 0000000..c30df0c --- /dev/null +++ b/python-3.7.4-docs-html/howto/sorting.html @@ -0,0 +1,473 @@ + + + + + + + Sorting HOW TO — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Sorting HOW TO

    +
    +
    Author
    +

    Andrew Dalke and Raymond Hettinger

    +
    +
    Release
    +

    0.1

    +
    +
    +

    Python lists have a built-in list.sort() method that modifies the list +in-place. There is also a sorted() built-in function that builds a new +sorted list from an iterable.

    +

    In this document, we explore the various techniques for sorting data using Python.

    +
    +

    Sorting Basics

    +

    A simple ascending sort is very easy: just call the sorted() function. It +returns a new sorted list:

    +
    >>> sorted([5, 2, 3, 1, 4])
    +[1, 2, 3, 4, 5]
    +
    +
    +

    You can also use the list.sort() method. It modifies the list +in-place (and returns None to avoid confusion). Usually it’s less convenient +than sorted() - but if you don’t need the original list, it’s slightly +more efficient.

    +
    >>> a = [5, 2, 3, 1, 4]
    +>>> a.sort()
    +>>> a
    +[1, 2, 3, 4, 5]
    +
    +
    +

    Another difference is that the list.sort() method is only defined for +lists. In contrast, the sorted() function accepts any iterable.

    +
    >>> sorted({1: 'D', 2: 'B', 3: 'B', 4: 'E', 5: 'A'})
    +[1, 2, 3, 4, 5]
    +
    +
    +
    +
    +

    Key Functions

    +

    Both list.sort() and sorted() have a key parameter to specify a +function to be called on each list element prior to making comparisons.

    +

    For example, here’s a case-insensitive string comparison:

    +
    >>> sorted("This is a test string from Andrew".split(), key=str.lower)
    +['a', 'Andrew', 'from', 'is', 'string', 'test', 'This']
    +
    +
    +

    The value of the key parameter should be a function that takes a single argument +and returns a key to use for sorting purposes. This technique is fast because +the key function is called exactly once for each input record.

    +

    A common pattern is to sort complex objects using some of the object’s indices +as keys. For example:

    +
    >>> student_tuples = [
    +...     ('john', 'A', 15),
    +...     ('jane', 'B', 12),
    +...     ('dave', 'B', 10),
    +... ]
    +>>> sorted(student_tuples, key=lambda student: student[2])   # sort by age
    +[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]
    +
    +
    +

    The same technique works for objects with named attributes. For example:

    +
    >>> class Student:
    +...     def __init__(self, name, grade, age):
    +...         self.name = name
    +...         self.grade = grade
    +...         self.age = age
    +...     def __repr__(self):
    +...         return repr((self.name, self.grade, self.age))
    +
    +
    +
    >>> student_objects = [
    +...     Student('john', 'A', 15),
    +...     Student('jane', 'B', 12),
    +...     Student('dave', 'B', 10),
    +... ]
    +>>> sorted(student_objects, key=lambda student: student.age)   # sort by age
    +[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]
    +
    +
    +
    +
    +

    Operator Module Functions

    +

    The key-function patterns shown above are very common, so Python provides +convenience functions to make accessor functions easier and faster. The +operator module has itemgetter(), +attrgetter(), and a methodcaller() function.

    +

    Using those functions, the above examples become simpler and faster:

    +
    >>> from operator import itemgetter, attrgetter
    +
    +
    +
    >>> sorted(student_tuples, key=itemgetter(2))
    +[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]
    +
    +
    +
    >>> sorted(student_objects, key=attrgetter('age'))
    +[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]
    +
    +
    +

    The operator module functions allow multiple levels of sorting. For example, to +sort by grade then by age:

    +
    >>> sorted(student_tuples, key=itemgetter(1,2))
    +[('john', 'A', 15), ('dave', 'B', 10), ('jane', 'B', 12)]
    +
    +
    +
    >>> sorted(student_objects, key=attrgetter('grade', 'age'))
    +[('john', 'A', 15), ('dave', 'B', 10), ('jane', 'B', 12)]
    +
    +
    +
    +
    +

    Ascending and Descending

    +

    Both list.sort() and sorted() accept a reverse parameter with a +boolean value. This is used to flag descending sorts. For example, to get the +student data in reverse age order:

    +
    >>> sorted(student_tuples, key=itemgetter(2), reverse=True)
    +[('john', 'A', 15), ('jane', 'B', 12), ('dave', 'B', 10)]
    +
    +
    +
    >>> sorted(student_objects, key=attrgetter('age'), reverse=True)
    +[('john', 'A', 15), ('jane', 'B', 12), ('dave', 'B', 10)]
    +
    +
    +
    +
    +

    Sort Stability and Complex Sorts

    +

    Sorts are guaranteed to be stable. That means that +when multiple records have the same key, their original order is preserved.

    +
    >>> data = [('red', 1), ('blue', 1), ('red', 2), ('blue', 2)]
    +>>> sorted(data, key=itemgetter(0))
    +[('blue', 1), ('blue', 2), ('red', 1), ('red', 2)]
    +
    +
    +

    Notice how the two records for blue retain their original order so that +('blue', 1) is guaranteed to precede ('blue', 2).

    +

    This wonderful property lets you build complex sorts in a series of sorting +steps. For example, to sort the student data by descending grade and then +ascending age, do the age sort first and then sort again using grade:

    +
    >>> s = sorted(student_objects, key=attrgetter('age'))     # sort on secondary key
    +>>> sorted(s, key=attrgetter('grade'), reverse=True)       # now sort on primary key, descending
    +[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]
    +
    +
    +

    The Timsort algorithm used in Python +does multiple sorts efficiently because it can take advantage of any ordering +already present in a dataset.

    +
    +
    +

    The Old Way Using Decorate-Sort-Undecorate

    +

    This idiom is called Decorate-Sort-Undecorate after its three steps:

    +
      +
    • First, the initial list is decorated with new values that control the sort order.

    • +
    • Second, the decorated list is sorted.

    • +
    • Finally, the decorations are removed, creating a list that contains only the +initial values in the new order.

    • +
    +

    For example, to sort the student data by grade using the DSU approach:

    +
    >>> decorated = [(student.grade, i, student) for i, student in enumerate(student_objects)]
    +>>> decorated.sort()
    +>>> [student for grade, i, student in decorated]               # undecorate
    +[('john', 'A', 15), ('jane', 'B', 12), ('dave', 'B', 10)]
    +
    +
    +

    This idiom works because tuples are compared lexicographically; the first items +are compared; if they are the same then the second items are compared, and so +on.

    +

    It is not strictly necessary in all cases to include the index i in the +decorated list, but including it gives two benefits:

    +
      +
    • The sort is stable – if two items have the same key, their order will be +preserved in the sorted list.

    • +
    • The original items do not have to be comparable because the ordering of the +decorated tuples will be determined by at most the first two items. So for +example the original list could contain complex numbers which cannot be sorted +directly.

    • +
    +

    Another name for this idiom is +Schwartzian transform, +after Randal L. Schwartz, who popularized it among Perl programmers.

    +

    Now that Python sorting provides key-functions, this technique is not often needed.

    +
    +
    +

    The Old Way Using the cmp Parameter

    +

    Many constructs given in this HOWTO assume Python 2.4 or later. Before that, +there was no sorted() builtin and list.sort() took no keyword +arguments. Instead, all of the Py2.x versions supported a cmp parameter to +handle user specified comparison functions.

    +

    In Py3.0, the cmp parameter was removed entirely (as part of a larger effort to +simplify and unify the language, eliminating the conflict between rich +comparisons and the __cmp__() magic method).

    +

    In Py2.x, sort allowed an optional function which can be called for doing the +comparisons. That function should take two arguments to be compared and then +return a negative value for less-than, return zero if they are equal, or return +a positive value for greater-than. For example, we can do:

    +
    >>> def numeric_compare(x, y):
    +...     return x - y
    +>>> sorted([5, 2, 4, 1, 3], cmp=numeric_compare) # doctest: +SKIP
    +[1, 2, 3, 4, 5]
    +
    +
    +

    Or you can reverse the order of comparison with:

    +
    >>> def reverse_numeric(x, y):
    +...     return y - x
    +>>> sorted([5, 2, 4, 1, 3], cmp=reverse_numeric) # doctest: +SKIP
    +[5, 4, 3, 2, 1]
    +
    +
    +

    When porting code from Python 2.x to 3.x, the situation can arise when you have +the user supplying a comparison function and you need to convert that to a key +function. The following wrapper makes that easy to do:

    +
    def cmp_to_key(mycmp):
    +    'Convert a cmp= function into a key= function'
    +    class K:
    +        def __init__(self, obj, *args):
    +            self.obj = obj
    +        def __lt__(self, other):
    +            return mycmp(self.obj, other.obj) < 0
    +        def __gt__(self, other):
    +            return mycmp(self.obj, other.obj) > 0
    +        def __eq__(self, other):
    +            return mycmp(self.obj, other.obj) == 0
    +        def __le__(self, other):
    +            return mycmp(self.obj, other.obj) <= 0
    +        def __ge__(self, other):
    +            return mycmp(self.obj, other.obj) >= 0
    +        def __ne__(self, other):
    +            return mycmp(self.obj, other.obj) != 0
    +    return K
    +
    +
    +

    To convert to a key function, just wrap the old comparison function:

    +
    >>> sorted([5, 2, 4, 1, 3], key=cmp_to_key(reverse_numeric))
    +[5, 4, 3, 2, 1]
    +
    +
    +

    In Python 3.2, the functools.cmp_to_key() function was added to the +functools module in the standard library.

    +
    +
    +

    Odd and Ends

    +
      +
    • For locale aware sorting, use locale.strxfrm() for a key function or +locale.strcoll() for a comparison function.

    • +
    • The reverse parameter still maintains sort stability (so that records with +equal keys retain the original order). Interestingly, that effect can be +simulated without the parameter by using the builtin reversed() function +twice:

      +
      >>> data = [('red', 1), ('blue', 1), ('red', 2), ('blue', 2)]
      +>>> standard_way = sorted(data, key=itemgetter(0), reverse=True)
      +>>> double_reversed = list(reversed(sorted(reversed(data), key=itemgetter(0))))
      +>>> assert standard_way == double_reversed
      +>>> standard_way
      +[('red', 1), ('red', 2), ('blue', 1), ('blue', 2)]
      +
      +
      +
    • +
    • The sort routines are guaranteed to use __lt__() when making comparisons +between two objects. So, it is easy to add a standard sort order to a class by +defining an __lt__() method:

      +
      >>> Student.__lt__ = lambda self, other: self.age < other.age
      +>>> sorted(student_objects)
      +[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]
      +
      +
      +
    • +
    • Key functions need not depend directly on the objects being sorted. A key +function can also access external resources. For instance, if the student grades +are stored in a dictionary, they can be used to sort a separate list of student +names:

      +
      >>> students = ['dave', 'john', 'jane']
      +>>> newgrades = {'john': 'F', 'jane':'A', 'dave': 'C'}
      +>>> sorted(students, key=newgrades.__getitem__)
      +['jane', 'dave', 'john']
      +
      +
      +
    • +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/howto/unicode.html b/python-3.7.4-docs-html/howto/unicode.html new file mode 100644 index 0000000..41c12ea --- /dev/null +++ b/python-3.7.4-docs-html/howto/unicode.html @@ -0,0 +1,878 @@ + + + + + + + Unicode HOWTO — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Unicode HOWTO

    +
    +
    Release
    +

    1.12

    +
    +
    +

    This HOWTO discusses Python’s support for the Unicode specification +for representing textual data, and explains various problems that +people commonly encounter when trying to work with Unicode.

    +
    +

    Introduction to Unicode

    +
    +

    Definitions

    +

    Today’s programs need to be able to handle a wide variety of +characters. Applications are often internationalized to display +messages and output in a variety of user-selectable languages; the +same program might need to output an error message in English, French, +Japanese, Hebrew, or Russian. Web content can be written in any of +these languages and can also include a variety of emoji symbols. +Python’s string type uses the Unicode Standard for representing +characters, which lets Python programs work with all these different +possible characters.

    +

    Unicode (https://www.unicode.org/) is a specification that aims to +list every character used by human languages and give each character +its own unique code. The Unicode specifications are continually +revised and updated to add new languages and symbols.

    +

    A character is the smallest possible component of a text. ‘A’, ‘B’, ‘C’, +etc., are all different characters. So are ‘È’ and ‘Í’. Characters vary +depending on the language or context you’re talking +about. For example, there’s a character for “Roman Numeral One”, ‘Ⅰ’, that’s +separate from the uppercase letter ‘I’. They’ll usually look the same, +but these are two different characters that have different meanings.

    +

    The Unicode standard describes how characters are represented by +code points. A code point value is an integer in the range 0 to +0x10FFFF (about 1.1 million values, with some 110 thousand assigned so +far). In the standard and in this document, a code point is written +using the notation U+265E to mean the character with value +0x265e (9,822 in decimal).

    +

    The Unicode standard contains a lot of tables listing characters and +their corresponding code points:

    +
    0061    'a'; LATIN SMALL LETTER A
    +0062    'b'; LATIN SMALL LETTER B
    +0063    'c'; LATIN SMALL LETTER C
    +...
    +007B    '{'; LEFT CURLY BRACKET
    +...
    +2167    'Ⅶ': ROMAN NUMERAL EIGHT
    +2168    'Ⅸ': ROMAN NUMERAL NINE
    +...
    +265E    '♞': BLACK CHESS KNIGHT
    +265F    '♟': BLACK CHESS PAWN
    +...
    +1F600   '😀': GRINNING FACE
    +1F609   '😉': WINKING FACE
    +...
    +
    +
    +

    Strictly, these definitions imply that it’s meaningless to say ‘this is +character U+265E’. U+265E is a code point, which represents some particular +character; in this case, it represents the character ‘BLACK CHESS KNIGHT’, +‘♞’. In +informal contexts, this distinction between code points and characters will +sometimes be forgotten.

    +

    A character is represented on a screen or on paper by a set of graphical +elements that’s called a glyph. The glyph for an uppercase A, for example, +is two diagonal strokes and a horizontal stroke, though the exact details will +depend on the font being used. Most Python code doesn’t need to worry about +glyphs; figuring out the correct glyph to display is generally the job of a GUI +toolkit or a terminal’s font renderer.

    +
    +
    +

    Encodings

    +

    To summarize the previous section: a Unicode string is a sequence of +code points, which are numbers from 0 through 0x10FFFF (1,114,111 +decimal). This sequence of code points needs to be represented in +memory as a set of code units, and code units are then mapped +to 8-bit bytes. The rules for translating a Unicode string into a +sequence of bytes are called a character encoding, or just +an encoding.

    +

    The first encoding you might think of is using 32-bit integers as the +code unit, and then using the CPU’s representation of 32-bit integers. +In this representation, the string “Python” might look like this:

    +
       P           y           t           h           o           n
    +0x50 00 00 00 79 00 00 00 74 00 00 00 68 00 00 00 6f 00 00 00 6e 00 00 00
    +   0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
    +
    +
    +

    This representation is straightforward but using it presents a number of +problems.

    +
      +
    1. It’s not portable; different processors order the bytes differently.

    2. +
    3. It’s very wasteful of space. In most texts, the majority of the code points +are less than 127, or less than 255, so a lot of space is occupied by 0x00 +bytes. The above string takes 24 bytes compared to the 6 bytes needed for an +ASCII representation. Increased RAM usage doesn’t matter too much (desktop +computers have gigabytes of RAM, and strings aren’t usually that large), but +expanding our usage of disk and network bandwidth by a factor of 4 is +intolerable.

    4. +
    5. It’s not compatible with existing C functions such as strlen(), so a new +family of wide string functions would need to be used.

    6. +
    +

    Therefore this encoding isn’t used very much, and people instead choose other +encodings that are more efficient and convenient, such as UTF-8.

    +

    UTF-8 is one of the most commonly used encodings, and Python often +defaults to using it. UTF stands for “Unicode Transformation Format”, +and the ‘8’ means that 8-bit values are used in the encoding. (There +are also UTF-16 and UTF-32 encodings, but they are less frequently +used than UTF-8.) UTF-8 uses the following rules:

    +
      +
    1. If the code point is < 128, it’s represented by the corresponding byte value.

    2. +
    3. If the code point is >= 128, it’s turned into a sequence of two, three, or +four bytes, where each byte of the sequence is between 128 and 255.

    4. +
    +

    UTF-8 has several convenient properties:

    +
      +
    1. It can handle any Unicode code point.

    2. +
    3. A Unicode string is turned into a sequence of bytes that contains embedded +zero bytes only where they represent the null character (U+0000). This means +that UTF-8 strings can be processed by C functions such as strcpy() and sent +through protocols that can’t handle zero bytes for anything other than +end-of-string markers.

    4. +
    5. A string of ASCII text is also valid UTF-8 text.

    6. +
    7. UTF-8 is fairly compact; the majority of commonly used characters can be +represented with one or two bytes.

    8. +
    9. If bytes are corrupted or lost, it’s possible to determine the start of the +next UTF-8-encoded code point and resynchronize. It’s also unlikely that +random 8-bit data will look like valid UTF-8.

    10. +
    11. UTF-8 is a byte oriented encoding. The encoding specifies that each +character is represented by a specific sequence of one or more bytes. This +avoids the byte-ordering issues that can occur with integer and word oriented +encodings, like UTF-16 and UTF-32, where the sequence of bytes varies depending +on the hardware on which the string was encoded.

    12. +
    +
    +
    +

    References

    +

    The Unicode Consortium site has character charts, a +glossary, and PDF versions of the Unicode specification. Be prepared for some +difficult reading. A chronology of the +origin and development of Unicode is also available on the site.

    +

    On the Computerphile Youtube channel, Tom Scott briefly +discusses the history of Unicode and UTF-8 <https://www.youtube.com/watch?v=MijmeoH9LT4> +(9 minutes 36 seconds).

    +

    To help understand the standard, Jukka Korpela has written an introductory +guide to reading the +Unicode character tables.

    +

    Another good introductory article +was written by Joel Spolsky. +If this introduction didn’t make things clear to you, you should try +reading this alternate article before continuing.

    +

    Wikipedia entries are often helpful; see the entries for “character encoding” and UTF-8, for example.

    +
    +
    +
    +

    Python’s Unicode Support

    +

    Now that you’ve learned the rudiments of Unicode, we can look at Python’s +Unicode features.

    +
    +

    The String Type

    +

    Since Python 3.0, the language’s str type contains Unicode +characters, meaning any string created using "unicode rocks!", 'unicode +rocks!', or the triple-quoted string syntax is stored as Unicode.

    +

    The default encoding for Python source code is UTF-8, so you can simply +include a Unicode character in a string literal:

    +
    try:
    +    with open('/tmp/input.txt', 'r') as f:
    +        ...
    +except OSError:
    +    # 'File not found' error message.
    +    print("Fichier non trouvé")
    +
    +
    +

    Side note: Python 3 also supports using Unicode characters in identifiers:

    +
    répertoire = "/tmp/records.log"
    +with open(répertoire, "w") as f:
    +    f.write("test\n")
    +
    +
    +

    If you can’t enter a particular character in your editor or want to +keep the source code ASCII-only for some reason, you can also use +escape sequences in string literals. (Depending on your system, +you may see the actual capital-delta glyph instead of a u escape.)

    +
    >>> "\N{GREEK CAPITAL LETTER DELTA}"  # Using the character name
    +'\u0394'
    +>>> "\u0394"                          # Using a 16-bit hex value
    +'\u0394'
    +>>> "\U00000394"                      # Using a 32-bit hex value
    +'\u0394'
    +
    +
    +

    In addition, one can create a string using the decode() method of +bytes. This method takes an encoding argument, such as UTF-8, +and optionally an errors argument.

    +

    The errors argument specifies the response when the input string can’t be +converted according to the encoding’s rules. Legal values for this argument are +'strict' (raise a UnicodeDecodeError exception), 'replace' (use +U+FFFD, REPLACEMENT CHARACTER), 'ignore' (just leave the +character out of the Unicode result), or 'backslashreplace' (inserts a +\xNN escape sequence). +The following examples show the differences:

    +
    >>> b'\x80abc'.decode("utf-8", "strict")  
    +Traceback (most recent call last):
    +    ...
    +UnicodeDecodeError: 'utf-8' codec can't decode byte 0x80 in position 0:
    +  invalid start byte
    +>>> b'\x80abc'.decode("utf-8", "replace")
    +'\ufffdabc'
    +>>> b'\x80abc'.decode("utf-8", "backslashreplace")
    +'\\x80abc'
    +>>> b'\x80abc'.decode("utf-8", "ignore")
    +'abc'
    +
    +
    +

    Encodings are specified as strings containing the encoding’s name. Python +comes with roughly 100 different encodings; see the Python Library Reference at +Standard Encodings for a list. Some encodings have multiple names; for +example, 'latin-1', 'iso_8859_1' and '8859’ are all synonyms for +the same encoding.

    +

    One-character Unicode strings can also be created with the chr() +built-in function, which takes integers and returns a Unicode string of length 1 +that contains the corresponding code point. The reverse operation is the +built-in ord() function that takes a one-character Unicode string and +returns the code point value:

    +
    >>> chr(57344)
    +'\ue000'
    +>>> ord('\ue000')
    +57344
    +
    +
    +
    +
    +

    Converting to Bytes

    +

    The opposite method of bytes.decode() is str.encode(), +which returns a bytes representation of the Unicode string, encoded in the +requested encoding.

    +

    The errors parameter is the same as the parameter of the +decode() method but supports a few more possible handlers. As well as +'strict', 'ignore', and 'replace' (which in this case +inserts a question mark instead of the unencodable character), there is +also 'xmlcharrefreplace' (inserts an XML character reference), +backslashreplace (inserts a \uNNNN escape sequence) and +namereplace (inserts a \N{...} escape sequence).

    +

    The following example shows the different results:

    +
    >>> u = chr(40960) + 'abcd' + chr(1972)
    +>>> u.encode('utf-8')
    +b'\xea\x80\x80abcd\xde\xb4'
    +>>> u.encode('ascii')  
    +Traceback (most recent call last):
    +    ...
    +UnicodeEncodeError: 'ascii' codec can't encode character '\ua000' in
    +  position 0: ordinal not in range(128)
    +>>> u.encode('ascii', 'ignore')
    +b'abcd'
    +>>> u.encode('ascii', 'replace')
    +b'?abcd?'
    +>>> u.encode('ascii', 'xmlcharrefreplace')
    +b'&#40960;abcd&#1972;'
    +>>> u.encode('ascii', 'backslashreplace')
    +b'\\ua000abcd\\u07b4'
    +>>> u.encode('ascii', 'namereplace')
    +b'\\N{YI SYLLABLE IT}abcd\\u07b4'
    +
    +
    +

    The low-level routines for registering and accessing the available +encodings are found in the codecs module. Implementing new +encodings also requires understanding the codecs module. +However, the encoding and decoding functions returned by this module +are usually more low-level than is comfortable, and writing new encodings +is a specialized task, so the module won’t be covered in this HOWTO.

    +
    +
    +

    Unicode Literals in Python Source Code

    +

    In Python source code, specific Unicode code points can be written using the +\u escape sequence, which is followed by four hex digits giving the code +point. The \U escape sequence is similar, but expects eight hex digits, +not four:

    +
    >>> s = "a\xac\u1234\u20ac\U00008000"
    +... #     ^^^^ two-digit hex escape
    +... #         ^^^^^^ four-digit Unicode escape
    +... #                     ^^^^^^^^^^ eight-digit Unicode escape
    +>>> [ord(c) for c in s]
    +[97, 172, 4660, 8364, 32768]
    +
    +
    +

    Using escape sequences for code points greater than 127 is fine in small doses, +but becomes an annoyance if you’re using many accented characters, as you would +in a program with messages in French or some other accent-using language. You +can also assemble strings using the chr() built-in function, but this is +even more tedious.

    +

    Ideally, you’d want to be able to write literals in your language’s natural +encoding. You could then edit Python source code with your favorite editor +which would display the accented characters naturally, and have the right +characters used at runtime.

    +

    Python supports writing source code in UTF-8 by default, but you can use almost +any encoding if you declare the encoding being used. This is done by including +a special comment as either the first or second line of the source file:

    +
    #!/usr/bin/env python
    +# -*- coding: latin-1 -*-
    +
    +u = 'abcdé'
    +print(ord(u[-1]))
    +
    +
    +

    The syntax is inspired by Emacs’s notation for specifying variables local to a +file. Emacs supports many different variables, but Python only supports +‘coding’. The -*- symbols indicate to Emacs that the comment is special; +they have no significance to Python but are a convention. Python looks for +coding: name or coding=name in the comment.

    +

    If you don’t include such a comment, the default encoding used will be UTF-8 as +already mentioned. See also PEP 263 for more information.

    +
    +
    +

    Unicode Properties

    +

    The Unicode specification includes a database of information about +code points. For each defined code point, the information includes +the character’s name, its category, the numeric value if applicable +(for characters representing numeric concepts such as the Roman +numerals, fractions such as one-third and four-fifths, etc.). There +are also display-related properties, such as how to use the code point +in bidirectional text.

    +

    The following program displays some information about several characters, and +prints the numeric value of one particular character:

    +
    import unicodedata
    +
    +u = chr(233) + chr(0x0bf2) + chr(3972) + chr(6000) + chr(13231)
    +
    +for i, c in enumerate(u):
    +    print(i, '%04x' % ord(c), unicodedata.category(c), end=" ")
    +    print(unicodedata.name(c))
    +
    +# Get numeric value of second character
    +print(unicodedata.numeric(u[1]))
    +
    +
    +

    When run, this prints:

    +
    0 00e9 Ll LATIN SMALL LETTER E WITH ACUTE
    +1 0bf2 No TAMIL NUMBER ONE THOUSAND
    +2 0f84 Mn TIBETAN MARK HALANTA
    +3 1770 Lo TAGBANWA LETTER SA
    +4 33af So SQUARE RAD OVER S SQUARED
    +1000.0
    +
    +
    +

    The category codes are abbreviations describing the nature of the character. +These are grouped into categories such as “Letter”, “Number”, “Punctuation”, or +“Symbol”, which in turn are broken up into subcategories. To take the codes +from the above output, 'Ll' means ‘Letter, lowercase’, 'No' means +“Number, other”, 'Mn' is “Mark, nonspacing”, and 'So' is “Symbol, +other”. See +the General Category Values section of the Unicode Character Database documentation for a +list of category codes.

    +
    +
    +

    Comparing Strings

    +

    Unicode adds some complication to comparing strings, because the same +set of characters can be represented by different sequences of code +points. For example, a letter like ‘ê’ can be represented as a single +code point U+00EA, or as U+0065 U+0302, which is the code point for +‘e’ followed by a code point for ‘COMBINING CIRCUMFLEX ACCENT’. These +will produce the same output when printed, but one is a string of +length 1 and the other is of length 2.

    +

    One tool for a case-insensitive comparison is the +casefold() string method that converts a string to a +case-insensitive form following an algorithm described by the Unicode +Standard. This algorithm has special handling for characters such as +the German letter ‘ß’ (code point U+00DF), which becomes the pair of +lowercase letters ‘ss’.

    +
    >>> street = 'Gürzenichstraße'
    +>>> street.casefold()
    +'gürzenichstrasse'
    +
    +
    +

    A second tool is the unicodedata module’s +normalize() function that converts strings to one +of several normal forms, where letters followed by a combining +character are replaced with single characters. normalize() can +be used to perform string comparisons that won’t falsely report +inequality if two strings use combining characters differently:

    +
    import unicodedata
    +
    +def compare_strs(s1, s2):
    +    def NFD(s):
    +        return unicodedata.normalize('NFD', s)
    +
    +    return NFD(s1) == NFD(s2)
    +
    +single_char = 'ê'
    +multiple_chars = '\N{LATIN SMALL LETTER E}\N{COMBINING CIRCUMFLEX ACCENT}'
    +print('length of first string=', len(single_char))
    +print('length of second string=', len(multiple_chars))
    +print(compare_strs(single_char, multiple_chars))
    +
    +
    +

    When run, this outputs:

    +
    $ python3 compare-strs.py
    +length of first string= 1
    +length of second string= 2
    +True
    +
    +
    +

    The first argument to the normalize() function is a +string giving the desired normalization form, which can be one of +‘NFC’, ‘NFKC’, ‘NFD’, and ‘NFKD’.

    +

    The Unicode Standard also specifies how to do caseless comparisons:

    +
    import unicodedata
    +
    +def compare_caseless(s1, s2):
    +    def NFD(s):
    +        return unicodedata.normalize('NFD', s)
    +
    +    return NFD(NFD(s1).casefold()) == NFD(NFD(s2).casefold())
    +
    +# Example usage
    +single_char = 'ê'
    +multiple_chars = '\N{LATIN CAPITAL LETTER E}\N{COMBINING CIRCUMFLEX ACCENT}'
    +
    +print(compare_caseless(single_char, multiple_chars))
    +
    +
    +

    This will print True. (Why is NFD() invoked twice? Because +there are a few characters that make casefold() return a +non-normalized string, so the result needs to be normalized again. See +section 3.13 of the Unicode Standard for a discussion and an example.)

    +
    +
    +

    Unicode Regular Expressions

    +

    The regular expressions supported by the re module can be provided +either as bytes or strings. Some of the special character sequences such as +\d and \w have different meanings depending on whether +the pattern is supplied as bytes or a string. For example, +\d will match the characters [0-9] in bytes but +in strings will match any character that’s in the 'Nd' category.

    +

    The string in this example has the number 57 written in both Thai and +Arabic numerals:

    +
    import re
    +p = re.compile(r'\d+')
    +
    +s = "Over \u0e55\u0e57 57 flavours"
    +m = p.search(s)
    +print(repr(m.group()))
    +
    +
    +

    When executed, \d+ will match the Thai numerals and print them +out. If you supply the re.ASCII flag to +compile(), \d+ will match the substring “57” instead.

    +

    Similarly, \w matches a wide variety of Unicode characters but +only [a-zA-Z0-9_] in bytes or if re.ASCII is supplied, +and \s will match either Unicode whitespace characters or +[ \t\n\r\f\v].

    +
    +
    +

    References

    +

    Some good alternative discussions of Python’s Unicode support are:

    + +

    The str type is described in the Python library reference at +Text Sequence Type — str.

    +

    The documentation for the unicodedata module.

    +

    The documentation for the codecs module.

    +

    Marc-André Lemburg gave a presentation titled “Python and Unicode” (PDF slides) at +EuroPython 2002. The slides are an excellent overview of the design of Python +2’s Unicode features (where the Unicode string type is called unicode and +literals start with u).

    +
    +
    +
    +

    Reading and Writing Unicode Data

    +

    Once you’ve written some code that works with Unicode data, the next problem is +input/output. How do you get Unicode strings into your program, and how do you +convert Unicode into a form suitable for storage or transmission?

    +

    It’s possible that you may not need to do anything depending on your input +sources and output destinations; you should check whether the libraries used in +your application support Unicode natively. XML parsers often return Unicode +data, for example. Many relational databases also support Unicode-valued +columns and can return Unicode values from an SQL query.

    +

    Unicode data is usually converted to a particular encoding before it gets +written to disk or sent over a socket. It’s possible to do all the work +yourself: open a file, read an 8-bit bytes object from it, and convert the bytes +with bytes.decode(encoding). However, the manual approach is not recommended.

    +

    One problem is the multi-byte nature of encodings; one Unicode character can be +represented by several bytes. If you want to read the file in arbitrary-sized +chunks (say, 1024 or 4096 bytes), you need to write error-handling code to catch the case +where only part of the bytes encoding a single Unicode character are read at the +end of a chunk. One solution would be to read the entire file into memory and +then perform the decoding, but that prevents you from working with files that +are extremely large; if you need to read a 2 GiB file, you need 2 GiB of RAM. +(More, really, since for at least a moment you’d need to have both the encoded +string and its Unicode version in memory.)

    +

    The solution would be to use the low-level decoding interface to catch the case +of partial coding sequences. The work of implementing this has already been +done for you: the built-in open() function can return a file-like object +that assumes the file’s contents are in a specified encoding and accepts Unicode +parameters for methods such as read() and +write(). This works through open()’s encoding and +errors parameters which are interpreted just like those in str.encode() +and bytes.decode().

    +

    Reading Unicode from a file is therefore simple:

    +
    with open('unicode.txt', encoding='utf-8') as f:
    +    for line in f:
    +        print(repr(line))
    +
    +
    +

    It’s also possible to open files in update mode, allowing both reading and +writing:

    +
    with open('test', encoding='utf-8', mode='w+') as f:
    +    f.write('\u4500 blah blah blah\n')
    +    f.seek(0)
    +    print(repr(f.readline()[:1]))
    +
    +
    +

    The Unicode character U+FEFF is used as a byte-order mark (BOM), and is often +written as the first character of a file in order to assist with autodetection +of the file’s byte ordering. Some encodings, such as UTF-16, expect a BOM to be +present at the start of a file; when such an encoding is used, the BOM will be +automatically written as the first character and will be silently dropped when +the file is read. There are variants of these encodings, such as ‘utf-16-le’ +and ‘utf-16-be’ for little-endian and big-endian encodings, that specify one +particular byte ordering and don’t skip the BOM.

    +

    In some areas, it is also convention to use a “BOM” at the start of UTF-8 +encoded files; the name is misleading since UTF-8 is not byte-order dependent. +The mark simply announces that the file is encoded in UTF-8. For reading such +files, use the ‘utf-8-sig’ codec to automatically skip the mark if present.

    +
    +

    Unicode filenames

    +

    Most of the operating systems in common use today support filenames +that contain arbitrary Unicode characters. Usually this is +implemented by converting the Unicode string into some encoding that +varies depending on the system. Today Python is converging on using +UTF-8: Python on MacOS has used UTF-8 for several versions, and Python +3.6 switched to using UTF-8 on Windows as well. On Unix systems, +there will only be a filesystem encoding if you’ve set the LANG or +LC_CTYPE environment variables; if you haven’t, the default +encoding is again UTF-8.

    +

    The sys.getfilesystemencoding() function returns the encoding to use on +your current system, in case you want to do the encoding manually, but there’s +not much reason to bother. When opening a file for reading or writing, you can +usually just provide the Unicode string as the filename, and it will be +automatically converted to the right encoding for you:

    +
    filename = 'filename\u4500abc'
    +with open(filename, 'w') as f:
    +    f.write('blah\n')
    +
    +
    +

    Functions in the os module such as os.stat() will also accept Unicode +filenames.

    +

    The os.listdir() function returns filenames, which raises an issue: should it return +the Unicode version of filenames, or should it return bytes containing +the encoded versions? os.listdir() can do both, depending on whether you +provided the directory path as bytes or a Unicode string. If you pass a +Unicode string as the path, filenames will be decoded using the filesystem’s +encoding and a list of Unicode strings will be returned, while passing a byte +path will return the filenames as bytes. For example, +assuming the default filesystem encoding is UTF-8, running the following +program:

    +
    fn = 'filename\u4500abc'
    +f = open(fn, 'w')
    +f.close()
    +
    +import os
    +print(os.listdir(b'.'))
    +print(os.listdir('.'))
    +
    +
    +

    will produce the following output:

    +
    $ python listdir-test.py
    +[b'filename\xe4\x94\x80abc', ...]
    +['filename\u4500abc', ...]
    +
    +
    +

    The first list contains UTF-8-encoded filenames, and the second list contains +the Unicode versions.

    +

    Note that on most occasions, you should can just stick with using +Unicode with these APIs. The bytes APIs should only be used on +systems where undecodable file names can be present; that’s +pretty much only Unix systems now.

    +
    +
    +

    Tips for Writing Unicode-aware Programs

    +

    This section provides some suggestions on writing software that deals with +Unicode.

    +

    The most important tip is:

    +
    +

    Software should only work with Unicode strings internally, decoding the input +data as soon as possible and encoding the output only at the end.

    +
    +

    If you attempt to write processing functions that accept both Unicode and byte +strings, you will find your program vulnerable to bugs wherever you combine the +two different kinds of strings. There is no automatic encoding or decoding: if +you do e.g. str + bytes, a TypeError will be raised.

    +

    When using data coming from a web browser or some other untrusted source, a +common technique is to check for illegal characters in a string before using the +string in a generated command line or storing it in a database. If you’re doing +this, be careful to check the decoded string, not the encoded bytes data; +some encodings may have interesting properties, such as not being bijective +or not being fully ASCII-compatible. This is especially true if the input +data also specifies the encoding, since the attacker can then choose a +clever way to hide malicious text in the encoded bytestream.

    +
    +

    Converting Between File Encodings

    +

    The StreamRecoder class can transparently convert between +encodings, taking a stream that returns data in encoding #1 +and behaving like a stream returning data in encoding #2.

    +

    For example, if you have an input file f that’s in Latin-1, you +can wrap it with a StreamRecoder to return bytes encoded in +UTF-8:

    +
    new_f = codecs.StreamRecoder(f,
    +    # en/decoder: used by read() to encode its results and
    +    # by write() to decode its input.
    +    codecs.getencoder('utf-8'), codecs.getdecoder('utf-8'),
    +
    +    # reader/writer: used to read and write to the stream.
    +    codecs.getreader('latin-1'), codecs.getwriter('latin-1') )
    +
    +
    +
    +
    +

    Files in an Unknown Encoding

    +

    What can you do if you need to make a change to a file, but don’t know +the file’s encoding? If you know the encoding is ASCII-compatible and +only want to examine or modify the ASCII parts, you can open the file +with the surrogateescape error handler:

    +
    with open(fname, 'r', encoding="ascii", errors="surrogateescape") as f:
    +    data = f.read()
    +
    +# make changes to the string 'data'
    +
    +with open(fname + '.new', 'w',
    +          encoding="ascii", errors="surrogateescape") as f:
    +    f.write(data)
    +
    +
    +

    The surrogateescape error handler will decode any non-ASCII bytes +as code points in a special range running from U+DC80 to +U+DCFF. These code points will then turn back into the +same bytes when the surrogateescape error handler is used to +encode the data and write it back out.

    +
    +
    +
    +

    References

    +

    One section of Mastering Python 3 Input/Output, +a PyCon 2010 talk by David Beazley, discusses text processing and binary data handling.

    +

    The PDF slides for Marc-André Lemburg’s presentation “Writing Unicode-aware +Applications in Python” +discuss questions of character encodings as well as how to internationalize +and localize an application. These slides cover Python 2.x only.

    +

    The Guts of Unicode in Python +is a PyCon 2013 talk by Benjamin Peterson that discusses the internal Unicode +representation in Python 3.3.

    +
    +
    +
    +

    Acknowledgements

    +

    The initial draft of this document was written by Andrew Kuchling. +It has since been revised further by Alexander Belopolsky, Georg Brandl, +Andrew Kuchling, and Ezio Melotti.

    +

    Thanks to the following people who have noted errors or offered +suggestions on this article: Éric Araujo, Nicholas Bastin, Nick +Coghlan, Marius Gedminas, Kent Johnson, Ken Krugler, Marc-André +Lemburg, Martin von Löwis, Terry J. Reedy, Serhiy Storchaka, +Eryk Sun, Chad Whitacre, Graham Wideman.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/howto/urllib2.html b/python-3.7.4-docs-html/howto/urllib2.html new file mode 100644 index 0000000..0f20b8f --- /dev/null +++ b/python-3.7.4-docs-html/howto/urllib2.html @@ -0,0 +1,770 @@ + + + + + + + HOWTO Fetch Internet Resources Using The urllib Package — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    HOWTO Fetch Internet Resources Using The urllib Package

    +
    +
    Author
    +

    Michael Foord

    +
    +
    +
    +

    Note

    +

    There is a French translation of an earlier revision of this +HOWTO, available at urllib2 - Le Manuel manquant.

    +
    +
    +

    Introduction

    + +

    urllib.request is a Python module for fetching URLs +(Uniform Resource Locators). It offers a very simple interface, in the form of +the urlopen function. This is capable of fetching URLs using a variety of +different protocols. It also offers a slightly more complex interface for +handling common situations - like basic authentication, cookies, proxies and so +on. These are provided by objects called handlers and openers.

    +

    urllib.request supports fetching URLs for many “URL schemes” (identified by the string +before the ":" in URL - for example "ftp" is the URL scheme of +"ftp://python.org/") using their associated network protocols (e.g. FTP, HTTP). +This tutorial focuses on the most common case, HTTP.

    +

    For straightforward situations urlopen is very easy to use. But as soon as you +encounter errors or non-trivial cases when opening HTTP URLs, you will need some +understanding of the HyperText Transfer Protocol. The most comprehensive and +authoritative reference to HTTP is RFC 2616. This is a technical document and +not intended to be easy to read. This HOWTO aims to illustrate using urllib, +with enough detail about HTTP to help you through. It is not intended to replace +the urllib.request docs, but is supplementary to them.

    +
    +
    +

    Fetching URLs

    +

    The simplest way to use urllib.request is as follows:

    +
    import urllib.request
    +with urllib.request.urlopen('http://python.org/') as response:
    +   html = response.read()
    +
    +
    +

    If you wish to retrieve a resource via URL and store it in a temporary +location, you can do so via the shutil.copyfileobj() and +tempfile.NamedTemporaryFile() functions:

    +
    import shutil
    +import tempfile
    +import urllib.request
    +
    +with urllib.request.urlopen('http://python.org/') as response:
    +    with tempfile.NamedTemporaryFile(delete=False) as tmp_file:
    +        shutil.copyfileobj(response, tmp_file)
    +
    +with open(tmp_file.name) as html:
    +    pass
    +
    +
    +

    Many uses of urllib will be that simple (note that instead of an ‘http:’ URL we +could have used a URL starting with ‘ftp:’, ‘file:’, etc.). However, it’s the +purpose of this tutorial to explain the more complicated cases, concentrating on +HTTP.

    +

    HTTP is based on requests and responses - the client makes requests and servers +send responses. urllib.request mirrors this with a Request object which represents +the HTTP request you are making. In its simplest form you create a Request +object that specifies the URL you want to fetch. Calling urlopen with this +Request object returns a response object for the URL requested. This response is +a file-like object, which means you can for example call .read() on the +response:

    +
    import urllib.request
    +
    +req = urllib.request.Request('http://www.voidspace.org.uk')
    +with urllib.request.urlopen(req) as response:
    +   the_page = response.read()
    +
    +
    +

    Note that urllib.request makes use of the same Request interface to handle all URL +schemes. For example, you can make an FTP request like so:

    +
    req = urllib.request.Request('ftp://example.com/')
    +
    +
    +

    In the case of HTTP, there are two extra things that Request objects allow you +to do: First, you can pass data to be sent to the server. Second, you can pass +extra information (“metadata”) about the data or the about request itself, to +the server - this information is sent as HTTP “headers”. Let’s look at each of +these in turn.

    +
    +

    Data

    +

    Sometimes you want to send data to a URL (often the URL will refer to a CGI +(Common Gateway Interface) script or other web application). With HTTP, +this is often done using what’s known as a POST request. This is often what +your browser does when you submit a HTML form that you filled in on the web. Not +all POSTs have to come from forms: you can use a POST to transmit arbitrary data +to your own application. In the common case of HTML forms, the data needs to be +encoded in a standard way, and then passed to the Request object as the data +argument. The encoding is done using a function from the urllib.parse +library.

    +
    import urllib.parse
    +import urllib.request
    +
    +url = 'http://www.someserver.com/cgi-bin/register.cgi'
    +values = {'name' : 'Michael Foord',
    +          'location' : 'Northampton',
    +          'language' : 'Python' }
    +
    +data = urllib.parse.urlencode(values)
    +data = data.encode('ascii') # data should be bytes
    +req = urllib.request.Request(url, data)
    +with urllib.request.urlopen(req) as response:
    +   the_page = response.read()
    +
    +
    +

    Note that other encodings are sometimes required (e.g. for file upload from HTML +forms - see HTML Specification, Form Submission for more +details).

    +

    If you do not pass the data argument, urllib uses a GET request. One +way in which GET and POST requests differ is that POST requests often have +“side-effects”: they change the state of the system in some way (for example by +placing an order with the website for a hundredweight of tinned spam to be +delivered to your door). Though the HTTP standard makes it clear that POSTs are +intended to always cause side-effects, and GET requests never to cause +side-effects, nothing prevents a GET request from having side-effects, nor a +POST requests from having no side-effects. Data can also be passed in an HTTP +GET request by encoding it in the URL itself.

    +

    This is done as follows:

    +
    >>> import urllib.request
    +>>> import urllib.parse
    +>>> data = {}
    +>>> data['name'] = 'Somebody Here'
    +>>> data['location'] = 'Northampton'
    +>>> data['language'] = 'Python'
    +>>> url_values = urllib.parse.urlencode(data)
    +>>> print(url_values)  # The order may differ from below.  
    +name=Somebody+Here&language=Python&location=Northampton
    +>>> url = 'http://www.example.com/example.cgi'
    +>>> full_url = url + '?' + url_values
    +>>> data = urllib.request.urlopen(full_url)
    +
    +
    +

    Notice that the full URL is created by adding a ? to the URL, followed by +the encoded values.

    +
    +
    +

    Headers

    +

    We’ll discuss here one particular HTTP header, to illustrate how to add headers +to your HTTP request.

    +

    Some websites 1 dislike being browsed by programs, or send different versions +to different browsers 2. By default urllib identifies itself as +Python-urllib/x.y (where x and y are the major and minor version +numbers of the Python release, +e.g. Python-urllib/2.5), which may confuse the site, or just plain +not work. The way a browser identifies itself is through the +User-Agent header 3. When you create a Request object you can +pass a dictionary of headers in. The following example makes the same +request as above, but identifies itself as a version of Internet +Explorer 4.

    +
    import urllib.parse
    +import urllib.request
    +
    +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}
    +
    +data = urllib.parse.urlencode(values)
    +data = data.encode('ascii')
    +req = urllib.request.Request(url, data, headers)
    +with urllib.request.urlopen(req) as response:
    +   the_page = response.read()
    +
    +
    +

    The response also has two useful methods. See the section on info and geturl +which comes after we have a look at what happens when things go wrong.

    +
    +
    +
    +

    Handling Exceptions

    +

    urlopen raises URLError when it cannot handle a response (though as +usual with Python APIs, built-in exceptions such as ValueError, +TypeError etc. may also be raised).

    +

    HTTPError is the subclass of URLError raised in the specific case of +HTTP URLs.

    +

    The exception classes are exported from the urllib.error module.

    +
    +

    URLError

    +

    Often, URLError is raised because there is no network connection (no route to +the specified server), or the specified server doesn’t exist. In this case, the +exception raised will have a ‘reason’ attribute, which is a tuple containing an +error code and a text error message.

    +

    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)      
    +...
    +(4, 'getaddrinfo failed')
    +
    +
    +
    +
    +

    HTTPError

    +

    Every HTTP response from the server contains a numeric “status code”. Sometimes +the status code indicates that the server is unable to fulfil the request. The +default handlers will handle some of these responses for you (for example, if +the response is a “redirection” that requests the client fetch the document from +a different URL, urllib will handle that for you). For those it can’t handle, +urlopen will raise an HTTPError. Typical errors include ‘404’ (page not +found), ‘403’ (request forbidden), and ‘401’ (authentication required).

    +

    See section 10 of RFC 2616 for a reference on all the HTTP error codes.

    +

    The HTTPError instance raised will have an integer ‘code’ attribute, which +corresponds to the error sent by the server.

    +
    +

    Error Codes

    +

    Because the default handlers handle redirects (codes in the 300 range), and +codes in the 100–299 range indicate success, you will usually only see error +codes in the 400–599 range.

    +

    http.server.BaseHTTPRequestHandler.responses is a useful dictionary of +response codes in that shows all the response codes used by RFC 2616. The +dictionary is reproduced here for convenience

    +
    # Table mapping response codes to messages; entries have the
    +# form {code: (shortmessage, longmessage)}.
    +responses = {
    +    100: ('Continue', 'Request received, please continue'),
    +    101: ('Switching Protocols',
    +          'Switching to new protocol; obey Upgrade header'),
    +
    +    200: ('OK', 'Request fulfilled, document follows'),
    +    201: ('Created', 'Document created, URL follows'),
    +    202: ('Accepted',
    +          'Request accepted, processing continues off-line'),
    +    203: ('Non-Authoritative Information', 'Request fulfilled from cache'),
    +    204: ('No Content', 'Request fulfilled, nothing follows'),
    +    205: ('Reset Content', 'Clear input form for further input.'),
    +    206: ('Partial Content', 'Partial content follows.'),
    +
    +    300: ('Multiple Choices',
    +          'Object has several resources -- see URI list'),
    +    301: ('Moved Permanently', 'Object moved permanently -- see URI list'),
    +    302: ('Found', 'Object moved temporarily -- see URI list'),
    +    303: ('See Other', 'Object moved -- see Method and URL list'),
    +    304: ('Not Modified',
    +          'Document has not changed since given time'),
    +    305: ('Use Proxy',
    +          'You must use proxy specified in Location to access this '
    +          'resource.'),
    +    307: ('Temporary Redirect',
    +          'Object moved temporarily -- see URI list'),
    +
    +    400: ('Bad Request',
    +          'Bad request syntax or unsupported method'),
    +    401: ('Unauthorized',
    +          'No permission -- see authorization schemes'),
    +    402: ('Payment Required',
    +          'No payment -- see charging schemes'),
    +    403: ('Forbidden',
    +          'Request forbidden -- authorization will not help'),
    +    404: ('Not Found', 'Nothing matches the given URI'),
    +    405: ('Method Not Allowed',
    +          'Specified method is invalid for this server.'),
    +    406: ('Not Acceptable', 'URI not available in preferred format.'),
    +    407: ('Proxy Authentication Required', 'You must authenticate with '
    +          'this proxy before proceeding.'),
    +    408: ('Request Timeout', 'Request timed out; try again later.'),
    +    409: ('Conflict', 'Request conflict.'),
    +    410: ('Gone',
    +          'URI no longer exists and has been permanently removed.'),
    +    411: ('Length Required', 'Client must specify Content-Length.'),
    +    412: ('Precondition Failed', 'Precondition in headers is false.'),
    +    413: ('Request Entity Too Large', 'Entity is too large.'),
    +    414: ('Request-URI Too Long', 'URI is too long.'),
    +    415: ('Unsupported Media Type', 'Entity body in unsupported format.'),
    +    416: ('Requested Range Not Satisfiable',
    +          'Cannot satisfy request range.'),
    +    417: ('Expectation Failed',
    +          'Expect condition could not be satisfied.'),
    +
    +    500: ('Internal Server Error', 'Server got itself in trouble'),
    +    501: ('Not Implemented',
    +          'Server does not support this operation'),
    +    502: ('Bad Gateway', 'Invalid responses from another server/proxy.'),
    +    503: ('Service Unavailable',
    +          'The server cannot process the request due to a high load'),
    +    504: ('Gateway Timeout',
    +          'The gateway server did not receive a timely response'),
    +    505: ('HTTP Version Not Supported', 'Cannot fulfill request.'),
    +    }
    +
    +
    +

    When an error is raised the server responds by returning an HTTP error code +and an error page. You can use the HTTPError instance as a response on the +page returned. This means that as well as the code attribute, it also has read, +geturl, and info, methods as returned by the urllib.response module:

    +
    >>> req = urllib.request.Request('http://www.python.org/fish.html')
    +>>> try:
    +...     urllib.request.urlopen(req)
    +... except urllib.error.HTTPError as e:
    +...     print(e.code)
    +...     print(e.read())  
    +...
    +404
    +b'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    +  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n\n\n<html
    +  ...
    +  <title>Page Not Found</title>\n
    +  ...
    +
    +
    +
    +
    +
    +

    Wrapping it Up

    +

    So if you want to be prepared for HTTPError or URLError there are two +basic approaches. I prefer the second approach.

    +
    +

    Number 1

    +
    from urllib.request import Request, urlopen
    +from urllib.error import URLError, HTTPError
    +req = Request(someurl)
    +try:
    +    response = urlopen(req)
    +except HTTPError as e:
    +    print('The server couldn\'t fulfill the request.')
    +    print('Error code: ', e.code)
    +except URLError as e:
    +    print('We failed to reach a server.')
    +    print('Reason: ', e.reason)
    +else:
    +    # everything is fine
    +
    +
    +
    +

    Note

    +

    The except HTTPError must come first, otherwise except URLError +will also catch an HTTPError.

    +
    +
    +
    +

    Number 2

    +
    from urllib.request import Request, urlopen
    +from urllib.error import URLError
    +req = Request(someurl)
    +try:
    +    response = urlopen(req)
    +except URLError as e:
    +    if hasattr(e, 'reason'):
    +        print('We failed to reach a server.')
    +        print('Reason: ', e.reason)
    +    elif hasattr(e, 'code'):
    +        print('The server couldn\'t fulfill the request.')
    +        print('Error code: ', e.code)
    +else:
    +    # everything is fine
    +
    +
    +
    +
    +
    +
    +

    info and geturl

    +

    The response returned by urlopen (or the HTTPError instance) has two +useful methods info() and geturl() and is defined in the module +urllib.response..

    +

    geturl - this returns the real URL of the page fetched. This is useful +because urlopen (or the opener object used) may have followed a +redirect. The URL of the page fetched may not be the same as the URL requested.

    +

    info - this returns a dictionary-like object that describes the page +fetched, particularly the headers sent by the server. It is currently an +http.client.HTTPMessage instance.

    +

    Typical headers include ‘Content-length’, ‘Content-type’, and so on. See the +Quick Reference to HTTP Headers +for a useful listing of HTTP headers with brief explanations of their meaning +and use.

    +
    +
    +

    Openers and Handlers

    +

    When you fetch a URL you use an opener (an instance of the perhaps +confusingly-named urllib.request.OpenerDirector). Normally we have been using +the default opener - via urlopen - but you can create custom +openers. Openers use handlers. All the “heavy lifting” is done by the +handlers. Each handler knows how to open URLs for a particular URL scheme (http, +ftp, etc.), or how to handle an aspect of URL opening, for example HTTP +redirections or HTTP cookies.

    +

    You will want to create openers if you want to fetch URLs with specific handlers +installed, for example to get an opener that handles cookies, or to get an +opener that does not handle redirections.

    +

    To create an opener, instantiate an OpenerDirector, and then call +.add_handler(some_handler_instance) repeatedly.

    +

    Alternatively, you can use build_opener, which is a convenience function for +creating opener objects with a single function call. build_opener adds +several handlers by default, but provides a quick way to add more and/or +override the default handlers.

    +

    Other sorts of handlers you might want to can handle proxies, authentication, +and other common but slightly specialised situations.

    +

    install_opener can be used to make an opener object the (global) default +opener. This means that calls to urlopen will use the opener you have +installed.

    +

    Opener objects have an open method, which can be called directly to fetch +urls in the same way as the urlopen function: there’s no need to call +install_opener, except as a convenience.

    +
    +
    +

    Basic Authentication

    +

    To illustrate creating and installing a handler we will use the +HTTPBasicAuthHandler. For a more detailed discussion of this subject – +including an explanation of how Basic Authentication works - see the Basic +Authentication Tutorial.

    +

    When authentication is required, the server sends a header (as well as the 401 +error code) requesting authentication. This specifies the authentication scheme +and a ‘realm’. The header looks like: WWW-Authenticate: SCHEME +realm="REALM".

    +

    e.g.

    +
    WWW-Authenticate: Basic realm="cPanel Users"
    +
    +
    +

    The client should then retry the request with the appropriate name and password +for the realm included as a header in the request. This is ‘basic +authentication’. In order to simplify this process we can create an instance of +HTTPBasicAuthHandler and an opener to use this handler.

    +

    The HTTPBasicAuthHandler uses an object called a password manager to handle +the mapping of URLs and realms to passwords and usernames. If you know what the +realm is (from the authentication header sent by the server), then you can use a +HTTPPasswordMgr. Frequently one doesn’t care what the realm is. In that +case, it is convenient to use HTTPPasswordMgrWithDefaultRealm. This allows +you to specify a default username and password for a URL. This will be supplied +in the absence of you providing an alternative combination for a specific +realm. We indicate this by providing None as the realm argument to the +add_password method.

    +

    The top-level URL is the first URL that requires authentication. URLs “deeper” +than the URL you pass to .add_password() will also match.

    +
    # create a password manager
    +password_mgr = urllib.request.HTTPPasswordMgrWithDefaultRealm()
    +
    +# Add the username and password.
    +# If we knew the realm, we could use it instead of None.
    +top_level_url = "http://example.com/foo/"
    +password_mgr.add_password(None, top_level_url, username, password)
    +
    +handler = urllib.request.HTTPBasicAuthHandler(password_mgr)
    +
    +# create "opener" (OpenerDirector instance)
    +opener = urllib.request.build_opener(handler)
    +
    +# use the opener to fetch a URL
    +opener.open(a_url)
    +
    +# Install the opener.
    +# Now all calls to urllib.request.urlopen use our opener.
    +urllib.request.install_opener(opener)
    +
    +
    +
    +

    Note

    +

    In the above example we only supplied our HTTPBasicAuthHandler to +build_opener. By default openers have the handlers for normal situations +– ProxyHandler (if a proxy setting such as an http_proxy +environment variable is set), UnknownHandler, HTTPHandler, +HTTPDefaultErrorHandler, HTTPRedirectHandler, FTPHandler, +FileHandler, DataHandler, HTTPErrorProcessor.

    +
    +

    top_level_url is in fact either a full URL (including the ‘http:’ scheme +component and the hostname and optionally the port number) +e.g. "http://example.com/" or an “authority” (i.e. the hostname, +optionally including the port number) e.g. "example.com" or "example.com:8080" +(the latter example includes a port number). The authority, if present, must +NOT contain the “userinfo” component - for example "joe:password@example.com" is +not correct.

    +
    +
    +

    Proxies

    +

    urllib will auto-detect your proxy settings and use those. This is through +the ProxyHandler, which is part of the normal handler chain when a proxy +setting is detected. Normally that’s a good thing, but there are occasions +when it may not be helpful 5. One way to do this is to setup our own +ProxyHandler, with no proxies defined. This is done using similar steps to +setting up a Basic Authentication handler:

    +
    >>> proxy_support = urllib.request.ProxyHandler({})
    +>>> opener = urllib.request.build_opener(proxy_support)
    +>>> urllib.request.install_opener(opener)
    +
    +
    +
    +

    Note

    +

    Currently urllib.request does not support fetching of https locations +through a proxy. However, this can be enabled by extending urllib.request as +shown in the recipe 6.

    +
    +
    +

    Note

    +

    HTTP_PROXY will be ignored if a variable REQUEST_METHOD is set; see +the documentation on getproxies().

    +
    +
    +
    +

    Sockets and Layers

    +

    The Python support for fetching resources from the web is layered. urllib uses +the http.client library, which in turn uses the socket library.

    +

    As of Python 2.3 you can specify how long a socket should wait for a response +before timing out. This can be useful in applications which have to fetch web +pages. By default the socket module has no timeout and can hang. Currently, +the socket timeout is not exposed at the http.client or urllib.request levels. +However, you can set the default timeout globally for all sockets using

    +
    import socket
    +import urllib.request
    +
    +# timeout in seconds
    +timeout = 10
    +socket.setdefaulttimeout(timeout)
    +
    +# this call to urllib.request.urlopen now uses the default timeout
    +# we have set in the socket module
    +req = urllib.request.Request('http://www.voidspace.org.uk')
    +response = urllib.request.urlopen(req)
    +
    +
    +
    +
    +
    +

    Footnotes

    +

    This document was reviewed and revised by John Lee.

    +
    +
    1
    +

    Google for example.

    +
    +
    2
    +

    Browser sniffing is a very bad practice for website design - building +sites using web standards is much more sensible. Unfortunately a lot of +sites still send different versions to different browsers.

    +
    +
    3
    +

    The user agent for MSIE 6 is +‘Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)’

    +
    +
    4
    +

    For details of more HTTP request headers, see +Quick Reference to HTTP Headers.

    +
    +
    5
    +

    In my case I have to use a proxy to access the internet at work. If you +attempt to fetch localhost URLs through this proxy it blocks them. IE +is set to use the proxy, which urllib picks up on. In order to test +scripts with a localhost server, I have to prevent urllib from using +the proxy.

    +
    +
    6
    +

    urllib opener for SSL proxy (CONNECT method): ASPN Cookbook Recipe.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/index.html b/python-3.7.4-docs-html/index.html new file mode 100644 index 0000000..44755f4 --- /dev/null +++ b/python-3.7.4-docs-html/index.html @@ -0,0 +1,223 @@ + + + + + + 3.7.4 Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +

    Python 3.7.4 documentation

    +

    + Welcome! This is the documentation for Python 3.7.4. +

    +

    Parts of the documentation:

    + + +
    + + + + + + + + + + + + +
    + +

    Indices and tables:

    + + +
    + + + + + + +
    + +

    Meta information:

    + + +
    + + + + + +
    + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/install/index.html b/python-3.7.4-docs-html/install/index.html new file mode 100644 index 0000000..b4f7b49 --- /dev/null +++ b/python-3.7.4-docs-html/install/index.html @@ -0,0 +1,1293 @@ + + + + + + + Installing Python Modules (Legacy version) — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Installing Python Modules (Legacy version)

    +
    +
    Author
    +

    Greg Ward

    +
    +
    +
    +

    See also

    +
    +
    Installing Python Modules

    The up to date module installation documentations

    +
    +
    +
    +

    This document describes the Python Distribution Utilities (“Distutils”) from the +end-user’s point-of-view, describing how to extend the capabilities of a +standard Python installation by building and installing third-party Python +modules and extensions.

    +
    +

    Note

    +

    This guide only covers the basic tools for building and distributing +extensions that are provided as part of this version of Python. Third party +tools offer easier to use and more secure alternatives. Refer to the quick +recommendations section +in the Python Packaging User Guide for more information.

    +
    +
    +

    Introduction

    +

    Although Python’s extensive standard library covers many programming needs, +there often comes a time when you need to add some new functionality to your +Python installation in the form of third-party modules. This might be necessary +to support your own programming, or to support an application that you want to +use and that happens to be written in Python.

    +

    In the past, there has been little support for adding third-party modules to an +existing Python installation. With the introduction of the Python Distribution +Utilities (Distutils for short) in Python 2.0, this changed.

    +

    This document is aimed primarily at the people who need to install third-party +Python modules: end-users and system administrators who just need to get some +Python application running, and existing Python programmers who want to add some +new goodies to their toolbox. You don’t need to know Python to read this +document; there will be some brief forays into using Python’s interactive mode +to explore your installation, but that’s it. If you’re looking for information +on how to distribute your own Python modules so that others may use them, see +the Distributing Python Modules (Legacy version) manual. Debugging the setup script may also be of +interest.

    +
    +

    Best case: trivial installation

    +

    In the best case, someone will have prepared a special version of the module +distribution you want to install that is targeted specifically at your platform +and is installed just like any other software on your platform. For example, +the module developer might make an executable installer available for Windows +users, an RPM package for users of RPM-based Linux systems (Red Hat, SuSE, +Mandrake, and many others), a Debian package for users of Debian-based Linux +systems, and so forth.

    +

    In that case, you would download the installer appropriate to your platform and +do the obvious thing with it: run it if it’s an executable installer, rpm +--install it if it’s an RPM, etc. You don’t need to run Python or a setup +script, you don’t need to compile anything—you might not even need to read any +instructions (although it’s always a good idea to do so anyway).

    +

    Of course, things will not always be that easy. You might be interested in a +module distribution that doesn’t have an easy-to-use installer for your +platform. In that case, you’ll have to start with the source distribution +released by the module’s author/maintainer. Installing from a source +distribution is not too hard, as long as the modules are packaged in the +standard way. The bulk of this document is about building and installing +modules from standard source distributions.

    +
    +
    +

    The new standard: Distutils

    +

    If you download a module source distribution, you can tell pretty quickly if it +was packaged and distributed in the standard way, i.e. using the Distutils. +First, the distribution’s name and version number will be featured prominently +in the name of the downloaded archive, e.g. foo-1.0.tar.gz or +widget-0.9.7.zip. Next, the archive will unpack into a similarly-named +directory: foo-1.0 or widget-0.9.7. Additionally, the +distribution will contain a setup script setup.py, and a file named +README.txt or possibly just README, which should explain that +building and installing the module distribution is a simple matter of running +one command from a terminal:

    +
    python setup.py install
    +
    +
    +

    For Windows, this command should be run from a command prompt window +(Start ‣ Accessories):

    +
    setup.py install
    +
    +
    +

    If all these things are true, then you already know how to build and install the +modules you’ve just downloaded: Run the command above. Unless you need to +install things in a non-standard way or customize the build process, you don’t +really need this manual. Or rather, the above command is everything you need to +get out of this manual.

    +
    +
    +
    +

    Standard Build and Install

    +

    As described in section The new standard: Distutils, building and installing a module +distribution using the Distutils is usually one simple command to run from a +terminal:

    +
    python setup.py install
    +
    +
    +
    +

    Platform variations

    +

    You should always run the setup command from the distribution root directory, +i.e. the top-level subdirectory that the module source distribution unpacks +into. For example, if you’ve just downloaded a module source distribution +foo-1.0.tar.gz onto a Unix system, the normal thing to do is:

    +
    gunzip -c foo-1.0.tar.gz | tar xf -    # unpacks into directory foo-1.0
    +cd foo-1.0
    +python setup.py install
    +
    +
    +

    On Windows, you’d probably download foo-1.0.zip. If you downloaded the +archive file to C:\Temp, then it would unpack into +C:\Temp\foo-1.0; you can use either an archive manipulator with a +graphical user interface (such as WinZip) or a command-line tool (such as +unzip or pkunzip) to unpack the archive. Then, open a +command prompt window and run:

    +
    cd c:\Temp\foo-1.0
    +python setup.py install
    +
    +
    +
    +
    +

    Splitting the job up

    +

    Running setup.py install builds and installs all modules in one run. If you +prefer to work incrementally—especially useful if you want to customize the +build process, or if things are going wrong—you can use the setup script to do +one thing at a time. This is particularly helpful when the build and install +will be done by different users—for example, you might want to build a module +distribution and hand it off to a system administrator for installation (or do +it yourself, with super-user privileges).

    +

    For example, you can build everything in one step, and then install everything +in a second step, by invoking the setup script twice:

    +
    python setup.py build
    +python setup.py install
    +
    +
    +

    If you do this, you will notice that running the install command +first runs the build command, which—in this case—quickly notices +that it has nothing to do, since everything in the build directory is +up-to-date.

    +

    You may not need this ability to break things down often if all you do is +install modules downloaded off the ‘net, but it’s very handy for more advanced +tasks. If you get into distributing your own Python modules and extensions, +you’ll run lots of individual Distutils commands on their own.

    +
    +
    +

    How building works

    +

    As implied above, the build command is responsible for putting the +files to install into a build directory. By default, this is build +under the distribution root; if you’re excessively concerned with speed, or want +to keep the source tree pristine, you can change the build directory with the +--build-base option. For example:

    +
    python setup.py build --build-base=/path/to/pybuild/foo-1.0
    +
    +
    +

    (Or you could do this permanently with a directive in your system or personal +Distutils configuration file; see section Distutils Configuration Files.) Normally, this +isn’t necessary.

    +

    The default layout for the build tree is as follows:

    +
    --- build/ --- lib/
    +or
    +--- build/ --- lib.<plat>/
    +               temp.<plat>/
    +
    +
    +

    where <plat> expands to a brief description of the current OS/hardware +platform and Python version. The first form, with just a lib directory, +is used for “pure module distributions”—that is, module distributions that +include only pure Python modules. If a module distribution contains any +extensions (modules written in C/C++), then the second form, with two <plat> +directories, is used. In that case, the temp.plat directory holds +temporary files generated by the compile/link process that don’t actually get +installed. In either case, the lib (or lib.plat) directory +contains all Python modules (pure Python and extensions) that will be installed.

    +

    In the future, more directories will be added to handle Python scripts, +documentation, binary executables, and whatever else is needed to handle the job +of installing Python modules and applications.

    +
    +
    +

    How installation works

    +

    After the build command runs (whether you run it explicitly, or the +install command does it for you), the work of the install +command is relatively simple: all it has to do is copy everything under +build/lib (or build/lib.plat) to your chosen installation +directory.

    +

    If you don’t choose an installation directory—i.e., if you just run setup.py +install—then the install command installs to the standard +location for third-party Python modules. This location varies by platform and +by how you built/installed Python itself. On Unix (and Mac OS X, which is also +Unix-based), it also depends on whether the module distribution being installed +is pure Python or contains extensions (“non-pure”):

    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + +

    Platform

    Standard installation location

    Default value

    Notes

    Unix (pure)

    prefix/lib/pythonX.Y/site-packages

    /usr/local/lib/pythonX.Y/site-packages

    (1)

    Unix (non-pure)

    exec-prefix/lib/pythonX.Y/site-packages

    /usr/local/lib/pythonX.Y/site-packages

    (1)

    Windows

    prefix\Lib\site-packages

    C:\PythonXY\Lib\site-packages

    (2)

    +

    Notes:

    +
      +
    1. Most Linux distributions include Python as a standard part of the system, so +prefix and exec-prefix are usually both /usr on +Linux. If you build Python yourself on Linux (or any Unix-like system), the +default prefix and exec-prefix are /usr/local.

    2. +
    3. The default installation directory on Windows was C:\Program +Files\Python under Python 1.6a1, 1.5.2, and earlier.

    4. +
    +

    prefix and exec-prefix stand for the directories that Python +is installed to, and where it finds its libraries at run-time. They are always +the same under Windows, and very often the same under Unix and Mac OS X. You +can find out what your Python installation uses for prefix and +exec-prefix by running Python in interactive mode and typing a few +simple commands. Under Unix, just type python at the shell prompt. Under +Windows, choose Start ‣ Programs ‣ Python X.Y ‣ +Python (command line). Once the interpreter is started, you type Python code +at the prompt. For example, on my Linux system, I type the three Python +statements shown below, and get the output as shown, to find out my +prefix and exec-prefix:

    +
    Python 2.4 (#26, Aug  7 2004, 17:19:02)
    +Type "help", "copyright", "credits" or "license" for more information.
    +>>> import sys
    +>>> sys.prefix
    +'/usr'
    +>>> sys.exec_prefix
    +'/usr'
    +
    +
    +

    A few other placeholders are used in this document: X.Y stands for the +version of Python, for example 3.2; abiflags will be replaced by +the value of sys.abiflags or the empty string for platforms which don’t +define ABI flags; distname will be replaced by the name of the module +distribution being installed. Dots and capitalization are important in the +paths; for example, a value that uses python3.2 on UNIX will typically use +Python32 on Windows.

    +

    If you don’t want to install modules to the standard location, or if you don’t +have permission to write there, then you need to read about alternate +installations in section Alternate Installation. If you want to customize your +installation directories more heavily, see section Custom Installation on +custom installations.

    +
    +
    +
    +

    Alternate Installation

    +

    Often, it is necessary or desirable to install modules to a location other than +the standard location for third-party Python modules. For example, on a Unix +system you might not have permission to write to the standard third-party module +directory. Or you might wish to try out a module before making it a standard +part of your local Python installation. This is especially true when upgrading +a distribution already present: you want to make sure your existing base of +scripts still works with the new version before actually upgrading.

    +

    The Distutils install command is designed to make installing module +distributions to an alternate location simple and painless. The basic idea is +that you supply a base directory for the installation, and the +install command picks a set of directories (called an installation +scheme) under this base directory in which to install files. The details +differ across platforms, so read whichever of the following sections applies to +you.

    +

    Note that the various alternate installation schemes are mutually exclusive: you +can pass --user, or --home, or --prefix and --exec-prefix, or +--install-base and --install-platbase, but you can’t mix from these +groups.

    +
    +

    Alternate installation: the user scheme

    +

    This scheme is designed to be the most convenient solution for users that don’t +have write permission to the global site-packages directory or don’t want to +install into it. It is enabled with a simple option:

    +
    python setup.py install --user
    +
    +
    +

    Files will be installed into subdirectories of site.USER_BASE (written +as userbase hereafter). This scheme installs pure Python modules and +extension modules in the same location (also known as site.USER_SITE). +Here are the values for UNIX, including Mac OS X:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Type of file

    Installation directory

    modules

    userbase/lib/pythonX.Y/site-packages

    scripts

    userbase/bin

    data

    userbase

    C headers

    userbase/include/pythonX.Yabiflags/distname

    +

    And here are the values used on Windows:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Type of file

    Installation directory

    modules

    userbase\PythonXY\site-packages

    scripts

    userbase\PythonXY\Scripts

    data

    userbase

    C headers

    userbase\PythonXY\Include{distname}

    +

    The advantage of using this scheme compared to the other ones described below is +that the user site-packages directory is under normal conditions always included +in sys.path (see site for more information), which means that +there is no additional step to perform after running the setup.py script +to finalize the installation.

    +

    The build_ext command also has a --user option to add +userbase/include to the compiler search path for header files and +userbase/lib to the compiler search path for libraries as well as to +the runtime search path for shared C libraries (rpath).

    +
    +
    +

    Alternate installation: the home scheme

    +

    The idea behind the “home scheme” is that you build and maintain a personal +stash of Python modules. This scheme’s name is derived from the idea of a +“home” directory on Unix, since it’s not unusual for a Unix user to make their +home directory have a layout similar to /usr/ or /usr/local/. +This scheme can be used by anyone, regardless of the operating system they +are installing for.

    +

    Installing a new module distribution is as simple as

    +
    python setup.py install --home=<dir>
    +
    +
    +

    where you can supply any directory you like for the --home option. On +Unix, lazy typists can just type a tilde (~); the install command +will expand this to your home directory:

    +
    python setup.py install --home=~
    +
    +
    +

    To make Python find the distributions installed with this scheme, you may have +to modify Python’s search path or edit +sitecustomize (see site) to call site.addsitedir() or edit +sys.path.

    +

    The --home option defines the installation base directory. Files are +installed to the following directories under the installation base as follows:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Type of file

    Installation directory

    modules

    home/lib/python

    scripts

    home/bin

    data

    home

    C headers

    home/include/python/distname

    +

    (Mentally replace slashes with backslashes if you’re on Windows.)

    +
    +
    +

    Alternate installation: Unix (the prefix scheme)

    +

    The “prefix scheme” is useful when you wish to use one Python installation to +perform the build/install (i.e., to run the setup script), but install modules +into the third-party module directory of a different Python installation (or +something that looks like a different Python installation). If this sounds a +trifle unusual, it is—that’s why the user and home schemes come before. However, +there are at least two known cases where the prefix scheme will be useful.

    +

    First, consider that many Linux distributions put Python in /usr, rather +than the more traditional /usr/local. This is entirely appropriate, +since in those cases Python is part of “the system” rather than a local add-on. +However, if you are installing Python modules from source, you probably want +them to go in /usr/local/lib/python2.X rather than +/usr/lib/python2.X. This can be done with

    +
    /usr/bin/python setup.py install --prefix=/usr/local
    +
    +
    +

    Another possibility is a network filesystem where the name used to write to a +remote directory is different from the name used to read it: for example, the +Python interpreter accessed as /usr/local/bin/python might search for +modules in /usr/local/lib/python2.X, but those modules would have to +be installed to, say, /mnt/@server/export/lib/python2.X. This could +be done with

    +
    /usr/local/bin/python setup.py install --prefix=/mnt/@server/export
    +
    +
    +

    In either case, the --prefix option defines the installation base, and +the --exec-prefix option defines the platform-specific installation +base, which is used for platform-specific files. (Currently, this just means +non-pure module distributions, but could be expanded to C libraries, binary +executables, etc.) If --exec-prefix is not supplied, it defaults to +--prefix. Files are installed as follows:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + +

    Type of file

    Installation directory

    Python modules

    prefix/lib/pythonX.Y/site-packages

    extension modules

    exec-prefix/lib/pythonX.Y/site-packages

    scripts

    prefix/bin

    data

    prefix

    C headers

    prefix/include/pythonX.Yabiflags/distname

    +

    There is no requirement that --prefix or --exec-prefix +actually point to an alternate Python installation; if the directories listed +above do not already exist, they are created at installation time.

    +

    Incidentally, the real reason the prefix scheme is important is simply that a +standard Unix installation uses the prefix scheme, but with --prefix +and --exec-prefix supplied by Python itself as sys.prefix and +sys.exec_prefix. Thus, you might think you’ll never use the prefix scheme, +but every time you run python setup.py install without any other options, +you’re using it.

    +

    Note that installing extensions to an alternate Python installation has no +effect on how those extensions are built: in particular, the Python header files +(Python.h and friends) installed with the Python interpreter used to run +the setup script will be used in compiling extensions. It is your +responsibility to ensure that the interpreter used to run extensions installed +in this way is compatible with the interpreter used to build them. The best way +to do this is to ensure that the two interpreters are the same version of Python +(possibly different builds, or possibly copies of the same build). (Of course, +if your --prefix and --exec-prefix don’t even point to an +alternate Python installation, this is immaterial.)

    +
    +
    +

    Alternate installation: Windows (the prefix scheme)

    +

    Windows has no concept of a user’s home directory, and since the standard Python +installation under Windows is simpler than under Unix, the --prefix +option has traditionally been used to install additional packages in separate +locations on Windows.

    +
    python setup.py install --prefix="\Temp\Python"
    +
    +
    +

    to install modules to the \Temp\Python directory on the current drive.

    +

    The installation base is defined by the --prefix option; the +--exec-prefix option is not supported under Windows, which means that +pure Python modules and extension modules are installed into the same location. +Files are installed as follows:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Type of file

    Installation directory

    modules

    prefix\Lib\site-packages

    scripts

    prefix\Scripts

    data

    prefix

    C headers

    prefix\Include{distname}

    +
    +
    +
    +

    Custom Installation

    +

    Sometimes, the alternate installation schemes described in section +Alternate Installation just don’t do what you want. You might want to tweak just +one or two directories while keeping everything under the same base directory, +or you might want to completely redefine the installation scheme. In either +case, you’re creating a custom installation scheme.

    +

    To create a custom installation scheme, you start with one of the alternate +schemes and override some of the installation directories used for the various +types of files, using these options:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + +

    Type of file

    Override option

    Python modules

    --install-purelib

    extension modules

    --install-platlib

    all modules

    --install-lib

    scripts

    --install-scripts

    data

    --install-data

    C headers

    --install-headers

    +

    These override options can be relative, absolute, +or explicitly defined in terms of one of the installation base directories. +(There are two installation base directories, and they are normally the +same—they only differ when you use the Unix “prefix scheme” and supply +different --prefix and --exec-prefix options; using --install-lib +will override values computed or given for --install-purelib and +--install-platlib, and is recommended for schemes that don’t make a +difference between Python and extension modules.)

    +

    For example, say you’re installing a module distribution to your home directory +under Unix—but you want scripts to go in ~/scripts rather than +~/bin. As you might expect, you can override this directory with the +--install-scripts option; in this case, it makes most sense to supply +a relative path, which will be interpreted relative to the installation base +directory (your home directory, in this case):

    +
    python setup.py install --home=~ --install-scripts=scripts
    +
    +
    +

    Another Unix example: suppose your Python installation was built and installed +with a prefix of /usr/local/python, so under a standard installation +scripts will wind up in /usr/local/python/bin. If you want them in +/usr/local/bin instead, you would supply this absolute directory for the +--install-scripts option:

    +
    python setup.py install --install-scripts=/usr/local/bin
    +
    +
    +

    (This performs an installation using the “prefix scheme,” where the prefix is +whatever your Python interpreter was installed with— /usr/local/python +in this case.)

    +

    If you maintain Python on Windows, you might want third-party modules to live in +a subdirectory of prefix, rather than right in prefix +itself. This is almost as easy as customizing the script installation +directory—you just have to remember that there are two types of modules +to worry about, Python and extension modules, which can conveniently be both +controlled by one option:

    +
    python setup.py install --install-lib=Site
    +
    +
    +

    The specified installation directory is relative to prefix. Of +course, you also have to ensure that this directory is in Python’s module +search path, such as by putting a .pth file in a site directory (see +site). See section Modifying Python’s Search Path to find out how to modify +Python’s search path.

    +

    If you want to define an entire installation scheme, you just have to supply all +of the installation directory options. The recommended way to do this is to +supply relative paths; for example, if you want to maintain all Python +module-related files under python in your home directory, and you want a +separate directory for each platform that you use your home directory from, you +might define the following installation scheme:

    +
    python setup.py install --home=~ \
    +                        --install-purelib=python/lib \
    +                        --install-platlib=python/lib.$PLAT \
    +                        --install-scripts=python/scripts
    +                        --install-data=python/data
    +
    +
    +

    or, equivalently,

    +
    python setup.py install --home=~/python \
    +                        --install-purelib=lib \
    +                        --install-platlib='lib.$PLAT' \
    +                        --install-scripts=scripts
    +                        --install-data=data
    +
    +
    +

    $PLAT is not (necessarily) an environment variable—it will be expanded by +the Distutils as it parses your command line options, just as it does when +parsing your configuration file(s).

    +

    Obviously, specifying the entire installation scheme every time you install a +new module distribution would be very tedious. Thus, you can put these options +into your Distutils config file (see section Distutils Configuration Files):

    +
    [install]
    +install-base=$HOME
    +install-purelib=python/lib
    +install-platlib=python/lib.$PLAT
    +install-scripts=python/scripts
    +install-data=python/data
    +
    +
    +

    or, equivalently,

    +
    [install]
    +install-base=$HOME/python
    +install-purelib=lib
    +install-platlib=lib.$PLAT
    +install-scripts=scripts
    +install-data=data
    +
    +
    +

    Note that these two are not equivalent if you supply a different installation +base directory when you run the setup script. For example,

    +
    python setup.py install --install-base=/tmp
    +
    +
    +

    would install pure modules to /tmp/python/lib in the first case, and +to /tmp/lib in the second case. (For the second case, you probably +want to supply an installation base of /tmp/python.)

    +

    You probably noticed the use of $HOME and $PLAT in the sample +configuration file input. These are Distutils configuration variables, which +bear a strong resemblance to environment variables. In fact, you can use +environment variables in config files on platforms that have such a notion but +the Distutils additionally define a few extra variables that may not be in your +environment, such as $PLAT. (And of course, on systems that don’t have +environment variables, such as Mac OS 9, the configuration variables supplied by +the Distutils are the only ones you can use.) See section Distutils Configuration Files +for details.

    +
    +

    Note

    +

    When a virtual environment is activated, any options +that change the installation path will be ignored from all distutils configuration +files to prevent inadvertently installing projects outside of the virtual +environment.

    +
    +
    +

    Modifying Python’s Search Path

    +

    When the Python interpreter executes an import statement, it searches +for both Python code and extension modules along a search path. A default value +for the path is configured into the Python binary when the interpreter is built. +You can determine the path by importing the sys module and printing the +value of sys.path.

    +
    $ python
    +Python 2.2 (#11, Oct  3 2002, 13:31:27)
    +[GCC 2.96 20000731 (Red Hat Linux 7.3 2.96-112)] on linux2
    +Type "help", "copyright", "credits" or "license" for more information.
    +>>> import sys
    +>>> sys.path
    +['', '/usr/local/lib/python2.3', '/usr/local/lib/python2.3/plat-linux2',
    + '/usr/local/lib/python2.3/lib-tk', '/usr/local/lib/python2.3/lib-dynload',
    + '/usr/local/lib/python2.3/site-packages']
    +>>>
    +
    +
    +

    The null string in sys.path represents the current working directory.

    +

    The expected convention for locally installed packages is to put them in the +/site-packages/ directory, but you may want to install Python +modules into some arbitrary directory. For example, your site may have a +convention of keeping all software related to the web server under /www. +Add-on Python modules might then belong in /www/python, and in order to +import them, this directory must be added to sys.path. There are several +different ways to add the directory.

    +

    The most convenient way is to add a path configuration file to a directory +that’s already on Python’s path, usually to the .../site-packages/ +directory. Path configuration files have an extension of .pth, and each +line must contain a single path that will be appended to sys.path. (Because +the new paths are appended to sys.path, modules in the added directories +will not override standard modules. This means you can’t use this mechanism for +installing fixed versions of standard modules.)

    +

    Paths can be absolute or relative, in which case they’re relative to the +directory containing the .pth file. See the documentation of +the site module for more information.

    +

    A slightly less convenient way is to edit the site.py file in Python’s +standard library, and modify sys.path. site.py is automatically +imported when the Python interpreter is executed, unless the -S switch +is supplied to suppress this behaviour. So you could simply edit +site.py and add two lines to it:

    +
    import sys
    +sys.path.append('/www/python/')
    +
    +
    +

    However, if you reinstall the same major version of Python (perhaps when +upgrading from 2.2 to 2.2.2, for example) site.py will be overwritten by +the stock version. You’d have to remember that it was modified and save a copy +before doing the installation.

    +

    There are two environment variables that can modify sys.path. +PYTHONHOME sets an alternate value for the prefix of the Python +installation. For example, if PYTHONHOME is set to /www/python, +the search path will be set to ['', '/www/python/lib/pythonX.Y/', +'/www/python/lib/pythonX.Y/plat-linux2', ...].

    +

    The PYTHONPATH variable can be set to a list of paths that will be +added to the beginning of sys.path. For example, if PYTHONPATH is +set to /www/python:/opt/py, the search path will begin with +['/www/python', '/opt/py']. (Note that directories must exist in order to +be added to sys.path; the site module removes paths that don’t +exist.)

    +

    Finally, sys.path is just a regular Python list, so any Python application +can modify it by adding or removing entries.

    +
    +
    +
    +

    Distutils Configuration Files

    +

    As mentioned above, you can use Distutils configuration files to record personal +or site preferences for any Distutils options. That is, any option to any +command can be stored in one of two or three (depending on your platform) +configuration files, which will be consulted before the command-line is parsed. +This means that configuration files will override default values, and the +command-line will in turn override configuration files. Furthermore, if +multiple configuration files apply, values from “earlier” files are overridden +by “later” files.

    +
    +

    Location and names of config files

    +

    The names and locations of the configuration files vary slightly across +platforms. On Unix and Mac OS X, the three configuration files (in the order +they are processed) are:

    + +++++ + + + + + + + + + + + + + + + + + + + + +

    Type of file

    Location and filename

    Notes

    system

    prefix/lib/pythonver/distutils/distutils.cfg

    (1)

    personal

    $HOME/.pydistutils.cfg

    (2)

    local

    setup.cfg

    (3)

    +

    And on Windows, the configuration files are:

    + +++++ + + + + + + + + + + + + + + + + + + + + +

    Type of file

    Location and filename

    Notes

    system

    prefix\Lib\distutils\distutils.cfg

    (4)

    personal

    %HOME%\pydistutils.cfg

    (5)

    local

    setup.cfg

    (3)

    +

    On all platforms, the “personal” file can be temporarily disabled by +passing the –no-user-cfg option.

    +

    Notes:

    +
      +
    1. Strictly speaking, the system-wide configuration file lives in the directory +where the Distutils are installed; under Python 1.6 and later on Unix, this is +as shown. For Python 1.5.2, the Distutils will normally be installed to +prefix/lib/python1.5/site-packages/distutils, so the system +configuration file should be put there under Python 1.5.2.

    2. +
    3. On Unix, if the HOME environment variable is not defined, the user’s +home directory will be determined with the getpwuid() function from the +standard pwd module. This is done by the os.path.expanduser() +function used by Distutils.

    4. +
    5. I.e., in the current directory (usually the location of the setup script).

    6. +
    7. (See also note (1).) Under Python 1.6 and later, Python’s default “installation +prefix” is C:\Python, so the system configuration file is normally +C:\Python\Lib\distutils\distutils.cfg. Under Python 1.5.2, the +default prefix was C:\Program Files\Python, and the Distutils were not +part of the standard library—so the system configuration file would be +C:\Program Files\Python\distutils\distutils.cfg in a standard Python +1.5.2 installation under Windows.

    8. +
    9. On Windows, if the HOME environment variable is not defined, +USERPROFILE then HOMEDRIVE and HOMEPATH will +be tried. This is done by the os.path.expanduser() function used +by Distutils.

    10. +
    +
    +
    +

    Syntax of config files

    +

    The Distutils configuration files all have the same syntax. The config files +are grouped into sections. There is one section for each Distutils command, +plus a global section for global options that affect every command. Each +section consists of one option per line, specified as option=value.

    +

    For example, the following is a complete config file that just forces all +commands to run quietly by default:

    +
    [global]
    +verbose=0
    +
    +
    +

    If this is installed as the system config file, it will affect all processing of +any Python module distribution by any user on the current system. If it is +installed as your personal config file (on systems that support them), it will +affect only module distributions processed by you. And if it is used as the +setup.cfg for a particular module distribution, it affects only that +distribution.

    +

    You could override the default “build base” directory and make the +build* commands always forcibly rebuild all files with the +following:

    +
    [build]
    +build-base=blib
    +force=1
    +
    +
    +

    which corresponds to the command-line arguments

    +
    python setup.py build --build-base=blib --force
    +
    +
    +

    except that including the build command on the command-line means +that command will be run. Including a particular command in config files has no +such implication; it only means that if the command is run, the options in the +config file will apply. (Or if other commands that derive values from it are +run, they will use the values in the config file.)

    +

    You can find out the complete list of options for any command using the +--help option, e.g.:

    +
    python setup.py build --help
    +
    +
    +

    and you can find out the complete list of global options by using +--help without a command:

    +
    python setup.py --help
    +
    +
    +

    See also the “Reference” section of the “Distributing Python Modules” manual.

    +
    +
    +
    +

    Building Extensions: Tips and Tricks

    +

    Whenever possible, the Distutils try to use the configuration information made +available by the Python interpreter used to run the setup.py script. +For example, the same compiler and linker flags used to compile Python will also +be used for compiling extensions. Usually this will work well, but in +complicated situations this might be inappropriate. This section discusses how +to override the usual Distutils behaviour.

    +
    +

    Tweaking compiler/linker flags

    +

    Compiling a Python extension written in C or C++ will sometimes require +specifying custom flags for the compiler and linker in order to use a particular +library or produce a special kind of object code. This is especially true if the +extension hasn’t been tested on your platform, or if you’re trying to +cross-compile Python.

    +

    In the most general case, the extension author might have foreseen that +compiling the extensions would be complicated, and provided a Setup file +for you to edit. This will likely only be done if the module distribution +contains many separate extension modules, or if they often require elaborate +sets of compiler flags in order to work.

    +

    A Setup file, if present, is parsed in order to get a list of extensions +to build. Each line in a Setup describes a single module. Lines have +the following structure:

    +
    module ... [sourcefile ...] [cpparg ...] [library ...]
    +
    +
    +

    Let’s examine each of the fields in turn.

    +
      +
    • module is the name of the extension module to be built, and should be a +valid Python identifier. You can’t just change this in order to rename a module +(edits to the source code would also be needed), so this should be left alone.

    • +
    • sourcefile is anything that’s likely to be a source code file, at least +judging by the filename. Filenames ending in .c are assumed to be +written in C, filenames ending in .C, .cc, and .c++ are +assumed to be C++, and filenames ending in .m or .mm are assumed +to be in Objective C.

    • +
    • cpparg is an argument for the C preprocessor, and is anything starting with +-I, -D, -U or -C.

    • +
    • library is anything ending in .a or beginning with -l or +-L.

    • +
    +

    If a particular platform requires a special library on your platform, you can +add it by editing the Setup file and running python setup.py build. +For example, if the module defined by the line

    +
    foo foomodule.c
    +
    +
    +

    must be linked with the math library libm.a on your platform, simply add +-lm to the line:

    +
    foo foomodule.c -lm
    +
    +
    +

    Arbitrary switches intended for the compiler or the linker can be supplied with +the -Xcompiler arg and -Xlinker arg options:

    +
    foo foomodule.c -Xcompiler -o32 -Xlinker -shared -lm
    +
    +
    +

    The next option after -Xcompiler and -Xlinker will be +appended to the proper command line, so in the above example the compiler will +be passed the -o32 option, and the linker will be passed +-shared. If a compiler option requires an argument, you’ll have to +supply multiple -Xcompiler options; for example, to pass -x c++ +the Setup file would have to contain -Xcompiler -x -Xcompiler c++.

    +

    Compiler flags can also be supplied through setting the CFLAGS +environment variable. If set, the contents of CFLAGS will be added to +the compiler flags specified in the Setup file.

    +
    +
    +

    Using non-Microsoft compilers on Windows

    +
    +

    Borland/CodeGear C++

    +

    This subsection describes the necessary steps to use Distutils with the Borland +C++ compiler version 5.5. First you have to know that Borland’s object file +format (OMF) is different from the format used by the Python version you can +download from the Python or ActiveState Web site. (Python is built with +Microsoft Visual C++, which uses COFF as the object file format.) For this +reason you have to convert Python’s library python25.lib into the +Borland format. You can do this as follows:

    +
    coff2omf python25.lib python25_bcpp.lib
    +
    +
    +

    The coff2omf program comes with the Borland compiler. The file +python25.lib is in the Libs directory of your Python +installation. If your extension uses other libraries (zlib, …) you have to +convert them too.

    +

    The converted files have to reside in the same directories as the normal +libraries.

    +

    How does Distutils manage to use these libraries with their changed names? If +the extension needs a library (eg. foo) Distutils checks first if it +finds a library with suffix _bcpp (eg. foo_bcpp.lib) and then +uses this library. In the case it doesn’t find such a special library it uses +the default name (foo.lib.) 1

    +

    To let Distutils compile your extension with Borland C++ you now have to type:

    +
    python setup.py build --compiler=bcpp
    +
    +
    +

    If you want to use the Borland C++ compiler as the default, you could specify +this in your personal or system-wide configuration file for Distutils (see +section Distutils Configuration Files.)

    +
    +

    See also

    +
    +
    C++Builder Compiler

    Information about the free C++ compiler from Borland, including links to the +download pages.

    +
    +
    Creating Python Extensions Using Borland’s Free Compiler

    Document describing how to use Borland’s free command-line C++ compiler to build +Python.

    +
    +
    +
    +
    +
    +

    GNU C / Cygwin / MinGW

    +

    This section describes the necessary steps to use Distutils with the GNU C/C++ +compilers in their Cygwin and MinGW distributions. 2 For a Python interpreter +that was built with Cygwin, everything should work without any of these +following steps.

    +

    Not all extensions can be built with MinGW or Cygwin, but many can. Extensions +most likely to not work are those that use C++ or depend on Microsoft Visual C +extensions.

    +

    To let Distutils compile your extension with Cygwin you have to type:

    +
    python setup.py build --compiler=cygwin
    +
    +
    +

    and for Cygwin in no-cygwin mode 3 or for MinGW type:

    +
    python setup.py build --compiler=mingw32
    +
    +
    +

    If you want to use any of these options/compilers as default, you should +consider writing it in your personal or system-wide configuration file for +Distutils (see section Distutils Configuration Files.)

    +
    +
    Older Versions of Python and MinGW
    +

    The following instructions only apply if you’re using a version of Python +inferior to 2.4.1 with a MinGW inferior to 3.0.0 (with +binutils-2.13.90-20030111-1).

    +

    These compilers require some special libraries. This task is more complex than +for Borland’s C++, because there is no program to convert the library. First +you have to create a list of symbols which the Python DLL exports. (You can find +a good program for this task at +https://sourceforge.net/projects/mingw/files/MinGW/Extension/pexports/).

    +
    pexports python25.dll >python25.def
    +
    +
    +

    The location of an installed python25.dll will depend on the +installation options and the version and language of Windows. In a “just for +me” installation, it will appear in the root of the installation directory. In +a shared installation, it will be located in the system directory.

    +

    Then you can create from these information an import library for gcc.

    +
    /cygwin/bin/dlltool --dllname python25.dll --def python25.def --output-lib libpython25.a
    +
    +
    +

    The resulting library has to be placed in the same directory as +python25.lib. (Should be the libs directory under your Python +installation directory.)

    +

    If your extension uses other libraries (zlib,…) you might have to convert +them too. The converted files have to reside in the same directories as the +normal libraries do.

    +
    +

    See also

    +
    +
    Building Python modules on MS Windows platform with MinGW

    Information about building the required libraries for the MinGW environment.

    +
    +
    +
    +

    Footnotes

    +
    +
    1
    +

    This also means you could replace all existing COFF-libraries with OMF-libraries +of the same name.

    +
    +
    2
    +

    Check https://www.sourceware.org/cygwin/ and http://www.mingw.org/ for more +information

    +
    +
    3
    +

    Then you have no POSIX emulation available, but you also don’t need +cygwin1.dll.

    +
    +
    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/installing/index.html b/python-3.7.4-docs-html/installing/index.html new file mode 100644 index 0000000..9c19199 --- /dev/null +++ b/python-3.7.4-docs-html/installing/index.html @@ -0,0 +1,399 @@ + + + + + + + Installing Python Modules — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Installing Python Modules

    +
    +
    Email
    +

    distutils-sig@python.org

    +
    +
    +

    As a popular open source development project, Python has an active +supporting community of contributors and users that also make their software +available for other Python developers to use under open source license terms.

    +

    This allows Python users to share and collaborate effectively, benefiting +from the solutions others have already created to common (and sometimes +even rare!) problems, as well as potentially contributing their own +solutions to the common pool.

    +

    This guide covers the installation part of the process. For a guide to +creating and sharing your own Python projects, refer to the +distribution guide.

    +
    +

    Note

    +

    For corporate and other institutional users, be aware that many +organisations have their own policies around using and contributing to +open source software. Please take such policies into account when making +use of the distribution and installation tools provided with Python.

    +
    +
    +

    Key terms

    +
      +
    • pip is the preferred installer program. Starting with Python 3.4, it +is included by default with the Python binary installers.

    • +
    • A virtual environment is a semi-isolated Python environment that allows +packages to be installed for use by a particular application, rather than +being installed system wide.

    • +
    • venv is the standard tool for creating virtual environments, and has +been part of Python since Python 3.3. Starting with Python 3.4, it +defaults to installing pip into all created virtual environments.

    • +
    • virtualenv is a third party alternative (and predecessor) to +venv. It allows virtual environments to be used on versions of +Python prior to 3.4, which either don’t provide venv at all, or +aren’t able to automatically install pip into created environments.

    • +
    • The Python Packaging Index is a public +repository of open source licensed packages made available for use by +other Python users.

    • +
    • the Python Packaging Authority is the group of +developers and documentation authors responsible for the maintenance and +evolution of the standard packaging tools and the associated metadata and +file format standards. They maintain a variety of tools, documentation, +and issue trackers on both GitHub and +BitBucket.

    • +
    • distutils is the original build and distribution system first added to +the Python standard library in 1998. While direct use of distutils is +being phased out, it still laid the foundation for the current packaging +and distribution infrastructure, and it not only remains part of the +standard library, but its name lives on in other ways (such as the name +of the mailing list used to coordinate Python packaging standards +development).

    • +
    +
    +

    Deprecated since version 3.6: pyvenv was the recommended tool for creating virtual environments for +Python 3.3 and 3.4, and is deprecated in Python 3.6.

    +
    +
    +

    Changed in version 3.5: The use of venv is now recommended for creating virtual environments.

    +
    + +
    +
    +

    Basic usage

    +

    The standard packaging tools are all designed to be used from the command +line.

    +

    The following command will install the latest version of a module and its +dependencies from the Python Packaging Index:

    +
    python -m pip install SomePackage
    +
    +
    +
    +

    Note

    +

    For POSIX users (including Mac OS X and Linux users), the examples in +this guide assume the use of a virtual environment.

    +

    For Windows users, the examples in this guide assume that the option to +adjust the system PATH environment variable was selected when installing +Python.

    +
    +

    It’s also possible to specify an exact or minimum version directly on the +command line. When using comparator operators such as >, < or some other +special character which get interpreted by shell, the package name and the +version should be enclosed within double quotes:

    +
    python -m pip install SomePackage==1.0.4    # specific version
    +python -m pip install "SomePackage>=1.0.4"  # minimum version
    +
    +
    +

    Normally, if a suitable module is already installed, attempting to install +it again will have no effect. Upgrading existing modules must be requested +explicitly:

    +
    python -m pip install --upgrade SomePackage
    +
    +
    +

    More information and resources regarding pip and its capabilities can be +found in the Python Packaging User Guide.

    +

    Creation of virtual environments is done through the venv module. +Installing packages into an active virtual environment uses the commands shown +above.

    + +
    +
    +

    How do I …?

    +

    These are quick answers or links for some common tasks.

    +
    +

    … install pip in versions of Python prior to Python 3.4?

    +

    Python only started bundling pip with Python 3.4. For earlier versions, +pip needs to be “bootstrapped” as described in the Python Packaging +User Guide.

    + +
    +
    +

    … install packages just for the current user?

    +

    Passing the --user option to python -m pip install will install a +package just for the current user, rather than for all users of the system.

    +
    +
    +

    … install scientific Python packages?

    +

    A number of scientific Python packages have complex binary dependencies, and +aren’t currently easy to install using pip directly. At this point in +time, it will often be easier for users to install these packages by +other means +rather than attempting to install them with pip.

    + +
    +
    +

    … work with multiple versions of Python installed in parallel?

    +

    On Linux, Mac OS X, and other POSIX systems, use the versioned Python commands +in combination with the -m switch to run the appropriate copy of +pip:

    +
    python2   -m pip install SomePackage  # default Python 2
    +python2.7 -m pip install SomePackage  # specifically Python 2.7
    +python3   -m pip install SomePackage  # default Python 3
    +python3.4 -m pip install SomePackage  # specifically Python 3.4
    +
    +
    +

    Appropriately versioned pip commands may also be available.

    +

    On Windows, use the py Python launcher in combination with the -m +switch:

    +
    py -2   -m pip install SomePackage  # default Python 2
    +py -2.7 -m pip install SomePackage  # specifically Python 2.7
    +py -3   -m pip install SomePackage  # default Python 3
    +py -3.4 -m pip install SomePackage  # specifically Python 3.4
    +
    +
    +
    +
    +
    +

    Common installation issues

    +
    +

    Installing into the system Python on Linux

    +

    On Linux systems, a Python installation will typically be included as part +of the distribution. Installing into this Python installation requires +root access to the system, and may interfere with the operation of the +system package manager and other components of the system if a component +is unexpectedly upgraded using pip.

    +

    On such systems, it is often better to use a virtual environment or a +per-user installation when installing packages with pip.

    +
    +
    +

    Pip not installed

    +

    It is possible that pip does not get installed by default. One potential fix is:

    +
    python -m ensurepip --default-pip
    +
    +
    +

    There are also additional resources for installing pip.

    +
    +
    +

    Installing binary extensions

    +

    Python has typically relied heavily on source based distribution, with end +users being expected to compile extension modules from source as part of +the installation process.

    +

    With the introduction of support for the binary wheel format, and the +ability to publish wheels for at least Windows and Mac OS X through the +Python Packaging Index, this problem is expected to diminish over time, +as users are more regularly able to install pre-built extensions rather +than needing to build them themselves.

    +

    Some of the solutions for installing scientific software +that are not yet available as pre-built wheel files may also help with +obtaining other binary extensions without needing to build them locally.

    + +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/2to3.html b/python-3.7.4-docs-html/library/2to3.html new file mode 100644 index 0000000..fa0a04b --- /dev/null +++ b/python-3.7.4-docs-html/library/2to3.html @@ -0,0 +1,762 @@ + + + + + + + 2to3 - Automated Python 2 to 3 code translation — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    2to3 - Automated Python 2 to 3 code translation

    +

    2to3 is a Python program that reads Python 2.x source code and applies a series +of fixers to transform it into valid Python 3.x code. The standard library +contains a rich set of fixers that will handle almost all code. 2to3 supporting +library lib2to3 is, however, a flexible and generic library, so it is +possible to write your own fixers for 2to3. lib2to3 could also be +adapted to custom applications in which Python code needs to be edited +automatically.

    +
    +

    Using 2to3

    +

    2to3 will usually be installed with the Python interpreter as a script. It is +also located in the Tools/scripts directory of the Python root.

    +

    2to3’s basic arguments are a list of files or directories to transform. The +directories are recursively traversed for Python sources.

    +

    Here is a sample Python 2.x source file, example.py:

    +
    def greet(name):
    +    print "Hello, {0}!".format(name)
    +print "What's your name?"
    +name = raw_input()
    +greet(name)
    +
    +
    +

    It can be converted to Python 3.x code via 2to3 on the command line:

    +
    $ 2to3 example.py
    +
    +
    +

    A diff against the original source file is printed. 2to3 can also write the +needed modifications right back to the source file. (A backup of the original +file is made unless -n is also given.) Writing the changes back is +enabled with the -w flag:

    +
    $ 2to3 -w example.py
    +
    +
    +

    After transformation, example.py looks like this:

    +
    def greet(name):
    +    print("Hello, {0}!".format(name))
    +print("What's your name?")
    +name = input()
    +greet(name)
    +
    +
    +

    Comments and exact indentation are preserved throughout the translation process.

    +

    By default, 2to3 runs a set of predefined fixers. The +-l flag lists all available fixers. An explicit set of fixers to run +can be given with -f. Likewise the -x explicitly disables a +fixer. The following example runs only the imports and has_key fixers:

    +
    $ 2to3 -f imports -f has_key example.py
    +
    +
    +

    This command runs every fixer except the apply fixer:

    +
    $ 2to3 -x apply example.py
    +
    +
    +

    Some fixers are explicit, meaning they aren’t run by default and must be +listed on the command line to be run. Here, in addition to the default fixers, +the idioms fixer is run:

    +
    $ 2to3 -f all -f idioms example.py
    +
    +
    +

    Notice how passing all enables all default fixers.

    +

    Sometimes 2to3 will find a place in your source code that needs to be changed, +but 2to3 cannot fix automatically. In this case, 2to3 will print a warning +beneath the diff for a file. You should address the warning in order to have +compliant 3.x code.

    +

    2to3 can also refactor doctests. To enable this mode, use the -d +flag. Note that only doctests will be refactored. This also doesn’t require +the module to be valid Python. For example, doctest like examples in a reST +document could also be refactored with this option.

    +

    The -v option enables output of more information on the translation +process.

    +

    Since some print statements can be parsed as function calls or statements, 2to3 +cannot always read files containing the print function. When 2to3 detects the +presence of the from __future__ import print_function compiler directive, it +modifies its internal grammar to interpret print() as a function. This +change can also be enabled manually with the -p flag. Use +-p to run fixers on code that already has had its print statements +converted.

    +

    The -o or --output-dir option allows specification of an +alternate directory for processed output files to be written to. The +-n flag is required when using this as backup files do not make sense +when not overwriting the input files.

    +
    +

    New in version 3.2.3: The -o option was added.

    +
    +

    The -W or --write-unchanged-files flag tells 2to3 to always +write output files even if no changes were required to the file. This is most +useful with -o so that an entire Python source tree is copied with +translation from one directory to another. +This option implies the -w flag as it would not make sense otherwise.

    +
    +

    New in version 3.2.3: The -W flag was added.

    +
    +

    The --add-suffix option specifies a string to append to all output +filenames. The -n flag is required when specifying this as backups +are not necessary when writing to different filenames. Example:

    +
    $ 2to3 -n -W --add-suffix=3 example.py
    +
    +
    +

    Will cause a converted file named example.py3 to be written.

    +
    +

    New in version 3.2.3: The --add-suffix option was added.

    +
    +

    To translate an entire project from one directory tree to another use:

    +
    $ 2to3 --output-dir=python3-version/mycode -W -n python2-version/mycode
    +
    +
    +
    +
    +

    Fixers

    +

    Each step of transforming code is encapsulated in a fixer. The command 2to3 +-l lists them. As documented above, each can be turned on +and off individually. They are described here in more detail.

    +
    +
    +apply
    +

    Removes usage of apply(). For example apply(function, *args, +**kwargs) is converted to function(*args, **kwargs).

    +
    + +
    +
    +asserts
    +

    Replaces deprecated unittest method names with the correct ones.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    From

    To

    failUnlessEqual(a, b)

    assertEqual(a, b)

    assertEquals(a, b)

    assertEqual(a, b)

    failIfEqual(a, b)

    assertNotEqual(a, b)

    assertNotEquals(a, b)

    assertNotEqual(a, b)

    failUnless(a)

    assertTrue(a)

    assert_(a)

    assertTrue(a)

    failIf(a)

    assertFalse(a)

    failUnlessRaises(exc, cal)

    assertRaises(exc, cal)

    failUnlessAlmostEqual(a, b)

    assertAlmostEqual(a, b)

    assertAlmostEquals(a, b)

    assertAlmostEqual(a, b)

    failIfAlmostEqual(a, b)

    assertNotAlmostEqual(a, b)

    assertNotAlmostEquals(a, b)

    assertNotAlmostEqual(a, b)

    +
    + +
    +
    +basestring
    +

    Converts basestring to str.

    +
    + +
    +
    +buffer
    +

    Converts buffer to memoryview. This fixer is optional +because the memoryview API is similar but not exactly the same as +that of buffer.

    +
    + +
    +
    +dict
    +

    Fixes dictionary iteration methods. dict.iteritems() is converted to +dict.items(), dict.iterkeys() to dict.keys(), and +dict.itervalues() to dict.values(). Similarly, +dict.viewitems(), dict.viewkeys() and dict.viewvalues() are +converted respectively to dict.items(), dict.keys() and +dict.values(). It also wraps existing usages of dict.items(), +dict.keys(), and dict.values() in a call to list.

    +
    + +
    +
    +except
    +

    Converts except X, T to except X as T.

    +
    + +
    +
    +exec
    +

    Converts the exec statement to the exec() function.

    +
    + +
    +
    +execfile
    +

    Removes usage of execfile(). The argument to execfile() is +wrapped in calls to open(), compile(), and exec().

    +
    + +
    +
    +exitfunc
    +

    Changes assignment of sys.exitfunc to use of the atexit +module.

    +
    + +
    +
    +filter
    +

    Wraps filter() usage in a list call.

    +
    + +
    +
    +funcattrs
    +

    Fixes function attributes that have been renamed. For example, +my_function.func_closure is converted to my_function.__closure__.

    +
    + +
    +
    +future
    +

    Removes from __future__ import new_feature statements.

    +
    + +
    +
    +getcwdu
    +

    Renames os.getcwdu() to os.getcwd().

    +
    + +
    +
    +has_key
    +

    Changes dict.has_key(key) to key in dict.

    +
    + +
    +
    +idioms
    +

    This optional fixer performs several transformations that make Python code +more idiomatic. Type comparisons like type(x) is SomeClass and +type(x) == SomeClass are converted to isinstance(x, SomeClass). +while 1 becomes while True. This fixer also tries to make use of +sorted() in appropriate places. For example, this block

    +
    L = list(some_iterable)
    +L.sort()
    +
    +
    +

    is changed to

    +
    L = sorted(some_iterable)
    +
    +
    +
    + +
    +
    +import
    +

    Detects sibling imports and converts them to relative imports.

    +
    + +
    +
    +imports
    +

    Handles module renames in the standard library.

    +
    + +
    +
    +imports2
    +

    Handles other modules renames in the standard library. It is separate from +the imports fixer only because of technical limitations.

    +
    + +
    +
    +input
    +

    Converts input(prompt) to eval(input(prompt)).

    +
    + +
    +
    +intern
    +

    Converts intern() to sys.intern().

    +
    + +
    +
    +isinstance
    +

    Fixes duplicate types in the second argument of isinstance(). For +example, isinstance(x, (int, int)) is converted to isinstance(x, +int) and isinstance(x, (int, float, int)) is converted to +isinstance(x, (int, float)).

    +
    + +
    +
    +itertools_imports
    +

    Removes imports of itertools.ifilter(), itertools.izip(), and +itertools.imap(). Imports of itertools.ifilterfalse() are also +changed to itertools.filterfalse().

    +
    + +
    +
    +itertools
    +

    Changes usage of itertools.ifilter(), itertools.izip(), and +itertools.imap() to their built-in equivalents. +itertools.ifilterfalse() is changed to itertools.filterfalse().

    +
    + +
    +
    +long
    +

    Renames long to int.

    +
    + +
    +
    +map
    +

    Wraps map() in a list call. It also changes map(None, x) +to list(x). Using from future_builtins import map disables this +fixer.

    +
    + +
    +
    +metaclass
    +

    Converts the old metaclass syntax (__metaclass__ = Meta in the class +body) to the new (class X(metaclass=Meta)).

    +
    + +
    +
    +methodattrs
    +

    Fixes old method attribute names. For example, meth.im_func is converted +to meth.__func__.

    +
    + +
    +
    +ne
    +

    Converts the old not-equal syntax, <>, to !=.

    +
    + +
    +
    +next
    +

    Converts the use of iterator’s next() methods to the +next() function. It also renames next() methods to +__next__().

    +
    + +
    +
    +nonzero
    +

    Renames __nonzero__() to __bool__().

    +
    + +
    +
    +numliterals
    +

    Converts octal literals into the new syntax.

    +
    + +
    +
    +operator
    +

    Converts calls to various functions in the operator module to other, +but equivalent, function calls. When needed, the appropriate import +statements are added, e.g. import collections.abc. The following mapping +are made:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    From

    To

    operator.isCallable(obj)

    callable(obj)

    operator.sequenceIncludes(obj)

    operator.contains(obj)

    operator.isSequenceType(obj)

    isinstance(obj, collections.abc.Sequence)

    operator.isMappingType(obj)

    isinstance(obj, collections.abc.Mapping)

    operator.isNumberType(obj)

    isinstance(obj, numbers.Number)

    operator.repeat(obj, n)

    operator.mul(obj, n)

    operator.irepeat(obj, n)

    operator.imul(obj, n)

    +
    + +
    +
    +paren
    +

    Add extra parenthesis where they are required in list comprehensions. For +example, [x for x in 1, 2] becomes [x for x in (1, 2)].

    +
    + +
    +
    +print
    +

    Converts the print statement to the print() function.

    +
    + +
    +
    +raise
    +

    Converts raise E, V to raise E(V), and raise E, V, T to raise +E(V).with_traceback(T). If E is a tuple, the translation will be +incorrect because substituting tuples for exceptions has been removed in 3.0.

    +
    + +
    +
    +raw_input
    +

    Converts raw_input() to input().

    +
    + +
    +
    +reduce
    +

    Handles the move of reduce() to functools.reduce().

    +
    + +
    +
    +reload
    +

    Converts reload() to importlib.reload().

    +
    + +
    +
    +renames
    +

    Changes sys.maxint to sys.maxsize.

    +
    + +
    +
    +repr
    +

    Replaces backtick repr with the repr() function.

    +
    + +
    +
    +set_literal
    +

    Replaces use of the set constructor with set literals. This fixer +is optional.

    +
    + +
    +
    +standarderror
    +

    Renames StandardError to Exception.

    +
    + +
    +
    +sys_exc
    +

    Changes the deprecated sys.exc_value, sys.exc_type, +sys.exc_traceback to use sys.exc_info().

    +
    + +
    +
    +throw
    +

    Fixes the API change in generator’s throw() method.

    +
    + +
    +
    +tuple_params
    +

    Removes implicit tuple parameter unpacking. This fixer inserts temporary +variables.

    +
    + +
    +
    +types
    +

    Fixes code broken from the removal of some members in the types +module.

    +
    + +
    +
    +unicode
    +

    Renames unicode to str.

    +
    + +
    +
    +urllib
    +

    Handles the rename of urllib and urllib2 to the urllib +package.

    +
    + +
    +
    +ws_comma
    +

    Removes excess whitespace from comma separated items. This fixer is +optional.

    +
    + +
    +
    +xrange
    +

    Renames xrange() to range() and wraps existing range() +calls with list.

    +
    + +
    +
    +xreadlines
    +

    Changes for x in file.xreadlines() to for x in file.

    +
    + +
    +
    +zip
    +

    Wraps zip() usage in a list call. This is disabled when +from future_builtins import zip appears.

    +
    + +
    +
    +

    lib2to3 - 2to3’s library

    +

    Source code: Lib/lib2to3/

    +
    +
    +

    Note

    +

    The lib2to3 API should be considered unstable and may change +drastically in the future.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/__future__.html b/python-3.7.4-docs-html/library/__future__.html new file mode 100644 index 0000000..3a211a1 --- /dev/null +++ b/python-3.7.4-docs-html/library/__future__.html @@ -0,0 +1,308 @@ + + + + + + + __future__ — Future statement definitions — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    __future__ — Future statement definitions

    +

    Source code: Lib/__future__.py

    +
    +

    __future__ is a real module, and serves three purposes:

    +
      +
    • To avoid confusing existing tools that analyze import statements and expect to +find the modules they’re importing.

    • +
    • To ensure that future statements run under releases prior to +2.1 at least yield runtime exceptions (the import of __future__ will +fail, because there was no module of that name prior to 2.1).

    • +
    • To document when incompatible changes were introduced, and when they will be +— or were — made mandatory. This is a form of executable documentation, and +can be inspected programmatically via importing __future__ and examining +its contents.

    • +
    +

    Each statement in __future__.py is of the form:

    +
    FeatureName = _Feature(OptionalRelease, MandatoryRelease,
    +                       CompilerFlag)
    +
    +
    +

    where, normally, OptionalRelease is less than MandatoryRelease, and both are +5-tuples of the same form as sys.version_info:

    +
    (PY_MAJOR_VERSION, # the 2 in 2.1.0a3; an int
    + PY_MINOR_VERSION, # the 1; an int
    + PY_MICRO_VERSION, # the 0; an int
    + PY_RELEASE_LEVEL, # "alpha", "beta", "candidate" or "final"; string
    + PY_RELEASE_SERIAL # the 3; an int
    +)
    +
    +
    +

    OptionalRelease records the first release in which the feature was accepted.

    +

    In the case of a MandatoryRelease that has not yet occurred, +MandatoryRelease predicts the release in which the feature will become part of +the language.

    +

    Else MandatoryRelease records when the feature became part of the language; in +releases at or after that, modules no longer need a future statement to use the +feature in question, but may continue to use such imports.

    +

    MandatoryRelease may also be None, meaning that a planned feature got +dropped.

    +

    Instances of class _Feature have two corresponding methods, +getOptionalRelease() and getMandatoryRelease().

    +

    CompilerFlag is the (bitfield) flag that should be passed in the fourth +argument to the built-in function compile() to enable the feature in +dynamically compiled code. This flag is stored in the compiler_flag +attribute on _Feature instances.

    +

    No feature description will ever be deleted from __future__. Since its +introduction in Python 2.1 the following features have found their way into the +language using this mechanism:

    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    feature

    optional in

    mandatory in

    effect

    nested_scopes

    2.1.0b1

    2.2

    PEP 227: +Statically Nested Scopes

    generators

    2.2.0a1

    2.3

    PEP 255: +Simple Generators

    division

    2.2.0a2

    3.0

    PEP 238: +Changing the Division Operator

    absolute_import

    2.5.0a1

    3.0

    PEP 328: +Imports: Multi-Line and Absolute/Relative

    with_statement

    2.5.0a1

    2.6

    PEP 343: +The “with” Statement

    print_function

    2.6.0a2

    3.0

    PEP 3105: +Make print a function

    unicode_literals

    2.6.0a2

    3.0

    PEP 3112: +Bytes literals in Python 3000

    generator_stop

    3.5.0b1

    3.7

    PEP 479: +StopIteration handling inside generators

    annotations

    3.7.0b1

    4.0

    PEP 563: +Postponed evaluation of annotations

    +
    +

    See also

    +
    +
    Future statements

    How the compiler treats future imports.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/__main__.html b/python-3.7.4-docs-html/library/__main__.html new file mode 100644 index 0000000..ce4015e --- /dev/null +++ b/python-3.7.4-docs-html/library/__main__.html @@ -0,0 +1,199 @@ + + + + + + + __main__ — Top-level script environment — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    __main__ — Top-level script environment

    +
    +

    '__main__' is the name of the scope in which top-level code executes. +A module’s __name__ is set equal to '__main__' when read from +standard input, a script, or from an interactive prompt.

    +

    A module can discover whether or not it is running in the main scope by +checking its own __name__, which allows a common idiom for conditionally +executing code in a module when it is run as a script or with python +-m but not when it is imported:

    +
    if __name__ == "__main__":
    +    # execute only if run as a script
    +    main()
    +
    +
    +

    For a package, the same effect can be achieved by including a +__main__.py module, the contents of which will be executed when the +module is run with -m.

    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/_dummy_thread.html b/python-3.7.4-docs-html/library/_dummy_thread.html new file mode 100644 index 0000000..dcfca47 --- /dev/null +++ b/python-3.7.4-docs-html/library/_dummy_thread.html @@ -0,0 +1,195 @@ + + + + + + + _dummy_thread — Drop-in replacement for the _thread module — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    _dummy_thread — Drop-in replacement for the _thread module

    +

    Source code: Lib/_dummy_thread.py

    +
    +

    Deprecated since version 3.7: Python now always has threading enabled. Please use _thread +(or, better, threading) instead.

    +
    +
    +

    This module provides a duplicate interface to the _thread module. +It was meant to be imported when the _thread module was not provided +on a platform.

    +

    Be careful to not use this module where deadlock might occur from a thread being +created that blocks waiting for another thread to be created. This often occurs +with blocking I/O.

    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/_thread.html b/python-3.7.4-docs-html/library/_thread.html new file mode 100644 index 0000000..fbf1ee7 --- /dev/null +++ b/python-3.7.4-docs-html/library/_thread.html @@ -0,0 +1,352 @@ + + + + + + + _thread — Low-level threading API — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    _thread — Low-level threading API

    +
    +

    This module provides low-level primitives for working with multiple threads +(also called light-weight processes or tasks) — multiple threads of +control sharing their global data space. For synchronization, simple locks +(also called mutexes or binary semaphores) are provided. +The threading module provides an easier to use and higher-level +threading API built on top of this module.

    +
    +

    Changed in version 3.7: This module used to be optional, it is now always available.

    +
    +

    This module defines the following constants and functions:

    +
    +
    +exception _thread.error
    +

    Raised on thread-specific errors.

    +
    +

    Changed in version 3.3: This is now a synonym of the built-in RuntimeError.

    +
    +
    + +
    +
    +_thread.LockType
    +

    This is the type of lock objects.

    +
    + +
    +
    +_thread.start_new_thread(function, args[, kwargs])
    +

    Start a new thread and return its identifier. The thread executes the function +function with the argument list args (which must be a tuple). The optional +kwargs argument specifies a dictionary of keyword arguments. When the function +returns, the thread silently exits. When the function terminates with an +unhandled exception, a stack trace is printed and then the thread exits (but +other threads continue to run).

    +
    + +
    +
    +_thread.interrupt_main()
    +

    Simulate the effect of a signal.SIGINT signal arriving in the main +thread. A thread can use this function to interrupt the main thread.

    +

    If signal.SIGINT isn’t handled by Python (it was set to +signal.SIG_DFL or signal.SIG_IGN), this function does +nothing.

    +
    + +
    +
    +_thread.exit()
    +

    Raise the SystemExit exception. When not caught, this will cause the +thread to exit silently.

    +
    + +
    +
    +_thread.allocate_lock()
    +

    Return a new lock object. Methods of locks are described below. The lock is +initially unlocked.

    +
    + +
    +
    +_thread.get_ident()
    +

    Return the ‘thread identifier’ of the current thread. This is a nonzero +integer. Its value has no direct meaning; it is intended as a magic cookie to +be used e.g. to index a dictionary of thread-specific data. Thread identifiers +may be recycled when a thread exits and another thread is created.

    +
    + +
    +
    +_thread.stack_size([size])
    +

    Return the thread stack size used when creating new threads. The optional +size argument specifies the stack size to be used for subsequently created +threads, and must be 0 (use platform or configured default) or a positive +integer value of at least 32,768 (32 KiB). If size is not specified, +0 is used. If changing the thread stack size is +unsupported, a RuntimeError is raised. If the specified stack size is +invalid, a ValueError is raised and the stack size is unmodified. 32 KiB +is currently the minimum supported stack size value to guarantee sufficient +stack space for the interpreter itself. Note that some platforms may have +particular restrictions on values for the stack size, such as requiring a +minimum stack size > 32 KiB or requiring allocation in multiples of the system +memory page size - platform documentation should be referred to for more +information (4 KiB pages are common; using multiples of 4096 for the stack size is +the suggested approach in the absence of more specific information).

    +

    Availability: Windows, systems with POSIX threads.

    +
    + +
    +
    +_thread.TIMEOUT_MAX
    +

    The maximum value allowed for the timeout parameter of +Lock.acquire(). Specifying a timeout greater than this value will +raise an OverflowError.

    +
    +

    New in version 3.2.

    +
    +
    + +

    Lock objects have the following methods:

    +
    +
    +lock.acquire(waitflag=1, timeout=-1)
    +

    Without any optional argument, this method acquires the lock unconditionally, if +necessary waiting until it is released by another thread (only one thread at a +time can acquire a lock — that’s their reason for existence).

    +

    If the integer waitflag argument is present, the action depends on its +value: if it is zero, the lock is only acquired if it can be acquired +immediately without waiting, while if it is nonzero, the lock is acquired +unconditionally as above.

    +

    If the floating-point timeout argument is present and positive, it +specifies the maximum wait time in seconds before returning. A negative +timeout argument specifies an unbounded wait. You cannot specify +a timeout if waitflag is zero.

    +

    The return value is True if the lock is acquired successfully, +False if not.

    +
    +

    Changed in version 3.2: The timeout parameter is new.

    +
    +
    +

    Changed in version 3.2: Lock acquires can now be interrupted by signals on POSIX.

    +
    +
    + +
    +
    +lock.release()
    +

    Releases the lock. The lock must have been acquired earlier, but not +necessarily by the same thread.

    +
    + +
    +
    +lock.locked()
    +

    Return the status of the lock: True if it has been acquired by some thread, +False if not.

    +
    + +

    In addition to these methods, lock objects can also be used via the +with statement, e.g.:

    +
    import _thread
    +
    +a_lock = _thread.allocate_lock()
    +
    +with a_lock:
    +    print("a_lock is locked while this executes")
    +
    +
    +

    Caveats:

    +
    +
    +
      +
    • Threads interact strangely with interrupts: the KeyboardInterrupt +exception will be received by an arbitrary thread. (When the signal +module is available, interrupts always go to the main thread.)

    • +
    • Calling sys.exit() or raising the SystemExit exception is +equivalent to calling _thread.exit().

    • +
    • It is not possible to interrupt the acquire() method on a lock — the +KeyboardInterrupt exception will happen after the lock has been acquired.

    • +
    • When the main thread exits, it is system defined whether the other threads +survive. On most systems, they are killed without executing +tryfinally clauses or executing object +destructors.

    • +
    • When the main thread exits, it does not do any of its usual cleanup (except +that tryfinally clauses are honored), and the +standard I/O files are not flushed.

    • +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/abc.html b/python-3.7.4-docs-html/library/abc.html new file mode 100644 index 0000000..442268d --- /dev/null +++ b/python-3.7.4-docs-html/library/abc.html @@ -0,0 +1,512 @@ + + + + + + + abc — Abstract Base Classes — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    abc — Abstract Base Classes

    +

    Source code: Lib/abc.py

    +
    +

    This module provides the infrastructure for defining abstract base +classes (ABCs) in Python, as outlined in PEP 3119; +see the PEP for why this was added to Python. (See also PEP 3141 and the +numbers module regarding a type hierarchy for numbers based on ABCs.)

    +

    The collections module has some concrete classes that derive from +ABCs; these can, of course, be further derived. In addition, the +collections.abc submodule has some ABCs that can be used to test whether +a class or instance provides a particular interface, for example, if it is +hashable or if it is a mapping.

    +

    This module provides the metaclass ABCMeta for defining ABCs and +a helper class ABC to alternatively define ABCs through inheritance:

    +
    +
    +class abc.ABC
    +

    A helper class that has ABCMeta as its metaclass. With this class, +an abstract base class can be created by simply deriving from ABC +avoiding sometimes confusing metaclass usage, for example:

    +
    from abc import ABC
    +
    +class MyABC(ABC):
    +    pass
    +
    +
    +

    Note that the type of ABC is still ABCMeta, therefore +inheriting from ABC requires the usual precautions regarding +metaclass usage, as multiple inheritance may lead to metaclass conflicts. +One may also define an abstract base class by passing the metaclass +keyword and using ABCMeta directly, for example:

    +
    from abc import ABCMeta
    +
    +class MyABC(metaclass=ABCMeta):
    +    pass
    +
    +
    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +class abc.ABCMeta
    +

    Metaclass for defining Abstract Base Classes (ABCs).

    +

    Use this metaclass to create an ABC. An ABC can be subclassed directly, and +then acts as a mix-in class. You can also register unrelated concrete +classes (even built-in classes) and unrelated ABCs as “virtual subclasses” – +these and their descendants will be considered subclasses of the registering +ABC by the built-in issubclass() function, but the registering ABC +won’t show up in their MRO (Method Resolution Order) nor will method +implementations defined by the registering ABC be callable (not even via +super()). 1

    +

    Classes created with a metaclass of ABCMeta have the following method:

    +
    +
    +register(subclass)
    +

    Register subclass as a “virtual subclass” of this ABC. For +example:

    +
    from abc import ABC
    +
    +class MyABC(ABC):
    +    pass
    +
    +MyABC.register(tuple)
    +
    +assert issubclass(tuple, MyABC)
    +assert isinstance((), MyABC)
    +
    +
    +
    +

    Changed in version 3.3: Returns the registered subclass, to allow usage as a class decorator.

    +
    +
    +

    Changed in version 3.4: To detect calls to register(), you can use the +get_cache_token() function.

    +
    +
    + +

    You can also override this method in an abstract base class:

    +
    +
    +__subclasshook__(subclass)
    +

    (Must be defined as a class method.)

    +

    Check whether subclass is considered a subclass of this ABC. This means +that you can customize the behavior of issubclass further without the +need to call register() on every class you want to consider a +subclass of the ABC. (This class method is called from the +__subclasscheck__() method of the ABC.)

    +

    This method should return True, False or NotImplemented. If +it returns True, the subclass is considered a subclass of this ABC. +If it returns False, the subclass is not considered a subclass of +this ABC, even if it would normally be one. If it returns +NotImplemented, the subclass check is continued with the usual +mechanism.

    +
    + +

    For a demonstration of these concepts, look at this example ABC definition:

    +
    class Foo:
    +    def __getitem__(self, index):
    +        ...
    +    def __len__(self):
    +        ...
    +    def get_iterator(self):
    +        return iter(self)
    +
    +class MyIterable(ABC):
    +
    +    @abstractmethod
    +    def __iter__(self):
    +        while False:
    +            yield None
    +
    +    def get_iterator(self):
    +        return self.__iter__()
    +
    +    @classmethod
    +    def __subclasshook__(cls, C):
    +        if cls is MyIterable:
    +            if any("__iter__" in B.__dict__ for B in C.__mro__):
    +                return True
    +        return NotImplemented
    +
    +MyIterable.register(Foo)
    +
    +
    +

    The ABC MyIterable defines the standard iterable method, +__iter__(), as an abstract method. The implementation given +here can still be called from subclasses. The get_iterator() method +is also part of the MyIterable abstract base class, but it does not have +to be overridden in non-abstract derived classes.

    +

    The __subclasshook__() class method defined here says that any class +that has an __iter__() method in its +__dict__ (or in that of one of its base classes, accessed +via the __mro__ list) is considered a MyIterable too.

    +

    Finally, the last line makes Foo a virtual subclass of MyIterable, +even though it does not define an __iter__() method (it uses +the old-style iterable protocol, defined in terms of __len__() and +__getitem__()). Note that this will not make get_iterator +available as a method of Foo, so it is provided separately.

    +
    + +

    The abc module also provides the following decorator:

    +
    +
    +@abc.abstractmethod
    +

    A decorator indicating abstract methods.

    +

    Using this decorator requires that the class’s metaclass is ABCMeta +or is derived from it. A class that has a metaclass derived from +ABCMeta cannot be instantiated unless all of its abstract methods +and properties are overridden. The abstract methods can be called using any +of the normal ‘super’ call mechanisms. abstractmethod() may be used +to declare abstract methods for properties and descriptors.

    +

    Dynamically adding abstract methods to a class, or attempting to modify the +abstraction status of a method or class once it is created, are not +supported. The abstractmethod() only affects subclasses derived using +regular inheritance; “virtual subclasses” registered with the ABC’s +register() method are not affected.

    +

    When abstractmethod() is applied in combination with other method +descriptors, it should be applied as the innermost decorator, as shown in +the following usage examples:

    +
    class C(ABC):
    +    @abstractmethod
    +    def my_abstract_method(self, ...):
    +        ...
    +    @classmethod
    +    @abstractmethod
    +    def my_abstract_classmethod(cls, ...):
    +        ...
    +    @staticmethod
    +    @abstractmethod
    +    def my_abstract_staticmethod(...):
    +        ...
    +
    +    @property
    +    @abstractmethod
    +    def my_abstract_property(self):
    +        ...
    +    @my_abstract_property.setter
    +    @abstractmethod
    +    def my_abstract_property(self, val):
    +        ...
    +
    +    @abstractmethod
    +    def _get_x(self):
    +        ...
    +    @abstractmethod
    +    def _set_x(self, val):
    +        ...
    +    x = property(_get_x, _set_x)
    +
    +
    +

    In order to correctly interoperate with the abstract base class machinery, +the descriptor must identify itself as abstract using +__isabstractmethod__. In general, this attribute should be True +if any of the methods used to compose the descriptor are abstract. For +example, Python’s built-in property does the equivalent of:

    +
    class Descriptor:
    +    ...
    +    @property
    +    def __isabstractmethod__(self):
    +        return any(getattr(f, '__isabstractmethod__', False) for
    +                   f in (self._fget, self._fset, self._fdel))
    +
    +
    +
    +

    Note

    +

    Unlike Java abstract methods, these abstract +methods may have an implementation. This implementation can be +called via the super() mechanism from the class that +overrides it. This could be useful as an end-point for a +super-call in a framework that uses cooperative +multiple-inheritance.

    +
    +
    + +

    The abc module also supports the following legacy decorators:

    +
    +
    +@abc.abstractclassmethod
    +
    +

    New in version 3.2.

    +
    +
    +

    Deprecated since version 3.3: It is now possible to use classmethod with +abstractmethod(), making this decorator redundant.

    +
    +

    A subclass of the built-in classmethod(), indicating an abstract +classmethod. Otherwise it is similar to abstractmethod().

    +

    This special case is deprecated, as the classmethod() decorator +is now correctly identified as abstract when applied to an abstract +method:

    +
    class C(ABC):
    +    @classmethod
    +    @abstractmethod
    +    def my_abstract_classmethod(cls, ...):
    +        ...
    +
    +
    +
    + +
    +
    +@abc.abstractstaticmethod
    +
    +

    New in version 3.2.

    +
    +
    +

    Deprecated since version 3.3: It is now possible to use staticmethod with +abstractmethod(), making this decorator redundant.

    +
    +

    A subclass of the built-in staticmethod(), indicating an abstract +staticmethod. Otherwise it is similar to abstractmethod().

    +

    This special case is deprecated, as the staticmethod() decorator +is now correctly identified as abstract when applied to an abstract +method:

    +
    class C(ABC):
    +    @staticmethod
    +    @abstractmethod
    +    def my_abstract_staticmethod(...):
    +        ...
    +
    +
    +
    + +
    +
    +@abc.abstractproperty
    +
    +

    Deprecated since version 3.3: It is now possible to use property, property.getter(), +property.setter() and property.deleter() with +abstractmethod(), making this decorator redundant.

    +
    +

    A subclass of the built-in property(), indicating an abstract +property.

    +

    This special case is deprecated, as the property() decorator +is now correctly identified as abstract when applied to an abstract +method:

    +
    class C(ABC):
    +    @property
    +    @abstractmethod
    +    def my_abstract_property(self):
    +        ...
    +
    +
    +

    The above example defines a read-only property; you can also define a +read-write abstract property by appropriately marking one or more of the +underlying methods as abstract:

    +
    class C(ABC):
    +    @property
    +    def x(self):
    +        ...
    +
    +    @x.setter
    +    @abstractmethod
    +    def x(self, val):
    +        ...
    +
    +
    +

    If only some components are abstract, only those components need to be +updated to create a concrete property in a subclass:

    +
    class D(C):
    +    @C.x.setter
    +    def x(self, val):
    +        ...
    +
    +
    +
    + +

    The abc module also provides the following functions:

    +
    +
    +abc.get_cache_token()
    +

    Returns the current abstract base class cache token.

    +

    The token is an opaque object (that supports equality testing) identifying +the current version of the abstract base class cache for virtual subclasses. +The token changes with every call to ABCMeta.register() on any ABC.

    +
    +

    New in version 3.4.

    +
    +
    + +

    Footnotes

    +
    +
    1
    +

    C++ programmers should note that Python’s virtual base class +concept is not the same as C++’s.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/aifc.html b/python-3.7.4-docs-html/library/aifc.html new file mode 100644 index 0000000..7e6cdeb --- /dev/null +++ b/python-3.7.4-docs-html/library/aifc.html @@ -0,0 +1,426 @@ + + + + + + + aifc — Read and write AIFF and AIFC files — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    aifc — Read and write AIFF and AIFC files

    +

    Source code: Lib/aifc.py

    +
    +

    This module provides support for reading and writing AIFF and AIFF-C files. +AIFF is Audio Interchange File Format, a format for storing digital audio +samples in a file. AIFF-C is a newer version of the format that includes the +ability to compress the audio data.

    +

    Audio files have a number of parameters that describe the audio data. The +sampling rate or frame rate is the number of times per second the sound is +sampled. The number of channels indicate if the audio is mono, stereo, or +quadro. Each frame consists of one sample per channel. The sample size is the +size in bytes of each sample. Thus a frame consists of +nchannels * samplesize bytes, and a second’s worth of audio consists of +nchannels * samplesize * framerate bytes.

    +

    For example, CD quality audio has a sample size of two bytes (16 bits), uses two +channels (stereo) and has a frame rate of 44,100 frames/second. This gives a +frame size of 4 bytes (2*2), and a second’s worth occupies 2*2*44100 bytes +(176,400 bytes).

    +

    Module aifc defines the following function:

    +
    +
    +aifc.open(file, mode=None)
    +

    Open an AIFF or AIFF-C file and return an object instance with methods that are +described below. The argument file is either a string naming a file or a +file object. mode must be 'r' or 'rb' when the file must be +opened for reading, or 'w' or 'wb' when the file must be opened for writing. +If omitted, file.mode is used if it exists, otherwise 'rb' is used. When +used for writing, the file object should be seekable, unless you know ahead of +time how many samples you are going to write in total and use +writeframesraw() and setnframes(). +The open() function may be used in a with statement. When +the with block completes, the close() method is called.

    +
    +

    Changed in version 3.4: Support for the with statement was added.

    +
    +
    + +

    Objects returned by open() when a file is opened for reading have the +following methods:

    +
    +
    +aifc.getnchannels()
    +

    Return the number of audio channels (1 for mono, 2 for stereo).

    +
    + +
    +
    +aifc.getsampwidth()
    +

    Return the size in bytes of individual samples.

    +
    + +
    +
    +aifc.getframerate()
    +

    Return the sampling rate (number of audio frames per second).

    +
    + +
    +
    +aifc.getnframes()
    +

    Return the number of audio frames in the file.

    +
    + +
    +
    +aifc.getcomptype()
    +

    Return a bytes array of length 4 describing the type of compression +used in the audio file. For AIFF files, the returned value is +b'NONE'.

    +
    + +
    +
    +aifc.getcompname()
    +

    Return a bytes array convertible to a human-readable description +of the type of compression used in the audio file. For AIFF files, +the returned value is b'not compressed'.

    +
    + +
    +
    +aifc.getparams()
    +

    Returns a namedtuple() (nchannels, sampwidth, +framerate, nframes, comptype, compname), equivalent to output of the +get*() methods.

    +
    + +
    +
    +aifc.getmarkers()
    +

    Return a list of markers in the audio file. A marker consists of a tuple of +three elements. The first is the mark ID (an integer), the second is the mark +position in frames from the beginning of the data (an integer), the third is the +name of the mark (a string).

    +
    + +
    +
    +aifc.getmark(id)
    +

    Return the tuple as described in getmarkers() for the mark with the given +id.

    +
    + +
    +
    +aifc.readframes(nframes)
    +

    Read and return the next nframes frames from the audio file. The returned +data is a string containing for each frame the uncompressed samples of all +channels.

    +
    + +
    +
    +aifc.rewind()
    +

    Rewind the read pointer. The next readframes() will start from the +beginning.

    +
    + +
    +
    +aifc.setpos(pos)
    +

    Seek to the specified frame number.

    +
    + +
    +
    +aifc.tell()
    +

    Return the current frame number.

    +
    + +
    +
    +aifc.close()
    +

    Close the AIFF file. After calling this method, the object can no longer be +used.

    +
    + +

    Objects returned by open() when a file is opened for writing have all the +above methods, except for readframes() and setpos(). In addition +the following methods exist. The get*() methods can only be called after +the corresponding set*() methods have been called. Before the first +writeframes() or writeframesraw(), all parameters except for the +number of frames must be filled in.

    +
    +
    +aifc.aiff()
    +

    Create an AIFF file. The default is that an AIFF-C file is created, unless the +name of the file ends in '.aiff' in which case the default is an AIFF file.

    +
    + +
    +
    +aifc.aifc()
    +

    Create an AIFF-C file. The default is that an AIFF-C file is created, unless +the name of the file ends in '.aiff' in which case the default is an AIFF +file.

    +
    + +
    +
    +aifc.setnchannels(nchannels)
    +

    Specify the number of channels in the audio file.

    +
    + +
    +
    +aifc.setsampwidth(width)
    +

    Specify the size in bytes of audio samples.

    +
    + +
    +
    +aifc.setframerate(rate)
    +

    Specify the sampling frequency in frames per second.

    +
    + +
    +
    +aifc.setnframes(nframes)
    +

    Specify the number of frames that are to be written to the audio file. If this +parameter is not set, or not set correctly, the file needs to support seeking.

    +
    + +
    +
    +aifc.setcomptype(type, name)
    +

    Specify the compression type. If not specified, the audio data will +not be compressed. In AIFF files, compression is not possible. +The name parameter should be a human-readable description of the +compression type as a bytes array, the type parameter should be a +bytes array of length 4. Currently the following compression types +are supported: b'NONE', b'ULAW', b'ALAW', b'G722'.

    +
    + +
    +
    +aifc.setparams(nchannels, sampwidth, framerate, comptype, compname)
    +

    Set all the above parameters at once. The argument is a tuple consisting of the +various parameters. This means that it is possible to use the result of a +getparams() call as argument to setparams().

    +
    + +
    +
    +aifc.setmark(id, pos, name)
    +

    Add a mark with the given id (larger than 0), and the given name at the given +position. This method can be called at any time before close().

    +
    + +
    +
    +aifc.tell()
    +

    Return the current write position in the output file. Useful in combination +with setmark().

    +
    + +
    +
    +aifc.writeframes(data)
    +

    Write data to the output file. This method can only be called after the audio +file parameters have been set.

    +
    +

    Changed in version 3.4: Any bytes-like object is now accepted.

    +
    +
    + +
    +
    +aifc.writeframesraw(data)
    +

    Like writeframes(), except that the header of the audio file is not +updated.

    +
    +

    Changed in version 3.4: Any bytes-like object is now accepted.

    +
    +
    + +
    +
    +aifc.close()
    +

    Close the AIFF file. The header of the file is updated to reflect the actual +size of the audio data. After calling this method, the object can no longer be +used.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/allos.html b/python-3.7.4-docs-html/library/allos.html new file mode 100644 index 0000000..cf03dae --- /dev/null +++ b/python-3.7.4-docs-html/library/allos.html @@ -0,0 +1,420 @@ + + + + + + + Generic Operating System Services — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Generic Operating System Services

    +

    The modules described in this chapter provide interfaces to operating system +features that are available on (almost) all operating systems, such as files and +a clock. The interfaces are generally modeled after the Unix or C interfaces, +but they are available on most other systems as well. Here’s an overview:

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/archiving.html b/python-3.7.4-docs-html/library/archiving.html new file mode 100644 index 0000000..310c926 --- /dev/null +++ b/python-3.7.4-docs-html/library/archiving.html @@ -0,0 +1,231 @@ + + + + + + + Data Compression and Archiving — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/argparse.html b/python-3.7.4-docs-html/library/argparse.html new file mode 100644 index 0000000..2915704 --- /dev/null +++ b/python-3.7.4-docs-html/library/argparse.html @@ -0,0 +1,2240 @@ + + + + + + + argparse — Parser for command-line options, arguments and sub-commands — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    argparse — Parser for command-line options, arguments and sub-commands

    +
    +

    New in version 3.2.

    +
    +

    Source code: Lib/argparse.py

    +
    + +

    The argparse module makes it easy to write user-friendly command-line +interfaces. The program defines what arguments it requires, and argparse +will figure out how to parse those out of sys.argv. The argparse +module also automatically generates help and usage messages and issues errors +when users give the program invalid arguments.

    +
    +

    Example

    +

    The following code is a Python program that takes a list of integers and +produces either the sum or the max:

    +
    import argparse
    +
    +parser = argparse.ArgumentParser(description='Process some integers.')
    +parser.add_argument('integers', metavar='N', type=int, nargs='+',
    +                    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)')
    +
    +args = parser.parse_args()
    +print(args.accumulate(args.integers))
    +
    +
    +

    Assuming the Python code above is saved into a file called prog.py, it can +be run at the command line and provides useful help messages:

    +
    $ python prog.py -h
    +usage: prog.py [-h] [--sum] N [N ...]
    +
    +Process some integers.
    +
    +positional arguments:
    + N           an integer for the accumulator
    +
    +optional arguments:
    + -h, --help  show this help message and exit
    + --sum       sum the integers (default: find the max)
    +
    +
    +

    When run with the appropriate arguments, it prints either the sum or the max of +the command-line integers:

    +
    $ python prog.py 1 2 3 4
    +4
    +
    +$ python prog.py 1 2 3 4 --sum
    +10
    +
    +
    +

    If invalid arguments are passed in, it will issue an error:

    +
    $ python prog.py a b c
    +usage: prog.py [-h] [--sum] N [N ...]
    +prog.py: error: argument N: invalid int value: 'a'
    +
    +
    +

    The following sections walk you through this example.

    +
    +

    Creating a parser

    +

    The first step in using the argparse is creating an +ArgumentParser object:

    +
    >>> parser = argparse.ArgumentParser(description='Process some integers.')
    +
    +
    +

    The ArgumentParser object will hold all the information necessary to +parse the command line into Python data types.

    +
    +
    +

    Adding arguments

    +

    Filling an ArgumentParser with information about program arguments is +done by making calls to the add_argument() method. +Generally, these calls tell the ArgumentParser how to take the strings +on the command line and turn them into objects. This information is stored and +used when parse_args() is called. For example:

    +
    >>> parser.add_argument('integers', metavar='N', type=int, nargs='+',
    +...                     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)')
    +
    +
    +

    Later, calling parse_args() will return an object with +two attributes, integers and accumulate. The integers attribute +will be a list of one or more ints, and the accumulate attribute will be +either the sum() function, if --sum was specified at the command line, +or the max() function if it was not.

    +
    +
    +

    Parsing arguments

    +

    ArgumentParser parses arguments through the +parse_args() method. This will inspect the command line, +convert each argument to the appropriate type and then invoke the appropriate action. +In most cases, this means a simple Namespace object will be built up from +attributes parsed out of the command line:

    +
    >>> parser.parse_args(['--sum', '7', '-1', '42'])
    +Namespace(accumulate=<built-in function sum>, integers=[7, -1, 42])
    +
    +
    +

    In a script, parse_args() will typically be called with no +arguments, and the ArgumentParser will automatically determine the +command-line arguments from sys.argv.

    +
    +
    +
    +

    ArgumentParser objects

    +
    +
    +class argparse.ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True)
    +

    Create a new ArgumentParser object. All parameters should be passed +as keyword arguments. Each parameter has its own more detailed description +below, but in short they are:

    +
      +
    • prog - The name of the program (default: sys.argv[0])

    • +
    • usage - The string describing the program usage (default: generated from +arguments added to parser)

    • +
    • description - Text to display before the argument help (default: none)

    • +
    • epilog - Text to display after the argument help (default: none)

    • +
    • parents - A list of ArgumentParser objects whose arguments should +also be included

    • +
    • formatter_class - A class for customizing the help output

    • +
    • prefix_chars - The set of characters that prefix optional arguments +(default: ‘-‘)

    • +
    • fromfile_prefix_chars - The set of characters that prefix files from +which additional arguments should be read (default: None)

    • +
    • argument_default - The global default value for arguments +(default: None)

    • +
    • conflict_handler - The strategy for resolving conflicting optionals +(usually unnecessary)

    • +
    • add_help - Add a -h/--help option to the parser (default: True)

    • +
    • allow_abbrev - Allows long options to be abbreviated if the +abbreviation is unambiguous. (default: True)

    • +
    +
    +

    Changed in version 3.5: allow_abbrev parameter was added.

    +
    +
    + +

    The following sections describe how each of these are used.

    +
    +

    prog

    +

    By default, ArgumentParser objects use sys.argv[0] to determine +how to display the name of the program in help messages. This default is almost +always desirable because it will make the help messages match how the program was +invoked on the command line. For example, consider a file named +myprogram.py with the following code:

    +
    import argparse
    +parser = argparse.ArgumentParser()
    +parser.add_argument('--foo', help='foo help')
    +args = parser.parse_args()
    +
    +
    +

    The help for this program will display myprogram.py as the program name +(regardless of where the program was invoked from):

    +
    $ python myprogram.py --help
    +usage: myprogram.py [-h] [--foo FOO]
    +
    +optional arguments:
    + -h, --help  show this help message and exit
    + --foo FOO   foo help
    +$ cd ..
    +$ python subdir/myprogram.py --help
    +usage: myprogram.py [-h] [--foo FOO]
    +
    +optional arguments:
    + -h, --help  show this help message and exit
    + --foo FOO   foo help
    +
    +
    +

    To change this default behavior, another value can be supplied using the +prog= argument to ArgumentParser:

    +
    >>> parser = argparse.ArgumentParser(prog='myprogram')
    +>>> parser.print_help()
    +usage: myprogram [-h]
    +
    +optional arguments:
    + -h, --help  show this help message and exit
    +
    +
    +

    Note that the program name, whether determined from sys.argv[0] or from the +prog= argument, is available to help messages using the %(prog)s format +specifier.

    +
    >>> parser = argparse.ArgumentParser(prog='myprogram')
    +>>> parser.add_argument('--foo', help='foo of the %(prog)s program')
    +>>> parser.print_help()
    +usage: myprogram [-h] [--foo FOO]
    +
    +optional arguments:
    + -h, --help  show this help message and exit
    + --foo FOO   foo of the myprogram program
    +
    +
    +
    +
    +

    usage

    +

    By default, ArgumentParser calculates the usage message from the +arguments it contains:

    +
    >>> parser = argparse.ArgumentParser(prog='PROG')
    +>>> parser.add_argument('--foo', nargs='?', help='foo help')
    +>>> parser.add_argument('bar', nargs='+', help='bar help')
    +>>> parser.print_help()
    +usage: PROG [-h] [--foo [FOO]] bar [bar ...]
    +
    +positional arguments:
    + bar          bar help
    +
    +optional arguments:
    + -h, --help   show this help message and exit
    + --foo [FOO]  foo help
    +
    +
    +

    The default message can be overridden with the usage= keyword argument:

    +
    >>> parser = argparse.ArgumentParser(prog='PROG', usage='%(prog)s [options]')
    +>>> parser.add_argument('--foo', nargs='?', help='foo help')
    +>>> parser.add_argument('bar', nargs='+', help='bar help')
    +>>> parser.print_help()
    +usage: PROG [options]
    +
    +positional arguments:
    + bar          bar help
    +
    +optional arguments:
    + -h, --help   show this help message and exit
    + --foo [FOO]  foo help
    +
    +
    +

    The %(prog)s format specifier is available to fill in the program name in +your usage messages.

    +
    +
    +

    description

    +

    Most calls to the ArgumentParser constructor will use the +description= keyword argument. This argument gives a brief description of +what the program does and how it works. In help messages, the description is +displayed between the command-line usage string and the help messages for the +various arguments:

    +
    >>> parser = argparse.ArgumentParser(description='A foo that bars')
    +>>> parser.print_help()
    +usage: argparse.py [-h]
    +
    +A foo that bars
    +
    +optional arguments:
    + -h, --help  show this help message and exit
    +
    +
    +

    By default, the description will be line-wrapped so that it fits within the +given space. To change this behavior, see the formatter_class argument.

    +
    +
    +

    epilog

    +

    Some programs like to display additional description of the program after the +description of the arguments. Such text can be specified using the epilog= +argument to ArgumentParser:

    +
    >>> parser = argparse.ArgumentParser(
    +...     description='A foo that bars',
    +...     epilog="And that's how you'd foo a bar")
    +>>> parser.print_help()
    +usage: argparse.py [-h]
    +
    +A foo that bars
    +
    +optional arguments:
    + -h, --help  show this help message and exit
    +
    +And that's how you'd foo a bar
    +
    +
    +

    As with the description argument, the epilog= text is by default +line-wrapped, but this behavior can be adjusted with the formatter_class +argument to ArgumentParser.

    +
    +
    +

    parents

    +

    Sometimes, several parsers share a common set of arguments. Rather than +repeating the definitions of these arguments, a single parser with all the +shared arguments and passed to parents= argument to ArgumentParser +can be used. The parents= argument takes a list of ArgumentParser +objects, collects all the positional and optional actions from them, and adds +these actions to the ArgumentParser object being constructed:

    +
    >>> parent_parser = argparse.ArgumentParser(add_help=False)
    +>>> parent_parser.add_argument('--parent', type=int)
    +
    +>>> foo_parser = argparse.ArgumentParser(parents=[parent_parser])
    +>>> foo_parser.add_argument('foo')
    +>>> foo_parser.parse_args(['--parent', '2', 'XXX'])
    +Namespace(foo='XXX', parent=2)
    +
    +>>> bar_parser = argparse.ArgumentParser(parents=[parent_parser])
    +>>> bar_parser.add_argument('--bar')
    +>>> bar_parser.parse_args(['--bar', 'YYY'])
    +Namespace(bar='YYY', parent=None)
    +
    +
    +

    Note that most parent parsers will specify add_help=False. Otherwise, the +ArgumentParser will see two -h/--help options (one in the parent +and one in the child) and raise an error.

    +
    +

    Note

    +

    You must fully initialize the parsers before passing them via parents=. +If you change the parent parsers after the child parser, those changes will +not be reflected in the child.

    +
    +
    +
    +

    formatter_class

    +

    ArgumentParser objects allow the help formatting to be customized by +specifying an alternate formatting class. Currently, there are four such +classes:

    +
    +
    +class argparse.RawDescriptionHelpFormatter
    +
    +class argparse.RawTextHelpFormatter
    +
    +class argparse.ArgumentDefaultsHelpFormatter
    +
    +class argparse.MetavarTypeHelpFormatter
    +
    + +

    RawDescriptionHelpFormatter and RawTextHelpFormatter give +more control over how textual descriptions are displayed. +By default, ArgumentParser objects line-wrap the description and +epilog texts in command-line help messages:

    +
    >>> parser = argparse.ArgumentParser(
    +...     prog='PROG',
    +...     description='''this description
    +...         was indented weird
    +...             but that is okay''',
    +...     epilog='''
    +...             likewise for this epilog whose whitespace will
    +...         be cleaned up and whose words will be wrapped
    +...         across a couple lines''')
    +>>> parser.print_help()
    +usage: PROG [-h]
    +
    +this description was indented weird but that is okay
    +
    +optional arguments:
    + -h, --help  show this help message and exit
    +
    +likewise for this epilog whose whitespace will be cleaned up and whose words
    +will be wrapped across a couple lines
    +
    +
    +

    Passing RawDescriptionHelpFormatter as formatter_class= +indicates that description and epilog are already correctly formatted and +should not be line-wrapped:

    +
    >>> parser = argparse.ArgumentParser(
    +...     prog='PROG',
    +...     formatter_class=argparse.RawDescriptionHelpFormatter,
    +...     description=textwrap.dedent('''\
    +...         Please do not mess up this text!
    +...         --------------------------------
    +...             I have indented it
    +...             exactly the way
    +...             I want it
    +...         '''))
    +>>> parser.print_help()
    +usage: PROG [-h]
    +
    +Please do not mess up this text!
    +--------------------------------
    +   I have indented it
    +   exactly the way
    +   I want it
    +
    +optional arguments:
    + -h, --help  show this help message and exit
    +
    +
    +

    RawTextHelpFormatter maintains whitespace for all sorts of help text, +including argument descriptions. However, multiple new lines are replaced with +one. If you wish to preserve multiple blank lines, add spaces between the +newlines.

    +

    ArgumentDefaultsHelpFormatter automatically adds information about +default values to each of the argument help messages:

    +
    >>> parser = argparse.ArgumentParser(
    +...     prog='PROG',
    +...     formatter_class=argparse.ArgumentDefaultsHelpFormatter)
    +>>> parser.add_argument('--foo', type=int, default=42, help='FOO!')
    +>>> parser.add_argument('bar', nargs='*', default=[1, 2, 3], help='BAR!')
    +>>> parser.print_help()
    +usage: PROG [-h] [--foo FOO] [bar [bar ...]]
    +
    +positional arguments:
    + bar         BAR! (default: [1, 2, 3])
    +
    +optional arguments:
    + -h, --help  show this help message and exit
    + --foo FOO   FOO! (default: 42)
    +
    +
    +

    MetavarTypeHelpFormatter uses the name of the type argument for each +argument as the display name for its values (rather than using the dest +as the regular formatter does):

    +
    >>> parser = argparse.ArgumentParser(
    +...     prog='PROG',
    +...     formatter_class=argparse.MetavarTypeHelpFormatter)
    +>>> parser.add_argument('--foo', type=int)
    +>>> parser.add_argument('bar', type=float)
    +>>> parser.print_help()
    +usage: PROG [-h] [--foo int] float
    +
    +positional arguments:
    +  float
    +
    +optional arguments:
    +  -h, --help  show this help message and exit
    +  --foo int
    +
    +
    +
    +
    +

    prefix_chars

    +

    Most command-line options will use - as the prefix, e.g. -f/--foo. +Parsers that need to support different or additional prefix +characters, e.g. for options +like +f or /foo, may specify them using the prefix_chars= argument +to the ArgumentParser constructor:

    +
    >>> parser = argparse.ArgumentParser(prog='PROG', prefix_chars='-+')
    +>>> parser.add_argument('+f')
    +>>> parser.add_argument('++bar')
    +>>> parser.parse_args('+f X ++bar Y'.split())
    +Namespace(bar='Y', f='X')
    +
    +
    +

    The prefix_chars= argument defaults to '-'. Supplying a set of +characters that does not include - will cause -f/--foo options to be +disallowed.

    +
    +
    +

    fromfile_prefix_chars

    +

    Sometimes, for example when dealing with a particularly long argument lists, it +may make sense to keep the list of arguments in a file rather than typing it out +at the command line. If the fromfile_prefix_chars= argument is given to the +ArgumentParser constructor, then arguments that start with any of the +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')
    +>>> parser = argparse.ArgumentParser(fromfile_prefix_chars='@')
    +>>> parser.add_argument('-f')
    +>>> parser.parse_args(['-f', 'foo', '@args.txt'])
    +Namespace(f='bar')
    +
    +
    +

    Arguments read from a file must by default be one per line (but see also +convert_arg_line_to_args()) and are treated as if they +were in the same place as the original file referencing argument on the command +line. So in the example above, the expression ['-f', 'foo', '@args.txt'] +is considered equivalent to the expression ['-f', 'foo', '-f', 'bar'].

    +

    The fromfile_prefix_chars= argument defaults to None, meaning that +arguments will never be treated as file references.

    +
    +
    +

    argument_default

    +

    Generally, argument defaults are specified either by passing a default to +add_argument() or by calling the +set_defaults() methods with a specific set of name-value +pairs. Sometimes however, it may be useful to specify a single parser-wide +default for arguments. This can be accomplished by passing the +argument_default= keyword argument to ArgumentParser. For example, +to globally suppress attribute creation on parse_args() +calls, we supply argument_default=SUPPRESS:

    +
    >>> parser = argparse.ArgumentParser(argument_default=argparse.SUPPRESS)
    +>>> parser.add_argument('--foo')
    +>>> parser.add_argument('bar', nargs='?')
    +>>> parser.parse_args(['--foo', '1', 'BAR'])
    +Namespace(bar='BAR', foo='1')
    +>>> parser.parse_args([])
    +Namespace()
    +
    +
    +
    +
    +

    allow_abbrev

    +

    Normally, when you pass an argument list to the +parse_args() method of an ArgumentParser, +it recognizes abbreviations of long options.

    +

    This feature can be disabled by setting allow_abbrev to False:

    +
    >>> parser = argparse.ArgumentParser(prog='PROG', allow_abbrev=False)
    +>>> parser.add_argument('--foobar', action='store_true')
    +>>> parser.add_argument('--foonley', action='store_false')
    +>>> parser.parse_args(['--foon'])
    +usage: PROG [-h] [--foobar] [--foonley]
    +PROG: error: unrecognized arguments: --foon
    +
    +
    +
    +

    New in version 3.5.

    +
    +
    +
    +

    conflict_handler

    +

    ArgumentParser objects do not allow two actions with the same option +string. By default, ArgumentParser objects raise an exception if an +attempt is made to create an argument with an option string that is already in +use:

    +
    >>> parser = argparse.ArgumentParser(prog='PROG')
    +>>> parser.add_argument('-f', '--foo', help='old foo help')
    +>>> parser.add_argument('--foo', help='new foo help')
    +Traceback (most recent call last):
    + ..
    +ArgumentError: argument --foo: conflicting option string(s): --foo
    +
    +
    +

    Sometimes (e.g. when using parents) it may be useful to simply override any +older arguments with the same option string. To get this behavior, the value +'resolve' can be supplied to the conflict_handler= argument of +ArgumentParser:

    +
    >>> parser = argparse.ArgumentParser(prog='PROG', conflict_handler='resolve')
    +>>> parser.add_argument('-f', '--foo', help='old foo help')
    +>>> parser.add_argument('--foo', help='new foo help')
    +>>> parser.print_help()
    +usage: PROG [-h] [-f FOO] [--foo FOO]
    +
    +optional arguments:
    + -h, --help  show this help message and exit
    + -f FOO      old foo help
    + --foo FOO   new foo help
    +
    +
    +

    Note that ArgumentParser objects only remove an action if all of its +option strings are overridden. So, in the example above, the old -f/--foo +action is retained as the -f action, because only the --foo option +string was overridden.

    +
    +
    +

    add_help

    +

    By default, ArgumentParser objects add an option which simply displays +the parser’s help message. For example, consider a file named +myprogram.py containing the following code:

    +
    import argparse
    +parser = argparse.ArgumentParser()
    +parser.add_argument('--foo', help='foo help')
    +args = parser.parse_args()
    +
    +
    +

    If -h or --help is supplied at the command line, the ArgumentParser +help will be printed:

    +
    $ python myprogram.py --help
    +usage: myprogram.py [-h] [--foo FOO]
    +
    +optional arguments:
    + -h, --help  show this help message and exit
    + --foo FOO   foo help
    +
    +
    +

    Occasionally, it may be useful to disable the addition of this help option. +This can be achieved by passing False as the add_help= argument to +ArgumentParser:

    +
    >>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
    +>>> parser.add_argument('--foo', help='foo help')
    +>>> parser.print_help()
    +usage: PROG [--foo FOO]
    +
    +optional arguments:
    + --foo FOO  foo help
    +
    +
    +

    The help option is typically -h/--help. The exception to this is +if the prefix_chars= is specified and does not include -, in +which case -h and --help are not valid options. In +this case, the first character in prefix_chars is used to prefix +the help options:

    +
    >>> parser = argparse.ArgumentParser(prog='PROG', prefix_chars='+/')
    +>>> parser.print_help()
    +usage: PROG [+h]
    +
    +optional arguments:
    +  +h, ++help  show this help message and exit
    +
    +
    +
    +
    +
    +

    The add_argument() method

    +
    +
    +ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])
    +

    Define how a single command-line argument should be parsed. Each parameter +has its own more detailed description below, but in short they are:

    +
      +
    • name or flags - Either a name or a list of option strings, e.g. foo +or -f, --foo.

    • +
    • action - The basic type of action to be taken when this argument is +encountered at the command line.

    • +
    • nargs - The number of command-line arguments that should be consumed.

    • +
    • const - A constant value required by some action and nargs selections.

    • +
    • default - The value produced if the argument is absent from the +command line.

    • +
    • type - The type to which the command-line argument should be converted.

    • +
    • choices - A container of the allowable values for the argument.

    • +
    • required - Whether or not the command-line option may be omitted +(optionals only).

    • +
    • help - A brief description of what the argument does.

    • +
    • metavar - A name for the argument in usage messages.

    • +
    • dest - The name of the attribute to be added to the object returned by +parse_args().

    • +
    +
    + +

    The following sections describe how each of these are used.

    +
    +

    name or flags

    +

    The add_argument() method must know whether an optional +argument, like -f or --foo, or a positional argument, like a list of +filenames, is expected. The first arguments passed to +add_argument() must therefore be either a series of +flags, or a simple argument name. For example, an optional argument could +be created like:

    +
    >>> parser.add_argument('-f', '--foo')
    +
    +
    +

    while a positional argument could be created like:

    +
    >>> parser.add_argument('bar')
    +
    +
    +

    When parse_args() is called, optional arguments will be +identified by the - prefix, and the remaining arguments will be assumed to +be positional:

    +
    >>> parser = argparse.ArgumentParser(prog='PROG')
    +>>> parser.add_argument('-f', '--foo')
    +>>> parser.add_argument('bar')
    +>>> parser.parse_args(['BAR'])
    +Namespace(bar='BAR', foo=None)
    +>>> parser.parse_args(['BAR', '--foo', 'FOO'])
    +Namespace(bar='BAR', foo='FOO')
    +>>> parser.parse_args(['--foo', 'FOO'])
    +usage: PROG [-h] [-f FOO] bar
    +PROG: error: the following arguments are required: bar
    +
    +
    +
    +
    +

    action

    +

    ArgumentParser objects associate command-line arguments with actions. These +actions can do just about anything with the command-line arguments associated with +them, though most actions simply add an attribute to the object returned by +parse_args(). The action keyword argument specifies +how the command-line arguments should be handled. The supplied actions are:

    +
      +
    • 'store' - This just stores the argument’s value. This is the default +action. For example:

      +
      >>> parser = argparse.ArgumentParser()
      +>>> parser.add_argument('--foo')
      +>>> parser.parse_args('--foo 1'.split())
      +Namespace(foo='1')
      +
      +
      +
    • +
    • 'store_const' - This stores the value specified by the const keyword +argument. The 'store_const' action is most commonly used with +optional arguments that specify some sort of flag. For example:

      +
      >>> parser = argparse.ArgumentParser()
      +>>> parser.add_argument('--foo', action='store_const', const=42)
      +>>> parser.parse_args(['--foo'])
      +Namespace(foo=42)
      +
      +
      +
    • +
    • 'store_true' and 'store_false' - These are special cases of +'store_const' used for storing the values True and False +respectively. In addition, they create default values of False and +True respectively. For example:

      +
      >>> parser = argparse.ArgumentParser()
      +>>> parser.add_argument('--foo', action='store_true')
      +>>> parser.add_argument('--bar', action='store_false')
      +>>> parser.add_argument('--baz', action='store_false')
      +>>> parser.parse_args('--foo --bar'.split())
      +Namespace(foo=True, bar=False, baz=True)
      +
      +
      +
    • +
    • 'append' - This stores a list, and appends each argument value to the +list. This is useful to allow an option to be specified multiple times. +Example usage:

      +
      >>> parser = argparse.ArgumentParser()
      +>>> parser.add_argument('--foo', action='append')
      +>>> parser.parse_args('--foo 1 --foo 2'.split())
      +Namespace(foo=['1', '2'])
      +
      +
      +
    • +
    • 'append_const' - This stores a list, and appends the value specified by +the const keyword argument to the list. (Note that the const keyword +argument defaults to None.) The 'append_const' action is typically +useful when multiple arguments need to store constants to the same list. For +example:

      +
      >>> parser = argparse.ArgumentParser()
      +>>> parser.add_argument('--str', dest='types', action='append_const', const=str)
      +>>> parser.add_argument('--int', dest='types', action='append_const', const=int)
      +>>> parser.parse_args('--str --int'.split())
      +Namespace(types=[<class 'str'>, <class 'int'>])
      +
      +
      +
    • +
    • 'count' - This counts the number of times a keyword argument occurs. For +example, this is useful for increasing verbosity levels:

      +
      >>> parser = argparse.ArgumentParser()
      +>>> parser.add_argument('--verbose', '-v', action='count')
      +>>> parser.parse_args(['-vvv'])
      +Namespace(verbose=3)
      +
      +
      +
    • +
    • 'help' - This prints a complete help message for all the options in the +current parser and then exits. By default a help action is automatically +added to the parser. See ArgumentParser for details of how the +output is created.

    • +
    • 'version' - This expects a version= keyword argument in the +add_argument() call, and prints version information +and exits when invoked:

      +
      >>> import argparse
      +>>> parser = argparse.ArgumentParser(prog='PROG')
      +>>> parser.add_argument('--version', action='version', version='%(prog)s 2.0')
      +>>> parser.parse_args(['--version'])
      +PROG 2.0
      +
      +
      +
    • +
    +

    You may also specify an arbitrary action by passing an Action subclass or +other object that implements the same interface. The recommended way to do +this is to extend Action, overriding the __call__ method +and optionally the __init__ method.

    +

    An example of a custom action:

    +
    >>> class FooAction(argparse.Action):
    +...     def __init__(self, option_strings, dest, nargs=None, **kwargs):
    +...         if nargs is not None:
    +...             raise ValueError("nargs not allowed")
    +...         super(FooAction, self).__init__(option_strings, dest, **kwargs)
    +...     def __call__(self, parser, namespace, values, option_string=None):
    +...         print('%r %r %r' % (namespace, values, option_string))
    +...         setattr(namespace, self.dest, values)
    +...
    +>>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('--foo', action=FooAction)
    +>>> parser.add_argument('bar', action=FooAction)
    +>>> args = parser.parse_args('1 --foo 2'.split())
    +Namespace(bar=None, foo=None) '1' None
    +Namespace(bar='1', foo=None) '2' '--foo'
    +>>> args
    +Namespace(bar='1', foo='2')
    +
    +
    +

    For more details, see Action.

    +
    +
    +

    nargs

    +

    ArgumentParser objects usually associate a single command-line argument with a +single action to be taken. The nargs keyword argument associates a +different number of command-line arguments with a single action. The supported +values are:

    +
      +
    • N (an integer). N arguments from the command line will be gathered +together into a list. For example:

      +
      >>> parser = argparse.ArgumentParser()
      +>>> parser.add_argument('--foo', nargs=2)
      +>>> parser.add_argument('bar', nargs=1)
      +>>> parser.parse_args('c --foo a b'.split())
      +Namespace(bar=['c'], foo=['a', 'b'])
      +
      +
      +

      Note that nargs=1 produces a list of one item. This is different from +the default, in which the item is produced by itself.

      +
    • +
    +
      +
    • '?'. One argument will be consumed from the command line if possible, and +produced as a single item. If no command-line argument is present, the value from +default will be produced. Note that for optional arguments, there is an +additional case - the option string is present but not followed by a +command-line argument. In this case the value from const will be produced. Some +examples to illustrate this:

      +
      >>> parser = argparse.ArgumentParser()
      +>>> parser.add_argument('--foo', nargs='?', const='c', default='d')
      +>>> parser.add_argument('bar', nargs='?', default='d')
      +>>> parser.parse_args(['XX', '--foo', 'YY'])
      +Namespace(bar='XX', foo='YY')
      +>>> parser.parse_args(['XX', '--foo'])
      +Namespace(bar='XX', foo='c')
      +>>> parser.parse_args([])
      +Namespace(bar='d', foo='d')
      +
      +
      +

      One of the more common uses of nargs='?' is to allow optional input and +output files:

      +
      >>> parser = argparse.ArgumentParser()
      +>>> parser.add_argument('infile', nargs='?', type=argparse.FileType('r'),
      +...                     default=sys.stdin)
      +>>> parser.add_argument('outfile', nargs='?', type=argparse.FileType('w'),
      +...                     default=sys.stdout)
      +>>> parser.parse_args(['input.txt', 'output.txt'])
      +Namespace(infile=<_io.TextIOWrapper name='input.txt' encoding='UTF-8'>,
      +          outfile=<_io.TextIOWrapper name='output.txt' encoding='UTF-8'>)
      +>>> parser.parse_args([])
      +Namespace(infile=<_io.TextIOWrapper name='<stdin>' encoding='UTF-8'>,
      +          outfile=<_io.TextIOWrapper name='<stdout>' encoding='UTF-8'>)
      +
      +
      +
    • +
    +
      +
    • '*'. All command-line arguments present are gathered into a list. Note that +it generally doesn’t make much sense to have more than one positional argument +with nargs='*', but multiple optional arguments with nargs='*' is +possible. For example:

      +
      >>> parser = argparse.ArgumentParser()
      +>>> parser.add_argument('--foo', nargs='*')
      +>>> parser.add_argument('--bar', nargs='*')
      +>>> parser.add_argument('baz', nargs='*')
      +>>> parser.parse_args('a b --foo x y --bar 1 2'.split())
      +Namespace(bar=['1', '2'], baz=['a', 'b'], foo=['x', 'y'])
      +
      +
      +
    • +
    +
      +
    • '+'. Just like '*', all command-line args present are gathered into a +list. Additionally, an error message will be generated if there wasn’t at +least one command-line argument present. For example:

      +
      >>> parser = argparse.ArgumentParser(prog='PROG')
      +>>> parser.add_argument('foo', nargs='+')
      +>>> parser.parse_args(['a', 'b'])
      +Namespace(foo=['a', 'b'])
      +>>> parser.parse_args([])
      +usage: PROG [-h] foo [foo ...]
      +PROG: error: the following arguments are required: foo
      +
      +
      +
    • +
    +
      +
    • argparse.REMAINDER. All the remaining command-line arguments are gathered +into a list. This is commonly useful for command line utilities that dispatch +to other command line utilities:

      +
      >>> parser = argparse.ArgumentParser(prog='PROG')
      +>>> parser.add_argument('--foo')
      +>>> parser.add_argument('command')
      +>>> parser.add_argument('args', nargs=argparse.REMAINDER)
      +>>> print(parser.parse_args('--foo B cmd --arg1 XX ZZ'.split()))
      +Namespace(args=['--arg1', 'XX', 'ZZ'], command='cmd', foo='B')
      +
      +
      +
    • +
    +

    If the nargs keyword argument is not provided, the number of arguments consumed +is determined by the action. Generally this means a single command-line argument +will be consumed and a single item (not a list) will be produced.

    +
    +
    +

    const

    +

    The const argument of add_argument() is used to hold +constant values that are not read from the command line but are required for +the various ArgumentParser actions. The two most common uses of it are:

    +
      +
    • When add_argument() is called with +action='store_const' or action='append_const'. These actions add the +const value to one of the attributes of the object returned by +parse_args(). See the action description for examples.

    • +
    • When add_argument() is called with option strings +(like -f or --foo) and nargs='?'. This creates an optional +argument that can be followed by zero or one command-line arguments. +When parsing the command line, if the option string is encountered with no +command-line argument following it, the value of const will be assumed instead. +See the nargs description for examples.

    • +
    +

    With the 'store_const' and 'append_const' actions, the const +keyword argument must be given. For other actions, it defaults to None.

    +
    +
    +

    default

    +

    All optional arguments and some positional arguments may be omitted at the +command line. The default keyword argument of +add_argument(), whose value defaults to None, +specifies what value should be used if the command-line argument is not present. +For optional arguments, the default value is used when the option string +was not present at the command line:

    +
    >>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('--foo', default=42)
    +>>> parser.parse_args(['--foo', '2'])
    +Namespace(foo='2')
    +>>> parser.parse_args([])
    +Namespace(foo=42)
    +
    +
    +

    If the default value is a string, the parser parses the value as if it +were a command-line argument. In particular, the parser applies any type +conversion argument, if provided, before setting the attribute on the +Namespace return value. Otherwise, the parser uses the value as is:

    +
    >>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('--length', default='10', type=int)
    +>>> parser.add_argument('--width', default=10.5, type=int)
    +>>> parser.parse_args()
    +Namespace(length=10, width=10.5)
    +
    +
    +

    For positional arguments with nargs equal to ? or *, the default value +is used when no command-line argument was present:

    +
    >>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('foo', nargs='?', default=42)
    +>>> parser.parse_args(['a'])
    +Namespace(foo='a')
    +>>> parser.parse_args([])
    +Namespace(foo=42)
    +
    +
    +

    Providing default=argparse.SUPPRESS causes no attribute to be added if the +command-line argument was not present:

    +
    >>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('--foo', default=argparse.SUPPRESS)
    +>>> parser.parse_args([])
    +Namespace()
    +>>> parser.parse_args(['--foo', '1'])
    +Namespace(foo='1')
    +
    +
    +
    +
    +

    type

    +

    By default, ArgumentParser objects read command-line arguments in as simple +strings. However, quite often the command-line string should instead be +interpreted as another type, like a float or int. The +type keyword argument of add_argument() allows any +necessary type-checking and type conversions to be performed. Common built-in +types and functions can be used directly as the value of the type argument:

    +
    >>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('foo', type=int)
    +>>> parser.add_argument('bar', type=open)
    +>>> parser.parse_args('2 temp.txt'.split())
    +Namespace(bar=<_io.TextIOWrapper name='temp.txt' encoding='UTF-8'>, foo=2)
    +
    +
    +

    See the section on the default keyword argument for information on when the +type argument is applied to default arguments.

    +

    To ease the use of various types of files, the argparse module provides the +factory FileType which takes the mode=, bufsize=, encoding= and +errors= arguments of the open() function. For example, +FileType('w') can be used to create a writable file:

    +
    >>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('bar', type=argparse.FileType('w'))
    +>>> parser.parse_args(['out.txt'])
    +Namespace(bar=<_io.TextIOWrapper name='out.txt' encoding='UTF-8'>)
    +
    +
    +

    type= can take any callable that takes a single string argument and returns +the converted value:

    +
    >>> def perfect_square(string):
    +...     value = int(string)
    +...     sqrt = math.sqrt(value)
    +...     if sqrt != int(sqrt):
    +...         msg = "%r is not a perfect square" % string
    +...         raise argparse.ArgumentTypeError(msg)
    +...     return value
    +...
    +>>> parser = argparse.ArgumentParser(prog='PROG')
    +>>> parser.add_argument('foo', type=perfect_square)
    +>>> parser.parse_args(['9'])
    +Namespace(foo=9)
    +>>> parser.parse_args(['7'])
    +usage: PROG [-h] foo
    +PROG: error: argument foo: '7' is not a perfect square
    +
    +
    +

    The choices keyword argument may be more convenient for type checkers that +simply check against a range of values:

    +
    >>> parser = argparse.ArgumentParser(prog='PROG')
    +>>> parser.add_argument('foo', type=int, choices=range(5, 10))
    +>>> parser.parse_args(['7'])
    +Namespace(foo=7)
    +>>> parser.parse_args(['11'])
    +usage: PROG [-h] {5,6,7,8,9}
    +PROG: error: argument foo: invalid choice: 11 (choose from 5, 6, 7, 8, 9)
    +
    +
    +

    See the choices section for more details.

    +
    +
    +

    choices

    +

    Some command-line arguments should be selected from a restricted set of values. +These can be handled by passing a container object as the choices keyword +argument to add_argument(). When the command line is +parsed, argument values will be checked, and an error message will be displayed +if the argument was not one of the acceptable values:

    +
    >>> parser = argparse.ArgumentParser(prog='game.py')
    +>>> parser.add_argument('move', choices=['rock', 'paper', 'scissors'])
    +>>> parser.parse_args(['rock'])
    +Namespace(move='rock')
    +>>> parser.parse_args(['fire'])
    +usage: game.py [-h] {rock,paper,scissors}
    +game.py: error: argument move: invalid choice: 'fire' (choose from 'rock',
    +'paper', 'scissors')
    +
    +
    +

    Note that inclusion in the choices container is checked after any type +conversions have been performed, so the type of the objects in the choices +container should match the type specified:

    +
    >>> parser = argparse.ArgumentParser(prog='doors.py')
    +>>> parser.add_argument('door', type=int, choices=range(1, 4))
    +>>> print(parser.parse_args(['3']))
    +Namespace(door=3)
    +>>> parser.parse_args(['4'])
    +usage: doors.py [-h] {1,2,3}
    +doors.py: error: argument door: invalid choice: 4 (choose from 1, 2, 3)
    +
    +
    +

    Any object that supports the in operator can be passed as the choices +value, so dict objects, set objects, custom containers, +etc. are all supported.

    +
    +
    +

    required

    +

    In general, the argparse module assumes that flags like -f and --bar +indicate optional arguments, which can always be omitted at the command line. +To make an option required, True can be specified for the required= +keyword argument to add_argument():

    +
    >>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('--foo', required=True)
    +>>> parser.parse_args(['--foo', 'BAR'])
    +Namespace(foo='BAR')
    +>>> parser.parse_args([])
    +usage: argparse.py [-h] [--foo FOO]
    +argparse.py: error: option --foo is required
    +
    +
    +

    As the example shows, if an option is marked as required, +parse_args() will report an error if that option is not +present at the command line.

    +
    +

    Note

    +

    Required options are generally considered bad form because users expect +options to be optional, and thus they should be avoided when possible.

    +
    +
    +
    +

    help

    +

    The help value is a string containing a brief description of the argument. +When a user requests help (usually by using -h or --help at the +command line), these help descriptions will be displayed with each +argument:

    +
    >>> parser = argparse.ArgumentParser(prog='frobble')
    +>>> parser.add_argument('--foo', action='store_true',
    +...                     help='foo the bars before frobbling')
    +>>> parser.add_argument('bar', nargs='+',
    +...                     help='one of the bars to be frobbled')
    +>>> parser.parse_args(['-h'])
    +usage: frobble [-h] [--foo] bar [bar ...]
    +
    +positional arguments:
    + bar     one of the bars to be frobbled
    +
    +optional arguments:
    + -h, --help  show this help message and exit
    + --foo   foo the bars before frobbling
    +
    +
    +

    The help strings can include various format specifiers to avoid repetition +of things like the program name or the argument default. The available +specifiers include the program name, %(prog)s and most keyword arguments to +add_argument(), e.g. %(default)s, %(type)s, etc.:

    +
    >>> parser = argparse.ArgumentParser(prog='frobble')
    +>>> parser.add_argument('bar', nargs='?', type=int, default=42,
    +...                     help='the bar to %(prog)s (default: %(default)s)')
    +>>> parser.print_help()
    +usage: frobble [-h] [bar]
    +
    +positional arguments:
    + bar     the bar to frobble (default: 42)
    +
    +optional arguments:
    + -h, --help  show this help message and exit
    +
    +
    +

    As the help string supports %-formatting, if you want a literal % to appear +in the help string, you must escape it as %%.

    +

    argparse supports silencing the help entry for certain options, by +setting the help value to argparse.SUPPRESS:

    +
    >>> parser = argparse.ArgumentParser(prog='frobble')
    +>>> parser.add_argument('--foo', help=argparse.SUPPRESS)
    +>>> parser.print_help()
    +usage: frobble [-h]
    +
    +optional arguments:
    +  -h, --help  show this help message and exit
    +
    +
    +
    +
    +

    metavar

    +

    When ArgumentParser generates help messages, it needs some way to refer +to each expected argument. By default, ArgumentParser objects use the dest +value as the “name” of each object. By default, for positional argument +actions, the dest value is used directly, and for optional argument actions, +the dest value is uppercased. So, a single positional argument with +dest='bar' will be referred to as bar. A single +optional argument --foo that should be followed by a single command-line argument +will be referred to as FOO. An example:

    +
    >>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('--foo')
    +>>> parser.add_argument('bar')
    +>>> parser.parse_args('X --foo Y'.split())
    +Namespace(bar='X', foo='Y')
    +>>> parser.print_help()
    +usage:  [-h] [--foo FOO] bar
    +
    +positional arguments:
    + bar
    +
    +optional arguments:
    + -h, --help  show this help message and exit
    + --foo FOO
    +
    +
    +

    An alternative name can be specified with metavar:

    +
    >>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('--foo', metavar='YYY')
    +>>> parser.add_argument('bar', metavar='XXX')
    +>>> parser.parse_args('X --foo Y'.split())
    +Namespace(bar='X', foo='Y')
    +>>> parser.print_help()
    +usage:  [-h] [--foo YYY] XXX
    +
    +positional arguments:
    + XXX
    +
    +optional arguments:
    + -h, --help  show this help message and exit
    + --foo YYY
    +
    +
    +

    Note that metavar only changes the displayed name - the name of the +attribute on the parse_args() object is still determined +by the dest value.

    +

    Different values of nargs may cause the metavar to be used multiple times. +Providing a tuple to metavar specifies a different display for each of the +arguments:

    +
    >>> parser = argparse.ArgumentParser(prog='PROG')
    +>>> parser.add_argument('-x', nargs=2)
    +>>> parser.add_argument('--foo', nargs=2, metavar=('bar', 'baz'))
    +>>> parser.print_help()
    +usage: PROG [-h] [-x X X] [--foo bar baz]
    +
    +optional arguments:
    + -h, --help     show this help message and exit
    + -x X X
    + --foo bar baz
    +
    +
    +
    +
    +

    dest

    +

    Most ArgumentParser actions add some value as an attribute of the +object returned by parse_args(). The name of this +attribute is determined by the dest keyword argument of +add_argument(). For positional argument actions, +dest is normally supplied as the first argument to +add_argument():

    +
    >>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('bar')
    +>>> parser.parse_args(['XXX'])
    +Namespace(bar='XXX')
    +
    +
    +

    For optional argument actions, the value of dest is normally inferred from +the option strings. ArgumentParser generates the value of dest by +taking the first long option string and stripping away the initial -- +string. If no long option strings were supplied, dest will be derived from +the first short option string by stripping the initial - character. Any +internal - characters will be converted to _ characters to make sure +the string is a valid attribute name. The examples below illustrate this +behavior:

    +
    >>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('-f', '--foo-bar', '--foo')
    +>>> parser.add_argument('-x', '-y')
    +>>> parser.parse_args('-f 1 -x 2'.split())
    +Namespace(foo_bar='1', x='2')
    +>>> parser.parse_args('--foo 1 -y 2'.split())
    +Namespace(foo_bar='1', x='2')
    +
    +
    +

    dest allows a custom attribute name to be provided:

    +
    >>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('--foo', dest='bar')
    +>>> parser.parse_args('--foo XXX'.split())
    +Namespace(bar='XXX')
    +
    +
    +
    +
    +

    Action classes

    +

    Action classes implement the Action API, a callable which returns a callable +which processes arguments from the command-line. Any object which follows +this API may be passed as the action parameter to +add_argument().

    +
    +
    +class argparse.Action(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)
    +
    + +

    Action objects are used by an ArgumentParser to represent the information +needed to parse a single argument from one or more strings from the +command line. The Action class must accept the two positional arguments +plus any keyword arguments passed to ArgumentParser.add_argument() +except for the action itself.

    +

    Instances of Action (or return value of any callable to the action +parameter) should have attributes “dest”, “option_strings”, “default”, “type”, +“required”, “help”, etc. defined. The easiest way to ensure these attributes +are defined is to call Action.__init__.

    +

    Action instances should be callable, so subclasses must override the +__call__ method, which should accept four parameters:

    +
      +
    • parser - The ArgumentParser object which contains this action.

    • +
    • namespace - The Namespace object that will be returned by +parse_args(). Most actions add an attribute to this +object using setattr().

    • +
    • values - The associated command-line arguments, with any type conversions +applied. Type conversions are specified with the type keyword argument to +add_argument().

    • +
    • option_string - The option string that was used to invoke this action. +The option_string argument is optional, and will be absent if the action +is associated with a positional argument.

    • +
    +

    The __call__ method may perform arbitrary actions, but will typically set +attributes on the namespace based on dest and values.

    +
    +
    +
    +

    The parse_args() method

    +
    +
    +ArgumentParser.parse_args(args=None, namespace=None)
    +

    Convert argument strings to objects and assign them as attributes of the +namespace. Return the populated namespace.

    +

    Previous calls to add_argument() determine exactly what objects are +created and how they are assigned. See the documentation for +add_argument() for details.

    +
      +
    • args - List of strings to parse. The default is taken from +sys.argv.

    • +
    • namespace - An object to take the attributes. The default is a new empty +Namespace object.

    • +
    +
    + +
    +

    Option value syntax

    +

    The parse_args() method supports several ways of +specifying the value of an option (if it takes one). In the simplest case, the +option and its value are passed as two separate arguments:

    +
    >>> parser = argparse.ArgumentParser(prog='PROG')
    +>>> parser.add_argument('-x')
    +>>> parser.add_argument('--foo')
    +>>> parser.parse_args(['-x', 'X'])
    +Namespace(foo=None, x='X')
    +>>> parser.parse_args(['--foo', 'FOO'])
    +Namespace(foo='FOO', x=None)
    +
    +
    +

    For long options (options with names longer than a single character), the option +and value can also be passed as a single command-line argument, using = to +separate them:

    +
    >>> parser.parse_args(['--foo=FOO'])
    +Namespace(foo='FOO', x=None)
    +
    +
    +

    For short options (options only one character long), the option and its value +can be concatenated:

    +
    >>> parser.parse_args(['-xX'])
    +Namespace(foo=None, x='X')
    +
    +
    +

    Several short options can be joined together, using only a single - prefix, +as long as only the last option (or none of them) requires a value:

    +
    >>> parser = argparse.ArgumentParser(prog='PROG')
    +>>> parser.add_argument('-x', action='store_true')
    +>>> parser.add_argument('-y', action='store_true')
    +>>> parser.add_argument('-z')
    +>>> parser.parse_args(['-xyzZ'])
    +Namespace(x=True, y=True, z='Z')
    +
    +
    +
    +
    +

    Invalid arguments

    +

    While parsing the command line, parse_args() checks for a +variety of errors, including ambiguous options, invalid types, invalid options, +wrong number of positional arguments, etc. When it encounters such an error, +it exits and prints the error along with a usage message:

    +
    >>> parser = argparse.ArgumentParser(prog='PROG')
    +>>> parser.add_argument('--foo', type=int)
    +>>> parser.add_argument('bar', nargs='?')
    +
    +>>> # invalid type
    +>>> parser.parse_args(['--foo', 'spam'])
    +usage: PROG [-h] [--foo FOO] [bar]
    +PROG: error: argument --foo: invalid int value: 'spam'
    +
    +>>> # invalid option
    +>>> parser.parse_args(['--bar'])
    +usage: PROG [-h] [--foo FOO] [bar]
    +PROG: error: no such option: --bar
    +
    +>>> # wrong number of arguments
    +>>> parser.parse_args(['spam', 'badger'])
    +usage: PROG [-h] [--foo FOO] [bar]
    +PROG: error: extra arguments found: badger
    +
    +
    +
    +
    +

    Arguments containing -

    +

    The parse_args() method attempts to give errors whenever +the user has clearly made a mistake, but some situations are inherently +ambiguous. For example, the command-line argument -1 could either be an +attempt to specify an option or an attempt to provide a positional argument. +The parse_args() method is cautious here: positional +arguments may only begin with - if they look like negative numbers and +there are no options in the parser that look like negative numbers:

    +
    >>> parser = argparse.ArgumentParser(prog='PROG')
    +>>> parser.add_argument('-x')
    +>>> parser.add_argument('foo', nargs='?')
    +
    +>>> # no negative number options, so -1 is a positional argument
    +>>> parser.parse_args(['-x', '-1'])
    +Namespace(foo=None, x='-1')
    +
    +>>> # no negative number options, so -1 and -5 are positional arguments
    +>>> parser.parse_args(['-x', '-1', '-5'])
    +Namespace(foo='-5', x='-1')
    +
    +>>> parser = argparse.ArgumentParser(prog='PROG')
    +>>> parser.add_argument('-1', dest='one')
    +>>> parser.add_argument('foo', nargs='?')
    +
    +>>> # negative number options present, so -1 is an option
    +>>> parser.parse_args(['-1', 'X'])
    +Namespace(foo=None, one='X')
    +
    +>>> # negative number options present, so -2 is an option
    +>>> parser.parse_args(['-2'])
    +usage: PROG [-h] [-1 ONE] [foo]
    +PROG: error: no such option: -2
    +
    +>>> # negative number options present, so both -1s are options
    +>>> parser.parse_args(['-1', '-1'])
    +usage: PROG [-h] [-1 ONE] [foo]
    +PROG: error: argument -1: expected one argument
    +
    +
    +

    If you have positional arguments that must begin with - and don’t look +like negative numbers, you can insert the pseudo-argument '--' which tells +parse_args() that everything after that is a positional +argument:

    +
    >>> parser.parse_args(['--', '-f'])
    +Namespace(foo='-f', one=None)
    +
    +
    +
    +
    +

    Argument abbreviations (prefix matching)

    +

    The parse_args() method by default +allows long options to be abbreviated to a prefix, if the abbreviation is +unambiguous (the prefix matches a unique option):

    +
    >>> parser = argparse.ArgumentParser(prog='PROG')
    +>>> parser.add_argument('-bacon')
    +>>> parser.add_argument('-badger')
    +>>> parser.parse_args('-bac MMM'.split())
    +Namespace(bacon='MMM', badger=None)
    +>>> parser.parse_args('-bad WOOD'.split())
    +Namespace(bacon=None, badger='WOOD')
    +>>> parser.parse_args('-ba BA'.split())
    +usage: PROG [-h] [-bacon BACON] [-badger BADGER]
    +PROG: error: ambiguous option: -ba could match -badger, -bacon
    +
    +
    +

    An error is produced for arguments that could produce more than one options. +This feature can be disabled by setting allow_abbrev to False.

    +
    +
    +

    Beyond sys.argv

    +

    Sometimes it may be useful to have an ArgumentParser parse arguments other than those +of sys.argv. This can be accomplished by passing a list of strings to +parse_args(). This is useful for testing at the +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')
    +>>> parser.add_argument(
    +...     '--sum', dest='accumulate', action='store_const', const=sum,
    +...     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'])
    +Namespace(accumulate=<built-in function sum>, integers=[1, 2, 3, 4])
    +
    +
    +
    +
    +

    The Namespace object

    +
    +
    +class argparse.Namespace
    +

    Simple class used by default by parse_args() to create +an object holding attributes and return it.

    +
    + +

    This class is deliberately simple, just an object subclass with a +readable string representation. If you prefer to have dict-like view of the +attributes, you can use the standard Python idiom, vars():

    +
    >>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('--foo')
    +>>> args = parser.parse_args(['--foo', 'BAR'])
    +>>> vars(args)
    +{'foo': 'BAR'}
    +
    +
    +

    It may also be useful to have an ArgumentParser assign attributes to an +already existing object, rather than a new Namespace object. This can +be achieved by specifying the namespace= keyword argument:

    +
    >>> class C:
    +...     pass
    +...
    +>>> c = C()
    +>>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('--foo')
    +>>> parser.parse_args(args=['--foo', 'BAR'], namespace=c)
    +>>> c.foo
    +'BAR'
    +
    +
    +
    +
    +
    +

    Other utilities

    +
    +

    Sub-commands

    +
    +
    +ArgumentParser.add_subparsers([title][, description][, prog][, parser_class][, action][, option_string][, dest][, required][, help][, metavar])
    +

    Many programs split up their functionality into a number of sub-commands, +for example, the svn program can invoke sub-commands like svn +checkout, svn update, and svn commit. Splitting up functionality +this way can be a particularly good idea when a program performs several +different functions which require different kinds of command-line arguments. +ArgumentParser supports the creation of such sub-commands with the +add_subparsers() method. The add_subparsers() method is normally +called with no arguments and returns a special action object. This object +has a single method, add_parser(), which takes a +command name and any ArgumentParser constructor arguments, and +returns an ArgumentParser object that can be modified as usual.

    +

    Description of parameters:

    +
      +
    • title - title for the sub-parser group in help output; by default +“subcommands” if description is provided, otherwise uses title for +positional arguments

    • +
    • description - description for the sub-parser group in help output, by +default None

    • +
    • prog - usage information that will be displayed with sub-command help, +by default the name of the program and any positional arguments before the +subparser argument

    • +
    • parser_class - class which will be used to create sub-parser instances, by +default the class of the current parser (e.g. ArgumentParser)

    • +
    • action - the basic type of action to be taken when this argument is +encountered at the command line

    • +
    • dest - name of the attribute under which sub-command name will be +stored; by default None and no value is stored

    • +
    • required - Whether or not a subcommand must be provided, by default +False.

    • +
    • help - help for sub-parser group in help output, by default None

    • +
    • metavar - string presenting available sub-commands in help; by default it +is None and presents sub-commands in form {cmd1, cmd2, ..}

    • +
    +

    Some example usage:

    +
    >>> # create the top-level parser
    +>>> parser = argparse.ArgumentParser(prog='PROG')
    +>>> parser.add_argument('--foo', action='store_true', help='foo help')
    +>>> subparsers = parser.add_subparsers(help='sub-command help')
    +>>>
    +>>> # create the parser for the "a" command
    +>>> parser_a = subparsers.add_parser('a', help='a help')
    +>>> parser_a.add_argument('bar', type=int, help='bar help')
    +>>>
    +>>> # create the parser for the "b" command
    +>>> parser_b = subparsers.add_parser('b', help='b help')
    +>>> parser_b.add_argument('--baz', choices='XYZ', help='baz help')
    +>>>
    +>>> # parse some argument lists
    +>>> parser.parse_args(['a', '12'])
    +Namespace(bar=12, foo=False)
    +>>> parser.parse_args(['--foo', 'b', '--baz', 'Z'])
    +Namespace(baz='Z', foo=True)
    +
    +
    +

    Note that the object returned by parse_args() will only contain +attributes for the main parser and the subparser that was selected by the +command line (and not any other subparsers). So in the example above, when +the a command is specified, only the foo and bar attributes are +present, and when the b command is specified, only the foo and +baz attributes are present.

    +

    Similarly, when a help message is requested from a subparser, only the help +for that particular parser will be printed. The help message will not +include parent parser or sibling parser messages. (A help message for each +subparser command, however, can be given by supplying the help= argument +to add_parser() as above.)

    +
    >>> parser.parse_args(['--help'])
    +usage: PROG [-h] [--foo] {a,b} ...
    +
    +positional arguments:
    +  {a,b}   sub-command help
    +    a     a help
    +    b     b help
    +
    +optional arguments:
    +  -h, --help  show this help message and exit
    +  --foo   foo help
    +
    +>>> parser.parse_args(['a', '--help'])
    +usage: PROG a [-h] bar
    +
    +positional arguments:
    +  bar     bar help
    +
    +optional arguments:
    +  -h, --help  show this help message and exit
    +
    +>>> parser.parse_args(['b', '--help'])
    +usage: PROG b [-h] [--baz {X,Y,Z}]
    +
    +optional arguments:
    +  -h, --help     show this help message and exit
    +  --baz {X,Y,Z}  baz help
    +
    +
    +

    The add_subparsers() method also supports title and description +keyword arguments. When either is present, the subparser’s commands will +appear in their own group in the help output. For example:

    +
    >>> parser = argparse.ArgumentParser()
    +>>> subparsers = parser.add_subparsers(title='subcommands',
    +...                                    description='valid subcommands',
    +...                                    help='additional help')
    +>>> subparsers.add_parser('foo')
    +>>> subparsers.add_parser('bar')
    +>>> parser.parse_args(['-h'])
    +usage:  [-h] {foo,bar} ...
    +
    +optional arguments:
    +  -h, --help  show this help message and exit
    +
    +subcommands:
    +  valid subcommands
    +
    +  {foo,bar}   additional help
    +
    +
    +

    Furthermore, add_parser supports an additional aliases argument, +which allows multiple strings to refer to the same subparser. This example, +like svn, aliases co as a shorthand for checkout:

    +
    >>> parser = argparse.ArgumentParser()
    +>>> subparsers = parser.add_subparsers()
    +>>> checkout = subparsers.add_parser('checkout', aliases=['co'])
    +>>> checkout.add_argument('foo')
    +>>> parser.parse_args(['co', 'bar'])
    +Namespace(foo='bar')
    +
    +
    +

    One particularly effective way of handling sub-commands is to combine the use +of the add_subparsers() method with calls to set_defaults() so +that each subparser knows which Python function it should execute. For +example:

    +
    >>> # sub-command functions
    +>>> def foo(args):
    +...     print(args.x * args.y)
    +...
    +>>> def bar(args):
    +...     print('((%s))' % args.z)
    +...
    +>>> # create the top-level parser
    +>>> parser = argparse.ArgumentParser()
    +>>> subparsers = parser.add_subparsers()
    +>>>
    +>>> # create the parser for the "foo" command
    +>>> parser_foo = subparsers.add_parser('foo')
    +>>> parser_foo.add_argument('-x', type=int, default=1)
    +>>> parser_foo.add_argument('y', type=float)
    +>>> parser_foo.set_defaults(func=foo)
    +>>>
    +>>> # create the parser for the "bar" command
    +>>> parser_bar = subparsers.add_parser('bar')
    +>>> parser_bar.add_argument('z')
    +>>> parser_bar.set_defaults(func=bar)
    +>>>
    +>>> # parse the args and call whatever function was selected
    +>>> args = parser.parse_args('foo 1 -x 2'.split())
    +>>> args.func(args)
    +2.0
    +>>>
    +>>> # parse the args and call whatever function was selected
    +>>> args = parser.parse_args('bar XYZYX'.split())
    +>>> args.func(args)
    +((XYZYX))
    +
    +
    +

    This way, you can let parse_args() do the job of calling the +appropriate function after argument parsing is complete. Associating +functions with actions like this is typically the easiest way to handle the +different actions for each of your subparsers. However, if it is necessary +to check the name of the subparser that was invoked, the dest keyword +argument to the add_subparsers() call will work:

    +
    >>> parser = argparse.ArgumentParser()
    +>>> subparsers = parser.add_subparsers(dest='subparser_name')
    +>>> subparser1 = subparsers.add_parser('1')
    +>>> subparser1.add_argument('-x')
    +>>> subparser2 = subparsers.add_parser('2')
    +>>> subparser2.add_argument('y')
    +>>> parser.parse_args(['2', 'frobble'])
    +Namespace(subparser_name='2', y='frobble')
    +
    +
    +
    + +
    +
    +

    FileType objects

    +
    +
    +class argparse.FileType(mode='r', bufsize=-1, encoding=None, errors=None)
    +

    The FileType factory creates objects that can be passed to the type +argument of ArgumentParser.add_argument(). Arguments that have +FileType objects as their type will open command-line arguments as +files with the requested modes, buffer sizes, encodings and error handling +(see the open() function for more details):

    +
    >>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('--raw', type=argparse.FileType('wb', 0))
    +>>> parser.add_argument('out', type=argparse.FileType('w', encoding='UTF-8'))
    +>>> parser.parse_args(['--raw', 'raw.dat', 'file.txt'])
    +Namespace(out=<_io.TextIOWrapper name='file.txt' mode='w' encoding='UTF-8'>, raw=<_io.FileIO name='raw.dat' mode='wb'>)
    +
    +
    +

    FileType objects understand the pseudo-argument '-' and automatically +convert this into sys.stdin for readable FileType objects and +sys.stdout for writable FileType objects:

    +
    >>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('infile', type=argparse.FileType('r'))
    +>>> parser.parse_args(['-'])
    +Namespace(infile=<_io.TextIOWrapper name='<stdin>' encoding='UTF-8'>)
    +
    +
    +
    +

    New in version 3.4: The encodings and errors keyword arguments.

    +
    +
    + +
    +
    +

    Argument groups

    +
    +
    +ArgumentParser.add_argument_group(title=None, description=None)
    +

    By default, ArgumentParser groups command-line arguments into +“positional arguments” and “optional arguments” when displaying help +messages. When there is a better conceptual grouping of arguments than this +default one, appropriate groups can be created using the +add_argument_group() method:

    +
    >>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
    +>>> group = parser.add_argument_group('group')
    +>>> group.add_argument('--foo', help='foo help')
    +>>> group.add_argument('bar', help='bar help')
    +>>> parser.print_help()
    +usage: PROG [--foo FOO] bar
    +
    +group:
    +  bar    bar help
    +  --foo FOO  foo help
    +
    +
    +

    The add_argument_group() method returns an argument group object which +has an add_argument() method just like a regular +ArgumentParser. When an argument is added to the group, the parser +treats it just like a normal argument, but displays the argument in a +separate group for help messages. The add_argument_group() method +accepts title and description arguments which can be used to +customize this display:

    +
    >>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
    +>>> group1 = parser.add_argument_group('group1', 'group1 description')
    +>>> group1.add_argument('foo', help='foo help')
    +>>> group2 = parser.add_argument_group('group2', 'group2 description')
    +>>> group2.add_argument('--bar', help='bar help')
    +>>> parser.print_help()
    +usage: PROG [--bar BAR] foo
    +
    +group1:
    +  group1 description
    +
    +  foo    foo help
    +
    +group2:
    +  group2 description
    +
    +  --bar BAR  bar help
    +
    +
    +

    Note that any arguments not in your user-defined groups will end up back +in the usual “positional arguments” and “optional arguments” sections.

    +
    + +
    +
    +

    Mutual exclusion

    +
    +
    +ArgumentParser.add_mutually_exclusive_group(required=False)
    +

    Create a mutually exclusive group. argparse will make sure that only +one of the arguments in the mutually exclusive group was present on the +command line:

    +
    >>> parser = argparse.ArgumentParser(prog='PROG')
    +>>> group = parser.add_mutually_exclusive_group()
    +>>> group.add_argument('--foo', action='store_true')
    +>>> group.add_argument('--bar', action='store_false')
    +>>> parser.parse_args(['--foo'])
    +Namespace(bar=True, foo=True)
    +>>> parser.parse_args(['--bar'])
    +Namespace(bar=False, foo=False)
    +>>> parser.parse_args(['--foo', '--bar'])
    +usage: PROG [-h] [--foo | --bar]
    +PROG: error: argument --bar: not allowed with argument --foo
    +
    +
    +

    The add_mutually_exclusive_group() method also accepts a required +argument, to indicate that at least one of the mutually exclusive arguments +is required:

    +
    >>> parser = argparse.ArgumentParser(prog='PROG')
    +>>> group = parser.add_mutually_exclusive_group(required=True)
    +>>> group.add_argument('--foo', action='store_true')
    +>>> group.add_argument('--bar', action='store_false')
    +>>> parser.parse_args([])
    +usage: PROG [-h] (--foo | --bar)
    +PROG: error: one of the arguments --foo --bar is required
    +
    +
    +

    Note that currently mutually exclusive argument groups do not support the +title and description arguments of +add_argument_group().

    +
    + +
    +
    +

    Parser defaults

    +
    +
    +ArgumentParser.set_defaults(**kwargs)
    +

    Most of the time, the attributes of the object returned by parse_args() +will be fully determined by inspecting the command-line arguments and the argument +actions. set_defaults() allows some additional +attributes that are determined without any inspection of the command line to +be added:

    +
    >>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('foo', type=int)
    +>>> parser.set_defaults(bar=42, baz='badger')
    +>>> parser.parse_args(['736'])
    +Namespace(bar=42, baz='badger', foo=736)
    +
    +
    +

    Note that parser-level defaults always override argument-level defaults:

    +
    >>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('--foo', default='bar')
    +>>> parser.set_defaults(foo='spam')
    +>>> parser.parse_args([])
    +Namespace(foo='spam')
    +
    +
    +

    Parser-level defaults can be particularly useful when working with multiple +parsers. See the add_subparsers() method for an +example of this type.

    +
    + +
    +
    +ArgumentParser.get_default(dest)
    +

    Get the default value for a namespace attribute, as set by either +add_argument() or by +set_defaults():

    +
    >>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('--foo', default='badger')
    +>>> parser.get_default('foo')
    +'badger'
    +
    +
    +
    + +
    +
    +

    Printing help

    +

    In most typical applications, parse_args() will take +care of formatting and printing any usage or error messages. However, several +formatting methods are available:

    +
    +
    +ArgumentParser.print_usage(file=None)
    +

    Print a brief description of how the ArgumentParser should be +invoked on the command line. If file is None, sys.stdout is +assumed.

    +
    + +
    +
    +ArgumentParser.print_help(file=None)
    +

    Print a help message, including the program usage and information about the +arguments registered with the ArgumentParser. If file is +None, sys.stdout is assumed.

    +
    + +

    There are also variants of these methods that simply return a string instead of +printing it:

    +
    +
    +ArgumentParser.format_usage()
    +

    Return a string containing a brief description of how the +ArgumentParser should be invoked on the command line.

    +
    + +
    +
    +ArgumentParser.format_help()
    +

    Return a string containing a help message, including the program usage and +information about the arguments registered with the ArgumentParser.

    +
    + +
    +
    +

    Partial parsing

    +
    +
    +ArgumentParser.parse_known_args(args=None, namespace=None)
    +
    + +

    Sometimes a script may only parse a few of the command-line arguments, passing +the remaining arguments on to another script or program. In these cases, the +parse_known_args() method can be useful. It works much like +parse_args() except that it does not produce an error when +extra arguments are present. Instead, it returns a two item tuple containing +the populated namespace and the list of remaining argument strings.

    +
    >>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('--foo', action='store_true')
    +>>> parser.add_argument('bar')
    +>>> parser.parse_known_args(['--foo', '--badger', 'BAR', 'spam'])
    +(Namespace(bar='BAR', foo=True), ['--badger', 'spam'])
    +
    +
    +
    +

    Warning

    +

    Prefix matching rules apply to +parse_known_args(). The parser may consume an option even if it’s just +a prefix of one of its known options, instead of leaving it in the remaining +arguments list.

    +
    +
    +
    +

    Customizing file parsing

    +
    +
    +ArgumentParser.convert_arg_line_to_args(arg_line)
    +

    Arguments that are read from a file (see the fromfile_prefix_chars +keyword argument to the ArgumentParser constructor) are read one +argument per line. convert_arg_line_to_args() can be overridden for +fancier reading.

    +

    This method takes a single argument arg_line which is a string read from +the argument file. It returns a list of arguments parsed from this string. +The method is called once per line read from the argument file, in order.

    +

    A useful override of this method is one that treats each space-separated word +as an argument. The following example demonstrates how to do this:

    +
    class MyArgumentParser(argparse.ArgumentParser):
    +    def convert_arg_line_to_args(self, arg_line):
    +        return arg_line.split()
    +
    +
    +
    + +
    +
    +

    Exiting methods

    +
    +
    +ArgumentParser.exit(status=0, message=None)
    +

    This method terminates the program, exiting with the specified status +and, if given, it prints a message before that.

    +
    + +
    +
    +ArgumentParser.error(message)
    +

    This method prints a usage message including the message to the +standard error and terminates the program with a status code of 2.

    +
    + +
    +
    +

    Intermixed parsing

    +
    +
    +ArgumentParser.parse_intermixed_args(args=None, namespace=None)
    +
    + +
    +
    +ArgumentParser.parse_known_intermixed_args(args=None, namespace=None)
    +
    + +

    A number of Unix commands allow the user to intermix optional arguments with +positional arguments. The parse_intermixed_args() +and parse_known_intermixed_args() methods +support this parsing style.

    +

    These parsers do not support all the argparse features, and will raise +exceptions if unsupported features are used. In particular, subparsers, +argparse.REMAINDER, and mutually exclusive groups that include both +optionals and positionals are not supported.

    +

    The following example shows the difference between +parse_known_args() and +parse_intermixed_args(): the former returns ['2', +'3'] as unparsed arguments, while the latter collects all the positionals +into rest.

    +
    >>> parser = argparse.ArgumentParser()
    +>>> parser.add_argument('--foo')
    +>>> parser.add_argument('cmd')
    +>>> parser.add_argument('rest', nargs='*', type=int)
    +>>> parser.parse_known_args('doit 1 --foo bar 2 3'.split())
    +(Namespace(cmd='doit', foo='bar', rest=[1]), ['2', '3'])
    +>>> parser.parse_intermixed_args('doit 1 --foo bar 2 3'.split())
    +Namespace(cmd='doit', foo='bar', rest=[1, 2, 3])
    +
    +
    +

    parse_known_intermixed_args() returns a two item tuple +containing the populated namespace and the list of remaining argument strings. +parse_intermixed_args() raises an error if there are any +remaining unparsed argument strings.

    +
    +

    New in version 3.7.

    +
    +
    +
    +
    +

    Upgrading optparse code

    +

    Originally, the argparse module had attempted to maintain compatibility +with optparse. However, optparse was difficult to extend +transparently, particularly with the changes required to support the new +nargs= specifiers and better usage messages. When most everything in +optparse had either been copy-pasted over or monkey-patched, it no +longer seemed practical to try to maintain the backwards compatibility.

    +

    The argparse module improves on the standard library optparse +module in a number of ways including:

    +
      +
    • Handling positional arguments.

    • +
    • Supporting sub-commands.

    • +
    • Allowing alternative option prefixes like + and /.

    • +
    • Handling zero-or-more and one-or-more style arguments.

    • +
    • Producing more informative usage messages.

    • +
    • Providing a much simpler interface for custom type and action.

    • +
    +

    A partial upgrade path from optparse to argparse:

    +
      +
    • Replace all optparse.OptionParser.add_option() calls with +ArgumentParser.add_argument() calls.

    • +
    • Replace (options, args) = parser.parse_args() with args = +parser.parse_args() and add additional ArgumentParser.add_argument() +calls for the positional arguments. Keep in mind that what was previously +called options, now in the argparse context is called args.

    • +
    • Replace optparse.OptionParser.disable_interspersed_args() +by using parse_intermixed_args() instead of +parse_args().

    • +
    • Replace callback actions and the callback_* keyword arguments with +type or action arguments.

    • +
    • Replace string names for type keyword arguments with the corresponding +type objects (e.g. int, float, complex, etc).

    • +
    • Replace optparse.Values with Namespace and +optparse.OptionError and optparse.OptionValueError with +ArgumentError.

    • +
    • Replace strings with implicit arguments such as %default or %prog with +the standard Python syntax to use dictionaries to format strings, that is, +%(default)s and %(prog)s.

    • +
    • Replace the OptionParser constructor version argument with a call to +parser.add_argument('--version', action='version', version='<the version>').

    • +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/array.html b/python-3.7.4-docs-html/library/array.html new file mode 100644 index 0000000..b35a28e --- /dev/null +++ b/python-3.7.4-docs-html/library/array.html @@ -0,0 +1,536 @@ + + + + + + + array — Efficient arrays of numeric values — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    array — Efficient arrays of numeric values

    +
    +

    This module defines an object type which can compactly represent an array of +basic values: characters, integers, floating point numbers. Arrays are sequence +types and behave very much like lists, except that the type of objects stored in +them is constrained. The type is specified at object creation time by using a +type code, which is a single character. The following type codes are +defined:

    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Type code

    C Type

    Python Type

    Minimum size in bytes

    Notes

    'b'

    signed char

    int

    1

    'B'

    unsigned char

    int

    1

    'u'

    Py_UNICODE

    Unicode character

    2

    (1)

    'h'

    signed short

    int

    2

    'H'

    unsigned short

    int

    2

    'i'

    signed int

    int

    2

    'I'

    unsigned int

    int

    2

    'l'

    signed long

    int

    4

    'L'

    unsigned long

    int

    4

    'q'

    signed long long

    int

    8

    (2)

    'Q'

    unsigned long long

    int

    8

    (2)

    'f'

    float

    float

    4

    'd'

    double

    float

    8

    +

    Notes:

    +
      +
    1. The 'u' type code corresponds to Python’s obsolete unicode character +(Py_UNICODE which is wchar_t). Depending on the +platform, it can be 16 bits or 32 bits.

      +

      'u' will be removed together with the rest of the Py_UNICODE +API.

      +
      +

      Deprecated since version 3.3, will be removed in version 4.0.

      +
      +
    2. +
    3. The 'q' and 'Q' type codes are available only if +the platform C compiler used to build Python supports C long long, +or, on Windows, __int64.

      +
      +

      New in version 3.3.

      +
      +
    4. +
    +

    The actual representation of values is determined by the machine architecture +(strictly speaking, by the C implementation). The actual size can be accessed +through the itemsize attribute.

    +

    The module defines the following type:

    +
    +
    +class array.array(typecode[, initializer])
    +

    A new array whose items are restricted by typecode, and initialized +from the optional initializer value, which must be a list, a +bytes-like object, or iterable over elements of the +appropriate type.

    +

    If given a list or string, the initializer is passed to the new array’s +fromlist(), frombytes(), or fromunicode() method (see below) +to add initial items to the array. Otherwise, the iterable initializer is +passed to the extend() method.

    +
    + +
    +
    +array.typecodes
    +

    A string with all available type codes.

    +
    + +

    Array objects support the ordinary sequence operations of indexing, slicing, +concatenation, and multiplication. When using slice assignment, the assigned +value must be an array object with the same type code; in all other cases, +TypeError is raised. Array objects also implement the buffer interface, +and may be used wherever bytes-like objects are supported.

    +

    The following data items and methods are also supported:

    +
    +
    +array.typecode
    +

    The typecode character used to create the array.

    +
    + +
    +
    +array.itemsize
    +

    The length in bytes of one array item in the internal representation.

    +
    + +
    +
    +array.append(x)
    +

    Append a new item with value x to the end of the array.

    +
    + +
    +
    +array.buffer_info()
    +

    Return a tuple (address, length) giving the current memory address and the +length in elements of the buffer used to hold array’s contents. The size of the +memory buffer in bytes can be computed as array.buffer_info()[1] * +array.itemsize. This is occasionally useful when working with low-level (and +inherently unsafe) I/O interfaces that require memory addresses, such as certain +ioctl() operations. The returned numbers are valid as long as the array +exists and no length-changing operations are applied to it.

    +
    +

    Note

    +

    When using array objects from code written in C or C++ (the only way to +effectively make use of this information), it makes more sense to use the buffer +interface supported by array objects. This method is maintained for backward +compatibility and should be avoided in new code. The buffer interface is +documented in Buffer Protocol.

    +
    +
    + +
    +
    +array.byteswap()
    +

    “Byteswap” all items of the array. This is only supported for values which are +1, 2, 4, or 8 bytes in size; for other types of values, RuntimeError is +raised. It is useful when reading data from a file written on a machine with a +different byte order.

    +
    + +
    +
    +array.count(x)
    +

    Return the number of occurrences of x in the array.

    +
    + +
    +
    +array.extend(iterable)
    +

    Append items from iterable to the end of the array. If iterable is another +array, it must have exactly the same type code; if not, TypeError will +be raised. If iterable is not an array, it must be iterable and its elements +must be the right type to be appended to the array.

    +
    + +
    +
    +array.frombytes(s)
    +

    Appends items from the string, interpreting the string as an array of machine +values (as if it had been read from a file using the fromfile() method).

    +
    +

    New in version 3.2: fromstring() is renamed to frombytes() for clarity.

    +
    +
    + +
    +
    +array.fromfile(f, n)
    +

    Read n items (as machine values) from the file object f and append +them to the end of the array. If less than n items are available, +EOFError is raised, but the items that were available are still +inserted into the array. f must be a real built-in file object; something +else with a read() method won’t do.

    +
    + +
    +
    +array.fromlist(list)
    +

    Append items from the list. This is equivalent to for x in list: +a.append(x) except that if there is a type error, the array is unchanged.

    +
    + +
    +
    +array.fromstring()
    +

    Deprecated alias for frombytes().

    +
    + +
    +
    +array.fromunicode(s)
    +

    Extends this array with data from the given unicode string. The array must +be a type 'u' array; otherwise a ValueError is raised. Use +array.frombytes(unicodestring.encode(enc)) to append Unicode data to an +array of some other type.

    +
    + +
    +
    +array.index(x)
    +

    Return the smallest i such that i is the index of the first occurrence of +x in the array.

    +
    + +
    +
    +array.insert(i, x)
    +

    Insert a new item with value x in the array before position i. Negative +values are treated as being relative to the end of the array.

    +
    + +
    +
    +array.pop([i])
    +

    Removes the item with the index i from the array and returns it. The optional +argument defaults to -1, so that by default the last item is removed and +returned.

    +
    + +
    +
    +array.remove(x)
    +

    Remove the first occurrence of x from the array.

    +
    + +
    +
    +array.reverse()
    +

    Reverse the order of the items in the array.

    +
    + +
    +
    +array.tobytes()
    +

    Convert the array to an array of machine values and return the bytes +representation (the same sequence of bytes that would be written to a file by +the tofile() method.)

    +
    +

    New in version 3.2: tostring() is renamed to tobytes() for clarity.

    +
    +
    + +
    +
    +array.tofile(f)
    +

    Write all items (as machine values) to the file object f.

    +
    + +
    +
    +array.tolist()
    +

    Convert the array to an ordinary list with the same items.

    +
    + +
    +
    +array.tostring()
    +

    Deprecated alias for tobytes().

    +
    + +
    +
    +array.tounicode()
    +

    Convert the array to a unicode string. The array must be a type 'u' array; +otherwise a ValueError is raised. Use array.tobytes().decode(enc) to +obtain a unicode string from an array of some other type.

    +
    + +

    When an array object is printed or converted to a string, it is represented as +array(typecode, initializer). The initializer is omitted if the array is +empty, otherwise it is a string if the typecode is 'u', otherwise it is a +list of numbers. The string is guaranteed to be able to be converted back to an +array with the same type and value using eval(), so long as the +array class has been imported using from array import array. +Examples:

    +
    array('l')
    +array('u', 'hello \u2641')
    +array('l', [1, 2, 3, 4, 5])
    +array('d', [1.0, 2.0, 3.14])
    +
    +
    +
    +

    See also

    +
    +
    Module struct

    Packing and unpacking of heterogeneous binary data.

    +
    +
    Module xdrlib

    Packing and unpacking of External Data Representation (XDR) data as used in some +remote procedure call systems.

    +
    +
    The Numerical Python Documentation

    The Numeric Python extension (NumPy) defines another array type; see +http://www.numpy.org/ for further information about Numerical Python.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/ast.html b/python-3.7.4-docs-html/library/ast.html new file mode 100644 index 0000000..a60103f --- /dev/null +++ b/python-3.7.4-docs-html/library/ast.html @@ -0,0 +1,592 @@ + + + + + + + ast — Abstract Syntax Trees — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    ast — Abstract Syntax Trees

    +

    Source code: Lib/ast.py

    +
    +

    The ast module helps Python applications to process trees of the Python +abstract syntax grammar. The abstract syntax itself might change with each +Python release; this module helps to find out programmatically what the current +grammar looks like.

    +

    An abstract syntax tree can be generated by passing ast.PyCF_ONLY_AST as +a flag to the compile() built-in function, or using the parse() +helper provided in this module. The result will be a tree of objects whose +classes all inherit from ast.AST. An abstract syntax tree can be +compiled into a Python code object using the built-in compile() function.

    +
    +

    Node classes

    +
    +
    +class ast.AST
    +

    This is the base of all AST node classes. The actual node classes are +derived from the Parser/Python.asdl file, which is reproduced +below. They are defined in the _ast C +module and re-exported in ast.

    +

    There is one class defined for each left-hand side symbol in the abstract +grammar (for example, ast.stmt or ast.expr). In addition, +there is one class defined for each constructor on the right-hand side; these +classes inherit from the classes for the left-hand side trees. For example, +ast.BinOp inherits from ast.expr. For production rules +with alternatives (aka “sums”), the left-hand side class is abstract: only +instances of specific constructor nodes are ever created.

    +
    +
    +_fields
    +

    Each concrete class has an attribute _fields which gives the names +of all child nodes.

    +

    Each instance of a concrete class has one attribute for each child node, +of the type as defined in the grammar. For example, ast.BinOp +instances have an attribute left of type ast.expr.

    +

    If these attributes are marked as optional in the grammar (using a +question mark), the value might be None. If the attributes can have +zero-or-more values (marked with an asterisk), the values are represented +as Python lists. All possible attributes must be present and have valid +values when compiling an AST with compile().

    +
    + +
    +
    +lineno
    +
    +col_offset
    +

    Instances of ast.expr and ast.stmt subclasses have +lineno and col_offset attributes. The lineno is +the line number of source text (1-indexed so the first line is line 1) and +the col_offset is the UTF-8 byte offset of the first token that +generated the node. The UTF-8 offset is recorded because the parser uses +UTF-8 internally.

    +
    + +

    The constructor of a class ast.T parses its arguments as follows:

    +
      +
    • If there are positional arguments, there must be as many as there are items +in T._fields; they will be assigned as attributes of these names.

    • +
    • If there are keyword arguments, they will set the attributes of the same +names to the given values.

    • +
    +

    For example, to create and populate an ast.UnaryOp node, you could +use

    +
    node = ast.UnaryOp()
    +node.op = ast.USub()
    +node.operand = ast.Num()
    +node.operand.n = 5
    +node.operand.lineno = 0
    +node.operand.col_offset = 0
    +node.lineno = 0
    +node.col_offset = 0
    +
    +
    +

    or the more compact

    +
    node = ast.UnaryOp(ast.USub(), ast.Num(5, lineno=0, col_offset=0),
    +                   lineno=0, col_offset=0)
    +
    +
    +
    + +
    +
    +

    Abstract Grammar

    +

    The abstract grammar is currently defined as follows:

    +
    -- ASDL's 7 builtin types are:
    +-- identifier, int, string, bytes, object, singleton, constant
    +--
    +-- singleton: None, True or False
    +-- constant can be None, whereas None means "no value" for object.
    +
    +module Python
    +{
    +    mod = Module(stmt* body)
    +        | Interactive(stmt* body)
    +        | Expression(expr body)
    +
    +        -- not really an actual node but useful in Jython's typesystem.
    +        | Suite(stmt* body)
    +
    +    stmt = FunctionDef(identifier name, arguments args,
    +                       stmt* body, expr* decorator_list, expr? returns)
    +          | AsyncFunctionDef(identifier name, arguments args,
    +                             stmt* body, expr* decorator_list, expr? returns)
    +
    +          | ClassDef(identifier name,
    +             expr* bases,
    +             keyword* keywords,
    +             stmt* body,
    +             expr* decorator_list)
    +          | Return(expr? value)
    +
    +          | Delete(expr* targets)
    +          | Assign(expr* targets, expr value)
    +          | AugAssign(expr target, operator op, expr value)
    +          -- 'simple' indicates that we annotate simple name without parens
    +          | AnnAssign(expr target, expr annotation, expr? value, int simple)
    +
    +          -- use 'orelse' because else is a keyword in target languages
    +          | For(expr target, expr iter, stmt* body, stmt* orelse)
    +          | AsyncFor(expr target, expr iter, stmt* body, stmt* orelse)
    +          | While(expr test, stmt* body, stmt* orelse)
    +          | If(expr test, stmt* body, stmt* orelse)
    +          | With(withitem* items, stmt* body)
    +          | AsyncWith(withitem* items, stmt* body)
    +
    +          | Raise(expr? exc, expr? cause)
    +          | Try(stmt* body, excepthandler* handlers, stmt* orelse, stmt* finalbody)
    +          | Assert(expr test, expr? msg)
    +
    +          | Import(alias* names)
    +          | ImportFrom(identifier? module, alias* names, int? level)
    +
    +          | Global(identifier* names)
    +          | Nonlocal(identifier* names)
    +          | Expr(expr value)
    +          | Pass | Break | Continue
    +
    +          -- XXX Jython will be different
    +          -- col_offset is the byte offset in the utf8 string the parser uses
    +          attributes (int lineno, int col_offset)
    +
    +          -- BoolOp() can use left & right?
    +    expr = BoolOp(boolop op, expr* values)
    +         | BinOp(expr left, operator op, expr right)
    +         | UnaryOp(unaryop op, expr operand)
    +         | Lambda(arguments args, expr body)
    +         | IfExp(expr test, expr body, expr orelse)
    +         | Dict(expr* keys, expr* values)
    +         | Set(expr* elts)
    +         | ListComp(expr elt, comprehension* generators)
    +         | SetComp(expr elt, comprehension* generators)
    +         | DictComp(expr key, expr value, comprehension* generators)
    +         | GeneratorExp(expr elt, comprehension* generators)
    +         -- the grammar constrains where yield expressions can occur
    +         | Await(expr value)
    +         | Yield(expr? value)
    +         | YieldFrom(expr value)
    +         -- need sequences for compare to distinguish between
    +         -- x < 4 < 3 and (x < 4) < 3
    +         | Compare(expr left, cmpop* ops, expr* comparators)
    +         | Call(expr func, expr* args, keyword* keywords)
    +         | Num(object n) -- a number as a PyObject.
    +         | Str(string s) -- need to specify raw, unicode, etc?
    +         | FormattedValue(expr value, int? conversion, expr? format_spec)
    +         | JoinedStr(expr* values)
    +         | Bytes(bytes s)
    +         | NameConstant(singleton value)
    +         | Ellipsis
    +         | Constant(constant value)
    +
    +         -- the following expression can appear in assignment context
    +         | Attribute(expr value, identifier attr, expr_context ctx)
    +         | Subscript(expr value, slice slice, expr_context ctx)
    +         | Starred(expr value, expr_context ctx)
    +         | Name(identifier id, expr_context ctx)
    +         | List(expr* elts, expr_context ctx)
    +         | Tuple(expr* elts, expr_context ctx)
    +
    +          -- col_offset is the byte offset in the utf8 string the parser uses
    +          attributes (int lineno, int col_offset)
    +
    +    expr_context = Load | Store | Del | AugLoad | AugStore | Param
    +
    +    slice = Slice(expr? lower, expr? upper, expr? step)
    +          | ExtSlice(slice* dims)
    +          | Index(expr value)
    +
    +    boolop = And | Or
    +
    +    operator = Add | Sub | Mult | MatMult | Div | Mod | Pow | LShift
    +                 | RShift | BitOr | BitXor | BitAnd | FloorDiv
    +
    +    unaryop = Invert | Not | UAdd | USub
    +
    +    cmpop = Eq | NotEq | Lt | LtE | Gt | GtE | Is | IsNot | In | NotIn
    +
    +    comprehension = (expr target, expr iter, expr* ifs, int is_async)
    +
    +    excepthandler = ExceptHandler(expr? type, identifier? name, stmt* body)
    +                    attributes (int lineno, int col_offset)
    +
    +    arguments = (arg* args, arg? vararg, arg* kwonlyargs, expr* kw_defaults,
    +                 arg? kwarg, expr* defaults)
    +
    +    arg = (identifier arg, expr? annotation)
    +           attributes (int lineno, int col_offset)
    +
    +    -- keyword arguments supplied to call (NULL identifier for **kwargs)
    +    keyword = (identifier? arg, expr value)
    +
    +    -- import name with optional 'as' alias.
    +    alias = (identifier name, identifier? asname)
    +
    +    withitem = (expr context_expr, expr? optional_vars)
    +}
    +
    +
    +
    +
    +
    +

    ast Helpers

    +

    Apart from the node classes, the ast module defines these utility functions +and classes for traversing abstract syntax trees:

    +
    +
    +ast.parse(source, filename='<unknown>', mode='exec')
    +

    Parse the source into an AST node. Equivalent to compile(source, +filename, mode, ast.PyCF_ONLY_AST).

    +
    +

    Warning

    +

    It is possible to crash the Python interpreter with a +sufficiently large/complex string due to stack depth limitations +in Python’s AST compiler.

    +
    +
    + +
    +
    +ast.literal_eval(node_or_string)
    +

    Safely evaluate an expression node or a string containing a Python literal or +container display. The string or node provided may only consist of the +following Python literal structures: strings, bytes, numbers, tuples, lists, +dicts, sets, booleans, and None.

    +

    This can be used for safely evaluating strings containing Python values from +untrusted sources without the need to parse the values oneself. It is not +capable of evaluating arbitrarily complex expressions, for example involving +operators or indexing.

    +
    +

    Warning

    +

    It is possible to crash the Python interpreter with a +sufficiently large/complex string due to stack depth limitations +in Python’s AST compiler.

    +
    +
    +

    Changed in version 3.2: Now allows bytes and set literals.

    +
    +
    + +
    +
    +ast.get_docstring(node, clean=True)
    +

    Return the docstring of the given node (which must be a +FunctionDef, AsyncFunctionDef, ClassDef, +or Module node), or None if it has no docstring. +If clean is true, clean up the docstring’s indentation with +inspect.cleandoc().

    +
    +

    Changed in version 3.5: AsyncFunctionDef is now supported.

    +
    +
    + +
    +
    +ast.fix_missing_locations(node)
    +

    When you compile a node tree with compile(), the compiler expects +lineno and col_offset attributes for every node that supports +them. This is rather tedious to fill in for generated nodes, so this helper +adds these attributes recursively where not already set, by setting them to +the values of the parent node. It works recursively starting at node.

    +
    + +
    +
    +ast.increment_lineno(node, n=1)
    +

    Increment the line number of each node in the tree starting at node by n. +This is useful to “move code” to a different location in a file.

    +
    + +
    +
    +ast.copy_location(new_node, old_node)
    +

    Copy source location (lineno and col_offset) from old_node +to new_node if possible, and return new_node.

    +
    + +
    +
    +ast.iter_fields(node)
    +

    Yield a tuple of (fieldname, value) for each field in node._fields +that is present on node.

    +
    + +
    +
    +ast.iter_child_nodes(node)
    +

    Yield all direct child nodes of node, that is, all fields that are nodes +and all items of fields that are lists of nodes.

    +
    + +
    +
    +ast.walk(node)
    +

    Recursively yield all descendant nodes in the tree starting at node +(including node itself), in no specified order. This is useful if you only +want to modify nodes in place and don’t care about the context.

    +
    + +
    +
    +class ast.NodeVisitor
    +

    A node visitor base class that walks the abstract syntax tree and calls a +visitor function for every node found. This function may return a value +which is forwarded by the visit() method.

    +

    This class is meant to be subclassed, with the subclass adding visitor +methods.

    +
    +
    +visit(node)
    +

    Visit a node. The default implementation calls the method called +self.visit_classname where classname is the name of the node +class, or generic_visit() if that method doesn’t exist.

    +
    + +
    +
    +generic_visit(node)
    +

    This visitor calls visit() on all children of the node.

    +

    Note that child nodes of nodes that have a custom visitor method won’t be +visited unless the visitor calls generic_visit() or visits them +itself.

    +
    + +

    Don’t use the NodeVisitor if you want to apply changes to nodes +during traversal. For this a special visitor exists +(NodeTransformer) that allows modifications.

    +
    + +
    +
    +class ast.NodeTransformer
    +

    A NodeVisitor subclass that walks the abstract syntax tree and +allows modification of nodes.

    +

    The NodeTransformer will walk the AST and use the return value of +the visitor methods to replace or remove the old node. If the return value +of the visitor method is None, the node will be removed from its +location, otherwise it is replaced with the return value. The return value +may be the original node in which case no replacement takes place.

    +

    Here is an example transformer that rewrites all occurrences of name lookups +(foo) to data['foo']:

    +
    class RewriteName(NodeTransformer):
    +
    +    def visit_Name(self, node):
    +        return copy_location(Subscript(
    +            value=Name(id='data', ctx=Load()),
    +            slice=Index(value=Str(s=node.id)),
    +            ctx=node.ctx
    +        ), node)
    +
    +
    +

    Keep in mind that if the node you’re operating on has child nodes you must +either transform the child nodes yourself or call the generic_visit() +method for the node first.

    +

    For nodes that were part of a collection of statements (that applies to all +statement nodes), the visitor may also return a list of nodes rather than +just a single node.

    +

    Usually you use the transformer like this:

    +
    node = YourTransformer().visit(node)
    +
    +
    +
    + +
    +
    +ast.dump(node, annotate_fields=True, include_attributes=False)
    +

    Return a formatted dump of the tree in node. This is mainly useful for +debugging purposes. The returned string will show the names and the values +for fields. This makes the code impossible to evaluate, so if evaluation is +wanted annotate_fields must be set to False. Attributes such as line +numbers and column offsets are not dumped by default. If this is wanted, +include_attributes can be set to True.

    +
    + +
    +

    See also

    +

    Green Tree Snakes, an external documentation resource, has good +details on working with Python ASTs.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/asynchat.html b/python-3.7.4-docs-html/library/asynchat.html new file mode 100644 index 0000000..1a07433 --- /dev/null +++ b/python-3.7.4-docs-html/library/asynchat.html @@ -0,0 +1,405 @@ + + + + + + + asynchat — Asynchronous socket command/response handler — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    asynchat — Asynchronous socket command/response handler

    +

    Source code: Lib/asynchat.py

    +
    +

    Deprecated since version 3.6: Please use asyncio instead.

    +
    +
    +
    +

    Note

    +

    This module exists for backwards compatibility only. For new code we +recommend using asyncio.

    +
    +

    This module builds on the asyncore infrastructure, simplifying +asynchronous clients and servers and making it easier to handle protocols +whose elements are terminated by arbitrary strings, or are of variable length. +asynchat defines the abstract class async_chat that you +subclass, providing implementations of the collect_incoming_data() and +found_terminator() methods. It uses the same asynchronous loop as +asyncore, and the two types of channel, asyncore.dispatcher +and asynchat.async_chat, can freely be mixed in the channel map. +Typically an asyncore.dispatcher server channel generates new +asynchat.async_chat channel objects as it receives incoming +connection requests.

    +
    +
    +class asynchat.async_chat
    +

    This class is an abstract subclass of asyncore.dispatcher. To make +practical use of the code you must subclass async_chat, providing +meaningful collect_incoming_data() and found_terminator() +methods. +The asyncore.dispatcher methods can be used, although not all make +sense in a message/response context.

    +

    Like asyncore.dispatcher, async_chat defines a set of +events that are generated by an analysis of socket conditions after a +select() call. Once the polling loop has been started the +async_chat object’s methods are called by the event-processing +framework with no action on the part of the programmer.

    +

    Two class attributes can be modified, to improve performance, or possibly +even to conserve memory.

    +
    +
    +ac_in_buffer_size
    +

    The asynchronous input buffer size (default 4096).

    +
    + +
    +
    +ac_out_buffer_size
    +

    The asynchronous output buffer size (default 4096).

    +
    + +

    Unlike asyncore.dispatcher, async_chat allows you to +define a FIFO queue of producers. A producer need +have only one method, more(), which should return data to be +transmitted on the channel. +The producer indicates exhaustion (i.e. that it contains no more data) by +having its more() method return the empty bytes object. At this point +the async_chat object removes the producer from the queue and starts +using the next producer, if any. When the producer queue is empty the +handle_write() method does nothing. You use the channel object’s +set_terminator() method to describe how to recognize the end of, or +an important breakpoint in, an incoming transmission from the remote +endpoint.

    +

    To build a functioning async_chat subclass your input methods +collect_incoming_data() and found_terminator() must handle the +data that the channel receives asynchronously. The methods are described +below.

    +
    + +
    +
    +async_chat.close_when_done()
    +

    Pushes a None on to the producer queue. When this producer is popped off +the queue it causes the channel to be closed.

    +
    + +
    +
    +async_chat.collect_incoming_data(data)
    +

    Called with data holding an arbitrary amount of received data. The +default method, which must be overridden, raises a +NotImplementedError exception.

    +
    + +
    +
    +async_chat.discard_buffers()
    +

    In emergencies this method will discard any data held in the input and/or +output buffers and the producer queue.

    +
    + +
    +
    +async_chat.found_terminator()
    +

    Called when the incoming data stream matches the termination condition set +by set_terminator(). The default method, which must be overridden, +raises a NotImplementedError exception. The buffered input data +should be available via an instance attribute.

    +
    + +
    +
    +async_chat.get_terminator()
    +

    Returns the current terminator for the channel.

    +
    + +
    +
    +async_chat.push(data)
    +

    Pushes data on to the channel’s queue to ensure its transmission. +This is all you need to do to have the channel write the data out to the +network, although it is possible to use your own producers in more complex +schemes to implement encryption and chunking, for example.

    +
    + +
    +
    +async_chat.push_with_producer(producer)
    +

    Takes a producer object and adds it to the producer queue associated with +the channel. When all currently-pushed producers have been exhausted the +channel will consume this producer’s data by calling its more() +method and send the data to the remote endpoint.

    +
    + +
    +
    +async_chat.set_terminator(term)
    +

    Sets the terminating condition to be recognized on the channel. term +may be any of three types of value, corresponding to three different ways +to handle incoming protocol data.

    + ++++ + + + + + + + + + + + + + + + + +

    term

    Description

    string

    Will call found_terminator() when the +string is found in the input stream

    integer

    Will call found_terminator() when the +indicated number of characters have been +received

    None

    The channel continues to collect data +forever

    +

    Note that any data following the terminator will be available for reading +by the channel after found_terminator() is called.

    +
    + +
    +

    asynchat Example

    +

    The following partial example shows how HTTP requests can be read with +async_chat. A web server might create an +http_request_handler object for each incoming client connection. +Notice that initially the channel terminator is set to match the blank line at +the end of the HTTP headers, and a flag indicates that the headers are being +read.

    +

    Once the headers have been read, if the request is of type POST (indicating +that further data are present in the input stream) then the +Content-Length: header is used to set a numeric terminator to read the +right amount of data from the channel.

    +

    The handle_request() method is called once all relevant input has been +marshalled, after setting the channel terminator to None to ensure that +any extraneous data sent by the web client are ignored.

    +
    import asynchat
    +
    +class http_request_handler(asynchat.async_chat):
    +
    +    def __init__(self, sock, addr, sessions, log):
    +        asynchat.async_chat.__init__(self, sock=sock)
    +        self.addr = addr
    +        self.sessions = sessions
    +        self.ibuffer = []
    +        self.obuffer = b""
    +        self.set_terminator(b"\r\n\r\n")
    +        self.reading_headers = True
    +        self.handling = False
    +        self.cgi_data = None
    +        self.log = log
    +
    +    def collect_incoming_data(self, data):
    +        """Buffer the data"""
    +        self.ibuffer.append(data)
    +
    +    def found_terminator(self):
    +        if self.reading_headers:
    +            self.reading_headers = False
    +            self.parse_headers(b"".join(self.ibuffer))
    +            self.ibuffer = []
    +            if self.op.upper() == b"POST":
    +                clen = self.headers.getheader("content-length")
    +                self.set_terminator(int(clen))
    +            else:
    +                self.handling = True
    +                self.set_terminator(None)
    +                self.handle_request()
    +        elif not self.handling:
    +            self.set_terminator(None)  # browsers sometimes over-send
    +            self.cgi_data = parse(self.headers, b"".join(self.ibuffer))
    +            self.handling = True
    +            self.ibuffer = []
    +            self.handle_request()
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/asyncio-api-index.html b/python-3.7.4-docs-html/library/asyncio-api-index.html new file mode 100644 index 0000000..2b1fa93 --- /dev/null +++ b/python-3.7.4-docs-html/library/asyncio-api-index.html @@ -0,0 +1,402 @@ + + + + + + + High-level API Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    High-level API Index

    +

    This page lists all high-level async/await enabled asyncio APIs.

    +
    +

    Tasks

    +

    Utilities to run asyncio programs, create Tasks, and +await on multiple things with timeouts.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    run()

    Create event loop, run a coroutine, close the loop.

    create_task()

    Start an asyncio Task.

    await sleep()

    Sleep for a number of seconds.

    await gather()

    Schedule and wait for things concurrently.

    await wait_for()

    Run with a timeout.

    await shield()

    Shield from cancellation.

    await wait()

    Monitor for completion.

    current_task()

    Return the current Task.

    all_tasks()

    Return all tasks for an event loop.

    Task

    Task object.

    run_coroutine_threadsafe()

    Schedule a coroutine from another OS thread.

    for in as_completed()

    Monitor for completion with a for loop.

    +

    Examples

    + +
    +
    +

    Queues

    +

    Queues should be used to distribute work amongst multiple asyncio Tasks, +implement connection pools, and pub/sub patterns.

    + ++++ + + + + + + + + + + + +

    Queue

    A FIFO queue.

    PriorityQueue

    A priority queue.

    LifoQueue

    A LIFO queue.

    +

    Examples

    + +
    +
    +

    Subprocesses

    +

    Utilities to spawn subprocesses and run shell commands.

    + ++++ + + + + + + + + +

    await create_subprocess_exec()

    Create a subprocess.

    await create_subprocess_shell()

    Run a shell command.

    +

    Examples

    + +
    +
    +

    Streams

    +

    High-level APIs to work with network IO.

    + ++++ + + + + + + + + + + + + + + + + + + + + +

    await open_connection()

    Establish a TCP connection.

    await open_unix_connection()

    Establish a Unix socket connection.

    await start_server()

    Start a TCP server.

    await start_unix_server()

    Start a Unix socket server.

    StreamReader

    High-level async/await object to receive network data.

    StreamWriter

    High-level async/await object to send network data.

    +

    Examples

    + +
    +
    +

    Synchronization

    +

    Threading-like synchronization primitives that can be used in Tasks.

    + ++++ + + + + + + + + + + + + + + + + + +

    Lock

    A mutex lock.

    Event

    An event object.

    Condition

    A condition object.

    Semaphore

    A semaphore.

    BoundedSemaphore

    A bounded semaphore.

    +

    Examples

    + +
    +
    +

    Exceptions

    + ++++ + + + + + + + + +

    asyncio.TimeoutError

    Raised on timeout by functions like wait_for(). +Keep in mind that asyncio.TimeoutError is unrelated +to the built-in TimeoutError exception.

    asyncio.CancelledError

    Raised when a Task is cancelled. See also Task.cancel().

    +

    Examples

    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/asyncio-dev.html b/python-3.7.4-docs-html/library/asyncio-dev.html new file mode 100644 index 0000000..85fdc02 --- /dev/null +++ b/python-3.7.4-docs-html/library/asyncio-dev.html @@ -0,0 +1,395 @@ + + + + + + + Developing with asyncio — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Developing with asyncio

    +

    Asynchronous programming is different from classic “sequential” +programming.

    +

    This page lists common mistakes and traps and explains how +to avoid them.

    +
    +

    Debug Mode

    +

    By default asyncio runs in production mode. In order to ease +the development asyncio has a debug mode.

    +

    There are several ways to enable asyncio debug mode:

    + +

    In addition to enabling the debug mode, consider also:

    +
      +
    • setting the log level of the asyncio logger to +logging.DEBUG, for example the following snippet of code +can be run at startup of the application:

      +
      logging.basicConfig(level=logging.DEBUG)
      +
      +
      +
    • +
    • configuring the warnings module to display +ResourceWarning warnings. One way of doing that is by +using the -W default command line option.

    • +
    +

    When the debug mode is enabled:

    +
      +
    • asyncio checks for coroutines that were not awaited and logs them; this mitigates +the “forgotten await” pitfall.

    • +
    • Many non-threadsafe asyncio APIs (such as loop.call_soon() and +loop.call_at() methods) raise an exception if they are called +from a wrong thread.

    • +
    • The execution time of the I/O selector is logged if it takes too long to +perform an I/O operation.

    • +
    • Callbacks taking longer than 100ms are logged. The +loop.slow_callback_duration attribute can be used to set the +minimum execution duration in seconds that is considered “slow”.

    • +
    +
    +
    +

    Concurrency and Multithreading

    +

    An event loop runs in a thread (typically the main thread) and executes +all callbacks and Tasks in its thread. While a Task is running in the +event loop, no other Tasks can run in the same thread. When a Task +executes an await expression, the running Task gets suspended, and +the event loop executes the next Task.

    +

    To schedule a callback from a different OS thread, the +loop.call_soon_threadsafe() method should be used. Example:

    +
    loop.call_soon_threadsafe(callback, *args)
    +
    +
    +

    Almost all asyncio objects are not thread safe, which is typically +not a problem unless there is code that works with them from outside +of a Task or a callback. If there’s a need for such code to call a +low-level asyncio API, the loop.call_soon_threadsafe() method +should be used, e.g.:

    +
    loop.call_soon_threadsafe(fut.cancel)
    +
    +
    +

    To schedule a coroutine object from a different OS thread, the +run_coroutine_threadsafe() function should be used. It returns a +concurrent.futures.Future to access the result:

    +
    async def coro_func():
    +     return await asyncio.sleep(1, 42)
    +
    +# Later in another OS thread:
    +
    +future = asyncio.run_coroutine_threadsafe(coro_func(), loop)
    +# Wait for the result:
    +result = future.result()
    +
    +
    +

    To handle signals and to execute subprocesses, the event loop must be +run in the main thread.

    +

    The loop.run_in_executor() method can be used with a +concurrent.futures.ThreadPoolExecutor to execute +blocking code in a different OS thread without blocking the OS thread +that the event loop runs in.

    +
    +
    +

    Running Blocking Code

    +

    Blocking (CPU-bound) code should not be called directly. For example, +if a function performs a CPU-intensive calculation for 1 second, +all concurrent asyncio Tasks and IO operations would be delayed +by 1 second.

    +

    An executor can be used to run a task in a different thread or even in +a different process to avoid blocking block the OS thread with the +event loop. See the loop.run_in_executor() method for more +details.

    +
    +
    +

    Logging

    +

    asyncio uses the logging module and all logging is performed +via the "asyncio" logger.

    +

    The default log level is logging.INFO, which can be easily +adjusted:

    +
    logging.getLogger("asyncio").setLevel(logging.WARNING)
    +
    +
    +
    +
    +

    Detect never-awaited coroutines

    +

    When a coroutine function is called, but not awaited +(e.g. coro() instead of await coro()) +or the coroutine is not scheduled with asyncio.create_task(), asyncio +will emit a RuntimeWarning:

    +
    import asyncio
    +
    +async def test():
    +    print("never scheduled")
    +
    +async def main():
    +    test()
    +
    +asyncio.run(main())
    +
    +
    +

    Output:

    +
    test.py:7: RuntimeWarning: coroutine 'test' was never awaited
    +  test()
    +
    +
    +

    Output in debug mode:

    +
    test.py:7: RuntimeWarning: coroutine 'test' was never awaited
    +Coroutine created at (most recent call last)
    +  File "../t.py", line 9, in <module>
    +    asyncio.run(main(), debug=True)
    +
    +  < .. >
    +
    +  File "../t.py", line 7, in main
    +    test()
    +  test()
    +
    +
    +

    The usual fix is to either await the coroutine or call the +asyncio.create_task() function:

    +
    async def main():
    +    await test()
    +
    +
    +
    +
    +

    Detect never-retrieved exceptions

    +

    If a Future.set_exception() is called but the Future object is +never awaited on, the exception would never be propagated to the +user code. In this case, asyncio would emit a log message when the +Future object is garbage collected.

    +

    Example of an unhandled exception:

    +
    import asyncio
    +
    +async def bug():
    +    raise Exception("not consumed")
    +
    +async def main():
    +    asyncio.create_task(bug())
    +
    +asyncio.run(main())
    +
    +
    +

    Output:

    +
    Task exception was never retrieved
    +future: <Task finished coro=<bug() done, defined at test.py:3>
    +  exception=Exception('not consumed')>
    +
    +Traceback (most recent call last):
    +  File "test.py", line 4, in bug
    +    raise Exception("not consumed")
    +Exception: not consumed
    +
    +
    +

    Enable the debug mode to get the +traceback where the task was created:

    +
    asyncio.run(main(), debug=True)
    +
    +
    +

    Output in debug mode:

    +
    Task exception was never retrieved
    +future: <Task finished coro=<bug() done, defined at test.py:3>
    +    exception=Exception('not consumed') created at asyncio/tasks.py:321>
    +
    +source_traceback: Object created at (most recent call last):
    +  File "../t.py", line 9, in <module>
    +    asyncio.run(main(), debug=True)
    +
    +< .. >
    +
    +Traceback (most recent call last):
    +  File "../t.py", line 4, in bug
    +    raise Exception("not consumed")
    +Exception: not consumed
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/asyncio-eventloop.html b/python-3.7.4-docs-html/library/asyncio-eventloop.html new file mode 100644 index 0000000..39c4510 --- /dev/null +++ b/python-3.7.4-docs-html/library/asyncio-eventloop.html @@ -0,0 +1,1754 @@ + + + + + + + Event Loop — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Event Loop

    +

    Preface

    +

    The event loop is the core of every asyncio application. +Event loops run asynchronous tasks and callbacks, perform network +IO operations, and run subprocesses.

    +

    Application developers should typically use the high-level asyncio functions, +such as asyncio.run(), and should rarely need to reference the loop +object or call its methods. This section is intended mostly for authors +of lower-level code, libraries, and frameworks, who need finer control over +the event loop behavior.

    +

    Obtaining the Event Loop

    +

    The following low-level functions can be used to get, set, or create +an event loop:

    +
    +
    +asyncio.get_running_loop()
    +

    Return the running event loop in the current OS thread.

    +

    If there is no running event loop a RuntimeError is raised. +This function can only be called from a coroutine or a callback.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +asyncio.get_event_loop()
    +

    Get the current event loop. If there is no current event loop set +in the current OS thread and set_event_loop() has not yet +been called, asyncio will create a new event loop and set it as the +current one.

    +

    Because this function has rather complex behavior (especially +when custom event loop policies are in use), using the +get_running_loop() function is preferred to get_event_loop() +in coroutines and callbacks.

    +

    Consider also using the asyncio.run() function instead of using +lower level functions to manually create and close an event loop.

    +
    + +
    +
    +asyncio.set_event_loop(loop)
    +

    Set loop as a current event loop for the current OS thread.

    +
    + +
    +
    +asyncio.new_event_loop()
    +

    Create a new event loop object.

    +
    + +

    Note that the behaviour of get_event_loop(), set_event_loop(), +and new_event_loop() functions can be altered by +setting a custom event loop policy.

    +

    Contents

    +

    This documentation page contains the following sections:

    + +
    +

    Event Loop Methods

    +

    Event loops have low-level APIs for the following:

    + +
    +

    Running and stopping the loop

    +
    +
    +loop.run_until_complete(future)
    +

    Run until the future (an instance of Future) has +completed.

    +

    If the argument is a coroutine object it +is implicitly scheduled to run as a asyncio.Task.

    +

    Return the Future’s result or raise its exception.

    +
    + +
    +
    +loop.run_forever()
    +

    Run the event loop until stop() is called.

    +

    If stop() is called before run_forever() is called, +the loop will poll the I/O selector once with a timeout of zero, +run all callbacks scheduled in response to I/O events (and +those that were already scheduled), and then exit.

    +

    If stop() is called while run_forever() is running, +the loop will run the current batch of callbacks and then exit. +Note that new callbacks scheduled by callbacks will not run in this +case; instead, they will run the next time run_forever() or +run_until_complete() is called.

    +
    + +
    +
    +loop.stop()
    +

    Stop the event loop.

    +
    + +
    +
    +loop.is_running()
    +

    Return True if the event loop is currently running.

    +
    + +
    +
    +loop.is_closed()
    +

    Return True if the event loop was closed.

    +
    + +
    +
    +loop.close()
    +

    Close the event loop.

    +

    The loop must not be running when this function is called. +Any pending callbacks will be discarded.

    +

    This method clears all queues and shuts down the executor, but does +not wait for the executor to finish.

    +

    This method is idempotent and irreversible. No other methods +should be called after the event loop is closed.

    +
    + +
    +
    +coroutine loop.shutdown_asyncgens()
    +

    Schedule all currently open asynchronous generator objects to +close with an aclose() call. After calling this method, +the event loop will issue a warning if a new asynchronous generator +is iterated. This should be used to reliably finalize all scheduled +asynchronous generators.

    +

    Note that there is no need to call this function when +asyncio.run() is used.

    +

    Example:

    +
    try:
    +    loop.run_forever()
    +finally:
    +    loop.run_until_complete(loop.shutdown_asyncgens())
    +    loop.close()
    +
    +
    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +

    Scheduling callbacks

    +
    +
    +loop.call_soon(callback, *args, context=None)
    +

    Schedule a callback to be called with args arguments at +the next iteration of the event loop.

    +

    Callbacks are called in the order in which they are registered. +Each callback will be called exactly once.

    +

    An optional keyword-only context argument allows specifying a +custom contextvars.Context for the callback to run in. +The current context is used when no context is provided.

    +

    An instance of asyncio.Handle is returned, which can be +used later to cancel the callback.

    +

    This method is not thread-safe.

    +
    + +
    +
    +loop.call_soon_threadsafe(callback, *args, context=None)
    +

    A thread-safe variant of call_soon(). Must be used to +schedule callbacks from another thread.

    +

    See the concurrency and multithreading +section of the documentation.

    +
    + +
    +

    Changed in version 3.7: The context keyword-only parameter was added. See PEP 567 +for more details.

    +
    +
    +

    Note

    +

    Most asyncio scheduling functions don’t allow passing +keyword arguments. To do that, use functools.partial():

    +
    # will schedule "print("Hello", flush=True)"
    +loop.call_soon(
    +    functools.partial(print, "Hello", flush=True))
    +
    +
    +

    Using partial objects is usually more convenient than using lambdas, +as asyncio can render partial objects better in debug and error +messages.

    +
    +
    +
    +

    Scheduling delayed callbacks

    +

    Event loop provides mechanisms to schedule callback functions +to be called at some point in the future. Event loop uses monotonic +clocks to track time.

    +
    +
    +loop.call_later(delay, callback, *args, context=None)
    +

    Schedule callback to be called after the given delay +number of seconds (can be either an int or a float).

    +

    An instance of asyncio.TimerHandle is returned which can +be used to cancel the callback.

    +

    callback will be called exactly once. If two callbacks are +scheduled for exactly the same time, the order in which they +are called is undefined.

    +

    The optional positional args will be passed to the callback when +it is called. If you want the callback to be called with keyword +arguments use functools.partial().

    +

    An optional keyword-only context argument allows specifying a +custom contextvars.Context for the callback to run in. +The current context is used when no context is provided.

    +
    +

    Changed in version 3.7: The context keyword-only parameter was added. See PEP 567 +for more details.

    +
    +
    +

    Changed in version 3.7.1: In Python 3.7.0 and earlier with the default event loop implementation, +the delay could not exceed one day. +This has been fixed in Python 3.7.1.

    +
    +
    + +
    +
    +loop.call_at(when, callback, *args, context=None)
    +

    Schedule callback to be called at the given absolute timestamp +when (an int or a float), using the same time reference as +loop.time().

    +

    This method’s behavior is the same as call_later().

    +

    An instance of asyncio.TimerHandle is returned which can +be used to cancel the callback.

    +
    +

    Changed in version 3.7: The context keyword-only parameter was added. See PEP 567 +for more details.

    +
    +
    +

    Changed in version 3.7.1: In Python 3.7.0 and earlier with the default event loop implementation, +the difference between when and the current time could not exceed +one day. This has been fixed in Python 3.7.1.

    +
    +
    + +
    +
    +loop.time()
    +

    Return the current time, as a float value, according to +the event loop’s internal monotonic clock.

    +
    + +
    +

    Note

    +
    +

    Changed in version 3.8: In Python 3.7 and earlier timeouts (relative delay or absolute when) +should not exceed one day. This has been fixed in Python 3.8.

    +
    +
    +
    +

    See also

    +

    The asyncio.sleep() function.

    +
    +
    +
    +

    Creating Futures and Tasks

    +
    +
    +loop.create_future()
    +

    Create an asyncio.Future object attached to the event loop.

    +

    This is the preferred way to create Futures in asyncio. This lets +third-party event loops provide alternative implementations of +the Future object (with better performance or instrumentation).

    +
    +

    New in version 3.5.2.

    +
    +
    + +
    +
    +loop.create_task(coro)
    +

    Schedule the execution of a Coroutines. +Return a Task object.

    +

    Third-party event loops can use their own subclass of Task +for interoperability. In this case, the result type is a subclass +of Task.

    +
    + +
    +
    +loop.set_task_factory(factory)
    +

    Set a task factory that will be used by +loop.create_task().

    +

    If factory is None the default task factory will be set. +Otherwise, factory must be a callable with the signature matching +(loop, coro), where loop is a reference to the active +event loop, and coro is a coroutine object. The callable +must return a asyncio.Future-compatible object.

    +
    + +
    +
    +loop.get_task_factory()
    +

    Return a task factory or None if the default one is in use.

    +
    + +
    +
    +

    Opening network connections

    +
    +
    +coroutine loop.create_connection(protocol_factory, host=None, port=None, *, ssl=None, family=0, proto=0, flags=0, sock=None, local_addr=None, server_hostname=None, ssl_handshake_timeout=None)
    +

    Open a streaming transport connection to a given +address specified by host and port.

    +

    The socket family can be either AF_INET or +AF_INET6 depending on host (or the family +argument, if provided).

    +

    The socket type will be SOCK_STREAM.

    +

    protocol_factory must be a callable returning an +asyncio protocol implementation.

    +

    This method will try to establish the connection in the background. +When successful, it returns a (transport, protocol) pair.

    +

    The chronological synopsis of the underlying operation is as follows:

    +
      +
    1. The connection is established and a transport +is created for it.

    2. +
    3. protocol_factory is called without arguments and is expected to +return a protocol instance.

    4. +
    5. The protocol instance is coupled with the transport by calling its +connection_made() method.

    6. +
    7. A (transport, protocol) tuple is returned on success.

    8. +
    +

    The created transport is an implementation-dependent bidirectional +stream.

    +

    Other arguments:

    +
      +
    • ssl: if given and not false, a SSL/TLS transport is created +(by default a plain TCP transport is created). If ssl is +a ssl.SSLContext object, this context is used to create +the transport; if ssl is True, a default context returned +from ssl.create_default_context() is used.

      + +
    • +
    • server_hostname sets or overrides the hostname that the target +server’s certificate will be matched against. Should only be passed +if ssl is not None. By default the value of the host argument +is used. If host is empty, there is no default and you must pass a +value for server_hostname. If server_hostname is an empty +string, hostname matching is disabled (which is a serious security +risk, allowing for potential man-in-the-middle attacks).

    • +
    • family, proto, flags are the optional address family, protocol +and flags to be passed through to getaddrinfo() for host resolution. +If given, these should all be integers from the corresponding +socket module constants.

    • +
    • sock, if given, should be an existing, already connected +socket.socket object to be used by the transport. +If sock is given, none of host, port, family, proto, flags +and local_addr should be specified.

    • +
    • local_addr, if given, is a (local_host, local_port) tuple used +to bind the socket to locally. The local_host and local_port +are looked up using getaddrinfo(), similarly to host and port.

    • +
    • ssl_handshake_timeout is (for a TLS connection) the time in seconds +to wait for the TLS handshake to complete before aborting the connection. +60.0 seconds if None (default).

    • +
    +
    +

    New in version 3.7: The ssl_handshake_timeout parameter.

    +
    +
    +

    Changed in version 3.6: The socket option TCP_NODELAY is set by default +for all TCP connections.

    +
    +
    +

    Changed in version 3.5: Added support for SSL/TLS in ProactorEventLoop.

    +
    +
    +

    See also

    +

    The open_connection() function is a high-level alternative +API. It returns a pair of (StreamReader, StreamWriter) +that can be used directly in async/await code.

    +
    +
    + +
    +
    +coroutine loop.create_datagram_endpoint(protocol_factory, local_addr=None, remote_addr=None, *, family=0, proto=0, flags=0, reuse_address=None, reuse_port=None, allow_broadcast=None, sock=None)
    +

    Create a datagram connection.

    +

    The socket family can be either AF_INET, +AF_INET6, or AF_UNIX, +depending on host (or the family argument, if provided).

    +

    The socket type will be SOCK_DGRAM.

    +

    protocol_factory must be a callable returning a +protocol implementation.

    +

    A tuple of (transport, protocol) is returned on success.

    +

    Other arguments:

    +
      +
    • local_addr, if given, is a (local_host, local_port) tuple used +to bind the socket to locally. The local_host and local_port +are looked up using getaddrinfo().

    • +
    • remote_addr, if given, is a (remote_host, remote_port) tuple used +to connect the socket to a remote address. The remote_host and +remote_port are looked up using getaddrinfo().

    • +
    • family, proto, flags are the optional address family, protocol +and flags to be passed through to getaddrinfo() for host +resolution. If given, these should all be integers from the +corresponding socket module constants.

    • +
    • reuse_address tells the kernel to reuse a local socket in +TIME_WAIT state, without waiting for its natural timeout to +expire. If not specified will automatically be set to True on +Unix.

    • +
    • reuse_port tells the kernel to allow this endpoint to be bound to the +same port as other existing endpoints are bound to, so long as they all +set this flag when being created. This option is not supported on Windows +and some Unixes. If the SO_REUSEPORT constant is not +defined then this capability is unsupported.

    • +
    • allow_broadcast tells the kernel to allow this endpoint to send +messages to the broadcast address.

    • +
    • sock can optionally be specified in order to use a preexisting, +already connected, socket.socket object to be used by the +transport. If specified, local_addr and remote_addr should be omitted +(must be None).

    • +
    +

    On Windows, with ProactorEventLoop, this method is not supported.

    +

    See UDP echo client protocol and +UDP echo server protocol examples.

    +
    +

    Changed in version 3.4.4: The family, proto, flags, reuse_address, reuse_port, +*allow_broadcast, and sock parameters were added.

    +
    +
    + +
    +
    +coroutine loop.create_unix_connection(protocol_factory, path=None, *, ssl=None, sock=None, server_hostname=None, ssl_handshake_timeout=None)
    +

    Create a Unix connection.

    +

    The socket family will be AF_UNIX; socket +type will be SOCK_STREAM.

    +

    A tuple of (transport, protocol) is returned on success.

    +

    path is the name of a Unix domain socket and is required, +unless a sock parameter is specified. Abstract Unix sockets, +str, bytes, and Path paths are +supported.

    +

    See the documentation of the loop.create_connection() method +for information about arguments to this method.

    +

    Availability: Unix.

    +
    +

    New in version 3.7: The ssl_handshake_timeout parameter.

    +
    +
    +

    Changed in version 3.7: The path parameter can now be a path-like object.

    +
    +
    + +
    +
    +

    Creating network servers

    +
    +
    +coroutine loop.create_server(protocol_factory, host=None, port=None, *, family=socket.AF_UNSPEC, flags=socket.AI_PASSIVE, sock=None, backlog=100, ssl=None, reuse_address=None, reuse_port=None, ssl_handshake_timeout=None, start_serving=True)
    +

    Create a TCP server (socket type SOCK_STREAM) listening +on port of the host address.

    +

    Returns a Server object.

    +

    Arguments:

    +
      +
    • protocol_factory must be a callable returning a +protocol implementation.

    • +
    • The host parameter can be set to several types which determine where +the server would be listening:

      +
        +
      • If host is a string, the TCP server is bound to a single network +interface specified by host.

      • +
      • If host is a sequence of strings, the TCP server is bound to all +network interfaces specified by the sequence.

      • +
      • If host is an empty string or None, all interfaces are +assumed and a list of multiple sockets will be returned (most likely +one for IPv4 and another one for IPv6).

      • +
      +
    • +
    • family can be set to either socket.AF_INET or +AF_INET6 to force the socket to use IPv4 or IPv6. +If not set, the family will be determined from host name +(defaults to AF_UNSPEC).

    • +
    • flags is a bitmask for getaddrinfo().

    • +
    • sock can optionally be specified in order to use a preexisting +socket object. If specified, host and port must not be specified.

    • +
    • backlog is the maximum number of queued connections passed to +listen() (defaults to 100).

    • +
    • ssl can be set to an SSLContext instance to enable +TLS over the accepted connections.

    • +
    • reuse_address tells the kernel to reuse a local socket in +TIME_WAIT state, without waiting for its natural timeout to +expire. If not specified will automatically be set to True on +Unix.

    • +
    • reuse_port tells the kernel to allow this endpoint to be bound to the +same port as other existing endpoints are bound to, so long as they all +set this flag when being created. This option is not supported on +Windows.

    • +
    • ssl_handshake_timeout is (for a TLS server) the time in seconds to wait +for the TLS handshake to complete before aborting the connection. +60.0 seconds if None (default).

    • +
    • start_serving set to True (the default) causes the created server +to start accepting connections immediately. When set to False, +the user should await on Server.start_serving() or +Server.serve_forever() to make the server to start accepting +connections.

    • +
    +
    +

    New in version 3.7: Added ssl_handshake_timeout and start_serving parameters.

    +
    +
    +

    Changed in version 3.6: The socket option TCP_NODELAY is set by default +for all TCP connections.

    +
    +
    +

    Changed in version 3.5: Added support for SSL/TLS in ProactorEventLoop.

    +
    +
    +

    Changed in version 3.5.1: The host parameter can be a sequence of strings.

    +
    +
    +

    See also

    +

    The start_server() function is a higher-level alternative API +that returns a pair of StreamReader and StreamWriter +that can be used in an async/await code.

    +
    +
    + +
    +
    +coroutine loop.create_unix_server(protocol_factory, path=None, *, sock=None, backlog=100, ssl=None, ssl_handshake_timeout=None, start_serving=True)
    +

    Similar to loop.create_server() but works with the +AF_UNIX socket family.

    +

    path is the name of a Unix domain socket, and is required, +unless a sock argument is provided. Abstract Unix sockets, +str, bytes, and Path paths +are supported.

    +

    See the documentation of the loop.create_server() method +for information about arguments to this method.

    +

    Availability: Unix.

    +
    +

    New in version 3.7: The ssl_handshake_timeout and start_serving parameters.

    +
    +
    +

    Changed in version 3.7: The path parameter can now be a Path object.

    +
    +
    + +
    +
    +coroutine loop.connect_accepted_socket(protocol_factory, sock, *, ssl=None, ssl_handshake_timeout=None)
    +

    Wrap an already accepted connection into a transport/protocol pair.

    +

    This method can be used by servers that accept connections outside +of asyncio but that use asyncio to handle them.

    +

    Parameters:

    +
      +
    • protocol_factory must be a callable returning a +protocol implementation.

    • +
    • sock is a preexisting socket object returned from +socket.accept.

    • +
    • ssl can be set to an SSLContext to enable SSL over +the accepted connections.

    • +
    • ssl_handshake_timeout is (for an SSL connection) the time in seconds to +wait for the SSL handshake to complete before aborting the connection. +60.0 seconds if None (default).

    • +
    +

    Returns a (transport, protocol) pair.

    +
    +

    New in version 3.7: The ssl_handshake_timeout parameter.

    +
    +
    +

    New in version 3.5.3.

    +
    +
    + +
    +
    +

    Transferring files

    +
    +
    +coroutine loop.sendfile(transport, file, offset=0, count=None, *, fallback=True)
    +

    Send a file over a transport. Return the total number of bytes +sent.

    +

    The method uses high-performance os.sendfile() if available.

    +

    file must be a regular file object opened in binary mode.

    +

    offset tells from where to start reading the file. If specified, +count is the total number of bytes to transmit as opposed to +sending the file until EOF is reached. File position is always updated, +even when this method raises an error, and +file.tell() can be used to obtain the actual +number of bytes sent.

    +

    fallback set to True makes asyncio to manually read and send +the file when the platform does not support the sendfile system call +(e.g. Windows or SSL socket on Unix).

    +

    Raise SendfileNotAvailableError if the system does not support +the sendfile syscall and fallback is False.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +

    TLS Upgrade

    +
    +
    +coroutine loop.start_tls(transport, protocol, sslcontext, *, server_side=False, server_hostname=None, ssl_handshake_timeout=None)
    +

    Upgrade an existing transport-based connection to TLS.

    +

    Return a new transport instance, that the protocol must start using +immediately after the await. The transport instance passed to +the start_tls method should never be used again.

    +

    Parameters:

    +
      +
    • transport and protocol instances that methods like +create_server() and +create_connection() return.

    • +
    • sslcontext: a configured instance of SSLContext.

    • +
    • server_side pass True when a server-side connection is being +upgraded (like the one created by create_server()).

    • +
    • server_hostname: sets or overrides the host name that the target +server’s certificate will be matched against.

    • +
    • ssl_handshake_timeout is (for a TLS connection) the time in seconds to +wait for the TLS handshake to complete before aborting the connection. +60.0 seconds if None (default).

    • +
    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +

    Watching file descriptors

    +
    +
    +loop.add_reader(fd, callback, *args)
    +

    Start monitoring the fd file descriptor for read availability and +invoke callback with the specified arguments once fd is available for +reading.

    +
    + +
    +
    +loop.remove_reader(fd)
    +

    Stop monitoring the fd file descriptor for read availability.

    +
    + +
    +
    +loop.add_writer(fd, callback, *args)
    +

    Start monitoring the fd file descriptor for write availability and +invoke callback with the specified arguments once fd is available for +writing.

    +

    Use functools.partial() to pass keyword arguments to callback.

    +
    + +
    +
    +loop.remove_writer(fd)
    +

    Stop monitoring the fd file descriptor for write availability.

    +
    + +

    See also Platform Support section +for some limitations of these methods.

    +
    +
    +

    Working with socket objects directly

    +

    In general, protocol implementations that use transport-based APIs +such as loop.create_connection() and loop.create_server() +are faster than implementations that work with sockets directly. +However, there are some use cases when performance is not critical, and +working with socket objects directly is more +convenient.

    +
    +
    +coroutine loop.sock_recv(sock, nbytes)
    +

    Receive up to nbytes from sock. Asynchronous version of +socket.recv().

    +

    Return the received data as a bytes object.

    +

    sock must be a non-blocking socket.

    +
    +

    Changed in version 3.7: Even though this method was always documented as a coroutine +method, releases before Python 3.7 returned a Future. +Since Python 3.7 this is an async def method.

    +
    +
    + +
    +
    +coroutine loop.sock_recv_into(sock, buf)
    +

    Receive data from sock into the buf buffer. Modeled after the blocking +socket.recv_into() method.

    +

    Return the number of bytes written to the buffer.

    +

    sock must be a non-blocking socket.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +coroutine loop.sock_sendall(sock, data)
    +

    Send data to the sock socket. Asynchronous version of +socket.sendall().

    +

    This method continues to send to the socket until either all data +in data has been sent or an error occurs. None is returned +on success. On error, an exception is raised. Additionally, there is no way +to determine how much data, if any, was successfully processed by the +receiving end of the connection.

    +

    sock must be a non-blocking socket.

    +
    +

    Changed in version 3.7: Even though the method was always documented as a coroutine +method, before Python 3.7 it returned an Future. +Since Python 3.7, this is an async def method.

    +
    +
    + +
    +
    +coroutine loop.sock_connect(sock, address)
    +

    Connect sock to a remote socket at address.

    +

    Asynchronous version of socket.connect().

    +

    sock must be a non-blocking socket.

    +
    +

    Changed in version 3.5.2: address no longer needs to be resolved. sock_connect +will try to check if the address is already resolved by calling +socket.inet_pton(). If not, +loop.getaddrinfo() will be used to resolve the +address.

    +
    + +
    + +
    +
    +coroutine loop.sock_accept(sock)
    +

    Accept a connection. Modeled after the blocking +socket.accept() method.

    +

    The socket must be bound to an address and listening +for connections. The return value is a pair (conn, address) where conn +is a new socket object usable to send and receive data on the connection, +and address is the address bound to the socket on the other end of the +connection.

    +

    sock must be a non-blocking socket.

    +
    +

    Changed in version 3.7: Even though the method was always documented as a coroutine +method, before Python 3.7 it returned a Future. +Since Python 3.7, this is an async def method.

    +
    + +
    + +
    +
    +coroutine loop.sock_sendfile(sock, file, offset=0, count=None, *, fallback=True)
    +

    Send a file using high-performance os.sendfile if possible. +Return the total number of bytes sent.

    +

    Asynchronous version of socket.sendfile().

    +

    sock must be a non-blocking socket.SOCK_STREAM +socket.

    +

    file must be a regular file object open in binary mode.

    +

    offset tells from where to start reading the file. If specified, +count is the total number of bytes to transmit as opposed to +sending the file until EOF is reached. File position is always updated, +even when this method raises an error, and +file.tell() can be used to obtain the actual +number of bytes sent.

    +

    fallback, when set to True, makes asyncio manually read and send +the file when the platform does not support the sendfile syscall +(e.g. Windows or SSL socket on Unix).

    +

    Raise SendfileNotAvailableError if the system does not support +sendfile syscall and fallback is False.

    +

    sock must be a non-blocking socket.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +

    DNS

    +
    +
    +coroutine loop.getaddrinfo(host, port, *, family=0, type=0, proto=0, flags=0)
    +

    Asynchronous version of socket.getaddrinfo().

    +
    + +
    +
    +coroutine loop.getnameinfo(sockaddr, flags=0)
    +

    Asynchronous version of socket.getnameinfo().

    +
    + +
    +

    Changed in version 3.7: Both getaddrinfo and getnameinfo methods were always documented +to return a coroutine, but prior to Python 3.7 they were, in fact, +returning asyncio.Future objects. Starting with Python 3.7 +both methods are coroutines.

    +
    +
    +
    +

    Working with pipes

    +
    +
    +coroutine loop.connect_read_pipe(protocol_factory, pipe)
    +

    Register the read end of pipe in the event loop.

    +

    protocol_factory must be a callable returning an +asyncio protocol implementation.

    +

    pipe is a file-like object.

    +

    Return pair (transport, protocol), where transport supports +the ReadTransport interface and protocol is an object +instantiated by the protocol_factory.

    +

    With SelectorEventLoop event loop, the pipe is set to +non-blocking mode.

    +
    + +
    +
    +coroutine loop.connect_write_pipe(protocol_factory, pipe)
    +

    Register the write end of pipe in the event loop.

    +

    protocol_factory must be a callable returning an +asyncio protocol implementation.

    +

    pipe is file-like object.

    +

    Return pair (transport, protocol), where transport supports +WriteTransport interface and protocol is an object +instantiated by the protocol_factory.

    +

    With SelectorEventLoop event loop, the pipe is set to +non-blocking mode.

    +
    + +
    +

    Note

    +

    SelectorEventLoop does not support the above methods on +Windows. Use ProactorEventLoop instead for Windows.

    +
    +
    +

    See also

    +

    The loop.subprocess_exec() and +loop.subprocess_shell() methods.

    +
    +
    +
    +

    Unix signals

    +
    +
    +loop.add_signal_handler(signum, callback, *args)
    +

    Set callback as the handler for the signum signal.

    +

    The callback will be invoked by loop, along with other queued callbacks +and runnable coroutines of that event loop. Unlike signal handlers +registered using signal.signal(), a callback registered with this +function is allowed to interact with the event loop.

    +

    Raise ValueError if the signal number is invalid or uncatchable. +Raise RuntimeError if there is a problem setting up the handler.

    +

    Use functools.partial() to pass keyword arguments to callback.

    +

    Like signal.signal(), this function must be invoked in the main +thread.

    +
    + +
    +
    +loop.remove_signal_handler(sig)
    +

    Remove the handler for the sig signal.

    +

    Return True if the signal handler was removed, or False if +no handler was set for the given signal.

    +

    Availability: Unix.

    +
    + +
    +

    See also

    +

    The signal module.

    +
    +
    +
    +

    Executing code in thread or process pools

    +
    +
    +awaitable loop.run_in_executor(executor, func, *args)
    +

    Arrange for func to be called in the specified executor.

    +

    The executor argument should be an concurrent.futures.Executor +instance. The default executor is used if executor is None.

    +

    Example:

    +
    import asyncio
    +import concurrent.futures
    +
    +def blocking_io():
    +    # File operations (such as logging) can block the
    +    # event loop: run them in a thread pool.
    +    with open('/dev/urandom', 'rb') as f:
    +        return f.read(100)
    +
    +def cpu_bound():
    +    # CPU-bound operations will block the event loop:
    +    # in general it is preferable to run them in a
    +    # process pool.
    +    return sum(i * i for i in range(10 ** 7))
    +
    +async def main():
    +    loop = asyncio.get_running_loop()
    +
    +    ## Options:
    +
    +    # 1. Run in the default loop's executor:
    +    result = await loop.run_in_executor(
    +        None, blocking_io)
    +    print('default thread pool', result)
    +
    +    # 2. Run in a custom thread pool:
    +    with concurrent.futures.ThreadPoolExecutor() as pool:
    +        result = await loop.run_in_executor(
    +            pool, blocking_io)
    +        print('custom thread pool', result)
    +
    +    # 3. Run in a custom process pool:
    +    with concurrent.futures.ProcessPoolExecutor() as pool:
    +        result = await loop.run_in_executor(
    +            pool, cpu_bound)
    +        print('custom process pool', result)
    +
    +asyncio.run(main())
    +
    +
    +

    This method returns a asyncio.Future object.

    +

    Use functools.partial() to pass keyword arguments to func.

    +
    +

    Changed in version 3.5.3: loop.run_in_executor() no longer configures the +max_workers of the thread pool executor it creates, instead +leaving it up to the thread pool executor +(ThreadPoolExecutor) to set the +default.

    +
    +
    + +
    +
    +loop.set_default_executor(executor)
    +

    Set executor as the default executor used by run_in_executor(). +executor should be an instance of +ThreadPoolExecutor.

    +
    +

    Deprecated since version 3.7: Using an executor that is not an instance of +ThreadPoolExecutor is deprecated and +will trigger an error in Python 3.9.

    +
    +

    executor must be an instance of +concurrent.futures.ThreadPoolExecutor.

    +
    + +
    +
    +

    Error Handling API

    +

    Allows customizing how exceptions are handled in the event loop.

    +
    +
    +loop.set_exception_handler(handler)
    +

    Set handler as the new event loop exception handler.

    +

    If handler is None, the default exception handler will +be set. Otherwise, handler must be a callable with the signature +matching (loop, context), where loop +is a reference to the active event loop, and context +is a dict object containing the details of the exception +(see call_exception_handler() documentation for details +about context).

    +
    + +
    +
    +loop.get_exception_handler()
    +

    Return the current exception handler, or None if no custom +exception handler was set.

    +
    +

    New in version 3.5.2.

    +
    +
    + +
    +
    +loop.default_exception_handler(context)
    +

    Default exception handler.

    +

    This is called when an exception occurs and no exception +handler is set. This can be called by a custom exception +handler that wants to defer to the default handler behavior.

    +

    context parameter has the same meaning as in +call_exception_handler().

    +
    + +
    +
    +loop.call_exception_handler(context)
    +

    Call the current event loop exception handler.

    +

    context is a dict object containing the following keys +(new keys may be introduced in future Python versions):

    +
      +
    • ‘message’: Error message;

    • +
    • ‘exception’ (optional): Exception object;

    • +
    • ‘future’ (optional): asyncio.Future instance;

    • +
    • ‘handle’ (optional): asyncio.Handle instance;

    • +
    • ‘protocol’ (optional): Protocol instance;

    • +
    • ‘transport’ (optional): Transport instance;

    • +
    • ‘socket’ (optional): socket.socket instance.

    • +
    +
    +

    Note

    +

    This method should not be overloaded in subclassed +event loops. For custom exception handling, use +the set_exception_handler() method.

    +
    +
    + +
    +
    +

    Enabling debug mode

    +
    +
    +loop.get_debug()
    +

    Get the debug mode (bool) of the event loop.

    +

    The default value is True if the environment variable +PYTHONASYNCIODEBUG is set to a non-empty string, False +otherwise.

    +
    + +
    +
    +loop.set_debug(enabled: bool)
    +

    Set the debug mode of the event loop.

    +
    +

    Changed in version 3.7: The new -X dev command line option can now also be used +to enable the debug mode.

    +
    +
    + +
    +

    See also

    +

    The debug mode of asyncio.

    +
    +
    +
    +

    Running Subprocesses

    +

    Methods described in this subsections are low-level. In regular +async/await code consider using the high-level +asyncio.create_subprocess_shell() and +asyncio.create_subprocess_exec() convenience functions instead.

    +
    +

    Note

    +

    The default asyncio event loop on Windows does not support +subprocesses. See Subprocess Support on Windows for details.

    +
    +
    +
    +coroutine loop.subprocess_exec(protocol_factory, *args, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, **kwargs)
    +

    Create a subprocess from one or more string arguments specified by +args.

    +

    args must be a list of strings represented by:

    + +

    The first string specifies the program executable, +and the remaining strings specify the arguments. Together, string +arguments form the argv of the program.

    +

    This is similar to the standard library subprocess.Popen +class called with shell=False and the list of strings passed as +the first argument; however, where Popen takes +a single argument which is list of strings, subprocess_exec +takes multiple string arguments.

    +

    The protocol_factory must be a callable returning a subclass of the +asyncio.SubprocessProtocol class.

    +

    Other parameters:

    +
      +
    • stdin: either a file-like object representing a pipe to be +connected to the subprocess’s standard input stream using +connect_write_pipe(), or the +subprocess.PIPE constant (default). By default a new +pipe will be created and connected.

    • +
    • stdout: either a file-like object representing the pipe to be +connected to the subprocess’s standard output stream using +connect_read_pipe(), or the +subprocess.PIPE constant (default). By default a new pipe +will be created and connected.

    • +
    • stderr: either a file-like object representing the pipe to be +connected to the subprocess’s standard error stream using +connect_read_pipe(), or one of +subprocess.PIPE (default) or subprocess.STDOUT +constants.

      +

      By default a new pipe will be created and connected. When +subprocess.STDOUT is specified, the subprocess’ standard +error stream will be connected to the same pipe as the standard +output stream.

      +
    • +
    • All other keyword arguments are passed to subprocess.Popen +without interpretation, except for bufsize, universal_newlines +and shell, which should not be specified at all.

    • +
    +

    See the constructor of the subprocess.Popen class +for documentation on other arguments.

    +

    Returns a pair of (transport, protocol), where transport +conforms to the asyncio.SubprocessTransport base class and +protocol is an object instantiated by the protocol_factory.

    +
    + +
    +
    +coroutine loop.subprocess_shell(protocol_factory, cmd, *, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, **kwargs)
    +

    Create a subprocess from cmd, which can be a str or a +bytes string encoded to the +filesystem encoding, +using the platform’s “shell” syntax.

    +

    This is similar to the standard library subprocess.Popen +class called with shell=True.

    +

    The protocol_factory must be a callable returning a subclass of the +SubprocessProtocol class.

    +

    See subprocess_exec() for more details about +the remaining arguments.

    +

    Returns a pair of (transport, protocol), where transport +conforms to the SubprocessTransport base class and +protocol is an object instantiated by the protocol_factory.

    +
    + +
    +

    Note

    +

    It is the application’s responsibility to ensure that all whitespace +and special characters are quoted appropriately to avoid shell injection +vulnerabilities. The shlex.quote() function can be used to +properly escape whitespace and special characters in strings that +are going to be used to construct shell commands.

    +
    +
    +
    +
    +

    Callback Handles

    +
    +
    +class asyncio.Handle
    +

    A callback wrapper object returned by loop.call_soon(), +loop.call_soon_threadsafe().

    +
    +
    +cancel()
    +

    Cancel the callback. If the callback has already been canceled +or executed, this method has no effect.

    +
    + +
    +
    +cancelled()
    +

    Return True if the callback was cancelled.

    +
    +

    New in version 3.7.

    +
    +
    + +
    + +
    +
    +class asyncio.TimerHandle
    +

    A callback wrapper object returned by loop.call_later(), +and loop.call_at().

    +

    This class is a subclass of Handle.

    +
    +
    +when()
    +

    Return a scheduled callback time as float seconds.

    +

    The time is an absolute timestamp, using the same time +reference as loop.time().

    +
    +

    New in version 3.7.

    +
    +
    + +
    + +
    +
    +

    Server Objects

    +

    Server objects are created by loop.create_server(), +loop.create_unix_server(), start_server(), +and start_unix_server() functions.

    +

    Do not instantiate the class directly.

    +
    +
    +class asyncio.Server
    +

    Server objects are asynchronous context managers. When used in an +async with statement, it’s guaranteed that the Server object is +closed and not accepting new connections when the async with +statement is completed:

    +
    srv = await loop.create_server(...)
    +
    +async with srv:
    +    # some code
    +
    +# At this point, srv is closed and no longer accepts new connections.
    +
    +
    +
    +

    Changed in version 3.7: Server object is an asynchronous context manager since Python 3.7.

    +
    +
    +
    +close()
    +

    Stop serving: close listening sockets and set the sockets +attribute to None.

    +

    The sockets that represent existing incoming client connections +are left open.

    +

    The server is closed asynchronously, use the wait_closed() +coroutine to wait until the server is closed.

    +
    + +
    +
    +get_loop()
    +

    Return the event loop associated with the server object.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +coroutine start_serving()
    +

    Start accepting connections.

    +

    This method is idempotent, so it can be called when +the server is already being serving.

    +

    The start_serving keyword-only parameter to +loop.create_server() and +asyncio.start_server() allows creating a Server object +that is not accepting connections initially. In this case +Server.start_serving(), or Server.serve_forever() can be used +to make the Server start accepting connections.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +coroutine serve_forever()
    +

    Start accepting connections until the coroutine is cancelled. +Cancellation of serve_forever task causes the server +to be closed.

    +

    This method can be called if the server is already accepting +connections. Only one serve_forever task can exist per +one Server object.

    +

    Example:

    +
    async def client_connected(reader, writer):
    +    # Communicate with the client with
    +    # reader/writer streams.  For example:
    +    await reader.readline()
    +
    +async def main(host, port):
    +    srv = await asyncio.start_server(
    +        client_connected, host, port)
    +    await srv.serve_forever()
    +
    +asyncio.run(main('127.0.0.1', 0))
    +
    +
    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +is_serving()
    +

    Return True if the server is accepting new connections.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +coroutine wait_closed()
    +

    Wait until the close() method completes.

    +
    + +
    +
    +sockets
    +

    List of socket.socket objects the server is listening on, +or None if the server is closed.

    +
    +

    Changed in version 3.7: Prior to Python 3.7 Server.sockets used to return an +internal list of server sockets directly. In 3.7 a copy +of that list is returned.

    +
    +
    + +
    + +
    +
    +

    Event Loop Implementations

    +

    asyncio ships with two different event loop implementations: +SelectorEventLoop and ProactorEventLoop.

    +

    By default asyncio is configured to use SelectorEventLoop +on all platforms.

    +
    +
    +class asyncio.SelectorEventLoop
    +

    An event loop based on the selectors module.

    +

    Uses the most efficient selector available for the given +platform. It is also possible to manually configure the +exact selector implementation to be used:

    +
    import asyncio
    +import selectors
    +
    +selector = selectors.SelectSelector()
    +loop = asyncio.SelectorEventLoop(selector)
    +asyncio.set_event_loop(loop)
    +
    +
    +

    Availability: Unix, Windows.

    +
    + +
    +
    +class asyncio.ProactorEventLoop
    +

    An event loop for Windows that uses “I/O Completion Ports” (IOCP).

    +

    Availability: Windows.

    +

    An example how to use ProactorEventLoop on Windows:

    +
    import asyncio
    +import sys
    +
    +if sys.platform == 'win32':
    +    loop = asyncio.ProactorEventLoop()
    +    asyncio.set_event_loop(loop)
    +
    +
    + +
    + +
    +
    +class asyncio.AbstractEventLoop
    +

    Abstract base class for asyncio-compliant event loops.

    +

    The Event Loop Methods section lists all +methods that an alternative implementation of AbstractEventLoop +should have defined.

    +
    + +
    +
    +

    Examples

    +

    Note that all examples in this section purposefully show how +to use the low-level event loop APIs, such as loop.run_forever() +and loop.call_soon(). Modern asyncio applications rarely +need to be written this way; consider using the high-level functions +like asyncio.run().

    +
    +

    Hello World with call_soon()

    +

    An example using the loop.call_soon() method to schedule a +callback. The callback displays "Hello World" and then stops the +event loop:

    +
    import asyncio
    +
    +def hello_world(loop):
    +    """A callback to print 'Hello World' and stop the event loop"""
    +    print('Hello World')
    +    loop.stop()
    +
    +loop = asyncio.get_event_loop()
    +
    +# Schedule a call to hello_world()
    +loop.call_soon(hello_world, loop)
    +
    +# Blocking call interrupted by loop.stop()
    +try:
    +    loop.run_forever()
    +finally:
    +    loop.close()
    +
    +
    +
    +

    See also

    +

    A similar Hello World +example created with a coroutine and the run() function.

    +
    +
    +
    +

    Display the current date with call_later()

    +

    An example of a callback displaying the current date every second. The +callback uses the loop.call_later() method to reschedule itself +after 5 seconds, and then stops the event loop:

    +
    import asyncio
    +import datetime
    +
    +def display_date(end_time, loop):
    +    print(datetime.datetime.now())
    +    if (loop.time() + 1.0) < end_time:
    +        loop.call_later(1, display_date, end_time, loop)
    +    else:
    +        loop.stop()
    +
    +loop = asyncio.get_event_loop()
    +
    +# Schedule the first call to display_date()
    +end_time = loop.time() + 5.0
    +loop.call_soon(display_date, end_time, loop)
    +
    +# Blocking call interrupted by loop.stop()
    +try:
    +    loop.run_forever()
    +finally:
    +    loop.close()
    +
    +
    +
    +

    See also

    +

    A similar current date example +created with a coroutine and the run() function.

    +
    +
    +
    +

    Watch a file descriptor for read events

    +

    Wait until a file descriptor received some data using the +loop.add_reader() method and then close the event loop:

    +
    import asyncio
    +from socket import socketpair
    +
    +# Create a pair of connected file descriptors
    +rsock, wsock = socketpair()
    +
    +loop = asyncio.get_event_loop()
    +
    +def reader():
    +    data = rsock.recv(100)
    +    print("Received:", data.decode())
    +
    +    # We are done: unregister the file descriptor
    +    loop.remove_reader(rsock)
    +
    +    # Stop the event loop
    +    loop.stop()
    +
    +# Register the file descriptor for read event
    +loop.add_reader(rsock, reader)
    +
    +# Simulate the reception of data from the network
    +loop.call_soon(wsock.send, 'abc'.encode())
    +
    +try:
    +    # Run the event loop
    +    loop.run_forever()
    +finally:
    +    # We are done. Close sockets and the event loop.
    +    rsock.close()
    +    wsock.close()
    +    loop.close()
    +
    +
    +
    +

    See also

    + +
    +
    +
    +

    Set signal handlers for SIGINT and SIGTERM

    +

    (This signals example only works on Unix.)

    +

    Register handlers for signals SIGINT and SIGTERM +using the loop.add_signal_handler() method:

    +
    import asyncio
    +import functools
    +import os
    +import signal
    +
    +def ask_exit(signame, loop):
    +    print("got signal %s: exit" % signame)
    +    loop.stop()
    +
    +async def main():
    +    loop = asyncio.get_running_loop()
    +
    +    for signame in {'SIGINT', 'SIGTERM'}:
    +        loop.add_signal_handler(
    +            getattr(signal, signame),
    +            functools.partial(ask_exit, signame, loop))
    +
    +    await asyncio.sleep(3600)
    +
    +print("Event loop running for 1 hour, press Ctrl+C to interrupt.")
    +print(f"pid {os.getpid()}: send SIGINT or SIGTERM to exit.")
    +
    +asyncio.run(main())
    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/asyncio-exceptions.html b/python-3.7.4-docs-html/library/asyncio-exceptions.html new file mode 100644 index 0000000..636adab --- /dev/null +++ b/python-3.7.4-docs-html/library/asyncio-exceptions.html @@ -0,0 +1,276 @@ + + + + + + + Exceptions — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Exceptions

    +
    +
    +exception asyncio.TimeoutError
    +

    The operation has exceeded the given deadline.

    +
    +

    Important

    +

    This exception is different from the builtin TimeoutError +exception.

    +
    +
    + +
    +
    +exception asyncio.CancelledError
    +

    The operation has been cancelled.

    +

    This exception can be caught to perform custom operations +when asyncio Tasks are cancelled. In almost all situations the +exception must be re-raised.

    +
    +

    Important

    +

    This exception is a subclass of Exception, so it can be +accidentally suppressed by an overly broad try..except block:

    +
    try:
    +    await operation
    +except Exception:
    +    # The cancellation is broken because the *except* block
    +    # suppresses the CancelledError exception.
    +    log.log('an error has occurred')
    +
    +
    +

    Instead, the following pattern should be used:

    +
    try:
    +    await operation
    +except asyncio.CancelledError:
    +    raise
    +except Exception:
    +    log.log('an error has occurred')
    +
    +
    +
    +
    + +
    +
    +exception asyncio.InvalidStateError
    +

    Invalid internal state of Task or Future.

    +

    Can be raised in situations like setting a result value for a +Future object that already has a result value set.

    +
    + +
    +
    +exception asyncio.SendfileNotAvailableError
    +

    The “sendfile” syscall is not available for the given +socket or file type.

    +

    A subclass of RuntimeError.

    +
    + +
    +
    +exception asyncio.IncompleteReadError
    +

    The requested read operation did not complete fully.

    +

    Raised by the asyncio stream APIs.

    +

    This exception is a subclass of EOFError.

    +
    +
    +expected
    +

    The total number (int) of expected bytes.

    +
    + +
    +
    +partial
    +

    A string of bytes read before the end of stream was reached.

    +
    + +
    + +
    +
    +exception asyncio.LimitOverrunError
    +

    Reached the buffer size limit while looking for a separator.

    +

    Raised by the asyncio stream APIs.

    +
    +
    +consumed
    +

    The total number of to be consumed bytes.

    +
    + +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/asyncio-future.html b/python-3.7.4-docs-html/library/asyncio-future.html new file mode 100644 index 0000000..f125d5f --- /dev/null +++ b/python-3.7.4-docs-html/library/asyncio-future.html @@ -0,0 +1,435 @@ + + + + + + + Futures — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Futures

    +

    Future objects are used to bridge low-level callback-based code +with high-level async/await code.

    +
    +

    Future Functions

    +
    +
    +asyncio.isfuture(obj)
    +

    Return True if obj is either of:

    +
      +
    • an instance of asyncio.Future,

    • +
    • an instance of asyncio.Task,

    • +
    • a Future-like object with a _asyncio_future_blocking +attribute.

    • +
    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +asyncio.ensure_future(obj, *, loop=None)
    +

    Return:

    +
      +
    • obj argument as is, if obj is a Future, +a Task, or a Future-like object (isfuture() +is used for the test.)

    • +
    • a Task object wrapping obj, if obj is a +coroutine (iscoroutine() is used for the test.)

    • +
    • a Task object that would await on obj, if obj is an +awaitable (inspect.isawaitable() is used for the test.)

    • +
    +

    If obj is neither of the above a TypeError is raised.

    +
    +

    Important

    +

    See also the create_task() function which is the +preferred way for creating new Tasks.

    +
    +
    +

    Changed in version 3.5.1: The function accepts any awaitable object.

    +
    +
    + +
    +
    +asyncio.wrap_future(future, *, loop=None)
    +

    Wrap a concurrent.futures.Future object in a +asyncio.Future object.

    +
    + +
    +
    +

    Future Object

    +
    +
    +class asyncio.Future(*, loop=None)
    +

    A Future represents an eventual result of an asynchronous +operation. Not thread-safe.

    +

    Future is an awaitable object. Coroutines can await on +Future objects until they either have a result or an exception +set, or until they are cancelled.

    +

    Typically Futures are used to enable low-level +callback-based code (e.g. in protocols implemented using asyncio +transports) +to interoperate with high-level async/await code.

    +

    The rule of thumb is to never expose Future objects in user-facing +APIs, and the recommended way to create a Future object is to call +loop.create_future(). This way alternative event loop +implementations can inject their own optimized implementations +of a Future object.

    +
    +

    Changed in version 3.7: Added support for the contextvars module.

    +
    +
    +
    +result()
    +

    Return the result of the Future.

    +

    If the Future is done and has a result set by the +set_result() method, the result value is returned.

    +

    If the Future is done and has an exception set by the +set_exception() method, this method raises the exception.

    +

    If the Future has been cancelled, this method raises +a CancelledError exception.

    +

    If the Future’s result isn’t yet available, this method raises +a InvalidStateError exception.

    +
    + +
    +
    +set_result(result)
    +

    Mark the Future as done and set its result.

    +

    Raises a InvalidStateError error if the Future is +already done.

    +
    + +
    +
    +set_exception(exception)
    +

    Mark the Future as done and set an exception.

    +

    Raises a InvalidStateError error if the Future is +already done.

    +
    + +
    +
    +done()
    +

    Return True if the Future is done.

    +

    A Future is done if it was cancelled or if it has a result +or an exception set with set_result() or +set_exception() calls.

    +
    + +
    +
    +cancelled()
    +

    Return True if the Future was cancelled.

    +

    The method is usually used to check if a Future is not +cancelled before setting a result or an exception for it:

    +
    if not fut.cancelled():
    +    fut.set_result(42)
    +
    +
    +
    + +
    +
    +add_done_callback(callback, *, context=None)
    +

    Add a callback to be run when the Future is done.

    +

    The callback is called with the Future object as its only +argument.

    +

    If the Future is already done when this method is called, +the callback is scheduled with loop.call_soon().

    +

    An optional keyword-only context argument allows specifying a +custom contextvars.Context for the callback to run in. +The current context is used when no context is provided.

    +

    functools.partial() can be used to pass parameters +to the callback, e.g.:

    +
    # Call 'print("Future:", fut)' when "fut" is done.
    +fut.add_done_callback(
    +    functools.partial(print, "Future:"))
    +
    +
    +
    +

    Changed in version 3.7: The context keyword-only parameter was added. +See PEP 567 for more details.

    +
    +
    + +
    +
    +remove_done_callback(callback)
    +

    Remove callback from the callbacks list.

    +

    Returns the number of callbacks removed, which is typically 1, +unless a callback was added more than once.

    +
    + +
    +
    +cancel()
    +

    Cancel the Future and schedule callbacks.

    +

    If the Future is already done or cancelled, return False. +Otherwise, change the Future’s state to cancelled, +schedule the callbacks, and return True.

    +
    + +
    +
    +exception()
    +

    Return the exception that was set on this Future.

    +

    The exception (or None if no exception was set) is +returned only if the Future is done.

    +

    If the Future has been cancelled, this method raises a +CancelledError exception.

    +

    If the Future isn’t done yet, this method raises an +InvalidStateError exception.

    +
    + +
    +
    +get_loop()
    +

    Return the event loop the Future object is bound to.

    +
    +

    New in version 3.7.

    +
    +
    + +
    + +

    This example creates a Future object, creates and schedules an +asynchronous Task to set result for the Future, and waits until +the Future has a result:

    +
    async def set_after(fut, delay, value):
    +    # Sleep for *delay* seconds.
    +    await asyncio.sleep(delay)
    +
    +    # Set *value* as a result of *fut* Future.
    +    fut.set_result(value)
    +
    +async def main():
    +    # Get the current event loop.
    +    loop = asyncio.get_running_loop()
    +
    +    # Create a new Future object.
    +    fut = loop.create_future()
    +
    +    # Run "set_after()" coroutine in a parallel Task.
    +    # We are using the low-level "loop.create_task()" API here because
    +    # we already have a reference to the event loop at hand.
    +    # Otherwise we could have just used "asyncio.create_task()".
    +    loop.create_task(
    +        set_after(fut, 1, '... world'))
    +
    +    print('hello ...')
    +
    +    # Wait until *fut* has a result (1 second) and print it.
    +    print(await fut)
    +
    +asyncio.run(main())
    +
    +
    +
    +

    Important

    +

    The Future object was designed to mimic +concurrent.futures.Future. Key differences include:

    + +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/asyncio-llapi-index.html b/python-3.7.4-docs-html/library/asyncio-llapi-index.html new file mode 100644 index 0000000..2b38f27 --- /dev/null +++ b/python-3.7.4-docs-html/library/asyncio-llapi-index.html @@ -0,0 +1,743 @@ + + + + + + + Low-level API Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Low-level API Index

    +

    This page lists all low-level asyncio APIs.

    +
    +

    Obtaining the Event Loop

    + ++++ + + + + + + + + + + + + + + +

    asyncio.get_running_loop()

    The preferred function to get the running event loop.

    asyncio.get_event_loop()

    Get an event loop instance (current or via the policy).

    asyncio.set_event_loop()

    Set the event loop as current via the current policy.

    asyncio.new_event_loop()

    Create a new event loop.

    +

    Examples

    + +
    +
    +

    Event Loop Methods

    +

    See also the main documentation section about the +event loop methods.

    +

    Lifecycle

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + +

    loop.run_until_complete()

    Run a Future/Task/awaitable until complete.

    loop.run_forever()

    Run the event loop forever.

    loop.stop()

    Stop the event loop.

    loop.close()

    Close the event loop.

    loop.is_running()

    Return True if the event loop is running.

    loop.is_closed()

    Return True if the event loop is closed.

    await loop.shutdown_asyncgens()

    Close asynchronous generators.

    +

    Debugging

    + ++++ + + + + + + + + +

    loop.set_debug()

    Enable or disable the debug mode.

    loop.get_debug()

    Get the current debug mode.

    +

    Scheduling Callbacks

    + ++++ + + + + + + + + + + + + + + +

    loop.call_soon()

    Invoke a callback soon.

    loop.call_soon_threadsafe()

    A thread-safe variant of loop.call_soon().

    loop.call_later()

    Invoke a callback after the given time.

    loop.call_at()

    Invoke a callback at the given time.

    +

    Thread/Process Pool

    + ++++ + + + + + + + + +

    await loop.run_in_executor()

    Run a CPU-bound or other blocking function in +a concurrent.futures executor.

    loop.set_default_executor()

    Set the default executor for loop.run_in_executor().

    +

    Tasks and Futures

    + ++++ + + + + + + + + + + + + + + +

    loop.create_future()

    Create a Future object.

    loop.create_task()

    Schedule coroutine as a Task.

    loop.set_task_factory()

    Set a factory used by loop.create_task() to +create Tasks.

    loop.get_task_factory()

    Get the factory loop.create_task() uses +to create Tasks.

    +

    DNS

    + ++++ + + + + + + + + +

    await loop.getaddrinfo()

    Asynchronous version of socket.getaddrinfo().

    await loop.getnameinfo()

    Asynchronous version of socket.getnameinfo().

    +

    Networking and IPC

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    await loop.create_connection()

    Open a TCP connection.

    await loop.create_server()

    Create a TCP server.

    await loop.create_unix_connection()

    Open a Unix socket connection.

    await loop.create_unix_server()

    Create a Unix socket server.

    await loop.connect_accepted_socket()

    Wrap a socket into a (transport, protocol) +pair.

    await loop.create_datagram_endpoint()

    Open a datagram (UDP) connection.

    await loop.sendfile()

    Send a file over a transport.

    await loop.start_tls()

    Upgrade an existing connection to TLS.

    await loop.connect_read_pipe()

    Wrap a read end of a pipe into a (transport, protocol) pair.

    await loop.connect_write_pipe()

    Wrap a write end of a pipe into a (transport, protocol) pair.

    +

    Sockets

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    await loop.sock_recv()

    Receive data from the socket.

    await loop.sock_recv_into()

    Receive data from the socket into a buffer.

    await loop.sock_sendall()

    Send data to the socket.

    await loop.sock_connect()

    Connect the socket.

    await loop.sock_accept()

    Accept a socket connection.

    await loop.sock_sendfile()

    Send a file over the socket.

    loop.add_reader()

    Start watching a file descriptor for read availability.

    loop.remove_reader()

    Stop watching a file descriptor for read availability.

    loop.add_writer()

    Start watching a file descriptor for write availability.

    loop.remove_writer()

    Stop watching a file descriptor for write availability.

    +

    Unix Signals

    + ++++ + + + + + + + + +

    loop.add_signal_handler()

    Add a handler for a signal.

    loop.remove_signal_handler()

    Remove a handler for a signal.

    +

    Subprocesses

    + ++++ + + + + + + + + +

    loop.subprocess_exec()

    Spawn a subprocess.

    loop.subprocess_shell()

    Spawn a subprocess from a shell command.

    +

    Error Handling

    + ++++ + + + + + + + + + + + + + + +

    loop.call_exception_handler()

    Call the exception handler.

    loop.set_exception_handler()

    Set a new exception handler.

    loop.get_exception_handler()

    Get the current exception handler.

    loop.default_exception_handler()

    The default exception handler implementation.

    +

    Examples

    + +
    +
    +

    Transports

    +

    All transports implement the following methods:

    + ++++ + + + + + + + + + + + + + + + + + +

    transport.close()

    Close the transport.

    transport.is_closing()

    Return True if the transport is closing or is closed.

    transport.get_extra_info()

    Request for information about the transport.

    transport.set_protocol()

    Set a new protocol.

    transport.get_protocol()

    Return the current protocol.

    +

    Transports that can receive data (TCP and Unix connections, +pipes, etc). Returned from methods like +loop.create_connection(), loop.create_unix_connection(), +loop.connect_read_pipe(), etc:

    +

    Read Transports

    + ++++ + + + + + + + + + + + +

    transport.is_reading()

    Return True if the transport is receiving.

    transport.pause_reading()

    Pause receiving.

    transport.resume_reading()

    Resume receiving.

    +

    Transports that can Send data (TCP and Unix connections, +pipes, etc). Returned from methods like +loop.create_connection(), loop.create_unix_connection(), +loop.connect_write_pipe(), etc:

    +

    Write Transports

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + +

    transport.write()

    Write data to the transport.

    transport.writelines()

    Write buffers to the transport.

    transport.can_write_eof()

    Return True if the transport supports sending EOF.

    transport.write_eof()

    Close and send EOF after flushing buffered data.

    transport.abort()

    Close the transport immediately.

    transport.get_write_buffer_size()

    Return high and low water marks for write flow control.

    transport.set_write_buffer_limits()

    Set new high and low water marks for write flow control.

    +

    Transports returned by loop.create_datagram_endpoint():

    +

    Datagram Transports

    + ++++ + + + + + + + + +

    transport.sendto()

    Send data to the remote peer.

    transport.abort()

    Close the transport immediately.

    +

    Low-level transport abstraction over subprocesses. +Returned by loop.subprocess_exec() and +loop.subprocess_shell():

    +

    Subprocess Transports

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + +

    transport.get_pid()

    Return the subprocess process id.

    transport.get_pipe_transport()

    Return the transport for the requested communication pipe +(stdin, stdout, or stderr).

    transport.get_returncode()

    Return the subprocess return code.

    transport.kill()

    Kill the subprocess.

    transport.send_signal()

    Send a signal to the subprocess.

    transport.terminate()

    Stop the subprocess.

    transport.close()

    Kill the subprocess and close all pipes.

    +
    +
    +

    Protocols

    +

    Protocol classes can implement the following callback methods:

    + ++++ + + + + + + + + + + + + + + +

    callback connection_made()

    Called when a connection is made.

    callback connection_lost()

    Called when the connection is lost or closed.

    callback pause_writing()

    Called when the transport’s buffer goes over the high water mark.

    callback resume_writing()

    Called when the transport’s buffer drains below the low water mark.

    +

    Streaming Protocols (TCP, Unix Sockets, Pipes)

    + ++++ + + + + + + + + +

    callback data_received()

    Called when some data is received.

    callback eof_received()

    Called when an EOF is received.

    +

    Buffered Streaming Protocols

    + ++++ + + + + + + + + + + + +

    callback get_buffer()

    Called to allocate a new receive buffer.

    callback buffer_updated()

    Called when the buffer was updated with the received data.

    callback eof_received()

    Called when an EOF is received.

    +

    Datagram Protocols

    + ++++ + + + + + + + + +

    callback datagram_received()

    Called when a datagram is received.

    callback error_received()

    Called when a previous send or receive operation raises an +OSError.

    +

    Subprocess Protocols

    + ++++ + + + + + + + + + + + +

    callback pipe_data_received()

    Called when the child process writes data into its +stdout or stderr pipe.

    callback pipe_connection_lost()

    Called when one of the pipes communicating with +the child process is closed.

    callback process_exited()

    Called when the child process has exited.

    +
    +
    +

    Event Loop Policies

    +

    Policies is a low-level mechanism to alter the behavior of +functions like asyncio.get_event_loop(). See also +the main policies section for more +details.

    +

    Accessing Policies

    + ++++ + + + + + + + + + + + +

    asyncio.get_event_loop_policy()

    Return the current process-wide policy.

    asyncio.set_event_loop_policy()

    Set a new process-wide policy.

    AbstractEventLoopPolicy

    Base class for policy objects.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/asyncio-platforms.html b/python-3.7.4-docs-html/library/asyncio-platforms.html new file mode 100644 index 0000000..94d1fb1 --- /dev/null +++ b/python-3.7.4-docs-html/library/asyncio-platforms.html @@ -0,0 +1,277 @@ + + + + + + + Platform Support — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Platform Support

    +

    The asyncio module is designed to be portable, +but some platforms have subtle differences and limitations +due to the platforms’ underlying architecture and capabilities.

    +
    +

    All Platforms

    + +
    +
    +

    Windows

    +

    All event loops on Windows do not support the following methods:

    + +

    SelectorEventLoop has the following limitations:

    + +

    ProactorEventLoop has the following limitations:

    + +

    The resolution of the monotonic clock on Windows is usually around 15.6 +msec. The best resolution is 0.5 msec. The resolution depends on the +hardware (availability of HPET) and on the +Windows configuration.

    +
    +

    Subprocess Support on Windows

    +

    SelectorEventLoop on Windows does not support subproceses. +On Windows, ProactorEventLoop should be used instead:

    +
    import asyncio
    +
    +asyncio.set_event_loop_policy(
    +    asyncio.WindowsProactorEventLoopPolicy())
    +
    +asyncio.run(your_code())
    +
    +
    +

    The policy.set_child_watcher() function is also +not supported, as ProactorEventLoop has a different mechanism +to watch child processes.

    +
    +
    +
    +

    macOS

    +

    Modern macOS versions are fully supported.

    +

    macOS <= 10.8

    +

    On macOS 10.6, 10.7 and 10.8, the default event loop +uses selectors.KqueueSelector, which does not support +character devices on these versions. The SelectorEventLoop +can be manually configured to use SelectSelector +or PollSelector to support character devices on +these older versions of macOS. Example:

    +
    import asyncio
    +import selectors
    +
    +selector = selectors.SelectSelector()
    +loop = asyncio.SelectorEventLoop(selector)
    +asyncio.set_event_loop(loop)
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/asyncio-policy.html b/python-3.7.4-docs-html/library/asyncio-policy.html new file mode 100644 index 0000000..81fe34b --- /dev/null +++ b/python-3.7.4-docs-html/library/asyncio-policy.html @@ -0,0 +1,413 @@ + + + + + + + Policies — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Policies

    +

    An event loop policy is a global per-process object that controls +the management of the event loop. Each event loop has a default +policy, which can be changed and customized using the policy API.

    +

    A policy defines the notion of context and manages a +separate event loop per context. The default policy +defines context to be the current thread.

    +

    By using a custom event loop policy, the behavior of +get_event_loop(), set_event_loop(), and +new_event_loop() functions can be customized.

    +

    Policy objects should implement the APIs defined +in the AbstractEventLoopPolicy abstract base class.

    +
    +

    Getting and Setting the Policy

    +

    The following functions can be used to get and set the policy +for the current process:

    +
    +
    +asyncio.get_event_loop_policy()
    +

    Return the current process-wide policy.

    +
    + +
    +
    +asyncio.set_event_loop_policy(policy)
    +

    Set the current process-wide policy to policy.

    +

    If policy is set to None, the default policy is restored.

    +
    + +
    +
    +

    Policy Objects

    +

    The abstract event loop policy base class is defined as follows:

    +
    +
    +class asyncio.AbstractEventLoopPolicy
    +

    An abstract base class for asyncio policies.

    +
    +
    +get_event_loop()
    +

    Get the event loop for the current context.

    +

    Return an event loop object implementing the +AbstractEventLoop interface.

    +

    This method should never return None.

    +
    +

    Changed in version 3.6.

    +
    +
    + +
    +
    +set_event_loop(loop)
    +

    Set the event loop for the current context to loop.

    +
    + +
    +
    +new_event_loop()
    +

    Create and return a new event loop object.

    +

    This method should never return None.

    +
    + +
    +
    +get_child_watcher()
    +

    Get a child process watcher object.

    +

    Return a watcher object implementing the +AbstractChildWatcher interface.

    +

    This function is Unix specific.

    +
    + +
    +
    +set_child_watcher(watcher)
    +

    Set the current child process watcher to watcher.

    +

    This function is Unix specific.

    +
    + +
    + +

    asyncio ships with the following built-in policies:

    +
    +
    +class asyncio.DefaultEventLoopPolicy
    +

    The default asyncio policy. Uses SelectorEventLoop +on both Unix and Windows platforms.

    +

    There is no need to install the default policy manually. asyncio +is configured to use the default policy automatically.

    +
    + +
    +
    +class asyncio.WindowsProactorEventLoopPolicy
    +

    An alternative event loop policy that uses the +ProactorEventLoop event loop implementation.

    +

    Availability: Windows.

    +
    + +
    +
    +

    Process Watchers

    +

    A process watcher allows customization of how an event loop monitors +child processes on Unix. Specifically, the event loop needs to know +when a child process has exited.

    +

    In asyncio, child processes are created with +create_subprocess_exec() and loop.subprocess_exec() +functions.

    +

    asyncio defines the AbstractChildWatcher abstract base class, +which child watchers should implement, and has two different +implementations: SafeChildWatcher (configured to be used +by default) and FastChildWatcher.

    +

    See also the Subprocess and Threads +section.

    +

    The following two functions can be used to customize the child process watcher +implementation used by the asyncio event loop:

    +
    +
    +asyncio.get_child_watcher()
    +

    Return the current child watcher for the current policy.

    +
    + +
    +
    +asyncio.set_child_watcher(watcher)
    +

    Set the current child watcher to watcher for the current +policy. watcher must implement methods defined in the +AbstractChildWatcher base class.

    +
    + +
    +

    Note

    +

    Third-party event loops implementations might not support +custom child watchers. For such event loops, using +set_child_watcher() might be prohibited or have no effect.

    +
    +
    +
    +class asyncio.AbstractChildWatcher
    +
    +
    +add_child_handler(pid, callback, *args)
    +

    Register a new child handler.

    +

    Arrange for callback(pid, returncode, *args) to be called +when a process with PID equal to pid terminates. Specifying +another callback for the same process replaces the previous +handler.

    +

    The callback callable must be thread-safe.

    +
    + +
    +
    +remove_child_handler(pid)
    +

    Removes the handler for process with PID equal to pid.

    +

    The function returns True if the handler was successfully +removed, False if there was nothing to remove.

    +
    + +
    +
    +attach_loop(loop)
    +

    Attach the watcher to an event loop.

    +

    If the watcher was previously attached to an event loop, then +it is first detached before attaching to the new loop.

    +

    Note: loop may be None.

    +
    + +
    +
    +close()
    +

    Close the watcher.

    +

    This method has to be called to ensure that underlying +resources are cleaned-up.

    +
    + +
    + +
    +
    +class asyncio.SafeChildWatcher
    +

    This implementation avoids disrupting other code spawning processes +by polling every process explicitly on a SIGCHLD signal.

    +

    This is a safe solution but it has a significant overhead when +handling a big number of processes (O(n) each time a +SIGCHLD is received).

    +

    asyncio uses this safe implementation by default.

    +
    + +
    +
    +class asyncio.FastChildWatcher
    +

    This implementation reaps every terminated processes by calling +os.waitpid(-1) directly, possibly breaking other code spawning +processes and waiting for their termination.

    +

    There is no noticeable overhead when handling a big number of +children (O(1) each time a child terminates).

    +
    + +
    +
    +

    Custom Policies

    +

    To implement a new event loop policy, it is recommended to subclass +DefaultEventLoopPolicy and override the methods for which +custom behavior is wanted, e.g.:

    +
    class MyEventLoopPolicy(asyncio.DefaultEventLoopPolicy):
    +
    +    def get_event_loop(self):
    +        """Get the event loop.
    +
    +        This may be None or an instance of EventLoop.
    +        """
    +        loop = super().get_event_loop()
    +        # Do something with loop ...
    +        return loop
    +
    +asyncio.set_event_loop_policy(MyEventLoopPolicy())
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/asyncio-protocol.html b/python-3.7.4-docs-html/library/asyncio-protocol.html new file mode 100644 index 0000000..c2397ae --- /dev/null +++ b/python-3.7.4-docs-html/library/asyncio-protocol.html @@ -0,0 +1,1222 @@ + + + + + + + Transports and Protocols — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Transports and Protocols

    +

    Preface

    +

    Transports and Protocols are used by the low-level event loop +APIs such as loop.create_connection(). They use +callback-based programming style and enable high-performance +implementations of network or IPC protocols (e.g. HTTP).

    +

    Essentially, transports and protocols should only be used in +libraries and frameworks and never in high-level asyncio +applications.

    +

    This documentation page covers both Transports and Protocols.

    +

    Introduction

    +

    At the highest level, the transport is concerned with how bytes +are transmitted, while the protocol determines which bytes to +transmit (and to some extent when).

    +

    A different way of saying the same thing: a transport is an +abstraction for a socket (or similar I/O endpoint) while a protocol +is an abstraction for an application, from the transport’s point +of view.

    +

    Yet another view is the transport and protocol interfaces +together define an abstract interface for using network I/O and +interprocess I/O.

    +

    There is always a 1:1 relationship between transport and protocol +objects: the protocol calls transport methods to send data, +while the transport calls protocol methods to pass it data that +has been received.

    +

    Most of connection oriented event loop methods +(such as loop.create_connection()) usually accept a +protocol_factory argument used to create a Protocol object +for an accepted connection, represented by a Transport object. +Such methods usually return a tuple of (transport, protocol).

    +

    Contents

    +

    This documentation page contains the following sections:

    + +
    +

    Transports

    +

    Transports are classes provided by asyncio in order to abstract +various kinds of communication channels.

    +

    Transport objects are always instantiated by an +asyncio event loop.

    +

    asyncio implements transports for TCP, UDP, SSL, and subprocess pipes. +The methods available on a transport depend on the transport’s kind.

    +

    The transport classes are not thread safe.

    +
    +

    Transports Hierarchy

    +
    +
    +class asyncio.BaseTransport
    +

    Base class for all transports. Contains methods that all +asyncio transports share.

    +
    + +
    +
    +class asyncio.WriteTransport(BaseTransport)
    +

    A base transport for write-only connections.

    +

    Instances of the WriteTransport class are returned from +the loop.connect_write_pipe() event loop method and +are also used by subprocess-related methods like +loop.subprocess_exec().

    +
    + +
    +
    +class asyncio.ReadTransport(BaseTransport)
    +

    A base transport for read-only connections.

    +

    Instances of the ReadTransport class are returned from +the loop.connect_read_pipe() event loop method and +are also used by subprocess-related methods like +loop.subprocess_exec().

    +
    + +
    +
    +class asyncio.Transport(WriteTransport, ReadTransport)
    +

    Interface representing a bidirectional transport, such as a +TCP connection.

    +

    The user does not instantiate a transport directly; they call a +utility function, passing it a protocol factory and other +information necessary to create the transport and protocol.

    +

    Instances of the Transport class are returned from or used by +event loop methods like loop.create_connection(), +loop.create_unix_connection(), +loop.create_server(), loop.sendfile(), etc.

    +
    + +
    +
    +class asyncio.DatagramTransport(BaseTransport)
    +

    A transport for datagram (UDP) connections.

    +

    Instances of the DatagramTransport class are returned from +the loop.create_datagram_endpoint() event loop method.

    +
    + +
    +
    +class asyncio.SubprocessTransport(BaseTransport)
    +

    An abstraction to represent a connection between a parent and its +child OS process.

    +

    Instances of the SubprocessTransport class are returned from +event loop methods loop.subprocess_shell() and +loop.subprocess_exec().

    +
    + +
    +
    +

    Base Transport

    +
    +
    +BaseTransport.close()
    +

    Close the transport.

    +

    If the transport has a buffer for outgoing +data, buffered data will be flushed asynchronously. No more data +will be received. After all buffered data is flushed, the +protocol’s protocol.connection_lost() method will be called with +None as its argument.

    +
    + +
    +
    +BaseTransport.is_closing()
    +

    Return True if the transport is closing or is closed.

    +
    + +
    +
    +BaseTransport.get_extra_info(name, default=None)
    +

    Return information about the transport or underlying resources +it uses.

    +

    name is a string representing the piece of transport-specific +information to get.

    +

    default is the value to return if the information is not +available, or if the transport does not support querying it +with the given third-party event loop implementation or on the +current platform.

    +

    For example, the following code attempts to get the underlying +socket object of the transport:

    +
    sock = transport.get_extra_info('socket')
    +if sock is not None:
    +    print(sock.getsockopt(...))
    +
    +
    +

    Categories of information that can be queried on some transports:

    + +
    + +
    +
    +BaseTransport.set_protocol(protocol)
    +

    Set a new protocol.

    +

    Switching protocol should only be done when both +protocols are documented to support the switch.

    +
    + +
    +
    +BaseTransport.get_protocol()
    +

    Return the current protocol.

    +
    + +
    +
    +

    Read-only Transports

    +
    +
    +ReadTransport.is_reading()
    +

    Return True if the transport is receiving new data.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +ReadTransport.pause_reading()
    +

    Pause the receiving end of the transport. No data will be passed to +the protocol’s protocol.data_received() +method until resume_reading() is called.

    +
    +

    Changed in version 3.7: The method is idempotent, i.e. it can be called when the +transport is already paused or closed.

    +
    +
    + +
    +
    +ReadTransport.resume_reading()
    +

    Resume the receiving end. The protocol’s +protocol.data_received() method +will be called once again if some data is available for reading.

    +
    +

    Changed in version 3.7: The method is idempotent, i.e. it can be called when the +transport is already reading.

    +
    +
    + +
    +
    +

    Write-only Transports

    +
    +
    +WriteTransport.abort()
    +

    Close the transport immediately, without waiting for pending operations +to complete. Buffered data will be lost. No more data will be received. +The protocol’s protocol.connection_lost() method will eventually be +called with None as its argument.

    +
    + +
    +
    +WriteTransport.can_write_eof()
    +

    Return True if the transport supports +write_eof(), False if not.

    +
    + +
    +
    +WriteTransport.get_write_buffer_size()
    +

    Return the current size of the output buffer used by the transport.

    +
    + +
    +
    +WriteTransport.get_write_buffer_limits()
    +

    Get the high and low watermarks for write flow control. Return a +tuple (low, high) where low and high are positive number of +bytes.

    +

    Use set_write_buffer_limits() to set the limits.

    +
    +

    New in version 3.4.2.

    +
    +
    + +
    +
    +WriteTransport.set_write_buffer_limits(high=None, low=None)
    +

    Set the high and low watermarks for write flow control.

    +

    These two values (measured in number of +bytes) control when the protocol’s +protocol.pause_writing() +and protocol.resume_writing() +methods are called. If specified, the low watermark must be less +than or equal to the high watermark. Neither high nor low +can be negative.

    +

    pause_writing() is called when the buffer size +becomes greater than or equal to the high value. If writing has +been paused, resume_writing() is called when +the buffer size becomes less than or equal to the low value.

    +

    The defaults are implementation-specific. If only the +high watermark is given, the low watermark defaults to an +implementation-specific value less than or equal to the +high watermark. Setting high to zero forces low to zero as +well, and causes pause_writing() to be called +whenever the buffer becomes non-empty. Setting low to zero causes +resume_writing() to be called only once the +buffer is empty. Use of zero for either limit is generally +sub-optimal as it reduces opportunities for doing I/O and +computation concurrently.

    +

    Use get_write_buffer_limits() +to get the limits.

    +
    + +
    +
    +WriteTransport.write(data)
    +

    Write some data bytes to the transport.

    +

    This method does not block; it buffers the data and arranges for it +to be sent out asynchronously.

    +
    + +
    +
    +WriteTransport.writelines(list_of_data)
    +

    Write a list (or any iterable) of data bytes to the transport. +This is functionally equivalent to calling write() on each +element yielded by the iterable, but may be implemented more +efficiently.

    +
    + +
    +
    +WriteTransport.write_eof()
    +

    Close the write end of the transport after flushing all buffered data. +Data may still be received.

    +

    This method can raise NotImplementedError if the transport +(e.g. SSL) doesn’t support half-closed connections.

    +
    + +
    +
    +

    Datagram Transports

    +
    +
    +DatagramTransport.sendto(data, addr=None)
    +

    Send the data bytes to the remote peer given by addr (a +transport-dependent target address). If addr is None, +the data is sent to the target address given on transport +creation.

    +

    This method does not block; it buffers the data and arranges +for it to be sent out asynchronously.

    +
    + +
    +
    +DatagramTransport.abort()
    +

    Close the transport immediately, without waiting for pending +operations to complete. Buffered data will be lost. +No more data will be received. The protocol’s +protocol.connection_lost() +method will eventually be called with None as its argument.

    +
    + +
    +
    +

    Subprocess Transports

    +
    +
    +SubprocessTransport.get_pid()
    +

    Return the subprocess process id as an integer.

    +
    + +
    +
    +SubprocessTransport.get_pipe_transport(fd)
    +

    Return the transport for the communication pipe corresponding to the +integer file descriptor fd:

    +
      +
    • 0: readable streaming transport of the standard input (stdin), +or None if the subprocess was not created with stdin=PIPE

    • +
    • 1: writable streaming transport of the standard output (stdout), +or None if the subprocess was not created with stdout=PIPE

    • +
    • 2: writable streaming transport of the standard error (stderr), +or None if the subprocess was not created with stderr=PIPE

    • +
    • other fd: None

    • +
    +
    + +
    +
    +SubprocessTransport.get_returncode()
    +

    Return the subprocess return code as an integer or None +if it hasn’t returned, which is similar to the +subprocess.Popen.returncode attribute.

    +
    + +
    +
    +SubprocessTransport.kill()
    +

    Kill the subprocess.

    +

    On POSIX systems, the function sends SIGKILL to the subprocess. +On Windows, this method is an alias for terminate().

    +

    See also subprocess.Popen.kill().

    +
    + +
    +
    +SubprocessTransport.send_signal(signal)
    +

    Send the signal number to the subprocess, as in +subprocess.Popen.send_signal().

    +
    + +
    +
    +SubprocessTransport.terminate()
    +

    Stop the subprocess.

    +

    On POSIX systems, this method sends SIGTERM to the subprocess. +On Windows, the Windows API function TerminateProcess() is called to +stop the subprocess.

    +

    See also subprocess.Popen.terminate().

    +
    + +
    +
    +SubprocessTransport.close()
    +

    Kill the subprocess by calling the kill() method.

    +

    If the subprocess hasn’t returned yet, and close transports of +stdin, stdout, and stderr pipes.

    +
    + +
    +
    +
    +

    Protocols

    +

    asyncio provides a set of abstract base classes that should be used +to implement network protocols. Those classes are meant to be used +together with transports.

    +

    Subclasses of abstract base protocol classes may implement some or +all methods. All these methods are callbacks: they are called by +transports on certain events, for example when some data is received. +A base protocol method should be called by the corresponding transport.

    +
    +

    Base Protocols

    +
    +
    +class asyncio.BaseProtocol
    +

    Base protocol with methods that all protocols share.

    +
    + +
    +
    +class asyncio.Protocol(BaseProtocol)
    +

    The base class for implementing streaming protocols +(TCP, Unix sockets, etc).

    +
    + +
    +
    +class asyncio.BufferedProtocol(BaseProtocol)
    +

    A base class for implementing streaming protocols with manual +control of the receive buffer.

    +
    + +
    +
    +class asyncio.DatagramProtocol(BaseProtocol)
    +

    The base class for implementing datagram (UDP) protocols.

    +
    + +
    +
    +class asyncio.SubprocessProtocol(BaseProtocol)
    +

    The base class for implementing protocols communicating with child +processes (unidirectional pipes).

    +
    + +
    +
    +

    Base Protocol

    +

    All asyncio protocols can implement Base Protocol callbacks.

    +

    Connection Callbacks

    +

    Connection callbacks are called on all protocols, exactly once per +a successful connection. All other protocol callbacks can only be +called between those two methods.

    +
    +
    +BaseProtocol.connection_made(transport)
    +

    Called when a connection is made.

    +

    The transport argument is the transport representing the +connection. The protocol is responsible for storing the reference +to its transport.

    +
    + +
    +
    +BaseProtocol.connection_lost(exc)
    +

    Called when the connection is lost or closed.

    +

    The argument is either an exception object or None. +The latter means a regular EOF is received, or the connection was +aborted or closed by this side of the connection.

    +
    + +

    Flow Control Callbacks

    +

    Flow control callbacks can be called by transports to pause or +resume writing performed by the protocol.

    +

    See the documentation of the set_write_buffer_limits() +method for more details.

    +
    +
    +BaseProtocol.pause_writing()
    +

    Called when the transport’s buffer goes over the high watermark.

    +
    + +
    +
    +BaseProtocol.resume_writing()
    +

    Called when the transport’s buffer drains below the low watermark.

    +
    + +

    If the buffer size equals the high watermark, +pause_writing() is not called: the buffer size must +go strictly over.

    +

    Conversely, resume_writing() is called when the +buffer size is equal or lower than the low watermark. These end +conditions are important to ensure that things go as expected when +either mark is zero.

    +
    +
    +

    Streaming Protocols

    +

    Event methods, such as loop.create_server(), +loop.create_unix_server(), loop.create_connection(), +loop.create_unix_connection(), loop.connect_accepted_socket(), +loop.connect_read_pipe(), and loop.connect_write_pipe() +accept factories that return streaming protocols.

    +
    +
    +Protocol.data_received(data)
    +

    Called when some data is received. data is a non-empty bytes +object containing the incoming data.

    +

    Whether the data is buffered, chunked or reassembled depends on +the transport. In general, you shouldn’t rely on specific semantics +and instead make your parsing generic and flexible. However, +data is always received in the correct order.

    +

    The method can be called an arbitrary number of times while +a connection is open.

    +

    However, protocol.eof_received() +is called at most once. Once eof_received() is called, +data_received() is not called anymore.

    +
    + +
    +
    +Protocol.eof_received()
    +

    Called when the other end signals it won’t send any more data +(for example by calling transport.write_eof(), if the other end also uses +asyncio).

    +

    This method may return a false value (including None), in which case +the transport will close itself. Conversely, if this method returns a +true value, the protocol used determines whether to close the transport. +Since the default implementation returns None, it implicitly closes the +connection.

    +

    Some transports, including SSL, don’t support half-closed connections, +in which case returning true from this method will result in the connection +being closed.

    +
    + +

    State machine:

    +
    start -> connection_made
    +    [-> data_received]*
    +    [-> eof_received]?
    +-> connection_lost -> end
    +
    +
    +
    +
    +

    Buffered Streaming Protocols

    +
    +

    New in version 3.7: Important: this has been added to asyncio in Python 3.7 +on a provisional basis! This is as an experimental API that +might be changed or removed completely in Python 3.8.

    +
    +

    Buffered Protocols can be used with any event loop method +that supports Streaming Protocols.

    +

    BufferedProtocol implementations allow explicit manual allocation +and control of the receive buffer. Event loops can then use the buffer +provided by the protocol to avoid unnecessary data copies. This +can result in noticeable performance improvement for protocols that +receive big amounts of data. Sophisticated protocol implementations +can significantly reduce the number of buffer allocations.

    +

    The following callbacks are called on BufferedProtocol +instances:

    +
    +
    +BufferedProtocol.get_buffer(sizehint)
    +

    Called to allocate a new receive buffer.

    +

    sizehint is the recommended minimum size for the returned +buffer. It is acceptable to return smaller or larger buffers +than what sizehint suggests. When set to -1, the buffer size +can be arbitrary. It is an error to return a buffer with a zero size.

    +

    get_buffer() must return an object implementing the +buffer protocol.

    +
    + +
    +
    +BufferedProtocol.buffer_updated(nbytes)
    +

    Called when the buffer was updated with the received data.

    +

    nbytes is the total number of bytes that were written to the buffer.

    +
    + +
    +
    +BufferedProtocol.eof_received()
    +

    See the documentation of the protocol.eof_received() method.

    +
    + +

    get_buffer() can be called an arbitrary number +of times during a connection. However, protocol.eof_received() is called at most once +and, if called, get_buffer() and +buffer_updated() won’t be called after it.

    +

    State machine:

    +
    start -> connection_made
    +    [-> get_buffer
    +        [-> buffer_updated]?
    +    ]*
    +    [-> eof_received]?
    +-> connection_lost -> end
    +
    +
    +
    +
    +

    Datagram Protocols

    +

    Datagram Protocol instances should be constructed by protocol +factories passed to the loop.create_datagram_endpoint() method.

    +
    +
    +DatagramProtocol.datagram_received(data, addr)
    +

    Called when a datagram is received. data is a bytes object containing +the incoming data. addr is the address of the peer sending the data; +the exact format depends on the transport.

    +
    + +
    +
    +DatagramProtocol.error_received(exc)
    +

    Called when a previous send or receive operation raises an +OSError. exc is the OSError instance.

    +

    This method is called in rare conditions, when the transport (e.g. UDP) +detects that a datagram could not be delivered to its recipient. +In many conditions though, undeliverable datagrams will be silently +dropped.

    +
    + +
    +

    Note

    +

    On BSD systems (macOS, FreeBSD, etc.) flow control is not supported +for datagram protocols, because there is no reliable way to detect send +failures caused by writing too many packets.

    +

    The socket always appears ‘ready’ and excess packets are dropped. An +OSError with errno set to errno.ENOBUFS may +or may not be raised; if it is raised, it will be reported to +DatagramProtocol.error_received() but otherwise ignored.

    +
    +
    +
    +

    Subprocess Protocols

    +

    Datagram Protocol instances should be constructed by protocol +factories passed to the loop.subprocess_exec() and +loop.subprocess_shell() methods.

    +
    +
    +SubprocessProtocol.pipe_data_received(fd, data)
    +

    Called when the child process writes data into its stdout or stderr +pipe.

    +

    fd is the integer file descriptor of the pipe.

    +

    data is a non-empty bytes object containing the received data.

    +
    + +
    +
    +SubprocessProtocol.pipe_connection_lost(fd, exc)
    +

    Called when one of the pipes communicating with the child process +is closed.

    +

    fd is the integer file descriptor that was closed.

    +
    + +
    +
    +SubprocessProtocol.process_exited()
    +

    Called when the child process has exited.

    +
    + +
    +
    +
    +

    Examples

    +
    +

    TCP Echo Server

    +

    Create a TCP echo server using the loop.create_server() method, send back +received data, and close the connection:

    +
    import asyncio
    +
    +
    +class EchoServerProtocol(asyncio.Protocol):
    +    def connection_made(self, transport):
    +        peername = transport.get_extra_info('peername')
    +        print('Connection from {}'.format(peername))
    +        self.transport = transport
    +
    +    def data_received(self, data):
    +        message = data.decode()
    +        print('Data received: {!r}'.format(message))
    +
    +        print('Send: {!r}'.format(message))
    +        self.transport.write(data)
    +
    +        print('Close the client socket')
    +        self.transport.close()
    +
    +
    +async def main():
    +    # Get a reference to the event loop as we plan to use
    +    # low-level APIs.
    +    loop = asyncio.get_running_loop()
    +
    +    server = await loop.create_server(
    +        lambda: EchoServerProtocol(),
    +        '127.0.0.1', 8888)
    +
    +    async with server:
    +        await server.serve_forever()
    +
    +
    +asyncio.run(main())
    +
    +
    +
    +

    See also

    +

    The TCP echo server using streams +example uses the high-level asyncio.start_server() function.

    +
    +
    +
    +

    TCP Echo Client

    +

    A TCP echo client using the loop.create_connection() method, sends +data, and waits until the connection is closed:

    +
    import asyncio
    +
    +
    +class EchoClientProtocol(asyncio.Protocol):
    +    def __init__(self, message, on_con_lost, loop):
    +        self.message = message
    +        self.loop = loop
    +        self.on_con_lost = on_con_lost
    +
    +    def connection_made(self, transport):
    +        transport.write(self.message.encode())
    +        print('Data sent: {!r}'.format(self.message))
    +
    +    def data_received(self, data):
    +        print('Data received: {!r}'.format(data.decode()))
    +
    +    def connection_lost(self, exc):
    +        print('The server closed the connection')
    +        self.on_con_lost.set_result(True)
    +
    +
    +async def main():
    +    # Get a reference to the event loop as we plan to use
    +    # low-level APIs.
    +    loop = asyncio.get_running_loop()
    +
    +    on_con_lost = loop.create_future()
    +    message = 'Hello World!'
    +
    +    transport, protocol = await loop.create_connection(
    +        lambda: EchoClientProtocol(message, on_con_lost, loop),
    +        '127.0.0.1', 8888)
    +
    +    # Wait until the protocol signals that the connection
    +    # is lost and close the transport.
    +    try:
    +        await on_con_lost
    +    finally:
    +        transport.close()
    +
    +
    +asyncio.run(main())
    +
    +
    +
    +

    See also

    +

    The TCP echo client using streams +example uses the high-level asyncio.open_connection() function.

    +
    +
    +
    +

    UDP Echo Server

    +

    A UDP echo server, using the loop.create_datagram_endpoint() +method, sends back received data:

    +
    import asyncio
    +
    +
    +class EchoServerProtocol:
    +    def connection_made(self, transport):
    +        self.transport = transport
    +
    +    def datagram_received(self, data, addr):
    +        message = data.decode()
    +        print('Received %r from %s' % (message, addr))
    +        print('Send %r to %s' % (message, addr))
    +        self.transport.sendto(data, addr)
    +
    +
    +async def main():
    +    print("Starting UDP server")
    +
    +    # Get a reference to the event loop as we plan to use
    +    # low-level APIs.
    +    loop = asyncio.get_running_loop()
    +
    +    # One protocol instance will be created to serve all
    +    # client requests.
    +    transport, protocol = await loop.create_datagram_endpoint(
    +        lambda: EchoServerProtocol(),
    +        local_addr=('127.0.0.1', 9999))
    +
    +    try:
    +        await asyncio.sleep(3600)  # Serve for 1 hour.
    +    finally:
    +        transport.close()
    +
    +
    +asyncio.run(main())
    +
    +
    +
    +
    +

    UDP Echo Client

    +

    A UDP echo client, using the loop.create_datagram_endpoint() +method, sends data and closes the transport when it receives the answer:

    +
    import asyncio
    +
    +
    +class EchoClientProtocol:
    +    def __init__(self, message, loop):
    +        self.message = message
    +        self.loop = loop
    +        self.transport = None
    +        self.on_con_lost = loop.create_future()
    +
    +    def connection_made(self, transport):
    +        self.transport = transport
    +        print('Send:', self.message)
    +        self.transport.sendto(self.message.encode())
    +
    +    def datagram_received(self, data, addr):
    +        print("Received:", data.decode())
    +
    +        print("Close the socket")
    +        self.transport.close()
    +
    +    def error_received(self, exc):
    +        print('Error received:', exc)
    +
    +    def connection_lost(self, exc):
    +        print("Connection closed")
    +        self.on_con_lost.set_result(True)
    +
    +
    +async def main():
    +    # Get a reference to the event loop as we plan to use
    +    # low-level APIs.
    +    loop = asyncio.get_running_loop()
    +
    +    message = "Hello World!"
    +    transport, protocol = await loop.create_datagram_endpoint(
    +        lambda: EchoClientProtocol(message, loop),
    +        remote_addr=('127.0.0.1', 9999))
    +
    +    try:
    +        await protocol.on_con_lost
    +    finally:
    +        transport.close()
    +
    +
    +asyncio.run(main())
    +
    +
    +
    +
    +

    Connecting Existing Sockets

    +

    Wait until a socket receives data using the +loop.create_connection() method with a protocol:

    +
    import asyncio
    +import socket
    +
    +
    +class MyProtocol(asyncio.Protocol):
    +
    +    def __init__(self, loop):
    +        self.transport = None
    +        self.on_con_lost = loop.create_future()
    +
    +    def connection_made(self, transport):
    +        self.transport = transport
    +
    +    def data_received(self, data):
    +        print("Received:", data.decode())
    +
    +        # We are done: close the transport;
    +        # connection_lost() will be called automatically.
    +        self.transport.close()
    +
    +    def connection_lost(self, exc):
    +        # The socket has been closed
    +        self.on_con_lost.set_result(True)
    +
    +
    +async def main():
    +    # Get a reference to the event loop as we plan to use
    +    # low-level APIs.
    +    loop = asyncio.get_running_loop()
    +
    +    # Create a pair of connected sockets
    +    rsock, wsock = socket.socketpair()
    +
    +    # Register the socket to wait for data.
    +    transport, protocol = await loop.create_connection(
    +        lambda: MyProtocol(loop), sock=rsock)
    +
    +    # Simulate the reception of data from the network.
    +    loop.call_soon(wsock.send, 'abc'.encode())
    +
    +    try:
    +        await protocol.on_con_lost
    +    finally:
    +        transport.close()
    +        wsock.close()
    +
    +asyncio.run(main())
    +
    +
    +
    +

    See also

    +

    The watch a file descriptor for read events example uses the low-level +loop.add_reader() method to register an FD.

    +

    The register an open socket to wait for data using streams example uses high-level streams +created by the open_connection() function in a coroutine.

    +
    +
    +
    +

    loop.subprocess_exec() and SubprocessProtocol

    +

    An example of a subprocess protocol used to get the output of a +subprocess and to wait for the subprocess exit.

    +

    The subprocess is created by th loop.subprocess_exec() method:

    +
    import asyncio
    +import sys
    +
    +class DateProtocol(asyncio.SubprocessProtocol):
    +    def __init__(self, exit_future):
    +        self.exit_future = exit_future
    +        self.output = bytearray()
    +
    +    def pipe_data_received(self, fd, data):
    +        self.output.extend(data)
    +
    +    def process_exited(self):
    +        self.exit_future.set_result(True)
    +
    +async def get_date():
    +    # Get a reference to the event loop as we plan to use
    +    # low-level APIs.
    +    loop = asyncio.get_running_loop()
    +
    +    code = 'import datetime; print(datetime.datetime.now())'
    +    exit_future = asyncio.Future(loop=loop)
    +
    +    # Create the subprocess controlled by DateProtocol;
    +    # redirect the standard output into a pipe.
    +    transport, protocol = await loop.subprocess_exec(
    +        lambda: DateProtocol(exit_future),
    +        sys.executable, '-c', code,
    +        stdin=None, stderr=None)
    +
    +    # Wait for the subprocess exit using the process_exited()
    +    # method of the protocol.
    +    await exit_future
    +
    +    # Close the stdout pipe.
    +    transport.close()
    +
    +    # Read the output which was collected by the
    +    # pipe_data_received() method of the protocol.
    +    data = bytes(protocol.output)
    +    return data.decode('ascii').rstrip()
    +
    +if sys.platform == "win32":
    +    asyncio.set_event_loop_policy(
    +        asyncio.WindowsProactorEventLoopPolicy())
    +
    +date = asyncio.run(get_date())
    +print(f"Current date: {date}")
    +
    +
    +

    See also the same example +written using high-level APIs.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/asyncio-queue.html b/python-3.7.4-docs-html/library/asyncio-queue.html new file mode 100644 index 0000000..87d65fe --- /dev/null +++ b/python-3.7.4-docs-html/library/asyncio-queue.html @@ -0,0 +1,400 @@ + + + + + + + Queues — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Queues

    +

    asyncio queues are designed to be similar to classes of the +queue module. Although asyncio queues are not thread-safe, +they are designed to be used specifically in async/await code.

    +

    Note that methods of asyncio queues don’t have a timeout parameter; +use asyncio.wait_for() function to do queue operations with a +timeout.

    +

    See also the Examples section below.

    +
    +

    Queue

    +
    +
    +class asyncio.Queue(maxsize=0, *, loop=None)
    +

    A first in, first out (FIFO) queue.

    +

    If maxsize is less than or equal to zero, the queue size is +infinite. If it is an integer greater than 0, then +await put() blocks when the queue reaches maxsize +until an item is removed by get().

    +

    Unlike the standard library threading queue, the size of +the queue is always known and can be returned by calling the +qsize() method.

    +

    This class is not thread safe.

    +
    +
    +maxsize
    +

    Number of items allowed in the queue.

    +
    + +
    +
    +empty()
    +

    Return True if the queue is empty, False otherwise.

    +
    + +
    +
    +full()
    +

    Return True if there are maxsize items in the queue.

    +

    If the queue was initialized with maxsize=0 (the default), +then full() never returns True.

    +
    + +
    +
    +coroutine get()
    +

    Remove and return an item from the queue. If queue is empty, +wait until an item is available.

    +
    + +
    +
    +get_nowait()
    +

    Return an item if one is immediately available, else raise +QueueEmpty.

    +
    + +
    +
    +coroutine join()
    +

    Block until all items in the queue have been received and processed.

    +

    The count of unfinished tasks goes up whenever an item is added +to the queue. The count goes down whenever a consumer coroutine calls +task_done() to indicate that the item was retrieved and all +work on it is complete. When the count of unfinished tasks drops +to zero, join() unblocks.

    +
    + +
    +
    +coroutine put(item)
    +

    Put an item into the queue. If the queue is full, wait until a +free slot is available before adding the item.

    +
    + +
    +
    +put_nowait(item)
    +

    Put an item into the queue without blocking.

    +

    If no free slot is immediately available, raise QueueFull.

    +
    + +
    +
    +qsize()
    +

    Return the number of items in the queue.

    +
    + +
    +
    +task_done()
    +

    Indicate that a formerly enqueued task is complete.

    +

    Used by queue consumers. For each get() used to +fetch a task, a subsequent call to task_done() tells the +queue that the processing on the task is complete.

    +

    If a join() is currently blocking, it will resume when all +items have been processed (meaning that a task_done() +call was received for every item that had been put() +into the queue).

    +

    Raises ValueError if called more times than there were +items placed in the queue.

    +
    + +
    + +
    +
    +

    Priority Queue

    +
    +
    +class asyncio.PriorityQueue
    +

    A variant of Queue; retrieves entries in priority order +(lowest first).

    +

    Entries are typically tuples of the form +(priority_number, data).

    +
    + +
    +
    +

    LIFO Queue

    +
    +
    +class asyncio.LifoQueue
    +

    A variant of Queue that retrieves most recently added +entries first (last in, first out).

    +
    + +
    +
    +

    Exceptions

    +
    +
    +exception asyncio.QueueEmpty
    +

    This exception is raised when the get_nowait() method +is called on an empty queue.

    +
    + +
    +
    +exception asyncio.QueueFull
    +

    Exception raised when the put_nowait() method is called +on a queue that has reached its maxsize.

    +
    + +
    +
    +

    Examples

    +

    Queues can be used to distribute workload between several +concurrent tasks:

    +
    import asyncio
    +import random
    +import time
    +
    +
    +async def worker(name, queue):
    +    while True:
    +        # Get a "work item" out of the queue.
    +        sleep_for = await queue.get()
    +
    +        # Sleep for the "sleep_for" seconds.
    +        await asyncio.sleep(sleep_for)
    +
    +        # Notify the queue that the "work item" has been processed.
    +        queue.task_done()
    +
    +        print(f'{name} has slept for {sleep_for:.2f} seconds')
    +
    +
    +async def main():
    +    # Create a queue that we will use to store our "workload".
    +    queue = asyncio.Queue()
    +
    +    # Generate random timings and put them into the queue.
    +    total_sleep_time = 0
    +    for _ in range(20):
    +        sleep_for = random.uniform(0.05, 1.0)
    +        total_sleep_time += sleep_for
    +        queue.put_nowait(sleep_for)
    +
    +    # Create three worker tasks to process the queue concurrently.
    +    tasks = []
    +    for i in range(3):
    +        task = asyncio.create_task(worker(f'worker-{i}', queue))
    +        tasks.append(task)
    +
    +    # Wait until the queue is fully processed.
    +    started_at = time.monotonic()
    +    await queue.join()
    +    total_slept_for = time.monotonic() - started_at
    +
    +    # Cancel our worker tasks.
    +    for task in tasks:
    +        task.cancel()
    +    # Wait until all worker tasks are cancelled.
    +    await asyncio.gather(*tasks, return_exceptions=True)
    +
    +    print('====')
    +    print(f'3 workers slept in parallel for {total_slept_for:.2f} seconds')
    +    print(f'total expected sleep time: {total_sleep_time:.2f} seconds')
    +
    +
    +asyncio.run(main())
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/asyncio-stream.html b/python-3.7.4-docs-html/library/asyncio-stream.html new file mode 100644 index 0000000..ad05753 --- /dev/null +++ b/python-3.7.4-docs-html/library/asyncio-stream.html @@ -0,0 +1,630 @@ + + + + + + + Streams — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Streams

    +

    Streams are high-level async/await-ready primitives to work with +network connections. Streams allow sending and receiving data without +using callbacks or low-level protocols and transports.

    +

    Here is an example of a TCP echo client written using asyncio +streams:

    +
    import asyncio
    +
    +async def tcp_echo_client(message):
    +    reader, writer = await asyncio.open_connection(
    +        '127.0.0.1', 8888)
    +
    +    print(f'Send: {message!r}')
    +    writer.write(message.encode())
    +
    +    data = await reader.read(100)
    +    print(f'Received: {data.decode()!r}')
    +
    +    print('Close the connection')
    +    writer.close()
    +    await writer.wait_closed()
    +
    +asyncio.run(tcp_echo_client('Hello World!'))
    +
    +
    +

    See also the Examples section below.

    +

    Stream Functions

    +

    The following top-level asyncio functions can be used to create +and work with streams:

    +
    +
    +coroutine asyncio.open_connection(host=None, port=None, *, loop=None, limit=None, ssl=None, family=0, proto=0, flags=0, sock=None, local_addr=None, server_hostname=None, ssl_handshake_timeout=None)
    +

    Establish a network connection and return a pair of +(reader, writer) objects.

    +

    The returned reader and writer objects are instances of +StreamReader and StreamWriter classes.

    +

    The loop argument is optional and can always be determined +automatically when this function is awaited from a coroutine.

    +

    limit determines the buffer size limit used by the +returned StreamReader instance. By default the limit +is set to 64 KiB.

    +

    The rest of the arguments are passed directly to +loop.create_connection().

    +
    +

    New in version 3.7: The ssl_handshake_timeout parameter.

    +
    +
    + +
    +
    +coroutine asyncio.start_server(client_connected_cb, host=None, port=None, *, loop=None, limit=None, family=socket.AF_UNSPEC, flags=socket.AI_PASSIVE, sock=None, backlog=100, ssl=None, reuse_address=None, reuse_port=None, ssl_handshake_timeout=None, start_serving=True)
    +

    Start a socket server.

    +

    The client_connected_cb callback is called whenever a new client +connection is established. It receives a (reader, writer) pair +as two arguments, instances of the StreamReader and +StreamWriter classes.

    +

    client_connected_cb can be a plain callable or a +coroutine function; if it is a coroutine function, +it will be automatically scheduled as a Task.

    +

    The loop argument is optional and can always be determined +automatically when this method is awaited from a coroutine.

    +

    limit determines the buffer size limit used by the +returned StreamReader instance. By default the limit +is set to 64 KiB.

    +

    The rest of the arguments are passed directly to +loop.create_server().

    +
    +

    New in version 3.7: The ssl_handshake_timeout and start_serving parameters.

    +
    +
    + +

    Unix Sockets

    +
    +
    +coroutine asyncio.open_unix_connection(path=None, *, loop=None, limit=None, ssl=None, sock=None, server_hostname=None, ssl_handshake_timeout=None)
    +

    Establish a Unix socket connection and return a pair of +(reader, writer).

    +

    Similar to open_connection() but operates on Unix sockets.

    +

    See also the documentation of loop.create_unix_connection().

    +

    Availability: Unix.

    +
    +

    New in version 3.7: The ssl_handshake_timeout parameter.

    +
    +
    +

    Changed in version 3.7: The path parameter can now be a path-like object

    +
    +
    + +
    +
    +coroutine asyncio.start_unix_server(client_connected_cb, path=None, *, loop=None, limit=None, sock=None, backlog=100, ssl=None, ssl_handshake_timeout=None, start_serving=True)
    +

    Start a Unix socket server.

    +

    Similar to start_server() but works with Unix sockets.

    +

    See also the documentation of loop.create_unix_server().

    +

    Availability: Unix.

    +
    +

    New in version 3.7: The ssl_handshake_timeout and start_serving parameters.

    +
    +
    +

    Changed in version 3.7: The path parameter can now be a path-like object.

    +
    +
    + +
    +
    +

    StreamReader

    +
    +
    +class asyncio.StreamReader
    +

    Represents a reader object that provides APIs to read data +from the IO stream.

    +

    It is not recommended to instantiate StreamReader objects +directly; use open_connection() and start_server() +instead.

    +
    +
    +coroutine read(n=-1)
    +

    Read up to n bytes. If n is not provided, or set to -1, +read until EOF and return all read bytes.

    +

    If EOF was received and the internal buffer is empty, +return an empty bytes object.

    +
    + +
    +
    +coroutine readline()
    +

    Read one line, where “line” is a sequence of bytes +ending with \n.

    +

    If EOF is received and \n was not found, the method +returns partially read data.

    +

    If EOF is received and the internal buffer is empty, +return an empty bytes object.

    +
    + +
    +
    +coroutine readexactly(n)
    +

    Read exactly n bytes.

    +

    Raise an IncompleteReadError if EOF is reached before n +can be read. Use the IncompleteReadError.partial +attribute to get the partially read data.

    +
    + +
    +
    +coroutine readuntil(separator=b'\n')
    +

    Read data from the stream until separator is found.

    +

    On success, the data and separator will be removed from the +internal buffer (consumed). Returned data will include the +separator at the end.

    +

    If the amount of data read exceeds the configured stream limit, a +LimitOverrunError exception is raised, and the data +is left in the internal buffer and can be read again.

    +

    If EOF is reached before the complete separator is found, +an IncompleteReadError exception is raised, and the internal +buffer is reset. The IncompleteReadError.partial attribute +may contain a portion of the separator.

    +
    +

    New in version 3.5.2.

    +
    +
    + +
    +
    +at_eof()
    +

    Return True if the buffer is empty and feed_eof() +was called.

    +
    + +
    + +
    +
    +

    StreamWriter

    +
    +
    +class asyncio.StreamWriter
    +

    Represents a writer object that provides APIs to write data +to the IO stream.

    +

    It is not recommended to instantiate StreamWriter objects +directly; use open_connection() and start_server() +instead.

    +
    +
    +can_write_eof()
    +

    Return True if the underlying transport supports +the write_eof() method, False otherwise.

    +
    + +
    +
    +write_eof()
    +

    Close the write end of the stream after the buffered write +data is flushed.

    +
    + +
    +
    +transport
    +

    Return the underlying asyncio transport.

    +
    + +
    +
    +get_extra_info(name, default=None)
    +

    Access optional transport information; see +BaseTransport.get_extra_info() for details.

    +
    + +
    +
    +write(data)
    +

    Write data to the stream.

    +

    This method is not subject to flow control. Calls to write() should +be followed by drain().

    +
    + +
    +
    +writelines(data)
    +

    Write a list (or any iterable) of bytes to the stream.

    +

    This method is not subject to flow control. Calls to writelines() +should be followed by drain().

    +
    + +
    +
    +coroutine drain()
    +

    Wait until it is appropriate to resume writing to the stream. +Example:

    +
    writer.write(data)
    +await writer.drain()
    +
    +
    +

    This is a flow control method that interacts with the underlying +IO write buffer. When the size of the buffer reaches +the high watermark, drain() blocks until the size of the +buffer is drained down to the low watermark and writing can +be resumed. When there is nothing to wait for, the drain() +returns immediately.

    +
    + +
    +
    +close()
    +

    Close the stream.

    +
    + +
    +
    +is_closing()
    +

    Return True if the stream is closed or in the process of +being closed.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +coroutine wait_closed()
    +

    Wait until the stream is closed.

    +

    Should be called after close() to wait until the underlying +connection is closed.

    +
    +

    New in version 3.7.

    +
    +
    + +
    + +
    +
    +

    Examples

    +
    +

    TCP echo client using streams

    +

    TCP echo client using the asyncio.open_connection() function:

    +
    import asyncio
    +
    +async def tcp_echo_client(message):
    +    reader, writer = await asyncio.open_connection(
    +        '127.0.0.1', 8888)
    +
    +    print(f'Send: {message!r}')
    +    writer.write(message.encode())
    +
    +    data = await reader.read(100)
    +    print(f'Received: {data.decode()!r}')
    +
    +    print('Close the connection')
    +    writer.close()
    +
    +asyncio.run(tcp_echo_client('Hello World!'))
    +
    +
    +
    +

    See also

    +

    The TCP echo client protocol +example uses the low-level loop.create_connection() method.

    +
    +
    +
    +

    TCP echo server using streams

    +

    TCP echo server using the asyncio.start_server() function:

    +
    import asyncio
    +
    +async def handle_echo(reader, writer):
    +    data = await reader.read(100)
    +    message = data.decode()
    +    addr = writer.get_extra_info('peername')
    +
    +    print(f"Received {message!r} from {addr!r}")
    +
    +    print(f"Send: {message!r}")
    +    writer.write(data)
    +    await writer.drain()
    +
    +    print("Close the connection")
    +    writer.close()
    +
    +async def main():
    +    server = await asyncio.start_server(
    +        handle_echo, '127.0.0.1', 8888)
    +
    +    addr = server.sockets[0].getsockname()
    +    print(f'Serving on {addr}')
    +
    +    async with server:
    +        await server.serve_forever()
    +
    +asyncio.run(main())
    +
    +
    +
    +

    See also

    +

    The TCP echo server protocol +example uses the loop.create_server() method.

    +
    +
    +
    +

    Get HTTP headers

    +

    Simple example querying HTTP headers of the URL passed on the command line:

    +
    import asyncio
    +import urllib.parse
    +import sys
    +
    +async def print_http_headers(url):
    +    url = urllib.parse.urlsplit(url)
    +    if url.scheme == 'https':
    +        reader, writer = await asyncio.open_connection(
    +            url.hostname, 443, ssl=True)
    +    else:
    +        reader, writer = await asyncio.open_connection(
    +            url.hostname, 80)
    +
    +    query = (
    +        f"HEAD {url.path or '/'} HTTP/1.0\r\n"
    +        f"Host: {url.hostname}\r\n"
    +        f"\r\n"
    +    )
    +
    +    writer.write(query.encode('latin-1'))
    +    while True:
    +        line = await reader.readline()
    +        if not line:
    +            break
    +
    +        line = line.decode('latin1').rstrip()
    +        if line:
    +            print(f'HTTP header> {line}')
    +
    +    # Ignore the body, close the socket
    +    writer.close()
    +
    +url = sys.argv[1]
    +asyncio.run(print_http_headers(url))
    +
    +
    +

    Usage:

    +
    python example.py http://example.com/path/page.html
    +
    +
    +

    or with HTTPS:

    +
    python example.py https://example.com/path/page.html
    +
    +
    +
    +
    +

    Register an open socket to wait for data using streams

    +

    Coroutine waiting until a socket receives data using the +open_connection() function:

    +
    import asyncio
    +import socket
    +
    +async def wait_for_data():
    +    # Get a reference to the current event loop because
    +    # we want to access low-level APIs.
    +    loop = asyncio.get_running_loop()
    +
    +    # Create a pair of connected sockets.
    +    rsock, wsock = socket.socketpair()
    +
    +    # Register the open socket to wait for data.
    +    reader, writer = await asyncio.open_connection(sock=rsock)
    +
    +    # Simulate the reception of data from the network
    +    loop.call_soon(wsock.send, 'abc'.encode())
    +
    +    # Wait for data
    +    data = await reader.read(100)
    +
    +    # Got data, we are done: close the socket
    +    print("Received:", data.decode())
    +    writer.close()
    +
    +    # Close the second socket
    +    wsock.close()
    +
    +asyncio.run(wait_for_data())
    +
    +
    +
    +

    See also

    +

    The register an open socket to wait for data using a protocol example uses a low-level protocol and +the loop.create_connection() method.

    +

    The watch a file descriptor for read events example uses the low-level +loop.add_reader() method to watch a file descriptor.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/asyncio-subprocess.html b/python-3.7.4-docs-html/library/asyncio-subprocess.html new file mode 100644 index 0000000..f8ec016 --- /dev/null +++ b/python-3.7.4-docs-html/library/asyncio-subprocess.html @@ -0,0 +1,530 @@ + + + + + + + Subprocesses — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Subprocesses

    +

    This section describes high-level async/await asyncio APIs to +create and manage subprocesses.

    +

    Here’s an example of how asyncio can run a shell command and +obtain its result:

    +
    import asyncio
    +
    +async def run(cmd):
    +    proc = await asyncio.create_subprocess_shell(
    +        cmd,
    +        stdout=asyncio.subprocess.PIPE,
    +        stderr=asyncio.subprocess.PIPE)
    +
    +    stdout, stderr = await proc.communicate()
    +
    +    print(f'[{cmd!r} exited with {proc.returncode}]')
    +    if stdout:
    +        print(f'[stdout]\n{stdout.decode()}')
    +    if stderr:
    +        print(f'[stderr]\n{stderr.decode()}')
    +
    +asyncio.run(run('ls /zzz'))
    +
    +
    +

    will print:

    +
    ['ls /zzz' exited with 1]
    +[stderr]
    +ls: /zzz: No such file or directory
    +
    +
    +

    Because all asyncio subprocess functions are asynchronous and asyncio +provides many tools to work with such functions, it is easy to execute +and monitor multiple subprocesses in parallel. It is indeed trivial +to modify the above example to run several commands simultaneously:

    +
    async def main():
    +    await asyncio.gather(
    +        run('ls /zzz'),
    +        run('sleep 1; echo "hello"'))
    +
    +asyncio.run(main())
    +
    +
    +

    See also the Examples subsection.

    +
    +

    Creating Subprocesses

    +
    +
    +coroutine asyncio.create_subprocess_exec(program, *args, stdin=None, stdout=None, stderr=None, loop=None, limit=None, **kwds)
    +

    Create a subprocess.

    +

    The limit argument sets the buffer limit for StreamReader +wrappers for Process.stdout and Process.stderr +(if subprocess.PIPE is passed to stdout and stderr arguments).

    +

    Return a Process instance.

    +

    See the documentation of loop.subprocess_exec() for other +parameters.

    +
    + +
    +
    +coroutine asyncio.create_subprocess_shell(cmd, stdin=None, stdout=None, stderr=None, loop=None, limit=None, **kwds)
    +

    Run the cmd shell command.

    +

    The limit argument sets the buffer limit for StreamReader +wrappers for Process.stdout and Process.stderr +(if subprocess.PIPE is passed to stdout and stderr arguments).

    +

    Return a Process instance.

    +

    See the documentation of loop.subprocess_shell() for other +parameters.

    +
    + +
    +

    Important

    +

    It is the application’s responsibility to ensure that all whitespace and +special characters are quoted appropriately to avoid shell injection +vulnerabilities. The shlex.quote() function can be used to properly +escape whitespace and special shell characters in strings that are going +to be used to construct shell commands.

    +
    +
    +

    Note

    +

    The default asyncio event loop implementation on Windows does not +support subprocesses. Subprocesses are available for Windows if a +ProactorEventLoop is used. +See Subprocess Support on Windows +for details.

    +
    +
    +

    See also

    +

    asyncio also has the following low-level APIs to work with subprocesses: +loop.subprocess_exec(), loop.subprocess_shell(), +loop.connect_read_pipe(), loop.connect_write_pipe(), +as well as the Subprocess Transports +and Subprocess Protocols.

    +
    +
    +
    +

    Constants

    +
    +
    +asyncio.subprocess.PIPE
    +

    Can be passed to the stdin, stdout or stderr parameters.

    +

    If PIPE is passed to stdin argument, the +Process.stdin attribute +will point to a StreamWriter instance.

    +

    If PIPE is passed to stdout or stderr arguments, the +Process.stdout and +Process.stderr +attributes will point to StreamReader instances.

    +
    + +
    +
    +asyncio.subprocess.STDOUT
    +

    Special value that can be used as the stderr argument and indicates +that standard error should be redirected into standard output.

    +
    + +
    +
    +asyncio.subprocess.DEVNULL
    +

    Special value that can be used as the stdin, stdout or stderr argument +to process creation functions. It indicates that the special file +os.devnull will be used for the corresponding subprocess stream.

    +
    + +
    +
    +

    Interacting with Subprocesses

    +

    Both create_subprocess_exec() and create_subprocess_shell() +functions return instances of the Process class. Process is a high-level +wrapper that allows communicating with subprocesses and watching for +their completion.

    +
    +
    +class asyncio.subprocess.Process
    +

    An object that wraps OS processes created by the +create_subprocess_exec() and create_subprocess_shell() +functions.

    +

    This class is designed to have a similar API to the +subprocess.Popen class, but there are some +notable differences:

    +
      +
    • unlike Popen, Process instances do not have an equivalent to +the poll() method;

    • +
    • the communicate() and +wait() methods don’t have a +timeout parameter: use the wait_for() function;

    • +
    • the Process.wait() method +is asynchronous, whereas subprocess.Popen.wait() method +is implemented as a blocking busy loop;

    • +
    • the universal_newlines parameter is not supported.

    • +
    +

    This class is not thread safe.

    +

    See also the Subprocess and Threads +section.

    +
    +
    +coroutine wait()
    +

    Wait for the child process to terminate.

    +

    Set and return the returncode attribute.

    +
    +

    Note

    +

    This method can deadlock when using stdout=PIPE or +stderr=PIPE and the child process generates so much output +that it blocks waiting for the OS pipe buffer to accept +more data. Use the communicate() method when using pipes +to avoid this condition.

    +
    +
    + +
    +
    +coroutine communicate(input=None)
    +

    Interact with process:

    +
      +
    1. send data to stdin (if input is not None);

    2. +
    3. read data from stdout and stderr, until EOF is reached;

    4. +
    5. wait for process to terminate.

    6. +
    +

    The optional input argument is the data (bytes object) +that will be sent to the child process.

    +

    Return a tuple (stdout_data, stderr_data).

    +

    If either BrokenPipeError or ConnectionResetError +exception is raised when writing input into stdin, the +exception is ignored. This condition occurs when the process +exits before all data are written into stdin.

    +

    If it is desired to send data to the process’ stdin, +the process needs to be created with stdin=PIPE. Similarly, +to get anything other than None in the result tuple, the +process has to be created with stdout=PIPE and/or +stderr=PIPE arguments.

    +

    Note, that the data read is buffered in memory, so do not use +this method if the data size is large or unlimited.

    +
    + +
    +
    +send_signal(signal)
    +

    Sends the signal signal to the child process.

    +
    +

    Note

    +

    On Windows, SIGTERM is an alias for terminate(). +CTRL_C_EVENT and CTRL_BREAK_EVENT can be sent to processes +started with a creationflags parameter which includes +CREATE_NEW_PROCESS_GROUP.

    +
    +
    + +
    +
    +terminate()
    +

    Stop the child process.

    +

    On POSIX systems this method sends signal.SIGTERM to the +child process.

    +

    On Windows the Win32 API function TerminateProcess() is +called to stop the child process.

    +
    + +
    +
    +kill()
    +

    Kill the child.

    +

    On POSIX systems this method sends SIGKILL to the child +process.

    +

    On Windows this method is an alias for terminate().

    +
    + +
    +
    +stdin
    +

    Standard input stream (StreamWriter) or None +if the process was created with stdin=None.

    +
    + +
    +
    +stdout
    +

    Standard output stream (StreamReader) or None +if the process was created with stdout=None.

    +
    + +
    +
    +stderr
    +

    Standard error stream (StreamReader) or None +if the process was created with stderr=None.

    +
    + +
    +

    Warning

    +

    Use the communicate() method rather than +process.stdin.write(), +await process.stdout.read() or +await process.stderr.read. +This avoids deadlocks due to streams pausing reading or writing +and blocking the child process.

    +
    +
    +
    +pid
    +

    Process identification number (PID).

    +

    Note that for processes created by the create_subprocess_shell() +function, this attribute is the PID of the spawned shell.

    +
    + +
    +
    +returncode
    +

    Return code of the process when it exits.

    +

    A None value indicates that the process has not terminated yet.

    +

    A negative value -N indicates that the child was terminated +by signal N (POSIX only).

    +
    + +
    + +
    +

    Subprocess and Threads

    +

    Standard asyncio event loop supports running subprocesses from +different threads, but there are limitations:

    +
      +
    • An event loop must run in the main thread.

    • +
    • The child watcher must be instantiated in the main thread +before executing subprocesses from other threads. Call the +get_child_watcher() function in the main thread to instantiate +the child watcher.

    • +
    +

    Note that alternative event loop implementations might not share +the above limitations; please refer to their documentation.

    + +
    +
    +

    Examples

    +

    An example using the Process class to +control a subprocess and the StreamReader class to read from +its standard output.

    +

    The subprocess is created by the create_subprocess_exec() +function:

    +
    import asyncio
    +import sys
    +
    +async def get_date():
    +    code = 'import datetime; print(datetime.datetime.now())'
    +
    +    # Create the subprocess; redirect the standard output
    +    # into a pipe.
    +    proc = await asyncio.create_subprocess_exec(
    +        sys.executable, '-c', code,
    +        stdout=asyncio.subprocess.PIPE)
    +
    +    # Read one line of output.
    +    data = await proc.stdout.readline()
    +    line = data.decode('ascii').rstrip()
    +
    +    # Wait for the subprocess exit.
    +    await proc.wait()
    +    return line
    +
    +if sys.platform == "win32":
    +    asyncio.set_event_loop_policy(
    +        asyncio.WindowsProactorEventLoopPolicy())
    +
    +date = asyncio.run(get_date())
    +print(f"Current date: {date}")
    +
    +
    +

    See also the same example +written using low-level APIs.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/asyncio-sync.html b/python-3.7.4-docs-html/library/asyncio-sync.html new file mode 100644 index 0000000..30b9dbe --- /dev/null +++ b/python-3.7.4-docs-html/library/asyncio-sync.html @@ -0,0 +1,525 @@ + + + + + + + Synchronization Primitives — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Synchronization Primitives

    +

    asyncio synchronization primitives are designed to be similar to +those of the threading module with two important caveats:

    +
      +
    • asyncio primitives are not thread-safe, therefore they should not +be used for OS thread synchronization (use threading for +that);

    • +
    • methods of these synchronization primitives do not accept the timeout +argument; use the asyncio.wait_for() function to perform +operations with timeouts.

    • +
    +

    asyncio has the following basic synchronization primitives:

    + +
    +
    +

    Lock

    +
    +
    +class asyncio.Lock(*, loop=None)
    +

    Implements a mutex lock for asyncio tasks. Not thread-safe.

    +

    An asyncio lock can be used to guarantee exclusive access to a +shared resource.

    +

    The preferred way to use a Lock is an async with +statement:

    +
    lock = asyncio.Lock()
    +
    +# ... later
    +async with lock:
    +    # access shared state
    +
    +
    +

    which is equivalent to:

    +
    lock = asyncio.Lock()
    +
    +# ... later
    +await lock.acquire()
    +try:
    +    # access shared state
    +finally:
    +    lock.release()
    +
    +
    +
    +
    +coroutine acquire()
    +

    Acquire the lock.

    +

    This method waits until the lock is unlocked, sets it to +locked and returns True.

    +

    When more than one coroutine is blocked in acquire() +waiting for the lock to be unlocked, only one coroutine +eventually proceeds.

    +

    Acquiring a lock is fair: the coroutine that proceeds will be +the first coroutine that started waiting on the lock.

    +
    + +
    +
    +release()
    +

    Release the lock.

    +

    When the lock is locked, reset it to unlocked and return.

    +

    If the lock is unlocked, a RuntimeError is raised.

    +
    + +
    +
    +locked()
    +

    Return True if the lock is locked.

    +
    + +
    + +
    +
    +

    Event

    +
    +
    +class asyncio.Event(*, loop=None)
    +

    An event object. Not thread-safe.

    +

    An asyncio event can be used to notify multiple asyncio tasks +that some event has happened.

    +

    An Event object manages an internal flag that can be set to true +with the set() method and reset to false with the +clear() method. The wait() method blocks until the +flag is set to true. The flag is set to false initially.

    +

    Example:

    +
    async def waiter(event):
    +    print('waiting for it ...')
    +    await event.wait()
    +    print('... got it!')
    +
    +async def main():
    +    # Create an Event object.
    +    event = asyncio.Event()
    +
    +    # Spawn a Task to wait until 'event' is set.
    +    waiter_task = asyncio.create_task(waiter(event))
    +
    +    # Sleep for 1 second and set the event.
    +    await asyncio.sleep(1)
    +    event.set()
    +
    +    # Wait until the waiter task is finished.
    +    await waiter_task
    +
    +asyncio.run(main())
    +
    +
    +
    +
    +coroutine wait()
    +

    Wait until the event is set.

    +

    If the event is set, return True immediately. +Otherwise block until another task calls set().

    +
    + +
    +
    +set()
    +

    Set the event.

    +

    All tasks waiting for event to be set will be immediately +awakened.

    +
    + +
    +
    +clear()
    +

    Clear (unset) the event.

    +

    Tasks awaiting on wait() will now block until the +set() method is called again.

    +
    + +
    +
    +is_set()
    +

    Return True if the event is set.

    +
    + +
    + +
    +
    +

    Condition

    +
    +
    +class asyncio.Condition(lock=None, *, loop=None)
    +

    A Condition object. Not thread-safe.

    +

    An asyncio condition primitive can be used by a task to wait for +some event to happen and then get exclusive access to a shared +resource.

    +

    In essence, a Condition object combines the functionality +of an Event and a Lock. It is possible to have +multiple Condition objects share one Lock, which allows coordinating +exclusive access to a shared resource between different tasks +interested in particular states of that shared resource.

    +

    The optional lock argument must be a Lock object or +None. In the latter case a new Lock object is created +automatically.

    +

    The preferred way to use a Condition is an async with +statement:

    +
    cond = asyncio.Condition()
    +
    +# ... later
    +async with cond:
    +    await cond.wait()
    +
    +
    +

    which is equivalent to:

    +
    cond = asyncio.Condition()
    +
    +# ... later
    +await lock.acquire()
    +try:
    +    await cond.wait()
    +finally:
    +    lock.release()
    +
    +
    +
    +
    +coroutine acquire()
    +

    Acquire the underlying lock.

    +

    This method waits until the underlying lock is unlocked, +sets it to locked and returns True.

    +
    + +
    +
    +notify(n=1)
    +

    Wake up at most n tasks (1 by default) waiting on this +condition. The method is no-op if no tasks are waiting.

    +

    The lock must be acquired before this method is called and +released shortly after. If called with an unlocked lock +a RuntimeError error is raised.

    +
    + +
    +
    +locked()
    +

    Return True if the underlying lock is acquired.

    +
    + +
    +
    +notify_all()
    +

    Wake up all tasks waiting on this condition.

    +

    This method acts like notify(), but wakes up all waiting +tasks.

    +

    The lock must be acquired before this method is called and +released shortly after. If called with an unlocked lock +a RuntimeError error is raised.

    +
    + +
    +
    +release()
    +

    Release the underlying lock.

    +

    When invoked on an unlocked lock, a RuntimeError is +raised.

    +
    + +
    +
    +coroutine wait()
    +

    Wait until notified.

    +

    If the calling task has not acquired the lock when this method is +called, a RuntimeError is raised.

    +

    This method releases the underlying lock, and then blocks until +it is awakened by a notify() or notify_all() call. +Once awakened, the Condition re-acquires its lock and this method +returns True.

    +
    + +
    +
    +coroutine wait_for(predicate)
    +

    Wait until a predicate becomes true.

    +

    The predicate must be a callable which result will be +interpreted as a boolean value. The final value is the +return value.

    +
    + +
    + +
    +
    +

    Semaphore

    +
    +
    +class asyncio.Semaphore(value=1, *, loop=None)
    +

    A Semaphore object. Not thread-safe.

    +

    A semaphore manages an internal counter which is decremented by each +acquire() call and incremented by each release() call. +The counter can never go below zero; when acquire() finds +that it is zero, it blocks, waiting until some task calls +release().

    +

    The optional value argument gives the initial value for the +internal counter (1 by default). If the given value is +less than 0 a ValueError is raised.

    +

    The preferred way to use a Semaphore is an async with +statement:

    +
    sem = asyncio.Semaphore(10)
    +
    +# ... later
    +async with sem:
    +    # work with shared resource
    +
    +
    +

    which is equivalent to:

    +
    sem = asyncio.Semaphore(10)
    +
    +# ... later
    +await sem.acquire()
    +try:
    +    # work with shared resource
    +finally:
    +    sem.release()
    +
    +
    +
    +
    +coroutine acquire()
    +

    Acquire a semaphore.

    +

    If the internal counter is greater than zero, decrement +it by one and return True immediately. If it is zero, wait +until a release() is called and return True.

    +
    + +
    +
    +locked()
    +

    Returns True if semaphore can not be acquired immediately.

    +
    + +
    +
    +release()
    +

    Release a semaphore, incrementing the internal counter by one. +Can wake up a task waiting to acquire the semaphore.

    +

    Unlike BoundedSemaphore, Semaphore allows +making more release() calls than acquire() calls.

    +
    + +
    + +
    +
    +

    BoundedSemaphore

    +
    +
    +class asyncio.BoundedSemaphore(value=1, *, loop=None)
    +

    A bounded semaphore object. Not thread-safe.

    +

    Bounded Semaphore is a version of Semaphore that raises +a ValueError in release() if it +increases the internal counter above the initial value.

    +
    + +
    +
    +

    Deprecated since version 3.7: Acquiring a lock using await lock or yield from lock and/or +with statement (with await lock, with (yield from +lock)) is deprecated. Use async with lock instead.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/asyncio-task.html b/python-3.7.4-docs-html/library/asyncio-task.html new file mode 100644 index 0000000..7a05869 --- /dev/null +++ b/python-3.7.4-docs-html/library/asyncio-task.html @@ -0,0 +1,1062 @@ + + + + + + + Coroutines and Tasks — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Coroutines and Tasks

    +

    This section outlines high-level asyncio APIs to work with coroutines +and Tasks.

    + +
    +

    Coroutines

    +

    Coroutines declared with async/await syntax is the preferred way of +writing asyncio applications. For example, the following snippet +of code (requires Python 3.7+) prints “hello”, waits 1 second, +and then prints “world”:

    +
    >>> import asyncio
    +
    +>>> async def main():
    +...     print('hello')
    +...     await asyncio.sleep(1)
    +...     print('world')
    +
    +>>> asyncio.run(main())
    +hello
    +world
    +
    +
    +

    Note that simply calling a coroutine will not schedule it to +be executed:

    +
    >>> main()
    +<coroutine object main at 0x1053bb7c8>
    +
    +
    +

    To actually run a coroutine, asyncio provides three main mechanisms:

    +
      +
    • The asyncio.run() function to run the top-level +entry point “main()” function (see the above example.)

    • +
    • Awaiting on a coroutine. The following snippet of code will +print “hello” after waiting for 1 second, and then print “world” +after waiting for another 2 seconds:

      +
      import asyncio
      +import time
      +
      +async def say_after(delay, what):
      +    await asyncio.sleep(delay)
      +    print(what)
      +
      +async def main():
      +    print(f"started at {time.strftime('%X')}")
      +
      +    await say_after(1, 'hello')
      +    await say_after(2, 'world')
      +
      +    print(f"finished at {time.strftime('%X')}")
      +
      +asyncio.run(main())
      +
      +
      +

      Expected output:

      +
      started at 17:13:52
      +hello
      +world
      +finished at 17:13:55
      +
      +
      +
    • +
    • The asyncio.create_task() function to run coroutines +concurrently as asyncio Tasks.

      +

      Let’s modify the above example and run two say_after coroutines +concurrently:

      +
      async def main():
      +    task1 = asyncio.create_task(
      +        say_after(1, 'hello'))
      +
      +    task2 = asyncio.create_task(
      +        say_after(2, 'world'))
      +
      +    print(f"started at {time.strftime('%X')}")
      +
      +    # Wait until both tasks are completed (should take
      +    # around 2 seconds.)
      +    await task1
      +    await task2
      +
      +    print(f"finished at {time.strftime('%X')}")
      +
      +
      +

      Note that expected output now shows that the snippet runs +1 second faster than before:

      +
      started at 17:14:32
      +hello
      +world
      +finished at 17:14:34
      +
      +
      +
    • +
    +
    +
    +

    Awaitables

    +

    We say that an object is an awaitable object if it can be used +in an await expression. Many asyncio APIs are designed to +accept awaitables.

    +

    There are three main types of awaitable objects: +coroutines, Tasks, and Futures.

    +

    Coroutines

    +

    Python coroutines are awaitables and therefore can be awaited from +other coroutines:

    +
    import asyncio
    +
    +async def nested():
    +    return 42
    +
    +async def main():
    +    # Nothing happens if we just call "nested()".
    +    # A coroutine object is created but not awaited,
    +    # so it *won't run at all*.
    +    nested()
    +
    +    # Let's do it differently now and await it:
    +    print(await nested())  # will print "42".
    +
    +asyncio.run(main())
    +
    +
    +
    +

    Important

    +

    In this documentation the term “coroutine” can be used for +two closely related concepts:

    +
      +
    • a coroutine function: an async def function;

    • +
    • a coroutine object: an object returned by calling a +coroutine function.

    • +
    +
    +

    asyncio also supports legacy generator-based coroutines.

    +

    Tasks

    +

    Tasks are used to schedule coroutines concurrently.

    +

    When a coroutine is wrapped into a Task with functions like +asyncio.create_task() the coroutine is automatically +scheduled to run soon:

    +
    import asyncio
    +
    +async def nested():
    +    return 42
    +
    +async def main():
    +    # Schedule nested() to run soon concurrently
    +    # with "main()".
    +    task = asyncio.create_task(nested())
    +
    +    # "task" can now be used to cancel "nested()", or
    +    # can simply be awaited to wait until it is complete:
    +    await task
    +
    +asyncio.run(main())
    +
    +
    +

    Futures

    +

    A Future is a special low-level awaitable object that +represents an eventual result of an asynchronous operation.

    +

    When a Future object is awaited it means that the coroutine will +wait until the Future is resolved in some other place.

    +

    Future objects in asyncio are needed to allow callback-based code +to be used with async/await.

    +

    Normally there is no need to create Future objects at the +application level code.

    +

    Future objects, sometimes exposed by libraries and some asyncio +APIs, can be awaited:

    +
    async def main():
    +    await function_that_returns_a_future_object()
    +
    +    # this is also valid:
    +    await asyncio.gather(
    +        function_that_returns_a_future_object(),
    +        some_python_coroutine()
    +    )
    +
    +
    +

    A good example of a low-level function that returns a Future object +is loop.run_in_executor().

    +
    +
    +

    Running an asyncio Program

    +
    +
    +asyncio.run(coro, *, debug=False)
    +

    This function runs the passed coroutine, taking care of +managing the asyncio event loop and finalizing asynchronous +generators.

    +

    This function cannot be called when another asyncio event loop is +running in the same thread.

    +

    If debug is True, the event loop will be run in debug mode.

    +

    This function always creates a new event loop and closes it at +the end. It should be used as a main entry point for asyncio +programs, and should ideally only be called once.

    +
    +

    New in version 3.7: Important: this function has been added to asyncio in +Python 3.7 on a provisional basis.

    +
    +
    + +
    +
    +

    Creating Tasks

    +
    +
    +asyncio.create_task(coro)
    +

    Wrap the coro coroutine into a Task +and schedule its execution. Return the Task object.

    +

    The task is executed in the loop returned by get_running_loop(), +RuntimeError is raised if there is no running loop in +current thread.

    +

    This function has been added in Python 3.7. Prior to +Python 3.7, the low-level asyncio.ensure_future() function +can be used instead:

    +
    async def coro():
    +    ...
    +
    +# In Python 3.7+
    +task = asyncio.create_task(coro())
    +...
    +
    +# This works in all Python versions but is less readable
    +task = asyncio.ensure_future(coro())
    +...
    +
    +
    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +

    Sleeping

    +
    +
    +coroutine asyncio.sleep(delay, result=None, *, loop=None)
    +

    Block for delay seconds.

    +

    If result is provided, it is returned to the caller +when the coroutine completes.

    +

    sleep() always suspends the current task, allowing other tasks +to run.

    +

    The loop argument is deprecated and scheduled for removal +in Python 3.10.

    +

    Example of coroutine displaying the current date every second +for 5 seconds:

    +
    import asyncio
    +import datetime
    +
    +async def display_date():
    +    loop = asyncio.get_running_loop()
    +    end_time = loop.time() + 5.0
    +    while True:
    +        print(datetime.datetime.now())
    +        if (loop.time() + 1.0) >= end_time:
    +            break
    +        await asyncio.sleep(1)
    +
    +asyncio.run(display_date())
    +
    +
    +
    + +
    +
    +

    Running Tasks Concurrently

    +
    +
    +awaitable asyncio.gather(*aws, loop=None, return_exceptions=False)
    +

    Run awaitable objects in the aws +sequence concurrently.

    +

    If any awaitable in aws is a coroutine, it is automatically +scheduled as a Task.

    +

    If all awaitables are completed successfully, the result is an +aggregate list of returned values. The order of result values +corresponds to the order of awaitables in aws.

    +

    If return_exceptions is False (default), the first +raised exception is immediately propagated to the task that +awaits on gather(). Other awaitables in the aws sequence +won’t be cancelled and will continue to run.

    +

    If return_exceptions is True, exceptions are treated the +same as successful results, and aggregated in the result list.

    +

    If gather() is cancelled, all submitted awaitables +(that have not completed yet) are also cancelled.

    +

    If any Task or Future from the aws sequence is cancelled, it is +treated as if it raised CancelledError – the gather() +call is not cancelled in this case. This is to prevent the +cancellation of one submitted Task/Future to cause other +Tasks/Futures to be cancelled.

    +

    Example:

    +
    import asyncio
    +
    +async def factorial(name, number):
    +    f = 1
    +    for i in range(2, number + 1):
    +        print(f"Task {name}: Compute factorial({i})...")
    +        await asyncio.sleep(1)
    +        f *= i
    +    print(f"Task {name}: factorial({number}) = {f}")
    +
    +async def main():
    +    # Schedule three calls *concurrently*:
    +    await asyncio.gather(
    +        factorial("A", 2),
    +        factorial("B", 3),
    +        factorial("C", 4),
    +    )
    +
    +asyncio.run(main())
    +
    +# Expected output:
    +#
    +#     Task A: Compute factorial(2)...
    +#     Task B: Compute factorial(2)...
    +#     Task C: Compute factorial(2)...
    +#     Task A: factorial(2) = 2
    +#     Task B: Compute factorial(3)...
    +#     Task C: Compute factorial(3)...
    +#     Task B: factorial(3) = 6
    +#     Task C: Compute factorial(4)...
    +#     Task C: factorial(4) = 24
    +
    +
    +
    +

    Changed in version 3.7: If the gather itself is cancelled, the cancellation is +propagated regardless of return_exceptions.

    +
    +
    + +
    +
    +

    Shielding From Cancellation

    +
    +
    +awaitable asyncio.shield(aw, *, loop=None)
    +

    Protect an awaitable object +from being cancelled.

    +

    If aw is a coroutine it is automatically scheduled as a Task.

    +

    The statement:

    +
    res = await shield(something())
    +
    +
    +

    is equivalent to:

    +
    res = await something()
    +
    +
    +

    except that if the coroutine containing it is cancelled, the +Task running in something() is not cancelled. From the point +of view of something(), the cancellation did not happen. +Although its caller is still cancelled, so the “await” expression +still raises a CancelledError.

    +

    If something() is cancelled by other means (i.e. from within +itself) that would also cancel shield().

    +

    If it is desired to completely ignore cancellation (not recommended) +the shield() function should be combined with a try/except +clause, as follows:

    +
    try:
    +    res = await shield(something())
    +except CancelledError:
    +    res = None
    +
    +
    +
    + +
    +
    +

    Timeouts

    +
    +
    +coroutine asyncio.wait_for(aw, timeout, *, loop=None)
    +

    Wait for the aw awaitable +to complete with a timeout.

    +

    If aw is a coroutine it is automatically scheduled as a Task.

    +

    timeout can either be None or a float or int number of seconds +to wait for. If timeout is None, block until the future +completes.

    +

    If a timeout occurs, it cancels the task and raises +asyncio.TimeoutError.

    +

    To avoid the task cancellation, +wrap it in shield().

    +

    The function will wait until the future is actually cancelled, +so the total wait time may exceed the timeout.

    +

    If the wait is cancelled, the future aw is also cancelled.

    +

    The loop argument is deprecated and scheduled for removal +in Python 3.10.

    +

    Example:

    +
    async def eternity():
    +    # Sleep for one hour
    +    await asyncio.sleep(3600)
    +    print('yay!')
    +
    +async def main():
    +    # Wait for at most 1 second
    +    try:
    +        await asyncio.wait_for(eternity(), timeout=1.0)
    +    except asyncio.TimeoutError:
    +        print('timeout!')
    +
    +asyncio.run(main())
    +
    +# Expected output:
    +#
    +#     timeout!
    +
    +
    +
    +

    Changed in version 3.7: When aw is cancelled due to a timeout, wait_for waits +for aw to be cancelled. Previously, it raised +asyncio.TimeoutError immediately.

    +
    +
    + +
    +
    +

    Waiting Primitives

    +
    +
    +coroutine asyncio.wait(aws, *, loop=None, timeout=None, return_when=ALL_COMPLETED)
    +

    Run awaitable objects in the aws +set concurrently and block until the condition specified +by return_when.

    +

    If any awaitable in aws is a coroutine, it is automatically +scheduled as a Task. Passing coroutines objects to +wait() directly is deprecated as it leads to +confusing behavior.

    +

    Returns two sets of Tasks/Futures: (done, pending).

    +

    Usage:

    +
    done, pending = await asyncio.wait(aws)
    +
    +
    +

    The loop argument is deprecated and scheduled for removal +in Python 3.10.

    +

    timeout (a float or int), if specified, can be used to control +the maximum number of seconds to wait before returning.

    +

    Note that this function does not raise asyncio.TimeoutError. +Futures or Tasks that aren’t done when the timeout occurs are simply +returned in the second set.

    +

    return_when indicates when this function should return. It must +be one of the following constants:

    + ++++ + + + + + + + + + + + + + + + + +

    Constant

    Description

    FIRST_COMPLETED

    The function will return when any +future finishes or is cancelled.

    FIRST_EXCEPTION

    The function will return when any +future finishes by raising an +exception. If no future raises an +exception then it is equivalent to +ALL_COMPLETED.

    ALL_COMPLETED

    The function will return when all +futures finish or are cancelled.

    +

    Unlike wait_for(), wait() does not cancel the +futures when a timeout occurs.

    +
    +

    Note

    +

    wait() schedules coroutines as Tasks automatically and later +returns those implicitly created Task objects in (done, pending) +sets. Therefore the following code won’t work as expected:

    +
    async def foo():
    +    return 42
    +
    +coro = foo()
    +done, pending = await asyncio.wait({coro})
    +
    +if coro in done:
    +    # This branch will never be run!
    +
    +
    +

    Here is how the above snippet can be fixed:

    +
    async def foo():
    +    return 42
    +
    +task = asyncio.create_task(foo())
    +done, pending = await asyncio.wait({task})
    +
    +if task in done:
    +    # Everything will work as expected now.
    +
    +
    +

    Passing coroutine objects to wait() directly is +deprecated.

    +
    +
    + +
    +
    +asyncio.as_completed(aws, *, loop=None, timeout=None)
    +

    Run awaitable objects in the aws +set concurrently. Return an iterator of Future objects. +Each Future object returned represents the earliest result +from the set of the remaining awaitables.

    +

    Raises asyncio.TimeoutError if the timeout occurs before +all Futures are done.

    +

    Example:

    +
    for f in as_completed(aws):
    +    earliest_result = await f
    +    # ...
    +
    +
    +
    + +
    +
    +

    Scheduling From Other Threads

    +
    +
    +asyncio.run_coroutine_threadsafe(coro, loop)
    +

    Submit a coroutine to the given event loop. Thread-safe.

    +

    Return a concurrent.futures.Future to wait for the result +from another OS thread.

    +

    This function is meant to be called from a different OS thread +than the one where the event loop is running. Example:

    +
    # Create a coroutine
    +coro = asyncio.sleep(1, result=3)
    +
    +# Submit the coroutine to a given loop
    +future = asyncio.run_coroutine_threadsafe(coro, loop)
    +
    +# Wait for the result with an optional timeout argument
    +assert future.result(timeout) == 3
    +
    +
    +

    If an exception is raised in the coroutine, the returned Future +will be notified. It can also be used to cancel the task in +the event loop:

    +
    try:
    +    result = future.result(timeout)
    +except asyncio.TimeoutError:
    +    print('The coroutine took too long, cancelling the task...')
    +    future.cancel()
    +except Exception as exc:
    +    print(f'The coroutine raised an exception: {exc!r}')
    +else:
    +    print(f'The coroutine returned: {result!r}')
    +
    +
    +

    See the concurrency and multithreading +section of the documentation.

    +

    Unlike other asyncio functions this function requires the loop +argument to be passed explicitly.

    +
    +

    New in version 3.5.1.

    +
    +
    + +
    +
    +

    Introspection

    +
    +
    +asyncio.current_task(loop=None)
    +

    Return the currently running Task instance, or None if +no task is running.

    +

    If loop is None get_running_loop() is used to get +the current loop.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +asyncio.all_tasks(loop=None)
    +

    Return a set of not yet finished Task objects run by +the loop.

    +

    If loop is None, get_running_loop() is used for getting +current loop.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +

    Task Object

    +
    +
    +class asyncio.Task(coro, *, loop=None)
    +

    A Future-like object that runs a Python +coroutine. Not thread-safe.

    +

    Tasks are used to run coroutines in event loops. +If a coroutine awaits on a Future, the Task suspends +the execution of the coroutine and waits for the completion +of the Future. When the Future is done, the execution of +the wrapped coroutine resumes.

    +

    Event loops use cooperative scheduling: an event loop runs +one Task at a time. While a Task awaits for the completion of a +Future, the event loop runs other Tasks, callbacks, or performs +IO operations.

    +

    Use the high-level asyncio.create_task() function to create +Tasks, or the low-level loop.create_task() or +ensure_future() functions. Manual instantiation of Tasks +is discouraged.

    +

    To cancel a running Task use the cancel() method. Calling it +will cause the Task to throw a CancelledError exception into +the wrapped coroutine. If a coroutine is awaiting on a Future +object during cancellation, the Future object will be cancelled.

    +

    cancelled() can be used to check if the Task was cancelled. +The method returns True if the wrapped coroutine did not +suppress the CancelledError exception and was actually +cancelled.

    +

    asyncio.Task inherits from Future all of its +APIs except Future.set_result() and +Future.set_exception().

    +

    Tasks support the contextvars module. When a Task +is created it copies the current context and later runs its +coroutine in the copied context.

    +
    +

    Changed in version 3.7: Added support for the contextvars module.

    +
    +
    +
    +cancel()
    +

    Request the Task to be cancelled.

    +

    This arranges for a CancelledError exception to be thrown +into the wrapped coroutine on the next cycle of the event loop.

    +

    The coroutine then has a chance to clean up or even deny the +request by suppressing the exception with a try … +… except CancelledErrorfinally block. +Therefore, unlike Future.cancel(), Task.cancel() does +not guarantee that the Task will be cancelled, although +suppressing cancellation completely is not common and is actively +discouraged.

    +

    The following example illustrates how coroutines can intercept +the cancellation request:

    +
    async def cancel_me():
    +    print('cancel_me(): before sleep')
    +
    +    try:
    +        # Wait for 1 hour
    +        await asyncio.sleep(3600)
    +    except asyncio.CancelledError:
    +        print('cancel_me(): cancel sleep')
    +        raise
    +    finally:
    +        print('cancel_me(): after sleep')
    +
    +async def main():
    +    # Create a "cancel_me" Task
    +    task = asyncio.create_task(cancel_me())
    +
    +    # Wait for 1 second
    +    await asyncio.sleep(1)
    +
    +    task.cancel()
    +    try:
    +        await task
    +    except asyncio.CancelledError:
    +        print("main(): cancel_me is cancelled now")
    +
    +asyncio.run(main())
    +
    +# Expected output:
    +#
    +#     cancel_me(): before sleep
    +#     cancel_me(): cancel sleep
    +#     cancel_me(): after sleep
    +#     main(): cancel_me is cancelled now
    +
    +
    +
    + +
    +
    +cancelled()
    +

    Return True if the Task is cancelled.

    +

    The Task is cancelled when the cancellation was requested with +cancel() and the wrapped coroutine propagated the +CancelledError exception thrown into it.

    +
    + +
    +
    +done()
    +

    Return True if the Task is done.

    +

    A Task is done when the wrapped coroutine either returned +a value, raised an exception, or the Task was cancelled.

    +
    + +
    +
    +result()
    +

    Return the result of the Task.

    +

    If the Task is done, the result of the wrapped coroutine +is returned (or if the coroutine raised an exception, that +exception is re-raised.)

    +

    If the Task has been cancelled, this method raises +a CancelledError exception.

    +

    If the Task’s result isn’t yet available, this method raises +a InvalidStateError exception.

    +
    + +
    +
    +exception()
    +

    Return the exception of the Task.

    +

    If the wrapped coroutine raised an exception that exception +is returned. If the wrapped coroutine returned normally +this method returns None.

    +

    If the Task has been cancelled, this method raises a +CancelledError exception.

    +

    If the Task isn’t done yet, this method raises an +InvalidStateError exception.

    +
    + +
    +
    +add_done_callback(callback, *, context=None)
    +

    Add a callback to be run when the Task is done.

    +

    This method should only be used in low-level callback-based code.

    +

    See the documentation of Future.add_done_callback() +for more details.

    +
    + +
    +
    +remove_done_callback(callback)
    +

    Remove callback from the callbacks list.

    +

    This method should only be used in low-level callback-based code.

    +

    See the documentation of Future.remove_done_callback() +for more details.

    +
    + +
    +
    +get_stack(*, limit=None)
    +

    Return the list of stack frames for this Task.

    +

    If the wrapped coroutine is not done, this returns the stack +where it is suspended. If the coroutine has completed +successfully or was cancelled, this returns an empty list. +If the coroutine was terminated by an exception, this returns +the list of traceback frames.

    +

    The frames are always ordered from oldest to newest.

    +

    Only one stack frame is returned for a suspended coroutine.

    +

    The optional limit argument sets the maximum number of frames +to return; by default all available frames are returned. +The ordering of the returned list differs depending on whether +a stack or a traceback is returned: the newest frames of a +stack are returned, but the oldest frames of a traceback are +returned. (This matches the behavior of the traceback module.)

    +
    + +
    +
    +print_stack(*, limit=None, file=None)
    +

    Print the stack or traceback for this Task.

    +

    This produces output similar to that of the traceback module +for the frames retrieved by get_stack().

    +

    The limit argument is passed to get_stack() directly.

    +

    The file argument is an I/O stream to which the output +is written; by default output is written to sys.stderr.

    +
    + +
    +
    +classmethod all_tasks(loop=None)
    +

    Return a set of all tasks for an event loop.

    +

    By default all tasks for the current event loop are returned. +If loop is None, the get_event_loop() function +is used to get the current loop.

    +

    This method is deprecated and will be removed in +Python 3.9. Use the asyncio.all_tasks() function instead.

    +
    + +
    +
    +classmethod current_task(loop=None)
    +

    Return the currently running task or None.

    +

    If loop is None, the get_event_loop() function +is used to get the current loop.

    +

    This method is deprecated and will be removed in +Python 3.9. Use the asyncio.current_task() function +instead.

    +
    + +
    + +
    +
    +

    Generator-based Coroutines

    +
    +

    Note

    +

    Support for generator-based coroutines is deprecated and +is scheduled for removal in Python 3.10.

    +
    +

    Generator-based coroutines predate async/await syntax. They are +Python generators that use yield from expressions to await +on Futures and other coroutines.

    +

    Generator-based coroutines should be decorated with +@asyncio.coroutine, although this is not +enforced.

    +
    +
    +@asyncio.coroutine
    +

    Decorator to mark generator-based coroutines.

    +

    This decorator enables legacy generator-based coroutines to be +compatible with async/await code:

    +
    @asyncio.coroutine
    +def old_style_coroutine():
    +    yield from asyncio.sleep(1)
    +
    +async def main():
    +    await old_style_coroutine()
    +
    +
    +

    This decorator is deprecated and is scheduled for removal in +Python 3.10.

    +

    This decorator should not be used for async def +coroutines.

    +
    + +
    +
    +asyncio.iscoroutine(obj)
    +

    Return True if obj is a coroutine object.

    +

    This method is different from inspect.iscoroutine() because +it returns True for generator-based coroutines.

    +
    + +
    +
    +asyncio.iscoroutinefunction(func)
    +

    Return True if func is a coroutine function.

    +

    This method is different from inspect.iscoroutinefunction() +because it returns True for generator-based coroutine functions +decorated with @coroutine.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/asyncio.html b/python-3.7.4-docs-html/library/asyncio.html new file mode 100644 index 0000000..8e1e8db --- /dev/null +++ b/python-3.7.4-docs-html/library/asyncio.html @@ -0,0 +1,256 @@ + + + + + + + asyncio — Asynchronous I/O — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    asyncio — Asynchronous I/O

    +
    + +

    asyncio is a library to write concurrent code using +the async/await syntax.

    +

    asyncio is used as a foundation for multiple Python asynchronous +frameworks that provide high-performance network and web-servers, +database connection libraries, distributed task queues, etc.

    +

    asyncio is often a perfect fit for IO-bound and high-level +structured network code.

    +

    asyncio provides a set of high-level APIs to:

    + +

    Additionally, there are low-level APIs for +library and framework developers to:

    + +

    Reference

    + + + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/asyncore.html b/python-3.7.4-docs-html/library/asyncore.html new file mode 100644 index 0000000..be2af8e --- /dev/null +++ b/python-3.7.4-docs-html/library/asyncore.html @@ -0,0 +1,560 @@ + + + + + + + asyncore — Asynchronous socket handler — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    asyncore — Asynchronous socket handler

    +

    Source code: Lib/asyncore.py

    +
    +

    Deprecated since version 3.6: Please use asyncio instead.

    +
    +
    +
    +

    Note

    +

    This module exists for backwards compatibility only. For new code we +recommend using asyncio.

    +
    +

    This module provides the basic infrastructure for writing asynchronous socket +service clients and servers.

    +

    There are only two ways to have a program on a single processor do “more than +one thing at a time.” Multi-threaded programming is the simplest and most +popular way to do it, but there is another very different technique, that lets +you have nearly all the advantages of multi-threading, without actually using +multiple threads. It’s really only practical if your program is largely I/O +bound. If your program is processor bound, then pre-emptive scheduled threads +are probably what you really need. Network servers are rarely processor +bound, however.

    +

    If your operating system supports the select() system call in its I/O +library (and nearly all do), then you can use it to juggle multiple +communication channels at once; doing other work while your I/O is taking +place in the “background.” Although this strategy can seem strange and +complex, especially at first, it is in many ways easier to understand and +control than multi-threaded programming. The asyncore module solves +many of the difficult problems for you, making the task of building +sophisticated high-performance network servers and clients a snap. For +“conversational” applications and protocols the companion asynchat +module is invaluable.

    +

    The basic idea behind both modules is to create one or more network +channels, instances of class asyncore.dispatcher and +asynchat.async_chat. Creating the channels adds them to a global +map, used by the loop() function if you do not provide it with your own +map.

    +

    Once the initial channel(s) is(are) created, calling the loop() function +activates channel service, which continues until the last channel (including +any that have been added to the map during asynchronous service) is closed.

    +
    +
    +asyncore.loop([timeout[, use_poll[, map[, count]]]])
    +

    Enter a polling loop that terminates after count passes or all open +channels have been closed. All arguments are optional. The count +parameter defaults to None, resulting in the loop terminating only when all +channels have been closed. The timeout argument sets the timeout +parameter for the appropriate select() or poll() +call, measured in seconds; the default is 30 seconds. The use_poll +parameter, if true, indicates that poll() should be used in +preference to select() (the default is False).

    +

    The map parameter is a dictionary whose items are the channels to watch. +As channels are closed they are deleted from their map. If map is +omitted, a global map is used. Channels (instances of +asyncore.dispatcher, asynchat.async_chat and subclasses +thereof) can freely be mixed in the map.

    +
    + +
    +
    +class asyncore.dispatcher
    +

    The dispatcher class is a thin wrapper around a low-level socket +object. To make it more useful, it has a few methods for event-handling +which are called from the asynchronous loop. Otherwise, it can be treated +as a normal non-blocking socket object.

    +

    The firing of low-level events at certain times or in certain connection +states tells the asynchronous loop that certain higher-level events have +taken place. For example, if we have asked for a socket to connect to +another host, we know that the connection has been made when the socket +becomes writable for the first time (at this point you know that you may +write to it with the expectation of success). The implied higher-level +events are:

    + ++++ + + + + + + + + + + + + + + + + +

    Event

    Description

    handle_connect()

    Implied by the first read or write +event

    handle_close()

    Implied by a read event with no data +available

    handle_accepted()

    Implied by a read event on a listening +socket

    +

    During asynchronous processing, each mapped channel’s readable() and +writable() methods are used to determine whether the channel’s socket +should be added to the list of channels select()ed or +poll()ed for read and write events.

    +

    Thus, the set of channel events is larger than the basic socket events. The +full set of methods that can be overridden in your subclass follows:

    +
    +
    +handle_read()
    +

    Called when the asynchronous loop detects that a read() call on the +channel’s socket will succeed.

    +
    + +
    +
    +handle_write()
    +

    Called when the asynchronous loop detects that a writable socket can be +written. Often this method will implement the necessary buffering for +performance. For example:

    +
    def handle_write(self):
    +    sent = self.send(self.buffer)
    +    self.buffer = self.buffer[sent:]
    +
    +
    +
    + +
    +
    +handle_expt()
    +

    Called when there is out of band (OOB) data for a socket connection. This +will almost never happen, as OOB is tenuously supported and rarely used.

    +
    + +
    +
    +handle_connect()
    +

    Called when the active opener’s socket actually makes a connection. Might +send a “welcome” banner, or initiate a protocol negotiation with the +remote endpoint, for example.

    +
    + +
    +
    +handle_close()
    +

    Called when the socket is closed.

    +
    + +
    +
    +handle_error()
    +

    Called when an exception is raised and not otherwise handled. The default +version prints a condensed traceback.

    +
    + +
    +
    +handle_accept()
    +

    Called on listening channels (passive openers) when a connection can be +established with a new remote endpoint that has issued a connect() +call for the local endpoint. Deprecated in version 3.2; use +handle_accepted() instead.

    +
    +

    Deprecated since version 3.2.

    +
    +
    + +
    +
    +handle_accepted(sock, addr)
    +

    Called on listening channels (passive openers) when a connection has been +established with a new remote endpoint that has issued a connect() +call for the local endpoint. sock is a new socket object usable to +send and receive data on the connection, and addr is the address +bound to the socket on the other end of the connection.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +readable()
    +

    Called each time around the asynchronous loop to determine whether a +channel’s socket should be added to the list on which read events can +occur. The default method simply returns True, indicating that by +default, all channels will be interested in read events.

    +
    + +
    +
    +writable()
    +

    Called each time around the asynchronous loop to determine whether a +channel’s socket should be added to the list on which write events can +occur. The default method simply returns True, indicating that by +default, all channels will be interested in write events.

    +
    + +

    In addition, each channel delegates or extends many of the socket methods. +Most of these are nearly identical to their socket partners.

    +
    +
    +create_socket(family=socket.AF_INET, type=socket.SOCK_STREAM)
    +

    This is identical to the creation of a normal socket, and will use the +same options for creation. Refer to the socket documentation for +information on creating sockets.

    +
    +

    Changed in version 3.3: family and type arguments can be omitted.

    +
    +
    + +
    +
    +connect(address)
    +

    As with the normal socket object, address is a tuple with the first +element the host to connect to, and the second the port number.

    +
    + +
    +
    +send(data)
    +

    Send data to the remote end-point of the socket.

    +
    + +
    +
    +recv(buffer_size)
    +

    Read at most buffer_size bytes from the socket’s remote end-point. An +empty bytes object implies that the channel has been closed from the +other end.

    +

    Note that recv() may raise BlockingIOError , even though +select.select() or select.poll() has reported the socket +ready for reading.

    +
    + +
    +
    +listen(backlog)
    +

    Listen for connections made to the socket. The backlog argument +specifies the maximum number of queued connections and should be at least +1; the maximum value is system-dependent (usually 5).

    +
    + +
    +
    +bind(address)
    +

    Bind the socket to address. The socket must not already be bound. (The +format of address depends on the address family — refer to the +socket documentation for more information.) To mark +the socket as re-usable (setting the SO_REUSEADDR option), call +the dispatcher object’s set_reuse_addr() method.

    +
    + +
    +
    +accept()
    +

    Accept a connection. The socket must be bound to an address and listening +for connections. The return value can be either None or a pair +(conn, address) where conn is a new socket object usable to send +and receive data on the connection, and address is the address bound to +the socket on the other end of the connection. +When None is returned it means the connection didn’t take place, in +which case the server should just ignore this event and keep listening +for further incoming connections.

    +
    + +
    +
    +close()
    +

    Close the socket. All future operations on the socket object will fail. +The remote end-point will receive no more data (after queued data is +flushed). Sockets are automatically closed when they are +garbage-collected.

    +
    + +
    + +
    +
    +class asyncore.dispatcher_with_send
    +

    A dispatcher subclass which adds simple buffered output capability, +useful for simple clients. For more sophisticated usage use +asynchat.async_chat.

    +
    + +
    +
    +class asyncore.file_dispatcher
    +

    A file_dispatcher takes a file descriptor or file object along +with an optional map argument and wraps it for use with the poll() +or loop() functions. If provided a file object or anything with a +fileno() method, that method will be called and passed to the +file_wrapper constructor.

    +

    Availability: Unix.

    +
    + +
    +
    +class asyncore.file_wrapper
    +

    A file_wrapper takes an integer file descriptor and calls os.dup() to +duplicate the handle so that the original handle may be closed independently +of the file_wrapper. This class implements sufficient methods to emulate a +socket for use by the file_dispatcher class.

    +

    Availability: Unix.

    +
    + +
    +

    asyncore Example basic HTTP client

    +

    Here is a very basic HTTP client that uses the dispatcher class to +implement its socket handling:

    +
    import asyncore
    +
    +class HTTPClient(asyncore.dispatcher):
    +
    +    def __init__(self, host, path):
    +        asyncore.dispatcher.__init__(self)
    +        self.create_socket()
    +        self.connect( (host, 80) )
    +        self.buffer = bytes('GET %s HTTP/1.0\r\nHost: %s\r\n\r\n' %
    +                            (path, host), 'ascii')
    +
    +    def handle_connect(self):
    +        pass
    +
    +    def handle_close(self):
    +        self.close()
    +
    +    def handle_read(self):
    +        print(self.recv(8192))
    +
    +    def writable(self):
    +        return (len(self.buffer) > 0)
    +
    +    def handle_write(self):
    +        sent = self.send(self.buffer)
    +        self.buffer = self.buffer[sent:]
    +
    +
    +client = HTTPClient('www.python.org', '/')
    +asyncore.loop()
    +
    +
    +
    +
    +

    asyncore Example basic echo server

    +

    Here is a basic echo server that uses the dispatcher class to accept +connections and dispatches the incoming connections to a handler:

    +
    import asyncore
    +
    +class EchoHandler(asyncore.dispatcher_with_send):
    +
    +    def handle_read(self):
    +        data = self.recv(8192)
    +        if data:
    +            self.send(data)
    +
    +class EchoServer(asyncore.dispatcher):
    +
    +    def __init__(self, host, port):
    +        asyncore.dispatcher.__init__(self)
    +        self.create_socket()
    +        self.set_reuse_addr()
    +        self.bind((host, port))
    +        self.listen(5)
    +
    +    def handle_accepted(self, sock, addr):
    +        print('Incoming connection from %s' % repr(addr))
    +        handler = EchoHandler(sock)
    +
    +server = EchoServer('localhost', 8080)
    +asyncore.loop()
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/atexit.html b/python-3.7.4-docs-html/library/atexit.html new file mode 100644 index 0000000..70f6f3c --- /dev/null +++ b/python-3.7.4-docs-html/library/atexit.html @@ -0,0 +1,289 @@ + + + + + + + atexit — Exit handlers — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    atexit — Exit handlers

    +
    +

    The atexit module defines functions to register and unregister cleanup +functions. Functions thus registered are automatically executed upon normal +interpreter termination. atexit runs these functions in the reverse +order in which they were registered; if you register A, B, and C, +at interpreter termination time they will be run in the order C, B, +A.

    +

    Note: The functions registered via this module are not called when the +program is killed by a signal not handled by Python, when a Python fatal +internal error is detected, or when os._exit() is called.

    +
    +

    Changed in version 3.7: When used with C-API subinterpreters, registered functions +are local to the interpreter they were registered in.

    +
    +
    +
    +atexit.register(func, *args, **kwargs)
    +

    Register func as a function to be executed at termination. Any optional +arguments that are to be passed to func must be passed as arguments to +register(). It is possible to register the same function and arguments +more than once.

    +

    At normal program termination (for instance, if sys.exit() is called or +the main module’s execution completes), all functions registered are called in +last in, first out order. The assumption is that lower level modules will +normally be imported before higher level modules and thus must be cleaned up +later.

    +

    If an exception is raised during execution of the exit handlers, a traceback is +printed (unless SystemExit is raised) and the exception information is +saved. After all exit handlers have had a chance to run the last exception to +be raised is re-raised.

    +

    This function returns func, which makes it possible to use it as a +decorator.

    +
    + +
    +
    +atexit.unregister(func)
    +

    Remove func from the list of functions to be run at interpreter +shutdown. After calling unregister(), func is guaranteed not to be +called when the interpreter shuts down, even if it was registered more than +once. unregister() silently does nothing if func was not previously +registered.

    +
    + +
    +

    See also

    +
    +
    Module readline

    Useful example of atexit to read and write readline history +files.

    +
    +
    +
    +
    +

    atexit Example

    +

    The following simple example demonstrates how a module can initialize a counter +from a file when it is imported and save the counter’s updated value +automatically when the program terminates without relying on the application +making an explicit call into this module at termination.

    +
    try:
    +    with open("counterfile") as infile:
    +        _count = int(infile.read())
    +except FileNotFoundError:
    +    _count = 0
    +
    +def incrcounter(n):
    +    global _count
    +    _count = _count + n
    +
    +def savecounter():
    +    with open("counterfile", "w") as outfile:
    +        outfile.write("%d" % _count)
    +
    +import atexit
    +atexit.register(savecounter)
    +
    +
    +

    Positional and keyword arguments may also be passed to register() to be +passed along to the registered function when it is called:

    +
    def goodbye(name, adjective):
    +    print('Goodbye, %s, it was %s to meet you.' % (name, adjective))
    +
    +import atexit
    +atexit.register(goodbye, 'Donny', 'nice')
    +
    +# or:
    +atexit.register(goodbye, adjective='nice', name='Donny')
    +
    +
    +

    Usage as a decorator:

    +
    import atexit
    +
    +@atexit.register
    +def goodbye():
    +    print("You are now leaving the Python sector.")
    +
    +
    +

    This only works with functions that can be called without arguments.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/audioop.html b/python-3.7.4-docs-html/library/audioop.html new file mode 100644 index 0000000..9fae8f4 --- /dev/null +++ b/python-3.7.4-docs-html/library/audioop.html @@ -0,0 +1,466 @@ + + + + + + + audioop — Manipulate raw audio data — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    audioop — Manipulate raw audio data

    +
    +

    The audioop module contains some useful operations on sound fragments. +It operates on sound fragments consisting of signed integer samples 8, 16, 24 +or 32 bits wide, stored in bytes-like objects. All scalar items are +integers, unless specified otherwise.

    +
    +

    Changed in version 3.4: Support for 24-bit samples was added. +All functions now accept any bytes-like object. +String input now results in an immediate error.

    +
    +

    This module provides support for a-LAW, u-LAW and Intel/DVI ADPCM encodings.

    +

    A few of the more complicated operations only take 16-bit samples, otherwise the +sample size (in bytes) is always a parameter of the operation.

    +

    The module defines the following variables and functions:

    +
    +
    +exception audioop.error
    +

    This exception is raised on all errors, such as unknown number of bytes per +sample, etc.

    +
    + +
    +
    +audioop.add(fragment1, fragment2, width)
    +

    Return a fragment which is the addition of the two samples passed as parameters. +width is the sample width in bytes, either 1, 2, 3 or 4. Both +fragments should have the same length. Samples are truncated in case of overflow.

    +
    + +
    +
    +audioop.adpcm2lin(adpcmfragment, width, state)
    +

    Decode an Intel/DVI ADPCM coded fragment to a linear fragment. See the +description of lin2adpcm() for details on ADPCM coding. Return a tuple +(sample, newstate) where the sample has the width specified in width.

    +
    + +
    +
    +audioop.alaw2lin(fragment, width)
    +

    Convert sound fragments in a-LAW encoding to linearly encoded sound fragments. +a-LAW encoding always uses 8 bits samples, so width refers only to the sample +width of the output fragment here.

    +
    + +
    +
    +audioop.avg(fragment, width)
    +

    Return the average over all samples in the fragment.

    +
    + +
    +
    +audioop.avgpp(fragment, width)
    +

    Return the average peak-peak value over all samples in the fragment. No +filtering is done, so the usefulness of this routine is questionable.

    +
    + +
    +
    +audioop.bias(fragment, width, bias)
    +

    Return a fragment that is the original fragment with a bias added to each +sample. Samples wrap around in case of overflow.

    +
    + +
    +
    +audioop.byteswap(fragment, width)
    +

    “Byteswap” all samples in a fragment and returns the modified fragment. +Converts big-endian samples to little-endian and vice versa.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +audioop.cross(fragment, width)
    +

    Return the number of zero crossings in the fragment passed as an argument.

    +
    + +
    +
    +audioop.findfactor(fragment, reference)
    +

    Return a factor F such that rms(add(fragment, mul(reference, -F))) is +minimal, i.e., return the factor with which you should multiply reference to +make it match as well as possible to fragment. The fragments should both +contain 2-byte samples.

    +

    The time taken by this routine is proportional to len(fragment).

    +
    + +
    +
    +audioop.findfit(fragment, reference)
    +

    Try to match reference as well as possible to a portion of fragment (which +should be the longer fragment). This is (conceptually) done by taking slices +out of fragment, using findfactor() to compute the best match, and +minimizing the result. The fragments should both contain 2-byte samples. +Return a tuple (offset, factor) where offset is the (integer) offset into +fragment where the optimal match started and factor is the (floating-point) +factor as per findfactor().

    +
    + +
    +
    +audioop.findmax(fragment, length)
    +

    Search fragment for a slice of length length samples (not bytes!) with +maximum energy, i.e., return i for which rms(fragment[i*2:(i+length)*2]) +is maximal. The fragments should both contain 2-byte samples.

    +

    The routine takes time proportional to len(fragment).

    +
    + +
    +
    +audioop.getsample(fragment, width, index)
    +

    Return the value of sample index from the fragment.

    +
    + +
    +
    +audioop.lin2adpcm(fragment, width, state)
    +

    Convert samples to 4 bit Intel/DVI ADPCM encoding. ADPCM coding is an adaptive +coding scheme, whereby each 4 bit number is the difference between one sample +and the next, divided by a (varying) step. The Intel/DVI ADPCM algorithm has +been selected for use by the IMA, so it may well become a standard.

    +

    state is a tuple containing the state of the coder. The coder returns a tuple +(adpcmfrag, newstate), and the newstate should be passed to the next call +of lin2adpcm(). In the initial call, None can be passed as the state. +adpcmfrag is the ADPCM coded fragment packed 2 4-bit values per byte.

    +
    + +
    +
    +audioop.lin2alaw(fragment, width)
    +

    Convert samples in the audio fragment to a-LAW encoding and return this as a +bytes object. a-LAW is an audio encoding format whereby you get a dynamic +range of about 13 bits using only 8 bit samples. It is used by the Sun audio +hardware, among others.

    +
    + +
    +
    +audioop.lin2lin(fragment, width, newwidth)
    +

    Convert samples between 1-, 2-, 3- and 4-byte formats.

    +
    +

    Note

    +

    In some audio formats, such as .WAV files, 16, 24 and 32 bit samples are +signed, but 8 bit samples are unsigned. So when converting to 8 bit wide +samples for these formats, you need to also add 128 to the result:

    +
    new_frames = audioop.lin2lin(frames, old_width, 1)
    +new_frames = audioop.bias(new_frames, 1, 128)
    +
    +
    +

    The same, in reverse, has to be applied when converting from 8 to 16, 24 +or 32 bit width samples.

    +
    +
    + +
    +
    +audioop.lin2ulaw(fragment, width)
    +

    Convert samples in the audio fragment to u-LAW encoding and return this as a +bytes object. u-LAW is an audio encoding format whereby you get a dynamic +range of about 14 bits using only 8 bit samples. It is used by the Sun audio +hardware, among others.

    +
    + +
    +
    +audioop.max(fragment, width)
    +

    Return the maximum of the absolute value of all samples in a fragment.

    +
    + +
    +
    +audioop.maxpp(fragment, width)
    +

    Return the maximum peak-peak value in the sound fragment.

    +
    + +
    +
    +audioop.minmax(fragment, width)
    +

    Return a tuple consisting of the minimum and maximum values of all samples in +the sound fragment.

    +
    + +
    +
    +audioop.mul(fragment, width, factor)
    +

    Return a fragment that has all samples in the original fragment multiplied by +the floating-point value factor. Samples are truncated in case of overflow.

    +
    + +
    +
    +audioop.ratecv(fragment, width, nchannels, inrate, outrate, state[, weightA[, weightB]])
    +

    Convert the frame rate of the input fragment.

    +

    state is a tuple containing the state of the converter. The converter returns +a tuple (newfragment, newstate), and newstate should be passed to the next +call of ratecv(). The initial call should pass None as the state.

    +

    The weightA and weightB arguments are parameters for a simple digital filter +and default to 1 and 0 respectively.

    +
    + +
    +
    +audioop.reverse(fragment, width)
    +

    Reverse the samples in a fragment and returns the modified fragment.

    +
    + +
    +
    +audioop.rms(fragment, width)
    +

    Return the root-mean-square of the fragment, i.e. sqrt(sum(S_i^2)/n).

    +

    This is a measure of the power in an audio signal.

    +
    + +
    +
    +audioop.tomono(fragment, width, lfactor, rfactor)
    +

    Convert a stereo fragment to a mono fragment. The left channel is multiplied by +lfactor and the right channel by rfactor before adding the two channels to +give a mono signal.

    +
    + +
    +
    +audioop.tostereo(fragment, width, lfactor, rfactor)
    +

    Generate a stereo fragment from a mono fragment. Each pair of samples in the +stereo fragment are computed from the mono sample, whereby left channel samples +are multiplied by lfactor and right channel samples by rfactor.

    +
    + +
    +
    +audioop.ulaw2lin(fragment, width)
    +

    Convert sound fragments in u-LAW encoding to linearly encoded sound fragments. +u-LAW encoding always uses 8 bits samples, so width refers only to the sample +width of the output fragment here.

    +
    + +

    Note that operations such as mul() or max() make no distinction +between mono and stereo fragments, i.e. all samples are treated equal. If this +is a problem the stereo fragment should be split into two mono fragments first +and recombined later. Here is an example of how to do that:

    +
    def mul_stereo(sample, width, lfactor, rfactor):
    +    lsample = audioop.tomono(sample, width, 1, 0)
    +    rsample = audioop.tomono(sample, width, 0, 1)
    +    lsample = audioop.mul(lsample, width, lfactor)
    +    rsample = audioop.mul(rsample, width, rfactor)
    +    lsample = audioop.tostereo(lsample, width, 1, 0)
    +    rsample = audioop.tostereo(rsample, width, 0, 1)
    +    return audioop.add(lsample, rsample, width)
    +
    +
    +

    If you use the ADPCM coder to build network packets and you want your protocol +to be stateless (i.e. to be able to tolerate packet loss) you should not only +transmit the data but also the state. Note that you should send the initial +state (the one you passed to lin2adpcm()) along to the decoder, not the +final state (as returned by the coder). If you want to use +struct.Struct to store the state in binary you can code the first +element (the predicted value) in 16 bits and the second (the delta index) in 8.

    +

    The ADPCM coders have never been tried against other ADPCM coders, only against +themselves. It could well be that I misinterpreted the standards in which case +they will not be interoperable with the respective standards.

    +

    The find*() routines might look a bit funny at first sight. They are +primarily meant to do echo cancellation. A reasonably fast way to do this is to +pick the most energetic piece of the output sample, locate that in the input +sample and subtract the whole output sample from the input sample:

    +
    def echocancel(outputdata, inputdata):
    +    pos = audioop.findmax(outputdata, 800)    # one tenth second
    +    out_test = outputdata[pos*2:]
    +    in_test = inputdata[pos*2:]
    +    ipos, factor = audioop.findfit(in_test, out_test)
    +    # Optional (for better cancellation):
    +    # factor = audioop.findfactor(in_test[ipos*2:ipos*2+len(out_test)],
    +    #              out_test)
    +    prefill = '\0'*(pos+ipos)*2
    +    postfill = '\0'*(len(inputdata)-len(prefill)-len(outputdata))
    +    outputdata = prefill + audioop.mul(outputdata, 2, -factor) + postfill
    +    return audioop.add(inputdata, outputdata, 2)
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/base64.html b/python-3.7.4-docs-html/library/base64.html new file mode 100644 index 0000000..83bf8cf --- /dev/null +++ b/python-3.7.4-docs-html/library/base64.html @@ -0,0 +1,464 @@ + + + + + + + base64 — Base16, Base32, Base64, Base85 Data Encodings — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    base64 — Base16, Base32, Base64, Base85 Data Encodings

    +

    Source code: Lib/base64.py

    +
    +

    This module provides functions for encoding binary data to printable +ASCII characters and decoding such encodings back to binary data. +It provides encoding and decoding functions for the encodings specified in +RFC 3548, which defines the Base16, Base32, and Base64 algorithms, +and for the de-facto standard Ascii85 and Base85 encodings.

    +

    The RFC 3548 encodings are suitable for encoding binary data so that it can +safely sent by email, used as parts of URLs, or included as part of an HTTP +POST request. The encoding algorithm is not the same as the +uuencode program.

    +

    There are two interfaces provided by this module. The modern interface +supports encoding bytes-like objects to ASCII +bytes, and decoding bytes-like objects or +strings containing ASCII to bytes. Both base-64 alphabets +defined in RFC 3548 (normal, and URL- and filesystem-safe) are supported.

    +

    The legacy interface does not support decoding from strings, but it does +provide functions for encoding and decoding to and from file objects. It only supports the Base64 standard alphabet, and it adds +newlines every 76 characters as per RFC 2045. Note that if you are looking +for RFC 2045 support you probably want to be looking at the email +package instead.

    +
    +

    Changed in version 3.3: ASCII-only Unicode strings are now accepted by the decoding functions of +the modern interface.

    +
    +
    +

    Changed in version 3.4: Any bytes-like objects are now accepted by all +encoding and decoding functions in this module. Ascii85/Base85 support added.

    +
    +

    The modern interface provides:

    +
    +
    +base64.b64encode(s, altchars=None)
    +

    Encode the bytes-like object s using Base64 and return the encoded +bytes.

    +

    Optional altchars must be a bytes-like object of at least +length 2 (additional characters are ignored) which specifies an alternative +alphabet for the + and / characters. This allows an application to e.g. +generate URL or filesystem safe Base64 strings. The default is None, for +which the standard Base64 alphabet is used.

    +
    + +
    +
    +base64.b64decode(s, altchars=None, validate=False)
    +

    Decode the Base64 encoded bytes-like object or ASCII string +s and return the decoded bytes.

    +

    Optional altchars must be a bytes-like object or ASCII string of +at least length 2 (additional characters are ignored) which specifies the +alternative alphabet used instead of the + and / characters.

    +

    A binascii.Error exception is raised +if s is incorrectly padded.

    +

    If validate is False (the default), characters that are neither +in the normal base-64 alphabet nor the alternative alphabet are +discarded prior to the padding check. If validate is True, +these non-alphabet characters in the input result in a +binascii.Error.

    +
    + +
    +
    +base64.standard_b64encode(s)
    +

    Encode bytes-like object s using the standard Base64 alphabet +and return the encoded bytes.

    +
    + +
    +
    +base64.standard_b64decode(s)
    +

    Decode bytes-like object or ASCII string s using the standard +Base64 alphabet and return the decoded bytes.

    +
    + +
    +
    +base64.urlsafe_b64encode(s)
    +

    Encode bytes-like object s using the +URL- and filesystem-safe alphabet, which +substitutes - instead of + and _ instead of / in the +standard Base64 alphabet, and return the encoded bytes. The result +can still contain =.

    +
    + +
    +
    +base64.urlsafe_b64decode(s)
    +

    Decode bytes-like object or ASCII string s +using the URL- and filesystem-safe +alphabet, which substitutes - instead of + and _ instead of +/ in the standard Base64 alphabet, and return the decoded +bytes.

    +
    + +
    +
    +base64.b32encode(s)
    +

    Encode the bytes-like object s using Base32 and return the +encoded bytes.

    +
    + +
    +
    +base64.b32decode(s, casefold=False, map01=None)
    +

    Decode the Base32 encoded bytes-like object or ASCII string s and +return the decoded bytes.

    +

    Optional casefold is a flag specifying +whether a lowercase alphabet is acceptable as input. For security purposes, +the default is False.

    +

    RFC 3548 allows for optional mapping of the digit 0 (zero) to the letter O +(oh), and for optional mapping of the digit 1 (one) to either the letter I (eye) +or letter L (el). The optional argument map01 when not None, specifies +which letter the digit 1 should be mapped to (when map01 is not None, the +digit 0 is always mapped to the letter O). For security purposes the default is +None, so that 0 and 1 are not allowed in the input.

    +

    A binascii.Error is raised if s is +incorrectly padded or if there are non-alphabet characters present in the +input.

    +
    + +
    +
    +base64.b16encode(s)
    +

    Encode the bytes-like object s using Base16 and return the +encoded bytes.

    +
    + +
    +
    +base64.b16decode(s, casefold=False)
    +

    Decode the Base16 encoded bytes-like object or ASCII string s and +return the decoded bytes.

    +

    Optional casefold is a flag specifying whether a +lowercase alphabet is acceptable as input. For security purposes, the default +is False.

    +

    A binascii.Error is raised if s is +incorrectly padded or if there are non-alphabet characters present in the +input.

    +
    + +
    +
    +base64.a85encode(b, *, foldspaces=False, wrapcol=0, pad=False, adobe=False)
    +

    Encode the bytes-like object b using Ascii85 and return the +encoded bytes.

    +

    foldspaces is an optional flag that uses the special short sequence ‘y’ +instead of 4 consecutive spaces (ASCII 0x20) as supported by ‘btoa’. This +feature is not supported by the “standard” Ascii85 encoding.

    +

    wrapcol controls whether the output should have newline (b'\n') +characters added to it. If this is non-zero, each output line will be +at most this many characters long.

    +

    pad controls whether the input is padded to a multiple of 4 +before encoding. Note that the btoa implementation always pads.

    +

    adobe controls whether the encoded byte sequence is framed with <~ +and ~>, which is used by the Adobe implementation.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +base64.a85decode(b, *, foldspaces=False, adobe=False, ignorechars=b' \t\n\r\v')
    +

    Decode the Ascii85 encoded bytes-like object or ASCII string b and +return the decoded bytes.

    +

    foldspaces is a flag that specifies whether the ‘y’ short sequence +should be accepted as shorthand for 4 consecutive spaces (ASCII 0x20). +This feature is not supported by the “standard” Ascii85 encoding.

    +

    adobe controls whether the input sequence is in Adobe Ascii85 format +(i.e. is framed with <~ and ~>).

    +

    ignorechars should be a bytes-like object or ASCII string +containing characters to ignore +from the input. This should only contain whitespace characters, and by +default contains all whitespace characters in ASCII.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +base64.b85encode(b, pad=False)
    +

    Encode the bytes-like object b using base85 (as used in e.g. +git-style binary diffs) and return the encoded bytes.

    +

    If pad is true, the input is padded with b'\0' so its length is a +multiple of 4 bytes before encoding.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +base64.b85decode(b)
    +

    Decode the base85-encoded bytes-like object or ASCII string b and +return the decoded bytes. Padding is implicitly removed, if +necessary.

    +
    +

    New in version 3.4.

    +
    +
    + +

    The legacy interface:

    +
    +
    +base64.decode(input, output)
    +

    Decode the contents of the binary input file and write the resulting binary +data to the output file. input and output must be file objects. input will be read until input.readline() returns an +empty bytes object.

    +
    + +
    +
    +base64.decodebytes(s)
    +

    Decode the bytes-like object s, which must contain one or more +lines of base64 encoded data, and return the decoded bytes.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +base64.decodestring(s)
    +

    Deprecated alias of decodebytes().

    +
    +

    Deprecated since version 3.1.

    +
    +
    + +
    +
    +base64.encode(input, output)
    +

    Encode the contents of the binary input file and write the resulting base64 +encoded data to the output file. input and output must be file +objects. input will be read until input.read() returns +an empty bytes object. encode() inserts a newline character (b'\n') +after every 76 bytes of the output, as well as ensuring that the output +always ends with a newline, as per RFC 2045 (MIME).

    +
    + +
    +
    +base64.encodebytes(s)
    +

    Encode the bytes-like object s, which can contain arbitrary binary +data, and return bytes containing the base64-encoded data, with newlines +(b'\n') inserted after every 76 bytes of output, and ensuring that +there is a trailing newline, as per RFC 2045 (MIME).

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +base64.encodestring(s)
    +

    Deprecated alias of encodebytes().

    +
    +

    Deprecated since version 3.1.

    +
    +
    + +

    An example usage of the module:

    +
    >>> import base64
    +>>> encoded = base64.b64encode(b'data to be encoded')
    +>>> encoded
    +b'ZGF0YSB0byBiZSBlbmNvZGVk'
    +>>> data = base64.b64decode(encoded)
    +>>> data
    +b'data to be encoded'
    +
    +
    +
    +

    See also

    +
    +
    Module binascii

    Support module containing ASCII-to-binary and binary-to-ASCII conversions.

    +
    +
    RFC 1521 - MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies

    Section 5.2, “Base64 Content-Transfer-Encoding,” provides the definition of the +base64 encoding.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/bdb.html b/python-3.7.4-docs-html/library/bdb.html new file mode 100644 index 0000000..66af42a --- /dev/null +++ b/python-3.7.4-docs-html/library/bdb.html @@ -0,0 +1,619 @@ + + + + + + + bdb — Debugger framework — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    bdb — Debugger framework

    +

    Source code: Lib/bdb.py

    +
    +

    The bdb module handles basic debugger functions, like setting breakpoints +or managing execution via the debugger.

    +

    The following exception is defined:

    +
    +
    +exception bdb.BdbQuit
    +

    Exception raised by the Bdb class for quitting the debugger.

    +
    + +

    The bdb module also defines two classes:

    +
    +
    +class bdb.Breakpoint(self, file, line, temporary=0, cond=None, funcname=None)
    +

    This class implements temporary breakpoints, ignore counts, disabling and +(re-)enabling, and conditionals.

    +

    Breakpoints are indexed by number through a list called bpbynumber +and by (file, line) pairs through bplist. The former points to a +single instance of class Breakpoint. The latter points to a list of +such instances since there may be more than one breakpoint per line.

    +

    When creating a breakpoint, its associated filename should be in canonical +form. If a funcname is defined, a breakpoint hit will be counted when the +first line of that function is executed. A conditional breakpoint always +counts a hit.

    +

    Breakpoint instances have the following methods:

    +
    +
    +deleteMe()
    +

    Delete the breakpoint from the list associated to a file/line. If it is +the last breakpoint in that position, it also deletes the entry for the +file/line.

    +
    + +
    +
    +enable()
    +

    Mark the breakpoint as enabled.

    +
    + +
    +
    +disable()
    +

    Mark the breakpoint as disabled.

    +
    + +
    +
    +bpformat()
    +

    Return a string with all the information about the breakpoint, nicely +formatted:

    +
      +
    • The breakpoint number.

    • +
    • If it is temporary or not.

    • +
    • Its file,line position.

    • +
    • The condition that causes a break.

    • +
    • If it must be ignored the next N times.

    • +
    • The breakpoint hit count.

    • +
    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +bpprint(out=None)
    +

    Print the output of bpformat() to the file out, or if it is +None, to standard output.

    +
    + +
    + +
    +
    +class bdb.Bdb(skip=None)
    +

    The Bdb class acts as a generic Python debugger base class.

    +

    This class takes care of the details of the trace facility; a derived class +should implement user interaction. The standard debugger class +(pdb.Pdb) is an example.

    +

    The skip argument, if given, must be an iterable of glob-style +module name patterns. The debugger will not step into frames that +originate in a module that matches one of these patterns. Whether a +frame is considered to originate in a certain module is determined +by the __name__ in the frame globals.

    +
    +

    New in version 3.1: The skip argument.

    +
    +

    The following methods of Bdb normally don’t need to be overridden.

    +
    +
    +canonic(filename)
    +

    Auxiliary method for getting a filename in a canonical form, that is, as a +case-normalized (on case-insensitive filesystems) absolute path, stripped +of surrounding angle brackets.

    +
    + +
    +
    +reset()
    +

    Set the botframe, stopframe, returnframe and +quitting attributes with values ready to start debugging.

    +
    + +
    +
    +trace_dispatch(frame, event, arg)
    +

    This function is installed as the trace function of debugged frames. Its +return value is the new trace function (in most cases, that is, itself).

    +

    The default implementation decides how to dispatch a frame, depending on +the type of event (passed as a string) that is about to be executed. +event can be one of the following:

    +
      +
    • "line": A new line of code is going to be executed.

    • +
    • "call": A function is about to be called, or another code block +entered.

    • +
    • "return": A function or other code block is about to return.

    • +
    • "exception": An exception has occurred.

    • +
    • "c_call": A C function is about to be called.

    • +
    • "c_return": A C function has returned.

    • +
    • "c_exception": A C function has raised an exception.

    • +
    +

    For the Python events, specialized functions (see below) are called. For +the C events, no action is taken.

    +

    The arg parameter depends on the previous event.

    +

    See the documentation for sys.settrace() for more information on the +trace function. For more information on code and frame objects, refer to +The standard type hierarchy.

    +
    + +
    +
    +dispatch_line(frame)
    +

    If the debugger should stop on the current line, invoke the +user_line() method (which should be overridden in subclasses). +Raise a BdbQuit exception if the Bdb.quitting flag is set +(which can be set from user_line()). Return a reference to the +trace_dispatch() method for further tracing in that scope.

    +
    + +
    +
    +dispatch_call(frame, arg)
    +

    If the debugger should stop on this function call, invoke the +user_call() method (which should be overridden in subclasses). +Raise a BdbQuit exception if the Bdb.quitting flag is set +(which can be set from user_call()). Return a reference to the +trace_dispatch() method for further tracing in that scope.

    +
    + +
    +
    +dispatch_return(frame, arg)
    +

    If the debugger should stop on this function return, invoke the +user_return() method (which should be overridden in subclasses). +Raise a BdbQuit exception if the Bdb.quitting flag is set +(which can be set from user_return()). Return a reference to the +trace_dispatch() method for further tracing in that scope.

    +
    + +
    +
    +dispatch_exception(frame, arg)
    +

    If the debugger should stop at this exception, invokes the +user_exception() method (which should be overridden in subclasses). +Raise a BdbQuit exception if the Bdb.quitting flag is set +(which can be set from user_exception()). Return a reference to the +trace_dispatch() method for further tracing in that scope.

    +
    + +

    Normally derived classes don’t override the following methods, but they may +if they want to redefine the definition of stopping and breakpoints.

    +
    +
    +stop_here(frame)
    +

    This method checks if the frame is somewhere below botframe in +the call stack. botframe is the frame in which debugging started.

    +
    + +
    +
    +break_here(frame)
    +

    This method checks if there is a breakpoint in the filename and line +belonging to frame or, at least, in the current function. If the +breakpoint is a temporary one, this method deletes it.

    +
    + +
    +
    +break_anywhere(frame)
    +

    This method checks if there is a breakpoint in the filename of the current +frame.

    +
    + +

    Derived classes should override these methods to gain control over debugger +operation.

    +
    +
    +user_call(frame, argument_list)
    +

    This method is called from dispatch_call() when there is the +possibility that a break might be necessary anywhere inside the called +function.

    +
    + +
    +
    +user_line(frame)
    +

    This method is called from dispatch_line() when either +stop_here() or break_here() yields True.

    +
    + +
    +
    +user_return(frame, return_value)
    +

    This method is called from dispatch_return() when stop_here() +yields True.

    +
    + +
    +
    +user_exception(frame, exc_info)
    +

    This method is called from dispatch_exception() when +stop_here() yields True.

    +
    + +
    +
    +do_clear(arg)
    +

    Handle how a breakpoint must be removed when it is a temporary one.

    +

    This method must be implemented by derived classes.

    +
    + +

    Derived classes and clients can call the following methods to affect the +stepping state.

    +
    +
    +set_step()
    +

    Stop after one line of code.

    +
    + +
    +
    +set_next(frame)
    +

    Stop on the next line in or below the given frame.

    +
    + +
    +
    +set_return(frame)
    +

    Stop when returning from the given frame.

    +
    + +
    +
    +set_until(frame)
    +

    Stop when the line with the line no greater than the current one is +reached or when returning from current frame.

    +
    + +
    +
    +set_trace([frame])
    +

    Start debugging from frame. If frame is not specified, debugging +starts from caller’s frame.

    +
    + +
    +
    +set_continue()
    +

    Stop only at breakpoints or when finished. If there are no breakpoints, +set the system trace function to None.

    +
    + +
    +
    +set_quit()
    +

    Set the quitting attribute to True. This raises BdbQuit in +the next call to one of the dispatch_*() methods.

    +
    + +

    Derived classes and clients can call the following methods to manipulate +breakpoints. These methods return a string containing an error message if +something went wrong, or None if all is well.

    +
    +
    +set_break(filename, lineno, temporary=0, cond, funcname)
    +

    Set a new breakpoint. If the lineno line doesn’t exist for the +filename passed as argument, return an error message. The filename +should be in canonical form, as described in the canonic() method.

    +
    + +
    +
    +clear_break(filename, lineno)
    +

    Delete the breakpoints in filename and lineno. If none were set, an +error message is returned.

    +
    + +
    +
    +clear_bpbynumber(arg)
    +

    Delete the breakpoint which has the index arg in the +Breakpoint.bpbynumber. If arg is not numeric or out of range, +return an error message.

    +
    + +
    +
    +clear_all_file_breaks(filename)
    +

    Delete all breakpoints in filename. If none were set, an error message +is returned.

    +
    + +
    +
    +clear_all_breaks()
    +

    Delete all existing breakpoints.

    +
    + +
    +
    +get_bpbynumber(arg)
    +

    Return a breakpoint specified by the given number. If arg is a string, +it will be converted to a number. If arg is a non-numeric string, if +the given breakpoint never existed or has been deleted, a +ValueError is raised.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +get_break(filename, lineno)
    +

    Check if there is a breakpoint for lineno of filename.

    +
    + +
    +
    +get_breaks(filename, lineno)
    +

    Return all breakpoints for lineno in filename, or an empty list if +none are set.

    +
    + +
    +
    +get_file_breaks(filename)
    +

    Return all breakpoints in filename, or an empty list if none are set.

    +
    + +
    +
    +get_all_breaks()
    +

    Return all breakpoints that are set.

    +
    + +

    Derived classes and clients can call the following methods to get a data +structure representing a stack trace.

    +
    +
    +get_stack(f, t)
    +

    Get a list of records for a frame and all higher (calling) and lower +frames, and the size of the higher part.

    +
    + +
    +
    +format_stack_entry(frame_lineno, lprefix=': ')
    +

    Return a string with information about a stack entry, identified by a +(frame, lineno) tuple:

    +
      +
    • The canonical form of the filename which contains the frame.

    • +
    • The function name, or "<lambda>".

    • +
    • The input arguments.

    • +
    • The return value.

    • +
    • The line of code (if it exists).

    • +
    +
    + +

    The following two methods can be called by clients to use a debugger to debug +a statement, given as a string.

    +
    +
    +run(cmd, globals=None, locals=None)
    +

    Debug a statement executed via the exec() function. globals +defaults to __main__.__dict__, locals defaults to globals.

    +
    + +
    +
    +runeval(expr, globals=None, locals=None)
    +

    Debug an expression executed via the eval() function. globals and +locals have the same meaning as in run().

    +
    + +
    +
    +runctx(cmd, globals, locals)
    +

    For backwards compatibility. Calls the run() method.

    +
    + +
    +
    +runcall(func, *args, **kwds)
    +

    Debug a single function call, and return its result.

    +
    + +
    + +

    Finally, the module defines the following functions:

    +
    +
    +bdb.checkfuncname(b, frame)
    +

    Check whether we should break here, depending on the way the breakpoint b +was set.

    +

    If it was set via line number, it checks if b.line is the same as the one +in the frame also passed as argument. If the breakpoint was set via function +name, we have to check we are in the right frame (the right function) and if +we are in its first executable line.

    +
    + +
    +
    +bdb.effective(file, line, frame)
    +

    Determine if there is an effective (active) breakpoint at this line of code. +Return a tuple of the breakpoint and a boolean that indicates if it is ok +to delete a temporary breakpoint. Return (None, None) if there is no +matching breakpoint.

    +
    + +
    +
    +bdb.set_trace()
    +

    Start debugging with a Bdb instance from caller’s frame.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/binary.html b/python-3.7.4-docs-html/library/binary.html new file mode 100644 index 0000000..6e26204 --- /dev/null +++ b/python-3.7.4-docs-html/library/binary.html @@ -0,0 +1,236 @@ + + + + + + + Binary Data Services — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Binary Data Services

    +

    The modules described in this chapter provide some basic services operations +for manipulation of binary data. Other operations on binary data, specifically +in relation to file formats and network protocols, are described in the +relevant sections.

    +

    Some libraries described under Text Processing Services also work with either +ASCII-compatible binary formats (for example, re) or all binary data +(for example, difflib).

    +

    In addition, see the documentation for Python’s built-in binary data types in +Binary Sequence Types — bytes, bytearray, memoryview.

    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/binascii.html b/python-3.7.4-docs-html/library/binascii.html new file mode 100644 index 0000000..5924562 --- /dev/null +++ b/python-3.7.4-docs-html/library/binascii.html @@ -0,0 +1,379 @@ + + + + + + + binascii — Convert between binary and ASCII — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    binascii — Convert between binary and ASCII

    +
    +

    The binascii module contains a number of methods to convert between +binary and various ASCII-encoded binary representations. Normally, you will not +use these functions directly but use wrapper modules like uu, +base64, or binhex instead. The binascii module contains +low-level functions written in C for greater speed that are used by the +higher-level modules.

    +
    +

    Note

    +

    a2b_* functions accept Unicode strings containing only ASCII characters. +Other functions only accept bytes-like objects (such as +bytes, bytearray and other objects that support the buffer +protocol).

    +
    +

    Changed in version 3.3: ASCII-only unicode strings are now accepted by the a2b_* functions.

    +
    +
    +

    The binascii module defines the following functions:

    +
    +
    +binascii.a2b_uu(string)
    +

    Convert a single line of uuencoded data back to binary and return the binary +data. Lines normally contain 45 (binary) bytes, except for the last line. Line +data may be followed by whitespace.

    +
    + +
    +
    +binascii.b2a_uu(data, *, backtick=False)
    +

    Convert binary data to a line of ASCII characters, the return value is the +converted line, including a newline char. The length of data should be at most +45. If backtick is true, zeros are represented by '`' instead of spaces.

    +
    +

    Changed in version 3.7: Added the backtick parameter.

    +
    +
    + +
    +
    +binascii.a2b_base64(string)
    +

    Convert a block of base64 data back to binary and return the binary data. More +than one line may be passed at a time.

    +
    + +
    +
    +binascii.b2a_base64(data, *, newline=True)
    +

    Convert binary data to a line of ASCII characters in base64 coding. The return +value is the converted line, including a newline char if newline is +true. The output of this function conforms to RFC 3548.

    +
    +

    Changed in version 3.6: Added the newline parameter.

    +
    +
    + +
    +
    +binascii.a2b_qp(data, header=False)
    +

    Convert a block of quoted-printable data back to binary and return the binary +data. More than one line may be passed at a time. If the optional argument +header is present and true, underscores will be decoded as spaces.

    +
    + +
    +
    +binascii.b2a_qp(data, quotetabs=False, istext=True, header=False)
    +

    Convert binary data to a line(s) of ASCII characters in quoted-printable +encoding. The return value is the converted line(s). If the optional argument +quotetabs is present and true, all tabs and spaces will be encoded. If the +optional argument istext is present and true, newlines are not encoded but +trailing whitespace will be encoded. If the optional argument header is +present and true, spaces will be encoded as underscores per RFC 1522. If the +optional argument header is present and false, newline characters will be +encoded as well; otherwise linefeed conversion might corrupt the binary data +stream.

    +
    + +
    +
    +binascii.a2b_hqx(string)
    +

    Convert binhex4 formatted ASCII data to binary, without doing RLE-decompression. +The string should contain a complete number of binary bytes, or (in case of the +last portion of the binhex4 data) have the remaining bits zero.

    +
    + +
    +
    +binascii.rledecode_hqx(data)
    +

    Perform RLE-decompression on the data, as per the binhex4 standard. The +algorithm uses 0x90 after a byte as a repeat indicator, followed by a count. +A count of 0 specifies a byte value of 0x90. The routine returns the +decompressed data, unless data input data ends in an orphaned repeat indicator, +in which case the Incomplete exception is raised.

    +
    +

    Changed in version 3.2: Accept only bytestring or bytearray objects as input.

    +
    +
    + +
    +
    +binascii.rlecode_hqx(data)
    +

    Perform binhex4 style RLE-compression on data and return the result.

    +
    + +
    +
    +binascii.b2a_hqx(data)
    +

    Perform hexbin4 binary-to-ASCII translation and return the resulting string. The +argument should already be RLE-coded, and have a length divisible by 3 (except +possibly the last fragment).

    +
    + +
    +
    +binascii.crc_hqx(data, value)
    +

    Compute a 16-bit CRC value of data, starting with value as the +initial CRC, and return the result. This uses the CRC-CCITT polynomial +x16 + x12 + x5 + 1, often represented as +0x1021. This CRC is used in the binhex4 format.

    +
    + +
    +
    +binascii.crc32(data[, value])
    +

    Compute CRC-32, the 32-bit checksum of data, starting with an +initial CRC of value. The default initial CRC is zero. The algorithm +is consistent with the ZIP file checksum. Since the algorithm is designed for +use as a checksum algorithm, it is not suitable for use as a general hash +algorithm. Use as follows:

    +
    print(binascii.crc32(b"hello world"))
    +# Or, in two pieces:
    +crc = binascii.crc32(b"hello")
    +crc = binascii.crc32(b" world", crc)
    +print('crc32 = {:#010x}'.format(crc))
    +
    +
    +
    +

    Changed in version 3.0: The result is always unsigned. +To generate the same numeric value across all Python versions and +platforms, use crc32(data) & 0xffffffff.

    +
    +
    + +
    +
    +binascii.b2a_hex(data)
    +
    +binascii.hexlify(data)
    +

    Return the hexadecimal representation of the binary data. Every byte of +data is converted into the corresponding 2-digit hex representation. The +returned bytes object is therefore twice as long as the length of data.

    +

    Similar functionality (but returning a text string) is also conveniently +accessible using the bytes.hex() method.

    +
    + +
    +
    +binascii.a2b_hex(hexstr)
    +
    +binascii.unhexlify(hexstr)
    +

    Return the binary data represented by the hexadecimal string hexstr. This +function is the inverse of b2a_hex(). hexstr must contain an even number +of hexadecimal digits (which can be upper or lower case), otherwise an +Error exception is raised.

    +

    Similar functionality (accepting only text string arguments, but more +liberal towards whitespace) is also accessible using the +bytes.fromhex() class method.

    +
    + +
    +
    +exception binascii.Error
    +

    Exception raised on errors. These are usually programming errors.

    +
    + +
    +
    +exception binascii.Incomplete
    +

    Exception raised on incomplete data. These are usually not programming errors, +but may be handled by reading a little more data and trying again.

    +
    + +
    +

    See also

    +
    +
    Module base64

    Support for RFC compliant base64-style encoding in base 16, 32, 64, +and 85.

    +
    +
    Module binhex

    Support for the binhex format used on the Macintosh.

    +
    +
    Module uu

    Support for UU encoding used on Unix.

    +
    +
    Module quopri

    Support for quoted-printable encoding used in MIME email messages.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/binhex.html b/python-3.7.4-docs-html/library/binhex.html new file mode 100644 index 0000000..58e6bdc --- /dev/null +++ b/python-3.7.4-docs-html/library/binhex.html @@ -0,0 +1,236 @@ + + + + + + + binhex — Encode and decode binhex4 files — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    binhex — Encode and decode binhex4 files

    +

    Source code: Lib/binhex.py

    +
    +

    This module encodes and decodes files in binhex4 format, a format allowing +representation of Macintosh files in ASCII. Only the data fork is handled.

    +

    The binhex module defines the following functions:

    +
    +
    +binhex.binhex(input, output)
    +

    Convert a binary file with filename input to binhex file output. The +output parameter can either be a filename or a file-like object (any object +supporting a write() and close() method).

    +
    + +
    +
    +binhex.hexbin(input, output)
    +

    Decode a binhex file input. input may be a filename or a file-like object +supporting read() and close() methods. The resulting file is written +to a file named output, unless the argument is None in which case the +output filename is read from the binhex file.

    +
    + +

    The following exception is also defined:

    +
    +
    +exception binhex.Error
    +

    Exception raised when something can’t be encoded using the binhex format (for +example, a filename is too long to fit in the filename field), or when input is +not properly encoded binhex data.

    +
    + +
    +

    See also

    +
    +
    Module binascii

    Support module containing ASCII-to-binary and binary-to-ASCII conversions.

    +
    +
    +
    +
    +

    Notes

    +

    There is an alternative, more powerful interface to the coder and decoder, see +the source for details.

    +

    If you code or decode textfiles on non-Macintosh platforms they will still use +the old Macintosh newline convention (carriage-return as end of line).

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/bisect.html b/python-3.7.4-docs-html/library/bisect.html new file mode 100644 index 0000000..1184138 --- /dev/null +++ b/python-3.7.4-docs-html/library/bisect.html @@ -0,0 +1,329 @@ + + + + + + + bisect — Array bisection algorithm — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    bisect — Array bisection algorithm

    +

    Source code: Lib/bisect.py

    +
    +

    This module provides support for maintaining a list in sorted order without +having to sort the list after each insertion. For long lists of items with +expensive comparison operations, this can be an improvement over the more common +approach. The module is called bisect because it uses a basic bisection +algorithm to do its work. The source code may be most useful as a working +example of the algorithm (the boundary conditions are already right!).

    +

    The following functions are provided:

    +
    +
    +bisect.bisect_left(a, x, lo=0, hi=len(a))
    +

    Locate the insertion point for x in a to maintain sorted order. +The parameters lo and hi may be used to specify a subset of the list +which should be considered; by default the entire list is used. If x is +already present in a, the insertion point will be before (to the left of) +any existing entries. The return value is suitable for use as the first +parameter to list.insert() assuming that a is already sorted.

    +

    The returned insertion point i partitions the array a into two halves so +that all(val < x for val in a[lo:i]) for the left side and +all(val >= x for val in a[i:hi]) for the right side.

    +
    + +
    +
    +bisect.bisect_right(a, x, lo=0, hi=len(a))
    +
    +bisect.bisect(a, x, lo=0, hi=len(a))
    +

    Similar to bisect_left(), but returns an insertion point which comes +after (to the right of) any existing entries of x in a.

    +

    The returned insertion point i partitions the array a into two halves so +that all(val <= x for val in a[lo:i]) for the left side and +all(val > x for val in a[i:hi]) for the right side.

    +
    + +
    +
    +bisect.insort_left(a, x, lo=0, hi=len(a))
    +

    Insert x in a in sorted order. This is equivalent to +a.insert(bisect.bisect_left(a, x, lo, hi), x) assuming that a is +already sorted. Keep in mind that the O(log n) search is dominated by +the slow O(n) insertion step.

    +
    + +
    +
    +bisect.insort_right(a, x, lo=0, hi=len(a))
    +
    +bisect.insort(a, x, lo=0, hi=len(a))
    +

    Similar to insort_left(), but inserting x in a after any existing +entries of x.

    +
    + +
    +

    See also

    +

    SortedCollection recipe that uses +bisect to build a full-featured collection class with straight-forward search +methods and support for a key-function. The keys are precomputed to save +unnecessary calls to the key function during searches.

    +
    +
    +

    Searching Sorted Lists

    +

    The above bisect() functions are useful for finding insertion points but +can be tricky or awkward to use for common searching tasks. The following five +functions show how to transform them into the standard lookups for sorted +lists:

    +
    def index(a, x):
    +    'Locate the leftmost value exactly equal to x'
    +    i = bisect_left(a, x)
    +    if i != len(a) and a[i] == x:
    +        return i
    +    raise ValueError
    +
    +def find_lt(a, x):
    +    'Find rightmost value less than x'
    +    i = bisect_left(a, x)
    +    if i:
    +        return a[i-1]
    +    raise ValueError
    +
    +def find_le(a, x):
    +    'Find rightmost value less than or equal to x'
    +    i = bisect_right(a, x)
    +    if i:
    +        return a[i-1]
    +    raise ValueError
    +
    +def find_gt(a, x):
    +    'Find leftmost value greater than x'
    +    i = bisect_right(a, x)
    +    if i != len(a):
    +        return a[i]
    +    raise ValueError
    +
    +def find_ge(a, x):
    +    'Find leftmost item greater than or equal to x'
    +    i = bisect_left(a, x)
    +    if i != len(a):
    +        return a[i]
    +    raise ValueError
    +
    +
    +
    +
    +

    Other Examples

    +

    The bisect() function can be useful for numeric table lookups. This +example uses bisect() to look up a letter grade for an exam score (say) +based on a set of ordered numeric breakpoints: 90 and up is an ‘A’, 80 to 89 is +a ‘B’, and so on:

    +
    >>> def grade(score, breakpoints=[60, 70, 80, 90], grades='FDCBA'):
    +...     i = bisect(breakpoints, score)
    +...     return grades[i]
    +...
    +>>> [grade(score) for score in [33, 99, 77, 70, 89, 90, 100]]
    +['F', 'A', 'C', 'C', 'B', 'A', 'A']
    +
    +
    +

    Unlike the sorted() function, it does not make sense for the bisect() +functions to have key or reversed arguments because that would lead to an +inefficient design (successive calls to bisect functions would not “remember” +all of the previous key lookups).

    +

    Instead, it is better to search a list of precomputed keys to find the index +of the record in question:

    +
    >>> data = [('red', 5), ('blue', 1), ('yellow', 8), ('black', 0)]
    +>>> data.sort(key=lambda r: r[1])
    +>>> keys = [r[1] for r in data]         # precomputed list of keys
    +>>> data[bisect_left(keys, 0)]
    +('black', 0)
    +>>> data[bisect_left(keys, 1)]
    +('blue', 1)
    +>>> data[bisect_left(keys, 5)]
    +('red', 5)
    +>>> data[bisect_left(keys, 8)]
    +('yellow', 8)
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/builtins.html b/python-3.7.4-docs-html/library/builtins.html new file mode 100644 index 0000000..cad7957 --- /dev/null +++ b/python-3.7.4-docs-html/library/builtins.html @@ -0,0 +1,216 @@ + + + + + + + builtins — Built-in objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    builtins — Built-in objects

    +
    +

    This module provides direct access to all ‘built-in’ identifiers of Python; for +example, builtins.open is the full name for the built-in function +open(). See Built-in Functions and Built-in Constants for +documentation.

    +

    This module is not normally accessed explicitly by most applications, but can be +useful in modules that provide objects with the same name as a built-in value, +but in which the built-in of that name is also needed. For example, in a module +that wants to implement an open() function that wraps the built-in +open(), this module can be used directly:

    +
    import builtins
    +
    +def open(path):
    +    f = builtins.open(path, 'r')
    +    return UpperCaser(f)
    +
    +class UpperCaser:
    +    '''Wrapper around a file that converts output to upper-case.'''
    +
    +    def __init__(self, f):
    +        self._f = f
    +
    +    def read(self, count=-1):
    +        return self._f.read(count).upper()
    +
    +    # ...
    +
    +
    +

    As an implementation detail, most modules have the name __builtins__ made +available as part of their globals. The value of __builtins__ is normally +either this module or the value of this module’s __dict__ attribute. +Since this is an implementation detail, it may not be used by alternate +implementations of Python.

    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/bz2.html b/python-3.7.4-docs-html/library/bz2.html new file mode 100644 index 0000000..2c98b23 --- /dev/null +++ b/python-3.7.4-docs-html/library/bz2.html @@ -0,0 +1,511 @@ + + + + + + + bz2 — Support for bzip2 compression — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    bz2 — Support for bzip2 compression

    +

    Source code: Lib/bz2.py

    +
    +

    This module provides a comprehensive interface for compressing and +decompressing data using the bzip2 compression algorithm.

    +

    The bz2 module contains:

    + +

    All of the classes in this module may safely be accessed from multiple threads.

    +
    +

    (De)compression of files

    +
    +
    +bz2.open(filename, mode='r', compresslevel=9, encoding=None, errors=None, newline=None)
    +

    Open a bzip2-compressed file in binary or text mode, returning a file +object.

    +

    As with the constructor for BZ2File, the filename argument can be +an actual filename (a str or bytes object), or an existing +file object to read from or write to.

    +

    The mode argument can be any of 'r', 'rb', 'w', 'wb', +'x', 'xb', 'a' or 'ab' for binary mode, or 'rt', +'wt', 'xt', or 'at' for text mode. The default is 'rb'.

    +

    The compresslevel argument is an integer from 1 to 9, as for the +BZ2File constructor.

    +

    For binary mode, this function is equivalent to the BZ2File +constructor: BZ2File(filename, mode, compresslevel=compresslevel). In +this case, the encoding, errors and newline arguments must not be +provided.

    +

    For text mode, a BZ2File object is created, and wrapped in an +io.TextIOWrapper instance with the specified encoding, error +handling behavior, and line ending(s).

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.4: The 'x' (exclusive creation) mode was added.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +class bz2.BZ2File(filename, mode='r', buffering=None, compresslevel=9)
    +

    Open a bzip2-compressed file in binary mode.

    +

    If filename is a str or bytes object, open the named file +directly. Otherwise, filename should be a file object, which will +be used to read or write the compressed data.

    +

    The mode argument can be either 'r' for reading (default), 'w' for +overwriting, 'x' for exclusive creation, or 'a' for appending. These +can equivalently be given as 'rb', 'wb', 'xb' and 'ab' +respectively.

    +

    If filename is a file object (rather than an actual file name), a mode of +'w' does not truncate the file, and is instead equivalent to 'a'.

    +

    The buffering argument is ignored. Its use is deprecated.

    +

    If mode is 'w' or 'a', compresslevel can be an integer between +1 and 9 specifying the level of compression: 1 produces the +least compression, and 9 (default) produces the most compression.

    +

    If mode is 'r', the input file may be the concatenation of multiple +compressed streams.

    +

    BZ2File provides all of the members specified by the +io.BufferedIOBase, except for detach() and truncate(). +Iteration and the with statement are supported.

    +

    BZ2File also provides the following method:

    +
    +
    +peek([n])
    +

    Return buffered data without advancing the file position. At least one +byte of data will be returned (unless at EOF). The exact number of bytes +returned is unspecified.

    +
    +

    Note

    +

    While calling peek() does not change the file position of +the BZ2File, it may change the position of the underlying file +object (e.g. if the BZ2File was constructed by passing a file +object for filename).

    +
    +
    +

    New in version 3.3.

    +
    +
    + +
    +

    Changed in version 3.1: Support for the with statement was added.

    +
    +
    +

    Changed in version 3.3: The fileno(), readable(), seekable(), writable(), +read1() and readinto() methods were added.

    +
    +
    +

    Changed in version 3.3: Support was added for filename being a file object instead of an +actual filename.

    +
    +
    +

    Changed in version 3.3: The 'a' (append) mode was added, along with support for reading +multi-stream files.

    +
    +
    +

    Changed in version 3.4: The 'x' (exclusive creation) mode was added.

    +
    +
    +

    Changed in version 3.5: The read() method now accepts an argument of +None.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +

    Incremental (de)compression

    +
    +
    +class bz2.BZ2Compressor(compresslevel=9)
    +

    Create a new compressor object. This object may be used to compress data +incrementally. For one-shot compression, use the compress() function +instead.

    +

    compresslevel, if given, must be an integer between 1 and 9. The +default is 9.

    +
    +
    +compress(data)
    +

    Provide data to the compressor object. Returns a chunk of compressed data +if possible, or an empty byte string otherwise.

    +

    When you have finished providing data to the compressor, call the +flush() method to finish the compression process.

    +
    + +
    +
    +flush()
    +

    Finish the compression process. Returns the compressed data left in +internal buffers.

    +

    The compressor object may not be used after this method has been called.

    +
    + +
    + +
    +
    +class bz2.BZ2Decompressor
    +

    Create a new decompressor object. This object may be used to decompress data +incrementally. For one-shot compression, use the decompress() function +instead.

    +
    +

    Note

    +

    This class does not transparently handle inputs containing multiple +compressed streams, unlike decompress() and BZ2File. If +you need to decompress a multi-stream input with BZ2Decompressor, +you must use a new decompressor for each stream.

    +
    +
    +
    +decompress(data, max_length=-1)
    +

    Decompress data (a bytes-like object), returning +uncompressed data as bytes. Some of data may be buffered +internally, for use in later calls to decompress(). The +returned data should be concatenated with the output of any +previous calls to decompress().

    +

    If max_length is nonnegative, returns at most max_length +bytes of decompressed data. If this limit is reached and further +output can be produced, the needs_input attribute will +be set to False. In this case, the next call to +decompress() may provide data as b'' to obtain +more of the output.

    +

    If all of the input data was decompressed and returned (either +because this was less than max_length bytes, or because +max_length was negative), the needs_input attribute +will be set to True.

    +

    Attempting to decompress data after the end of stream is reached +raises an EOFError. Any data found after the end of the +stream is ignored and saved in the unused_data attribute.

    +
    +

    Changed in version 3.5: Added the max_length parameter.

    +
    +
    + +
    +
    +eof
    +

    True if the end-of-stream marker has been reached.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +unused_data
    +

    Data found after the end of the compressed stream.

    +

    If this attribute is accessed before the end of the stream has been +reached, its value will be b''.

    +
    + +
    +
    +needs_input
    +

    False if the decompress() method can provide more +decompressed data before requiring new uncompressed input.

    +
    +

    New in version 3.5.

    +
    +
    + +
    + +
    +
    +

    One-shot (de)compression

    +
    +
    +bz2.compress(data, compresslevel=9)
    +

    Compress data, a bytes-like object.

    +

    compresslevel, if given, must be an integer between 1 and 9. The +default is 9.

    +

    For incremental compression, use a BZ2Compressor instead.

    +
    + +
    +
    +bz2.decompress(data)
    +

    Decompress data, a bytes-like object.

    +

    If data is the concatenation of multiple compressed streams, decompress +all of the streams.

    +

    For incremental decompression, use a BZ2Decompressor instead.

    +
    +

    Changed in version 3.3: Support for multi-stream inputs was added.

    +
    +
    + +
    +
    +

    Examples of usage

    +

    Below are some examples of typical usage of the bz2 module.

    +

    Using compress() and decompress() to demonstrate round-trip compression:

    +
    >>> import bz2
    +
    +
    +
    >>> data = b"""\
    +... Donec rhoncus quis sapien sit amet molestie. Fusce scelerisque vel augue
    +... nec ullamcorper. Nam rutrum pretium placerat. Aliquam vel tristique lorem,
    +... sit amet cursus ante. In interdum laoreet mi, sit amet ultrices purus
    +... pulvinar a. Nam gravida euismod magna, non varius justo tincidunt feugiat.
    +... Aliquam pharetra lacus non risus vehicula rutrum. Maecenas aliquam leo
    +... felis. Pellentesque semper nunc sit amet nibh ullamcorper, ac elementum
    +... dolor luctus. Curabitur lacinia mi ornare consectetur vestibulum."""
    +
    +
    +
    >>> c = bz2.compress(data)
    +>>> len(data) / len(c)  # Data compression ratio
    +1.513595166163142
    +
    +
    +
    >>> d = bz2.decompress(c)
    +>>> data == d  # Check equality to original object after round-trip
    +True
    +
    +
    +

    Using BZ2Compressor for incremental compression:

    +
    >>> import bz2
    +
    +
    +
    >>> def gen_data(chunks=10, chunksize=1000):
    +...     """Yield incremental blocks of chunksize bytes."""
    +...     for _ in range(chunks):
    +...         yield b"z" * chunksize
    +...
    +>>> comp = bz2.BZ2Compressor()
    +>>> out = b""
    +>>> for chunk in gen_data():
    +...     # Provide data to the compressor object
    +...     out = out + comp.compress(chunk)
    +...
    +>>> # Finish the compression process.  Call this once you have
    +>>> # finished providing data to the compressor.
    +>>> out = out + comp.flush()
    +
    +
    +

    The example above uses a very “nonrandom” stream of data +(a stream of b”z” chunks). Random data tends to compress poorly, +while ordered, repetitive data usually yields a high compression ratio.

    +

    Writing and reading a bzip2-compressed file in binary mode:

    +
    >>> import bz2
    +
    +
    +
    >>> data = b"""\
    +... Donec rhoncus quis sapien sit amet molestie. Fusce scelerisque vel augue
    +... nec ullamcorper. Nam rutrum pretium placerat. Aliquam vel tristique lorem,
    +... sit amet cursus ante. In interdum laoreet mi, sit amet ultrices purus
    +... pulvinar a. Nam gravida euismod magna, non varius justo tincidunt feugiat.
    +... Aliquam pharetra lacus non risus vehicula rutrum. Maecenas aliquam leo
    +... felis. Pellentesque semper nunc sit amet nibh ullamcorper, ac elementum
    +... dolor luctus. Curabitur lacinia mi ornare consectetur vestibulum."""
    +
    +
    +
    >>> with bz2.open("myfile.bz2", "wb") as f:
    +...     # Write compressed data to file
    +...     unused = f.write(data)
    +
    +
    +
    >>> with bz2.open("myfile.bz2", "rb") as f:
    +...     # Decompress data from file
    +...     content = f.read()
    +
    +
    +
    >>> content == data  # Check equality to original object after round-trip
    +True
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/calendar.html b/python-3.7.4-docs-html/library/calendar.html new file mode 100644 index 0000000..02e6bff --- /dev/null +++ b/python-3.7.4-docs-html/library/calendar.html @@ -0,0 +1,640 @@ + + + + + + + calendar — General calendar-related functions — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    calendar — General calendar-related functions

    +

    Source code: Lib/calendar.py

    +
    +

    This module allows you to output calendars like the Unix cal program, +and provides additional useful functions related to the calendar. By default, +these calendars have Monday as the first day of the week, and Sunday as the last +(the European convention). Use setfirstweekday() to set the first day of +the week to Sunday (6) or to any other weekday. Parameters that specify dates +are given as integers. For related +functionality, see also the datetime and time modules.

    +

    The functions and classes defined in this module +use an idealized calendar, the current Gregorian calendar extended indefinitely +in both directions. This matches the definition of the “proleptic Gregorian” +calendar in Dershowitz and Reingold’s book “Calendrical Calculations”, where +it’s the base calendar for all computations. Zero and negative years are +interpreted as prescribed by the ISO 8601 standard. Year 0 is 1 BC, year -1 is +2 BC, and so on.

    +
    +
    +class calendar.Calendar(firstweekday=0)
    +

    Creates a Calendar object. firstweekday is an integer specifying the +first day of the week. 0 is Monday (the default), 6 is Sunday.

    +

    A Calendar object provides several methods that can be used for +preparing the calendar data for formatting. This class doesn’t do any formatting +itself. This is the job of subclasses.

    +

    Calendar instances have the following methods:

    +
    +
    +iterweekdays()
    +

    Return an iterator for the week day numbers that will be used for one +week. The first value from the iterator will be the same as the value of +the firstweekday property.

    +
    + +
    +
    +itermonthdates(year, month)
    +

    Return an iterator for the month month (1–12) in the year year. This +iterator will return all days (as datetime.date objects) for the +month and all days before the start of the month or after the end of the +month that are required to get a complete week.

    +
    + +
    +
    +itermonthdays(year, month)
    +

    Return an iterator for the month month in the year year similar to +itermonthdates(), but not restricted by the datetime.date +range. Days returned will simply be day of the month numbers. For the +days outside of the specified month, the day number is 0.

    +
    + +
    +
    +itermonthdays2(year, month)
    +

    Return an iterator for the month month in the year year similar to +itermonthdates(), but not restricted by the datetime.date +range. Days returned will be tuples consisting of a day of the month +number and a week day number.

    +
    + +
    +
    +itermonthdays3(year, month)
    +

    Return an iterator for the month month in the year year similar to +itermonthdates(), but not restricted by the datetime.date +range. Days returned will be tuples consisting of a year, a month and a day +of the month numbers.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +itermonthdays4(year, month)
    +

    Return an iterator for the month month in the year year similar to +itermonthdates(), but not restricted by the datetime.date +range. Days returned will be tuples consisting of a year, a month, a day +of the month, and a day of the week numbers.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +monthdatescalendar(year, month)
    +

    Return a list of the weeks in the month month of the year as full +weeks. Weeks are lists of seven datetime.date objects.

    +
    + +
    +
    +monthdays2calendar(year, month)
    +

    Return a list of the weeks in the month month of the year as full +weeks. Weeks are lists of seven tuples of day numbers and weekday +numbers.

    +
    + +
    +
    +monthdayscalendar(year, month)
    +

    Return a list of the weeks in the month month of the year as full +weeks. Weeks are lists of seven day numbers.

    +
    + +
    +
    +yeardatescalendar(year, width=3)
    +

    Return the data for the specified year ready for formatting. The return +value is a list of month rows. Each month row contains up to width +months (defaulting to 3). Each month contains between 4 and 6 weeks and +each week contains 1–7 days. Days are datetime.date objects.

    +
    + +
    +
    +yeardays2calendar(year, width=3)
    +

    Return the data for the specified year ready for formatting (similar to +yeardatescalendar()). Entries in the week lists are tuples of day +numbers and weekday numbers. Day numbers outside this month are zero.

    +
    + +
    +
    +yeardayscalendar(year, width=3)
    +

    Return the data for the specified year ready for formatting (similar to +yeardatescalendar()). Entries in the week lists are day numbers. Day +numbers outside this month are zero.

    +
    + +
    + +
    +
    +class calendar.TextCalendar(firstweekday=0)
    +

    This class can be used to generate plain text calendars.

    +

    TextCalendar instances have the following methods:

    +
    +
    +formatmonth(theyear, themonth, w=0, l=0)
    +

    Return a month’s calendar in a multi-line string. If w is provided, it +specifies the width of the date columns, which are centered. If l is +given, it specifies the number of lines that each week will use. Depends +on the first weekday as specified in the constructor or set by the +setfirstweekday() method.

    +
    + +
    +
    +prmonth(theyear, themonth, w=0, l=0)
    +

    Print a month’s calendar as returned by formatmonth().

    +
    + +
    +
    +formatyear(theyear, w=2, l=1, c=6, m=3)
    +

    Return a m-column calendar for an entire year as a multi-line string. +Optional parameters w, l, and c are for date column width, lines per +week, and number of spaces between month columns, respectively. Depends on +the first weekday as specified in the constructor or set by the +setfirstweekday() method. The earliest year for which a calendar +can be generated is platform-dependent.

    +
    + +
    +
    +pryear(theyear, w=2, l=1, c=6, m=3)
    +

    Print the calendar for an entire year as returned by formatyear().

    +
    + +
    + +
    +
    +class calendar.HTMLCalendar(firstweekday=0)
    +

    This class can be used to generate HTML calendars.

    +

    HTMLCalendar instances have the following methods:

    +
    +
    +formatmonth(theyear, themonth, withyear=True)
    +

    Return a month’s calendar as an HTML table. If withyear is true the year +will be included in the header, otherwise just the month name will be +used.

    +
    + +
    +
    +formatyear(theyear, width=3)
    +

    Return a year’s calendar as an HTML table. width (defaulting to 3) +specifies the number of months per row.

    +
    + +
    +
    +formatyearpage(theyear, width=3, css='calendar.css', encoding=None)
    +

    Return a year’s calendar as a complete HTML page. width (defaulting to +3) specifies the number of months per row. css is the name for the +cascading style sheet to be used. None can be passed if no style +sheet should be used. encoding specifies the encoding to be used for the +output (defaulting to the system default encoding).

    +
    + +

    HTMLCalendar has the following attributes you can override to +customize the CSS classes used by the calendar:

    +
    +
    +cssclasses
    +

    A list of CSS classes used for each weekday. The default class list is:

    +
    cssclasses = ["mon", "tue", "wed", "thu", "fri", "sat", "sun"]
    +
    +
    +

    more styles can be added for each day:

    +
    cssclasses = ["mon text-bold", "tue", "wed", "thu", "fri", "sat", "sun red"]
    +
    +
    +

    Note that the length of this list must be seven items.

    +
    + +
    +
    +cssclass_noday
    +

    The CSS class for a weekday occurring in the previous or coming month.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +cssclasses_weekday_head
    +

    A list of CSS classes used for weekday names in the header row. +The default is the same as cssclasses.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +cssclass_month_head
    +

    The month’s head CSS class (used by formatmonthname()). +The default value is "month".

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +cssclass_month
    +

    The CSS class for the whole month’s table (used by formatmonth()). +The default value is "month".

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +cssclass_year
    +

    The CSS class for the whole year’s table of tables (used by +formatyear()). The default value is "year".

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +cssclass_year_head
    +

    The CSS class for the table head for the whole year (used by +formatyear()). The default value is "year".

    +
    +

    New in version 3.7.

    +
    +
    + +

    Note that although the naming for the above described class attributes is +singular (e.g. cssclass_month cssclass_noday), one can replace the +single CSS class with a space separated list of CSS classes, for example:

    +
    "text-bold text-red"
    +
    +
    +

    Here is an example how HTMLCalendar can be customized:

    +
    class CustomHTMLCal(calendar.HTMLCalendar):
    +    cssclasses = [style + " text-nowrap" for style in
    +                  calendar.HTMLCalendar.cssclasses]
    +    cssclass_month_head = "text-center month-head"
    +    cssclass_month = "text-center month"
    +    cssclass_year = "text-italic lead"
    +
    +
    +
    + +
    +
    +class calendar.LocaleTextCalendar(firstweekday=0, locale=None)
    +

    This subclass of TextCalendar can be passed a locale name in the +constructor and will return month and weekday names in the specified locale. +If this locale includes an encoding all strings containing month and weekday +names will be returned as unicode.

    +
    + +
    +
    +class calendar.LocaleHTMLCalendar(firstweekday=0, locale=None)
    +

    This subclass of HTMLCalendar can be passed a locale name in the +constructor and will return month and weekday names in the specified +locale. If this locale includes an encoding all strings containing month and +weekday names will be returned as unicode.

    +
    + +
    +

    Note

    +

    The formatweekday() and formatmonthname() methods of these two +classes temporarily change the current locale to the given locale. Because +the current locale is a process-wide setting, they are not thread-safe.

    +
    +

    For simple text calendars this module provides the following functions.

    +
    +
    +calendar.setfirstweekday(weekday)
    +

    Sets the weekday (0 is Monday, 6 is Sunday) to start each week. The +values MONDAY, TUESDAY, WEDNESDAY, THURSDAY, +FRIDAY, SATURDAY, and SUNDAY are provided for +convenience. For example, to set the first weekday to Sunday:

    +
    import calendar
    +calendar.setfirstweekday(calendar.SUNDAY)
    +
    +
    +
    + +
    +
    +calendar.firstweekday()
    +

    Returns the current setting for the weekday to start each week.

    +
    + +
    +
    +calendar.isleap(year)
    +

    Returns True if year is a leap year, otherwise False.

    +
    + +
    +
    +calendar.leapdays(y1, y2)
    +

    Returns the number of leap years in the range from y1 to y2 (exclusive), +where y1 and y2 are years.

    +

    This function works for ranges spanning a century change.

    +
    + +
    +
    +calendar.weekday(year, month, day)
    +

    Returns the day of the week (0 is Monday) for year (1970–…), +month (112), day (131).

    +
    + +
    +
    +calendar.weekheader(n)
    +

    Return a header containing abbreviated weekday names. n specifies the width in +characters for one weekday.

    +
    + +
    +
    +calendar.monthrange(year, month)
    +

    Returns weekday of first day of the month and number of days in month, for the +specified year and month.

    +
    + +
    +
    +calendar.monthcalendar(year, month)
    +

    Returns a matrix representing a month’s calendar. Each row represents a week; +days outside of the month a represented by zeros. Each week begins with Monday +unless set by setfirstweekday().

    +
    + +
    +
    +calendar.prmonth(theyear, themonth, w=0, l=0)
    +

    Prints a month’s calendar as returned by month().

    +
    + +
    +
    +calendar.month(theyear, themonth, w=0, l=0)
    +

    Returns a month’s calendar in a multi-line string using the formatmonth() +of the TextCalendar class.

    +
    + +
    +
    +calendar.prcal(year, w=0, l=0, c=6, m=3)
    +

    Prints the calendar for an entire year as returned by calendar().

    +
    + +
    +
    +calendar.calendar(year, w=2, l=1, c=6, m=3)
    +

    Returns a 3-column calendar for an entire year as a multi-line string using +the formatyear() of the TextCalendar class.

    +
    + +
    +
    +calendar.timegm(tuple)
    +

    An unrelated but handy function that takes a time tuple such as returned by +the gmtime() function in the time module, and returns the +corresponding Unix timestamp value, assuming an epoch of 1970, and the POSIX +encoding. In fact, time.gmtime() and timegm() are each others’ +inverse.

    +
    + +

    The calendar module exports the following data attributes:

    +
    +
    +calendar.day_name
    +

    An array that represents the days of the week in the current locale.

    +
    + +
    +
    +calendar.day_abbr
    +

    An array that represents the abbreviated days of the week in the current locale.

    +
    + +
    +
    +calendar.month_name
    +

    An array that represents the months of the year in the current locale. This +follows normal convention of January being month number 1, so it has a length of +13 and month_name[0] is the empty string.

    +
    + +
    +
    +calendar.month_abbr
    +

    An array that represents the abbreviated months of the year in the current +locale. This follows normal convention of January being month number 1, so it +has a length of 13 and month_abbr[0] is the empty string.

    +
    + +
    +

    See also

    +
    +
    Module datetime

    Object-oriented interface to dates and times with similar functionality to the +time module.

    +
    +
    Module time

    Low-level time related functions.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/cgi.html b/python-3.7.4-docs-html/library/cgi.html new file mode 100644 index 0000000..615fc96 --- /dev/null +++ b/python-3.7.4-docs-html/library/cgi.html @@ -0,0 +1,676 @@ + + + + + + + cgi — Common Gateway Interface support — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    cgi — Common Gateway Interface support

    +

    Source code: Lib/cgi.py

    +
    +

    Support module for Common Gateway Interface (CGI) scripts.

    +

    This module defines a number of utilities for use by CGI scripts written in +Python.

    +
    +

    Introduction

    +

    A CGI script is invoked by an HTTP server, usually to process user input +submitted through an HTML <FORM> or <ISINDEX> element.

    +

    Most often, CGI scripts live in the server’s special cgi-bin directory. +The HTTP server places all sorts of information about the request (such as the +client’s hostname, the requested URL, the query string, and lots of other +goodies) in the script’s shell environment, executes the script, and sends the +script’s output back to the client.

    +

    The script’s input is connected to the client too, and sometimes the form data +is read this way; at other times the form data is passed via the “query string” +part of the URL. This module is intended to take care of the different cases +and provide a simpler interface to the Python script. It also provides a number +of utilities that help in debugging scripts, and the latest addition is support +for file uploads from a form (if your browser supports it).

    +

    The output of a CGI script should consist of two sections, separated by a blank +line. The first section contains a number of headers, telling the client what +kind of data is following. Python code to generate a minimal header section +looks like this:

    +
    print("Content-Type: text/html")    # HTML is following
    +print()                             # blank line, end of headers
    +
    +
    +

    The second section is usually HTML, which allows the client software to display +nicely formatted text with header, in-line images, etc. Here’s Python code that +prints a simple piece of HTML:

    +
    print("<TITLE>CGI script output</TITLE>")
    +print("<H1>This is my first CGI script</H1>")
    +print("Hello, world!")
    +
    +
    +
    +
    +

    Using the cgi module

    +

    Begin by writing import cgi.

    +

    When you write a new script, consider adding these lines:

    +
    import cgitb
    +cgitb.enable()
    +
    +
    +

    This activates a special exception handler that will display detailed reports in +the Web browser if any errors occur. If you’d rather not show the guts of your +program to users of your script, you can have the reports saved to files +instead, with code like this:

    +
    import cgitb
    +cgitb.enable(display=0, logdir="/path/to/logdir")
    +
    +
    +

    It’s very helpful to use this feature during script development. The reports +produced by cgitb provide information that can save you a lot of time in +tracking down bugs. You can always remove the cgitb line later when you +have tested your script and are confident that it works correctly.

    +

    To get at submitted form data, use the FieldStorage class. If the form +contains non-ASCII characters, use the encoding keyword parameter set to the +value of the encoding defined for the document. It is usually contained in the +META tag in the HEAD section of the HTML document or by the +Content-Type header). This reads the form contents from the +standard input or the environment (depending on the value of various +environment variables set according to the CGI standard). Since it may consume +standard input, it should be instantiated only once.

    +

    The FieldStorage instance can be indexed like a Python dictionary. +It allows membership testing with the in operator, and also supports +the standard dictionary method keys() and the built-in function +len(). Form fields containing empty strings are ignored and do not appear +in the dictionary; to keep such values, provide a true value for the optional +keep_blank_values keyword parameter when creating the FieldStorage +instance.

    +

    For instance, the following code (which assumes that the +Content-Type header and blank line have already been printed) +checks that the fields name and addr are both set to a non-empty +string:

    +
    form = cgi.FieldStorage()
    +if "name" not in form or "addr" not in form:
    +    print("<H1>Error</H1>")
    +    print("Please fill in the name and addr fields.")
    +    return
    +print("<p>name:", form["name"].value)
    +print("<p>addr:", form["addr"].value)
    +...further form processing here...
    +
    +
    +

    Here the fields, accessed through form[key], are themselves instances of +FieldStorage (or MiniFieldStorage, depending on the form +encoding). The value attribute of the instance yields +the string value of the field. The getvalue() method +returns this string value directly; it also accepts an optional second argument +as a default to return if the requested key is not present.

    +

    If the submitted form data contains more than one field with the same name, the +object retrieved by form[key] is not a FieldStorage or +MiniFieldStorage instance but a list of such instances. Similarly, in +this situation, form.getvalue(key) would return a list of strings. If you +expect this possibility (when your HTML form contains multiple fields with the +same name), use the getlist() method, which always returns +a list of values (so that you do not need to special-case the single item +case). For example, this code concatenates any number of username fields, +separated by commas:

    +
    value = form.getlist("username")
    +usernames = ",".join(value)
    +
    +
    +

    If a field represents an uploaded file, accessing the value via the +value attribute or the getvalue() +method reads the entire file in memory as bytes. This may not be what you +want. You can test for an uploaded file by testing either the +filename attribute or the file +attribute. You can then read the data from the file +attribute before it is automatically closed as part of the garbage collection of +the FieldStorage instance +(the read() and readline() methods will +return bytes):

    +
    fileitem = form["userfile"]
    +if fileitem.file:
    +    # It's an uploaded file; count lines
    +    linecount = 0
    +    while True:
    +        line = fileitem.file.readline()
    +        if not line: break
    +        linecount = linecount + 1
    +
    +
    +

    FieldStorage objects also support being used in a with +statement, which will automatically close them when done.

    +

    If an error is encountered when obtaining the contents of an uploaded file +(for example, when the user interrupts the form submission by clicking on +a Back or Cancel button) the done attribute of the +object for the field will be set to the value -1.

    +

    The file upload draft standard entertains the possibility of uploading multiple +files from one field (using a recursive multipart/* encoding). +When this occurs, the item will be a dictionary-like FieldStorage item. +This can be determined by testing its type attribute, which should be +multipart/form-data (or perhaps another MIME type matching +multipart/*). In this case, it can be iterated over recursively +just like the top-level form object.

    +

    When a form is submitted in the “old” format (as the query string or as a single +data part of type application/x-www-form-urlencoded), the items will +actually be instances of the class MiniFieldStorage. In this case, the +list, file, and filename attributes are always None.

    +

    A form submitted via POST that also has a query string will contain both +FieldStorage and MiniFieldStorage items.

    +
    +

    Changed in version 3.4: The file attribute is automatically closed upon the +garbage collection of the creating FieldStorage instance.

    +
    +
    +

    Changed in version 3.5: Added support for the context management protocol to the +FieldStorage class.

    +
    +
    +
    +

    Higher Level Interface

    +

    The previous section explains how to read CGI form data using the +FieldStorage class. This section describes a higher level interface +which was added to this class to allow one to do it in a more readable and +intuitive way. The interface doesn’t make the techniques described in previous +sections obsolete — they are still useful to process file uploads efficiently, +for example.

    +

    The interface consists of two simple methods. Using the methods you can process +form data in a generic way, without the need to worry whether only one or more +values were posted under one name.

    +

    In the previous section, you learned to write following code anytime you +expected a user to post more than one value under one name:

    +
    item = form.getvalue("item")
    +if isinstance(item, list):
    +    # The user is requesting more than one item.
    +else:
    +    # The user is requesting only one item.
    +
    +
    +

    This situation is common for example when a form contains a group of multiple +checkboxes with the same name:

    +
    <input type="checkbox" name="item" value="1" />
    +<input type="checkbox" name="item" value="2" />
    +
    +
    +

    In most situations, however, there’s only one form control with a particular +name in a form and then you expect and need only one value associated with this +name. So you write a script containing for example this code:

    +
    user = form.getvalue("user").upper()
    +
    +
    +

    The problem with the code is that you should never expect that a client will +provide valid input to your scripts. For example, if a curious user appends +another user=foo pair to the query string, then the script would crash, +because in this situation the getvalue("user") method call returns a list +instead of a string. Calling the upper() method on a list is not valid +(since lists do not have a method of this name) and results in an +AttributeError exception.

    +

    Therefore, the appropriate way to read form data values was to always use the +code which checks whether the obtained value is a single value or a list of +values. That’s annoying and leads to less readable scripts.

    +

    A more convenient approach is to use the methods getfirst() +and getlist() provided by this higher level interface.

    +
    +
    +FieldStorage.getfirst(name, default=None)
    +

    This method always returns only one value associated with form field name. +The method returns only the first value in case that more values were posted +under such name. Please note that the order in which the values are received +may vary from browser to browser and should not be counted on. 1 If no such +form field or value exists then the method returns the value specified by the +optional parameter default. This parameter defaults to None if not +specified.

    +
    + +
    +
    +FieldStorage.getlist(name)
    +

    This method always returns a list of values associated with form field name. +The method returns an empty list if no such form field or value exists for +name. It returns a list consisting of one item if only one such value exists.

    +
    + +

    Using these methods you can write nice compact code:

    +
    import cgi
    +form = cgi.FieldStorage()
    +user = form.getfirst("user", "").upper()    # This way it's safe.
    +for item in form.getlist("item"):
    +    do_something(item)
    +
    +
    +
    +
    +

    Functions

    +

    These are useful if you want more control, or if you want to employ some of the +algorithms implemented in this module in other circumstances.

    +
    +
    +cgi.parse(fp=None, environ=os.environ, keep_blank_values=False, strict_parsing=False)
    +

    Parse a query in the environment or from a file (the file defaults to +sys.stdin). The keep_blank_values and strict_parsing parameters are +passed to urllib.parse.parse_qs() unchanged.

    +
    + +
    +
    +cgi.parse_qs(qs, keep_blank_values=False, strict_parsing=False)
    +

    This function is deprecated in this module. Use urllib.parse.parse_qs() +instead. It is maintained here only for backward compatibility.

    +
    + +
    +
    +cgi.parse_qsl(qs, keep_blank_values=False, strict_parsing=False)
    +

    This function is deprecated in this module. Use urllib.parse.parse_qsl() +instead. It is maintained here only for backward compatibility.

    +
    + +
    +
    +cgi.parse_multipart(fp, pdict, encoding="utf-8", errors="replace")
    +

    Parse input of type multipart/form-data (for file uploads). +Arguments are fp for the input file, pdict for a dictionary containing +other parameters in the Content-Type header, and encoding, +the request encoding.

    +

    Returns a dictionary just like urllib.parse.parse_qs(): keys are the +field names, each value is a list of values for that field. For non-file +fields, the value is a list of strings.

    +

    This is easy to use but not much good if you are expecting megabytes to be +uploaded — in that case, use the FieldStorage class instead +which is much more flexible.

    +
    +

    Changed in version 3.7: Added the encoding and errors parameters. For non-file fields, the +value is now a list of strings, not bytes.

    +
    +
    + +
    +
    +cgi.parse_header(string)
    +

    Parse a MIME header (such as Content-Type) into a main value and a +dictionary of parameters.

    +
    + +
    +
    +cgi.test()
    +

    Robust test CGI script, usable as main program. Writes minimal HTTP headers and +formats all information provided to the script in HTML form.

    +
    + +
    +
    +cgi.print_environ()
    +

    Format the shell environment in HTML.

    +
    + +
    +
    +cgi.print_form(form)
    +

    Format a form in HTML.

    +
    + +
    +
    +cgi.print_directory()
    +

    Format the current directory in HTML.

    +
    + +
    +
    +cgi.print_environ_usage()
    +

    Print a list of useful (used by CGI) environment variables in HTML.

    +
    + +
    +
    +cgi.escape(s, quote=False)
    +

    Convert the characters '&', '<' and '>' in string s to HTML-safe +sequences. Use this if you need to display text that might contain such +characters in HTML. If the optional flag quote is true, the quotation mark +character (") is also translated; this helps for inclusion in an HTML +attribute value delimited by double quotes, as in <a href="...">. Note +that single quotes are never translated.

    +
    +

    Deprecated since version 3.2: This function is unsafe because quote is false by default, and therefore +deprecated. Use html.escape() instead.

    +
    +
    + +
    +
    +

    Caring about security

    +

    There’s one important rule: if you invoke an external program (via the +os.system() or os.popen() functions. or others with similar +functionality), make very sure you don’t pass arbitrary strings received from +the client to the shell. This is a well-known security hole whereby clever +hackers anywhere on the Web can exploit a gullible CGI script to invoke +arbitrary shell commands. Even parts of the URL or field names cannot be +trusted, since the request doesn’t have to come from your form!

    +

    To be on the safe side, if you must pass a string gotten from a form to a shell +command, you should make sure the string contains only alphanumeric characters, +dashes, underscores, and periods.

    +
    +
    +

    Installing your CGI script on a Unix system

    +

    Read the documentation for your HTTP server and check with your local system +administrator to find the directory where CGI scripts should be installed; +usually this is in a directory cgi-bin in the server tree.

    +

    Make sure that your script is readable and executable by “others”; the Unix file +mode should be 0o755 octal (use chmod 0755 filename). Make sure that the +first line of the script contains #! starting in column 1 followed by the +pathname of the Python interpreter, for instance:

    +
    #!/usr/local/bin/python
    +
    +
    +

    Make sure the Python interpreter exists and is executable by “others”.

    +

    Make sure that any files your script needs to read or write are readable or +writable, respectively, by “others” — their mode should be 0o644 for +readable and 0o666 for writable. This is because, for security reasons, the +HTTP server executes your script as user “nobody”, without any special +privileges. It can only read (write, execute) files that everybody can read +(write, execute). The current directory at execution time is also different (it +is usually the server’s cgi-bin directory) and the set of environment variables +is also different from what you get when you log in. In particular, don’t count +on the shell’s search path for executables (PATH) or the Python module +search path (PYTHONPATH) to be set to anything interesting.

    +

    If you need to load modules from a directory which is not on Python’s default +module search path, you can change the path in your script, before importing +other modules. For example:

    +
    import sys
    +sys.path.insert(0, "/usr/home/joe/lib/python")
    +sys.path.insert(0, "/usr/local/lib/python")
    +
    +
    +

    (This way, the directory inserted last will be searched first!)

    +

    Instructions for non-Unix systems will vary; check your HTTP server’s +documentation (it will usually have a section on CGI scripts).

    +
    +
    +

    Testing your CGI script

    +

    Unfortunately, a CGI script will generally not run when you try it from the +command line, and a script that works perfectly from the command line may fail +mysteriously when run from the server. There’s one reason why you should still +test your script from the command line: if it contains a syntax error, the +Python interpreter won’t execute it at all, and the HTTP server will most likely +send a cryptic error to the client.

    +

    Assuming your script has no syntax errors, yet it does not work, you have no +choice but to read the next section.

    +
    +
    +

    Debugging CGI scripts

    +

    First of all, check for trivial installation errors — reading the section +above on installing your CGI script carefully can save you a lot of time. If +you wonder whether you have understood the installation procedure correctly, try +installing a copy of this module file (cgi.py) as a CGI script. When +invoked as a script, the file will dump its environment and the contents of the +form in HTML form. Give it the right mode etc, and send it a request. If it’s +installed in the standard cgi-bin directory, it should be possible to +send it a request by entering a URL into your browser of the form:

    +
    http://yourhostname/cgi-bin/cgi.py?name=Joe+Blow&addr=At+Home
    +
    +
    +

    If this gives an error of type 404, the server cannot find the script – perhaps +you need to install it in a different directory. If it gives another error, +there’s an installation problem that you should fix before trying to go any +further. If you get a nicely formatted listing of the environment and form +content (in this example, the fields should be listed as “addr” with value “At +Home” and “name” with value “Joe Blow”), the cgi.py script has been +installed correctly. If you follow the same procedure for your own script, you +should now be able to debug it.

    +

    The next step could be to call the cgi module’s test() function +from your script: replace its main code with the single statement

    +
    cgi.test()
    +
    +
    +

    This should produce the same results as those gotten from installing the +cgi.py file itself.

    +

    When an ordinary Python script raises an unhandled exception (for whatever +reason: of a typo in a module name, a file that can’t be opened, etc.), the +Python interpreter prints a nice traceback and exits. While the Python +interpreter will still do this when your CGI script raises an exception, most +likely the traceback will end up in one of the HTTP server’s log files, or be +discarded altogether.

    +

    Fortunately, once you have managed to get your script to execute some code, +you can easily send tracebacks to the Web browser using the cgitb module. +If you haven’t done so already, just add the lines:

    +
    import cgitb
    +cgitb.enable()
    +
    +
    +

    to the top of your script. Then try running it again; when a problem occurs, +you should see a detailed report that will likely make apparent the cause of the +crash.

    +

    If you suspect that there may be a problem in importing the cgitb module, +you can use an even more robust approach (which only uses built-in modules):

    +
    import sys
    +sys.stderr = sys.stdout
    +print("Content-Type: text/plain")
    +print()
    +...your code here...
    +
    +
    +

    This relies on the Python interpreter to print the traceback. The content type +of the output is set to plain text, which disables all HTML processing. If your +script works, the raw HTML will be displayed by your client. If it raises an +exception, most likely after the first two lines have been printed, a traceback +will be displayed. Because no HTML interpretation is going on, the traceback +will be readable.

    +
    +
    +

    Common problems and solutions

    +
      +
    • Most HTTP servers buffer the output from CGI scripts until the script is +completed. This means that it is not possible to display a progress report on +the client’s display while the script is running.

    • +
    • Check the installation instructions above.

    • +
    • Check the HTTP server’s log files. (tail -f logfile in a separate window +may be useful!)

    • +
    • Always check a script for syntax errors first, by doing something like +python script.py.

    • +
    • If your script does not have any syntax errors, try adding import cgitb; +cgitb.enable() to the top of the script.

    • +
    • When invoking external programs, make sure they can be found. Usually, this +means using absolute path names — PATH is usually not set to a very +useful value in a CGI script.

    • +
    • When reading or writing external files, make sure they can be read or written +by the userid under which your CGI script will be running: this is typically the +userid under which the web server is running, or some explicitly specified +userid for a web server’s suexec feature.

    • +
    • Don’t try to give a CGI script a set-uid mode. This doesn’t work on most +systems, and is a security liability as well.

    • +
    +

    Footnotes

    +
    +
    1
    +

    Note that some recent versions of the HTML specification do state what +order the field values should be supplied in, but knowing whether a request +was received from a conforming browser, or even from a browser at all, is +tedious and error-prone.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/cgitb.html b/python-3.7.4-docs-html/library/cgitb.html new file mode 100644 index 0000000..d528dfe --- /dev/null +++ b/python-3.7.4-docs-html/library/cgitb.html @@ -0,0 +1,249 @@ + + + + + + + cgitb — Traceback manager for CGI scripts — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    cgitb — Traceback manager for CGI scripts

    +

    Source code: Lib/cgitb.py

    +
    +

    The cgitb module provides a special exception handler for Python scripts. +(Its name is a bit misleading. It was originally designed to display extensive +traceback information in HTML for CGI scripts. It was later generalized to also +display this information in plain text.) After this module is activated, if an +uncaught exception occurs, a detailed, formatted report will be displayed. The +report includes a traceback showing excerpts of the source code for each level, +as well as the values of the arguments and local variables to currently running +functions, to help you debug the problem. Optionally, you can save this +information to a file instead of sending it to the browser.

    +

    To enable this feature, simply add this to the top of your CGI script:

    +
    import cgitb
    +cgitb.enable()
    +
    +
    +

    The options to the enable() function control whether the report is +displayed in the browser and whether the report is logged to a file for later +analysis.

    +
    +
    +cgitb.enable(display=1, logdir=None, context=5, format="html")
    +

    This function causes the cgitb module to take over the interpreter’s +default handling for exceptions by setting the value of sys.excepthook.

    +

    The optional argument display defaults to 1 and can be set to 0 to +suppress sending the traceback to the browser. If the argument logdir is +present, the traceback reports are written to files. The value of logdir +should be a directory where these files will be placed. The optional argument +context is the number of lines of context to display around the current line +of source code in the traceback; this defaults to 5. If the optional +argument format is "html", the output is formatted as HTML. Any other +value forces plain text output. The default value is "html".

    +
    + +
    +
    +cgitb.text(info, context=5)
    +

    This function handles the exception described by info (a 3-tuple containing +the result of sys.exc_info()), formatting its traceback as text and +returning the result as a string. The optional argument context is the +number of lines of context to display around the current line of source code +in the traceback; this defaults to 5.

    +
    + +
    +
    +cgitb.html(info, context=5)
    +

    This function handles the exception described by info (a 3-tuple containing +the result of sys.exc_info()), formatting its traceback as HTML and +returning the result as a string. The optional argument context is the +number of lines of context to display around the current line of source code +in the traceback; this defaults to 5.

    +
    + +
    +
    +cgitb.handler(info=None)
    +

    This function handles an exception using the default settings (that is, show a +report in the browser, but don’t log to a file). This can be used when you’ve +caught an exception and want to report it using cgitb. The optional +info argument should be a 3-tuple containing an exception type, exception +value, and traceback object, exactly like the tuple returned by +sys.exc_info(). If the info argument is not supplied, the current +exception is obtained from sys.exc_info().

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/chunk.html b/python-3.7.4-docs-html/library/chunk.html new file mode 100644 index 0000000..b92e3e6 --- /dev/null +++ b/python-3.7.4-docs-html/library/chunk.html @@ -0,0 +1,324 @@ + + + + + + + chunk — Read IFF chunked data — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    chunk — Read IFF chunked data

    +

    Source code: Lib/chunk.py

    +
    +

    This module provides an interface for reading files that use EA IFF 85 chunks. +1 This format is used in at least the Audio Interchange File Format +(AIFF/AIFF-C) and the Real Media File Format (RMFF). The WAVE audio file format +is closely related and can also be read using this module.

    +

    A chunk has the following structure:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + +

    Offset

    Length

    Contents

    0

    4

    Chunk ID

    4

    4

    Size of chunk in big-endian +byte order, not including the +header

    8

    n

    Data bytes, where n is the +size given in the preceding +field

    8 + n

    0 or 1

    Pad byte needed if n is odd +and chunk alignment is used

    +

    The ID is a 4-byte string which identifies the type of chunk.

    +

    The size field (a 32-bit value, encoded using big-endian byte order) gives the +size of the chunk data, not including the 8-byte header.

    +

    Usually an IFF-type file consists of one or more chunks. The proposed usage of +the Chunk class defined here is to instantiate an instance at the start +of each chunk and read from the instance until it reaches the end, after which a +new instance can be instantiated. At the end of the file, creating a new +instance will fail with an EOFError exception.

    +
    +
    +class chunk.Chunk(file, align=True, bigendian=True, inclheader=False)
    +

    Class which represents a chunk. The file argument is expected to be a +file-like object. An instance of this class is specifically allowed. The +only method that is needed is read(). If the methods +seek() and tell() are present and don’t +raise an exception, they are also used. +If these methods are present and raise an exception, they are expected to not +have altered the object. If the optional argument align is true, chunks +are assumed to be aligned on 2-byte boundaries. If align is false, no +alignment is assumed. The default value is true. If the optional argument +bigendian is false, the chunk size is assumed to be in little-endian order. +This is needed for WAVE audio files. The default value is true. If the +optional argument inclheader is true, the size given in the chunk header +includes the size of the header. The default value is false.

    +

    A Chunk object supports the following methods:

    +
    +
    +getname()
    +

    Returns the name (ID) of the chunk. This is the first 4 bytes of the +chunk.

    +
    + +
    +
    +getsize()
    +

    Returns the size of the chunk.

    +
    + +
    +
    +close()
    +

    Close and skip to the end of the chunk. This does not close the +underlying file.

    +
    + +

    The remaining methods will raise OSError if called after the +close() method has been called. Before Python 3.3, they used to +raise IOError, now an alias of OSError.

    +
    +
    +isatty()
    +

    Returns False.

    +
    + +
    +
    +seek(pos, whence=0)
    +

    Set the chunk’s current position. The whence argument is optional and +defaults to 0 (absolute file positioning); other values are 1 +(seek relative to the current position) and 2 (seek relative to the +file’s end). There is no return value. If the underlying file does not +allow seek, only forward seeks are allowed.

    +
    + +
    +
    +tell()
    +

    Return the current position into the chunk.

    +
    + +
    +
    +read(size=-1)
    +

    Read at most size bytes from the chunk (less if the read hits the end of +the chunk before obtaining size bytes). If the size argument is +negative or omitted, read all data until the end of the chunk. An empty +bytes object is returned when the end of the chunk is encountered +immediately.

    +
    + +
    +
    +skip()
    +

    Skip to the end of the chunk. All further calls to read() for the +chunk will return b''. If you are not interested in the contents of +the chunk, this method should be called so that the file points to the +start of the next chunk.

    +
    + +
    + +

    Footnotes

    +
    +
    1
    +

    “EA IFF 85” Standard for Interchange Format Files, Jerry Morrison, Electronic +Arts, January 1985.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/cmath.html b/python-3.7.4-docs-html/library/cmath.html new file mode 100644 index 0000000..ebcbec0 --- /dev/null +++ b/python-3.7.4-docs-html/library/cmath.html @@ -0,0 +1,529 @@ + + + + + + + cmath — Mathematical functions for complex numbers — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    cmath — Mathematical functions for complex numbers

    +
    +

    This module provides access to mathematical functions for complex numbers. The +functions in this module accept integers, floating-point numbers or complex +numbers as arguments. They will also accept any Python object that has either a +__complex__() or a __float__() method: these methods are used to +convert the object to a complex or floating-point number, respectively, and +the function is then applied to the result of the conversion.

    +
    +

    Note

    +

    On platforms with hardware and system-level support for signed +zeros, functions involving branch cuts are continuous on both +sides of the branch cut: the sign of the zero distinguishes one +side of the branch cut from the other. On platforms that do not +support signed zeros the continuity is as specified below.

    +
    +
    +

    Conversions to and from polar coordinates

    +

    A Python complex number z is stored internally using rectangular +or Cartesian coordinates. It is completely determined by its real +part z.real and its imaginary part z.imag. In other +words:

    +
    z == z.real + z.imag*1j
    +
    +
    +

    Polar coordinates give an alternative way to represent a complex +number. In polar coordinates, a complex number z is defined by the +modulus r and the phase angle phi. The modulus r is the distance +from z to the origin, while the phase phi is the counterclockwise +angle, measured in radians, from the positive x-axis to the line +segment that joins the origin to z.

    +

    The following functions can be used to convert from the native +rectangular coordinates to polar coordinates and back.

    +
    +
    +cmath.phase(x)
    +

    Return the phase of x (also known as the argument of x), as a +float. phase(x) is equivalent to math.atan2(x.imag, +x.real). The result lies in the range [-π, π], and the branch +cut for this operation lies along the negative real axis, +continuous from above. On systems with support for signed zeros +(which includes most systems in current use), this means that the +sign of the result is the same as the sign of x.imag, even when +x.imag is zero:

    +
    >>> phase(complex(-1.0, 0.0))
    +3.141592653589793
    +>>> phase(complex(-1.0, -0.0))
    +-3.141592653589793
    +
    +
    +
    + +
    +

    Note

    +

    The modulus (absolute value) of a complex number x can be +computed using the built-in abs() function. There is no +separate cmath module function for this operation.

    +
    +
    +
    +cmath.polar(x)
    +

    Return the representation of x in polar coordinates. Returns a +pair (r, phi) where r is the modulus of x and phi is the +phase of x. polar(x) is equivalent to (abs(x), +phase(x)).

    +
    + +
    +
    +cmath.rect(r, phi)
    +

    Return the complex number x with polar coordinates r and phi. +Equivalent to r * (math.cos(phi) + math.sin(phi)*1j).

    +
    + +
    +
    +

    Power and logarithmic functions

    +
    +
    +cmath.exp(x)
    +

    Return e raised to the power x, where e is the base of natural +logarithms.

    +
    + +
    +
    +cmath.log(x[, base])
    +

    Returns the logarithm of x to the given base. If the base is not +specified, returns the natural logarithm of x. There is one branch cut, from 0 +along the negative real axis to -∞, continuous from above.

    +
    + +
    +
    +cmath.log10(x)
    +

    Return the base-10 logarithm of x. This has the same branch cut as +log().

    +
    + +
    +
    +cmath.sqrt(x)
    +

    Return the square root of x. This has the same branch cut as log().

    +
    + +
    +
    +

    Trigonometric functions

    +
    +
    +cmath.acos(x)
    +

    Return the arc cosine of x. There are two branch cuts: One extends right from +1 along the real axis to ∞, continuous from below. The other extends left from +-1 along the real axis to -∞, continuous from above.

    +
    + +
    +
    +cmath.asin(x)
    +

    Return the arc sine of x. This has the same branch cuts as acos().

    +
    + +
    +
    +cmath.atan(x)
    +

    Return the arc tangent of x. There are two branch cuts: One extends from +1j along the imaginary axis to ∞j, continuous from the right. The +other extends from -1j along the imaginary axis to -∞j, continuous +from the left.

    +
    + +
    +
    +cmath.cos(x)
    +

    Return the cosine of x.

    +
    + +
    +
    +cmath.sin(x)
    +

    Return the sine of x.

    +
    + +
    +
    +cmath.tan(x)
    +

    Return the tangent of x.

    +
    + +
    +
    +

    Hyperbolic functions

    +
    +
    +cmath.acosh(x)
    +

    Return the inverse hyperbolic cosine of x. There is one branch cut, +extending left from 1 along the real axis to -∞, continuous from above.

    +
    + +
    +
    +cmath.asinh(x)
    +

    Return the inverse hyperbolic sine of x. There are two branch cuts: +One extends from 1j along the imaginary axis to ∞j, +continuous from the right. The other extends from -1j along +the imaginary axis to -∞j, continuous from the left.

    +
    + +
    +
    +cmath.atanh(x)
    +

    Return the inverse hyperbolic tangent of x. There are two branch cuts: One +extends from 1 along the real axis to , continuous from below. The +other extends from -1 along the real axis to -∞, continuous from +above.

    +
    + +
    +
    +cmath.cosh(x)
    +

    Return the hyperbolic cosine of x.

    +
    + +
    +
    +cmath.sinh(x)
    +

    Return the hyperbolic sine of x.

    +
    + +
    +
    +cmath.tanh(x)
    +

    Return the hyperbolic tangent of x.

    +
    + +
    +
    +

    Classification functions

    +
    +
    +cmath.isfinite(x)
    +

    Return True if both the real and imaginary parts of x are finite, and +False otherwise.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +cmath.isinf(x)
    +

    Return True if either the real or the imaginary part of x is an +infinity, and False otherwise.

    +
    + +
    +
    +cmath.isnan(x)
    +

    Return True if either the real or the imaginary part of x is a NaN, +and False otherwise.

    +
    + +
    +
    +cmath.isclose(a, b, *, rel_tol=1e-09, abs_tol=0.0)
    +

    Return True if the values a and b are close to each other and +False otherwise.

    +

    Whether or not two values are considered close is determined according to +given absolute and relative tolerances.

    +

    rel_tol is the relative tolerance – it is the maximum allowed difference +between a and b, relative to the larger absolute value of a or b. +For example, to set a tolerance of 5%, pass rel_tol=0.05. The default +tolerance is 1e-09, which assures that the two values are the same +within about 9 decimal digits. rel_tol must be greater than zero.

    +

    abs_tol is the minimum absolute tolerance – useful for comparisons near +zero. abs_tol must be at least zero.

    +

    If no errors occur, the result will be: +abs(a-b) <= max(rel_tol * max(abs(a), abs(b)), abs_tol).

    +

    The IEEE 754 special values of NaN, inf, and -inf will be +handled according to IEEE rules. Specifically, NaN is not considered +close to any other value, including NaN. inf and -inf are only +considered close to themselves.

    +
    +

    New in version 3.5.

    +
    +
    +

    See also

    +

    PEP 485 – A function for testing approximate equality

    +
    +
    + +
    +
    +

    Constants

    +
    +
    +cmath.pi
    +

    The mathematical constant π, as a float.

    +
    + +
    +
    +cmath.e
    +

    The mathematical constant e, as a float.

    +
    + +
    +
    +cmath.tau
    +

    The mathematical constant τ, as a float.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +cmath.inf
    +

    Floating-point positive infinity. Equivalent to float('inf').

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +cmath.infj
    +

    Complex number with zero real part and positive infinity imaginary +part. Equivalent to complex(0.0, float('inf')).

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +cmath.nan
    +

    A floating-point “not a number” (NaN) value. Equivalent to +float('nan').

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +cmath.nanj
    +

    Complex number with zero real part and NaN imaginary part. Equivalent to +complex(0.0, float('nan')).

    +
    +

    New in version 3.6.

    +
    +
    + +

    Note that the selection of functions is similar, but not identical, to that in +module math. The reason for having two modules is that some users aren’t +interested in complex numbers, and perhaps don’t even know what they are. They +would rather have math.sqrt(-1) raise an exception than return a complex +number. Also note that the functions defined in cmath always return a +complex number, even if the answer can be expressed as a real number (in which +case the complex number has an imaginary part of zero).

    +

    A note on branch cuts: They are curves along which the given function fails to +be continuous. They are a necessary feature of many complex functions. It is +assumed that if you need to compute with complex functions, you will understand +about branch cuts. Consult almost any (not too elementary) book on complex +variables for enlightenment. For information of the proper choice of branch +cuts for numerical purposes, a good reference should be the following:

    +
    +

    See also

    +

    Kahan, W: Branch cuts for complex elementary functions; or, Much ado about +nothing’s sign bit. In Iserles, A., and Powell, M. (eds.), The state of the art +in numerical analysis. Clarendon Press (1987) pp165–211.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/cmd.html b/python-3.7.4-docs-html/library/cmd.html new file mode 100644 index 0000000..d13bea0 --- /dev/null +++ b/python-3.7.4-docs-html/library/cmd.html @@ -0,0 +1,554 @@ + + + + + + + cmd — Support for line-oriented command interpreters — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    cmd — Support for line-oriented command interpreters

    +

    Source code: Lib/cmd.py

    +
    +

    The Cmd class provides a simple framework for writing line-oriented +command interpreters. These are often useful for test harnesses, administrative +tools, and prototypes that will later be wrapped in a more sophisticated +interface.

    +
    +
    +class cmd.Cmd(completekey='tab', stdin=None, stdout=None)
    +

    A Cmd instance or subclass instance is a line-oriented interpreter +framework. There is no good reason to instantiate Cmd itself; rather, +it’s useful as a superclass of an interpreter class you define yourself in order +to inherit Cmd’s methods and encapsulate action methods.

    +

    The optional argument completekey is the readline name of a completion +key; it defaults to Tab. If completekey is not None and +readline is available, command completion is done automatically.

    +

    The optional arguments stdin and stdout specify the input and output file +objects that the Cmd instance or subclass instance will use for input and +output. If not specified, they will default to sys.stdin and +sys.stdout.

    +

    If you want a given stdin to be used, make sure to set the instance’s +use_rawinput attribute to False, otherwise stdin will be +ignored.

    +
    + +
    +

    Cmd Objects

    +

    A Cmd instance has the following methods:

    +
    +
    +Cmd.cmdloop(intro=None)
    +

    Repeatedly issue a prompt, accept input, parse an initial prefix off the +received input, and dispatch to action methods, passing them the remainder of +the line as argument.

    +

    The optional argument is a banner or intro string to be issued before the first +prompt (this overrides the intro class attribute).

    +

    If the readline module is loaded, input will automatically inherit +bash-like history-list editing (e.g. Control-P scrolls back +to the last command, Control-N forward to the next one, Control-F +moves the cursor to the right non-destructively, Control-B moves the +cursor to the left non-destructively, etc.).

    +

    An end-of-file on input is passed back as the string 'EOF'.

    +

    An interpreter instance will recognize a command name foo if and only if it +has a method do_foo(). As a special case, a line beginning with the +character '?' is dispatched to the method do_help(). As another +special case, a line beginning with the character '!' is dispatched to the +method do_shell() (if such a method is defined).

    +

    This method will return when the postcmd() method returns a true value. +The stop argument to postcmd() is the return value from the command’s +corresponding do_*() method.

    +

    If completion is enabled, completing commands will be done automatically, and +completing of commands args is done by calling complete_foo() with +arguments text, line, begidx, and endidx. text is the string prefix +we are attempting to match: all returned matches must begin with it. line is +the current input line with leading whitespace removed, begidx and endidx +are the beginning and ending indexes of the prefix text, which could be used to +provide different completion depending upon which position the argument is in.

    +

    All subclasses of Cmd inherit a predefined do_help(). This +method, called with an argument 'bar', invokes the corresponding method +help_bar(), and if that is not present, prints the docstring of +do_bar(), if available. With no argument, do_help() lists all +available help topics (that is, all commands with corresponding +help_*() methods or commands that have docstrings), and also lists any +undocumented commands.

    +
    + +
    +
    +Cmd.onecmd(str)
    +

    Interpret the argument as though it had been typed in response to the prompt. +This may be overridden, but should not normally need to be; see the +precmd() and postcmd() methods for useful execution hooks. The +return value is a flag indicating whether interpretation of commands by the +interpreter should stop. If there is a do_*() method for the command +str, the return value of that method is returned, otherwise the return value +from the default() method is returned.

    +
    + +
    +
    +Cmd.emptyline()
    +

    Method called when an empty line is entered in response to the prompt. If this +method is not overridden, it repeats the last nonempty command entered.

    +
    + +
    +
    +Cmd.default(line)
    +

    Method called on an input line when the command prefix is not recognized. If +this method is not overridden, it prints an error message and returns.

    +
    + +
    +
    +Cmd.completedefault(text, line, begidx, endidx)
    +

    Method called to complete an input line when no command-specific +complete_*() method is available. By default, it returns an empty list.

    +
    + +
    +
    +Cmd.precmd(line)
    +

    Hook method executed just before the command line line is interpreted, but +after the input prompt is generated and issued. This method is a stub in +Cmd; it exists to be overridden by subclasses. The return value is +used as the command which will be executed by the onecmd() method; the +precmd() implementation may re-write the command or simply return line +unchanged.

    +
    + +
    +
    +Cmd.postcmd(stop, line)
    +

    Hook method executed just after a command dispatch is finished. This method is +a stub in Cmd; it exists to be overridden by subclasses. line is the +command line which was executed, and stop is a flag which indicates whether +execution will be terminated after the call to postcmd(); this will be the +return value of the onecmd() method. The return value of this method will +be used as the new value for the internal flag which corresponds to stop; +returning false will cause interpretation to continue.

    +
    + +
    +
    +Cmd.preloop()
    +

    Hook method executed once when cmdloop() is called. This method is a stub +in Cmd; it exists to be overridden by subclasses.

    +
    + +
    +
    +Cmd.postloop()
    +

    Hook method executed once when cmdloop() is about to return. This method +is a stub in Cmd; it exists to be overridden by subclasses.

    +
    + +

    Instances of Cmd subclasses have some public instance variables:

    +
    +
    +Cmd.prompt
    +

    The prompt issued to solicit input.

    +
    + +
    +
    +Cmd.identchars
    +

    The string of characters accepted for the command prefix.

    +
    + +
    +
    +Cmd.lastcmd
    +

    The last nonempty command prefix seen.

    +
    + +
    +
    +Cmd.cmdqueue
    +

    A list of queued input lines. The cmdqueue list is checked in +cmdloop() when new input is needed; if it is nonempty, its elements +will be processed in order, as if entered at the prompt.

    +
    + +
    +
    +Cmd.intro
    +

    A string to issue as an intro or banner. May be overridden by giving the +cmdloop() method an argument.

    +
    + +
    +
    +Cmd.doc_header
    +

    The header to issue if the help output has a section for documented commands.

    +
    + +
    +
    +Cmd.misc_header
    +

    The header to issue if the help output has a section for miscellaneous help +topics (that is, there are help_*() methods without corresponding +do_*() methods).

    +
    + +
    +
    +Cmd.undoc_header
    +

    The header to issue if the help output has a section for undocumented commands +(that is, there are do_*() methods without corresponding help_*() +methods).

    +
    + +
    +
    +Cmd.ruler
    +

    The character used to draw separator lines under the help-message headers. If +empty, no ruler line is drawn. It defaults to '='.

    +
    + +
    +
    +Cmd.use_rawinput
    +

    A flag, defaulting to true. If true, cmdloop() uses input() to +display a prompt and read the next command; if false, sys.stdout.write() +and sys.stdin.readline() are used. (This means that by importing +readline, on systems that support it, the interpreter will automatically +support Emacs-like line editing and command-history keystrokes.)

    +
    + +
    +
    +

    Cmd Example

    +

    The cmd module is mainly useful for building custom shells that let a +user work with a program interactively.

    +

    This section presents a simple example of how to build a shell around a few of +the commands in the turtle module.

    +

    Basic turtle commands such as forward() are added to a +Cmd subclass with method named do_forward(). The argument is +converted to a number and dispatched to the turtle module. The docstring is +used in the help utility provided by the shell.

    +

    The example also includes a basic record and playback facility implemented with +the precmd() method which is responsible for converting the input to +lowercase and writing the commands to a file. The do_playback() method +reads the file and adds the recorded commands to the cmdqueue for +immediate playback:

    +
    import cmd, sys
    +from turtle import *
    +
    +class TurtleShell(cmd.Cmd):
    +    intro = 'Welcome to the turtle shell.   Type help or ? to list commands.\n'
    +    prompt = '(turtle) '
    +    file = None
    +
    +    # ----- basic turtle commands -----
    +    def do_forward(self, arg):
    +        'Move the turtle forward by the specified distance:  FORWARD 10'
    +        forward(*parse(arg))
    +    def do_right(self, arg):
    +        'Turn turtle right by given number of degrees:  RIGHT 20'
    +        right(*parse(arg))
    +    def do_left(self, arg):
    +        'Turn turtle left by given number of degrees:  LEFT 90'
    +        left(*parse(arg))
    +    def do_goto(self, arg):
    +        'Move turtle to an absolute position with changing orientation.  GOTO 100 200'
    +        goto(*parse(arg))
    +    def do_home(self, arg):
    +        'Return turtle to the home position:  HOME'
    +        home()
    +    def do_circle(self, arg):
    +        'Draw circle with given radius an options extent and steps:  CIRCLE 50'
    +        circle(*parse(arg))
    +    def do_position(self, arg):
    +        'Print the current turtle position:  POSITION'
    +        print('Current position is %d %d\n' % position())
    +    def do_heading(self, arg):
    +        'Print the current turtle heading in degrees:  HEADING'
    +        print('Current heading is %d\n' % (heading(),))
    +    def do_color(self, arg):
    +        'Set the color:  COLOR BLUE'
    +        color(arg.lower())
    +    def do_undo(self, arg):
    +        'Undo (repeatedly) the last turtle action(s):  UNDO'
    +    def do_reset(self, arg):
    +        'Clear the screen and return turtle to center:  RESET'
    +        reset()
    +    def do_bye(self, arg):
    +        'Stop recording, close the turtle window, and exit:  BYE'
    +        print('Thank you for using Turtle')
    +        self.close()
    +        bye()
    +        return True
    +
    +    # ----- record and playback -----
    +    def do_record(self, arg):
    +        'Save future commands to filename:  RECORD rose.cmd'
    +        self.file = open(arg, 'w')
    +    def do_playback(self, arg):
    +        'Playback commands from a file:  PLAYBACK rose.cmd'
    +        self.close()
    +        with open(arg) as f:
    +            self.cmdqueue.extend(f.read().splitlines())
    +    def precmd(self, line):
    +        line = line.lower()
    +        if self.file and 'playback' not in line:
    +            print(line, file=self.file)
    +        return line
    +    def close(self):
    +        if self.file:
    +            self.file.close()
    +            self.file = None
    +
    +def parse(arg):
    +    'Convert a series of zero or more numbers to an argument tuple'
    +    return tuple(map(int, arg.split()))
    +
    +if __name__ == '__main__':
    +    TurtleShell().cmdloop()
    +
    +
    +

    Here is a sample session with the turtle shell showing the help functions, using +blank lines to repeat commands, and the simple record and playback facility:

    +
    Welcome to the turtle shell.   Type help or ? to list commands.
    +
    +(turtle) ?
    +
    +Documented commands (type help <topic>):
    +========================================
    +bye     color    goto     home  playback  record  right
    +circle  forward  heading  left  position  reset   undo
    +
    +(turtle) help forward
    +Move the turtle forward by the specified distance:  FORWARD 10
    +(turtle) record spiral.cmd
    +(turtle) position
    +Current position is 0 0
    +
    +(turtle) heading
    +Current heading is 0
    +
    +(turtle) reset
    +(turtle) circle 20
    +(turtle) right 30
    +(turtle) circle 40
    +(turtle) right 30
    +(turtle) circle 60
    +(turtle) right 30
    +(turtle) circle 80
    +(turtle) right 30
    +(turtle) circle 100
    +(turtle) right 30
    +(turtle) circle 120
    +(turtle) right 30
    +(turtle) circle 120
    +(turtle) heading
    +Current heading is 180
    +
    +(turtle) forward 100
    +(turtle)
    +(turtle) right 90
    +(turtle) forward 100
    +(turtle)
    +(turtle) right 90
    +(turtle) forward 400
    +(turtle) right 90
    +(turtle) forward 500
    +(turtle) right 90
    +(turtle) forward 400
    +(turtle) right 90
    +(turtle) forward 300
    +(turtle) playback spiral.cmd
    +Current position is 0 0
    +
    +Current heading is 0
    +
    +Current heading is 180
    +
    +(turtle) bye
    +Thank you for using Turtle
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/code.html b/python-3.7.4-docs-html/library/code.html new file mode 100644 index 0000000..a20e0f3 --- /dev/null +++ b/python-3.7.4-docs-html/library/code.html @@ -0,0 +1,369 @@ + + + + + + + code — Interpreter base classes — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    code — Interpreter base classes

    +

    Source code: Lib/code.py

    +
    +

    The code module provides facilities to implement read-eval-print loops in +Python. Two classes and convenience functions are included which can be used to +build applications which provide an interactive interpreter prompt.

    +
    +
    +class code.InteractiveInterpreter(locals=None)
    +

    This class deals with parsing and interpreter state (the user’s namespace); it +does not deal with input buffering or prompting or input file naming (the +filename is always passed in explicitly). The optional locals argument +specifies the dictionary in which code will be executed; it defaults to a newly +created dictionary with key '__name__' set to '__console__' and key +'__doc__' set to None.

    +
    + +
    +
    +class code.InteractiveConsole(locals=None, filename="<console>")
    +

    Closely emulate the behavior of the interactive Python interpreter. This class +builds on InteractiveInterpreter and adds prompting using the familiar +sys.ps1 and sys.ps2, and input buffering.

    +
    + +
    +
    +code.interact(banner=None, readfunc=None, local=None, exitmsg=None)
    +

    Convenience function to run a read-eval-print loop. This creates a new +instance of InteractiveConsole and sets readfunc to be used as +the InteractiveConsole.raw_input() method, if provided. If local is +provided, it is passed to the InteractiveConsole constructor for +use as the default namespace for the interpreter loop. The interact() +method of the instance is then run with banner and exitmsg passed as the +banner and exit message to use, if provided. The console object is discarded +after use.

    +
    +

    Changed in version 3.6: Added exitmsg parameter.

    +
    +
    + +
    +
    +code.compile_command(source, filename="<input>", symbol="single")
    +

    This function is useful for programs that want to emulate Python’s interpreter +main loop (a.k.a. the read-eval-print loop). The tricky part is to determine +when the user has entered an incomplete command that can be completed by +entering more text (as opposed to a complete command or a syntax error). This +function almost always makes the same decision as the real interpreter main +loop.

    +

    source is the source string; filename is the optional filename from which +source was read, defaulting to '<input>'; and symbol is the optional +grammar start symbol, which should be either 'single' (the default) or +'eval'.

    +

    Returns a code object (the same as compile(source, filename, symbol)) if the +command is complete and valid; None if the command is incomplete; raises +SyntaxError if the command is complete and contains a syntax error, or +raises OverflowError or ValueError if the command contains an +invalid literal.

    +
    + +
    +

    Interactive Interpreter Objects

    +
    +
    +InteractiveInterpreter.runsource(source, filename="<input>", symbol="single")
    +

    Compile and run some source in the interpreter. Arguments are the same as for +compile_command(); the default for filename is '<input>', and for +symbol is 'single'. One several things can happen:

    + +

    The return value can be used to decide whether to use sys.ps1 or sys.ps2 +to prompt the next line.

    +
    + +
    +
    +InteractiveInterpreter.runcode(code)
    +

    Execute a code object. When an exception occurs, showtraceback() is called +to display a traceback. All exceptions are caught except SystemExit, +which is allowed to propagate.

    +

    A note about KeyboardInterrupt: this exception may occur elsewhere in +this code, and may not always be caught. The caller should be prepared to deal +with it.

    +
    + +
    +
    +InteractiveInterpreter.showsyntaxerror(filename=None)
    +

    Display the syntax error that just occurred. This does not display a stack +trace because there isn’t one for syntax errors. If filename is given, it is +stuffed into the exception instead of the default filename provided by Python’s +parser, because it always uses '<string>' when reading from a string. The +output is written by the write() method.

    +
    + +
    +
    +InteractiveInterpreter.showtraceback()
    +

    Display the exception that just occurred. We remove the first stack item +because it is within the interpreter object implementation. The output is +written by the write() method.

    +
    +

    Changed in version 3.5: The full chained traceback is displayed instead +of just the primary traceback.

    +
    +
    + +
    +
    +InteractiveInterpreter.write(data)
    +

    Write a string to the standard error stream (sys.stderr). Derived classes +should override this to provide the appropriate output handling as needed.

    +
    + +
    +
    +

    Interactive Console Objects

    +

    The InteractiveConsole class is a subclass of +InteractiveInterpreter, and so offers all the methods of the +interpreter objects as well as the following additions.

    +
    +
    +InteractiveConsole.interact(banner=None, exitmsg=None)
    +

    Closely emulate the interactive Python console. The optional banner argument +specify the banner to print before the first interaction; by default it prints a +banner similar to the one printed by the standard Python interpreter, followed +by the class name of the console object in parentheses (so as not to confuse +this with the real interpreter – since it’s so close!).

    +

    The optional exitmsg argument specifies an exit message printed when exiting. +Pass the empty string to suppress the exit message. If exitmsg is not given or +None, a default message is printed.

    +
    +

    Changed in version 3.4: To suppress printing any banner, pass an empty string.

    +
    +
    +

    Changed in version 3.6: Print an exit message when exiting.

    +
    +
    + +
    +
    +InteractiveConsole.push(line)
    +

    Push a line of source text to the interpreter. The line should not have a +trailing newline; it may have internal newlines. The line is appended to a +buffer and the interpreter’s runsource() method is called with the +concatenated contents of the buffer as source. If this indicates that the +command was executed or invalid, the buffer is reset; otherwise, the command is +incomplete, and the buffer is left as it was after the line was appended. The +return value is True if more input is required, False if the line was +dealt with in some way (this is the same as runsource()).

    +
    + +
    +
    +InteractiveConsole.resetbuffer()
    +

    Remove any unhandled source text from the input buffer.

    +
    + +
    +
    +InteractiveConsole.raw_input(prompt="")
    +

    Write a prompt and read a line. The returned line does not include the trailing +newline. When the user enters the EOF key sequence, EOFError is raised. +The base implementation reads from sys.stdin; a subclass may replace this +with a different implementation.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/codecs.html b/python-3.7.4-docs-html/library/codecs.html new file mode 100644 index 0000000..d221c22 --- /dev/null +++ b/python-3.7.4-docs-html/library/codecs.html @@ -0,0 +1,1948 @@ + + + + + + + codecs — Codec registry and base classes — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    codecs — Codec registry and base classes

    +

    Source code: Lib/codecs.py

    +
    +

    This module defines base classes for standard Python codecs (encoders and +decoders) and provides access to the internal Python codec registry, which +manages the codec and error handling lookup process. Most standard codecs +are text encodings, which encode text to bytes, +but there are also codecs provided that encode text to text, and bytes to +bytes. Custom codecs may encode and decode between arbitrary types, but some +module features are restricted to use specifically with +text encodings, or with codecs that encode to +bytes.

    +

    The module defines the following functions for encoding and decoding with +any codec:

    +
    +
    +codecs.encode(obj, encoding='utf-8', errors='strict')
    +

    Encodes obj using the codec registered for encoding.

    +

    Errors may be given to set the desired error handling scheme. The +default error handler is 'strict' meaning that encoding errors raise +ValueError (or a more codec specific subclass, such as +UnicodeEncodeError). Refer to Codec Base Classes for more +information on codec error handling.

    +
    + +
    +
    +codecs.decode(obj, encoding='utf-8', errors='strict')
    +

    Decodes obj using the codec registered for encoding.

    +

    Errors may be given to set the desired error handling scheme. The +default error handler is 'strict' meaning that decoding errors raise +ValueError (or a more codec specific subclass, such as +UnicodeDecodeError). Refer to Codec Base Classes for more +information on codec error handling.

    +
    + +

    The full details for each codec can also be looked up directly:

    +
    +
    +codecs.lookup(encoding)
    +

    Looks up the codec info in the Python codec registry and returns a +CodecInfo object as defined below.

    +

    Encodings are first looked up in the registry’s cache. If not found, the list of +registered search functions is scanned. If no CodecInfo object is +found, a LookupError is raised. Otherwise, the CodecInfo object +is stored in the cache and returned to the caller.

    +
    + +
    +
    +class codecs.CodecInfo(encode, decode, streamreader=None, streamwriter=None, incrementalencoder=None, incrementaldecoder=None, name=None)
    +

    Codec details when looking up the codec registry. The constructor +arguments are stored in attributes of the same name:

    +
    +
    +name
    +

    The name of the encoding.

    +
    + +
    +
    +encode
    +
    +decode
    +

    The stateless encoding and decoding functions. These must be +functions or methods which have the same interface as +the encode() and decode() methods of Codec +instances (see Codec Interface). +The functions or methods are expected to work in a stateless mode.

    +
    + +
    +
    +incrementalencoder
    +
    +incrementaldecoder
    +

    Incremental encoder and decoder classes or factory functions. +These have to provide the interface defined by the base classes +IncrementalEncoder and IncrementalDecoder, +respectively. Incremental codecs can maintain state.

    +
    + +
    +
    +streamwriter
    +
    +streamreader
    +

    Stream writer and reader classes or factory functions. These have to +provide the interface defined by the base classes +StreamWriter and StreamReader, respectively. +Stream codecs can maintain state.

    +
    + +
    + +

    To simplify access to the various codec components, the module provides +these additional functions which use lookup() for the codec lookup:

    +
    +
    +codecs.getencoder(encoding)
    +

    Look up the codec for the given encoding and return its encoder function.

    +

    Raises a LookupError in case the encoding cannot be found.

    +
    + +
    +
    +codecs.getdecoder(encoding)
    +

    Look up the codec for the given encoding and return its decoder function.

    +

    Raises a LookupError in case the encoding cannot be found.

    +
    + +
    +
    +codecs.getincrementalencoder(encoding)
    +

    Look up the codec for the given encoding and return its incremental encoder +class or factory function.

    +

    Raises a LookupError in case the encoding cannot be found or the codec +doesn’t support an incremental encoder.

    +
    + +
    +
    +codecs.getincrementaldecoder(encoding)
    +

    Look up the codec for the given encoding and return its incremental decoder +class or factory function.

    +

    Raises a LookupError in case the encoding cannot be found or the codec +doesn’t support an incremental decoder.

    +
    + +
    +
    +codecs.getreader(encoding)
    +

    Look up the codec for the given encoding and return its StreamReader +class or factory function.

    +

    Raises a LookupError in case the encoding cannot be found.

    +
    + +
    +
    +codecs.getwriter(encoding)
    +

    Look up the codec for the given encoding and return its StreamWriter +class or factory function.

    +

    Raises a LookupError in case the encoding cannot be found.

    +
    + +

    Custom codecs are made available by registering a suitable codec search +function:

    +
    +
    +codecs.register(search_function)
    +

    Register a codec search function. Search functions are expected to take one +argument, being the encoding name in all lower case letters, and return a +CodecInfo object. In case a search function cannot find +a given encoding, it should return None.

    +
    +

    Note

    +

    Search function registration is not currently reversible, +which may cause problems in some cases, such as unit testing or +module reloading.

    +
    +
    + +

    While the builtin open() and the associated io module are the +recommended approach for working with encoded text files, this module +provides additional utility functions and classes that allow the use of a +wider range of codecs when working with binary files:

    +
    +
    +codecs.open(filename, mode='r', encoding=None, errors='strict', buffering=1)
    +

    Open an encoded file using the given mode and return an instance of +StreamReaderWriter, providing transparent encoding/decoding. +The default file mode is 'r', meaning to open the file in read mode.

    +
    +

    Note

    +

    Underlying encoded files are always opened in binary mode. +No automatic conversion of '\n' is done on reading and writing. +The mode argument may be any binary mode acceptable to the built-in +open() function; the 'b' is automatically added.

    +
    +

    encoding specifies the encoding which is to be used for the file. +Any encoding that encodes to and decodes from bytes is allowed, and +the data types supported by the file methods depend on the codec used.

    +

    errors may be given to define the error handling. It defaults to 'strict' +which causes a ValueError to be raised in case an encoding error occurs.

    +

    buffering has the same meaning as for the built-in open() function. It +defaults to line buffered.

    +
    + +
    +
    +codecs.EncodedFile(file, data_encoding, file_encoding=None, errors='strict')
    +

    Return a StreamRecoder instance, a wrapped version of file +which provides transparent transcoding. The original file is closed +when the wrapped version is closed.

    +

    Data written to the wrapped file is decoded according to the given +data_encoding and then written to the original file as bytes using +file_encoding. Bytes read from the original file are decoded +according to file_encoding, and the result is encoded +using data_encoding.

    +

    If file_encoding is not given, it defaults to data_encoding.

    +

    errors may be given to define the error handling. It defaults to +'strict', which causes ValueError to be raised in case an encoding +error occurs.

    +
    + +
    +
    +codecs.iterencode(iterator, encoding, errors='strict', **kwargs)
    +

    Uses an incremental encoder to iteratively encode the input provided by +iterator. This function is a generator. +The errors argument (as well as any +other keyword argument) is passed through to the incremental encoder.

    +

    This function requires that the codec accept text str objects +to encode. Therefore it does not support bytes-to-bytes encoders such as +base64_codec.

    +
    + +
    +
    +codecs.iterdecode(iterator, encoding, errors='strict', **kwargs)
    +

    Uses an incremental decoder to iteratively decode the input provided by +iterator. This function is a generator. +The errors argument (as well as any +other keyword argument) is passed through to the incremental decoder.

    +

    This function requires that the codec accept bytes objects +to decode. Therefore it does not support text-to-text encoders such as +rot_13, although rot_13 may be used equivalently with +iterencode().

    +
    + +

    The module also provides the following constants which are useful for reading +and writing to platform dependent files:

    +
    +
    +codecs.BOM
    +
    +codecs.BOM_BE
    +
    +codecs.BOM_LE
    +
    +codecs.BOM_UTF8
    +
    +codecs.BOM_UTF16
    +
    +codecs.BOM_UTF16_BE
    +
    +codecs.BOM_UTF16_LE
    +
    +codecs.BOM_UTF32
    +
    +codecs.BOM_UTF32_BE
    +
    +codecs.BOM_UTF32_LE
    +

    These constants define various byte sequences, +being Unicode byte order marks (BOMs) for several encodings. They are +used in UTF-16 and UTF-32 data streams to indicate the byte order used, +and in UTF-8 as a Unicode signature. BOM_UTF16 is either +BOM_UTF16_BE or BOM_UTF16_LE depending on the platform’s +native byte order, BOM is an alias for BOM_UTF16, +BOM_LE for BOM_UTF16_LE and BOM_BE for +BOM_UTF16_BE. The others represent the BOM in UTF-8 and UTF-32 +encodings.

    +
    + +
    +

    Codec Base Classes

    +

    The codecs module defines a set of base classes which define the +interfaces for working with codec objects, and can also be used as the basis +for custom codec implementations.

    +

    Each codec has to define four interfaces to make it usable as codec in Python: +stateless encoder, stateless decoder, stream reader and stream writer. The +stream reader and writers typically reuse the stateless encoder/decoder to +implement the file protocols. Codec authors also need to define how the +codec will handle encoding and decoding errors.

    +
    +

    Error Handlers

    +

    To simplify and standardize error handling, +codecs may implement different error handling schemes by +accepting the errors string argument. The following string values are +defined and implemented by all standard Python codecs:

    + ++++ + + + + + + + + + + + + + +

    Value

    Meaning

    'strict'

    Raise UnicodeError (or a subclass); +this is the default. Implemented in +strict_errors().

    'ignore'

    Ignore the malformed data and continue +without further notice. Implemented in +ignore_errors().

    +

    The following error handlers are only applicable to +text encodings:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + +

    Value

    Meaning

    'replace'

    Replace with a suitable replacement +marker; Python will use the official +U+FFFD REPLACEMENT CHARACTER for the +built-in codecs on decoding, and ‘?’ on +encoding. Implemented in +replace_errors().

    'xmlcharrefreplace'

    Replace with the appropriate XML character +reference (only for encoding). Implemented +in xmlcharrefreplace_errors().

    'backslashreplace'

    Replace with backslashed escape sequences. +Implemented in +backslashreplace_errors().

    'namereplace'

    Replace with \N{...} escape sequences +(only for encoding). Implemented in +namereplace_errors().

    'surrogateescape'

    On decoding, replace byte with individual +surrogate code ranging from U+DC80 to +U+DCFF. This code will then be turned +back into the same byte when the +'surrogateescape' error handler is used +when encoding the data. (See PEP 383 for +more.)

    +

    In addition, the following error handler is specific to the given codecs:

    + +++++ + + + + + + + + + + + + +

    Value

    Codecs

    Meaning

    'surrogatepass'

    utf-8, utf-16, utf-32, +utf-16-be, utf-16-le, +utf-32-be, utf-32-le

    Allow encoding and decoding of surrogate +codes. These codecs normally treat the +presence of surrogates as an error.

    +
    +

    New in version 3.1: The 'surrogateescape' and 'surrogatepass' error handlers.

    +
    +
    +

    Changed in version 3.4: The 'surrogatepass' error handlers now works with utf-16* and utf-32* codecs.

    +
    +
    +

    New in version 3.5: The 'namereplace' error handler.

    +
    +
    +

    Changed in version 3.5: The 'backslashreplace' error handlers now works with decoding and +translating.

    +
    +

    The set of allowed values can be extended by registering a new named error +handler:

    +
    +
    +codecs.register_error(name, error_handler)
    +

    Register the error handling function error_handler under the name name. +The error_handler argument will be called during encoding and decoding +in case of an error, when name is specified as the errors parameter.

    +

    For encoding, error_handler will be called with a UnicodeEncodeError +instance, which contains information about the location of the error. The +error handler must either raise this or a different exception, or return a +tuple with a replacement for the unencodable part of the input and a position +where encoding should continue. The replacement may be either str or +bytes. If the replacement is bytes, the encoder will simply copy +them into the output buffer. If the replacement is a string, the encoder will +encode the replacement. Encoding continues on original input at the +specified position. Negative position values will be treated as being +relative to the end of the input string. If the resulting position is out of +bound an IndexError will be raised.

    +

    Decoding and translating works similarly, except UnicodeDecodeError or +UnicodeTranslateError will be passed to the handler and that the +replacement from the error handler will be put into the output directly.

    +
    + +

    Previously registered error handlers (including the standard error handlers) +can be looked up by name:

    +
    +
    +codecs.lookup_error(name)
    +

    Return the error handler previously registered under the name name.

    +

    Raises a LookupError in case the handler cannot be found.

    +
    + +

    The following standard error handlers are also made available as module level +functions:

    +
    +
    +codecs.strict_errors(exception)
    +

    Implements the 'strict' error handling: each encoding or +decoding error raises a UnicodeError.

    +
    + +
    +
    +codecs.replace_errors(exception)
    +

    Implements the 'replace' error handling (for text encodings only): substitutes '?' for encoding errors +(to be encoded by the codec), and '\ufffd' (the Unicode replacement +character) for decoding errors.

    +
    + +
    +
    +codecs.ignore_errors(exception)
    +

    Implements the 'ignore' error handling: malformed data is ignored and +encoding or decoding is continued without further notice.

    +
    + +
    +
    +codecs.xmlcharrefreplace_errors(exception)
    +

    Implements the 'xmlcharrefreplace' error handling (for encoding with +text encodings only): the +unencodable character is replaced by an appropriate XML character reference.

    +
    + +
    +
    +codecs.backslashreplace_errors(exception)
    +

    Implements the 'backslashreplace' error handling (for +text encodings only): malformed data is +replaced by a backslashed escape sequence.

    +
    + +
    +
    +codecs.namereplace_errors(exception)
    +

    Implements the 'namereplace' error handling (for encoding with +text encodings only): the +unencodable character is replaced by a \N{...} escape sequence.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +

    Stateless Encoding and Decoding

    +

    The base Codec class defines these methods which also define the +function interfaces of the stateless encoder and decoder:

    +
    +
    +Codec.encode(input[, errors])
    +

    Encodes the object input and returns a tuple (output object, length consumed). +For instance, text encoding converts +a string object to a bytes object using a particular +character set encoding (e.g., cp1252 or iso-8859-1).

    +

    The errors argument defines the error handling to apply. +It defaults to 'strict' handling.

    +

    The method may not store state in the Codec instance. Use +StreamWriter for codecs which have to keep state in order to make +encoding efficient.

    +

    The encoder must be able to handle zero length input and return an empty object +of the output object type in this situation.

    +
    + +
    +
    +Codec.decode(input[, errors])
    +

    Decodes the object input and returns a tuple (output object, length +consumed). For instance, for a text encoding, decoding converts +a bytes object encoded using a particular +character set encoding to a string object.

    +

    For text encodings and bytes-to-bytes codecs, +input must be a bytes object or one which provides the read-only +buffer interface – for example, buffer objects and memory mapped files.

    +

    The errors argument defines the error handling to apply. +It defaults to 'strict' handling.

    +

    The method may not store state in the Codec instance. Use +StreamReader for codecs which have to keep state in order to make +decoding efficient.

    +

    The decoder must be able to handle zero length input and return an empty object +of the output object type in this situation.

    +
    + +
    +
    +

    Incremental Encoding and Decoding

    +

    The IncrementalEncoder and IncrementalDecoder classes provide +the basic interface for incremental encoding and decoding. Encoding/decoding the +input isn’t done with one call to the stateless encoder/decoder function, but +with multiple calls to the +encode()/decode() method of +the incremental encoder/decoder. The incremental encoder/decoder keeps track of +the encoding/decoding process during method calls.

    +

    The joined output of calls to the +encode()/decode() method is +the same as if all the single inputs were joined into one, and this input was +encoded/decoded with the stateless encoder/decoder.

    +
    +

    IncrementalEncoder Objects

    +

    The IncrementalEncoder class is used for encoding an input in multiple +steps. It defines the following methods which every incremental encoder must +define in order to be compatible with the Python codec registry.

    +
    +
    +class codecs.IncrementalEncoder(errors='strict')
    +

    Constructor for an IncrementalEncoder instance.

    +

    All incremental encoders must provide this constructor interface. They are free +to add additional keyword arguments, but only the ones defined here are used by +the Python codec registry.

    +

    The IncrementalEncoder may implement different error handling schemes +by providing the errors keyword argument. See Error Handlers for +possible values.

    +

    The errors argument will be assigned to an attribute of the same name. +Assigning to this attribute makes it possible to switch between different error +handling strategies during the lifetime of the IncrementalEncoder +object.

    +
    +
    +encode(object[, final])
    +

    Encodes object (taking the current state of the encoder into account) +and returns the resulting encoded object. If this is the last call to +encode() final must be true (the default is false).

    +
    + +
    +
    +reset()
    +

    Reset the encoder to the initial state. The output is discarded: call +.encode(object, final=True), passing an empty byte or text string +if necessary, to reset the encoder and to get the output.

    +
    + +
    +
    +getstate()
    +

    Return the current state of the encoder which must be an integer. The +implementation should make sure that 0 is the most common +state. (States that are more complicated than integers can be converted +into an integer by marshaling/pickling the state and encoding the bytes +of the resulting string into an integer).

    +
    + +
    +
    +setstate(state)
    +

    Set the state of the encoder to state. state must be an encoder state +returned by getstate().

    +
    + +
    + +
    +
    +

    IncrementalDecoder Objects

    +

    The IncrementalDecoder class is used for decoding an input in multiple +steps. It defines the following methods which every incremental decoder must +define in order to be compatible with the Python codec registry.

    +
    +
    +class codecs.IncrementalDecoder(errors='strict')
    +

    Constructor for an IncrementalDecoder instance.

    +

    All incremental decoders must provide this constructor interface. They are free +to add additional keyword arguments, but only the ones defined here are used by +the Python codec registry.

    +

    The IncrementalDecoder may implement different error handling schemes +by providing the errors keyword argument. See Error Handlers for +possible values.

    +

    The errors argument will be assigned to an attribute of the same name. +Assigning to this attribute makes it possible to switch between different error +handling strategies during the lifetime of the IncrementalDecoder +object.

    +
    +
    +decode(object[, final])
    +

    Decodes object (taking the current state of the decoder into account) +and returns the resulting decoded object. If this is the last call to +decode() final must be true (the default is false). If final is +true the decoder must decode the input completely and must flush all +buffers. If this isn’t possible (e.g. because of incomplete byte sequences +at the end of the input) it must initiate error handling just like in the +stateless case (which might raise an exception).

    +
    + +
    +
    +reset()
    +

    Reset the decoder to the initial state.

    +
    + +
    +
    +getstate()
    +

    Return the current state of the decoder. This must be a tuple with two +items, the first must be the buffer containing the still undecoded +input. The second must be an integer and can be additional state +info. (The implementation should make sure that 0 is the most common +additional state info.) If this additional state info is 0 it must be +possible to set the decoder to the state which has no input buffered and +0 as the additional state info, so that feeding the previously +buffered input to the decoder returns it to the previous state without +producing any output. (Additional state info that is more complicated than +integers can be converted into an integer by marshaling/pickling the info +and encoding the bytes of the resulting string into an integer.)

    +
    + +
    +
    +setstate(state)
    +

    Set the state of the decoder to state. state must be a decoder state +returned by getstate().

    +
    + +
    + +
    +
    +
    +

    Stream Encoding and Decoding

    +

    The StreamWriter and StreamReader classes provide generic +working interfaces which can be used to implement new encoding submodules very +easily. See encodings.utf_8 for an example of how this is done.

    +
    +

    StreamWriter Objects

    +

    The StreamWriter class is a subclass of Codec and defines the +following methods which every stream writer must define in order to be +compatible with the Python codec registry.

    +
    +
    +class codecs.StreamWriter(stream, errors='strict')
    +

    Constructor for a StreamWriter instance.

    +

    All stream writers must provide this constructor interface. They are free to add +additional keyword arguments, but only the ones defined here are used by the +Python codec registry.

    +

    The stream argument must be a file-like object open for writing +text or binary data, as appropriate for the specific codec.

    +

    The StreamWriter may implement different error handling schemes by +providing the errors keyword argument. See Error Handlers for +the standard error handlers the underlying stream codec may support.

    +

    The errors argument will be assigned to an attribute of the same name. +Assigning to this attribute makes it possible to switch between different error +handling strategies during the lifetime of the StreamWriter object.

    +
    +
    +write(object)
    +

    Writes the object’s contents encoded to the stream.

    +
    + +
    +
    +writelines(list)
    +

    Writes the concatenated list of strings to the stream (possibly by reusing +the write() method). The standard bytes-to-bytes codecs +do not support this method.

    +
    + +
    +
    +reset()
    +

    Flushes and resets the codec buffers used for keeping state.

    +

    Calling this method should ensure that the data on the output is put into +a clean state that allows appending of new fresh data without having to +rescan the whole stream to recover state.

    +
    + +
    + +

    In addition to the above methods, the StreamWriter must also inherit +all other methods and attributes from the underlying stream.

    +
    +
    +

    StreamReader Objects

    +

    The StreamReader class is a subclass of Codec and defines the +following methods which every stream reader must define in order to be +compatible with the Python codec registry.

    +
    +
    +class codecs.StreamReader(stream, errors='strict')
    +

    Constructor for a StreamReader instance.

    +

    All stream readers must provide this constructor interface. They are free to add +additional keyword arguments, but only the ones defined here are used by the +Python codec registry.

    +

    The stream argument must be a file-like object open for reading +text or binary data, as appropriate for the specific codec.

    +

    The StreamReader may implement different error handling schemes by +providing the errors keyword argument. See Error Handlers for +the standard error handlers the underlying stream codec may support.

    +

    The errors argument will be assigned to an attribute of the same name. +Assigning to this attribute makes it possible to switch between different error +handling strategies during the lifetime of the StreamReader object.

    +

    The set of allowed values for the errors argument can be extended with +register_error().

    +
    +
    +read([size[, chars[, firstline]]])
    +

    Decodes data from the stream and returns the resulting object.

    +

    The chars argument indicates the number of decoded +code points or bytes to return. The read() method will +never return more data than requested, but it might return less, +if there is not enough available.

    +

    The size argument indicates the approximate maximum +number of encoded bytes or code points to read +for decoding. The decoder can modify this setting as +appropriate. The default value -1 indicates to read and decode as much as +possible. This parameter is intended to +prevent having to decode huge files in one step.

    +

    The firstline flag indicates that +it would be sufficient to only return the first +line, if there are decoding errors on later lines.

    +

    The method should use a greedy read strategy meaning that it should read +as much data as is allowed within the definition of the encoding and the +given size, e.g. if optional encoding endings or state markers are +available on the stream, these should be read too.

    +
    + +
    +
    +readline([size[, keepends]])
    +

    Read one line from the input stream and return the decoded data.

    +

    size, if given, is passed as size argument to the stream’s +read() method.

    +

    If keepends is false line-endings will be stripped from the lines +returned.

    +
    + +
    +
    +readlines([sizehint[, keepends]])
    +

    Read all lines available on the input stream and return them as a list of +lines.

    +

    Line-endings are implemented using the codec’s decoder method and are +included in the list entries if keepends is true.

    +

    sizehint, if given, is passed as the size argument to the stream’s +read() method.

    +
    + +
    +
    +reset()
    +

    Resets the codec buffers used for keeping state.

    +

    Note that no stream repositioning should take place. This method is +primarily intended to be able to recover from decoding errors.

    +
    + +
    + +

    In addition to the above methods, the StreamReader must also inherit +all other methods and attributes from the underlying stream.

    +
    +
    +

    StreamReaderWriter Objects

    +

    The StreamReaderWriter is a convenience class that allows wrapping +streams which work in both read and write modes.

    +

    The design is such that one can use the factory functions returned by the +lookup() function to construct the instance.

    +
    +
    +class codecs.StreamReaderWriter(stream, Reader, Writer, errors='strict')
    +

    Creates a StreamReaderWriter instance. stream must be a file-like +object. Reader and Writer must be factory functions or classes providing the +StreamReader and StreamWriter interface resp. Error handling +is done in the same way as defined for the stream readers and writers.

    +
    + +

    StreamReaderWriter instances define the combined interfaces of +StreamReader and StreamWriter classes. They inherit all other +methods and attributes from the underlying stream.

    +
    +
    +

    StreamRecoder Objects

    +

    The StreamRecoder translates data from one encoding to another, +which is sometimes useful when dealing with different encoding environments.

    +

    The design is such that one can use the factory functions returned by the +lookup() function to construct the instance.

    +
    +
    +class codecs.StreamRecoder(stream, encode, decode, Reader, Writer, errors='strict')
    +

    Creates a StreamRecoder instance which implements a two-way conversion: +encode and decode work on the frontend — the data visible to +code calling read() and write(), while Reader and Writer +work on the backend — the data in stream.

    +

    You can use these objects to do transparent transcodings from e.g. Latin-1 +to UTF-8 and back.

    +

    The stream argument must be a file-like object.

    +

    The encode and decode arguments must +adhere to the Codec interface. Reader and +Writer must be factory functions or classes providing objects of the +StreamReader and StreamWriter interface respectively.

    +

    Error handling is done in the same way as defined for the stream readers and +writers.

    +
    + +

    StreamRecoder instances define the combined interfaces of +StreamReader and StreamWriter classes. They inherit all other +methods and attributes from the underlying stream.

    +
    +
    +
    +
    +

    Encodings and Unicode

    +

    Strings are stored internally as sequences of code points in +range 0x00x10FFFF. (See PEP 393 for +more details about the implementation.) +Once a string object is used outside of CPU and memory, endianness +and how these arrays are stored as bytes become an issue. As with other +codecs, serialising a string into a sequence of bytes is known as encoding, +and recreating the string from the sequence of bytes is known as decoding. +There are a variety of different text serialisation codecs, which are +collectivity referred to as text encodings.

    +

    The simplest text encoding (called 'latin-1' or 'iso-8859-1') maps +the code points 0–255 to the bytes 0x00xff, which means that a string +object that contains code points above U+00FF can’t be encoded with this +codec. Doing so will raise a UnicodeEncodeError that looks +like the following (although the details of the error message may differ): +UnicodeEncodeError: 'latin-1' codec can't encode character '\u1234' in +position 3: ordinal not in range(256).

    +

    There’s another group of encodings (the so called charmap encodings) that choose +a different subset of all Unicode code points and how these code points are +mapped to the bytes 0x00xff. To see how this is done simply open +e.g. encodings/cp1252.py (which is an encoding that is used primarily on +Windows). There’s a string constant with 256 characters that shows you which +character is mapped to which byte value.

    +

    All of these encodings can only encode 256 of the 1114112 code points +defined in Unicode. A simple and straightforward way that can store each Unicode +code point, is to store each code point as four consecutive bytes. There are two +possibilities: store the bytes in big endian or in little endian order. These +two encodings are called UTF-32-BE and UTF-32-LE respectively. Their +disadvantage is that if e.g. you use UTF-32-BE on a little endian machine you +will always have to swap bytes on encoding and decoding. UTF-32 avoids this +problem: bytes will always be in natural endianness. When these bytes are read +by a CPU with a different endianness, then bytes have to be swapped though. To +be able to detect the endianness of a UTF-16 or UTF-32 byte sequence, +there’s the so called BOM (“Byte Order Mark”). This is the Unicode character +U+FEFF. This character can be prepended to every UTF-16 or UTF-32 +byte sequence. The byte swapped version of this character (0xFFFE) is an +illegal character that may not appear in a Unicode text. So when the +first character in an UTF-16 or UTF-32 byte sequence +appears to be a U+FFFE the bytes have to be swapped on decoding. +Unfortunately the character U+FEFF had a second purpose as +a ZERO WIDTH NO-BREAK SPACE: a character that has no width and doesn’t allow +a word to be split. It can e.g. be used to give hints to a ligature algorithm. +With Unicode 4.0 using U+FEFF as a ZERO WIDTH NO-BREAK SPACE has been +deprecated (with U+2060 (WORD JOINER) assuming this role). Nevertheless +Unicode software still must be able to handle U+FEFF in both roles: as a BOM +it’s a device to determine the storage layout of the encoded bytes, and vanishes +once the byte sequence has been decoded into a string; as a ZERO WIDTH +NO-BREAK SPACE it’s a normal character that will be decoded like any other.

    +

    There’s another encoding that is able to encoding the full range of Unicode +characters: UTF-8. UTF-8 is an 8-bit encoding, which means there are no issues +with byte order in UTF-8. Each byte in a UTF-8 byte sequence consists of two +parts: marker bits (the most significant bits) and payload bits. The marker bits +are a sequence of zero to four 1 bits followed by a 0 bit. Unicode characters are +encoded like this (with x being payload bits, which when concatenated give the +Unicode character):

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Range

    Encoding

    U-00000000U-0000007F

    0xxxxxxx

    U-00000080U-000007FF

    110xxxxx 10xxxxxx

    U-00000800U-0000FFFF

    1110xxxx 10xxxxxx 10xxxxxx

    U-00010000U-0010FFFF

    11110xxx 10xxxxxx 10xxxxxx 10xxxxxx

    +

    The least significant bit of the Unicode character is the rightmost x bit.

    +

    As UTF-8 is an 8-bit encoding no BOM is required and any U+FEFF character in +the decoded string (even if it’s the first character) is treated as a ZERO +WIDTH NO-BREAK SPACE.

    +

    Without external information it’s impossible to reliably determine which +encoding was used for encoding a string. Each charmap encoding can +decode any random byte sequence. However that’s not possible with UTF-8, as +UTF-8 byte sequences have a structure that doesn’t allow arbitrary byte +sequences. To increase the reliability with which a UTF-8 encoding can be +detected, Microsoft invented a variant of UTF-8 (that Python 2.5 calls +"utf-8-sig") for its Notepad program: Before any of the Unicode characters +is written to the file, a UTF-8 encoded BOM (which looks like this as a byte +sequence: 0xef, 0xbb, 0xbf) is written. As it’s rather improbable +that any charmap encoded file starts with these byte values (which would e.g. +map to

    +
    +
    +
    LATIN SMALL LETTER I WITH DIAERESIS
    +
    RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK
    +
    INVERTED QUESTION MARK
    +
    +
    +

    in iso-8859-1), this increases the probability that a utf-8-sig encoding can be +correctly guessed from the byte sequence. So here the BOM is not used to be able +to determine the byte order used for generating the byte sequence, but as a +signature that helps in guessing the encoding. On encoding the utf-8-sig codec +will write 0xef, 0xbb, 0xbf as the first three bytes to the file. On +decoding utf-8-sig will skip those three bytes if they appear as the first +three bytes in the file. In UTF-8, the use of the BOM is discouraged and +should generally be avoided.

    +
    +
    +

    Standard Encodings

    +

    Python comes with a number of codecs built-in, either implemented as C functions +or with dictionaries as mapping tables. The following table lists the codecs by +name, together with a few common aliases, and the languages for which the +encoding is likely used. Neither the list of aliases nor the list of languages +is meant to be exhaustive. Notice that spelling alternatives that only differ in +case or use a hyphen instead of an underscore are also valid aliases; therefore, +e.g. 'utf-8' is a valid alias for the 'utf_8' codec.

    +
    +

    CPython implementation detail: Some common encodings can bypass the codecs lookup machinery to +improve performance. These optimization opportunities are only +recognized by CPython for a limited set of (case insensitive) +aliases: utf-8, utf8, latin-1, latin1, iso-8859-1, iso8859-1, mbcs +(Windows only), ascii, us-ascii, utf-16, utf16, utf-32, utf32, and +the same using underscores instead of dashes. Using alternative +aliases for these encodings may result in slower execution.

    +
    +

    Changed in version 3.6: Optimization opportunity recognized for us-ascii.

    +
    +
    +

    Many of the character sets support the same languages. They vary in individual +characters (e.g. whether the EURO SIGN is supported or not), and in the +assignment of characters to code positions. For the European languages in +particular, the following variants typically exist:

    +
      +
    • an ISO 8859 codeset

    • +
    • a Microsoft Windows code page, which is typically derived from an 8859 codeset, +but replaces control characters with additional graphic characters

    • +
    • an IBM EBCDIC code page

    • +
    • an IBM PC code page, which is ASCII compatible

    • +
    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Codec

    Aliases

    Languages

    ascii

    646, us-ascii

    English

    big5

    big5-tw, csbig5

    Traditional Chinese

    big5hkscs

    big5-hkscs, hkscs

    Traditional Chinese

    cp037

    IBM037, IBM039

    English

    cp273

    273, IBM273, csIBM273

    German

    +
    +

    New in version 3.4.

    +
    +

    cp424

    EBCDIC-CP-HE, IBM424

    Hebrew

    cp437

    437, IBM437

    English

    cp500

    EBCDIC-CP-BE, EBCDIC-CP-CH, +IBM500

    Western Europe

    cp720

    Arabic

    cp737

    Greek

    cp775

    IBM775

    Baltic languages

    cp850

    850, IBM850

    Western Europe

    cp852

    852, IBM852

    Central and Eastern Europe

    cp855

    855, IBM855

    Bulgarian, Byelorussian, +Macedonian, Russian, Serbian

    cp856

    Hebrew

    cp857

    857, IBM857

    Turkish

    cp858

    858, IBM858

    Western Europe

    cp860

    860, IBM860

    Portuguese

    cp861

    861, CP-IS, IBM861

    Icelandic

    cp862

    862, IBM862

    Hebrew

    cp863

    863, IBM863

    Canadian

    cp864

    IBM864

    Arabic

    cp865

    865, IBM865

    Danish, Norwegian

    cp866

    866, IBM866

    Russian

    cp869

    869, CP-GR, IBM869

    Greek

    cp874

    Thai

    cp875

    Greek

    cp932

    932, ms932, mskanji, ms-kanji

    Japanese

    cp949

    949, ms949, uhc

    Korean

    cp950

    950, ms950

    Traditional Chinese

    cp1006

    Urdu

    cp1026

    ibm1026

    Turkish

    cp1125

    1125, ibm1125, cp866u, ruscii

    Ukrainian

    +
    +

    New in version 3.4.

    +
    +

    cp1140

    ibm1140

    Western Europe

    cp1250

    windows-1250

    Central and Eastern Europe

    cp1251

    windows-1251

    Bulgarian, Byelorussian, +Macedonian, Russian, Serbian

    cp1252

    windows-1252

    Western Europe

    cp1253

    windows-1253

    Greek

    cp1254

    windows-1254

    Turkish

    cp1255

    windows-1255

    Hebrew

    cp1256

    windows-1256

    Arabic

    cp1257

    windows-1257

    Baltic languages

    cp1258

    windows-1258

    Vietnamese

    cp65001

    Windows only: Windows UTF-8 +(CP_UTF8)

    +
    +

    New in version 3.3.

    +
    +

    euc_jp

    eucjp, ujis, u-jis

    Japanese

    euc_jis_2004

    jisx0213, eucjis2004

    Japanese

    euc_jisx0213

    eucjisx0213

    Japanese

    euc_kr

    euckr, korean, ksc5601, +ks_c-5601, ks_c-5601-1987, +ksx1001, ks_x-1001

    Korean

    gb2312

    chinese, csiso58gb231280, +euc-cn, euccn, eucgb2312-cn, +gb2312-1980, gb2312-80, +iso-ir-58

    Simplified Chinese

    gbk

    936, cp936, ms936

    Unified Chinese

    gb18030

    gb18030-2000

    Unified Chinese

    hz

    hzgb, hz-gb, hz-gb-2312

    Simplified Chinese

    iso2022_jp

    csiso2022jp, iso2022jp, +iso-2022-jp

    Japanese

    iso2022_jp_1

    iso2022jp-1, iso-2022-jp-1

    Japanese

    iso2022_jp_2

    iso2022jp-2, iso-2022-jp-2

    Japanese, Korean, Simplified +Chinese, Western Europe, Greek

    iso2022_jp_2004

    iso2022jp-2004, +iso-2022-jp-2004

    Japanese

    iso2022_jp_3

    iso2022jp-3, iso-2022-jp-3

    Japanese

    iso2022_jp_ext

    iso2022jp-ext, iso-2022-jp-ext

    Japanese

    iso2022_kr

    csiso2022kr, iso2022kr, +iso-2022-kr

    Korean

    latin_1

    iso-8859-1, iso8859-1, 8859, +cp819, latin, latin1, L1

    West Europe

    iso8859_2

    iso-8859-2, latin2, L2

    Central and Eastern Europe

    iso8859_3

    iso-8859-3, latin3, L3

    Esperanto, Maltese

    iso8859_4

    iso-8859-4, latin4, L4

    Baltic languages

    iso8859_5

    iso-8859-5, cyrillic

    Bulgarian, Byelorussian, +Macedonian, Russian, Serbian

    iso8859_6

    iso-8859-6, arabic

    Arabic

    iso8859_7

    iso-8859-7, greek, greek8

    Greek

    iso8859_8

    iso-8859-8, hebrew

    Hebrew

    iso8859_9

    iso-8859-9, latin5, L5

    Turkish

    iso8859_10

    iso-8859-10, latin6, L6

    Nordic languages

    iso8859_11

    iso-8859-11, thai

    Thai languages

    iso8859_13

    iso-8859-13, latin7, L7

    Baltic languages

    iso8859_14

    iso-8859-14, latin8, L8

    Celtic languages

    iso8859_15

    iso-8859-15, latin9, L9

    Western Europe

    iso8859_16

    iso-8859-16, latin10, L10

    South-Eastern Europe

    johab

    cp1361, ms1361

    Korean

    koi8_r

    Russian

    koi8_t

    Tajik

    +
    +

    New in version 3.5.

    +
    +

    koi8_u

    Ukrainian

    kz1048

    kz_1048, strk1048_2002, rk1048

    Kazakh

    +
    +

    New in version 3.5.

    +
    +

    mac_cyrillic

    maccyrillic

    Bulgarian, Byelorussian, +Macedonian, Russian, Serbian

    mac_greek

    macgreek

    Greek

    mac_iceland

    maciceland

    Icelandic

    mac_latin2

    maclatin2, maccentraleurope

    Central and Eastern Europe

    mac_roman

    macroman, macintosh

    Western Europe

    mac_turkish

    macturkish

    Turkish

    ptcp154

    csptcp154, pt154, cp154, +cyrillic-asian

    Kazakh

    shift_jis

    csshiftjis, shiftjis, sjis, +s_jis

    Japanese

    shift_jis_2004

    shiftjis2004, sjis_2004, +sjis2004

    Japanese

    shift_jisx0213

    shiftjisx0213, sjisx0213, +s_jisx0213

    Japanese

    utf_32

    U32, utf32

    all languages

    utf_32_be

    UTF-32BE

    all languages

    utf_32_le

    UTF-32LE

    all languages

    utf_16

    U16, utf16

    all languages

    utf_16_be

    UTF-16BE

    all languages

    utf_16_le

    UTF-16LE

    all languages

    utf_7

    U7, unicode-1-1-utf-7

    all languages

    utf_8

    U8, UTF, utf8

    all languages

    utf_8_sig

    all languages

    +
    +

    Changed in version 3.4: The utf-16* and utf-32* encoders no longer allow surrogate code points +(U+D800U+DFFF) to be encoded. +The utf-32* decoders no longer decode +byte sequences that correspond to surrogate code points.

    +
    +
    +
    +

    Python Specific Encodings

    +

    A number of predefined codecs are specific to Python, so their codec names have +no meaning outside Python. These are listed in the tables below based on the +expected input and output types (note that while text encodings are the most +common use case for codecs, the underlying codec infrastructure supports +arbitrary data transforms rather than just text encodings). For asymmetric +codecs, the stated purpose describes the encoding direction.

    +
    +

    Text Encodings

    +

    The following codecs provide str to bytes encoding and +bytes-like object to str decoding, similar to the Unicode text +encodings.

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Codec

    Aliases

    Purpose

    idna

    Implements RFC 3490, +see also +encodings.idna. +Only errors='strict' +is supported.

    mbcs

    ansi, +dbcs

    Windows only: Encode +operand according to the +ANSI codepage (CP_ACP)

    oem

    Windows only: Encode +operand according to the +OEM codepage (CP_OEMCP)

    +
    +

    New in version 3.6.

    +
    +

    palmos

    Encoding of PalmOS 3.5

    punycode

    Implements RFC 3492. +Stateful codecs are not +supported.

    raw_unicode_escape

    Latin-1 encoding with +\uXXXX and +\UXXXXXXXX for other +code points. Existing +backslashes are not +escaped in any way. +It is used in the Python +pickle protocol.

    undefined

    Raise an exception for +all conversions, even +empty strings. The error +handler is ignored.

    unicode_escape

    Encoding suitable as the +contents of a Unicode +literal in ASCII-encoded +Python source code, +except that quotes are +not escaped. Decodes from +Latin-1 source code. +Beware that Python source +code actually uses UTF-8 +by default.

    unicode_internal

    Return the internal +representation of the +operand. Stateful codecs +are not supported.

    +
    +

    Deprecated since version 3.3: This representation is +obsoleted by +PEP 393.

    +
    +
    +
    +
    +

    Binary Transforms

    +

    The following codecs provide binary transforms: bytes-like object +to bytes mappings. They are not supported by bytes.decode() +(which only produces str output).

    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Codec

    Aliases

    Purpose

    Encoder / decoder

    base64_codec 1

    base64, base_64

    Convert operand to multiline +MIME base64 (the result +always includes a trailing +'\n')

    +
    +

    Changed in version 3.4: accepts any +bytes-like object +as input for encoding and +decoding

    +
    +

    base64.encodebytes() / +base64.decodebytes()

    bz2_codec

    bz2

    Compress the operand +using bz2

    bz2.compress() / +bz2.decompress()

    hex_codec

    hex

    Convert operand to +hexadecimal +representation, with two +digits per byte

    binascii.b2a_hex() / +binascii.a2b_hex()

    quopri_codec

    quopri, +quotedprintable, +quoted_printable

    Convert operand to MIME +quoted printable

    quopri.encode() with +quotetabs=True / +quopri.decode()

    uu_codec

    uu

    Convert the operand using +uuencode

    uu.encode() / +uu.decode()

    zlib_codec

    zip, zlib

    Compress the operand +using gzip

    zlib.compress() / +zlib.decompress()

    +
    +
    1
    +

    In addition to bytes-like objects, +'base64_codec' also accepts ASCII-only instances of str for +decoding

    +
    +
    +
    +

    New in version 3.2: Restoration of the binary transforms.

    +
    +
    +

    Changed in version 3.4: Restoration of the aliases for the binary transforms.

    +
    +
    +
    +

    Text Transforms

    +

    The following codec provides a text transform: a str to str +mapping. It is not supported by str.encode() (which only produces +bytes output).

    + +++++ + + + + + + + + + + + + +

    Codec

    Aliases

    Purpose

    rot_13

    rot13

    Returns the Caesar-cypher +encryption of the operand

    +
    +

    New in version 3.2: Restoration of the rot_13 text transform.

    +
    +
    +

    Changed in version 3.4: Restoration of the rot13 alias.

    +
    +
    +
    +
    +

    encodings.idna — Internationalized Domain Names in Applications

    +

    This module implements RFC 3490 (Internationalized Domain Names in +Applications) and RFC 3492 (Nameprep: A Stringprep Profile for +Internationalized Domain Names (IDN)). It builds upon the punycode encoding +and stringprep.

    +

    These RFCs together define a protocol to support non-ASCII characters in domain +names. A domain name containing non-ASCII characters (such as +www.Alliancefrançaise.nu) is converted into an ASCII-compatible encoding +(ACE, such as www.xn--alliancefranaise-npb.nu). The ACE form of the domain +name is then used in all places where arbitrary characters are not allowed by +the protocol, such as DNS queries, HTTP Host fields, and so +on. This conversion is carried out in the application; if possible invisible to +the user: The application should transparently convert Unicode domain labels to +IDNA on the wire, and convert back ACE labels to Unicode before presenting them +to the user.

    +

    Python supports this conversion in several ways: the idna codec performs +conversion between Unicode and ACE, separating an input string into labels +based on the separator characters defined in section 3.1 of RFC 3490 +and converting each label to ACE as required, and conversely separating an input +byte string into labels based on the . separator and converting any ACE +labels found into unicode. Furthermore, the socket module +transparently converts Unicode host names to ACE, so that applications need not +be concerned about converting host names themselves when they pass them to the +socket module. On top of that, modules that have host names as function +parameters, such as http.client and ftplib, accept Unicode host +names (http.client then also transparently sends an IDNA hostname in the +Host field if it sends that field at all).

    +

    When receiving host names from the wire (such as in reverse name lookup), no +automatic conversion to Unicode is performed: Applications wishing to present +such host names to the user should decode them to Unicode.

    +

    The module encodings.idna also implements the nameprep procedure, which +performs certain normalizations on host names, to achieve case-insensitivity of +international domain names, and to unify similar characters. The nameprep +functions can be used directly if desired.

    +
    +
    +encodings.idna.nameprep(label)
    +

    Return the nameprepped version of label. The implementation currently assumes +query strings, so AllowUnassigned is true.

    +
    + +
    +
    +encodings.idna.ToASCII(label)
    +

    Convert a label to ASCII, as specified in RFC 3490. UseSTD3ASCIIRules is +assumed to be false.

    +
    + +
    +
    +encodings.idna.ToUnicode(label)
    +

    Convert a label to Unicode, as specified in RFC 3490.

    +
    + +
    +
    +

    encodings.mbcs — Windows ANSI codepage

    +

    Encode operand according to the ANSI codepage (CP_ACP).

    +

    Availability: Windows only.

    +
    +

    Changed in version 3.3: Support any error handler.

    +
    +
    +

    Changed in version 3.2: Before 3.2, the errors argument was ignored; 'replace' was always used +to encode, and 'ignore' to decode.

    +
    +
    +
    +

    encodings.utf_8_sig — UTF-8 codec with BOM signature

    +

    This module implements a variant of the UTF-8 codec: On encoding a UTF-8 encoded +BOM will be prepended to the UTF-8 encoded bytes. For the stateful encoder this +is only done once (on the first write to the byte stream). For decoding an +optional UTF-8 encoded BOM at the start of the data will be skipped.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/codeop.html b/python-3.7.4-docs-html/library/codeop.html new file mode 100644 index 0000000..9ec7692 --- /dev/null +++ b/python-3.7.4-docs-html/library/codeop.html @@ -0,0 +1,243 @@ + + + + + + + codeop — Compile Python code — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    codeop — Compile Python code

    +

    Source code: Lib/codeop.py

    +
    +

    The codeop module provides utilities upon which the Python +read-eval-print loop can be emulated, as is done in the code module. As +a result, you probably don’t want to use the module directly; if you want to +include such a loop in your program you probably want to use the code +module instead.

    +

    There are two parts to this job:

    +
      +
    1. Being able to tell if a line of input completes a Python statement: in +short, telling whether to print ‘>>>’ or ‘...’ next.

    2. +
    3. Remembering which future statements the user has entered, so subsequent +input can be compiled with these in effect.

    4. +
    +

    The codeop module provides a way of doing each of these things, and a way +of doing them both.

    +

    To do just the former:

    +
    +
    +codeop.compile_command(source, filename="<input>", symbol="single")
    +

    Tries to compile source, which should be a string of Python code and return a +code object if source is valid Python code. In that case, the filename +attribute of the code object will be filename, which defaults to +'<input>'. Returns None if source is not valid Python code, but is a +prefix of valid Python code.

    +

    If there is a problem with source, an exception will be raised. +SyntaxError is raised if there is invalid Python syntax, and +OverflowError or ValueError if there is an invalid literal.

    +

    The symbol argument determines whether source is compiled as a statement +('single', the default) or as an expression ('eval'). Any +other value will cause ValueError to be raised.

    +
    +

    Note

    +

    It is possible (but not likely) that the parser stops parsing with a +successful outcome before reaching the end of the source; in this case, +trailing symbols may be ignored instead of causing an error. For example, +a backslash followed by two newlines may be followed by arbitrary garbage. +This will be fixed once the API for the parser is better.

    +
    +
    + +
    +
    +class codeop.Compile
    +

    Instances of this class have __call__() methods identical in signature to +the built-in function compile(), but with the difference that if the +instance compiles program text containing a __future__ statement, the +instance ‘remembers’ and compiles all subsequent program texts with the +statement in force.

    +
    + +
    +
    +class codeop.CommandCompiler
    +

    Instances of this class have __call__() methods identical in signature to +compile_command(); the difference is that if the instance compiles program +text containing a __future__ statement, the instance ‘remembers’ and +compiles all subsequent program texts with the statement in force.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/collections.abc.html b/python-3.7.4-docs-html/library/collections.abc.html new file mode 100644 index 0000000..6eb7115 --- /dev/null +++ b/python-3.7.4-docs-html/library/collections.abc.html @@ -0,0 +1,633 @@ + + + + + + + collections.abc — Abstract Base Classes for Containers — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    collections.abc — Abstract Base Classes for Containers

    +
    +

    New in version 3.3: Formerly, this module was part of the collections module.

    +
    +

    Source code: Lib/_collections_abc.py

    +
    +

    This module provides abstract base classes that +can be used to test whether a class provides a particular interface; for +example, whether it is hashable or whether it is a mapping.

    +
    +

    Collections Abstract Base Classes

    +

    The collections module offers the following ABCs:

    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    ABC

    Inherits from

    Abstract Methods

    Mixin Methods

    Container

    __contains__

    Hashable

    __hash__

    Iterable

    __iter__

    Iterator

    Iterable

    __next__

    __iter__

    Reversible

    Iterable

    __reversed__

    Generator

    Iterator

    send, throw

    close, __iter__, __next__

    Sized

    __len__

    Callable

    __call__

    Collection

    Sized, +Iterable, +Container

    __contains__, +__iter__, +__len__

    Sequence

    Reversible, +Collection

    __getitem__, +__len__

    __contains__, __iter__, __reversed__, +index, and count

    MutableSequence

    Sequence

    __getitem__, +__setitem__, +__delitem__, +__len__, +insert

    Inherited Sequence methods and +append, reverse, extend, pop, +remove, and __iadd__

    ByteString

    Sequence

    __getitem__, +__len__

    Inherited Sequence methods

    Set

    Collection

    __contains__, +__iter__, +__len__

    __le__, __lt__, __eq__, __ne__, +__gt__, __ge__, __and__, __or__, +__sub__, __xor__, and isdisjoint

    MutableSet

    Set

    __contains__, +__iter__, +__len__, +add, +discard

    Inherited Set methods and +clear, pop, remove, __ior__, +__iand__, __ixor__, and __isub__

    Mapping

    Collection

    __getitem__, +__iter__, +__len__

    __contains__, keys, items, values, +get, __eq__, and __ne__

    MutableMapping

    Mapping

    __getitem__, +__setitem__, +__delitem__, +__iter__, +__len__

    Inherited Mapping methods and +pop, popitem, clear, update, +and setdefault

    MappingView

    Sized

    __len__

    ItemsView

    MappingView, +Set

    __contains__, +__iter__

    KeysView

    MappingView, +Set

    __contains__, +__iter__

    ValuesView

    MappingView, +Collection

    __contains__, __iter__

    Awaitable

    __await__

    Coroutine

    Awaitable

    send, throw

    close

    AsyncIterable

    __aiter__

    AsyncIterator

    AsyncIterable

    __anext__

    __aiter__

    AsyncGenerator

    AsyncIterator

    asend, athrow

    aclose, __aiter__, __anext__

    +
    +
    +class collections.abc.Container
    +
    +class collections.abc.Hashable
    +
    +class collections.abc.Sized
    +
    +class collections.abc.Callable
    +

    ABCs for classes that provide respectively the methods __contains__(), +__hash__(), __len__(), and __call__().

    +
    + +
    +
    +class collections.abc.Iterable
    +

    ABC for classes that provide the __iter__() method.

    +

    Checking isinstance(obj, Iterable) detects classes that are registered +as Iterable or that have an __iter__() method, but it does +not detect classes that iterate with the __getitem__() method. +The only reliable way to determine whether an object is iterable +is to call iter(obj).

    +
    + +
    +
    +class collections.abc.Collection
    +

    ABC for sized iterable container classes.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +class collections.abc.Iterator
    +

    ABC for classes that provide the __iter__() and +__next__() methods. See also the definition of +iterator.

    +
    + +
    +
    +class collections.abc.Reversible
    +

    ABC for iterable classes that also provide the __reversed__() +method.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +class collections.abc.Generator
    +

    ABC for generator classes that implement the protocol defined in +PEP 342 that extends iterators with the send(), +throw() and close() methods. +See also the definition of generator.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +class collections.abc.Sequence
    +
    +class collections.abc.MutableSequence
    +
    +class collections.abc.ByteString
    +

    ABCs for read-only and mutable sequences.

    +

    Implementation note: Some of the mixin methods, such as +__iter__(), __reversed__() and index(), make +repeated calls to the underlying __getitem__() method. +Consequently, if __getitem__() is implemented with constant +access speed, the mixin methods will have linear performance; +however, if the underlying method is linear (as it would be with a +linked list), the mixins will have quadratic performance and will +likely need to be overridden.

    +
    +

    Changed in version 3.5: The index() method added support for stop and start +arguments.

    +
    +
    + +
    +
    +class collections.abc.Set
    +
    +class collections.abc.MutableSet
    +

    ABCs for read-only and mutable sets.

    +
    + +
    +
    +class collections.abc.Mapping
    +
    +class collections.abc.MutableMapping
    +

    ABCs for read-only and mutable mappings.

    +
    + +
    +
    +class collections.abc.MappingView
    +
    +class collections.abc.ItemsView
    +
    +class collections.abc.KeysView
    +
    +class collections.abc.ValuesView
    +

    ABCs for mapping, items, keys, and values views.

    +
    + +
    +
    +class collections.abc.Awaitable
    +

    ABC for awaitable objects, which can be used in await +expressions. Custom implementations must provide the __await__() +method.

    +

    Coroutine objects and instances of the +Coroutine ABC are all instances of this ABC.

    +
    +

    Note

    +

    In CPython, generator-based coroutines (generators decorated with +types.coroutine() or asyncio.coroutine()) are +awaitables, even though they do not have an __await__() method. +Using isinstance(gencoro, Awaitable) for them will return False. +Use inspect.isawaitable() to detect them.

    +
    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +class collections.abc.Coroutine
    +

    ABC for coroutine compatible classes. These implement the +following methods, defined in Coroutine Objects: +send(), throw(), and +close(). Custom implementations must also implement +__await__(). All Coroutine instances are also instances of +Awaitable. See also the definition of coroutine.

    +
    +

    Note

    +

    In CPython, generator-based coroutines (generators decorated with +types.coroutine() or asyncio.coroutine()) are +awaitables, even though they do not have an __await__() method. +Using isinstance(gencoro, Coroutine) for them will return False. +Use inspect.isawaitable() to detect them.

    +
    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +class collections.abc.AsyncIterable
    +

    ABC for classes that provide __aiter__ method. See also the +definition of asynchronous iterable.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +class collections.abc.AsyncIterator
    +

    ABC for classes that provide __aiter__ and __anext__ +methods. See also the definition of asynchronous iterator.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +class collections.abc.AsyncGenerator
    +

    ABC for asynchronous generator classes that implement the protocol +defined in PEP 525 and PEP 492.

    +
    +

    New in version 3.6.

    +
    +
    + +

    These ABCs allow us to ask classes or instances if they provide +particular functionality, for example:

    +
    size = None
    +if isinstance(myvar, collections.abc.Sized):
    +    size = len(myvar)
    +
    +
    +

    Several of the ABCs are also useful as mixins that make it easier to develop +classes supporting container APIs. For example, to write a class supporting +the full Set API, it is only necessary to supply the three underlying +abstract methods: __contains__(), __iter__(), and __len__(). +The ABC supplies the remaining methods such as __and__() and +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)
    +
    +s1 = ListBasedSet('abcdef')
    +s2 = ListBasedSet('defghi')
    +overlap = s1 & s2            # The __and__() method is supported automatically
    +
    +
    +

    Notes on using Set and MutableSet as a mixin:

    +
      +
    1. Since some set operations create new sets, the default mixin methods need +a way to create new instances from an iterable. The class constructor is +assumed to have a signature in the form ClassName(iterable). +That assumption is factored-out to an internal classmethod called +_from_iterable() which calls cls(iterable) to produce a new set. +If the Set mixin is being used in a class with a different +constructor signature, you will need to override _from_iterable() +with a classmethod that can construct new instances from +an iterable argument.

    2. +
    3. To override the comparisons (presumably for speed, as the +semantics are fixed), redefine __le__() and __ge__(), +then the other operations will automatically follow suit.

    4. +
    5. The Set mixin provides a _hash() method to compute a hash value +for the set; however, __hash__() is not defined because not all sets +are hashable or immutable. To add set hashability using mixins, +inherit from both Set() and Hashable(), then define +__hash__ = Set._hash.

    6. +
    +
    +

    See also

    + +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/collections.html b/python-3.7.4-docs-html/library/collections.html new file mode 100644 index 0000000..00014ba --- /dev/null +++ b/python-3.7.4-docs-html/library/collections.html @@ -0,0 +1,1461 @@ + + + + + + + collections — Container datatypes — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    collections — Container datatypes

    +

    Source code: Lib/collections/__init__.py

    +
    +

    This module implements specialized container datatypes providing alternatives to +Python’s general purpose built-in containers, dict, list, +set, and tuple.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    namedtuple()

    factory function for creating tuple subclasses with named fields

    deque

    list-like container with fast appends and pops on either end

    ChainMap

    dict-like class for creating a single view of multiple mappings

    Counter

    dict subclass for counting hashable objects

    OrderedDict

    dict subclass that remembers the order entries were added

    defaultdict

    dict subclass that calls a factory function to supply missing values

    UserDict

    wrapper around dictionary objects for easier dict subclassing

    UserList

    wrapper around list objects for easier list subclassing

    UserString

    wrapper around string objects for easier string subclassing

    +
    +

    Changed in version 3.3: Moved Collections Abstract Base Classes to the collections.abc module. +For backwards compatibility, they continue to be visible in this module through +Python 3.7. Subsequently, they will be removed entirely.

    +
    +
    +

    ChainMap objects

    +
    +

    New in version 3.3.

    +
    +

    A ChainMap class is provided for quickly linking a number of mappings +so they can be treated as a single unit. It is often much faster than creating +a new dictionary and running multiple update() calls.

    +

    The class can be used to simulate nested scopes and is useful in templating.

    +
    +
    +class collections.ChainMap(*maps)
    +

    A ChainMap groups multiple dicts or other mappings together to +create a single, updateable view. If no maps are specified, a single empty +dictionary is provided so that a new chain always has at least one mapping.

    +

    The underlying mappings are stored in a list. That list is public and can +be accessed or updated using the maps attribute. There is no other state.

    +

    Lookups search the underlying mappings successively until a key is found. In +contrast, writes, updates, and deletions only operate on the first mapping.

    +

    A ChainMap incorporates the underlying mappings by reference. So, if +one of the underlying mappings gets updated, those changes will be reflected +in ChainMap.

    +

    All of the usual dictionary methods are supported. In addition, there is a +maps attribute, a method for creating new subcontexts, and a property for +accessing all but the first mapping:

    +
    +
    +maps
    +

    A user updateable list of mappings. The list is ordered from +first-searched to last-searched. It is the only stored state and can +be modified to change which mappings are searched. The list should +always contain at least one mapping.

    +
    + +
    +
    +new_child(m=None)
    +

    Returns a new ChainMap containing a new map followed by +all of the maps in the current instance. If m is specified, +it becomes the new map at the front of the list of mappings; if not +specified, an empty dict is used, so that a call to d.new_child() +is equivalent to: ChainMap({}, *d.maps). This method is used for +creating subcontexts that can be updated without altering values in any +of the parent mappings.

    +
    +

    Changed in version 3.4: The optional m parameter was added.

    +
    +
    + +
    +
    +parents
    +

    Property returning a new ChainMap containing all of the maps in +the current instance except the first one. This is useful for skipping +the first map in the search. Use cases are similar to those for the +nonlocal keyword used in nested scopes. The use cases also parallel those for the built-in +super() function. A reference to d.parents is equivalent to: +ChainMap(*d.maps[1:]).

    +
    + +

    Note, the iteration order of a ChainMap() is determined by +scanning the mappings last to first:

    +
    >>> baseline = {'music': 'bach', 'art': 'rembrandt'}
    +>>> adjustments = {'art': 'van gogh', 'opera': 'carmen'}
    +>>> list(ChainMap(adjustments, baseline))
    +['music', 'art', 'opera']
    +
    +
    +

    This gives the same ordering as a series of dict.update() calls +starting with the last mapping:

    +
    >>> combined = baseline.copy()
    +>>> combined.update(adjustments)
    +>>> list(combined)
    +['music', 'art', 'opera']
    +
    +
    +
    + +
    +

    See also

    + +
    +
    +

    ChainMap Examples and Recipes

    +

    This section shows various approaches to working with chained maps.

    +

    Example of simulating Python’s internal lookup chain:

    +
    import builtins
    +pylookup = ChainMap(locals(), globals(), vars(builtins))
    +
    +
    +

    Example of letting user specified command-line arguments take precedence over +environment variables which in turn take precedence over default values:

    +
    import os, argparse
    +
    +defaults = {'color': 'red', 'user': 'guest'}
    +
    +parser = argparse.ArgumentParser()
    +parser.add_argument('-u', '--user')
    +parser.add_argument('-c', '--color')
    +namespace = parser.parse_args()
    +command_line_args = {k:v for k, v in vars(namespace).items() if v}
    +
    +combined = ChainMap(command_line_args, os.environ, defaults)
    +print(combined['color'])
    +print(combined['user'])
    +
    +
    +

    Example patterns for using the ChainMap class to simulate nested +contexts:

    +
    c = ChainMap()        # Create root context
    +d = c.new_child()     # Create nested child context
    +e = c.new_child()     # Child of c, independent from d
    +e.maps[0]             # Current context dictionary -- like Python's locals()
    +e.maps[-1]            # Root context -- like Python's globals()
    +e.parents             # Enclosing context chain -- like Python's nonlocals
    +
    +d['x'] = 1            # Set value in current context
    +d['x']                # Get first key in the chain of contexts
    +del d['x']            # Delete from current context
    +list(d)               # All nested values
    +k in d                # Check all nested values
    +len(d)                # Number of nested values
    +d.items()             # All nested items
    +dict(d)               # Flatten into a regular dictionary
    +
    +
    +

    The ChainMap class only makes updates (writes and deletions) to the +first mapping in the chain while lookups will search the full chain. However, +if deep writes and deletions are desired, it is easy to make a subclass that +updates keys found deeper in the chain:

    +
    class DeepChainMap(ChainMap):
    +    'Variant of ChainMap that allows direct updates to inner scopes'
    +
    +    def __setitem__(self, key, value):
    +        for mapping in self.maps:
    +            if key in mapping:
    +                mapping[key] = value
    +                return
    +        self.maps[0][key] = value
    +
    +    def __delitem__(self, key):
    +        for mapping in self.maps:
    +            if key in mapping:
    +                del mapping[key]
    +                return
    +        raise KeyError(key)
    +
    +>>> d = DeepChainMap({'zebra': 'black'}, {'elephant': 'blue'}, {'lion': 'yellow'})
    +>>> d['lion'] = 'orange'         # update an existing key two levels down
    +>>> d['snake'] = 'red'           # new keys get added to the topmost dict
    +>>> del d['elephant']            # remove an existing key one level down
    +>>> d                            # display result
    +DeepChainMap({'zebra': 'black', 'snake': 'red'}, {}, {'lion': 'orange'})
    +
    +
    +
    +
    +
    +

    Counter objects

    +

    A counter tool is provided to support convenient and rapid tallies. +For example:

    +
    >>> # Tally occurrences of words in a list
    +>>> cnt = Counter()
    +>>> for word in ['red', 'blue', 'red', 'green', 'blue', 'blue']:
    +...     cnt[word] += 1
    +>>> cnt
    +Counter({'blue': 3, 'red': 2, 'green': 1})
    +
    +>>> # Find the ten most common words in Hamlet
    +>>> import re
    +>>> words = re.findall(r'\w+', open('hamlet.txt').read().lower())
    +>>> Counter(words).most_common(10)
    +[('the', 1143), ('and', 966), ('to', 762), ('of', 669), ('i', 631),
    + ('you', 554),  ('a', 546), ('my', 514), ('hamlet', 471), ('in', 451)]
    +
    +
    +
    +
    +class collections.Counter([iterable-or-mapping])
    +

    A Counter is a dict subclass for counting hashable objects. +It is a collection where elements are stored as dictionary keys +and their counts are stored as dictionary values. Counts are allowed to be +any integer value including zero or negative counts. The Counter +class is similar to bags or multisets in other languages.

    +

    Elements are counted from an iterable or initialized from another +mapping (or counter):

    +
    >>> c = Counter()                           # a new, empty counter
    +>>> c = Counter('gallahad')                 # a new counter from an iterable
    +>>> c = Counter({'red': 4, 'blue': 2})      # a new counter from a mapping
    +>>> c = Counter(cats=4, dogs=8)             # a new counter from keyword args
    +
    +
    +

    Counter objects have a dictionary interface except that they return a zero +count for missing items instead of raising a KeyError:

    +
    >>> c = Counter(['eggs', 'ham'])
    +>>> c['bacon']                              # count of a missing element is zero
    +0
    +
    +
    +

    Setting a count to zero does not remove an element from a counter. +Use del to remove it entirely:

    +
    >>> c['sausage'] = 0                        # counter entry with a zero count
    +>>> del c['sausage']                        # del actually removes the entry
    +
    +
    +
    +

    New in version 3.1.

    +
    +

    Counter objects support three methods beyond those available for all +dictionaries:

    +
    +
    +elements()
    +

    Return an iterator over elements repeating each as many times as its +count. Elements are returned in arbitrary order. If an element’s count +is less than one, elements() will ignore it.

    +
    >>> c = Counter(a=4, b=2, c=0, d=-2)
    +>>> sorted(c.elements())
    +['a', 'a', 'a', 'a', 'b', 'b']
    +
    +
    +
    + +
    +
    +most_common([n])
    +

    Return a list of the n most common elements and their counts from the +most common to the least. If n is omitted or None, +most_common() returns all elements in the counter. +Elements with equal counts are ordered arbitrarily:

    +
    >>> Counter('abracadabra').most_common(3)  # doctest: +SKIP
    +[('a', 5), ('r', 2), ('b', 2)]
    +
    +
    +
    + +
    +
    +subtract([iterable-or-mapping])
    +

    Elements are subtracted from an iterable or from another mapping +(or counter). Like dict.update() but subtracts counts instead +of replacing them. Both inputs and outputs may be zero or negative.

    +
    >>> c = Counter(a=4, b=2, c=0, d=-2)
    +>>> d = Counter(a=1, b=2, c=3, d=4)
    +>>> c.subtract(d)
    +>>> c
    +Counter({'a': 3, 'b': 0, 'c': -3, 'd': -6})
    +
    +
    +
    +

    New in version 3.2.

    +
    +
    + +

    The usual dictionary methods are available for Counter objects +except for two which work differently for counters.

    +
    +
    +fromkeys(iterable)
    +

    This class method is not implemented for Counter objects.

    +
    + +
    +
    +update([iterable-or-mapping])
    +

    Elements are counted from an iterable or added-in from another +mapping (or counter). Like dict.update() but adds counts +instead of replacing them. Also, the iterable is expected to be a +sequence of elements, not a sequence of (key, value) pairs.

    +
    + +
    + +

    Common patterns for working with Counter objects:

    +
    sum(c.values())                 # total of all counts
    +c.clear()                       # reset all counts
    +list(c)                         # list unique elements
    +set(c)                          # convert to a set
    +dict(c)                         # convert to a regular dictionary
    +c.items()                       # convert to a list of (elem, cnt) pairs
    +Counter(dict(list_of_pairs))    # convert from a list of (elem, cnt) pairs
    +c.most_common()[:-n-1:-1]       # n least common elements
    ++c                              # remove zero and negative counts
    +
    +
    +

    Several mathematical operations are provided for combining Counter +objects to produce multisets (counters that have counts greater than zero). +Addition and subtraction combine counters by adding or subtracting the counts +of corresponding elements. Intersection and union return the minimum and +maximum of corresponding counts. Each operation can accept inputs with signed +counts, but the output will exclude results with counts of zero or less.

    +
    >>> c = Counter(a=3, b=1)
    +>>> d = Counter(a=1, b=2)
    +>>> c + d                       # add two counters together:  c[x] + d[x]
    +Counter({'a': 4, 'b': 3})
    +>>> c - d                       # subtract (keeping only positive counts)
    +Counter({'a': 2})
    +>>> c & d                       # intersection:  min(c[x], d[x]) # doctest: +SKIP
    +Counter({'a': 1, 'b': 1})
    +>>> c | d                       # union:  max(c[x], d[x])
    +Counter({'a': 3, 'b': 2})
    +
    +
    +

    Unary addition and subtraction are shortcuts for adding an empty counter +or subtracting from an empty counter.

    +
    >>> c = Counter(a=2, b=-4)
    +>>> +c
    +Counter({'a': 2})
    +>>> -c
    +Counter({'b': 4})
    +
    +
    +
    +

    New in version 3.3: Added support for unary plus, unary minus, and in-place multiset operations.

    +
    +
    +

    Note

    +

    Counters were primarily designed to work with positive integers to represent +running counts; however, care was taken to not unnecessarily preclude use +cases needing other types or negative values. To help with those use cases, +this section documents the minimum range and type restrictions.

    +
      +
    • The Counter class itself is a dictionary subclass with no +restrictions on its keys and values. The values are intended to be numbers +representing counts, but you could store anything in the value field.

    • +
    • The most_common() method requires only that the values be orderable.

    • +
    • For in-place operations such as c[key] += 1, the value type need only +support addition and subtraction. So fractions, floats, and decimals would +work and negative values are supported. The same is also true for +update() and subtract() which allow negative and zero values +for both inputs and outputs.

    • +
    • The multiset methods are designed only for use cases with positive values. +The inputs may be negative or zero, but only outputs with positive values +are created. There are no type restrictions, but the value type needs to +support addition, subtraction, and comparison.

    • +
    • The elements() method requires integer counts. It ignores zero and +negative counts.

    • +
    +
    +
    +

    See also

    +
      +
    • Bag class +in Smalltalk.

    • +
    • Wikipedia entry for Multisets.

    • +
    • C++ multisets +tutorial with examples.

    • +
    • For mathematical operations on multisets and their use cases, see +Knuth, Donald. The Art of Computer Programming Volume II, +Section 4.6.3, Exercise 19.

    • +
    • To enumerate all distinct multisets of a given size over a given set of +elements, see itertools.combinations_with_replacement():

      +
      map(Counter, combinations_with_replacement('ABC', 2)) # --> AA AB AC BB BC CC
      +
      +
      +
    • +
    +
    +
    +
    +

    deque objects

    +
    +
    +class collections.deque([iterable[, maxlen]])
    +

    Returns a new deque object initialized left-to-right (using append()) with +data from iterable. If iterable is not specified, the new deque is empty.

    +

    Deques are a generalization of stacks and queues (the name is pronounced “deck” +and is short for “double-ended queue”). Deques support thread-safe, memory +efficient appends and pops from either side of the deque with approximately the +same O(1) performance in either direction.

    +

    Though list objects support similar operations, they are optimized for +fast fixed-length operations and incur O(n) memory movement costs for +pop(0) and insert(0, v) operations which change both the size and +position of the underlying data representation.

    +

    If maxlen is not specified or is None, deques may grow to an +arbitrary length. Otherwise, the deque is bounded to the specified maximum +length. Once a bounded length deque is full, when new items are added, a +corresponding number of items are discarded from the opposite end. Bounded +length deques provide functionality similar to the tail filter in +Unix. They are also useful for tracking transactions and other pools of data +where only the most recent activity is of interest.

    +

    Deque objects support the following methods:

    +
    +
    +append(x)
    +

    Add x to the right side of the deque.

    +
    + +
    +
    +appendleft(x)
    +

    Add x to the left side of the deque.

    +
    + +
    +
    +clear()
    +

    Remove all elements from the deque leaving it with length 0.

    +
    + +
    +
    +copy()
    +

    Create a shallow copy of the deque.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +count(x)
    +

    Count the number of deque elements equal to x.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +extend(iterable)
    +

    Extend the right side of the deque by appending elements from the iterable +argument.

    +
    + +
    +
    +extendleft(iterable)
    +

    Extend the left side of the deque by appending elements from iterable. +Note, the series of left appends results in reversing the order of +elements in the iterable argument.

    +
    + +
    +
    +index(x[, start[, stop]])
    +

    Return the position of x in the deque (at or after index start +and before index stop). Returns the first match or raises +ValueError if not found.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +insert(i, x)
    +

    Insert x into the deque at position i.

    +

    If the insertion would cause a bounded deque to grow beyond maxlen, +an IndexError is raised.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +pop()
    +

    Remove and return an element from the right side of the deque. If no +elements are present, raises an IndexError.

    +
    + +
    +
    +popleft()
    +

    Remove and return an element from the left side of the deque. If no +elements are present, raises an IndexError.

    +
    + +
    +
    +remove(value)
    +

    Remove the first occurrence of value. If not found, raises a +ValueError.

    +
    + +
    +
    +reverse()
    +

    Reverse the elements of the deque in-place and then return None.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +rotate(n=1)
    +

    Rotate the deque n steps to the right. If n is negative, rotate +to the left.

    +

    When the deque is not empty, rotating one step to the right is equivalent +to d.appendleft(d.pop()), and rotating one step to the left is +equivalent to d.append(d.popleft()).

    +
    + +

    Deque objects also provide one read-only attribute:

    +
    +
    +maxlen
    +

    Maximum size of a deque or None if unbounded.

    +
    +

    New in version 3.1.

    +
    +
    + +
    + +

    In addition to the above, deques support iteration, pickling, len(d), +reversed(d), copy.copy(d), copy.deepcopy(d), membership testing with +the in operator, and subscript references such as d[-1]. Indexed +access is O(1) at both ends but slows to O(n) in the middle. For fast random +access, use lists instead.

    +

    Starting in version 3.5, deques support __add__(), __mul__(), +and __imul__().

    +

    Example:

    +
    >>> from collections import deque
    +>>> d = deque('ghi')                 # make a new deque with three items
    +>>> for elem in d:                   # iterate over the deque's elements
    +...     print(elem.upper())
    +G
    +H
    +I
    +
    +>>> d.append('j')                    # add a new entry to the right side
    +>>> d.appendleft('f')                # add a new entry to the left side
    +>>> d                                # show the representation of the deque
    +deque(['f', 'g', 'h', 'i', 'j'])
    +
    +>>> d.pop()                          # return and remove the rightmost item
    +'j'
    +>>> d.popleft()                      # return and remove the leftmost item
    +'f'
    +>>> list(d)                          # list the contents of the deque
    +['g', 'h', 'i']
    +>>> d[0]                             # peek at leftmost item
    +'g'
    +>>> d[-1]                            # peek at rightmost item
    +'i'
    +
    +>>> list(reversed(d))                # list the contents of a deque in reverse
    +['i', 'h', 'g']
    +>>> 'h' in d                         # search the deque
    +True
    +>>> d.extend('jkl')                  # add multiple elements at once
    +>>> d
    +deque(['g', 'h', 'i', 'j', 'k', 'l'])
    +>>> d.rotate(1)                      # right rotation
    +>>> d
    +deque(['l', 'g', 'h', 'i', 'j', 'k'])
    +>>> d.rotate(-1)                     # left rotation
    +>>> d
    +deque(['g', 'h', 'i', 'j', 'k', 'l'])
    +
    +>>> deque(reversed(d))               # make a new deque in reverse order
    +deque(['l', 'k', 'j', 'i', 'h', 'g'])
    +>>> d.clear()                        # empty the deque
    +>>> d.pop()                          # cannot pop from an empty deque
    +Traceback (most recent call last):
    +    File "<pyshell#6>", line 1, in -toplevel-
    +        d.pop()
    +IndexError: pop from an empty deque
    +
    +>>> d.extendleft('abc')              # extendleft() reverses the input order
    +>>> d
    +deque(['c', 'b', 'a'])
    +
    +
    +
    +

    deque Recipes

    +

    This section shows various approaches to working with deques.

    +

    Bounded length deques provide functionality similar to the tail filter +in Unix:

    +
    def tail(filename, n=10):
    +    'Return the last n lines of a file'
    +    with open(filename) as f:
    +        return deque(f, n)
    +
    +
    +

    Another approach to using deques is to maintain a sequence of recently +added elements by appending to the right and popping to the left:

    +
    def moving_average(iterable, n=3):
    +    # moving_average([40, 30, 50, 46, 39, 44]) --> 40.0 42.0 45.0 43.0
    +    # http://en.wikipedia.org/wiki/Moving_average
    +    it = iter(iterable)
    +    d = deque(itertools.islice(it, n-1))
    +    d.appendleft(0)
    +    s = sum(d)
    +    for elem in it:
    +        s += elem - d.popleft()
    +        d.append(elem)
    +        yield s / n
    +
    +
    +

    A round-robin scheduler can be implemented with +input iterators stored in a deque. Values are yielded from the active +iterator in position zero. If that iterator is exhausted, it can be removed +with popleft(); otherwise, it can be cycled back to the end with +the rotate() method:

    +
    def roundrobin(*iterables):
    +    "roundrobin('ABC', 'D', 'EF') --> A D E B F C"
    +    iterators = deque(map(iter, iterables))
    +    while iterators:
    +        try:
    +            while True:
    +                yield next(iterators[0])
    +                iterators.rotate(-1)
    +        except StopIteration:
    +            # Remove an exhausted iterator.
    +            iterators.popleft()
    +
    +
    +

    The rotate() method provides a way to implement deque slicing and +deletion. For example, a pure Python implementation of del d[n] relies on +the rotate() method to position elements to be popped:

    +
    def delete_nth(d, n):
    +    d.rotate(-n)
    +    d.popleft()
    +    d.rotate(n)
    +
    +
    +

    To implement deque slicing, use a similar approach applying +rotate() to bring a target element to the left side of the deque. Remove +old entries with popleft(), add new entries with extend(), and then +reverse the rotation. +With minor variations on that approach, it is easy to implement Forth style +stack manipulations such as dup, drop, swap, over, pick, +rot, and roll.

    +
    +
    +
    +

    defaultdict objects

    +
    +
    +class collections.defaultdict([default_factory[, ...]])
    +

    Returns a new dictionary-like object. defaultdict is a subclass of the +built-in dict class. It overrides one method and adds one writable +instance variable. The remaining functionality is the same as for the +dict class and is not documented here.

    +

    The first argument provides the initial value for the default_factory +attribute; it defaults to None. All remaining arguments are treated the same +as if they were passed to the dict constructor, including keyword +arguments.

    +

    defaultdict objects support the following method in addition to the +standard dict operations:

    +
    +
    +__missing__(key)
    +

    If the default_factory attribute is None, this raises a +KeyError exception with the key as argument.

    +

    If default_factory is not None, it is called without arguments +to provide a default value for the given key, this value is inserted in +the dictionary for the key, and returned.

    +

    If calling default_factory raises an exception this exception is +propagated unchanged.

    +

    This method is called by the __getitem__() method of the +dict class when the requested key is not found; whatever it +returns or raises is then returned or raised by __getitem__().

    +

    Note that __missing__() is not called for any operations besides +__getitem__(). This means that get() will, like normal +dictionaries, return None as a default rather than using +default_factory.

    +
    + +

    defaultdict objects support the following instance variable:

    +
    +
    +default_factory
    +

    This attribute is used by the __missing__() method; it is +initialized from the first argument to the constructor, if present, or to +None, if absent.

    +
    + +
    + +
    +

    defaultdict Examples

    +

    Using list as the default_factory, it is easy to group a +sequence of key-value pairs into a dictionary of lists:

    +
    >>> s = [('yellow', 1), ('blue', 2), ('yellow', 3), ('blue', 4), ('red', 1)]
    +>>> d = defaultdict(list)
    +>>> for k, v in s:
    +...     d[k].append(v)
    +...
    +>>> sorted(d.items())
    +[('blue', [2, 4]), ('red', [1]), ('yellow', [1, 3])]
    +
    +
    +

    When each key is encountered for the first time, it is not already in the +mapping; so an entry is automatically created using the default_factory +function which returns an empty list. The list.append() +operation then attaches the value to the new list. When keys are encountered +again, the look-up proceeds normally (returning the list for that key) and the +list.append() operation adds another value to the list. This technique is +simpler and faster than an equivalent technique using dict.setdefault():

    +
    >>> d = {}
    +>>> for k, v in s:
    +...     d.setdefault(k, []).append(v)
    +...
    +>>> sorted(d.items())
    +[('blue', [2, 4]), ('red', [1]), ('yellow', [1, 3])]
    +
    +
    +

    Setting the default_factory to int makes the +defaultdict useful for counting (like a bag or multiset in other +languages):

    +
    >>> s = 'mississippi'
    +>>> d = defaultdict(int)
    +>>> for k in s:
    +...     d[k] += 1
    +...
    +>>> sorted(d.items())
    +[('i', 4), ('m', 1), ('p', 2), ('s', 4)]
    +
    +
    +

    When a letter is first encountered, it is missing from the mapping, so the +default_factory function calls int() to supply a default count of +zero. The increment operation then builds up the count for each letter.

    +

    The function int() which always returns zero is just a special case of +constant functions. A faster and more flexible way to create constant functions +is to use a lambda function which can supply any constant value (not just +zero):

    +
    >>> def constant_factory(value):
    +...     return lambda: value
    +>>> d = defaultdict(constant_factory('<missing>'))
    +>>> d.update(name='John', action='ran')
    +>>> '%(name)s %(action)s to %(object)s' % d
    +'John ran to <missing>'
    +
    +
    +

    Setting the default_factory to set makes the +defaultdict useful for building a dictionary of sets:

    +
    >>> s = [('red', 1), ('blue', 2), ('red', 3), ('blue', 4), ('red', 1), ('blue', 4)]
    +>>> d = defaultdict(set)
    +>>> for k, v in s:
    +...     d[k].add(v)
    +...
    +>>> sorted(d.items())
    +[('blue', {2, 4}), ('red', {1, 3})]
    +
    +
    +
    +
    +
    +

    namedtuple() Factory Function for Tuples with Named Fields

    +

    Named tuples assign meaning to each position in a tuple and allow for more readable, +self-documenting code. They can be used wherever regular tuples are used, and +they add the ability to access fields by name instead of position index.

    +
    +
    +collections.namedtuple(typename, field_names, *, rename=False, defaults=None, module=None)
    +

    Returns a new tuple subclass named typename. The new subclass is used to +create tuple-like objects that have fields accessible by attribute lookup as +well as being indexable and iterable. Instances of the subclass also have a +helpful docstring (with typename and field_names) and a helpful __repr__() +method which lists the tuple contents in a name=value format.

    +

    The field_names are a sequence of strings such as ['x', 'y']. +Alternatively, field_names can be a single string with each fieldname +separated by whitespace and/or commas, for example 'x y' or 'x, y'.

    +

    Any valid Python identifier may be used for a fieldname except for names +starting with an underscore. Valid identifiers consist of letters, digits, +and underscores but do not start with a digit or underscore and cannot be +a keyword such as class, for, return, global, pass, +or raise.

    +

    If rename is true, invalid fieldnames are automatically replaced +with positional names. For example, ['abc', 'def', 'ghi', 'abc'] is +converted to ['abc', '_1', 'ghi', '_3'], eliminating the keyword +def and the duplicate fieldname abc.

    +

    defaults can be None or an iterable of default values. +Since fields with a default value must come after any fields without a +default, the defaults are applied to the rightmost parameters. For +example, if the fieldnames are ['x', 'y', 'z'] and the defaults are +(1, 2), then x will be a required argument, y will default to +1, and z will default to 2.

    +

    If module is defined, the __module__ attribute of the named tuple is +set to that value.

    +

    Named tuple instances do not have per-instance dictionaries, so they are +lightweight and require no more memory than regular tuples.

    +
    +

    Changed in version 3.1: Added support for rename.

    +
    +
    +

    Changed in version 3.6: The verbose and rename parameters became +keyword-only arguments.

    +
    +
    +

    Changed in version 3.6: Added the module parameter.

    +
    +
    +

    Changed in version 3.7: Remove the verbose parameter and the _source attribute.

    +
    +
    +

    Changed in version 3.7: Added the defaults parameter and the _field_defaults +attribute.

    +
    +
    + +
    >>> # Basic example
    +>>> Point = namedtuple('Point', ['x', 'y'])
    +>>> p = Point(11, y=22)     # instantiate with positional or keyword arguments
    +>>> p[0] + p[1]             # indexable like the plain tuple (11, 22)
    +33
    +>>> x, y = p                # unpack like a regular tuple
    +>>> x, y
    +(11, 22)
    +>>> p.x + p.y               # fields also accessible by name
    +33
    +>>> p                       # readable __repr__ with a name=value style
    +Point(x=11, y=22)
    +
    +
    +

    Named tuples are especially useful for assigning field names to result tuples returned +by the csv or sqlite3 modules:

    +
    EmployeeRecord = namedtuple('EmployeeRecord', 'name, age, title, department, paygrade')
    +
    +import csv
    +for emp in map(EmployeeRecord._make, csv.reader(open("employees.csv", "rb"))):
    +    print(emp.name, emp.title)
    +
    +import sqlite3
    +conn = sqlite3.connect('/companydata')
    +cursor = conn.cursor()
    +cursor.execute('SELECT name, age, title, department, paygrade FROM employees')
    +for emp in map(EmployeeRecord._make, cursor.fetchall()):
    +    print(emp.name, emp.title)
    +
    +
    +

    In addition to the methods inherited from tuples, named tuples support +three additional methods and two attributes. To prevent conflicts with +field names, the method and attribute names start with an underscore.

    +
    +
    +classmethod somenamedtuple._make(iterable)
    +

    Class method that makes a new instance from an existing sequence or iterable.

    +
    >>> t = [11, 22]
    +>>> Point._make(t)
    +Point(x=11, y=22)
    +
    +
    +
    + +
    +
    +somenamedtuple._asdict()
    +

    Return a new dict which maps field names to their corresponding +values:

    +
    >>> p = Point(x=11, y=22)
    +>>> p._asdict()
    +OrderedDict([('x', 11), ('y', 22)])
    +
    +
    +
    +

    Changed in version 3.1: Returns an OrderedDict instead of a regular dict.

    +
    +
    + +
    +
    +somenamedtuple._replace(**kwargs)
    +

    Return a new instance of the named tuple replacing specified fields with new +values:

    +
    >>> p = Point(x=11, y=22)
    +>>> p._replace(x=33)
    +Point(x=33, y=22)
    +
    +>>> for partnum, record in inventory.items():
    +...     inventory[partnum] = record._replace(price=newprices[partnum], timestamp=time.now())
    +
    +
    +
    + +
    +
    +somenamedtuple._fields
    +

    Tuple of strings listing the field names. Useful for introspection +and for creating new named tuple types from existing named tuples.

    +
    >>> p._fields            # view the field names
    +('x', 'y')
    +
    +>>> Color = namedtuple('Color', 'red green blue')
    +>>> Pixel = namedtuple('Pixel', Point._fields + Color._fields)
    +>>> Pixel(11, 22, 128, 255, 0)
    +Pixel(x=11, y=22, red=128, green=255, blue=0)
    +
    +
    +
    + +
    +
    +somenamedtuple._field_defaults
    +

    Dictionary mapping field names to default values.

    +
    >>> Account = namedtuple('Account', ['type', 'balance'], defaults=[0])
    +>>> Account._field_defaults
    +{'balance': 0}
    +>>> Account('premium')
    +Account(type='premium', balance=0)
    +
    +
    +
    + +

    To retrieve a field whose name is stored in a string, use the getattr() +function:

    +
    >>> getattr(p, 'x')
    +11
    +
    +
    +

    To convert a dictionary to a named tuple, use the ** operator +(as described in Unpacking Argument Lists):

    +
    >>> d = {'x': 11, 'y': 22}
    +>>> Point(**d)
    +Point(x=11, y=22)
    +
    +
    +

    Since a named tuple is a regular Python class, it is easy to add or change +functionality with a subclass. Here is how to add a calculated field and +a fixed-width print format:

    +
    >>> class Point(namedtuple('Point', ['x', 'y'])):
    +...     __slots__ = ()
    +...     @property
    +...     def hypot(self):
    +...         return (self.x ** 2 + self.y ** 2) ** 0.5
    +...     def __str__(self):
    +...         return 'Point: x=%6.3f  y=%6.3f  hypot=%6.3f' % (self.x, self.y, self.hypot)
    +
    +>>> for p in Point(3, 4), Point(14, 5/7):
    +...     print(p)
    +Point: x= 3.000  y= 4.000  hypot= 5.000
    +Point: x=14.000  y= 0.714  hypot=14.018
    +
    +
    +

    The subclass shown above sets __slots__ to an empty tuple. This helps +keep memory requirements low by preventing the creation of instance dictionaries.

    +

    Subclassing is not useful for adding new, stored fields. Instead, simply +create a new named tuple type from the _fields attribute:

    +
    >>> Point3D = namedtuple('Point3D', Point._fields + ('z',))
    +
    +
    +

    Docstrings can be customized by making direct assignments to the __doc__ +fields:

    +
    >>> Book = namedtuple('Book', ['id', 'title', 'authors'])
    +>>> Book.__doc__ += ': Hardcover book in active collection'
    +>>> Book.id.__doc__ = '13-digit ISBN'
    +>>> Book.title.__doc__ = 'Title of first printing'
    +>>> Book.authors.__doc__ = 'List of authors sorted by last name'
    +
    +
    +
    +

    Changed in version 3.5: Property docstrings became writeable.

    +
    +

    Default values can be implemented by using _replace() to +customize a prototype instance:

    +
    >>> Account = namedtuple('Account', 'owner balance transaction_count')
    +>>> default_account = Account('<owner name>', 0.0, 0)
    +>>> johns_account = default_account._replace(owner='John')
    +>>> janes_account = default_account._replace(owner='Jane')
    +
    +
    +
    +

    See also

    +
      +
    • See typing.NamedTuple for a way to add type hints for named +tuples. It also provides an elegant notation using the class +keyword:

      +
      class Component(NamedTuple):
      +    part_number: int
      +    weight: float
      +    description: Optional[str] = None
      +
      +
      +
    • +
    • See types.SimpleNamespace() for a mutable namespace based on an +underlying dictionary instead of a tuple.

    • +
    • The dataclasses module provides a decorator and functions for +automatically adding generated special methods to user-defined classes.

    • +
    +
    +
    +
    +

    OrderedDict objects

    +

    Ordered dictionaries are just like regular dictionaries but have some extra +capabilities relating to ordering operations. They have become less +important now that the built-in dict class gained the ability +to remember insertion order (this new behavior became guaranteed in +Python 3.7).

    +

    Some differences from dict still remain:

    +
      +
    • The regular dict was designed to be very good at mapping +operations. Tracking insertion order was secondary.

    • +
    • The OrderedDict was designed to be good at reordering operations. +Space efficiency, iteration speed, and the performance of update +operations were secondary.

    • +
    • Algorithmically, OrderedDict can handle frequent reordering +operations better than dict. This makes it suitable for tracking +recent accesses (for example in an LRU cache).

    • +
    • The equality operation for OrderedDict checks for matching order.

    • +
    • The popitem() method of OrderedDict has a different +signature. It accepts an optional argument to specify which item is popped.

    • +
    • OrderedDict has a move_to_end() method to +efficiently reposition an element to an endpoint.

    • +
    • Until Python 3.8, dict lacked a __reversed__() method.

    • +
    +
    +
    +class collections.OrderedDict([items])
    +

    Return an instance of a dict subclass that has methods +specialized for rearranging dictionary order.

    +
    +

    New in version 3.1.

    +
    +
    +
    +popitem(last=True)
    +

    The popitem() method for ordered dictionaries returns and removes a +(key, value) pair. The pairs are returned in +LIFO order if last is true +or FIFO order if false.

    +
    + +
    +
    +move_to_end(key, last=True)
    +

    Move an existing key to either end of an ordered dictionary. The item +is moved to the right end if last is true (the default) or to the +beginning if last is false. Raises KeyError if the key does +not exist:

    +
    >>> d = OrderedDict.fromkeys('abcde')
    +>>> d.move_to_end('b')
    +>>> ''.join(d.keys())
    +'acdeb'
    +>>> d.move_to_end('b', last=False)
    +>>> ''.join(d.keys())
    +'bacde'
    +
    +
    +
    +

    New in version 3.2.

    +
    +
    + +
    + +

    In addition to the usual mapping methods, ordered dictionaries also support +reverse iteration using reversed().

    +

    Equality tests between OrderedDict objects are order-sensitive +and are implemented as list(od1.items())==list(od2.items()). +Equality tests between OrderedDict objects and other +Mapping objects are order-insensitive like regular +dictionaries. This allows OrderedDict objects to be substituted +anywhere a regular dictionary is used.

    +
    +

    Changed in version 3.5: The items, keys, and values views +of OrderedDict now support reverse iteration using reversed().

    +
    +
    +

    Changed in version 3.6: With the acceptance of PEP 468, order is retained for keyword arguments +passed to the OrderedDict constructor and its update() +method.

    +
    +
    +

    OrderedDict Examples and Recipes

    +

    It is straightforward to create an ordered dictionary variant +that remembers the order the keys were last inserted. +If a new entry overwrites an existing entry, the +original insertion position is changed and moved to the end:

    +
    class LastUpdatedOrderedDict(OrderedDict):
    +    'Store items in the order the keys were last added'
    +
    +    def __setitem__(self, key, value):
    +        super().__setitem__(key, value)
    +        super().move_to_end(key)
    +
    +
    +

    An OrderedDict would also be useful for implementing +variants of functools.lru_cache():

    +
    class LRU(OrderedDict):
    +    'Limit size, evicting the least recently looked-up key when full'
    +
    +    def __init__(self, maxsize=128, *args, **kwds):
    +        self.maxsize = maxsize
    +        super().__init__(*args, **kwds)
    +
    +    def __getitem__(self, key):
    +        value = super().__getitem__(key)
    +        self.move_to_end(key)
    +        return value
    +
    +    def __setitem__(self, key, value):
    +        super().__setitem__(key, value)
    +        if len(self) > self.maxsize:
    +            oldest = next(iter(self))
    +            del self[oldest]
    +
    +
    +
    +
    +
    +

    UserDict objects

    +

    The class, UserDict acts as a wrapper around dictionary objects. +The need for this class has been partially supplanted by the ability to +subclass directly from dict; however, this class can be easier +to work with because the underlying dictionary is accessible as an +attribute.

    +
    +
    +class collections.UserDict([initialdata])
    +

    Class that simulates a dictionary. The instance’s contents are kept in a +regular dictionary, which is accessible via the data attribute of +UserDict instances. If initialdata is provided, data is +initialized with its contents; note that a reference to initialdata will not +be kept, allowing it be used for other purposes.

    +

    In addition to supporting the methods and operations of mappings, +UserDict instances provide the following attribute:

    +
    +
    +data
    +

    A real dictionary used to store the contents of the UserDict +class.

    +
    + +
    + +
    +
    +

    UserList objects

    +

    This class acts as a wrapper around list objects. It is a useful base class +for your own list-like classes which can inherit from them and override +existing methods or add new ones. In this way, one can add new behaviors to +lists.

    +

    The need for this class has been partially supplanted by the ability to +subclass directly from list; however, this class can be easier +to work with because the underlying list is accessible as an attribute.

    +
    +
    +class collections.UserList([list])
    +

    Class that simulates a list. The instance’s contents are kept in a regular +list, which is accessible via the data attribute of UserList +instances. The instance’s contents are initially set to a copy of list, +defaulting to the empty list []. list can be any iterable, for +example a real Python list or a UserList object.

    +

    In addition to supporting the methods and operations of mutable sequences, +UserList instances provide the following attribute:

    +
    +
    +data
    +

    A real list object used to store the contents of the +UserList class.

    +
    + +
    + +

    Subclassing requirements: Subclasses of UserList are expected to +offer a constructor which can be called with either no arguments or one +argument. List operations which return a new sequence attempt to create an +instance of the actual implementation class. To do so, it assumes that the +constructor can be called with a single parameter, which is a sequence object +used as a data source.

    +

    If a derived class does not wish to comply with this requirement, all of the +special methods supported by this class will need to be overridden; please +consult the sources for information about the methods which need to be provided +in that case.

    +
    +
    +

    UserString objects

    +

    The class, UserString acts as a wrapper around string objects. +The need for this class has been partially supplanted by the ability to +subclass directly from str; however, this class can be easier +to work with because the underlying string is accessible as an +attribute.

    +
    +
    +class collections.UserString(seq)
    +

    Class that simulates a string object. The instance’s +content is kept in a regular string object, which is accessible via the +data attribute of UserString instances. The instance’s +contents are initially set to a copy of seq. The seq argument can +be any object which can be converted into a string using the built-in +str() function.

    +

    In addition to supporting the methods and operations of strings, +UserString instances provide the following attribute:

    +
    +
    +data
    +

    A real str object used to store the contents of the +UserString class.

    +
    + +
    +

    Changed in version 3.5: New methods __getnewargs__, __rmod__, casefold, +format_map, isprintable, and maketrans.

    +
    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/colorsys.html b/python-3.7.4-docs-html/library/colorsys.html new file mode 100644 index 0000000..d8c5815 --- /dev/null +++ b/python-3.7.4-docs-html/library/colorsys.html @@ -0,0 +1,243 @@ + + + + + + + colorsys — Conversions between color systems — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    colorsys — Conversions between color systems

    +

    Source code: Lib/colorsys.py

    +
    +

    The colorsys module defines bidirectional conversions of color values +between colors expressed in the RGB (Red Green Blue) color space used in +computer monitors and three other coordinate systems: YIQ, HLS (Hue Lightness +Saturation) and HSV (Hue Saturation Value). Coordinates in all of these color +spaces are floating point values. In the YIQ space, the Y coordinate is between +0 and 1, but the I and Q coordinates can be positive or negative. In all other +spaces, the coordinates are all between 0 and 1.

    +
    +

    See also

    +

    More information about color spaces can be found at +http://poynton.ca/ColorFAQ.html and +https://www.cambridgeincolour.com/tutorials/color-spaces.htm.

    +
    +

    The colorsys module defines the following functions:

    +
    +
    +colorsys.rgb_to_yiq(r, g, b)
    +

    Convert the color from RGB coordinates to YIQ coordinates.

    +
    + +
    +
    +colorsys.yiq_to_rgb(y, i, q)
    +

    Convert the color from YIQ coordinates to RGB coordinates.

    +
    + +
    +
    +colorsys.rgb_to_hls(r, g, b)
    +

    Convert the color from RGB coordinates to HLS coordinates.

    +
    + +
    +
    +colorsys.hls_to_rgb(h, l, s)
    +

    Convert the color from HLS coordinates to RGB coordinates.

    +
    + +
    +
    +colorsys.rgb_to_hsv(r, g, b)
    +

    Convert the color from RGB coordinates to HSV coordinates.

    +
    + +
    +
    +colorsys.hsv_to_rgb(h, s, v)
    +

    Convert the color from HSV coordinates to RGB coordinates.

    +
    + +

    Example:

    +
    >>> import colorsys
    +>>> colorsys.rgb_to_hsv(0.2, 0.4, 0.4)
    +(0.5, 0.5, 0.4)
    +>>> colorsys.hsv_to_rgb(0.5, 0.5, 0.4)
    +(0.2, 0.4, 0.4)
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/compileall.html b/python-3.7.4-docs-html/library/compileall.html new file mode 100644 index 0000000..177a8f8 --- /dev/null +++ b/python-3.7.4-docs-html/library/compileall.html @@ -0,0 +1,461 @@ + + + + + + + compileall — Byte-compile Python libraries — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    compileall — Byte-compile Python libraries

    +

    Source code: Lib/compileall.py

    +
    +

    This module provides some utility functions to support installing Python +libraries. These functions compile Python source files in a directory tree. +This module can be used to create the cached byte-code files at library +installation time, which makes them available for use even by users who don’t +have write permission to the library directories.

    +
    +

    Command-line use

    +

    This module can work as a script (using python -m compileall) to +compile Python sources.

    +
    +
    +directory ...
    +
    +file ...
    +

    Positional arguments are files to compile or directories that contain +source files, traversed recursively. If no argument is given, behave as if +the command line was -l <directories from sys.path>.

    +
    + +
    +
    +-l
    +

    Do not recurse into subdirectories, only compile source code files directly +contained in the named or implied directories.

    +
    + +
    +
    +-f
    +

    Force rebuild even if timestamps are up-to-date.

    +
    + +
    +
    +-q
    +

    Do not print the list of files compiled. If passed once, error messages will +still be printed. If passed twice (-qq), all output is suppressed.

    +
    + +
    +
    +-d destdir
    +

    Directory prepended to the path to each file being compiled. This will +appear in compilation time tracebacks, and is also compiled in to the +byte-code file, where it will be used in tracebacks and other messages in +cases where the source file does not exist at the time the byte-code file is +executed.

    +
    + +
    +
    +-x regex
    +

    regex is used to search the full path to each file considered for +compilation, and if the regex produces a match, the file is skipped.

    +
    + +
    +
    +-i list
    +

    Read the file list and add each line that it contains to the list of +files and directories to compile. If list is -, read lines from +stdin.

    +
    + +
    +
    +-b
    +

    Write the byte-code files to their legacy locations and names, which may +overwrite byte-code files created by another version of Python. The default +is to write files to their PEP 3147 locations and names, which allows +byte-code files from multiple versions of Python to coexist.

    +
    + +
    +
    +-r
    +

    Control the maximum recursion level for subdirectories. +If this is given, then -l option will not be taken into account. +python -m compileall <directory> -r 0 is equivalent to +python -m compileall <directory> -l.

    +
    + +
    +
    +-j N
    +

    Use N workers to compile the files within the given directory. +If 0 is used, then the result of os.cpu_count() +will be used.

    +
    + +
    +
    +--invalidation-mode [timestamp|checked-hash|unchecked-hash]
    +

    Control how the generated byte-code files are invalidated at runtime. +The timestamp value, means that .pyc files with the source timestamp +and size embedded will be generated. The checked-hash and +unchecked-hash values cause hash-based pycs to be generated. Hash-based +pycs embed a hash of the source file contents rather than a timestamp. See +Cached bytecode invalidation for more information on how Python validates +bytecode cache files at runtime. +The default is timestamp if the SOURCE_DATE_EPOCH environment +variable is not set, and checked-hash if the SOURCE_DATE_EPOCH +environment variable is set.

    +
    + +
    +

    Changed in version 3.2: Added the -i, -b and -h options.

    +
    +
    +

    Changed in version 3.5: Added the -j, -r, and -qq options. -q option +was changed to a multilevel value. -b will always produce a +byte-code file ending in .pyc, never .pyo.

    +
    +
    +

    Changed in version 3.7: Added the --invalidation-mode option.

    +
    +

    There is no command-line option to control the optimization level used by the +compile() function, because the Python interpreter itself already +provides the option: python -O -m compileall.

    +
    +
    +

    Public functions

    +
    +
    +compileall.compile_dir(dir, maxlevels=10, ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, workers=1, invalidation_mode=py_compile.PycInvalidationMode.TIMESTAMP)
    +

    Recursively descend the directory tree named by dir, compiling all .py +files along the way. Return a true value if all the files compiled successfully, +and a false value otherwise.

    +

    The maxlevels parameter is used to limit the depth of the recursion; it +defaults to 10.

    +

    If ddir is given, it is prepended to the path to each file being compiled +for use in compilation time tracebacks, and is also compiled in to the +byte-code file, where it will be used in tracebacks and other messages in +cases where the source file does not exist at the time the byte-code file is +executed.

    +

    If force is true, modules are re-compiled even if the timestamps are up to +date.

    +

    If rx is given, its search method is called on the complete path to each +file considered for compilation, and if it returns a true value, the file +is skipped.

    +

    If quiet is False or 0 (the default), the filenames and other +information are printed to standard out. Set to 1, only errors are +printed. Set to 2, all output is suppressed.

    +

    If legacy is true, byte-code files are written to their legacy locations +and names, which may overwrite byte-code files created by another version of +Python. The default is to write files to their PEP 3147 locations and +names, which allows byte-code files from multiple versions of Python to +coexist.

    +

    optimize specifies the optimization level for the compiler. It is passed to +the built-in compile() function.

    +

    The argument workers specifies how many workers are used to +compile files in parallel. The default is to not use multiple workers. +If the platform can’t use multiple workers and workers argument is given, +then sequential compilation will be used as a fallback. If workers is +lower than 0, a ValueError will be raised.

    +

    invalidation_mode should be a member of the +py_compile.PycInvalidationMode enum and controls how the generated +pycs are invalidated at runtime.

    +
    +

    Changed in version 3.2: Added the legacy and optimize parameter.

    +
    +
    +

    Changed in version 3.5: Added the workers parameter.

    +
    +
    +

    Changed in version 3.5: quiet parameter was changed to a multilevel value.

    +
    +
    +

    Changed in version 3.5: The legacy parameter only writes out .pyc files, not .pyo files +no matter what the value of optimize is.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    +

    Changed in version 3.7: The invalidation_mode parameter was added.

    +
    +
    + +
    +
    +compileall.compile_file(fullname, ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, invalidation_mode=py_compile.PycInvalidationMode.TIMESTAMP)
    +

    Compile the file with path fullname. Return a true value if the file +compiled successfully, and a false value otherwise.

    +

    If ddir is given, it is prepended to the path to the file being compiled +for use in compilation time tracebacks, and is also compiled in to the +byte-code file, where it will be used in tracebacks and other messages in +cases where the source file does not exist at the time the byte-code file is +executed.

    +

    If rx is given, its search method is passed the full path name to the +file being compiled, and if it returns a true value, the file is not +compiled and True is returned.

    +

    If quiet is False or 0 (the default), the filenames and other +information are printed to standard out. Set to 1, only errors are +printed. Set to 2, all output is suppressed.

    +

    If legacy is true, byte-code files are written to their legacy locations +and names, which may overwrite byte-code files created by another version of +Python. The default is to write files to their PEP 3147 locations and +names, which allows byte-code files from multiple versions of Python to +coexist.

    +

    optimize specifies the optimization level for the compiler. It is passed to +the built-in compile() function.

    +

    invalidation_mode should be a member of the +py_compile.PycInvalidationMode enum and controls how the generated +pycs are invalidated at runtime.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.5: quiet parameter was changed to a multilevel value.

    +
    +
    +

    Changed in version 3.5: The legacy parameter only writes out .pyc files, not .pyo files +no matter what the value of optimize is.

    +
    +
    +

    Changed in version 3.7: The invalidation_mode parameter was added.

    +
    +
    + +
    +
    +compileall.compile_path(skip_curdir=True, maxlevels=0, force=False, quiet=0, legacy=False, optimize=-1, invalidation_mode=py_compile.PycInvalidationMode.TIMESTAMP)
    +

    Byte-compile all the .py files found along sys.path. Return a +true value if all the files compiled successfully, and a false value otherwise.

    +

    If skip_curdir is true (the default), the current directory is not included +in the search. All other parameters are passed to the compile_dir() +function. Note that unlike the other compile functions, maxlevels +defaults to 0.

    +
    +

    Changed in version 3.2: Added the legacy and optimize parameter.

    +
    +
    +

    Changed in version 3.5: quiet parameter was changed to a multilevel value.

    +
    +
    +

    Changed in version 3.5: The legacy parameter only writes out .pyc files, not .pyo files +no matter what the value of optimize is.

    +
    +
    +

    Changed in version 3.7: The invalidation_mode parameter was added.

    +
    +
    + +

    To force a recompile of all the .py files in the Lib/ +subdirectory and all its subdirectories:

    +
    import compileall
    +
    +compileall.compile_dir('Lib/', force=True)
    +
    +# Perform same compilation, excluding files in .svn directories.
    +import re
    +compileall.compile_dir('Lib/', rx=re.compile(r'[/\\][.]svn'), force=True)
    +
    +# pathlib.Path objects can also be used.
    +import pathlib
    +compileall.compile_dir(pathlib.Path('Lib/'), force=True)
    +
    +
    +
    +

    See also

    +
    +
    Module py_compile

    Byte-compile a single source file.

    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/concurrency.html b/python-3.7.4-docs-html/library/concurrency.html new file mode 100644 index 0000000..c9597c4 --- /dev/null +++ b/python-3.7.4-docs-html/library/concurrency.html @@ -0,0 +1,316 @@ + + + + + + + Concurrent Execution — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Concurrent Execution

    +

    The modules described in this chapter provide support for concurrent +execution of code. The appropriate choice of tool will depend on the +task to be executed (CPU bound vs IO bound) and preferred style of +development (event driven cooperative multitasking vs preemptive +multitasking). Here’s an overview:

    +
    + +
    +

    The following are support modules for some of the above services:

    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/concurrent.futures.html b/python-3.7.4-docs-html/library/concurrent.futures.html new file mode 100644 index 0000000..9bbf22d --- /dev/null +++ b/python-3.7.4-docs-html/library/concurrent.futures.html @@ -0,0 +1,712 @@ + + + + + + + concurrent.futures — Launching parallel tasks — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    concurrent.futures — Launching parallel tasks

    +
    +

    New in version 3.2.

    +
    +

    Source code: Lib/concurrent/futures/thread.py +and Lib/concurrent/futures/process.py

    +
    +

    The concurrent.futures module provides a high-level interface for +asynchronously executing callables.

    +

    The asynchronous execution can be performed with threads, using +ThreadPoolExecutor, or separate processes, using +ProcessPoolExecutor. Both implement the same interface, which is +defined by the abstract Executor class.

    +
    +

    Executor Objects

    +
    +
    +class concurrent.futures.Executor
    +

    An abstract class that provides methods to execute calls asynchronously. It +should not be used directly, but through its concrete subclasses.

    +
    +
    +
    +submit(fn, *args, **kwargs)
    +

    Schedules the callable, fn, to be executed as fn(*args **kwargs) +and returns a Future object representing the execution of the +callable.

    +
    with ThreadPoolExecutor(max_workers=1) as executor:
    +    future = executor.submit(pow, 323, 1235)
    +    print(future.result())
    +
    +
    +
    + +
    +
    +map(func, *iterables, timeout=None, chunksize=1)
    +

    Similar to map(func, *iterables) except:

    +
      +
    • the iterables are collected immediately rather than lazily;

    • +
    • func is executed asynchronously and several calls to +func may be made concurrently.

    • +
    +

    The returned iterator raises a concurrent.futures.TimeoutError +if __next__() is called and the result isn’t available +after timeout seconds from the original call to Executor.map(). +timeout can be an int or a float. If timeout is not specified or +None, there is no limit to the wait time.

    +

    If a func call raises an exception, then that exception will be +raised when its value is retrieved from the iterator.

    +

    When using ProcessPoolExecutor, this method chops iterables +into a number of chunks which it submits to the pool as separate +tasks. The (approximate) size of these chunks can be specified by +setting chunksize to a positive integer. For very long iterables, +using a large value for chunksize can significantly improve +performance compared to the default size of 1. With +ThreadPoolExecutor, chunksize has no effect.

    +
    +

    Changed in version 3.5: Added the chunksize argument.

    +
    +
    + +
    +
    +shutdown(wait=True)
    +

    Signal the executor that it should free any resources that it is using +when the currently pending futures are done executing. Calls to +Executor.submit() and Executor.map() made after shutdown will +raise RuntimeError.

    +

    If wait is True then this method will not return until all the +pending futures are done executing and the resources associated with the +executor have been freed. If wait is False then this method will +return immediately and the resources associated with the executor will be +freed when all pending futures are done executing. Regardless of the +value of wait, the entire Python program will not exit until all +pending futures are done executing.

    +

    You can avoid having to call this method explicitly if you use the +with statement, which will shutdown the Executor +(waiting as if Executor.shutdown() were called with wait set to +True):

    +
    import shutil
    +with ThreadPoolExecutor(max_workers=4) as e:
    +    e.submit(shutil.copy, 'src1.txt', 'dest1.txt')
    +    e.submit(shutil.copy, 'src2.txt', 'dest2.txt')
    +    e.submit(shutil.copy, 'src3.txt', 'dest3.txt')
    +    e.submit(shutil.copy, 'src4.txt', 'dest4.txt')
    +
    +
    +
    + +
    +
    + +
    +
    +

    ThreadPoolExecutor

    +

    ThreadPoolExecutor is an Executor subclass that uses a pool of +threads to execute calls asynchronously.

    +

    Deadlocks can occur when the callable associated with a Future waits on +the results of another 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.
    +    return 5
    +
    +def wait_on_a():
    +    time.sleep(5)
    +    print(a.result())  # a will never complete because it is waiting on b.
    +    return 6
    +
    +
    +executor = ThreadPoolExecutor(max_workers=2)
    +a = executor.submit(wait_on_b)
    +b = executor.submit(wait_on_a)
    +
    +
    +

    And:

    +
    def wait_on_future():
    +    f = executor.submit(pow, 5, 2)
    +    # This will never complete because there is only one worker thread and
    +    # it is executing this function.
    +    print(f.result())
    +
    +executor = ThreadPoolExecutor(max_workers=1)
    +executor.submit(wait_on_future)
    +
    +
    +
    +
    +class concurrent.futures.ThreadPoolExecutor(max_workers=None, thread_name_prefix='', initializer=None, initargs=())
    +

    An Executor subclass that uses a pool of at most max_workers +threads to execute calls asynchronously.

    +

    initializer is an optional callable that is called at the start of +each worker thread; initargs is a tuple of arguments passed to the +initializer. Should initializer raise an exception, all currently +pending jobs will raise a BrokenThreadPool, +as well as any attempt to submit more jobs to the pool.

    +
    +

    Changed in version 3.5: If max_workers is None or +not given, it will default to the number of processors on the machine, +multiplied by 5, assuming that ThreadPoolExecutor is often +used to overlap I/O instead of CPU work and the number of workers +should be higher than the number of workers +for ProcessPoolExecutor.

    +
    +
    +

    New in version 3.6: The thread_name_prefix argument was added to allow users to +control the threading.Thread names for worker threads created by +the pool for easier debugging.

    +
    +
    +

    Changed in version 3.7: Added the initializer and initargs arguments.

    +
    +
    + +
    +

    ThreadPoolExecutor Example

    +
    import concurrent.futures
    +import urllib.request
    +
    +URLS = ['http://www.foxnews.com/',
    +        'http://www.cnn.com/',
    +        'http://europe.wsj.com/',
    +        'http://www.bbc.co.uk/',
    +        'http://some-made-up-domain.com/']
    +
    +# Retrieve a single page and report the URL and contents
    +def load_url(url, timeout):
    +    with urllib.request.urlopen(url, timeout=timeout) as conn:
    +        return conn.read()
    +
    +# We can use a with statement to ensure threads are cleaned up promptly
    +with concurrent.futures.ThreadPoolExecutor(max_workers=5) as executor:
    +    # Start the load operations and mark each future with its URL
    +    future_to_url = {executor.submit(load_url, url, 60): url for url in URLS}
    +    for future in concurrent.futures.as_completed(future_to_url):
    +        url = future_to_url[future]
    +        try:
    +            data = future.result()
    +        except Exception as exc:
    +            print('%r generated an exception: %s' % (url, exc))
    +        else:
    +            print('%r page is %d bytes' % (url, len(data)))
    +
    +
    +
    +
    +
    +

    ProcessPoolExecutor

    +

    The ProcessPoolExecutor class is an Executor subclass that +uses a pool of processes to execute calls asynchronously. +ProcessPoolExecutor uses the multiprocessing module, which +allows it to side-step the Global Interpreter Lock but also means that +only picklable objects can be executed and returned.

    +

    The __main__ module must be importable by worker subprocesses. This means +that ProcessPoolExecutor will not work in the interactive interpreter.

    +

    Calling Executor or Future methods from a callable submitted +to a ProcessPoolExecutor will result in deadlock.

    +
    +
    +class concurrent.futures.ProcessPoolExecutor(max_workers=None, mp_context=None, initializer=None, initargs=())
    +

    An Executor subclass that executes calls asynchronously using a pool +of at most max_workers processes. If max_workers is None or not +given, it will default to the number of processors on the machine. +If max_workers is lower or equal to 0, then a ValueError +will be raised. +On Windows, max_workers must be equal or lower than 61. If it is not +then ValueError will be raised. If max_workers is None, then +the default chosen will be at most 61, even if more processors are +available. +mp_context can be a multiprocessing context or None. It will be used to +launch the workers. If mp_context is None or not given, the default +multiprocessing context is used.

    +

    initializer is an optional callable that is called at the start of +each worker process; initargs is a tuple of arguments passed to the +initializer. Should initializer raise an exception, all currently +pending jobs will raise a BrokenProcessPool, +as well any attempt to submit more jobs to the pool.

    +
    +

    Changed in version 3.3: When one of the worker processes terminates abruptly, a +BrokenProcessPool error is now raised. Previously, behaviour +was undefined but operations on the executor or its futures would often +freeze or deadlock.

    +
    +
    +

    Changed in version 3.7: The mp_context argument was added to allow users to control the +start_method for worker processes created by the pool.

    +

    Added the initializer and initargs arguments.

    +
    +
    + +
    +

    ProcessPoolExecutor Example

    +
    import concurrent.futures
    +import math
    +
    +PRIMES = [
    +    112272535095293,
    +    112582705942171,
    +    112272535095293,
    +    115280095190773,
    +    115797848077099,
    +    1099726899285419]
    +
    +def is_prime(n):
    +    if n % 2 == 0:
    +        return False
    +
    +    sqrt_n = int(math.floor(math.sqrt(n)))
    +    for i in range(3, sqrt_n + 1, 2):
    +        if n % i == 0:
    +            return False
    +    return True
    +
    +def main():
    +    with concurrent.futures.ProcessPoolExecutor() as executor:
    +        for number, prime in zip(PRIMES, executor.map(is_prime, PRIMES)):
    +            print('%d is prime: %s' % (number, prime))
    +
    +if __name__ == '__main__':
    +    main()
    +
    +
    +
    +
    +
    +

    Future Objects

    +

    The Future class encapsulates the asynchronous execution of a callable. +Future instances are created by Executor.submit().

    +
    +
    +class concurrent.futures.Future
    +

    Encapsulates the asynchronous execution of a callable. Future +instances are created by Executor.submit() and should not be created +directly except for testing.

    +
    +
    +
    +cancel()
    +

    Attempt to cancel the call. If the call is currently being executed or +finished running and cannot be cancelled then the method will return +False, otherwise the call will be cancelled and the method will +return True.

    +
    + +
    +
    +cancelled()
    +

    Return True if the call was successfully cancelled.

    +
    + +
    +
    +running()
    +

    Return True if the call is currently being executed and cannot be +cancelled.

    +
    + +
    +
    +done()
    +

    Return True if the call was successfully cancelled or finished +running.

    +
    + +
    +
    +result(timeout=None)
    +

    Return the value returned by the call. If the call hasn’t yet completed +then this method will wait up to timeout seconds. If the call hasn’t +completed in timeout seconds, then a +concurrent.futures.TimeoutError will be raised. timeout can be +an int or float. If timeout is not specified or None, there is no +limit to the wait time.

    +

    If the future is cancelled before completing then CancelledError +will be raised.

    +

    If the call raised, this method will raise the same exception.

    +
    + +
    +
    +exception(timeout=None)
    +

    Return the exception raised by the call. If the call hasn’t yet +completed then this method will wait up to timeout seconds. If the +call hasn’t completed in timeout seconds, then a +concurrent.futures.TimeoutError will be raised. timeout can be +an int or float. If timeout is not specified or None, there is no +limit to the wait time.

    +

    If the future is cancelled before completing then CancelledError +will be raised.

    +

    If the call completed without raising, None is returned.

    +
    + +
    +
    +add_done_callback(fn)
    +

    Attaches the callable fn to the future. fn will be called, with the +future as its only argument, when the future is cancelled or finishes +running.

    +

    Added callables are called in the order that they were added and are +always called in a thread belonging to the process that added them. If +the callable raises an Exception subclass, it will be logged and +ignored. If the callable raises a BaseException subclass, the +behavior is undefined.

    +

    If the future has already completed or been cancelled, fn will be +called immediately.

    +
    + +
    +

    The following Future methods are meant for use in unit tests and +Executor implementations.

    +
    +
    +
    +set_running_or_notify_cancel()
    +

    This method should only be called by Executor implementations +before executing the work associated with the Future and by unit +tests.

    +

    If the method returns False then the Future was cancelled, +i.e. Future.cancel() was called and returned True. Any threads +waiting on the Future completing (i.e. through +as_completed() or wait()) will be woken up.

    +

    If the method returns True then the Future was not cancelled +and has been put in the running state, i.e. calls to +Future.running() will return True.

    +

    This method can only be called once and cannot be called after +Future.set_result() or Future.set_exception() have been +called.

    +
    + +
    +
    +set_result(result)
    +

    Sets the result of the work associated with the Future to +result.

    +

    This method should only be used by Executor implementations and +unit tests.

    +
    + +
    +
    +set_exception(exception)
    +

    Sets the result of the work associated with the Future to the +Exception exception.

    +

    This method should only be used by Executor implementations and +unit tests.

    +
    + +
    +
    + +
    +
    +

    Module Functions

    +
    +
    +concurrent.futures.wait(fs, timeout=None, return_when=ALL_COMPLETED)
    +

    Wait for the Future instances (possibly created by different +Executor instances) given by fs to complete. Returns a named +2-tuple of sets. The first set, named done, contains the futures that +completed (finished or cancelled futures) before the wait completed. The +second set, named not_done, contains the futures that did not complete +(pending or running futures).

    +

    timeout can be used to control the maximum number of seconds to wait before +returning. timeout can be an int or float. If timeout is not specified +or None, there is no limit to the wait time.

    +

    return_when indicates when this function should return. It must be one of +the following constants:

    + ++++ + + + + + + + + + + + + + + + + +

    Constant

    Description

    FIRST_COMPLETED

    The function will return when any +future finishes or is cancelled.

    FIRST_EXCEPTION

    The function will return when any +future finishes by raising an +exception. If no future raises an +exception then it is equivalent to +ALL_COMPLETED.

    ALL_COMPLETED

    The function will return when all +futures finish or are cancelled.

    +
    + +
    +
    +concurrent.futures.as_completed(fs, timeout=None)
    +

    Returns an iterator over the Future instances (possibly created by +different Executor instances) given by fs that yields futures as +they complete (finished or cancelled futures). Any futures given by fs that +are duplicated will be returned once. Any futures that completed before +as_completed() is called will be yielded first. The returned iterator +raises a concurrent.futures.TimeoutError if __next__() +is called and the result isn’t available after timeout seconds from the +original call to as_completed(). timeout can be an int or float. If +timeout is not specified or None, there is no limit to the wait time.

    +
    + +
    +

    See also

    +
    +
    PEP 3148 – futures - execute computations asynchronously

    The proposal which described this feature for inclusion in the Python +standard library.

    +
    +
    +
    +
    +
    +

    Exception classes

    +
    +
    +exception concurrent.futures.CancelledError
    +

    Raised when a future is cancelled.

    +
    + +
    +
    +exception concurrent.futures.TimeoutError
    +

    Raised when a future operation exceeds the given timeout.

    +
    + +
    +
    +exception concurrent.futures.BrokenExecutor
    +

    Derived from RuntimeError, this exception class is raised +when an executor is broken for some reason, and cannot be used +to submit or execute new tasks.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +exception concurrent.futures.thread.BrokenThreadPool
    +

    Derived from BrokenExecutor, this exception +class is raised when one of the workers of a ThreadPoolExecutor +has failed initializing.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +exception concurrent.futures.process.BrokenProcessPool
    +

    Derived from BrokenExecutor (formerly +RuntimeError), this exception class is raised when one of the +workers of a ProcessPoolExecutor has terminated in a non-clean +fashion (for example, if it was killed from the outside).

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/concurrent.html b/python-3.7.4-docs-html/library/concurrent.html new file mode 100644 index 0000000..aee296c --- /dev/null +++ b/python-3.7.4-docs-html/library/concurrent.html @@ -0,0 +1,187 @@ + + + + + + + The concurrent package — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    The concurrent package

    +

    Currently, there is only one module in this package:

    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/configparser.html b/python-3.7.4-docs-html/library/configparser.html new file mode 100644 index 0000000..5a2c1f0 --- /dev/null +++ b/python-3.7.4-docs-html/library/configparser.html @@ -0,0 +1,1442 @@ + + + + + + + configparser — Configuration file parser — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    configparser — Configuration file parser

    +

    Source code: Lib/configparser.py

    +
    +

    This module provides the ConfigParser class which implements a basic +configuration language which provides a structure similar to what’s found in +Microsoft Windows INI files. You can use this to write Python programs which +can be customized by end users easily.

    +
    +

    Note

    +

    This library does not interpret or write the value-type prefixes used in +the Windows Registry extended version of INI syntax.

    +
    +
    +

    See also

    +
    +
    Module shlex

    Support for creating Unix shell-like mini-languages which can be used as +an alternate format for application configuration files.

    +
    +
    Module json

    The json module implements a subset of JavaScript syntax which can also +be used for this purpose.

    +
    +
    +
    +
    +

    Quick Start

    +

    Let’s take a very basic configuration file that looks like this:

    +
    [DEFAULT]
    +ServerAliveInterval = 45
    +Compression = yes
    +CompressionLevel = 9
    +ForwardX11 = yes
    +
    +[bitbucket.org]
    +User = hg
    +
    +[topsecret.server.com]
    +Port = 50022
    +ForwardX11 = no
    +
    +
    +

    The structure of INI files is described in the following section. Essentially, the file +consists of sections, each of which contains keys with values. +configparser classes can read and write such files. Let’s start by +creating the above configuration file programmatically.

    +
    >>> import configparser
    +>>> config = configparser.ConfigParser()
    +>>> config['DEFAULT'] = {'ServerAliveInterval': '45',
    +...                      'Compression': 'yes',
    +...                      'CompressionLevel': '9'}
    +>>> config['bitbucket.org'] = {}
    +>>> config['bitbucket.org']['User'] = 'hg'
    +>>> config['topsecret.server.com'] = {}
    +>>> topsecret = config['topsecret.server.com']
    +>>> topsecret['Port'] = '50022'     # mutates the parser
    +>>> topsecret['ForwardX11'] = 'no'  # same here
    +>>> config['DEFAULT']['ForwardX11'] = 'yes'
    +>>> with open('example.ini', 'w') as configfile:
    +...   config.write(configfile)
    +...
    +
    +
    +

    As you can see, we can treat a config parser much like a dictionary. +There are differences, outlined later, but +the behavior is very close to what you would expect from a dictionary.

    +

    Now that we have created and saved a configuration file, let’s read it +back and explore the data it holds.

    +
    >>> config = configparser.ConfigParser()
    +>>> config.sections()
    +[]
    +>>> config.read('example.ini')
    +['example.ini']
    +>>> config.sections()
    +['bitbucket.org', 'topsecret.server.com']
    +>>> 'bitbucket.org' in config
    +True
    +>>> 'bytebong.com' in config
    +False
    +>>> config['bitbucket.org']['User']
    +'hg'
    +>>> config['DEFAULT']['Compression']
    +'yes'
    +>>> topsecret = config['topsecret.server.com']
    +>>> topsecret['ForwardX11']
    +'no'
    +>>> topsecret['Port']
    +'50022'
    +>>> for key in config['bitbucket.org']:  
    +...     print(key)
    +user
    +compressionlevel
    +serveraliveinterval
    +compression
    +forwardx11
    +>>> config['bitbucket.org']['ForwardX11']
    +'yes'
    +
    +
    +

    As we can see above, the API is pretty straightforward. The only bit of magic +involves the DEFAULT section which provides default values for all other +sections 1. Note also that keys in sections are +case-insensitive and stored in lowercase 1.

    +
    +
    +

    Supported Datatypes

    +

    Config parsers do not guess datatypes of values in configuration files, always +storing them internally as strings. This means that if you need other +datatypes, you should convert on your own:

    +
    >>> int(topsecret['Port'])
    +50022
    +>>> float(topsecret['CompressionLevel'])
    +9.0
    +
    +
    +

    Since this task is so common, config parsers provide a range of handy getter +methods to handle integers, floats and booleans. The last one is the most +interesting because simply passing the value to bool() would do no good +since bool('False') is still True. This is why config parsers also +provide getboolean(). This method is case-insensitive and +recognizes Boolean values from 'yes'/'no', 'on'/'off', +'true'/'false' and '1'/'0' 1. For example:

    +
    >>> topsecret.getboolean('ForwardX11')
    +False
    +>>> config['bitbucket.org'].getboolean('ForwardX11')
    +True
    +>>> config.getboolean('bitbucket.org', 'Compression')
    +True
    +
    +
    +

    Apart from getboolean(), config parsers also +provide equivalent getint() and +getfloat() methods. You can register your own +converters and customize the provided ones. 1

    +
    +
    +

    Fallback Values

    +

    As with a dictionary, you can use a section’s get() method to +provide fallback values:

    +
    >>> topsecret.get('Port')
    +'50022'
    +>>> topsecret.get('CompressionLevel')
    +'9'
    +>>> topsecret.get('Cipher')
    +>>> topsecret.get('Cipher', '3des-cbc')
    +'3des-cbc'
    +
    +
    +

    Please note that default values have precedence over fallback values. +For instance, in our example the 'CompressionLevel' key was +specified only in the 'DEFAULT' section. If we try to get it from +the section 'topsecret.server.com', we will always get the default, +even if we specify a fallback:

    +
    >>> topsecret.get('CompressionLevel', '3')
    +'9'
    +
    +
    +

    One more thing to be aware of is that the parser-level get() method +provides a custom, more complex interface, maintained for backwards +compatibility. When using this method, a fallback value can be provided via +the fallback keyword-only argument:

    +
    >>> config.get('bitbucket.org', 'monster',
    +...            fallback='No such things as monsters')
    +'No such things as monsters'
    +
    +
    +

    The same fallback argument can be used with the +getint(), getfloat() and +getboolean() methods, for example:

    +
    >>> 'BatchMode' in topsecret
    +False
    +>>> topsecret.getboolean('BatchMode', fallback=True)
    +True
    +>>> config['DEFAULT']['BatchMode'] = 'no'
    +>>> topsecret.getboolean('BatchMode', fallback=True)
    +False
    +
    +
    +
    +
    +

    Supported INI File Structure

    +

    A configuration file consists of sections, each led by a [section] header, +followed by key/value entries separated by a specific string (= or : by +default 1). By default, section names are case sensitive but keys are not +1. Leading and trailing whitespace is removed from keys and values. +Values can be omitted, in which case the key/value delimiter may also be left +out. Values can also span multiple lines, as long as they are indented deeper +than the first line of the value. Depending on the parser’s mode, blank lines +may be treated as parts of multiline values or ignored.

    +

    Configuration files may include comments, prefixed by specific +characters (# and ; by default 1). Comments may appear on +their own on an otherwise empty line, possibly indented. 1

    +

    For example:

    +
    [Simple Values]
    +key=value
    +spaces in keys=allowed
    +spaces in values=allowed as well
    +spaces around the delimiter = obviously
    +you can also use : to delimit keys from values
    +
    +[All Values Are Strings]
    +values like this: 1000000
    +or this: 3.14159265359
    +are they treated as numbers? : no
    +integers, floats and booleans are held as: strings
    +can use the API to get converted values directly: true
    +
    +[Multiline Values]
    +chorus: I'm a lumberjack, and I'm okay
    +    I sleep all night and I work all day
    +
    +[No Values]
    +key_without_value
    +empty string value here =
    +
    +[You can use comments]
    +# like this
    +; or this
    +
    +# By default only in an empty line.
    +# Inline comments can be harmful because they prevent users
    +# from using the delimiting characters as parts of values.
    +# That being said, this can be customized.
    +
    +    [Sections Can Be Indented]
    +        can_values_be_as_well = True
    +        does_that_mean_anything_special = False
    +        purpose = formatting for readability
    +        multiline_values = are
    +            handled just fine as
    +            long as they are indented
    +            deeper than the first line
    +            of a value
    +        # Did I mention we can indent comments, too?
    +
    +
    +
    +
    +

    Interpolation of values

    +

    On top of the core functionality, ConfigParser supports +interpolation. This means values can be preprocessed before returning them +from get() calls.

    +
    +
    +class configparser.BasicInterpolation
    +

    The default implementation used by ConfigParser. It enables +values to contain format strings which refer to other values in the same +section, or values in the special default section 1. Additional default +values can be provided on initialization.

    +

    For example:

    +
    [Paths]
    +home_dir: /Users
    +my_dir: %(home_dir)s/lumberjack
    +my_pictures: %(my_dir)s/Pictures
    +
    +
    +

    In the example above, ConfigParser with interpolation set to +BasicInterpolation() would resolve %(home_dir)s to the value of +home_dir (/Users in this case). %(my_dir)s in effect would +resolve to /Users/lumberjack. All interpolations are done on demand so +keys used in the chain of references do not have to be specified in any +specific order in the configuration file.

    +

    With interpolation set to None, the parser would simply return +%(my_dir)s/Pictures as the value of my_pictures and +%(home_dir)s/lumberjack as the value of my_dir.

    +
    + +
    +
    +class configparser.ExtendedInterpolation
    +

    An alternative handler for interpolation which implements a more advanced +syntax, used for instance in zc.buildout. Extended interpolation is +using ${section:option} to denote a value from a foreign section. +Interpolation can span multiple levels. For convenience, if the +section: part is omitted, interpolation defaults to the current section +(and possibly the default values from the special section).

    +

    For example, the configuration specified above with basic interpolation, +would look like this with extended interpolation:

    +
    [Paths]
    +home_dir: /Users
    +my_dir: ${home_dir}/lumberjack
    +my_pictures: ${my_dir}/Pictures
    +
    +
    +

    Values from other sections can be fetched as well:

    +
    [Common]
    +home_dir: /Users
    +library_dir: /Library
    +system_dir: /System
    +macports_dir: /opt/local
    +
    +[Frameworks]
    +Python: 3.2
    +path: ${Common:system_dir}/Library/Frameworks/
    +
    +[Arthur]
    +nickname: Two Sheds
    +last_name: Jackson
    +my_dir: ${Common:home_dir}/twosheds
    +my_pictures: ${my_dir}/Pictures
    +python_dir: ${Frameworks:path}/Python/Versions/${Frameworks:Python}
    +
    +
    +
    + +
    +
    +

    Mapping Protocol Access

    +
    +

    New in version 3.2.

    +
    +

    Mapping protocol access is a generic name for functionality that enables using +custom objects as if they were dictionaries. In case of configparser, +the mapping interface implementation is using the +parser['section']['option'] notation.

    +

    parser['section'] in particular returns a proxy for the section’s data in +the parser. This means that the values are not copied but they are taken from +the original parser on demand. What’s even more important is that when values +are changed on a section proxy, they are actually mutated in the original +parser.

    +

    configparser objects behave as close to actual dictionaries as possible. +The mapping interface is complete and adheres to the +MutableMapping ABC. +However, there are a few differences that should be taken into account:

    +
      +
    • By default, all keys in sections are accessible in a case-insensitive manner +1. E.g. for option in parser["section"] yields only optionxform’ed +option key names. This means lowercased keys by default. At the same time, +for a section that holds the key 'a', both expressions return True:

      +
      "a" in parser["section"]
      +"A" in parser["section"]
      +
      +
      +
    • +
    • All sections include DEFAULTSECT values as well which means that +.clear() on a section may not leave the section visibly empty. This is +because default values cannot be deleted from the section (because technically +they are not there). If they are overridden in the section, deleting causes +the default value to be visible again. Trying to delete a default value +causes a KeyError.

    • +
    • DEFAULTSECT cannot be removed from the parser:

      +
        +
      • trying to delete it raises ValueError,

      • +
      • parser.clear() leaves it intact,

      • +
      • parser.popitem() never returns it.

      • +
      +
    • +
    • parser.get(section, option, **kwargs) - the second argument is not +a fallback value. Note however that the section-level get() methods are +compatible both with the mapping protocol and the classic configparser API.

    • +
    • parser.items() is compatible with the mapping protocol (returns a list of +section_name, section_proxy pairs including the DEFAULTSECT). However, +this method can also be invoked with arguments: parser.items(section, raw, +vars). The latter call returns a list of option, value pairs for +a specified section, with all interpolations expanded (unless +raw=True is provided).

    • +
    +

    The mapping protocol is implemented on top of the existing legacy API so that +subclasses overriding the original interface still should have mappings working +as expected.

    +
    +
    +

    Customizing Parser Behaviour

    +

    There are nearly as many INI format variants as there are applications using it. +configparser goes a long way to provide support for the largest sensible +set of INI styles available. The default functionality is mainly dictated by +historical background and it’s very likely that you will want to customize some +of the features.

    +

    The most common way to change the way a specific config parser works is to use +the __init__() options:

    +
      +
    • defaults, default value: None

      +

      This option accepts a dictionary of key-value pairs which will be initially +put in the DEFAULT section. This makes for an elegant way to support +concise configuration files that don’t specify values which are the same as +the documented default.

      +

      Hint: if you want to specify default values for a specific section, use +read_dict() before you read the actual file.

      +
    • +
    • dict_type, default value: collections.OrderedDict

      +

      This option has a major impact on how the mapping protocol will behave and how +the written configuration files look. With the default ordered +dictionary, every section is stored in the order they were added to the +parser. Same goes for options within sections.

      +

      An alternative dictionary type can be used for example to sort sections and +options on write-back. You can also use a regular dictionary for performance +reasons.

      +

      Please note: there are ways to add a set of key-value pairs in a single +operation. When you use a regular dictionary in those operations, the order +of the keys will be ordered because dict preserves order from Python 3.7. +For example:

      +
      >>> parser = configparser.ConfigParser()
      +>>> parser.read_dict({'section1': {'key1': 'value1',
      +...                                'key2': 'value2',
      +...                                'key3': 'value3'},
      +...                   'section2': {'keyA': 'valueA',
      +...                                'keyB': 'valueB',
      +...                                'keyC': 'valueC'},
      +...                   'section3': {'foo': 'x',
      +...                                'bar': 'y',
      +...                                'baz': 'z'}
      +... })
      +>>> parser.sections()
      +['section1', 'section2', 'section3']
      +>>> [option for option in parser['section3']]
      +['foo', 'bar', 'baz']
      +
      +
      +
    • +
    • allow_no_value, default value: False

      +

      Some configuration files are known to include settings without values, but +which otherwise conform to the syntax supported by configparser. The +allow_no_value parameter to the constructor can be used to +indicate that such values should be accepted:

      +
      >>> import configparser
      +
      +>>> sample_config = """
      +... [mysqld]
      +...   user = mysql
      +...   pid-file = /var/run/mysqld/mysqld.pid
      +...   skip-external-locking
      +...   old_passwords = 1
      +...   skip-bdb
      +...   # we don't need ACID today
      +...   skip-innodb
      +... """
      +>>> config = configparser.ConfigParser(allow_no_value=True)
      +>>> config.read_string(sample_config)
      +
      +>>> # Settings with values are treated as before:
      +>>> config["mysqld"]["user"]
      +'mysql'
      +
      +>>> # Settings without values provide None:
      +>>> config["mysqld"]["skip-bdb"]
      +
      +>>> # Settings which aren't specified still raise an error:
      +>>> config["mysqld"]["does-not-exist"]
      +Traceback (most recent call last):
      +  ...
      +KeyError: 'does-not-exist'
      +
      +
      +
    • +
    • delimiters, default value: ('=', ':')

      +

      Delimiters are substrings that delimit keys from values within a section. +The first occurrence of a delimiting substring on a line is considered +a delimiter. This means values (but not keys) can contain the delimiters.

      +

      See also the space_around_delimiters argument to +ConfigParser.write().

      +
    • +
    • comment_prefixes, default value: ('#', ';')

    • +
    • inline_comment_prefixes, default value: None

      +

      Comment prefixes are strings that indicate the start of a valid comment within +a config file. comment_prefixes are used only on otherwise empty lines +(optionally indented) whereas inline_comment_prefixes can be used after +every valid value (e.g. section names, options and empty lines as well). By +default inline comments are disabled and '#' and ';' are used as +prefixes for whole line comments.

      +
      +

      Changed in version 3.2: In previous versions of configparser behaviour matched +comment_prefixes=('#',';') and inline_comment_prefixes=(';',).

      +
      +

      Please note that config parsers don’t support escaping of comment prefixes so +using inline_comment_prefixes may prevent users from specifying option +values with characters used as comment prefixes. When in doubt, avoid +setting inline_comment_prefixes. In any circumstances, the only way of +storing comment prefix characters at the beginning of a line in multiline +values is to interpolate the prefix, for example:

      +
      >>> from configparser import ConfigParser, ExtendedInterpolation
      +>>> parser = ConfigParser(interpolation=ExtendedInterpolation())
      +>>> # the default BasicInterpolation could be used as well
      +>>> parser.read_string("""
      +... [DEFAULT]
      +... hash = #
      +...
      +... [hashes]
      +... shebang =
      +...   ${hash}!/usr/bin/env python
      +...   ${hash} -*- coding: utf-8 -*-
      +...
      +... extensions =
      +...   enabled_extension
      +...   another_extension
      +...   #disabled_by_comment
      +...   yet_another_extension
      +...
      +... interpolation not necessary = if # is not at line start
      +... even in multiline values = line #1
      +...   line #2
      +...   line #3
      +... """)
      +>>> print(parser['hashes']['shebang'])
      +
      +#!/usr/bin/env python
      +# -*- coding: utf-8 -*-
      +>>> print(parser['hashes']['extensions'])
      +
      +enabled_extension
      +another_extension
      +yet_another_extension
      +>>> print(parser['hashes']['interpolation not necessary'])
      +if # is not at line start
      +>>> print(parser['hashes']['even in multiline values'])
      +line #1
      +line #2
      +line #3
      +
      +
      +
    • +
    • strict, default value: True

      +

      When set to True, the parser will not allow for any section or option +duplicates while reading from a single source (using read_file(), +read_string() or read_dict()). It is recommended to use strict +parsers in new applications.

      +
      +

      Changed in version 3.2: In previous versions of configparser behaviour matched +strict=False.

      +
      +
    • +
    • empty_lines_in_values, default value: True

      +

      In config parsers, values can span multiple lines as long as they are +indented more than the key that holds them. By default parsers also let +empty lines to be parts of values. At the same time, keys can be arbitrarily +indented themselves to improve readability. In consequence, when +configuration files get big and complex, it is easy for the user to lose +track of the file structure. Take for instance:

      +
      [Section]
      +key = multiline
      +  value with a gotcha
      +
      + this = is still a part of the multiline value of 'key'
      +
      +
      +

      This can be especially problematic for the user to see if she’s using a +proportional font to edit the file. That is why when your application does +not need values with empty lines, you should consider disallowing them. This +will make empty lines split keys every time. In the example above, it would +produce two keys, key and this.

      +
    • +
    • default_section, default value: configparser.DEFAULTSECT (that is: +"DEFAULT")

      +

      The convention of allowing a special section of default values for other +sections or interpolation purposes is a powerful concept of this library, +letting users create complex declarative configurations. This section is +normally called "DEFAULT" but this can be customized to point to any +other valid section name. Some typical values include: "general" or +"common". The name provided is used for recognizing default sections +when reading from any source and is used when writing configuration back to +a file. Its current value can be retrieved using the +parser_instance.default_section attribute and may be modified at runtime +(i.e. to convert files from one format to another).

      +
    • +
    • interpolation, default value: configparser.BasicInterpolation

      +

      Interpolation behaviour may be customized by providing a custom handler +through the interpolation argument. None can be used to turn off +interpolation completely, ExtendedInterpolation() provides a more +advanced variant inspired by zc.buildout. More on the subject in the +dedicated documentation section. +RawConfigParser has a default value of None.

      +
    • +
    • converters, default value: not set

      +

      Config parsers provide option value getters that perform type conversion. By +default getint(), getfloat(), and +getboolean() are implemented. Should other getters be +desirable, users may define them in a subclass or pass a dictionary where each +key is a name of the converter and each value is a callable implementing said +conversion. For instance, passing {'decimal': decimal.Decimal} would add +getdecimal() on both the parser object and all section proxies. In +other words, it will be possible to write both +parser_instance.getdecimal('section', 'key', fallback=0) and +parser_instance['section'].getdecimal('key', 0).

      +

      If the converter needs to access the state of the parser, it can be +implemented as a method on a config parser subclass. If the name of this +method starts with get, it will be available on all section proxies, in +the dict-compatible form (see the getdecimal() example above).

      +
    • +
    +

    More advanced customization may be achieved by overriding default values of +these parser attributes. The defaults are defined on the classes, so they may +be overridden by subclasses or by attribute assignment.

    +
    +
    +ConfigParser.BOOLEAN_STATES
    +

    By default when using getboolean(), config parsers +consider the following values True: '1', 'yes', 'true', +'on' and the following values False: '0', 'no', 'false', +'off'. You can override this by specifying a custom dictionary of strings +and their Boolean outcomes. For example:

    +
    >>> custom = configparser.ConfigParser()
    +>>> custom['section1'] = {'funky': 'nope'}
    +>>> custom['section1'].getboolean('funky')
    +Traceback (most recent call last):
    +...
    +ValueError: Not a boolean: nope
    +>>> custom.BOOLEAN_STATES = {'sure': True, 'nope': False}
    +>>> custom['section1'].getboolean('funky')
    +False
    +
    +
    +

    Other typical Boolean pairs include accept/reject or +enabled/disabled.

    +
    + +
    +
    +ConfigParser.optionxform(option)
    +

    This method transforms option names on every read, get, or set +operation. The default converts the name to lowercase. This also +means that when a configuration file gets written, all keys will be +lowercase. Override this method if that’s unsuitable. +For example:

    +
    >>> config = """
    +... [Section1]
    +... Key = Value
    +...
    +... [Section2]
    +... AnotherKey = Value
    +... """
    +>>> typical = configparser.ConfigParser()
    +>>> typical.read_string(config)
    +>>> list(typical['Section1'].keys())
    +['key']
    +>>> list(typical['Section2'].keys())
    +['anotherkey']
    +>>> custom = configparser.RawConfigParser()
    +>>> custom.optionxform = lambda option: option
    +>>> custom.read_string(config)
    +>>> list(custom['Section1'].keys())
    +['Key']
    +>>> list(custom['Section2'].keys())
    +['AnotherKey']
    +
    +
    +
    +

    Note

    +

    The optionxform function transforms option names to a canonical form. +This should be an idempotent function: if the name is already in +canonical form, it should be returned unchanged.

    +
    +
    + +
    +
    +ConfigParser.SECTCRE
    +

    A compiled regular expression used to parse section headers. The default +matches [section] to the name "section". Whitespace is considered +part of the section name, thus [  larch  ] will be read as a section of +name "  larch  ". Override this attribute if that’s unsuitable. For +example:

    +
    >>> import re
    +>>> config = """
    +... [Section 1]
    +... option = value
    +...
    +... [  Section 2  ]
    +... another = val
    +... """
    +>>> typical = configparser.ConfigParser()
    +>>> typical.read_string(config)
    +>>> typical.sections()
    +['Section 1', '  Section 2  ']
    +>>> custom = configparser.ConfigParser()
    +>>> custom.SECTCRE = re.compile(r"\[ *(?P<header>[^]]+?) *\]")
    +>>> custom.read_string(config)
    +>>> custom.sections()
    +['Section 1', 'Section 2']
    +
    +
    +
    +

    Note

    +

    While ConfigParser objects also use an OPTCRE attribute for recognizing +option lines, it’s not recommended to override it because that would +interfere with constructor options allow_no_value and delimiters.

    +
    +
    + +
    +
    +

    Legacy API Examples

    +

    Mainly because of backwards compatibility concerns, configparser +provides also a legacy API with explicit get/set methods. While there +are valid use cases for the methods outlined below, mapping protocol access is +preferred for new projects. The legacy API is at times more advanced, +low-level and downright counterintuitive.

    +

    An example of writing to a configuration file:

    +
    import configparser
    +
    +config = configparser.RawConfigParser()
    +
    +# Please note that using RawConfigParser's set functions, you can assign
    +# non-string values to keys internally, but will receive an error when
    +# attempting to write to a file or when you get it in non-raw mode. Setting
    +# values using the mapping protocol or ConfigParser's set() does not allow
    +# such assignments to take place.
    +config.add_section('Section1')
    +config.set('Section1', 'an_int', '15')
    +config.set('Section1', 'a_bool', 'true')
    +config.set('Section1', 'a_float', '3.1415')
    +config.set('Section1', 'baz', 'fun')
    +config.set('Section1', 'bar', 'Python')
    +config.set('Section1', 'foo', '%(bar)s is %(baz)s!')
    +
    +# Writing our configuration file to 'example.cfg'
    +with open('example.cfg', 'w') as configfile:
    +    config.write(configfile)
    +
    +
    +

    An example of reading the configuration file again:

    +
    import configparser
    +
    +config = configparser.RawConfigParser()
    +config.read('example.cfg')
    +
    +# getfloat() raises an exception if the value is not a float
    +# getint() and getboolean() also do this for their respective types
    +a_float = config.getfloat('Section1', 'a_float')
    +an_int = config.getint('Section1', 'an_int')
    +print(a_float + an_int)
    +
    +# Notice that the next output does not interpolate '%(bar)s' or '%(baz)s'.
    +# This is because we are using a RawConfigParser().
    +if config.getboolean('Section1', 'a_bool'):
    +    print(config.get('Section1', 'foo'))
    +
    +
    +

    To get interpolation, use ConfigParser:

    +
    import configparser
    +
    +cfg = configparser.ConfigParser()
    +cfg.read('example.cfg')
    +
    +# 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!"
    +
    +# 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'}))
    +
    +# The optional *fallback* argument can be used to provide a fallback value
    +print(cfg.get('Section1', 'foo'))
    +      # -> "Python is fun!"
    +
    +print(cfg.get('Section1', 'foo', fallback='Monty is not.'))
    +      # -> "Python is fun!"
    +
    +print(cfg.get('Section1', 'monster', fallback='No such things as monsters.'))
    +      # -> "No such things as monsters."
    +
    +# A bare print(cfg.get('Section1', 'monster')) would raise NoOptionError
    +# but we can also use:
    +
    +print(cfg.get('Section1', 'monster', fallback=None))
    +      # -> None
    +
    +
    +

    Default values are available in both types of ConfigParsers. They are used in +interpolation if an option used is not defined elsewhere.

    +
    import configparser
    +
    +# New instance with 'bar' and 'baz' defaulting to 'Life' and 'hard' each
    +config = configparser.ConfigParser({'bar': 'Life', 'baz': 'hard'})
    +config.read('example.cfg')
    +
    +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!"
    +
    +
    +
    +
    +

    ConfigParser Objects

    +
    +
    +class configparser.ConfigParser(defaults=None, dict_type=collections.OrderedDict, allow_no_value=False, delimiters=('=', ':'), comment_prefixes=('#', ';'), inline_comment_prefixes=None, strict=True, empty_lines_in_values=True, default_section=configparser.DEFAULTSECT, interpolation=BasicInterpolation(), converters={})
    +

    The main configuration parser. When defaults is given, it is initialized +into the dictionary of intrinsic defaults. When dict_type is given, it +will be used to create the dictionary objects for the list of sections, for +the options within a section, and for the default values.

    +

    When delimiters is given, it is used as the set of substrings that +divide keys from values. When comment_prefixes is given, it will be used +as the set of substrings that prefix comments in otherwise empty lines. +Comments can be indented. When inline_comment_prefixes is given, it will +be used as the set of substrings that prefix comments in non-empty lines.

    +

    When strict is True (the default), the parser won’t allow for +any section or option duplicates while reading from a single source (file, +string or dictionary), raising DuplicateSectionError or +DuplicateOptionError. When empty_lines_in_values is False +(default: True), each empty line marks the end of an option. Otherwise, +internal empty lines of a multiline option are kept as part of the value. +When allow_no_value is True (default: False), options without +values are accepted; the value held for these is None and they are +serialized without the trailing delimiter.

    +

    When default_section is given, it specifies the name for the special +section holding default values for other sections and interpolation purposes +(normally named "DEFAULT"). This value can be retrieved and changed on +runtime using the default_section instance attribute.

    +

    Interpolation behaviour may be customized by providing a custom handler +through the interpolation argument. None can be used to turn off +interpolation completely, ExtendedInterpolation() provides a more +advanced variant inspired by zc.buildout. More on the subject in the +dedicated documentation section.

    +

    All option names used in interpolation will be passed through the +optionxform() method just like any other option name reference. For +example, using the default implementation of optionxform() (which +converts option names to lower case), the values foo %(bar)s and foo +%(BAR)s are equivalent.

    +

    When converters is given, it should be a dictionary where each key +represents the name of a type converter and each value is a callable +implementing the conversion from string to the desired datatype. Every +converter gets its own corresponding get*() method on the parser +object and section proxies.

    +
    +

    Changed in version 3.1: The default dict_type is collections.OrderedDict.

    +
    +
    +

    Changed in version 3.2: allow_no_value, delimiters, comment_prefixes, strict, +empty_lines_in_values, default_section and interpolation were +added.

    +
    +
    +

    Changed in version 3.5: The converters argument was added.

    +
    +
    +

    Changed in version 3.7: The defaults argument is read with read_dict(), +providing consistent behavior across the parser: non-string +keys and values are implicitly converted to strings.

    +
    +
    +
    +defaults()
    +

    Return a dictionary containing the instance-wide defaults.

    +
    + +
    +
    +sections()
    +

    Return a list of the sections available; the default section is not +included in the list.

    +
    + +
    +
    +add_section(section)
    +

    Add a section named section to the instance. If a section by the given +name already exists, DuplicateSectionError is raised. If the +default section name is passed, ValueError is raised. The name +of the section must be a string; if not, TypeError is raised.

    +
    +

    Changed in version 3.2: Non-string section names raise TypeError.

    +
    +
    + +
    +
    +has_section(section)
    +

    Indicates whether the named section is present in the configuration. +The default section is not acknowledged.

    +
    + +
    +
    +options(section)
    +

    Return a list of options available in the specified section.

    +
    + +
    +
    +has_option(section, option)
    +

    If the given section exists, and contains the given option, return +True; otherwise return False. If the specified +section is None or an empty string, DEFAULT is assumed.

    +
    + +
    +
    +read(filenames, encoding=None)
    +

    Attempt to read and parse an iterable of filenames, returning a list of +filenames which were successfully parsed.

    +

    If filenames is a string, a bytes object or a +path-like object, it is treated as +a single filename. If a file named in filenames cannot be opened, that +file will be ignored. This is designed so that you can specify an +iterable of potential configuration file locations (for example, the +current directory, the user’s home directory, and some system-wide +directory), and all existing configuration files in the iterable will be +read.

    +

    If none of the named files exist, the ConfigParser +instance will contain an empty dataset. An application which requires +initial values to be loaded from a file should load the required file or +files using read_file() before calling read() for any +optional files:

    +
    import configparser, os
    +
    +config = configparser.ConfigParser()
    +config.read_file(open('defaults.cfg'))
    +config.read(['site.cfg', os.path.expanduser('~/.myapp.cfg')],
    +            encoding='cp1250')
    +
    +
    +
    +

    New in version 3.2: The encoding parameter. Previously, all files were read using the +default encoding for open().

    +
    +
    +

    New in version 3.6.1: The filenames parameter accepts a path-like object.

    +
    +
    +

    New in version 3.7: The filenames parameter accepts a bytes object.

    +
    +
    + +
    +
    +read_file(f, source=None)
    +

    Read and parse configuration data from f which must be an iterable +yielding Unicode strings (for example files opened in text mode).

    +

    Optional argument source specifies the name of the file being read. If +not given and f has a name attribute, that is used for +source; the default is '<???>'.

    +
    +

    New in version 3.2: Replaces readfp().

    +
    +
    + +
    +
    +read_string(string, source='<string>')
    +

    Parse configuration data from a string.

    +

    Optional argument source specifies a context-specific name of the +string passed. If not given, '<string>' is used. This should +commonly be a filesystem path or a URL.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +read_dict(dictionary, source='<dict>')
    +

    Load configuration from any object that provides a dict-like items() +method. Keys are section names, values are dictionaries with keys and +values that should be present in the section. If the used dictionary +type preserves order, sections and their keys will be added in order. +Values are automatically converted to strings.

    +

    Optional argument source specifies a context-specific name of the +dictionary passed. If not given, <dict> is used.

    +

    This method can be used to copy state between parsers.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +get(section, option, *, raw=False, vars=None[, fallback])
    +

    Get an option value for the named section. If vars is provided, it +must be a dictionary. The option is looked up in vars (if provided), +section, and in DEFAULTSECT in that order. If the key is not found +and fallback is provided, it is used as a fallback value. None can +be provided as a fallback value.

    +

    All the '%' interpolations are expanded in the return values, unless +the raw argument is true. Values for interpolation keys are looked up +in the same manner as the option.

    +
    +

    Changed in version 3.2: Arguments raw, vars and fallback are keyword only to protect +users from trying to use the third argument as the fallback fallback +(especially when using the mapping protocol).

    +
    +
    + +
    +
    +getint(section, option, *, raw=False, vars=None[, fallback])
    +

    A convenience method which coerces the option in the specified section +to an integer. See get() for explanation of raw, vars and +fallback.

    +
    + +
    +
    +getfloat(section, option, *, raw=False, vars=None[, fallback])
    +

    A convenience method which coerces the option in the specified section +to a floating point number. See get() for explanation of raw, +vars and fallback.

    +
    + +
    +
    +getboolean(section, option, *, raw=False, vars=None[, fallback])
    +

    A convenience method which coerces the option in the specified section +to a Boolean value. Note that the accepted values for the option are +'1', 'yes', 'true', and 'on', which cause this method to +return True, and '0', 'no', 'false', and 'off', which +cause it to return False. These string values are checked in a +case-insensitive manner. Any other value will cause it to raise +ValueError. See get() for explanation of raw, vars and +fallback.

    +
    + +
    +
    +items(raw=False, vars=None)
    +
    +items(section, raw=False, vars=None)
    +

    When section is not given, return a list of section_name, +section_proxy pairs, including DEFAULTSECT.

    +

    Otherwise, return a list of name, value pairs for the options in the +given section. Optional arguments have the same meaning as for the +get() method.

    +
    + +
    +
    +set(section, option, value)
    +

    If the given section exists, set the given option to the specified value; +otherwise raise NoSectionError. option and value must be +strings; if not, TypeError is raised.

    +
    + +
    +
    +write(fileobject, space_around_delimiters=True)
    +

    Write a representation of the configuration to the specified file +object, which must be opened in text mode (accepting strings). This +representation can be parsed by a future read() call. If +space_around_delimiters is true, delimiters between +keys and values are surrounded by spaces.

    +
    + +
    +
    +remove_option(section, option)
    +

    Remove the specified option from the specified section. If the +section does not exist, raise NoSectionError. If the option +existed to be removed, return True; otherwise return +False.

    +
    + +
    +
    +remove_section(section)
    +

    Remove the specified section from the configuration. If the section in +fact existed, return True. Otherwise return False.

    +
    + +
    +
    +optionxform(option)
    +

    Transforms the option name option as found in an input file or as passed +in by client code to the form that should be used in the internal +structures. The default implementation returns a lower-case version of +option; subclasses may override this or client code can set an attribute +of this name on instances to affect this behavior.

    +

    You don’t need to subclass the parser to use this method, you can also +set it on an instance, to a function that takes a string argument and +returns a string. Setting it to str, for example, would make option +names case sensitive:

    +
    cfgparser = ConfigParser()
    +cfgparser.optionxform = str
    +
    +
    +

    Note that when reading configuration files, whitespace around the option +names is stripped before optionxform() is called.

    +
    + +
    +
    +readfp(fp, filename=None)
    +
    +

    Deprecated since version 3.2: Use read_file() instead.

    +
    +
    +

    Changed in version 3.2: readfp() now iterates on fp instead of calling fp.readline().

    +
    +

    For existing code calling readfp() with arguments which don’t +support iteration, the following generator may be used as a wrapper +around the file-like object:

    +
    def readline_generator(fp):
    +    line = fp.readline()
    +    while line:
    +        yield line
    +        line = fp.readline()
    +
    +
    +

    Instead of parser.readfp(fp) use +parser.read_file(readline_generator(fp)).

    +
    + +
    + +
    +
    +configparser.MAX_INTERPOLATION_DEPTH
    +

    The maximum depth for recursive interpolation for get() when the raw +parameter is false. This is relevant only when the default interpolation +is used.

    +
    + +
    +
    +

    RawConfigParser Objects

    +
    +
    +class configparser.RawConfigParser(defaults=None, dict_type=collections.OrderedDict, allow_no_value=False, *, delimiters=('=', ':'), comment_prefixes=('#', ';'), inline_comment_prefixes=None, strict=True, empty_lines_in_values=True, default_section=configparser.DEFAULTSECT[, interpolation])
    +

    Legacy variant of the ConfigParser. It has interpolation +disabled by default and allows for non-string section names, option +names, and values via its unsafe add_section and set methods, +as well as the legacy defaults= keyword argument handling.

    +
    +

    Note

    +

    Consider using ConfigParser instead which checks types of +the values to be stored internally. If you don’t want interpolation, you +can use ConfigParser(interpolation=None).

    +
    +
    +
    +add_section(section)
    +

    Add a section named section to the instance. If a section by the given +name already exists, DuplicateSectionError is raised. If the +default section name is passed, ValueError is raised.

    +

    Type of section is not checked which lets users create non-string named +sections. This behaviour is unsupported and may cause internal errors.

    +
    + +
    +
    +set(section, option, value)
    +

    If the given section exists, set the given option to the specified value; +otherwise raise NoSectionError. While it is possible to use +RawConfigParser (or ConfigParser with raw parameters +set to true) for internal storage of non-string values, full +functionality (including interpolation and output to files) can only be +achieved using string values.

    +

    This method lets users assign non-string values to keys internally. This +behaviour is unsupported and will cause errors when attempting to write +to a file or get it in non-raw mode. Use the mapping protocol API +which does not allow such assignments to take place.

    +
    + +
    + +
    +
    +

    Exceptions

    +
    +
    +exception configparser.Error
    +

    Base class for all other configparser exceptions.

    +
    + +
    +
    +exception configparser.NoSectionError
    +

    Exception raised when a specified section is not found.

    +
    + +
    +
    +exception configparser.DuplicateSectionError
    +

    Exception raised if add_section() is called with the name of a section +that is already present or in strict parsers when a section if found more +than once in a single input file, string or dictionary.

    +
    +

    New in version 3.2: Optional source and lineno attributes and arguments to +__init__() were added.

    +
    +
    + +
    +
    +exception configparser.DuplicateOptionError
    +

    Exception raised by strict parsers if a single option appears twice during +reading from a single file, string or dictionary. This catches misspellings +and case sensitivity-related errors, e.g. a dictionary may have two keys +representing the same case-insensitive configuration key.

    +
    + +
    +
    +exception configparser.NoOptionError
    +

    Exception raised when a specified option is not found in the specified +section.

    +
    + +
    +
    +exception configparser.InterpolationError
    +

    Base class for exceptions raised when problems occur performing string +interpolation.

    +
    + +
    +
    +exception configparser.InterpolationDepthError
    +

    Exception raised when string interpolation cannot be completed because the +number of iterations exceeds MAX_INTERPOLATION_DEPTH. Subclass of +InterpolationError.

    +
    + +
    +
    +exception configparser.InterpolationMissingOptionError
    +

    Exception raised when an option referenced from a value does not exist. +Subclass of InterpolationError.

    +
    + +
    +
    +exception configparser.InterpolationSyntaxError
    +

    Exception raised when the source text into which substitutions are made does +not conform to the required syntax. Subclass of InterpolationError.

    +
    + +
    +
    +exception configparser.MissingSectionHeaderError
    +

    Exception raised when attempting to parse a file which has no section +headers.

    +
    + +
    +
    +exception configparser.ParsingError
    +

    Exception raised when errors occur attempting to parse a file.

    +
    +

    Changed in version 3.2: The filename attribute and __init__() argument were renamed to +source for consistency.

    +
    +
    + +

    Footnotes

    +
    +
    1(1,2,3,4,5,6,7,8,9,10)
    +

    Config parsers allow for heavy customization. If you are interested in +changing the behaviour outlined by the footnote reference, consult the +Customizing Parser Behaviour section.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/constants.html b/python-3.7.4-docs-html/library/constants.html new file mode 100644 index 0000000..6b6cb79 --- /dev/null +++ b/python-3.7.4-docs-html/library/constants.html @@ -0,0 +1,293 @@ + + + + + + + Built-in Constants — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Built-in Constants

    +

    A small number of constants live in the built-in namespace. They are:

    +
    +
    +False
    +

    The false value of the bool type. Assignments to False +are illegal and raise a SyntaxError.

    +
    + +
    +
    +True
    +

    The true value of the bool type. Assignments to True +are illegal and raise a SyntaxError.

    +
    + +
    +
    +None
    +

    The sole value of the type NoneType. None is frequently used to +represent the absence of a value, as when default arguments are not passed to a +function. Assignments to None are illegal and raise a SyntaxError.

    +
    + +
    +
    +NotImplemented
    +

    Special value which should be returned by the binary special methods +(e.g. __eq__(), __lt__(), __add__(), __rsub__(), +etc.) to indicate that the operation is not implemented with respect to +the other type; may be returned by the in-place binary special methods +(e.g. __imul__(), __iand__(), etc.) for the same purpose. +Its truth value is true.

    +
    +

    Note

    +

    When a binary (or in-place) method returns NotImplemented the +interpreter will try the reflected operation on the other type (or some +other fallback, depending on the operator). If all attempts return +NotImplemented, the interpreter will raise an appropriate exception. +Incorrectly returning NotImplemented will result in a misleading +error message or the NotImplemented value being returned to Python code.

    +

    See Implementing the arithmetic operations for examples.

    +
    +
    +

    Note

    +

    NotImplementedError and NotImplemented are not interchangeable, +even though they have similar names and purposes. +See NotImplementedError for details on when to use it.

    +
    +
    + +
    +
    +Ellipsis
    +

    The same as the ellipsis literal “...”. Special value used mostly in conjunction +with extended slicing syntax for user-defined container data types.

    +
    + +
    +
    +__debug__
    +

    This constant is true if Python was not started with an -O option. +See also the assert statement.

    +
    + +
    +

    Note

    +

    The names None, False, True and __debug__ +cannot be reassigned (assignments to them, even as an attribute name, raise +SyntaxError), so they can be considered “true” constants.

    +
    +
    +

    Constants added by the site module

    +

    The site module (which is imported automatically during startup, except +if the -S command-line option is given) adds several constants to the +built-in namespace. They are useful for the interactive interpreter shell and +should not be used in programs.

    +
    +
    +quit(code=None)
    +
    +exit(code=None)
    +

    Objects that when printed, print a message like “Use quit() or Ctrl-D +(i.e. EOF) to exit”, and when called, raise SystemExit with the +specified exit code.

    +
    + +
    + +
    +credits
    +

    Objects that when printed or called, print the text of copyright or +credits, respectively.

    +
    + +
    +
    +license
    +

    Object that when printed, prints the message “Type license() to see the +full license text”, and when called, displays the full license text in a +pager-like fashion (one screen at a time).

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/contextlib.html b/python-3.7.4-docs-html/library/contextlib.html new file mode 100644 index 0000000..15d763b --- /dev/null +++ b/python-3.7.4-docs-html/library/contextlib.html @@ -0,0 +1,1053 @@ + + + + + + + contextlib — Utilities for with-statement contexts — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    contextlib — Utilities for with-statement contexts

    +

    Source code: Lib/contextlib.py

    +
    +

    This module provides utilities for common tasks involving the with +statement. For more information see also Context Manager Types and +With Statement Context Managers.

    +
    +

    Utilities

    +

    Functions and classes provided:

    +
    +
    +class contextlib.AbstractContextManager
    +

    An abstract base class for classes that implement +object.__enter__() and object.__exit__(). A default +implementation for object.__enter__() is provided which returns +self while object.__exit__() is an abstract method which by default +returns None. See also the definition of Context Manager Types.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +class contextlib.AbstractAsyncContextManager
    +

    An abstract base class for classes that implement +object.__aenter__() and object.__aexit__(). A default +implementation for object.__aenter__() is provided which returns +self while object.__aexit__() is an abstract method which by default +returns None. See also the definition of +Asynchronous Context Managers.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +@contextlib.contextmanager
    +

    This function is a decorator that can be used to define a factory +function for with statement context managers, without needing to +create a class or separate __enter__() and __exit__() methods.

    +

    While many objects natively support use in with statements, sometimes a +resource needs to be managed that isn’t a context manager in its own right, +and doesn’t implement a close() method for use with contextlib.closing

    +

    An abstract example would be the following to ensure correct resource +management:

    +
    from contextlib import contextmanager
    +
    +@contextmanager
    +def managed_resource(*args, **kwds):
    +    # Code to acquire resource, e.g.:
    +    resource = acquire_resource(*args, **kwds)
    +    try:
    +        yield resource
    +    finally:
    +        # Code to release resource, e.g.:
    +        release_resource(resource)
    +
    +>>> with managed_resource(timeout=3600) as resource:
    +...     # Resource is released at the end of this block,
    +...     # even if code in the block raises an exception
    +
    +
    +

    The function being decorated must return a generator-iterator when +called. This iterator must yield exactly one value, which will be bound to +the targets in the with statement’s as clause, if any.

    +

    At the point where the generator yields, the block nested in the with +statement is executed. The generator is then resumed after the block is exited. +If an unhandled exception occurs in the block, it is reraised inside the +generator at the point where the yield occurred. Thus, you can use a +tryexceptfinally statement to trap +the error (if any), or ensure that some cleanup takes place. If an exception is +trapped merely in order to log it or to perform some action (rather than to +suppress it entirely), the generator must reraise that exception. Otherwise the +generator context manager will indicate to the with statement that +the exception has been handled, and execution will resume with the statement +immediately following the with statement.

    +

    contextmanager() uses ContextDecorator so the context managers +it creates can be used as decorators as well as in with statements. +When used as a decorator, a new generator instance is implicitly created on +each function call (this allows the otherwise “one-shot” context managers +created by contextmanager() to meet the requirement that context +managers support multiple invocations in order to be used as decorators).

    +
    +

    Changed in version 3.2: Use of ContextDecorator.

    +
    +
    + +
    +
    +@contextlib.asynccontextmanager
    +

    Similar to contextmanager(), but creates an +asynchronous context manager.

    +

    This function is a decorator that can be used to define a factory +function for async with statement asynchronous context managers, +without needing to create a class or separate __aenter__() and +__aexit__() methods. It must be applied to an asynchronous +generator function.

    +

    A simple example:

    +
    from contextlib import asynccontextmanager
    +
    +@asynccontextmanager
    +async def get_connection():
    +    conn = await acquire_db_connection()
    +    try:
    +        yield conn
    +    finally:
    +        await release_db_connection(conn)
    +
    +async def get_all_users():
    +    async with get_connection() as conn:
    +        return conn.query('SELECT ...')
    +
    +
    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +contextlib.closing(thing)
    +

    Return a context manager that closes thing upon completion of the block. This +is basically equivalent to:

    +
    from contextlib import contextmanager
    +
    +@contextmanager
    +def closing(thing):
    +    try:
    +        yield thing
    +    finally:
    +        thing.close()
    +
    +
    +

    And lets you write code like this:

    +
    from contextlib import closing
    +from urllib.request import urlopen
    +
    +with closing(urlopen('http://www.python.org')) as page:
    +    for line in page:
    +        print(line)
    +
    +
    +

    without needing to explicitly close page. Even if an error occurs, +page.close() will be called when the with block is exited.

    +
    + +
    +
    +contextlib.nullcontext(enter_result=None)
    +

    Return a context manager that returns enter_result from __enter__, but +otherwise does nothing. It is intended to be used as a stand-in for an +optional context manager, for example:

    +
    def myfunction(arg, ignore_exceptions=False):
    +    if ignore_exceptions:
    +        # Use suppress to ignore all exceptions.
    +        cm = contextlib.suppress(Exception)
    +    else:
    +        # Do not ignore any exceptions, cm has no effect.
    +        cm = contextlib.nullcontext()
    +    with cm:
    +        # Do something
    +
    +
    +

    An example using enter_result:

    +
    def process_file(file_or_path):
    +    if isinstance(file_or_path, str):
    +        # If string, open file
    +        cm = open(file_or_path)
    +    else:
    +        # Caller is responsible for closing file
    +        cm = nullcontext(file_or_path)
    +
    +    with cm as file:
    +        # Perform processing on the file
    +
    +
    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +contextlib.suppress(*exceptions)
    +

    Return a context manager that suppresses any of the specified exceptions +if they occur in the body of a with statement and then resumes execution +with the first statement following the end of the with statement.

    +

    As with any other mechanism that completely suppresses exceptions, this +context manager should be used only to cover very specific errors where +silently continuing with program execution is known to be the right +thing to do.

    +

    For example:

    +
    from contextlib import suppress
    +
    +with suppress(FileNotFoundError):
    +    os.remove('somefile.tmp')
    +
    +with suppress(FileNotFoundError):
    +    os.remove('someotherfile.tmp')
    +
    +
    +

    This code is equivalent to:

    +
    try:
    +    os.remove('somefile.tmp')
    +except FileNotFoundError:
    +    pass
    +
    +try:
    +    os.remove('someotherfile.tmp')
    +except FileNotFoundError:
    +    pass
    +
    +
    +

    This context manager is reentrant.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +contextlib.redirect_stdout(new_target)
    +

    Context manager for temporarily redirecting sys.stdout to +another file or file-like object.

    +

    This tool adds flexibility to existing functions or classes whose output +is hardwired to stdout.

    +

    For example, the output of help() normally is sent to sys.stdout. +You can capture that output in a string by redirecting the output to an +io.StringIO object:

    +
    f = io.StringIO()
    +with redirect_stdout(f):
    +    help(pow)
    +s = f.getvalue()
    +
    +
    +

    To send the output of help() to a file on disk, redirect the output +to a regular file:

    +
    with open('help.txt', 'w') as f:
    +    with redirect_stdout(f):
    +        help(pow)
    +
    +
    +

    To send the output of help() to sys.stderr:

    +
    with redirect_stdout(sys.stderr):
    +    help(pow)
    +
    +
    +

    Note that the global side effect on sys.stdout means that this +context manager is not suitable for use in library code and most threaded +applications. It also has no effect on the output of subprocesses. +However, it is still a useful approach for many utility scripts.

    +

    This context manager is reentrant.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +contextlib.redirect_stderr(new_target)
    +

    Similar to redirect_stdout() but redirecting +sys.stderr to another file or file-like object.

    +

    This context manager is reentrant.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +class contextlib.ContextDecorator
    +

    A base class that enables a context manager to also be used as a decorator.

    +

    Context managers inheriting from ContextDecorator have to implement +__enter__ and __exit__ as normal. __exit__ retains its optional +exception handling even when used as a decorator.

    +

    ContextDecorator is used by contextmanager(), so you get this +functionality automatically.

    +

    Example of ContextDecorator:

    +
    from contextlib import ContextDecorator
    +
    +class mycontext(ContextDecorator):
    +    def __enter__(self):
    +        print('Starting')
    +        return self
    +
    +    def __exit__(self, *exc):
    +        print('Finishing')
    +        return False
    +
    +>>> @mycontext()
    +... def function():
    +...     print('The bit in the middle')
    +...
    +>>> function()
    +Starting
    +The bit in the middle
    +Finishing
    +
    +>>> with mycontext():
    +...     print('The bit in the middle')
    +...
    +Starting
    +The bit in the middle
    +Finishing
    +
    +
    +

    This change is just syntactic sugar for any construct of the following form:

    +
    def f():
    +    with cm():
    +        # Do stuff
    +
    +
    +

    ContextDecorator lets you instead write:

    +
    @cm()
    +def f():
    +    # Do stuff
    +
    +
    +

    It makes it clear that the cm applies to the whole function, rather than +just a piece of it (and saving an indentation level is nice, too).

    +

    Existing context managers that already have a base class can be extended by +using ContextDecorator as a mixin class:

    +
    from contextlib import ContextDecorator
    +
    +class mycontext(ContextBaseClass, ContextDecorator):
    +    def __enter__(self):
    +        return self
    +
    +    def __exit__(self, *exc):
    +        return False
    +
    +
    +
    +

    Note

    +

    As the decorated function must be able to be called multiple times, the +underlying context manager must support use in multiple with +statements. If this is not the case, then the original construct with the +explicit with statement inside the function should be used.

    +
    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +class contextlib.ExitStack
    +

    A context manager that is designed to make it easy to programmatically +combine other context managers and cleanup functions, especially those +that are optional or otherwise driven by input data.

    +

    For example, a set of files may easily be handled in a single with +statement as follows:

    +
    with ExitStack() as stack:
    +    files = [stack.enter_context(open(fname)) for fname in filenames]
    +    # All opened files will automatically be closed at the end of
    +    # the with statement, even if attempts to open files later
    +    # in the list raise an exception
    +
    +
    +

    Each instance maintains a stack of registered callbacks that are called in +reverse order when the instance is closed (either explicitly or implicitly +at the end of a with statement). Note that callbacks are not +invoked implicitly when the context stack instance is garbage collected.

    +

    This stack model is used so that context managers that acquire their +resources in their __init__ method (such as file objects) can be +handled correctly.

    +

    Since registered callbacks are invoked in the reverse order of +registration, this ends up behaving as if multiple nested with +statements had been used with the registered set of callbacks. This even +extends to exception handling - if an inner callback suppresses or replaces +an exception, then outer callbacks will be passed arguments based on that +updated state.

    +

    This is a relatively low level API that takes care of the details of +correctly unwinding the stack of exit callbacks. It provides a suitable +foundation for higher level context managers that manipulate the exit +stack in application specific ways.

    +
    +

    New in version 3.3.

    +
    +
    +
    +enter_context(cm)
    +

    Enters a new context manager and adds its __exit__() method to +the callback stack. The return value is the result of the context +manager’s own __enter__() method.

    +

    These context managers may suppress exceptions just as they normally +would if used directly as part of a with statement.

    +
    + +
    +
    +push(exit)
    +

    Adds a context manager’s __exit__() method to the callback stack.

    +

    As __enter__ is not invoked, this method can be used to cover +part of an __enter__() implementation with a context manager’s own +__exit__() method.

    +

    If passed an object that is not a context manager, this method assumes +it is a callback with the same signature as a context manager’s +__exit__() method and adds it directly to the callback stack.

    +

    By returning true values, these callbacks can suppress exceptions the +same way context manager __exit__() methods can.

    +

    The passed in object is returned from the function, allowing this +method to be used as a function decorator.

    +
    + +
    +
    +callback(callback, *args, **kwds)
    +

    Accepts an arbitrary callback function and arguments and adds it to +the callback stack.

    +

    Unlike the other methods, callbacks added this way cannot suppress +exceptions (as they are never passed the exception details).

    +

    The passed in callback is returned from the function, allowing this +method to be used as a function decorator.

    +
    + +
    +
    +pop_all()
    +

    Transfers the callback stack to a fresh ExitStack instance +and returns it. No callbacks are invoked by this operation - instead, +they will now be invoked when the new stack is closed (either +explicitly or implicitly at the end of a with statement).

    +

    For example, a group of files can be opened as an “all or nothing” +operation as follows:

    +
    with ExitStack() as stack:
    +    files = [stack.enter_context(open(fname)) for fname in filenames]
    +    # Hold onto the close method, but don't call it yet.
    +    close_files = stack.pop_all().close
    +    # If opening any file fails, all previously opened files will be
    +    # closed automatically. If all files are opened successfully,
    +    # they will remain open even after the with statement ends.
    +    # close_files() can then be invoked explicitly to close them all.
    +
    +
    +
    + +
    +
    +close()
    +

    Immediately unwinds the callback stack, invoking callbacks in the +reverse order of registration. For any context managers and exit +callbacks registered, the arguments passed in will indicate that no +exception occurred.

    +
    + +
    + +
    +
    +class contextlib.AsyncExitStack
    +

    An asynchronous context manager, similar +to ExitStack, that supports combining both synchronous and +asynchronous context managers, as well as having coroutines for +cleanup logic.

    +

    The close() method is not implemented, aclose() must be used +instead.

    +
    +
    +enter_async_context(cm)
    +

    Similar to enter_context() but expects an asynchronous context +manager.

    +
    + +
    +
    +push_async_exit(exit)
    +

    Similar to push() but expects either an asynchronous context manager +or a coroutine function.

    +
    + +
    +
    +push_async_callback(callback, *args, **kwds)
    +

    Similar to callback() but expects a coroutine function.

    +
    + +
    +
    +aclose()
    +

    Similar to close() but properly handles awaitables.

    +
    + +

    Continuing the example for asynccontextmanager():

    +
    async with AsyncExitStack() as stack:
    +    connections = [await stack.enter_async_context(get_connection())
    +        for i in range(5)]
    +    # All opened connections will automatically be released at the end of
    +    # the async with statement, even if attempts to open a connection
    +    # later in the list raise an exception.
    +
    +
    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +

    Examples and Recipes

    +

    This section describes some examples and recipes for making effective use of +the tools provided by contextlib.

    +
    +

    Supporting a variable number of context managers

    +

    The primary use case for ExitStack is the one given in the class +documentation: supporting a variable number of context managers and other +cleanup operations in a single with statement. The variability +may come from the number of context managers needed being driven by user +input (such as opening a user specified collection of files), or from +some of the context managers being optional:

    +
    with ExitStack() as stack:
    +    for resource in resources:
    +        stack.enter_context(resource)
    +    if need_special_resource():
    +        special = acquire_special_resource()
    +        stack.callback(release_special_resource, special)
    +    # Perform operations that use the acquired resources
    +
    +
    +

    As shown, ExitStack also makes it quite easy to use with +statements to manage arbitrary resources that don’t natively support the +context management protocol.

    +
    +
    +

    Catching exceptions from __enter__ methods

    +

    It is occasionally desirable to catch exceptions from an __enter__ +method implementation, without inadvertently catching exceptions from +the with statement body or the context manager’s __exit__ +method. By using ExitStack the steps in the context management +protocol can be separated slightly in order to allow this:

    +
    stack = ExitStack()
    +try:
    +    x = stack.enter_context(cm)
    +except Exception:
    +    # handle __enter__ exception
    +else:
    +    with stack:
    +        # Handle normal case
    +
    +
    +

    Actually needing to do this is likely to indicate that the underlying API +should be providing a direct resource management interface for use with +try/except/finally statements, but not +all APIs are well designed in that regard. When a context manager is the +only resource management API provided, then ExitStack can make it +easier to handle various situations that can’t be handled directly in a +with statement.

    +
    +
    +

    Cleaning up in an __enter__ implementation

    +

    As noted in the documentation of ExitStack.push(), this +method can be useful in cleaning up an already allocated resource if later +steps in the __enter__() implementation fail.

    +

    Here’s an example of doing this for a context manager that accepts resource +acquisition and release functions, along with an optional validation function, +and maps them to the context management protocol:

    +
    from contextlib import contextmanager, AbstractContextManager, ExitStack
    +
    +class ResourceManager(AbstractContextManager):
    +
    +    def __init__(self, acquire_resource, release_resource, check_resource_ok=None):
    +        self.acquire_resource = acquire_resource
    +        self.release_resource = release_resource
    +        if check_resource_ok is None:
    +            def check_resource_ok(resource):
    +                return True
    +        self.check_resource_ok = check_resource_ok
    +
    +    @contextmanager
    +    def _cleanup_on_error(self):
    +        with ExitStack() as stack:
    +            stack.push(self)
    +            yield
    +            # The validation check passed and didn't raise an exception
    +            # Accordingly, we want to keep the resource, and pass it
    +            # back to our caller
    +            stack.pop_all()
    +
    +    def __enter__(self):
    +        resource = self.acquire_resource()
    +        with self._cleanup_on_error():
    +            if not self.check_resource_ok(resource):
    +                msg = "Failed validation for {!r}"
    +                raise RuntimeError(msg.format(resource))
    +        return resource
    +
    +    def __exit__(self, *exc_details):
    +        # We don't need to duplicate any of our resource release logic
    +        self.release_resource()
    +
    +
    +
    +
    +

    Replacing any use of try-finally and flag variables

    +

    A pattern you will sometimes see is a try-finally statement with a flag +variable to indicate whether or not the body of the finally clause should +be executed. In its simplest form (that can’t already be handled just by +using an except clause instead), it looks something like this:

    +
    cleanup_needed = True
    +try:
    +    result = perform_operation()
    +    if result:
    +        cleanup_needed = False
    +finally:
    +    if cleanup_needed:
    +        cleanup_resources()
    +
    +
    +

    As with any try statement based code, this can cause problems for +development and review, because the setup code and the cleanup code can end +up being separated by arbitrarily long sections of code.

    +

    ExitStack makes it possible to instead register a callback for +execution at the end of a with statement, and then later decide to skip +executing that callback:

    +
    from contextlib import ExitStack
    +
    +with ExitStack() as stack:
    +    stack.callback(cleanup_resources)
    +    result = perform_operation()
    +    if result:
    +        stack.pop_all()
    +
    +
    +

    This allows the intended cleanup up behaviour to be made explicit up front, +rather than requiring a separate flag variable.

    +

    If a particular application uses this pattern a lot, it can be simplified +even further by means of a small helper class:

    +
    from contextlib import ExitStack
    +
    +class Callback(ExitStack):
    +    def __init__(self, callback, *args, **kwds):
    +        super(Callback, self).__init__()
    +        self.callback(callback, *args, **kwds)
    +
    +    def cancel(self):
    +        self.pop_all()
    +
    +with Callback(cleanup_resources) as cb:
    +    result = perform_operation()
    +    if result:
    +        cb.cancel()
    +
    +
    +

    If the resource cleanup isn’t already neatly bundled into a standalone +function, then it is still possible to use the decorator form of +ExitStack.callback() to declare the resource cleanup in +advance:

    +
    from contextlib import ExitStack
    +
    +with ExitStack() as stack:
    +    @stack.callback
    +    def cleanup_resources():
    +        ...
    +    result = perform_operation()
    +    if result:
    +        stack.pop_all()
    +
    +
    +

    Due to the way the decorator protocol works, a callback function +declared this way cannot take any parameters. Instead, any resources to +be released must be accessed as closure variables.

    +
    +
    +

    Using a context manager as a function decorator

    +

    ContextDecorator makes it possible to use a context manager in +both an ordinary with statement and also as a function decorator.

    +

    For example, it is sometimes useful to wrap functions or groups of statements +with a logger that can track the time of entry and time of exit. Rather than +writing both a function decorator and a context manager for the task, +inheriting from ContextDecorator provides both capabilities in a +single definition:

    +
    from contextlib import ContextDecorator
    +import logging
    +
    +logging.basicConfig(level=logging.INFO)
    +
    +class track_entry_and_exit(ContextDecorator):
    +    def __init__(self, name):
    +        self.name = name
    +
    +    def __enter__(self):
    +        logging.info('Entering: %s', self.name)
    +
    +    def __exit__(self, exc_type, exc, exc_tb):
    +        logging.info('Exiting: %s', self.name)
    +
    +
    +

    Instances of this class can be used as both a context manager:

    +
    with track_entry_and_exit('widget loader'):
    +    print('Some time consuming activity goes here')
    +    load_widget()
    +
    +
    +

    And also as a function decorator:

    +
    @track_entry_and_exit('widget loader')
    +def activity():
    +    print('Some time consuming activity goes here')
    +    load_widget()
    +
    +
    +

    Note that there is one additional limitation when using context managers +as function decorators: there’s no way to access the return value of +__enter__(). If that value is needed, then it is still necessary to use +an explicit with statement.

    +
    +

    See also

    +
    +
    PEP 343 - The “with” statement

    The specification, background, and examples for the Python with +statement.

    +
    +
    +
    +
    +
    +
    +

    Single use, reusable and reentrant context managers

    +

    Most context managers are written in a way that means they can only be +used effectively in a with statement once. These single use +context managers must be created afresh each time they’re used - +attempting to use them a second time will trigger an exception or +otherwise not work correctly.

    +

    This common limitation means that it is generally advisable to create +context managers directly in the header of the with statement +where they are used (as shown in all of the usage examples above).

    +

    Files are an example of effectively single use context managers, since +the first with statement will close the file, preventing any +further IO operations using that file object.

    +

    Context managers created using contextmanager() are also single use +context managers, and will complain about the underlying generator failing +to yield if an attempt is made to use them a second time:

    +
    >>> from contextlib import contextmanager
    +>>> @contextmanager
    +... def singleuse():
    +...     print("Before")
    +...     yield
    +...     print("After")
    +...
    +>>> cm = singleuse()
    +>>> with cm:
    +...     pass
    +...
    +Before
    +After
    +>>> with cm:
    +...     pass
    +...
    +Traceback (most recent call last):
    +    ...
    +RuntimeError: generator didn't yield
    +
    +
    +
    +

    Reentrant context managers

    +

    More sophisticated context managers may be “reentrant”. These context +managers can not only be used in multiple with statements, +but may also be used inside a with statement that is already +using the same context manager.

    +

    threading.RLock is an example of a reentrant context manager, as are +suppress() and redirect_stdout(). Here’s a very simple example of +reentrant use:

    +
    >>> from contextlib import redirect_stdout
    +>>> from io import StringIO
    +>>> stream = StringIO()
    +>>> write_to_stream = redirect_stdout(stream)
    +>>> with write_to_stream:
    +...     print("This is written to the stream rather than stdout")
    +...     with write_to_stream:
    +...         print("This is also written to the stream")
    +...
    +>>> print("This is written directly to stdout")
    +This is written directly to stdout
    +>>> print(stream.getvalue())
    +This is written to the stream rather than stdout
    +This is also written to the stream
    +
    +
    +

    Real world examples of reentrancy are more likely to involve multiple +functions calling each other and hence be far more complicated than this +example.

    +

    Note also that being reentrant is not the same thing as being thread safe. +redirect_stdout(), for example, is definitely not thread safe, as it +makes a global modification to the system state by binding sys.stdout +to a different stream.

    +
    +
    +

    Reusable context managers

    +

    Distinct from both single use and reentrant context managers are “reusable” +context managers (or, to be completely explicit, “reusable, but not +reentrant” context managers, since reentrant context managers are also +reusable). These context managers support being used multiple times, but +will fail (or otherwise not work correctly) if the specific context manager +instance has already been used in a containing with statement.

    +

    threading.Lock is an example of a reusable, but not reentrant, +context manager (for a reentrant lock, it is necessary to use +threading.RLock instead).

    +

    Another example of a reusable, but not reentrant, context manager is +ExitStack, as it invokes all currently registered callbacks +when leaving any with statement, regardless of where those callbacks +were added:

    +
    >>> from contextlib import ExitStack
    +>>> stack = ExitStack()
    +>>> with stack:
    +...     stack.callback(print, "Callback: from first context")
    +...     print("Leaving first context")
    +...
    +Leaving first context
    +Callback: from first context
    +>>> with stack:
    +...     stack.callback(print, "Callback: from second context")
    +...     print("Leaving second context")
    +...
    +Leaving second context
    +Callback: from second context
    +>>> with stack:
    +...     stack.callback(print, "Callback: from outer context")
    +...     with stack:
    +...         stack.callback(print, "Callback: from inner context")
    +...         print("Leaving inner context")
    +...     print("Leaving outer context")
    +...
    +Leaving inner context
    +Callback: from inner context
    +Callback: from outer context
    +Leaving outer context
    +
    +
    +

    As the output from the example shows, reusing a single stack object across +multiple with statements works correctly, but attempting to nest them +will cause the stack to be cleared at the end of the innermost with +statement, which is unlikely to be desirable behaviour.

    +

    Using separate ExitStack instances instead of reusing a single +instance avoids that problem:

    +
    >>> from contextlib import ExitStack
    +>>> with ExitStack() as outer_stack:
    +...     outer_stack.callback(print, "Callback: from outer context")
    +...     with ExitStack() as inner_stack:
    +...         inner_stack.callback(print, "Callback: from inner context")
    +...         print("Leaving inner context")
    +...     print("Leaving outer context")
    +...
    +Leaving inner context
    +Callback: from inner context
    +Leaving outer context
    +Callback: from outer context
    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/contextvars.html b/python-3.7.4-docs-html/library/contextvars.html new file mode 100644 index 0000000..34343cd --- /dev/null +++ b/python-3.7.4-docs-html/library/contextvars.html @@ -0,0 +1,489 @@ + + + + + + + contextvars — Context Variables — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    contextvars — Context Variables

    +
    +

    This module provides APIs to manage, store, and access context-local +state. The ContextVar class is used to declare +and work with Context Variables. The copy_context() +function and the Context class should be used to +manage the current context in asynchronous frameworks.

    +

    Context managers that have state should use Context Variables +instead of threading.local() to prevent their state from +bleeding to other code unexpectedly, when used in concurrent code.

    +

    See also PEP 567 for additional details.

    +
    +

    New in version 3.7.

    +
    +
    +

    Context Variables

    +
    +
    +class contextvars.ContextVar(name[, *, default])
    +

    This class is used to declare a new Context Variable, e.g.:

    +
    var: ContextVar[int] = ContextVar('var', default=42)
    +
    +
    +

    The required name parameter is used for introspection and debug +purposes.

    +

    The optional keyword-only default parameter is returned by +ContextVar.get() when no value for the variable is found +in the current context.

    +

    Important: Context Variables should be created at the top module +level and never in closures. Context objects hold strong +references to context variables which prevents context variables +from being properly garbage collected.

    +
    +
    +name
    +

    The name of the variable. This is a read-only property.

    +
    +

    New in version 3.7.1.

    +
    +
    + +
    +
    +get([default])
    +

    Return a value for the context variable for the current context.

    +

    If there is no value for the variable in the current context, +the method will:

    +
      +
    • return the value of the default argument of the method, +if provided; or

    • +
    • return the default value for the context variable, +if it was created with one; or

    • +
    • raise a LookupError.

    • +
    +
    + +
    +
    +set(value)
    +

    Call to set a new value for the context variable in the current +context.

    +

    The required value argument is the new value for the context +variable.

    +

    Returns a Token object that can be used +to restore the variable to its previous value via the +ContextVar.reset() method.

    +
    + +
    +
    +reset(token)
    +

    Reset the context variable to the value it had before the +ContextVar.set() that created the token was used.

    +

    For example:

    +
    var = ContextVar('var')
    +
    +token = var.set('new value')
    +# code that uses 'var'; var.get() returns 'new value'.
    +var.reset(token)
    +
    +# After the reset call the var has no value again, so
    +# var.get() would raise a LookupError.
    +
    +
    +
    + +
    + +
    +
    +class contextvars.Token
    +

    Token objects are returned by the ContextVar.set() method. +They can be passed to the ContextVar.reset() method to revert +the value of the variable to what it was before the corresponding +set.

    +
    +
    +Token.var
    +

    A read-only property. Points to the ContextVar object +that created the token.

    +
    + +
    +
    +Token.old_value
    +

    A read-only property. Set to the value the variable had before +the ContextVar.set() method call that created the token. +It points to Token.MISSING is the variable was not set +before the call.

    +
    + +
    +
    +Token.MISSING
    +

    A marker object used by Token.old_value.

    +
    + +
    + +
    +
    +

    Manual Context Management

    +
    +
    +contextvars.copy_context()
    +

    Returns a copy of the current Context object.

    +

    The following snippet gets a copy of the current context and prints +all variables and their values that are set in it:

    +
    ctx: Context = copy_context()
    +print(list(ctx.items()))
    +
    +
    +

    The function has an O(1) complexity, i.e. works equally fast for +contexts with a few context variables and for contexts that have +a lot of them.

    +
    + +
    +
    +class contextvars.Context
    +

    A mapping of ContextVars to their values.

    +

    Context() creates an empty context with no values in it. +To get a copy of the current context use the +copy_context() function.

    +

    Context implements the collections.abc.Mapping interface.

    +
    +
    +run(callable, *args, **kwargs)
    +

    Execute callable(*args, **kwargs) code in the context object +the run method is called on. Return the result of the execution +or propagate an exception if one occurred.

    +

    Any changes to any context variables that callable makes will +be contained in the context object:

    +
    var = ContextVar('var')
    +var.set('spam')
    +
    +def main():
    +    # 'var' was set to 'spam' before
    +    # calling 'copy_context()' and 'ctx.run(main)', so:
    +    # var.get() == ctx[var] == 'spam'
    +
    +    var.set('ham')
    +
    +    # Now, after setting 'var' to 'ham':
    +    # var.get() == ctx[var] == 'ham'
    +
    +ctx = copy_context()
    +
    +# Any changes that the 'main' function makes to 'var'
    +# will be contained in 'ctx'.
    +ctx.run(main)
    +
    +# The 'main()' function was run in the 'ctx' context,
    +# so changes to 'var' are contained in it:
    +# ctx[var] == 'ham'
    +
    +# However, outside of 'ctx', 'var' is still set to 'spam':
    +# var.get() == 'spam'
    +
    +
    +

    The method raises a RuntimeError when called on the same +context object from more than one OS thread, or when called +recursively.

    +
    + +
    +
    +copy()
    +

    Return a shallow copy of the context object.

    +
    + +
    +
    +var in context
    +

    Return True if the context has a value for var set; +return False otherwise.

    +
    + +
    +
    +context[var]
    +

    Return the value of the var ContextVar variable. +If the variable is not set in the context object, a +KeyError is raised.

    +
    + +
    +
    +get(var[, default])
    +

    Return the value for var if var has the value in the context +object. Return default otherwise. If default is not given, +return None.

    +
    + +
    +
    +iter(context)
    +

    Return an iterator over the variables stored in the context +object.

    +
    + +
    +
    +len(proxy)
    +

    Return the number of variables set in the context object.

    +
    + +
    +
    +keys()
    +

    Return a list of all variables in the context object.

    +
    + +
    +
    +values()
    +

    Return a list of all variables’ values in the context object.

    +
    + +
    +
    +items()
    +

    Return a list of 2-tuples containing all variables and their +values in the context object.

    +
    + +
    + +
    +
    +

    asyncio support

    +

    Context variables are natively supported in asyncio and are +ready to be used without any extra configuration. For example, here +is a simple echo server, that uses a context variable to make the +address of a remote client available in the Task that handles that +client:

    +
    import asyncio
    +import contextvars
    +
    +client_addr_var = contextvars.ContextVar('client_addr')
    +
    +def render_goodbye():
    +    # The address of the currently handled client can be accessed
    +    # without passing it explicitly to this function.
    +
    +    client_addr = client_addr_var.get()
    +    return f'Good bye, client @ {client_addr}\n'.encode()
    +
    +async def handle_request(reader, writer):
    +    addr = writer.transport.get_extra_info('socket').getpeername()
    +    client_addr_var.set(addr)
    +
    +    # In any code that we call is now possible to get
    +    # client's address by calling 'client_addr_var.get()'.
    +
    +    while True:
    +        line = await reader.readline()
    +        print(line)
    +        if not line.strip():
    +            break
    +        writer.write(line)
    +
    +    writer.write(render_goodbye())
    +    writer.close()
    +
    +async def main():
    +    srv = await asyncio.start_server(
    +        handle_request, '127.0.0.1', 8081)
    +
    +    async with srv:
    +        await srv.serve_forever()
    +
    +asyncio.run(main())
    +
    +# To test it you can use telnet:
    +#     telnet 127.0.0.1 8081
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/copy.html b/python-3.7.4-docs-html/library/copy.html new file mode 100644 index 0000000..6c46340 --- /dev/null +++ b/python-3.7.4-docs-html/library/copy.html @@ -0,0 +1,258 @@ + + + + + + + copy — Shallow and deep copy operations — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    copy — Shallow and deep copy operations

    +

    Source code: Lib/copy.py

    +
    +

    Assignment statements in Python do not copy objects, they create bindings +between a target and an object. For collections that are mutable or contain +mutable items, a copy is sometimes needed so one can change one copy without +changing the other. This module provides generic shallow and deep copy +operations (explained below).

    +

    Interface summary:

    +
    +
    +copy.copy(x)
    +

    Return a shallow copy of x.

    +
    + +
    +
    +copy.deepcopy(x[, memo])
    +

    Return a deep copy of x.

    +
    + +
    +
    +exception copy.error
    +

    Raised for module specific errors.

    +
    + +

    The difference between shallow and deep copying is only relevant for compound +objects (objects that contain other objects, like lists or class instances):

    +
      +
    • A shallow copy constructs a new compound object and then (to the extent +possible) inserts references into it to the objects found in the original.

    • +
    • A deep copy constructs a new compound object and then, recursively, inserts +copies into it of the objects found in the original.

    • +
    +

    Two problems often exist with deep copy operations that don’t exist with shallow +copy operations:

    +
      +
    • Recursive objects (compound objects that, directly or indirectly, contain a +reference to themselves) may cause a recursive loop.

    • +
    • Because deep copy copies everything it may copy too much, such as data +which is intended to be shared between copies.

    • +
    +

    The deepcopy() function avoids these problems by:

    +
      +
    • keeping a memo dictionary of objects already copied during the current +copying pass; and

    • +
    • letting user-defined classes override the copying operation or the set of +components copied.

    • +
    +

    This module does not copy types like module, method, stack trace, stack frame, +file, socket, window, array, or any similar types. It does “copy” functions and +classes (shallow and deeply), by returning the original object unchanged; this +is compatible with the way these are treated by the pickle module.

    +

    Shallow copies of dictionaries can be made using dict.copy(), and +of lists by assigning a slice of the entire list, for example, +copied_list = original_list[:].

    +

    Classes can use the same interfaces to control copying that they use to control +pickling. See the description of module pickle for information on these +methods. In fact, the copy module uses the registered +pickle functions from the copyreg module.

    +

    In order for a class to define its own copy implementation, it can define +special methods __copy__() and __deepcopy__(). The former is called +to implement the shallow copy operation; no additional arguments are passed. +The latter is called to implement the deep copy operation; it is passed one +argument, the memo dictionary. If the __deepcopy__() implementation needs +to make a deep copy of a component, it should call the deepcopy() function +with the component as first argument and the memo dictionary as second argument.

    +
    +

    See also

    +
    +
    Module pickle

    Discussion of the special methods used to support object state retrieval and +restoration.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/copyreg.html b/python-3.7.4-docs-html/library/copyreg.html new file mode 100644 index 0000000..2352c6c --- /dev/null +++ b/python-3.7.4-docs-html/library/copyreg.html @@ -0,0 +1,244 @@ + + + + + + + copyreg — Register pickle support functions — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    copyreg — Register pickle support functions

    +

    Source code: Lib/copyreg.py

    +
    +

    The copyreg module offers a way to define functions used while pickling +specific objects. The pickle and copy modules use those functions +when pickling/copying those objects. The module provides configuration +information about object constructors which are not classes. +Such constructors may be factory functions or class instances.

    +
    +
    +copyreg.constructor(object)
    +

    Declares object to be a valid constructor. If object is not callable (and +hence not valid as a constructor), raises TypeError.

    +
    + +
    +
    +copyreg.pickle(type, function, constructor=None)
    +

    Declares that function should be used as a “reduction” function for objects +of type type. function should return either a string or a tuple +containing two or three elements.

    +

    The optional constructor parameter, if provided, is a callable object which +can be used to reconstruct the object when called with the tuple of arguments +returned by function at pickling time. TypeError will be raised if +object is a class or constructor is not callable.

    +

    See the pickle module for more details on the interface +expected of function and constructor. Note that the +dispatch_table attribute of a pickler +object or subclass of pickle.Pickler can also be used for +declaring reduction functions.

    +
    + +
    +

    Example

    +

    The example below would like to show how to register a pickle function and how +it will be used:

    +
    >>> import copyreg, copy, pickle
    +>>> class C(object):
    +...     def __init__(self, a):
    +...         self.a = a
    +...
    +>>> def pickle_c(c):
    +...     print("pickling a C instance...")
    +...     return C, (c.a,)
    +...
    +>>> copyreg.pickle(C, pickle_c)
    +>>> c = C(1)
    +>>> d = copy.copy(c)  # doctest: +SKIP
    +pickling a C instance...
    +>>> p = pickle.dumps(c)  # doctest: +SKIP
    +pickling a C instance...
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/crypt.html b/python-3.7.4-docs-html/library/crypt.html new file mode 100644 index 0000000..505b462 --- /dev/null +++ b/python-3.7.4-docs-html/library/crypt.html @@ -0,0 +1,353 @@ + + + + + + + crypt — Function to check Unix passwords — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    crypt — Function to check Unix passwords

    +

    Source code: Lib/crypt.py

    +
    +

    This module implements an interface to the crypt(3) routine, which is +a one-way hash function based upon a modified DES algorithm; see the Unix man +page for further details. Possible uses include storing hashed passwords +so you can check passwords without storing the actual password, or attempting +to crack Unix passwords with a dictionary.

    +

    Notice that the behavior of this module depends on the actual implementation of +the crypt(3) routine in the running system. Therefore, any +extensions available on the current implementation will also be available on +this module.

    +
    +

    Hashing Methods

    +
    +

    New in version 3.3.

    +
    +

    The crypt module defines the list of hashing methods (not all methods +are available on all platforms):

    +
    +
    +crypt.METHOD_SHA512
    +

    A Modular Crypt Format method with 16 character salt and 86 character +hash based on the SHA-512 hash function. This is the strongest method.

    +
    + +
    +
    +crypt.METHOD_SHA256
    +

    Another Modular Crypt Format method with 16 character salt and 43 +character hash based on the SHA-256 hash function.

    +
    + +
    +
    +crypt.METHOD_BLOWFISH
    +

    Another Modular Crypt Format method with 22 character salt and 31 +character hash based on the Blowfish cipher.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +crypt.METHOD_MD5
    +

    Another Modular Crypt Format method with 8 character salt and 22 +character hash based on the MD5 hash function.

    +
    + +
    +
    +crypt.METHOD_CRYPT
    +

    The traditional method with a 2 character salt and 13 characters of +hash. This is the weakest method.

    +
    + +
    +
    +

    Module Attributes

    +
    +

    New in version 3.3.

    +
    +
    +
    +crypt.methods
    +

    A list of available password hashing algorithms, as +crypt.METHOD_* objects. This list is sorted from strongest to +weakest.

    +
    + +
    +
    +

    Module Functions

    +

    The crypt module defines the following functions:

    +
    +
    +crypt.crypt(word, salt=None)
    +

    word will usually be a user’s password as typed at a prompt or in a graphical +interface. The optional salt is either a string as returned from +mksalt(), one of the crypt.METHOD_* values (though not all +may be available on all platforms), or a full encrypted password +including salt, as returned by this function. If salt is not +provided, the strongest method will be used (as returned by +methods()).

    +

    Checking a password is usually done by passing the plain-text password +as word and the full results of a previous crypt() call, +which should be the same as the results of this call.

    +

    salt (either a random 2 or 16 character string, possibly prefixed with +$digit$ to indicate the method) which will be used to perturb the +encryption algorithm. The characters in salt must be in the set +[./a-zA-Z0-9], with the exception of Modular Crypt Format which +prefixes a $digit$.

    +

    Returns the hashed password as a string, which will be composed of +characters from the same alphabet as the salt.

    +

    Since a few crypt(3) extensions allow different values, with +different sizes in the salt, it is recommended to use the full crypted +password as salt when checking for a password.

    +
    +

    Changed in version 3.3: Accept crypt.METHOD_* values in addition to strings for salt.

    +
    +
    + +
    +
    +crypt.mksalt(method=None, *, rounds=None)
    +

    Return a randomly generated salt of the specified method. If no +method is given, the strongest method available as returned by +methods() is used.

    +

    The return value is a string suitable for passing as the salt argument +to crypt().

    +

    rounds specifies the number of rounds for METHOD_SHA256, +METHOD_SHA512 and METHOD_BLOWFISH. +For METHOD_SHA256 and METHOD_SHA512 it must be an integer between +1000 and 999_999_999, the default is 5000. For +METHOD_BLOWFISH it must be a power of two between 16 (24) +and 2_147_483_648 (231), the default is 4096 +(212).

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.7: Added the rounds parameter.

    +
    +
    + +
    +
    +

    Examples

    +

    A simple example illustrating typical use (a constant-time comparison +operation is needed to limit exposure to timing attacks. +hmac.compare_digest() is suitable for this purpose):

    +
    import pwd
    +import crypt
    +import getpass
    +from hmac import compare_digest as compare_hash
    +
    +def login():
    +    username = input('Python login: ')
    +    cryptedpasswd = pwd.getpwnam(username)[1]
    +    if cryptedpasswd:
    +        if cryptedpasswd == 'x' or cryptedpasswd == '*':
    +            raise ValueError('no support for shadow passwords')
    +        cleartext = getpass.getpass()
    +        return compare_hash(crypt.crypt(cleartext, cryptedpasswd), cryptedpasswd)
    +    else:
    +        return True
    +
    +
    +

    To generate a hash of a password using the strongest available method and +check it against the original:

    +
    import crypt
    +from hmac import compare_digest as compare_hash
    +
    +hashed = crypt.crypt(plaintext)
    +if not compare_hash(hashed, crypt.crypt(plaintext, hashed)):
    +    raise ValueError("hashed version doesn't validate against original")
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/crypto.html b/python-3.7.4-docs-html/library/crypto.html new file mode 100644 index 0000000..43dd951 --- /dev/null +++ b/python-3.7.4-docs-html/library/crypto.html @@ -0,0 +1,221 @@ + + + + + + + Cryptographic Services — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Cryptographic Services

    +

    The modules described in this chapter implement various algorithms of a +cryptographic nature. They are available at the discretion of the installation. +On Unix systems, the crypt module may also be available. +Here’s an overview:

    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/csv.html b/python-3.7.4-docs-html/library/csv.html new file mode 100644 index 0000000..2357e45 --- /dev/null +++ b/python-3.7.4-docs-html/library/csv.html @@ -0,0 +1,735 @@ + + + + + + + csv — CSV File Reading and Writing — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    csv — CSV File Reading and Writing

    +

    Source code: Lib/csv.py

    +
    +

    The so-called CSV (Comma Separated Values) format is the most common import and +export format for spreadsheets and databases. CSV format was used for many +years prior to attempts to describe the format in a standardized way in +RFC 4180. The lack of a well-defined standard means that subtle differences +often exist in the data produced and consumed by different applications. These +differences can make it annoying to process CSV files from multiple sources. +Still, while the delimiters and quoting characters vary, the overall format is +similar enough that it is possible to write a single module which can +efficiently manipulate such data, hiding the details of reading and writing the +data from the programmer.

    +

    The csv module implements classes to read and write tabular data in CSV +format. It allows programmers to say, “write this data in the format preferred +by Excel,” or “read data from this file which was generated by Excel,” without +knowing the precise details of the CSV format used by Excel. Programmers can +also describe the CSV formats understood by other applications or define their +own special-purpose CSV formats.

    +

    The csv module’s reader and writer objects read and +write sequences. Programmers can also read and write data in dictionary form +using the DictReader and DictWriter classes.

    +
    +

    See also

    +
    +
    PEP 305 - CSV File API

    The Python Enhancement Proposal which proposed this addition to Python.

    +
    +
    +
    +
    +

    Module Contents

    +

    The csv module defines the following functions:

    +
    +
    +csv.reader(csvfile, dialect='excel', **fmtparams)
    +

    Return a reader object which will iterate over lines in the given csvfile. +csvfile can be any object which supports the iterator protocol and returns a +string each time its __next__() method is called — file objects and list objects are both suitable. If csvfile is a file object, +it should be opened with newline=''. 1 An optional +dialect parameter can be given which is used to define a set of parameters +specific to a particular CSV dialect. It may be an instance of a subclass of +the Dialect class or one of the strings returned by the +list_dialects() function. The other optional fmtparams keyword arguments +can be given to override individual formatting parameters in the current +dialect. For full details about the dialect and formatting parameters, see +section Dialects and Formatting Parameters.

    +

    Each row read from the csv file is returned as a list of strings. No +automatic data type conversion is performed unless the QUOTE_NONNUMERIC format +option is specified (in which case unquoted fields are transformed into floats).

    +

    A short usage example:

    +
    >>> import csv
    +>>> with open('eggs.csv', newline='') as csvfile:
    +...     spamreader = csv.reader(csvfile, delimiter=' ', quotechar='|')
    +...     for row in spamreader:
    +...         print(', '.join(row))
    +Spam, Spam, Spam, Spam, Spam, Baked Beans
    +Spam, Lovely Spam, Wonderful Spam
    +
    +
    +
    + +
    +
    +csv.writer(csvfile, dialect='excel', **fmtparams)
    +

    Return a writer object responsible for converting the user’s data into delimited +strings on the given file-like object. csvfile can be any object with a +write() method. If csvfile is a file object, it should be opened with +newline='' 1. An optional dialect +parameter can be given which is used to define a set of parameters specific to a +particular CSV dialect. It may be an instance of a subclass of the +Dialect class or one of the strings returned by the +list_dialects() function. The other optional fmtparams keyword arguments +can be given to override individual formatting parameters in the current +dialect. For full details about the dialect and formatting parameters, see +section Dialects and Formatting Parameters. To make it +as easy as possible to interface with modules which implement the DB API, the +value None is written as the empty string. While this isn’t a +reversible transformation, it makes it easier to dump SQL NULL data values to +CSV files without preprocessing the data returned from a cursor.fetch* call. +All other non-string data are stringified with str() before being written.

    +

    A short usage example:

    +
    import csv
    +with open('eggs.csv', 'w', newline='') as csvfile:
    +    spamwriter = csv.writer(csvfile, delimiter=' ',
    +                            quotechar='|', quoting=csv.QUOTE_MINIMAL)
    +    spamwriter.writerow(['Spam'] * 5 + ['Baked Beans'])
    +    spamwriter.writerow(['Spam', 'Lovely Spam', 'Wonderful Spam'])
    +
    +
    +
    + +
    +
    +csv.register_dialect(name[, dialect[, **fmtparams]])
    +

    Associate dialect with name. name must be a string. The +dialect can be specified either by passing a sub-class of Dialect, or +by fmtparams keyword arguments, or both, with keyword arguments overriding +parameters of the dialect. For full details about the dialect and formatting +parameters, see section Dialects and Formatting Parameters.

    +
    + +
    +
    +csv.unregister_dialect(name)
    +

    Delete the dialect associated with name from the dialect registry. An +Error is raised if name is not a registered dialect name.

    +
    + +
    +
    +csv.get_dialect(name)
    +

    Return the dialect associated with name. An Error is raised if +name is not a registered dialect name. This function returns an immutable +Dialect.

    +
    + +
    +
    +csv.list_dialects()
    +

    Return the names of all registered dialects.

    +
    + +
    +
    +csv.field_size_limit([new_limit])
    +

    Returns the current maximum field size allowed by the parser. If new_limit is +given, this becomes the new limit.

    +
    + +

    The csv module defines the following classes:

    +
    +
    +class csv.DictReader(f, fieldnames=None, restkey=None, restval=None, dialect='excel', *args, **kwds)
    +

    Create an object that operates like a regular reader but maps the +information in each row to an OrderedDict +whose keys are given by the optional fieldnames parameter.

    +

    The fieldnames parameter is a sequence. If fieldnames is +omitted, the values in the first row of file f will be used as the +fieldnames. Regardless of how the fieldnames are determined, the ordered +dictionary preserves their original ordering.

    +

    If a row has more fields than fieldnames, the remaining data is put in a +list and stored with the fieldname specified by restkey (which defaults +to None). If a non-blank row has fewer fields than fieldnames, the +missing values are filled-in with None.

    +

    All other optional or keyword arguments are passed to the underlying +reader instance.

    +
    +

    Changed in version 3.6: Returned rows are now of type OrderedDict.

    +
    +

    A short usage example:

    +
    >>> import csv
    +>>> with open('names.csv', newline='') as csvfile:
    +...     reader = csv.DictReader(csvfile)
    +...     for row in reader:
    +...         print(row['first_name'], row['last_name'])
    +...
    +Eric Idle
    +John Cleese
    +
    +>>> print(row)
    +OrderedDict([('first_name', 'John'), ('last_name', 'Cleese')])
    +
    +
    +
    + +
    +
    +class csv.DictWriter(f, fieldnames, restval='', extrasaction='raise', dialect='excel', *args, **kwds)
    +

    Create an object which operates like a regular writer but maps dictionaries +onto output rows. The fieldnames parameter is a sequence of keys that identify the order in which values in the +dictionary passed to the writerow() method are written to file +f. The optional restval parameter specifies the value to be +written if the dictionary is missing a key in fieldnames. If the +dictionary passed to the writerow() method contains a key not found in +fieldnames, the optional extrasaction parameter indicates what action to +take. +If it is set to 'raise', the default value, a ValueError +is raised. +If it is set to 'ignore', extra values in the dictionary are ignored. +Any other optional or keyword arguments are passed to the underlying +writer instance.

    +

    Note that unlike the DictReader class, the fieldnames parameter +of the DictWriter class is not optional.

    +

    A short usage example:

    +
    import csv
    +
    +with open('names.csv', 'w', newline='') as csvfile:
    +    fieldnames = ['first_name', 'last_name']
    +    writer = csv.DictWriter(csvfile, fieldnames=fieldnames)
    +
    +    writer.writeheader()
    +    writer.writerow({'first_name': 'Baked', 'last_name': 'Beans'})
    +    writer.writerow({'first_name': 'Lovely', 'last_name': 'Spam'})
    +    writer.writerow({'first_name': 'Wonderful', 'last_name': 'Spam'})
    +
    +
    +
    + +
    +
    +class csv.Dialect
    +

    The Dialect class is a container class relied on primarily for its +attributes, which are used to define the parameters for a specific +reader or writer instance.

    +
    + +
    +
    +class csv.excel
    +

    The excel class defines the usual properties of an Excel-generated CSV +file. It is registered with the dialect name 'excel'.

    +
    + +
    +
    +class csv.excel_tab
    +

    The excel_tab class defines the usual properties of an Excel-generated +TAB-delimited file. It is registered with the dialect name 'excel-tab'.

    +
    + +
    +
    +class csv.unix_dialect
    +

    The unix_dialect class defines the usual properties of a CSV file +generated on UNIX systems, i.e. using '\n' as line terminator and quoting +all fields. It is registered with the dialect name 'unix'.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +class csv.Sniffer
    +

    The Sniffer class is used to deduce the format of a CSV file.

    +

    The Sniffer class provides two methods:

    +
    +
    +sniff(sample, delimiters=None)
    +

    Analyze the given sample and return a Dialect subclass +reflecting the parameters found. If the optional delimiters parameter +is given, it is interpreted as a string containing possible valid +delimiter characters.

    +
    + +
    +
    +has_header(sample)
    +

    Analyze the sample text (presumed to be in CSV format) and return +True if the first row appears to be a series of column headers.

    +
    + +
    + +

    An example for Sniffer use:

    +
    with open('example.csv', newline='') as csvfile:
    +    dialect = csv.Sniffer().sniff(csvfile.read(1024))
    +    csvfile.seek(0)
    +    reader = csv.reader(csvfile, dialect)
    +    # ... process CSV file contents here ...
    +
    +
    +

    The csv module defines the following constants:

    +
    +
    +csv.QUOTE_ALL
    +

    Instructs writer objects to quote all fields.

    +
    + +
    +
    +csv.QUOTE_MINIMAL
    +

    Instructs writer objects to only quote those fields which contain +special characters such as delimiter, quotechar or any of the characters in +lineterminator.

    +
    + +
    +
    +csv.QUOTE_NONNUMERIC
    +

    Instructs writer objects to quote all non-numeric fields.

    +

    Instructs the reader to convert all non-quoted fields to type float.

    +
    + +
    +
    +csv.QUOTE_NONE
    +

    Instructs writer objects to never quote fields. When the current +delimiter occurs in output data it is preceded by the current escapechar +character. If escapechar is not set, the writer will raise Error if +any characters that require escaping are encountered.

    +

    Instructs reader to perform no special processing of quote characters.

    +
    + +

    The csv module defines the following exception:

    +
    +
    +exception csv.Error
    +

    Raised by any of the functions when an error is detected.

    +
    + +
    +
    +

    Dialects and Formatting Parameters

    +

    To make it easier to specify the format of input and output records, specific +formatting parameters are grouped together into dialects. A dialect is a +subclass of the Dialect class having a set of specific methods and a +single validate() method. When creating reader or +writer objects, the programmer can specify a string or a subclass of +the Dialect class as the dialect parameter. In addition to, or instead +of, the dialect parameter, the programmer can also specify individual +formatting parameters, which have the same names as the attributes defined below +for the Dialect class.

    +

    Dialects support the following attributes:

    +
    +
    +Dialect.delimiter
    +

    A one-character string used to separate fields. It defaults to ','.

    +
    + +
    +
    +Dialect.doublequote
    +

    Controls how instances of quotechar appearing inside a field should +themselves be quoted. When True, the character is doubled. When +False, the escapechar is used as a prefix to the quotechar. It +defaults to True.

    +

    On output, if doublequote is False and no escapechar is set, +Error is raised if a quotechar is found in a field.

    +
    + +
    +
    +Dialect.escapechar
    +

    A one-character string used by the writer to escape the delimiter if quoting +is set to QUOTE_NONE and the quotechar if doublequote is +False. On reading, the escapechar removes any special meaning from +the following character. It defaults to None, which disables escaping.

    +
    + +
    +
    +Dialect.lineterminator
    +

    The string used to terminate lines produced by the writer. It defaults +to '\r\n'.

    +
    +

    Note

    +

    The reader is hard-coded to recognise either '\r' or '\n' as +end-of-line, and ignores lineterminator. This behavior may change in the +future.

    +
    +
    + +
    +
    +Dialect.quotechar
    +

    A one-character string used to quote fields containing special characters, such +as the delimiter or quotechar, or which contain new-line characters. It +defaults to '"'.

    +
    + +
    +
    +Dialect.quoting
    +

    Controls when quotes should be generated by the writer and recognised by the +reader. It can take on any of the QUOTE_* constants (see section +Module Contents) and defaults to QUOTE_MINIMAL.

    +
    + +
    +
    +Dialect.skipinitialspace
    +

    When True, whitespace immediately following the delimiter is ignored. +The default is False.

    +
    + +
    +
    +Dialect.strict
    +

    When True, raise exception Error on bad CSV input. +The default is False.

    +
    + +
    +
    +

    Reader Objects

    +

    Reader objects (DictReader instances and objects returned by the +reader() function) have the following public methods:

    +
    +
    +csvreader.__next__()
    +

    Return the next row of the reader’s iterable object as a list (if the object +was returned from reader()) or a dict (if it is a DictReader +instance), parsed according to the current dialect. Usually you should call +this as next(reader).

    +
    + +

    Reader objects have the following public attributes:

    +
    +
    +csvreader.dialect
    +

    A read-only description of the dialect in use by the parser.

    +
    + +
    +
    +csvreader.line_num
    +

    The number of lines read from the source iterator. This is not the same as the +number of records returned, as records can span multiple lines.

    +
    + +

    DictReader objects have the following public attribute:

    +
    +
    +csvreader.fieldnames
    +

    If not passed as a parameter when creating the object, this attribute is +initialized upon first access or when the first record is read from the +file.

    +
    + +
    +
    +

    Writer Objects

    +

    Writer objects (DictWriter instances and objects returned by +the writer() function) have the following public methods. A row must be +an iterable of strings or numbers for Writer objects and a dictionary +mapping fieldnames to strings or numbers (by passing them through str() +first) for DictWriter objects. Note that complex numbers are written +out surrounded by parens. This may cause some problems for other programs which +read CSV files (assuming they support complex numbers at all).

    +
    +
    +csvwriter.writerow(row)
    +

    Write the row parameter to the writer’s file object, formatted according to +the current dialect.

    +
    +

    Changed in version 3.5: Added support of arbitrary iterables.

    +
    +
    + +
    +
    +csvwriter.writerows(rows)
    +

    Write all elements in rows (an iterable of row objects as described +above) to the writer’s file object, formatted according to the current +dialect.

    +
    + +

    Writer objects have the following public attribute:

    +
    +
    +csvwriter.dialect
    +

    A read-only description of the dialect in use by the writer.

    +
    + +

    DictWriter objects have the following public method:

    +
    +
    +DictWriter.writeheader()
    +

    Write a row with the field names (as specified in the constructor).

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +

    Examples

    +

    The simplest example of reading a CSV file:

    +
    import csv
    +with open('some.csv', newline='') as f:
    +    reader = csv.reader(f)
    +    for row in reader:
    +        print(row)
    +
    +
    +

    Reading a file with an alternate format:

    +
    import csv
    +with open('passwd', newline='') as f:
    +    reader = csv.reader(f, delimiter=':', quoting=csv.QUOTE_NONE)
    +    for row in reader:
    +        print(row)
    +
    +
    +

    The corresponding simplest possible writing example is:

    +
    import csv
    +with open('some.csv', 'w', newline='') as f:
    +    writer = csv.writer(f)
    +    writer.writerows(someiterable)
    +
    +
    +

    Since open() is used to open a CSV file for reading, the file +will by default be decoded into unicode using the system default +encoding (see locale.getpreferredencoding()). To decode a file +using a different encoding, use the encoding argument of open:

    +
    import csv
    +with open('some.csv', newline='', encoding='utf-8') as f:
    +    reader = csv.reader(f)
    +    for row in reader:
    +        print(row)
    +
    +
    +

    The same applies to writing in something other than the system default +encoding: specify the encoding argument when opening the output file.

    +

    Registering a new dialect:

    +
    import csv
    +csv.register_dialect('unixpwd', delimiter=':', quoting=csv.QUOTE_NONE)
    +with open('passwd', newline='') as f:
    +    reader = csv.reader(f, 'unixpwd')
    +
    +
    +

    A slightly more advanced use of the reader — catching and reporting errors:

    +
    import csv, sys
    +filename = 'some.csv'
    +with open(filename, newline='') as f:
    +    reader = csv.reader(f)
    +    try:
    +        for row in reader:
    +            print(row)
    +    except csv.Error as e:
    +        sys.exit('file {}, line {}: {}'.format(filename, reader.line_num, e))
    +
    +
    +

    And while the module doesn’t directly support parsing strings, it can easily be +done:

    +
    import csv
    +for row in csv.reader(['one,two,three']):
    +    print(row)
    +
    +
    +

    Footnotes

    +
    +
    1(1,2)
    +

    If newline='' is not specified, newlines embedded inside quoted fields +will not be interpreted correctly, and on platforms that use \r\n linendings +on write an extra \r will be added. It should always be safe to specify +newline='', since the csv module does its own +(universal) newline handling.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/ctypes.html b/python-3.7.4-docs-html/library/ctypes.html new file mode 100644 index 0000000..0ae3612 --- /dev/null +++ b/python-3.7.4-docs-html/library/ctypes.html @@ -0,0 +1,2646 @@ + + + + + + + ctypes — A foreign function library for Python — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    ctypes — A foreign function library for Python

    +
    +

    ctypes is a foreign function library for Python. It provides C compatible +data types, and allows calling functions in DLLs or shared libraries. It can be +used to wrap these libraries in pure Python.

    +
    +

    ctypes tutorial

    +

    Note: The code samples in this tutorial use doctest to make sure that +they actually work. Since some code samples behave differently under Linux, +Windows, or Mac OS X, they contain doctest directives in comments.

    +

    Note: Some code samples reference the ctypes c_int type. On platforms +where sizeof(long) == sizeof(int) it is an alias to c_long. +So, you should not be confused if c_long is printed if you would expect +c_int — they are actually the same type.

    + +
    +

    Accessing functions from loaded dlls

    +

    Functions are accessed as attributes of dll objects:

    +
    >>> from ctypes import *
    +>>> libc.printf
    +<_FuncPtr object at 0x...>
    +>>> print(windll.kernel32.GetModuleHandleA)  
    +<_FuncPtr object at 0x...>
    +>>> print(windll.kernel32.MyOwnFunction)     
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +  File "ctypes.py", line 239, in __getattr__
    +    func = _StdcallFuncPtr(name, self)
    +AttributeError: function 'MyOwnFunction' not found
    +>>>
    +
    +
    +

    Note that win32 system dlls like kernel32 and user32 often export ANSI +as well as UNICODE versions of a function. The UNICODE version is exported with +an W appended to the name, while the ANSI version is exported with an A +appended to the name. The win32 GetModuleHandle function, which returns a +module handle for a given module name, has the following C prototype, and a +macro is used to expose one of them as GetModuleHandle depending on whether +UNICODE is defined or not:

    +
    /* ANSI version */
    +HMODULE GetModuleHandleA(LPCSTR lpModuleName);
    +/* UNICODE version */
    +HMODULE GetModuleHandleW(LPCWSTR lpModuleName);
    +
    +
    +

    windll does not try to select one of them by magic, you must access the +version you need by specifying GetModuleHandleA or GetModuleHandleW +explicitly, and then call it with bytes or string objects respectively.

    +

    Sometimes, dlls export functions with names which aren’t valid Python +identifiers, like "??2@YAPAXI@Z". In this case you have to use +getattr() to retrieve the function:

    +
    >>> getattr(cdll.msvcrt, "??2@YAPAXI@Z")  
    +<_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]  
    +<_FuncPtr object at 0x...>
    +>>> cdll.kernel32[0]  
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +  File "ctypes.py", line 310, in __getitem__
    +    func = _StdcallFuncPtr(name, self)
    +AttributeError: function ordinal 0 not found
    +>>>
    +
    +
    +
    +
    +

    Calling functions

    +

    You can call these functions like any other Python callable. This example uses +the time() function, which returns system time in seconds since the Unix +epoch, and the GetModuleHandleA() function, which returns a win32 module +handle.

    +

    This example calls both functions with a NULL pointer (None should be used +as the NULL pointer):

    +
    >>> print(libc.time(None))  
    +1150640792
    +>>> print(hex(windll.kernel32.GetModuleHandleA(None)))  
    +0x1d000000
    +>>>
    +
    +
    +
    +

    Note

    +

    ctypes may raise a ValueError after calling the function, if +it detects that an invalid number of arguments were passed. This behavior +should not be relied upon. It is deprecated in 3.6.2, and will be removed +in 3.7.

    +
    +

    ValueError is raised when you call an stdcall function with the +cdecl calling convention, or vice versa:

    +
    >>> cdll.kernel32.GetModuleHandleA(None)  
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +ValueError: Procedure probably called with not enough arguments (4 bytes missing)
    +>>>
    +
    +>>> windll.msvcrt.printf(b"spam")  
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +ValueError: Procedure probably called with too many arguments (4 bytes in excess)
    +>>>
    +
    +
    +

    To find out the correct calling convention you have to look into the C header +file or the documentation for the function you want to call.

    +

    On Windows, 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)  
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +OSError: exception: access violation reading 0x00000020
    +>>>
    +
    +
    +

    There are, however, enough ways to crash Python with ctypes, so you +should be careful anyway. The faulthandler module can be helpful in +debugging crashes (e.g. from segmentation faults produced by erroneous C library +calls).

    +

    None, integers, bytes objects and (unicode) strings are the only native +Python objects that can directly be used as parameters in these function calls. +None is passed as a C NULL pointer, bytes objects and strings are passed +as pointer to the memory block that contains their data (char * or +wchar_t *). Python integers are passed as the platforms default C +int type, their value is masked to fit into the C type.

    +

    Before we move on calling functions with other parameter types, we have to learn +more about ctypes data types.

    +
    +
    +

    Fundamental data types

    +

    ctypes defines a number of primitive C compatible data types:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    ctypes type

    C type

    Python type

    c_bool

    _Bool

    bool (1)

    c_char

    char

    1-character bytes object

    c_wchar

    wchar_t

    1-character string

    c_byte

    char

    int

    c_ubyte

    unsigned char

    int

    c_short

    short

    int

    c_ushort

    unsigned short

    int

    c_int

    int

    int

    c_uint

    unsigned int

    int

    c_long

    long

    int

    c_ulong

    unsigned long

    int

    c_longlong

    __int64 or long long

    int

    c_ulonglong

    unsigned __int64 or +unsigned long long

    int

    c_size_t

    size_t

    int

    c_ssize_t

    ssize_t or +Py_ssize_t

    int

    c_float

    float

    float

    c_double

    double

    float

    c_longdouble

    long double

    float

    c_char_p

    char * (NUL terminated)

    bytes object or None

    c_wchar_p

    wchar_t * (NUL terminated)

    string or None

    c_void_p

    void *

    int or None

    +
      +
    1. The constructor accepts any object with a truth value.

    2. +
    +

    All these types can be created by calling them with an optional initializer of +the correct type and value:

    +
    >>> c_int()
    +c_long(0)
    +>>> c_wchar_p("Hello, World")
    +c_wchar_p(140018365411392)
    +>>> c_ushort(-3)
    +c_ushort(65533)
    +>>>
    +
    +
    +

    Since these types are mutable, their value can also be changed afterwards:

    +
    >>> i = c_int(42)
    +>>> print(i)
    +c_long(42)
    +>>> print(i.value)
    +42
    +>>> i.value = -99
    +>>> print(i.value)
    +-99
    +>>>
    +
    +
    +

    Assigning a new value to instances of the pointer types c_char_p, +c_wchar_p, and c_void_p changes the memory location they +point to, not the contents of the memory block (of course not, because Python +bytes objects are immutable):

    +
    >>> s = "Hello, World"
    +>>> c_s = c_wchar_p(s)
    +>>> print(c_s)
    +c_wchar_p(139966785747344)
    +>>> print(c_s.value)
    +Hello World
    +>>> c_s.value = "Hi, there"
    +>>> print(c_s)              # the memory location has changed
    +c_wchar_p(139966783348904)
    +>>> print(c_s.value)
    +Hi, there
    +>>> print(s)                # first object is unchanged
    +Hello, World
    +>>>
    +
    +
    +

    You should be careful, however, not to pass them to functions expecting pointers +to mutable memory. If you need mutable memory blocks, ctypes has a +create_string_buffer() function which creates these in various ways. The +current memory block contents can be accessed (or changed) with the raw +property; if you want to access it as NUL terminated string, use the value +property:

    +
    >>> from ctypes import *
    +>>> p = create_string_buffer(3)            # create a 3 byte buffer, initialized to NUL bytes
    +>>> print(sizeof(p), repr(p.raw))
    +3 b'\x00\x00\x00'
    +>>> p = create_string_buffer(b"Hello")     # create a buffer containing a NUL terminated string
    +>>> print(sizeof(p), repr(p.raw))
    +6 b'Hello\x00'
    +>>> print(repr(p.value))
    +b'Hello'
    +>>> p = create_string_buffer(b"Hello", 10) # create a 10 byte buffer
    +>>> print(sizeof(p), repr(p.raw))
    +10 b'Hello\x00\x00\x00\x00\x00'
    +>>> p.value = b"Hi"
    +>>> print(sizeof(p), repr(p.raw))
    +10 b'Hi\x00lo\x00\x00\x00\x00\x00'
    +>>>
    +
    +
    +

    The create_string_buffer() function replaces the c_buffer() function +(which is still available as an alias), as well as the c_string() function +from earlier ctypes releases. To create a mutable memory block containing +unicode characters of the C type wchar_t use the +create_unicode_buffer() function.

    +
    +
    +

    Calling functions, continued

    +

    Note that printf prints to the real standard output channel, not to +sys.stdout, so these examples will only work at the console prompt, not +from within IDLE or PythonWin:

    +
    >>> printf = libc.printf
    +>>> printf(b"Hello, %s\n", b"World!")
    +Hello, World!
    +14
    +>>> printf(b"Hello, %S\n", "World!")
    +Hello, World!
    +14
    +>>> printf(b"%d bottles of beer\n", 42)
    +42 bottles of beer
    +19
    +>>> printf(b"%f bottles of beer\n", 42.5)
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +ArgumentError: argument 2: exceptions.TypeError: Don't know how to convert parameter 2
    +>>>
    +
    +
    +

    As has been mentioned before, all Python types except integers, strings, and +bytes objects have to be wrapped in their corresponding ctypes type, so +that they can be converted to the required C data type:

    +
    >>> printf(b"An int %d, a double %f\n", 1234, c_double(3.14))
    +An int 1234, a double 3.140000
    +31
    +>>>
    +
    +
    +
    +
    +

    Calling functions with your own custom data types

    +

    You can also customize ctypes argument conversion to allow instances of +your own classes be used as function arguments. ctypes looks for an +_as_parameter_ attribute and uses this as the function argument. Of +course, it must be one of integer, string, or bytes:

    +
    >>> class Bottles:
    +...     def __init__(self, number):
    +...         self._as_parameter_ = number
    +...
    +>>> bottles = Bottles(42)
    +>>> printf(b"%d bottles of beer\n", bottles)
    +42 bottles of beer
    +19
    +>>>
    +
    +
    +

    If you don’t want to store the instance’s data in the _as_parameter_ +instance variable, you could define a property which makes the +attribute available on request.

    +
    +
    +

    Specifying the required argument types (function prototypes)

    +

    It is possible to specify the required argument types of functions exported from +DLLs by setting the argtypes attribute.

    +

    argtypes must be a sequence of C data types (the printf function is +probably not a good example here, because it takes a variable number and +different types of parameters depending on the format string, on the other hand +this is quite handy to experiment with this feature):

    +
    >>> printf.argtypes = [c_char_p, c_char_p, c_int, c_double]
    +>>> printf(b"String '%s', Int %d, Double %f\n", b"Hi", 10, 2.2)
    +String 'Hi', Int 10, Double 2.200000
    +37
    +>>>
    +
    +
    +

    Specifying a format protects against incompatible argument types (just as a +prototype for a C function), and tries to convert the arguments to valid types:

    +
    >>> printf(b"%d %d %d", 1, 2, 3)
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +ArgumentError: argument 2: exceptions.TypeError: wrong type
    +>>> printf(b"%s %d %f\n", b"X", 2, 3)
    +X 2 3.000000
    +13
    +>>>
    +
    +
    +

    If you have defined your own classes which you pass to function calls, you have +to implement a from_param() class method for them to be able to use them +in the argtypes sequence. The from_param() class method receives +the Python object passed to the function call, it should do a typecheck or +whatever is needed to make sure this object is acceptable, and then return the +object itself, its _as_parameter_ attribute, or whatever you want to +pass as the C function argument in this case. Again, the result should be an +integer, string, bytes, a ctypes instance, or an object with an +_as_parameter_ attribute.

    +
    +
    +

    Return types

    +

    By default functions are assumed to return the C int type. Other +return types can be specified by setting the restype attribute of the +function object.

    +

    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"))  
    +8059983
    +>>> 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")))
    +None
    +>>>
    +
    +
    +

    If you want to avoid the ord("x") calls above, you can set the +argtypes attribute, and the second argument will be converted from a +single character Python bytes object into a C char:

    +
    >>> strchr.restype = c_char_p
    +>>> strchr.argtypes = [c_char_p, c_char]
    +>>> strchr(b"abcdef", b"d")
    +'def'
    +>>> strchr(b"abcdef", b"def")
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +ArgumentError: argument 2: exceptions.TypeError: one character string expected
    +>>> print(strchr(b"abcdef", b"x"))
    +None
    +>>> strchr(b"abcdef", b"d")
    +'def'
    +>>>
    +
    +
    +

    You can also use a callable Python object (a function or a class for example) as +the restype attribute, if the foreign function returns an integer. The +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  
    +>>> def ValidHandle(value):
    +...     if value == 0:
    +...         raise WinError()
    +...     return value
    +...
    +>>>
    +>>> GetModuleHandle.restype = ValidHandle  
    +>>> GetModuleHandle(None)  
    +486539264
    +>>> GetModuleHandle("something silly")  
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +  File "<stdin>", line 3, in ValidHandle
    +OSError: [Errno 126] The specified module could not be found.
    +>>>
    +
    +
    +

    WinError is a function which will call Windows FormatMessage() api to +get the string representation of an error code, and returns an exception. +WinError takes an optional error code parameter, if no one is used, it calls +GetLastError() to retrieve it.

    +

    Please note that a much more powerful error checking mechanism is available +through the errcheck attribute; see the reference manual for details.

    +
    +
    +

    Passing pointers (or: passing parameters by reference)

    +

    Sometimes a C api function expects a pointer to a data type as parameter, +probably to write into the corresponding location, or if the data is too large +to be passed by value. This is also known as passing parameters by reference.

    +

    ctypes exports the byref() function which is used to pass parameters +by reference. The same effect can be achieved with the pointer() function, +although pointer() does a lot more work since it constructs a real pointer +object, so it is faster to use byref() if you don’t need the pointer +object in Python itself:

    +
    >>> i = c_int()
    +>>> f = c_float()
    +>>> s = create_string_buffer(b'\000' * 32)
    +>>> print(i.value, f.value, repr(s.value))
    +0 0.0 b''
    +>>> libc.sscanf(b"1 3.14 Hello", b"%d %f %s",
    +...             byref(i), byref(f), s)
    +3
    +>>> print(i.value, f.value, repr(s.value))
    +1 3.1400001049 b'Hello'
    +>>>
    +
    +
    +
    +
    +

    Structures and unions

    +

    Structures and unions must derive from the Structure and Union +base classes which are defined in the ctypes module. Each subclass must +define a _fields_ attribute. _fields_ must be a list of +2-tuples, containing a field name and a field type.

    +

    The field type must be a ctypes type like c_int, or any other +derived ctypes type: structure, union, array, pointer.

    +

    Here is a simple example of a POINT structure, which contains two integers named +x and y, and also shows how to initialize a structure in the constructor:

    +
    >>> from ctypes import *
    +>>> class POINT(Structure):
    +...     _fields_ = [("x", c_int),
    +...                 ("y", c_int)]
    +...
    +>>> point = POINT(10, 20)
    +>>> print(point.x, point.y)
    +10 20
    +>>> point = POINT(y=5)
    +>>> print(point.x, point.y)
    +0 5
    +>>> POINT(1, 2, 3)
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +TypeError: too many initializers
    +>>>
    +
    +
    +

    You can, however, build much more complicated structures. A structure can +itself contain other structures by using a structure as a field type.

    +

    Here is a RECT structure which contains two POINTs named upperleft and +lowerright:

    +
    >>> class RECT(Structure):
    +...     _fields_ = [("upperleft", POINT),
    +...                 ("lowerright", POINT)]
    +...
    +>>> rc = RECT(point)
    +>>> print(rc.upperleft.x, rc.upperleft.y)
    +0 5
    +>>> print(rc.lowerright.x, rc.lowerright.y)
    +0 0
    +>>>
    +
    +
    +

    Nested structures can also be initialized in the constructor in several ways:

    +
    >>> r = RECT(POINT(1, 2), POINT(3, 4))
    +>>> r = RECT((1, 2), (3, 4))
    +
    +
    +

    Field descriptors can be retrieved from the class, they are useful +for debugging because they can provide useful information:

    +
    >>> print(POINT.x)
    +<Field type=c_long, ofs=0, size=4>
    +>>> print(POINT.y)
    +<Field type=c_long, ofs=4, size=4>
    +>>>
    +
    +
    +
    +

    Warning

    +

    ctypes does not support passing unions or structures with bit-fields +to functions by value. While this may work on 32-bit x86, it’s not +guaranteed by the library to work in the general case. Unions and +structures with bit-fields should always be passed to functions by pointer.

    +
    +
    +
    +

    Structure/union alignment and byte order

    +

    By default, Structure and Union fields are aligned in the same way the C +compiler does it. It is possible to override this behavior be specifying a +_pack_ class attribute in the subclass definition. This must be set to a +positive integer and specifies the maximum alignment for the fields. This is +what #pragma pack(n) also does in MSVC.

    +

    ctypes uses the native byte order for Structures and Unions. To build +structures with non-native byte order, you can use one of the +BigEndianStructure, LittleEndianStructure, +BigEndianUnion, and LittleEndianUnion base classes. These +classes cannot contain pointer fields.

    +
    +
    +

    Bit fields in structures and unions

    +

    It is possible to create structures and unions containing bit fields. Bit fields +are only possible for integer fields, the bit width is specified as the third +item in the _fields_ tuples:

    +
    >>> class Int(Structure):
    +...     _fields_ = [("first_16", c_int, 16),
    +...                 ("second_16", c_int, 16)]
    +...
    +>>> print(Int.first_16)
    +<Field type=c_long, ofs=0:0, bits=16>
    +>>> print(Int.second_16)
    +<Field type=c_long, ofs=0:16, bits=16>
    +>>>
    +
    +
    +
    +
    +

    Arrays

    +

    Arrays are sequences, containing a fixed number of instances of the same type.

    +

    The recommended way to create array types is by multiplying a data type with a +positive integer:

    +
    TenPointsArrayType = POINT * 10
    +
    +
    +

    Here is an example of a somewhat artificial data type, a structure containing 4 +POINTs among other stuff:

    +
    >>> from ctypes import *
    +>>> class POINT(Structure):
    +...     _fields_ = ("x", c_int), ("y", c_int)
    +...
    +>>> class MyStruct(Structure):
    +...     _fields_ = [("a", c_int),
    +...                 ("b", c_float),
    +...                 ("point_array", POINT * 4)]
    +>>>
    +>>> print(len(MyStruct().point_array))
    +4
    +>>>
    +
    +
    +

    Instances are created in the usual way, by calling the class:

    +
    arr = TenPointsArrayType()
    +for pt in arr:
    +    print(pt.x, pt.y)
    +
    +
    +

    The above code print a series of 0 0 lines, because the array contents is +initialized to zeros.

    +

    Initializers of the correct type can also be specified:

    +
    >>> from ctypes import *
    +>>> TenIntegers = c_int * 10
    +>>> ii = TenIntegers(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)
    +>>> print(ii)
    +<c_long_Array_10 object at 0x...>
    +>>> for i in ii: print(i, end=" ")
    +...
    +1 2 3 4 5 6 7 8 9 10
    +>>>
    +
    +
    +
    +
    +

    Pointers

    +

    Pointer instances are created by calling the pointer() function on a +ctypes type:

    +
    >>> from ctypes import *
    +>>> i = c_int(42)
    +>>> pi = pointer(i)
    +>>>
    +
    +
    +

    Pointer instances have a contents attribute which +returns the object to which the pointer points, the i object above:

    +
    >>> pi.contents
    +c_long(42)
    +>>>
    +
    +
    +

    Note that ctypes does not have OOR (original object return), it constructs a +new, equivalent object each time you retrieve an attribute:

    +
    >>> pi.contents is i
    +False
    +>>> pi.contents is pi.contents
    +False
    +>>>
    +
    +
    +

    Assigning another c_int instance to the pointer’s contents attribute +would cause the pointer to point to the memory location where this is stored:

    +
    >>> i = c_int(99)
    +>>> pi.contents = i
    +>>> pi.contents
    +c_long(99)
    +>>>
    +
    +
    +

    Pointer instances can also be indexed with integers:

    +
    >>> pi[0]
    +99
    +>>>
    +
    +
    +

    Assigning to an integer index changes the pointed to value:

    +
    >>> print(i)
    +c_long(99)
    +>>> pi[0] = 22
    +>>> print(i)
    +c_long(22)
    +>>>
    +
    +
    +

    It is also possible to use indexes different from 0, but you must know what +you’re doing, just as in C: You can access or change arbitrary memory locations. +Generally you only use this feature if you receive a pointer from a C function, +and you know that the pointer actually points to an array instead of a single +item.

    +

    Behind the scenes, the pointer() function does more than simply create +pointer instances, it has to create pointer types first. This is done with the +POINTER() function, which accepts any ctypes type, and returns a +new type:

    +
    >>> PI = POINTER(c_int)
    +>>> PI
    +<class 'ctypes.LP_c_long'>
    +>>> PI(42)
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +TypeError: expected c_long instead of int
    +>>> PI(c_int(42))
    +<ctypes.LP_c_long object at 0x...>
    +>>>
    +
    +
    +

    Calling the pointer type without an argument creates a NULL pointer. +NULL pointers have a False boolean value:

    +
    >>> null_ptr = POINTER(c_int)()
    +>>> print(bool(null_ptr))
    +False
    +>>>
    +
    +
    +

    ctypes checks for NULL when dereferencing pointers (but dereferencing +invalid non-NULL pointers would crash Python):

    +
    >>> null_ptr[0]
    +Traceback (most recent call last):
    +    ....
    +ValueError: NULL pointer access
    +>>>
    +
    +>>> null_ptr[0] = 1234
    +Traceback (most recent call last):
    +    ....
    +ValueError: NULL pointer access
    +>>>
    +
    +
    +
    +
    +

    Type conversions

    +

    Usually, ctypes does strict type checking. This means, if you have +POINTER(c_int) in the argtypes list of a function or as the type of +a member field in a structure definition, only instances of exactly the same +type are accepted. There are some exceptions to this rule, where ctypes accepts +other objects. For example, you can pass compatible array instances instead of +pointer types. So, for POINTER(c_int), ctypes accepts an array of c_int:

    +
    >>> class Bar(Structure):
    +...     _fields_ = [("count", c_int), ("values", POINTER(c_int))]
    +...
    +>>> bar = Bar()
    +>>> bar.values = (c_int * 3)(1, 2, 3)
    +>>> bar.count = 3
    +>>> for i in range(bar.count):
    +...     print(bar.values[i])
    +...
    +1
    +2
    +3
    +>>>
    +
    +
    +

    In addition, if a function argument is explicitly declared to be a pointer type +(such as POINTER(c_int)) in argtypes, an object of the pointed +type (c_int in this case) can be passed to the function. ctypes will apply +the required byref() conversion in this case automatically.

    +

    To set a POINTER type field to NULL, you can assign None:

    +
    >>> bar.values = None
    +>>>
    +
    +
    +

    Sometimes you have instances of incompatible types. In C, you can cast one type +into another type. ctypes provides a cast() function which can be +used in the same way. The Bar structure defined above accepts +POINTER(c_int) pointers or c_int arrays for its values field, +but not instances of other types:

    +
    >>> bar.values = (c_byte * 4)()
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +TypeError: incompatible types, c_byte_Array_4 instance instead of LP_c_long instance
    +>>>
    +
    +
    +

    For these cases, the cast() function is handy.

    +

    The cast() function can be used to cast a ctypes instance into a pointer +to a different ctypes data type. cast() takes two parameters, a ctypes +object that is or can be converted to a pointer of some kind, and a ctypes +pointer type. It returns an instance of the second argument, which references +the same memory block as the first argument:

    +
    >>> a = (c_byte * 4)()
    +>>> cast(a, POINTER(c_int))
    +<ctypes.LP_c_long object at ...>
    +>>>
    +
    +
    +

    So, cast() can be used to assign to the values field of Bar the +structure:

    +
    >>> bar = Bar()
    +>>> bar.values = cast((c_byte * 4)(), POINTER(c_int))
    +>>> print(bar.values[0])
    +0
    +>>>
    +
    +
    +
    +
    +

    Incomplete Types

    +

    Incomplete Types are structures, unions or arrays whose members are not yet +specified. In C, they are specified by forward declarations, which are defined +later:

    +
    struct cell; /* forward declaration */
    +
    +struct cell {
    +    char *name;
    +    struct cell *next;
    +};
    +
    +
    +

    The straightforward translation into ctypes code would be this, but it does not +work:

    +
    >>> class cell(Structure):
    +...     _fields_ = [("name", c_char_p),
    +...                 ("next", POINTER(cell))]
    +...
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +  File "<stdin>", line 2, in cell
    +NameError: name 'cell' is not defined
    +>>>
    +
    +
    +

    because the new class cell is not available in the class statement itself. +In ctypes, we can define the cell class and set the _fields_ +attribute later, after the class statement:

    +
    >>> from ctypes import *
    +>>> class cell(Structure):
    +...     pass
    +...
    +>>> cell._fields_ = [("name", c_char_p),
    +...                  ("next", POINTER(cell))]
    +>>>
    +
    +
    +

    Lets try it. We create two instances of cell, and let them point to each +other, and finally follow the pointer chain a few times:

    +
    >>> c1 = cell()
    +>>> c1.name = "foo"
    +>>> c2 = cell()
    +>>> c2.name = "bar"
    +>>> c1.next = pointer(c2)
    +>>> c2.next = pointer(c1)
    +>>> p = c1
    +>>> for i in range(8):
    +...     print(p.name, end=" ")
    +...     p = p.next[0]
    +...
    +foo bar foo bar foo bar foo bar
    +>>>
    +
    +
    +
    +
    +

    Callback functions

    +

    ctypes allows creating C callable function pointers from Python callables. +These are sometimes called callback functions.

    +

    First, you must create a class for the callback function. The class knows the +calling convention, the return type, and the number and types of arguments this +function will receive.

    +

    The CFUNCTYPE() factory function creates types for callback functions +using the cdecl calling convention. On Windows, the WINFUNCTYPE() +factory function creates types for callback functions using the stdcall +calling convention.

    +

    Both of these factory functions are called with the result type as first +argument, and the callback functions expected argument types as the remaining +arguments.

    +

    I will present an example here which uses the standard C library’s +qsort() function, that is used to sort items with the help of a callback +function. qsort() will be used to sort an array of integers:

    +
    >>> IntArray5 = c_int * 5
    +>>> ia = IntArray5(5, 1, 7, 33, 99)
    +>>> qsort = libc.qsort
    +>>> qsort.restype = None
    +>>>
    +
    +
    +

    qsort() must be called with a pointer to the data to sort, the number of +items in the data array, the size of one item, and a pointer to the comparison +function, the callback. The callback will then be called with two pointers to +items, and it must return a negative integer if the first item is smaller than +the second, a zero if they are equal, and a positive integer otherwise.

    +

    So our callback function receives pointers to integers, and must return an +integer. First we create the type for the callback function:

    +
    >>> CMPFUNC = CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int))
    +>>>
    +
    +
    +

    To get started, here is a simple callback that shows the values it gets +passed:

    +
    >>> def py_cmp_func(a, b):
    +...     print("py_cmp_func", a[0], b[0])
    +...     return 0
    +...
    +>>> cmp_func = CMPFUNC(py_cmp_func)
    +>>>
    +
    +
    +

    The result:

    +
    >>> qsort(ia, len(ia), sizeof(c_int), cmp_func)  
    +py_cmp_func 5 1
    +py_cmp_func 33 99
    +py_cmp_func 7 33
    +py_cmp_func 5 7
    +py_cmp_func 1 7
    +>>>
    +
    +
    +

    Now we can actually compare the two items and return a useful result:

    +
    >>> def py_cmp_func(a, b):
    +...     print("py_cmp_func", a[0], b[0])
    +...     return a[0] - b[0]
    +...
    +>>>
    +>>> qsort(ia, len(ia), sizeof(c_int), CMPFUNC(py_cmp_func)) 
    +py_cmp_func 5 1
    +py_cmp_func 33 99
    +py_cmp_func 7 33
    +py_cmp_func 1 7
    +py_cmp_func 5 7
    +>>>
    +
    +
    +

    As we can easily check, our array is sorted now:

    +
    >>> for i in ia: print(i, end=" ")
    +...
    +1 5 7 33 99
    +>>>
    +
    +
    +

    The function factories can be used as decorator factories, so we may as well +write:

    +
    >>> @CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int))
    +... def py_cmp_func(a, b):
    +...     print("py_cmp_func", a[0], b[0])
    +...     return a[0] - b[0]
    +...
    +>>> qsort(ia, len(ia), sizeof(c_int), py_cmp_func)
    +py_cmp_func 5 1
    +py_cmp_func 33 99
    +py_cmp_func 7 33
    +py_cmp_func 1 7
    +py_cmp_func 5 7
    +>>>
    +
    +
    +
    +

    Note

    +

    Make sure you keep references to CFUNCTYPE() objects as long as they +are used from C code. ctypes doesn’t, and if you don’t, they may be +garbage collected, crashing your program when a callback is made.

    +

    Also, note that if the callback function is called in a thread created +outside of Python’s control (e.g. by the foreign code that calls the +callback), ctypes creates a new dummy Python thread on every invocation. This +behavior is correct for most purposes, but it means that values stored with +threading.local will not survive across different callbacks, even when +those calls are made from the same C thread.

    +
    +
    +
    +

    Accessing values exported from dlls

    +

    Some shared libraries not only export functions, they also export variables. An +example in the Python library itself is the Py_OptimizeFlag, an integer +set to 0, 1, or 2, depending on the -O or -OO flag given on +startup.

    +

    ctypes can access values like this with the in_dll() class methods of +the type. pythonapi is a predefined symbol giving access to the Python C +api:

    +
    >>> opt_flag = c_int.in_dll(pythonapi, "Py_OptimizeFlag")
    +>>> print(opt_flag)
    +c_long(0)
    +>>>
    +
    +
    +

    If the interpreter would have been started with -O, the sample would +have printed c_long(1), or c_long(2) if -OO would have been +specified.

    +

    An extended example which also demonstrates the use of pointers accesses the +PyImport_FrozenModules pointer exported by Python.

    +

    Quoting the docs for that value:

    +
    +

    This pointer is initialized to point to an array of struct _frozen +records, terminated by one whose members are all NULL or zero. When a frozen +module is imported, it is searched in this table. Third-party code could play +tricks with this to provide a dynamically created collection of frozen modules.

    +
    +

    So manipulating this pointer could even prove useful. To restrict the example +size, we show only how this table can be read with ctypes:

    +
    >>> from ctypes import *
    +>>>
    +>>> class struct_frozen(Structure):
    +...     _fields_ = [("name", c_char_p),
    +...                 ("code", POINTER(c_ubyte)),
    +...                 ("size", c_int)]
    +...
    +>>>
    +
    +
    +

    We have defined the struct _frozen data type, so we can get the pointer +to the table:

    +
    >>> FrozenTable = POINTER(struct_frozen)
    +>>> table = FrozenTable.in_dll(pythonapi, "PyImport_FrozenModules")
    +>>>
    +
    +
    +

    Since table is a pointer to the array of struct_frozen records, we +can iterate over it, but we just have to make sure that our loop terminates, +because pointers have no size. Sooner or later it would probably crash with an +access violation or whatever, so it’s better to break out of the loop when we +hit the NULL entry:

    +
    >>> for item in table:
    +...     if item.name is None:
    +...         break
    +...     print(item.name.decode("ascii"), item.size)
    +...
    +_frozen_importlib 31764
    +_frozen_importlib_external 41499
    +__hello__ 161
    +__phello__ -161
    +__phello__.spam 161
    +>>>
    +
    +
    +

    The fact that standard Python has a frozen module and a frozen package +(indicated by the negative size member) is not well known, it is only used for +testing. Try it out with import __hello__ for example.

    +
    +
    +

    Surprises

    +

    There are some edges in ctypes where you might expect something other +than what actually happens.

    +

    Consider the following example:

    +
    >>> from ctypes import *
    +>>> class POINT(Structure):
    +...     _fields_ = ("x", c_int), ("y", c_int)
    +...
    +>>> class RECT(Structure):
    +...     _fields_ = ("a", POINT), ("b", POINT)
    +...
    +>>> p1 = POINT(1, 2)
    +>>> p2 = POINT(3, 4)
    +>>> rc = RECT(p1, p2)
    +>>> print(rc.a.x, rc.a.y, rc.b.x, rc.b.y)
    +1 2 3 4
    +>>> # now swap the two points
    +>>> rc.a, rc.b = rc.b, rc.a
    +>>> print(rc.a.x, rc.a.y, rc.b.x, rc.b.y)
    +3 4 3 4
    +>>>
    +
    +
    +

    Hm. We certainly expected the last statement to print 3 4 1 2. What +happened? Here are the steps of the rc.a, rc.b = rc.b, rc.a line above:

    +
    >>> temp0, temp1 = rc.b, rc.a
    +>>> rc.a = temp0
    +>>> rc.b = temp1
    +>>>
    +
    +
    +

    Note that temp0 and temp1 are objects still using the internal buffer of +the rc object above. So executing rc.a = temp0 copies the buffer +contents of temp0 into rc ‘s buffer. This, in turn, changes the +contents of temp1. So, the last assignment rc.b = temp1, doesn’t have +the expected effect.

    +

    Keep in mind that retrieving sub-objects from Structure, Unions, and Arrays +doesn’t copy the sub-object, instead it retrieves a wrapper object accessing +the root-object’s underlying buffer.

    +

    Another example that may behave different from what one would expect is this:

    +
    >>> s = c_char_p()
    +>>> s.value = "abc def ghi"
    +>>> s.value
    +'abc def ghi'
    +>>> s.value is s.value
    +False
    +>>>
    +
    +
    +

    Why is it printing False? ctypes instances are objects containing a memory +block plus some descriptors accessing the contents of the memory. +Storing a Python object in the memory block does not store the object itself, +instead the contents of the object is stored. Accessing the contents again +constructs a new Python object each time!

    +
    +
    +

    Variable-sized data types

    +

    ctypes provides some support for variable-sized arrays and structures.

    +

    The resize() function can be used to resize the memory buffer of an +existing ctypes object. The function takes the object as first argument, and +the requested size in bytes as the second argument. The memory block cannot be +made smaller than the natural memory block specified by the objects type, a +ValueError is raised if this is tried:

    +
    >>> short_array = (c_short * 4)()
    +>>> print(sizeof(short_array))
    +8
    +>>> resize(short_array, 4)
    +Traceback (most recent call last):
    +    ...
    +ValueError: minimum size is 8
    +>>> resize(short_array, 32)
    +>>> sizeof(short_array)
    +32
    +>>> sizeof(type(short_array))
    +8
    +>>>
    +
    +
    +

    This is nice and fine, but how would one access the additional elements +contained in this array? Since the type still only knows about 4 elements, we +get errors accessing other elements:

    +
    >>> short_array[:]
    +[0, 0, 0, 0]
    +>>> short_array[7]
    +Traceback (most recent call last):
    +    ...
    +IndexError: invalid index
    +>>>
    +
    +
    +

    Another way to use variable-sized data types with ctypes is to use the +dynamic nature of Python, and (re-)define the data type after the required size +is already known, on a case by case basis.

    +
    +
    +
    +

    ctypes reference

    +
    +

    Finding shared libraries

    +

    When programming in a compiled language, shared libraries are accessed when +compiling/linking a program, and when the program is run.

    +

    The purpose of the find_library() function is to locate a library in a way +similar to what the compiler or runtime loader does (on platforms with several +versions of a shared library the most recent should be loaded), while the ctypes +library loaders act like when a program is run, and call the runtime loader +directly.

    +

    The ctypes.util module provides a function which can help to determine +the library to load.

    +
    +
    +ctypes.util.find_library(name)
    +

    Try to find a library and return a pathname. name is the library name without +any prefix like lib, suffix like .so, .dylib or version number (this +is the form used for the posix linker option -l). If no library can +be found, returns None.

    +
    + +

    The exact functionality is system dependent.

    +

    On Linux, find_library() tries to run external programs +(/sbin/ldconfig, gcc, objdump and ld) to find the library file. +It returns the filename of the library file.

    +
    +

    Changed in version 3.6: On Linux, the value of the environment variable LD_LIBRARY_PATH is used +when searching for libraries, if a library cannot be found by any other means.

    +
    +

    Here are some examples:

    +
    >>> from ctypes.util import find_library
    +>>> find_library("m")
    +'libm.so.6'
    +>>> find_library("c")
    +'libc.so.6'
    +>>> find_library("bz2")
    +'libbz2.so.1.0'
    +>>>
    +
    +
    +

    On OS X, find_library() tries several predefined naming schemes and paths +to locate the library, and returns a full pathname if successful:

    +
    >>> from ctypes.util import find_library
    +>>> find_library("c")
    +'/usr/lib/libc.dylib'
    +>>> find_library("m")
    +'/usr/lib/libm.dylib'
    +>>> find_library("bz2")
    +'/usr/lib/libbz2.dylib'
    +>>> find_library("AGL")
    +'/System/Library/Frameworks/AGL.framework/AGL'
    +>>>
    +
    +
    +

    On Windows, find_library() searches along the system search path, and +returns the full pathname, but since there is no predefined naming scheme a call +like find_library("c") will fail and return None.

    +

    If wrapping a shared library with ctypes, it may be better to determine +the shared library name at development time, and hardcode that into the wrapper +module instead of using find_library() to locate the library at runtime.

    +
    +
    +

    Loading shared libraries

    +

    There are several ways to load shared libraries into the Python process. One +way is to instantiate one of the following classes:

    +
    +
    +class ctypes.CDLL(name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False)
    +

    Instances of this class represent loaded shared libraries. Functions in these +libraries use the standard C calling convention, and are assumed to return +int.

    +
    + +
    +
    +class ctypes.OleDLL(name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False)
    +

    Windows only: Instances of this class represent loaded shared libraries, +functions in these libraries use the stdcall calling convention, and are +assumed to return the windows specific HRESULT code. HRESULT +values contain information specifying whether the function call failed or +succeeded, together with additional error code. If the return value signals a +failure, an OSError is automatically raised.

    +
    +

    Changed in version 3.3: WindowsError used to be raised.

    +
    +
    + +
    +
    +class ctypes.WinDLL(name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False)
    +

    Windows only: Instances of this class represent loaded shared libraries, +functions in these libraries use the stdcall calling convention, and are +assumed to return int by default.

    +

    On Windows CE only the standard calling convention is used, for convenience the +WinDLL and OleDLL use the standard calling convention on this +platform.

    +
    + +

    The Python global interpreter lock is released before calling any +function exported by these libraries, and reacquired afterwards.

    +
    +
    +class ctypes.PyDLL(name, mode=DEFAULT_MODE, handle=None)
    +

    Instances of this class behave like CDLL instances, except that the +Python GIL is not released during the function call, and after the function +execution the Python error flag is checked. If the error flag is set, a Python +exception is raised.

    +

    Thus, this is only useful to call Python C api functions directly.

    +
    + +

    All these classes can be instantiated by calling them with at least one +argument, the pathname of the shared library. If you have an existing handle to +an already loaded shared library, it can be passed as the handle named +parameter, otherwise the underlying platforms dlopen or LoadLibrary +function is used to load the library into the process, and to get a handle to +it.

    +

    The mode parameter can be used to specify how the library is loaded. For +details, consult the dlopen(3) manpage. On Windows, mode is +ignored. On posix systems, RTLD_NOW is always added, and is not +configurable.

    +

    The use_errno parameter, when set to true, enables a ctypes mechanism that +allows accessing the system errno error number in a safe way. +ctypes maintains a thread-local copy of the systems errno +variable; if you call foreign functions created with use_errno=True then the +errno value before the function call is swapped with the ctypes private +copy, the same happens immediately after the function call.

    +

    The function ctypes.get_errno() returns the value of the ctypes private +copy, and the function ctypes.set_errno() changes the ctypes private copy +to a new value and returns the former value.

    +

    The use_last_error parameter, when set to true, enables the same mechanism for +the Windows error code which is managed by the GetLastError() and +SetLastError() Windows API functions; ctypes.get_last_error() and +ctypes.set_last_error() are used to request and change the ctypes private +copy of the windows error code.

    +
    +
    +ctypes.RTLD_GLOBAL
    +

    Flag to use as mode parameter. On platforms where this flag is not available, +it is defined as the integer zero.

    +
    + +
    +
    +ctypes.RTLD_LOCAL
    +

    Flag to use as mode parameter. On platforms where this is not available, it +is the same as RTLD_GLOBAL.

    +
    + +
    +
    +ctypes.DEFAULT_MODE
    +

    The default mode which is used to load shared libraries. On OSX 10.3, this is +RTLD_GLOBAL, otherwise it is the same as RTLD_LOCAL.

    +
    + +

    Instances of these classes have no public methods. Functions exported by the +shared library can be accessed as attributes or by index. Please note that +accessing the function through an attribute caches the result and therefore +accessing it repeatedly returns the same object each time. On the other hand, +accessing it through an index returns a new object each time:

    +
    >>> from ctypes import CDLL
    +>>> libc = CDLL("libc.so.6")  # On Linux
    +>>> libc.time == libc.time
    +True
    +>>> libc['time'] == libc['time']
    +False
    +
    +
    +

    The following public attributes are available, their name starts with an +underscore to not clash with exported function names:

    +
    +
    +PyDLL._handle
    +

    The system handle used to access the library.

    +
    + +
    +
    +PyDLL._name
    +

    The name of the library passed in the constructor.

    +
    + +

    Shared libraries can also be loaded by using one of the prefabricated objects, +which are instances of the LibraryLoader class, either by calling the +LoadLibrary() method, or by retrieving the library as attribute of the +loader instance.

    +
    +
    +class ctypes.LibraryLoader(dlltype)
    +

    Class which loads shared libraries. dlltype should be one of the +CDLL, PyDLL, WinDLL, or OleDLL types.

    +

    __getattr__() has special behavior: It allows loading a shared library by +accessing it as attribute of a library loader instance. The result is cached, +so repeated attribute accesses return the same library each time.

    +
    +
    +LoadLibrary(name)
    +

    Load a shared library into the process and return it. This method always +returns a new instance of the library.

    +
    + +
    + +

    These prefabricated library loaders are available:

    +
    +
    +ctypes.cdll
    +

    Creates CDLL instances.

    +
    + +
    +
    +ctypes.windll
    +

    Windows only: Creates WinDLL instances.

    +
    + +
    +
    +ctypes.oledll
    +

    Windows only: Creates OleDLL instances.

    +
    + +
    +
    +ctypes.pydll
    +

    Creates PyDLL instances.

    +
    + +

    For accessing the C Python api directly, a ready-to-use Python shared library +object is available:

    +
    +
    +ctypes.pythonapi
    +

    An instance of PyDLL that exposes Python C API functions as +attributes. Note that all these functions are assumed to return C +int, which is of course not always the truth, so you have to assign +the correct restype attribute to use these functions.

    +
    + +
    +
    +

    Foreign functions

    +

    As explained in the previous section, foreign functions can be accessed as +attributes of loaded shared libraries. The function objects created in this way +by default accept any number of arguments, accept any ctypes data instances as +arguments, and return the default result type specified by the library loader. +They are instances of a private class:

    +
    +
    +class ctypes._FuncPtr
    +

    Base class for C callable foreign functions.

    +

    Instances of foreign functions are also C compatible data types; they +represent C function pointers.

    +

    This behavior can be customized by assigning to special attributes of the +foreign function object.

    +
    +
    +restype
    +

    Assign a ctypes type to specify the result type of the foreign function. +Use None for void, a function not returning anything.

    +

    It is possible to assign a callable Python object that is not a ctypes +type, in this case the function is assumed to return a C int, and +the callable will be called with this integer, allowing further +processing or error checking. Using this is deprecated, for more flexible +post processing or error checking use a ctypes data type as +restype and assign a callable to the errcheck attribute.

    +
    + +
    +
    +argtypes
    +

    Assign a tuple of ctypes types to specify the argument types that the +function accepts. Functions using the stdcall calling convention can +only be called with the same number of arguments as the length of this +tuple; functions using the C calling convention accept additional, +unspecified arguments as well.

    +

    When a foreign function is called, each actual argument is passed to the +from_param() class method of the items in the argtypes +tuple, this method allows adapting the actual argument to an object that +the foreign function accepts. For example, a c_char_p item in +the argtypes tuple will convert a string passed as argument into +a bytes object using ctypes conversion rules.

    +

    New: It is now possible to put items in argtypes which are not ctypes +types, but each item must have a from_param() method which returns a +value usable as argument (integer, string, ctypes instance). This allows +defining adapters that can adapt custom objects as function parameters.

    +
    + +
    +
    +errcheck
    +

    Assign a Python function or another callable to this attribute. The +callable will be called with three or more arguments:

    +
    +
    +callable(result, func, arguments)
    +

    result is what the foreign function returns, as specified by the +restype attribute.

    +

    func is the foreign function object itself, this allows reusing the +same callable object to check or post process the results of several +functions.

    +

    arguments is a tuple containing the parameters originally passed to +the function call, this allows specializing the behavior on the +arguments used.

    +
    + +

    The object that this function returns will be returned from the +foreign function call, but it can also check the result value +and raise an exception if the foreign function call failed.

    +
    + +
    + +
    +
    +exception ctypes.ArgumentError
    +

    This exception is raised when a foreign function call cannot convert one of the +passed arguments.

    +
    + +
    +
    +

    Function prototypes

    +

    Foreign functions can also be created by instantiating function prototypes. +Function prototypes are similar to function prototypes in C; they describe a +function (return type, argument types, calling convention) without defining an +implementation. The factory functions must be called with the desired result +type and the argument types of the function, and can be used as decorator +factories, and as such, be applied to functions through the @wrapper syntax. +See Callback functions for examples.

    +
    +
    +ctypes.CFUNCTYPE(restype, *argtypes, use_errno=False, use_last_error=False)
    +

    The returned function prototype creates functions that use the standard C +calling convention. The function will release the GIL during the call. If +use_errno is set to true, the ctypes private copy of the system +errno variable is exchanged with the real errno value before +and after the call; use_last_error does the same for the Windows error +code.

    +
    + +
    +
    +ctypes.WINFUNCTYPE(restype, *argtypes, use_errno=False, use_last_error=False)
    +

    Windows only: The returned function prototype creates functions that use the +stdcall calling convention, except on Windows CE where +WINFUNCTYPE() is the same as CFUNCTYPE(). The function will +release the GIL during the call. use_errno and use_last_error have the +same meaning as above.

    +
    + +
    +
    +ctypes.PYFUNCTYPE(restype, *argtypes)
    +

    The returned function prototype creates functions that use the Python calling +convention. The function will not release the GIL during the call.

    +
    + +

    Function prototypes created by these factory functions can be instantiated in +different ways, depending on the type and number of the parameters in the call:

    +
    +
    +
    +prototype(address)
    +

    Returns a foreign function at the specified address which must be an integer.

    +
    + +
    +
    +prototype(callable)
    +

    Create a C callable function (a callback function) from a Python callable.

    +
    + +
    +
    +prototype(func_spec[, paramflags])
    +

    Returns a foreign function exported by a shared library. func_spec must +be a 2-tuple (name_or_ordinal, library). The first item is the name of +the exported function as string, or the ordinal of the exported function +as small integer. The second item is the shared library instance.

    +
    + +
    +
    +prototype(vtbl_index, name[, paramflags[, iid]])
    +

    Returns a foreign function that will call a COM method. vtbl_index is +the index into the virtual function table, a small non-negative +integer. name is name of the COM method. iid is an optional pointer to +the interface identifier which is used in extended error reporting.

    +

    COM methods use a special calling convention: They require a pointer to +the COM interface as first argument, in addition to those parameters that +are specified in the argtypes tuple.

    +
    + +

    The optional paramflags parameter creates foreign function wrappers with much +more functionality than the features described above.

    +

    paramflags must be a tuple of the same length as argtypes.

    +

    Each item in this tuple contains further information about a parameter, it must +be a tuple containing one, two, or three items.

    +

    The first item is an integer containing a combination of direction +flags for the parameter:

    +
    +
    +
    1

    Specifies an input parameter to the function.

    +
    +
    2

    Output parameter. The foreign function fills in a value.

    +
    +
    4

    Input parameter which defaults to the integer zero.

    +
    +
    +
    +

    The optional second item is the parameter name as string. If this is specified, +the foreign function can be called with named parameters.

    +

    The optional third item is the default value for this parameter.

    +
    +

    This example demonstrates how to wrap the Windows MessageBoxW function so +that it supports default parameters and named arguments. The C declaration from +the windows header file is this:

    +
    WINUSERAPI int WINAPI
    +MessageBoxW(
    +    HWND hWnd,
    +    LPCWSTR lpText,
    +    LPCWSTR lpCaption,
    +    UINT uType);
    +
    +
    +

    Here is the wrapping with ctypes:

    +
    >>> from ctypes import c_int, WINFUNCTYPE, windll
    +>>> from ctypes.wintypes import HWND, LPCWSTR, UINT
    +>>> prototype = WINFUNCTYPE(c_int, HWND, LPCWSTR, LPCWSTR, UINT)
    +>>> paramflags = (1, "hwnd", 0), (1, "text", "Hi"), (1, "caption", "Hello from ctypes"), (1, "flags", 0)
    +>>> MessageBox = prototype(("MessageBoxW", windll.user32), paramflags)
    +
    +
    +

    The MessageBox foreign function can now be called in these ways:

    +
    >>> MessageBox()
    +>>> MessageBox(text="Spam, spam, spam")
    +>>> MessageBox(flags=2, text="foo bar")
    +
    +
    +

    A second example demonstrates output parameters. The win32 GetWindowRect +function retrieves the dimensions of a specified window by copying them into +RECT structure that the caller has to supply. Here is the C declaration:

    +
    WINUSERAPI BOOL WINAPI
    +GetWindowRect(
    +     HWND hWnd,
    +     LPRECT lpRect);
    +
    +
    +

    Here is the wrapping with ctypes:

    +
    >>> from ctypes import POINTER, WINFUNCTYPE, windll, WinError
    +>>> from ctypes.wintypes import BOOL, HWND, RECT
    +>>> prototype = WINFUNCTYPE(BOOL, HWND, POINTER(RECT))
    +>>> paramflags = (1, "hwnd"), (2, "lprect")
    +>>> GetWindowRect = prototype(("GetWindowRect", windll.user32), paramflags)
    +>>>
    +
    +
    +

    Functions with output parameters will automatically return the output parameter +value if there is a single one, or a tuple containing the output parameter +values when there are more than one, so the GetWindowRect function now returns a +RECT instance, when called.

    +

    Output parameters can be combined with the errcheck protocol to do +further output processing and error checking. The win32 GetWindowRect api +function returns a BOOL to signal success or failure, so this function could +do the error checking, and raises an exception when the api call failed:

    +
    >>> def errcheck(result, func, args):
    +...     if not result:
    +...         raise WinError()
    +...     return args
    +...
    +>>> GetWindowRect.errcheck = errcheck
    +>>>
    +
    +
    +

    If the errcheck function returns the argument tuple it receives +unchanged, ctypes continues the normal processing it does on the output +parameters. If you want to return a tuple of window coordinates instead of a +RECT instance, you can retrieve the fields in the function and return them +instead, the normal processing will no longer take place:

    +
    >>> def errcheck(result, func, args):
    +...     if not result:
    +...         raise WinError()
    +...     rc = args[1]
    +...     return rc.left, rc.top, rc.bottom, rc.right
    +...
    +>>> GetWindowRect.errcheck = errcheck
    +>>>
    +
    +
    +
    +
    +

    Utility functions

    +
    +
    +ctypes.addressof(obj)
    +

    Returns the address of the memory buffer as integer. obj must be an +instance of a ctypes type.

    +
    + +
    +
    +ctypes.alignment(obj_or_type)
    +

    Returns the alignment requirements of a ctypes type. obj_or_type must be a +ctypes type or instance.

    +
    + +
    +
    +ctypes.byref(obj[, offset])
    +

    Returns a light-weight pointer to obj, which must be an instance of a +ctypes type. offset defaults to zero, and must be an integer that will be +added to the internal pointer value.

    +

    byref(obj, offset) corresponds to this C code:

    +
    (((char *)&obj) + offset)
    +
    +
    +

    The returned object can only be used as a foreign function call parameter. +It behaves similar to pointer(obj), but the construction is a lot faster.

    +
    + +
    +
    +ctypes.cast(obj, type)
    +

    This function is similar to the cast operator in C. It returns a new instance +of type which points to the same memory block as obj. type must be a +pointer type, and obj must be an object that can be interpreted as a +pointer.

    +
    + +
    +
    +ctypes.create_string_buffer(init_or_size, size=None)
    +

    This function creates a mutable character buffer. The returned object is a +ctypes array of c_char.

    +

    init_or_size must be an integer which specifies the size of the array, or a +bytes object which will be used to initialize the array items.

    +

    If a bytes object is specified as first argument, the buffer is made one item +larger than its length so that the last element in the array is a NUL +termination character. An integer can be passed as second argument which allows +specifying the size of the array if the length of the bytes should not be used.

    +
    + +
    +
    +ctypes.create_unicode_buffer(init_or_size, size=None)
    +

    This function creates a mutable unicode character buffer. The returned object is +a ctypes array of c_wchar.

    +

    init_or_size must be an integer which specifies the size of the array, or a +string which will be used to initialize the array items.

    +

    If a string is specified as first argument, the buffer is made one item +larger than the length of the string so that the last element in the array is a +NUL termination character. An integer can be passed as second argument which +allows specifying the size of the array if the length of the string should not +be used.

    +
    + +
    +
    +ctypes.DllCanUnloadNow()
    +

    Windows only: This function is a hook which allows implementing in-process +COM servers with ctypes. It is called from the DllCanUnloadNow function that +the _ctypes extension dll exports.

    +
    + +
    +
    +ctypes.DllGetClassObject()
    +

    Windows only: This function is a hook which allows implementing in-process +COM servers with ctypes. It is called from the DllGetClassObject function +that the _ctypes extension dll exports.

    +
    + +
    +
    +ctypes.util.find_library(name)
    +

    Try to find a library and return a pathname. name is the library name +without any prefix like lib, suffix like .so, .dylib or version +number (this is the form used for the posix linker option -l). If +no library can be found, returns None.

    +

    The exact functionality is system dependent.

    +
    + +
    +
    +ctypes.util.find_msvcrt()
    +

    Windows only: return the filename of the VC runtime library used by Python, +and by the extension modules. If the name of the library cannot be +determined, None is returned.

    +

    If you need to free memory, for example, allocated by an extension module +with a call to the free(void *), it is important that you use the +function in the same library that allocated the memory.

    +
    + +
    +
    +ctypes.FormatError([code])
    +

    Windows only: Returns a textual description of the error code code. If no +error code is specified, the last error code is used by calling the Windows +api function GetLastError.

    +
    + +
    +
    +ctypes.GetLastError()
    +

    Windows only: Returns the last error code set by Windows in the calling thread. +This function calls the Windows GetLastError() function directly, +it does not return the ctypes-private copy of the error code.

    +
    + +
    +
    +ctypes.get_errno()
    +

    Returns the current value of the ctypes-private copy of the system +errno variable in the calling thread.

    +
    + +
    +
    +ctypes.get_last_error()
    +

    Windows only: returns the current value of the ctypes-private copy of the system +LastError variable in the calling thread.

    +
    + +
    +
    +ctypes.memmove(dst, src, count)
    +

    Same as the standard C memmove library function: copies count bytes from +src to dst. dst and src must be integers or ctypes instances that can +be converted to pointers.

    +
    + +
    +
    +ctypes.memset(dst, c, count)
    +

    Same as the standard C memset library function: fills the memory block at +address dst with count bytes of value c. dst must be an integer +specifying an address, or a ctypes instance.

    +
    + +
    +
    +ctypes.POINTER(type)
    +

    This factory function creates and returns a new ctypes pointer type. Pointer +types are cached and reused internally, so calling this function repeatedly is +cheap. type must be a ctypes type.

    +
    + +
    +
    +ctypes.pointer(obj)
    +

    This function creates a new pointer instance, pointing to obj. The returned +object is of the type POINTER(type(obj)).

    +

    Note: If you just want to pass a pointer to an object to a foreign function +call, you should use byref(obj) which is much faster.

    +
    + +
    +
    +ctypes.resize(obj, size)
    +

    This function resizes the internal memory buffer of obj, which must be an +instance of a ctypes type. It is not possible to make the buffer smaller +than the native size of the objects type, as given by sizeof(type(obj)), +but it is possible to enlarge the buffer.

    +
    + +
    +
    +ctypes.set_errno(value)
    +

    Set the current value of the ctypes-private copy of the system errno +variable in the calling thread to value and return the previous value.

    +
    + +
    +
    +ctypes.set_last_error(value)
    +

    Windows only: set the current value of the ctypes-private copy of the system +LastError variable in the calling thread to value and return the +previous value.

    +
    + +
    +
    +ctypes.sizeof(obj_or_type)
    +

    Returns the size in bytes of a ctypes type or instance memory buffer. +Does the same as the C sizeof operator.

    +
    + +
    +
    +ctypes.string_at(address, size=-1)
    +

    This function returns the C string starting at memory address address as a bytes +object. If size is specified, it is used as size, otherwise the string is assumed +to be zero-terminated.

    +
    + +
    +
    +ctypes.WinError(code=None, descr=None)
    +

    Windows only: this function is probably the worst-named thing in ctypes. It +creates an instance of OSError. If code is not specified, +GetLastError is called to determine the error code. If descr is not +specified, FormatError() is called to get a textual description of the +error.

    +
    +

    Changed in version 3.3: An instance of WindowsError used to be created.

    +
    +
    + +
    +
    +ctypes.wstring_at(address, size=-1)
    +

    This function returns the wide character string starting at memory address +address as a string. If size is specified, it is used as the number of +characters of the string, otherwise the string is assumed to be +zero-terminated.

    +
    + +
    +
    +

    Data types

    +
    +
    +class ctypes._CData
    +

    This non-public class is the common base class of all ctypes data types. +Among other things, all ctypes type instances contain a memory block that +hold C compatible data; the address of the memory block is returned by the +addressof() helper function. Another instance variable is exposed as +_objects; this contains other Python objects that need to be kept +alive in case the memory block contains pointers.

    +

    Common methods of ctypes data types, these are all class methods (to be +exact, they are methods of the metaclass):

    +
    +
    +from_buffer(source[, offset])
    +

    This method returns a ctypes instance that shares the buffer of the +source object. The source object must support the writeable buffer +interface. The optional offset parameter specifies an offset into the +source buffer in bytes; the default is zero. If the source buffer is not +large enough a ValueError is raised.

    +
    + +
    +
    +from_buffer_copy(source[, offset])
    +

    This method creates a ctypes instance, copying the buffer from the +source object buffer which must be readable. The optional offset +parameter specifies an offset into the source buffer in bytes; the default +is zero. If the source buffer is not large enough a ValueError is +raised.

    +
    + +
    +
    +from_address(address)
    +

    This method returns a ctypes type instance using the memory specified by +address which must be an integer.

    +
    + +
    +
    +from_param(obj)
    +

    This method adapts obj to a ctypes type. It is called with the actual +object used in a foreign function call when the type is present in the +foreign function’s argtypes tuple; it must return an object that +can be used as a function call parameter.

    +

    All ctypes data types have a default implementation of this classmethod +that normally returns obj if that is an instance of the type. Some +types accept other objects as well.

    +
    + +
    +
    +in_dll(library, name)
    +

    This method returns a ctypes type instance exported by a shared +library. name is the name of the symbol that exports the data, library +is the loaded shared library.

    +
    + +

    Common instance variables of ctypes data types:

    +
    +
    +_b_base_
    +

    Sometimes ctypes data instances do not own the memory block they contain, +instead they share part of the memory block of a base object. The +_b_base_ read-only member is the root ctypes object that owns the +memory block.

    +
    + +
    +
    +_b_needsfree_
    +

    This read-only variable is true when the ctypes data instance has +allocated the memory block itself, false otherwise.

    +
    + +
    +
    +_objects
    +

    This member is either None or a dictionary containing Python objects +that need to be kept alive so that the memory block contents is kept +valid. This object is only exposed for debugging; never modify the +contents of this dictionary.

    +
    + +
    + +
    +
    +

    Fundamental data types

    +
    +
    +class ctypes._SimpleCData
    +

    This non-public class is the base class of all fundamental ctypes data +types. It is mentioned here because it contains the common attributes of the +fundamental ctypes data types. _SimpleCData is a subclass of +_CData, so it inherits their methods and attributes. ctypes data +types that are not and do not contain pointers can now be pickled.

    +

    Instances have a single attribute:

    +
    +
    +value
    +

    This attribute contains the actual value of the instance. For integer and +pointer types, it is an integer, for character types, it is a single +character bytes object or string, for character pointer types it is a +Python bytes object or string.

    +

    When the value attribute is retrieved from a ctypes instance, usually +a new object is returned each time. ctypes does not implement +original object return, always a new object is constructed. The same is +true for all other ctypes object instances.

    +
    + +
    + +

    Fundamental data types, when returned as foreign function call results, or, for +example, by retrieving structure field members or array items, are transparently +converted to native Python types. In other words, if a foreign function has a +restype of c_char_p, you will always receive a Python bytes +object, not a c_char_p instance.

    +

    Subclasses of fundamental data types do not inherit this behavior. So, if a +foreign functions restype is a subclass of c_void_p, you will +receive an instance of this subclass from the function call. Of course, you can +get the value of the pointer by accessing the value attribute.

    +

    These are the fundamental ctypes data types:

    +
    +
    +class ctypes.c_byte
    +

    Represents the C signed char datatype, and interprets the value as +small integer. The constructor accepts an optional integer initializer; no +overflow checking is done.

    +
    + +
    +
    +class ctypes.c_char
    +

    Represents the C char datatype, and interprets the value as a single +character. The constructor accepts an optional string initializer, the +length of the string must be exactly one character.

    +
    + +
    +
    +class ctypes.c_char_p
    +

    Represents the C char * datatype when it points to a zero-terminated +string. For a general character pointer that may also point to binary data, +POINTER(c_char) must be used. The constructor accepts an integer +address, or a bytes object.

    +
    + +
    +
    +class ctypes.c_double
    +

    Represents the C double datatype. The constructor accepts an +optional float initializer.

    +
    + +
    +
    +class ctypes.c_longdouble
    +

    Represents the C long double datatype. The constructor accepts an +optional float initializer. On platforms where sizeof(long double) == +sizeof(double) it is an alias to c_double.

    +
    + +
    +
    +class ctypes.c_float
    +

    Represents the C float datatype. The constructor accepts an +optional float initializer.

    +
    + +
    +
    +class ctypes.c_int
    +

    Represents the C signed int datatype. The constructor accepts an +optional integer initializer; no overflow checking is done. On platforms +where sizeof(int) == sizeof(long) it is an alias to c_long.

    +
    + +
    +
    +class ctypes.c_int8
    +

    Represents the C 8-bit signed int datatype. Usually an alias for +c_byte.

    +
    + +
    +
    +class ctypes.c_int16
    +

    Represents the C 16-bit signed int datatype. Usually an alias for +c_short.

    +
    + +
    +
    +class ctypes.c_int32
    +

    Represents the C 32-bit signed int datatype. Usually an alias for +c_int.

    +
    + +
    +
    +class ctypes.c_int64
    +

    Represents the C 64-bit signed int datatype. Usually an alias for +c_longlong.

    +
    + +
    +
    +class ctypes.c_long
    +

    Represents the C signed long datatype. The constructor accepts an +optional integer initializer; no overflow checking is done.

    +
    + +
    +
    +class ctypes.c_longlong
    +

    Represents the C signed long long datatype. The constructor accepts +an optional integer initializer; no overflow checking is done.

    +
    + +
    +
    +class ctypes.c_short
    +

    Represents the C signed short datatype. The constructor accepts an +optional integer initializer; no overflow checking is done.

    +
    + +
    +
    +class ctypes.c_size_t
    +

    Represents the C size_t datatype.

    +
    + +
    +
    +class ctypes.c_ssize_t
    +

    Represents the C ssize_t datatype.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +class ctypes.c_ubyte
    +

    Represents the C unsigned char datatype, it interprets the value as +small integer. The constructor accepts an optional integer initializer; no +overflow checking is done.

    +
    + +
    +
    +class ctypes.c_uint
    +

    Represents the C unsigned int datatype. The constructor accepts an +optional integer initializer; no overflow checking is done. On platforms +where sizeof(int) == sizeof(long) it is an alias for c_ulong.

    +
    + +
    +
    +class ctypes.c_uint8
    +

    Represents the C 8-bit unsigned int datatype. Usually an alias for +c_ubyte.

    +
    + +
    +
    +class ctypes.c_uint16
    +

    Represents the C 16-bit unsigned int datatype. Usually an alias for +c_ushort.

    +
    + +
    +
    +class ctypes.c_uint32
    +

    Represents the C 32-bit unsigned int datatype. Usually an alias for +c_uint.

    +
    + +
    +
    +class ctypes.c_uint64
    +

    Represents the C 64-bit unsigned int datatype. Usually an alias for +c_ulonglong.

    +
    + +
    +
    +class ctypes.c_ulong
    +

    Represents the C unsigned long datatype. The constructor accepts an +optional integer initializer; no overflow checking is done.

    +
    + +
    +
    +class ctypes.c_ulonglong
    +

    Represents the C unsigned long long datatype. The constructor +accepts an optional integer initializer; no overflow checking is done.

    +
    + +
    +
    +class ctypes.c_ushort
    +

    Represents the C unsigned short datatype. The constructor accepts +an optional integer initializer; no overflow checking is done.

    +
    + +
    +
    +class ctypes.c_void_p
    +

    Represents the C void * type. The value is represented as integer. +The constructor accepts an optional integer initializer.

    +
    + +
    +
    +class ctypes.c_wchar
    +

    Represents the C wchar_t datatype, and interprets the value as a +single character unicode string. The constructor accepts an optional string +initializer, the length of the string must be exactly one character.

    +
    + +
    +
    +class ctypes.c_wchar_p
    +

    Represents the C wchar_t * datatype, which must be a pointer to a +zero-terminated wide character string. The constructor accepts an integer +address, or a string.

    +
    + +
    +
    +class ctypes.c_bool
    +

    Represent the C bool datatype (more accurately, _Bool from +C99). Its value can be True or False, and the constructor accepts any object +that has a truth value.

    +
    + +
    +
    +class ctypes.HRESULT
    +

    Windows only: Represents a HRESULT value, which contains success or +error information for a function or method call.

    +
    + +
    +
    +class ctypes.py_object
    +

    Represents the C PyObject * datatype. Calling this without an +argument creates a NULL PyObject * pointer.

    +
    + +

    The ctypes.wintypes module provides quite some other Windows specific +data types, for example HWND, WPARAM, or DWORD. Some +useful structures like MSG or RECT are also defined.

    +
    +
    +

    Structured data types

    +
    +
    +class ctypes.Union(*args, **kw)
    +

    Abstract base class for unions in native byte order.

    +
    + +
    +
    +class ctypes.BigEndianStructure(*args, **kw)
    +

    Abstract base class for structures in big endian byte order.

    +
    + +
    +
    +class ctypes.LittleEndianStructure(*args, **kw)
    +

    Abstract base class for structures in little endian byte order.

    +
    + +

    Structures with non-native byte order cannot contain pointer type fields, or any +other data types containing pointer type fields.

    +
    +
    +class ctypes.Structure(*args, **kw)
    +

    Abstract base class for structures in native byte order.

    +

    Concrete structure and union types must be created by subclassing one of these +types, and at least define a _fields_ class variable. ctypes will +create descriptors which allow reading and writing the fields by direct +attribute accesses. These are the

    +
    +
    +_fields_
    +

    A sequence defining the structure fields. The items must be 2-tuples or +3-tuples. The first item is the name of the field, the second item +specifies the type of the field; it can be any ctypes data type.

    +

    For integer type fields like c_int, a third optional item can be +given. It must be a small positive integer defining the bit width of the +field.

    +

    Field names must be unique within one structure or union. This is not +checked, only one field can be accessed when names are repeated.

    +

    It is possible to define the _fields_ class variable after the +class statement that defines the Structure subclass, this allows creating +data types that directly or indirectly reference themselves:

    +
    class List(Structure):
    +    pass
    +List._fields_ = [("pnext", POINTER(List)),
    +                 ...
    +                ]
    +
    +
    +

    The _fields_ class variable must, however, be defined before the +type is first used (an instance is created, sizeof() is called on it, +and so on). Later assignments to the _fields_ class variable will +raise an AttributeError.

    +

    It is possible to define sub-subclasses of structure types, they inherit +the fields of the base class plus the _fields_ defined in the +sub-subclass, if any.

    +
    + +
    +
    +_pack_
    +

    An optional small integer that allows overriding the alignment of +structure fields in the instance. _pack_ must already be defined +when _fields_ is assigned, otherwise it will have no effect.

    +
    + +
    +
    +_anonymous_
    +

    An optional sequence that lists the names of unnamed (anonymous) fields. +_anonymous_ must be already defined when _fields_ is +assigned, otherwise it will have no effect.

    +

    The fields listed in this variable must be structure or union type fields. +ctypes will create descriptors in the structure type that allows +accessing the nested fields directly, without the need to create the +structure or union field.

    +

    Here is an example type (Windows):

    +
    class _U(Union):
    +    _fields_ = [("lptdesc", POINTER(TYPEDESC)),
    +                ("lpadesc", POINTER(ARRAYDESC)),
    +                ("hreftype", HREFTYPE)]
    +
    +class TYPEDESC(Structure):
    +    _anonymous_ = ("u",)
    +    _fields_ = [("u", _U),
    +                ("vt", VARTYPE)]
    +
    +
    +

    The TYPEDESC structure describes a COM data type, the vt field +specifies which one of the union fields is valid. Since the u field +is defined as anonymous field, it is now possible to access the members +directly off the TYPEDESC instance. td.lptdesc and td.u.lptdesc +are equivalent, but the former is faster since it does not need to create +a temporary union instance:

    +
    td = TYPEDESC()
    +td.vt = VT_PTR
    +td.lptdesc = POINTER(some_type)
    +td.u.lptdesc = POINTER(some_type)
    +
    +
    +
    + +

    It is possible to define sub-subclasses of structures, they inherit the +fields of the base class. If the subclass definition has a separate +_fields_ variable, the fields specified in this are appended to the +fields of the base class.

    +

    Structure and union constructors accept both positional and keyword +arguments. Positional arguments are used to initialize member fields in the +same order as they are appear in _fields_. Keyword arguments in the +constructor are interpreted as attribute assignments, so they will initialize +_fields_ with the same name, or create new attributes for names not +present in _fields_.

    +
    + +
    +
    +

    Arrays and pointers

    +
    +
    +class ctypes.Array(*args)
    +

    Abstract base class for arrays.

    +

    The recommended way to create concrete array types is by multiplying any +ctypes data type with a positive integer. Alternatively, you can subclass +this type and define _length_ and _type_ class variables. +Array elements can be read and written using standard +subscript and slice accesses; for slice reads, the resulting object is +not itself an Array.

    +
    +
    +_length_
    +

    A positive integer specifying the number of elements in the array. +Out-of-range subscripts result in an IndexError. Will be +returned by len().

    +
    + +
    +
    +_type_
    +

    Specifies the type of each element in the array.

    +
    + +

    Array subclass constructors accept positional arguments, used to +initialize the elements in order.

    +
    + +
    +
    +class ctypes._Pointer
    +

    Private, abstract base class for pointers.

    +

    Concrete pointer types are created by calling POINTER() with the +type that will be pointed to; this is done automatically by +pointer().

    +

    If a pointer points to an array, its elements can be read and +written using standard subscript and slice accesses. Pointer objects +have no size, so len() will raise TypeError. Negative +subscripts will read from the memory before the pointer (as in C), and +out-of-range subscripts will probably crash with an access violation (if +you’re lucky).

    +
    +
    +_type_
    +

    Specifies the type pointed to.

    +
    + +
    +
    +contents
    +

    Returns the object to which to pointer points. Assigning to this +attribute changes the pointer to point to the assigned object.

    +
    + +
    + +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/curses.ascii.html b/python-3.7.4-docs-html/library/curses.ascii.html new file mode 100644 index 0000000..3be0102 --- /dev/null +++ b/python-3.7.4-docs-html/library/curses.ascii.html @@ -0,0 +1,456 @@ + + + + + + + curses.ascii — Utilities for ASCII characters — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    curses.ascii — Utilities for ASCII characters

    +
    +

    The curses.ascii module supplies name constants for ASCII characters and +functions to test membership in various ASCII character classes. The constants +supplied are names for control characters as follows:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Name

    Meaning

    NUL

    SOH

    Start of heading, console interrupt

    STX

    Start of text

    ETX

    End of text

    EOT

    End of transmission

    ENQ

    Enquiry, goes with ACK flow control

    ACK

    Acknowledgement

    BEL

    Bell

    BS

    Backspace

    TAB

    Tab

    HT

    Alias for TAB: “Horizontal tab”

    LF

    Line feed

    NL

    Alias for LF: “New line”

    VT

    Vertical tab

    FF

    Form feed

    CR

    Carriage return

    SO

    Shift-out, begin alternate character set

    SI

    Shift-in, resume default character set

    DLE

    Data-link escape

    DC1

    XON, for flow control

    DC2

    Device control 2, block-mode flow control

    DC3

    XOFF, for flow control

    DC4

    Device control 4

    NAK

    Negative acknowledgement

    SYN

    Synchronous idle

    ETB

    End transmission block

    CAN

    Cancel

    EM

    End of medium

    SUB

    Substitute

    ESC

    Escape

    FS

    File separator

    GS

    Group separator

    RS

    Record separator, block-mode terminator

    US

    Unit separator

    SP

    Space

    DEL

    Delete

    +

    Note that many of these have little practical significance in modern usage. The +mnemonics derive from teleprinter conventions that predate digital computers.

    +

    The module supplies the following functions, patterned on those in the standard +C library:

    +
    +
    +curses.ascii.isalnum(c)
    +

    Checks for an ASCII alphanumeric character; it is equivalent to isalpha(c) or +isdigit(c).

    +
    + +
    +
    +curses.ascii.isalpha(c)
    +

    Checks for an ASCII alphabetic character; it is equivalent to isupper(c) or +islower(c).

    +
    + +
    +
    +curses.ascii.isascii(c)
    +

    Checks for a character value that fits in the 7-bit ASCII set.

    +
    + +
    +
    +curses.ascii.isblank(c)
    +

    Checks for an ASCII whitespace character; space or horizontal tab.

    +
    + +
    +
    +curses.ascii.iscntrl(c)
    +

    Checks for an ASCII control character (in the range 0x00 to 0x1f or 0x7f).

    +
    + +
    +
    +curses.ascii.isdigit(c)
    +

    Checks for an ASCII decimal digit, '0' through '9'. This is equivalent +to c in string.digits.

    +
    + +
    +
    +curses.ascii.isgraph(c)
    +

    Checks for ASCII any printable character except space.

    +
    + +
    +
    +curses.ascii.islower(c)
    +

    Checks for an ASCII lower-case character.

    +
    + +
    +
    +curses.ascii.isprint(c)
    +

    Checks for any ASCII printable character including space.

    +
    + +
    +
    +curses.ascii.ispunct(c)
    +

    Checks for any printable ASCII character which is not a space or an alphanumeric +character.

    +
    + +
    +
    +curses.ascii.isspace(c)
    +

    Checks for ASCII white-space characters; space, line feed, carriage return, form +feed, horizontal tab, vertical tab.

    +
    + +
    +
    +curses.ascii.isupper(c)
    +

    Checks for an ASCII uppercase letter.

    +
    + +
    +
    +curses.ascii.isxdigit(c)
    +

    Checks for an ASCII hexadecimal digit. This is equivalent to c in +string.hexdigits.

    +
    + +
    +
    +curses.ascii.isctrl(c)
    +

    Checks for an ASCII control character (ordinal values 0 to 31).

    +
    + +
    +
    +curses.ascii.ismeta(c)
    +

    Checks for a non-ASCII character (ordinal values 0x80 and above).

    +
    + +

    These functions accept either integers or single-character strings; when the argument is a +string, it is first converted using the built-in function ord().

    +

    Note that all these functions check ordinal bit values derived from the +character of the string you pass in; they do not actually know anything about +the host machine’s character encoding.

    +

    The following two functions take either a single-character string or integer +byte value; they return a value of the same type.

    +
    +
    +curses.ascii.ascii(c)
    +

    Return the ASCII value corresponding to the low 7 bits of c.

    +
    + +
    +
    +curses.ascii.ctrl(c)
    +

    Return the control character corresponding to the given character (the character +bit value is bitwise-anded with 0x1f).

    +
    + +
    +
    +curses.ascii.alt(c)
    +

    Return the 8-bit character corresponding to the given ASCII character (the +character bit value is bitwise-ored with 0x80).

    +
    + +

    The following function takes either a single-character string or integer value; +it returns a string.

    +
    +
    +curses.ascii.unctrl(c)
    +

    Return a string representation of the ASCII character c. If c is printable, +this string is the character itself. If the character is a control character +(0x00–0x1f) the string consists of a caret ('^') followed by the +corresponding uppercase letter. If the character is an ASCII delete (0x7f) the +string is '^?'. If the character has its meta bit (0x80) set, the meta bit +is stripped, the preceding rules applied, and '!' prepended to the result.

    +
    + +
    +
    +curses.ascii.controlnames
    +

    A 33-element string array that contains the ASCII mnemonics for the thirty-two +ASCII control characters from 0 (NUL) to 0x1f (US), in order, plus the mnemonic +SP for the space character.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/curses.html b/python-3.7.4-docs-html/library/curses.html new file mode 100644 index 0000000..6860682 --- /dev/null +++ b/python-3.7.4-docs-html/library/curses.html @@ -0,0 +1,2441 @@ + + + + + + + curses — Terminal handling for character-cell displays — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    curses — Terminal handling for character-cell displays

    +
    +

    The curses module provides an interface to the curses library, the +de-facto standard for portable advanced terminal handling.

    +

    While curses is most widely used in the Unix environment, versions are available +for Windows, DOS, and possibly other systems as well. This extension module is +designed to match the API of ncurses, an open-source curses library hosted on +Linux and the BSD variants of Unix.

    +
    +

    Note

    +

    Whenever the documentation mentions a character it can be specified +as an integer, a one-character Unicode string or a one-byte byte string.

    +

    Whenever the documentation mentions a character string it can be specified +as a Unicode string or a byte string.

    +
    +
    +

    Note

    +

    Since version 5.4, the ncurses library decides how to interpret non-ASCII data +using the nl_langinfo function. That means that you have to call +locale.setlocale() in the application and encode Unicode strings +using one of the system’s available encodings. This example uses the +system’s default encoding:

    +
    import locale
    +locale.setlocale(locale.LC_ALL, '')
    +code = locale.getpreferredencoding()
    +
    +
    +

    Then use code as the encoding for str.encode() calls.

    +
    +
    +

    See also

    +
    +
    Module curses.ascii

    Utilities for working with ASCII characters, regardless of your locale settings.

    +
    +
    Module curses.panel

    A panel stack extension that adds depth to curses windows.

    +
    +
    Module curses.textpad

    Editable text widget for curses supporting Emacs-like bindings.

    +
    +
    Curses Programming with Python

    Tutorial material on using curses with Python, by Andrew Kuchling and Eric +Raymond.

    +
    +
    +

    The Tools/demo/ directory in the Python source distribution contains +some example programs using the curses bindings provided by this module.

    +
    +
    +

    Functions

    +

    The module curses defines the following exception:

    +
    +
    +exception curses.error
    +

    Exception raised when a curses library function returns an error.

    +
    + +
    +

    Note

    +

    Whenever x or y arguments to a function or a method are optional, they +default to the current cursor location. Whenever attr is optional, it defaults +to A_NORMAL.

    +
    +

    The module curses defines the following functions:

    +
    +
    +curses.baudrate()
    +

    Return the output speed of the terminal in bits per second. On software +terminal emulators it will have a fixed high value. Included for historical +reasons; in former times, it was used to write output loops for time delays and +occasionally to change interfaces depending on the line speed.

    +
    + +
    +
    +curses.beep()
    +

    Emit a short attention sound.

    +
    + +
    +
    +curses.can_change_color()
    +

    Return True or False, depending on whether the programmer can change the colors +displayed by the terminal.

    +
    + +
    +
    +curses.cbreak()
    +

    Enter cbreak mode. In cbreak mode (sometimes called “rare” mode) normal tty +line buffering is turned off and characters are available to be read one by one. +However, unlike raw mode, special characters (interrupt, quit, suspend, and flow +control) retain their effects on the tty driver and calling program. Calling +first raw() then cbreak() leaves the terminal in cbreak mode.

    +
    + +
    +
    +curses.color_content(color_number)
    +

    Return the intensity of the red, green, and blue (RGB) components in the color +color_number, which must be between 0 and COLORS. Return a 3-tuple, +containing the R,G,B values for the given color, which will be between +0 (no component) and 1000 (maximum amount of component).

    +
    + +
    +
    +curses.color_pair(color_number)
    +

    Return the attribute value for displaying text in the specified color. This +attribute value can be combined with A_STANDOUT, A_REVERSE, +and the other A_* attributes. pair_number() is the counterpart +to this function.

    +
    + +
    +
    +curses.curs_set(visibility)
    +

    Set the cursor state. visibility can be set to 0, 1, or 2, for invisible, +normal, or very visible. If the terminal supports the visibility requested, return the +previous cursor state; otherwise raise an exception. On many +terminals, the “visible” mode is an underline cursor and the “very visible” mode +is a block cursor.

    +
    + +
    +
    +curses.def_prog_mode()
    +

    Save the current terminal mode as the “program” mode, the mode when the running +program is using curses. (Its counterpart is the “shell” mode, for when the +program is not in curses.) Subsequent calls to reset_prog_mode() will +restore this mode.

    +
    + +
    +
    +curses.def_shell_mode()
    +

    Save the current terminal mode as the “shell” mode, the mode when the running +program is not using curses. (Its counterpart is the “program” mode, when the +program is using curses capabilities.) Subsequent calls to +reset_shell_mode() will restore this mode.

    +
    + +
    +
    +curses.delay_output(ms)
    +

    Insert an ms millisecond pause in output.

    +
    + +
    +
    +curses.doupdate()
    +

    Update the physical screen. The curses library keeps two data structures, one +representing the current physical screen contents and a virtual screen +representing the desired next state. The doupdate() ground updates the +physical screen to match the virtual screen.

    +

    The virtual screen may be updated by a noutrefresh() call after write +operations such as addstr() have been performed on a window. The normal +refresh() call is simply noutrefresh() followed by doupdate(); +if you have to update multiple windows, you can speed performance and perhaps +reduce screen flicker by issuing noutrefresh() calls on all windows, +followed by a single doupdate().

    +
    + +
    +
    +curses.echo()
    +

    Enter echo mode. In echo mode, each character input is echoed to the screen as +it is entered.

    +
    + +
    +
    +curses.endwin()
    +

    De-initialize the library, and return terminal to normal status.

    +
    + +
    +
    +curses.erasechar()
    +

    Return the user’s current erase character as a one-byte bytes object. Under Unix operating systems this +is a property of the controlling tty of the curses program, and is not set by +the curses library itself.

    +
    + +
    +
    +curses.filter()
    +

    The filter() routine, if used, must be called before initscr() is +called. The effect is that, during those calls, LINES is set to 1; the +capabilities clear, cup, cud, cud1, cuu1, cuu, vpa are disabled; and the home +string is set to the value of cr. The effect is that the cursor is confined to +the current line, and so are screen updates. This may be used for enabling +character-at-a-time line editing without touching the rest of the screen.

    +
    + +
    +
    +curses.flash()
    +

    Flash the screen. That is, change it to reverse-video and then change it back +in a short interval. Some people prefer such as ‘visible bell’ to the audible +attention signal produced by beep().

    +
    + +
    +
    +curses.flushinp()
    +

    Flush all input buffers. This throws away any typeahead that has been typed +by the user and has not yet been processed by the program.

    +
    + +
    +
    +curses.getmouse()
    +

    After getch() returns KEY_MOUSE to signal a mouse event, this +method should be call to retrieve the queued mouse event, represented as a +5-tuple (id, x, y, z, bstate). id is an ID value used to distinguish +multiple devices, and x, y, z are the event’s coordinates. (z is +currently unused.) bstate is an integer value whose bits will be set to +indicate the type of event, and will be the bitwise OR of one or more of the +following constants, where n is the button number from 1 to 4: +BUTTONn_PRESSED, BUTTONn_RELEASED, BUTTONn_CLICKED, +BUTTONn_DOUBLE_CLICKED, BUTTONn_TRIPLE_CLICKED, +BUTTON_SHIFT, BUTTON_CTRL, BUTTON_ALT.

    +
    + +
    +
    +curses.getsyx()
    +

    Return the current coordinates of the virtual screen cursor as a tuple +(y, x). If leaveok is currently True, then return (-1, -1).

    +
    + +
    +
    +curses.getwin(file)
    +

    Read window related data stored in the file by an earlier putwin() call. +The routine then creates and initializes a new window using that data, returning +the new window object.

    +
    + +
    +
    +curses.has_colors()
    +

    Return True if the terminal can display colors; otherwise, return False.

    +
    + +
    +
    +curses.has_ic()
    +

    Return True if the terminal has insert- and delete-character capabilities. +This function is included for historical reasons only, as all modern software +terminal emulators have such capabilities.

    +
    + +
    +
    +curses.has_il()
    +

    Return True if the terminal has insert- and delete-line capabilities, or can +simulate them using scrolling regions. This function is included for +historical reasons only, as all modern software terminal emulators have such +capabilities.

    +
    + +
    +
    +curses.has_key(ch)
    +

    Take a key value ch, and return True if the current terminal type recognizes +a key with that value.

    +
    + +
    +
    +curses.halfdelay(tenths)
    +

    Used for half-delay mode, which is similar to cbreak mode in that characters +typed by the user are immediately available to the program. However, after +blocking for tenths tenths of seconds, raise an exception if nothing has +been typed. The value of tenths must be a number between 1 and 255. Use +nocbreak() to leave half-delay mode.

    +
    + +
    +
    +curses.init_color(color_number, r, g, b)
    +

    Change the definition of a color, taking the number of the color to be changed +followed by three RGB values (for the amounts of red, green, and blue +components). The value of color_number must be between 0 and +COLORS. Each of r, g, b, must be a value between 0 and +1000. When init_color() is used, all occurrences of that color on the +screen immediately change to the new definition. This function is a no-op on +most terminals; it is active only if can_change_color() returns True.

    +
    + +
    +
    +curses.init_pair(pair_number, fg, bg)
    +

    Change the definition of a color-pair. It takes three arguments: the number of +the color-pair to be changed, the foreground color number, and the background +color number. The value of pair_number must be between 1 and +COLOR_PAIRS - 1 (the 0 color pair is wired to white on black and cannot +be changed). The value of fg and bg arguments must be between 0 and +COLORS. If the color-pair was previously initialized, the screen is +refreshed and all occurrences of that color-pair are changed to the new +definition.

    +
    + +
    +
    +curses.initscr()
    +

    Initialize the library. Return a window object +which represents the whole screen.

    +
    +

    Note

    +

    If there is an error opening the terminal, the underlying curses library may +cause the interpreter to exit.

    +
    +
    + +
    +
    +curses.is_term_resized(nlines, ncols)
    +

    Return True if resize_term() would modify the window structure, +False otherwise.

    +
    + +
    +
    +curses.isendwin()
    +

    Return True if endwin() has been called (that is, the curses library has +been deinitialized).

    +
    + +
    +
    +curses.keyname(k)
    +

    Return the name of the key numbered k as a bytes object. The name of a key generating printable +ASCII character is the key’s character. The name of a control-key combination +is a two-byte bytes object consisting of a caret (b'^') followed by the corresponding +printable ASCII character. The name of an alt-key combination (128–255) is a +bytes object consisting of the prefix b'M-' followed by the name of the corresponding +ASCII character.

    +
    + +
    +
    +curses.killchar()
    +

    Return the user’s current line kill character as a one-byte bytes object. Under Unix operating systems +this is a property of the controlling tty of the curses program, and is not set +by the curses library itself.

    +
    + +
    +
    +curses.longname()
    +

    Return a bytes object containing the terminfo long name field describing the current +terminal. The maximum length of a verbose description is 128 characters. It is +defined only after the call to initscr().

    +
    + +
    +
    +curses.meta(flag)
    +

    If flag is True, allow 8-bit characters to be input. If +flag is False, allow only 7-bit chars.

    +
    + +
    +
    +curses.mouseinterval(interval)
    +

    Set the maximum time in milliseconds that can elapse between press and release +events in order for them to be recognized as a click, and return the previous +interval value. The default value is 200 msec, or one fifth of a second.

    +
    + +
    +
    +curses.mousemask(mousemask)
    +

    Set the mouse events to be reported, and return a tuple (availmask, +oldmask). availmask indicates which of the specified mouse events can be +reported; on complete failure it returns 0. oldmask is the previous value of +the given window’s mouse event mask. If this function is never called, no mouse +events are ever reported.

    +
    + +
    +
    +curses.napms(ms)
    +

    Sleep for ms milliseconds.

    +
    + +
    +
    +curses.newpad(nlines, ncols)
    +

    Create and return a pointer to a new pad data structure with the given number +of lines and columns. Return a pad as a window object.

    +

    A pad is like a window, except that it is not restricted by the screen size, and +is not necessarily associated with a particular part of the screen. Pads can be +used when a large window is needed, and only a part of the window will be on the +screen at one time. Automatic refreshes of pads (such as from scrolling or +echoing of input) do not occur. The refresh() and noutrefresh() +methods of a pad require 6 arguments to specify the part of the pad to be +displayed and the location on the screen to be used for the display. The +arguments are pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol; the p +arguments refer to the upper left corner of the pad region to be displayed and +the s arguments define a clipping box on the screen within which the pad region +is to be displayed.

    +
    + +
    +
    +curses.newwin(nlines, ncols)
    +
    +curses.newwin(nlines, ncols, begin_y, begin_x)
    +

    Return a new window, whose left-upper corner +is at (begin_y, begin_x), and whose height/width is nlines/ncols.

    +

    By default, the window will extend from the specified position to the lower +right corner of the screen.

    +
    + +
    +
    +curses.nl()
    +

    Enter newline mode. This mode translates the return key into newline on input, +and translates newline into return and line-feed on output. Newline mode is +initially on.

    +
    + +
    +
    +curses.nocbreak()
    +

    Leave cbreak mode. Return to normal “cooked” mode with line buffering.

    +
    + +
    +
    +curses.noecho()
    +

    Leave echo mode. Echoing of input characters is turned off.

    +
    + +
    +
    +curses.nonl()
    +

    Leave newline mode. Disable translation of return into newline on input, and +disable low-level translation of newline into newline/return on output (but this +does not change the behavior of addch('\n'), which always does the +equivalent of return and line feed on the virtual screen). With translation +off, curses can sometimes speed up vertical motion a little; also, it will be +able to detect the return key on input.

    +
    + +
    +
    +curses.noqiflush()
    +

    When the noqiflush() routine is used, normal flush of input and output queues +associated with the INTR, QUIT and SUSP characters will not be done. You may +want to call noqiflush() in a signal handler if you want output to +continue as though the interrupt had not occurred, after the handler exits.

    +
    + +
    +
    +curses.noraw()
    +

    Leave raw mode. Return to normal “cooked” mode with line buffering.

    +
    + +
    +
    +curses.pair_content(pair_number)
    +

    Return a tuple (fg, bg) containing the colors for the requested color pair. +The value of pair_number must be between 1 and COLOR_PAIRS - 1.

    +
    + +
    +
    +curses.pair_number(attr)
    +

    Return the number of the color-pair set by the attribute value attr. +color_pair() is the counterpart to this function.

    +
    + +
    +
    +curses.putp(str)
    +

    Equivalent to tputs(str, 1, putchar); emit the value of a specified +terminfo capability for the current terminal. Note that the output of putp() +always goes to standard output.

    +
    + +
    +
    +curses.qiflush([flag])
    +

    If flag is False, the effect is the same as calling noqiflush(). If +flag is True, or no argument is provided, the queues will be flushed when +these control characters are read.

    +
    + +
    +
    +curses.raw()
    +

    Enter raw mode. In raw mode, normal line buffering and processing of +interrupt, quit, suspend, and flow control keys are turned off; characters are +presented to curses input functions one by one.

    +
    + +
    +
    +curses.reset_prog_mode()
    +

    Restore the terminal to “program” mode, as previously saved by +def_prog_mode().

    +
    + +
    +
    +curses.reset_shell_mode()
    +

    Restore the terminal to “shell” mode, as previously saved by +def_shell_mode().

    +
    + +
    +
    +curses.resetty()
    +

    Restore the state of the terminal modes to what it was at the last call to +savetty().

    +
    + +
    +
    +curses.resize_term(nlines, ncols)
    +

    Backend function used by resizeterm(), performing most of the work; +when resizing the windows, resize_term() blank-fills the areas that are +extended. The calling application should fill in these areas with +appropriate data. The resize_term() function attempts to resize all +windows. However, due to the calling convention of pads, it is not possible +to resize these without additional interaction with the application.

    +
    + +
    +
    +curses.resizeterm(nlines, ncols)
    +

    Resize the standard and current windows to the specified dimensions, and +adjusts other bookkeeping data used by the curses library that record the +window dimensions (in particular the SIGWINCH handler).

    +
    + +
    +
    +curses.savetty()
    +

    Save the current state of the terminal modes in a buffer, usable by +resetty().

    +
    + +
    +
    +curses.setsyx(y, x)
    +

    Set the virtual screen cursor to y, x. If y and x are both -1, then +leaveok is set True.

    +
    + +
    +
    +curses.setupterm(term=None, fd=-1)
    +

    Initialize the terminal. term is a string giving +the terminal name, or None; if omitted or None, the value of the +TERM environment variable will be used. fd is the +file descriptor to which any initialization sequences will be sent; if not +supplied or -1, the file descriptor for sys.stdout will be used.

    +
    + +
    +
    +curses.start_color()
    +

    Must be called if the programmer wants to use colors, and before any other color +manipulation routine is called. It is good practice to call this routine right +after initscr().

    +

    start_color() initializes eight basic colors (black, red, green, yellow, +blue, magenta, cyan, and white), and two global variables in the curses +module, COLORS and COLOR_PAIRS, containing the maximum number +of colors and color-pairs the terminal can support. It also restores the colors +on the terminal to the values they had when the terminal was just turned on.

    +
    + +
    +
    +curses.termattrs()
    +

    Return a logical OR of all video attributes supported by the terminal. This +information is useful when a curses program needs complete control over the +appearance of the screen.

    +
    + +
    +
    +curses.termname()
    +

    Return the value of the environment variable TERM, as a bytes object, +truncated to 14 characters.

    +
    + +
    +
    +curses.tigetflag(capname)
    +

    Return the value of the Boolean capability corresponding to the terminfo +capability name capname as an integer. Return the value -1 if capname is not a +Boolean capability, or 0 if it is canceled or absent from the terminal +description.

    +
    + +
    +
    +curses.tigetnum(capname)
    +

    Return the value of the numeric capability corresponding to the terminfo +capability name capname as an integer. Return the value -2 if capname is not a +numeric capability, or -1 if it is canceled or absent from the terminal +description.

    +
    + +
    +
    +curses.tigetstr(capname)
    +

    Return the value of the string capability corresponding to the terminfo +capability name capname as a bytes object. Return None if capname +is not a terminfo “string capability”, or is canceled or absent from the +terminal description.

    +
    + +
    +
    +curses.tparm(str[, ...])
    +

    Instantiate the bytes object str with the supplied parameters, where str should +be a parameterized string obtained from the terminfo database. E.g. +tparm(tigetstr("cup"), 5, 3) could result in b'\033[6;4H', the exact +result depending on terminal type.

    +
    + +
    +
    +curses.typeahead(fd)
    +

    Specify that the file descriptor fd be used for typeahead checking. If fd +is -1, then no typeahead checking is done.

    +

    The curses library does “line-breakout optimization” by looking for typeahead +periodically while updating the screen. If input is found, and it is coming +from a tty, the current update is postponed until refresh or doupdate is called +again, allowing faster response to commands typed in advance. This function +allows specifying a different file descriptor for typeahead checking.

    +
    + +
    +
    +curses.unctrl(ch)
    +

    Return a bytes object which is a printable representation of the character ch. +Control characters are represented as a caret followed by the character, for +example as b'^C'. Printing characters are left as they are.

    +
    + +
    +
    +curses.ungetch(ch)
    +

    Push ch so the next getch() will return it.

    +
    +

    Note

    +

    Only one ch can be pushed before getch() is called.

    +
    +
    + +
    +
    +curses.update_lines_cols()
    +

    Update LINES and COLS. Useful for detecting manual screen resize.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +curses.unget_wch(ch)
    +

    Push ch so the next get_wch() will return it.

    +
    +

    Note

    +

    Only one ch can be pushed before get_wch() is called.

    +
    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +curses.ungetmouse(id, x, y, z, bstate)
    +

    Push a KEY_MOUSE event onto the input queue, associating the given +state data with it.

    +
    + +
    +
    +curses.use_env(flag)
    +

    If used, this function should be called before initscr() or newterm are +called. When flag is False, the values of lines and columns specified in the +terminfo database will be used, even if environment variables LINES +and COLUMNS (used by default) are set, or if curses is running in a +window (in which case default behavior would be to use the window size if +LINES and COLUMNS are not set).

    +
    + +
    +
    +curses.use_default_colors()
    +

    Allow use of default values for colors on terminals supporting this feature. Use +this to support transparency in your application. The default color is assigned +to the color number -1. After calling this function, init_pair(x, +curses.COLOR_RED, -1) initializes, for instance, color pair x to a red +foreground color on the default background.

    +
    + +
    +
    +curses.wrapper(func, ...)
    +

    Initialize curses and call another callable object, func, which should be the +rest of your curses-using application. If the application raises an exception, +this function will restore the terminal to a sane state before re-raising the +exception and generating a traceback. The callable object func is then passed +the main window ‘stdscr’ as its first argument, followed by any other arguments +passed to wrapper(). Before calling func, wrapper() turns on +cbreak mode, turns off echo, enables the terminal keypad, and initializes colors +if the terminal has color support. On exit (whether normally or by exception) +it restores cooked mode, turns on echo, and disables the terminal keypad.

    +
    + +
    +
    +

    Window Objects

    +

    Window objects, as returned by initscr() and newwin() above, have +the following methods and attributes:

    +
    +
    +window.addch(ch[, attr])
    +
    +window.addch(y, x, ch[, attr])
    +

    Paint character ch at (y, x) with attributes attr, overwriting any +character previously painter at that location. By default, the character +position and attributes are the current settings for the window object.

    +
    +

    Note

    +

    Writing outside the window, subwindow, or pad raises a curses.error. +Attempting to write to the lower right corner of a window, subwindow, +or pad will cause an exception to be raised after the character is printed.

    +
    +
    + +
    +
    +window.addnstr(str, n[, attr])
    +
    +window.addnstr(y, x, str, n[, attr])
    +

    Paint at most n characters of the character string str at +(y, x) with attributes +attr, overwriting anything previously on the display.

    +
    + +
    +
    +window.addstr(str[, attr])
    +
    +window.addstr(y, x, str[, attr])
    +

    Paint the character string str at (y, x) with attributes +attr, overwriting anything previously on the display.

    +
    +

    Note

    +

    Writing outside the window, subwindow, or pad raises curses.error. +Attempting to write to the lower right corner of a window, subwindow, +or pad will cause an exception to be raised after the string is printed.

    +
    +
    + +
    +
    +window.attroff(attr)
    +

    Remove attribute attr from the “background” set applied to all writes to the +current window.

    +
    + +
    +
    +window.attron(attr)
    +

    Add attribute attr from the “background” set applied to all writes to the +current window.

    +
    + +
    +
    +window.attrset(attr)
    +

    Set the “background” set of attributes to attr. This set is initially +0 (no attributes).

    +
    + +
    +
    +window.bkgd(ch[, attr])
    +

    Set the background property of the window to the character ch, with +attributes attr. The change is then applied to every character position in +that window:

    +
      +
    • The attribute of every character in the window is changed to the new +background attribute.

    • +
    • Wherever the former background character appears, it is changed to the new +background character.

    • +
    +
    + +
    +
    +window.bkgdset(ch[, attr])
    +

    Set the window’s background. A window’s background consists of a character and +any combination of attributes. The attribute part of the background is combined +(OR’ed) with all non-blank characters that are written into the window. Both +the character and attribute parts of the background are combined with the blank +characters. The background becomes a property of the character and moves with +the character through any scrolling and insert/delete line/character operations.

    +
    + +
    +
    +window.border([ls[, rs[, ts[, bs[, tl[, tr[, bl[, br]]]]]]]])
    +

    Draw a border around the edges of the window. Each parameter specifies the +character to use for a specific part of the border; see the table below for more +details.

    +
    +

    Note

    +

    A 0 value for any parameter will cause the default character to be used for +that parameter. Keyword parameters can not be used. The defaults are listed +in this table:

    +
    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    Description

    Default value

    ls

    Left side

    ACS_VLINE

    rs

    Right side

    ACS_VLINE

    ts

    Top

    ACS_HLINE

    bs

    Bottom

    ACS_HLINE

    tl

    Upper-left corner

    ACS_ULCORNER

    tr

    Upper-right corner

    ACS_URCORNER

    bl

    Bottom-left corner

    ACS_LLCORNER

    br

    Bottom-right corner

    ACS_LRCORNER

    +
    + +
    +
    +window.box([vertch, horch])
    +

    Similar to border(), but both ls and rs are vertch and both ts and +bs are horch. The default corner characters are always used by this function.

    +
    + +
    +
    +window.chgat(attr)
    +
    +window.chgat(num, attr)
    +
    +window.chgat(y, x, attr)
    +
    +window.chgat(y, x, num, attr)
    +

    Set the attributes of num characters at the current cursor position, or at +position (y, x) if supplied. If num is not given or is -1, +the attribute will be set on all the characters to the end of the line. This +function moves cursor to position (y, x) if supplied. The changed line +will be touched using the touchline() method so that the contents will +be redisplayed by the next window refresh.

    +
    + +
    +
    +window.clear()
    +

    Like erase(), but also cause the whole window to be repainted upon next +call to refresh().

    +
    + +
    +
    +window.clearok(flag)
    +

    If flag is True, the next call to refresh() will clear the window +completely.

    +
    + +
    +
    +window.clrtobot()
    +

    Erase from cursor to the end of the window: all lines below the cursor are +deleted, and then the equivalent of clrtoeol() is performed.

    +
    + +
    +
    +window.clrtoeol()
    +

    Erase from cursor to the end of the line.

    +
    + +
    +
    +window.cursyncup()
    +

    Update the current cursor position of all the ancestors of the window to +reflect the current cursor position of the window.

    +
    + +
    +
    +window.delch([y, x])
    +

    Delete any character at (y, x).

    +
    + +
    +
    +window.deleteln()
    +

    Delete the line under the cursor. All following lines are moved up by one line.

    +
    + +
    +
    +window.derwin(begin_y, begin_x)
    +
    +window.derwin(nlines, ncols, begin_y, begin_x)
    +

    An abbreviation for “derive window”, derwin() is the same as calling +subwin(), except that begin_y and begin_x are relative to the origin +of the window, rather than relative to the entire screen. Return a window +object for the derived window.

    +
    + +
    +
    +window.echochar(ch[, attr])
    +

    Add character ch with attribute attr, and immediately call refresh() +on the window.

    +
    + +
    +
    +window.enclose(y, x)
    +

    Test whether the given pair of screen-relative character-cell coordinates are +enclosed by the given window, returning True or False. It is useful for +determining what subset of the screen windows enclose the location of a mouse +event.

    +
    + +
    +
    +window.encoding
    +

    Encoding used to encode method arguments (Unicode strings and characters). +The encoding attribute is inherited from the parent window when a subwindow +is created, for example with window.subwin(). By default, the locale +encoding is used (see locale.getpreferredencoding()).

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +window.erase()
    +

    Clear the window.

    +
    + +
    +
    +window.getbegyx()
    +

    Return a tuple (y, x) of co-ordinates of upper-left corner.

    +
    + +
    +
    +window.getbkgd()
    +

    Return the given window’s current background character/attribute pair.

    +
    + +
    +
    +window.getch([y, x])
    +

    Get a character. Note that the integer returned does not have to be in ASCII +range: function keys, keypad keys and so on are represented by numbers higher +than 255. In no-delay mode, return -1 if there is no input, otherwise +wait until a key is pressed.

    +
    + +
    +
    +window.get_wch([y, x])
    +

    Get a wide character. Return a character for most keys, or an integer for +function keys, keypad keys, and other special keys. +In no-delay mode, raise an exception if there is no input.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +window.getkey([y, x])
    +

    Get a character, returning a string instead of an integer, as getch() +does. Function keys, keypad keys and other special keys return a multibyte +string containing the key name. In no-delay mode, raise an exception if +there is no input.

    +
    + +
    +
    +window.getmaxyx()
    +

    Return a tuple (y, x) of the height and width of the window.

    +
    + +
    +
    +window.getparyx()
    +

    Return the beginning coordinates of this window relative to its parent window +as a tuple (y, x). Return (-1, -1) if this window has no +parent.

    +
    + +
    +
    +window.getstr()
    +
    +window.getstr(n)
    +
    +window.getstr(y, x)
    +
    +window.getstr(y, x, n)
    +

    Read a bytes object from the user, with primitive line editing capacity.

    +
    + +
    +
    +window.getyx()
    +

    Return a tuple (y, x) of current cursor position relative to the window’s +upper-left corner.

    +
    + +
    +
    +window.hline(ch, n)
    +
    +window.hline(y, x, ch, n)
    +

    Display a horizontal line starting at (y, x) with length n consisting of +the character ch.

    +
    + +
    +
    +window.idcok(flag)
    +

    If flag is False, curses no longer considers using the hardware insert/delete +character feature of the terminal; if flag is True, use of character insertion +and deletion is enabled. When curses is first initialized, use of character +insert/delete is enabled by default.

    +
    + +
    +
    +window.idlok(flag)
    +

    If flag is True, curses will try and use hardware line +editing facilities. Otherwise, line insertion/deletion are disabled.

    +
    + +
    +
    +window.immedok(flag)
    +

    If flag is True, any change in the window image automatically causes the +window to be refreshed; you no longer have to call refresh() yourself. +However, it may degrade performance considerably, due to repeated calls to +wrefresh. This option is disabled by default.

    +
    + +
    +
    +window.inch([y, x])
    +

    Return the character at the given position in the window. The bottom 8 bits are +the character proper, and upper bits are the attributes.

    +
    + +
    +
    +window.insch(ch[, attr])
    +
    +window.insch(y, x, ch[, attr])
    +

    Paint character ch at (y, x) with attributes attr, moving the line from +position x right by one character.

    +
    + +
    +
    +window.insdelln(nlines)
    +

    Insert nlines lines into the specified window above the current line. The +nlines bottom lines are lost. For negative nlines, delete nlines lines +starting with the one under the cursor, and move the remaining lines up. The +bottom nlines lines are cleared. The current cursor position remains the +same.

    +
    + +
    +
    +window.insertln()
    +

    Insert a blank line under the cursor. All following lines are moved down by one +line.

    +
    + +
    +
    +window.insnstr(str, n[, attr])
    +
    +window.insnstr(y, x, str, n[, attr])
    +

    Insert a character string (as many characters as will fit on the line) before +the character under the cursor, up to n characters. If n is zero or +negative, the entire string is inserted. All characters to the right of the +cursor are shifted right, with the rightmost characters on the line being lost. +The cursor position does not change (after moving to y, x, if specified).

    +
    + +
    +
    +window.insstr(str[, attr])
    +
    +window.insstr(y, x, str[, attr])
    +

    Insert a character string (as many characters as will fit on the line) before +the character under the cursor. All characters to the right of the cursor are +shifted right, with the rightmost characters on the line being lost. The cursor +position does not change (after moving to y, x, if specified).

    +
    + +
    +
    +window.instr([n])
    +
    +window.instr(y, x[, n])
    +

    Return a bytes object of characters, extracted from the window starting at the +current cursor position, or at y, x if specified. Attributes are stripped +from the characters. If n is specified, instr() returns a string +at most n characters long (exclusive of the trailing NUL).

    +
    + +
    +
    +window.is_linetouched(line)
    +

    Return True if the specified line was modified since the last call to +refresh(); otherwise return False. Raise a curses.error +exception if line is not valid for the given window.

    +
    + +
    +
    +window.is_wintouched()
    +

    Return True if the specified window was modified since the last call to +refresh(); otherwise return False.

    +
    + +
    +
    +window.keypad(flag)
    +

    If flag is True, escape sequences generated by some keys (keypad, function keys) +will be interpreted by curses. If flag is False, escape sequences will be +left as is in the input stream.

    +
    + +
    +
    +window.leaveok(flag)
    +

    If flag is True, cursor is left where it is on update, instead of being at “cursor +position.” This reduces cursor movement where possible. If possible the cursor +will be made invisible.

    +

    If flag is False, cursor will always be at “cursor position” after an update.

    +
    + +
    +
    +window.move(new_y, new_x)
    +

    Move cursor to (new_y, new_x).

    +
    + +
    +
    +window.mvderwin(y, x)
    +

    Move the window inside its parent window. The screen-relative parameters of +the window are not changed. This routine is used to display different parts of +the parent window at the same physical position on the screen.

    +
    + +
    +
    +window.mvwin(new_y, new_x)
    +

    Move the window so its upper-left corner is at (new_y, new_x).

    +
    + +
    +
    +window.nodelay(flag)
    +

    If flag is True, getch() will be non-blocking.

    +
    + +
    +
    +window.notimeout(flag)
    +

    If flag is True, escape sequences will not be timed out.

    +

    If flag is False, after a few milliseconds, an escape sequence will not be +interpreted, and will be left in the input stream as is.

    +
    + +
    +
    +window.noutrefresh()
    +

    Mark for refresh but wait. This function updates the data structure +representing the desired state of the window, but does not force an update of +the physical screen. To accomplish that, call doupdate().

    +
    + +
    +
    +window.overlay(destwin[, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol])
    +

    Overlay the window on top of destwin. The windows need not be the same size, +only the overlapping region is copied. This copy is non-destructive, which means +that the current background character does not overwrite the old contents of +destwin.

    +

    To get fine-grained control over the copied region, the second form of +overlay() can be used. sminrow and smincol are the upper-left +coordinates of the source window, and the other variables mark a rectangle in +the destination window.

    +
    + +
    +
    +window.overwrite(destwin[, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol])
    +

    Overwrite the window on top of destwin. The windows need not be the same size, +in which case only the overlapping region is copied. This copy is destructive, +which means that the current background character overwrites the old contents of +destwin.

    +

    To get fine-grained control over the copied region, the second form of +overwrite() can be used. sminrow and smincol are the upper-left +coordinates of the source window, the other variables mark a rectangle in the +destination window.

    +
    + +
    +
    +window.putwin(file)
    +

    Write all data associated with the window into the provided file object. This +information can be later retrieved using the getwin() function.

    +
    + +
    +
    +window.redrawln(beg, num)
    +

    Indicate that the num screen lines, starting at line beg, are corrupted and +should be completely redrawn on the next refresh() call.

    +
    + +
    +
    +window.redrawwin()
    +

    Touch the entire window, causing it to be completely redrawn on the next +refresh() call.

    +
    + +
    +
    +window.refresh([pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol])
    +

    Update the display immediately (sync actual screen with previous +drawing/deleting methods).

    +

    The 6 optional arguments can only be specified when the window is a pad created +with newpad(). The additional parameters are needed to indicate what part +of the pad and screen are involved. pminrow and pmincol specify the upper +left-hand corner of the rectangle to be displayed in the pad. sminrow, +smincol, smaxrow, and smaxcol specify the edges of the rectangle to be +displayed on the screen. The lower right-hand corner of the rectangle to be +displayed in the pad is calculated from the screen coordinates, since the +rectangles must be the same size. Both rectangles must be entirely contained +within their respective structures. Negative values of pminrow, pmincol, +sminrow, or smincol are treated as if they were zero.

    +
    + +
    +
    +window.resize(nlines, ncols)
    +

    Reallocate storage for a curses window to adjust its dimensions to the +specified values. If either dimension is larger than the current values, the +window’s data is filled with blanks that have the current background +rendition (as set by bkgdset()) merged into them.

    +
    + +
    +
    +window.scroll([lines=1])
    +

    Scroll the screen or scrolling region upward by lines lines.

    +
    + +
    +
    +window.scrollok(flag)
    +

    Control what happens when the cursor of a window is moved off the edge of the +window or scrolling region, either as a result of a newline action on the bottom +line, or typing the last character of the last line. If flag is False, the +cursor is left on the bottom line. If flag is True, the window is scrolled up +one line. Note that in order to get the physical scrolling effect on the +terminal, it is also necessary to call idlok().

    +
    + +
    +
    +window.setscrreg(top, bottom)
    +

    Set the scrolling region from line top to line bottom. All scrolling actions +will take place in this region.

    +
    + +
    +
    +window.standend()
    +

    Turn off the standout attribute. On some terminals this has the side effect of +turning off all attributes.

    +
    + +
    +
    +window.standout()
    +

    Turn on attribute A_STANDOUT.

    +
    + +
    +
    +window.subpad(begin_y, begin_x)
    +
    +window.subpad(nlines, ncols, begin_y, begin_x)
    +

    Return a sub-window, whose upper-left corner is at (begin_y, begin_x), and +whose width/height is ncols/nlines.

    +
    + +
    +
    +window.subwin(begin_y, begin_x)
    +
    +window.subwin(nlines, ncols, begin_y, begin_x)
    +

    Return a sub-window, whose upper-left corner is at (begin_y, begin_x), and +whose width/height is ncols/nlines.

    +

    By default, the sub-window will extend from the specified position to the lower +right corner of the window.

    +
    + +
    +
    +window.syncdown()
    +

    Touch each location in the window that has been touched in any of its ancestor +windows. This routine is called by refresh(), so it should almost never +be necessary to call it manually.

    +
    + +
    +
    +window.syncok(flag)
    +

    If flag is True, then syncup() is called automatically +whenever there is a change in the window.

    +
    + +
    +
    +window.syncup()
    +

    Touch all locations in ancestors of the window that have been changed in the +window.

    +
    + +
    +
    +window.timeout(delay)
    +

    Set blocking or non-blocking read behavior for the window. If delay is +negative, blocking read is used (which will wait indefinitely for input). If +delay is zero, then non-blocking read is used, and getch() will +return -1 if no input is waiting. If delay is positive, then +getch() will block for delay milliseconds, and return -1 if there is +still no input at the end of that time.

    +
    + +
    +
    +window.touchline(start, count[, changed])
    +

    Pretend count lines have been changed, starting with line start. If +changed is supplied, it specifies whether the affected lines are marked as +having been changed (changed=True) or unchanged (changed=False).

    +
    + +
    +
    +window.touchwin()
    +

    Pretend the whole window has been changed, for purposes of drawing +optimizations.

    +
    + +
    +
    +window.untouchwin()
    +

    Mark all lines in the window as unchanged since the last call to +refresh().

    +
    + +
    +
    +window.vline(ch, n)
    +
    +window.vline(y, x, ch, n)
    +

    Display a vertical line starting at (y, x) with length n consisting of the +character ch.

    +
    + +
    +
    +

    Constants

    +

    The curses module defines the following data members:

    +
    +
    +curses.ERR
    +

    Some curses routines that return an integer, such as getch(), return +ERR upon failure.

    +
    + +
    +
    +curses.OK
    +

    Some curses routines that return an integer, such as napms(), return +OK upon success.

    +
    + +
    +
    +curses.version
    +

    A bytes object representing the current version of the module. Also available as +__version__.

    +
    + +

    Some constants are available to specify character cell attributes. +The exact constants available are system dependent.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Attribute

    Meaning

    A_ALTCHARSET

    Alternate character set mode

    A_BLINK

    Blink mode

    A_BOLD

    Bold mode

    A_DIM

    Dim mode

    A_INVIS

    Invisible or blank mode

    A_ITALIC

    Italic mode

    A_NORMAL

    Normal attribute

    A_PROTECT

    Protected mode

    A_REVERSE

    Reverse background and +foreground colors

    A_STANDOUT

    Standout mode

    A_UNDERLINE

    Underline mode

    A_HORIZONTAL

    Horizontal highlight

    A_LEFT

    Left highlight

    A_LOW

    Low highlight

    A_RIGHT

    Right highlight

    A_TOP

    Top highlight

    A_VERTICAL

    Vertical highlight

    A_CHARTEXT

    Bit-mask to extract a +character

    +
    +

    New in version 3.7: A_ITALIC was added.

    +
    +

    Several constants are available to extract corresponding attributes returned +by some methods.

    + ++++ + + + + + + + + + + + + + + + + +

    Bit-mask

    Meaning

    A_ATTRIBUTES

    Bit-mask to extract +attributes

    A_CHARTEXT

    Bit-mask to extract a +character

    A_COLOR

    Bit-mask to extract +color-pair field information

    +

    Keys are referred to by integer constants with names starting with KEY_. +The exact keycaps available are system dependent.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Key constant

    Key

    KEY_MIN

    Minimum key value

    KEY_BREAK

    Break key (unreliable)

    KEY_DOWN

    Down-arrow

    KEY_UP

    Up-arrow

    KEY_LEFT

    Left-arrow

    KEY_RIGHT

    Right-arrow

    KEY_HOME

    Home key (upward+left arrow)

    KEY_BACKSPACE

    Backspace (unreliable)

    KEY_F0

    Function keys. Up to 64 function keys are +supported.

    KEY_Fn

    Value of function key n

    KEY_DL

    Delete line

    KEY_IL

    Insert line

    KEY_DC

    Delete character

    KEY_IC

    Insert char or enter insert mode

    KEY_EIC

    Exit insert char mode

    KEY_CLEAR

    Clear screen

    KEY_EOS

    Clear to end of screen

    KEY_EOL

    Clear to end of line

    KEY_SF

    Scroll 1 line forward

    KEY_SR

    Scroll 1 line backward (reverse)

    KEY_NPAGE

    Next page

    KEY_PPAGE

    Previous page

    KEY_STAB

    Set tab

    KEY_CTAB

    Clear tab

    KEY_CATAB

    Clear all tabs

    KEY_ENTER

    Enter or send (unreliable)

    KEY_SRESET

    Soft (partial) reset (unreliable)

    KEY_RESET

    Reset or hard reset (unreliable)

    KEY_PRINT

    Print

    KEY_LL

    Home down or bottom (lower left)

    KEY_A1

    Upper left of keypad

    KEY_A3

    Upper right of keypad

    KEY_B2

    Center of keypad

    KEY_C1

    Lower left of keypad

    KEY_C3

    Lower right of keypad

    KEY_BTAB

    Back tab

    KEY_BEG

    Beg (beginning)

    KEY_CANCEL

    Cancel

    KEY_CLOSE

    Close

    KEY_COMMAND

    Cmd (command)

    KEY_COPY

    Copy

    KEY_CREATE

    Create

    KEY_END

    End

    KEY_EXIT

    Exit

    KEY_FIND

    Find

    KEY_HELP

    Help

    KEY_MARK

    Mark

    KEY_MESSAGE

    Message

    KEY_MOVE

    Move

    KEY_NEXT

    Next

    KEY_OPEN

    Open

    KEY_OPTIONS

    Options

    KEY_PREVIOUS

    Prev (previous)

    KEY_REDO

    Redo

    KEY_REFERENCE

    Ref (reference)

    KEY_REFRESH

    Refresh

    KEY_REPLACE

    Replace

    KEY_RESTART

    Restart

    KEY_RESUME

    Resume

    KEY_SAVE

    Save

    KEY_SBEG

    Shifted Beg (beginning)

    KEY_SCANCEL

    Shifted Cancel

    KEY_SCOMMAND

    Shifted Command

    KEY_SCOPY

    Shifted Copy

    KEY_SCREATE

    Shifted Create

    KEY_SDC

    Shifted Delete char

    KEY_SDL

    Shifted Delete line

    KEY_SELECT

    Select

    KEY_SEND

    Shifted End

    KEY_SEOL

    Shifted Clear line

    KEY_SEXIT

    Shifted Exit

    KEY_SFIND

    Shifted Find

    KEY_SHELP

    Shifted Help

    KEY_SHOME

    Shifted Home

    KEY_SIC

    Shifted Input

    KEY_SLEFT

    Shifted Left arrow

    KEY_SMESSAGE

    Shifted Message

    KEY_SMOVE

    Shifted Move

    KEY_SNEXT

    Shifted Next

    KEY_SOPTIONS

    Shifted Options

    KEY_SPREVIOUS

    Shifted Prev

    KEY_SPRINT

    Shifted Print

    KEY_SREDO

    Shifted Redo

    KEY_SREPLACE

    Shifted Replace

    KEY_SRIGHT

    Shifted Right arrow

    KEY_SRSUME

    Shifted Resume

    KEY_SSAVE

    Shifted Save

    KEY_SSUSPEND

    Shifted Suspend

    KEY_SUNDO

    Shifted Undo

    KEY_SUSPEND

    Suspend

    KEY_UNDO

    Undo

    KEY_MOUSE

    Mouse event has occurred

    KEY_RESIZE

    Terminal resize event

    KEY_MAX

    Maximum key value

    +

    On VT100s and their software emulations, such as X terminal emulators, there are +normally at least four function keys (KEY_F1, KEY_F2, +KEY_F3, KEY_F4) available, and the arrow keys mapped to +KEY_UP, KEY_DOWN, KEY_LEFT and KEY_RIGHT in +the obvious way. If your machine has a PC keyboard, it is safe to expect arrow +keys and twelve function keys (older PC keyboards may have only ten function +keys); also, the following keypad mappings are standard:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + +

    Keycap

    Constant

    Insert

    KEY_IC

    Delete

    KEY_DC

    Home

    KEY_HOME

    End

    KEY_END

    Page Up

    KEY_PPAGE

    Page Down

    KEY_NPAGE

    +

    The following table lists characters from the alternate character set. These are +inherited from the VT100 terminal, and will generally be available on software +emulations such as X terminals. When there is no graphic available, curses +falls back on a crude printable ASCII approximation.

    +
    +

    Note

    +

    These are available only after initscr() has been called.

    +
    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    ACS code

    Meaning

    ACS_BBSS

    alternate name for upper right corner

    ACS_BLOCK

    solid square block

    ACS_BOARD

    board of squares

    ACS_BSBS

    alternate name for horizontal line

    ACS_BSSB

    alternate name for upper left corner

    ACS_BSSS

    alternate name for top tee

    ACS_BTEE

    bottom tee

    ACS_BULLET

    bullet

    ACS_CKBOARD

    checker board (stipple)

    ACS_DARROW

    arrow pointing down

    ACS_DEGREE

    degree symbol

    ACS_DIAMOND

    diamond

    ACS_GEQUAL

    greater-than-or-equal-to

    ACS_HLINE

    horizontal line

    ACS_LANTERN

    lantern symbol

    ACS_LARROW

    left arrow

    ACS_LEQUAL

    less-than-or-equal-to

    ACS_LLCORNER

    lower left-hand corner

    ACS_LRCORNER

    lower right-hand corner

    ACS_LTEE

    left tee

    ACS_NEQUAL

    not-equal sign

    ACS_PI

    letter pi

    ACS_PLMINUS

    plus-or-minus sign

    ACS_PLUS

    big plus sign

    ACS_RARROW

    right arrow

    ACS_RTEE

    right tee

    ACS_S1

    scan line 1

    ACS_S3

    scan line 3

    ACS_S7

    scan line 7

    ACS_S9

    scan line 9

    ACS_SBBS

    alternate name for lower right corner

    ACS_SBSB

    alternate name for vertical line

    ACS_SBSS

    alternate name for right tee

    ACS_SSBB

    alternate name for lower left corner

    ACS_SSBS

    alternate name for bottom tee

    ACS_SSSB

    alternate name for left tee

    ACS_SSSS

    alternate name for crossover or big plus

    ACS_STERLING

    pound sterling

    ACS_TTEE

    top tee

    ACS_UARROW

    up arrow

    ACS_ULCORNER

    upper left corner

    ACS_URCORNER

    upper right corner

    ACS_VLINE

    vertical line

    +

    The following table lists the predefined colors:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Constant

    Color

    COLOR_BLACK

    Black

    COLOR_BLUE

    Blue

    COLOR_CYAN

    Cyan (light greenish blue)

    COLOR_GREEN

    Green

    COLOR_MAGENTA

    Magenta (purplish red)

    COLOR_RED

    Red

    COLOR_WHITE

    White

    COLOR_YELLOW

    Yellow

    +
    +
    +
    +

    curses.textpad — Text input widget for curses programs

    +

    The curses.textpad module provides a Textbox class that handles +elementary text editing in a curses window, supporting a set of keybindings +resembling those of Emacs (thus, also of Netscape Navigator, BBedit 6.x, +FrameMaker, and many other programs). The module also provides a +rectangle-drawing function useful for framing text boxes or for other purposes.

    +

    The module curses.textpad defines the following function:

    +
    +
    +curses.textpad.rectangle(win, uly, ulx, lry, lrx)
    +

    Draw a rectangle. The first argument must be a window object; the remaining +arguments are coordinates relative to that window. The second and third +arguments are the y and x coordinates of the upper left hand corner of the +rectangle to be drawn; the fourth and fifth arguments are the y and x +coordinates of the lower right hand corner. The rectangle will be drawn using +VT100/IBM PC forms characters on terminals that make this possible (including +xterm and most other software terminal emulators). Otherwise it will be drawn +with ASCII dashes, vertical bars, and plus signs.

    +
    + +
    +

    Textbox objects

    +

    You can instantiate a Textbox object as follows:

    +
    +
    +class curses.textpad.Textbox(win)
    +

    Return a textbox widget object. The win argument should be a curses +window object in which the textbox is to +be contained. The edit cursor of the textbox is initially located at the +upper left hand corner of the containing window, with coordinates (0, 0). +The instance’s stripspaces flag is initially on.

    +

    Textbox objects have the following methods:

    +
    +
    +edit([validator])
    +

    This is the entry point you will normally use. It accepts editing +keystrokes until one of the termination keystrokes is entered. If +validator is supplied, it must be a function. It will be called for +each keystroke entered with the keystroke as a parameter; command dispatch +is done on the result. This method returns the window contents as a +string; whether blanks in the window are included is affected by the +stripspaces attribute.

    +
    + +
    +
    +do_command(ch)
    +

    Process a single command keystroke. Here are the supported special +keystrokes:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Keystroke

    Action

    Control-A

    Go to left edge of window.

    Control-B

    Cursor left, wrapping to previous line if +appropriate.

    Control-D

    Delete character under cursor.

    Control-E

    Go to right edge (stripspaces off) or end +of line (stripspaces on).

    Control-F

    Cursor right, wrapping to next line when +appropriate.

    Control-G

    Terminate, returning the window contents.

    Control-H

    Delete character backward.

    Control-J

    Terminate if the window is 1 line, +otherwise insert newline.

    Control-K

    If line is blank, delete it, otherwise +clear to end of line.

    Control-L

    Refresh screen.

    Control-N

    Cursor down; move down one line.

    Control-O

    Insert a blank line at cursor location.

    Control-P

    Cursor up; move up one line.

    +

    Move operations do nothing if the cursor is at an edge where the movement +is not possible. The following synonyms are supported where possible:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + +

    Constant

    Keystroke

    KEY_LEFT

    Control-B

    KEY_RIGHT

    Control-F

    KEY_UP

    Control-P

    KEY_DOWN

    Control-N

    KEY_BACKSPACE

    Control-h

    +

    All other keystrokes are treated as a command to insert the given +character and move right (with line wrapping).

    +
    + +
    +
    +gather()
    +

    Return the window contents as a string; whether blanks in the +window are included is affected by the stripspaces member.

    +
    + +
    +
    +stripspaces
    +

    This attribute is a flag which controls the interpretation of blanks in +the window. When it is on, trailing blanks on each line are ignored; any +cursor motion that would land the cursor on a trailing blank goes to the +end of that line instead, and trailing blanks are stripped when the window +contents are gathered.

    +
    + +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/curses.panel.html b/python-3.7.4-docs-html/library/curses.panel.html new file mode 100644 index 0000000..fe06e7d --- /dev/null +++ b/python-3.7.4-docs-html/library/curses.panel.html @@ -0,0 +1,309 @@ + + + + + + + curses.panel — A panel stack extension for curses — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    curses.panel — A panel stack extension for curses

    +
    +

    Panels are windows with the added feature of depth, so they can be stacked on +top of each other, and only the visible portions of each window will be +displayed. Panels can be added, moved up or down in the stack, and removed.

    +
    +

    Functions

    +

    The module curses.panel defines the following functions:

    +
    +
    +curses.panel.bottom_panel()
    +

    Returns the bottom panel in the panel stack.

    +
    + +
    +
    +curses.panel.new_panel(win)
    +

    Returns a panel object, associating it with the given window win. Be aware +that you need to keep the returned panel object referenced explicitly. If you +don’t, the panel object is garbage collected and removed from the panel stack.

    +
    + +
    +
    +curses.panel.top_panel()
    +

    Returns the top panel in the panel stack.

    +
    + +
    +
    +curses.panel.update_panels()
    +

    Updates the virtual screen after changes in the panel stack. This does not call +curses.doupdate(), so you’ll have to do this yourself.

    +
    + +
    +
    +

    Panel Objects

    +

    Panel objects, as returned by new_panel() above, are windows with a +stacking order. There’s always a window associated with a panel which determines +the content, while the panel methods are responsible for the window’s depth in +the panel stack.

    +

    Panel objects have the following methods:

    +
    +
    +Panel.above()
    +

    Returns the panel above the current panel.

    +
    + +
    +
    +Panel.below()
    +

    Returns the panel below the current panel.

    +
    + +
    +
    +Panel.bottom()
    +

    Push the panel to the bottom of the stack.

    +
    + +
    +
    +Panel.hidden()
    +

    Returns True if the panel is hidden (not visible), False otherwise.

    +
    + +
    +
    +Panel.hide()
    +

    Hide the panel. This does not delete the object, it just makes the window on +screen invisible.

    +
    + +
    +
    +Panel.move(y, x)
    +

    Move the panel to the screen coordinates (y, x).

    +
    + +
    +
    +Panel.replace(win)
    +

    Change the window associated with the panel to the window win.

    +
    + +
    +
    +Panel.set_userptr(obj)
    +

    Set the panel’s user pointer to obj. This is used to associate an arbitrary +piece of data with the panel, and can be any Python object.

    +
    + +
    +
    +Panel.show()
    +

    Display the panel (which might have been hidden).

    +
    + +
    +
    +Panel.top()
    +

    Push panel to the top of the stack.

    +
    + +
    +
    +Panel.userptr()
    +

    Returns the user pointer for the panel. This might be any Python object.

    +
    + +
    +
    +Panel.window()
    +

    Returns the window object associated with the panel.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/custominterp.html b/python-3.7.4-docs-html/library/custominterp.html new file mode 100644 index 0000000..a5ce881 --- /dev/null +++ b/python-3.7.4-docs-html/library/custominterp.html @@ -0,0 +1,197 @@ + + + + + + + Custom Python Interpreters — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Custom Python Interpreters

    +

    The modules described in this chapter allow writing interfaces similar to +Python’s interactive interpreter. If you want a Python interpreter that +supports some special feature in addition to the Python language, you should +look at the code module. (The codeop module is lower-level, used +to support compiling a possibly-incomplete chunk of Python code.)

    +

    The full list of modules described in this chapter is:

    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/dataclasses.html b/python-3.7.4-docs-html/library/dataclasses.html new file mode 100644 index 0000000..880679e --- /dev/null +++ b/python-3.7.4-docs-html/library/dataclasses.html @@ -0,0 +1,769 @@ + + + + + + + dataclasses — Data Classes — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    dataclasses — Data Classes

    +

    Source code: Lib/dataclasses.py

    +
    +

    This module provides a decorator and functions for automatically +adding generated special methods such as __init__() and +__repr__() to user-defined classes. It was originally described +in PEP 557.

    +

    The member variables to use in these generated methods are defined +using PEP 526 type annotations. For example this code:

    +
    @dataclass
    +class InventoryItem:
    +    '''Class for keeping track of an item in inventory.'''
    +    name: str
    +    unit_price: float
    +    quantity_on_hand: int = 0
    +
    +    def total_cost(self) -> float:
    +        return self.unit_price * self.quantity_on_hand
    +
    +
    +

    Will add, among other things, a __init__() that looks like:

    +
    def __init__(self, name: str, unit_price: float, quantity_on_hand: int=0):
    +    self.name = name
    +    self.unit_price = unit_price
    +    self.quantity_on_hand = quantity_on_hand
    +
    +
    +

    Note that this method is automatically added to the class: it is not +directly specified in the InventoryItem definition shown above.

    +
    +

    New in version 3.7.

    +
    +
    +

    Module-level decorators, classes, and functions

    +
    +
    +@dataclasses.dataclass(*, init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False)
    +

    This function is a decorator that is used to add generated +special methods to classes, as described below.

    +

    The dataclass() decorator examines the class to find +fields. A field is defined as class variable that has a +type annotation. With two +exceptions described below, nothing in dataclass() +examines the type specified in the variable annotation.

    +

    The order of the fields in all of the generated methods is the +order in which they appear in the class definition.

    +

    The dataclass() decorator will add various “dunder” methods to +the class, described below. If any of the added methods already +exist on the class, the behavior depends on the parameter, as documented +below. The decorator returns the same class that is called on; no new +class is created.

    +

    If dataclass() is used just as a simple decorator with no parameters, +it acts as if it has the default values documented in this +signature. That is, these three uses of dataclass() are +equivalent:

    +
    @dataclass
    +class C:
    +    ...
    +
    +@dataclass()
    +class C:
    +    ...
    +
    +@dataclass(init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False)
    +class C:
    +   ...
    +
    +
    +

    The parameters to dataclass() are:

    +
      +
    • init: If true (the default), a __init__() method will be +generated.

      +

      If the class already defines __init__(), this parameter is +ignored.

      +
    • +
    • repr: If true (the default), a __repr__() method will be +generated. The generated repr string will have the class name and +the name and repr of each field, in the order they are defined in +the class. Fields that are marked as being excluded from the repr +are not included. For example: +InventoryItem(name='widget', unit_price=3.0, quantity_on_hand=10).

      +

      If the class already defines __repr__(), this parameter is +ignored.

      +
    • +
    • eq: If true (the default), an __eq__() method will be +generated. This method compares the class as if it were a tuple +of its fields, in order. Both instances in the comparison must +be of the identical type.

      +

      If the class already defines __eq__(), this parameter is +ignored.

      +
    • +
    • order: If true (the default is False), __lt__(), +__le__(), __gt__(), and __ge__() methods will be +generated. These compare the class as if it were a tuple of its +fields, in order. Both instances in the comparison must be of the +identical type. If order is true and eq is false, a +ValueError is raised.

      +

      If the class already defines any of __lt__(), +__le__(), __gt__(), or __ge__(), then +TypeError is raised.

      +
    • +
    • unsafe_hash: If False (the default), a __hash__() method +is generated according to how eq and frozen are set.

      +

      __hash__() is used by built-in hash(), and when objects are +added to hashed collections such as dictionaries and sets. Having a +__hash__() implies that instances of the class are immutable. +Mutability is a complicated property that depends on the programmer’s +intent, the existence and behavior of __eq__(), and the values of +the eq and frozen flags in the dataclass() decorator.

      +

      By default, dataclass() will not implicitly add a __hash__() +method unless it is safe to do so. Neither will it add or change an +existing explicitly defined __hash__() method. Setting the class +attribute __hash__ = None has a specific meaning to Python, as +described in the __hash__() documentation.

      +

      If __hash__() is not explicit defined, or if it is set to None, +then dataclass() may add an implicit __hash__() method. +Although not recommended, you can force dataclass() to create a +__hash__() method with unsafe_hash=True. This might be the case +if your class is logically immutable but can nonetheless be mutated. +This is a specialized use case and should be considered carefully.

      +

      Here are the rules governing implicit creation of a __hash__() +method. Note that you cannot both have an explicit __hash__() +method in your dataclass and set unsafe_hash=True; this will result +in a TypeError.

      +

      If eq and frozen are both true, by default dataclass() will +generate a __hash__() method for you. If eq is true and +frozen is false, __hash__() will be set to None, marking it +unhashable (which it is, since it is mutable). If eq is false, +__hash__() will be left untouched meaning the __hash__() +method of the superclass will be used (if the superclass is +object, this means it will fall back to id-based hashing).

      +
    • +
    • frozen: If true (the default is False), assigning to fields will +generate an exception. This emulates read-only frozen instances. If +__setattr__() or __delattr__() is defined in the class, then +TypeError is raised. See the discussion below.

    • +
    +

    fields may optionally specify a default value, using normal +Python syntax:

    +
    @dataclass
    +class C:
    +    a: int       # 'a' has no default value
    +    b: int = 0   # assign a default value for 'b'
    +
    +
    +

    In this example, both a and b will be included in the added +__init__() method, which will be defined as:

    +
    def __init__(self, a: int, b: int = 0):
    +
    +
    +

    TypeError will be raised if a field without a default value +follows a field with a default value. This is true either when this +occurs in a single class, or as a result of class inheritance.

    +
    + +
    +
    +dataclasses.field(*, default=MISSING, default_factory=MISSING, repr=True, hash=None, init=True, compare=True, metadata=None)
    +

    For common and simple use cases, no other functionality is +required. There are, however, some dataclass features that +require additional per-field information. To satisfy this need for +additional information, you can replace the default field value +with a call to the provided field() function. For example:

    +
    @dataclass
    +class C:
    +    mylist: List[int] = field(default_factory=list)
    +
    +c = C()
    +c.mylist += [1, 2, 3]
    +
    +
    +

    As shown above, the MISSING value is a sentinel object used to +detect if the default and default_factory parameters are +provided. This sentinel is used because None is a valid value +for default. No code should directly use the MISSING +value.

    +

    The parameters to field() are:

    +
      +
    • default: If provided, this will be the default value for this +field. This is needed because the field() call itself +replaces the normal position of the default value.

    • +
    • default_factory: If provided, it must be a zero-argument +callable that will be called when a default value is needed for +this field. Among other purposes, this can be used to specify +fields with mutable default values, as discussed below. It is an +error to specify both default and default_factory.

    • +
    • init: If true (the default), this field is included as a +parameter to the generated __init__() method.

    • +
    • repr: If true (the default), this field is included in the +string returned by the generated __repr__() method.

    • +
    • compare: If true (the default), this field is included in the +generated equality and comparison methods (__eq__(), +__gt__(), et al.).

    • +
    • hash: This can be a bool or None. If true, this field is +included in the generated __hash__() method. If None (the +default), use the value of compare: this would normally be +the expected behavior. A field should be considered in the hash +if it’s used for comparisons. Setting this value to anything +other than None is discouraged.

      +

      One possible reason to set hash=False but compare=True +would be if a field is expensive to compute a hash value for, +that field is needed for equality testing, and there are other +fields that contribute to the type’s hash value. Even if a field +is excluded from the hash, it will still be used for comparisons.

      +
    • +
    • metadata: This can be a mapping or None. None is treated as +an empty dict. This value is wrapped in +MappingProxyType() to make it read-only, and exposed +on the Field object. It is not used at all by Data +Classes, and is provided as a third-party extension mechanism. +Multiple third-parties can each have their own key, to use as a +namespace in the metadata.

    • +
    +

    If the default value of a field is specified by a call to +field(), then the class attribute for this field will be +replaced by the specified default value. If no default is +provided, then the class attribute will be deleted. The intent is +that after the dataclass() decorator runs, the class +attributes will all contain the default values for the fields, just +as if the default value itself were specified. For example, +after:

    +
    @dataclass
    +class C:
    +    x: int
    +    y: int = field(repr=False)
    +    z: int = field(repr=False, default=10)
    +    t: int = 20
    +
    +
    +

    The class attribute C.z will be 10, the class attribute +C.t will be 20, and the class attributes C.x and +C.y will not be set.

    +
    + +
    +
    +class dataclasses.Field
    +

    Field objects describe each defined field. These objects +are created internally, and are returned by the fields() +module-level method (see below). Users should never instantiate a +Field object directly. Its documented attributes are:

    +
    +
      +
    • name: The name of the field.

    • +
    • type: The type of the field.

    • +
    • default, default_factory, init, repr, hash, +compare, and metadata have the identical meaning and +values as they do in the field() declaration.

    • +
    +
    +

    Other attributes may exist, but they are private and must not be +inspected or relied on.

    +
    + +
    +
    +dataclasses.fields(class_or_instance)
    +

    Returns a tuple of Field objects that define the fields for this +dataclass. Accepts either a dataclass, or an instance of a dataclass. +Raises TypeError if not passed a dataclass or instance of one. +Does not return pseudo-fields which are ClassVar or InitVar.

    +
    + +
    +
    +dataclasses.asdict(instance, *, dict_factory=dict)
    +

    Converts the dataclass instance to a dict (by using the +factory function dict_factory). Each dataclass is converted +to a dict of its fields, as name: value pairs. dataclasses, dicts, +lists, and tuples are recursed into. For example:

    +
    @dataclass
    +class Point:
    +     x: int
    +     y: int
    +
    +@dataclass
    +class C:
    +     mylist: List[Point]
    +
    +p = Point(10, 20)
    +assert asdict(p) == {'x': 10, 'y': 20}
    +
    +c = C([Point(0, 0), Point(10, 4)])
    +assert asdict(c) == {'mylist': [{'x': 0, 'y': 0}, {'x': 10, 'y': 4}]}
    +
    +
    +

    Raises TypeError if instance is not a dataclass instance.

    +
    + +
    +
    +dataclasses.astuple(instance, *, tuple_factory=tuple)
    +

    Converts the dataclass instance to a tuple (by using the +factory function tuple_factory). Each dataclass is converted +to a tuple of its field values. dataclasses, dicts, lists, and +tuples are recursed into.

    +

    Continuing from the previous example:

    +
    assert astuple(p) == (10, 20)
    +assert astuple(c) == ([(0, 0), (10, 4)],)
    +
    +
    +

    Raises TypeError if instance is not a dataclass instance.

    +
    + +
    +
    +dataclasses.make_dataclass(cls_name, fields, *, bases=(), namespace=None, init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False)
    +

    Creates a new dataclass with name cls_name, fields as defined +in fields, base classes as given in bases, and initialized +with a namespace as given in namespace. fields is an +iterable whose elements are each either name, (name, type), +or (name, type, Field). If just name is supplied, +typing.Any is used for type. The values of init, +repr, eq, order, unsafe_hash, and frozen have +the same meaning as they do in dataclass().

    +

    This function is not strictly required, because any Python +mechanism for creating a new class with __annotations__ can +then apply the dataclass() function to convert that class to +a dataclass. This function is provided as a convenience. For +example:

    +
    C = make_dataclass('C',
    +                   [('x', int),
    +                     'y',
    +                    ('z', int, field(default=5))],
    +                   namespace={'add_one': lambda self: self.x + 1})
    +
    +
    +

    Is equivalent to:

    +
    @dataclass
    +class C:
    +    x: int
    +    y: 'typing.Any'
    +    z: int = 5
    +
    +    def add_one(self):
    +        return self.x + 1
    +
    +
    +
    + +
    +
    +dataclasses.replace(instance, **changes)
    +

    Creates a new object of the same type of instance, replacing +fields with values from changes. If instance is not a Data +Class, raises TypeError. If values in changes do not +specify fields, raises TypeError.

    +

    The newly returned object is created by calling the __init__() +method of the dataclass. This ensures that +__post_init__(), if present, is also called.

    +

    Init-only variables without default values, if any exist, must be +specified on the call to replace() so that they can be passed to +__init__() and __post_init__().

    +

    It is an error for changes to contain any fields that are +defined as having init=False. A ValueError will be raised +in this case.

    +

    Be forewarned about how init=False fields work during a call to +replace(). They are not copied from the source object, but +rather are initialized in __post_init__(), if they’re +initialized at all. It is expected that init=False fields will +be rarely and judiciously used. If they are used, it might be wise +to have alternate class constructors, or perhaps a custom +replace() (or similarly named) method which handles instance +copying.

    +
    + +
    +
    +dataclasses.is_dataclass(class_or_instance)
    +

    Returns True if its parameter is a dataclass or an instance of one, +otherwise returns False.

    +

    If you need to know if a class is an instance of a dataclass (and +not a dataclass itself), then add a further check for not +isinstance(obj, type):

    +
    def is_dataclass_instance(obj):
    +    return is_dataclass(obj) and not isinstance(obj, type)
    +
    +
    +
    + +
    +
    +

    Post-init processing

    +

    The generated __init__() code will call a method named +__post_init__(), if __post_init__() is defined on the +class. It will normally be called as self.__post_init__(). +However, if any InitVar fields are defined, they will also be +passed to __post_init__() in the order they were defined in the +class. If no __init__() method is generated, then +__post_init__() will not automatically be called.

    +

    Among other uses, this allows for initializing field values that +depend on one or more other fields. For example:

    +
    @dataclass
    +class C:
    +    a: float
    +    b: float
    +    c: float = field(init=False)
    +
    +    def __post_init__(self):
    +        self.c = self.a + self.b
    +
    +
    +

    See the section below on init-only variables for ways to pass +parameters to __post_init__(). Also see the warning about how +replace() handles init=False fields.

    +
    +
    +

    Class variables

    +

    One of two places where dataclass() actually inspects the type +of a field is to determine if a field is a class variable as defined +in PEP 526. It does this by checking if the type of the field is +typing.ClassVar. If a field is a ClassVar, it is excluded +from consideration as a field and is ignored by the dataclass +mechanisms. Such ClassVar pseudo-fields are not returned by the +module-level fields() function.

    +
    +
    +

    Init-only variables

    +

    The other place where dataclass() inspects a type annotation is to +determine if a field is an init-only variable. It does this by seeing +if the type of a field is of type dataclasses.InitVar. If a field +is an InitVar, it is considered a pseudo-field called an init-only +field. As it is not a true field, it is not returned by the +module-level fields() function. Init-only fields are added as +parameters to the generated __init__() method, and are passed to +the optional __post_init__() method. They are not otherwise used +by dataclasses.

    +

    For example, suppose a field will be initialized from a database, if a +value is not provided when creating the class:

    +
    @dataclass
    +class C:
    +    i: int
    +    j: int = None
    +    database: InitVar[DatabaseType] = None
    +
    +    def __post_init__(self, database):
    +        if self.j is None and database is not None:
    +            self.j = database.lookup('j')
    +
    +c = C(10, database=my_database)
    +
    +
    +

    In this case, fields() will return Field objects for i and +j, but not for database.

    +
    +
    +

    Frozen instances

    +

    It is not possible to create truly immutable Python objects. However, +by passing frozen=True to the dataclass() decorator you can +emulate immutability. In that case, dataclasses will add +__setattr__() and __delattr__() methods to the class. These +methods will raise a FrozenInstanceError when invoked.

    +

    There is a tiny performance penalty when using frozen=True: +__init__() cannot use simple assignment to initialize fields, and +must use object.__setattr__().

    +
    +
    +

    Inheritance

    +

    When the dataclass is being created by the dataclass() decorator, +it looks through all of the class’s base classes in reverse MRO (that +is, starting at object) and, for each dataclass that it finds, +adds the fields from that base class to an ordered mapping of fields. +After all of the base class fields are added, it adds its own fields +to the ordered mapping. All of the generated methods will use this +combined, calculated ordered mapping of fields. Because the fields +are in insertion order, derived classes override base classes. An +example:

    +
    @dataclass
    +class Base:
    +    x: Any = 15.0
    +    y: int = 0
    +
    +@dataclass
    +class C(Base):
    +    z: int = 10
    +    x: int = 15
    +
    +
    +

    The final list of fields is, in order, x, y, z. The final +type of x is int, as specified in class C.

    +

    The generated __init__() method for C will look like:

    +
    def __init__(self, x: int = 15, y: int = 0, z: int = 10):
    +
    +
    +
    +
    +

    Default factory functions

    +
    +

    If a field() specifies a default_factory, it is called with +zero arguments when a default value for the field is needed. For +example, to create a new instance of a list, use:

    +
    mylist: list = field(default_factory=list)
    +
    +
    +

    If a field is excluded from __init__() (using init=False) +and the field also specifies default_factory, then the default +factory function will always be called from the generated +__init__() function. This happens because there is no other +way to give the field an initial value.

    +
    +
    +
    +

    Mutable default values

    +
    +

    Python stores default member variable values in class attributes. +Consider this example, not using dataclasses:

    +
    class C:
    +    x = []
    +    def add(self, element):
    +        self.x.append(element)
    +
    +o1 = C()
    +o2 = C()
    +o1.add(1)
    +o2.add(2)
    +assert o1.x == [1, 2]
    +assert o1.x is o2.x
    +
    +
    +

    Note that the two instances of class C share the same class +variable x, as expected.

    +

    Using dataclasses, if this code was valid:

    +
    @dataclass
    +class D:
    +    x: List = []
    +    def add(self, element):
    +        self.x += element
    +
    +
    +

    it would generate code similar to:

    +
    class D:
    +    x = []
    +    def __init__(self, x=x):
    +        self.x = x
    +    def add(self, element):
    +        self.x += element
    +
    +assert D().x is D().x
    +
    +
    +

    This has the same issue as the original example using class C. +That is, two instances of class D that do not specify a value for +x when creating a class instance will share the same copy of +x. Because dataclasses just use normal Python class creation +they also share this behavior. There is no general way for Data +Classes to detect this condition. Instead, dataclasses will raise a +TypeError if it detects a default parameter of type list, +dict, or set. This is a partial solution, but it does protect +against many common errors.

    +

    Using default factory functions is a way to create new instances of +mutable types as default values for fields:

    +
    @dataclass
    +class D:
    +    x: list = field(default_factory=list)
    +
    +assert D().x is not D().x
    +
    +
    +
    +
    +
    +

    Exceptions

    +
    +
    +exception dataclasses.FrozenInstanceError
    +

    Raised when an implicitly defined __setattr__() or +__delattr__() is called on a dataclass which was defined with +frozen=True.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/datatypes.html b/python-3.7.4-docs-html/library/datatypes.html new file mode 100644 index 0000000..5c535d2 --- /dev/null +++ b/python-3.7.4-docs-html/library/datatypes.html @@ -0,0 +1,320 @@ + + + + + + + Data Types — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Data Types

    +

    The modules described in this chapter provide a variety of specialized data +types such as dates and times, fixed-type arrays, heap queues, synchronized +queues, and sets.

    +

    Python also provides some built-in data types, in particular, +dict, list, set and frozenset, and +tuple. The str class is used to hold +Unicode strings, and the bytes class is used to hold binary data.

    +

    The following modules are documented in this chapter:

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/datetime.html b/python-3.7.4-docs-html/library/datetime.html new file mode 100644 index 0000000..c2bbc6e --- /dev/null +++ b/python-3.7.4-docs-html/library/datetime.html @@ -0,0 +1,2814 @@ + + + + + + + datetime — Basic date and time types — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    datetime — Basic date and time types

    +

    Source code: Lib/datetime.py

    +
    +

    The datetime module supplies classes for manipulating dates and times in +both simple and complex ways. While date and time arithmetic is supported, the +focus of the implementation is on efficient attribute extraction for output +formatting and manipulation. For related functionality, see also the +time and calendar modules.

    +

    There are two kinds of date and time objects: “naive” and “aware”.

    +

    An aware object has sufficient knowledge of applicable algorithmic and +political time adjustments, such as time zone and daylight saving time +information, to locate itself relative to other aware objects. An aware object +is used to represent a specific moment in time that is not open to +interpretation 1.

    +

    A naive object does not contain enough information to unambiguously locate +itself relative to other date/time objects. Whether a naive object represents +Coordinated Universal Time (UTC), local time, or time in some other timezone is +purely up to the program, just like it is up to the program whether a +particular number represents metres, miles, or mass. Naive objects are easy to +understand and to work with, at the cost of ignoring some aspects of reality.

    +

    For applications requiring aware objects, datetime and time +objects have an optional time zone information attribute, tzinfo, that +can be set to an instance of a subclass of the abstract tzinfo class. +These tzinfo objects capture information about the offset from UTC +time, the time zone name, and whether Daylight Saving Time is in effect. Note +that only one concrete tzinfo class, the timezone class, is +supplied by the datetime module. The timezone class can +represent simple timezones with fixed offset from UTC, such as UTC itself or +North American EST and EDT timezones. Supporting timezones at deeper levels of +detail is up to the application. The rules for time adjustment across the +world are more political than rational, change frequently, and there is no +standard suitable for every application aside from UTC.

    +

    The datetime module exports the following constants:

    +
    +
    +datetime.MINYEAR
    +

    The smallest year number allowed in a date or datetime object. +MINYEAR is 1.

    +
    + +
    +
    +datetime.MAXYEAR
    +

    The largest year number allowed in a date or datetime object. +MAXYEAR is 9999.

    +
    + +
    +

    See also

    +
    +
    Module calendar

    General calendar related functions.

    +
    +
    Module time

    Time access and conversions.

    +
    +
    +
    +
    +

    Available Types

    +
    +
    +class datetime.date
    +

    An idealized naive date, assuming the current Gregorian calendar always was, and +always will be, in effect. Attributes: year, month, and +day.

    +
    + +
    +
    +class datetime.time
    +

    An idealized time, independent of any particular day, assuming that every day +has exactly 24*60*60 seconds (there is no notion of “leap seconds” here). +Attributes: hour, minute, second, microsecond, +and tzinfo.

    +
    + +
    +
    +class datetime.datetime
    +

    A combination of a date and a time. Attributes: year, month, +day, hour, minute, second, microsecond, +and tzinfo.

    +
    + +
    +
    +class datetime.timedelta
    +

    A duration expressing the difference between two date, time, +or datetime instances to microsecond resolution.

    +
    + +
    +
    +class datetime.tzinfo
    +

    An abstract base class for time zone information objects. These are used by the +datetime and time classes to provide a customizable notion of +time adjustment (for example, to account for time zone and/or daylight saving +time).

    +
    + +
    +
    +class datetime.timezone
    +

    A class that implements the tzinfo abstract base class as a +fixed offset from the UTC.

    +
    +

    New in version 3.2.

    +
    +
    + +

    Objects of these types are immutable.

    +

    Objects of the date type are always naive.

    +

    An object of type time or datetime may be naive or aware. +A datetime object d is aware if d.tzinfo is not None and +d.tzinfo.utcoffset(d) does not return None. If d.tzinfo is +None, or if d.tzinfo is not None but d.tzinfo.utcoffset(d) +returns None, d is naive. A time object t is aware +if t.tzinfo is not None and t.tzinfo.utcoffset(None) does not return +None. Otherwise, t is naive.

    +

    The distinction between naive and aware doesn’t apply to timedelta +objects.

    +

    Subclass relationships:

    +
    object
    +    timedelta
    +    tzinfo
    +        timezone
    +    time
    +    date
    +        datetime
    +
    +
    +
    +
    +

    timedelta Objects

    +

    A timedelta object represents a duration, the difference between two +dates or times.

    +
    +
    +class datetime.timedelta(days=0, seconds=0, microseconds=0, milliseconds=0, minutes=0, hours=0, weeks=0)
    +

    All arguments are optional and default to 0. Arguments may be integers +or floats, and may be positive or negative.

    +

    Only days, seconds and microseconds are stored internally. Arguments are +converted to those units:

    +
      +
    • A millisecond is converted to 1000 microseconds.

    • +
    • A minute is converted to 60 seconds.

    • +
    • An hour is converted to 3600 seconds.

    • +
    • A week is converted to 7 days.

    • +
    +

    and days, seconds and microseconds are then normalized so that the +representation is unique, with

    +
      +
    • 0 <= microseconds < 1000000

    • +
    • 0 <= seconds < 3600*24 (the number of seconds in one day)

    • +
    • -999999999 <= days <= 999999999

    • +
    +

    If any argument is a float and there are fractional microseconds, +the fractional microseconds left over from all arguments are +combined and their sum is rounded to the nearest microsecond using +round-half-to-even tiebreaker. If no argument is a float, the +conversion and normalization processes are exact (no information is +lost).

    +

    If the normalized value of days lies outside the indicated range, +OverflowError is raised.

    +

    Note that normalization of negative values may be surprising at first. For +example,

    +
    >>> from datetime import timedelta
    +>>> d = timedelta(microseconds=-1)
    +>>> (d.days, d.seconds, d.microseconds)
    +(-1, 86399, 999999)
    +
    +
    +
    + +

    Class attributes are:

    +
    +
    +timedelta.min
    +

    The most negative timedelta object, timedelta(-999999999).

    +
    + +
    +
    +timedelta.max
    +

    The most positive timedelta object, timedelta(days=999999999, +hours=23, minutes=59, seconds=59, microseconds=999999).

    +
    + +
    +
    +timedelta.resolution
    +

    The smallest possible difference between non-equal timedelta objects, +timedelta(microseconds=1).

    +
    + +

    Note that, because of normalization, timedelta.max > -timedelta.min. +-timedelta.max is not representable as a timedelta object.

    +

    Instance attributes (read-only):

    + ++++ + + + + + + + + + + + + + + + + +

    Attribute

    Value

    days

    Between -999999999 and 999999999 inclusive

    seconds

    Between 0 and 86399 inclusive

    microseconds

    Between 0 and 999999 inclusive

    +

    Supported operations:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Operation

    Result

    t1 = t2 + t3

    Sum of t2 and t3. Afterwards t1-t2 == +t3 and t1-t3 == t2 are true. (1)

    t1 = t2 - t3

    Difference of t2 and t3. Afterwards t1 +== t2 - t3 and t2 == t1 + t3 are +true. (1)(6)

    t1 = t2 * i or t1 = i * t2

    Delta multiplied by an integer. +Afterwards t1 // i == t2 is true, +provided i != 0.

    In general, t1 * i == t1 * (i-1) + t1 +is true. (1)

    t1 = t2 * f or t1 = f * t2

    Delta multiplied by a float. The result is +rounded to the nearest multiple of +timedelta.resolution using round-half-to-even.

    f = t2 / t3

    Division (3) of overall duration t2 by +interval unit t3. Returns a float +object.

    t1 = t2 / f or t1 = t2 / i

    Delta divided by a float or an int. The result +is rounded to the nearest multiple of +timedelta.resolution using round-half-to-even.

    t1 = t2 // i or +t1 = t2 // t3

    The floor is computed and the remainder (if +any) is thrown away. In the second case, an +integer is returned. (3)

    t1 = t2 % t3

    The remainder is computed as a +timedelta object. (3)

    q, r = divmod(t1, t2)

    Computes the quotient and the remainder: +q = t1 // t2 (3) and r = t1 % t2. +q is an integer and r is a timedelta +object.

    +t1

    Returns a timedelta object with the +same value. (2)

    -t1

    equivalent to +timedelta(-t1.days, +-t1.seconds, -t1.microseconds), +and to t1* -1. (1)(4)

    abs(t)

    equivalent to +t when t.days >= 0, and +to -t when t.days < 0. (2)

    str(t)

    Returns a string in the form +[D day[s], ][H]H:MM:SS[.UUUUUU], where D +is negative for negative t. (5)

    repr(t)

    Returns a string representation of the +timedelta object as a constructor +call with canonical attribute values.

    +

    Notes:

    +
      +
    1. This is exact, but may overflow.

    2. +
    3. This is exact, and cannot overflow.

    4. +
    5. Division by 0 raises ZeroDivisionError.

    6. +
    7. -timedelta.max is not representable as a timedelta object.

    8. +
    9. String representations of timedelta objects are normalized +similarly to their internal representation. This leads to somewhat +unusual results for negative timedeltas. For example:

      +
      >>> timedelta(hours=-5)
      +datetime.timedelta(days=-1, seconds=68400)
      +>>> print(_)
      +-1 day, 19:00:00
      +
      +
      +
    10. +
    11. The expression t2 - t3 will always be equal to the expression t2 + (-t3) except +when t3 is equal to timedelta.max; in that case the former will produce a result +while the latter will overflow.

    12. +
    +

    In addition to the operations listed above timedelta objects support +certain additions and subtractions with date and datetime +objects (see below).

    +
    +

    Changed in version 3.2: Floor division and true division of a timedelta object by another +timedelta object are now supported, as are remainder operations and +the divmod() function. True division and multiplication of a +timedelta object by a float object are now supported.

    +
    +

    Comparisons of timedelta objects are supported with the +timedelta object representing the smaller duration considered to be the +smaller timedelta. In order to stop mixed-type comparisons from falling back to +the default comparison by object address, when a timedelta object is +compared to an object of a different type, TypeError is raised unless the +comparison is == or !=. The latter cases return False or +True, respectively.

    +

    timedelta objects are hashable (usable as dictionary keys), support +efficient pickling, and in Boolean contexts, a timedelta object is +considered to be true if and only if it isn’t equal to timedelta(0).

    +

    Instance methods:

    +
    +
    +timedelta.total_seconds()
    +

    Return the total number of seconds contained in the duration. Equivalent to +td / timedelta(seconds=1). For interval units other than seconds, use the +division form directly (e.g. td / timedelta(microseconds=1)).

    +

    Note that for very large time intervals (greater than 270 years on +most platforms) this method will lose microsecond accuracy.

    +
    +

    New in version 3.2.

    +
    +
    + +

    Example usage:

    +
    >>> from datetime import timedelta
    +>>> year = timedelta(days=365)
    +>>> another_year = timedelta(weeks=40, days=84, hours=23,
    +...                          minutes=50, seconds=600)  # adds up to 365 days
    +>>> year.total_seconds()
    +31536000.0
    +>>> year == another_year
    +True
    +>>> ten_years = 10 * year
    +>>> ten_years, ten_years.days // 365
    +(datetime.timedelta(days=3650), 10)
    +>>> nine_years = ten_years - year
    +>>> nine_years, nine_years.days // 365
    +(datetime.timedelta(days=3285), 9)
    +>>> three_years = nine_years // 3
    +>>> three_years, three_years.days // 365
    +(datetime.timedelta(days=1095), 3)
    +>>> abs(three_years - ten_years) == 2 * three_years + year
    +True
    +
    +
    +
    +
    +

    date Objects

    +

    A date object represents a date (year, month and day) in an idealized +calendar, the current Gregorian calendar indefinitely extended in both +directions. January 1 of year 1 is called day number 1, January 2 of year 1 is +called day number 2, and so on. This matches the definition of the “proleptic +Gregorian” calendar in Dershowitz and Reingold’s book Calendrical Calculations, +where it’s the base calendar for all computations. See the book for algorithms +for converting between proleptic Gregorian ordinals and many other calendar +systems.

    +
    +
    +class datetime.date(year, month, day)
    +

    All arguments are required. Arguments may be integers, in the following +ranges:

    +
      +
    • MINYEAR <= year <= MAXYEAR

    • +
    • 1 <= month <= 12

    • +
    • 1 <= day <= number of days in the given month and year

    • +
    +

    If an argument outside those ranges is given, ValueError is raised.

    +
    + +

    Other constructors, all class methods:

    +
    +
    +classmethod date.today()
    +

    Return the current local date. This is equivalent to +date.fromtimestamp(time.time()).

    +
    + +
    +
    +classmethod date.fromtimestamp(timestamp)
    +

    Return the local date corresponding to the POSIX timestamp, such as is returned +by time.time(). This may raise OverflowError, if the timestamp is out +of the range of values supported by the platform C localtime() function, +and OSError on localtime() failure. +It’s common for this to be restricted to years from 1970 through 2038. Note +that on non-POSIX systems that include leap seconds in their notion of a +timestamp, leap seconds are ignored by fromtimestamp().

    +
    +

    Changed in version 3.3: Raise OverflowError instead of ValueError if the timestamp +is out of the range of values supported by the platform C +localtime() function. Raise OSError instead of +ValueError on localtime() failure.

    +
    +
    + +
    +
    +classmethod date.fromordinal(ordinal)
    +

    Return the date corresponding to the proleptic Gregorian ordinal, where January +1 of year 1 has ordinal 1. ValueError is raised unless 1 <= ordinal <= +date.max.toordinal(). For any date d, date.fromordinal(d.toordinal()) == +d.

    +
    + +
    +
    +classmethod date.fromisoformat(date_string)
    +

    Return a date corresponding to a date_string in the format emitted +by date.isoformat(). Specifically, this function supports strings in +the format(s) YYYY-MM-DD.

    +
    +

    Caution

    +

    This does not support parsing arbitrary ISO 8601 strings - it is only intended +as the inverse operation of date.isoformat().

    +
    +
    +

    New in version 3.7.

    +
    +
    + +

    Class attributes:

    +
    +
    +date.min
    +

    The earliest representable date, date(MINYEAR, 1, 1).

    +
    + +
    +
    +date.max
    +

    The latest representable date, date(MAXYEAR, 12, 31).

    +
    + +
    +
    +date.resolution
    +

    The smallest possible difference between non-equal date objects, +timedelta(days=1).

    +
    + +

    Instance attributes (read-only):

    +
    +
    +date.year
    +

    Between MINYEAR and MAXYEAR inclusive.

    +
    + +
    +
    +date.month
    +

    Between 1 and 12 inclusive.

    +
    + +
    +
    +date.day
    +

    Between 1 and the number of days in the given month of the given year.

    +
    + +

    Supported operations:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Operation

    Result

    date2 = date1 + timedelta

    date2 is timedelta.days days removed +from date1. (1)

    date2 = date1 - timedelta

    Computes date2 such that date2 + +timedelta == date1. (2)

    timedelta = date1 - date2

    (3)

    date1 < date2

    date1 is considered less than date2 when +date1 precedes date2 in time. (4)

    +

    Notes:

    +
      +
    1. date2 is moved forward in time if timedelta.days > 0, or backward if +timedelta.days < 0. Afterward date2 - date1 == timedelta.days. +timedelta.seconds and timedelta.microseconds are ignored. +OverflowError is raised if date2.year would be smaller than +MINYEAR or larger than MAXYEAR.

    2. +
    3. timedelta.seconds and timedelta.microseconds are ignored.

    4. +
    5. This is exact, and cannot overflow. timedelta.seconds and +timedelta.microseconds are 0, and date2 + timedelta == date1 after.

    6. +
    7. In other words, date1 < date2 if and only if date1.toordinal() < +date2.toordinal(). Date comparison raises TypeError if +the other comparand isn’t also a date object. However, +NotImplemented is returned instead if the other comparand has a +timetuple() attribute. This hook gives other kinds of date objects a +chance at implementing mixed-type comparison. If not, when a date +object is compared to an object of a different type, TypeError is raised +unless the comparison is == or !=. The latter cases return +False or True, respectively.

    8. +
    +

    Dates can be used as dictionary keys. In Boolean contexts, all date +objects are considered to be true.

    +

    Instance methods:

    +
    +
    +date.replace(year=self.year, month=self.month, day=self.day)
    +

    Return a date with the same value, except for those parameters given new +values by whichever keyword arguments are specified. For example, if d == +date(2002, 12, 31), then d.replace(day=26) == date(2002, 12, 26).

    +
    + +
    +
    +date.timetuple()
    +

    Return a time.struct_time such as returned by time.localtime(). +The hours, minutes and seconds are 0, and the DST flag is -1. d.timetuple() +is equivalent to time.struct_time((d.year, d.month, d.day, 0, 0, 0, +d.weekday(), yday, -1)), where yday = d.toordinal() - date(d.year, 1, +1).toordinal() + 1 is the day number within the current year starting with +1 for January 1st.

    +
    + +
    +
    +date.toordinal()
    +

    Return the proleptic Gregorian ordinal of the date, where January 1 of year 1 +has ordinal 1. For any date object d, +date.fromordinal(d.toordinal()) == d.

    +
    + +
    +
    +date.weekday()
    +

    Return the day of the week as an integer, where Monday is 0 and Sunday is 6. +For example, date(2002, 12, 4).weekday() == 2, a Wednesday. See also +isoweekday().

    +
    + +
    +
    +date.isoweekday()
    +

    Return the day of the week as an integer, where Monday is 1 and Sunday is 7. +For example, date(2002, 12, 4).isoweekday() == 3, a Wednesday. See also +weekday(), isocalendar().

    +
    + +
    +
    +date.isocalendar()
    +

    Return a 3-tuple, (ISO year, ISO week number, ISO weekday).

    +

    The ISO calendar is a widely used variant of the Gregorian calendar. See +https://www.staff.science.uu.nl/~gent0113/calendar/isocalendar.htm for a good +explanation.

    +

    The ISO year consists of 52 or 53 full weeks, and where a week starts on a +Monday and ends on a Sunday. The first week of an ISO year is the first +(Gregorian) calendar week of a year containing a Thursday. This is called week +number 1, and the ISO year of that Thursday is the same as its Gregorian year.

    +

    For example, 2004 begins on a Thursday, so the first week of ISO year 2004 +begins on Monday, 29 Dec 2003 and ends on Sunday, 4 Jan 2004, so that +date(2003, 12, 29).isocalendar() == (2004, 1, 1) and date(2004, 1, +4).isocalendar() == (2004, 1, 7).

    +
    + +
    +
    +date.isoformat()
    +

    Return a string representing the date in ISO 8601 format, ‘YYYY-MM-DD’. For +example, date(2002, 12, 4).isoformat() == '2002-12-04'.

    +
    + +
    +
    +date.__str__()
    +

    For a date d, str(d) is equivalent to d.isoformat().

    +
    + +
    +
    +date.ctime()
    +

    Return a string representing the date, for example date(2002, 12, +4).ctime() == 'Wed Dec 4 00:00:00 2002'. d.ctime() is equivalent to +time.ctime(time.mktime(d.timetuple())) on platforms where the native C +ctime() function (which time.ctime() invokes, but which +date.ctime() does not invoke) conforms to the C standard.

    +
    + +
    +
    +date.strftime(format)
    +

    Return a string representing the date, controlled by an explicit format string. +Format codes referring to hours, minutes or seconds will see 0 values. For a +complete list of formatting directives, see +strftime() and strptime() Behavior.

    +
    + +
    +
    +date.__format__(format)
    +

    Same as date.strftime(). This makes it possible to specify a format +string for a date object in formatted string +literals and when using str.format(). For a +complete list of formatting directives, see +strftime() and strptime() Behavior.

    +
    + +

    Example of counting days to an event:

    +
    >>> import time
    +>>> from datetime import date
    +>>> today = date.today()
    +>>> today
    +datetime.date(2007, 12, 5)
    +>>> today == date.fromtimestamp(time.time())
    +True
    +>>> my_birthday = date(today.year, 6, 24)
    +>>> if my_birthday < today:
    +...     my_birthday = my_birthday.replace(year=today.year + 1)
    +>>> my_birthday
    +datetime.date(2008, 6, 24)
    +>>> time_to_birthday = abs(my_birthday - today)
    +>>> time_to_birthday.days
    +202
    +
    +
    +

    Example of working with date:

    +
    >>> from datetime import date
    +>>> d = date.fromordinal(730920) # 730920th day after 1. 1. 0001
    +>>> d
    +datetime.date(2002, 3, 11)
    +>>> t = d.timetuple()
    +>>> for i in t:     
    +...     print(i)
    +2002                # year
    +3                   # month
    +11                  # day
    +0
    +0
    +0
    +0                   # weekday (0 = Monday)
    +70                  # 70th day in the year
    +-1
    +>>> ic = d.isocalendar()
    +>>> for i in ic:    
    +...     print(i)
    +2002                # ISO year
    +11                  # ISO week number
    +1                   # ISO day number ( 1 = Monday )
    +>>> d.isoformat()
    +'2002-03-11'
    +>>> d.strftime("%d/%m/%y")
    +'11/03/02'
    +>>> d.strftime("%A %d. %B %Y")
    +'Monday 11. March 2002'
    +>>> 'The {1} is {0:%d}, the {2} is {0:%B}.'.format(d, "day", "month")
    +'The day is 11, the month is March.'
    +
    +
    +
    +
    +

    datetime Objects

    +

    A datetime object is a single object containing all the information +from a date object and a time object. Like a date +object, datetime assumes the current Gregorian calendar extended in +both directions; like a time object, datetime assumes there are exactly +3600*24 seconds in every day.

    +

    Constructor:

    +
    +
    +class datetime.datetime(year, month, day, hour=0, minute=0, second=0, microsecond=0, tzinfo=None, *, fold=0)
    +

    The year, month and day arguments are required. tzinfo may be None, or an +instance of a tzinfo subclass. The remaining arguments may be integers, +in the following ranges:

    +
      +
    • MINYEAR <= year <= MAXYEAR,

    • +
    • 1 <= month <= 12,

    • +
    • 1 <= day <= number of days in the given month and year,

    • +
    • 0 <= hour < 24,

    • +
    • 0 <= minute < 60,

    • +
    • 0 <= second < 60,

    • +
    • 0 <= microsecond < 1000000,

    • +
    • fold in [0, 1].

    • +
    +

    If an argument outside those ranges is given, ValueError is raised.

    +
    +

    New in version 3.6: Added the fold argument.

    +
    +
    + +

    Other constructors, all class methods:

    +
    +
    +classmethod datetime.today()
    +

    Return the current local datetime, with tzinfo None. This is +equivalent to datetime.fromtimestamp(time.time()). See also now(), +fromtimestamp().

    +
    + +
    +
    +classmethod datetime.now(tz=None)
    +

    Return the current local date and time. If optional argument tz is None +or not specified, this is like today(), but, if possible, supplies more +precision than can be gotten from going through a time.time() timestamp +(for example, this may be possible on platforms supplying the C +gettimeofday() function).

    +

    If tz is not None, it must be an instance of a tzinfo subclass, and the +current date and time are converted to tz’s time zone. In this case the +result is equivalent to tz.fromutc(datetime.utcnow().replace(tzinfo=tz)). +See also today(), utcnow().

    +
    + +
    +
    +classmethod datetime.utcnow()
    +

    Return the current UTC date and time, with tzinfo None. This is like +now(), but returns the current UTC date and time, as a naive +datetime object. An aware current UTC datetime can be obtained by +calling datetime.now(timezone.utc). See also now().

    +
    + +
    +
    +classmethod datetime.fromtimestamp(timestamp, tz=None)
    +

    Return the local date and time corresponding to the POSIX timestamp, such as is +returned by time.time(). If optional argument tz is None or not +specified, the timestamp is converted to the platform’s local date and time, and +the returned datetime object is naive.

    +

    If tz is not None, it must be an instance of a tzinfo subclass, and the +timestamp is converted to tz’s time zone. In this case the result is +equivalent to +tz.fromutc(datetime.utcfromtimestamp(timestamp).replace(tzinfo=tz)).

    +

    fromtimestamp() may raise OverflowError, if the timestamp is out of +the range of values supported by the platform C localtime() or +gmtime() functions, and OSError on localtime() or +gmtime() failure. +It’s common for this to be restricted to years in +1970 through 2038. Note that on non-POSIX systems that include leap seconds in +their notion of a timestamp, leap seconds are ignored by fromtimestamp(), +and then it’s possible to have two timestamps differing by a second that yield +identical datetime objects. See also utcfromtimestamp().

    +
    +

    Changed in version 3.3: Raise OverflowError instead of ValueError if the timestamp +is out of the range of values supported by the platform C +localtime() or gmtime() functions. Raise OSError +instead of ValueError on localtime() or gmtime() +failure.

    +
    +
    +

    Changed in version 3.6: fromtimestamp() may return instances with fold set to 1.

    +
    +
    + +
    +
    +classmethod datetime.utcfromtimestamp(timestamp)
    +

    Return the UTC datetime corresponding to the POSIX timestamp, with +tzinfo None. This may raise OverflowError, if the timestamp is +out of the range of values supported by the platform C gmtime() function, +and OSError on gmtime() failure. +It’s common for this to be restricted to years in 1970 through 2038.

    +

    To get an aware datetime object, call fromtimestamp():

    +
    datetime.fromtimestamp(timestamp, timezone.utc)
    +
    +
    +

    On the POSIX compliant platforms, it is equivalent to the following +expression:

    +
    datetime(1970, 1, 1, tzinfo=timezone.utc) + timedelta(seconds=timestamp)
    +
    +
    +

    except the latter formula always supports the full years range: between +MINYEAR and MAXYEAR inclusive.

    +
    +

    Changed in version 3.3: Raise OverflowError instead of ValueError if the timestamp +is out of the range of values supported by the platform C +gmtime() function. Raise OSError instead of +ValueError on gmtime() failure.

    +
    +
    + +
    +
    +classmethod datetime.fromordinal(ordinal)
    +

    Return the datetime corresponding to the proleptic Gregorian ordinal, +where January 1 of year 1 has ordinal 1. ValueError is raised unless 1 +<= ordinal <= datetime.max.toordinal(). The hour, minute, second and +microsecond of the result are all 0, and tzinfo is None.

    +
    + +
    +
    +classmethod datetime.combine(date, time, tzinfo=self.tzinfo)
    +

    Return a new datetime object whose date components are equal to the +given date object’s, and whose time components +are equal to the given time object’s. If the tzinfo +argument is provided, its value is used to set the tzinfo attribute +of the result, otherwise the tzinfo attribute of the time argument +is used.

    +

    For any datetime object d, +d == datetime.combine(d.date(), d.time(), d.tzinfo). If date is a +datetime object, its time components and tzinfo attributes +are ignored.

    +
    +

    Changed in version 3.6: Added the tzinfo argument.

    +
    +
    + +
    +
    +classmethod datetime.fromisoformat(date_string)
    +

    Return a datetime corresponding to a date_string in one of the +formats emitted by date.isoformat() and datetime.isoformat(). +Specifically, this function supports strings in the format(s) +YYYY-MM-DD[*HH[:MM[:SS[.fff[fff]]]][+HH:MM[:SS[.ffffff]]]], +where * can match any single character.

    +
    +

    Caution

    +

    This does not support parsing arbitrary ISO 8601 strings - it is only intended +as the inverse operation of datetime.isoformat().

    +
    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +classmethod datetime.strptime(date_string, format)
    +

    Return a datetime corresponding to date_string, parsed according to +format. This is equivalent to datetime(*(time.strptime(date_string, +format)[0:6])). ValueError is raised if the date_string and format +can’t be parsed by time.strptime() or if it returns a value which isn’t a +time tuple. For a complete list of formatting directives, see +strftime() and strptime() Behavior.

    +
    + +

    Class attributes:

    +
    +
    +datetime.min
    +

    The earliest representable datetime, datetime(MINYEAR, 1, 1, +tzinfo=None).

    +
    + +
    +
    +datetime.max
    +

    The latest representable datetime, datetime(MAXYEAR, 12, 31, 23, 59, +59, 999999, tzinfo=None).

    +
    + +
    +
    +datetime.resolution
    +

    The smallest possible difference between non-equal datetime objects, +timedelta(microseconds=1).

    +
    + +

    Instance attributes (read-only):

    +
    +
    +datetime.year
    +

    Between MINYEAR and MAXYEAR inclusive.

    +
    + +
    +
    +datetime.month
    +

    Between 1 and 12 inclusive.

    +
    + +
    +
    +datetime.day
    +

    Between 1 and the number of days in the given month of the given year.

    +
    + +
    +
    +datetime.hour
    +

    In range(24).

    +
    + +
    +
    +datetime.minute
    +

    In range(60).

    +
    + +
    +
    +datetime.second
    +

    In range(60).

    +
    + +
    +
    +datetime.microsecond
    +

    In range(1000000).

    +
    + +
    +
    +datetime.tzinfo
    +

    The object passed as the tzinfo argument to the datetime constructor, +or None if none was passed.

    +
    + +
    +
    +datetime.fold
    +

    In [0, 1]. Used to disambiguate wall times during a repeated interval. (A +repeated interval occurs when clocks are rolled back at the end of daylight saving +time or when the UTC offset for the current zone is decreased for political reasons.) +The value 0 (1) represents the earlier (later) of the two moments with the same wall +time representation.

    +
    +

    New in version 3.6.

    +
    +
    + +

    Supported operations:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Operation

    Result

    datetime2 = datetime1 + timedelta

    (1)

    datetime2 = datetime1 - timedelta

    (2)

    timedelta = datetime1 - datetime2

    (3)

    datetime1 < datetime2

    Compares datetime to +datetime. (4)

    +
      +
    1. datetime2 is a duration of timedelta removed from datetime1, moving forward in +time if timedelta.days > 0, or backward if timedelta.days < 0. The +result has the same tzinfo attribute as the input datetime, and +datetime2 - datetime1 == timedelta after. OverflowError is raised if +datetime2.year would be smaller than MINYEAR or larger than +MAXYEAR. Note that no time zone adjustments are done even if the +input is an aware object.

    2. +
    3. Computes the datetime2 such that datetime2 + timedelta == datetime1. As for +addition, the result has the same tzinfo attribute as the input +datetime, and no time zone adjustments are done even if the input is aware.

    4. +
    5. Subtraction of a datetime from a datetime is defined only if +both operands are naive, or if both are aware. If one is aware and the other is +naive, TypeError is raised.

      +

      If both are naive, or both are aware and have the same tzinfo attribute, +the tzinfo attributes are ignored, and the result is a timedelta +object t such that datetime2 + t == datetime1. No time zone adjustments +are done in this case.

      +

      If both are aware and have different tzinfo attributes, a-b acts +as if a and b were first converted to naive UTC datetimes first. The +result is (a.replace(tzinfo=None) - a.utcoffset()) - (b.replace(tzinfo=None) +- b.utcoffset()) except that the implementation never overflows.

      +
    6. +
    7. datetime1 is considered less than datetime2 when datetime1 precedes +datetime2 in time.

      +

      If one comparand is naive and the other is aware, TypeError +is raised if an order comparison is attempted. For equality +comparisons, naive instances are never equal to aware instances.

      +

      If both comparands are aware, and have the same tzinfo attribute, the +common tzinfo attribute is ignored and the base datetimes are +compared. If both comparands are aware and have different tzinfo +attributes, the comparands are first adjusted by subtracting their UTC +offsets (obtained from self.utcoffset()).

      +
      +

      Changed in version 3.3: Equality comparisons between naive and aware datetime +instances don’t raise TypeError.

      +
      +
      +

      Note

      +

      In order to stop comparison from falling back to the default scheme of comparing +object addresses, datetime comparison normally raises TypeError if the +other comparand isn’t also a datetime object. However, +NotImplemented is returned instead if the other comparand has a +timetuple() attribute. This hook gives other kinds of date objects a +chance at implementing mixed-type comparison. If not, when a datetime +object is compared to an object of a different type, TypeError is raised +unless the comparison is == or !=. The latter cases return +False or True, respectively.

      +
      +
    8. +
    +

    datetime objects can be used as dictionary keys. In Boolean contexts, +all datetime objects are considered to be true.

    +

    Instance methods:

    +
    +
    +datetime.date()
    +

    Return date object with same year, month and day.

    +
    + +
    +
    +datetime.time()
    +

    Return time object with same hour, minute, second, microsecond and fold. +tzinfo is None. See also method timetz().

    +
    +

    Changed in version 3.6: The fold value is copied to the returned time object.

    +
    +
    + +
    +
    +datetime.timetz()
    +

    Return time object with same hour, minute, second, microsecond, fold, and +tzinfo attributes. See also method time().

    +
    +

    Changed in version 3.6: The fold value is copied to the returned time object.

    +
    +
    + +
    +
    +datetime.replace(year=self.year, month=self.month, day=self.day, hour=self.hour, minute=self.minute, second=self.second, microsecond=self.microsecond, tzinfo=self.tzinfo, * fold=0)
    +

    Return a datetime with the same attributes, except for those attributes given +new values by whichever keyword arguments are specified. Note that +tzinfo=None can be specified to create a naive datetime from an aware +datetime with no conversion of date and time data.

    +
    +

    New in version 3.6: Added the fold argument.

    +
    +
    + +
    +
    +datetime.astimezone(tz=None)
    +

    Return a datetime object with new tzinfo attribute tz, +adjusting the date and time data so the result is the same UTC time as +self, but in tz’s local time.

    +

    If provided, tz must be an instance of a tzinfo subclass, and its +utcoffset() and dst() methods must not return None. If self +is naive, it is presumed to represent time in the system timezone.

    +

    If called without arguments (or with tz=None) the system local +timezone is assumed for the target timezone. The .tzinfo attribute of the converted +datetime instance will be set to an instance of timezone +with the zone name and offset obtained from the OS.

    +

    If self.tzinfo is tz, self.astimezone(tz) is equal to self: no +adjustment of date or time data is performed. Else the result is local +time in the timezone tz, representing the same UTC time as self: after +astz = dt.astimezone(tz), astz - astz.utcoffset() will have +the same date and time data as dt - dt.utcoffset().

    +

    If you merely want to attach a time zone object tz to a datetime dt without +adjustment of date and time data, use dt.replace(tzinfo=tz). If you +merely want to remove the time zone object from an aware datetime dt without +conversion of date and time data, use dt.replace(tzinfo=None).

    +

    Note that the default tzinfo.fromutc() method can be overridden in a +tzinfo subclass to affect the result returned by astimezone(). +Ignoring error cases, astimezone() acts like:

    +
    def astimezone(self, tz):
    +    if self.tzinfo is tz:
    +        return self
    +    # Convert self to UTC, and attach the new time zone object.
    +    utc = (self - self.utcoffset()).replace(tzinfo=tz)
    +    # Convert from UTC to tz's local time.
    +    return tz.fromutc(utc)
    +
    +
    +
    +

    Changed in version 3.3: tz now can be omitted.

    +
    +
    +

    Changed in version 3.6: The astimezone() method can now be called on naive instances that +are presumed to represent system local time.

    +
    +
    + +
    +
    +datetime.utcoffset()
    +

    If tzinfo is None, returns None, else returns +self.tzinfo.utcoffset(self), and raises an exception if the latter doesn’t +return None or a timedelta object with magnitude less than one day.

    +
    +

    Changed in version 3.7: The UTC offset is not restricted to a whole number of minutes.

    +
    +
    + +
    +
    +datetime.dst()
    +

    If tzinfo is None, returns None, else returns +self.tzinfo.dst(self), and raises an exception if the latter doesn’t return +None or a timedelta object with magnitude less than one day.

    +
    +

    Changed in version 3.7: The DST offset is not restricted to a whole number of minutes.

    +
    +
    + +
    +
    +datetime.tzname()
    +

    If tzinfo is None, returns None, else returns +self.tzinfo.tzname(self), raises an exception if the latter doesn’t return +None or a string object,

    +
    + +
    +
    +datetime.timetuple()
    +

    Return a time.struct_time such as returned by time.localtime(). +d.timetuple() is equivalent to time.struct_time((d.year, d.month, d.day, +d.hour, d.minute, d.second, d.weekday(), yday, dst)), where yday = +d.toordinal() - date(d.year, 1, 1).toordinal() + 1 is the day number within +the current year starting with 1 for January 1st. The tm_isdst flag +of the result is set according to the dst() method: tzinfo is +None or dst() returns None, tm_isdst is set to -1; +else if dst() returns a non-zero value, tm_isdst is set to 1; +else tm_isdst is set to 0.

    +
    + +
    +
    +datetime.utctimetuple()
    +

    If datetime instance d is naive, this is the same as +d.timetuple() except that tm_isdst is forced to 0 regardless of what +d.dst() returns. DST is never in effect for a UTC time.

    +

    If d is aware, d is normalized to UTC time, by subtracting +d.utcoffset(), and a time.struct_time for the +normalized time is returned. tm_isdst is forced to 0. Note +that an OverflowError may be raised if d.year was +MINYEAR or MAXYEAR and UTC adjustment spills over a year +boundary.

    +
    + +
    +
    +datetime.toordinal()
    +

    Return the proleptic Gregorian ordinal of the date. The same as +self.date().toordinal().

    +
    + +
    +
    +datetime.timestamp()
    +

    Return POSIX timestamp corresponding to the datetime +instance. The return value is a float similar to that +returned by time.time().

    +

    Naive datetime instances are assumed to represent local +time and this method relies on the platform C mktime() +function to perform the conversion. Since datetime +supports wider range of values than mktime() on many +platforms, this method may raise OverflowError for times far +in the past or far in the future.

    +

    For aware datetime instances, the return value is computed +as:

    +
    (dt - datetime(1970, 1, 1, tzinfo=timezone.utc)).total_seconds()
    +
    +
    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.6: The timestamp() method uses the fold attribute to +disambiguate the times during a repeated interval.

    +
    +
    +

    Note

    +

    There is no method to obtain the POSIX timestamp directly from a +naive datetime instance representing UTC time. If your +application uses this convention and your system timezone is not +set to UTC, you can obtain the POSIX timestamp by supplying +tzinfo=timezone.utc:

    +
    timestamp = dt.replace(tzinfo=timezone.utc).timestamp()
    +
    +
    +

    or by calculating the timestamp directly:

    +
    timestamp = (dt - datetime(1970, 1, 1)) / timedelta(seconds=1)
    +
    +
    +
    +
    + +
    +
    +datetime.weekday()
    +

    Return the day of the week as an integer, where Monday is 0 and Sunday is 6. +The same as self.date().weekday(). See also isoweekday().

    +
    + +
    +
    +datetime.isoweekday()
    +

    Return the day of the week as an integer, where Monday is 1 and Sunday is 7. +The same as self.date().isoweekday(). See also weekday(), +isocalendar().

    +
    + +
    +
    +datetime.isocalendar()
    +

    Return a 3-tuple, (ISO year, ISO week number, ISO weekday). The same as +self.date().isocalendar().

    +
    + +
    +
    +datetime.isoformat(sep='T', timespec='auto')
    +

    Return a string representing the date and time in ISO 8601 format, +YYYY-MM-DDTHH:MM:SS.ffffff or, if microsecond is 0, +YYYY-MM-DDTHH:MM:SS

    +

    If utcoffset() does not return None, a string is +appended, giving the UTC offset: +YYYY-MM-DDTHH:MM:SS.ffffff+HH:MM[:SS[.ffffff]] or, if microsecond +is 0 YYYY-MM-DDTHH:MM:SS+HH:MM[:SS[.ffffff]].

    +

    The optional argument sep (default 'T') is a one-character separator, +placed between the date and time portions of the result. For example,

    +
    >>> from datetime import tzinfo, timedelta, datetime
    +>>> class TZ(tzinfo):
    +...     def utcoffset(self, dt): return timedelta(minutes=-399)
    +...
    +>>> datetime(2002, 12, 25, tzinfo=TZ()).isoformat(' ')
    +'2002-12-25 00:00:00-06:39'
    +
    +
    +

    The optional argument timespec specifies the number of additional +components of the time to include (the default is 'auto'). +It can be one of the following:

    +
      +
    • 'auto': Same as 'seconds' if microsecond is 0, +same as 'microseconds' otherwise.

    • +
    • 'hours': Include the hour in the two-digit HH format.

    • +
    • 'minutes': Include hour and minute in HH:MM format.

    • +
    • 'seconds': Include hour, minute, and second +in HH:MM:SS format.

    • +
    • 'milliseconds': Include full time, but truncate fractional second +part to milliseconds. HH:MM:SS.sss format.

    • +
    • 'microseconds': Include full time in HH:MM:SS.ffffff format.

    • +
    +
    +

    Note

    +

    Excluded time components are truncated, not rounded.

    +
    +

    ValueError will be raised on an invalid timespec argument.

    +
    >>> from datetime import datetime
    +>>> datetime.now().isoformat(timespec='minutes')   # doctest: +SKIP
    +'2002-12-25T00:00'
    +>>> dt = datetime(2015, 1, 1, 12, 30, 59, 0)
    +>>> dt.isoformat(timespec='microseconds')
    +'2015-01-01T12:30:59.000000'
    +
    +
    +
    +

    New in version 3.6: Added the timespec argument.

    +
    +
    + +
    +
    +datetime.__str__()
    +

    For a datetime instance d, str(d) is equivalent to +d.isoformat(' ').

    +
    + +
    +
    +datetime.ctime()
    +

    Return a string representing the date and time, for example datetime(2002, 12, +4, 20, 30, 40).ctime() == 'Wed Dec  4 20:30:40 2002'. d.ctime() is +equivalent to time.ctime(time.mktime(d.timetuple())) on platforms where the +native C ctime() function (which time.ctime() invokes, but which +datetime.ctime() does not invoke) conforms to the C standard.

    +
    + +
    +
    +datetime.strftime(format)
    +

    Return a string representing the date and time, controlled by an explicit format +string. For a complete list of formatting directives, see +strftime() and strptime() Behavior.

    +
    + +
    +
    +datetime.__format__(format)
    +

    Same as datetime.strftime(). This makes it possible to specify a format +string for a datetime object in formatted string +literals and when using str.format(). For a +complete list of formatting directives, see +strftime() and strptime() Behavior.

    +
    + +

    Examples of working with datetime objects:

    +
    >>> from datetime import datetime, date, time
    +>>> # Using datetime.combine()
    +>>> d = date(2005, 7, 14)
    +>>> t = time(12, 30)
    +>>> datetime.combine(d, t)
    +datetime.datetime(2005, 7, 14, 12, 30)
    +>>> # Using datetime.now() or datetime.utcnow()
    +>>> datetime.now()   
    +datetime.datetime(2007, 12, 6, 16, 29, 43, 79043)   # GMT +1
    +>>> datetime.utcnow()   
    +datetime.datetime(2007, 12, 6, 15, 29, 43, 79060)
    +>>> # Using datetime.strptime()
    +>>> dt = datetime.strptime("21/11/06 16:30", "%d/%m/%y %H:%M")
    +>>> dt
    +datetime.datetime(2006, 11, 21, 16, 30)
    +>>> # Using datetime.timetuple() to get tuple of all attributes
    +>>> tt = dt.timetuple()
    +>>> for it in tt:   
    +...     print(it)
    +...
    +2006    # year
    +11      # month
    +21      # day
    +16      # hour
    +30      # minute
    +0       # second
    +1       # weekday (0 = Monday)
    +325     # number of days since 1st January
    +-1      # dst - method tzinfo.dst() returned None
    +>>> # Date in ISO format
    +>>> ic = dt.isocalendar()
    +>>> for it in ic:   
    +...     print(it)
    +...
    +2006    # ISO year
    +47      # ISO week
    +2       # ISO weekday
    +>>> # Formatting datetime
    +>>> dt.strftime("%A, %d. %B %Y %I:%M%p")
    +'Tuesday, 21. November 2006 04:30PM'
    +>>> 'The {1} is {0:%d}, the {2} is {0:%B}, the {3} is {0:%I:%M%p}.'.format(dt, "day", "month", "time")
    +'The day is 21, the month is November, the time is 04:30PM.'
    +
    +
    +

    Using datetime with tzinfo:

    +
    >>> from datetime import timedelta, datetime, tzinfo, timezone
    +>>> class KabulTz(tzinfo):
    +...     # Kabul used +4 until 1945, when they moved to +4:30
    +...     UTC_MOVE_DATE = datetime(1944, 12, 31, 20, tzinfo=timezone.utc)
    +...     def utcoffset(self, dt):
    +...         if dt.year < 1945:
    +...             return timedelta(hours=4)
    +...         elif (1945, 1, 1, 0, 0) <= dt.timetuple()[:5] < (1945, 1, 1, 0, 30):
    +...             # If dt falls in the imaginary range, use fold to decide how
    +...             # to resolve. See PEP495
    +...             return timedelta(hours=4, minutes=(30 if dt.fold else 0))
    +...         else:
    +...             return timedelta(hours=4, minutes=30)
    +...
    +...     def fromutc(self, dt):
    +...         # A custom implementation is required for fromutc as
    +...         # the input to this function is a datetime with utc values
    +...         # but with a tzinfo set to self
    +...         # See datetime.astimezone or fromtimestamp
    +...
    +...         # Follow same validations as in datetime.tzinfo
    +...         if not isinstance(dt, datetime):
    +...             raise TypeError("fromutc() requires a datetime argument")
    +...         if dt.tzinfo is not self:
    +...             raise ValueError("dt.tzinfo is not self")
    +...
    +...         if dt.replace(tzinfo=timezone.utc) >= self.UTC_MOVE_DATE:
    +...             return dt + timedelta(hours=4, minutes=30)
    +...         else:
    +...             return dt + timedelta(hours=4)
    +...
    +...     def dst(self, dt):
    +...         return timedelta(0)
    +...
    +...     def tzname(self, dt):
    +...         if dt >= self.UTC_MOVE_DATE:
    +...             return "+04:30"
    +...         else:
    +...             return "+04"
    +...
    +...     def  __repr__(self):
    +...         return f"{self.__class__.__name__}()"
    +...
    +>>> tz1 = KabulTz()
    +>>> # Datetime before the change
    +>>> dt1 = datetime(1900, 11, 21, 16, 30, tzinfo=tz1)
    +>>> print(dt1.utcoffset())
    +4:00:00
    +>>> # Datetime after the change
    +>>> dt2 = datetime(2006, 6, 14, 13, 0, tzinfo=tz1)
    +>>> print(dt2.utcoffset())
    +4:30:00
    +>>> # Convert datetime to another time zone
    +>>> dt3 = dt2.astimezone(timezone.utc)
    +>>> dt3
    +datetime.datetime(2006, 6, 14, 8, 30, tzinfo=datetime.timezone.utc)
    +>>> dt2
    +datetime.datetime(2006, 6, 14, 13, 0, tzinfo=KabulTz())
    +>>> dt2.utctimetuple() == dt3.utctimetuple()
    +True
    +
    +
    +
    +
    +

    time Objects

    +

    A time object represents a (local) time of day, independent of any particular +day, and subject to adjustment via a tzinfo object.

    +
    +
    +class datetime.time(hour=0, minute=0, second=0, microsecond=0, tzinfo=None, *, fold=0)
    +

    All arguments are optional. tzinfo may be None, or an instance of a +tzinfo subclass. The remaining arguments may be integers, in the +following ranges:

    +
      +
    • 0 <= hour < 24,

    • +
    • 0 <= minute < 60,

    • +
    • 0 <= second < 60,

    • +
    • 0 <= microsecond < 1000000,

    • +
    • fold in [0, 1].

    • +
    +

    If an argument outside those ranges is given, ValueError is raised. All +default to 0 except tzinfo, which defaults to None.

    +
    + +

    Class attributes:

    +
    +
    +time.min
    +

    The earliest representable time, time(0, 0, 0, 0).

    +
    + +
    +
    +time.max
    +

    The latest representable time, time(23, 59, 59, 999999).

    +
    + +
    +
    +time.resolution
    +

    The smallest possible difference between non-equal time objects, +timedelta(microseconds=1), although note that arithmetic on +time objects is not supported.

    +
    + +

    Instance attributes (read-only):

    +
    +
    +time.hour
    +

    In range(24).

    +
    + +
    +
    +time.minute
    +

    In range(60).

    +
    + +
    +
    +time.second
    +

    In range(60).

    +
    + +
    +
    +time.microsecond
    +

    In range(1000000).

    +
    + +
    +
    +time.tzinfo
    +

    The object passed as the tzinfo argument to the time constructor, or +None if none was passed.

    +
    + +
    +
    +time.fold
    +

    In [0, 1]. Used to disambiguate wall times during a repeated interval. (A +repeated interval occurs when clocks are rolled back at the end of daylight saving +time or when the UTC offset for the current zone is decreased for political reasons.) +The value 0 (1) represents the earlier (later) of the two moments with the same wall +time representation.

    +
    +

    New in version 3.6.

    +
    +
    + +

    Supported operations:

    +
      +
    • comparison of time to time, where a is considered less +than b when a precedes b in time. If one comparand is naive and the other +is aware, TypeError is raised if an order comparison is attempted. For equality +comparisons, naive instances are never equal to aware instances.

      +

      If both comparands are aware, and have +the same tzinfo attribute, the common tzinfo attribute is +ignored and the base times are compared. If both comparands are aware and +have different tzinfo attributes, the comparands are first adjusted by +subtracting their UTC offsets (obtained from self.utcoffset()). In order +to stop mixed-type comparisons from falling back to the default comparison by +object address, when a time object is compared to an object of a +different type, TypeError is raised unless the comparison is == or +!=. The latter cases return False or True, respectively.

      +
      +

      Changed in version 3.3: Equality comparisons between naive and aware time instances +don’t raise TypeError.

      +
      +
    • +
    • hash, use as dict key

    • +
    • efficient pickling

    • +
    +

    In boolean contexts, a time object is always considered to be true.

    +
    +

    Changed in version 3.5: Before Python 3.5, a time object was considered to be false if it +represented midnight in UTC. This behavior was considered obscure and +error-prone and has been removed in Python 3.5. See bpo-13936 for full +details.

    +
    +

    Other constructor:

    +
    +
    +classmethod time.fromisoformat(time_string)
    +

    Return a time corresponding to a time_string in one of the +formats emitted by time.isoformat(). Specifically, this function supports +strings in the format(s) HH[:MM[:SS[.fff[fff]]]][+HH:MM[:SS[.ffffff]]].

    +
    +

    Caution

    +

    This does not support parsing arbitrary ISO 8601 strings - it is only intended +as the inverse operation of time.isoformat().

    +
    +
    +

    New in version 3.7.

    +
    +
    + +

    Instance methods:

    +
    +
    +time.replace(hour=self.hour, minute=self.minute, second=self.second, microsecond=self.microsecond, tzinfo=self.tzinfo, * fold=0)
    +

    Return a time with the same value, except for those attributes given +new values by whichever keyword arguments are specified. Note that +tzinfo=None can be specified to create a naive time from an +aware time, without conversion of the time data.

    +
    +

    New in version 3.6: Added the fold argument.

    +
    +
    + +
    +
    +time.isoformat(timespec='auto')
    +

    Return a string representing the time in ISO 8601 format, HH:MM:SS.ffffff or, if +microsecond is 0, HH:MM:SS If utcoffset() does not return None, a +string is appended, giving the UTC offset: HH:MM:SS.ffffff+HH:MM[:SS[.ffffff]] +or, if self.microsecond is 0, HH:MM:SS+HH:MM[:SS[.ffffff]].

    +

    The optional argument timespec specifies the number of additional +components of the time to include (the default is 'auto'). +It can be one of the following:

    +
      +
    • 'auto': Same as 'seconds' if microsecond is 0, +same as 'microseconds' otherwise.

    • +
    • 'hours': Include the hour in the two-digit HH format.

    • +
    • 'minutes': Include hour and minute in HH:MM format.

    • +
    • 'seconds': Include hour, minute, and second +in HH:MM:SS format.

    • +
    • 'milliseconds': Include full time, but truncate fractional second +part to milliseconds. HH:MM:SS.sss format.

    • +
    • 'microseconds': Include full time in HH:MM:SS.ffffff format.

    • +
    +
    +

    Note

    +

    Excluded time components are truncated, not rounded.

    +
    +

    ValueError will be raised on an invalid timespec argument.

    +
    >>> from datetime import time
    +>>> time(hour=12, minute=34, second=56, microsecond=123456).isoformat(timespec='minutes')
    +'12:34'
    +>>> dt = time(hour=12, minute=34, second=56, microsecond=0)
    +>>> dt.isoformat(timespec='microseconds')
    +'12:34:56.000000'
    +>>> dt.isoformat(timespec='auto')
    +'12:34:56'
    +
    +
    +
    +

    New in version 3.6: Added the timespec argument.

    +
    +
    + +
    +
    +time.__str__()
    +

    For a time t, str(t) is equivalent to t.isoformat().

    +
    + +
    +
    +time.strftime(format)
    +

    Return a string representing the time, controlled by an explicit format +string. For a complete list of formatting directives, see +strftime() and strptime() Behavior.

    +
    + +
    +
    +time.__format__(format)
    +

    Same as time.strftime(). This makes it possible to specify a format string +for a time object in formatted string +literals and when using str.format(). For a +complete list of formatting directives, see +strftime() and strptime() Behavior.

    +
    + +
    +
    +time.utcoffset()
    +

    If tzinfo is None, returns None, else returns +self.tzinfo.utcoffset(None), and raises an exception if the latter doesn’t +return None or a timedelta object with magnitude less than one day.

    +
    +

    Changed in version 3.7: The UTC offset is not restricted to a whole number of minutes.

    +
    +
    + +
    +
    +time.dst()
    +

    If tzinfo is None, returns None, else returns +self.tzinfo.dst(None), and raises an exception if the latter doesn’t return +None, or a timedelta object with magnitude less than one day.

    +
    +

    Changed in version 3.7: The DST offset is not restricted to a whole number of minutes.

    +
    +
    + +
    +
    +time.tzname()
    +

    If tzinfo is None, returns None, else returns +self.tzinfo.tzname(None), or raises an exception if the latter doesn’t +return None or a string object.

    +
    + +

    Example:

    +
    >>> from datetime import time, tzinfo, timedelta
    +>>> class TZ1(tzinfo):
    +...     def utcoffset(self, dt):
    +...         return timedelta(hours=1)
    +...     def dst(self, dt):
    +...         return timedelta(0)
    +...     def tzname(self,dt):
    +...         return "+01:00"
    +...     def  __repr__(self):
    +...         return f"{self.__class__.__name__}()"
    +...
    +>>> t = time(12, 10, 30, tzinfo=TZ1())
    +>>> t
    +datetime.time(12, 10, 30, tzinfo=TZ1())
    +>>> t.isoformat()
    +'12:10:30+01:00'
    +>>> t.dst()
    +datetime.timedelta(0)
    +>>> t.tzname()
    +'+01:00'
    +>>> t.strftime("%H:%M:%S %Z")
    +'12:10:30 +01:00'
    +>>> 'The {} is {:%H:%M}.'.format("time", t)
    +'The time is 12:10.'
    +
    +
    +
    +
    +

    tzinfo Objects

    +
    +
    +class datetime.tzinfo
    +

    This is an abstract base class, meaning that this class should not be +instantiated directly. You need to derive a concrete subclass, and (at least) +supply implementations of the standard tzinfo methods needed by the +datetime methods you use. The datetime module supplies +a simple concrete subclass of tzinfo, timezone, which can represent +timezones with fixed offset from UTC such as UTC itself or North American EST and +EDT.

    +

    An instance of (a concrete subclass of) tzinfo can be passed to the +constructors for datetime and time objects. The latter objects +view their attributes as being in local time, and the tzinfo object +supports methods revealing offset of local time from UTC, the name of the time +zone, and DST offset, all relative to a date or time object passed to them.

    +

    Special requirement for pickling: A tzinfo subclass must have an +__init__() method that can be called with no arguments, else it can be +pickled but possibly not unpickled again. This is a technical requirement that +may be relaxed in the future.

    +

    A concrete subclass of tzinfo may need to implement the following +methods. Exactly which methods are needed depends on the uses made of aware +datetime objects. If in doubt, simply implement all of them.

    +
    + +
    +
    +tzinfo.utcoffset(dt)
    +

    Return offset of local time from UTC, as a timedelta object that is +positive east of UTC. If local time is +west of UTC, this should be negative. Note that this is intended to be the +total offset from UTC; for example, if a tzinfo object represents both +time zone and DST adjustments, utcoffset() should return their sum. If +the UTC offset isn’t known, return None. Else the value returned must be a +timedelta object strictly between -timedelta(hours=24) and +timedelta(hours=24) (the magnitude of the offset must be less +than one day). Most implementations of utcoffset() will probably look +like one of these two:

    +
    return CONSTANT                 # fixed-offset class
    +return CONSTANT + self.dst(dt)  # daylight-aware class
    +
    +
    +

    If utcoffset() does not return None, dst() should not return +None either.

    +

    The default implementation of utcoffset() raises +NotImplementedError.

    +
    +

    Changed in version 3.7: The UTC offset is not restricted to a whole number of minutes.

    +
    +
    + +
    +
    +tzinfo.dst(dt)
    +

    Return the daylight saving time (DST) adjustment, as a timedelta +object or +None if DST information isn’t known. Return timedelta(0) if DST is not +in effect. If DST is in effect, return the offset as a timedelta object +(see utcoffset() for details). Note that DST offset, if applicable, has +already been added to the UTC offset returned by utcoffset(), so there’s +no need to consult dst() unless you’re interested in obtaining DST info +separately. For example, datetime.timetuple() calls its tzinfo +attribute’s dst() method to determine how the tm_isdst flag +should be set, and tzinfo.fromutc() calls dst() to account for +DST changes when crossing time zones.

    +

    An instance tz of a tzinfo subclass that models both standard and +daylight times must be consistent in this sense:

    +

    tz.utcoffset(dt) - tz.dst(dt)

    +

    must return the same result for every datetime dt with dt.tzinfo == +tz For sane tzinfo subclasses, this expression yields the time +zone’s “standard offset”, which should not depend on the date or the time, but +only on geographic location. The implementation of datetime.astimezone() +relies on this, but cannot detect violations; it’s the programmer’s +responsibility to ensure it. If a tzinfo subclass cannot guarantee +this, it may be able to override the default implementation of +tzinfo.fromutc() to work correctly with astimezone() regardless.

    +

    Most implementations of dst() will probably look like one of these two:

    +
    def dst(self, dt):
    +    # a fixed-offset class:  doesn't account for DST
    +    return timedelta(0)
    +
    +
    +

    or

    +
    def dst(self, dt):
    +    # Code to set dston and dstoff to the time zone's DST
    +    # transition times based on the input dt.year, and expressed
    +    # in standard local time.  Then
    +
    +    if dston <= dt.replace(tzinfo=None) < dstoff:
    +        return timedelta(hours=1)
    +    else:
    +        return timedelta(0)
    +
    +
    +

    The default implementation of dst() raises NotImplementedError.

    +
    +

    Changed in version 3.7: The DST offset is not restricted to a whole number of minutes.

    +
    +
    + +
    +
    +tzinfo.tzname(dt)
    +

    Return the time zone name corresponding to the datetime object dt, as +a string. Nothing about string names is defined by the datetime module, +and there’s no requirement that it mean anything in particular. For example, +“GMT”, “UTC”, “-500”, “-5:00”, “EDT”, “US/Eastern”, “America/New York” are all +valid replies. Return None if a string name isn’t known. Note that this is +a method rather than a fixed string primarily because some tzinfo +subclasses will wish to return different names depending on the specific value +of dt passed, especially if the tzinfo class is accounting for +daylight time.

    +

    The default implementation of tzname() raises NotImplementedError.

    +
    + +

    These methods are called by a datetime or time object, in +response to their methods of the same names. A datetime object passes +itself as the argument, and a time object passes None as the +argument. A tzinfo subclass’s methods should therefore be prepared to +accept a dt argument of None, or of class datetime.

    +

    When None is passed, it’s up to the class designer to decide the best +response. For example, returning None is appropriate if the class wishes to +say that time objects don’t participate in the tzinfo protocols. It +may be more useful for utcoffset(None) to return the standard UTC offset, as +there is no other convention for discovering the standard offset.

    +

    When a datetime object is passed in response to a datetime +method, dt.tzinfo is the same object as self. tzinfo methods can +rely on this, unless user code calls tzinfo methods directly. The +intent is that the tzinfo methods interpret dt as being in local +time, and not need worry about objects in other timezones.

    +

    There is one more tzinfo method that a subclass may wish to override:

    +
    +
    +tzinfo.fromutc(dt)
    +

    This is called from the default datetime.astimezone() +implementation. When called from that, dt.tzinfo is self, and dt’s +date and time data are to be viewed as expressing a UTC time. The purpose +of fromutc() is to adjust the date and time data, returning an +equivalent datetime in self’s local time.

    +

    Most tzinfo subclasses should be able to inherit the default +fromutc() implementation without problems. It’s strong enough to handle +fixed-offset time zones, and time zones accounting for both standard and +daylight time, and the latter even if the DST transition times differ in +different years. An example of a time zone the default fromutc() +implementation may not handle correctly in all cases is one where the standard +offset (from UTC) depends on the specific date and time passed, which can happen +for political reasons. The default implementations of astimezone() and +fromutc() may not produce the result you want if the result is one of the +hours straddling the moment the standard offset changes.

    +

    Skipping code for error cases, the default fromutc() implementation acts +like:

    +
    def fromutc(self, dt):
    +    # raise ValueError error if dt.tzinfo is not self
    +    dtoff = dt.utcoffset()
    +    dtdst = dt.dst()
    +    # raise ValueError if dtoff is None or dtdst is None
    +    delta = dtoff - dtdst  # this is self's standard offset
    +    if delta:
    +        dt += delta   # convert to standard local time
    +        dtdst = dt.dst()
    +        # raise ValueError if dtdst is None
    +    if dtdst:
    +        return dt + dtdst
    +    else:
    +        return dt
    +
    +
    +
    + +

    In the following tzinfo_examples.py file there are some examples of +tzinfo classes:

    +
    from datetime import tzinfo, timedelta, datetime
    +
    +ZERO = timedelta(0)
    +HOUR = timedelta(hours=1)
    +SECOND = timedelta(seconds=1)
    +
    +# A class capturing the platform's idea of local time.
    +# (May result in wrong values on historical times in
    +#  timezones where UTC offset and/or the DST rules had
    +#  changed in the past.)
    +import time as _time
    +
    +STDOFFSET = timedelta(seconds = -_time.timezone)
    +if _time.daylight:
    +    DSTOFFSET = timedelta(seconds = -_time.altzone)
    +else:
    +    DSTOFFSET = STDOFFSET
    +
    +DSTDIFF = DSTOFFSET - STDOFFSET
    +
    +class LocalTimezone(tzinfo):
    +
    +    def fromutc(self, dt):
    +        assert dt.tzinfo is self
    +        stamp = (dt - datetime(1970, 1, 1, tzinfo=self)) // SECOND
    +        args = _time.localtime(stamp)[:6]
    +        dst_diff = DSTDIFF // SECOND
    +        # Detect fold
    +        fold = (args == _time.localtime(stamp - dst_diff))
    +        return datetime(*args, microsecond=dt.microsecond,
    +                        tzinfo=self, fold=fold)
    +
    +    def utcoffset(self, dt):
    +        if self._isdst(dt):
    +            return DSTOFFSET
    +        else:
    +            return STDOFFSET
    +
    +    def dst(self, dt):
    +        if self._isdst(dt):
    +            return DSTDIFF
    +        else:
    +            return ZERO
    +
    +    def tzname(self, dt):
    +        return _time.tzname[self._isdst(dt)]
    +
    +    def _isdst(self, dt):
    +        tt = (dt.year, dt.month, dt.day,
    +              dt.hour, dt.minute, dt.second,
    +              dt.weekday(), 0, 0)
    +        stamp = _time.mktime(tt)
    +        tt = _time.localtime(stamp)
    +        return tt.tm_isdst > 0
    +
    +Local = LocalTimezone()
    +
    +
    +# A complete implementation of current DST rules for major US time zones.
    +
    +def first_sunday_on_or_after(dt):
    +    days_to_go = 6 - dt.weekday()
    +    if days_to_go:
    +        dt += timedelta(days_to_go)
    +    return dt
    +
    +
    +# US DST Rules
    +#
    +# This is a simplified (i.e., wrong for a few cases) set of rules for US
    +# DST start and end times. For a complete and up-to-date set of DST rules
    +# and timezone definitions, visit the Olson Database (or try pytz):
    +# http://www.twinsun.com/tz/tz-link.htm
    +# http://sourceforge.net/projects/pytz/ (might not be up-to-date)
    +#
    +# In the US, since 2007, DST starts at 2am (standard time) on the second
    +# Sunday in March, which is the first Sunday on or after Mar 8.
    +DSTSTART_2007 = datetime(1, 3, 8, 2)
    +# and ends at 2am (DST time) on the first Sunday of Nov.
    +DSTEND_2007 = datetime(1, 11, 1, 2)
    +# From 1987 to 2006, DST used to start at 2am (standard time) on the first
    +# Sunday in April and to end at 2am (DST time) on the last
    +# Sunday of October, which is the first Sunday on or after Oct 25.
    +DSTSTART_1987_2006 = datetime(1, 4, 1, 2)
    +DSTEND_1987_2006 = datetime(1, 10, 25, 2)
    +# From 1967 to 1986, DST used to start at 2am (standard time) on the last
    +# Sunday in April (the one on or after April 24) and to end at 2am (DST time)
    +# on the last Sunday of October, which is the first Sunday
    +# on or after Oct 25.
    +DSTSTART_1967_1986 = datetime(1, 4, 24, 2)
    +DSTEND_1967_1986 = DSTEND_1987_2006
    +
    +def us_dst_range(year):
    +    # Find start and end times for US DST. For years before 1967, return
    +    # start = end for no DST.
    +    if 2006 < year:
    +        dststart, dstend = DSTSTART_2007, DSTEND_2007
    +    elif 1986 < year < 2007:
    +        dststart, dstend = DSTSTART_1987_2006, DSTEND_1987_2006
    +    elif 1966 < year < 1987:
    +        dststart, dstend = DSTSTART_1967_1986, DSTEND_1967_1986
    +    else:
    +        return (datetime(year, 1, 1), ) * 2
    +
    +    start = first_sunday_on_or_after(dststart.replace(year=year))
    +    end = first_sunday_on_or_after(dstend.replace(year=year))
    +    return start, end
    +
    +
    +class USTimeZone(tzinfo):
    +
    +    def __init__(self, hours, reprname, stdname, dstname):
    +        self.stdoffset = timedelta(hours=hours)
    +        self.reprname = reprname
    +        self.stdname = stdname
    +        self.dstname = dstname
    +
    +    def __repr__(self):
    +        return self.reprname
    +
    +    def tzname(self, dt):
    +        if self.dst(dt):
    +            return self.dstname
    +        else:
    +            return self.stdname
    +
    +    def utcoffset(self, dt):
    +        return self.stdoffset + self.dst(dt)
    +
    +    def dst(self, dt):
    +        if dt is None or dt.tzinfo is None:
    +            # An exception may be sensible here, in one or both cases.
    +            # It depends on how you want to treat them.  The default
    +            # fromutc() implementation (called by the default astimezone()
    +            # implementation) passes a datetime with dt.tzinfo is self.
    +            return ZERO
    +        assert dt.tzinfo is self
    +        start, end = us_dst_range(dt.year)
    +        # Can't compare naive to aware objects, so strip the timezone from
    +        # dt first.
    +        dt = dt.replace(tzinfo=None)
    +        if start + HOUR <= dt < end - HOUR:
    +            # DST is in effect.
    +            return HOUR
    +        if end - HOUR <= dt < end:
    +            # Fold (an ambiguous hour): use dt.fold to disambiguate.
    +            return ZERO if dt.fold else HOUR
    +        if start <= dt < start + HOUR:
    +            # Gap (a non-existent hour): reverse the fold rule.
    +            return HOUR if dt.fold else ZERO
    +        # DST is off.
    +        return ZERO
    +
    +    def fromutc(self, dt):
    +        assert dt.tzinfo is self
    +        start, end = us_dst_range(dt.year)
    +        start = start.replace(tzinfo=self)
    +        end = end.replace(tzinfo=self)
    +        std_time = dt + self.stdoffset
    +        dst_time = std_time + HOUR
    +        if end <= dst_time < end + HOUR:
    +            # Repeated hour
    +            return std_time.replace(fold=1)
    +        if std_time < start or dst_time >= end:
    +            # Standard time
    +            return std_time
    +        if start <= std_time < end - HOUR:
    +            # Daylight saving time
    +            return dst_time
    +
    +
    +Eastern  = USTimeZone(-5, "Eastern",  "EST", "EDT")
    +Central  = USTimeZone(-6, "Central",  "CST", "CDT")
    +Mountain = USTimeZone(-7, "Mountain", "MST", "MDT")
    +Pacific  = USTimeZone(-8, "Pacific",  "PST", "PDT")
    +
    +
    +

    Note that there are unavoidable subtleties twice per year in a tzinfo +subclass accounting for both standard and daylight time, at the DST transition +points. For concreteness, consider US Eastern (UTC -0500), where EDT begins the +minute after 1:59 (EST) on the second Sunday in March, and ends the minute after +1:59 (EDT) on the first Sunday in November:

    +
      UTC   3:MM  4:MM  5:MM  6:MM  7:MM  8:MM
    +  EST  22:MM 23:MM  0:MM  1:MM  2:MM  3:MM
    +  EDT  23:MM  0:MM  1:MM  2:MM  3:MM  4:MM
    +
    +start  22:MM 23:MM  0:MM  1:MM  3:MM  4:MM
    +
    +  end  23:MM  0:MM  1:MM  1:MM  2:MM  3:MM
    +
    +
    +

    When DST starts (the “start” line), the local wall clock leaps from 1:59 to +3:00. A wall time of the form 2:MM doesn’t really make sense on that day, so +astimezone(Eastern) won’t deliver a result with hour == 2 on the day DST +begins. For example, at the Spring forward transition of 2016, we get

    +
    >>> from datetime import datetime, timezone
    +>>> from tzinfo_examples import HOUR, Eastern
    +>>> u0 = datetime(2016, 3, 13, 5, tzinfo=timezone.utc)
    +>>> for i in range(4):
    +...     u = u0 + i*HOUR
    +...     t = u.astimezone(Eastern)
    +...     print(u.time(), 'UTC =', t.time(), t.tzname())
    +...
    +05:00:00 UTC = 00:00:00 EST
    +06:00:00 UTC = 01:00:00 EST
    +07:00:00 UTC = 03:00:00 EDT
    +08:00:00 UTC = 04:00:00 EDT
    +
    +
    +

    When DST ends (the “end” line), there’s a potentially worse problem: there’s an +hour that can’t be spelled unambiguously in local wall time: the last hour of +daylight time. In Eastern, that’s times of the form 5:MM UTC on the day +daylight time ends. The local wall clock leaps from 1:59 (daylight time) back +to 1:00 (standard time) again. Local times of the form 1:MM are ambiguous. +astimezone() mimics the local clock’s behavior by mapping two adjacent UTC +hours into the same local hour then. In the Eastern example, UTC times of the +form 5:MM and 6:MM both map to 1:MM when converted to Eastern, but earlier times +have the fold attribute set to 0 and the later times have it set to 1. +For example, at the Fall back transition of 2016, we get

    +
    >>> u0 = datetime(2016, 11, 6, 4, tzinfo=timezone.utc)
    +>>> for i in range(4):
    +...     u = u0 + i*HOUR
    +...     t = u.astimezone(Eastern)
    +...     print(u.time(), 'UTC =', t.time(), t.tzname(), t.fold)
    +...
    +04:00:00 UTC = 00:00:00 EDT 0
    +05:00:00 UTC = 01:00:00 EDT 0
    +06:00:00 UTC = 01:00:00 EST 1
    +07:00:00 UTC = 02:00:00 EST 0
    +
    +
    +

    Note that the datetime instances that differ only by the value of the +fold attribute are considered equal in comparisons.

    +

    Applications that can’t bear wall-time ambiguities should explicitly check the +value of the fold attribute or avoid using hybrid +tzinfo subclasses; there are no ambiguities when using timezone, +or any other fixed-offset tzinfo subclass (such as a class representing +only EST (fixed offset -5 hours), or only EDT (fixed offset -4 hours)).

    +
    +

    See also

    +
    +
    dateutil.tz

    The standard library has timezone class for handling arbitrary +fixed offsets from UTC and timezone.utc as UTC timezone instance.

    +

    dateutil.tz library brings the IANA timezone database (also known as the +Olson database) to Python and its usage is recommended.

    +
    +
    IANA timezone database

    The Time Zone Database (often called tz, tzdata or zoneinfo) contains code and +data that represent the history of local time for many representative +locations around the globe. It is updated periodically to reflect changes +made by political bodies to time zone boundaries, UTC offsets, and +daylight-saving rules.

    +
    +
    +
    +
    +
    +

    timezone Objects

    +

    The timezone class is a subclass of tzinfo, each +instance of which represents a timezone defined by a fixed offset from +UTC. Note that objects of this class cannot be used to represent +timezone information in the locations where different offsets are used +in different days of the year or where historical changes have been +made to civil time.

    +
    +
    +class datetime.timezone(offset, name=None)
    +

    The offset argument must be specified as a timedelta +object representing the difference between the local time and UTC. It must +be strictly between -timedelta(hours=24) and +timedelta(hours=24), otherwise ValueError is raised.

    +

    The name argument is optional. If specified it must be a string that +will be used as the value returned by the datetime.tzname() method.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.7: The UTC offset is not restricted to a whole number of minutes.

    +
    +
    + +
    +
    +timezone.utcoffset(dt)
    +

    Return the fixed value specified when the timezone instance is +constructed. The dt argument is ignored. The return value is a +timedelta instance equal to the difference between the +local time and UTC.

    +
    +

    Changed in version 3.7: The UTC offset is not restricted to a whole number of minutes.

    +
    +
    + +
    +
    +timezone.tzname(dt)
    +

    Return the fixed value specified when the timezone instance +is constructed. If name is not provided in the constructor, the +name returned by tzname(dt) is generated from the value of the +offset as follows. If offset is timedelta(0), the name +is “UTC”, otherwise it is a string ‘UTC±HH:MM’, where ± is the sign +of offset, HH and MM are two digits of offset.hours and +offset.minutes respectively.

    +
    +

    Changed in version 3.6: Name generated from offset=timedelta(0) is now plain ‘UTC’, not +‘UTC+00:00’.

    +
    +
    + +
    +
    +timezone.dst(dt)
    +

    Always returns None.

    +
    + +
    +
    +timezone.fromutc(dt)
    +

    Return dt + offset. The dt argument must be an aware +datetime instance, with tzinfo set to self.

    +
    + +

    Class attributes:

    +
    +
    +timezone.utc
    +

    The UTC timezone, timezone(timedelta(0)).

    +
    + +
    +
    +

    strftime() and strptime() Behavior

    +

    date, datetime, and time objects all support a +strftime(format) method, to create a string representing the time under the +control of an explicit format string. Broadly speaking, d.strftime(fmt) +acts like the time module’s time.strftime(fmt, d.timetuple()) +although not all objects support a timetuple() method.

    +

    Conversely, the datetime.strptime() class method creates a +datetime object from a string representing a date and time and a +corresponding format string. datetime.strptime(date_string, format) is +equivalent to datetime(*(time.strptime(date_string, format)[0:6])), except +when the format includes sub-second components or timezone offset information, +which are supported in datetime.strptime but are discarded by time.strptime.

    +

    For time objects, the format codes for year, month, and day should not +be used, as time objects have no such values. If they’re used anyway, 1900 +is substituted for the year, and 1 for the month and day.

    +

    For date objects, the format codes for hours, minutes, seconds, and +microseconds should not be used, as date objects have no such +values. If they’re used anyway, 0 is substituted for them.

    +

    For the datetime.strptime() class method, the default value is 1900-01-01T00:00:00.000: +any components not specified in the format string will be pulled from the default value. 2

    +

    The full set of format codes supported varies across platforms, because Python +calls the platform C library’s strftime() function, and platform +variations are common. To see the full set of format codes supported on your +platform, consult the strftime(3) documentation.

    +

    For the same reason, handling of format strings containing Unicode code points +that can’t be represented in the charset of the current locale is also +platform-dependent. On some platforms such code points are preserved intact in +the output, while on others strftime may raise UnicodeError or return +an empty string instead.

    +

    The following is a list of all the format codes that the C standard (1989 +version) requires, and these work on all platforms with a standard C +implementation. Note that the 1999 version of the C standard added additional +format codes.

    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Directive

    Meaning

    Example

    Notes

    %a

    Weekday as locale’s +abbreviated name.

    +
    Sun, Mon, …, Sat +(en_US);
    +
    So, Mo, …, Sa +(de_DE)
    +
    +

    (1)

    %A

    Weekday as locale’s full name.

    +
    Sunday, Monday, …, +Saturday (en_US);
    +
    Sonntag, Montag, …, +Samstag (de_DE)
    +
    +

    (1)

    %w

    Weekday as a decimal number, +where 0 is Sunday and 6 is +Saturday.

    0, 1, …, 6

    %d

    Day of the month as a +zero-padded decimal number.

    01, 02, …, 31

    (9)

    %b

    Month as locale’s abbreviated +name.

    +
    Jan, Feb, …, Dec +(en_US);
    +
    Jan, Feb, …, Dez +(de_DE)
    +
    +

    (1)

    %B

    Month as locale’s full name.

    +
    January, February, +…, December (en_US);
    +
    Januar, Februar, …, +Dezember (de_DE)
    +
    +

    (1)

    %m

    Month as a zero-padded +decimal number.

    01, 02, …, 12

    (9)

    %y

    Year without century as a +zero-padded decimal number.

    00, 01, …, 99

    (9)

    %Y

    Year with century as a decimal +number.

    0001, 0002, …, 2013, +2014, …, 9998, 9999

    (2)

    %H

    Hour (24-hour clock) as a +zero-padded decimal number.

    00, 01, …, 23

    (9)

    %I

    Hour (12-hour clock) as a +zero-padded decimal number.

    01, 02, …, 12

    (9)

    %p

    Locale’s equivalent of either +AM or PM.

    +
    AM, PM (en_US);
    +
    am, pm (de_DE)
    +
    +

    (1), +(3)

    %M

    Minute as a zero-padded +decimal number.

    00, 01, …, 59

    (9)

    %S

    Second as a zero-padded +decimal number.

    00, 01, …, 59

    (4), +(9)

    %f

    Microsecond as a decimal +number, zero-padded on the +left.

    000000, 000001, …, +999999

    (5)

    %z

    UTC offset in the form +±HHMM[SS[.ffffff]] (empty +string if the object is +naive).

    (empty), +0000, +-0400, +1030, ++063415, +-030712.345216

    (6)

    %Z

    Time zone name (empty string +if the object is naive).

    (empty), UTC, EST, CST

    %j

    Day of the year as a +zero-padded decimal number.

    001, 002, …, 366

    (9)

    %U

    Week number of the year +(Sunday as the first day of +the week) as a zero padded +decimal number. All days in a +new year preceding the first +Sunday are considered to be in +week 0.

    00, 01, …, 53

    (7), +(9)

    %W

    Week number of the year +(Monday as the first day of +the week) as a decimal number. +All days in a new year +preceding the first Monday +are considered to be in +week 0.

    00, 01, …, 53

    (7), +(9)

    %c

    Locale’s appropriate date and +time representation.

    +
    Tue Aug 16 21:30:00 +1988 (en_US);
    +
    Di 16 Aug 21:30:00 +1988 (de_DE)
    +
    +

    (1)

    %x

    Locale’s appropriate date +representation.

    +
    08/16/88 (None);
    +
    08/16/1988 (en_US);
    +
    16.08.1988 (de_DE)
    +
    +

    (1)

    %X

    Locale’s appropriate time +representation.

    +
    21:30:00 (en_US);
    +
    21:30:00 (de_DE)
    +
    +

    (1)

    %%

    A literal '%' character.

    %

    +

    Several additional directives not required by the C89 standard are included for +convenience. These parameters all correspond to ISO 8601 date values. These +may not be available on all platforms when used with the strftime() +method. The ISO 8601 year and ISO 8601 week directives are not interchangeable +with the year and week number directives above. Calling strptime() with +incomplete or ambiguous ISO 8601 directives will raise a ValueError.

    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + +

    Directive

    Meaning

    Example

    Notes

    %G

    ISO 8601 year with century +representing the year that +contains the greater part of +the ISO week (%V).

    0001, 0002, …, 2013, +2014, …, 9998, 9999

    (8)

    %u

    ISO 8601 weekday as a decimal +number where 1 is Monday.

    1, 2, …, 7

    %V

    ISO 8601 week as a decimal +number with Monday as +the first day of the week. +Week 01 is the week containing +Jan 4.

    01, 02, …, 53

    (8), +(9)

    +
    +

    New in version 3.6: %G, %u and %V were added.

    +
    +

    Notes:

    +
      +
    1. Because the format depends on the current locale, care should be taken when +making assumptions about the output value. Field orderings will vary (for +example, “month/day/year” versus “day/month/year”), and the output may +contain Unicode characters encoded using the locale’s default encoding (for +example, if the current locale is ja_JP, the default encoding could be +any one of eucJP, SJIS, or utf-8; use locale.getlocale() +to determine the current locale’s encoding).

    2. +
    3. The strptime() method can parse years in the full [1, 9999] range, but +years < 1000 must be zero-filled to 4-digit width.

      +
      +

      Changed in version 3.2: In previous versions, strftime() method was restricted to +years >= 1900.

      +
      +
      +

      Changed in version 3.3: In version 3.2, strftime() method was restricted to +years >= 1000.

      +
      +
    4. +
    5. When used with the strptime() method, the %p directive only affects +the output hour field if the %I directive is used to parse the hour.

    6. +
    7. Unlike the time module, the datetime module does not support +leap seconds.

    8. +
    9. When used with the strptime() method, the %f directive +accepts from one to six digits and zero pads on the right. %f is +an extension to the set of format characters in the C standard (but +implemented separately in datetime objects, and therefore always +available).

    10. +
    11. For a naive object, the %z and %Z format codes are replaced by empty +strings.

      +

      For an aware object:

      +
      +
      %z

      utcoffset() is transformed into a string of the form +±HHMM[SS[.ffffff]], where HH is a 2-digit string giving the number of UTC +offset hours, MM is a 2-digit string giving the number of UTC offset +minutes, SS is a 2-digit string giving the number of UTC offset +seconds and ffffff is a 6-digit string giving the number of UTC +offset microseconds. The ffffff part is omitted when the offset is a +whole number of seconds and both the ffffff and the SS part is omitted +when the offset is a whole number of minutes. For example, if +utcoffset() returns timedelta(hours=-3, minutes=-30), %z is +replaced with the string '-0330'.

      +
      +
      +
      +

      Changed in version 3.7: The UTC offset is not restricted to a whole number of minutes.

      +
      +
      +

      Changed in version 3.7: When the %z directive is provided to the strptime() method, +the UTC offsets can have a colon as a separator between hours, minutes +and seconds. +For example, '+01:00:00' will be parsed as an offset of one hour. +In addition, providing 'Z' is identical to '+00:00'.

      +
      +
      +
      %Z

      If tzname() returns None, %Z is replaced by an empty +string. Otherwise %Z is replaced by the returned value, which must +be a string.

      +
      +
      +
      +

      Changed in version 3.2: When the %z directive is provided to the strptime() method, an +aware datetime object will be produced. The tzinfo of the +result will be set to a timezone instance.

      +
      +
    12. +
    13. When used with the strptime() method, %U and %W are only used +in calculations when the day of the week and the calendar year (%Y) +are specified.

    14. +
    15. Similar to %U and %W, %V is only used in calculations when the +day of the week and the ISO year (%G) are specified in a +strptime() format string. Also note that %G and %Y are not +interchangeable.

    16. +
    17. When used with the strptime() method, the leading zero is optional +for formats %d, %m, %H, %I, %M, %S, %J, %U, +%W, and %V. Format %y does require a leading zero.

    18. +
    +

    Footnotes

    +
    +
    1
    +

    If, that is, we ignore the effects of Relativity

    +
    +
    2
    +

    Passing datetime.strptime('Feb 29', '%b %d') will fail since 1900 is not a leap year.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/dbm.html b/python-3.7.4-docs-html/library/dbm.html new file mode 100644 index 0000000..2ec7c67 --- /dev/null +++ b/python-3.7.4-docs-html/library/dbm.html @@ -0,0 +1,593 @@ + + + + + + + dbm — Interfaces to Unix “databases” — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    dbm — Interfaces to Unix “databases”

    +

    Source code: Lib/dbm/__init__.py

    +
    +

    dbm is a generic interface to variants of the DBM database — +dbm.gnu or dbm.ndbm. If none of these modules is installed, the +slow-but-simple implementation in module dbm.dumb will be used. There +is a third party interface to +the Oracle Berkeley DB.

    +
    +
    +exception dbm.error
    +

    A tuple containing the exceptions that can be raised by each of the supported +modules, with a unique exception also named dbm.error as the first +item — the latter is used when dbm.error is raised.

    +
    + +
    +
    +dbm.whichdb(filename)
    +

    This function attempts to guess which of the several simple database modules +available — dbm.gnu, dbm.ndbm or dbm.dumb — should +be used to open a given file.

    +

    Returns one of the following values: None if the file can’t be opened +because it’s unreadable or doesn’t exist; the empty string ('') if the +file’s format can’t be guessed; or a string containing the required module +name, such as 'dbm.ndbm' or 'dbm.gnu'.

    +
    + +
    +
    +dbm.open(file, flag='r', mode=0o666)
    +

    Open the database file file and return a corresponding object.

    +

    If the database file already exists, the whichdb() function is used to +determine its type and the appropriate module is used; if it does not exist, +the first module listed above that can be imported is used.

    +

    The optional flag argument can be:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Value

    Meaning

    'r'

    Open existing database for reading only +(default)

    'w'

    Open existing database for reading and +writing

    'c'

    Open database for reading and writing, +creating it if it doesn’t exist

    'n'

    Always create a new, empty database, open +for reading and writing

    +

    The optional mode argument is the Unix mode of the file, used only when the +database has to be created. It defaults to octal 0o666 (and will be +modified by the prevailing umask).

    +
    + +

    The object returned by open() supports the same basic functionality as +dictionaries; keys and their corresponding values can be stored, retrieved, and +deleted, and the in operator and the keys() method are +available, as well as get() and setdefault().

    +
    +

    Changed in version 3.2: get() and setdefault() are now available in all database modules.

    +
    +

    Key and values are always stored as bytes. This means that when +strings are used they are implicitly converted to the default encoding before +being stored.

    +

    These objects also support being used in a with statement, which +will automatically close them when done.

    +
    +

    Changed in version 3.4: Added native support for the context management protocol to the objects +returned by open().

    +
    +

    The following example records some hostnames and a corresponding title, and +then prints out the contents of the database:

    +
    import dbm
    +
    +# Open database, creating it if necessary.
    +with dbm.open('cache', 'c') as db:
    +
    +    # Record some values
    +    db[b'hello'] = b'there'
    +    db['www.python.org'] = 'Python Website'
    +    db['www.cnn.com'] = 'Cable News Network'
    +
    +    # Note that the keys are considered bytes now.
    +    assert db[b'www.python.org'] == b'Python Website'
    +    # Notice how the value is now in bytes.
    +    assert db['www.cnn.com'] == b'Cable News Network'
    +
    +    # Often-used methods of the dict interface work too.
    +    print(db.get('python.org', b'not present'))
    +
    +    # Storing a non-string key or value will raise an exception (most
    +    # likely a TypeError).
    +    db['www.yahoo.com'] = 4
    +
    +# db is automatically closed when leaving the with statement.
    +
    +
    +
    +

    See also

    +
    +
    Module shelve

    Persistence module which stores non-string data.

    +
    +
    +
    +

    The individual submodules are described in the following sections.

    +
    +

    dbm.gnu — GNU’s reinterpretation of dbm

    +

    Source code: Lib/dbm/gnu.py

    +
    +

    This module is quite similar to the dbm module, but uses the GNU library +gdbm instead to provide some additional functionality. Please note that the +file formats created by dbm.gnu and dbm.ndbm are incompatible.

    +

    The dbm.gnu module provides an interface to the GNU DBM library. +dbm.gnu.gdbm objects behave like mappings (dictionaries), except that keys and +values are always converted to bytes before storing. Printing a gdbm +object doesn’t print the +keys and values, and the items() and values() methods are not +supported.

    +
    +
    +exception dbm.gnu.error
    +

    Raised on dbm.gnu-specific errors, such as I/O errors. KeyError is +raised for general mapping errors like specifying an incorrect key.

    +
    + +
    +
    +dbm.gnu.open(filename[, flag[, mode]])
    +

    Open a gdbm database and return a gdbm object. The filename +argument is the name of the database file.

    +

    The optional flag argument can be:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Value

    Meaning

    'r'

    Open existing database for reading only +(default)

    'w'

    Open existing database for reading and +writing

    'c'

    Open database for reading and writing, +creating it if it doesn’t exist

    'n'

    Always create a new, empty database, open +for reading and writing

    +

    The following additional characters may be appended to the flag to control +how the database is opened:

    + ++++ + + + + + + + + + + + + + + + + +

    Value

    Meaning

    'f'

    Open the database in fast mode. Writes +to the database will not be synchronized.

    's'

    Synchronized mode. This will cause changes +to the database to be immediately written +to the file.

    'u'

    Do not lock database.

    +

    Not all flags are valid for all versions of gdbm. The module constant +open_flags is a string of supported flag characters. The exception +error is raised if an invalid flag is specified.

    +

    The optional mode argument is the Unix mode of the file, used only when the +database has to be created. It defaults to octal 0o666.

    +

    In addition to the dictionary-like methods, gdbm objects have the +following methods:

    +
    +
    +gdbm.firstkey()
    +

    It’s possible to loop over every key in the database using this method and the +nextkey() method. The traversal is ordered by gdbm’s internal +hash values, and won’t be sorted by the key values. This method returns +the starting key.

    +
    + +
    +
    +gdbm.nextkey(key)
    +

    Returns the key that follows key in the traversal. The following code prints +every key in the database db, without having to create a list in memory that +contains them all:

    +
    k = db.firstkey()
    +while k != None:
    +    print(k)
    +    k = db.nextkey(k)
    +
    +
    +
    + +
    +
    +gdbm.reorganize()
    +

    If you have carried out a lot of deletions and would like to shrink the space +used by the gdbm file, this routine will reorganize the database. gdbm +objects will not shorten the length of a database file except by using this +reorganization; otherwise, deleted file space will be kept and reused as new +(key, value) pairs are added.

    +
    + +
    +
    +gdbm.sync()
    +

    When the database has been opened in fast mode, this method forces any +unwritten data to be written to the disk.

    +
    + +
    +
    +gdbm.close()
    +

    Close the gdbm database.

    +
    + +
    + +
    +
    +

    dbm.ndbm — Interface based on ndbm

    +

    Source code: Lib/dbm/ndbm.py

    +
    +

    The dbm.ndbm module provides an interface to the Unix “(n)dbm” library. +Dbm objects behave like mappings (dictionaries), except that keys and values are +always stored as bytes. Printing a dbm object doesn’t print the keys and +values, and the items() and values() methods are not supported.

    +

    This module can be used with the “classic” ndbm interface or the GNU GDBM +compatibility interface. On Unix, the configure script will attempt +to locate the appropriate header file to simplify building this module.

    +
    +
    +exception dbm.ndbm.error
    +

    Raised on dbm.ndbm-specific errors, such as I/O errors. KeyError is raised +for general mapping errors like specifying an incorrect key.

    +
    + +
    +
    +dbm.ndbm.library
    +

    Name of the ndbm implementation library used.

    +
    + +
    +
    +dbm.ndbm.open(filename[, flag[, mode]])
    +

    Open a dbm database and return a ndbm object. The filename argument is the +name of the database file (without the .dir or .pag extensions).

    +

    The optional flag argument must be one of these values:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Value

    Meaning

    'r'

    Open existing database for reading only +(default)

    'w'

    Open existing database for reading and +writing

    'c'

    Open database for reading and writing, +creating it if it doesn’t exist

    'n'

    Always create a new, empty database, open +for reading and writing

    +

    The optional mode argument is the Unix mode of the file, used only when the +database has to be created. It defaults to octal 0o666 (and will be +modified by the prevailing umask).

    +

    In addition to the dictionary-like methods, ndbm objects +provide the following method:

    +
    +
    +ndbm.close()
    +

    Close the ndbm database.

    +
    + +
    + +
    +
    +

    dbm.dumb — Portable DBM implementation

    +

    Source code: Lib/dbm/dumb.py

    +
    +

    Note

    +

    The dbm.dumb module is intended as a last resort fallback for the +dbm module when a more robust module is not available. The dbm.dumb +module is not written for speed and is not nearly as heavily used as the other +database modules.

    +
    +
    +

    The dbm.dumb module provides a persistent dictionary-like interface which +is written entirely in Python. Unlike other modules such as dbm.gnu no +external library is required. As with other persistent mappings, the keys and +values are always stored as bytes.

    +

    The module defines the following:

    +
    +
    +exception dbm.dumb.error
    +

    Raised on dbm.dumb-specific errors, such as I/O errors. KeyError is +raised for general mapping errors like specifying an incorrect key.

    +
    + +
    +
    +dbm.dumb.open(filename[, flag[, mode]])
    +

    Open a dumbdbm database and return a dumbdbm object. The filename argument is +the basename of the database file (without any specific extensions). When a +dumbdbm database is created, files with .dat and .dir extensions +are created.

    +

    The optional flag argument supports only the semantics of 'c' +and 'n' values. Other values will default to database being always +opened for update, and will be created if it does not exist.

    +

    The optional mode argument is the Unix mode of the file, used only when the +database has to be created. It defaults to octal 0o666 (and will be modified +by the prevailing umask).

    +
    +

    Warning

    +

    It is possible to crash the Python interpreter when loading a database +with a sufficiently large/complex entry due to stack depth limitations in +Python’s AST compiler.

    +
    +
    +

    Changed in version 3.5: open() always creates a new database when the flag has the value +'n'.

    +
    +
    +

    Deprecated since version 3.6, will be removed in version 3.8: Creating database in 'r' and 'w' modes. Modifying database in +'r' mode.

    +
    +

    In addition to the methods provided by the +collections.abc.MutableMapping class, dumbdbm objects +provide the following methods:

    +
    +
    +dumbdbm.sync()
    +

    Synchronize the on-disk directory and data files. This method is called +by the Shelve.sync() method.

    +
    + +
    +
    +dumbdbm.close()
    +

    Close the dumbdbm database.

    +
    + +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/debug.html b/python-3.7.4-docs-html/library/debug.html new file mode 100644 index 0000000..4390165 --- /dev/null +++ b/python-3.7.4-docs-html/library/debug.html @@ -0,0 +1,253 @@ + + + + + + + Debugging and Profiling — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/decimal.html b/python-3.7.4-docs-html/library/decimal.html new file mode 100644 index 0000000..8bf0e31 --- /dev/null +++ b/python-3.7.4-docs-html/library/decimal.html @@ -0,0 +1,2419 @@ + + + + + + + decimal — Decimal fixed point and floating point arithmetic — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    decimal — Decimal fixed point and floating point arithmetic

    +

    Source code: Lib/decimal.py

    +
    +

    The decimal module provides support for fast correctly-rounded +decimal floating point arithmetic. It offers several advantages over the +float datatype:

    +
      +
    • Decimal “is based on a floating-point model which was designed with people +in mind, and necessarily has a paramount guiding principle – computers must +provide an arithmetic that works in the same way as the arithmetic that +people learn at school.” – excerpt from the decimal arithmetic specification.

    • +
    • Decimal numbers can be represented exactly. In contrast, numbers like +1.1 and 2.2 do not have exact representations in binary +floating point. End users typically would not expect 1.1 + 2.2 to display +as 3.3000000000000003 as it does with binary floating point.

    • +
    • The exactness carries over into arithmetic. In decimal floating point, 0.1 ++ 0.1 + 0.1 - 0.3 is exactly equal to zero. In binary floating point, the result +is 5.5511151231257827e-017. While near to zero, the differences +prevent reliable equality testing and differences can accumulate. For this +reason, decimal is preferred in accounting applications which have strict +equality invariants.

    • +
    • The decimal module incorporates a notion of significant places so that 1.30 ++ 1.20 is 2.50. The trailing zero is kept to indicate significance. +This is the customary presentation for monetary applications. For +multiplication, the “schoolbook” approach uses all the figures in the +multiplicands. For instance, 1.3 * 1.2 gives 1.56 while 1.30 * +1.20 gives 1.5600.

    • +
    • Unlike hardware based binary floating point, the decimal module has a user +alterable precision (defaulting to 28 places) which can be as large as needed for +a given problem:

      +
      >>> from decimal import *
      +>>> getcontext().prec = 6
      +>>> Decimal(1) / Decimal(7)
      +Decimal('0.142857')
      +>>> getcontext().prec = 28
      +>>> Decimal(1) / Decimal(7)
      +Decimal('0.1428571428571428571428571429')
      +
      +
      +
    • +
    • Both binary and decimal floating point are implemented in terms of published +standards. While the built-in float type exposes only a modest portion of its +capabilities, the decimal module exposes all required parts of the standard. +When needed, the programmer has full control over rounding and signal handling. +This includes an option to enforce exact arithmetic by using exceptions +to block any inexact operations.

    • +
    • The decimal module was designed to support “without prejudice, both exact +unrounded decimal arithmetic (sometimes called fixed-point arithmetic) +and rounded floating-point arithmetic.” – excerpt from the decimal +arithmetic specification.

    • +
    +

    The module design is centered around three concepts: the decimal number, the +context for arithmetic, and signals.

    +

    A decimal number is immutable. It has a sign, coefficient digits, and an +exponent. To preserve significance, the coefficient digits do not truncate +trailing zeros. Decimals also include special values such as +Infinity, -Infinity, and NaN. The standard also +differentiates -0 from +0.

    +

    The context for arithmetic is an environment specifying precision, rounding +rules, limits on exponents, flags indicating the results of operations, and trap +enablers which determine whether signals are treated as exceptions. Rounding +options include ROUND_CEILING, ROUND_DOWN, +ROUND_FLOOR, ROUND_HALF_DOWN, ROUND_HALF_EVEN, +ROUND_HALF_UP, ROUND_UP, and ROUND_05UP.

    +

    Signals are groups of exceptional conditions arising during the course of +computation. Depending on the needs of the application, signals may be ignored, +considered as informational, or treated as exceptions. The signals in the +decimal module are: Clamped, InvalidOperation, +DivisionByZero, Inexact, Rounded, Subnormal, +Overflow, Underflow and FloatOperation.

    +

    For each signal there is a flag and a trap enabler. When a signal is +encountered, its flag is set to one, then, if the trap enabler is +set to one, an exception is raised. Flags are sticky, so the user needs to +reset them before monitoring a calculation.

    +
    +

    See also

    + +
    +
    +

    Quick-start Tutorial

    +

    The usual start to using decimals is importing the module, viewing the current +context with getcontext() and, if necessary, setting new values for +precision, rounding, or enabled traps:

    +
    >>> from decimal import *
    +>>> getcontext()
    +Context(prec=28, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999,
    +        capitals=1, clamp=0, flags=[], traps=[Overflow, DivisionByZero,
    +        InvalidOperation])
    +
    +>>> getcontext().prec = 7       # Set a new precision
    +
    +
    +

    Decimal instances can be constructed from integers, strings, floats, or tuples. +Construction from an integer or a float performs an exact conversion of the +value of that integer or float. Decimal numbers include special values such as +NaN which stands for “Not a number”, positive and negative +Infinity, and -0:

    +
    >>> getcontext().prec = 28
    +>>> Decimal(10)
    +Decimal('10')
    +>>> Decimal('3.14')
    +Decimal('3.14')
    +>>> Decimal(3.14)
    +Decimal('3.140000000000000124344978758017532527446746826171875')
    +>>> Decimal((0, (3, 1, 4), -2))
    +Decimal('3.14')
    +>>> Decimal(str(2.0 ** 0.5))
    +Decimal('1.4142135623730951')
    +>>> Decimal(2) ** Decimal('0.5')
    +Decimal('1.414213562373095048801688724')
    +>>> Decimal('NaN')
    +Decimal('NaN')
    +>>> Decimal('-Infinity')
    +Decimal('-Infinity')
    +
    +
    +

    If the FloatOperation signal is trapped, accidental mixing of +decimals and floats in constructors or ordering comparisons raises +an exception:

    +
    >>> c = getcontext()
    +>>> c.traps[FloatOperation] = True
    +>>> Decimal(3.14)
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +decimal.FloatOperation: [<class 'decimal.FloatOperation'>]
    +>>> Decimal('3.5') < 3.7
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +decimal.FloatOperation: [<class 'decimal.FloatOperation'>]
    +>>> Decimal('3.5') == 3.5
    +True
    +
    +
    +
    +

    New in version 3.3.

    +
    +

    The significance of a new Decimal is determined solely by the number of digits +input. Context precision and rounding only come into play during arithmetic +operations.

    +
    >>> getcontext().prec = 6
    +>>> Decimal('3.0')
    +Decimal('3.0')
    +>>> Decimal('3.1415926535')
    +Decimal('3.1415926535')
    +>>> Decimal('3.1415926535') + Decimal('2.7182818285')
    +Decimal('5.85987')
    +>>> getcontext().rounding = ROUND_UP
    +>>> Decimal('3.1415926535') + Decimal('2.7182818285')
    +Decimal('5.85988')
    +
    +
    +

    If the internal limits of the C version are exceeded, constructing +a decimal raises InvalidOperation:

    +
    >>> Decimal("1e9999999999999999999")
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +decimal.InvalidOperation: [<class 'decimal.InvalidOperation'>]
    +
    +
    +
    +

    Changed in version 3.3.

    +
    +

    Decimals interact well with much of the rest of Python. Here is a small decimal +floating point flying circus:

    +
    >>> data = list(map(Decimal, '1.34 1.87 3.45 2.35 1.00 0.03 9.25'.split()))
    +>>> max(data)
    +Decimal('9.25')
    +>>> min(data)
    +Decimal('0.03')
    +>>> sorted(data)
    +[Decimal('0.03'), Decimal('1.00'), Decimal('1.34'), Decimal('1.87'),
    + Decimal('2.35'), Decimal('3.45'), Decimal('9.25')]
    +>>> sum(data)
    +Decimal('19.29')
    +>>> a,b,c = data[:3]
    +>>> str(a)
    +'1.34'
    +>>> float(a)
    +1.34
    +>>> round(a, 1)
    +Decimal('1.3')
    +>>> int(a)
    +1
    +>>> a * 5
    +Decimal('6.70')
    +>>> a * b
    +Decimal('2.5058')
    +>>> c % a
    +Decimal('0.77')
    +
    +
    +

    And some mathematical functions are also available to Decimal:

    +
    >>> getcontext().prec = 28
    +>>> Decimal(2).sqrt()
    +Decimal('1.414213562373095048801688724')
    +>>> Decimal(1).exp()
    +Decimal('2.718281828459045235360287471')
    +>>> Decimal('10').ln()
    +Decimal('2.302585092994045684017991455')
    +>>> Decimal('10').log10()
    +Decimal('1')
    +
    +
    +

    The quantize() method rounds a number to a fixed exponent. This method is +useful for monetary applications that often round results to a fixed number of +places:

    +
    >>> Decimal('7.325').quantize(Decimal('.01'), rounding=ROUND_DOWN)
    +Decimal('7.32')
    +>>> Decimal('7.325').quantize(Decimal('1.'), rounding=ROUND_UP)
    +Decimal('8')
    +
    +
    +

    As shown above, the getcontext() function accesses the current context and +allows the settings to be changed. This approach meets the needs of most +applications.

    +

    For more advanced work, it may be useful to create alternate contexts using the +Context() constructor. To make an alternate active, use the setcontext() +function.

    +

    In accordance with the standard, the decimal module provides two ready to +use standard contexts, BasicContext and ExtendedContext. The +former is especially useful for debugging because many of the traps are +enabled:

    +
    >>> myothercontext = Context(prec=60, rounding=ROUND_HALF_DOWN)
    +>>> setcontext(myothercontext)
    +>>> Decimal(1) / Decimal(7)
    +Decimal('0.142857142857142857142857142857142857142857142857142857142857')
    +
    +>>> ExtendedContext
    +Context(prec=9, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999,
    +        capitals=1, clamp=0, flags=[], traps=[])
    +>>> setcontext(ExtendedContext)
    +>>> Decimal(1) / Decimal(7)
    +Decimal('0.142857143')
    +>>> Decimal(42) / Decimal(0)
    +Decimal('Infinity')
    +
    +>>> setcontext(BasicContext)
    +>>> Decimal(42) / Decimal(0)
    +Traceback (most recent call last):
    +  File "<pyshell#143>", line 1, in -toplevel-
    +    Decimal(42) / Decimal(0)
    +DivisionByZero: x / 0
    +
    +
    +

    Contexts also have signal flags for monitoring exceptional conditions +encountered during computations. The flags remain set until explicitly cleared, +so it is best to clear the flags before each set of monitored computations by +using the clear_flags() method.

    +
    >>> setcontext(ExtendedContext)
    +>>> getcontext().clear_flags()
    +>>> Decimal(355) / Decimal(113)
    +Decimal('3.14159292')
    +>>> getcontext()
    +Context(prec=9, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999,
    +        capitals=1, clamp=0, flags=[Inexact, Rounded], traps=[])
    +
    +
    +

    The flags entry shows that the rational approximation to Pi was +rounded (digits beyond the context precision were thrown away) and that the +result is inexact (some of the discarded digits were non-zero).

    +

    Individual traps are set using the dictionary in the traps field of a +context:

    +
    >>> setcontext(ExtendedContext)
    +>>> Decimal(1) / Decimal(0)
    +Decimal('Infinity')
    +>>> getcontext().traps[DivisionByZero] = 1
    +>>> Decimal(1) / Decimal(0)
    +Traceback (most recent call last):
    +  File "<pyshell#112>", line 1, in -toplevel-
    +    Decimal(1) / Decimal(0)
    +DivisionByZero: x / 0
    +
    +
    +

    Most programs adjust the current context only once, at the beginning of the +program. And, in many applications, data is converted to Decimal with +a single cast inside a loop. With context set and decimals created, the bulk of +the program manipulates the data no differently than with other Python numeric +types.

    +
    +
    +

    Decimal objects

    +
    +
    +class decimal.Decimal(value="0", context=None)
    +

    Construct a new Decimal object based from value.

    +

    value can be an integer, string, tuple, float, or another Decimal +object. If no value is given, returns Decimal('0'). If value is a +string, it should conform to the decimal numeric string syntax after leading +and trailing whitespace characters, as well as underscores throughout, are removed:

    +
    sign           ::=  '+' | '-'
    +digit          ::=  '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
    +indicator      ::=  'e' | 'E'
    +digits         ::=  digit [digit]...
    +decimal-part   ::=  digits '.' [digits] | ['.'] digits
    +exponent-part  ::=  indicator [sign] digits
    +infinity       ::=  'Infinity' | 'Inf'
    +nan            ::=  'NaN' [digits] | 'sNaN' [digits]
    +numeric-value  ::=  decimal-part [exponent-part] | infinity
    +numeric-string ::=  [sign] numeric-value | [sign] nan
    +
    +
    +

    Other Unicode decimal digits are also permitted where digit +appears above. These include decimal digits from various other +alphabets (for example, Arabic-Indic and Devanāgarī digits) along +with the fullwidth digits '\uff10' through '\uff19'.

    +

    If value is a tuple, it should have three components, a sign +(0 for positive or 1 for negative), a tuple of +digits, and an integer exponent. For example, Decimal((0, (1, 4, 1, 4), -3)) +returns Decimal('1.414').

    +

    If value is a float, the binary floating point value is losslessly +converted to its exact decimal equivalent. This conversion can often require +53 or more digits of precision. For example, Decimal(float('1.1')) +converts to +Decimal('1.100000000000000088817841970012523233890533447265625').

    +

    The context precision does not affect how many digits are stored. That is +determined exclusively by the number of digits in value. For example, +Decimal('3.00000') records all five zeros even if the context precision is +only three.

    +

    The purpose of the context argument is determining what to do if value is a +malformed string. If the context traps InvalidOperation, an exception +is raised; otherwise, the constructor returns a new Decimal with the value of +NaN.

    +

    Once constructed, Decimal objects are immutable.

    +
    +

    Changed in version 3.2: The argument to the constructor is now permitted to be a float +instance.

    +
    +
    +

    Changed in version 3.3: float arguments raise an exception if the FloatOperation +trap is set. By default the trap is off.

    +
    +
    +

    Changed in version 3.6: Underscores are allowed for grouping, as with integral and floating-point +literals in code.

    +
    +

    Decimal floating point objects share many properties with the other built-in +numeric types such as float and int. All of the usual math +operations and special methods apply. Likewise, decimal objects can be +copied, pickled, printed, used as dictionary keys, used as set elements, +compared, sorted, and coerced to another type (such as float or +int).

    +

    There are some small differences between arithmetic on Decimal objects and +arithmetic on integers and floats. When the remainder operator % is +applied to Decimal objects, the sign of the result is the sign of the +dividend rather than the sign of the divisor:

    +
    >>> (-7) % 4
    +1
    +>>> Decimal(-7) % Decimal(4)
    +Decimal('-3')
    +
    +
    +

    The integer division operator // behaves analogously, returning the +integer part of the true quotient (truncating towards zero) rather than its +floor, so as to preserve the usual identity x == (x // y) * y + x % y:

    +
    >>> -7 // 4
    +-2
    +>>> Decimal(-7) // Decimal(4)
    +Decimal('-1')
    +
    +
    +

    The % and // operators implement the remainder and +divide-integer operations (respectively) as described in the +specification.

    +

    Decimal objects cannot generally be combined with floats or +instances of fractions.Fraction in arithmetic operations: +an attempt to add a Decimal to a float, for +example, will raise a TypeError. However, it is possible to +use Python’s comparison operators to compare a Decimal +instance x with another number y. This avoids confusing results +when doing equality comparisons between numbers of different types.

    +
    +

    Changed in version 3.2: Mixed-type comparisons between Decimal instances and other +numeric types are now fully supported.

    +
    +

    In addition to the standard numeric properties, decimal floating point +objects also have a number of specialized methods:

    +
    +
    +adjusted()
    +

    Return the adjusted exponent after shifting out the coefficient’s +rightmost digits until only the lead digit remains: +Decimal('321e+5').adjusted() returns seven. Used for determining the +position of the most significant digit with respect to the decimal point.

    +
    + +
    +
    +as_integer_ratio()
    +

    Return a pair (n, d) of integers that represent the given +Decimal instance as a fraction, in lowest terms and +with a positive denominator:

    +
    >>> Decimal('-3.14').as_integer_ratio()
    +(-157, 50)
    +
    +
    +

    The conversion is exact. Raise OverflowError on infinities and ValueError +on NaNs.

    +
    + +
    +

    New in version 3.6.

    +
    +
    +
    +as_tuple()
    +

    Return a named tuple representation of the number: +DecimalTuple(sign, digits, exponent).

    +
    + +
    +
    +canonical()
    +

    Return the canonical encoding of the argument. Currently, the encoding of +a Decimal instance is always canonical, so this operation returns +its argument unchanged.

    +
    + +
    +
    +compare(other, context=None)
    +

    Compare the values of two Decimal instances. compare() returns a +Decimal instance, and if either operand is a NaN then the result is a +NaN:

    +
    a or b is a NaN  ==> Decimal('NaN')
    +a < b            ==> Decimal('-1')
    +a == b           ==> Decimal('0')
    +a > b            ==> Decimal('1')
    +
    +
    +
    + +
    +
    +compare_signal(other, context=None)
    +

    This operation is identical to the compare() method, except that all +NaNs signal. That is, if neither operand is a signaling NaN then any +quiet NaN operand is treated as though it were a signaling NaN.

    +
    + +
    +
    +compare_total(other, context=None)
    +

    Compare two operands using their abstract representation rather than their +numerical value. Similar to the compare() method, but the result +gives a total ordering on Decimal instances. Two +Decimal instances with the same numeric value but different +representations compare unequal in this ordering:

    +
    >>> Decimal('12.0').compare_total(Decimal('12'))
    +Decimal('-1')
    +
    +
    +

    Quiet and signaling NaNs are also included in the total ordering. The +result of this function is Decimal('0') if both operands have the same +representation, Decimal('-1') if the first operand is lower in the +total order than the second, and Decimal('1') if the first operand is +higher in the total order than the second operand. See the specification +for details of the total order.

    +

    This operation is unaffected by context and is quiet: no flags are changed +and no rounding is performed. As an exception, the C version may raise +InvalidOperation if the second operand cannot be converted exactly.

    +
    + +
    +
    +compare_total_mag(other, context=None)
    +

    Compare two operands using their abstract representation rather than their +value as in compare_total(), but ignoring the sign of each operand. +x.compare_total_mag(y) is equivalent to +x.copy_abs().compare_total(y.copy_abs()).

    +

    This operation is unaffected by context and is quiet: no flags are changed +and no rounding is performed. As an exception, the C version may raise +InvalidOperation if the second operand cannot be converted exactly.

    +
    + +
    +
    +conjugate()
    +

    Just returns self, this method is only to comply with the Decimal +Specification.

    +
    + +
    +
    +copy_abs()
    +

    Return the absolute value of the argument. This operation is unaffected +by the context and is quiet: no flags are changed and no rounding is +performed.

    +
    + +
    +
    +copy_negate()
    +

    Return the negation of the argument. This operation is unaffected by the +context and is quiet: no flags are changed and no rounding is performed.

    +
    + +
    +
    +copy_sign(other, context=None)
    +

    Return a copy of the first operand with the sign set to be the same as the +sign of the second operand. For example:

    +
    >>> Decimal('2.3').copy_sign(Decimal('-1.5'))
    +Decimal('-2.3')
    +
    +
    +

    This operation is unaffected by context and is quiet: no flags are changed +and no rounding is performed. As an exception, the C version may raise +InvalidOperation if the second operand cannot be converted exactly.

    +
    + +
    +
    +exp(context=None)
    +

    Return the value of the (natural) exponential function e**x at the +given number. The result is correctly rounded using the +ROUND_HALF_EVEN rounding mode.

    +
    >>> Decimal(1).exp()
    +Decimal('2.718281828459045235360287471')
    +>>> Decimal(321).exp()
    +Decimal('2.561702493119680037517373933E+139')
    +
    +
    +
    + +
    +
    +from_float(f)
    +

    Classmethod that converts a float to a decimal number, exactly.

    +

    Note Decimal.from_float(0.1) is not the same as Decimal(‘0.1’). +Since 0.1 is not exactly representable in binary floating point, the +value is stored as the nearest representable value which is +0x1.999999999999ap-4. That equivalent value in decimal is +0.1000000000000000055511151231257827021181583404541015625.

    +
    +

    Note

    +

    From Python 3.2 onwards, a Decimal instance +can also be constructed directly from a float.

    +
    +
    >>> Decimal.from_float(0.1)
    +Decimal('0.1000000000000000055511151231257827021181583404541015625')
    +>>> Decimal.from_float(float('nan'))
    +Decimal('NaN')
    +>>> Decimal.from_float(float('inf'))
    +Decimal('Infinity')
    +>>> Decimal.from_float(float('-inf'))
    +Decimal('-Infinity')
    +
    +
    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +fma(other, third, context=None)
    +

    Fused multiply-add. Return self*other+third with no rounding of the +intermediate product self*other.

    +
    >>> Decimal(2).fma(3, 5)
    +Decimal('11')
    +
    +
    +
    + +
    +
    +is_canonical()
    +

    Return True if the argument is canonical and False +otherwise. Currently, a Decimal instance is always canonical, so +this operation always returns True.

    +
    + +
    +
    +is_finite()
    +

    Return True if the argument is a finite number, and +False if the argument is an infinity or a NaN.

    +
    + +
    +
    +is_infinite()
    +

    Return True if the argument is either positive or negative +infinity and False otherwise.

    +
    + +
    +
    +is_nan()
    +

    Return True if the argument is a (quiet or signaling) NaN and +False otherwise.

    +
    + +
    +
    +is_normal(context=None)
    +

    Return True if the argument is a normal finite number. Return +False if the argument is zero, subnormal, infinite or a NaN.

    +
    + +
    +
    +is_qnan()
    +

    Return True if the argument is a quiet NaN, and +False otherwise.

    +
    + +
    +
    +is_signed()
    +

    Return True if the argument has a negative sign and +False otherwise. Note that zeros and NaNs can both carry signs.

    +
    + +
    +
    +is_snan()
    +

    Return True if the argument is a signaling NaN and False +otherwise.

    +
    + +
    +
    +is_subnormal(context=None)
    +

    Return True if the argument is subnormal, and False +otherwise.

    +
    + +
    +
    +is_zero()
    +

    Return True if the argument is a (positive or negative) zero and +False otherwise.

    +
    + +
    +
    +ln(context=None)
    +

    Return the natural (base e) logarithm of the operand. The result is +correctly rounded using the ROUND_HALF_EVEN rounding mode.

    +
    + +
    +
    +log10(context=None)
    +

    Return the base ten logarithm of the operand. The result is correctly +rounded using the ROUND_HALF_EVEN rounding mode.

    +
    + +
    +
    +logb(context=None)
    +

    For a nonzero number, return the adjusted exponent of its operand as a +Decimal instance. If the operand is a zero then +Decimal('-Infinity') is returned and the DivisionByZero flag +is raised. If the operand is an infinity then Decimal('Infinity') is +returned.

    +
    + +
    +
    +logical_and(other, context=None)
    +

    logical_and() is a logical operation which takes two logical +operands (see Logical operands). The result is the +digit-wise and of the two operands.

    +
    + +
    +
    +logical_invert(context=None)
    +

    logical_invert() is a logical operation. The +result is the digit-wise inversion of the operand.

    +
    + +
    +
    +logical_or(other, context=None)
    +

    logical_or() is a logical operation which takes two logical +operands (see Logical operands). The result is the +digit-wise or of the two operands.

    +
    + +
    +
    +logical_xor(other, context=None)
    +

    logical_xor() is a logical operation which takes two logical +operands (see Logical operands). The result is the +digit-wise exclusive or of the two operands.

    +
    + +
    +
    +max(other, context=None)
    +

    Like max(self, other) except that the context rounding rule is applied +before returning and that NaN values are either signaled or +ignored (depending on the context and whether they are signaling or +quiet).

    +
    + +
    +
    +max_mag(other, context=None)
    +

    Similar to the max() method, but the comparison is done using the +absolute values of the operands.

    +
    + +
    +
    +min(other, context=None)
    +

    Like min(self, other) except that the context rounding rule is applied +before returning and that NaN values are either signaled or +ignored (depending on the context and whether they are signaling or +quiet).

    +
    + +
    +
    +min_mag(other, context=None)
    +

    Similar to the min() method, but the comparison is done using the +absolute values of the operands.

    +
    + +
    +
    +next_minus(context=None)
    +

    Return the largest number representable in the given context (or in the +current thread’s context if no context is given) that is smaller than the +given operand.

    +
    + +
    +
    +next_plus(context=None)
    +

    Return the smallest number representable in the given context (or in the +current thread’s context if no context is given) that is larger than the +given operand.

    +
    + +
    +
    +next_toward(other, context=None)
    +

    If the two operands are unequal, return the number closest to the first +operand in the direction of the second operand. If both operands are +numerically equal, return a copy of the first operand with the sign set to +be the same as the sign of the second operand.

    +
    + +
    +
    +normalize(context=None)
    +

    Normalize the number by stripping the rightmost trailing zeros and +converting any result equal to Decimal('0') to +Decimal('0e0'). Used for producing canonical values for attributes +of an equivalence class. For example, Decimal('32.100') and +Decimal('0.321000e+2') both normalize to the equivalent value +Decimal('32.1').

    +
    + +
    +
    +number_class(context=None)
    +

    Return a string describing the class of the operand. The returned value +is one of the following ten strings.

    +
      +
    • "-Infinity", indicating that the operand is negative infinity.

    • +
    • "-Normal", indicating that the operand is a negative normal number.

    • +
    • "-Subnormal", indicating that the operand is negative and subnormal.

    • +
    • "-Zero", indicating that the operand is a negative zero.

    • +
    • "+Zero", indicating that the operand is a positive zero.

    • +
    • "+Subnormal", indicating that the operand is positive and subnormal.

    • +
    • "+Normal", indicating that the operand is a positive normal number.

    • +
    • "+Infinity", indicating that the operand is positive infinity.

    • +
    • "NaN", indicating that the operand is a quiet NaN (Not a Number).

    • +
    • "sNaN", indicating that the operand is a signaling NaN.

    • +
    +
    + +
    +
    +quantize(exp, rounding=None, context=None)
    +

    Return a value equal to the first operand after rounding and having the +exponent of the second operand.

    +
    >>> Decimal('1.41421356').quantize(Decimal('1.000'))
    +Decimal('1.414')
    +
    +
    +

    Unlike other operations, if the length of the coefficient after the +quantize operation would be greater than precision, then an +InvalidOperation is signaled. This guarantees that, unless there +is an error condition, the quantized exponent is always equal to that of +the right-hand operand.

    +

    Also unlike other operations, quantize never signals Underflow, even if +the result is subnormal and inexact.

    +

    If the exponent of the second operand is larger than that of the first +then rounding may be necessary. In this case, the rounding mode is +determined by the rounding argument if given, else by the given +context argument; if neither argument is given the rounding mode of +the current thread’s context is used.

    +

    An error is returned whenever the resulting exponent is greater than +Emax or less than Etiny.

    +
    + +
    +
    +radix()
    +

    Return Decimal(10), the radix (base) in which the Decimal +class does all its arithmetic. Included for compatibility with the +specification.

    +
    + +
    +
    +remainder_near(other, context=None)
    +

    Return the remainder from dividing self by other. This differs from +self % other in that the sign of the remainder is chosen so as to +minimize its absolute value. More precisely, the return value is +self - n * other where n is the integer nearest to the exact +value of self / other, and if two integers are equally near then the +even one is chosen.

    +

    If the result is zero then its sign will be the sign of self.

    +
    >>> Decimal(18).remainder_near(Decimal(10))
    +Decimal('-2')
    +>>> Decimal(25).remainder_near(Decimal(10))
    +Decimal('5')
    +>>> Decimal(35).remainder_near(Decimal(10))
    +Decimal('-5')
    +
    +
    +
    + +
    +
    +rotate(other, context=None)
    +

    Return the result of rotating the digits of the first operand by an amount +specified by the second operand. The second operand must be an integer in +the range -precision through precision. The absolute value of the second +operand gives the number of places to rotate. If the second operand is +positive then rotation is to the left; otherwise rotation is to the right. +The coefficient of the first operand is padded on the left with zeros to +length precision if necessary. The sign and exponent of the first operand +are unchanged.

    +
    + +
    +
    +same_quantum(other, context=None)
    +

    Test whether self and other have the same exponent or whether both are +NaN.

    +

    This operation is unaffected by context and is quiet: no flags are changed +and no rounding is performed. As an exception, the C version may raise +InvalidOperation if the second operand cannot be converted exactly.

    +
    + +
    +
    +scaleb(other, context=None)
    +

    Return the first operand with exponent adjusted by the second. +Equivalently, return the first operand multiplied by 10**other. The +second operand must be an integer.

    +
    + +
    +
    +shift(other, context=None)
    +

    Return the result of shifting the digits of the first operand by an amount +specified by the second operand. The second operand must be an integer in +the range -precision through precision. The absolute value of the second +operand gives the number of places to shift. If the second operand is +positive then the shift is to the left; otherwise the shift is to the +right. Digits shifted into the coefficient are zeros. The sign and +exponent of the first operand are unchanged.

    +
    + +
    +
    +sqrt(context=None)
    +

    Return the square root of the argument to full precision.

    +
    + +
    +
    +to_eng_string(context=None)
    +

    Convert to a string, using engineering notation if an exponent is needed.

    +

    Engineering notation has an exponent which is a multiple of 3. This +can leave up to 3 digits to the left of the decimal place and may +require the addition of either one or two trailing zeros.

    +

    For example, this converts Decimal('123E+1') to Decimal('1.23E+3').

    +
    + +
    +
    +to_integral(rounding=None, context=None)
    +

    Identical to the to_integral_value() method. The to_integral +name has been kept for compatibility with older versions.

    +
    + +
    +
    +to_integral_exact(rounding=None, context=None)
    +

    Round to the nearest integer, signaling Inexact or +Rounded as appropriate if rounding occurs. The rounding mode is +determined by the rounding parameter if given, else by the given +context. If neither parameter is given then the rounding mode of the +current context is used.

    +
    + +
    +
    +to_integral_value(rounding=None, context=None)
    +

    Round to the nearest integer without signaling Inexact or +Rounded. If given, applies rounding; otherwise, uses the +rounding method in either the supplied context or the current context.

    +
    + +
    + +
    +

    Logical operands

    +

    The logical_and(), logical_invert(), logical_or(), +and logical_xor() methods expect their arguments to be logical +operands. A logical operand is a Decimal instance whose +exponent and sign are both zero, and whose digits are all either +0 or 1.

    +
    +
    +
    +

    Context objects

    +

    Contexts are environments for arithmetic operations. They govern precision, set +rules for rounding, determine which signals are treated as exceptions, and limit +the range for exponents.

    +

    Each thread has its own current context which is accessed or changed using the +getcontext() and setcontext() functions:

    +
    +
    +decimal.getcontext()
    +

    Return the current context for the active thread.

    +
    + +
    +
    +decimal.setcontext(c)
    +

    Set the current context for the active thread to c.

    +
    + +

    You can also use the with statement and the localcontext() +function to temporarily change the active context.

    +
    +
    +decimal.localcontext(ctx=None)
    +

    Return a context manager that will set the current context for the active thread +to a copy of ctx on entry to the with-statement and restore the previous context +when exiting the with-statement. If no context is specified, a copy of the +current context is used.

    +

    For example, the following code sets the current decimal precision to 42 places, +performs a calculation, and then automatically restores the previous context:

    +
    from decimal import localcontext
    +
    +with localcontext() as ctx:
    +    ctx.prec = 42   # Perform a high precision calculation
    +    s = calculate_something()
    +s = +s  # Round the final result back to the default precision
    +
    +
    +
    + +

    New contexts can also be created using the Context constructor +described below. In addition, the module provides three pre-made contexts:

    +
    +
    +class decimal.BasicContext
    +

    This is a standard context defined by the General Decimal Arithmetic +Specification. Precision is set to nine. Rounding is set to +ROUND_HALF_UP. All flags are cleared. All traps are enabled (treated +as exceptions) except Inexact, Rounded, and +Subnormal.

    +

    Because many of the traps are enabled, this context is useful for debugging.

    +
    + +
    +
    +class decimal.ExtendedContext
    +

    This is a standard context defined by the General Decimal Arithmetic +Specification. Precision is set to nine. Rounding is set to +ROUND_HALF_EVEN. All flags are cleared. No traps are enabled (so that +exceptions are not raised during computations).

    +

    Because the traps are disabled, this context is useful for applications that +prefer to have result value of NaN or Infinity instead of +raising exceptions. This allows an application to complete a run in the +presence of conditions that would otherwise halt the program.

    +
    + +
    +
    +class decimal.DefaultContext
    +

    This context is used by the Context constructor as a prototype for new +contexts. Changing a field (such a precision) has the effect of changing the +default for new contexts created by the Context constructor.

    +

    This context is most useful in multi-threaded environments. Changing one of the +fields before threads are started has the effect of setting system-wide +defaults. Changing the fields after threads have started is not recommended as +it would require thread synchronization to prevent race conditions.

    +

    In single threaded environments, it is preferable to not use this context at +all. Instead, simply create contexts explicitly as described below.

    +

    The default values are prec=28, +rounding=ROUND_HALF_EVEN, +and enabled traps for Overflow, InvalidOperation, and +DivisionByZero.

    +
    + +

    In addition to the three supplied contexts, new contexts can be created with the +Context constructor.

    +
    +
    +class decimal.Context(prec=None, rounding=None, Emin=None, Emax=None, capitals=None, clamp=None, flags=None, traps=None)
    +

    Creates a new context. If a field is not specified or is None, the +default values are copied from the DefaultContext. If the flags +field is not specified or is None, all flags are cleared.

    +

    prec is an integer in the range [1, MAX_PREC] that sets +the precision for arithmetic operations in the context.

    +

    The rounding option is one of the constants listed in the section +Rounding Modes.

    +

    The traps and flags fields list any signals to be set. Generally, new +contexts should only set traps and leave the flags clear.

    +

    The Emin and Emax fields are integers specifying the outer limits allowable +for exponents. Emin must be in the range [MIN_EMIN, 0], +Emax in the range [0, MAX_EMAX].

    +

    The capitals field is either 0 or 1 (the default). If set to +1, exponents are printed with a capital E; otherwise, a +lowercase e is used: Decimal('6.02e+23').

    +

    The clamp field is either 0 (the default) or 1. +If set to 1, the exponent e of a Decimal +instance representable in this context is strictly limited to the +range Emin - prec + 1 <= e <= Emax - prec + 1. If clamp is +0 then a weaker condition holds: the adjusted exponent of +the Decimal instance is at most Emax. When clamp is +1, a large normal number will, where possible, have its +exponent reduced and a corresponding number of zeros added to its +coefficient, in order to fit the exponent constraints; this +preserves the value of the number but loses information about +significant trailing zeros. For example:

    +
    >>> Context(prec=6, Emax=999, clamp=1).create_decimal('1.23e999')
    +Decimal('1.23000E+999')
    +
    +
    +

    A clamp value of 1 allows compatibility with the +fixed-width decimal interchange formats specified in IEEE 754.

    +

    The Context class defines several general purpose methods as well as +a large number of methods for doing arithmetic directly in a given context. +In addition, for each of the Decimal methods described above (with +the exception of the adjusted() and as_tuple() methods) there is +a corresponding Context method. For example, for a Context +instance C and Decimal instance x, C.exp(x) is +equivalent to x.exp(context=C). Each Context method accepts a +Python integer (an instance of int) anywhere that a +Decimal instance is accepted.

    +
    +
    +clear_flags()
    +

    Resets all of the flags to 0.

    +
    + +
    +
    +clear_traps()
    +

    Resets all of the traps to 0.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +copy()
    +

    Return a duplicate of the context.

    +
    + +
    +
    +copy_decimal(num)
    +

    Return a copy of the Decimal instance num.

    +
    + +
    +
    +create_decimal(num)
    +

    Creates a new Decimal instance from num but using self as +context. Unlike the Decimal constructor, the context precision, +rounding method, flags, and traps are applied to the conversion.

    +

    This is useful because constants are often given to a greater precision +than is needed by the application. Another benefit is that rounding +immediately eliminates unintended effects from digits beyond the current +precision. In the following example, using unrounded inputs means that +adding zero to a sum can change the result:

    +
    >>> getcontext().prec = 3
    +>>> Decimal('3.4445') + Decimal('1.0023')
    +Decimal('4.45')
    +>>> Decimal('3.4445') + Decimal(0) + Decimal('1.0023')
    +Decimal('4.44')
    +
    +
    +

    This method implements the to-number operation of the IBM specification. +If the argument is a string, no leading or trailing whitespace or +underscores are permitted.

    +
    + +
    +
    +create_decimal_from_float(f)
    +

    Creates a new Decimal instance from a float f but rounding using self +as the context. Unlike the Decimal.from_float() class method, +the context precision, rounding method, flags, and traps are applied to +the conversion.

    +
    >>> context = Context(prec=5, rounding=ROUND_DOWN)
    +>>> context.create_decimal_from_float(math.pi)
    +Decimal('3.1415')
    +>>> context = Context(prec=5, traps=[Inexact])
    +>>> context.create_decimal_from_float(math.pi)
    +Traceback (most recent call last):
    +    ...
    +decimal.Inexact: None
    +
    +
    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +Etiny()
    +

    Returns a value equal to Emin - prec + 1 which is the minimum exponent +value for subnormal results. When underflow occurs, the exponent is set +to Etiny.

    +
    + +
    +
    +Etop()
    +

    Returns a value equal to Emax - prec + 1.

    +
    + +

    The usual approach to working with decimals is to create Decimal +instances and then apply arithmetic operations which take place within the +current context for the active thread. An alternative approach is to use +context methods for calculating within a specific context. The methods are +similar to those for the Decimal class and are only briefly +recounted here.

    +
    +
    +abs(x)
    +

    Returns the absolute value of x.

    +
    + +
    +
    +add(x, y)
    +

    Return the sum of x and y.

    +
    + +
    +
    +canonical(x)
    +

    Returns the same Decimal object x.

    +
    + +
    +
    +compare(x, y)
    +

    Compares x and y numerically.

    +
    + +
    +
    +compare_signal(x, y)
    +

    Compares the values of the two operands numerically.

    +
    + +
    +
    +compare_total(x, y)
    +

    Compares two operands using their abstract representation.

    +
    + +
    +
    +compare_total_mag(x, y)
    +

    Compares two operands using their abstract representation, ignoring sign.

    +
    + +
    +
    +copy_abs(x)
    +

    Returns a copy of x with the sign set to 0.

    +
    + +
    +
    +copy_negate(x)
    +

    Returns a copy of x with the sign inverted.

    +
    + +
    +
    +copy_sign(x, y)
    +

    Copies the sign from y to x.

    +
    + +
    +
    +divide(x, y)
    +

    Return x divided by y.

    +
    + +
    +
    +divide_int(x, y)
    +

    Return x divided by y, truncated to an integer.

    +
    + +
    +
    +divmod(x, y)
    +

    Divides two numbers and returns the integer part of the result.

    +
    + +
    +
    +exp(x)
    +

    Returns e ** x.

    +
    + +
    +
    +fma(x, y, z)
    +

    Returns x multiplied by y, plus z.

    +
    + +
    +
    +is_canonical(x)
    +

    Returns True if x is canonical; otherwise returns False.

    +
    + +
    +
    +is_finite(x)
    +

    Returns True if x is finite; otherwise returns False.

    +
    + +
    +
    +is_infinite(x)
    +

    Returns True if x is infinite; otherwise returns False.

    +
    + +
    +
    +is_nan(x)
    +

    Returns True if x is a qNaN or sNaN; otherwise returns False.

    +
    + +
    +
    +is_normal(x)
    +

    Returns True if x is a normal number; otherwise returns False.

    +
    + +
    +
    +is_qnan(x)
    +

    Returns True if x is a quiet NaN; otherwise returns False.

    +
    + +
    +
    +is_signed(x)
    +

    Returns True if x is negative; otherwise returns False.

    +
    + +
    +
    +is_snan(x)
    +

    Returns True if x is a signaling NaN; otherwise returns False.

    +
    + +
    +
    +is_subnormal(x)
    +

    Returns True if x is subnormal; otherwise returns False.

    +
    + +
    +
    +is_zero(x)
    +

    Returns True if x is a zero; otherwise returns False.

    +
    + +
    +
    +ln(x)
    +

    Returns the natural (base e) logarithm of x.

    +
    + +
    +
    +log10(x)
    +

    Returns the base 10 logarithm of x.

    +
    + +
    +
    +logb(x)
    +

    Returns the exponent of the magnitude of the operand’s MSD.

    +
    + +
    +
    +logical_and(x, y)
    +

    Applies the logical operation and between each operand’s digits.

    +
    + +
    +
    +logical_invert(x)
    +

    Invert all the digits in x.

    +
    + +
    +
    +logical_or(x, y)
    +

    Applies the logical operation or between each operand’s digits.

    +
    + +
    +
    +logical_xor(x, y)
    +

    Applies the logical operation xor between each operand’s digits.

    +
    + +
    +
    +max(x, y)
    +

    Compares two values numerically and returns the maximum.

    +
    + +
    +
    +max_mag(x, y)
    +

    Compares the values numerically with their sign ignored.

    +
    + +
    +
    +min(x, y)
    +

    Compares two values numerically and returns the minimum.

    +
    + +
    +
    +min_mag(x, y)
    +

    Compares the values numerically with their sign ignored.

    +
    + +
    +
    +minus(x)
    +

    Minus corresponds to the unary prefix minus operator in Python.

    +
    + +
    +
    +multiply(x, y)
    +

    Return the product of x and y.

    +
    + +
    +
    +next_minus(x)
    +

    Returns the largest representable number smaller than x.

    +
    + +
    +
    +next_plus(x)
    +

    Returns the smallest representable number larger than x.

    +
    + +
    +
    +next_toward(x, y)
    +

    Returns the number closest to x, in direction towards y.

    +
    + +
    +
    +normalize(x)
    +

    Reduces x to its simplest form.

    +
    + +
    +
    +number_class(x)
    +

    Returns an indication of the class of x.

    +
    + +
    +
    +plus(x)
    +

    Plus corresponds to the unary prefix plus operator in Python. This +operation applies the context precision and rounding, so it is not an +identity operation.

    +
    + +
    +
    +power(x, y, modulo=None)
    +

    Return x to the power of y, reduced modulo modulo if given.

    +

    With two arguments, compute x**y. If x is negative then y +must be integral. The result will be inexact unless y is integral and +the result is finite and can be expressed exactly in ‘precision’ digits. +The rounding mode of the context is used. Results are always correctly-rounded +in the Python version.

    +
    +

    Changed in version 3.3: The C module computes power() in terms of the correctly-rounded +exp() and ln() functions. The result is well-defined but +only “almost always correctly-rounded”.

    +
    +

    With three arguments, compute (x**y) % modulo. For the three argument +form, the following restrictions on the arguments hold:

    +
    +
      +
    • all three arguments must be integral

    • +
    • y must be nonnegative

    • +
    • at least one of x or y must be nonzero

    • +
    • modulo must be nonzero and have at most ‘precision’ digits

    • +
    +
    +

    The value resulting from Context.power(x, y, modulo) is +equal to the value that would be obtained by computing (x**y) +% modulo with unbounded precision, but is computed more +efficiently. The exponent of the result is zero, regardless of +the exponents of x, y and modulo. The result is +always exact.

    +
    + +
    +
    +quantize(x, y)
    +

    Returns a value equal to x (rounded), having the exponent of y.

    +
    + +
    +
    +radix()
    +

    Just returns 10, as this is Decimal, :)

    +
    + +
    +
    +remainder(x, y)
    +

    Returns the remainder from integer division.

    +

    The sign of the result, if non-zero, is the same as that of the original +dividend.

    +
    + +
    +
    +remainder_near(x, y)
    +

    Returns x - y * n, where n is the integer nearest the exact value +of x / y (if the result is 0 then its sign will be the sign of x).

    +
    + +
    +
    +rotate(x, y)
    +

    Returns a rotated copy of x, y times.

    +
    + +
    +
    +same_quantum(x, y)
    +

    Returns True if the two operands have the same exponent.

    +
    + +
    +
    +scaleb(x, y)
    +

    Returns the first operand after adding the second value its exp.

    +
    + +
    +
    +shift(x, y)
    +

    Returns a shifted copy of x, y times.

    +
    + +
    +
    +sqrt(x)
    +

    Square root of a non-negative number to context precision.

    +
    + +
    +
    +subtract(x, y)
    +

    Return the difference between x and y.

    +
    + +
    +
    +to_eng_string(x)
    +

    Convert to a string, using engineering notation if an exponent is needed.

    +

    Engineering notation has an exponent which is a multiple of 3. This +can leave up to 3 digits to the left of the decimal place and may +require the addition of either one or two trailing zeros.

    +
    + +
    +
    +to_integral_exact(x)
    +

    Rounds to an integer.

    +
    + +
    +
    +to_sci_string(x)
    +

    Converts a number to a string using scientific notation.

    +
    + +
    + +
    +
    +

    Constants

    +

    The constants in this section are only relevant for the C module. They +are also included in the pure Python version for compatibility.

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + +

    32-bit

    64-bit

    +
    +decimal.MAX_PREC
    +
    + +

    425000000

    999999999999999999

    +
    +decimal.MAX_EMAX
    +
    + +

    425000000

    999999999999999999

    +
    +decimal.MIN_EMIN
    +
    + +

    -425000000

    -999999999999999999

    +
    +decimal.MIN_ETINY
    +
    + +

    -849999999

    -1999999999999999997

    +
    +
    +decimal.HAVE_THREADS
    +

    The default value is True. If Python is compiled without threads, the +C version automatically disables the expensive thread local context +machinery. In this case, the value is False.

    +
    + +
    +
    +

    Rounding modes

    +
    +
    +decimal.ROUND_CEILING
    +

    Round towards Infinity.

    +
    + +
    +
    +decimal.ROUND_DOWN
    +

    Round towards zero.

    +
    + +
    +
    +decimal.ROUND_FLOOR
    +

    Round towards -Infinity.

    +
    + +
    +
    +decimal.ROUND_HALF_DOWN
    +

    Round to nearest with ties going towards zero.

    +
    + +
    +
    +decimal.ROUND_HALF_EVEN
    +

    Round to nearest with ties going to nearest even integer.

    +
    + +
    +
    +decimal.ROUND_HALF_UP
    +

    Round to nearest with ties going away from zero.

    +
    + +
    +
    +decimal.ROUND_UP
    +

    Round away from zero.

    +
    + +
    +
    +decimal.ROUND_05UP
    +

    Round away from zero if last digit after rounding towards zero would have +been 0 or 5; otherwise round towards zero.

    +
    + +
    +
    +

    Signals

    +

    Signals represent conditions that arise during computation. Each corresponds to +one context flag and one context trap enabler.

    +

    The context flag is set whenever the condition is encountered. After the +computation, flags may be checked for informational purposes (for instance, to +determine whether a computation was exact). After checking the flags, be sure to +clear all flags before starting the next computation.

    +

    If the context’s trap enabler is set for the signal, then the condition causes a +Python exception to be raised. For example, if the DivisionByZero trap +is set, then a DivisionByZero exception is raised upon encountering the +condition.

    +
    +
    +class decimal.Clamped
    +

    Altered an exponent to fit representation constraints.

    +

    Typically, clamping occurs when an exponent falls outside the context’s +Emin and Emax limits. If possible, the exponent is reduced to +fit by adding zeros to the coefficient.

    +
    + +
    +
    +class decimal.DecimalException
    +

    Base class for other signals and a subclass of ArithmeticError.

    +
    + +
    +
    +class decimal.DivisionByZero
    +

    Signals the division of a non-infinite number by zero.

    +

    Can occur with division, modulo division, or when raising a number to a negative +power. If this signal is not trapped, returns Infinity or +-Infinity with the sign determined by the inputs to the calculation.

    +
    + +
    +
    +class decimal.Inexact
    +

    Indicates that rounding occurred and the result is not exact.

    +

    Signals when non-zero digits were discarded during rounding. The rounded result +is returned. The signal flag or trap is used to detect when results are +inexact.

    +
    + +
    +
    +class decimal.InvalidOperation
    +

    An invalid operation was performed.

    +

    Indicates that an operation was requested that does not make sense. If not +trapped, returns NaN. Possible causes include:

    +
    Infinity - Infinity
    +0 * Infinity
    +Infinity / Infinity
    +x % 0
    +Infinity % x
    +sqrt(-x) and x > 0
    +0 ** 0
    +x ** (non-integer)
    +x ** Infinity
    +
    +
    +
    + +
    +
    +class decimal.Overflow
    +

    Numerical overflow.

    +

    Indicates the exponent is larger than Emax after rounding has +occurred. If not trapped, the result depends on the rounding mode, either +pulling inward to the largest representable finite number or rounding outward +to Infinity. In either case, Inexact and Rounded +are also signaled.

    +
    + +
    +
    +class decimal.Rounded
    +

    Rounding occurred though possibly no information was lost.

    +

    Signaled whenever rounding discards digits; even if those digits are zero +(such as rounding 5.00 to 5.0). If not trapped, returns +the result unchanged. This signal is used to detect loss of significant +digits.

    +
    + +
    +
    +class decimal.Subnormal
    +

    Exponent was lower than Emin prior to rounding.

    +

    Occurs when an operation result is subnormal (the exponent is too small). If +not trapped, returns the result unchanged.

    +
    + +
    +
    +class decimal.Underflow
    +

    Numerical underflow with result rounded to zero.

    +

    Occurs when a subnormal result is pushed to zero by rounding. Inexact +and Subnormal are also signaled.

    +
    + +
    +
    +class decimal.FloatOperation
    +

    Enable stricter semantics for mixing floats and Decimals.

    +

    If the signal is not trapped (default), mixing floats and Decimals is +permitted in the Decimal constructor, +create_decimal() and all comparison operators. +Both conversion and comparisons are exact. Any occurrence of a mixed +operation is silently recorded by setting FloatOperation in the +context flags. Explicit conversions with from_float() +or create_decimal_from_float() do not set the flag.

    +

    Otherwise (the signal is trapped), only equality comparisons and explicit +conversions are silent. All other mixed operations raise FloatOperation.

    +
    + +

    The following table summarizes the hierarchy of signals:

    +
    exceptions.ArithmeticError(exceptions.Exception)
    +    DecimalException
    +        Clamped
    +        DivisionByZero(DecimalException, exceptions.ZeroDivisionError)
    +        Inexact
    +            Overflow(Inexact, Rounded)
    +            Underflow(Inexact, Rounded, Subnormal)
    +        InvalidOperation
    +        Rounded
    +        Subnormal
    +        FloatOperation(DecimalException, exceptions.TypeError)
    +
    +
    +
    +
    +

    Floating Point Notes

    +
    +

    Mitigating round-off error with increased precision

    +

    The use of decimal floating point eliminates decimal representation error +(making it possible to represent 0.1 exactly); however, some operations +can still incur round-off error when non-zero digits exceed the fixed precision.

    +

    The effects of round-off error can be amplified by the addition or subtraction +of nearly offsetting quantities resulting in loss of significance. Knuth +provides two instructive examples where rounded floating point arithmetic with +insufficient precision causes the breakdown of the associative and distributive +properties of addition:

    +
    # Examples from Seminumerical Algorithms, Section 4.2.2.
    +>>> from decimal import Decimal, getcontext
    +>>> getcontext().prec = 8
    +
    +>>> u, v, w = Decimal(11111113), Decimal(-11111111), Decimal('7.51111111')
    +>>> (u + v) + w
    +Decimal('9.5111111')
    +>>> u + (v + w)
    +Decimal('10')
    +
    +>>> u, v, w = Decimal(20000), Decimal(-6), Decimal('6.0000003')
    +>>> (u*v) + (u*w)
    +Decimal('0.01')
    +>>> u * (v+w)
    +Decimal('0.0060000')
    +
    +
    +

    The decimal module makes it possible to restore the identities by +expanding the precision sufficiently to avoid loss of significance:

    +
    >>> getcontext().prec = 20
    +>>> u, v, w = Decimal(11111113), Decimal(-11111111), Decimal('7.51111111')
    +>>> (u + v) + w
    +Decimal('9.51111111')
    +>>> u + (v + w)
    +Decimal('9.51111111')
    +>>>
    +>>> u, v, w = Decimal(20000), Decimal(-6), Decimal('6.0000003')
    +>>> (u*v) + (u*w)
    +Decimal('0.0060000')
    +>>> u * (v+w)
    +Decimal('0.0060000')
    +
    +
    +
    +
    +

    Special values

    +

    The number system for the decimal module provides special values +including NaN, sNaN, -Infinity, Infinity, +and two zeros, +0 and -0.

    +

    Infinities can be constructed directly with: Decimal('Infinity'). Also, +they can arise from dividing by zero when the DivisionByZero signal is +not trapped. Likewise, when the Overflow signal is not trapped, infinity +can result from rounding beyond the limits of the largest representable number.

    +

    The infinities are signed (affine) and can be used in arithmetic operations +where they get treated as very large, indeterminate numbers. For instance, +adding a constant to infinity gives another infinite result.

    +

    Some operations are indeterminate and return NaN, or if the +InvalidOperation signal is trapped, raise an exception. For example, +0/0 returns NaN which means “not a number”. This variety of +NaN is quiet and, once created, will flow through other computations +always resulting in another NaN. This behavior can be useful for a +series of computations that occasionally have missing inputs — it allows the +calculation to proceed while flagging specific results as invalid.

    +

    A variant is sNaN which signals rather than remaining quiet after every +operation. This is a useful return value when an invalid result needs to +interrupt a calculation for special handling.

    +

    The behavior of Python’s comparison operators can be a little surprising where a +NaN is involved. A test for equality where one of the operands is a +quiet or signaling NaN always returns False (even when doing +Decimal('NaN')==Decimal('NaN')), while a test for inequality always returns +True. An attempt to compare two Decimals using any of the <, +<=, > or >= operators will raise the InvalidOperation signal +if either operand is a NaN, and return False if this signal is +not trapped. Note that the General Decimal Arithmetic specification does not +specify the behavior of direct comparisons; these rules for comparisons +involving a NaN were taken from the IEEE 854 standard (see Table 3 in +section 5.7). To ensure strict standards-compliance, use the compare() +and compare-signal() methods instead.

    +

    The signed zeros can result from calculations that underflow. They keep the sign +that would have resulted if the calculation had been carried out to greater +precision. Since their magnitude is zero, both positive and negative zeros are +treated as equal and their sign is informational.

    +

    In addition to the two signed zeros which are distinct yet equal, there are +various representations of zero with differing precisions yet equivalent in +value. This takes a bit of getting used to. For an eye accustomed to +normalized floating point representations, it is not immediately obvious that +the following calculation returns a value equal to zero:

    +
    >>> 1 / Decimal('Infinity')
    +Decimal('0E-1000026')
    +
    +
    +
    +
    +
    +

    Working with threads

    +

    The getcontext() function accesses a different Context object for +each thread. Having separate thread contexts means that threads may make +changes (such as getcontext().prec=10) without interfering with other threads.

    +

    Likewise, the setcontext() function automatically assigns its target to +the current thread.

    +

    If setcontext() has not been called before getcontext(), then +getcontext() will automatically create a new context for use in the +current thread.

    +

    The new context is copied from a prototype context called DefaultContext. To +control the defaults so that each thread will use the same values throughout the +application, directly modify the DefaultContext object. This should be done +before any threads are started so that there won’t be a race condition between +threads calling getcontext(). For example:

    +
    # Set applicationwide defaults for all threads about to be launched
    +DefaultContext.prec = 12
    +DefaultContext.rounding = ROUND_DOWN
    +DefaultContext.traps = ExtendedContext.traps.copy()
    +DefaultContext.traps[InvalidOperation] = 1
    +setcontext(DefaultContext)
    +
    +# Afterwards, the threads can be started
    +t1.start()
    +t2.start()
    +t3.start()
    + . . .
    +
    +
    +
    +
    +

    Recipes

    +

    Here are a few recipes that serve as utility functions and that demonstrate ways +to work with the Decimal class:

    +
    def moneyfmt(value, places=2, curr='', sep=',', dp='.',
    +             pos='', neg='-', trailneg=''):
    +    """Convert Decimal to a money formatted string.
    +
    +    places:  required number of places after the decimal point
    +    curr:    optional currency symbol before the sign (may be blank)
    +    sep:     optional grouping separator (comma, period, space, or blank)
    +    dp:      decimal point indicator (comma or period)
    +             only specify as blank when places is zero
    +    pos:     optional sign for positive numbers: '+', space or blank
    +    neg:     optional sign for negative numbers: '-', '(', space or blank
    +    trailneg:optional trailing minus indicator:  '-', ')', space or blank
    +
    +    >>> d = Decimal('-1234567.8901')
    +    >>> moneyfmt(d, curr='$')
    +    '-$1,234,567.89'
    +    >>> moneyfmt(d, places=0, sep='.', dp='', neg='', trailneg='-')
    +    '1.234.568-'
    +    >>> moneyfmt(d, curr='$', neg='(', trailneg=')')
    +    '($1,234,567.89)'
    +    >>> moneyfmt(Decimal(123456789), sep=' ')
    +    '123 456 789.00'
    +    >>> moneyfmt(Decimal('-0.02'), neg='<', trailneg='>')
    +    '<0.02>'
    +
    +    """
    +    q = Decimal(10) ** -places      # 2 places --> '0.01'
    +    sign, digits, exp = value.quantize(q).as_tuple()
    +    result = []
    +    digits = list(map(str, digits))
    +    build, next = result.append, digits.pop
    +    if sign:
    +        build(trailneg)
    +    for i in range(places):
    +        build(next() if digits else '0')
    +    if places:
    +        build(dp)
    +    if not digits:
    +        build('0')
    +    i = 0
    +    while digits:
    +        build(next())
    +        i += 1
    +        if i == 3 and digits:
    +            i = 0
    +            build(sep)
    +    build(curr)
    +    build(neg if sign else pos)
    +    return ''.join(reversed(result))
    +
    +def pi():
    +    """Compute Pi to the current precision.
    +
    +    >>> print(pi())
    +    3.141592653589793238462643383
    +
    +    """
    +    getcontext().prec += 2  # extra digits for intermediate steps
    +    three = Decimal(3)      # substitute "three=3.0" for regular floats
    +    lasts, t, s, n, na, d, da = 0, three, 3, 1, 0, 0, 24
    +    while s != lasts:
    +        lasts = s
    +        n, na = n+na, na+8
    +        d, da = d+da, da+32
    +        t = (t * n) / d
    +        s += t
    +    getcontext().prec -= 2
    +    return +s               # unary plus applies the new precision
    +
    +def exp(x):
    +    """Return e raised to the power of x.  Result type matches input type.
    +
    +    >>> print(exp(Decimal(1)))
    +    2.718281828459045235360287471
    +    >>> print(exp(Decimal(2)))
    +    7.389056098930650227230427461
    +    >>> print(exp(2.0))
    +    7.38905609893
    +    >>> print(exp(2+0j))
    +    (7.38905609893+0j)
    +
    +    """
    +    getcontext().prec += 2
    +    i, lasts, s, fact, num = 0, 0, 1, 1, 1
    +    while s != lasts:
    +        lasts = s
    +        i += 1
    +        fact *= i
    +        num *= x
    +        s += num / fact
    +    getcontext().prec -= 2
    +    return +s
    +
    +def cos(x):
    +    """Return the cosine of x as measured in radians.
    +
    +    The Taylor series approximation works best for a small value of x.
    +    For larger values, first compute x = x % (2 * pi).
    +
    +    >>> print(cos(Decimal('0.5')))
    +    0.8775825618903727161162815826
    +    >>> print(cos(0.5))
    +    0.87758256189
    +    >>> print(cos(0.5+0j))
    +    (0.87758256189+0j)
    +
    +    """
    +    getcontext().prec += 2
    +    i, lasts, s, fact, num, sign = 0, 0, 1, 1, 1, 1
    +    while s != lasts:
    +        lasts = s
    +        i += 2
    +        fact *= i * (i-1)
    +        num *= x * x
    +        sign *= -1
    +        s += num / fact * sign
    +    getcontext().prec -= 2
    +    return +s
    +
    +def sin(x):
    +    """Return the sine of x as measured in radians.
    +
    +    The Taylor series approximation works best for a small value of x.
    +    For larger values, first compute x = x % (2 * pi).
    +
    +    >>> print(sin(Decimal('0.5')))
    +    0.4794255386042030002732879352
    +    >>> print(sin(0.5))
    +    0.479425538604
    +    >>> print(sin(0.5+0j))
    +    (0.479425538604+0j)
    +
    +    """
    +    getcontext().prec += 2
    +    i, lasts, s, fact, num, sign = 1, 0, x, 1, x, 1
    +    while s != lasts:
    +        lasts = s
    +        i += 2
    +        fact *= i * (i-1)
    +        num *= x * x
    +        sign *= -1
    +        s += num / fact * sign
    +    getcontext().prec -= 2
    +    return +s
    +
    +
    +
    +
    +

    Decimal FAQ

    +

    Q. It is cumbersome to type decimal.Decimal('1234.5'). Is there a way to +minimize typing when using the interactive interpreter?

    +

    A. Some users abbreviate the constructor to just a single letter:

    +
    >>> D = decimal.Decimal
    +>>> D('1.23') + D('3.45')
    +Decimal('4.68')
    +
    +
    +

    Q. In a fixed-point application with two decimal places, some inputs have many +places and need to be rounded. Others are not supposed to have excess digits +and need to be validated. What methods should be used?

    +

    A. The quantize() method rounds to a fixed number of decimal places. If +the Inexact trap is set, it is also useful for validation:

    +
    >>> TWOPLACES = Decimal(10) ** -2       # same as Decimal('0.01')
    +
    +
    +
    >>> # Round to two places
    +>>> Decimal('3.214').quantize(TWOPLACES)
    +Decimal('3.21')
    +
    +
    +
    >>> # Validate that a number does not exceed two places
    +>>> Decimal('3.21').quantize(TWOPLACES, context=Context(traps=[Inexact]))
    +Decimal('3.21')
    +
    +
    +
    >>> Decimal('3.214').quantize(TWOPLACES, context=Context(traps=[Inexact]))
    +Traceback (most recent call last):
    +   ...
    +Inexact: None
    +
    +
    +

    Q. Once I have valid two place inputs, how do I maintain that invariant +throughout an application?

    +

    A. Some operations like addition, subtraction, and multiplication by an integer +will automatically preserve fixed point. Others operations, like division and +non-integer multiplication, will change the number of decimal places and need to +be followed-up with a quantize() step:

    +
    >>> a = Decimal('102.72')           # Initial fixed-point values
    +>>> b = Decimal('3.17')
    +>>> a + b                           # Addition preserves fixed-point
    +Decimal('105.89')
    +>>> a - b
    +Decimal('99.55')
    +>>> a * 42                          # So does integer multiplication
    +Decimal('4314.24')
    +>>> (a * b).quantize(TWOPLACES)     # Must quantize non-integer multiplication
    +Decimal('325.62')
    +>>> (b / a).quantize(TWOPLACES)     # And quantize division
    +Decimal('0.03')
    +
    +
    +

    In developing fixed-point applications, it is convenient to define functions +to handle the quantize() step:

    +
    >>> def mul(x, y, fp=TWOPLACES):
    +...     return (x * y).quantize(fp)
    +>>> def div(x, y, fp=TWOPLACES):
    +...     return (x / y).quantize(fp)
    +
    +
    +
    >>> mul(a, b)                       # Automatically preserve fixed-point
    +Decimal('325.62')
    +>>> div(b, a)
    +Decimal('0.03')
    +
    +
    +

    Q. There are many ways to express the same value. The numbers 200, +200.000, 2E2, and 02E+4 all have the same value at +various precisions. Is there a way to transform them to a single recognizable +canonical value?

    +

    A. The normalize() method maps all equivalent values to a single +representative:

    +
    >>> values = map(Decimal, '200 200.000 2E2 .02E+4'.split())
    +>>> [v.normalize() for v in values]
    +[Decimal('2E+2'), Decimal('2E+2'), Decimal('2E+2'), Decimal('2E+2')]
    +
    +
    +

    Q. Some decimal values always print with exponential notation. Is there a way +to get a non-exponential representation?

    +

    A. For some values, exponential notation is the only way to express the number +of significant places in the coefficient. For example, expressing +5.0E+3 as 5000 keeps the value constant but cannot show the +original’s two-place significance.

    +

    If an application does not care about tracking significance, it is easy to +remove the exponent and trailing zeroes, losing significance, but keeping the +value unchanged:

    +
    >>> def remove_exponent(d):
    +...     return d.quantize(Decimal(1)) if d == d.to_integral() else d.normalize()
    +
    +
    +
    >>> remove_exponent(Decimal('5E+3'))
    +Decimal('5000')
    +
    +
    +

    Q. Is there a way to convert a regular float to a Decimal?

    +

    A. Yes, any binary floating point number can be exactly expressed as a +Decimal though an exact conversion may take more precision than intuition would +suggest:

    +
    >>> Decimal(math.pi)
    +Decimal('3.141592653589793115997963468544185161590576171875')
    +
    +
    +

    Q. Within a complex calculation, how can I make sure that I haven’t gotten a +spurious result because of insufficient precision or rounding anomalies.

    +

    A. The decimal module makes it easy to test results. A best practice is to +re-run calculations using greater precision and with various rounding modes. +Widely differing results indicate insufficient precision, rounding mode issues, +ill-conditioned inputs, or a numerically unstable algorithm.

    +

    Q. I noticed that context precision is applied to the results of operations but +not to the inputs. Is there anything to watch out for when mixing values of +different precisions?

    +

    A. Yes. The principle is that all values are considered to be exact and so is +the arithmetic on those values. Only the results are rounded. The advantage +for inputs is that “what you type is what you get”. A disadvantage is that the +results can look odd if you forget that the inputs haven’t been rounded:

    +
    >>> getcontext().prec = 3
    +>>> Decimal('3.104') + Decimal('2.104')
    +Decimal('5.21')
    +>>> Decimal('3.104') + Decimal('0.000') + Decimal('2.104')
    +Decimal('5.20')
    +
    +
    +

    The solution is either to increase precision or to force rounding of inputs +using the unary plus operation:

    +
    >>> getcontext().prec = 3
    +>>> +Decimal('1.23456789')      # unary plus triggers rounding
    +Decimal('1.23')
    +
    +
    +

    Alternatively, inputs can be rounded upon creation using the +Context.create_decimal() method:

    +
    >>> Context(prec=5, rounding=ROUND_DOWN).create_decimal('1.2345678')
    +Decimal('1.2345')
    +
    +
    +

    Q. Is the CPython implementation fast for large numbers?

    +

    A. Yes. In the CPython and PyPy3 implementations, the C/CFFI versions of +the decimal module integrate the high speed libmpdec library for +arbitrary precision correctly-rounded decimal floating point arithmetic. +libmpdec uses Karatsuba multiplication +for medium-sized numbers and the Number Theoretic Transform +for very large numbers. However, to realize this performance gain, the +context needs to be set for unrounded calculations.

    +
    >>> c = getcontext()
    +>>> c.prec = MAX_PREC
    +>>> c.Emax = MAX_EMAX
    +>>> c.Emin = MIN_EMIN
    +
    +
    +
    +

    New in version 3.3.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/development.html b/python-3.7.4-docs-html/library/development.html new file mode 100644 index 0000000..92d2945 --- /dev/null +++ b/python-3.7.4-docs-html/library/development.html @@ -0,0 +1,350 @@ + + + + + + + Development Tools — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Development Tools

    +

    The modules described in this chapter help you write software. For example, the +pydoc module takes a module and generates documentation based on the +module’s contents. The doctest and unittest modules contains +frameworks for writing unit tests that automatically exercise code and verify +that the expected output is produced. 2to3 can translate Python 2.x +source code into valid Python 3.x code.

    +

    The list of modules described in this chapter is:

    +
    + +
    +

    See also the Python development mode: the -X dev option and +PYTHONDEVMODE environment variable.

    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/difflib.html b/python-3.7.4-docs-html/library/difflib.html new file mode 100644 index 0000000..8d51de4 --- /dev/null +++ b/python-3.7.4-docs-html/library/difflib.html @@ -0,0 +1,970 @@ + + + + + + + difflib — Helpers for computing deltas — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    difflib — Helpers for computing deltas

    +

    Source code: Lib/difflib.py

    +
    +

    This module provides classes and functions for comparing sequences. It +can be used for example, for comparing files, and can produce difference +information in various formats, including HTML and context and unified +diffs. For comparing directories and files, see also, the filecmp module.

    +
    +
    +class difflib.SequenceMatcher
    +

    This is a flexible class for comparing pairs of sequences of any type, so long +as the sequence elements are hashable. The basic algorithm predates, and is a +little fancier than, an algorithm published in the late 1980’s by Ratcliff and +Obershelp under the hyperbolic name “gestalt pattern matching.” The idea is to +find the longest contiguous matching subsequence that contains no “junk” +elements; these “junk” elements are ones that are uninteresting in some +sense, such as blank lines or whitespace. (Handling junk is an +extension to the Ratcliff and Obershelp algorithm.) The same +idea is then applied recursively to the pieces of the sequences to the left and +to the right of the matching subsequence. This does not yield minimal edit +sequences, but does tend to yield matches that “look right” to people.

    +

    Timing: The basic Ratcliff-Obershelp algorithm is cubic time in the worst +case and quadratic time in the expected case. SequenceMatcher is +quadratic time for the worst case and has expected-case behavior dependent in a +complicated way on how many elements the sequences have in common; best case +time is linear.

    +

    Automatic junk heuristic: SequenceMatcher supports a heuristic that +automatically treats certain sequence items as junk. The heuristic counts how many +times each individual item appears in the sequence. If an item’s duplicates (after +the first one) account for more than 1% of the sequence and the sequence is at least +200 items long, this item is marked as “popular” and is treated as junk for +the purpose of sequence matching. This heuristic can be turned off by setting +the autojunk argument to False when creating the SequenceMatcher.

    +
    +

    New in version 3.2: The autojunk parameter.

    +
    +
    + +
    +
    +class difflib.Differ
    +

    This is a class for comparing sequences of lines of text, and producing +human-readable differences or deltas. Differ uses SequenceMatcher +both to compare sequences of lines, and to compare sequences of characters +within similar (near-matching) lines.

    +

    Each line of a Differ delta begins with a two-letter code:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Code

    Meaning

    '- '

    line unique to sequence 1

    '+ '

    line unique to sequence 2

    '  '

    line common to both sequences

    '? '

    line not present in either input sequence

    +

    Lines beginning with ‘?’ attempt to guide the eye to intraline differences, +and were not present in either input sequence. These lines can be confusing if +the sequences contain tab characters.

    +
    + +
    +
    +class difflib.HtmlDiff
    +

    This class can be used to create an HTML table (or a complete HTML file +containing the table) showing a side by side, line by line comparison of text +with inter-line and intra-line change highlights. The table can be generated in +either full or contextual difference mode.

    +

    The constructor for this class is:

    +
    +
    +__init__(tabsize=8, wrapcolumn=None, linejunk=None, charjunk=IS_CHARACTER_JUNK)
    +

    Initializes instance of HtmlDiff.

    +

    tabsize is an optional keyword argument to specify tab stop spacing and +defaults to 8.

    +

    wrapcolumn is an optional keyword to specify column number where lines are +broken and wrapped, defaults to None where lines are not wrapped.

    +

    linejunk and charjunk are optional keyword arguments passed into ndiff() +(used by HtmlDiff to generate the side by side HTML differences). See +ndiff() documentation for argument default values and descriptions.

    +
    + +

    The following methods are public:

    +
    +
    +make_file(fromlines, tolines, fromdesc='', todesc='', context=False, numlines=5, *, charset='utf-8')
    +

    Compares fromlines and tolines (lists of strings) and returns a string which +is a complete HTML file containing a table showing line by line differences with +inter-line and intra-line changes highlighted.

    +

    fromdesc and todesc are optional keyword arguments to specify from/to file +column header strings (both default to an empty string).

    +

    context and numlines are both optional keyword arguments. Set context to +True when contextual differences are to be shown, else the default is +False to show the full files. numlines defaults to 5. When context +is True numlines controls the number of context lines which surround the +difference highlights. When context is False numlines controls the +number of lines which are shown before a difference highlight when using the +“next” hyperlinks (setting to zero would cause the “next” hyperlinks to place +the next difference highlight at the top of the browser without any leading +context).

    +
    +

    Changed in version 3.5: charset keyword-only argument was added. The default charset of +HTML document changed from 'ISO-8859-1' to 'utf-8'.

    +
    +
    + +
    +
    +make_table(fromlines, tolines, fromdesc='', todesc='', context=False, numlines=5)
    +

    Compares fromlines and tolines (lists of strings) and returns a string which +is a complete HTML table showing line by line differences with inter-line and +intra-line changes highlighted.

    +

    The arguments for this method are the same as those for the make_file() +method.

    +
    + +

    Tools/scripts/diff.py is a command-line front-end to this class and +contains a good example of its use.

    +
    + +
    +
    +difflib.context_diff(a, b, fromfile='', tofile='', fromfiledate='', tofiledate='', n=3, lineterm='\n')
    +

    Compare a and b (lists of strings); return a delta (a generator +generating the delta lines) in context diff format.

    +

    Context diffs are a compact way of showing just the lines that have changed plus +a few lines of context. The changes are shown in a before/after style. The +number of context lines is set by n which defaults to three.

    +

    By default, the diff control lines (those with *** or ---) are created +with a trailing newline. This is helpful so that inputs created from +io.IOBase.readlines() result in diffs that are suitable for use with +io.IOBase.writelines() since both the inputs and outputs have trailing +newlines.

    +

    For inputs that do not have trailing newlines, set the lineterm argument to +"" so that the output will be uniformly newline free.

    +

    The context diff format normally has a header for filenames and modification +times. Any or all of these may be specified using strings for fromfile, +tofile, fromfiledate, and tofiledate. The modification times are normally +expressed in the ISO 8601 format. If not specified, the +strings default to blanks.

    +
    >>> s1 = ['bacon\n', 'eggs\n', 'ham\n', 'guido\n']
    +>>> s2 = ['python\n', 'eggy\n', 'hamster\n', 'guido\n']
    +>>> sys.stdout.writelines(context_diff(s1, s2, fromfile='before.py', tofile='after.py'))
    +*** before.py
    +--- after.py
    +***************
    +*** 1,4 ****
    +! bacon
    +! eggs
    +! ham
    +  guido
    +--- 1,4 ----
    +! python
    +! eggy
    +! hamster
    +  guido
    +
    +
    +

    See A command-line interface to difflib for a more detailed example.

    +
    + +
    +
    +difflib.get_close_matches(word, possibilities, n=3, cutoff=0.6)
    +

    Return a list of the best “good enough” matches. word is a sequence for which +close matches are desired (typically a string), and possibilities is a list of +sequences against which to match word (typically a list of strings).

    +

    Optional argument n (default 3) is the maximum number of close matches to +return; n must be greater than 0.

    +

    Optional argument cutoff (default 0.6) is a float in the range [0, 1]. +Possibilities that don’t score at least that similar to word are ignored.

    +

    The best (no more than n) matches among the possibilities are returned in a +list, sorted by similarity score, most similar first.

    +
    >>> get_close_matches('appel', ['ape', 'apple', 'peach', 'puppy'])
    +['apple', 'ape']
    +>>> import keyword
    +>>> get_close_matches('wheel', keyword.kwlist)
    +['while']
    +>>> get_close_matches('pineapple', keyword.kwlist)
    +[]
    +>>> get_close_matches('accept', keyword.kwlist)
    +['except']
    +
    +
    +
    + +
    +
    +difflib.ndiff(a, b, linejunk=None, charjunk=IS_CHARACTER_JUNK)
    +

    Compare a and b (lists of strings); return a Differ-style +delta (a generator generating the delta lines).

    +

    Optional keyword parameters linejunk and charjunk are filtering functions +(or None):

    +

    linejunk: A function that accepts a single string argument, and returns +true if the string is junk, or false if not. The default is None. There +is also a module-level function IS_LINE_JUNK(), which filters out lines +without visible characters, except for at most one pound character ('#') +– however the underlying SequenceMatcher class does a dynamic +analysis of which lines are so frequent as to constitute noise, and this +usually works better than using this function.

    +

    charjunk: A function that accepts a character (a string of length 1), and +returns if the character is junk, or false if not. The default is module-level +function IS_CHARACTER_JUNK(), which filters out whitespace characters (a +blank or tab; it’s a bad idea to include newline in this!).

    +

    Tools/scripts/ndiff.py is a command-line front-end to this function.

    +
    >>> diff = ndiff('one\ntwo\nthree\n'.splitlines(keepends=True),
    +...              'ore\ntree\nemu\n'.splitlines(keepends=True))
    +>>> print(''.join(diff), end="")
    +- one
    +?  ^
    ++ ore
    +?  ^
    +- two
    +- three
    +?  -
    ++ tree
    ++ emu
    +
    +
    +
    + +
    +
    +difflib.restore(sequence, which)
    +

    Return one of the two sequences that generated a delta.

    +

    Given a sequence produced by Differ.compare() or ndiff(), extract +lines originating from file 1 or 2 (parameter which), stripping off line +prefixes.

    +

    Example:

    +
    >>> diff = ndiff('one\ntwo\nthree\n'.splitlines(keepends=True),
    +...              'ore\ntree\nemu\n'.splitlines(keepends=True))
    +>>> diff = list(diff) # materialize the generated delta into a list
    +>>> print(''.join(restore(diff, 1)), end="")
    +one
    +two
    +three
    +>>> print(''.join(restore(diff, 2)), end="")
    +ore
    +tree
    +emu
    +
    +
    +
    + +
    +
    +difflib.unified_diff(a, b, fromfile='', tofile='', fromfiledate='', tofiledate='', n=3, lineterm='\n')
    +

    Compare a and b (lists of strings); return a delta (a generator +generating the delta lines) in unified diff format.

    +

    Unified diffs are a compact way of showing just the lines that have changed plus +a few lines of context. The changes are shown in an inline style (instead of +separate before/after blocks). The number of context lines is set by n which +defaults to three.

    +

    By default, the diff control lines (those with ---, +++, or @@) are +created with a trailing newline. This is helpful so that inputs created from +io.IOBase.readlines() result in diffs that are suitable for use with +io.IOBase.writelines() since both the inputs and outputs have trailing +newlines.

    +

    For inputs that do not have trailing newlines, set the lineterm argument to +"" so that the output will be uniformly newline free.

    +

    The context diff format normally has a header for filenames and modification +times. Any or all of these may be specified using strings for fromfile, +tofile, fromfiledate, and tofiledate. The modification times are normally +expressed in the ISO 8601 format. If not specified, the +strings default to blanks.

    +
    >>> s1 = ['bacon\n', 'eggs\n', 'ham\n', 'guido\n']
    +>>> s2 = ['python\n', 'eggy\n', 'hamster\n', 'guido\n']
    +>>> sys.stdout.writelines(unified_diff(s1, s2, fromfile='before.py', tofile='after.py'))
    +--- before.py
    ++++ after.py
    +@@ -1,4 +1,4 @@
    +-bacon
    +-eggs
    +-ham
    ++python
    ++eggy
    ++hamster
    + guido
    +
    +
    +

    See A command-line interface to difflib for a more detailed example.

    +
    + +
    +
    +difflib.diff_bytes(dfunc, a, b, fromfile=b'', tofile=b'', fromfiledate=b'', tofiledate=b'', n=3, lineterm=b'\n')
    +

    Compare a and b (lists of bytes objects) using dfunc; yield a +sequence of delta lines (also bytes) in the format returned by dfunc. +dfunc must be a callable, typically either unified_diff() or +context_diff().

    +

    Allows you to compare data with unknown or inconsistent encoding. All +inputs except n must be bytes objects, not str. Works by losslessly +converting all inputs (except n) to str, and calling dfunc(a, b, +fromfile, tofile, fromfiledate, tofiledate, n, lineterm). The output of +dfunc is then converted back to bytes, so the delta lines that you +receive have the same unknown/inconsistent encodings as a and b.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +difflib.IS_LINE_JUNK(line)
    +

    Return true for ignorable lines. The line line is ignorable if line is +blank or contains a single '#', otherwise it is not ignorable. Used as a +default for parameter linejunk in ndiff() in older versions.

    +
    + +
    +
    +difflib.IS_CHARACTER_JUNK(ch)
    +

    Return true for ignorable characters. The character ch is ignorable if ch +is a space or tab, otherwise it is not ignorable. Used as a default for +parameter charjunk in ndiff().

    +
    + +
    +

    See also

    +
    +
    Pattern Matching: The Gestalt Approach

    Discussion of a similar algorithm by John W. Ratcliff and D. E. Metzener. This +was published in Dr. Dobb’s Journal in July, 1988.

    +
    +
    +
    +
    +

    SequenceMatcher Objects

    +

    The SequenceMatcher class has this constructor:

    +
    +
    +class difflib.SequenceMatcher(isjunk=None, a='', b='', autojunk=True)
    +

    Optional argument isjunk must be None (the default) or a one-argument +function that takes a sequence element and returns true if and only if the +element is “junk” and should be ignored. Passing None for isjunk is +equivalent to passing lambda x: 0; in other words, no elements are ignored. +For example, pass:

    +
    lambda x: x in " \t"
    +
    +
    +

    if you’re comparing lines as sequences of characters, and don’t want to synch up +on blanks or hard tabs.

    +

    The optional arguments a and b are sequences to be compared; both default to +empty strings. The elements of both sequences must be hashable.

    +

    The optional argument autojunk can be used to disable the automatic junk +heuristic.

    +
    +

    New in version 3.2: The autojunk parameter.

    +
    +

    SequenceMatcher objects get three data attributes: bjunk is the +set of elements of b for which isjunk is True; bpopular is the set of +non-junk elements considered popular by the heuristic (if it is not +disabled); b2j is a dict mapping the remaining elements of b to a list +of positions where they occur. All three are reset whenever b is reset +with set_seqs() or set_seq2().

    +
    +

    New in version 3.2: The bjunk and bpopular attributes.

    +
    +

    SequenceMatcher objects have the following methods:

    +
    +
    +set_seqs(a, b)
    +

    Set the two sequences to be compared.

    +
    + +

    SequenceMatcher computes and caches detailed information about the +second sequence, so if you want to compare one sequence against many +sequences, use set_seq2() to set the commonly used sequence once and +call set_seq1() repeatedly, once for each of the other sequences.

    +
    +
    +set_seq1(a)
    +

    Set the first sequence to be compared. The second sequence to be compared +is not changed.

    +
    + +
    +
    +set_seq2(b)
    +

    Set the second sequence to be compared. The first sequence to be compared +is not changed.

    +
    + +
    +
    +find_longest_match(alo, ahi, blo, bhi)
    +

    Find longest matching block in a[alo:ahi] and b[blo:bhi].

    +

    If isjunk was omitted or None, find_longest_match() returns +(i, j, k) such that a[i:i+k] is equal to b[j:j+k], where alo +<= i <= i+k <= ahi and blo <= j <= j+k <= bhi. For all (i', j', +k') meeting those conditions, the additional conditions k >= k', i +<= i', and if i == i', j <= j' are also met. In other words, of +all maximal matching blocks, return one that starts earliest in a, and +of all those maximal matching blocks that start earliest in a, return +the one that starts earliest in b.

    +
    >>> s = SequenceMatcher(None, " abcd", "abcd abcd")
    +>>> s.find_longest_match(0, 5, 0, 9)
    +Match(a=0, b=4, size=5)
    +
    +
    +

    If isjunk was provided, first the longest matching block is determined +as above, but with the additional restriction that no junk element appears +in the block. Then that block is extended as far as possible by matching +(only) junk elements on both sides. So the resulting block never matches +on junk except as identical junk happens to be adjacent to an interesting +match.

    +

    Here’s the same example as before, but considering blanks to be junk. That +prevents ' abcd' from matching the ' abcd' at the tail end of the +second sequence directly. Instead only the 'abcd' can match, and +matches the leftmost 'abcd' in the second sequence:

    +
    >>> s = SequenceMatcher(lambda x: x==" ", " abcd", "abcd abcd")
    +>>> s.find_longest_match(0, 5, 0, 9)
    +Match(a=1, b=0, size=4)
    +
    +
    +

    If no blocks match, this returns (alo, blo, 0).

    +

    This method returns a named tuple Match(a, b, size).

    +
    + +
    +
    +get_matching_blocks()
    +

    Return list of triples describing non-overlapping matching subsequences. +Each triple is of the form (i, j, n), +and means that a[i:i+n] == b[j:j+n]. The +triples are monotonically increasing in i and j.

    +

    The last triple is a dummy, and has the value (len(a), len(b), 0). It +is the only triple with n == 0. If (i, j, n) and (i', j', n') +are adjacent triples in the list, and the second is not the last triple in +the list, then i+n < i' or j+n < j'; in other words, adjacent +triples always describe non-adjacent equal blocks.

    +
    >>> s = SequenceMatcher(None, "abxcd", "abcd")
    +>>> s.get_matching_blocks()
    +[Match(a=0, b=0, size=2), Match(a=3, b=2, size=2), Match(a=5, b=4, size=0)]
    +
    +
    +
    + +
    +
    +get_opcodes()
    +

    Return list of 5-tuples describing how to turn a into b. Each tuple is +of the form (tag, i1, i2, j1, j2). The first tuple has i1 == j1 == +0, and remaining tuples have i1 equal to the i2 from the preceding +tuple, and, likewise, j1 equal to the previous j2.

    +

    The tag values are strings, with these meanings:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Value

    Meaning

    'replace'

    a[i1:i2] should be replaced by +b[j1:j2].

    'delete'

    a[i1:i2] should be deleted. Note that +j1 == j2 in this case.

    'insert'

    b[j1:j2] should be inserted at +a[i1:i1]. Note that i1 == i2 in +this case.

    'equal'

    a[i1:i2] == b[j1:j2] (the sub-sequences +are equal).

    +

    For example:

    +
    >>> a = "qabxcd"
    +>>> b = "abycdf"
    +>>> s = SequenceMatcher(None, a, b)
    +>>> for tag, i1, i2, j1, j2 in s.get_opcodes():
    +...     print('{:7}   a[{}:{}] --> b[{}:{}] {!r:>8} --> {!r}'.format(
    +...         tag, i1, i2, j1, j2, a[i1:i2], b[j1:j2]))
    +delete    a[0:1] --> b[0:0]      'q' --> ''
    +equal     a[1:3] --> b[0:2]     'ab' --> 'ab'
    +replace   a[3:4] --> b[2:3]      'x' --> 'y'
    +equal     a[4:6] --> b[3:5]     'cd' --> 'cd'
    +insert    a[6:6] --> b[5:6]       '' --> 'f'
    +
    +
    +
    + +
    +
    +get_grouped_opcodes(n=3)
    +

    Return a generator of groups with up to n lines of context.

    +

    Starting with the groups returned by get_opcodes(), this method +splits out smaller change clusters and eliminates intervening ranges which +have no changes.

    +

    The groups are returned in the same format as get_opcodes().

    +
    + +
    +
    +ratio()
    +

    Return a measure of the sequences’ similarity as a float in the range [0, +1].

    +

    Where T is the total number of elements in both sequences, and M is the +number of matches, this is 2.0*M / T. Note that this is 1.0 if the +sequences are identical, and 0.0 if they have nothing in common.

    +

    This is expensive to compute if get_matching_blocks() or +get_opcodes() hasn’t already been called, in which case you may want +to try quick_ratio() or real_quick_ratio() first to get an +upper bound.

    +
    + +
    +
    +quick_ratio()
    +

    Return an upper bound on ratio() relatively quickly.

    +
    + +
    +
    +real_quick_ratio()
    +

    Return an upper bound on ratio() very quickly.

    +
    + +
    + +

    The three methods that return the ratio of matching to total characters can give +different results due to differing levels of approximation, although +quick_ratio() and real_quick_ratio() are always at least as large as +ratio():

    +
    >>> s = SequenceMatcher(None, "abcd", "bcde")
    +>>> s.ratio()
    +0.75
    +>>> s.quick_ratio()
    +0.75
    +>>> s.real_quick_ratio()
    +1.0
    +
    +
    +
    +
    +

    SequenceMatcher Examples

    +

    This example compares two strings, considering blanks to be “junk”:

    +
    >>> s = SequenceMatcher(lambda x: x == " ",
    +...                     "private Thread currentThread;",
    +...                     "private volatile Thread currentThread;")
    +
    +
    +

    ratio() returns a float in [0, 1], measuring the similarity of the +sequences. As a rule of thumb, a ratio() value over 0.6 means the +sequences are close matches:

    +
    >>> print(round(s.ratio(), 3))
    +0.866
    +
    +
    +

    If you’re only interested in where the sequences match, +get_matching_blocks() is handy:

    +
    >>> for block in s.get_matching_blocks():
    +...     print("a[%d] and b[%d] match for %d elements" % block)
    +a[0] and b[0] match for 8 elements
    +a[8] and b[17] match for 21 elements
    +a[29] and b[38] match for 0 elements
    +
    +
    +

    Note that the last tuple returned by get_matching_blocks() is always a +dummy, (len(a), len(b), 0), and this is the only case in which the last +tuple element (number of elements matched) is 0.

    +

    If you want to know how to change the first sequence into the second, use +get_opcodes():

    +
    >>> for opcode in s.get_opcodes():
    +...     print("%6s a[%d:%d] b[%d:%d]" % opcode)
    + equal a[0:8] b[0:8]
    +insert a[8:8] b[8:17]
    + equal a[8:29] b[17:38]
    +
    +
    +
    +

    See also

    + +
    +
    +
    +

    Differ Objects

    +

    Note that Differ-generated deltas make no claim to be minimal +diffs. To the contrary, minimal diffs are often counter-intuitive, because they +synch up anywhere possible, sometimes accidental matches 100 pages apart. +Restricting synch points to contiguous matches preserves some notion of +locality, at the occasional cost of producing a longer diff.

    +

    The Differ class has this constructor:

    +
    +
    +class difflib.Differ(linejunk=None, charjunk=None)
    +

    Optional keyword parameters linejunk and charjunk are for filter functions +(or None):

    +

    linejunk: A function that accepts a single string argument, and returns true +if the string is junk. The default is None, meaning that no line is +considered junk.

    +

    charjunk: A function that accepts a single character argument (a string of +length 1), and returns true if the character is junk. The default is None, +meaning that no character is considered junk.

    +

    These junk-filtering functions speed up matching to find +differences and do not cause any differing lines or characters to +be ignored. Read the description of the +find_longest_match() method’s isjunk +parameter for an explanation.

    +

    Differ objects are used (deltas generated) via a single method:

    +
    +
    +compare(a, b)
    +

    Compare two sequences of lines, and generate the delta (a sequence of lines).

    +

    Each sequence must contain individual single-line strings ending with +newlines. Such sequences can be obtained from the +readlines() method of file-like objects. The delta +generated also consists of newline-terminated strings, ready to be +printed as-is via the writelines() method of a +file-like object.

    +
    + +
    + +
    +
    +

    Differ Example

    +

    This example compares two texts. First we set up the texts, sequences of +individual single-line strings ending with newlines (such sequences can also be +obtained from the readlines() method of file-like objects):

    +
    >>> text1 = '''  1. Beautiful is better than ugly.
    +...   2. Explicit is better than implicit.
    +...   3. Simple is better than complex.
    +...   4. Complex is better than complicated.
    +... '''.splitlines(keepends=True)
    +>>> len(text1)
    +4
    +>>> text1[0][-1]
    +'\n'
    +>>> text2 = '''  1. Beautiful is better than ugly.
    +...   3.   Simple is better than complex.
    +...   4. Complicated is better than complex.
    +...   5. Flat is better than nested.
    +... '''.splitlines(keepends=True)
    +
    +
    +

    Next we instantiate a Differ object:

    +
    >>> d = Differ()
    +
    +
    +

    Note that when instantiating a Differ object we may pass functions to +filter out line and character “junk.” See the Differ() constructor for +details.

    +

    Finally, we compare the two:

    +
    >>> result = list(d.compare(text1, text2))
    +
    +
    +

    result is a list of strings, so let’s pretty-print it:

    +
    >>> from pprint import pprint
    +>>> pprint(result)
    +['    1. Beautiful is better than ugly.\n',
    + '-   2. Explicit is better than implicit.\n',
    + '-   3. Simple is better than complex.\n',
    + '+   3.   Simple is better than complex.\n',
    + '?     ++\n',
    + '-   4. Complex is better than complicated.\n',
    + '?            ^                     ---- ^\n',
    + '+   4. Complicated is better than complex.\n',
    + '?           ++++ ^                      ^\n',
    + '+   5. Flat is better than nested.\n']
    +
    +
    +

    As a single multi-line string it looks like this:

    +
    >>> import sys
    +>>> sys.stdout.writelines(result)
    +    1. Beautiful is better than ugly.
    +-   2. Explicit is better than implicit.
    +-   3. Simple is better than complex.
    ++   3.   Simple is better than complex.
    +?     ++
    +-   4. Complex is better than complicated.
    +?            ^                     ---- ^
    ++   4. Complicated is better than complex.
    +?           ++++ ^                      ^
    ++   5. Flat is better than nested.
    +
    +
    +
    +
    +

    A command-line interface to difflib

    +

    This example shows how to use difflib to create a diff-like utility. +It is also contained in the Python source distribution, as +Tools/scripts/diff.py.

    +
    #!/usr/bin/env python3
    +""" Command line interface to difflib.py providing diffs in four formats:
    +
    +* ndiff:    lists every line and highlights interline changes.
    +* context:  highlights clusters of changes in a before/after format.
    +* unified:  highlights clusters of changes in an inline format.
    +* html:     generates side by side comparison with change highlights.
    +
    +"""
    +
    +import sys, os, difflib, argparse
    +from datetime import datetime, timezone
    +
    +def file_mtime(path):
    +    t = datetime.fromtimestamp(os.stat(path).st_mtime,
    +                               timezone.utc)
    +    return t.astimezone().isoformat()
    +
    +def main():
    +
    +    parser = argparse.ArgumentParser()
    +    parser.add_argument('-c', action='store_true', default=False,
    +                        help='Produce a context format diff (default)')
    +    parser.add_argument('-u', action='store_true', default=False,
    +                        help='Produce a unified format diff')
    +    parser.add_argument('-m', action='store_true', default=False,
    +                        help='Produce HTML side by side diff '
    +                             '(can use -c and -l in conjunction)')
    +    parser.add_argument('-n', action='store_true', default=False,
    +                        help='Produce a ndiff format diff')
    +    parser.add_argument('-l', '--lines', type=int, default=3,
    +                        help='Set number of context lines (default 3)')
    +    parser.add_argument('fromfile')
    +    parser.add_argument('tofile')
    +    options = parser.parse_args()
    +
    +    n = options.lines
    +    fromfile = options.fromfile
    +    tofile = options.tofile
    +
    +    fromdate = file_mtime(fromfile)
    +    todate = file_mtime(tofile)
    +    with open(fromfile) as ff:
    +        fromlines = ff.readlines()
    +    with open(tofile) as tf:
    +        tolines = tf.readlines()
    +
    +    if options.u:
    +        diff = difflib.unified_diff(fromlines, tolines, fromfile, tofile, fromdate, todate, n=n)
    +    elif options.n:
    +        diff = difflib.ndiff(fromlines, tolines)
    +    elif options.m:
    +        diff = difflib.HtmlDiff().make_file(fromlines,tolines,fromfile,tofile,context=options.c,numlines=n)
    +    else:
    +        diff = difflib.context_diff(fromlines, tolines, fromfile, tofile, fromdate, todate, n=n)
    +
    +    sys.stdout.writelines(diff)
    +
    +if __name__ == '__main__':
    +    main()
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/dis.html b/python-3.7.4-docs-html/library/dis.html new file mode 100644 index 0000000..23ec835 --- /dev/null +++ b/python-3.7.4-docs-html/library/dis.html @@ -0,0 +1,1613 @@ + + + + + + + dis — Disassembler for Python bytecode — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    dis — Disassembler for Python bytecode

    +

    Source code: Lib/dis.py

    +
    +

    The dis module supports the analysis of CPython bytecode by +disassembling it. The CPython bytecode which this module takes as an input is +defined in the file Include/opcode.h and used by the compiler and the +interpreter.

    +
    +

    CPython implementation detail: Bytecode is an implementation detail of the CPython interpreter. No +guarantees are made that bytecode will not be added, removed, or changed +between versions of Python. Use of this module should not be considered to +work across Python VMs or Python releases.

    +
    +

    Changed in version 3.6: Use 2 bytes for each instruction. Previously the number of bytes varied +by instruction.

    +
    +
    +

    Example: Given the function myfunc():

    +
    def myfunc(alist):
    +    return len(alist)
    +
    +
    +

    the following command can be used to display the disassembly of +myfunc():

    +
    >>> dis.dis(myfunc)
    +  2           0 LOAD_GLOBAL              0 (len)
    +              2 LOAD_FAST                0 (alist)
    +              4 CALL_FUNCTION            1
    +              6 RETURN_VALUE
    +
    +
    +

    (The “2” is a line number).

    +
    +

    Bytecode analysis

    +
    +

    New in version 3.4.

    +
    +

    The bytecode analysis API allows pieces of Python code to be wrapped in a +Bytecode object that provides easy access to details of the compiled +code.

    +
    +
    +class dis.Bytecode(x, *, first_line=None, current_offset=None)
    +

    Analyse the bytecode corresponding to a function, generator, asynchronous +generator, coroutine, method, string of source code, or a code object (as +returned by compile()).

    +

    This is a convenience wrapper around many of the functions listed below, most +notably get_instructions(), as iterating over a Bytecode +instance yields the bytecode operations as Instruction instances.

    +

    If first_line is not None, it indicates the line number that should be +reported for the first source line in the disassembled code. Otherwise, the +source line information (if any) is taken directly from the disassembled code +object.

    +

    If current_offset is not None, it refers to an instruction offset in the +disassembled code. Setting this means dis() will display a “current +instruction” marker against the specified opcode.

    +
    +
    +classmethod from_traceback(tb)
    +

    Construct a Bytecode instance from the given traceback, setting +current_offset to the instruction responsible for the exception.

    +
    + +
    +
    +codeobj
    +

    The compiled code object.

    +
    + +
    +
    +first_line
    +

    The first source line of the code object (if available)

    +
    + +
    +
    +dis()
    +

    Return a formatted view of the bytecode operations (the same as printed by +dis.dis(), but returned as a multi-line string).

    +
    + +
    +
    +info()
    +

    Return a formatted multi-line string with detailed information about the +code object, like code_info().

    +
    + +
    +

    Changed in version 3.7: This can now handle coroutine and asynchronous generator objects.

    +
    +
    + +

    Example:

    +
    >>> bytecode = dis.Bytecode(myfunc)
    +>>> for instr in bytecode:
    +...     print(instr.opname)
    +...
    +LOAD_GLOBAL
    +LOAD_FAST
    +CALL_FUNCTION
    +RETURN_VALUE
    +
    +
    +
    +
    +

    Analysis functions

    +

    The dis module also defines the following analysis functions that convert +the input directly to the desired output. They can be useful if only a single +operation is being performed, so the intermediate analysis object isn’t useful:

    +
    +
    +dis.code_info(x)
    +

    Return a formatted multi-line string with detailed code object information +for the supplied function, generator, asynchronous generator, coroutine, +method, source code string or code object.

    +

    Note that the exact contents of code info strings are highly implementation +dependent and they may change arbitrarily across Python VMs or Python +releases.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.7: This can now handle coroutine and asynchronous generator objects.

    +
    +
    + +
    +
    +dis.show_code(x, *, file=None)
    +

    Print detailed code object information for the supplied function, method, +source code string or code object to file (or sys.stdout if file +is not specified).

    +

    This is a convenient shorthand for print(code_info(x), file=file), +intended for interactive exploration at the interpreter prompt.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.4: Added file parameter.

    +
    +
    + +
    +
    +dis.dis(x=None, *, file=None, depth=None)
    +

    Disassemble the x object. x can denote either a module, a class, a +method, a function, a generator, an asynchronous generator, a coroutine, +a code object, a string of source code or a byte sequence of raw bytecode. +For a module, it disassembles all functions. For a class, it disassembles +all methods (including class and static methods). For a code object or +sequence of raw bytecode, it prints one line per bytecode instruction. +It also recursively disassembles nested code objects (the code of +comprehensions, generator expressions and nested functions, and the code +used for building nested classes). +Strings are first compiled to code objects with the compile() +built-in function before being disassembled. If no object is provided, this +function disassembles the last traceback.

    +

    The disassembly is written as text to the supplied file argument if +provided and to sys.stdout otherwise.

    +

    The maximal depth of recursion is limited by depth unless it is None. +depth=0 means no recursion.

    +
    +

    Changed in version 3.4: Added file parameter.

    +
    +
    +

    Changed in version 3.7: Implemented recursive disassembling and added depth parameter.

    +
    +
    +

    Changed in version 3.7: This can now handle coroutine and asynchronous generator objects.

    +
    +
    + +
    +
    +dis.distb(tb=None, *, file=None)
    +

    Disassemble the top-of-stack function of a traceback, using the last +traceback if none was passed. The instruction causing the exception is +indicated.

    +

    The disassembly is written as text to the supplied file argument if +provided and to sys.stdout otherwise.

    +
    +

    Changed in version 3.4: Added file parameter.

    +
    +
    + +
    +
    +dis.disassemble(code, lasti=-1, *, file=None)
    +
    +dis.disco(code, lasti=-1, *, file=None)
    +

    Disassemble a code object, indicating the last instruction if lasti was +provided. The output is divided in the following columns:

    +
      +
    1. the line number, for the first instruction of each line

    2. +
    3. the current instruction, indicated as -->,

    4. +
    5. a labelled instruction, indicated with >>,

    6. +
    7. the address of the instruction,

    8. +
    9. the operation code name,

    10. +
    11. operation parameters, and

    12. +
    13. interpretation of the parameters in parentheses.

    14. +
    +

    The parameter interpretation recognizes local and global variable names, +constant values, branch targets, and compare operators.

    +

    The disassembly is written as text to the supplied file argument if +provided and to sys.stdout otherwise.

    +
    +

    Changed in version 3.4: Added file parameter.

    +
    +
    + +
    +
    +dis.get_instructions(x, *, first_line=None)
    +

    Return an iterator over the instructions in the supplied function, method, +source code string or code object.

    +

    The iterator generates a series of Instruction named tuples giving +the details of each operation in the supplied code.

    +

    If first_line is not None, it indicates the line number that should be +reported for the first source line in the disassembled code. Otherwise, the +source line information (if any) is taken directly from the disassembled code +object.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +dis.findlinestarts(code)
    +

    This generator function uses the co_firstlineno and co_lnotab +attributes of the code object code to find the offsets which are starts of +lines in the source code. They are generated as (offset, lineno) pairs. +See Objects/lnotab_notes.txt for the co_lnotab format and +how to decode it.

    +
    +

    Changed in version 3.6: Line numbers can be decreasing. Before, they were always increasing.

    +
    +
    + +
    +
    +dis.findlabels(code)
    +

    Detect all offsets in the code object code which are jump targets, and +return a list of these offsets.

    +
    + +
    +
    +dis.stack_effect(opcode[, oparg])
    +

    Compute the stack effect of opcode with argument oparg.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +

    Python Bytecode Instructions

    +

    The get_instructions() function and Bytecode class provide +details of bytecode instructions as Instruction instances:

    +
    +
    +class dis.Instruction
    +

    Details for a bytecode operation

    +
    +
    +opcode
    +

    numeric code for operation, corresponding to the opcode values listed +below and the bytecode values in the Opcode collections.

    +
    + +
    +
    +opname
    +

    human readable name for operation

    +
    + +
    +
    +arg
    +

    numeric argument to operation (if any), otherwise None

    +
    + +
    +
    +argval
    +

    resolved arg value (if known), otherwise same as arg

    +
    + +
    +
    +argrepr
    +

    human readable description of operation argument

    +
    + +
    +
    +offset
    +

    start index of operation within bytecode sequence

    +
    + +
    +
    +starts_line
    +

    line started by this opcode (if any), otherwise None

    +
    + +
    +
    +is_jump_target
    +

    True if other code jumps to here, otherwise False

    +
    + +
    +

    New in version 3.4.

    +
    +
    + +

    The Python compiler currently generates the following bytecode instructions.

    +

    General instructions

    +
    +
    +NOP
    +

    Do nothing code. Used as a placeholder by the bytecode optimizer.

    +
    + +
    +
    +POP_TOP
    +

    Removes the top-of-stack (TOS) item.

    +
    + +
    +
    +ROT_TWO
    +

    Swaps the two top-most stack items.

    +
    + +
    +
    +ROT_THREE
    +

    Lifts second and third stack item one position up, moves top down to position +three.

    +
    + +
    +
    +DUP_TOP
    +

    Duplicates the reference on top of the stack.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +DUP_TOP_TWO
    +

    Duplicates the two references on top of the stack, leaving them in the +same order.

    +
    +

    New in version 3.2.

    +
    +
    + +

    Unary operations

    +

    Unary operations take the top of the stack, apply the operation, and push the +result back on the stack.

    +
    +
    +UNARY_POSITIVE
    +

    Implements TOS = +TOS.

    +
    + +
    +
    +UNARY_NEGATIVE
    +

    Implements TOS = -TOS.

    +
    + +
    +
    +UNARY_NOT
    +

    Implements TOS = not TOS.

    +
    + +
    +
    +UNARY_INVERT
    +

    Implements TOS = ~TOS.

    +
    + +
    +
    +GET_ITER
    +

    Implements TOS = iter(TOS).

    +
    + +
    +
    +GET_YIELD_FROM_ITER
    +

    If TOS is a generator iterator or coroutine object +it is left as is. Otherwise, implements TOS = iter(TOS).

    +
    +

    New in version 3.5.

    +
    +
    + +

    Binary operations

    +

    Binary operations remove the top of the stack (TOS) and the second top-most +stack item (TOS1) from the stack. They perform the operation, and put the +result back on the stack.

    +
    +
    +BINARY_POWER
    +

    Implements TOS = TOS1 ** TOS.

    +
    + +
    +
    +BINARY_MULTIPLY
    +

    Implements TOS = TOS1 * TOS.

    +
    + +
    +
    +BINARY_MATRIX_MULTIPLY
    +

    Implements TOS = TOS1 @ TOS.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +BINARY_FLOOR_DIVIDE
    +

    Implements TOS = TOS1 // TOS.

    +
    + +
    +
    +BINARY_TRUE_DIVIDE
    +

    Implements TOS = TOS1 / TOS.

    +
    + +
    +
    +BINARY_MODULO
    +

    Implements TOS = TOS1 % TOS.

    +
    + +
    +
    +BINARY_ADD
    +

    Implements TOS = TOS1 + TOS.

    +
    + +
    +
    +BINARY_SUBTRACT
    +

    Implements TOS = TOS1 - TOS.

    +
    + +
    +
    +BINARY_SUBSCR
    +

    Implements TOS = TOS1[TOS].

    +
    + +
    +
    +BINARY_LSHIFT
    +

    Implements TOS = TOS1 << TOS.

    +
    + +
    +
    +BINARY_RSHIFT
    +

    Implements TOS = TOS1 >> TOS.

    +
    + +
    +
    +BINARY_AND
    +

    Implements TOS = TOS1 & TOS.

    +
    + +
    +
    +BINARY_XOR
    +

    Implements TOS = TOS1 ^ TOS.

    +
    + +
    +
    +BINARY_OR
    +

    Implements TOS = TOS1 | TOS.

    +
    + +

    In-place operations

    +

    In-place operations are like binary operations, in that they remove TOS and +TOS1, and push the result back on the stack, but the operation is done in-place +when TOS1 supports it, and the resulting TOS may be (but does not have to be) +the original TOS1.

    +
    +
    +INPLACE_POWER
    +

    Implements in-place TOS = TOS1 ** TOS.

    +
    + +
    +
    +INPLACE_MULTIPLY
    +

    Implements in-place TOS = TOS1 * TOS.

    +
    + +
    +
    +INPLACE_MATRIX_MULTIPLY
    +

    Implements in-place TOS = TOS1 @ TOS.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +INPLACE_FLOOR_DIVIDE
    +

    Implements in-place TOS = TOS1 // TOS.

    +
    + +
    +
    +INPLACE_TRUE_DIVIDE
    +

    Implements in-place TOS = TOS1 / TOS.

    +
    + +
    +
    +INPLACE_MODULO
    +

    Implements in-place TOS = TOS1 % TOS.

    +
    + +
    +
    +INPLACE_ADD
    +

    Implements in-place TOS = TOS1 + TOS.

    +
    + +
    +
    +INPLACE_SUBTRACT
    +

    Implements in-place TOS = TOS1 - TOS.

    +
    + +
    +
    +INPLACE_LSHIFT
    +

    Implements in-place TOS = TOS1 << TOS.

    +
    + +
    +
    +INPLACE_RSHIFT
    +

    Implements in-place TOS = TOS1 >> TOS.

    +
    + +
    +
    +INPLACE_AND
    +

    Implements in-place TOS = TOS1 & TOS.

    +
    + +
    +
    +INPLACE_XOR
    +

    Implements in-place TOS = TOS1 ^ TOS.

    +
    + +
    +
    +INPLACE_OR
    +

    Implements in-place TOS = TOS1 | TOS.

    +
    + +
    +
    +STORE_SUBSCR
    +

    Implements TOS1[TOS] = TOS2.

    +
    + +
    +
    +DELETE_SUBSCR
    +

    Implements del TOS1[TOS].

    +
    + +

    Coroutine opcodes

    +
    +
    +GET_AWAITABLE
    +

    Implements TOS = get_awaitable(TOS), where get_awaitable(o) +returns o if o is a coroutine object or a generator object with +the CO_ITERABLE_COROUTINE flag, or resolves +o.__await__.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +GET_AITER
    +

    Implements TOS = TOS.__aiter__().

    +
    +

    New in version 3.5.

    +
    +
    +

    Changed in version 3.7: Returning awaitable objects from __aiter__ is no longer +supported.

    +
    +
    + +
    +
    +GET_ANEXT
    +

    Implements PUSH(get_awaitable(TOS.__anext__())). See GET_AWAITABLE +for details about get_awaitable

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +BEFORE_ASYNC_WITH
    +

    Resolves __aenter__ and __aexit__ from the object on top of the +stack. Pushes __aexit__ and result of __aenter__() to the stack.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +SETUP_ASYNC_WITH
    +

    Creates a new frame object.

    +
    +

    New in version 3.5.

    +
    +
    + +

    Miscellaneous opcodes

    +
    +
    +PRINT_EXPR
    +

    Implements the expression statement for the interactive mode. TOS is removed +from the stack and printed. In non-interactive mode, an expression statement +is terminated with POP_TOP.

    +
    + +
    +
    +BREAK_LOOP
    +

    Terminates a loop due to a break statement.

    +
    + +
    +
    +CONTINUE_LOOP(target)
    +

    Continues a loop due to a continue statement. target is the +address to jump to (which should be a FOR_ITER instruction).

    +
    + +
    +
    +SET_ADD(i)
    +

    Calls set.add(TOS1[-i], TOS). Used to implement set comprehensions.

    +
    + +
    +
    +LIST_APPEND(i)
    +

    Calls list.append(TOS[-i], TOS). Used to implement list comprehensions.

    +
    + +
    +
    +MAP_ADD(i)
    +

    Calls dict.setitem(TOS1[-i], TOS, TOS1). Used to implement dict +comprehensions.

    +
    +

    New in version 3.1.

    +
    +
    + +

    For all of the SET_ADD, LIST_APPEND and MAP_ADD +instructions, while the added value or key/value pair is popped off, the +container object remains on the stack so that it is available for further +iterations of the loop.

    +
    +
    +RETURN_VALUE
    +

    Returns with TOS to the caller of the function.

    +
    + +
    +
    +YIELD_VALUE
    +

    Pops TOS and yields it from a generator.

    +
    + +
    +
    +YIELD_FROM
    +

    Pops TOS and delegates to it as a subiterator from a generator.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +SETUP_ANNOTATIONS
    +

    Checks whether __annotations__ is defined in locals(), if not it is +set up to an empty dict. This opcode is only emitted if a class +or module body contains variable annotations +statically.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +IMPORT_STAR
    +

    Loads all symbols not starting with '_' directly from the module TOS to +the local namespace. The module is popped after loading all names. This +opcode implements from module import *.

    +
    + +
    +
    +POP_BLOCK
    +

    Removes one block from the block stack. Per frame, there is a stack of +blocks, denoting nested loops, try statements, and such.

    +
    + +
    +
    +POP_EXCEPT
    +

    Removes one block from the block stack. The popped block must be an exception +handler block, as implicitly created when entering an except handler. In +addition to popping extraneous values from the frame stack, the last three +popped values are used to restore the exception state.

    +
    + +
    +
    +END_FINALLY
    +

    Terminates a finally clause. The interpreter recalls whether the +exception has to be re-raised, or whether the function returns, and continues +with the outer-next block.

    +
    + +
    +
    +LOAD_BUILD_CLASS
    +

    Pushes builtins.__build_class__() onto the stack. It is later called +by CALL_FUNCTION to construct a class.

    +
    + +
    +
    +SETUP_WITH(delta)
    +

    This opcode performs several operations before a with block starts. First, +it loads __exit__() from the context manager and pushes it onto +the stack for later use by WITH_CLEANUP. Then, +__enter__() is called, and a finally block pointing to delta +is pushed. Finally, the result of calling the enter method is pushed onto +the stack. The next opcode will either ignore it (POP_TOP), or +store it in (a) variable(s) (STORE_FAST, STORE_NAME, or +UNPACK_SEQUENCE).

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +WITH_CLEANUP_START
    +

    Cleans up the stack when a with statement block exits. TOS is the +context manager’s __exit__() bound method. Below TOS are 1–3 values +indicating how/why the finally clause was entered:

    +
      +
    • SECOND = None

    • +
    • (SECOND, THIRD) = (WHY_{RETURN,CONTINUE}), retval

    • +
    • SECOND = WHY_*; no retval below it

    • +
    • (SECOND, THIRD, FOURTH) = exc_info()

    • +
    +

    In the last case, TOS(SECOND, THIRD, FOURTH) is called, otherwise +TOS(None, None, None). Pushes SECOND and result of the call +to the stack.

    +
    + +
    +
    +WITH_CLEANUP_FINISH
    +

    Pops exception type and result of ‘exit’ function call from the stack.

    +

    If the stack represents an exception, and the function call returns a +‘true’ value, this information is “zapped” and replaced with a single +WHY_SILENCED to prevent END_FINALLY from re-raising the +exception. (But non-local gotos will still be resumed.)

    +
    + +

    All of the following opcodes use their arguments.

    +
    +
    +STORE_NAME(namei)
    +

    Implements name = TOS. namei is the index of name in the attribute +co_names of the code object. The compiler tries to use +STORE_FAST or STORE_GLOBAL if possible.

    +
    + +
    +
    +DELETE_NAME(namei)
    +

    Implements del name, where namei is the index into co_names +attribute of the code object.

    +
    + +
    +
    +UNPACK_SEQUENCE(count)
    +

    Unpacks TOS into count individual values, which are put onto the stack +right-to-left.

    +
    + +
    +
    +UNPACK_EX(counts)
    +

    Implements assignment with a starred target: Unpacks an iterable in TOS into +individual values, where the total number of values can be smaller than the +number of items in the iterable: one of the new values will be a list of all +leftover items.

    +

    The low byte of counts is the number of values before the list value, the +high byte of counts the number of values after it. The resulting values +are put onto the stack right-to-left.

    +
    + +
    +
    +STORE_ATTR(namei)
    +

    Implements TOS.name = TOS1, where namei is the index of name in +co_names.

    +
    + +
    +
    +DELETE_ATTR(namei)
    +

    Implements del TOS.name, using namei as index into co_names.

    +
    + +
    +
    +STORE_GLOBAL(namei)
    +

    Works as STORE_NAME, but stores the name as a global.

    +
    + +
    +
    +DELETE_GLOBAL(namei)
    +

    Works as DELETE_NAME, but deletes a global name.

    +
    + +
    +
    +LOAD_CONST(consti)
    +

    Pushes co_consts[consti] onto the stack.

    +
    + +
    +
    +LOAD_NAME(namei)
    +

    Pushes the value associated with co_names[namei] onto the stack.

    +
    + +
    +
    +BUILD_TUPLE(count)
    +

    Creates a tuple consuming count items from the stack, and pushes the +resulting tuple onto the stack.

    +
    + +
    +
    +BUILD_LIST(count)
    +

    Works as BUILD_TUPLE, but creates a list.

    +
    + +
    +
    +BUILD_SET(count)
    +

    Works as BUILD_TUPLE, but creates a set.

    +
    + +
    +
    +BUILD_MAP(count)
    +

    Pushes a new dictionary object onto the stack. Pops 2 * count items +so that the dictionary holds count entries: +{..., TOS3: TOS2, TOS1: TOS}.

    +
    +

    Changed in version 3.5: The dictionary is created from stack items instead of creating an +empty dictionary pre-sized to hold count items.

    +
    +
    + +
    +
    +BUILD_CONST_KEY_MAP(count)
    +

    The version of BUILD_MAP specialized for constant keys. count +values are consumed from the stack. The top element on the stack contains +a tuple of keys.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +BUILD_STRING(count)
    +

    Concatenates count strings from the stack and pushes the resulting string +onto the stack.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +BUILD_TUPLE_UNPACK(count)
    +

    Pops count iterables from the stack, joins them in a single tuple, +and pushes the result. Implements iterable unpacking in tuple +displays (*x, *y, *z).

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +BUILD_TUPLE_UNPACK_WITH_CALL(count)
    +

    This is similar to BUILD_TUPLE_UNPACK, +but is used for f(*x, *y, *z) call syntax. The stack item at position +count + 1 should be the corresponding callable f.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +BUILD_LIST_UNPACK(count)
    +

    This is similar to BUILD_TUPLE_UNPACK, but pushes a list +instead of tuple. Implements iterable unpacking in list +displays [*x, *y, *z].

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +BUILD_SET_UNPACK(count)
    +

    This is similar to BUILD_TUPLE_UNPACK, but pushes a set +instead of tuple. Implements iterable unpacking in set +displays {*x, *y, *z}.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +BUILD_MAP_UNPACK(count)
    +

    Pops count mappings from the stack, merges them into a single dictionary, +and pushes the result. Implements dictionary unpacking in dictionary +displays {**x, **y, **z}.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +BUILD_MAP_UNPACK_WITH_CALL(count)
    +

    This is similar to BUILD_MAP_UNPACK, +but is used for f(**x, **y, **z) call syntax. The stack item at +position count + 2 should be the corresponding callable f.

    +
    +

    New in version 3.5.

    +
    +
    +

    Changed in version 3.6: The position of the callable is determined by adding 2 to the opcode +argument instead of encoding it in the second byte of the argument.

    +
    +
    + +
    +
    +LOAD_ATTR(namei)
    +

    Replaces TOS with getattr(TOS, co_names[namei]).

    +
    + +
    +
    +COMPARE_OP(opname)
    +

    Performs a Boolean operation. The operation name can be found in +cmp_op[opname].

    +
    + +
    +
    +IMPORT_NAME(namei)
    +

    Imports the module co_names[namei]. TOS and TOS1 are popped and provide +the fromlist and level arguments of __import__(). The module +object is pushed onto the stack. The current namespace is not affected: for +a proper import statement, a subsequent STORE_FAST instruction +modifies the namespace.

    +
    + +
    +
    +IMPORT_FROM(namei)
    +

    Loads the attribute co_names[namei] from the module found in TOS. The +resulting object is pushed onto the stack, to be subsequently stored by a +STORE_FAST instruction.

    +
    + +
    +
    +JUMP_FORWARD(delta)
    +

    Increments bytecode counter by delta.

    +
    + +
    +
    +POP_JUMP_IF_TRUE(target)
    +

    If TOS is true, sets the bytecode counter to target. TOS is popped.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +POP_JUMP_IF_FALSE(target)
    +

    If TOS is false, sets the bytecode counter to target. TOS is popped.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +JUMP_IF_TRUE_OR_POP(target)
    +

    If TOS is true, sets the bytecode counter to target and leaves TOS on the +stack. Otherwise (TOS is false), TOS is popped.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +JUMP_IF_FALSE_OR_POP(target)
    +

    If TOS is false, sets the bytecode counter to target and leaves TOS on the +stack. Otherwise (TOS is true), TOS is popped.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +JUMP_ABSOLUTE(target)
    +

    Set bytecode counter to target.

    +
    + +
    +
    +FOR_ITER(delta)
    +

    TOS is an iterator. Call its __next__() method. If +this yields a new value, push it on the stack (leaving the iterator below +it). If the iterator indicates it is exhausted TOS is popped, and the byte +code counter is incremented by delta.

    +
    + +
    +
    +LOAD_GLOBAL(namei)
    +

    Loads the global named co_names[namei] onto the stack.

    +
    + +
    +
    +SETUP_LOOP(delta)
    +

    Pushes a block for a loop onto the block stack. The block spans from the +current instruction with a size of delta bytes.

    +
    + +
    +
    +SETUP_EXCEPT(delta)
    +

    Pushes a try block from a try-except clause onto the block stack. delta +points to the first except block.

    +
    + +
    +
    +SETUP_FINALLY(delta)
    +

    Pushes a try block from a try-except clause onto the block stack. delta +points to the finally block.

    +
    + +
    +
    +LOAD_FAST(var_num)
    +

    Pushes a reference to the local co_varnames[var_num] onto the stack.

    +
    + +
    +
    +STORE_FAST(var_num)
    +

    Stores TOS into the local co_varnames[var_num].

    +
    + +
    +
    +DELETE_FAST(var_num)
    +

    Deletes local co_varnames[var_num].

    +
    + +
    +
    +LOAD_CLOSURE(i)
    +

    Pushes a reference to the cell contained in slot i of the cell and free +variable storage. The name of the variable is co_cellvars[i] if i is +less than the length of co_cellvars. Otherwise it is co_freevars[i - +len(co_cellvars)].

    +
    + +
    +
    +LOAD_DEREF(i)
    +

    Loads the cell contained in slot i of the cell and free variable storage. +Pushes a reference to the object the cell contains on the stack.

    +
    + +
    +
    +LOAD_CLASSDEREF(i)
    +

    Much like LOAD_DEREF but first checks the locals dictionary before +consulting the cell. This is used for loading free variables in class +bodies.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +STORE_DEREF(i)
    +

    Stores TOS into the cell contained in slot i of the cell and free variable +storage.

    +
    + +
    +
    +DELETE_DEREF(i)
    +

    Empties the cell contained in slot i of the cell and free variable storage. +Used by the del statement.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +RAISE_VARARGS(argc)
    +

    Raises an exception using one of the 3 forms of the raise statement, +depending on the value of argc:

    +
      +
    • 0: raise (re-raise previous exception)

    • +
    • 1: raise TOS (raise exception instance or type at TOS)

    • +
    • 2: raise TOS1 from TOS (raise exception instance or type at TOS1 +with __cause__ set to TOS)

    • +
    +
    + +
    +
    +CALL_FUNCTION(argc)
    +

    Calls a callable object with positional arguments. +argc indicates the number of positional arguments. +The top of the stack contains positional arguments, with the right-most +argument on top. Below the arguments is a callable object to call. +CALL_FUNCTION pops all arguments and the callable object off the stack, +calls the callable object with those arguments, and pushes the return value +returned by the callable object.

    +
    +

    Changed in version 3.6: This opcode is used only for calls with positional arguments.

    +
    +
    + +
    +
    +CALL_FUNCTION_KW(argc)
    +

    Calls a callable object with positional (if any) and keyword arguments. +argc indicates the total number of positional and keyword arguments. +The top element on the stack contains a tuple of keyword argument names. +Below that are keyword arguments in the order corresponding to the tuple. +Below that are positional arguments, with the right-most parameter on +top. Below the arguments is a callable object to call. +CALL_FUNCTION_KW pops all arguments and the callable object off the stack, +calls the callable object with those arguments, and pushes the return value +returned by the callable object.

    +
    +

    Changed in version 3.6: Keyword arguments are packed in a tuple instead of a dictionary, +argc indicates the total number of arguments.

    +
    +
    + +
    +
    +CALL_FUNCTION_EX(flags)
    +

    Calls a callable object with variable set of positional and keyword +arguments. If the lowest bit of flags is set, the top of the stack +contains a mapping object containing additional keyword arguments. +Below that is an iterable object containing positional arguments and +a callable object to call. BUILD_MAP_UNPACK_WITH_CALL and +BUILD_TUPLE_UNPACK_WITH_CALL can be used for merging multiple +mapping objects and iterables containing arguments. +Before the callable is called, the mapping object and iterable object +are each “unpacked” and their contents passed in as keyword and +positional arguments respectively. +CALL_FUNCTION_EX pops all arguments and the callable object off the stack, +calls the callable object with those arguments, and pushes the return value +returned by the callable object.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +LOAD_METHOD(namei)
    +

    Loads a method named co_names[namei] from TOS object. TOS is popped and +method and TOS are pushed when interpreter can call unbound method directly. +TOS will be used as the first argument (self) by CALL_METHOD. +Otherwise, NULL and method is pushed (method is bound method or +something else).

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +CALL_METHOD(argc)
    +

    Calls a method. argc is number of positional arguments. +Keyword arguments are not supported. This opcode is designed to be used +with LOAD_METHOD. Positional arguments are on top of the stack. +Below them, two items described in LOAD_METHOD on the stack. +All of them are popped and return value is pushed.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +MAKE_FUNCTION(argc)
    +

    Pushes a new function object on the stack. From bottom to top, the consumed +stack must consist of values if the argument carries a specified flag value

    +
      +
    • 0x01 a tuple of default values for positional-only and +positional-or-keyword parameters in positional order

    • +
    • 0x02 a dictionary of keyword-only parameters’ default values

    • +
    • 0x04 an annotation dictionary

    • +
    • 0x08 a tuple containing cells for free variables, making a closure

    • +
    • the code associated with the function (at TOS1)

    • +
    • the qualified name of the function (at TOS)

    • +
    +
    + +
    +
    +BUILD_SLICE(argc)
    +

    Pushes a slice object on the stack. argc must be 2 or 3. If it is 2, +slice(TOS1, TOS) is pushed; if it is 3, slice(TOS2, TOS1, TOS) is +pushed. See the slice() built-in function for more information.

    +
    + +
    +
    +EXTENDED_ARG(ext)
    +

    Prefixes any opcode which has an argument too big to fit into the default one +byte. ext holds an additional byte which act as higher bits in the argument. +For each opcode, at most three prefixal EXTENDED_ARG are allowed, forming +an argument from two-byte to four-byte.

    +
    + +
    +
    +FORMAT_VALUE(flags)
    +

    Used for implementing formatted literal strings (f-strings). Pops +an optional fmt_spec from the stack, then a required value. +flags is interpreted as follows:

    +
      +
    • (flags & 0x03) == 0x00: value is formatted as-is.

    • +
    • (flags & 0x03) == 0x01: call str() on value before +formatting it.

    • +
    • (flags & 0x03) == 0x02: call repr() on value before +formatting it.

    • +
    • (flags & 0x03) == 0x03: call ascii() on value before +formatting it.

    • +
    • (flags & 0x04) == 0x04: pop fmt_spec from the stack and use +it, else use an empty fmt_spec.

    • +
    +

    Formatting is performed using PyObject_Format(). The +result is pushed on the stack.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +HAVE_ARGUMENT
    +

    This is not really an opcode. It identifies the dividing line between +opcodes which don’t use their argument and those that do +(< HAVE_ARGUMENT and >= HAVE_ARGUMENT, respectively).

    +
    +

    Changed in version 3.6: Now every instruction has an argument, but opcodes < HAVE_ARGUMENT +ignore it. Before, only opcodes >= HAVE_ARGUMENT had an argument.

    +
    +
    + +
    +
    +

    Opcode collections

    +

    These collections are provided for automatic introspection of bytecode +instructions:

    +
    +
    +dis.opname
    +

    Sequence of operation names, indexable using the bytecode.

    +
    + +
    +
    +dis.opmap
    +

    Dictionary mapping operation names to bytecodes.

    +
    + +
    +
    +dis.cmp_op
    +

    Sequence of all compare operation names.

    +
    + +
    +
    +dis.hasconst
    +

    Sequence of bytecodes that access a constant.

    +
    + +
    +
    +dis.hasfree
    +

    Sequence of bytecodes that access a free variable (note that ‘free’ in this +context refers to names in the current scope that are referenced by inner +scopes or names in outer scopes that are referenced from this scope. It does +not include references to global or builtin scopes).

    +
    + +
    +
    +dis.hasname
    +

    Sequence of bytecodes that access an attribute by name.

    +
    + +
    +
    +dis.hasjrel
    +

    Sequence of bytecodes that have a relative jump target.

    +
    + +
    +
    +dis.hasjabs
    +

    Sequence of bytecodes that have an absolute jump target.

    +
    + +
    +
    +dis.haslocal
    +

    Sequence of bytecodes that access a local variable.

    +
    + +
    +
    +dis.hascompare
    +

    Sequence of bytecodes of Boolean operations.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/distribution.html b/python-3.7.4-docs-html/library/distribution.html new file mode 100644 index 0000000..82e8135 --- /dev/null +++ b/python-3.7.4-docs-html/library/distribution.html @@ -0,0 +1,215 @@ + + + + + + + Software Packaging and Distribution — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/distutils.html b/python-3.7.4-docs-html/library/distutils.html new file mode 100644 index 0000000..e058a00 --- /dev/null +++ b/python-3.7.4-docs-html/library/distutils.html @@ -0,0 +1,216 @@ + + + + + + + distutils — Building and installing Python modules — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    distutils — Building and installing Python modules

    +
    +

    The distutils package provides support for building and installing +additional modules into a Python installation. The new modules may be either +100%-pure Python, or may be extension modules written in C, or may be +collections of Python packages which include modules coded in both Python and C.

    +

    Most Python users will not want to use this module directly, but instead +use the cross-version tools maintained by the Python Packaging Authority. In +particular, +setuptools is an +enhanced alternative to distutils that provides:

    +
      +
    • support for declaring project dependencies

    • +
    • additional mechanisms for configuring which files to include in source +releases (including plugins for integration with version control systems)

    • +
    • the ability to declare project “entry points”, which can be used as the +basis for application plugin systems

    • +
    • the ability to automatically generate Windows command line executables at +installation time rather than needing to prebuild them

    • +
    • consistent behaviour across all supported Python versions

    • +
    +

    The recommended pip installer runs all +setup.py scripts with setuptools, even if the script itself only +imports distutils. Refer to the +Python Packaging User Guide for more +information.

    +

    For the benefits of packaging tool authors and users seeking a deeper +understanding of the details of the current packaging and distribution +system, the legacy distutils based user documentation and API +reference remain available:

    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/doctest.html b/python-3.7.4-docs-html/library/doctest.html new file mode 100644 index 0000000..b29bafe --- /dev/null +++ b/python-3.7.4-docs-html/library/doctest.html @@ -0,0 +1,1890 @@ + + + + + + + doctest — Test interactive Python examples — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    doctest — Test interactive Python examples

    +

    Source code: Lib/doctest.py

    +
    +

    The doctest module searches for pieces of text that look like interactive +Python sessions, and then executes those sessions to verify that they work +exactly as shown. There are several common ways to use doctest:

    +
      +
    • To check that a module’s docstrings are up-to-date by verifying that all +interactive examples still work as documented.

    • +
    • To perform regression testing by verifying that interactive examples from a +test file or a test object work as expected.

    • +
    • To write tutorial documentation for a package, liberally illustrated with +input-output examples. Depending on whether the examples or the expository text +are emphasized, this has the flavor of “literate testing” or “executable +documentation”.

    • +
    +

    Here’s a complete but small example module:

    +
    """
    +This is the "example" module.
    +
    +The example module supplies one function, factorial().  For example,
    +
    +>>> factorial(5)
    +120
    +"""
    +
    +def factorial(n):
    +    """Return the factorial of n, an exact integer >= 0.
    +
    +    >>> [factorial(n) for n in range(6)]
    +    [1, 1, 2, 6, 24, 120]
    +    >>> factorial(30)
    +    265252859812191058636308480000000
    +    >>> factorial(-1)
    +    Traceback (most recent call last):
    +        ...
    +    ValueError: n must be >= 0
    +
    +    Factorials of floats are OK, but the float must be an exact integer:
    +    >>> factorial(30.1)
    +    Traceback (most recent call last):
    +        ...
    +    ValueError: n must be exact integer
    +    >>> factorial(30.0)
    +    265252859812191058636308480000000
    +
    +    It must also not be ridiculously large:
    +    >>> factorial(1e100)
    +    Traceback (most recent call last):
    +        ...
    +    OverflowError: n too large
    +    """
    +
    +    import math
    +    if not n >= 0:
    +        raise ValueError("n must be >= 0")
    +    if math.floor(n) != n:
    +        raise ValueError("n must be exact integer")
    +    if n+1 == n:  # catch a value like 1e300
    +        raise OverflowError("n too large")
    +    result = 1
    +    factor = 2
    +    while factor <= n:
    +        result *= factor
    +        factor += 1
    +    return result
    +
    +
    +if __name__ == "__main__":
    +    import doctest
    +    doctest.testmod()
    +
    +
    +

    If you run example.py directly from the command line, doctest +works its magic:

    +
    $ python example.py
    +$
    +
    +
    +

    There’s no output! That’s normal, and it means all the examples worked. Pass +-v to the script, and doctest prints a detailed log of what +it’s trying, and prints a summary at the end:

    +
    $ python example.py -v
    +Trying:
    +    factorial(5)
    +Expecting:
    +    120
    +ok
    +Trying:
    +    [factorial(n) for n in range(6)]
    +Expecting:
    +    [1, 1, 2, 6, 24, 120]
    +ok
    +
    +
    +

    And so on, eventually ending with:

    +
    Trying:
    +    factorial(1e100)
    +Expecting:
    +    Traceback (most recent call last):
    +        ...
    +    OverflowError: n too large
    +ok
    +2 items passed all tests:
    +   1 tests in __main__
    +   8 tests in __main__.factorial
    +9 tests in 2 items.
    +9 passed and 0 failed.
    +Test passed.
    +$
    +
    +
    +

    That’s all you need to know to start making productive use of doctest! +Jump in. The following sections provide full details. Note that there are many +examples of doctests in the standard Python test suite and libraries. +Especially useful examples can be found in the standard test file +Lib/test/test_doctest.py.

    +
    +

    Simple Usage: Checking Examples in Docstrings

    +

    The simplest way to start using doctest (but not necessarily the way you’ll +continue to do it) is to end each module M with:

    +
    if __name__ == "__main__":
    +    import doctest
    +    doctest.testmod()
    +
    +
    +

    doctest then examines docstrings in module M.

    +

    Running the module as a script causes the examples in the docstrings to get +executed and verified:

    +
    python M.py
    +
    +
    +

    This won’t display anything unless an example fails, in which case the failing +example(s) and the cause(s) of the failure(s) are printed to stdout, and the +final line of output is ***Test Failed*** N failures., where N is the +number of examples that failed.

    +

    Run it with the -v switch instead:

    +
    python M.py -v
    +
    +
    +

    and a detailed report of all examples tried is printed to standard output, along +with assorted summaries at the end.

    +

    You can force verbose mode by passing verbose=True to testmod(), or +prohibit it by passing verbose=False. In either of those cases, +sys.argv is not examined by testmod() (so passing -v or not +has no effect).

    +

    There is also a command line shortcut for running testmod(). You can +instruct the Python interpreter to run the doctest module directly from the +standard library and pass the module name(s) on the command line:

    +
    python -m doctest -v example.py
    +
    +
    +

    This will import example.py as a standalone module and run +testmod() on it. Note that this may not work correctly if the file is +part of a package and imports other submodules from that package.

    +

    For more information on testmod(), see section Basic API.

    +
    +
    +

    Simple Usage: Checking Examples in a Text File

    +

    Another simple application of doctest is testing interactive examples in a text +file. This can be done with the testfile() function:

    +
    import doctest
    +doctest.testfile("example.txt")
    +
    +
    +

    That short script executes and verifies any interactive Python examples +contained in the file example.txt. The file content is treated as if it +were a single giant docstring; the file doesn’t need to contain a Python +program! For example, perhaps example.txt contains this:

    +
    The ``example`` module
    +======================
    +
    +Using ``factorial``
    +-------------------
    +
    +This is an example text file in reStructuredText format.  First import
    +``factorial`` from the ``example`` module:
    +
    +    >>> from example import factorial
    +
    +Now use it:
    +
    +    >>> factorial(6)
    +    120
    +
    +
    +

    Running doctest.testfile("example.txt") then finds the error in this +documentation:

    +
    File "./example.txt", line 14, in example.txt
    +Failed example:
    +    factorial(6)
    +Expected:
    +    120
    +Got:
    +    720
    +
    +
    +

    As with testmod(), testfile() won’t display anything unless an +example fails. If an example does fail, then the failing example(s) and the +cause(s) of the failure(s) are printed to stdout, using the same format as +testmod().

    +

    By default, testfile() looks for files in the calling module’s directory. +See section Basic API for a description of the optional arguments +that can be used to tell it to look for files in other locations.

    +

    Like testmod(), testfile()’s verbosity can be set with the +-v command-line switch or with the optional keyword argument +verbose.

    +

    There is also a command line shortcut for running testfile(). You can +instruct the Python interpreter to run the doctest module directly from the +standard library and pass the file name(s) on the command line:

    +
    python -m doctest -v example.txt
    +
    +
    +

    Because the file name does not end with .py, doctest infers that +it must be run with testfile(), not testmod().

    +

    For more information on testfile(), see section Basic API.

    +
    +
    +

    How It Works

    +

    This section examines in detail how doctest works: which docstrings it looks at, +how it finds interactive examples, what execution context it uses, how it +handles exceptions, and how option flags can be used to control its behavior. +This is the information that you need to know to write doctest examples; for +information about actually running doctest on these examples, see the following +sections.

    +
    +

    Which Docstrings Are Examined?

    +

    The module docstring, and all function, class and method docstrings are +searched. Objects imported into the module are not searched.

    +

    In addition, if M.__test__ exists and “is true”, it must be a dict, and each +entry maps a (string) name to a function object, class object, or string. +Function and class object docstrings found from M.__test__ are searched, and +strings are treated as if they were docstrings. In output, a key K in +M.__test__ appears with name

    +
    <name of M>.__test__.K
    +
    +
    +

    Any classes found are recursively searched similarly, to test docstrings in +their contained methods and nested classes.

    +
    +

    CPython implementation detail: Prior to version 3.4, extension modules written in C were not fully +searched by doctest.

    +
    +
    +
    +

    How are Docstring Examples Recognized?

    +

    In most cases a copy-and-paste of an interactive console session works fine, +but doctest isn’t trying to do an exact emulation of any specific Python shell.

    +
    >>> # comments are ignored
    +>>> x = 12
    +>>> x
    +12
    +>>> if x == 13:
    +...     print("yes")
    +... else:
    +...     print("no")
    +...     print("NO")
    +...     print("NO!!!")
    +...
    +no
    +NO
    +NO!!!
    +>>>
    +
    +
    +

    Any expected output must immediately follow the final '>>> ' or '... ' +line containing the code, and the expected output (if any) extends to the next +'>>> ' or all-whitespace line.

    +

    The fine print:

    +
      +
    • Expected output cannot contain an all-whitespace line, since such a line is +taken to signal the end of expected output. If expected output does contain a +blank line, put <BLANKLINE> in your doctest example each place a blank line +is expected.

    • +
    • All hard tab characters are expanded to spaces, using 8-column tab stops. +Tabs in output generated by the tested code are not modified. Because any +hard tabs in the sample output are expanded, this means that if the code +output includes hard tabs, the only way the doctest can pass is if the +NORMALIZE_WHITESPACE option or directive +is in effect. +Alternatively, the test can be rewritten to capture the output and compare it +to an expected value as part of the test. This handling of tabs in the +source was arrived at through trial and error, and has proven to be the least +error prone way of handling them. It is possible to use a different +algorithm for handling tabs by writing a custom DocTestParser class.

    • +
    • Output to stdout is captured, but not output to stderr (exception tracebacks +are captured via a different means).

    • +
    • If you continue a line via backslashing in an interactive session, or for any +other reason use a backslash, you should use a raw docstring, which will +preserve your backslashes exactly as you type them:

      +
      >>> def f(x):
      +...     r'''Backslashes in a raw docstring: m\n'''
      +>>> print(f.__doc__)
      +Backslashes in a raw docstring: m\n
      +
      +
      +

      Otherwise, the backslash will be interpreted as part of the string. For example, +the \n above would be interpreted as a newline character. Alternatively, you +can double each backslash in the doctest version (and not use a raw string):

      +
      >>> def f(x):
      +...     '''Backslashes in a raw docstring: m\\n'''
      +>>> print(f.__doc__)
      +Backslashes in a raw docstring: m\n
      +
      +
      +
    • +
    • The starting column doesn’t matter:

      +
      >>> assert "Easy!"
      +      >>> import math
      +          >>> math.floor(1.9)
      +          1
      +
      +
      +

      and as many leading whitespace characters are stripped from the expected output +as appeared in the initial '>>> ' line that started the example.

      +
    • +
    +
    +
    +

    What’s the Execution Context?

    +

    By default, each time doctest finds a docstring to test, it uses a +shallow copy of M’s globals, so that running tests doesn’t change the +module’s real globals, and so that one test in M can’t leave behind +crumbs that accidentally allow another test to work. This means examples can +freely use any names defined at top-level in M, and names defined earlier +in the docstring being run. Examples cannot see names defined in other +docstrings.

    +

    You can force use of your own dict as the execution context by passing +globs=your_dict to testmod() or testfile() instead.

    +
    +
    +

    What About Exceptions?

    +

    No problem, provided that the traceback is the only output produced by the +example: just paste in the traceback. 1 Since tracebacks contain details +that are likely to change rapidly (for example, exact file paths and line +numbers), this is one case where doctest works hard to be flexible in what it +accepts.

    +

    Simple example:

    +
    >>> [1, 2, 3].remove(42)
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +ValueError: list.remove(x): x not in list
    +
    +
    +

    That doctest succeeds if ValueError is raised, with the list.remove(x): +x not in list detail as shown.

    +

    The expected output for an exception must start with a traceback header, which +may be either of the following two lines, indented the same as the first line of +the example:

    +
    Traceback (most recent call last):
    +Traceback (innermost last):
    +
    +
    +

    The traceback header is followed by an optional traceback stack, whose contents +are ignored by doctest. The traceback stack is typically omitted, or copied +verbatim from an interactive session.

    +

    The traceback stack is followed by the most interesting part: the line(s) +containing the exception type and detail. This is usually the last line of a +traceback, but can extend across multiple lines if the exception has a +multi-line detail:

    +
    >>> raise ValueError('multi\n    line\ndetail')
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +ValueError: multi
    +    line
    +detail
    +
    +
    +

    The last three lines (starting with ValueError) are compared against the +exception’s type and detail, and the rest are ignored.

    +

    Best practice is to omit the traceback stack, unless it adds significant +documentation value to the example. So the last example is probably better as:

    +
    >>> raise ValueError('multi\n    line\ndetail')
    +Traceback (most recent call last):
    +    ...
    +ValueError: multi
    +    line
    +detail
    +
    +
    +

    Note that tracebacks are treated very specially. In particular, in the +rewritten example, the use of ... is independent of doctest’s +ELLIPSIS option. The ellipsis in that example could be left out, or +could just as well be three (or three hundred) commas or digits, or an indented +transcript of a Monty Python skit.

    +

    Some details you should read once, but won’t need to remember:

    +
      +
    • Doctest can’t guess whether your expected output came from an exception +traceback or from ordinary printing. So, e.g., an example that expects +ValueError: 42 is prime will pass whether ValueError is actually +raised or if the example merely prints that traceback text. In practice, +ordinary output rarely begins with a traceback header line, so this doesn’t +create real problems.

    • +
    • Each line of the traceback stack (if present) must be indented further than +the first line of the example, or start with a non-alphanumeric character. +The first line following the traceback header indented the same and starting +with an alphanumeric is taken to be the start of the exception detail. Of +course this does the right thing for genuine tracebacks.

    • +
    • When the IGNORE_EXCEPTION_DETAIL doctest option is specified, +everything following the leftmost colon and any module information in the +exception name is ignored.

    • +
    • The interactive shell omits the traceback header line for some +SyntaxErrors. But doctest uses the traceback header line to +distinguish exceptions from non-exceptions. So in the rare case where you need +to test a SyntaxError that omits the traceback header, you will need to +manually add the traceback header line to your test example.

    • +
    +
      +
    • For some SyntaxErrors, Python displays the character position of the +syntax error, using a ^ marker:

      +
      >>> 1 1
      +  File "<stdin>", line 1
      +    1 1
      +      ^
      +SyntaxError: invalid syntax
      +
      +
      +

      Since the lines showing the position of the error come before the exception type +and detail, they are not checked by doctest. For example, the following test +would pass, even though it puts the ^ marker in the wrong location:

      +
      >>> 1 1
      +  File "<stdin>", line 1
      +    1 1
      +    ^
      +SyntaxError: invalid syntax
      +
      +
      +
    • +
    +
    +
    +

    Option Flags

    +

    A number of option flags control various aspects of doctest’s behavior. +Symbolic names for the flags are supplied as module constants, which can be +bitwise ORed together and passed to various functions. +The names can also be used in doctest directives, +and may be passed to the doctest command line interface via the -o option.

    +
    +

    New in version 3.4: The -o command line option.

    +
    +

    The first group of options define test semantics, controlling aspects of how +doctest decides whether actual output matches an example’s expected output:

    +
    +
    +doctest.DONT_ACCEPT_TRUE_FOR_1
    +

    By default, if an expected output block contains just 1, an actual output +block containing just 1 or just True is considered to be a match, and +similarly for 0 versus False. When DONT_ACCEPT_TRUE_FOR_1 is +specified, neither substitution is allowed. The default behavior caters to that +Python changed the return type of many functions from integer to boolean; +doctests expecting “little integer” output still work in these cases. This +option will probably go away, but not for several years.

    +
    + +
    +
    +doctest.DONT_ACCEPT_BLANKLINE
    +

    By default, if an expected output block contains a line containing only the +string <BLANKLINE>, then that line will match a blank line in the actual +output. Because a genuinely blank line delimits the expected output, this is +the only way to communicate that a blank line is expected. When +DONT_ACCEPT_BLANKLINE is specified, this substitution is not allowed.

    +
    + +
    +
    +doctest.NORMALIZE_WHITESPACE
    +

    When specified, all sequences of whitespace (blanks and newlines) are treated as +equal. Any sequence of whitespace within the expected output will match any +sequence of whitespace within the actual output. By default, whitespace must +match exactly. NORMALIZE_WHITESPACE is especially useful when a line of +expected output is very long, and you want to wrap it across multiple lines in +your source.

    +
    + +
    +
    +doctest.ELLIPSIS
    +

    When specified, an ellipsis marker (...) in the expected output can match +any substring in the actual output. This includes substrings that span line +boundaries, and empty substrings, so it’s best to keep usage of this simple. +Complicated uses can lead to the same kinds of “oops, it matched too much!” +surprises that .* is prone to in regular expressions.

    +
    + +
    +
    +doctest.IGNORE_EXCEPTION_DETAIL
    +

    When specified, an example that expects an exception passes if an exception of +the expected type is raised, even if the exception detail does not match. For +example, an example expecting ValueError: 42 will pass if the actual +exception raised is ValueError: 3*14, but will fail, e.g., if +TypeError is raised.

    +

    It will also ignore the module name used in Python 3 doctest reports. Hence +both of these variations will work with the flag specified, regardless of +whether the test is run under Python 2.7 or Python 3.2 (or later versions):

    +
    >>> raise CustomError('message')
    +Traceback (most recent call last):
    +CustomError: message
    +
    +>>> raise CustomError('message')
    +Traceback (most recent call last):
    +my_module.CustomError: message
    +
    +
    +

    Note that ELLIPSIS can also be used to ignore the +details of the exception message, but such a test may still fail based +on whether or not the module details are printed as part of the +exception name. Using IGNORE_EXCEPTION_DETAIL and the details +from Python 2.3 is also the only clear way to write a doctest that doesn’t +care about the exception detail yet continues to pass under Python 2.3 or +earlier (those releases do not support doctest directives and ignore them as irrelevant comments). For example:

    +
    >>> (1, 2)[3] = 'moo'
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +TypeError: object doesn't support item assignment
    +
    +
    +

    passes under Python 2.3 and later Python versions with the flag specified, +even though the detail +changed in Python 2.4 to say “does not” instead of “doesn’t”.

    +
    +

    Changed in version 3.2: IGNORE_EXCEPTION_DETAIL now also ignores any information relating +to the module containing the exception under test.

    +
    +
    + +
    +
    +doctest.SKIP
    +

    When specified, do not run the example at all. This can be useful in contexts +where doctest examples serve as both documentation and test cases, and an +example should be included for documentation purposes, but should not be +checked. E.g., the example’s output might be random; or the example might +depend on resources which would be unavailable to the test driver.

    +

    The SKIP flag can also be used for temporarily “commenting out” examples.

    +
    + +
    +
    +doctest.COMPARISON_FLAGS
    +

    A bitmask or’ing together all the comparison flags above.

    +
    + +

    The second group of options controls how test failures are reported:

    +
    +
    +doctest.REPORT_UDIFF
    +

    When specified, failures that involve multi-line expected and actual outputs are +displayed using a unified diff.

    +
    + +
    +
    +doctest.REPORT_CDIFF
    +

    When specified, failures that involve multi-line expected and actual outputs +will be displayed using a context diff.

    +
    + +
    +
    +doctest.REPORT_NDIFF
    +

    When specified, differences are computed by difflib.Differ, using the same +algorithm as the popular ndiff.py utility. This is the only method that +marks differences within lines as well as across lines. For example, if a line +of expected output contains digit 1 where actual output contains letter +l, a line is inserted with a caret marking the mismatching column positions.

    +
    + +
    +
    +doctest.REPORT_ONLY_FIRST_FAILURE
    +

    When specified, display the first failing example in each doctest, but suppress +output for all remaining examples. This will prevent doctest from reporting +correct examples that break because of earlier failures; but it might also hide +incorrect examples that fail independently of the first failure. When +REPORT_ONLY_FIRST_FAILURE is specified, the remaining examples are +still run, and still count towards the total number of failures reported; only +the output is suppressed.

    +
    + +
    +
    +doctest.FAIL_FAST
    +

    When specified, exit after the first failing example and don’t attempt to run +the remaining examples. Thus, the number of failures reported will be at most +1. This flag may be useful during debugging, since examples after the first +failure won’t even produce debugging output.

    +

    The doctest command line accepts the option -f as a shorthand for -o +FAIL_FAST.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +doctest.REPORTING_FLAGS
    +

    A bitmask or’ing together all the reporting flags above.

    +
    + +

    There is also a way to register new option flag names, though this isn’t +useful unless you intend to extend doctest internals via subclassing:

    +
    +
    +doctest.register_optionflag(name)
    +

    Create a new option flag with a given name, and return the new flag’s integer +value. register_optionflag() can be used when subclassing +OutputChecker or DocTestRunner to create new options that are +supported by your subclasses. register_optionflag() should always be +called using the following idiom:

    +
    MY_FLAG = register_optionflag('MY_FLAG')
    +
    +
    +
    + +
    +
    +

    Directives

    +

    Doctest directives may be used to modify the option flags for an individual example. Doctest directives are +special Python comments following an example’s source code:

    +
    +directive             ::=  "#" "doctest:" directive_options
    +directive_options     ::=  directive_option ("," directive_option)\*
    +directive_option      ::=  on_or_off directive_option_name
    +on_or_off             ::=  "+" \| "-"
    +directive_option_name ::=  "DONT_ACCEPT_BLANKLINE" \| "NORMALIZE_WHITESPACE" \| ...
    +
    +

    Whitespace is not allowed between the + or - and the directive option +name. The directive option name can be any of the option flag names explained +above.

    +

    An example’s doctest directives modify doctest’s behavior for that single +example. Use + to enable the named behavior, or - to disable it.

    +

    For example, this test passes:

    +
    >>> print(list(range(20))) 
    +[0,   1,  2,  3,  4,  5,  6,  7,  8,  9,
    +10,  11, 12, 13, 14, 15, 16, 17, 18, 19]
    +
    +
    +

    Without the directive it would fail, both because the actual output doesn’t have +two blanks before the single-digit list elements, and because the actual output +is on a single line. This test also passes, and also requires a directive to do +so:

    +
    >>> print(list(range(20))) 
    +[0, 1, ..., 18, 19]
    +
    +
    +

    Multiple directives can be used on a single physical line, separated by +commas:

    +
    >>> print(list(range(20))) 
    +[0,    1, ...,   18,    19]
    +
    +
    +

    If multiple directive comments are used for a single example, then they are +combined:

    +
    >>> print(list(range(20))) 
    +...                        
    +[0,    1, ...,   18,    19]
    +
    +
    +

    As the previous example shows, you can add ... lines to your example +containing only directives. This can be useful when an example is too long for +a directive to comfortably fit on the same line:

    +
    >>> print(list(range(5)) + list(range(10, 20)) + list(range(30, 40)))
    +... 
    +[0, ..., 4, 10, ..., 19, 30, ..., 39]
    +
    +
    +

    Note that since all options are disabled by default, and directives apply only +to the example they appear in, enabling options (via + in a directive) is +usually the only meaningful choice. However, option flags can also be passed to +functions that run doctests, establishing different defaults. In such cases, +disabling an option via - in a directive can be useful.

    +
    +
    +

    Warnings

    +

    doctest is serious about requiring exact matches in expected output. If +even a single character doesn’t match, the test fails. This will probably +surprise you a few times, as you learn exactly what Python does and doesn’t +guarantee about output. For example, when printing a set, Python doesn’t +guarantee that the element is printed in any particular order, so a test like

    +
    >>> foo()
    +{"Hermione", "Harry"}
    +
    +
    +

    is vulnerable! One workaround is to do

    +
    >>> foo() == {"Hermione", "Harry"}
    +True
    +
    +
    +

    instead. Another is to do

    +
    >>> d = sorted(foo())
    +>>> d
    +['Harry', 'Hermione']
    +
    +
    +
    +

    Note

    +

    Before Python 3.6, when printing a dict, Python did not guarantee that +the key-value pairs was printed in any particular order.

    +
    +

    There are others, but you get the idea.

    +

    Another bad idea is to print things that embed an object address, like

    +
    >>> id(1.0) # certain to fail some of the time
    +7948648
    +>>> class C: pass
    +>>> C()   # the default repr() for instances embeds an address
    +<__main__.C instance at 0x00AC18F0>
    +
    +
    +

    The ELLIPSIS directive gives a nice approach for the last example:

    +
    >>> C() 
    +<__main__.C instance at 0x...>
    +
    +
    +

    Floating-point numbers are also subject to small output variations across +platforms, because Python defers to the platform C library for float formatting, +and C libraries vary widely in quality here.

    +
    >>> 1./7  # risky
    +0.14285714285714285
    +>>> print(1./7) # safer
    +0.142857142857
    +>>> print(round(1./7, 6)) # much safer
    +0.142857
    +
    +
    +

    Numbers of the form I/2.**J are safe across all platforms, and I often +contrive doctest examples to produce numbers of that form:

    +
    >>> 3./4  # utterly safe
    +0.75
    +
    +
    +

    Simple fractions are also easier for people to understand, and that makes for +better documentation.

    +
    +
    +
    +

    Basic API

    +

    The functions testmod() and testfile() provide a simple interface to +doctest that should be sufficient for most basic uses. For a less formal +introduction to these two functions, see sections Simple Usage: Checking Examples in Docstrings +and Simple Usage: Checking Examples in a Text File.

    +
    +
    +doctest.testfile(filename, module_relative=True, name=None, package=None, globs=None, verbose=None, report=True, optionflags=0, extraglobs=None, raise_on_error=False, parser=DocTestParser(), encoding=None)
    +

    All arguments except filename are optional, and should be specified in keyword +form.

    +

    Test examples in the file named filename. Return (failure_count, +test_count).

    +

    Optional argument module_relative specifies how the filename should be +interpreted:

    +
      +
    • If module_relative is True (the default), then filename specifies an +OS-independent module-relative path. By default, this path is relative to the +calling module’s directory; but if the package argument is specified, then it +is relative to that package. To ensure OS-independence, filename should use +/ characters to separate path segments, and may not be an absolute path +(i.e., it may not begin with /).

    • +
    • If module_relative is False, then filename specifies an OS-specific +path. The path may be absolute or relative; relative paths are resolved with +respect to the current working directory.

    • +
    +

    Optional argument name gives the name of the test; by default, or if None, +os.path.basename(filename) is used.

    +

    Optional argument package is a Python package or the name of a Python package +whose directory should be used as the base directory for a module-relative +filename. If no package is specified, then the calling module’s directory is +used as the base directory for module-relative filenames. It is an error to +specify package if module_relative is False.

    +

    Optional argument globs gives a dict to be used as the globals when executing +examples. A new shallow copy of this dict is created for the doctest, so its +examples start with a clean slate. By default, or if None, a new empty dict +is used.

    +

    Optional argument extraglobs gives a dict merged into the globals used to +execute examples. This works like dict.update(): if globs and +extraglobs have a common key, the associated value in extraglobs appears in +the combined dict. By default, or if None, no extra globals are used. This +is an advanced feature that allows parameterization of doctests. For example, a +doctest can be written for a base class, using a generic name for the class, +then reused to test any number of subclasses by passing an extraglobs dict +mapping the generic name to the subclass to be tested.

    +

    Optional argument verbose prints lots of stuff if true, and prints only +failures if false; by default, or if None, it’s true if and only if '-v' +is in sys.argv.

    +

    Optional argument report prints a summary at the end when true, else prints +nothing at the end. In verbose mode, the summary is detailed, else the summary +is very brief (in fact, empty if all tests passed).

    +

    Optional argument optionflags (default value 0) takes the +bitwise OR of option flags. +See section Option Flags.

    +

    Optional argument raise_on_error defaults to false. If true, an exception is +raised upon the first failure or unexpected exception in an example. This +allows failures to be post-mortem debugged. Default behavior is to continue +running examples.

    +

    Optional argument parser specifies a DocTestParser (or subclass) that +should be used to extract tests from the files. It defaults to a normal parser +(i.e., DocTestParser()).

    +

    Optional argument encoding specifies an encoding that should be used to +convert the file to unicode.

    +
    + +
    +
    +doctest.testmod(m=None, name=None, globs=None, verbose=None, report=True, optionflags=0, extraglobs=None, raise_on_error=False, exclude_empty=False)
    +

    All arguments are optional, and all except for m should be specified in +keyword form.

    +

    Test examples in docstrings in functions and classes reachable from module m +(or module __main__ if m is not supplied or is None), starting with +m.__doc__.

    +

    Also test examples reachable from dict m.__test__, if it exists and is not +None. m.__test__ maps names (strings) to functions, classes and +strings; function and class docstrings are searched for examples; strings are +searched directly, as if they were docstrings.

    +

    Only docstrings attached to objects belonging to module m are searched.

    +

    Return (failure_count, test_count).

    +

    Optional argument name gives the name of the module; by default, or if +None, m.__name__ is used.

    +

    Optional argument exclude_empty defaults to false. If true, objects for which +no doctests are found are excluded from consideration. The default is a backward +compatibility hack, so that code still using doctest.master.summarize() in +conjunction with testmod() continues to get output for objects with no +tests. The exclude_empty argument to the newer DocTestFinder +constructor defaults to true.

    +

    Optional arguments extraglobs, verbose, report, optionflags, +raise_on_error, and globs are the same as for function testfile() +above, except that globs defaults to m.__dict__.

    +
    + +
    +
    +doctest.run_docstring_examples(f, globs, verbose=False, name="NoName", compileflags=None, optionflags=0)
    +

    Test examples associated with object f; for example, f may be a string, +a module, a function, or a class object.

    +

    A shallow copy of dictionary argument globs is used for the execution context.

    +

    Optional argument name is used in failure messages, and defaults to +"NoName".

    +

    If optional argument verbose is true, output is generated even if there are no +failures. By default, output is generated only in case of an example failure.

    +

    Optional argument compileflags gives the set of flags that should be used by +the Python compiler when running the examples. By default, or if None, +flags are deduced corresponding to the set of future features found in globs.

    +

    Optional argument optionflags works as for function testfile() above.

    +
    + +
    +
    +

    Unittest API

    +

    As your collection of doctest’ed modules grows, you’ll want a way to run all +their doctests systematically. doctest provides two functions that can +be used to create unittest test suites from modules and text files +containing doctests. To integrate with unittest test discovery, include +a load_tests() function in your test module:

    +
    import unittest
    +import doctest
    +import my_module_with_doctests
    +
    +def load_tests(loader, tests, ignore):
    +    tests.addTests(doctest.DocTestSuite(my_module_with_doctests))
    +    return tests
    +
    +
    +

    There are two main functions for creating unittest.TestSuite instances +from text files and modules with doctests:

    +
    +
    +doctest.DocFileSuite(*paths, module_relative=True, package=None, setUp=None, tearDown=None, globs=None, optionflags=0, parser=DocTestParser(), encoding=None)
    +

    Convert doctest tests from one or more text files to a +unittest.TestSuite.

    +

    The returned unittest.TestSuite is to be run by the unittest framework +and runs the interactive examples in each file. If an example in any file +fails, then the synthesized unit test fails, and a failureException +exception is raised showing the name of the file containing the test and a +(sometimes approximate) line number.

    +

    Pass one or more paths (as strings) to text files to be examined.

    +

    Options may be provided as keyword arguments:

    +

    Optional argument module_relative specifies how the filenames in paths +should be interpreted:

    +
      +
    • If module_relative is True (the default), then each filename in +paths specifies an OS-independent module-relative path. By default, this +path is relative to the calling module’s directory; but if the package +argument is specified, then it is relative to that package. To ensure +OS-independence, each filename should use / characters to separate path +segments, and may not be an absolute path (i.e., it may not begin with +/).

    • +
    • If module_relative is False, then each filename in paths specifies +an OS-specific path. The path may be absolute or relative; relative paths +are resolved with respect to the current working directory.

    • +
    +

    Optional argument package is a Python package or the name of a Python +package whose directory should be used as the base directory for +module-relative filenames in paths. If no package is specified, then the +calling module’s directory is used as the base directory for module-relative +filenames. It is an error to specify package if module_relative is +False.

    +

    Optional argument setUp specifies a set-up function for the test suite. +This is called before running the tests in each file. The setUp function +will be passed a DocTest object. The setUp function can access the +test globals as the globs attribute of the test passed.

    +

    Optional argument tearDown specifies a tear-down function for the test +suite. This is called after running the tests in each file. The tearDown +function will be passed a DocTest object. The setUp function can +access the test globals as the globs attribute of the test passed.

    +

    Optional argument globs is a dictionary containing the initial global +variables for the tests. A new copy of this dictionary is created for each +test. By default, globs is a new empty dictionary.

    +

    Optional argument optionflags specifies the default doctest options for the +tests, created by or-ing together individual option flags. See section +Option Flags. See function set_unittest_reportflags() below +for a better way to set reporting options.

    +

    Optional argument parser specifies a DocTestParser (or subclass) +that should be used to extract tests from the files. It defaults to a normal +parser (i.e., DocTestParser()).

    +

    Optional argument encoding specifies an encoding that should be used to +convert the file to unicode.

    +

    The global __file__ is added to the globals provided to doctests loaded +from a text file using DocFileSuite().

    +
    + +
    +
    +doctest.DocTestSuite(module=None, globs=None, extraglobs=None, test_finder=None, setUp=None, tearDown=None, checker=None)
    +

    Convert doctest tests for a module to a unittest.TestSuite.

    +

    The returned unittest.TestSuite is to be run by the unittest framework +and runs each doctest in the module. If any of the doctests fail, then the +synthesized unit test fails, and a failureException exception is raised +showing the name of the file containing the test and a (sometimes approximate) +line number.

    +

    Optional argument module provides the module to be tested. It can be a module +object or a (possibly dotted) module name. If not specified, the module calling +this function is used.

    +

    Optional argument globs is a dictionary containing the initial global +variables for the tests. A new copy of this dictionary is created for each +test. By default, globs is a new empty dictionary.

    +

    Optional argument extraglobs specifies an extra set of global variables, which +is merged into globs. By default, no extra globals are used.

    +

    Optional argument test_finder is the DocTestFinder object (or a +drop-in replacement) that is used to extract doctests from the module.

    +

    Optional arguments setUp, tearDown, and optionflags are the same as for +function DocFileSuite() above.

    +

    This function uses the same search technique as testmod().

    +
    +

    Changed in version 3.5: DocTestSuite() returns an empty unittest.TestSuite if module +contains no docstrings instead of raising ValueError.

    +
    +
    + +

    Under the covers, DocTestSuite() creates a unittest.TestSuite out +of doctest.DocTestCase instances, and DocTestCase is a +subclass of unittest.TestCase. DocTestCase isn’t documented +here (it’s an internal detail), but studying its code can answer questions about +the exact details of unittest integration.

    +

    Similarly, DocFileSuite() creates a unittest.TestSuite out of +doctest.DocFileCase instances, and DocFileCase is a subclass +of DocTestCase.

    +

    So both ways of creating a unittest.TestSuite run instances of +DocTestCase. This is important for a subtle reason: when you run +doctest functions yourself, you can control the doctest options in +use directly, by passing option flags to doctest functions. However, if +you’re writing a unittest framework, unittest ultimately controls +when and how tests get run. The framework author typically wants to control +doctest reporting options (perhaps, e.g., specified by command line +options), but there’s no way to pass options through unittest to +doctest test runners.

    +

    For this reason, doctest also supports a notion of doctest +reporting flags specific to unittest support, via this function:

    +
    +
    +doctest.set_unittest_reportflags(flags)
    +

    Set the doctest reporting flags to use.

    +

    Argument flags takes the bitwise OR of option flags. See +section Option Flags. Only “reporting flags” can be used.

    +

    This is a module-global setting, and affects all future doctests run by module +unittest: the runTest() method of DocTestCase looks at +the option flags specified for the test case when the DocTestCase +instance was constructed. If no reporting flags were specified (which is the +typical and expected case), doctest’s unittest reporting flags are +bitwise ORed into the option flags, and the option flags +so augmented are passed to the DocTestRunner instance created to +run the doctest. If any reporting flags were specified when the +DocTestCase instance was constructed, doctest’s +unittest reporting flags are ignored.

    +

    The value of the unittest reporting flags in effect before the function +was called is returned by the function.

    +
    + +
    +
    +

    Advanced API

    +

    The basic API is a simple wrapper that’s intended to make doctest easy to use. +It is fairly flexible, and should meet most users’ needs; however, if you +require more fine-grained control over testing, or wish to extend doctest’s +capabilities, then you should use the advanced API.

    +

    The advanced API revolves around two container classes, which are used to store +the interactive examples extracted from doctest cases:

    +
      +
    • Example: A single Python statement, paired with its expected +output.

    • +
    • DocTest: A collection of Examples, typically extracted +from a single docstring or text file.

    • +
    +

    Additional processing classes are defined to find, parse, and run, and check +doctest examples:

    + +

    The relationships among these processing classes are summarized in the following +diagram:

    +
                                list of:
    ++------+                   +---------+
    +|module| --DocTestFinder-> | DocTest | --DocTestRunner-> results
    ++------+    |        ^     +---------+     |       ^    (printed)
    +            |        |     | Example |     |       |
    +            v        |     |   ...   |     v       |
    +           DocTestParser   | Example |   OutputChecker
    +                           +---------+
    +
    +
    +
    +

    DocTest Objects

    +
    +
    +class doctest.DocTest(examples, globs, name, filename, lineno, docstring)
    +

    A collection of doctest examples that should be run in a single namespace. The +constructor arguments are used to initialize the attributes of the same names.

    +

    DocTest defines the following attributes. They are initialized by +the constructor, and should not be modified directly.

    +
    +
    +examples
    +

    A list of Example objects encoding the individual interactive Python +examples that should be run by this test.

    +
    + +
    +
    +globs
    +

    The namespace (aka globals) that the examples should be run in. This is a +dictionary mapping names to values. Any changes to the namespace made by the +examples (such as binding new variables) will be reflected in globs +after the test is run.

    +
    + +
    +
    +name
    +

    A string name identifying the DocTest. Typically, this is the name +of the object or file that the test was extracted from.

    +
    + +
    +
    +filename
    +

    The name of the file that this DocTest was extracted from; or +None if the filename is unknown, or if the DocTest was not +extracted from a file.

    +
    + +
    +
    +lineno
    +

    The line number within filename where this DocTest begins, or +None if the line number is unavailable. This line number is zero-based +with respect to the beginning of the file.

    +
    + +
    +
    +docstring
    +

    The string that the test was extracted from, or None if the string is +unavailable, or if the test was not extracted from a string.

    +
    + +
    + +
    +
    +

    Example Objects

    +
    +
    +class doctest.Example(source, want, exc_msg=None, lineno=0, indent=0, options=None)
    +

    A single interactive example, consisting of a Python statement and its expected +output. The constructor arguments are used to initialize the attributes of +the same names.

    +

    Example defines the following attributes. They are initialized by +the constructor, and should not be modified directly.

    +
    +
    +source
    +

    A string containing the example’s source code. This source code consists of a +single Python statement, and always ends with a newline; the constructor adds +a newline when necessary.

    +
    + +
    +
    +want
    +

    The expected output from running the example’s source code (either from +stdout, or a traceback in case of exception). want ends with a +newline unless no output is expected, in which case it’s an empty string. The +constructor adds a newline when necessary.

    +
    + +
    +
    +exc_msg
    +

    The exception message generated by the example, if the example is expected to +generate an exception; or None if it is not expected to generate an +exception. This exception message is compared against the return value of +traceback.format_exception_only(). exc_msg ends with a newline +unless it’s None. The constructor adds a newline if needed.

    +
    + +
    +
    +lineno
    +

    The line number within the string containing this example where the example +begins. This line number is zero-based with respect to the beginning of the +containing string.

    +
    + +
    +
    +indent
    +

    The example’s indentation in the containing string, i.e., the number of space +characters that precede the example’s first prompt.

    +
    + +
    +
    +options
    +

    A dictionary mapping from option flags to True or False, which is used +to override default options for this example. Any option flags not contained +in this dictionary are left at their default value (as specified by the +DocTestRunner’s optionflags). By default, no options are set.

    +
    + +
    + +
    +
    +

    DocTestFinder objects

    +
    +
    +class doctest.DocTestFinder(verbose=False, parser=DocTestParser(), recurse=True, exclude_empty=True)
    +

    A processing class used to extract the DocTests that are relevant to +a given object, from its docstring and the docstrings of its contained objects. +DocTests can be extracted from modules, classes, functions, +methods, staticmethods, classmethods, and properties.

    +

    The optional argument verbose can be used to display the objects searched by +the finder. It defaults to False (no output).

    +

    The optional argument parser specifies the DocTestParser object (or a +drop-in replacement) that is used to extract doctests from docstrings.

    +

    If the optional argument recurse is false, then DocTestFinder.find() +will only examine the given object, and not any contained objects.

    +

    If the optional argument exclude_empty is false, then +DocTestFinder.find() will include tests for objects with empty docstrings.

    +

    DocTestFinder defines the following method:

    +
    +
    +find(obj[, name][, module][, globs][, extraglobs])
    +

    Return a list of the DocTests that are defined by obj’s +docstring, or by any of its contained objects’ docstrings.

    +

    The optional argument name specifies the object’s name; this name will be +used to construct names for the returned DocTests. If name is +not specified, then obj.__name__ is used.

    +

    The optional parameter module is the module that contains the given object. +If the module is not specified or is None, then the test finder will attempt +to automatically determine the correct module. The object’s module is used:

    +
      +
    • As a default namespace, if globs is not specified.

    • +
    • To prevent the DocTestFinder from extracting DocTests from objects that are +imported from other modules. (Contained objects with modules other than +module are ignored.)

    • +
    • To find the name of the file containing the object.

    • +
    • To help find the line number of the object within its file.

    • +
    +

    If module is False, no attempt to find the module will be made. This is +obscure, of use mostly in testing doctest itself: if module is False, or +is None but cannot be found automatically, then all objects are considered +to belong to the (non-existent) module, so all contained objects will +(recursively) be searched for doctests.

    +

    The globals for each DocTest is formed by combining globs and +extraglobs (bindings in extraglobs override bindings in globs). A new +shallow copy of the globals dictionary is created for each DocTest. +If globs is not specified, then it defaults to the module’s __dict__, if +specified, or {} otherwise. If extraglobs is not specified, then it +defaults to {}.

    +
    + +
    + +
    +
    +

    DocTestParser objects

    +
    +
    +class doctest.DocTestParser
    +

    A processing class used to extract interactive examples from a string, and use +them to create a DocTest object.

    +

    DocTestParser defines the following methods:

    +
    +
    +get_doctest(string, globs, name, filename, lineno)
    +

    Extract all doctest examples from the given string, and collect them into a +DocTest object.

    +

    globs, name, filename, and lineno are attributes for the new +DocTest object. See the documentation for DocTest for more +information.

    +
    + +
    +
    +get_examples(string, name='<string>')
    +

    Extract all doctest examples from the given string, and return them as a list +of Example objects. Line numbers are 0-based. The optional argument +name is a name identifying this string, and is only used for error messages.

    +
    + +
    +
    +parse(string, name='<string>')
    +

    Divide the given string into examples and intervening text, and return them as +a list of alternating Examples and strings. Line numbers for the +Examples are 0-based. The optional argument name is a name +identifying this string, and is only used for error messages.

    +
    + +
    + +
    +
    +

    DocTestRunner objects

    +
    +
    +class doctest.DocTestRunner(checker=None, verbose=None, optionflags=0)
    +

    A processing class used to execute and verify the interactive examples in a +DocTest.

    +

    The comparison between expected outputs and actual outputs is done by an +OutputChecker. This comparison may be customized with a number of +option flags; see section Option Flags for more information. If the +option flags are insufficient, then the comparison may also be customized by +passing a subclass of OutputChecker to the constructor.

    +

    The test runner’s display output can be controlled in two ways. First, an output +function can be passed to TestRunner.run(); this function will be called +with strings that should be displayed. It defaults to sys.stdout.write. If +capturing the output is not sufficient, then the display output can be also +customized by subclassing DocTestRunner, and overriding the methods +report_start(), report_success(), +report_unexpected_exception(), and report_failure().

    +

    The optional keyword argument checker specifies the OutputChecker +object (or drop-in replacement) that should be used to compare the expected +outputs to the actual outputs of doctest examples.

    +

    The optional keyword argument verbose controls the DocTestRunner’s +verbosity. If verbose is True, then information is printed about each +example, as it is run. If verbose is False, then only failures are +printed. If verbose is unspecified, or None, then verbose output is used +iff the command-line switch -v is used.

    +

    The optional keyword argument optionflags can be used to control how the test +runner compares expected output to actual output, and how it displays failures. +For more information, see section Option Flags.

    +

    DocTestParser defines the following methods:

    +
    +
    +report_start(out, test, example)
    +

    Report that the test runner is about to process the given example. This method +is provided to allow subclasses of DocTestRunner to customize their +output; it should not be called directly.

    +

    example is the example about to be processed. test is the test +containing example. out is the output function that was passed to +DocTestRunner.run().

    +
    + +
    +
    +report_success(out, test, example, got)
    +

    Report that the given example ran successfully. This method is provided to +allow subclasses of DocTestRunner to customize their output; it +should not be called directly.

    +

    example is the example about to be processed. got is the actual output +from the example. test is the test containing example. out is the +output function that was passed to DocTestRunner.run().

    +
    + +
    +
    +report_failure(out, test, example, got)
    +

    Report that the given example failed. This method is provided to allow +subclasses of DocTestRunner to customize their output; it should not +be called directly.

    +

    example is the example about to be processed. got is the actual output +from the example. test is the test containing example. out is the +output function that was passed to DocTestRunner.run().

    +
    + +
    +
    +report_unexpected_exception(out, test, example, exc_info)
    +

    Report that the given example raised an unexpected exception. This method is +provided to allow subclasses of DocTestRunner to customize their +output; it should not be called directly.

    +

    example is the example about to be processed. exc_info is a tuple +containing information about the unexpected exception (as returned by +sys.exc_info()). test is the test containing example. out is the +output function that was passed to DocTestRunner.run().

    +
    + +
    +
    +run(test, compileflags=None, out=None, clear_globs=True)
    +

    Run the examples in test (a DocTest object), and display the +results using the writer function out.

    +

    The examples are run in the namespace test.globs. If clear_globs is +true (the default), then this namespace will be cleared after the test runs, +to help with garbage collection. If you would like to examine the namespace +after the test completes, then use clear_globs=False.

    +

    compileflags gives the set of flags that should be used by the Python +compiler when running the examples. If not specified, then it will default to +the set of future-import flags that apply to globs.

    +

    The output of each example is checked using the DocTestRunner’s +output checker, and the results are formatted by the +DocTestRunner.report_*() methods.

    +
    + +
    +
    +summarize(verbose=None)
    +

    Print a summary of all the test cases that have been run by this DocTestRunner, +and return a named tuple TestResults(failed, attempted).

    +

    The optional verbose argument controls how detailed the summary is. If the +verbosity is not specified, then the DocTestRunner’s verbosity is +used.

    +
    + +
    + +
    +
    +

    OutputChecker objects

    +
    +
    +class doctest.OutputChecker
    +

    A class used to check the whether the actual output from a doctest example +matches the expected output. OutputChecker defines two methods: +check_output(), which compares a given pair of outputs, and returns true +if they match; and output_difference(), which returns a string describing +the differences between two outputs.

    +

    OutputChecker defines the following methods:

    +
    +
    +check_output(want, got, optionflags)
    +

    Return True iff the actual output from an example (got) matches the +expected output (want). These strings are always considered to match if +they are identical; but depending on what option flags the test runner is +using, several non-exact match types are also possible. See section +Option Flags for more information about option flags.

    +
    + +
    +
    +output_difference(example, got, optionflags)
    +

    Return a string describing the differences between the expected output for a +given example (example) and the actual output (got). optionflags is the +set of option flags used to compare want and got.

    +
    + +
    + +
    +
    +
    +

    Debugging

    +

    Doctest provides several mechanisms for debugging doctest examples:

    +
      +
    • Several functions convert doctests to executable Python programs, which can be +run under the Python debugger, pdb.

    • +
    • The DebugRunner class is a subclass of DocTestRunner that +raises an exception for the first failing example, containing information about +that example. This information can be used to perform post-mortem debugging on +the example.

    • +
    • The unittest cases generated by DocTestSuite() support the +debug() method defined by unittest.TestCase.

    • +
    • You can add a call to pdb.set_trace() in a doctest example, and you’ll +drop into the Python debugger when that line is executed. Then you can inspect +current values of variables, and so on. For example, suppose a.py +contains just this module docstring:

      +
      """
      +>>> def f(x):
      +...     g(x*2)
      +>>> def g(x):
      +...     print(x+3)
      +...     import pdb; pdb.set_trace()
      +>>> f(3)
      +9
      +"""
      +
      +
      +

      Then an interactive Python session may look like this:

      +
      >>> import a, doctest
      +>>> doctest.testmod(a)
      +--Return--
      +> <doctest a[1]>(3)g()->None
      +-> import pdb; pdb.set_trace()
      +(Pdb) list
      +  1     def g(x):
      +  2         print(x+3)
      +  3  ->     import pdb; pdb.set_trace()
      +[EOF]
      +(Pdb) p x
      +6
      +(Pdb) step
      +--Return--
      +> <doctest a[0]>(2)f()->None
      +-> g(x*2)
      +(Pdb) list
      +  1     def f(x):
      +  2  ->     g(x*2)
      +[EOF]
      +(Pdb) p x
      +3
      +(Pdb) step
      +--Return--
      +> <doctest a[2]>(1)?()->None
      +-> f(3)
      +(Pdb) cont
      +(0, 3)
      +>>>
      +
      +
      +
    • +
    +

    Functions that convert doctests to Python code, and possibly run the synthesized +code under the debugger:

    +
    +
    +doctest.script_from_examples(s)
    +

    Convert text with examples to a script.

    +

    Argument s is a string containing doctest examples. The string is converted +to a Python script, where doctest examples in s are converted to regular code, +and everything else is converted to Python comments. The generated script is +returned as a string. For example,

    +
    import doctest
    +print(doctest.script_from_examples(r"""
    +    Set x and y to 1 and 2.
    +    >>> x, y = 1, 2
    +
    +    Print their sum:
    +    >>> print(x+y)
    +    3
    +"""))
    +
    +
    +

    displays:

    +
    # Set x and y to 1 and 2.
    +x, y = 1, 2
    +#
    +# Print their sum:
    +print(x+y)
    +# Expected:
    +## 3
    +
    +
    +

    This function is used internally by other functions (see below), but can also be +useful when you want to transform an interactive Python session into a Python +script.

    +
    + +
    +
    +doctest.testsource(module, name)
    +

    Convert the doctest for an object to a script.

    +

    Argument module is a module object, or dotted name of a module, containing the +object whose doctests are of interest. Argument name is the name (within the +module) of the object with the doctests of interest. The result is a string, +containing the object’s docstring converted to a Python script, as described for +script_from_examples() above. For example, if module a.py +contains a top-level function f(), then

    +
    import a, doctest
    +print(doctest.testsource(a, "a.f"))
    +
    +
    +

    prints a script version of function f()’s docstring, with doctests +converted to code, and the rest placed in comments.

    +
    + +
    +
    +doctest.debug(module, name, pm=False)
    +

    Debug the doctests for an object.

    +

    The module and name arguments are the same as for function +testsource() above. The synthesized Python script for the named object’s +docstring is written to a temporary file, and then that file is run under the +control of the Python debugger, pdb.

    +

    A shallow copy of module.__dict__ is used for both local and global +execution context.

    +

    Optional argument pm controls whether post-mortem debugging is used. If pm +has a true value, the script file is run directly, and the debugger gets +involved only if the script terminates via raising an unhandled exception. If +it does, then post-mortem debugging is invoked, via pdb.post_mortem(), +passing the traceback object from the unhandled exception. If pm is not +specified, or is false, the script is run under the debugger from the start, via +passing an appropriate exec() call to pdb.run().

    +
    + +
    +
    +doctest.debug_src(src, pm=False, globs=None)
    +

    Debug the doctests in a string.

    +

    This is like function debug() above, except that a string containing +doctest examples is specified directly, via the src argument.

    +

    Optional argument pm has the same meaning as in function debug() above.

    +

    Optional argument globs gives a dictionary to use as both local and global +execution context. If not specified, or None, an empty dictionary is used. +If specified, a shallow copy of the dictionary is used.

    +
    + +

    The DebugRunner class, and the special exceptions it may raise, are of +most interest to testing framework authors, and will only be sketched here. See +the source code, and especially DebugRunner’s docstring (which is a +doctest!) for more details:

    +
    +
    +class doctest.DebugRunner(checker=None, verbose=None, optionflags=0)
    +

    A subclass of DocTestRunner that raises an exception as soon as a +failure is encountered. If an unexpected exception occurs, an +UnexpectedException exception is raised, containing the test, the +example, and the original exception. If the output doesn’t match, then a +DocTestFailure exception is raised, containing the test, the example, and +the actual output.

    +

    For information about the constructor parameters and methods, see the +documentation for DocTestRunner in section Advanced API.

    +
    + +

    There are two exceptions that may be raised by DebugRunner instances:

    +
    +
    +exception doctest.DocTestFailure(test, example, got)
    +

    An exception raised by DocTestRunner to signal that a doctest example’s +actual output did not match its expected output. The constructor arguments are +used to initialize the attributes of the same names.

    +
    + +

    DocTestFailure defines the following attributes:

    +
    +
    +DocTestFailure.test
    +

    The DocTest object that was being run when the example failed.

    +
    + +
    +
    +DocTestFailure.example
    +

    The Example that failed.

    +
    + +
    +
    +DocTestFailure.got
    +

    The example’s actual output.

    +
    + +
    +
    +exception doctest.UnexpectedException(test, example, exc_info)
    +

    An exception raised by DocTestRunner to signal that a doctest +example raised an unexpected exception. The constructor arguments are used +to initialize the attributes of the same names.

    +
    + +

    UnexpectedException defines the following attributes:

    +
    +
    +UnexpectedException.test
    +

    The DocTest object that was being run when the example failed.

    +
    + +
    +
    +UnexpectedException.example
    +

    The Example that failed.

    +
    + +
    +
    +UnexpectedException.exc_info
    +

    A tuple containing information about the unexpected exception, as returned by +sys.exc_info().

    +
    + +
    +
    +

    Soapbox

    +

    As mentioned in the introduction, doctest has grown to have three primary +uses:

    +
      +
    1. Checking examples in docstrings.

    2. +
    3. Regression testing.

    4. +
    5. Executable documentation / literate testing.

    6. +
    +

    These uses have different requirements, and it is important to distinguish them. +In particular, filling your docstrings with obscure test cases makes for bad +documentation.

    +

    When writing a docstring, choose docstring examples with care. There’s an art to +this that needs to be learned—it may not be natural at first. Examples should +add genuine value to the documentation. A good example can often be worth many +words. If done with care, the examples will be invaluable for your users, and +will pay back the time it takes to collect them many times over as the years go +by and things change. I’m still amazed at how often one of my doctest +examples stops working after a “harmless” change.

    +

    Doctest also makes an excellent tool for regression testing, especially if you +don’t skimp on explanatory text. By interleaving prose and examples, it becomes +much easier to keep track of what’s actually being tested, and why. When a test +fails, good prose can make it much easier to figure out what the problem is, and +how it should be fixed. It’s true that you could write extensive comments in +code-based testing, but few programmers do. Many have found that using doctest +approaches instead leads to much clearer tests. Perhaps this is simply because +doctest makes writing prose a little easier than writing code, while writing +comments in code is a little harder. I think it goes deeper than just that: +the natural attitude when writing a doctest-based test is that you want to +explain the fine points of your software, and illustrate them with examples. +This in turn naturally leads to test files that start with the simplest +features, and logically progress to complications and edge cases. A coherent +narrative is the result, instead of a collection of isolated functions that test +isolated bits of functionality seemingly at random. It’s a different attitude, +and produces different results, blurring the distinction between testing and +explaining.

    +

    Regression testing is best confined to dedicated objects or files. There are +several options for organizing tests:

    +
      +
    • Write text files containing test cases as interactive examples, and test the +files using testfile() or DocFileSuite(). This is recommended, +although is easiest to do for new projects, designed from the start to use +doctest.

    • +
    • Define functions named _regrtest_topic that consist of single docstrings, +containing test cases for the named topics. These functions can be included in +the same file as the module, or separated out into a separate test file.

    • +
    • Define a __test__ dictionary mapping from regression test topics to +docstrings containing test cases.

    • +
    +

    When you have placed your tests in a module, the module can itself be the test +runner. When a test fails, you can arrange for your test runner to re-run only +the failing doctest while you debug the problem. Here is a minimal example of +such a test runner:

    +
    if __name__ == '__main__':
    +    import doctest
    +    flags = doctest.REPORT_NDIFF|doctest.FAIL_FAST
    +    if len(sys.argv) > 1:
    +        name = sys.argv[1]
    +        if name in globals():
    +            obj = globals()[name]
    +        else:
    +            obj = __test__[name]
    +        doctest.run_docstring_examples(obj, globals(), name=name,
    +                                       optionflags=flags)
    +    else:
    +        fail, total = doctest.testmod(optionflags=flags)
    +        print("{} failures out of {} tests".format(fail, total))
    +
    +
    +

    Footnotes

    +
    +
    1
    +

    Examples containing both expected output and an exception are not supported. +Trying to guess where one ends and the other begins is too error-prone, and that +also makes for a confusing test.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/dummy_threading.html b/python-3.7.4-docs-html/library/dummy_threading.html new file mode 100644 index 0000000..a1a4ad9 --- /dev/null +++ b/python-3.7.4-docs-html/library/dummy_threading.html @@ -0,0 +1,194 @@ + + + + + + + dummy_threading — Drop-in replacement for the threading module — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    dummy_threading — Drop-in replacement for the threading module

    +

    Source code: Lib/dummy_threading.py

    +
    +

    Deprecated since version 3.7: Python now always has threading enabled. Please use threading instead.

    +
    +
    +

    This module provides a duplicate interface to the threading module. +It was meant to be imported when the _thread module was not provided +on a platform.

    +

    Be careful to not use this module where deadlock might occur from a thread being +created that blocks waiting for another thread to be created. This often occurs +with blocking I/O.

    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/email.charset.html b/python-3.7.4-docs-html/library/email.charset.html new file mode 100644 index 0000000..9d28541 --- /dev/null +++ b/python-3.7.4-docs-html/library/email.charset.html @@ -0,0 +1,386 @@ + + + + + + + email.charset: Representing character sets — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    email.charset: Representing character sets

    +

    Source code: Lib/email/charset.py

    +
    +

    This module is part of the legacy (Compat32) email API. In the new +API only the aliases table is used.

    +

    The remaining text in this section is the original documentation of the module.

    +

    This module provides a class Charset for representing character sets +and character set conversions in email messages, as well as a character set +registry and several convenience methods for manipulating this registry. +Instances of Charset are used in several other modules within the +email package.

    +

    Import this class from the email.charset module.

    +
    +
    +class email.charset.Charset(input_charset=DEFAULT_CHARSET)
    +

    Map character sets to their email properties.

    +

    This class provides information about the requirements imposed on email for a +specific character set. It also provides convenience routines for converting +between character sets, given the availability of the applicable codecs. Given +a character set, it will do its best to provide information on how to use that +character set in an email message in an RFC-compliant way.

    +

    Certain character sets must be encoded with quoted-printable or base64 when used +in email headers or bodies. Certain character sets must be converted outright, +and are not allowed in email.

    +

    Optional input_charset is as described below; it is always coerced to lower +case. After being alias normalized it is also used as a lookup into the +registry of character sets to find out the header encoding, body encoding, and +output conversion codec to be used for the character set. For example, if +input_charset is iso-8859-1, then headers and bodies will be encoded using +quoted-printable and no output conversion codec is necessary. If +input_charset is euc-jp, then headers will be encoded with base64, bodies +will not be encoded, but output text will be converted from the euc-jp +character set to the iso-2022-jp character set.

    +

    Charset instances have the following data attributes:

    +
    +
    +input_charset
    +

    The initial character set specified. Common aliases are converted to +their official email names (e.g. latin_1 is converted to +iso-8859-1). Defaults to 7-bit us-ascii.

    +
    + +
    +
    +header_encoding
    +

    If the character set must be encoded before it can be used in an email +header, this attribute will be set to Charset.QP (for +quoted-printable), Charset.BASE64 (for base64 encoding), or +Charset.SHORTEST for the shortest of QP or BASE64 encoding. Otherwise, +it will be None.

    +
    + +
    +
    +body_encoding
    +

    Same as header_encoding, but describes the encoding for the mail +message’s body, which indeed may be different than the header encoding. +Charset.SHORTEST is not allowed for body_encoding.

    +
    + +
    +
    +output_charset
    +

    Some character sets must be converted before they can be used in email +headers or bodies. If the input_charset is one of them, this attribute +will contain the name of the character set output will be converted to. +Otherwise, it will be None.

    +
    + +
    +
    +input_codec
    +

    The name of the Python codec used to convert the input_charset to +Unicode. If no conversion codec is necessary, this attribute will be +None.

    +
    + +
    +
    +output_codec
    +

    The name of the Python codec used to convert Unicode to the +output_charset. If no conversion codec is necessary, this attribute +will have the same value as the input_codec.

    +
    + +

    Charset instances also have the following methods:

    +
    +
    +get_body_encoding()
    +

    Return the content transfer encoding used for body encoding.

    +

    This is either the string quoted-printable or base64 depending on +the encoding used, or it is a function, in which case you should call the +function with a single argument, the Message object being encoded. The +function should then set the Content-Transfer-Encoding +header itself to whatever is appropriate.

    +

    Returns the string quoted-printable if body_encoding is QP, +returns the string base64 if body_encoding is BASE64, and +returns the string 7bit otherwise.

    +
    + +
    +
    +get_output_charset()
    +

    Return the output character set.

    +

    This is the output_charset attribute if that is not None, otherwise +it is input_charset.

    +
    + +
    +
    +header_encode(string)
    +

    Header-encode the string string.

    +

    The type of encoding (base64 or quoted-printable) will be based on the +header_encoding attribute.

    +
    + +
    +
    +header_encode_lines(string, maxlengths)
    +

    Header-encode a string by converting it first to bytes.

    +

    This is similar to header_encode() except that the string is fit +into maximum line lengths as given by the argument maxlengths, which +must be an iterator: each element returned from this iterator will provide +the next maximum line length.

    +
    + +
    +
    +body_encode(string)
    +

    Body-encode the string string.

    +

    The type of encoding (base64 or quoted-printable) will be based on the +body_encoding attribute.

    +
    + +

    The Charset class also provides a number of methods to support +standard operations and built-in functions.

    +
    +
    +__str__()
    +

    Returns input_charset as a string coerced to lower +case. __repr__() is an alias for __str__().

    +
    + +
    +
    +__eq__(other)
    +

    This method allows you to compare two Charset instances for +equality.

    +
    + +
    +
    +__ne__(other)
    +

    This method allows you to compare two Charset instances for +inequality.

    +
    + +
    + +

    The email.charset module also provides the following functions for adding +new entries to the global character set, alias, and codec registries:

    +
    +
    +email.charset.add_charset(charset, header_enc=None, body_enc=None, output_charset=None)
    +

    Add character properties to the global registry.

    +

    charset is the input character set, and must be the canonical name of a +character set.

    +

    Optional header_enc and body_enc is either Charset.QP for +quoted-printable, Charset.BASE64 for base64 encoding, +Charset.SHORTEST for the shortest of quoted-printable or base64 encoding, +or None for no encoding. SHORTEST is only valid for +header_enc. The default is None for no encoding.

    +

    Optional output_charset is the character set that the output should be in. +Conversions will proceed from input charset, to Unicode, to the output charset +when the method Charset.convert() is called. The default is to output in +the same character set as the input.

    +

    Both input_charset and output_charset must have Unicode codec entries in the +module’s character set-to-codec mapping; use add_codec() to add codecs the +module does not know about. See the codecs module’s documentation for +more information.

    +

    The global character set registry is kept in the module global dictionary +CHARSETS.

    +
    + +
    +
    +email.charset.add_alias(alias, canonical)
    +

    Add a character set alias. alias is the alias name, e.g. latin-1. +canonical is the character set’s canonical name, e.g. iso-8859-1.

    +

    The global charset alias registry is kept in the module global dictionary +ALIASES.

    +
    + +
    +
    +email.charset.add_codec(charset, codecname)
    +

    Add a codec that map characters in the given character set to and from Unicode.

    +

    charset is the canonical name of a character set. codecname is the name of a +Python codec, as appropriate for the second argument to the str’s +encode() method.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/email.compat32-message.html b/python-3.7.4-docs-html/library/email.compat32-message.html new file mode 100644 index 0000000..6a08549 --- /dev/null +++ b/python-3.7.4-docs-html/library/email.compat32-message.html @@ -0,0 +1,921 @@ + + + + + + + email.message.Message: Representing an email message using the compat32 API — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    email.message.Message: Representing an email message using the compat32 API

    +

    The Message class is very similar to the +EmailMessage class, without the methods added by that +class, and with the default behavior of certain other methods being slightly +different. We also document here some methods that, while supported by the +EmailMessage class, are not recommended unless you are +dealing with legacy code.

    +

    The philosophy and structure of the two classes is otherwise the same.

    +

    This document describes the behavior under the default (for Message) +policy Compat32. If you are going to use another policy, +you should be using the EmailMessage class instead.

    +

    An email message consists of headers and a payload. Headers must be +RFC 5233 style names and values, where the field name and value are +separated by a colon. The colon is not part of either the field name or the +field value. The payload may be a simple text message, or a binary object, or +a structured sequence of sub-messages each with their own set of headers and +their own payload. The latter type of payload is indicated by the message +having a MIME type such as multipart/* or +message/rfc822.

    +

    The conceptual model provided by a Message object is that of an +ordered dictionary of headers with additional methods for accessing both +specialized information from the headers, for accessing the payload, for +generating a serialized version of the message, and for recursively walking +over the object tree. Note that duplicate headers are supported but special +methods must be used to access them.

    +

    The Message pseudo-dictionary is indexed by the header names, which +must be ASCII values. The values of the dictionary are strings that are +supposed to contain only ASCII characters; there is some special handling for +non-ASCII input, but it doesn’t always produce the correct results. Headers +are stored and returned in case-preserving form, but field names are matched +case-insensitively. There may also be a single envelope header, also known as +the Unix-From header or the From_ header. The payload is either a +string or bytes, in the case of simple message objects, or a list of +Message objects, for MIME container documents (e.g. +multipart/* and message/rfc822).

    +

    Here are the methods of the Message class:

    +
    +
    +class email.message.Message(policy=compat32)
    +

    If policy is specified (it must be an instance of a policy +class) use the rules it specifies to update and serialize the representation +of the message. If policy is not set, use the compat32 policy, which maintains backward compatibility with +the Python 3.2 version of the email package. For more information see the +policy documentation.

    +
    +

    Changed in version 3.3: The policy keyword argument was added.

    +
    +
    +
    +as_string(unixfrom=False, maxheaderlen=0, policy=None)
    +

    Return the entire message flattened as a string. When optional unixfrom +is true, the envelope header is included in the returned string. +unixfrom defaults to False. For backward compatibility reasons, +maxheaderlen defaults to 0, so if you want a different value you +must override it explicitly (the value specified for max_line_length in +the policy will be ignored by this method). The policy argument may be +used to override the default policy obtained from the message instance. +This can be used to control some of the formatting produced by the +method, since the specified policy will be passed to the Generator.

    +

    Flattening the message may trigger changes to the Message if +defaults need to be filled in to complete the transformation to a string +(for example, MIME boundaries may be generated or modified).

    +

    Note that this method is provided as a convenience and may not always +format the message the way you want. For example, by default it does +not do the mangling of lines that begin with From that is +required by the unix mbox format. For more flexibility, instantiate a +Generator instance and use its +flatten() method directly. For example:

    +
    from io import StringIO
    +from email.generator import Generator
    +fp = StringIO()
    +g = Generator(fp, mangle_from_=True, maxheaderlen=60)
    +g.flatten(msg)
    +text = fp.getvalue()
    +
    +
    +

    If the message object contains binary data that is not encoded according +to RFC standards, the non-compliant data will be replaced by unicode +“unknown character” code points. (See also as_bytes() and +BytesGenerator.)

    +
    +

    Changed in version 3.4: the policy keyword argument was added.

    +
    +
    + +
    +
    +__str__()
    +

    Equivalent to as_string(). Allows str(msg) to produce a +string containing the formatted message.

    +
    + +
    +
    +as_bytes(unixfrom=False, policy=None)
    +

    Return the entire message flattened as a bytes object. When optional +unixfrom is true, the envelope header is included in the returned +string. unixfrom defaults to False. The policy argument may be +used to override the default policy obtained from the message instance. +This can be used to control some of the formatting produced by the +method, since the specified policy will be passed to the +BytesGenerator.

    +

    Flattening the message may trigger changes to the Message if +defaults need to be filled in to complete the transformation to a string +(for example, MIME boundaries may be generated or modified).

    +

    Note that this method is provided as a convenience and may not always +format the message the way you want. For example, by default it does +not do the mangling of lines that begin with From that is +required by the unix mbox format. For more flexibility, instantiate a +BytesGenerator instance and use its +flatten() method directly. +For example:

    +
    from io import BytesIO
    +from email.generator import BytesGenerator
    +fp = BytesIO()
    +g = BytesGenerator(fp, mangle_from_=True, maxheaderlen=60)
    +g.flatten(msg)
    +text = fp.getvalue()
    +
    +
    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +__bytes__()
    +

    Equivalent to as_bytes(). Allows bytes(msg) to produce a +bytes object containing the formatted message.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +is_multipart()
    +

    Return True if the message’s payload is a list of +sub-Message objects, otherwise return False. When +is_multipart() returns False, the payload should be a string +object (which might be a CTE encoded binary payload). (Note that +is_multipart() returning True does not necessarily mean that +“msg.get_content_maintype() == ‘multipart’” will return the True. +For example, is_multipart will return True when the +Message is of type message/rfc822.)

    +
    + +
    +
    +set_unixfrom(unixfrom)
    +

    Set the message’s envelope header to unixfrom, which should be a string.

    +
    + +
    +
    +get_unixfrom()
    +

    Return the message’s envelope header. Defaults to None if the +envelope header was never set.

    +
    + +
    +
    +attach(payload)
    +

    Add the given payload to the current payload, which must be None or +a list of Message objects before the call. After the call, the +payload will always be a list of Message objects. If you want to +set the payload to a scalar object (e.g. a string), use +set_payload() instead.

    +

    This is a legacy method. On the +EmailMessage class its functionality is +replaced by set_content() and the +related make and add methods.

    +
    + +
    +
    +get_payload(i=None, decode=False)
    +

    Return the current payload, which will be a list of +Message objects when is_multipart() is True, or a +string when is_multipart() is False. If the payload is a list +and you mutate the list object, you modify the message’s payload in place.

    +

    With optional argument i, get_payload() will return the i-th +element of the payload, counting from zero, if is_multipart() is +True. An IndexError will be raised if i is less than 0 or +greater than or equal to the number of items in the payload. If the +payload is a string (i.e. is_multipart() is False) and i is +given, a TypeError is raised.

    +

    Optional decode is a flag indicating whether the payload should be +decoded or not, according to the Content-Transfer-Encoding +header. When True and the message is not a multipart, the payload will +be decoded if this header’s value is quoted-printable or base64. +If some other encoding is used, or Content-Transfer-Encoding +header is missing, the payload is +returned as-is (undecoded). In all cases the returned value is binary +data. If the message is a multipart and the decode flag is True, +then None is returned. If the payload is base64 and it was not +perfectly formed (missing padding, characters outside the base64 +alphabet), then an appropriate defect will be added to the message’s +defect property (InvalidBase64PaddingDefect or +InvalidBase64CharactersDefect, respectively).

    +

    When decode is False (the default) the body is returned as a string +without decoding the Content-Transfer-Encoding. However, +for a Content-Transfer-Encoding of 8bit, an attempt is made +to decode the original bytes using the charset specified by the +Content-Type header, using the replace error handler. +If no charset is specified, or if the charset given is not +recognized by the email package, the body is decoded using the default +ASCII charset.

    +

    This is a legacy method. On the +EmailMessage class its functionality is +replaced by get_content() and +iter_parts().

    +
    + +
    +
    +set_payload(payload, charset=None)
    +

    Set the entire message object’s payload to payload. It is the client’s +responsibility to ensure the payload invariants. Optional charset sets +the message’s default character set; see set_charset() for details.

    +

    This is a legacy method. On the +EmailMessage class its functionality is +replaced by set_content().

    +
    + +
    +
    +set_charset(charset)
    +

    Set the character set of the payload to charset, which can either be a +Charset instance (see email.charset), a +string naming a character set, or None. If it is a string, it will +be converted to a Charset instance. If charset +is None, the charset parameter will be removed from the +Content-Type header (the message will not be otherwise +modified). Anything else will generate a TypeError.

    +

    If there is no existing MIME-Version header one will be +added. If there is no existing Content-Type header, one +will be added with a value of text/plain. Whether the +Content-Type header already exists or not, its charset +parameter will be set to charset.output_charset. If +charset.input_charset and charset.output_charset differ, the payload +will be re-encoded to the output_charset. If there is no existing +Content-Transfer-Encoding header, then the payload will be +transfer-encoded, if needed, using the specified +Charset, and a header with the appropriate value +will be added. If a Content-Transfer-Encoding header +already exists, the payload is assumed to already be correctly encoded +using that Content-Transfer-Encoding and is not modified.

    +

    This is a legacy method. On the +EmailMessage class its functionality is +replaced by the charset parameter of the +email.emailmessage.EmailMessage.set_content() method.

    +
    + +
    +
    +get_charset()
    +

    Return the Charset instance associated with the +message’s payload.

    +

    This is a legacy method. On the +EmailMessage class it always returns +None.

    +
    + +

    The following methods implement a mapping-like interface for accessing the +message’s RFC 2822 headers. Note that there are some semantic differences +between these methods and a normal mapping (i.e. dictionary) interface. For +example, in a dictionary there are no duplicate keys, but here there may be +duplicate message headers. Also, in dictionaries there is no guaranteed +order to the keys returned by keys(), but in a Message object, +headers are always returned in the order they appeared in the original +message, or were added to the message later. Any header deleted and then +re-added are always appended to the end of the header list.

    +

    These semantic differences are intentional and are biased toward maximal +convenience.

    +

    Note that in all cases, any envelope header present in the message is not +included in the mapping interface.

    +

    In a model generated from bytes, any header values that (in contravention of +the RFCs) contain non-ASCII bytes will, when retrieved through this +interface, be represented as Header objects with +a charset of unknown-8bit.

    +
    +
    +__len__()
    +

    Return the total number of headers, including duplicates.

    +
    + +
    +
    +__contains__(name)
    +

    Return true if the message object has a field named name. Matching is +done case-insensitively and name should not include the trailing colon. +Used for the in operator, e.g.:

    +
    if 'message-id' in myMessage:
    +   print('Message-ID:', myMessage['message-id'])
    +
    +
    +
    + +
    +
    +__getitem__(name)
    +

    Return the value of the named header field. name should not include the +colon field separator. If the header is missing, None is returned; a +KeyError is never raised.

    +

    Note that if the named field appears more than once in the message’s +headers, exactly which of those field values will be returned is +undefined. Use the get_all() method to get the values of all the +extant named headers.

    +
    + +
    +
    +__setitem__(name, val)
    +

    Add a header to the message with field name name and value val. The +field is appended to the end of the message’s existing fields.

    +

    Note that this does not overwrite or delete any existing header with the same +name. If you want to ensure that the new header is the only one present in the +message with field name name, delete the field first, e.g.:

    +
    del msg['subject']
    +msg['subject'] = 'Python roolz!'
    +
    +
    +
    + +
    +
    +__delitem__(name)
    +

    Delete all occurrences of the field with name name from the message’s +headers. No exception is raised if the named field isn’t present in the +headers.

    +
    + +
    +
    +keys()
    +

    Return a list of all the message’s header field names.

    +
    + +
    +
    +values()
    +

    Return a list of all the message’s field values.

    +
    + +
    +
    +items()
    +

    Return a list of 2-tuples containing all the message’s field headers and +values.

    +
    + +
    +
    +get(name, failobj=None)
    +

    Return the value of the named header field. This is identical to +__getitem__() except that optional failobj is returned if the +named header is missing (defaults to None).

    +
    + +

    Here are some additional useful methods:

    +
    +
    +get_all(name, failobj=None)
    +

    Return a list of all the values for the field named name. If there are +no such named headers in the message, failobj is returned (defaults to +None).

    +
    + +
    +
    +add_header(_name, _value, **_params)
    +

    Extended header setting. This method is similar to __setitem__() +except that additional header parameters can be provided as keyword +arguments. _name is the header field to add and _value is the +primary value for the header.

    +

    For each item in the keyword argument dictionary _params, the key is +taken as the parameter name, with underscores converted to dashes (since +dashes are illegal in Python identifiers). Normally, the parameter will +be added as key="value" unless the value is None, in which case +only the key will be added. If the value contains non-ASCII characters, +it can be specified as a three tuple in the format +(CHARSET, LANGUAGE, VALUE), where CHARSET is a string naming the +charset to be used to encode the value, LANGUAGE can usually be set +to None or the empty string (see RFC 2231 for other possibilities), +and VALUE is the string value containing non-ASCII code points. If +a three tuple is not passed and the value contains non-ASCII characters, +it is automatically encoded in RFC 2231 format using a CHARSET +of utf-8 and a LANGUAGE of None.

    +

    Here’s an example:

    +
    msg.add_header('Content-Disposition', 'attachment', filename='bud.gif')
    +
    +
    +

    This will add a header that looks like

    +
    Content-Disposition: attachment; filename="bud.gif"
    +
    +
    +

    An example with non-ASCII characters:

    +
    msg.add_header('Content-Disposition', 'attachment',
    +               filename=('iso-8859-1', '', 'Fußballer.ppt'))
    +
    +
    +

    Which produces

    +
    Content-Disposition: attachment; filename*="iso-8859-1''Fu%DFballer.ppt"
    +
    +
    +
    + +
    +
    +replace_header(_name, _value)
    +

    Replace a header. Replace the first header found in the message that +matches _name, retaining header order and field name case. If no +matching header was found, a KeyError is raised.

    +
    + +
    +
    +get_content_type()
    +

    Return the message’s content type. The returned string is coerced to +lower case of the form maintype/subtype. If there was no +Content-Type header in the message the default type as given +by get_default_type() will be returned. Since according to +RFC 2045, messages always have a default type, get_content_type() +will always return a value.

    +

    RFC 2045 defines a message’s default type to be text/plain +unless it appears inside a multipart/digest container, in +which case it would be message/rfc822. If the +Content-Type header has an invalid type specification, +RFC 2045 mandates that the default type be text/plain.

    +
    + +
    +
    +get_content_maintype()
    +

    Return the message’s main content type. This is the maintype +part of the string returned by get_content_type().

    +
    + +
    +
    +get_content_subtype()
    +

    Return the message’s sub-content type. This is the subtype +part of the string returned by get_content_type().

    +
    + +
    +
    +get_default_type()
    +

    Return the default content type. Most messages have a default content +type of text/plain, except for messages that are subparts of +multipart/digest containers. Such subparts have a default +content type of message/rfc822.

    +
    + +
    +
    +set_default_type(ctype)
    +

    Set the default content type. ctype should either be +text/plain or message/rfc822, although this is not +enforced. The default content type is not stored in the +Content-Type header.

    +
    + +
    +
    +get_params(failobj=None, header='content-type', unquote=True)
    +

    Return the message’s Content-Type parameters, as a list. +The elements of the returned list are 2-tuples of key/value pairs, as +split on the '=' sign. The left hand side of the '=' is the key, +while the right hand side is the value. If there is no '=' sign in +the parameter the value is the empty string, otherwise the value is as +described in get_param() and is unquoted if optional unquote is +True (the default).

    +

    Optional failobj is the object to return if there is no +Content-Type header. Optional header is the header to +search instead of Content-Type.

    +

    This is a legacy method. On the +EmailMessage class its functionality is +replaced by the params property of the individual header objects +returned by the header access methods.

    +
    + +
    +
    +get_param(param, failobj=None, header='content-type', unquote=True)
    +

    Return the value of the Content-Type header’s parameter +param as a string. If the message has no Content-Type +header or if there is no such parameter, then failobj is returned +(defaults to None).

    +

    Optional header if given, specifies the message header to use instead of +Content-Type.

    +

    Parameter keys are always compared case insensitively. The return value +can either be a string, or a 3-tuple if the parameter was RFC 2231 +encoded. When it’s a 3-tuple, the elements of the value are of the form +(CHARSET, LANGUAGE, VALUE). Note that both CHARSET and +LANGUAGE can be None, in which case you should consider VALUE +to be encoded in the us-ascii charset. You can usually ignore +LANGUAGE.

    +

    If your application doesn’t care whether the parameter was encoded as in +RFC 2231, you can collapse the parameter value by calling +email.utils.collapse_rfc2231_value(), passing in the return value +from get_param(). This will return a suitably decoded Unicode +string when the value is a tuple, or the original string unquoted if it +isn’t. For example:

    +
    rawparam = msg.get_param('foo')
    +param = email.utils.collapse_rfc2231_value(rawparam)
    +
    +
    +

    In any case, the parameter value (either the returned string, or the +VALUE item in the 3-tuple) is always unquoted, unless unquote is set +to False.

    +

    This is a legacy method. On the +EmailMessage class its functionality is +replaced by the params property of the individual header objects +returned by the header access methods.

    +
    + +
    +
    +set_param(param, value, header='Content-Type', requote=True, charset=None, language='', replace=False)
    +

    Set a parameter in the Content-Type header. If the +parameter already exists in the header, its value will be replaced with +value. If the Content-Type header as not yet been defined +for this message, it will be set to text/plain and the new +parameter value will be appended as per RFC 2045.

    +

    Optional header specifies an alternative header to +Content-Type, and all parameters will be quoted as necessary +unless optional requote is False (the default is True).

    +

    If optional charset is specified, the parameter will be encoded +according to RFC 2231. Optional language specifies the RFC 2231 +language, defaulting to the empty string. Both charset and language +should be strings.

    +

    If replace is False (the default) the header is moved to the +end of the list of headers. If replace is True, the header +will be updated in place.

    +
    +

    Changed in version 3.4: replace keyword was added.

    +
    +
    + +
    +
    +del_param(param, header='content-type', requote=True)
    +

    Remove the given parameter completely from the Content-Type +header. The header will be re-written in place without the parameter or +its value. All values will be quoted as necessary unless requote is +False (the default is True). Optional header specifies an +alternative to Content-Type.

    +
    + +
    +
    +set_type(type, header='Content-Type', requote=True)
    +

    Set the main type and subtype for the Content-Type +header. type must be a string in the form maintype/subtype, +otherwise a ValueError is raised.

    +

    This method replaces the Content-Type header, keeping all +the parameters in place. If requote is False, this leaves the +existing header’s quoting as is, otherwise the parameters will be quoted +(the default).

    +

    An alternative header can be specified in the header argument. When the +Content-Type header is set a MIME-Version +header is also added.

    +

    This is a legacy method. On the +EmailMessage class its functionality is +replaced by the make_ and add_ methods.

    +
    + +
    +
    +get_filename(failobj=None)
    +

    Return the value of the filename parameter of the +Content-Disposition header of the message. If the header +does not have a filename parameter, this method falls back to looking +for the name parameter on the Content-Type header. If +neither is found, or the header is missing, then failobj is returned. +The returned string will always be unquoted as per +email.utils.unquote().

    +
    + +
    +
    +get_boundary(failobj=None)
    +

    Return the value of the boundary parameter of the +Content-Type header of the message, or failobj if either +the header is missing, or has no boundary parameter. The returned +string will always be unquoted as per email.utils.unquote().

    +
    + +
    +
    +set_boundary(boundary)
    +

    Set the boundary parameter of the Content-Type header to +boundary. set_boundary() will always quote boundary if +necessary. A HeaderParseError is raised if the +message object has no Content-Type header.

    +

    Note that using this method is subtly different than deleting the old +Content-Type header and adding a new one with the new +boundary via add_header(), because set_boundary() preserves +the order of the Content-Type header in the list of +headers. However, it does not preserve any continuation lines which may +have been present in the original Content-Type header.

    +
    + +
    +
    +get_content_charset(failobj=None)
    +

    Return the charset parameter of the Content-Type header, +coerced to lower case. If there is no Content-Type header, or if +that header has no charset parameter, failobj is returned.

    +

    Note that this method differs from get_charset() which returns the +Charset instance for the default encoding of the message body.

    +
    + +
    +
    +get_charsets(failobj=None)
    +

    Return a list containing the character set names in the message. If the +message is a multipart, then the list will contain one element +for each subpart in the payload, otherwise, it will be a list of length 1.

    +

    Each item in the list will be a string which is the value of the +charset parameter in the Content-Type header for the +represented subpart. However, if the subpart has no +Content-Type header, no charset parameter, or is not of +the text main MIME type, then that item in the returned list +will be failobj.

    +
    + +
    +
    +get_content_disposition()
    +

    Return the lowercased value (without parameters) of the message’s +Content-Disposition header if it has one, or None. The +possible values for this method are inline, attachment or None +if the message follows RFC 2183.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +walk()
    +

    The walk() method is an all-purpose generator which can be used to +iterate over all the parts and subparts of a message object tree, in +depth-first traversal order. You will typically use walk() as the +iterator in a for loop; each iteration returns the next subpart.

    +

    Here’s an example that prints the MIME type of every part of a multipart +message structure:

    +
    >>> for part in msg.walk():
    +...     print(part.get_content_type())
    +multipart/report
    +text/plain
    +message/delivery-status
    +text/plain
    +text/plain
    +message/rfc822
    +text/plain
    +
    +
    +

    walk iterates over the subparts of any part where +is_multipart() returns True, even though +msg.get_content_maintype() == 'multipart' may return False. We +can see this in our example by making use of the _structure debug +helper function:

    +
    >>> for part in msg.walk():
    +...     print(part.get_content_maintype() == 'multipart',
    +...           part.is_multipart())
    +True True
    +False False
    +False True
    +False False
    +False False
    +False True
    +False False
    +>>> _structure(msg)
    +multipart/report
    +    text/plain
    +    message/delivery-status
    +        text/plain
    +        text/plain
    +    message/rfc822
    +        text/plain
    +
    +
    +

    Here the message parts are not multiparts, but they do contain +subparts. is_multipart() returns True and walk descends +into the subparts.

    +
    + +

    Message objects can also optionally contain two instance attributes, +which can be used when generating the plain text of a MIME message.

    +
    +
    +preamble
    +

    The format of a MIME document allows for some text between the blank line +following the headers, and the first multipart boundary string. Normally, +this text is never visible in a MIME-aware mail reader because it falls +outside the standard MIME armor. However, when viewing the raw text of +the message, or when viewing the message in a non-MIME aware reader, this +text can become visible.

    +

    The preamble attribute contains this leading extra-armor text for MIME +documents. When the Parser discovers some text +after the headers but before the first boundary string, it assigns this +text to the message’s preamble attribute. When the +Generator is writing out the plain text +representation of a MIME message, and it finds the +message has a preamble attribute, it will write this text in the area +between the headers and the first boundary. See email.parser and +email.generator for details.

    +

    Note that if the message object has no preamble, the preamble attribute +will be None.

    +
    + +
    +
    +epilogue
    +

    The epilogue attribute acts the same way as the preamble attribute, +except that it contains text that appears between the last boundary and +the end of the message.

    +

    You do not need to set the epilogue to the empty string in order for the +Generator to print a newline at the end of the +file.

    +
    + +
    +
    +defects
    +

    The defects attribute contains a list of all the problems found when +parsing this message. See email.errors for a detailed description +of the possible parsing defects.

    +
    + +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/email.contentmanager.html b/python-3.7.4-docs-html/library/email.contentmanager.html new file mode 100644 index 0000000..9bb966b --- /dev/null +++ b/python-3.7.4-docs-html/library/email.contentmanager.html @@ -0,0 +1,386 @@ + + + + + + + email.contentmanager: Managing MIME Content — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    email.contentmanager: Managing MIME Content

    +

    Source code: Lib/email/contentmanager.py

    +
    +
    +

    New in version 3.6: 1

    +
    +
    +
    +class email.contentmanager.ContentManager
    +

    Base class for content managers. Provides the standard registry mechanisms +to register converters between MIME content and other representations, as +well as the get_content and set_content dispatch methods.

    +
    +
    +get_content(msg, *args, **kw)
    +

    Look up a handler function based on the mimetype of msg (see next +paragraph), call it, passing through all arguments, and return the result +of the call. The expectation is that the handler will extract the +payload from msg and return an object that encodes information about +the extracted data.

    +

    To find the handler, look for the following keys in the registry, +stopping with the first one found:

    +
    +
      +
    • the string representing the full MIME type (maintype/subtype)

    • +
    • the string representing the maintype

    • +
    • the empty string

    • +
    +
    +

    If none of these keys produce a handler, raise a KeyError for the +full MIME type.

    +
    + +
    +
    +set_content(msg, obj, *args, **kw)
    +

    If the maintype is multipart, raise a TypeError; otherwise +look up a handler function based on the type of obj (see next +paragraph), call clear_content() on the +msg, and call the handler function, passing through all arguments. The +expectation is that the handler will transform and store obj into +msg, possibly making other changes to msg as well, such as adding +various MIME headers to encode information needed to interpret the stored +data.

    +

    To find the handler, obtain the type of obj (typ = type(obj)), and +look for the following keys in the registry, stopping with the first one +found:

    +
    +
      +
    • the type itself (typ)

    • +
    • the type’s fully qualified name (typ.__module__ + '.' + +typ.__qualname__).

    • +
    • the type’s qualname (typ.__qualname__)

    • +
    • the type’s name (typ.__name__).

    • +
    +
    +

    If none of the above match, repeat all of the checks above for each of +the types in the MRO (typ.__mro__). Finally, if no other key +yields a handler, check for a handler for the key None. If there is +no handler for None, raise a KeyError for the fully +qualified name of the type.

    +

    Also add a MIME-Version header if one is not present (see +also MIMEPart).

    +
    + +
    +
    +add_get_handler(key, handler)
    +

    Record the function handler as the handler for key. For the possible +values of key, see get_content().

    +
    + +
    +
    +add_set_handler(typekey, handler)
    +

    Record handler as the function to call when an object of a type +matching typekey is passed to set_content(). For the possible +values of typekey, see set_content().

    +
    + +
    + +
    +

    Content Manager Instances

    +

    Currently the email package provides only one concrete content manager, +raw_data_manager, although more may be added in the future. +raw_data_manager is the +content_manager provided by +EmailPolicy and its derivatives.

    +
    +
    +email.contentmanager.raw_data_manager
    +

    This content manager provides only a minimum interface beyond that provided +by Message itself: it deals only with text, raw +byte strings, and Message objects. Nevertheless, it +provides significant advantages compared to the base API: get_content on +a text part will return a unicode string without the application needing to +manually decode it, set_content provides a rich set of options for +controlling the headers added to a part and controlling the content transfer +encoding, and it enables the use of the various add_ methods, thereby +simplifying the creation of multipart messages.

    +
    +
    +email.contentmanager.get_content(msg, errors='replace')
    +

    Return the payload of the part as either a string (for text parts), an +EmailMessage object (for message/rfc822 +parts), or a bytes object (for all other non-multipart types). Raise +a KeyError if called on a multipart. If the part is a +text part and errors is specified, use it as the error handler when +decoding the payload to unicode. The default error handler is +replace.

    +
    + +
    +
    +email.contentmanager.set_content(msg, <'str'>, subtype="plain", charset='utf-8' cte=None, disposition=None, filename=None, cid=None, params=None, headers=None)
    +
    +email.contentmanager.set_content(msg, <'bytes'>, maintype, subtype, cte="base64", disposition=None, filename=None, cid=None, params=None, headers=None)
    +
    +email.contentmanager.set_content(msg, <'EmailMessage'>, cte=None, disposition=None, filename=None, cid=None, params=None, headers=None)
    +

    Add headers and payload to msg:

    +

    Add a Content-Type header with a maintype/subtype +value.

    +
    +
      +
    • For str, set the MIME maintype to text, and set the +subtype to subtype if it is specified, or plain if it is not.

    • +
    • For bytes, use the specified maintype and subtype, or +raise a TypeError if they are not specified.

    • +
    • For EmailMessage objects, set the maintype +to message, and set the subtype to subtype if it is +specified or rfc822 if it is not. If subtype is +partial, raise an error (bytes objects must be used to +construct message/partial parts).

    • +
    +
    +

    If charset is provided (which is valid only for str), encode the +string to bytes using the specified character set. The default is +utf-8. If the specified charset is a known alias for a standard +MIME charset name, use the standard charset instead.

    +

    If cte is set, encode the payload using the specified content transfer +encoding, and set the Content-Transfer-Encoding header to +that value. Possible values for cte are quoted-printable, +base64, 7bit, 8bit, and binary. If the input cannot be +encoded in the specified encoding (for example, specifying a cte of +7bit for an input that contains non-ASCII values), raise a +ValueError.

    +
    +
      +
    • For str objects, if cte is not set use heuristics to +determine the most compact encoding.

    • +
    • For EmailMessage, per RFC 2046, raise +an error if a cte of quoted-printable or base64 is +requested for subtype rfc822, and for any cte other than +7bit for subtype external-body. For +message/rfc822, use 8bit if cte is not specified. For +all other values of subtype, use 7bit.

    • +
    +
    +
    +

    Note

    +

    A cte of binary does not actually work correctly yet. +The EmailMessage object as modified by set_content is +correct, but BytesGenerator does not +serialize it correctly.

    +
    +

    If disposition is set, use it as the value of the +Content-Disposition header. If not specified, and +filename is specified, add the header with the value attachment. +If disposition is not specified and filename is also not specified, +do not add the header. The only valid values for disposition are +attachment and inline.

    +

    If filename is specified, use it as the value of the filename +parameter of the Content-Disposition header.

    +

    If cid is specified, add a Content-ID header with +cid as its value.

    +

    If params is specified, iterate its items method and use the +resulting (key, value) pairs to set additional parameters on the +Content-Type header.

    +

    If headers is specified and is a list of strings of the form +headername: headervalue or a list of header objects +(distinguished from strings by having a name attribute), add the +headers to msg.

    +
    + +
    + +

    Footnotes

    +
    +
    1
    +

    Originally added in 3.4 as a provisional module

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/email.encoders.html b/python-3.7.4-docs-html/library/email.encoders.html new file mode 100644 index 0000000..df714b3 --- /dev/null +++ b/python-3.7.4-docs-html/library/email.encoders.html @@ -0,0 +1,251 @@ + + + + + + + email.encoders: Encoders — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    email.encoders: Encoders

    +

    Source code: Lib/email/encoders.py

    +
    +

    This module is part of the legacy (Compat32) email API. In the +new API the functionality is provided by the cte parameter of +the set_content() method.

    +

    This module is deprecated in Python 3. The functions provided here +should not be called explicitly since the MIMEText +class sets the content type and CTE header using the _subtype and _charset +values passed during the instaniation of that class.

    +

    The remaining text in this section is the original documentation of the module.

    +

    When creating Message objects from scratch, you often +need to encode the payloads for transport through compliant mail servers. This +is especially true for image/* and text/* type messages +containing binary data.

    +

    The email package provides some convenient encodings in its +encoders module. These encoders are actually used by the +MIMEAudio and MIMEImage +class constructors to provide default encodings. All encoder functions take +exactly one argument, the message object to encode. They usually extract the +payload, encode it, and reset the payload to this newly encoded value. They +should also set the Content-Transfer-Encoding header as appropriate.

    +

    Note that these functions are not meaningful for a multipart message. They +must be applied to individual subparts instead, and will raise a +TypeError if passed a message whose type is multipart.

    +

    Here are the encoding functions provided:

    +
    +
    +email.encoders.encode_quopri(msg)
    +

    Encodes the payload into quoted-printable form and sets the +Content-Transfer-Encoding header to quoted-printable 1. +This is a good encoding to use when most of your payload is normal printable +data, but contains a few unprintable characters.

    +
    + +
    +
    +email.encoders.encode_base64(msg)
    +

    Encodes the payload into base64 form and sets the +Content-Transfer-Encoding header to base64. This is a good +encoding to use when most of your payload is unprintable data since it is a more +compact form than quoted-printable. The drawback of base64 encoding is that it +renders the text non-human readable.

    +
    + +
    +
    +email.encoders.encode_7or8bit(msg)
    +

    This doesn’t actually modify the message’s payload, but it does set the +Content-Transfer-Encoding header to either 7bit or 8bit as +appropriate, based on the payload data.

    +
    + +
    +
    +email.encoders.encode_noop(msg)
    +

    This does nothing; it doesn’t even set the +Content-Transfer-Encoding header.

    +
    + +

    Footnotes

    +
    +
    1
    +

    Note that encoding with encode_quopri() also encodes all tabs and space +characters in the data.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/email.errors.html b/python-3.7.4-docs-html/library/email.errors.html new file mode 100644 index 0000000..27bed83 --- /dev/null +++ b/python-3.7.4-docs-html/library/email.errors.html @@ -0,0 +1,288 @@ + + + + + + + email.errors: Exception and Defect classes — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    email.errors: Exception and Defect classes

    +

    Source code: Lib/email/errors.py

    +
    +

    The following exception classes are defined in the email.errors module:

    +
    +
    +exception email.errors.MessageError
    +

    This is the base class for all exceptions that the email package can +raise. It is derived from the standard Exception class and defines no +additional methods.

    +
    + +
    +
    +exception email.errors.MessageParseError
    +

    This is the base class for exceptions raised by the +Parser class. It is derived from +MessageError. This class is also used internally by the parser used +by headerregistry.

    +
    + +
    +
    +exception email.errors.HeaderParseError
    +

    Raised under some error conditions when parsing the RFC 5322 headers of a +message, this class is derived from MessageParseError. The +set_boundary() method will raise this +error if the content type is unknown when the method is called. +Header may raise this error for certain base64 +decoding errors, and when an attempt is made to create a header that appears +to contain an embedded header (that is, there is what is supposed to be a +continuation line that has no leading whitespace and looks like a header).

    +
    + +
    +
    +exception email.errors.BoundaryError
    +

    Deprecated and no longer used.

    +
    + +
    +
    +exception email.errors.MultipartConversionError
    +

    Raised when a payload is added to a Message object +using add_payload(), but the payload is already a scalar and the +message’s Content-Type main type is not either +multipart or missing. MultipartConversionError multiply +inherits from MessageError and the built-in TypeError.

    +

    Since Message.add_payload() is deprecated, this exception is rarely +raised in practice. However the exception may also be raised if the +attach() +method is called on an instance of a class derived from +MIMENonMultipart (e.g. +MIMEImage).

    +
    + +

    Here is the list of the defects that the FeedParser +can find while parsing messages. Note that the defects are added to the message +where the problem was found, so for example, if a message nested inside a +multipart/alternative had a malformed header, that nested message +object would have a defect, but the containing messages would not.

    +

    All defect classes are subclassed from email.errors.MessageDefect.

    +
      +
    • NoBoundaryInMultipartDefect – A message claimed to be a multipart, +but had no boundary parameter.

    • +
    • StartBoundaryNotFoundDefect – The start boundary claimed in the +Content-Type header was never found.

    • +
    • CloseBoundaryNotFoundDefect – A start boundary was found, but +no corresponding close boundary was ever found.

      +
      +

      New in version 3.3.

      +
      +
    • +
    • FirstHeaderLineIsContinuationDefect – The message had a continuation +line as its first header line.

    • +
    • MisplacedEnvelopeHeaderDefect - A “Unix From” header was found in the +middle of a header block.

    • +
    • MissingHeaderBodySeparatorDefect - A line was found while parsing +headers that had no leading white space but contained no ‘:’. Parsing +continues assuming that the line represents the first line of the body.

      +
      +

      New in version 3.3.

      +
      +
    • +
    • MalformedHeaderDefect – A header was found that was missing a colon, +or was otherwise malformed.

      +
      +

      Deprecated since version 3.3: This defect has not been used for several Python versions.

      +
      +
    • +
    • MultipartInvariantViolationDefect – A message claimed to be a +multipart, but no subparts were found. Note that when a message +has this defect, its is_multipart() method may +return false even though its content type claims to be multipart.

    • +
    • InvalidBase64PaddingDefect – When decoding a block of base64 +encoded bytes, the padding was not correct. Enough padding is added to +perform the decode, but the resulting decoded bytes may be invalid.

    • +
    • InvalidBase64CharactersDefect – When decoding a block of base64 +encoded bytes, characters outside the base64 alphabet were encountered. +The characters are ignored, but the resulting decoded bytes may be invalid.

    • +
    • InvalidBase64LengthDefect – When decoding a block of base64 encoded +bytes, the number of non-padding base64 characters was invalid (1 more than +a multiple of 4). The encoded block was kept as-is.

    • +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/email.examples.html b/python-3.7.4-docs-html/library/email.examples.html new file mode 100644 index 0000000..1882984 --- /dev/null +++ b/python-3.7.4-docs-html/library/email.examples.html @@ -0,0 +1,569 @@ + + + + + + + email: Examples — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    email: Examples

    +

    Here are a few examples of how to use the email package to read, write, +and send simple email messages, as well as more complex MIME messages.

    +

    First, let’s see how to create and send a simple text message (both the +text content and the addresses may contain unicode characters):

    +
    # Import smtplib for the actual sending function
    +import smtplib
    +
    +# Import the email modules we'll need
    +from email.message import EmailMessage
    +
    +# Open the plain text file whose name is in textfile for reading.
    +with open(textfile) as fp:
    +    # Create a text/plain message
    +    msg = EmailMessage()
    +    msg.set_content(fp.read())
    +
    +# me == the sender's email address
    +# you == the recipient's email address
    +msg['Subject'] = 'The contents of %s' % textfile
    +msg['From'] = me
    +msg['To'] = you
    +
    +# Send the message via our own SMTP server.
    +s = smtplib.SMTP('localhost')
    +s.send_message(msg)
    +s.quit()
    +
    +
    +

    Parsing RFC 822 headers can easily be done by the using the classes +from the parser module:

    +
    # Import the email modules we'll need
    +from email.parser import BytesParser, Parser
    +from email.policy import default
    +
    +# If the e-mail headers are in a file, uncomment these two lines:
    +# with open(messagefile, 'rb') as fp:
    +#     headers = BytesParser(policy=default).parse(fp)
    +
    +#  Or for parsing headers in a string (this is an uncommon operation), use:
    +headers = Parser(policy=default).parsestr(
    +        'From: Foo Bar <user@example.com>\n'
    +        'To: <someone_else@example.com>\n'
    +        'Subject: Test message\n'
    +        '\n'
    +        'Body would go here\n')
    +
    +#  Now the header items can be accessed as a dictionary:
    +print('To: {}'.format(headers['to']))
    +print('From: {}'.format(headers['from']))
    +print('Subject: {}'.format(headers['subject']))
    +
    +# You can also access the parts of the addresses:
    +print('Recipient username: {}'.format(headers['to'].addresses[0].username))
    +print('Sender name: {}'.format(headers['from'].addresses[0].display_name))
    +
    +
    +

    Here’s an example of how to send a MIME message containing a bunch of family +pictures that may be residing in a directory:

    +
    # Import smtplib for the actual sending function
    +import smtplib
    +
    +# And imghdr to find the types of our images
    +import imghdr
    +
    +# Here are the email package modules we'll need
    +from email.message import EmailMessage
    +
    +# Create the container email message.
    +msg = EmailMessage()
    +msg['Subject'] = 'Our family reunion'
    +# me == the sender's email address
    +# family = the list of all recipients' email addresses
    +msg['From'] = me
    +msg['To'] = ', '.join(family)
    +msg.preamble = 'Our family reunion'
    +
    +# Open the files in binary mode.  Use imghdr to figure out the
    +# MIME subtype for each specific image.
    +for file in pngfiles:
    +    with open(file, 'rb') as fp:
    +        img_data = fp.read()
    +    msg.add_attachment(img_data, maintype='image',
    +                                 subtype=imghdr.what(None, img_data))
    +
    +# Send the email via our own SMTP server.
    +with smtplib.SMTP('localhost') as s:
    +    s.send_message(msg)
    +
    +
    +

    Here’s an example of how to send the entire contents of a directory as an email +message: 1

    +
    #!/usr/bin/env python3
    +
    +"""Send the contents of a directory as a MIME message."""
    +
    +import os
    +import smtplib
    +# For guessing MIME type based on file name extension
    +import mimetypes
    +
    +from argparse import ArgumentParser
    +
    +from email.message import EmailMessage
    +from email.policy import SMTP
    +
    +
    +def main():
    +    parser = ArgumentParser(description="""\
    +Send the contents of a directory as a MIME message.
    +Unless the -o option is given, the email is sent by forwarding to your local
    +SMTP server, which then does the normal delivery process.  Your local machine
    +must be running an SMTP server.
    +""")
    +    parser.add_argument('-d', '--directory',
    +                        help="""Mail the contents of the specified directory,
    +                        otherwise use the current directory.  Only the regular
    +                        files in the directory are sent, and we don't recurse to
    +                        subdirectories.""")
    +    parser.add_argument('-o', '--output',
    +                        metavar='FILE',
    +                        help="""Print the composed message to FILE instead of
    +                        sending the message to the SMTP server.""")
    +    parser.add_argument('-s', '--sender', required=True,
    +                        help='The value of the From: header (required)')
    +    parser.add_argument('-r', '--recipient', required=True,
    +                        action='append', metavar='RECIPIENT',
    +                        default=[], dest='recipients',
    +                        help='A To: header value (at least one required)')
    +    args = parser.parse_args()
    +    directory = args.directory
    +    if not directory:
    +        directory = '.'
    +    # Create the message
    +    msg = EmailMessage()
    +    msg['Subject'] = 'Contents of directory %s' % os.path.abspath(directory)
    +    msg['To'] = ', '.join(args.recipients)
    +    msg['From'] = args.sender
    +    msg.preamble = 'You will not see this in a MIME-aware mail reader.\n'
    +
    +    for filename in os.listdir(directory):
    +        path = os.path.join(directory, filename)
    +        if not os.path.isfile(path):
    +            continue
    +        # Guess the content type based on the file's extension.  Encoding
    +        # will be ignored, although we should check for simple things like
    +        # gzip'd or compressed files.
    +        ctype, encoding = mimetypes.guess_type(path)
    +        if ctype is None or encoding is not None:
    +            # No guess could be made, or the file is encoded (compressed), so
    +            # use a generic bag-of-bits type.
    +            ctype = 'application/octet-stream'
    +        maintype, subtype = ctype.split('/', 1)
    +        with open(path, 'rb') as fp:
    +            msg.add_attachment(fp.read(),
    +                               maintype=maintype,
    +                               subtype=subtype,
    +                               filename=filename)
    +    # Now send or store the message
    +    if args.output:
    +        with open(args.output, 'wb') as fp:
    +            fp.write(msg.as_bytes(policy=SMTP))
    +    else:
    +        with smtplib.SMTP('localhost') as s:
    +            s.send_message(msg)
    +
    +
    +if __name__ == '__main__':
    +    main()
    +
    +
    +

    Here’s an example of how to unpack a MIME message like the one +above, into a directory of files:

    +
    #!/usr/bin/env python3
    +
    +"""Unpack a MIME message into a directory of files."""
    +
    +import os
    +import email
    +import mimetypes
    +
    +from email.policy import default
    +
    +from argparse import ArgumentParser
    +
    +
    +def main():
    +    parser = ArgumentParser(description="""\
    +Unpack a MIME message into a directory of files.
    +""")
    +    parser.add_argument('-d', '--directory', required=True,
    +                        help="""Unpack the MIME message into the named
    +                        directory, which will be created if it doesn't already
    +                        exist.""")
    +    parser.add_argument('msgfile')
    +    args = parser.parse_args()
    +
    +    with open(args.msgfile, 'rb') as fp:
    +        msg = email.message_from_binary_file(fp, policy=default)
    +
    +    try:
    +        os.mkdir(args.directory)
    +    except FileExistsError:
    +        pass
    +
    +    counter = 1
    +    for part in msg.walk():
    +        # multipart/* are just containers
    +        if part.get_content_maintype() == 'multipart':
    +            continue
    +        # Applications should really sanitize the given filename so that an
    +        # email message can't be used to overwrite important files
    +        filename = part.get_filename()
    +        if not filename:
    +            ext = mimetypes.guess_extension(part.get_content_type())
    +            if not ext:
    +                # Use a generic bag-of-bits extension
    +                ext = '.bin'
    +            filename = 'part-%03d%s' % (counter, ext)
    +        counter += 1
    +        with open(os.path.join(args.directory, filename), 'wb') as fp:
    +            fp.write(part.get_payload(decode=True))
    +
    +
    +if __name__ == '__main__':
    +    main()
    +
    +
    +

    Here’s an example of how to create an HTML message with an alternative plain +text version. To make things a bit more interesting, we include a related +image in the html part, and we save a copy of what we are going to send to +disk, as well as sending it.

    +
    #!/usr/bin/env python3
    +
    +import smtplib
    +
    +from email.message import EmailMessage
    +from email.headerregistry import Address
    +from email.utils import make_msgid
    +
    +# Create the base text message.
    +msg = EmailMessage()
    +msg['Subject'] = "Ayons asperges pour le déjeuner"
    +msg['From'] = Address("Pepé Le Pew", "pepe", "example.com")
    +msg['To'] = (Address("Penelope Pussycat", "penelope", "example.com"),
    +             Address("Fabrette Pussycat", "fabrette", "example.com"))
    +msg.set_content("""\
    +Salut!
    +
    +Cela ressemble à un excellent recipie[1] déjeuner.
    +
    +[1] http://www.yummly.com/recipe/Roasted-Asparagus-Epicurious-203718
    +
    +--Pepé
    +""")
    +
    +# Add the html version.  This converts the message into a multipart/alternative
    +# container, with the original text message as the first part and the new html
    +# message as the second part.
    +asparagus_cid = make_msgid()
    +msg.add_alternative("""\
    +<html>
    +  <head></head>
    +  <body>
    +    <p>Salut!</p>
    +    <p>Cela ressemble à un excellent
    +        <a href="http://www.yummly.com/recipe/Roasted-Asparagus-Epicurious-203718">
    +            recipie
    +        </a> déjeuner.
    +    </p>
    +    <img src="cid:{asparagus_cid}" />
    +  </body>
    +</html>
    +""".format(asparagus_cid=asparagus_cid[1:-1]), subtype='html')
    +# note that we needed to peel the <> off the msgid for use in the html.
    +
    +# Now add the related image to the html part.
    +with open("roasted-asparagus.jpg", 'rb') as img:
    +    msg.get_payload()[1].add_related(img.read(), 'image', 'jpeg',
    +                                     cid=asparagus_cid)
    +
    +# Make a local copy of what we are going to send.
    +with open('outgoing.msg', 'wb') as f:
    +    f.write(bytes(msg))
    +
    +# Send the message via local SMTP server.
    +with smtplib.SMTP('localhost') as s:
    +    s.send_message(msg)
    +
    +
    +

    If we were sent the message from the last example, here is one way we could +process it:

    +
    import os
    +import sys
    +import tempfile
    +import mimetypes
    +import webbrowser
    +
    +# Import the email modules we'll need
    +from email import policy
    +from email.parser import BytesParser
    +
    +# An imaginary module that would make this work and be safe.
    +from imaginary import magic_html_parser
    +
    +# In a real program you'd get the filename from the arguments.
    +with open('outgoing.msg', 'rb') as fp:
    +    msg = BytesParser(policy=policy.default).parse(fp)
    +
    +# Now the header items can be accessed as a dictionary, and any non-ASCII will
    +# be converted to unicode:
    +print('To:', msg['to'])
    +print('From:', msg['from'])
    +print('Subject:', msg['subject'])
    +
    +# If we want to print a preview of the message content, we can extract whatever
    +# the least formatted payload is and print the first three lines.  Of course,
    +# if the message has no plain text part printing the first three lines of html
    +# is probably useless, but this is just a conceptual example.
    +simplest = msg.get_body(preferencelist=('plain', 'html'))
    +print()
    +print(''.join(simplest.get_content().splitlines(keepends=True)[:3]))
    +
    +ans = input("View full message?")
    +if ans.lower()[0] == 'n':
    +    sys.exit()
    +
    +# We can extract the richest alternative in order to display it:
    +richest = msg.get_body()
    +partfiles = {}
    +if richest['content-type'].maintype == 'text':
    +    if richest['content-type'].subtype == 'plain':
    +        for line in richest.get_content().splitlines():
    +            print(line)
    +        sys.exit()
    +    elif richest['content-type'].subtype == 'html':
    +        body = richest
    +    else:
    +        print("Don't know how to display {}".format(richest.get_content_type()))
    +        sys.exit()
    +elif richest['content-type'].content_type == 'multipart/related':
    +    body = richest.get_body(preferencelist=('html'))
    +    for part in richest.iter_attachments():
    +        fn = part.get_filename()
    +        if fn:
    +            extension = os.path.splitext(part.get_filename())[1]
    +        else:
    +            extension = mimetypes.guess_extension(part.get_content_type())
    +        with tempfile.NamedTemporaryFile(suffix=extension, delete=False) as f:
    +            f.write(part.get_content())
    +            # again strip the <> to go from email form of cid to html form.
    +            partfiles[part['content-id'][1:-1]] = f.name
    +else:
    +    print("Don't know how to display {}".format(richest.get_content_type()))
    +    sys.exit()
    +with tempfile.NamedTemporaryFile(mode='w', delete=False) as f:
    +    # The magic_html_parser has to rewrite the href="cid:...." attributes to
    +    # point to the filenames in partfiles.  It also has to do a safety-sanitize
    +    # of the html.  It could be written using html.parser.
    +    f.write(magic_html_parser(body.get_content(), partfiles))
    +webbrowser.open(f.name)
    +os.remove(f.name)
    +for fn in partfiles.values():
    +    os.remove(fn)
    +
    +# Of course, there are lots of email messages that could break this simple
    +# minded program, but it will handle the most common ones.
    +
    +
    +

    Up to the prompt, the output from the above is:

    +
    To: Penelope Pussycat <penelope@example.com>, Fabrette Pussycat <fabrette@example.com>
    +From: Pepé Le Pew <pepe@example.com>
    +Subject: Ayons asperges pour le déjeuner
    +
    +Salut!
    +
    +Cela ressemble à un excellent recipie[1] déjeuner.
    +
    +
    +

    Footnotes

    +
    +
    1
    +

    Thanks to Matthew Dixon Cowles for the original inspiration and examples.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/email.generator.html b/python-3.7.4-docs-html/library/email.generator.html new file mode 100644 index 0000000..220cfe7 --- /dev/null +++ b/python-3.7.4-docs-html/library/email.generator.html @@ -0,0 +1,433 @@ + + + + + + + email.generator: Generating MIME documents — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    email.generator: Generating MIME documents

    +

    Source code: Lib/email/generator.py

    +
    +

    One of the most common tasks is to generate the flat (serialized) version of +the email message represented by a message object structure. You will need to +do this if you want to send your message via smtplib.SMTP.sendmail() or +the nntplib module, or print the message on the console. Taking a +message object structure and producing a serialized representation is the job +of the generator classes.

    +

    As with the email.parser module, you aren’t limited to the functionality +of the bundled generator; you could write one from scratch yourself. However +the bundled generator knows how to generate most email in a standards-compliant +way, should handle MIME and non-MIME email messages just fine, and is designed +so that the bytes-oriented parsing and generation operations are inverses, +assuming the same non-transforming policy is used for both. That +is, parsing the serialized byte stream via the +BytesParser class and then regenerating the serialized +byte stream using BytesGenerator should produce output identical to +the input 1. (On the other hand, using the generator on an +EmailMessage constructed by program may result in +changes to the EmailMessage object as defaults are +filled in.)

    +

    The Generator class can be used to flatten a message into a text (as +opposed to binary) serialized representation, but since Unicode cannot +represent binary data directly, the message is of necessity transformed into +something that contains only ASCII characters, using the standard email RFC +Content Transfer Encoding techniques for encoding email messages for transport +over channels that are not “8 bit clean”.

    +
    +
    +class email.generator.BytesGenerator(outfp, mangle_from_=None, maxheaderlen=None, *, policy=None)
    +

    Return a BytesGenerator object that will write any message provided +to the flatten() method, or any surrogateescape encoded text provided +to the write() method, to the file-like object outfp. +outfp must support a write method that accepts binary data.

    +

    If optional mangle_from_ is True, put a > character in front of +any line in the body that starts with the exact string "From ", that is +From followed by a space at the beginning of a line. mangle_from_ +defaults to the value of the mangle_from_ +setting of the policy (which is True for the +compat32 policy and False for all others). +mangle_from_ is intended for use when messages are stored in unix mbox +format (see mailbox and WHY THE CONTENT-LENGTH FORMAT IS BAD).

    +

    If maxheaderlen is not None, refold any header lines that are longer +than maxheaderlen, or if 0, do not rewrap any headers. If +manheaderlen is None (the default), wrap headers and other message +lines according to the policy settings.

    +

    If policy is specified, use that policy to control message generation. If +policy is None (the default), use the policy associated with the +Message or EmailMessage +object passed to flatten to control the message generation. See +email.policy for details on what policy controls.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.3: Added the policy keyword.

    +
    +
    +

    Changed in version 3.6: The default behavior of the mangle_from_ +and maxheaderlen parameters is to follow the policy.

    +
    +
    +
    +flatten(msg, unixfrom=False, linesep=None)
    +

    Print the textual representation of the message object structure rooted +at msg to the output file specified when the BytesGenerator +instance was created.

    +

    If the policy option cte_type +is 8bit (the default), copy any headers in the original parsed +message that have not been modified to the output with any bytes with the +high bit set reproduced as in the original, and preserve the non-ASCII +Content-Transfer-Encoding of any body parts that have them. +If cte_type is 7bit, convert the bytes with the high bit set as +needed using an ASCII-compatible Content-Transfer-Encoding. +That is, transform parts with non-ASCII +Content-Transfer-Encoding +(Content-Transfer-Encoding: 8bit) to an ASCII compatible +Content-Transfer-Encoding, and encode RFC-invalid non-ASCII +bytes in headers using the MIME unknown-8bit character set, thus +rendering them RFC-compliant.

    +

    If unixfrom is True, print the envelope header delimiter used by +the Unix mailbox format (see mailbox) before the first of the +RFC 5322 headers of the root message object. If the root object has +no envelope header, craft a standard one. The default is False. +Note that for subparts, no envelope header is ever printed.

    +

    If linesep is not None, use it as the separator character between +all the lines of the flattened message. If linesep is None (the +default), use the value specified in the policy.

    +
    + +
    +
    +clone(fp)
    +

    Return an independent clone of this BytesGenerator instance with +the exact same option settings, and fp as the new outfp.

    +
    + +
    +
    +write(s)
    +

    Encode s using the ASCII codec and the surrogateescape error +handler, and pass it to the write method of the outfp passed to the +BytesGenerator’s constructor.

    +
    + +
    + +

    As a convenience, EmailMessage provides the methods +as_bytes() and bytes(aMessage) (a.k.a. +__bytes__()), which simplify the generation of +a serialized binary representation of a message object. For more detail, see +email.message.

    +

    Because strings cannot represent binary data, the Generator class must +convert any binary data in any message it flattens to an ASCII compatible +format, by converting them to an ASCII compatible +Content-Transfer_Encoding. Using the terminology of the email +RFCs, you can think of this as Generator serializing to an I/O stream +that is not “8 bit clean”. In other words, most applications will want +to be using BytesGenerator, and not Generator.

    +
    +
    +class email.generator.Generator(outfp, mangle_from_=None, maxheaderlen=None, *, policy=None)
    +

    Return a Generator object that will write any message provided +to the flatten() method, or any text provided to the write() +method, to the file-like object outfp. outfp must support a +write method that accepts string data.

    +

    If optional mangle_from_ is True, put a > character in front of +any line in the body that starts with the exact string "From ", that is +From followed by a space at the beginning of a line. mangle_from_ +defaults to the value of the mangle_from_ +setting of the policy (which is True for the +compat32 policy and False for all others). +mangle_from_ is intended for use when messages are stored in unix mbox +format (see mailbox and WHY THE CONTENT-LENGTH FORMAT IS BAD).

    +

    If maxheaderlen is not None, refold any header lines that are longer +than maxheaderlen, or if 0, do not rewrap any headers. If +manheaderlen is None (the default), wrap headers and other message +lines according to the policy settings.

    +

    If policy is specified, use that policy to control message generation. If +policy is None (the default), use the policy associated with the +Message or EmailMessage +object passed to flatten to control the message generation. See +email.policy for details on what policy controls.

    +
    +

    Changed in version 3.3: Added the policy keyword.

    +
    +
    +

    Changed in version 3.6: The default behavior of the mangle_from_ +and maxheaderlen parameters is to follow the policy.

    +
    +
    +
    +flatten(msg, unixfrom=False, linesep=None)
    +

    Print the textual representation of the message object structure rooted +at msg to the output file specified when the Generator +instance was created.

    +

    If the policy option cte_type +is 8bit, generate the message as if the option were set to 7bit. +(This is required because strings cannot represent non-ASCII bytes.) +Convert any bytes with the high bit set as needed using an +ASCII-compatible Content-Transfer-Encoding. That is, +transform parts with non-ASCII Content-Transfer-Encoding +(Content-Transfer-Encoding: 8bit) to an ASCII compatible +Content-Transfer-Encoding, and encode RFC-invalid non-ASCII +bytes in headers using the MIME unknown-8bit character set, thus +rendering them RFC-compliant.

    +

    If unixfrom is True, print the envelope header delimiter used by +the Unix mailbox format (see mailbox) before the first of the +RFC 5322 headers of the root message object. If the root object has +no envelope header, craft a standard one. The default is False. +Note that for subparts, no envelope header is ever printed.

    +

    If linesep is not None, use it as the separator character between +all the lines of the flattened message. If linesep is None (the +default), use the value specified in the policy.

    +
    +

    Changed in version 3.2: Added support for re-encoding 8bit message bodies, and the +linesep argument.

    +
    +
    + +
    +
    +clone(fp)
    +

    Return an independent clone of this Generator instance with the +exact same options, and fp as the new outfp.

    +
    + +
    +
    +write(s)
    +

    Write s to the write method of the outfp passed to the +Generator’s constructor. This provides just enough file-like +API for Generator instances to be used in the print() +function.

    +
    + +
    + +

    As a convenience, EmailMessage provides the methods +as_string() and str(aMessage) (a.k.a. +__str__()), which simplify the generation of +a formatted string representation of a message object. For more detail, see +email.message.

    +

    The email.generator module also provides a derived class, +DecodedGenerator, which is like the Generator base class, +except that non-text parts are not serialized, but are instead +represented in the output stream by a string derived from a template filled +in with information about the part.

    +
    +
    +class email.generator.DecodedGenerator(outfp, mangle_from_=None, maxheaderlen=None, fmt=None, *, policy=None)
    +

    Act like Generator, except that for any subpart of the message +passed to Generator.flatten(), if the subpart is of main type +text, print the decoded payload of the subpart, and if the main +type is not text, instead of printing it fill in the string +fmt using information from the part and print the resulting +filled-in string.

    +

    To fill in fmt, execute fmt % part_info, where part_info +is a dictionary composed of the following keys and values:

    +
      +
    • type – Full MIME type of the non-text part

    • +
    • maintype – Main MIME type of the non-text part

    • +
    • subtype – Sub-MIME type of the non-text part

    • +
    • filename – Filename of the non-text part

    • +
    • description – Description associated with the non-text part

    • +
    • encoding – Content transfer encoding of the non-text part

    • +
    +

    If fmt is None, use the following default fmt:

    +
    +

    “[Non-text (%(type)s) part of message omitted, filename %(filename)s]”

    +
    +

    Optional _mangle_from_ and maxheaderlen are as with the +Generator base class.

    +
    + +

    Footnotes

    +
    +
    1
    +

    This statement assumes that you use the appropriate setting for +unixfrom, and that there are no policy settings calling for +automatic adjustments (for example, +refold_source must be none, which is +not the default). It is also not 100% true, since if the message +does not conform to the RFC standards occasionally information about the +exact original text is lost during parsing error recovery. It is a goal +to fix these latter edge cases when possible.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/email.header.html b/python-3.7.4-docs-html/library/email.header.html new file mode 100644 index 0000000..3a29c87 --- /dev/null +++ b/python-3.7.4-docs-html/library/email.header.html @@ -0,0 +1,364 @@ + + + + + + + email.header: Internationalized headers — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    email.header: Internationalized headers

    +

    Source code: Lib/email/header.py

    +
    +

    This module is part of the legacy (Compat32) email API. In the current API +encoding and decoding of headers is handled transparently by the +dictionary-like API of the EmailMessage class. In +addition to uses in legacy code, this module can be useful in applications that +need to completely control the character sets used when encoding headers.

    +

    The remaining text in this section is the original documentation of the module.

    +

    RFC 2822 is the base standard that describes the format of email messages. +It derives from the older RFC 822 standard which came into widespread use at +a time when most email was composed of ASCII characters only. RFC 2822 is a +specification written assuming email contains only 7-bit ASCII characters.

    +

    Of course, as email has been deployed worldwide, it has become +internationalized, such that language specific character sets can now be used in +email messages. The base standard still requires email messages to be +transferred using only 7-bit ASCII characters, so a slew of RFCs have been +written describing how to encode email containing non-ASCII characters into +RFC 2822-compliant format. These RFCs include RFC 2045, RFC 2046, +RFC 2047, and RFC 2231. The email package supports these standards +in its email.header and email.charset modules.

    +

    If you want to include non-ASCII characters in your email headers, say in the +Subject or To fields, you should use the +Header class and assign the field in the Message +object to an instance of Header instead of using a string for the header +value. Import the Header class from the email.header module. +For example:

    +
    >>> from email.message import Message
    +>>> from email.header import Header
    +>>> msg = Message()
    +>>> h = Header('p\xf6stal', 'iso-8859-1')
    +>>> msg['Subject'] = h
    +>>> msg.as_string()
    +'Subject: =?iso-8859-1?q?p=F6stal?=\n\n'
    +
    +
    +

    Notice here how we wanted the Subject field to contain a non-ASCII +character? We did this by creating a Header instance and passing in +the character set that the byte string was encoded in. When the subsequent +Message instance was flattened, the Subject +field was properly RFC 2047 encoded. MIME-aware mail readers would show this +header using the embedded ISO-8859-1 character.

    +

    Here is the Header class description:

    +
    +
    +class email.header.Header(s=None, charset=None, maxlinelen=None, header_name=None, continuation_ws=' ', errors='strict')
    +

    Create a MIME-compliant header that can contain strings in different character +sets.

    +

    Optional s is the initial header value. If None (the default), the +initial header value is not set. You can later append to the header with +append() method calls. s may be an instance of bytes or +str, but see the append() documentation for semantics.

    +

    Optional charset serves two purposes: it has the same meaning as the charset +argument to the append() method. It also sets the default character set +for all subsequent append() calls that omit the charset argument. If +charset is not provided in the constructor (the default), the us-ascii +character set is used both as s’s initial charset and as the default for +subsequent append() calls.

    +

    The maximum line length can be specified explicitly via maxlinelen. For +splitting the first line to a shorter value (to account for the field header +which isn’t included in s, e.g. Subject) pass in the name of the +field in header_name. The default maxlinelen is 76, and the default value +for header_name is None, meaning it is not taken into account for the +first line of a long, split header.

    +

    Optional continuation_ws must be RFC 2822-compliant folding +whitespace, and is usually either a space or a hard tab character. This +character will be prepended to continuation lines. continuation_ws +defaults to a single space character.

    +

    Optional errors is passed straight through to the append() method.

    +
    +
    +append(s, charset=None, errors='strict')
    +

    Append the string s to the MIME header.

    +

    Optional charset, if given, should be a Charset +instance (see email.charset) or the name of a character set, which +will be converted to a Charset instance. A value +of None (the default) means that the charset given in the constructor +is used.

    +

    s may be an instance of bytes or str. If it is an +instance of bytes, then charset is the encoding of that byte +string, and a UnicodeError will be raised if the string cannot be +decoded with that character set.

    +

    If s is an instance of str, then charset is a hint specifying +the character set of the characters in the string.

    +

    In either case, when producing an RFC 2822-compliant header using +RFC 2047 rules, the string will be encoded using the output codec of +the charset. If the string cannot be encoded using the output codec, a +UnicodeError will be raised.

    +

    Optional errors is passed as the errors argument to the decode call +if s is a byte string.

    +
    + +
    +
    +encode(splitchars=';, \t', maxlinelen=None, linesep='\n')
    +

    Encode a message header into an RFC-compliant format, possibly wrapping +long lines and encapsulating non-ASCII parts in base64 or quoted-printable +encodings.

    +

    Optional splitchars is a string containing characters which should be +given extra weight by the splitting algorithm during normal header +wrapping. This is in very rough support of RFC 2822’s ‘higher level +syntactic breaks’: split points preceded by a splitchar are preferred +during line splitting, with the characters preferred in the order in +which they appear in the string. Space and tab may be included in the +string to indicate whether preference should be given to one over the +other as a split point when other split chars do not appear in the line +being split. Splitchars does not affect RFC 2047 encoded lines.

    +

    maxlinelen, if given, overrides the instance’s value for the maximum +line length.

    +

    linesep specifies the characters used to separate the lines of the +folded header. It defaults to the most useful value for Python +application code (\n), but \r\n can be specified in order +to produce headers with RFC-compliant line separators.

    +
    +

    Changed in version 3.2: Added the linesep argument.

    +
    +
    + +

    The Header class also provides a number of methods to support +standard operators and built-in functions.

    +
    +
    +__str__()
    +

    Returns an approximation of the Header as a string, using an +unlimited line length. All pieces are converted to unicode using the +specified encoding and joined together appropriately. Any pieces with a +charset of 'unknown-8bit' are decoded as ASCII using the 'replace' +error handler.

    +
    +

    Changed in version 3.2: Added handling for the 'unknown-8bit' charset.

    +
    +
    + +
    +
    +__eq__(other)
    +

    This method allows you to compare two Header instances for +equality.

    +
    + +
    +
    +__ne__(other)
    +

    This method allows you to compare two Header instances for +inequality.

    +
    + +
    + +

    The email.header module also provides the following convenient functions.

    +
    +
    +email.header.decode_header(header)
    +

    Decode a message header value without converting the character set. The header +value is in header.

    +

    This function returns a list of (decoded_string, charset) pairs containing +each of the decoded parts of the header. charset is None for non-encoded +parts of the header, otherwise a lower case string containing the name of the +character set specified in the encoded string.

    +

    Here’s an example:

    +
    >>> from email.header import decode_header
    +>>> decode_header('=?iso-8859-1?q?p=F6stal?=')
    +[(b'p\xf6stal', 'iso-8859-1')]
    +
    +
    +
    + +
    +
    +email.header.make_header(decoded_seq, maxlinelen=None, header_name=None, continuation_ws=' ')
    +

    Create a Header instance from a sequence of pairs as returned by +decode_header().

    +

    decode_header() takes a header value string and returns a sequence of +pairs of the format (decoded_string, charset) where charset is the name of +the character set.

    +

    This function takes one of those sequence of pairs and returns a +Header instance. Optional maxlinelen, header_name, and +continuation_ws are as in the Header constructor.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/email.headerregistry.html b/python-3.7.4-docs-html/library/email.headerregistry.html new file mode 100644 index 0000000..d2d158c --- /dev/null +++ b/python-3.7.4-docs-html/library/email.headerregistry.html @@ -0,0 +1,696 @@ + + + + + + + email.headerregistry: Custom Header Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    email.headerregistry: Custom Header Objects

    +

    Source code: Lib/email/headerregistry.py

    +
    +
    +

    New in version 3.6: 1

    +
    +

    Headers are represented by customized subclasses of str. The +particular class used to represent a given header is determined by the +header_factory of the policy in +effect when the headers are created. This section documents the particular +header_factory implemented by the email package for handling RFC 5322 +compliant email messages, which not only provides customized header objects for +various header types, but also provides an extension mechanism for applications +to add their own custom header types.

    +

    When using any of the policy objects derived from +EmailPolicy, all headers are produced by +HeaderRegistry and have BaseHeader as their last base +class. Each header class has an additional base class that is determined by +the type of the header. For example, many headers have the class +UnstructuredHeader as their other base class. The specialized second +class for a header is determined by the name of the header, using a lookup +table stored in the HeaderRegistry. All of this is managed +transparently for the typical application program, but interfaces are provided +for modifying the default behavior for use by more complex applications.

    +

    The sections below first document the header base classes and their attributes, +followed by the API for modifying the behavior of HeaderRegistry, and +finally the support classes used to represent the data parsed from structured +headers.

    +
    +
    +class email.headerregistry.BaseHeader(name, value)
    +

    name and value are passed to BaseHeader from the +header_factory call. The string value of +any header object is the value fully decoded to unicode.

    +

    This base class defines the following read-only properties:

    +
    +
    +name
    +

    The name of the header (the portion of the field before the ‘:’). This +is exactly the value passed in the +header_factory call for name; that +is, case is preserved.

    +
    + +
    +
    +defects
    +

    A tuple of HeaderDefect instances reporting any +RFC compliance problems found during parsing. The email package tries to +be complete about detecting compliance issues. See the errors +module for a discussion of the types of defects that may be reported.

    +
    + +
    +
    +max_count
    +

    The maximum number of headers of this type that can have the same +name. A value of None means unlimited. The BaseHeader value +for this attribute is None; it is expected that specialized header +classes will override this value as needed.

    +
    + +

    BaseHeader also provides the following method, which is called by the +email library code and should not in general be called by application +programs:

    +
    +
    +fold(*, policy)
    +

    Return a string containing linesep +characters as required to correctly fold the header according to +policy. A cte_type of 8bit will be +treated as if it were 7bit, since headers may not contain arbitrary +binary data. If utf8 is False, +non-ASCII data will be RFC 2047 encoded.

    +
    + +

    BaseHeader by itself cannot be used to create a header object. It +defines a protocol that each specialized header cooperates with in order to +produce the header object. Specifically, BaseHeader requires that +the specialized class provide a classmethod() named parse. This +method is called as follows:

    +
    parse(string, kwds)
    +
    +
    +

    kwds is a dictionary containing one pre-initialized key, defects. +defects is an empty list. The parse method should append any detected +defects to this list. On return, the kwds dictionary must contain +values for at least the keys decoded and defects. decoded +should be the string value for the header (that is, the header value fully +decoded to unicode). The parse method should assume that string may +contain content-transfer-encoded parts, but should correctly handle all valid +unicode characters as well so that it can parse un-encoded header values.

    +

    BaseHeader’s __new__ then creates the header instance, and calls its +init method. The specialized class only needs to provide an init +method if it wishes to set additional attributes beyond those provided by +BaseHeader itself. Such an init method should look like this:

    +
    def init(self, *args, **kw):
    +    self._myattr = kw.pop('myattr')
    +    super().init(*args, **kw)
    +
    +
    +

    That is, anything extra that the specialized class puts in to the kwds +dictionary should be removed and handled, and the remaining contents of +kw (and args) passed to the BaseHeader init method.

    +
    + +
    +
    +class email.headerregistry.UnstructuredHeader
    +

    An “unstructured” header is the default type of header in RFC 5322. +Any header that does not have a specified syntax is treated as +unstructured. The classic example of an unstructured header is the +Subject header.

    +

    In RFC 5322, an unstructured header is a run of arbitrary text in the +ASCII character set. RFC 2047, however, has an RFC 5322 compatible +mechanism for encoding non-ASCII text as ASCII characters within a header +value. When a value containing encoded words is passed to the +constructor, the UnstructuredHeader parser converts such encoded words +into unicode, following the RFC 2047 rules for unstructured text. The +parser uses heuristics to attempt to decode certain non-compliant encoded +words. Defects are registered in such cases, as well as defects for issues +such as invalid characters within the encoded words or the non-encoded text.

    +

    This header type provides no additional attributes.

    +
    + +
    +
    +class email.headerregistry.DateHeader
    +

    RFC 5322 specifies a very specific format for dates within email headers. +The DateHeader parser recognizes that date format, as well as +recognizing a number of variant forms that are sometimes found “in the +wild”.

    +

    This header type provides the following additional attributes:

    +
    +
    +datetime
    +

    If the header value can be recognized as a valid date of one form or +another, this attribute will contain a datetime +instance representing that date. If the timezone of the input date is +specified as -0000 (indicating it is in UTC but contains no +information about the source timezone), then datetime will be a +naive datetime. If a specific timezone offset is +found (including +0000), then datetime will contain an aware +datetime that uses datetime.timezone to record the timezone +offset.

    +
    + +

    The decoded value of the header is determined by formatting the +datetime according to the RFC 5322 rules; that is, it is set to:

    +
    email.utils.format_datetime(self.datetime)
    +
    +
    +

    When creating a DateHeader, value may be +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)
    +
    +
    +

    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 +more useful is to use the localtime() function from the +utils module:

    +
    msg['Date'] = utils.localtime()
    +
    +
    +

    This example sets the date header to the current time and date using +the current timezone offset.

    +
    + +
    +
    +class email.headerregistry.AddressHeader
    +

    Address headers are one of the most complex structured header types. +The AddressHeader class provides a generic interface to any address +header.

    +

    This header type provides the following additional attributes:

    +
    +
    +groups
    +

    A tuple of Group objects encoding the +addresses and groups found in the header value. Addresses that are +not part of a group are represented in this list as single-address +Groups whose display_name is None.

    +
    + +
    +
    +addresses
    +

    A tuple of Address objects encoding all +of the individual addresses from the header value. If the header value +contains any groups, the individual addresses from the group are included +in the list at the point where the group occurs in the value (that is, +the list of addresses is “flattened” into a one dimensional list).

    +
    + +

    The decoded value of the header will have all encoded words decoded to +unicode. idna encoded domain names are also decoded to +unicode. The decoded value is set by joining the +str value of the elements of the groups attribute with ', +'.

    +

    A list of Address and Group objects in any combination +may be used to set the value of an address header. Group objects whose +display_name is None will be interpreted as single addresses, which +allows an address list to be copied with groups intact by using the list +obtained from the groups attribute of the source header.

    +
    + +
    +
    +class email.headerregistry.SingleAddressHeader
    +

    A subclass of AddressHeader that adds one +additional attribute:

    +
    +
    +address
    +

    The single address encoded by the header value. If the header value +actually contains more than one address (which would be a violation of +the RFC under the default policy), accessing this attribute +will result in a ValueError.

    +
    + +
    + +

    Many of the above classes also have a Unique variant (for example, +UniqueUnstructuredHeader). The only difference is that in the Unique +variant, max_count is set to 1.

    +
    +
    +class email.headerregistry.MIMEVersionHeader
    +

    There is really only one valid value for the MIME-Version +header, and that is 1.0. For future proofing, this header class +supports other valid version numbers. If a version number has a valid value +per RFC 2045, then the header object will have non-None values for +the following attributes:

    +
    +
    +version
    +

    The version number as a string, with any whitespace and/or comments +removed.

    +
    + +
    +
    +major
    +

    The major version number as an integer

    +
    + +
    +
    +minor
    +

    The minor version number as an integer

    +
    + +
    + +
    +
    +class email.headerregistry.ParameterizedMIMEHeader
    +

    MIME headers all start with the prefix ‘Content-‘. Each specific header has +a certain value, described under the class for that header. Some can +also take a list of supplemental parameters, which have a common format. +This class serves as a base for all the MIME headers that take parameters.

    +
    +
    +params
    +

    A dictionary mapping parameter names to parameter values.

    +
    + +
    + +
    +
    +class email.headerregistry.ContentTypeHeader
    +

    A ParameterizedMIMEHeader class that handles the +Content-Type header.

    +
    +
    +content_type
    +

    The content type string, in the form maintype/subtype.

    +
    + +
    +
    +maintype
    +
    + +
    +
    +subtype
    +
    + +
    + +
    +
    +class email.headerregistry.ContentDispositionHeader
    +

    A ParameterizedMIMEHeader class that handles the +Content-Disposition header.

    +
    +
    +content-disposition
    +

    inline and attachment are the only valid values in common use.

    +
    + +
    + +
    +
    +class email.headerregistry.ContentTransferEncoding
    +

    Handles the Content-Transfer-Encoding header.

    +
    +
    +cte
    +

    Valid values are 7bit, 8bit, base64, and +quoted-printable. See RFC 2045 for more information.

    +
    + +
    + +
    +
    +class email.headerregistry.HeaderRegistry(base_class=BaseHeader, default_class=UnstructuredHeader, use_default_map=True)
    +

    This is the factory used by EmailPolicy by default. +HeaderRegistry builds the class used to create a header instance +dynamically, using base_class and a specialized class retrieved from a +registry that it holds. When a given header name does not appear in the +registry, the class specified by default_class is used as the specialized +class. When use_default_map is True (the default), the standard +mapping of header names to classes is copied in to the registry during +initialization. base_class is always the last class in the generated +class’s __bases__ list.

    +

    The default mappings are:

    +
    +
    +
    subject
    +

    UniqueUnstructuredHeader

    +
    +
    date
    +

    UniqueDateHeader

    +
    +
    resent-date
    +

    DateHeader

    +
    +
    orig-date
    +

    UniqueDateHeader

    +
    +
    sender
    +

    UniqueSingleAddressHeader

    +
    +
    resent-sender
    +

    SingleAddressHeader

    +
    +
    to
    +

    UniqueAddressHeader

    +
    +
    resent-to
    +

    AddressHeader

    +
    +
    cc
    +

    UniqueAddressHeader

    +
    +
    resent-cc
    +

    AddressHeader

    +
    +
    from
    +

    UniqueAddressHeader

    +
    +
    resent-from
    +

    AddressHeader

    +
    +
    reply-to
    +

    UniqueAddressHeader

    +
    +
    +
    +

    HeaderRegistry has the following methods:

    +
    +
    +map_to_type(self, name, cls)
    +

    name is the name of the header to be mapped. It will be converted to +lower case in the registry. cls is the specialized class to be used, +along with base_class, to create the class used to instantiate headers +that match name.

    +
    + +
    +
    +__getitem__(name)
    +

    Construct and return a class to handle creating a name header.

    +
    + +
    +
    +__call__(name, value)
    +

    Retrieves the specialized header associated with name from the +registry (using default_class if name does not appear in the +registry) and composes it with base_class to produce a class, +calls the constructed class’s constructor, passing it the same +argument list, and finally returns the class instance created thereby.

    +
    + +
    + +

    The following classes are the classes used to represent data parsed from +structured headers and can, in general, be used by an application program to +construct structured values to assign to specific headers.

    +
    +
    +class email.headerregistry.Address(display_name='', username='', domain='', addr_spec=None)
    +

    The class used to represent an email address. The general form of an +address is:

    +
    [display_name] <username@domain>
    +
    +
    +

    or:

    +
    username@domain
    +
    +
    +

    where each part must conform to specific syntax rules spelled out in +RFC 5322.

    +

    As a convenience addr_spec can be specified instead of username and +domain, in which case username and domain will be parsed from the +addr_spec. An addr_spec must be a properly RFC quoted string; if it is +not Address will raise an error. Unicode characters are allowed and +will be property encoded when serialized. However, per the RFCs, unicode is +not allowed in the username portion of the address.

    +
    +
    +display_name
    +

    The display name portion of the address, if any, with all quoting +removed. If the address does not have a display name, this attribute +will be an empty string.

    +
    + +
    +
    +username
    +

    The username portion of the address, with all quoting removed.

    +
    + +
    +
    +domain
    +

    The domain portion of the address.

    +
    + +
    +
    +addr_spec
    +

    The username@domain portion of the address, correctly quoted +for use as a bare address (the second form shown above). This +attribute is not mutable.

    +
    + +
    +
    +__str__()
    +

    The str value of the object is the address quoted according to +RFC 5322 rules, but with no Content Transfer Encoding of any non-ASCII +characters.

    +
    + +

    To support SMTP (RFC 5321), Address handles one special case: if +username and domain are both the empty string (or None), then +the string value of the Address is <>.

    +
    + +
    +
    +class email.headerregistry.Group(display_name=None, addresses=None)
    +

    The class used to represent an address group. The general form of an +address group is:

    +
    display_name: [address-list];
    +
    +
    +

    As a convenience for processing lists of addresses that consist of a mixture +of groups and single addresses, a Group may also be used to represent +single addresses that are not part of a group by setting display_name to +None and providing a list of the single address as addresses.

    +
    +
    +display_name
    +

    The display_name of the group. If it is None and there is +exactly one Address in addresses, then the Group represents a +single address that is not in a group.

    +
    + +
    +
    +addresses
    +

    A possibly empty tuple of Address objects representing the +addresses in the group.

    +
    + +
    +
    +__str__()
    +

    The str value of a Group is formatted according to RFC 5322, +but with no Content Transfer Encoding of any non-ASCII characters. If +display_name is none and there is a single Address in the +addresses list, the str value will be the same as the str of +that single Address.

    +
    + +
    + +

    Footnotes

    +
    +
    1
    +

    Originally added in 3.3 as a provisional module

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/email.html b/python-3.7.4-docs-html/library/email.html new file mode 100644 index 0000000..b67a871 --- /dev/null +++ b/python-3.7.4-docs-html/library/email.html @@ -0,0 +1,316 @@ + + + + + + + email — An email and MIME handling package — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    email — An email and MIME handling package

    +

    Source code: Lib/email/__init__.py

    +
    +

    The email package is a library for managing email messages. It is +specifically not designed to do any sending of email messages to SMTP +(RFC 2821), NNTP, or other servers; those are functions of modules such as +smtplib and nntplib. The email package attempts to be as +RFC-compliant as possible, supporting RFC 5233 and RFC 6532, as well as +such MIME-related RFCs as RFC 2045, RFC 2046, RFC 2047, RFC 2183, +and RFC 2231.

    +

    The overall structure of the email package can be divided into three major +components, plus a fourth component that controls the behavior of the other +components.

    +

    The central component of the package is an “object model” that represents email +messages. An application interacts with the package primarily through the +object model interface defined in the message sub-module. The +application can use this API to ask questions about an existing email, to +construct a new email, or to add or remove email subcomponents that themselves +use the same object model interface. That is, following the nature of email +messages and their MIME subcomponents, the email object model is a tree +structure of objects that all provide the EmailMessage +API.

    +

    The other two major components of the package are the parser and +the generator. The parser takes the serialized version of an +email message (a stream of bytes) and converts it into a tree of +EmailMessage objects. The generator takes an +EmailMessage and turns it back into a serialized byte +stream. (The parser and generator also handle streams of text characters, but +this usage is discouraged as it is too easy to end up with messages that are +not valid in one way or another.)

    +

    The control component is the policy module. Every +EmailMessage, every generator, and every +parser has an associated policy object that +controls its behavior. Usually an application only needs to specify the policy +when an EmailMessage is created, either by directly +instantiating an EmailMessage to create a new email, +or by parsing an input stream using a parser. But the policy can +be changed when the message is serialized using a generator. +This allows, for example, a generic email message to be parsed from disk, but +to serialize it using standard SMTP settings when sending it to an email +server.

    +

    The email package does its best to hide the details of the various governing +RFCs from the application. Conceptually the application should be able to +treat the email message as a structured tree of unicode text and binary +attachments, without having to worry about how these are represented when +serialized. In practice, however, it is often necessary to be aware of at +least some of the rules governing MIME messages and their structure, +specifically the names and nature of the MIME “content types” and how they +identify multipart documents. For the most part this knowledge should only be +required for more complex applications, and even then it should only be the +high level structure in question, and not the details of how those structures +are represented. Since MIME content types are used widely in modern internet +software (not just email), this will be a familiar concept to many programmers.

    +

    The following sections describe the functionality of the email package. +We start with the message object model, which is the primary +interface an application will use, and follow that with the +parser and generator components. Then we cover the +policy controls, which completes the treatment of the main +components of the library.

    +

    The next three sections cover the exceptions the package may raise and the +defects (non-compliance with the RFCs) that the parser may +detect. Then we cover the headerregistry and the +contentmanager sub-components, which provide tools for doing more +detailed manipulation of headers and payloads, respectively. Both of these +components contain features relevant to consuming and producing non-trivial +messages, but also document their extensibility APIs, which will be of interest +to advanced applications.

    +

    Following those is a set of examples of using the fundamental parts of the APIs +covered in the preceding sections.

    +

    The foregoing represent the modern (unicode friendly) API of the email package. +The remaining sections, starting with the Message +class, cover the legacy compat32 API that deals much more +directly with the details of how email messages are represented. The +compat32 API does not hide the details of the RFCs from +the application, but for applications that need to operate at that level, they +can be useful tools. This documentation is also relevant for applications that +are still using the compat32 API for backward +compatibility reasons.

    +
    +

    Changed in version 3.6: Docs reorganized and rewritten to promote the new +EmailMessage/EmailPolicy +API.

    +
    +

    Contents of the email package documentation:

    + +

    Legacy API:

    + +
    +

    See also

    +
    +
    Module smtplib

    SMTP (Simple Mail Transport Protocol) client

    +
    +
    Module poplib

    POP (Post Office Protocol) client

    +
    +
    Module imaplib

    IMAP (Internet Message Access Protocol) client

    +
    +
    Module nntplib

    NNTP (Net News Transport Protocol) client

    +
    +
    Module mailbox

    Tools for creating, reading, and managing collections of messages on disk +using a variety standard formats.

    +
    +
    Module smtpd

    SMTP server framework (primarily useful for testing)

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/email.iterators.html b/python-3.7.4-docs-html/library/email.iterators.html new file mode 100644 index 0000000..5d1ee7b --- /dev/null +++ b/python-3.7.4-docs-html/library/email.iterators.html @@ -0,0 +1,246 @@ + + + + + + + email.iterators: Iterators — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    email.iterators: Iterators

    +

    Source code: Lib/email/iterators.py

    +
    +

    Iterating over a message object tree is fairly easy with the +Message.walk method. The +email.iterators module provides some useful higher level iterations over +message object trees.

    +
    +
    +email.iterators.body_line_iterator(msg, decode=False)
    +

    This iterates over all the payloads in all the subparts of msg, returning the +string payloads line-by-line. It skips over all the subpart headers, and it +skips over any subpart with a payload that isn’t a Python string. This is +somewhat equivalent to reading the flat text representation of the message from +a file using readline(), skipping over all the +intervening headers.

    +

    Optional decode is passed through to Message.get_payload.

    +
    + +
    +
    +email.iterators.typed_subpart_iterator(msg, maintype='text', subtype=None)
    +

    This iterates over all the subparts of msg, returning only those subparts that +match the MIME type specified by maintype and subtype.

    +

    Note that subtype is optional; if omitted, then subpart MIME type matching is +done only with the main type. maintype is optional too; it defaults to +text.

    +

    Thus, by default typed_subpart_iterator() returns each subpart that has a +MIME type of text/*.

    +
    + +

    The following function has been added as a useful debugging tool. It should +not be considered part of the supported public interface for the package.

    +
    +
    +email.iterators._structure(msg, fp=None, level=0, include_default=False)
    +

    Prints an indented representation of the content types of the message object +structure. For example:

    +
    >>> msg = email.message_from_file(somefile)
    +>>> _structure(msg)
    +multipart/mixed
    +    text/plain
    +    text/plain
    +    multipart/digest
    +        message/rfc822
    +            text/plain
    +        message/rfc822
    +            text/plain
    +        message/rfc822
    +            text/plain
    +        message/rfc822
    +            text/plain
    +        message/rfc822
    +            text/plain
    +    text/plain
    +
    +
    +

    Optional fp is a file-like object to print the output to. It must be +suitable for Python’s print() function. level is used internally. +include_default, if true, prints the default type as well.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/email.message.html b/python-3.7.4-docs-html/library/email.message.html new file mode 100644 index 0000000..011d76b --- /dev/null +++ b/python-3.7.4-docs-html/library/email.message.html @@ -0,0 +1,931 @@ + + + + + + + email.message: Representing an email message — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    email.message: Representing an email message

    +

    Source code: Lib/email/message.py

    +
    +
    +

    New in version 3.6: 1

    +
    +

    The central class in the email package is the EmailMessage +class, imported from the email.message module. It is the base class for +the email object model. EmailMessage provides the core +functionality for setting and querying header fields, for accessing message +bodies, and for creating or modifying structured messages.

    +

    An email message consists of headers and a payload (which is also referred +to as the content). Headers are RFC 5322 or RFC 6532 style field names +and values, where the field name and value are separated by a colon. The colon +is not part of either the field name or the field value. The payload may be a +simple text message, or a binary object, or a structured sequence of +sub-messages each with their own set of headers and their own payload. The +latter type of payload is indicated by the message having a MIME type such as +multipart/* or message/rfc822.

    +

    The conceptual model provided by an EmailMessage object is that of an +ordered dictionary of headers coupled with a payload that represents the +RFC 5322 body of the message, which might be a list of sub-EmailMessage +objects. In addition to the normal dictionary methods for accessing the header +names and values, there are methods for accessing specialized information from +the headers (for example the MIME content type), for operating on the payload, +for generating a serialized version of the message, and for recursively walking +over the object tree.

    +

    The EmailMessage dictionary-like interface is indexed by the header +names, which must be ASCII values. The values of the dictionary are strings +with some extra methods. Headers are stored and returned in case-preserving +form, but field names are matched case-insensitively. Unlike a real dict, +there is an ordering to the keys, and there can be duplicate keys. Additional +methods are provided for working with headers that have duplicate keys.

    +

    The payload is either a string or bytes object, in the case of simple message +objects, or a list of EmailMessage objects, for MIME container +documents such as multipart/* and message/rfc822 +message objects.

    +
    +
    +class email.message.EmailMessage(policy=default)
    +

    If policy is specified use the rules it specifies to update and serialize +the representation of the message. If policy is not set, use the +default policy, which follows the rules of the email +RFCs except for line endings (instead of the RFC mandated \r\n, it uses +the Python standard \n line endings). For more information see the +policy documentation.

    +
    +
    +as_string(unixfrom=False, maxheaderlen=None, policy=None)
    +

    Return the entire message flattened as a string. When optional +unixfrom is true, the envelope header is included in the returned +string. unixfrom defaults to False. For backward compatibility +with the base Message class maxheaderlen is +accepted, but defaults to None, which means that by default the line +length is controlled by the +max_line_length of the policy. The +policy argument may be used to override the default policy obtained +from the message instance. This can be used to control some of the +formatting produced by the method, since the specified policy will be +passed to the Generator.

    +

    Flattening the message may trigger changes to the EmailMessage +if defaults need to be filled in to complete the transformation to a +string (for example, MIME boundaries may be generated or modified).

    +

    Note that this method is provided as a convenience and may not be the +most useful way to serialize messages in your application, especially if +you are dealing with multiple messages. See +email.generator.Generator for a more flexible API for +serializing messages. Note also that this method is restricted to +producing messages serialized as “7 bit clean” when +utf8 is False, which is the default.

    +
    +

    Changed in version 3.6: the default behavior when maxheaderlen +is not specified was changed from defaulting to 0 to defaulting +to the value of max_line_length from the policy.

    +
    +
    + +
    +
    +__str__()
    +

    Equivalent to as_string(policy=self.policy.clone(utf8=True)). Allows +str(msg) to produce a string containing the serialized message in a +readable format.

    +
    +

    Changed in version 3.4: the method was changed to use utf8=True, +thus producing an RFC 6531-like message representation, instead of +being a direct alias for as_string().

    +
    +
    + +
    +
    +as_bytes(unixfrom=False, policy=None)
    +

    Return the entire message flattened as a bytes object. When optional +unixfrom is true, the envelope header is included in the returned +string. unixfrom defaults to False. The policy argument may be +used to override the default policy obtained from the message instance. +This can be used to control some of the formatting produced by the +method, since the specified policy will be passed to the +BytesGenerator.

    +

    Flattening the message may trigger changes to the EmailMessage +if defaults need to be filled in to complete the transformation to a +string (for example, MIME boundaries may be generated or modified).

    +

    Note that this method is provided as a convenience and may not be the +most useful way to serialize messages in your application, especially if +you are dealing with multiple messages. See +email.generator.BytesGenerator for a more flexible API for +serializing messages.

    +
    + +
    +
    +__bytes__()
    +

    Equivalent to as_bytes(). Allows bytes(msg) to produce a +bytes object containing the serialized message.

    +
    + +
    +
    +is_multipart()
    +

    Return True if the message’s payload is a list of +sub-EmailMessage objects, otherwise return False. When +is_multipart() returns False, the payload should be a string +object (which might be a CTE encoded binary payload). Note that +is_multipart() returning True does not necessarily mean that +“msg.get_content_maintype() == ‘multipart’” will return the True. +For example, is_multipart will return True when the +EmailMessage is of type message/rfc822.

    +
    + +
    +
    +set_unixfrom(unixfrom)
    +

    Set the message’s envelope header to unixfrom, which should be a +string. (See mboxMessage for a brief description of +this header.)

    +
    + +
    +
    +get_unixfrom()
    +

    Return the message’s envelope header. Defaults to None if the +envelope header was never set.

    +
    + +

    The following methods implement the mapping-like interface for accessing the +message’s headers. Note that there are some semantic differences +between these methods and a normal mapping (i.e. dictionary) interface. For +example, in a dictionary there are no duplicate keys, but here there may be +duplicate message headers. Also, in dictionaries there is no guaranteed +order to the keys returned by keys(), but in an EmailMessage +object, headers are always returned in the order they appeared in the +original message, or in which they were added to the message later. Any +header deleted and then re-added is always appended to the end of the +header list.

    +

    These semantic differences are intentional and are biased toward +convenience in the most common use cases.

    +

    Note that in all cases, any envelope header present in the message is not +included in the mapping interface.

    +
    +
    +__len__()
    +

    Return the total number of headers, including duplicates.

    +
    + +
    +
    +__contains__(name)
    +

    Return true if the message object has a field named name. Matching is +done without regard to case and name does not include the trailing +colon. Used for the in operator. For example:

    +
    if 'message-id' in myMessage:
    +   print('Message-ID:', myMessage['message-id'])
    +
    +
    +
    + +
    +
    +__getitem__(name)
    +

    Return the value of the named header field. name does not include the +colon field separator. If the header is missing, None is returned; a +KeyError is never raised.

    +

    Note that if the named field appears more than once in the message’s +headers, exactly which of those field values will be returned is +undefined. Use the get_all() method to get the values of all the +extant headers named name.

    +

    Using the standard (non-compat32) policies, the returned value is an +instance of a subclass of email.headerregistry.BaseHeader.

    +
    + +
    +
    +__setitem__(name, val)
    +

    Add a header to the message with field name name and value val. The +field is appended to the end of the message’s existing headers.

    +

    Note that this does not overwrite or delete any existing header with the same +name. If you want to ensure that the new header is the only one present in the +message with field name name, delete the field first, e.g.:

    +
    del msg['subject']
    +msg['subject'] = 'Python roolz!'
    +
    +
    +

    If the policy defines certain headers to be unique (as the standard +policies do), this method may raise a ValueError when an attempt +is made to assign a value to such a header when one already exists. This +behavior is intentional for consistency’s sake, but do not depend on it +as we may choose to make such assignments do an automatic deletion of the +existing header in the future.

    +
    + +
    +
    +__delitem__(name)
    +

    Delete all occurrences of the field with name name from the message’s +headers. No exception is raised if the named field isn’t present in the +headers.

    +
    + +
    +
    +keys()
    +

    Return a list of all the message’s header field names.

    +
    + +
    +
    +values()
    +

    Return a list of all the message’s field values.

    +
    + +
    +
    +items()
    +

    Return a list of 2-tuples containing all the message’s field headers and +values.

    +
    + +
    +
    +get(name, failobj=None)
    +

    Return the value of the named header field. This is identical to +__getitem__() except that optional failobj is returned if the +named header is missing (failobj defaults to None).

    +
    + +

    Here are some additional useful header related methods:

    +
    +
    +get_all(name, failobj=None)
    +

    Return a list of all the values for the field named name. If there are +no such named headers in the message, failobj is returned (defaults to +None).

    +
    + +
    +
    +add_header(_name, _value, **_params)
    +

    Extended header setting. This method is similar to __setitem__() +except that additional header parameters can be provided as keyword +arguments. _name is the header field to add and _value is the +primary value for the header.

    +

    For each item in the keyword argument dictionary _params, the key is +taken as the parameter name, with underscores converted to dashes (since +dashes are illegal in Python identifiers). Normally, the parameter will +be added as key="value" unless the value is None, in which case +only the key will be added.

    +

    If the value contains non-ASCII characters, the charset and language may +be explicitly controlled by specifying the value as a three tuple in the +format (CHARSET, LANGUAGE, VALUE), where CHARSET is a string +naming the charset to be used to encode the value, LANGUAGE can +usually be set to None or the empty string (see RFC 2231 for other +possibilities), and VALUE is the string value containing non-ASCII +code points. If a three tuple is not passed and the value contains +non-ASCII characters, it is automatically encoded in RFC 2231 format +using a CHARSET of utf-8 and a LANGUAGE of None.

    +

    Here is an example:

    +
    msg.add_header('Content-Disposition', 'attachment', filename='bud.gif')
    +
    +
    +

    This will add a header that looks like

    +
    Content-Disposition: attachment; filename="bud.gif"
    +
    +
    +

    An example of the extended interface with non-ASCII characters:

    +
    msg.add_header('Content-Disposition', 'attachment',
    +               filename=('iso-8859-1', '', 'Fußballer.ppt'))
    +
    +
    +
    + +
    +
    +replace_header(_name, _value)
    +

    Replace a header. Replace the first header found in the message that +matches _name, retaining header order and field name case of the +original header. If no matching header is found, raise a +KeyError.

    +
    + +
    +
    +get_content_type()
    +

    Return the message’s content type, coerced to lower case of the form +maintype/subtype. If there is no Content-Type +header in the message return the value returned by +get_default_type(). If the Content-Type header is +invalid, return text/plain.

    +

    (According to RFC 2045, messages always have a default type, +get_content_type() will always return a value. RFC 2045 defines +a message’s default type to be text/plain unless it appears +inside a multipart/digest container, in which case it would +be message/rfc822. If the Content-Type header +has an invalid type specification, RFC 2045 mandates that the default +type be text/plain.)

    +
    + +
    +
    +get_content_maintype()
    +

    Return the message’s main content type. This is the maintype +part of the string returned by get_content_type().

    +
    + +
    +
    +get_content_subtype()
    +

    Return the message’s sub-content type. This is the subtype +part of the string returned by get_content_type().

    +
    + +
    +
    +get_default_type()
    +

    Return the default content type. Most messages have a default content +type of text/plain, except for messages that are subparts of +multipart/digest containers. Such subparts have a default +content type of message/rfc822.

    +
    + +
    +
    +set_default_type(ctype)
    +

    Set the default content type. ctype should either be +text/plain or message/rfc822, although this is +not enforced. The default content type is not stored in the +Content-Type header, so it only affects the return value of +the get_content_type methods when no Content-Type +header is present in the message.

    +
    + +
    +
    +set_param(param, value, header='Content-Type', requote=True, charset=None, language='', replace=False)
    +

    Set a parameter in the Content-Type header. If the +parameter already exists in the header, replace its value with value. +When header is Content-Type (the default) and the header does not +yet exist in the message, add it, set its value to +text/plain, and append the new parameter value. Optional +header specifies an alternative header to Content-Type.

    +

    If the value contains non-ASCII characters, the charset and language may +be explicitly specified using the optional charset and language +parameters. Optional language specifies the RFC 2231 language, +defaulting to the empty string. Both charset and language should be +strings. The default is to use the utf8 charset and None for +the language.

    +

    If replace is False (the default) the header is moved to the +end of the list of headers. If replace is True, the header +will be updated in place.

    +

    Use of the requote parameter with EmailMessage objects is +deprecated.

    +

    Note that existing parameter values of headers may be accessed through +the params attribute of the +header value (for example, msg['Content-Type'].params['charset']).

    +
    +

    Changed in version 3.4: replace keyword was added.

    +
    +
    + +
    +
    +del_param(param, header='content-type', requote=True)
    +

    Remove the given parameter completely from the Content-Type +header. The header will be re-written in place without the parameter or +its value. Optional header specifies an alternative to +Content-Type.

    +

    Use of the requote parameter with EmailMessage objects is +deprecated.

    +
    + +
    +
    +get_filename(failobj=None)
    +

    Return the value of the filename parameter of the +Content-Disposition header of the message. If the header +does not have a filename parameter, this method falls back to looking +for the name parameter on the Content-Type header. If +neither is found, or the header is missing, then failobj is returned. +The returned string will always be unquoted as per +email.utils.unquote().

    +
    + +
    +
    +get_boundary(failobj=None)
    +

    Return the value of the boundary parameter of the +Content-Type header of the message, or failobj if either +the header is missing, or has no boundary parameter. The returned +string will always be unquoted as per email.utils.unquote().

    +
    + +
    +
    +set_boundary(boundary)
    +

    Set the boundary parameter of the Content-Type header to +boundary. set_boundary() will always quote boundary if +necessary. A HeaderParseError is raised if the +message object has no Content-Type header.

    +

    Note that using this method is subtly different from deleting the old +Content-Type header and adding a new one with the new +boundary via add_header(), because set_boundary() preserves +the order of the Content-Type header in the list of +headers.

    +
    + +
    +
    +get_content_charset(failobj=None)
    +

    Return the charset parameter of the Content-Type header, +coerced to lower case. If there is no Content-Type header, or if +that header has no charset parameter, failobj is returned.

    +
    + +
    +
    +get_charsets(failobj=None)
    +

    Return a list containing the character set names in the message. If the +message is a multipart, then the list will contain one element +for each subpart in the payload, otherwise, it will be a list of length 1.

    +

    Each item in the list will be a string which is the value of the +charset parameter in the Content-Type header for the +represented subpart. If the subpart has no Content-Type +header, no charset parameter, or is not of the text main +MIME type, then that item in the returned list will be failobj.

    +
    + +
    +
    +is_attachment()
    +

    Return True if there is a Content-Disposition header +and its (case insensitive) value is attachment, False otherwise.

    +
    +

    Changed in version 3.4.2: is_attachment is now a method instead of a property, for consistency +with is_multipart().

    +
    +
    + +
    +
    +get_content_disposition()
    +

    Return the lowercased value (without parameters) of the message’s +Content-Disposition header if it has one, or None. The +possible values for this method are inline, attachment or None +if the message follows RFC 2183.

    +
    +

    New in version 3.5.

    +
    +
    + +

    The following methods relate to interrogating and manipulating the content +(payload) of the message.

    +
    +
    +walk()
    +

    The walk() method is an all-purpose generator which can be used to +iterate over all the parts and subparts of a message object tree, in +depth-first traversal order. You will typically use walk() as the +iterator in a for loop; each iteration returns the next subpart.

    +

    Here’s an example that prints the MIME type of every part of a multipart +message structure:

    +
    >>> for part in msg.walk():
    +...     print(part.get_content_type())
    +multipart/report
    +text/plain
    +message/delivery-status
    +text/plain
    +text/plain
    +message/rfc822
    +text/plain
    +
    +
    +

    walk iterates over the subparts of any part where +is_multipart() returns True, even though +msg.get_content_maintype() == 'multipart' may return False. We +can see this in our example by making use of the _structure debug +helper function:

    +
    >>> for part in msg.walk():
    +...     print(part.get_content_maintype() == 'multipart',
    +...           part.is_multipart())
    +True True
    +False False
    +False True
    +False False
    +False False
    +False True
    +False False
    +>>> _structure(msg)
    +multipart/report
    +    text/plain
    +    message/delivery-status
    +        text/plain
    +        text/plain
    +    message/rfc822
    +        text/plain
    +
    +
    +

    Here the message parts are not multiparts, but they do contain +subparts. is_multipart() returns True and walk descends +into the subparts.

    +
    + +
    +
    +get_body(preferencelist=('related', 'html', 'plain'))
    +

    Return the MIME part that is the best candidate to be the “body” of the +message.

    +

    preferencelist must be a sequence of strings from the set related, +html, and plain, and indicates the order of preference for the +content type of the part returned.

    +

    Start looking for candidate matches with the object on which the +get_body method is called.

    +

    If related is not included in preferencelist, consider the root +part (or subpart of the root part) of any related encountered as a +candidate if the (sub-)part matches a preference.

    +

    When encountering a multipart/related, check the start parameter +and if a part with a matching Content-ID is found, consider +only it when looking for candidate matches. Otherwise consider only the +first (default root) part of the multipart/related.

    +

    If a part has a Content-Disposition header, only consider +the part a candidate match if the value of the header is inline.

    +

    If none of the candidates matches any of the preferences in +preferencelist, return None.

    +

    Notes: (1) For most applications the only preferencelist combinations +that really make sense are ('plain',), ('html', 'plain'), and the +default ('related', 'html', 'plain'). (2) Because matching starts +with the object on which get_body is called, calling get_body on +a multipart/related will return the object itself unless +preferencelist has a non-default value. (3) Messages (or message parts) +that do not specify a Content-Type or whose +Content-Type header is invalid will be treated as if they +are of type text/plain, which may occasionally cause get_body to +return unexpected results.

    +
    + +
    +
    +iter_attachments()
    +

    Return an iterator over all of the immediate sub-parts of the message +that are not candidate “body” parts. That is, skip the first occurrence +of each of text/plain, text/html, multipart/related, or +multipart/alternative (unless they are explicitly marked as +attachments via Content-Disposition: attachment), and +return all remaining parts. When applied directly to a +multipart/related, return an iterator over the all the related parts +except the root part (ie: the part pointed to by the start parameter, +or the first part if there is no start parameter or the start +parameter doesn’t match the Content-ID of any of the +parts). When applied directly to a multipart/alternative or a +non-multipart, return an empty iterator.

    +
    + +
    +
    +iter_parts()
    +

    Return an iterator over all of the immediate sub-parts of the message, +which will be empty for a non-multipart. (See also +walk().)

    +
    + +
    +
    +get_content(*args, content_manager=None, **kw)
    +

    Call the get_content() method +of the content_manager, passing self as the message object, and passing +along any other arguments or keywords as additional arguments. If +content_manager is not specified, use the content_manager specified +by the current policy.

    +
    + +
    +
    +set_content(*args, content_manager=None, **kw)
    +

    Call the set_content() method +of the content_manager, passing self as the message object, and passing +along any other arguments or keywords as additional arguments. If +content_manager is not specified, use the content_manager specified +by the current policy.

    +
    + +
    + +

    Convert a non-multipart message into a multipart/related message, +moving any existing Content- headers and payload into a +(new) first part of the multipart. If boundary is specified, use +it as the boundary string in the multipart, otherwise leave the boundary +to be automatically created when it is needed (for example, when the +message is serialized).

    +
    + +
    +
    +make_alternative(boundary=None)
    +

    Convert a non-multipart or a multipart/related into a +multipart/alternative, moving any existing Content- +headers and payload into a (new) first part of the multipart. If +boundary is specified, use it as the boundary string in the multipart, +otherwise leave the boundary to be automatically created when it is +needed (for example, when the message is serialized).

    +
    + +
    +
    +make_mixed(boundary=None)
    +

    Convert a non-multipart, a multipart/related, or a +multipart-alternative into a multipart/mixed, moving any existing +Content- headers and payload into a (new) first part of the +multipart. If boundary is specified, use it as the boundary string +in the multipart, otherwise leave the boundary to be automatically +created when it is needed (for example, when the message is serialized).

    +
    + +
    + +

    If the message is a multipart/related, create a new message +object, pass all of the arguments to its set_content() method, +and attach() it to the multipart. If +the message is a non-multipart, call make_related() and then +proceed as above. If the message is any other type of multipart, +raise a TypeError. If content_manager is not specified, use +the content_manager specified by the current policy. +If the added part has no Content-Disposition header, +add one with the value inline.

    +
    + +
    +
    +add_alternative(*args, content_manager=None, **kw)
    +

    If the message is a multipart/alternative, create a new message +object, pass all of the arguments to its set_content() method, and +attach() it to the multipart. If the +message is a non-multipart or multipart/related, call +make_alternative() and then proceed as above. If the message is +any other type of multipart, raise a TypeError. If +content_manager is not specified, use the content_manager specified +by the current policy.

    +
    + +
    +
    +add_attachment(*args, content_manager=None, **kw)
    +

    If the message is a multipart/mixed, create a new message object, +pass all of the arguments to its set_content() method, and +attach() it to the multipart. If the +message is a non-multipart, multipart/related, or +multipart/alternative, call make_mixed() and then proceed as +above. If content_manager is not specified, use the content_manager +specified by the current policy. If the added part +has no Content-Disposition header, add one with the value +attachment. This method can be used both for explicit attachments +(Content-Disposition: attachment) and inline attachments +(Content-Disposition: inline), by passing appropriate +options to the content_manager.

    +
    + +
    +
    +clear()
    +

    Remove the payload and all of the headers.

    +
    + +
    +
    +clear_content()
    +

    Remove the payload and all of the Content- headers, leaving +all other headers intact and in their original order.

    +
    + +

    EmailMessage objects have the following instance attributes:

    +
    +
    +preamble
    +

    The format of a MIME document allows for some text between the blank line +following the headers, and the first multipart boundary string. Normally, +this text is never visible in a MIME-aware mail reader because it falls +outside the standard MIME armor. However, when viewing the raw text of +the message, or when viewing the message in a non-MIME aware reader, this +text can become visible.

    +

    The preamble attribute contains this leading extra-armor text for MIME +documents. When the Parser discovers some text +after the headers but before the first boundary string, it assigns this +text to the message’s preamble attribute. When the +Generator is writing out the plain text +representation of a MIME message, and it finds the +message has a preamble attribute, it will write this text in the area +between the headers and the first boundary. See email.parser and +email.generator for details.

    +

    Note that if the message object has no preamble, the preamble attribute +will be None.

    +
    + +
    +
    +epilogue
    +

    The epilogue attribute acts the same way as the preamble attribute, +except that it contains text that appears between the last boundary and +the end of the message. As with the preamble, +if there is no epilog text this attribute will be None.

    +
    + +
    +
    +defects
    +

    The defects attribute contains a list of all the problems found when +parsing this message. See email.errors for a detailed description +of the possible parsing defects.

    +
    + +
    + +
    +
    +class email.message.MIMEPart(policy=default)
    +

    This class represents a subpart of a MIME message. It is identical to +EmailMessage, except that no MIME-Version headers are +added when set_content() is called, since sub-parts do +not need their own MIME-Version headers.

    +
    + +

    Footnotes

    +
    +
    1
    +

    Originally added in 3.4 as a provisional module. Docs for legacy message class moved to +email.message.Message: Representing an email message using the compat32 API.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/email.mime.html b/python-3.7.4-docs-html/library/email.mime.html new file mode 100644 index 0000000..f0bb732 --- /dev/null +++ b/python-3.7.4-docs-html/library/email.mime.html @@ -0,0 +1,394 @@ + + + + + + + email.mime: Creating email and MIME objects from scratch — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    email.mime: Creating email and MIME objects from scratch

    +

    Source code: Lib/email/mime/

    +
    +

    This module is part of the legacy (Compat32) email API. Its functionality +is partially replaced by the contentmanager in the new API, but +in certain applications these classes may still be useful, even in non-legacy +code.

    +

    Ordinarily, you get a message object structure by passing a file or some text to +a parser, which parses the text and returns the root message object. However +you can also build a complete message structure from scratch, or even individual +Message objects by hand. In fact, you can also take an +existing structure and add new Message objects, move them +around, etc. This makes a very convenient interface for slicing-and-dicing MIME +messages.

    +

    You can create a new object structure by creating Message +instances, adding attachments and all the appropriate headers manually. For MIME +messages though, the email package provides some convenient subclasses to +make things easier.

    +

    Here are the classes:

    +
    +
    +class email.mime.base.MIMEBase(_maintype, _subtype, *, policy=compat32, **_params)
    +

    Module: email.mime.base

    +

    This is the base class for all the MIME-specific subclasses of +Message. Ordinarily you won’t create instances +specifically of MIMEBase, although you could. MIMEBase +is provided primarily as a convenient base class for more specific +MIME-aware subclasses.

    +

    _maintype is the Content-Type major type (e.g. text +or image), and _subtype is the Content-Type minor +type (e.g. plain or gif). _params is a parameter +key/value dictionary and is passed directly to Message.add_header.

    +

    If policy is specified, (defaults to the +compat32 policy) it will be passed to +Message.

    +

    The MIMEBase class always adds a Content-Type header +(based on _maintype, _subtype, and _params), and a +MIME-Version header (always set to 1.0).

    +
    +

    Changed in version 3.6: Added policy keyword-only parameter.

    +
    +
    + +
    +
    +class email.mime.nonmultipart.MIMENonMultipart
    +

    Module: email.mime.nonmultipart

    +

    A subclass of MIMEBase, this is an intermediate base +class for MIME messages that are not multipart. The primary +purpose of this class is to prevent the use of the +attach() method, which only makes sense for +multipart messages. If attach() +is called, a MultipartConversionError exception is raised.

    +
    + +
    +
    +class email.mime.multipart.MIMEMultipart(_subtype='mixed', boundary=None, _subparts=None, *, policy=compat32, **_params)
    +

    Module: email.mime.multipart

    +

    A subclass of MIMEBase, this is an intermediate base +class for MIME messages that are multipart. Optional _subtype +defaults to mixed, but can be used to specify the subtype of the +message. A Content-Type header of multipart/_subtype +will be added to the message object. A MIME-Version header will +also be added.

    +

    Optional boundary is the multipart boundary string. When None (the +default), the boundary is calculated when needed (for example, when the +message is serialized).

    +

    _subparts is a sequence of initial subparts for the payload. It must be +possible to convert this sequence to a list. You can always attach new subparts +to the message by using the Message.attach method.

    +

    Optional policy argument defaults to compat32.

    +

    Additional parameters for the Content-Type header are taken from +the keyword arguments, or passed into the _params argument, which is a keyword +dictionary.

    +
    +

    Changed in version 3.6: Added policy keyword-only parameter.

    +
    +
    + +
    +
    +class email.mime.application.MIMEApplication(_data, _subtype='octet-stream', _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)
    +

    Module: email.mime.application

    +

    A subclass of MIMENonMultipart, the +MIMEApplication class is used to represent MIME message objects of +major type application. _data is a string containing the raw +byte data. Optional _subtype specifies the MIME subtype and defaults to +octet-stream.

    +

    Optional _encoder is a callable (i.e. function) which will perform the actual +encoding of the data for transport. This callable takes one argument, which is +the MIMEApplication instance. It should use +get_payload() and +set_payload() to change the payload to encoded +form. It should also add +any Content-Transfer-Encoding or other headers to the message +object as necessary. The default encoding is base64. See the +email.encoders module for a list of the built-in encoders.

    +

    Optional policy argument defaults to compat32.

    +

    _params are passed straight through to the base class constructor.

    +
    +

    Changed in version 3.6: Added policy keyword-only parameter.

    +
    +
    + +
    +
    +class email.mime.audio.MIMEAudio(_audiodata, _subtype=None, _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)
    +

    Module: email.mime.audio

    +

    A subclass of MIMENonMultipart, the +MIMEAudio class is used to create MIME message objects of major type +audio. _audiodata is a string containing the raw audio data. If +this data can be decoded by the standard Python module sndhdr, then the +subtype will be automatically included in the Content-Type header. +Otherwise you can explicitly specify the audio subtype via the _subtype +argument. If the minor type could not be guessed and _subtype was not given, +then TypeError is raised.

    +

    Optional _encoder is a callable (i.e. function) which will perform the actual +encoding of the audio data for transport. This callable takes one argument, +which is the MIMEAudio instance. It should use +get_payload() and +set_payload() to change the payload to encoded +form. It should also add +any Content-Transfer-Encoding or other headers to the message +object as necessary. The default encoding is base64. See the +email.encoders module for a list of the built-in encoders.

    +

    Optional policy argument defaults to compat32.

    +

    _params are passed straight through to the base class constructor.

    +
    +

    Changed in version 3.6: Added policy keyword-only parameter.

    +
    +
    + +
    +
    +class email.mime.image.MIMEImage(_imagedata, _subtype=None, _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)
    +

    Module: email.mime.image

    +

    A subclass of MIMENonMultipart, the +MIMEImage class is used to create MIME message objects of major type +image. _imagedata is a string containing the raw image data. If +this data can be decoded by the standard Python module imghdr, then the +subtype will be automatically included in the Content-Type header. +Otherwise you can explicitly specify the image subtype via the _subtype +argument. If the minor type could not be guessed and _subtype was not given, +then TypeError is raised.

    +

    Optional _encoder is a callable (i.e. function) which will perform the actual +encoding of the image data for transport. This callable takes one argument, +which is the MIMEImage instance. It should use +get_payload() and +set_payload() to change the payload to encoded +form. It should also add +any Content-Transfer-Encoding or other headers to the message +object as necessary. The default encoding is base64. See the +email.encoders module for a list of the built-in encoders.

    +

    Optional policy argument defaults to compat32.

    +

    _params are passed straight through to the MIMEBase +constructor.

    +
    +

    Changed in version 3.6: Added policy keyword-only parameter.

    +
    +
    + +
    +
    +class email.mime.message.MIMEMessage(_msg, _subtype='rfc822', *, policy=compat32)
    +

    Module: email.mime.message

    +

    A subclass of MIMENonMultipart, the +MIMEMessage class is used to create MIME objects of main type +message. _msg is used as the payload, and must be an instance +of class Message (or a subclass thereof), otherwise +a TypeError is raised.

    +

    Optional _subtype sets the subtype of the message; it defaults to +rfc822.

    +

    Optional policy argument defaults to compat32.

    +
    +

    Changed in version 3.6: Added policy keyword-only parameter.

    +
    +
    + +
    +
    +class email.mime.text.MIMEText(_text, _subtype='plain', _charset=None, *, policy=compat32)
    +

    Module: email.mime.text

    +

    A subclass of MIMENonMultipart, the +MIMEText class is used to create MIME objects of major type +text. _text is the string for the payload. _subtype is the +minor type and defaults to plain. _charset is the character +set of the text and is passed as an argument to the +MIMENonMultipart constructor; it defaults +to us-ascii if the string contains only ascii code points, and +utf-8 otherwise. The _charset parameter accepts either a string or a +Charset instance.

    +

    Unless the _charset argument is explicitly set to None, the +MIMEText object created will have both a Content-Type header +with a charset parameter, and a Content-Transfer-Encoding +header. This means that a subsequent set_payload call will not result +in an encoded payload, even if a charset is passed in the set_payload +command. You can “reset” this behavior by deleting the +Content-Transfer-Encoding header, after which a set_payload call +will automatically encode the new payload (and add a new +Content-Transfer-Encoding header).

    +

    Optional policy argument defaults to compat32.

    +
    +

    Changed in version 3.5: _charset also accepts Charset instances.

    +
    +
    +

    Changed in version 3.6: Added policy keyword-only parameter.

    +
    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/email.parser.html b/python-3.7.4-docs-html/library/email.parser.html new file mode 100644 index 0000000..7c60e9e --- /dev/null +++ b/python-3.7.4-docs-html/library/email.parser.html @@ -0,0 +1,513 @@ + + + + + + + email.parser: Parsing email messages — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    email.parser: Parsing email messages

    +

    Source code: Lib/email/parser.py

    +
    +

    Message object structures can be created in one of two ways: they can be +created from whole cloth by creating an EmailMessage +object, adding headers using the dictionary interface, and adding payload(s) +using set_content() and related methods, or +they can be created by parsing a serialized representation of the email +message.

    +

    The email package provides a standard parser that understands most email +document structures, including MIME documents. You can pass the parser a +bytes, string or file object, and the parser will return to you the root +EmailMessage instance of the object structure. For +simple, non-MIME messages the payload of this root object will likely be a +string containing the text of the message. For MIME messages, the root object +will return True from its is_multipart() +method, and the subparts can be accessed via the payload manipulation methods, +such as get_body(), +iter_parts(), and +walk().

    +

    There are actually two parser interfaces available for use, the Parser +API and the incremental FeedParser API. The Parser API is +most useful if you have the entire text of the message in memory, or if the +entire message lives in a file on the file system. FeedParser is more +appropriate when you are reading the message from a stream which might block +waiting for more input (such as reading an email message from a socket). The +FeedParser can consume and parse the message incrementally, and only +returns the root object when you close the parser.

    +

    Note that the parser can be extended in limited ways, and of course you can +implement your own parser completely from scratch. All of the logic that +connects the email package’s bundled parser and the +EmailMessage class is embodied in the policy +class, so a custom parser can create message object trees any way it finds +necessary by implementing custom versions of the appropriate policy +methods.

    +
    +

    FeedParser API

    +

    The BytesFeedParser, imported from the email.feedparser module, +provides an API that is conducive to incremental parsing of email messages, +such as would be necessary when reading the text of an email message from a +source that can block (such as a socket). The BytesFeedParser can of +course be used to parse an email message fully contained in a bytes-like +object, string, or file, but the BytesParser API may be more +convenient for such use cases. The semantics and results of the two parser +APIs are identical.

    +

    The BytesFeedParser’s API is simple; you create an instance, feed it a +bunch of bytes until there’s no more to feed it, then close the parser to +retrieve the root message object. The BytesFeedParser is extremely +accurate when parsing standards-compliant messages, and it does a very good job +of parsing non-compliant messages, providing information about how a message +was deemed broken. It will populate a message object’s +defects attribute with a list of any +problems it found in a message. See the email.errors module for the +list of defects that it can find.

    +

    Here is the API for the BytesFeedParser:

    +
    +
    +class email.parser.BytesFeedParser(_factory=None, *, policy=policy.compat32)
    +

    Create a BytesFeedParser instance. Optional _factory is a +no-argument callable; if not specified use the +message_factory from the policy. Call +_factory whenever a new message object is needed.

    +

    If policy is specified use the rules it specifies to update the +representation of the message. If policy is not set, use the +compat32 policy, which maintains backward +compatibility with the Python 3.2 version of the email package and provides +Message as the default factory. All other policies +provide EmailMessage as the default _factory. For +more information on what else policy controls, see the +policy documentation.

    +

    Note: The policy keyword should always be specified; The default will +change to email.policy.default in a future version of Python.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.3: Added the policy keyword.

    +
    +
    +

    Changed in version 3.6: _factory defaults to the policy message_factory.

    +
    +
    +
    +feed(data)
    +

    Feed the parser some more data. data should be a bytes-like +object containing one or more lines. The lines can be partial and the +parser will stitch such partial lines together properly. The lines can +have any of the three common line endings: carriage return, newline, or +carriage return and newline (they can even be mixed).

    +
    + +
    +
    +close()
    +

    Complete the parsing of all previously fed data and return the root +message object. It is undefined what happens if feed() is called +after this method has been called.

    +
    + +
    + +
    +
    +class email.parser.FeedParser(_factory=None, *, policy=policy.compat32)
    +

    Works like BytesFeedParser except that the input to the +feed() method must be a string. This is of limited +utility, since the only way for such a message to be valid is for it to +contain only ASCII text or, if utf8 is +True, no binary attachments.

    +
    +

    Changed in version 3.3: Added the policy keyword.

    +
    +
    + +
    +
    +

    Parser API

    +

    The BytesParser class, imported from the email.parser module, +provides an API that can be used to parse a message when the complete contents +of the message are available in a bytes-like object or file. The +email.parser module also provides Parser for parsing strings, +and header-only parsers, BytesHeaderParser and +HeaderParser, which can be used if you’re only interested in the +headers of the message. BytesHeaderParser and HeaderParser +can be much faster in these situations, since they do not attempt to parse the +message body, instead setting the payload to the raw body.

    +
    +
    +class email.parser.BytesParser(_class=None, *, policy=policy.compat32)
    +

    Create a BytesParser instance. The _class and policy +arguments have the same meaning and semantics as the _factory +and policy arguments of BytesFeedParser.

    +

    Note: The policy keyword should always be specified; The default will +change to email.policy.default in a future version of Python.

    +
    +

    Changed in version 3.3: Removed the strict argument that was deprecated in 2.4. Added the +policy keyword.

    +
    +
    +

    Changed in version 3.6: _class defaults to the policy message_factory.

    +
    +
    +
    +parse(fp, headersonly=False)
    +

    Read all the data from the binary file-like object fp, parse the +resulting bytes, and return the message object. fp must support +both the readline() and the read() +methods.

    +

    The bytes contained in fp must be formatted as a block of RFC 5322 +(or, if utf8 is True, RFC 6532) +style headers and header continuation lines, optionally preceded by an +envelope header. The header block is terminated either by the end of the +data or by a blank line. Following the header block is the body of the +message (which may contain MIME-encoded subparts, including subparts +with a Content-Transfer-Encoding of 8bit).

    +

    Optional headersonly is a flag specifying whether to stop parsing after +reading the headers or not. The default is False, meaning it parses +the entire contents of the file.

    +
    + +
    +
    +parsebytes(bytes, headersonly=False)
    +

    Similar to the parse() method, except it takes a bytes-like +object instead of a file-like object. Calling this method on a +bytes-like object is equivalent to wrapping bytes in a +BytesIO instance first and calling parse().

    +

    Optional headersonly is as with the parse() method.

    +
    + +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +class email.parser.BytesHeaderParser(_class=None, *, policy=policy.compat32)
    +

    Exactly like BytesParser, except that headersonly +defaults to True.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +class email.parser.Parser(_class=None, *, policy=policy.compat32)
    +

    This class is parallel to BytesParser, but handles string input.

    +
    +

    Changed in version 3.3: Removed the strict argument. Added the policy keyword.

    +
    +
    +

    Changed in version 3.6: _class defaults to the policy message_factory.

    +
    +
    +
    +parse(fp, headersonly=False)
    +

    Read all the data from the text-mode file-like object fp, parse the +resulting text, and return the root message object. fp must support +both the readline() and the +read() methods on file-like objects.

    +

    Other than the text mode requirement, this method operates like +BytesParser.parse().

    +
    + +
    +
    +parsestr(text, headersonly=False)
    +

    Similar to the parse() method, except it takes a string object +instead of a file-like object. Calling this method on a string is +equivalent to wrapping text in a StringIO instance first +and calling parse().

    +

    Optional headersonly is as with the parse() method.

    +
    + +
    + +
    +
    +class email.parser.HeaderParser(_class=None, *, policy=policy.compat32)
    +

    Exactly like Parser, except that headersonly +defaults to True.

    +
    + +

    Since creating a message object structure from a string or a file object is such +a common task, four functions are provided as a convenience. They are available +in the top-level email package namespace.

    +
    +
    +email.message_from_bytes(s, _class=None, *, policy=policy.compat32)
    +

    Return a message object structure from a bytes-like object. This is +equivalent to BytesParser().parsebytes(s). Optional _class and +policy are interpreted as with the BytesParser class +constructor.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.3: Removed the strict argument. Added the policy keyword.

    +
    +
    + +
    +
    +email.message_from_binary_file(fp, _class=None, *, policy=policy.compat32)
    +

    Return a message object structure tree from an open binary file +object. This is equivalent to BytesParser().parse(fp). _class and +policy are interpreted as with the BytesParser class +constructor.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.3: Removed the strict argument. Added the policy keyword.

    +
    +
    + +
    +
    +email.message_from_string(s, _class=None, *, policy=policy.compat32)
    +

    Return a message object structure from a string. This is equivalent to +Parser().parsestr(s). _class and policy are interpreted as +with the Parser class constructor.

    +
    +

    Changed in version 3.3: Removed the strict argument. Added the policy keyword.

    +
    +
    + +
    +
    +email.message_from_file(fp, _class=None, *, policy=policy.compat32)
    +

    Return a message object structure tree from an open file object. +This is equivalent to Parser().parse(fp). _class and policy are +interpreted as with the Parser class constructor.

    +
    +

    Changed in version 3.3: Removed the strict argument. Added the policy keyword.

    +
    +
    +

    Changed in version 3.6: _class defaults to the policy message_factory.

    +
    +
    + +

    Here’s an example of how you might use message_from_bytes() at an +interactive Python prompt:

    +
    >>> import email
    +>>> msg = email.message_from_bytes(myBytes)  
    +
    +
    +
    +
    +

    Additional notes

    +

    Here are some notes on the parsing semantics:

    +
      +
    • Most non-multipart type messages are parsed as a single message +object with a string payload. These objects will return False for +is_multipart(), and +iter_parts() will yield an empty list.

    • +
    • All multipart type messages will be parsed as a container message +object with a list of sub-message objects for their payload. The outer +container message will return True for +is_multipart(), and +iter_parts() will yield a list of subparts.

    • +
    • Most messages with a content type of message/* (such as +message/delivery-status and message/rfc822) will also +be parsed as container object containing a list payload of length 1. Their +is_multipart() method will return True. +The single element yielded by iter_parts() +will be a sub-message object.

    • +
    • Some non-standards-compliant messages may not be internally consistent about +their multipart-edness. Such messages may have a +Content-Type header of type multipart, but their +is_multipart() method may return False. +If such messages were parsed with the FeedParser, +they will have an instance of the +MultipartInvariantViolationDefect class in their +defects attribute list. See email.errors for details.

    • +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/email.policy.html b/python-3.7.4-docs-html/library/email.policy.html new file mode 100644 index 0000000..e6db522 --- /dev/null +++ b/python-3.7.4-docs-html/library/email.policy.html @@ -0,0 +1,816 @@ + + + + + + + email.policy: Policy Objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    email.policy: Policy Objects

    +
    +

    New in version 3.3.

    +
    +

    Source code: Lib/email/policy.py

    +
    +

    The email package’s prime focus is the handling of email messages as +described by the various email and MIME RFCs. However, the general format of +email messages (a block of header fields each consisting of a name followed by +a colon followed by a value, the whole block followed by a blank line and an +arbitrary ‘body’), is a format that has found utility outside of the realm of +email. Some of these uses conform fairly closely to the main email RFCs, some +do not. Even when working with email, there are times when it is desirable to +break strict compliance with the RFCs, such as generating emails that +interoperate with email servers that do not themselves follow the standards, or +that implement extensions you want to use in ways that violate the +standards.

    +

    Policy objects give the email package the flexibility to handle all these +disparate use cases.

    +

    A Policy object encapsulates a set of attributes and methods that +control the behavior of various components of the email package during use. +Policy instances can be passed to various classes and methods in the +email package to alter the default behavior. The settable values and their +defaults are described below.

    +

    There is a default policy used by all classes in the email package. For all of +the parser classes and the related convenience functions, and for +the Message class, this is the Compat32 +policy, via its corresponding pre-defined instance compat32. This +policy provides for complete backward compatibility (in some cases, including +bug compatibility) with the pre-Python3.3 version of the email package.

    +

    This default value for the policy keyword to +EmailMessage is the EmailPolicy policy, via +its pre-defined instance default.

    +

    When a Message or EmailMessage +object is created, it acquires a policy. If the message is created by a +parser, a policy passed to the parser will be the policy used by +the message it creates. If the message is created by the program, then the +policy can be specified when it is created. When a message is passed to a +generator, the generator uses the policy from the message by +default, but you can also pass a specific policy to the generator that will +override the one stored on the message object.

    +

    The default value for the policy keyword for the email.parser classes +and the parser convenience functions will be changing in a future version of +Python. Therefore you should always specify explicitly which policy you want +to use when calling any of the classes and functions described in the +parser module.

    +

    The first part of this documentation covers the features of Policy, an +abstract base class that defines the features that are common to all +policy objects, including compat32. This includes certain hook +methods that are called internally by the email package, which a custom policy +could override to obtain different behavior. The second part describes the +concrete classes EmailPolicy and Compat32, which implement +the hooks that provide the standard behavior and the backward compatible +behavior and features, respectively.

    +

    Policy instances are immutable, but they can be cloned, accepting the +same keyword arguments as the class constructor and returning a new +Policy instance that is a copy of the original but with the specified +attributes values changed.

    +

    As an example, the following code could be used to read an email message from a +file on disk and pass it to the system sendmail program on a Unix system:

    +
    >>> from email import message_from_binary_file
    +>>> from email.generator import BytesGenerator
    +>>> from email import policy
    +>>> from subprocess import Popen, PIPE
    +>>> with open('mymsg.txt', 'rb') as f:
    +...     msg = message_from_binary_file(f, policy=policy.default)
    +>>> p = Popen(['sendmail', msg['To'].addresses[0]], stdin=PIPE)
    +>>> g = BytesGenerator(p.stdin, policy=msg.policy.clone(linesep='\r\n'))
    +>>> g.flatten(msg)
    +>>> p.stdin.close()
    +>>> rc = p.wait()
    +
    +
    +

    Here we are telling BytesGenerator to use the RFC +correct line separator characters when creating the binary string to feed into +sendmail's stdin, where the default policy would use \n line +separators.

    +

    Some email package methods accept a policy keyword argument, allowing the +policy to be overridden for that method. For example, the following code uses +the as_bytes() method of the msg object from +the previous example and writes the message to a file using the native line +separators for the platform on which it is running:

    +
    >>> import os
    +>>> with open('converted.txt', 'wb') as f:
    +...     f.write(msg.as_bytes(policy=msg.policy.clone(linesep=os.linesep)))
    +17
    +
    +
    +

    Policy objects can also be combined using the addition operator, producing a +policy object whose settings are a combination of the non-default values of the +summed objects:

    +
    >>> compat_SMTP = policy.compat32.clone(linesep='\r\n')
    +>>> compat_strict = policy.compat32.clone(raise_on_defect=True)
    +>>> compat_strict_SMTP = compat_SMTP + compat_strict
    +
    +
    +

    This operation is not commutative; that is, the order in which the objects are +added matters. To illustrate:

    +
    >>> policy100 = policy.compat32.clone(max_line_length=100)
    +>>> policy80 = policy.compat32.clone(max_line_length=80)
    +>>> apolicy = policy100 + policy80
    +>>> apolicy.max_line_length
    +80
    +>>> apolicy = policy80 + policy100
    +>>> apolicy.max_line_length
    +100
    +
    +
    +
    +
    +class email.policy.Policy(**kw)
    +

    This is the abstract base class for all policy classes. It provides +default implementations for a couple of trivial methods, as well as the +implementation of the immutability property, the clone() method, and +the constructor semantics.

    +

    The constructor of a policy class can be passed various keyword arguments. +The arguments that may be specified are any non-method properties on this +class, plus any additional non-method properties on the concrete class. A +value specified in the constructor will override the default value for the +corresponding attribute.

    +

    This class defines the following properties, and thus values for the +following may be passed in the constructor of any policy class:

    +
    +
    +max_line_length
    +

    The maximum length of any line in the serialized output, not counting the +end of line character(s). Default is 78, per RFC 5322. A value of +0 or None indicates that no line wrapping should be +done at all.

    +
    + +
    +
    +linesep
    +

    The string to be used to terminate lines in serialized output. The +default is \n because that’s the internal end-of-line discipline used +by Python, though \r\n is required by the RFCs.

    +
    + +
    +
    +cte_type
    +

    Controls the type of Content Transfer Encodings that may be or are +required to be used. The possible values are:

    + ++++ + + + + + + + + +

    7bit

    all data must be “7 bit clean” (ASCII-only). This means that +where necessary data will be encoded using either +quoted-printable or base64 encoding.

    8bit

    data is not constrained to be 7 bit clean. Data in headers is +still required to be ASCII-only and so will be encoded (see +fold_binary() and utf8 below for +exceptions), but body parts may use the 8bit CTE.

    +

    A cte_type value of 8bit only works with BytesGenerator, not +Generator, because strings cannot contain binary data. If a +Generator is operating under a policy that specifies +cte_type=8bit, it will act as if cte_type is 7bit.

    +
    + +
    +
    +raise_on_defect
    +

    If True, any defects encountered will be raised as errors. If +False (the default), defects will be passed to the +register_defect() method.

    +
    + +
    +
    +mangle_from_
    +

    If True, lines starting with “From “ in the body are +escaped by putting a > in front of them. This parameter is used when +the message is being serialized by a generator. +Default: False.

    +
    +

    New in version 3.5: The mangle_from_ parameter.

    +
    +
    + +
    +
    +message_factory
    +

    A factory function for constructing a new empty message object. Used +by the parser when building messages. Defaults to None, in +which case Message is used.

    +
    +

    New in version 3.6.

    +
    +
    + +

    The following Policy method is intended to be called by code using +the email library to create policy instances with custom settings:

    +
    +
    +clone(**kw)
    +

    Return a new Policy instance whose attributes have the same +values as the current instance, except where those attributes are +given new values by the keyword arguments.

    +
    + +

    The remaining Policy methods are called by the email package code, +and are not intended to be called by an application using the email package. +A custom policy must implement all of these methods.

    +
    +
    +handle_defect(obj, defect)
    +

    Handle a defect found on obj. When the email package calls this +method, defect will always be a subclass of +Defect.

    +

    The default implementation checks the raise_on_defect flag. If +it is True, defect is raised as an exception. If it is False +(the default), obj and defect are passed to register_defect().

    +
    + +
    +
    +register_defect(obj, defect)
    +

    Register a defect on obj. In the email package, defect will always +be a subclass of Defect.

    +

    The default implementation calls the append method of the defects +attribute of obj. When the email package calls handle_defect, +obj will normally have a defects attribute that has an append +method. Custom object types used with the email package (for example, +custom Message objects) should also provide such an attribute, +otherwise defects in parsed messages will raise unexpected errors.

    +
    + +
    +
    +header_max_count(name)
    +

    Return the maximum allowed number of headers named name.

    +

    Called when a header is added to an EmailMessage +or Message object. If the returned value is not +0 or None, and there are already a number of headers with the +name name greater than or equal to the value returned, a +ValueError is raised.

    +

    Because the default behavior of Message.__setitem__ is to append the +value to the list of headers, it is easy to create duplicate headers +without realizing it. This method allows certain headers to be limited +in the number of instances of that header that may be added to a +Message programmatically. (The limit is not observed by the parser, +which will faithfully produce as many headers as exist in the message +being parsed.)

    +

    The default implementation returns None for all header names.

    +
    + +
    +
    +header_source_parse(sourcelines)
    +

    The email package calls this method with a list of strings, each string +ending with the line separation characters found in the source being +parsed. The first line includes the field header name and separator. +All whitespace in the source is preserved. The method should return the +(name, value) tuple that is to be stored in the Message to +represent the parsed header.

    +

    If an implementation wishes to retain compatibility with the existing +email package policies, name should be the case preserved name (all +characters up to the ‘:’ separator), while value should be the +unfolded value (all line separator characters removed, but whitespace +kept intact), stripped of leading whitespace.

    +

    sourcelines may contain surrogateescaped binary data.

    +

    There is no default implementation

    +
    + +
    +
    +header_store_parse(name, value)
    +

    The email package calls this method with the name and value provided by +the application program when the application program is modifying a +Message programmatically (as opposed to a Message created by a +parser). The method should return the (name, value) tuple that is to +be stored in the Message to represent the header.

    +

    If an implementation wishes to retain compatibility with the existing +email package policies, the name and value should be strings or +string subclasses that do not change the content of the passed in +arguments.

    +

    There is no default implementation

    +
    + +
    +
    +header_fetch_parse(name, value)
    +

    The email package calls this method with the name and value currently +stored in the Message when that header is requested by the +application program, and whatever the method returns is what is passed +back to the application as the value of the header being retrieved. +Note that there may be more than one header with the same name stored in +the Message; the method is passed the specific name and value of the +header destined to be returned to the application.

    +

    value may contain surrogateescaped binary data. There should be no +surrogateescaped binary data in the value returned by the method.

    +

    There is no default implementation

    +
    + +
    +
    +fold(name, value)
    +

    The email package calls this method with the name and value currently +stored in the Message for a given header. The method should return a +string that represents that header “folded” correctly (according to the +policy settings) by composing the name with the value and inserting +linesep characters at the appropriate places. See RFC 5322 +for a discussion of the rules for folding email headers.

    +

    value may contain surrogateescaped binary data. There should be no +surrogateescaped binary data in the string returned by the method.

    +
    + +
    +
    +fold_binary(name, value)
    +

    The same as fold(), except that the returned value should be a +bytes object rather than a string.

    +

    value may contain surrogateescaped binary data. These could be +converted back into binary data in the returned bytes object.

    +
    + +
    + +
    +
    +class email.policy.EmailPolicy(**kw)
    +

    This concrete Policy provides behavior that is intended to be fully +compliant with the current email RFCs. These include (but are not limited +to) RFC 5322, RFC 2047, and the current MIME RFCs.

    +

    This policy adds new header parsing and folding algorithms. Instead of +simple strings, headers are str subclasses with attributes that depend +on the type of the field. The parsing and folding algorithm fully implement +RFC 2047 and RFC 5322.

    +

    The default value for the message_factory +attribute is EmailMessage.

    +

    In addition to the settable attributes listed above that apply to all +policies, this policy adds the following additional attributes:

    +
    +

    New in version 3.6: 1

    +
    +
    +
    +utf8
    +

    If False, follow RFC 5322, supporting non-ASCII characters in +headers by encoding them as “encoded words”. If True, follow +RFC 6532 and use utf-8 encoding for headers. Messages +formatted in this way may be passed to SMTP servers that support +the SMTPUTF8 extension (RFC 6531).

    +
    + +
    +
    +refold_source
    +

    If the value for a header in the Message object originated from a +parser (as opposed to being set by a program), this +attribute indicates whether or not a generator should refold that value +when transforming the message back into serialized form. The possible +values are:

    + ++++ + + + + + + + + + + + +

    none

    all source values use original folding

    long

    source values that have any line that is longer than +max_line_length will be refolded

    all

    all values are refolded.

    +

    The default is long.

    +
    + +
    +
    +header_factory
    +

    A callable that takes two arguments, name and value, where +name is a header field name and value is an unfolded header field +value, and returns a string subclass that represents that header. A +default header_factory (see headerregistry) is provided +that supports custom parsing for the various address and date RFC 5322 +header field types, and the major MIME header field stypes. Support for +additional custom parsing will be added in the future.

    +
    + +
    +
    +content_manager
    +

    An object with at least two methods: get_content and set_content. When +the get_content() or +set_content() method of an +EmailMessage object is called, it calls the +corresponding method of this object, passing it the message object as its +first argument, and any arguments or keywords that were passed to it as +additional arguments. By default content_manager is set to +raw_data_manager.

    +
    +

    New in version 3.4.

    +
    +
    + +

    The class provides the following concrete implementations of the abstract +methods of Policy:

    +
    +
    +header_max_count(name)
    +

    Returns the value of the +max_count attribute of the +specialized class used to represent the header with the given name.

    +
    + +
    +
    +header_source_parse(sourcelines)
    +

    The name is parsed as everything up to the ‘:’ and returned +unmodified. The value is determined by stripping leading whitespace off +the remainder of the first line, joining all subsequent lines together, +and stripping any trailing carriage return or linefeed characters.

    +
    + +
    +
    +header_store_parse(name, value)
    +

    The name is returned unchanged. If the input value has a name +attribute and it matches name ignoring case, the value is returned +unchanged. Otherwise the name and value are passed to +header_factory, and the resulting header object is returned as +the value. In this case a ValueError is raised if the input value +contains CR or LF characters.

    +
    + +
    +
    +header_fetch_parse(name, value)
    +

    If the value has a name attribute, it is returned to unmodified. +Otherwise the name, and the value with any CR or LF characters +removed, are passed to the header_factory, and the resulting +header object is returned. Any surrogateescaped bytes get turned into +the unicode unknown-character glyph.

    +
    + +
    +
    +fold(name, value)
    +

    Header folding is controlled by the refold_source policy setting. +A value is considered to be a ‘source value’ if and only if it does not +have a name attribute (having a name attribute means it is a +header object of some sort). If a source value needs to be refolded +according to the policy, it is converted into a header object by +passing the name and the value with any CR and LF characters removed +to the header_factory. Folding of a header object is done by +calling its fold method with the current policy.

    +

    Source values are split into lines using splitlines(). If +the value is not to be refolded, the lines are rejoined using the +linesep from the policy and returned. The exception is lines +containing non-ascii binary data. In that case the value is refolded +regardless of the refold_source setting, which causes the binary data +to be CTE encoded using the unknown-8bit charset.

    +
    + +
    +
    +fold_binary(name, value)
    +

    The same as fold() if cte_type is 7bit, except +that the returned value is bytes.

    +

    If cte_type is 8bit, non-ASCII binary data is +converted back +into bytes. Headers with binary data are not refolded, regardless of the +refold_header setting, since there is no way to know whether the +binary data consists of single byte characters or multibyte characters.

    +
    + +
    + +

    The following instances of EmailPolicy provide defaults suitable for +specific application domains. Note that in the future the behavior of these +instances (in particular the HTTP instance) may be adjusted to conform even +more closely to the RFCs relevant to their domains.

    +
    +
    +email.policy.default
    +

    An instance of EmailPolicy with all defaults unchanged. This policy +uses the standard Python \n line endings rather than the RFC-correct +\r\n.

    +
    + +
    +
    +email.policy.SMTP
    +

    Suitable for serializing messages in conformance with the email RFCs. +Like default, but with linesep set to \r\n, which is RFC +compliant.

    +
    + +
    +
    +email.policy.SMTPUTF8
    +

    The same as SMTP except that utf8 is True. +Useful for serializing messages to a message store without using encoded +words in the headers. Should only be used for SMTP transmission if the +sender or recipient addresses have non-ASCII characters (the +smtplib.SMTP.send_message() method handles this automatically).

    +
    + +
    +
    +email.policy.HTTP
    +

    Suitable for serializing headers with for use in HTTP traffic. Like +SMTP except that max_line_length is set to None (unlimited).

    +
    + +
    +
    +email.policy.strict
    +

    Convenience instance. The same as default except that +raise_on_defect is set to True. This allows any policy to be made +strict by writing:

    +
    somepolicy + policy.strict
    +
    +
    +
    + +

    With all of these EmailPolicies, the effective API of +the email package is changed from the Python 3.2 API in the following ways:

    +
    +
      +
    • Setting a header on a Message results in that +header being parsed and a header object created.

    • +
    • Fetching a header value from a Message results +in that header being parsed and a header object created and +returned.

    • +
    • Any header object, or any header that is refolded due to the +policy settings, is folded using an algorithm that fully implements the +RFC folding algorithms, including knowing where encoded words are required +and allowed.

    • +
    +
    +

    From the application view, this means that any header obtained through the +EmailMessage is a header object with extra +attributes, whose string value is the fully decoded unicode value of the +header. Likewise, a header may be assigned a new value, or a new header +created, using a unicode string, and the policy will take care of converting +the unicode string into the correct RFC encoded form.

    +

    The header objects and their attributes are described in +headerregistry.

    +
    +
    +class email.policy.Compat32(**kw)
    +

    This concrete Policy is the backward compatibility policy. It +replicates the behavior of the email package in Python 3.2. The +policy module also defines an instance of this class, +compat32, that is used as the default policy. Thus the default +behavior of the email package is to maintain compatibility with Python 3.2.

    +

    The following attributes have values that are different from the +Policy default:

    +
    +
    +mangle_from_
    +

    The default is True.

    +
    + +

    The class provides the following concrete implementations of the +abstract methods of Policy:

    +
    +
    +header_source_parse(sourcelines)
    +

    The name is parsed as everything up to the ‘:’ and returned +unmodified. The value is determined by stripping leading whitespace off +the remainder of the first line, joining all subsequent lines together, +and stripping any trailing carriage return or linefeed characters.

    +
    + +
    +
    +header_store_parse(name, value)
    +

    The name and value are returned unmodified.

    +
    + +
    +
    +header_fetch_parse(name, value)
    +

    If the value contains binary data, it is converted into a +Header object using the unknown-8bit charset. +Otherwise it is returned unmodified.

    +
    + +
    +
    +fold(name, value)
    +

    Headers are folded using the Header folding +algorithm, which preserves existing line breaks in the value, and wraps +each resulting line to the max_line_length. Non-ASCII binary data are +CTE encoded using the unknown-8bit charset.

    +
    + +
    +
    +fold_binary(name, value)
    +

    Headers are folded using the Header folding +algorithm, which preserves existing line breaks in the value, and wraps +each resulting line to the max_line_length. If cte_type is +7bit, non-ascii binary data is CTE encoded using the unknown-8bit +charset. Otherwise the original source header is used, with its existing +line breaks and any (RFC invalid) binary data it may contain.

    +
    + +
    + +
    +
    +email.policy.compat32
    +

    An instance of Compat32, providing backward compatibility with the +behavior of the email package in Python 3.2.

    +
    + +

    Footnotes

    +
    +
    1
    +

    Originally added in 3.3 as a provisional feature.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/email.utils.html b/python-3.7.4-docs-html/library/email.utils.html new file mode 100644 index 0000000..4a1a72e --- /dev/null +++ b/python-3.7.4-docs-html/library/email.utils.html @@ -0,0 +1,412 @@ + + + + + + + email.utils: Miscellaneous utilities — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    email.utils: Miscellaneous utilities

    +

    Source code: Lib/email/utils.py

    +
    +

    There are a couple of useful utilities provided in the email.utils +module:

    +
    +
    +email.utils.localtime(dt=None)
    +

    Return local time as an aware datetime object. If called without +arguments, return current time. Otherwise dt argument should be a +datetime instance, and it is converted to the local time +zone according to the system time zone database. If dt is naive (that +is, dt.tzinfo is None), it is assumed to be in local time. In this +case, a positive or zero value for isdst causes localtime to presume +initially that summer time (for example, Daylight Saving Time) is or is not +(respectively) in effect for the specified time. A negative value for +isdst causes the localtime to attempt to divine whether summer time +is in effect for the specified time.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +email.utils.make_msgid(idstring=None, domain=None)
    +

    Returns a string suitable for an RFC 2822-compliant +Message-ID header. Optional idstring if given, is a string +used to strengthen the uniqueness of the message id. Optional domain if +given provides the portion of the msgid after the ‘@’. The default is the +local hostname. It is not normally necessary to override this default, but +may be useful certain cases, such as a constructing distributed system that +uses a consistent domain name across multiple hosts.

    +
    +

    Changed in version 3.2: Added the domain keyword.

    +
    +
    + +

    The remaining functions are part of the legacy (Compat32) email API. There +is no need to directly use these with the new API, since the parsing and +formatting they provide is done automatically by the header parsing machinery +of the new API.

    +
    +
    +email.utils.quote(str)
    +

    Return a new string with backslashes in str replaced by two backslashes, and +double quotes replaced by backslash-double quote.

    +
    + +
    +
    +email.utils.unquote(str)
    +

    Return a new string which is an unquoted version of str. If str ends and +begins with double quotes, they are stripped off. Likewise if str ends and +begins with angle brackets, they are stripped off.

    +
    + +
    +
    +email.utils.parseaddr(address)
    +

    Parse address – which should be the value of some address-containing field such +as To or Cc – into its constituent realname and +email address parts. Returns a tuple of that information, unless the parse +fails, in which case a 2-tuple of ('', '') is returned.

    +
    + +
    +
    +email.utils.formataddr(pair, charset='utf-8')
    +

    The inverse of parseaddr(), this takes a 2-tuple of the form (realname, +email_address) and returns the string value suitable for a To or +Cc header. If the first element of pair is false, then the +second element is returned unmodified.

    +

    Optional charset is the character set that will be used in the RFC 2047 +encoding of the realname if the realname contains non-ASCII +characters. Can be an instance of str or a +Charset. Defaults to utf-8.

    +
    +

    Changed in version 3.3: Added the charset option.

    +
    +
    + +
    +
    +email.utils.getaddresses(fieldvalues)
    +

    This method returns a list of 2-tuples of the form returned by parseaddr(). +fieldvalues is a sequence of header field values as might be returned by +Message.get_all. Here’s a simple +example that gets all the recipients of a message:

    +
    from email.utils import getaddresses
    +
    +tos = msg.get_all('to', [])
    +ccs = msg.get_all('cc', [])
    +resent_tos = msg.get_all('resent-to', [])
    +resent_ccs = msg.get_all('resent-cc', [])
    +all_recipients = getaddresses(tos + ccs + resent_tos + resent_ccs)
    +
    +
    +
    + +
    +
    +email.utils.parsedate(date)
    +

    Attempts to parse a date according to the rules in RFC 2822. however, some +mailers don’t follow that format as specified, so parsedate() tries to +guess correctly in such cases. date is a string containing an RFC 2822 +date, such as "Mon, 20 Nov 1995 19:12:08 -0500". If it succeeds in parsing +the date, parsedate() returns a 9-tuple that can be passed directly to +time.mktime(); otherwise None will be returned. Note that indexes 6, +7, and 8 of the result tuple are not usable.

    +
    + +
    +
    +email.utils.parsedate_tz(date)
    +

    Performs the same function as parsedate(), but returns either None or +a 10-tuple; the first 9 elements make up a tuple that can be passed directly to +time.mktime(), and the tenth is the offset of the date’s timezone from UTC +(which is the official term for Greenwich Mean Time) 1. If the input string +has no timezone, the last element of the tuple returned is None. Note that +indexes 6, 7, and 8 of the result tuple are not usable.

    +
    + +
    +
    +email.utils.parsedate_to_datetime(date)
    +

    The inverse of format_datetime(). Performs the same function as +parsedate(), but on success returns a datetime. If +the input date has a timezone of -0000, the datetime will be a naive +datetime, and if the date is conforming to the RFCs it will represent a +time in UTC but with no indication of the actual source timezone of the +message the date comes from. If the input date has any other valid timezone +offset, the datetime will be an aware datetime with the +corresponding a timezone tzinfo.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +email.utils.mktime_tz(tuple)
    +

    Turn a 10-tuple as returned by parsedate_tz() into a UTC +timestamp (seconds since the Epoch). If the timezone item in the +tuple is None, assume local time.

    +
    + +
    +
    +email.utils.formatdate(timeval=None, localtime=False, usegmt=False)
    +

    Returns a date string as per RFC 2822, e.g.:

    +
    Fri, 09 Nov 2001 01:08:47 -0000
    +
    +
    +

    Optional timeval if given is a floating point time value as accepted by +time.gmtime() and time.localtime(), otherwise the current time is +used.

    +

    Optional localtime is a flag that when True, interprets timeval, and +returns a date relative to the local timezone instead of UTC, properly taking +daylight savings time into account. The default is False meaning UTC is +used.

    +

    Optional usegmt is a flag that when True, outputs a date string with the +timezone as an ascii string GMT, rather than a numeric -0000. This is +needed for some protocols (such as HTTP). This only applies when localtime is +False. The default is False.

    +
    + +
    +
    +email.utils.format_datetime(dt, usegmt=False)
    +

    Like formatdate, but the input is a datetime instance. If it is +a naive datetime, it is assumed to be “UTC with no information about the +source timezone”, and the conventional -0000 is used for the timezone. +If it is an aware datetime, then the numeric timezone offset is used. +If it is an aware timezone with offset zero, then usegmt may be set to +True, in which case the string GMT is used instead of the numeric +timezone offset. This provides a way to generate standards conformant HTTP +date headers.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +email.utils.decode_rfc2231(s)
    +

    Decode the string s according to RFC 2231.

    +
    + +
    +
    +email.utils.encode_rfc2231(s, charset=None, language=None)
    +

    Encode the string s according to RFC 2231. Optional charset and +language, if given is the character set name and language name to use. If +neither is given, s is returned as-is. If charset is given but language +is not, the string is encoded using the empty string for language.

    +
    + +
    +
    +email.utils.collapse_rfc2231_value(value, errors='replace', fallback_charset='us-ascii')
    +

    When a header parameter is encoded in RFC 2231 format, +Message.get_param may return a +3-tuple containing the character set, +language, and value. collapse_rfc2231_value() turns this into a unicode +string. Optional errors is passed to the errors argument of str’s +encode() method; it defaults to 'replace'. Optional +fallback_charset specifies the character set to use if the one in the +RFC 2231 header is not known by Python; it defaults to 'us-ascii'.

    +

    For convenience, if the value passed to collapse_rfc2231_value() is not +a tuple, it should be a string and it is returned unquoted.

    +
    + +
    +
    +email.utils.decode_params(params)
    +

    Decode parameters list according to RFC 2231. params is a sequence of +2-tuples containing elements of the form (content-type, string-value).

    +
    + +

    Footnotes

    +
    +
    1
    +

    Note that the sign of the timezone offset is the opposite of the sign of the +time.timezone variable for the same timezone; the latter variable follows +the POSIX standard while this module follows RFC 2822.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/ensurepip.html b/python-3.7.4-docs-html/library/ensurepip.html new file mode 100644 index 0000000..9812b63 --- /dev/null +++ b/python-3.7.4-docs-html/library/ensurepip.html @@ -0,0 +1,309 @@ + + + + + + + ensurepip — Bootstrapping the pip installer — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    ensurepip — Bootstrapping the pip installer

    +
    +

    New in version 3.4.

    +
    +
    +

    The ensurepip package provides support for bootstrapping the pip +installer into an existing Python installation or virtual environment. This +bootstrapping approach reflects the fact that pip is an independent +project with its own release cycle, and the latest available stable version +is bundled with maintenance and feature releases of the CPython reference +interpreter.

    +

    In most cases, end users of Python shouldn’t need to invoke this module +directly (as pip should be bootstrapped by default), but it may be +needed if installing pip was skipped when installing Python (or +when creating a virtual environment) or after explicitly uninstalling +pip.

    +
    +

    Note

    +

    This module does not access the internet. All of the components +needed to bootstrap pip are included as internal parts of the +package.

    +
    +
    +

    See also

    +
    +
    Installing Python Modules

    The end user guide for installing Python packages

    +
    +
    PEP 453: Explicit bootstrapping of pip in Python installations

    The original rationale and specification for this module.

    +
    +
    +
    +
    +

    Command line interface

    +

    The command line interface is invoked using the interpreter’s -m switch.

    +

    The simplest possible invocation is:

    +
    python -m ensurepip
    +
    +
    +

    This invocation will install pip if it is not already installed, +but otherwise does nothing. To ensure the installed version of pip +is at least as recent as the one bundled with ensurepip, pass the +--upgrade option:

    +
    python -m ensurepip --upgrade
    +
    +
    +

    By default, pip is installed into the current virtual environment +(if one is active) or into the system site packages (if there is no +active virtual environment). The installation location can be controlled +through two additional command line options:

    +
      +
    • --root <dir>: Installs pip relative to the given root directory +rather than the root of the currently active virtual environment (if any) +or the default root for the current Python installation.

    • +
    • --user: Installs pip into the user site packages directory rather +than globally for the current Python installation (this option is not +permitted inside an active virtual environment).

    • +
    +

    By default, the scripts pipX and pipX.Y will be installed (where +X.Y stands for the version of Python used to invoke ensurepip). The +scripts installed can be controlled through two additional command line +options:

    +
      +
    • --altinstall: if an alternate installation is requested, the pipX +script will not be installed.

    • +
    • +
      --default-pip: if a “default pip” installation is requested, the

      pip script will be installed in addition to the two regular scripts.

      +
      +
      +
    • +
    +

    Providing both of the script selection options will trigger an exception.

    +
    +
    +

    Module API

    +

    ensurepip exposes two functions for programmatic use:

    +
    +
    +ensurepip.version()
    +

    Returns a string specifying the bundled version of pip that will be +installed when bootstrapping an environment.

    +
    + +
    +
    +ensurepip.bootstrap(root=None, upgrade=False, user=False, altinstall=False, default_pip=False, verbosity=0)
    +

    Bootstraps pip into the current or designated environment.

    +

    root specifies an alternative root directory to install relative to. +If root is None, then installation uses the default install location +for the current environment.

    +

    upgrade indicates whether or not to upgrade an existing installation +of an earlier version of pip to the bundled version.

    +

    user indicates whether to use the user scheme rather than installing +globally.

    +

    By default, the scripts pipX and pipX.Y will be installed (where +X.Y stands for the current version of Python).

    +

    If altinstall is set, then pipX will not be installed.

    +

    If default_pip is set, then pip will be installed in addition to +the two regular scripts.

    +

    Setting both altinstall and default_pip will trigger +ValueError.

    +

    verbosity controls the level of output to sys.stdout from the +bootstrapping operation.

    +
    +

    Note

    +

    The bootstrapping process has side effects on both sys.path and +os.environ. Invoking the command line interface in a subprocess +instead allows these side effects to be avoided.

    +
    +
    +

    Note

    +

    The bootstrapping process may install additional modules required by +pip, but other software should not assume those dependencies will +always be present by default (as the dependencies may be removed in a +future version of pip).

    +
    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/enum.html b/python-3.7.4-docs-html/library/enum.html new file mode 100644 index 0000000..1a5f374 --- /dev/null +++ b/python-3.7.4-docs-html/library/enum.html @@ -0,0 +1,1328 @@ + + + + + + + enum — Support for enumerations — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    enum — Support for enumerations

    +
    +

    New in version 3.4.

    +
    +

    Source code: Lib/enum.py

    +
    +

    An enumeration is a set of symbolic names (members) bound to unique, +constant values. Within an enumeration, the members can be compared +by identity, and the enumeration itself can be iterated over.

    +
    +

    Module Contents

    +

    This module defines four enumeration classes that can be used to define unique +sets of names and values: Enum, IntEnum, Flag, and +IntFlag. It also defines one decorator, unique(), and one +helper, auto.

    +
    +
    +class enum.Enum
    +

    Base class for creating enumerated constants. See section +Functional API for an alternate construction syntax.

    +
    + +
    +
    +class enum.IntEnum
    +

    Base class for creating enumerated constants that are also +subclasses of int.

    +
    + +
    +
    +class enum.IntFlag
    +

    Base class for creating enumerated constants that can be combined using +the bitwise operators without losing their IntFlag membership. +IntFlag members are also subclasses of int.

    +
    + +
    +
    +class enum.Flag
    +

    Base class for creating enumerated constants that can be combined using +the bitwise operations without losing their Flag membership.

    +
    + +
    +
    +enum.unique()
    +

    Enum class decorator that ensures only one name is bound to any one value.

    +
    + +
    +
    +class enum.auto
    +

    Instances are replaced with an appropriate value for Enum members.

    +
    + +
    +

    New in version 3.6: Flag, IntFlag, auto

    +
    +
    +
    +

    Creating an Enum

    +

    Enumerations are created using the class syntax, which makes them +easy to read and write. An alternative creation method is described in +Functional API. To define an enumeration, subclass Enum as +follows:

    +
    >>> from enum import Enum
    +>>> class Color(Enum):
    +...     RED = 1
    +...     GREEN = 2
    +...     BLUE = 3
    +...
    +
    +
    +
    +

    Note

    +

    Enum member values

    +

    Member values can be anything: int, str, etc.. If +the exact value is unimportant you may use auto instances and an +appropriate value will be chosen for you. Care must be taken if you mix +auto with other values.

    +
    +
    +

    Note

    +

    Nomenclature

    +
      +
    • The class Color is an enumeration (or enum)

    • +
    • The attributes Color.RED, Color.GREEN, etc., are +enumeration members (or enum members) and are functionally constants.

    • +
    • The enum members have names and values (the name of +Color.RED is RED, the value of Color.BLUE is +3, etc.)

    • +
    +
    +
    +

    Note

    +

    Even though we use the class syntax to create Enums, Enums +are not normal Python classes. See How are Enums different? for +more details.

    +
    +

    Enumeration members have human readable string representations:

    +
    >>> print(Color.RED)
    +Color.RED
    +
    +
    +

    …while their repr has more information:

    +
    >>> print(repr(Color.RED))
    +<Color.RED: 1>
    +
    +
    +

    The type of an enumeration member is the enumeration it belongs to:

    +
    >>> type(Color.RED)
    +<enum 'Color'>
    +>>> isinstance(Color.GREEN, Color)
    +True
    +>>>
    +
    +
    +

    Enum members also have a property that contains just their item name:

    +
    >>> print(Color.RED.name)
    +RED
    +
    +
    +

    Enumerations support iteration, in definition order:

    +
    >>> class Shake(Enum):
    +...     VANILLA = 7
    +...     CHOCOLATE = 4
    +...     COOKIES = 9
    +...     MINT = 3
    +...
    +>>> for shake in Shake:
    +...     print(shake)
    +...
    +Shake.VANILLA
    +Shake.CHOCOLATE
    +Shake.COOKIES
    +Shake.MINT
    +
    +
    +

    Enumeration members are hashable, so they can be used in dictionaries and sets:

    +
    >>> apples = {}
    +>>> apples[Color.RED] = 'red delicious'
    +>>> apples[Color.GREEN] = 'granny smith'
    +>>> apples == {Color.RED: 'red delicious', Color.GREEN: 'granny smith'}
    +True
    +
    +
    +
    +
    +

    Programmatic access to enumeration members and their attributes

    +

    Sometimes it’s useful to access members in enumerations programmatically (i.e. +situations where Color.RED won’t do because the exact color is not known +at program-writing time). Enum allows such access:

    +
    >>> Color(1)
    +<Color.RED: 1>
    +>>> Color(3)
    +<Color.BLUE: 3>
    +
    +
    +

    If you want to access enum members by name, use item access:

    +
    >>> Color['RED']
    +<Color.RED: 1>
    +>>> Color['GREEN']
    +<Color.GREEN: 2>
    +
    +
    +

    If you have an enum member and need its name or value:

    +
    >>> member = Color.RED
    +>>> member.name
    +'RED'
    +>>> member.value
    +1
    +
    +
    +
    +
    +

    Duplicating enum members and values

    +

    Having two enum members with the same name is invalid:

    +
    >>> class Shape(Enum):
    +...     SQUARE = 2
    +...     SQUARE = 3
    +...
    +Traceback (most recent call last):
    +...
    +TypeError: Attempted to reuse key: 'SQUARE'
    +
    +
    +

    However, two enum members are allowed to have the same value. Given two members +A and B with the same value (and A defined first), B is an alias to A. By-value +lookup of the value of A and B will return A. By-name lookup of B will also +return A:

    +
    >>> class Shape(Enum):
    +...     SQUARE = 2
    +...     DIAMOND = 1
    +...     CIRCLE = 3
    +...     ALIAS_FOR_SQUARE = 2
    +...
    +>>> Shape.SQUARE
    +<Shape.SQUARE: 2>
    +>>> Shape.ALIAS_FOR_SQUARE
    +<Shape.SQUARE: 2>
    +>>> Shape(2)
    +<Shape.SQUARE: 2>
    +
    +
    +
    +

    Note

    +

    Attempting to create a member with the same name as an already +defined attribute (another member, a method, etc.) or attempting to create +an attribute with the same name as a member is not allowed.

    +
    +
    +
    +

    Ensuring unique enumeration values

    +

    By default, enumerations allow multiple names as aliases for the same value. +When this behavior isn’t desired, the following decorator can be used to +ensure each value is used only once in the enumeration:

    +
    +
    +@enum.unique
    +
    + +

    A class decorator specifically for enumerations. It searches an +enumeration’s __members__ gathering any aliases it finds; if any are +found ValueError is raised with the details:

    +
    >>> from enum import Enum, unique
    +>>> @unique
    +... class Mistake(Enum):
    +...     ONE = 1
    +...     TWO = 2
    +...     THREE = 3
    +...     FOUR = 3
    +...
    +Traceback (most recent call last):
    +...
    +ValueError: duplicate values found in <enum 'Mistake'>: FOUR -> THREE
    +
    +
    +
    +
    +

    Using automatic values

    +

    If the exact value is unimportant you can use auto:

    +
    >>> from enum import Enum, auto
    +>>> class Color(Enum):
    +...     RED = auto()
    +...     BLUE = auto()
    +...     GREEN = auto()
    +...
    +>>> list(Color)
    +[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]
    +
    +
    +

    The values are chosen by _generate_next_value_(), which can be +overridden:

    +
    >>> class AutoName(Enum):
    +...     def _generate_next_value_(name, start, count, last_values):
    +...         return name
    +...
    +>>> class Ordinal(AutoName):
    +...     NORTH = auto()
    +...     SOUTH = auto()
    +...     EAST = auto()
    +...     WEST = auto()
    +...
    +>>> list(Ordinal)
    +[<Ordinal.NORTH: 'NORTH'>, <Ordinal.SOUTH: 'SOUTH'>, <Ordinal.EAST: 'EAST'>, <Ordinal.WEST: 'WEST'>]
    +
    +
    +
    +

    Note

    +

    The goal of the default _generate_next_value_() methods is to provide +the next int in sequence with the last int provided, but +the way it does this is an implementation detail and may change.

    +
    +
    +
    +

    Iteration

    +

    Iterating over the members of an enum does not provide the aliases:

    +
    >>> list(Shape)
    +[<Shape.SQUARE: 2>, <Shape.DIAMOND: 1>, <Shape.CIRCLE: 3>]
    +
    +
    +

    The special attribute __members__ is an ordered dictionary mapping names +to members. It includes all names defined in the enumeration, including the +aliases:

    +
    >>> for name, member in Shape.__members__.items():
    +...     name, member
    +...
    +('SQUARE', <Shape.SQUARE: 2>)
    +('DIAMOND', <Shape.DIAMOND: 1>)
    +('CIRCLE', <Shape.CIRCLE: 3>)
    +('ALIAS_FOR_SQUARE', <Shape.SQUARE: 2>)
    +
    +
    +

    The __members__ attribute can be used for detailed programmatic access to +the enumeration members. For example, finding all the aliases:

    +
    >>> [name for name, member in Shape.__members__.items() if member.name != name]
    +['ALIAS_FOR_SQUARE']
    +
    +
    +
    +
    +

    Comparisons

    +

    Enumeration members are compared by identity:

    +
    >>> Color.RED is Color.RED
    +True
    +>>> Color.RED is Color.BLUE
    +False
    +>>> Color.RED is not Color.BLUE
    +True
    +
    +
    +

    Ordered comparisons between enumeration values are not supported. Enum +members are not integers (but see IntEnum below):

    +
    >>> Color.RED < Color.BLUE
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +TypeError: '<' not supported between instances of 'Color' and 'Color'
    +
    +
    +

    Equality comparisons are defined though:

    +
    >>> Color.BLUE == Color.RED
    +False
    +>>> Color.BLUE != Color.RED
    +True
    +>>> Color.BLUE == Color.BLUE
    +True
    +
    +
    +

    Comparisons against non-enumeration values will always compare not equal +(again, IntEnum was explicitly designed to behave differently, see +below):

    +
    >>> Color.BLUE == 2
    +False
    +
    +
    +
    +
    +

    Allowed members and attributes of enumerations

    +

    The examples above use integers for enumeration values. Using integers is +short and handy (and provided by default by the Functional API), but not +strictly enforced. In the vast majority of use-cases, one doesn’t care what +the actual value of an enumeration is. But if the value is important, +enumerations can have arbitrary values.

    +

    Enumerations are Python classes, and can have methods and special methods as +usual. If we have this enumeration:

    +
    >>> class Mood(Enum):
    +...     FUNKY = 1
    +...     HAPPY = 3
    +...
    +...     def describe(self):
    +...         # self is the member here
    +...         return self.name, self.value
    +...
    +...     def __str__(self):
    +...         return 'my custom str! {0}'.format(self.value)
    +...
    +...     @classmethod
    +...     def favorite_mood(cls):
    +...         # cls here is the enumeration
    +...         return cls.HAPPY
    +...
    +
    +
    +

    Then:

    +
    >>> Mood.favorite_mood()
    +<Mood.HAPPY: 3>
    +>>> Mood.HAPPY.describe()
    +('HAPPY', 3)
    +>>> str(Mood.FUNKY)
    +'my custom str! 1'
    +
    +
    +

    The rules for what is allowed are as follows: names that start and end with +a single underscore are reserved by enum and cannot be used; all other +attributes defined within an enumeration will become members of this +enumeration, with the exception of special methods (__str__(), +__add__(), etc.), descriptors (methods are also descriptors), and +variable names listed in _ignore_.

    +

    Note: if your enumeration defines __new__() and/or __init__() then +whatever value(s) were given to the enum member will be passed into those +methods. See Planet for an example.

    +
    +
    +

    Restricted Enum subclassing

    +

    A new Enum class must have one base Enum class, up to one concrete +data type, and as many object-based mixin classes as needed. The +order of these base classes is:

    +
    class EnumName([mix-in, ...,] [data-type,] base-enum):
    +    pass
    +
    +
    +

    Also, subclassing an enumeration is allowed only if the enumeration does not define +any members. So this is forbidden:

    +
    >>> class MoreColor(Color):
    +...     PINK = 17
    +...
    +Traceback (most recent call last):
    +...
    +TypeError: Cannot extend enumerations
    +
    +
    +

    But this is allowed:

    +
    >>> class Foo(Enum):
    +...     def some_behavior(self):
    +...         pass
    +...
    +>>> class Bar(Foo):
    +...     HAPPY = 1
    +...     SAD = 2
    +...
    +
    +
    +

    Allowing subclassing of enums that define members would lead to a violation of +some important invariants of types and instances. On the other hand, it makes +sense to allow sharing some common behavior between a group of enumerations. +(See OrderedEnum for an example.)

    +
    +
    +

    Pickling

    +

    Enumerations can be pickled and unpickled:

    +
    >>> from test.test_enum import Fruit
    +>>> from pickle import dumps, loads
    +>>> Fruit.TOMATO is loads(dumps(Fruit.TOMATO))
    +True
    +
    +
    +

    The usual restrictions for pickling apply: picklable enums must be defined in +the top level of a module, since unpickling requires them to be importable +from that module.

    +
    +

    Note

    +

    With pickle protocol version 4 it is possible to easily pickle enums +nested in other classes.

    +
    +

    It is possible to modify how Enum members are pickled/unpickled by defining +__reduce_ex__() in the enumeration class.

    +
    +
    +

    Functional API

    +

    The Enum class is callable, providing the following functional API:

    +
    >>> Animal = Enum('Animal', 'ANT BEE CAT DOG')
    +>>> Animal
    +<enum 'Animal'>
    +>>> Animal.ANT
    +<Animal.ANT: 1>
    +>>> Animal.ANT.value
    +1
    +>>> list(Animal)
    +[<Animal.ANT: 1>, <Animal.BEE: 2>, <Animal.CAT: 3>, <Animal.DOG: 4>]
    +
    +
    +

    The semantics of this API resemble namedtuple. The first +argument of the call to Enum is the name of the enumeration.

    +

    The second argument is the source of enumeration member names. It can be a +whitespace-separated string of names, a sequence of names, a sequence of +2-tuples with key/value pairs, or a mapping (e.g. dictionary) of names to +values. The last two options enable assigning arbitrary values to +enumerations; the others auto-assign increasing integers starting with 1 (use +the start parameter to specify a different starting value). A +new class derived from Enum is returned. In other words, the above +assignment to Animal is equivalent to:

    +
    >>> class Animal(Enum):
    +...     ANT = 1
    +...     BEE = 2
    +...     CAT = 3
    +...     DOG = 4
    +...
    +
    +
    +

    The reason for defaulting to 1 as the starting number and not 0 is +that 0 is False in a boolean sense, but enum members all evaluate +to True.

    +

    Pickling enums created with the functional API can be tricky as frame stack +implementation details are used to try and figure out which module the +enumeration is being created in (e.g. it will fail if you use a utility +function in separate module, and also may not work on IronPython or Jython). +The solution is to specify the module name explicitly as follows:

    +
    >>> Animal = Enum('Animal', 'ANT BEE CAT DOG', module=__name__)
    +
    +
    +
    +

    Warning

    +

    If module is not supplied, and Enum cannot determine what it is, +the new Enum members will not be unpicklable; to keep errors closer to +the source, pickling will be disabled.

    +
    +

    The new pickle protocol 4 also, in some circumstances, relies on +__qualname__ being set to the location where pickle will be able +to find the class. For example, if the class was made available in class +SomeData in the global scope:

    +
    >>> Animal = Enum('Animal', 'ANT BEE CAT DOG', qualname='SomeData.Animal')
    +
    +
    +

    The complete signature is:

    +
    Enum(value='NewEnumName', names=<...>, *, module='...', qualname='...', type=<mixed-in class>, start=1)
    +
    +
    +
    +
    value
    +

    What the new Enum class will record as its name.

    +
    +
    names
    +

    The Enum members. This can be a whitespace or comma separated string +(values will start at 1 unless otherwise specified):

    +
    'RED GREEN BLUE' | 'RED,GREEN,BLUE' | 'RED, GREEN, BLUE'
    +
    +
    +

    or an iterator of names:

    +
    ['RED', 'GREEN', 'BLUE']
    +
    +
    +

    or an iterator of (name, value) pairs:

    +
    [('CYAN', 4), ('MAGENTA', 5), ('YELLOW', 6)]
    +
    +
    +

    or a mapping:

    +
    {'CHARTREUSE': 7, 'SEA_GREEN': 11, 'ROSEMARY': 42}
    +
    +
    +
    +
    module
    +

    name of module where new Enum class can be found.

    +
    +
    qualname
    +

    where in module new Enum class can be found.

    +
    +
    type
    +

    type to mix in to new Enum class.

    +
    +
    start
    +

    number to start counting at if only names are passed in.

    +
    +
    +
    +

    Changed in version 3.5: The start parameter was added.

    +
    +
    +
    +

    Derived Enumerations

    +
    +

    IntEnum

    +

    The first variation of Enum that is provided is also a subclass of +int. Members of an IntEnum can be compared to integers; +by extension, integer enumerations of different types can also be compared +to each other:

    +
    >>> from enum import IntEnum
    +>>> class Shape(IntEnum):
    +...     CIRCLE = 1
    +...     SQUARE = 2
    +...
    +>>> class Request(IntEnum):
    +...     POST = 1
    +...     GET = 2
    +...
    +>>> Shape == 1
    +False
    +>>> Shape.CIRCLE == 1
    +True
    +>>> Shape.CIRCLE == Request.POST
    +True
    +
    +
    +

    However, they still can’t be compared to standard Enum enumerations:

    +
    >>> class Shape(IntEnum):
    +...     CIRCLE = 1
    +...     SQUARE = 2
    +...
    +>>> class Color(Enum):
    +...     RED = 1
    +...     GREEN = 2
    +...
    +>>> Shape.CIRCLE == Color.RED
    +False
    +
    +
    +

    IntEnum values behave like integers in other ways you’d expect:

    +
    >>> int(Shape.CIRCLE)
    +1
    +>>> ['a', 'b', 'c'][Shape.CIRCLE]
    +'b'
    +>>> [i for i in range(Shape.SQUARE)]
    +[0, 1]
    +
    +
    +
    +
    +

    IntFlag

    +

    The next variation of Enum provided, IntFlag, is also based +on int. The difference being IntFlag members can be combined +using the bitwise operators (&, |, ^, ~) and the result is still an +IntFlag member. However, as the name implies, IntFlag +members also subclass int and can be used wherever an int is +used. Any operation on an IntFlag member besides the bit-wise +operations will lose the IntFlag membership.

    +
    +

    New in version 3.6.

    +
    +

    Sample IntFlag class:

    +
    >>> from enum import IntFlag
    +>>> class Perm(IntFlag):
    +...     R = 4
    +...     W = 2
    +...     X = 1
    +...
    +>>> Perm.R | Perm.W
    +<Perm.R|W: 6>
    +>>> Perm.R + Perm.W
    +6
    +>>> RW = Perm.R | Perm.W
    +>>> Perm.R in RW
    +True
    +
    +
    +

    It is also possible to name the combinations:

    +
    >>> class Perm(IntFlag):
    +...     R = 4
    +...     W = 2
    +...     X = 1
    +...     RWX = 7
    +>>> Perm.RWX
    +<Perm.RWX: 7>
    +>>> ~Perm.RWX
    +<Perm.-8: -8>
    +
    +
    +

    Another important difference between IntFlag and Enum is that +if no flags are set (the value is 0), its boolean evaluation is False:

    +
    >>> Perm.R & Perm.X
    +<Perm.0: 0>
    +>>> bool(Perm.R & Perm.X)
    +False
    +
    +
    +

    Because IntFlag members are also subclasses of int they can +be combined with them:

    +
    >>> Perm.X | 8
    +<Perm.8|X: 9>
    +
    +
    +
    +
    +

    Flag

    +

    The last variation is Flag. Like IntFlag, Flag +members can be combined using the bitwise operators (&, |, ^, ~). Unlike +IntFlag, they cannot be combined with, nor compared against, any +other Flag enumeration, nor int. While it is possible to +specify the values directly it is recommended to use auto as the +value and let Flag select an appropriate value.

    +
    +

    New in version 3.6.

    +
    +

    Like IntFlag, if a combination of Flag members results in no +flags being set, the boolean evaluation is False:

    +
    >>> from enum import Flag, auto
    +>>> class Color(Flag):
    +...     RED = auto()
    +...     BLUE = auto()
    +...     GREEN = auto()
    +...
    +>>> Color.RED & Color.GREEN
    +<Color.0: 0>
    +>>> bool(Color.RED & Color.GREEN)
    +False
    +
    +
    +

    Individual flags should have values that are powers of two (1, 2, 4, 8, …), +while combinations of flags won’t:

    +
    >>> class Color(Flag):
    +...     RED = auto()
    +...     BLUE = auto()
    +...     GREEN = auto()
    +...     WHITE = RED | BLUE | GREEN
    +...
    +>>> Color.WHITE
    +<Color.WHITE: 7>
    +
    +
    +

    Giving a name to the “no flags set” condition does not change its boolean +value:

    +
    >>> class Color(Flag):
    +...     BLACK = 0
    +...     RED = auto()
    +...     BLUE = auto()
    +...     GREEN = auto()
    +...
    +>>> Color.BLACK
    +<Color.BLACK: 0>
    +>>> bool(Color.BLACK)
    +False
    +
    +
    +
    +

    Note

    +

    For the majority of new code, Enum and Flag are strongly +recommended, since IntEnum and IntFlag break some +semantic promises of an enumeration (by being comparable to integers, and +thus by transitivity to other unrelated enumerations). IntEnum +and IntFlag should be used only in cases where Enum and +Flag will not do; for example, when integer constants are replaced +with enumerations, or for interoperability with other systems.

    +
    +
    +
    +

    Others

    +

    While IntEnum is part of the enum module, it would be very +simple to implement independently:

    +
    class IntEnum(int, Enum):
    +    pass
    +
    +
    +

    This demonstrates how similar derived enumerations can be defined; for example +a StrEnum that mixes in str instead of int.

    +

    Some rules:

    +
      +
    1. When subclassing Enum, mix-in types must appear before +Enum itself in the sequence of bases, as in the IntEnum +example above.

    2. +
    3. While Enum can have members of any type, once you mix in an +additional type, all the members must have values of that type, e.g. +int above. This restriction does not apply to mix-ins which only +add methods and don’t specify another data type such as int or +str.

    4. +
    5. When another data type is mixed in, the value attribute is not the +same as the enum member itself, although it is equivalent and will compare +equal.

    6. +
    7. %-style formatting: %s and %r call the Enum class’s +__str__() and __repr__() respectively; other codes (such as +%i or %h for IntEnum) treat the enum member as its mixed-in type.

    8. +
    9. Formatted string literals, str.format(), +and format() will use the mixed-in +type’s __format__(). If the Enum class’s str() or +repr() is desired, use the !s or !r format codes.

    10. +
    +
    +
    +
    +

    Interesting examples

    +

    While Enum, IntEnum, IntFlag, and Flag are +expected to cover the majority of use-cases, they cannot cover them all. Here +are recipes for some different types of enumerations that can be used directly, +or as examples for creating one’s own.

    +
    +

    Omitting values

    +

    In many use-cases one doesn’t care what the actual value of an enumeration +is. There are several ways to define this type of simple enumeration:

    +
      +
    • use instances of auto for the value

    • +
    • use instances of object as the value

    • +
    • use a descriptive string as the value

    • +
    • use a tuple as the value and a custom __new__() to replace the +tuple with an int value

    • +
    +

    Using any of these methods signifies to the user that these values are not +important, and also enables one to add, remove, or reorder members without +having to renumber the remaining members.

    +

    Whichever method you choose, you should provide a repr() that also hides +the (unimportant) value:

    +
    >>> class NoValue(Enum):
    +...     def __repr__(self):
    +...         return '<%s.%s>' % (self.__class__.__name__, self.name)
    +...
    +
    +
    +
    +

    Using auto

    +

    Using auto would look like:

    +
    >>> class Color(NoValue):
    +...     RED = auto()
    +...     BLUE = auto()
    +...     GREEN = auto()
    +...
    +>>> Color.GREEN
    +<Color.GREEN>
    +
    +
    +
    +
    +

    Using object

    +

    Using object would look like:

    +
    >>> class Color(NoValue):
    +...     RED = object()
    +...     GREEN = object()
    +...     BLUE = object()
    +...
    +>>> Color.GREEN
    +<Color.GREEN>
    +
    +
    +
    +
    +

    Using a descriptive string

    +

    Using a string as the value would look like:

    +
    >>> class Color(NoValue):
    +...     RED = 'stop'
    +...     GREEN = 'go'
    +...     BLUE = 'too fast!'
    +...
    +>>> Color.GREEN
    +<Color.GREEN>
    +>>> Color.GREEN.value
    +'go'
    +
    +
    +
    +
    +

    Using a custom __new__()

    +

    Using an auto-numbering __new__() would look like:

    +
    >>> class AutoNumber(NoValue):
    +...     def __new__(cls):
    +...         value = len(cls.__members__) + 1
    +...         obj = object.__new__(cls)
    +...         obj._value_ = value
    +...         return obj
    +...
    +>>> class Color(AutoNumber):
    +...     RED = ()
    +...     GREEN = ()
    +...     BLUE = ()
    +...
    +>>> Color.GREEN
    +<Color.GREEN>
    +>>> Color.GREEN.value
    +2
    +
    +
    +
    +

    Note

    +

    The __new__() method, if defined, is used during creation of the Enum +members; it is then replaced by Enum’s __new__() which is used after +class creation for lookup of existing members.

    +
    +
    +
    +
    +

    OrderedEnum

    +

    An ordered enumeration that is not based on IntEnum and so maintains +the normal Enum invariants (such as not being comparable to other +enumerations):

    +
    >>> class OrderedEnum(Enum):
    +...     def __ge__(self, other):
    +...         if self.__class__ is other.__class__:
    +...             return self.value >= other.value
    +...         return NotImplemented
    +...     def __gt__(self, other):
    +...         if self.__class__ is other.__class__:
    +...             return self.value > other.value
    +...         return NotImplemented
    +...     def __le__(self, other):
    +...         if self.__class__ is other.__class__:
    +...             return self.value <= other.value
    +...         return NotImplemented
    +...     def __lt__(self, other):
    +...         if self.__class__ is other.__class__:
    +...             return self.value < other.value
    +...         return NotImplemented
    +...
    +>>> class Grade(OrderedEnum):
    +...     A = 5
    +...     B = 4
    +...     C = 3
    +...     D = 2
    +...     F = 1
    +...
    +>>> Grade.C < Grade.A
    +True
    +
    +
    +
    +
    +

    DuplicateFreeEnum

    +

    Raises an error if a duplicate member name is found instead of creating an +alias:

    +
    >>> class DuplicateFreeEnum(Enum):
    +...     def __init__(self, *args):
    +...         cls = self.__class__
    +...         if any(self.value == e.value for e in cls):
    +...             a = self.name
    +...             e = cls(self.value).name
    +...             raise ValueError(
    +...                 "aliases not allowed in DuplicateFreeEnum:  %r --> %r"
    +...                 % (a, e))
    +...
    +>>> class Color(DuplicateFreeEnum):
    +...     RED = 1
    +...     GREEN = 2
    +...     BLUE = 3
    +...     GRENE = 2
    +...
    +Traceback (most recent call last):
    +...
    +ValueError: aliases not allowed in DuplicateFreeEnum:  'GRENE' --> 'GREEN'
    +
    +
    +
    +

    Note

    +

    This is a useful example for subclassing Enum to add or change other +behaviors as well as disallowing aliases. If the only desired change is +disallowing aliases, the unique() decorator can be used instead.

    +
    +
    +
    +

    Planet

    +

    If __new__() or __init__() is defined the value of the enum member +will be passed to those methods:

    +
    >>> class Planet(Enum):
    +...     MERCURY = (3.303e+23, 2.4397e6)
    +...     VENUS   = (4.869e+24, 6.0518e6)
    +...     EARTH   = (5.976e+24, 6.37814e6)
    +...     MARS    = (6.421e+23, 3.3972e6)
    +...     JUPITER = (1.9e+27,   7.1492e7)
    +...     SATURN  = (5.688e+26, 6.0268e7)
    +...     URANUS  = (8.686e+25, 2.5559e7)
    +...     NEPTUNE = (1.024e+26, 2.4746e7)
    +...     def __init__(self, mass, radius):
    +...         self.mass = mass       # in kilograms
    +...         self.radius = radius   # in meters
    +...     @property
    +...     def surface_gravity(self):
    +...         # universal gravitational constant  (m3 kg-1 s-2)
    +...         G = 6.67300E-11
    +...         return G * self.mass / (self.radius * self.radius)
    +...
    +>>> Planet.EARTH.value
    +(5.976e+24, 6378140.0)
    +>>> Planet.EARTH.surface_gravity
    +9.802652743337129
    +
    +
    +
    +
    +

    TimePeriod

    +

    An example to show the _ignore_ attribute in use:

    +
    >>> from datetime import timedelta
    +>>> class Period(timedelta, Enum):
    +...     "different lengths of time"
    +...     _ignore_ = 'Period i'
    +...     Period = vars()
    +...     for i in range(367):
    +...         Period['day_%d' % i] = i
    +...
    +>>> list(Period)[:2]
    +[<Period.day_0: datetime.timedelta(0)>, <Period.day_1: datetime.timedelta(days=1)>]
    +>>> list(Period)[-2:]
    +[<Period.day_365: datetime.timedelta(days=365)>, <Period.day_366: datetime.timedelta(days=366)>]
    +
    +
    +
    +
    +
    +

    How are Enums different?

    +

    Enums have a custom metaclass that affects many aspects of both derived Enum +classes and their instances (members).

    +
    +

    Enum Classes

    +

    The EnumMeta metaclass is responsible for providing the +__contains__(), __dir__(), __iter__() and other methods that +allow one to do things with an Enum class that fail on a typical +class, such as list(Color) or some_enum_var in Color. EnumMeta is +responsible for ensuring that various other methods on the final Enum +class are correct (such as __new__(), __getnewargs__(), +__str__() and __repr__()).

    +
    +
    +

    Enum Members (aka instances)

    +

    The most interesting thing about Enum members is that they are singletons. +EnumMeta creates them all while it is creating the Enum +class itself, and then puts a custom __new__() in place to ensure +that no new ones are ever instantiated by returning only the existing +member instances.

    +
    +
    +

    Finer Points

    +
    +

    Supported __dunder__ names

    +

    __members__ is an OrderedDict of member_name:member +items. It is only available on the class.

    +

    __new__(), if specified, must create and return the enum members; it is +also a very good idea to set the member’s _value_ appropriately. Once +all the members are created it is no longer used.

    +
    +
    +

    Supported _sunder_ names

    +
      +
    • _name_ – name of the member

    • +
    • _value_ – value of the member; can be set / modified in __new__

    • +
    • _missing_ – a lookup function used when a value is not found; may be +overridden

    • +
    • _ignore_ – a list of names, either as a list() or a str(), +that will not be transformed into members, and will be removed from the final +class

    • +
    • _order_ – used in Python 2/3 code to ensure member order is consistent +(class attribute, removed during class creation)

    • +
    • _generate_next_value_ – used by the Functional API and by +auto to get an appropriate value for an enum member; may be +overridden

    • +
    +
    +

    New in version 3.6: _missing_, _order_, _generate_next_value_

    +
    +
    +

    New in version 3.7: _ignore_

    +
    +

    To help keep Python 2 / Python 3 code in sync an _order_ attribute can +be provided. It will be checked against the actual order of the enumeration +and raise an error if the two do not match:

    +
    >>> class Color(Enum):
    +...     _order_ = 'RED GREEN BLUE'
    +...     RED = 1
    +...     BLUE = 3
    +...     GREEN = 2
    +...
    +Traceback (most recent call last):
    +...
    +TypeError: member order does not match _order_
    +
    +
    +
    +

    Note

    +

    In Python 2 code the _order_ attribute is necessary as definition +order is lost before it can be recorded.

    +
    +
    +
    +

    Enum member type

    +

    Enum members are instances of their Enum class, and are +normally accessed as EnumClass.member. Under certain circumstances they +can also be accessed as EnumClass.member.member, but you should never do +this as that lookup may fail or, worse, return something besides the +Enum member you are looking for (this is another good reason to use +all-uppercase names for members):

    +
    >>> class FieldTypes(Enum):
    +...     name = 0
    +...     value = 1
    +...     size = 2
    +...
    +>>> FieldTypes.value.size
    +<FieldTypes.size: 2>
    +>>> FieldTypes.size.value
    +2
    +
    +
    +
    +

    Changed in version 3.5.

    +
    +
    +
    +

    Boolean value of Enum classes and members

    +

    Enum members that are mixed with non-Enum types (such as +int, str, etc.) are evaluated according to the mixed-in +type’s rules; otherwise, all members evaluate as True. To make your +own Enum’s boolean evaluation depend on the member’s value add the following to +your class:

    +
    def __bool__(self):
    +    return bool(self.value)
    +
    +
    +

    Enum classes always evaluate as True.

    +
    +
    +

    Enum classes with methods

    +

    If you give your Enum subclass extra methods, like the Planet +class above, those methods will show up in a dir() of the member, +but not of the class:

    +
    >>> dir(Planet)
    +['EARTH', 'JUPITER', 'MARS', 'MERCURY', 'NEPTUNE', 'SATURN', 'URANUS', 'VENUS', '__class__', '__doc__', '__members__', '__module__']
    +>>> dir(Planet.EARTH)
    +['__class__', '__doc__', '__module__', 'name', 'surface_gravity', 'value']
    +
    +
    +
    +
    +

    Combining members of Flag

    +

    If a combination of Flag members is not named, the repr() will include +all named flags and all named combinations of flags that are in the value:

    +
    >>> class Color(Flag):
    +...     RED = auto()
    +...     GREEN = auto()
    +...     BLUE = auto()
    +...     MAGENTA = RED | BLUE
    +...     YELLOW = RED | GREEN
    +...     CYAN = GREEN | BLUE
    +...
    +>>> Color(3)  # named combination
    +<Color.YELLOW: 3>
    +>>> Color(7)      # not named combination
    +<Color.CYAN|MAGENTA|BLUE|YELLOW|GREEN|RED: 7>
    +
    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/errno.html b/python-3.7.4-docs-html/library/errno.html new file mode 100644 index 0000000..108fbaa --- /dev/null +++ b/python-3.7.4-docs-html/library/errno.html @@ -0,0 +1,936 @@ + + + + + + + errno — Standard errno system symbols — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    errno — Standard errno system symbols

    +
    +

    This module makes available standard errno system symbols. The value of each +symbol is the corresponding integer value. The names and descriptions are +borrowed from linux/include/errno.h, which should be pretty +all-inclusive.

    +
    +
    +errno.errorcode
    +

    Dictionary providing a mapping from the errno value to the string name in the +underlying system. For instance, errno.errorcode[errno.EPERM] maps to +'EPERM'.

    +
    + +

    To translate a numeric error code to an error message, use os.strerror().

    +

    Of the following list, symbols that are not used on the current platform are not +defined by the module. The specific list of defined symbols is available as +errno.errorcode.keys(). Symbols available can include:

    +
    +
    +errno.EPERM
    +

    Operation not permitted

    +
    + +
    +
    +errno.ENOENT
    +

    No such file or directory

    +
    + +
    +
    +errno.ESRCH
    +

    No such process

    +
    + +
    +
    +errno.EINTR
    +

    Interrupted system call.

    +
    +

    See also

    +

    This error is mapped to the exception InterruptedError.

    +
    +
    + +
    +
    +errno.EIO
    +

    I/O error

    +
    + +
    +
    +errno.ENXIO
    +

    No such device or address

    +
    + +
    +
    +errno.E2BIG
    +

    Arg list too long

    +
    + +
    +
    +errno.ENOEXEC
    +

    Exec format error

    +
    + +
    +
    +errno.EBADF
    +

    Bad file number

    +
    + +
    +
    +errno.ECHILD
    +

    No child processes

    +
    + +
    +
    +errno.EAGAIN
    +

    Try again

    +
    + +
    +
    +errno.ENOMEM
    +

    Out of memory

    +
    + +
    +
    +errno.EACCES
    +

    Permission denied

    +
    + +
    +
    +errno.EFAULT
    +

    Bad address

    +
    + +
    +
    +errno.ENOTBLK
    +

    Block device required

    +
    + +
    +
    +errno.EBUSY
    +

    Device or resource busy

    +
    + +
    +
    +errno.EEXIST
    +

    File exists

    +
    + +
    +
    +errno.EXDEV
    +

    Cross-device link

    +
    + +
    +
    +errno.ENODEV
    +

    No such device

    +
    + +
    +
    +errno.ENOTDIR
    +

    Not a directory

    +
    + +
    +
    +errno.EISDIR
    +

    Is a directory

    +
    + +
    +
    +errno.EINVAL
    +

    Invalid argument

    +
    + +
    +
    +errno.ENFILE
    +

    File table overflow

    +
    + +
    +
    +errno.EMFILE
    +

    Too many open files

    +
    + +
    +
    +errno.ENOTTY
    +

    Not a typewriter

    +
    + +
    +
    +errno.ETXTBSY
    +

    Text file busy

    +
    + +
    +
    +errno.EFBIG
    +

    File too large

    +
    + +
    +
    +errno.ENOSPC
    +

    No space left on device

    +
    + +
    +
    +errno.ESPIPE
    +

    Illegal seek

    +
    + +
    +
    +errno.EROFS
    +

    Read-only file system

    +
    + +
    + +

    Too many links

    +
    + +
    +
    +errno.EPIPE
    +

    Broken pipe

    +
    + +
    +
    +errno.EDOM
    +

    Math argument out of domain of func

    +
    + +
    +
    +errno.ERANGE
    +

    Math result not representable

    +
    + +
    +
    +errno.EDEADLK
    +

    Resource deadlock would occur

    +
    + +
    +
    +errno.ENAMETOOLONG
    +

    File name too long

    +
    + +
    +
    +errno.ENOLCK
    +

    No record locks available

    +
    + +
    +
    +errno.ENOSYS
    +

    Function not implemented

    +
    + +
    +
    +errno.ENOTEMPTY
    +

    Directory not empty

    +
    + +
    +
    +errno.ELOOP
    +

    Too many symbolic links encountered

    +
    + +
    +
    +errno.EWOULDBLOCK
    +

    Operation would block

    +
    + +
    +
    +errno.ENOMSG
    +

    No message of desired type

    +
    + +
    +
    +errno.EIDRM
    +

    Identifier removed

    +
    + +
    +
    +errno.ECHRNG
    +

    Channel number out of range

    +
    + +
    +
    +errno.EL2NSYNC
    +

    Level 2 not synchronized

    +
    + +
    +
    +errno.EL3HLT
    +

    Level 3 halted

    +
    + +
    +
    +errno.EL3RST
    +

    Level 3 reset

    +
    + +
    +
    +errno.ELNRNG
    +

    Link number out of range

    +
    + +
    +
    +errno.EUNATCH
    +

    Protocol driver not attached

    +
    + +
    +
    +errno.ENOCSI
    +

    No CSI structure available

    +
    + +
    +
    +errno.EL2HLT
    +

    Level 2 halted

    +
    + +
    +
    +errno.EBADE
    +

    Invalid exchange

    +
    + +
    +
    +errno.EBADR
    +

    Invalid request descriptor

    +
    + +
    +
    +errno.EXFULL
    +

    Exchange full

    +
    + +
    +
    +errno.ENOANO
    +

    No anode

    +
    + +
    +
    +errno.EBADRQC
    +

    Invalid request code

    +
    + +
    +
    +errno.EBADSLT
    +

    Invalid slot

    +
    + +
    +
    +errno.EDEADLOCK
    +

    File locking deadlock error

    +
    + +
    +
    +errno.EBFONT
    +

    Bad font file format

    +
    + +
    +
    +errno.ENOSTR
    +

    Device not a stream

    +
    + +
    +
    +errno.ENODATA
    +

    No data available

    +
    + +
    +
    +errno.ETIME
    +

    Timer expired

    +
    + +
    +
    +errno.ENOSR
    +

    Out of streams resources

    +
    + +
    +
    +errno.ENONET
    +

    Machine is not on the network

    +
    + +
    +
    +errno.ENOPKG
    +

    Package not installed

    +
    + +
    +
    +errno.EREMOTE
    +

    Object is remote

    +
    + +
    + +

    Link has been severed

    +
    + +
    +
    +errno.EADV
    +

    Advertise error

    +
    + +
    +
    +errno.ESRMNT
    +

    Srmount error

    +
    + +
    +
    +errno.ECOMM
    +

    Communication error on send

    +
    + +
    +
    +errno.EPROTO
    +

    Protocol error

    +
    + +
    +
    +errno.EMULTIHOP
    +

    Multihop attempted

    +
    + +
    +
    +errno.EDOTDOT
    +

    RFS specific error

    +
    + +
    +
    +errno.EBADMSG
    +

    Not a data message

    +
    + +
    +
    +errno.EOVERFLOW
    +

    Value too large for defined data type

    +
    + +
    +
    +errno.ENOTUNIQ
    +

    Name not unique on network

    +
    + +
    +
    +errno.EBADFD
    +

    File descriptor in bad state

    +
    + +
    +
    +errno.EREMCHG
    +

    Remote address changed

    +
    + +
    +
    +errno.ELIBACC
    +

    Can not access a needed shared library

    +
    + +
    +
    +errno.ELIBBAD
    +

    Accessing a corrupted shared library

    +
    + +
    +
    +errno.ELIBSCN
    +

    .lib section in a.out corrupted

    +
    + +
    +
    +errno.ELIBMAX
    +

    Attempting to link in too many shared libraries

    +
    + +
    +
    +errno.ELIBEXEC
    +

    Cannot exec a shared library directly

    +
    + +
    +
    +errno.EILSEQ
    +

    Illegal byte sequence

    +
    + +
    +
    +errno.ERESTART
    +

    Interrupted system call should be restarted

    +
    + +
    +
    +errno.ESTRPIPE
    +

    Streams pipe error

    +
    + +
    +
    +errno.EUSERS
    +

    Too many users

    +
    + +
    +
    +errno.ENOTSOCK
    +

    Socket operation on non-socket

    +
    + +
    +
    +errno.EDESTADDRREQ
    +

    Destination address required

    +
    + +
    +
    +errno.EMSGSIZE
    +

    Message too long

    +
    + +
    +
    +errno.EPROTOTYPE
    +

    Protocol wrong type for socket

    +
    + +
    +
    +errno.ENOPROTOOPT
    +

    Protocol not available

    +
    + +
    +
    +errno.EPROTONOSUPPORT
    +

    Protocol not supported

    +
    + +
    +
    +errno.ESOCKTNOSUPPORT
    +

    Socket type not supported

    +
    + +
    +
    +errno.EOPNOTSUPP
    +

    Operation not supported on transport endpoint

    +
    + +
    +
    +errno.EPFNOSUPPORT
    +

    Protocol family not supported

    +
    + +
    +
    +errno.EAFNOSUPPORT
    +

    Address family not supported by protocol

    +
    + +
    +
    +errno.EADDRINUSE
    +

    Address already in use

    +
    + +
    +
    +errno.EADDRNOTAVAIL
    +

    Cannot assign requested address

    +
    + +
    +
    +errno.ENETDOWN
    +

    Network is down

    +
    + +
    +
    +errno.ENETUNREACH
    +

    Network is unreachable

    +
    + +
    +
    +errno.ENETRESET
    +

    Network dropped connection because of reset

    +
    + +
    +
    +errno.ECONNABORTED
    +

    Software caused connection abort

    +
    + +
    +
    +errno.ECONNRESET
    +

    Connection reset by peer

    +
    + +
    +
    +errno.ENOBUFS
    +

    No buffer space available

    +
    + +
    +
    +errno.EISCONN
    +

    Transport endpoint is already connected

    +
    + +
    +
    +errno.ENOTCONN
    +

    Transport endpoint is not connected

    +
    + +
    +
    +errno.ESHUTDOWN
    +

    Cannot send after transport endpoint shutdown

    +
    + +
    +
    +errno.ETOOMANYREFS
    +

    Too many references: cannot splice

    +
    + +
    +
    +errno.ETIMEDOUT
    +

    Connection timed out

    +
    + +
    +
    +errno.ECONNREFUSED
    +

    Connection refused

    +
    + +
    +
    +errno.EHOSTDOWN
    +

    Host is down

    +
    + +
    +
    +errno.EHOSTUNREACH
    +

    No route to host

    +
    + +
    +
    +errno.EALREADY
    +

    Operation already in progress

    +
    + +
    +
    +errno.EINPROGRESS
    +

    Operation now in progress

    +
    + +
    +
    +errno.ESTALE
    +

    Stale NFS file handle

    +
    + +
    +
    +errno.EUCLEAN
    +

    Structure needs cleaning

    +
    + +
    +
    +errno.ENOTNAM
    +

    Not a XENIX named type file

    +
    + +
    +
    +errno.ENAVAIL
    +

    No XENIX semaphores available

    +
    + +
    +
    +errno.EISNAM
    +

    Is a named type file

    +
    + +
    +
    +errno.EREMOTEIO
    +

    Remote I/O error

    +
    + +
    +
    +errno.EDQUOT
    +

    Quota exceeded

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/exceptions.html b/python-3.7.4-docs-html/library/exceptions.html new file mode 100644 index 0000000..c2ce80e --- /dev/null +++ b/python-3.7.4-docs-html/library/exceptions.html @@ -0,0 +1,1075 @@ + + + + + + + Built-in Exceptions — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Built-in Exceptions

    +

    In Python, all exceptions must be instances of a class that derives from +BaseException. In a try statement with an except +clause that mentions a particular class, that clause also handles any exception +classes derived from that class (but not exception classes from which it is +derived). Two exception classes that are not related via subclassing are never +equivalent, even if they have the same name.

    +

    The built-in exceptions listed below can be generated by the interpreter or +built-in functions. Except where mentioned, they have an “associated value” +indicating the detailed cause of the error. This may be a string or a tuple of +several items of information (e.g., an error code and a string explaining the +code). The associated value is usually passed as arguments to the exception +class’s constructor.

    +

    User code can raise built-in exceptions. This can be used to test an exception +handler or to report an error condition “just like” the situation in which the +interpreter raises the same exception; but beware that there is nothing to +prevent user code from raising an inappropriate error.

    +

    The built-in exception classes can be subclassed to define new exceptions; +programmers are encouraged to derive new exceptions from the Exception +class or one of its subclasses, and not from BaseException. More +information on defining exceptions is available in the Python Tutorial under +User-defined Exceptions.

    +

    When raising (or re-raising) an exception in an except or +finally clause +__context__ is automatically set to the last exception caught; if the +new exception is not handled the traceback that is eventually displayed will +include the originating exception(s) and the final exception.

    +

    When raising a new exception (rather than using a bare raise to re-raise +the exception currently being handled), the implicit exception context can be +supplemented with an explicit cause by using from with +raise:

    +
    raise new_exc from original_exc
    +
    +
    +

    The expression following from must be an exception or None. It +will be set as __cause__ on the raised exception. Setting +__cause__ also implicitly sets the __suppress_context__ +attribute to True, so that using raise new_exc from None +effectively replaces the old exception with the new one for display +purposes (e.g. converting KeyError to AttributeError), while +leaving the old exception available in __context__ for introspection +when debugging.

    +

    The default traceback display code shows these chained exceptions in +addition to the traceback for the exception itself. An explicitly chained +exception in __cause__ is always shown when present. An implicitly +chained exception in __context__ is shown only if __cause__ +is None and __suppress_context__ is false.

    +

    In either case, the exception itself is always shown after any chained +exceptions so that the final line of the traceback always shows the last +exception that was raised.

    +
    +

    Base classes

    +

    The following exceptions are used mostly as base classes for other exceptions.

    +
    +
    +exception BaseException
    +

    The base class for all built-in exceptions. It is not meant to be directly +inherited by user-defined classes (for that, use Exception). If +str() is called on an instance of this class, the representation of +the argument(s) to the instance are returned, or the empty string when +there were no arguments.

    +
    +
    +args
    +

    The tuple of arguments given to the exception constructor. Some built-in +exceptions (like OSError) expect a certain number of arguments and +assign a special meaning to the elements of this tuple, while others are +usually called only with a single string giving an error message.

    +
    + +
    +
    +with_traceback(tb)
    +

    This method sets tb as the new traceback for the exception and returns +the exception object. It is usually used in exception handling code like +this:

    +
    try:
    +    ...
    +except SomeException:
    +    tb = sys.exc_info()[2]
    +    raise OtherException(...).with_traceback(tb)
    +
    +
    +
    + +
    + +
    +
    +exception Exception
    +

    All built-in, non-system-exiting exceptions are derived from this class. All +user-defined exceptions should also be derived from this class.

    +
    + +
    +
    +exception ArithmeticError
    +

    The base class for those built-in exceptions that are raised for various +arithmetic errors: OverflowError, ZeroDivisionError, +FloatingPointError.

    +
    + +
    +
    +exception BufferError
    +

    Raised when a buffer related operation cannot be +performed.

    +
    + +
    +
    +exception LookupError
    +

    The base class for the exceptions that are raised when a key or index used on +a mapping or sequence is invalid: IndexError, KeyError. This +can be raised directly by codecs.lookup().

    +
    + +
    +
    +

    Concrete exceptions

    +

    The following exceptions are the exceptions that are usually raised.

    +
    +
    +exception AssertionError
    +

    Raised when an assert statement fails.

    +
    + +
    +
    +exception AttributeError
    +

    Raised when an attribute reference (see Attribute references) or +assignment fails. (When an object does not support attribute references or +attribute assignments at all, TypeError is raised.)

    +
    + +
    +
    +exception EOFError
    +

    Raised when the input() function hits an end-of-file condition (EOF) +without reading any data. (N.B.: the io.IOBase.read() and +io.IOBase.readline() methods return an empty string when they hit EOF.)

    +
    + +
    +
    +exception FloatingPointError
    +

    Not currently used.

    +
    + +
    +
    +exception GeneratorExit
    +

    Raised when a generator or coroutine is closed; +see generator.close() and coroutine.close(). It +directly inherits from BaseException instead of Exception since +it is technically not an error.

    +
    + +
    +
    +exception ImportError
    +

    Raised when the import statement has troubles trying to +load a module. Also raised when the “from list” in from ... import +has a name that cannot be found.

    +

    The name and path attributes can be set using keyword-only +arguments to the constructor. When set they represent the name of the module +that was attempted to be imported and the path to any file which triggered +the exception, respectively.

    +
    +

    Changed in version 3.3: Added the name and path attributes.

    +
    +
    + +
    +
    +exception ModuleNotFoundError
    +

    A subclass of ImportError which is raised by import +when a module could not be located. It is also raised when None +is found in sys.modules.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +exception IndexError
    +

    Raised when a sequence subscript is out of range. (Slice indices are +silently truncated to fall in the allowed range; if an index is not an +integer, TypeError is raised.)

    +
    + +
    +
    +exception KeyError
    +

    Raised when a mapping (dictionary) key is not found in the set of existing keys.

    +
    + +
    +
    +exception KeyboardInterrupt
    +

    Raised when the user hits the interrupt key (normally Control-C or +Delete). During execution, a check for interrupts is made +regularly. The exception inherits from BaseException so as to not be +accidentally caught by code that catches Exception and thus prevent +the interpreter from exiting.

    +
    + +
    +
    +exception MemoryError
    +

    Raised when an operation runs out of memory but the situation may still be +rescued (by deleting some objects). The associated value is a string indicating +what kind of (internal) operation ran out of memory. Note that because of the +underlying memory management architecture (C’s malloc() function), the +interpreter may not always be able to completely recover from this situation; it +nevertheless raises an exception so that a stack traceback can be printed, in +case a run-away program was the cause.

    +
    + +
    +
    +exception NameError
    +

    Raised when a local or global name is not found. This applies only to +unqualified names. The associated value is an error message that includes the +name that could not be found.

    +
    + +
    +
    +exception NotImplementedError
    +

    This exception is derived from RuntimeError. In user defined base +classes, abstract methods should raise this exception when they require +derived classes to override the method, or while the class is being +developed to indicate that the real implementation still needs to be added.

    +
    +

    Note

    +

    It should not be used to indicate that an operator or method is not +meant to be supported at all – in that case either leave the operator / +method undefined or, if a subclass, set it to None.

    +
    +
    +

    Note

    +

    NotImplementedError and NotImplemented are not interchangeable, +even though they have similar names and purposes. See +NotImplemented for details on when to use it.

    +
    +
    + +
    +
    +exception OSError([arg])
    +
    +exception OSError(errno, strerror[, filename[, winerror[, filename2]]])
    +

    This exception is raised when a system function returns a system-related +error, including I/O failures such as “file not found” or “disk full” +(not for illegal argument types or other incidental errors).

    +

    The second form of the constructor sets the corresponding attributes, +described below. The attributes default to None if not +specified. For backwards compatibility, if three arguments are passed, +the args attribute contains only a 2-tuple +of the first two constructor arguments.

    +

    The constructor often actually returns a subclass of OSError, as +described in OS exceptions below. The particular subclass depends on +the final errno value. This behaviour only occurs when +constructing OSError directly or via an alias, and is not +inherited when subclassing.

    +
    +
    +errno
    +

    A numeric error code from the C variable errno.

    +
    + +
    +
    +winerror
    +

    Under Windows, this gives you the native +Windows error code. The errno attribute is then an approximate +translation, in POSIX terms, of that native error code.

    +

    Under Windows, if the winerror constructor argument is an integer, +the errno attribute is determined from the Windows error code, +and the errno argument is ignored. On other platforms, the +winerror argument is ignored, and the winerror attribute +does not exist.

    +
    + +
    +
    +strerror
    +

    The corresponding error message, as provided by +the operating system. It is formatted by the C +functions perror() under POSIX, and FormatMessage() +under Windows.

    +
    + +
    +
    +filename
    +
    +filename2
    +

    For exceptions that involve a file system path (such as open() or +os.unlink()), filename is the file name passed to the function. +For functions that involve two file system paths (such as +os.rename()), filename2 corresponds to the second +file name passed to the function.

    +
    + +
    +

    Changed in version 3.3: EnvironmentError, IOError, WindowsError, +socket.error, select.error and +mmap.error have been merged into OSError, and the +constructor may return a subclass.

    +
    +
    +

    Changed in version 3.4: The filename attribute is now the original file name passed to +the function, instead of the name encoded to or decoded from the +filesystem encoding. Also, the filename2 constructor argument and +attribute was added.

    +
    +
    + +
    +
    +exception OverflowError
    +

    Raised when the result of an arithmetic operation is too large to be +represented. This cannot occur for integers (which would rather raise +MemoryError than give up). However, for historical reasons, +OverflowError is sometimes raised for integers that are outside a required +range. Because of the lack of standardization of floating point exception +handling in C, most floating point operations are not checked.

    +
    + +
    +
    +exception RecursionError
    +

    This exception is derived from RuntimeError. It is raised when the +interpreter detects that the maximum recursion depth (see +sys.getrecursionlimit()) is exceeded.

    +
    +

    New in version 3.5: Previously, a plain RuntimeError was raised.

    +
    +
    + +
    +
    +exception ReferenceError
    +

    This exception is raised when a weak reference proxy, created by the +weakref.proxy() function, is used to access an attribute of the referent +after it has been garbage collected. For more information on weak references, +see the weakref module.

    +
    + +
    +
    +exception RuntimeError
    +

    Raised when an error is detected that doesn’t fall in any of the other +categories. The associated value is a string indicating what precisely went +wrong.

    +
    + +
    +
    +exception StopIteration
    +

    Raised by built-in function next() and an iterator’s +__next__() method to signal that there are no further +items produced by the iterator.

    +

    The exception object has a single attribute value, which is +given as an argument when constructing the exception, and defaults +to None.

    +

    When a generator or coroutine function +returns, a new StopIteration instance is +raised, and the value returned by the function is used as the +value parameter to the constructor of the exception.

    +

    If a generator code directly or indirectly raises StopIteration, +it is converted into a RuntimeError (retaining the +StopIteration as the new exception’s cause).

    +
    +

    Changed in version 3.3: Added value attribute and the ability for generator functions to +use it to return a value.

    +
    +
    +

    Changed in version 3.5: Introduced the RuntimeError transformation via +from __future__ import generator_stop, see PEP 479.

    +
    +
    +

    Changed in version 3.7: Enable PEP 479 for all code by default: a StopIteration +error raised in a generator is transformed into a RuntimeError.

    +
    +
    + +
    +
    +exception StopAsyncIteration
    +

    Must be raised by __anext__() method of an +asynchronous iterator object to stop the iteration.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +exception SyntaxError
    +

    Raised when the parser encounters a syntax error. This may occur in an +import statement, in a call to the built-in functions exec() +or eval(), or when reading the initial script or standard input +(also interactively).

    +

    Instances of this class have attributes filename, lineno, +offset and text for easier access to the details. str() +of the exception instance returns only the message.

    +
    + +
    +
    +exception IndentationError
    +

    Base class for syntax errors related to incorrect indentation. This is a +subclass of SyntaxError.

    +
    + +
    +
    +exception TabError
    +

    Raised when indentation contains an inconsistent use of tabs and spaces. +This is a subclass of IndentationError.

    +
    + +
    +
    +exception SystemError
    +

    Raised when the interpreter finds an internal error, but the situation does not +look so serious to cause it to abandon all hope. The associated value is a +string indicating what went wrong (in low-level terms).

    +

    You should report this to the author or maintainer of your Python interpreter. +Be sure to report the version of the Python interpreter (sys.version; it is +also printed at the start of an interactive Python session), the exact error +message (the exception’s associated value) and if possible the source of the +program that triggered the error.

    +
    + +
    +
    +exception SystemExit
    +

    This exception is raised by the sys.exit() function. It inherits from +BaseException instead of Exception so that it is not accidentally +caught by code that catches Exception. This allows the exception to +properly propagate up and cause the interpreter to exit. When it is not +handled, the Python interpreter exits; no stack traceback is printed. The +constructor accepts the same optional argument passed to sys.exit(). +If the value is an integer, it specifies the system exit status (passed to +C’s exit() function); if it is None, the exit status is zero; if +it has another type (such as a string), the object’s value is printed and +the exit status is one.

    +

    A call to sys.exit() is translated into an exception so that clean-up +handlers (finally clauses of try statements) can be +executed, and so that a debugger can execute a script without running the risk +of losing control. The os._exit() function can be used if it is +absolutely positively necessary to exit immediately (for example, in the child +process after a call to os.fork()).

    +
    +
    +code
    +

    The exit status or error message that is passed to the constructor. +(Defaults to None.)

    +
    + +
    + +
    +
    +exception TypeError
    +

    Raised when an operation or function is applied to an object of inappropriate +type. The associated value is a string giving details about the type mismatch.

    +

    This exception may be raised by user code to indicate that an attempted +operation on an object is not supported, and is not meant to be. If an object +is meant to support a given operation but has not yet provided an +implementation, NotImplementedError is the proper exception to raise.

    +

    Passing arguments of the wrong type (e.g. passing a list when an +int is expected) should result in a TypeError, but passing +arguments with the wrong value (e.g. a number outside expected boundaries) +should result in a ValueError.

    +
    + +
    +
    +exception UnboundLocalError
    +

    Raised when a reference is made to a local variable in a function or method, but +no value has been bound to that variable. This is a subclass of +NameError.

    +
    + +
    +
    +exception UnicodeError
    +

    Raised when a Unicode-related encoding or decoding error occurs. It is a +subclass of ValueError.

    +

    UnicodeError has attributes that describe the encoding or decoding +error. For example, err.object[err.start:err.end] gives the particular +invalid input that the codec failed on.

    +
    +
    +encoding
    +

    The name of the encoding that raised the error.

    +
    + +
    +
    +reason
    +

    A string describing the specific codec error.

    +
    + +
    +
    +object
    +

    The object the codec was attempting to encode or decode.

    +
    + +
    +
    +start
    +

    The first index of invalid data in object.

    +
    + +
    +
    +end
    +

    The index after the last invalid data in object.

    +
    + +
    + +
    +
    +exception UnicodeEncodeError
    +

    Raised when a Unicode-related error occurs during encoding. It is a subclass of +UnicodeError.

    +
    + +
    +
    +exception UnicodeDecodeError
    +

    Raised when a Unicode-related error occurs during decoding. It is a subclass of +UnicodeError.

    +
    + +
    +
    +exception UnicodeTranslateError
    +

    Raised when a Unicode-related error occurs during translating. It is a subclass +of UnicodeError.

    +
    + +
    +
    +exception ValueError
    +

    Raised when an operation or function receives an argument that has the +right type but an inappropriate value, and the situation is not described by a +more precise exception such as IndexError.

    +
    + +
    +
    +exception ZeroDivisionError
    +

    Raised when the second argument of a division or modulo operation is zero. The +associated value is a string indicating the type of the operands and the +operation.

    +
    + +

    The following exceptions are kept for compatibility with previous versions; +starting from Python 3.3, they are aliases of OSError.

    +
    +
    +exception EnvironmentError
    +
    + +
    +
    +exception IOError
    +
    + +
    +
    +exception WindowsError
    +

    Only available on Windows.

    +
    + +
    +

    OS exceptions

    +

    The following exceptions are subclasses of OSError, they get raised +depending on the system error code.

    +
    +
    +exception BlockingIOError
    +

    Raised when an operation would block on an object (e.g. socket) set +for non-blocking operation. +Corresponds to errno EAGAIN, EALREADY, +EWOULDBLOCK and EINPROGRESS.

    +

    In addition to those of OSError, BlockingIOError can have +one more attribute:

    +
    +
    +characters_written
    +

    An integer containing the number of characters written to the stream +before it blocked. This attribute is available when using the +buffered I/O classes from the io module.

    +
    + +
    + +
    +
    +exception ChildProcessError
    +

    Raised when an operation on a child process failed. +Corresponds to errno ECHILD.

    +
    + +
    +
    +exception ConnectionError
    +

    A base class for connection-related issues.

    +

    Subclasses are BrokenPipeError, ConnectionAbortedError, +ConnectionRefusedError and ConnectionResetError.

    +
    + +
    +
    +exception BrokenPipeError
    +

    A subclass of ConnectionError, raised when trying to write on a +pipe while the other end has been closed, or trying to write on a socket +which has been shutdown for writing. +Corresponds to errno EPIPE and ESHUTDOWN.

    +
    + +
    +
    +exception ConnectionAbortedError
    +

    A subclass of ConnectionError, raised when a connection attempt +is aborted by the peer. +Corresponds to errno ECONNABORTED.

    +
    + +
    +
    +exception ConnectionRefusedError
    +

    A subclass of ConnectionError, raised when a connection attempt +is refused by the peer. +Corresponds to errno ECONNREFUSED.

    +
    + +
    +
    +exception ConnectionResetError
    +

    A subclass of ConnectionError, raised when a connection is +reset by the peer. +Corresponds to errno ECONNRESET.

    +
    + +
    +
    +exception FileExistsError
    +

    Raised when trying to create a file or directory which already exists. +Corresponds to errno EEXIST.

    +
    + +
    +
    +exception FileNotFoundError
    +

    Raised when a file or directory is requested but doesn’t exist. +Corresponds to errno ENOENT.

    +
    + +
    +
    +exception InterruptedError
    +

    Raised when a system call is interrupted by an incoming signal. +Corresponds to errno EINTR.

    +
    +

    Changed in version 3.5: Python now retries system calls when a syscall is interrupted by a +signal, except if the signal handler raises an exception (see PEP 475 +for the rationale), instead of raising InterruptedError.

    +
    +
    + +
    +
    +exception IsADirectoryError
    +

    Raised when a file operation (such as os.remove()) is requested +on a directory. +Corresponds to errno EISDIR.

    +
    + +
    +
    +exception NotADirectoryError
    +

    Raised when a directory operation (such as os.listdir()) is requested +on something which is not a directory. +Corresponds to errno ENOTDIR.

    +
    + +
    +
    +exception PermissionError
    +

    Raised when trying to run an operation without the adequate access +rights - for example filesystem permissions. +Corresponds to errno EACCES and EPERM.

    +
    + +
    +
    +exception ProcessLookupError
    +

    Raised when a given process doesn’t exist. +Corresponds to errno ESRCH.

    +
    + +
    +
    +exception TimeoutError
    +

    Raised when a system function timed out at the system level. +Corresponds to errno ETIMEDOUT.

    +
    + +
    +

    New in version 3.3: All the above OSError subclasses were added.

    +
    +
    +

    See also

    +

    PEP 3151 - Reworking the OS and IO exception hierarchy

    +
    +
    +
    +
    +

    Warnings

    +

    The following exceptions are used as warning categories; see the +Warning Categories documentation for more details.

    +
    +
    +exception Warning
    +

    Base class for warning categories.

    +
    + +
    +
    +exception UserWarning
    +

    Base class for warnings generated by user code.

    +
    + +
    +
    +exception DeprecationWarning
    +

    Base class for warnings about deprecated features when those warnings are +intended for other Python developers.

    +
    + +
    +
    +exception PendingDeprecationWarning
    +

    Base class for warnings about features which are obsolete and +expected to be deprecated in the future, but are not deprecated +at the moment.

    +

    This class is rarely used as emitting a warning about a possible +upcoming deprecation is unusual, and DeprecationWarning +is preferred for already active deprecations.

    +
    + +
    +
    +exception SyntaxWarning
    +

    Base class for warnings about dubious syntax.

    +
    + +
    +
    +exception RuntimeWarning
    +

    Base class for warnings about dubious runtime behavior.

    +
    + +
    +
    +exception FutureWarning
    +

    Base class for warnings about deprecated features when those warnings are +intended for end users of applications that are written in Python.

    +
    + +
    +
    +exception ImportWarning
    +

    Base class for warnings about probable mistakes in module imports.

    +
    + +
    +
    +exception UnicodeWarning
    +

    Base class for warnings related to Unicode.

    +
    + +
    +
    +exception BytesWarning
    +

    Base class for warnings related to bytes and bytearray.

    +
    + +
    +
    +exception ResourceWarning
    +

    Base class for warnings related to resource usage. Ignored by the default +warning filters.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +

    Exception hierarchy

    +

    The class hierarchy for built-in exceptions is:

    +
    BaseException
    + +-- SystemExit
    + +-- KeyboardInterrupt
    + +-- GeneratorExit
    + +-- Exception
    +      +-- StopIteration
    +      +-- StopAsyncIteration
    +      +-- ArithmeticError
    +      |    +-- FloatingPointError
    +      |    +-- OverflowError
    +      |    +-- ZeroDivisionError
    +      +-- AssertionError
    +      +-- AttributeError
    +      +-- BufferError
    +      +-- EOFError
    +      +-- ImportError
    +      |    +-- ModuleNotFoundError
    +      +-- LookupError
    +      |    +-- IndexError
    +      |    +-- KeyError
    +      +-- MemoryError
    +      +-- NameError
    +      |    +-- UnboundLocalError
    +      +-- OSError
    +      |    +-- BlockingIOError
    +      |    +-- ChildProcessError
    +      |    +-- ConnectionError
    +      |    |    +-- BrokenPipeError
    +      |    |    +-- ConnectionAbortedError
    +      |    |    +-- ConnectionRefusedError
    +      |    |    +-- ConnectionResetError
    +      |    +-- FileExistsError
    +      |    +-- FileNotFoundError
    +      |    +-- InterruptedError
    +      |    +-- IsADirectoryError
    +      |    +-- NotADirectoryError
    +      |    +-- PermissionError
    +      |    +-- ProcessLookupError
    +      |    +-- TimeoutError
    +      +-- ReferenceError
    +      +-- RuntimeError
    +      |    +-- NotImplementedError
    +      |    +-- RecursionError
    +      +-- SyntaxError
    +      |    +-- IndentationError
    +      |         +-- TabError
    +      +-- SystemError
    +      +-- TypeError
    +      +-- ValueError
    +      |    +-- UnicodeError
    +      |         +-- UnicodeDecodeError
    +      |         +-- UnicodeEncodeError
    +      |         +-- UnicodeTranslateError
    +      +-- Warning
    +           +-- DeprecationWarning
    +           +-- PendingDeprecationWarning
    +           +-- RuntimeWarning
    +           +-- SyntaxWarning
    +           +-- UserWarning
    +           +-- FutureWarning
    +           +-- ImportWarning
    +           +-- UnicodeWarning
    +           +-- BytesWarning
    +           +-- ResourceWarning
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/faulthandler.html b/python-3.7.4-docs-html/library/faulthandler.html new file mode 100644 index 0000000..1eda27d --- /dev/null +++ b/python-3.7.4-docs-html/library/faulthandler.html @@ -0,0 +1,357 @@ + + + + + + + faulthandler — Dump the Python traceback — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    faulthandler — Dump the Python traceback

    +
    +

    New in version 3.3.

    +
    +
    +

    This module contains functions to dump Python tracebacks explicitly, on a fault, +after a timeout, or on a user signal. Call faulthandler.enable() to +install fault handlers for the SIGSEGV, SIGFPE, +SIGABRT, SIGBUS, and SIGILL signals. You can also +enable them at startup by setting the PYTHONFAULTHANDLER environment +variable or by using the -X faulthandler command line option.

    +

    The fault handler is compatible with system fault handlers like Apport or the +Windows fault handler. The module uses an alternative stack for signal handlers +if the sigaltstack() function is available. This allows it to dump the +traceback even on a stack overflow.

    +

    The fault handler is called on catastrophic cases and therefore can only use +signal-safe functions (e.g. it cannot allocate memory on the heap). Because of +this limitation traceback dumping is minimal compared to normal Python +tracebacks:

    +
      +
    • Only ASCII is supported. The backslashreplace error handler is used on +encoding.

    • +
    • Each string is limited to 500 characters.

    • +
    • Only the filename, the function name and the line number are +displayed. (no source code)

    • +
    • It is limited to 100 frames and 100 threads.

    • +
    • The order is reversed: the most recent call is shown first.

    • +
    +

    By default, the Python traceback is written to sys.stderr. To see +tracebacks, applications must be run in the terminal. A log file can +alternatively be passed to faulthandler.enable().

    +

    The module is implemented in C, so tracebacks can be dumped on a crash or when +Python is deadlocked.

    +
    +

    Dumping the traceback

    +
    +
    +faulthandler.dump_traceback(file=sys.stderr, all_threads=True)
    +

    Dump the tracebacks of all threads into file. If all_threads is +False, dump only the current thread.

    +
    +

    Changed in version 3.5: Added support for passing file descriptor to this function.

    +
    +
    + +
    +
    +

    Fault handler state

    +
    +
    +faulthandler.enable(file=sys.stderr, all_threads=True)
    +

    Enable the fault handler: install handlers for the SIGSEGV, +SIGFPE, SIGABRT, SIGBUS and SIGILL +signals to dump the Python traceback. If all_threads is True, +produce tracebacks for every running thread. Otherwise, dump only the current +thread.

    +

    The file must be kept open until the fault handler is disabled: see +issue with file descriptors.

    +
    +

    Changed in version 3.5: Added support for passing file descriptor to this function.

    +
    +
    +

    Changed in version 3.6: On Windows, a handler for Windows exception is also installed.

    +
    +
    + +
    +
    +faulthandler.disable()
    +

    Disable the fault handler: uninstall the signal handlers installed by +enable().

    +
    + +
    +
    +faulthandler.is_enabled()
    +

    Check if the fault handler is enabled.

    +
    + +
    +
    +

    Dumping the tracebacks after a timeout

    +
    +
    +faulthandler.dump_traceback_later(timeout, repeat=False, file=sys.stderr, exit=False)
    +

    Dump the tracebacks of all threads, after a timeout of timeout seconds, or +every timeout seconds if repeat is True. If exit is True, call +_exit() with status=1 after dumping the tracebacks. (Note +_exit() exits the process immediately, which means it doesn’t do any +cleanup like flushing file buffers.) If the function is called twice, the new +call replaces previous parameters and resets the timeout. The timer has a +sub-second resolution.

    +

    The file must be kept open until the traceback is dumped or +cancel_dump_traceback_later() is called: see issue with file +descriptors.

    +

    This function is implemented using a watchdog thread and therefore is not +available if Python is compiled with threads disabled.

    +
    +

    Changed in version 3.5: Added support for passing file descriptor to this function.

    +
    +
    + +
    +
    +faulthandler.cancel_dump_traceback_later()
    +

    Cancel the last call to dump_traceback_later().

    +
    + +
    +
    +

    Dumping the traceback on a user signal

    +
    +
    +faulthandler.register(signum, file=sys.stderr, all_threads=True, chain=False)
    +

    Register a user signal: install a handler for the signum signal to dump +the traceback of all threads, or of the current thread if all_threads is +False, into file. Call the previous handler if chain is True.

    +

    The file must be kept open until the signal is unregistered by +unregister(): see issue with file descriptors.

    +

    Not available on Windows.

    +
    +

    Changed in version 3.5: Added support for passing file descriptor to this function.

    +
    +
    + +
    +
    +faulthandler.unregister(signum)
    +

    Unregister a user signal: uninstall the handler of the signum signal +installed by register(). Return True if the signal was registered, +False otherwise.

    +

    Not available on Windows.

    +
    + +
    +
    +

    Issue with file descriptors

    +

    enable(), dump_traceback_later() and register() keep the +file descriptor of their file argument. If the file is closed and its file +descriptor is reused by a new file, or if os.dup2() is used to replace +the file descriptor, the traceback will be written into a different file. Call +these functions again each time that the file is replaced.

    +
    +
    +

    Example

    +

    Example of a segmentation fault on Linux with and without enabling the fault +handler:

    +
    $ python3 -c "import ctypes; ctypes.string_at(0)"
    +Segmentation fault
    +
    +$ python3 -q -X faulthandler
    +>>> import ctypes
    +>>> ctypes.string_at(0)
    +Fatal Python error: Segmentation fault
    +
    +Current thread 0x00007fb899f39700 (most recent call first):
    +  File "/home/python/cpython/Lib/ctypes/__init__.py", line 486 in string_at
    +  File "<stdin>", line 1 in <module>
    +Segmentation fault
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/fcntl.html b/python-3.7.4-docs-html/library/fcntl.html new file mode 100644 index 0000000..07287b9 --- /dev/null +++ b/python-3.7.4-docs-html/library/fcntl.html @@ -0,0 +1,329 @@ + + + + + + + fcntl — The fcntl and ioctl system calls — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    fcntl — The fcntl and ioctl system calls

    +
    +

    This module performs file control and I/O control on file descriptors. It is an +interface to the fcntl() and ioctl() Unix routines. For a +complete description of these calls, see fcntl(2) and +ioctl(2) Unix manual pages.

    +

    All functions in this module take a file descriptor fd as their first +argument. This can be an integer file descriptor, such as returned by +sys.stdin.fileno(), or an io.IOBase object, such as sys.stdin +itself, which provides a fileno() that returns a genuine file +descriptor.

    +
    +

    Changed in version 3.3: Operations in this module used to raise an IOError where they now +raise an OSError.

    +
    +

    The module defines the following functions:

    +
    +
    +fcntl.fcntl(fd, cmd, arg=0)
    +

    Perform the operation cmd on file descriptor fd (file objects providing +a fileno() method are accepted as well). The values used +for cmd are operating system dependent, and are available as constants +in the fcntl module, using the same names as used in the relevant C +header files. The argument arg can either be an integer value, or a +bytes object. With an integer value, the return value of this +function is the integer return value of the C fcntl() call. When +the argument is bytes it represents a binary structure, e.g. created by +struct.pack(). The binary data is copied to a buffer whose address is +passed to the C fcntl() call. The return value after a successful +call is the contents of the buffer, converted to a bytes object. +The length of the returned object will be the same as the length of the +arg argument. This is limited to 1024 bytes. If the information returned +in the buffer by the operating system is larger than 1024 bytes, this is +most likely to result in a segmentation violation or a more subtle data +corruption.

    +

    If the fcntl() fails, an OSError is raised.

    +
    + +
    +
    +fcntl.ioctl(fd, request, arg=0, mutate_flag=True)
    +

    This function is identical to the fcntl() function, except +that the argument handling is even more complicated.

    +

    The request parameter is limited to values that can fit in 32-bits. +Additional constants of interest for use as the request argument can be +found in the termios module, under the same names as used in +the relevant C header files.

    +

    The parameter arg can be one of an integer, an object supporting the +read-only buffer interface (like bytes) or an object supporting +the read-write buffer interface (like bytearray).

    +

    In all but the last case, behaviour is as for the fcntl() +function.

    +

    If a mutable buffer is passed, then the behaviour is determined by the value of +the mutate_flag parameter.

    +

    If it is false, the buffer’s mutability is ignored and behaviour is as for a +read-only buffer, except that the 1024 byte limit mentioned above is avoided – +so long as the buffer you pass is at least as long as what the operating system +wants to put there, things should work.

    +

    If mutate_flag is true (the default), then the buffer is (in effect) passed +to the underlying ioctl() system call, the latter’s return code is +passed back to the calling Python, and the buffer’s new contents reflect the +action of the ioctl(). This is a slight simplification, because if the +supplied buffer is less than 1024 bytes long it is first copied into a static +buffer 1024 bytes long which is then passed to ioctl() and copied back +into the supplied buffer.

    +

    If the ioctl() fails, an OSError exception is raised.

    +

    An example:

    +
    >>> import array, fcntl, struct, termios, os
    +>>> os.getpgrp()
    +13341
    +>>> struct.unpack('h', fcntl.ioctl(0, termios.TIOCGPGRP, "  "))[0]
    +13341
    +>>> buf = array.array('h', [0])
    +>>> fcntl.ioctl(0, termios.TIOCGPGRP, buf, 1)
    +0
    +>>> buf
    +array('h', [13341])
    +
    +
    +
    + +
    +
    +fcntl.flock(fd, operation)
    +

    Perform the lock operation operation on file descriptor fd (file objects providing +a fileno() method are accepted as well). See the Unix manual +flock(2) for details. (On some systems, this function is emulated +using fcntl().)

    +

    If the flock() fails, an OSError exception is raised.

    +
    + +
    +
    +fcntl.lockf(fd, cmd, len=0, start=0, whence=0)
    +

    This is essentially a wrapper around the fcntl() locking calls. +fd is the file descriptor of the file to lock or unlock, and cmd +is one of the following values:

    +
      +
    • LOCK_UN – unlock

    • +
    • LOCK_SH – acquire a shared lock

    • +
    • LOCK_EX – acquire an exclusive lock

    • +
    +

    When cmd is LOCK_SH or LOCK_EX, it can also be +bitwise ORed with LOCK_NB to avoid blocking on lock acquisition. +If LOCK_NB is used and the lock cannot be acquired, an +OSError will be raised and the exception will have an errno +attribute set to EACCES or EAGAIN (depending on the +operating system; for portability, check for both values). On at least some +systems, LOCK_EX can only be used if the file descriptor refers to a +file opened for writing.

    +

    len is the number of bytes to lock, start is the byte offset at +which the lock starts, relative to whence, and whence is as with +io.IOBase.seek(), specifically:

    +
      +
    • 0 – relative to the start of the file (os.SEEK_SET)

    • +
    • 1 – relative to the current buffer position (os.SEEK_CUR)

    • +
    • 2 – relative to the end of the file (os.SEEK_END)

    • +
    +

    The default for start is 0, which means to start at the beginning of the file. +The default for len is 0 which means to lock to the end of the file. The +default for whence is also 0.

    +
    + +

    Examples (all on a SVR4 compliant system):

    +
    import struct, fcntl, os
    +
    +f = open(...)
    +rv = fcntl.fcntl(f, fcntl.F_SETFL, os.O_NDELAY)
    +
    +lockdata = struct.pack('hhllhh', fcntl.F_WRLCK, 0, 0, 0, 0, 0)
    +rv = fcntl.fcntl(f, fcntl.F_SETLKW, lockdata)
    +
    +
    +

    Note that in the first example the return value variable rv will hold an +integer value; in the second example it will hold a bytes object. The +structure lay-out for the lockdata variable is system dependent — therefore +using the flock() call may be better.

    +
    +

    See also

    +
    +
    Module os

    If the locking flags O_SHLOCK and O_EXLOCK are +present in the os module (on BSD only), the os.open() +function provides an alternative to the lockf() and flock() +functions.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/filecmp.html b/python-3.7.4-docs-html/library/filecmp.html new file mode 100644 index 0000000..e673f44 --- /dev/null +++ b/python-3.7.4-docs-html/library/filecmp.html @@ -0,0 +1,392 @@ + + + + + + + filecmp — File and Directory Comparisons — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    filecmp — File and Directory Comparisons

    +

    Source code: Lib/filecmp.py

    +
    +

    The filecmp module defines functions to compare files and directories, +with various optional time/correctness trade-offs. For comparing files, +see also the difflib module.

    +

    The filecmp module defines the following functions:

    +
    +
    +filecmp.cmp(f1, f2, shallow=True)
    +

    Compare the files named f1 and f2, returning True if they seem equal, +False otherwise.

    +

    If shallow is true, files with identical os.stat() signatures are +taken to be equal. Otherwise, the contents of the files are compared.

    +

    Note that no external programs are called from this function, giving it +portability and efficiency.

    +

    This function uses a cache for past comparisons and the results, +with cache entries invalidated if the os.stat() information for the +file changes. The entire cache may be cleared using clear_cache().

    +
    + +
    +
    +filecmp.cmpfiles(dir1, dir2, common, shallow=True)
    +

    Compare the files in the two directories dir1 and dir2 whose names are +given by common.

    +

    Returns three lists of file names: match, mismatch, +errors. match contains the list of files that match, mismatch contains +the names of those that don’t, and errors lists the names of files which +could not be compared. Files are listed in errors if they don’t exist in +one of the directories, the user lacks permission to read them or if the +comparison could not be done for some other reason.

    +

    The shallow parameter has the same meaning and default value as for +filecmp.cmp().

    +

    For example, cmpfiles('a', 'b', ['c', 'd/e']) will compare a/c with +b/c and a/d/e with b/d/e. 'c' and 'd/e' will each be in +one of the three returned lists.

    +
    + +
    +
    +filecmp.clear_cache()
    +

    Clear the filecmp cache. This may be useful if a file is compared so quickly +after it is modified that it is within the mtime resolution of +the underlying filesystem.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +

    The dircmp class

    +
    +
    +class filecmp.dircmp(a, b, ignore=None, hide=None)
    +

    Construct a new directory comparison object, to compare the directories a +and b. ignore is a list of names to ignore, and defaults to +filecmp.DEFAULT_IGNORES. hide is a list of names to hide, and +defaults to [os.curdir, os.pardir].

    +

    The dircmp class compares files by doing shallow comparisons +as described for filecmp.cmp().

    +

    The dircmp class provides the following methods:

    +
    +
    +report()
    +

    Print (to sys.stdout) a comparison between a and b.

    +
    + +
    +
    +report_partial_closure()
    +

    Print a comparison between a and b and common immediate +subdirectories.

    +
    + +
    +
    +report_full_closure()
    +

    Print a comparison between a and b and common subdirectories +(recursively).

    +
    + +

    The dircmp class offers a number of interesting attributes that may be +used to get various bits of information about the directory trees being +compared.

    +

    Note that via __getattr__() hooks, all attributes are computed lazily, +so there is no speed penalty if only those attributes which are lightweight +to compute are used.

    +
    +
    +left
    +

    The directory a.

    +
    + +
    +
    +right
    +

    The directory b.

    +
    + +
    +
    +left_list
    +

    Files and subdirectories in a, filtered by hide and ignore.

    +
    + +
    +
    +right_list
    +

    Files and subdirectories in b, filtered by hide and ignore.

    +
    + +
    +
    +common
    +

    Files and subdirectories in both a and b.

    +
    + +
    +
    +left_only
    +

    Files and subdirectories only in a.

    +
    + +
    +
    +right_only
    +

    Files and subdirectories only in b.

    +
    + +
    +
    +common_dirs
    +

    Subdirectories in both a and b.

    +
    + +
    +
    +common_files
    +

    Files in both a and b.

    +
    + +
    +
    +common_funny
    +

    Names in both a and b, such that the type differs between the +directories, or names for which os.stat() reports an error.

    +
    + +
    +
    +same_files
    +

    Files which are identical in both a and b, using the class’s +file comparison operator.

    +
    + +
    +
    +diff_files
    +

    Files which are in both a and b, whose contents differ according +to the class’s file comparison operator.

    +
    + +
    +
    +funny_files
    +

    Files which are in both a and b, but could not be compared.

    +
    + +
    +
    +subdirs
    +

    A dictionary mapping names in common_dirs to dircmp +objects.

    +
    + +
    + +
    +
    +filecmp.DEFAULT_IGNORES
    +
    +

    New in version 3.4.

    +
    +

    List of directories ignored by dircmp by default.

    +
    + +

    Here is a simplified example of using the subdirs attribute to search +recursively through two directories to show common different files:

    +
    >>> from filecmp import dircmp
    +>>> def print_diff_files(dcmp):
    +...     for name in dcmp.diff_files:
    +...         print("diff_file %s found in %s and %s" % (name, dcmp.left,
    +...               dcmp.right))
    +...     for sub_dcmp in dcmp.subdirs.values():
    +...         print_diff_files(sub_dcmp)
    +...
    +>>> dcmp = dircmp('dir1', 'dir2') 
    +>>> print_diff_files(dcmp) 
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/fileformats.html b/python-3.7.4-docs-html/library/fileformats.html new file mode 100644 index 0000000..803d7ff --- /dev/null +++ b/python-3.7.4-docs-html/library/fileformats.html @@ -0,0 +1,223 @@ + + + + + + + File Formats — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/fileinput.html b/python-3.7.4-docs-html/library/fileinput.html new file mode 100644 index 0000000..fbb1dcc --- /dev/null +++ b/python-3.7.4-docs-html/library/fileinput.html @@ -0,0 +1,376 @@ + + + + + + + fileinput — Iterate over lines from multiple input streams — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    fileinput — Iterate over lines from multiple input streams

    +

    Source code: Lib/fileinput.py

    +
    +

    This module implements a helper class and functions to quickly write a +loop over standard input or a list of files. If you just want to read or +write one file see open().

    +

    The typical use is:

    +
    import fileinput
    +for line in fileinput.input():
    +    process(line)
    +
    +
    +

    This iterates over the lines of all files listed in sys.argv[1:], defaulting +to sys.stdin if the list is empty. If a filename is '-', it is also +replaced by sys.stdin and the optional arguments mode and openhook +are ignored. To specify an alternative list of filenames, pass it as the +first argument to input(). A single file name is also allowed.

    +

    All files are opened in text mode by default, but you can override this by +specifying the mode parameter in the call to input() or +FileInput. If an I/O error occurs during opening or reading a file, +OSError is raised.

    +
    +

    Changed in version 3.3: IOError used to be raised; it is now an alias of OSError.

    +
    +

    If sys.stdin is used more than once, the second and further use will return +no lines, except perhaps for interactive use, or if it has been explicitly reset +(e.g. using sys.stdin.seek(0)).

    +

    Empty files are opened and immediately closed; the only time their presence in +the list of filenames is noticeable at all is when the last file opened is +empty.

    +

    Lines are returned with any newlines intact, which means that the last line in +a file may not have one.

    +

    You can control how files are opened by providing an opening hook via the +openhook parameter to fileinput.input() or FileInput(). The +hook must be a function that takes two arguments, filename and mode, and +returns an accordingly opened file-like object. Two useful hooks are already +provided by this module.

    +

    The following function is the primary interface of this module:

    +
    +
    +fileinput.input(files=None, inplace=False, backup='', bufsize=0, mode='r', openhook=None)
    +

    Create an instance of the FileInput class. The instance will be used +as global state for the functions of this module, and is also returned to use +during iteration. The parameters to this function will be passed along to the +constructor of the FileInput class.

    +

    The FileInput instance can be used as a context manager in the +with statement. In this example, input is closed after the +with statement is exited, even if an exception occurs:

    +
    with fileinput.input(files=('spam.txt', 'eggs.txt')) as f:
    +    for line in f:
    +        process(line)
    +
    +
    +
    +

    Changed in version 3.2: Can be used as a context manager.

    +
    +
    +

    Deprecated since version 3.6, will be removed in version 3.8: The bufsize parameter.

    +
    +
    + +

    The following functions use the global state created by fileinput.input(); +if there is no active state, RuntimeError is raised.

    +
    +
    +fileinput.filename()
    +

    Return the name of the file currently being read. Before the first line has +been read, returns None.

    +
    + +
    +
    +fileinput.fileno()
    +

    Return the integer “file descriptor” for the current file. When no file is +opened (before the first line and between files), returns -1.

    +
    + +
    +
    +fileinput.lineno()
    +

    Return the cumulative line number of the line that has just been read. Before +the first line has been read, returns 0. After the last line of the last +file has been read, returns the line number of that line.

    +
    + +
    +
    +fileinput.filelineno()
    +

    Return the line number in the current file. Before the first line has been +read, returns 0. After the last line of the last file has been read, +returns the line number of that line within the file.

    +
    + +
    +
    +fileinput.isfirstline()
    +

    Returns true if the line just read is the first line of its file, otherwise +returns false.

    +
    + +
    +
    +fileinput.isstdin()
    +

    Returns true if the last line was read from sys.stdin, otherwise returns +false.

    +
    + +
    +
    +fileinput.nextfile()
    +

    Close the current file so that the next iteration will read the first line from +the next file (if any); lines not read from the file will not count towards the +cumulative line count. The filename is not changed until after the first line +of the next file has been read. Before the first line has been read, this +function has no effect; it cannot be used to skip the first file. After the +last line of the last file has been read, this function has no effect.

    +
    + +
    +
    +fileinput.close()
    +

    Close the sequence.

    +
    + +

    The class which implements the sequence behavior provided by the module is +available for subclassing as well:

    +
    +
    +class fileinput.FileInput(files=None, inplace=False, backup='', bufsize=0, mode='r', openhook=None)
    +

    Class FileInput is the implementation; its methods filename(), +fileno(), lineno(), filelineno(), isfirstline(), +isstdin(), nextfile() and close() correspond to the +functions of the same name in the module. In addition it has a +readline() method which returns the next input line, +and a __getitem__() method which implements the sequence behavior. +The sequence must be accessed in strictly sequential order; random access +and readline() cannot be mixed.

    +

    With mode you can specify which file mode will be passed to open(). It +must be one of 'r', 'rU', 'U' and 'rb'.

    +

    The openhook, when given, must be a function that takes two arguments, +filename and mode, and returns an accordingly opened file-like object. You +cannot use inplace and openhook together.

    +

    A FileInput instance can be used as a context manager in the +with statement. In this example, input is closed after the +with statement is exited, even if an exception occurs:

    +
    with FileInput(files=('spam.txt', 'eggs.txt')) as input:
    +    process(input)
    +
    +
    +
    +

    Changed in version 3.2: Can be used as a context manager.

    +
    +
    +

    Deprecated since version 3.4: The 'rU' and 'U' modes.

    +
    +
    +

    Deprecated since version 3.6, will be removed in version 3.8: The bufsize parameter.

    +
    +
    + +

    Optional in-place filtering: if the keyword argument inplace=True is +passed to fileinput.input() or to the FileInput constructor, the +file is moved to a backup file and standard output is directed to the input file +(if a file of the same name as the backup file already exists, it will be +replaced silently). This makes it possible to write a filter that rewrites its +input file in place. If the backup parameter is given (typically as +backup='.<some extension>'), it specifies the extension for the backup file, +and the backup file remains around; by default, the extension is '.bak' and +it is deleted when the output file is closed. In-place filtering is disabled +when standard input is read.

    +

    The two following opening hooks are provided by this module:

    +
    +
    +fileinput.hook_compressed(filename, mode)
    +

    Transparently opens files compressed with gzip and bzip2 (recognized by the +extensions '.gz' and '.bz2') using the gzip and bz2 +modules. If the filename extension is not '.gz' or '.bz2', the file is +opened normally (ie, using open() without any decompression).

    +

    Usage example: fi = fileinput.FileInput(openhook=fileinput.hook_compressed)

    +
    + +
    +
    +fileinput.hook_encoded(encoding, errors=None)
    +

    Returns a hook which opens each file with open(), using the given +encoding and errors to read the file.

    +

    Usage example: fi = +fileinput.FileInput(openhook=fileinput.hook_encoded("utf-8", +"surrogateescape"))

    +
    +

    Changed in version 3.6: Added the optional errors parameter.

    +
    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/filesys.html b/python-3.7.4-docs-html/library/filesys.html new file mode 100644 index 0000000..4066191 --- /dev/null +++ b/python-3.7.4-docs-html/library/filesys.html @@ -0,0 +1,247 @@ + + + + + + + File and Directory Access — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    File and Directory Access

    +

    The modules described in this chapter deal with disk files and directories. For +example, there are modules for reading the properties of files, manipulating +paths in a portable way, and creating temporary files. The full list of modules +in this chapter is:

    + +
    +

    See also

    +
    +
    Module os

    Operating system interfaces, including functions to work with files at a +lower level than Python file objects.

    +
    +
    Module io

    Python’s built-in I/O library, including both abstract classes and +some concrete classes such as file I/O.

    +
    +
    Built-in function open()

    The standard way to open files for reading and writing with Python.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/fnmatch.html b/python-3.7.4-docs-html/library/fnmatch.html new file mode 100644 index 0000000..d61d5e5 --- /dev/null +++ b/python-3.7.4-docs-html/library/fnmatch.html @@ -0,0 +1,280 @@ + + + + + + + fnmatch — Unix filename pattern matching — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    fnmatch — Unix filename pattern matching

    +

    Source code: Lib/fnmatch.py

    +
    +

    This module provides support for Unix shell-style wildcards, which are not the +same as regular expressions (which are documented in the re module). The +special characters used in shell-style wildcards are:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Pattern

    Meaning

    *

    matches everything

    ?

    matches any single character

    [seq]

    matches any character in seq

    [!seq]

    matches any character not in seq

    +

    For a literal match, wrap the meta-characters in brackets. +For example, '[?]' matches the character '?'.

    +

    Note that the filename separator ('/' on Unix) is not special to this +module. See module glob for pathname expansion (glob uses +filter() to match pathname segments). Similarly, filenames starting with +a period are not special for this module, and are matched by the * and ? +patterns.

    +
    +
    +fnmatch.fnmatch(filename, pattern)
    +

    Test whether the filename string matches the pattern string, returning +True or False. Both parameters are case-normalized +using os.path.normcase(). fnmatchcase() can be used to perform a +case-sensitive comparison, regardless of whether that’s standard for the +operating system.

    +

    This example will print all file names in the current directory with the +extension .txt:

    +
    import fnmatch
    +import os
    +
    +for file in os.listdir('.'):
    +    if fnmatch.fnmatch(file, '*.txt'):
    +        print(file)
    +
    +
    +
    + +
    +
    +fnmatch.fnmatchcase(filename, pattern)
    +

    Test whether filename matches pattern, returning True or +False; the comparison is case-sensitive and does not apply +os.path.normcase().

    +
    + +
    +
    +fnmatch.filter(names, pattern)
    +

    Return the subset of the list of names that match pattern. It is the same as +[n for n in names if fnmatch(n, pattern)], but implemented more efficiently.

    +
    + +
    +
    +fnmatch.translate(pattern)
    +

    Return the shell-style pattern converted to a regular expression for +using with re.match().

    +

    Example:

    +
    >>> import fnmatch, re
    +>>>
    +>>> regex = fnmatch.translate('*.txt')
    +>>> regex
    +'(?s:.*\\.txt)\\Z'
    +>>> reobj = re.compile(regex)
    +>>> reobj.match('foobar.txt')
    +<re.Match object; span=(0, 10), match='foobar.txt'>
    +
    +
    +
    + +
    +

    See also

    +
    +
    Module glob

    Unix shell-style path expansion.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/formatter.html b/python-3.7.4-docs-html/library/formatter.html new file mode 100644 index 0000000..124c9e7 --- /dev/null +++ b/python-3.7.4-docs-html/library/formatter.html @@ -0,0 +1,551 @@ + + + + + + + formatter — Generic output formatting — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    formatter — Generic output formatting

    +
    +

    Deprecated since version 3.4: Due to lack of usage, the formatter module has been deprecated.

    +
    +
    +

    This module supports two interface definitions, each with multiple +implementations: The formatter interface, and the writer interface which is +required by the formatter interface.

    +

    Formatter objects transform an abstract flow of formatting events into specific +output events on writer objects. Formatters manage several stack structures to +allow various properties of a writer object to be changed and restored; writers +need not be able to handle relative changes nor any sort of “change back” +operation. Specific writer properties which may be controlled via formatter +objects are horizontal alignment, font, and left margin indentations. A +mechanism is provided which supports providing arbitrary, non-exclusive style +settings to a writer as well. Additional interfaces facilitate formatting +events which are not reversible, such as paragraph separation.

    +

    Writer objects encapsulate device interfaces. Abstract devices, such as file +formats, are supported as well as physical devices. The provided +implementations all work with abstract devices. The interface makes available +mechanisms for setting the properties which formatter objects manage and +inserting data into the output.

    +
    +

    The Formatter Interface

    +

    Interfaces to create formatters are dependent on the specific formatter class +being instantiated. The interfaces described below are the required interfaces +which all formatters must support once initialized.

    +

    One data element is defined at the module level:

    +
    +
    +formatter.AS_IS
    +

    Value which can be used in the font specification passed to the push_font() +method described below, or as the new value to any other push_property() +method. Pushing the AS_IS value allows the corresponding pop_property() +method to be called without having to track whether the property was changed.

    +
    + +

    The following attributes are defined for formatter instance objects:

    +
    +
    +formatter.writer
    +

    The writer instance with which the formatter interacts.

    +
    + +
    +
    +formatter.end_paragraph(blanklines)
    +

    Close any open paragraphs and insert at least blanklines before the next +paragraph.

    +
    + +
    +
    +formatter.add_line_break()
    +

    Add a hard line break if one does not already exist. This does not break the +logical paragraph.

    +
    + +
    +
    +formatter.add_hor_rule(*args, **kw)
    +

    Insert a horizontal rule in the output. A hard break is inserted if there is +data in the current paragraph, but the logical paragraph is not broken. The +arguments and keywords are passed on to the writer’s send_line_break() +method.

    +
    + +
    +
    +formatter.add_flowing_data(data)
    +

    Provide data which should be formatted with collapsed whitespace. Whitespace +from preceding and successive calls to add_flowing_data() is considered as +well when the whitespace collapse is performed. The data which is passed to +this method is expected to be word-wrapped by the output device. Note that any +word-wrapping still must be performed by the writer object due to the need to +rely on device and font information.

    +
    + +
    +
    +formatter.add_literal_data(data)
    +

    Provide data which should be passed to the writer unchanged. Whitespace, +including newline and tab characters, are considered legal in the value of +data.

    +
    + +
    +
    +formatter.add_label_data(format, counter)
    +

    Insert a label which should be placed to the left of the current left margin. +This should be used for constructing bulleted or numbered lists. If the +format value is a string, it is interpreted as a format specification for +counter, which should be an integer. The result of this formatting becomes the +value of the label; if format is not a string it is used as the label value +directly. The label value is passed as the only argument to the writer’s +send_label_data() method. Interpretation of non-string label values is +dependent on the associated writer.

    +

    Format specifications are strings which, in combination with a counter value, +are used to compute label values. Each character in the format string is copied +to the label value, with some characters recognized to indicate a transform on +the counter value. Specifically, the character '1' represents the counter +value formatter as an Arabic number, the characters 'A' and 'a' +represent alphabetic representations of the counter value in upper and lower +case, respectively, and 'I' and 'i' represent the counter value in Roman +numerals, in upper and lower case. Note that the alphabetic and roman +transforms require that the counter value be greater than zero.

    +
    + +
    +
    +formatter.flush_softspace()
    +

    Send any pending whitespace buffered from a previous call to +add_flowing_data() to the associated writer object. This should be called +before any direct manipulation of the writer object.

    +
    + +
    +
    +formatter.push_alignment(align)
    +

    Push a new alignment setting onto the alignment stack. This may be +AS_IS if no change is desired. If the alignment value is changed from +the previous setting, the writer’s new_alignment() method is called with +the align value.

    +
    + +
    +
    +formatter.pop_alignment()
    +

    Restore the previous alignment.

    +
    + +
    +
    +formatter.push_font((size, italic, bold, teletype))
    +

    Change some or all font properties of the writer object. Properties which are +not set to AS_IS are set to the values passed in while others are +maintained at their current settings. The writer’s new_font() method is +called with the fully resolved font specification.

    +
    + +
    +
    +formatter.pop_font()
    +

    Restore the previous font.

    +
    + +
    +
    +formatter.push_margin(margin)
    +

    Increase the number of left margin indentations by one, associating the logical +tag margin with the new indentation. The initial margin level is 0. +Changed values of the logical tag must be true values; false values other than +AS_IS are not sufficient to change the margin.

    +
    + +
    +
    +formatter.pop_margin()
    +

    Restore the previous margin.

    +
    + +
    +
    +formatter.push_style(*styles)
    +

    Push any number of arbitrary style specifications. All styles are pushed onto +the styles stack in order. A tuple representing the entire stack, including +AS_IS values, is passed to the writer’s new_styles() method.

    +
    + +
    +
    +formatter.pop_style(n=1)
    +

    Pop the last n style specifications passed to push_style(). A tuple +representing the revised stack, including AS_IS values, is passed to +the writer’s new_styles() method.

    +
    + +
    +
    +formatter.set_spacing(spacing)
    +

    Set the spacing style for the writer.

    +
    + +
    +
    +formatter.assert_line_data(flag=1)
    +

    Inform the formatter that data has been added to the current paragraph +out-of-band. This should be used when the writer has been manipulated +directly. The optional flag argument can be set to false if the writer +manipulations produced a hard line break at the end of the output.

    +
    + +
    +
    +

    Formatter Implementations

    +

    Two implementations of formatter objects are provided by this module. Most +applications may use one of these classes without modification or subclassing.

    +
    +
    +class formatter.NullFormatter(writer=None)
    +

    A formatter which does nothing. If writer is omitted, a NullWriter +instance is created. No methods of the writer are called by +NullFormatter instances. Implementations should inherit from this +class if implementing a writer interface but don’t need to inherit any +implementation.

    +
    + +
    +
    +class formatter.AbstractFormatter(writer)
    +

    The standard formatter. This implementation has demonstrated wide applicability +to many writers, and may be used directly in most circumstances. It has been +used to implement a full-featured World Wide Web browser.

    +
    + +
    +
    +

    The Writer Interface

    +

    Interfaces to create writers are dependent on the specific writer class being +instantiated. The interfaces described below are the required interfaces which +all writers must support once initialized. Note that while most applications can +use the AbstractFormatter class as a formatter, the writer must +typically be provided by the application.

    +
    +
    +writer.flush()
    +

    Flush any buffered output or device control events.

    +
    + +
    +
    +writer.new_alignment(align)
    +

    Set the alignment style. The align value can be any object, but by convention +is a string or None, where None indicates that the writer’s “preferred” +alignment should be used. Conventional align values are 'left', +'center', 'right', and 'justify'.

    +
    + +
    +
    +writer.new_font(font)
    +

    Set the font style. The value of font will be None, indicating that the +device’s default font should be used, or a tuple of the form (size, +italic, bold, teletype). Size will be a string indicating the size of +font that should be used; specific strings and their interpretation must be +defined by the application. The italic, bold, and teletype values are +Boolean values specifying which of those font attributes should be used.

    +
    + +
    +
    +writer.new_margin(margin, level)
    +

    Set the margin level to the integer level and the logical tag to margin. +Interpretation of the logical tag is at the writer’s discretion; the only +restriction on the value of the logical tag is that it not be a false value for +non-zero values of level.

    +
    + +
    +
    +writer.new_spacing(spacing)
    +

    Set the spacing style to spacing.

    +
    + +
    +
    +writer.new_styles(styles)
    +

    Set additional styles. The styles value is a tuple of arbitrary values; the +value AS_IS should be ignored. The styles tuple may be interpreted +either as a set or as a stack depending on the requirements of the application +and writer implementation.

    +
    + +
    +
    +writer.send_line_break()
    +

    Break the current line.

    +
    + +
    +
    +writer.send_paragraph(blankline)
    +

    Produce a paragraph separation of at least blankline blank lines, or the +equivalent. The blankline value will be an integer. Note that the +implementation will receive a call to send_line_break() before this call +if a line break is needed; this method should not include ending the last line +of the paragraph. It is only responsible for vertical spacing between +paragraphs.

    +
    + +
    +
    +writer.send_hor_rule(*args, **kw)
    +

    Display a horizontal rule on the output device. The arguments to this method +are entirely application- and writer-specific, and should be interpreted with +care. The method implementation may assume that a line break has already been +issued via send_line_break().

    +
    + +
    +
    +writer.send_flowing_data(data)
    +

    Output character data which may be word-wrapped and re-flowed as needed. Within +any sequence of calls to this method, the writer may assume that spans of +multiple whitespace characters have been collapsed to single space characters.

    +
    + +
    +
    +writer.send_literal_data(data)
    +

    Output character data which has already been formatted for display. Generally, +this should be interpreted to mean that line breaks indicated by newline +characters should be preserved and no new line breaks should be introduced. The +data may contain embedded newline and tab characters, unlike data provided to +the send_formatted_data() interface.

    +
    + +
    +
    +writer.send_label_data(data)
    +

    Set data to the left of the current left margin, if possible. The value of +data is not restricted; treatment of non-string values is entirely +application- and writer-dependent. This method will only be called at the +beginning of a line.

    +
    + +
    +
    +

    Writer Implementations

    +

    Three implementations of the writer object interface are provided as examples by +this module. Most applications will need to derive new writer classes from the +NullWriter class.

    +
    +
    +class formatter.NullWriter
    +

    A writer which only provides the interface definition; no actions are taken on +any methods. This should be the base class for all writers which do not need to +inherit any implementation methods.

    +
    + +
    +
    +class formatter.AbstractWriter
    +

    A writer which can be used in debugging formatters, but not much else. Each +method simply announces itself by printing its name and arguments on standard +output.

    +
    + +
    +
    +class formatter.DumbWriter(file=None, maxcol=72)
    +

    Simple writer class which writes output on the file object passed +in as file or, if file is omitted, on standard output. The output is +simply word-wrapped to the number of columns specified by maxcol. This +class is suitable for reflowing a sequence of paragraphs.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/fractions.html b/python-3.7.4-docs-html/library/fractions.html new file mode 100644 index 0000000..63194b4 --- /dev/null +++ b/python-3.7.4-docs-html/library/fractions.html @@ -0,0 +1,372 @@ + + + + + + + fractions — Rational numbers — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    fractions — Rational numbers

    +

    Source code: Lib/fractions.py

    +
    +

    The fractions module provides support for rational number arithmetic.

    +

    A Fraction instance can be constructed from a pair of integers, from +another rational number, or from a string.

    +
    +
    +class fractions.Fraction(numerator=0, denominator=1)
    +
    +class fractions.Fraction(other_fraction)
    +
    +class fractions.Fraction(float)
    +
    +class fractions.Fraction(decimal)
    +
    +class fractions.Fraction(string)
    +

    The first version requires that numerator and denominator are instances +of numbers.Rational and returns a new Fraction instance +with value numerator/denominator. If denominator is 0, it +raises a ZeroDivisionError. The second version requires that +other_fraction is an instance of numbers.Rational and returns a +Fraction instance with the same value. The next two versions accept +either a float or a decimal.Decimal instance, and return a +Fraction instance with exactly the same value. Note that due to the +usual issues with binary floating-point (see Floating Point Arithmetic: Issues and Limitations), the +argument to Fraction(1.1) is not exactly equal to 11/10, and so +Fraction(1.1) does not return Fraction(11, 10) as one might expect. +(But see the documentation for the limit_denominator() method below.) +The last version of the constructor expects a string or unicode instance. +The usual form for this instance is:

    +
    [sign] numerator ['/' denominator]
    +
    +
    +

    where the optional sign may be either ‘+’ or ‘-‘ and +numerator and denominator (if present) are strings of +decimal digits. In addition, any string that represents a finite +value and is accepted by the float constructor is also +accepted by the Fraction constructor. In either form the +input string may also have leading and/or trailing whitespace. +Here are some examples:

    +
    >>> from fractions import Fraction
    +>>> Fraction(16, -10)
    +Fraction(-8, 5)
    +>>> Fraction(123)
    +Fraction(123, 1)
    +>>> Fraction()
    +Fraction(0, 1)
    +>>> Fraction('3/7')
    +Fraction(3, 7)
    +>>> Fraction(' -3/7 ')
    +Fraction(-3, 7)
    +>>> Fraction('1.414213 \t\n')
    +Fraction(1414213, 1000000)
    +>>> Fraction('-.125')
    +Fraction(-1, 8)
    +>>> Fraction('7e-6')
    +Fraction(7, 1000000)
    +>>> Fraction(2.25)
    +Fraction(9, 4)
    +>>> Fraction(1.1)
    +Fraction(2476979795053773, 2251799813685248)
    +>>> from decimal import Decimal
    +>>> Fraction(Decimal('1.1'))
    +Fraction(11, 10)
    +
    +
    +

    The Fraction class inherits from the abstract base class +numbers.Rational, and implements all of the methods and +operations from that class. Fraction instances are hashable, +and should be treated as immutable. In addition, +Fraction has the following properties and methods:

    +
    +

    Changed in version 3.2: The Fraction constructor now accepts float and +decimal.Decimal instances.

    +
    +
    +
    +numerator
    +

    Numerator of the Fraction in lowest term.

    +
    + +
    +
    +denominator
    +

    Denominator of the Fraction in lowest term.

    +
    + +
    +
    +from_float(flt)
    +

    This class method constructs a Fraction representing the exact +value of flt, which must be a float. Beware that +Fraction.from_float(0.3) is not the same value as Fraction(3, 10).

    +
    +

    Note

    +

    From Python 3.2 onwards, you can also construct a +Fraction instance directly from a float.

    +
    +
    + +
    +
    +from_decimal(dec)
    +

    This class method constructs a Fraction representing the exact +value of dec, which must be a decimal.Decimal instance.

    +
    +

    Note

    +

    From Python 3.2 onwards, you can also construct a +Fraction instance directly from a decimal.Decimal +instance.

    +
    +
    + +
    +
    +limit_denominator(max_denominator=1000000)
    +

    Finds and returns the closest Fraction to self that has +denominator at most max_denominator. This method is useful for finding +rational approximations to a given floating-point number:

    +
    >>> from fractions import Fraction
    +>>> Fraction('3.1415926535897932').limit_denominator(1000)
    +Fraction(355, 113)
    +
    +
    +

    or for recovering a rational number that’s represented as a float:

    +
    >>> from math import pi, cos
    +>>> Fraction(cos(pi/3))
    +Fraction(4503599627370497, 9007199254740992)
    +>>> Fraction(cos(pi/3)).limit_denominator()
    +Fraction(1, 2)
    +>>> Fraction(1.1).limit_denominator()
    +Fraction(11, 10)
    +
    +
    +
    + +
    +
    +__floor__()
    +

    Returns the greatest int <= self. This method can +also be accessed through the math.floor() function:

    +
    >>> from math import floor
    +>>> floor(Fraction(355, 113))
    +3
    +
    +
    +
    + +
    +
    +__ceil__()
    +

    Returns the least int >= self. This method can +also be accessed through the math.ceil() function.

    +
    + +
    +
    +__round__()
    +
    +__round__(ndigits)
    +

    The first version returns the nearest int to self, +rounding half to even. The second version rounds self to the +nearest multiple of Fraction(1, 10**ndigits) (logically, if +ndigits is negative), again rounding half toward even. This +method can also be accessed through the round() function.

    +
    + +
    + +
    +
    +fractions.gcd(a, b)
    +

    Return the greatest common divisor of the integers a and b. If either +a or b is nonzero, then the absolute value of gcd(a, b) is the +largest integer that divides both a and b. gcd(a,b) has the same +sign as b if b is nonzero; otherwise it takes the sign of a. gcd(0, +0) returns 0.

    +
    +

    Deprecated since version 3.5: Use math.gcd() instead.

    +
    +
    + +
    +

    See also

    +
    +
    Module numbers

    The abstract base classes making up the numeric tower.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/frameworks.html b/python-3.7.4-docs-html/library/frameworks.html new file mode 100644 index 0000000..1e40b16 --- /dev/null +++ b/python-3.7.4-docs-html/library/frameworks.html @@ -0,0 +1,249 @@ + + + + + + + Program Frameworks — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/ftplib.html b/python-3.7.4-docs-html/library/ftplib.html new file mode 100644 index 0000000..73cf417 --- /dev/null +++ b/python-3.7.4-docs-html/library/ftplib.html @@ -0,0 +1,662 @@ + + + + + + + ftplib — FTP protocol client — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    ftplib — FTP protocol client

    +

    Source code: Lib/ftplib.py

    +
    +

    This module defines the class FTP and a few related items. The +FTP class implements the client side of the FTP protocol. You can use +this to write Python programs that perform a variety of automated FTP jobs, such +as mirroring other FTP servers. It is also used by the module +urllib.request to handle URLs that use FTP. For more information on FTP +(File Transfer Protocol), see Internet RFC 959.

    +

    Here’s a sample session using the ftplib module:

    +
    >>> from ftplib import FTP
    +>>> ftp = FTP('ftp.debian.org')     # connect to host, default port
    +>>> ftp.login()                     # user anonymous, passwd anonymous@
    +'230 Login successful.'
    +>>> ftp.cwd('debian')               # change into "debian" directory
    +>>> ftp.retrlines('LIST')           # list directory contents
    +-rw-rw-r--    1 1176     1176         1063 Jun 15 10:18 README
    +...
    +drwxr-sr-x    5 1176     1176         4096 Dec 19  2000 pool
    +drwxr-sr-x    4 1176     1176         4096 Nov 17  2008 project
    +drwxr-xr-x    3 1176     1176         4096 Oct 10  2012 tools
    +'226 Directory send OK.'
    +>>> ftp.retrbinary('RETR README', open('README', 'wb').write)
    +'226 Transfer complete.'
    +>>> ftp.quit()
    +
    +
    +

    The module defines the following items:

    +
    +
    +class ftplib.FTP(host='', user='', passwd='', acct='', timeout=None, source_address=None)
    +

    Return a new instance of the FTP class. When host is given, the +method call connect(host) is made. When user is given, additionally +the method call login(user, passwd, acct) is made (where passwd and +acct default to the empty string when not given). The optional timeout +parameter specifies a timeout in seconds for blocking operations like the +connection attempt (if is not specified, the global default timeout setting +will be used). source_address is a 2-tuple (host, port) for the socket +to bind to as its source address before connecting.

    +

    The FTP class supports the with statement, e.g.:

    +
    >>> from ftplib import FTP
    +>>> with FTP("ftp1.at.proftpd.org") as ftp:
    +...     ftp.login()
    +...     ftp.dir()
    +... # doctest: +SKIP
    +'230 Anonymous login ok, restrictions apply.'
    +dr-xr-xr-x   9 ftp      ftp           154 May  6 10:43 .
    +dr-xr-xr-x   9 ftp      ftp           154 May  6 10:43 ..
    +dr-xr-xr-x   5 ftp      ftp          4096 May  6 10:43 CentOS
    +dr-xr-xr-x   3 ftp      ftp            18 Jul 10  2008 Fedora
    +>>>
    +
    +
    +
    +

    Changed in version 3.2: Support for the with statement was added.

    +
    +
    +

    Changed in version 3.3: source_address parameter was added.

    +
    +
    + +
    +
    +class ftplib.FTP_TLS(host='', user='', passwd='', acct='', keyfile=None, certfile=None, context=None, timeout=None, source_address=None)
    +

    A FTP subclass which adds TLS support to FTP as described in +RFC 4217. +Connect as usual to port 21 implicitly securing the FTP control connection +before authenticating. Securing the data connection requires the user to +explicitly ask for it by calling the prot_p() method. context +is a ssl.SSLContext object which allows bundling SSL configuration +options, certificates and private keys into a single (potentially +long-lived) structure. Please read Security considerations for best practices.

    +

    keyfile and certfile are a legacy alternative to context – they +can point to PEM-formatted private key and certificate chain files +(respectively) for the SSL connection.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.3: source_address parameter was added.

    +
    +
    +

    Changed in version 3.4: The class now supports hostname check with +ssl.SSLContext.check_hostname and Server Name Indication (see +ssl.HAS_SNI).

    +
    +
    +

    Deprecated since version 3.6: keyfile and certfile are deprecated in favor of context. +Please use ssl.SSLContext.load_cert_chain() instead, or let +ssl.create_default_context() select the system’s trusted CA +certificates for you.

    +
    +

    Here’s a sample session using the FTP_TLS class:

    +
    >>> ftps = FTP_TLS('ftp.pureftpd.org')
    +>>> ftps.login()
    +'230 Anonymous user logged in'
    +>>> ftps.prot_p()
    +'200 Data protection level set to "private"'
    +>>> ftps.nlst()
    +['6jack', 'OpenBSD', 'antilink', 'blogbench', 'bsdcam', 'clockspeed', 'djbdns-jedi', 'docs', 'eaccelerator-jedi', 'favicon.ico', 'francotone', 'fugu', 'ignore', 'libpuzzle', 'metalog', 'minidentd', 'misc', 'mysql-udf-global-user-variables', 'php-jenkins-hash', 'php-skein-hash', 'php-webdav', 'phpaudit', 'phpbench', 'pincaster', 'ping', 'posto', 'pub', 'public', 'public_keys', 'pure-ftpd', 'qscan', 'qtc', 'sharedance', 'skycache', 'sound', 'tmp', 'ucarp']
    +
    +
    +
    + +
    +
    +exception ftplib.error_reply
    +

    Exception raised when an unexpected reply is received from the server.

    +
    + +
    +
    +exception ftplib.error_temp
    +

    Exception raised when an error code signifying a temporary error (response +codes in the range 400–499) is received.

    +
    + +
    +
    +exception ftplib.error_perm
    +

    Exception raised when an error code signifying a permanent error (response +codes in the range 500–599) is received.

    +
    + +
    +
    +exception ftplib.error_proto
    +

    Exception raised when a reply is received from the server that does not fit +the response specifications of the File Transfer Protocol, i.e. begin with a +digit in the range 1–5.

    +
    + +
    +
    +ftplib.all_errors
    +

    The set of all exceptions (as a tuple) that methods of FTP +instances may raise as a result of problems with the FTP connection (as +opposed to programming errors made by the caller). This set includes the +four exceptions listed above as well as OSError.

    +
    + +
    +

    See also

    +
    +
    Module netrc

    Parser for the .netrc file format. The file .netrc is +typically used by FTP clients to load user authentication information +before prompting the user.

    +
    +
    +
    +
    +

    FTP Objects

    +

    Several methods are available in two flavors: one for handling text files and +another for binary files. These are named for the command which is used +followed by lines for the text version or binary for the binary version.

    +

    FTP instances have the following methods:

    +
    +
    +FTP.set_debuglevel(level)
    +

    Set the instance’s debugging level. This controls the amount of debugging +output printed. The default, 0, produces no debugging output. A value of +1 produces a moderate amount of debugging output, generally a single line +per request. A value of 2 or higher produces the maximum amount of +debugging output, logging each line sent and received on the control connection.

    +
    + +
    +
    +FTP.connect(host='', port=0, timeout=None, source_address=None)
    +

    Connect to the given host and port. The default port number is 21, as +specified by the FTP protocol specification. It is rarely needed to specify a +different port number. This function should be called only once for each +instance; it should not be called at all if a host was given when the instance +was created. All other methods can only be used after a connection has been +made. +The optional timeout parameter specifies a timeout in seconds for the +connection attempt. If no timeout is passed, the global default timeout +setting will be used. +source_address is a 2-tuple (host, port) for the socket to bind to as +its source address before connecting.

    +
    +

    Changed in version 3.3: source_address parameter was added.

    +
    +
    + +
    +
    +FTP.getwelcome()
    +

    Return the welcome message sent by the server in reply to the initial +connection. (This message sometimes contains disclaimers or help information +that may be relevant to the user.)

    +
    + +
    +
    +FTP.login(user='anonymous', passwd='', acct='')
    +

    Log in as the given user. The passwd and acct parameters are optional and +default to the empty string. If no user is specified, it defaults to +'anonymous'. If user is 'anonymous', the default passwd is +'anonymous@'. This function should be called only once for each instance, +after a connection has been established; it should not be called at all if a +host and user were given when the instance was created. Most FTP commands are +only allowed after the client has logged in. The acct parameter supplies +“accounting information”; few systems implement this.

    +
    + +
    +
    +FTP.abort()
    +

    Abort a file transfer that is in progress. Using this does not always work, but +it’s worth a try.

    +
    + +
    +
    +FTP.sendcmd(cmd)
    +

    Send a simple command string to the server and return the response string.

    +
    + +
    +
    +FTP.voidcmd(cmd)
    +

    Send a simple command string to the server and handle the response. Return +nothing if a response code corresponding to success (codes in the range +200–299) is received. Raise error_reply otherwise.

    +
    + +
    +
    +FTP.retrbinary(cmd, callback, blocksize=8192, rest=None)
    +

    Retrieve a file in binary transfer mode. cmd should be an appropriate +RETR command: 'RETR filename'. The callback function is called for +each block of data received, with a single bytes argument giving the data +block. The optional blocksize argument specifies the maximum chunk size to +read on the low-level socket object created to do the actual transfer (which +will also be the largest size of the data blocks passed to callback). A +reasonable default is chosen. rest means the same thing as in the +transfercmd() method.

    +
    + +
    +
    +FTP.retrlines(cmd, callback=None)
    +

    Retrieve a file or directory listing in ASCII transfer mode. cmd should be +an appropriate RETR command (see retrbinary()) or a command such as +LIST or NLST (usually just the string 'LIST'). +LIST retrieves a list of files and information about those files. +NLST retrieves a list of file names. +The callback function is called for each line with a string argument +containing the line with the trailing CRLF stripped. The default callback +prints the line to sys.stdout.

    +
    + +
    +
    +FTP.set_pasv(val)
    +

    Enable “passive” mode if val is true, otherwise disable passive mode. +Passive mode is on by default.

    +
    + +
    +
    +FTP.storbinary(cmd, fp, blocksize=8192, callback=None, rest=None)
    +

    Store a file in binary transfer mode. cmd should be an appropriate +STOR command: "STOR filename". fp is a file object +(opened in binary mode) which is read until EOF using its read() +method in blocks of size blocksize to provide the data to be stored. +The blocksize argument defaults to 8192. callback is an optional single +parameter callable that is called on each block of data after it is sent. +rest means the same thing as in the transfercmd() method.

    +
    +

    Changed in version 3.2: rest parameter added.

    +
    +
    + +
    +
    +FTP.storlines(cmd, fp, callback=None)
    +

    Store a file in ASCII transfer mode. cmd should be an appropriate +STOR command (see storbinary()). Lines are read until EOF from the +file object fp (opened in binary mode) using its readline() +method to provide the data to be stored. callback is an optional single +parameter callable that is called on each line after it is sent.

    +
    + +
    +
    +FTP.transfercmd(cmd, rest=None)
    +

    Initiate a transfer over the data connection. If the transfer is active, send an +EPRT or PORT command and the transfer command specified by cmd, and +accept the connection. If the server is passive, send an EPSV or PASV +command, connect to it, and start the transfer command. Either way, return the +socket for the connection.

    +

    If optional rest is given, a REST command is sent to the server, passing +rest as an argument. rest is usually a byte offset into the requested file, +telling the server to restart sending the file’s bytes at the requested offset, +skipping over the initial bytes. Note however that RFC 959 requires only that +rest be a string containing characters in the printable range from ASCII code +33 to ASCII code 126. The transfercmd() method, therefore, converts +rest to a string, but no check is performed on the string’s contents. If the +server does not recognize the REST command, an error_reply exception +will be raised. If this happens, simply call transfercmd() without a +rest argument.

    +
    + +
    +
    +FTP.ntransfercmd(cmd, rest=None)
    +

    Like transfercmd(), but returns a tuple of the data connection and the +expected size of the data. If the expected size could not be computed, None +will be returned as the expected size. cmd and rest means the same thing as +in transfercmd().

    +
    + +
    +
    +FTP.mlsd(path="", facts=[])
    +

    List a directory in a standardized format by using MLSD command +(RFC 3659). If path is omitted the current directory is assumed. +facts is a list of strings representing the type of information desired +(e.g. ["type", "size", "perm"]). Return a generator object yielding a +tuple of two elements for every file found in path. First element is the +file name, the second one is a dictionary containing facts about the file +name. Content of this dictionary might be limited by the facts argument +but server is not guaranteed to return all requested facts.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +FTP.nlst(argument[, ...])
    +

    Return a list of file names as returned by the NLST command. The +optional argument is a directory to list (default is the current server +directory). Multiple arguments can be used to pass non-standard options to +the NLST command.

    +
    +

    Note

    +

    If your server supports the command, mlsd() offers a better API.

    +
    +
    + +
    +
    +FTP.dir(argument[, ...])
    +

    Produce a directory listing as returned by the LIST command, printing it to +standard output. The optional argument is a directory to list (default is the +current server directory). Multiple arguments can be used to pass non-standard +options to the LIST command. If the last argument is a function, it is used +as a callback function as for retrlines(); the default prints to +sys.stdout. This method returns None.

    +
    +

    Note

    +

    If your server supports the command, mlsd() offers a better API.

    +
    +
    + +
    +
    +FTP.rename(fromname, toname)
    +

    Rename file fromname on the server to toname.

    +
    + +
    +
    +FTP.delete(filename)
    +

    Remove the file named filename from the server. If successful, returns the +text of the response, otherwise raises error_perm on permission errors or +error_reply on other errors.

    +
    + +
    +
    +FTP.cwd(pathname)
    +

    Set the current directory on the server.

    +
    + +
    +
    +FTP.mkd(pathname)
    +

    Create a new directory on the server.

    +
    + +
    +
    +FTP.pwd()
    +

    Return the pathname of the current directory on the server.

    +
    + +
    +
    +FTP.rmd(dirname)
    +

    Remove the directory named dirname on the server.

    +
    + +
    +
    +FTP.size(filename)
    +

    Request the size of the file named filename on the server. On success, the +size of the file is returned as an integer, otherwise None is returned. +Note that the SIZE command is not standardized, but is supported by many +common server implementations.

    +
    + +
    +
    +FTP.quit()
    +

    Send a QUIT command to the server and close the connection. This is the +“polite” way to close a connection, but it may raise an exception if the server +responds with an error to the QUIT command. This implies a call to the +close() method which renders the FTP instance useless for +subsequent calls (see below).

    +
    + +
    +
    +FTP.close()
    +

    Close the connection unilaterally. This should not be applied to an already +closed connection such as after a successful call to quit(). +After this call the FTP instance should not be used any more (after +a call to close() or quit() you cannot reopen the +connection by issuing another login() method).

    +
    + +
    +
    +

    FTP_TLS Objects

    +

    FTP_TLS class inherits from FTP, defining these additional objects:

    +
    +
    +FTP_TLS.ssl_version
    +

    The SSL version to use (defaults to ssl.PROTOCOL_SSLv23).

    +
    + +
    +
    +FTP_TLS.auth()
    +

    Set up a secure control connection by using TLS or SSL, depending on what +is specified in the ssl_version attribute.

    +
    +

    Changed in version 3.4: The method now supports hostname check with +ssl.SSLContext.check_hostname and Server Name Indication (see +ssl.HAS_SNI).

    +
    +
    + +
    +
    +FTP_TLS.ccc()
    +

    Revert control channel back to plaintext. This can be useful to take +advantage of firewalls that know how to handle NAT with non-secure FTP +without opening fixed ports.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +FTP_TLS.prot_p()
    +

    Set up secure data connection.

    +
    + +
    +
    +FTP_TLS.prot_c()
    +

    Set up clear text data connection.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/functional.html b/python-3.7.4-docs-html/library/functional.html new file mode 100644 index 0000000..9ed767e --- /dev/null +++ b/python-3.7.4-docs-html/library/functional.html @@ -0,0 +1,202 @@ + + + + + + + Functional Programming Modules — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Functional Programming Modules

    +

    The modules described in this chapter provide functions and classes that support +a functional programming style, and general operations on callables.

    +

    The following modules are documented in this chapter:

    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/functions.html b/python-3.7.4-docs-html/library/functions.html new file mode 100644 index 0000000..9f2386e --- /dev/null +++ b/python-3.7.4-docs-html/library/functions.html @@ -0,0 +1,1915 @@ + + + + + + + Built-in Functions — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Built-in Functions

    +

    The Python interpreter has a number of functions and types built into it that +are always available. They are listed here in alphabetical order.

    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Built-in Functions

    abs()

    delattr()

    hash()

    memoryview()

    set()

    all()

    dict()

    help()

    min()

    setattr()

    any()

    dir()

    hex()

    next()

    slice()

    ascii()

    divmod()

    id()

    object()

    sorted()

    bin()

    enumerate()

    input()

    oct()

    staticmethod()

    bool()

    eval()

    int()

    open()

    str()

    breakpoint()

    exec()

    isinstance()

    ord()

    sum()

    bytearray()

    filter()

    issubclass()

    pow()

    super()

    bytes()

    float()

    iter()

    print()

    tuple()

    callable()

    format()

    len()

    property()

    type()

    chr()

    frozenset()

    list()

    range()

    vars()

    classmethod()

    getattr()

    locals()

    repr()

    zip()

    compile()

    globals()

    map()

    reversed()

    __import__()

    complex()

    hasattr()

    max()

    round()

    +
    +
    +abs(x)
    +

    Return the absolute value of a number. The argument may be an +integer or a floating point number. If the argument is a complex number, its +magnitude is returned.

    +
    + +
    +
    +all(iterable)
    +

    Return True if all elements of the iterable are true (or if the iterable +is empty). Equivalent to:

    +
    def all(iterable):
    +    for element in iterable:
    +        if not element:
    +            return False
    +    return True
    +
    +
    +
    + +
    +
    +any(iterable)
    +

    Return True if any element of the iterable is true. If the iterable +is empty, return False. Equivalent to:

    +
    def any(iterable):
    +    for element in iterable:
    +        if element:
    +            return True
    +    return False
    +
    +
    +
    + +
    +
    +ascii(object)
    +

    As repr(), return a string containing a printable representation of an +object, but escape the non-ASCII characters in the string returned by +repr() using \x, \u or \U escapes. This generates a string +similar to that returned by repr() in Python 2.

    +
    + +
    +
    +bin(x)
    +

    Convert an integer number to a binary string prefixed with “0b”. The result +is a valid Python expression. If x is not a Python int object, it +has to define an __index__() method that returns an integer. Some +examples:

    +
    >>> bin(3)
    +'0b11'
    +>>> bin(-10)
    +'-0b1010'
    +
    +
    +

    If prefix “0b” is desired or not, you can use either of the following ways.

    +
    >>> format(14, '#b'), format(14, 'b')
    +('0b1110', '1110')
    +>>> f'{14:#b}', f'{14:b}'
    +('0b1110', '1110')
    +
    +
    +

    See also format() for more information.

    +
    + +
    +
    +class bool([x])
    +

    Return a Boolean value, i.e. one of True or False. x is converted +using the standard truth testing procedure. If x is false +or omitted, this returns False; otherwise it returns True. The +bool class is a subclass of int (see Numeric Types — int, float, complex). +It cannot be subclassed further. Its only instances are False and +True (see Boolean Values).

    +
    +

    Changed in version 3.7: x is now a positional-only parameter.

    +
    +
    + +
    +
    +breakpoint(*args, **kws)
    +

    This function drops you into the debugger at the call site. Specifically, +it calls sys.breakpointhook(), passing args and kws straight +through. By default, sys.breakpointhook() calls +pdb.set_trace() expecting no arguments. In this case, it is +purely a convenience function so you don’t have to explicitly import +pdb or type as much code to enter the debugger. However, +sys.breakpointhook() can be set to some other function and +breakpoint() will automatically call that, allowing you to drop into +the debugger of choice.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +class bytearray([source[, encoding[, errors]]])
    +

    Return a new array of bytes. The bytearray class is a mutable +sequence of integers in the range 0 <= x < 256. It has most of the usual +methods of mutable sequences, described in Mutable Sequence Types, as well +as most methods that the bytes type has, see Bytes and Bytearray Operations.

    +

    The optional source parameter can be used to initialize the array in a few +different ways:

    +
      +
    • If it is a string, you must also give the encoding (and optionally, +errors) parameters; bytearray() then converts the string to +bytes using str.encode().

    • +
    • If it is an integer, the array will have that size and will be +initialized with null bytes.

    • +
    • If it is an object conforming to the buffer interface, a read-only buffer +of the object will be used to initialize the bytes array.

    • +
    • If it is an iterable, it must be an iterable of integers in the range +0 <= x < 256, which are used as the initial contents of the array.

    • +
    +

    Without an argument, an array of size 0 is created.

    +

    See also Binary Sequence Types — bytes, bytearray, memoryview and Bytearray Objects.

    +
    + +
    +
    +class bytes([source[, encoding[, errors]]])
    +

    Return a new “bytes” object, which is an immutable sequence of integers in +the range 0 <= x < 256. bytes is an immutable version of +bytearray – it has the same non-mutating methods and the same +indexing and slicing behavior.

    +

    Accordingly, constructor arguments are interpreted as for bytearray().

    +

    Bytes objects can also be created with literals, see String and Bytes literals.

    +

    See also Binary Sequence Types — bytes, bytearray, memoryview, Bytes Objects, and Bytes and Bytearray Operations.

    +
    + +
    +
    +callable(object)
    +

    Return True if the object argument appears callable, +False if not. If this returns true, it is still possible that a +call fails, but if it is false, calling object will never succeed. +Note that classes are callable (calling a class returns a new instance); +instances are callable if their class has a __call__() method.

    +
    +

    New in version 3.2: This function was first removed in Python 3.0 and then brought back +in Python 3.2.

    +
    +
    + +
    +
    +chr(i)
    +

    Return the string representing a character whose Unicode code point is the +integer i. For example, chr(97) returns the string 'a', while +chr(8364) returns the string '€'. This is the inverse of ord().

    +

    The valid range for the argument is from 0 through 1,114,111 (0x10FFFF in +base 16). ValueError will be raised if i is outside that range.

    +
    + +
    +
    +@classmethod
    +

    Transform a method into a class method.

    +

    A class method receives the class as implicit first argument, just like an +instance method receives the instance. To declare a class method, use this +idiom:

    +
    class C:
    +    @classmethod
    +    def f(cls, arg1, arg2, ...): ...
    +
    +
    +

    The @classmethod form is a function decorator – see +Function definitions for details.

    +

    A class method can be called either on the class (such as C.f()) or on an instance (such +as C().f()). The instance is ignored except for its class. If a class +method is called for a derived class, the derived class object is passed as the +implied first argument.

    +

    Class methods are different than C++ or Java static methods. If you want those, +see staticmethod().

    +

    For more information on class methods, see The standard type hierarchy.

    +
    + +
    +
    +compile(source, filename, mode, flags=0, dont_inherit=False, optimize=-1)
    +

    Compile the source into a code or AST object. Code objects can be executed +by exec() or eval(). source can either be a normal string, a +byte string, or an AST object. Refer to the ast module documentation +for information on how to work with AST objects.

    +

    The filename argument should give the file from which the code was read; +pass some recognizable value if it wasn’t read from a file ('<string>' is +commonly used).

    +

    The mode argument specifies what kind of code must be compiled; it can be +'exec' if source consists of a sequence of statements, 'eval' if it +consists of a single expression, or 'single' if it consists of a single +interactive statement (in the latter case, expression statements that +evaluate to something other than None will be printed).

    +

    The optional arguments flags and dont_inherit control which future +statements affect the compilation of source. If neither +is present (or both are zero) the code is compiled with those future +statements that are in effect in the code that is calling compile(). If the +flags argument is given and dont_inherit is not (or is zero) then the +future statements specified by the flags argument are used in addition to +those that would be used anyway. If dont_inherit is a non-zero integer then +the flags argument is it – the future statements in effect around the call +to compile are ignored.

    +

    Future statements are specified by bits which can be bitwise ORed together to +specify multiple statements. The bitfield required to specify a given feature +can be found as the compiler_flag attribute on +the _Feature instance in the __future__ module.

    +

    The argument optimize specifies the optimization level of the compiler; the +default value of -1 selects the optimization level of the interpreter as +given by -O options. Explicit levels are 0 (no optimization; +__debug__ is true), 1 (asserts are removed, __debug__ is false) +or 2 (docstrings are removed too).

    +

    This function raises SyntaxError if the compiled source is invalid, +and ValueError if the source contains null bytes.

    +

    If you want to parse Python code into its AST representation, see +ast.parse().

    +
    +

    Note

    +

    When compiling a string with multi-line code in 'single' or +'eval' mode, input must be terminated by at least one newline +character. This is to facilitate detection of incomplete and complete +statements in the code module.

    +
    +
    +

    Warning

    +

    It is possible to crash the Python interpreter with a +sufficiently large/complex string when compiling to an AST +object due to stack depth limitations in Python’s AST compiler.

    +
    +
    +

    Changed in version 3.2: Allowed use of Windows and Mac newlines. Also input in 'exec' mode +does not have to end in a newline anymore. Added the optimize parameter.

    +
    +
    +

    Changed in version 3.5: Previously, TypeError was raised when null bytes were encountered +in source.

    +
    +
    + +
    +
    +class complex([real[, imag]])
    +

    Return a complex number with the value real + imag*1j or convert a string +or number to a complex number. If the first parameter is a string, it will +be interpreted as a complex number and the function must be called without a +second parameter. The second parameter can never be a string. Each argument +may be any numeric type (including complex). If imag is omitted, it +defaults to zero and the constructor serves as a numeric conversion like +int and float. If both arguments are omitted, returns +0j.

    +
    +

    Note

    +

    When converting from a string, the string must not contain whitespace +around the central + or - operator. For example, +complex('1+2j') is fine, but complex('1 + 2j') raises +ValueError.

    +
    +

    The complex type is described in Numeric Types — int, float, complex.

    +
    +

    Changed in version 3.6: Grouping digits with underscores as in code literals is allowed.

    +
    +
    + +
    +
    +delattr(object, name)
    +

    This is a relative of setattr(). The arguments are an object and a +string. The string must be the name of one of the object’s attributes. The +function deletes the named attribute, provided the object allows it. For +example, delattr(x, 'foobar') is equivalent to del x.foobar.

    +
    + +
    +
    +class dict(**kwarg)
    +
    +class dict(mapping, **kwarg)
    +
    +class dict(iterable, **kwarg)
    +

    Create a new dictionary. The dict object is the dictionary class. +See dict and Mapping Types — dict for documentation about this class.

    +

    For other containers see the built-in list, set, and +tuple classes, as well as the collections module.

    +
    + +
    +
    +dir([object])
    +

    Without arguments, return the list of names in the current local scope. With an +argument, attempt to return a list of valid attributes for that object.

    +

    If the object has a method named __dir__(), this method will be called and +must return the list of attributes. This allows objects that implement a custom +__getattr__() or __getattribute__() function to customize the way +dir() reports their attributes.

    +

    If the object does not provide __dir__(), the function tries its best to +gather information from the object’s __dict__ attribute, if defined, and +from its type object. The resulting list is not necessarily complete, and may +be inaccurate when the object has a custom __getattr__().

    +

    The default dir() mechanism behaves differently with different types of +objects, as it attempts to produce the most relevant, rather than complete, +information:

    +
      +
    • If the object is a module object, the list contains the names of the module’s +attributes.

    • +
    • If the object is a type or class object, the list contains the names of its +attributes, and recursively of the attributes of its bases.

    • +
    • Otherwise, the list contains the object’s attributes’ names, the names of its +class’s attributes, and recursively of the attributes of its class’s base +classes.

    • +
    +

    The resulting list is sorted alphabetically. For example:

    +
    >>> import struct
    +>>> dir()   # show the names in the module namespace  # doctest: +SKIP
    +['__builtins__', '__name__', 'struct']
    +>>> dir(struct)   # show the names in the struct module # doctest: +SKIP
    +['Struct', '__all__', '__builtins__', '__cached__', '__doc__', '__file__',
    + '__initializing__', '__loader__', '__name__', '__package__',
    + '_clearcache', 'calcsize', 'error', 'pack', 'pack_into',
    + 'unpack', 'unpack_from']
    +>>> class Shape:
    +...     def __dir__(self):
    +...         return ['area', 'perimeter', 'location']
    +>>> s = Shape()
    +>>> dir(s)
    +['area', 'location', 'perimeter']
    +
    +
    +
    +

    Note

    +

    Because dir() is supplied primarily as a convenience for use at an +interactive prompt, it tries to supply an interesting set of names more +than it tries to supply a rigorously or consistently defined set of names, +and its detailed behavior may change across releases. For example, +metaclass attributes are not in the result list when the argument is a +class.

    +
    +
    + +
    +
    +divmod(a, b)
    +

    Take two (non complex) numbers as arguments and return a pair of numbers +consisting of their quotient and remainder when using integer division. With +mixed operand types, the rules for binary arithmetic operators apply. For +integers, the result is the same as (a // b, a % b). For floating point +numbers the result is (q, a % b), where q is usually math.floor(a / +b) but may be 1 less than that. In any case q * b + a % b is very +close to a, if a % b is non-zero it has the same sign as b, and 0 +<= abs(a % b) < abs(b).

    +
    + +
    +
    +enumerate(iterable, start=0)
    +

    Return an enumerate object. iterable must be a sequence, an +iterator, or some other object which supports iteration. +The __next__() method of the iterator returned by +enumerate() returns a tuple containing a count (from start which +defaults to 0) and the values obtained from iterating over iterable.

    +
    >>> seasons = ['Spring', 'Summer', 'Fall', 'Winter']
    +>>> list(enumerate(seasons))
    +[(0, 'Spring'), (1, 'Summer'), (2, 'Fall'), (3, 'Winter')]
    +>>> list(enumerate(seasons, start=1))
    +[(1, 'Spring'), (2, 'Summer'), (3, 'Fall'), (4, 'Winter')]
    +
    +
    +

    Equivalent to:

    +
    def enumerate(sequence, start=0):
    +    n = start
    +    for elem in sequence:
    +        yield n, elem
    +        n += 1
    +
    +
    +
    + +
    +
    +eval(expression, globals=None, locals=None)
    +

    The arguments are a string and optional globals and locals. If provided, +globals must be a dictionary. If provided, locals can be any mapping +object.

    +

    The expression argument is parsed and evaluated as a Python expression +(technically speaking, a condition list) using the globals and locals +dictionaries as global and local namespace. If the globals dictionary is +present and does not contain a value for the key __builtins__, a +reference to the dictionary of the built-in module builtins is +inserted under that key before expression is parsed. +This means that expression normally has full +access to the standard builtins module and restricted environments are +propagated. If the locals dictionary is omitted it defaults to the globals +dictionary. If both dictionaries are omitted, the expression is executed in the +environment where eval() is called. The return value is the result of +the evaluated expression. Syntax errors are reported as exceptions. Example:

    +
    >>> x = 1
    +>>> eval('x+1')
    +2
    +
    +
    +

    This function can also be used to execute arbitrary code objects (such as +those created by compile()). In this case pass a code object instead +of a string. If the code object has been compiled with 'exec' as the +mode argument, eval()’s return value will be None.

    +

    Hints: dynamic execution of statements is supported by the exec() +function. The globals() and locals() functions +returns the current global and local dictionary, respectively, which may be +useful to pass around for use by eval() or exec().

    +

    See ast.literal_eval() for a function that can safely evaluate strings +with expressions containing only literals.

    +
    + +
    +
    +exec(object[, globals[, locals]])
    +

    This function supports dynamic execution of Python code. object must be +either a string or a code object. If it is a string, the string is parsed as +a suite of Python statements which is then executed (unless a syntax error +occurs). 1 If it is a code object, it is simply executed. In all cases, +the code that’s executed is expected to be valid as file input (see the +section “File input” in the Reference Manual). Be aware that the +return and yield statements may not be used outside of +function definitions even within the context of code passed to the +exec() function. The return value is None.

    +

    In all cases, if the optional parts are omitted, the code is executed in the +current scope. If only globals is provided, it must be a dictionary, which +will be used for both the global and the local variables. If globals and +locals are given, they are used for the global and local variables, +respectively. If provided, locals can be any mapping object. Remember +that at module level, globals and locals are the same dictionary. If exec +gets two separate objects as globals and locals, the code will be +executed as if it were embedded in a class definition.

    +

    If the globals dictionary does not contain a value for the key +__builtins__, a reference to the dictionary of the built-in module +builtins is inserted under that key. That way you can control what +builtins are available to the executed code by inserting your own +__builtins__ dictionary into globals before passing it to exec().

    +
    +

    Note

    +

    The built-in functions globals() and locals() return the current +global and local dictionary, respectively, which may be useful to pass around +for use as the second and third argument to exec().

    +
    +
    +

    Note

    +

    The default locals act as described for function locals() below: +modifications to the default locals dictionary should not be attempted. +Pass an explicit locals dictionary if you need to see effects of the +code on locals after function exec() returns.

    +
    +
    + +
    +
    +filter(function, iterable)
    +

    Construct an iterator from those elements of iterable for which function +returns true. iterable may be either a sequence, a container which +supports iteration, or an iterator. If function is None, the identity +function is assumed, that is, all elements of iterable that are false are +removed.

    +

    Note that filter(function, iterable) is equivalent to the generator +expression (item for item in iterable if function(item)) if function is +not None and (item for item in iterable if item) if function is +None.

    +

    See itertools.filterfalse() for the complementary function that returns +elements of iterable for which function returns false.

    +
    + +
    +
    +class float([x])
    +

    Return a floating point number constructed from a number or string x.

    +

    If the argument is a string, it should contain a decimal number, optionally +preceded by a sign, and optionally embedded in whitespace. The optional +sign may be '+' or '-'; a '+' sign has no effect on the value +produced. The argument may also be a string representing a NaN +(not-a-number), or a positive or negative infinity. More precisely, the +input must conform to the following grammar after leading and trailing +whitespace characters are removed:

    +
    +sign           ::=  "+" | "-"
    +infinity       ::=  "Infinity" | "inf"
    +nan            ::=  "nan"
    +numeric_value  ::=  floatnumber | infinity | nan
    +numeric_string ::=  [sign] numeric_value
    +
    +

    Here floatnumber is the form of a Python floating-point literal, +described in Floating point literals. Case is not significant, so, for example, +“inf”, “Inf”, “INFINITY” and “iNfINity” are all acceptable spellings for +positive infinity.

    +

    Otherwise, if the argument is an integer or a floating point number, a +floating point number with the same value (within Python’s floating point +precision) is returned. If the argument is outside the range of a Python +float, an OverflowError will be raised.

    +

    For a general Python object x, float(x) delegates to +x.__float__().

    +

    If no argument is given, 0.0 is returned.

    +

    Examples:

    +
    >>> float('+1.23')
    +1.23
    +>>> float('   -12345\n')
    +-12345.0
    +>>> float('1e-003')
    +0.001
    +>>> float('+1E6')
    +1000000.0
    +>>> float('-Infinity')
    +-inf
    +
    +
    +

    The float type is described in Numeric Types — int, float, complex.

    +
    +

    Changed in version 3.6: Grouping digits with underscores as in code literals is allowed.

    +
    +
    +

    Changed in version 3.7: x is now a positional-only parameter.

    +
    +
    + +
    +
    +format(value[, format_spec])
    +

    Convert a value to a “formatted” representation, as controlled by +format_spec. The interpretation of format_spec will depend on the type +of the value argument, however there is a standard formatting syntax that +is used by most built-in types: Format Specification Mini-Language.

    +

    The default format_spec is an empty string which usually gives the same +effect as calling str(value).

    +

    A call to format(value, format_spec) is translated to +type(value).__format__(value, format_spec) which bypasses the instance +dictionary when searching for the value’s __format__() method. A +TypeError exception is raised if the method search reaches +object and the format_spec is non-empty, or if either the +format_spec or the return value are not strings.

    +
    +

    Changed in version 3.4: object().__format__(format_spec) raises TypeError +if format_spec is not an empty string.

    +
    +
    + +
    +
    +class frozenset([iterable])
    +

    Return a new frozenset object, optionally with elements taken from +iterable. frozenset is a built-in class. See frozenset and +Set Types — set, frozenset for documentation about this class.

    +

    For other containers see the built-in set, list, +tuple, and dict classes, as well as the collections +module.

    +
    + +
    +
    +getattr(object, name[, default])
    +

    Return the value of the named attribute of object. name must be a string. +If the string is the name of one of the object’s attributes, the result is the +value of that attribute. For example, getattr(x, 'foobar') is equivalent to +x.foobar. If the named attribute does not exist, default is returned if +provided, otherwise AttributeError is raised.

    +
    + +
    +
    +globals()
    +

    Return a dictionary representing the current global symbol table. This is always +the dictionary of the current module (inside a function or method, this is the +module where it is defined, not the module from which it is called).

    +
    + +
    +
    +hasattr(object, name)
    +

    The arguments are an object and a string. The result is True if the +string is the name of one of the object’s attributes, False if not. (This +is implemented by calling getattr(object, name) and seeing whether it +raises an AttributeError or not.)

    +
    + +
    +
    +hash(object)
    +

    Return the hash value of the object (if it has one). Hash values are +integers. They are used to quickly compare dictionary keys during a +dictionary lookup. Numeric values that compare equal have the same hash +value (even if they are of different types, as is the case for 1 and 1.0).

    +
    +

    Note

    +

    For objects with custom __hash__() methods, note that hash() +truncates the return value based on the bit width of the host machine. +See __hash__() for details.

    +
    +
    + +
    +
    +help([object])
    +

    Invoke the built-in help system. (This function is intended for interactive +use.) If no argument is given, the interactive help system starts on the +interpreter console. If the argument is a string, then the string is looked up +as the name of a module, function, class, method, keyword, or documentation +topic, and a help page is printed on the console. If the argument is any other +kind of object, a help page on the object is generated.

    +

    Note that if a slash(/) appears in the parameter list of a function, when +invoking help(), it means that the parameters prior to the slash are +positional-only. For more info, see +the FAQ entry on positional-only parameters.

    +

    This function is added to the built-in namespace by the site module.

    +
    +

    Changed in version 3.4: Changes to pydoc and inspect mean that the reported +signatures for callables are now more comprehensive and consistent.

    +
    +
    + +
    +
    +hex(x)
    +

    Convert an integer number to a lowercase hexadecimal string prefixed with +“0x”. If x is not a Python int object, it has to define an +__index__() method that returns an integer. Some examples:

    +
    >>> hex(255)
    +'0xff'
    +>>> hex(-42)
    +'-0x2a'
    +
    +
    +

    If you want to convert an integer number to an uppercase or lower hexadecimal +string with prefix or not, you can use either of the following ways:

    +
    >>> '%#x' % 255, '%x' % 255, '%X' % 255
    +('0xff', 'ff', 'FF')
    +>>> format(255, '#x'), format(255, 'x'), format(255, 'X')
    +('0xff', 'ff', 'FF')
    +>>> f'{255:#x}', f'{255:x}', f'{255:X}'
    +('0xff', 'ff', 'FF')
    +
    +
    +

    See also format() for more information.

    +

    See also int() for converting a hexadecimal string to an +integer using a base of 16.

    +
    +

    Note

    +

    To obtain a hexadecimal string representation for a float, use the +float.hex() method.

    +
    +
    + +
    +
    +id(object)
    +

    Return the “identity” of an object. This is an integer which +is guaranteed to be unique and constant for this object during its lifetime. +Two objects with non-overlapping lifetimes may have the same id() +value.

    +
    +

    CPython implementation detail: This is the address of the object in memory.

    +
    +
    + +
    +
    +input([prompt])
    +

    If the prompt argument is present, it is written to standard output without +a trailing newline. The function then reads a line from input, converts it +to a string (stripping a trailing newline), and returns that. When EOF is +read, EOFError is raised. Example:

    +
    >>> s = input('--> ')  
    +--> Monty Python's Flying Circus
    +>>> s  
    +"Monty Python's Flying Circus"
    +
    +
    +

    If the readline module was loaded, then input() will use it +to provide elaborate line editing and history features.

    +
    + +
    +
    +class int([x])
    +
    +class int(x, base=10)
    +

    Return an integer object constructed from a number or string x, or return +0 if no arguments are given. If x defines __int__(), +int(x) returns x.__int__(). If x defines __trunc__(), +it returns x.__trunc__(). +For floating point numbers, this truncates towards zero.

    +

    If x is not a number or if base is given, then x must be a string, +bytes, or bytearray instance representing an integer +literal in radix base. Optionally, the literal can be +preceded by + or - (with no space in between) and surrounded by +whitespace. A base-n literal consists of the digits 0 to n-1, with a +to z (or A to Z) having +values 10 to 35. The default base is 10. The allowed values are 0 and 2–36. +Base-2, -8, and -16 literals can be optionally prefixed with 0b/0B, +0o/0O, or 0x/0X, as with integer literals in code. Base 0 +means to interpret exactly as a code literal, so that the actual base is 2, +8, 10, or 16, and so that int('010', 0) is not legal, while +int('010') is, as well as int('010', 8).

    +

    The integer type is described in Numeric Types — int, float, complex.

    +
    +

    Changed in version 3.4: If base is not an instance of int and the base object has a +base.__index__ method, that method is called +to obtain an integer for the base. Previous versions used +base.__int__ instead of base.__index__.

    +
    +
    +

    Changed in version 3.6: Grouping digits with underscores as in code literals is allowed.

    +
    +
    +

    Changed in version 3.7: x is now a positional-only parameter.

    +
    +
    + +
    +
    +isinstance(object, classinfo)
    +

    Return true if the object argument is an instance of the classinfo +argument, or of a (direct, indirect or virtual) subclass thereof. If object is not +an object of the given type, the function always returns false. +If classinfo is a tuple of type objects (or recursively, other such +tuples), return true if object is an instance of any of the types. +If classinfo is not a type or tuple of types and such tuples, +a TypeError exception is raised.

    +
    + +
    +
    +issubclass(class, classinfo)
    +

    Return true if class is a subclass (direct, indirect or virtual) of classinfo. A +class is considered a subclass of itself. classinfo may be a tuple of class +objects, in which case every entry in classinfo will be checked. In any other +case, a TypeError exception is raised.

    +
    + +
    +
    +iter(object[, sentinel])
    +

    Return an iterator object. The first argument is interpreted very +differently depending on the presence of the second argument. Without a +second argument, object must be a collection object which supports the +iteration protocol (the __iter__() method), or it must support the +sequence protocol (the __getitem__() method with integer arguments +starting at 0). If it does not support either of those protocols, +TypeError is raised. If the second argument, sentinel, is given, +then object must be a callable object. The iterator created in this case +will call object with no arguments for each call to its +__next__() method; if the value returned is equal to +sentinel, StopIteration will be raised, otherwise the value will +be returned.

    +

    See also Iterator Types.

    +

    One useful application of the second form of iter() is to build a +block-reader. For example, reading fixed-width blocks from a binary +database file until the end of file is reached:

    +
    from functools import partial
    +with open('mydata.db', 'rb') as f:
    +    for block in iter(partial(f.read, 64), b''):
    +        process_block(block)
    +
    +
    +
    + +
    +
    +len(s)
    +

    Return the length (the number of items) of an object. The argument may be a +sequence (such as a string, bytes, tuple, list, or range) or a collection +(such as a dictionary, set, or frozen set).

    +
    + +
    +
    +class list([iterable])
    +

    Rather than being a function, list is actually a mutable +sequence type, as documented in Lists and Sequence Types — list, tuple, range.

    +
    + +
    +
    +locals()
    +

    Update and return a dictionary representing the current local symbol table. +Free variables are returned by locals() when it is called in function +blocks, but not in class blocks. Note that at the module level, locals() +and globals() are the same dictionary.

    +
    +

    Note

    +

    The contents of this dictionary should not be modified; changes may not +affect the values of local and free variables used by the interpreter.

    +
    +
    + +
    +
    +map(function, iterable, ...)
    +

    Return an iterator that applies function to every item of iterable, +yielding the results. If additional iterable arguments are passed, +function must take that many arguments and is applied to the items from all +iterables in parallel. With multiple iterables, the iterator stops when the +shortest iterable is exhausted. For cases where the function inputs are +already arranged into argument tuples, see itertools.starmap().

    +
    + +
    +
    +max(iterable, *[, key, default])
    +
    +max(arg1, arg2, *args[, key])
    +

    Return the largest item in an iterable or the largest of two or more +arguments.

    +

    If one positional argument is provided, it should be an iterable. +The largest item in the iterable is returned. If two or more positional +arguments are provided, the largest of the positional arguments is +returned.

    +

    There are two optional keyword-only arguments. The key argument specifies +a one-argument ordering function like that used for list.sort(). The +default argument specifies an object to return if the provided iterable is +empty. If the iterable is empty and default is not provided, a +ValueError is raised.

    +

    If multiple items are maximal, the function returns the first one +encountered. This is consistent with other sort-stability preserving tools +such as sorted(iterable, key=keyfunc, reverse=True)[0] and +heapq.nlargest(1, iterable, key=keyfunc).

    +
    +

    New in version 3.4: The default keyword-only argument.

    +
    +
    + +
    +
    +memoryview(obj)
    +

    Return a “memory view” object created from the given argument. See +Memory Views for more information.

    +
    + +
    +
    +min(iterable, *[, key, default])
    +
    +min(arg1, arg2, *args[, key])
    +

    Return the smallest item in an iterable or the smallest of two or more +arguments.

    +

    If one positional argument is provided, it should be an iterable. +The smallest item in the iterable is returned. If two or more positional +arguments are provided, the smallest of the positional arguments is +returned.

    +

    There are two optional keyword-only arguments. The key argument specifies +a one-argument ordering function like that used for list.sort(). The +default argument specifies an object to return if the provided iterable is +empty. If the iterable is empty and default is not provided, a +ValueError is raised.

    +

    If multiple items are minimal, the function returns the first one +encountered. This is consistent with other sort-stability preserving tools +such as sorted(iterable, key=keyfunc)[0] and heapq.nsmallest(1, +iterable, key=keyfunc).

    +
    +

    New in version 3.4: The default keyword-only argument.

    +
    +
    + +
    +
    +next(iterator[, default])
    +

    Retrieve the next item from the iterator by calling its +__next__() method. If default is given, it is returned +if the iterator is exhausted, otherwise StopIteration is raised.

    +
    + +
    +
    +class object
    +

    Return a new featureless object. object is a base for all classes. +It has the methods that are common to all instances of Python classes. This +function does not accept any arguments.

    +
    +

    Note

    +

    object does not have a __dict__, so you can’t +assign arbitrary attributes to an instance of the object class.

    +
    +
    + +
    +
    +oct(x)
    +

    Convert an integer number to an octal string prefixed with “0o”. The result +is a valid Python expression. If x is not a Python int object, it +has to define an __index__() method that returns an integer. For +example:

    +
    >>> oct(8)
    +'0o10'
    +>>> oct(-56)
    +'-0o70'
    +
    +
    +

    If you want to convert an integer number to octal string either with prefix +“0o” or not, you can use either of the following ways.

    +
    >>> '%#o' % 10, '%o' % 10
    +('0o12', '12')
    +>>> format(10, '#o'), format(10, 'o')
    +('0o12', '12')
    +>>> f'{10:#o}', f'{10:o}'
    +('0o12', '12')
    +
    +
    +

    See also format() for more information.

    +
    +
    +
    + +
    +
    +open(file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None)
    +

    Open file and return a corresponding file object. If the file +cannot be opened, an OSError is raised.

    +

    file is a path-like object giving the pathname (absolute or +relative to the current working directory) of the file to be opened or an +integer file descriptor of the file to be wrapped. (If a file descriptor is +given, it is closed when the returned I/O object is closed, unless closefd +is set to False.)

    +

    mode is an optional string that specifies the mode in which the file is +opened. It defaults to 'r' which means open for reading in text mode. +Other common values are 'w' for writing (truncating the file if it +already exists), 'x' for exclusive creation and 'a' for appending +(which on some Unix systems, means that all writes append to the end of +the file regardless of the current seek position). In text mode, if +encoding is not specified the encoding used is platform dependent: +locale.getpreferredencoding(False) is called to get the current locale +encoding. (For reading and writing raw bytes use binary mode and leave +encoding unspecified.) The available modes are:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Character

    Meaning

    'r'

    open for reading (default)

    'w'

    open for writing, truncating the file first

    'x'

    open for exclusive creation, failing if the file already exists

    'a'

    open for writing, appending to the end of the file if it exists

    'b'

    binary mode

    't'

    text mode (default)

    '+'

    open a disk file for updating (reading and writing)

    +

    The default mode is 'r' (open for reading text, synonym of 'rt'). +For binary read-write access, the mode 'w+b' opens and truncates the file +to 0 bytes. 'r+b' opens the file without truncation.

    +

    As mentioned in the Overview, Python distinguishes between binary +and text I/O. Files opened in binary mode (including 'b' in the mode +argument) return contents as bytes objects without any decoding. In +text mode (the default, or when 't' is included in the mode argument), +the contents of the file are returned as str, the bytes having been +first decoded using a platform-dependent encoding or using the specified +encoding if given.

    +

    There is an additional mode character permitted, 'U', which no longer +has any effect, and is considered deprecated. It previously enabled +universal newlines in text mode, which became the default behaviour +in Python 3.0. Refer to the documentation of the +newline parameter for further details.

    +
    +

    Note

    +

    Python doesn’t depend on the underlying operating system’s notion of text +files; all the processing is done by Python itself, and is therefore +platform-independent.

    +
    +

    buffering is an optional integer used to set the buffering policy. Pass 0 +to switch buffering off (only allowed in binary mode), 1 to select line +buffering (only usable in text mode), and an integer > 1 to indicate the size +in bytes of a fixed-size chunk buffer. When no buffering argument is +given, the default buffering policy works as follows:

    +
      +
    • Binary files are buffered in fixed-size chunks; the size of the buffer is +chosen using a heuristic trying to determine the underlying device’s “block +size” and falling back on io.DEFAULT_BUFFER_SIZE. On many systems, +the buffer will typically be 4096 or 8192 bytes long.

    • +
    • “Interactive” text files (files for which isatty() +returns True) use line buffering. Other text files use the policy +described above for binary files.

    • +
    +

    encoding is the name of the encoding used to decode or encode the file. +This should only be used in text mode. The default encoding is platform +dependent (whatever locale.getpreferredencoding() returns), but any +text encoding supported by Python +can be used. See the codecs module for +the list of supported encodings.

    +

    errors is an optional string that specifies how encoding and decoding +errors are to be handled—this cannot be used in binary mode. +A variety of standard error handlers are available +(listed under Error Handlers), though any +error handling name that has been registered with +codecs.register_error() is also valid. The standard names +include:

    +
      +
    • 'strict' to raise a ValueError exception if there is +an encoding error. The default value of None has the same +effect.

    • +
    • 'ignore' ignores errors. Note that ignoring encoding errors +can lead to data loss.

    • +
    • 'replace' causes a replacement marker (such as '?') to be inserted +where there is malformed data.

    • +
    • 'surrogateescape' will represent any incorrect bytes as code +points in the Unicode Private Use Area ranging from U+DC80 to +U+DCFF. These private code points will then be turned back into +the same bytes when the surrogateescape error handler is used +when writing data. This is useful for processing files in an +unknown encoding.

    • +
    • 'xmlcharrefreplace' is only supported when writing to a file. +Characters not supported by the encoding are replaced with the +appropriate XML character reference &#nnn;.

    • +
    • 'backslashreplace' replaces malformed data by Python’s backslashed +escape sequences.

    • +
    • 'namereplace' (also only supported when writing) +replaces unsupported characters with \N{...} escape sequences.

    • +
    +

    newline controls how universal newlines mode works (it only +applies to text mode). It can be None, '', '\n', '\r', and +'\r\n'. It works as follows:

    +
      +
    • When reading input from the stream, if newline is None, universal +newlines mode is enabled. Lines in the input can end in '\n', +'\r', or '\r\n', and these are translated into '\n' before +being returned to the caller. If it is '', universal newlines mode is +enabled, but line endings are returned to the caller untranslated. If it +has any of the other legal values, input lines are only terminated by the +given string, and the line ending is returned to the caller untranslated.

    • +
    • When writing output to the stream, if newline is None, any '\n' +characters written are translated to the system default line separator, +os.linesep. If newline is '' or '\n', no translation +takes place. If newline is any of the other legal values, any '\n' +characters written are translated to the given string.

    • +
    +

    If closefd is False and a file descriptor rather than a filename was +given, the underlying file descriptor will be kept open when the file is +closed. If a filename is given closefd must be True (the default) +otherwise an error will be raised.

    +

    A custom opener can be used by passing a callable as opener. The underlying +file descriptor for the file object is then obtained by calling opener with +(file, flags). opener must return an open file descriptor (passing +os.open as opener results in functionality similar to passing +None).

    +

    The newly created file is non-inheritable.

    +

    The following example uses the dir_fd parameter of the +os.open() function to open a file relative to a given directory:

    +
    >>> import os
    +>>> dir_fd = os.open('somedir', os.O_RDONLY)
    +>>> def opener(path, flags):
    +...     return os.open(path, flags, dir_fd=dir_fd)
    +...
    +>>> with open('spamspam.txt', 'w', opener=opener) as f:
    +...     print('This will be written to somedir/spamspam.txt', file=f)
    +...
    +>>> os.close(dir_fd)  # don't leak a file descriptor
    +
    +
    +

    The type of file object returned by the open() function +depends on the mode. When open() is used to open a file in a text +mode ('w', 'r', 'wt', 'rt', etc.), it returns a subclass of +io.TextIOBase (specifically io.TextIOWrapper). When used +to open a file in a binary mode with buffering, the returned class is a +subclass of io.BufferedIOBase. The exact class varies: in read +binary mode, it returns an io.BufferedReader; in write binary and +append binary modes, it returns an io.BufferedWriter, and in +read/write mode, it returns an io.BufferedRandom. When buffering is +disabled, the raw stream, a subclass of io.RawIOBase, +io.FileIO, is returned.

    +

    See also the file handling modules, such as, fileinput, io +(where open() is declared), os, os.path, tempfile, +and shutil.

    +
    +
    +
    Changed in version 3.3:
      +
    • The opener parameter was added.

    • +
    • The 'x' mode was added.

    • +
    • IOError used to be raised, it is now an alias of OSError.

    • +
    • FileExistsError is now raised if the file opened in exclusive +creation mode ('x') already exists.

    • +
    +
    +
    +
    +
    +
    Changed in version 3.4:
      +
    • The file is now non-inheritable.

    • +
    +
    +
    +
    +

    Deprecated since version 3.4, will be removed in version 4.0: The 'U' mode.

    +
    +
    +
    +
    Changed in version 3.5:
      +
    • If the system call is interrupted and the signal handler does not raise an +exception, the function now retries the system call instead of raising an +InterruptedError exception (see PEP 475 for the rationale).

    • +
    • The 'namereplace' error handler was added.

    • +
    +
    +
    +
    +
    +
    Changed in version 3.6:
      +
    • Support added to accept objects implementing os.PathLike.

    • +
    • On Windows, opening a console buffer may return a subclass of +io.RawIOBase other than io.FileIO.

    • +
    +
    +
    +
    + +
    +
    +ord(c)
    +

    Given a string representing one Unicode character, return an integer +representing the Unicode code point of that character. For example, +ord('a') returns the integer 97 and ord('€') (Euro sign) +returns 8364. This is the inverse of chr().

    +
    + +
    +
    +pow(x, y[, z])
    +

    Return x to the power y; if z is present, return x to the power y, +modulo z (computed more efficiently than pow(x, y) % z). The two-argument +form pow(x, y) is equivalent to using the power operator: x**y.

    +

    The arguments must have numeric types. With mixed operand types, the +coercion rules for binary arithmetic operators apply. For int +operands, the result has the same type as the operands (after coercion) +unless the second argument is negative; in that case, all arguments are +converted to float and a float result is delivered. For example, 10**2 +returns 100, but 10**-2 returns 0.01. If the second argument is +negative, the third argument must be omitted. If z is present, x and y +must be of integer types, and y must be non-negative.

    +
    + +
    +
    +print(*objects, sep=' ', end='\n', file=sys.stdout, flush=False)
    +

    Print objects to the text stream file, separated by sep and followed +by end. sep, end, file and flush, if present, must be given as keyword +arguments.

    +

    All non-keyword arguments are converted to strings like str() does and +written to the stream, separated by sep and followed by end. Both sep +and end must be strings; they can also be None, which means to use the +default values. If no objects are given, print() will just write +end.

    +

    The file argument must be an object with a write(string) method; if it +is not present or None, sys.stdout will be used. Since printed +arguments are converted to text strings, print() cannot be used with +binary mode file objects. For these, use file.write(...) instead.

    +

    Whether output is buffered is usually determined by file, but if the +flush keyword argument is true, the stream is forcibly flushed.

    +
    +

    Changed in version 3.3: Added the flush keyword argument.

    +
    +
    + +
    +
    +class property(fget=None, fset=None, fdel=None, doc=None)
    +

    Return a property attribute.

    +

    fget is a function for getting an attribute value. fset is a function +for setting an attribute value. fdel is a function for deleting an attribute +value. And doc creates a docstring for the attribute.

    +

    A typical use is to define a managed attribute x:

    +
    class C:
    +    def __init__(self):
    +        self._x = None
    +
    +    def getx(self):
    +        return self._x
    +
    +    def setx(self, value):
    +        self._x = value
    +
    +    def delx(self):
    +        del self._x
    +
    +    x = property(getx, setx, delx, "I'm the 'x' property.")
    +
    +
    +

    If c is an instance of C, c.x will invoke the getter, +c.x = value will invoke the setter and del c.x the deleter.

    +

    If given, doc will be the docstring of the property attribute. Otherwise, the +property will copy fget’s docstring (if it exists). This makes it possible to +create read-only properties easily using property() as a decorator:

    +
    class Parrot:
    +    def __init__(self):
    +        self._voltage = 100000
    +
    +    @property
    +    def voltage(self):
    +        """Get the current voltage."""
    +        return self._voltage
    +
    +
    +

    The @property decorator turns the voltage() method into a “getter” +for a read-only attribute with the same name, and it sets the docstring for +voltage to “Get the current voltage.”

    +

    A property object has getter, setter, +and deleter methods usable as decorators that create a +copy of the property with the corresponding accessor function set to the +decorated function. This is best explained with an example:

    +
    class C:
    +    def __init__(self):
    +        self._x = None
    +
    +    @property
    +    def x(self):
    +        """I'm the 'x' property."""
    +        return self._x
    +
    +    @x.setter
    +    def x(self, value):
    +        self._x = value
    +
    +    @x.deleter
    +    def x(self):
    +        del self._x
    +
    +
    +

    This code is exactly equivalent to the first example. Be sure to give the +additional functions the same name as the original property (x in this +case.)

    +

    The returned property object also has the attributes fget, fset, and +fdel corresponding to the constructor arguments.

    +
    +

    Changed in version 3.5: The docstrings of property objects are now writeable.

    +
    +
    + +
    +
    +range(stop)
    +
    +range(start, stop[, step])
    +

    Rather than being a function, range is actually an immutable +sequence type, as documented in Ranges and Sequence Types — list, tuple, range.

    +
    + +
    +
    +repr(object)
    +

    Return a string containing a printable representation of an object. For many +types, this function makes an attempt to return a string that would yield an +object with the same value when passed to eval(), otherwise the +representation is a string enclosed in angle brackets that contains the name +of the type of the object together with additional information often +including the name and address of the object. A class can control what this +function returns for its instances by defining a __repr__() method.

    +
    + +
    +
    +reversed(seq)
    +

    Return a reverse iterator. seq must be an object which has +a __reversed__() method or supports the sequence protocol (the +__len__() method and the __getitem__() method with integer +arguments starting at 0).

    +
    + +
    +
    +round(number[, ndigits])
    +

    Return number rounded to ndigits precision after the decimal +point. If ndigits is omitted or is None, it returns the +nearest integer to its input.

    +

    For the built-in types supporting round(), values are rounded to the +closest multiple of 10 to the power minus ndigits; if two multiples are +equally close, rounding is done toward the even choice (so, for example, +both round(0.5) and round(-0.5) are 0, and round(1.5) is +2). Any integer value is valid for ndigits (positive, zero, or +negative). The return value is an integer if ndigits is omitted or +None. +Otherwise the return value has the same type as number.

    +

    For a general Python object number, round delegates to +number.__round__.

    +
    +

    Note

    +

    The behavior of round() for floats can be surprising: for example, +round(2.675, 2) gives 2.67 instead of the expected 2.68. +This is not a bug: it’s a result of the fact that most decimal fractions +can’t be represented exactly as a float. See Floating Point Arithmetic: Issues and Limitations for +more information.

    +
    +
    + +
    +
    +class set([iterable])
    +

    Return a new set object, optionally with elements taken from +iterable. set is a built-in class. See set and +Set Types — set, frozenset for documentation about this class.

    +

    For other containers see the built-in frozenset, list, +tuple, and dict classes, as well as the collections +module.

    +
    + +
    +
    +setattr(object, name, value)
    +

    This is the counterpart of getattr(). The arguments are an object, a +string and an arbitrary value. The string may name an existing attribute or a +new attribute. The function assigns the value to the attribute, provided the +object allows it. For example, setattr(x, 'foobar', 123) is equivalent to +x.foobar = 123.

    +
    + +
    +
    +class slice(stop)
    +
    +class slice(start, stop[, step])
    +

    Return a slice object representing the set of indices specified by +range(start, stop, step). The start and step arguments default to +None. Slice objects have read-only data attributes start, +stop and step which merely return the argument +values (or their default). They have no other explicit functionality; +however they are used by Numerical Python and other third party extensions. +Slice objects are also generated when extended indexing syntax is used. For +example: a[start:stop:step] or a[start:stop, i]. See +itertools.islice() for an alternate version that returns an iterator.

    +
    + +
    +
    +sorted(iterable, *, key=None, reverse=False)
    +

    Return a new sorted list from the items in iterable.

    +

    Has two optional arguments which must be specified as keyword arguments.

    +

    key specifies a function of one argument that is used to extract a comparison +key from each element in iterable (for example, key=str.lower). The +default value is None (compare the elements directly).

    +

    reverse is a boolean value. If set to True, then the list elements are +sorted as if each comparison were reversed.

    +

    Use functools.cmp_to_key() to convert an old-style cmp function to a +key function.

    +

    The built-in sorted() function is guaranteed to be stable. A sort is +stable if it guarantees not to change the relative order of elements that +compare equal — this is helpful for sorting in multiple passes (for +example, sort by department, then by salary grade).

    +

    For sorting examples and a brief sorting tutorial, see Sorting HOW TO.

    +
    + +
    +
    +@staticmethod
    +

    Transform a method into a static method.

    +

    A static method does not receive an implicit first argument. To declare a static +method, use this idiom:

    +
    class C:
    +    @staticmethod
    +    def f(arg1, arg2, ...): ...
    +
    +
    +

    The @staticmethod form is a function decorator – see +Function definitions for details.

    +

    A static method can be called either on the class (such as C.f()) or on an instance (such +as C().f()).

    +

    Static methods in Python are similar to those found in Java or C++. Also see +classmethod() for a variant that is useful for creating alternate class +constructors.

    +

    Like all decorators, it is also possible to call staticmethod as +a regular function and do something with its result. This is needed +in some cases where you need a reference to a function from a class +body and you want to avoid the automatic transformation to instance +method. For these cases, use this idiom:

    +
    class C:
    +    builtin_open = staticmethod(open)
    +
    +
    +

    For more information on static methods, see The standard type hierarchy.

    +
    + +
    +
    +class str(object='')
    +
    +class str(object=b'', encoding='utf-8', errors='strict')
    +

    Return a str version of object. See str() for details.

    +

    str is the built-in string class. For general information +about strings, see Text Sequence Type — str.

    +
    + +
    +
    +sum(iterable[, start])
    +

    Sums start and the items of an iterable from left to right and returns the +total. start defaults to 0. The iterable’s items are normally numbers, +and the start value is not allowed to be a string.

    +

    For some use cases, there are good alternatives to sum(). +The preferred, fast way to concatenate a sequence of strings is by calling +''.join(sequence). To add floating point values with extended precision, +see math.fsum(). To concatenate a series of iterables, consider using +itertools.chain().

    +
    + +
    +
    +super([type[, object-or-type]])
    +

    Return a proxy object that delegates method calls to a parent or sibling +class of type. This is useful for accessing inherited methods that have +been overridden in a class. The search order is same as that used by +getattr() except that the type itself is skipped.

    +

    The __mro__ attribute of the type lists the method +resolution search order used by both getattr() and super(). The +attribute is dynamic and can change whenever the inheritance hierarchy is +updated.

    +

    If the second argument is omitted, the super object returned is unbound. If +the second argument is an object, isinstance(obj, type) must be true. If +the second argument is a type, issubclass(type2, type) must be true (this +is useful for classmethods).

    +

    There are two typical use cases for super. In a class hierarchy with +single inheritance, super can be used to refer to parent classes without +naming them explicitly, thus making the code more maintainable. This use +closely parallels the use of super in other programming languages.

    +

    The second use case is to support cooperative multiple inheritance in a +dynamic execution environment. This use case is unique to Python and is +not found in statically compiled languages or languages that only support +single inheritance. This makes it possible to implement “diamond diagrams” +where multiple base classes implement the same method. Good design dictates +that this method have the same calling signature in every case (because the +order of calls is determined at runtime, because that order adapts +to changes in the class hierarchy, and because that order can include +sibling classes that are unknown prior to runtime).

    +

    For both use cases, a typical superclass call looks like this:

    +
    class C(B):
    +    def method(self, arg):
    +        super().method(arg)    # This does the same thing as:
    +                               # super(C, self).method(arg)
    +
    +
    +

    Note that super() is implemented as part of the binding process for +explicit dotted attribute lookups such as super().__getitem__(name). +It does so by implementing its own __getattribute__() method for searching +classes in a predictable order that supports cooperative multiple inheritance. +Accordingly, super() is undefined for implicit lookups using statements or +operators such as super()[name].

    +

    Also note that, aside from the zero argument form, super() is not +limited to use inside methods. The two argument form specifies the +arguments exactly and makes the appropriate references. The zero +argument form only works inside a class definition, as the compiler fills +in the necessary details to correctly retrieve the class being defined, +as well as accessing the current instance for ordinary methods.

    +

    For practical suggestions on how to design cooperative classes using +super(), see guide to using super().

    +
    + +
    +
    +tuple([iterable])
    +

    Rather than being a function, tuple is actually an immutable +sequence type, as documented in Tuples and Sequence Types — list, tuple, range.

    +
    + +
    +
    +class type(object)
    +
    +class type(name, bases, dict)
    +

    With one argument, return the type of an object. The return value is a +type object and generally the same object as returned by +object.__class__.

    +

    The isinstance() built-in function is recommended for testing the type +of an object, because it takes subclasses into account.

    +

    With three arguments, return a new type object. This is essentially a +dynamic form of the class statement. The name string is the +class name and becomes the __name__ attribute; the bases +tuple itemizes the base classes and becomes the __bases__ +attribute; and the dict dictionary is the namespace containing definitions +for class body and is copied to a standard dictionary to become the +__dict__ attribute. For example, the following two +statements create identical type objects:

    +
    >>> class X:
    +...     a = 1
    +...
    +>>> X = type('X', (object,), dict(a=1))
    +
    +
    +

    See also Type Objects.

    +
    +

    Changed in version 3.6: Subclasses of type which don’t override type.__new__ may no +longer use the one-argument form to get the type of an object.

    +
    +
    + +
    +
    +vars([object])
    +

    Return the __dict__ attribute for a module, class, instance, +or any other object with a __dict__ attribute.

    +

    Objects such as modules and instances have an updateable __dict__ +attribute; however, other objects may have write restrictions on their +__dict__ attributes (for example, classes use a +types.MappingProxyType to prevent direct dictionary updates).

    +

    Without an argument, vars() acts like locals(). Note, the +locals dictionary is only useful for reads since updates to the locals +dictionary are ignored.

    +
    + +
    +
    +zip(*iterables)
    +

    Make an iterator that aggregates elements from each of the iterables.

    +

    Returns an iterator of tuples, where the i-th tuple contains +the i-th element from each of the argument sequences or iterables. The +iterator stops when the shortest input iterable is exhausted. With a single +iterable argument, it returns an iterator of 1-tuples. With no arguments, +it returns an empty iterator. Equivalent to:

    +
    def zip(*iterables):
    +    # zip('ABCD', 'xy') --> Ax By
    +    sentinel = object()
    +    iterators = [iter(it) for it in iterables]
    +    while iterators:
    +        result = []
    +        for it in iterators:
    +            elem = next(it, sentinel)
    +            if elem is sentinel:
    +                return
    +            result.append(elem)
    +        yield tuple(result)
    +
    +
    +

    The left-to-right evaluation order of the iterables is guaranteed. This +makes possible an idiom for clustering a data series into n-length groups +using zip(*[iter(s)]*n). This repeats the same iterator n times +so that each output tuple has the result of n calls to the iterator. +This has the effect of dividing the input into n-length chunks.

    +

    zip() should only be used with unequal length inputs when you don’t +care about trailing, unmatched values from the longer iterables. If those +values are important, use itertools.zip_longest() instead.

    +

    zip() in conjunction with the * operator can be used to unzip a +list:

    +
    >>> x = [1, 2, 3]
    +>>> y = [4, 5, 6]
    +>>> zipped = zip(x, y)
    +>>> list(zipped)
    +[(1, 4), (2, 5), (3, 6)]
    +>>> x2, y2 = zip(*zip(x, y))
    +>>> x == list(x2) and y == list(y2)
    +True
    +
    +
    +
    + +
    +
    +__import__(name, globals=None, locals=None, fromlist=(), level=0)
    +
    +

    Note

    +

    This is an advanced function that is not needed in everyday Python +programming, unlike importlib.import_module().

    +
    +

    This function is invoked by the import statement. It can be +replaced (by importing the builtins module and assigning to +builtins.__import__) in order to change semantics of the +import statement, but doing so is strongly discouraged as it +is usually simpler to use import hooks (see PEP 302) to attain the same +goals and does not cause issues with code which assumes the default import +implementation is in use. Direct use of __import__() is also +discouraged in favor of importlib.import_module().

    +

    The function imports the module name, potentially using the given globals +and locals to determine how to interpret the name in a package context. +The fromlist gives the names of objects or submodules that should be +imported from the module given by name. The standard implementation does +not use its locals argument at all, and uses its globals only to +determine the package context of the import statement.

    +

    level specifies whether to use absolute or relative imports. 0 (the +default) means only perform absolute imports. Positive values for +level indicate the number of parent directories to search relative to the +directory of the module calling __import__() (see PEP 328 for the +details).

    +

    When the name variable is of the form package.module, normally, the +top-level package (the name up till the first dot) is returned, not the +module named by name. However, when a non-empty fromlist argument is +given, the module named by name is returned.

    +

    For example, the statement import spam results in bytecode resembling the +following code:

    +
    spam = __import__('spam', globals(), locals(), [], 0)
    +
    +
    +

    The statement import spam.ham results in this call:

    +
    spam = __import__('spam.ham', globals(), locals(), [], 0)
    +
    +
    +

    Note how __import__() returns the toplevel module here because this is +the object that is bound to a name by the import statement.

    +

    On the other hand, the statement from spam.ham import eggs, sausage as +saus results in

    +
    _temp = __import__('spam.ham', globals(), locals(), ['eggs', 'sausage'], 0)
    +eggs = _temp.eggs
    +saus = _temp.sausage
    +
    +
    +

    Here, the spam.ham module is returned from __import__(). From this +object, the names to import are retrieved and assigned to their respective +names.

    +

    If you simply want to import a module (potentially within a package) by name, +use importlib.import_module().

    +
    +

    Changed in version 3.3: Negative values for level are no longer supported (which also changes +the default value to 0).

    +
    +
    + +

    Footnotes

    +
    +
    1
    +

    Note that the parser only accepts the Unix-style end of line convention. +If you are reading the code from a file, make sure to use newline conversion +mode to convert Windows or Mac-style newlines.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/functools.html b/python-3.7.4-docs-html/library/functools.html new file mode 100644 index 0000000..8b9162d --- /dev/null +++ b/python-3.7.4-docs-html/library/functools.html @@ -0,0 +1,675 @@ + + + + + + + functools — Higher-order functions and operations on callable objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    functools — Higher-order functions and operations on callable objects

    +

    Source code: Lib/functools.py

    +
    +

    The functools module is for higher-order functions: functions that act on +or return other functions. In general, any callable object can be treated as a +function for the purposes of this module.

    +

    The functools module defines the following functions:

    +
    +
    +functools.cmp_to_key(func)
    +

    Transform an old-style comparison function to a key function. Used +with tools that accept key functions (such as sorted(), min(), +max(), heapq.nlargest(), heapq.nsmallest(), +itertools.groupby()). This function is primarily used as a transition +tool for programs being converted from Python 2 which supported the use of +comparison functions.

    +

    A comparison function is any callable that accept two arguments, compares them, +and returns a negative number for less-than, zero for equality, or a positive +number for greater-than. A key function is a callable that accepts one +argument and returns another value to be used as the sort key.

    +

    Example:

    +
    sorted(iterable, key=cmp_to_key(locale.strcoll))  # locale-aware sort order
    +
    +
    +

    For sorting examples and a brief sorting tutorial, see Sorting HOW TO.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +@functools.lru_cache(maxsize=128, typed=False)
    +

    Decorator to wrap a function with a memoizing callable that saves up to the +maxsize most recent calls. It can save time when an expensive or I/O bound +function is periodically called with the same arguments.

    +

    Since a dictionary is used to cache results, the positional and keyword +arguments to the function must be hashable.

    +

    Distinct argument patterns may be considered to be distinct calls with +separate cache entries. For example, f(a=1, b=2) and f(b=2, a=1) +differ in their keyword argument order and may have two separate cache +entries.

    +

    If maxsize is set to None, the LRU feature is disabled and the cache can +grow without bound. The LRU feature performs best when maxsize is a +power-of-two.

    +

    If typed is set to true, function arguments of different types will be +cached separately. For example, f(3) and f(3.0) will be treated +as distinct calls with distinct results.

    +

    To help measure the effectiveness of the cache and tune the maxsize +parameter, the wrapped function is instrumented with a cache_info() +function that returns a named tuple showing hits, misses, +maxsize and currsize. In a multi-threaded environment, the hits +and misses are approximate.

    +

    The decorator also provides a cache_clear() function for clearing or +invalidating the cache.

    +

    The original underlying function is accessible through the +__wrapped__ attribute. This is useful for introspection, for +bypassing the cache, or for rewrapping the function with a different cache.

    +

    An LRU (least recently used) cache works +best when the most recent calls are the best predictors of upcoming calls (for +example, the most popular articles on a news server tend to change each day). +The cache’s size limit assures that the cache does not grow without bound on +long-running processes such as web servers.

    +

    In general, the LRU cache should only be used when you want to reuse +previously computed values. Accordingly, it doesn’t make sense to cache +functions with side-effects, functions that need to create distinct mutable +objects on each call, or impure functions such as time() or random().

    +

    Example of an LRU cache for static web content:

    +
    @lru_cache(maxsize=32)
    +def get_pep(num):
    +    'Retrieve text of a Python Enhancement Proposal'
    +    resource = 'http://www.python.org/dev/peps/pep-%04d/' % num
    +    try:
    +        with urllib.request.urlopen(resource) as s:
    +            return s.read()
    +    except urllib.error.HTTPError:
    +        return 'Not Found'
    +
    +>>> for n in 8, 290, 308, 320, 8, 218, 320, 279, 289, 320, 9991:
    +...     pep = get_pep(n)
    +...     print(n, len(pep))
    +
    +>>> get_pep.cache_info()
    +CacheInfo(hits=3, misses=8, maxsize=32, currsize=8)
    +
    +
    +

    Example of efficiently computing +Fibonacci numbers +using a cache to implement a +dynamic programming +technique:

    +
    @lru_cache(maxsize=None)
    +def fib(n):
    +    if n < 2:
    +        return n
    +    return fib(n-1) + fib(n-2)
    +
    +>>> [fib(n) for n in range(16)]
    +[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377, 610]
    +
    +>>> fib.cache_info()
    +CacheInfo(hits=28, misses=16, maxsize=None, currsize=16)
    +
    +
    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.3: Added the typed option.

    +
    +
    + +
    +
    +@functools.total_ordering
    +

    Given a class defining one or more rich comparison ordering methods, this +class decorator supplies the rest. This simplifies the effort involved +in specifying all of the possible rich comparison operations:

    +

    The class must define one of __lt__(), __le__(), +__gt__(), or __ge__(). +In addition, the class should supply an __eq__() method.

    +

    For example:

    +
    @total_ordering
    +class Student:
    +    def _is_valid_operand(self, other):
    +        return (hasattr(other, "lastname") and
    +                hasattr(other, "firstname"))
    +    def __eq__(self, other):
    +        if not self._is_valid_operand(other):
    +            return NotImplemented
    +        return ((self.lastname.lower(), self.firstname.lower()) ==
    +                (other.lastname.lower(), other.firstname.lower()))
    +    def __lt__(self, other):
    +        if not self._is_valid_operand(other):
    +            return NotImplemented
    +        return ((self.lastname.lower(), self.firstname.lower()) <
    +                (other.lastname.lower(), other.firstname.lower()))
    +
    +
    +
    +

    Note

    +

    While this decorator makes it easy to create well behaved totally +ordered types, it does come at the cost of slower execution and +more complex stack traces for the derived comparison methods. If +performance benchmarking indicates this is a bottleneck for a given +application, implementing all six rich comparison methods instead is +likely to provide an easy speed boost.

    +
    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.4: Returning NotImplemented from the underlying comparison function for +unrecognised types is now supported.

    +
    +
    + +
    +
    +functools.partial(func, *args, **keywords)
    +

    Return a new partial object which when called +will behave like func called with the positional arguments args +and keyword arguments keywords. If more arguments are supplied to the +call, they are appended to args. If additional keyword arguments are +supplied, they extend and override keywords. +Roughly equivalent to:

    +
    def partial(func, *args, **keywords):
    +    def newfunc(*fargs, **fkeywords):
    +        newkeywords = keywords.copy()
    +        newkeywords.update(fkeywords)
    +        return func(*args, *fargs, **newkeywords)
    +    newfunc.func = func
    +    newfunc.args = args
    +    newfunc.keywords = keywords
    +    return newfunc
    +
    +
    +

    The partial() is used for partial function application which “freezes” +some portion of a function’s arguments and/or keywords resulting in a new object +with a simplified signature. For example, partial() can be used to create +a callable that behaves like the int() function where the base argument +defaults to two:

    +
    >>> from functools import partial
    +>>> basetwo = partial(int, base=2)
    +>>> basetwo.__doc__ = 'Convert base 2 string to an int.'
    +>>> basetwo('10010')
    +18
    +
    +
    +
    + +
    +
    +class functools.partialmethod(func, *args, **keywords)
    +

    Return a new partialmethod descriptor which behaves +like partial except that it is designed to be used as a method +definition rather than being directly callable.

    +

    func must be a descriptor or a callable (objects which are both, +like normal functions, are handled as descriptors).

    +

    When func is a descriptor (such as a normal Python function, +classmethod(), staticmethod(), abstractmethod() or +another instance of partialmethod), calls to __get__ are +delegated to the underlying descriptor, and an appropriate +partial object returned as the result.

    +

    When func is a non-descriptor callable, an appropriate bound method is +created dynamically. This behaves like a normal Python function when +used as a method: the self argument will be inserted as the first +positional argument, even before the args and keywords supplied to +the partialmethod constructor.

    +

    Example:

    +
    >>> class Cell(object):
    +...     def __init__(self):
    +...         self._alive = False
    +...     @property
    +...     def alive(self):
    +...         return self._alive
    +...     def set_state(self, state):
    +...         self._alive = bool(state)
    +...     set_alive = partialmethod(set_state, True)
    +...     set_dead = partialmethod(set_state, False)
    +...
    +>>> c = Cell()
    +>>> c.alive
    +False
    +>>> c.set_alive()
    +>>> c.alive
    +True
    +
    +
    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +functools.reduce(function, iterable[, initializer])
    +

    Apply function of two arguments cumulatively to the items of sequence, from +left to right, so as to reduce the sequence to a single value. For example, +reduce(lambda x, y: x+y, [1, 2, 3, 4, 5]) calculates ((((1+2)+3)+4)+5). +The left argument, x, is the accumulated value and the right argument, y, is +the update value from the sequence. If the optional initializer is present, +it is placed before the items of the sequence in the calculation, and serves as +a default when the sequence is empty. If initializer is not given and +sequence contains only one item, the first item is returned.

    +

    Roughly equivalent to:

    +
    def reduce(function, iterable, initializer=None):
    +    it = iter(iterable)
    +    if initializer is None:
    +        value = next(it)
    +    else:
    +        value = initializer
    +    for element in it:
    +        value = function(value, element)
    +    return value
    +
    +
    +
    + +
    +
    +@functools.singledispatch
    +

    Transform a function into a single-dispatch generic function.

    +

    To define a generic function, decorate it with the @singledispatch +decorator. Note that the dispatch happens on the type of the first argument, +create your function accordingly:

    +
    >>> from functools import singledispatch
    +>>> @singledispatch
    +... def fun(arg, verbose=False):
    +...     if verbose:
    +...         print("Let me just say,", end=" ")
    +...     print(arg)
    +
    +
    +

    To add overloaded implementations to the function, use the register() +attribute of the generic function. It is a decorator. For functions +annotated with types, the decorator will infer the type of the first +argument automatically:

    +
    >>> @fun.register
    +... def _(arg: int, verbose=False):
    +...     if verbose:
    +...         print("Strength in numbers, eh?", end=" ")
    +...     print(arg)
    +...
    +>>> @fun.register
    +... def _(arg: list, verbose=False):
    +...     if verbose:
    +...         print("Enumerate this:")
    +...     for i, elem in enumerate(arg):
    +...         print(i, elem)
    +
    +
    +

    For code which doesn’t use type annotations, the appropriate type +argument can be passed explicitly to the decorator itself:

    +
    >>> @fun.register(complex)
    +... def _(arg, verbose=False):
    +...     if verbose:
    +...         print("Better than complicated.", end=" ")
    +...     print(arg.real, arg.imag)
    +...
    +
    +
    +

    To enable registering lambdas and pre-existing functions, the +register() attribute can be used in a functional form:

    +
    >>> def nothing(arg, verbose=False):
    +...     print("Nothing.")
    +...
    +>>> fun.register(type(None), nothing)
    +
    +
    +

    The register() attribute returns the undecorated function which +enables decorator stacking, pickling, as well as creating unit tests for +each variant independently:

    +
    >>> @fun.register(float)
    +... @fun.register(Decimal)
    +... def fun_num(arg, verbose=False):
    +...     if verbose:
    +...         print("Half of your number:", end=" ")
    +...     print(arg / 2)
    +...
    +>>> fun_num is fun
    +False
    +
    +
    +

    When called, the generic function dispatches on the type of the first +argument:

    +
    >>> fun("Hello, world.")
    +Hello, world.
    +>>> fun("test.", verbose=True)
    +Let me just say, test.
    +>>> fun(42, verbose=True)
    +Strength in numbers, eh? 42
    +>>> fun(['spam', 'spam', 'eggs', 'spam'], verbose=True)
    +Enumerate this:
    +0 spam
    +1 spam
    +2 eggs
    +3 spam
    +>>> fun(None)
    +Nothing.
    +>>> fun(1.23)
    +0.615
    +
    +
    +

    Where there is no registered implementation for a specific type, its +method resolution order is used to find a more generic implementation. +The original function decorated with @singledispatch is registered +for the base object type, which means it is used if no better +implementation is found.

    +

    To check which implementation will the generic function choose for +a given type, use the dispatch() attribute:

    +
    >>> fun.dispatch(float)
    +<function fun_num at 0x1035a2840>
    +>>> fun.dispatch(dict)    # note: default implementation
    +<function fun at 0x103fe0000>
    +
    +
    +

    To access all registered implementations, use the read-only registry +attribute:

    +
    >>> fun.registry.keys()
    +dict_keys([<class 'NoneType'>, <class 'int'>, <class 'object'>,
    +          <class 'decimal.Decimal'>, <class 'list'>,
    +          <class 'float'>])
    +>>> fun.registry[float]
    +<function fun_num at 0x1035a2840>
    +>>> fun.registry[object]
    +<function fun at 0x103fe0000>
    +
    +
    +
    +

    New in version 3.4.

    +
    +
    +

    Changed in version 3.7: The register() attribute supports using type annotations.

    +
    +
    + +
    +
    +functools.update_wrapper(wrapper, wrapped, assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES)
    +

    Update a wrapper function to look like the wrapped function. The optional +arguments are tuples to specify which attributes of the original function are +assigned directly to the matching attributes on the wrapper function and which +attributes of the wrapper function are updated with the corresponding attributes +from the original function. The default values for these arguments are the +module level constants WRAPPER_ASSIGNMENTS (which assigns to the wrapper +function’s __module__, __name__, __qualname__, __annotations__ +and __doc__, the documentation string) and WRAPPER_UPDATES (which +updates the wrapper function’s __dict__, i.e. the instance dictionary).

    +

    To allow access to the original function for introspection and other purposes +(e.g. bypassing a caching decorator such as lru_cache()), this function +automatically adds a __wrapped__ attribute to the wrapper that refers to +the function being wrapped.

    +

    The main intended use for this function is in decorator functions which +wrap the decorated function and return the wrapper. If the wrapper function is +not updated, the metadata of the returned function will reflect the wrapper +definition rather than the original function definition, which is typically less +than helpful.

    +

    update_wrapper() may be used with callables other than functions. Any +attributes named in assigned or updated that are missing from the object +being wrapped are ignored (i.e. this function will not attempt to set them +on the wrapper function). AttributeError is still raised if the +wrapper function itself is missing any attributes named in updated.

    +
    +

    New in version 3.2: Automatic addition of the __wrapped__ attribute.

    +
    +
    +

    New in version 3.2: Copying of the __annotations__ attribute by default.

    +
    +
    +

    Changed in version 3.2: Missing attributes no longer trigger an AttributeError.

    +
    +
    +

    Changed in version 3.4: The __wrapped__ attribute now always refers to the wrapped +function, even if that function defined a __wrapped__ attribute. +(see bpo-17482)

    +
    +
    + +
    +
    +@functools.wraps(wrapped, assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES)
    +

    This is a convenience function for invoking update_wrapper() as a +function decorator when defining a wrapper function. It is equivalent to +partial(update_wrapper, wrapped=wrapped, assigned=assigned, updated=updated). +For example:

    +
    >>> from functools import wraps
    +>>> def my_decorator(f):
    +...     @wraps(f)
    +...     def wrapper(*args, **kwds):
    +...         print('Calling decorated function')
    +...         return f(*args, **kwds)
    +...     return wrapper
    +...
    +>>> @my_decorator
    +... def example():
    +...     """Docstring"""
    +...     print('Called example function')
    +...
    +>>> example()
    +Calling decorated function
    +Called example function
    +>>> example.__name__
    +'example'
    +>>> example.__doc__
    +'Docstring'
    +
    +
    +

    Without the use of this decorator factory, the name of the example function +would have been 'wrapper', and the docstring of the original example() +would have been lost.

    +
    + +
    +

    partial Objects

    +

    partial objects are callable objects created by partial(). They +have three read-only attributes:

    +
    +
    +partial.func
    +

    A callable object or function. Calls to the partial object will be +forwarded to func with new arguments and keywords.

    +
    + +
    +
    +partial.args
    +

    The leftmost positional arguments that will be prepended to the positional +arguments provided to a partial object call.

    +
    + +
    +
    +partial.keywords
    +

    The keyword arguments that will be supplied when the partial object is +called.

    +
    + +

    partial objects are like function objects in that they are +callable, weak referencable, and can have attributes. There are some important +differences. For instance, the __name__ and __doc__ attributes +are not created automatically. Also, partial objects defined in +classes behave like static methods and do not transform into bound methods +during instance attribute look-up.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/gc.html b/python-3.7.4-docs-html/library/gc.html new file mode 100644 index 0000000..bddeb58 --- /dev/null +++ b/python-3.7.4-docs-html/library/gc.html @@ -0,0 +1,489 @@ + + + + + + + gc — Garbage Collector interface — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    gc — Garbage Collector interface

    +
    +

    This module provides an interface to the optional garbage collector. It +provides the ability to disable the collector, tune the collection frequency, +and set debugging options. It also provides access to unreachable objects that +the collector found but cannot free. Since the collector supplements the +reference counting already used in Python, you can disable the collector if you +are sure your program does not create reference cycles. Automatic collection +can be disabled by calling gc.disable(). To debug a leaking program call +gc.set_debug(gc.DEBUG_LEAK). Notice that this includes +gc.DEBUG_SAVEALL, causing garbage-collected objects to be saved in +gc.garbage for inspection.

    +

    The gc module provides the following functions:

    +
    +
    +gc.enable()
    +

    Enable automatic garbage collection.

    +
    + +
    +
    +gc.disable()
    +

    Disable automatic garbage collection.

    +
    + +
    +
    +gc.isenabled()
    +

    Returns true if automatic collection is enabled.

    +
    + +
    +
    +gc.collect(generation=2)
    +

    With no arguments, run a full collection. The optional argument generation +may be an integer specifying which generation to collect (from 0 to 2). A +ValueError is raised if the generation number is invalid. The number of +unreachable objects found is returned.

    +

    The free lists maintained for a number of built-in types are cleared +whenever a full collection or collection of the highest generation (2) +is run. Not all items in some free lists may be freed due to the +particular implementation, in particular float.

    +
    + +
    +
    +gc.set_debug(flags)
    +

    Set the garbage collection debugging flags. Debugging information will be +written to sys.stderr. See below for a list of debugging flags which can be +combined using bit operations to control debugging.

    +
    + +
    +
    +gc.get_debug()
    +

    Return the debugging flags currently set.

    +
    + +
    +
    +gc.get_objects()
    +

    Returns a list of all objects tracked by the collector, excluding the list +returned.

    +
    + +
    +
    +gc.get_stats()
    +

    Return a list of three per-generation dictionaries containing collection +statistics since interpreter start. The number of keys may change +in the future, but currently each dictionary will contain the following +items:

    +
      +
    • collections is the number of times this generation was collected;

    • +
    • collected is the total number of objects collected inside this +generation;

    • +
    • uncollectable is the total number of objects which were found +to be uncollectable (and were therefore moved to the garbage +list) inside this generation.

    • +
    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +gc.set_threshold(threshold0[, threshold1[, threshold2]])
    +

    Set the garbage collection thresholds (the collection frequency). Setting +threshold0 to zero disables collection.

    +

    The GC classifies objects into three generations depending on how many +collection sweeps they have survived. New objects are placed in the youngest +generation (generation 0). If an object survives a collection it is moved +into the next older generation. Since generation 2 is the oldest +generation, objects in that generation remain there after a collection. In +order to decide when to run, the collector keeps track of the number object +allocations and deallocations since the last collection. When the number of +allocations minus the number of deallocations exceeds threshold0, collection +starts. Initially only generation 0 is examined. If generation 0 has +been examined more than threshold1 times since generation 1 has been +examined, then generation 1 is examined as well. Similarly, threshold2 +controls the number of collections of generation 1 before collecting +generation 2.

    +
    + +
    +
    +gc.get_count()
    +

    Return the current collection counts as a tuple of (count0, count1, +count2).

    +
    + +
    +
    +gc.get_threshold()
    +

    Return the current collection thresholds as a tuple of (threshold0, +threshold1, threshold2).

    +
    + +
    +
    +gc.get_referrers(*objs)
    +

    Return the list of objects that directly refer to any of objs. This function +will only locate those containers which support garbage collection; extension +types which do refer to other objects but do not support garbage collection will +not be found.

    +

    Note that objects which have already been dereferenced, but which live in cycles +and have not yet been collected by the garbage collector can be listed among the +resulting referrers. To get only currently live objects, call collect() +before calling get_referrers().

    +

    Care must be taken when using objects returned by get_referrers() because +some of them could still be under construction and hence in a temporarily +invalid state. Avoid using get_referrers() for any purpose other than +debugging.

    +
    + +
    +
    +gc.get_referents(*objs)
    +

    Return a list of objects directly referred to by any of the arguments. The +referents returned are those objects visited by the arguments’ C-level +tp_traverse methods (if any), and may not be all objects actually +directly reachable. tp_traverse methods are supported only by objects +that support garbage collection, and are only required to visit objects that may +be involved in a cycle. So, for example, if an integer is directly reachable +from an argument, that integer object may or may not appear in the result list.

    +
    + +
    +
    +gc.is_tracked(obj)
    +

    Returns True if the object is currently tracked by the garbage collector, +False otherwise. As a general rule, instances of atomic types aren’t +tracked and instances of non-atomic types (containers, user-defined +objects…) are. However, some type-specific optimizations can be present +in order to suppress the garbage collector footprint of simple instances +(e.g. dicts containing only atomic keys and values):

    +
    >>> gc.is_tracked(0)
    +False
    +>>> gc.is_tracked("a")
    +False
    +>>> gc.is_tracked([])
    +True
    +>>> gc.is_tracked({})
    +False
    +>>> gc.is_tracked({"a": 1})
    +False
    +>>> gc.is_tracked({"a": []})
    +True
    +
    +
    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +gc.freeze()
    +

    Freeze all the objects tracked by gc - move them to a permanent generation +and ignore all the future collections. This can be used before a POSIX +fork() call to make the gc copy-on-write friendly or to speed up collection. +Also collection before a POSIX fork() call may free pages for future +allocation which can cause copy-on-write too so it’s advised to disable gc +in master process and freeze before fork and enable gc in child process.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +gc.unfreeze()
    +

    Unfreeze the objects in the permanent generation, put them back into the +oldest generation.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +gc.get_freeze_count()
    +

    Return the number of objects in the permanent generation.

    +
    +

    New in version 3.7.

    +
    +
    + +

    The following variables are provided for read-only access (you can mutate the +values but should not rebind them):

    +
    +
    +gc.garbage
    +

    A list of objects which the collector found to be unreachable but could +not be freed (uncollectable objects). Starting with Python 3.4, this +list should be empty most of the time, except when using instances of +C extension types with a non-NULL tp_del slot.

    +

    If DEBUG_SAVEALL is set, then all unreachable objects will be +added to this list rather than freed.

    +
    +

    Changed in version 3.2: If this list is non-empty at interpreter shutdown, a +ResourceWarning is emitted, which is silent by default. If +DEBUG_UNCOLLECTABLE is set, in addition all uncollectable objects +are printed.

    +
    +
    +

    Changed in version 3.4: Following PEP 442, objects with a __del__() method don’t end +up in gc.garbage anymore.

    +
    +
    + +
    +
    +gc.callbacks
    +

    A list of callbacks that will be invoked by the garbage collector before and +after collection. The callbacks will be called with two arguments, +phase and info.

    +

    phase can be one of two values:

    +
    +

    “start”: The garbage collection is about to start.

    +

    “stop”: The garbage collection has finished.

    +
    +

    info is a dict providing more information for the callback. The following +keys are currently defined:

    +
    +

    “generation”: The oldest generation being collected.

    +

    “collected”: When phase is “stop”, the number of objects +successfully collected.

    +

    “uncollectable”: When phase is “stop”, the number of objects +that could not be collected and were put in garbage.

    +
    +

    Applications can add their own callbacks to this list. The primary +use cases are:

    +
    +

    Gathering statistics about garbage collection, such as how often +various generations are collected, and how long the collection +takes.

    +

    Allowing applications to identify and clear their own uncollectable +types when they appear in garbage.

    +
    +
    +

    New in version 3.3.

    +
    +
    + +

    The following constants are provided for use with set_debug():

    +
    +
    +gc.DEBUG_STATS
    +

    Print statistics during collection. This information can be useful when tuning +the collection frequency.

    +
    + +
    +
    +gc.DEBUG_COLLECTABLE
    +

    Print information on collectable objects found.

    +
    + +
    +
    +gc.DEBUG_UNCOLLECTABLE
    +

    Print information of uncollectable objects found (objects which are not +reachable but cannot be freed by the collector). These objects will be added +to the garbage list.

    +
    +

    Changed in version 3.2: Also print the contents of the garbage list at +interpreter shutdown, if it isn’t empty.

    +
    +
    + +
    +
    +gc.DEBUG_SAVEALL
    +

    When set, all unreachable objects found will be appended to garbage rather +than being freed. This can be useful for debugging a leaking program.

    +
    + +
    +
    +gc.DEBUG_LEAK
    +

    The debugging flags necessary for the collector to print information about a +leaking program (equal to DEBUG_COLLECTABLE | DEBUG_UNCOLLECTABLE | +DEBUG_SAVEALL).

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/getopt.html b/python-3.7.4-docs-html/library/getopt.html new file mode 100644 index 0000000..0c1619b --- /dev/null +++ b/python-3.7.4-docs-html/library/getopt.html @@ -0,0 +1,339 @@ + + + + + + + getopt — C-style parser for command line options — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    getopt — C-style parser for command line options

    +

    Source code: Lib/getopt.py

    +
    +

    Note

    +

    The getopt module is a parser for command line options whose API is +designed to be familiar to users of the C getopt() function. Users who +are unfamiliar with the C getopt() function or who would like to write +less code and get better help and error messages should consider using the +argparse module instead.

    +
    +
    +

    This module helps scripts to parse the command line arguments in sys.argv. +It supports the same conventions as the Unix getopt() function (including +the special meanings of arguments of the form ‘-‘ and ‘--‘). Long +options similar to those supported by GNU software may be used as well via an +optional third argument.

    +

    This module provides two functions and an +exception:

    +
    +
    +getopt.getopt(args, shortopts, longopts=[])
    +

    Parses command line options and parameter list. args is the argument list to +be parsed, without the leading reference to the running program. Typically, this +means sys.argv[1:]. shortopts is the string of option letters that the +script wants to recognize, with options that require an argument followed by a +colon (':'; i.e., the same format that Unix getopt() uses).

    +
    +

    Note

    +

    Unlike GNU getopt(), after a non-option argument, all further +arguments are considered also non-options. This is similar to the way +non-GNU Unix systems work.

    +
    +

    longopts, if specified, must be a list of strings with the names of the +long options which should be supported. The leading '--' characters +should not be included in the option name. Long options which require an +argument should be followed by an equal sign ('='). Optional arguments +are not supported. To accept only long options, shortopts should be an +empty string. Long options on the command line can be recognized so long as +they provide a prefix of the option name that matches exactly one of the +accepted options. For example, if longopts is ['foo', 'frob'], the +option --fo will match as --foo, but --f will +not match uniquely, so GetoptError will be raised.

    +

    The return value consists of two elements: the first is a list of (option, +value) pairs; the second is the list of program arguments left after the +option list was stripped (this is a trailing slice of args). Each +option-and-value pair returned has the option as its first element, prefixed +with a hyphen for short options (e.g., '-x') or two hyphens for long +options (e.g., '--long-option'), and the option argument as its +second element, or an empty string if the option has no argument. The +options occur in the list in the same order in which they were found, thus +allowing multiple occurrences. Long and short options may be mixed.

    +
    + +
    +
    +getopt.gnu_getopt(args, shortopts, longopts=[])
    +

    This function works like getopt(), except that GNU style scanning mode is +used by default. This means that option and non-option arguments may be +intermixed. The getopt() function stops processing options as soon as a +non-option argument is encountered.

    +

    If the first character of the option string is '+', or if the environment +variable POSIXLY_CORRECT is set, then option processing stops as +soon as a non-option argument is encountered.

    +
    + +
    +
    +exception getopt.GetoptError
    +

    This is raised when an unrecognized option is found in the argument list or when +an option requiring an argument is given none. The argument to the exception is +a string indicating the cause of the error. For long options, an argument given +to an option which does not require one will also cause this exception to be +raised. The attributes msg and opt give the error message and +related option; if there is no specific option to which the exception relates, +opt is an empty string.

    +
    + +
    +
    +exception getopt.error
    +

    Alias for GetoptError; for backward compatibility.

    +
    + +

    An example using only Unix style options:

    +
    >>> import getopt
    +>>> args = '-a -b -cfoo -d bar a1 a2'.split()
    +>>> args
    +['-a', '-b', '-cfoo', '-d', 'bar', 'a1', 'a2']
    +>>> optlist, args = getopt.getopt(args, 'abc:d:')
    +>>> optlist
    +[('-a', ''), ('-b', ''), ('-c', 'foo'), ('-d', 'bar')]
    +>>> args
    +['a1', 'a2']
    +
    +
    +

    Using long option names is equally easy:

    +
    >>> s = '--condition=foo --testing --output-file abc.def -x a1 a2'
    +>>> args = s.split()
    +>>> args
    +['--condition=foo', '--testing', '--output-file', 'abc.def', '-x', 'a1', 'a2']
    +>>> optlist, args = getopt.getopt(args, 'x', [
    +...     'condition=', 'output-file=', 'testing'])
    +>>> optlist
    +[('--condition', 'foo'), ('--testing', ''), ('--output-file', 'abc.def'), ('-x', '')]
    +>>> args
    +['a1', 'a2']
    +
    +
    +

    In a script, typical usage is something like this:

    +
    import getopt, sys
    +
    +def main():
    +    try:
    +        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"
    +        usage()
    +        sys.exit(2)
    +    output = None
    +    verbose = False
    +    for o, a in opts:
    +        if o == "-v":
    +            verbose = True
    +        elif o in ("-h", "--help"):
    +            usage()
    +            sys.exit()
    +        elif o in ("-o", "--output"):
    +            output = a
    +        else:
    +            assert False, "unhandled option"
    +    # ...
    +
    +if __name__ == "__main__":
    +    main()
    +
    +
    +

    Note that an equivalent command line interface could be produced with less code +and more informative help and error messages by using the argparse module:

    +
    import argparse
    +
    +if __name__ == '__main__':
    +    parser = argparse.ArgumentParser()
    +    parser.add_argument('-o', '--output')
    +    parser.add_argument('-v', dest='verbose', action='store_true')
    +    args = parser.parse_args()
    +    # ... do something with args.output ...
    +    # ... do something with args.verbose ..
    +
    +
    +
    +

    See also

    +
    +
    Module argparse

    Alternative command line option and argument parsing library.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/getpass.html b/python-3.7.4-docs-html/library/getpass.html new file mode 100644 index 0000000..58321a4 --- /dev/null +++ b/python-3.7.4-docs-html/library/getpass.html @@ -0,0 +1,224 @@ + + + + + + + getpass — Portable password input — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    getpass — Portable password input

    +

    Source code: Lib/getpass.py

    +
    +

    The getpass module provides two functions:

    +
    +
    +getpass.getpass(prompt='Password: ', stream=None)
    +

    Prompt the user for a password without echoing. The user is prompted using +the string prompt, which defaults to 'Password: '. On Unix, the +prompt is written to the file-like object stream using the replace error +handler if needed. stream defaults to the controlling terminal +(/dev/tty) or if that is unavailable to sys.stderr (this +argument is ignored on Windows).

    +

    If echo free input is unavailable getpass() falls back to printing +a warning message to stream and reading from sys.stdin and +issuing a GetPassWarning.

    +
    +

    Note

    +

    If you call getpass from within IDLE, the input may be done in the +terminal you launched IDLE from rather than the idle window itself.

    +
    +
    + +
    +
    +exception getpass.GetPassWarning
    +

    A UserWarning subclass issued when password input may be echoed.

    +
    + +
    +
    +getpass.getuser()
    +

    Return the “login name” of the user.

    +

    This function checks the environment variables LOGNAME, +USER, LNAME and USERNAME, in order, and +returns the value of the first one which is set to a non-empty string. If +none are set, the login name from the password database is returned on +systems which support the pwd module, otherwise, an exception is +raised.

    +

    In general, this function should be preferred over os.getlogin().

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/gettext.html b/python-3.7.4-docs-html/library/gettext.html new file mode 100644 index 0000000..fe63f0d --- /dev/null +++ b/python-3.7.4-docs-html/library/gettext.html @@ -0,0 +1,843 @@ + + + + + + + gettext — Multilingual internationalization services — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    gettext — Multilingual internationalization services

    +

    Source code: Lib/gettext.py

    +
    +

    The gettext module provides internationalization (I18N) and localization +(L10N) services for your Python modules and applications. It supports both the +GNU gettext message catalog API and a higher level, class-based API that may +be more appropriate for Python files. The interface described below allows you +to write your module and application messages in one natural language, and +provide a catalog of translated messages for running under different natural +languages.

    +

    Some hints on localizing your Python modules and applications are also given.

    +
    +

    GNU gettext API

    +

    The gettext module defines the following API, which is very similar to +the GNU gettext API. If you use this API you will affect the +translation of your entire application globally. Often this is what you want if +your application is monolingual, with the choice of language dependent on the +locale of your user. If you are localizing a Python module, or if your +application needs to switch languages on the fly, you probably want to use the +class-based API instead.

    +
    +
    +gettext.bindtextdomain(domain, localedir=None)
    +

    Bind the domain to the locale directory localedir. More concretely, +gettext will look for binary .mo files for the given domain using +the path (on Unix): localedir/language/LC_MESSAGES/domain.mo, where +languages is searched for in the environment variables LANGUAGE, +LC_ALL, LC_MESSAGES, and LANG respectively.

    +

    If localedir is omitted or None, then the current binding for domain is +returned. 1

    +
    + +
    +
    +gettext.bind_textdomain_codeset(domain, codeset=None)
    +

    Bind the domain to codeset, changing the encoding of byte strings +returned by the lgettext(), ldgettext(), lngettext() +and ldngettext() functions. +If codeset is omitted, then the current binding is returned.

    +
    + +
    +
    +gettext.textdomain(domain=None)
    +

    Change or query the current global domain. If domain is None, then the +current global domain is returned, otherwise the global domain is set to +domain, which is returned.

    +
    + +
    +
    +gettext.gettext(message)
    +

    Return the localized translation of message, based on the current global +domain, language, and locale directory. This function is usually aliased as +_() in the local namespace (see examples below).

    +
    + +
    +
    +gettext.dgettext(domain, message)
    +

    Like gettext(), but look the message up in the specified domain.

    +
    + +
    +
    +gettext.ngettext(singular, plural, n)
    +

    Like gettext(), but consider plural forms. If a translation is found, +apply the plural formula to n, and return the resulting message (some +languages have more than two plural forms). If no translation is found, return +singular if n is 1; return plural otherwise.

    +

    The Plural formula is taken from the catalog header. It is a C or Python +expression that has a free variable n; the expression evaluates to the index +of the plural in the catalog. See +the GNU gettext documentation +for the precise syntax to be used in .po files and the +formulas for a variety of languages.

    +
    + +
    +
    +gettext.dngettext(domain, singular, plural, n)
    +

    Like ngettext(), but look the message up in the specified domain.

    +
    + +
    +
    +gettext.lgettext(message)
    +
    + +
    +
    +gettext.ldgettext(domain, message)
    +
    + +
    +
    +gettext.lngettext(singular, plural, n)
    +
    + +
    +
    +gettext.ldngettext(domain, singular, plural, n)
    +

    Equivalent to the corresponding functions without the l prefix +(gettext(), dgettext(), ngettext() and dngettext()), +but the translation is returned as a byte string encoded in the preferred +system encoding if no other encoding was explicitly set with +bind_textdomain_codeset().

    +
    +

    Warning

    +

    These functions should be avoided in Python 3, because they return +encoded bytes. It’s much better to use alternatives which return +Unicode strings instead, since most Python applications will want to +manipulate human readable text as strings instead of bytes. Further, +it’s possible that you may get unexpected Unicode-related exceptions +if there are encoding problems with the translated strings. It is +possible that the l*() functions will be deprecated in future Python +versions due to their inherent problems and limitations.

    +
    +
    + +

    Note that GNU gettext also defines a dcgettext() method, but +this was deemed not useful and so it is currently unimplemented.

    +

    Here’s an example of typical usage for this API:

    +
    import gettext
    +gettext.bindtextdomain('myapplication', '/path/to/my/language/directory')
    +gettext.textdomain('myapplication')
    +_ = gettext.gettext
    +# ...
    +print(_('This is a translatable string.'))
    +
    +
    +
    +
    +

    Class-based API

    +

    The class-based API of the gettext module gives you more flexibility and +greater convenience than the GNU gettext API. It is the recommended +way of localizing your Python applications and modules. gettext defines +a GNUTranslations class which implements the parsing of GNU .mo format +files, and has methods for returning strings. Instances of this class can also +install themselves in the built-in namespace as the function _().

    +
    +
    +gettext.find(domain, localedir=None, languages=None, all=False)
    +

    This function implements the standard .mo file search algorithm. It +takes a domain, identical to what textdomain() takes. Optional +localedir is as in bindtextdomain(). Optional languages is a list of +strings, where each string is a language code.

    +

    If localedir is not given, then the default system locale directory is used. +2 If languages is not given, then the following environment variables are +searched: LANGUAGE, LC_ALL, LC_MESSAGES, and +LANG. The first one returning a non-empty value is used for the +languages variable. The environment variables should contain a colon separated +list of languages, which will be split on the colon to produce the expected list +of language code strings.

    +

    find() then expands and normalizes the languages, and then iterates +through them, searching for an existing file built of these components:

    +

    localedir/language/LC_MESSAGES/domain.mo

    +

    The first such file name that exists is returned by find(). If no such +file is found, then None is returned. If all is given, it returns a list +of all file names, in the order in which they appear in the languages list or +the environment variables.

    +
    + +
    +
    +gettext.translation(domain, localedir=None, languages=None, class_=None, fallback=False, codeset=None)
    +

    Return a *Translations instance based on the domain, localedir, +and languages, which are first passed to find() to get a list of the +associated .mo file paths. Instances with identical .mo file +names are cached. The actual class instantiated is class_ if +provided, otherwise GNUTranslations. The class’s constructor must +take a single file object argument. If provided, codeset will change +the charset used to encode translated strings in the +lgettext() and lngettext() +methods.

    +

    If multiple files are found, later files are used as fallbacks for earlier ones. +To allow setting the fallback, copy.copy() is used to clone each +translation object from the cache; the actual instance data is still shared with +the cache.

    +

    If no .mo file is found, this function raises OSError if +fallback is false (which is the default), and returns a +NullTranslations instance if fallback is true.

    +
    +

    Changed in version 3.3: IOError used to be raised instead of OSError.

    +
    +
    + +
    +
    +gettext.install(domain, localedir=None, codeset=None, names=None)
    +

    This installs the function _() in Python’s builtins namespace, based on +domain, localedir, and codeset which are passed to the function +translation().

    +

    For the names parameter, please see the description of the translation +object’s install() method.

    +

    As seen below, you usually mark the strings in your application that are +candidates for translation, by wrapping them in a call to the _() +function, like this:

    +
    print(_('This string will be translated.'))
    +
    +
    +

    For convenience, you want the _() function to be installed in Python’s +builtins namespace, so it is easily accessible in all modules of your +application.

    +
    + +
    +

    The NullTranslations class

    +

    Translation classes are what actually implement the translation of original +source file message strings to translated message strings. The base class used +by all translation classes is NullTranslations; this provides the basic +interface you can use to write your own specialized translation classes. Here +are the methods of NullTranslations:

    +
    +
    +class gettext.NullTranslations(fp=None)
    +

    Takes an optional file object fp, which is ignored by the base class. +Initializes “protected” instance variables _info and _charset which are set +by derived classes, as well as _fallback, which is set through +add_fallback(). It then calls self._parse(fp) if fp is not +None.

    +
    +
    +_parse(fp)
    +

    No-op in the base class, this method takes file object fp, and reads +the data from the file, initializing its message catalog. If you have an +unsupported message catalog file format, you should override this method +to parse your format.

    +
    + +
    +
    +add_fallback(fallback)
    +

    Add fallback as the fallback object for the current translation object. +A translation object should consult the fallback if it cannot provide a +translation for a given message.

    +
    + +
    +
    +gettext(message)
    +

    If a fallback has been set, forward gettext() to the fallback. +Otherwise, return message. Overridden in derived classes.

    +
    + +
    +
    +ngettext(singular, plural, n)
    +

    If a fallback has been set, forward ngettext() to the fallback. +Otherwise, return singular if n is 1; return plural otherwise. +Overridden in derived classes.

    +
    + +
    +
    +lgettext(message)
    +
    + +
    +
    +lngettext(singular, plural, n)
    +

    Equivalent to gettext() and ngettext(), but the translation +is returned as a byte string encoded in the preferred system encoding +if no encoding was explicitly set with set_output_charset(). +Overridden in derived classes.

    +
    +

    Warning

    +

    These methods should be avoided in Python 3. See the warning for the +lgettext() function.

    +
    +
    + +
    +
    +info()
    +

    Return the “protected” _info variable, a dictionary containing +the metadata found in the message catalog file.

    +
    + +
    +
    +charset()
    +

    Return the encoding of the message catalog file.

    +
    + +
    +
    +output_charset()
    +

    Return the encoding used to return translated messages in lgettext() +and lngettext().

    +
    + +
    +
    +set_output_charset(charset)
    +

    Change the encoding used to return translated messages.

    +
    + +
    +
    +install(names=None)
    +

    This method installs gettext() into the built-in namespace, +binding it to _.

    +

    If the names parameter is given, it must be a sequence containing the +names of functions you want to install in the builtins namespace in +addition to _(). Supported names are 'gettext', 'ngettext', +'lgettext' and 'lngettext'.

    +

    Note that this is only one way, albeit the most convenient way, to make +the _() function available to your application. Because it affects +the entire application globally, and specifically the built-in namespace, +localized modules should never install _(). Instead, they should use +this code to make _() available to their module:

    +
    import gettext
    +t = gettext.translation('mymodule', ...)
    +_ = t.gettext
    +
    +
    +

    This puts _() only in the module’s global namespace and so only +affects calls within this module.

    +
    + +
    + +
    +
    +

    The GNUTranslations class

    +

    The gettext module provides one additional class derived from +NullTranslations: GNUTranslations. This class overrides +_parse() to enable reading GNU gettext format .mo files +in both big-endian and little-endian format.

    +

    GNUTranslations parses optional metadata out of the translation +catalog. It is convention with GNU gettext to include metadata as +the translation for the empty string. This metadata is in RFC 822-style +key: value pairs, and should contain the Project-Id-Version key. If the +key Content-Type is found, then the charset property is used to +initialize the “protected” _charset instance variable, defaulting to +None if not found. If the charset encoding is specified, then all message +ids and message strings read from the catalog are converted to Unicode using +this encoding, else ASCII is assumed.

    +

    Since message ids are read as Unicode strings too, all *gettext() methods +will assume message ids as Unicode strings, not byte strings.

    +

    The entire set of key/value pairs are placed into a dictionary and set as the +“protected” _info instance variable.

    +

    If the .mo file’s magic number is invalid, the major version number is +unexpected, or if other problems occur while reading the file, instantiating a +GNUTranslations class can raise OSError.

    +
    +
    +class gettext.GNUTranslations
    +

    The following methods are overridden from the base class implementation:

    +
    +
    +gettext(message)
    +

    Look up the message id in the catalog and return the corresponding message +string, as a Unicode string. If there is no entry in the catalog for the +message id, and a fallback has been set, the look up is forwarded to the +fallback’s gettext() method. Otherwise, the +message id is returned.

    +
    + +
    +
    +ngettext(singular, plural, n)
    +

    Do a plural-forms lookup of a message id. singular is used as the message id +for purposes of lookup in the catalog, while n is used to determine which +plural form to use. The returned message string is a Unicode string.

    +

    If the message id is not found in the catalog, and a fallback is specified, +the request is forwarded to the fallback’s ngettext() +method. Otherwise, when n is 1 singular is returned, and plural is +returned in all other cases.

    +

    Here is an example:

    +
    n = len(os.listdir('.'))
    +cat = GNUTranslations(somefile)
    +message = cat.ngettext(
    +    'There is %(num)d file in this directory',
    +    'There are %(num)d files in this directory',
    +    n) % {'num': n}
    +
    +
    +
    + +
    +
    +lgettext(message)
    +
    + +
    +
    +lngettext(singular, plural, n)
    +

    Equivalent to gettext() and ngettext(), but the translation +is returned as a byte string encoded in the preferred system encoding +if no encoding was explicitly set with +set_output_charset().

    +
    +

    Warning

    +

    These methods should be avoided in Python 3. See the warning for the +lgettext() function.

    +
    +
    + +
    + +
    +
    +

    Solaris message catalog support

    +

    The Solaris operating system defines its own binary .mo file format, but +since no documentation can be found on this format, it is not supported at this +time.

    +
    +
    +

    The Catalog constructor

    +

    GNOME uses a version of the gettext module by James Henstridge, but this +version has a slightly different API. Its documented usage was:

    +
    import gettext
    +cat = gettext.Catalog(domain, localedir)
    +_ = cat.gettext
    +print(_('hello world'))
    +
    +
    +

    For compatibility with this older module, the function Catalog() is an +alias for the translation() function described above.

    +

    One difference between this module and Henstridge’s: his catalog objects +supported access through a mapping API, but this appears to be unused and so is +not currently supported.

    +
    +
    +
    +

    Internationalizing your programs and modules

    +

    Internationalization (I18N) refers to the operation by which a program is made +aware of multiple languages. Localization (L10N) refers to the adaptation of +your program, once internationalized, to the local language and cultural habits. +In order to provide multilingual messages for your Python programs, you need to +take the following steps:

    +
      +
    1. prepare your program or module by specially marking translatable strings

    2. +
    3. run a suite of tools over your marked files to generate raw messages catalogs

    4. +
    5. create language-specific translations of the message catalogs

    6. +
    7. use the gettext module so that message strings are properly translated

    8. +
    +

    In order to prepare your code for I18N, you need to look at all the strings in +your files. Any string that needs to be translated should be marked by wrapping +it in _('...') — that is, a call to the function _(). For example:

    +
    filename = 'mylog.txt'
    +message = _('writing a log message')
    +with open(filename, 'w') as fp:
    +    fp.write(message)
    +
    +
    +

    In this example, the string 'writing a log message' is marked as a candidate +for translation, while the strings 'mylog.txt' and 'w' are not.

    +

    There are a few tools to extract the strings meant for translation. +The original GNU gettext only supported C or C++ source +code but its extended version xgettext scans code written +in a number of languages, including Python, to find strings marked as +translatable. Babel is a Python +internationalization library that includes a pybabel script to +extract and compile message catalogs. François Pinard’s program +called xpot does a similar job and is available as part of +his po-utils package.

    +

    (Python also includes pure-Python versions of these programs, called +pygettext.py and msgfmt.py; some Python distributions +will install them for you. pygettext.py is similar to +xgettext, but only understands Python source code and +cannot handle other programming languages such as C or C++. +pygettext.py supports a command-line interface similar to +xgettext; for details on its use, run pygettext.py +--help. msgfmt.py is binary compatible with GNU +msgfmt. With these two programs, you may not need the GNU +gettext package to internationalize your Python +applications.)

    +

    xgettext, pygettext, and similar tools generate +.po files that are message catalogs. They are structured +human-readable files that contain every marked string in the source +code, along with a placeholder for the translated versions of these +strings.

    +

    Copies of these .po files are then handed over to the +individual human translators who write translations for every +supported natural language. They send back the completed +language-specific versions as a <language-name>.po file that’s +compiled into a machine-readable .mo binary catalog file using +the msgfmt program. The .mo files are used by the +gettext module for the actual translation processing at +run-time.

    +

    How you use the gettext module in your code depends on whether you are +internationalizing a single module or your entire application. The next two +sections will discuss each case.

    +
    +

    Localizing your module

    +

    If you are localizing your module, you must take care not to make global +changes, e.g. to the built-in namespace. You should not use the GNU gettext +API but instead the class-based API.

    +

    Let’s say your module is called “spam” and the module’s various natural language +translation .mo files reside in /usr/share/locale in GNU +gettext format. Here’s what you would put at the top of your +module:

    +
    import gettext
    +t = gettext.translation('spam', '/usr/share/locale')
    +_ = t.gettext
    +
    +
    +
    +
    +

    Localizing your application

    +

    If you are localizing your application, you can install the _() function +globally into the built-in namespace, usually in the main driver file of your +application. This will let all your application-specific files just use +_('...') without having to explicitly install it in each file.

    +

    In the simple case then, you need only add the following bit of code to the main +driver file of your application:

    +
    import gettext
    +gettext.install('myapplication')
    +
    +
    +

    If you need to set the locale directory, you can pass it into the +install() function:

    +
    import gettext
    +gettext.install('myapplication', '/usr/share/locale')
    +
    +
    +
    +
    +

    Changing languages on the fly

    +

    If your program needs to support many languages at the same time, you may want +to create multiple translation instances and then switch between them +explicitly, like so:

    +
    import gettext
    +
    +lang1 = gettext.translation('myapplication', languages=['en'])
    +lang2 = gettext.translation('myapplication', languages=['fr'])
    +lang3 = gettext.translation('myapplication', languages=['de'])
    +
    +# start by using language1
    +lang1.install()
    +
    +# ... time goes by, user selects language 2
    +lang2.install()
    +
    +# ... more time goes by, user selects language 3
    +lang3.install()
    +
    +
    +
    +
    +

    Deferred translations

    +

    In most coding situations, strings are translated where they are coded. +Occasionally however, you need to mark strings for translation, but defer actual +translation until later. A classic example is:

    +
    animals = ['mollusk',
    +           'albatross',
    +           'rat',
    +           'penguin',
    +           'python', ]
    +# ...
    +for a in animals:
    +    print(a)
    +
    +
    +

    Here, you want to mark the strings in the animals list as being +translatable, but you don’t actually want to translate them until they are +printed.

    +

    Here is one way you can handle this situation:

    +
    def _(message): return message
    +
    +animals = [_('mollusk'),
    +           _('albatross'),
    +           _('rat'),
    +           _('penguin'),
    +           _('python'), ]
    +
    +del _
    +
    +# ...
    +for a in animals:
    +    print(_(a))
    +
    +
    +

    This works because the dummy definition of _() simply returns the string +unchanged. And this dummy definition will temporarily override any definition +of _() in the built-in namespace (until the del command). Take +care, though if you have a previous definition of _() in the local +namespace.

    +

    Note that the second use of _() will not identify “a” as being +translatable to the gettext program, because the parameter +is not a string literal.

    +

    Another way to handle this is with the following example:

    +
    def N_(message): return message
    +
    +animals = [N_('mollusk'),
    +           N_('albatross'),
    +           N_('rat'),
    +           N_('penguin'),
    +           N_('python'), ]
    +
    +# ...
    +for a in animals:
    +    print(_(a))
    +
    +
    +

    In this case, you are marking translatable strings with the function +N_(), which won’t conflict with any definition of _(). +However, you will need to teach your message extraction program to +look for translatable strings marked with N_(). xgettext, +pygettext, pybabel extract, and xpot all +support this through the use of the -k command-line switch. +The choice of N_() here is totally arbitrary; it could have just +as easily been MarkThisStringForTranslation().

    +
    +
    +
    +

    Acknowledgements

    +

    The following people contributed code, feedback, design suggestions, previous +implementations, and valuable experience to the creation of this module:

    +
      +
    • Peter Funk

    • +
    • James Henstridge

    • +
    • Juan David Ibáñez Palomar

    • +
    • Marc-André Lemburg

    • +
    • Martin von Löwis

    • +
    • François Pinard

    • +
    • Barry Warsaw

    • +
    • Gustavo Niemeyer

    • +
    +

    Footnotes

    +
    +
    1
    +

    The default locale directory is system dependent; for example, on RedHat Linux +it is /usr/share/locale, but on Solaris it is /usr/lib/locale. +The gettext module does not try to support these system dependent +defaults; instead its default is sys.prefix/share/locale (see +sys.prefix). For this reason, it is always best to call +bindtextdomain() with an explicit absolute path at the start of your +application.

    +
    +
    2
    +

    See the footnote for bindtextdomain() above.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/glob.html b/python-3.7.4-docs-html/library/glob.html new file mode 100644 index 0000000..f1f36ea --- /dev/null +++ b/python-3.7.4-docs-html/library/glob.html @@ -0,0 +1,276 @@ + + + + + + + glob — Unix style pathname pattern expansion — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    glob — Unix style pathname pattern expansion

    +

    Source code: Lib/glob.py

    +
    +

    The glob module finds all the pathnames matching a specified pattern +according to the rules used by the Unix shell, although results are returned in +arbitrary order. No tilde expansion is done, but *, ?, and character +ranges expressed with [] will be correctly matched. This is done by using +the os.scandir() and fnmatch.fnmatch() functions in concert, and +not by actually invoking a subshell. Note that unlike fnmatch.fnmatch(), +glob treats filenames beginning with a dot (.) as special cases. +(For tilde and shell variable expansion, use os.path.expanduser() and +os.path.expandvars().)

    +

    For a literal match, wrap the meta-characters in brackets. +For example, '[?]' matches the character '?'.

    +
    +

    See also

    +

    The pathlib module offers high-level path objects.

    +
    +
    +
    +glob.glob(pathname, *, recursive=False)
    +

    Return a possibly-empty list of path names that match pathname, which must be +a string containing a path specification. pathname can be either absolute +(like /usr/src/Python-1.5/Makefile) or relative (like +../../Tools/*/*.gif), and can contain shell-style wildcards. Broken +symlinks are included in the results (as in the shell).

    +

    If recursive is true, the pattern “**” will match any files and zero or +more directories and subdirectories. If the pattern is followed by an +os.sep, only directories and subdirectories match.

    +
    +

    Note

    +

    Using the “**” pattern in large directory trees may consume +an inordinate amount of time.

    +
    +
    +

    Changed in version 3.5: Support for recursive globs using “**”.

    +
    +
    + +
    +
    +glob.iglob(pathname, *, recursive=False)
    +

    Return an iterator which yields the same values as glob() +without actually storing them all simultaneously.

    +
    + +
    +
    +glob.escape(pathname)
    +

    Escape all special characters ('?', '*' and '['). +This is useful if you want to match an arbitrary literal string that may +have special characters in it. Special characters in drive/UNC +sharepoints are not escaped, e.g. on Windows +escape('//?/c:/Quo vadis?.txt') returns '//?/c:/Quo vadis[?].txt'.

    +
    +

    New in version 3.4.

    +
    +
    + +

    For example, consider a directory containing the following files: +1.gif, 2.txt, card.gif and a subdirectory sub +which contains only the file 3.txt. glob() will produce +the following results. Notice how any leading components of the path are +preserved.

    +
    >>> import glob
    +>>> glob.glob('./[0-9].*')
    +['./1.gif', './2.txt']
    +>>> glob.glob('*.gif')
    +['1.gif', 'card.gif']
    +>>> glob.glob('?.gif')
    +['1.gif']
    +>>> glob.glob('**/*.txt', recursive=True)
    +['2.txt', 'sub/3.txt']
    +>>> glob.glob('./**/', recursive=True)
    +['./', './sub/']
    +
    +
    +

    If the directory contains files starting with . they won’t be matched by +default. For example, consider a directory containing card.gif and +.card.gif:

    +
    >>> import glob
    +>>> glob.glob('*.gif')
    +['card.gif']
    +>>> glob.glob('.c*')
    +['.card.gif']
    +
    +
    +
    +

    See also

    +
    +
    Module fnmatch

    Shell-style filename (not path) expansion

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/grp.html b/python-3.7.4-docs-html/library/grp.html new file mode 100644 index 0000000..5965813 --- /dev/null +++ b/python-3.7.4-docs-html/library/grp.html @@ -0,0 +1,262 @@ + + + + + + + grp — The group database — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    grp — The group database

    +
    +

    This module provides access to the Unix group database. It is available on all +Unix versions.

    +

    Group database entries are reported as a tuple-like object, whose attributes +correspond to the members of the group structure (Attribute field below, see +<pwd.h>):

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + +

    Index

    Attribute

    Meaning

    0

    gr_name

    the name of the group

    1

    gr_passwd

    the (encrypted) group password; +often empty

    2

    gr_gid

    the numerical group ID

    3

    gr_mem

    all the group member’s user +names

    +

    The gid is an integer, name and password are strings, and the member list is a +list of strings. (Note that most users are not explicitly listed as members of +the group they are in according to the password database. Check both databases +to get complete membership information. Also note that a gr_name that +starts with a + or - is likely to be a YP/NIS reference and may not be +accessible via getgrnam() or getgrgid().)

    +

    It defines the following items:

    +
    +
    +grp.getgrgid(gid)
    +

    Return the group database entry for the given numeric group ID. KeyError +is raised if the entry asked for cannot be found.

    +
    +

    Deprecated since version 3.6: Since Python 3.6 the support of non-integer arguments like floats or +strings in getgrgid() is deprecated.

    +
    +
    + +
    +
    +grp.getgrnam(name)
    +

    Return the group database entry for the given group name. KeyError is +raised if the entry asked for cannot be found.

    +
    + +
    +
    +grp.getgrall()
    +

    Return a list of all available group entries, in arbitrary order.

    +
    + +
    +

    See also

    +
    +
    Module pwd

    An interface to the user database, similar to this.

    +
    +
    Module spwd

    An interface to the shadow password database, similar to this.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/gzip.html b/python-3.7.4-docs-html/library/gzip.html new file mode 100644 index 0000000..dc72b73 --- /dev/null +++ b/python-3.7.4-docs-html/library/gzip.html @@ -0,0 +1,390 @@ + + + + + + + gzip — Support for gzip files — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    gzip — Support for gzip files

    +

    Source code: Lib/gzip.py

    +
    +

    This module provides a simple interface to compress and decompress files just +like the GNU programs gzip and gunzip would.

    +

    The data compression is provided by the zlib module.

    +

    The gzip module provides the GzipFile class, as well as the +open(), compress() and decompress() convenience functions. +The GzipFile class reads and writes gzip-format files, +automatically compressing or decompressing the data so that it looks like an +ordinary file object.

    +

    Note that additional file formats which can be decompressed by the +gzip and gunzip programs, such as those produced by +compress and pack, are not supported by this module.

    +

    The module defines the following items:

    +
    +
    +gzip.open(filename, mode='rb', compresslevel=9, encoding=None, errors=None, newline=None)
    +

    Open a gzip-compressed file in binary or text mode, returning a file +object.

    +

    The filename argument can be an actual filename (a str or +bytes object), or an existing file object to read from or write to.

    +

    The mode argument can be any of 'r', 'rb', 'a', 'ab', +'w', 'wb', 'x' or 'xb' for binary mode, or 'rt', +'at', 'wt', or 'xt' for text mode. The default is 'rb'.

    +

    The compresslevel argument is an integer from 0 to 9, as for the +GzipFile constructor.

    +

    For binary mode, this function is equivalent to the GzipFile +constructor: GzipFile(filename, mode, compresslevel). In this case, the +encoding, errors and newline arguments must not be provided.

    +

    For text mode, a GzipFile object is created, and wrapped in an +io.TextIOWrapper instance with the specified encoding, error +handling behavior, and line ending(s).

    +
    +

    Changed in version 3.3: Added support for filename being a file object, support for text mode, +and the encoding, errors and newline arguments.

    +
    +
    +

    Changed in version 3.4: Added support for the 'x', 'xb' and 'xt' modes.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +class gzip.GzipFile(filename=None, mode=None, compresslevel=9, fileobj=None, mtime=None)
    +

    Constructor for the GzipFile class, which simulates most of the +methods of a file object, with the exception of the truncate() +method. At least one of fileobj and filename must be given a non-trivial +value.

    +

    The new class instance is based on fileobj, which can be a regular file, an +io.BytesIO object, or any other object which simulates a file. It +defaults to None, in which case filename is opened to provide a file +object.

    +

    When fileobj is not None, the filename argument is only used to be +included in the gzip file header, which may include the original +filename of the uncompressed file. It defaults to the filename of fileobj, if +discernible; otherwise, it defaults to the empty string, and in this case the +original filename is not included in the header.

    +

    The mode argument can be any of 'r', 'rb', 'a', 'ab', 'w', +'wb', 'x', or 'xb', depending on whether the file will be read or +written. The default is the mode of fileobj if discernible; otherwise, the +default is 'rb'.

    +

    Note that the file is always opened in binary mode. To open a compressed file +in text mode, use open() (or wrap your GzipFile with an +io.TextIOWrapper).

    +

    The compresslevel argument is an integer from 0 to 9 controlling +the level of compression; 1 is fastest and produces the least +compression, and 9 is slowest and produces the most compression. 0 +is no compression. The default is 9.

    +

    The mtime argument is an optional numeric timestamp to be written to +the last modification time field in the stream when compressing. It +should only be provided in compression mode. If omitted or None, the +current time is used. See the mtime attribute for more details.

    +

    Calling a GzipFile object’s close() method does not close +fileobj, since you might wish to append more material after the compressed +data. This also allows you to pass an io.BytesIO object opened for +writing as fileobj, and retrieve the resulting memory buffer using the +io.BytesIO object’s getvalue() method.

    +

    GzipFile supports the io.BufferedIOBase interface, +including iteration and the with statement. Only the +truncate() method isn’t implemented.

    +

    GzipFile also provides the following method and attribute:

    +
    +
    +peek(n)
    +

    Read n uncompressed bytes without advancing the file position. +At most one single read on the compressed stream is done to satisfy +the call. The number of bytes returned may be more or less than +requested.

    +
    +

    Note

    +

    While calling peek() does not change the file position of +the GzipFile, it may change the position of the underlying +file object (e.g. if the GzipFile was constructed with the +fileobj parameter).

    +
    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +mtime
    +

    When decompressing, the value of the last modification time field in +the most recently read header may be read from this attribute, as an +integer. The initial value before reading any headers is None.

    +

    All gzip compressed streams are required to contain this +timestamp field. Some programs, such as gunzip, make use +of the timestamp. The format is the same as the return value of +time.time() and the st_mtime attribute of +the object returned by os.stat().

    +
    + +
    +

    Changed in version 3.1: Support for the with statement was added, along with the +mtime constructor argument and mtime attribute.

    +
    +
    +

    Changed in version 3.2: Support for zero-padded and unseekable files was added.

    +
    +
    +

    Changed in version 3.3: The io.BufferedIOBase.read1() method is now implemented.

    +
    +
    +

    Changed in version 3.4: Added support for the 'x' and 'xb' modes.

    +
    +
    +

    Changed in version 3.5: Added support for writing arbitrary +bytes-like objects. +The read() method now accepts an argument of +None.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +gzip.compress(data, compresslevel=9)
    +

    Compress the data, returning a bytes object containing +the compressed data. compresslevel has the same meaning as in +the GzipFile constructor above.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +gzip.decompress(data)
    +

    Decompress the data, returning a bytes object containing the +uncompressed data.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +

    Examples of usage

    +

    Example of how to read a compressed file:

    +
    import gzip
    +with gzip.open('/home/joe/file.txt.gz', 'rb') as f:
    +    file_content = f.read()
    +
    +
    +

    Example of how to create a compressed GZIP file:

    +
    import gzip
    +content = b"Lots of content here"
    +with gzip.open('/home/joe/file.txt.gz', 'wb') as f:
    +    f.write(content)
    +
    +
    +

    Example of how to GZIP compress an existing file:

    +
    import gzip
    +import shutil
    +with open('/home/joe/file.txt', 'rb') as f_in:
    +    with gzip.open('/home/joe/file.txt.gz', 'wb') as f_out:
    +        shutil.copyfileobj(f_in, f_out)
    +
    +
    +

    Example of how to GZIP compress a binary string:

    +
    import gzip
    +s_in = b"Lots of content here"
    +s_out = gzip.compress(s_in)
    +
    +
    +
    +

    See also

    +
    +
    Module zlib

    The basic data compression module needed to support the gzip file +format.

    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/hashlib.html b/python-3.7.4-docs-html/library/hashlib.html new file mode 100644 index 0000000..a14564c --- /dev/null +++ b/python-3.7.4-docs-html/library/hashlib.html @@ -0,0 +1,919 @@ + + + + + + + hashlib — Secure hashes and message digests — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    hashlib — Secure hashes and message digests

    +

    Source code: Lib/hashlib.py

    +
    +

    This module implements a common interface to many different secure hash and +message digest algorithms. Included are the FIPS secure hash algorithms SHA1, +SHA224, SHA256, SHA384, and SHA512 (defined in FIPS 180-2) as well as RSA’s MD5 +algorithm (defined in Internet RFC 1321). The terms “secure hash” and +“message digest” are interchangeable. Older algorithms were called message +digests. The modern term is secure hash.

    +
    +

    Note

    +

    If you want the adler32 or crc32 hash functions, they are available in +the zlib module.

    +
    +
    +

    Warning

    +

    Some algorithms have known hash collision weaknesses, refer to the “See +also” section at the end.

    +
    +
    +

    Hash algorithms

    +

    There is one constructor method named for each type of hash. All return +a hash object with the same simple interface. For example: use sha256() to +create a SHA-256 hash object. You can now feed this object with bytes-like +objects (normally bytes) using the update() method. +At any point you can ask it for the digest of the +concatenation of the data fed to it so far using the digest() or +hexdigest() methods.

    +
    +

    Note

    +

    For better multithreading performance, the Python GIL is released for +data larger than 2047 bytes at object creation or on update.

    +
    +
    +

    Note

    +

    Feeding string objects into update() is not supported, as hashes work +on bytes, not on characters.

    +
    +

    Constructors for hash algorithms that are always present in this module are +sha1(), sha224(), sha256(), sha384(), +sha512(), blake2b(), and blake2s(). +md5() is normally available as well, though it +may be missing if you are using a rare “FIPS compliant” build of Python. +Additional algorithms may also be available depending upon the OpenSSL +library that Python uses on your platform. On most platforms the +sha3_224(), sha3_256(), sha3_384(), sha3_512(), +shake_128(), shake_256() are also available.

    +
    +

    New in version 3.6: SHA3 (Keccak) and SHAKE constructors sha3_224(), sha3_256(), +sha3_384(), sha3_512(), shake_128(), shake_256().

    +
    +
    +

    New in version 3.6: blake2b() and blake2s() were added.

    +
    +

    For example, to obtain the digest of the byte string b'Nobody inspects the +spammish repetition':

    +
    >>> import hashlib
    +>>> m = hashlib.sha256()
    +>>> m.update(b"Nobody inspects")
    +>>> m.update(b" the spammish repetition")
    +>>> m.digest()
    +b'\x03\x1e\xdd}Ae\x15\x93\xc5\xfe\\\x00o\xa5u+7\xfd\xdf\xf7\xbcN\x84:\xa6\xaf\x0c\x95\x0fK\x94\x06'
    +>>> m.digest_size
    +32
    +>>> m.block_size
    +64
    +
    +
    +

    More condensed:

    +
    >>> hashlib.sha224(b"Nobody inspects the spammish repetition").hexdigest()
    +'a4337bc45a8fc544c03f52dc550cd6e1e87021bc896588bd79e901e2'
    +
    +
    +
    +
    +hashlib.new(name[, data])
    +

    Is a generic constructor that takes the string name of the desired +algorithm as its first parameter. It also exists to allow access to the +above listed hashes as well as any other algorithms that your OpenSSL +library may offer. The named constructors are much faster than new() +and should be preferred.

    +
    + +

    Using new() with an algorithm provided by OpenSSL:

    +
    >>> h = hashlib.new('ripemd160')
    +>>> h.update(b"Nobody inspects the spammish repetition")
    +>>> h.hexdigest()
    +'cc4a5ce1b3df48aec5d22d1f16b894a0b894eccc'
    +
    +
    +

    Hashlib provides the following constant attributes:

    +
    +
    +hashlib.algorithms_guaranteed
    +

    A set containing the names of the hash algorithms guaranteed to be supported +by this module on all platforms. Note that ‘md5’ is in this list despite +some upstream vendors offering an odd “FIPS compliant” Python build that +excludes it.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +hashlib.algorithms_available
    +

    A set containing the names of the hash algorithms that are available in the +running Python interpreter. These names will be recognized when passed to +new(). algorithms_guaranteed will always be a subset. The +same algorithm may appear multiple times in this set under different names +(thanks to OpenSSL).

    +
    +

    New in version 3.2.

    +
    +
    + +

    The following values are provided as constant attributes of the hash objects +returned by the constructors:

    +
    +
    +hash.digest_size
    +

    The size of the resulting hash in bytes.

    +
    + +
    +
    +hash.block_size
    +

    The internal block size of the hash algorithm in bytes.

    +
    + +

    A hash object has the following attributes:

    +
    +
    +hash.name
    +

    The canonical name of this hash, always lowercase and always suitable as a +parameter to new() to create another hash of this type.

    +
    +

    Changed in version 3.4: The name attribute has been present in CPython since its inception, but +until Python 3.4 was not formally specified, so may not exist on some +platforms.

    +
    +
    + +

    A hash object has the following methods:

    +
    +
    +hash.update(data)
    +

    Update the hash object with the bytes-like object. +Repeated calls are equivalent to a single call with the +concatenation of all the arguments: m.update(a); m.update(b) is +equivalent to m.update(a+b).

    +
    +

    Changed in version 3.1: The Python GIL is released to allow other threads to run while hash +updates on data larger than 2047 bytes is taking place when using hash +algorithms supplied by OpenSSL.

    +
    +
    + +
    +
    +hash.digest()
    +

    Return the digest of the data passed to the update() method so far. +This is a bytes object of size digest_size which may contain bytes in +the whole range from 0 to 255.

    +
    + +
    +
    +hash.hexdigest()
    +

    Like digest() except the digest is returned as a string object of +double length, containing only hexadecimal digits. This may be used to +exchange the value safely in email or other non-binary environments.

    +
    + +
    +
    +hash.copy()
    +

    Return a copy (“clone”) of the hash object. This can be used to efficiently +compute the digests of data sharing a common initial substring.

    +
    + +
    +
    +

    SHAKE variable length digests

    +

    The shake_128() and shake_256() algorithms provide variable +length digests with length_in_bits//2 up to 128 or 256 bits of security. +As such, their digest methods require a length. Maximum length is not limited +by the SHAKE algorithm.

    +
    +
    +shake.digest(length)
    +

    Return the digest of the data passed to the update() method so far. +This is a bytes object of size length which may contain bytes in +the whole range from 0 to 255.

    +
    + +
    +
    +shake.hexdigest(length)
    +

    Like digest() except the digest is returned as a string object of +double length, containing only hexadecimal digits. This may be used to +exchange the value safely in email or other non-binary environments.

    +
    + +
    +
    +

    Key derivation

    +

    Key derivation and key stretching algorithms are designed for secure password +hashing. Naive algorithms such as sha1(password) are not resistant against +brute-force attacks. A good password hashing function must be tunable, slow, and +include a salt.

    +
    +
    +hashlib.pbkdf2_hmac(hash_name, password, salt, iterations, dklen=None)
    +

    The function provides PKCS#5 password-based key derivation function 2. It +uses HMAC as pseudorandom function.

    +

    The string hash_name is the desired name of the hash digest algorithm for +HMAC, e.g. ‘sha1’ or ‘sha256’. password and salt are interpreted as +buffers of bytes. Applications and libraries should limit password to +a sensible length (e.g. 1024). salt should be about 16 or more bytes from +a proper source, e.g. os.urandom().

    +

    The number of iterations should be chosen based on the hash algorithm and +computing power. As of 2013, at least 100,000 iterations of SHA-256 are +suggested.

    +

    dklen is the length of the derived key. If dklen is None then the +digest size of the hash algorithm hash_name is used, e.g. 64 for SHA-512.

    +
    >>> import hashlib, binascii
    +>>> dk = hashlib.pbkdf2_hmac('sha256', b'password', b'salt', 100000)
    +>>> binascii.hexlify(dk)
    +b'0394a2ede332c9a13eb82e9b24631604c31df978b4e2f0fbd2c549944f9d79a5'
    +
    +
    +
    +

    New in version 3.4.

    +
    +
    +

    Note

    +

    A fast implementation of pbkdf2_hmac is available with OpenSSL. The +Python implementation uses an inline version of hmac. It is about +three times slower and doesn’t release the GIL.

    +
    +
    + +
    +
    +hashlib.scrypt(password, *, salt, n, r, p, maxmem=0, dklen=64)
    +

    The function provides scrypt password-based key derivation function as +defined in RFC 7914.

    +

    password and salt must be bytes-like objects. Applications and libraries should limit password +to a sensible length (e.g. 1024). salt should be about 16 or more +bytes from a proper source, e.g. os.urandom().

    +

    n is the CPU/Memory cost factor, r the block size, p parallelization +factor and maxmem limits memory (OpenSSL 1.1.0 defaults to 32 MiB). +dklen is the length of the derived key.

    +

    Availability: OpenSSL 1.1+.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +

    BLAKE2

    +

    BLAKE2 is a cryptographic hash function defined in RFC 7693 that comes in two +flavors:

    +
      +
    • BLAKE2b, optimized for 64-bit platforms and produces digests of any size +between 1 and 64 bytes,

    • +
    • BLAKE2s, optimized for 8- to 32-bit platforms and produces digests of any +size between 1 and 32 bytes.

    • +
    +

    BLAKE2 supports keyed mode (a faster and simpler replacement for HMAC), +salted hashing, personalization, and tree hashing.

    +

    Hash objects from this module follow the API of standard library’s +hashlib objects.

    +
    +

    Creating hash objects

    +

    New hash objects are created by calling constructor functions:

    +
    +
    +hashlib.blake2b(data=b'', *, digest_size=64, key=b'', salt=b'', person=b'', fanout=1, depth=1, leaf_size=0, node_offset=0, node_depth=0, inner_size=0, last_node=False)
    +
    + +
    +
    +hashlib.blake2s(data=b'', *, digest_size=32, key=b'', salt=b'', person=b'', fanout=1, depth=1, leaf_size=0, node_offset=0, node_depth=0, inner_size=0, last_node=False)
    +
    + +

    These functions return the corresponding hash objects for calculating +BLAKE2b or BLAKE2s. They optionally take these general parameters:

    +
      +
    • data: initial chunk of data to hash, which must be +bytes-like object. It can be passed only as positional argument.

    • +
    • digest_size: size of output digest in bytes.

    • +
    • key: key for keyed hashing (up to 64 bytes for BLAKE2b, up to 32 bytes for +BLAKE2s).

    • +
    • salt: salt for randomized hashing (up to 16 bytes for BLAKE2b, up to 8 +bytes for BLAKE2s).

    • +
    • person: personalization string (up to 16 bytes for BLAKE2b, up to 8 bytes +for BLAKE2s).

    • +
    +

    The following table shows limits for general parameters (in bytes):

    + +++++++ + + + + + + + + + + + + + + + + + + + + + + +

    Hash

    digest_size

    len(key)

    len(salt)

    len(person)

    BLAKE2b

    64

    64

    16

    16

    BLAKE2s

    32

    32

    8

    8

    +
    +

    Note

    +

    BLAKE2 specification defines constant lengths for salt and personalization +parameters, however, for convenience, this implementation accepts byte +strings of any size up to the specified length. If the length of the +parameter is less than specified, it is padded with zeros, thus, for +example, b'salt' and b'salt\x00' is the same value. (This is not +the case for key.)

    +
    +

    These sizes are available as module constants described below.

    +

    Constructor functions also accept the following tree hashing parameters:

    +
      +
    • fanout: fanout (0 to 255, 0 if unlimited, 1 in sequential mode).

    • +
    • depth: maximal depth of tree (1 to 255, 255 if unlimited, 1 in +sequential mode).

    • +
    • leaf_size: maximal byte length of leaf (0 to 2**32-1, 0 if unlimited or in +sequential mode).

    • +
    • node_offset: node offset (0 to 2**64-1 for BLAKE2b, 0 to 2**48-1 for +BLAKE2s, 0 for the first, leftmost, leaf, or in sequential mode).

    • +
    • node_depth: node depth (0 to 255, 0 for leaves, or in sequential mode).

    • +
    • inner_size: inner digest size (0 to 64 for BLAKE2b, 0 to 32 for +BLAKE2s, 0 in sequential mode).

    • +
    • last_node: boolean indicating whether the processed node is the last +one (False for sequential mode).

    • +
    +
    +Explanation of tree mode parameters. +
    +

    See section 2.10 in BLAKE2 specification for comprehensive review of tree +hashing.

    +
    +
    +

    Constants

    +
    +
    +blake2b.SALT_SIZE
    +
    + +
    +
    +blake2s.SALT_SIZE
    +
    + +

    Salt length (maximum length accepted by constructors).

    +
    +
    +blake2b.PERSON_SIZE
    +
    + +
    +
    +blake2s.PERSON_SIZE
    +
    + +

    Personalization string length (maximum length accepted by constructors).

    +
    +
    +blake2b.MAX_KEY_SIZE
    +
    + +
    +
    +blake2s.MAX_KEY_SIZE
    +
    + +

    Maximum key size.

    +
    +
    +blake2b.MAX_DIGEST_SIZE
    +
    + +
    +
    +blake2s.MAX_DIGEST_SIZE
    +
    + +

    Maximum digest size that the hash function can output.

    +
    +
    +

    Examples

    +
    +

    Simple hashing

    +

    To calculate hash of some data, you should first construct a hash object by +calling the appropriate constructor function (blake2b() or +blake2s()), then update it with the data by calling update() on the +object, and, finally, get the digest out of the object by calling +digest() (or hexdigest() for hex-encoded string).

    +
    >>> from hashlib import blake2b
    +>>> h = blake2b()
    +>>> h.update(b'Hello world')
    +>>> h.hexdigest()
    +'6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183'
    +
    +
    +

    As a shortcut, you can pass the first chunk of data to update directly to the +constructor as the positional argument:

    +
    >>> from hashlib import blake2b
    +>>> blake2b(b'Hello world').hexdigest()
    +'6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183'
    +
    +
    +

    You can call hash.update() as many times as you need to iteratively +update the hash:

    +
    >>> from hashlib import blake2b
    +>>> items = [b'Hello', b' ', b'world']
    +>>> h = blake2b()
    +>>> for item in items:
    +...     h.update(item)
    +>>> h.hexdigest()
    +'6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183'
    +
    +
    +
    +
    +

    Using different digest sizes

    +

    BLAKE2 has configurable size of digests up to 64 bytes for BLAKE2b and up to 32 +bytes for BLAKE2s. For example, to replace SHA-1 with BLAKE2b without changing +the size of output, we can tell BLAKE2b to produce 20-byte digests:

    +
    >>> from hashlib import blake2b
    +>>> h = blake2b(digest_size=20)
    +>>> h.update(b'Replacing SHA1 with the more secure function')
    +>>> h.hexdigest()
    +'d24f26cf8de66472d58d4e1b1774b4c9158b1f4c'
    +>>> h.digest_size
    +20
    +>>> len(h.digest())
    +20
    +
    +
    +

    Hash objects with different digest sizes have completely different outputs +(shorter hashes are not prefixes of longer hashes); BLAKE2b and BLAKE2s +produce different outputs even if the output length is the same:

    +
    >>> from hashlib import blake2b, blake2s
    +>>> blake2b(digest_size=10).hexdigest()
    +'6fa1d8fcfd719046d762'
    +>>> blake2b(digest_size=11).hexdigest()
    +'eb6ec15daf9546254f0809'
    +>>> blake2s(digest_size=10).hexdigest()
    +'1bf21a98c78a1c376ae9'
    +>>> blake2s(digest_size=11).hexdigest()
    +'567004bf96e4a25773ebf4'
    +
    +
    +
    +
    +

    Keyed hashing

    +

    Keyed hashing can be used for authentication as a faster and simpler +replacement for Hash-based message authentication code (HMAC). +BLAKE2 can be securely used in prefix-MAC mode thanks to the +indifferentiability property inherited from BLAKE.

    +

    This example shows how to get a (hex-encoded) 128-bit authentication code for +message b'message data' with key b'pseudorandom key':

    +
    >>> from hashlib import blake2b
    +>>> h = blake2b(key=b'pseudorandom key', digest_size=16)
    +>>> h.update(b'message data')
    +>>> h.hexdigest()
    +'3d363ff7401e02026f4a4687d4863ced'
    +
    +
    +

    As a practical example, a web application can symmetrically sign cookies sent +to users and later verify them to make sure they weren’t tampered with:

    +
    >>> from hashlib import blake2b
    +>>> from hmac import compare_digest
    +>>>
    +>>> SECRET_KEY = b'pseudorandomly generated server secret key'
    +>>> AUTH_SIZE = 16
    +>>>
    +>>> def sign(cookie):
    +...     h = blake2b(digest_size=AUTH_SIZE, key=SECRET_KEY)
    +...     h.update(cookie)
    +...     return h.hexdigest().encode('utf-8')
    +>>>
    +>>> def verify(cookie, sig):
    +...     good_sig = sign(cookie)
    +...     return compare_digest(good_sig, sig)
    +>>>
    +>>> cookie = b'user-alice'
    +>>> sig = sign(cookie)
    +>>> print("{0},{1}".format(cookie.decode('utf-8'), sig))
    +user-alice,b'43b3c982cf697e0c5ab22172d1ca7421'
    +>>> verify(cookie, sig)
    +True
    +>>> verify(b'user-bob', sig)
    +False
    +>>> verify(cookie, b'0102030405060708090a0b0c0d0e0f00')
    +False
    +
    +
    +

    Even though there’s a native keyed hashing mode, BLAKE2 can, of course, be used +in HMAC construction with hmac module:

    +
    >>> import hmac, hashlib
    +>>> m = hmac.new(b'secret key', digestmod=hashlib.blake2s)
    +>>> m.update(b'message')
    +>>> m.hexdigest()
    +'e3c8102868d28b5ff85fc35dda07329970d1a01e273c37481326fe0c861c8142'
    +
    +
    +
    +
    +

    Randomized hashing

    +

    By setting salt parameter users can introduce randomization to the hash +function. Randomized hashing is useful for protecting against collision attacks +on the hash function used in digital signatures.

    +
    +

    Randomized hashing is designed for situations where one party, the message +preparer, generates all or part of a message to be signed by a second +party, the message signer. If the message preparer is able to find +cryptographic hash function collisions (i.e., two messages producing the +same hash value), then they might prepare meaningful versions of the message +that would produce the same hash value and digital signature, but with +different results (e.g., transferring $1,000,000 to an account, rather than +$10). Cryptographic hash functions have been designed with collision +resistance as a major goal, but the current concentration on attacking +cryptographic hash functions may result in a given cryptographic hash +function providing less collision resistance than expected. Randomized +hashing offers the signer additional protection by reducing the likelihood +that a preparer can generate two or more messages that ultimately yield the +same hash value during the digital signature generation process — even if +it is practical to find collisions for the hash function. However, the use +of randomized hashing may reduce the amount of security provided by a +digital signature when all portions of the message are prepared +by the signer.

    +

    (NIST SP-800-106 “Randomized Hashing for Digital Signatures”)

    +
    +

    In BLAKE2 the salt is processed as a one-time input to the hash function during +initialization, rather than as an input to each compression function.

    +
    +

    Warning

    +

    Salted hashing (or just hashing) with BLAKE2 or any other general-purpose +cryptographic hash function, such as SHA-256, is not suitable for hashing +passwords. See BLAKE2 FAQ for more +information.

    +
    +
    >>> import os
    +>>> from hashlib import blake2b
    +>>> msg = b'some message'
    +>>> # Calculate the first hash with a random salt.
    +>>> salt1 = os.urandom(blake2b.SALT_SIZE)
    +>>> h1 = blake2b(salt=salt1)
    +>>> h1.update(msg)
    +>>> # Calculate the second hash with a different random salt.
    +>>> salt2 = os.urandom(blake2b.SALT_SIZE)
    +>>> h2 = blake2b(salt=salt2)
    +>>> h2.update(msg)
    +>>> # The digests are different.
    +>>> h1.digest() != h2.digest()
    +True
    +
    +
    +
    +
    +

    Personalization

    +

    Sometimes it is useful to force hash function to produce different digests for +the same input for different purposes. Quoting the authors of the Skein hash +function:

    +
    +

    We recommend that all application designers seriously consider doing this; +we have seen many protocols where a hash that is computed in one part of +the protocol can be used in an entirely different part because two hash +computations were done on similar or related data, and the attacker can +force the application to make the hash inputs the same. Personalizing each +hash function used in the protocol summarily stops this type of attack.

    +

    (The Skein Hash Function Family, +p. 21)

    +
    +

    BLAKE2 can be personalized by passing bytes to the person argument:

    +
    >>> from hashlib import blake2b
    +>>> FILES_HASH_PERSON = b'MyApp Files Hash'
    +>>> BLOCK_HASH_PERSON = b'MyApp Block Hash'
    +>>> h = blake2b(digest_size=32, person=FILES_HASH_PERSON)
    +>>> h.update(b'the same content')
    +>>> h.hexdigest()
    +'20d9cd024d4fb086aae819a1432dd2466de12947831b75c5a30cf2676095d3b4'
    +>>> h = blake2b(digest_size=32, person=BLOCK_HASH_PERSON)
    +>>> h.update(b'the same content')
    +>>> h.hexdigest()
    +'cf68fb5761b9c44e7878bfb2c4c9aea52264a80b75005e65619778de59f383a3'
    +
    +
    +

    Personalization together with the keyed mode can also be used to derive different +keys from a single one.

    +
    >>> from hashlib import blake2s
    +>>> from base64 import b64decode, b64encode
    +>>> orig_key = b64decode(b'Rm5EPJai72qcK3RGBpW3vPNfZy5OZothY+kHY6h21KM=')
    +>>> enc_key = blake2s(key=orig_key, person=b'kEncrypt').digest()
    +>>> mac_key = blake2s(key=orig_key, person=b'kMAC').digest()
    +>>> print(b64encode(enc_key).decode('utf-8'))
    +rbPb15S/Z9t+agffno5wuhB77VbRi6F9Iv2qIxU7WHw=
    +>>> print(b64encode(mac_key).decode('utf-8'))
    +G9GtHFE1YluXY1zWPlYk1e/nWfu0WSEb0KRcjhDeP/o=
    +
    +
    +
    +
    +

    Tree mode

    +

    Here’s an example of hashing a minimal tree with two leaf nodes:

    +
      10
    + /  \
    +00  01
    +
    +
    +

    This example uses 64-byte internal digests, and returns the 32-byte final +digest:

    +
    >>> from hashlib import blake2b
    +>>>
    +>>> FANOUT = 2
    +>>> DEPTH = 2
    +>>> LEAF_SIZE = 4096
    +>>> INNER_SIZE = 64
    +>>>
    +>>> buf = bytearray(6000)
    +>>>
    +>>> # Left leaf
    +... h00 = blake2b(buf[0:LEAF_SIZE], fanout=FANOUT, depth=DEPTH,
    +...               leaf_size=LEAF_SIZE, inner_size=INNER_SIZE,
    +...               node_offset=0, node_depth=0, last_node=False)
    +>>> # Right leaf
    +... h01 = blake2b(buf[LEAF_SIZE:], fanout=FANOUT, depth=DEPTH,
    +...               leaf_size=LEAF_SIZE, inner_size=INNER_SIZE,
    +...               node_offset=1, node_depth=0, last_node=True)
    +>>> # Root node
    +... h10 = blake2b(digest_size=32, fanout=FANOUT, depth=DEPTH,
    +...               leaf_size=LEAF_SIZE, inner_size=INNER_SIZE,
    +...               node_offset=0, node_depth=1, last_node=True)
    +>>> h10.update(h00.digest())
    +>>> h10.update(h01.digest())
    +>>> h10.hexdigest()
    +'3ad2a9b37c6070e374c7a8c508fe20ca86b6ed54e286e93a0318e95e881db5aa'
    +
    +
    +
    +
    +
    +

    Credits

    +

    BLAKE2 was designed by Jean-Philippe Aumasson, Samuel Neves, Zooko +Wilcox-O’Hearn, and Christian Winnerlein based on SHA-3 finalist BLAKE +created by Jean-Philippe Aumasson, Luca Henzen, Willi Meier, and +Raphael C.-W. Phan.

    +

    It uses core algorithm from ChaCha cipher designed by Daniel J. Bernstein.

    +

    The stdlib implementation is based on pyblake2 module. It was written by +Dmitry Chestnykh based on C implementation written by Samuel Neves. The +documentation was copied from pyblake2 and written by Dmitry Chestnykh.

    +

    The C code was partly rewritten for Python by Christian Heimes.

    +

    The following public domain dedication applies for both C hash function +implementation, extension code, and this documentation:

    +
    +

    To the extent possible under law, the author(s) have dedicated all copyright +and related and neighboring rights to this software to the public domain +worldwide. This software is distributed without any warranty.

    +

    You should have received a copy of the CC0 Public Domain Dedication along +with this software. If not, see +https://creativecommons.org/publicdomain/zero/1.0/.

    +
    +

    The following people have helped with development or contributed their changes +to the project and the public domain according to the Creative Commons Public +Domain Dedication 1.0 Universal:

    +
      +
    • Alexandr Sokolovskiy

    • +
    +
    +

    See also

    +
    +
    Module hmac

    A module to generate message authentication codes using hashes.

    +
    +
    Module base64

    Another way to encode binary hashes for non-binary environments.

    +
    +
    https://blake2.net

    Official BLAKE2 website.

    +
    +
    https://csrc.nist.gov/csrc/media/publications/fips/180/2/archive/2002-08-01/documents/fips180-2.pdf

    The FIPS 180-2 publication on Secure Hash Algorithms.

    +
    +
    https://en.wikipedia.org/wiki/Cryptographic_hash_function#Cryptographic_hash_algorithms

    Wikipedia article with information on which algorithms have known issues and +what that means regarding their use.

    +
    +
    https://www.ietf.org/rfc/rfc2898.txt

    PKCS #5: Password-Based Cryptography Specification Version 2.0

    +
    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/heapq.html b/python-3.7.4-docs-html/library/heapq.html new file mode 100644 index 0000000..81687bc --- /dev/null +++ b/python-3.7.4-docs-html/library/heapq.html @@ -0,0 +1,479 @@ + + + + + + + heapq — Heap queue algorithm — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    heapq — Heap queue algorithm

    +

    Source code: Lib/heapq.py

    +
    +

    This module provides an implementation of the heap queue algorithm, also known +as the priority queue algorithm.

    +

    Heaps are binary trees for which every parent node has a value less than or +equal to any of its children. This implementation uses arrays for which +heap[k] <= heap[2*k+1] and heap[k] <= heap[2*k+2] for all k, counting +elements from zero. For the sake of comparison, non-existing elements are +considered to be infinite. The interesting property of a heap is that its +smallest element is always the root, heap[0].

    +

    The API below differs from textbook heap algorithms in two aspects: (a) We use +zero-based indexing. This makes the relationship between the index for a node +and the indexes for its children slightly less obvious, but is more suitable +since Python uses zero-based indexing. (b) Our pop method returns the smallest +item, not the largest (called a “min heap” in textbooks; a “max heap” is more +common in texts because of its suitability for in-place sorting).

    +

    These two make it possible to view the heap as a regular Python list without +surprises: heap[0] is the smallest item, and heap.sort() maintains the +heap invariant!

    +

    To create a heap, use a list initialized to [], or you can transform a +populated list into a heap via function heapify().

    +

    The following functions are provided:

    +
    +
    +heapq.heappush(heap, item)
    +

    Push the value item onto the heap, maintaining the heap invariant.

    +
    + +
    +
    +heapq.heappop(heap)
    +

    Pop and return the smallest item from the heap, maintaining the heap +invariant. If the heap is empty, IndexError is raised. To access the +smallest item without popping it, use heap[0].

    +
    + +
    +
    +heapq.heappushpop(heap, item)
    +

    Push item on the heap, then pop and return the smallest item from the +heap. The combined action runs more efficiently than heappush() +followed by a separate call to heappop().

    +
    + +
    +
    +heapq.heapify(x)
    +

    Transform list x into a heap, in-place, in linear time.

    +
    + +
    +
    +heapq.heapreplace(heap, item)
    +

    Pop and return the smallest item from the heap, and also push the new item. +The heap size doesn’t change. If the heap is empty, IndexError is raised.

    +

    This one step operation is more efficient than a heappop() followed by +heappush() and can be more appropriate when using a fixed-size heap. +The pop/push combination always returns an element from the heap and replaces +it with item.

    +

    The value returned may be larger than the item added. If that isn’t +desired, consider using heappushpop() instead. Its push/pop +combination returns the smaller of the two values, leaving the larger value +on the heap.

    +
    + +

    The module also offers three general purpose functions based on heaps.

    +
    +
    +heapq.merge(*iterables, key=None, reverse=False)
    +

    Merge multiple sorted inputs into a single sorted output (for example, merge +timestamped entries from multiple log files). Returns an iterator +over the sorted values.

    +

    Similar to sorted(itertools.chain(*iterables)) but returns an iterable, does +not pull the data into memory all at once, and assumes that each of the input +streams is already sorted (smallest to largest).

    +

    Has two optional arguments which must be specified as keyword arguments.

    +

    key specifies a key function of one argument that is used to +extract a comparison key from each input element. The default value is +None (compare the elements directly).

    +

    reverse is a boolean value. If set to True, then the input elements +are merged as if each comparison were reversed. To achieve behavior similar +to sorted(itertools.chain(*iterables), reverse=True), all iterables must +be sorted from largest to smallest.

    +
    +

    Changed in version 3.5: Added the optional key and reverse parameters.

    +
    +
    + +
    +
    +heapq.nlargest(n, iterable, key=None)
    +

    Return a list with the n largest elements from the dataset defined by +iterable. key, if provided, specifies a function of one argument that is +used to extract a comparison key from each element in iterable (for example, +key=str.lower). Equivalent to: sorted(iterable, key=key, +reverse=True)[:n].

    +
    + +
    +
    +heapq.nsmallest(n, iterable, key=None)
    +

    Return a list with the n smallest elements from the dataset defined by +iterable. key, if provided, specifies a function of one argument that is +used to extract a comparison key from each element in iterable (for example, +key=str.lower). Equivalent to: sorted(iterable, key=key)[:n].

    +
    + +

    The latter two functions perform best for smaller values of n. For larger +values, it is more efficient to use the sorted() function. Also, when +n==1, it is more efficient to use the built-in min() and max() +functions. If repeated usage of these functions is required, consider turning +the iterable into an actual heap.

    +
    +

    Basic Examples

    +

    A heapsort can be implemented by +pushing all values onto a heap and then popping off the smallest values one at a +time:

    +
    >>> def heapsort(iterable):
    +...     h = []
    +...     for value in iterable:
    +...         heappush(h, value)
    +...     return [heappop(h) for i in range(len(h))]
    +...
    +>>> heapsort([1, 3, 5, 7, 9, 2, 4, 6, 8, 0])
    +[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
    +
    +
    +

    This is similar to sorted(iterable), but unlike sorted(), this +implementation is not stable.

    +

    Heap elements can be tuples. This is useful for assigning comparison values +(such as task priorities) alongside the main record being tracked:

    +
    >>> h = []
    +>>> heappush(h, (5, 'write code'))
    +>>> heappush(h, (7, 'release product'))
    +>>> heappush(h, (1, 'write spec'))
    +>>> heappush(h, (3, 'create tests'))
    +>>> heappop(h)
    +(1, 'write spec')
    +
    +
    +
    +
    +

    Priority Queue Implementation Notes

    +

    A priority queue is common use +for a heap, and it presents several implementation challenges:

    +
      +
    • Sort stability: how do you get two tasks with equal priorities to be returned +in the order they were originally added?

    • +
    • Tuple comparison breaks for (priority, task) pairs if the priorities are equal +and the tasks do not have a default comparison order.

    • +
    • If the priority of a task changes, how do you move it to a new position in +the heap?

    • +
    • Or if a pending task needs to be deleted, how do you find it and remove it +from the queue?

    • +
    +

    A solution to the first two challenges is to store entries as 3-element list +including the priority, an entry count, and the task. The entry count serves as +a tie-breaker so that two tasks with the same priority are returned in the order +they were added. And since no two entry counts are the same, the tuple +comparison will never attempt to directly compare two tasks.

    +

    Another solution to the problem of non-comparable tasks is to create a wrapper +class that ignores the task item and only compares the priority field:

    +
    from dataclasses import dataclass, field
    +from typing import Any
    +
    +@dataclass(order=True)
    +class PrioritizedItem:
    +    priority: int
    +    item: Any=field(compare=False)
    +
    +
    +

    The remaining challenges revolve around finding a pending task and making +changes to its priority or removing it entirely. Finding a task can be done +with a dictionary pointing to an entry in the queue.

    +

    Removing the entry or changing its priority is more difficult because it would +break the heap structure invariants. So, a possible solution is to mark the +entry as removed and add a new entry with the revised priority:

    +
    pq = []                         # list of entries arranged in a heap
    +entry_finder = {}               # mapping of tasks to entries
    +REMOVED = '<removed-task>'      # placeholder for a removed task
    +counter = itertools.count()     # unique sequence count
    +
    +def add_task(task, priority=0):
    +    'Add a new task or update the priority of an existing task'
    +    if task in entry_finder:
    +        remove_task(task)
    +    count = next(counter)
    +    entry = [priority, count, task]
    +    entry_finder[task] = entry
    +    heappush(pq, entry)
    +
    +def remove_task(task):
    +    'Mark an existing task as REMOVED.  Raise KeyError if not found.'
    +    entry = entry_finder.pop(task)
    +    entry[-1] = REMOVED
    +
    +def pop_task():
    +    'Remove and return the lowest priority task. Raise KeyError if empty.'
    +    while pq:
    +        priority, count, task = heappop(pq)
    +        if task is not REMOVED:
    +            del entry_finder[task]
    +            return task
    +    raise KeyError('pop from an empty priority queue')
    +
    +
    +
    +
    +

    Theory

    +

    Heaps are arrays for which a[k] <= a[2*k+1] and a[k] <= a[2*k+2] for all +k, counting elements from 0. For the sake of comparison, non-existing +elements are considered to be infinite. The interesting property of a heap is +that a[0] is always its smallest element.

    +

    The strange invariant above is meant to be an efficient memory representation +for a tournament. The numbers below are k, not a[k]:

    +
                                   0
    +
    +              1                                 2
    +
    +      3               4                5               6
    +
    +  7       8       9       10      11      12      13      14
    +
    +15 16   17 18   19 20   21 22   23 24   25 26   27 28   29 30
    +
    +
    +

    In the tree above, each cell k is topping 2*k+1 and 2*k+2. In a usual +binary tournament we see in sports, each cell is the winner over the two cells +it tops, and we can trace the winner down the tree to see all opponents s/he +had. However, in many computer applications of such tournaments, we do not need +to trace the history of a winner. To be more memory efficient, when a winner is +promoted, we try to replace it by something else at a lower level, and the rule +becomes that a cell and the two cells it tops contain three different items, but +the top cell “wins” over the two topped cells.

    +

    If this heap invariant is protected at all time, index 0 is clearly the overall +winner. The simplest algorithmic way to remove it and find the “next” winner is +to move some loser (let’s say cell 30 in the diagram above) into the 0 position, +and then percolate this new 0 down the tree, exchanging values, until the +invariant is re-established. This is clearly logarithmic on the total number of +items in the tree. By iterating over all items, you get an O(n log n) sort.

    +

    A nice feature of this sort is that you can efficiently insert new items while +the sort is going on, provided that the inserted items are not “better” than the +last 0’th element you extracted. This is especially useful in simulation +contexts, where the tree holds all incoming events, and the “win” condition +means the smallest scheduled time. When an event schedules other events for +execution, they are scheduled into the future, so they can easily go into the +heap. So, a heap is a good structure for implementing schedulers (this is what +I used for my MIDI sequencer :-).

    +

    Various structures for implementing schedulers have been extensively studied, +and heaps are good for this, as they are reasonably speedy, the speed is almost +constant, and the worst case is not much different than the average case. +However, there are other representations which are more efficient overall, yet +the worst cases might be terrible.

    +

    Heaps are also very useful in big disk sorts. You most probably all know that a +big sort implies producing “runs” (which are pre-sorted sequences, whose size is +usually related to the amount of CPU memory), followed by a merging passes for +these runs, which merging is often very cleverly organised 1. It is very +important that the initial sort produces the longest runs possible. Tournaments +are a good way to achieve that. If, using all the memory available to hold a +tournament, you replace and percolate items that happen to fit the current run, +you’ll produce runs which are twice the size of the memory for random input, and +much better for input fuzzily ordered.

    +

    Moreover, if you output the 0’th item on disk and get an input which may not fit +in the current tournament (because the value “wins” over the last output value), +it cannot fit in the heap, so the size of the heap decreases. The freed memory +could be cleverly reused immediately for progressively building a second heap, +which grows at exactly the same rate the first heap is melting. When the first +heap completely vanishes, you switch heaps and start a new run. Clever and +quite effective!

    +

    In a word, heaps are useful memory structures to know. I use them in a few +applications, and I think it is good to keep a ‘heap’ module around. :-)

    +

    Footnotes

    +
    +
    1
    +

    The disk balancing algorithms which are current, nowadays, are more annoying +than clever, and this is a consequence of the seeking capabilities of the disks. +On devices which cannot seek, like big tape drives, the story was quite +different, and one had to be very clever to ensure (far in advance) that each +tape movement will be the most effective possible (that is, will best +participate at “progressing” the merge). Some tapes were even able to read +backwards, and this was also used to avoid the rewinding time. Believe me, real +good tape sorts were quite spectacular to watch! From all times, sorting has +always been a Great Art! :-)

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/hmac.html b/python-3.7.4-docs-html/library/hmac.html new file mode 100644 index 0000000..ce58a6b --- /dev/null +++ b/python-3.7.4-docs-html/library/hmac.html @@ -0,0 +1,322 @@ + + + + + + + hmac — Keyed-Hashing for Message Authentication — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    hmac — Keyed-Hashing for Message Authentication

    +

    Source code: Lib/hmac.py

    +
    +

    This module implements the HMAC algorithm as described by RFC 2104.

    +
    +
    +hmac.new(key, msg=None, digestmod=None)
    +

    Return a new hmac object. key is a bytes or bytearray object giving the +secret key. If msg is present, the method call update(msg) is made. +digestmod is the digest name, digest constructor or module for the HMAC +object to use. It supports any name suitable to hashlib.new() and +defaults to the hashlib.md5 constructor.

    +
    +

    Changed in version 3.4: Parameter key can be a bytes or bytearray object. +Parameter msg can be of any type supported by hashlib. +Parameter digestmod can be the name of a hash algorithm.

    +
    +
    +

    Deprecated since version 3.4, will be removed in version 3.8: MD5 as implicit default digest for digestmod is deprecated.

    +
    +
    + +
    +
    +hmac.digest(key, msg, digest)
    +

    Return digest of msg for given secret key and digest. The +function is equivalent to HMAC(key, msg, digest).digest(), but +uses an optimized C or inline implementation, which is faster for messages +that fit into memory. The parameters key, msg, and digest have +the same meaning as in new().

    +

    CPython implementation detail, the optimized C implementation is only used +when digest is a string and name of a digest algorithm, which is +supported by OpenSSL.

    +
    +

    New in version 3.7.

    +
    +
    + +

    An HMAC object has the following methods:

    +
    +
    +HMAC.update(msg)
    +

    Update the hmac object with msg. Repeated calls are equivalent to a +single call with the concatenation of all the arguments: +m.update(a); m.update(b) is equivalent to m.update(a + b).

    +
    +

    Changed in version 3.4: Parameter msg can be of any type supported by hashlib.

    +
    +
    + +
    +
    +HMAC.digest()
    +

    Return the digest of the bytes passed to the update() method so far. +This bytes object will be the same length as the digest_size of the digest +given to the constructor. It may contain non-ASCII bytes, including NUL +bytes.

    +
    +

    Warning

    +

    When comparing the output of digest() to an externally-supplied +digest during a verification routine, it is recommended to use the +compare_digest() function instead of the == operator +to reduce the vulnerability to timing attacks.

    +
    +
    + +
    +
    +HMAC.hexdigest()
    +

    Like digest() except the digest is returned as a string twice the +length containing only hexadecimal digits. This may be used to exchange the +value safely in email or other non-binary environments.

    +
    +

    Warning

    +

    When comparing the output of hexdigest() to an externally-supplied +digest during a verification routine, it is recommended to use the +compare_digest() function instead of the == operator +to reduce the vulnerability to timing attacks.

    +
    +
    + +
    +
    +HMAC.copy()
    +

    Return a copy (“clone”) of the hmac object. This can be used to efficiently +compute the digests of strings that share a common initial substring.

    +
    + +

    A hash object has the following attributes:

    +
    +
    +HMAC.digest_size
    +

    The size of the resulting HMAC digest in bytes.

    +
    + +
    +
    +HMAC.block_size
    +

    The internal block size of the hash algorithm in bytes.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +HMAC.name
    +

    The canonical name of this HMAC, always lowercase, e.g. hmac-md5.

    +
    +

    New in version 3.4.

    +
    +
    + +

    This module also provides the following helper function:

    +
    +
    +hmac.compare_digest(a, b)
    +

    Return a == b. This function uses an approach designed to prevent +timing analysis by avoiding content-based short circuiting behaviour, +making it appropriate for cryptography. a and b must both be of the +same type: either str (ASCII only, as e.g. returned by +HMAC.hexdigest()), or a bytes-like object.

    +
    +

    Note

    +

    If a and b are of different lengths, or if an error occurs, +a timing attack could theoretically reveal information about the +types and lengths of a and b—but not their values.

    +
    +
    +

    New in version 3.3.

    +
    +
    + +
    +

    See also

    +
    +
    Module hashlib

    The Python module providing secure hash functions.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/html.entities.html b/python-3.7.4-docs-html/library/html.entities.html new file mode 100644 index 0000000..3994e3a --- /dev/null +++ b/python-3.7.4-docs-html/library/html.entities.html @@ -0,0 +1,226 @@ + + + + + + + html.entities — Definitions of HTML general entities — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    html.entities — Definitions of HTML general entities

    +

    Source code: Lib/html/entities.py

    +
    +

    This module defines four dictionaries, html5, +name2codepoint, codepoint2name, and entitydefs.

    +
    +
    +html.entities.html5
    +

    A dictionary that maps HTML5 named character references 1 to the +equivalent Unicode character(s), e.g. html5['gt;'] == '>'. +Note that the trailing semicolon is included in the name (e.g. 'gt;'), +however some of the names are accepted by the standard even without the +semicolon: in this case the name is present with and without the ';'. +See also html.unescape().

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +html.entities.entitydefs
    +

    A dictionary mapping XHTML 1.0 entity definitions to their replacement text in +ISO Latin-1.

    +
    + +
    +
    +html.entities.name2codepoint
    +

    A dictionary that maps HTML entity names to the Unicode code points.

    +
    + +
    +
    +html.entities.codepoint2name
    +

    A dictionary that maps Unicode code points to HTML entity names.

    +
    + +

    Footnotes

    +
    +
    1
    +

    See https://www.w3.org/TR/html5/syntax.html#named-character-references

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/html.html b/python-3.7.4-docs-html/library/html.html new file mode 100644 index 0000000..0cc0758 --- /dev/null +++ b/python-3.7.4-docs-html/library/html.html @@ -0,0 +1,218 @@ + + + + + + + html — HyperText Markup Language support — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    html — HyperText Markup Language support

    +

    Source code: Lib/html/__init__.py

    +
    +

    This module defines utilities to manipulate HTML.

    +
    +
    +html.escape(s, quote=True)
    +

    Convert the characters &, < and > in string s to HTML-safe +sequences. Use this if you need to display text that might contain such +characters in HTML. If the optional flag quote is true, the characters +(") and (') are also translated; this helps for inclusion in an HTML +attribute value delimited by quotes, as in <a href="...">.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +html.unescape(s)
    +

    Convert all named and numeric character references (e.g. &gt;, +&#62;, &#x3e;) in the string s to the corresponding Unicode +characters. This function uses the rules defined by the HTML 5 standard +for both valid and invalid character references, and the list of +HTML 5 named character references.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +

    Submodules in the html package are:

    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/html.parser.html b/python-3.7.4-docs-html/library/html.parser.html new file mode 100644 index 0000000..5ef80af --- /dev/null +++ b/python-3.7.4-docs-html/library/html.parser.html @@ -0,0 +1,517 @@ + + + + + + + html.parser — Simple HTML and XHTML parser — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    html.parser — Simple HTML and XHTML parser

    +

    Source code: Lib/html/parser.py

    +
    +

    This module defines a class HTMLParser which serves as the basis for +parsing text files formatted in HTML (HyperText Mark-up Language) and XHTML.

    +
    +
    +class html.parser.HTMLParser(*, convert_charrefs=True)
    +

    Create a parser instance able to parse invalid markup.

    +

    If convert_charrefs is True (the default), all character +references (except the ones in script/style elements) are +automatically converted to the corresponding Unicode characters.

    +

    An HTMLParser instance is fed HTML data and calls handler methods +when start tags, end tags, text, comments, and other markup elements are +encountered. The user should subclass HTMLParser and override its +methods to implement the desired behavior.

    +

    This parser does not check that end tags match start tags or call the end-tag +handler for elements which are closed implicitly by closing an outer element.

    +
    +

    Changed in version 3.4: convert_charrefs keyword argument added.

    +
    +
    +

    Changed in version 3.5: The default value for argument convert_charrefs is now True.

    +
    +
    + +
    +

    Example HTML Parser Application

    +

    As a basic example, below is a simple HTML parser that uses the +HTMLParser class to print out start tags, end tags, and data +as they are encountered:

    +
    from html.parser import HTMLParser
    +
    +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)
    +
    +parser = MyHTMLParser()
    +parser.feed('<html><head><title>Test</title></head>'
    +            '<body><h1>Parse me!</h1></body></html>')
    +
    +
    +

    The output will then be:

    +
    Encountered a start tag: html
    +Encountered a start tag: head
    +Encountered a start tag: title
    +Encountered some data  : Test
    +Encountered an end tag : title
    +Encountered an end tag : head
    +Encountered a start tag: body
    +Encountered a start tag: h1
    +Encountered some data  : Parse me!
    +Encountered an end tag : h1
    +Encountered an end tag : body
    +Encountered an end tag : html
    +
    +
    +
    +
    +

    HTMLParser Methods

    +

    HTMLParser instances have the following methods:

    +
    +
    +HTMLParser.feed(data)
    +

    Feed some text to the parser. It is processed insofar as it consists of +complete elements; incomplete data is buffered until more data is fed or +close() is called. data must be str.

    +
    + +
    +
    +HTMLParser.close()
    +

    Force processing of all buffered data as if it were followed by an end-of-file +mark. This method may be redefined by a derived class to define additional +processing at the end of the input, but the redefined version should always call +the HTMLParser base class method close().

    +
    + +
    +
    +HTMLParser.reset()
    +

    Reset the instance. Loses all unprocessed data. This is called implicitly at +instantiation time.

    +
    + +
    +
    +HTMLParser.getpos()
    +

    Return current line number and offset.

    +
    + +
    +
    +HTMLParser.get_starttag_text()
    +

    Return the text of the most recently opened start tag. This should not normally +be needed for structured processing, but may be useful in dealing with HTML “as +deployed” or for re-generating input with minimal changes (whitespace between +attributes can be preserved, etc.).

    +
    + +

    The following methods are called when data or markup elements are encountered +and they are meant to be overridden in a subclass. The base class +implementations do nothing (except for handle_startendtag()):

    +
    +
    +HTMLParser.handle_starttag(tag, attrs)
    +

    This method is called to handle the start of a tag (e.g. <div id="main">).

    +

    The tag argument is the name of the tag converted to lower case. The attrs +argument is a list of (name, value) pairs containing the attributes found +inside the tag’s <> brackets. The name will be translated to lower case, +and quotes in the value have been removed, and character and entity references +have been replaced.

    +

    For instance, for the tag <A HREF="https://www.cwi.nl/">, this method +would be called as handle_starttag('a', [('href', 'https://www.cwi.nl/')]).

    +

    All entity references from html.entities are replaced in the attribute +values.

    +
    + +
    +
    +HTMLParser.handle_endtag(tag)
    +

    This method is called to handle the end tag of an element (e.g. </div>).

    +

    The tag argument is the name of the tag converted to lower case.

    +
    + +
    +
    +HTMLParser.handle_startendtag(tag, attrs)
    +

    Similar to handle_starttag(), but called when the parser encounters an +XHTML-style empty tag (<img ... />). This method may be overridden by +subclasses which require this particular lexical information; the default +implementation simply calls handle_starttag() and handle_endtag().

    +
    + +
    +
    +HTMLParser.handle_data(data)
    +

    This method is called to process arbitrary data (e.g. text nodes and the +content of <script>...</script> and <style>...</style>).

    +
    + +
    +
    +HTMLParser.handle_entityref(name)
    +

    This method is called to process a named character reference of the form +&name; (e.g. &gt;), where name is a general entity reference +(e.g. 'gt'). This method is never called if convert_charrefs is +True.

    +
    + +
    +
    +HTMLParser.handle_charref(name)
    +

    This method is called to process decimal and hexadecimal numeric character +references of the form &#NNN; and &#xNNN;. For example, the decimal +equivalent for &gt; is &#62;, whereas the hexadecimal is &#x3E;; +in this case the method will receive '62' or 'x3E'. This method +is never called if convert_charrefs is True.

    +
    + +
    +
    +HTMLParser.handle_comment(data)
    +

    This method is called when a comment is encountered (e.g. <!--comment-->).

    +

    For example, the comment <!-- comment --> will cause this method to be +called with the argument ' comment '.

    +

    The content of Internet Explorer conditional comments (condcoms) will also be +sent to this method, so, for <!--[if IE 9]>IE9-specific content<![endif]-->, +this method will receive '[if IE 9]>IE9-specific content<![endif]'.

    +
    + +
    +
    +HTMLParser.handle_decl(decl)
    +

    This method is called to handle an HTML doctype declaration (e.g. +<!DOCTYPE html>).

    +

    The decl parameter will be the entire contents of the declaration inside +the <!...> markup (e.g. 'DOCTYPE html').

    +
    + +
    +
    +HTMLParser.handle_pi(data)
    +

    Method called when a processing instruction is encountered. The data +parameter will contain the entire processing instruction. For example, for the +processing instruction <?proc color='red'>, this method would be called as +handle_pi("proc color='red'"). It is intended to be overridden by a derived +class; the base class implementation does nothing.

    +
    +

    Note

    +

    The HTMLParser class uses the SGML syntactic rules for processing +instructions. An XHTML processing instruction using the trailing '?' will +cause the '?' to be included in data.

    +
    +
    + +
    +
    +HTMLParser.unknown_decl(data)
    +

    This method is called when an unrecognized declaration is read by the parser.

    +

    The data parameter will be the entire contents of the declaration inside +the <![...]> markup. It is sometimes useful to be overridden by a +derived class. The base class implementation does nothing.

    +
    + +
    +
    +

    Examples

    +

    The following class implements a parser that will be used to illustrate more +examples:

    +
    from html.parser import HTMLParser
    +from html.entities import name2codepoint
    +
    +class MyHTMLParser(HTMLParser):
    +    def handle_starttag(self, tag, attrs):
    +        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)
    +
    +parser = MyHTMLParser()
    +
    +
    +

    Parsing a doctype:

    +
    >>> parser.feed('<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" '
    +...             '"http://www.w3.org/TR/html4/strict.dtd">')
    +Decl     : DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"
    +
    +
    +

    Parsing an element with a few attributes and a title:

    +
    >>> parser.feed('<img src="python-logo.png" alt="The Python logo">')
    +Start tag: img
    +     attr: ('src', 'python-logo.png')
    +     attr: ('alt', 'The Python logo')
    +>>>
    +>>> parser.feed('<h1>Python</h1>')
    +Start tag: h1
    +Data     : Python
    +End tag  : h1
    +
    +
    +

    The content of script and style elements is returned as is, without +further parsing:

    +
    >>> parser.feed('<style type="text/css">#python { color: green }</style>')
    +Start tag: style
    +     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
    +     attr: ('type', 'text/javascript')
    +Data     : alert("<strong>hello!</strong>");
    +End tag  : script
    +
    +
    +

    Parsing comments:

    +
    >>> parser.feed('<!-- a comment -->'
    +...             '<!--[if IE 9]>IE-specific content<![endif]-->')
    +Comment  :  a comment
    +Comment  : [if IE 9]>IE-specific content<![endif]
    +
    +
    +

    Parsing named and numeric character references and converting them to the +correct char (note: these 3 references are all equivalent to '>'):

    +
    >>> parser.feed('&gt;&#62;&#x3E;')
    +Named ent: >
    +Num ent  : >
    +Num ent  : >
    +
    +
    +

    Feeding incomplete chunks to feed() works, but +handle_data() might be called more than once +(unless convert_charrefs is set to True):

    +
    >>> for chunk in ['<sp', 'an>buff', 'ered ', 'text</s', 'pan>']:
    +...     parser.feed(chunk)
    +...
    +Start tag: span
    +Data     : buff
    +Data     : ered
    +Data     : text
    +End tag  : span
    +
    +
    +

    Parsing invalid HTML (e.g. unquoted attributes) also works:

    +
    >>> parser.feed('<p><a class=link href=#main>tag soup</p ></a>')
    +Start tag: p
    +Start tag: a
    +     attr: ('class', 'link')
    +     attr: ('href', '#main')
    +Data     : tag soup
    +End tag  : p
    +End tag  : a
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/http.client.html b/python-3.7.4-docs-html/library/http.client.html new file mode 100644 index 0000000..8c1fc70 --- /dev/null +++ b/python-3.7.4-docs-html/library/http.client.html @@ -0,0 +1,775 @@ + + + + + + + http.client — HTTP protocol client — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    http.client — HTTP protocol client

    +

    Source code: Lib/http/client.py

    +
    +

    This module defines classes which implement the client side of the HTTP and +HTTPS protocols. It is normally not used directly — the module +urllib.request uses it to handle URLs that use HTTP and HTTPS.

    +
    +

    See also

    +

    The Requests package +is recommended for a higher-level HTTP client interface.

    +
    +
    +

    Note

    +

    HTTPS support is only available if Python was compiled with SSL support +(through the ssl module).

    +
    +

    The module provides the following classes:

    +
    +
    +class http.client.HTTPConnection(host, port=None, [timeout, ]source_address=None, blocksize=8192)
    +

    An HTTPConnection instance represents one transaction with an HTTP +server. It should be instantiated passing it a host and optional port +number. If no port number is passed, the port is extracted from the host +string if it has the form host:port, else the default HTTP port (80) is +used. If the optional timeout parameter is given, blocking +operations (like connection attempts) will timeout after that many seconds +(if it is not given, the global default timeout setting is used). +The optional source_address parameter may be a tuple of a (host, port) +to use as the source address the HTTP connection is made from. +The optional blocksize parameter sets the buffer size in bytes for +sending a file-like message body.

    +

    For example, the following calls all create instances that connect to the server +at the same host and port:

    +
    >>> h1 = http.client.HTTPConnection('www.python.org')
    +>>> h2 = http.client.HTTPConnection('www.python.org:80')
    +>>> h3 = http.client.HTTPConnection('www.python.org', 80)
    +>>> h4 = http.client.HTTPConnection('www.python.org', 80, timeout=10)
    +
    +
    +
    +

    Changed in version 3.2: source_address was added.

    +
    +
    +

    Changed in version 3.4: The strict parameter was removed. HTTP 0.9-style “Simple Responses” are +not longer supported.

    +
    +
    +

    Changed in version 3.7: blocksize parameter was added.

    +
    +
    + +
    +
    +class http.client.HTTPSConnection(host, port=None, key_file=None, cert_file=None, [timeout, ]source_address=None, *, context=None, check_hostname=None, blocksize=8192)
    +

    A subclass of HTTPConnection that uses SSL for communication with +secure servers. Default port is 443. If context is specified, it +must be a ssl.SSLContext instance describing the various SSL +options.

    +

    Please read Security considerations for more information on best practices.

    +
    +

    Changed in version 3.2: source_address, context and check_hostname were added.

    +
    +
    +

    Changed in version 3.2: This class now supports HTTPS virtual hosts if possible (that is, +if ssl.HAS_SNI is true).

    +
    +
    +

    Changed in version 3.4: The strict parameter was removed. HTTP 0.9-style “Simple Responses” are +no longer supported.

    +
    +
    +

    Changed in version 3.4.3: This class now performs all the necessary certificate and hostname checks +by default. To revert to the previous, unverified, behavior +ssl._create_unverified_context() can be passed to the context +parameter.

    +
    +
    +

    Changed in version 3.7.4: This class now enables TLS 1.3 +ssl.SSLContext.post_handshake_auth for the default context or +when cert_file is passed with a custom context.

    +
    +
    +

    Deprecated since version 3.6: key_file and cert_file are deprecated in favor of context. +Please use ssl.SSLContext.load_cert_chain() instead, or let +ssl.create_default_context() select the system’s trusted CA +certificates for you.

    +

    The check_hostname parameter is also deprecated; the +ssl.SSLContext.check_hostname attribute of context should +be used instead.

    +
    +
    + +
    +
    +class http.client.HTTPResponse(sock, debuglevel=0, method=None, url=None)
    +

    Class whose instances are returned upon successful connection. Not +instantiated directly by user.

    +
    +

    Changed in version 3.4: The strict parameter was removed. HTTP 0.9 style “Simple Responses” are +no longer supported.

    +
    +
    + +

    The following exceptions are raised as appropriate:

    +
    +
    +exception http.client.HTTPException
    +

    The base class of the other exceptions in this module. It is a subclass of +Exception.

    +
    + +
    +
    +exception http.client.NotConnected
    +

    A subclass of HTTPException.

    +
    + +
    +
    +exception http.client.InvalidURL
    +

    A subclass of HTTPException, raised if a port is given and is either +non-numeric or empty.

    +
    + +
    +
    +exception http.client.UnknownProtocol
    +

    A subclass of HTTPException.

    +
    + +
    +
    +exception http.client.UnknownTransferEncoding
    +

    A subclass of HTTPException.

    +
    + +
    +
    +exception http.client.UnimplementedFileMode
    +

    A subclass of HTTPException.

    +
    + +
    +
    +exception http.client.IncompleteRead
    +

    A subclass of HTTPException.

    +
    + +
    +
    +exception http.client.ImproperConnectionState
    +

    A subclass of HTTPException.

    +
    + +
    +
    +exception http.client.CannotSendRequest
    +

    A subclass of ImproperConnectionState.

    +
    + +
    +
    +exception http.client.CannotSendHeader
    +

    A subclass of ImproperConnectionState.

    +
    + +
    +
    +exception http.client.ResponseNotReady
    +

    A subclass of ImproperConnectionState.

    +
    + +
    +
    +exception http.client.BadStatusLine
    +

    A subclass of HTTPException. Raised if a server responds with a HTTP +status code that we don’t understand.

    +
    + +
    +
    +exception http.client.LineTooLong
    +

    A subclass of HTTPException. Raised if an excessively long line +is received in the HTTP protocol from the server.

    +
    + +
    +
    +exception http.client.RemoteDisconnected
    +

    A subclass of ConnectionResetError and BadStatusLine. Raised +by HTTPConnection.getresponse() when the attempt to read the response +results in no data read from the connection, indicating that the remote end +has closed the connection.

    +
    +

    New in version 3.5: Previously, BadStatusLine('') was raised.

    +
    +
    + +

    The constants defined in this module are:

    +
    +
    +http.client.HTTP_PORT
    +

    The default port for the HTTP protocol (always 80).

    +
    + +
    +
    +http.client.HTTPS_PORT
    +

    The default port for the HTTPS protocol (always 443).

    +
    + +
    +
    +http.client.responses
    +

    This dictionary maps the HTTP 1.1 status codes to the W3C names.

    +

    Example: http.client.responses[http.client.NOT_FOUND] is 'Not Found'.

    +
    + +

    See HTTP status codes for a list of HTTP status codes that are +available in this module as constants.

    +
    +

    HTTPConnection Objects

    +

    HTTPConnection instances have the following methods:

    +
    +
    +HTTPConnection.request(method, url, body=None, headers={}, *, encode_chunked=False)
    +

    This will send a request to the server using the HTTP request +method method and the selector url.

    +

    If body is specified, the specified data is sent after the headers are +finished. It may be a str, a bytes-like object, an +open file object, or an iterable of bytes. If body +is a string, it is encoded as ISO-8859-1, the default for HTTP. If it +is a bytes-like object, the bytes are sent as is. If it is a file +object, the contents of the file is sent; this file object should +support at least the read() method. If the file object is an +instance of io.TextIOBase, the data returned by the read() +method will be encoded as ISO-8859-1, otherwise the data returned by +read() is sent as is. If body is an iterable, the elements of the +iterable are sent as is until the iterable is exhausted.

    +

    The headers argument should be a mapping of extra HTTP headers to send +with the request.

    +

    If headers contains neither Content-Length nor Transfer-Encoding, +but there is a request body, one of those +header fields will be added automatically. If +body is None, the Content-Length header is set to 0 for +methods that expect a body (PUT, POST, and PATCH). If +body is a string or a bytes-like object that is not also a +file, the Content-Length header is +set to its length. Any other type of body (files +and iterables in general) will be chunk-encoded, and the +Transfer-Encoding header will automatically be set instead of +Content-Length.

    +

    The encode_chunked argument is only relevant if Transfer-Encoding is +specified in headers. If encode_chunked is False, the +HTTPConnection object assumes that all encoding is handled by the +calling code. If it is True, the body will be chunk-encoded.

    +
    +

    Note

    +

    Chunked transfer encoding has been added to the HTTP protocol +version 1.1. Unless the HTTP server is known to handle HTTP 1.1, +the caller must either specify the Content-Length, or must pass a +str or bytes-like object that is not also a file as the +body representation.

    +
    +
    +

    New in version 3.2: body can now be an iterable.

    +
    +
    +

    Changed in version 3.6: If neither Content-Length nor Transfer-Encoding are set in +headers, file and iterable body objects are now chunk-encoded. +The encode_chunked argument was added. +No attempt is made to determine the Content-Length for file +objects.

    +
    +
    + +
    +
    +HTTPConnection.getresponse()
    +

    Should be called after a request is sent to get the response from the server. +Returns an HTTPResponse instance.

    +
    +

    Note

    +

    Note that you must have read the whole response before you can send a new +request to the server.

    +
    +
    +

    Changed in version 3.5: If a ConnectionError or subclass is raised, the +HTTPConnection object will be ready to reconnect when +a new request is sent.

    +
    +
    + +
    +
    +HTTPConnection.set_debuglevel(level)
    +

    Set the debugging level. The default debug level is 0, meaning no +debugging output is printed. Any value greater than 0 will cause all +currently defined debug output to be printed to stdout. The debuglevel +is passed to any new HTTPResponse objects that are created.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +HTTPConnection.set_tunnel(host, port=None, headers=None)
    +

    Set the host and the port for HTTP Connect Tunnelling. This allows running +the connection through a proxy server.

    +

    The host and port arguments specify the endpoint of the tunneled connection +(i.e. the address included in the CONNECT request, not the address of the +proxy server).

    +

    The headers argument should be a mapping of extra HTTP headers to send with +the CONNECT request.

    +

    For example, to tunnel through a HTTPS proxy server running locally on port +8080, we would pass the address of the proxy to the HTTPSConnection +constructor, and the address of the host that we eventually want to reach to +the set_tunnel() method:

    +
    >>> import http.client
    +>>> conn = http.client.HTTPSConnection("localhost", 8080)
    +>>> conn.set_tunnel("www.python.org")
    +>>> conn.request("HEAD","/index.html")
    +
    +
    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +HTTPConnection.connect()
    +

    Connect to the server specified when the object was created. By default, +this is called automatically when making a request if the client does not +already have a connection.

    +
    + +
    +
    +HTTPConnection.close()
    +

    Close the connection to the server.

    +
    + +
    +
    +HTTPConnection.blocksize
    +

    Buffer size in bytes for sending a file-like message body.

    +
    +

    New in version 3.7.

    +
    +
    + +

    As an alternative to using the request() method described above, you can +also send your request step by step, by using the four functions below.

    +
    +
    +HTTPConnection.putrequest(method, url, skip_host=False, skip_accept_encoding=False)
    +

    This should be the first call after the connection to the server has been +made. It sends a line to the server consisting of the method string, +the url string, and the HTTP version (HTTP/1.1). To disable automatic +sending of Host: or Accept-Encoding: headers (for example to accept +additional content encodings), specify skip_host or skip_accept_encoding +with non-False values.

    +
    + +
    +
    +HTTPConnection.putheader(header, argument[, ...])
    +

    Send an RFC 822-style header to the server. It sends a line to the server +consisting of the header, a colon and a space, and the first argument. If more +arguments are given, continuation lines are sent, each consisting of a tab and +an argument.

    +
    + +
    +
    +HTTPConnection.endheaders(message_body=None, *, encode_chunked=False)
    +

    Send a blank line to the server, signalling the end of the headers. The +optional message_body argument can be used to pass a message body +associated with the request.

    +

    If encode_chunked is True, the result of each iteration of +message_body will be chunk-encoded as specified in RFC 7230, +Section 3.3.1. How the data is encoded is dependent on the type of +message_body. If message_body implements the buffer interface the encoding will result in a single chunk. +If message_body is a collections.abc.Iterable, each iteration +of message_body will result in a chunk. If message_body is a +file object, each call to .read() will result in a chunk. +The method automatically signals the end of the chunk-encoded data +immediately after message_body.

    +
    +

    Note

    +

    Due to the chunked encoding specification, empty chunks +yielded by an iterator body will be ignored by the chunk-encoder. +This is to avoid premature termination of the read of the request by +the target server due to malformed encoding.

    +
    +
    +

    New in version 3.6: Chunked encoding support. The encode_chunked parameter was +added.

    +
    +
    + +
    +
    +HTTPConnection.send(data)
    +

    Send data to the server. This should be used directly only after the +endheaders() method has been called and before getresponse() is +called.

    +
    + +
    +
    +

    HTTPResponse Objects

    +

    An HTTPResponse instance wraps the HTTP response from the +server. It provides access to the request headers and the entity +body. The response is an iterable object and can be used in a with +statement.

    +
    +

    Changed in version 3.5: The io.BufferedIOBase interface is now implemented and +all of its reader operations are supported.

    +
    +
    +
    +HTTPResponse.read([amt])
    +

    Reads and returns the response body, or up to the next amt bytes.

    +
    + +
    +
    +HTTPResponse.readinto(b)
    +

    Reads up to the next len(b) bytes of the response body into the buffer b. +Returns the number of bytes read.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +HTTPResponse.getheader(name, default=None)
    +

    Return the value of the header name, or default if there is no header +matching name. If there is more than one header with the name name, +return all of the values joined by ‘, ‘. If ‘default’ is any iterable other +than a single string, its elements are similarly returned joined by commas.

    +
    + +
    +
    +HTTPResponse.getheaders()
    +

    Return a list of (header, value) tuples.

    +
    + +
    +
    +HTTPResponse.fileno()
    +

    Return the fileno of the underlying socket.

    +
    + +
    +
    +HTTPResponse.msg
    +

    A http.client.HTTPMessage instance containing the response +headers. http.client.HTTPMessage is a subclass of +email.message.Message.

    +
    + +
    +
    +HTTPResponse.version
    +

    HTTP protocol version used by server. 10 for HTTP/1.0, 11 for HTTP/1.1.

    +
    + +
    +
    +HTTPResponse.status
    +

    Status code returned by server.

    +
    + +
    +
    +HTTPResponse.reason
    +

    Reason phrase returned by server.

    +
    + +
    +
    +HTTPResponse.debuglevel
    +

    A debugging hook. If debuglevel is greater than zero, messages +will be printed to stdout as the response is read and parsed.

    +
    + +
    +
    +HTTPResponse.closed
    +

    Is True if the stream is closed.

    +
    + +
    +
    +

    Examples

    +

    Here is an example session that uses the GET method:

    +
    >>> import http.client
    +>>> conn = http.client.HTTPSConnection("www.python.org")
    +>>> conn.request("GET", "/")
    +>>> r1 = conn.getresponse()
    +>>> print(r1.status, r1.reason)
    +200 OK
    +>>> data1 = r1.read()  # This will return entire content.
    +>>> # The following example demonstrates reading data in chunks.
    +>>> conn.request("GET", "/")
    +>>> r1 = conn.getresponse()
    +>>> while not r1.closed:
    +...     print(r1.read(200))  # 200 bytes
    +b'<!doctype html>\n<!--[if"...
    +...
    +>>> # Example of an invalid request
    +>>> conn = http.client.HTTPSConnection("docs.python.org")
    +>>> conn.request("GET", "/parrot.spam")
    +>>> r2 = conn.getresponse()
    +>>> print(r2.status, r2.reason)
    +404 Not Found
    +>>> data2 = r2.read()
    +>>> conn.close()
    +
    +
    +

    Here is an example session that uses the HEAD method. Note that the +HEAD method never returns any data.

    +
    >>> import http.client
    +>>> conn = http.client.HTTPSConnection("www.python.org")
    +>>> conn.request("HEAD", "/")
    +>>> res = conn.getresponse()
    +>>> print(res.status, res.reason)
    +200 OK
    +>>> data = res.read()
    +>>> print(len(data))
    +0
    +>>> data == b''
    +True
    +
    +
    +

    Here is an example session that shows how to POST requests:

    +
    >>> import http.client, urllib.parse
    +>>> params = urllib.parse.urlencode({'@number': 12524, '@type': 'issue', '@action': 'show'})
    +>>> headers = {"Content-type": "application/x-www-form-urlencoded",
    +...            "Accept": "text/plain"}
    +>>> conn = http.client.HTTPConnection("bugs.python.org")
    +>>> conn.request("POST", "", params, headers)
    +>>> response = conn.getresponse()
    +>>> print(response.status, response.reason)
    +302 Found
    +>>> data = response.read()
    +>>> data
    +b'Redirecting to <a href="http://bugs.python.org/issue12524">http://bugs.python.org/issue12524</a>'
    +>>> conn.close()
    +
    +
    +

    Client side HTTP PUT requests are very similar to POST requests. The +difference lies only the server side where HTTP server will allow resources to +be created via PUT request. It should be noted that custom HTTP methods ++are also handled in urllib.request.Request by sending the appropriate ++method attribute.Here is an example session that shows how to do PUT +request using http.client:

    +
    >>> # This creates an HTTP message
    +>>> # with the content of BODY as the enclosed representation
    +>>> # for the resource http://localhost:8080/file
    +...
    +>>> import http.client
    +>>> BODY = "***filecontents***"
    +>>> conn = http.client.HTTPConnection("localhost", 8080)
    +>>> conn.request("PUT", "/file", BODY)
    +>>> response = conn.getresponse()
    +>>> print(response.status, response.reason)
    +200, OK
    +
    +
    +
    +
    +

    HTTPMessage Objects

    +

    An http.client.HTTPMessage instance holds the headers from an HTTP +response. It is implemented using the email.message.Message class.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/http.cookiejar.html b/python-3.7.4-docs-html/library/http.cookiejar.html new file mode 100644 index 0000000..b8c99c1 --- /dev/null +++ b/python-3.7.4-docs-html/library/http.cookiejar.html @@ -0,0 +1,932 @@ + + + + + + + http.cookiejar — Cookie handling for HTTP clients — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    http.cookiejar — Cookie handling for HTTP clients

    +

    Source code: Lib/http/cookiejar.py

    +
    +

    The http.cookiejar module defines classes for automatic handling of HTTP +cookies. It is useful for accessing web sites that require small pieces of data +– cookies – to be set on the client machine by an HTTP response from a +web server, and then returned to the server in later HTTP requests.

    +

    Both the regular Netscape cookie protocol and the protocol defined by +RFC 2965 are handled. RFC 2965 handling is switched off by default. +RFC 2109 cookies are parsed as Netscape cookies and subsequently treated +either as Netscape or RFC 2965 cookies according to the ‘policy’ in effect. +Note that the great majority of cookies on the Internet are Netscape cookies. +http.cookiejar attempts to follow the de-facto Netscape cookie protocol (which +differs substantially from that set out in the original Netscape specification), +including taking note of the max-age and port cookie-attributes +introduced with RFC 2965.

    +
    +

    Note

    +

    The various named parameters found in Set-Cookie and +Set-Cookie2 headers (eg. domain and expires) are +conventionally referred to as attributes. To distinguish them from +Python attributes, the documentation for this module uses the term +cookie-attribute instead.

    +
    +

    The module defines the following exception:

    +
    +
    +exception http.cookiejar.LoadError
    +

    Instances of FileCookieJar raise this exception on failure to load +cookies from a file. LoadError is a subclass of OSError.

    +
    +

    Changed in version 3.3: LoadError was made a subclass of OSError instead of +IOError.

    +
    +
    + +

    The following classes are provided:

    +
    +
    +class http.cookiejar.CookieJar(policy=None)
    +

    policy is an object implementing the CookiePolicy interface.

    +

    The CookieJar class stores HTTP cookies. It extracts cookies from HTTP +requests, and returns them in HTTP responses. CookieJar instances +automatically expire contained cookies when necessary. Subclasses are also +responsible for storing and retrieving cookies from a file or database.

    +
    + +
    +
    +class http.cookiejar.FileCookieJar(filename, delayload=None, policy=None)
    +

    policy is an object implementing the CookiePolicy interface. For the +other arguments, see the documentation for the corresponding attributes.

    +

    A CookieJar which can load cookies from, and perhaps save cookies to, a +file on disk. Cookies are NOT loaded from the named file until either the +load() or revert() method is called. Subclasses of this class are +documented in section FileCookieJar subclasses and co-operation with web browsers.

    +
    + +
    +
    +class http.cookiejar.CookiePolicy
    +

    This class is responsible for deciding whether each cookie should be accepted +from / returned to the server.

    +
    + +
    +
    +class http.cookiejar.DefaultCookiePolicy(blocked_domains=None, allowed_domains=None, netscape=True, rfc2965=False, rfc2109_as_netscape=None, hide_cookie2=False, strict_domain=False, strict_rfc2965_unverifiable=True, strict_ns_unverifiable=False, strict_ns_domain=DefaultCookiePolicy.DomainLiberal, strict_ns_set_initial_dollar=False, strict_ns_set_path=False)
    +

    Constructor arguments should be passed as keyword arguments only. +blocked_domains is a sequence of domain names that we never accept cookies +from, nor return cookies to. allowed_domains if not None, this is a +sequence of the only domains for which we accept and return cookies. For all +other arguments, see the documentation for CookiePolicy and +DefaultCookiePolicy objects.

    +

    DefaultCookiePolicy implements the standard accept / reject rules for +Netscape and RFC 2965 cookies. By default, RFC 2109 cookies (ie. cookies +received in a Set-Cookie header with a version cookie-attribute of +1) are treated according to the RFC 2965 rules. However, if RFC 2965 handling +is turned off or rfc2109_as_netscape is True, RFC 2109 cookies are +‘downgraded’ by the CookieJar instance to Netscape cookies, by +setting the version attribute of the Cookie instance to 0. +DefaultCookiePolicy also provides some parameters to allow some +fine-tuning of policy.

    +
    + +
    +
    +class http.cookiejar.Cookie
    +

    This class represents Netscape, RFC 2109 and RFC 2965 cookies. It is not +expected that users of http.cookiejar construct their own Cookie +instances. Instead, if necessary, call make_cookies() on a +CookieJar instance.

    +
    + +
    +

    See also

    +
    +
    Module urllib.request

    URL opening with automatic cookie handling.

    +
    +
    Module http.cookies

    HTTP cookie classes, principally useful for server-side code. The +http.cookiejar and http.cookies modules do not depend on each +other.

    +
    +
    https://curl.haxx.se/rfc/cookie_spec.html

    The specification of the original Netscape cookie protocol. Though this is +still the dominant protocol, the ‘Netscape cookie protocol’ implemented by all +the major browsers (and http.cookiejar) only bears a passing resemblance to +the one sketched out in cookie_spec.html.

    +
    +
    RFC 2109 - HTTP State Management Mechanism

    Obsoleted by RFC 2965. Uses Set-Cookie with version=1.

    +
    +
    RFC 2965 - HTTP State Management Mechanism

    The Netscape protocol with the bugs fixed. Uses Set-Cookie2 in +place of Set-Cookie. Not widely used.

    +
    +
    http://kristol.org/cookie/errata.html

    Unfinished errata to RFC 2965.

    +
    +
    +

    RFC 2964 - Use of HTTP State Management

    +
    +
    +

    CookieJar and FileCookieJar Objects

    +

    CookieJar objects support the iterator protocol for iterating over +contained Cookie objects.

    +

    CookieJar has the following methods:

    +
    + +

    Add correct Cookie header to request.

    +

    If policy allows (ie. the rfc2965 and hide_cookie2 attributes of +the CookieJar’s CookiePolicy instance are true and false +respectively), the Cookie2 header is also added when appropriate.

    +

    The request object (usually a urllib.request..Request instance) +must support the methods get_full_url(), get_host(), +get_type(), unverifiable(), has_header(), +get_header(), header_items(), add_unredirected_header() +and origin_req_host attribute as documented by +urllib.request.

    +
    +

    Changed in version 3.3: request object needs origin_req_host attribute. Dependency on a +deprecated method get_origin_req_host() has been removed.

    +
    +
    + +
    +
    +CookieJar.extract_cookies(response, request)
    +

    Extract cookies from HTTP response and store them in the CookieJar, +where allowed by policy.

    +

    The CookieJar will look for allowable Set-Cookie and +Set-Cookie2 headers in the response argument, and store cookies +as appropriate (subject to the CookiePolicy.set_ok() method’s approval).

    +

    The response object (usually the result of a call to +urllib.request.urlopen(), or similar) should support an info() +method, which returns an email.message.Message instance.

    +

    The request object (usually a urllib.request.Request instance) +must support the methods get_full_url(), get_host(), +unverifiable(), and origin_req_host attribute, as documented +by urllib.request. The request is used to set default values for +cookie-attributes as well as for checking that the cookie is allowed to be +set.

    +
    +

    Changed in version 3.3: request object needs origin_req_host attribute. Dependency on a +deprecated method get_origin_req_host() has been removed.

    +
    +
    + +
    +
    +CookieJar.set_policy(policy)
    +

    Set the CookiePolicy instance to be used.

    +
    + +
    +
    +CookieJar.make_cookies(response, request)
    +

    Return sequence of Cookie objects extracted from response object.

    +

    See the documentation for extract_cookies() for the interfaces required of +the response and request arguments.

    +
    + +
    + +

    Set a Cookie if policy says it’s OK to do so.

    +
    + +
    + +

    Set a Cookie, without checking with policy to see whether or not it +should be set.

    +
    + +
    +
    +CookieJar.clear([domain[, path[, name]]])
    +

    Clear some cookies.

    +

    If invoked without arguments, clear all cookies. If given a single argument, +only cookies belonging to that domain will be removed. If given two arguments, +cookies belonging to the specified domain and URL path are removed. If +given three arguments, then the cookie with the specified domain, path and +name is removed.

    +

    Raises KeyError if no matching cookie exists.

    +
    + +
    +
    +CookieJar.clear_session_cookies()
    +

    Discard all session cookies.

    +

    Discards all contained cookies that have a true discard attribute +(usually because they had either no max-age or expires cookie-attribute, +or an explicit discard cookie-attribute). For interactive browsers, the end +of a session usually corresponds to closing the browser window.

    +

    Note that the save() method won’t save session cookies anyway, unless you +ask otherwise by passing a true ignore_discard argument.

    +
    + +

    FileCookieJar implements the following additional methods:

    +
    +
    +FileCookieJar.save(filename=None, ignore_discard=False, ignore_expires=False)
    +

    Save cookies to a file.

    +

    This base class raises NotImplementedError. Subclasses may leave this +method unimplemented.

    +

    filename is the name of file in which to save cookies. If filename is not +specified, self.filename is used (whose default is the value passed to +the constructor, if any); if self.filename is None, +ValueError is raised.

    +

    ignore_discard: save even cookies set to be discarded. ignore_expires: save +even cookies that have expired

    +

    The file is overwritten if it already exists, thus wiping all the cookies it +contains. Saved cookies can be restored later using the load() or +revert() methods.

    +
    + +
    +
    +FileCookieJar.load(filename=None, ignore_discard=False, ignore_expires=False)
    +

    Load cookies from a file.

    +

    Old cookies are kept unless overwritten by newly loaded ones.

    +

    Arguments are as for save().

    +

    The named file must be in the format understood by the class, or +LoadError will be raised. Also, OSError may be raised, for +example if the file does not exist.

    +
    +

    Changed in version 3.3: IOError used to be raised, it is now an alias of OSError.

    +
    +
    + +
    +
    +FileCookieJar.revert(filename=None, ignore_discard=False, ignore_expires=False)
    +

    Clear all cookies and reload cookies from a saved file.

    +

    revert() can raise the same exceptions as load(). If there is a +failure, the object’s state will not be altered.

    +
    + +

    FileCookieJar instances have the following public attributes:

    +
    +
    +FileCookieJar.filename
    +

    Filename of default file in which to keep cookies. This attribute may be +assigned to.

    +
    + +
    +
    +FileCookieJar.delayload
    +

    If true, load cookies lazily from disk. This attribute should not be assigned +to. This is only a hint, since this only affects performance, not behaviour +(unless the cookies on disk are changing). A CookieJar object may +ignore it. None of the FileCookieJar classes included in the standard +library lazily loads cookies.

    +
    + +
    +
    +

    FileCookieJar subclasses and co-operation with web browsers

    +

    The following CookieJar subclasses are provided for reading and +writing.

    +
    +
    +class http.cookiejar.MozillaCookieJar(filename, delayload=None, policy=None)
    +

    A FileCookieJar that can load from and save cookies to disk in the +Mozilla cookies.txt file format (which is also used by the Lynx and Netscape +browsers).

    +
    +

    Note

    +

    This loses information about RFC 2965 cookies, and also about newer or +non-standard cookie-attributes such as port.

    +
    +
    +

    Warning

    +

    Back up your cookies before saving if you have cookies whose loss / corruption +would be inconvenient (there are some subtleties which may lead to slight +changes in the file over a load / save round-trip).

    +
    +

    Also note that cookies saved while Mozilla is running will get clobbered by +Mozilla.

    +
    + +
    +
    +class http.cookiejar.LWPCookieJar(filename, delayload=None, policy=None)
    +

    A FileCookieJar that can load from and save cookies to disk in format +compatible with the libwww-perl library’s Set-Cookie3 file format. This is +convenient if you want to store cookies in a human-readable file.

    +
    + +
    +
    +

    CookiePolicy Objects

    +

    Objects implementing the CookiePolicy interface have the following +methods:

    +
    +
    +CookiePolicy.set_ok(cookie, request)
    +

    Return boolean value indicating whether cookie should be accepted from server.

    +

    cookie is a Cookie instance. request is an object +implementing the interface defined by the documentation for +CookieJar.extract_cookies().

    +
    + +
    +
    +CookiePolicy.return_ok(cookie, request)
    +

    Return boolean value indicating whether cookie should be returned to server.

    +

    cookie is a Cookie instance. request is an object +implementing the interface defined by the documentation for +CookieJar.add_cookie_header().

    +
    + +
    +
    +CookiePolicy.domain_return_ok(domain, request)
    +

    Return false if cookies should not be returned, given cookie domain.

    +

    This method is an optimization. It removes the need for checking every cookie +with a particular domain (which might involve reading many files). Returning +true from domain_return_ok() and path_return_ok() leaves all the +work to return_ok().

    +

    If domain_return_ok() returns true for the cookie domain, +path_return_ok() is called for the cookie path. Otherwise, +path_return_ok() and return_ok() are never called for that cookie +domain. If path_return_ok() returns true, return_ok() is called +with the Cookie object itself for a full check. Otherwise, +return_ok() is never called for that cookie path.

    +

    Note that domain_return_ok() is called for every cookie domain, not just +for the request domain. For example, the function might be called with both +".example.com" and "www.example.com" if the request domain is +"www.example.com". The same goes for path_return_ok().

    +

    The request argument is as documented for return_ok().

    +
    + +
    +
    +CookiePolicy.path_return_ok(path, request)
    +

    Return false if cookies should not be returned, given cookie path.

    +

    See the documentation for domain_return_ok().

    +
    + +

    In addition to implementing the methods above, implementations of the +CookiePolicy interface must also supply the following attributes, +indicating which protocols should be used, and how. All of these attributes may +be assigned to.

    +
    +
    +CookiePolicy.netscape
    +

    Implement Netscape protocol.

    +
    + +
    +
    +CookiePolicy.rfc2965
    +

    Implement RFC 2965 protocol.

    +
    + +
    +
    +CookiePolicy.hide_cookie2
    +

    Don’t add Cookie2 header to requests (the presence of this header +indicates to the server that we understand RFC 2965 cookies).

    +
    + +

    The most useful way to define a CookiePolicy class is by subclassing +from DefaultCookiePolicy and overriding some or all of the methods +above. CookiePolicy itself may be used as a ‘null policy’ to allow +setting and receiving any and all cookies (this is unlikely to be useful).

    +
    +
    +

    DefaultCookiePolicy Objects

    +

    Implements the standard rules for accepting and returning cookies.

    +

    Both RFC 2965 and Netscape cookies are covered. RFC 2965 handling is switched +off by default.

    +

    The easiest way to provide your own policy is to override this class and call +its methods in your overridden implementations before adding your own additional +checks:

    +
    import http.cookiejar
    +class MyCookiePolicy(http.cookiejar.DefaultCookiePolicy):
    +    def set_ok(self, cookie, request):
    +        if not http.cookiejar.DefaultCookiePolicy.set_ok(self, cookie, request):
    +            return False
    +        if i_dont_want_to_store_this_cookie(cookie):
    +            return False
    +        return True
    +
    +
    +

    In addition to the features required to implement the CookiePolicy +interface, this class allows you to block and allow domains from setting and +receiving cookies. There are also some strictness switches that allow you to +tighten up the rather loose Netscape protocol rules a little bit (at the cost of +blocking some benign cookies).

    +

    A domain blacklist and whitelist is provided (both off by default). Only domains +not in the blacklist and present in the whitelist (if the whitelist is active) +participate in cookie setting and returning. Use the blocked_domains +constructor argument, and blocked_domains() and +set_blocked_domains() methods (and the corresponding argument and methods +for allowed_domains). If you set a whitelist, you can turn it off again by +setting it to None.

    +

    Domains in block or allow lists that do not start with a dot must equal the +cookie domain to be matched. For example, "example.com" matches a blacklist +entry of "example.com", but "www.example.com" does not. Domains that do +start with a dot are matched by more specific domains too. For example, both +"www.example.com" and "www.coyote.example.com" match ".example.com" +(but "example.com" itself does not). IP addresses are an exception, and +must match exactly. For example, if blocked_domains contains "192.168.1.2" +and ".168.1.2", 192.168.1.2 is blocked, but 193.168.1.2 is not.

    +

    DefaultCookiePolicy implements the following additional methods:

    +
    +
    +DefaultCookiePolicy.blocked_domains()
    +

    Return the sequence of blocked domains (as a tuple).

    +
    + +
    +
    +DefaultCookiePolicy.set_blocked_domains(blocked_domains)
    +

    Set the sequence of blocked domains.

    +
    + +
    +
    +DefaultCookiePolicy.is_blocked(domain)
    +

    Return whether domain is on the blacklist for setting or receiving cookies.

    +
    + +
    +
    +DefaultCookiePolicy.allowed_domains()
    +

    Return None, or the sequence of allowed domains (as a tuple).

    +
    + +
    +
    +DefaultCookiePolicy.set_allowed_domains(allowed_domains)
    +

    Set the sequence of allowed domains, or None.

    +
    + +
    +
    +DefaultCookiePolicy.is_not_allowed(domain)
    +

    Return whether domain is not on the whitelist for setting or receiving +cookies.

    +
    + +

    DefaultCookiePolicy instances have the following attributes, which are +all initialised from the constructor arguments of the same name, and which may +all be assigned to.

    +
    +
    +DefaultCookiePolicy.rfc2109_as_netscape
    +

    If true, request that the CookieJar instance downgrade RFC 2109 cookies +(ie. cookies received in a Set-Cookie header with a version +cookie-attribute of 1) to Netscape cookies by setting the version attribute of +the Cookie instance to 0. The default value is None, in which +case RFC 2109 cookies are downgraded if and only if RFC 2965 handling is turned +off. Therefore, RFC 2109 cookies are downgraded by default.

    +
    + +

    General strictness switches:

    +
    +
    +DefaultCookiePolicy.strict_domain
    +

    Don’t allow sites to set two-component domains with country-code top-level +domains like .co.uk, .gov.uk, .co.nz.etc. This is far from perfect +and isn’t guaranteed to work!

    +
    + +

    RFC 2965 protocol strictness switches:

    +
    +
    +DefaultCookiePolicy.strict_rfc2965_unverifiable
    +

    Follow RFC 2965 rules on unverifiable transactions (usually, an unverifiable +transaction is one resulting from a redirect or a request for an image hosted on +another site). If this is false, cookies are never blocked on the basis of +verifiability

    +
    + +

    Netscape protocol strictness switches:

    +
    +
    +DefaultCookiePolicy.strict_ns_unverifiable
    +

    Apply RFC 2965 rules on unverifiable transactions even to Netscape cookies.

    +
    + +
    +
    +DefaultCookiePolicy.strict_ns_domain
    +

    Flags indicating how strict to be with domain-matching rules for Netscape +cookies. See below for acceptable values.

    +
    + +
    +
    +DefaultCookiePolicy.strict_ns_set_initial_dollar
    +

    Ignore cookies in Set-Cookie: headers that have names starting with '$'.

    +
    + +
    +
    +DefaultCookiePolicy.strict_ns_set_path
    +

    Don’t allow setting cookies whose path doesn’t path-match request URI.

    +
    + +

    strict_ns_domain is a collection of flags. Its value is constructed by +or-ing together (for example, DomainStrictNoDots|DomainStrictNonDomain means +both flags are set).

    +
    +
    +DefaultCookiePolicy.DomainStrictNoDots
    +

    When setting cookies, the ‘host prefix’ must not contain a dot (eg. +www.foo.bar.com can’t set a cookie for .bar.com, because www.foo +contains a dot).

    +
    + +
    +
    +DefaultCookiePolicy.DomainStrictNonDomain
    +

    Cookies that did not explicitly specify a domain cookie-attribute can only +be returned to a domain equal to the domain that set the cookie (eg. +spam.example.com won’t be returned cookies from example.com that had no +domain cookie-attribute).

    +
    + +
    +
    +DefaultCookiePolicy.DomainRFC2965Match
    +

    When setting cookies, require a full RFC 2965 domain-match.

    +
    + +

    The following attributes are provided for convenience, and are the most useful +combinations of the above flags:

    +
    +
    +DefaultCookiePolicy.DomainLiberal
    +

    Equivalent to 0 (ie. all of the above Netscape domain strictness flags switched +off).

    +
    + +
    +
    +DefaultCookiePolicy.DomainStrict
    +

    Equivalent to DomainStrictNoDots|DomainStrictNonDomain.

    +
    + +
    + +
    +

    Examples

    +

    The first example shows the most common usage of http.cookiejar:

    +
    import http.cookiejar, urllib.request
    +cj = http.cookiejar.CookieJar()
    +opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj))
    +r = opener.open("http://example.com/")
    +
    +
    +

    This example illustrates how to open a URL using your Netscape, Mozilla, or Lynx +cookies (assumes Unix/Netscape convention for location of the cookies file):

    +
    import os, http.cookiejar, urllib.request
    +cj = http.cookiejar.MozillaCookieJar()
    +cj.load(os.path.join(os.path.expanduser("~"), ".netscape", "cookies.txt"))
    +opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj))
    +r = opener.open("http://example.com/")
    +
    +
    +

    The next example illustrates the use of DefaultCookiePolicy. Turn on +RFC 2965 cookies, be more strict about domains when setting and returning +Netscape cookies, and block some domains from setting cookies or having them +returned:

    +
    import urllib.request
    +from http.cookiejar import CookieJar, DefaultCookiePolicy
    +policy = DefaultCookiePolicy(
    +    rfc2965=True, strict_ns_domain=Policy.DomainStrict,
    +    blocked_domains=["ads.net", ".ads.net"])
    +cj = CookieJar(policy)
    +opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj))
    +r = opener.open("http://example.com/")
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/http.cookies.html b/python-3.7.4-docs-html/library/http.cookies.html new file mode 100644 index 0000000..f467b30 --- /dev/null +++ b/python-3.7.4-docs-html/library/http.cookies.html @@ -0,0 +1,468 @@ + + + + + + + http.cookies — HTTP state management — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    http.cookies — HTTP state management

    +

    Source code: Lib/http/cookies.py

    +
    +

    The http.cookies module defines classes for abstracting the concept of +cookies, an HTTP state management mechanism. It supports both simple string-only +cookies, and provides an abstraction for having any serializable data-type as +cookie value.

    +

    The module formerly strictly applied the parsing rules described in the +RFC 2109 and RFC 2068 specifications. It has since been discovered that +MSIE 3.0x doesn’t follow the character rules outlined in those specs and also +many current day browsers and servers have relaxed parsing rules when comes to +Cookie handling. As a result, the parsing rules used are a bit less strict.

    +

    The character set, string.ascii_letters, string.digits and +!#$%&'*+-.^_`|~: denote the set of valid characters allowed by this module +in Cookie name (as key).

    +
    +

    Changed in version 3.3: Allowed ‘:’ as a valid Cookie name character.

    +
    +
    +

    Note

    +

    On encountering an invalid cookie, CookieError is raised, so if your +cookie data comes from a browser you should always prepare for invalid data +and catch CookieError on parsing.

    +
    +
    +
    +exception http.cookies.CookieError
    +

    Exception failing because of RFC 2109 invalidity: incorrect attributes, +incorrect Set-Cookie header, etc.

    +
    + +
    +
    +class http.cookies.BaseCookie([input])
    +

    This class is a dictionary-like object whose keys are strings and whose values +are Morsel instances. Note that upon setting a key to a value, the +value is first converted to a Morsel containing the key and the value.

    +

    If input is given, it is passed to the load() method.

    +
    + +
    +
    +class http.cookies.SimpleCookie([input])
    +

    This class derives from BaseCookie and overrides value_decode() +and value_encode(). SimpleCookie supports strings as cookie values. +When setting the value, SimpleCookie calls the builtin str() to convert +the value to a string. Values received from HTTP are kept as strings.

    +
    + +
    +

    See also

    +
    +
    Module http.cookiejar

    HTTP cookie handling for web clients. The http.cookiejar and +http.cookies modules do not depend on each other.

    +
    +
    RFC 2109 - HTTP State Management Mechanism

    This is the state management specification implemented by this module.

    +
    +
    +
    + +
    +

    Morsel Objects

    +
    +
    +class http.cookies.Morsel
    +

    Abstract a key/value pair, which has some RFC 2109 attributes.

    +

    Morsels are dictionary-like objects, whose set of keys is constant — the valid +RFC 2109 attributes, which are

    +
      +
    • expires

    • +
    • path

    • +
    • comment

    • +
    • domain

    • +
    • max-age

    • +
    • secure

    • +
    • version

    • +
    • httponly

    • +
    +

    The attribute httponly specifies that the cookie is only transferred +in HTTP requests, and is not accessible through JavaScript. This is intended +to mitigate some forms of cross-site scripting.

    +

    The keys are case-insensitive and their default value is ''.

    +
    +

    Changed in version 3.5: __eq__() now takes key and value +into account.

    +
    +
    +

    Changed in version 3.7: Attributes key, value and +coded_value are read-only. Use set() for +setting them.

    +
    +
    + +
    +
    +Morsel.value
    +

    The value of the cookie.

    +
    + +
    +
    +Morsel.coded_value
    +

    The encoded value of the cookie — this is what should be sent.

    +
    + +
    +
    +Morsel.key
    +

    The name of the cookie.

    +
    + +
    +
    +Morsel.set(key, value, coded_value)
    +

    Set the key, value and coded_value attributes.

    +
    + +
    +
    +Morsel.isReservedKey(K)
    +

    Whether K is a member of the set of keys of a Morsel.

    +
    + +
    +
    +Morsel.output(attrs=None, header='Set-Cookie:')
    +

    Return a string representation of the Morsel, suitable to be sent as an HTTP +header. By default, all the attributes are included, unless attrs is given, in +which case it should be a list of attributes to use. header is by default +"Set-Cookie:".

    +
    + +
    +
    +Morsel.js_output(attrs=None)
    +

    Return an embeddable JavaScript snippet, which, if run on a browser which +supports JavaScript, will act the same as if the HTTP header was sent.

    +

    The meaning for attrs is the same as in output().

    +
    + +
    +
    +Morsel.OutputString(attrs=None)
    +

    Return a string representing the Morsel, without any surrounding HTTP or +JavaScript.

    +

    The meaning for attrs is the same as in output().

    +
    + +
    +
    +Morsel.update(values)
    +

    Update the values in the Morsel dictionary with the values in the dictionary +values. Raise an error if any of the keys in the values dict is not a +valid RFC 2109 attribute.

    +
    +

    Changed in version 3.5: an error is raised for invalid keys.

    +
    +
    + +
    +
    +Morsel.copy(value)
    +

    Return a shallow copy of the Morsel object.

    +
    +

    Changed in version 3.5: return a Morsel object instead of a dict.

    +
    +
    + +
    +
    +Morsel.setdefault(key, value=None)
    +

    Raise an error if key is not a valid RFC 2109 attribute, otherwise +behave the same as dict.setdefault().

    +
    + +
    +
    +

    Example

    +

    The following example demonstrates how to use the http.cookies module.

    +
    >>> from http import cookies
    +>>> C = cookies.SimpleCookie()
    +>>> C["fig"] = "newton"
    +>>> C["sugar"] = "wafer"
    +>>> print(C) # generate HTTP headers
    +Set-Cookie: fig=newton
    +Set-Cookie: sugar=wafer
    +>>> print(C.output()) # same thing
    +Set-Cookie: fig=newton
    +Set-Cookie: sugar=wafer
    +>>> C = cookies.SimpleCookie()
    +>>> C["rocky"] = "road"
    +>>> C["rocky"]["path"] = "/cookie"
    +>>> print(C.output(header="Cookie:"))
    +Cookie: rocky=road; Path=/cookie
    +>>> print(C.output(attrs=[], header="Cookie:"))
    +Cookie: rocky=road
    +>>> C = cookies.SimpleCookie()
    +>>> C.load("chips=ahoy; vienna=finger") # load from a string (HTTP header)
    +>>> print(C)
    +Set-Cookie: chips=ahoy
    +Set-Cookie: vienna=finger
    +>>> C = cookies.SimpleCookie()
    +>>> C.load('keebler="E=everybody; L=\\"Loves\\"; fudge=\\012;";')
    +>>> print(C)
    +Set-Cookie: keebler="E=everybody; L=\"Loves\"; fudge=\012;"
    +>>> C = cookies.SimpleCookie()
    +>>> C["oreo"] = "doublestuff"
    +>>> C["oreo"]["path"] = "/"
    +>>> print(C)
    +Set-Cookie: oreo=doublestuff; Path=/
    +>>> C = cookies.SimpleCookie()
    +>>> C["twix"] = "none for you"
    +>>> C["twix"].value
    +'none for you'
    +>>> C = cookies.SimpleCookie()
    +>>> C["number"] = 7 # equivalent to C["number"] = str(7)
    +>>> C["string"] = "seven"
    +>>> C["number"].value
    +'7'
    +>>> C["string"].value
    +'seven'
    +>>> print(C)
    +Set-Cookie: number=7
    +Set-Cookie: string=seven
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/http.html b/python-3.7.4-docs-html/library/http.html new file mode 100644 index 0000000..ed423da --- /dev/null +++ b/python-3.7.4-docs-html/library/http.html @@ -0,0 +1,490 @@ + + + + + + + http — HTTP modules — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    http — HTTP modules

    +

    Source code: Lib/http/__init__.py

    +
    +

    http is a package that collects several modules for working with the +HyperText Transfer Protocol:

    + +

    http is also a module that defines a number of HTTP status codes and +associated messages through the http.HTTPStatus enum:

    +
    +
    +class http.HTTPStatus
    +
    +

    New in version 3.5.

    +
    +

    A subclass of enum.IntEnum that defines a set of HTTP status codes, +reason phrases and long descriptions written in English.

    +

    Usage:

    +
    >>> from http import HTTPStatus
    +>>> HTTPStatus.OK
    +<HTTPStatus.OK: 200>
    +>>> HTTPStatus.OK == 200
    +True
    +>>> http.HTTPStatus.OK.value
    +200
    +>>> HTTPStatus.OK.phrase
    +'OK'
    +>>> HTTPStatus.OK.description
    +'Request fulfilled, document follows'
    +>>> list(HTTPStatus)
    +[<HTTPStatus.CONTINUE: 100>, <HTTPStatus.SWITCHING_PROTOCOLS: 101>, ...]
    +
    +
    +
    + +
    +

    HTTP status codes

    +

    Supported, +IANA-registered +status codes available in http.HTTPStatus are:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Code

    Enum Name

    Details

    100

    CONTINUE

    HTTP/1.1 RFC 7231, Section 6.2.1

    101

    SWITCHING_PROTOCOLS

    HTTP/1.1 RFC 7231, Section 6.2.2

    102

    PROCESSING

    WebDAV RFC 2518, Section 10.1

    200

    OK

    HTTP/1.1 RFC 7231, Section 6.3.1

    201

    CREATED

    HTTP/1.1 RFC 7231, Section 6.3.2

    202

    ACCEPTED

    HTTP/1.1 RFC 7231, Section 6.3.3

    203

    NON_AUTHORITATIVE_INFORMATION

    HTTP/1.1 RFC 7231, Section 6.3.4

    204

    NO_CONTENT

    HTTP/1.1 RFC 7231, Section 6.3.5

    205

    RESET_CONTENT

    HTTP/1.1 RFC 7231, Section 6.3.6

    206

    PARTIAL_CONTENT

    HTTP/1.1 RFC 7233, Section 4.1

    207

    MULTI_STATUS

    WebDAV RFC 4918, Section 11.1

    208

    ALREADY_REPORTED

    WebDAV Binding Extensions RFC 5842, Section 7.1 (Experimental)

    226

    IM_USED

    Delta Encoding in HTTP RFC 3229, Section 10.4.1

    300

    MULTIPLE_CHOICES

    HTTP/1.1 RFC 7231, Section 6.4.1

    301

    MOVED_PERMANENTLY

    HTTP/1.1 RFC 7231, Section 6.4.2

    302

    FOUND

    HTTP/1.1 RFC 7231, Section 6.4.3

    303

    SEE_OTHER

    HTTP/1.1 RFC 7231, Section 6.4.4

    304

    NOT_MODIFIED

    HTTP/1.1 RFC 7232, Section 4.1

    305

    USE_PROXY

    HTTP/1.1 RFC 7231, Section 6.4.5

    307

    TEMPORARY_REDIRECT

    HTTP/1.1 RFC 7231, Section 6.4.7

    308

    PERMANENT_REDIRECT

    Permanent Redirect RFC 7238, Section 3 (Experimental)

    400

    BAD_REQUEST

    HTTP/1.1 RFC 7231, Section 6.5.1

    401

    UNAUTHORIZED

    HTTP/1.1 Authentication RFC 7235, Section 3.1

    402

    PAYMENT_REQUIRED

    HTTP/1.1 RFC 7231, Section 6.5.2

    403

    FORBIDDEN

    HTTP/1.1 RFC 7231, Section 6.5.3

    404

    NOT_FOUND

    HTTP/1.1 RFC 7231, Section 6.5.4

    405

    METHOD_NOT_ALLOWED

    HTTP/1.1 RFC 7231, Section 6.5.5

    406

    NOT_ACCEPTABLE

    HTTP/1.1 RFC 7231, Section 6.5.6

    407

    PROXY_AUTHENTICATION_REQUIRED

    HTTP/1.1 Authentication RFC 7235, Section 3.2

    408

    REQUEST_TIMEOUT

    HTTP/1.1 RFC 7231, Section 6.5.7

    409

    CONFLICT

    HTTP/1.1 RFC 7231, Section 6.5.8

    410

    GONE

    HTTP/1.1 RFC 7231, Section 6.5.9

    411

    LENGTH_REQUIRED

    HTTP/1.1 RFC 7231, Section 6.5.10

    412

    PRECONDITION_FAILED

    HTTP/1.1 RFC 7232, Section 4.2

    413

    REQUEST_ENTITY_TOO_LARGE

    HTTP/1.1 RFC 7231, Section 6.5.11

    414

    REQUEST_URI_TOO_LONG

    HTTP/1.1 RFC 7231, Section 6.5.12

    415

    UNSUPPORTED_MEDIA_TYPE

    HTTP/1.1 RFC 7231, Section 6.5.13

    416

    REQUESTED_RANGE_NOT_SATISFIABLE

    HTTP/1.1 Range Requests RFC 7233, Section 4.4

    417

    EXPECTATION_FAILED

    HTTP/1.1 RFC 7231, Section 6.5.14

    421

    MISDIRECTED_REQUEST

    HTTP/2 RFC 7540, Section 9.1.2

    422

    UNPROCESSABLE_ENTITY

    WebDAV RFC 4918, Section 11.2

    423

    LOCKED

    WebDAV RFC 4918, Section 11.3

    424

    FAILED_DEPENDENCY

    WebDAV RFC 4918, Section 11.4

    426

    UPGRADE_REQUIRED

    HTTP/1.1 RFC 7231, Section 6.5.15

    428

    PRECONDITION_REQUIRED

    Additional HTTP Status Codes RFC 6585

    429

    TOO_MANY_REQUESTS

    Additional HTTP Status Codes RFC 6585

    431

    REQUEST_HEADER_FIELDS_TOO_LARGE

    Additional HTTP Status Codes RFC 6585

    500

    INTERNAL_SERVER_ERROR

    HTTP/1.1 RFC 7231, Section 6.6.1

    501

    NOT_IMPLEMENTED

    HTTP/1.1 RFC 7231, Section 6.6.2

    502

    BAD_GATEWAY

    HTTP/1.1 RFC 7231, Section 6.6.3

    503

    SERVICE_UNAVAILABLE

    HTTP/1.1 RFC 7231, Section 6.6.4

    504

    GATEWAY_TIMEOUT

    HTTP/1.1 RFC 7231, Section 6.6.5

    505

    HTTP_VERSION_NOT_SUPPORTED

    HTTP/1.1 RFC 7231, Section 6.6.6

    506

    VARIANT_ALSO_NEGOTIATES

    Transparent Content Negotiation in HTTP RFC 2295, Section 8.1 (Experimental)

    507

    INSUFFICIENT_STORAGE

    WebDAV RFC 4918, Section 11.5

    508

    LOOP_DETECTED

    WebDAV Binding Extensions RFC 5842, Section 7.2 (Experimental)

    510

    NOT_EXTENDED

    An HTTP Extension Framework RFC 2774, Section 7 (Experimental)

    511

    NETWORK_AUTHENTICATION_REQUIRED

    Additional HTTP Status Codes RFC 6585, Section 6

    +

    In order to preserve backwards compatibility, enum values are also present +in the http.client module in the form of constants. The enum name is +equal to the constant name (i.e. http.HTTPStatus.OK is also available as +http.client.OK).

    +
    +

    Changed in version 3.7: Added 421 MISDIRECTED_REQUEST status code.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/http.server.html b/python-3.7.4-docs-html/library/http.server.html new file mode 100644 index 0000000..3cad6fc --- /dev/null +++ b/python-3.7.4-docs-html/library/http.server.html @@ -0,0 +1,710 @@ + + + + + + + http.server — HTTP servers — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    http.server — HTTP servers

    +

    Source code: Lib/http/server.py

    +
    +

    This module defines classes for implementing HTTP servers (Web servers).

    +
    +

    Warning

    +

    http.server is not recommended for production. It only implements +basic security checks.

    +
    +

    One class, HTTPServer, is a socketserver.TCPServer subclass. +It creates and listens at the HTTP socket, dispatching the requests to a +handler. Code to create and run the server looks like this:

    +
    def run(server_class=HTTPServer, handler_class=BaseHTTPRequestHandler):
    +    server_address = ('', 8000)
    +    httpd = server_class(server_address, handler_class)
    +    httpd.serve_forever()
    +
    +
    +
    +
    +class http.server.HTTPServer(server_address, RequestHandlerClass)
    +

    This class builds on the TCPServer class by storing +the server address as instance variables named server_name and +server_port. The server is accessible by the handler, typically +through the handler’s server instance variable.

    +
    + +
    +
    +class http.server.ThreadingHTTPServer(server_address, RequestHandlerClass)
    +

    This class is identical to HTTPServer but uses threads to handle +requests by using the ThreadingMixIn. This +is useful to handle web browsers pre-opening sockets, on which +HTTPServer would wait indefinitely.

    +
    +

    New in version 3.7.

    +
    +
    + +

    The HTTPServer and ThreadingHTTPServer must be given +a RequestHandlerClass on instantiation, of which this module +provides three different variants:

    +
    +
    +class http.server.BaseHTTPRequestHandler(request, client_address, server)
    +

    This class is used to handle the HTTP requests that arrive at the server. By +itself, it cannot respond to any actual HTTP requests; it must be subclassed +to handle each request method (e.g. GET or POST). +BaseHTTPRequestHandler provides a number of class and instance +variables, and methods for use by subclasses.

    +

    The handler will parse the request and the headers, then call a method +specific to the request type. The method name is constructed from the +request. For example, for the request method SPAM, the do_SPAM() +method will be called with no arguments. All of the relevant information is +stored in instance variables of the handler. Subclasses should not need to +override or extend the __init__() method.

    +

    BaseHTTPRequestHandler has the following instance variables:

    +
    +
    +client_address
    +

    Contains a tuple of the form (host, port) referring to the client’s +address.

    +
    + +
    +
    +server
    +

    Contains the server instance.

    +
    + +
    +
    +close_connection
    +

    Boolean that should be set before handle_one_request() returns, +indicating if another request may be expected, or if the connection should +be shut down.

    +
    + +
    +
    +requestline
    +

    Contains the string representation of the HTTP request line. The +terminating CRLF is stripped. This attribute should be set by +handle_one_request(). If no valid request line was processed, it +should be set to the empty string.

    +
    + +
    +
    +command
    +

    Contains the command (request type). For example, 'GET'.

    +
    + +
    +
    +path
    +

    Contains the request path.

    +
    + +
    +
    +request_version
    +

    Contains the version string from the request. For example, 'HTTP/1.0'.

    +
    + +
    +
    +headers
    +

    Holds an instance of the class specified by the MessageClass class +variable. This instance parses and manages the headers in the HTTP +request. The parse_headers() function from +http.client is used to parse the headers and it requires that the +HTTP request provide a valid RFC 2822 style header.

    +
    + +
    +
    +rfile
    +

    An io.BufferedIOBase input stream, ready to read from +the start of the optional input data.

    +
    + +
    +
    +wfile
    +

    Contains the output stream for writing a response back to the +client. Proper adherence to the HTTP protocol must be used when writing to +this stream in order to achieve successful interoperation with HTTP +clients.

    +
    +

    Changed in version 3.6: This is an io.BufferedIOBase stream.

    +
    +
    + +

    BaseHTTPRequestHandler has the following attributes:

    +
    +
    +server_version
    +

    Specifies the server software version. You may want to override this. The +format is multiple whitespace-separated strings, where each string is of +the form name[/version]. For example, 'BaseHTTP/0.2'.

    +
    + +
    +
    +sys_version
    +

    Contains the Python system version, in a form usable by the +version_string method and the server_version class +variable. For example, 'Python/1.4'.

    +
    + +
    +
    +error_message_format
    +

    Specifies a format string that should be used by send_error() method +for building an error response to the client. The string is filled by +default with variables from responses based on the status code +that passed to send_error().

    +
    + +
    +
    +error_content_type
    +

    Specifies the Content-Type HTTP header of error responses sent to the +client. The default value is 'text/html'.

    +
    + +
    +
    +protocol_version
    +

    This specifies the HTTP protocol version used in responses. If set to +'HTTP/1.1', the server will permit HTTP persistent connections; +however, your server must then include an accurate Content-Length +header (using send_header()) in all of its responses to clients. +For backwards compatibility, the setting defaults to 'HTTP/1.0'.

    +
    + +
    +
    +MessageClass
    +

    Specifies an email.message.Message-like class to parse HTTP +headers. Typically, this is not overridden, and it defaults to +http.client.HTTPMessage.

    +
    + +
    +
    +responses
    +

    This attribute contains a mapping of error code integers to two-element tuples +containing a short and long message. For example, {code: (shortmessage, +longmessage)}. The shortmessage is usually used as the message key in an +error response, and longmessage as the explain key. It is used by +send_response_only() and send_error() methods.

    +
    + +

    A BaseHTTPRequestHandler instance has the following methods:

    +
    +
    +handle()
    +

    Calls handle_one_request() once (or, if persistent connections are +enabled, multiple times) to handle incoming HTTP requests. You should +never need to override it; instead, implement appropriate do_*() +methods.

    +
    + +
    +
    +handle_one_request()
    +

    This method will parse and dispatch the request to the appropriate +do_*() method. You should never need to override it.

    +
    + +
    +
    +handle_expect_100()
    +

    When a HTTP/1.1 compliant server receives an Expect: 100-continue +request header it responds back with a 100 Continue followed by 200 +OK headers. +This method can be overridden to raise an error if the server does not +want the client to continue. For e.g. server can chose to send 417 +Expectation Failed as a response header and return False.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +send_error(code, message=None, explain=None)
    +

    Sends and logs a complete error reply to the client. The numeric code +specifies the HTTP error code, with message as an optional, short, human +readable description of the error. The explain argument can be used to +provide more detailed information about the error; it will be formatted +using the error_message_format attribute and emitted, after +a complete set of headers, as the response body. The responses +attribute holds the default values for message and explain that +will be used if no value is provided; for unknown codes the default value +for both is the string ???. The body will be empty if the method is +HEAD or the response code is one of the following: 1xx, +204 No Content, 205 Reset Content, 304 Not Modified.

    +
    +

    Changed in version 3.4: The error response includes a Content-Length header. +Added the explain argument.

    +
    +
    + +
    +
    +send_response(code, message=None)
    +

    Adds a response header to the headers buffer and logs the accepted +request. The HTTP response line is written to the internal buffer, +followed by Server and Date headers. The values for these two headers +are picked up from the version_string() and +date_time_string() methods, respectively. If the server does not +intend to send any other headers using the send_header() method, +then send_response() should be followed by an end_headers() +call.

    +
    +

    Changed in version 3.3: Headers are stored to an internal buffer and end_headers() +needs to be called explicitly.

    +
    +
    + +
    +
    +send_header(keyword, value)
    +

    Adds the HTTP header to an internal buffer which will be written to the +output stream when either end_headers() or flush_headers() is +invoked. keyword should specify the header keyword, with value +specifying its value. Note that, after the send_header calls are done, +end_headers() MUST BE called in order to complete the operation.

    +
    +

    Changed in version 3.2: Headers are stored in an internal buffer.

    +
    +
    + +
    +
    +send_response_only(code, message=None)
    +

    Sends the response header only, used for the purposes when 100 +Continue response is sent by the server to the client. The headers not +buffered and sent directly the output stream.If the message is not +specified, the HTTP message corresponding the response code is sent.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +end_headers()
    +

    Adds a blank line +(indicating the end of the HTTP headers in the response) +to the headers buffer and calls flush_headers().

    +
    +

    Changed in version 3.2: The buffered headers are written to the output stream.

    +
    +
    + +
    +
    +flush_headers()
    +

    Finally send the headers to the output stream and flush the internal +headers buffer.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +log_request(code='-', size='-')
    +

    Logs an accepted (successful) request. code should specify the numeric +HTTP code associated with the response. If a size of the response is +available, then it should be passed as the size parameter.

    +
    + +
    +
    +log_error(...)
    +

    Logs an error when a request cannot be fulfilled. By default, it passes +the message to log_message(), so it takes the same arguments +(format and additional values).

    +
    + +
    +
    +log_message(format, ...)
    +

    Logs an arbitrary message to sys.stderr. This is typically overridden +to create custom error logging mechanisms. The format argument is a +standard printf-style format string, where the additional arguments to +log_message() are applied as inputs to the formatting. The client +ip address and current date and time are prefixed to every message logged.

    +
    + +
    +
    +version_string()
    +

    Returns the server software’s version string. This is a combination of the +server_version and sys_version attributes.

    +
    + +
    +
    +date_time_string(timestamp=None)
    +

    Returns the date and time given by timestamp (which must be None or in +the format returned by time.time()), formatted for a message +header. If timestamp is omitted, it uses the current date and time.

    +

    The result looks like 'Sun, 06 Nov 1994 08:49:37 GMT'.

    +
    + +
    +
    +log_date_time_string()
    +

    Returns the current date and time, formatted for logging.

    +
    + +
    +
    +address_string()
    +

    Returns the client address.

    +
    +

    Changed in version 3.3: Previously, a name lookup was performed. To avoid name resolution +delays, it now always returns the IP address.

    +
    +
    + +
    + +
    +
    +class http.server.SimpleHTTPRequestHandler(request, client_address, server, directory=None)
    +

    This class serves files from the current directory and below, directly +mapping the directory structure to HTTP requests.

    +

    A lot of the work, such as parsing the request, is done by the base class +BaseHTTPRequestHandler. This class implements the do_GET() +and do_HEAD() functions.

    +

    The following are defined as class-level attributes of +SimpleHTTPRequestHandler:

    +
    +
    +server_version
    +

    This will be "SimpleHTTP/" + __version__, where __version__ is +defined at the module level.

    +
    + +
    +
    +extensions_map
    +

    A dictionary mapping suffixes into MIME types. The default is +signified by an empty string, and is considered to be +application/octet-stream. The mapping is used case-insensitively, +and so should contain only lower-cased keys.

    +
    + +
    +
    +directory
    +

    If not specified, the directory to serve is the current working directory.

    +
    + +

    The SimpleHTTPRequestHandler class defines the following methods:

    +
    +
    +do_HEAD()
    +

    This method serves the 'HEAD' request type: it sends the headers it +would send for the equivalent GET request. See the do_GET() +method for a more complete explanation of the possible headers.

    +
    + +
    +
    +do_GET()
    +

    The request is mapped to a local file by interpreting the request as a +path relative to the current working directory.

    +

    If the request was mapped to a directory, the directory is checked for a +file named index.html or index.htm (in that order). If found, the +file’s contents are returned; otherwise a directory listing is generated +by calling the list_directory() method. This method uses +os.listdir() to scan the directory, and returns a 404 error +response if the listdir() fails.

    +

    If the request was mapped to a file, it is opened. Any OSError +exception in opening the requested file is mapped to a 404, +'File not found' error. If there was a 'If-Modified-Since' +header in the request, and the file was not modified after this time, +a 304, 'Not Modified' response is sent. Otherwise, the content +type is guessed by calling the guess_type() method, which in turn +uses the extensions_map variable, and the file contents are returned.

    +

    A 'Content-type:' header with the guessed content type is output, +followed by a 'Content-Length:' header with the file’s size and a +'Last-Modified:' header with the file’s modification time.

    +

    Then follows a blank line signifying the end of the headers, and then the +contents of the file are output. If the file’s MIME type starts with +text/ the file is opened in text mode; otherwise binary mode is used.

    +

    For example usage, see the implementation of the test() function +invocation in the http.server module.

    +
    +

    Changed in version 3.7: Support of the 'If-Modified-Since' header.

    +
    +
    + +
    + +

    The SimpleHTTPRequestHandler class can be used in the following +manner in order to create a very basic webserver serving files relative to +the current directory:

    +
    import http.server
    +import socketserver
    +
    +PORT = 8000
    +
    +Handler = http.server.SimpleHTTPRequestHandler
    +
    +with socketserver.TCPServer(("", PORT), Handler) as httpd:
    +    print("serving at port", PORT)
    +    httpd.serve_forever()
    +
    +
    +

    http.server can also be invoked directly using the -m +switch of the interpreter with a port number argument. Similar to +the previous example, this serves files relative to the current directory:

    +
    python -m http.server 8000
    +
    +
    +

    By default, server binds itself to all interfaces. The option -b/--bind +specifies a specific address to which it should bind. For example, the +following command causes the server to bind to localhost only:

    +
    python -m http.server 8000 --bind 127.0.0.1
    +
    +
    +
    +

    New in version 3.4: --bind argument was introduced.

    +
    +

    By default, server uses the current directory. The option -d/--directory +specifies a directory to which it should serve the files. For example, +the following command uses a specific directory:

    +
    python -m http.server --directory /tmp/
    +
    +
    +
    +

    New in version 3.7: --directory specify alternate directory

    +
    +
    +
    +class http.server.CGIHTTPRequestHandler(request, client_address, server)
    +

    This class is used to serve either files or output of CGI scripts from the +current directory and below. Note that mapping HTTP hierarchic structure to +local directory structure is exactly as in SimpleHTTPRequestHandler.

    +
    +

    Note

    +

    CGI scripts run by the CGIHTTPRequestHandler class cannot execute +redirects (HTTP code 302), because code 200 (script output follows) is +sent prior to execution of the CGI script. This pre-empts the status +code.

    +
    +

    The class will however, run the CGI script, instead of serving it as a file, +if it guesses it to be a CGI script. Only directory-based CGI are used — +the other common server configuration is to treat special extensions as +denoting CGI scripts.

    +

    The do_GET() and do_HEAD() functions are modified to run CGI scripts +and serve the output, instead of serving files, if the request leads to +somewhere below the cgi_directories path.

    +

    The CGIHTTPRequestHandler defines the following data member:

    +
    +
    +cgi_directories
    +

    This defaults to ['/cgi-bin', '/htbin'] and describes directories to +treat as containing CGI scripts.

    +
    + +

    The CGIHTTPRequestHandler defines the following method:

    +
    +
    +do_POST()
    +

    This method serves the 'POST' request type, only allowed for CGI +scripts. Error 501, “Can only POST to CGI scripts”, is output when trying +to POST to a non-CGI url.

    +
    + +

    Note that CGI scripts will be run with UID of user nobody, for security +reasons. Problems with the CGI script will be translated to error 403.

    +
    + +

    CGIHTTPRequestHandler can be enabled in the command line by passing +the --cgi option:

    +
    python -m http.server --cgi 8000
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/i18n.html b/python-3.7.4-docs-html/library/i18n.html new file mode 100644 index 0000000..dcd0606 --- /dev/null +++ b/python-3.7.4-docs-html/library/i18n.html @@ -0,0 +1,215 @@ + + + + + + + Internationalization — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Internationalization

    +

    The modules described in this chapter help you write software that is +independent of language and locale by providing mechanisms for selecting a +language to be used in program messages or by tailoring output to match local +conventions.

    +

    The list of modules described in this chapter is:

    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/idle.html b/python-3.7.4-docs-html/library/idle.html new file mode 100644 index 0000000..7e62205 --- /dev/null +++ b/python-3.7.4-docs-html/library/idle.html @@ -0,0 +1,950 @@ + + + + + + + IDLE — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    IDLE

    +

    Source code: Lib/idlelib/

    +
    +

    IDLE is Python’s Integrated Development and Learning Environment.

    +

    IDLE has the following features:

    +
      +
    • coded in 100% pure Python, using the tkinter GUI toolkit

    • +
    • cross-platform: works mostly the same on Windows, Unix, and macOS

    • +
    • Python shell window (interactive interpreter) with colorizing +of code input, output, and error messages

    • +
    • multi-window text editor with multiple undo, Python colorizing, +smart indent, call tips, auto completion, and other features

    • +
    • search within any window, replace within editor windows, and search +through multiple files (grep)

    • +
    • debugger with persistent breakpoints, stepping, and viewing +of global and local namespaces

    • +
    • configuration, browsers, and other dialogs

    • +
    + +
    +

    Editing and navigation

    +
    +

    Editor windows

    +

    IDLE may open editor windows when it starts, depending on settings +and how you start IDLE. Thereafter, use the File menu. There can be only +one open editor window for a given file.

    +

    The title bar contains the name of the file, the full path, and the version +of Python and IDLE running the window. The status bar contains the line +number (‘Ln’) and column number (‘Col’). Line numbers start with 1; +column numbers with 0.

    +

    IDLE assumes that files with a known .py* extension contain Python code +and that other files do not. Run Python code with the Run menu.

    +
    +
    +

    Key bindings

    +

    In this section, ‘C’ refers to the Control key on Windows and Unix and +the Command key on macOS.

    +
      +
    • Backspace deletes to the left; Del deletes to the right

    • +
    • C-Backspace delete word left; C-Del delete word to the right

    • +
    • Arrow keys and Page Up/Page Down to move around

    • +
    • C-LeftArrow and C-RightArrow moves by words

    • +
    • Home/End go to begin/end of line

    • +
    • C-Home/C-End go to begin/end of file

    • +
    • Some useful Emacs bindings are inherited from Tcl/Tk:

      +
      +
        +
      • C-a beginning of line

      • +
      • C-e end of line

      • +
      • C-k kill line (but doesn’t put it in clipboard)

      • +
      • C-l center window around the insertion point

      • +
      • C-b go backward one character without deleting (usually you can +also use the cursor key for this)

      • +
      • C-f go forward one character without deleting (usually you can +also use the cursor key for this)

      • +
      • C-p go up one line (usually you can also use the cursor key for +this)

      • +
      • C-d delete next character

      • +
      +
      +
    • +
    +

    Standard keybindings (like C-c to copy and C-v to paste) +may work. Keybindings are selected in the Configure IDLE dialog.

    +
    +
    +

    Automatic indentation

    +

    After a block-opening statement, the next line is indented by 4 spaces (in the +Python Shell window by one tab). After certain keywords (break, return etc.) +the next line is dedented. In leading indentation, Backspace deletes up +to 4 spaces if they are there. Tab inserts spaces (in the Python +Shell window one tab), number depends on Indent width. Currently, tabs +are restricted to four spaces due to Tcl/Tk limitations.

    +

    See also the indent/dedent region commands on the +Format menu.

    +
    +
    +

    Completions

    +

    Completions are supplied for functions, classes, and attributes of classes, +both built-in and user-defined. Completions are also provided for +filenames.

    +

    The AutoCompleteWindow (ACW) will open after a predefined delay (default is +two seconds) after a ‘.’ or (in a string) an os.sep is typed. If after one +of those characters (plus zero or more other characters) a tab is typed +the ACW will open immediately if a possible continuation is found.

    +

    If there is only one possible completion for the characters entered, a +Tab will supply that completion without opening the ACW.

    +

    ‘Show Completions’ will force open a completions window, by default the +C-space will open a completions window. In an empty +string, this will contain the files in the current directory. On a +blank line, it will contain the built-in and user-defined functions and +classes in the current namespaces, plus any modules imported. If some +characters have been entered, the ACW will attempt to be more specific.

    +

    If a string of characters is typed, the ACW selection will jump to the +entry most closely matching those characters. Entering a tab will +cause the longest non-ambiguous match to be entered in the Editor window or +Shell. Two tab in a row will supply the current ACW selection, as +will return or a double click. Cursor keys, Page Up/Down, mouse selection, +and the scroll wheel all operate on the ACW.

    +

    “Hidden” attributes can be accessed by typing the beginning of hidden +name after a ‘.’, e.g. ‘_’. This allows access to modules with +__all__ set, or to class-private attributes.

    +

    Completions and the ‘Expand Word’ facility can save a lot of typing!

    +

    Completions are currently limited to those in the namespaces. Names in +an Editor window which are not via __main__ and sys.modules will +not be found. Run the module once with your imports to correct this situation. +Note that IDLE itself places quite a few modules in sys.modules, so +much can be found by default, e.g. the re module.

    +

    If you don’t like the ACW popping up unbidden, simply make the delay +longer or disable the extension.

    +
    +
    +

    Calltips

    +

    A calltip is shown when one types ( after the name of an accessible +function. A name expression may include dots and subscripts. A calltip +remains until it is clicked, the cursor is moved out of the argument area, +or ) is typed. When the cursor is in the argument part of a definition, +the menu or shortcut display a calltip.

    +

    A calltip consists of the function signature and the first line of the +docstring. For builtins without an accessible signature, the calltip +consists of all lines up the fifth line or the first blank line. These +details may change.

    +

    The set of accessible functions depends on what modules have been imported +into the user process, including those imported by Idle itself, +and what definitions have been run, all since the last restart.

    +

    For example, restart the Shell and enter itertools.count(. A calltip +appears because Idle imports itertools into the user process for its own use. +(This could change.) Enter turtle.write( and nothing appears. Idle does +not import turtle. The menu or shortcut do nothing either. Enter +import turtle and then turtle.write( will work.

    +

    In an editor, import statements have no effect until one runs the file. One +might want to run a file after writing the import statements at the top, +or immediately run an existing file before editing.

    +
    +
    +

    Code Context

    +

    Within an editor window containing Python code, code context can be toggled +in order to show or hide a pane at the top of the window. When shown, this +pane freezes the opening lines for block code, such as those beginning with +class, def, or if keywords, that would have otherwise scrolled +out of view. The size of the pane will be expanded and contracted as needed +to show the all current levels of context, up to the maximum number of +lines defined in the Configure IDLE dialog (which defaults to 15). If there +are no current context lines and the feature is toggled on, a single blank +line will display. Clicking on a line in the context pane will move that +line to the top of the editor.

    +

    The text and background colors for the context pane can be configured under +the Highlights tab in the Configure IDLE dialog.

    +
    +
    +

    Python Shell window

    +

    With IDLE’s Shell, one enters, edits, and recalls complete statements. +Most consoles and terminals only work with a single physical line at a time.

    +

    When one pastes code into Shell, it is not compiled and possibly executed +until one hits Return. One may edit pasted code first. +If one pastes more that one statement into Shell, the result will be a +SyntaxError when multiple statements are compiled as if they were one.

    +

    The editing features described in previous subsections work when entering +code interactively. IDLE’s Shell window also responds to the following keys.

    +
      +
    • C-c interrupts executing command

    • +
    • C-d sends end-of-file; closes window if typed at a >>> prompt

    • +
    • Alt-/ (Expand word) is also useful to reduce typing

      +

      Command history

      +
        +
      • Alt-p retrieves previous command matching what you have typed. On +macOS use C-p.

      • +
      • Alt-n retrieves next. On macOS use C-n.

      • +
      • Return while on any previous command retrieves that command

      • +
      +
    • +
    +
    +
    +

    Text colors

    +

    Idle defaults to black on white text, but colors text with special meanings. +For the shell, these are shell output, shell error, user output, and +user error. For Python code, at the shell prompt or in an editor, these are +keywords, builtin class and function names, names following class and +def, strings, and comments. For any text window, these are the cursor (when +present), found text (when possible), and selected text.

    +

    Text coloring is done in the background, so uncolorized text is occasionally +visible. To change the color scheme, use the Configure IDLE dialog +Highlighting tab. The marking of debugger breakpoint lines in the editor and +text in popups and dialogs is not user-configurable.

    +
    +
    +
    +

    Startup and code execution

    +

    Upon startup with the -s option, IDLE will execute the file referenced by +the environment variables IDLESTARTUP or PYTHONSTARTUP. +IDLE first checks for IDLESTARTUP; if IDLESTARTUP is present the file +referenced is run. If IDLESTARTUP is not present, IDLE checks for +PYTHONSTARTUP. Files referenced by these environment variables are +convenient places to store functions that are used frequently from the IDLE +shell, or for executing import statements to import common modules.

    +

    In addition, Tk also loads a startup file if it is present. Note that the +Tk file is loaded unconditionally. This additional file is .Idle.py and is +looked for in the user’s home directory. Statements in this file will be +executed in the Tk namespace, so this file is not useful for importing +functions to be used from IDLE’s Python shell.

    +
    +

    Command line usage

    +
    idle.py [-c command] [-d] [-e] [-h] [-i] [-r file] [-s] [-t title] [-] [arg] ...
    +
    +-c command  run command in the shell window
    +-d          enable debugger and open shell window
    +-e          open editor window
    +-h          print help message with legal combinations and exit
    +-i          open shell window
    +-r file     run file in shell window
    +-s          run $IDLESTARTUP or $PYTHONSTARTUP first, in shell window
    +-t title    set title of shell window
    +-           run stdin in shell (- must be last option before args)
    +
    +
    +

    If there are arguments:

    +
      +
    • If -, -c, or r is used, all arguments are placed in +sys.argv[1:...] and sys.argv[0] is set to '', '-c', +or '-r'. No editor window is opened, even if that is the default +set in the Options dialog.

    • +
    • Otherwise, arguments are files opened for editing and +sys.argv reflects the arguments passed to IDLE itself.

    • +
    +
    +
    +

    Startup failure

    +

    IDLE uses a socket to communicate between the IDLE GUI process and the user +code execution process. A connection must be established whenever the Shell +starts or restarts. (The latter is indicated by a divider line that says +‘RESTART’). If the user process fails to connect to the GUI process, it +displays a Tk error box with a ‘cannot connect’ message that directs the +user here. It then exits.

    +

    A common cause of failure is a user-written file with the same name as a +standard library module, such as random.py and tkinter.py. When such a +file is located in the same directory as a file that is about to be run, +IDLE cannot import the stdlib file. The current fix is to rename the +user file.

    +

    Though less common than in the past, an antivirus or firewall program may +stop the connection. If the program cannot be taught to allow the +connection, then it must be turned off for IDLE to work. It is safe to +allow this internal connection because no data is visible on external +ports. A similar problem is a network mis-configuration that blocks +connections.

    +

    Python installation issues occasionally stop IDLE: multiple versions can +clash, or a single installation might need admin access. If one undo the +clash, or cannot or does not want to run as admin, it might be easiest to +completely remove Python and start over.

    +

    A zombie pythonw.exe process could be a problem. On Windows, use Task +Manager to detect and stop one. Sometimes a restart initiated by a program +crash or Keyboard Interrupt (control-C) may fail to connect. Dismissing +the error box or Restart Shell on the Shell menu may fix a temporary problem.

    +

    When IDLE first starts, it attempts to read user configuration files in +~/.idlerc/ (~ is one’s home directory). If there is a problem, an error +message should be displayed. Leaving aside random disk glitches, this can +be prevented by never editing the files by hand, using the configuration +dialog, under Options, instead Options. Once it happens, the solution may +be to delete one or more of the configuration files.

    +

    If IDLE quits with no message, and it was not started from a console, try +starting from a console (python -m idlelib) and see if a message appears.

    +
    +
    +

    Running user code

    +

    With rare exceptions, the result of executing Python code with IDLE is +intended to be the same as executing the same code by the default method, +directly with Python in a text-mode system console or terminal window. +However, the different interface and operation occasionally affect +visible results. For instance, sys.modules starts with more entries, +and threading.activeCount() returns 2 instead of 1.

    +

    By default, IDLE runs user code in a separate OS process rather than in +the user interface process that runs the shell and editor. In the execution +process, it replaces sys.stdin, sys.stdout, and sys.stderr +with objects that get input from and send output to the Shell window. +The original values stored in sys.__stdin__, sys.__stdout__, and +sys.__stderr__ are not touched, but may be None.

    +

    When Shell has the focus, it controls the keyboard and screen. This is +normally transparent, but functions that directly access the keyboard +and screen will not work. These include system-specific functions that +determine whether a key has been pressed and if so, which.

    +

    IDLE’s standard stream replacements are not inherited by subprocesses +created in the execution process, whether directly by user code or by modules +such as multiprocessing. If such subprocess use input from sys.stdin +or print or write to sys.stdout or sys.stderr, +IDLE should be started in a command line window. The secondary subprocess +will then be attached to that window for input and output.

    +

    The IDLE code running in the execution process adds frames to the call stack +that would not be there otherwise. IDLE wraps sys.getrecursionlimit and +sys.setrecursionlimit to reduce the effect of the additional stack frames.

    +

    If sys is reset by user code, such as with importlib.reload(sys), +IDLE’s changes are lost and input from the keyboard and output to the screen +will not work correctly.

    +

    When user code raises SystemExit either directly or by calling sys.exit, IDLE +returns to a Shell prompt instead of exiting.

    +
    +
    +

    User output in Shell

    +

    When a program outputs text, the result is determined by the +corresponding output device. When IDLE executes user code, sys.stdout +and sys.stderr are connected to the display area of IDLE’s Shell. Some of +its features are inherited from the underlying Tk Text widget. Others +are programmed additions. Where it matters, Shell is designed for development +rather than production runs.

    +

    For instance, Shell never throws away output. A program that sends unlimited +output to Shell will eventually fill memory, resulting in a memory error. +In contrast, some system text windows only keep the last n lines of output. +A Windows console, for instance, keeps a user-settable 1 to 9999 lines, +with 300 the default.

    +

    A Tk Text widget, and hence IDLE’s Shell, displays characters (codepoints) in +the BMP (Basic Multilingual Plane) subset of Unicode. Which characters are +displayed with a proper glyph and which with a replacement box depends on the +operating system and installed fonts. Tab characters cause the following text +to begin after the next tab stop. (They occur every 8 ‘characters’). Newline +characters cause following text to appear on a new line. Other control +characters are ignored or displayed as a space, box, or something else, +depending on the operating system and font. (Moving the text cursor through +such output with arrow keys may exhibit some surprising spacing behavior.)

    +
    >>> s = 'a\tb\a<\x02><\r>\bc\nd'  # Enter 22 chars.
    +>>> len(s)
    +14
    +>>> s  # Display repr(s)
    +'a\tb\x07<\x02><\r>\x08c\nd'
    +>>> print(s, end='')  # Display s as is.
    +# Result varies by OS and font.  Try it.
    +
    +
    +

    The repr function is used for interactive echo of expression +values. It returns an altered version of the input string in which +control codes, some BMP codepoints, and all non-BMP codepoints are +replaced with escape codes. As demonstrated above, it allows one to +identify the characters in a string, regardless of how they are displayed.

    +

    Normal and error output are generally kept separate (on separate lines) +from code input and each other. They each get different highlight colors.

    +

    For SyntaxError tracebacks, the normal ‘^’ marking where the error was +detected is replaced by coloring the text with an error highlight. +When code run from a file causes other exceptions, one may right click +on a traceback line to jump to the corresponding line in an IDLE editor. +The file will be opened if necessary.

    +

    Shell has a special facility for squeezing output lines down to a +‘Squeezed text’ label. This is done automatically +for output over N lines (N = 50 by default). +N can be changed in the PyShell section of the General +page of the Settings dialog. Output with fewer lines can be squeezed by +right clicking on the output. This can be useful lines long enough to slow +down scrolling.

    +

    Squeezed output is expanded in place by double-clicking the label. +It can also be sent to the clipboard or a separate view window by +right-clicking the label.

    +
    +
    +

    Developing tkinter applications

    +

    IDLE is intentionally different from standard Python in order to +facilitate development of tkinter programs. Enter import tkinter as tk; +root = tk.Tk() in standard Python and nothing appears. Enter the same +in IDLE and a tk window appears. In standard Python, one must also enter +root.update() to see the window. IDLE does the equivalent in the +background, about 20 times a second, which is about every 50 milliseconds. +Next enter b = tk.Button(root, text='button'); b.pack(). Again, +nothing visibly changes in standard Python until one enters root.update().

    +

    Most tkinter programs run root.mainloop(), which usually does not +return until the tk app is destroyed. If the program is run with +python -i or from an IDLE editor, a >>> shell prompt does not +appear until mainloop() returns, at which time there is nothing left +to interact with.

    +

    When running a tkinter program from an IDLE editor, one can comment out +the mainloop call. One then gets a shell prompt immediately and can +interact with the live application. One just has to remember to +re-enable the mainloop call when running in standard Python.

    +
    +
    +

    Running without a subprocess

    +

    By default, IDLE executes user code in a separate subprocess via a socket, +which uses the internal loopback interface. This connection is not +externally visible and no data is sent to or received from the Internet. +If firewall software complains anyway, you can ignore it.

    +

    If the attempt to make the socket connection fails, Idle will notify you. +Such failures are sometimes transient, but if persistent, the problem +may be either a firewall blocking the connection or misconfiguration of +a particular system. Until the problem is fixed, one can run Idle with +the -n command line switch.

    +

    If IDLE is started with the -n command line switch it will run in a +single process and will not create the subprocess which runs the RPC +Python execution server. This can be useful if Python cannot create +the subprocess or the RPC socket interface on your platform. However, +in this mode user code is not isolated from IDLE itself. Also, the +environment is not restarted when Run/Run Module (F5) is selected. If +your code has been modified, you must reload() the affected modules and +re-import any specific items (e.g. from foo import baz) if the changes +are to take effect. For these reasons, it is preferable to run IDLE +with the default subprocess if at all possible.

    +
    +

    Deprecated since version 3.4.

    +
    +
    +
    +
    +

    Help and preferences

    +
    +

    Help sources

    +

    Help menu entry “IDLE Help” displays a formatted html version of the +IDLE chapter of the Library Reference. The result, in a read-only +tkinter text window, is close to what one sees in a web browser. +Navigate through the text with a mousewheel, +the scrollbar, or up and down arrow keys held down. +Or click the TOC (Table of Contents) button and select a section +header in the opened box.

    +

    Help menu entry “Python Docs” opens the extensive sources of help, +including tutorials, available at docs.python.org/x.y, where ‘x.y’ +is the currently running Python version. If your system +has an off-line copy of the docs (this may be an installation option), +that will be opened instead.

    +

    Selected URLs can be added or removed from the help menu at any time using the +General tab of the Configure IDLE dialog .

    +
    +
    +

    Setting preferences

    +

    The font preferences, highlighting, keys, and general preferences can be +changed via Configure IDLE on the Option menu. +Non-default user settings are saved in a .idlerc directory in the user’s +home directory. Problems caused by bad user configuration files are solved +by editing or deleting one or more of the files in .idlerc.

    +

    On the Font tab, see the text sample for the effect of font face and size +on multiple characters in multiple languages. Edit the sample to add +other characters of personal interest. Use the sample to select +monospaced fonts. If particular characters have problems in Shell or an +editor, add them to the top of the sample and try changing first size +and then font.

    +

    On the Highlights and Keys tab, select a built-in or custom color theme +and key set. To use a newer built-in color theme or key set with older +IDLEs, save it as a new custom theme or key set and it well be accessible +to older IDLEs.

    +
    +
    +

    IDLE on macOS

    +

    Under System Preferences: Dock, one can set “Prefer tabs when opening +documents” to “Always”. This setting is not compatible with the tk/tkinter +GUI framework used by IDLE, and it breaks a few IDLE features.

    +
    +
    +

    Extensions

    +

    IDLE contains an extension facility. Preferences for extensions can be +changed with the Extensions tab of the preferences dialog. See the +beginning of config-extensions.def in the idlelib directory for further +information. The only current default extension is zzdummy, an example +also used for testing.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/imaplib.html b/python-3.7.4-docs-html/library/imaplib.html new file mode 100644 index 0000000..ca77822 --- /dev/null +++ b/python-3.7.4-docs-html/library/imaplib.html @@ -0,0 +1,812 @@ + + + + + + + imaplib — IMAP4 protocol client — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    imaplib — IMAP4 protocol client

    +

    Source code: Lib/imaplib.py

    +
    +

    This module defines three classes, IMAP4, IMAP4_SSL and +IMAP4_stream, which encapsulate a connection to an IMAP4 server and +implement a large subset of the IMAP4rev1 client protocol as defined in +RFC 2060. It is backward compatible with IMAP4 (RFC 1730) servers, but +note that the STATUS command is not supported in IMAP4.

    +

    Three classes are provided by the imaplib module, IMAP4 is the +base class:

    +
    +
    +class imaplib.IMAP4(host='', port=IMAP4_PORT)
    +

    This class implements the actual IMAP4 protocol. The connection is created and +protocol version (IMAP4 or IMAP4rev1) is determined when the instance is +initialized. If host is not specified, '' (the local host) is used. If +port is omitted, the standard IMAP4 port (143) is used.

    +

    The IMAP4 class supports the with statement. When used +like this, the IMAP4 LOGOUT command is issued automatically when the +with statement exits. E.g.:

    +
    >>> from imaplib import IMAP4
    +>>> with IMAP4("domain.org") as M:
    +...     M.noop()
    +...
    +('OK', [b'Nothing Accomplished. d25if65hy903weo.87'])
    +
    +
    +
    +

    Changed in version 3.5: Support for the with statement was added.

    +
    +
    + +

    Three exceptions are defined as attributes of the IMAP4 class:

    +
    +
    +exception IMAP4.error
    +

    Exception raised on any errors. The reason for the exception is passed to the +constructor as a string.

    +
    + +
    +
    +exception IMAP4.abort
    +

    IMAP4 server errors cause this exception to be raised. This is a sub-class of +IMAP4.error. Note that closing the instance and instantiating a new one +will usually allow recovery from this exception.

    +
    + +
    +
    +exception IMAP4.readonly
    +

    This exception is raised when a writable mailbox has its status changed by the +server. This is a sub-class of IMAP4.error. Some other client now has +write permission, and the mailbox will need to be re-opened to re-obtain write +permission.

    +
    + +

    There’s also a subclass for secure connections:

    +
    +
    +class imaplib.IMAP4_SSL(host='', port=IMAP4_SSL_PORT, keyfile=None, certfile=None, ssl_context=None)
    +

    This is a subclass derived from IMAP4 that connects over an SSL +encrypted socket (to use this class you need a socket module that was compiled +with SSL support). If host is not specified, '' (the local host) is used. +If port is omitted, the standard IMAP4-over-SSL port (993) is used. +ssl_context is a ssl.SSLContext object which allows bundling +SSL configuration options, certificates and private keys into a single +(potentially long-lived) structure. Please read Security considerations for +best practices.

    +

    keyfile and certfile are a legacy alternative to ssl_context - they +can point to PEM-formatted private key and certificate chain files for +the SSL connection. Note that the keyfile/certfile parameters are +mutually exclusive with ssl_context, a ValueError is raised +if keyfile/certfile is provided along with ssl_context.

    +
    +

    Changed in version 3.3: ssl_context parameter added.

    +
    +
    +

    Changed in version 3.4: The class now supports hostname check with +ssl.SSLContext.check_hostname and Server Name Indication (see +ssl.HAS_SNI).

    +
    +
    +

    Deprecated since version 3.6: keyfile and certfile are deprecated in favor of ssl_context. +Please use ssl.SSLContext.load_cert_chain() instead, or let +ssl.create_default_context() select the system’s trusted CA +certificates for you.

    +
    +
    + +

    The second subclass allows for connections created by a child process:

    +
    +
    +class imaplib.IMAP4_stream(command)
    +

    This is a subclass derived from IMAP4 that connects to the +stdin/stdout file descriptors created by passing command to +subprocess.Popen().

    +
    + +

    The following utility functions are defined:

    +
    +
    +imaplib.Internaldate2tuple(datestr)
    +

    Parse an IMAP4 INTERNALDATE string and return corresponding local +time. The return value is a time.struct_time tuple or +None if the string has wrong format.

    +
    + +
    +
    +imaplib.Int2AP(num)
    +

    Converts an integer into a string representation using characters from the set +[A .. P].

    +
    + +
    +
    +imaplib.ParseFlags(flagstr)
    +

    Converts an IMAP4 FLAGS response to a tuple of individual flags.

    +
    + +
    +
    +imaplib.Time2Internaldate(date_time)
    +

    Convert date_time to an IMAP4 INTERNALDATE representation. +The return value is a string in the form: "DD-Mmm-YYYY HH:MM:SS ++HHMM" (including double-quotes). The date_time argument can +be a number (int or float) representing seconds since epoch (as +returned by time.time()), a 9-tuple representing local time +an instance of time.struct_time (as returned by +time.localtime()), an aware instance of +datetime.datetime, or a double-quoted string. In the last +case, it is assumed to already be in the correct format.

    +
    + +

    Note that IMAP4 message numbers change as the mailbox changes; in particular, +after an EXPUNGE command performs deletions the remaining messages are +renumbered. So it is highly advisable to use UIDs instead, with the UID command.

    +

    At the end of the module, there is a test section that contains a more extensive +example of usage.

    +
    +

    See also

    +

    Documents describing the protocol, and sources and binaries for servers +implementing it, can all be found at the University of Washington’s IMAP +Information Center (https://www.washington.edu/imap/).

    +
    +
    +

    IMAP4 Objects

    +

    All IMAP4rev1 commands are represented by methods of the same name, either +upper-case or lower-case.

    +

    All arguments to commands are converted to strings, except for AUTHENTICATE, +and the last argument to APPEND which is passed as an IMAP4 literal. If +necessary (the string contains IMAP4 protocol-sensitive characters and isn’t +enclosed with either parentheses or double quotes) each string is quoted. +However, the password argument to the LOGIN command is always quoted. If +you want to avoid having an argument string quoted (eg: the flags argument to +STORE) then enclose the string in parentheses (eg: r'(\Deleted)').

    +

    Each command returns a tuple: (type, [data, ...]) where type is usually +'OK' or 'NO', and data is either the text from the command response, +or mandated results from the command. Each data is either a string, or a +tuple. If a tuple, then the first part is the header of the response, and the +second part contains the data (ie: ‘literal’ value).

    +

    The message_set options to commands below is a string specifying one or more +messages to be acted upon. It may be a simple message number ('1'), a range +of message numbers ('2:4'), or a group of non-contiguous ranges separated by +commas ('1:3,6:9'). A range can contain an asterisk to indicate an infinite +upper bound ('3:*').

    +

    An IMAP4 instance has the following methods:

    +
    +
    +IMAP4.append(mailbox, flags, date_time, message)
    +

    Append message to named mailbox.

    +
    + +
    +
    +IMAP4.authenticate(mechanism, authobject)
    +

    Authenticate command — requires response processing.

    +

    mechanism specifies which authentication mechanism is to be used - it should +appear in the instance variable capabilities in the form AUTH=mechanism.

    +

    authobject must be a callable object:

    +
    data = authobject(response)
    +
    +
    +

    It will be called to process server continuation responses; the response +argument it is passed will be bytes. It should return bytes data +that will be base64 encoded and sent to the server. It should return +None if the client abort response * should be sent instead.

    +
    +

    Changed in version 3.5: string usernames and passwords are now encoded to utf-8 instead of +being limited to ASCII.

    +
    +
    + +
    +
    +IMAP4.check()
    +

    Checkpoint mailbox on server.

    +
    + +
    +
    +IMAP4.close()
    +

    Close currently selected mailbox. Deleted messages are removed from writable +mailbox. This is the recommended command before LOGOUT.

    +
    + +
    +
    +IMAP4.copy(message_set, new_mailbox)
    +

    Copy message_set messages onto end of new_mailbox.

    +
    + +
    +
    +IMAP4.create(mailbox)
    +

    Create new mailbox named mailbox.

    +
    + +
    +
    +IMAP4.delete(mailbox)
    +

    Delete old mailbox named mailbox.

    +
    + +
    +
    +IMAP4.deleteacl(mailbox, who)
    +

    Delete the ACLs (remove any rights) set for who on mailbox.

    +
    + +
    +
    +IMAP4.enable(capability)
    +

    Enable capability (see RFC 5161). Most capabilities do not need to be +enabled. Currently only the UTF8=ACCEPT capability is supported +(see RFC 6855).

    +
    +

    New in version 3.5: The enable() method itself, and RFC 6855 support.

    +
    +
    + +
    +
    +IMAP4.expunge()
    +

    Permanently remove deleted items from selected mailbox. Generates an EXPUNGE +response for each deleted message. Returned data contains a list of EXPUNGE +message numbers in order received.

    +
    + +
    +
    +IMAP4.fetch(message_set, message_parts)
    +

    Fetch (parts of) messages. message_parts should be a string of message part +names enclosed within parentheses, eg: "(UID BODY[TEXT])". Returned data +are tuples of message part envelope and data.

    +
    + +
    +
    +IMAP4.getacl(mailbox)
    +

    Get the ACLs for mailbox. The method is non-standard, but is supported +by the Cyrus server.

    +
    + +
    +
    +IMAP4.getannotation(mailbox, entry, attribute)
    +

    Retrieve the specified ANNOTATIONs for mailbox. The method is +non-standard, but is supported by the Cyrus server.

    +
    + +
    +
    +IMAP4.getquota(root)
    +

    Get the quota root’s resource usage and limits. This method is part of the +IMAP4 QUOTA extension defined in rfc2087.

    +
    + +
    +
    +IMAP4.getquotaroot(mailbox)
    +

    Get the list of quota roots for the named mailbox. This method is part +of the IMAP4 QUOTA extension defined in rfc2087.

    +
    + +
    +
    +IMAP4.list([directory[, pattern]])
    +

    List mailbox names in directory matching pattern. directory defaults to +the top-level mail folder, and pattern defaults to match anything. Returned +data contains a list of LIST responses.

    +
    + +
    +
    +IMAP4.login(user, password)
    +

    Identify the client using a plaintext password. The password will be quoted.

    +
    + +
    +
    +IMAP4.login_cram_md5(user, password)
    +

    Force use of CRAM-MD5 authentication when identifying the client to protect +the password. Will only work if the server CAPABILITY response includes the +phrase AUTH=CRAM-MD5.

    +
    + +
    +
    +IMAP4.logout()
    +

    Shutdown connection to server. Returns server BYE response.

    +
    + +
    +
    +IMAP4.lsub(directory='""', pattern='*')
    +

    List subscribed mailbox names in directory matching pattern. directory +defaults to the top level directory and pattern defaults to match any mailbox. +Returned data are tuples of message part envelope and data.

    +
    + +
    +
    +IMAP4.myrights(mailbox)
    +

    Show my ACLs for a mailbox (i.e. the rights that I have on mailbox).

    +
    + +
    +
    +IMAP4.namespace()
    +

    Returns IMAP namespaces as defined in RFC 2342.

    +
    + +
    +
    +IMAP4.noop()
    +

    Send NOOP to server.

    +
    + +
    +
    +IMAP4.open(host, port)
    +

    Opens socket to port at host. This method is implicitly called by +the IMAP4 constructor. The connection objects established by this +method will be used in the IMAP4.read(), IMAP4.readline(), +IMAP4.send(), and IMAP4.shutdown() methods. You may override +this method.

    +
    + +
    +
    +IMAP4.partial(message_num, message_part, start, length)
    +

    Fetch truncated part of a message. Returned data is a tuple of message part +envelope and data.

    +
    + +
    +
    +IMAP4.proxyauth(user)
    +

    Assume authentication as user. Allows an authorised administrator to proxy +into any user’s mailbox.

    +
    + +
    +
    +IMAP4.read(size)
    +

    Reads size bytes from the remote server. You may override this method.

    +
    + +
    +
    +IMAP4.readline()
    +

    Reads one line from the remote server. You may override this method.

    +
    + +
    +
    +IMAP4.recent()
    +

    Prompt server for an update. Returned data is None if no new messages, else +value of RECENT response.

    +
    + +
    +
    +IMAP4.rename(oldmailbox, newmailbox)
    +

    Rename mailbox named oldmailbox to newmailbox.

    +
    + +
    +
    +IMAP4.response(code)
    +

    Return data for response code if received, or None. Returns the given +code, instead of the usual type.

    +
    + +
    +
    +IMAP4.search(charset, criterion[, ...])
    +

    Search mailbox for matching messages. charset may be None, in which case +no CHARSET will be specified in the request to the server. The IMAP +protocol requires that at least one criterion be specified; an exception will be +raised when the server returns an error. charset must be None if +the UTF8=ACCEPT capability was enabled using the enable() +command.

    +

    Example:

    +
    # M is a connected IMAP4 instance...
    +typ, msgnums = M.search(None, 'FROM', '"LDJ"')
    +
    +# or:
    +typ, msgnums = M.search(None, '(FROM "LDJ")')
    +
    +
    +
    + +
    +
    +IMAP4.select(mailbox='INBOX', readonly=False)
    +

    Select a mailbox. Returned data is the count of messages in mailbox +(EXISTS response). The default mailbox is 'INBOX'. If the readonly +flag is set, modifications to the mailbox are not allowed.

    +
    + +
    +
    +IMAP4.send(data)
    +

    Sends data to the remote server. You may override this method.

    +
    + +
    +
    +IMAP4.setacl(mailbox, who, what)
    +

    Set an ACL for mailbox. The method is non-standard, but is supported by +the Cyrus server.

    +
    + +
    +
    +IMAP4.setannotation(mailbox, entry, attribute[, ...])
    +

    Set ANNOTATIONs for mailbox. The method is non-standard, but is +supported by the Cyrus server.

    +
    + +
    +
    +IMAP4.setquota(root, limits)
    +

    Set the quota root’s resource limits. This method is part of the IMAP4 +QUOTA extension defined in rfc2087.

    +
    + +
    +
    +IMAP4.shutdown()
    +

    Close connection established in open. This method is implicitly +called by IMAP4.logout(). You may override this method.

    +
    + +
    +
    +IMAP4.socket()
    +

    Returns socket instance used to connect to server.

    +
    + +
    +
    +IMAP4.sort(sort_criteria, charset, search_criterion[, ...])
    +

    The sort command is a variant of search with sorting semantics for the +results. Returned data contains a space separated list of matching message +numbers.

    +

    Sort has two arguments before the search_criterion argument(s); a +parenthesized list of sort_criteria, and the searching charset. Note that +unlike search, the searching charset argument is mandatory. There is also +a uid sort command which corresponds to sort the way that uid search +corresponds to search. The sort command first searches the mailbox for +messages that match the given searching criteria using the charset argument for +the interpretation of strings in the searching criteria. It then returns the +numbers of matching messages.

    +

    This is an IMAP4rev1 extension command.

    +
    + +
    +
    +IMAP4.starttls(ssl_context=None)
    +

    Send a STARTTLS command. The ssl_context argument is optional +and should be a ssl.SSLContext object. This will enable +encryption on the IMAP connection. Please read Security considerations for +best practices.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.4: The method now supports hostname check with +ssl.SSLContext.check_hostname and Server Name Indication (see +ssl.HAS_SNI).

    +
    +
    + +
    +
    +IMAP4.status(mailbox, names)
    +

    Request named status conditions for mailbox.

    +
    + +
    +
    +IMAP4.store(message_set, command, flag_list)
    +

    Alters flag dispositions for messages in mailbox. command is specified by +section 6.4.6 of RFC 2060 as being one of “FLAGS”, “+FLAGS”, or “-FLAGS”, +optionally with a suffix of “.SILENT”.

    +

    For example, to set the delete flag on all messages:

    +
    typ, data = M.search(None, 'ALL')
    +for num in data[0].split():
    +   M.store(num, '+FLAGS', '\\Deleted')
    +M.expunge()
    +
    +
    +
    +

    Note

    +

    Creating flags containing ‘]’ (for example: “[test]”) violates +RFC 3501 (the IMAP protocol). However, imaplib has historically +allowed creation of such tags, and popular IMAP servers, such as Gmail, +accept and produce such flags. There are non-Python programs which also +create such tags. Although it is an RFC violation and IMAP clients and +servers are supposed to be strict, imaplib nonetheless continues to allow +such tags to be created for backward compatibility reasons, and as of +Python 3.6, handles them if they are sent from the server, since this +improves real-world compatibility.

    +
    +
    + +
    +
    +IMAP4.subscribe(mailbox)
    +

    Subscribe to new mailbox.

    +
    + +
    +
    +IMAP4.thread(threading_algorithm, charset, search_criterion[, ...])
    +

    The thread command is a variant of search with threading semantics for +the results. Returned data contains a space separated list of thread members.

    +

    Thread members consist of zero or more messages numbers, delimited by spaces, +indicating successive parent and child.

    +

    Thread has two arguments before the search_criterion argument(s); a +threading_algorithm, and the searching charset. Note that unlike +search, the searching charset argument is mandatory. There is also a +uid thread command which corresponds to thread the way that uid +search corresponds to search. The thread command first searches the +mailbox for messages that match the given searching criteria using the charset +argument for the interpretation of strings in the searching criteria. It then +returns the matching messages threaded according to the specified threading +algorithm.

    +

    This is an IMAP4rev1 extension command.

    +
    + +
    +
    +IMAP4.uid(command, arg[, ...])
    +

    Execute command args with messages identified by UID, rather than message +number. Returns response appropriate to command. At least one argument must be +supplied; if none are provided, the server will return an error and an exception +will be raised.

    +
    + +
    +
    +IMAP4.unsubscribe(mailbox)
    +

    Unsubscribe from old mailbox.

    +
    + +
    +
    +IMAP4.xatom(name[, ...])
    +

    Allow simple extension commands notified by server in CAPABILITY response.

    +
    + +

    The following attributes are defined on instances of IMAP4:

    +
    +
    +IMAP4.PROTOCOL_VERSION
    +

    The most recent supported protocol in the CAPABILITY response from the +server.

    +
    + +
    +
    +IMAP4.debug
    +

    Integer value to control debugging output. The initialize value is taken from +the module variable Debug. Values greater than three trace each command.

    +
    + +
    +
    +IMAP4.utf8_enabled
    +

    Boolean value that is normally False, but is set to True if an +enable() command is successfully issued for the UTF8=ACCEPT +capability.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +

    IMAP4 Example

    +

    Here is a minimal example (without error checking) that opens a mailbox and +retrieves and prints all messages:

    +
    import getpass, imaplib
    +
    +M = imaplib.IMAP4()
    +M.login(getpass.getuser(), getpass.getpass())
    +M.select()
    +typ, data = M.search(None, 'ALL')
    +for num in data[0].split():
    +    typ, data = M.fetch(num, '(RFC822)')
    +    print('Message %s\n%s\n' % (num, data[0][1]))
    +M.close()
    +M.logout()
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/imghdr.html b/python-3.7.4-docs-html/library/imghdr.html new file mode 100644 index 0000000..9e70884 --- /dev/null +++ b/python-3.7.4-docs-html/library/imghdr.html @@ -0,0 +1,274 @@ + + + + + + + imghdr — Determine the type of an image — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    imghdr — Determine the type of an image

    +

    Source code: Lib/imghdr.py

    +
    +

    The imghdr module determines the type of image contained in a file or +byte stream.

    +

    The imghdr module defines the following function:

    +
    +
    +imghdr.what(filename, h=None)
    +

    Tests the image data contained in the file named by filename, and returns a +string describing the image type. If optional h is provided, the filename +is ignored and h is assumed to contain the byte stream to test.

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +

    The following image types are recognized, as listed below with the return value +from what():

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Value

    Image format

    'rgb'

    SGI ImgLib Files

    'gif'

    GIF 87a and 89a Files

    'pbm'

    Portable Bitmap Files

    'pgm'

    Portable Graymap Files

    'ppm'

    Portable Pixmap Files

    'tiff'

    TIFF Files

    'rast'

    Sun Raster Files

    'xbm'

    X Bitmap Files

    'jpeg'

    JPEG data in JFIF or Exif formats

    'bmp'

    BMP files

    'png'

    Portable Network Graphics

    'webp'

    WebP files

    'exr'

    OpenEXR Files

    +
    +

    New in version 3.5: The exr and webp formats were added.

    +
    +

    You can extend the list of file types imghdr can recognize by appending +to this variable:

    +
    +
    +imghdr.tests
    +

    A list of functions performing the individual tests. Each function takes two +arguments: the byte-stream and an open file-like object. When what() is +called with a byte-stream, the file-like object will be None.

    +

    The test function should return a string describing the image type if the test +succeeded, or None if it failed.

    +
    + +

    Example:

    +
    >>> import imghdr
    +>>> imghdr.what('bass.gif')
    +'gif'
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/imp.html b/python-3.7.4-docs-html/library/imp.html new file mode 100644 index 0000000..5196f6b --- /dev/null +++ b/python-3.7.4-docs-html/library/imp.html @@ -0,0 +1,593 @@ + + + + + + + imp — Access the import internals — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    imp — Access the import internals

    +

    Source code: Lib/imp.py

    +
    +

    Deprecated since version 3.4: The imp package is pending deprecation in favor of importlib.

    +
    +
    +

    This module provides an interface to the mechanisms used to implement the +import statement. It defines the following constants and functions:

    +
    +
    +imp.get_magic()
    +

    Return the magic string value used to recognize byte-compiled code files +(.pyc files). (This value may be different for each Python version.)

    +
    +

    Deprecated since version 3.4: Use importlib.util.MAGIC_NUMBER instead.

    +
    +
    + +
    +
    +imp.get_suffixes()
    +

    Return a list of 3-element tuples, each describing a particular type of +module. Each triple has the form (suffix, mode, type), where suffix is +a string to be appended to the module name to form the filename to search +for, mode is the mode string to pass to the built-in open() function +to open the file (this can be 'r' for text files or 'rb' for binary +files), and type is the file type, which has one of the values +PY_SOURCE, PY_COMPILED, or C_EXTENSION, described +below.

    +
    +

    Deprecated since version 3.3: Use the constants defined on importlib.machinery instead.

    +
    +
    + +
    +
    +imp.find_module(name[, path])
    +

    Try to find the module name. If path is omitted or None, the list of +directory names given by sys.path is searched, but first a few special +places are searched: the function tries to find a built-in module with the +given name (C_BUILTIN), then a frozen module (PY_FROZEN), +and on some systems some other places are looked in as well (on Windows, it +looks in the registry which may point to a specific file).

    +

    Otherwise, path must be a list of directory names; each directory is +searched for files with any of the suffixes returned by get_suffixes() +above. Invalid names in the list are silently ignored (but all list items +must be strings).

    +

    If search is successful, the return value is a 3-element tuple (file, +pathname, description):

    +

    file is an open file object positioned at the beginning, pathname +is the pathname of the file found, and description is a 3-element tuple as +contained in the list returned by get_suffixes() describing the kind of +module found.

    +

    If the module does not live in a file, the returned file is None, +pathname is the empty string, and the description tuple contains empty +strings for its suffix and mode; the module type is indicated as given in +parentheses above. If the search is unsuccessful, ImportError is +raised. Other exceptions indicate problems with the arguments or +environment.

    +

    If the module is a package, file is None, pathname is the package +path and the last item in the description tuple is PKG_DIRECTORY.

    +

    This function does not handle hierarchical module names (names containing +dots). In order to find P.M, that is, submodule M of package P, use +find_module() and load_module() to find and load package P, and +then use find_module() with the path argument set to P.__path__. +When P itself has a dotted name, apply this recipe recursively.

    +
    +

    Deprecated since version 3.3: Use importlib.util.find_spec() instead unless Python 3.3 +compatibility is required, in which case use +importlib.find_loader(). For example usage of the former case, +see the Examples section of the importlib +documentation.

    +
    +
    + +
    +
    +imp.load_module(name, file, pathname, description)
    +

    Load a module that was previously found by find_module() (or by an +otherwise conducted search yielding compatible results). This function does +more than importing the module: if the module was already imported, it will +reload the module! The name argument indicates the full +module name (including the package name, if this is a submodule of a +package). The file argument is an open file, and pathname is the +corresponding file name; these can be None and '', respectively, when +the module is a package or not being loaded from a file. The description +argument is a tuple, as would be returned by get_suffixes(), describing +what kind of module must be loaded.

    +

    If the load is successful, the return value is the module object; otherwise, +an exception (usually ImportError) is raised.

    +

    Important: the caller is responsible for closing the file argument, if +it was not None, even when an exception is raised. This is best done +using a tryfinally statement.

    +
    +

    Deprecated since version 3.3: If previously used in conjunction with imp.find_module() then +consider using importlib.import_module(), otherwise use the loader +returned by the replacement you chose for imp.find_module(). If you +called imp.load_module() and related functions directly with file +path arguments then use a combination of +importlib.util.spec_from_file_location() and +importlib.util.module_from_spec(). See the Examples +section of the importlib documentation for details of the various +approaches.

    +
    +
    + +
    +
    +imp.new_module(name)
    +

    Return a new empty module object called name. This object is not inserted +in sys.modules.

    +
    +

    Deprecated since version 3.4: Use importlib.util.module_from_spec() instead.

    +
    +
    + +
    +
    +imp.reload(module)
    +

    Reload a previously imported module. The argument must be a module object, so +it must have been successfully imported before. This is useful if you have +edited the module source file using an external editor and want to try out the +new version without leaving the Python interpreter. The return value is the +module object (the same as the module argument).

    +

    When reload(module) is executed:

    +
      +
    • Python modules’ code is recompiled and the module-level code reexecuted, +defining a new set of objects which are bound to names in the module’s +dictionary. The init function of extension modules is not called a second +time.

    • +
    • As with all other objects in Python the old objects are only reclaimed after +their reference counts drop to zero.

    • +
    • The names in the module namespace are updated to point to any new or changed +objects.

    • +
    • Other references to the old objects (such as names external to the module) are +not rebound to refer to the new objects and must be updated in each namespace +where they occur if that is desired.

    • +
    +

    There are a number of other caveats:

    +

    When a module is reloaded, its dictionary (containing the module’s global +variables) is retained. Redefinitions of names will override the old +definitions, so this is generally not a problem. If the new version of a module +does not define a name that was defined by the old version, the old definition +remains. This feature can be used to the module’s advantage if it maintains a +global table or cache of objects — with a try statement it can test +for the table’s presence and skip its initialization if desired:

    +
    try:
    +    cache
    +except NameError:
    +    cache = {}
    +
    +
    +

    It is legal though generally not very useful to reload built-in or dynamically +loaded modules, except for sys, __main__ and builtins. +In many cases, however, extension modules are not designed to be initialized +more than once, and may fail in arbitrary ways when reloaded.

    +

    If a module imports objects from another module using from … +import …, calling reload() for the other module does not +redefine the objects imported from it — one way around this is to re-execute +the from statement, another is to use import and qualified +names (module.*name*) instead.

    +

    If a module instantiates instances of a class, reloading the module that defines +the class does not affect the method definitions of the instances — they +continue to use the old class definition. The same is true for derived classes.

    +
    +

    Changed in version 3.3: Relies on both __name__ and __loader__ being defined on the module +being reloaded instead of just __name__.

    +
    +
    +

    Deprecated since version 3.4: Use importlib.reload() instead.

    +
    +
    + +

    The following functions are conveniences for handling PEP 3147 byte-compiled +file paths.

    +
    +

    New in version 3.2.

    +
    +
    +
    +imp.cache_from_source(path, debug_override=None)
    +

    Return the PEP 3147 path to the byte-compiled file associated with the +source path. For example, if path is /foo/bar/baz.py the return +value would be /foo/bar/__pycache__/baz.cpython-32.pyc for Python 3.2. +The cpython-32 string comes from the current magic tag (see +get_tag(); if sys.implementation.cache_tag is not defined then +NotImplementedError will be raised). By passing in True or +False for debug_override you can override the system’s value for +__debug__, leading to optimized bytecode.

    +

    path need not exist.

    +
    +

    Changed in version 3.3: If sys.implementation.cache_tag is None, then +NotImplementedError is raised.

    +
    +
    +

    Deprecated since version 3.4: Use importlib.util.cache_from_source() instead.

    +
    +
    +

    Changed in version 3.5: The debug_override parameter no longer creates a .pyo file.

    +
    +
    + +
    +
    +imp.source_from_cache(path)
    +

    Given the path to a PEP 3147 file name, return the associated source code +file path. For example, if path is +/foo/bar/__pycache__/baz.cpython-32.pyc the returned path would be +/foo/bar/baz.py. path need not exist, however if it does not conform +to PEP 3147 format, a ValueError is raised. If +sys.implementation.cache_tag is not defined, +NotImplementedError is raised.

    +
    +

    Changed in version 3.3: Raise NotImplementedError when +sys.implementation.cache_tag is not defined.

    +
    +
    +

    Deprecated since version 3.4: Use importlib.util.source_from_cache() instead.

    +
    +
    + +
    +
    +imp.get_tag()
    +

    Return the PEP 3147 magic tag string matching this version of Python’s +magic number, as returned by get_magic().

    +
    +

    Deprecated since version 3.4: Use sys.implementation.cache_tag directly starting +in Python 3.3.

    +
    +
    + +

    The following functions help interact with the import system’s internal +locking mechanism. Locking semantics of imports are an implementation +detail which may vary from release to release. However, Python ensures +that circular imports work without any deadlocks.

    +
    +
    +imp.lock_held()
    +

    Return True if the global import lock is currently held, else +False. On platforms without threads, always return False.

    +

    On platforms with threads, a thread executing an import first holds a +global import lock, then sets up a per-module lock for the rest of the +import. This blocks other threads from importing the same module until +the original import completes, preventing other threads from seeing +incomplete module objects constructed by the original thread. An +exception is made for circular imports, which by construction have to +expose an incomplete module object at some point.

    +
    +

    Changed in version 3.3: The locking scheme has changed to per-module locks for +the most part. A global import lock is kept for some critical tasks, +such as initializing the per-module locks.

    +
    +
    +

    Deprecated since version 3.4.

    +
    +
    + +
    +
    +imp.acquire_lock()
    +

    Acquire the interpreter’s global import lock for the current thread. +This lock should be used by import hooks to ensure thread-safety when +importing modules.

    +

    Once a thread has acquired the import lock, the same thread may acquire it +again without blocking; the thread must release it once for each time it has +acquired it.

    +

    On platforms without threads, this function does nothing.

    +
    +

    Changed in version 3.3: The locking scheme has changed to per-module locks for +the most part. A global import lock is kept for some critical tasks, +such as initializing the per-module locks.

    +
    +
    +

    Deprecated since version 3.4.

    +
    +
    + +
    +
    +imp.release_lock()
    +

    Release the interpreter’s global import lock. On platforms without +threads, this function does nothing.

    +
    +

    Changed in version 3.3: The locking scheme has changed to per-module locks for +the most part. A global import lock is kept for some critical tasks, +such as initializing the per-module locks.

    +
    +
    +

    Deprecated since version 3.4.

    +
    +
    + +

    The following constants with integer values, defined in this module, are used +to indicate the search result of find_module().

    +
    +
    +imp.PY_SOURCE
    +

    The module was found as a source file.

    +
    +

    Deprecated since version 3.3.

    +
    +
    + +
    +
    +imp.PY_COMPILED
    +

    The module was found as a compiled code object file.

    +
    +

    Deprecated since version 3.3.

    +
    +
    + +
    +
    +imp.C_EXTENSION
    +

    The module was found as dynamically loadable shared library.

    +
    +

    Deprecated since version 3.3.

    +
    +
    + +
    +
    +imp.PKG_DIRECTORY
    +

    The module was found as a package directory.

    +
    +

    Deprecated since version 3.3.

    +
    +
    + +
    +
    +imp.C_BUILTIN
    +

    The module was found as a built-in module.

    +
    +

    Deprecated since version 3.3.

    +
    +
    + +
    +
    +imp.PY_FROZEN
    +

    The module was found as a frozen module.

    +
    +

    Deprecated since version 3.3.

    +
    +
    + +
    +
    +class imp.NullImporter(path_string)
    +

    The NullImporter type is a PEP 302 import hook that handles +non-directory path strings by failing to find any modules. Calling this type +with an existing directory or empty string raises ImportError. +Otherwise, a NullImporter instance is returned.

    +

    Instances have only one method:

    +
    +
    +find_module(fullname[, path])
    +

    This method always returns None, indicating that the requested module could +not be found.

    +
    + +
    +

    Changed in version 3.3: None is inserted into sys.path_importer_cache instead of an +instance of NullImporter.

    +
    +
    +

    Deprecated since version 3.4: Insert None into sys.path_importer_cache instead.

    +
    +
    + +
    +

    Examples

    +

    The following function emulates what was the standard import statement up to +Python 1.4 (no hierarchical module names). (This implementation wouldn’t work +in that version, since find_module() has been extended and +load_module() has been added in 1.4.)

    +
    import imp
    +import sys
    +
    +def __import__(name, globals=None, locals=None, fromlist=None):
    +    # Fast path: see if the module has already been imported.
    +    try:
    +        return sys.modules[name]
    +    except KeyError:
    +        pass
    +
    +    # If any of the following calls raises an exception,
    +    # there's a problem we can't handle -- let the caller handle it.
    +
    +    fp, pathname, description = imp.find_module(name)
    +
    +    try:
    +        return imp.load_module(name, fp, pathname, description)
    +    finally:
    +        # Since we may exit via an exception, close fp explicitly.
    +        if fp:
    +            fp.close()
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/importlib.html b/python-3.7.4-docs-html/library/importlib.html new file mode 100644 index 0000000..5e2eb96 --- /dev/null +++ b/python-3.7.4-docs-html/library/importlib.html @@ -0,0 +1,2105 @@ + + + + + + + importlib — The implementation of import — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    importlib — The implementation of import

    +
    +

    New in version 3.1.

    +
    +

    Source code: Lib/importlib/__init__.py

    +
    +
    +

    Introduction

    +

    The purpose of the importlib package is two-fold. One is to provide the +implementation of the import statement (and thus, by extension, the +__import__() function) in Python source code. This provides an +implementation of import which is portable to any Python +interpreter. This also provides an implementation which is easier to +comprehend than one implemented in a programming language other than Python.

    +

    Two, the components to implement import are exposed in this +package, making it easier for users to create their own custom objects (known +generically as an importer) to participate in the import process.

    +
    +

    See also

    +
    +
    The import statement

    The language reference for the import statement.

    +
    +
    Packages specification

    Original specification of packages. Some semantics have changed since +the writing of this document (e.g. redirecting based on None +in sys.modules).

    +
    +
    The __import__() function

    The import statement is syntactic sugar for this function.

    +
    +
    PEP 235

    Import on Case-Insensitive Platforms

    +
    +
    PEP 263

    Defining Python Source Code Encodings

    +
    +
    PEP 302

    New Import Hooks

    +
    +
    PEP 328

    Imports: Multi-Line and Absolute/Relative

    +
    +
    PEP 366

    Main module explicit relative imports

    +
    +
    PEP 420

    Implicit namespace packages

    +
    +
    PEP 451

    A ModuleSpec Type for the Import System

    +
    +
    PEP 488

    Elimination of PYO files

    +
    +
    PEP 489

    Multi-phase extension module initialization

    +
    +
    PEP 552

    Deterministic pycs

    +
    +
    PEP 3120

    Using UTF-8 as the Default Source Encoding

    +
    +
    PEP 3147

    PYC Repository Directories

    +
    +
    +
    +
    +
    +

    Functions

    +
    +
    +importlib.__import__(name, globals=None, locals=None, fromlist=(), level=0)
    +

    An implementation of the built-in __import__() function.

    +
    +

    Note

    +

    Programmatic importing of modules should use import_module() +instead of this function.

    +
    +
    + +
    +
    +importlib.import_module(name, package=None)
    +

    Import a module. The name argument specifies what module to +import in absolute or relative terms +(e.g. either pkg.mod or ..mod). If the name is +specified in relative terms, then the package argument must be set to +the name of the package which is to act as the anchor for resolving the +package name (e.g. import_module('..mod', 'pkg.subpkg') will import +pkg.mod).

    +

    The import_module() function acts as a simplifying wrapper around +importlib.__import__(). This means all semantics of the function are +derived from importlib.__import__(). The most important difference +between these two functions is that import_module() returns the +specified package or module (e.g. pkg.mod), while __import__() +returns the top-level package or module (e.g. pkg).

    +

    If you are dynamically importing a module that was created since the +interpreter began execution (e.g., created a Python source file), you may +need to call invalidate_caches() in order for the new module to be +noticed by the import system.

    +
    +

    Changed in version 3.3: Parent packages are automatically imported.

    +
    +
    + +
    +
    +importlib.find_loader(name, path=None)
    +

    Find the loader for a module, optionally within the specified path. If the +module is in sys.modules, then sys.modules[name].__loader__ is +returned (unless the loader would be None or is not set, in which case +ValueError is raised). Otherwise a search using sys.meta_path +is done. None is returned if no loader is found.

    +

    A dotted name does not have its parents implicitly imported as that requires +loading them and that may not be desired. To properly import a submodule you +will need to import all parent packages of the submodule and use the correct +argument to path.

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.4: If __loader__ is not set, raise ValueError, just like when the +attribute is set to None.

    +
    +
    +

    Deprecated since version 3.4: Use importlib.util.find_spec() instead.

    +
    +
    + +
    +
    +importlib.invalidate_caches()
    +

    Invalidate the internal caches of finders stored at +sys.meta_path. If a finder implements invalidate_caches() then it +will be called to perform the invalidation. This function should be called +if any modules are created/installed while your program is running to +guarantee all finders will notice the new module’s existence.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +importlib.reload(module)
    +

    Reload a previously imported module. The argument must be a module object, +so it must have been successfully imported before. This is useful if you +have edited the module source file using an external editor and want to try +out the new version without leaving the Python interpreter. The return value +is the module object (which can be different if re-importing causes a +different object to be placed in sys.modules).

    +

    When reload() is executed:

    +
      +
    • Python module’s code is recompiled and the module-level code re-executed, +defining a new set of objects which are bound to names in the module’s +dictionary by reusing the loader which originally loaded the +module. The init function of extension modules is not called a second +time.

    • +
    • As with all other objects in Python the old objects are only reclaimed +after their reference counts drop to zero.

    • +
    • The names in the module namespace are updated to point to any new or +changed objects.

    • +
    • Other references to the old objects (such as names external to the module) are +not rebound to refer to the new objects and must be updated in each namespace +where they occur if that is desired.

    • +
    +

    There are a number of other caveats:

    +

    When a module is reloaded, its dictionary (containing the module’s global +variables) is retained. Redefinitions of names will override the old +definitions, so this is generally not a problem. If the new version of a +module does not define a name that was defined by the old version, the old +definition remains. This feature can be used to the module’s advantage if it +maintains a global table or cache of objects — with a try +statement it can test for the table’s presence and skip its initialization if +desired:

    +
    try:
    +    cache
    +except NameError:
    +    cache = {}
    +
    +
    +

    It is generally not very useful to reload built-in or dynamically loaded +modules. Reloading sys, __main__, builtins and other +key modules is not recommended. In many cases extension modules are not +designed to be initialized more than once, and may fail in arbitrary ways +when reloaded.

    +

    If a module imports objects from another module using from … +import …, calling reload() for the other module does not +redefine the objects imported from it — one way around this is to +re-execute the from statement, another is to use import +and qualified names (module.name) instead.

    +

    If a module instantiates instances of a class, reloading the module that +defines the class does not affect the method definitions of the instances — +they continue to use the old class definition. The same is true for derived +classes.

    +
    +

    New in version 3.4.

    +
    +
    +

    Changed in version 3.7: ModuleNotFoundError is raised when the module being reloaded lacks +a ModuleSpec.

    +
    +
    + +
    +
    +

    importlib.abc – Abstract base classes related to import

    +

    Source code: Lib/importlib/abc.py

    +
    +

    The importlib.abc module contains all of the core abstract base classes +used by import. Some subclasses of the core abstract base classes +are also provided to help in implementing the core ABCs.

    +

    ABC hierarchy:

    +
    object
    + +-- Finder (deprecated)
    + |    +-- MetaPathFinder
    + |    +-- PathEntryFinder
    + +-- Loader
    +      +-- ResourceLoader --------+
    +      +-- InspectLoader          |
    +           +-- ExecutionLoader --+
    +                                 +-- FileLoader
    +                                 +-- SourceLoader
    +
    +
    +
    +
    +class importlib.abc.Finder
    +

    An abstract base class representing a finder.

    +
    +

    Deprecated since version 3.3: Use MetaPathFinder or PathEntryFinder instead.

    +
    +
    +
    +abstractmethod find_module(fullname, path=None)
    +

    An abstract method for finding a loader for the specified +module. Originally specified in PEP 302, this method was meant +for use in sys.meta_path and in the path-based import subsystem.

    +
    +

    Changed in version 3.4: Returns None when called instead of raising +NotImplementedError.

    +
    +
    + +
    + +
    +
    +class importlib.abc.MetaPathFinder
    +

    An abstract base class representing a meta path finder. For +compatibility, this is a subclass of Finder.

    +
    +

    New in version 3.3.

    +
    +
    +
    +find_spec(fullname, path, target=None)
    +

    An abstract method for finding a spec for +the specified module. If this is a top-level import, path will +be None. Otherwise, this is a search for a subpackage or +module and path will be the value of __path__ from the +parent package. If a spec cannot be found, None is returned. +When passed in, target is a module object that the finder may +use to make a more educated guess about what spec to return.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +find_module(fullname, path)
    +

    A legacy method for finding a loader for the specified +module. If this is a top-level import, path will be None. +Otherwise, this is a search for a subpackage or module and path +will be the value of __path__ from the parent +package. If a loader cannot be found, None is returned.

    +

    If find_spec() is defined, backwards-compatible functionality is +provided.

    +
    +

    Changed in version 3.4: Returns None when called instead of raising +NotImplementedError. Can use find_spec() to provide +functionality.

    +
    +
    +

    Deprecated since version 3.4: Use find_spec() instead.

    +
    +
    + +
    +
    +invalidate_caches()
    +

    An optional method which, when called, should invalidate any internal +cache used by the finder. Used by importlib.invalidate_caches() +when invalidating the caches of all finders on sys.meta_path.

    +
    +

    Changed in version 3.4: Returns None when called instead of NotImplemented.

    +
    +
    + +
    + +
    +
    +class importlib.abc.PathEntryFinder
    +

    An abstract base class representing a path entry finder. Though +it bears some similarities to MetaPathFinder, PathEntryFinder +is meant for use only within the path-based import subsystem provided +by PathFinder. This ABC is a subclass of Finder for +compatibility reasons only.

    +
    +

    New in version 3.3.

    +
    +
    +
    +find_spec(fullname, target=None)
    +

    An abstract method for finding a spec for +the specified module. The finder will search for the module only +within the path entry to which it is assigned. If a spec +cannot be found, None is returned. When passed in, target +is a module object that the finder may use to make a more educated +guess about what spec to return.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +find_loader(fullname)
    +

    A legacy method for finding a loader for the specified +module. Returns a 2-tuple of (loader, portion) where portion +is a sequence of file system locations contributing to part of a namespace +package. The loader may be None while specifying portion to +signify the contribution of the file system locations to a namespace +package. An empty list can be used for portion to signify the loader +is not part of a namespace package. If loader is None and +portion is the empty list then no loader or location for a namespace +package were found (i.e. failure to find anything for the module).

    +

    If find_spec() is defined then backwards-compatible functionality is +provided.

    +
    +

    Changed in version 3.4: Returns (None, []) instead of raising NotImplementedError. +Uses find_spec() when available to provide functionality.

    +
    +
    +

    Deprecated since version 3.4: Use find_spec() instead.

    +
    +
    + +
    +
    +find_module(fullname)
    +

    A concrete implementation of Finder.find_module() which is +equivalent to self.find_loader(fullname)[0].

    +
    +

    Deprecated since version 3.4: Use find_spec() instead.

    +
    +
    + +
    +
    +invalidate_caches()
    +

    An optional method which, when called, should invalidate any internal +cache used by the finder. Used by PathFinder.invalidate_caches() +when invalidating the caches of all cached finders.

    +
    + +
    + +
    +
    +class importlib.abc.Loader
    +

    An abstract base class for a loader. +See PEP 302 for the exact definition for a loader.

    +

    Loaders that wish to support resource reading should implement a +get_resource_reader(fullname) method as specified by +importlib.abc.ResourceReader.

    +
    +

    Changed in version 3.7: Introduced the optional get_resource_reader() method.

    +
    +
    +
    +create_module(spec)
    +

    A method that returns the module object to use when +importing a module. This method may return None, +indicating that default module creation semantics should take place.

    +
    +

    New in version 3.4.

    +
    +
    +

    Changed in version 3.5: Starting in Python 3.6, this method will not be optional when +exec_module() is defined.

    +
    +
    + +
    +
    +exec_module(module)
    +

    An abstract method that executes the module in its own namespace +when a module is imported or reloaded. The module should already +be initialized when exec_module() is called. When this method exists, +create_module() must be defined.

    +
    +

    New in version 3.4.

    +
    +
    +

    Changed in version 3.6: create_module() must also be defined.

    +
    +
    + +
    +
    +load_module(fullname)
    +

    A legacy method for loading a module. If the module cannot be +loaded, ImportError is raised, otherwise the loaded module is +returned.

    +

    If the requested module already exists in sys.modules, that +module should be used and reloaded. +Otherwise the loader should create a new module and insert it into +sys.modules before any loading begins, to prevent recursion +from the import. If the loader inserted a module and the load fails, it +must be removed by the loader from sys.modules; modules already +in sys.modules before the loader began execution should be left +alone (see importlib.util.module_for_loader()).

    +

    The loader should set several attributes on the module. +(Note that some of these attributes can change when a module is +reloaded):

    +
      +
    • +
      __name__

      The name of the module.

      +
      +
      +
    • +
    • +
      __file__

      The path to where the module data is stored (not set for built-in +modules).

      +
      +
      +
    • +
    • +
      __cached__

      The path to where a compiled version of the module is/should be +stored (not set when the attribute would be inappropriate).

      +
      +
      +
    • +
    • +
      __path__

      A list of strings specifying the search path within a +package. This attribute is not set on modules.

      +
      +
      +
    • +
    • +
      __package__

      The parent package for the module/package. If the module is +top-level then it has a value of the empty string. The +importlib.util.module_for_loader() decorator can handle the +details for __package__.

      +
      +
      +
    • +
    • +
      __loader__

      The loader used to load the module. The +importlib.util.module_for_loader() decorator can handle the +details for __package__.

      +
      +
      +
    • +
    +

    When exec_module() is available then backwards-compatible +functionality is provided.

    +
    +

    Changed in version 3.4: Raise ImportError when called instead of +NotImplementedError. Functionality provided when +exec_module() is available.

    +
    +
    +

    Deprecated since version 3.4: The recommended API for loading a module is exec_module() +(and create_module()). Loaders should implement +it instead of load_module(). The import machinery takes care of +all the other responsibilities of load_module() when exec_module() +is implemented.

    +
    +
    + +
    +
    +module_repr(module)
    +

    A legacy method which when implemented calculates and returns the +given module’s repr, as a string. The module type’s default repr() will +use the result of this method as appropriate.

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.4: Made optional instead of an abstractmethod.

    +
    +
    +

    Deprecated since version 3.4: The import machinery now takes care of this automatically.

    +
    +
    + +
    + +
    +
    +class importlib.abc.ResourceReader
    +

    An abstract base class to provide the ability to read +resources.

    +

    From the perspective of this ABC, a resource is a binary +artifact that is shipped within a package. Typically this is +something like a data file that lives next to the __init__.py +file of the package. The purpose of this class is to help abstract +out the accessing of such data files so that it does not matter if +the package and its data file(s) are stored in a e.g. zip file +versus on the file system.

    +

    For any of methods of this class, a resource argument is +expected to be a path-like object which represents +conceptually just a file name. This means that no subdirectory +paths should be included in the resource argument. This is +because the location of the package the reader is for, acts as the +“directory”. Hence the metaphor for directories and file +names is packages and resources, respectively. This is also why +instances of this class are expected to directly correlate to +a specific package (instead of potentially representing multiple +packages or a module).

    +

    Loaders that wish to support resource reading are expected to +provide a method called get_resource_reader(fullname) which +returns an object implementing this ABC’s interface. If the module +specified by fullname is not a package, this method should return +None. An object compatible with this ABC should only be +returned when the specified module is a package.

    +
    +

    New in version 3.7.

    +
    +
    +
    +abstractmethod open_resource(resource)
    +

    Returns an opened, file-like object for binary reading +of the resource.

    +

    If the resource cannot be found, FileNotFoundError is +raised.

    +
    + +
    +
    +abstractmethod resource_path(resource)
    +

    Returns the file system path to the resource.

    +

    If the resource does not concretely exist on the file system, +raise FileNotFoundError.

    +
    + +
    +
    +abstractmethod is_resource(name)
    +

    Returns True if the named name is considered a resource. +FileNotFoundError is raised if name does not exist.

    +
    + +
    +
    +abstractmethod contents()
    +

    Returns an iterable of strings over the contents of +the package. Do note that it is not required that all names +returned by the iterator be actual resources, e.g. it is +acceptable to return names for which is_resource() would +be false.

    +

    Allowing non-resource names to be returned is to allow for +situations where how a package and its resources are stored +are known a priori and the non-resource names would be useful. +For instance, returning subdirectory names is allowed so that +when it is known that the package and resources are stored on +the file system then those subdirectory names can be used +directly.

    +

    The abstract method returns an iterable of no items.

    +
    + +
    + +
    +
    +class importlib.abc.ResourceLoader
    +

    An abstract base class for a loader which implements the optional +PEP 302 protocol for loading arbitrary resources from the storage +back-end.

    +
    +

    Deprecated since version 3.7: This ABC is deprecated in favour of supporting resource loading +through importlib.abc.ResourceReader.

    +
    +
    +
    +abstractmethod get_data(path)
    +

    An abstract method to return the bytes for the data located at path. +Loaders that have a file-like storage back-end +that allows storing arbitrary data +can implement this abstract method to give direct access +to the data stored. OSError is to be raised if the path cannot +be found. The path is expected to be constructed using a module’s +__file__ attribute or an item from a package’s __path__.

    +
    +

    Changed in version 3.4: Raises OSError instead of NotImplementedError.

    +
    +
    + +
    + +
    +
    +class importlib.abc.InspectLoader
    +

    An abstract base class for a loader which implements the optional +PEP 302 protocol for loaders that inspect modules.

    +
    +
    +get_code(fullname)
    +

    Return the code object for a module, or None if the module does not +have a code object (as would be the case, for example, for a built-in +module). Raise an ImportError if loader cannot find the +requested module.

    +
    +

    Note

    +

    While the method has a default implementation, it is suggested that +it be overridden if possible for performance.

    +
    +
    +

    Changed in version 3.4: No longer abstract and a concrete implementation is provided.

    +
    +
    + +
    +
    +abstractmethod get_source(fullname)
    +

    An abstract method to return the source of a module. It is returned as +a text string using universal newlines, translating all +recognized line separators into '\n' characters. Returns None +if no source is available (e.g. a built-in module). Raises +ImportError if the loader cannot find the module specified.

    +
    +

    Changed in version 3.4: Raises ImportError instead of NotImplementedError.

    +
    +
    + +
    +
    +is_package(fullname)
    +

    An abstract method to return a true value if the module is a package, a +false value otherwise. ImportError is raised if the +loader cannot find the module.

    +
    +

    Changed in version 3.4: Raises ImportError instead of NotImplementedError.

    +
    +
    + +
    +
    +static source_to_code(data, path='<string>')
    +

    Create a code object from Python source.

    +

    The data argument can be whatever the compile() function +supports (i.e. string or bytes). The path argument should be +the “path” to where the source code originated from, which can be an +abstract concept (e.g. location in a zip file).

    +

    With the subsequent code object one can execute it in a module by +running exec(code, module.__dict__).

    +
    +

    New in version 3.4.

    +
    +
    +

    Changed in version 3.5: Made the method static.

    +
    +
    + +
    +
    +exec_module(module)
    +

    Implementation of Loader.exec_module().

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +load_module(fullname)
    +

    Implementation of Loader.load_module().

    +
    +

    Deprecated since version 3.4: use exec_module() instead.

    +
    +
    + +
    + +
    +
    +class importlib.abc.ExecutionLoader
    +

    An abstract base class which inherits from InspectLoader that, +when implemented, helps a module to be executed as a script. The ABC +represents an optional PEP 302 protocol.

    +
    +
    +abstractmethod get_filename(fullname)
    +

    An abstract method that is to return the value of __file__ for +the specified module. If no path is available, ImportError is +raised.

    +

    If source code is available, then the method should return the path to +the source file, regardless of whether a bytecode was used to load the +module.

    +
    +

    Changed in version 3.4: Raises ImportError instead of NotImplementedError.

    +
    +
    + +
    + +
    +
    +class importlib.abc.FileLoader(fullname, path)
    +

    An abstract base class which inherits from ResourceLoader and +ExecutionLoader, providing concrete implementations of +ResourceLoader.get_data() and ExecutionLoader.get_filename().

    +

    The fullname argument is a fully resolved name of the module the loader is +to handle. The path argument is the path to the file for the module.

    +
    +

    New in version 3.3.

    +
    +
    +
    +name
    +

    The name of the module the loader can handle.

    +
    + +
    +
    +path
    +

    Path to the file of the module.

    +
    + +
    +
    +load_module(fullname)
    +

    Calls super’s load_module().

    +
    +

    Deprecated since version 3.4: Use Loader.exec_module() instead.

    +
    +
    + +
    +
    +abstractmethod get_filename(fullname)
    +

    Returns path.

    +
    + +
    +
    +abstractmethod get_data(path)
    +

    Reads path as a binary file and returns the bytes from it.

    +
    + +
    + +
    +
    +class importlib.abc.SourceLoader
    +

    An abstract base class for implementing source (and optionally bytecode) +file loading. The class inherits from both ResourceLoader and +ExecutionLoader, requiring the implementation of:

    + +

    The abstract methods defined by this class are to add optional bytecode +file support. Not implementing these optional methods (or causing them to +raise NotImplementedError) causes the loader to +only work with source code. Implementing the methods allows the loader to +work with source and bytecode files; it does not allow for sourceless +loading where only bytecode is provided. Bytecode files are an +optimization to speed up loading by removing the parsing step of Python’s +compiler, and so no bytecode-specific API is exposed.

    +
    +
    +path_stats(path)
    +

    Optional abstract method which returns a dict containing +metadata about the specified path. Supported dictionary keys are:

    +
      +
    • 'mtime' (mandatory): an integer or floating-point number +representing the modification time of the source code;

    • +
    • 'size' (optional): the size in bytes of the source code.

    • +
    +

    Any other keys in the dictionary are ignored, to allow for future +extensions. If the path cannot be handled, OSError is raised.

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.4: Raise OSError instead of NotImplementedError.

    +
    +
    + +
    +
    +path_mtime(path)
    +

    Optional abstract method which returns the modification time for the +specified path.

    +
    +

    Deprecated since version 3.3: This method is deprecated in favour of path_stats(). You don’t +have to implement it, but it is still available for compatibility +purposes. Raise OSError if the path cannot be handled.

    +
    +
    +

    Changed in version 3.4: Raise OSError instead of NotImplementedError.

    +
    +
    + +
    +
    +set_data(path, data)
    +

    Optional abstract method which writes the specified bytes to a file +path. Any intermediate directories which do not exist are to be created +automatically.

    +

    When writing to the path fails because the path is read-only +(errno.EACCES/PermissionError), do not propagate the +exception.

    +
    +

    Changed in version 3.4: No longer raises NotImplementedError when called.

    +
    +
    + +
    +
    +get_code(fullname)
    +

    Concrete implementation of InspectLoader.get_code().

    +
    + +
    +
    +exec_module(module)
    +

    Concrete implementation of Loader.exec_module().

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +load_module(fullname)
    +

    Concrete implementation of Loader.load_module().

    +
    +

    Deprecated since version 3.4: Use exec_module() instead.

    +
    +
    + +
    +
    +get_source(fullname)
    +

    Concrete implementation of InspectLoader.get_source().

    +
    + +
    +
    +is_package(fullname)
    +

    Concrete implementation of InspectLoader.is_package(). A module +is determined to be a package if its file path (as provided by +ExecutionLoader.get_filename()) is a file named +__init__ when the file extension is removed and the module name +itself does not end in __init__.

    +
    + +
    + +
    +
    +

    importlib.resources – Resources

    +

    Source code: Lib/importlib/resources.py

    +
    +
    +

    New in version 3.7.

    +
    +

    This module leverages Python’s import system to provide access to resources +within packages. If you can import a package, you can access resources +within that package. Resources can be opened or read, in either binary or +text mode.

    +

    Resources are roughly akin to files inside directories, though it’s important +to keep in mind that this is just a metaphor. Resources and packages do +not have to exist as physical files and directories on the file system.

    +
    +

    Note

    +

    This module provides functionality similar to pkg_resources Basic +Resource Access +without the performance overhead of that package. This makes reading +resources included in packages easier, with more stable and consistent +semantics.

    +

    The standalone backport of this module provides more information +on using importlib.resources and +migrating from pkg_resources to importlib.resources.

    +
    +

    Loaders that wish to support resource reading should implement a +get_resource_reader(fullname) method as specified by +importlib.abc.ResourceReader.

    +

    The following types are defined.

    +
    +
    +importlib.resources.Package
    +

    The Package type is defined as Union[str, ModuleType]. This means +that where the function describes accepting a Package, you can pass in +either a string or a module. Module objects must have a resolvable +__spec__.submodule_search_locations that is not None.

    +
    + +
    +
    +importlib.resources.Resource
    +

    This type describes the resource names passed into the various functions +in this package. This is defined as Union[str, os.PathLike].

    +
    + +

    The following functions are available.

    +
    +
    +importlib.resources.open_binary(package, resource)
    +

    Open for binary reading the resource within package.

    +

    package is either a name or a module object which conforms to the +Package requirements. resource is the name of the resource to open +within package; it may not contain path separators and it may not have +sub-resources (i.e. it cannot be a directory). This function returns a +typing.BinaryIO instance, a binary I/O stream open for reading.

    +
    + +
    +
    +importlib.resources.open_text(package, resource, encoding='utf-8', errors='strict')
    +

    Open for text reading the resource within package. By default, the +resource is opened for reading as UTF-8.

    +

    package is either a name or a module object which conforms to the +Package requirements. resource is the name of the resource to open +within package; it may not contain path separators and it may not have +sub-resources (i.e. it cannot be a directory). encoding and errors +have the same meaning as with built-in open().

    +

    This function returns a typing.TextIO instance, a text I/O stream open +for reading.

    +
    + +
    +
    +importlib.resources.read_binary(package, resource)
    +

    Read and return the contents of the resource within package as +bytes.

    +

    package is either a name or a module object which conforms to the +Package requirements. resource is the name of the resource to open +within package; it may not contain path separators and it may not have +sub-resources (i.e. it cannot be a directory). This function returns the +contents of the resource as bytes.

    +
    + +
    +
    +importlib.resources.read_text(package, resource, encoding='utf-8', errors='strict')
    +

    Read and return the contents of resource within package as a str. +By default, the contents are read as strict UTF-8.

    +

    package is either a name or a module object which conforms to the +Package requirements. resource is the name of the resource to open +within package; it may not contain path separators and it may not have +sub-resources (i.e. it cannot be a directory). encoding and errors +have the same meaning as with built-in open(). This function +returns the contents of the resource as str.

    +
    + +
    +
    +importlib.resources.path(package, resource)
    +

    Return the path to the resource as an actual file system path. This +function returns a context manager for use in a with statement. +The context manager provides a pathlib.Path object.

    +

    Exiting the context manager cleans up any temporary file created when the +resource needs to be extracted from e.g. a zip file.

    +

    package is either a name or a module object which conforms to the +Package requirements. resource is the name of the resource to open +within package; it may not contain path separators and it may not have +sub-resources (i.e. it cannot be a directory).

    +
    + +
    +
    +importlib.resources.is_resource(package, name)
    +

    Return True if there is a resource named name in the package, +otherwise False. Remember that directories are not resources! +package is either a name or a module object which conforms to the +Package requirements.

    +
    + +
    +
    +importlib.resources.contents(package)
    +

    Return an iterable over the named items within the package. The iterable +returns str resources (e.g. files) and non-resources +(e.g. directories). The iterable does not recurse into subdirectories.

    +

    package is either a name or a module object which conforms to the +Package requirements.

    +
    + +
    +
    +

    importlib.machinery – Importers and path hooks

    +

    Source code: Lib/importlib/machinery.py

    +
    +

    This module contains the various objects that help import +find and load modules.

    +
    +
    +importlib.machinery.SOURCE_SUFFIXES
    +

    A list of strings representing the recognized file suffixes for source +modules.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +importlib.machinery.DEBUG_BYTECODE_SUFFIXES
    +

    A list of strings representing the file suffixes for non-optimized bytecode +modules.

    +
    +

    New in version 3.3.

    +
    +
    +

    Deprecated since version 3.5: Use BYTECODE_SUFFIXES instead.

    +
    +
    + +
    +
    +importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES
    +

    A list of strings representing the file suffixes for optimized bytecode +modules.

    +
    +

    New in version 3.3.

    +
    +
    +

    Deprecated since version 3.5: Use BYTECODE_SUFFIXES instead.

    +
    +
    + +
    +
    +importlib.machinery.BYTECODE_SUFFIXES
    +

    A list of strings representing the recognized file suffixes for bytecode +modules (including the leading dot).

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.5: The value is no longer dependent on __debug__.

    +
    +
    + +
    +
    +importlib.machinery.EXTENSION_SUFFIXES
    +

    A list of strings representing the recognized file suffixes for +extension modules.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +importlib.machinery.all_suffixes()
    +

    Returns a combined list of strings representing all file suffixes for +modules recognized by the standard import machinery. This is a +helper for code which simply needs to know if a filesystem path +potentially refers to a module without needing any details on the kind +of module (for example, inspect.getmodulename()).

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +class importlib.machinery.BuiltinImporter
    +

    An importer for built-in modules. All known built-in modules are +listed in sys.builtin_module_names. This class implements the +importlib.abc.MetaPathFinder and +importlib.abc.InspectLoader ABCs.

    +

    Only class methods are defined by this class to alleviate the need for +instantiation.

    +
    +

    Changed in version 3.5: As part of PEP 489, the builtin importer now implements +Loader.create_module() and Loader.exec_module()

    +
    +
    + +
    +
    +class importlib.machinery.FrozenImporter
    +

    An importer for frozen modules. This class implements the +importlib.abc.MetaPathFinder and +importlib.abc.InspectLoader ABCs.

    +

    Only class methods are defined by this class to alleviate the need for +instantiation.

    +
    + +
    +
    +class importlib.machinery.WindowsRegistryFinder
    +

    Finder for modules declared in the Windows registry. This class +implements the importlib.abc.MetaPathFinder ABC.

    +

    Only class methods are defined by this class to alleviate the need for +instantiation.

    +
    +

    New in version 3.3.

    +
    +
    +

    Deprecated since version 3.6: Use site configuration instead. Future versions of Python may +not enable this finder by default.

    +
    +
    + +
    +
    +class importlib.machinery.PathFinder
    +

    A Finder for sys.path and package __path__ attributes. +This class implements the importlib.abc.MetaPathFinder ABC.

    +

    Only class methods are defined by this class to alleviate the need for +instantiation.

    +
    +
    +classmethod find_spec(fullname, path=None, target=None)
    +

    Class method that attempts to find a spec +for the module specified by fullname on sys.path or, if +defined, on path. For each path entry that is searched, +sys.path_importer_cache is checked. If a non-false object +is found then it is used as the path entry finder to look +for the module being searched for. If no entry is found in +sys.path_importer_cache, then sys.path_hooks is +searched for a finder for the path entry and, if found, is stored +in sys.path_importer_cache along with being queried about +the module. If no finder is ever found then None is both +stored in the cache and returned.

    +
    +

    New in version 3.4.

    +
    +
    +

    Changed in version 3.5: If the current working directory – represented by an empty string – +is no longer valid then None is returned but no value is cached +in sys.path_importer_cache.

    +
    +
    + +
    +
    +classmethod find_module(fullname, path=None)
    +

    A legacy wrapper around find_spec().

    +
    +

    Deprecated since version 3.4: Use find_spec() instead.

    +
    +
    + +
    +
    +classmethod invalidate_caches()
    +

    Calls importlib.abc.PathEntryFinder.invalidate_caches() on all +finders stored in sys.path_importer_cache that define the method. +Otherwise entries in sys.path_importer_cache set to None are +deleted.

    +
    +

    Changed in version 3.7: Entries of None in sys.path_importer_cache are deleted.

    +
    +
    + +
    +

    Changed in version 3.4: Calls objects in sys.path_hooks with the current working +directory for '' (i.e. the empty string).

    +
    +
    + +
    +
    +class importlib.machinery.FileFinder(path, *loader_details)
    +

    A concrete implementation of importlib.abc.PathEntryFinder which +caches results from the file system.

    +

    The path argument is the directory for which the finder is in charge of +searching.

    +

    The loader_details argument is a variable number of 2-item tuples each +containing a loader and a sequence of file suffixes the loader recognizes. +The loaders are expected to be callables which accept two arguments of +the module’s name and the path to the file found.

    +

    The finder will cache the directory contents as necessary, making stat calls +for each module search to verify the cache is not outdated. Because cache +staleness relies upon the granularity of the operating system’s state +information of the file system, there is a potential race condition of +searching for a module, creating a new file, and then searching for the +module the new file represents. If the operations happen fast enough to fit +within the granularity of stat calls, then the module search will fail. To +prevent this from happening, when you create a module dynamically, make sure +to call importlib.invalidate_caches().

    +
    +

    New in version 3.3.

    +
    +
    +
    +path
    +

    The path the finder will search in.

    +
    + +
    +
    +find_spec(fullname, target=None)
    +

    Attempt to find the spec to handle fullname within path.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +find_loader(fullname)
    +

    Attempt to find the loader to handle fullname within path.

    +
    + +
    +
    +invalidate_caches()
    +

    Clear out the internal cache.

    +
    + +
    +
    +classmethod path_hook(*loader_details)
    +

    A class method which returns a closure for use on sys.path_hooks. +An instance of FileFinder is returned by the closure using the +path argument given to the closure directly and loader_details +indirectly.

    +

    If the argument to the closure is not an existing directory, +ImportError is raised.

    +
    + +
    + +
    +
    +class importlib.machinery.SourceFileLoader(fullname, path)
    +

    A concrete implementation of importlib.abc.SourceLoader by +subclassing importlib.abc.FileLoader and providing some concrete +implementations of other methods.

    +
    +

    New in version 3.3.

    +
    +
    +
    +name
    +

    The name of the module that this loader will handle.

    +
    + +
    +
    +path
    +

    The path to the source file.

    +
    + +
    +
    +is_package(fullname)
    +

    Return true if path appears to be for a package.

    +
    + +
    +
    +path_stats(path)
    +

    Concrete implementation of importlib.abc.SourceLoader.path_stats().

    +
    + +
    +
    +set_data(path, data)
    +

    Concrete implementation of importlib.abc.SourceLoader.set_data().

    +
    + +
    +
    +load_module(name=None)
    +

    Concrete implementation of importlib.abc.Loader.load_module() where +specifying the name of the module to load is optional.

    +
    +

    Deprecated since version 3.6: Use importlib.abc.Loader.exec_module() instead.

    +
    +
    + +
    + +
    +
    +class importlib.machinery.SourcelessFileLoader(fullname, path)
    +

    A concrete implementation of importlib.abc.FileLoader which can +import bytecode files (i.e. no source code files exist).

    +

    Please note that direct use of bytecode files (and thus not source code +files) inhibits your modules from being usable by all Python +implementations or new versions of Python which change the bytecode +format.

    +
    +

    New in version 3.3.

    +
    +
    +
    +name
    +

    The name of the module the loader will handle.

    +
    + +
    +
    +path
    +

    The path to the bytecode file.

    +
    + +
    +
    +is_package(fullname)
    +

    Determines if the module is a package based on path.

    +
    + +
    +
    +get_code(fullname)
    +

    Returns the code object for name created from path.

    +
    + +
    +
    +get_source(fullname)
    +

    Returns None as bytecode files have no source when this loader is +used.

    +
    + +
    +
    +load_module(name=None)
    +
    + +

    Concrete implementation of importlib.abc.Loader.load_module() where +specifying the name of the module to load is optional.

    +
    +

    Deprecated since version 3.6: Use importlib.abc.Loader.exec_module() instead.

    +
    +
    + +
    +
    +class importlib.machinery.ExtensionFileLoader(fullname, path)
    +

    A concrete implementation of importlib.abc.ExecutionLoader for +extension modules.

    +

    The fullname argument specifies the name of the module the loader is to +support. The path argument is the path to the extension module’s file.

    +
    +

    New in version 3.3.

    +
    +
    +
    +name
    +

    Name of the module the loader supports.

    +
    + +
    +
    +path
    +

    Path to the extension module.

    +
    + +
    +
    +create_module(spec)
    +

    Creates the module object from the given specification in accordance +with PEP 489.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +exec_module(module)
    +

    Initializes the given module object in accordance with PEP 489.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +is_package(fullname)
    +

    Returns True if the file path points to a package’s __init__ +module based on EXTENSION_SUFFIXES.

    +
    + +
    +
    +get_code(fullname)
    +

    Returns None as extension modules lack a code object.

    +
    + +
    +
    +get_source(fullname)
    +

    Returns None as extension modules do not have source code.

    +
    + +
    +
    +get_filename(fullname)
    +

    Returns path.

    +
    +

    New in version 3.4.

    +
    +
    + +
    + +
    +
    +class importlib.machinery.ModuleSpec(name, loader, *, origin=None, loader_state=None, is_package=None)
    +

    A specification for a module’s import-system-related state. This is +typically exposed as the module’s __spec__ attribute. In the +descriptions below, the names in parentheses give the corresponding +attribute available directly on the module object. +E.g. module.__spec__.origin == module.__file__. Note however that +while the values are usually equivalent, they can differ since there is +no synchronization between the two objects. Thus it is possible to update +the module’s __path__ at runtime, and this will not be automatically +reflected in __spec__.submodule_search_locations.

    +
    +

    New in version 3.4.

    +
    +
    +
    +name
    +
    + +

    (__name__)

    +

    A string for the fully-qualified name of the module.

    +
    +
    +loader
    +
    + +

    (__loader__)

    +

    The loader to use for loading. For namespace packages this should be +set to None.

    +
    +
    +origin
    +
    + +

    (__file__)

    +

    Name of the place from which the module is loaded, e.g. “builtin” for +built-in modules and the filename for modules loaded from source. +Normally “origin” should be set, but it may be None (the default) +which indicates it is unspecified (e.g. for namespace packages).

    +
    +
    +submodule_search_locations
    +
    + +

    (__path__)

    +

    List of strings for where to find submodules, if a package (None +otherwise).

    +
    +
    +loader_state
    +
    + +

    Container of extra module-specific data for use during loading (or +None).

    +
    +
    +cached
    +
    + +

    (__cached__)

    +

    String for where the compiled module should be stored (or None).

    +
    +
    +parent
    +
    + +

    (__package__)

    +

    (Read-only) Fully-qualified name of the package to which the module +belongs as a submodule (or None).

    +
    +
    +has_location
    +
    + +

    Boolean indicating whether or not the module’s “origin” +attribute refers to a loadable location.

    +
    + +
    +
    +

    importlib.util – Utility code for importers

    +

    Source code: Lib/importlib/util.py

    +
    +

    This module contains the various objects that help in the construction of +an importer.

    +
    +
    +importlib.util.MAGIC_NUMBER
    +

    The bytes which represent the bytecode version number. If you need help with +loading/writing bytecode then consider importlib.abc.SourceLoader.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +importlib.util.cache_from_source(path, debug_override=None, *, optimization=None)
    +

    Return the PEP 3147/PEP 488 path to the byte-compiled file associated +with the source path. For example, if path is /foo/bar/baz.py the return +value would be /foo/bar/__pycache__/baz.cpython-32.pyc for Python 3.2. +The cpython-32 string comes from the current magic tag (see +get_tag(); if sys.implementation.cache_tag is not defined then +NotImplementedError will be raised).

    +

    The optimization parameter is used to specify the optimization level of the +bytecode file. An empty string represents no optimization, so +/foo/bar/baz.py with an optimization of '' will result in a +bytecode path of /foo/bar/__pycache__/baz.cpython-32.pyc. None causes +the interpter’s optimization level to be used. Any other value’s string +representation being used, so /foo/bar/baz.py with an optimization of +2 will lead to the bytecode path of +/foo/bar/__pycache__/baz.cpython-32.opt-2.pyc. The string representation +of optimization can only be alphanumeric, else ValueError is raised.

    +

    The debug_override parameter is deprecated and can be used to override +the system’s value for __debug__. A True value is the equivalent of +setting optimization to the empty string. A False value is the same as +setting optimization to 1. If both debug_override an optimization +are not None then TypeError is raised.

    +
    +

    New in version 3.4.

    +
    +
    +

    Changed in version 3.5: The optimization parameter was added and the debug_override parameter +was deprecated.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +importlib.util.source_from_cache(path)
    +

    Given the path to a PEP 3147 file name, return the associated source code +file path. For example, if path is +/foo/bar/__pycache__/baz.cpython-32.pyc the returned path would be +/foo/bar/baz.py. path need not exist, however if it does not conform +to PEP 3147 or PEP 488 format, a ValueError is raised. If +sys.implementation.cache_tag is not defined, +NotImplementedError is raised.

    +
    +

    New in version 3.4.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +importlib.util.decode_source(source_bytes)
    +

    Decode the given bytes representing source code and return it as a string +with universal newlines (as required by +importlib.abc.InspectLoader.get_source()).

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +importlib.util.resolve_name(name, package)
    +

    Resolve a relative module name to an absolute one.

    +

    If name has no leading dots, then name is simply returned. This +allows for usage such as +importlib.util.resolve_name('sys', __package__) without doing a +check to see if the package argument is needed.

    +

    ValueError is raised if name is a relative module name but +package is a false value (e.g. None or the empty string). +ValueError is also raised a relative name would escape its containing +package (e.g. requesting ..bacon from within the spam package).

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +importlib.util.find_spec(name, package=None)
    +

    Find the spec for a module, optionally relative to +the specified package name. If the module is in sys.modules, +then sys.modules[name].__spec__ is returned (unless the spec would be +None or is not set, in which case ValueError is raised). +Otherwise a search using sys.meta_path is done. None is +returned if no spec is found.

    +

    If name is for a submodule (contains a dot), the parent module is +automatically imported.

    +

    name and package work the same as for import_module().

    +
    +

    New in version 3.4.

    +
    +
    +

    Changed in version 3.7: Raises ModuleNotFoundError instead of AttributeError if +package is in fact not a package (i.e. lacks a __path__ +attribute).

    +
    +
    + +
    +
    +importlib.util.module_from_spec(spec)
    +

    Create a new module based on spec and +spec.loader.create_module.

    +

    If spec.loader.create_module +does not return None, then any pre-existing attributes will not be reset. +Also, no AttributeError will be raised if triggered while accessing +spec or setting an attribute on the module.

    +

    This function is preferred over using types.ModuleType to create a +new module as spec is used to set as many import-controlled attributes on +the module as possible.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +@importlib.util.module_for_loader
    +

    A decorator for importlib.abc.Loader.load_module() +to handle selecting the proper +module object to load with. The decorated method is expected to have a call +signature taking two positional arguments +(e.g. load_module(self, module)) for which the second argument +will be the module object to be used by the loader. +Note that the decorator will not work on static methods because of the +assumption of two arguments.

    +

    The decorated method will take in the name of the module to be loaded +as expected for a loader. If the module is not found in +sys.modules then a new one is constructed. Regardless of where the +module came from, __loader__ set to self and __package__ +is set based on what importlib.abc.InspectLoader.is_package() returns +(if available). These attributes are set unconditionally to support +reloading.

    +

    If an exception is raised by the decorated method and a module was added to +sys.modules, then the module will be removed to prevent a partially +initialized module from being in left in sys.modules. If the module +was already in sys.modules then it is left alone.

    +
    +

    Changed in version 3.3: __loader__ and __package__ are automatically set +(when possible).

    +
    +
    +

    Changed in version 3.4: Set __name__, __loader__ __package__ +unconditionally to support reloading.

    +
    +
    +

    Deprecated since version 3.4: The import machinery now directly performs all the functionality +provided by this function.

    +
    +
    + +
    +
    +@importlib.util.set_loader
    +

    A decorator for importlib.abc.Loader.load_module() +to set the __loader__ +attribute on the returned module. If the attribute is already set the +decorator does nothing. It is assumed that the first positional argument to +the wrapped method (i.e. self) is what __loader__ should be set +to.

    +
    +

    Changed in version 3.4: Set __loader__ if set to None, as if the attribute does not +exist.

    +
    +
    +

    Deprecated since version 3.4: The import machinery takes care of this automatically.

    +
    +
    + +
    +
    +@importlib.util.set_package
    +

    A decorator for importlib.abc.Loader.load_module() to set the +__package__ attribute on the returned module. If __package__ +is set and has a value other than None it will not be changed.

    +
    +

    Deprecated since version 3.4: The import machinery takes care of this automatically.

    +
    +
    + +
    +
    +importlib.util.spec_from_loader(name, loader, *, origin=None, is_package=None)
    +

    A factory function for creating a ModuleSpec instance based +on a loader. The parameters have the same meaning as they do for +ModuleSpec. The function uses available loader APIs, such as +InspectLoader.is_package(), to fill in any missing +information on the spec.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +importlib.util.spec_from_file_location(name, location, *, loader=None, submodule_search_locations=None)
    +

    A factory function for creating a ModuleSpec instance based +on the path to a file. Missing information will be filled in on the +spec by making use of loader APIs and by the implication that the +module will be file-based.

    +
    +

    New in version 3.4.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +importlib.util.source_hash(source_bytes)
    +

    Return the hash of source_bytes as bytes. A hash-based .pyc file embeds +the source_hash() of the corresponding source file’s contents in its +header.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +class importlib.util.LazyLoader(loader)
    +

    A class which postpones the execution of the loader of a module until the +module has an attribute accessed.

    +

    This class only works with loaders that define +exec_module() as control over what module type +is used for the module is required. For those same reasons, the loader’s +create_module() method must return None or a +type for which its __class__ attribute can be mutated along with not +using slots. Finally, modules which substitute the object +placed into sys.modules will not work as there is no way to properly +replace the module references throughout the interpreter safely; +ValueError is raised if such a substitution is detected.

    +
    +

    Note

    +

    For projects where startup time is critical, this class allows for +potentially minimizing the cost of loading a module if it is never used. +For projects where startup time is not essential then use of this class is +heavily discouraged due to error messages created during loading being +postponed and thus occurring out of context.

    +
    +
    +

    New in version 3.5.

    +
    +
    +

    Changed in version 3.6: Began calling create_module(), removing the +compatibility warning for importlib.machinery.BuiltinImporter and +importlib.machinery.ExtensionFileLoader.

    +
    +
    +
    +classmethod factory(loader)
    +

    A static method which returns a callable that creates a lazy loader. This +is meant to be used in situations where the loader is passed by class +instead of by instance.

    +
    suffixes = importlib.machinery.SOURCE_SUFFIXES
    +loader = importlib.machinery.SourceFileLoader
    +lazy_loader = importlib.util.LazyLoader.factory(loader)
    +finder = importlib.machinery.FileFinder(path, (lazy_loader, suffixes))
    +
    +
    +
    + +
    + +
    +
    +

    Examples

    +
    +

    Importing programmatically

    +

    To programmatically import a module, use importlib.import_module().

    +
    import importlib
    +
    +itertools = importlib.import_module('itertools')
    +
    +
    +
    +
    +

    Checking if a module can be imported

    +

    If you need to find out if a module can be imported without actually doing the +import, then you should use importlib.util.find_spec().

    +
    import importlib.util
    +import sys
    +
    +# For illustrative purposes.
    +name = 'itertools'
    +
    +spec = importlib.util.find_spec(name)
    +if spec is None:
    +    print("can't find the itertools module")
    +else:
    +    # If you chose to perform the actual import ...
    +    module = importlib.util.module_from_spec(spec)
    +    spec.loader.exec_module(module)
    +    # Adding the module to sys.modules is optional.
    +    sys.modules[name] = module
    +
    +
    +
    +
    +

    Importing a source file directly

    +

    To import a Python source file directly, use the following recipe +(Python 3.5 and newer only):

    +
    import importlib.util
    +import sys
    +
    +# For illustrative purposes.
    +import tokenize
    +file_path = tokenize.__file__
    +module_name = tokenize.__name__
    +
    +spec = importlib.util.spec_from_file_location(module_name, file_path)
    +module = importlib.util.module_from_spec(spec)
    +spec.loader.exec_module(module)
    +# Optional; only necessary if you want to be able to import the module
    +# by name later.
    +sys.modules[module_name] = module
    +
    +
    +
    +
    +

    Setting up an importer

    +

    For deep customizations of import, you typically want to implement an +importer. This means managing both the finder and loader +side of things. For finders there are two flavours to choose from depending on +your needs: a meta path finder or a path entry finder. The +former is what you would put on sys.meta_path while the latter is what +you create using a path entry hook on sys.path_hooks which works +with sys.path entries to potentially create a finder. This example will +show you how to register your own importers so that import will use them (for +creating an importer for yourself, read the documentation for the appropriate +classes defined within this package):

    +
    import importlib.machinery
    +import sys
    +
    +# For illustrative purposes only.
    +SpamMetaPathFinder = importlib.machinery.PathFinder
    +SpamPathEntryFinder = importlib.machinery.FileFinder
    +loader_details = (importlib.machinery.SourceFileLoader,
    +                  importlib.machinery.SOURCE_SUFFIXES)
    +
    +# Setting up a meta path finder.
    +# Make sure to put the finder in the proper location in the list in terms of
    +# priority.
    +sys.meta_path.append(SpamMetaPathFinder)
    +
    +# Setting up a path entry finder.
    +# Make sure to put the path hook in the proper location in the list in terms
    +# of priority.
    +sys.path_hooks.append(SpamPathEntryFinder.path_hook(loader_details))
    +
    +
    +
    +
    +

    Approximating importlib.import_module()

    +

    Import itself is implemented in Python code, making it possible to +expose most of the import machinery through importlib. The following +helps illustrate the various APIs that importlib exposes by providing an +approximate implementation of +importlib.import_module() (Python 3.4 and newer for the importlib usage, +Python 3.6 and newer for other parts of the code).

    +
    import importlib.util
    +import sys
    +
    +def import_module(name, package=None):
    +    """An approximate implementation of import."""
    +    absolute_name = importlib.util.resolve_name(name, package)
    +    try:
    +        return sys.modules[absolute_name]
    +    except KeyError:
    +        pass
    +
    +    path = None
    +    if '.' in absolute_name:
    +        parent_name, _, child_name = absolute_name.rpartition('.')
    +        parent_module = import_module(parent_name)
    +        path = parent_module.__spec__.submodule_search_locations
    +    for finder in sys.meta_path:
    +        spec = finder.find_spec(absolute_name, path)
    +        if spec is not None:
    +            break
    +    else:
    +        msg = f'No module named {absolute_name!r}'
    +        raise ModuleNotFoundError(msg, name=absolute_name)
    +    module = importlib.util.module_from_spec(spec)
    +    spec.loader.exec_module(module)
    +    sys.modules[absolute_name] = module
    +    if path is not None:
    +        setattr(parent_module, child_name, module)
    +    return module
    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/index.html b/python-3.7.4-docs-html/library/index.html new file mode 100644 index 0000000..05b573d --- /dev/null +++ b/python-3.7.4-docs-html/library/index.html @@ -0,0 +1,587 @@ + + + + + + + The Python Standard Library — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    The Python Standard Library

    +

    While The Python Language Reference describes the exact syntax and +semantics of the Python language, this library reference manual +describes the standard library that is distributed with Python. It also +describes some of the optional components that are commonly included +in Python distributions.

    +

    Python’s standard library is very extensive, offering a wide range of +facilities as indicated by the long table of contents listed below. The +library contains built-in modules (written in C) that provide access to +system functionality such as file I/O that would otherwise be +inaccessible to Python programmers, as well as modules written in Python +that provide standardized solutions for many problems that occur in +everyday programming. Some of these modules are explicitly designed to +encourage and enhance the portability of Python programs by abstracting +away platform-specifics into platform-neutral APIs.

    +

    The Python installers for the Windows platform usually include +the entire standard library and often also include many additional +components. For Unix-like operating systems Python is normally provided +as a collection of packages, so it may be necessary to use the packaging +tools provided with the operating system to obtain some or all of the +optional components.

    +

    In addition to the standard library, there is a growing collection of +several thousand components (from individual programs and modules to +packages and entire application development frameworks), available from +the Python Package Index.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/inspect.html b/python-3.7.4-docs-html/library/inspect.html new file mode 100644 index 0000000..1c0839f --- /dev/null +++ b/python-3.7.4-docs-html/library/inspect.html @@ -0,0 +1,1801 @@ + + + + + + + inspect — Inspect live objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    inspect — Inspect live objects

    +

    Source code: Lib/inspect.py

    +
    +

    The inspect module provides several useful functions to help get +information about live objects such as modules, classes, methods, functions, +tracebacks, frame objects, and code objects. For example, it can help you +examine the contents of a class, retrieve the source code of a method, extract +and format the argument list for a function, or get all the information you need +to display a detailed traceback.

    +

    There are four main kinds of services provided by this module: type checking, +getting source code, inspecting classes and functions, and examining the +interpreter stack.

    +
    +

    Types and members

    +

    The getmembers() function retrieves the members of an object such as a +class or module. The functions whose names begin with “is” are mainly +provided as convenient choices for the second argument to getmembers(). +They also help you determine when you can expect to find the following special +attributes:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Type

    Attribute

    Description

    module

    __doc__

    documentation string

    __file__

    filename (missing for +built-in modules)

    class

    __doc__

    documentation string

    __name__

    name with which this +class was defined

    __qualname__

    qualified name

    __module__

    name of module in which +this class was defined

    method

    __doc__

    documentation string

    __name__

    name with which this +method was defined

    __qualname__

    qualified name

    __func__

    function object +containing implementation +of method

    __self__

    instance to which this +method is bound, or +None

    function

    __doc__

    documentation string

    __name__

    name with which this +function was defined

    __qualname__

    qualified name

    __code__

    code object containing +compiled function +bytecode

    __defaults__

    tuple of any default +values for positional or +keyword parameters

    __kwdefaults__

    mapping of any default +values for keyword-only +parameters

    __globals__

    global namespace in which +this function was defined

    __annotations__

    mapping of parameters +names to annotations; +"return" key is +reserved for return +annotations.

    traceback

    tb_frame

    frame object at this +level

    tb_lasti

    index of last attempted +instruction in bytecode

    tb_lineno

    current line number in +Python source code

    tb_next

    next inner traceback +object (called by this +level)

    frame

    f_back

    next outer frame object +(this frame’s caller)

    f_builtins

    builtins namespace seen +by this frame

    f_code

    code object being +executed in this frame

    f_globals

    global namespace seen by +this frame

    f_lasti

    index of last attempted +instruction in bytecode

    f_lineno

    current line number in +Python source code

    f_locals

    local namespace seen by +this frame

    f_trace

    tracing function for this +frame, or None

    code

    co_argcount

    number of arguments (not +including keyword only +arguments, * or ** +args)

    co_code

    string of raw compiled +bytecode

    co_cellvars

    tuple of names of cell +variables (referenced by +containing scopes)

    co_consts

    tuple of constants used +in the bytecode

    co_filename

    name of file in which +this code object was +created

    co_firstlineno

    number of first line in +Python source code

    co_flags

    bitmap of CO_* flags, +read more here

    co_lnotab

    encoded mapping of line +numbers to bytecode +indices

    co_freevars

    tuple of names of free +variables (referenced via +a function’s closure)

    co_kwonlyargcount

    number of keyword only +arguments (not including +** arg)

    co_name

    name with which this code +object was defined

    co_names

    tuple of names of local +variables

    co_nlocals

    number of local variables

    co_stacksize

    virtual machine stack +space required

    co_varnames

    tuple of names of +arguments and local +variables

    generator

    __name__

    name

    __qualname__

    qualified name

    gi_frame

    frame

    gi_running

    is the generator running?

    gi_code

    code

    gi_yieldfrom

    object being iterated by +yield from, or +None

    coroutine

    __name__

    name

    __qualname__

    qualified name

    cr_await

    object being awaited on, +or None

    cr_frame

    frame

    cr_running

    is the coroutine running?

    cr_code

    code

    cr_origin

    where coroutine was +created, or None. See +sys.set_coroutine_origin_tracking_depth()

    builtin

    __doc__

    documentation string

    __name__

    original name of this +function or method

    __qualname__

    qualified name

    __self__

    instance to which a +method is bound, or +None

    +
    +

    Changed in version 3.5: Add __qualname__ and gi_yieldfrom attributes to generators.

    +

    The __name__ attribute of generators is now set from the function +name, instead of the code name, and it can now be modified.

    +
    +
    +

    Changed in version 3.7: Add cr_origin attribute to coroutines.

    +
    +
    +
    +inspect.getmembers(object[, predicate])
    +

    Return all the members of an object in a list of (name, value) pairs sorted by +name. If the optional predicate argument is supplied, only members for which +the predicate returns a true value are included.

    +
    +

    Note

    +

    getmembers() will only return class attributes defined in the +metaclass when the argument is a class and those attributes have been +listed in the metaclass’ custom __dir__().

    +
    +
    + +
    +
    +inspect.getmodulename(path)
    +

    Return the name of the module named by the file path, without including the +names of enclosing packages. The file extension is checked against all of +the entries in importlib.machinery.all_suffixes(). If it matches, +the final path component is returned with the extension removed. +Otherwise, None is returned.

    +

    Note that this function only returns a meaningful name for actual +Python modules - paths that potentially refer to Python packages will +still return None.

    +
    +

    Changed in version 3.3: The function is based directly on importlib.

    +
    +
    + +
    +
    +inspect.ismodule(object)
    +

    Return true if the object is a module.

    +
    + +
    +
    +inspect.isclass(object)
    +

    Return true if the object is a class, whether built-in or created in Python +code.

    +
    + +
    +
    +inspect.ismethod(object)
    +

    Return true if the object is a bound method written in Python.

    +
    + +
    +
    +inspect.isfunction(object)
    +

    Return true if the object is a Python function, which includes functions +created by a lambda expression.

    +
    + +
    +
    +inspect.isgeneratorfunction(object)
    +

    Return true if the object is a Python generator function.

    +
    + +
    +
    +inspect.isgenerator(object)
    +

    Return true if the object is a generator.

    +
    + +
    +
    +inspect.iscoroutinefunction(object)
    +

    Return true if the object is a coroutine function +(a function defined with an async def syntax).

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +inspect.iscoroutine(object)
    +

    Return true if the object is a coroutine created by an +async def function.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +inspect.isawaitable(object)
    +

    Return true if the object can be used in await expression.

    +

    Can also be used to distinguish generator-based coroutines from regular +generators:

    +
    def gen():
    +    yield
    +@types.coroutine
    +def gen_coro():
    +    yield
    +
    +assert not isawaitable(gen())
    +assert isawaitable(gen_coro())
    +
    +
    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +inspect.isasyncgenfunction(object)
    +

    Return true if the object is an asynchronous generator function, +for example:

    +
    >>> async def agen():
    +...     yield 1
    +...
    +>>> inspect.isasyncgenfunction(agen)
    +True
    +
    +
    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +inspect.isasyncgen(object)
    +

    Return true if the object is an asynchronous generator iterator +created by an asynchronous generator function.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +inspect.istraceback(object)
    +

    Return true if the object is a traceback.

    +
    + +
    +
    +inspect.isframe(object)
    +

    Return true if the object is a frame.

    +
    + +
    +
    +inspect.iscode(object)
    +

    Return true if the object is a code.

    +
    + +
    +
    +inspect.isbuiltin(object)
    +

    Return true if the object is a built-in function or a bound built-in method.

    +
    + +
    +
    +inspect.isroutine(object)
    +

    Return true if the object is a user-defined or built-in function or method.

    +
    + +
    +
    +inspect.isabstract(object)
    +

    Return true if the object is an abstract base class.

    +
    + +
    +
    +inspect.ismethoddescriptor(object)
    +

    Return true if the object is a method descriptor, but not if +ismethod(), isclass(), isfunction() or isbuiltin() +are true.

    +

    This, for example, is true of int.__add__. An object passing this test +has a __get__() method but not a __set__() +method, but beyond that the set of attributes varies. A +__name__ attribute is usually +sensible, and __doc__ often is.

    +

    Methods implemented via descriptors that also pass one of the other tests +return false from the ismethoddescriptor() test, simply because the +other tests promise more – you can, e.g., count on having the +__func__ attribute (etc) when an object passes ismethod().

    +
    + +
    +
    +inspect.isdatadescriptor(object)
    +

    Return true if the object is a data descriptor.

    +

    Data descriptors have both a __get__ and a __set__ method. +Examples are properties (defined in Python), getsets, and members. The +latter two are defined in C and there are more specific tests available for +those types, which is robust across Python implementations. Typically, data +descriptors will also have __name__ and __doc__ attributes +(properties, getsets, and members have both of these attributes), but this is +not guaranteed.

    +
    + +
    +
    +inspect.isgetsetdescriptor(object)
    +

    Return true if the object is a getset descriptor.

    +
    +

    CPython implementation detail: getsets are attributes defined in extension modules via +PyGetSetDef structures. For Python implementations without such +types, this method will always return False.

    +
    +
    + +
    +
    +inspect.ismemberdescriptor(object)
    +

    Return true if the object is a member descriptor.

    +
    +

    CPython implementation detail: Member descriptors are attributes defined in extension modules via +PyMemberDef structures. For Python implementations without such +types, this method will always return False.

    +
    +
    + +
    +
    +

    Retrieving source code

    +
    +
    +inspect.getdoc(object)
    +

    Get the documentation string for an object, cleaned up with cleandoc(). +If the documentation string for an object is not provided and the object is +a class, a method, a property or a descriptor, retrieve the documentation +string from the inheritance hierarchy.

    +
    +

    Changed in version 3.5: Documentation strings are now inherited if not overridden.

    +
    +
    + +
    +
    +inspect.getcomments(object)
    +

    Return in a single string any lines of comments immediately preceding the +object’s source code (for a class, function, or method), or at the top of the +Python source file (if the object is a module). If the object’s source code +is unavailable, return None. This could happen if the object has been +defined in C or the interactive shell.

    +
    + +
    +
    +inspect.getfile(object)
    +

    Return the name of the (text or binary) file in which an object was defined. +This will fail with a TypeError if the object is a built-in module, +class, or function.

    +
    + +
    +
    +inspect.getmodule(object)
    +

    Try to guess which module an object was defined in.

    +
    + +
    +
    +inspect.getsourcefile(object)
    +

    Return the name of the Python source file in which an object was defined. This +will fail with a TypeError if the object is a built-in module, class, or +function.

    +
    + +
    +
    +inspect.getsourcelines(object)
    +

    Return a list of source lines and starting line number for an object. The +argument may be a module, class, method, function, traceback, frame, or code +object. The source code is returned as a list of the lines corresponding to the +object and the line number indicates where in the original source file the first +line of code was found. An OSError is raised if the source code cannot +be retrieved.

    +
    +

    Changed in version 3.3: OSError is raised instead of IOError, now an alias of the +former.

    +
    +
    + +
    +
    +inspect.getsource(object)
    +

    Return the text of the source code for an object. The argument may be a module, +class, method, function, traceback, frame, or code object. The source code is +returned as a single string. An OSError is raised if the source code +cannot be retrieved.

    +
    +

    Changed in version 3.3: OSError is raised instead of IOError, now an alias of the +former.

    +
    +
    + +
    +
    +inspect.cleandoc(doc)
    +

    Clean up indentation from docstrings that are indented to line up with blocks +of code.

    +

    All leading whitespace is removed from the first line. Any leading whitespace +that can be uniformly removed from the second line onwards is removed. Empty +lines at the beginning and end are subsequently removed. Also, all tabs are +expanded to spaces.

    +
    + +
    +
    +

    Introspecting callables with the Signature object

    +
    +

    New in version 3.3.

    +
    +

    The Signature object represents the call signature of a callable object and its +return annotation. To retrieve a Signature object, use the signature() +function.

    +
    +
    +inspect.signature(callable, *, follow_wrapped=True)
    +

    Return a Signature object for the given callable:

    +
    >>> from inspect import signature
    +>>> def foo(a, *, b:int, **kwargs):
    +...     pass
    +
    +>>> sig = signature(foo)
    +
    +>>> str(sig)
    +'(a, *, b:int, **kwargs)'
    +
    +>>> str(sig.parameters['b'])
    +'b:int'
    +
    +>>> sig.parameters['b'].annotation
    +<class 'int'>
    +
    +
    +

    Accepts a wide range of Python callables, from plain functions and classes to +functools.partial() objects.

    +

    Raises ValueError if no signature can be provided, and +TypeError if that type of object is not supported.

    +

    A slash(/) in the signature of a function denotes that the parameters prior +to it are positional-only. For more info, see +the FAQ entry on positional-only parameters.

    +
    +

    New in version 3.5: follow_wrapped parameter. Pass False to get a signature of +callable specifically (callable.__wrapped__ will not be used to +unwrap decorated callables.)

    +
    +
    +

    Note

    +

    Some callables may not be introspectable in certain implementations of +Python. For example, in CPython, some built-in functions defined in +C provide no metadata about their arguments.

    +
    +
    + +
    +
    +class inspect.Signature(parameters=None, *, return_annotation=Signature.empty)
    +

    A Signature object represents the call signature of a function and its return +annotation. For each parameter accepted by the function it stores a +Parameter object in its parameters collection.

    +

    The optional parameters argument is a sequence of Parameter +objects, which is validated to check that there are no parameters with +duplicate names, and that the parameters are in the right order, i.e. +positional-only first, then positional-or-keyword, and that parameters with +defaults follow parameters without defaults.

    +

    The optional return_annotation argument, can be an arbitrary Python object, +is the “return” annotation of the callable.

    +

    Signature objects are immutable. Use Signature.replace() to make a +modified copy.

    +
    +

    Changed in version 3.5: Signature objects are picklable and hashable.

    +
    +
    +
    +empty
    +

    A special class-level marker to specify absence of a return annotation.

    +
    + +
    +
    +parameters
    +

    An ordered mapping of parameters’ names to the corresponding +Parameter objects. Parameters appear in strict definition +order, including keyword-only parameters.

    +
    +

    Changed in version 3.7: Python only explicitly guaranteed that it preserved the declaration +order of keyword-only parameters as of version 3.7, although in practice +this order had always been preserved in Python 3.

    +
    +
    + +
    +
    +return_annotation
    +

    The “return” annotation for the callable. If the callable has no “return” +annotation, this attribute is set to Signature.empty.

    +
    + +
    +
    +bind(*args, **kwargs)
    +

    Create a mapping from positional and keyword arguments to parameters. +Returns BoundArguments if *args and **kwargs match the +signature, or raises a TypeError.

    +
    + +
    +
    +bind_partial(*args, **kwargs)
    +

    Works the same way as Signature.bind(), but allows the omission of +some required arguments (mimics functools.partial() behavior.) +Returns BoundArguments, or raises a TypeError if the +passed arguments do not match the signature.

    +
    + +
    +
    +replace(*[, parameters][, return_annotation])
    +

    Create a new Signature instance based on the instance replace was invoked +on. It is possible to pass different parameters and/or +return_annotation to override the corresponding properties of the base +signature. To remove return_annotation from the copied Signature, pass in +Signature.empty.

    +
    >>> def test(a, b):
    +...     pass
    +>>> sig = signature(test)
    +>>> new_sig = sig.replace(return_annotation="new return anno")
    +>>> str(new_sig)
    +"(a, b) -> 'new return anno'"
    +
    +
    +
    + +
    +
    +classmethod from_callable(obj, *, follow_wrapped=True)
    +

    Return a Signature (or its subclass) object for a given callable +obj. Pass follow_wrapped=False to get a signature of obj +without unwrapping its __wrapped__ chain.

    +

    This method simplifies subclassing of Signature:

    +
    class MySignature(Signature):
    +    pass
    +sig = MySignature.from_callable(min)
    +assert isinstance(sig, MySignature)
    +
    +
    +
    +

    New in version 3.5.

    +
    +
    + +
    + +
    +
    +class inspect.Parameter(name, kind, *, default=Parameter.empty, annotation=Parameter.empty)
    +

    Parameter objects are immutable. Instead of modifying a Parameter object, +you can use Parameter.replace() to create a modified copy.

    +
    +

    Changed in version 3.5: Parameter objects are picklable and hashable.

    +
    +
    +
    +empty
    +

    A special class-level marker to specify absence of default values and +annotations.

    +
    + +
    +
    +name
    +

    The name of the parameter as a string. The name must be a valid +Python identifier.

    +
    +

    CPython implementation detail: CPython generates implicit parameter names of the form .0 on the +code objects used to implement comprehensions and generator +expressions.

    +
    +

    Changed in version 3.6: These parameter names are exposed by this module as names like +implicit0.

    +
    +
    +
    + +
    +
    +default
    +

    The default value for the parameter. If the parameter has no default +value, this attribute is set to Parameter.empty.

    +
    + +
    +
    +annotation
    +

    The annotation for the parameter. If the parameter has no annotation, +this attribute is set to Parameter.empty.

    +
    + +
    +
    +kind
    +

    Describes how argument values are bound to the parameter. Possible values +(accessible via Parameter, like Parameter.KEYWORD_ONLY):

    + ++++ + + + + + + + + + + + + + + + + + + + + + + +

    Name

    Meaning

    POSITIONAL_ONLY

    Value must be supplied as a positional +argument.

    +

    Python has no explicit syntax for defining +positional-only parameters, but many built-in +and extension module functions (especially +those that accept only one or two parameters) +accept them.

    +

    POSITIONAL_OR_KEYWORD

    Value may be supplied as either a keyword or +positional argument (this is the standard +binding behaviour for functions implemented +in Python.)

    VAR_POSITIONAL

    A tuple of positional arguments that aren’t +bound to any other parameter. This +corresponds to a *args parameter in a +Python function definition.

    KEYWORD_ONLY

    Value must be supplied as a keyword argument. +Keyword only parameters are those which +appear after a * or *args entry in a +Python function definition.

    VAR_KEYWORD

    A dict of keyword arguments that aren’t bound +to any other parameter. This corresponds to a +**kwargs parameter in a Python function +definition.

    +

    Example: print all keyword-only arguments without default values:

    +
    >>> def foo(a, b, *, c, d=10):
    +...     pass
    +
    +>>> sig = signature(foo)
    +>>> for param in sig.parameters.values():
    +...     if (param.kind == param.KEYWORD_ONLY and
    +...                        param.default is param.empty):
    +...         print('Parameter:', param)
    +Parameter: c
    +
    +
    +
    + +
    +
    +replace(*[, name][, kind][, default][, annotation])
    +
    +

    Create a new Parameter instance based on the instance replaced was invoked +on. To override a Parameter attribute, pass the corresponding +argument. To remove a default value or/and an annotation from a +Parameter, pass Parameter.empty.

    +
    >>> from inspect import Parameter
    +>>> param = Parameter('foo', Parameter.KEYWORD_ONLY, default=42)
    +>>> str(param)
    +'foo=42'
    +
    +>>> str(param.replace()) # Will create a shallow copy of 'param'
    +'foo=42'
    +
    +>>> str(param.replace(default=Parameter.empty, annotation='spam'))
    +"foo:'spam'"
    +
    +
    +
    +
    +

    Changed in version 3.4: In Python 3.3 Parameter objects were allowed to have name set +to None if their kind was set to POSITIONAL_ONLY. +This is no longer permitted.

    +
    +
    + +
    + +
    +
    +class inspect.BoundArguments
    +

    Result of a Signature.bind() or Signature.bind_partial() call. +Holds the mapping of arguments to the function’s parameters.

    +
    +
    +arguments
    +

    An ordered, mutable mapping (collections.OrderedDict) of +parameters’ names to arguments’ values. Contains only explicitly bound +arguments. Changes in arguments will reflect in args and +kwargs.

    +

    Should be used in conjunction with Signature.parameters for any +argument processing purposes.

    +
    +

    Note

    +

    Arguments for which Signature.bind() or +Signature.bind_partial() relied on a default value are skipped. +However, if needed, use BoundArguments.apply_defaults() to add +them.

    +
    +
    + +
    +
    +args
    +

    A tuple of positional arguments values. Dynamically computed from the +arguments attribute.

    +
    + +
    +
    +kwargs
    +

    A dict of keyword arguments values. Dynamically computed from the +arguments attribute.

    +
    + +
    +
    +signature
    +

    A reference to the parent Signature object.

    +
    + +
    +
    +apply_defaults()
    +

    Set default values for missing arguments.

    +

    For variable-positional arguments (*args) the default is an +empty tuple.

    +

    For variable-keyword arguments (**kwargs) the default is an +empty dict.

    +
    >>> def foo(a, b='ham', *args): pass
    +>>> ba = inspect.signature(foo).bind('spam')
    +>>> ba.apply_defaults()
    +>>> ba.arguments
    +OrderedDict([('a', 'spam'), ('b', 'ham'), ('args', ())])
    +
    +
    +
    +

    New in version 3.5.

    +
    +
    + +

    The args and kwargs properties can be used to invoke +functions:

    +
    def test(a, *, b):
    +    ...
    +
    +sig = signature(test)
    +ba = sig.bind(10, b=20)
    +test(*ba.args, **ba.kwargs)
    +
    +
    +
    + +
    +

    See also

    +
    +
    PEP 362 - Function Signature Object.

    The detailed specification, implementation details and examples.

    +
    +
    +
    +
    +
    +

    Classes and functions

    +
    +
    +inspect.getclasstree(classes, unique=False)
    +

    Arrange the given list of classes into a hierarchy of nested lists. Where a +nested list appears, it contains classes derived from the class whose entry +immediately precedes the list. Each entry is a 2-tuple containing a class and a +tuple of its base classes. If the unique argument is true, exactly one entry +appears in the returned structure for each class in the given list. Otherwise, +classes using multiple inheritance and their descendants will appear multiple +times.

    +
    + +
    +
    +inspect.getargspec(func)
    +

    Get the names and default values of a Python function’s parameters. A +named tuple ArgSpec(args, varargs, keywords, defaults) is +returned. args is a list of the parameter names. varargs and keywords +are the names of the * and ** parameters or None. defaults is a +tuple of default argument values or None if there are no default +arguments; if this tuple has n elements, they correspond to the last +n elements listed in args.

    +
    +

    Deprecated since version 3.0: Use getfullargspec() for an updated API that is usually a drop-in +replacement, but also correctly handles function annotations and +keyword-only parameters.

    +

    Alternatively, use signature() and +Signature Object, which provide a +more structured introspection API for callables.

    +
    +
    + +
    +
    +inspect.getfullargspec(func)
    +

    Get the names and default values of a Python function’s parameters. A +named tuple is returned:

    +

    FullArgSpec(args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, +annotations)

    +

    args is a list of the positional parameter names. +varargs is the name of the * parameter or None if arbitrary +positional arguments are not accepted. +varkw is the name of the ** parameter or None if arbitrary +keyword arguments are not accepted. +defaults is an n-tuple of default argument values corresponding to the +last n positional parameters, or None if there are no such defaults +defined. +kwonlyargs is a list of keyword-only parameter names in declaration order. +kwonlydefaults is a dictionary mapping parameter names from kwonlyargs +to the default values used if no argument is supplied. +annotations is a dictionary mapping parameter names to annotations. +The special key "return" is used to report the function return value +annotation (if any).

    +

    Note that signature() and +Signature Object provide the recommended +API for callable introspection, and support additional behaviours (like +positional-only arguments) that are sometimes encountered in extension module +APIs. This function is retained primarily for use in code that needs to +maintain compatibility with the Python 2 inspect module API.

    +
    +

    Changed in version 3.4: This function is now based on signature(), but still ignores +__wrapped__ attributes and includes the already bound first +parameter in the signature output for bound methods.

    +
    +
    +

    Changed in version 3.6: This method was previously documented as deprecated in favour of +signature() in Python 3.5, but that decision has been reversed +in order to restore a clearly supported standard interface for +single-source Python 2/3 code migrating away from the legacy +getargspec() API.

    +
    +
    +

    Changed in version 3.7: Python only explicitly guaranteed that it preserved the declaration +order of keyword-only parameters as of version 3.7, although in practice +this order had always been preserved in Python 3.

    +
    +
    + +
    +
    +inspect.getargvalues(frame)
    +

    Get information about arguments passed into a particular frame. A +named tuple ArgInfo(args, varargs, keywords, locals) is +returned. args is a list of the argument names. varargs and keywords +are the names of the * and ** arguments or None. locals is the +locals dictionary of the given frame.

    +
    +

    Note

    +

    This function was inadvertently marked as deprecated in Python 3.5.

    +
    +
    + +
    +
    +inspect.formatargspec(args[, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations[, formatarg, formatvarargs, formatvarkw, formatvalue, formatreturns, formatannotations]])
    +

    Format a pretty argument spec from the values returned by +getfullargspec().

    +

    The first seven arguments are (args, varargs, varkw, +defaults, kwonlyargs, kwonlydefaults, annotations).

    +

    The other six arguments are functions that are called to turn argument names, +* argument name, ** argument name, default values, return annotation +and individual annotations into strings, respectively.

    +

    For example:

    +
    >>> from inspect import formatargspec, getfullargspec
    +>>> def f(a: int, b: float):
    +...     pass
    +...
    +>>> formatargspec(*getfullargspec(f))
    +'(a: int, b: float)'
    +
    +
    +
    +

    Deprecated since version 3.5: Use signature() and +Signature Object, which provide a +better introspecting API for callables.

    +
    +
    + +
    +
    +inspect.formatargvalues(args[, varargs, varkw, locals, formatarg, formatvarargs, formatvarkw, formatvalue])
    +

    Format a pretty argument spec from the four values returned by +getargvalues(). The format* arguments are the corresponding optional +formatting functions that are called to turn names and values into strings.

    +
    +

    Note

    +

    This function was inadvertently marked as deprecated in Python 3.5.

    +
    +
    + +
    +
    +inspect.getmro(cls)
    +

    Return a tuple of class cls’s base classes, including cls, in method resolution +order. No class appears more than once in this tuple. Note that the method +resolution order depends on cls’s type. Unless a very peculiar user-defined +metatype is in use, cls will be the first element of the tuple.

    +
    + +
    +
    +inspect.getcallargs(func, *args, **kwds)
    +

    Bind the args and kwds to the argument names of the Python function or +method func, as if it was called with them. For bound methods, bind also the +first argument (typically named self) to the associated instance. A dict +is returned, mapping the argument names (including the names of the * and +** arguments, if any) to their values from args and kwds. In case of +invoking func incorrectly, i.e. whenever func(*args, **kwds) would raise +an exception because of incompatible signature, an exception of the same type +and the same or similar message is raised. For example:

    +
    >>> from inspect import getcallargs
    +>>> def f(a, b=1, *pos, **named):
    +...     pass
    +>>> getcallargs(f, 1, 2, 3) == {'a': 1, 'named': {}, 'b': 2, 'pos': (3,)}
    +True
    +>>> getcallargs(f, a=2, x=4) == {'a': 2, 'named': {'x': 4}, 'b': 1, 'pos': ()}
    +True
    +>>> getcallargs(f)
    +Traceback (most recent call last):
    +...
    +TypeError: f() missing 1 required positional argument: 'a'
    +
    +
    +
    +

    New in version 3.2.

    +
    +
    +

    Deprecated since version 3.5: Use Signature.bind() and Signature.bind_partial() instead.

    +
    +
    + +
    +
    +inspect.getclosurevars(func)
    +

    Get the mapping of external name references in a Python function or +method func to their current values. A +named tuple ClosureVars(nonlocals, globals, builtins, unbound) +is returned. nonlocals maps referenced names to lexical closure +variables, globals to the function’s module globals and builtins to +the builtins visible from the function body. unbound is the set of names +referenced in the function that could not be resolved at all given the +current module globals and builtins.

    +

    TypeError is raised if func is not a Python function or method.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +inspect.unwrap(func, *, stop=None)
    +

    Get the object wrapped by func. It follows the chain of __wrapped__ +attributes returning the last object in the chain.

    +

    stop is an optional callback accepting an object in the wrapper chain +as its sole argument that allows the unwrapping to be terminated early if +the callback returns a true value. If the callback never returns a true +value, the last object in the chain is returned as usual. For example, +signature() uses this to stop unwrapping if any object in the +chain has a __signature__ attribute defined.

    +

    ValueError is raised if a cycle is encountered.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +

    The interpreter stack

    +

    When the following functions return “frame records,” each record is a +named tuple +FrameInfo(frame, filename, lineno, function, code_context, index). +The tuple contains the frame object, the filename, the line number of the +current line, +the function name, a list of lines of context from the source code, and the +index of the current line within that list.

    +
    +

    Changed in version 3.5: Return a named tuple instead of a tuple.

    +
    +
    +

    Note

    +

    Keeping references to frame objects, as found in the first element of the frame +records these functions return, can cause your program to create reference +cycles. Once a reference cycle has been created, the lifespan of all objects +which can be accessed from the objects which form the cycle can become much +longer even if Python’s optional cycle detector is enabled. If such cycles must +be created, it is important to ensure they are explicitly broken to avoid the +delayed destruction of objects and increased memory consumption which occurs.

    +

    Though the cycle detector will catch these, destruction of the frames (and local +variables) can be made deterministic by removing the cycle in a +finally clause. This is also important if the cycle detector was +disabled when Python was compiled or using gc.disable(). For example:

    +
    def handle_stackframe_without_leak():
    +    frame = inspect.currentframe()
    +    try:
    +        # do something with the frame
    +    finally:
    +        del frame
    +
    +
    +

    If you want to keep the frame around (for example to print a traceback +later), you can also break reference cycles by using the +frame.clear() method.

    +
    +

    The optional context argument supported by most of these functions specifies +the number of lines of context to return, which are centered around the current +line.

    +
    +
    +inspect.getframeinfo(frame, context=1)
    +

    Get information about a frame or traceback object. A named tuple +Traceback(filename, lineno, function, code_context, index) is returned.

    +
    + +
    +
    +inspect.getouterframes(frame, context=1)
    +

    Get a list of frame records for a frame and all outer frames. These frames +represent the calls that lead to the creation of frame. The first entry in the +returned list represents frame; the last entry represents the outermost call +on frame’s stack.

    +
    +

    Changed in version 3.5: A list of named tuples +FrameInfo(frame, filename, lineno, function, code_context, index) +is returned.

    +
    +
    + +
    +
    +inspect.getinnerframes(traceback, context=1)
    +

    Get a list of frame records for a traceback’s frame and all inner frames. These +frames represent calls made as a consequence of frame. The first entry in the +list represents traceback; the last entry represents where the exception was +raised.

    +
    +

    Changed in version 3.5: A list of named tuples +FrameInfo(frame, filename, lineno, function, code_context, index) +is returned.

    +
    +
    + +
    +
    +inspect.currentframe()
    +

    Return the frame object for the caller’s stack frame.

    +
    +

    CPython implementation detail: This function relies on Python stack frame support in the interpreter, +which isn’t guaranteed to exist in all implementations of Python. If +running in an implementation without Python stack frame support this +function returns None.

    +
    +
    + +
    +
    +inspect.stack(context=1)
    +

    Return a list of frame records for the caller’s stack. The first entry in the +returned list represents the caller; the last entry represents the outermost +call on the stack.

    +
    +

    Changed in version 3.5: A list of named tuples +FrameInfo(frame, filename, lineno, function, code_context, index) +is returned.

    +
    +
    + +
    +
    +inspect.trace(context=1)
    +

    Return a list of frame records for the stack between the current frame and the +frame in which an exception currently being handled was raised in. The first +entry in the list represents the caller; the last entry represents where the +exception was raised.

    +
    +

    Changed in version 3.5: A list of named tuples +FrameInfo(frame, filename, lineno, function, code_context, index) +is returned.

    +
    +
    + +
    +
    +

    Fetching attributes statically

    +

    Both getattr() and hasattr() can trigger code execution when +fetching or checking for the existence of attributes. Descriptors, like +properties, will be invoked and __getattr__() and __getattribute__() +may be called.

    +

    For cases where you want passive introspection, like documentation tools, this +can be inconvenient. getattr_static() has the same signature as getattr() +but avoids executing code when it fetches attributes.

    +
    +
    +inspect.getattr_static(obj, attr, default=None)
    +

    Retrieve attributes without triggering dynamic lookup via the +descriptor protocol, __getattr__() or __getattribute__().

    +

    Note: this function may not be able to retrieve all attributes +that getattr can fetch (like dynamically created attributes) +and may find attributes that getattr can’t (like descriptors +that raise AttributeError). It can also return descriptors objects +instead of instance members.

    +

    If the instance __dict__ is shadowed by another member (for +example a property) then this function will be unable to find instance +members.

    +
    +

    New in version 3.2.

    +
    +
    + +

    getattr_static() does not resolve descriptors, for example slot descriptors or +getset descriptors on objects implemented in C. The descriptor object +is returned instead of the underlying attribute.

    +

    You can handle these with code like the following. Note that +for arbitrary getset descriptors invoking these may trigger +code execution:

    +
    # example code for resolving the builtin descriptor types
    +class _foo:
    +    __slots__ = ['foo']
    +
    +slot_descriptor = type(_foo.foo)
    +getset_descriptor = type(type(open(__file__)).name)
    +wrapper_descriptor = type(str.__dict__['__add__'])
    +descriptor_types = (slot_descriptor, getset_descriptor, wrapper_descriptor)
    +
    +result = getattr_static(some_object, 'foo')
    +if type(result) in descriptor_types:
    +    try:
    +        result = result.__get__()
    +    except AttributeError:
    +        # descriptors can raise AttributeError to
    +        # indicate there is no underlying value
    +        # in which case the descriptor itself will
    +        # have to do
    +        pass
    +
    +
    +
    +
    +

    Current State of Generators and Coroutines

    +

    When implementing coroutine schedulers and for other advanced uses of +generators, it is useful to determine whether a generator is currently +executing, is waiting to start or resume or execution, or has already +terminated. getgeneratorstate() allows the current state of a +generator to be determined easily.

    +
    +
    +inspect.getgeneratorstate(generator)
    +

    Get current state of a generator-iterator.

    +
    +
    Possible states are:
      +
    • GEN_CREATED: Waiting to start execution.

    • +
    • GEN_RUNNING: Currently being executed by the interpreter.

    • +
    • GEN_SUSPENDED: Currently suspended at a yield expression.

    • +
    • GEN_CLOSED: Execution has completed.

    • +
    +
    +
    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +inspect.getcoroutinestate(coroutine)
    +

    Get current state of a coroutine object. The function is intended to be +used with coroutine objects created by async def functions, but +will accept any coroutine-like object that has cr_running and +cr_frame attributes.

    +
    +
    Possible states are:
      +
    • CORO_CREATED: Waiting to start execution.

    • +
    • CORO_RUNNING: Currently being executed by the interpreter.

    • +
    • CORO_SUSPENDED: Currently suspended at an await expression.

    • +
    • CORO_CLOSED: Execution has completed.

    • +
    +
    +
    +
    +

    New in version 3.5.

    +
    +
    + +

    The current internal state of the generator can also be queried. This is +mostly useful for testing purposes, to ensure that internal state is being +updated as expected:

    +
    +
    +inspect.getgeneratorlocals(generator)
    +

    Get the mapping of live local variables in generator to their current +values. A dictionary is returned that maps from variable names to values. +This is the equivalent of calling locals() in the body of the +generator, and all the same caveats apply.

    +

    If generator is a generator with no currently associated frame, +then an empty dictionary is returned. TypeError is raised if +generator is not a Python generator object.

    +
    +

    CPython implementation detail: This function relies on the generator exposing a Python stack frame +for introspection, which isn’t guaranteed to be the case in all +implementations of Python. In such cases, this function will always +return an empty dictionary.

    +
    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +inspect.getcoroutinelocals(coroutine)
    +

    This function is analogous to getgeneratorlocals(), but +works for coroutine objects created by async def functions.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +

    Code Objects Bit Flags

    +

    Python code objects have a co_flags attribute, which is a bitmap of +the following flags:

    +
    +
    +inspect.CO_OPTIMIZED
    +

    The code object is optimized, using fast locals.

    +
    + +
    +
    +inspect.CO_NEWLOCALS
    +

    If set, a new dict will be created for the frame’s f_locals when +the code object is executed.

    +
    + +
    +
    +inspect.CO_VARARGS
    +

    The code object has a variable positional parameter (*args-like).

    +
    + +
    +
    +inspect.CO_VARKEYWORDS
    +

    The code object has a variable keyword parameter (**kwargs-like).

    +
    + +
    +
    +inspect.CO_NESTED
    +

    The flag is set when the code object is a nested function.

    +
    + +
    +
    +inspect.CO_GENERATOR
    +

    The flag is set when the code object is a generator function, i.e. +a generator object is returned when the code object is executed.

    +
    + +
    +
    +inspect.CO_NOFREE
    +

    The flag is set if there are no free or cell variables.

    +
    + +
    +
    +inspect.CO_COROUTINE
    +

    The flag is set when the code object is a coroutine function. +When the code object is executed it returns a coroutine object. +See PEP 492 for more details.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +inspect.CO_ITERABLE_COROUTINE
    +

    The flag is used to transform generators into generator-based +coroutines. Generator objects with this flag can be used in +await expression, and can yield from coroutine objects. +See PEP 492 for more details.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +inspect.CO_ASYNC_GENERATOR
    +

    The flag is set when the code object is an asynchronous generator +function. When the code object is executed it returns an +asynchronous generator object. See PEP 525 for more details.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +

    Note

    +

    The flags are specific to CPython, and may not be defined in other +Python implementations. Furthermore, the flags are an implementation +detail, and can be removed or deprecated in future Python releases. +It’s recommended to use public APIs from the inspect module +for any introspection needs.

    +
    +
    +
    +

    Command Line Interface

    +

    The inspect module also provides a basic introspection capability +from the command line.

    +

    By default, accepts the name of a module and prints the source of that +module. A class or function within the module can be printed instead by +appended a colon and the qualified name of the target object.

    +
    +
    +--details
    +

    Print information about the specified object rather than the source code

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/internet.html b/python-3.7.4-docs-html/library/internet.html new file mode 100644 index 0000000..80ba60d --- /dev/null +++ b/python-3.7.4-docs-html/library/internet.html @@ -0,0 +1,397 @@ + + + + + + + Internet Protocols and Support — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Internet Protocols and Support

    +

    The modules described in this chapter implement Internet protocols and support +for related technology. They are all implemented in Python. Most of these +modules require the presence of the system-dependent module socket, which +is currently supported on most popular platforms. Here is an overview:

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/intro.html b/python-3.7.4-docs-html/library/intro.html new file mode 100644 index 0000000..a62577a --- /dev/null +++ b/python-3.7.4-docs-html/library/intro.html @@ -0,0 +1,235 @@ + + + + + + + Introduction — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Introduction

    +

    The “Python library” contains several different kinds of components.

    +

    It contains data types that would normally be considered part of the “core” of a +language, such as numbers and lists. For these types, the Python language core +defines the form of literals and places some constraints on their semantics, but +does not fully define the semantics. (On the other hand, the language core does +define syntactic properties like the spelling and priorities of operators.)

    +

    The library also contains built-in functions and exceptions — objects that can +be used by all Python code without the need of an import statement. +Some of these are defined by the core language, but many are not essential for +the core semantics and are only described here.

    +

    The bulk of the library, however, consists of a collection of modules. There are +many ways to dissect this collection. Some modules are written in C and built +in to the Python interpreter; others are written in Python and imported in +source form. Some modules provide interfaces that are highly specific to +Python, like printing a stack trace; some provide interfaces that are specific +to particular operating systems, such as access to specific hardware; others +provide interfaces that are specific to a particular application domain, like +the World Wide Web. Some modules are available in all versions and ports of +Python; others are only available when the underlying system supports or +requires them; yet others are available only when a particular configuration +option was chosen at the time when Python was compiled and installed.

    +

    This manual is organized “from the inside out:” it first describes the built-in +functions, data types and exceptions, and finally the modules, grouped in +chapters of related modules.

    +

    This means that if you start reading this manual from the start, and skip to the +next chapter when you get bored, you will get a reasonable overview of the +available modules and application areas that are supported by the Python +library. Of course, you don’t have to read it like a novel — you can also +browse the table of contents (in front of the manual), or look for a specific +function, module or term in the index (in the back). And finally, if you enjoy +learning about random subjects, you choose a random page number (see module +random) and read a section or two. Regardless of the order in which you +read the sections of this manual, it helps to start with chapter +Built-in Functions, as the remainder of the manual assumes familiarity with +this material.

    +

    Let the show begin!

    +
    +

    Notes on availability

    +
      +
    • An “Availability: Unix” note means that this function is commonly found on +Unix systems. It does not make any claims about its existence on a specific +operating system.

    • +
    • If not separately noted, all functions that claim “Availability: Unix” are +supported on Mac OS X, which builds on a Unix core.

    • +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/io.html b/python-3.7.4-docs-html/library/io.html new file mode 100644 index 0000000..3382ed7 --- /dev/null +++ b/python-3.7.4-docs-html/library/io.html @@ -0,0 +1,1304 @@ + + + + + + + io — Core tools for working with streams — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    io — Core tools for working with streams

    +

    Source code: Lib/io.py

    +
    +
    +

    Overview

    +

    The io module provides Python’s main facilities for dealing with various +types of I/O. There are three main types of I/O: text I/O, binary I/O +and raw I/O. These are generic categories, and various backing stores can +be used for each of them. A concrete object belonging to any of these +categories is called a file object. Other common terms are stream +and file-like object.

    +

    Independent of its category, each concrete stream object will also have +various capabilities: it can be read-only, write-only, or read-write. It can +also allow arbitrary random access (seeking forwards or backwards to any +location), or only sequential access (for example in the case of a socket or +pipe).

    +

    All streams are careful about the type of data you give to them. For example +giving a str object to the write() method of a binary stream +will raise a TypeError. So will giving a bytes object to the +write() method of a text stream.

    +
    +

    Changed in version 3.3: Operations that used to raise IOError now raise OSError, since +IOError is now an alias of OSError.

    +
    +
    +

    Text I/O

    +

    Text I/O expects and produces str objects. This means that whenever +the backing store is natively made of bytes (such as in the case of a file), +encoding and decoding of data is made transparently as well as optional +translation of platform-specific newline characters.

    +

    The easiest way to create a text stream is with open(), optionally +specifying an encoding:

    +
    f = open("myfile.txt", "r", encoding="utf-8")
    +
    +
    +

    In-memory text streams are also available as StringIO objects:

    +
    f = io.StringIO("some initial text data")
    +
    +
    +

    The text stream API is described in detail in the documentation of +TextIOBase.

    +
    +
    +

    Binary I/O

    +

    Binary I/O (also called buffered I/O) expects +bytes-like objects and produces bytes +objects. No encoding, decoding, or newline translation is performed. This +category of streams can be used for all kinds of non-text data, and also when +manual control over the handling of text data is desired.

    +

    The easiest way to create a binary stream is with open() with 'b' in +the mode string:

    +
    f = open("myfile.jpg", "rb")
    +
    +
    +

    In-memory binary streams are also available as BytesIO objects:

    +
    f = io.BytesIO(b"some initial binary data: \x00\x01")
    +
    +
    +

    The binary stream API is described in detail in the docs of +BufferedIOBase.

    +

    Other library modules may provide additional ways to create text or binary +streams. See socket.socket.makefile() for example.

    +
    +
    +

    Raw I/O

    +

    Raw I/O (also called unbuffered I/O) is generally used as a low-level +building-block for binary and text streams; it is rarely useful to directly +manipulate a raw stream from user code. Nevertheless, you can create a raw +stream by opening a file in binary mode with buffering disabled:

    +
    f = open("myfile.jpg", "rb", buffering=0)
    +
    +
    +

    The raw stream API is described in detail in the docs of RawIOBase.

    +
    +
    +
    +

    High-level Module Interface

    +
    +
    +io.DEFAULT_BUFFER_SIZE
    +

    An int containing the default buffer size used by the module’s buffered I/O +classes. open() uses the file’s blksize (as obtained by +os.stat()) if possible.

    +
    + +
    +
    +io.open(file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None)
    +

    This is an alias for the builtin open() function.

    +
    + +
    +
    +exception io.BlockingIOError
    +

    This is a compatibility alias for the builtin BlockingIOError +exception.

    +
    + +
    +
    +exception io.UnsupportedOperation
    +

    An exception inheriting OSError and ValueError that is raised +when an unsupported operation is called on a stream.

    +
    + +
    +

    In-memory streams

    +

    It is also possible to use a str or bytes-like object as a +file for both reading and writing. For strings StringIO can be used +like a file opened in text mode. BytesIO can be used like a file +opened in binary mode. Both provide full read-write capabilities with random +access.

    +
    +

    See also

    +
    +
    sys

    contains the standard IO streams: sys.stdin, sys.stdout, +and sys.stderr.

    +
    +
    +
    +
    +
    +
    +

    Class hierarchy

    +

    The implementation of I/O streams is organized as a hierarchy of classes. First +abstract base classes (ABCs), which are used to +specify the various categories of streams, then concrete classes providing the +standard stream implementations.

    +
    +
    +

    Note

    +

    The abstract base classes also provide default implementations of some +methods in order to help implementation of concrete stream classes. For +example, BufferedIOBase provides unoptimized implementations of +readinto() and readline().

    +
    +
    +

    At the top of the I/O hierarchy is the abstract base class IOBase. It +defines the basic interface to a stream. Note, however, that there is no +separation between reading and writing to streams; implementations are allowed +to raise UnsupportedOperation if they do not support a given operation.

    +

    The RawIOBase ABC extends IOBase. It deals with the reading +and writing of bytes to a stream. FileIO subclasses RawIOBase +to provide an interface to files in the machine’s file system.

    +

    The BufferedIOBase ABC deals with buffering on a raw byte stream +(RawIOBase). Its subclasses, BufferedWriter, +BufferedReader, and BufferedRWPair buffer streams that are +readable, writable, and both readable and writable. BufferedRandom +provides a buffered interface to random access streams. Another +BufferedIOBase subclass, BytesIO, is a stream of in-memory +bytes.

    +

    The TextIOBase ABC, another subclass of IOBase, deals with +streams whose bytes represent text, and handles encoding and decoding to and +from strings. TextIOWrapper, which extends it, is a buffered text +interface to a buffered raw stream (BufferedIOBase). Finally, +StringIO is an in-memory stream for text.

    +

    Argument names are not part of the specification, and only the arguments of +open() are intended to be used as keyword arguments.

    +

    The following table summarizes the ABCs provided by the io module:

    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    ABC

    Inherits

    Stub Methods

    Mixin Methods and Properties

    IOBase

    fileno, seek, +and truncate

    close, closed, __enter__, +__exit__, flush, isatty, __iter__, +__next__, readable, readline, +readlines, seekable, tell, +writable, and writelines

    RawIOBase

    IOBase

    readinto and +write

    Inherited IOBase methods, read, +and readall

    BufferedIOBase

    IOBase

    detach, read, +read1, and write

    Inherited IOBase methods, readinto, +and readinto1

    TextIOBase

    IOBase

    detach, read, +readline, and +write

    Inherited IOBase methods, encoding, +errors, and newlines

    +
    +

    I/O Base Classes

    +
    +
    +class io.IOBase
    +

    The abstract base class for all I/O classes, acting on streams of bytes. +There is no public constructor.

    +

    This class provides empty abstract implementations for many methods +that derived classes can override selectively; the default +implementations represent a file that cannot be read, written or +seeked.

    +

    Even though IOBase does not declare read() +or write() because their signatures will vary, implementations and +clients should consider those methods part of the interface. Also, +implementations may raise a ValueError (or UnsupportedOperation) +when operations they do not support are called.

    +

    The basic type used for binary data read from or written to a file is +bytes. Other bytes-like objects are +accepted as method arguments too. Text I/O classes work with str data.

    +

    Note that calling any method (even inquiries) on a closed stream is +undefined. Implementations may raise ValueError in this case.

    +

    IOBase (and its subclasses) supports the iterator protocol, meaning +that an IOBase object can be iterated over yielding the lines in a +stream. Lines are defined slightly differently depending on whether the +stream is a binary stream (yielding bytes), or a text stream (yielding +character strings). See readline() below.

    +

    IOBase is also a context manager and therefore supports the +with statement. In this example, file is closed after the +with statement’s suite is finished—even if an exception occurs:

    +
    with open('spam.txt', 'w') as file:
    +    file.write('Spam and eggs!')
    +
    +
    +

    IOBase provides these data attributes and methods:

    +
    +
    +close()
    +

    Flush and close this stream. This method has no effect if the file is +already closed. Once the file is closed, any operation on the file +(e.g. reading or writing) will raise a ValueError.

    +

    As a convenience, it is allowed to call this method more than once; +only the first call, however, will have an effect.

    +
    + +
    +
    +closed
    +

    True if the stream is closed.

    +
    + +
    +
    +fileno()
    +

    Return the underlying file descriptor (an integer) of the stream if it +exists. An OSError is raised if the IO object does not use a file +descriptor.

    +
    + +
    +
    +flush()
    +

    Flush the write buffers of the stream if applicable. This does nothing +for read-only and non-blocking streams.

    +
    + +
    +
    +isatty()
    +

    Return True if the stream is interactive (i.e., connected to +a terminal/tty device).

    +
    + +
    +
    +readable()
    +

    Return True if the stream can be read from. If False, read() +will raise OSError.

    +
    + +
    +
    +readline(size=-1)
    +

    Read and return one line from the stream. If size is specified, at +most size bytes will be read.

    +

    The line terminator is always b'\n' for binary files; for text files, +the newline argument to open() can be used to select the line +terminator(s) recognized.

    +
    + +
    +
    +readlines(hint=-1)
    +

    Read and return a list of lines from the stream. hint can be specified +to control the number of lines read: no more lines will be read if the +total size (in bytes/characters) of all lines so far exceeds hint.

    +

    Note that it’s already possible to iterate on file objects using for +line in file: ... without calling file.readlines().

    +
    + +
    +
    +seek(offset, whence=SEEK_SET)
    +

    Change the stream position to the given byte offset. offset is +interpreted relative to the position indicated by whence. The default +value for whence is SEEK_SET. Values for whence are:

    +
      +
    • SEEK_SET or 0 – start of the stream (the default); +offset should be zero or positive

    • +
    • SEEK_CUR or 1 – current stream position; offset may +be negative

    • +
    • SEEK_END or 2 – end of the stream; offset is usually +negative

    • +
    +

    Return the new absolute position.

    +
    +

    New in version 3.1: The SEEK_* constants.

    +
    +
    +

    New in version 3.3: Some operating systems could support additional values, like +os.SEEK_HOLE or os.SEEK_DATA. The valid values +for a file could depend on it being open in text or binary mode.

    +
    +
    + +
    +
    +seekable()
    +

    Return True if the stream supports random access. If False, +seek(), tell() and truncate() will raise OSError.

    +
    + +
    +
    +tell()
    +

    Return the current stream position.

    +
    + +
    +
    +truncate(size=None)
    +

    Resize the stream to the given size in bytes (or the current position +if size is not specified). The current stream position isn’t changed. +This resizing can extend or reduce the current file size. In case of +extension, the contents of the new file area depend on the platform +(on most systems, additional bytes are zero-filled). The new file size +is returned.

    +
    +

    Changed in version 3.5: Windows will now zero-fill files when extending.

    +
    +
    + +
    +
    +writable()
    +

    Return True if the stream supports writing. If False, +write() and truncate() will raise OSError.

    +
    + +
    +
    +writelines(lines)
    +

    Write a list of lines to the stream. Line separators are not added, so it +is usual for each of the lines provided to have a line separator at the +end.

    +
    + +
    +
    +__del__()
    +

    Prepare for object destruction. IOBase provides a default +implementation of this method that calls the instance’s +close() method.

    +
    + +
    + +
    +
    +class io.RawIOBase
    +

    Base class for raw binary I/O. It inherits IOBase. There is no +public constructor.

    +

    Raw binary I/O typically provides low-level access to an underlying OS +device or API, and does not try to encapsulate it in high-level primitives +(this is left to Buffered I/O and Text I/O, described later in this page).

    +

    In addition to the attributes and methods from IOBase, +RawIOBase provides the following methods:

    +
    +
    +read(size=-1)
    +

    Read up to size bytes from the object and return them. As a convenience, +if size is unspecified or -1, all bytes until EOF are returned. +Otherwise, only one system call is ever made. Fewer than size bytes may +be returned if the operating system call returns fewer than size bytes.

    +

    If 0 bytes are returned, and size was not 0, this indicates end of file. +If the object is in non-blocking mode and no bytes are available, +None is returned.

    +

    The default implementation defers to readall() and +readinto().

    +
    + +
    +
    +readall()
    +

    Read and return all the bytes from the stream until EOF, using multiple +calls to the stream if necessary.

    +
    + +
    +
    +readinto(b)
    +

    Read bytes into a pre-allocated, writable +bytes-like object b, and return the +number of bytes read. For example, b might be a bytearray. +If the object is in non-blocking mode and no bytes +are available, None is returned.

    +
    + +
    +
    +write(b)
    +

    Write the given bytes-like object, b, to the +underlying raw stream, and return the number of +bytes written. This can be less than the length of b in +bytes, depending on specifics of the underlying raw +stream, and especially if it is in non-blocking mode. None is +returned if the raw stream is set not to block and no single byte could +be readily written to it. The caller may release or mutate b after +this method returns, so the implementation should only access b +during the method call.

    +
    + +
    + +
    +
    +class io.BufferedIOBase
    +

    Base class for binary streams that support some kind of buffering. +It inherits IOBase. There is no public constructor.

    +

    The main difference with RawIOBase is that methods read(), +readinto() and write() will try (respectively) to read as much +input as requested or to consume all given output, at the expense of +making perhaps more than one system call.

    +

    In addition, those methods can raise BlockingIOError if the +underlying raw stream is in non-blocking mode and cannot take or give +enough data; unlike their RawIOBase counterparts, they will +never return None.

    +

    Besides, the read() method does not have a default +implementation that defers to readinto().

    +

    A typical BufferedIOBase implementation should not inherit from a +RawIOBase implementation, but wrap one, like +BufferedWriter and BufferedReader do.

    +

    BufferedIOBase provides or overrides these methods and attribute in +addition to those from IOBase:

    +
    +
    +raw
    +

    The underlying raw stream (a RawIOBase instance) that +BufferedIOBase deals with. This is not part of the +BufferedIOBase API and may not exist on some implementations.

    +
    + +
    +
    +detach()
    +

    Separate the underlying raw stream from the buffer and return it.

    +

    After the raw stream has been detached, the buffer is in an unusable +state.

    +

    Some buffers, like BytesIO, do not have the concept of a single +raw stream to return from this method. They raise +UnsupportedOperation.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +read(size=-1)
    +

    Read and return up to size bytes. If the argument is omitted, None, +or negative, data is read and returned until EOF is reached. An empty +bytes object is returned if the stream is already at EOF.

    +

    If the argument is positive, and the underlying raw stream is not +interactive, multiple raw reads may be issued to satisfy the byte count +(unless EOF is reached first). But for interactive raw streams, at most +one raw read will be issued, and a short result does not imply that EOF is +imminent.

    +

    A BlockingIOError is raised if the underlying raw stream is in +non blocking-mode, and has no data available at the moment.

    +
    + +
    +
    +read1([size])
    +

    Read and return up to size bytes, with at most one call to the +underlying raw stream’s read() (or +readinto()) method. This can be useful if you are +implementing your own buffering on top of a BufferedIOBase +object.

    +

    If size is -1 (the default), an arbitrary number of bytes are +returned (more than zero unless EOF is reached).

    +
    + +
    +
    +readinto(b)
    +

    Read bytes into a pre-allocated, writable +bytes-like object b and return the number of bytes read. +For example, b might be a bytearray.

    +

    Like read(), multiple reads may be issued to the underlying raw +stream, unless the latter is interactive.

    +

    A BlockingIOError is raised if the underlying raw stream is in non +blocking-mode, and has no data available at the moment.

    +
    + +
    +
    +readinto1(b)
    +

    Read bytes into a pre-allocated, writable +bytes-like object b, using at most one call to +the underlying raw stream’s read() (or +readinto()) method. Return the number of bytes read.

    +

    A BlockingIOError is raised if the underlying raw stream is in non +blocking-mode, and has no data available at the moment.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +write(b)
    +

    Write the given bytes-like object, b, and return the number +of bytes written (always equal to the length of b in bytes, since if +the write fails an OSError will be raised). Depending on the +actual implementation, these bytes may be readily written to the +underlying stream, or held in a buffer for performance and latency +reasons.

    +

    When in non-blocking mode, a BlockingIOError is raised if the +data needed to be written to the raw stream but it couldn’t accept +all the data without blocking.

    +

    The caller may release or mutate b after this method returns, +so the implementation should only access b during the method call.

    +
    + +
    + +
    +
    +

    Raw File I/O

    +
    +
    +class io.FileIO(name, mode='r', closefd=True, opener=None)
    +

    FileIO represents an OS-level file containing bytes data. +It implements the RawIOBase interface (and therefore the +IOBase interface, too).

    +

    The name can be one of two things:

    +
      +
    • a character string or bytes object representing the path to the +file which will be opened. In this case closefd must be True (the default) +otherwise an error will be raised.

    • +
    • an integer representing the number of an existing OS-level file descriptor +to which the resulting FileIO object will give access. When the +FileIO object is closed this fd will be closed as well, unless closefd +is set to False.

    • +
    +

    The mode can be 'r', 'w', 'x' or 'a' for reading +(default), writing, exclusive creation or appending. The file will be +created if it doesn’t exist when opened for writing or appending; it will be +truncated when opened for writing. FileExistsError will be raised if +it already exists when opened for creating. Opening a file for creating +implies writing, so this mode behaves in a similar way to 'w'. Add a +'+' to the mode to allow simultaneous reading and writing.

    +

    The read() (when called with a positive argument), readinto() +and write() methods on this class will only make one system call.

    +

    A custom opener can be used by passing a callable as opener. The underlying +file descriptor for the file object is then obtained by calling opener with +(name, flags). opener must return an open file descriptor (passing +os.open as opener results in functionality similar to passing +None).

    +

    The newly created file is non-inheritable.

    +

    See the open() built-in function for examples on using the opener +parameter.

    +
    +

    Changed in version 3.3: The opener parameter was added. +The 'x' mode was added.

    +
    +
    +

    Changed in version 3.4: The file is now non-inheritable.

    +
    +

    In addition to the attributes and methods from IOBase and +RawIOBase, FileIO provides the following data +attributes:

    +
    +
    +mode
    +

    The mode as given in the constructor.

    +
    + +
    +
    +name
    +

    The file name. This is the file descriptor of the file when no name is +given in the constructor.

    +
    + +
    + +
    +
    +

    Buffered Streams

    +

    Buffered I/O streams provide a higher-level interface to an I/O device +than raw I/O does.

    +
    +
    +class io.BytesIO([initial_bytes])
    +

    A stream implementation using an in-memory bytes buffer. It inherits +BufferedIOBase. The buffer is discarded when the +close() method is called.

    +

    The optional argument initial_bytes is a bytes-like object that +contains initial data.

    +

    BytesIO provides or overrides these methods in addition to those +from BufferedIOBase and IOBase:

    +
    +
    +getbuffer()
    +

    Return a readable and writable view over the contents of the buffer +without copying them. Also, mutating the view will transparently +update the contents of the buffer:

    +
    >>> b = io.BytesIO(b"abcdef")
    +>>> view = b.getbuffer()
    +>>> view[2:4] = b"56"
    +>>> b.getvalue()
    +b'ab56ef'
    +
    +
    +
    +

    Note

    +

    As long as the view exists, the BytesIO object cannot be +resized or closed.

    +
    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +getvalue()
    +

    Return bytes containing the entire contents of the buffer.

    +
    + +
    +
    +read1([size])
    +

    In BytesIO, this is the same as read().

    +
    +

    Changed in version 3.7: The size argument is now optional.

    +
    +
    + +
    +
    +readinto1(b)
    +

    In BytesIO, this is the same as readinto().

    +
    +

    New in version 3.5.

    +
    +
    + +
    + +
    +
    +class io.BufferedReader(raw, buffer_size=DEFAULT_BUFFER_SIZE)
    +

    A buffer providing higher-level access to a readable, sequential +RawIOBase object. It inherits BufferedIOBase. +When reading data from this object, a larger amount of data may be +requested from the underlying raw stream, and kept in an internal buffer. +The buffered data can then be returned directly on subsequent reads.

    +

    The constructor creates a BufferedReader for the given readable +raw stream and buffer_size. If buffer_size is omitted, +DEFAULT_BUFFER_SIZE is used.

    +

    BufferedReader provides or overrides these methods in addition to +those from BufferedIOBase and IOBase:

    +
    +
    +peek([size])
    +

    Return bytes from the stream without advancing the position. At most one +single read on the raw stream is done to satisfy the call. The number of +bytes returned may be less or more than requested.

    +
    + +
    +
    +read([size])
    +

    Read and return size bytes, or if size is not given or negative, until +EOF or if the read call would block in non-blocking mode.

    +
    + +
    +
    +read1([size])
    +

    Read and return up to size bytes with only one call on the raw stream. +If at least one byte is buffered, only buffered bytes are returned. +Otherwise, one raw stream read call is made.

    +
    +

    Changed in version 3.7: The size argument is now optional.

    +
    +
    + +
    + +
    +
    +class io.BufferedWriter(raw, buffer_size=DEFAULT_BUFFER_SIZE)
    +

    A buffer providing higher-level access to a writeable, sequential +RawIOBase object. It inherits BufferedIOBase. +When writing to this object, data is normally placed into an internal +buffer. The buffer will be written out to the underlying RawIOBase +object under various conditions, including:

    +
      +
    • when the buffer gets too small for all pending data;

    • +
    • when flush() is called;

    • +
    • when a seek() is requested (for BufferedRandom objects);

    • +
    • when the BufferedWriter object is closed or destroyed.

    • +
    +

    The constructor creates a BufferedWriter for the given writeable +raw stream. If the buffer_size is not given, it defaults to +DEFAULT_BUFFER_SIZE.

    +

    BufferedWriter provides or overrides these methods in addition to +those from BufferedIOBase and IOBase:

    +
    +
    +flush()
    +

    Force bytes held in the buffer into the raw stream. A +BlockingIOError should be raised if the raw stream blocks.

    +
    + +
    +
    +write(b)
    +

    Write the bytes-like object, b, and return the +number of bytes written. When in non-blocking mode, a +BlockingIOError is raised if the buffer needs to be written out but +the raw stream blocks.

    +
    + +
    + +
    +
    +class io.BufferedRandom(raw, buffer_size=DEFAULT_BUFFER_SIZE)
    +

    A buffered interface to random access streams. It inherits +BufferedReader and BufferedWriter, and further supports +seek() and tell() functionality.

    +

    The constructor creates a reader and writer for a seekable raw stream, given +in the first argument. If the buffer_size is omitted it defaults to +DEFAULT_BUFFER_SIZE.

    +

    BufferedRandom is capable of anything BufferedReader or +BufferedWriter can do.

    +
    + +
    +
    +class io.BufferedRWPair(reader, writer, buffer_size=DEFAULT_BUFFER_SIZE)
    +

    A buffered I/O object combining two unidirectional RawIOBase +objects – one readable, the other writeable – into a single bidirectional +endpoint. It inherits BufferedIOBase.

    +

    reader and writer are RawIOBase objects that are readable and +writeable respectively. If the buffer_size is omitted it defaults to +DEFAULT_BUFFER_SIZE.

    +

    BufferedRWPair implements all of BufferedIOBase’s methods +except for detach(), which raises +UnsupportedOperation.

    +
    +

    Warning

    +

    BufferedRWPair does not attempt to synchronize accesses to +its underlying raw streams. You should not pass it the same object +as reader and writer; use BufferedRandom instead.

    +
    +
    + +
    +
    +

    Text I/O

    +
    +
    +class io.TextIOBase
    +

    Base class for text streams. This class provides a character and line based +interface to stream I/O. It inherits IOBase. +There is no public constructor.

    +

    TextIOBase provides or overrides these data attributes and +methods in addition to those from IOBase:

    +
    +
    +encoding
    +

    The name of the encoding used to decode the stream’s bytes into +strings, and to encode strings into bytes.

    +
    + +
    +
    +errors
    +

    The error setting of the decoder or encoder.

    +
    + +
    +
    +newlines
    +

    A string, a tuple of strings, or None, indicating the newlines +translated so far. Depending on the implementation and the initial +constructor flags, this may not be available.

    +
    + +
    +
    +buffer
    +

    The underlying binary buffer (a BufferedIOBase instance) that +TextIOBase deals with. This is not part of the +TextIOBase API and may not exist in some implementations.

    +
    + +
    +
    +detach()
    +

    Separate the underlying binary buffer from the TextIOBase and +return it.

    +

    After the underlying buffer has been detached, the TextIOBase is +in an unusable state.

    +

    Some TextIOBase implementations, like StringIO, may not +have the concept of an underlying buffer and calling this method will +raise UnsupportedOperation.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +read(size=-1)
    +

    Read and return at most size characters from the stream as a single +str. If size is negative or None, reads until EOF.

    +
    + +
    +
    +readline(size=-1)
    +

    Read until newline or EOF and return a single str. If the stream is +already at EOF, an empty string is returned.

    +

    If size is specified, at most size characters will be read.

    +
    + +
    +
    +seek(offset, whence=SEEK_SET)
    +

    Change the stream position to the given offset. Behaviour depends on +the whence parameter. The default value for whence is +SEEK_SET.

    +
      +
    • SEEK_SET or 0: seek from the start of the stream +(the default); offset must either be a number returned by +TextIOBase.tell(), or zero. Any other offset value +produces undefined behaviour.

    • +
    • SEEK_CUR or 1: “seek” to the current position; +offset must be zero, which is a no-operation (all other values +are unsupported).

    • +
    • SEEK_END or 2: seek to the end of the stream; +offset must be zero (all other values are unsupported).

    • +
    +

    Return the new absolute position as an opaque number.

    +
    +

    New in version 3.1: The SEEK_* constants.

    +
    +
    + +
    +
    +tell()
    +

    Return the current stream position as an opaque number. The number +does not usually represent a number of bytes in the underlying +binary storage.

    +
    + +
    +
    +write(s)
    +

    Write the string s to the stream and return the number of characters +written.

    +
    + +
    + +
    +
    +class io.TextIOWrapper(buffer, encoding=None, errors=None, newline=None, line_buffering=False, write_through=False)
    +

    A buffered text stream over a BufferedIOBase binary stream. +It inherits TextIOBase.

    +

    encoding gives the name of the encoding that the stream will be decoded or +encoded with. It defaults to +locale.getpreferredencoding(False).

    +

    errors is an optional string that specifies how encoding and decoding +errors are to be handled. Pass 'strict' to raise a ValueError +exception if there is an encoding error (the default of None has the same +effect), or pass 'ignore' to ignore errors. (Note that ignoring encoding +errors can lead to data loss.) 'replace' causes a replacement marker +(such as '?') to be inserted where there is malformed data. +'backslashreplace' causes malformed data to be replaced by a +backslashed escape sequence. When writing, 'xmlcharrefreplace' +(replace with the appropriate XML character reference) or 'namereplace' +(replace with \N{...} escape sequences) can be used. Any other error +handling name that has been registered with +codecs.register_error() is also valid.

    +

    newline controls how line endings are handled. It can be None, +'', '\n', '\r', and '\r\n'. It works as follows:

    +
      +
    • When reading input from the stream, if newline is None, +universal newlines mode is enabled. Lines in the input can end in +'\n', '\r', or '\r\n', and these are translated into '\n' +before being returned to the caller. If it is '', universal newlines +mode is enabled, but line endings are returned to the caller untranslated. +If it has any of the other legal values, input lines are only terminated +by the given string, and the line ending is returned to the caller +untranslated.

    • +
    • When writing output to the stream, if newline is None, any '\n' +characters written are translated to the system default line separator, +os.linesep. If newline is '' or '\n', no translation +takes place. If newline is any of the other legal values, any '\n' +characters written are translated to the given string.

    • +
    +

    If line_buffering is True, flush() is implied when a call to +write contains a newline character or a carriage return.

    +

    If write_through is True, calls to write() are guaranteed +not to be buffered: any data written on the TextIOWrapper +object is immediately handled to its underlying binary buffer.

    +
    +

    Changed in version 3.3: The write_through argument has been added.

    +
    +
    +

    Changed in version 3.3: The default encoding is now locale.getpreferredencoding(False) +instead of locale.getpreferredencoding(). Don’t change temporary the +locale encoding using locale.setlocale(), use the current locale +encoding instead of the user preferred encoding.

    +
    +

    TextIOWrapper provides these members in addition to those of +TextIOBase and its parents:

    +
    +
    +line_buffering
    +

    Whether line buffering is enabled.

    +
    + +
    +
    +write_through
    +

    Whether writes are passed immediately to the underlying binary +buffer.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +reconfigure(*[, encoding][, errors][, newline][, line_buffering][, write_through])
    +

    Reconfigure this text stream using new settings for encoding, +errors, newline, line_buffering and write_through.

    +

    Parameters not specified keep current settings, except +errors='strict' is used when encoding is specified but +errors is not specified.

    +

    It is not possible to change the encoding or newline if some data +has already been read from the stream. On the other hand, changing +encoding after write is possible.

    +

    This method does an implicit stream flush before setting the +new parameters.

    +
    +

    New in version 3.7.

    +
    +
    + +
    + +
    +
    +class io.StringIO(initial_value='', newline='\n')
    +

    An in-memory stream for text I/O. The text buffer is discarded when the +close() method is called.

    +

    The initial value of the buffer can be set by providing initial_value. +If newline translation is enabled, newlines will be encoded as if by +write(). The stream is positioned at the start of +the buffer.

    +

    The newline argument works like that of TextIOWrapper. +The default is to consider only \n characters as ends of lines and +to do no newline translation. If newline is set to None, +newlines are written as \n on all platforms, but universal +newline decoding is still performed when reading.

    +

    StringIO provides this method in addition to those from +TextIOBase and its parents:

    +
    +
    +getvalue()
    +

    Return a str containing the entire contents of the buffer. +Newlines are decoded as if by read(), although +the stream position is not changed.

    +
    + +

    Example usage:

    +
    import io
    +
    +output = io.StringIO()
    +output.write('First line.\n')
    +print('Second line.', file=output)
    +
    +# Retrieve file contents -- this will be
    +# 'First line.\nSecond line.\n'
    +contents = output.getvalue()
    +
    +# Close object and discard memory buffer --
    +# .getvalue() will now raise an exception.
    +output.close()
    +
    +
    +
    + +
    +
    +class io.IncrementalNewlineDecoder
    +

    A helper codec that decodes newlines for universal newlines mode. +It inherits codecs.IncrementalDecoder.

    +
    + +
    +
    +
    +

    Performance

    +

    This section discusses the performance of the provided concrete I/O +implementations.

    +
    +

    Binary I/O

    +

    By reading and writing only large chunks of data even when the user asks for a +single byte, buffered I/O hides any inefficiency in calling and executing the +operating system’s unbuffered I/O routines. The gain depends on the OS and the +kind of I/O which is performed. For example, on some modern OSes such as Linux, +unbuffered disk I/O can be as fast as buffered I/O. The bottom line, however, +is that buffered I/O offers predictable performance regardless of the platform +and the backing device. Therefore, it is almost always preferable to use +buffered I/O rather than unbuffered I/O for binary data.

    +
    +
    +

    Text I/O

    +

    Text I/O over a binary storage (such as a file) is significantly slower than +binary I/O over the same storage, because it requires conversions between +unicode and binary data using a character codec. This can become noticeable +handling huge amounts of text data like large log files. Also, +TextIOWrapper.tell() and TextIOWrapper.seek() are both quite slow +due to the reconstruction algorithm used.

    +

    StringIO, however, is a native in-memory unicode container and will +exhibit similar speed to BytesIO.

    +
    +
    +

    Multi-threading

    +

    FileIO objects are thread-safe to the extent that the operating system +calls (such as read(2) under Unix) they wrap are thread-safe too.

    +

    Binary buffered objects (instances of BufferedReader, +BufferedWriter, BufferedRandom and BufferedRWPair) +protect their internal structures using a lock; it is therefore safe to call +them from multiple threads at once.

    +

    TextIOWrapper objects are not thread-safe.

    +
    +
    +

    Reentrancy

    +

    Binary buffered objects (instances of BufferedReader, +BufferedWriter, BufferedRandom and BufferedRWPair) +are not reentrant. While reentrant calls will not happen in normal situations, +they can arise from doing I/O in a signal handler. If a thread tries to +re-enter a buffered object which it is already accessing, a RuntimeError +is raised. Note this doesn’t prohibit a different thread from entering the +buffered object.

    +

    The above implicitly extends to text files, since the open() function +will wrap a buffered object inside a TextIOWrapper. This includes +standard streams and therefore affects the built-in function print() as +well.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/ipaddress.html b/python-3.7.4-docs-html/library/ipaddress.html new file mode 100644 index 0000000..373e8d5 --- /dev/null +++ b/python-3.7.4-docs-html/library/ipaddress.html @@ -0,0 +1,1399 @@ + + + + + + + ipaddress — IPv4/IPv6 manipulation library — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    ipaddress — IPv4/IPv6 manipulation library

    +

    Source code: Lib/ipaddress.py

    +
    +

    ipaddress provides the capabilities to create, manipulate and +operate on IPv4 and IPv6 addresses and networks.

    +

    The functions and classes in this module make it straightforward to handle +various tasks related to IP addresses, including checking whether or not two +hosts are on the same subnet, iterating over all hosts in a particular +subnet, checking whether or not a string represents a valid IP address or +network definition, and so on.

    +

    This is the full module API reference—for an overview and introduction, see +An introduction to the ipaddress module.

    +
    +

    New in version 3.3.

    +
    +
    +

    Convenience factory functions

    +

    The ipaddress module provides factory functions to conveniently create +IP addresses, networks and interfaces:

    +
    +
    +ipaddress.ip_address(address)
    +

    Return an IPv4Address or IPv6Address object depending on +the IP address passed as argument. Either IPv4 or IPv6 addresses may be +supplied; integers less than 2**32 will be considered to be IPv4 by default. +A ValueError is raised if address does not represent a valid IPv4 +or IPv6 address.

    +
    >>> ipaddress.ip_address('192.168.0.1')
    +IPv4Address('192.168.0.1')
    +>>> ipaddress.ip_address('2001:db8::')
    +IPv6Address('2001:db8::')
    +
    +
    +
    + +
    +
    +ipaddress.ip_network(address, strict=True)
    +

    Return an IPv4Network or IPv6Network object depending on +the IP address passed as argument. address is a string or integer +representing the IP network. Either IPv4 or IPv6 networks may be supplied; +integers less than 2**32 will be considered to be IPv4 by default. strict +is passed to IPv4Network or IPv6Network constructor. A +ValueError is raised if address does not represent a valid IPv4 or +IPv6 address, or if the network has host bits set.

    +
    >>> ipaddress.ip_network('192.168.0.0/28')
    +IPv4Network('192.168.0.0/28')
    +
    +
    +
    + +
    +
    +ipaddress.ip_interface(address)
    +

    Return an IPv4Interface or IPv6Interface object depending +on the IP address passed as argument. address is a string or integer +representing the IP address. Either IPv4 or IPv6 addresses may be supplied; +integers less than 2**32 will be considered to be IPv4 by default. A +ValueError is raised if address does not represent a valid IPv4 or +IPv6 address.

    +
    + +

    One downside of these convenience functions is that the need to handle both +IPv4 and IPv6 formats means that error messages provide minimal +information on the precise error, as the functions don’t know whether the +IPv4 or IPv6 format was intended. More detailed error reporting can be +obtained by calling the appropriate version specific class constructors +directly.

    +
    +
    +

    IP Addresses

    +
    +

    Address objects

    +

    The IPv4Address and IPv6Address objects share a lot of common +attributes. Some attributes that are only meaningful for IPv6 addresses are +also implemented by IPv4Address objects, in order to make it easier to +write code that handles both IP versions correctly. Address objects are +hashable, so they can be used as keys in dictionaries.

    +
    +
    +class ipaddress.IPv4Address(address)
    +

    Construct an IPv4 address. An AddressValueError is raised if +address is not a valid IPv4 address.

    +

    The following constitutes a valid IPv4 address:

    +
      +
    1. A string in decimal-dot notation, consisting of four decimal integers in +the inclusive range 0–255, separated by dots (e.g. 192.168.0.1). Each +integer represents an octet (byte) in the address. Leading zeroes are +tolerated only for values less than 8 (as there is no ambiguity +between the decimal and octal interpretations of such strings).

    2. +
    3. An integer that fits into 32 bits.

    4. +
    5. An integer packed into a bytes object of length 4 (most +significant octet first).

    6. +
    +
    >>> ipaddress.IPv4Address('192.168.0.1')
    +IPv4Address('192.168.0.1')
    +>>> ipaddress.IPv4Address(3232235521)
    +IPv4Address('192.168.0.1')
    +>>> ipaddress.IPv4Address(b'\xC0\xA8\x00\x01')
    +IPv4Address('192.168.0.1')
    +
    +
    +
    +
    +version
    +

    The appropriate version number: 4 for IPv4, 6 for IPv6.

    +
    + +
    +
    +max_prefixlen
    +

    The total number of bits in the address representation for this +version: 32 for IPv4, 128 for IPv6.

    +

    The prefix defines the number of leading bits in an address that +are compared to determine whether or not an address is part of a +network.

    +
    + +
    +
    +compressed
    +
    + +
    +
    +exploded
    +

    The string representation in dotted decimal notation. Leading zeroes +are never included in the representation.

    +

    As IPv4 does not define a shorthand notation for addresses with octets +set to zero, these two attributes are always the same as str(addr) +for IPv4 addresses. Exposing these attributes makes it easier to +write display code that can handle both IPv4 and IPv6 addresses.

    +
    + +
    +
    +packed
    +

    The binary representation of this address - a bytes object of +the appropriate length (most significant octet first). This is 4 bytes +for IPv4 and 16 bytes for IPv6.

    +
    + +
    +
    +reverse_pointer
    +

    The name of the reverse DNS PTR record for the IP address, e.g.:

    +
    >>> ipaddress.ip_address("127.0.0.1").reverse_pointer
    +'1.0.0.127.in-addr.arpa'
    +>>> ipaddress.ip_address("2001:db8::1").reverse_pointer
    +'1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa'
    +
    +
    +

    This is the name that could be used for performing a PTR lookup, not the +resolved hostname itself.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +is_multicast
    +

    True if the address is reserved for multicast use. See +RFC 3171 (for IPv4) or RFC 2373 (for IPv6).

    +
    + +
    +
    +is_private
    +

    True if the address is allocated for private networks. See +iana-ipv4-special-registry (for IPv4) or iana-ipv6-special-registry +(for IPv6).

    +
    + +
    +
    +is_global
    +

    True if the address is allocated for public networks. See +iana-ipv4-special-registry (for IPv4) or iana-ipv6-special-registry +(for IPv6).

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +is_unspecified
    +

    True if the address is unspecified. See RFC 5735 (for IPv4) +or RFC 2373 (for IPv6).

    +
    + +
    +
    +is_reserved
    +

    True if the address is otherwise IETF reserved.

    +
    + +
    +
    +is_loopback
    +

    True if this is a loopback address. See RFC 3330 (for IPv4) +or RFC 2373 (for IPv6).

    +
    + +
    + +

    True if the address is reserved for link-local usage. See +RFC 3927.

    +
    + +
    + +
    +
    +class ipaddress.IPv6Address(address)
    +

    Construct an IPv6 address. An AddressValueError is raised if +address is not a valid IPv6 address.

    +

    The following constitutes a valid IPv6 address:

    +
      +
    1. A string consisting of eight groups of four hexadecimal digits, each +group representing 16 bits. The groups are separated by colons. +This describes an exploded (longhand) notation. The string can +also be compressed (shorthand notation) by various means. See +RFC 4291 for details. For example, +"0000:0000:0000:0000:0000:0abc:0007:0def" can be compressed to +"::abc:7:def".

    2. +
    3. An integer that fits into 128 bits.

    4. +
    5. An integer packed into a bytes object of length 16, big-endian.

    6. +
    +
    >>> ipaddress.IPv6Address('2001:db8::1000')
    +IPv6Address('2001:db8::1000')
    +
    +
    +
    +
    +compressed
    +
    + +

    The short form of the address representation, with leading zeroes in +groups omitted and the longest sequence of groups consisting entirely of +zeroes collapsed to a single empty group.

    +

    This is also the value returned by str(addr) for IPv6 addresses.

    +
    +
    +exploded
    +
    + +

    The long form of the address representation, with all leading zeroes and +groups consisting entirely of zeroes included.

    +

    For the following attributes, see the corresponding documentation of the +IPv4Address class:

    +
    +
    +packed
    +
    + +
    +
    +reverse_pointer
    +
    + +
    +
    +version
    +
    + +
    +
    +max_prefixlen
    +
    + +
    +
    +is_multicast
    +
    + +
    +
    +is_private
    +
    + +
    +
    +is_global
    +
    + +
    +
    +is_unspecified
    +
    + +
    +
    +is_reserved
    +
    + +
    +
    +is_loopback
    +
    + +
    + +
    +

    New in version 3.4: is_global

    +
    +
    + +
    +
    +is_site_local
    +

    True if the address is reserved for site-local usage. Note that +the site-local address space has been deprecated by RFC 3879. Use +is_private to test if this address is in the +space of unique local addresses as defined by RFC 4193.

    +
    + +
    +
    +ipv4_mapped
    +

    For addresses that appear to be IPv4 mapped addresses (starting with +::FFFF/96), this property will report the embedded IPv4 address. +For any other address, this property will be None.

    +
    + +
    +
    +sixtofour
    +

    For addresses that appear to be 6to4 addresses (starting with +2002::/16) as defined by RFC 3056, this property will report +the embedded IPv4 address. For any other address, this property will +be None.

    +
    + +
    +
    +teredo
    +

    For addresses that appear to be Teredo addresses (starting with +2001::/32) as defined by RFC 4380, this property will report +the embedded (server, client) IP address pair. For any other +address, this property will be None.

    +
    + +
    + +
    +
    +

    Conversion to Strings and Integers

    +

    To interoperate with networking interfaces such as the socket module, +addresses must be converted to strings or integers. This is handled using +the str() and int() builtin functions:

    +
    >>> str(ipaddress.IPv4Address('192.168.0.1'))
    +'192.168.0.1'
    +>>> int(ipaddress.IPv4Address('192.168.0.1'))
    +3232235521
    +>>> str(ipaddress.IPv6Address('::1'))
    +'::1'
    +>>> int(ipaddress.IPv6Address('::1'))
    +1
    +
    +
    +
    +
    +

    Operators

    +

    Address objects support some operators. Unless stated otherwise, operators can +only be applied between compatible objects (i.e. IPv4 with IPv4, IPv6 with +IPv6).

    +
    +

    Comparison operators

    +

    Address objects can be compared with the usual set of comparison operators. Some +examples:

    +
    >>> IPv4Address('127.0.0.2') > IPv4Address('127.0.0.1')
    +True
    +>>> IPv4Address('127.0.0.2') == IPv4Address('127.0.0.1')
    +False
    +>>> IPv4Address('127.0.0.2') != IPv4Address('127.0.0.1')
    +True
    +
    +
    +
    +
    +

    Arithmetic operators

    +

    Integers can be added to or subtracted from address objects. Some examples:

    +
    >>> IPv4Address('127.0.0.2') + 3
    +IPv4Address('127.0.0.5')
    +>>> IPv4Address('127.0.0.2') - 3
    +IPv4Address('126.255.255.255')
    +>>> IPv4Address('255.255.255.255') + 1
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +ipaddress.AddressValueError: 4294967296 (>= 2**32) is not permitted as an IPv4 address
    +
    +
    +
    +
    +
    +
    +

    IP Network definitions

    +

    The IPv4Network and IPv6Network objects provide a mechanism +for defining and inspecting IP network definitions. A network definition +consists of a mask and a network address, and as such defines a range of +IP addresses that equal the network address when masked (binary AND) with the +mask. For example, a network definition with the mask 255.255.255.0 and +the network address 192.168.1.0 consists of IP addresses in the inclusive +range 192.168.1.0 to 192.168.1.255.

    +
    +

    Prefix, net mask and host mask

    +

    There are several equivalent ways to specify IP network masks. A prefix +/<nbits> is a notation that denotes how many high-order bits are set in +the network mask. A net mask is an IP address with some number of +high-order bits set. Thus the prefix /24 is equivalent to the net mask +255.255.255.0 in IPv4, or ffff:ff00:: in IPv6. In addition, a +host mask is the logical inverse of a net mask, and is sometimes used +(for example in Cisco access control lists) to denote a network mask. The +host mask equivalent to /24 in IPv4 is 0.0.0.255.

    +
    +
    +

    Network objects

    +

    All attributes implemented by address objects are implemented by network +objects as well. In addition, network objects implement additional attributes. +All of these are common between IPv4Network and IPv6Network, +so to avoid duplication they are only documented for IPv4Network. +Network objects are hashable, so they can be used as keys in +dictionaries.

    +
    +
    +class ipaddress.IPv4Network(address, strict=True)
    +

    Construct an IPv4 network definition. address can be one of the following:

    +
      +
    1. A string consisting of an IP address and an optional mask, separated by +a slash (/). The IP address is the network address, and the mask +can be either a single number, which means it’s a prefix, or a string +representation of an IPv4 address. If it’s the latter, the mask is +interpreted as a net mask if it starts with a non-zero field, or as a +host mask if it starts with a zero field, with the single exception of +an all-zero mask which is treated as a net mask. If no mask is provided, +it’s considered to be /32.

      +

      For example, the following address specifications are equivalent: +192.168.1.0/24, 192.168.1.0/255.255.255.0 and +192.168.1.0/0.0.0.255.

      +
    2. +
    3. An integer that fits into 32 bits. This is equivalent to a +single-address network, with the network address being address and +the mask being /32.

    4. +
    5. An integer packed into a bytes object of length 4, big-endian. +The interpretation is similar to an integer address.

    6. +
    7. A two-tuple of an address description and a netmask, where the address +description is either a string, a 32-bits integer, a 4-bytes packed +integer, or an existing IPv4Address object; and the netmask is either +an integer representing the prefix length (e.g. 24) or a string +representing the prefix mask (e.g. 255.255.255.0).

    8. +
    +

    An AddressValueError is raised if address is not a valid IPv4 +address. A NetmaskValueError is raised if the mask is not valid for +an IPv4 address.

    +

    If strict is True and host bits are set in the supplied address, +then ValueError is raised. Otherwise, the host bits are masked out +to determine the appropriate network address.

    +

    Unless stated otherwise, all network methods accepting other network/address +objects will raise TypeError if the argument’s IP version is +incompatible to self.

    +
    +

    Changed in version 3.5: Added the two-tuple form for the address constructor parameter.

    +
    +
    +
    +version
    +
    + +
    +
    +max_prefixlen
    +

    Refer to the corresponding attribute documentation in +IPv4Address.

    +
    + +
    +
    +is_multicast
    +
    + +
    +
    +is_private
    +
    + +
    +
    +is_unspecified
    +
    + +
    +
    +is_reserved
    +
    + +
    +
    +is_loopback
    +
    + +
    + +

    These attributes are true for the network as a whole if they are true +for both the network address and the broadcast address.

    +
    + +
    +
    +network_address
    +

    The network address for the network. The network address and the +prefix length together uniquely define a network.

    +
    + +
    +
    +broadcast_address
    +

    The broadcast address for the network. Packets sent to the broadcast +address should be received by every host on the network.

    +
    + +
    +
    +hostmask
    +

    The host mask, as an IPv4Address object.

    +
    + +
    +
    +netmask
    +

    The net mask, as an IPv4Address object.

    +
    + +
    +
    +with_prefixlen
    +
    + +
    +
    +compressed
    +
    + +
    +
    +exploded
    +

    A string representation of the network, with the mask in prefix +notation.

    +

    with_prefixlen and compressed are always the same as +str(network). +exploded uses the exploded form the network address.

    +
    + +
    +
    +with_netmask
    +

    A string representation of the network, with the mask in net mask +notation.

    +
    + +
    +
    +with_hostmask
    +

    A string representation of the network, with the mask in host mask +notation.

    +
    + +
    +
    +num_addresses
    +

    The total number of addresses in the network.

    +
    + +
    +
    +prefixlen
    +

    Length of the network prefix, in bits.

    +
    + +
    +
    +hosts()
    +

    Returns an iterator over the usable hosts in the network. The usable +hosts are all the IP addresses that belong to the network, except the +network address itself and the network broadcast address. For networks +with a mask length of 31, the network address and network broadcast +address are also included in the result.

    +
    >>> list(ip_network('192.0.2.0/29').hosts())  #doctest: +NORMALIZE_WHITESPACE
    +[IPv4Address('192.0.2.1'), IPv4Address('192.0.2.2'),
    + IPv4Address('192.0.2.3'), IPv4Address('192.0.2.4'),
    + IPv4Address('192.0.2.5'), IPv4Address('192.0.2.6')]
    +>>> list(ip_network('192.0.2.0/31').hosts())
    +[IPv4Address('192.0.2.0'), IPv4Address('192.0.2.1')]
    +
    +
    +
    + +
    +
    +overlaps(other)
    +

    True if this network is partly or wholly contained in other or +other is wholly contained in this network.

    +
    + +
    +
    +address_exclude(network)
    +

    Computes the network definitions resulting from removing the given +network from this one. Returns an iterator of network objects. +Raises ValueError if network is not completely contained in +this network.

    +
    >>> n1 = ip_network('192.0.2.0/28')
    +>>> n2 = ip_network('192.0.2.1/32')
    +>>> list(n1.address_exclude(n2))  #doctest: +NORMALIZE_WHITESPACE
    +[IPv4Network('192.0.2.8/29'), IPv4Network('192.0.2.4/30'),
    + IPv4Network('192.0.2.2/31'), IPv4Network('192.0.2.0/32')]
    +
    +
    +
    + +
    +
    +subnets(prefixlen_diff=1, new_prefix=None)
    +

    The subnets that join to make the current network definition, depending +on the argument values. prefixlen_diff is the amount our prefix +length should be increased by. new_prefix is the desired new +prefix of the subnets; it must be larger than our prefix. One and +only one of prefixlen_diff and new_prefix must be set. Returns an +iterator of network objects.

    +
    >>> list(ip_network('192.0.2.0/24').subnets())
    +[IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/25')]
    +>>> list(ip_network('192.0.2.0/24').subnets(prefixlen_diff=2))  #doctest: +NORMALIZE_WHITESPACE
    +[IPv4Network('192.0.2.0/26'), IPv4Network('192.0.2.64/26'),
    + IPv4Network('192.0.2.128/26'), IPv4Network('192.0.2.192/26')]
    +>>> list(ip_network('192.0.2.0/24').subnets(new_prefix=26))  #doctest: +NORMALIZE_WHITESPACE
    +[IPv4Network('192.0.2.0/26'), IPv4Network('192.0.2.64/26'),
    + IPv4Network('192.0.2.128/26'), IPv4Network('192.0.2.192/26')]
    +>>> list(ip_network('192.0.2.0/24').subnets(new_prefix=23))
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +    raise ValueError('new prefix must be longer')
    +ValueError: new prefix must be longer
    +>>> list(ip_network('192.0.2.0/24').subnets(new_prefix=25))
    +[IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/25')]
    +
    +
    +
    + +
    +
    +supernet(prefixlen_diff=1, new_prefix=None)
    +

    The supernet containing this network definition, depending on the +argument values. prefixlen_diff is the amount our prefix length +should be decreased by. new_prefix is the desired new prefix of +the supernet; it must be smaller than our prefix. One and only one +of prefixlen_diff and new_prefix must be set. Returns a single +network object.

    +
    >>> ip_network('192.0.2.0/24').supernet()
    +IPv4Network('192.0.2.0/23')
    +>>> ip_network('192.0.2.0/24').supernet(prefixlen_diff=2)
    +IPv4Network('192.0.0.0/22')
    +>>> ip_network('192.0.2.0/24').supernet(new_prefix=20)
    +IPv4Network('192.0.0.0/20')
    +
    +
    +
    + +
    +
    +subnet_of(other)
    +

    Returns True if this network is a subnet of other.

    +
    >>> a = ip_network('192.168.1.0/24')
    +>>> b = ip_network('192.168.1.128/30')
    +>>> b.subnet_of(a)
    +True
    +
    +
    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +supernet_of(other)
    +

    Returns True if this network is a supernet of other.

    +
    >>> a = ip_network('192.168.1.0/24')
    +>>> b = ip_network('192.168.1.128/30')
    +>>> a.supernet_of(b)
    +True
    +
    +
    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +compare_networks(other)
    +

    Compare this network to other. In this comparison only the network +addresses are considered; host bits aren’t. Returns either -1, +0 or 1.

    +
    >>> ip_network('192.0.2.1/32').compare_networks(ip_network('192.0.2.2/32'))
    +-1
    +>>> ip_network('192.0.2.1/32').compare_networks(ip_network('192.0.2.0/32'))
    +1
    +>>> ip_network('192.0.2.1/32').compare_networks(ip_network('192.0.2.1/32'))
    +0
    +
    +
    +
    +

    Deprecated since version 3.7: It uses the same ordering and comparison algorithm as “<”, “==”, and “>”

    +
    +
    + +
    + +
    +
    +class ipaddress.IPv6Network(address, strict=True)
    +

    Construct an IPv6 network definition. address can be one of the following:

    +
      +
    1. A string consisting of an IP address and an optional prefix length, +separated by a slash (/). The IP address is the network address, +and the prefix length must be a single number, the prefix. If no +prefix length is provided, it’s considered to be /128.

      +

      Note that currently expanded netmasks are not supported. That means +2001:db00::0/24 is a valid argument while 2001:db00::0/ffff:ff00:: +not.

      +
    2. +
    3. An integer that fits into 128 bits. This is equivalent to a +single-address network, with the network address being address and +the mask being /128.

    4. +
    5. An integer packed into a bytes object of length 16, big-endian. +The interpretation is similar to an integer address.

    6. +
    7. A two-tuple of an address description and a netmask, where the address +description is either a string, a 128-bits integer, a 16-bytes packed +integer, or an existing IPv6Address object; and the netmask is an +integer representing the prefix length.

    8. +
    +

    An AddressValueError is raised if address is not a valid IPv6 +address. A NetmaskValueError is raised if the mask is not valid for +an IPv6 address.

    +

    If strict is True and host bits are set in the supplied address, +then ValueError is raised. Otherwise, the host bits are masked out +to determine the appropriate network address.

    +
    +

    Changed in version 3.5: Added the two-tuple form for the address constructor parameter.

    +
    +
    +
    +version
    +
    + +
    +
    +max_prefixlen
    +
    + +
    +
    +is_multicast
    +
    + +
    +
    +is_private
    +
    + +
    +
    +is_unspecified
    +
    + +
    +
    +is_reserved
    +
    + +
    +
    +is_loopback
    +
    + +
    + +
    + +
    +
    +network_address
    +
    + +
    +
    +broadcast_address
    +
    + +
    +
    +hostmask
    +
    + +
    +
    +netmask
    +
    + +
    +
    +with_prefixlen
    +
    + +
    +
    +compressed
    +
    + +
    +
    +exploded
    +
    + +
    +
    +with_netmask
    +
    + +
    +
    +with_hostmask
    +
    + +
    +
    +num_addresses
    +
    + +
    +
    +prefixlen
    +
    + +
    +
    +hosts()
    +

    Returns an iterator over the usable hosts in the network. The usable +hosts are all the IP addresses that belong to the network, except the +Subnet-Router anycast address. For networks with a mask length of 127, +the Subnet-Router anycast address is also included in the result.

    +
    + +
    +
    +overlaps(other)
    +
    + +
    +
    +address_exclude(network)
    +
    + +
    +
    +subnets(prefixlen_diff=1, new_prefix=None)
    +
    + +
    +
    +supernet(prefixlen_diff=1, new_prefix=None)
    +
    + +
    +
    +subnet_of(other)
    +
    + +
    +
    +supernet_of(other)
    +
    + +
    +
    +compare_networks(other)
    +

    Refer to the corresponding attribute documentation in +IPv4Network.

    +
    + +
    +
    +is_site_local
    +

    These attribute is true for the network as a whole if it is true +for both the network address and the broadcast address.

    +
    + +
    + +
    +
    +

    Operators

    +

    Network objects support some operators. Unless stated otherwise, operators can +only be applied between compatible objects (i.e. IPv4 with IPv4, IPv6 with +IPv6).

    +
    +

    Logical operators

    +

    Network objects can be compared with the usual set of logical operators. +Network objects are ordered first by network address, then by net mask.

    +
    +
    +

    Iteration

    +

    Network objects can be iterated to list all the addresses belonging to the +network. For iteration, all hosts are returned, including unusable hosts +(for usable hosts, use the hosts() method). An +example:

    +
    >>> for addr in IPv4Network('192.0.2.0/28'):
    +...     addr
    +...
    +IPv4Address('192.0.2.0')
    +IPv4Address('192.0.2.1')
    +IPv4Address('192.0.2.2')
    +IPv4Address('192.0.2.3')
    +IPv4Address('192.0.2.4')
    +IPv4Address('192.0.2.5')
    +IPv4Address('192.0.2.6')
    +IPv4Address('192.0.2.7')
    +IPv4Address('192.0.2.8')
    +IPv4Address('192.0.2.9')
    +IPv4Address('192.0.2.10')
    +IPv4Address('192.0.2.11')
    +IPv4Address('192.0.2.12')
    +IPv4Address('192.0.2.13')
    +IPv4Address('192.0.2.14')
    +IPv4Address('192.0.2.15')
    +
    +
    +
    +
    +

    Networks as containers of addresses

    +

    Network objects can act as containers of addresses. Some examples:

    +
    >>> IPv4Network('192.0.2.0/28')[0]
    +IPv4Address('192.0.2.0')
    +>>> IPv4Network('192.0.2.0/28')[15]
    +IPv4Address('192.0.2.15')
    +>>> IPv4Address('192.0.2.6') in IPv4Network('192.0.2.0/28')
    +True
    +>>> IPv4Address('192.0.3.6') in IPv4Network('192.0.2.0/28')
    +False
    +
    +
    +
    +
    +
    +
    +

    Interface objects

    +

    Interface objects are hashable, so they can be used as keys in +dictionaries.

    +
    +
    +class ipaddress.IPv4Interface(address)
    +

    Construct an IPv4 interface. The meaning of address is as in the +constructor of IPv4Network, except that arbitrary host addresses +are always accepted.

    +

    IPv4Interface is a subclass of IPv4Address, so it inherits +all the attributes from that class. In addition, the following attributes +are available:

    +
    +
    +ip
    +

    The address (IPv4Address) without network information.

    +
    >>> interface = IPv4Interface('192.0.2.5/24')
    +>>> interface.ip
    +IPv4Address('192.0.2.5')
    +
    +
    +
    + +
    +
    +network
    +

    The network (IPv4Network) this interface belongs to.

    +
    >>> interface = IPv4Interface('192.0.2.5/24')
    +>>> interface.network
    +IPv4Network('192.0.2.0/24')
    +
    +
    +
    + +
    +
    +with_prefixlen
    +

    A string representation of the interface with the mask in prefix notation.

    +
    >>> interface = IPv4Interface('192.0.2.5/24')
    +>>> interface.with_prefixlen
    +'192.0.2.5/24'
    +
    +
    +
    + +
    +
    +with_netmask
    +

    A string representation of the interface with the network as a net mask.

    +
    >>> interface = IPv4Interface('192.0.2.5/24')
    +>>> interface.with_netmask
    +'192.0.2.5/255.255.255.0'
    +
    +
    +
    + +
    +
    +with_hostmask
    +

    A string representation of the interface with the network as a host mask.

    +
    >>> interface = IPv4Interface('192.0.2.5/24')
    +>>> interface.with_hostmask
    +'192.0.2.5/0.0.0.255'
    +
    +
    +
    + +
    + +
    +
    +class ipaddress.IPv6Interface(address)
    +

    Construct an IPv6 interface. The meaning of address is as in the +constructor of IPv6Network, except that arbitrary host addresses +are always accepted.

    +

    IPv6Interface is a subclass of IPv6Address, so it inherits +all the attributes from that class. In addition, the following attributes +are available:

    +
    +
    +ip
    +
    + +
    +
    +network
    +
    + +
    +
    +with_prefixlen
    +
    + +
    +
    +with_netmask
    +
    + +
    +
    +with_hostmask
    +

    Refer to the corresponding attribute documentation in +IPv4Interface.

    +
    + +
    + +
    +

    Operators

    +

    Interface objects support some operators. Unless stated otherwise, operators +can only be applied between compatible objects (i.e. IPv4 with IPv4, IPv6 with +IPv6).

    +
    +

    Logical operators

    +

    Interface objects can be compared with the usual set of logical operators.

    +

    For equality comparison (== and !=), both the IP address and network +must be the same for the objects to be equal. An interface will not compare +equal to any address or network object.

    +

    For ordering (<, >, etc) the rules are different. Interface and +address objects with the same IP version can be compared, and the address +objects will always sort before the interface objects. Two interface objects +are first compared by their networks and, if those are the same, then by their +IP addresses.

    +
    +
    +
    +
    +

    Other Module Level Functions

    +

    The module also provides the following module level functions:

    +
    +
    +ipaddress.v4_int_to_packed(address)
    +

    Represent an address as 4 packed bytes in network (big-endian) order. +address is an integer representation of an IPv4 IP address. A +ValueError is raised if the integer is negative or too large to be an +IPv4 IP address.

    +
    >>> ipaddress.ip_address(3221225985)
    +IPv4Address('192.0.2.1')
    +>>> ipaddress.v4_int_to_packed(3221225985)
    +b'\xc0\x00\x02\x01'
    +
    +
    +
    + +
    +
    +ipaddress.v6_int_to_packed(address)
    +

    Represent an address as 16 packed bytes in network (big-endian) order. +address is an integer representation of an IPv6 IP address. A +ValueError is raised if the integer is negative or too large to be an +IPv6 IP address.

    +
    + +
    +
    +ipaddress.summarize_address_range(first, last)
    +

    Return an iterator of the summarized network range given the first and last +IP addresses. first is the first IPv4Address or +IPv6Address in the range and last is the last IPv4Address +or IPv6Address in the range. A TypeError is raised if +first or last are not IP addresses or are not of the same version. A +ValueError is raised if last is not greater than first or if +first address version is not 4 or 6.

    +
    >>> [ipaddr for ipaddr in ipaddress.summarize_address_range(
    +...    ipaddress.IPv4Address('192.0.2.0'),
    +...    ipaddress.IPv4Address('192.0.2.130'))]
    +[IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/31'), IPv4Network('192.0.2.130/32')]
    +
    +
    +
    + +
    +
    +ipaddress.collapse_addresses(addresses)
    +

    Return an iterator of the collapsed IPv4Network or +IPv6Network objects. addresses is an iterator of +IPv4Network or IPv6Network objects. A TypeError is +raised if addresses contains mixed version objects.

    +
    >>> [ipaddr for ipaddr in
    +... ipaddress.collapse_addresses([ipaddress.IPv4Network('192.0.2.0/25'),
    +... ipaddress.IPv4Network('192.0.2.128/25')])]
    +[IPv4Network('192.0.2.0/24')]
    +
    +
    +
    + +
    +
    +ipaddress.get_mixed_type_key(obj)
    +

    Return a key suitable for sorting between networks and addresses. Address +and Network objects are not sortable by default; they’re fundamentally +different, so the expression:

    +
    IPv4Address('192.0.2.0') <= IPv4Network('192.0.2.0/24')
    +
    +
    +

    doesn’t make sense. There are some times however, where you may wish to +have ipaddress sort these anyway. If you need to do this, you can use +this function as the key argument to sorted().

    +

    obj is either a network or address object.

    +
    + +
    +
    +

    Custom Exceptions

    +

    To support more specific error reporting from class constructors, the +module defines the following exceptions:

    +
    +
    +exception ipaddress.AddressValueError(ValueError)
    +

    Any value error related to the address.

    +
    + +
    +
    +exception ipaddress.NetmaskValueError(ValueError)
    +

    Any value error related to the net mask.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/ipc.html b/python-3.7.4-docs-html/library/ipc.html new file mode 100644 index 0000000..2a9a67b --- /dev/null +++ b/python-3.7.4-docs-html/library/ipc.html @@ -0,0 +1,200 @@ + + + + + + + Networking and Interprocess Communication — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Networking and Interprocess Communication

    +

    The modules described in this chapter provide mechanisms for +networking and inter-processes communication.

    +

    Some modules only work for two processes that are on the same machine, e.g. +signal and mmap. Other modules support networking protocols +that two or more processes can use to communicate across machines.

    +

    The list of modules described in this chapter is:

    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/itertools.html b/python-3.7.4-docs-html/library/itertools.html new file mode 100644 index 0000000..2667d77 --- /dev/null +++ b/python-3.7.4-docs-html/library/itertools.html @@ -0,0 +1,1202 @@ + + + + + + + itertools — Functions creating iterators for efficient looping — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    itertools — Functions creating iterators for efficient looping

    +
    +

    This module implements a number of iterator building blocks inspired +by constructs from APL, Haskell, and SML. Each has been recast in a form +suitable for Python.

    +

    The module standardizes a core set of fast, memory efficient tools that are +useful by themselves or in combination. Together, they form an “iterator +algebra” making it possible to construct specialized tools succinctly and +efficiently in pure Python.

    +

    For instance, SML provides a tabulation tool: tabulate(f) which produces a +sequence f(0), f(1), .... The same effect can be achieved in Python +by combining map() and count() to form map(f, count()).

    +

    These tools and their built-in counterparts also work well with the high-speed +functions in the operator module. For example, the multiplication +operator can be mapped across two vectors to form an efficient dot-product: +sum(map(operator.mul, vector1, vector2)).

    +

    Infinite iterators:

    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + +

    Iterator

    Arguments

    Results

    Example

    count()

    start, [step]

    start, start+step, start+2*step, …

    count(10) --> 10 11 12 13 14 ...

    cycle()

    p

    p0, p1, … plast, p0, p1, …

    cycle('ABCD') --> A B C D A B C D ...

    repeat()

    elem [,n]

    elem, elem, elem, … endlessly or up to n times

    repeat(10, 3) --> 10 10 10

    +

    Iterators terminating on the shortest input sequence:

    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Iterator

    Arguments

    Results

    Example

    accumulate()

    p [,func]

    p0, p0+p1, p0+p1+p2, …

    accumulate([1,2,3,4,5]) --> 1 3 6 10 15

    chain()

    p, q, …

    p0, p1, … plast, q0, q1, …

    chain('ABC', 'DEF') --> A B C D E F

    chain.from_iterable()

    iterable

    p0, p1, … plast, q0, q1, …

    chain.from_iterable(['ABC', 'DEF']) --> A B C D E F

    compress()

    data, selectors

    (d[0] if s[0]), (d[1] if s[1]), …

    compress('ABCDEF', [1,0,1,0,1,1]) --> A C E F

    dropwhile()

    pred, seq

    seq[n], seq[n+1], starting when pred fails

    dropwhile(lambda x: x<5, [1,4,6,4,1]) --> 6 4 1

    filterfalse()

    pred, seq

    elements of seq where pred(elem) is false

    filterfalse(lambda x: x%2, range(10)) --> 0 2 4 6 8

    groupby()

    iterable[, key]

    sub-iterators grouped by value of key(v)

    islice()

    seq, [start,] stop [, step]

    elements from seq[start:stop:step]

    islice('ABCDEFG', 2, None) --> C D E F G

    starmap()

    func, seq

    func(*seq[0]), func(*seq[1]), …

    starmap(pow, [(2,5), (3,2), (10,3)]) --> 32 9 1000

    takewhile()

    pred, seq

    seq[0], seq[1], until pred fails

    takewhile(lambda x: x<5, [1,4,6,4,1]) --> 1 4

    tee()

    it, n

    it1, it2, … itn splits one iterator into n

    zip_longest()

    p, q, …

    (p[0], q[0]), (p[1], q[1]), …

    zip_longest('ABCD', 'xy', fillvalue='-') --> Ax By C- D-

    +

    Combinatoric iterators:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Iterator

    Arguments

    Results

    product()

    p, q, … [repeat=1]

    cartesian product, equivalent to a nested for-loop

    permutations()

    p[, r]

    r-length tuples, all possible orderings, no repeated elements

    combinations()

    p, r

    r-length tuples, in sorted order, no repeated elements

    combinations_with_replacement()

    p, r

    r-length tuples, in sorted order, with repeated elements

    product('ABCD', repeat=2)

    AA AB AC AD BA BB BC BD CA CB CC CD DA DB DC DD

    permutations('ABCD', 2)

    AB AC AD BA BC BD CA CB CD DA DB DC

    combinations('ABCD', 2)

    AB AC AD BC BD CD

    combinations_with_replacement('ABCD', 2)

    AA AB AC AD BB BC BD CC CD DD

    +
    +

    Itertool functions

    +

    The following module functions all construct and return iterators. Some provide +streams of infinite length, so they should only be accessed by functions or +loops that truncate the stream.

    +
    +
    +itertools.accumulate(iterable[, func])
    +

    Make an iterator that returns accumulated sums, or accumulated +results of other binary functions (specified via the optional +func argument). If func is supplied, it should be a function +of two arguments. Elements of the input iterable may be any type +that can be accepted as arguments to func. (For example, with +the default operation of addition, elements may be any addable +type including Decimal or +Fraction.) If the input iterable is empty, the +output iterable will also be empty.

    +

    Roughly equivalent to:

    +
    def accumulate(iterable, func=operator.add):
    +    'Return running totals'
    +    # accumulate([1,2,3,4,5]) --> 1 3 6 10 15
    +    # accumulate([1,2,3,4,5], operator.mul) --> 1 2 6 24 120
    +    it = iter(iterable)
    +    try:
    +        total = next(it)
    +    except StopIteration:
    +        return
    +    yield total
    +    for element in it:
    +        total = func(total, element)
    +        yield total
    +
    +
    +

    There are a number of uses for the func argument. It can be set to +min() for a running minimum, max() for a running maximum, or +operator.mul() for a running product. Amortization tables can be +built by accumulating interest and applying payments. First-order +recurrence relations +can be modeled by supplying the initial value in the iterable and using only +the accumulated total in func argument:

    +
    >>> data = [3, 4, 6, 2, 1, 9, 0, 7, 5, 8]
    +>>> list(accumulate(data, operator.mul))     # running product
    +[3, 12, 72, 144, 144, 1296, 0, 0, 0, 0]
    +>>> list(accumulate(data, max))              # running maximum
    +[3, 4, 6, 6, 6, 9, 9, 9, 9, 9]
    +
    +# Amortize a 5% loan of 1000 with 4 annual payments of 90
    +>>> cashflows = [1000, -90, -90, -90, -90]
    +>>> list(accumulate(cashflows, lambda bal, pmt: bal*1.05 + pmt))
    +[1000, 960.0, 918.0, 873.9000000000001, 827.5950000000001]
    +
    +# Chaotic recurrence relation https://en.wikipedia.org/wiki/Logistic_map
    +>>> logistic_map = lambda x, _:  r * x * (1 - x)
    +>>> r = 3.8
    +>>> x0 = 0.4
    +>>> inputs = repeat(x0, 36)     # only the initial value is used
    +>>> [format(x, '.2f') for x in accumulate(inputs, logistic_map)]
    +['0.40', '0.91', '0.30', '0.81', '0.60', '0.92', '0.29', '0.79', '0.63',
    + '0.88', '0.39', '0.90', '0.33', '0.84', '0.52', '0.95', '0.18', '0.57',
    + '0.93', '0.25', '0.71', '0.79', '0.63', '0.88', '0.39', '0.91', '0.32',
    + '0.83', '0.54', '0.95', '0.20', '0.60', '0.91', '0.30', '0.80', '0.60']
    +
    +
    +

    See functools.reduce() for a similar function that returns only the +final accumulated value.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.3: Added the optional func parameter.

    +
    +
    + +
    +
    +itertools.chain(*iterables)
    +

    Make an iterator that returns elements from the first iterable until it is +exhausted, then proceeds to the next iterable, until all of the iterables are +exhausted. Used for treating consecutive sequences as a single sequence. +Roughly equivalent to:

    +
    def chain(*iterables):
    +    # chain('ABC', 'DEF') --> A B C D E F
    +    for it in iterables:
    +        for element in it:
    +            yield element
    +
    +
    +
    + +
    +
    +classmethod chain.from_iterable(iterable)
    +

    Alternate constructor for chain(). Gets chained inputs from a +single iterable argument that is evaluated lazily. Roughly equivalent to:

    +
    def from_iterable(iterables):
    +    # chain.from_iterable(['ABC', 'DEF']) --> A B C D E F
    +    for it in iterables:
    +        for element in it:
    +            yield element
    +
    +
    +
    + +
    +
    +itertools.combinations(iterable, r)
    +

    Return r length subsequences of elements from the input iterable.

    +

    Combinations are emitted in lexicographic sort order. So, if the +input iterable is sorted, the combination tuples will be produced +in sorted order.

    +

    Elements are treated as unique based on their position, not on their +value. So if the input elements are unique, there will be no repeat +values in each combination.

    +

    Roughly equivalent to:

    +
    def combinations(iterable, r):
    +    # combinations('ABCD', 2) --> AB AC AD BC BD CD
    +    # combinations(range(4), 3) --> 012 013 023 123
    +    pool = tuple(iterable)
    +    n = len(pool)
    +    if r > n:
    +        return
    +    indices = list(range(r))
    +    yield tuple(pool[i] for i in indices)
    +    while True:
    +        for i in reversed(range(r)):
    +            if indices[i] != i + n - r:
    +                break
    +        else:
    +            return
    +        indices[i] += 1
    +        for j in range(i+1, r):
    +            indices[j] = indices[j-1] + 1
    +        yield tuple(pool[i] for i in indices)
    +
    +
    +

    The code for combinations() can be also expressed as a subsequence +of permutations() after filtering entries where the elements are not +in sorted order (according to their position in the input pool):

    +
    def combinations(iterable, r):
    +    pool = tuple(iterable)
    +    n = len(pool)
    +    for indices in permutations(range(n), r):
    +        if sorted(indices) == list(indices):
    +            yield tuple(pool[i] for i in indices)
    +
    +
    +

    The number of items returned is n! / r! / (n-r)! when 0 <= r <= n +or zero when r > n.

    +
    + +
    +
    +itertools.combinations_with_replacement(iterable, r)
    +

    Return r length subsequences of elements from the input iterable +allowing individual elements to be repeated more than once.

    +

    Combinations are emitted in lexicographic sort order. So, if the +input iterable is sorted, the combination tuples will be produced +in sorted order.

    +

    Elements are treated as unique based on their position, not on their +value. So if the input elements are unique, the generated combinations +will also be unique.

    +

    Roughly equivalent to:

    +
    def combinations_with_replacement(iterable, r):
    +    # combinations_with_replacement('ABC', 2) --> AA AB AC BB BC CC
    +    pool = tuple(iterable)
    +    n = len(pool)
    +    if not n and r:
    +        return
    +    indices = [0] * r
    +    yield tuple(pool[i] for i in indices)
    +    while True:
    +        for i in reversed(range(r)):
    +            if indices[i] != n - 1:
    +                break
    +        else:
    +            return
    +        indices[i:] = [indices[i] + 1] * (r - i)
    +        yield tuple(pool[i] for i in indices)
    +
    +
    +

    The code for combinations_with_replacement() can be also expressed as +a subsequence of product() after filtering entries where the elements +are not in sorted order (according to their position in the input pool):

    +
    def combinations_with_replacement(iterable, r):
    +    pool = tuple(iterable)
    +    n = len(pool)
    +    for indices in product(range(n), repeat=r):
    +        if sorted(indices) == list(indices):
    +            yield tuple(pool[i] for i in indices)
    +
    +
    +

    The number of items returned is (n+r-1)! / r! / (n-1)! when n > 0.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +itertools.compress(data, selectors)
    +

    Make an iterator that filters elements from data returning only those that +have a corresponding element in selectors that evaluates to True. +Stops when either the data or selectors iterables has been exhausted. +Roughly equivalent to:

    +
    def compress(data, selectors):
    +    # compress('ABCDEF', [1,0,1,0,1,1]) --> A C E F
    +    return (d for d, s in zip(data, selectors) if s)
    +
    +
    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +itertools.count(start=0, step=1)
    +

    Make an iterator that returns evenly spaced values starting with number start. Often +used as an argument to map() to generate consecutive data points. +Also, used with zip() to add sequence numbers. Roughly equivalent to:

    +
    def count(start=0, step=1):
    +    # count(10) --> 10 11 12 13 14 ...
    +    # count(2.5, 0.5) -> 2.5 3.0 3.5 ...
    +    n = start
    +    while True:
    +        yield n
    +        n += step
    +
    +
    +

    When counting with floating point numbers, better accuracy can sometimes be +achieved by substituting multiplicative code such as: (start + step * i +for i in count()).

    +
    +

    Changed in version 3.1: Added step argument and allowed non-integer arguments.

    +
    +
    + +
    +
    +itertools.cycle(iterable)
    +

    Make an iterator returning elements from the iterable and saving a copy of each. +When the iterable is exhausted, return elements from the saved copy. Repeats +indefinitely. Roughly equivalent to:

    +
    def cycle(iterable):
    +    # cycle('ABCD') --> A B C D A B C D A B C D ...
    +    saved = []
    +    for element in iterable:
    +        yield element
    +        saved.append(element)
    +    while saved:
    +        for element in saved:
    +              yield element
    +
    +
    +

    Note, this member of the toolkit may require significant auxiliary storage +(depending on the length of the iterable).

    +
    + +
    +
    +itertools.dropwhile(predicate, iterable)
    +

    Make an iterator that drops elements from the iterable as long as the predicate +is true; afterwards, returns every element. Note, the iterator does not produce +any output until the predicate first becomes false, so it may have a lengthy +start-up time. Roughly equivalent to:

    +
    def dropwhile(predicate, iterable):
    +    # dropwhile(lambda x: x<5, [1,4,6,4,1]) --> 6 4 1
    +    iterable = iter(iterable)
    +    for x in iterable:
    +        if not predicate(x):
    +            yield x
    +            break
    +    for x in iterable:
    +        yield x
    +
    +
    +
    + +
    +
    +itertools.filterfalse(predicate, iterable)
    +

    Make an iterator that filters elements from iterable returning only those for +which the predicate is False. If predicate is None, return the items +that are false. Roughly equivalent to:

    +
    def filterfalse(predicate, iterable):
    +    # filterfalse(lambda x: x%2, range(10)) --> 0 2 4 6 8
    +    if predicate is None:
    +        predicate = bool
    +    for x in iterable:
    +        if not predicate(x):
    +            yield x
    +
    +
    +
    + +
    +
    +itertools.groupby(iterable, key=None)
    +

    Make an iterator that returns consecutive keys and groups from the iterable. +The key is a function computing a key value for each element. If not +specified or is None, key defaults to an identity function and returns +the element unchanged. Generally, the iterable needs to already be sorted on +the same key function.

    +

    The operation of groupby() is similar to the uniq filter in Unix. It +generates a break or new group every time the value of the key function changes +(which is why it is usually necessary to have sorted the data using the same key +function). That behavior differs from SQL’s GROUP BY which aggregates common +elements regardless of their input order.

    +

    The returned group is itself an iterator that shares the underlying iterable +with groupby(). Because the source is shared, when the groupby() +object is advanced, the previous group is no longer visible. So, if that data +is needed later, it should be stored as a list:

    +
    groups = []
    +uniquekeys = []
    +data = sorted(data, key=keyfunc)
    +for k, g in groupby(data, keyfunc):
    +    groups.append(list(g))      # Store group iterator as a list
    +    uniquekeys.append(k)
    +
    +
    +

    groupby() is roughly equivalent to:

    +
    class groupby:
    +    # [k for k, g in groupby('AAAABBBCCDAABBB')] --> A B C D A B
    +    # [list(g) for k, g in groupby('AAAABBBCCD')] --> AAAA BBB CC D
    +    def __init__(self, iterable, key=None):
    +        if key is None:
    +            key = lambda x: x
    +        self.keyfunc = key
    +        self.it = iter(iterable)
    +        self.tgtkey = self.currkey = self.currvalue = object()
    +    def __iter__(self):
    +        return self
    +    def __next__(self):
    +        self.id = object()
    +        while self.currkey == self.tgtkey:
    +            self.currvalue = next(self.it)    # Exit on StopIteration
    +            self.currkey = self.keyfunc(self.currvalue)
    +        self.tgtkey = self.currkey
    +        return (self.currkey, self._grouper(self.tgtkey, self.id))
    +    def _grouper(self, tgtkey, id):
    +        while self.id is id and self.currkey == tgtkey:
    +            yield self.currvalue
    +            try:
    +                self.currvalue = next(self.it)
    +            except StopIteration:
    +                return
    +            self.currkey = self.keyfunc(self.currvalue)
    +
    +
    +
    + +
    +
    +itertools.islice(iterable, stop)
    +
    +itertools.islice(iterable, start, stop[, step])
    +

    Make an iterator that returns selected elements from the iterable. If start is +non-zero, then elements from the iterable are skipped until start is reached. +Afterward, elements are returned consecutively unless step is set higher than +one which results in items being skipped. If stop is None, then iteration +continues until the iterator is exhausted, if at all; otherwise, it stops at the +specified position. Unlike regular slicing, islice() does not support +negative values for start, stop, or step. Can be used to extract related +fields from data where the internal structure has been flattened (for example, a +multi-line report may list a name field on every third line). Roughly equivalent to:

    +
    def islice(iterable, *args):
    +    # islice('ABCDEFG', 2) --> A B
    +    # islice('ABCDEFG', 2, 4) --> C D
    +    # islice('ABCDEFG', 2, None) --> C D E F G
    +    # islice('ABCDEFG', 0, None, 2) --> A C E G
    +    s = slice(*args)
    +    start, stop, step = s.start or 0, s.stop or sys.maxsize, s.step or 1
    +    it = iter(range(start, stop, step))
    +    try:
    +        nexti = next(it)
    +    except StopIteration:
    +        # Consume *iterable* up to the *start* position.
    +        for i, element in zip(range(start), iterable):
    +            pass
    +        return
    +    try:
    +        for i, element in enumerate(iterable):
    +            if i == nexti:
    +                yield element
    +                nexti = next(it)
    +    except StopIteration:
    +        # Consume to *stop*.
    +        for i, element in zip(range(i + 1, stop), iterable):
    +            pass
    +
    +
    +

    If start is None, then iteration starts at zero. If step is None, +then the step defaults to one.

    +
    + +
    +
    +itertools.permutations(iterable, r=None)
    +

    Return successive r length permutations of elements in the iterable.

    +

    If r is not specified or is None, then r defaults to the length +of the iterable and all possible full-length permutations +are generated.

    +

    Permutations are emitted in lexicographic sort order. So, if the +input iterable is sorted, the permutation tuples will be produced +in sorted order.

    +

    Elements are treated as unique based on their position, not on their +value. So if the input elements are unique, there will be no repeat +values in each permutation.

    +

    Roughly equivalent to:

    +
    def permutations(iterable, r=None):
    +    # permutations('ABCD', 2) --> AB AC AD BA BC BD CA CB CD DA DB DC
    +    # permutations(range(3)) --> 012 021 102 120 201 210
    +    pool = tuple(iterable)
    +    n = len(pool)
    +    r = n if r is None else r
    +    if r > n:
    +        return
    +    indices = list(range(n))
    +    cycles = list(range(n, n-r, -1))
    +    yield tuple(pool[i] for i in indices[:r])
    +    while n:
    +        for i in reversed(range(r)):
    +            cycles[i] -= 1
    +            if cycles[i] == 0:
    +                indices[i:] = indices[i+1:] + indices[i:i+1]
    +                cycles[i] = n - i
    +            else:
    +                j = cycles[i]
    +                indices[i], indices[-j] = indices[-j], indices[i]
    +                yield tuple(pool[i] for i in indices[:r])
    +                break
    +        else:
    +            return
    +
    +
    +

    The code for permutations() can be also expressed as a subsequence of +product(), filtered to exclude entries with repeated elements (those +from the same position in the input pool):

    +
    def permutations(iterable, r=None):
    +    pool = tuple(iterable)
    +    n = len(pool)
    +    r = n if r is None else r
    +    for indices in product(range(n), repeat=r):
    +        if len(set(indices)) == r:
    +            yield tuple(pool[i] for i in indices)
    +
    +
    +

    The number of items returned is n! / (n-r)! when 0 <= r <= n +or zero when r > n.

    +
    + +
    +
    +itertools.product(*iterables, repeat=1)
    +

    Cartesian product of input iterables.

    +

    Roughly equivalent to nested for-loops in a generator expression. For example, +product(A, B) returns the same as ((x,y) for x in A for y in B).

    +

    The nested loops cycle like an odometer with the rightmost element advancing +on every iteration. This pattern creates a lexicographic ordering so that if +the input’s iterables are sorted, the product tuples are emitted in sorted +order.

    +

    To compute the product of an iterable with itself, specify the number of +repetitions with the optional repeat keyword argument. For example, +product(A, repeat=4) means the same as product(A, A, A, A).

    +

    This function is roughly equivalent to the following code, except that the +actual implementation does not build up intermediate results in memory:

    +
    def product(*args, repeat=1):
    +    # product('ABCD', 'xy') --> Ax Ay Bx By Cx Cy Dx Dy
    +    # product(range(2), repeat=3) --> 000 001 010 011 100 101 110 111
    +    pools = [tuple(pool) for pool in args] * repeat
    +    result = [[]]
    +    for pool in pools:
    +        result = [x+[y] for x in result for y in pool]
    +    for prod in result:
    +        yield tuple(prod)
    +
    +
    +
    + +
    +
    +itertools.repeat(object[, times])
    +

    Make an iterator that returns object over and over again. Runs indefinitely +unless the times argument is specified. Used as argument to map() for +invariant parameters to the called function. Also used with zip() to +create an invariant part of a tuple record.

    +

    Roughly equivalent to:

    +
    def repeat(object, times=None):
    +    # repeat(10, 3) --> 10 10 10
    +    if times is None:
    +        while True:
    +            yield object
    +    else:
    +        for i in range(times):
    +            yield object
    +
    +
    +

    A common use for repeat is to supply a stream of constant values to map +or zip:

    +
    >>> list(map(pow, range(10), repeat(2)))
    +[0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
    +
    +
    +
    + +
    +
    +itertools.starmap(function, iterable)
    +

    Make an iterator that computes the function using arguments obtained from +the iterable. Used instead of map() when argument parameters are already +grouped in tuples from a single iterable (the data has been “pre-zipped”). The +difference between map() and starmap() parallels the distinction +between function(a,b) and function(*c). Roughly equivalent to:

    +
    def starmap(function, iterable):
    +    # starmap(pow, [(2,5), (3,2), (10,3)]) --> 32 9 1000
    +    for args in iterable:
    +        yield function(*args)
    +
    +
    +
    + +
    +
    +itertools.takewhile(predicate, iterable)
    +

    Make an iterator that returns elements from the iterable as long as the +predicate is true. Roughly equivalent to:

    +
    def takewhile(predicate, iterable):
    +    # takewhile(lambda x: x<5, [1,4,6,4,1]) --> 1 4
    +    for x in iterable:
    +        if predicate(x):
    +            yield x
    +        else:
    +            break
    +
    +
    +
    + +
    +
    +itertools.tee(iterable, n=2)
    +

    Return n independent iterators from a single iterable.

    +

    The following Python code helps explain what tee does (although the actual +implementation is more complex and uses only a single underlying +FIFO queue).

    +

    Roughly equivalent to:

    +
    def tee(iterable, n=2):
    +    it = iter(iterable)
    +    deques = [collections.deque() for i in range(n)]
    +    def gen(mydeque):
    +        while True:
    +            if not mydeque:             # when the local deque is empty
    +                try:
    +                    newval = next(it)   # fetch a new value and
    +                except StopIteration:
    +                    return
    +                for d in deques:        # load it to all the deques
    +                    d.append(newval)
    +            yield mydeque.popleft()
    +    return tuple(gen(d) for d in deques)
    +
    +
    +

    Once tee() has made a split, the original iterable should not be +used anywhere else; otherwise, the iterable could get advanced without +the tee objects being informed.

    +

    This itertool may require significant auxiliary storage (depending on how +much temporary data needs to be stored). In general, if one iterator uses +most or all of the data before another iterator starts, it is faster to use +list() instead of tee().

    +
    + +
    +
    +itertools.zip_longest(*iterables, fillvalue=None)
    +

    Make an iterator that aggregates elements from each of the iterables. If the +iterables are of uneven length, missing values are filled-in with fillvalue. +Iteration continues until the longest iterable is exhausted. Roughly equivalent to:

    +
    def zip_longest(*args, fillvalue=None):
    +    # zip_longest('ABCD', 'xy', fillvalue='-') --> Ax By C- D-
    +    iterators = [iter(it) for it in args]
    +    num_active = len(iterators)
    +    if not num_active:
    +        return
    +    while True:
    +        values = []
    +        for i, it in enumerate(iterators):
    +            try:
    +                value = next(it)
    +            except StopIteration:
    +                num_active -= 1
    +                if not num_active:
    +                    return
    +                iterators[i] = repeat(fillvalue)
    +                value = fillvalue
    +            values.append(value)
    +        yield tuple(values)
    +
    +
    +

    If one of the iterables is potentially infinite, then the zip_longest() +function should be wrapped with something that limits the number of calls +(for example islice() or takewhile()). If not specified, +fillvalue defaults to None.

    +
    + +
    +
    +

    Itertools Recipes

    +

    This section shows recipes for creating an extended toolset using the existing +itertools as building blocks.

    +

    The extended tools offer the same high performance as the underlying toolset. +The superior memory performance is kept by processing elements one at a time +rather than bringing the whole iterable into memory all at once. Code volume is +kept small by linking the tools together in a functional style which helps +eliminate temporary variables. High speed is retained by preferring +“vectorized” building blocks over the use of for-loops and generators +which incur interpreter overhead.

    +
    def take(n, iterable):
    +    "Return first n items of the iterable as a list"
    +    return list(islice(iterable, n))
    +
    +def prepend(value, iterator):
    +    "Prepend a single value in front of an iterator"
    +    # prepend(1, [2, 3, 4]) -> 1 2 3 4
    +    return chain([value], iterator)
    +
    +def tabulate(function, start=0):
    +    "Return function(0), function(1), ..."
    +    return map(function, count(start))
    +
    +def tail(n, iterable):
    +    "Return an iterator over the last n items"
    +    # tail(3, 'ABCDEFG') --> E F G
    +    return iter(collections.deque(iterable, maxlen=n))
    +
    +def consume(iterator, n=None):
    +    "Advance the iterator n-steps ahead. If n is None, consume entirely."
    +    # Use functions that consume iterators at C speed.
    +    if n is None:
    +        # feed the entire iterator into a zero-length deque
    +        collections.deque(iterator, maxlen=0)
    +    else:
    +        # advance to the empty slice starting at position n
    +        next(islice(iterator, n, n), None)
    +
    +def nth(iterable, n, default=None):
    +    "Returns the nth item or a default value"
    +    return next(islice(iterable, n, None), default)
    +
    +def all_equal(iterable):
    +    "Returns True if all the elements are equal to each other"
    +    g = groupby(iterable)
    +    return next(g, True) and not next(g, False)
    +
    +def quantify(iterable, pred=bool):
    +    "Count how many times the predicate is true"
    +    return sum(map(pred, iterable))
    +
    +def padnone(iterable):
    +    """Returns the sequence elements and then returns None indefinitely.
    +
    +    Useful for emulating the behavior of the built-in map() function.
    +    """
    +    return chain(iterable, repeat(None))
    +
    +def ncycles(iterable, n):
    +    "Returns the sequence elements n times"
    +    return chain.from_iterable(repeat(tuple(iterable), n))
    +
    +def dotproduct(vec1, vec2):
    +    return sum(map(operator.mul, vec1, vec2))
    +
    +def flatten(listOfLists):
    +    "Flatten one level of nesting"
    +    return chain.from_iterable(listOfLists)
    +
    +def repeatfunc(func, times=None, *args):
    +    """Repeat calls to func with specified arguments.
    +
    +    Example:  repeatfunc(random.random)
    +    """
    +    if times is None:
    +        return starmap(func, repeat(args))
    +    return starmap(func, repeat(args, times))
    +
    +def pairwise(iterable):
    +    "s -> (s0,s1), (s1,s2), (s2, s3), ..."
    +    a, b = tee(iterable)
    +    next(b, None)
    +    return zip(a, b)
    +
    +def grouper(iterable, n, fillvalue=None):
    +    "Collect data into fixed-length chunks or blocks"
    +    # grouper('ABCDEFG', 3, 'x') --> ABC DEF Gxx"
    +    args = [iter(iterable)] * n
    +    return zip_longest(*args, fillvalue=fillvalue)
    +
    +def roundrobin(*iterables):
    +    "roundrobin('ABC', 'D', 'EF') --> A D E B F C"
    +    # Recipe credited to George Sakkis
    +    num_active = len(iterables)
    +    nexts = cycle(iter(it).__next__ for it in iterables)
    +    while num_active:
    +        try:
    +            for next in nexts:
    +                yield next()
    +        except StopIteration:
    +            # Remove the iterator we just exhausted from the cycle.
    +            num_active -= 1
    +            nexts = cycle(islice(nexts, num_active))
    +
    +def partition(pred, iterable):
    +    'Use a predicate to partition entries into false entries and true entries'
    +    # partition(is_odd, range(10)) --> 0 2 4 6 8   and  1 3 5 7 9
    +    t1, t2 = tee(iterable)
    +    return filterfalse(pred, t1), filter(pred, t2)
    +
    +def powerset(iterable):
    +    "powerset([1,2,3]) --> () (1,) (2,) (3,) (1,2) (1,3) (2,3) (1,2,3)"
    +    s = list(iterable)
    +    return chain.from_iterable(combinations(s, r) for r in range(len(s)+1))
    +
    +def unique_everseen(iterable, key=None):
    +    "List unique elements, preserving order. Remember all elements ever seen."
    +    # unique_everseen('AAAABBBCCDAABBB') --> A B C D
    +    # unique_everseen('ABBCcAD', str.lower) --> A B C D
    +    seen = set()
    +    seen_add = seen.add
    +    if key is None:
    +        for element in filterfalse(seen.__contains__, iterable):
    +            seen_add(element)
    +            yield element
    +    else:
    +        for element in iterable:
    +            k = key(element)
    +            if k not in seen:
    +                seen_add(k)
    +                yield element
    +
    +def unique_justseen(iterable, key=None):
    +    "List unique elements, preserving order. Remember only the element just seen."
    +    # unique_justseen('AAAABBBCCDAABBB') --> A B C D A B
    +    # unique_justseen('ABBCcAD', str.lower) --> A B C A D
    +    return map(next, map(itemgetter(1), groupby(iterable, key)))
    +
    +def iter_except(func, exception, first=None):
    +    """ Call a function repeatedly until an exception is raised.
    +
    +    Converts a call-until-exception interface to an iterator interface.
    +    Like builtins.iter(func, sentinel) but uses an exception instead
    +    of a sentinel to end the loop.
    +
    +    Examples:
    +        iter_except(functools.partial(heappop, h), IndexError)   # priority queue iterator
    +        iter_except(d.popitem, KeyError)                         # non-blocking dict iterator
    +        iter_except(d.popleft, IndexError)                       # non-blocking deque iterator
    +        iter_except(q.get_nowait, Queue.Empty)                   # loop over a producer Queue
    +        iter_except(s.pop, KeyError)                             # non-blocking set iterator
    +
    +    """
    +    try:
    +        if first is not None:
    +            yield first()            # For database APIs needing an initial cast to db.first()
    +        while True:
    +            yield func()
    +    except exception:
    +        pass
    +
    +def first_true(iterable, default=False, pred=None):
    +    """Returns the first true value in the iterable.
    +
    +    If no true value is found, returns *default*
    +
    +    If *pred* is not None, returns the first item
    +    for which pred(item) is true.
    +
    +    """
    +    # first_true([a,b,c], x) --> a or b or c or x
    +    # first_true([a,b], x, f) --> a if f(a) else b if f(b) else x
    +    return next(filter(pred, iterable), default)
    +
    +def random_product(*args, repeat=1):
    +    "Random selection from itertools.product(*args, **kwds)"
    +    pools = [tuple(pool) for pool in args] * repeat
    +    return tuple(random.choice(pool) for pool in pools)
    +
    +def random_permutation(iterable, r=None):
    +    "Random selection from itertools.permutations(iterable, r)"
    +    pool = tuple(iterable)
    +    r = len(pool) if r is None else r
    +    return tuple(random.sample(pool, r))
    +
    +def random_combination(iterable, r):
    +    "Random selection from itertools.combinations(iterable, r)"
    +    pool = tuple(iterable)
    +    n = len(pool)
    +    indices = sorted(random.sample(range(n), r))
    +    return tuple(pool[i] for i in indices)
    +
    +def random_combination_with_replacement(iterable, r):
    +    "Random selection from itertools.combinations_with_replacement(iterable, r)"
    +    pool = tuple(iterable)
    +    n = len(pool)
    +    indices = sorted(random.randrange(n) for i in range(r))
    +    return tuple(pool[i] for i in indices)
    +
    +def nth_combination(iterable, r, index):
    +    'Equivalent to list(combinations(iterable, r))[index]'
    +    pool = tuple(iterable)
    +    n = len(pool)
    +    if r < 0 or r > n:
    +        raise ValueError
    +    c = 1
    +    k = min(r, n-r)
    +    for i in range(1, k+1):
    +        c = c * (n - k + i) // i
    +    if index < 0:
    +        index += c
    +    if index < 0 or index >= c:
    +        raise IndexError
    +    result = []
    +    while r:
    +        c, n, r = c*r//n, n-1, r-1
    +        while index >= c:
    +            index -= c
    +            c, n = c*(n-r)//n, n-1
    +        result.append(pool[-1-n])
    +    return tuple(result)
    +
    +
    +

    Note, many of the above recipes can be optimized by replacing global lookups +with local variables defined as default values. For example, the +dotproduct recipe can be written as:

    +
    def dotproduct(vec1, vec2, sum=sum, map=map, mul=operator.mul):
    +    return sum(map(mul, vec1, vec2))
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/json.html b/python-3.7.4-docs-html/library/json.html new file mode 100644 index 0000000..1482ce6 --- /dev/null +++ b/python-3.7.4-docs-html/library/json.html @@ -0,0 +1,908 @@ + + + + + + + json — JSON encoder and decoder — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    json — JSON encoder and decoder

    +

    Source code: Lib/json/__init__.py

    +
    +

    JSON (JavaScript Object Notation), specified by +RFC 7159 (which obsoletes RFC 4627) and by +ECMA-404, +is a lightweight data interchange format inspired by +JavaScript object literal syntax +(although it is not a strict subset of JavaScript 1 ).

    +

    json exposes an API familiar to users of the standard library +marshal and pickle modules.

    +

    Encoding basic Python object hierarchies:

    +
    >>> import json
    +>>> json.dumps(['foo', {'bar': ('baz', None, 1.0, 2)}])
    +'["foo", {"bar": ["baz", null, 1.0, 2]}]'
    +>>> print(json.dumps("\"foo\bar"))
    +"\"foo\bar"
    +>>> print(json.dumps('\u1234'))
    +"\u1234"
    +>>> print(json.dumps('\\'))
    +"\\"
    +>>> print(json.dumps({"c": 0, "b": 0, "a": 0}, sort_keys=True))
    +{"a": 0, "b": 0, "c": 0}
    +>>> from io import StringIO
    +>>> io = StringIO()
    +>>> json.dump(['streaming API'], io)
    +>>> io.getvalue()
    +'["streaming API"]'
    +
    +
    +

    Compact encoding:

    +
    >>> import json
    +>>> json.dumps([1, 2, 3, {'4': 5, '6': 7}], separators=(',', ':'))
    +'[1,2,3,{"4":5,"6":7}]'
    +
    +
    +

    Pretty printing:

    +
    >>> import json
    +>>> print(json.dumps({'4': 5, '6': 7}, sort_keys=True, indent=4))
    +{
    +    "4": 5,
    +    "6": 7
    +}
    +
    +
    +

    Decoding JSON:

    +
    >>> import json
    +>>> json.loads('["foo", {"bar":["baz", null, 1.0, 2]}]')
    +['foo', {'bar': ['baz', None, 1.0, 2]}]
    +>>> json.loads('"\\"foo\\bar"')
    +'"foo\x08ar'
    +>>> from io import StringIO
    +>>> io = StringIO('["streaming API"]')
    +>>> json.load(io)
    +['streaming API']
    +
    +
    +

    Specializing JSON object decoding:

    +
    >>> import json
    +>>> def as_complex(dct):
    +...     if '__complex__' in dct:
    +...         return complex(dct['real'], dct['imag'])
    +...     return dct
    +...
    +>>> json.loads('{"__complex__": true, "real": 1, "imag": 2}',
    +...     object_hook=as_complex)
    +(1+2j)
    +>>> import decimal
    +>>> json.loads('1.1', parse_float=decimal.Decimal)
    +Decimal('1.1')
    +
    +
    +

    Extending JSONEncoder:

    +
    >>> import json
    +>>> class ComplexEncoder(json.JSONEncoder):
    +...     def default(self, obj):
    +...         if isinstance(obj, complex):
    +...             return [obj.real, obj.imag]
    +...         # Let the base class default method raise the TypeError
    +...         return json.JSONEncoder.default(self, obj)
    +...
    +>>> json.dumps(2 + 1j, cls=ComplexEncoder)
    +'[2.0, 1.0]'
    +>>> ComplexEncoder().encode(2 + 1j)
    +'[2.0, 1.0]'
    +>>> list(ComplexEncoder().iterencode(2 + 1j))
    +['[2.0', ', 1.0', ']']
    +
    +
    +

    Using json.tool from the shell to validate and pretty-print:

    +
    $ echo '{"json":"obj"}' | python -m json.tool
    +{
    +    "json": "obj"
    +}
    +$ echo '{1.2:3.4}' | python -m json.tool
    +Expecting property name enclosed in double quotes: line 1 column 2 (char 1)
    +
    +
    +

    See Command Line Interface for detailed documentation.

    +
    +

    Note

    +

    JSON is a subset of YAML 1.2. The JSON produced by +this module’s default settings (in particular, the default separators +value) is also a subset of YAML 1.0 and 1.1. This module can thus also be +used as a YAML serializer.

    +
    +
    +

    Basic Usage

    +
    +
    +json.dump(obj, fp, *, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False, **kw)
    +

    Serialize obj as a JSON formatted stream to fp (a .write()-supporting +file-like object) using this conversion table.

    +

    If skipkeys is true (default: False), then dict keys that are not +of a basic type (str, int, float, bool, +None) will be skipped instead of raising a TypeError.

    +

    The json module always produces str objects, not +bytes objects. Therefore, fp.write() must support str +input.

    +

    If ensure_ascii is true (the default), the output is guaranteed to +have all incoming non-ASCII characters escaped. If ensure_ascii is +false, these characters will be output as-is.

    +

    If check_circular is false (default: True), then the circular +reference check for container types will be skipped and a circular reference +will result in an OverflowError (or worse).

    +

    If allow_nan is false (default: True), then it will be a +ValueError to serialize out of range float values (nan, +inf, -inf) in strict compliance of the JSON specification. +If allow_nan is true, their JavaScript equivalents (NaN, +Infinity, -Infinity) will be used.

    +

    If indent is a non-negative integer or string, then JSON array elements and +object members will be pretty-printed with that indent level. An indent level +of 0, negative, or "" will only insert newlines. None (the default) +selects the most compact representation. Using a positive integer indent +indents that many spaces per level. If indent is a string (such as "\t"), +that string is used to indent each level.

    +
    +

    Changed in version 3.2: Allow strings for indent in addition to integers.

    +
    +

    If specified, separators should be an (item_separator, key_separator) +tuple. The default is (', ', ': ') if indent is None and +(',', ': ') otherwise. To get the most compact JSON representation, +you should specify (',', ':') to eliminate whitespace.

    +
    +

    Changed in version 3.4: Use (',', ': ') as default if indent is not None.

    +
    +

    If specified, default should be a function that gets called for objects that +can’t otherwise be serialized. It should return a JSON encodable version of +the object or raise a TypeError. If not specified, TypeError +is raised.

    +

    If sort_keys is true (default: False), then the output of +dictionaries will be sorted by key.

    +

    To use a custom JSONEncoder subclass (e.g. one that overrides the +default() method to serialize additional types), specify it with the +cls kwarg; otherwise JSONEncoder is used.

    +
    +

    Changed in version 3.6: All optional parameters are now keyword-only.

    +
    +
    +

    Note

    +

    Unlike pickle and marshal, JSON is not a framed protocol, +so trying to serialize multiple objects with repeated calls to +dump() using the same fp will result in an invalid JSON file.

    +
    +
    + +
    +
    +json.dumps(obj, *, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False, **kw)
    +

    Serialize obj to a JSON formatted str using this conversion +table. The arguments have the same meaning as in +dump().

    +
    +

    Note

    +

    Keys in key/value pairs of JSON are always of the type str. When +a dictionary is converted into JSON, all the keys of the dictionary are +coerced to strings. As a result of this, if a dictionary is converted +into JSON and then back into a dictionary, the dictionary may not equal +the original one. That is, loads(dumps(x)) != x if x has non-string +keys.

    +
    +
    + +
    +
    +json.load(fp, *, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw)
    +

    Deserialize fp (a .read()-supporting text file or +binary file containing a JSON document) to a Python object using +this conversion table.

    +

    object_hook is an optional function that will be called with the result of +any object literal decoded (a dict). The return value of +object_hook will be used instead of the dict. This feature can be used +to implement custom decoders (e.g. JSON-RPC +class hinting).

    +

    object_pairs_hook is an optional function that will be called with the +result of any object literal decoded with an ordered list of pairs. The +return value of object_pairs_hook will be used instead of the +dict. This feature can be used to implement custom decoders. +If object_hook is also defined, the object_pairs_hook takes priority.

    +
    +

    Changed in version 3.1: Added support for object_pairs_hook.

    +
    +

    parse_float, if specified, will be called with the string of every JSON +float to be decoded. By default, this is equivalent to float(num_str). +This can be used to use another datatype or parser for JSON floats +(e.g. decimal.Decimal).

    +

    parse_int, if specified, will be called with the string of every JSON int +to be decoded. By default, this is equivalent to int(num_str). This can +be used to use another datatype or parser for JSON integers +(e.g. float).

    +

    parse_constant, if specified, will be called with one of the following +strings: '-Infinity', 'Infinity', 'NaN'. +This can be used to raise an exception if invalid JSON numbers +are encountered.

    +
    +

    Changed in version 3.1: parse_constant doesn’t get called on ‘null’, ‘true’, ‘false’ anymore.

    +
    +

    To use a custom JSONDecoder subclass, specify it with the cls +kwarg; otherwise JSONDecoder is used. Additional keyword arguments +will be passed to the constructor of the class.

    +

    If the data being deserialized is not a valid JSON document, a +JSONDecodeError will be raised.

    +
    +

    Changed in version 3.6: All optional parameters are now keyword-only.

    +
    +
    +

    Changed in version 3.6: fp can now be a binary file. The input encoding should be +UTF-8, UTF-16 or UTF-32.

    +
    +
    + +
    +
    +json.loads(s, *, encoding=None, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw)
    +

    Deserialize s (a str, bytes or bytearray +instance containing a JSON document) to a Python object using this +conversion table.

    +

    The other arguments have the same meaning as in load(), except +encoding which is ignored and deprecated.

    +

    If the data being deserialized is not a valid JSON document, a +JSONDecodeError will be raised.

    +
    +

    Changed in version 3.6: s can now be of type bytes or bytearray. The +input encoding should be UTF-8, UTF-16 or UTF-32.

    +
    +
    + +
    +
    +

    Encoders and Decoders

    +
    +
    +class json.JSONDecoder(*, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, strict=True, object_pairs_hook=None)
    +

    Simple JSON decoder.

    +

    Performs the following translations in decoding by default:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    JSON

    Python

    object

    dict

    array

    list

    string

    str

    number (int)

    int

    number (real)

    float

    true

    True

    false

    False

    null

    None

    +

    It also understands NaN, Infinity, and -Infinity as their +corresponding float values, which is outside the JSON spec.

    +

    object_hook, if specified, will be called with the result of every JSON +object decoded and its return value will be used in place of the given +dict. This can be used to provide custom deserializations (e.g. to +support JSON-RPC class hinting).

    +

    object_pairs_hook, if specified will be called with the result of every +JSON object decoded with an ordered list of pairs. The return value of +object_pairs_hook will be used instead of the dict. This +feature can be used to implement custom decoders. If object_hook is also +defined, the object_pairs_hook takes priority.

    +
    +

    Changed in version 3.1: Added support for object_pairs_hook.

    +
    +

    parse_float, if specified, will be called with the string of every JSON +float to be decoded. By default, this is equivalent to float(num_str). +This can be used to use another datatype or parser for JSON floats +(e.g. decimal.Decimal).

    +

    parse_int, if specified, will be called with the string of every JSON int +to be decoded. By default, this is equivalent to int(num_str). This can +be used to use another datatype or parser for JSON integers +(e.g. float).

    +

    parse_constant, if specified, will be called with one of the following +strings: '-Infinity', 'Infinity', 'NaN'. +This can be used to raise an exception if invalid JSON numbers +are encountered.

    +

    If strict is false (True is the default), then control characters +will be allowed inside strings. Control characters in this context are +those with character codes in the 0–31 range, including '\t' (tab), +'\n', '\r' and '\0'.

    +

    If the data being deserialized is not a valid JSON document, a +JSONDecodeError will be raised.

    +
    +

    Changed in version 3.6: All parameters are now keyword-only.

    +
    +
    +
    +decode(s)
    +

    Return the Python representation of s (a str instance +containing a JSON document).

    +

    JSONDecodeError will be raised if the given JSON document is not +valid.

    +
    + +
    +
    +raw_decode(s)
    +

    Decode a JSON document from s (a str beginning with a +JSON document) and return a 2-tuple of the Python representation +and the index in s where the document ended.

    +

    This can be used to decode a JSON document from a string that may have +extraneous data at the end.

    +
    + +
    + +
    +
    +class json.JSONEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)
    +

    Extensible JSON encoder for Python data structures.

    +

    Supports the following objects and types by default:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Python

    JSON

    dict

    object

    list, tuple

    array

    str

    string

    int, float, int- & float-derived Enums

    number

    True

    true

    False

    false

    None

    null

    +
    +

    Changed in version 3.4: Added support for int- and float-derived Enum classes.

    +
    +

    To extend this to recognize other objects, subclass and implement a +default() method with another method that returns a serializable object +for o if possible, otherwise it should call the superclass implementation +(to raise TypeError).

    +

    If skipkeys is false (the default), then it is a TypeError to +attempt encoding of keys that are not str, int, +float or None. If skipkeys is true, such items are simply +skipped.

    +

    If ensure_ascii is true (the default), the output is guaranteed to +have all incoming non-ASCII characters escaped. If ensure_ascii is +false, these characters will be output as-is.

    +

    If check_circular is true (the default), then lists, dicts, and custom +encoded objects will be checked for circular references during encoding to +prevent an infinite recursion (which would cause an OverflowError). +Otherwise, no such check takes place.

    +

    If allow_nan is true (the default), then NaN, Infinity, and +-Infinity will be encoded as such. This behavior is not JSON +specification compliant, but is consistent with most JavaScript based +encoders and decoders. Otherwise, it will be a ValueError to encode +such floats.

    +

    If sort_keys is true (default: False), then the output of dictionaries +will be sorted by key; this is useful for regression tests to ensure that +JSON serializations can be compared on a day-to-day basis.

    +

    If indent is a non-negative integer or string, then JSON array elements and +object members will be pretty-printed with that indent level. An indent level +of 0, negative, or "" will only insert newlines. None (the default) +selects the most compact representation. Using a positive integer indent +indents that many spaces per level. If indent is a string (such as "\t"), +that string is used to indent each level.

    +
    +

    Changed in version 3.2: Allow strings for indent in addition to integers.

    +
    +

    If specified, separators should be an (item_separator, key_separator) +tuple. The default is (', ', ': ') if indent is None and +(',', ': ') otherwise. To get the most compact JSON representation, +you should specify (',', ':') to eliminate whitespace.

    +
    +

    Changed in version 3.4: Use (',', ': ') as default if indent is not None.

    +
    +

    If specified, default should be a function that gets called for objects that +can’t otherwise be serialized. It should return a JSON encodable version of +the object or raise a TypeError. If not specified, TypeError +is raised.

    +
    +

    Changed in version 3.6: All parameters are now keyword-only.

    +
    +
    +
    +default(o)
    +

    Implement this method in a subclass such that it returns a serializable +object for o, or calls the base implementation (to raise a +TypeError).

    +

    For example, to support arbitrary iterators, you could implement default +like this:

    +
    def default(self, o):
    +   try:
    +       iterable = iter(o)
    +   except TypeError:
    +       pass
    +   else:
    +       return list(iterable)
    +   # Let the base class default method raise the TypeError
    +   return json.JSONEncoder.default(self, o)
    +
    +
    +
    + +
    +
    +encode(o)
    +

    Return a JSON string representation of a Python data structure, o. For +example:

    +
    >>> json.JSONEncoder().encode({"foo": ["bar", "baz"]})
    +'{"foo": ["bar", "baz"]}'
    +
    +
    +
    + +
    +
    +iterencode(o)
    +

    Encode the given object, o, and yield each string representation as +available. For example:

    +
    for chunk in json.JSONEncoder().iterencode(bigobject):
    +    mysocket.write(chunk)
    +
    +
    +
    + +
    + +
    +
    +

    Exceptions

    +
    +
    +exception json.JSONDecodeError(msg, doc, pos)
    +

    Subclass of ValueError with the following additional attributes:

    +
    +
    +msg
    +

    The unformatted error message.

    +
    + +
    +
    +doc
    +

    The JSON document being parsed.

    +
    + +
    +
    +pos
    +

    The start index of doc where parsing failed.

    +
    + +
    +
    +lineno
    +

    The line corresponding to pos.

    +
    + +
    +
    +colno
    +

    The column corresponding to pos.

    +
    + +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +

    Standard Compliance and Interoperability

    +

    The JSON format is specified by RFC 7159 and by +ECMA-404. +This section details this module’s level of compliance with the RFC. +For simplicity, JSONEncoder and JSONDecoder subclasses, and +parameters other than those explicitly mentioned, are not considered.

    +

    This module does not comply with the RFC in a strict fashion, implementing some +extensions that are valid JavaScript but not valid JSON. In particular:

    +
      +
    • Infinite and NaN number values are accepted and output;

    • +
    • Repeated names within an object are accepted, and only the value of the last +name-value pair is used.

    • +
    +

    Since the RFC permits RFC-compliant parsers to accept input texts that are not +RFC-compliant, this module’s deserializer is technically RFC-compliant under +default settings.

    +
    +

    Character Encodings

    +

    The RFC requires that JSON be represented using either UTF-8, UTF-16, or +UTF-32, with UTF-8 being the recommended default for maximum interoperability.

    +

    As permitted, though not required, by the RFC, this module’s serializer sets +ensure_ascii=True by default, thus escaping the output so that the resulting +strings only contain ASCII characters.

    +

    Other than the ensure_ascii parameter, this module is defined strictly in +terms of conversion between Python objects and +Unicode strings, and thus does not otherwise directly address +the issue of character encodings.

    +

    The RFC prohibits adding a byte order mark (BOM) to the start of a JSON text, +and this module’s serializer does not add a BOM to its output. +The RFC permits, but does not require, JSON deserializers to ignore an initial +BOM in their input. This module’s deserializer raises a ValueError +when an initial BOM is present.

    +

    The RFC does not explicitly forbid JSON strings which contain byte sequences +that don’t correspond to valid Unicode characters (e.g. unpaired UTF-16 +surrogates), but it does note that they may cause interoperability problems. +By default, this module accepts and outputs (when present in the original +str) code points for such sequences.

    +
    +
    +

    Infinite and NaN Number Values

    +

    The RFC does not permit the representation of infinite or NaN number values. +Despite that, by default, this module accepts and outputs Infinity, +-Infinity, and NaN as if they were valid JSON number literal values:

    +
    >>> # Neither of these calls raises an exception, but the results are not valid JSON
    +>>> json.dumps(float('-inf'))
    +'-Infinity'
    +>>> json.dumps(float('nan'))
    +'NaN'
    +>>> # Same when deserializing
    +>>> json.loads('-Infinity')
    +-inf
    +>>> json.loads('NaN')
    +nan
    +
    +
    +

    In the serializer, the allow_nan parameter can be used to alter this +behavior. In the deserializer, the parse_constant parameter can be used to +alter this behavior.

    +
    +
    +

    Repeated Names Within an Object

    +

    The RFC specifies that the names within a JSON object should be unique, but +does not mandate how repeated names in JSON objects should be handled. By +default, this module does not raise an exception; instead, it ignores all but +the last name-value pair for a given name:

    +
    >>> weird_json = '{"x": 1, "x": 2, "x": 3}'
    +>>> json.loads(weird_json)
    +{'x': 3}
    +
    +
    +

    The object_pairs_hook parameter can be used to alter this behavior.

    +
    +
    +

    Top-level Non-Object, Non-Array Values

    +

    The old version of JSON specified by the obsolete RFC 4627 required that +the top-level value of a JSON text must be either a JSON object or array +(Python dict or list), and could not be a JSON null, +boolean, number, or string value. RFC 7159 removed that restriction, and +this module does not and has never implemented that restriction in either its +serializer or its deserializer.

    +

    Regardless, for maximum interoperability, you may wish to voluntarily adhere +to the restriction yourself.

    +
    +
    +

    Implementation Limitations

    +

    Some JSON deserializer implementations may set limits on:

    +
      +
    • the size of accepted JSON texts

    • +
    • the maximum level of nesting of JSON objects and arrays

    • +
    • the range and precision of JSON numbers

    • +
    • the content and maximum length of JSON strings

    • +
    +

    This module does not impose any such limits beyond those of the relevant +Python datatypes themselves or the Python interpreter itself.

    +

    When serializing to JSON, beware any such limitations in applications that may +consume your JSON. In particular, it is common for JSON numbers to be +deserialized into IEEE 754 double precision numbers and thus subject to that +representation’s range and precision limitations. This is especially relevant +when serializing Python int values of extremely large magnitude, or +when serializing instances of “exotic” numerical types such as +decimal.Decimal.

    +
    +
    +
    +

    Command Line Interface

    +

    Source code: Lib/json/tool.py

    +
    +

    The json.tool module provides a simple command line interface to validate +and pretty-print JSON objects.

    +

    If the optional infile and outfile arguments are not +specified, sys.stdin and sys.stdout will be used respectively:

    +
    $ echo '{"json": "obj"}' | python -m json.tool
    +{
    +    "json": "obj"
    +}
    +$ echo '{1.2:3.4}' | python -m json.tool
    +Expecting property name enclosed in double quotes: line 1 column 2 (char 1)
    +
    +
    +
    +

    Changed in version 3.5: The output is now in the same order as the input. Use the +--sort-keys option to sort the output of dictionaries +alphabetically by key.

    +
    +
    +

    Command line options

    +
    +
    +infile
    +

    The JSON file to be validated or pretty-printed:

    +
    $ python -m json.tool mp_films.json
    +[
    +    {
    +        "title": "And Now for Something Completely Different",
    +        "year": 1971
    +    },
    +    {
    +        "title": "Monty Python and the Holy Grail",
    +        "year": 1975
    +    }
    +]
    +
    +
    +

    If infile is not specified, read from sys.stdin.

    +
    + +
    +
    +outfile
    +

    Write the output of the infile to the given outfile. Otherwise, write it +to sys.stdout.

    +
    + +
    +
    +--sort-keys
    +

    Sort the output of dictionaries alphabetically by key.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +-h, --help
    +

    Show the help message.

    +
    + +

    Footnotes

    +
    +
    1
    +

    As noted in the errata for RFC 7159, +JSON permits literal U+2028 (LINE SEPARATOR) and +U+2029 (PARAGRAPH SEPARATOR) characters in strings, whereas JavaScript +(as of ECMAScript Edition 5.1) does not.

    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/keyword.html b/python-3.7.4-docs-html/library/keyword.html new file mode 100644 index 0000000..23c0b72 --- /dev/null +++ b/python-3.7.4-docs-html/library/keyword.html @@ -0,0 +1,200 @@ + + + + + + + keyword — Testing for Python keywords — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    keyword — Testing for Python keywords

    +

    Source code: Lib/keyword.py

    +
    +

    This module allows a Python program to determine if a string is a keyword.

    +
    +
    +keyword.iskeyword(s)
    +

    Return true if s is a Python keyword.

    +
    + +
    +
    +keyword.kwlist
    +

    Sequence containing all the keywords defined for the interpreter. If any +keywords are defined to only be active when particular __future__ +statements are in effect, these will be included as well.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/language.html b/python-3.7.4-docs-html/library/language.html new file mode 100644 index 0000000..f7ae501 --- /dev/null +++ b/python-3.7.4-docs-html/library/language.html @@ -0,0 +1,245 @@ + + + + + + + Python Language Services — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/linecache.html b/python-3.7.4-docs-html/library/linecache.html new file mode 100644 index 0000000..1e8505d --- /dev/null +++ b/python-3.7.4-docs-html/library/linecache.html @@ -0,0 +1,238 @@ + + + + + + + linecache — Random access to text lines — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    linecache — Random access to text lines

    +

    Source code: Lib/linecache.py

    +
    +

    The linecache module allows one to get any line from a Python source file, while +attempting to optimize internally, using a cache, the common case where many +lines are read from a single file. This is used by the traceback module +to retrieve source lines for inclusion in the formatted traceback.

    +

    The tokenize.open() function is used to open files. This +function uses tokenize.detect_encoding() to get the encoding of the +file; in the absence of an encoding token, the file encoding defaults to UTF-8.

    +

    The linecache module defines the following functions:

    +
    +
    +linecache.getline(filename, lineno, module_globals=None)
    +

    Get line lineno from file named filename. This function will never raise an +exception — it will return '' on errors (the terminating newline character +will be included for lines that are found).

    +

    If a file named filename is not found, the function will look for it in the +module search path, sys.path, after first checking for a PEP 302 +__loader__ in module_globals, in case the module was imported from a +zipfile or other non-filesystem import source.

    +
    + +
    +
    +linecache.clearcache()
    +

    Clear the cache. Use this function if you no longer need lines from files +previously read using getline().

    +
    + +
    +
    +linecache.checkcache(filename=None)
    +

    Check the cache for validity. Use this function if files in the cache may have +changed on disk, and you require the updated version. If filename is omitted, +it will check all the entries in the cache.

    +
    + +
    +
    +linecache.lazycache(filename, module_globals)
    +

    Capture enough detail about a non-file-based module to permit getting its +lines later via getline() even if module_globals is None in the later +call. This avoids doing I/O until a line is actually needed, without having +to carry the module globals around indefinitely.

    +
    +

    New in version 3.5.

    +
    +
    + +

    Example:

    +
    >>> import linecache
    +>>> linecache.getline(linecache.__file__, 8)
    +'import sys\n'
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/locale.html b/python-3.7.4-docs-html/library/locale.html new file mode 100644 index 0000000..d8c0c31 --- /dev/null +++ b/python-3.7.4-docs-html/library/locale.html @@ -0,0 +1,862 @@ + + + + + + + locale — Internationalization services — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    locale — Internationalization services

    +

    Source code: Lib/locale.py

    +
    +

    The locale module opens access to the POSIX locale database and +functionality. The POSIX locale mechanism allows programmers to deal with +certain cultural issues in an application, without requiring the programmer to +know all the specifics of each country where the software is executed.

    +

    The locale module is implemented on top of the _locale module, +which in turn uses an ANSI C locale implementation if available.

    +

    The locale module defines the following exception and functions:

    +
    +
    +exception locale.Error
    +

    Exception raised when the locale passed to setlocale() is not +recognized.

    +
    + +
    +
    +locale.setlocale(category, locale=None)
    +

    If locale is given and not None, setlocale() modifies the locale +setting for the category. The available categories are listed in the data +description below. locale may be a string, or an iterable of two strings +(language code and encoding). If it’s an iterable, it’s converted to a locale +name using the locale aliasing engine. An empty string specifies the user’s +default settings. If the modification of the locale fails, the exception +Error is raised. If successful, the new locale setting is returned.

    +

    If locale is omitted or None, the current setting for category is +returned.

    +

    setlocale() is not thread-safe on most systems. Applications typically +start with a call of

    +
    import locale
    +locale.setlocale(locale.LC_ALL, '')
    +
    +
    +

    This sets the locale for all categories to the user’s default setting (typically +specified in the LANG environment variable). If the locale is not +changed thereafter, using multithreading should not cause problems.

    +
    + +
    +
    +locale.localeconv()
    +

    Returns the database of the local conventions as a dictionary. This dictionary +has the following strings as keys:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Category

    Key

    Meaning

    LC_NUMERIC

    'decimal_point'

    Decimal point character.

    'grouping'

    Sequence of numbers specifying +which relative positions the +'thousands_sep' is +expected. If the sequence is +terminated with +CHAR_MAX, no further +grouping is performed. If the +sequence terminates with a +0, the last group size is +repeatedly used.

    'thousands_sep'

    Character used between groups.

    LC_MONETARY

    'int_curr_symbol'

    International currency symbol.

    'currency_symbol'

    Local currency symbol.

    'p_cs_precedes/n_cs_precedes'

    Whether the currency symbol +precedes the value (for +positive resp. negative +values).

    'p_sep_by_space/n_sep_by_space'

    Whether the currency symbol is +separated from the value by a +space (for positive resp. +negative values).

    'mon_decimal_point'

    Decimal point used for +monetary values.

    'frac_digits'

    Number of fractional digits +used in local formatting of +monetary values.

    'int_frac_digits'

    Number of fractional digits +used in international +formatting of monetary values.

    'mon_thousands_sep'

    Group separator used for +monetary values.

    'mon_grouping'

    Equivalent to 'grouping', +used for monetary values.

    'positive_sign'

    Symbol used to annotate a +positive monetary value.

    'negative_sign'

    Symbol used to annotate a +negative monetary value.

    'p_sign_posn/n_sign_posn'

    The position of the sign (for +positive resp. negative +values), see below.

    +

    All numeric values can be set to CHAR_MAX to indicate that there is no +value specified in this locale.

    +

    The possible values for 'p_sign_posn' and 'n_sign_posn' are given below.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + +

    Value

    Explanation

    0

    Currency and value are surrounded by +parentheses.

    1

    The sign should precede the value and +currency symbol.

    2

    The sign should follow the value and +currency symbol.

    3

    The sign should immediately precede the +value.

    4

    The sign should immediately follow the +value.

    CHAR_MAX

    Nothing is specified in this locale.

    +

    The function sets temporarily the LC_CTYPE locale to the LC_NUMERIC +locale or the LC_MONETARY locale if locales are different and numeric or +monetary strings are non-ASCII. This temporary change affects other threads.

    +
    +

    Changed in version 3.7: The function now sets temporarily the LC_CTYPE locale to the +LC_NUMERIC locale in some cases.

    +
    +
    + +
    +
    +locale.nl_langinfo(option)
    +

    Return some locale-specific information as a string. This function is not +available on all systems, and the set of possible options might also vary +across platforms. The possible argument values are numbers, for which +symbolic constants are available in the locale module.

    +

    The nl_langinfo() function accepts one of the following keys. Most +descriptions are taken from the corresponding description in the GNU C +library.

    +
    +
    +locale.CODESET
    +

    Get a string with the name of the character encoding used in the +selected locale.

    +
    + +
    +
    +locale.D_T_FMT
    +

    Get a string that can be used as a format string for time.strftime() to +represent date and time in a locale-specific way.

    +
    + +
    +
    +locale.D_FMT
    +

    Get a string that can be used as a format string for time.strftime() to +represent a date in a locale-specific way.

    +
    + +
    +
    +locale.T_FMT
    +

    Get a string that can be used as a format string for time.strftime() to +represent a time in a locale-specific way.

    +
    + +
    +
    +locale.T_FMT_AMPM
    +

    Get a format string for time.strftime() to represent time in the am/pm +format.

    +
    + +
    +
    +DAY_1 ... DAY_7
    +

    Get the name of the n-th day of the week.

    +
    +

    Note

    +

    This follows the US convention of DAY_1 being Sunday, not the +international convention (ISO 8601) that Monday is the first day of the +week.

    +
    +
    + +
    +
    +ABDAY_1 ... ABDAY_7
    +

    Get the abbreviated name of the n-th day of the week.

    +
    + +
    +
    +MON_1 ... MON_12
    +

    Get the name of the n-th month.

    +
    + +
    +
    +ABMON_1 ... ABMON_12
    +

    Get the abbreviated name of the n-th month.

    +
    + +
    +
    +locale.RADIXCHAR
    +

    Get the radix character (decimal dot, decimal comma, etc.).

    +
    + +
    +
    +locale.THOUSEP
    +

    Get the separator character for thousands (groups of three digits).

    +
    + +
    +
    +locale.YESEXPR
    +

    Get a regular expression that can be used with the regex function to +recognize a positive response to a yes/no question.

    +
    +

    Note

    +

    The expression is in the syntax suitable for the regex() function +from the C library, which might differ from the syntax used in re.

    +
    +
    + +
    +
    +locale.NOEXPR
    +

    Get a regular expression that can be used with the regex(3) function to +recognize a negative response to a yes/no question.

    +
    + +
    +
    +locale.CRNCYSTR
    +

    Get the currency symbol, preceded by “-” if the symbol should appear before +the value, “+” if the symbol should appear after the value, or “.” if the +symbol should replace the radix character.

    +
    + +
    +
    +locale.ERA
    +

    Get a string that represents the era used in the current locale.

    +

    Most locales do not define this value. An example of a locale which does +define this value is the Japanese one. In Japan, the traditional +representation of dates includes the name of the era corresponding to the +then-emperor’s reign.

    +

    Normally it should not be necessary to use this value directly. Specifying +the E modifier in their format strings causes the time.strftime() +function to use this information. The format of the returned string is not +specified, and therefore you should not assume knowledge of it on different +systems.

    +
    + +
    +
    +locale.ERA_D_T_FMT
    +

    Get a format string for time.strftime() to represent date and time in a +locale-specific era-based way.

    +
    + +
    +
    +locale.ERA_D_FMT
    +

    Get a format string for time.strftime() to represent a date in a +locale-specific era-based way.

    +
    + +
    +
    +locale.ERA_T_FMT
    +

    Get a format string for time.strftime() to represent a time in a +locale-specific era-based way.

    +
    + +
    +
    +locale.ALT_DIGITS
    +

    Get a representation of up to 100 values used to represent the values +0 to 99.

    +
    + +
    + +
    +
    +locale.getdefaultlocale([envvars])
    +

    Tries to determine the default locale settings and returns them as a tuple of +the form (language code, encoding).

    +

    According to POSIX, a program which has not called setlocale(LC_ALL, '') +runs using the portable 'C' locale. Calling setlocale(LC_ALL, '') lets +it use the default locale as defined by the LANG variable. Since we +do not want to interfere with the current locale setting we thus emulate the +behavior in the way described above.

    +

    To maintain compatibility with other platforms, not only the LANG +variable is tested, but a list of variables given as envvars parameter. The +first found to be defined will be used. envvars defaults to the search +path used in GNU gettext; it must always contain the variable name +'LANG'. The GNU gettext search path contains 'LC_ALL', +'LC_CTYPE', 'LANG' and 'LANGUAGE', in that order.

    +

    Except for the code 'C', the language code corresponds to RFC 1766. +language code and encoding may be None if their values cannot be +determined.

    +
    + +
    +
    +locale.getlocale(category=LC_CTYPE)
    +

    Returns the current setting for the given locale category as sequence containing +language code, encoding. category may be one of the LC_* values +except LC_ALL. It defaults to LC_CTYPE.

    +

    Except for the code 'C', the language code corresponds to RFC 1766. +language code and encoding may be None if their values cannot be +determined.

    +
    + +
    +
    +locale.getpreferredencoding(do_setlocale=True)
    +

    Return the encoding used for text data, according to user preferences. User +preferences are expressed differently on different systems, and might not be +available programmatically on some systems, so this function only returns a +guess.

    +

    On some systems, it is necessary to invoke setlocale() to obtain the user +preferences, so this function is not thread-safe. If invoking setlocale is not +necessary or desired, do_setlocale should be set to False.

    +

    On Android or in the UTF-8 mode (-X utf8 option), always +return 'UTF-8', the locale and the do_setlocale argument are ignored.

    +
    +

    Changed in version 3.7: The function now always returns UTF-8 on Android or if the UTF-8 mode +is enabled.

    +
    +
    + +
    +
    +locale.normalize(localename)
    +

    Returns a normalized locale code for the given locale name. The returned locale +code is formatted for use with setlocale(). If normalization fails, the +original name is returned unchanged.

    +

    If the given encoding is not known, the function defaults to the default +encoding for the locale code just like setlocale().

    +
    + +
    +
    +locale.resetlocale(category=LC_ALL)
    +

    Sets the locale for category to the default setting.

    +

    The default setting is determined by calling getdefaultlocale(). +category defaults to LC_ALL.

    +
    + +
    +
    +locale.strcoll(string1, string2)
    +

    Compares two strings according to the current LC_COLLATE setting. As +any other compare function, returns a negative, or a positive value, or 0, +depending on whether string1 collates before or after string2 or is equal to +it.

    +
    + +
    +
    +locale.strxfrm(string)
    +

    Transforms a string to one that can be used in locale-aware +comparisons. For example, strxfrm(s1) < strxfrm(s2) is +equivalent to strcoll(s1, s2) < 0. This function can be used +when the same string is compared repeatedly, e.g. when collating a +sequence of strings.

    +
    + +
    +
    +locale.format_string(format, val, grouping=False, monetary=False)
    +

    Formats a number val according to the current LC_NUMERIC setting. +The format follows the conventions of the % operator. For floating point +values, the decimal point is modified if appropriate. If grouping is true, +also takes the grouping into account.

    +

    If monetary is true, the conversion uses monetary thousands separator and +grouping strings.

    +

    Processes formatting specifiers as in format % val, but takes the current +locale settings into account.

    +
    +

    Changed in version 3.7: The monetary keyword parameter was added.

    +
    +
    + +
    +
    +locale.format(format, val, grouping=False, monetary=False)
    +

    Please note that this function works like format_string() but will +only work for exactly one %char specifier. For example, '%f' and +'%.0f' are both valid specifiers, but '%f KiB' is not.

    +

    For whole format strings, use format_string().

    +
    +

    Deprecated since version 3.7: Use format_string() instead.

    +
    +
    + +
    +
    +locale.currency(val, symbol=True, grouping=False, international=False)
    +

    Formats a number val according to the current LC_MONETARY settings.

    +

    The returned string includes the currency symbol if symbol is true, which is +the default. If grouping is true (which is not the default), grouping is done +with the value. If international is true (which is not the default), the +international currency symbol is used.

    +

    Note that this function will not work with the ‘C’ locale, so you have to set a +locale via setlocale() first.

    +
    + +
    +
    +locale.str(float)
    +

    Formats a floating point number using the same format as the built-in function +str(float), but takes the decimal point into account.

    +
    + +
    +
    +locale.delocalize(string)
    +

    Converts a string into a normalized number string, following the +LC_NUMERIC settings.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +locale.atof(string)
    +

    Converts a string to a floating point number, following the LC_NUMERIC +settings.

    +
    + +
    +
    +locale.atoi(string)
    +

    Converts a string to an integer, following the LC_NUMERIC conventions.

    +
    + +
    +
    +locale.LC_CTYPE
    +

    Locale category for the character type functions. Depending on the settings of +this category, the functions of module string dealing with case change +their behaviour.

    +
    + +
    +
    +locale.LC_COLLATE
    +

    Locale category for sorting strings. The functions strcoll() and +strxfrm() of the locale module are affected.

    +
    + +
    +
    +locale.LC_TIME
    +

    Locale category for the formatting of time. The function time.strftime() +follows these conventions.

    +
    + +
    +
    +locale.LC_MONETARY
    +

    Locale category for formatting of monetary values. The available options are +available from the localeconv() function.

    +
    + +
    +
    +locale.LC_MESSAGES
    +

    Locale category for message display. Python currently does not support +application specific locale-aware messages. Messages displayed by the operating +system, like those returned by os.strerror() might be affected by this +category.

    +
    + +
    +
    +locale.LC_NUMERIC
    +

    Locale category for formatting numbers. The functions format(), +atoi(), atof() and str() of the locale module are +affected by that category. All other numeric formatting operations are not +affected.

    +
    + +
    +
    +locale.LC_ALL
    +

    Combination of all locale settings. If this flag is used when the locale is +changed, setting the locale for all categories is attempted. If that fails for +any category, no category is changed at all. When the locale is retrieved using +this flag, a string indicating the setting for all categories is returned. This +string can be later used to restore the settings.

    +
    + +
    +
    +locale.CHAR_MAX
    +

    This is a symbolic constant used for different values returned by +localeconv().

    +
    + +

    Example:

    +
    >>> import 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
    +
    +
    +
    +

    Background, details, hints, tips and caveats

    +

    The C standard defines the locale as a program-wide property that may be +relatively expensive to change. On top of that, some implementation are broken +in such a way that frequent locale changes may cause core dumps. This makes the +locale somewhat painful to use correctly.

    +

    Initially, when a program is started, the locale is the C locale, no matter +what the user’s preferred locale is. There is one exception: the +LC_CTYPE category is changed at startup to set the current locale +encoding to the user’s preferred locale encoding. The program must explicitly +say that it wants the user’s preferred locale settings for other categories by +calling setlocale(LC_ALL, '').

    +

    It is generally a bad idea to call setlocale() in some library routine, +since as a side effect it affects the entire program. Saving and restoring it +is almost as bad: it is expensive and affects other threads that happen to run +before the settings have been restored.

    +

    If, when coding a module for general use, you need a locale independent version +of an operation that is affected by the locale (such as +certain formats used with time.strftime()), you will have to find a way to +do it without using the standard library routine. Even better is convincing +yourself that using locale settings is okay. Only as a last resort should you +document that your module is not compatible with non-C locale settings.

    +

    The only way to perform numeric operations according to the locale is to use the +special functions defined by this module: atof(), atoi(), +format(), str().

    +

    There is no way to perform case conversions and character classifications +according to the locale. For (Unicode) text strings these are done according +to the character value only, while for byte strings, the conversions and +classifications are done according to the ASCII value of the byte, and bytes +whose high bit is set (i.e., non-ASCII bytes) are never converted or considered +part of a character class such as letter or whitespace.

    +
    +
    +

    For extension writers and programs that embed Python

    +

    Extension modules should never call setlocale(), except to find out what +the current locale is. But since the return value can only be used portably to +restore it, that is not very useful (except perhaps to find out whether or not +the locale is C).

    +

    When Python code uses the locale module to change the locale, this also +affects the embedding application. If the embedding application doesn’t want +this to happen, it should remove the _locale extension module (which does +all the work) from the table of built-in modules in the config.c file, +and make sure that the _locale module is not accessible as a shared +library.

    +
    +
    +

    Access to message catalogs

    +
    +
    +locale.gettext(msg)
    +
    + +
    +
    +locale.dgettext(domain, msg)
    +
    + +
    +
    +locale.dcgettext(domain, msg, category)
    +
    + +
    +
    +locale.textdomain(domain)
    +
    + +
    +
    +locale.bindtextdomain(domain, dir)
    +
    + +

    The locale module exposes the C library’s gettext interface on systems that +provide this interface. It consists of the functions gettext(), +dgettext(), dcgettext(), textdomain(), bindtextdomain(), +and bind_textdomain_codeset(). These are similar to the same functions in +the gettext module, but use the C library’s binary format for message +catalogs, and the C library’s search algorithms for locating message catalogs.

    +

    Python applications should normally find no need to invoke these functions, and +should use gettext instead. A known exception to this rule are +applications that link with additional C libraries which internally invoke +gettext() or dcgettext(). For these applications, it may be +necessary to bind the text domain, so that the libraries can properly locate +their message catalogs.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/logging.config.html b/python-3.7.4-docs-html/library/logging.config.html new file mode 100644 index 0000000..9607a8c --- /dev/null +++ b/python-3.7.4-docs-html/library/logging.config.html @@ -0,0 +1,935 @@ + + + + + + + logging.config — Logging configuration — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    logging.config — Logging configuration

    +

    Source code: Lib/logging/config.py

    + +
    +

    This section describes the API for configuring the logging module.

    +
    +

    Configuration functions

    +

    The following functions configure the logging module. They are located in the +logging.config module. Their use is optional — you can configure the +logging module using these functions or by making calls to the main API (defined +in logging itself) and defining handlers which are declared either in +logging or logging.handlers.

    +
    +
    +logging.config.dictConfig(config)
    +
    +

    Takes the logging configuration from a dictionary. The contents of +this dictionary are described in Configuration dictionary schema +below.

    +

    If an error is encountered during configuration, this function will +raise a ValueError, TypeError, AttributeError +or ImportError with a suitably descriptive message. The +following is a (possibly incomplete) list of conditions which will +raise an error:

    +
      +
    • A level which is not a string or which is a string not +corresponding to an actual logging level.

    • +
    • A propagate value which is not a boolean.

    • +
    • An id which does not have a corresponding destination.

    • +
    • A non-existent handler id found during an incremental call.

    • +
    • An invalid logger name.

    • +
    • Inability to resolve to an internal or external object.

    • +
    +

    Parsing is performed by the DictConfigurator class, whose +constructor is passed the dictionary used for configuration, and +has a configure() method. The logging.config module +has a callable attribute dictConfigClass +which is initially set to DictConfigurator. +You can replace the value of dictConfigClass with a +suitable implementation of your own.

    +

    dictConfig() calls dictConfigClass passing +the specified dictionary, and then calls the configure() method on +the returned object to put the configuration into effect:

    +
    def dictConfig(config):
    +    dictConfigClass(config).configure()
    +
    +
    +

    For example, a subclass of DictConfigurator could call +DictConfigurator.__init__() in its own __init__(), then +set up custom prefixes which would be usable in the subsequent +configure() call. dictConfigClass would be bound to +this new subclass, and then dictConfig() could be called exactly as +in the default, uncustomized state.

    +
    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +logging.config.fileConfig(fname, defaults=None, disable_existing_loggers=True)
    +

    Reads the logging configuration from a configparser-format file. The +format of the file should be as described in +Configuration file format. +This function can be called several times from an application, allowing an +end user to select from various pre-canned configurations (if the developer +provides a mechanism to present the choices and load the chosen +configuration).

    +
    +
    Parameters
    +
      +
    • fname – A filename, or a file-like object, or an instance derived +from RawConfigParser. If a +RawConfigParser-derived instance is passed, it is used as +is. Otherwise, a Configparser is +instantiated, and the configuration read by it from the +object passed in fname. If that has a readline() +method, it is assumed to be a file-like object and read using +read_file(); otherwise, +it is assumed to be a filename and passed to +read().

    • +
    • defaults – Defaults to be passed to the ConfigParser can be specified +in this argument.

    • +
    • disable_existing_loggers – If specified as False, loggers which +exist when this call is made are left +enabled. The default is True because this +enables old behaviour in a +backward-compatible way. This behaviour is to +disable any existing non-root loggers unless +they or their ancestors are explicitly named +in the logging configuration.

    • +
    +
    +
    +
    +

    Changed in version 3.4: An instance of a subclass of RawConfigParser is +now accepted as a value for fname. This facilitates:

    +
      +
    • Use of a configuration file where logging configuration is just part +of the overall application configuration.

    • +
    • Use of a configuration read from a file, and then modified by the using +application (e.g. based on command-line parameters or other aspects +of the runtime environment) before being passed to fileConfig.

    • +
    +
    +
    + +
    +
    +logging.config.listen(port=DEFAULT_LOGGING_CONFIG_PORT, verify=None)
    +

    Starts up a socket server on the specified port, and listens for new +configurations. If no port is specified, the module’s default +DEFAULT_LOGGING_CONFIG_PORT is used. Logging configurations will be +sent as a file suitable for processing by dictConfig() or +fileConfig(). Returns a Thread instance on which +you can call start() to start the server, and which +you can join() when appropriate. To stop the server, +call stopListening().

    +

    The verify argument, if specified, should be a callable which should +verify whether bytes received across the socket are valid and should be +processed. This could be done by encrypting and/or signing what is sent +across the socket, such that the verify callable can perform +signature verification and/or decryption. The verify callable is called +with a single argument - the bytes received across the socket - and should +return the bytes to be processed, or None to indicate that the bytes should +be discarded. The returned bytes could be the same as the passed in bytes +(e.g. when only verification is done), or they could be completely different +(perhaps if decryption were performed).

    +

    To send a configuration to the socket, read in the configuration file and +send it to the socket as a sequence of bytes preceded by a four-byte length +string packed in binary using struct.pack('>L', n).

    +
    +

    Note

    +

    Because portions of the configuration are passed through +eval(), use of this function may open its users to a security risk. +While the function only binds to a socket on localhost, and so does +not accept connections from remote machines, there are scenarios where +untrusted code could be run under the account of the process which calls +listen(). Specifically, if the process calling listen() runs +on a multi-user machine where users cannot trust each other, then a +malicious user could arrange to run essentially arbitrary code in a +victim user’s process, simply by connecting to the victim’s +listen() socket and sending a configuration which runs whatever +code the attacker wants to have executed in the victim’s process. This is +especially easy to do if the default port is used, but not hard even if a +different port is used). To avoid the risk of this happening, use the +verify argument to listen() to prevent unrecognised +configurations from being applied.

    +
    +
    +

    Changed in version 3.4: The verify argument was added.

    +
    +
    +

    Note

    +

    If you want to send configurations to the listener which don’t +disable existing loggers, you will need to use a JSON format for +the configuration, which will use dictConfig() for configuration. +This method allows you to specify disable_existing_loggers as +False in the configuration you send.

    +
    +
    + +
    +
    +logging.config.stopListening()
    +

    Stops the listening server which was created with a call to listen(). +This is typically called before calling join() on the return value from +listen().

    +
    + +
    +
    +

    Configuration dictionary schema

    +

    Describing a logging configuration requires listing the various +objects to create and the connections between them; for example, you +may create a handler named ‘console’ and then say that the logger +named ‘startup’ will send its messages to the ‘console’ handler. +These objects aren’t limited to those provided by the logging +module because you might write your own formatter or handler class. +The parameters to these classes may also need to include external +objects such as sys.stderr. The syntax for describing these +objects and connections is defined in Object connections +below.

    +
    +

    Dictionary Schema Details

    +

    The dictionary passed to dictConfig() must contain the following +keys:

    +
      +
    • version - to be set to an integer value representing the schema +version. The only valid value at present is 1, but having this key +allows the schema to evolve while still preserving backwards +compatibility.

    • +
    +

    All other keys are optional, but if present they will be interpreted +as described below. In all cases below where a ‘configuring dict’ is +mentioned, it will be checked for the special '()' key to see if a +custom instantiation is required. If so, the mechanism described in +User-defined objects below is used to create an instance; +otherwise, the context is used to determine what to instantiate.

    +
      +
    • formatters - the corresponding value will be a dict in which each +key is a formatter id and each value is a dict describing how to +configure the corresponding Formatter instance.

      +

      The configuring dict is searched for keys format and datefmt +(with defaults of None) and these are used to construct a +Formatter instance.

      +
    • +
    • filters - the corresponding value will be a dict in which each key +is a filter id and each value is a dict describing how to configure +the corresponding Filter instance.

      +

      The configuring dict is searched for the key name (defaulting to the +empty string) and this is used to construct a logging.Filter +instance.

      +
    • +
    • handlers - the corresponding value will be a dict in which each +key is a handler id and each value is a dict describing how to +configure the corresponding Handler instance.

      +

      The configuring dict is searched for the following keys:

      +
        +
      • class (mandatory). This is the fully qualified name of the +handler class.

      • +
      • level (optional). The level of the handler.

      • +
      • formatter (optional). The id of the formatter for this +handler.

      • +
      • filters (optional). A list of ids of the filters for this +handler.

      • +
      +

      All other keys are passed through as keyword arguments to the +handler’s constructor. For example, given the snippet:

      +
      handlers:
      +  console:
      +    class : logging.StreamHandler
      +    formatter: brief
      +    level   : INFO
      +    filters: [allow_foo]
      +    stream  : ext://sys.stdout
      +  file:
      +    class : logging.handlers.RotatingFileHandler
      +    formatter: precise
      +    filename: logconfig.log
      +    maxBytes: 1024
      +    backupCount: 3
      +
      +
      +

      the handler with id console is instantiated as a +logging.StreamHandler, using sys.stdout as the underlying +stream. The handler with id file is instantiated as a +logging.handlers.RotatingFileHandler with the keyword arguments +filename='logconfig.log', maxBytes=1024, backupCount=3.

      +
    • +
    • loggers - the corresponding value will be a dict in which each key +is a logger name and each value is a dict describing how to +configure the corresponding Logger instance.

      +

      The configuring dict is searched for the following keys:

      +
        +
      • level (optional). The level of the logger.

      • +
      • propagate (optional). The propagation setting of the logger.

      • +
      • filters (optional). A list of ids of the filters for this +logger.

      • +
      • handlers (optional). A list of ids of the handlers for this +logger.

      • +
      +

      The specified loggers will be configured according to the level, +propagation, filters and handlers specified.

      +
    • +
    • root - this will be the configuration for the root logger. +Processing of the configuration will be as for any logger, except +that the propagate setting will not be applicable.

    • +
    • incremental - whether the configuration is to be interpreted as +incremental to the existing configuration. This value defaults to +False, which means that the specified configuration replaces the +existing configuration with the same semantics as used by the +existing fileConfig() API.

      +

      If the specified value is True, the configuration is processed +as described in the section on Incremental Configuration.

      +
    • +
    • disable_existing_loggers - whether any existing non-root loggers are +to be disabled. This setting mirrors the parameter of the same name in +fileConfig(). If absent, this parameter defaults to True. +This value is ignored if incremental is True.

    • +
    +
    +
    +

    Incremental Configuration

    +

    It is difficult to provide complete flexibility for incremental +configuration. For example, because objects such as filters +and formatters are anonymous, once a configuration is set up, it is +not possible to refer to such anonymous objects when augmenting a +configuration.

    +

    Furthermore, there is not a compelling case for arbitrarily altering +the object graph of loggers, handlers, filters, formatters at +run-time, once a configuration is set up; the verbosity of loggers and +handlers can be controlled just by setting levels (and, in the case of +loggers, propagation flags). Changing the object graph arbitrarily in +a safe way is problematic in a multi-threaded environment; while not +impossible, the benefits are not worth the complexity it adds to the +implementation.

    +

    Thus, when the incremental key of a configuration dict is present +and is True, the system will completely ignore any formatters and +filters entries, and process only the level +settings in the handlers entries, and the level and +propagate settings in the loggers and root entries.

    +

    Using a value in the configuration dict lets configurations to be sent +over the wire as pickled dicts to a socket listener. Thus, the logging +verbosity of a long-running application can be altered over time with +no need to stop and restart the application.

    +
    +
    +

    Object connections

    +

    The schema describes a set of logging objects - loggers, +handlers, formatters, filters - which are connected to each other in +an object graph. Thus, the schema needs to represent connections +between the objects. For example, say that, once configured, a +particular logger has attached to it a particular handler. For the +purposes of this discussion, we can say that the logger represents the +source, and the handler the destination, of a connection between the +two. Of course in the configured objects this is represented by the +logger holding a reference to the handler. In the configuration dict, +this is done by giving each destination object an id which identifies +it unambiguously, and then using the id in the source object’s +configuration to indicate that a connection exists between the source +and the destination object with that id.

    +

    So, for example, consider the following YAML snippet:

    +
    formatters:
    +  brief:
    +    # configuration for formatter with id 'brief' goes here
    +  precise:
    +    # configuration for formatter with id 'precise' goes here
    +handlers:
    +  h1: #This is an id
    +   # configuration of handler with id 'h1' goes here
    +   formatter: brief
    +  h2: #This is another id
    +   # configuration of handler with id 'h2' goes here
    +   formatter: precise
    +loggers:
    +  foo.bar.baz:
    +    # other configuration for logger 'foo.bar.baz'
    +    handlers: [h1, h2]
    +
    +
    +

    (Note: YAML used here because it’s a little more readable than the +equivalent Python source form for the dictionary.)

    +

    The ids for loggers are the logger names which would be used +programmatically to obtain a reference to those loggers, e.g. +foo.bar.baz. The ids for Formatters and Filters can be any string +value (such as brief, precise above) and they are transient, +in that they are only meaningful for processing the configuration +dictionary and used to determine connections between objects, and are +not persisted anywhere when the configuration call is complete.

    +

    The above snippet indicates that logger named foo.bar.baz should +have two handlers attached to it, which are described by the handler +ids h1 and h2. The formatter for h1 is that described by id +brief, and the formatter for h2 is that described by id +precise.

    +
    +
    +

    User-defined objects

    +

    The schema supports user-defined objects for handlers, filters and +formatters. (Loggers do not need to have different types for +different instances, so there is no support in this configuration +schema for user-defined logger classes.)

    +

    Objects to be configured are described by dictionaries +which detail their configuration. In some places, the logging system +will be able to infer from the context how an object is to be +instantiated, but when a user-defined object is to be instantiated, +the system will not know how to do this. In order to provide complete +flexibility for user-defined object instantiation, the user needs +to provide a ‘factory’ - a callable which is called with a +configuration dictionary and which returns the instantiated object. +This is signalled by an absolute import path to the factory being +made available under the special key '()'. Here’s a concrete +example:

    +
    formatters:
    +  brief:
    +    format: '%(message)s'
    +  default:
    +    format: '%(asctime)s %(levelname)-8s %(name)-15s %(message)s'
    +    datefmt: '%Y-%m-%d %H:%M:%S'
    +  custom:
    +      (): my.package.customFormatterFactory
    +      bar: baz
    +      spam: 99.9
    +      answer: 42
    +
    +
    +

    The above YAML snippet defines three formatters. The first, with id +brief, is a standard logging.Formatter instance with the +specified format string. The second, with id default, has a +longer format and also defines the time format explicitly, and will +result in a logging.Formatter initialized with those two format +strings. Shown in Python source form, the brief and default +formatters have configuration sub-dictionaries:

    +
    {
    +  'format' : '%(message)s'
    +}
    +
    +
    +

    and:

    +
    {
    +  'format' : '%(asctime)s %(levelname)-8s %(name)-15s %(message)s',
    +  'datefmt' : '%Y-%m-%d %H:%M:%S'
    +}
    +
    +
    +

    respectively, and as these dictionaries do not contain the special key +'()', the instantiation is inferred from the context: as a result, +standard logging.Formatter instances are created. The +configuration sub-dictionary for the third formatter, with id +custom, is:

    +
    {
    +  '()' : 'my.package.customFormatterFactory',
    +  'bar' : 'baz',
    +  'spam' : 99.9,
    +  'answer' : 42
    +}
    +
    +
    +

    and this contains the special key '()', which means that +user-defined instantiation is wanted. In this case, the specified +factory callable will be used. If it is an actual callable it will be +used directly - otherwise, if you specify a string (as in the example) +the actual callable will be located using normal import mechanisms. +The callable will be called with the remaining items in the +configuration sub-dictionary as keyword arguments. In the above +example, the formatter with id custom will be assumed to be +returned by the call:

    +
    my.package.customFormatterFactory(bar='baz', spam=99.9, answer=42)
    +
    +
    +

    The key '()' has been used as the special key because it is not a +valid keyword parameter name, and so will not clash with the names of +the keyword arguments used in the call. The '()' also serves as a +mnemonic that the corresponding value is a callable.

    +
    +
    +

    Access to external objects

    +

    There are times where a configuration needs to refer to objects +external to the configuration, for example sys.stderr. If the +configuration dict is constructed using Python code, this is +straightforward, but a problem arises when the configuration is +provided via a text file (e.g. JSON, YAML). In a text file, there is +no standard way to distinguish sys.stderr from the literal string +'sys.stderr'. To facilitate this distinction, the configuration +system looks for certain special prefixes in string values and +treat them specially. For example, if the literal string +'ext://sys.stderr' is provided as a value in the configuration, +then the ext:// will be stripped off and the remainder of the +value processed using normal import mechanisms.

    +

    The handling of such prefixes is done in a way analogous to protocol +handling: there is a generic mechanism to look for prefixes which +match the regular expression ^(?P<prefix>[a-z]+)://(?P<suffix>.*)$ +whereby, if the prefix is recognised, the suffix is processed +in a prefix-dependent manner and the result of the processing replaces +the string value. If the prefix is not recognised, then the string +value will be left as-is.

    +
    +
    +

    Access to internal objects

    +

    As well as external objects, there is sometimes also a need to refer +to objects in the configuration. This will be done implicitly by the +configuration system for things that it knows about. For example, the +string value 'DEBUG' for a level in a logger or handler will +automatically be converted to the value logging.DEBUG, and the +handlers, filters and formatter entries will take an +object id and resolve to the appropriate destination object.

    +

    However, a more generic mechanism is needed for user-defined +objects which are not known to the logging module. For +example, consider logging.handlers.MemoryHandler, which takes +a target argument which is another handler to delegate to. Since +the system already knows about this class, then in the configuration, +the given target just needs to be the object id of the relevant +target handler, and the system will resolve to the handler from the +id. If, however, a user defines a my.package.MyHandler which has +an alternate handler, the configuration system would not know that +the alternate referred to a handler. To cater for this, a generic +resolution system allows the user to specify:

    +
    handlers:
    +  file:
    +    # configuration of file handler goes here
    +
    +  custom:
    +    (): my.package.MyHandler
    +    alternate: cfg://handlers.file
    +
    +
    +

    The literal string 'cfg://handlers.file' will be resolved in an +analogous way to strings with the ext:// prefix, but looking +in the configuration itself rather than the import namespace. The +mechanism allows access by dot or by index, in a similar way to +that provided by str.format. Thus, given the following snippet:

    +
    handlers:
    +  email:
    +    class: logging.handlers.SMTPHandler
    +    mailhost: localhost
    +    fromaddr: my_app@domain.tld
    +    toaddrs:
    +      - support_team@domain.tld
    +      - dev_team@domain.tld
    +    subject: Houston, we have a problem.
    +
    +
    +

    in the configuration, the string 'cfg://handlers' would resolve to +the dict with key handlers, the string 'cfg://handlers.email +would resolve to the dict with key email in the handlers dict, +and so on. The string 'cfg://handlers.email.toaddrs[1] would +resolve to 'dev_team.domain.tld' and the string +'cfg://handlers.email.toaddrs[0]' would resolve to the value +'support_team@domain.tld'. The subject value could be accessed +using either 'cfg://handlers.email.subject' or, equivalently, +'cfg://handlers.email[subject]'. The latter form only needs to be +used if the key contains spaces or non-alphanumeric characters. If an +index value consists only of decimal digits, access will be attempted +using the corresponding integer value, falling back to the string +value if needed.

    +

    Given a string cfg://handlers.myhandler.mykey.123, this will +resolve to config_dict['handlers']['myhandler']['mykey']['123']. +If the string is specified as cfg://handlers.myhandler.mykey[123], +the system will attempt to retrieve the value from +config_dict['handlers']['myhandler']['mykey'][123], and fall back +to config_dict['handlers']['myhandler']['mykey']['123'] if that +fails.

    +
    +
    +

    Import resolution and custom importers

    +

    Import resolution, by default, uses the builtin __import__() function +to do its importing. You may want to replace this with your own importing +mechanism: if so, you can replace the importer attribute of the +DictConfigurator or its superclass, the +BaseConfigurator class. However, you need to be +careful because of the way functions are accessed from classes via +descriptors. If you are using a Python callable to do your imports, and you +want to define it at class level rather than instance level, you need to wrap +it with staticmethod(). For example:

    +
    from importlib import import_module
    +from logging.config import BaseConfigurator
    +
    +BaseConfigurator.importer = staticmethod(import_module)
    +
    +
    +

    You don’t need to wrap with staticmethod() if you’re setting the import +callable on a configurator instance.

    +
    +
    +
    +

    Configuration file format

    +

    The configuration file format understood by fileConfig() is based on +configparser functionality. The file must contain sections called +[loggers], [handlers] and [formatters] which identify by name the +entities of each type which are defined in the file. For each such entity, there +is a separate section which identifies how that entity is configured. Thus, for +a logger named log01 in the [loggers] section, the relevant +configuration details are held in a section [logger_log01]. Similarly, a +handler called hand01 in the [handlers] section will have its +configuration held in a section called [handler_hand01], while a formatter +called form01 in the [formatters] section will have its configuration +specified in a section called [formatter_form01]. The root logger +configuration must be specified in a section called [logger_root].

    +
    +

    Note

    +

    The fileConfig() API is older than the dictConfig() API and does +not provide functionality to cover certain aspects of logging. For example, +you cannot configure Filter objects, which provide for +filtering of messages beyond simple integer levels, using fileConfig(). +If you need to have instances of Filter in your logging +configuration, you will need to use dictConfig(). Note that future +enhancements to configuration functionality will be added to +dictConfig(), so it’s worth considering transitioning to this newer +API when it’s convenient to do so.

    +
    +

    Examples of these sections in the file are given below.

    +
    [loggers]
    +keys=root,log02,log03,log04,log05,log06,log07
    +
    +[handlers]
    +keys=hand01,hand02,hand03,hand04,hand05,hand06,hand07,hand08,hand09
    +
    +[formatters]
    +keys=form01,form02,form03,form04,form05,form06,form07,form08,form09
    +
    +
    +

    The root logger must specify a level and a list of handlers. An example of a +root logger section is given below.

    +
    [logger_root]
    +level=NOTSET
    +handlers=hand01
    +
    +
    +

    The level entry can be one of DEBUG, INFO, WARNING, ERROR, CRITICAL or +NOTSET. For the root logger only, NOTSET means that all messages will be +logged. Level values are eval()uated in the context of the logging +package’s namespace.

    +

    The handlers entry is a comma-separated list of handler names, which must +appear in the [handlers] section. These names must appear in the +[handlers] section and have corresponding sections in the configuration +file.

    +

    For loggers other than the root logger, some additional information is required. +This is illustrated by the following example.

    +
    [logger_parser]
    +level=DEBUG
    +handlers=hand01
    +propagate=1
    +qualname=compiler.parser
    +
    +
    +

    The level and handlers entries are interpreted as for the root logger, +except that if a non-root logger’s level is specified as NOTSET, the system +consults loggers higher up the hierarchy to determine the effective level of the +logger. The propagate entry is set to 1 to indicate that messages must +propagate to handlers higher up the logger hierarchy from this logger, or 0 to +indicate that messages are not propagated to handlers up the hierarchy. The +qualname entry is the hierarchical channel name of the logger, that is to +say the name used by the application to get the logger.

    +

    Sections which specify handler configuration are exemplified by the following.

    +
    [handler_hand01]
    +class=StreamHandler
    +level=NOTSET
    +formatter=form01
    +args=(sys.stdout,)
    +
    +
    +

    The class entry indicates the handler’s class (as determined by eval() +in the logging package’s namespace). The level is interpreted as for +loggers, and NOTSET is taken to mean ‘log everything’.

    +

    The formatter entry indicates the key name of the formatter for this +handler. If blank, a default formatter (logging._defaultFormatter) is used. +If a name is specified, it must appear in the [formatters] section and have +a corresponding section in the configuration file.

    +

    The args entry, when eval()uated in the context of the logging +package’s namespace, is the list of arguments to the constructor for the handler +class. Refer to the constructors for the relevant handlers, or to the examples +below, to see how typical entries are constructed. If not provided, it defaults +to ().

    +

    The optional kwargs entry, when eval()uated in the context of the +logging package’s namespace, is the keyword argument dict to the constructor +for the handler class. If not provided, it defaults to {}.

    +
    [handler_hand02]
    +class=FileHandler
    +level=DEBUG
    +formatter=form02
    +args=('python.log', 'w')
    +
    +[handler_hand03]
    +class=handlers.SocketHandler
    +level=INFO
    +formatter=form03
    +args=('localhost', handlers.DEFAULT_TCP_LOGGING_PORT)
    +
    +[handler_hand04]
    +class=handlers.DatagramHandler
    +level=WARN
    +formatter=form04
    +args=('localhost', handlers.DEFAULT_UDP_LOGGING_PORT)
    +
    +[handler_hand05]
    +class=handlers.SysLogHandler
    +level=ERROR
    +formatter=form05
    +args=(('localhost', handlers.SYSLOG_UDP_PORT), handlers.SysLogHandler.LOG_USER)
    +
    +[handler_hand06]
    +class=handlers.NTEventLogHandler
    +level=CRITICAL
    +formatter=form06
    +args=('Python Application', '', 'Application')
    +
    +[handler_hand07]
    +class=handlers.SMTPHandler
    +level=WARN
    +formatter=form07
    +args=('localhost', 'from@abc', ['user1@abc', 'user2@xyz'], 'Logger Subject')
    +kwargs={'timeout': 10.0}
    +
    +[handler_hand08]
    +class=handlers.MemoryHandler
    +level=NOTSET
    +formatter=form08
    +target=
    +args=(10, ERROR)
    +
    +[handler_hand09]
    +class=handlers.HTTPHandler
    +level=NOTSET
    +formatter=form09
    +args=('localhost:9022', '/log', 'GET')
    +kwargs={'secure': True}
    +
    +
    +

    Sections which specify formatter configuration are typified by the following.

    +
    [formatter_form01]
    +format=F1 %(asctime)s %(levelname)s %(message)s
    +datefmt=
    +class=logging.Formatter
    +
    +
    +

    The format entry is the overall format string, and the datefmt entry is +the strftime()-compatible date/time format string. If empty, the +package substitutes something which is almost equivalent to specifying the date +format string '%Y-%m-%d %H:%M:%S'. This format also specifies milliseconds, +which are appended to the result of using the above format string, with a comma +separator. An example time in this format is 2003-01-23 00:29:50,411.

    +

    The class entry is optional. It indicates the name of the formatter’s class +(as a dotted module and class name.) This option is useful for instantiating a +Formatter subclass. Subclasses of +Formatter can present exception tracebacks in an expanded or +condensed format.

    +
    +

    Note

    +

    Due to the use of eval() as described above, there are +potential security risks which result from using the listen() to send +and receive configurations via sockets. The risks are limited to where +multiple users with no mutual trust run code on the same machine; see the +listen() documentation for more information.

    +
    +
    +

    See also

    +
    +
    Module logging

    API reference for the logging module.

    +
    +
    Module logging.handlers

    Useful handlers included with the logging module.

    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/logging.handlers.html b/python-3.7.4-docs-html/library/logging.handlers.html new file mode 100644 index 0000000..6c58709 --- /dev/null +++ b/python-3.7.4-docs-html/library/logging.handlers.html @@ -0,0 +1,1401 @@ + + + + + + + logging.handlers — Logging handlers — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    logging.handlers — Logging handlers

    +

    Source code: Lib/logging/handlers.py

    + +
    +

    The following useful handlers are provided in the package. Note that three of +the handlers (StreamHandler, FileHandler and +NullHandler) are actually defined in the logging module itself, +but have been documented here along with the other handlers.

    +
    +

    StreamHandler

    +

    The StreamHandler class, located in the core logging package, +sends logging output to streams such as sys.stdout, sys.stderr or any +file-like object (or, more precisely, any object which supports write() +and flush() methods).

    +
    +
    +class logging.StreamHandler(stream=None)
    +

    Returns a new instance of the StreamHandler class. If stream is +specified, the instance will use it for logging output; otherwise, sys.stderr +will be used.

    +
    +
    +emit(record)
    +

    If a formatter is specified, it is used to format the record. The record +is then written to the stream with a terminator. If exception information +is present, it is formatted using traceback.print_exception() and +appended to the stream.

    +
    + +
    +
    +flush()
    +

    Flushes the stream by calling its flush() method. Note that the +close() method is inherited from Handler and so +does no output, so an explicit flush() call may be needed at times.

    +
    + +
    +
    +setStream(stream)
    +

    Sets the instance’s stream to the specified value, if it is different. +The old stream is flushed before the new stream is set.

    +
    +
    Parameters
    +

    stream – The stream that the handler should use.

    +
    +
    Returns
    +

    the old stream, if the stream was changed, or None if it wasn’t.

    +
    +
    +
    + +
    +

    New in version 3.7.

    +
    +
    + +
    +

    Changed in version 3.2: The StreamHandler class now has a terminator attribute, default +value '\n', which is used as the terminator when writing a formatted +record to a stream. If you don’t want this newline termination, you can +set the handler instance’s terminator attribute to the empty string. +In earlier versions, the terminator was hardcoded as '\n'.

    +
    +
    +
    +

    FileHandler

    +

    The FileHandler class, located in the core logging package, +sends logging output to a disk file. It inherits the output functionality from +StreamHandler.

    +
    +
    +class logging.FileHandler(filename, mode='a', encoding=None, delay=False)
    +

    Returns a new instance of the FileHandler class. The specified file is +opened and used as the stream for logging. If mode is not specified, +'a' is used. If encoding is not None, it is used to open the file +with that encoding. If delay is true, then file opening is deferred until the +first call to emit(). By default, the file grows indefinitely.

    +
    +

    Changed in version 3.6: As well as string values, Path objects are also accepted +for the filename argument.

    +
    +
    +
    +close()
    +

    Closes the file.

    +
    + +
    +
    +emit(record)
    +

    Outputs the record to the file.

    +
    + +
    + +
    +
    +

    NullHandler

    +
    +

    New in version 3.1.

    +
    +

    The NullHandler class, located in the core logging package, +does not do any formatting or output. It is essentially a ‘no-op’ handler +for use by library developers.

    +
    +
    +class logging.NullHandler
    +

    Returns a new instance of the NullHandler class.

    +
    +
    +emit(record)
    +

    This method does nothing.

    +
    + +
    +
    +handle(record)
    +

    This method does nothing.

    +
    + +
    +
    +createLock()
    +

    This method returns None for the lock, since there is no +underlying I/O to which access needs to be serialized.

    +
    + +
    + +

    See Configuring Logging for a Library for more information on how to use +NullHandler.

    +
    +
    +

    WatchedFileHandler

    +

    The WatchedFileHandler class, located in the logging.handlers +module, is a FileHandler which watches the file it is logging to. If +the file changes, it is closed and reopened using the file name.

    +

    A file change can happen because of usage of programs such as newsyslog and +logrotate which perform log file rotation. This handler, intended for use +under Unix/Linux, watches the file to see if it has changed since the last emit. +(A file is deemed to have changed if its device or inode have changed.) If the +file has changed, the old file stream is closed, and the file opened to get a +new stream.

    +

    This handler is not appropriate for use under Windows, because under Windows +open log files cannot be moved or renamed - logging opens the files with +exclusive locks - and so there is no need for such a handler. Furthermore, +ST_INO is not supported under Windows; stat() always returns zero +for this value.

    +
    +
    +class logging.handlers.WatchedFileHandler(filename, mode='a', encoding=None, delay=False)
    +

    Returns a new instance of the WatchedFileHandler class. The specified +file is opened and used as the stream for logging. If mode is not specified, +'a' is used. If encoding is not None, it is used to open the file +with that encoding. If delay is true, then file opening is deferred until the +first call to emit(). By default, the file grows indefinitely.

    +
    +

    Changed in version 3.6: As well as string values, Path objects are also accepted +for the filename argument.

    +
    +
    +
    +reopenIfNeeded()
    +

    Checks to see if the file has changed. If it has, the existing stream is +flushed and closed and the file opened again, typically as a precursor to +outputting the record to the file.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +emit(record)
    +

    Outputs the record to the file, but first calls reopenIfNeeded() to +reopen the file if it has changed.

    +
    + +
    + +
    +
    +

    BaseRotatingHandler

    +

    The BaseRotatingHandler class, located in the logging.handlers +module, is the base class for the rotating file handlers, +RotatingFileHandler and TimedRotatingFileHandler. You should +not need to instantiate this class, but it has attributes and methods you may +need to override.

    +
    +
    +class logging.handlers.BaseRotatingHandler(filename, mode, encoding=None, delay=False)
    +

    The parameters are as for FileHandler. The attributes are:

    +
    +
    +namer
    +

    If this attribute is set to a callable, the rotation_filename() +method delegates to this callable. The parameters passed to the callable +are those passed to rotation_filename().

    +
    +

    Note

    +

    The namer function is called quite a few times during rollover, +so it should be as simple and as fast as possible. It should also +return the same output every time for a given input, otherwise the +rollover behaviour may not work as expected.

    +
    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +rotator
    +

    If this attribute is set to a callable, the rotate() method +delegates to this callable. The parameters passed to the callable are +those passed to rotate().

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +rotation_filename(default_name)
    +

    Modify the filename of a log file when rotating.

    +

    This is provided so that a custom filename can be provided.

    +

    The default implementation calls the ‘namer’ attribute of the handler, +if it’s callable, passing the default name to it. If the attribute isn’t +callable (the default is None), the name is returned unchanged.

    +
    +
    Parameters
    +

    default_name – The default name for the log file.

    +
    +
    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +rotate(source, dest)
    +

    When rotating, rotate the current log.

    +

    The default implementation calls the ‘rotator’ attribute of the handler, +if it’s callable, passing the source and dest arguments to it. If the +attribute isn’t callable (the default is None), the source is simply +renamed to the destination.

    +
    +
    Parameters
    +
      +
    • source – The source filename. This is normally the base +filename, e.g. ‘test.log’.

    • +
    • dest – The destination filename. This is normally +what the source is rotated to, e.g. ‘test.log.1’.

    • +
    +
    +
    +
    +

    New in version 3.3.

    +
    +
    + +
    + +

    The reason the attributes exist is to save you having to subclass - you can use +the same callables for instances of RotatingFileHandler and +TimedRotatingFileHandler. If either the namer or rotator callable +raises an exception, this will be handled in the same way as any other +exception during an emit() call, i.e. via the handleError() method +of the handler.

    +

    If you need to make more significant changes to rotation processing, you can +override the methods.

    +

    For an example, see Using a rotator and namer to customize log rotation processing.

    +
    +
    +

    RotatingFileHandler

    +

    The RotatingFileHandler class, located in the logging.handlers +module, supports rotation of disk log files.

    +
    +
    +class logging.handlers.RotatingFileHandler(filename, mode='a', maxBytes=0, backupCount=0, encoding=None, delay=False)
    +

    Returns a new instance of the RotatingFileHandler class. The specified +file is opened and used as the stream for logging. If mode is not specified, +'a' is used. If encoding is not None, it is used to open the file +with that encoding. If delay is true, then file opening is deferred until the +first call to emit(). By default, the file grows indefinitely.

    +

    You can use the maxBytes and backupCount values to allow the file to +rollover at a predetermined size. When the size is about to be exceeded, +the file is closed and a new file is silently opened for output. Rollover occurs +whenever the current log file is nearly maxBytes in length; but if either of +maxBytes or backupCount is zero, rollover never occurs, so you generally want +to set backupCount to at least 1, and have a non-zero maxBytes. +When backupCount is non-zero, the system will save old log files by appending +the extensions ‘.1’, ‘.2’ etc., to the filename. For example, with a backupCount +of 5 and a base file name of app.log, you would get app.log, +app.log.1, app.log.2, up to app.log.5. The file being +written to is always app.log. When this file is filled, it is closed +and renamed to app.log.1, and if files app.log.1, +app.log.2, etc. exist, then they are renamed to app.log.2, +app.log.3 etc. respectively.

    +
    +

    Changed in version 3.6: As well as string values, Path objects are also accepted +for the filename argument.

    +
    +
    +
    +doRollover()
    +

    Does a rollover, as described above.

    +
    + +
    +
    +emit(record)
    +

    Outputs the record to the file, catering for rollover as described +previously.

    +
    + +
    + +
    +
    +

    TimedRotatingFileHandler

    +

    The TimedRotatingFileHandler class, located in the +logging.handlers module, supports rotation of disk log files at certain +timed intervals.

    +
    +
    +class logging.handlers.TimedRotatingFileHandler(filename, when='h', interval=1, backupCount=0, encoding=None, delay=False, utc=False, atTime=None)
    +

    Returns a new instance of the TimedRotatingFileHandler class. The +specified file is opened and used as the stream for logging. On rotating it also +sets the filename suffix. Rotating happens based on the product of when and +interval.

    +

    You can use the when to specify the type of interval. The list of possible +values is below. Note that they are not case sensitive.

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Value

    Type of interval

    If/how atTime is used

    'S'

    Seconds

    Ignored

    'M'

    Minutes

    Ignored

    'H'

    Hours

    Ignored

    'D'

    Days

    Ignored

    'W0'-'W6'

    Weekday (0=Monday)

    Used to compute initial +rollover time

    'midnight'

    Roll over at midnight, if +atTime not specified, +else at time atTime

    Used to compute initial +rollover time

    +

    When using weekday-based rotation, specify ‘W0’ for Monday, ‘W1’ for +Tuesday, and so on up to ‘W6’ for Sunday. In this case, the value passed for +interval isn’t used.

    +

    The system will save old log files by appending extensions to the filename. +The extensions are date-and-time based, using the strftime format +%Y-%m-%d_%H-%M-%S or a leading portion thereof, depending on the +rollover interval.

    +

    When computing the next rollover time for the first time (when the handler +is created), the last modification time of an existing log file, or else +the current time, is used to compute when the next rotation will occur.

    +

    If the utc argument is true, times in UTC will be used; otherwise +local time is used.

    +

    If backupCount is nonzero, at most backupCount files +will be kept, and if more would be created when rollover occurs, the oldest +one is deleted. The deletion logic uses the interval to determine which +files to delete, so changing the interval may leave old files lying around.

    +

    If delay is true, then file opening is deferred until the first call to +emit().

    +

    If atTime is not None, it must be a datetime.time instance which +specifies the time of day when rollover occurs, for the cases where rollover +is set to happen “at midnight” or “on a particular weekday”. Note that in +these cases, the atTime value is effectively used to compute the initial +rollover, and subsequent rollovers would be calculated via the normal +interval calculation.

    +
    +

    Note

    +

    Calculation of the initial rollover time is done when the handler +is initialised. Calculation of subsequent rollover times is done only +when rollover occurs, and rollover occurs only when emitting output. If +this is not kept in mind, it might lead to some confusion. For example, +if an interval of “every minute” is set, that does not mean you will +always see log files with times (in the filename) separated by a minute; +if, during application execution, logging output is generated more +frequently than once a minute, then you can expect to see log files +with times separated by a minute. If, on the other hand, logging messages +are only output once every five minutes (say), then there will be gaps in +the file times corresponding to the minutes where no output (and hence no +rollover) occurred.

    +
    +
    +

    Changed in version 3.4: atTime parameter was added.

    +
    +
    +

    Changed in version 3.6: As well as string values, Path objects are also accepted +for the filename argument.

    +
    +
    +
    +doRollover()
    +

    Does a rollover, as described above.

    +
    + +
    +
    +emit(record)
    +

    Outputs the record to the file, catering for rollover as described above.

    +
    + +
    + +
    +
    +

    SocketHandler

    +

    The SocketHandler class, located in the logging.handlers module, +sends logging output to a network socket. The base class uses a TCP socket.

    +
    +
    +class logging.handlers.SocketHandler(host, port)
    +

    Returns a new instance of the SocketHandler class intended to +communicate with a remote machine whose address is given by host and port.

    +
    +

    Changed in version 3.4: If port is specified as None, a Unix domain socket is created +using the value in host - otherwise, a TCP socket is created.

    +
    +
    +
    +close()
    +

    Closes the socket.

    +
    + +
    +
    +emit()
    +

    Pickles the record’s attribute dictionary and writes it to the socket in +binary format. If there is an error with the socket, silently drops the +packet. If the connection was previously lost, re-establishes the +connection. To unpickle the record at the receiving end into a +LogRecord, use the makeLogRecord() +function.

    +
    + +
    +
    +handleError()
    +

    Handles an error which has occurred during emit(). The most likely +cause is a lost connection. Closes the socket so that we can retry on the +next event.

    +
    + +
    +
    +makeSocket()
    +

    This is a factory method which allows subclasses to define the precise +type of socket they want. The default implementation creates a TCP socket +(socket.SOCK_STREAM).

    +
    + +
    +
    +makePickle(record)
    +

    Pickles the record’s attribute dictionary in binary format with a length +prefix, and returns it ready for transmission across the socket. The +details of this operation are equivalent to:

    +
    data = pickle.dumps(record_attr_dict, 1)
    +datalen = struct.pack('>L', len(data))
    +return datalen + data
    +
    +
    +

    Note that pickles aren’t completely secure. If you are concerned about +security, you may want to override this method to implement a more secure +mechanism. For example, you can sign pickles using HMAC and then verify +them on the receiving end, or alternatively you can disable unpickling of +global objects on the receiving end.

    +
    + +
    +
    +send(packet)
    +

    Send a pickled byte-string packet to the socket. The format of the sent +byte-string is as described in the documentation for +makePickle().

    +

    This function allows for partial sends, which can happen when the network +is busy.

    +
    + +
    +
    +createSocket()
    +

    Tries to create a socket; on failure, uses an exponential back-off +algorithm. On initial failure, the handler will drop the message it was +trying to send. When subsequent messages are handled by the same +instance, it will not try connecting until some time has passed. The +default parameters are such that the initial delay is one second, and if +after that delay the connection still can’t be made, the handler will +double the delay each time up to a maximum of 30 seconds.

    +

    This behaviour is controlled by the following handler attributes:

    +
      +
    • retryStart (initial delay, defaulting to 1.0 seconds).

    • +
    • retryFactor (multiplier, defaulting to 2.0).

    • +
    • retryMax (maximum delay, defaulting to 30.0 seconds).

    • +
    +

    This means that if the remote listener starts up after the handler has +been used, you could lose messages (since the handler won’t even attempt +a connection until the delay has elapsed, but just silently drop messages +during the delay period).

    +
    + +
    + +
    +
    +

    DatagramHandler

    +

    The DatagramHandler class, located in the logging.handlers +module, inherits from SocketHandler to support sending logging messages +over UDP sockets.

    +
    +
    +class logging.handlers.DatagramHandler(host, port)
    +

    Returns a new instance of the DatagramHandler class intended to +communicate with a remote machine whose address is given by host and port.

    +
    +

    Changed in version 3.4: If port is specified as None, a Unix domain socket is created +using the value in host - otherwise, a UDP socket is created.

    +
    +
    +
    +emit()
    +

    Pickles the record’s attribute dictionary and writes it to the socket in +binary format. If there is an error with the socket, silently drops the +packet. To unpickle the record at the receiving end into a +LogRecord, use the makeLogRecord() +function.

    +
    + +
    +
    +makeSocket()
    +

    The factory method of SocketHandler is here overridden to create +a UDP socket (socket.SOCK_DGRAM).

    +
    + +
    +
    +send(s)
    +

    Send a pickled byte-string to a socket. The format of the sent byte-string +is as described in the documentation for SocketHandler.makePickle().

    +
    + +
    + +
    +
    +

    SysLogHandler

    +

    The SysLogHandler class, located in the logging.handlers module, +supports sending logging messages to a remote or local Unix syslog.

    +
    +
    +class logging.handlers.SysLogHandler(address=('localhost', SYSLOG_UDP_PORT), facility=LOG_USER, socktype=socket.SOCK_DGRAM)
    +

    Returns a new instance of the SysLogHandler class intended to +communicate with a remote Unix machine whose address is given by address in +the form of a (host, port) tuple. If address is not specified, +('localhost', 514) is used. The address is used to open a socket. An +alternative to providing a (host, port) tuple is providing an address as a +string, for example ‘/dev/log’. In this case, a Unix domain socket is used to +send the message to the syslog. If facility is not specified, +LOG_USER is used. The type of socket opened depends on the +socktype argument, which defaults to socket.SOCK_DGRAM and thus +opens a UDP socket. To open a TCP socket (for use with the newer syslog +daemons such as rsyslog), specify a value of socket.SOCK_STREAM.

    +

    Note that if your server is not listening on UDP port 514, +SysLogHandler may appear not to work. In that case, check what +address you should be using for a domain socket - it’s system dependent. +For example, on Linux it’s usually ‘/dev/log’ but on OS/X it’s +‘/var/run/syslog’. You’ll need to check your platform and use the +appropriate address (you may need to do this check at runtime if your +application needs to run on several platforms). On Windows, you pretty +much have to use the UDP option.

    +
    +

    Changed in version 3.2: socktype was added.

    +
    +
    +
    +close()
    +

    Closes the socket to the remote host.

    +
    + +
    +
    +emit(record)
    +

    The record is formatted, and then sent to the syslog server. If exception +information is present, it is not sent to the server.

    +
    +

    Changed in version 3.2.1: (See: bpo-12168.) In earlier versions, the message sent to the +syslog daemons was always terminated with a NUL byte, because early +versions of these daemons expected a NUL terminated message - even +though it’s not in the relevant specification (RFC 5424). More recent +versions of these daemons don’t expect the NUL byte but strip it off +if it’s there, and even more recent daemons (which adhere more closely +to RFC 5424) pass the NUL byte on as part of the message.

    +

    To enable easier handling of syslog messages in the face of all these +differing daemon behaviours, the appending of the NUL byte has been +made configurable, through the use of a class-level attribute, +append_nul. This defaults to True (preserving the existing +behaviour) but can be set to False on a SysLogHandler instance +in order for that instance to not append the NUL terminator.

    +
    +
    +

    Changed in version 3.3: (See: bpo-12419.) In earlier versions, there was no facility for +an “ident” or “tag” prefix to identify the source of the message. This +can now be specified using a class-level attribute, defaulting to +"" to preserve existing behaviour, but which can be overridden on +a SysLogHandler instance in order for that instance to prepend +the ident to every message handled. Note that the provided ident must +be text, not bytes, and is prepended to the message exactly as is.

    +
    +
    + +
    +
    +encodePriority(facility, priority)
    +

    Encodes the facility and priority into an integer. You can pass in strings +or integers - if strings are passed, internal mapping dictionaries are +used to convert them to integers.

    +

    The symbolic LOG_ values are defined in SysLogHandler and +mirror the values defined in the sys/syslog.h header file.

    +

    Priorities

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Name (string)

    Symbolic value

    alert

    LOG_ALERT

    crit or critical

    LOG_CRIT

    debug

    LOG_DEBUG

    emerg or panic

    LOG_EMERG

    err or error

    LOG_ERR

    info

    LOG_INFO

    notice

    LOG_NOTICE

    warn or warning

    LOG_WARNING

    +

    Facilities

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Name (string)

    Symbolic value

    auth

    LOG_AUTH

    authpriv

    LOG_AUTHPRIV

    cron

    LOG_CRON

    daemon

    LOG_DAEMON

    ftp

    LOG_FTP

    kern

    LOG_KERN

    lpr

    LOG_LPR

    mail

    LOG_MAIL

    news

    LOG_NEWS

    syslog

    LOG_SYSLOG

    user

    LOG_USER

    uucp

    LOG_UUCP

    local0

    LOG_LOCAL0

    local1

    LOG_LOCAL1

    local2

    LOG_LOCAL2

    local3

    LOG_LOCAL3

    local4

    LOG_LOCAL4

    local5

    LOG_LOCAL5

    local6

    LOG_LOCAL6

    local7

    LOG_LOCAL7

    +
    + +
    +
    +mapPriority(levelname)
    +

    Maps a logging level name to a syslog priority name. +You may need to override this if you are using custom levels, or +if the default algorithm is not suitable for your needs. The +default algorithm maps DEBUG, INFO, WARNING, ERROR and +CRITICAL to the equivalent syslog names, and all other level +names to ‘warning’.

    +
    + +
    + +
    +
    +

    NTEventLogHandler

    +

    The NTEventLogHandler class, located in the logging.handlers +module, supports sending logging messages to a local Windows NT, Windows 2000 or +Windows XP event log. Before you can use it, you need Mark Hammond’s Win32 +extensions for Python installed.

    +
    +
    +class logging.handlers.NTEventLogHandler(appname, dllname=None, logtype='Application')
    +

    Returns a new instance of the NTEventLogHandler class. The appname is +used to define the application name as it appears in the event log. An +appropriate registry entry is created using this name. The dllname should give +the fully qualified pathname of a .dll or .exe which contains message +definitions to hold in the log (if not specified, 'win32service.pyd' is used +- this is installed with the Win32 extensions and contains some basic +placeholder message definitions. Note that use of these placeholders will make +your event logs big, as the entire message source is held in the log. If you +want slimmer logs, you have to pass in the name of your own .dll or .exe which +contains the message definitions you want to use in the event log). The +logtype is one of 'Application', 'System' or 'Security', and +defaults to 'Application'.

    +
    +
    +close()
    +

    At this point, you can remove the application name from the registry as a +source of event log entries. However, if you do this, you will not be able +to see the events as you intended in the Event Log Viewer - it needs to be +able to access the registry to get the .dll name. The current version does +not do this.

    +
    + +
    +
    +emit(record)
    +

    Determines the message ID, event category and event type, and then logs +the message in the NT event log.

    +
    + +
    +
    +getEventCategory(record)
    +

    Returns the event category for the record. Override this if you want to +specify your own categories. This version returns 0.

    +
    + +
    +
    +getEventType(record)
    +

    Returns the event type for the record. Override this if you want to +specify your own types. This version does a mapping using the handler’s +typemap attribute, which is set up in __init__() to a dictionary +which contains mappings for DEBUG, INFO, +WARNING, ERROR and CRITICAL. If you are using +your own levels, you will either need to override this method or place a +suitable dictionary in the handler’s typemap attribute.

    +
    + +
    +
    +getMessageID(record)
    +

    Returns the message ID for the record. If you are using your own messages, +you could do this by having the msg passed to the logger being an ID +rather than a format string. Then, in here, you could use a dictionary +lookup to get the message ID. This version returns 1, which is the base +message ID in win32service.pyd.

    +
    + +
    + +
    +
    +

    SMTPHandler

    +

    The SMTPHandler class, located in the logging.handlers module, +supports sending logging messages to an email address via SMTP.

    +
    +
    +class logging.handlers.SMTPHandler(mailhost, fromaddr, toaddrs, subject, credentials=None, secure=None, timeout=1.0)
    +

    Returns a new instance of the SMTPHandler class. The instance is +initialized with the from and to addresses and subject line of the email. The +toaddrs should be a list of strings. To specify a non-standard SMTP port, use +the (host, port) tuple format for the mailhost argument. If you use a string, +the standard SMTP port is used. If your SMTP server requires authentication, you +can specify a (username, password) tuple for the credentials argument.

    +

    To specify the use of a secure protocol (TLS), pass in a tuple to the +secure argument. This will only be used when authentication credentials are +supplied. The tuple should be either an empty tuple, or a single-value tuple +with the name of a keyfile, or a 2-value tuple with the names of the keyfile +and certificate file. (This tuple is passed to the +smtplib.SMTP.starttls() method.)

    +

    A timeout can be specified for communication with the SMTP server using the +timeout argument.

    +
    +

    New in version 3.3: The timeout argument was added.

    +
    +
    +
    +emit(record)
    +

    Formats the record and sends it to the specified addressees.

    +
    + +
    +
    +getSubject(record)
    +

    If you want to specify a subject line which is record-dependent, override +this method.

    +
    + +
    + +
    +
    +

    MemoryHandler

    +

    The MemoryHandler class, located in the logging.handlers module, +supports buffering of logging records in memory, periodically flushing them to a +target handler. Flushing occurs whenever the buffer is full, or when an +event of a certain severity or greater is seen.

    +

    MemoryHandler is a subclass of the more general +BufferingHandler, which is an abstract class. This buffers logging +records in memory. Whenever each record is added to the buffer, a check is made +by calling shouldFlush() to see if the buffer should be flushed. If it +should, then flush() is expected to do the flushing.

    +
    +
    +class logging.handlers.BufferingHandler(capacity)
    +

    Initializes the handler with a buffer of the specified capacity. Here, +capacity means the number of logging records buffered.

    +
    +
    +emit(record)
    +

    Appends the record to the buffer. If shouldFlush() returns true, +calls flush() to process the buffer.

    +
    + +
    +
    +flush()
    +

    You can override this to implement custom flushing behavior. This version +just zaps the buffer to empty.

    +
    + +
    +
    +shouldFlush(record)
    +

    Returns true if the buffer is up to capacity. This method can be +overridden to implement custom flushing strategies.

    +
    + +
    + +
    +
    +class logging.handlers.MemoryHandler(capacity, flushLevel=ERROR, target=None, flushOnClose=True)
    +

    Returns a new instance of the MemoryHandler class. The instance is +initialized with a buffer size of capacity (number of records buffered). +If flushLevel is not specified, ERROR is used. If no target is +specified, the target will need to be set using setTarget() before this +handler does anything useful. If flushOnClose is specified as False, +then the buffer is not flushed when the handler is closed. If not specified +or specified as True, the previous behaviour of flushing the buffer will +occur when the handler is closed.

    +
    +

    Changed in version 3.6: The flushOnClose parameter was added.

    +
    +
    +
    +close()
    +

    Calls flush(), sets the target to None and clears the +buffer.

    +
    + +
    +
    +flush()
    +

    For a MemoryHandler, flushing means just sending the buffered +records to the target, if there is one. The buffer is also cleared when +this happens. Override if you want different behavior.

    +
    + +
    +
    +setTarget(target)
    +

    Sets the target handler for this handler.

    +
    + +
    +
    +shouldFlush(record)
    +

    Checks for buffer full or a record at the flushLevel or higher.

    +
    + +
    + +
    +
    +

    HTTPHandler

    +

    The HTTPHandler class, located in the logging.handlers module, +supports sending logging messages to a Web server, using either GET or +POST semantics.

    +
    +
    +class logging.handlers.HTTPHandler(host, url, method='GET', secure=False, credentials=None, context=None)
    +

    Returns a new instance of the HTTPHandler class. The host can be +of the form host:port, should you need to use a specific port number. If +no method is specified, GET is used. If secure is true, a HTTPS +connection will be used. The context parameter may be set to a +ssl.SSLContext instance to configure the SSL settings used for the +HTTPS connection. If credentials is specified, it should be a 2-tuple +consisting of userid and password, which will be placed in a HTTP +‘Authorization’ header using Basic authentication. If you specify +credentials, you should also specify secure=True so that your userid and +password are not passed in cleartext across the wire.

    +
    +

    Changed in version 3.5: The context parameter was added.

    +
    +
    +
    +mapLogRecord(record)
    +

    Provides a dictionary, based on record, which is to be URL-encoded +and sent to the web server. The default implementation just returns +record.__dict__. This method can be overridden if e.g. only a +subset of LogRecord is to be sent to the web server, or +if more specific customization of what’s sent to the server is required.

    +
    + +
    +
    +emit(record)
    +

    Sends the record to the Web server as a URL-encoded dictionary. The +mapLogRecord() method is used to convert the record to the +dictionary to be sent.

    +
    + +
    +

    Note

    +

    Since preparing a record for sending it to a Web server is not +the same as a generic formatting operation, using +setFormatter() to specify a +Formatter for a HTTPHandler has no effect. +Instead of calling format(), this handler calls +mapLogRecord() and then urllib.parse.urlencode() to encode the +dictionary in a form suitable for sending to a Web server.

    +
    +
    + +
    +
    +

    QueueHandler

    +
    +

    New in version 3.2.

    +
    +

    The QueueHandler class, located in the logging.handlers module, +supports sending logging messages to a queue, such as those implemented in the +queue or multiprocessing modules.

    +

    Along with the QueueListener class, QueueHandler can be used +to let handlers do their work on a separate thread from the one which does the +logging. This is important in Web applications and also other service +applications where threads servicing clients need to respond as quickly as +possible, while any potentially slow operations (such as sending an email via +SMTPHandler) are done on a separate thread.

    +
    +
    +class logging.handlers.QueueHandler(queue)
    +

    Returns a new instance of the QueueHandler class. The instance is +initialized with the queue to send messages to. The queue can be any +queue-like object; it’s used as-is by the enqueue() method, which +needs to know how to send messages to it. The queue is not required to +have the task tracking API, which means that you can use +SimpleQueue instances for queue.

    +
    +
    +emit(record)
    +

    Enqueues the result of preparing the LogRecord. Should an exception +occur (e.g. because a bounded queue has filled up), the +handleError() method is called to handle the +error. This can result in the record silently being dropped (if +logging.raiseExceptions is False) or a message printed to +sys.stderr (if logging.raiseExceptions is True).

    +
    + +
    +
    +prepare(record)
    +

    Prepares a record for queuing. The object returned by this +method is enqueued.

    +

    The base implementation formats the record to merge the message, +arguments, and exception information, if present. It also +removes unpickleable items from the record in-place.

    +

    You might want to override this method if you want to convert +the record to a dict or JSON string, or send a modified copy +of the record while leaving the original intact.

    +
    + +
    +
    +enqueue(record)
    +

    Enqueues the record on the queue using put_nowait(); you may +want to override this if you want to use blocking behaviour, or a +timeout, or a customized queue implementation.

    +
    + +
    + +
    +
    +

    QueueListener

    +
    +

    New in version 3.2.

    +
    +

    The QueueListener class, located in the logging.handlers +module, supports receiving logging messages from a queue, such as those +implemented in the queue or multiprocessing modules. The +messages are received from a queue in an internal thread and passed, on +the same thread, to one or more handlers for processing. While +QueueListener is not itself a handler, it is documented here +because it works hand-in-hand with QueueHandler.

    +

    Along with the QueueHandler class, QueueListener can be used +to let handlers do their work on a separate thread from the one which does the +logging. This is important in Web applications and also other service +applications where threads servicing clients need to respond as quickly as +possible, while any potentially slow operations (such as sending an email via +SMTPHandler) are done on a separate thread.

    +
    +
    +class logging.handlers.QueueListener(queue, *handlers, respect_handler_level=False)
    +

    Returns a new instance of the QueueListener class. The instance is +initialized with the queue to send messages to and a list of handlers which +will handle entries placed on the queue. The queue can be any queue-like +object; it’s passed as-is to the dequeue() method, which needs +to know how to get messages from it. The queue is not required to have the +task tracking API (though it’s used if available), which means that you can +use SimpleQueue instances for queue.

    +

    If respect_handler_level is True, a handler’s level is respected +(compared with the level for the message) when deciding whether to pass +messages to that handler; otherwise, the behaviour is as in previous Python +versions - to always pass each message to each handler.

    +
    +

    Changed in version 3.5: The respect_handler_levels argument was added.

    +
    +
    +
    +dequeue(block)
    +

    Dequeues a record and return it, optionally blocking.

    +

    The base implementation uses get(). You may want to override this +method if you want to use timeouts or work with custom queue +implementations.

    +
    + +
    +
    +prepare(record)
    +

    Prepare a record for handling.

    +

    This implementation just returns the passed-in record. You may want to +override this method if you need to do any custom marshalling or +manipulation of the record before passing it to the handlers.

    +
    + +
    +
    +handle(record)
    +

    Handle a record.

    +

    This just loops through the handlers offering them the record +to handle. The actual object passed to the handlers is that which +is returned from prepare().

    +
    + +
    +
    +start()
    +

    Starts the listener.

    +

    This starts up a background thread to monitor the queue for +LogRecords to process.

    +
    + +
    +
    +stop()
    +

    Stops the listener.

    +

    This asks the thread to terminate, and then waits for it to do so. +Note that if you don’t call this before your application exits, there +may be some records still left on the queue, which won’t be processed.

    +
    + +
    +
    +enqueue_sentinel()
    +

    Writes a sentinel to the queue to tell the listener to quit. This +implementation uses put_nowait(). You may want to override this +method if you want to use timeouts or work with custom queue +implementations.

    +
    +

    New in version 3.3.

    +
    +
    + +
    + +
    +

    See also

    +
    +
    Module logging

    API reference for the logging module.

    +
    +
    Module logging.config

    Configuration API for the logging module.

    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/logging.html b/python-3.7.4-docs-html/library/logging.html new file mode 100644 index 0000000..fe68979 --- /dev/null +++ b/python-3.7.4-docs-html/library/logging.html @@ -0,0 +1,1603 @@ + + + + + + + logging — Logging facility for Python — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    logging — Logging facility for Python

    +

    Source code: Lib/logging/__init__.py

    + +
    +

    This module defines functions and classes which implement a flexible event +logging system for applications and libraries.

    +

    The key benefit of having the logging API provided by a standard library module +is that all Python modules can participate in logging, so your application log +can include your own messages integrated with messages from third-party +modules.

    +

    The module provides a lot of functionality and flexibility. If you are +unfamiliar with logging, the best way to get to grips with it is to see the +tutorials (see the links on the right).

    +

    The basic classes defined by the module, together with their functions, are +listed below.

    +
      +
    • Loggers expose the interface that application code directly uses.

    • +
    • Handlers send the log records (created by loggers) to the appropriate +destination.

    • +
    • Filters provide a finer grained facility for determining which log records +to output.

    • +
    • Formatters specify the layout of log records in the final output.

    • +
    +
    +

    Logger Objects

    +

    Loggers have the following attributes and methods. Note that Loggers should +NEVER be instantiated directly, but always through the module-level function +logging.getLogger(name). Multiple calls to getLogger() with the same +name will always return a reference to the same Logger object.

    +

    The name is potentially a period-separated hierarchical value, like +foo.bar.baz (though it could also be just plain foo, for example). +Loggers that are further down in the hierarchical list are children of loggers +higher up in the list. For example, given a logger with a name of foo, +loggers with names of foo.bar, foo.bar.baz, and foo.bam are all +descendants of foo. The logger name hierarchy is analogous to the Python +package hierarchy, and identical to it if you organise your loggers on a +per-module basis using the recommended construction +logging.getLogger(__name__). That’s because in a module, __name__ +is the module’s name in the Python package namespace.

    +
    +
    +class logging.Logger
    +
    +
    +propagate
    +

    If this attribute evaluates to true, events logged to this logger will be +passed to the handlers of higher level (ancestor) loggers, in addition to +any handlers attached to this logger. Messages are passed directly to the +ancestor loggers’ handlers - neither the level nor filters of the ancestor +loggers in question are considered.

    +

    If this evaluates to false, logging messages are not passed to the handlers +of ancestor loggers.

    +

    The constructor sets this attribute to True.

    +
    +

    Note

    +

    If you attach a handler to a logger and one or more of its +ancestors, it may emit the same record multiple times. In general, you +should not need to attach a handler to more than one logger - if you just +attach it to the appropriate logger which is highest in the logger +hierarchy, then it will see all events logged by all descendant loggers, +provided that their propagate setting is left set to True. A common +scenario is to attach handlers only to the root logger, and to let +propagation take care of the rest.

    +
    +
    + +
    +
    +setLevel(level)
    +

    Sets the threshold for this logger to level. Logging messages which are less +severe than level will be ignored; logging messages which have severity level +or higher will be emitted by whichever handler or handlers service this logger, +unless a handler’s level has been set to a higher severity level than level.

    +

    When a logger is created, the level is set to NOTSET (which causes +all messages to be processed when the logger is the root logger, or delegation +to the parent when the logger is a non-root logger). Note that the root logger +is created with level WARNING.

    +

    The term ‘delegation to the parent’ means that if a logger has a level of +NOTSET, its chain of ancestor loggers is traversed until either an ancestor with +a level other than NOTSET is found, or the root is reached.

    +

    If an ancestor is found with a level other than NOTSET, then that ancestor’s +level is treated as the effective level of the logger where the ancestor search +began, and is used to determine how a logging event is handled.

    +

    If the root is reached, and it has a level of NOTSET, then all messages will be +processed. Otherwise, the root’s level will be used as the effective level.

    +

    See Logging Levels for a list of levels.

    +
    +

    Changed in version 3.2: The level parameter now accepts a string representation of the +level such as ‘INFO’ as an alternative to the integer constants +such as INFO. Note, however, that levels are internally stored +as integers, and methods such as e.g. getEffectiveLevel() and +isEnabledFor() will return/expect to be passed integers.

    +
    +
    + +
    +
    +isEnabledFor(lvl)
    +

    Indicates if a message of severity lvl would be processed by this logger. +This method checks first the module-level level set by +logging.disable(lvl) and then the logger’s effective level as determined +by getEffectiveLevel().

    +
    + +
    +
    +getEffectiveLevel()
    +

    Indicates the effective level for this logger. If a value other than +NOTSET has been set using setLevel(), it is returned. Otherwise, +the hierarchy is traversed towards the root until a value other than +NOTSET is found, and that value is returned. The value returned is +an integer, typically one of logging.DEBUG, logging.INFO +etc.

    +
    + +
    +
    +getChild(suffix)
    +

    Returns a logger which is a descendant to this logger, as determined by the suffix. +Thus, logging.getLogger('abc').getChild('def.ghi') would return the same +logger as would be returned by logging.getLogger('abc.def.ghi'). This is a +convenience method, useful when the parent logger is named using e.g. __name__ +rather than a literal string.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +debug(msg, *args, **kwargs)
    +

    Logs a message with level DEBUG on this logger. The msg is the +message format string, and the args are the arguments which are merged into +msg using the string formatting operator. (Note that this means that you can +use keywords in the format string, together with a single dictionary argument.)

    +

    There are three keyword arguments in kwargs which are inspected: +exc_info, stack_info, and extra.

    +

    If exc_info does not evaluate as false, it causes exception information to be +added to the logging message. If an exception tuple (in the format returned by +sys.exc_info()) or an exception instance is provided, it is used; +otherwise, sys.exc_info() is called to get the exception information.

    +

    The second optional keyword argument is stack_info, which defaults to +False. If true, stack information is added to the logging +message, including the actual logging call. Note that this is not the same +stack information as that displayed through specifying exc_info: The +former is stack frames from the bottom of the stack up to the logging call +in the current thread, whereas the latter is information about stack frames +which have been unwound, following an exception, while searching for +exception handlers.

    +

    You can specify stack_info independently of exc_info, e.g. to just show +how you got to a certain point in your code, even when no exceptions were +raised. The stack frames are printed following a header line which says:

    +
    Stack (most recent call last):
    +
    +
    +

    This mimics the Traceback (most recent call last): which is used when +displaying exception frames.

    +

    The third keyword argument is extra which can be used to pass a +dictionary which is used to populate the __dict__ of the LogRecord created for +the logging event with user-defined attributes. These custom attributes can then +be used as you like. For example, they could be incorporated into logged +messages. For example:

    +
    FORMAT = '%(asctime)-15s %(clientip)s %(user)-8s %(message)s'
    +logging.basicConfig(format=FORMAT)
    +d = {'clientip': '192.168.0.1', 'user': 'fbloggs'}
    +logger = logging.getLogger('tcpserver')
    +logger.warning('Protocol problem: %s', 'connection reset', extra=d)
    +
    +
    +

    would print something like

    +
    2006-02-08 22:20:02,165 192.168.0.1 fbloggs  Protocol problem: connection reset
    +
    +
    +

    The keys in the dictionary passed in extra should not clash with the keys used +by the logging system. (See the Formatter documentation for more +information on which keys are used by the logging system.)

    +

    If you choose to use these attributes in logged messages, you need to exercise +some care. In the above example, for instance, the Formatter has been +set up with a format string which expects ‘clientip’ and ‘user’ in the attribute +dictionary of the LogRecord. If these are missing, the message will not be +logged because a string formatting exception will occur. So in this case, you +always need to pass the extra dictionary with these keys.

    +

    While this might be annoying, this feature is intended for use in specialized +circumstances, such as multi-threaded servers where the same code executes in +many contexts, and interesting conditions which arise are dependent on this +context (such as remote client IP address and authenticated user name, in the +above example). In such circumstances, it is likely that specialized +Formatters would be used with particular Handlers.

    +
    +

    New in version 3.2: The stack_info parameter was added.

    +
    +
    +

    Changed in version 3.5: The exc_info parameter can now accept exception instances.

    +
    +
    + +
    +
    +info(msg, *args, **kwargs)
    +

    Logs a message with level INFO on this logger. The arguments are +interpreted as for debug().

    +
    + +
    +
    +warning(msg, *args, **kwargs)
    +

    Logs a message with level WARNING on this logger. The arguments are +interpreted as for debug().

    +
    +

    Note

    +

    There is an obsolete method warn which is functionally +identical to warning. As warn is deprecated, please do not use +it - use warning instead.

    +
    +
    + +
    +
    +error(msg, *args, **kwargs)
    +

    Logs a message with level ERROR on this logger. The arguments are +interpreted as for debug().

    +
    + +
    +
    +critical(msg, *args, **kwargs)
    +

    Logs a message with level CRITICAL on this logger. The arguments are +interpreted as for debug().

    +
    + +
    +
    +log(lvl, msg, *args, **kwargs)
    +

    Logs a message with integer level lvl on this logger. The other arguments are +interpreted as for debug().

    +
    + +
    +
    +exception(msg, *args, **kwargs)
    +

    Logs a message with level ERROR on this logger. The arguments are +interpreted as for debug(). Exception info is added to the logging +message. This method should only be called from an exception handler.

    +
    + +
    +
    +addFilter(filter)
    +

    Adds the specified filter filter to this logger.

    +
    + +
    +
    +removeFilter(filter)
    +

    Removes the specified filter filter from this logger.

    +
    + +
    +
    +filter(record)
    +

    Applies this logger’s filters to the record and returns a true value if the +record is to be processed. The filters are consulted in turn, until one of +them returns a false value. If none of them return a false value, the record +will be processed (passed to handlers). If one returns a false value, no +further processing of the record occurs.

    +
    + +
    +
    +addHandler(hdlr)
    +

    Adds the specified handler hdlr to this logger.

    +
    + +
    +
    +removeHandler(hdlr)
    +

    Removes the specified handler hdlr from this logger.

    +
    + +
    +
    +findCaller(stack_info=False)
    +

    Finds the caller’s source filename and line number. Returns the filename, line +number, function name and stack information as a 4-element tuple. The stack +information is returned as None unless stack_info is True.

    +
    + +
    +
    +handle(record)
    +

    Handles a record by passing it to all handlers associated with this logger and +its ancestors (until a false value of propagate is found). This method is used +for unpickled records received from a socket, as well as those created locally. +Logger-level filtering is applied using filter().

    +
    + +
    +
    +makeRecord(name, lvl, fn, lno, msg, args, exc_info, func=None, extra=None, sinfo=None)
    +

    This is a factory method which can be overridden in subclasses to create +specialized LogRecord instances.

    +
    + +
    +
    +hasHandlers()
    +

    Checks to see if this logger has any handlers configured. This is done by +looking for handlers in this logger and its parents in the logger hierarchy. +Returns True if a handler was found, else False. The method stops searching +up the hierarchy whenever a logger with the ‘propagate’ attribute set to +false is found - that will be the last logger which is checked for the +existence of handlers.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +

    Changed in version 3.7: Loggers can now be pickled and unpickled.

    +
    +
    + +
    +
    +

    Logging Levels

    +

    The numeric values of logging levels are given in the following table. These are +primarily of interest if you want to define your own levels, and need them to +have specific values relative to the predefined levels. If you define a level +with the same numeric value, it overwrites the predefined value; the predefined +name is lost.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + +

    Level

    Numeric value

    CRITICAL

    50

    ERROR

    40

    WARNING

    30

    INFO

    20

    DEBUG

    10

    NOTSET

    0

    +
    +
    +

    Handler Objects

    +

    Handlers have the following attributes and methods. Note that Handler +is never instantiated directly; this class acts as a base for more useful +subclasses. However, the __init__() method in subclasses needs to call +Handler.__init__().

    +
    +
    +class logging.Handler
    +
    +
    +__init__(level=NOTSET)
    +

    Initializes the Handler instance by setting its level, setting the list +of filters to the empty list and creating a lock (using createLock()) for +serializing access to an I/O mechanism.

    +
    + +
    +
    +createLock()
    +

    Initializes a thread lock which can be used to serialize access to underlying +I/O functionality which may not be threadsafe.

    +
    + +
    +
    +acquire()
    +

    Acquires the thread lock created with createLock().

    +
    + +
    +
    +release()
    +

    Releases the thread lock acquired with acquire().

    +
    + +
    +
    +setLevel(level)
    +

    Sets the threshold for this handler to level. Logging messages which are +less severe than level will be ignored. When a handler is created, the +level is set to NOTSET (which causes all messages to be +processed).

    +

    See Logging Levels for a list of levels.

    +
    +

    Changed in version 3.2: The level parameter now accepts a string representation of the +level such as ‘INFO’ as an alternative to the integer constants +such as INFO.

    +
    +
    + +
    +
    +setFormatter(fmt)
    +

    Sets the Formatter for this handler to fmt.

    +
    + +
    +
    +addFilter(filter)
    +

    Adds the specified filter filter to this handler.

    +
    + +
    +
    +removeFilter(filter)
    +

    Removes the specified filter filter from this handler.

    +
    + +
    +
    +filter(record)
    +

    Applies this handler’s filters to the record and returns a true value if the +record is to be processed. The filters are consulted in turn, until one of +them returns a false value. If none of them return a false value, the record +will be emitted. If one returns a false value, the handler will not emit the +record.

    +
    + +
    +
    +flush()
    +

    Ensure all logging output has been flushed. This version does nothing and is +intended to be implemented by subclasses.

    +
    + +
    +
    +close()
    +

    Tidy up any resources used by the handler. This version does no output but +removes the handler from an internal list of handlers which is closed when +shutdown() is called. Subclasses should ensure that this gets called +from overridden close() methods.

    +
    + +
    +
    +handle(record)
    +

    Conditionally emits the specified logging record, depending on filters which may +have been added to the handler. Wraps the actual emission of the record with +acquisition/release of the I/O thread lock.

    +
    + +
    +
    +handleError(record)
    +

    This method should be called from handlers when an exception is encountered +during an emit() call. If the module-level attribute +raiseExceptions is False, exceptions get silently ignored. This is +what is mostly wanted for a logging system - most users will not care about +errors in the logging system, they are more interested in application +errors. You could, however, replace this with a custom handler if you wish. +The specified record is the one which was being processed when the exception +occurred. (The default value of raiseExceptions is True, as that is +more useful during development).

    +
    + +
    +
    +format(record)
    +

    Do formatting for a record - if a formatter is set, use it. Otherwise, use the +default formatter for the module.

    +
    + +
    +
    +emit(record)
    +

    Do whatever it takes to actually log the specified logging record. This version +is intended to be implemented by subclasses and so raises a +NotImplementedError.

    +
    + +
    + +

    For a list of handlers included as standard, see logging.handlers.

    +
    +
    +

    Formatter Objects

    +

    Formatter objects have the following attributes and methods. They are +responsible for converting a LogRecord to (usually) a string which can +be interpreted by either a human or an external system. The base +Formatter allows a formatting string to be specified. If none is +supplied, the default value of '%(message)s' is used, which just includes +the message in the logging call. To have additional items of information in the +formatted output (such as a timestamp), keep reading.

    +

    A Formatter can be initialized with a format string which makes use of knowledge +of the LogRecord attributes - such as the default value mentioned above +making use of the fact that the user’s message and arguments are pre-formatted +into a LogRecord’s message attribute. This format string contains +standard Python %-style mapping keys. See section printf-style String Formatting +for more information on string formatting.

    +

    The useful mapping keys in a LogRecord are given in the section on +LogRecord attributes.

    +
    +
    +class logging.Formatter(fmt=None, datefmt=None, style='%')
    +

    Returns a new instance of the Formatter class. The instance is +initialized with a format string for the message as a whole, as well as a +format string for the date/time portion of a message. If no fmt is +specified, '%(message)s' is used. If no datefmt is specified, a format +is used which is described in the formatTime() documentation.

    +

    The style parameter can be one of ‘%’, ‘{‘ or ‘$’ and determines how +the format string will be merged with its data: using one of %-formatting, +str.format() or string.Template. See Using particular formatting styles throughout your application +for more information on using {- and $-formatting for log messages.

    +
    +

    Changed in version 3.2: The style parameter was added.

    +
    +
    +
    +format(record)
    +

    The record’s attribute dictionary is used as the operand to a string +formatting operation. Returns the resulting string. Before formatting the +dictionary, a couple of preparatory steps are carried out. The message +attribute of the record is computed using msg % args. If the +formatting string contains '(asctime)', formatTime() is called +to format the event time. If there is exception information, it is +formatted using formatException() and appended to the message. Note +that the formatted exception information is cached in attribute +exc_text. This is useful because the exception information can be +pickled and sent across the wire, but you should be careful if you have +more than one Formatter subclass which customizes the formatting +of exception information. In this case, you will have to clear the cached +value after a formatter has done its formatting, so that the next +formatter to handle the event doesn’t use the cached value but +recalculates it afresh.

    +

    If stack information is available, it’s appended after the exception +information, using formatStack() to transform it if necessary.

    +
    + +
    +
    +formatTime(record, datefmt=None)
    +

    This method should be called from format() by a formatter which +wants to make use of a formatted time. This method can be overridden in +formatters to provide for any specific requirement, but the basic behavior +is as follows: if datefmt (a string) is specified, it is used with +time.strftime() to format the creation time of the +record. Otherwise, the format ‘%Y-%m-%d %H:%M:%S,uuu’ is used, where the +uuu part is a millisecond value and the other letters are as per the +time.strftime() documentation. An example time in this format is +2003-01-23 00:29:50,411. The resulting string is returned.

    +

    This function uses a user-configurable function to convert the creation +time to a tuple. By default, time.localtime() is used; to change +this for a particular formatter instance, set the converter attribute +to a function with the same signature as time.localtime() or +time.gmtime(). To change it for all formatters, for example if you +want all logging times to be shown in GMT, set the converter +attribute in the Formatter class.

    +
    +

    Changed in version 3.3: Previously, the default format was hard-coded as in this example: +2010-09-06 22:38:15,292 where the part before the comma is +handled by a strptime format string ('%Y-%m-%d %H:%M:%S'), and the +part after the comma is a millisecond value. Because strptime does not +have a format placeholder for milliseconds, the millisecond value is +appended using another format string, '%s,%03d' — and both of these +format strings have been hardcoded into this method. With the change, +these strings are defined as class-level attributes which can be +overridden at the instance level when desired. The names of the +attributes are default_time_format (for the strptime format string) +and default_msec_format (for appending the millisecond value).

    +
    +
    + +
    +
    +formatException(exc_info)
    +

    Formats the specified exception information (a standard exception tuple as +returned by sys.exc_info()) as a string. This default implementation +just uses traceback.print_exception(). The resulting string is +returned.

    +
    + +
    +
    +formatStack(stack_info)
    +

    Formats the specified stack information (a string as returned by +traceback.print_stack(), but with the last newline removed) as a +string. This default implementation just returns the input value.

    +
    + +
    + +
    +
    +

    Filter Objects

    +

    Filters can be used by Handlers and Loggers for more sophisticated +filtering than is provided by levels. The base filter class only allows events +which are below a certain point in the logger hierarchy. For example, a filter +initialized with ‘A.B’ will allow events logged by loggers ‘A.B’, ‘A.B.C’, +‘A.B.C.D’, ‘A.B.D’ etc. but not ‘A.BB’, ‘B.A.B’ etc. If initialized with the +empty string, all events are passed.

    +
    +
    +class logging.Filter(name='')
    +

    Returns an instance of the Filter class. If name is specified, it +names a logger which, together with its children, will have its events allowed +through the filter. If name is the empty string, allows every event.

    +
    +
    +filter(record)
    +

    Is the specified record to be logged? Returns zero for no, nonzero for +yes. If deemed appropriate, the record may be modified in-place by this +method.

    +
    + +
    + +

    Note that filters attached to handlers are consulted before an event is +emitted by the handler, whereas filters attached to loggers are consulted +whenever an event is logged (using debug(), info(), +etc.), before sending an event to handlers. This means that events which have +been generated by descendant loggers will not be filtered by a logger’s filter +setting, unless the filter has also been applied to those descendant loggers.

    +

    You don’t actually need to subclass Filter: you can pass any instance +which has a filter method with the same semantics.

    +
    +

    Changed in version 3.2: You don’t need to create specialized Filter classes, or use other +classes with a filter method: you can use a function (or other +callable) as a filter. The filtering logic will check to see if the filter +object has a filter attribute: if it does, it’s assumed to be a +Filter and its filter() method is called. Otherwise, it’s +assumed to be a callable and called with the record as the single +parameter. The returned value should conform to that returned by +filter().

    +
    +

    Although filters are used primarily to filter records based on more +sophisticated criteria than levels, they get to see every record which is +processed by the handler or logger they’re attached to: this can be useful if +you want to do things like counting how many records were processed by a +particular logger or handler, or adding, changing or removing attributes in +the LogRecord being processed. Obviously changing the LogRecord needs to be +done with some care, but it does allow the injection of contextual information +into logs (see Using Filters to impart contextual information).

    +
    +
    +

    LogRecord Objects

    +

    LogRecord instances are created automatically by the Logger +every time something is logged, and can be created manually via +makeLogRecord() (for example, from a pickled event received over the +wire).

    +
    +
    +class logging.LogRecord(name, level, pathname, lineno, msg, args, exc_info, func=None, sinfo=None)
    +

    Contains all the information pertinent to the event being logged.

    +

    The primary information is passed in msg and args, which +are combined using msg % args to create the message field of the +record.

    +
    +
    Parameters
    +
      +
    • name – The name of the logger used to log the event represented by +this LogRecord. Note that this name will always have this +value, even though it may be emitted by a handler attached to +a different (ancestor) logger.

    • +
    • level – The numeric level of the logging event (one of DEBUG, INFO etc.) +Note that this is converted to two attributes of the LogRecord: +levelno for the numeric value and levelname for the +corresponding level name.

    • +
    • pathname – The full pathname of the source file where the logging call +was made.

    • +
    • lineno – The line number in the source file where the logging call was +made.

    • +
    • msg – The event description message, possibly a format string with +placeholders for variable data.

    • +
    • args – Variable data to merge into the msg argument to obtain the +event description.

    • +
    • exc_info – An exception tuple with the current exception information, +or None if no exception information is available.

    • +
    • func – The name of the function or method from which the logging call +was invoked.

    • +
    • sinfo – A text string representing stack information from the base of +the stack in the current thread, up to the logging call.

    • +
    +
    +
    +
    +
    +getMessage()
    +

    Returns the message for this LogRecord instance after merging any +user-supplied arguments with the message. If the user-supplied message +argument to the logging call is not a string, str() is called on it to +convert it to a string. This allows use of user-defined classes as +messages, whose __str__ method can return the actual format string to +be used.

    +
    + +
    +

    Changed in version 3.2: The creation of a LogRecord has been made more configurable by +providing a factory which is used to create the record. The factory can be +set using getLogRecordFactory() and setLogRecordFactory() +(see this for the factory’s signature).

    +
    +

    This functionality can be used to inject your own values into a +LogRecord at creation time. You can use the following pattern:

    +
    old_factory = logging.getLogRecordFactory()
    +
    +def record_factory(*args, **kwargs):
    +    record = old_factory(*args, **kwargs)
    +    record.custom_attribute = 0xdecafbad
    +    return record
    +
    +logging.setLogRecordFactory(record_factory)
    +
    +
    +

    With this pattern, multiple factories could be chained, and as long +as they don’t overwrite each other’s attributes or unintentionally +overwrite the standard attributes listed above, there should be no +surprises.

    +
    + +
    +
    +

    LogRecord attributes

    +

    The LogRecord has a number of attributes, most of which are derived from the +parameters to the constructor. (Note that the names do not always correspond +exactly between the LogRecord constructor parameters and the LogRecord +attributes.) These attributes can be used to merge data from the record into +the format string. The following table lists (in alphabetical order) the +attribute names, their meanings and the corresponding placeholder in a %-style +format string.

    +

    If you are using {}-formatting (str.format()), you can use +{attrname} as the placeholder in the format string. If you are using +$-formatting (string.Template), use the form ${attrname}. In +both cases, of course, replace attrname with the actual attribute name +you want to use.

    +

    In the case of {}-formatting, you can specify formatting flags by placing them +after the attribute name, separated from it with a colon. For example: a +placeholder of {msecs:03d} would format a millisecond value of 4 as +004. Refer to the str.format() documentation for full details on +the options available to you.

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Attribute name

    Format

    Description

    args

    You shouldn’t need to +format this yourself.

    The tuple of arguments merged into msg to +produce message, or a dict whose values +are used for the merge (when there is only one +argument, and it is a dictionary).

    asctime

    %(asctime)s

    Human-readable time when the +LogRecord was created. By default +this is of the form ‘2003-07-08 16:49:45,896’ +(the numbers after the comma are millisecond +portion of the time).

    created

    %(created)f

    Time when the LogRecord was created +(as returned by time.time()).

    exc_info

    You shouldn’t need to +format this yourself.

    Exception tuple (à la sys.exc_info) or, +if no exception has occurred, None.

    filename

    %(filename)s

    Filename portion of pathname.

    funcName

    %(funcName)s

    Name of function containing the logging call.

    levelname

    %(levelname)s

    Text logging level for the message +('DEBUG', 'INFO', 'WARNING', +'ERROR', 'CRITICAL').

    levelno

    %(levelno)s

    Numeric logging level for the message +(DEBUG, INFO, +WARNING, ERROR, +CRITICAL).

    lineno

    %(lineno)d

    Source line number where the logging call was +issued (if available).

    message

    %(message)s

    The logged message, computed as msg % +args. This is set when +Formatter.format() is invoked.

    module

    %(module)s

    Module (name portion of filename).

    msecs

    %(msecs)d

    Millisecond portion of the time when the +LogRecord was created.

    msg

    You shouldn’t need to +format this yourself.

    The format string passed in the original +logging call. Merged with args to +produce message, or an arbitrary object +(see Using arbitrary objects as messages).

    name

    %(name)s

    Name of the logger used to log the call.

    pathname

    %(pathname)s

    Full pathname of the source file where the +logging call was issued (if available).

    process

    %(process)d

    Process ID (if available).

    processName

    %(processName)s

    Process name (if available).

    relativeCreated

    %(relativeCreated)d

    Time in milliseconds when the LogRecord was +created, relative to the time the logging +module was loaded.

    stack_info

    You shouldn’t need to +format this yourself.

    Stack frame information (where available) +from the bottom of the stack in the current +thread, up to and including the stack frame +of the logging call which resulted in the +creation of this record.

    thread

    %(thread)d

    Thread ID (if available).

    threadName

    %(threadName)s

    Thread name (if available).

    +
    +

    Changed in version 3.1: processName was added.

    +
    +
    +
    +

    LoggerAdapter Objects

    +

    LoggerAdapter instances are used to conveniently pass contextual +information into logging calls. For a usage example, see the section on +adding contextual information to your logging output.

    +
    +
    +class logging.LoggerAdapter(logger, extra)
    +

    Returns an instance of LoggerAdapter initialized with an +underlying Logger instance and a dict-like object.

    +
    +
    +process(msg, kwargs)
    +

    Modifies the message and/or keyword arguments passed to a logging call in +order to insert contextual information. This implementation takes the object +passed as extra to the constructor and adds it to kwargs using key +‘extra’. The return value is a (msg, kwargs) tuple which has the +(possibly modified) versions of the arguments passed in.

    +
    + +
    + +

    In addition to the above, LoggerAdapter supports the following +methods of Logger: debug(), info(), +warning(), error(), exception(), +critical(), log(), isEnabledFor(), +getEffectiveLevel(), setLevel() and +hasHandlers(). These methods have the same signatures as their +counterparts in Logger, so you can use the two types of instances +interchangeably.

    +
    +

    Changed in version 3.2: The isEnabledFor(), getEffectiveLevel(), +setLevel() and hasHandlers() methods were added +to LoggerAdapter. These methods delegate to the underlying logger.

    +
    +
    +
    +

    Thread Safety

    +

    The logging module is intended to be thread-safe without any special work +needing to be done by its clients. It achieves this though using threading +locks; there is one lock to serialize access to the module’s shared data, and +each handler also creates a lock to serialize access to its underlying I/O.

    +

    If you are implementing asynchronous signal handlers using the signal +module, you may not be able to use logging from within such handlers. This is +because lock implementations in the threading module are not always +re-entrant, and so cannot be invoked from such signal handlers.

    +
    +
    +

    Module-Level Functions

    +

    In addition to the classes described above, there are a number of module-level +functions.

    +
    +
    +logging.getLogger(name=None)
    +

    Return a logger with the specified name or, if name is None, return a +logger which is the root logger of the hierarchy. If specified, the name is +typically a dot-separated hierarchical name like ‘a’, ‘a.b’ or ‘a.b.c.d’. +Choice of these names is entirely up to the developer who is using logging.

    +

    All calls to this function with a given name return the same logger instance. +This means that logger instances never need to be passed between different parts +of an application.

    +
    + +
    +
    +logging.getLoggerClass()
    +

    Return either the standard Logger class, or the last class passed to +setLoggerClass(). This function may be called from within a new class +definition, to ensure that installing a customized Logger class will +not undo customizations already applied by other code. For example:

    +
    class MyLogger(logging.getLoggerClass()):
    +    # ... override behaviour here
    +
    +
    +
    + +
    +
    +logging.getLogRecordFactory()
    +

    Return a callable which is used to create a LogRecord.

    +
    +

    New in version 3.2: This function has been provided, along with setLogRecordFactory(), +to allow developers more control over how the LogRecord +representing a logging event is constructed.

    +
    +

    See setLogRecordFactory() for more information about the how the +factory is called.

    +
    + +
    +
    +logging.debug(msg, *args, **kwargs)
    +

    Logs a message with level DEBUG on the root logger. The msg is the +message format string, and the args are the arguments which are merged into +msg using the string formatting operator. (Note that this means that you can +use keywords in the format string, together with a single dictionary argument.)

    +

    There are three keyword arguments in kwargs which are inspected: exc_info +which, if it does not evaluate as false, causes exception information to be +added to the logging message. If an exception tuple (in the format returned by +sys.exc_info()) or an exception instance is provided, it is used; +otherwise, sys.exc_info() is called to get the exception information.

    +

    The second optional keyword argument is stack_info, which defaults to +False. If true, stack information is added to the logging +message, including the actual logging call. Note that this is not the same +stack information as that displayed through specifying exc_info: The +former is stack frames from the bottom of the stack up to the logging call +in the current thread, whereas the latter is information about stack frames +which have been unwound, following an exception, while searching for +exception handlers.

    +

    You can specify stack_info independently of exc_info, e.g. to just show +how you got to a certain point in your code, even when no exceptions were +raised. The stack frames are printed following a header line which says:

    +
    Stack (most recent call last):
    +
    +
    +

    This mimics the Traceback (most recent call last): which is used when +displaying exception frames.

    +

    The third optional keyword argument is extra which can be used to pass a +dictionary which is used to populate the __dict__ of the LogRecord created for +the logging event with user-defined attributes. These custom attributes can then +be used as you like. For example, they could be incorporated into logged +messages. For example:

    +
    FORMAT = '%(asctime)-15s %(clientip)s %(user)-8s %(message)s'
    +logging.basicConfig(format=FORMAT)
    +d = {'clientip': '192.168.0.1', 'user': 'fbloggs'}
    +logging.warning('Protocol problem: %s', 'connection reset', extra=d)
    +
    +
    +

    would print something like:

    +
    2006-02-08 22:20:02,165 192.168.0.1 fbloggs  Protocol problem: connection reset
    +
    +
    +

    The keys in the dictionary passed in extra should not clash with the keys used +by the logging system. (See the Formatter documentation for more +information on which keys are used by the logging system.)

    +

    If you choose to use these attributes in logged messages, you need to exercise +some care. In the above example, for instance, the Formatter has been +set up with a format string which expects ‘clientip’ and ‘user’ in the attribute +dictionary of the LogRecord. If these are missing, the message will not be +logged because a string formatting exception will occur. So in this case, you +always need to pass the extra dictionary with these keys.

    +

    While this might be annoying, this feature is intended for use in specialized +circumstances, such as multi-threaded servers where the same code executes in +many contexts, and interesting conditions which arise are dependent on this +context (such as remote client IP address and authenticated user name, in the +above example). In such circumstances, it is likely that specialized +Formatters would be used with particular Handlers.

    +
    +

    New in version 3.2: The stack_info parameter was added.

    +
    +
    + +
    +
    +logging.info(msg, *args, **kwargs)
    +

    Logs a message with level INFO on the root logger. The arguments are +interpreted as for debug().

    +
    + +
    +
    +logging.warning(msg, *args, **kwargs)
    +

    Logs a message with level WARNING on the root logger. The arguments +are interpreted as for debug().

    +
    +

    Note

    +

    There is an obsolete function warn which is functionally +identical to warning. As warn is deprecated, please do not use +it - use warning instead.

    +
    +
    + +
    +
    +logging.error(msg, *args, **kwargs)
    +

    Logs a message with level ERROR on the root logger. The arguments are +interpreted as for debug().

    +
    + +
    +
    +logging.critical(msg, *args, **kwargs)
    +

    Logs a message with level CRITICAL on the root logger. The arguments +are interpreted as for debug().

    +
    + +
    +
    +logging.exception(msg, *args, **kwargs)
    +

    Logs a message with level ERROR on the root logger. The arguments are +interpreted as for debug(). Exception info is added to the logging +message. This function should only be called from an exception handler.

    +
    + +
    +
    +logging.log(level, msg, *args, **kwargs)
    +

    Logs a message with level level on the root logger. The other arguments are +interpreted as for debug().

    +
    +

    Note

    +

    The above module-level convenience functions, which delegate to the +root logger, call basicConfig() to ensure that at least one handler +is available. Because of this, they should not be used in threads, +in versions of Python earlier than 2.7.1 and 3.2, unless at least one +handler has been added to the root logger before the threads are +started. In earlier versions of Python, due to a thread safety shortcoming +in basicConfig(), this can (under rare circumstances) lead to +handlers being added multiple times to the root logger, which can in turn +lead to multiple messages for the same event.

    +
    +
    + +
    +
    +logging.disable(lvl=CRITICAL)
    +

    Provides an overriding level lvl for all loggers which takes precedence over +the logger’s own level. When the need arises to temporarily throttle logging +output down across the whole application, this function can be useful. Its +effect is to disable all logging calls of severity lvl and below, so that +if you call it with a value of INFO, then all INFO and DEBUG events would be +discarded, whereas those of severity WARNING and above would be processed +according to the logger’s effective level. If +logging.disable(logging.NOTSET) is called, it effectively removes this +overriding level, so that logging output again depends on the effective +levels of individual loggers.

    +

    Note that if you have defined any custom logging level higher than +CRITICAL (this is not recommended), you won’t be able to rely on the +default value for the lvl parameter, but will have to explicitly supply a +suitable value.

    +
    +

    Changed in version 3.7: The lvl parameter was defaulted to level CRITICAL. See Issue +#28524 for more information about this change.

    +
    +
    + +
    +
    +logging.addLevelName(lvl, levelName)
    +

    Associates level lvl with text levelName in an internal dictionary, which is +used to map numeric levels to a textual representation, for example when a +Formatter formats a message. This function can also be used to define +your own levels. The only constraints are that all levels used must be +registered using this function, levels should be positive integers and they +should increase in increasing order of severity.

    +
    +

    Note

    +

    If you are thinking of defining your own levels, please see the +section on Custom Levels.

    +
    +
    + +
    +
    +logging.getLevelName(lvl)
    +

    Returns the textual representation of logging level lvl. If the level is one +of the predefined levels CRITICAL, ERROR, WARNING, +INFO or DEBUG then you get the corresponding string. If you +have associated levels with names using addLevelName() then the name you +have associated with lvl is returned. If a numeric value corresponding to one +of the defined levels is passed in, the corresponding string representation is +returned. Otherwise, the string ‘Level %s’ % lvl is returned.

    +
    +

    Note

    +

    Levels are internally integers (as they need to be compared in the +logging logic). This function is used to convert between an integer level +and the level name displayed in the formatted log output by means of the +%(levelname)s format specifier (see LogRecord attributes).

    +
    +
    +

    Changed in version 3.4: In Python versions earlier than 3.4, this function could also be passed a +text level, and would return the corresponding numeric value of the level. +This undocumented behaviour was considered a mistake, and was removed in +Python 3.4, but reinstated in 3.4.2 due to retain backward compatibility.

    +
    +
    + +
    +
    +logging.makeLogRecord(attrdict)
    +

    Creates and returns a new LogRecord instance whose attributes are +defined by attrdict. This function is useful for taking a pickled +LogRecord attribute dictionary, sent over a socket, and reconstituting +it as a LogRecord instance at the receiving end.

    +
    + +
    +
    +logging.basicConfig(**kwargs)
    +

    Does basic configuration for the logging system by creating a +StreamHandler with a default Formatter and adding it to the +root logger. The functions debug(), info(), warning(), +error() and critical() will call basicConfig() automatically +if no handlers are defined for the root logger.

    +

    This function does nothing if the root logger already has handlers +configured for it.

    +
    +

    Note

    +

    This function should be called from the main thread +before other threads are started. In versions of Python prior to +2.7.1 and 3.2, if this function is called from multiple threads, +it is possible (in rare circumstances) that a handler will be added +to the root logger more than once, leading to unexpected results +such as messages being duplicated in the log.

    +
    +

    The following keyword arguments are supported.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Format

    Description

    filename

    Specifies that a FileHandler be created, +using the specified filename, rather than a +StreamHandler.

    filemode

    If filename is specified, open the file +in this mode. Defaults +to 'a'.

    format

    Use the specified format string for the +handler.

    datefmt

    Use the specified date/time format, as +accepted by time.strftime().

    style

    If format is specified, use this style +for the format string. One of '%', +'{' or '$' for printf-style, +str.format() or +string.Template respectively. +Defaults to '%'.

    level

    Set the root logger level to the specified +level.

    stream

    Use the specified stream to initialize the +StreamHandler. Note that this argument is +incompatible with filename - if both +are present, a ValueError is raised.

    handlers

    If specified, this should be an iterable of +already created handlers to add to the root +logger. Any handlers which don’t already +have a formatter set will be assigned the +default formatter created in this function. +Note that this argument is incompatible +with filename or stream - if both +are present, a ValueError is raised.

    +
    +

    Changed in version 3.2: The style argument was added.

    +
    +
    +

    Changed in version 3.3: The handlers argument was added. Additional checks were added to +catch situations where incompatible arguments are specified (e.g. +handlers together with stream or filename, or stream +together with filename).

    +
    +
    + +
    +
    +logging.shutdown()
    +

    Informs the logging system to perform an orderly shutdown by flushing and +closing all handlers. This should be called at application exit and no +further use of the logging system should be made after this call.

    +
    + +
    +
    +logging.setLoggerClass(klass)
    +

    Tells the logging system to use the class klass when instantiating a logger. +The class should define __init__() such that only a name argument is +required, and the __init__() should call Logger.__init__(). This +function is typically called before any loggers are instantiated by applications +which need to use custom logger behavior. After this call, as at any other +time, do not instantiate loggers directly using the subclass: continue to use +the logging.getLogger() API to get your loggers.

    +
    + +
    +
    +logging.setLogRecordFactory(factory)
    +

    Set a callable which is used to create a LogRecord.

    +
    +
    Parameters
    +

    factory – The factory callable to be used to instantiate a log record.

    +
    +
    +
    +

    New in version 3.2: This function has been provided, along with getLogRecordFactory(), to +allow developers more control over how the LogRecord representing +a logging event is constructed.

    +
    +

    The factory has the following signature:

    +

    factory(name, level, fn, lno, msg, args, exc_info, func=None, sinfo=None, **kwargs)

    +
    +
    +
    name
    +

    The logger name.

    +
    +
    level
    +

    The logging level (numeric).

    +
    +
    fn
    +

    The full pathname of the file where the logging call was made.

    +
    +
    lno
    +

    The line number in the file where the logging call was made.

    +
    +
    msg
    +

    The logging message.

    +
    +
    args
    +

    The arguments for the logging message.

    +
    +
    exc_info
    +

    An exception tuple, or None.

    +
    +
    func
    +

    The name of the function or method which invoked the logging +call.

    +
    +
    sinfo
    +

    A stack traceback such as is provided by +traceback.print_stack(), showing the call hierarchy.

    +
    +
    kwargs
    +

    Additional keyword arguments.

    +
    +
    +
    +
    + +
    +
    +

    Module-Level Attributes

    +
    +
    +logging.lastResort
    +

    A “handler of last resort” is available through this attribute. This +is a StreamHandler writing to sys.stderr with a level of +WARNING, and is used to handle logging events in the absence of any +logging configuration. The end result is to just print the message to +sys.stderr. This replaces the earlier error message saying that +“no handlers could be found for logger XYZ”. If you need the earlier +behaviour for some reason, lastResort can be set to None.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +

    Integration with the warnings module

    +

    The captureWarnings() function can be used to integrate logging +with the warnings module.

    +
    +
    +logging.captureWarnings(capture)
    +

    This function is used to turn the capture of warnings by logging on and +off.

    +

    If capture is True, warnings issued by the warnings module will +be redirected to the logging system. Specifically, a warning will be +formatted using warnings.formatwarning() and the resulting string +logged to a logger named 'py.warnings' with a severity of WARNING.

    +

    If capture is False, the redirection of warnings to the logging system +will stop, and warnings will be redirected to their original destinations +(i.e. those in effect before captureWarnings(True) was called).

    +
    + +
    +

    See also

    +
    +
    Module logging.config

    Configuration API for the logging module.

    +
    +
    Module logging.handlers

    Useful handlers included with the logging module.

    +
    +
    PEP 282 - A Logging System

    The proposal which described this feature for inclusion in the Python standard +library.

    +
    +
    Original Python logging package

    This is the original source for the logging package. The version of the +package available from this site is suitable for use with Python 1.5.2, 2.1.x +and 2.2.x, which do not include the logging package in the standard +library.

    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/lzma.html b/python-3.7.4-docs-html/library/lzma.html new file mode 100644 index 0000000..3c2b934 --- /dev/null +++ b/python-3.7.4-docs-html/library/lzma.html @@ -0,0 +1,627 @@ + + + + + + + lzma — Compression using the LZMA algorithm — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    lzma — Compression using the LZMA algorithm

    +
    +

    New in version 3.3.

    +
    +

    Source code: Lib/lzma.py

    +
    +

    This module provides classes and convenience functions for compressing and +decompressing data using the LZMA compression algorithm. Also included is a file +interface supporting the .xz and legacy .lzma file formats used by the +xz utility, as well as raw compressed streams.

    +

    The interface provided by this module is very similar to that of the bz2 +module. However, note that LZMAFile is not thread-safe, unlike +bz2.BZ2File, so if you need to use a single LZMAFile instance +from multiple threads, it is necessary to protect it with a lock.

    +
    +
    +exception lzma.LZMAError
    +

    This exception is raised when an error occurs during compression or +decompression, or while initializing the compressor/decompressor state.

    +
    + +
    +

    Reading and writing compressed files

    +
    +
    +lzma.open(filename, mode="rb", *, format=None, check=-1, preset=None, filters=None, encoding=None, errors=None, newline=None)
    +

    Open an LZMA-compressed file in binary or text mode, returning a file +object.

    +

    The filename argument can be either an actual file name (given as a +str, bytes or path-like object), in +which case the named file is opened, or it can be an existing file object +to read from or write to.

    +

    The mode argument can be any of "r", "rb", "w", "wb", +"x", "xb", "a" or "ab" for binary mode, or "rt", +"wt", "xt", or "at" for text mode. The default is "rb".

    +

    When opening a file for reading, the format and filters arguments have +the same meanings as for LZMADecompressor. In this case, the check +and preset arguments should not be used.

    +

    When opening a file for writing, the format, check, preset and +filters arguments have the same meanings as for LZMACompressor.

    +

    For binary mode, this function is equivalent to the LZMAFile +constructor: LZMAFile(filename, mode, ...). In this case, the encoding, +errors and newline arguments must not be provided.

    +

    For text mode, a LZMAFile object is created, and wrapped in an +io.TextIOWrapper instance with the specified encoding, error +handling behavior, and line ending(s).

    +
    +

    Changed in version 3.4: Added support for the "x", "xb" and "xt" modes.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +class lzma.LZMAFile(filename=None, mode="r", *, format=None, check=-1, preset=None, filters=None)
    +

    Open an LZMA-compressed file in binary mode.

    +

    An LZMAFile can wrap an already-open file object, or operate +directly on a named file. The filename argument specifies either the file +object to wrap, or the name of the file to open (as a str, +bytes or path-like object). When wrapping an +existing file object, the wrapped file will not be closed when the +LZMAFile is closed.

    +

    The mode argument can be either "r" for reading (default), "w" for +overwriting, "x" for exclusive creation, or "a" for appending. These +can equivalently be given as "rb", "wb", "xb" and "ab" +respectively.

    +

    If filename is a file object (rather than an actual file name), a mode of +"w" does not truncate the file, and is instead equivalent to "a".

    +

    When opening a file for reading, the input file may be the concatenation of +multiple separate compressed streams. These are transparently decoded as a +single logical stream.

    +

    When opening a file for reading, the format and filters arguments have +the same meanings as for LZMADecompressor. In this case, the check +and preset arguments should not be used.

    +

    When opening a file for writing, the format, check, preset and +filters arguments have the same meanings as for LZMACompressor.

    +

    LZMAFile supports all the members specified by +io.BufferedIOBase, except for detach() and truncate(). +Iteration and the with statement are supported.

    +

    The following method is also provided:

    +
    +
    +peek(size=-1)
    +

    Return buffered data without advancing the file position. At least one +byte of data will be returned, unless EOF has been reached. The exact +number of bytes returned is unspecified (the size argument is ignored).

    +
    +

    Note

    +

    While calling peek() does not change the file position of +the LZMAFile, it may change the position of the underlying +file object (e.g. if the LZMAFile was constructed by passing a +file object for filename).

    +
    +
    + +
    +

    Changed in version 3.4: Added support for the "x" and "xb" modes.

    +
    +
    +

    Changed in version 3.5: The read() method now accepts an argument of +None.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +

    Compressing and decompressing data in memory

    +
    +
    +class lzma.LZMACompressor(format=FORMAT_XZ, check=-1, preset=None, filters=None)
    +

    Create a compressor object, which can be used to compress data incrementally.

    +

    For a more convenient way of compressing a single chunk of data, see +compress().

    +

    The format argument specifies what container format should be used. +Possible values are:

    +
      +
    • +
      FORMAT_XZ: The .xz container format.

      This is the default format.

      +
      +
      +
    • +
    • +
      FORMAT_ALONE: The legacy .lzma container format.

      This format is more limited than .xz – it does not support integrity +checks or multiple filters.

      +
      +
      +
    • +
    • +
      FORMAT_RAW: A raw data stream, not using any container format.

      This format specifier does not support integrity checks, and requires that +you always specify a custom filter chain (for both compression and +decompression). Additionally, data compressed in this manner cannot be +decompressed using FORMAT_AUTO (see LZMADecompressor).

      +
      +
      +
    • +
    +

    The check argument specifies the type of integrity check to include in the +compressed data. This check is used when decompressing, to ensure that the +data has not been corrupted. Possible values are:

    +
      +
    • CHECK_NONE: No integrity check. +This is the default (and the only acceptable value) for +FORMAT_ALONE and FORMAT_RAW.

    • +
    • CHECK_CRC32: 32-bit Cyclic Redundancy Check.

    • +
    • CHECK_CRC64: 64-bit Cyclic Redundancy Check. +This is the default for FORMAT_XZ.

    • +
    • CHECK_SHA256: 256-bit Secure Hash Algorithm.

    • +
    +

    If the specified check is not supported, an LZMAError is raised.

    +

    The compression settings can be specified either as a preset compression +level (with the preset argument), or in detail as a custom filter chain +(with the filters argument).

    +

    The preset argument (if provided) should be an integer between 0 and +9 (inclusive), optionally OR-ed with the constant +PRESET_EXTREME. If neither preset nor filters are given, the +default behavior is to use PRESET_DEFAULT (preset level 6). +Higher presets produce smaller output, but make the compression process +slower.

    +
    +

    Note

    +

    In addition to being more CPU-intensive, compression with higher presets +also requires much more memory (and produces output that needs more memory +to decompress). With preset 9 for example, the overhead for an +LZMACompressor object can be as high as 800 MiB. For this reason, +it is generally best to stick with the default preset.

    +
    +

    The filters argument (if provided) should be a filter chain specifier. +See Specifying custom filter chains for details.

    +
    +
    +compress(data)
    +

    Compress data (a bytes object), returning a bytes +object containing compressed data for at least part of the input. Some of +data may be buffered internally, for use in later calls to +compress() and flush(). The returned data should be +concatenated with the output of any previous calls to compress().

    +
    + +
    +
    +flush()
    +

    Finish the compression process, returning a bytes object +containing any data stored in the compressor’s internal buffers.

    +

    The compressor cannot be used after this method has been called.

    +
    + +
    + +
    +
    +class lzma.LZMADecompressor(format=FORMAT_AUTO, memlimit=None, filters=None)
    +

    Create a decompressor object, which can be used to decompress data +incrementally.

    +

    For a more convenient way of decompressing an entire compressed stream at +once, see decompress().

    +

    The format argument specifies the container format that should be used. The +default is FORMAT_AUTO, which can decompress both .xz and +.lzma files. Other possible values are FORMAT_XZ, +FORMAT_ALONE, and FORMAT_RAW.

    +

    The memlimit argument specifies a limit (in bytes) on the amount of memory +that the decompressor can use. When this argument is used, decompression will +fail with an LZMAError if it is not possible to decompress the input +within the given memory limit.

    +

    The filters argument specifies the filter chain that was used to create +the stream being decompressed. This argument is required if format is +FORMAT_RAW, but should not be used for other formats. +See Specifying custom filter chains for more information about filter chains.

    +
    +

    Note

    +

    This class does not transparently handle inputs containing multiple +compressed streams, unlike decompress() and LZMAFile. To +decompress a multi-stream input with LZMADecompressor, you must +create a new decompressor for each stream.

    +
    +
    +
    +decompress(data, max_length=-1)
    +

    Decompress data (a bytes-like object), returning +uncompressed data as bytes. Some of data may be buffered +internally, for use in later calls to decompress(). The +returned data should be concatenated with the output of any +previous calls to decompress().

    +

    If max_length is nonnegative, returns at most max_length +bytes of decompressed data. If this limit is reached and further +output can be produced, the needs_input attribute will +be set to False. In this case, the next call to +decompress() may provide data as b'' to obtain +more of the output.

    +

    If all of the input data was decompressed and returned (either +because this was less than max_length bytes, or because +max_length was negative), the needs_input attribute +will be set to True.

    +

    Attempting to decompress data after the end of stream is reached +raises an EOFError. Any data found after the end of the +stream is ignored and saved in the unused_data attribute.

    +
    +

    Changed in version 3.5: Added the max_length parameter.

    +
    +
    + +
    +
    +check
    +

    The ID of the integrity check used by the input stream. This may be +CHECK_UNKNOWN until enough of the input has been decoded to +determine what integrity check it uses.

    +
    + +
    +
    +eof
    +

    True if the end-of-stream marker has been reached.

    +
    + +
    +
    +unused_data
    +

    Data found after the end of the compressed stream.

    +

    Before the end of the stream is reached, this will be b"".

    +
    + +
    +
    +needs_input
    +

    False if the decompress() method can provide more +decompressed data before requiring new uncompressed input.

    +
    +

    New in version 3.5.

    +
    +
    + +
    + +
    +
    +lzma.compress(data, format=FORMAT_XZ, check=-1, preset=None, filters=None)
    +

    Compress data (a bytes object), returning the compressed data as a +bytes object.

    +

    See LZMACompressor above for a description of the format, check, +preset and filters arguments.

    +
    + +
    +
    +lzma.decompress(data, format=FORMAT_AUTO, memlimit=None, filters=None)
    +

    Decompress data (a bytes object), returning the uncompressed data +as a bytes object.

    +

    If data is the concatenation of multiple distinct compressed streams, +decompress all of these streams, and return the concatenation of the results.

    +

    See LZMADecompressor above for a description of the format, +memlimit and filters arguments.

    +
    + +
    +
    +

    Miscellaneous

    +
    +
    +lzma.is_check_supported(check)
    +

    Returns true if the given integrity check is supported on this system.

    +

    CHECK_NONE and CHECK_CRC32 are always supported. +CHECK_CRC64 and CHECK_SHA256 may be unavailable if you are +using a version of liblzma that was compiled with a limited +feature set.

    +
    + +
    +
    +

    Specifying custom filter chains

    +

    A filter chain specifier is a sequence of dictionaries, where each dictionary +contains the ID and options for a single filter. Each dictionary must contain +the key "id", and may contain additional keys to specify filter-dependent +options. Valid filter IDs are as follows:

    +
      +
    • +
      Compression filters:
        +
      • FILTER_LZMA1 (for use with FORMAT_ALONE)

      • +
      • FILTER_LZMA2 (for use with FORMAT_XZ and FORMAT_RAW)

      • +
      +
      +
      +
    • +
    • +
      Delta filter:
        +
      • FILTER_DELTA

      • +
      +
      +
      +
    • +
    • +
      Branch-Call-Jump (BCJ) filters:
        +
      • FILTER_X86

      • +
      • FILTER_IA64

      • +
      • FILTER_ARM

      • +
      • FILTER_ARMTHUMB

      • +
      • FILTER_POWERPC

      • +
      • FILTER_SPARC

      • +
      +
      +
      +
    • +
    +

    A filter chain can consist of up to 4 filters, and cannot be empty. The last +filter in the chain must be a compression filter, and any other filters must be +delta or BCJ filters.

    +

    Compression filters support the following options (specified as additional +entries in the dictionary representing the filter):

    +
    +
      +
    • preset: A compression preset to use as a source of default values for +options that are not specified explicitly.

    • +
    • dict_size: Dictionary size in bytes. This should be between 4 KiB and +1.5 GiB (inclusive).

    • +
    • lc: Number of literal context bits.

    • +
    • lp: Number of literal position bits. The sum lc + lp must be at +most 4.

    • +
    • pb: Number of position bits; must be at most 4.

    • +
    • mode: MODE_FAST or MODE_NORMAL.

    • +
    • nice_len: What should be considered a “nice length” for a match. +This should be 273 or less.

    • +
    • mf: What match finder to use – MF_HC3, MF_HC4, +MF_BT2, MF_BT3, or MF_BT4.

    • +
    • depth: Maximum search depth used by match finder. 0 (default) means to +select automatically based on other filter options.

    • +
    +
    +

    The delta filter stores the differences between bytes, producing more repetitive +input for the compressor in certain circumstances. It supports one option, +dist. This indicates the distance between bytes to be subtracted. The +default is 1, i.e. take the differences between adjacent bytes.

    +

    The BCJ filters are intended to be applied to machine code. They convert +relative branches, calls and jumps in the code to use absolute addressing, with +the aim of increasing the redundancy that can be exploited by the compressor. +These filters support one option, start_offset. This specifies the address +that should be mapped to the beginning of the input data. The default is 0.

    +
    +
    +

    Examples

    +

    Reading in a compressed file:

    +
    import lzma
    +with lzma.open("file.xz") as f:
    +    file_content = f.read()
    +
    +
    +

    Creating a compressed file:

    +
    import lzma
    +data = b"Insert Data Here"
    +with lzma.open("file.xz", "w") as f:
    +    f.write(data)
    +
    +
    +

    Compressing data in memory:

    +
    import lzma
    +data_in = b"Insert Data Here"
    +data_out = lzma.compress(data_in)
    +
    +
    +

    Incremental compression:

    +
    import lzma
    +lzc = lzma.LZMACompressor()
    +out1 = lzc.compress(b"Some data\n")
    +out2 = lzc.compress(b"Another piece of data\n")
    +out3 = lzc.compress(b"Even more data\n")
    +out4 = lzc.flush()
    +# Concatenate all the partial results:
    +result = b"".join([out1, out2, out3, out4])
    +
    +
    +

    Writing compressed data to an already-open file:

    +
    import lzma
    +with open("file.xz", "wb") as f:
    +    f.write(b"This data will not be compressed\n")
    +    with lzma.open(f, "w") as lzf:
    +        lzf.write(b"This *will* be compressed\n")
    +    f.write(b"Not compressed\n")
    +
    +
    +

    Creating a compressed file using a custom filter chain:

    +
    import lzma
    +my_filters = [
    +    {"id": lzma.FILTER_DELTA, "dist": 5},
    +    {"id": lzma.FILTER_LZMA2, "preset": 7 | lzma.PRESET_EXTREME},
    +]
    +with lzma.open("file.xz", "w", filters=my_filters) as f:
    +    f.write(b"blah blah blah")
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/macpath.html b/python-3.7.4-docs-html/library/macpath.html new file mode 100644 index 0000000..c744186 --- /dev/null +++ b/python-3.7.4-docs-html/library/macpath.html @@ -0,0 +1,195 @@ + + + + + + + macpath — Mac OS 9 path manipulation functions — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    macpath — Mac OS 9 path manipulation functions

    +

    Source code: Lib/macpath.py

    +
    +

    Deprecated since version 3.7, will be removed in version 3.8.

    +
    +
    +

    This module is the Mac OS 9 (and earlier) implementation of the os.path +module. It can be used to manipulate old-style Macintosh pathnames on Mac OS X +(or any other platform).

    +

    The following functions are available in this module: normcase(), +normpath(), isabs(), join(), split(), isdir(), +isfile(), walk(), exists(). For other functions available in +os.path dummy counterparts are available.

    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/mailbox.html b/python-3.7.4-docs-html/library/mailbox.html new file mode 100644 index 0000000..27274fd --- /dev/null +++ b/python-3.7.4-docs-html/library/mailbox.html @@ -0,0 +1,2115 @@ + + + + + + + mailbox — Manipulate mailboxes in various formats — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    mailbox — Manipulate mailboxes in various formats

    +

    Source code: Lib/mailbox.py

    +
    +

    This module defines two classes, Mailbox and Message, for +accessing and manipulating on-disk mailboxes and the messages they contain. +Mailbox offers a dictionary-like mapping from keys to messages. +Message extends the email.message module’s +Message class with format-specific state and behavior. +Supported mailbox formats are Maildir, mbox, MH, Babyl, and MMDF.

    +
    +

    See also

    +
    +
    Module email

    Represent and manipulate messages.

    +
    +
    +
    +
    +

    Mailbox objects

    +
    +
    +class mailbox.Mailbox
    +

    A mailbox, which may be inspected and modified.

    +

    The Mailbox class defines an interface and is not intended to be +instantiated. Instead, format-specific subclasses should inherit from +Mailbox and your code should instantiate a particular subclass.

    +

    The Mailbox interface is dictionary-like, with small keys +corresponding to messages. Keys are issued by the Mailbox instance +with which they will be used and are only meaningful to that Mailbox +instance. A key continues to identify a message even if the corresponding +message is modified, such as by replacing it with another message.

    +

    Messages may be added to a Mailbox instance using the set-like +method add() and removed using a del statement or the set-like +methods remove() and discard().

    +

    Mailbox interface semantics differ from dictionary semantics in some +noteworthy ways. Each time a message is requested, a new representation +(typically a Message instance) is generated based upon the current +state of the mailbox. Similarly, when a message is added to a +Mailbox instance, the provided message representation’s contents are +copied. In neither case is a reference to the message representation kept by +the Mailbox instance.

    +

    The default Mailbox iterator iterates over message representations, +not keys as the default dictionary iterator does. Moreover, modification of a +mailbox during iteration is safe and well-defined. Messages added to the +mailbox after an iterator is created will not be seen by the +iterator. Messages removed from the mailbox before the iterator yields them +will be silently skipped, though using a key from an iterator may result in a +KeyError exception if the corresponding message is subsequently +removed.

    +
    +

    Warning

    +

    Be very cautious when modifying mailboxes that might be simultaneously +changed by some other process. The safest mailbox format to use for such +tasks is Maildir; try to avoid using single-file formats such as mbox for +concurrent writing. If you’re modifying a mailbox, you must lock it by +calling the lock() and unlock() methods before reading any +messages in the file or making any changes by adding or deleting a +message. Failing to lock the mailbox runs the risk of losing messages or +corrupting the entire mailbox.

    +
    +

    Mailbox instances have the following methods:

    +
    +
    +add(message)
    +

    Add message to the mailbox and return the key that has been assigned to +it.

    +

    Parameter message may be a Message instance, an +email.message.Message instance, a string, a byte string, or a +file-like object (which should be open in binary mode). If message is +an instance of the +appropriate format-specific Message subclass (e.g., if it’s an +mboxMessage instance and this is an mbox instance), its +format-specific information is used. Otherwise, reasonable defaults for +format-specific information are used.

    +
    +

    Changed in version 3.2: Support for binary input was added.

    +
    +
    + +
    +
    +remove(key)
    +
    +__delitem__(key)
    +
    +discard(key)
    +

    Delete the message corresponding to key from the mailbox.

    +

    If no such message exists, a KeyError exception is raised if the +method was called as remove() or __delitem__() but no +exception is raised if the method was called as discard(). The +behavior of discard() may be preferred if the underlying mailbox +format supports concurrent modification by other processes.

    +
    + +
    +
    +__setitem__(key, message)
    +

    Replace the message corresponding to key with message. Raise a +KeyError exception if no message already corresponds to key.

    +

    As with add(), parameter message may be a Message +instance, an email.message.Message instance, a string, a byte +string, or a file-like object (which should be open in binary mode). If +message is an +instance of the appropriate format-specific Message subclass +(e.g., if it’s an mboxMessage instance and this is an +mbox instance), its format-specific information is +used. Otherwise, the format-specific information of the message that +currently corresponds to key is left unchanged.

    +
    + +
    +
    +iterkeys()
    +
    +keys()
    +

    Return an iterator over all keys if called as iterkeys() or return a +list of keys if called as keys().

    +
    + +
    +
    +itervalues()
    +
    +__iter__()
    +
    +values()
    +

    Return an iterator over representations of all messages if called as +itervalues() or __iter__() or return a list of such +representations if called as values(). The messages are represented +as instances of the appropriate format-specific Message subclass +unless a custom message factory was specified when the Mailbox +instance was initialized.

    +
    +

    Note

    +

    The behavior of __iter__() is unlike that of dictionaries, which +iterate over keys.

    +
    +
    + +
    +
    +iteritems()
    +
    +items()
    +

    Return an iterator over (key, message) pairs, where key is a key and +message is a message representation, if called as iteritems() or +return a list of such pairs if called as items(). The messages are +represented as instances of the appropriate format-specific +Message subclass unless a custom message factory was specified +when the Mailbox instance was initialized.

    +
    + +
    +
    +get(key, default=None)
    +
    +__getitem__(key)
    +

    Return a representation of the message corresponding to key. If no such +message exists, default is returned if the method was called as +get() and a KeyError exception is raised if the method was +called as __getitem__(). The message is represented as an instance +of the appropriate format-specific Message subclass unless a +custom message factory was specified when the Mailbox instance +was initialized.

    +
    + +
    +
    +get_message(key)
    +

    Return a representation of the message corresponding to key as an +instance of the appropriate format-specific Message subclass, or +raise a KeyError exception if no such message exists.

    +
    + +
    +
    +get_bytes(key)
    +

    Return a byte representation of the message corresponding to key, or +raise a KeyError exception if no such message exists.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +get_string(key)
    +

    Return a string representation of the message corresponding to key, or +raise a KeyError exception if no such message exists. The +message is processed through email.message.Message to +convert it to a 7bit clean representation.

    +
    + +
    +
    +get_file(key)
    +

    Return a file-like representation of the message corresponding to key, +or raise a KeyError exception if no such message exists. The +file-like object behaves as if open in binary mode. This file should be +closed once it is no longer needed.

    +
    +

    Changed in version 3.2: The file object really is a binary file; previously it was incorrectly +returned in text mode. Also, the file-like object now supports the +context management protocol: you can use a with statement to +automatically close it.

    +
    +
    +

    Note

    +

    Unlike other representations of messages, file-like representations are +not necessarily independent of the Mailbox instance that +created them or of the underlying mailbox. More specific documentation +is provided by each subclass.

    +
    +
    + +
    +
    +__contains__(key)
    +

    Return True if key corresponds to a message, False otherwise.

    +
    + +
    +
    +__len__()
    +

    Return a count of messages in the mailbox.

    +
    + +
    +
    +clear()
    +

    Delete all messages from the mailbox.

    +
    + +
    +
    +pop(key, default=None)
    +

    Return a representation of the message corresponding to key and delete +the message. If no such message exists, return default. The message is +represented as an instance of the appropriate format-specific +Message subclass unless a custom message factory was specified +when the Mailbox instance was initialized.

    +
    + +
    +
    +popitem()
    +

    Return an arbitrary (key, message) pair, where key is a key and +message is a message representation, and delete the corresponding +message. If the mailbox is empty, raise a KeyError exception. The +message is represented as an instance of the appropriate format-specific +Message subclass unless a custom message factory was specified +when the Mailbox instance was initialized.

    +
    + +
    +
    +update(arg)
    +

    Parameter arg should be a key-to-message mapping or an iterable of +(key, message) pairs. Updates the mailbox so that, for each given +key and message, the message corresponding to key is set to +message as if by using __setitem__(). As with __setitem__(), +each key must already correspond to a message in the mailbox or else a +KeyError exception will be raised, so in general it is incorrect +for arg to be a Mailbox instance.

    +
    +

    Note

    +

    Unlike with dictionaries, keyword arguments are not supported.

    +
    +
    + +
    +
    +flush()
    +

    Write any pending changes to the filesystem. For some Mailbox +subclasses, changes are always written immediately and flush() does +nothing, but you should still make a habit of calling this method.

    +
    + +
    +
    +lock()
    +

    Acquire an exclusive advisory lock on the mailbox so that other processes +know not to modify it. An ExternalClashError is raised if the lock +is not available. The particular locking mechanisms used depend upon the +mailbox format. You should always lock the mailbox before making any +modifications to its contents.

    +
    + +
    +
    +unlock()
    +

    Release the lock on the mailbox, if any.

    +
    + +
    +
    +close()
    +

    Flush the mailbox, unlock it if necessary, and close any open files. For +some Mailbox subclasses, this method does nothing.

    +
    + +
    + +
    +

    Maildir

    +
    +
    +class mailbox.Maildir(dirname, factory=None, create=True)
    +

    A subclass of Mailbox for mailboxes in Maildir format. Parameter +factory is a callable object that accepts a file-like message representation +(which behaves as if opened in binary mode) and returns a custom representation. +If factory is None, MaildirMessage is used as the default message +representation. If create is True, the mailbox is created if it does not +exist.

    +

    It is for historical reasons that dirname is named as such rather than path.

    +

    Maildir is a directory-based mailbox format invented for the qmail mail +transfer agent and now widely supported by other programs. Messages in a +Maildir mailbox are stored in separate files within a common directory +structure. This design allows Maildir mailboxes to be accessed and modified +by multiple unrelated programs without data corruption, so file locking is +unnecessary.

    +

    Maildir mailboxes contain three subdirectories, namely: tmp, +new, and cur. Messages are created momentarily in the +tmp subdirectory and then moved to the new subdirectory to +finalize delivery. A mail user agent may subsequently move the message to the +cur subdirectory and store information about the state of the message +in a special “info” section appended to its file name.

    +

    Folders of the style introduced by the Courier mail transfer agent are also +supported. Any subdirectory of the main mailbox is considered a folder if +'.' is the first character in its name. Folder names are represented by +Maildir without the leading '.'. Each folder is itself a Maildir +mailbox but should not contain other folders. Instead, a logical nesting is +indicated using '.' to delimit levels, e.g., “Archived.2005.07”.

    +
    +

    Note

    +

    The Maildir specification requires the use of a colon (':') in certain +message file names. However, some operating systems do not permit this +character in file names, If you wish to use a Maildir-like format on such +an operating system, you should specify another character to use +instead. The exclamation point ('!') is a popular choice. For +example:

    +
    import mailbox
    +mailbox.Maildir.colon = '!'
    +
    +
    +

    The colon attribute may also be set on a per-instance basis.

    +
    +

    Maildir instances have all of the methods of Mailbox in +addition to the following:

    +
    +
    +list_folders()
    +

    Return a list of the names of all folders.

    +
    + +
    +
    +get_folder(folder)
    +

    Return a Maildir instance representing the folder whose name is +folder. A NoSuchMailboxError exception is raised if the folder +does not exist.

    +
    + +
    +
    +add_folder(folder)
    +

    Create a folder whose name is folder and return a Maildir +instance representing it.

    +
    + +
    +
    +remove_folder(folder)
    +

    Delete the folder whose name is folder. If the folder contains any +messages, a NotEmptyError exception will be raised and the folder +will not be deleted.

    +
    + +
    +
    +clean()
    +

    Delete temporary files from the mailbox that have not been accessed in the +last 36 hours. The Maildir specification says that mail-reading programs +should do this occasionally.

    +
    + +

    Some Mailbox methods implemented by Maildir deserve special +remarks:

    +
    +
    +add(message)
    +
    +__setitem__(key, message)
    +
    +update(arg)
    +
    +

    Warning

    +

    These methods generate unique file names based upon the current process +ID. When using multiple threads, undetected name clashes may occur and +cause corruption of the mailbox unless threads are coordinated to avoid +using these methods to manipulate the same mailbox simultaneously.

    +
    +
    + +
    +
    +flush()
    +

    All changes to Maildir mailboxes are immediately applied, so this method +does nothing.

    +
    + +
    +
    +lock()
    +
    +unlock()
    +

    Maildir mailboxes do not support (or require) locking, so these methods do +nothing.

    +
    + +
    +
    +close()
    +

    Maildir instances do not keep any open files and the underlying +mailboxes do not support locking, so this method does nothing.

    +
    + +
    +
    +get_file(key)
    +

    Depending upon the host platform, it may not be possible to modify or +remove the underlying message while the returned file remains open.

    +
    + +
    + +
    +

    See also

    +
    +
    maildir man page from qmail

    The original specification of the format.

    +
    +
    Using maildir format

    Notes on Maildir by its inventor. Includes an updated name-creation scheme and +details on “info” semantics.

    +
    +
    maildir man page from Courier

    Another specification of the format. Describes a common extension for supporting +folders.

    +
    +
    +
    +
    +
    +

    mbox

    +
    +
    +class mailbox.mbox(path, factory=None, create=True)
    +

    A subclass of Mailbox for mailboxes in mbox format. Parameter factory +is a callable object that accepts a file-like message representation (which +behaves as if opened in binary mode) and returns a custom representation. If +factory is None, mboxMessage is used as the default message +representation. If create is True, the mailbox is created if it does not +exist.

    +

    The mbox format is the classic format for storing mail on Unix systems. All +messages in an mbox mailbox are stored in a single file with the beginning of +each message indicated by a line whose first five characters are “From “.

    +

    Several variations of the mbox format exist to address perceived shortcomings in +the original. In the interest of compatibility, mbox implements the +original format, which is sometimes referred to as mboxo. This means that +the Content-Length header, if present, is ignored and that any +occurrences of “From ” at the beginning of a line in a message body are +transformed to “>From ” when storing the message, although occurrences of “>From +” are not transformed to “From ” when reading the message.

    +

    Some Mailbox methods implemented by mbox deserve special +remarks:

    +
    +
    +get_file(key)
    +

    Using the file after calling flush() or close() on the +mbox instance may yield unpredictable results or raise an +exception.

    +
    + +
    +
    +lock()
    +
    +unlock()
    +

    Three locking mechanisms are used—dot locking and, if available, the +flock() and lockf() system calls.

    +
    + +
    + +
    +

    See also

    +
    +
    mbox man page from qmail

    A specification of the format and its variations.

    +
    +
    mbox man page from tin

    Another specification of the format, with details on locking.

    +
    +
    Configuring Netscape Mail on Unix: Why The Content-Length Format is Bad

    An argument for using the original mbox format rather than a variation.

    +
    +
    “mbox” is a family of several mutually incompatible mailbox formats

    A history of mbox variations.

    +
    +
    +
    +
    +
    +

    MH

    +
    +
    +class mailbox.MH(path, factory=None, create=True)
    +

    A subclass of Mailbox for mailboxes in MH format. Parameter factory +is a callable object that accepts a file-like message representation (which +behaves as if opened in binary mode) and returns a custom representation. If +factory is None, MHMessage is used as the default message +representation. If create is True, the mailbox is created if it does not +exist.

    +

    MH is a directory-based mailbox format invented for the MH Message Handling +System, a mail user agent. Each message in an MH mailbox resides in its own +file. An MH mailbox may contain other MH mailboxes (called folders) in +addition to messages. Folders may be nested indefinitely. MH mailboxes also +support sequences, which are named lists used to logically group +messages without moving them to sub-folders. Sequences are defined in a file +called .mh_sequences in each folder.

    +

    The MH class manipulates MH mailboxes, but it does not attempt to +emulate all of mh’s behaviors. In particular, it does not modify +and is not affected by the context or .mh_profile files that +are used by mh to store its state and configuration.

    +

    MH instances have all of the methods of Mailbox in addition +to the following:

    +
    +
    +list_folders()
    +

    Return a list of the names of all folders.

    +
    + +
    +
    +get_folder(folder)
    +

    Return an MH instance representing the folder whose name is +folder. A NoSuchMailboxError exception is raised if the folder +does not exist.

    +
    + +
    +
    +add_folder(folder)
    +

    Create a folder whose name is folder and return an MH instance +representing it.

    +
    + +
    +
    +remove_folder(folder)
    +

    Delete the folder whose name is folder. If the folder contains any +messages, a NotEmptyError exception will be raised and the folder +will not be deleted.

    +
    + +
    +
    +get_sequences()
    +

    Return a dictionary of sequence names mapped to key lists. If there are no +sequences, the empty dictionary is returned.

    +
    + +
    +
    +set_sequences(sequences)
    +

    Re-define the sequences that exist in the mailbox based upon sequences, +a dictionary of names mapped to key lists, like returned by +get_sequences().

    +
    + +
    +
    +pack()
    +

    Rename messages in the mailbox as necessary to eliminate gaps in +numbering. Entries in the sequences list are updated correspondingly.

    +
    +

    Note

    +

    Already-issued keys are invalidated by this operation and should not be +subsequently used.

    +
    +
    + +

    Some Mailbox methods implemented by MH deserve special +remarks:

    +
    +
    +remove(key)
    +
    +__delitem__(key)
    +
    +discard(key)
    +

    These methods immediately delete the message. The MH convention of marking +a message for deletion by prepending a comma to its name is not used.

    +
    + +
    +
    +lock()
    +
    +unlock()
    +

    Three locking mechanisms are used—dot locking and, if available, the +flock() and lockf() system calls. For MH mailboxes, locking +the mailbox means locking the .mh_sequences file and, only for the +duration of any operations that affect them, locking individual message +files.

    +
    + +
    +
    +get_file(key)
    +

    Depending upon the host platform, it may not be possible to remove the +underlying message while the returned file remains open.

    +
    + +
    +
    +flush()
    +

    All changes to MH mailboxes are immediately applied, so this method does +nothing.

    +
    + +
    +
    +close()
    +

    MH instances do not keep any open files, so this method is +equivalent to unlock().

    +
    + +
    + +
    +

    See also

    +
    +
    nmh - Message Handling System

    Home page of nmh, an updated version of the original mh.

    +
    +
    MH & nmh: Email for Users & Programmers

    A GPL-licensed book on mh and nmh, with some information +on the mailbox format.

    +
    +
    +
    +
    +
    +

    Babyl

    +
    +
    +class mailbox.Babyl(path, factory=None, create=True)
    +

    A subclass of Mailbox for mailboxes in Babyl format. Parameter +factory is a callable object that accepts a file-like message representation +(which behaves as if opened in binary mode) and returns a custom representation. +If factory is None, BabylMessage is used as the default message +representation. If create is True, the mailbox is created if it does not +exist.

    +

    Babyl is a single-file mailbox format used by the Rmail mail user agent +included with Emacs. The beginning of a message is indicated by a line +containing the two characters Control-Underscore ('\037') and Control-L +('\014'). The end of a message is indicated by the start of the next +message or, in the case of the last message, a line containing a +Control-Underscore ('\037') character.

    +

    Messages in a Babyl mailbox have two sets of headers, original headers and +so-called visible headers. Visible headers are typically a subset of the +original headers that have been reformatted or abridged to be more +attractive. Each message in a Babyl mailbox also has an accompanying list of +labels, or short strings that record extra information about the +message, and a list of all user-defined labels found in the mailbox is kept +in the Babyl options section.

    +

    Babyl instances have all of the methods of Mailbox in +addition to the following:

    +
    +
    +get_labels()
    +

    Return a list of the names of all user-defined labels used in the mailbox.

    +
    +

    Note

    +

    The actual messages are inspected to determine which labels exist in +the mailbox rather than consulting the list of labels in the Babyl +options section, but the Babyl section is updated whenever the mailbox +is modified.

    +
    +
    + +

    Some Mailbox methods implemented by Babyl deserve special +remarks:

    +
    +
    +get_file(key)
    +

    In Babyl mailboxes, the headers of a message are not stored contiguously +with the body of the message. To generate a file-like representation, the +headers and body are copied together into an io.BytesIO instance, +which has an API identical to that of a +file. As a result, the file-like object is truly independent of the +underlying mailbox but does not save memory compared to a string +representation.

    +
    + +
    +
    +lock()
    +
    +unlock()
    +

    Three locking mechanisms are used—dot locking and, if available, the +flock() and lockf() system calls.

    +
    + +
    + +
    +

    See also

    +
    +
    Format of Version 5 Babyl Files

    A specification of the Babyl format.

    +
    +
    Reading Mail with Rmail

    The Rmail manual, with some information on Babyl semantics.

    +
    +
    +
    +
    +
    +

    MMDF

    +
    +
    +class mailbox.MMDF(path, factory=None, create=True)
    +

    A subclass of Mailbox for mailboxes in MMDF format. Parameter factory +is a callable object that accepts a file-like message representation (which +behaves as if opened in binary mode) and returns a custom representation. If +factory is None, MMDFMessage is used as the default message +representation. If create is True, the mailbox is created if it does not +exist.

    +

    MMDF is a single-file mailbox format invented for the Multichannel Memorandum +Distribution Facility, a mail transfer agent. Each message is in the same +form as an mbox message but is bracketed before and after by lines containing +four Control-A ('\001') characters. As with the mbox format, the +beginning of each message is indicated by a line whose first five characters +are “From “, but additional occurrences of “From ” are not transformed to +“>From ” when storing messages because the extra message separator lines +prevent mistaking such occurrences for the starts of subsequent messages.

    +

    Some Mailbox methods implemented by MMDF deserve special +remarks:

    +
    +
    +get_file(key)
    +

    Using the file after calling flush() or close() on the +MMDF instance may yield unpredictable results or raise an +exception.

    +
    + +
    +
    +lock()
    +
    +unlock()
    +

    Three locking mechanisms are used—dot locking and, if available, the +flock() and lockf() system calls.

    +
    + +
    + +
    +

    See also

    +
    +
    mmdf man page from tin

    A specification of MMDF format from the documentation of tin, a newsreader.

    +
    +
    MMDF

    A Wikipedia article describing the Multichannel Memorandum Distribution +Facility.

    +
    +
    +
    +
    +
    +
    +

    Message objects

    +
    +
    +class mailbox.Message(message=None)
    +

    A subclass of the email.message module’s +Message. Subclasses of mailbox.Message add +mailbox-format-specific state and behavior.

    +

    If message is omitted, the new instance is created in a default, empty state. +If message is an email.message.Message instance, its contents are +copied; furthermore, any format-specific information is converted insofar as +possible if message is a Message instance. If message is a string, +a byte string, +or a file, it should contain an RFC 2822-compliant message, which is read +and parsed. Files should be open in binary mode, but text mode files +are accepted for backward compatibility.

    +

    The format-specific state and behaviors offered by subclasses vary, but in +general it is only the properties that are not specific to a particular +mailbox that are supported (although presumably the properties are specific +to a particular mailbox format). For example, file offsets for single-file +mailbox formats and file names for directory-based mailbox formats are not +retained, because they are only applicable to the original mailbox. But state +such as whether a message has been read by the user or marked as important is +retained, because it applies to the message itself.

    +

    There is no requirement that Message instances be used to represent +messages retrieved using Mailbox instances. In some situations, the +time and memory required to generate Message representations might +not be acceptable. For such situations, Mailbox instances also +offer string and file-like representations, and a custom message factory may +be specified when a Mailbox instance is initialized.

    +
    + +
    +

    MaildirMessage

    +
    +
    +class mailbox.MaildirMessage(message=None)
    +

    A message with Maildir-specific behaviors. Parameter message has the same +meaning as with the Message constructor.

    +

    Typically, a mail user agent application moves all of the messages in the +new subdirectory to the cur subdirectory after the first time +the user opens and closes the mailbox, recording that the messages are old +whether or not they’ve actually been read. Each message in cur has an +“info” section added to its file name to store information about its state. +(Some mail readers may also add an “info” section to messages in +new.) The “info” section may take one of two forms: it may contain +“2,” followed by a list of standardized flags (e.g., “2,FR”) or it may +contain “1,” followed by so-called experimental information. Standard flags +for Maildir messages are as follows:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Flag

    Meaning

    Explanation

    D

    Draft

    Under composition

    F

    Flagged

    Marked as important

    P

    Passed

    Forwarded, resent, or bounced

    R

    Replied

    Replied to

    S

    Seen

    Read

    T

    Trashed

    Marked for subsequent deletion

    +

    MaildirMessage instances offer the following methods:

    +
    +
    +get_subdir()
    +

    Return either “new” (if the message should be stored in the new +subdirectory) or “cur” (if the message should be stored in the cur +subdirectory).

    +
    +

    Note

    +

    A message is typically moved from new to cur after its +mailbox has been accessed, whether or not the message is has been +read. A message msg has been read if "S" in msg.get_flags() is +True.

    +
    +
    + +
    +
    +set_subdir(subdir)
    +

    Set the subdirectory the message should be stored in. Parameter subdir +must be either “new” or “cur”.

    +
    + +
    +
    +get_flags()
    +

    Return a string specifying the flags that are currently set. If the +message complies with the standard Maildir format, the result is the +concatenation in alphabetical order of zero or one occurrence of each of +'D', 'F', 'P', 'R', 'S', and 'T'. The empty string +is returned if no flags are set or if “info” contains experimental +semantics.

    +
    + +
    +
    +set_flags(flags)
    +

    Set the flags specified by flags and unset all others.

    +
    + +
    +
    +add_flag(flag)
    +

    Set the flag(s) specified by flag without changing other flags. To add +more than one flag at a time, flag may be a string of more than one +character. The current “info” is overwritten whether or not it contains +experimental information rather than flags.

    +
    + +
    +
    +remove_flag(flag)
    +

    Unset the flag(s) specified by flag without changing other flags. To +remove more than one flag at a time, flag maybe a string of more than +one character. If “info” contains experimental information rather than +flags, the current “info” is not modified.

    +
    + +
    +
    +get_date()
    +

    Return the delivery date of the message as a floating-point number +representing seconds since the epoch.

    +
    + +
    +
    +set_date(date)
    +

    Set the delivery date of the message to date, a floating-point number +representing seconds since the epoch.

    +
    + +
    +
    +get_info()
    +

    Return a string containing the “info” for a message. This is useful for +accessing and modifying “info” that is experimental (i.e., not a list of +flags).

    +
    + +
    +
    +set_info(info)
    +

    Set “info” to info, which should be a string.

    +
    + +
    + +

    When a MaildirMessage instance is created based upon an +mboxMessage or MMDFMessage instance, the Status +and X-Status headers are omitted and the following conversions +take place:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + +

    Resulting state

    mboxMessage or MMDFMessage +state

    “cur” subdirectory

    O flag

    F flag

    F flag

    R flag

    A flag

    S flag

    R flag

    T flag

    D flag

    +

    When a MaildirMessage instance is created based upon an +MHMessage instance, the following conversions take place:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Resulting state

    MHMessage state

    “cur” subdirectory

    “unseen” sequence

    “cur” subdirectory and S flag

    no “unseen” sequence

    F flag

    “flagged” sequence

    R flag

    “replied” sequence

    +

    When a MaildirMessage instance is created based upon a +BabylMessage instance, the following conversions take place:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + +

    Resulting state

    BabylMessage state

    “cur” subdirectory

    “unseen” label

    “cur” subdirectory and S flag

    no “unseen” label

    P flag

    “forwarded” or “resent” label

    R flag

    “answered” label

    T flag

    “deleted” label

    +
    +
    +

    mboxMessage

    +
    +
    +class mailbox.mboxMessage(message=None)
    +

    A message with mbox-specific behaviors. Parameter message has the same meaning +as with the Message constructor.

    +

    Messages in an mbox mailbox are stored together in a single file. The +sender’s envelope address and the time of delivery are typically stored in a +line beginning with “From ” that is used to indicate the start of a message, +though there is considerable variation in the exact format of this data among +mbox implementations. Flags that indicate the state of the message, such as +whether it has been read or marked as important, are typically stored in +Status and X-Status headers.

    +

    Conventional flags for mbox messages are as follows:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Flag

    Meaning

    Explanation

    R

    Read

    Read

    O

    Old

    Previously detected by MUA

    D

    Deleted

    Marked for subsequent deletion

    F

    Flagged

    Marked as important

    A

    Answered

    Replied to

    +

    The “R” and “O” flags are stored in the Status header, and the +“D”, “F”, and “A” flags are stored in the X-Status header. The +flags and headers typically appear in the order mentioned.

    +

    mboxMessage instances offer the following methods:

    +
    +
    +get_from()
    +

    Return a string representing the “From ” line that marks the start of the +message in an mbox mailbox. The leading “From ” and the trailing newline +are excluded.

    +
    + +
    +
    +set_from(from_, time_=None)
    +

    Set the “From ” line to from_, which should be specified without a +leading “From ” or trailing newline. For convenience, time_ may be +specified and will be formatted appropriately and appended to from_. If +time_ is specified, it should be a time.struct_time instance, a +tuple suitable for passing to time.strftime(), or True (to use +time.gmtime()).

    +
    + +
    +
    +get_flags()
    +

    Return a string specifying the flags that are currently set. If the +message complies with the conventional format, the result is the +concatenation in the following order of zero or one occurrence of each of +'R', 'O', 'D', 'F', and 'A'.

    +
    + +
    +
    +set_flags(flags)
    +

    Set the flags specified by flags and unset all others. Parameter flags +should be the concatenation in any order of zero or more occurrences of +each of 'R', 'O', 'D', 'F', and 'A'.

    +
    + +
    +
    +add_flag(flag)
    +

    Set the flag(s) specified by flag without changing other flags. To add +more than one flag at a time, flag may be a string of more than one +character.

    +
    + +
    +
    +remove_flag(flag)
    +

    Unset the flag(s) specified by flag without changing other flags. To +remove more than one flag at a time, flag maybe a string of more than +one character.

    +
    + +
    + +

    When an mboxMessage instance is created based upon a +MaildirMessage instance, a “From ” line is generated based upon the +MaildirMessage instance’s delivery date, and the following conversions +take place:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + +

    Resulting state

    MaildirMessage state

    R flag

    S flag

    O flag

    “cur” subdirectory

    D flag

    T flag

    F flag

    F flag

    A flag

    R flag

    +

    When an mboxMessage instance is created based upon an +MHMessage instance, the following conversions take place:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Resulting state

    MHMessage state

    R flag and O flag

    no “unseen” sequence

    O flag

    “unseen” sequence

    F flag

    “flagged” sequence

    A flag

    “replied” sequence

    +

    When an mboxMessage instance is created based upon a +BabylMessage instance, the following conversions take place:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Resulting state

    BabylMessage state

    R flag and O flag

    no “unseen” label

    O flag

    “unseen” label

    D flag

    “deleted” label

    A flag

    “answered” label

    +

    When a Message instance is created based upon an MMDFMessage +instance, the “From ” line is copied and all flags directly correspond:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + +

    Resulting state

    MMDFMessage state

    R flag

    R flag

    O flag

    O flag

    D flag

    D flag

    F flag

    F flag

    A flag

    A flag

    +
    +
    +

    MHMessage

    +
    +
    +class mailbox.MHMessage(message=None)
    +

    A message with MH-specific behaviors. Parameter message has the same meaning +as with the Message constructor.

    +

    MH messages do not support marks or flags in the traditional sense, but they +do support sequences, which are logical groupings of arbitrary messages. Some +mail reading programs (although not the standard mh and +nmh) use sequences in much the same way flags are used with other +formats, as follows:

    + ++++ + + + + + + + + + + + + + + + + +

    Sequence

    Explanation

    unseen

    Not read, but previously detected by MUA

    replied

    Replied to

    flagged

    Marked as important

    +

    MHMessage instances offer the following methods:

    +
    +
    +get_sequences()
    +

    Return a list of the names of sequences that include this message.

    +
    + +
    +
    +set_sequences(sequences)
    +

    Set the list of sequences that include this message.

    +
    + +
    +
    +add_sequence(sequence)
    +

    Add sequence to the list of sequences that include this message.

    +
    + +
    +
    +remove_sequence(sequence)
    +

    Remove sequence from the list of sequences that include this message.

    +
    + +
    + +

    When an MHMessage instance is created based upon a +MaildirMessage instance, the following conversions take place:

    + ++++ + + + + + + + + + + + + + + + + +

    Resulting state

    MaildirMessage state

    “unseen” sequence

    no S flag

    “replied” sequence

    R flag

    “flagged” sequence

    F flag

    +

    When an MHMessage instance is created based upon an +mboxMessage or MMDFMessage instance, the Status +and X-Status headers are omitted and the following conversions +take place:

    + ++++ + + + + + + + + + + + + + + + + +

    Resulting state

    mboxMessage or MMDFMessage +state

    “unseen” sequence

    no R flag

    “replied” sequence

    A flag

    “flagged” sequence

    F flag

    +

    When an MHMessage instance is created based upon a +BabylMessage instance, the following conversions take place:

    + ++++ + + + + + + + + + + + + + +

    Resulting state

    BabylMessage state

    “unseen” sequence

    “unseen” label

    “replied” sequence

    “answered” label

    +
    +
    +

    BabylMessage

    +
    +
    +class mailbox.BabylMessage(message=None)
    +

    A message with Babyl-specific behaviors. Parameter message has the same +meaning as with the Message constructor.

    +

    Certain message labels, called attributes, are defined by convention +to have special meanings. The attributes are as follows:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Label

    Explanation

    unseen

    Not read, but previously detected by MUA

    deleted

    Marked for subsequent deletion

    filed

    Copied to another file or mailbox

    answered

    Replied to

    forwarded

    Forwarded

    edited

    Modified by the user

    resent

    Resent

    +

    By default, Rmail displays only visible headers. The BabylMessage +class, though, uses the original headers because they are more +complete. Visible headers may be accessed explicitly if desired.

    +

    BabylMessage instances offer the following methods:

    +
    +
    +get_labels()
    +

    Return a list of labels on the message.

    +
    + +
    +
    +set_labels(labels)
    +

    Set the list of labels on the message to labels.

    +
    + +
    +
    +add_label(label)
    +

    Add label to the list of labels on the message.

    +
    + +
    +
    +remove_label(label)
    +

    Remove label from the list of labels on the message.

    +
    + +
    +
    +get_visible()
    +

    Return an Message instance whose headers are the message’s +visible headers and whose body is empty.

    +
    + +
    +
    +set_visible(visible)
    +

    Set the message’s visible headers to be the same as the headers in +message. Parameter visible should be a Message instance, an +email.message.Message instance, a string, or a file-like object +(which should be open in text mode).

    +
    + +
    +
    +update_visible()
    +

    When a BabylMessage instance’s original headers are modified, the +visible headers are not automatically modified to correspond. This method +updates the visible headers as follows: each visible header with a +corresponding original header is set to the value of the original header, +each visible header without a corresponding original header is removed, +and any of Date, From, Reply-To, +To, CC, and Subject that are +present in the original headers but not the visible headers are added to +the visible headers.

    +
    + +
    + +

    When a BabylMessage instance is created based upon a +MaildirMessage instance, the following conversions take place:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Resulting state

    MaildirMessage state

    “unseen” label

    no S flag

    “deleted” label

    T flag

    “answered” label

    R flag

    “forwarded” label

    P flag

    +

    When a BabylMessage instance is created based upon an +mboxMessage or MMDFMessage instance, the Status +and X-Status headers are omitted and the following conversions +take place:

    + ++++ + + + + + + + + + + + + + + + + +

    Resulting state

    mboxMessage or MMDFMessage +state

    “unseen” label

    no R flag

    “deleted” label

    D flag

    “answered” label

    A flag

    +

    When a BabylMessage instance is created based upon an +MHMessage instance, the following conversions take place:

    + ++++ + + + + + + + + + + + + + +

    Resulting state

    MHMessage state

    “unseen” label

    “unseen” sequence

    “answered” label

    “replied” sequence

    +
    +
    +

    MMDFMessage

    +
    +
    +class mailbox.MMDFMessage(message=None)
    +

    A message with MMDF-specific behaviors. Parameter message has the same meaning +as with the Message constructor.

    +

    As with message in an mbox mailbox, MMDF messages are stored with the +sender’s address and the delivery date in an initial line beginning with +“From “. Likewise, flags that indicate the state of the message are +typically stored in Status and X-Status headers.

    +

    Conventional flags for MMDF messages are identical to those of mbox message +and are as follows:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Flag

    Meaning

    Explanation

    R

    Read

    Read

    O

    Old

    Previously detected by MUA

    D

    Deleted

    Marked for subsequent deletion

    F

    Flagged

    Marked as important

    A

    Answered

    Replied to

    +

    The “R” and “O” flags are stored in the Status header, and the +“D”, “F”, and “A” flags are stored in the X-Status header. The +flags and headers typically appear in the order mentioned.

    +

    MMDFMessage instances offer the following methods, which are +identical to those offered by mboxMessage:

    +
    +
    +get_from()
    +

    Return a string representing the “From ” line that marks the start of the +message in an mbox mailbox. The leading “From ” and the trailing newline +are excluded.

    +
    + +
    +
    +set_from(from_, time_=None)
    +

    Set the “From ” line to from_, which should be specified without a +leading “From ” or trailing newline. For convenience, time_ may be +specified and will be formatted appropriately and appended to from_. If +time_ is specified, it should be a time.struct_time instance, a +tuple suitable for passing to time.strftime(), or True (to use +time.gmtime()).

    +
    + +
    +
    +get_flags()
    +

    Return a string specifying the flags that are currently set. If the +message complies with the conventional format, the result is the +concatenation in the following order of zero or one occurrence of each of +'R', 'O', 'D', 'F', and 'A'.

    +
    + +
    +
    +set_flags(flags)
    +

    Set the flags specified by flags and unset all others. Parameter flags +should be the concatenation in any order of zero or more occurrences of +each of 'R', 'O', 'D', 'F', and 'A'.

    +
    + +
    +
    +add_flag(flag)
    +

    Set the flag(s) specified by flag without changing other flags. To add +more than one flag at a time, flag may be a string of more than one +character.

    +
    + +
    +
    +remove_flag(flag)
    +

    Unset the flag(s) specified by flag without changing other flags. To +remove more than one flag at a time, flag maybe a string of more than +one character.

    +
    + +
    + +

    When an MMDFMessage instance is created based upon a +MaildirMessage instance, a “From ” line is generated based upon the +MaildirMessage instance’s delivery date, and the following conversions +take place:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + +

    Resulting state

    MaildirMessage state

    R flag

    S flag

    O flag

    “cur” subdirectory

    D flag

    T flag

    F flag

    F flag

    A flag

    R flag

    +

    When an MMDFMessage instance is created based upon an +MHMessage instance, the following conversions take place:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Resulting state

    MHMessage state

    R flag and O flag

    no “unseen” sequence

    O flag

    “unseen” sequence

    F flag

    “flagged” sequence

    A flag

    “replied” sequence

    +

    When an MMDFMessage instance is created based upon a +BabylMessage instance, the following conversions take place:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Resulting state

    BabylMessage state

    R flag and O flag

    no “unseen” label

    O flag

    “unseen” label

    D flag

    “deleted” label

    A flag

    “answered” label

    +

    When an MMDFMessage instance is created based upon an +mboxMessage instance, the “From ” line is copied and all flags directly +correspond:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + +

    Resulting state

    mboxMessage state

    R flag

    R flag

    O flag

    O flag

    D flag

    D flag

    F flag

    F flag

    A flag

    A flag

    +
    +
    +
    +

    Exceptions

    +

    The following exception classes are defined in the mailbox module:

    +
    +
    +exception mailbox.Error
    +

    The based class for all other module-specific exceptions.

    +
    + +
    +
    +exception mailbox.NoSuchMailboxError
    +

    Raised when a mailbox is expected but is not found, such as when instantiating a +Mailbox subclass with a path that does not exist (and with the create +parameter set to False), or when opening a folder that does not exist.

    +
    + +
    +
    +exception mailbox.NotEmptyError
    +

    Raised when a mailbox is not empty but is expected to be, such as when deleting +a folder that contains messages.

    +
    + +
    +
    +exception mailbox.ExternalClashError
    +

    Raised when some mailbox-related condition beyond the control of the program +causes it to be unable to proceed, such as when failing to acquire a lock that +another program already holds a lock, or when a uniquely-generated file name +already exists.

    +
    + +
    +
    +exception mailbox.FormatError
    +

    Raised when the data in a file cannot be parsed, such as when an MH +instance attempts to read a corrupted .mh_sequences file.

    +
    + +
    +
    +

    Examples

    +

    A simple example of printing the subjects of all messages in a mailbox that seem +interesting:

    +
    import mailbox
    +for message in mailbox.mbox('~/mbox'):
    +    subject = message['subject']       # Could possibly be None.
    +    if subject and 'python' in subject.lower():
    +        print(subject)
    +
    +
    +

    To copy all mail from a Babyl mailbox to an MH mailbox, converting all of the +format-specific information that can be converted:

    +
    import mailbox
    +destination = mailbox.MH('~/Mail')
    +destination.lock()
    +for message in mailbox.Babyl('~/RMAIL'):
    +    destination.add(mailbox.MHMessage(message))
    +destination.flush()
    +destination.unlock()
    +
    +
    +

    This example sorts mail from several mailing lists into different mailboxes, +being careful to avoid mail corruption due to concurrent modification by other +programs, mail loss due to interruption of the program, or premature termination +due to malformed messages in the mailbox:

    +
    import mailbox
    +import email.errors
    +
    +list_names = ('python-list', 'python-dev', 'python-bugs')
    +
    +boxes = {name: mailbox.mbox('~/email/%s' % name) for name in list_names}
    +inbox = mailbox.Maildir('~/Maildir', factory=None)
    +
    +for key in inbox.iterkeys():
    +    try:
    +        message = inbox[key]
    +    except email.errors.MessageParseError:
    +        continue                # The message is malformed. Just leave it.
    +
    +    for name in list_names:
    +        list_id = message['list-id']
    +        if list_id and name in list_id:
    +            # Get mailbox to use
    +            box = boxes[name]
    +
    +            # Write copy to disk before removing original.
    +            # If there's a crash, you might duplicate a message, but
    +            # that's better than losing a message completely.
    +            box.lock()
    +            box.add(message)
    +            box.flush()
    +            box.unlock()
    +
    +            # Remove original message
    +            inbox.lock()
    +            inbox.discard(key)
    +            inbox.flush()
    +            inbox.unlock()
    +            break               # Found destination, so stop looking.
    +
    +for box in boxes.itervalues():
    +    box.close()
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/mailcap.html b/python-3.7.4-docs-html/library/mailcap.html new file mode 100644 index 0000000..61edf76 --- /dev/null +++ b/python-3.7.4-docs-html/library/mailcap.html @@ -0,0 +1,246 @@ + + + + + + + mailcap — Mailcap file handling — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    mailcap — Mailcap file handling

    +

    Source code: Lib/mailcap.py

    +
    +

    Mailcap files are used to configure how MIME-aware applications such as mail +readers and Web browsers react to files with different MIME types. (The name +“mailcap” is derived from the phrase “mail capability”.) For example, a mailcap +file might contain a line like video/mpeg; xmpeg %s. Then, if the user +encounters an email message or Web document with the MIME type +video/mpeg, %s will be replaced by a filename (usually one +belonging to a temporary file) and the xmpeg program can be +automatically started to view the file.

    +

    The mailcap format is documented in RFC 1524, “A User Agent Configuration +Mechanism For Multimedia Mail Format Information,” but is not an Internet +standard. However, mailcap files are supported on most Unix systems.

    +
    +
    +mailcap.findmatch(caps, MIMEtype, key='view', filename='/dev/null', plist=[])
    +

    Return a 2-tuple; the first element is a string containing the command line to +be executed (which can be passed to os.system()), and the second element +is the mailcap entry for a given MIME type. If no matching MIME type can be +found, (None, None) is returned.

    +

    key is the name of the field desired, which represents the type of activity to +be performed; the default value is ‘view’, since in the most common case you +simply want to view the body of the MIME-typed data. Other possible values +might be ‘compose’ and ‘edit’, if you wanted to create a new body of the given +MIME type or alter the existing body data. See RFC 1524 for a complete list +of these fields.

    +

    filename is the filename to be substituted for %s in the command line; the +default value is '/dev/null' which is almost certainly not what you want, so +usually you’ll override it by specifying a filename.

    +

    plist can be a list containing named parameters; the default value is simply +an empty list. Each entry in the list must be a string containing the parameter +name, an equals sign ('='), and the parameter’s value. Mailcap entries can +contain named parameters like %{foo}, which will be replaced by the value +of the parameter named ‘foo’. For example, if the command line showpartial +%{id} %{number} %{total} was in a mailcap file, and plist was set to +['id=1', 'number=2', 'total=3'], the resulting command line would be +'showpartial 1 2 3'.

    +

    In a mailcap file, the “test” field can optionally be specified to test some +external condition (such as the machine architecture, or the window system in +use) to determine whether or not the mailcap line applies. findmatch() +will automatically check such conditions and skip the entry if the check fails.

    +
    + +
    +
    +mailcap.getcaps()
    +

    Returns a dictionary mapping MIME types to a list of mailcap file entries. This +dictionary must be passed to the findmatch() function. An entry is stored +as a list of dictionaries, but it shouldn’t be necessary to know the details of +this representation.

    +

    The information is derived from all of the mailcap files found on the system. +Settings in the user’s mailcap file $HOME/.mailcap will override +settings in the system mailcap files /etc/mailcap, +/usr/etc/mailcap, and /usr/local/etc/mailcap.

    +
    + +

    An example usage:

    +
    >>> import mailcap
    +>>> d = mailcap.getcaps()
    +>>> mailcap.findmatch(d, 'video/mpeg', filename='tmp1223')
    +('xmpeg tmp1223', {'view': 'xmpeg %s'})
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/markup.html b/python-3.7.4-docs-html/library/markup.html new file mode 100644 index 0000000..32f6d5f --- /dev/null +++ b/python-3.7.4-docs-html/library/markup.html @@ -0,0 +1,295 @@ + + + + + + + Structured Markup Processing Tools — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Structured Markup Processing Tools

    +

    Python supports a variety of modules to work with various forms of structured +data markup. This includes modules to work with the Standard Generalized Markup +Language (SGML) and the Hypertext Markup Language (HTML), and several interfaces +for working with the Extensible Markup Language (XML).

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/marshal.html b/python-3.7.4-docs-html/library/marshal.html new file mode 100644 index 0000000..b739ce3 --- /dev/null +++ b/python-3.7.4-docs-html/library/marshal.html @@ -0,0 +1,284 @@ + + + + + + + marshal — Internal Python object serialization — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    marshal — Internal Python object serialization

    +
    +

    This module contains functions that can read and write Python values in a binary +format. The format is specific to Python, but independent of machine +architecture issues (e.g., you can write a Python value to a file on a PC, +transport the file to a Sun, and read it back there). Details of the format are +undocumented on purpose; it may change between Python versions (although it +rarely does). 1

    +

    This is not a general “persistence” module. For general persistence and +transfer of Python objects through RPC calls, see the modules pickle and +shelve. The marshal module exists mainly to support reading and +writing the “pseudo-compiled” code for Python modules of .pyc files. +Therefore, the Python maintainers reserve the right to modify the marshal format +in backward incompatible ways should the need arise. If you’re serializing and +de-serializing Python objects, use the pickle module instead – the +performance is comparable, version independence is guaranteed, and pickle +supports a substantially wider range of objects than marshal.

    +
    +

    Warning

    +

    The marshal module is not intended to be secure against erroneous or +maliciously constructed data. Never unmarshal data received from an +untrusted or unauthenticated source.

    +
    +

    Not all Python object types are supported; in general, only objects whose value +is independent from a particular invocation of Python can be written and read by +this module. The following types are supported: booleans, integers, floating +point numbers, complex numbers, strings, bytes, bytearrays, tuples, lists, sets, +frozensets, dictionaries, and code objects, where it should be understood that +tuples, lists, sets, frozensets and dictionaries are only supported as long as +the values contained therein are themselves supported. The +singletons None, Ellipsis and StopIteration can also be +marshalled and unmarshalled. +For format version lower than 3, recursive lists, sets and dictionaries cannot +be written (see below).

    +

    There are functions that read/write files as well as functions operating on +bytes-like objects.

    +

    The module defines these functions:

    +
    +
    +marshal.dump(value, file[, version])
    +

    Write the value on the open file. The value must be a supported type. The +file must be a writeable binary file.

    +

    If the value has (or contains an object that has) an unsupported type, a +ValueError exception is raised — but garbage data will also be written +to the file. The object will not be properly read back by load().

    +

    The version argument indicates the data format that dump should use +(see below).

    +
    + +
    +
    +marshal.load(file)
    +

    Read one value from the open file and return it. If no valid value is read +(e.g. because the data has a different Python version’s incompatible marshal +format), raise EOFError, ValueError or TypeError. The +file must be a readable binary file.

    +
    +

    Note

    +

    If an object containing an unsupported type was marshalled with dump(), +load() will substitute None for the unmarshallable type.

    +
    +
    + +
    +
    +marshal.dumps(value[, version])
    +

    Return the bytes object that would be written to a file by dump(value, file). The +value must be a supported type. Raise a ValueError exception if value +has (or contains an object that has) an unsupported type.

    +

    The version argument indicates the data format that dumps should use +(see below).

    +
    + +
    +
    +marshal.loads(bytes)
    +

    Convert the bytes-like object to a value. If no valid value is found, raise +EOFError, ValueError or TypeError. Extra bytes in the +input are ignored.

    +
    + +

    In addition, the following constants are defined:

    +
    +
    +marshal.version
    +

    Indicates the format that the module uses. Version 0 is the historical +format, version 1 shares interned strings and version 2 uses a binary format +for floating point numbers. +Version 3 adds support for object instancing and recursion. +The current version is 4.

    +
    + +

    Footnotes

    +
    +
    1
    +

    The name of this module stems from a bit of terminology used by the designers of +Modula-3 (amongst others), who use the term “marshalling” for shipping of data +around in a self-contained form. Strictly speaking, “to marshal” means to +convert some data from internal to external form (in an RPC buffer for instance) +and “unmarshalling” for the reverse process.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/math.html b/python-3.7.4-docs-html/library/math.html new file mode 100644 index 0000000..e49450b --- /dev/null +++ b/python-3.7.4-docs-html/library/math.html @@ -0,0 +1,735 @@ + + + + + + + math — Mathematical functions — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    math — Mathematical functions

    +
    +

    This module provides access to the mathematical functions defined by the C +standard.

    +

    These functions cannot be used with complex numbers; use the functions of the +same name from the cmath module if you require support for complex +numbers. The distinction between functions which support complex numbers and +those which don’t is made since most users do not want to learn quite as much +mathematics as required to understand complex numbers. Receiving an exception +instead of a complex result allows earlier detection of the unexpected complex +number used as a parameter, so that the programmer can determine how and why it +was generated in the first place.

    +

    The following functions are provided by this module. Except when explicitly +noted otherwise, all return values are floats.

    +
    +

    Number-theoretic and representation functions

    +
    +
    +math.ceil(x)
    +

    Return the ceiling of x, the smallest integer greater than or equal to x. +If x is not a float, delegates to x.__ceil__(), which should return an +Integral value.

    +
    + +
    +
    +math.copysign(x, y)
    +

    Return a float with the magnitude (absolute value) of x but the sign of +y. On platforms that support signed zeros, copysign(1.0, -0.0) +returns -1.0.

    +
    + +
    +
    +math.fabs(x)
    +

    Return the absolute value of x.

    +
    + +
    +
    +math.factorial(x)
    +

    Return x factorial as an integer. Raises ValueError if x is not integral or +is negative.

    +
    + +
    +
    +math.floor(x)
    +

    Return the floor of x, the largest integer less than or equal to x. +If x is not a float, delegates to x.__floor__(), which should return an +Integral value.

    +
    + +
    +
    +math.fmod(x, y)
    +

    Return fmod(x, y), as defined by the platform C library. Note that the +Python expression x % y may not return the same result. The intent of the C +standard is that fmod(x, y) be exactly (mathematically; to infinite +precision) equal to x - n*y for some integer n such that the result has +the same sign as x and magnitude less than abs(y). Python’s x % y +returns a result with the sign of y instead, and may not be exactly computable +for float arguments. For example, fmod(-1e-100, 1e100) is -1e-100, but +the result of Python’s -1e-100 % 1e100 is 1e100-1e-100, which cannot be +represented exactly as a float, and rounds to the surprising 1e100. For +this reason, function fmod() is generally preferred when working with +floats, while Python’s x % y is preferred when working with integers.

    +
    + +
    +
    +math.frexp(x)
    +

    Return the mantissa and exponent of x as the pair (m, e). m is a float +and e is an integer such that x == m * 2**e exactly. If x is zero, +returns (0.0, 0), otherwise 0.5 <= abs(m) < 1. This is used to “pick +apart” the internal representation of a float in a portable way.

    +
    + +
    +
    +math.fsum(iterable)
    +

    Return an accurate floating point sum of values in the iterable. Avoids +loss of precision by tracking multiple intermediate partial sums:

    +
    >>> sum([.1, .1, .1, .1, .1, .1, .1, .1, .1, .1])
    +0.9999999999999999
    +>>> fsum([.1, .1, .1, .1, .1, .1, .1, .1, .1, .1])
    +1.0
    +
    +
    +

    The algorithm’s accuracy depends on IEEE-754 arithmetic guarantees and the +typical case where the rounding mode is half-even. On some non-Windows +builds, the underlying C library uses extended precision addition and may +occasionally double-round an intermediate sum causing it to be off in its +least significant bit.

    +

    For further discussion and two alternative approaches, see the ASPN cookbook +recipes for accurate floating point summation.

    +
    + +
    +
    +math.gcd(a, b)
    +

    Return the greatest common divisor of the integers a and b. If either +a or b is nonzero, then the value of gcd(a, b) is the largest +positive integer that divides both a and b. gcd(0, 0) returns +0.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +math.isclose(a, b, *, rel_tol=1e-09, abs_tol=0.0)
    +

    Return True if the values a and b are close to each other and +False otherwise.

    +

    Whether or not two values are considered close is determined according to +given absolute and relative tolerances.

    +

    rel_tol is the relative tolerance – it is the maximum allowed difference +between a and b, relative to the larger absolute value of a or b. +For example, to set a tolerance of 5%, pass rel_tol=0.05. The default +tolerance is 1e-09, which assures that the two values are the same +within about 9 decimal digits. rel_tol must be greater than zero.

    +

    abs_tol is the minimum absolute tolerance – useful for comparisons near +zero. abs_tol must be at least zero.

    +

    If no errors occur, the result will be: +abs(a-b) <= max(rel_tol * max(abs(a), abs(b)), abs_tol).

    +

    The IEEE 754 special values of NaN, inf, and -inf will be +handled according to IEEE rules. Specifically, NaN is not considered +close to any other value, including NaN. inf and -inf are only +considered close to themselves.

    +
    +

    New in version 3.5.

    +
    +
    +

    See also

    +

    PEP 485 – A function for testing approximate equality

    +
    +
    + +
    +
    +math.isfinite(x)
    +

    Return True if x is neither an infinity nor a NaN, and +False otherwise. (Note that 0.0 is considered finite.)

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +math.isinf(x)
    +

    Return True if x is a positive or negative infinity, and +False otherwise.

    +
    + +
    +
    +math.isnan(x)
    +

    Return True if x is a NaN (not a number), and False otherwise.

    +
    + +
    +
    +math.ldexp(x, i)
    +

    Return x * (2**i). This is essentially the inverse of function +frexp().

    +
    + +
    +
    +math.modf(x)
    +

    Return the fractional and integer parts of x. Both results carry the sign +of x and are floats.

    +
    + +
    +
    +math.remainder(x, y)
    +

    Return the IEEE 754-style remainder of x with respect to y. For +finite x and finite nonzero y, this is the difference x - n*y, +where n is the closest integer to the exact value of the quotient x / +y. If x / y is exactly halfway between two consecutive integers, the +nearest even integer is used for n. The remainder r = remainder(x, +y) thus always satisfies abs(r) <= 0.5 * abs(y).

    +

    Special cases follow IEEE 754: in particular, remainder(x, math.inf) is +x for any finite x, and remainder(x, 0) and +remainder(math.inf, x) raise ValueError for any non-NaN x. +If the result of the remainder operation is zero, that zero will have +the same sign as x.

    +

    On platforms using IEEE 754 binary floating-point, the result of this +operation is always exactly representable: no rounding error is introduced.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +math.trunc(x)
    +

    Return the Real value x truncated to an +Integral (usually an integer). Delegates to +x.__trunc__().

    +
    + +

    Note that frexp() and modf() have a different call/return pattern +than their C equivalents: they take a single argument and return a pair of +values, rather than returning their second return value through an ‘output +parameter’ (there is no such thing in Python).

    +

    For the ceil(), floor(), and modf() functions, note that all +floating-point numbers of sufficiently large magnitude are exact integers. +Python floats typically carry no more than 53 bits of precision (the same as the +platform C double type), in which case any float x with abs(x) >= 2**52 +necessarily has no fractional bits.

    +
    +
    +

    Power and logarithmic functions

    +
    +
    +math.exp(x)
    +

    Return e raised to the power x, where e = 2.718281… is the base +of natural logarithms. This is usually more accurate than math.e ** x +or pow(math.e, x).

    +
    + +
    +
    +math.expm1(x)
    +

    Return e raised to the power x, minus 1. Here e is the base of natural +logarithms. For small floats x, the subtraction in exp(x) - 1 +can result in a significant loss of precision; the expm1() +function provides a way to compute this quantity to full precision:

    +
    >>> from math import exp, expm1
    +>>> exp(1e-5) - 1  # gives result accurate to 11 places
    +1.0000050000069649e-05
    +>>> expm1(1e-5)    # result accurate to full precision
    +1.0000050000166668e-05
    +
    +
    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +math.log(x[, base])
    +

    With one argument, return the natural logarithm of x (to base e).

    +

    With two arguments, return the logarithm of x to the given base, +calculated as log(x)/log(base).

    +
    + +
    +
    +math.log1p(x)
    +

    Return the natural logarithm of 1+x (base e). The +result is calculated in a way which is accurate for x near zero.

    +
    + +
    +
    +math.log2(x)
    +

    Return the base-2 logarithm of x. This is usually more accurate than +log(x, 2).

    +
    +

    New in version 3.3.

    +
    +
    +

    See also

    +

    int.bit_length() returns the number of bits necessary to represent +an integer in binary, excluding the sign and leading zeros.

    +
    +
    + +
    +
    +math.log10(x)
    +

    Return the base-10 logarithm of x. This is usually more accurate +than log(x, 10).

    +
    + +
    +
    +math.pow(x, y)
    +

    Return x raised to the power y. Exceptional cases follow +Annex ‘F’ of the C99 standard as far as possible. In particular, +pow(1.0, x) and pow(x, 0.0) always return 1.0, even +when x is a zero or a NaN. If both x and y are finite, +x is negative, and y is not an integer then pow(x, y) +is undefined, and raises ValueError.

    +

    Unlike the built-in ** operator, math.pow() converts both +its arguments to type float. Use ** or the built-in +pow() function for computing exact integer powers.

    +
    + +
    +
    +math.sqrt(x)
    +

    Return the square root of x.

    +
    + +
    +
    +

    Trigonometric functions

    +
    +
    +math.acos(x)
    +

    Return the arc cosine of x, in radians.

    +
    + +
    +
    +math.asin(x)
    +

    Return the arc sine of x, in radians.

    +
    + +
    +
    +math.atan(x)
    +

    Return the arc tangent of x, in radians.

    +
    + +
    +
    +math.atan2(y, x)
    +

    Return atan(y / x), in radians. The result is between -pi and pi. +The vector in the plane from the origin to point (x, y) makes this angle +with the positive X axis. The point of atan2() is that the signs of both +inputs are known to it, so it can compute the correct quadrant for the angle. +For example, atan(1) and atan2(1, 1) are both pi/4, but atan2(-1, +-1) is -3*pi/4.

    +
    + +
    +
    +math.cos(x)
    +

    Return the cosine of x radians.

    +
    + +
    +
    +math.hypot(x, y)
    +

    Return the Euclidean norm, sqrt(x*x + y*y). This is the length of the vector +from the origin to point (x, y).

    +
    + +
    +
    +math.sin(x)
    +

    Return the sine of x radians.

    +
    + +
    +
    +math.tan(x)
    +

    Return the tangent of x radians.

    +
    + +
    +
    +

    Angular conversion

    +
    +
    +math.degrees(x)
    +

    Convert angle x from radians to degrees.

    +
    + +
    +
    +math.radians(x)
    +

    Convert angle x from degrees to radians.

    +
    + +
    +
    +

    Hyperbolic functions

    +

    Hyperbolic functions +are analogs of trigonometric functions that are based on hyperbolas +instead of circles.

    +
    +
    +math.acosh(x)
    +

    Return the inverse hyperbolic cosine of x.

    +
    + +
    +
    +math.asinh(x)
    +

    Return the inverse hyperbolic sine of x.

    +
    + +
    +
    +math.atanh(x)
    +

    Return the inverse hyperbolic tangent of x.

    +
    + +
    +
    +math.cosh(x)
    +

    Return the hyperbolic cosine of x.

    +
    + +
    +
    +math.sinh(x)
    +

    Return the hyperbolic sine of x.

    +
    + +
    +
    +math.tanh(x)
    +

    Return the hyperbolic tangent of x.

    +
    + +
    +
    +

    Special functions

    +
    +
    +math.erf(x)
    +

    Return the error function at +x.

    +

    The erf() function can be used to compute traditional statistical +functions such as the cumulative standard normal distribution:

    +
    def phi(x):
    +    'Cumulative distribution function for the standard normal distribution'
    +    return (1.0 + erf(x / sqrt(2.0))) / 2.0
    +
    +
    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +math.erfc(x)
    +

    Return the complementary error function at x. The complementary error +function is defined as +1.0 - erf(x). It is used for large values of x where a subtraction +from one would cause a loss of significance.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +math.gamma(x)
    +

    Return the Gamma function at +x.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +math.lgamma(x)
    +

    Return the natural logarithm of the absolute value of the Gamma +function at x.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +

    Constants

    +
    +
    +math.pi
    +

    The mathematical constant π = 3.141592…, to available precision.

    +
    + +
    +
    +math.e
    +

    The mathematical constant e = 2.718281…, to available precision.

    +
    + +
    +
    +math.tau
    +

    The mathematical constant τ = 6.283185…, to available precision. +Tau is a circle constant equal to 2π, the ratio of a circle’s circumference to +its radius. To learn more about Tau, check out Vi Hart’s video Pi is (still) +Wrong, and start celebrating +Tau day by eating twice as much pie!

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +math.inf
    +

    A floating-point positive infinity. (For negative infinity, use +-math.inf.) Equivalent to the output of float('inf').

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +math.nan
    +

    A floating-point “not a number” (NaN) value. Equivalent to the output of +float('nan').

    +
    +

    New in version 3.5.

    +
    +
    + +
    +

    CPython implementation detail: The math module consists mostly of thin wrappers around the platform C +math library functions. Behavior in exceptional cases follows Annex F of +the C99 standard where appropriate. The current implementation will raise +ValueError for invalid operations like sqrt(-1.0) or log(0.0) +(where C99 Annex F recommends signaling invalid operation or divide-by-zero), +and OverflowError for results that overflow (for example, +exp(1000.0)). A NaN will not be returned from any of the functions +above unless one or more of the input arguments was a NaN; in that case, +most functions will return a NaN, but (again following C99 Annex F) there +are some exceptions to this rule, for example pow(float('nan'), 0.0) or +hypot(float('nan'), float('inf')).

    +

    Note that Python makes no effort to distinguish signaling NaNs from +quiet NaNs, and behavior for signaling NaNs remains unspecified. +Typical behavior is to treat all NaNs as though they were quiet.

    +
    +
    +

    See also

    +
    +
    Module cmath

    Complex number versions of many of these functions.

    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/mimetypes.html b/python-3.7.4-docs-html/library/mimetypes.html new file mode 100644 index 0000000..c61b807 --- /dev/null +++ b/python-3.7.4-docs-html/library/mimetypes.html @@ -0,0 +1,447 @@ + + + + + + + mimetypes — Map filenames to MIME types — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    mimetypes — Map filenames to MIME types

    +

    Source code: Lib/mimetypes.py

    +
    +

    The mimetypes module converts between a filename or URL and the MIME type +associated with the filename extension. Conversions are provided from filename +to MIME type and from MIME type to filename extension; encodings are not +supported for the latter conversion.

    +

    The module provides one class and a number of convenience functions. The +functions are the normal interface to this module, but some applications may be +interested in the class as well.

    +

    The functions described below provide the primary interface for this module. If +the module has not been initialized, they will call init() if they rely on +the information init() sets up.

    +
    +
    +mimetypes.guess_type(url, strict=True)
    +

    Guess the type of a file based on its filename or URL, given by url. The +return value is a tuple (type, encoding) where type is None if the +type can’t be guessed (missing or unknown suffix) or a string of the form +'type/subtype', usable for a MIME content-type header.

    +

    encoding is None for no encoding or the name of the program used to encode +(e.g. compress or gzip). The encoding is suitable for use +as a Content-Encoding header, not as a +Content-Transfer-Encoding header. The mappings are table driven. +Encoding suffixes are case sensitive; type suffixes are first tried case +sensitively, then case insensitively.

    +

    The optional strict argument is a flag specifying whether the list of known MIME types +is limited to only the official types registered with IANA. +When strict is True (the default), only the IANA types are supported; when +strict is False, some additional non-standard but commonly used MIME types +are also recognized.

    +
    + +
    +
    +mimetypes.guess_all_extensions(type, strict=True)
    +

    Guess the extensions for a file based on its MIME type, given by type. The +return value is a list of strings giving all possible filename extensions, +including the leading dot ('.'). The extensions are not guaranteed to have +been associated with any particular data stream, but would be mapped to the MIME +type type by guess_type().

    +

    The optional strict argument has the same meaning as with the guess_type() function.

    +
    + +
    +
    +mimetypes.guess_extension(type, strict=True)
    +

    Guess the extension for a file based on its MIME type, given by type. The +return value is a string giving a filename extension, including the leading dot +('.'). The extension is not guaranteed to have been associated with any +particular data stream, but would be mapped to the MIME type type by +guess_type(). If no extension can be guessed for type, None is +returned.

    +

    The optional strict argument has the same meaning as with the guess_type() function.

    +
    + +

    Some additional functions and data items are available for controlling the +behavior of the module.

    +
    +
    +mimetypes.init(files=None)
    +

    Initialize the internal data structures. If given, files must be a sequence +of file names which should be used to augment the default type map. If omitted, +the file names to use are taken from knownfiles; on Windows, the +current registry settings are loaded. Each file named in files or +knownfiles takes precedence over those named before it. Calling +init() repeatedly is allowed.

    +

    Specifying an empty list for files will prevent the system defaults from +being applied: only the well-known values will be present from a built-in list.

    +

    If files is None the internal data structure is completely rebuilt to its +initial default value. This is a stable operation and will produce the same results +when called multiple times.

    +
    +

    Changed in version 3.2: Previously, Windows registry settings were ignored.

    +
    +
    + +
    +
    +mimetypes.read_mime_types(filename)
    +

    Load the type map given in the file filename, if it exists. The type map is +returned as a dictionary mapping filename extensions, including the leading dot +('.'), to strings of the form 'type/subtype'. If the file filename +does not exist or cannot be read, None is returned.

    +
    + +
    +
    +mimetypes.add_type(type, ext, strict=True)
    +

    Add a mapping from the MIME type type to the extension ext. When the +extension is already known, the new type will replace the old one. When the type +is already known the extension will be added to the list of known extensions.

    +

    When strict is True (the default), the mapping will be added to the +official MIME types, otherwise to the non-standard ones.

    +
    + +
    +
    +mimetypes.inited
    +

    Flag indicating whether or not the global data structures have been initialized. +This is set to True by init().

    +
    + +
    +
    +mimetypes.knownfiles
    +

    List of type map file names commonly installed. These files are typically named +mime.types and are installed in different locations by different +packages.

    +
    + +
    +
    +mimetypes.suffix_map
    +

    Dictionary mapping suffixes to suffixes. This is used to allow recognition of +encoded files for which the encoding and the type are indicated by the same +extension. For example, the .tgz extension is mapped to .tar.gz +to allow the encoding and type to be recognized separately.

    +
    + +
    +
    +mimetypes.encodings_map
    +

    Dictionary mapping filename extensions to encoding types.

    +
    + +
    +
    +mimetypes.types_map
    +

    Dictionary mapping filename extensions to MIME types.

    +
    + +
    +
    +mimetypes.common_types
    +

    Dictionary mapping filename extensions to non-standard, but commonly found MIME +types.

    +
    + +

    An example usage of the module:

    +
    >>> import mimetypes
    +>>> mimetypes.init()
    +>>> mimetypes.knownfiles
    +['/etc/mime.types', '/etc/httpd/mime.types', ... ]
    +>>> mimetypes.suffix_map['.tgz']
    +'.tar.gz'
    +>>> mimetypes.encodings_map['.gz']
    +'gzip'
    +>>> mimetypes.types_map['.tgz']
    +'application/x-tar-gz'
    +
    +
    +
    +

    MimeTypes Objects

    +

    The MimeTypes class may be useful for applications which may want more +than one MIME-type database; it provides an interface similar to the one of the +mimetypes module.

    +
    +
    +class mimetypes.MimeTypes(filenames=(), strict=True)
    +

    This class represents a MIME-types database. By default, it provides access to +the same database as the rest of this module. The initial database is a copy of +that provided by the module, and may be extended by loading additional +mime.types-style files into the database using the read() or +readfp() methods. The mapping dictionaries may also be cleared before +loading additional data if the default data is not desired.

    +

    The optional filenames parameter can be used to cause additional files to be +loaded “on top” of the default database.

    +
    +
    +suffix_map
    +

    Dictionary mapping suffixes to suffixes. This is used to allow recognition of +encoded files for which the encoding and the type are indicated by the same +extension. For example, the .tgz extension is mapped to .tar.gz +to allow the encoding and type to be recognized separately. This is initially a +copy of the global suffix_map defined in the module.

    +
    + +
    +
    +encodings_map
    +

    Dictionary mapping filename extensions to encoding types. This is initially a +copy of the global encodings_map defined in the module.

    +
    + +
    +
    +types_map
    +

    Tuple containing two dictionaries, mapping filename extensions to MIME types: +the first dictionary is for the non-standards types and the second one is for +the standard types. They are initialized by common_types and +types_map.

    +
    + +
    +
    +types_map_inv
    +

    Tuple containing two dictionaries, mapping MIME types to a list of filename +extensions: the first dictionary is for the non-standards types and the +second one is for the standard types. They are initialized by +common_types and types_map.

    +
    + +
    +
    +guess_extension(type, strict=True)
    +

    Similar to the guess_extension() function, using the tables stored as part +of the object.

    +
    + +
    +
    +guess_type(url, strict=True)
    +

    Similar to the guess_type() function, using the tables stored as part of +the object.

    +
    + +
    +
    +guess_all_extensions(type, strict=True)
    +

    Similar to the guess_all_extensions() function, using the tables stored +as part of the object.

    +
    + +
    +
    +read(filename, strict=True)
    +

    Load MIME information from a file named filename. This uses readfp() to +parse the file.

    +

    If strict is True, information will be added to list of standard types, +else to the list of non-standard types.

    +
    + +
    +
    +readfp(fp, strict=True)
    +

    Load MIME type information from an open file fp. The file must have the format of +the standard mime.types files.

    +

    If strict is True, information will be added to the list of standard +types, else to the list of non-standard types.

    +
    + +
    +
    +read_windows_registry(strict=True)
    +

    Load MIME type information from the Windows registry.

    +

    Availability: Windows.

    +

    If strict is True, information will be added to the list of standard +types, else to the list of non-standard types.

    +
    +

    New in version 3.2.

    +
    +
    + +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/misc.html b/python-3.7.4-docs-html/library/misc.html new file mode 100644 index 0000000..9edf629 --- /dev/null +++ b/python-3.7.4-docs-html/library/misc.html @@ -0,0 +1,194 @@ + + + + + + + Miscellaneous Services — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Miscellaneous Services

    +

    The modules described in this chapter provide miscellaneous services that are +available in all Python versions. Here’s an overview:

    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/mm.html b/python-3.7.4-docs-html/library/mm.html new file mode 100644 index 0000000..06966ae --- /dev/null +++ b/python-3.7.4-docs-html/library/mm.html @@ -0,0 +1,209 @@ + + + + + + + Multimedia Services — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/mmap.html b/python-3.7.4-docs-html/library/mmap.html new file mode 100644 index 0000000..f11fb50 --- /dev/null +++ b/python-3.7.4-docs-html/library/mmap.html @@ -0,0 +1,471 @@ + + + + + + + mmap — Memory-mapped file support — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    mmap — Memory-mapped file support

    +
    +

    Memory-mapped file objects behave like both bytearray and like +file objects. You can use mmap objects in most places +where bytearray are expected; for example, you can use the re +module to search through a memory-mapped file. You can also change a single +byte by doing obj[index] = 97, or change a subsequence by assigning to a +slice: obj[i1:i2] = b'...'. You can also read and write data starting at +the current file position, and seek() through the file to different positions.

    +

    A memory-mapped file is created by the mmap constructor, which is +different on Unix and on Windows. In either case you must provide a file +descriptor for a file opened for update. If you wish to map an existing Python +file object, use its fileno() method to obtain the correct value for the +fileno parameter. Otherwise, you can open the file using the +os.open() function, which returns a file descriptor directly (the file +still needs to be closed when done).

    +
    +

    Note

    +

    If you want to create a memory-mapping for a writable, buffered file, you +should flush() the file first. This is necessary to ensure +that local modifications to the buffers are actually available to the +mapping.

    +
    +

    For both the Unix and Windows versions of the constructor, access may be +specified as an optional keyword parameter. access accepts one of four +values: ACCESS_READ, ACCESS_WRITE, or ACCESS_COPY to +specify read-only, write-through or copy-on-write memory respectively, or +ACCESS_DEFAULT to defer to prot. access can be used on both Unix +and Windows. If access is not specified, Windows mmap returns a +write-through mapping. The initial memory values for all three access types +are taken from the specified file. Assignment to an ACCESS_READ +memory map raises a TypeError exception. Assignment to an +ACCESS_WRITE memory map affects both memory and the underlying file. +Assignment to an ACCESS_COPY memory map affects memory but does not +update the underlying file.

    +
    +

    Changed in version 3.7: Added ACCESS_DEFAULT constant.

    +
    +

    To map anonymous memory, -1 should be passed as the fileno along with the length.

    +
    +
    +class mmap.mmap(fileno, length, tagname=None, access=ACCESS_DEFAULT[, offset])
    +

    (Windows version) Maps length bytes from the file specified by the +file handle fileno, and creates a mmap object. If length is larger +than the current size of the file, the file is extended to contain length +bytes. If length is 0, the maximum length of the map is the current +size of the file, except that if the file is empty Windows raises an +exception (you cannot create an empty mapping on Windows).

    +

    tagname, if specified and not None, is a string giving a tag name for +the mapping. Windows allows you to have many different mappings against +the same file. If you specify the name of an existing tag, that tag is +opened, otherwise a new tag of this name is created. If this parameter is +omitted or None, the mapping is created without a name. Avoiding the +use of the tag parameter will assist in keeping your code portable between +Unix and Windows.

    +

    offset may be specified as a non-negative integer offset. mmap references +will be relative to the offset from the beginning of the file. offset +defaults to 0. offset must be a multiple of the ALLOCATIONGRANULARITY.

    +
    + +
    +
    +class mmap.mmap(fileno, length, flags=MAP_SHARED, prot=PROT_WRITE|PROT_READ, access=ACCESS_DEFAULT[, offset])
    +

    (Unix version) Maps length bytes from the file specified by the file +descriptor fileno, and returns a mmap object. If length is 0, the +maximum length of the map will be the current size of the file when +mmap is called.

    +

    flags specifies the nature of the mapping. MAP_PRIVATE creates a +private copy-on-write mapping, so changes to the contents of the mmap +object will be private to this process, and MAP_SHARED creates a +mapping that’s shared with all other processes mapping the same areas of +the file. The default value is MAP_SHARED.

    +

    prot, if specified, gives the desired memory protection; the two most +useful values are PROT_READ and PROT_WRITE, to specify +that the pages may be read or written. prot defaults to +PROT_READ | PROT_WRITE.

    +

    access may be specified in lieu of flags and prot as an optional +keyword parameter. It is an error to specify both flags, prot and +access. See the description of access above for information on how to +use this parameter.

    +

    offset may be specified as a non-negative integer offset. mmap references +will be relative to the offset from the beginning of the file. offset +defaults to 0. offset must be a multiple of ALLOCATIONGRANULARITY +which is equal to PAGESIZE on Unix systems.

    +

    To ensure validity of the created memory mapping the file specified +by the descriptor fileno is internally automatically synchronized +with physical backing store on Mac OS X and OpenVMS.

    +

    This example shows a simple way of using mmap:

    +
    import mmap
    +
    +# write a simple example file
    +with open("hello.txt", "wb") as f:
    +    f.write(b"Hello Python!\n")
    +
    +with open("hello.txt", "r+b") as f:
    +    # memory-map the file, size 0 means whole file
    +    mm = mmap.mmap(f.fileno(), 0)
    +    # read content via standard file methods
    +    print(mm.readline())  # prints b"Hello Python!\n"
    +    # read content via slice notation
    +    print(mm[:5])  # prints b"Hello"
    +    # update content using slice notation;
    +    # note that new content must have same size
    +    mm[6:] = b" world!\n"
    +    # ... and read again using standard file methods
    +    mm.seek(0)
    +    print(mm.readline())  # prints b"Hello  world!\n"
    +    # close the map
    +    mm.close()
    +
    +
    +

    mmap can also be used as a context manager in a with +statement:

    +
    import mmap
    +
    +with mmap.mmap(-1, 13) as mm:
    +    mm.write(b"Hello world!")
    +
    +
    +
    +

    New in version 3.2: Context manager support.

    +
    +

    The next example demonstrates how to create an anonymous map and exchange +data between the parent and child processes:

    +
    import mmap
    +import os
    +
    +mm = mmap.mmap(-1, 13)
    +mm.write(b"Hello world!")
    +
    +pid = os.fork()
    +
    +if pid == 0:  # In a child process
    +    mm.seek(0)
    +    print(mm.readline())
    +
    +    mm.close()
    +
    +
    +

    Memory-mapped file objects support the following methods:

    +
    +
    +close()
    +

    Closes the mmap. Subsequent calls to other methods of the object will +result in a ValueError exception being raised. This will not close +the open file.

    +
    + +
    +
    +closed
    +

    True if the file is closed.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +find(sub[, start[, end]])
    +

    Returns the lowest index in the object where the subsequence sub is +found, such that sub is contained in the range [start, end]. +Optional arguments start and end are interpreted as in slice notation. +Returns -1 on failure.

    +
    +

    Changed in version 3.5: Writable bytes-like object is now accepted.

    +
    +
    + +
    +
    +flush([offset[, size]])
    +

    Flushes changes made to the in-memory copy of a file back to disk. Without +use of this call there is no guarantee that changes are written back before +the object is destroyed. If offset and size are specified, only +changes to the given range of bytes will be flushed to disk; otherwise, the +whole extent of the mapping is flushed. offset must be a multiple of the +PAGESIZE or ALLOCATIONGRANULARITY.

    +

    (Windows version) A nonzero value returned indicates success; zero +indicates failure.

    +

    (Unix version) A zero value is returned to indicate success. An +exception is raised when the call failed.

    +
    + +
    +
    +move(dest, src, count)
    +

    Copy the count bytes starting at offset src to the destination index +dest. If the mmap was created with ACCESS_READ, then calls to +move will raise a TypeError exception.

    +
    + +
    +
    +read([n])
    +

    Return a bytes containing up to n bytes starting from the +current file position. If the argument is omitted, None or negative, +return all bytes from the current file position to the end of the +mapping. The file position is updated to point after the bytes that were +returned.

    +
    +

    Changed in version 3.3: Argument can be omitted or None.

    +
    +
    + +
    +
    +read_byte()
    +

    Returns a byte at the current file position as an integer, and advances +the file position by 1.

    +
    + +
    +
    +readline()
    +

    Returns a single line, starting at the current file position and up to the +next newline.

    +
    + +
    +
    +resize(newsize)
    +

    Resizes the map and the underlying file, if any. If the mmap was created +with ACCESS_READ or ACCESS_COPY, resizing the map will +raise a TypeError exception.

    +
    + +
    +
    +rfind(sub[, start[, end]])
    +

    Returns the highest index in the object where the subsequence sub is +found, such that sub is contained in the range [start, end]. +Optional arguments start and end are interpreted as in slice notation. +Returns -1 on failure.

    +
    +

    Changed in version 3.5: Writable bytes-like object is now accepted.

    +
    +
    + +
    +
    +seek(pos[, whence])
    +

    Set the file’s current position. whence argument is optional and +defaults to os.SEEK_SET or 0 (absolute file positioning); other +values are os.SEEK_CUR or 1 (seek relative to the current +position) and os.SEEK_END or 2 (seek relative to the file’s end).

    +
    + +
    +
    +size()
    +

    Return the length of the file, which can be larger than the size of the +memory-mapped area.

    +
    + +
    +
    +tell()
    +

    Returns the current position of the file pointer.

    +
    + +
    +
    +write(bytes)
    +

    Write the bytes in bytes into memory at the current position of the +file pointer and return the number of bytes written (never less than +len(bytes), since if the write fails, a ValueError will be +raised). The file position is updated to point after the bytes that +were written. If the mmap was created with ACCESS_READ, then +writing to it will raise a TypeError exception.

    +
    +

    Changed in version 3.5: Writable bytes-like object is now accepted.

    +
    +
    +

    Changed in version 3.6: The number of bytes written is now returned.

    +
    +
    + +
    +
    +write_byte(byte)
    +

    Write the integer byte into memory at the current +position of the file pointer; the file position is advanced by 1. If +the mmap was created with ACCESS_READ, then writing to it will +raise a TypeError exception.

    +
    + +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/modulefinder.html b/python-3.7.4-docs-html/library/modulefinder.html new file mode 100644 index 0000000..1166c6d --- /dev/null +++ b/python-3.7.4-docs-html/library/modulefinder.html @@ -0,0 +1,297 @@ + + + + + + + modulefinder — Find modules used by a script — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    modulefinder — Find modules used by a script

    +

    Source code: Lib/modulefinder.py

    +
    +

    This module provides a ModuleFinder class that can be used to determine +the set of modules imported by a script. modulefinder.py can also be run as +a script, giving the filename of a Python script as its argument, after which a +report of the imported modules will be printed.

    +
    +
    +modulefinder.AddPackagePath(pkg_name, path)
    +

    Record that the package named pkg_name can be found in the specified path.

    +
    + +
    +
    +modulefinder.ReplacePackage(oldname, newname)
    +

    Allows specifying that the module named oldname is in fact the package named +newname.

    +
    + +
    +
    +class modulefinder.ModuleFinder(path=None, debug=0, excludes=[], replace_paths=[])
    +

    This class provides run_script() and report() methods to determine +the set of modules imported by a script. path can be a list of directories to +search for modules; if not specified, sys.path is used. debug sets the +debugging level; higher values make the class print debugging messages about +what it’s doing. excludes is a list of module names to exclude from the +analysis. replace_paths is a list of (oldpath, newpath) tuples that will +be replaced in module paths.

    +
    +
    +report()
    +

    Print a report to standard output that lists the modules imported by the +script and their paths, as well as modules that are missing or seem to be +missing.

    +
    + +
    +
    +run_script(pathname)
    +

    Analyze the contents of the pathname file, which must contain Python +code.

    +
    + +
    +
    +modules
    +

    A dictionary mapping module names to modules. See +Example usage of ModuleFinder.

    +
    + +
    + +
    +

    Example usage of ModuleFinder

    +

    The script that is going to get analyzed later on (bacon.py):

    +
    import re, itertools
    +
    +try:
    +    import baconhameggs
    +except ImportError:
    +    pass
    +
    +try:
    +    import guido.python.ham
    +except ImportError:
    +    pass
    +
    +
    +

    The script that will output the report of bacon.py:

    +
    from modulefinder import ModuleFinder
    +
    +finder = ModuleFinder()
    +finder.run_script('bacon.py')
    +
    +print('Loaded modules:')
    +for name, mod in finder.modules.items():
    +    print('%s: ' % name, end='')
    +    print(','.join(list(mod.globalnames.keys())[:3]))
    +
    +print('-'*50)
    +print('Modules not imported:')
    +print('\n'.join(finder.badmodules.keys()))
    +
    +
    +

    Sample output (may vary depending on the architecture):

    +
    Loaded modules:
    +_types:
    +copyreg:  _inverted_registry,_slotnames,__all__
    +sre_compile:  isstring,_sre,_optimize_unicode
    +_sre:
    +sre_constants:  REPEAT_ONE,makedict,AT_END_LINE
    +sys:
    +re:  __module__,finditer,_expand
    +itertools:
    +__main__:  re,itertools,baconhameggs
    +sre_parse:  _PATTERNENDERS,SRE_FLAG_UNICODE
    +array:
    +types:  __module__,IntType,TypeType
    +---------------------------------------------------
    +Modules not imported:
    +guido.python.ham
    +baconhameggs
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/modules.html b/python-3.7.4-docs-html/library/modules.html new file mode 100644 index 0000000..a63b318 --- /dev/null +++ b/python-3.7.4-docs-html/library/modules.html @@ -0,0 +1,216 @@ + + + + + + + Importing Modules — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/msilib.html b/python-3.7.4-docs-html/library/msilib.html new file mode 100644 index 0000000..dd2458e --- /dev/null +++ b/python-3.7.4-docs-html/library/msilib.html @@ -0,0 +1,762 @@ + + + + + + + msilib — Read and write Microsoft Installer files — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    msilib — Read and write Microsoft Installer files

    +

    Source code: Lib/msilib/__init__.py

    +
    +

    The msilib supports the creation of Microsoft Installer (.msi) files. +Because these files often contain an embedded “cabinet” file (.cab), it also +exposes an API to create CAB files. Support for reading .cab files is +currently not implemented; read support for the .msi database is possible.

    +

    This package aims to provide complete access to all tables in an .msi file, +therefore, it is a fairly low-level API. Two primary applications of this +package are the distutils command bdist_msi, and the creation of +Python installer package itself (although that currently uses a different +version of msilib).

    +

    The package contents can be roughly split into four parts: low-level CAB +routines, low-level MSI routines, higher-level MSI routines, and standard table +structures.

    +
    +
    +msilib.FCICreate(cabname, files)
    +

    Create a new CAB file named cabname. files must be a list of tuples, each +containing the name of the file on disk, and the name of the file inside the CAB +file.

    +

    The files are added to the CAB file in the order they appear in the list. All +files are added into a single CAB file, using the MSZIP compression algorithm.

    +

    Callbacks to Python for the various steps of MSI creation are currently not +exposed.

    +
    + +
    +
    +msilib.UuidCreate()
    +

    Return the string representation of a new unique identifier. This wraps the +Windows API functions UuidCreate() and UuidToString().

    +
    + +
    +
    +msilib.OpenDatabase(path, persist)
    +

    Return a new database object by calling MsiOpenDatabase. path is the file +name of the MSI file; persist can be one of the constants +MSIDBOPEN_CREATEDIRECT, MSIDBOPEN_CREATE, MSIDBOPEN_DIRECT, +MSIDBOPEN_READONLY, or MSIDBOPEN_TRANSACT, and may include the flag +MSIDBOPEN_PATCHFILE. See the Microsoft documentation for the meaning of +these flags; depending on the flags, an existing database is opened, or a new +one created.

    +
    + +
    +
    +msilib.CreateRecord(count)
    +

    Return a new record object by calling MSICreateRecord(). count is the +number of fields of the record.

    +
    + +
    +
    +msilib.init_database(name, schema, ProductName, ProductCode, ProductVersion, Manufacturer)
    +

    Create and return a new database name, initialize it with schema, and set +the properties ProductName, ProductCode, ProductVersion, and +Manufacturer.

    +

    schema must be a module object containing tables and +_Validation_records attributes; typically, msilib.schema should be +used.

    +

    The database will contain just the schema and the validation records when this +function returns.

    +
    + +
    +
    +msilib.add_data(database, table, records)
    +

    Add all records to the table named table in database.

    +

    The table argument must be one of the predefined tables in the MSI schema, +e.g. 'Feature', 'File', 'Component', 'Dialog', 'Control', +etc.

    +

    records should be a list of tuples, each one containing all fields of a +record according to the schema of the table. For optional fields, +None can be passed.

    +

    Field values can be ints, strings, or instances of the Binary class.

    +
    + +
    +
    +class msilib.Binary(filename)
    +

    Represents entries in the Binary table; inserting such an object using +add_data() reads the file named filename into the table.

    +
    + +
    +
    +msilib.add_tables(database, module)
    +

    Add all table content from module to database. module must contain an +attribute tables listing all tables for which content should be added, and one +attribute per table that has the actual content.

    +

    This is typically used to install the sequence tables.

    +
    + +
    +
    +msilib.add_stream(database, name, path)
    +

    Add the file path into the _Stream table of database, with the stream +name name.

    +
    + +
    +
    +msilib.gen_uuid()
    +

    Return a new UUID, in the format that MSI typically requires (i.e. in curly +braces, and with all hexdigits in upper-case).

    +
    + + +
    +

    Database Objects

    +
    +
    +Database.OpenView(sql)
    +

    Return a view object, by calling MSIDatabaseOpenView(). sql is the SQL +statement to execute.

    +
    + +
    +
    +Database.Commit()
    +

    Commit the changes pending in the current transaction, by calling +MSIDatabaseCommit().

    +
    + +
    +
    +Database.GetSummaryInformation(count)
    +

    Return a new summary information object, by calling +MsiGetSummaryInformation(). count is the maximum number of updated +values.

    +
    + +
    +
    +Database.Close()
    +

    Close the database object, through MsiCloseHandle().

    +
    +

    New in version 3.7.

    +
    +
    + + +
    +
    +

    View Objects

    +
    +
    +View.Execute(params)
    +

    Execute the SQL query of the view, through MSIViewExecute(). If +params is not None, it is a record describing actual values of the +parameter tokens in the query.

    +
    + +
    +
    +View.GetColumnInfo(kind)
    +

    Return a record describing the columns of the view, through calling +MsiViewGetColumnInfo(). kind can be either MSICOLINFO_NAMES or +MSICOLINFO_TYPES.

    +
    + +
    +
    +View.Fetch()
    +

    Return a result record of the query, through calling MsiViewFetch().

    +
    + +
    +
    +View.Modify(kind, data)
    +

    Modify the view, by calling MsiViewModify(). kind can be one of +MSIMODIFY_SEEK, MSIMODIFY_REFRESH, MSIMODIFY_INSERT, +MSIMODIFY_UPDATE, MSIMODIFY_ASSIGN, MSIMODIFY_REPLACE, +MSIMODIFY_MERGE, MSIMODIFY_DELETE, MSIMODIFY_INSERT_TEMPORARY, +MSIMODIFY_VALIDATE, MSIMODIFY_VALIDATE_NEW, +MSIMODIFY_VALIDATE_FIELD, or MSIMODIFY_VALIDATE_DELETE.

    +

    data must be a record describing the new data.

    +
    + +
    +
    +View.Close()
    +

    Close the view, through MsiViewClose().

    +
    + + +
    +
    +

    Summary Information Objects

    +
    +
    +SummaryInformation.GetProperty(field)
    +

    Return a property of the summary, through MsiSummaryInfoGetProperty(). +field is the name of the property, and can be one of the constants +PID_CODEPAGE, PID_TITLE, PID_SUBJECT, PID_AUTHOR, +PID_KEYWORDS, PID_COMMENTS, PID_TEMPLATE, PID_LASTAUTHOR, +PID_REVNUMBER, PID_LASTPRINTED, PID_CREATE_DTM, +PID_LASTSAVE_DTM, PID_PAGECOUNT, PID_WORDCOUNT, PID_CHARCOUNT, +PID_APPNAME, or PID_SECURITY.

    +
    + +
    +
    +SummaryInformation.GetPropertyCount()
    +

    Return the number of summary properties, through +MsiSummaryInfoGetPropertyCount().

    +
    + +
    +
    +SummaryInformation.SetProperty(field, value)
    +

    Set a property through MsiSummaryInfoSetProperty(). field can have the +same values as in GetProperty(), value is the new value of the property. +Possible value types are integer and string.

    +
    + +
    +
    +SummaryInformation.Persist()
    +

    Write the modified properties to the summary information stream, using +MsiSummaryInfoPersist().

    +
    + + +
    +
    +

    Record Objects

    +
    +
    +Record.GetFieldCount()
    +

    Return the number of fields of the record, through +MsiRecordGetFieldCount().

    +
    + +
    +
    +Record.GetInteger(field)
    +

    Return the value of field as an integer where possible. field must +be an integer.

    +
    + +
    +
    +Record.GetString(field)
    +

    Return the value of field as a string where possible. field must +be an integer.

    +
    + +
    +
    +Record.SetString(field, value)
    +

    Set field to value through MsiRecordSetString(). field must be an +integer; value a string.

    +
    + +
    +
    +Record.SetStream(field, value)
    +

    Set field to the contents of the file named value, through +MsiRecordSetStream(). field must be an integer; value a string.

    +
    + +
    +
    +Record.SetInteger(field, value)
    +

    Set field to value through MsiRecordSetInteger(). Both field and +value must be an integer.

    +
    + +
    +
    +Record.ClearData()
    +

    Set all fields of the record to 0, through MsiRecordClearData().

    +
    + + +
    +
    +

    Errors

    +

    All wrappers around MSI functions raise MSIError; the string inside the +exception will contain more detail.

    +
    +
    +

    CAB Objects

    +
    +
    +class msilib.CAB(name)
    +

    The class CAB represents a CAB file. During MSI construction, files +will be added simultaneously to the Files table, and to a CAB file. Then, +when all files have been added, the CAB file can be written, then added to the +MSI file.

    +

    name is the name of the CAB file in the MSI file.

    +
    +
    +append(full, file, logical)
    +

    Add the file with the pathname full to the CAB file, under the name +logical. If there is already a file named logical, a new file name is +created.

    +

    Return the index of the file in the CAB file, and the new name of the file +inside the CAB file.

    +
    + +
    +
    +commit(database)
    +

    Generate a CAB file, add it as a stream to the MSI file, put it into the +Media table, and remove the generated file from the disk.

    +
    + +
    + +
    +
    +

    Directory Objects

    +
    +
    +class msilib.Directory(database, cab, basedir, physical, logical, default[, componentflags])
    +

    Create a new directory in the Directory table. There is a current component at +each point in time for the directory, which is either explicitly created through +start_component(), or implicitly when files are added for the first time. +Files are added into the current component, and into the cab file. To create a +directory, a base directory object needs to be specified (can be None), the +path to the physical directory, and a logical directory name. default +specifies the DefaultDir slot in the directory table. componentflags specifies +the default flags that new components get.

    +
    +
    +start_component(component=None, feature=None, flags=None, keyfile=None, uuid=None)
    +

    Add an entry to the Component table, and make this component the current +component for this directory. If no component name is given, the directory +name is used. If no feature is given, the current feature is used. If no +flags are given, the directory’s default flags are used. If no keyfile +is given, the KeyPath is left null in the Component table.

    +
    + +
    +
    +add_file(file, src=None, version=None, language=None)
    +

    Add a file to the current component of the directory, starting a new one +if there is no current component. By default, the file name in the source +and the file table will be identical. If the src file is specified, it +is interpreted relative to the current directory. Optionally, a version +and a language can be specified for the entry in the File table.

    +
    + +
    +
    +glob(pattern, exclude=None)
    +

    Add a list of files to the current component as specified in the glob +pattern. Individual files can be excluded in the exclude list.

    +
    + +
    +
    +remove_pyc()
    +

    Remove .pyc files on uninstall.

    +
    + +
    + + +
    +
    +

    Features

    +
    +
    +class msilib.Feature(db, id, title, desc, display, level=1, parent=None, directory=None, attributes=0)
    +

    Add a new record to the Feature table, using the values id, parent.id, +title, desc, display, level, directory, and attributes. The +resulting feature object can be passed to the start_component() method of +Directory.

    +
    +
    +set_current()
    +

    Make this feature the current feature of msilib. New components are +automatically added to the default feature, unless a feature is explicitly +specified.

    +
    + +
    + +
    +

    See also

    +

    Feature Table

    +
    +
    +
    +

    GUI classes

    +

    msilib provides several classes that wrap the GUI tables in an MSI +database. However, no standard user interface is provided; use +bdist_msi to create MSI files with a user-interface +for installing Python packages.

    +
    +
    +class msilib.Control(dlg, name)
    +

    Base class of the dialog controls. dlg is the dialog object the control +belongs to, and name is the control’s name.

    +
    +
    +event(event, argument, condition=1, ordering=None)
    +

    Make an entry into the ControlEvent table for this control.

    +
    + +
    +
    +mapping(event, attribute)
    +

    Make an entry into the EventMapping table for this control.

    +
    + +
    +
    +condition(action, condition)
    +

    Make an entry into the ControlCondition table for this control.

    +
    + +
    + +
    +
    +class msilib.RadioButtonGroup(dlg, name, property)
    +

    Create a radio button control named name. property is the installer property +that gets set when a radio button is selected.

    +
    +
    +add(name, x, y, width, height, text, value=None)
    +

    Add a radio button named name to the group, at the coordinates x, y, +width, height, and with the label text. If value is None, it +defaults to name.

    +
    + +
    + +
    +
    +class msilib.Dialog(db, name, x, y, w, h, attr, title, first, default, cancel)
    +

    Return a new Dialog object. An entry in the Dialog table is made, +with the specified coordinates, dialog attributes, title, name of the first, +default, and cancel controls.

    +
    +
    +control(name, type, x, y, width, height, attributes, property, text, control_next, help)
    +

    Return a new Control object. An entry in the Control table is +made with the specified parameters.

    +

    This is a generic method; for specific types, specialized methods are +provided.

    +
    + +
    +
    +text(name, x, y, width, height, attributes, text)
    +

    Add and return a Text control.

    +
    + +
    +
    +bitmap(name, x, y, width, height, text)
    +

    Add and return a Bitmap control.

    +
    + +
    +
    +line(name, x, y, width, height)
    +

    Add and return a Line control.

    +
    + +
    +
    +pushbutton(name, x, y, width, height, attributes, text, next_control)
    +

    Add and return a PushButton control.

    +
    + +
    +
    +radiogroup(name, x, y, width, height, attributes, property, text, next_control)
    +

    Add and return a RadioButtonGroup control.

    +
    + +
    +
    +checkbox(name, x, y, width, height, attributes, property, text, next_control)
    +

    Add and return a CheckBox control.

    +
    + +
    + + +
    +
    +

    Precomputed tables

    +

    msilib provides a few subpackages that contain only schema and table +definitions. Currently, these definitions are based on MSI version 2.0.

    +
    +
    +msilib.schema
    +

    This is the standard MSI schema for MSI 2.0, with the tables variable +providing a list of table definitions, and _Validation_records providing the +data for MSI validation.

    +
    + +
    +
    +msilib.sequence
    +

    This module contains table contents for the standard sequence tables: +AdminExecuteSequence, AdminUISequence, AdvtExecuteSequence, +InstallExecuteSequence, and InstallUISequence.

    +
    + +
    +
    +msilib.text
    +

    This module contains definitions for the UIText and ActionText tables, for the +standard installer actions.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/msvcrt.html b/python-3.7.4-docs-html/library/msvcrt.html new file mode 100644 index 0000000..88a8303 --- /dev/null +++ b/python-3.7.4-docs-html/library/msvcrt.html @@ -0,0 +1,345 @@ + + + + + + + msvcrt — Useful routines from the MS VC++ runtime — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    msvcrt — Useful routines from the MS VC++ runtime

    +
    +

    These functions provide access to some useful capabilities on Windows platforms. +Some higher-level modules use these functions to build the Windows +implementations of their services. For example, the getpass module uses +this in the implementation of the getpass() function.

    +

    Further documentation on these functions can be found in the Platform API +documentation.

    +

    The module implements both the normal and wide char variants of the console I/O +api. The normal API deals only with ASCII characters and is of limited use +for internationalized applications. The wide char API should be used where +ever possible.

    +
    +

    Changed in version 3.3: Operations in this module now raise OSError where IOError +was raised.

    +
    +
    +

    File Operations

    +
    +
    +msvcrt.locking(fd, mode, nbytes)
    +

    Lock part of a file based on file descriptor fd from the C runtime. Raises +OSError on failure. The locked region of the file extends from the +current file position for nbytes bytes, and may continue beyond the end of the +file. mode must be one of the LK_* constants listed below. Multiple +regions in a file may be locked at the same time, but may not overlap. Adjacent +regions are not merged; they must be unlocked individually.

    +
    + +
    +
    +msvcrt.LK_LOCK
    +
    +msvcrt.LK_RLCK
    +

    Locks the specified bytes. If the bytes cannot be locked, the program +immediately tries again after 1 second. If, after 10 attempts, the bytes cannot +be locked, OSError is raised.

    +
    + +
    +
    +msvcrt.LK_NBLCK
    +
    +msvcrt.LK_NBRLCK
    +

    Locks the specified bytes. If the bytes cannot be locked, OSError is +raised.

    +
    + +
    +
    +msvcrt.LK_UNLCK
    +

    Unlocks the specified bytes, which must have been previously locked.

    +
    + +
    +
    +msvcrt.setmode(fd, flags)
    +

    Set the line-end translation mode for the file descriptor fd. To set it to +text mode, flags should be os.O_TEXT; for binary, it should be +os.O_BINARY.

    +
    + +
    +
    +msvcrt.open_osfhandle(handle, flags)
    +

    Create a C runtime file descriptor from the file handle handle. The flags +parameter should be a bitwise OR of os.O_APPEND, os.O_RDONLY, +and os.O_TEXT. The returned file descriptor may be used as a parameter +to os.fdopen() to create a file object.

    +
    + +
    +
    +msvcrt.get_osfhandle(fd)
    +

    Return the file handle for the file descriptor fd. Raises OSError if +fd is not recognized.

    +
    + +
    +
    +

    Console I/O

    +
    +
    +msvcrt.kbhit()
    +

    Return true if a keypress is waiting to be read.

    +
    + +
    +
    +msvcrt.getch()
    +

    Read a keypress and return the resulting character as a byte string. +Nothing is echoed to the console. This call will block if a keypress +is not already available, but will not wait for Enter to be +pressed. If the pressed key was a special function key, this will +return '\000' or '\xe0'; the next call will return the keycode. +The Control-C keypress cannot be read with this function.

    +
    + +
    +
    +msvcrt.getwch()
    +

    Wide char variant of getch(), returning a Unicode value.

    +
    + +
    +
    +msvcrt.getche()
    +

    Similar to getch(), but the keypress will be echoed if it represents a +printable character.

    +
    + +
    +
    +msvcrt.getwche()
    +

    Wide char variant of getche(), returning a Unicode value.

    +
    + +
    +
    +msvcrt.putch(char)
    +

    Print the byte string char to the console without buffering.

    +
    + +
    +
    +msvcrt.putwch(unicode_char)
    +

    Wide char variant of putch(), accepting a Unicode value.

    +
    + +
    +
    +msvcrt.ungetch(char)
    +

    Cause the byte string char to be “pushed back” into the console buffer; +it will be the next character read by getch() or getche().

    +
    + +
    +
    +msvcrt.ungetwch(unicode_char)
    +

    Wide char variant of ungetch(), accepting a Unicode value.

    +
    + +
    +
    +

    Other Functions

    +
    +
    +msvcrt.heapmin()
    +

    Force the malloc() heap to clean itself up and return unused blocks to +the operating system. On failure, this raises OSError.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/multiprocessing.html b/python-3.7.4-docs-html/library/multiprocessing.html new file mode 100644 index 0000000..f7d98b8 --- /dev/null +++ b/python-3.7.4-docs-html/library/multiprocessing.html @@ -0,0 +1,3397 @@ + + + + + + + multiprocessing — Process-based parallelism — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    multiprocessing — Process-based parallelism

    +

    Source code: Lib/multiprocessing/

    +
    +
    +

    Introduction

    +

    multiprocessing is a package that supports spawning processes using an +API similar to the threading module. The multiprocessing package +offers both local and remote concurrency, effectively side-stepping the +Global Interpreter Lock by using subprocesses instead of threads. Due +to this, the multiprocessing module allows the programmer to fully +leverage multiple processors on a given machine. It runs on both Unix and +Windows.

    +

    The multiprocessing module also introduces APIs which do not have +analogs in the threading module. A prime example of this is the +Pool object which offers a convenient means of +parallelizing the execution of a function across multiple input values, +distributing the input data across processes (data parallelism). The following +example demonstrates the common practice of defining such functions in a module +so that child processes can successfully import that module. This basic example +of data parallelism using Pool,

    +
    from multiprocessing import Pool
    +
    +def f(x):
    +    return x*x
    +
    +if __name__ == '__main__':
    +    with Pool(5) as p:
    +        print(p.map(f, [1, 2, 3]))
    +
    +
    +

    will print to standard output

    +
    [1, 4, 9]
    +
    +
    +
    +

    The Process class

    +

    In multiprocessing, processes are spawned by creating a Process +object and then calling its start() method. Process +follows the API of threading.Thread. A trivial example of a +multiprocess program is

    +
    from multiprocessing import Process
    +
    +def f(name):
    +    print('hello', name)
    +
    +if __name__ == '__main__':
    +    p = Process(target=f, args=('bob',))
    +    p.start()
    +    p.join()
    +
    +
    +

    To show the individual process IDs involved, here is an expanded example:

    +
    from multiprocessing import Process
    +import os
    +
    +def info(title):
    +    print(title)
    +    print('module name:', __name__)
    +    print('parent process:', os.getppid())
    +    print('process id:', os.getpid())
    +
    +def f(name):
    +    info('function f')
    +    print('hello', name)
    +
    +if __name__ == '__main__':
    +    info('main line')
    +    p = Process(target=f, args=('bob',))
    +    p.start()
    +    p.join()
    +
    +
    +

    For an explanation of why the if __name__ == '__main__' part is +necessary, see Programming guidelines.

    +
    +
    +

    Contexts and start methods

    +

    Depending on the platform, multiprocessing supports three ways +to start a process. These start methods are

    +
    +
    +
    spawn

    The parent process starts a fresh python interpreter process. The +child process will only inherit those resources necessary to run +the process objects run() method. In particular, +unnecessary file descriptors and handles from the parent process +will not be inherited. Starting a process using this method is +rather slow compared to using fork or forkserver.

    +

    Available on Unix and Windows. The default on Windows.

    +
    +
    fork

    The parent process uses os.fork() to fork the Python +interpreter. The child process, when it begins, is effectively +identical to the parent process. All resources of the parent are +inherited by the child process. Note that safely forking a +multithreaded process is problematic.

    +

    Available on Unix only. The default on Unix.

    +
    +
    forkserver

    When the program starts and selects the forkserver start method, +a server process is started. From then on, whenever a new process +is needed, the parent process connects to the server and requests +that it fork a new process. The fork server process is single +threaded so it is safe for it to use os.fork(). No +unnecessary resources are inherited.

    +

    Available on Unix platforms which support passing file descriptors +over Unix pipes.

    +
    +
    +
    +
    +

    Changed in version 3.4: spawn added on all unix platforms, and forkserver added for +some unix platforms. +Child processes no longer inherit all of the parents inheritable +handles on Windows.

    +
    +

    On Unix using the spawn or forkserver start methods will also +start a semaphore tracker process which tracks the unlinked named +semaphores created by processes of the program. When all processes +have exited the semaphore tracker unlinks any remaining semaphores. +Usually there should be none, but if a process was killed by a signal +there may be some “leaked” semaphores. (Unlinking the named semaphores +is a serious matter since the system allows only a limited number, and +they will not be automatically unlinked until the next reboot.)

    +

    To select a start method you use the set_start_method() in +the if __name__ == '__main__' clause of the main module. For +example:

    +
    import multiprocessing as mp
    +
    +def foo(q):
    +    q.put('hello')
    +
    +if __name__ == '__main__':
    +    mp.set_start_method('spawn')
    +    q = mp.Queue()
    +    p = mp.Process(target=foo, args=(q,))
    +    p.start()
    +    print(q.get())
    +    p.join()
    +
    +
    +

    set_start_method() should not be used more than once in the +program.

    +

    Alternatively, you can use get_context() to obtain a context +object. Context objects have the same API as the multiprocessing +module, and allow one to use multiple start methods in the same +program.

    +
    import multiprocessing as mp
    +
    +def foo(q):
    +    q.put('hello')
    +
    +if __name__ == '__main__':
    +    ctx = mp.get_context('spawn')
    +    q = ctx.Queue()
    +    p = ctx.Process(target=foo, args=(q,))
    +    p.start()
    +    print(q.get())
    +    p.join()
    +
    +
    +

    Note that objects related to one context may not be compatible with +processes for a different context. In particular, locks created using +the fork context cannot be passed to processes started using the +spawn or forkserver start methods.

    +

    A library which wants to use a particular start method should probably +use get_context() to avoid interfering with the choice of the +library user.

    +
    +

    Warning

    +

    The 'spawn' and 'forkserver' start methods cannot currently +be used with “frozen” executables (i.e., binaries produced by +packages like PyInstaller and cx_Freeze) on Unix. +The 'fork' start method does work.

    +
    +
    +
    +

    Exchanging objects between processes

    +

    multiprocessing supports two types of communication channel between +processes:

    +

    Queues

    +
    +

    The Queue class is a near clone of queue.Queue. For +example:

    +
    from multiprocessing import Process, Queue
    +
    +def f(q):
    +    q.put([42, None, 'hello'])
    +
    +if __name__ == '__main__':
    +    q = Queue()
    +    p = Process(target=f, args=(q,))
    +    p.start()
    +    print(q.get())    # prints "[42, None, 'hello']"
    +    p.join()
    +
    +
    +

    Queues are thread and process safe.

    +
    +

    Pipes

    +
    +

    The Pipe() function returns a pair of connection objects connected by a +pipe which by default is duplex (two-way). For example:

    +
    from multiprocessing import Process, Pipe
    +
    +def f(conn):
    +    conn.send([42, None, 'hello'])
    +    conn.close()
    +
    +if __name__ == '__main__':
    +    parent_conn, child_conn = Pipe()
    +    p = Process(target=f, args=(child_conn,))
    +    p.start()
    +    print(parent_conn.recv())   # prints "[42, None, 'hello']"
    +    p.join()
    +
    +
    +

    The two connection objects returned by Pipe() represent the two ends of +the pipe. Each connection object has send() and +recv() methods (among others). Note that data in a pipe +may become corrupted if two processes (or threads) try to read from or write +to the same end of the pipe at the same time. Of course there is no risk +of corruption from processes using different ends of the pipe at the same +time.

    +
    +
    +
    +

    Synchronization between processes

    +

    multiprocessing contains equivalents of all the synchronization +primitives from threading. For instance one can use a lock to ensure +that only one process prints to standard output at a time:

    +
    from multiprocessing import Process, Lock
    +
    +def f(l, i):
    +    l.acquire()
    +    try:
    +        print('hello world', i)
    +    finally:
    +        l.release()
    +
    +if __name__ == '__main__':
    +    lock = Lock()
    +
    +    for num in range(10):
    +        Process(target=f, args=(lock, num)).start()
    +
    +
    +

    Without using the lock output from the different processes is liable to get all +mixed up.

    +
    +
    +

    Sharing state between processes

    +

    As mentioned above, when doing concurrent programming it is usually best to +avoid using shared state as far as possible. This is particularly true when +using multiple processes.

    +

    However, if you really do need to use some shared data then +multiprocessing provides a couple of ways of doing so.

    +

    Shared memory

    +
    +

    Data can be stored in a shared memory map using Value or +Array. For example, the following code

    +
    from multiprocessing import Process, Value, Array
    +
    +def f(n, a):
    +    n.value = 3.1415927
    +    for i in range(len(a)):
    +        a[i] = -a[i]
    +
    +if __name__ == '__main__':
    +    num = Value('d', 0.0)
    +    arr = Array('i', range(10))
    +
    +    p = Process(target=f, args=(num, arr))
    +    p.start()
    +    p.join()
    +
    +    print(num.value)
    +    print(arr[:])
    +
    +
    +

    will print

    +
    3.1415927
    +[0, -1, -2, -3, -4, -5, -6, -7, -8, -9]
    +
    +
    +

    The 'd' and 'i' arguments used when creating num and arr are +typecodes of the kind used by the array module: 'd' indicates a +double precision float and 'i' indicates a signed integer. These shared +objects will be process and thread-safe.

    +

    For more flexibility in using shared memory one can use the +multiprocessing.sharedctypes module which supports the creation of +arbitrary ctypes objects allocated from shared memory.

    +
    +

    Server process

    +
    +

    A manager object returned by Manager() controls a server process which +holds Python objects and allows other processes to manipulate them using +proxies.

    +

    A manager returned by Manager() will support types +list, dict, Namespace, Lock, +RLock, Semaphore, BoundedSemaphore, +Condition, Event, Barrier, +Queue, Value and Array. For example,

    +
    from multiprocessing import Process, Manager
    +
    +def f(d, l):
    +    d[1] = '1'
    +    d['2'] = 2
    +    d[0.25] = None
    +    l.reverse()
    +
    +if __name__ == '__main__':
    +    with Manager() as manager:
    +        d = manager.dict()
    +        l = manager.list(range(10))
    +
    +        p = Process(target=f, args=(d, l))
    +        p.start()
    +        p.join()
    +
    +        print(d)
    +        print(l)
    +
    +
    +

    will print

    +
    {0.25: None, 1: '1', '2': 2}
    +[9, 8, 7, 6, 5, 4, 3, 2, 1, 0]
    +
    +
    +

    Server process managers are more flexible than using shared memory objects +because they can be made to support arbitrary object types. Also, a single +manager can be shared by processes on different computers over a network. +They are, however, slower than using shared memory.

    +
    +
    +
    +

    Using a pool of workers

    +

    The Pool class represents a pool of worker +processes. It has methods which allows tasks to be offloaded to the worker +processes in a few different ways.

    +

    For example:

    +
    from multiprocessing import Pool, TimeoutError
    +import time
    +import os
    +
    +def f(x):
    +    return x*x
    +
    +if __name__ == '__main__':
    +    # start 4 worker processes
    +    with Pool(processes=4) as pool:
    +
    +        # print "[0, 1, 4,..., 81]"
    +        print(pool.map(f, range(10)))
    +
    +        # print same numbers in arbitrary order
    +        for i in pool.imap_unordered(f, range(10)):
    +            print(i)
    +
    +        # evaluate "f(20)" asynchronously
    +        res = pool.apply_async(f, (20,))      # runs in *only* one process
    +        print(res.get(timeout=1))             # prints "400"
    +
    +        # evaluate "os.getpid()" asynchronously
    +        res = pool.apply_async(os.getpid, ()) # runs in *only* one process
    +        print(res.get(timeout=1))             # prints the PID of that process
    +
    +        # launching multiple evaluations asynchronously *may* use more processes
    +        multiple_results = [pool.apply_async(os.getpid, ()) for i in range(4)]
    +        print([res.get(timeout=1) for res in multiple_results])
    +
    +        # make a single worker sleep for 10 secs
    +        res = pool.apply_async(time.sleep, (10,))
    +        try:
    +            print(res.get(timeout=1))
    +        except TimeoutError:
    +            print("We lacked patience and got a multiprocessing.TimeoutError")
    +
    +        print("For the moment, the pool remains available for more work")
    +
    +    # exiting the 'with'-block has stopped the pool
    +    print("Now the pool is closed and no longer available")
    +
    +
    +

    Note that the methods of a pool should only ever be used by the +process which created it.

    +
    +

    Note

    +

    Functionality within this package requires that the __main__ module be +importable by the children. This is covered in Programming guidelines +however it is worth pointing out here. This means that some examples, such +as the multiprocessing.pool.Pool examples will not work in the +interactive interpreter. For example:

    +
    >>> from multiprocessing import Pool
    +>>> p = Pool(5)
    +>>> def f(x):
    +...     return x*x
    +...
    +>>> p.map(f, [1,2,3])
    +Process PoolWorker-1:
    +Process PoolWorker-2:
    +Process PoolWorker-3:
    +Traceback (most recent call last):
    +AttributeError: 'module' object has no attribute 'f'
    +AttributeError: 'module' object has no attribute 'f'
    +AttributeError: 'module' object has no attribute 'f'
    +
    +
    +

    (If you try this it will actually output three full tracebacks +interleaved in a semi-random fashion, and then you may have to +stop the master process somehow.)

    +
    +
    +
    +
    +

    Reference

    +

    The multiprocessing package mostly replicates the API of the +threading module.

    +
    +

    Process and exceptions

    +
    +
    +class multiprocessing.Process(group=None, target=None, name=None, args=(), kwargs={}, *, daemon=None)
    +

    Process objects represent activity that is run in a separate process. The +Process class has equivalents of all the methods of +threading.Thread.

    +

    The constructor should always be called with keyword arguments. group +should always be None; it exists solely for compatibility with +threading.Thread. target is the callable object to be invoked by +the run() method. It defaults to None, meaning nothing is +called. name is the process name (see name for more details). +args is the argument tuple for the target invocation. kwargs is a +dictionary of keyword arguments for the target invocation. If provided, +the keyword-only daemon argument sets the process daemon flag +to True or False. If None (the default), this flag will be +inherited from the creating process.

    +

    By default, no arguments are passed to target.

    +

    If a subclass overrides the constructor, it must make sure it invokes the +base class constructor (Process.__init__()) before doing anything else +to the process.

    +
    +

    Changed in version 3.3: Added the daemon argument.

    +
    +
    +
    +run()
    +

    Method representing the process’s activity.

    +

    You may override this method in a subclass. The standard run() +method invokes the callable object passed to the object’s constructor as +the target argument, if any, with sequential and keyword arguments taken +from the args and kwargs arguments, respectively.

    +
    + +
    +
    +start()
    +

    Start the process’s activity.

    +

    This must be called at most once per process object. It arranges for the +object’s run() method to be invoked in a separate process.

    +
    + +
    +
    +join([timeout])
    +

    If the optional argument timeout is None (the default), the method +blocks until the process whose join() method is called terminates. +If timeout is a positive number, it blocks at most timeout seconds. +Note that the method returns None if its process terminates or if the +method times out. Check the process’s exitcode to determine if +it terminated.

    +

    A process can be joined many times.

    +

    A process cannot join itself because this would cause a deadlock. It is +an error to attempt to join a process before it has been started.

    +
    + +
    +
    +name
    +

    The process’s name. The name is a string used for identification purposes +only. It has no semantics. Multiple processes may be given the same +name.

    +

    The initial name is set by the constructor. If no explicit name is +provided to the constructor, a name of the form +‘Process-N1:N2:…:Nk’ is constructed, where +each Nk is the N-th child of its parent.

    +
    + +
    +
    +is_alive()
    +

    Return whether the process is alive.

    +

    Roughly, a process object is alive from the moment the start() +method returns until the child process terminates.

    +
    + +
    +
    +daemon
    +

    The process’s daemon flag, a Boolean value. This must be set before +start() is called.

    +

    The initial value is inherited from the creating process.

    +

    When a process exits, it attempts to terminate all of its daemonic child +processes.

    +

    Note that a daemonic process is not allowed to create child processes. +Otherwise a daemonic process would leave its children orphaned if it gets +terminated when its parent process exits. Additionally, these are not +Unix daemons or services, they are normal processes that will be +terminated (and not joined) if non-daemonic processes have exited.

    +
    + +

    In addition to the threading.Thread API, Process objects +also support the following attributes and methods:

    +
    +
    +pid
    +

    Return the process ID. Before the process is spawned, this will be +None.

    +
    + +
    +
    +exitcode
    +

    The child’s exit code. This will be None if the process has not yet +terminated. A negative value -N indicates that the child was terminated +by signal N.

    +
    + +
    +
    +authkey
    +

    The process’s authentication key (a byte string).

    +

    When multiprocessing is initialized the main process is assigned a +random string using os.urandom().

    +

    When a Process object is created, it will inherit the +authentication key of its parent process, although this may be changed by +setting authkey to another byte string.

    +

    See Authentication keys.

    +
    + +
    +
    +sentinel
    +

    A numeric handle of a system object which will become “ready” when +the process ends.

    +

    You can use this value if you want to wait on several events at +once using multiprocessing.connection.wait(). Otherwise +calling join() is simpler.

    +

    On Windows, this is an OS handle usable with the WaitForSingleObject +and WaitForMultipleObjects family of API calls. On Unix, this is +a file descriptor usable with primitives from the select module.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +terminate()
    +

    Terminate the process. On Unix this is done using the SIGTERM signal; +on Windows TerminateProcess() is used. Note that exit handlers and +finally clauses, etc., will not be executed.

    +

    Note that descendant processes of the process will not be terminated – +they will simply become orphaned.

    +
    +

    Warning

    +

    If this method is used when the associated process is using a pipe or +queue then the pipe or queue is liable to become corrupted and may +become unusable by other process. Similarly, if the process has +acquired a lock or semaphore etc. then terminating it is liable to +cause other processes to deadlock.

    +
    +
    + +
    +
    +kill()
    +

    Same as terminate() but using the SIGKILL signal on Unix.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +close()
    +

    Close the Process object, releasing all resources associated +with it. ValueError is raised if the underlying process +is still running. Once close() returns successfully, most +other methods and attributes of the Process object will +raise ValueError.

    +
    +

    New in version 3.7.

    +
    +
    + +

    Note that the start(), join(), is_alive(), +terminate() and exitcode methods should only be called by +the process that created the process object.

    +

    Example usage of some of the methods of Process:

    +
    >>> import multiprocessing, time, signal
    +>>> p = multiprocessing.Process(target=time.sleep, args=(1000,))
    +>>> print(p, p.is_alive())
    +<Process(Process-1, initial)> False
    +>>> p.start()
    +>>> print(p, p.is_alive())
    +<Process(Process-1, started)> True
    +>>> p.terminate()
    +>>> time.sleep(0.1)
    +>>> print(p, p.is_alive())
    +<Process(Process-1, stopped[SIGTERM])> False
    +>>> p.exitcode == -signal.SIGTERM
    +True
    +
    +
    +
    + +
    +
    +exception multiprocessing.ProcessError
    +

    The base class of all multiprocessing exceptions.

    +
    + +
    +
    +exception multiprocessing.BufferTooShort
    +

    Exception raised by Connection.recv_bytes_into() when the supplied +buffer object is too small for the message read.

    +

    If e is an instance of BufferTooShort then e.args[0] will give +the message as a byte string.

    +
    + +
    +
    +exception multiprocessing.AuthenticationError
    +

    Raised when there is an authentication error.

    +
    + +
    +
    +exception multiprocessing.TimeoutError
    +

    Raised by methods with a timeout when the timeout expires.

    +
    + +
    +
    +

    Pipes and Queues

    +

    When using multiple processes, one generally uses message passing for +communication between processes and avoids having to use any synchronization +primitives like locks.

    +

    For passing messages one can use Pipe() (for a connection between two +processes) or a queue (which allows multiple producers and consumers).

    +

    The Queue, SimpleQueue and JoinableQueue types +are multi-producer, multi-consumer FIFO +queues modelled on the queue.Queue class in the +standard library. They differ in that Queue lacks the +task_done() and join() methods introduced +into Python 2.5’s queue.Queue class.

    +

    If you use JoinableQueue then you must call +JoinableQueue.task_done() for each task removed from the queue or else the +semaphore used to count the number of unfinished tasks may eventually overflow, +raising an exception.

    +

    Note that one can also create a shared queue by using a manager object – see +Managers.

    +
    +

    Note

    +

    multiprocessing uses the usual queue.Empty and +queue.Full exceptions to signal a timeout. They are not available in +the multiprocessing namespace so you need to import them from +queue.

    +
    +
    +

    Note

    +

    When an object is put on a queue, the object is pickled and a +background thread later flushes the pickled data to an underlying +pipe. This has some consequences which are a little surprising, +but should not cause any practical difficulties – if they really +bother you then you can instead use a queue created with a +manager.

    +
      +
    1. After putting an object on an empty queue there may be an +infinitesimal delay before the queue’s empty() +method returns False and get_nowait() can +return without raising queue.Empty.

    2. +
    3. If multiple processes are enqueuing objects, it is possible for +the objects to be received at the other end out-of-order. +However, objects enqueued by the same process will always be in +the expected order with respect to each other.

    4. +
    +
    +
    +

    Warning

    +

    If a process is killed using Process.terminate() or os.kill() +while it is trying to use a Queue, then the data in the queue is +likely to become corrupted. This may cause any other process to get an +exception when it tries to use the queue later on.

    +
    +
    +

    Warning

    +

    As mentioned above, if a child process has put items on a queue (and it has +not used JoinableQueue.cancel_join_thread), then that process will +not terminate until all buffered items have been flushed to the pipe.

    +

    This means that if you try joining that process you may get a deadlock unless +you are sure that all items which have been put on the queue have been +consumed. Similarly, if the child process is non-daemonic then the parent +process may hang on exit when it tries to join all its non-daemonic children.

    +

    Note that a queue created using a manager does not have this issue. See +Programming guidelines.

    +
    +

    For an example of the usage of queues for interprocess communication see +Examples.

    +
    +
    +multiprocessing.Pipe([duplex])
    +

    Returns a pair (conn1, conn2) of +Connection objects representing the +ends of a pipe.

    +

    If duplex is True (the default) then the pipe is bidirectional. If +duplex is False then the pipe is unidirectional: conn1 can only be +used for receiving messages and conn2 can only be used for sending +messages.

    +
    + +
    +
    +class multiprocessing.Queue([maxsize])
    +

    Returns a process shared queue implemented using a pipe and a few +locks/semaphores. When a process first puts an item on the queue a feeder +thread is started which transfers objects from a buffer into the pipe.

    +

    The usual queue.Empty and queue.Full exceptions from the +standard library’s queue module are raised to signal timeouts.

    +

    Queue implements all the methods of queue.Queue except for +task_done() and join().

    +
    +
    +qsize()
    +

    Return the approximate size of the queue. Because of +multithreading/multiprocessing semantics, this number is not reliable.

    +

    Note that this may raise NotImplementedError on Unix platforms like +Mac OS X where sem_getvalue() is not implemented.

    +
    + +
    +
    +empty()
    +

    Return True if the queue is empty, False otherwise. Because of +multithreading/multiprocessing semantics, this is not reliable.

    +
    + +
    +
    +full()
    +

    Return True if the queue is full, False otherwise. Because of +multithreading/multiprocessing semantics, this is not reliable.

    +
    + +
    +
    +put(obj[, block[, timeout]])
    +

    Put obj into the queue. If the optional argument block is True +(the default) and timeout is None (the default), block if necessary until +a free slot is available. If timeout is a positive number, it blocks at +most timeout seconds and raises the queue.Full exception if no +free slot was available within that time. Otherwise (block is +False), put an item on the queue if a free slot is immediately +available, else raise the queue.Full exception (timeout is +ignored in that case).

    +
    + +
    +
    +put_nowait(obj)
    +

    Equivalent to put(obj, False).

    +
    + +
    +
    +get([block[, timeout]])
    +

    Remove and return an item from the queue. If optional args block is +True (the default) and timeout is None (the default), block if +necessary until an item is available. If timeout is a positive number, +it blocks at most timeout seconds and raises the queue.Empty +exception if no item was available within that time. Otherwise (block is +False), return an item if one is immediately available, else raise the +queue.Empty exception (timeout is ignored in that case).

    +
    + +
    +
    +get_nowait()
    +

    Equivalent to get(False).

    +
    + +

    multiprocessing.Queue has a few additional methods not found in +queue.Queue. These methods are usually unnecessary for most +code:

    +
    +
    +close()
    +

    Indicate that no more data will be put on this queue by the current +process. The background thread will quit once it has flushed all buffered +data to the pipe. This is called automatically when the queue is garbage +collected.

    +
    + +
    +
    +join_thread()
    +

    Join the background thread. This can only be used after close() has +been called. It blocks until the background thread exits, ensuring that +all data in the buffer has been flushed to the pipe.

    +

    By default if a process is not the creator of the queue then on exit it +will attempt to join the queue’s background thread. The process can call +cancel_join_thread() to make join_thread() do nothing.

    +
    + +
    +
    +cancel_join_thread()
    +

    Prevent join_thread() from blocking. In particular, this prevents +the background thread from being joined automatically when the process +exits – see join_thread().

    +

    A better name for this method might be +allow_exit_without_flush(). It is likely to cause enqueued +data to lost, and you almost certainly will not need to use it. +It is really only there if you need the current process to exit +immediately without waiting to flush enqueued data to the +underlying pipe, and you don’t care about lost data.

    +
    + +
    +

    Note

    +

    This class’s functionality requires a functioning shared semaphore +implementation on the host operating system. Without one, the +functionality in this class will be disabled, and attempts to +instantiate a Queue will result in an ImportError. See +bpo-3770 for additional information. The same holds true for any +of the specialized queue types listed below.

    +
    +
    + +
    +
    +class multiprocessing.SimpleQueue
    +

    It is a simplified Queue type, very close to a locked Pipe.

    +
    +
    +empty()
    +

    Return True if the queue is empty, False otherwise.

    +
    + +
    +
    +get()
    +

    Remove and return an item from the queue.

    +
    + +
    +
    +put(item)
    +

    Put item into the queue.

    +
    + +
    + +
    +
    +class multiprocessing.JoinableQueue([maxsize])
    +

    JoinableQueue, a Queue subclass, is a queue which +additionally has task_done() and join() methods.

    +
    +
    +task_done()
    +

    Indicate that a formerly enqueued task is complete. Used by queue +consumers. For each get() used to fetch a task, a subsequent +call to task_done() tells the queue that the processing on the task +is complete.

    +

    If a join() is currently blocking, it will resume when all +items have been processed (meaning that a task_done() call was +received for every item that had been put() into the queue).

    +

    Raises a ValueError if called more times than there were items +placed in the queue.

    +
    + +
    +
    +join()
    +

    Block until all items in the queue have been gotten and processed.

    +

    The count of unfinished tasks goes up whenever an item is added to the +queue. The count goes down whenever a consumer calls +task_done() to indicate that the item was retrieved and all work on +it is complete. When the count of unfinished tasks drops to zero, +join() unblocks.

    +
    + +
    + +
    +
    +

    Miscellaneous

    +
    +
    +multiprocessing.active_children()
    +

    Return list of all live children of the current process.

    +

    Calling this has the side effect of “joining” any processes which have +already finished.

    +
    + +
    +
    +multiprocessing.cpu_count()
    +

    Return the number of CPUs in the system.

    +

    This number is not equivalent to the number of CPUs the current process can +use. The number of usable CPUs can be obtained with +len(os.sched_getaffinity(0))

    +

    May raise NotImplementedError.

    +
    +

    See also

    +

    os.cpu_count()

    +
    +
    + +
    +
    +multiprocessing.current_process()
    +

    Return the Process object corresponding to the current process.

    +

    An analogue of threading.current_thread().

    +
    + +
    +
    +multiprocessing.freeze_support()
    +

    Add support for when a program which uses multiprocessing has been +frozen to produce a Windows executable. (Has been tested with py2exe, +PyInstaller and cx_Freeze.)

    +

    One needs to call this function straight after the if __name__ == +'__main__' line of the main module. For example:

    +
    from multiprocessing import Process, freeze_support
    +
    +def f():
    +    print('hello world!')
    +
    +if __name__ == '__main__':
    +    freeze_support()
    +    Process(target=f).start()
    +
    +
    +

    If the freeze_support() line is omitted then trying to run the frozen +executable will raise RuntimeError.

    +

    Calling freeze_support() has no effect when invoked on any operating +system other than Windows. In addition, if the module is being run +normally by the Python interpreter on Windows (the program has not been +frozen), then freeze_support() has no effect.

    +
    + +
    +
    +multiprocessing.get_all_start_methods()
    +

    Returns a list of the supported start methods, the first of which +is the default. The possible start methods are 'fork', +'spawn' and 'forkserver'. On Windows only 'spawn' is +available. On Unix 'fork' and 'spawn' are always +supported, with 'fork' being the default.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +multiprocessing.get_context(method=None)
    +

    Return a context object which has the same attributes as the +multiprocessing module.

    +

    If method is None then the default context is returned. +Otherwise method should be 'fork', 'spawn', +'forkserver'. ValueError is raised if the specified +start method is not available.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +multiprocessing.get_start_method(allow_none=False)
    +

    Return the name of start method used for starting processes.

    +

    If the start method has not been fixed and allow_none is false, +then the start method is fixed to the default and the name is +returned. If the start method has not been fixed and allow_none +is true then None is returned.

    +

    The return value can be 'fork', 'spawn', 'forkserver' +or None. 'fork' is the default on Unix, while 'spawn' is +the default on Windows.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +multiprocessing.set_executable()
    +

    Sets the path of the Python interpreter to use when starting a child process. +(By default sys.executable is used). Embedders will probably need to +do some thing like

    +
    set_executable(os.path.join(sys.exec_prefix, 'pythonw.exe'))
    +
    +
    +

    before they can create child processes.

    +
    +

    Changed in version 3.4: Now supported on Unix when the 'spawn' start method is used.

    +
    +
    + +
    +
    +multiprocessing.set_start_method(method)
    +

    Set the method which should be used to start child processes. +method can be 'fork', 'spawn' or 'forkserver'.

    +

    Note that this should be called at most once, and it should be +protected inside the if __name__ == '__main__' clause of the +main module.

    +
    +

    New in version 3.4.

    +
    +
    + + +
    +
    +

    Connection Objects

    +

    Connection objects allow the sending and receiving of picklable objects or +strings. They can be thought of as message oriented connected sockets.

    +

    Connection objects are usually created using +Pipe – see also +Listeners and Clients.

    +
    +
    +class multiprocessing.connection.Connection
    +
    +
    +send(obj)
    +

    Send an object to the other end of the connection which should be read +using recv().

    +

    The object must be picklable. Very large pickles (approximately 32 MiB+, +though it depends on the OS) may raise a ValueError exception.

    +
    + +
    +
    +recv()
    +

    Return an object sent from the other end of the connection using +send(). Blocks until there is something to receive. Raises +EOFError if there is nothing left to receive +and the other end was closed.

    +
    + +
    +
    +fileno()
    +

    Return the file descriptor or handle used by the connection.

    +
    + +
    +
    +close()
    +

    Close the connection.

    +

    This is called automatically when the connection is garbage collected.

    +
    + +
    +
    +poll([timeout])
    +

    Return whether there is any data available to be read.

    +

    If timeout is not specified then it will return immediately. If +timeout is a number then this specifies the maximum time in seconds to +block. If timeout is None then an infinite timeout is used.

    +

    Note that multiple connection objects may be polled at once by +using multiprocessing.connection.wait().

    +
    + +
    +
    +send_bytes(buffer[, offset[, size]])
    +

    Send byte data from a bytes-like object as a complete message.

    +

    If offset is given then data is read from that position in buffer. If +size is given then that many bytes will be read from buffer. Very large +buffers (approximately 32 MiB+, though it depends on the OS) may raise a +ValueError exception

    +
    + +
    +
    +recv_bytes([maxlength])
    +

    Return a complete message of byte data sent from the other end of the +connection as a string. Blocks until there is something to receive. +Raises EOFError if there is nothing left +to receive and the other end has closed.

    +

    If maxlength is specified and the message is longer than maxlength +then OSError is raised and the connection will no longer be +readable.

    +
    +

    Changed in version 3.3: This function used to raise IOError, which is now an +alias of OSError.

    +
    +
    + +
    +
    +recv_bytes_into(buffer[, offset])
    +

    Read into buffer a complete message of byte data sent from the other end +of the connection and return the number of bytes in the message. Blocks +until there is something to receive. Raises +EOFError if there is nothing left to receive and the other end was +closed.

    +

    buffer must be a writable bytes-like object. If +offset is given then the message will be written into the buffer from +that position. Offset must be a non-negative integer less than the +length of buffer (in bytes).

    +

    If the buffer is too short then a BufferTooShort exception is +raised and the complete message is available as e.args[0] where e +is the exception instance.

    +
    + +
    +

    Changed in version 3.3: Connection objects themselves can now be transferred between processes +using Connection.send() and Connection.recv().

    +
    +
    +

    New in version 3.3: Connection objects now support the context management protocol – see +Context Manager Types. __enter__() returns the +connection object, and __exit__() calls close().

    +
    +
    + +

    For example:

    +
    >>> from multiprocessing import Pipe
    +>>> a, b = Pipe()
    +>>> a.send([1, 'hello', None])
    +>>> b.recv()
    +[1, 'hello', None]
    +>>> b.send_bytes(b'thank you')
    +>>> a.recv_bytes()
    +b'thank you'
    +>>> import array
    +>>> arr1 = array.array('i', range(5))
    +>>> arr2 = array.array('i', [0] * 10)
    +>>> a.send_bytes(arr1)
    +>>> count = b.recv_bytes_into(arr2)
    +>>> assert count == len(arr1) * arr1.itemsize
    +>>> arr2
    +array('i', [0, 1, 2, 3, 4, 0, 0, 0, 0, 0])
    +
    +
    +
    +

    Warning

    +

    The Connection.recv() method automatically unpickles the data it +receives, which can be a security risk unless you can trust the process +which sent the message.

    +

    Therefore, unless the connection object was produced using Pipe() you +should only use the recv() and send() +methods after performing some sort of authentication. See +Authentication keys.

    +
    +
    +

    Warning

    +

    If a process is killed while it is trying to read or write to a pipe then +the data in the pipe is likely to become corrupted, because it may become +impossible to be sure where the message boundaries lie.

    +
    +
    +
    +

    Synchronization primitives

    +

    Generally synchronization primitives are not as necessary in a multiprocess +program as they are in a multithreaded program. See the documentation for +threading module.

    +

    Note that one can also create synchronization primitives by using a manager +object – see Managers.

    +
    +
    +class multiprocessing.Barrier(parties[, action[, timeout]])
    +

    A barrier object: a clone of threading.Barrier.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +class multiprocessing.BoundedSemaphore([value])
    +

    A bounded semaphore object: a close analog of +threading.BoundedSemaphore.

    +

    A solitary difference from its close analog exists: its acquire method’s +first argument is named block, as is consistent with Lock.acquire().

    +
    +

    Note

    +

    On Mac OS X, this is indistinguishable from Semaphore because +sem_getvalue() is not implemented on that platform.

    +
    +
    + +
    +
    +class multiprocessing.Condition([lock])
    +

    A condition variable: an alias for threading.Condition.

    +

    If lock is specified then it should be a Lock or RLock +object from multiprocessing.

    +
    +

    Changed in version 3.3: The wait_for() method was added.

    +
    +
    + +
    +
    +class multiprocessing.Event
    +

    A clone of threading.Event.

    +
    + +
    +
    +class multiprocessing.Lock
    +

    A non-recursive lock object: a close analog of threading.Lock. +Once a process or thread has acquired a lock, subsequent attempts to +acquire it from any process or thread will block until it is released; +any process or thread may release it. The concepts and behaviors of +threading.Lock as it applies to threads are replicated here in +multiprocessing.Lock as it applies to either processes or threads, +except as noted.

    +

    Note that Lock is actually a factory function which returns an +instance of multiprocessing.synchronize.Lock initialized with a +default context.

    +

    Lock supports the context manager protocol and thus may be +used in with statements.

    +
    +
    +acquire(block=True, timeout=None)
    +

    Acquire a lock, blocking or non-blocking.

    +

    With the block argument set to True (the default), the method call +will block until the lock is in an unlocked state, then set it to locked +and return True. Note that the name of this first argument differs +from that in threading.Lock.acquire().

    +

    With the block argument set to False, the method call does not +block. If the lock is currently in a locked state, return False; +otherwise set the lock to a locked state and return True.

    +

    When invoked with a positive, floating-point value for timeout, block +for at most the number of seconds specified by timeout as long as +the lock can not be acquired. Invocations with a negative value for +timeout are equivalent to a timeout of zero. Invocations with a +timeout value of None (the default) set the timeout period to +infinite. Note that the treatment of negative or None values for +timeout differs from the implemented behavior in +threading.Lock.acquire(). The timeout argument has no practical +implications if the block argument is set to False and is thus +ignored. Returns True if the lock has been acquired or False if +the timeout period has elapsed.

    +
    + +
    +
    +release()
    +

    Release a lock. This can be called from any process or thread, not only +the process or thread which originally acquired the lock.

    +

    Behavior is the same as in threading.Lock.release() except that +when invoked on an unlocked lock, a ValueError is raised.

    +
    + +
    + +
    +
    +class multiprocessing.RLock
    +

    A recursive lock object: a close analog of threading.RLock. A +recursive lock must be released by the process or thread that acquired it. +Once a process or thread has acquired a recursive lock, the same process +or thread may acquire it again without blocking; that process or thread +must release it once for each time it has been acquired.

    +

    Note that RLock is actually a factory function which returns an +instance of multiprocessing.synchronize.RLock initialized with a +default context.

    +

    RLock supports the context manager protocol and thus may be +used in with statements.

    +
    +
    +acquire(block=True, timeout=None)
    +

    Acquire a lock, blocking or non-blocking.

    +

    When invoked with the block argument set to True, block until the +lock is in an unlocked state (not owned by any process or thread) unless +the lock is already owned by the current process or thread. The current +process or thread then takes ownership of the lock (if it does not +already have ownership) and the recursion level inside the lock increments +by one, resulting in a return value of True. Note that there are +several differences in this first argument’s behavior compared to the +implementation of threading.RLock.acquire(), starting with the name +of the argument itself.

    +

    When invoked with the block argument set to False, do not block. +If the lock has already been acquired (and thus is owned) by another +process or thread, the current process or thread does not take ownership +and the recursion level within the lock is not changed, resulting in +a return value of False. If the lock is in an unlocked state, the +current process or thread takes ownership and the recursion level is +incremented, resulting in a return value of True.

    +

    Use and behaviors of the timeout argument are the same as in +Lock.acquire(). Note that some of these behaviors of timeout +differ from the implemented behaviors in threading.RLock.acquire().

    +
    + +
    +
    +release()
    +

    Release a lock, decrementing the recursion level. If after the +decrement the recursion level is zero, reset the lock to unlocked (not +owned by any process or thread) and if any other processes or threads +are blocked waiting for the lock to become unlocked, allow exactly one +of them to proceed. If after the decrement the recursion level is still +nonzero, the lock remains locked and owned by the calling process or +thread.

    +

    Only call this method when the calling process or thread owns the lock. +An AssertionError is raised if this method is called by a process +or thread other than the owner or if the lock is in an unlocked (unowned) +state. Note that the type of exception raised in this situation +differs from the implemented behavior in threading.RLock.release().

    +
    + +
    + +
    +
    +class multiprocessing.Semaphore([value])
    +

    A semaphore object: a close analog of threading.Semaphore.

    +

    A solitary difference from its close analog exists: its acquire method’s +first argument is named block, as is consistent with Lock.acquire().

    +
    + +
    +

    Note

    +

    On Mac OS X, sem_timedwait is unsupported, so calling acquire() with +a timeout will emulate that function’s behavior using a sleeping loop.

    +
    +
    +

    Note

    +

    If the SIGINT signal generated by Ctrl-C arrives while the main thread is +blocked by a call to BoundedSemaphore.acquire(), Lock.acquire(), +RLock.acquire(), Semaphore.acquire(), Condition.acquire() +or Condition.wait() then the call will be immediately interrupted and +KeyboardInterrupt will be raised.

    +

    This differs from the behaviour of threading where SIGINT will be +ignored while the equivalent blocking calls are in progress.

    +
    +
    +

    Note

    +

    Some of this package’s functionality requires a functioning shared semaphore +implementation on the host operating system. Without one, the +multiprocessing.synchronize module will be disabled, and attempts to +import it will result in an ImportError. See +bpo-3770 for additional information.

    +
    +
    +
    +

    Shared ctypes Objects

    +

    It is possible to create shared objects using shared memory which can be +inherited by child processes.

    +
    +
    +multiprocessing.Value(typecode_or_type, *args, lock=True)
    +

    Return a ctypes object allocated from shared memory. By default the +return value is actually a synchronized wrapper for the object. The object +itself can be accessed via the value attribute of a Value.

    +

    typecode_or_type determines the type of the returned object: it is either a +ctypes type or a one character typecode of the kind used by the array +module. *args is passed on to the constructor for the type.

    +

    If lock is True (the default) then a new recursive lock +object is created to synchronize access to the value. If lock is +a Lock or RLock object then that will be used to +synchronize access to the value. If lock is False then +access to the returned object will not be automatically protected +by a lock, so it will not necessarily be “process-safe”.

    +

    Operations like += which involve a read and write are not +atomic. So if, for instance, you want to atomically increment a +shared value it is insufficient to just do

    +
    counter.value += 1
    +
    +
    +

    Assuming the associated lock is recursive (which it is by default) +you can instead do

    +
    with counter.get_lock():
    +    counter.value += 1
    +
    +
    +

    Note that lock is a keyword-only argument.

    +
    + +
    +
    +multiprocessing.Array(typecode_or_type, size_or_initializer, *, lock=True)
    +

    Return a ctypes array allocated from shared memory. By default the return +value is actually a synchronized wrapper for the array.

    +

    typecode_or_type determines the type of the elements of the returned array: +it is either a ctypes type or a one character typecode of the kind used by +the array module. If size_or_initializer is an integer, then it +determines the length of the array, and the array will be initially zeroed. +Otherwise, size_or_initializer is a sequence which is used to initialize +the array and whose length determines the length of the array.

    +

    If lock is True (the default) then a new lock object is created to +synchronize access to the value. If lock is a Lock or +RLock object then that will be used to synchronize access to the +value. If lock is False then access to the returned object will not be +automatically protected by a lock, so it will not necessarily be +“process-safe”.

    +

    Note that lock is a keyword only argument.

    +

    Note that an array of ctypes.c_char has value and raw +attributes which allow one to use it to store and retrieve strings.

    +
    + +
    +

    The multiprocessing.sharedctypes module

    +

    The multiprocessing.sharedctypes module provides functions for allocating +ctypes objects from shared memory which can be inherited by child +processes.

    +
    +

    Note

    +

    Although it is possible to store a pointer in shared memory remember that +this will refer to a location in the address space of a specific process. +However, the pointer is quite likely to be invalid in the context of a second +process and trying to dereference the pointer from the second process may +cause a crash.

    +
    +
    +
    +multiprocessing.sharedctypes.RawArray(typecode_or_type, size_or_initializer)
    +

    Return a ctypes array allocated from shared memory.

    +

    typecode_or_type determines the type of the elements of the returned array: +it is either a ctypes type or a one character typecode of the kind used by +the array module. If size_or_initializer is an integer then it +determines the length of the array, and the array will be initially zeroed. +Otherwise size_or_initializer is a sequence which is used to initialize the +array and whose length determines the length of the array.

    +

    Note that setting and getting an element is potentially non-atomic – use +Array() instead to make sure that access is automatically synchronized +using a lock.

    +
    + +
    +
    +multiprocessing.sharedctypes.RawValue(typecode_or_type, *args)
    +

    Return a ctypes object allocated from shared memory.

    +

    typecode_or_type determines the type of the returned object: it is either a +ctypes type or a one character typecode of the kind used by the array +module. *args is passed on to the constructor for the type.

    +

    Note that setting and getting the value is potentially non-atomic – use +Value() instead to make sure that access is automatically synchronized +using a lock.

    +

    Note that an array of ctypes.c_char has value and raw +attributes which allow one to use it to store and retrieve strings – see +documentation for ctypes.

    +
    + +
    +
    +multiprocessing.sharedctypes.Array(typecode_or_type, size_or_initializer, *, lock=True)
    +

    The same as RawArray() except that depending on the value of lock a +process-safe synchronization wrapper may be returned instead of a raw ctypes +array.

    +

    If lock is True (the default) then a new lock object is created to +synchronize access to the value. If lock is a +Lock or RLock object +then that will be used to synchronize access to the +value. If lock is False then access to the returned object will not be +automatically protected by a lock, so it will not necessarily be +“process-safe”.

    +

    Note that lock is a keyword-only argument.

    +
    + +
    +
    +multiprocessing.sharedctypes.Value(typecode_or_type, *args, lock=True)
    +

    The same as RawValue() except that depending on the value of lock a +process-safe synchronization wrapper may be returned instead of a raw ctypes +object.

    +

    If lock is True (the default) then a new lock object is created to +synchronize access to the value. If lock is a Lock or +RLock object then that will be used to synchronize access to the +value. If lock is False then access to the returned object will not be +automatically protected by a lock, so it will not necessarily be +“process-safe”.

    +

    Note that lock is a keyword-only argument.

    +
    + +
    +
    +multiprocessing.sharedctypes.copy(obj)
    +

    Return a ctypes object allocated from shared memory which is a copy of the +ctypes object obj.

    +
    + +
    +
    +multiprocessing.sharedctypes.synchronized(obj[, lock])
    +

    Return a process-safe wrapper object for a ctypes object which uses lock to +synchronize access. If lock is None (the default) then a +multiprocessing.RLock object is created automatically.

    +

    A synchronized wrapper will have two methods in addition to those of the +object it wraps: get_obj() returns the wrapped object and +get_lock() returns the lock object used for synchronization.

    +

    Note that accessing the ctypes object through the wrapper can be a lot slower +than accessing the raw ctypes object.

    +
    +

    Changed in version 3.5: Synchronized objects support the context manager protocol.

    +
    +
    + +

    The table below compares the syntax for creating shared ctypes objects from +shared memory with the normal ctypes syntax. (In the table MyStruct is some +subclass of ctypes.Structure.)

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + +

    ctypes

    sharedctypes using type

    sharedctypes using typecode

    c_double(2.4)

    RawValue(c_double, 2.4)

    RawValue(‘d’, 2.4)

    MyStruct(4, 6)

    RawValue(MyStruct, 4, 6)

    (c_short * 7)()

    RawArray(c_short, 7)

    RawArray(‘h’, 7)

    (c_int * 3)(9, 2, 8)

    RawArray(c_int, (9, 2, 8))

    RawArray(‘i’, (9, 2, 8))

    +

    Below is an example where a number of ctypes objects are modified by a child +process:

    +
    from multiprocessing import Process, Lock
    +from multiprocessing.sharedctypes import Value, Array
    +from ctypes import Structure, c_double
    +
    +class Point(Structure):
    +    _fields_ = [('x', c_double), ('y', c_double)]
    +
    +def modify(n, x, s, A):
    +    n.value **= 2
    +    x.value **= 2
    +    s.value = s.value.upper()
    +    for a in A:
    +        a.x **= 2
    +        a.y **= 2
    +
    +if __name__ == '__main__':
    +    lock = Lock()
    +
    +    n = Value('i', 7)
    +    x = Value(c_double, 1.0/3.0, lock=False)
    +    s = Array('c', b'hello world', lock=lock)
    +    A = Array(Point, [(1.875,-6.25), (-5.75,2.0), (2.375,9.5)], lock=lock)
    +
    +    p = Process(target=modify, args=(n, x, s, A))
    +    p.start()
    +    p.join()
    +
    +    print(n.value)
    +    print(x.value)
    +    print(s.value)
    +    print([(a.x, a.y) for a in A])
    +
    +
    +

    The results printed are

    +
    49
    +0.1111111111111111
    +HELLO WORLD
    +[(3.515625, 39.0625), (33.0625, 4.0), (5.640625, 90.25)]
    +
    +
    +
    +
    +
    +

    Managers

    +

    Managers provide a way to create data which can be shared between different +processes, including sharing over a network between processes running on +different machines. A manager object controls a server process which manages +shared objects. Other processes can access the shared objects by using +proxies.

    +
    +
    +multiprocessing.Manager()
    +

    Returns a started SyncManager object which +can be used for sharing objects between processes. The returned manager +object corresponds to a spawned child process and has methods which will +create shared objects and return corresponding proxies.

    +
    + +

    Manager processes will be shutdown as soon as they are garbage collected or +their parent process exits. The manager classes are defined in the +multiprocessing.managers module:

    +
    +
    +class multiprocessing.managers.BaseManager([address[, authkey]])
    +

    Create a BaseManager object.

    +

    Once created one should call start() or get_server().serve_forever() to ensure +that the manager object refers to a started manager process.

    +

    address is the address on which the manager process listens for new +connections. If address is None then an arbitrary one is chosen.

    +

    authkey is the authentication key which will be used to check the +validity of incoming connections to the server process. If +authkey is None then current_process().authkey is used. +Otherwise authkey is used and it must be a byte string.

    +
    +
    +start([initializer[, initargs]])
    +

    Start a subprocess to start the manager. If initializer is not None +then the subprocess will call initializer(*initargs) when it starts.

    +
    + +
    +
    +get_server()
    +

    Returns a Server object which represents the actual server under +the control of the Manager. The Server object supports the +serve_forever() method:

    +
    >>> from multiprocessing.managers import BaseManager
    +>>> manager = BaseManager(address=('', 50000), authkey=b'abc')
    +>>> server = manager.get_server()
    +>>> server.serve_forever()
    +
    +
    +

    Server additionally has an address attribute.

    +
    + +
    +
    +connect()
    +

    Connect a local manager object to a remote manager process:

    +
    >>> from multiprocessing.managers import BaseManager
    +>>> m = BaseManager(address=('127.0.0.1', 50000), authkey=b'abc')
    +>>> m.connect()
    +
    +
    +
    + +
    +
    +shutdown()
    +

    Stop the process used by the manager. This is only available if +start() has been used to start the server process.

    +

    This can be called multiple times.

    +
    + +
    +
    +register(typeid[, callable[, proxytype[, exposed[, method_to_typeid[, create_method]]]]])
    +

    A classmethod which can be used for registering a type or callable with +the manager class.

    +

    typeid is a “type identifier” which is used to identify a particular +type of shared object. This must be a string.

    +

    callable is a callable used for creating objects for this type +identifier. If a manager instance will be connected to the +server using the connect() method, or if the +create_method argument is False then this can be left as +None.

    +

    proxytype is a subclass of BaseProxy which is used to create +proxies for shared objects with this typeid. If None then a proxy +class is created automatically.

    +

    exposed is used to specify a sequence of method names which proxies for +this typeid should be allowed to access using +BaseProxy._callmethod(). (If exposed is None then +proxytype._exposed_ is used instead if it exists.) In the case +where no exposed list is specified, all “public methods” of the shared +object will be accessible. (Here a “public method” means any attribute +which has a __call__() method and whose name does not begin +with '_'.)

    +

    method_to_typeid is a mapping used to specify the return type of those +exposed methods which should return a proxy. It maps method names to +typeid strings. (If method_to_typeid is None then +proxytype._method_to_typeid_ is used instead if it exists.) If a +method’s name is not a key of this mapping or if the mapping is None +then the object returned by the method will be copied by value.

    +

    create_method determines whether a method should be created with name +typeid which can be used to tell the server process to create a new +shared object and return a proxy for it. By default it is True.

    +
    + +

    BaseManager instances also have one read-only property:

    +
    +
    +address
    +

    The address used by the manager.

    +
    + +
    +

    Changed in version 3.3: Manager objects support the context management protocol – see +Context Manager Types. __enter__() starts the +server process (if it has not already started) and then returns the +manager object. __exit__() calls shutdown().

    +

    In previous versions __enter__() did not start the +manager’s server process if it was not already started.

    +
    +
    + +
    +
    +class multiprocessing.managers.SyncManager
    +

    A subclass of BaseManager which can be used for the synchronization +of processes. Objects of this type are returned by +multiprocessing.Manager().

    +

    Its methods create and return Proxy Objects for a +number of commonly used data types to be synchronized across processes. +This notably includes shared lists and dictionaries.

    +
    +
    +Barrier(parties[, action[, timeout]])
    +

    Create a shared threading.Barrier object and return a +proxy for it.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +BoundedSemaphore([value])
    +

    Create a shared threading.BoundedSemaphore object and return a +proxy for it.

    +
    + +
    +
    +Condition([lock])
    +

    Create a shared threading.Condition object and return a proxy for +it.

    +

    If lock is supplied then it should be a proxy for a +threading.Lock or threading.RLock object.

    +
    +

    Changed in version 3.3: The wait_for() method was added.

    +
    +
    + +
    +
    +Event()
    +

    Create a shared threading.Event object and return a proxy for it.

    +
    + +
    +
    +Lock()
    +

    Create a shared threading.Lock object and return a proxy for it.

    +
    + +
    +
    +Namespace()
    +

    Create a shared Namespace object and return a proxy for it.

    +
    + +
    +
    +Queue([maxsize])
    +

    Create a shared queue.Queue object and return a proxy for it.

    +
    + +
    +
    +RLock()
    +

    Create a shared threading.RLock object and return a proxy for it.

    +
    + +
    +
    +Semaphore([value])
    +

    Create a shared threading.Semaphore object and return a proxy for +it.

    +
    + +
    +
    +Array(typecode, sequence)
    +

    Create an array and return a proxy for it.

    +
    + +
    +
    +Value(typecode, value)
    +

    Create an object with a writable value attribute and return a proxy +for it.

    +
    + +
    +
    +dict()
    +
    +dict(mapping)
    +
    +dict(sequence)
    +

    Create a shared dict object and return a proxy for it.

    +
    + +
    +
    +list()
    +
    +list(sequence)
    +

    Create a shared list object and return a proxy for it.

    +
    + +
    +

    Changed in version 3.6: Shared objects are capable of being nested. For example, a shared +container object such as a shared list can contain other shared objects +which will all be managed and synchronized by the SyncManager.

    +
    +
    + +
    +
    +class multiprocessing.managers.Namespace
    +

    A type that can register with SyncManager.

    +

    A namespace object has no public methods, but does have writable attributes. +Its representation shows the values of its attributes.

    +

    However, when using a proxy for a namespace object, an attribute beginning +with '_' will be an attribute of the proxy and not an attribute of the +referent:

    +
    >>> manager = multiprocessing.Manager()
    +>>> Global = manager.Namespace()
    +>>> Global.x = 10
    +>>> Global.y = 'hello'
    +>>> Global._z = 12.3    # this is an attribute of the proxy
    +>>> print(Global)
    +Namespace(x=10, y='hello')
    +
    +
    +
    + +
    +

    Customized managers

    +

    To create one’s own manager, one creates a subclass of BaseManager and +uses the register() classmethod to register new types or +callables with the manager class. For example:

    +
    from multiprocessing.managers import BaseManager
    +
    +class MathsClass:
    +    def add(self, x, y):
    +        return x + y
    +    def mul(self, x, y):
    +        return x * y
    +
    +class MyManager(BaseManager):
    +    pass
    +
    +MyManager.register('Maths', MathsClass)
    +
    +if __name__ == '__main__':
    +    with MyManager() as manager:
    +        maths = manager.Maths()
    +        print(maths.add(4, 3))         # prints 7
    +        print(maths.mul(7, 8))         # prints 56
    +
    +
    +
    +
    +

    Using a remote manager

    +

    It is possible to run a manager server on one machine and have clients use it +from other machines (assuming that the firewalls involved allow it).

    +

    Running the following commands creates a server for a single shared queue which +remote clients can access:

    +
    >>> from multiprocessing.managers import BaseManager
    +>>> from queue import Queue
    +>>> queue = Queue()
    +>>> class QueueManager(BaseManager): pass
    +>>> QueueManager.register('get_queue', callable=lambda:queue)
    +>>> m = QueueManager(address=('', 50000), authkey=b'abracadabra')
    +>>> s = m.get_server()
    +>>> s.serve_forever()
    +
    +
    +

    One client can access the server as follows:

    +
    >>> from multiprocessing.managers import BaseManager
    +>>> class QueueManager(BaseManager): pass
    +>>> QueueManager.register('get_queue')
    +>>> m = QueueManager(address=('foo.bar.org', 50000), authkey=b'abracadabra')
    +>>> m.connect()
    +>>> queue = m.get_queue()
    +>>> queue.put('hello')
    +
    +
    +

    Another client can also use it:

    +
    >>> from multiprocessing.managers import BaseManager
    +>>> class QueueManager(BaseManager): pass
    +>>> QueueManager.register('get_queue')
    +>>> m = QueueManager(address=('foo.bar.org', 50000), authkey=b'abracadabra')
    +>>> m.connect()
    +>>> queue = m.get_queue()
    +>>> queue.get()
    +'hello'
    +
    +
    +

    Local processes can also access that queue, using the code from above on the +client to access it remotely:

    +
    >>> from multiprocessing import Process, Queue
    +>>> from multiprocessing.managers import BaseManager
    +>>> class Worker(Process):
    +...     def __init__(self, q):
    +...         self.q = q
    +...         super(Worker, self).__init__()
    +...     def run(self):
    +...         self.q.put('local hello')
    +...
    +>>> queue = Queue()
    +>>> w = Worker(queue)
    +>>> w.start()
    +>>> class QueueManager(BaseManager): pass
    +...
    +>>> QueueManager.register('get_queue', callable=lambda: queue)
    +>>> m = QueueManager(address=('', 50000), authkey=b'abracadabra')
    +>>> s = m.get_server()
    +>>> s.serve_forever()
    +
    +
    +
    +
    +
    +

    Proxy Objects

    +

    A proxy is an object which refers to a shared object which lives (presumably) +in a different process. The shared object is said to be the referent of the +proxy. Multiple proxy objects may have the same referent.

    +

    A proxy object has methods which invoke corresponding methods of its referent +(although not every method of the referent will necessarily be available through +the proxy). In this way, a proxy can be used just like its referent can:

    +
    >>> from multiprocessing import Manager
    +>>> manager = Manager()
    +>>> l = manager.list([i*i for i in range(10)])
    +>>> print(l)
    +[0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
    +>>> print(repr(l))
    +<ListProxy object, typeid 'list' at 0x...>
    +>>> l[4]
    +16
    +>>> l[2:5]
    +[4, 9, 16]
    +
    +
    +

    Notice that applying str() to a proxy will return the representation of +the referent, whereas applying repr() will return the representation of +the proxy.

    +

    An important feature of proxy objects is that they are picklable so they can be +passed between processes. As such, a referent can contain +Proxy Objects. This permits nesting of these managed +lists, dicts, and other Proxy Objects:

    +
    >>> a = manager.list()
    +>>> b = manager.list()
    +>>> a.append(b)         # referent of a now contains referent of b
    +>>> print(a, b)
    +[<ListProxy object, typeid 'list' at ...>] []
    +>>> b.append('hello')
    +>>> print(a[0], b)
    +['hello'] ['hello']
    +
    +
    +

    Similarly, dict and list proxies may be nested inside one another:

    +
    >>> l_outer = manager.list([ manager.dict() for i in range(2) ])
    +>>> d_first_inner = l_outer[0]
    +>>> d_first_inner['a'] = 1
    +>>> d_first_inner['b'] = 2
    +>>> l_outer[1]['c'] = 3
    +>>> l_outer[1]['z'] = 26
    +>>> print(l_outer[0])
    +{'a': 1, 'b': 2}
    +>>> print(l_outer[1])
    +{'c': 3, 'z': 26}
    +
    +
    +

    If standard (non-proxy) list or dict objects are contained +in a referent, modifications to those mutable values will not be propagated +through the manager because the proxy has no way of knowing when the values +contained within are modified. However, storing a value in a container proxy +(which triggers a __setitem__ on the proxy object) does propagate through +the manager and so to effectively modify such an item, one could re-assign the +modified value to the container proxy:

    +
    # create a list proxy and append a mutable object (a dictionary)
    +lproxy = manager.list()
    +lproxy.append({})
    +# now mutate the dictionary
    +d = lproxy[0]
    +d['a'] = 1
    +d['b'] = 2
    +# at this point, the changes to d are not yet synced, but by
    +# updating the dictionary, the proxy is notified of the change
    +lproxy[0] = d
    +
    +
    +

    This approach is perhaps less convenient than employing nested +Proxy Objects for most use cases but also +demonstrates a level of control over the synchronization.

    +
    +

    Note

    +

    The proxy types in multiprocessing do nothing to support comparisons +by value. So, for instance, we have:

    +
    >>> manager.list([1,2,3]) == [1,2,3]
    +False
    +
    +
    +

    One should just use a copy of the referent instead when making comparisons.

    +
    +
    +
    +class multiprocessing.managers.BaseProxy
    +

    Proxy objects are instances of subclasses of BaseProxy.

    +
    +
    +_callmethod(methodname[, args[, kwds]])
    +

    Call and return the result of a method of the proxy’s referent.

    +

    If proxy is a proxy whose referent is obj then the expression

    +
    proxy._callmethod(methodname, args, kwds)
    +
    +
    +

    will evaluate the expression

    +
    getattr(obj, methodname)(*args, **kwds)
    +
    +
    +

    in the manager’s process.

    +

    The returned value will be a copy of the result of the call or a proxy to +a new shared object – see documentation for the method_to_typeid +argument of BaseManager.register().

    +

    If an exception is raised by the call, then is re-raised by +_callmethod(). If some other exception is raised in the manager’s +process then this is converted into a RemoteError exception and is +raised by _callmethod().

    +

    Note in particular that an exception will be raised if methodname has +not been exposed.

    +

    An example of the usage of _callmethod():

    +
    >>> l = manager.list(range(10))
    +>>> l._callmethod('__len__')
    +10
    +>>> l._callmethod('__getitem__', (slice(2, 7),)) # equivalent to l[2:7]
    +[2, 3, 4, 5, 6]
    +>>> l._callmethod('__getitem__', (20,))          # equivalent to l[20]
    +Traceback (most recent call last):
    +...
    +IndexError: list index out of range
    +
    +
    +
    + +
    +
    +_getvalue()
    +

    Return a copy of the referent.

    +

    If the referent is unpicklable then this will raise an exception.

    +
    + +
    +
    +__repr__()
    +

    Return a representation of the proxy object.

    +
    + +
    +
    +__str__()
    +

    Return the representation of the referent.

    +
    + +
    + +
    +

    Cleanup

    +

    A proxy object uses a weakref callback so that when it gets garbage collected it +deregisters itself from the manager which owns its referent.

    +

    A shared object gets deleted from the manager process when there are no longer +any proxies referring to it.

    +
    +
    +
    +

    Process Pools

    +

    One can create a pool of processes which will carry out tasks submitted to it +with the Pool class.

    +
    +
    +class multiprocessing.pool.Pool([processes[, initializer[, initargs[, maxtasksperchild[, context]]]]])
    +

    A process pool object which controls a pool of worker processes to which jobs +can be submitted. It supports asynchronous results with timeouts and +callbacks and has a parallel map implementation.

    +

    processes is the number of worker processes to use. If processes is +None then the number returned by os.cpu_count() is used.

    +

    If initializer is not None then each worker process will call +initializer(*initargs) when it starts.

    +

    maxtasksperchild is the number of tasks a worker process can complete +before it will exit and be replaced with a fresh worker process, to enable +unused resources to be freed. The default maxtasksperchild is None, which +means worker processes will live as long as the pool.

    +

    context can be used to specify the context used for starting +the worker processes. Usually a pool is created using the +function multiprocessing.Pool() or the Pool() method +of a context object. In both cases context is set +appropriately.

    +

    Note that the methods of the pool object should only be called by +the process which created the pool.

    +
    +

    New in version 3.2: maxtasksperchild

    +
    +
    +

    New in version 3.4: context

    +
    +
    +

    Note

    +

    Worker processes within a Pool typically live for the complete +duration of the Pool’s work queue. A frequent pattern found in other +systems (such as Apache, mod_wsgi, etc) to free resources held by +workers is to allow a worker within a pool to complete only a set +amount of work before being exiting, being cleaned up and a new +process spawned to replace the old one. The maxtasksperchild +argument to the Pool exposes this ability to the end user.

    +
    +
    +
    +apply(func[, args[, kwds]])
    +

    Call func with arguments args and keyword arguments kwds. It blocks +until the result is ready. Given this blocks, apply_async() is +better suited for performing work in parallel. Additionally, func +is only executed in one of the workers of the pool.

    +
    + +
    +
    +apply_async(func[, args[, kwds[, callback[, error_callback]]]])
    +

    A variant of the apply() method which returns a result object.

    +

    If callback is specified then it should be a callable which accepts a +single argument. When the result becomes ready callback is applied to +it, that is unless the call failed, in which case the error_callback +is applied instead.

    +

    If error_callback is specified then it should be a callable which +accepts a single argument. If the target function fails, then +the error_callback is called with the exception instance.

    +

    Callbacks should complete immediately since otherwise the thread which +handles the results will get blocked.

    +
    + +
    +
    +map(func, iterable[, chunksize])
    +

    A parallel equivalent of the map() built-in function (it supports only +one iterable argument though). It blocks until the result is ready.

    +

    This method chops the iterable into a number of chunks which it submits to +the process pool as separate tasks. The (approximate) size of these +chunks can be specified by setting chunksize to a positive integer.

    +

    Note that it may cause high memory usage for very long iterables. Consider +using imap() or imap_unordered() with explicit chunksize +option for better efficiency.

    +
    + +
    +
    +map_async(func, iterable[, chunksize[, callback[, error_callback]]])
    +

    A variant of the map() method which returns a result object.

    +

    If callback is specified then it should be a callable which accepts a +single argument. When the result becomes ready callback is applied to +it, that is unless the call failed, in which case the error_callback +is applied instead.

    +

    If error_callback is specified then it should be a callable which +accepts a single argument. If the target function fails, then +the error_callback is called with the exception instance.

    +

    Callbacks should complete immediately since otherwise the thread which +handles the results will get blocked.

    +
    + +
    +
    +imap(func, iterable[, chunksize])
    +

    A lazier version of map().

    +

    The chunksize argument is the same as the one used by the map() +method. For very long iterables using a large value for chunksize can +make the job complete much faster than using the default value of +1.

    +

    Also if chunksize is 1 then the next() method of the iterator +returned by the imap() method has an optional timeout parameter: +next(timeout) will raise multiprocessing.TimeoutError if the +result cannot be returned within timeout seconds.

    +
    + +
    +
    +imap_unordered(func, iterable[, chunksize])
    +

    The same as imap() except that the ordering of the results from the +returned iterator should be considered arbitrary. (Only when there is +only one worker process is the order guaranteed to be “correct”.)

    +
    + +
    +
    +starmap(func, iterable[, chunksize])
    +

    Like map() except that the elements of the iterable are expected +to be iterables that are unpacked as arguments.

    +

    Hence an iterable of [(1,2), (3, 4)] results in [func(1,2), +func(3,4)].

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +starmap_async(func, iterable[, chunksize[, callback[, error_callback]]])
    +

    A combination of starmap() and map_async() that iterates over +iterable of iterables and calls func with the iterables unpacked. +Returns a result object.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +close()
    +

    Prevents any more tasks from being submitted to the pool. Once all the +tasks have been completed the worker processes will exit.

    +
    + +
    +
    +terminate()
    +

    Stops the worker processes immediately without completing outstanding +work. When the pool object is garbage collected terminate() will be +called immediately.

    +
    + +
    +
    +join()
    +

    Wait for the worker processes to exit. One must call close() or +terminate() before using join().

    +
    + +
    +

    New in version 3.3: Pool objects now support the context management protocol – see +Context Manager Types. __enter__() returns the +pool object, and __exit__() calls terminate().

    +
    +
    + +
    +
    +class multiprocessing.pool.AsyncResult
    +

    The class of the result returned by Pool.apply_async() and +Pool.map_async().

    +
    +
    +get([timeout])
    +

    Return the result when it arrives. If timeout is not None and the +result does not arrive within timeout seconds then +multiprocessing.TimeoutError is raised. If the remote call raised +an exception then that exception will be reraised by get().

    +
    + +
    +
    +wait([timeout])
    +

    Wait until the result is available or until timeout seconds pass.

    +
    + +
    +
    +ready()
    +

    Return whether the call has completed.

    +
    + +
    +
    +successful()
    +

    Return whether the call completed without raising an exception. Will +raise AssertionError if the result is not ready.

    +
    + +
    + +

    The following example demonstrates the use of a pool:

    +
    from multiprocessing import Pool
    +import time
    +
    +def f(x):
    +    return x*x
    +
    +if __name__ == '__main__':
    +    with Pool(processes=4) as pool:         # start 4 worker processes
    +        result = pool.apply_async(f, (10,)) # evaluate "f(10)" asynchronously in a single process
    +        print(result.get(timeout=1))        # prints "100" unless your computer is *very* slow
    +
    +        print(pool.map(f, range(10)))       # prints "[0, 1, 4,..., 81]"
    +
    +        it = pool.imap(f, range(10))
    +        print(next(it))                     # prints "0"
    +        print(next(it))                     # prints "1"
    +        print(it.next(timeout=1))           # prints "4" unless your computer is *very* slow
    +
    +        result = pool.apply_async(time.sleep, (10,))
    +        print(result.get(timeout=1))        # raises multiprocessing.TimeoutError
    +
    +
    +
    +
    +

    Listeners and Clients

    +

    Usually message passing between processes is done using queues or by using +Connection objects returned by +Pipe().

    +

    However, the multiprocessing.connection module allows some extra +flexibility. It basically gives a high level message oriented API for dealing +with sockets or Windows named pipes. It also has support for digest +authentication using the hmac module, and for polling +multiple connections at the same time.

    +
    +
    +multiprocessing.connection.deliver_challenge(connection, authkey)
    +

    Send a randomly generated message to the other end of the connection and wait +for a reply.

    +

    If the reply matches the digest of the message using authkey as the key +then a welcome message is sent to the other end of the connection. Otherwise +AuthenticationError is raised.

    +
    + +
    +
    +multiprocessing.connection.answer_challenge(connection, authkey)
    +

    Receive a message, calculate the digest of the message using authkey as the +key, and then send the digest back.

    +

    If a welcome message is not received, then +AuthenticationError is raised.

    +
    + +
    +
    +multiprocessing.connection.Client(address[, family[, authkey]])
    +

    Attempt to set up a connection to the listener which is using address +address, returning a Connection.

    +

    The type of the connection is determined by family argument, but this can +generally be omitted since it can usually be inferred from the format of +address. (See Address Formats)

    +

    If authkey is given and not None, it should be a byte string and will be +used as the secret key for an HMAC-based authentication challenge. No +authentication is done if authkey is None. +AuthenticationError is raised if authentication fails. +See Authentication keys.

    +
    + +
    +
    +class multiprocessing.connection.Listener([address[, family[, backlog[, authkey]]]])
    +

    A wrapper for a bound socket or Windows named pipe which is ‘listening’ for +connections.

    +

    address is the address to be used by the bound socket or named pipe of the +listener object.

    +
    +

    Note

    +

    If an address of ‘0.0.0.0’ is used, the address will not be a connectable +end point on Windows. If you require a connectable end-point, +you should use ‘127.0.0.1’.

    +
    +

    family is the type of socket (or named pipe) to use. This can be one of +the strings 'AF_INET' (for a TCP socket), 'AF_UNIX' (for a Unix +domain socket) or 'AF_PIPE' (for a Windows named pipe). Of these only +the first is guaranteed to be available. If family is None then the +family is inferred from the format of address. If address is also +None then a default is chosen. This default is the family which is +assumed to be the fastest available. See +Address Formats. Note that if family is +'AF_UNIX' and address is None then the socket will be created in a +private temporary directory created using tempfile.mkstemp().

    +

    If the listener object uses a socket then backlog (1 by default) is passed +to the listen() method of the socket once it has been +bound.

    +

    If authkey is given and not None, it should be a byte string and will be +used as the secret key for an HMAC-based authentication challenge. No +authentication is done if authkey is None. +AuthenticationError is raised if authentication fails. +See Authentication keys.

    +
    +
    +accept()
    +

    Accept a connection on the bound socket or named pipe of the listener +object and return a Connection object. +If authentication is attempted and fails, then +AuthenticationError is raised.

    +
    + +
    +
    +close()
    +

    Close the bound socket or named pipe of the listener object. This is +called automatically when the listener is garbage collected. However it +is advisable to call it explicitly.

    +
    + +

    Listener objects have the following read-only properties:

    +
    +
    +address
    +

    The address which is being used by the Listener object.

    +
    + +
    +
    +last_accepted
    +

    The address from which the last accepted connection came. If this is +unavailable then it is None.

    +
    + +
    +

    New in version 3.3: Listener objects now support the context management protocol – see +Context Manager Types. __enter__() returns the +listener object, and __exit__() calls close().

    +
    +
    + +
    +
    +multiprocessing.connection.wait(object_list, timeout=None)
    +

    Wait till an object in object_list is ready. Returns the list of +those objects in object_list which are ready. If timeout is a +float then the call blocks for at most that many seconds. If +timeout is None then it will block for an unlimited period. +A negative timeout is equivalent to a zero timeout.

    +

    For both Unix and Windows, an object can appear in object_list if +it is

    + +

    A connection or socket object is ready when there is data available +to be read from it, or the other end has been closed.

    +

    Unix: wait(object_list, timeout) almost equivalent +select.select(object_list, [], [], timeout). The difference is +that, if select.select() is interrupted by a signal, it can +raise OSError with an error number of EINTR, whereas +wait() will not.

    +

    Windows: An item in object_list must either be an integer +handle which is waitable (according to the definition used by the +documentation of the Win32 function WaitForMultipleObjects()) +or it can be an object with a fileno() method which returns a +socket handle or pipe handle. (Note that pipe handles and socket +handles are not waitable handles.)

    +
    +

    New in version 3.3.

    +
    +
    + +

    Examples

    +

    The following server code creates a listener which uses 'secret password' as +an authentication key. It then waits for a connection and sends some data to +the client:

    +
    from multiprocessing.connection import Listener
    +from array import array
    +
    +address = ('localhost', 6000)     # family is deduced to be 'AF_INET'
    +
    +with Listener(address, authkey=b'secret password') as listener:
    +    with listener.accept() as conn:
    +        print('connection accepted from', listener.last_accepted)
    +
    +        conn.send([2.25, None, 'junk', float])
    +
    +        conn.send_bytes(b'hello')
    +
    +        conn.send_bytes(array('i', [42, 1729]))
    +
    +
    +

    The following code connects to the server and receives some data from the +server:

    +
    from multiprocessing.connection import Client
    +from array import array
    +
    +address = ('localhost', 6000)
    +
    +with Client(address, authkey=b'secret password') as conn:
    +    print(conn.recv())                  # => [2.25, None, 'junk', float]
    +
    +    print(conn.recv_bytes())            # => 'hello'
    +
    +    arr = array('i', [0, 0, 0, 0, 0])
    +    print(conn.recv_bytes_into(arr))    # => 8
    +    print(arr)                          # => array('i', [42, 1729, 0, 0, 0])
    +
    +
    +

    The following code uses wait() to +wait for messages from multiple processes at once:

    +
    import time, random
    +from multiprocessing import Process, Pipe, current_process
    +from multiprocessing.connection import wait
    +
    +def foo(w):
    +    for i in range(10):
    +        w.send((i, current_process().name))
    +    w.close()
    +
    +if __name__ == '__main__':
    +    readers = []
    +
    +    for i in range(4):
    +        r, w = Pipe(duplex=False)
    +        readers.append(r)
    +        p = Process(target=foo, args=(w,))
    +        p.start()
    +        # We close the writable end of the pipe now to be sure that
    +        # p is the only process which owns a handle for it.  This
    +        # ensures that when p closes its handle for the writable end,
    +        # wait() will promptly report the readable end as being ready.
    +        w.close()
    +
    +    while readers:
    +        for r in wait(readers):
    +            try:
    +                msg = r.recv()
    +            except EOFError:
    +                readers.remove(r)
    +            else:
    +                print(msg)
    +
    +
    +
    +

    Address Formats

    +
      +
    • An 'AF_INET' address is a tuple of the form (hostname, port) where +hostname is a string and port is an integer.

    • +
    • An 'AF_UNIX' address is a string representing a filename on the +filesystem.

    • +
    • +
      An 'AF_PIPE' address is a string of the form

      r'\.\pipe{PipeName}'. To use Client() to connect to a named +pipe on a remote computer called ServerName one should use an address of the +form r'\ServerName\pipe{PipeName}' instead.

      +
      +
      +
    • +
    +

    Note that any string beginning with two backslashes is assumed by default to be +an 'AF_PIPE' address rather than an 'AF_UNIX' address.

    +
    +
    +
    +

    Authentication keys

    +

    When one uses Connection.recv, the +data received is automatically +unpickled. Unfortunately unpickling data from an untrusted source is a security +risk. Therefore Listener and Client() use the hmac module +to provide digest authentication.

    +

    An authentication key is a byte string which can be thought of as a +password: once a connection is established both ends will demand proof +that the other knows the authentication key. (Demonstrating that both +ends are using the same key does not involve sending the key over +the connection.)

    +

    If authentication is requested but no authentication key is specified then the +return value of current_process().authkey is used (see +Process). This value will be automatically inherited by +any Process object that the current process creates. +This means that (by default) all processes of a multi-process program will share +a single authentication key which can be used when setting up connections +between themselves.

    +

    Suitable authentication keys can also be generated by using os.urandom().

    +
    +
    +

    Logging

    +

    Some support for logging is available. Note, however, that the logging +package does not use process shared locks so it is possible (depending on the +handler type) for messages from different processes to get mixed up.

    +
    +
    +multiprocessing.get_logger()
    +

    Returns the logger used by multiprocessing. If necessary, a new one +will be created.

    +

    When first created the logger has level logging.NOTSET and no +default handler. Messages sent to this logger will not by default propagate +to the root logger.

    +

    Note that on Windows child processes will only inherit the level of the +parent process’s logger – any other customization of the logger will not be +inherited.

    +
    + +
    +
    +multiprocessing.log_to_stderr()
    +

    This function performs a call to get_logger() but in addition to +returning the logger created by get_logger, it adds a handler which sends +output to sys.stderr using format +'[%(levelname)s/%(processName)s] %(message)s'.

    +
    + +

    Below is an example session with logging turned on:

    +
    >>> import multiprocessing, logging
    +>>> logger = multiprocessing.log_to_stderr()
    +>>> logger.setLevel(logging.INFO)
    +>>> logger.warning('doomed')
    +[WARNING/MainProcess] doomed
    +>>> m = multiprocessing.Manager()
    +[INFO/SyncManager-...] child process calling self.run()
    +[INFO/SyncManager-...] created temp directory /.../pymp-...
    +[INFO/SyncManager-...] manager serving at '/.../listener-...'
    +>>> del m
    +[INFO/MainProcess] sending shutdown message to manager
    +[INFO/SyncManager-...] manager exiting with exitcode 0
    +
    +
    +

    For a full table of logging levels, see the logging module.

    +
    +
    +

    The multiprocessing.dummy module

    +

    multiprocessing.dummy replicates the API of multiprocessing but is +no more than a wrapper around the threading module.

    +
    +
    +
    +

    Programming guidelines

    +

    There are certain guidelines and idioms which should be adhered to when using +multiprocessing.

    +
    +

    All start methods

    +

    The following applies to all start methods.

    +

    Avoid shared state

    +
    +

    As far as possible one should try to avoid shifting large amounts of data +between processes.

    +

    It is probably best to stick to using queues or pipes for communication +between processes rather than using the lower level synchronization +primitives.

    +
    +

    Picklability

    +
    +

    Ensure that the arguments to the methods of proxies are picklable.

    +
    +

    Thread safety of proxies

    +
    +

    Do not use a proxy object from more than one thread unless you protect it +with a lock.

    +

    (There is never a problem with different processes using the same proxy.)

    +
    +

    Joining zombie processes

    +
    +

    On Unix when a process finishes but has not been joined it becomes a zombie. +There should never be very many because each time a new process starts (or +active_children() is called) all completed processes +which have not yet been joined will be joined. Also calling a finished +process’s Process.is_alive will +join the process. Even so it is probably good +practice to explicitly join all the processes that you start.

    +
    +

    Better to inherit than pickle/unpickle

    +
    +

    When using the spawn or forkserver start methods many types +from multiprocessing need to be picklable so that child +processes can use them. However, one should generally avoid +sending shared objects to other processes using pipes or queues. +Instead you should arrange the program so that a process which +needs access to a shared resource created elsewhere can inherit it +from an ancestor process.

    +
    +

    Avoid terminating processes

    +
    +

    Using the Process.terminate +method to stop a process is liable to +cause any shared resources (such as locks, semaphores, pipes and queues) +currently being used by the process to become broken or unavailable to other +processes.

    +

    Therefore it is probably best to only consider using +Process.terminate on processes +which never use any shared resources.

    +
    +

    Joining processes that use queues

    +
    +

    Bear in mind that a process that has put items in a queue will wait before +terminating until all the buffered items are fed by the “feeder” thread to +the underlying pipe. (The child process can call the +Queue.cancel_join_thread +method of the queue to avoid this behaviour.)

    +

    This means that whenever you use a queue you need to make sure that all +items which have been put on the queue will eventually be removed before the +process is joined. Otherwise you cannot be sure that processes which have +put items on the queue will terminate. Remember also that non-daemonic +processes will be joined automatically.

    +

    An example which will deadlock is the following:

    +
    from multiprocessing import Process, Queue
    +
    +def f(q):
    +    q.put('X' * 1000000)
    +
    +if __name__ == '__main__':
    +    queue = Queue()
    +    p = Process(target=f, args=(queue,))
    +    p.start()
    +    p.join()                    # this deadlocks
    +    obj = queue.get()
    +
    +
    +

    A fix here would be to swap the last two lines (or simply remove the +p.join() line).

    +
    +

    Explicitly pass resources to child processes

    +
    +

    On Unix using the fork start method, a child process can make +use of a shared resource created in a parent process using a +global resource. However, it is better to pass the object as an +argument to the constructor for the child process.

    +

    Apart from making the code (potentially) compatible with Windows +and the other start methods this also ensures that as long as the +child process is still alive the object will not be garbage +collected in the parent process. This might be important if some +resource is freed when the object is garbage collected in the +parent process.

    +

    So for instance

    +
    from multiprocessing import Process, Lock
    +
    +def f():
    +    ... do something using "lock" ...
    +
    +if __name__ == '__main__':
    +    lock = Lock()
    +    for i in range(10):
    +        Process(target=f).start()
    +
    +
    +

    should be rewritten as

    +
    from multiprocessing import Process, Lock
    +
    +def f(l):
    +    ... do something using "l" ...
    +
    +if __name__ == '__main__':
    +    lock = Lock()
    +    for i in range(10):
    +        Process(target=f, args=(lock,)).start()
    +
    +
    +
    +

    Beware of replacing sys.stdin with a “file like object”

    +
    +

    multiprocessing originally unconditionally called:

    +
    os.close(sys.stdin.fileno())
    +
    +
    +

    in the multiprocessing.Process._bootstrap() method — this resulted +in issues with processes-in-processes. This has been changed to:

    +
    sys.stdin.close()
    +sys.stdin = open(os.open(os.devnull, os.O_RDONLY), closefd=False)
    +
    +
    +

    Which solves the fundamental issue of processes colliding with each other +resulting in a bad file descriptor error, but introduces a potential danger +to applications which replace sys.stdin() with a “file-like object” +with output buffering. This danger is that if multiple processes call +close() on this file-like object, it could result in the same +data being flushed to the object multiple times, resulting in corruption.

    +

    If you write a file-like object and implement your own caching, you can +make it fork-safe by storing the pid whenever you append to the cache, +and discarding the cache when the pid changes. For example:

    +
    @property
    +def cache(self):
    +    pid = os.getpid()
    +    if pid != self._pid:
    +        self._pid = pid
    +        self._cache = []
    +    return self._cache
    +
    +
    +

    For more information, see bpo-5155, bpo-5313 and bpo-5331

    +
    +
    +
    +

    The spawn and forkserver start methods

    +

    There are a few extra restriction which don’t apply to the fork +start method.

    +

    More picklability

    +
    +

    Ensure that all arguments to Process.__init__() are picklable. +Also, if you subclass Process then make sure that +instances will be picklable when the Process.start method is called.

    +
    +

    Global variables

    +
    +

    Bear in mind that if code run in a child process tries to access a global +variable, then the value it sees (if any) may not be the same as the value +in the parent process at the time that Process.start was called.

    +

    However, global variables which are just module level constants cause no +problems.

    +
    +

    Safe importing of main module

    +
    +

    Make sure that the main module can be safely imported by a new Python +interpreter without causing unintended side effects (such a starting a new +process).

    +

    For example, using the spawn or forkserver start method +running the following module would fail with a +RuntimeError:

    +
    from multiprocessing import Process
    +
    +def foo():
    +    print('hello')
    +
    +p = Process(target=foo)
    +p.start()
    +
    +
    +

    Instead one should protect the “entry point” of the program by using if +__name__ == '__main__': as follows:

    +
    from multiprocessing import Process, freeze_support, set_start_method
    +
    +def foo():
    +    print('hello')
    +
    +if __name__ == '__main__':
    +    freeze_support()
    +    set_start_method('spawn')
    +    p = Process(target=foo)
    +    p.start()
    +
    +
    +

    (The freeze_support() line can be omitted if the program will be run +normally instead of frozen.)

    +

    This allows the newly spawned Python interpreter to safely import the module +and then run the module’s foo() function.

    +

    Similar restrictions apply if a pool or manager is created in the main +module.

    +
    +
    +
    +
    +

    Examples

    +

    Demonstration of how to create and use customized managers and proxies:

    +
    from multiprocessing import freeze_support
    +from multiprocessing.managers import BaseManager, BaseProxy
    +import operator
    +
    +##
    +
    +class Foo:
    +    def f(self):
    +        print('you called Foo.f()')
    +    def g(self):
    +        print('you called Foo.g()')
    +    def _h(self):
    +        print('you called Foo._h()')
    +
    +# A simple generator function
    +def baz():
    +    for i in range(10):
    +        yield i*i
    +
    +# Proxy type for generator objects
    +class GeneratorProxy(BaseProxy):
    +    _exposed_ = ['__next__']
    +    def __iter__(self):
    +        return self
    +    def __next__(self):
    +        return self._callmethod('__next__')
    +
    +# Function to return the operator module
    +def get_operator_module():
    +    return operator
    +
    +##
    +
    +class MyManager(BaseManager):
    +    pass
    +
    +# register the Foo class; make `f()` and `g()` accessible via proxy
    +MyManager.register('Foo1', Foo)
    +
    +# register the Foo class; make `g()` and `_h()` accessible via proxy
    +MyManager.register('Foo2', Foo, exposed=('g', '_h'))
    +
    +# register the generator function baz; use `GeneratorProxy` to make proxies
    +MyManager.register('baz', baz, proxytype=GeneratorProxy)
    +
    +# register get_operator_module(); make public functions accessible via proxy
    +MyManager.register('operator', get_operator_module)
    +
    +##
    +
    +def test():
    +    manager = MyManager()
    +    manager.start()
    +
    +    print('-' * 20)
    +
    +    f1 = manager.Foo1()
    +    f1.f()
    +    f1.g()
    +    assert not hasattr(f1, '_h')
    +    assert sorted(f1._exposed_) == sorted(['f', 'g'])
    +
    +    print('-' * 20)
    +
    +    f2 = manager.Foo2()
    +    f2.g()
    +    f2._h()
    +    assert not hasattr(f2, 'f')
    +    assert sorted(f2._exposed_) == sorted(['g', '_h'])
    +
    +    print('-' * 20)
    +
    +    it = manager.baz()
    +    for i in it:
    +        print('<%d>' % i, end=' ')
    +    print()
    +
    +    print('-' * 20)
    +
    +    op = manager.operator()
    +    print('op.add(23, 45) =', op.add(23, 45))
    +    print('op.pow(2, 94) =', op.pow(2, 94))
    +    print('op._exposed_ =', op._exposed_)
    +
    +##
    +
    +if __name__ == '__main__':
    +    freeze_support()
    +    test()
    +
    +
    +

    Using Pool:

    +
    import multiprocessing
    +import time
    +import random
    +import sys
    +
    +#
    +# Functions used by test code
    +#
    +
    +def calculate(func, args):
    +    result = func(*args)
    +    return '%s says that %s%s = %s' % (
    +        multiprocessing.current_process().name,
    +        func.__name__, args, result
    +        )
    +
    +def calculatestar(args):
    +    return calculate(*args)
    +
    +def mul(a, b):
    +    time.sleep(0.5 * random.random())
    +    return a * b
    +
    +def plus(a, b):
    +    time.sleep(0.5 * random.random())
    +    return a + b
    +
    +def f(x):
    +    return 1.0 / (x - 5.0)
    +
    +def pow3(x):
    +    return x ** 3
    +
    +def noop(x):
    +    pass
    +
    +#
    +# Test code
    +#
    +
    +def test():
    +    PROCESSES = 4
    +    print('Creating pool with %d processes\n' % PROCESSES)
    +
    +    with multiprocessing.Pool(PROCESSES) as pool:
    +        #
    +        # Tests
    +        #
    +
    +        TASKS = [(mul, (i, 7)) for i in range(10)] + \
    +                [(plus, (i, 8)) for i in range(10)]
    +
    +        results = [pool.apply_async(calculate, t) for t in TASKS]
    +        imap_it = pool.imap(calculatestar, TASKS)
    +        imap_unordered_it = pool.imap_unordered(calculatestar, TASKS)
    +
    +        print('Ordered results using pool.apply_async():')
    +        for r in results:
    +            print('\t', r.get())
    +        print()
    +
    +        print('Ordered results using pool.imap():')
    +        for x in imap_it:
    +            print('\t', x)
    +        print()
    +
    +        print('Unordered results using pool.imap_unordered():')
    +        for x in imap_unordered_it:
    +            print('\t', x)
    +        print()
    +
    +        print('Ordered results using pool.map() --- will block till complete:')
    +        for x in pool.map(calculatestar, TASKS):
    +            print('\t', x)
    +        print()
    +
    +        #
    +        # Test error handling
    +        #
    +
    +        print('Testing error handling:')
    +
    +        try:
    +            print(pool.apply(f, (5,)))
    +        except ZeroDivisionError:
    +            print('\tGot ZeroDivisionError as expected from pool.apply()')
    +        else:
    +            raise AssertionError('expected ZeroDivisionError')
    +
    +        try:
    +            print(pool.map(f, list(range(10))))
    +        except ZeroDivisionError:
    +            print('\tGot ZeroDivisionError as expected from pool.map()')
    +        else:
    +            raise AssertionError('expected ZeroDivisionError')
    +
    +        try:
    +            print(list(pool.imap(f, list(range(10)))))
    +        except ZeroDivisionError:
    +            print('\tGot ZeroDivisionError as expected from list(pool.imap())')
    +        else:
    +            raise AssertionError('expected ZeroDivisionError')
    +
    +        it = pool.imap(f, list(range(10)))
    +        for i in range(10):
    +            try:
    +                x = next(it)
    +            except ZeroDivisionError:
    +                if i == 5:
    +                    pass
    +            except StopIteration:
    +                break
    +            else:
    +                if i == 5:
    +                    raise AssertionError('expected ZeroDivisionError')
    +
    +        assert i == 9
    +        print('\tGot ZeroDivisionError as expected from IMapIterator.next()')
    +        print()
    +
    +        #
    +        # Testing timeouts
    +        #
    +
    +        print('Testing ApplyResult.get() with timeout:', end=' ')
    +        res = pool.apply_async(calculate, TASKS[0])
    +        while 1:
    +            sys.stdout.flush()
    +            try:
    +                sys.stdout.write('\n\t%s' % res.get(0.02))
    +                break
    +            except multiprocessing.TimeoutError:
    +                sys.stdout.write('.')
    +        print()
    +        print()
    +
    +        print('Testing IMapIterator.next() with timeout:', end=' ')
    +        it = pool.imap(calculatestar, TASKS)
    +        while 1:
    +            sys.stdout.flush()
    +            try:
    +                sys.stdout.write('\n\t%s' % it.next(0.02))
    +            except StopIteration:
    +                break
    +            except multiprocessing.TimeoutError:
    +                sys.stdout.write('.')
    +        print()
    +        print()
    +
    +
    +if __name__ == '__main__':
    +    multiprocessing.freeze_support()
    +    test()
    +
    +
    +

    An example showing how to use queues to feed tasks to a collection of worker +processes and collect the results:

    +
    import time
    +import random
    +
    +from multiprocessing import Process, Queue, current_process, freeze_support
    +
    +#
    +# Function run by worker processes
    +#
    +
    +def worker(input, output):
    +    for func, args in iter(input.get, 'STOP'):
    +        result = calculate(func, args)
    +        output.put(result)
    +
    +#
    +# Function used to calculate result
    +#
    +
    +def calculate(func, args):
    +    result = func(*args)
    +    return '%s says that %s%s = %s' % \
    +        (current_process().name, func.__name__, args, result)
    +
    +#
    +# Functions referenced by tasks
    +#
    +
    +def mul(a, b):
    +    time.sleep(0.5*random.random())
    +    return a * b
    +
    +def plus(a, b):
    +    time.sleep(0.5*random.random())
    +    return a + b
    +
    +#
    +#
    +#
    +
    +def test():
    +    NUMBER_OF_PROCESSES = 4
    +    TASKS1 = [(mul, (i, 7)) for i in range(20)]
    +    TASKS2 = [(plus, (i, 8)) for i in range(10)]
    +
    +    # Create queues
    +    task_queue = Queue()
    +    done_queue = Queue()
    +
    +    # Submit tasks
    +    for task in TASKS1:
    +        task_queue.put(task)
    +
    +    # Start worker processes
    +    for i in range(NUMBER_OF_PROCESSES):
    +        Process(target=worker, args=(task_queue, done_queue)).start()
    +
    +    # Get and print results
    +    print('Unordered results:')
    +    for i in range(len(TASKS1)):
    +        print('\t', done_queue.get())
    +
    +    # Add more tasks using `put()`
    +    for task in TASKS2:
    +        task_queue.put(task)
    +
    +    # Get and print some more results
    +    for i in range(len(TASKS2)):
    +        print('\t', done_queue.get())
    +
    +    # Tell child processes to stop
    +    for i in range(NUMBER_OF_PROCESSES):
    +        task_queue.put('STOP')
    +
    +
    +if __name__ == '__main__':
    +    freeze_support()
    +    test()
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/netdata.html b/python-3.7.4-docs-html/library/netdata.html new file mode 100644 index 0000000..79ec4af --- /dev/null +++ b/python-3.7.4-docs-html/library/netdata.html @@ -0,0 +1,265 @@ + + + + + + + Internet Data Handling — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Internet Data Handling

    +

    This chapter describes modules which support handling data formats commonly used +on the Internet.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/netrc.html b/python-3.7.4-docs-html/library/netrc.html new file mode 100644 index 0000000..8fa252c --- /dev/null +++ b/python-3.7.4-docs-html/library/netrc.html @@ -0,0 +1,271 @@ + + + + + + + netrc — netrc file processing — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    netrc — netrc file processing

    +

    Source code: Lib/netrc.py

    +
    +

    The netrc class parses and encapsulates the netrc file format used by +the Unix ftp program and other FTP clients.

    +
    +
    +class netrc.netrc([file])
    +

    A netrc instance or subclass instance encapsulates data from a netrc +file. The initialization argument, if present, specifies the file to parse. If +no argument is given, the file .netrc in the user’s home directory – +as determined by os.path.expanduser() – will be read. Otherwise, +a FileNotFoundError exception will be raised. +Parse errors will raise NetrcParseError with diagnostic +information including the file name, line number, and terminating token. +If no argument is specified on a POSIX system, the presence of passwords in +the .netrc file will raise a NetrcParseError if the file +ownership or permissions are insecure (owned by a user other than the user +running the process, or accessible for read or write by any other user). +This implements security behavior equivalent to that of ftp and other +programs that use .netrc.

    +
    +

    Changed in version 3.4: Added the POSIX permission check.

    +
    +
    +

    Changed in version 3.7: os.path.expanduser() is used to find the location of the +.netrc file when file is not passed as argument.

    +
    +
    + +
    +
    +exception netrc.NetrcParseError
    +

    Exception raised by the netrc class when syntactical errors are +encountered in source text. Instances of this exception provide three +interesting attributes: msg is a textual explanation of the error, +filename is the name of the source file, and lineno gives the +line number on which the error was found.

    +
    + +
    +

    netrc Objects

    +

    A netrc instance has the following methods:

    +
    +
    +netrc.authenticators(host)
    +

    Return a 3-tuple (login, account, password) of authenticators for host. +If the netrc file did not contain an entry for the given host, return the tuple +associated with the ‘default’ entry. If neither matching host nor default entry +is available, return None.

    +
    + +
    +
    +netrc.__repr__()
    +

    Dump the class data as a string in the format of a netrc file. (This discards +comments and may reorder the entries.)

    +
    + +

    Instances of netrc have public instance variables:

    +
    +
    +netrc.hosts
    +

    Dictionary mapping host names to (login, account, password) tuples. The +‘default’ entry, if any, is represented as a pseudo-host by that name.

    +
    + +
    +
    +netrc.macros
    +

    Dictionary mapping macro names to string lists.

    +
    + +
    +

    Note

    +

    Passwords are limited to a subset of the ASCII character set. All ASCII +punctuation is allowed in passwords, however, note that whitespace and +non-printable characters are not allowed in passwords. This is a limitation +of the way the .netrc file is parsed and may be removed in the future.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/nis.html b/python-3.7.4-docs-html/library/nis.html new file mode 100644 index 0000000..e51de2b --- /dev/null +++ b/python-3.7.4-docs-html/library/nis.html @@ -0,0 +1,232 @@ + + + + + + + nis — Interface to Sun’s NIS (Yellow Pages) — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    nis — Interface to Sun’s NIS (Yellow Pages)

    +
    +

    The nis module gives a thin wrapper around the NIS library, useful for +central administration of several hosts.

    +

    Because NIS exists only on Unix systems, this module is only available for Unix.

    +

    The nis module defines the following functions:

    +
    +
    +nis.match(key, mapname, domain=default_domain)
    +

    Return the match for key in map mapname, or raise an error +(nis.error) if there is none. Both should be strings, key is 8-bit +clean. Return value is an arbitrary array of bytes (may contain NULL and +other joys).

    +

    Note that mapname is first checked if it is an alias to another name.

    +

    The domain argument allows overriding the NIS domain used for the lookup. If +unspecified, lookup is in the default NIS domain.

    +
    + +
    +
    +nis.cat(mapname, domain=default_domain)
    +

    Return a dictionary mapping key to value such that match(key, +mapname)==value. Note that both keys and values of the dictionary are +arbitrary arrays of bytes.

    +

    Note that mapname is first checked if it is an alias to another name.

    +

    The domain argument allows overriding the NIS domain used for the lookup. If +unspecified, lookup is in the default NIS domain.

    +
    + +
    +
    +nis.maps(domain=default_domain)
    +

    Return a list of all valid maps.

    +

    The domain argument allows overriding the NIS domain used for the lookup. If +unspecified, lookup is in the default NIS domain.

    +
    + +
    +
    +nis.get_default_domain()
    +

    Return the system default NIS domain.

    +
    + +

    The nis module defines the following exception:

    +
    +
    +exception nis.error
    +

    An error raised when a NIS function returns an error code.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/nntplib.html b/python-3.7.4-docs-html/library/nntplib.html new file mode 100644 index 0000000..9cf3bf5 --- /dev/null +++ b/python-3.7.4-docs-html/library/nntplib.html @@ -0,0 +1,773 @@ + + + + + + + nntplib — NNTP protocol client — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    nntplib — NNTP protocol client

    +

    Source code: Lib/nntplib.py

    +
    +

    This module defines the class NNTP which implements the client side of +the Network News Transfer Protocol. It can be used to implement a news reader +or poster, or automated news processors. It is compatible with RFC 3977 +as well as the older RFC 977 and RFC 2980.

    +

    Here are two small examples of how it can be used. To list some statistics +about a newsgroup and print the subjects of the last 10 articles:

    +
    >>> s = nntplib.NNTP('news.gmane.org')
    +>>> resp, count, first, last, name = s.group('gmane.comp.python.committers')
    +>>> print('Group', name, 'has', count, 'articles, range', first, 'to', last)
    +Group gmane.comp.python.committers has 1096 articles, range 1 to 1096
    +>>> resp, overviews = s.over((last - 9, last))
    +>>> for id, over in overviews:
    +...     print(id, nntplib.decode_header(over['subject']))
    +...
    +1087 Re: Commit privileges for Łukasz Langa
    +1088 Re: 3.2 alpha 2 freeze
    +1089 Re: 3.2 alpha 2 freeze
    +1090 Re: Commit privileges for Łukasz Langa
    +1091 Re: Commit privileges for Łukasz Langa
    +1092 Updated ssh key
    +1093 Re: Updated ssh key
    +1094 Re: Updated ssh key
    +1095 Hello fellow committers!
    +1096 Re: Hello fellow committers!
    +>>> s.quit()
    +'205 Bye!'
    +
    +
    +

    To post an article from a binary file (this assumes that the article has valid +headers, and that you have right to post on the particular newsgroup):

    +
    >>> s = nntplib.NNTP('news.gmane.org')
    +>>> f = open('article.txt', 'rb')
    +>>> s.post(f)
    +'240 Article posted successfully.'
    +>>> s.quit()
    +'205 Bye!'
    +
    +
    +

    The module itself defines the following classes:

    +
    +
    +class nntplib.NNTP(host, port=119, user=None, password=None, readermode=None, usenetrc=False[, timeout])
    +

    Return a new NNTP object, representing a connection +to the NNTP server running on host host, listening at port port. +An optional timeout can be specified for the socket connection. +If the optional user and password are provided, or if suitable +credentials are present in /.netrc and the optional flag usenetrc +is true, the AUTHINFO USER and AUTHINFO PASS commands are used +to identify and authenticate the user to the server. If the optional +flag readermode is true, then a mode reader command is sent before +authentication is performed. Reader mode is sometimes necessary if you are +connecting to an NNTP server on the local machine and intend to call +reader-specific commands, such as group. If you get unexpected +NNTPPermanentErrors, you might need to set readermode. +The NNTP class supports the with statement to +unconditionally consume OSError exceptions and to close the NNTP +connection when done, e.g.:

    +
    >>> from nntplib import NNTP
    +>>> with NNTP('news.gmane.org') as n:
    +...     n.group('gmane.comp.python.committers')
    +... # doctest: +SKIP
    +('211 1755 1 1755 gmane.comp.python.committers', 1755, 1, 1755, 'gmane.comp.python.committers')
    +>>>
    +
    +
    +
    +

    Changed in version 3.2: usenetrc is now False by default.

    +
    +
    +

    Changed in version 3.3: Support for the with statement was added.

    +
    +
    + +
    +
    +class nntplib.NNTP_SSL(host, port=563, user=None, password=None, ssl_context=None, readermode=None, usenetrc=False[, timeout])
    +

    Return a new NNTP_SSL object, representing an encrypted +connection to the NNTP server running on host host, listening at +port port. NNTP_SSL objects have the same methods as +NNTP objects. If port is omitted, port 563 (NNTPS) is used. +ssl_context is also optional, and is a SSLContext object. +Please read Security considerations for best practices. +All other parameters behave the same as for NNTP.

    +

    Note that SSL-on-563 is discouraged per RFC 4642, in favor of +STARTTLS as described below. However, some servers only support the +former.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.4: The class now supports hostname check with +ssl.SSLContext.check_hostname and Server Name Indication (see +ssl.HAS_SNI).

    +
    +
    + +
    +
    +exception nntplib.NNTPError
    +

    Derived from the standard exception Exception, this is the base +class for all exceptions raised by the nntplib module. Instances +of this class have the following attribute:

    +
    +
    +response
    +

    The response of the server if available, as a str object.

    +
    + +
    + +
    +
    +exception nntplib.NNTPReplyError
    +

    Exception raised when an unexpected reply is received from the server.

    +
    + +
    +
    +exception nntplib.NNTPTemporaryError
    +

    Exception raised when a response code in the range 400–499 is received.

    +
    + +
    +
    +exception nntplib.NNTPPermanentError
    +

    Exception raised when a response code in the range 500–599 is received.

    +
    + +
    +
    +exception nntplib.NNTPProtocolError
    +

    Exception raised when a reply is received from the server that does not begin +with a digit in the range 1–5.

    +
    + +
    +
    +exception nntplib.NNTPDataError
    +

    Exception raised when there is some error in the response data.

    +
    + +
    +

    NNTP Objects

    +

    When connected, NNTP and NNTP_SSL objects support the +following methods and attributes.

    +
    +

    Attributes

    +
    +
    +NNTP.nntp_version
    +

    An integer representing the version of the NNTP protocol supported by the +server. In practice, this should be 2 for servers advertising +RFC 3977 compliance and 1 for others.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +NNTP.nntp_implementation
    +

    A string describing the software name and version of the NNTP server, +or None if not advertised by the server.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +

    Methods

    +

    The response that is returned as the first item in the return tuple of almost +all methods is the server’s response: a string beginning with a three-digit +code. If the server’s response indicates an error, the method raises one of +the above exceptions.

    +

    Many of the following methods take an optional keyword-only argument file. +When the file argument is supplied, it must be either a file object +opened for binary writing, or the name of an on-disk file to be written to. +The method will then write any data returned by the server (except for the +response line and the terminating dot) to the file; any list of lines, +tuples or objects that the method normally returns will be empty.

    +
    +

    Changed in version 3.2: Many of the following methods have been reworked and fixed, which makes +them incompatible with their 3.1 counterparts.

    +
    +
    +
    +NNTP.quit()
    +

    Send a QUIT command and close the connection. Once this method has been +called, no other methods of the NNTP object should be called.

    +
    + +
    +
    +NNTP.getwelcome()
    +

    Return the welcome message sent by the server in reply to the initial +connection. (This message sometimes contains disclaimers or help information +that may be relevant to the user.)

    +
    + +
    +
    +NNTP.getcapabilities()
    +

    Return the RFC 3977 capabilities advertised by the server, as a +dict instance mapping capability names to (possibly empty) lists +of values. On legacy servers which don’t understand the CAPABILITIES +command, an empty dictionary is returned instead.

    +
    >>> s = NNTP('news.gmane.org')
    +>>> 'POST' in s.getcapabilities()
    +True
    +
    +
    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +NNTP.login(user=None, password=None, usenetrc=True)
    +

    Send AUTHINFO commands with the user name and password. If user +and password are None and usenetrc is true, credentials from +~/.netrc will be used if possible.

    +

    Unless intentionally delayed, login is normally performed during the +NNTP object initialization and separately calling this function +is unnecessary. To force authentication to be delayed, you must not set +user or password when creating the object, and must set usenetrc to +False.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +NNTP.starttls(context=None)
    +

    Send a STARTTLS command. This will enable encryption on the NNTP +connection. The context argument is optional and should be a +ssl.SSLContext object. Please read Security considerations for best +practices.

    +

    Note that this may not be done after authentication information has +been transmitted, and authentication occurs by default if possible during a +NNTP object initialization. See NNTP.login() for information +on suppressing this behavior.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.4: The method now supports hostname check with +ssl.SSLContext.check_hostname and Server Name Indication (see +ssl.HAS_SNI).

    +
    +
    + +
    +
    +NNTP.newgroups(date, *, file=None)
    +

    Send a NEWGROUPS command. The date argument should be a +datetime.date or datetime.datetime object. +Return a pair (response, groups) where groups is a list representing +the groups that are new since the given date. If file is supplied, +though, then groups will be empty.

    +
    >>> from datetime import date, timedelta
    +>>> resp, groups = s.newgroups(date.today() - timedelta(days=3))
    +>>> len(groups) # doctest: +SKIP
    +85
    +>>> groups[0] # doctest: +SKIP
    +GroupInfo(group='gmane.network.tor.devel', last='4', first='1', flag='m')
    +
    +
    +
    + +
    +
    +NNTP.newnews(group, date, *, file=None)
    +

    Send a NEWNEWS command. Here, group is a group name or '*', and +date has the same meaning as for newgroups(). Return a pair +(response, articles) where articles is a list of message ids.

    +

    This command is frequently disabled by NNTP server administrators.

    +
    + +
    +
    +NNTP.list(group_pattern=None, *, file=None)
    +

    Send a LIST or LIST ACTIVE command. Return a pair +(response, list) where list is a list of tuples representing all +the groups available from this NNTP server, optionally matching the +pattern string group_pattern. Each tuple has the form +(group, last, first, flag), where group is a group name, last +and first are the last and first article numbers, and flag usually +takes one of these values:

    +
      +
    • y: Local postings and articles from peers are allowed.

    • +
    • m: The group is moderated and all postings must be approved.

    • +
    • n: No local postings are allowed, only articles from peers.

    • +
    • j: Articles from peers are filed in the junk group instead.

    • +
    • x: No local postings, and articles from peers are ignored.

    • +
    • =foo.bar: Articles are filed in the foo.bar group instead.

    • +
    +

    If flag has another value, then the status of the newsgroup should be +considered unknown.

    +

    This command can return very large results, especially if group_pattern +is not specified. It is best to cache the results offline unless you +really need to refresh them.

    +
    +

    Changed in version 3.2: group_pattern was added.

    +
    +
    + +
    +
    +NNTP.descriptions(grouppattern)
    +

    Send a LIST NEWSGROUPS command, where grouppattern is a wildmat string as +specified in RFC 3977 (it’s essentially the same as DOS or UNIX shell wildcard +strings). Return a pair (response, descriptions), where descriptions +is a dictionary mapping group names to textual descriptions.

    +
    >>> resp, descs = s.descriptions('gmane.comp.python.*')
    +>>> len(descs) # doctest: +SKIP
    +295
    +>>> descs.popitem() # doctest: +SKIP
    +('gmane.comp.python.bio.general', 'BioPython discussion list (Moderated)')
    +
    +
    +
    + +
    +
    +NNTP.description(group)
    +

    Get a description for a single group group. If more than one group matches +(if ‘group’ is a real wildmat string), return the first match. If no group +matches, return an empty string.

    +

    This elides the response code from the server. If the response code is needed, +use descriptions().

    +
    + +
    +
    +NNTP.group(name)
    +

    Send a GROUP command, where name is the group name. The group is +selected as the current group, if it exists. Return a tuple +(response, count, first, last, name) where count is the (estimated) +number of articles in the group, first is the first article number in +the group, last is the last article number in the group, and name +is the group name.

    +
    + +
    +
    +NNTP.over(message_spec, *, file=None)
    +

    Send an OVER command, or an XOVER command on legacy servers. +message_spec can be either a string representing a message id, or +a (first, last) tuple of numbers indicating a range of articles in +the current group, or a (first, None) tuple indicating a range of +articles starting from first to the last article in the current group, +or None to select the current article in the current group.

    +

    Return a pair (response, overviews). overviews is a list of +(article_number, overview) tuples, one for each article selected +by message_spec. Each overview is a dictionary with the same number +of items, but this number depends on the server. These items are either +message headers (the key is then the lower-cased header name) or metadata +items (the key is then the metadata name prepended with ":"). The +following items are guaranteed to be present by the NNTP specification:

    +
      +
    • the subject, from, date, message-id and references +headers

    • +
    • the :bytes metadata: the number of bytes in the entire raw article +(including headers and body)

    • +
    • the :lines metadata: the number of lines in the article body

    • +
    +

    The value of each item is either a string, or None if not present.

    +

    It is advisable to use the decode_header() function on header +values when they may contain non-ASCII characters:

    +
    >>> _, _, first, last, _ = s.group('gmane.comp.python.devel')
    +>>> resp, overviews = s.over((last, last))
    +>>> art_num, over = overviews[0]
    +>>> art_num
    +117216
    +>>> list(over.keys())
    +['xref', 'from', ':lines', ':bytes', 'references', 'date', 'message-id', 'subject']
    +>>> over['from']
    +'=?UTF-8?B?Ik1hcnRpbiB2LiBMw7Z3aXMi?= <martin@v.loewis.de>'
    +>>> nntplib.decode_header(over['from'])
    +'"Martin v. Löwis" <martin@v.loewis.de>'
    +
    +
    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +NNTP.help(*, file=None)
    +

    Send a HELP command. Return a pair (response, list) where list is a +list of help strings.

    +
    + +
    +
    +NNTP.stat(message_spec=None)
    +

    Send a STAT command, where message_spec is either a message id +(enclosed in '<' and '>') or an article number in the current group. +If message_spec is omitted or None, the current article in the +current group is considered. Return a triple (response, number, id) +where number is the article number and id is the message id.

    +
    >>> _, _, first, last, _ = s.group('gmane.comp.python.devel')
    +>>> resp, number, message_id = s.stat(first)
    +>>> number, message_id
    +(9099, '<20030112190404.GE29873@epoch.metaslash.com>')
    +
    +
    +
    + +
    +
    +NNTP.next()
    +

    Send a NEXT command. Return as for stat().

    +
    + +
    +
    +NNTP.last()
    +

    Send a LAST command. Return as for stat().

    +
    + +
    +
    +NNTP.article(message_spec=None, *, file=None)
    +

    Send an ARTICLE command, where message_spec has the same meaning as +for stat(). Return a tuple (response, info) where info +is a namedtuple with three attributes number, +message_id and lines (in that order). number is the article number +in the group (or 0 if the information is not available), message_id the +message id as a string, and lines a list of lines (without terminating +newlines) comprising the raw message including headers and body.

    +
    >>> resp, info = s.article('<20030112190404.GE29873@epoch.metaslash.com>')
    +>>> info.number
    +0
    +>>> info.message_id
    +'<20030112190404.GE29873@epoch.metaslash.com>'
    +>>> len(info.lines)
    +65
    +>>> info.lines[0]
    +b'Path: main.gmane.org!not-for-mail'
    +>>> info.lines[1]
    +b'From: Neal Norwitz <neal@metaslash.com>'
    +>>> info.lines[-3:]
    +[b'There is a patch for 2.3 as well as 2.2.', b'', b'Neal']
    +
    +
    +
    + +
    +
    +NNTP.head(message_spec=None, *, file=None)
    +

    Same as article(), but sends a HEAD command. The lines +returned (or written to file) will only contain the message headers, not +the body.

    +
    + +
    +
    +NNTP.body(message_spec=None, *, file=None)
    +

    Same as article(), but sends a BODY command. The lines +returned (or written to file) will only contain the message body, not the +headers.

    +
    + +
    +
    +NNTP.post(data)
    +

    Post an article using the POST command. The data argument is either +a file object opened for binary reading, or any iterable of bytes +objects (representing raw lines of the article to be posted). It should +represent a well-formed news article, including the required headers. The +post() method automatically escapes lines beginning with . and +appends the termination line.

    +

    If the method succeeds, the server’s response is returned. If the server +refuses posting, a NNTPReplyError is raised.

    +
    + +
    +
    +NNTP.ihave(message_id, data)
    +

    Send an IHAVE command. message_id is the id of the message to send +to the server (enclosed in '<' and '>'). The data parameter +and the return value are the same as for post().

    +
    + +
    +
    +NNTP.date()
    +

    Return a pair (response, date). date is a datetime +object containing the current date and time of the server.

    +
    + +
    +
    +NNTP.slave()
    +

    Send a SLAVE command. Return the server’s response.

    +
    + +
    +
    +NNTP.set_debuglevel(level)
    +

    Set the instance’s debugging level. This controls the amount of debugging +output printed. The default, 0, produces no debugging output. A value of +1 produces a moderate amount of debugging output, generally a single line +per request or response. A value of 2 or higher produces the maximum amount +of debugging output, logging each line sent and received on the connection +(including message text).

    +
    + +

    The following are optional NNTP extensions defined in RFC 2980. Some of +them have been superseded by newer commands in RFC 3977.

    +
    +
    +NNTP.xhdr(hdr, str, *, file=None)
    +

    Send an XHDR command. The hdr argument is a header keyword, e.g. +'subject'. The str argument should have the form 'first-last' +where first and last are the first and last article numbers to search. +Return a pair (response, list), where list is a list of pairs (id, +text), where id is an article number (as a string) and text is the text of +the requested header for that article. If the file parameter is supplied, then +the output of the XHDR command is stored in a file. If file is a string, +then the method will open a file with that name, write to it then close it. +If file is a file object, then it will start calling write() on +it to store the lines of the command output. If file is supplied, then the +returned list is an empty list.

    +
    + +
    +
    +NNTP.xover(start, end, *, file=None)
    +

    Send an XOVER command. start and end are article numbers +delimiting the range of articles to select. The return value is the +same of for over(). It is recommended to use over() +instead, since it will automatically use the newer OVER command +if available.

    +
    + +
    +
    +NNTP.xpath(id)
    +

    Return a pair (resp, path), where path is the directory path to the +article with message ID id. Most of the time, this extension is not +enabled by NNTP server administrators.

    +
    +

    Deprecated since version 3.3: The XPATH extension is not actively used.

    +
    +
    + +
    +
    +
    +

    Utility functions

    +

    The module also defines the following utility function:

    +
    +
    +nntplib.decode_header(header_str)
    +

    Decode a header value, un-escaping any escaped non-ASCII characters. +header_str must be a str object. The unescaped value is +returned. Using this function is recommended to display some headers +in a human readable form:

    +
    >>> decode_header("Some subject")
    +'Some subject'
    +>>> decode_header("=?ISO-8859-15?Q?D=E9buter_en_Python?=")
    +'Débuter en Python'
    +>>> decode_header("Re: =?UTF-8?B?cHJvYmzDqG1lIGRlIG1hdHJpY2U=?=")
    +'Re: problème de matrice'
    +
    +
    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/numbers.html b/python-3.7.4-docs-html/library/numbers.html new file mode 100644 index 0000000..f9b6808 --- /dev/null +++ b/python-3.7.4-docs-html/library/numbers.html @@ -0,0 +1,420 @@ + + + + + + + numbers — Numeric abstract base classes — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    numbers — Numeric abstract base classes

    +

    Source code: Lib/numbers.py

    +
    +

    The numbers module (PEP 3141) defines a hierarchy of numeric +abstract base classes which progressively define +more operations. None of the types defined in this module can be instantiated.

    +
    +
    +class numbers.Number
    +

    The root of the numeric hierarchy. If you just want to check if an argument +x is a number, without caring what kind, use isinstance(x, Number).

    +
    + +
    +

    The numeric tower

    +
    +
    +class numbers.Complex
    +

    Subclasses of this type describe complex numbers and include the operations +that work on the built-in complex type. These are: conversions to +complex and bool, real, imag, +, +-, *, /, abs(), conjugate(), ==, and !=. All +except - and != are abstract.

    +
    +
    +real
    +

    Abstract. Retrieves the real component of this number.

    +
    + +
    +
    +imag
    +

    Abstract. Retrieves the imaginary component of this number.

    +
    + +
    +
    +abstractmethod conjugate()
    +

    Abstract. Returns the complex conjugate. For example, (1+3j).conjugate() +== (1-3j).

    +
    + +
    + +
    +
    +class numbers.Real
    +

    To Complex, Real adds the operations that work on real +numbers.

    +

    In short, those are: a conversion to float, math.trunc(), +round(), math.floor(), math.ceil(), divmod(), //, +%, <, <=, >, and >=.

    +

    Real also provides defaults for complex(), real, +imag, and conjugate().

    +
    + +
    +
    +class numbers.Rational
    +

    Subtypes Real and adds +numerator and denominator properties, which +should be in lowest terms. With these, it provides a default for +float().

    +
    +
    +numerator
    +

    Abstract.

    +
    + +
    +
    +denominator
    +

    Abstract.

    +
    + +
    + +
    +
    +class numbers.Integral
    +

    Subtypes Rational and adds a conversion to int. Provides +defaults for float(), numerator, and +denominator. Adds abstract methods for ** and +bit-string operations: <<, >>, &, ^, |, ~.

    +
    + +
    +
    +

    Notes for type implementors

    +

    Implementors should be careful to make equal numbers equal and hash +them to the same values. This may be subtle if there are two different +extensions of the real numbers. For example, fractions.Fraction +implements hash() as follows:

    +
    def __hash__(self):
    +    if self.denominator == 1:
    +        # Get integers right.
    +        return hash(self.numerator)
    +    # Expensive check, but definitely correct.
    +    if self == float(self):
    +        return hash(float(self))
    +    else:
    +        # Use tuple's hash to avoid a high collision rate on
    +        # simple fractions.
    +        return hash((self.numerator, self.denominator))
    +
    +
    +
    +

    Adding More Numeric ABCs

    +

    There are, of course, more possible ABCs for numbers, and this would +be a poor hierarchy if it precluded the possibility of adding +those. You can add MyFoo between Complex and +Real with:

    +
    class MyFoo(Complex): ...
    +MyFoo.register(Real)
    +
    +
    +
    +
    +

    Implementing the arithmetic operations

    +

    We want to implement the arithmetic operations so that mixed-mode +operations either call an implementation whose author knew about the +types of both arguments, or convert both to the nearest built in type +and do the operation there. For subtypes of Integral, this +means that __add__() and __radd__() should be defined as:

    +
    class MyIntegral(Integral):
    +
    +    def __add__(self, other):
    +        if isinstance(other, MyIntegral):
    +            return do_my_adding_stuff(self, other)
    +        elif isinstance(other, OtherTypeIKnowAbout):
    +            return do_my_other_adding_stuff(self, other)
    +        else:
    +            return NotImplemented
    +
    +    def __radd__(self, other):
    +        if isinstance(other, MyIntegral):
    +            return do_my_adding_stuff(other, self)
    +        elif isinstance(other, OtherTypeIKnowAbout):
    +            return do_my_other_adding_stuff(other, self)
    +        elif isinstance(other, Integral):
    +            return int(other) + int(self)
    +        elif isinstance(other, Real):
    +            return float(other) + float(self)
    +        elif isinstance(other, Complex):
    +            return complex(other) + complex(self)
    +        else:
    +            return NotImplemented
    +
    +
    +

    There are 5 different cases for a mixed-type operation on subclasses +of Complex. I’ll refer to all of the above code that doesn’t +refer to MyIntegral and OtherTypeIKnowAbout as +“boilerplate”. a will be an instance of A, which is a subtype +of Complex (a : A <: Complex), and b : B <: +Complex. I’ll consider a + b:

    +
    +
      +
    1. If A defines an __add__() which accepts b, all is +well.

    2. +
    3. If A falls back to the boilerplate code, and it were to +return a value from __add__(), we’d miss the possibility +that B defines a more intelligent __radd__(), so the +boilerplate should return NotImplemented from +__add__(). (Or A may not implement __add__() at +all.)

    4. +
    5. Then B’s __radd__() gets a chance. If it accepts +a, all is well.

    6. +
    7. If it falls back to the boilerplate, there are no more possible +methods to try, so this is where the default implementation +should live.

    8. +
    9. If B <: A, Python tries B.__radd__ before +A.__add__. This is ok, because it was implemented with +knowledge of A, so it can handle those instances before +delegating to Complex.

    10. +
    +
    +

    If A <: Complex and B <: Real without sharing any other knowledge, +then the appropriate shared operation is the one involving the built +in complex, and both __radd__() s land there, so a+b +== b+a.

    +

    Because most of the operations on any given type will be very similar, +it can be useful to define a helper function which generates the +forward and reverse instances of any given operator. For example, +fractions.Fraction uses:

    +
    def _operator_fallbacks(monomorphic_operator, fallback_operator):
    +    def forward(a, b):
    +        if isinstance(b, (int, Fraction)):
    +            return monomorphic_operator(a, b)
    +        elif isinstance(b, float):
    +            return fallback_operator(float(a), b)
    +        elif isinstance(b, complex):
    +            return fallback_operator(complex(a), b)
    +        else:
    +            return NotImplemented
    +    forward.__name__ = '__' + fallback_operator.__name__ + '__'
    +    forward.__doc__ = monomorphic_operator.__doc__
    +
    +    def reverse(b, a):
    +        if isinstance(a, Rational):
    +            # Includes ints.
    +            return monomorphic_operator(a, b)
    +        elif isinstance(a, numbers.Real):
    +            return fallback_operator(float(a), float(b))
    +        elif isinstance(a, numbers.Complex):
    +            return fallback_operator(complex(a), complex(b))
    +        else:
    +            return NotImplemented
    +    reverse.__name__ = '__r' + fallback_operator.__name__ + '__'
    +    reverse.__doc__ = monomorphic_operator.__doc__
    +
    +    return forward, reverse
    +
    +def _add(a, b):
    +    """a + b"""
    +    return Fraction(a.numerator * b.denominator +
    +                    b.numerator * a.denominator,
    +                    a.denominator * b.denominator)
    +
    +__add__, __radd__ = _operator_fallbacks(_add, operator.add)
    +
    +# ...
    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/numeric.html b/python-3.7.4-docs-html/library/numeric.html new file mode 100644 index 0000000..a450e0f --- /dev/null +++ b/python-3.7.4-docs-html/library/numeric.html @@ -0,0 +1,258 @@ + + + + + + + Numeric and Mathematical Modules — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Numeric and Mathematical Modules

    +

    The modules described in this chapter provide numeric and math-related functions +and data types. The numbers module defines an abstract hierarchy of +numeric types. The math and cmath modules contain various +mathematical functions for floating-point and complex numbers. The decimal +module supports exact representations of decimal numbers, using arbitrary precision +arithmetic.

    +

    The following modules are documented in this chapter:

    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/operator.html b/python-3.7.4-docs-html/library/operator.html new file mode 100644 index 0000000..db7bc47 --- /dev/null +++ b/python-3.7.4-docs-html/library/operator.html @@ -0,0 +1,906 @@ + + + + + + + operator — Standard operators as functions — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    operator — Standard operators as functions

    +

    Source code: Lib/operator.py

    +
    +

    The operator module exports a set of efficient functions corresponding to +the intrinsic operators of Python. For example, operator.add(x, y) is +equivalent to the expression x+y. Many function names are those used for +special methods, without the double underscores. For backward compatibility, +many of these have a variant with the double underscores kept. The variants +without the double underscores are preferred for clarity.

    +

    The functions fall into categories that perform object comparisons, logical +operations, mathematical operations and sequence operations.

    +

    The object comparison functions are useful for all objects, and are named after +the rich comparison operators they support:

    +
    +
    +operator.lt(a, b)
    +
    +operator.le(a, b)
    +
    +operator.eq(a, b)
    +
    +operator.ne(a, b)
    +
    +operator.ge(a, b)
    +
    +operator.gt(a, b)
    +
    +operator.__lt__(a, b)
    +
    +operator.__le__(a, b)
    +
    +operator.__eq__(a, b)
    +
    +operator.__ne__(a, b)
    +
    +operator.__ge__(a, b)
    +
    +operator.__gt__(a, b)
    +

    Perform “rich comparisons” between a and b. Specifically, lt(a, b) is +equivalent to a < b, le(a, b) is equivalent to a <= b, eq(a, +b) is equivalent to a == b, ne(a, b) is equivalent to a != b, +gt(a, b) is equivalent to a > b and ge(a, b) is equivalent to a +>= b. Note that these functions can return any value, which may +or may not be interpretable as a Boolean value. See +Comparisons for more information about rich comparisons.

    +
    + +

    The logical operations are also generally applicable to all objects, and support +truth tests, identity tests, and boolean operations:

    +
    +
    +operator.not_(obj)
    +
    +operator.__not__(obj)
    +

    Return the outcome of not obj. (Note that there is no +__not__() method for object instances; only the interpreter core defines +this operation. The result is affected by the __bool__() and +__len__() methods.)

    +
    + +
    +
    +operator.truth(obj)
    +

    Return True if obj is true, and False otherwise. This is +equivalent to using the bool constructor.

    +
    + +
    +
    +operator.is_(a, b)
    +

    Return a is b. Tests object identity.

    +
    + +
    +
    +operator.is_not(a, b)
    +

    Return a is not b. Tests object identity.

    +
    + +

    The mathematical and bitwise operations are the most numerous:

    +
    +
    +operator.abs(obj)
    +
    +operator.__abs__(obj)
    +

    Return the absolute value of obj.

    +
    + +
    +
    +operator.add(a, b)
    +
    +operator.__add__(a, b)
    +

    Return a + b, for a and b numbers.

    +
    + +
    +
    +operator.and_(a, b)
    +
    +operator.__and__(a, b)
    +

    Return the bitwise and of a and b.

    +
    + +
    +
    +operator.floordiv(a, b)
    +
    +operator.__floordiv__(a, b)
    +

    Return a // b.

    +
    + +
    +
    +operator.index(a)
    +
    +operator.__index__(a)
    +

    Return a converted to an integer. Equivalent to a.__index__().

    +
    + +
    +
    +operator.inv(obj)
    +
    +operator.invert(obj)
    +
    +operator.__inv__(obj)
    +
    +operator.__invert__(obj)
    +

    Return the bitwise inverse of the number obj. This is equivalent to ~obj.

    +
    + +
    +
    +operator.lshift(a, b)
    +
    +operator.__lshift__(a, b)
    +

    Return a shifted left by b.

    +
    + +
    +
    +operator.mod(a, b)
    +
    +operator.__mod__(a, b)
    +

    Return a % b.

    +
    + +
    +
    +operator.mul(a, b)
    +
    +operator.__mul__(a, b)
    +

    Return a * b, for a and b numbers.

    +
    + +
    +
    +operator.matmul(a, b)
    +
    +operator.__matmul__(a, b)
    +

    Return a @ b.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +operator.neg(obj)
    +
    +operator.__neg__(obj)
    +

    Return obj negated (-obj).

    +
    + +
    +
    +operator.or_(a, b)
    +
    +operator.__or__(a, b)
    +

    Return the bitwise or of a and b.

    +
    + +
    +
    +operator.pos(obj)
    +
    +operator.__pos__(obj)
    +

    Return obj positive (+obj).

    +
    + +
    +
    +operator.pow(a, b)
    +
    +operator.__pow__(a, b)
    +

    Return a ** b, for a and b numbers.

    +
    + +
    +
    +operator.rshift(a, b)
    +
    +operator.__rshift__(a, b)
    +

    Return a shifted right by b.

    +
    + +
    +
    +operator.sub(a, b)
    +
    +operator.__sub__(a, b)
    +

    Return a - b.

    +
    + +
    +
    +operator.truediv(a, b)
    +
    +operator.__truediv__(a, b)
    +

    Return a / b where 2/3 is .66 rather than 0. This is also known as +“true” division.

    +
    + +
    +
    +operator.xor(a, b)
    +
    +operator.__xor__(a, b)
    +

    Return the bitwise exclusive or of a and b.

    +
    + +

    Operations which work with sequences (some of them with mappings too) include:

    +
    +
    +operator.concat(a, b)
    +
    +operator.__concat__(a, b)
    +

    Return a + b for a and b sequences.

    +
    + +
    +
    +operator.contains(a, b)
    +
    +operator.__contains__(a, b)
    +

    Return the outcome of the test b in a. Note the reversed operands.

    +
    + +
    +
    +operator.countOf(a, b)
    +

    Return the number of occurrences of b in a.

    +
    + +
    +
    +operator.delitem(a, b)
    +
    +operator.__delitem__(a, b)
    +

    Remove the value of a at index b.

    +
    + +
    +
    +operator.getitem(a, b)
    +
    +operator.__getitem__(a, b)
    +

    Return the value of a at index b.

    +
    + +
    +
    +operator.indexOf(a, b)
    +

    Return the index of the first of occurrence of b in a.

    +
    + +
    +
    +operator.setitem(a, b, c)
    +
    +operator.__setitem__(a, b, c)
    +

    Set the value of a at index b to c.

    +
    + +
    +
    +operator.length_hint(obj, default=0)
    +

    Return an estimated length for the object o. First try to return its +actual length, then an estimate using object.__length_hint__(), and +finally return the default value.

    +
    +

    New in version 3.4.

    +
    +
    + +

    The operator module also defines tools for generalized attribute and item +lookups. These are useful for making fast field extractors as arguments for +map(), sorted(), itertools.groupby(), or other functions that +expect a function argument.

    +
    +
    +operator.attrgetter(attr)
    +
    +operator.attrgetter(*attrs)
    +

    Return a callable object that fetches attr from its operand. +If more than one attribute is requested, returns a tuple of attributes. +The attribute names can also contain dots. For example:

    +
      +
    • After f = attrgetter('name'), the call f(b) returns b.name.

    • +
    • After f = attrgetter('name', 'date'), the call f(b) returns +(b.name, b.date).

    • +
    • After f = attrgetter('name.first', 'name.last'), the call f(b) +returns (b.name.first, b.name.last).

    • +
    +

    Equivalent to:

    +
    def attrgetter(*items):
    +    if any(not isinstance(item, str) for item in items):
    +        raise TypeError('attribute name must be a string')
    +    if len(items) == 1:
    +        attr = items[0]
    +        def g(obj):
    +            return resolve_attr(obj, attr)
    +    else:
    +        def g(obj):
    +            return tuple(resolve_attr(obj, attr) for attr in items)
    +    return g
    +
    +def resolve_attr(obj, attr):
    +    for name in attr.split("."):
    +        obj = getattr(obj, name)
    +    return obj
    +
    +
    +
    + +
    +
    +operator.itemgetter(item)
    +
    +operator.itemgetter(*items)
    +

    Return a callable object that fetches item from its operand using the +operand’s __getitem__() method. If multiple items are specified, +returns a tuple of lookup values. For example:

    +
      +
    • After f = itemgetter(2), the call f(r) returns r[2].

    • +
    • After g = itemgetter(2, 5, 3), the call g(r) returns +(r[2], r[5], r[3]).

    • +
    +

    Equivalent to:

    +
    def itemgetter(*items):
    +    if len(items) == 1:
    +        item = items[0]
    +        def g(obj):
    +            return obj[item]
    +    else:
    +        def g(obj):
    +            return tuple(obj[item] for item in items)
    +    return g
    +
    +
    +

    The items can be any type accepted by the operand’s __getitem__() +method. Dictionaries accept any hashable value. Lists, tuples, and +strings accept an index or a slice:

    +
    >>> itemgetter(1)('ABCDEFG')
    +'B'
    +>>> itemgetter(1,3,5)('ABCDEFG')
    +('B', 'D', 'F')
    +>>> itemgetter(slice(2,None))('ABCDEFG')
    +'CDEFG'
    +
    +
    +
    >>> soldier = dict(rank='captain', name='dotterbart')
    +>>> itemgetter('rank')(soldier)
    +'captain'
    +
    +
    +

    Example of using itemgetter() to retrieve specific fields from a +tuple record:

    +
    >>> inventory = [('apple', 3), ('banana', 2), ('pear', 5), ('orange', 1)]
    +>>> getcount = itemgetter(1)
    +>>> list(map(getcount, inventory))
    +[3, 2, 5, 1]
    +>>> sorted(inventory, key=getcount)
    +[('orange', 1), ('banana', 2), ('apple', 3), ('pear', 5)]
    +
    +
    +
    + +
    +
    +operator.methodcaller(name[, args...])
    +

    Return a callable object that calls the method name on its operand. If +additional arguments and/or keyword arguments are given, they will be given +to the method as well. For example:

    +
      +
    • After f = methodcaller('name'), the call f(b) returns b.name().

    • +
    • After f = methodcaller('name', 'foo', bar=1), the call f(b) +returns b.name('foo', bar=1).

    • +
    +

    Equivalent to:

    +
    def methodcaller(name, *args, **kwargs):
    +    def caller(obj):
    +        return getattr(obj, name)(*args, **kwargs)
    +    return caller
    +
    +
    +
    + +
    +

    Mapping Operators to Functions

    +

    This table shows how abstract operations correspond to operator symbols in the +Python syntax and the functions in the operator module.

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Operation

    Syntax

    Function

    Addition

    a + b

    add(a, b)

    Concatenation

    seq1 + seq2

    concat(seq1, seq2)

    Containment Test

    obj in seq

    contains(seq, obj)

    Division

    a / b

    truediv(a, b)

    Division

    a // b

    floordiv(a, b)

    Bitwise And

    a & b

    and_(a, b)

    Bitwise Exclusive Or

    a ^ b

    xor(a, b)

    Bitwise Inversion

    ~ a

    invert(a)

    Bitwise Or

    a | b

    or_(a, b)

    Exponentiation

    a ** b

    pow(a, b)

    Identity

    a is b

    is_(a, b)

    Identity

    a is not b

    is_not(a, b)

    Indexed Assignment

    obj[k] = v

    setitem(obj, k, v)

    Indexed Deletion

    del obj[k]

    delitem(obj, k)

    Indexing

    obj[k]

    getitem(obj, k)

    Left Shift

    a << b

    lshift(a, b)

    Modulo

    a % b

    mod(a, b)

    Multiplication

    a * b

    mul(a, b)

    Matrix Multiplication

    a @ b

    matmul(a, b)

    Negation (Arithmetic)

    - a

    neg(a)

    Negation (Logical)

    not a

    not_(a)

    Positive

    + a

    pos(a)

    Right Shift

    a >> b

    rshift(a, b)

    Slice Assignment

    seq[i:j] = values

    setitem(seq, slice(i, j), values)

    Slice Deletion

    del seq[i:j]

    delitem(seq, slice(i, j))

    Slicing

    seq[i:j]

    getitem(seq, slice(i, j))

    String Formatting

    s % obj

    mod(s, obj)

    Subtraction

    a - b

    sub(a, b)

    Truth Test

    obj

    truth(obj)

    Ordering

    a < b

    lt(a, b)

    Ordering

    a <= b

    le(a, b)

    Equality

    a == b

    eq(a, b)

    Difference

    a != b

    ne(a, b)

    Ordering

    a >= b

    ge(a, b)

    Ordering

    a > b

    gt(a, b)

    +
    +
    +

    In-place Operators

    +

    Many operations have an “in-place” version. Listed below are functions +providing a more primitive access to in-place operators than the usual syntax +does; for example, the statement x += y is equivalent to +x = operator.iadd(x, y). Another way to put it is to say that +z = operator.iadd(x, y) is equivalent to the compound statement +z = x; z += y.

    +

    In those examples, note that when an in-place method is called, the computation +and assignment are performed in two separate steps. The in-place functions +listed below only do the first step, calling the in-place method. The second +step, assignment, is not handled.

    +

    For immutable targets such as strings, numbers, and tuples, the updated +value is computed, but not assigned back to the input variable:

    +
    >>> a = 'hello'
    +>>> iadd(a, ' world')
    +'hello world'
    +>>> a
    +'hello'
    +
    +
    +

    For mutable targets such as lists and dictionaries, the in-place method +will perform the update, so no subsequent assignment is necessary:

    +
    >>> s = ['h', 'e', 'l', 'l', 'o']
    +>>> iadd(s, [' ', 'w', 'o', 'r', 'l', 'd'])
    +['h', 'e', 'l', 'l', 'o', ' ', 'w', 'o', 'r', 'l', 'd']
    +>>> s
    +['h', 'e', 'l', 'l', 'o', ' ', 'w', 'o', 'r', 'l', 'd']
    +
    +
    +
    +
    +operator.iadd(a, b)
    +
    +operator.__iadd__(a, b)
    +

    a = iadd(a, b) is equivalent to a += b.

    +
    + +
    +
    +operator.iand(a, b)
    +
    +operator.__iand__(a, b)
    +

    a = iand(a, b) is equivalent to a &= b.

    +
    + +
    +
    +operator.iconcat(a, b)
    +
    +operator.__iconcat__(a, b)
    +

    a = iconcat(a, b) is equivalent to a += b for a and b sequences.

    +
    + +
    +
    +operator.ifloordiv(a, b)
    +
    +operator.__ifloordiv__(a, b)
    +

    a = ifloordiv(a, b) is equivalent to a //= b.

    +
    + +
    +
    +operator.ilshift(a, b)
    +
    +operator.__ilshift__(a, b)
    +

    a = ilshift(a, b) is equivalent to a <<= b.

    +
    + +
    +
    +operator.imod(a, b)
    +
    +operator.__imod__(a, b)
    +

    a = imod(a, b) is equivalent to a %= b.

    +
    + +
    +
    +operator.imul(a, b)
    +
    +operator.__imul__(a, b)
    +

    a = imul(a, b) is equivalent to a *= b.

    +
    + +
    +
    +operator.imatmul(a, b)
    +
    +operator.__imatmul__(a, b)
    +

    a = imatmul(a, b) is equivalent to a @= b.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +operator.ior(a, b)
    +
    +operator.__ior__(a, b)
    +

    a = ior(a, b) is equivalent to a |= b.

    +
    + +
    +
    +operator.ipow(a, b)
    +
    +operator.__ipow__(a, b)
    +

    a = ipow(a, b) is equivalent to a **= b.

    +
    + +
    +
    +operator.irshift(a, b)
    +
    +operator.__irshift__(a, b)
    +

    a = irshift(a, b) is equivalent to a >>= b.

    +
    + +
    +
    +operator.isub(a, b)
    +
    +operator.__isub__(a, b)
    +

    a = isub(a, b) is equivalent to a -= b.

    +
    + +
    +
    +operator.itruediv(a, b)
    +
    +operator.__itruediv__(a, b)
    +

    a = itruediv(a, b) is equivalent to a /= b.

    +
    + +
    +
    +operator.ixor(a, b)
    +
    +operator.__ixor__(a, b)
    +

    a = ixor(a, b) is equivalent to a ^= b.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/optparse.html b/python-3.7.4-docs-html/library/optparse.html new file mode 100644 index 0000000..b4418c0 --- /dev/null +++ b/python-3.7.4-docs-html/library/optparse.html @@ -0,0 +1,2047 @@ + + + + + + + optparse — Parser for command line options — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    optparse — Parser for command line options

    +

    Source code: Lib/optparse.py

    +
    +

    Deprecated since version 3.2: The optparse module is deprecated and will not be developed further; +development will continue with the argparse module.

    +
    +
    +

    optparse is a more convenient, flexible, and powerful library for parsing +command-line options than the old getopt module. optparse uses a +more declarative style of command-line parsing: you create an instance of +OptionParser, populate it with options, and parse the command +line. optparse allows users to specify options in the conventional +GNU/POSIX syntax, and additionally generates usage and help messages for you.

    +

    Here’s an example of using 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")
    +parser.add_option("-q", "--quiet",
    +                  action="store_false", dest="verbose", default=True,
    +                  help="don't print status messages to stdout")
    +
    +(options, args) = parser.parse_args()
    +
    +
    +

    With these few lines of code, users of your script can now do the “usual thing” +on the command-line, for example:

    +
    <yourscript> --file=outfile -q
    +
    +
    +

    As it parses the command line, optparse sets attributes of the +options object returned by parse_args() based on user-supplied +command-line values. When parse_args() returns from parsing this command +line, options.filename will be "outfile" and options.verbose will be +False. optparse supports both long and short options, allows short +options to be merged together, and allows options to be associated with their +arguments in a variety of ways. Thus, the following command lines are all +equivalent to the above example:

    +
    <yourscript> -f outfile --quiet
    +<yourscript> --quiet --file outfile
    +<yourscript> -q -foutfile
    +<yourscript> -qfoutfile
    +
    +
    +

    Additionally, users can run one of

    +
    <yourscript> -h
    +<yourscript> --help
    +
    +
    +

    and optparse will print out a brief summary of your script’s options:

    +
    Usage: <yourscript> [options]
    +
    +Options:
    +  -h, --help            show this help message and exit
    +  -f FILE, --file=FILE  write report to FILE
    +  -q, --quiet           don't print status messages to stdout
    +
    +
    +

    where the value of yourscript is determined at runtime (normally from +sys.argv[0]).

    +
    +

    Background

    +

    optparse was explicitly designed to encourage the creation of programs +with straightforward, conventional command-line interfaces. To that end, it +supports only the most common command-line syntax and semantics conventionally +used under Unix. If you are unfamiliar with these conventions, read this +section to acquaint yourself with them.

    +
    +

    Terminology

    +
    +
    argument

    a string entered on the command-line, and passed by the shell to execl() +or execv(). In Python, arguments are elements of sys.argv[1:] +(sys.argv[0] is the name of the program being executed). Unix shells +also use the term “word”.

    +

    It is occasionally desirable to substitute an argument list other than +sys.argv[1:], so you should read “argument” as “an element of +sys.argv[1:], or of some other list provided as a substitute for +sys.argv[1:]”.

    +
    +
    option

    an argument used to supply extra information to guide or customize the +execution of a program. There are many different syntaxes for options; the +traditional Unix syntax is a hyphen (“-“) followed by a single letter, +e.g. -x or -F. Also, traditional Unix syntax allows multiple +options to be merged into a single argument, e.g. -x -F is equivalent +to -xF. The GNU project introduced -- followed by a series of +hyphen-separated words, e.g. --file or --dry-run. These are the +only two option syntaxes provided by optparse.

    +

    Some other option syntaxes that the world has seen include:

    +
      +
    • a hyphen followed by a few letters, e.g. -pf (this is not the same +as multiple options merged into a single argument)

    • +
    • a hyphen followed by a whole word, e.g. -file (this is technically +equivalent to the previous syntax, but they aren’t usually seen in the same +program)

    • +
    • a plus sign followed by a single letter, or a few letters, or a word, e.g. ++f, +rgb

    • +
    • a slash followed by a letter, or a few letters, or a word, e.g. /f, +/file

    • +
    +

    These option syntaxes are not supported by optparse, and they never +will be. This is deliberate: the first three are non-standard on any +environment, and the last only makes sense if you’re exclusively targeting +VMS, MS-DOS, and/or Windows.

    +
    +
    option argument

    an argument that follows an option, is closely associated with that option, +and is consumed from the argument list when that option is. With +optparse, option arguments may either be in a separate argument from +their option:

    +
    -f foo
    +--file foo
    +
    +
    +

    or included in the same argument:

    +
    -ffoo
    +--file=foo
    +
    +
    +

    Typically, a given option either takes an argument or it doesn’t. Lots of +people want an “optional option arguments” feature, meaning that some options +will take an argument if they see it, and won’t if they don’t. This is +somewhat controversial, because it makes parsing ambiguous: if -a takes +an optional argument and -b is another option entirely, how do we +interpret -ab? Because of this ambiguity, optparse does not +support this feature.

    +
    +
    positional argument

    something leftover in the argument list after options have been parsed, i.e. +after options and their arguments have been parsed and removed from the +argument list.

    +
    +
    required option

    an option that must be supplied on the command-line; note that the phrase +“required option” is self-contradictory in English. optparse doesn’t +prevent you from implementing required options, but doesn’t give you much +help at it either.

    +
    +
    +

    For example, consider this hypothetical command-line:

    +
    prog -v --report report.txt foo bar
    +
    +
    +

    -v and --report are both options. Assuming that --report +takes one argument, report.txt is an option argument. foo and +bar are positional arguments.

    +
    +
    +

    What are options for?

    +

    Options are used to provide extra information to tune or customize the execution +of a program. In case it wasn’t clear, options are usually optional. A +program should be able to run just fine with no options whatsoever. (Pick a +random program from the Unix or GNU toolsets. Can it run without any options at +all and still make sense? The main exceptions are find, tar, and +dd—all of which are mutant oddballs that have been rightly criticized +for their non-standard syntax and confusing interfaces.)

    +

    Lots of people want their programs to have “required options”. Think about it. +If it’s required, then it’s not optional! If there is a piece of information +that your program absolutely requires in order to run successfully, that’s what +positional arguments are for.

    +

    As an example of good command-line interface design, consider the humble cp +utility, for copying files. It doesn’t make much sense to try to copy files +without supplying a destination and at least one source. Hence, cp fails if +you run it with no arguments. However, it has a flexible, useful syntax that +does not require any options at all:

    +
    cp SOURCE DEST
    +cp SOURCE ... DEST-DIR
    +
    +
    +

    You can get pretty far with just that. Most cp implementations provide a +bunch of options to tweak exactly how the files are copied: you can preserve +mode and modification time, avoid following symlinks, ask before clobbering +existing files, etc. But none of this distracts from the core mission of +cp, which is to copy either one file to another, or several files to another +directory.

    +
    +
    +

    What are positional arguments for?

    +

    Positional arguments are for those pieces of information that your program +absolutely, positively requires to run.

    +

    A good user interface should have as few absolute requirements as possible. If +your program requires 17 distinct pieces of information in order to run +successfully, it doesn’t much matter how you get that information from the +user—most people will give up and walk away before they successfully run the +program. This applies whether the user interface is a command-line, a +configuration file, or a GUI: if you make that many demands on your users, most +of them will simply give up.

    +

    In short, try to minimize the amount of information that users are absolutely +required to supply—use sensible defaults whenever possible. Of course, you +also want to make your programs reasonably flexible. That’s what options are +for. Again, it doesn’t matter if they are entries in a config file, widgets in +the “Preferences” dialog of a GUI, or command-line options—the more options +you implement, the more flexible your program is, and the more complicated its +implementation becomes. Too much flexibility has drawbacks as well, of course; +too many options can overwhelm users and make your code much harder to maintain.

    +
    +
    +
    +

    Tutorial

    +

    While optparse is quite flexible and powerful, it’s also straightforward +to use in most cases. This section covers the code patterns that are common to +any optparse-based program.

    +

    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:

    +
    parser.add_option(opt_str, ...,
    +                  attr=value, ...)
    +
    +
    +

    Each option has one or more option strings, such as -f or --file, +and several option attributes that tell optparse what to expect and what +to do when it encounters that option on the command line.

    +

    Typically, each option will have one short option string and one long option +string, e.g.:

    +
    parser.add_option("-f", "--file", ...)
    +
    +
    +

    You’re free to define as many short option strings and as many long option +strings as you like (including zero), as long as there is at least one option +string overall.

    +

    The option strings passed to OptionParser.add_option() are effectively +labels for the +option defined by that call. For brevity, we will frequently refer to +encountering an option on the command line; in reality, optparse +encounters option strings and looks up options from them.

    +

    Once all of your options are defined, instruct optparse to parse your +program’s command line:

    +
    (options, args) = parser.parse_args()
    +
    +
    +

    (If you like, you can pass a custom argument list to parse_args(), but +that’s rarely necessary: by default it uses sys.argv[1:].)

    +

    parse_args() returns two values:

    +
      +
    • options, an object containing values for all of your options—e.g. if +--file takes a single string argument, then options.file will be the +filename supplied by the user, or None if the user did not supply that +option

    • +
    • args, the list of positional arguments leftover after parsing options

    • +
    +

    This tutorial section only covers the four most important option attributes: +action, type, dest +(destination), and help. Of these, action is the +most fundamental.

    +
    +

    Understanding option actions

    +

    Actions tell optparse what to do when it encounters an option on the +command line. There is a fixed set of actions hard-coded into optparse; +adding new actions is an advanced topic covered in section +Extending optparse. Most actions tell optparse to store +a value in some variable—for example, take a string from the command line and +store it in an attribute of options.

    +

    If you don’t specify an option action, optparse defaults to store.

    +
    +
    +

    The store action

    +

    The most common option action is store, which tells optparse to take +the next argument (or the remainder of the current argument), ensure that it is +of the correct type, and store it to your chosen destination.

    +

    For example:

    +
    parser.add_option("-f", "--file",
    +                  action="store", type="string", dest="filename")
    +
    +
    +

    Now let’s make up a fake command line and ask optparse to parse it:

    +
    args = ["-f", "foo.txt"]
    +(options, args) = parser.parse_args(args)
    +
    +
    +

    When optparse sees the option string -f, it consumes the next +argument, foo.txt, and stores it in options.filename. So, after this +call to parse_args(), options.filename is "foo.txt".

    +

    Some other option types supported by optparse are int and float. +Here’s an option that expects an integer argument:

    +
    parser.add_option("-n", type="int", dest="num")
    +
    +
    +

    Note that this option has no long option string, which is perfectly acceptable. +Also, there’s no explicit action, since the default is store.

    +

    Let’s parse another fake command-line. This time, we’ll jam the option argument +right up against the option: since -n42 (one argument) is equivalent to +-n 42 (two arguments), the code

    +
    (options, args) = parser.parse_args(["-n42"])
    +print(options.num)
    +
    +
    +

    will print 42.

    +

    If you don’t specify a type, optparse assumes string. Combined with +the fact that the default action is store, that means our first example can +be a lot shorter:

    +
    parser.add_option("-f", "--file", dest="filename")
    +
    +
    +

    If you don’t supply a destination, optparse figures out a sensible +default from the option strings: if the first long option string is +--foo-bar, then the default destination is foo_bar. If there are no +long option strings, optparse looks at the first short option string: the +default destination for -f is f.

    +

    optparse also includes the built-in complex type. Adding +types is covered in section Extending optparse.

    +
    +
    +

    Handling boolean (flag) options

    +

    Flag options—set a variable to true or false when a particular option is +seen—are quite common. optparse supports them with two separate actions, +store_true and store_false. For example, you might have a verbose +flag that is turned on with -v and off with -q:

    +
    parser.add_option("-v", action="store_true", dest="verbose")
    +parser.add_option("-q", action="store_false", dest="verbose")
    +
    +
    +

    Here we have two different options with the same destination, which is perfectly +OK. (It just means you have to be a bit careful when setting default +values—see below.)

    +

    When optparse encounters -v on the command line, it sets +options.verbose to True; when it encounters -q, +options.verbose is set to False.

    +
    +
    +

    Other actions

    +

    Some other actions supported by optparse are:

    +
    +
    "store_const"

    store a constant value

    +
    +
    "append"

    append this option’s argument to a list

    +
    +
    "count"

    increment a counter by one

    +
    +
    "callback"

    call a specified function

    +
    +
    +

    These are covered in section Reference Guide, Reference Guide +and section Option Callbacks.

    +
    +
    +

    Default values

    +

    All of the above examples involve setting some variable (the “destination”) when +certain command-line options are seen. What happens if those options are never +seen? Since we didn’t supply any defaults, they are all set to None. This +is usually fine, but sometimes you want more control. optparse lets you +supply a default value for each destination, which is assigned before the +command line is parsed.

    +

    First, consider the verbose/quiet example. If we want optparse to set +verbose to True unless -q is seen, then we can do this:

    +
    parser.add_option("-v", action="store_true", dest="verbose", default=True)
    +parser.add_option("-q", action="store_false", dest="verbose")
    +
    +
    +

    Since default values apply to the destination rather than to any particular +option, and these two options happen to have the same destination, this is +exactly equivalent:

    +
    parser.add_option("-v", action="store_true", dest="verbose")
    +parser.add_option("-q", action="store_false", dest="verbose", default=True)
    +
    +
    +

    Consider this:

    +
    parser.add_option("-v", action="store_true", dest="verbose", default=False)
    +parser.add_option("-q", action="store_false", dest="verbose", default=True)
    +
    +
    +

    Again, the default value for verbose will be True: the last default +value supplied for any particular destination is the one that counts.

    +

    A clearer way to specify default values is the set_defaults() method of +OptionParser, which you can call at any time before calling parse_args():

    +
    parser.set_defaults(verbose=True)
    +parser.add_option(...)
    +(options, args) = parser.parse_args()
    +
    +
    +

    As before, the last value specified for a given option destination is the one +that counts. For clarity, try to use one method or the other of setting default +values, not both.

    +
    +
    +

    Generating help

    +

    optparse’s ability to generate help and usage text automatically is +useful for creating user-friendly command-line interfaces. All you have to do +is supply a help value for each option, and optionally a short +usage message for your whole program. Here’s an OptionParser populated with +user-friendly (documented) options:

    +
    usage = "usage: %prog [options] arg1 arg2"
    +parser = OptionParser(usage=usage)
    +parser.add_option("-v", "--verbose",
    +                  action="store_true", dest="verbose", default=True,
    +                  help="make lots of noise [default]")
    +parser.add_option("-q", "--quiet",
    +                  action="store_false", dest="verbose",
    +                  help="be vewwy quiet (I'm hunting wabbits)")
    +parser.add_option("-f", "--filename",
    +                  metavar="FILE", help="write output to FILE")
    +parser.add_option("-m", "--mode",
    +                  default="intermediate",
    +                  help="interaction mode: novice, intermediate, "
    +                       "or expert [default: %default]")
    +
    +
    +

    If optparse encounters either -h or --help on the +command-line, or if you just call parser.print_help(), it prints the +following to standard output:

    +
    Usage: <yourscript> [options] arg1 arg2
    +
    +Options:
    +  -h, --help            show this help message and exit
    +  -v, --verbose         make lots of noise [default]
    +  -q, --quiet           be vewwy quiet (I'm hunting wabbits)
    +  -f FILE, --filename=FILE
    +                        write output to FILE
    +  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or
    +                        expert [default: intermediate]
    +
    +
    +

    (If the help output is triggered by a help option, optparse exits after +printing the help text.)

    +

    There’s a lot going on here to help optparse generate the best possible +help message:

    +
      +
    • the script defines its own usage message:

      +
      usage = "usage: %prog [options] arg1 arg2"
      +
      +
      +

      optparse expands %prog in the usage string to the name of the +current program, i.e. os.path.basename(sys.argv[0]). The expanded string +is then printed before the detailed option help.

      +

      If you don’t supply a usage string, optparse uses a bland but sensible +default: "Usage: %prog [options]", which is fine if your script doesn’t +take any positional arguments.

      +
    • +
    • every option defines a help string, and doesn’t worry about +line-wrapping—optparse takes care of wrapping lines and making +the help output look good.

    • +
    • options that take a value indicate this fact in their automatically-generated +help message, e.g. for the “mode” option:

      +
      -m MODE, --mode=MODE
      +
      +
      +

      Here, “MODE” is called the meta-variable: it stands for the argument that the +user is expected to supply to -m/--mode. By default, +optparse converts the destination variable name to uppercase and uses +that for the meta-variable. Sometimes, that’s not what you want—for +example, the --filename option explicitly sets metavar="FILE", +resulting in this automatically-generated option description:

      +
      -f FILE, --filename=FILE
      +
      +
      +

      This is important for more than just saving space, though: the manually +written help text uses the meta-variable FILE to clue the user in that +there’s a connection between the semi-formal syntax -f FILE and the informal +semantic description “write output to FILE”. This is a simple but effective +way to make your help text a lot clearer and more useful for end users.

      +
    • +
    • options that have a default value can include %default in the help +string—optparse will replace it with str() of the option’s +default value. If an option has no default value (or the default value is +None), %default expands to none.

    • +
    +
    +

    Grouping Options

    +

    When dealing with many options, it is convenient to group these options for +better help output. An OptionParser can contain several option groups, +each of which can contain several options.

    +

    An option group is obtained using the class OptionGroup:

    +
    +
    +class optparse.OptionGroup(parser, title, description=None)
    +

    where

    +
      +
    • parser is the OptionParser instance the group will be inserted in +to

    • +
    • title is the group title

    • +
    • description, optional, is a long description of the group

    • +
    +
    + +

    OptionGroup inherits from OptionContainer (like +OptionParser) and so the add_option() method can be used to add +an option to the group.

    +

    Once all the options are declared, using the OptionParser method +add_option_group() the group is added to the previously defined parser.

    +

    Continuing with the parser defined in the previous section, adding an +OptionGroup to a parser is easy:

    +
    group = OptionGroup(parser, "Dangerous Options",
    +                    "Caution: use these options at your own risk.  "
    +                    "It is believed that some of them bite.")
    +group.add_option("-g", action="store_true", help="Group option.")
    +parser.add_option_group(group)
    +
    +
    +

    This would result in the following help output:

    +
    Usage: <yourscript> [options] arg1 arg2
    +
    +Options:
    +  -h, --help            show this help message and exit
    +  -v, --verbose         make lots of noise [default]
    +  -q, --quiet           be vewwy quiet (I'm hunting wabbits)
    +  -f FILE, --filename=FILE
    +                        write output to FILE
    +  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or
    +                        expert [default: intermediate]
    +
    +  Dangerous Options:
    +    Caution: use these options at your own risk.  It is believed that some
    +    of them bite.
    +
    +    -g                  Group option.
    +
    +
    +

    A bit more complete example might involve using more than one group: still +extending the previous example:

    +
    group = OptionGroup(parser, "Dangerous Options",
    +                    "Caution: use these options at your own risk.  "
    +                    "It is believed that some of them bite.")
    +group.add_option("-g", action="store_true", help="Group option.")
    +parser.add_option_group(group)
    +
    +group = OptionGroup(parser, "Debug Options")
    +group.add_option("-d", "--debug", action="store_true",
    +                 help="Print debug information")
    +group.add_option("-s", "--sql", action="store_true",
    +                 help="Print all SQL statements executed")
    +group.add_option("-e", action="store_true", help="Print every action done")
    +parser.add_option_group(group)
    +
    +
    +

    that results in the following output:

    +
    Usage: <yourscript> [options] arg1 arg2
    +
    +Options:
    +  -h, --help            show this help message and exit
    +  -v, --verbose         make lots of noise [default]
    +  -q, --quiet           be vewwy quiet (I'm hunting wabbits)
    +  -f FILE, --filename=FILE
    +                        write output to FILE
    +  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or expert
    +                        [default: intermediate]
    +
    +  Dangerous Options:
    +    Caution: use these options at your own risk.  It is believed that some
    +    of them bite.
    +
    +    -g                  Group option.
    +
    +  Debug Options:
    +    -d, --debug         Print debug information
    +    -s, --sql           Print all SQL statements executed
    +    -e                  Print every action done
    +
    +
    +

    Another interesting method, in particular when working programmatically with +option groups is:

    +
    +
    +OptionParser.get_option_group(opt_str)
    +

    Return the OptionGroup to which the short or long option +string opt_str (e.g. '-o' or '--option') belongs. If +there’s no such OptionGroup, return None.

    +
    + +
    +
    +
    +

    Printing a version string

    +

    Similar to the brief usage string, optparse can also print a version +string for your program. You have to supply the string as the version +argument to OptionParser:

    +
    parser = OptionParser(usage="%prog [-f] [-q]", version="%prog 1.0")
    +
    +
    +

    %prog is expanded just like it is in usage. Apart from that, +version can contain anything you like. When you supply it, optparse +automatically adds a --version option to your parser. If it encounters +this option on the command line, it expands your version string (by +replacing %prog), prints it to stdout, and exits.

    +

    For example, if your script is called /usr/bin/foo:

    +
    $ /usr/bin/foo --version
    +foo 1.0
    +
    +
    +

    The following two methods can be used to print and get the version string:

    +
    +
    +OptionParser.print_version(file=None)
    +

    Print the version message for the current program (self.version) to +file (default stdout). As with print_usage(), any occurrence +of %prog in self.version is replaced with the name of the current +program. Does nothing if self.version is empty or undefined.

    +
    + +
    +
    +OptionParser.get_version()
    +

    Same as print_version() but returns the version string instead of +printing it.

    +
    + +
    +
    +

    How optparse handles errors

    +

    There are two broad classes of errors that optparse has to worry about: +programmer errors and user errors. Programmer errors are usually erroneous +calls to OptionParser.add_option(), e.g. invalid option strings, unknown +option attributes, missing option attributes, etc. These are dealt with in the +usual way: raise an exception (either optparse.OptionError or +TypeError) and let the program crash.

    +

    Handling user errors is much more important, since they are guaranteed to happen +no matter how stable your code is. optparse can automatically detect +some user errors, such as bad option arguments (passing -n 4x where +-n takes an integer argument), missing arguments (-n at the end +of the command line, where -n takes an argument of any type). Also, +you can call 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")
    +
    +
    +

    In either case, optparse handles the error the same way: it prints the +program’s usage message and an error message to standard error and exits with +error status 2.

    +

    Consider the first example above, where the user passes 4x to an option +that takes an integer:

    +
    $ /usr/bin/foo -n 4x
    +Usage: foo [options]
    +
    +foo: error: option -n: invalid integer value: '4x'
    +
    +
    +

    Or, where the user fails to pass a value at all:

    +
    $ /usr/bin/foo -n
    +Usage: foo [options]
    +
    +foo: error: -n option requires an argument
    +
    +
    +

    optparse-generated error messages take care always to mention the +option involved in the error; be sure to do the same when calling +OptionParser.error() from your application code.

    +

    If optparse’s default error-handling behaviour does not suit your needs, +you’ll need to subclass OptionParser and override its exit() +and/or error() methods.

    +
    +
    +

    Putting it all together

    +

    Here’s what optparse-based scripts usually look like:

    +
    from optparse import OptionParser
    +...
    +def main():
    +    usage = "usage: %prog [options] arg"
    +    parser = OptionParser(usage)
    +    parser.add_option("-f", "--file", dest="filename",
    +                      help="read data from FILENAME")
    +    parser.add_option("-v", "--verbose",
    +                      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()
    +
    +
    +
    +
    +
    +

    Reference Guide

    +
    +

    Creating the parser

    +

    The first step in using optparse is to create an OptionParser instance.

    +
    +
    +class optparse.OptionParser(...)
    +

    The OptionParser constructor has no required arguments, but a number of +optional keyword arguments. You should always pass them as keyword +arguments, i.e. do not rely on the order in which the arguments are declared.

    +
    +
    usage (default: "%prog [options]")

    The usage summary to print when your program is run incorrectly or with a +help option. When optparse prints the usage string, it expands +%prog to os.path.basename(sys.argv[0]) (or to prog if you +passed that keyword argument). To suppress a usage message, pass the +special value optparse.SUPPRESS_USAGE.

    +
    +
    option_list (default: [])

    A list of Option objects to populate the parser with. The options in +option_list are added after any options in standard_option_list (a +class attribute that may be set by OptionParser subclasses), but before +any version or help options. Deprecated; use add_option() after +creating the parser instead.

    +
    +
    option_class (default: optparse.Option)

    Class to use when adding options to the parser in add_option().

    +
    +
    version (default: None)

    A version string to print when the user supplies a version option. If you +supply a true value for version, optparse automatically adds a +version option with the single option string --version. The +substring %prog is expanded the same as for usage.

    +
    +
    conflict_handler (default: "error")

    Specifies what to do when options with conflicting option strings are +added to the parser; see section +Conflicts between options.

    +
    +
    description (default: None)

    A paragraph of text giving a brief overview of your program. +optparse reformats this paragraph to fit the current terminal width +and prints it when the user requests help (after usage, but before the +list of options).

    +
    +
    formatter (default: a new IndentedHelpFormatter)

    An instance of optparse.HelpFormatter that will be used for printing help +text. optparse provides two concrete classes for this purpose: +IndentedHelpFormatter and TitledHelpFormatter.

    +
    +
    add_help_option (default: True)

    If true, optparse will add a help option (with option strings -h +and --help) to the parser.

    +
    +
    prog

    The string to use when expanding %prog in usage and version +instead of os.path.basename(sys.argv[0]).

    +
    +
    epilog (default: None)

    A paragraph of help text to print after the option help.

    +
    +
    +
    + +
    +
    +

    Populating the parser

    +

    There are several ways to populate the parser with options. The preferred way +is by using OptionParser.add_option(), as shown in section +Tutorial. add_option() can be called in one of two ways:

    +
      +
    • pass it an Option instance (as returned by make_option())

    • +
    • pass it any combination of positional and keyword arguments that are +acceptable to make_option() (i.e., to the Option constructor), and it +will create the Option instance for you

    • +
    +

    The other alternative is to pass a list of pre-constructed Option instances to +the OptionParser constructor, as in:

    +
    option_list = [
    +    make_option("-f", "--filename",
    +                action="store", type="string", dest="filename"),
    +    make_option("-q", "--quiet",
    +                action="store_false", dest="verbose"),
    +    ]
    +parser = OptionParser(option_list=option_list)
    +
    +
    +

    (make_option() is a factory function for creating Option instances; +currently it is an alias for the Option constructor. A future version of +optparse may split Option into several classes, and make_option() +will pick the right class to instantiate. Do not instantiate Option directly.)

    +
    +
    +

    Defining options

    +

    Each Option instance represents a set of synonymous command-line option strings, +e.g. -f and --file. You can specify any number of short or +long option strings, but you must specify at least one overall option string.

    +

    The canonical way to create an Option instance is with the +add_option() method of OptionParser.

    +
    +
    +OptionParser.add_option(option)
    +
    +OptionParser.add_option(*opt_str, attr=value, ...)
    +

    To define an option with only a short option string:

    +
    parser.add_option("-f", attr=value, ...)
    +
    +
    +

    And to define an option with only a long option string:

    +
    parser.add_option("--foo", attr=value, ...)
    +
    +
    +

    The keyword arguments define attributes of the new Option object. The most +important option attribute is action, and it largely +determines which other attributes are relevant or required. If you pass +irrelevant option attributes, or fail to pass required ones, optparse +raises an OptionError exception explaining your mistake.

    +

    An option’s action determines what optparse does when it encounters +this option on the command-line. The standard option actions hard-coded into +optparse are:

    +
    +
    "store"

    store this option’s argument (default)

    +
    +
    "store_const"

    store a constant value

    +
    +
    "store_true"

    store a true value

    +
    +
    "store_false"

    store a false value

    +
    +
    "append"

    append this option’s argument to a list

    +
    +
    "append_const"

    append a constant value to a list

    +
    +
    "count"

    increment a counter by one

    +
    +
    "callback"

    call a specified function

    +
    +
    "help"

    print a usage message including all options and the documentation for them

    +
    +
    +

    (If you don’t supply an action, the default is "store". For this action, +you may also supply type and dest option +attributes; see Standard option actions.)

    +
    + +

    As you can see, most actions involve storing or updating a value somewhere. +optparse always creates a special object for this, conventionally called +options (it happens to be an instance of optparse.Values). Option +arguments (and various other values) are stored as attributes of this object, +according to the dest (destination) option attribute.

    +

    For example, when you call

    +
    parser.parse_args()
    +
    +
    +

    one of the first things optparse does is create the options object:

    +
    options = Values()
    +
    +
    +

    If one of the options in this parser is defined with

    +
    parser.add_option("-f", "--file", action="store", type="string", dest="filename")
    +
    +
    +

    and the command-line being parsed includes any of the following:

    +
    -ffoo
    +-f foo
    +--file=foo
    +--file foo
    +
    +
    +

    then optparse, on seeing this option, will do the equivalent of

    +
    options.filename = "foo"
    +
    +
    +

    The type and dest option attributes are almost +as important as action, but action is the only +one that makes sense for all options.

    +
    +
    +

    Option attributes

    +

    The following option attributes may be passed as keyword arguments to +OptionParser.add_option(). If you pass an option attribute that is not +relevant to a particular option, or fail to pass a required option attribute, +optparse raises OptionError.

    +
    +
    +Option.action
    +

    (default: "store")

    +

    Determines optparse’s behaviour when this option is seen on the +command line; the available options are documented here.

    +
    + +
    +
    +Option.type
    +

    (default: "string")

    +

    The argument type expected by this option (e.g., "string" or "int"); +the available option types are documented here.

    +
    + +
    +
    +Option.dest
    +

    (default: derived from option strings)

    +

    If the option’s action implies writing or modifying a value somewhere, this +tells optparse where to write it: dest names an +attribute of the options object that optparse builds as it parses +the command line.

    +
    + +
    +
    +Option.default
    +

    The value to use for this option’s destination if the option is not seen on +the command line. See also OptionParser.set_defaults().

    +
    + +
    +
    +Option.nargs
    +

    (default: 1)

    +

    How many arguments of type type should be consumed when this +option is seen. If > 1, optparse will store a tuple of values to +dest.

    +
    + +
    +
    +Option.const
    +

    For actions that store a constant value, the constant value to store.

    +
    + +
    +
    +Option.choices
    +

    For options of type "choice", the list of strings the user may choose +from.

    +
    + +
    +
    +Option.callback
    +

    For options with action "callback", the callable to call when this option +is seen. See section Option Callbacks for detail on the +arguments passed to the callable.

    +
    + +
    +
    +Option.callback_args
    +
    +Option.callback_kwargs
    +

    Additional positional and keyword arguments to pass to callback after the +four standard callback arguments.

    +
    + +
    +
    +Option.help
    +

    Help text to print for this option when listing all available options after +the user supplies a help option (such as --help). If +no help text is supplied, the option will be listed without help text. To +hide this option, use the special value optparse.SUPPRESS_HELP.

    +
    + +
    +
    +Option.metavar
    +

    (default: derived from option strings)

    +

    Stand-in for the option argument(s) to use when printing help text. See +section Tutorial for an example.

    +
    + +
    +
    +

    Standard option actions

    +

    The various option actions all have slightly different requirements and effects. +Most actions have several relevant option attributes which you may specify to +guide optparse’s behaviour; a few have required attributes, which you +must specify for any option using that action.

    +
      +
    • "store" [relevant: type, dest, +nargs, choices]

      +

      The option must be followed by an argument, which is converted to a value +according to type and stored in dest. If +nargs > 1, multiple arguments will be consumed from the +command line; all will be converted according to type and +stored to dest as a tuple. See the +Standard option types section.

      +

      If choices is supplied (a list or tuple of strings), the type +defaults to "choice".

      +

      If type is not supplied, it defaults to "string".

      +

      If dest is not supplied, optparse derives a destination +from the first long option string (e.g., --foo-bar implies +foo_bar). If there are no long option strings, optparse derives a +destination from the first short option string (e.g., -f implies f).

      +

      Example:

      +
      parser.add_option("-f")
      +parser.add_option("-p", type="float", nargs=3, dest="point")
      +
      +
      +

      As it parses the command line

      +
      -f foo.txt -p 1 -3.5 4 -fbar.txt
      +
      +
      +

      optparse will set

      +
      options.f = "foo.txt"
      +options.point = (1.0, -3.5, 4.0)
      +options.f = "bar.txt"
      +
      +
      +
    • +
    • "store_const" [required: const; relevant: +dest]

      +

      The value const is stored in dest.

      +

      Example:

      +
      parser.add_option("-q", "--quiet",
      +                  action="store_const", const=0, dest="verbose")
      +parser.add_option("-v", "--verbose",
      +                  action="store_const", const=1, dest="verbose")
      +parser.add_option("--noisy",
      +                  action="store_const", const=2, dest="verbose")
      +
      +
      +

      If --noisy is seen, optparse will set

      +
      options.verbose = 2
      +
      +
      +
    • +
    • "store_true" [relevant: dest]

      +

      A special case of "store_const" that stores a true value to +dest.

      +
    • +
    • "store_false" [relevant: dest]

      +

      Like "store_true", but stores a false value.

      +

      Example:

      +
      parser.add_option("--clobber", action="store_true", dest="clobber")
      +parser.add_option("--no-clobber", action="store_false", dest="clobber")
      +
      +
      +
    • +
    • "append" [relevant: type, dest, +nargs, choices]

      +

      The option must be followed by an argument, which is appended to the list in +dest. If no default value for dest is +supplied, an empty list is automatically created when optparse first +encounters this option on the command-line. If nargs > 1, +multiple arguments are consumed, and a tuple of length nargs +is appended to dest.

      +

      The defaults for type and dest are the same as +for the "store" action.

      +

      Example:

      +
      parser.add_option("-t", "--tracks", action="append", type="int")
      +
      +
      +

      If -t3 is seen on the command-line, optparse does the equivalent +of:

      +
      options.tracks = []
      +options.tracks.append(int("3"))
      +
      +
      +

      If, a little later on, --tracks=4 is seen, it does:

      +
      options.tracks.append(int("4"))
      +
      +
      +

      The append action calls the append method on the current value of the +option. This means that any default value specified must have an append +method. It also means that if the default value is non-empty, the default +elements will be present in the parsed value for the option, with any values +from the command line appended after those default values:

      +
      >>> parser.add_option("--files", action="append", default=['~/.mypkg/defaults'])
      +>>> opts, args = parser.parse_args(['--files', 'overrides.mypkg'])
      +>>> opts.files
      +['~/.mypkg/defaults', 'overrides.mypkg']
      +
      +
      +
    • +
    • "append_const" [required: const; relevant: +dest]

      +

      Like "store_const", but the value const is appended to +dest; as with "append", dest defaults to +None, and an empty list is automatically created the first time the option +is encountered.

      +
    • +
    • "count" [relevant: dest]

      +

      Increment the integer stored at dest. If no default value is +supplied, dest is set to zero before being incremented the +first time.

      +

      Example:

      +
      parser.add_option("-v", action="count", dest="verbosity")
      +
      +
      +

      The first time -v is seen on the command line, optparse does the +equivalent of:

      +
      options.verbosity = 0
      +options.verbosity += 1
      +
      +
      +

      Every subsequent occurrence of -v results in

      +
      options.verbosity += 1
      +
      +
      +
    • +
    • "callback" [required: callback; relevant: +type, nargs, callback_args, +callback_kwargs]

      +

      Call the function specified by callback, which is called as

      +
      func(option, opt_str, value, parser, *args, **kwargs)
      +
      +
      +

      See section Option Callbacks for more detail.

      +
    • +
    • "help"

      +

      Prints a complete help message for all the options in the current option +parser. The help message is constructed from the usage string passed to +OptionParser’s constructor and the help string passed to every +option.

      +

      If no help string is supplied for an option, it will still be +listed in the help message. To omit an option entirely, use the special value +optparse.SUPPRESS_HELP.

      +

      optparse automatically adds a help option to all +OptionParsers, so you do not normally need to create one.

      +

      Example:

      +
      from optparse import OptionParser, SUPPRESS_HELP
      +
      +# usually, a help option is added automatically, but that can
      +# be suppressed using the add_help_option argument
      +parser = OptionParser(add_help_option=False)
      +
      +parser.add_option("-h", "--help", action="help")
      +parser.add_option("-v", action="store_true", dest="verbose",
      +                  help="Be moderately verbose")
      +parser.add_option("--file", dest="filename",
      +                  help="Input file to read data from")
      +parser.add_option("--secret", help=SUPPRESS_HELP)
      +
      +
      +

      If optparse sees either -h or --help on the command line, +it will print something like the following help message to stdout (assuming +sys.argv[0] is "foo.py"):

      +
      Usage: foo.py [options]
      +
      +Options:
      +  -h, --help        Show this help message and exit
      +  -v                Be moderately verbose
      +  --file=FILENAME   Input file to read data from
      +
      +
      +

      After printing the help message, optparse terminates your process with +sys.exit(0).

      +
    • +
    • "version"

      +

      Prints the version number supplied to the OptionParser to stdout and exits. +The version number is actually formatted and printed by the +print_version() method of OptionParser. Generally only relevant if the +version argument is supplied to the OptionParser constructor. As with +help options, you will rarely create version options, +since optparse automatically adds them when needed.

      +
    • +
    +
    +
    +

    Standard option types

    +

    optparse has five built-in option types: "string", "int", +"choice", "float" and "complex". If you need to add new +option types, see section Extending optparse.

    +

    Arguments to string options are not checked or converted in any way: the text on +the command line is stored in the destination (or passed to the callback) as-is.

    +

    Integer arguments (type "int") are parsed as follows:

    +
      +
    • if the number starts with 0x, it is parsed as a hexadecimal number

    • +
    • if the number starts with 0, it is parsed as an octal number

    • +
    • if the number starts with 0b, it is parsed as a binary number

    • +
    • otherwise, the number is parsed as a decimal number

    • +
    +

    The conversion is done by calling int() with the appropriate base (2, 8, +10, or 16). If this fails, so will optparse, although with a more useful +error message.

    +

    "float" and "complex" option arguments are converted directly with +float() and complex(), with similar error-handling.

    +

    "choice" options are a subtype of "string" options. The +choices option attribute (a sequence of strings) defines the +set of allowed option arguments. optparse.check_choice() compares +user-supplied option arguments against this master list and raises +OptionValueError if an invalid string is given.

    +
    +
    +

    Parsing arguments

    +

    The whole point of creating and populating an OptionParser is to call its +parse_args() method:

    +
    (options, args) = parser.parse_args(args=None, values=None)
    +
    +
    +

    where the input parameters are

    +
    +
    args

    the list of arguments to process (default: sys.argv[1:])

    +
    +
    values

    an optparse.Values object to store option arguments in (default: a +new instance of Values) – if you give an existing object, the +option defaults will not be initialized on it

    +
    +
    +

    and the return values are

    +
    +
    options

    the same object that was passed in as values, or the optparse.Values +instance created by optparse

    +
    +
    args

    the leftover positional arguments after all options have been processed

    +
    +
    +

    The most common usage is to supply neither keyword argument. If you supply +values, it will be modified with repeated setattr() calls (roughly one +for every option argument stored to an option destination) and returned by +parse_args().

    +

    If parse_args() encounters any errors in the argument list, it calls the +OptionParser’s error() method with an appropriate end-user error message. +This ultimately terminates your process with an exit status of 2 (the +traditional Unix exit status for command-line errors).

    +
    +
    +

    Querying and manipulating your option parser

    +

    The default behavior of the option parser can be customized slightly, and you +can also poke around your option parser and see what’s there. OptionParser +provides several methods to help you out:

    +
    +
    +OptionParser.disable_interspersed_args()
    +

    Set parsing to stop on the first non-option. For example, if -a and +-b are both simple options that take no arguments, optparse +normally accepts this syntax:

    +
    prog -a arg1 -b arg2
    +
    +
    +

    and treats it as equivalent to

    +
    prog -a -b arg1 arg2
    +
    +
    +

    To disable this feature, call disable_interspersed_args(). This +restores traditional Unix syntax, where option parsing stops with the first +non-option argument.

    +

    Use this if you have a command processor which runs another command which has +options of its own and you want to make sure these options don’t get +confused. For example, each command might have a different set of options.

    +
    + +
    +
    +OptionParser.enable_interspersed_args()
    +

    Set parsing to not stop on the first non-option, allowing interspersing +switches with command arguments. This is the default behavior.

    +
    + +
    +
    +OptionParser.get_option(opt_str)
    +

    Returns the Option instance with the option string opt_str, or None if +no options have that option string.

    +
    + +
    +
    +OptionParser.has_option(opt_str)
    +

    Return true if the OptionParser has an option with option string opt_str +(e.g., -q or --verbose).

    +
    + +
    +
    +OptionParser.remove_option(opt_str)
    +

    If the OptionParser has an option corresponding to opt_str, that +option is removed. If that option provided any other option strings, all of +those option strings become invalid. If opt_str does not occur in any +option belonging to this OptionParser, raises ValueError.

    +
    + +
    +
    +

    Conflicts between options

    +

    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 +some standard options.)

    +

    Every time you add an option, optparse checks for conflicts with existing +options. If it finds any, it invokes the current conflict-handling mechanism. +You can set the conflict-handling mechanism either in the constructor:

    +
    parser = OptionParser(..., conflict_handler=handler)
    +
    +
    +

    or with a separate call:

    +
    parser.set_conflict_handler(handler)
    +
    +
    +

    The available conflict handlers are:

    +
    +
    +
    "error" (default)

    assume option conflicts are a programming error and raise +OptionConflictError

    +
    +
    "resolve"

    resolve option conflicts intelligently (see below)

    +
    +
    +
    +

    As an example, let’s define an OptionParser that resolves conflicts +intelligently and add conflicting options to it:

    +
    parser = OptionParser(conflict_handler="resolve")
    +parser.add_option("-n", "--dry-run", ..., help="do no harm")
    +parser.add_option("-n", "--noisy", ..., help="be noisy")
    +
    +
    +

    At this point, optparse detects that a previously-added option is already +using the -n option string. Since conflict_handler is "resolve", +it resolves the situation by removing -n from the earlier option’s list of +option strings. Now --dry-run is the only way for the user to activate +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 +until there are none left, and the user has no way of invoking that option from +the command-line. In that case, optparse removes that option completely, +so it doesn’t show up in help text or anywhere else. Carrying on with our +existing OptionParser:

    +
    parser.add_option("--dry-run", ..., help="new dry-run option")
    +
    +
    +

    At this point, the original -n/--dry-run option is no longer +accessible, so optparse removes it, leaving this help text:

    +
    Options:
    +  ...
    +  -n, --noisy   be noisy
    +  --dry-run     new dry-run option
    +
    +
    +
    +
    +

    Cleanup

    +

    OptionParser instances have several cyclic references. This should not be a +problem for Python’s garbage collector, but you may wish to break the cyclic +references explicitly by calling destroy() on your +OptionParser once you are done with it. This is particularly useful in +long-running applications where large object graphs are reachable from your +OptionParser.

    +
    +
    +

    Other methods

    +

    OptionParser supports several other public methods:

    +
    +
    +OptionParser.set_usage(usage)
    +

    Set the usage string according to the rules described above for the usage +constructor keyword argument. Passing None sets the default usage +string; use optparse.SUPPRESS_USAGE to suppress a usage message.

    +
    + +
    +
    +OptionParser.print_usage(file=None)
    +

    Print the usage message for the current program (self.usage) to file +(default stdout). Any occurrence of the string %prog in self.usage +is replaced with the name of the current program. Does nothing if +self.usage is empty or not defined.

    +
    + +
    +
    +OptionParser.get_usage()
    +

    Same as print_usage() but returns the usage string instead of +printing it.

    +
    + +
    +
    +OptionParser.set_defaults(dest=value, ...)
    +

    Set default values for several option destinations at once. Using +set_defaults() is the preferred way to set default values for options, +since multiple options can share the same destination. For example, if +several “mode” options all set the same destination, any one of them can set +the default, and the last one wins:

    +
    parser.add_option("--advanced", action="store_const",
    +                  dest="mode", const="advanced",
    +                  default="novice")    # overridden below
    +parser.add_option("--novice", action="store_const",
    +                  dest="mode", const="novice",
    +                  default="advanced")  # overrides above setting
    +
    +
    +

    To avoid this confusion, use set_defaults():

    +
    parser.set_defaults(mode="advanced")
    +parser.add_option("--advanced", action="store_const",
    +                  dest="mode", const="advanced")
    +parser.add_option("--novice", action="store_const",
    +                  dest="mode", const="novice")
    +
    +
    +
    + +
    +
    +
    +

    Option Callbacks

    +

    When optparse’s built-in actions and types aren’t quite enough for your +needs, you have two choices: extend optparse or define a callback option. +Extending optparse is more general, but overkill for a lot of simple +cases. Quite often a simple callback is all you need.

    +

    There are two steps to defining a callback option:

    +
      +
    • define the option itself using the "callback" action

    • +
    • write the callback; this is a function (or method) that takes at least four +arguments, as described below

    • +
    +
    +

    Defining a callback option

    +

    As always, the easiest way to define a callback option is by using the +OptionParser.add_option() method. Apart from action, the +only option attribute you must specify is callback, the function to call:

    +
    parser.add_option("-c", action="callback", callback=my_callback)
    +
    +
    +

    callback is a function (or other callable object), so you must have already +defined my_callback() when you create this callback option. In this simple +case, optparse doesn’t even know if -c takes any arguments, +which usually means that the option takes no arguments—the mere presence of +-c on the command-line is all it needs to know. In some +circumstances, though, you might want your callback to consume an arbitrary +number of command-line arguments. This is where writing callbacks gets tricky; +it’s covered later in this section.

    +

    optparse always passes four particular arguments to your callback, and it +will only pass additional arguments if you specify them via +callback_args and callback_kwargs. Thus, the +minimal callback function signature is:

    +
    def my_callback(option, opt, value, parser):
    +
    +
    +

    The four arguments to a callback are described below.

    +

    There are several other option attributes that you can supply when you define a +callback option:

    +
    +
    type

    has its usual meaning: as with the "store" or "append" actions, it +instructs optparse to consume one argument and convert it to +type. Rather than storing the converted value(s) anywhere, +though, optparse passes it to your callback function.

    +
    +
    nargs

    also has its usual meaning: if it is supplied and > 1, optparse will +consume nargs arguments, each of which must be convertible to +type. It then passes a tuple of converted values to your +callback.

    +
    +
    callback_args

    a tuple of extra positional arguments to pass to the callback

    +
    +
    callback_kwargs

    a dictionary of extra keyword arguments to pass to the callback

    +
    +
    +
    +
    +

    How callbacks are called

    +

    All callbacks are called as follows:

    +
    func(option, opt_str, value, parser, *args, **kwargs)
    +
    +
    +

    where

    +
    +
    option

    is the Option instance that’s calling the callback

    +
    +
    opt_str

    is the option string seen on the command-line that’s triggering the callback. +(If an abbreviated long option was used, opt_str will be the full, +canonical option string—e.g. if the user puts --foo on the +command-line as an abbreviation for --foobar, then opt_str will be +"--foobar".)

    +
    +
    value

    is the argument to this option seen on the command-line. optparse will +only expect an argument if type is set; the type of value will be +the type implied by the option’s type. If type for this option is +None (no argument expected), then value will be None. If nargs +> 1, value will be a tuple of values of the appropriate type.

    +
    +
    parser

    is the OptionParser instance driving the whole thing, mainly useful because +you can access some other interesting data through its instance attributes:

    +
    +
    parser.largs

    the current list of leftover arguments, ie. arguments that have been +consumed but are neither options nor option arguments. Feel free to modify +parser.largs, e.g. by adding more arguments to it. (This list will +become args, the second return value of parse_args().)

    +
    +
    parser.rargs

    the current list of remaining arguments, ie. with opt_str and +value (if applicable) removed, and only the arguments following them +still there. Feel free to modify parser.rargs, e.g. by consuming more +arguments.

    +
    +
    parser.values

    the object where option values are by default stored (an instance of +optparse.OptionValues). This lets callbacks use the same mechanism as the +rest of optparse for storing option values; you don’t need to mess +around with globals or closures. You can also access or modify the +value(s) of any options already encountered on the command-line.

    +
    +
    +
    +
    args

    is a tuple of arbitrary positional arguments supplied via the +callback_args option attribute.

    +
    +
    kwargs

    is a dictionary of arbitrary keyword arguments supplied via +callback_kwargs.

    +
    +
    +
    +
    +

    Raising errors in a callback

    +

    The callback function should raise OptionValueError if there are any +problems with the option or its argument(s). optparse catches this and +terminates the program, printing the error message you supply to stderr. Your +message should be clear, concise, accurate, and mention the option at fault. +Otherwise, the user will have a hard time figuring out what they did wrong.

    +
    +
    +

    Callback example 1: trivial callback

    +

    Here’s an example of a callback option that takes no arguments, and simply +records that the option was seen:

    +
    def record_foo_seen(option, opt_str, value, parser):
    +    parser.values.saw_foo = True
    +
    +parser.add_option("--foo", action="callback", callback=record_foo_seen)
    +
    +
    +

    Of course, you could do that with the "store_true" action.

    +
    +
    +

    Callback example 2: check option order

    +

    Here’s a slightly more interesting example: record the fact that -a is +seen, but blow up if it comes after -b in the command-line.

    +
    def check_order(option, opt_str, value, parser):
    +    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")
    +
    +
    +
    +
    +

    Callback example 3: check option order (generalized)

    +

    If you want to re-use this callback for several similar options (set a flag, but +blow up if -b has already been seen), it needs a bit of work: the error +message and the flag that it sets must be generalized.

    +
    def check_order(option, opt_str, value, parser):
    +    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')
    +
    +
    +
    +
    +

    Callback example 4: check arbitrary condition

    +

    Of course, you could put any condition in there—you’re not limited to checking +the values of already-defined options. For example, if you have options that +should not be called when the moon is full, all you have to do is this:

    +
    def check_moon(option, opt_str, value, parser):
    +    if is_moon_full():
    +        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")
    +
    +
    +

    (The definition of is_moon_full() is left as an exercise for the reader.)

    +
    +
    +

    Callback example 5: fixed arguments

    +

    Things get slightly more interesting when you define callback options that take +a fixed number of arguments. Specifying that a callback option takes arguments +is similar to defining a "store" or "append" option: if you define +type, then the option takes one argument that must be +convertible to that type; if you further define nargs, then the +option takes nargs arguments.

    +

    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")
    +
    +
    +

    Note that optparse takes care of consuming 3 arguments and converting +them to integers for you; all you have to do is store them. (Or whatever; +obviously you don’t need a callback for this example.)

    +
    +
    +

    Callback example 6: variable arguments

    +

    Things get hairy when you want an option to take a variable number of arguments. +For this case, you must write a callback, as optparse doesn’t provide any +built-in capabilities for it. And you have to deal with certain intricacies of +conventional Unix command-line parsing that optparse normally handles for +you. In particular, callbacks should implement the conventional rules for bare +-- and - arguments:

    +
      +
    • either -- or - can be option arguments

    • +
    • bare -- (if not the argument to some option): halt command-line +processing and discard the --

    • +
    • bare - (if not the argument to some option): halt command-line +processing but keep the - (append it to parser.largs)

    • +
    +

    If you want an option that takes a variable number of arguments, there are +several subtle, tricky issues to worry about. The exact implementation you +choose will be based on which trade-offs you’re willing to make for your +application (which is why optparse doesn’t support this sort of thing +directly).

    +

    Nevertheless, here’s a stab at a callback for an option with variable +arguments:

    +
    def vararg_callback(option, opt_str, value, parser):
    +    assert value is None
    +    value = []
    +
    +    def floatable(str):
    +        try:
    +            float(str)
    +            return True
    +        except ValueError:
    +            return False
    +
    +    for arg in parser.rargs:
    +        # stop on --foo like options
    +        if arg[:2] == "--" and len(arg) > 2:
    +            break
    +        # stop on -a, but not on -3 or -3.0
    +        if arg[:1] == "-" and len(arg) > 1 and not floatable(arg):
    +            break
    +        value.append(arg)
    +
    +    del parser.rargs[:len(value)]
    +    setattr(parser.values, option.dest, value)
    +
    +...
    +parser.add_option("-c", "--callback", dest="vararg_attr",
    +                  action="callback", callback=vararg_callback)
    +
    +
    +
    +
    +
    +

    Extending optparse

    +

    Since the two major controlling factors in how optparse interprets +command-line options are the action and type of each option, the most likely +direction of extension is to add new actions and new types.

    +
    +

    Adding new types

    +

    To add new types, you need to define your own subclass of optparse’s +Option class. This class has a couple of attributes that define +optparse’s types: TYPES and TYPE_CHECKER.

    +
    +
    +Option.TYPES
    +

    A tuple of type names; in your subclass, simply define a new tuple +TYPES that builds on the standard one.

    +
    + +
    +
    +Option.TYPE_CHECKER
    +

    A dictionary mapping type names to type-checking functions. A type-checking +function has the following signature:

    +
    def check_mytype(option, opt, value)
    +
    +
    +

    where option is an Option instance, opt is an option string +(e.g., -f), and value is the string from the command line that must +be checked and converted to your desired type. check_mytype() should +return an object of the hypothetical type mytype. The value returned by +a type-checking function will wind up in the OptionValues instance returned +by OptionParser.parse_args(), or be passed to a callback as the +value parameter.

    +

    Your type-checking function should raise OptionValueError if it +encounters any problems. OptionValueError takes a single string +argument, which is passed as-is to OptionParser’s error() +method, which in turn prepends the program name and the string "error:" +and prints everything to stderr before terminating the process.

    +
    + +

    Here’s a silly example that demonstrates adding a "complex" option type to +parse Python-style complex numbers on the command line. (This is even sillier +than it used to be, because optparse 1.3 added built-in support for +complex numbers, but never mind.)

    +

    First, the necessary imports:

    +
    from copy import copy
    +from optparse import Option, OptionValueError
    +
    +
    +

    You need to define your type-checker first, since it’s referred to later (in the +TYPE_CHECKER class attribute of your Option subclass):

    +
    def check_complex(option, opt, value):
    +    try:
    +        return complex(value)
    +    except ValueError:
    +        raise OptionValueError(
    +            "option %s: invalid complex value: %r" % (opt, value))
    +
    +
    +

    Finally, the Option subclass:

    +
    class MyOption (Option):
    +    TYPES = Option.TYPES + ("complex",)
    +    TYPE_CHECKER = copy(Option.TYPE_CHECKER)
    +    TYPE_CHECKER["complex"] = check_complex
    +
    +
    +

    (If we didn’t make a copy() of Option.TYPE_CHECKER, we would end +up modifying the TYPE_CHECKER attribute of optparse’s +Option class. This being Python, nothing stops you from doing that except good +manners and common sense.)

    +

    That’s it! Now you can write a script that uses the new option type just like +any other optparse-based script, except you have to instruct your +OptionParser to use MyOption instead of Option:

    +
    parser = OptionParser(option_class=MyOption)
    +parser.add_option("-c", type="complex")
    +
    +
    +

    Alternately, you can build your own option list and pass it to OptionParser; if +you don’t use add_option() in the above way, you don’t need to tell +OptionParser which option class to use:

    +
    option_list = [MyOption("-c", action="store", type="complex", dest="c")]
    +parser = OptionParser(option_list=option_list)
    +
    +
    +
    +
    +

    Adding new actions

    +

    Adding new actions is a bit trickier, because you have to understand that +optparse has a couple of classifications for actions:

    +
    +
    “store” actions

    actions that result in optparse storing a value to an attribute of the +current OptionValues instance; these options require a dest +attribute to be supplied to the Option constructor.

    +
    +
    “typed” actions

    actions that take a value from the command line and expect it to be of a +certain type; or rather, a string that can be converted to a certain type. +These options require a type attribute to the Option +constructor.

    +
    +
    +

    These are overlapping sets: some default “store” actions are "store", +"store_const", "append", and "count", while the default “typed” +actions are "store", "append", and "callback".

    +

    When you add an action, you need to categorize it by listing it in at least one +of the following class attributes of Option (all are lists of strings):

    +
    +
    +Option.ACTIONS
    +

    All actions must be listed in ACTIONS.

    +
    + +
    +
    +Option.STORE_ACTIONS
    +

    “store” actions are additionally listed here.

    +
    + +
    +
    +Option.TYPED_ACTIONS
    +

    “typed” actions are additionally listed here.

    +
    + +
    +
    +Option.ALWAYS_TYPED_ACTIONS
    +

    Actions that always take a type (i.e. whose options always take a value) are +additionally listed here. The only effect of this is that optparse +assigns the default type, "string", to options with no explicit type +whose action is listed in ALWAYS_TYPED_ACTIONS.

    +
    + +

    In order to actually implement your new action, you must override Option’s +take_action() method and add a case that recognizes your action.

    +

    For example, let’s add an "extend" action. This is similar to the standard +"append" action, but instead of taking a single value from the command-line +and appending it to an existing list, "extend" will take multiple values in +a single comma-delimited string, and extend an existing list with them. That +is, if --names is an "extend" option of type "string", the command +line

    +
    --names=foo,bar --names blah --names ding,dong
    +
    +
    +

    would result in a list

    +
    ["foo", "bar", "blah", "ding", "dong"]
    +
    +
    +

    Again we define a subclass of Option:

    +
    class MyOption(Option):
    +
    +    ACTIONS = Option.ACTIONS + ("extend",)
    +    STORE_ACTIONS = Option.STORE_ACTIONS + ("extend",)
    +    TYPED_ACTIONS = Option.TYPED_ACTIONS + ("extend",)
    +    ALWAYS_TYPED_ACTIONS = Option.ALWAYS_TYPED_ACTIONS + ("extend",)
    +
    +    def take_action(self, action, dest, opt, value, values, parser):
    +        if action == "extend":
    +            lvalue = value.split(",")
    +            values.ensure_value(dest, []).extend(lvalue)
    +        else:
    +            Option.take_action(
    +                self, action, dest, opt, value, values, parser)
    +
    +
    +

    Features of note:

    +
      +
    • "extend" both expects a value on the command-line and stores that value +somewhere, so it goes in both STORE_ACTIONS and +TYPED_ACTIONS.

    • +
    • to ensure that optparse assigns the default type of "string" to +"extend" actions, we put the "extend" action in +ALWAYS_TYPED_ACTIONS as well.

    • +
    • MyOption.take_action() implements just this one new action, and passes +control back to Option.take_action() for the standard optparse +actions.

    • +
    • values is an instance of the optparse_parser.Values class, which provides +the very useful ensure_value() method. ensure_value() is +essentially getattr() with a safety valve; it is called as

      +
      values.ensure_value(attr, value)
      +
      +
      +

      If the attr attribute of values doesn’t exist or is None, then +ensure_value() first sets it to value, and then returns ‘value. This is +very handy for actions like "extend", "append", and "count", all +of which accumulate data in a variable and expect that variable to be of a +certain type (a list for the first two, an integer for the latter). Using +ensure_value() means that scripts using your action don’t have to worry +about setting a default value for the option destinations in question; they +can just leave the default as None and ensure_value() will take care of +getting it right when it’s needed.

      +
    • +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/os.html b/python-3.7.4-docs-html/library/os.html new file mode 100644 index 0000000..f7931a2 --- /dev/null +++ b/python-3.7.4-docs-html/library/os.html @@ -0,0 +1,4412 @@ + + + + + + + os — Miscellaneous operating system interfaces — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    os — Miscellaneous operating system interfaces

    +

    Source code: Lib/os.py

    +
    +

    This module provides a portable way of using operating system dependent +functionality. If you just want to read or write a file see open(), if +you want to manipulate paths, see the os.path module, and if you want to +read all the lines in all the files on the command line see the fileinput +module. For creating temporary files and directories see the tempfile +module, and for high-level file and directory handling see the shutil +module.

    +

    Notes on the availability of these functions:

    +
      +
    • The design of all built-in operating system dependent modules of Python is +such that as long as the same functionality is available, it uses the same +interface; for example, the function os.stat(path) returns stat +information about path in the same format (which happens to have originated +with the POSIX interface).

    • +
    • Extensions peculiar to a particular operating system are also available +through the os module, but using them is of course a threat to +portability.

    • +
    • All functions accepting path or file names accept both bytes and string +objects, and result in an object of the same type, if a path or file name is +returned.

    • +
    +
    +

    Note

    +

    All functions in this module raise OSError (or subclasses thereof) in +the case of invalid or inaccessible file names and paths, or other arguments +that have the correct type, but are not accepted by the operating system.

    +
    +
    +
    +exception os.error
    +

    An alias for the built-in OSError exception.

    +
    + +
    +
    +os.name
    +

    The name of the operating system dependent module imported. The following +names have currently been registered: 'posix', 'nt', +'java'.

    +
    +

    See also

    +

    sys.platform has a finer granularity. os.uname() gives +system-dependent version information.

    +

    The platform module provides detailed checks for the +system’s identity.

    +
    +
    + +
    +

    File Names, Command Line Arguments, and Environment Variables

    +

    In Python, file names, command line arguments, and environment variables are +represented using the string type. On some systems, decoding these strings to +and from bytes is necessary before passing them to the operating system. Python +uses the file system encoding to perform this conversion (see +sys.getfilesystemencoding()).

    +
    +

    Changed in version 3.1: On some systems, conversion using the file system encoding may fail. In this +case, Python uses the surrogateescape encoding error handler, which means that undecodable bytes are replaced by a +Unicode character U+DCxx on decoding, and these are again translated to the +original byte on encoding.

    +
    +

    The file system encoding must guarantee to successfully decode all bytes +below 128. If the file system encoding fails to provide this guarantee, API +functions may raise UnicodeErrors.

    +
    +
    +

    Process Parameters

    +

    These functions and data items provide information and operate on the current +process and user.

    +
    +
    +os.ctermid()
    +

    Return the filename corresponding to the controlling terminal of the process.

    +

    Availability: Unix.

    +
    + +
    +
    +os.environ
    +

    A mapping object representing the string environment. For example, +environ['HOME'] is the pathname of your home directory (on some platforms), +and is equivalent to getenv("HOME") in C.

    +

    This mapping is captured the first time the os module is imported, +typically during Python startup as part of processing site.py. Changes +to the environment made after this time are not reflected in os.environ, +except for changes made by modifying os.environ directly.

    +

    If the platform supports the putenv() function, this mapping may be used +to modify the environment as well as query the environment. putenv() will +be called automatically when the mapping is modified.

    +

    On Unix, keys and values use sys.getfilesystemencoding() and +'surrogateescape' error handler. Use environb if you would like +to use a different encoding.

    +
    +

    Note

    +

    Calling putenv() directly does not change os.environ, so it’s better +to modify os.environ.

    +
    +
    +

    Note

    +

    On some platforms, including FreeBSD and Mac OS X, setting environ may +cause memory leaks. Refer to the system documentation for +putenv().

    +
    +

    If putenv() is not provided, a modified copy of this mapping may be +passed to the appropriate process-creation functions to cause child processes +to use a modified environment.

    +

    If the platform supports the unsetenv() function, you can delete items in +this mapping to unset environment variables. unsetenv() will be called +automatically when an item is deleted from os.environ, and when +one of the pop() or clear() methods is called.

    +
    + +
    +
    +os.environb
    +

    Bytes version of environ: a mapping object representing the +environment as byte strings. environ and environb are +synchronized (modify environb updates environ, and vice +versa).

    +

    environb is only available if supports_bytes_environ is +True.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +os.chdir(path)
    +
    +os.fchdir(fd)
    +
    +os.getcwd()
    +

    These functions are described in Files and Directories.

    +
    + +
    +
    +os.fsencode(filename)
    +

    Encode path-like filename to the filesystem +encoding with 'surrogateescape' error handler, or 'strict' on +Windows; return bytes unchanged.

    +

    fsdecode() is the reverse function.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.6: Support added to accept objects implementing the os.PathLike +interface.

    +
    +
    + +
    +
    +os.fsdecode(filename)
    +

    Decode the path-like filename from the +filesystem encoding with 'surrogateescape' error handler, or 'strict' +on Windows; return str unchanged.

    +

    fsencode() is the reverse function.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.6: Support added to accept objects implementing the os.PathLike +interface.

    +
    +
    + +
    +
    +os.fspath(path)
    +

    Return the file system representation of the path.

    +

    If str or bytes is passed in, it is returned unchanged. +Otherwise __fspath__() is called and its value is +returned as long as it is a str or bytes object. +In all other cases, TypeError is raised.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +class os.PathLike
    +

    An abstract base class for objects representing a file system path, +e.g. pathlib.PurePath.

    +
    +

    New in version 3.6.

    +
    +
    +
    +abstractmethod __fspath__()
    +

    Return the file system path representation of the object.

    +

    The method should only return a str or bytes object, +with the preference being for str.

    +
    + +
    + +
    +
    +os.getenv(key, default=None)
    +

    Return the value of the environment variable key if it exists, or +default if it doesn’t. key, default and the result are str.

    +

    On Unix, keys and values are decoded with sys.getfilesystemencoding() +and 'surrogateescape' error handler. Use os.getenvb() if you +would like to use a different encoding.

    +

    Availability: most flavors of Unix, Windows.

    +
    + +
    +
    +os.getenvb(key, default=None)
    +

    Return the value of the environment variable key if it exists, or +default if it doesn’t. key, default and the result are bytes.

    +

    getenvb() is only available if supports_bytes_environ +is True.

    +

    Availability: most flavors of Unix.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +os.get_exec_path(env=None)
    +

    Returns the list of directories that will be searched for a named +executable, similar to a shell, when launching a process. +env, when specified, should be an environment variable dictionary +to lookup the PATH in. +By default, when env is None, environ is used.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +os.getegid()
    +

    Return the effective group id of the current process. This corresponds to the +“set id” bit on the file being executed in the current process.

    +

    Availability: Unix.

    +
    + +
    +
    +os.geteuid()
    +

    Return the current process’s effective user id.

    +

    Availability: Unix.

    +
    + +
    +
    +os.getgid()
    +

    Return the real group id of the current process.

    +

    Availability: Unix.

    +
    + +
    +
    +os.getgrouplist(user, group)
    +

    Return list of group ids that user belongs to. If group is not in the +list, it is included; typically, group is specified as the group ID +field from the password record for user.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.getgroups()
    +

    Return list of supplemental group ids associated with the current process.

    +

    Availability: Unix.

    +
    +

    Note

    +

    On Mac OS X, getgroups() behavior differs somewhat from +other Unix platforms. If the Python interpreter was built with a +deployment target of 10.5 or earlier, getgroups() returns +the list of effective group ids associated with the current user process; +this list is limited to a system-defined number of entries, typically 16, +and may be modified by calls to setgroups() if suitably privileged. +If built with a deployment target greater than 10.5, +getgroups() returns the current group access list for the user +associated with the effective user id of the process; the group access +list may change over the lifetime of the process, it is not affected by +calls to setgroups(), and its length is not limited to 16. The +deployment target value, MACOSX_DEPLOYMENT_TARGET, can be +obtained with sysconfig.get_config_var().

    +
    +
    + +
    +
    +os.getlogin()
    +

    Return the name of the user logged in on the controlling terminal of the +process. For most purposes, it is more useful to use +getpass.getuser() since the latter checks the environment variables +LOGNAME or USERNAME to find out who the user is, and +falls back to pwd.getpwuid(os.getuid())[0] to get the login name of the +current real user id.

    +

    Availability: Unix, Windows.

    +
    + +
    +
    +os.getpgid(pid)
    +

    Return the process group id of the process with process id pid. If pid is 0, +the process group id of the current process is returned.

    +

    Availability: Unix.

    +
    + +
    +
    +os.getpgrp()
    +

    Return the id of the current process group.

    +

    Availability: Unix.

    +
    + +
    +
    +os.getpid()
    +

    Return the current process id.

    +
    + +
    +
    +os.getppid()
    +

    Return the parent’s process id. When the parent process has exited, on Unix +the id returned is the one of the init process (1), on Windows it is still +the same id, which may be already reused by another process.

    +

    Availability: Unix, Windows.

    +
    +

    Changed in version 3.2: Added support for Windows.

    +
    +
    + +
    +
    +os.getpriority(which, who)
    +

    Get program scheduling priority. The value which is one of +PRIO_PROCESS, PRIO_PGRP, or PRIO_USER, and who +is interpreted relative to which (a process identifier for +PRIO_PROCESS, process group identifier for PRIO_PGRP, and a +user ID for PRIO_USER). A zero value for who denotes +(respectively) the calling process, the process group of the calling process, +or the real user ID of the calling process.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.PRIO_PROCESS
    +
    +os.PRIO_PGRP
    +
    +os.PRIO_USER
    +

    Parameters for the getpriority() and setpriority() functions.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.getresuid()
    +

    Return a tuple (ruid, euid, suid) denoting the current process’s +real, effective, and saved user ids.

    +

    Availability: Unix.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +os.getresgid()
    +

    Return a tuple (rgid, egid, sgid) denoting the current process’s +real, effective, and saved group ids.

    +

    Availability: Unix.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +os.getuid()
    +

    Return the current process’s real user id.

    +

    Availability: Unix.

    +
    + +
    +
    +os.initgroups(username, gid)
    +

    Call the system initgroups() to initialize the group access list with all of +the groups of which the specified username is a member, plus the specified +group id.

    +

    Availability: Unix.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +os.putenv(key, value)
    +

    Set the environment variable named key to the string value. Such +changes to the environment affect subprocesses started with os.system(), +popen() or fork() and execv().

    +

    Availability: most flavors of Unix, Windows.

    +
    +

    Note

    +

    On some platforms, including FreeBSD and Mac OS X, setting environ may +cause memory leaks. Refer to the system documentation for putenv.

    +
    +

    When putenv() is supported, assignments to items in os.environ are +automatically translated into corresponding calls to putenv(); however, +calls to putenv() don’t update os.environ, so it is actually +preferable to assign to items of os.environ.

    +
    + +
    +
    +os.setegid(egid)
    +

    Set the current process’s effective group id.

    +

    Availability: Unix.

    +
    + +
    +
    +os.seteuid(euid)
    +

    Set the current process’s effective user id.

    +

    Availability: Unix.

    +
    + +
    +
    +os.setgid(gid)
    +

    Set the current process’ group id.

    +

    Availability: Unix.

    +
    + +
    +
    +os.setgroups(groups)
    +

    Set the list of supplemental group ids associated with the current process to +groups. groups must be a sequence, and each element must be an integer +identifying a group. This operation is typically available only to the superuser.

    +

    Availability: Unix.

    +
    +

    Note

    +

    On Mac OS X, the length of groups may not exceed the +system-defined maximum number of effective group ids, typically 16. +See the documentation for getgroups() for cases where it may not +return the same group list set by calling setgroups().

    +
    +
    + +
    +
    +os.setpgrp()
    +

    Call the system call setpgrp() or setpgrp(0, 0) depending on +which version is implemented (if any). See the Unix manual for the semantics.

    +

    Availability: Unix.

    +
    + +
    +
    +os.setpgid(pid, pgrp)
    +

    Call the system call setpgid() to set the process group id of the +process with id pid to the process group with id pgrp. See the Unix manual +for the semantics.

    +

    Availability: Unix.

    +
    + +
    +
    +os.setpriority(which, who, priority)
    +

    Set program scheduling priority. The value which is one of +PRIO_PROCESS, PRIO_PGRP, or PRIO_USER, and who +is interpreted relative to which (a process identifier for +PRIO_PROCESS, process group identifier for PRIO_PGRP, and a +user ID for PRIO_USER). A zero value for who denotes +(respectively) the calling process, the process group of the calling process, +or the real user ID of the calling process. +priority is a value in the range -20 to 19. The default priority is 0; +lower priorities cause more favorable scheduling.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.setregid(rgid, egid)
    +

    Set the current process’s real and effective group ids.

    +

    Availability: Unix.

    +
    + +
    +
    +os.setresgid(rgid, egid, sgid)
    +

    Set the current process’s real, effective, and saved group ids.

    +

    Availability: Unix.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +os.setresuid(ruid, euid, suid)
    +

    Set the current process’s real, effective, and saved user ids.

    +

    Availability: Unix.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +os.setreuid(ruid, euid)
    +

    Set the current process’s real and effective user ids.

    +

    Availability: Unix.

    +
    + +
    +
    +os.getsid(pid)
    +

    Call the system call getsid(). See the Unix manual for the semantics.

    +

    Availability: Unix.

    +
    + +
    +
    +os.setsid()
    +

    Call the system call setsid(). See the Unix manual for the semantics.

    +

    Availability: Unix.

    +
    + +
    +
    +os.setuid(uid)
    +

    Set the current process’s user id.

    +

    Availability: Unix.

    +
    + +
    +
    +os.strerror(code)
    +

    Return the error message corresponding to the error code in code. +On platforms where strerror() returns NULL when given an unknown +error number, ValueError is raised.

    +
    + +
    +
    +os.supports_bytes_environ
    +

    True if the native OS type of the environment is bytes (eg. False on +Windows).

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +os.umask(mask)
    +

    Set the current numeric umask and return the previous umask.

    +
    + +
    +
    +os.uname()
    +

    Returns information identifying the current operating system. +The return value is an object with five attributes:

    +
      +
    • sysname - operating system name

    • +
    • nodename - name of machine on network (implementation-defined)

    • +
    • release - operating system release

    • +
    • version - operating system version

    • +
    • machine - hardware identifier

    • +
    +

    For backwards compatibility, this object is also iterable, behaving +like a five-tuple containing sysname, nodename, +release, version, and machine +in that order.

    +

    Some systems truncate nodename to 8 characters or to the +leading component; a better way to get the hostname is +socket.gethostname() or even +socket.gethostbyaddr(socket.gethostname()).

    +

    Availability: recent flavors of Unix.

    +
    +

    Changed in version 3.3: Return type changed from a tuple to a tuple-like object +with named attributes.

    +
    +
    + +
    +
    +os.unsetenv(key)
    +

    Unset (delete) the environment variable named key. Such changes to the +environment affect subprocesses started with os.system(), popen() or +fork() and execv().

    +

    When unsetenv() is supported, deletion of items in os.environ is +automatically translated into a corresponding call to unsetenv(); however, +calls to unsetenv() don’t update os.environ, so it is actually +preferable to delete items of os.environ.

    +

    Availability: most flavors of Unix, Windows.

    +
    + +
    +
    +

    File Object Creation

    +

    This function creates new file objects. (See also +open() for opening file descriptors.)

    +
    +
    +os.fdopen(fd, *args, **kwargs)
    +

    Return an open file object connected to the file descriptor fd. This is an +alias of the open() built-in function and accepts the same arguments. +The only difference is that the first argument of fdopen() must always +be an integer.

    +
    + +
    +
    +

    File Descriptor Operations

    +

    These functions operate on I/O streams referenced using file descriptors.

    +

    File descriptors are small integers corresponding to a file that has been opened +by the current process. For example, standard input is usually file descriptor +0, standard output is 1, and standard error is 2. Further files opened by a +process will then be assigned 3, 4, 5, and so forth. The name “file descriptor” +is slightly deceptive; on Unix platforms, sockets and pipes are also referenced +by file descriptors.

    +

    The fileno() method can be used to obtain the file descriptor +associated with a file object when required. Note that using the file +descriptor directly will bypass the file object methods, ignoring aspects such +as internal buffering of data.

    +
    +
    +os.close(fd)
    +

    Close file descriptor fd.

    +
    +

    Note

    +

    This function is intended for low-level I/O and must be applied to a file +descriptor as returned by os.open() or pipe(). To close a “file +object” returned by the built-in function open() or by popen() or +fdopen(), use its close() method.

    +
    +
    + +
    +
    +os.closerange(fd_low, fd_high)
    +

    Close all file descriptors from fd_low (inclusive) to fd_high (exclusive), +ignoring errors. Equivalent to (but much faster than):

    +
    for fd in range(fd_low, fd_high):
    +    try:
    +        os.close(fd)
    +    except OSError:
    +        pass
    +
    +
    +
    + +
    +
    +os.device_encoding(fd)
    +

    Return a string describing the encoding of the device associated with fd +if it is connected to a terminal; else return None.

    +
    + +
    +
    +os.dup(fd)
    +

    Return a duplicate of file descriptor fd. The new file descriptor is +non-inheritable.

    +

    On Windows, when duplicating a standard stream (0: stdin, 1: stdout, +2: stderr), the new file descriptor is inheritable.

    +
    +

    Changed in version 3.4: The new file descriptor is now non-inheritable.

    +
    +
    + +
    +
    +os.dup2(fd, fd2, inheritable=True)
    +

    Duplicate file descriptor fd to fd2, closing the latter first if +necessary. Return fd2. The new file descriptor is inheritable by default or non-inheritable if inheritable +is False.

    +
    +

    Changed in version 3.4: Add the optional inheritable parameter.

    +
    +
    +

    Changed in version 3.7: Return fd2 on success. Previously, None was always returned.

    +
    +
    + +
    +
    +os.fchmod(fd, mode)
    +

    Change the mode of the file given by fd to the numeric mode. See the +docs for chmod() for possible values of mode. As of Python 3.3, this +is equivalent to os.chmod(fd, mode).

    +

    Availability: Unix.

    +
    + +
    +
    +os.fchown(fd, uid, gid)
    +

    Change the owner and group id of the file given by fd to the numeric uid +and gid. To leave one of the ids unchanged, set it to -1. See +chown(). As of Python 3.3, this is equivalent to os.chown(fd, uid, +gid).

    +

    Availability: Unix.

    +
    + +
    +
    +os.fdatasync(fd)
    +

    Force write of file with filedescriptor fd to disk. Does not force update of +metadata.

    +

    Availability: Unix.

    +
    +

    Note

    +

    This function is not available on MacOS.

    +
    +
    + +
    +
    +os.fpathconf(fd, name)
    +

    Return system configuration information relevant to an open file. name +specifies the configuration value to retrieve; it may be a string which is the +name of a defined system value; these names are specified in a number of +standards (POSIX.1, Unix 95, Unix 98, and others). Some platforms define +additional names as well. The names known to the host operating system are +given in the pathconf_names dictionary. For configuration variables not +included in that mapping, passing an integer for name is also accepted.

    +

    If name is a string and is not known, ValueError is raised. If a +specific value for name is not supported by the host system, even if it is +included in pathconf_names, an OSError is raised with +errno.EINVAL for the error number.

    +

    As of Python 3.3, this is equivalent to os.pathconf(fd, name).

    +

    Availability: Unix.

    +
    + +
    +
    +os.fstat(fd)
    +

    Get the status of the file descriptor fd. Return a stat_result +object.

    +

    As of Python 3.3, this is equivalent to os.stat(fd).

    +
    +

    See also

    +

    The stat() function.

    +
    +
    + +
    +
    +os.fstatvfs(fd)
    +

    Return information about the filesystem containing the file associated with +file descriptor fd, like statvfs(). As of Python 3.3, this is +equivalent to os.statvfs(fd).

    +

    Availability: Unix.

    +
    + +
    +
    +os.fsync(fd)
    +

    Force write of file with filedescriptor fd to disk. On Unix, this calls the +native fsync() function; on Windows, the MS _commit() function.

    +

    If you’re starting with a buffered Python file object f, first do +f.flush(), and then do os.fsync(f.fileno()), to ensure that all internal +buffers associated with f are written to disk.

    +

    Availability: Unix, Windows.

    +
    + +
    +
    +os.ftruncate(fd, length)
    +

    Truncate the file corresponding to file descriptor fd, so that it is at +most length bytes in size. As of Python 3.3, this is equivalent to +os.truncate(fd, length).

    +

    Availability: Unix, Windows.

    +
    +

    Changed in version 3.5: Added support for Windows

    +
    +
    + +
    +
    +os.get_blocking(fd)
    +

    Get the blocking mode of the file descriptor: False if the +O_NONBLOCK flag is set, True if the flag is cleared.

    +

    See also set_blocking() and socket.socket.setblocking().

    +

    Availability: Unix.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +os.isatty(fd)
    +

    Return True if the file descriptor fd is open and connected to a +tty(-like) device, else False.

    +
    + +
    +
    +os.lockf(fd, cmd, len)
    +

    Apply, test or remove a POSIX lock on an open file descriptor. +fd is an open file descriptor. +cmd specifies the command to use - one of F_LOCK, F_TLOCK, +F_ULOCK or F_TEST. +len specifies the section of the file to lock.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.F_LOCK
    +
    +os.F_TLOCK
    +
    +os.F_ULOCK
    +
    +os.F_TEST
    +

    Flags that specify what action lockf() will take.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.lseek(fd, pos, how)
    +

    Set the current position of file descriptor fd to position pos, modified +by how: SEEK_SET or 0 to set the position relative to the +beginning of the file; SEEK_CUR or 1 to set it relative to the +current position; SEEK_END or 2 to set it relative to the end of +the file. Return the new cursor position in bytes, starting from the beginning.

    +
    + +
    +
    +os.SEEK_SET
    +
    +os.SEEK_CUR
    +
    +os.SEEK_END
    +

    Parameters to the lseek() function. Their values are 0, 1, and 2, +respectively.

    +
    +

    New in version 3.3: Some operating systems could support additional values, like +os.SEEK_HOLE or os.SEEK_DATA.

    +
    +
    + +
    +
    +os.open(path, flags, mode=0o777, *, dir_fd=None)
    +

    Open the file path and set various flags according to flags and possibly +its mode according to mode. When computing mode, the current umask value +is first masked out. Return the file descriptor for the newly opened file. +The new file descriptor is non-inheritable.

    +

    For a description of the flag and mode values, see the C run-time documentation; +flag constants (like O_RDONLY and O_WRONLY) are defined in +the os module. In particular, on Windows adding +O_BINARY is needed to open files in binary mode.

    +

    This function can support paths relative to directory descriptors with the dir_fd parameter.

    +
    +

    Changed in version 3.4: The new file descriptor is now non-inheritable.

    +
    +
    +

    Note

    +

    This function is intended for low-level I/O. For normal usage, use the +built-in function open(), which returns a file object with +read() and write() methods (and many more). To +wrap a file descriptor in a file object, use fdopen().

    +
    +
    +

    New in version 3.3: The dir_fd argument.

    +
    +
    +

    Changed in version 3.5: If the system call is interrupted and the signal handler does not raise an +exception, the function now retries the system call instead of raising an +InterruptedError exception (see PEP 475 for the rationale).

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +

    The following constants are options for the flags parameter to the +open() function. They can be combined using the bitwise OR operator +|. Some of them are not available on all platforms. For descriptions of +their availability and use, consult the open(2) manual page on Unix +or the MSDN on Windows.

    +
    +
    +os.O_RDONLY
    +
    +os.O_WRONLY
    +
    +os.O_RDWR
    +
    +os.O_APPEND
    +
    +os.O_CREAT
    +
    +os.O_EXCL
    +
    +os.O_TRUNC
    +

    The above constants are available on Unix and Windows.

    +
    + +
    +
    +os.O_DSYNC
    +
    +os.O_RSYNC
    +
    +os.O_SYNC
    +
    +os.O_NDELAY
    +
    +os.O_NONBLOCK
    +
    +os.O_NOCTTY
    +
    +os.O_CLOEXEC
    +

    The above constants are only available on Unix.

    +
    +

    Changed in version 3.3: Add O_CLOEXEC constant.

    +
    +
    + +
    +
    +os.O_BINARY
    +
    +os.O_NOINHERIT
    +
    +os.O_SHORT_LIVED
    +
    +os.O_TEMPORARY
    +
    +os.O_RANDOM
    +
    +os.O_SEQUENTIAL
    +
    +os.O_TEXT
    +

    The above constants are only available on Windows.

    +
    + +
    +
    +os.O_ASYNC
    +
    +os.O_DIRECT
    +
    +os.O_DIRECTORY
    +
    +os.O_NOFOLLOW
    +
    +os.O_NOATIME
    +
    +os.O_PATH
    +
    +os.O_TMPFILE
    +
    +os.O_SHLOCK
    +
    +os.O_EXLOCK
    +

    The above constants are extensions and not present if they are not defined by +the C library.

    +
    +

    Changed in version 3.4: Add O_PATH on systems that support it. +Add O_TMPFILE, only available on Linux Kernel 3.11 + or newer.

    +
    +
    + +
    +
    +os.openpty()
    +

    Open a new pseudo-terminal pair. Return a pair of file descriptors +(master, slave) for the pty and the tty, respectively. The new file +descriptors are non-inheritable. For a (slightly) more +portable approach, use the pty module.

    +

    Availability: some flavors of Unix.

    +
    +

    Changed in version 3.4: The new file descriptors are now non-inheritable.

    +
    +
    + +
    +
    +os.pipe()
    +

    Create a pipe. Return a pair of file descriptors (r, w) usable for +reading and writing, respectively. The new file descriptor is +non-inheritable.

    +

    Availability: Unix, Windows.

    +
    +

    Changed in version 3.4: The new file descriptors are now non-inheritable.

    +
    +
    + +
    +
    +os.pipe2(flags)
    +

    Create a pipe with flags set atomically. +flags can be constructed by ORing together one or more of these values: +O_NONBLOCK, O_CLOEXEC. +Return a pair of file descriptors (r, w) usable for reading and writing, +respectively.

    +

    Availability: some flavors of Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.posix_fallocate(fd, offset, len)
    +

    Ensures that enough disk space is allocated for the file specified by fd +starting from offset and continuing for len bytes.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.posix_fadvise(fd, offset, len, advice)
    +

    Announces an intention to access data in a specific pattern thus allowing +the kernel to make optimizations. +The advice applies to the region of the file specified by fd starting at +offset and continuing for len bytes. +advice is one of POSIX_FADV_NORMAL, POSIX_FADV_SEQUENTIAL, +POSIX_FADV_RANDOM, POSIX_FADV_NOREUSE, +POSIX_FADV_WILLNEED or POSIX_FADV_DONTNEED.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.POSIX_FADV_NORMAL
    +
    +os.POSIX_FADV_SEQUENTIAL
    +
    +os.POSIX_FADV_RANDOM
    +
    +os.POSIX_FADV_NOREUSE
    +
    +os.POSIX_FADV_WILLNEED
    +
    +os.POSIX_FADV_DONTNEED
    +

    Flags that can be used in advice in posix_fadvise() that specify +the access pattern that is likely to be used.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.pread(fd, n, offset)
    +

    Read at most n bytes from file descriptor fd at a position of offset, +leaving the file offset unchanged.

    +

    Return a bytestring containing the bytes read. If the end of the file +referred to by fd has been reached, an empty bytes object is returned.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.preadv(fd, buffers, offset, flags=0)
    +

    Read from a file descriptor fd at a position of offset into mutable +bytes-like objects buffers, leaving the file +offset unchanged. Transfer data into each buffer until it is full and then +move on to the next buffer in the sequence to hold the rest of the data.

    +

    The flags argument contains a bitwise OR of zero or more of the following +flags:

    + +

    Return the total number of bytes actually read which can be less than the +total capacity of all the objects.

    +

    The operating system may set a limit (sysconf() value +'SC_IOV_MAX') on the number of buffers that can be used.

    +

    Combine the functionality of os.readv() and os.pread().

    +

    Availability: Linux 2.6.30 and newer, FreeBSD 6.0 and newer, +OpenBSD 2.7 and newer. Using flags requires Linux 4.6 or newer.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +os.RWF_NOWAIT
    +

    Do not wait for data which is not immediately available. If this flag is +specified, the system call will return instantly if it would have to read +data from the backing storage or wait for a lock.

    +

    If some data was successfully read, it will return the number of bytes read. +If no bytes were read, it will return -1 and set errno to +errno.EAGAIN.

    +

    Availability: Linux 4.14 and newer.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +os.RWF_HIPRI
    +

    High priority read/write. Allows block-based filesystems to use polling +of the device, which provides lower latency, but may use additional +resources.

    +

    Currently, on Linux, this feature is usable only on a file descriptor opened +using the O_DIRECT flag.

    +

    Availability: Linux 4.6 and newer.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +os.pwrite(fd, str, offset)
    +

    Write the bytestring in str to file descriptor fd at position of +offset, leaving the file offset unchanged.

    +

    Return the number of bytes actually written.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.pwritev(fd, buffers, offset, flags=0)
    +

    Write the buffers contents to file descriptor fd at a offset offset, +leaving the file offset unchanged. buffers must be a sequence of +bytes-like objects. Buffers are processed in +array order. Entire contents of the first buffer is written before +proceeding to the second, and so on.

    +

    The flags argument contains a bitwise OR of zero or more of the following +flags:

    + +

    Return the total number of bytes actually written.

    +

    The operating system may set a limit (sysconf() value +'SC_IOV_MAX') on the number of buffers that can be used.

    +

    Combine the functionality of os.writev() and os.pwrite().

    +

    Availability: Linux 2.6.30 and newer, FreeBSD 6.0 and newer, +OpenBSD 2.7 and newer. Using flags requires Linux 4.7 or newer.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +os.RWF_DSYNC
    +

    Provide a per-write equivalent of the O_DSYNC open(2) flag. This +flag effect applies only to the data range written by the system call.

    +

    Availability: Linux 4.7 and newer.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +os.RWF_SYNC
    +

    Provide a per-write equivalent of the O_SYNC open(2) flag. This +flag effect applies only to the data range written by the system call.

    +

    Availability: Linux 4.7 and newer.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +os.read(fd, n)
    +

    Read at most n bytes from file descriptor fd.

    +

    Return a bytestring containing the bytes read. If the end of the file +referred to by fd has been reached, an empty bytes object is returned.

    +
    +

    Note

    +

    This function is intended for low-level I/O and must be applied to a file +descriptor as returned by os.open() or pipe(). To read a +“file object” returned by the built-in function open() or by +popen() or fdopen(), or sys.stdin, use its +read() or readline() methods.

    +
    +
    +

    Changed in version 3.5: If the system call is interrupted and the signal handler does not raise an +exception, the function now retries the system call instead of raising an +InterruptedError exception (see PEP 475 for the rationale).

    +
    +
    + +
    +
    +os.sendfile(out, in, offset, count)
    +
    +os.sendfile(out, in, offset, count, [headers, ][trailers, ]flags=0)
    +

    Copy count bytes from file descriptor in to file descriptor out +starting at offset. +Return the number of bytes sent. When EOF is reached return 0.

    +

    The first function notation is supported by all platforms that define +sendfile().

    +

    On Linux, if offset is given as None, the bytes are read from the +current position of in and the position of in is updated.

    +

    The second case may be used on Mac OS X and FreeBSD where headers and +trailers are arbitrary sequences of buffers that are written before and +after the data from in is written. It returns the same as the first case.

    +

    On Mac OS X and FreeBSD, a value of 0 for count specifies to send until +the end of in is reached.

    +

    All platforms support sockets as out file descriptor, and some platforms +allow other types (e.g. regular file, pipe) as well.

    +

    Cross-platform applications should not use headers, trailers and flags +arguments.

    +

    Availability: Unix.

    +
    +

    Note

    +

    For a higher-level wrapper of sendfile(), see +socket.socket.sendfile().

    +
    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.set_blocking(fd, blocking)
    +

    Set the blocking mode of the specified file descriptor. Set the +O_NONBLOCK flag if blocking is False, clear the flag otherwise.

    +

    See also get_blocking() and socket.socket.setblocking().

    +

    Availability: Unix.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +os.SF_NODISKIO
    +
    +os.SF_MNOWAIT
    +
    +os.SF_SYNC
    +

    Parameters to the sendfile() function, if the implementation supports +them.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.readv(fd, buffers)
    +

    Read from a file descriptor fd into a number of mutable bytes-like +objects buffers. Transfer data into each buffer until +it is full and then move on to the next buffer in the sequence to hold the +rest of the data.

    +

    Return the total number of bytes actually read which can be less than the +total capacity of all the objects.

    +

    The operating system may set a limit (sysconf() value +'SC_IOV_MAX') on the number of buffers that can be used.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.tcgetpgrp(fd)
    +

    Return the process group associated with the terminal given by fd (an open +file descriptor as returned by os.open()).

    +

    Availability: Unix.

    +
    + +
    +
    +os.tcsetpgrp(fd, pg)
    +

    Set the process group associated with the terminal given by fd (an open file +descriptor as returned by os.open()) to pg.

    +

    Availability: Unix.

    +
    + +
    +
    +os.ttyname(fd)
    +

    Return a string which specifies the terminal device associated with +file descriptor fd. If fd is not associated with a terminal device, an +exception is raised.

    +

    Availability: Unix.

    +
    + +
    +
    +os.write(fd, str)
    +

    Write the bytestring in str to file descriptor fd.

    +

    Return the number of bytes actually written.

    +
    +

    Note

    +

    This function is intended for low-level I/O and must be applied to a file +descriptor as returned by os.open() or pipe(). To write a “file +object” returned by the built-in function open() or by popen() or +fdopen(), or sys.stdout or sys.stderr, use its +write() method.

    +
    +
    +

    Changed in version 3.5: If the system call is interrupted and the signal handler does not raise an +exception, the function now retries the system call instead of raising an +InterruptedError exception (see PEP 475 for the rationale).

    +
    +
    + +
    +
    +os.writev(fd, buffers)
    +

    Write the contents of buffers to file descriptor fd. buffers must be +a sequence of bytes-like objects. Buffers are +processed in array order. Entire contents of the first buffer is written +before proceeding to the second, and so on.

    +

    Returns the total number of bytes actually written.

    +

    The operating system may set a limit (sysconf() value +'SC_IOV_MAX') on the number of buffers that can be used.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +

    Querying the size of a terminal

    +
    +

    New in version 3.3.

    +
    +
    +
    +os.get_terminal_size(fd=STDOUT_FILENO)
    +

    Return the size of the terminal window as (columns, lines), +tuple of type terminal_size.

    +

    The optional argument fd (default STDOUT_FILENO, or standard +output) specifies which file descriptor should be queried.

    +

    If the file descriptor is not connected to a terminal, an OSError +is raised.

    +

    shutil.get_terminal_size() is the high-level function which +should normally be used, os.get_terminal_size is the low-level +implementation.

    +

    Availability: Unix, Windows.

    +
    + +
    +
    +class os.terminal_size
    +

    A subclass of tuple, holding (columns, lines) of the terminal window size.

    +
    +
    +columns
    +

    Width of the terminal window in characters.

    +
    + +
    +
    +lines
    +

    Height of the terminal window in characters.

    +
    + +
    + +
    +
    +

    Inheritance of File Descriptors

    +
    +

    New in version 3.4.

    +
    +

    A file descriptor has an “inheritable” flag which indicates if the file descriptor +can be inherited by child processes. Since Python 3.4, file descriptors +created by Python are non-inheritable by default.

    +

    On UNIX, non-inheritable file descriptors are closed in child processes at the +execution of a new program, other file descriptors are inherited.

    +

    On Windows, non-inheritable handles and file descriptors are closed in child +processes, except for standard streams (file descriptors 0, 1 and 2: stdin, stdout +and stderr), which are always inherited. Using spawn* functions, +all inheritable handles and all inheritable file descriptors are inherited. +Using the subprocess module, all file descriptors except standard +streams are closed, and inheritable handles are only inherited if the +close_fds parameter is False.

    +
    +
    +os.get_inheritable(fd)
    +

    Get the “inheritable” flag of the specified file descriptor (a boolean).

    +
    + +
    +
    +os.set_inheritable(fd, inheritable)
    +

    Set the “inheritable” flag of the specified file descriptor.

    +
    + +
    +
    +os.get_handle_inheritable(handle)
    +

    Get the “inheritable” flag of the specified handle (a boolean).

    +

    Availability: Windows.

    +
    + +
    +
    +os.set_handle_inheritable(handle, inheritable)
    +

    Set the “inheritable” flag of the specified handle.

    +

    Availability: Windows.

    +
    + +
    +
    +
    +

    Files and Directories

    +

    On some Unix platforms, many of these functions support one or more of these +features:

    +
      +
    • specifying a file descriptor: +For some functions, the path argument can be not only a string giving a path +name, but also a file descriptor. The function will then operate on the file +referred to by the descriptor. (For POSIX systems, Python will call the +f... version of the function.)

      +

      You can check whether or not path can be specified as a file descriptor on +your platform using os.supports_fd. If it is unavailable, using it +will raise a NotImplementedError.

      +

      If the function also supports dir_fd or follow_symlinks arguments, it is +an error to specify one of those when supplying path as a file descriptor.

      +
    • +
    +
      +
    • paths relative to directory descriptors: If dir_fd is not None, it +should be a file descriptor referring to a directory, and the path to operate +on should be relative; path will then be relative to that directory. If the +path is absolute, dir_fd is ignored. (For POSIX systems, Python will call +the ...at or f...at version of the function.)

      +

      You can check whether or not dir_fd is supported on your platform using +os.supports_dir_fd. If it is unavailable, using it will raise a +NotImplementedError.

      +
    • +
    + +
    +
    +os.access(path, mode, *, dir_fd=None, effective_ids=False, follow_symlinks=True)
    +

    Use the real uid/gid to test for access to path. Note that most operations +will use the effective uid/gid, therefore this routine can be used in a +suid/sgid environment to test if the invoking user has the specified access to +path. mode should be F_OK to test the existence of path, or it +can be the inclusive OR of one or more of R_OK, W_OK, and +X_OK to test permissions. Return True if access is allowed, +False if not. See the Unix man page access(2) for more +information.

    +

    This function can support specifying paths relative to directory +descriptors and not following symlinks.

    +

    If effective_ids is True, access() will perform its access +checks using the effective uid/gid instead of the real uid/gid. +effective_ids may not be supported on your platform; you can check whether +or not it is available using os.supports_effective_ids. If it is +unavailable, using it will raise a NotImplementedError.

    +
    +

    Note

    +

    Using access() to check if a user is authorized to e.g. open a file +before actually doing so using open() creates a security hole, +because the user might exploit the short time interval between checking +and opening the file to manipulate it. It’s preferable to use EAFP +techniques. For example:

    +
    if os.access("myfile", os.R_OK):
    +    with open("myfile") as fp:
    +        return fp.read()
    +return "some default data"
    +
    +
    +

    is better written as:

    +
    try:
    +    fp = open("myfile")
    +except PermissionError:
    +    return "some default data"
    +else:
    +    with fp:
    +        return fp.read()
    +
    +
    +
    +
    +

    Note

    +

    I/O operations may fail even when access() indicates that they would +succeed, particularly for operations on network filesystems which may have +permissions semantics beyond the usual POSIX permission-bit model.

    +
    +
    +

    Changed in version 3.3: Added the dir_fd, effective_ids, and follow_symlinks parameters.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.F_OK
    +
    +os.R_OK
    +
    +os.W_OK
    +
    +os.X_OK
    +

    Values to pass as the mode parameter of access() to test the +existence, readability, writability and executability of path, +respectively.

    +
    + +
    +
    +os.chdir(path)
    +

    Change the current working directory to path.

    +

    This function can support specifying a file descriptor. The +descriptor must refer to an opened directory, not an open file.

    +

    This function can raise OSError and subclasses such as +FileNotFoundError, PermissionError, and NotADirectoryError.

    +
    +

    New in version 3.3: Added support for specifying path as a file descriptor +on some platforms.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.chflags(path, flags, *, follow_symlinks=True)
    +

    Set the flags of path to the numeric flags. flags may take a combination +(bitwise OR) of the following values (as defined in the stat module):

    + +

    This function can support not following symlinks.

    +

    Availability: Unix.

    +
    +

    New in version 3.3: The follow_symlinks argument.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.chmod(path, mode, *, dir_fd=None, follow_symlinks=True)
    +

    Change the mode of path to the numeric mode. mode may take one of the +following values (as defined in the stat module) or bitwise ORed +combinations of them:

    + +

    This function can support specifying a file descriptor, +paths relative to directory descriptors and not +following symlinks.

    +
    +

    Note

    +

    Although Windows supports chmod(), you can only set the file’s +read-only flag with it (via the stat.S_IWRITE and stat.S_IREAD +constants or a corresponding integer value). All other bits are ignored.

    +
    +
    +

    New in version 3.3: Added support for specifying path as an open file descriptor, +and the dir_fd and follow_symlinks arguments.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.chown(path, uid, gid, *, dir_fd=None, follow_symlinks=True)
    +

    Change the owner and group id of path to the numeric uid and gid. To +leave one of the ids unchanged, set it to -1.

    +

    This function can support specifying a file descriptor, +paths relative to directory descriptors and not +following symlinks.

    +

    See shutil.chown() for a higher-level function that accepts names in +addition to numeric ids.

    +

    Availability: Unix.

    +
    +

    New in version 3.3: Added support for specifying an open file descriptor for path, +and the dir_fd and follow_symlinks arguments.

    +
    +
    +

    Changed in version 3.6: Supports a path-like object.

    +
    +
    + +
    +
    +os.chroot(path)
    +

    Change the root directory of the current process to path.

    +

    Availability: Unix.

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.fchdir(fd)
    +

    Change the current working directory to the directory represented by the file +descriptor fd. The descriptor must refer to an opened directory, not an +open file. As of Python 3.3, this is equivalent to os.chdir(fd).

    +

    Availability: Unix.

    +
    + +
    +
    +os.getcwd()
    +

    Return a string representing the current working directory.

    +
    + +
    +
    +os.getcwdb()
    +

    Return a bytestring representing the current working directory.

    +
    + +
    +
    +os.lchflags(path, flags)
    +

    Set the flags of path to the numeric flags, like chflags(), but do +not follow symbolic links. As of Python 3.3, this is equivalent to +os.chflags(path, flags, follow_symlinks=False).

    +

    Availability: Unix.

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.lchmod(path, mode)
    +

    Change the mode of path to the numeric mode. If path is a symlink, this +affects the symlink rather than the target. See the docs for chmod() +for possible values of mode. As of Python 3.3, this is equivalent to +os.chmod(path, mode, follow_symlinks=False).

    +

    Availability: Unix.

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.lchown(path, uid, gid)
    +

    Change the owner and group id of path to the numeric uid and gid. This +function will not follow symbolic links. As of Python 3.3, this is equivalent +to os.chown(path, uid, gid, follow_symlinks=False).

    +

    Availability: Unix.

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    + +

    Create a hard link pointing to src named dst.

    +

    This function can support specifying src_dir_fd and/or dst_dir_fd to +supply paths relative to directory descriptors, and not +following symlinks.

    +

    Availability: Unix, Windows.

    +
    +

    Changed in version 3.2: Added Windows support.

    +
    +
    +

    New in version 3.3: Added the src_dir_fd, dst_dir_fd, and follow_symlinks arguments.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object for src and dst.

    +
    +
    + +
    +
    +os.listdir(path='.')
    +

    Return a list containing the names of the entries in the directory given by +path. The list is in arbitrary order, and does not include the special +entries '.' and '..' even if they are present in the directory.

    +

    path may be a path-like object. If path is of type bytes +(directly or indirectly through the PathLike interface), +the filenames returned will also be of type bytes; +in all other circumstances, they will be of type str.

    +

    This function can also support specifying a file descriptor; the file descriptor must refer to a directory.

    +
    +

    Note

    +

    To encode str filenames to bytes, use fsencode().

    +
    +
    +

    See also

    +

    The scandir() function returns directory entries along with +file attribute information, giving better performance for many +common use cases.

    +
    +
    +

    Changed in version 3.2: The path parameter became optional.

    +
    +
    +

    New in version 3.3: Added support for specifying an open file descriptor for path.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.lstat(path, *, dir_fd=None)
    +

    Perform the equivalent of an lstat() system call on the given path. +Similar to stat(), but does not follow symbolic links. Return a +stat_result object.

    +

    On platforms that do not support symbolic links, this is an alias for +stat().

    +

    As of Python 3.3, this is equivalent to os.stat(path, dir_fd=dir_fd, +follow_symlinks=False).

    +

    This function can also support paths relative to directory descriptors.

    +
    +

    See also

    +

    The stat() function.

    +
    +
    +

    Changed in version 3.2: Added support for Windows 6.0 (Vista) symbolic links.

    +
    +
    +

    Changed in version 3.3: Added the dir_fd parameter.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object for src and dst.

    +
    +
    + +
    +
    +os.mkdir(path, mode=0o777, *, dir_fd=None)
    +

    Create a directory named path with numeric mode mode.

    +

    If the directory already exists, FileExistsError is raised.

    +

    On some systems, mode is ignored. Where it is used, the current umask +value is first masked out. If bits other than the last 9 (i.e. the last 3 +digits of the octal representation of the mode) are set, their meaning is +platform-dependent. On some platforms, they are ignored and you should call +chmod() explicitly to set them.

    +

    This function can also support paths relative to directory descriptors.

    +

    It is also possible to create temporary directories; see the +tempfile module’s tempfile.mkdtemp() function.

    +
    +

    New in version 3.3: The dir_fd argument.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.makedirs(name, mode=0o777, exist_ok=False)
    +

    Recursive directory creation function. Like mkdir(), but makes all +intermediate-level directories needed to contain the leaf directory.

    +

    The mode parameter is passed to mkdir() for creating the leaf +directory; see the mkdir() description for how it +is interpreted. To set the file permission bits of any newly-created parent +directories you can set the umask before invoking makedirs(). The +file permission bits of existing parent directories are not changed.

    +

    If exist_ok is False (the default), an FileExistsError is +raised if the target directory already exists.

    +
    +

    Note

    +

    makedirs() will become confused if the path elements to create +include pardir (eg. “..” on UNIX systems).

    +
    +

    This function handles UNC paths correctly.

    +
    +

    New in version 3.2: The exist_ok parameter.

    +
    +
    +

    Changed in version 3.4.1: Before Python 3.4.1, if exist_ok was True and the directory existed, +makedirs() would still raise an error if mode did not match the +mode of the existing directory. Since this behavior was impossible to +implement safely, it was removed in Python 3.4.1. See bpo-21082.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    +

    Changed in version 3.7: The mode argument no longer affects the file permission bits of +newly-created intermediate-level directories.

    +
    +
    + +
    +
    +os.mkfifo(path, mode=0o666, *, dir_fd=None)
    +

    Create a FIFO (a named pipe) named path with numeric mode mode. +The current umask value is first masked out from the mode.

    +

    This function can also support paths relative to directory descriptors.

    +

    FIFOs are pipes that can be accessed like regular files. FIFOs exist until they +are deleted (for example with os.unlink()). Generally, FIFOs are used as +rendezvous between “client” and “server” type processes: the server opens the +FIFO for reading, and the client opens it for writing. Note that mkfifo() +doesn’t open the FIFO — it just creates the rendezvous point.

    +

    Availability: Unix.

    +
    +

    New in version 3.3: The dir_fd argument.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.mknod(path, mode=0o600, device=0, *, dir_fd=None)
    +

    Create a filesystem node (file, device special file or named pipe) named +path. mode specifies both the permissions to use and the type of node +to be created, being combined (bitwise OR) with one of stat.S_IFREG, +stat.S_IFCHR, stat.S_IFBLK, and stat.S_IFIFO (those constants are +available in stat). For stat.S_IFCHR and stat.S_IFBLK, +device defines the newly created device special file (probably using +os.makedev()), otherwise it is ignored.

    +

    This function can also support paths relative to directory descriptors.

    +

    Availability: Unix.

    +
    +

    New in version 3.3: The dir_fd argument.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.major(device)
    +

    Extract the device major number from a raw device number (usually the +st_dev or st_rdev field from stat).

    +
    + +
    +
    +os.minor(device)
    +

    Extract the device minor number from a raw device number (usually the +st_dev or st_rdev field from stat).

    +
    + +
    +
    +os.makedev(major, minor)
    +

    Compose a raw device number from the major and minor device numbers.

    +
    + +
    +
    +os.pathconf(path, name)
    +

    Return system configuration information relevant to a named file. name +specifies the configuration value to retrieve; it may be a string which is the +name of a defined system value; these names are specified in a number of +standards (POSIX.1, Unix 95, Unix 98, and others). Some platforms define +additional names as well. The names known to the host operating system are +given in the pathconf_names dictionary. For configuration variables not +included in that mapping, passing an integer for name is also accepted.

    +

    If name is a string and is not known, ValueError is raised. If a +specific value for name is not supported by the host system, even if it is +included in pathconf_names, an OSError is raised with +errno.EINVAL for the error number.

    +

    This function can support specifying a file descriptor.

    +

    Availability: Unix.

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.pathconf_names
    +

    Dictionary mapping names accepted by pathconf() and fpathconf() to +the integer values defined for those names by the host operating system. This +can be used to determine the set of names known to the system.

    +

    Availability: Unix.

    +
    + +
    + +

    Return a string representing the path to which the symbolic link points. The +result may be either an absolute or relative pathname; if it is relative, it +may be converted to an absolute pathname using +os.path.join(os.path.dirname(path), result).

    +

    If the path is a string object (directly or indirectly through a +PathLike interface), the result will also be a string object, +and the call may raise a UnicodeDecodeError. If the path is a bytes +object (direct or indirectly), the result will be a bytes object.

    +

    This function can also support paths relative to directory descriptors.

    +

    Availability: Unix, Windows.

    +
    +

    Changed in version 3.2: Added support for Windows 6.0 (Vista) symbolic links.

    +
    +
    +

    New in version 3.3: The dir_fd argument.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.remove(path, *, dir_fd=None)
    +

    Remove (delete) the file path. If path is a directory, an +IsADirectoryError is raised. Use rmdir() to remove directories.

    +

    This function can support paths relative to directory descriptors.

    +

    On Windows, attempting to remove a file that is in use causes an exception to +be raised; on Unix, the directory entry is removed but the storage allocated +to the file is not made available until the original file is no longer in use.

    +

    This function is semantically identical to unlink().

    +
    +

    New in version 3.3: The dir_fd argument.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.removedirs(name)
    +

    Remove directories recursively. Works like rmdir() except that, if the +leaf directory is successfully removed, removedirs() tries to +successively remove every parent directory mentioned in path until an error +is raised (which is ignored, because it generally means that a parent directory +is not empty). For example, os.removedirs('foo/bar/baz') will first remove +the directory 'foo/bar/baz', and then remove 'foo/bar' and 'foo' if +they are empty. Raises OSError if the leaf directory could not be +successfully removed.

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.rename(src, dst, *, src_dir_fd=None, dst_dir_fd=None)
    +

    Rename the file or directory src to dst. If dst exists, the operation +will fail with an OSError subclass in a number of cases:

    +

    On Windows, if dst exists a FileExistsError is always raised.

    +

    On Unix, if src is a file and dst is a directory or vice-versa, an +IsADirectoryError or a NotADirectoryError will be raised +respectively. If both are directories and dst is empty, dst will be +silently replaced. If dst is a non-empty directory, an OSError +is raised. If both are files, dst it will be replaced silently if the user +has permission. The operation may fail on some Unix flavors if src and +dst are on different filesystems. If successful, the renaming will be an +atomic operation (this is a POSIX requirement).

    +

    This function can support specifying src_dir_fd and/or dst_dir_fd to +supply paths relative to directory descriptors.

    +

    If you want cross-platform overwriting of the destination, use replace().

    +
    +

    New in version 3.3: The src_dir_fd and dst_dir_fd arguments.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object for src and dst.

    +
    +
    + +
    +
    +os.renames(old, new)
    +

    Recursive directory or file renaming function. Works like rename(), except +creation of any intermediate directories needed to make the new pathname good is +attempted first. After the rename, directories corresponding to rightmost path +segments of the old name will be pruned away using removedirs().

    +
    +

    Note

    +

    This function can fail with the new directory structure made if you lack +permissions needed to remove the leaf directory or file.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object for old and new.

    +
    +
    + +
    +
    +os.replace(src, dst, *, src_dir_fd=None, dst_dir_fd=None)
    +

    Rename the file or directory src to dst. If dst is a directory, +OSError will be raised. If dst exists and is a file, it will +be replaced silently if the user has permission. The operation may fail +if src and dst are on different filesystems. If successful, +the renaming will be an atomic operation (this is a POSIX requirement).

    +

    This function can support specifying src_dir_fd and/or dst_dir_fd to +supply paths relative to directory descriptors.

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object for src and dst.

    +
    +
    + +
    +
    +os.rmdir(path, *, dir_fd=None)
    +

    Remove (delete) the directory path. If the directory does not exist or is +not empty, an FileNotFoundError or an OSError is raised +respectively. In order to remove whole directory trees, +shutil.rmtree() can be used.

    +

    This function can support paths relative to directory descriptors.

    +
    +

    New in version 3.3: The dir_fd parameter.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.scandir(path='.')
    +

    Return an iterator of os.DirEntry objects corresponding to the +entries in the directory given by path. The entries are yielded in +arbitrary order, and the special entries '.' and '..' are not +included.

    +

    Using scandir() instead of listdir() can significantly +increase the performance of code that also needs file type or file +attribute information, because os.DirEntry objects expose this +information if the operating system provides it when scanning a directory. +All os.DirEntry methods may perform a system call, but +is_dir() and is_file() usually only +require a system call for symbolic links; os.DirEntry.stat() +always requires a system call on Unix but only requires one for +symbolic links on Windows.

    +

    path may be a path-like object. If path is of type bytes +(directly or indirectly through the PathLike interface), +the type of the name and path +attributes of each os.DirEntry will be bytes; in all other +circumstances, they will be of type str.

    +

    This function can also support specifying a file descriptor; the file descriptor must refer to a directory.

    +

    The scandir() iterator supports the context manager protocol +and has the following method:

    +
    +
    +scandir.close()
    +

    Close the iterator and free acquired resources.

    +

    This is called automatically when the iterator is exhausted or garbage +collected, or when an error happens during iterating. However it +is advisable to call it explicitly or use the with +statement.

    +
    +

    New in version 3.6.

    +
    +
    + +

    The following example shows a simple use of scandir() to display all +the files (excluding directories) in the given path that don’t start with +'.'. The entry.is_file() call will generally not make an additional +system call:

    +
    with os.scandir(path) as it:
    +    for entry in it:
    +        if not entry.name.startswith('.') and entry.is_file():
    +            print(entry.name)
    +
    +
    +
    +

    Note

    +

    On Unix-based systems, scandir() uses the system’s +opendir() +and +readdir() +functions. On Windows, it uses the Win32 +FindFirstFileW +and +FindNextFileW +functions.

    +
    +
    +

    New in version 3.5.

    +
    +
    +

    New in version 3.6: Added support for the context manager protocol and the +close() method. If a scandir() iterator is neither +exhausted nor explicitly closed a ResourceWarning will be emitted +in its destructor.

    +

    The function accepts a path-like object.

    +
    +
    +

    Changed in version 3.7: Added support for file descriptors on Unix.

    +
    +
    + +
    +
    +class os.DirEntry
    +

    Object yielded by scandir() to expose the file path and other file +attributes of a directory entry.

    +

    scandir() will provide as much of this information as possible without +making additional system calls. When a stat() or lstat() system call +is made, the os.DirEntry object will cache the result.

    +

    os.DirEntry instances are not intended to be stored in long-lived data +structures; if you know the file metadata has changed or if a long time has +elapsed since calling scandir(), call os.stat(entry.path) to fetch +up-to-date information.

    +

    Because the os.DirEntry methods can make operating system calls, they may +also raise OSError. If you need very fine-grained +control over errors, you can catch OSError when calling one of the +os.DirEntry methods and handle as appropriate.

    +

    To be directly usable as a path-like object, os.DirEntry +implements the PathLike interface.

    +

    Attributes and methods on a os.DirEntry instance are as follows:

    +
    +
    +name
    +

    The entry’s base filename, relative to the scandir() path +argument.

    +

    The name attribute will be bytes if the scandir() +path argument is of type bytes and str otherwise. Use +fsdecode() to decode byte filenames.

    +
    + +
    +
    +path
    +

    The entry’s full path name: equivalent to os.path.join(scandir_path, +entry.name) where scandir_path is the scandir() path +argument. The path is only absolute if the scandir() path +argument was absolute. If the scandir() path +argument was a file descriptor, the path +attribute is the same as the name attribute.

    +

    The path attribute will be bytes if the scandir() +path argument is of type bytes and str otherwise. Use +fsdecode() to decode byte filenames.

    +
    + +
    +
    +inode()
    +

    Return the inode number of the entry.

    +

    The result is cached on the os.DirEntry object. Use +os.stat(entry.path, follow_symlinks=False).st_ino to fetch up-to-date +information.

    +

    On the first, uncached call, a system call is required on Windows but +not on Unix.

    +
    + +
    +
    +is_dir(*, follow_symlinks=True)
    +

    Return True if this entry is a directory or a symbolic link pointing +to a directory; return False if the entry is or points to any other +kind of file, or if it doesn’t exist anymore.

    +

    If follow_symlinks is False, return True only if this entry +is a directory (without following symlinks); return False if the +entry is any other kind of file or if it doesn’t exist anymore.

    +

    The result is cached on the os.DirEntry object, with a separate cache +for follow_symlinks True and False. Call os.stat() along +with stat.S_ISDIR() to fetch up-to-date information.

    +

    On the first, uncached call, no system call is required in most cases. +Specifically, for non-symlinks, neither Windows or Unix require a system +call, except on certain Unix file systems, such as network file systems, +that return dirent.d_type == DT_UNKNOWN. If the entry is a symlink, +a system call will be required to follow the symlink unless +follow_symlinks is False.

    +

    This method can raise OSError, such as PermissionError, +but FileNotFoundError is caught and not raised.

    +
    + +
    +
    +is_file(*, follow_symlinks=True)
    +

    Return True if this entry is a file or a symbolic link pointing to a +file; return False if the entry is or points to a directory or other +non-file entry, or if it doesn’t exist anymore.

    +

    If follow_symlinks is False, return True only if this entry +is a file (without following symlinks); return False if the entry is +a directory or other non-file entry, or if it doesn’t exist anymore.

    +

    The result is cached on the os.DirEntry object. Caching, system calls +made, and exceptions raised are as per is_dir().

    +
    + +
    + +

    Return True if this entry is a symbolic link (even if broken); +return False if the entry points to a directory or any kind of file, +or if it doesn’t exist anymore.

    +

    The result is cached on the os.DirEntry object. Call +os.path.islink() to fetch up-to-date information.

    +

    On the first, uncached call, no system call is required in most cases. +Specifically, neither Windows or Unix require a system call, except on +certain Unix file systems, such as network file systems, that return +dirent.d_type == DT_UNKNOWN.

    +

    This method can raise OSError, such as PermissionError, +but FileNotFoundError is caught and not raised.

    +
    + +
    +
    +stat(*, follow_symlinks=True)
    +

    Return a stat_result object for this entry. This method +follows symbolic links by default; to stat a symbolic link add the +follow_symlinks=False argument.

    +

    On Unix, this method always requires a system call. On Windows, it +only requires a system call if follow_symlinks is True and the +entry is a symbolic link.

    +

    On Windows, the st_ino, st_dev and st_nlink attributes of the +stat_result are always set to zero. Call os.stat() to +get these attributes.

    +

    The result is cached on the os.DirEntry object, with a separate cache +for follow_symlinks True and False. Call os.stat() to +fetch up-to-date information.

    +
    + +

    Note that there is a nice correspondence between several attributes +and methods of os.DirEntry and of pathlib.Path. In +particular, the name attribute has the same +meaning, as do the is_dir(), is_file(), is_symlink() +and stat() methods.

    +
    +

    New in version 3.5.

    +
    +
    +

    Changed in version 3.6: Added support for the PathLike interface. Added support +for bytes paths on Windows.

    +
    +
    + +
    +
    +os.stat(path, *, dir_fd=None, follow_symlinks=True)
    +

    Get the status of a file or a file descriptor. Perform the equivalent of a +stat() system call on the given path. path may be specified as +either a string or bytes – directly or indirectly through the PathLike +interface – or as an open file descriptor. Return a stat_result +object.

    +

    This function normally follows symlinks; to stat a symlink add the argument +follow_symlinks=False, or use lstat().

    +

    This function can support specifying a file descriptor and +not following symlinks.

    +

    Example:

    +
    >>> import os
    +>>> statinfo = os.stat('somefile.txt')
    +>>> statinfo
    +os.stat_result(st_mode=33188, st_ino=7876932, st_dev=234881026,
    +st_nlink=1, st_uid=501, st_gid=501, st_size=264, st_atime=1297230295,
    +st_mtime=1297230027, st_ctime=1297230027)
    +>>> statinfo.st_size
    +264
    +
    +
    +
    +

    See also

    +

    fstat() and lstat() functions.

    +
    +
    +

    New in version 3.3: Added the dir_fd and follow_symlinks arguments, specifying a file +descriptor instead of a path.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +class os.stat_result
    +

    Object whose attributes correspond roughly to the members of the +stat structure. It is used for the result of os.stat(), +os.fstat() and os.lstat().

    +

    Attributes:

    +
    +
    +st_mode
    +

    File mode: file type and file mode bits (permissions).

    +
    + +
    +
    +st_ino
    +

    Platform dependent, but if non-zero, uniquely identifies the +file for a given value of st_dev. Typically:

    +
      +
    • the inode number on Unix,

    • +
    • the file index on +Windows

    • +
    +
    + +
    +
    +st_dev
    +

    Identifier of the device on which this file resides.

    +
    + +
    + +

    Number of hard links.

    +
    + +
    +
    +st_uid
    +

    User identifier of the file owner.

    +
    + +
    +
    +st_gid
    +

    Group identifier of the file owner.

    +
    + +
    +
    +st_size
    +

    Size of the file in bytes, if it is a regular file or a symbolic link. +The size of a symbolic link is the length of the pathname it contains, +without a terminating null byte.

    +
    + +

    Timestamps:

    +
    +
    +st_atime
    +

    Time of most recent access expressed in seconds.

    +
    + +
    +
    +st_mtime
    +

    Time of most recent content modification expressed in seconds.

    +
    + +
    +
    +st_ctime
    +

    Platform dependent:

    +
      +
    • the time of most recent metadata change on Unix,

    • +
    • the time of creation on Windows, expressed in seconds.

    • +
    +
    + +
    +
    +st_atime_ns
    +

    Time of most recent access expressed in nanoseconds as an integer.

    +
    + +
    +
    +st_mtime_ns
    +

    Time of most recent content modification expressed in nanoseconds as an +integer.

    +
    + +
    +
    +st_ctime_ns
    +

    Platform dependent:

    +
      +
    • the time of most recent metadata change on Unix,

    • +
    • the time of creation on Windows, expressed in nanoseconds as an +integer.

    • +
    +
    + +
    +

    Note

    +

    The exact meaning and resolution of the st_atime, +st_mtime, and st_ctime attributes depend on the operating +system and the file system. For example, on Windows systems using the FAT +or FAT32 file systems, st_mtime has 2-second resolution, and +st_atime has only 1-day resolution. See your operating system +documentation for details.

    +

    Similarly, although st_atime_ns, st_mtime_ns, +and st_ctime_ns are always expressed in nanoseconds, many +systems do not provide nanosecond precision. On systems that do +provide nanosecond precision, the floating-point object used to +store st_atime, st_mtime, and st_ctime +cannot preserve all of it, and as such will be slightly inexact. +If you need the exact timestamps you should always use +st_atime_ns, st_mtime_ns, and st_ctime_ns.

    +
    +

    On some Unix systems (such as Linux), the following attributes may also be +available:

    +
    +
    +st_blocks
    +

    Number of 512-byte blocks allocated for file. +This may be smaller than st_size/512 when the file has holes.

    +
    + +
    +
    +st_blksize
    +

    “Preferred” blocksize for efficient file system I/O. Writing to a file in +smaller chunks may cause an inefficient read-modify-rewrite.

    +
    + +
    +
    +st_rdev
    +

    Type of device if an inode device.

    +
    + +
    +
    +st_flags
    +

    User defined flags for file.

    +
    + +

    On other Unix systems (such as FreeBSD), the following attributes may be +available (but may be only filled out if root tries to use them):

    +
    +
    +st_gen
    +

    File generation number.

    +
    + +
    +
    +st_birthtime
    +

    Time of file creation.

    +
    + +

    On Solaris and derivatives, the following attributes may also be +available:

    +
    +
    +st_fstype
    +

    String that uniquely identifies the type of the filesystem that +contains the file.

    +
    + +

    On Mac OS systems, the following attributes may also be available:

    +
    +
    +st_rsize
    +

    Real size of the file.

    +
    + +
    +
    +st_creator
    +

    Creator of the file.

    +
    + +
    +
    +st_type
    +

    File type.

    +
    + +

    On Windows systems, the following attribute is also available:

    +
    +
    +st_file_attributes
    +

    Windows file attributes: dwFileAttributes member of the +BY_HANDLE_FILE_INFORMATION structure returned by +GetFileInformationByHandle(). See the FILE_ATTRIBUTE_* +constants in the stat module.

    +
    + +

    The standard module stat defines functions and constants that are +useful for extracting information from a stat structure. (On +Windows, some items are filled with dummy values.)

    +

    For backward compatibility, a stat_result instance is also +accessible as a tuple of at least 10 integers giving the most important (and +portable) members of the stat structure, in the order +st_mode, st_ino, st_dev, st_nlink, +st_uid, st_gid, st_size, st_atime, +st_mtime, st_ctime. More items may be added at the end by +some implementations. For compatibility with older Python versions, +accessing stat_result as a tuple always returns integers.

    +
    +

    New in version 3.3: Added the st_atime_ns, st_mtime_ns, and +st_ctime_ns members.

    +
    +
    +

    New in version 3.5: Added the st_file_attributes member on Windows.

    +
    +
    +

    Changed in version 3.5: Windows now returns the file index as st_ino when +available.

    +
    +
    +

    New in version 3.7: Added the st_fstype member to Solaris/derivatives.

    +
    +
    + +
    +
    +os.statvfs(path)
    +

    Perform a statvfs() system call on the given path. The return value is +an object whose attributes describe the filesystem on the given path, and +correspond to the members of the statvfs structure, namely: +f_bsize, f_frsize, f_blocks, f_bfree, +f_bavail, f_files, f_ffree, f_favail, +f_flag, f_namemax, f_fsid.

    +

    Two module-level constants are defined for the f_flag attribute’s +bit-flags: if ST_RDONLY is set, the filesystem is mounted +read-only, and if ST_NOSUID is set, the semantics of +setuid/setgid bits are disabled or not supported.

    +

    Additional module-level constants are defined for GNU/glibc based systems. +These are ST_NODEV (disallow access to device special files), +ST_NOEXEC (disallow program execution), ST_SYNCHRONOUS +(writes are synced at once), ST_MANDLOCK (allow mandatory locks on an FS), +ST_WRITE (write on file/directory/symlink), ST_APPEND +(append-only file), ST_IMMUTABLE (immutable file), ST_NOATIME +(do not update access times), ST_NODIRATIME (do not update directory access +times), ST_RELATIME (update atime relative to mtime/ctime).

    +

    This function can support specifying a file descriptor.

    +

    Availability: Unix.

    +
    +

    Changed in version 3.2: The ST_RDONLY and ST_NOSUID constants were added.

    +
    +
    +

    New in version 3.3: Added support for specifying an open file descriptor for path.

    +
    +
    +

    Changed in version 3.4: The ST_NODEV, ST_NOEXEC, ST_SYNCHRONOUS, +ST_MANDLOCK, ST_WRITE, ST_APPEND, +ST_IMMUTABLE, ST_NOATIME, ST_NODIRATIME, +and ST_RELATIME constants were added.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    +

    New in version 3.7: Added f_fsid.

    +
    +
    + +
    +
    +os.supports_dir_fd
    +

    A Set object indicating which functions in the +os module permit use of their dir_fd parameter. Different platforms +provide different functionality, and an option that might work on one might +be unsupported on another. For consistency’s sakes, functions that support +dir_fd always allow specifying the parameter, but will raise an exception +if the functionality is not actually available.

    +

    To check whether a particular function permits use of its dir_fd +parameter, use the in operator on supports_dir_fd. As an example, +this expression determines whether the dir_fd parameter of os.stat() +is locally available:

    +
    os.stat in os.supports_dir_fd
    +
    +
    +

    Currently dir_fd parameters only work on Unix platforms; none of them work +on Windows.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.supports_effective_ids
    +

    A Set object indicating which functions in the +os module permit use of the effective_ids parameter for +os.access(). If the local platform supports it, the collection will +contain os.access(), otherwise it will be empty.

    +

    To check whether you can use the effective_ids parameter for +os.access(), use the in operator on supports_effective_ids, +like so:

    +
    os.access in os.supports_effective_ids
    +
    +
    +

    Currently effective_ids only works on Unix platforms; it does not work on +Windows.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.supports_fd
    +

    A Set object indicating which functions in the +os module permit specifying their path parameter as an open file +descriptor. Different platforms provide different functionality, and an +option that might work on one might be unsupported on another. For +consistency’s sakes, functions that support fd always allow specifying +the parameter, but will raise an exception if the functionality is not +actually available.

    +

    To check whether a particular function permits specifying an open file +descriptor for its path parameter, use the in operator on +supports_fd. As an example, this expression determines whether +os.chdir() accepts open file descriptors when called on your local +platform:

    +
    os.chdir in os.supports_fd
    +
    +
    +
    +

    New in version 3.3.

    +
    +
    + +
    + +

    A Set object indicating which functions in the +os module permit use of their follow_symlinks parameter. Different +platforms provide different functionality, and an option that might work on +one might be unsupported on another. For consistency’s sakes, functions that +support follow_symlinks always allow specifying the parameter, but will +raise an exception if the functionality is not actually available.

    +

    To check whether a particular function permits use of its follow_symlinks +parameter, use the in operator on supports_follow_symlinks. As an +example, this expression determines whether the follow_symlinks parameter +of os.stat() is locally available:

    +
    os.stat in os.supports_follow_symlinks
    +
    +
    +
    +

    New in version 3.3.

    +
    +
    + +
    + +

    Create a symbolic link pointing to src named dst.

    +

    On Windows, a symlink represents either a file or a directory, and does not +morph to the target dynamically. If the target is present, the type of the +symlink will be created to match. Otherwise, the symlink will be created +as a directory if target_is_directory is True or a file symlink (the +default) otherwise. On non-Windows platforms, target_is_directory is ignored.

    +

    Symbolic link support was introduced in Windows 6.0 (Vista). symlink() +will raise a NotImplementedError on Windows versions earlier than 6.0.

    +

    This function can support paths relative to directory descriptors.

    +
    +

    Note

    +

    On Windows, the SeCreateSymbolicLinkPrivilege is required in order to +successfully create symlinks. This privilege is not typically granted to +regular users but is available to accounts which can escalate privileges +to the administrator level. Either obtaining the privilege or running your +application as an administrator are ways to successfully create symlinks.

    +

    OSError is raised when the function is called by an unprivileged +user.

    +
    +

    Availability: Unix, Windows.

    +
    +

    Changed in version 3.2: Added support for Windows 6.0 (Vista) symbolic links.

    +
    +
    +

    New in version 3.3: Added the dir_fd argument, and now allow target_is_directory +on non-Windows platforms.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object for src and dst.

    +
    +
    + +
    +
    +os.sync()
    +

    Force write of everything to disk.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.truncate(path, length)
    +

    Truncate the file corresponding to path, so that it is at most +length bytes in size.

    +

    This function can support specifying a file descriptor.

    +

    Availability: Unix, Windows.

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.5: Added support for Windows

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    + +

    Remove (delete) the file path. This function is semantically +identical to remove(); the unlink name is its +traditional Unix name. Please see the documentation for +remove() for further information.

    +
    +

    New in version 3.3: The dir_fd parameter.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.utime(path, times=None, *, [ns, ]dir_fd=None, follow_symlinks=True)
    +

    Set the access and modified times of the file specified by path.

    +

    utime() takes two optional parameters, times and ns. +These specify the times set on path and are used as follows:

    +
      +
    • If ns is specified, +it must be a 2-tuple of the form (atime_ns, mtime_ns) +where each member is an int expressing nanoseconds.

    • +
    • If times is not None, +it must be a 2-tuple of the form (atime, mtime) +where each member is an int or float expressing seconds.

    • +
    • If times is None and ns is unspecified, +this is equivalent to specifying ns=(atime_ns, mtime_ns) +where both times are the current time.

    • +
    +

    It is an error to specify tuples for both times and ns.

    +

    Whether a directory can be given for path +depends on whether the operating system implements directories as files +(for example, Windows does not). Note that the exact times you set here may +not be returned by a subsequent stat() call, depending on the +resolution with which your operating system records access and modification +times; see stat(). The best way to preserve exact times is to +use the st_atime_ns and st_mtime_ns fields from the os.stat() +result object with the ns parameter to utime.

    +

    This function can support specifying a file descriptor, +paths relative to directory descriptors and not +following symlinks.

    +
    +

    New in version 3.3: Added support for specifying an open file descriptor for path, +and the dir_fd, follow_symlinks, and ns parameters.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.walk(top, topdown=True, onerror=None, followlinks=False)
    +

    Generate the file names in a directory tree by walking the tree +either top-down or bottom-up. For each directory in the tree rooted at directory +top (including top itself), it yields a 3-tuple (dirpath, dirnames, +filenames).

    +

    dirpath is a string, the path to the directory. dirnames is a list of the +names of the subdirectories in dirpath (excluding '.' and '..'). +filenames is a list of the names of the non-directory files in dirpath. +Note that the names in the lists contain no path components. To get a full path +(which begins with top) to a file or directory in dirpath, do +os.path.join(dirpath, name).

    +

    If optional argument topdown is True or not specified, the triple for a +directory is generated before the triples for any of its subdirectories +(directories are generated top-down). If topdown is False, the triple +for a directory is generated after the triples for all of its subdirectories +(directories are generated bottom-up). No matter the value of topdown, the +list of subdirectories is retrieved before the tuples for the directory and +its subdirectories are generated.

    +

    When topdown is True, the caller can modify the dirnames list in-place +(perhaps using del or slice assignment), and walk() will only +recurse into the subdirectories whose names remain in dirnames; this can be +used to prune the search, impose a specific order of visiting, or even to inform +walk() about directories the caller creates or renames before it resumes +walk() again. Modifying dirnames when topdown is False has +no effect on the behavior of the walk, because in bottom-up mode the directories +in dirnames are generated before dirpath itself is generated.

    +

    By default, errors from the scandir() call are ignored. If optional +argument onerror is specified, it should be a function; it will be called with +one argument, an OSError instance. It can report the error to continue +with the walk, or raise the exception to abort the walk. Note that the filename +is available as the filename attribute of the exception object.

    +

    By default, walk() will not walk down into symbolic links that resolve to +directories. Set followlinks to True to visit directories pointed to by +symlinks, on systems that support them.

    +
    +

    Note

    +

    Be aware that setting followlinks to True can lead to infinite +recursion if a link points to a parent directory of itself. walk() +does not keep track of the directories it visited already.

    +
    +
    +

    Note

    +

    If you pass a relative pathname, don’t change the current working directory +between resumptions of walk(). walk() never changes the current +directory, and assumes that its caller doesn’t either.

    +
    +

    This example displays the number of bytes taken by non-directory files in each +directory under the starting directory, except that it doesn’t look under any +CVS subdirectory:

    +
    import os
    +from os.path import join, getsize
    +for root, dirs, files in os.walk('python/Lib/email'):
    +    print(root, "consumes", end=" ")
    +    print(sum(getsize(join(root, name)) for name in files), end=" ")
    +    print("bytes in", len(files), "non-directory files")
    +    if 'CVS' in dirs:
    +        dirs.remove('CVS')  # don't visit CVS directories
    +
    +
    +

    In the next example (simple implementation of shutil.rmtree()), +walking the tree bottom-up is essential, rmdir() doesn’t allow +deleting a directory before the directory is empty:

    +
    # Delete everything reachable from the directory named in "top",
    +# assuming there are no symbolic links.
    +# CAUTION:  This is dangerous!  For example, if top == '/', it
    +# could delete all your disk files.
    +import os
    +for root, dirs, files in os.walk(top, topdown=False):
    +    for name in files:
    +        os.remove(os.path.join(root, name))
    +    for name in dirs:
    +        os.rmdir(os.path.join(root, name))
    +
    +
    +
    +

    Changed in version 3.5: This function now calls os.scandir() instead of os.listdir(), +making it faster by reducing the number of calls to os.stat().

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.fwalk(top='.', topdown=True, onerror=None, *, follow_symlinks=False, dir_fd=None)
    +

    This behaves exactly like walk(), except that it yields a 4-tuple +(dirpath, dirnames, filenames, dirfd), and it supports dir_fd.

    +

    dirpath, dirnames and filenames are identical to walk() output, +and dirfd is a file descriptor referring to the directory dirpath.

    +

    This function always supports paths relative to directory descriptors and not following symlinks. Note however +that, unlike other functions, the fwalk() default value for +follow_symlinks is False.

    +
    +

    Note

    +

    Since fwalk() yields file descriptors, those are only valid until +the next iteration step, so you should duplicate them (e.g. with +dup()) if you want to keep them longer.

    +
    +

    This example displays the number of bytes taken by non-directory files in each +directory under the starting directory, except that it doesn’t look under any +CVS subdirectory:

    +
    import os
    +for root, dirs, files, rootfd in os.fwalk('python/Lib/email'):
    +    print(root, "consumes", end="")
    +    print(sum([os.stat(name, dir_fd=rootfd).st_size for name in files]),
    +          end="")
    +    print("bytes in", len(files), "non-directory files")
    +    if 'CVS' in dirs:
    +        dirs.remove('CVS')  # don't visit CVS directories
    +
    +
    +

    In the next example, walking the tree bottom-up is essential: +rmdir() doesn’t allow deleting a directory before the directory is +empty:

    +
    # Delete everything reachable from the directory named in "top",
    +# assuming there are no symbolic links.
    +# CAUTION:  This is dangerous!  For example, if top == '/', it
    +# could delete all your disk files.
    +import os
    +for root, dirs, files, rootfd in os.fwalk(top, topdown=False):
    +    for name in files:
    +        os.unlink(name, dir_fd=rootfd)
    +    for name in dirs:
    +        os.rmdir(name, dir_fd=rootfd)
    +
    +
    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    +

    Changed in version 3.7: Added support for bytes paths.

    +
    +
    + +
    +

    Linux extended attributes

    +
    +

    New in version 3.3.

    +
    +

    These functions are all available on Linux only.

    +
    +
    +os.getxattr(path, attribute, *, follow_symlinks=True)
    +

    Return the value of the extended filesystem attribute attribute for +path. attribute can be bytes or str (directly or indirectly through the +PathLike interface). If it is str, it is encoded with the filesystem +encoding.

    +

    This function can support specifying a file descriptor and +not following symlinks.

    +
    +

    Changed in version 3.6: Accepts a path-like object for path and attribute.

    +
    +
    + +
    +
    +os.listxattr(path=None, *, follow_symlinks=True)
    +

    Return a list of the extended filesystem attributes on path. The +attributes in the list are represented as strings decoded with the filesystem +encoding. If path is None, listxattr() will examine the current +directory.

    +

    This function can support specifying a file descriptor and +not following symlinks.

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.removexattr(path, attribute, *, follow_symlinks=True)
    +

    Removes the extended filesystem attribute attribute from path. +attribute should be bytes or str (directly or indirectly through the +PathLike interface). If it is a string, it is encoded +with the filesystem encoding.

    +

    This function can support specifying a file descriptor and +not following symlinks.

    +
    +

    Changed in version 3.6: Accepts a path-like object for path and attribute.

    +
    +
    + +
    +
    +os.setxattr(path, attribute, value, flags=0, *, follow_symlinks=True)
    +

    Set the extended filesystem attribute attribute on path to value. +attribute must be a bytes or str with no embedded NULs (directly or +indirectly through the PathLike interface). If it is a str, +it is encoded with the filesystem encoding. flags may be +XATTR_REPLACE or XATTR_CREATE. If XATTR_REPLACE is +given and the attribute does not exist, EEXISTS will be raised. +If XATTR_CREATE is given and the attribute already exists, the +attribute will not be created and ENODATA will be raised.

    +

    This function can support specifying a file descriptor and +not following symlinks.

    +
    +

    Note

    +

    A bug in Linux kernel versions less than 2.6.39 caused the flags argument +to be ignored on some filesystems.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object for path and attribute.

    +
    +
    + +
    +
    +os.XATTR_SIZE_MAX
    +

    The maximum size the value of an extended attribute can be. Currently, this +is 64 KiB on Linux.

    +
    + +
    +
    +os.XATTR_CREATE
    +

    This is a possible value for the flags argument in setxattr(). It +indicates the operation must create an attribute.

    +
    + +
    +
    +os.XATTR_REPLACE
    +

    This is a possible value for the flags argument in setxattr(). It +indicates the operation must replace an existing attribute.

    +
    + +
    +
    +
    +

    Process Management

    +

    These functions may be used to create and manage processes.

    +

    The various exec* functions take a list of arguments for the new +program loaded into the process. In each case, the first of these arguments is +passed to the new program as its own name rather than as an argument a user may +have typed on a command line. For the C programmer, this is the argv[0] +passed to a program’s main(). For example, os.execv('/bin/echo', +['foo', 'bar']) will only print bar on standard output; foo will seem +to be ignored.

    +
    +
    +os.abort()
    +

    Generate a SIGABRT signal to the current process. On Unix, the default +behavior is to produce a core dump; on Windows, the process immediately returns +an exit code of 3. Be aware that calling this function will not call the +Python signal handler registered for SIGABRT with +signal.signal().

    +
    + +
    +
    +os.execl(path, arg0, arg1, ...)
    +
    +os.execle(path, arg0, arg1, ..., env)
    +
    +os.execlp(file, arg0, arg1, ...)
    +
    +os.execlpe(file, arg0, arg1, ..., env)
    +
    +os.execv(path, args)
    +
    +os.execve(path, args, env)
    +
    +os.execvp(file, args)
    +
    +os.execvpe(file, args, env)
    +

    These functions all execute a new program, replacing the current process; they +do not return. On Unix, the new executable is loaded into the current process, +and will have the same process id as the caller. Errors will be reported as +OSError exceptions.

    +

    The current process is replaced immediately. Open file objects and +descriptors are not flushed, so if there may be data buffered +on these open files, you should flush them using +sys.stdout.flush() or os.fsync() before calling an +exec* function.

    +

    The “l” and “v” variants of the exec* functions differ in how +command-line arguments are passed. The “l” variants are perhaps the easiest +to work with if the number of parameters is fixed when the code is written; the +individual parameters simply become additional parameters to the execl*() +functions. The “v” variants are good when the number of parameters is +variable, with the arguments being passed in a list or tuple as the args +parameter. In either case, the arguments to the child process should start with +the name of the command being run, but this is not enforced.

    +

    The variants which include a “p” near the end (execlp(), +execlpe(), execvp(), and execvpe()) will use the +PATH environment variable to locate the program file. When the +environment is being replaced (using one of the exec*e variants, +discussed in the next paragraph), the new environment is used as the source of +the PATH variable. The other variants, execl(), execle(), +execv(), and execve(), will not use the PATH variable to +locate the executable; path must contain an appropriate absolute or relative +path.

    +

    For execle(), execlpe(), execve(), and execvpe() (note +that these all end in “e”), the env parameter must be a mapping which is +used to define the environment variables for the new process (these are used +instead of the current process’ environment); the functions execl(), +execlp(), execv(), and execvp() all cause the new process to +inherit the environment of the current process.

    +

    For execve() on some platforms, path may also be specified as an open +file descriptor. This functionality may not be supported on your platform; +you can check whether or not it is available using os.supports_fd. +If it is unavailable, using it will raise a NotImplementedError.

    +

    Availability: Unix, Windows.

    +
    +

    New in version 3.3: Added support for specifying an open file descriptor for path +for execve().

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os._exit(n)
    +

    Exit the process with status n, without calling cleanup handlers, flushing +stdio buffers, etc.

    +
    +

    Note

    +

    The standard way to exit is sys.exit(n). _exit() should +normally only be used in the child process after a fork().

    +
    +
    + +

    The following exit codes are defined and can be used with _exit(), +although they are not required. These are typically used for system programs +written in Python, such as a mail server’s external command delivery program.

    +
    +

    Note

    +

    Some of these may not be available on all Unix platforms, since there is some +variation. These constants are defined where they are defined by the underlying +platform.

    +
    +
    +
    +os.EX_OK
    +

    Exit code that means no error occurred.

    +

    Availability: Unix.

    +
    + +
    +
    +os.EX_USAGE
    +

    Exit code that means the command was used incorrectly, such as when the wrong +number of arguments are given.

    +

    Availability: Unix.

    +
    + +
    +
    +os.EX_DATAERR
    +

    Exit code that means the input data was incorrect.

    +

    Availability: Unix.

    +
    + +
    +
    +os.EX_NOINPUT
    +

    Exit code that means an input file did not exist or was not readable.

    +

    Availability: Unix.

    +
    + +
    +
    +os.EX_NOUSER
    +

    Exit code that means a specified user did not exist.

    +

    Availability: Unix.

    +
    + +
    +
    +os.EX_NOHOST
    +

    Exit code that means a specified host did not exist.

    +

    Availability: Unix.

    +
    + +
    +
    +os.EX_UNAVAILABLE
    +

    Exit code that means that a required service is unavailable.

    +

    Availability: Unix.

    +
    + +
    +
    +os.EX_SOFTWARE
    +

    Exit code that means an internal software error was detected.

    +

    Availability: Unix.

    +
    + +
    +
    +os.EX_OSERR
    +

    Exit code that means an operating system error was detected, such as the +inability to fork or create a pipe.

    +

    Availability: Unix.

    +
    + +
    +
    +os.EX_OSFILE
    +

    Exit code that means some system file did not exist, could not be opened, or had +some other kind of error.

    +

    Availability: Unix.

    +
    + +
    +
    +os.EX_CANTCREAT
    +

    Exit code that means a user specified output file could not be created.

    +

    Availability: Unix.

    +
    + +
    +
    +os.EX_IOERR
    +

    Exit code that means that an error occurred while doing I/O on some file.

    +

    Availability: Unix.

    +
    + +
    +
    +os.EX_TEMPFAIL
    +

    Exit code that means a temporary failure occurred. This indicates something +that may not really be an error, such as a network connection that couldn’t be +made during a retryable operation.

    +

    Availability: Unix.

    +
    + +
    +
    +os.EX_PROTOCOL
    +

    Exit code that means that a protocol exchange was illegal, invalid, or not +understood.

    +

    Availability: Unix.

    +
    + +
    +
    +os.EX_NOPERM
    +

    Exit code that means that there were insufficient permissions to perform the +operation (but not intended for file system problems).

    +

    Availability: Unix.

    +
    + +
    +
    +os.EX_CONFIG
    +

    Exit code that means that some kind of configuration error occurred.

    +

    Availability: Unix.

    +
    + +
    +
    +os.EX_NOTFOUND
    +

    Exit code that means something like “an entry was not found”.

    +

    Availability: Unix.

    +
    + +
    +
    +os.fork()
    +

    Fork a child process. Return 0 in the child and the child’s process id in the +parent. If an error occurs OSError is raised.

    +

    Note that some platforms including FreeBSD <= 6.3 and Cygwin have +known issues when using fork() from a thread.

    +
    +

    Warning

    +

    See ssl for applications that use the SSL module with fork().

    +
    +

    Availability: Unix.

    +
    + +
    +
    +os.forkpty()
    +

    Fork a child process, using a new pseudo-terminal as the child’s controlling +terminal. Return a pair of (pid, fd), where pid is 0 in the child, the +new child’s process id in the parent, and fd is the file descriptor of the +master end of the pseudo-terminal. For a more portable approach, use the +pty module. If an error occurs OSError is raised.

    +

    Availability: some flavors of Unix.

    +
    + +
    +
    +os.kill(pid, sig)
    +

    Send signal sig to the process pid. Constants for the specific signals +available on the host platform are defined in the signal module.

    +

    Windows: The signal.CTRL_C_EVENT and +signal.CTRL_BREAK_EVENT signals are special signals which can +only be sent to console processes which share a common console window, +e.g., some subprocesses. Any other value for sig will cause the process +to be unconditionally killed by the TerminateProcess API, and the exit code +will be set to sig. The Windows version of kill() additionally takes +process handles to be killed.

    +

    See also signal.pthread_kill().

    +
    +

    New in version 3.2: Windows support.

    +
    +
    + +
    +
    +os.killpg(pgid, sig)
    +

    Send the signal sig to the process group pgid.

    +

    Availability: Unix.

    +
    + +
    +
    +os.nice(increment)
    +

    Add increment to the process’s “niceness”. Return the new niceness.

    +

    Availability: Unix.

    +
    + +
    +
    +os.plock(op)
    +

    Lock program segments into memory. The value of op (defined in +<sys/lock.h>) determines which segments are locked.

    +

    Availability: Unix.

    +
    + +
    +
    +os.popen(cmd, mode='r', buffering=-1)
    +

    Open a pipe to or from command cmd. +The return value is an open file object +connected to the pipe, which can be read or written depending on whether mode +is 'r' (default) or 'w'. The buffering argument has the same meaning as +the corresponding argument to the built-in open() function. The +returned file object reads or writes text strings rather than bytes.

    +

    The close method returns None if the subprocess exited +successfully, or the subprocess’s return code if there was an +error. On POSIX systems, if the return code is positive it +represents the return value of the process left-shifted by one +byte. If the return code is negative, the process was terminated +by the signal given by the negated value of the return code. (For +example, the return value might be - signal.SIGKILL if the +subprocess was killed.) On Windows systems, the return value +contains the signed integer return code from the child process.

    +

    This is implemented using subprocess.Popen; see that class’s +documentation for more powerful ways to manage and communicate with +subprocesses.

    +
    + +
    +
    +os.register_at_fork(*, before=None, after_in_parent=None, after_in_child=None)
    +

    Register callables to be executed when a new child process is forked +using os.fork() or similar process cloning APIs. +The parameters are optional and keyword-only. +Each specifies a different call point.

    +
      +
    • before is a function called before forking a child process.

    • +
    • after_in_parent is a function called from the parent process +after forking a child process.

    • +
    • after_in_child is a function called from the child process.

    • +
    +

    These calls are only made if control is expected to return to the +Python interpreter. A typical subprocess launch will not +trigger them as the child is not going to re-enter the interpreter.

    +

    Functions registered for execution before forking are called in +reverse registration order. Functions registered for execution +after forking (either in the parent or in the child) are called +in registration order.

    +

    Note that fork() calls made by third-party C code may not +call those functions, unless it explicitly calls PyOS_BeforeFork(), +PyOS_AfterFork_Parent() and PyOS_AfterFork_Child().

    +

    There is no way to unregister a function.

    +

    Availability: Unix.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +os.spawnl(mode, path, ...)
    +
    +os.spawnle(mode, path, ..., env)
    +
    +os.spawnlp(mode, file, ...)
    +
    +os.spawnlpe(mode, file, ..., env)
    +
    +os.spawnv(mode, path, args)
    +
    +os.spawnve(mode, path, args, env)
    +
    +os.spawnvp(mode, file, args)
    +
    +os.spawnvpe(mode, file, args, env)
    +

    Execute the program path in a new process.

    +

    (Note that the subprocess module provides more powerful facilities for +spawning new processes and retrieving their results; using that module is +preferable to using these functions. Check especially the +Replacing Older Functions with the subprocess Module section.)

    +

    If mode is P_NOWAIT, this function returns the process id of the new +process; if mode is P_WAIT, returns the process’s exit code if it +exits normally, or -signal, where signal is the signal that killed the +process. On Windows, the process id will actually be the process handle, so can +be used with the waitpid() function.

    +

    The “l” and “v” variants of the spawn* functions differ in how +command-line arguments are passed. The “l” variants are perhaps the easiest +to work with if the number of parameters is fixed when the code is written; the +individual parameters simply become additional parameters to the +spawnl*() functions. The “v” variants are good when the number of +parameters is variable, with the arguments being passed in a list or tuple as +the args parameter. In either case, the arguments to the child process must +start with the name of the command being run.

    +

    The variants which include a second “p” near the end (spawnlp(), +spawnlpe(), spawnvp(), and spawnvpe()) will use the +PATH environment variable to locate the program file. When the +environment is being replaced (using one of the spawn*e variants, +discussed in the next paragraph), the new environment is used as the source of +the PATH variable. The other variants, spawnl(), +spawnle(), spawnv(), and spawnve(), will not use the +PATH variable to locate the executable; path must contain an +appropriate absolute or relative path.

    +

    For spawnle(), spawnlpe(), spawnve(), and spawnvpe() +(note that these all end in “e”), the env parameter must be a mapping +which is used to define the environment variables for the new process (they are +used instead of the current process’ environment); the functions +spawnl(), spawnlp(), spawnv(), and spawnvp() all cause +the new process to inherit the environment of the current process. Note that +keys and values in the env dictionary must be strings; invalid keys or +values will cause the function to fail, with a return value of 127.

    +

    As an example, the following calls to spawnlp() and spawnvpe() are +equivalent:

    +
    import os
    +os.spawnlp(os.P_WAIT, 'cp', 'cp', 'index.html', '/dev/null')
    +
    +L = ['cp', 'index.html', '/dev/null']
    +os.spawnvpe(os.P_WAIT, 'cp', L, os.environ)
    +
    +
    +

    Availability: Unix, Windows. spawnlp(), spawnlpe(), spawnvp() +and spawnvpe() are not available on Windows. spawnle() and +spawnve() are not thread-safe on Windows; we advise you to use the +subprocess module instead.

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.P_NOWAIT
    +
    +os.P_NOWAITO
    +

    Possible values for the mode parameter to the spawn* family of +functions. If either of these values is given, the spawn*() functions +will return as soon as the new process has been created, with the process id as +the return value.

    +

    Availability: Unix, Windows.

    +
    + +
    +
    +os.P_WAIT
    +

    Possible value for the mode parameter to the spawn* family of +functions. If this is given as mode, the spawn*() functions will not +return until the new process has run to completion and will return the exit code +of the process the run is successful, or -signal if a signal kills the +process.

    +

    Availability: Unix, Windows.

    +
    + +
    +
    +os.P_DETACH
    +
    +os.P_OVERLAY
    +

    Possible values for the mode parameter to the spawn* family of +functions. These are less portable than those listed above. P_DETACH +is similar to P_NOWAIT, but the new process is detached from the +console of the calling process. If P_OVERLAY is used, the current +process will be replaced; the spawn* function will not return.

    +

    Availability: Windows.

    +
    + +
    +
    +os.startfile(path[, operation])
    +

    Start a file with its associated application.

    +

    When operation is not specified or 'open', this acts like double-clicking +the file in Windows Explorer, or giving the file name as an argument to the +start command from the interactive command shell: the file is opened +with whatever application (if any) its extension is associated.

    +

    When another operation is given, it must be a “command verb” that specifies +what should be done with the file. Common verbs documented by Microsoft are +'print' and 'edit' (to be used on files) as well as 'explore' and +'find' (to be used on directories).

    +

    startfile() returns as soon as the associated application is launched. +There is no option to wait for the application to close, and no way to retrieve +the application’s exit status. The path parameter is relative to the current +directory. If you want to use an absolute path, make sure the first character +is not a slash ('/'); the underlying Win32 ShellExecute() function +doesn’t work if it is. Use the os.path.normpath() function to ensure that +the path is properly encoded for Win32.

    +

    To reduce interpreter startup overhead, the Win32 ShellExecute() +function is not resolved until this function is first called. If the function +cannot be resolved, NotImplementedError will be raised.

    +

    Availability: Windows.

    +
    + +
    +
    +os.system(command)
    +

    Execute the command (a string) in a subshell. This is implemented by calling +the Standard C function system(), and has the same limitations. +Changes to sys.stdin, etc. are not reflected in the environment of +the executed command. If command generates any output, it will be sent to +the interpreter standard output stream.

    +

    On Unix, the return value is the exit status of the process encoded in the +format specified for wait(). Note that POSIX does not specify the +meaning of the return value of the C system() function, so the return +value of the Python function is system-dependent.

    +

    On Windows, the return value is that returned by the system shell after +running command. The shell is given by the Windows environment variable +COMSPEC: it is usually cmd.exe, which returns the exit +status of the command run; on systems using a non-native shell, consult your +shell documentation.

    +

    The subprocess module provides more powerful facilities for spawning +new processes and retrieving their results; using that module is preferable +to using this function. See the Replacing Older Functions with the subprocess Module section in +the subprocess documentation for some helpful recipes.

    +

    Availability: Unix, Windows.

    +
    + +
    +
    +os.times()
    +

    Returns the current global process times. +The return value is an object with five attributes:

    +
      +
    • user - user time

    • +
    • system - system time

    • +
    • children_user - user time of all child processes

    • +
    • children_system - system time of all child processes

    • +
    • elapsed - elapsed real time since a fixed point in the past

    • +
    +

    For backwards compatibility, this object also behaves like a five-tuple +containing user, system, children_user, +children_system, and elapsed in that order.

    +

    See the Unix manual page +times(2) or the corresponding Windows Platform API documentation. +On Windows, only user and system are known; the other +attributes are zero.

    +

    Availability: Unix, Windows.

    +
    +

    Changed in version 3.3: Return type changed from a tuple to a tuple-like object +with named attributes.

    +
    +
    + +
    +
    +os.wait()
    +

    Wait for completion of a child process, and return a tuple containing its pid +and exit status indication: a 16-bit number, whose low byte is the signal number +that killed the process, and whose high byte is the exit status (if the signal +number is zero); the high bit of the low byte is set if a core file was +produced.

    +

    Availability: Unix.

    +
    + +
    +
    +os.waitid(idtype, id, options)
    +

    Wait for the completion of one or more child processes. +idtype can be P_PID, P_PGID or P_ALL. +id specifies the pid to wait on. +options is constructed from the ORing of one or more of WEXITED, +WSTOPPED or WCONTINUED and additionally may be ORed with +WNOHANG or WNOWAIT. The return value is an object +representing the data contained in the siginfo_t structure, namely: +si_pid, si_uid, si_signo, si_status, +si_code or None if WNOHANG is specified and there are no +children in a waitable state.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.P_PID
    +
    +os.P_PGID
    +
    +os.P_ALL
    +

    These are the possible values for idtype in waitid(). They affect +how id is interpreted.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.WEXITED
    +
    +os.WSTOPPED
    +
    +os.WNOWAIT
    +

    Flags that can be used in options in waitid() that specify what +child signal to wait for.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.CLD_EXITED
    +
    +os.CLD_DUMPED
    +
    +os.CLD_TRAPPED
    +
    +os.CLD_CONTINUED
    +

    These are the possible values for si_code in the result returned by +waitid().

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +os.waitpid(pid, options)
    +

    The details of this function differ on Unix and Windows.

    +

    On Unix: Wait for completion of a child process given by process id pid, and +return a tuple containing its process id and exit status indication (encoded as +for wait()). The semantics of the call are affected by the value of the +integer options, which should be 0 for normal operation.

    +

    If pid is greater than 0, waitpid() requests status information for +that specific process. If pid is 0, the request is for the status of any +child in the process group of the current process. If pid is -1, the +request pertains to any child of the current process. If pid is less than +-1, status is requested for any process in the process group -pid (the +absolute value of pid).

    +

    An OSError is raised with the value of errno when the syscall +returns -1.

    +

    On Windows: Wait for completion of a process given by process handle pid, and +return a tuple containing pid, and its exit status shifted left by 8 bits +(shifting makes cross-platform use of the function easier). A pid less than or +equal to 0 has no special meaning on Windows, and raises an exception. The +value of integer options has no effect. pid can refer to any process whose +id is known, not necessarily a child process. The spawn* +functions called with P_NOWAIT return suitable process handles.

    +
    +

    Changed in version 3.5: If the system call is interrupted and the signal handler does not raise an +exception, the function now retries the system call instead of raising an +InterruptedError exception (see PEP 475 for the rationale).

    +
    +
    + +
    +
    +os.wait3(options)
    +

    Similar to waitpid(), except no process id argument is given and a +3-element tuple containing the child’s process id, exit status indication, +and resource usage information is returned. Refer to +resource.getrusage() for details on resource usage +information. The option argument is the same as that provided to +waitpid() and wait4().

    +

    Availability: Unix.

    +
    + +
    +
    +os.wait4(pid, options)
    +

    Similar to waitpid(), except a 3-element tuple, containing the child’s +process id, exit status indication, and resource usage information is returned. +Refer to resource.getrusage() for details on +resource usage information. The arguments to wait4() are the same +as those provided to waitpid().

    +

    Availability: Unix.

    +
    + +
    +
    +os.WNOHANG
    +

    The option for waitpid() to return immediately if no child process status +is available immediately. The function returns (0, 0) in this case.

    +

    Availability: Unix.

    +
    + +
    +
    +os.WCONTINUED
    +

    This option causes child processes to be reported if they have been continued +from a job control stop since their status was last reported.

    +

    Availability: some Unix systems.

    +
    + +
    +
    +os.WUNTRACED
    +

    This option causes child processes to be reported if they have been stopped but +their current state has not been reported since they were stopped.

    +

    Availability: Unix.

    +
    + +

    The following functions take a process status code as returned by +system(), wait(), or waitpid() as a parameter. They may be +used to determine the disposition of a process.

    +
    +
    +os.WCOREDUMP(status)
    +

    Return True if a core dump was generated for the process, otherwise +return False.

    +

    Availability: Unix.

    +
    + +
    +
    +os.WIFCONTINUED(status)
    +

    Return True if the process has been continued from a job control stop, +otherwise return False.

    +

    Availability: Unix.

    +
    + +
    +
    +os.WIFSTOPPED(status)
    +

    Return True if the process has been stopped, otherwise return +False.

    +

    Availability: Unix.

    +
    + +
    +
    +os.WIFSIGNALED(status)
    +

    Return True if the process exited due to a signal, otherwise return +False.

    +

    Availability: Unix.

    +
    + +
    +
    +os.WIFEXITED(status)
    +

    Return True if the process exited using the exit(2) system call, +otherwise return False.

    +

    Availability: Unix.

    +
    + +
    +
    +os.WEXITSTATUS(status)
    +

    If WIFEXITED(status) is true, return the integer parameter to the +exit(2) system call. Otherwise, the return value is meaningless.

    +

    Availability: Unix.

    +
    + +
    +
    +os.WSTOPSIG(status)
    +

    Return the signal which caused the process to stop.

    +

    Availability: Unix.

    +
    + +
    +
    +os.WTERMSIG(status)
    +

    Return the signal which caused the process to exit.

    +

    Availability: Unix.

    +
    + +
    +
    +

    Interface to the scheduler

    +

    These functions control how a process is allocated CPU time by the operating +system. They are only available on some Unix platforms. For more detailed +information, consult your Unix manpages.

    +
    +

    New in version 3.3.

    +
    +

    The following scheduling policies are exposed if they are supported by the +operating system.

    +
    +
    +os.SCHED_OTHER
    +

    The default scheduling policy.

    +
    + +
    +
    +os.SCHED_BATCH
    +

    Scheduling policy for CPU-intensive processes that tries to preserve +interactivity on the rest of the computer.

    +
    + +
    +
    +os.SCHED_IDLE
    +

    Scheduling policy for extremely low priority background tasks.

    +
    + +
    +
    +os.SCHED_SPORADIC
    +

    Scheduling policy for sporadic server programs.

    +
    + +
    +
    +os.SCHED_FIFO
    +

    A First In First Out scheduling policy.

    +
    + +
    +
    +os.SCHED_RR
    +

    A round-robin scheduling policy.

    +
    + +
    +
    +os.SCHED_RESET_ON_FORK
    +

    This flag can be OR’ed with any other scheduling policy. When a process with +this flag set forks, its child’s scheduling policy and priority are reset to +the default.

    +
    + +
    +
    +class os.sched_param(sched_priority)
    +

    This class represents tunable scheduling parameters used in +sched_setparam(), sched_setscheduler(), and +sched_getparam(). It is immutable.

    +

    At the moment, there is only one possible parameter:

    +
    +
    +sched_priority
    +

    The scheduling priority for a scheduling policy.

    +
    + +
    + +
    +
    +os.sched_get_priority_min(policy)
    +

    Get the minimum priority value for policy. policy is one of the +scheduling policy constants above.

    +
    + +
    +
    +os.sched_get_priority_max(policy)
    +

    Get the maximum priority value for policy. policy is one of the +scheduling policy constants above.

    +
    + +
    +
    +os.sched_setscheduler(pid, policy, param)
    +

    Set the scheduling policy for the process with PID pid. A pid of 0 means +the calling process. policy is one of the scheduling policy constants +above. param is a sched_param instance.

    +
    + +
    +
    +os.sched_getscheduler(pid)
    +

    Return the scheduling policy for the process with PID pid. A pid of 0 +means the calling process. The result is one of the scheduling policy +constants above.

    +
    + +
    +
    +os.sched_setparam(pid, param)
    +

    Set a scheduling parameters for the process with PID pid. A pid of 0 means +the calling process. param is a sched_param instance.

    +
    + +
    +
    +os.sched_getparam(pid)
    +

    Return the scheduling parameters as a sched_param instance for the +process with PID pid. A pid of 0 means the calling process.

    +
    + +
    +
    +os.sched_rr_get_interval(pid)
    +

    Return the round-robin quantum in seconds for the process with PID pid. A +pid of 0 means the calling process.

    +
    + +
    +
    +os.sched_yield()
    +

    Voluntarily relinquish the CPU.

    +
    + +
    +
    +os.sched_setaffinity(pid, mask)
    +

    Restrict the process with PID pid (or the current process if zero) to a +set of CPUs. mask is an iterable of integers representing the set of +CPUs to which the process should be restricted.

    +
    + +
    +
    +os.sched_getaffinity(pid)
    +

    Return the set of CPUs the process with PID pid (or the current process +if zero) is restricted to.

    +
    + +
    +
    +

    Miscellaneous System Information

    +
    +
    +os.confstr(name)
    +

    Return string-valued system configuration values. name specifies the +configuration value to retrieve; it may be a string which is the name of a +defined system value; these names are specified in a number of standards (POSIX, +Unix 95, Unix 98, and others). Some platforms define additional names as well. +The names known to the host operating system are given as the keys of the +confstr_names dictionary. For configuration variables not included in that +mapping, passing an integer for name is also accepted.

    +

    If the configuration value specified by name isn’t defined, None is +returned.

    +

    If name is a string and is not known, ValueError is raised. If a +specific value for name is not supported by the host system, even if it is +included in confstr_names, an OSError is raised with +errno.EINVAL for the error number.

    +

    Availability: Unix.

    +
    + +
    +
    +os.confstr_names
    +

    Dictionary mapping names accepted by confstr() to the integer values +defined for those names by the host operating system. This can be used to +determine the set of names known to the system.

    +

    Availability: Unix.

    +
    + +
    +
    +os.cpu_count()
    +

    Return the number of CPUs in the system. Returns None if undetermined.

    +

    This number is not equivalent to the number of CPUs the current process can +use. The number of usable CPUs can be obtained with +len(os.sched_getaffinity(0))

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +os.getloadavg()
    +

    Return the number of processes in the system run queue averaged over the last +1, 5, and 15 minutes or raises OSError if the load average was +unobtainable.

    +

    Availability: Unix.

    +
    + +
    +
    +os.sysconf(name)
    +

    Return integer-valued system configuration values. If the configuration value +specified by name isn’t defined, -1 is returned. The comments regarding +the name parameter for confstr() apply here as well; the dictionary that +provides information on the known names is given by sysconf_names.

    +

    Availability: Unix.

    +
    + +
    +
    +os.sysconf_names
    +

    Dictionary mapping names accepted by sysconf() to the integer values +defined for those names by the host operating system. This can be used to +determine the set of names known to the system.

    +

    Availability: Unix.

    +
    + +

    The following data values are used to support path manipulation operations. These +are defined for all platforms.

    +

    Higher-level operations on pathnames are defined in the os.path module.

    +
    +
    +os.curdir
    +

    The constant string used by the operating system to refer to the current +directory. This is '.' for Windows and POSIX. Also available via +os.path.

    +
    + +
    +
    +os.pardir
    +

    The constant string used by the operating system to refer to the parent +directory. This is '..' for Windows and POSIX. Also available via +os.path.

    +
    + +
    +
    +os.sep
    +

    The character used by the operating system to separate pathname components. +This is '/' for POSIX and '\\' for Windows. Note that knowing this +is not sufficient to be able to parse or concatenate pathnames — use +os.path.split() and os.path.join() — but it is occasionally +useful. Also available via os.path.

    +
    + +
    +
    +os.altsep
    +

    An alternative character used by the operating system to separate pathname +components, or None if only one separator character exists. This is set to +'/' on Windows systems where sep is a backslash. Also available via +os.path.

    +
    + +
    +
    +os.extsep
    +

    The character which separates the base filename from the extension; for example, +the '.' in os.py. Also available via os.path.

    +
    + +
    +
    +os.pathsep
    +

    The character conventionally used by the operating system to separate search +path components (as in PATH), such as ':' for POSIX or ';' for +Windows. Also available via os.path.

    +
    + +
    +
    +os.defpath
    +

    The default search path used by exec*p* and +spawn*p* if the environment doesn’t have a 'PATH' +key. Also available via os.path.

    +
    + +
    +
    +os.linesep
    +

    The string used to separate (or, rather, terminate) lines on the current +platform. This may be a single character, such as '\n' for POSIX, or +multiple characters, for example, '\r\n' for Windows. Do not use +os.linesep as a line terminator when writing files opened in text mode (the +default); use a single '\n' instead, on all platforms.

    +
    + +
    +
    +os.devnull
    +

    The file path of the null device. For example: '/dev/null' for +POSIX, 'nul' for Windows. Also available via os.path.

    +
    + +
    +
    +os.RTLD_LAZY
    +
    +os.RTLD_NOW
    +
    +os.RTLD_GLOBAL
    +
    +os.RTLD_LOCAL
    +
    +os.RTLD_NODELETE
    +
    +os.RTLD_NOLOAD
    +
    +os.RTLD_DEEPBIND
    +

    Flags for use with the setdlopenflags() and +getdlopenflags() functions. See the Unix manual page +dlopen(3) for what the different flags mean.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +

    Random numbers

    +
    +
    +os.getrandom(size, flags=0)
    +

    Get up to size random bytes. The function can return less bytes than +requested.

    +

    These bytes can be used to seed user-space random number generators or for +cryptographic purposes.

    +

    getrandom() relies on entropy gathered from device drivers and other +sources of environmental noise. Unnecessarily reading large quantities of +data will have a negative impact on other users of the /dev/random and +/dev/urandom devices.

    +

    The flags argument is a bit mask that can contain zero or more of the +following values ORed together: os.GRND_RANDOM and +GRND_NONBLOCK.

    +

    See also the Linux getrandom() manual page.

    +

    Availability: Linux 3.17 and newer.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +os.urandom(size)
    +

    Return a string of size random bytes suitable for cryptographic use.

    +

    This function returns random bytes from an OS-specific randomness source. The +returned data should be unpredictable enough for cryptographic applications, +though its exact quality depends on the OS implementation.

    +

    On Linux, if the getrandom() syscall is available, it is used in +blocking mode: block until the system urandom entropy pool is initialized +(128 bits of entropy are collected by the kernel). See the PEP 524 for +the rationale. On Linux, the getrandom() function can be used to get +random bytes in non-blocking mode (using the GRND_NONBLOCK flag) or +to poll until the system urandom entropy pool is initialized.

    +

    On a Unix-like system, random bytes are read from the /dev/urandom +device. If the /dev/urandom device is not available or not readable, the +NotImplementedError exception is raised.

    +

    On Windows, it will use CryptGenRandom().

    +
    +

    See also

    +

    The secrets module provides higher level functions. For an +easy-to-use interface to the random number generator provided by your +platform, please see random.SystemRandom.

    +
    +
    +

    Changed in version 3.6.0: On Linux, getrandom() is now used in blocking mode to increase the +security.

    +
    +
    +

    Changed in version 3.5.2: On Linux, if the getrandom() syscall blocks (the urandom entropy pool +is not initialized yet), fall back on reading /dev/urandom.

    +
    +
    +

    Changed in version 3.5: On Linux 3.17 and newer, the getrandom() syscall is now used +when available. On OpenBSD 5.6 and newer, the C getentropy() +function is now used. These functions avoid the usage of an internal file +descriptor.

    +
    +
    + +
    +
    +os.GRND_NONBLOCK
    +

    By default, when reading from /dev/random, getrandom() blocks if +no random bytes are available, and when reading from /dev/urandom, it blocks +if the entropy pool has not yet been initialized.

    +

    If the GRND_NONBLOCK flag is set, then getrandom() does not +block in these cases, but instead immediately raises BlockingIOError.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +os.GRND_RANDOM
    +

    If this bit is set, then random bytes are drawn from the +/dev/random pool instead of the /dev/urandom pool.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/os.path.html b/python-3.7.4-docs-html/library/os.path.html new file mode 100644 index 0000000..56dd544 --- /dev/null +++ b/python-3.7.4-docs-html/library/os.path.html @@ -0,0 +1,642 @@ + + + + + + + os.path — Common pathname manipulations — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    os.path — Common pathname manipulations

    +

    Source code: Lib/posixpath.py (for POSIX), +Lib/ntpath.py (for Windows NT), +and Lib/macpath.py (for Macintosh)

    +
    +

    This module implements some useful functions on pathnames. To read or +write files see open(), and for accessing the filesystem see the +os module. The path parameters can be passed as either strings, +or bytes. Applications are encouraged to represent file names as +(Unicode) character strings. Unfortunately, some file names may not be +representable as strings on Unix, so applications that need to support +arbitrary file names on Unix should use bytes objects to represent +path names. Vice versa, using bytes objects cannot represent all file +names on Windows (in the standard mbcs encoding), hence Windows +applications should use string objects to access all files.

    +

    Unlike a unix shell, Python does not do any automatic path expansions. +Functions such as expanduser() and expandvars() can be invoked +explicitly when an application desires shell-like path expansion. (See also +the glob module.)

    +
    +

    See also

    +

    The pathlib module offers high-level path objects.

    +
    +
    +

    Note

    +

    All of these functions accept either only bytes or only string objects as +their parameters. The result is an object of the same type, if a path or +file name is returned.

    +
    +
    +

    Note

    +

    Since different operating systems have different path name conventions, there +are several versions of this module in the standard library. The +os.path module is always the path module suitable for the operating +system Python is running on, and therefore usable for local paths. However, +you can also import and use the individual modules if you want to manipulate +a path that is always in one of the different formats. They all have the +same interface:

    +
      +
    • posixpath for UNIX-style paths

    • +
    • ntpath for Windows paths

    • +
    • macpath for old-style MacOS paths

    • +
    +
    +
    +
    +os.path.abspath(path)
    +

    Return a normalized absolutized version of the pathname path. On most +platforms, this is equivalent to calling the function normpath() as +follows: normpath(join(os.getcwd(), path)).

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.basename(path)
    +

    Return the base name of pathname path. This is the second element of the +pair returned by passing path to the function split(). Note that +the result of this function is different +from the Unix basename program; where basename for +'/foo/bar/' returns 'bar', the basename() function returns an +empty string ('').

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.commonpath(paths)
    +

    Return the longest common sub-path of each pathname in the sequence +paths. Raise ValueError if paths contains both absolute and relative +pathnames, or if paths is empty. Unlike commonprefix(), this +returns a valid path.

    +

    Availability: Unix, Windows.

    +
    +

    New in version 3.5.

    +
    +
    +

    Changed in version 3.6: Accepts a sequence of path-like objects.

    +
    +
    + +
    +
    +os.path.commonprefix(list)
    +

    Return the longest path prefix (taken character-by-character) that is a +prefix of all paths in list. If list is empty, return the empty string +('').

    +
    +

    Note

    +

    This function may return invalid paths because it works a +character at a time. To obtain a valid path, see +commonpath().

    +
    >>> os.path.commonprefix(['/usr/lib', '/usr/local/lib'])
    +'/usr/l'
    +
    +>>> os.path.commonpath(['/usr/lib', '/usr/local/lib'])
    +'/usr'
    +
    +
    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.dirname(path)
    +

    Return the directory name of pathname path. This is the first element of +the pair returned by passing path to the function split().

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.exists(path)
    +

    Return True if path refers to an existing path or an open +file descriptor. Returns False for broken symbolic links. On +some platforms, this function may return False if permission is +not granted to execute os.stat() on the requested file, even +if the path physically exists.

    +
    +

    Changed in version 3.3: path can now be an integer: True is returned if it is an + open file descriptor, False otherwise.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.lexists(path)
    +

    Return True if path refers to an existing path. Returns True for +broken symbolic links. Equivalent to exists() on platforms lacking +os.lstat().

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.expanduser(path)
    +

    On Unix and Windows, return the argument with an initial component of ~ or +~user replaced by that user’s home directory.

    +

    On Unix, an initial ~ is replaced by the environment variable HOME +if it is set; otherwise the current user’s home directory is looked up in the +password directory through the built-in module pwd. An initial ~user +is looked up directly in the password directory.

    +

    On Windows, HOME and USERPROFILE will be used if set, +otherwise a combination of HOMEPATH and HOMEDRIVE will be +used. An initial ~user is handled by stripping the last directory component +from the created user path derived above.

    +

    If the expansion fails or if the path does not begin with a tilde, the path is +returned unchanged.

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.expandvars(path)
    +

    Return the argument with environment variables expanded. Substrings of the form +$name or ${name} are replaced by the value of environment variable +name. Malformed variable names and references to non-existing variables are +left unchanged.

    +

    On Windows, %name% expansions are supported in addition to $name and +${name}.

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.getatime(path)
    +

    Return the time of last access of path. The return value is a floating point number giving +the number of seconds since the epoch (see the time module). Raise +OSError if the file does not exist or is inaccessible.

    +
    + +
    +
    +os.path.getmtime(path)
    +

    Return the time of last modification of path. The return value is a floating point number +giving the number of seconds since the epoch (see the time module). +Raise OSError if the file does not exist or is inaccessible.

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.getctime(path)
    +

    Return the system’s ctime which, on some systems (like Unix) is the time of the +last metadata change, and, on others (like Windows), is the creation time for path. +The return value is a number giving the number of seconds since the epoch (see +the time module). Raise OSError if the file does not exist or +is inaccessible.

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.getsize(path)
    +

    Return the size, in bytes, of path. Raise OSError if the file does +not exist or is inaccessible.

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.isabs(path)
    +

    Return True if path is an absolute pathname. On Unix, that means it +begins with a slash, on Windows that it begins with a (back)slash after chopping +off a potential drive letter.

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.isfile(path)
    +

    Return True if path is an existing regular file. +This follows symbolic links, so both islink() and isfile() can +be true for the same path.

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.isdir(path)
    +

    Return True if path is an existing directory. This +follows symbolic links, so both islink() and isdir() can be true +for the same path.

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    + +

    Return True if path refers to an existing directory +entry that is a symbolic link. Always False if symbolic links are not +supported by the Python runtime.

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.ismount(path)
    +

    Return True if pathname path is a mount point: a point in a +file system where a different file system has been mounted. On POSIX, the +function checks whether path’s parent, path/.., is on a different +device than path, or whether path/.. and path point to the same +i-node on the same device — this should detect mount points for all Unix +and POSIX variants. It is not able to reliably detect bind mounts on the +same filesystem. On Windows, a drive letter root and a share UNC are +always mount points, and for any other path GetVolumePathName is called +to see if it is different from the input path.

    +
    +

    New in version 3.4: Support for detecting non-root mount points on Windows.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.join(path, *paths)
    +

    Join one or more path components intelligently. The return value is the +concatenation of path and any members of *paths with exactly one +directory separator (os.sep) following each non-empty part except the +last, meaning that the result will only end in a separator if the last +part is empty. If a component is an absolute path, all previous +components are thrown away and joining continues from the absolute path +component.

    +

    On Windows, the drive letter is not reset when an absolute path component +(e.g., r'\foo') is encountered. If a component contains a drive +letter, all previous components are thrown away and the drive letter is +reset. Note that since there is a current directory for each drive, +os.path.join("c:", "foo") represents a path relative to the current +directory on drive C: (c:foo), not c:\foo.

    +
    +

    Changed in version 3.6: Accepts a path-like object for path and paths.

    +
    +
    + +
    +
    +os.path.normcase(path)
    +

    Normalize the case of a pathname. On Windows, convert all characters in the +pathname to lowercase, and also convert forward slashes to backward slashes. +On other operating systems, return the path unchanged. +Raise a TypeError if the type of path is not str or bytes (directly +or indirectly through the os.PathLike interface).

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.normpath(path)
    +

    Normalize a pathname by collapsing redundant separators and up-level +references so that A//B, A/B/, A/./B and A/foo/../B all +become A/B. This string manipulation may change the meaning of a path +that contains symbolic links. On Windows, it converts forward slashes to +backward slashes. To normalize case, use normcase().

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.realpath(path)
    +

    Return the canonical path of the specified filename, eliminating any symbolic +links encountered in the path (if they are supported by the operating system).

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.relpath(path, start=os.curdir)
    +

    Return a relative filepath to path either from the current directory or +from an optional start directory. This is a path computation: the +filesystem is not accessed to confirm the existence or nature of path or +start.

    +

    start defaults to os.curdir.

    +

    Availability: Unix, Windows.

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.samefile(path1, path2)
    +

    Return True if both pathname arguments refer to the same file or directory. +This is determined by the device number and i-node number and raises an +exception if an os.stat() call on either pathname fails.

    +

    Availability: Unix, Windows.

    +
    +

    Changed in version 3.2: Added Windows support.

    +
    +
    +

    Changed in version 3.4: Windows now uses the same implementation as all other platforms.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.sameopenfile(fp1, fp2)
    +

    Return True if the file descriptors fp1 and fp2 refer to the same file.

    +

    Availability: Unix, Windows.

    +
    +

    Changed in version 3.2: Added Windows support.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.samestat(stat1, stat2)
    +

    Return True if the stat tuples stat1 and stat2 refer to the same file. +These structures may have been returned by os.fstat(), +os.lstat(), or os.stat(). This function implements the +underlying comparison used by samefile() and sameopenfile().

    +

    Availability: Unix, Windows.

    +
    +

    Changed in version 3.4: Added Windows support.

    +
    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.split(path)
    +

    Split the pathname path into a pair, (head, tail) where tail is the +last pathname component and head is everything leading up to that. The +tail part will never contain a slash; if path ends in a slash, tail +will be empty. If there is no slash in path, head will be empty. If +path is empty, both head and tail are empty. Trailing slashes are +stripped from head unless it is the root (one or more slashes only). In +all cases, join(head, tail) returns a path to the same location as path +(but the strings may differ). Also see the functions dirname() and +basename().

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.splitdrive(path)
    +

    Split the pathname path into a pair (drive, tail) where drive is either +a mount point or the empty string. On systems which do not use drive +specifications, drive will always be the empty string. In all cases, drive ++ tail will be the same as path.

    +

    On Windows, splits a pathname into drive/UNC sharepoint and relative path.

    +

    If the path contains a drive letter, drive will contain everything +up to and including the colon. +e.g. splitdrive("c:/dir") returns ("c:", "/dir")

    +

    If the path contains a UNC path, drive will contain the host name +and share, up to but not including the fourth separator. +e.g. splitdrive("//host/computer/dir") returns ("//host/computer", "/dir")

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.splitext(path)
    +

    Split the pathname path into a pair (root, ext) such that root + ext == +path, and ext is empty or begins with a period and contains at most one +period. Leading periods on the basename are ignored; splitext('.cshrc') +returns ('.cshrc', '').

    +
    +

    Changed in version 3.6: Accepts a path-like object.

    +
    +
    + +
    +
    +os.path.supports_unicode_filenames
    +

    True if arbitrary Unicode strings can be used as file names (within limitations +imposed by the file system).

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/ossaudiodev.html b/python-3.7.4-docs-html/library/ossaudiodev.html new file mode 100644 index 0000000..83ecc05 --- /dev/null +++ b/python-3.7.4-docs-html/library/ossaudiodev.html @@ -0,0 +1,638 @@ + + + + + + + ossaudiodev — Access to OSS-compatible audio devices — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    ossaudiodev — Access to OSS-compatible audio devices

    +
    +

    This module allows you to access the OSS (Open Sound System) audio interface. +OSS is available for a wide range of open-source and commercial Unices, and is +the standard audio interface for Linux and recent versions of FreeBSD.

    +
    +

    Changed in version 3.3: Operations in this module now raise OSError where IOError +was raised.

    +
    +
    +

    See also

    +
    +
    Open Sound System Programmer’s Guide

    the official documentation for the OSS C API

    +
    +
    +

    The module defines a large number of constants supplied by the OSS device +driver; see <sys/soundcard.h> on either Linux or FreeBSD for a listing.

    +
    +

    ossaudiodev defines the following variables and functions:

    +
    +
    +exception ossaudiodev.OSSAudioError
    +

    This exception is raised on certain errors. The argument is a string describing +what went wrong.

    +

    (If ossaudiodev receives an error from a system call such as +open(), write(), or ioctl(), it raises OSError. +Errors detected directly by ossaudiodev result in OSSAudioError.)

    +

    (For backwards compatibility, the exception class is also available as +ossaudiodev.error.)

    +
    + +
    +
    +ossaudiodev.open(mode)
    +
    +ossaudiodev.open(device, mode)
    +

    Open an audio device and return an OSS audio device object. This object +supports many file-like methods, such as read(), write(), and +fileno() (although there are subtle differences between conventional Unix +read/write semantics and those of OSS audio devices). It also supports a number +of audio-specific methods; see below for the complete list of methods.

    +

    device is the audio device filename to use. If it is not specified, this +module first looks in the environment variable AUDIODEV for a device +to use. If not found, it falls back to /dev/dsp.

    +

    mode is one of 'r' for read-only (record) access, 'w' for +write-only (playback) access and 'rw' for both. Since many sound cards +only allow one process to have the recorder or player open at a time, it is a +good idea to open the device only for the activity needed. Further, some +sound cards are half-duplex: they can be opened for reading or writing, but +not both at once.

    +

    Note the unusual calling syntax: the first argument is optional, and the +second is required. This is a historical artifact for compatibility with the +older linuxaudiodev module which ossaudiodev supersedes.

    +
    + +
    +
    +ossaudiodev.openmixer([device])
    +

    Open a mixer device and return an OSS mixer device object. device is the +mixer device filename to use. If it is not specified, this module first looks +in the environment variable MIXERDEV for a device to use. If not +found, it falls back to /dev/mixer.

    +
    + +
    +

    Audio Device Objects

    +

    Before you can write to or read from an audio device, you must call three +methods in the correct order:

    +
      +
    1. setfmt() to set the output format

    2. +
    3. channels() to set the number of channels

    4. +
    5. speed() to set the sample rate

    6. +
    +

    Alternately, you can use the setparameters() method to set all three audio +parameters at once. This is more convenient, but may not be as flexible in all +cases.

    +

    The audio device objects returned by open() define the following methods +and (read-only) attributes:

    +
    +
    +oss_audio_device.close()
    +

    Explicitly close the audio device. When you are done writing to or reading from +an audio device, you should explicitly close it. A closed device cannot be used +again.

    +
    + +
    +
    +oss_audio_device.fileno()
    +

    Return the file descriptor associated with the device.

    +
    + +
    +
    +oss_audio_device.read(size)
    +

    Read size bytes from the audio input and return them as a Python string. +Unlike most Unix device drivers, OSS audio devices in blocking mode (the +default) will block read() until the entire requested amount of data is +available.

    +
    + +
    +
    +oss_audio_device.write(data)
    +

    Write a bytes-like object data to the audio device and return the +number of bytes written. If the audio device is in blocking mode (the +default), the entire data is always written (again, this is different from +usual Unix device semantics). If the device is in non-blocking mode, some +data may not be written—see writeall().

    +
    +

    Changed in version 3.5: Writable bytes-like object is now accepted.

    +
    +
    + +
    +
    +oss_audio_device.writeall(data)
    +

    Write a bytes-like object data to the audio device: waits until +the audio device is able to accept data, writes as much data as it will +accept, and repeats until data has been completely written. If the device +is in blocking mode (the default), this has the same effect as +write(); writeall() is only useful in non-blocking mode. Has +no return value, since the amount of data written is always equal to the +amount of data supplied.

    +
    +

    Changed in version 3.5: Writable bytes-like object is now accepted.

    +
    +
    + +
    +

    Changed in version 3.2: Audio device objects also support the context management protocol, i.e. they can +be used in a with statement.

    +
    +

    The following methods each map to exactly one ioctl() system call. The +correspondence is obvious: for example, setfmt() corresponds to the +SNDCTL_DSP_SETFMT ioctl, and sync() to SNDCTL_DSP_SYNC (this can +be useful when consulting the OSS documentation). If the underlying +ioctl() fails, they all raise OSError.

    +
    +
    +oss_audio_device.nonblock()
    +

    Put the device into non-blocking mode. Once in non-blocking mode, there is no +way to return it to blocking mode.

    +
    + +
    +
    +oss_audio_device.getfmts()
    +

    Return a bitmask of the audio output formats supported by the soundcard. Some +of the formats supported by OSS are:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Format

    Description

    AFMT_MU_LAW

    a logarithmic encoding (used by Sun .au +files and /dev/audio)

    AFMT_A_LAW

    a logarithmic encoding

    AFMT_IMA_ADPCM

    a 4:1 compressed format defined by the +Interactive Multimedia Association

    AFMT_U8

    Unsigned, 8-bit audio

    AFMT_S16_LE

    Signed, 16-bit audio, little-endian byte +order (as used by Intel processors)

    AFMT_S16_BE

    Signed, 16-bit audio, big-endian byte order +(as used by 68k, PowerPC, Sparc)

    AFMT_S8

    Signed, 8 bit audio

    AFMT_U16_LE

    Unsigned, 16-bit little-endian audio

    AFMT_U16_BE

    Unsigned, 16-bit big-endian audio

    +

    Consult the OSS documentation for a full list of audio formats, and note that +most devices support only a subset of these formats. Some older devices only +support AFMT_U8; the most common format used today is +AFMT_S16_LE.

    +
    + +
    +
    +oss_audio_device.setfmt(format)
    +

    Try to set the current audio format to format—see getfmts() for a +list. Returns the audio format that the device was set to, which may not be the +requested format. May also be used to return the current audio format—do this +by passing an “audio format” of AFMT_QUERY.

    +
    + +
    +
    +oss_audio_device.channels(nchannels)
    +

    Set the number of output channels to nchannels. A value of 1 indicates +monophonic sound, 2 stereophonic. Some devices may have more than 2 channels, +and some high-end devices may not support mono. Returns the number of channels +the device was set to.

    +
    + +
    +
    +oss_audio_device.speed(samplerate)
    +

    Try to set the audio sampling rate to samplerate samples per second. Returns +the rate actually set. Most sound devices don’t support arbitrary sampling +rates. Common rates are:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + +

    Rate

    Description

    8000

    default rate for /dev/audio

    11025

    speech recording

    22050

    44100

    CD quality audio (at 16 bits/sample and 2 +channels)

    96000

    DVD quality audio (at 24 bits/sample)

    +
    + +
    +
    +oss_audio_device.sync()
    +

    Wait until the sound device has played every byte in its buffer. (This happens +implicitly when the device is closed.) The OSS documentation recommends closing +and re-opening the device rather than using sync().

    +
    + +
    +
    +oss_audio_device.reset()
    +

    Immediately stop playing or recording and return the device to a state where it +can accept commands. The OSS documentation recommends closing and re-opening +the device after calling reset().

    +
    + +
    +
    +oss_audio_device.post()
    +

    Tell the driver that there is likely to be a pause in the output, making it +possible for the device to handle the pause more intelligently. You might use +this after playing a spot sound effect, before waiting for user input, or before +doing disk I/O.

    +
    + +

    The following convenience methods combine several ioctls, or one ioctl and some +simple calculations.

    +
    +
    +oss_audio_device.setparameters(format, nchannels, samplerate[, strict=False])
    +

    Set the key audio sampling parameters—sample format, number of channels, and +sampling rate—in one method call. format, nchannels, and samplerate +should be as specified in the setfmt(), channels(), and +speed() methods. If strict is true, setparameters() checks to +see if each parameter was actually set to the requested value, and raises +OSSAudioError if not. Returns a tuple (format, nchannels, +samplerate) indicating the parameter values that were actually set by the +device driver (i.e., the same as the return values of setfmt(), +channels(), and speed()).

    +

    For example,

    +
    (fmt, channels, rate) = dsp.setparameters(fmt, channels, rate)
    +
    +
    +

    is equivalent to

    +
    fmt = dsp.setfmt(fmt)
    +channels = dsp.channels(channels)
    +rate = dsp.rate(rate)
    +
    +
    +
    + +
    +
    +oss_audio_device.bufsize()
    +

    Returns the size of the hardware buffer, in samples.

    +
    + +
    +
    +oss_audio_device.obufcount()
    +

    Returns the number of samples that are in the hardware buffer yet to be played.

    +
    + +
    +
    +oss_audio_device.obuffree()
    +

    Returns the number of samples that could be queued into the hardware buffer to +be played without blocking.

    +
    + +

    Audio device objects also support several read-only attributes:

    +
    +
    +oss_audio_device.closed
    +

    Boolean indicating whether the device has been closed.

    +
    + +
    +
    +oss_audio_device.name
    +

    String containing the name of the device file.

    +
    + +
    +
    +oss_audio_device.mode
    +

    The I/O mode for the file, either "r", "rw", or "w".

    +
    + +
    +
    +

    Mixer Device Objects

    +

    The mixer object provides two file-like methods:

    +
    +
    +oss_mixer_device.close()
    +

    This method closes the open mixer device file. Any further attempts to use the +mixer after this file is closed will raise an OSError.

    +
    + +
    +
    +oss_mixer_device.fileno()
    +

    Returns the file handle number of the open mixer device file.

    +
    + +
    +

    Changed in version 3.2: Mixer objects also support the context management protocol.

    +
    +

    The remaining methods are specific to audio mixing:

    +
    +
    +oss_mixer_device.controls()
    +

    This method returns a bitmask specifying the available mixer controls (“Control” +being a specific mixable “channel”, such as SOUND_MIXER_PCM or +SOUND_MIXER_SYNTH). This bitmask indicates a subset of all available +mixer controls—the SOUND_MIXER_* constants defined at module level. +To determine if, for example, the current mixer object supports a PCM mixer, use +the following Python code:

    +
    mixer=ossaudiodev.openmixer()
    +if mixer.controls() & (1 << ossaudiodev.SOUND_MIXER_PCM):
    +    # PCM is supported
    +    ... code ...
    +
    +
    +

    For most purposes, the SOUND_MIXER_VOLUME (master volume) and +SOUND_MIXER_PCM controls should suffice—but code that uses the mixer +should be flexible when it comes to choosing mixer controls. On the Gravis +Ultrasound, for example, SOUND_MIXER_VOLUME does not exist.

    +
    + +
    +
    +oss_mixer_device.stereocontrols()
    +

    Returns a bitmask indicating stereo mixer controls. If a bit is set, the +corresponding control is stereo; if it is unset, the control is either +monophonic or not supported by the mixer (use in combination with +controls() to determine which).

    +

    See the code example for the controls() function for an example of getting +data from a bitmask.

    +
    + +
    +
    +oss_mixer_device.reccontrols()
    +

    Returns a bitmask specifying the mixer controls that may be used to record. See +the code example for controls() for an example of reading from a bitmask.

    +
    + +
    +
    +oss_mixer_device.get(control)
    +

    Returns the volume of a given mixer control. The returned volume is a 2-tuple +(left_volume,right_volume). Volumes are specified as numbers from 0 +(silent) to 100 (full volume). If the control is monophonic, a 2-tuple is still +returned, but both volumes are the same.

    +

    Raises OSSAudioError if an invalid control is specified, or +OSError if an unsupported control is specified.

    +
    + +
    +
    +oss_mixer_device.set(control, (left, right))
    +

    Sets the volume for a given mixer control to (left,right). left and +right must be ints and between 0 (silent) and 100 (full volume). On +success, the new volume is returned as a 2-tuple. Note that this may not be +exactly the same as the volume specified, because of the limited resolution of +some soundcard’s mixers.

    +

    Raises OSSAudioError if an invalid mixer control was specified, or if the +specified volumes were out-of-range.

    +
    + +
    +
    +oss_mixer_device.get_recsrc()
    +

    This method returns a bitmask indicating which control(s) are currently being +used as a recording source.

    +
    + +
    +
    +oss_mixer_device.set_recsrc(bitmask)
    +

    Call this function to specify a recording source. Returns a bitmask indicating +the new recording source (or sources) if successful; raises OSError if an +invalid source was specified. To set the current recording source to the +microphone input:

    +
    mixer.setrecsrc (1 << ossaudiodev.SOUND_MIXER_MIC)
    +
    +
    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/othergui.html b/python-3.7.4-docs-html/library/othergui.html new file mode 100644 index 0000000..72f0843 --- /dev/null +++ b/python-3.7.4-docs-html/library/othergui.html @@ -0,0 +1,228 @@ + + + + + + + Other Graphical User Interface Packages — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Other Graphical User Interface Packages

    +

    Major cross-platform (Windows, Mac OS X, Unix-like) GUI toolkits are +available for Python:

    +
    +

    See also

    +
    +
    PyGObject

    PyGObject provides introspection bindings for C libraries using +GObject. One of +these libraries is the GTK+ 3 widget set. +GTK+ comes with many more widgets than Tkinter provides. An online +Python GTK+ 3 Tutorial +is available.

    +
    +
    PyGTK

    PyGTK provides bindings for an older version +of the library, GTK+ 2. It provides an object oriented interface that +is slightly higher level than the C one. There are also bindings to +GNOME. An online tutorial is available.

    +
    +
    PyQt

    PyQt is a sip-wrapped binding to the Qt toolkit. Qt is an +extensive C++ GUI application development framework that is +available for Unix, Windows and Mac OS X. sip is a tool +for generating bindings for C++ libraries as Python classes, and +is specifically designed for Python.

    +
    +
    PySide

    PySide is a newer binding to the Qt toolkit, provided by Nokia. +Compared to PyQt, its licensing scheme is friendlier to non-open source +applications.

    +
    +
    wxPython

    wxPython is a cross-platform GUI toolkit for Python that is built around +the popular wxWidgets (formerly wxWindows) +C++ toolkit. It provides a native look and feel for applications on +Windows, Mac OS X, and Unix systems by using each platform’s native +widgets where ever possible, (GTK+ on Unix-like systems). In addition to +an extensive set of widgets, wxPython provides classes for online +documentation and context sensitive help, printing, HTML viewing, +low-level device context drawing, drag and drop, system clipboard access, +an XML-based resource format and more, including an ever growing library +of user-contributed modules.

    +
    +
    +
    +

    PyGTK, PyQt, and wxPython, all have a modern look and feel and more +widgets than Tkinter. In addition, there are many other GUI toolkits for +Python, both cross-platform, and platform-specific. See the GUI Programming page in the Python Wiki for a +much more complete list, and also for links to documents where the +different GUI toolkits are compared.

    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/parser.html b/python-3.7.4-docs-html/library/parser.html new file mode 100644 index 0000000..888d9f4 --- /dev/null +++ b/python-3.7.4-docs-html/library/parser.html @@ -0,0 +1,510 @@ + + + + + + + parser — Access Python parse trees — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    parser — Access Python parse trees

    +
    +

    The parser module provides an interface to Python’s internal parser and +byte-code compiler. The primary purpose for this interface is to allow Python +code to edit the parse tree of a Python expression and create executable code +from this. This is better than trying to parse and modify an arbitrary Python +code fragment as a string because parsing is performed in a manner identical to +the code forming the application. It is also faster.

    +
    +

    Note

    +

    From Python 2.5 onward, it’s much more convenient to cut in at the Abstract +Syntax Tree (AST) generation and compilation stage, using the ast +module.

    +
    +

    There are a few things to note about this module which are important to making +use of the data structures created. This is not a tutorial on editing the parse +trees for Python code, but some examples of using the parser module are +presented.

    +

    Most importantly, a good understanding of the Python grammar processed by the +internal parser is required. For full information on the language syntax, refer +to The Python Language Reference. The parser +itself is created from a grammar specification defined in the file +Grammar/Grammar in the standard Python distribution. The parse trees +stored in the ST objects created by this module are the actual output from the +internal parser when created by the expr() or suite() functions, +described below. The ST objects created by sequence2st() faithfully +simulate those structures. Be aware that the values of the sequences which are +considered “correct” will vary from one version of Python to another as the +formal grammar for the language is revised. However, transporting code from one +Python version to another as source text will always allow correct parse trees +to be created in the target version, with the only restriction being that +migrating to an older version of the interpreter will not support more recent +language constructs. The parse trees are not typically compatible from one +version to another, whereas source code has always been forward-compatible.

    +

    Each element of the sequences returned by st2list() or st2tuple() +has a simple form. Sequences representing non-terminal elements in the grammar +always have a length greater than one. The first element is an integer which +identifies a production in the grammar. These integers are given symbolic names +in the C header file Include/graminit.h and the Python module +symbol. Each additional element of the sequence represents a component +of the production as recognized in the input string: these are always sequences +which have the same form as the parent. An important aspect of this structure +which should be noted is that keywords used to identify the parent node type, +such as the keyword if in an if_stmt, are included in the +node tree without any special treatment. For example, the if keyword +is represented by the tuple (1, 'if'), where 1 is the numeric value +associated with all NAME tokens, including variable and function names +defined by the user. In an alternate form returned when line number information +is requested, the same token might be represented as (1, 'if', 12), where +the 12 represents the line number at which the terminal symbol was found.

    +

    Terminal elements are represented in much the same way, but without any child +elements and the addition of the source text which was identified. The example +of the if keyword above is representative. The various types of +terminal symbols are defined in the C header file Include/token.h and +the Python module token.

    +

    The ST objects are not required to support the functionality of this module, +but are provided for three purposes: to allow an application to amortize the +cost of processing complex parse trees, to provide a parse tree representation +which conserves memory space when compared to the Python list or tuple +representation, and to ease the creation of additional modules in C which +manipulate parse trees. A simple “wrapper” class may be created in Python to +hide the use of ST objects.

    +

    The parser module defines functions for a few distinct purposes. The +most important purposes are to create ST objects and to convert ST objects to +other representations such as parse trees and compiled code objects, but there +are also functions which serve to query the type of parse tree represented by an +ST object.

    +
    +

    See also

    +
    +
    Module symbol

    Useful constants representing internal nodes of the parse tree.

    +
    +
    Module token

    Useful constants representing leaf nodes of the parse tree and functions for +testing node values.

    +
    +
    +
    +
    +

    Creating ST Objects

    +

    ST objects may be created from source code or from a parse tree. When creating +an ST object from source, different functions are used to create the 'eval' +and 'exec' forms.

    +
    +
    +parser.expr(source)
    +

    The expr() function parses the parameter source as if it were an input +to compile(source, 'file.py', 'eval'). If the parse succeeds, an ST object +is created to hold the internal parse tree representation, otherwise an +appropriate exception is raised.

    +
    + +
    +
    +parser.suite(source)
    +

    The suite() function parses the parameter source as if it were an input +to compile(source, 'file.py', 'exec'). If the parse succeeds, an ST object +is created to hold the internal parse tree representation, otherwise an +appropriate exception is raised.

    +
    + +
    +
    +parser.sequence2st(sequence)
    +

    This function accepts a parse tree represented as a sequence and builds an +internal representation if possible. If it can validate that the tree conforms +to the Python grammar and all nodes are valid node types in the host version of +Python, an ST object is created from the internal representation and returned +to the called. If there is a problem creating the internal representation, or +if the tree cannot be validated, a ParserError exception is raised. An +ST object created this way should not be assumed to compile correctly; normal +exceptions raised by compilation may still be initiated when the ST object is +passed to compilest(). This may indicate problems not related to syntax +(such as a MemoryError exception), but may also be due to constructs such +as the result of parsing del f(0), which escapes the Python parser but is +checked by the bytecode compiler.

    +

    Sequences representing terminal tokens may be represented as either two-element +lists of the form (1, 'name') or as three-element lists of the form (1, +'name', 56). If the third element is present, it is assumed to be a valid +line number. The line number may be specified for any subset of the terminal +symbols in the input tree.

    +
    + +
    +
    +parser.tuple2st(sequence)
    +

    This is the same function as sequence2st(). This entry point is +maintained for backward compatibility.

    +
    + +
    +
    +

    Converting ST Objects

    +

    ST objects, regardless of the input used to create them, may be converted to +parse trees represented as list- or tuple- trees, or may be compiled into +executable code objects. Parse trees may be extracted with or without line +numbering information.

    +
    +
    +parser.st2list(st, line_info=False, col_info=False)
    +

    This function accepts an ST object from the caller in st and returns a +Python list representing the equivalent parse tree. The resulting list +representation can be used for inspection or the creation of a new parse tree in +list form. This function does not fail so long as memory is available to build +the list representation. If the parse tree will only be used for inspection, +st2tuple() should be used instead to reduce memory consumption and +fragmentation. When the list representation is required, this function is +significantly faster than retrieving a tuple representation and converting that +to nested lists.

    +

    If line_info is true, line number information will be included for all +terminal tokens as a third element of the list representing the token. Note +that the line number provided specifies the line on which the token ends. +This information is omitted if the flag is false or omitted.

    +
    + +
    +
    +parser.st2tuple(st, line_info=False, col_info=False)
    +

    This function accepts an ST object from the caller in st and returns a +Python tuple representing the equivalent parse tree. Other than returning a +tuple instead of a list, this function is identical to st2list().

    +

    If line_info is true, line number information will be included for all +terminal tokens as a third element of the list representing the token. This +information is omitted if the flag is false or omitted.

    +
    + +
    +
    +parser.compilest(st, filename='<syntax-tree>')
    +

    The Python byte compiler can be invoked on an ST object to produce code objects +which can be used as part of a call to the built-in exec() or eval() +functions. This function provides the interface to the compiler, passing the +internal parse tree from st to the parser, using the source file name +specified by the filename parameter. The default value supplied for filename +indicates that the source was an ST object.

    +

    Compiling an ST object may result in exceptions related to compilation; an +example would be a SyntaxError caused by the parse tree for del f(0): +this statement is considered legal within the formal grammar for Python but is +not a legal language construct. The SyntaxError raised for this +condition is actually generated by the Python byte-compiler normally, which is +why it can be raised at this point by the parser module. Most causes of +compilation failure can be diagnosed programmatically by inspection of the parse +tree.

    +
    + +
    +
    +

    Queries on ST Objects

    +

    Two functions are provided which allow an application to determine if an ST was +created as an expression or a suite. Neither of these functions can be used to +determine if an ST was created from source code via expr() or +suite() or from a parse tree via sequence2st().

    +
    +
    +parser.isexpr(st)
    +

    When st represents an 'eval' form, this function returns true, otherwise +it returns false. This is useful, since code objects normally cannot be queried +for this information using existing built-in functions. Note that the code +objects created by compilest() cannot be queried like this either, and +are identical to those created by the built-in compile() function.

    +
    + +
    +
    +parser.issuite(st)
    +

    This function mirrors isexpr() in that it reports whether an ST object +represents an 'exec' form, commonly known as a “suite.” It is not safe to +assume that this function is equivalent to not isexpr(st), as additional +syntactic fragments may be supported in the future.

    +
    + +
    +
    +

    Exceptions and Error Handling

    +

    The parser module defines a single exception, but may also pass other built-in +exceptions from other portions of the Python runtime environment. See each +function for information about the exceptions it can raise.

    +
    +
    +exception parser.ParserError
    +

    Exception raised when a failure occurs within the parser module. This is +generally produced for validation failures rather than the built-in +SyntaxError raised during normal parsing. The exception argument is +either a string describing the reason of the failure or a tuple containing a +sequence causing the failure from a parse tree passed to sequence2st() +and an explanatory string. Calls to sequence2st() need to be able to +handle either type of exception, while calls to other functions in the module +will only need to be aware of the simple string values.

    +
    + +

    Note that the functions compilest(), expr(), and suite() may +raise exceptions which are normally raised by the parsing and compilation +process. These include the built in exceptions MemoryError, +OverflowError, SyntaxError, and SystemError. In these +cases, these exceptions carry all the meaning normally associated with them. +Refer to the descriptions of each function for detailed information.

    +
    +
    +

    ST Objects

    +

    Ordered and equality comparisons are supported between ST objects. Pickling of +ST objects (using the pickle module) is also supported.

    +
    +
    +parser.STType
    +

    The type of the objects returned by expr(), suite() and +sequence2st().

    +
    + +

    ST objects have the following methods:

    +
    +
    +ST.compile(filename='<syntax-tree>')
    +

    Same as compilest(st, filename).

    +
    + +
    +
    +ST.isexpr()
    +

    Same as isexpr(st).

    +
    + +
    +
    +ST.issuite()
    +

    Same as issuite(st).

    +
    + +
    +
    +ST.tolist(line_info=False, col_info=False)
    +

    Same as st2list(st, line_info, col_info).

    +
    + +
    +
    +ST.totuple(line_info=False, col_info=False)
    +

    Same as st2tuple(st, line_info, col_info).

    +
    + +
    +
    +

    Example: Emulation of compile()

    +

    While many useful operations may take place between parsing and bytecode +generation, the simplest operation is to do nothing. For this purpose, using +the parser module to produce an intermediate data structure is equivalent +to the code

    +
    >>> code = compile('a + 5', 'file.py', 'eval')
    +>>> a = 5
    +>>> eval(code)
    +10
    +
    +
    +

    The equivalent operation using the parser module is somewhat longer, and +allows the intermediate internal parse tree to be retained as an ST object:

    +
    >>> import parser
    +>>> st = parser.expr('a + 5')
    +>>> code = st.compile('file.py')
    +>>> a = 5
    +>>> eval(code)
    +10
    +
    +
    +

    An application which needs both ST and code objects can package this code into +readily available functions:

    +
    import parser
    +
    +def load_suite(source_string):
    +    st = parser.suite(source_string)
    +    return st, st.compile()
    +
    +def load_expression(source_string):
    +    st = parser.expr(source_string)
    +    return st, st.compile()
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/pathlib.html b/python-3.7.4-docs-html/library/pathlib.html new file mode 100644 index 0000000..30c0b69 --- /dev/null +++ b/python-3.7.4-docs-html/library/pathlib.html @@ -0,0 +1,1428 @@ + + + + + + + pathlib — Object-oriented filesystem paths — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    pathlib — Object-oriented filesystem paths

    +
    +

    New in version 3.4.

    +
    +

    Source code: Lib/pathlib.py

    +
    +

    This module offers classes representing filesystem paths with semantics +appropriate for different operating systems. Path classes are divided +between pure paths, which provide purely computational +operations without I/O, and concrete paths, which +inherit from pure paths but also provide I/O operations.

    +../_images/pathlib-inheritance.png +

    If you’ve never used this module before or just aren’t sure which class is +right for your task, Path is most likely what you need. It instantiates +a concrete path for the platform the code is running on.

    +

    Pure paths are useful in some special cases; for example:

    +
      +
    1. If you want to manipulate Windows paths on a Unix machine (or vice versa). +You cannot instantiate a WindowsPath when running on Unix, but you +can instantiate PureWindowsPath.

    2. +
    3. You want to make sure that your code only manipulates paths without actually +accessing the OS. In this case, instantiating one of the pure classes may be +useful since those simply don’t have any OS-accessing operations.

    4. +
    +
    +

    See also

    +

    PEP 428: The pathlib module – object-oriented filesystem paths.

    +
    +
    +

    See also

    +

    For low-level path manipulation on strings, you can also use the +os.path module.

    +
    +
    +

    Basic use

    +

    Importing the main class:

    +
    >>> from pathlib import Path
    +
    +
    +

    Listing subdirectories:

    +
    >>> p = Path('.')
    +>>> [x for x in p.iterdir() if x.is_dir()]
    +[PosixPath('.hg'), PosixPath('docs'), PosixPath('dist'),
    + PosixPath('__pycache__'), PosixPath('build')]
    +
    +
    +

    Listing Python source files in this directory tree:

    +
    >>> list(p.glob('**/*.py'))
    +[PosixPath('test_pathlib.py'), PosixPath('setup.py'),
    + PosixPath('pathlib.py'), PosixPath('docs/conf.py'),
    + PosixPath('build/lib/pathlib.py')]
    +
    +
    +

    Navigating inside a directory tree:

    +
    >>> p = Path('/etc')
    +>>> q = p / 'init.d' / 'reboot'
    +>>> q
    +PosixPath('/etc/init.d/reboot')
    +>>> q.resolve()
    +PosixPath('/etc/rc.d/init.d/halt')
    +
    +
    +

    Querying path properties:

    +
    >>> q.exists()
    +True
    +>>> q.is_dir()
    +False
    +
    +
    +

    Opening a file:

    +
    >>> with q.open() as f: f.readline()
    +...
    +'#!/bin/bash\n'
    +
    +
    +
    +
    +

    Pure paths

    +

    Pure path objects provide path-handling operations which don’t actually +access a filesystem. There are three ways to access these classes, which +we also call flavours:

    +
    +
    +class pathlib.PurePath(*pathsegments)
    +

    A generic class that represents the system’s path flavour (instantiating +it creates either a PurePosixPath or a PureWindowsPath):

    +
    >>> PurePath('setup.py')      # Running on a Unix machine
    +PurePosixPath('setup.py')
    +
    +
    +

    Each element of pathsegments can be either a string representing a +path segment, an object implementing the os.PathLike interface +which returns a string, or another path object:

    +
    >>> PurePath('foo', 'some/path', 'bar')
    +PurePosixPath('foo/some/path/bar')
    +>>> PurePath(Path('foo'), Path('bar'))
    +PurePosixPath('foo/bar')
    +
    +
    +

    When pathsegments is empty, the current directory is assumed:

    +
    >>> PurePath()
    +PurePosixPath('.')
    +
    +
    +

    When several absolute paths are given, the last is taken as an anchor +(mimicking os.path.join()’s behaviour):

    +
    >>> PurePath('/etc', '/usr', 'lib64')
    +PurePosixPath('/usr/lib64')
    +>>> PureWindowsPath('c:/Windows', 'd:bar')
    +PureWindowsPath('d:bar')
    +
    +
    +

    However, in a Windows path, changing the local root doesn’t discard the +previous drive setting:

    +
    >>> PureWindowsPath('c:/Windows', '/Program Files')
    +PureWindowsPath('c:/Program Files')
    +
    +
    +

    Spurious slashes and single dots are collapsed, but double dots ('..') +are not, since this would change the meaning of a path in the face of +symbolic links:

    +
    >>> PurePath('foo//bar')
    +PurePosixPath('foo/bar')
    +>>> PurePath('foo/./bar')
    +PurePosixPath('foo/bar')
    +>>> PurePath('foo/../bar')
    +PurePosixPath('foo/../bar')
    +
    +
    +

    (a naïve approach would make PurePosixPath('foo/../bar') equivalent +to PurePosixPath('bar'), which is wrong if foo is a symbolic link +to another directory)

    +

    Pure path objects implement the os.PathLike interface, allowing them +to be used anywhere the interface is accepted.

    +
    +

    Changed in version 3.6: Added support for the os.PathLike interface.

    +
    +
    + +
    +
    +class pathlib.PurePosixPath(*pathsegments)
    +

    A subclass of PurePath, this path flavour represents non-Windows +filesystem paths:

    +
    >>> PurePosixPath('/etc')
    +PurePosixPath('/etc')
    +
    +
    +

    pathsegments is specified similarly to PurePath.

    +
    + +
    +
    +class pathlib.PureWindowsPath(*pathsegments)
    +

    A subclass of PurePath, this path flavour represents Windows +filesystem paths:

    +
    >>> PureWindowsPath('c:/Program Files/')
    +PureWindowsPath('c:/Program Files')
    +
    +
    +

    pathsegments is specified similarly to PurePath.

    +
    + +

    Regardless of the system you’re running on, you can instantiate all of +these classes, since they don’t provide any operation that does system calls.

    +
    +

    General properties

    +

    Paths are immutable and hashable. Paths of a same flavour are comparable +and orderable. These properties respect the flavour’s case-folding +semantics:

    +
    >>> PurePosixPath('foo') == PurePosixPath('FOO')
    +False
    +>>> PureWindowsPath('foo') == PureWindowsPath('FOO')
    +True
    +>>> PureWindowsPath('FOO') in { PureWindowsPath('foo') }
    +True
    +>>> PureWindowsPath('C:') < PureWindowsPath('d:')
    +True
    +
    +
    +

    Paths of a different flavour compare unequal and cannot be ordered:

    +
    >>> PureWindowsPath('foo') == PurePosixPath('foo')
    +False
    +>>> PureWindowsPath('foo') < PurePosixPath('foo')
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +TypeError: '<' not supported between instances of 'PureWindowsPath' and 'PurePosixPath'
    +
    +
    +
    +
    +

    Operators

    +

    The slash operator helps create child paths, similarly to os.path.join():

    +
    >>> p = PurePath('/etc')
    +>>> p
    +PurePosixPath('/etc')
    +>>> p / 'init.d' / 'apache2'
    +PurePosixPath('/etc/init.d/apache2')
    +>>> q = PurePath('bin')
    +>>> '/usr' / q
    +PurePosixPath('/usr/bin')
    +
    +
    +

    A path object can be used anywhere an object implementing os.PathLike +is accepted:

    +
    >>> import os
    +>>> p = PurePath('/etc')
    +>>> os.fspath(p)
    +'/etc'
    +
    +
    +

    The string representation of a path is the raw filesystem path itself +(in native form, e.g. with backslashes under Windows), which you can +pass to any function taking a file path as a string:

    +
    >>> p = PurePath('/etc')
    +>>> str(p)
    +'/etc'
    +>>> p = PureWindowsPath('c:/Program Files')
    +>>> str(p)
    +'c:\\Program Files'
    +
    +
    +

    Similarly, calling bytes on a path gives the raw filesystem path as a +bytes object, as encoded by os.fsencode():

    +
    >>> bytes(p)
    +b'/etc'
    +
    +
    +
    +

    Note

    +

    Calling bytes is only recommended under Unix. Under Windows, +the unicode form is the canonical representation of filesystem paths.

    +
    +
    +
    +

    Accessing individual parts

    +

    To access the individual “parts” (components) of a path, use the following +property:

    +
    +
    +PurePath.parts
    +

    A tuple giving access to the path’s various components:

    +
    >>> p = PurePath('/usr/bin/python3')
    +>>> p.parts
    +('/', 'usr', 'bin', 'python3')
    +
    +>>> p = PureWindowsPath('c:/Program Files/PSF')
    +>>> p.parts
    +('c:\\', 'Program Files', 'PSF')
    +
    +
    +

    (note how the drive and local root are regrouped in a single part)

    +
    + +
    +
    +

    Methods and properties

    +

    Pure paths provide the following methods and properties:

    +
    +
    +PurePath.drive
    +

    A string representing the drive letter or name, if any:

    +
    >>> PureWindowsPath('c:/Program Files/').drive
    +'c:'
    +>>> PureWindowsPath('/Program Files/').drive
    +''
    +>>> PurePosixPath('/etc').drive
    +''
    +
    +
    +

    UNC shares are also considered drives:

    +
    >>> PureWindowsPath('//host/share/foo.txt').drive
    +'\\\\host\\share'
    +
    +
    +
    + +
    +
    +PurePath.root
    +

    A string representing the (local or global) root, if any:

    +
    >>> PureWindowsPath('c:/Program Files/').root
    +'\\'
    +>>> PureWindowsPath('c:Program Files/').root
    +''
    +>>> PurePosixPath('/etc').root
    +'/'
    +
    +
    +

    UNC shares always have a root:

    +
    >>> PureWindowsPath('//host/share').root
    +'\\'
    +
    +
    +
    + +
    +
    +PurePath.anchor
    +

    The concatenation of the drive and root:

    +
    >>> PureWindowsPath('c:/Program Files/').anchor
    +'c:\\'
    +>>> PureWindowsPath('c:Program Files/').anchor
    +'c:'
    +>>> PurePosixPath('/etc').anchor
    +'/'
    +>>> PureWindowsPath('//host/share').anchor
    +'\\\\host\\share\\'
    +
    +
    +
    + +
    +
    +PurePath.parents
    +

    An immutable sequence providing access to the logical ancestors of +the path:

    +
    >>> p = PureWindowsPath('c:/foo/bar/setup.py')
    +>>> p.parents[0]
    +PureWindowsPath('c:/foo/bar')
    +>>> p.parents[1]
    +PureWindowsPath('c:/foo')
    +>>> p.parents[2]
    +PureWindowsPath('c:/')
    +
    +
    +
    + +
    +
    +PurePath.parent
    +

    The logical parent of the path:

    +
    >>> p = PurePosixPath('/a/b/c/d')
    +>>> p.parent
    +PurePosixPath('/a/b/c')
    +
    +
    +

    You cannot go past an anchor, or empty path:

    +
    >>> p = PurePosixPath('/')
    +>>> p.parent
    +PurePosixPath('/')
    +>>> p = PurePosixPath('.')
    +>>> p.parent
    +PurePosixPath('.')
    +
    +
    +
    +

    Note

    +

    This is a purely lexical operation, hence the following behaviour:

    +
    >>> p = PurePosixPath('foo/..')
    +>>> p.parent
    +PurePosixPath('foo')
    +
    +
    +

    If you want to walk an arbitrary filesystem path upwards, it is +recommended to first call Path.resolve() so as to resolve +symlinks and eliminate “..” components.

    +
    +
    + +
    +
    +PurePath.name
    +

    A string representing the final path component, excluding the drive and +root, if any:

    +
    >>> PurePosixPath('my/library/setup.py').name
    +'setup.py'
    +
    +
    +

    UNC drive names are not considered:

    +
    >>> PureWindowsPath('//some/share/setup.py').name
    +'setup.py'
    +>>> PureWindowsPath('//some/share').name
    +''
    +
    +
    +
    + +
    +
    +PurePath.suffix
    +

    The file extension of the final component, if any:

    +
    >>> PurePosixPath('my/library/setup.py').suffix
    +'.py'
    +>>> PurePosixPath('my/library.tar.gz').suffix
    +'.gz'
    +>>> PurePosixPath('my/library').suffix
    +''
    +
    +
    +
    + +
    +
    +PurePath.suffixes
    +

    A list of the path’s file extensions:

    +
    >>> PurePosixPath('my/library.tar.gar').suffixes
    +['.tar', '.gar']
    +>>> PurePosixPath('my/library.tar.gz').suffixes
    +['.tar', '.gz']
    +>>> PurePosixPath('my/library').suffixes
    +[]
    +
    +
    +
    + +
    +
    +PurePath.stem
    +

    The final path component, without its suffix:

    +
    >>> PurePosixPath('my/library.tar.gz').stem
    +'library.tar'
    +>>> PurePosixPath('my/library.tar').stem
    +'library'
    +>>> PurePosixPath('my/library').stem
    +'library'
    +
    +
    +
    + +
    +
    +PurePath.as_posix()
    +

    Return a string representation of the path with forward slashes (/):

    +
    >>> p = PureWindowsPath('c:\\windows')
    +>>> str(p)
    +'c:\\windows'
    +>>> p.as_posix()
    +'c:/windows'
    +
    +
    +
    + +
    +
    +PurePath.as_uri()
    +

    Represent the path as a file URI. ValueError is raised if +the path isn’t absolute.

    +
    >>> p = PurePosixPath('/etc/passwd')
    +>>> p.as_uri()
    +'file:///etc/passwd'
    +>>> p = PureWindowsPath('c:/Windows')
    +>>> p.as_uri()
    +'file:///c:/Windows'
    +
    +
    +
    + +
    +
    +PurePath.is_absolute()
    +

    Return whether the path is absolute or not. A path is considered absolute +if it has both a root and (if the flavour allows) a drive:

    +
    >>> PurePosixPath('/a/b').is_absolute()
    +True
    +>>> PurePosixPath('a/b').is_absolute()
    +False
    +
    +>>> PureWindowsPath('c:/a/b').is_absolute()
    +True
    +>>> PureWindowsPath('/a/b').is_absolute()
    +False
    +>>> PureWindowsPath('c:').is_absolute()
    +False
    +>>> PureWindowsPath('//some/share').is_absolute()
    +True
    +
    +
    +
    + +
    +
    +PurePath.is_reserved()
    +

    With PureWindowsPath, return True if the path is considered +reserved under Windows, False otherwise. With PurePosixPath, +False is always returned.

    +
    >>> PureWindowsPath('nul').is_reserved()
    +True
    +>>> PurePosixPath('nul').is_reserved()
    +False
    +
    +
    +

    File system calls on reserved paths can fail mysteriously or have +unintended effects.

    +
    + +
    +
    +PurePath.joinpath(*other)
    +

    Calling this method is equivalent to combining the path with each of +the other arguments in turn:

    +
    >>> PurePosixPath('/etc').joinpath('passwd')
    +PurePosixPath('/etc/passwd')
    +>>> PurePosixPath('/etc').joinpath(PurePosixPath('passwd'))
    +PurePosixPath('/etc/passwd')
    +>>> PurePosixPath('/etc').joinpath('init.d', 'apache2')
    +PurePosixPath('/etc/init.d/apache2')
    +>>> PureWindowsPath('c:').joinpath('/Program Files')
    +PureWindowsPath('c:/Program Files')
    +
    +
    +
    + +
    +
    +PurePath.match(pattern)
    +

    Match this path against the provided glob-style pattern. Return True +if matching is successful, False otherwise.

    +

    If pattern is relative, the path can be either relative or absolute, +and matching is done from the right:

    +
    >>> PurePath('a/b.py').match('*.py')
    +True
    +>>> PurePath('/a/b/c.py').match('b/*.py')
    +True
    +>>> PurePath('/a/b/c.py').match('a/*.py')
    +False
    +
    +
    +

    If pattern is absolute, the path must be absolute, and the whole path +must match:

    +
    >>> PurePath('/a.py').match('/*.py')
    +True
    +>>> PurePath('a/b.py').match('/*.py')
    +False
    +
    +
    +

    As with other methods, case-sensitivity is observed:

    +
    >>> PureWindowsPath('b.py').match('*.PY')
    +True
    +
    +
    +
    + +
    +
    +PurePath.relative_to(*other)
    +

    Compute a version of this path relative to the path represented by +other. If it’s impossible, ValueError is raised:

    +
    >>> p = PurePosixPath('/etc/passwd')
    +>>> p.relative_to('/')
    +PurePosixPath('etc/passwd')
    +>>> p.relative_to('/etc')
    +PurePosixPath('passwd')
    +>>> p.relative_to('/usr')
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +  File "pathlib.py", line 694, in relative_to
    +    .format(str(self), str(formatted)))
    +ValueError: '/etc/passwd' does not start with '/usr'
    +
    +
    +
    + +
    +
    +PurePath.with_name(name)
    +

    Return a new path with the name changed. If the original path +doesn’t have a name, ValueError is raised:

    +
    >>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz')
    +>>> p.with_name('setup.py')
    +PureWindowsPath('c:/Downloads/setup.py')
    +>>> p = PureWindowsPath('c:/')
    +>>> p.with_name('setup.py')
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +  File "/home/antoine/cpython/default/Lib/pathlib.py", line 751, in with_name
    +    raise ValueError("%r has an empty name" % (self,))
    +ValueError: PureWindowsPath('c:/') has an empty name
    +
    +
    +
    + +
    +
    +PurePath.with_suffix(suffix)
    +

    Return a new path with the suffix changed. If the original path +doesn’t have a suffix, the new suffix is appended instead. If the +suffix is an empty string, the original suffix is removed:

    +
    >>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz')
    +>>> p.with_suffix('.bz2')
    +PureWindowsPath('c:/Downloads/pathlib.tar.bz2')
    +>>> p = PureWindowsPath('README')
    +>>> p.with_suffix('.txt')
    +PureWindowsPath('README.txt')
    +>>> p = PureWindowsPath('README.txt')
    +>>> p.with_suffix('')
    +PureWindowsPath('README')
    +
    +
    +
    + +
    +
    +
    +

    Concrete paths

    +

    Concrete paths are subclasses of the pure path classes. In addition to +operations provided by the latter, they also provide methods to do system +calls on path objects. There are three ways to instantiate concrete paths:

    +
    +
    +class pathlib.Path(*pathsegments)
    +

    A subclass of PurePath, this class represents concrete paths of +the system’s path flavour (instantiating it creates either a +PosixPath or a WindowsPath):

    +
    >>> Path('setup.py')
    +PosixPath('setup.py')
    +
    +
    +

    pathsegments is specified similarly to PurePath.

    +
    + +
    +
    +class pathlib.PosixPath(*pathsegments)
    +

    A subclass of Path and PurePosixPath, this class +represents concrete non-Windows filesystem paths:

    +
    >>> PosixPath('/etc')
    +PosixPath('/etc')
    +
    +
    +

    pathsegments is specified similarly to PurePath.

    +
    + +
    +
    +class pathlib.WindowsPath(*pathsegments)
    +

    A subclass of Path and PureWindowsPath, this class +represents concrete Windows filesystem paths:

    +
    >>> WindowsPath('c:/Program Files/')
    +WindowsPath('c:/Program Files')
    +
    +
    +

    pathsegments is specified similarly to PurePath.

    +
    + +

    You can only instantiate the class flavour that corresponds to your system +(allowing system calls on non-compatible path flavours could lead to +bugs or failures in your application):

    +
    >>> import os
    +>>> os.name
    +'posix'
    +>>> Path('setup.py')
    +PosixPath('setup.py')
    +>>> PosixPath('setup.py')
    +PosixPath('setup.py')
    +>>> WindowsPath('setup.py')
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +  File "pathlib.py", line 798, in __new__
    +    % (cls.__name__,))
    +NotImplementedError: cannot instantiate 'WindowsPath' on your system
    +
    +
    +
    +

    Methods

    +

    Concrete paths provide the following methods in addition to pure paths +methods. Many of these methods can raise an OSError if a system +call fails (for example because the path doesn’t exist):

    +
    +
    +classmethod Path.cwd()
    +

    Return a new path object representing the current directory (as returned +by os.getcwd()):

    +
    >>> Path.cwd()
    +PosixPath('/home/antoine/pathlib')
    +
    +
    +
    + +
    +
    +classmethod Path.home()
    +

    Return a new path object representing the user’s home directory (as +returned by os.path.expanduser() with ~ construct):

    +
    >>> Path.home()
    +PosixPath('/home/antoine')
    +
    +
    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +Path.stat()
    +

    Return information about this path (similarly to os.stat()). +The result is looked up at each call to this method.

    +
    >>> p = Path('setup.py')
    +>>> p.stat().st_size
    +956
    +>>> p.stat().st_mtime
    +1327883547.852554
    +
    +
    +
    + +
    +
    +Path.chmod(mode)
    +

    Change the file mode and permissions, like os.chmod():

    +
    >>> p = Path('setup.py')
    +>>> p.stat().st_mode
    +33277
    +>>> p.chmod(0o444)
    +>>> p.stat().st_mode
    +33060
    +
    +
    +
    + +
    +
    +Path.exists()
    +

    Whether the path points to an existing file or directory:

    +
    >>> Path('.').exists()
    +True
    +>>> Path('setup.py').exists()
    +True
    +>>> Path('/etc').exists()
    +True
    +>>> Path('nonexistentfile').exists()
    +False
    +
    +
    +
    +

    Note

    +

    If the path points to a symlink, exists() returns whether the +symlink points to an existing file or directory.

    +
    +
    + +
    +
    +Path.expanduser()
    +

    Return a new path with expanded ~ and ~user constructs, +as returned by os.path.expanduser():

    +
    >>> p = PosixPath('~/films/Monty Python')
    +>>> p.expanduser()
    +PosixPath('/home/eric/films/Monty Python')
    +
    +
    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +Path.glob(pattern)
    +

    Glob the given relative pattern in the directory represented by this path, +yielding all matching files (of any kind):

    +
    >>> sorted(Path('.').glob('*.py'))
    +[PosixPath('pathlib.py'), PosixPath('setup.py'), PosixPath('test_pathlib.py')]
    +>>> sorted(Path('.').glob('*/*.py'))
    +[PosixPath('docs/conf.py')]
    +
    +
    +

    The “**” pattern means “this directory and all subdirectories, +recursively”. In other words, it enables recursive globbing:

    +
    >>> sorted(Path('.').glob('**/*.py'))
    +[PosixPath('build/lib/pathlib.py'),
    + PosixPath('docs/conf.py'),
    + PosixPath('pathlib.py'),
    + PosixPath('setup.py'),
    + PosixPath('test_pathlib.py')]
    +
    +
    +
    +

    Note

    +

    Using the “**” pattern in large directory trees may consume +an inordinate amount of time.

    +
    +
    + +
    +
    +Path.group()
    +

    Return the name of the group owning the file. KeyError is raised +if the file’s gid isn’t found in the system database.

    +
    + +
    +
    +Path.is_dir()
    +

    Return True if the path points to a directory (or a symbolic link +pointing to a directory), False if it points to another kind of file.

    +

    False is also returned if the path doesn’t exist or is a broken symlink; +other errors (such as permission errors) are propagated.

    +
    + +
    +
    +Path.is_file()
    +

    Return True if the path points to a regular file (or a symbolic link +pointing to a regular file), False if it points to another kind of file.

    +

    False is also returned if the path doesn’t exist or is a broken symlink; +other errors (such as permission errors) are propagated.

    +
    + +
    +
    +Path.is_mount()
    +

    Return True if the path is a mount point: a point in a +file system where a different file system has been mounted. On POSIX, the +function checks whether path’s parent, path/.., is on a different +device than path, or whether path/.. and path point to the same +i-node on the same device — this should detect mount points for all Unix +and POSIX variants. Not implemented on Windows.

    +
    +

    New in version 3.7.

    +
    +
    + +
    + +

    Return True if the path points to a symbolic link, False otherwise.

    +

    False is also returned if the path doesn’t exist; other errors (such +as permission errors) are propagated.

    +
    + +
    +
    +Path.is_socket()
    +

    Return True if the path points to a Unix socket (or a symbolic link +pointing to a Unix socket), False if it points to another kind of file.

    +

    False is also returned if the path doesn’t exist or is a broken symlink; +other errors (such as permission errors) are propagated.

    +
    + +
    +
    +Path.is_fifo()
    +

    Return True if the path points to a FIFO (or a symbolic link +pointing to a FIFO), False if it points to another kind of file.

    +

    False is also returned if the path doesn’t exist or is a broken symlink; +other errors (such as permission errors) are propagated.

    +
    + +
    +
    +Path.is_block_device()
    +

    Return True if the path points to a block device (or a symbolic link +pointing to a block device), False if it points to another kind of file.

    +

    False is also returned if the path doesn’t exist or is a broken symlink; +other errors (such as permission errors) are propagated.

    +
    + +
    +
    +Path.is_char_device()
    +

    Return True if the path points to a character device (or a symbolic link +pointing to a character device), False if it points to another kind of file.

    +

    False is also returned if the path doesn’t exist or is a broken symlink; +other errors (such as permission errors) are propagated.

    +
    + +
    +
    +Path.iterdir()
    +

    When the path points to a directory, yield path objects of the directory +contents:

    +
    >>> p = Path('docs')
    +>>> for child in p.iterdir(): child
    +...
    +PosixPath('docs/conf.py')
    +PosixPath('docs/_templates')
    +PosixPath('docs/make.bat')
    +PosixPath('docs/index.rst')
    +PosixPath('docs/_build')
    +PosixPath('docs/_static')
    +PosixPath('docs/Makefile')
    +
    +
    +
    + +
    +
    +Path.lchmod(mode)
    +

    Like Path.chmod() but, if the path points to a symbolic link, the +symbolic link’s mode is changed rather than its target’s.

    +
    + +
    +
    +Path.lstat()
    +

    Like Path.stat() but, if the path points to a symbolic link, return +the symbolic link’s information rather than its target’s.

    +
    + +
    +
    +Path.mkdir(mode=0o777, parents=False, exist_ok=False)
    +

    Create a new directory at this given path. If mode is given, it is +combined with the process’ umask value to determine the file mode +and access flags. If the path already exists, FileExistsError +is raised.

    +

    If parents is true, any missing parents of this path are created +as needed; they are created with the default permissions without taking +mode into account (mimicking the POSIX mkdir -p command).

    +

    If parents is false (the default), a missing parent raises +FileNotFoundError.

    +

    If exist_ok is false (the default), FileExistsError is +raised if the target directory already exists.

    +

    If exist_ok is true, FileExistsError exceptions will be +ignored (same behavior as the POSIX mkdir -p command), but only if the +last path component is not an existing non-directory file.

    +
    +

    Changed in version 3.5: The exist_ok parameter was added.

    +
    +
    + +
    +
    +Path.open(mode='r', buffering=-1, encoding=None, errors=None, newline=None)
    +

    Open the file pointed to by the path, like the built-in open() +function does:

    +
    >>> p = Path('setup.py')
    +>>> with p.open() as f:
    +...     f.readline()
    +...
    +'#!/usr/bin/env python3\n'
    +
    +
    +
    + +
    +
    +Path.owner()
    +

    Return the name of the user owning the file. KeyError is raised +if the file’s uid isn’t found in the system database.

    +
    + +
    +
    +Path.read_bytes()
    +

    Return the binary contents of the pointed-to file as a bytes object:

    +
    >>> p = Path('my_binary_file')
    +>>> p.write_bytes(b'Binary file contents')
    +20
    +>>> p.read_bytes()
    +b'Binary file contents'
    +
    +
    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +Path.read_text(encoding=None, errors=None)
    +

    Return the decoded contents of the pointed-to file as a string:

    +
    >>> p = Path('my_text_file')
    +>>> p.write_text('Text file contents')
    +18
    +>>> p.read_text()
    +'Text file contents'
    +
    +
    +

    The file is opened and then closed. The optional parameters have the same +meaning as in open().

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +Path.rename(target)
    +

    Rename this file or directory to the given target. On Unix, if +target exists and is a file, it will be replaced silently if the user +has permission. target can be either a string or another path object:

    +
    >>> p = Path('foo')
    +>>> p.open('w').write('some text')
    +9
    +>>> target = Path('bar')
    +>>> p.rename(target)
    +>>> target.open().read()
    +'some text'
    +
    +
    +
    + +
    +
    +Path.replace(target)
    +

    Rename this file or directory to the given target. If target points +to an existing file or directory, it will be unconditionally replaced.

    +
    + +
    +
    +Path.resolve(strict=False)
    +

    Make the path absolute, resolving any symlinks. A new path object is +returned:

    +
    >>> p = Path()
    +>>> p
    +PosixPath('.')
    +>>> p.resolve()
    +PosixPath('/home/antoine/pathlib')
    +
    +
    +

    ..” components are also eliminated (this is the only method to do so):

    +
    >>> p = Path('docs/../setup.py')
    +>>> p.resolve()
    +PosixPath('/home/antoine/pathlib/setup.py')
    +
    +
    +

    If the path doesn’t exist and strict is True, FileNotFoundError +is raised. If strict is False, the path is resolved as far as possible +and any remainder is appended without checking whether it exists. If an +infinite loop is encountered along the resolution path, RuntimeError +is raised.

    +
    +

    New in version 3.6: The strict argument (pre-3.6 behavior is strict).

    +
    +
    + +
    +
    +Path.rglob(pattern)
    +

    This is like calling Path.glob() with “**/” added in front of the +given relative pattern:

    +
    >>> sorted(Path().rglob("*.py"))
    +[PosixPath('build/lib/pathlib.py'),
    + PosixPath('docs/conf.py'),
    + PosixPath('pathlib.py'),
    + PosixPath('setup.py'),
    + PosixPath('test_pathlib.py')]
    +
    +
    +
    + +
    +
    +Path.rmdir()
    +

    Remove this directory. The directory must be empty.

    +
    + +
    +
    +Path.samefile(other_path)
    +

    Return whether this path points to the same file as other_path, which +can be either a Path object, or a string. The semantics are similar +to os.path.samefile() and os.path.samestat().

    +

    An OSError can be raised if either file cannot be accessed for some +reason.

    +
    >>> p = Path('spam')
    +>>> q = Path('eggs')
    +>>> p.samefile(q)
    +False
    +>>> p.samefile('spam')
    +True
    +
    +
    +
    +

    New in version 3.5.

    +
    +
    + +
    + +

    Make this path a symbolic link to target. Under Windows, +target_is_directory must be true (default False) if the link’s target +is a directory. Under POSIX, target_is_directory’s value is ignored.

    +
    >>> p = Path('mylink')
    +>>> p.symlink_to('setup.py')
    +>>> p.resolve()
    +PosixPath('/home/antoine/pathlib/setup.py')
    +>>> p.stat().st_size
    +956
    +>>> p.lstat().st_size
    +8
    +
    +
    +
    +

    Note

    +

    The order of arguments (link, target) is the reverse +of os.symlink()’s.

    +
    +
    + +
    +
    +Path.touch(mode=0o666, exist_ok=True)
    +

    Create a file at this given path. If mode is given, it is combined +with the process’ umask value to determine the file mode and access +flags. If the file already exists, the function succeeds if exist_ok +is true (and its modification time is updated to the current time), +otherwise FileExistsError is raised.

    +
    + +
    + +

    Remove this file or symbolic link. If the path points to a directory, +use Path.rmdir() instead.

    +
    + +
    +
    +Path.write_bytes(data)
    +

    Open the file pointed to in bytes mode, write data to it, and close the +file:

    +
    >>> p = Path('my_binary_file')
    +>>> p.write_bytes(b'Binary file contents')
    +20
    +>>> p.read_bytes()
    +b'Binary file contents'
    +
    +
    +

    An existing file of the same name is overwritten.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +Path.write_text(data, encoding=None, errors=None)
    +

    Open the file pointed to in text mode, write data to it, and close the +file:

    +
    >>> p = Path('my_text_file')
    +>>> p.write_text('Text file contents')
    +18
    +>>> p.read_text()
    +'Text file contents'
    +
    +
    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/pdb.html b/python-3.7.4-docs-html/library/pdb.html new file mode 100644 index 0000000..07dd7a9 --- /dev/null +++ b/python-3.7.4-docs-html/library/pdb.html @@ -0,0 +1,757 @@ + + + + + + + pdb — The Python Debugger — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    pdb — The Python Debugger

    +

    Source code: Lib/pdb.py

    +
    +

    The module pdb defines an interactive source code debugger for Python +programs. It supports setting (conditional) breakpoints and single stepping at +the source line level, inspection of stack frames, source code listing, and +evaluation of arbitrary Python code in the context of any stack frame. It also +supports post-mortem debugging and can be called under program control.

    +

    The debugger is extensible – it is actually defined as the class Pdb. +This is currently undocumented but easily understood by reading the source. The +extension interface uses the modules bdb and cmd.

    +

    The debugger’s prompt is (Pdb). Typical usage to run a program under control +of the debugger is:

    +
    >>> import pdb
    +>>> import mymodule
    +>>> pdb.run('mymodule.test()')
    +> <string>(0)?()
    +(Pdb) continue
    +> <string>(1)?()
    +(Pdb) continue
    +NameError: 'spam'
    +> <string>(1)?()
    +(Pdb)
    +
    +
    +
    +

    Changed in version 3.3: Tab-completion via the readline module is available for commands and +command arguments, e.g. the current global and local names are offered as +arguments of the p command.

    +
    +

    pdb.py can also be invoked as a script to debug other scripts. For +example:

    +
    python3 -m pdb myscript.py
    +
    +
    +

    When invoked as a script, pdb will automatically enter post-mortem debugging if +the program being debugged exits abnormally. After post-mortem debugging (or +after normal exit of the program), pdb will restart the program. Automatic +restarting preserves pdb’s state (such as breakpoints) and in most cases is more +useful than quitting the debugger upon program’s exit.

    +
    +

    New in version 3.2: pdb.py now accepts a -c option that executes commands as if given +in a .pdbrc file, see Debugger Commands.

    +
    +
    +

    New in version 3.7: pdb.py now accepts a -m option that execute modules similar to the way +python3 -m does. As with a script, the debugger will pause execution just +before the first line of the module.

    +
    +

    The typical usage to break into the debugger from a running program is to +insert

    +
    import pdb; pdb.set_trace()
    +
    +
    +

    at the location you want to break into the debugger. You can then step through +the code following this statement, and continue running without the debugger +using the continue command.

    +
    +

    New in version 3.7: The built-in breakpoint(), when called with defaults, can be used +instead of import pdb; pdb.set_trace().

    +
    +

    The typical usage to inspect a crashed program is:

    +
    >>> import pdb
    +>>> import mymodule
    +>>> mymodule.test()
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +  File "./mymodule.py", line 4, in test
    +    test2()
    +  File "./mymodule.py", line 3, in test2
    +    print(spam)
    +NameError: spam
    +>>> pdb.pm()
    +> ./mymodule.py(3)test2()
    +-> print(spam)
    +(Pdb)
    +
    +
    +

    The module defines the following functions; each enters the debugger in a +slightly different way:

    +
    +
    +pdb.run(statement, globals=None, locals=None)
    +

    Execute the statement (given as a string or a code object) under debugger +control. The debugger prompt appears before any code is executed; you can +set breakpoints and type continue, or you can step through the +statement using step or next (all these commands are +explained below). The optional globals and locals arguments specify the +environment in which the code is executed; by default the dictionary of the +module __main__ is used. (See the explanation of the built-in +exec() or eval() functions.)

    +
    + +
    +
    +pdb.runeval(expression, globals=None, locals=None)
    +

    Evaluate the expression (given as a string or a code object) under debugger +control. When runeval() returns, it returns the value of the +expression. Otherwise this function is similar to run().

    +
    + +
    +
    +pdb.runcall(function, *args, **kwds)
    +

    Call the function (a function or method object, not a string) with the +given arguments. When runcall() returns, it returns whatever the +function call returned. The debugger prompt appears as soon as the function +is entered.

    +
    + +
    +
    +pdb.set_trace(*, header=None)
    +

    Enter the debugger at the calling stack frame. This is useful to hard-code +a breakpoint at a given point in a program, even if the code is not +otherwise being debugged (e.g. when an assertion fails). If given, +header is printed to the console just before debugging begins.

    +
    +

    Changed in version 3.7: The keyword-only argument header.

    +
    +
    + +
    +
    +pdb.post_mortem(traceback=None)
    +

    Enter post-mortem debugging of the given traceback object. If no +traceback is given, it uses the one of the exception that is currently +being handled (an exception must be being handled if the default is to be +used).

    +
    + +
    +
    +pdb.pm()
    +

    Enter post-mortem debugging of the traceback found in +sys.last_traceback.

    +
    + +

    The run* functions and set_trace() are aliases for instantiating the +Pdb class and calling the method of the same name. If you want to +access further features, you have to do this yourself:

    +
    +
    +class pdb.Pdb(completekey='tab', stdin=None, stdout=None, skip=None, nosigint=False, readrc=True)
    +

    Pdb is the debugger class.

    +

    The completekey, stdin and stdout arguments are passed to the +underlying cmd.Cmd class; see the description there.

    +

    The skip argument, if given, must be an iterable of glob-style module name +patterns. The debugger will not step into frames that originate in a module +that matches one of these patterns. 1

    +

    By default, Pdb sets a handler for the SIGINT signal (which is sent when the +user presses Ctrl-C on the console) when you give a continue command. +This allows you to break into the debugger again by pressing Ctrl-C. If you +want Pdb not to touch the SIGINT handler, set nosigint to true.

    +

    The readrc argument defaults to true and controls whether Pdb will load +.pdbrc files from the filesystem.

    +

    Example call to enable tracing with skip:

    +
    import pdb; pdb.Pdb(skip=['django.*']).set_trace()
    +
    +
    +
    +

    New in version 3.1: The skip argument.

    +
    +
    +

    New in version 3.2: The nosigint argument. Previously, a SIGINT handler was never set by +Pdb.

    +
    +
    +

    Changed in version 3.6: The readrc argument.

    +
    +
    +
    +run(statement, globals=None, locals=None)
    +
    +runeval(expression, globals=None, locals=None)
    +
    +runcall(function, *args, **kwds)
    +
    +set_trace()
    +

    See the documentation for the functions explained above.

    +
    + +
    + +
    +

    Debugger Commands

    +

    The commands recognized by the debugger are listed below. Most commands can be +abbreviated to one or two letters as indicated; e.g. h(elp) means that +either h or help can be used to enter the help command (but not he +or hel, nor H or Help or HELP). Arguments to commands must be +separated by whitespace (spaces or tabs). Optional arguments are enclosed in +square brackets ([]) in the command syntax; the square brackets must not be +typed. Alternatives in the command syntax are separated by a vertical bar +(|).

    +

    Entering a blank line repeats the last command entered. Exception: if the last +command was a list command, the next 11 lines are listed.

    +

    Commands that the debugger doesn’t recognize are assumed to be Python statements +and are executed in the context of the program being debugged. Python +statements can also be prefixed with an exclamation point (!). This is a +powerful way to inspect the program being debugged; it is even possible to +change a variable or call a function. When an exception occurs in such a +statement, the exception name is printed but the debugger’s state is not +changed.

    +

    The debugger supports aliases. Aliases can have +parameters which allows one a certain level of adaptability to the context under +examination.

    +

    Multiple commands may be entered on a single line, separated by ;;. (A +single ; is not used as it is the separator for multiple commands in a line +that is passed to the Python parser.) No intelligence is applied to separating +the commands; the input is split at the first ;; pair, even if it is in the +middle of a quoted string.

    +

    If a file .pdbrc exists in the user’s home directory or in the current +directory, it is read in and executed as if it had been typed at the debugger +prompt. This is particularly useful for aliases. If both files exist, the one +in the home directory is read first and aliases defined there can be overridden +by the local file.

    +
    +

    Changed in version 3.2: .pdbrc can now contain commands that continue debugging, such as +continue or next. Previously, these commands had no +effect.

    +
    +
    +
    +h(elp) [command]
    +

    Without argument, print the list of available commands. With a command as +argument, print help about that command. help pdb displays the full +documentation (the docstring of the pdb module). Since the command +argument must be an identifier, help exec must be entered to get help on +the ! command.

    +
    + +
    +
    +w(here)
    +

    Print a stack trace, with the most recent frame at the bottom. An arrow +indicates the current frame, which determines the context of most commands.

    +
    + +
    +
    +d(own) [count]
    +

    Move the current frame count (default one) levels down in the stack trace +(to a newer frame).

    +
    + +
    +
    +u(p) [count]
    +

    Move the current frame count (default one) levels up in the stack trace (to +an older frame).

    +
    + +
    +
    +b(reak) [([filename:]lineno | function) [, condition]]
    +

    With a lineno argument, set a break there in the current file. With a +function argument, set a break at the first executable statement within +that function. The line number may be prefixed with a filename and a colon, +to specify a breakpoint in another file (probably one that hasn’t been loaded +yet). The file is searched on sys.path. Note that each breakpoint +is assigned a number to which all the other breakpoint commands refer.

    +

    If a second argument is present, it is an expression which must evaluate to +true before the breakpoint is honored.

    +

    Without argument, list all breaks, including for each breakpoint, the number +of times that breakpoint has been hit, the current ignore count, and the +associated condition if any.

    +
    + +
    +
    +tbreak [([filename:]lineno | function) [, condition]]
    +

    Temporary breakpoint, which is removed automatically when it is first hit. +The arguments are the same as for break.

    +
    + +
    +
    +cl(ear) [filename:lineno | bpnumber [bpnumber ...]]
    +

    With a filename:lineno argument, clear all the breakpoints at this line. +With a space separated list of breakpoint numbers, clear those breakpoints. +Without argument, clear all breaks (but first ask confirmation).

    +
    + +
    +
    +disable [bpnumber [bpnumber ...]]
    +

    Disable the breakpoints given as a space separated list of breakpoint +numbers. Disabling a breakpoint means it cannot cause the program to stop +execution, but unlike clearing a breakpoint, it remains in the list of +breakpoints and can be (re-)enabled.

    +
    + +
    +
    +enable [bpnumber [bpnumber ...]]
    +

    Enable the breakpoints specified.

    +
    + +
    +
    +ignore bpnumber [count]
    +

    Set the ignore count for the given breakpoint number. If count is omitted, +the ignore count is set to 0. A breakpoint becomes active when the ignore +count is zero. When non-zero, the count is decremented each time the +breakpoint is reached and the breakpoint is not disabled and any associated +condition evaluates to true.

    +
    + +
    +
    +condition bpnumber [condition]
    +

    Set a new condition for the breakpoint, an expression which must evaluate +to true before the breakpoint is honored. If condition is absent, any +existing condition is removed; i.e., the breakpoint is made unconditional.

    +
    + +
    +
    +commands [bpnumber]
    +

    Specify a list of commands for breakpoint number bpnumber. The commands +themselves appear on the following lines. Type a line containing just +end to terminate the commands. An example:

    +
    (Pdb) commands 1
    +(com) p some_variable
    +(com) end
    +(Pdb)
    +
    +
    +

    To remove all commands from a breakpoint, type commands and follow it +immediately with end; that is, give no commands.

    +

    With no bpnumber argument, commands refers to the last breakpoint set.

    +

    You can use breakpoint commands to start your program up again. Simply use +the continue command, or step, +or any other command that resumes execution.

    +

    Specifying any command resuming execution +(currently continue, step, next, +return, jump, quit and their abbreviations) +terminates the command list (as if +that command was immediately followed by end). This is because any time you +resume execution (even with a simple next or step), you may encounter another +breakpoint—which could have its own command list, leading to ambiguities about +which list to execute.

    +

    If you use the ‘silent’ command in the command list, the usual message about +stopping at a breakpoint is not printed. This may be desirable for breakpoints +that are to print a specific message and then continue. If none of the other +commands print anything, you see no sign that the breakpoint was reached.

    +
    + +
    +
    +s(tep)
    +

    Execute the current line, stop at the first possible occasion (either in a +function that is called or on the next line in the current function).

    +
    + +
    +
    +n(ext)
    +

    Continue execution until the next line in the current function is reached or +it returns. (The difference between next and step is +that step stops inside a called function, while next +executes called functions at (nearly) full speed, only stopping at the next +line in the current function.)

    +
    + +
    +
    +unt(il) [lineno]
    +

    Without argument, continue execution until the line with a number greater +than the current one is reached.

    +

    With a line number, continue execution until a line with a number greater or +equal to that is reached. In both cases, also stop when the current frame +returns.

    +
    +

    Changed in version 3.2: Allow giving an explicit line number.

    +
    +
    + +
    +
    +r(eturn)
    +

    Continue execution until the current function returns.

    +
    + +
    +
    +c(ont(inue))
    +

    Continue execution, only stop when a breakpoint is encountered.

    +
    + +
    +
    +j(ump) lineno
    +

    Set the next line that will be executed. Only available in the bottom-most +frame. This lets you jump back and execute code again, or jump forward to +skip code that you don’t want to run.

    +

    It should be noted that not all jumps are allowed – for instance it is not +possible to jump into the middle of a for loop or out of a +finally clause.

    +
    + +
    +
    +l(ist) [first[, last]]
    +

    List source code for the current file. Without arguments, list 11 lines +around the current line or continue the previous listing. With . as +argument, list 11 lines around the current line. With one argument, +list 11 lines around at that line. With two arguments, list the given range; +if the second argument is less than the first, it is interpreted as a count.

    +

    The current line in the current frame is indicated by ->. If an +exception is being debugged, the line where the exception was originally +raised or propagated is indicated by >>, if it differs from the current +line.

    +
    +

    New in version 3.2: The >> marker.

    +
    +
    + +
    +
    +ll | longlist
    +

    List all source code for the current function or frame. Interesting lines +are marked as for list.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +a(rgs)
    +

    Print the argument list of the current function.

    +
    + +
    +
    +p expression
    +

    Evaluate the expression in the current context and print its value.

    +
    +

    Note

    +

    print() can also be used, but is not a debugger command — this executes the +Python print() function.

    +
    +
    + +
    +
    +pp expression
    +

    Like the p command, except the value of the expression is +pretty-printed using the pprint module.

    +
    + +
    +
    +whatis expression
    +

    Print the type of the expression.

    +
    + +
    +
    +source expression
    +

    Try to get source code for the given object and display it.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +display [expression]
    +

    Display the value of the expression if it changed, each time execution stops +in the current frame.

    +

    Without expression, list all display expressions for the current frame.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +undisplay [expression]
    +

    Do not display the expression any more in the current frame. Without +expression, clear all display expressions for the current frame.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +interact
    +

    Start an interactive interpreter (using the code module) whose global +namespace contains all the (global and local) names found in the current +scope.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +alias [name [command]]
    +

    Create an alias called name that executes command. The command must +not be enclosed in quotes. Replaceable parameters can be indicated by +%1, %2, and so on, while %* is replaced by all the parameters. +If no command is given, the current alias for name is shown. If no +arguments are given, all aliases are listed.

    +

    Aliases may be nested and can contain anything that can be legally typed at +the pdb prompt. Note that internal pdb commands can be overridden by +aliases. Such a command is then hidden until the alias is removed. Aliasing +is recursively applied to the first word of the command line; all other words +in the line are left alone.

    +

    As an example, here are two useful aliases (especially when placed in the +.pdbrc file):

    +
    # Print instance variables (usage "pi classInst")
    +alias pi for k in %1.__dict__.keys(): print("%1.",k,"=",%1.__dict__[k])
    +# Print instance variables in self
    +alias ps pi self
    +
    +
    +
    + +
    +
    +unalias name
    +

    Delete the specified alias.

    +
    + +
    +
    +! statement
    +

    Execute the (one-line) statement in the context of the current stack frame. +The exclamation point can be omitted unless the first word of the statement +resembles a debugger command. To set a global variable, you can prefix the +assignment command with a global statement on the same line, +e.g.:

    +
    (Pdb) global list_options; list_options = ['-l']
    +(Pdb)
    +
    +
    +
    + +
    +
    +run [args ...]
    +
    +restart [args ...]
    +

    Restart the debugged Python program. If an argument is supplied, it is split +with shlex and the result is used as the new sys.argv. +History, breakpoints, actions and debugger options are preserved. +restart is an alias for run.

    +
    + +
    +
    +q(uit)
    +

    Quit from the debugger. The program being executed is aborted.

    +
    + +

    Footnotes

    +
    +
    1
    +

    Whether a frame is considered to originate in a certain module +is determined by the __name__ in the frame globals.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/persistence.html b/python-3.7.4-docs-html/library/persistence.html new file mode 100644 index 0000000..353681b --- /dev/null +++ b/python-3.7.4-docs-html/library/persistence.html @@ -0,0 +1,257 @@ + + + + + + + Data Persistence — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Data Persistence

    +

    The modules described in this chapter support storing Python data in a +persistent form on disk. The pickle and marshal modules can turn +many Python data types into a stream of bytes and then recreate the objects from +the bytes. The various DBM-related modules support a family of hash-based file +formats that store a mapping of strings to other strings.

    +

    The list of modules described in this chapter is:

    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/pickle.html b/python-3.7.4-docs-html/library/pickle.html new file mode 100644 index 0000000..b69adc6 --- /dev/null +++ b/python-3.7.4-docs-html/library/pickle.html @@ -0,0 +1,1122 @@ + + + + + + + pickle — Python object serialization — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    pickle — Python object serialization

    +

    Source code: Lib/pickle.py

    +
    +

    The pickle module implements binary protocols for serializing and +de-serializing a Python object structure. “Pickling” is the process +whereby a Python object hierarchy is converted into a byte stream, and +“unpickling” is the inverse operation, whereby a byte stream +(from a binary file or bytes-like object) is converted +back into an object hierarchy. Pickling (and unpickling) is alternatively +known as “serialization”, “marshalling,” 1 or “flattening”; however, to +avoid confusion, the terms used here are “pickling” and “unpickling”.

    +
    +

    Warning

    +

    The pickle module is not secure against erroneous or maliciously +constructed data. Never unpickle data received from an untrusted or +unauthenticated source.

    +
    +
    +

    Relationship to other Python modules

    +
    +

    Comparison with marshal

    +

    Python has a more primitive serialization module called marshal, but in +general pickle should always be the preferred way to serialize Python +objects. marshal exists primarily to support Python’s .pyc +files.

    +

    The pickle module differs from marshal in several significant ways:

    +
      +
    • The pickle module keeps track of the objects it has already serialized, +so that later references to the same object won’t be serialized again. +marshal doesn’t do this.

      +

      This has implications both for recursive objects and object sharing. Recursive +objects are objects that contain references to themselves. These are not +handled by marshal, and in fact, attempting to marshal recursive objects will +crash your Python interpreter. Object sharing happens when there are multiple +references to the same object in different places in the object hierarchy being +serialized. pickle stores such objects only once, and ensures that all +other references point to the master copy. Shared objects remain shared, which +can be very important for mutable objects.

      +
    • +
    • marshal cannot be used to serialize user-defined classes and their +instances. pickle can save and restore class instances transparently, +however the class definition must be importable and live in the same module as +when the object was stored.

    • +
    • The marshal serialization format is not guaranteed to be portable +across Python versions. Because its primary job in life is to support +.pyc files, the Python implementers reserve the right to change the +serialization format in non-backwards compatible ways should the need arise. +The pickle serialization format is guaranteed to be backwards compatible +across Python releases provided a compatible pickle protocol is chosen and +pickling and unpickling code deals with Python 2 to Python 3 type differences +if your data is crossing that unique breaking change language boundary.

    • +
    +
    +
    +

    Comparison with json

    +

    There are fundamental differences between the pickle protocols and +JSON (JavaScript Object Notation):

    +
      +
    • JSON is a text serialization format (it outputs unicode text, although +most of the time it is then encoded to utf-8), while pickle is +a binary serialization format;

    • +
    • JSON is human-readable, while pickle is not;

    • +
    • JSON is interoperable and widely used outside of the Python ecosystem, +while pickle is Python-specific;

    • +
    • JSON, by default, can only represent a subset of the Python built-in +types, and no custom classes; pickle can represent an extremely large +number of Python types (many of them automatically, by clever usage +of Python’s introspection facilities; complex cases can be tackled by +implementing specific object APIs).

    • +
    +
    +

    See also

    +

    The json module: a standard library module allowing JSON +serialization and deserialization.

    +
    +
    +
    +
    +

    Data stream format

    +

    The data format used by pickle is Python-specific. This has the +advantage that there are no restrictions imposed by external standards such as +JSON or XDR (which can’t represent pointer sharing); however it means that +non-Python programs may not be able to reconstruct pickled Python objects.

    +

    By default, the pickle data format uses a relatively compact binary +representation. If you need optimal size characteristics, you can efficiently +compress pickled data.

    +

    The module pickletools contains tools for analyzing data streams +generated by pickle. pickletools source code has extensive +comments about opcodes used by pickle protocols.

    +

    There are currently 5 different protocols which can be used for pickling. +The higher the protocol used, the more recent the version of Python needed +to read the pickle produced.

    +
      +
    • Protocol version 0 is the original “human-readable” protocol and is +backwards compatible with earlier versions of Python.

    • +
    • Protocol version 1 is an old binary format which is also compatible with +earlier versions of Python.

    • +
    • Protocol version 2 was introduced in Python 2.3. It provides much more +efficient pickling of new-style classes. Refer to PEP 307 for +information about improvements brought by protocol 2.

    • +
    • Protocol version 3 was added in Python 3.0. It has explicit support for +bytes objects and cannot be unpickled by Python 2.x. This is +the default protocol, and the recommended protocol when compatibility with +other Python 3 versions is required.

    • +
    • Protocol version 4 was added in Python 3.4. It adds support for very large +objects, pickling more kinds of objects, and some data format +optimizations. Refer to PEP 3154 for information about improvements +brought by protocol 4.

    • +
    +
    +

    Note

    +

    Serialization is a more primitive notion than persistence; although +pickle reads and writes file objects, it does not handle the issue of +naming persistent objects, nor the (even more complicated) issue of concurrent +access to persistent objects. The pickle module can transform a complex +object into a byte stream and it can transform the byte stream into an object +with the same internal structure. Perhaps the most obvious thing to do with +these byte streams is to write them onto a file, but it is also conceivable to +send them across a network or store them in a database. The shelve +module provides a simple interface to pickle and unpickle objects on +DBM-style database files.

    +
    +
    +
    +

    Module Interface

    +

    To serialize an object hierarchy, you simply call the dumps() function. +Similarly, to de-serialize a data stream, you call the loads() function. +However, if you want more control over serialization and de-serialization, +you can create a Pickler or an Unpickler object, respectively.

    +

    The pickle module provides the following constants:

    +
    +
    +pickle.HIGHEST_PROTOCOL
    +

    An integer, the highest protocol version +available. This value can be passed as a protocol value to functions +dump() and dumps() as well as the Pickler +constructor.

    +
    + +
    +
    +pickle.DEFAULT_PROTOCOL
    +

    An integer, the default protocol version used +for pickling. May be less than HIGHEST_PROTOCOL. Currently the +default protocol is 3, a new protocol designed for Python 3.

    +
    + +

    The pickle module provides the following functions to make the pickling +process more convenient:

    +
    +
    +pickle.dump(obj, file, protocol=None, *, fix_imports=True)
    +

    Write a pickled representation of obj to the open file object file. +This is equivalent to Pickler(file, protocol).dump(obj).

    +

    The optional protocol argument, an integer, tells the pickler to use +the given protocol; supported protocols are 0 to HIGHEST_PROTOCOL. +If not specified, the default is DEFAULT_PROTOCOL. If a negative +number is specified, HIGHEST_PROTOCOL is selected.

    +

    The file argument must have a write() method that accepts a single bytes +argument. It can thus be an on-disk file opened for binary writing, an +io.BytesIO instance, or any other custom object that meets this +interface.

    +

    If fix_imports is true and protocol is less than 3, pickle will try to +map the new Python 3 names to the old module names used in Python 2, so +that the pickle data stream is readable with Python 2.

    +
    + +
    +
    +pickle.dumps(obj, protocol=None, *, fix_imports=True)
    +

    Return the pickled representation of the object as a bytes object, +instead of writing it to a file.

    +

    Arguments protocol and fix_imports have the same meaning as in +dump().

    +
    + +
    +
    +pickle.load(file, *, fix_imports=True, encoding="ASCII", errors="strict")
    +

    Read a pickled object representation from the open file object +file and return the reconstituted object hierarchy specified therein. +This is equivalent to Unpickler(file).load().

    +

    The protocol version of the pickle is detected automatically, so no +protocol argument is needed. Bytes past the pickled object’s +representation are ignored.

    +

    The argument file must have two methods, a read() method that takes an +integer argument, and a readline() method that requires no arguments. Both +methods should return bytes. Thus file can be an on-disk file opened for +binary reading, an io.BytesIO object, or any other custom object +that meets this interface.

    +

    Optional keyword arguments are fix_imports, encoding and errors, +which are used to control compatibility support for pickle stream generated +by Python 2. If fix_imports is true, pickle will try to map the old +Python 2 names to the new names used in Python 3. The encoding and +errors tell pickle how to decode 8-bit string instances pickled by Python +2; these default to ‘ASCII’ and ‘strict’, respectively. The encoding can +be ‘bytes’ to read these 8-bit string instances as bytes objects. +Using encoding='latin1' is required for unpickling NumPy arrays and +instances of datetime, date and +time pickled by Python 2.

    +
    + +
    +
    +pickle.loads(bytes_object, *, fix_imports=True, encoding="ASCII", errors="strict")
    +

    Read a pickled object hierarchy from a bytes object and return the +reconstituted object hierarchy specified therein.

    +

    The protocol version of the pickle is detected automatically, so no +protocol argument is needed. Bytes past the pickled object’s +representation are ignored.

    +

    Optional keyword arguments are fix_imports, encoding and errors, +which are used to control compatibility support for pickle stream generated +by Python 2. If fix_imports is true, pickle will try to map the old +Python 2 names to the new names used in Python 3. The encoding and +errors tell pickle how to decode 8-bit string instances pickled by Python +2; these default to ‘ASCII’ and ‘strict’, respectively. The encoding can +be ‘bytes’ to read these 8-bit string instances as bytes objects. +Using encoding='latin1' is required for unpickling NumPy arrays and +instances of datetime, date and +time pickled by Python 2.

    +
    + +

    The pickle module defines three exceptions:

    +
    +
    +exception pickle.PickleError
    +

    Common base class for the other pickling exceptions. It inherits +Exception.

    +
    + +
    +
    +exception pickle.PicklingError
    +

    Error raised when an unpicklable object is encountered by Pickler. +It inherits PickleError.

    +

    Refer to What can be pickled and unpickled? to learn what kinds of objects can be +pickled.

    +
    + +
    +
    +exception pickle.UnpicklingError
    +

    Error raised when there is a problem unpickling an object, such as a data +corruption or a security violation. It inherits PickleError.

    +

    Note that other exceptions may also be raised during unpickling, including +(but not necessarily limited to) AttributeError, EOFError, ImportError, and +IndexError.

    +
    + +

    The pickle module exports two classes, Pickler and +Unpickler:

    +
    +
    +class pickle.Pickler(file, protocol=None, *, fix_imports=True)
    +

    This takes a binary file for writing a pickle data stream.

    +

    The optional protocol argument, an integer, tells the pickler to use +the given protocol; supported protocols are 0 to HIGHEST_PROTOCOL. +If not specified, the default is DEFAULT_PROTOCOL. If a negative +number is specified, HIGHEST_PROTOCOL is selected.

    +

    The file argument must have a write() method that accepts a single bytes +argument. It can thus be an on-disk file opened for binary writing, an +io.BytesIO instance, or any other custom object that meets this +interface.

    +

    If fix_imports is true and protocol is less than 3, pickle will try to +map the new Python 3 names to the old module names used in Python 2, so +that the pickle data stream is readable with Python 2.

    +
    +
    +dump(obj)
    +

    Write a pickled representation of obj to the open file object given in +the constructor.

    +
    + +
    +
    +persistent_id(obj)
    +

    Do nothing by default. This exists so a subclass can override it.

    +

    If persistent_id() returns None, obj is pickled as usual. Any +other value causes Pickler to emit the returned value as a +persistent ID for obj. The meaning of this persistent ID should be +defined by Unpickler.persistent_load(). Note that the value +returned by persistent_id() cannot itself have a persistent ID.

    +

    See Persistence of External Objects for details and examples of uses.

    +
    + +
    +
    +dispatch_table
    +

    A pickler object’s dispatch table is a registry of reduction +functions of the kind which can be declared using +copyreg.pickle(). It is a mapping whose keys are classes +and whose values are reduction functions. A reduction function +takes a single argument of the associated class and should +conform to the same interface as a __reduce__() +method.

    +

    By default, a pickler object will not have a +dispatch_table attribute, and it will instead use the +global dispatch table managed by the copyreg module. +However, to customize the pickling for a specific pickler object +one can set the dispatch_table attribute to a dict-like +object. Alternatively, if a subclass of Pickler has a +dispatch_table attribute then this will be used as the +default dispatch table for instances of that class.

    +

    See Dispatch Tables for usage examples.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +fast
    +

    Deprecated. Enable fast mode if set to a true value. The fast mode +disables the usage of memo, therefore speeding the pickling process by not +generating superfluous PUT opcodes. It should not be used with +self-referential objects, doing otherwise will cause Pickler to +recurse infinitely.

    +

    Use pickletools.optimize() if you need more compact pickles.

    +
    + +
    + +
    +
    +class pickle.Unpickler(file, *, fix_imports=True, encoding="ASCII", errors="strict")
    +

    This takes a binary file for reading a pickle data stream.

    +

    The protocol version of the pickle is detected automatically, so no +protocol argument is needed.

    +

    The argument file must have two methods, a read() method that takes an +integer argument, and a readline() method that requires no arguments. Both +methods should return bytes. Thus file can be an on-disk file object +opened for binary reading, an io.BytesIO object, or any other +custom object that meets this interface.

    +

    Optional keyword arguments are fix_imports, encoding and errors, +which are used to control compatibility support for pickle stream generated +by Python 2. If fix_imports is true, pickle will try to map the old +Python 2 names to the new names used in Python 3. The encoding and +errors tell pickle how to decode 8-bit string instances pickled by Python +2; these default to ‘ASCII’ and ‘strict’, respectively. The encoding can +be ‘bytes’ to read these 8-bit string instances as bytes objects.

    +
    +
    +load()
    +

    Read a pickled object representation from the open file object given in +the constructor, and return the reconstituted object hierarchy specified +therein. Bytes past the pickled object’s representation are ignored.

    +
    + +
    +
    +persistent_load(pid)
    +

    Raise an UnpicklingError by default.

    +

    If defined, persistent_load() should return the object specified by +the persistent ID pid. If an invalid persistent ID is encountered, an +UnpicklingError should be raised.

    +

    See Persistence of External Objects for details and examples of uses.

    +
    + +
    +
    +find_class(module, name)
    +

    Import module if necessary and return the object called name from it, +where the module and name arguments are str objects. Note, +unlike its name suggests, find_class() is also used for finding +functions.

    +

    Subclasses may override this to gain control over what type of objects and +how they can be loaded, potentially reducing security risks. Refer to +Restricting Globals for details.

    +
    + +
    + +
    +
    +

    What can be pickled and unpickled?

    +

    The following types can be pickled:

    +
      +
    • None, True, and False

    • +
    • integers, floating point numbers, complex numbers

    • +
    • strings, bytes, bytearrays

    • +
    • tuples, lists, sets, and dictionaries containing only picklable objects

    • +
    • functions defined at the top level of a module (using def, not +lambda)

    • +
    • built-in functions defined at the top level of a module

    • +
    • classes that are defined at the top level of a module

    • +
    • instances of such classes whose __dict__ or the result of +calling __getstate__() is picklable (see section Pickling Class Instances for +details).

    • +
    +

    Attempts to pickle unpicklable objects will raise the PicklingError +exception; when this happens, an unspecified number of bytes may have already +been written to the underlying file. Trying to pickle a highly recursive data +structure may exceed the maximum recursion depth, a RecursionError will be +raised in this case. You can carefully raise this limit with +sys.setrecursionlimit().

    +

    Note that functions (built-in and user-defined) are pickled by “fully qualified” +name reference, not by value. 2 This means that only the function name is +pickled, along with the name of the module the function is defined in. Neither +the function’s code, nor any of its function attributes are pickled. Thus the +defining module must be importable in the unpickling environment, and the module +must contain the named object, otherwise an exception will be raised. 3

    +

    Similarly, classes are pickled by named reference, so the same restrictions in +the unpickling environment apply. Note that none of the class’s code or data is +pickled, so in the following example the class attribute attr is not +restored in the unpickling environment:

    +
    class Foo:
    +    attr = 'A class attribute'
    +
    +picklestring = pickle.dumps(Foo)
    +
    +
    +

    These restrictions are why picklable functions and classes must be defined in +the top level of a module.

    +

    Similarly, when class instances are pickled, their class’s code and data are not +pickled along with them. Only the instance data are pickled. This is done on +purpose, so you can fix bugs in a class or add methods to the class and still +load objects that were created with an earlier version of the class. If you +plan to have long-lived objects that will see many versions of a class, it may +be worthwhile to put a version number in the objects so that suitable +conversions can be made by the class’s __setstate__() method.

    +
    +
    +

    Pickling Class Instances

    +

    In this section, we describe the general mechanisms available to you to define, +customize, and control how class instances are pickled and unpickled.

    +

    In most cases, no additional code is needed to make instances picklable. By +default, pickle will retrieve the class and the attributes of an instance via +introspection. When a class instance is unpickled, its __init__() method +is usually not invoked. The default behaviour first creates an uninitialized +instance and then restores the saved attributes. The following code shows an +implementation of this behaviour:

    +
    def save(obj):
    +    return (obj.__class__, obj.__dict__)
    +
    +def load(cls, attributes):
    +    obj = cls.__new__(cls)
    +    obj.__dict__.update(attributes)
    +    return obj
    +
    +
    +

    Classes can alter the default behaviour by providing one or several special +methods:

    +
    +
    +object.__getnewargs_ex__()
    +

    In protocols 2 and newer, classes that implements the +__getnewargs_ex__() method can dictate the values passed to the +__new__() method upon unpickling. The method must return a pair +(args, kwargs) where args is a tuple of positional arguments +and kwargs a dictionary of named arguments for constructing the +object. Those will be passed to the __new__() method upon +unpickling.

    +

    You should implement this method if the __new__() method of your +class requires keyword-only arguments. Otherwise, it is recommended for +compatibility to implement __getnewargs__().

    +
    +

    Changed in version 3.6: __getnewargs_ex__() is now used in protocols 2 and 3.

    +
    +
    + +
    +
    +object.__getnewargs__()
    +

    This method serves a similar purpose as __getnewargs_ex__(), but +supports only positional arguments. It must return a tuple of arguments +args which will be passed to the __new__() method upon unpickling.

    +

    __getnewargs__() will not be called if __getnewargs_ex__() is +defined.

    +
    +

    Changed in version 3.6: Before Python 3.6, __getnewargs__() was called instead of +__getnewargs_ex__() in protocols 2 and 3.

    +
    +
    + +
    +
    +object.__getstate__()
    +

    Classes can further influence how their instances are pickled; if the class +defines the method __getstate__(), it is called and the returned object +is pickled as the contents for the instance, instead of the contents of the +instance’s dictionary. If the __getstate__() method is absent, the +instance’s __dict__ is pickled as usual.

    +
    + +
    +
    +object.__setstate__(state)
    +

    Upon unpickling, if the class defines __setstate__(), it is called with +the unpickled state. In that case, there is no requirement for the state +object to be a dictionary. Otherwise, the pickled state must be a dictionary +and its items are assigned to the new instance’s dictionary.

    +
    +

    Note

    +

    If __getstate__() returns a false value, the __setstate__() +method will not be called upon unpickling.

    +
    +
    + +

    Refer to the section Handling Stateful Objects for more information about how to use +the methods __getstate__() and __setstate__().

    +
    +

    Note

    +

    At unpickling time, some methods like __getattr__(), +__getattribute__(), or __setattr__() may be called upon the +instance. In case those methods rely on some internal invariant being +true, the type should implement __getnewargs__() or +__getnewargs_ex__() to establish such an invariant; otherwise, +neither __new__() nor __init__() will be called.

    +
    +

    As we shall see, pickle does not use directly the methods described above. In +fact, these methods are part of the copy protocol which implements the +__reduce__() special method. The copy protocol provides a unified +interface for retrieving the data necessary for pickling and copying +objects. 4

    +

    Although powerful, implementing __reduce__() directly in your classes is +error prone. For this reason, class designers should use the high-level +interface (i.e., __getnewargs_ex__(), __getstate__() and +__setstate__()) whenever possible. We will show, however, cases where +using __reduce__() is the only option or leads to more efficient pickling +or both.

    +
    +
    +object.__reduce__()
    +

    The interface is currently defined as follows. The __reduce__() method +takes no argument and shall return either a string or preferably a tuple (the +returned object is often referred to as the “reduce value”).

    +

    If a string is returned, the string should be interpreted as the name of a +global variable. It should be the object’s local name relative to its +module; the pickle module searches the module namespace to determine the +object’s module. This behaviour is typically useful for singletons.

    +

    When a tuple is returned, it must be between two and five items long. +Optional items can either be omitted, or None can be provided as their +value. The semantics of each item are in order:

    +
      +
    • A callable object that will be called to create the initial version of the +object.

    • +
    • A tuple of arguments for the callable object. An empty tuple must be given +if the callable does not accept any argument.

    • +
    • Optionally, the object’s state, which will be passed to the object’s +__setstate__() method as previously described. If the object has no +such method then, the value must be a dictionary and it will be added to +the object’s __dict__ attribute.

    • +
    • Optionally, an iterator (and not a sequence) yielding successive items. +These items will be appended to the object either using +obj.append(item) or, in batch, using obj.extend(list_of_items). +This is primarily used for list subclasses, but may be used by other +classes as long as they have append() and extend() methods with +the appropriate signature. (Whether append() or extend() is +used depends on which pickle protocol version is used as well as the number +of items to append, so both must be supported.)

    • +
    • Optionally, an iterator (not a sequence) yielding successive key-value +pairs. These items will be stored to the object using obj[key] = +value. This is primarily used for dictionary subclasses, but may be used +by other classes as long as they implement __setitem__().

    • +
    +
    + +
    +
    +object.__reduce_ex__(protocol)
    +

    Alternatively, a __reduce_ex__() method may be defined. The only +difference is this method should take a single integer argument, the protocol +version. When defined, pickle will prefer it over the __reduce__() +method. In addition, __reduce__() automatically becomes a synonym for +the extended version. The main use for this method is to provide +backwards-compatible reduce values for older Python releases.

    +
    + +
    +

    Persistence of External Objects

    +

    For the benefit of object persistence, the pickle module supports the +notion of a reference to an object outside the pickled data stream. Such +objects are referenced by a persistent ID, which should be either a string of +alphanumeric characters (for protocol 0) 5 or just an arbitrary object (for +any newer protocol).

    +

    The resolution of such persistent IDs is not defined by the pickle +module; it will delegate this resolution to the user defined methods on the +pickler and unpickler, persistent_id() and +persistent_load() respectively.

    +

    To pickle objects that have an external persistent id, the pickler must have a +custom persistent_id() method that takes an object as an +argument and returns either None or the persistent id for that object. +When None is returned, the pickler simply pickles the object as normal. +When a persistent ID string is returned, the pickler will pickle that object, +along with a marker so that the unpickler will recognize it as a persistent ID.

    +

    To unpickle external objects, the unpickler must have a custom +persistent_load() method that takes a persistent ID object and +returns the referenced object.

    +

    Here is a comprehensive example presenting how persistent ID can be used to +pickle external objects by reference.

    +
    # Simple example presenting how persistent ID can be used to pickle
    +# external objects by reference.
    +
    +import pickle
    +import sqlite3
    +from collections import namedtuple
    +
    +# Simple class representing a record in our database.
    +MemoRecord = namedtuple("MemoRecord", "key, task")
    +
    +class DBPickler(pickle.Pickler):
    +
    +    def persistent_id(self, obj):
    +        # Instead of pickling MemoRecord as a regular class instance, we emit a
    +        # persistent ID.
    +        if isinstance(obj, MemoRecord):
    +            # Here, our persistent ID is simply a tuple, containing a tag and a
    +            # key, which refers to a specific record in the database.
    +            return ("MemoRecord", obj.key)
    +        else:
    +            # If obj does not have a persistent ID, return None. This means obj
    +            # needs to be pickled as usual.
    +            return None
    +
    +
    +class DBUnpickler(pickle.Unpickler):
    +
    +    def __init__(self, file, connection):
    +        super().__init__(file)
    +        self.connection = connection
    +
    +    def persistent_load(self, pid):
    +        # This method is invoked whenever a persistent ID is encountered.
    +        # Here, pid is the tuple returned by DBPickler.
    +        cursor = self.connection.cursor()
    +        type_tag, key_id = pid
    +        if type_tag == "MemoRecord":
    +            # Fetch the referenced record from the database and return it.
    +            cursor.execute("SELECT * FROM memos WHERE key=?", (str(key_id),))
    +            key, task = cursor.fetchone()
    +            return MemoRecord(key, task)
    +        else:
    +            # Always raises an error if you cannot return the correct object.
    +            # Otherwise, the unpickler will think None is the object referenced
    +            # by the persistent ID.
    +            raise pickle.UnpicklingError("unsupported persistent object")
    +
    +
    +def main():
    +    import io
    +    import pprint
    +
    +    # Initialize and populate our database.
    +    conn = sqlite3.connect(":memory:")
    +    cursor = conn.cursor()
    +    cursor.execute("CREATE TABLE memos(key INTEGER PRIMARY KEY, task TEXT)")
    +    tasks = (
    +        'give food to fish',
    +        'prepare group meeting',
    +        'fight with a zebra',
    +        )
    +    for task in tasks:
    +        cursor.execute("INSERT INTO memos VALUES(NULL, ?)", (task,))
    +
    +    # Fetch the records to be pickled.
    +    cursor.execute("SELECT * FROM memos")
    +    memos = [MemoRecord(key, task) for key, task in cursor]
    +    # Save the records using our custom DBPickler.
    +    file = io.BytesIO()
    +    DBPickler(file).dump(memos)
    +
    +    print("Pickled records:")
    +    pprint.pprint(memos)
    +
    +    # Update a record, just for good measure.
    +    cursor.execute("UPDATE memos SET task='learn italian' WHERE key=1")
    +
    +    # Load the records from the pickle data stream.
    +    file.seek(0)
    +    memos = DBUnpickler(file, conn).load()
    +
    +    print("Unpickled records:")
    +    pprint.pprint(memos)
    +
    +
    +if __name__ == '__main__':
    +    main()
    +
    +
    +
    +
    +

    Dispatch Tables

    +

    If one wants to customize pickling of some classes without disturbing +any other code which depends on pickling, then one can create a +pickler with a private dispatch table.

    +

    The global dispatch table managed by the copyreg module is +available as copyreg.dispatch_table. Therefore, one may +choose to use a modified copy of copyreg.dispatch_table as a +private dispatch table.

    +

    For example

    +
    f = io.BytesIO()
    +p = pickle.Pickler(f)
    +p.dispatch_table = copyreg.dispatch_table.copy()
    +p.dispatch_table[SomeClass] = reduce_SomeClass
    +
    +
    +

    creates an instance of pickle.Pickler with a private dispatch +table which handles the SomeClass class specially. Alternatively, +the code

    +
    class MyPickler(pickle.Pickler):
    +    dispatch_table = copyreg.dispatch_table.copy()
    +    dispatch_table[SomeClass] = reduce_SomeClass
    +f = io.BytesIO()
    +p = MyPickler(f)
    +
    +
    +

    does the same, but all instances of MyPickler will by default +share the same dispatch table. The equivalent code using the +copyreg module is

    +
    copyreg.pickle(SomeClass, reduce_SomeClass)
    +f = io.BytesIO()
    +p = pickle.Pickler(f)
    +
    +
    +
    +
    +

    Handling Stateful Objects

    +

    Here’s an example that shows how to modify pickling behavior for a class. +The TextReader class opens a text file, and returns the line number and +line contents each time its readline() method is called. If a +TextReader instance is pickled, all attributes except the file object +member are saved. When the instance is unpickled, the file is reopened, and +reading resumes from the last location. The __setstate__() and +__getstate__() methods are used to implement this behavior.

    +
    class TextReader:
    +    """Print and number lines in a text file."""
    +
    +    def __init__(self, filename):
    +        self.filename = filename
    +        self.file = open(filename)
    +        self.lineno = 0
    +
    +    def readline(self):
    +        self.lineno += 1
    +        line = self.file.readline()
    +        if not line:
    +            return None
    +        if line.endswith('\n'):
    +            line = line[:-1]
    +        return "%i: %s" % (self.lineno, line)
    +
    +    def __getstate__(self):
    +        # Copy the object's state from self.__dict__ which contains
    +        # all our instance attributes. Always use the dict.copy()
    +        # method to avoid modifying the original state.
    +        state = self.__dict__.copy()
    +        # Remove the unpicklable entries.
    +        del state['file']
    +        return state
    +
    +    def __setstate__(self, state):
    +        # Restore instance attributes (i.e., filename and lineno).
    +        self.__dict__.update(state)
    +        # Restore the previously opened file's state. To do so, we need to
    +        # reopen it and read from it until the line count is restored.
    +        file = open(self.filename)
    +        for _ in range(self.lineno):
    +            file.readline()
    +        # Finally, save the file.
    +        self.file = file
    +
    +
    +

    A sample usage might be something like this:

    +
    >>> reader = TextReader("hello.txt")
    +>>> reader.readline()
    +'1: Hello world!'
    +>>> reader.readline()
    +'2: I am line number two.'
    +>>> new_reader = pickle.loads(pickle.dumps(reader))
    +>>> new_reader.readline()
    +'3: Goodbye!'
    +
    +
    +
    +
    +
    +

    Restricting Globals

    +

    By default, unpickling will import any class or function that it finds in the +pickle data. For many applications, this behaviour is unacceptable as it +permits the unpickler to import and invoke arbitrary code. Just consider what +this hand-crafted pickle data stream does when loaded:

    +
    >>> import pickle
    +>>> pickle.loads(b"cos\nsystem\n(S'echo hello world'\ntR.")
    +hello world
    +0
    +
    +
    +

    In this example, the unpickler imports the os.system() function and then +apply the string argument “echo hello world”. Although this example is +inoffensive, it is not difficult to imagine one that could damage your system.

    +

    For this reason, you may want to control what gets unpickled by customizing +Unpickler.find_class(). Unlike its name suggests, +Unpickler.find_class() is called whenever a global (i.e., a class or +a function) is requested. Thus it is possible to either completely forbid +globals or restrict them to a safe subset.

    +

    Here is an example of an unpickler allowing only few safe classes from the +builtins module to be loaded:

    +
    import builtins
    +import io
    +import pickle
    +
    +safe_builtins = {
    +    'range',
    +    'complex',
    +    'set',
    +    'frozenset',
    +    'slice',
    +}
    +
    +class RestrictedUnpickler(pickle.Unpickler):
    +
    +    def find_class(self, module, name):
    +        # Only allow safe classes from builtins.
    +        if module == "builtins" and name in safe_builtins:
    +            return getattr(builtins, name)
    +        # Forbid everything else.
    +        raise pickle.UnpicklingError("global '%s.%s' is forbidden" %
    +                                     (module, name))
    +
    +def restricted_loads(s):
    +    """Helper function analogous to pickle.loads()."""
    +    return RestrictedUnpickler(io.BytesIO(s)).load()
    +
    +
    +

    A sample usage of our unpickler working has intended:

    +
    >>> restricted_loads(pickle.dumps([1, 2, range(15)]))
    +[1, 2, range(0, 15)]
    +>>> restricted_loads(b"cos\nsystem\n(S'echo hello world'\ntR.")
    +Traceback (most recent call last):
    +  ...
    +pickle.UnpicklingError: global 'os.system' is forbidden
    +>>> restricted_loads(b'cbuiltins\neval\n'
    +...                  b'(S\'getattr(__import__("os"), "system")'
    +...                  b'("echo hello world")\'\ntR.')
    +Traceback (most recent call last):
    +  ...
    +pickle.UnpicklingError: global 'builtins.eval' is forbidden
    +
    +
    +

    As our examples shows, you have to be careful with what you allow to be +unpickled. Therefore if security is a concern, you may want to consider +alternatives such as the marshalling API in xmlrpc.client or +third-party solutions.

    +
    +
    +

    Performance

    +

    Recent versions of the pickle protocol (from protocol 2 and upwards) feature +efficient binary encodings for several common features and built-in types. +Also, the pickle module has a transparent optimizer written in C.

    +
    +
    +

    Examples

    +

    For the simplest code, use the dump() and load() functions.

    +
    import pickle
    +
    +# An arbitrary collection of objects supported by pickle.
    +data = {
    +    'a': [1, 2.0, 3, 4+6j],
    +    'b': ("character string", b"byte string"),
    +    'c': {None, True, False}
    +}
    +
    +with open('data.pickle', 'wb') as f:
    +    # Pickle the 'data' dictionary using the highest protocol available.
    +    pickle.dump(data, f, pickle.HIGHEST_PROTOCOL)
    +
    +
    +

    The following example reads the resulting pickled data.

    +
    import pickle
    +
    +with open('data.pickle', 'rb') as f:
    +    # The protocol version used is detected automatically, so we do not
    +    # have to specify it.
    +    data = pickle.load(f)
    +
    +
    +
    +

    See also

    +
    +
    Module copyreg

    Pickle interface constructor registration for extension types.

    +
    +
    Module pickletools

    Tools for working with and analyzing pickled data.

    +
    +
    Module shelve

    Indexed databases of objects; uses pickle.

    +
    +
    Module copy

    Shallow and deep object copying.

    +
    +
    Module marshal

    High-performance serialization of built-in types.

    +
    +
    +
    +

    Footnotes

    +
    +
    1
    +

    Don’t confuse this with the marshal module

    +
    +
    2
    +

    This is why lambda functions cannot be pickled: all +lambda functions share the same name: <lambda>.

    +
    +
    3
    +

    The exception raised will likely be an ImportError or an +AttributeError but it could be something else.

    +
    +
    4
    +

    The copy module uses this protocol for shallow and deep copying +operations.

    +
    +
    5
    +

    The limitation on alphanumeric characters is due to the fact +the persistent IDs, in protocol 0, are delimited by the newline +character. Therefore if any kind of newline characters occurs in +persistent IDs, the resulting pickle will become unreadable.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/pickletools.html b/python-3.7.4-docs-html/library/pickletools.html new file mode 100644 index 0000000..77a8d56 --- /dev/null +++ b/python-3.7.4-docs-html/library/pickletools.html @@ -0,0 +1,304 @@ + + + + + + + pickletools — Tools for pickle developers — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    pickletools — Tools for pickle developers

    +

    Source code: Lib/pickletools.py

    +
    +

    This module contains various constants relating to the intimate details of the +pickle module, some lengthy comments about the implementation, and a +few useful functions for analyzing pickled data. The contents of this module +are useful for Python core developers who are working on the pickle; +ordinary users of the pickle module probably won’t find the +pickletools module relevant.

    +
    +

    Command line usage

    +
    +

    New in version 3.2.

    +
    +

    When invoked from the command line, python -m pickletools will +disassemble the contents of one or more pickle files. Note that if +you want to see the Python object stored in the pickle rather than the +details of pickle format, you may want to use -m pickle instead. +However, when the pickle file that you want to examine comes from an +untrusted source, -m pickletools is a safer option because it does +not execute pickle bytecode.

    +

    For example, with a tuple (1, 2) pickled in file x.pickle:

    +
    $ python -m pickle x.pickle
    +(1, 2)
    +
    +$ python -m pickletools x.pickle
    +    0: \x80 PROTO      3
    +    2: K    BININT1    1
    +    4: K    BININT1    2
    +    6: \x86 TUPLE2
    +    7: q    BINPUT     0
    +    9: .    STOP
    +highest protocol among opcodes = 2
    +
    +
    +
    +

    Command line options

    +
    +
    +-a, --annotate
    +

    Annotate each line with a short opcode description.

    +
    + +
    +
    +-o, --output=<file>
    +

    Name of a file where the output should be written.

    +
    + +
    +
    +-l, --indentlevel=<num>
    +

    The number of blanks by which to indent a new MARK level.

    +
    + +
    +
    +-m, --memo
    +

    When multiple objects are disassembled, preserve memo between +disassemblies.

    +
    + +
    +
    +-p, --preamble=<preamble>
    +

    When more than one pickle file are specified, print given preamble +before each disassembly.

    +
    + +
    +
    +
    +

    Programmatic Interface

    +
    +
    +pickletools.dis(pickle, out=None, memo=None, indentlevel=4, annotate=0)
    +

    Outputs a symbolic disassembly of the pickle to the file-like +object out, defaulting to sys.stdout. pickle can be a +string or a file-like object. memo can be a Python dictionary +that will be used as the pickle’s memo; it can be used to perform +disassemblies across multiple pickles created by the same +pickler. Successive levels, indicated by MARK opcodes in the +stream, are indented by indentlevel spaces. If a nonzero value +is given to annotate, each opcode in the output is annotated with +a short description. The value of annotate is used as a hint for +the column where annotation should start.

    +
    +

    New in version 3.2: The annotate argument.

    +
    +
    + +
    +
    +pickletools.genops(pickle)
    +

    Provides an iterator over all of the opcodes in a pickle, returning a +sequence of (opcode, arg, pos) triples. opcode is an instance of an +OpcodeInfo class; arg is the decoded value, as a Python object, of +the opcode’s argument; pos is the position at which this opcode is located. +pickle can be a string or a file-like object.

    +
    + +
    +
    +pickletools.optimize(picklestring)
    +

    Returns a new equivalent pickle string after eliminating unused PUT +opcodes. The optimized pickle is shorter, takes less transmission time, +requires less storage space, and unpickles more efficiently.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/pipes.html b/python-3.7.4-docs-html/library/pipes.html new file mode 100644 index 0000000..014f681 --- /dev/null +++ b/python-3.7.4-docs-html/library/pipes.html @@ -0,0 +1,274 @@ + + + + + + + pipes — Interface to shell pipelines — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    pipes — Interface to shell pipelines

    +

    Source code: Lib/pipes.py

    +
    +

    The pipes module defines a class to abstract the concept of a pipeline +— a sequence of converters from one file to another.

    +

    Because the module uses /bin/sh command lines, a POSIX or compatible +shell for os.system() and os.popen() is required.

    +

    The pipes module defines the following class:

    +
    +
    +class pipes.Template
    +

    An abstraction of a pipeline.

    +
    + +

    Example:

    +
    >>> import pipes
    +>>> t = pipes.Template()
    +>>> t.append('tr a-z A-Z', '--')
    +>>> f = t.open('pipefile', 'w')
    +>>> f.write('hello world')
    +>>> f.close()
    +>>> open('pipefile').read()
    +'HELLO WORLD'
    +
    +
    +
    +

    Template Objects

    +

    Template objects following methods:

    +
    +
    +Template.reset()
    +

    Restore a pipeline template to its initial state.

    +
    + +
    +
    +Template.clone()
    +

    Return a new, equivalent, pipeline template.

    +
    + +
    +
    +Template.debug(flag)
    +

    If flag is true, turn debugging on. Otherwise, turn debugging off. When +debugging is on, commands to be executed are printed, and the shell is given +set -x command to be more verbose.

    +
    + +
    +
    +Template.append(cmd, kind)
    +

    Append a new action at the end. The cmd variable must be a valid bourne shell +command. The kind variable consists of two letters.

    +

    The first letter can be either of '-' (which means the command reads its +standard input), 'f' (which means the commands reads a given file on the +command line) or '.' (which means the commands reads no input, and hence +must be first.)

    +

    Similarly, the second letter can be either of '-' (which means the command +writes to standard output), 'f' (which means the command writes a file on +the command line) or '.' (which means the command does not write anything, +and hence must be last.)

    +
    + +
    +
    +Template.prepend(cmd, kind)
    +

    Add a new action at the beginning. See append() for explanations of the +arguments.

    +
    + +
    +
    +Template.open(file, mode)
    +

    Return a file-like object, open to file, but read from or written to by the +pipeline. Note that only one of 'r', 'w' may be given.

    +
    + +
    +
    +Template.copy(infile, outfile)
    +

    Copy infile to outfile through the pipe.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/pkgutil.html b/python-3.7.4-docs-html/library/pkgutil.html new file mode 100644 index 0000000..6e9604f --- /dev/null +++ b/python-3.7.4-docs-html/library/pkgutil.html @@ -0,0 +1,398 @@ + + + + + + + pkgutil — Package extension utility — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    pkgutil — Package extension utility

    +

    Source code: Lib/pkgutil.py

    +
    +

    This module provides utilities for the import system, in particular package +support.

    +
    +
    +class pkgutil.ModuleInfo(module_finder, name, ispkg)
    +

    A namedtuple that holds a brief summary of a module’s info.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +pkgutil.extend_path(path, name)
    +

    Extend the search path for the modules which comprise a package. Intended +use is to place the following code in a package’s __init__.py:

    +
    from pkgutil import extend_path
    +__path__ = extend_path(__path__, __name__)
    +
    +
    +

    This will add to the package’s __path__ all subdirectories of directories +on sys.path named after the package. This is useful if one wants to +distribute different parts of a single logical package as multiple +directories.

    +

    It also looks for *.pkg files beginning where * matches the +name argument. This feature is similar to *.pth files (see the +site module for more information), except that it doesn’t special-case +lines starting with import. A *.pkg file is trusted at face +value: apart from checking for duplicates, all entries found in a +*.pkg file are added to the path, regardless of whether they exist +on the filesystem. (This is a feature.)

    +

    If the input path is not a list (as is the case for frozen packages) it is +returned unchanged. The input path is not modified; an extended copy is +returned. Items are only appended to the copy at the end.

    +

    It is assumed that sys.path is a sequence. Items of sys.path +that are not strings referring to existing directories are ignored. Unicode +items on sys.path that cause errors when used as filenames may cause +this function to raise an exception (in line with os.path.isdir() +behavior).

    +
    + +
    +
    +class pkgutil.ImpImporter(dirname=None)
    +

    PEP 302 Finder that wraps Python’s “classic” import algorithm.

    +

    If dirname is a string, a PEP 302 finder is created that searches that +directory. If dirname is None, a PEP 302 finder is created that +searches the current sys.path, plus any modules that are frozen or +built-in.

    +

    Note that ImpImporter does not currently support being used by +placement on sys.meta_path.

    +
    +

    Deprecated since version 3.3: This emulation is no longer needed, as the standard import mechanism +is now fully PEP 302 compliant and available in importlib.

    +
    +
    + +
    +
    +class pkgutil.ImpLoader(fullname, file, filename, etc)
    +

    Loader that wraps Python’s “classic” import algorithm.

    +
    +

    Deprecated since version 3.3: This emulation is no longer needed, as the standard import mechanism +is now fully PEP 302 compliant and available in importlib.

    +
    +
    + +
    +
    +pkgutil.find_loader(fullname)
    +

    Retrieve a module loader for the given fullname.

    +

    This is a backwards compatibility wrapper around +importlib.util.find_spec() that converts most failures to +ImportError and only returns the loader rather than the full +ModuleSpec.

    +
    +

    Changed in version 3.3: Updated to be based directly on importlib rather than relying +on the package internal PEP 302 import emulation.

    +
    +
    +

    Changed in version 3.4: Updated to be based on PEP 451

    +
    +
    + +
    +
    +pkgutil.get_importer(path_item)
    +

    Retrieve a finder for the given path_item.

    +

    The returned finder is cached in sys.path_importer_cache if it was +newly created by a path hook.

    +

    The cache (or part of it) can be cleared manually if a rescan of +sys.path_hooks is necessary.

    +
    +

    Changed in version 3.3: Updated to be based directly on importlib rather than relying +on the package internal PEP 302 import emulation.

    +
    +
    + +
    +
    +pkgutil.get_loader(module_or_name)
    +

    Get a loader object for module_or_name.

    +

    If the module or package is accessible via the normal import mechanism, a +wrapper around the relevant part of that machinery is returned. Returns +None if the module cannot be found or imported. If the named module is +not already imported, its containing package (if any) is imported, in order +to establish the package __path__.

    +
    +

    Changed in version 3.3: Updated to be based directly on importlib rather than relying +on the package internal PEP 302 import emulation.

    +
    +
    +

    Changed in version 3.4: Updated to be based on PEP 451

    +
    +
    + +
    +
    +pkgutil.iter_importers(fullname='')
    +

    Yield finder objects for the given module name.

    +

    If fullname contains a ‘.’, the finders will be for the package +containing fullname, otherwise they will be all registered top level +finders (i.e. those on both sys.meta_path and sys.path_hooks).

    +

    If the named module is in a package, that package is imported as a side +effect of invoking this function.

    +

    If no module name is specified, all top level finders are produced.

    +
    +

    Changed in version 3.3: Updated to be based directly on importlib rather than relying +on the package internal PEP 302 import emulation.

    +
    +
    + +
    +
    +pkgutil.iter_modules(path=None, prefix='')
    +

    Yields ModuleInfo for all submodules on path, or, if +path is None, all top-level modules on sys.path.

    +

    path should be either None or a list of paths to look for modules in.

    +

    prefix is a string to output on the front of every module name on output.

    +
    +

    Note

    +

    Only works for a finder which defines an iter_modules() +method. This interface is non-standard, so the module also provides +implementations for importlib.machinery.FileFinder and +zipimport.zipimporter.

    +
    +
    +

    Changed in version 3.3: Updated to be based directly on importlib rather than relying +on the package internal PEP 302 import emulation.

    +
    +
    + +
    +
    +pkgutil.walk_packages(path=None, prefix='', onerror=None)
    +

    Yields ModuleInfo for all modules recursively on +path, or, if path is None, all accessible modules.

    +

    path should be either None or a list of paths to look for modules in.

    +

    prefix is a string to output on the front of every module name on output.

    +

    Note that this function must import all packages (not all modules!) on +the given path, in order to access the __path__ attribute to find +submodules.

    +

    onerror is a function which gets called with one argument (the name of the +package which was being imported) if any exception occurs while trying to +import a package. If no onerror function is supplied, ImportErrors +are caught and ignored, while all other exceptions are propagated, +terminating the search.

    +

    Examples:

    +
    # list all modules python can access
    +walk_packages()
    +
    +# list all submodules of ctypes
    +walk_packages(ctypes.__path__, ctypes.__name__ + '.')
    +
    +
    +
    +

    Note

    +

    Only works for a finder which defines an iter_modules() +method. This interface is non-standard, so the module also provides +implementations for importlib.machinery.FileFinder and +zipimport.zipimporter.

    +
    +
    +

    Changed in version 3.3: Updated to be based directly on importlib rather than relying +on the package internal PEP 302 import emulation.

    +
    +
    + +
    +
    +pkgutil.get_data(package, resource)
    +

    Get a resource from a package.

    +

    This is a wrapper for the loader +get_data API. The +package argument should be the name of a package, in standard module format +(foo.bar). The resource argument should be in the form of a relative +filename, using / as the path separator. The parent directory name +.. is not allowed, and nor is a rooted name (starting with a /).

    +

    The function returns a binary string that is the contents of the specified +resource.

    +

    For packages located in the filesystem, which have already been imported, +this is the rough equivalent of:

    +
    d = os.path.dirname(sys.modules[package].__file__)
    +data = open(os.path.join(d, resource), 'rb').read()
    +
    +
    +

    If the package cannot be located or loaded, or it uses a loader +which does not support get_data, +then None is returned. In particular, the loader for +namespace packages does not support +get_data.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/platform.html b/python-3.7.4-docs-html/library/platform.html new file mode 100644 index 0000000..031a60e --- /dev/null +++ b/python-3.7.4-docs-html/library/platform.html @@ -0,0 +1,473 @@ + + + + + + + platform — Access to underlying platform’s identifying data — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    platform — Access to underlying platform’s identifying data

    +

    Source code: Lib/platform.py

    +
    +
    +

    Note

    +

    Specific platforms listed alphabetically, with Linux included in the Unix +section.

    +
    +
    +

    Cross Platform

    +
    +
    +platform.architecture(executable=sys.executable, bits='', linkage='')
    +

    Queries the given executable (defaults to the Python interpreter binary) for +various architecture information.

    +

    Returns a tuple (bits, linkage) which contain information about the bit +architecture and the linkage format used for the executable. Both values are +returned as strings.

    +

    Values that cannot be determined are returned as given by the parameter presets. +If bits is given as '', the sizeof(pointer) (or +sizeof(long) on Python version < 1.5.2) is used as indicator for the +supported pointer size.

    +

    The function relies on the system’s file command to do the actual work. +This is available on most if not all Unix platforms and some non-Unix platforms +and then only if the executable points to the Python interpreter. Reasonable +defaults are used when the above needs are not met.

    +
    +

    Note

    +

    On Mac OS X (and perhaps other platforms), executable files may be +universal files containing multiple architectures.

    +

    To get at the “64-bitness” of the current interpreter, it is more +reliable to query the sys.maxsize attribute:

    +
    is_64bits = sys.maxsize > 2**32
    +
    +
    +
    +
    + +
    +
    +platform.machine()
    +

    Returns the machine type, e.g. 'i386'. An empty string is returned if the +value cannot be determined.

    +
    + +
    +
    +platform.node()
    +

    Returns the computer’s network name (may not be fully qualified!). An empty +string is returned if the value cannot be determined.

    +
    + +
    +
    +platform.platform(aliased=0, terse=0)
    +

    Returns a single string identifying the underlying platform with as much useful +information as possible.

    +

    The output is intended to be human readable rather than machine parseable. It +may look different on different platforms and this is intended.

    +

    If aliased is true, the function will use aliases for various platforms that +report system names which differ from their common names, for example SunOS will +be reported as Solaris. The system_alias() function is used to implement +this.

    +

    Setting terse to true causes the function to return only the absolute minimum +information needed to identify the platform.

    +
    + +
    +
    +platform.processor()
    +

    Returns the (real) processor name, e.g. 'amdk6'.

    +

    An empty string is returned if the value cannot be determined. Note that many +platforms do not provide this information or simply return the same value as for +machine(). NetBSD does this.

    +
    + +
    +
    +platform.python_build()
    +

    Returns a tuple (buildno, builddate) stating the Python build number and +date as strings.

    +
    + +
    +
    +platform.python_compiler()
    +

    Returns a string identifying the compiler used for compiling Python.

    +
    + +
    +
    +platform.python_branch()
    +

    Returns a string identifying the Python implementation SCM branch.

    +
    + +
    +
    +platform.python_implementation()
    +

    Returns a string identifying the Python implementation. Possible return values +are: ‘CPython’, ‘IronPython’, ‘Jython’, ‘PyPy’.

    +
    + +
    +
    +platform.python_revision()
    +

    Returns a string identifying the Python implementation SCM revision.

    +
    + +
    +
    +platform.python_version()
    +

    Returns the Python version as string 'major.minor.patchlevel'.

    +

    Note that unlike the Python sys.version, the returned value will always +include the patchlevel (it defaults to 0).

    +
    + +
    +
    +platform.python_version_tuple()
    +

    Returns the Python version as tuple (major, minor, patchlevel) of strings.

    +

    Note that unlike the Python sys.version, the returned value will always +include the patchlevel (it defaults to '0').

    +
    + +
    +
    +platform.release()
    +

    Returns the system’s release, e.g. '2.2.0' or 'NT' An empty string is +returned if the value cannot be determined.

    +
    + +
    +
    +platform.system()
    +

    Returns the system/OS name, e.g. 'Linux', 'Windows', or 'Java'. An +empty string is returned if the value cannot be determined.

    +
    + +
    +
    +platform.system_alias(system, release, version)
    +

    Returns (system, release, version) aliased to common marketing names used +for some systems. It also does some reordering of the information in some cases +where it would otherwise cause confusion.

    +
    + +
    +
    +platform.version()
    +

    Returns the system’s release version, e.g. '#3 on degas'. An empty string is +returned if the value cannot be determined.

    +
    + +
    +
    +platform.uname()
    +

    Fairly portable uname interface. Returns a namedtuple() +containing six attributes: system, node, release, +version, machine, and processor.

    +

    Note that this adds a sixth attribute (processor) not present +in the os.uname() result. Also, the attribute names are different +for the first two attributes; os.uname() names them +sysname and nodename.

    +

    Entries which cannot be determined are set to ''.

    +
    +

    Changed in version 3.3: Result changed from a tuple to a namedtuple.

    +
    +
    + +
    +
    +

    Java Platform

    +
    +
    +platform.java_ver(release='', vendor='', vminfo=('', '', ''), osinfo=('', '', ''))
    +

    Version interface for Jython.

    +

    Returns a tuple (release, vendor, vminfo, osinfo) with vminfo being a +tuple (vm_name, vm_release, vm_vendor) and osinfo being a tuple +(os_name, os_version, os_arch). Values which cannot be determined are set to +the defaults given as parameters (which all default to '').

    +
    + +
    +
    +

    Windows Platform

    +
    +
    +platform.win32_ver(release='', version='', csd='', ptype='')
    +

    Get additional version information from the Windows Registry and return a tuple +(release, version, csd, ptype) referring to OS release, version number, +CSD level (service pack) and OS type (multi/single processor).

    +

    As a hint: ptype is 'Uniprocessor Free' on single processor NT machines +and 'Multiprocessor Free' on multi processor machines. The ‘Free’ refers +to the OS version being free of debugging code. It could also state ‘Checked’ +which means the OS version uses debugging code, i.e. code that checks arguments, +ranges, etc.

    +
    +

    Note

    +

    This function works best with Mark Hammond’s +win32all package installed, but also on Python 2.3 and +later (support for this was added in Python 2.6). It obviously +only runs on Win32 compatible platforms.

    +
    +
    + +
    +

    Win95/98 specific

    +
    +
    +platform.popen(cmd, mode='r', bufsize=-1)
    +

    Portable popen() interface. Find a working popen implementation +preferring win32pipe.popen(). On Windows NT, win32pipe.popen() +should work; on Windows 9x it hangs due to bugs in the MS C library.

    +
    +

    Deprecated since version 3.3: This function is obsolete. Use the subprocess module. Check +especially the Replacing Older Functions with the subprocess Module section.

    +
    +
    + +
    +
    +
    +

    Mac OS Platform

    +
    +
    +platform.mac_ver(release='', versioninfo=('', '', ''), machine='')
    +

    Get Mac OS version information and return it as tuple (release, versioninfo, +machine) with versioninfo being a tuple (version, dev_stage, +non_release_version).

    +

    Entries which cannot be determined are set to ''. All tuple entries are +strings.

    +
    + +
    +
    +

    Unix Platforms

    +
    +
    +platform.dist(distname='', version='', id='', supported_dists=('SuSE', 'debian', 'redhat', 'mandrake', ...))
    +

    This is another name for linux_distribution().

    +
    +

    Deprecated since version 3.5, will be removed in version 3.8: See alternative like the distro package.

    +
    +
    + +
    +
    +platform.linux_distribution(distname='', version='', id='', supported_dists=('SuSE', 'debian', 'redhat', 'mandrake', ...), full_distribution_name=1)
    +

    Tries to determine the name of the Linux OS distribution name.

    +

    supported_dists may be given to define the set of Linux distributions to +look for. It defaults to a list of currently supported Linux distributions +identified by their release file name.

    +

    If full_distribution_name is true (default), the full distribution read +from the OS is returned. Otherwise the short name taken from +supported_dists is used.

    +

    Returns a tuple (distname,version,id) which defaults to the args given as +parameters. id is the item in parentheses after the version number. It +is usually the version codename.

    +
    +

    Deprecated since version 3.5, will be removed in version 3.8: See alternative like the distro package.

    +
    +
    + +
    +
    +platform.libc_ver(executable=sys.executable, lib='', version='', chunksize=16384)
    +

    Tries to determine the libc version against which the file executable (defaults +to the Python interpreter) is linked. Returns a tuple of strings (lib, +version) which default to the given parameters in case the lookup fails.

    +

    Note that this function has intimate knowledge of how different libc versions +add symbols to the executable is probably only usable for executables compiled +using gcc.

    +

    The file is read and scanned in chunks of chunksize bytes.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/plistlib.html b/python-3.7.4-docs-html/library/plistlib.html new file mode 100644 index 0000000..0667c31 --- /dev/null +++ b/python-3.7.4-docs-html/library/plistlib.html @@ -0,0 +1,403 @@ + + + + + + + plistlib — Generate and parse Mac OS X .plist files — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    plistlib — Generate and parse Mac OS X .plist files

    +

    Source code: Lib/plistlib.py

    +
    +

    This module provides an interface for reading and writing the “property list” +files used mainly by Mac OS X and supports both binary and XML plist files.

    +

    The property list (.plist) file format is a simple serialization supporting +basic object types, like dictionaries, lists, numbers and strings. Usually the +top level object is a dictionary.

    +

    To write out and to parse a plist file, use the dump() and +load() functions.

    +

    To work with plist data in bytes objects, use dumps() +and loads().

    +

    Values can be strings, integers, floats, booleans, tuples, lists, dictionaries +(but only with string keys), Data, bytes, bytesarray +or datetime.datetime objects.

    +
    +

    Changed in version 3.4: New API, old API deprecated. Support for binary format plists added.

    +
    +
    +

    See also

    +
    +
    PList manual page

    Apple’s documentation of the file format.

    +
    +
    +
    +

    This module defines the following functions:

    +
    +
    +plistlib.load(fp, *, fmt=None, use_builtin_types=True, dict_type=dict)
    +

    Read a plist file. fp should be a readable and binary file object. +Return the unpacked root object (which usually is a +dictionary).

    +

    The fmt is the format of the file and the following values are valid:

    + +

    If use_builtin_types is true (the default) binary data will be returned +as instances of bytes, otherwise it is returned as instances of +Data.

    +

    The dict_type is the type used for dictionaries that are read from the +plist file.

    +

    XML data for the FMT_XML format is parsed using the Expat parser +from xml.parsers.expat – see its documentation for possible +exceptions on ill-formed XML. Unknown elements will simply be ignored +by the plist parser.

    +

    The parser for the binary format raises InvalidFileException +when the file cannot be parsed.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +plistlib.loads(data, *, fmt=None, use_builtin_types=True, dict_type=dict)
    +

    Load a plist from a bytes object. See load() for an explanation of +the keyword arguments.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +plistlib.dump(value, fp, *, fmt=FMT_XML, sort_keys=True, skipkeys=False)
    +

    Write value to a plist file. Fp should be a writable, binary +file object.

    +

    The fmt argument specifies the format of the plist file and can be +one of the following values:

    + +

    When sort_keys is true (the default) the keys for dictionaries will be +written to the plist in sorted order, otherwise they will be written in +the iteration order of the dictionary.

    +

    When skipkeys is false (the default) the function raises TypeError +when a key of a dictionary is not a string, otherwise such keys are skipped.

    +

    A TypeError will be raised if the object is of an unsupported type or +a container that contains objects of unsupported types.

    +

    An OverflowError will be raised for integer values that cannot +be represented in (binary) plist files.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +plistlib.dumps(value, *, fmt=FMT_XML, sort_keys=True, skipkeys=False)
    +

    Return value as a plist-formatted bytes object. See +the documentation for dump() for an explanation of the keyword +arguments of this function.

    +
    +

    New in version 3.4.

    +
    +
    + +

    The following functions are deprecated:

    +
    +
    +plistlib.readPlist(pathOrFile)
    +

    Read a plist file. pathOrFile may be either a file name or a (readable +and binary) file object. Returns the unpacked root object (which usually +is a dictionary).

    +

    This function calls load() to do the actual work, see the documentation +of that function for an explanation of the keyword arguments.

    +
    +

    Deprecated since version 3.4: Use load() instead.

    +
    +
    +

    Changed in version 3.7: Dict values in the result are now normal dicts. You no longer can use +attribute access to access items of these dictionaries.

    +
    +
    + +
    +
    +plistlib.writePlist(rootObject, pathOrFile)
    +

    Write rootObject to an XML plist file. pathOrFile may be either a file name +or a (writable and binary) file object

    +
    +

    Deprecated since version 3.4: Use dump() instead.

    +
    +
    + +
    +
    +plistlib.readPlistFromBytes(data)
    +

    Read a plist data from a bytes object. Return the root object.

    +

    See load() for a description of the keyword arguments.

    +
    +

    Deprecated since version 3.4: Use loads() instead.

    +
    +
    +

    Changed in version 3.7: Dict values in the result are now normal dicts. You no longer can use +attribute access to access items of these dictionaries.

    +
    +
    + +
    +
    +plistlib.writePlistToBytes(rootObject)
    +

    Return rootObject as an XML plist-formatted bytes object.

    +
    +

    Deprecated since version 3.4: Use dumps() instead.

    +
    +
    + +

    The following classes are available:

    +
    +
    +class plistlib.Data(data)
    +

    Return a “data” wrapper object around the bytes object data. This is used +in functions converting from/to plists to represent the <data> type +available in plists.

    +

    It has one attribute, data, that can be used to retrieve the Python +bytes object stored in it.

    +
    +

    Deprecated since version 3.4: Use a bytes object instead.

    +
    +
    + +

    The following constants are available:

    +
    +
    +plistlib.FMT_XML
    +

    The XML format for plist files.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +plistlib.FMT_BINARY
    +

    The binary format for plist files

    +
    +

    New in version 3.4.

    +
    +
    + +
    +

    Examples

    +

    Generating a plist:

    +
    pl = dict(
    +    aString = "Doodah",
    +    aList = ["A", "B", 12, 32.1, [1, 2, 3]],
    +    aFloat = 0.1,
    +    anInt = 728,
    +    aDict = dict(
    +        anotherString = "<hello & hi there!>",
    +        aThirdString = "M\xe4ssig, Ma\xdf",
    +        aTrueValue = True,
    +        aFalseValue = False,
    +    ),
    +    someData = b"<binary gunk>",
    +    someMoreData = b"<lots of binary gunk>" * 10,
    +    aDate = datetime.datetime.fromtimestamp(time.mktime(time.gmtime())),
    +)
    +with open(fileName, 'wb') as fp:
    +    dump(pl, fp)
    +
    +
    +

    Parsing a plist:

    +
    with open(fileName, 'rb') as fp:
    +    pl = load(fp)
    +print(pl["aKey"])
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/poplib.html b/python-3.7.4-docs-html/library/poplib.html new file mode 100644 index 0000000..2f0509f --- /dev/null +++ b/python-3.7.4-docs-html/library/poplib.html @@ -0,0 +1,437 @@ + + + + + + + poplib — POP3 protocol client — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    poplib — POP3 protocol client

    +

    Source code: Lib/poplib.py

    +
    +

    This module defines a class, POP3, which encapsulates a connection to a +POP3 server and implements the protocol as defined in RFC 1939. The +POP3 class supports both the minimal and optional command sets from +RFC 1939. The POP3 class also supports the STLS command introduced +in RFC 2595 to enable encrypted communication on an already established connection.

    +

    Additionally, this module provides a class POP3_SSL, which provides +support for connecting to POP3 servers that use SSL as an underlying protocol +layer.

    +

    Note that POP3, though widely supported, is obsolescent. The implementation +quality of POP3 servers varies widely, and too many are quite poor. If your +mailserver supports IMAP, you would be better off using the +imaplib.IMAP4 class, as IMAP servers tend to be better implemented.

    +

    The poplib module provides two classes:

    +
    +
    +class poplib.POP3(host, port=POP3_PORT[, timeout])
    +

    This class implements the actual POP3 protocol. The connection is created when +the instance is initialized. If port is omitted, the standard POP3 port (110) +is used. The optional timeout parameter specifies a timeout in seconds for the +connection attempt (if not specified, the global default timeout setting will +be used).

    +
    + +
    +
    +class poplib.POP3_SSL(host, port=POP3_SSL_PORT, keyfile=None, certfile=None, timeout=None, context=None)
    +

    This is a subclass of POP3 that connects to the server over an SSL +encrypted socket. If port is not specified, 995, the standard POP3-over-SSL +port is used. timeout works as in the POP3 constructor. +context is an optional ssl.SSLContext object which allows +bundling SSL configuration options, certificates and private keys into a +single (potentially long-lived) structure. Please read Security considerations +for best practices.

    +

    keyfile and certfile are a legacy alternative to context - they can +point to PEM-formatted private key and certificate chain files, +respectively, for the SSL connection.

    +
    +

    Changed in version 3.2: context parameter added.

    +
    +
    +

    Changed in version 3.4: The class now supports hostname check with +ssl.SSLContext.check_hostname and Server Name Indication (see +ssl.HAS_SNI).

    +
    +
    +

    Deprecated since version 3.6: keyfile and certfile are deprecated in favor of context. +Please use ssl.SSLContext.load_cert_chain() instead, or let +ssl.create_default_context() select the system’s trusted CA +certificates for you.

    +
    +
    + +

    One exception is defined as an attribute of the poplib module:

    +
    +
    +exception poplib.error_proto
    +

    Exception raised on any errors from this module (errors from socket +module are not caught). The reason for the exception is passed to the +constructor as a string.

    +
    + +
    +

    See also

    +
    +
    Module imaplib

    The standard Python IMAP module.

    +
    +
    Frequently Asked Questions About Fetchmail

    The FAQ for the fetchmail POP/IMAP client collects information on +POP3 server variations and RFC noncompliance that may be useful if you need to +write an application based on the POP protocol.

    +
    +
    +
    +
    +

    POP3 Objects

    +

    All POP3 commands are represented by methods of the same name, in lower-case; +most return the response text sent by the server.

    +

    An POP3 instance has the following methods:

    +
    +
    +POP3.set_debuglevel(level)
    +

    Set the instance’s debugging level. This controls the amount of debugging +output printed. The default, 0, produces no debugging output. A value of +1 produces a moderate amount of debugging output, generally a single line +per request. A value of 2 or higher produces the maximum amount of +debugging output, logging each line sent and received on the control connection.

    +
    + +
    +
    +POP3.getwelcome()
    +

    Returns the greeting string sent by the POP3 server.

    +
    + +
    +
    +POP3.capa()
    +

    Query the server’s capabilities as specified in RFC 2449. +Returns a dictionary in the form {'name': ['param'...]}.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +POP3.user(username)
    +

    Send user command, response should indicate that a password is required.

    +
    + +
    +
    +POP3.pass_(password)
    +

    Send password, response includes message count and mailbox size. Note: the +mailbox on the server is locked until quit() is called.

    +
    + +
    +
    +POP3.apop(user, secret)
    +

    Use the more secure APOP authentication to log into the POP3 server.

    +
    + +
    +
    +POP3.rpop(user)
    +

    Use RPOP authentication (similar to UNIX r-commands) to log into POP3 server.

    +
    + +
    +
    +POP3.stat()
    +

    Get mailbox status. The result is a tuple of 2 integers: (message count, +mailbox size).

    +
    + +
    +
    +POP3.list([which])
    +

    Request message list, result is in the form (response, ['mesg_num octets', +...], octets). If which is set, it is the message to list.

    +
    + +
    +
    +POP3.retr(which)
    +

    Retrieve whole message number which, and set its seen flag. Result is in form +(response, ['line', ...], octets).

    +
    + +
    +
    +POP3.dele(which)
    +

    Flag message number which for deletion. On most servers deletions are not +actually performed until QUIT (the major exception is Eudora QPOP, which +deliberately violates the RFCs by doing pending deletes on any disconnect).

    +
    + +
    +
    +POP3.rset()
    +

    Remove any deletion marks for the mailbox.

    +
    + +
    +
    +POP3.noop()
    +

    Do nothing. Might be used as a keep-alive.

    +
    + +
    +
    +POP3.quit()
    +

    Signoff: commit changes, unlock mailbox, drop connection.

    +
    + +
    +
    +POP3.top(which, howmuch)
    +

    Retrieves the message header plus howmuch lines of the message after the +header of message number which. Result is in form (response, ['line', ...], +octets).

    +

    The POP3 TOP command this method uses, unlike the RETR command, doesn’t set the +message’s seen flag; unfortunately, TOP is poorly specified in the RFCs and is +frequently broken in off-brand servers. Test this method by hand against the +POP3 servers you will use before trusting it.

    +
    + +
    +
    +POP3.uidl(which=None)
    +

    Return message digest (unique id) list. If which is specified, result contains +the unique id for that message in the form 'response mesgnum uid, otherwise +result is list (response, ['mesgnum uid', ...], octets).

    +
    + +
    +
    +POP3.utf8()
    +

    Try to switch to UTF-8 mode. Returns the server response if successful, +raises error_proto if not. Specified in RFC 6856.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +POP3.stls(context=None)
    +

    Start a TLS session on the active connection as specified in RFC 2595. +This is only allowed before user authentication

    +

    context parameter is a ssl.SSLContext object which allows +bundling SSL configuration options, certificates and private keys into +a single (potentially long-lived) structure. Please read Security considerations +for best practices.

    +

    This method supports hostname checking via +ssl.SSLContext.check_hostname and Server Name Indication (see +ssl.HAS_SNI).

    +
    +

    New in version 3.4.

    +
    +
    + +

    Instances of POP3_SSL have no additional methods. The interface of this +subclass is identical to its parent.

    +
    +
    +

    POP3 Example

    +

    Here is a minimal example (without error checking) that opens a mailbox and +retrieves and prints all messages:

    +
    import getpass, poplib
    +
    +M = poplib.POP3('localhost')
    +M.user(getpass.getuser())
    +M.pass_(getpass.getpass())
    +numMessages = len(M.list()[1])
    +for i in range(numMessages):
    +    for j in M.retr(i+1)[1]:
    +        print(j)
    +
    +
    +

    At the end of the module, there is a test section that contains a more extensive +example of usage.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/posix.html b/python-3.7.4-docs-html/library/posix.html new file mode 100644 index 0000000..2f549b6 --- /dev/null +++ b/python-3.7.4-docs-html/library/posix.html @@ -0,0 +1,259 @@ + + + + + + + posix — The most common POSIX system calls — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    posix — The most common POSIX system calls

    +
    +

    This module provides access to operating system functionality that is +standardized by the C Standard and the POSIX standard (a thinly disguised Unix +interface).

    +

    Do not import this module directly. Instead, import the module os, +which provides a portable version of this interface. On Unix, the os +module provides a superset of the posix interface. On non-Unix operating +systems the posix module is not available, but a subset is always +available through the os interface. Once os is imported, there is +no performance penalty in using it instead of posix. In addition, +os provides some additional functionality, such as automatically calling +putenv() when an entry in os.environ is changed.

    +

    Errors are reported as exceptions; the usual exceptions are given for type +errors, while errors reported by the system calls raise OSError.

    +
    +

    Large File Support

    +

    Several operating systems (including AIX, HP-UX, Irix and Solaris) provide +support for files that are larger than 2 GiB from a C programming model where +int and long are 32-bit values. This is typically accomplished +by defining the relevant size and offset types as 64-bit values. Such files are +sometimes referred to as large files.

    +

    Large file support is enabled in Python when the size of an off_t is +larger than a long and the long long type is available and is +at least as large as an off_t. +It may be necessary to configure and compile Python with certain compiler flags +to enable this mode. For example, it is enabled by default with recent versions +of Irix, but with Solaris 2.6 and 2.7 you need to do something like:

    +
    CFLAGS="`getconf LFS_CFLAGS`" OPT="-g -O2 $CFLAGS" \
    +        ./configure
    +
    +
    +

    On large-file-capable Linux systems, this might work:

    +
    CFLAGS='-D_LARGEFILE64_SOURCE -D_FILE_OFFSET_BITS=64' OPT="-g -O2 $CFLAGS" \
    +        ./configure
    +
    +
    +
    +
    +

    Notable Module Contents

    +

    In addition to many functions described in the os module documentation, +posix defines the following data item:

    +
    +
    +posix.environ
    +

    A dictionary representing the string environment at the time the interpreter +was started. Keys and values are bytes on Unix and str on Windows. For +example, environ[b'HOME'] (environ['HOME'] on Windows) is the +pathname of your home directory, equivalent to getenv("HOME") in C.

    +

    Modifying this dictionary does not affect the string environment passed on by +execv(), popen() or system(); if you need to +change the environment, pass environ to execve() or add +variable assignments and export statements to the command string for +system() or popen().

    +
    +

    Changed in version 3.2: On Unix, keys and values are bytes.

    +
    +
    +

    Note

    +

    The os module provides an alternate implementation of environ +which updates the environment on modification. Note also that updating +os.environ will render this dictionary obsolete. Use of the +os module version of this is recommended over direct access to the +posix module.

    +
    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/pprint.html b/python-3.7.4-docs-html/library/pprint.html new file mode 100644 index 0000000..764b226 --- /dev/null +++ b/python-3.7.4-docs-html/library/pprint.html @@ -0,0 +1,546 @@ + + + + + + + pprint — Data pretty printer — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    pprint — Data pretty printer

    +

    Source code: Lib/pprint.py

    +
    +

    The pprint module provides a capability to “pretty-print” arbitrary +Python data structures in a form which can be used as input to the interpreter. +If the formatted structures include objects which are not fundamental Python +types, the representation may not be loadable. This may be the case if objects +such as files, sockets or classes are included, as well as many other +objects which are not representable as Python literals.

    +

    The formatted representation keeps objects on a single line if it can, and +breaks them onto multiple lines if they don’t fit within the allowed width. +Construct PrettyPrinter objects explicitly if you need to adjust the +width constraint.

    +

    Dictionaries are sorted by key before the display is computed.

    +

    The pprint module defines one class:

    +
    +
    +class pprint.PrettyPrinter(indent=1, width=80, depth=None, stream=None, *, compact=False)
    +

    Construct a PrettyPrinter instance. This constructor understands +several keyword parameters. An output stream may be set using the stream +keyword; the only method used on the stream object is the file protocol’s +write() method. If not specified, the PrettyPrinter adopts +sys.stdout. The +amount of indentation added for each recursive level is specified by indent; +the default is one. Other values can cause output to look a little odd, but can +make nesting easier to spot. The number of levels which may be printed is +controlled by depth; if the data structure being printed is too deep, the next +contained level is replaced by .... By default, there is no constraint on +the depth of the objects being formatted. The desired output width is +constrained using the width parameter; the default is 80 characters. If a +structure cannot be formatted within the constrained width, a best effort will +be made. If compact is false (the default) each item of a long sequence +will be formatted on a separate line. If compact is true, as many items +as will fit within the width will be formatted on each output line.

    +
    +

    Changed in version 3.4: Added the compact parameter.

    +
    >>> import pprint
    +>>> stuff = ['spam', 'eggs', 'lumberjack', 'knights', 'ni']
    +>>> stuff.insert(0, stuff[:])
    +>>> pp = pprint.PrettyPrinter(indent=4)
    +>>> pp.pprint(stuff)
    +[   ['spam', 'eggs', 'lumberjack', 'knights', 'ni'],
    +    'spam',
    +    'eggs',
    +    'lumberjack',
    +    'knights',
    +    'ni']
    +>>> pp = pprint.PrettyPrinter(width=41, compact=True)
    +>>> pp.pprint(stuff)
    +[['spam', 'eggs', 'lumberjack',
    +  'knights', 'ni'],
    + 'spam', 'eggs', 'lumberjack', 'knights',
    + 'ni']
    +>>> tup = ('spam', ('eggs', ('lumberjack', ('knights', ('ni', ('dead',
    +... ('parrot', ('fresh fruit',))))))))
    +>>> pp = pprint.PrettyPrinter(depth=6)
    +>>> pp.pprint(tup)
    +('spam', ('eggs', ('lumberjack', ('knights', ('ni', ('dead', (...)))))))
    +
    +
    +
    +
    + +

    The pprint module also provides several shortcut functions:

    +
    +
    +pprint.pformat(object, indent=1, width=80, depth=None, *, compact=False)
    +

    Return the formatted representation of object as a string. indent, +width, depth and compact will be passed to the PrettyPrinter +constructor as formatting parameters.

    +
    +

    Changed in version 3.4: Added the compact parameter.

    +
    +
    + +
    +
    +pprint.pprint(object, stream=None, indent=1, width=80, depth=None, *, compact=False)
    +

    Prints the formatted representation of object on stream, followed by a +newline. If stream is None, sys.stdout is used. This may be used +in the interactive interpreter instead of the print() function for +inspecting values (you can even reassign print = pprint.pprint for use +within a scope). indent, width, depth and compact will be passed +to the PrettyPrinter constructor as formatting parameters.

    +
    +

    Changed in version 3.4: Added the compact parameter.

    +
    >>> import pprint
    +>>> stuff = ['spam', 'eggs', 'lumberjack', 'knights', 'ni']
    +>>> stuff.insert(0, stuff)
    +>>> pprint.pprint(stuff)
    +[<Recursion on list with id=...>,
    + 'spam',
    + 'eggs',
    + 'lumberjack',
    + 'knights',
    + 'ni']
    +
    +
    +
    +
    + +
    +
    +pprint.isreadable(object)
    +

    Determine if the formatted representation of object is “readable,” or can be +used to reconstruct the value using eval(). This always returns False +for recursive objects.

    +
    >>> pprint.isreadable(stuff)
    +False
    +
    +
    +
    + +
    +
    +pprint.isrecursive(object)
    +

    Determine if object requires a recursive representation.

    +
    + +

    One more support function is also defined:

    +
    +
    +pprint.saferepr(object)
    +

    Return a string representation of object, protected against recursive data +structures. If the representation of object exposes a recursive entry, the +recursive reference will be represented as <Recursion on typename with +id=number>. The representation is not otherwise formatted.

    +
    >>> pprint.saferepr(stuff)
    +"[<Recursion on list with id=...>, 'spam', 'eggs', 'lumberjack', 'knights', 'ni']"
    +
    +
    +
    + +
    +

    PrettyPrinter Objects

    +

    PrettyPrinter instances have the following methods:

    +
    +
    +PrettyPrinter.pformat(object)
    +

    Return the formatted representation of object. This takes into account the +options passed to the PrettyPrinter constructor.

    +
    + +
    +
    +PrettyPrinter.pprint(object)
    +

    Print the formatted representation of object on the configured stream, +followed by a newline.

    +
    + +

    The following methods provide the implementations for the corresponding +functions of the same names. Using these methods on an instance is slightly +more efficient since new PrettyPrinter objects don’t need to be +created.

    +
    +
    +PrettyPrinter.isreadable(object)
    +

    Determine if the formatted representation of the object is “readable,” or can be +used to reconstruct the value using eval(). Note that this returns +False for recursive objects. If the depth parameter of the +PrettyPrinter is set and the object is deeper than allowed, this +returns False.

    +
    + +
    +
    +PrettyPrinter.isrecursive(object)
    +

    Determine if the object requires a recursive representation.

    +
    + +

    This method is provided as a hook to allow subclasses to modify the way objects +are converted to strings. The default implementation uses the internals of the +saferepr() implementation.

    +
    +
    +PrettyPrinter.format(object, context, maxlevels, level)
    +

    Returns three values: the formatted version of object as a string, a flag +indicating whether the result is readable, and a flag indicating whether +recursion was detected. The first argument is the object to be presented. The +second is a dictionary which contains the id() of objects that are part of +the current presentation context (direct and indirect containers for object +that are affecting the presentation) as the keys; if an object needs to be +presented which is already represented in context, the third return value +should be True. Recursive calls to the format() method should add +additional entries for containers to this dictionary. The third argument, +maxlevels, gives the requested limit to recursion; this will be 0 if there +is no requested limit. This argument should be passed unmodified to recursive +calls. The fourth argument, level, gives the current level; recursive calls +should be passed a value less than that of the current call.

    +
    + +
    +
    +

    Example

    +

    To demonstrate several uses of the pprint() function and its parameters, +let’s fetch information about a project from PyPI:

    +
    >>> import json
    +>>> import pprint
    +>>> from urllib.request import urlopen
    +>>> with urlopen('https://pypi.org/pypi/sampleproject/json') as resp:
    +...     project_info = json.load(resp)['info']
    +
    +
    +

    In its basic form, pprint() shows the whole object:

    +
    >>> pprint.pprint(project_info)
    +{'author': 'The Python Packaging Authority',
    + 'author_email': 'pypa-dev@googlegroups.com',
    + 'bugtrack_url': None,
    + 'classifiers': ['Development Status :: 3 - Alpha',
    +                 'Intended Audience :: Developers',
    +                 'License :: OSI Approved :: MIT License',
    +                 'Programming Language :: Python :: 2',
    +                 'Programming Language :: Python :: 2.6',
    +                 'Programming Language :: Python :: 2.7',
    +                 'Programming Language :: Python :: 3',
    +                 'Programming Language :: Python :: 3.2',
    +                 'Programming Language :: Python :: 3.3',
    +                 'Programming Language :: Python :: 3.4',
    +                 'Topic :: Software Development :: Build Tools'],
    + 'description': 'A sample Python project\n'
    +                '=======================\n'
    +                '\n'
    +                'This is the description file for the project.\n'
    +                '\n'
    +                'The file should use UTF-8 encoding and be written using '
    +                'ReStructured Text. It\n'
    +                'will be used to generate the project webpage on PyPI, and '
    +                'should be written for\n'
    +                'that purpose.\n'
    +                '\n'
    +                'Typical contents for this file would include an overview of '
    +                'the project, basic\n'
    +                'usage examples, etc. Generally, including the project '
    +                'changelog in here is not\n'
    +                'a good idea, although a simple "What\'s New" section for the '
    +                'most recent version\n'
    +                'may be appropriate.',
    + 'description_content_type': None,
    + 'docs_url': None,
    + 'download_url': 'UNKNOWN',
    + 'downloads': {'last_day': -1, 'last_month': -1, 'last_week': -1},
    + 'home_page': 'https://github.com/pypa/sampleproject',
    + 'keywords': 'sample setuptools development',
    + 'license': 'MIT',
    + 'maintainer': None,
    + 'maintainer_email': None,
    + 'name': 'sampleproject',
    + 'package_url': 'https://pypi.org/project/sampleproject/',
    + 'platform': 'UNKNOWN',
    + 'project_url': 'https://pypi.org/project/sampleproject/',
    + 'project_urls': {'Download': 'UNKNOWN',
    +                  'Homepage': 'https://github.com/pypa/sampleproject'},
    + 'release_url': 'https://pypi.org/project/sampleproject/1.2.0/',
    + 'requires_dist': None,
    + 'requires_python': None,
    + 'summary': 'A sample Python project',
    + 'version': '1.2.0'}
    +
    +
    +

    The result can be limited to a certain depth (ellipsis is used for deeper +contents):

    +
    >>> pprint.pprint(project_info, depth=1)
    +{'author': 'The Python Packaging Authority',
    + 'author_email': 'pypa-dev@googlegroups.com',
    + 'bugtrack_url': None,
    + 'classifiers': [...],
    + 'description': 'A sample Python project\n'
    +                '=======================\n'
    +                '\n'
    +                'This is the description file for the project.\n'
    +                '\n'
    +                'The file should use UTF-8 encoding and be written using '
    +                'ReStructured Text. It\n'
    +                'will be used to generate the project webpage on PyPI, and '
    +                'should be written for\n'
    +                'that purpose.\n'
    +                '\n'
    +                'Typical contents for this file would include an overview of '
    +                'the project, basic\n'
    +                'usage examples, etc. Generally, including the project '
    +                'changelog in here is not\n'
    +                'a good idea, although a simple "What\'s New" section for the '
    +                'most recent version\n'
    +                'may be appropriate.',
    + 'description_content_type': None,
    + 'docs_url': None,
    + 'download_url': 'UNKNOWN',
    + 'downloads': {...},
    + 'home_page': 'https://github.com/pypa/sampleproject',
    + 'keywords': 'sample setuptools development',
    + 'license': 'MIT',
    + 'maintainer': None,
    + 'maintainer_email': None,
    + 'name': 'sampleproject',
    + 'package_url': 'https://pypi.org/project/sampleproject/',
    + 'platform': 'UNKNOWN',
    + 'project_url': 'https://pypi.org/project/sampleproject/',
    + 'project_urls': {...},
    + 'release_url': 'https://pypi.org/project/sampleproject/1.2.0/',
    + 'requires_dist': None,
    + 'requires_python': None,
    + 'summary': 'A sample Python project',
    + 'version': '1.2.0'}
    +
    +
    +

    Additionally, maximum character width can be suggested. If a long object +cannot be split, the specified width will be exceeded:

    +
    >>> pprint.pprint(project_info, depth=1, width=60)
    +{'author': 'The Python Packaging Authority',
    + 'author_email': 'pypa-dev@googlegroups.com',
    + 'bugtrack_url': None,
    + 'classifiers': [...],
    + 'description': 'A sample Python project\n'
    +                '=======================\n'
    +                '\n'
    +                'This is the description file for the '
    +                'project.\n'
    +                '\n'
    +                'The file should use UTF-8 encoding and be '
    +                'written using ReStructured Text. It\n'
    +                'will be used to generate the project '
    +                'webpage on PyPI, and should be written '
    +                'for\n'
    +                'that purpose.\n'
    +                '\n'
    +                'Typical contents for this file would '
    +                'include an overview of the project, '
    +                'basic\n'
    +                'usage examples, etc. Generally, including '
    +                'the project changelog in here is not\n'
    +                'a good idea, although a simple "What\'s '
    +                'New" section for the most recent version\n'
    +                'may be appropriate.',
    + 'description_content_type': None,
    + 'docs_url': None,
    + 'download_url': 'UNKNOWN',
    + 'downloads': {...},
    + 'home_page': 'https://github.com/pypa/sampleproject',
    + 'keywords': 'sample setuptools development',
    + 'license': 'MIT',
    + 'maintainer': None,
    + 'maintainer_email': None,
    + 'name': 'sampleproject',
    + 'package_url': 'https://pypi.org/project/sampleproject/',
    + 'platform': 'UNKNOWN',
    + 'project_url': 'https://pypi.org/project/sampleproject/',
    + 'project_urls': {...},
    + 'release_url': 'https://pypi.org/project/sampleproject/1.2.0/',
    + 'requires_dist': None,
    + 'requires_python': None,
    + 'summary': 'A sample Python project',
    + 'version': '1.2.0'}
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/profile.html b/python-3.7.4-docs-html/library/profile.html new file mode 100644 index 0000000..54fc278 --- /dev/null +++ b/python-3.7.4-docs-html/library/profile.html @@ -0,0 +1,856 @@ + + + + + + + The Python Profilers — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    The Python Profilers

    +

    Source code: Lib/profile.py and Lib/pstats.py

    +
    +
    +

    Introduction to the profilers

    +

    cProfile and profile provide deterministic profiling of +Python programs. A profile is a set of statistics that describes how +often and for how long various parts of the program executed. These statistics +can be formatted into reports via the pstats module.

    +

    The Python standard library provides two different implementations of the same +profiling interface:

    +
      +
    1. cProfile is recommended for most users; it’s a C extension with +reasonable overhead that makes it suitable for profiling long-running +programs. Based on lsprof, contributed by Brett Rosen and Ted +Czotter.

    2. +
    3. profile, a pure Python module whose interface is imitated by +cProfile, but which adds significant overhead to profiled programs. +If you’re trying to extend the profiler in some way, the task might be easier +with this module. Originally designed and written by Jim Roskind.

    4. +
    +
    +

    Note

    +

    The profiler modules are designed to provide an execution profile for a given +program, not for benchmarking purposes (for that, there is timeit for +reasonably accurate results). This particularly applies to benchmarking +Python code against C code: the profilers introduce overhead for Python code, +but not for C-level functions, and so the C code would seem faster than any +Python one.

    +
    +
    +
    +

    Instant User’s Manual

    +

    This section is provided for users that “don’t want to read the manual.” It +provides a very brief overview, and allows a user to rapidly perform profiling +on an existing application.

    +

    To profile a function that takes a single argument, you can do:

    +
    import cProfile
    +import re
    +cProfile.run('re.compile("foo|bar")')
    +
    +
    +

    (Use profile instead of cProfile if the latter is not available on +your system.)

    +

    The above action would run re.compile() and print profile results like +the following:

    +
          197 function calls (192 primitive calls) in 0.002 seconds
    +
    +Ordered by: standard name
    +
    +ncalls  tottime  percall  cumtime  percall filename:lineno(function)
    +     1    0.000    0.000    0.001    0.001 <string>:1(<module>)
    +     1    0.000    0.000    0.001    0.001 re.py:212(compile)
    +     1    0.000    0.000    0.001    0.001 re.py:268(_compile)
    +     1    0.000    0.000    0.000    0.000 sre_compile.py:172(_compile_charset)
    +     1    0.000    0.000    0.000    0.000 sre_compile.py:201(_optimize_charset)
    +     4    0.000    0.000    0.000    0.000 sre_compile.py:25(_identityfunction)
    +   3/1    0.000    0.000    0.000    0.000 sre_compile.py:33(_compile)
    +
    +
    +

    The first line indicates that 197 calls were monitored. Of those calls, 192 +were primitive, meaning that the call was not induced via recursion. The +next line: Ordered by: standard name, indicates that the text string in the +far right column was used to sort the output. The column headings include:

    +
    +
    ncalls

    for the number of calls.

    +
    +
    tottime

    for the total time spent in the given function (and excluding time made in +calls to sub-functions)

    +
    +
    percall

    is the quotient of tottime divided by ncalls

    +
    +
    cumtime

    is the cumulative time spent in this and all subfunctions (from invocation +till exit). This figure is accurate even for recursive functions.

    +
    +
    percall

    is the quotient of cumtime divided by primitive calls

    +
    +
    filename:lineno(function)

    provides the respective data of each function

    +
    +
    +

    When there are two numbers in the first column (for example 3/1), it means +that the function recursed. The second value is the number of primitive calls +and the former is the total number of calls. Note that when the function does +not recurse, these two values are the same, and only the single figure is +printed.

    +

    Instead of printing the output at the end of the profile run, you can save the +results to a file by specifying a filename to the run() function:

    +
    import cProfile
    +import re
    +cProfile.run('re.compile("foo|bar")', 'restats')
    +
    +
    +

    The pstats.Stats class reads profile results from a file and formats +them in various ways.

    +

    The file cProfile can also be invoked as a script to profile another +script. For example:

    +
    python -m cProfile [-o output_file] [-s sort_order] (-m module | myscript.py)
    +
    +
    +

    -o writes the profile results to a file instead of to stdout

    +

    -s specifies one of the sort_stats() sort values to sort +the output by. This only applies when -o is not supplied.

    +

    -m specifies that a module is being profiled instead of a script.

    +
    +
    +

    New in version 3.7: Added the -m option.

    +
    +
    +

    The pstats module’s Stats class has a variety of methods +for manipulating and printing the data saved into a profile results file:

    +
    import pstats
    +from pstats import SortKey
    +p = pstats.Stats('restats')
    +p.strip_dirs().sort_stats(-1).print_stats()
    +
    +
    +

    The strip_dirs() method removed the extraneous path from all +the module names. The sort_stats() method sorted all the +entries according to the standard module/line/name string that is printed. The +print_stats() method printed out all the statistics. You +might try the following sort calls:

    +
    p.sort_stats(SortKey.NAME)
    +p.print_stats()
    +
    +
    +

    The first call will actually sort the list by function name, and the second call +will print out the statistics. The following are some interesting calls to +experiment with:

    +
    p.sort_stats(SortKey.CUMULATIVE).print_stats(10)
    +
    +
    +

    This sorts the profile by cumulative time in a function, and then only prints +the ten most significant lines. If you want to understand what algorithms are +taking time, the above line is what you would use.

    +

    If you were looking to see what functions were looping a lot, and taking a lot +of time, you would do:

    +
    p.sort_stats(SortKey.TIME).print_stats(10)
    +
    +
    +

    to sort according to time spent within each function, and then print the +statistics for the top ten functions.

    +

    You might also try:

    +
    p.sort_stats(SortKey.FILENAME).print_stats('__init__')
    +
    +
    +

    This will sort all the statistics by file name, and then print out statistics +for only the class init methods (since they are spelled with __init__ in +them). As one final example, you could try:

    +
    p.sort_stats(SortKey.TIME, SortKey.CUMULATIVE).print_stats(.5, 'init')
    +
    +
    +

    This line sorts statistics with a primary key of time, and a secondary key of +cumulative time, and then prints out some of the statistics. To be specific, the +list is first culled down to 50% (re: .5) of its original size, then only +lines containing init are maintained, and that sub-sub-list is printed.

    +

    If you wondered what functions called the above functions, you could now (p +is still sorted according to the last criteria) do:

    +
    p.print_callers(.5, 'init')
    +
    +
    +

    and you would get a list of callers for each of the listed functions.

    +

    If you want more functionality, you’re going to have to read the manual, or +guess what the following functions do:

    +
    p.print_callees()
    +p.add('restats')
    +
    +
    +

    Invoked as a script, the pstats module is a statistics browser for +reading and examining profile dumps. It has a simple line-oriented interface +(implemented using cmd) and interactive help.

    +
    +
    +

    profile and cProfile Module Reference

    +

    Both the profile and cProfile modules provide the following +functions:

    +
    +
    +profile.run(command, filename=None, sort=-1)
    +

    This function takes a single argument that can be passed to the exec() +function, and an optional file name. In all cases this routine executes:

    +
    exec(command, __main__.__dict__, __main__.__dict__)
    +
    +
    +

    and gathers profiling statistics from the execution. If no file name is +present, then this function automatically creates a Stats +instance and prints a simple profiling report. If the sort value is specified, +it is passed to this Stats instance to control how the +results are sorted.

    +
    + +
    +
    +profile.runctx(command, globals, locals, filename=None, sort=-1)
    +

    This function is similar to run(), with added arguments to supply the +globals and locals dictionaries for the command string. This routine +executes:

    +
    exec(command, globals, locals)
    +
    +
    +

    and gathers profiling statistics as in the run() function above.

    +
    + +
    +
    +class profile.Profile(timer=None, timeunit=0.0, subcalls=True, builtins=True)
    +

    This class is normally only used if more precise control over profiling is +needed than what the cProfile.run() function provides.

    +

    A custom timer can be supplied for measuring how long code takes to run via +the timer argument. This must be a function that returns a single number +representing the current time. If the number is an integer, the timeunit +specifies a multiplier that specifies the duration of each unit of time. For +example, if the timer returns times measured in thousands of seconds, the +time unit would be .001.

    +

    Directly using the Profile class allows formatting profile results +without writing the profile data to a file:

    +
    import cProfile, pstats, io
    +from pstats import SortKey
    +pr = cProfile.Profile()
    +pr.enable()
    +# ... do something ...
    +pr.disable()
    +s = io.StringIO()
    +sortby = SortKey.CUMULATIVE
    +ps = pstats.Stats(pr, stream=s).sort_stats(sortby)
    +ps.print_stats()
    +print(s.getvalue())
    +
    +
    +
    +
    +enable()
    +

    Start collecting profiling data.

    +
    + +
    +
    +disable()
    +

    Stop collecting profiling data.

    +
    + +
    +
    +create_stats()
    +

    Stop collecting profiling data and record the results internally +as the current profile.

    +
    + +
    +
    +print_stats(sort=-1)
    +

    Create a Stats object based on the current +profile and print the results to stdout.

    +
    + +
    +
    +dump_stats(filename)
    +

    Write the results of the current profile to filename.

    +
    + +
    +
    +run(cmd)
    +

    Profile the cmd via exec().

    +
    + +
    +
    +runctx(cmd, globals, locals)
    +

    Profile the cmd via exec() with the specified global and +local environment.

    +
    + +
    +
    +runcall(func, *args, **kwargs)
    +

    Profile func(*args, **kwargs)

    +
    + +
    + +

    Note that profiling will only work if the called command/function actually +returns. If the interpreter is terminated (e.g. via a sys.exit() call +during the called command/function execution) no profiling results will be +printed.

    +
    +
    +

    The Stats Class

    +

    Analysis of the profiler data is done using the Stats class.

    +
    +
    +class pstats.Stats(*filenames or profile, stream=sys.stdout)
    +

    This class constructor creates an instance of a “statistics object” from a +filename (or list of filenames) or from a Profile instance. Output +will be printed to the stream specified by stream.

    +

    The file selected by the above constructor must have been created by the +corresponding version of profile or cProfile. To be specific, +there is no file compatibility guaranteed with future versions of this +profiler, and there is no compatibility with files produced by other +profilers, or the same profiler run on a different operating system. If +several files are provided, all the statistics for identical functions will +be coalesced, so that an overall view of several processes can be considered +in a single report. If additional files need to be combined with data in an +existing Stats object, the add() method +can be used.

    +

    Instead of reading the profile data from a file, a cProfile.Profile +or profile.Profile object can be used as the profile data source.

    +

    Stats objects have the following methods:

    +
    +
    +strip_dirs()
    +

    This method for the Stats class removes all leading path +information from file names. It is very useful in reducing the size of +the printout to fit within (close to) 80 columns. This method modifies +the object, and the stripped information is lost. After performing a +strip operation, the object is considered to have its entries in a +“random” order, as it was just after object initialization and loading. +If strip_dirs() causes two function names to be +indistinguishable (they are on the same line of the same filename, and +have the same function name), then the statistics for these two entries +are accumulated into a single entry.

    +
    + +
    +
    +add(*filenames)
    +

    This method of the Stats class accumulates additional profiling +information into the current profiling object. Its arguments should refer +to filenames created by the corresponding version of profile.run() +or cProfile.run(). Statistics for identically named (re: file, line, +name) functions are automatically accumulated into single function +statistics.

    +
    + +
    +
    +dump_stats(filename)
    +

    Save the data loaded into the Stats object to a file named +filename. The file is created if it does not exist, and is overwritten +if it already exists. This is equivalent to the method of the same name +on the profile.Profile and cProfile.Profile classes.

    +
    + +
    +
    +sort_stats(*keys)
    +

    This method modifies the Stats object by sorting it according to +the supplied criteria. The argument can be either a string or a SortKey +enum identifying the basis of a sort (example: 'time', 'name', +SortKey.TIME or SortKey.NAME). The SortKey enums argument have +advantage over the string argument in that it is more robust and less +error prone.

    +

    When more than one key is provided, then additional keys are used as +secondary criteria when there is equality in all keys selected before +them. For example, sort_stats(SortKey.NAME, SortKey.FILE) will sort +all the entries according to their function name, and resolve all ties +(identical function names) by sorting by file name.

    +

    For the string argument, abbreviations can be used for any key names, as +long as the abbreviation is unambiguous.

    +

    The following are the valid string and SortKey:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Valid String Arg

    Valid enum Arg

    Meaning

    'calls'

    SortKey.CALLS

    call count

    'cumulative'

    SortKey.CUMULATIVE

    cumulative time

    'cumtime'

    N/A

    cumulative time

    'file'

    N/A

    file name

    'filename'

    SortKey.FILENAME

    file name

    'module'

    N/A

    file name

    'ncalls'

    N/A

    call count

    'pcalls'

    SortKey.PCALLS

    primitive call count

    'line'

    SortKey.LINE

    line number

    'name'

    SortKey.NAME

    function name

    'nfl'

    SortKey.NFL

    name/file/line

    'stdname'

    SortKey.STDNAME

    standard name

    'time'

    SortKey.TIME

    internal time

    'tottime'

    N/A

    internal time

    +

    Note that all sorts on statistics are in descending order (placing most +time consuming items first), where as name, file, and line number searches +are in ascending order (alphabetical). The subtle distinction between +SortKey.NFL and SortKey.STDNAME is that the standard name is a +sort of the name as printed, which means that the embedded line numbers +get compared in an odd way. For example, lines 3, 20, and 40 would (if +the file names were the same) appear in the string order 20, 3 and 40. +In contrast, SortKey.NFL does a numeric compare of the line numbers. +In fact, sort_stats(SortKey.NFL) is the same as +sort_stats(SortKey.NAME, SortKey.FILENAME, SortKey.LINE).

    +

    For backward-compatibility reasons, the numeric arguments -1, 0, +1, and 2 are permitted. They are interpreted as 'stdname', +'calls', 'time', and 'cumulative' respectively. If this old +style format (numeric) is used, only one sort key (the numeric key) will +be used, and additional arguments will be silently ignored.

    +
    +

    New in version 3.7: Added the SortKey enum.

    +
    +
    + +
    +
    +reverse_order()
    +

    This method for the Stats class reverses the ordering of the +basic list within the object. Note that by default ascending vs +descending order is properly selected based on the sort key of choice.

    +
    + +
    +
    +print_stats(*restrictions)
    +

    This method for the Stats class prints out a report as described +in the profile.run() definition.

    +

    The order of the printing is based on the last +sort_stats() operation done on the object (subject to +caveats in add() and +strip_dirs()).

    +

    The arguments provided (if any) can be used to limit the list down to the +significant entries. Initially, the list is taken to be the complete set +of profiled functions. Each restriction is either an integer (to select a +count of lines), or a decimal fraction between 0.0 and 1.0 inclusive (to +select a percentage of lines), or a string that will interpreted as a +regular expression (to pattern match the standard name that is printed). +If several restrictions are provided, then they are applied sequentially. +For example:

    +
    print_stats(.1, 'foo:')
    +
    +
    +

    would first limit the printing to first 10% of list, and then only print +functions that were part of filename .*foo:. In contrast, the +command:

    +
    print_stats('foo:', .1)
    +
    +
    +

    would limit the list to all functions having file names .*foo:, +and then proceed to only print the first 10% of them.

    +
    + +
    +
    +print_callers(*restrictions)
    +

    This method for the Stats class prints a list of all functions +that called each function in the profiled database. The ordering is +identical to that provided by print_stats(), and the +definition of the restricting argument is also identical. Each caller is +reported on its own line. The format differs slightly depending on the +profiler that produced the stats:

    +
      +
    • With profile, a number is shown in parentheses after each caller +to show how many times this specific call was made. For convenience, a +second non-parenthesized number repeats the cumulative time spent in the +function at the right.

    • +
    • With cProfile, each caller is preceded by three numbers: the +number of times this specific call was made, and the total and +cumulative times spent in the current function while it was invoked by +this specific caller.

    • +
    +
    + +
    +
    +print_callees(*restrictions)
    +

    This method for the Stats class prints a list of all function +that were called by the indicated function. Aside from this reversal of +direction of calls (re: called vs was called by), the arguments and +ordering are identical to the print_callers() method.

    +
    + +
    + +
    +
    +

    What Is Deterministic Profiling?

    +

    Deterministic profiling is meant to reflect the fact that all function +call, function return, and exception events are monitored, and precise +timings are made for the intervals between these events (during which time the +user’s code is executing). In contrast, statistical profiling (which is +not done by this module) randomly samples the effective instruction pointer, and +deduces where time is being spent. The latter technique traditionally involves +less overhead (as the code does not need to be instrumented), but provides only +relative indications of where time is being spent.

    +

    In Python, since there is an interpreter active during execution, the presence +of instrumented code is not required to do deterministic profiling. Python +automatically provides a hook (optional callback) for each event. In +addition, the interpreted nature of Python tends to add so much overhead to +execution, that deterministic profiling tends to only add small processing +overhead in typical applications. The result is that deterministic profiling is +not that expensive, yet provides extensive run time statistics about the +execution of a Python program.

    +

    Call count statistics can be used to identify bugs in code (surprising counts), +and to identify possible inline-expansion points (high call counts). Internal +time statistics can be used to identify “hot loops” that should be carefully +optimized. Cumulative time statistics should be used to identify high level +errors in the selection of algorithms. Note that the unusual handling of +cumulative times in this profiler allows statistics for recursive +implementations of algorithms to be directly compared to iterative +implementations.

    +
    +
    +

    Limitations

    +

    One limitation has to do with accuracy of timing information. There is a +fundamental problem with deterministic profilers involving accuracy. The most +obvious restriction is that the underlying “clock” is only ticking at a rate +(typically) of about .001 seconds. Hence no measurements will be more accurate +than the underlying clock. If enough measurements are taken, then the “error” +will tend to average out. Unfortunately, removing this first error induces a +second source of error.

    +

    The second problem is that it “takes a while” from when an event is dispatched +until the profiler’s call to get the time actually gets the state of the +clock. Similarly, there is a certain lag when exiting the profiler event +handler from the time that the clock’s value was obtained (and then squirreled +away), until the user’s code is once again executing. As a result, functions +that are called many times, or call many functions, will typically accumulate +this error. The error that accumulates in this fashion is typically less than +the accuracy of the clock (less than one clock tick), but it can accumulate +and become very significant.

    +

    The problem is more important with profile than with the lower-overhead +cProfile. For this reason, profile provides a means of +calibrating itself for a given platform so that this error can be +probabilistically (on the average) removed. After the profiler is calibrated, it +will be more accurate (in a least square sense), but it will sometimes produce +negative numbers (when call counts are exceptionally low, and the gods of +probability work against you :-). ) Do not be alarmed by negative numbers in +the profile. They should only appear if you have calibrated your profiler, +and the results are actually better than without calibration.

    +
    +
    +

    Calibration

    +

    The profiler of the profile module subtracts a constant from each event +handling time to compensate for the overhead of calling the time function, and +socking away the results. By default, the constant is 0. The following +procedure can be used to obtain a better constant for a given platform (see +Limitations).

    +
    import profile
    +pr = profile.Profile()
    +for i in range(5):
    +    print(pr.calibrate(10000))
    +
    +
    +

    The method executes the number of Python calls given by the argument, directly +and again under the profiler, measuring the time for both. It then computes the +hidden overhead per profiler event, and returns that as a float. For example, +on a 1.8Ghz Intel Core i5 running Mac OS X, and using Python’s time.process_time() as +the timer, the magical number is about 4.04e-6.

    +

    The object of this exercise is to get a fairly consistent result. If your +computer is very fast, or your timer function has poor resolution, you might +have to pass 100000, or even 1000000, to get consistent results.

    +

    When you have a consistent answer, there are three ways you can use it:

    +
    import profile
    +
    +# 1. Apply computed bias to all Profile instances created hereafter.
    +profile.Profile.bias = your_computed_bias
    +
    +# 2. Apply computed bias to a specific Profile instance.
    +pr = profile.Profile()
    +pr.bias = your_computed_bias
    +
    +# 3. Specify computed bias in instance constructor.
    +pr = profile.Profile(bias=your_computed_bias)
    +
    +
    +

    If you have a choice, you are better off choosing a smaller constant, and then +your results will “less often” show up as negative in profile statistics.

    +
    +
    +

    Using a custom timer

    +

    If you want to change how current time is determined (for example, to force use +of wall-clock time or elapsed process time), pass the timing function you want +to the Profile class constructor:

    +
    pr = profile.Profile(your_time_func)
    +
    +
    +

    The resulting profiler will then call your_time_func. Depending on whether +you are using profile.Profile or cProfile.Profile, +your_time_func’s return value will be interpreted differently:

    +
    +
    profile.Profile

    your_time_func should return a single number, or a list of numbers whose +sum is the current time (like what os.times() returns). If the +function returns a single time number, or the list of returned numbers has +length 2, then you will get an especially fast version of the dispatch +routine.

    +

    Be warned that you should calibrate the profiler class for the timer function +that you choose (see Calibration). For most machines, a timer +that returns a lone integer value will provide the best results in terms of +low overhead during profiling. (os.times() is pretty bad, as it +returns a tuple of floating point values). If you want to substitute a +better timer in the cleanest fashion, derive a class and hardwire a +replacement dispatch method that best handles your timer call, along with the +appropriate calibration constant.

    +
    +
    cProfile.Profile

    your_time_func should return a single number. If it returns integers, +you can also invoke the class constructor with a second argument specifying +the real duration of one unit of time. For example, if +your_integer_time_func returns times measured in thousands of seconds, +you would construct the Profile instance as follows:

    +
    pr = cProfile.Profile(your_integer_time_func, 0.001)
    +
    +
    +

    As the cProfile.Profile class cannot be calibrated, custom timer +functions should be used with care and should be as fast as possible. For +the best results with a custom timer, it might be necessary to hard-code it +in the C source of the internal _lsprof module.

    +
    +
    +

    Python 3.3 adds several new functions in time that can be used to make +precise measurements of process or wall-clock time. For example, see +time.perf_counter().

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/pty.html b/python-3.7.4-docs-html/library/pty.html new file mode 100644 index 0000000..b45faa0 --- /dev/null +++ b/python-3.7.4-docs-html/library/pty.html @@ -0,0 +1,287 @@ + + + + + + + pty — Pseudo-terminal utilities — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    pty — Pseudo-terminal utilities

    +

    Source code: Lib/pty.py

    +
    +

    The pty module defines operations for handling the pseudo-terminal +concept: starting another process and being able to write to and read from its +controlling terminal programmatically.

    +

    Because pseudo-terminal handling is highly platform dependent, there is code to +do it only for Linux. (The Linux code is supposed to work on other platforms, +but hasn’t been tested yet.)

    +

    The pty module defines the following functions:

    +
    +
    +pty.fork()
    +

    Fork. Connect the child’s controlling terminal to a pseudo-terminal. Return +value is (pid, fd). Note that the child gets pid 0, and the fd is +invalid. The parent’s return value is the pid of the child, and fd is a +file descriptor connected to the child’s controlling terminal (and also to the +child’s standard input and output).

    +
    + +
    +
    +pty.openpty()
    +

    Open a new pseudo-terminal pair, using os.openpty() if possible, or +emulation code for generic Unix systems. Return a pair of file descriptors +(master, slave), for the master and the slave end, respectively.

    +
    + +
    +
    +pty.spawn(argv[, master_read[, stdin_read]])
    +

    Spawn a process, and connect its controlling terminal with the current +process’s standard io. This is often used to baffle programs which insist on +reading from the controlling terminal. It is expected that the process +spawned behind the pty will eventually terminate, and when it does spawn +will return.

    +

    The functions master_read and stdin_read are passed a file descriptor +which they should read from, and they should always return a byte string. In +order to force spawn to return before the child process exits an +OSError should be thrown.

    +

    The default implementation for both functions will read and return up to 1024 +bytes each time the function is called. The master_read callback is passed +the pseudoterminal’s master file descriptor to read output from the child +process, and stdin_read is passed file descriptor 0, to read from the +parent process’s standard input.

    +

    Returning an empty byte string from either callback is interpreted as an +end-of-file (EOF) condition, and that callback will not be called after +that. If stdin_read signals EOF the controlling terminal can no longer +communicate with the parent process OR the child process. Unless the child +process will quit without any input, spawn will then loop forever. If +master_read signals EOF the same behavior results (on linux at least).

    +

    If both callbacks signal EOF then spawn will probably never return, unless +select throws an error on your platform when passed three empty lists. This +is a bug, documented in issue 26228.

    +
    +

    Changed in version 3.4: spawn() now returns the status value from os.waitpid() +on the child process.

    +
    +
    + +
    +

    Example

    +

    The following program acts like the Unix command script(1), using a +pseudo-terminal to record all input and output of a terminal session in a +“typescript”.

    +
    import argparse
    +import os
    +import pty
    +import sys
    +import time
    +
    +parser = argparse.ArgumentParser()
    +parser.add_argument('-a', dest='append', action='store_true')
    +parser.add_argument('-p', dest='use_python', action='store_true')
    +parser.add_argument('filename', nargs='?', default='typescript')
    +options = parser.parse_args()
    +
    +shell = sys.executable if options.use_python else os.environ.get('SHELL', 'sh')
    +filename = options.filename
    +mode = 'ab' if options.append else 'wb'
    +
    +with open(filename, mode) as script:
    +    def read(fd):
    +        data = os.read(fd, 1024)
    +        script.write(data)
    +        return data
    +
    +    print('Script started, file is', filename)
    +    script.write(('Script started on %s\n' % time.asctime()).encode())
    +
    +    pty.spawn(shell, read)
    +
    +    script.write(('Script done on %s\n' % time.asctime()).encode())
    +    print('Script done, file is', filename)
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/pwd.html b/python-3.7.4-docs-html/library/pwd.html new file mode 100644 index 0000000..73fe825 --- /dev/null +++ b/python-3.7.4-docs-html/library/pwd.html @@ -0,0 +1,273 @@ + + + + + + + pwd — The password database — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    pwd — The password database

    +
    +

    This module provides access to the Unix user account and password database. It +is available on all Unix versions.

    +

    Password database entries are reported as a tuple-like object, whose attributes +correspond to the members of the passwd structure (Attribute field below, +see <pwd.h>):

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Index

    Attribute

    Meaning

    0

    pw_name

    Login name

    1

    pw_passwd

    Optional encrypted password

    2

    pw_uid

    Numerical user ID

    3

    pw_gid

    Numerical group ID

    4

    pw_gecos

    User name or comment field

    5

    pw_dir

    User home directory

    6

    pw_shell

    User command interpreter

    +

    The uid and gid items are integers, all others are strings. KeyError is +raised if the entry asked for cannot be found.

    +
    +

    Note

    +

    In traditional Unix the field pw_passwd usually contains a password +encrypted with a DES derived algorithm (see module crypt). However most +modern unices use a so-called shadow password system. On those unices the +pw_passwd field only contains an asterisk ('*') or the letter 'x' +where the encrypted password is stored in a file /etc/shadow which is +not world readable. Whether the pw_passwd field contains anything useful is +system-dependent. If available, the spwd module should be used where +access to the encrypted password is required.

    +
    +

    It defines the following items:

    +
    +
    +pwd.getpwuid(uid)
    +

    Return the password database entry for the given numeric user ID.

    +
    + +
    +
    +pwd.getpwnam(name)
    +

    Return the password database entry for the given user name.

    +
    + +
    +
    +pwd.getpwall()
    +

    Return a list of all available password database entries, in arbitrary order.

    +
    + +
    +

    See also

    +
    +
    Module grp

    An interface to the group database, similar to this.

    +
    +
    Module spwd

    An interface to the shadow password database, similar to this.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/py_compile.html b/python-3.7.4-docs-html/library/py_compile.html new file mode 100644 index 0000000..4aa7f5b --- /dev/null +++ b/python-3.7.4-docs-html/library/py_compile.html @@ -0,0 +1,314 @@ + + + + + + + py_compile — Compile Python source files — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    py_compile — Compile Python source files

    +

    Source code: Lib/py_compile.py

    +
    +

    The py_compile module provides a function to generate a byte-code file +from a source file, and another function used when the module source file is +invoked as a script.

    +

    Though not often needed, this function can be useful when installing modules for +shared use, especially if some of the users may not have permission to write the +byte-code cache files in the directory containing the source code.

    +
    +
    +exception py_compile.PyCompileError
    +

    Exception raised when an error occurs while attempting to compile the file.

    +
    + +
    +
    +py_compile.compile(file, cfile=None, dfile=None, doraise=False, optimize=-1, invalidation_mode=PycInvalidationMode.TIMESTAMP)
    +

    Compile a source file to byte-code and write out the byte-code cache file. +The source code is loaded from the file named file. The byte-code is +written to cfile, which defaults to the PEP 3147/PEP 488 path, ending +in .pyc. +For example, if file is /foo/bar/baz.py cfile will default to +/foo/bar/__pycache__/baz.cpython-32.pyc for Python 3.2. If dfile is +specified, it is used as the name of the source file in error messages when +instead of file. If doraise is true, a PyCompileError is raised +when an error is encountered while compiling file. If doraise is false +(the default), an error string is written to sys.stderr, but no exception +is raised. This function returns the path to byte-compiled file, i.e. +whatever cfile value was used.

    +

    If the path that cfile becomes (either explicitly specified or computed) +is a symlink or non-regular file, FileExistsError will be raised. +This is to act as a warning that import will turn those paths into regular +files if it is allowed to write byte-compiled files to those paths. This is +a side-effect of import using file renaming to place the final byte-compiled +file into place to prevent concurrent file writing issues.

    +

    optimize controls the optimization level and is passed to the built-in +compile() function. The default of -1 selects the optimization +level of the current interpreter.

    +

    invalidation_mode should be a member of the PycInvalidationMode +enum and controls how the generated bytecode cache is invalidated at +runtime. The default is PycInvalidationMode.CHECKED_HASH if +the SOURCE_DATE_EPOCH environment variable is set, otherwise +the default is PycInvalidationMode.TIMESTAMP.

    +
    +

    Changed in version 3.2: Changed default value of cfile to be PEP 3147-compliant. Previous +default was file + 'c' ('o' if optimization was enabled). +Also added the optimize parameter.

    +
    +
    +

    Changed in version 3.4: Changed code to use importlib for the byte-code cache file writing. +This means file creation/writing semantics now match what importlib +does, e.g. permissions, write-and-move semantics, etc. Also added the +caveat that FileExistsError is raised if cfile is a symlink or +non-regular file.

    +
    +
    +

    Changed in version 3.7: The invalidation_mode parameter was added as specified in PEP 552. +If the SOURCE_DATE_EPOCH environment variable is set, +invalidation_mode will be forced to +PycInvalidationMode.CHECKED_HASH.

    +
    +
    +

    Changed in version 3.7.2: The SOURCE_DATE_EPOCH environment variable no longer +overrides the value of the invalidation_mode argument, and determines +its default value instead.

    +
    +
    + +
    +
    +class py_compile.PycInvalidationMode
    +

    A enumeration of possible methods the interpreter can use to determine +whether a bytecode file is up to date with a source file. The .pyc file +indicates the desired invalidation mode in its header. See +Cached bytecode invalidation for more information on how Python invalidates +.pyc files at runtime.

    +
    +

    New in version 3.7.

    +
    +
    +
    +TIMESTAMP
    +

    The .pyc file includes the timestamp and size of the source file, +which Python will compare against the metadata of the source file at +runtime to determine if the .pyc file needs to be regenerated.

    +
    + +
    +
    +CHECKED_HASH
    +

    The .pyc file includes a hash of the source file content, which Python +will compare against the source at runtime to determine if the .pyc +file needs to be regenerated.

    +
    + +
    +
    +UNCHECKED_HASH
    +

    Like CHECKED_HASH, the .pyc file includes a hash of the source +file content. However, Python will at runtime assume the .pyc file is +up to date and not validate the .pyc against the source file at all.

    +

    This option is useful when the .pycs are kept up to date by some +system external to Python like a build system.

    +
    + +
    + +
    +
    +py_compile.main(args=None)
    +

    Compile several source files. The files named in args (or on the command +line, if args is None) are compiled and the resulting byte-code is +cached in the normal manner. This function does not search a directory +structure to locate source files; it only compiles files named explicitly. +If '-' is the only parameter in args, the list of files is taken from +standard input.

    +
    +

    Changed in version 3.2: Added support for '-'.

    +
    +
    + +

    When this module is run as a script, the main() is used to compile all the +files named on the command line. The exit status is nonzero if one of the files +could not be compiled.

    +
    +

    See also

    +
    +
    Module compileall

    Utilities to compile all Python source files in a directory tree.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/pyclbr.html b/python-3.7.4-docs-html/library/pyclbr.html new file mode 100644 index 0000000..eeeb50a --- /dev/null +++ b/python-3.7.4-docs-html/library/pyclbr.html @@ -0,0 +1,348 @@ + + + + + + + pyclbr — Python class browser support — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    pyclbr — Python class browser support

    +

    Source code: Lib/pyclbr.py

    +
    +

    The pyclbr module provides limited information about the +functions, classes, and methods defined in a Python-coded module. The +information is sufficient to implement a module browser. The +information is extracted from the Python source code rather than by +importing the module, so this module is safe to use with untrusted code. +This restriction makes it impossible to use this module with modules not +implemented in Python, including all standard and optional extension +modules.

    +
    +
    +pyclbr.readmodule(module, path=None)
    +

    Return a dictionary mapping module-level class names to class +descriptors. If possible, descriptors for imported base classes are +included. Parameter module is a string with the name of the module +to read; it may be the name of a module within a package. If given, +path is a sequence of directory paths prepended to sys.path, +which is used to locate the module source code.

    +
    + +
    +
    +pyclbr.readmodule_ex(module, path=None)
    +

    Return a dictionary-based tree containing a function or class +descriptors for each function and class defined in the module with a +def or class statement. The returned dictionary maps +module-level function and class names to their descriptors. Nested +objects are entered into the children dictionary of their parent. As +with readmodule, module names the module to be read and path is +prepended to sys.path. If the module being read is a package, the +returned dictionary has a key '__path__' whose value is a list +containing the package search path.

    +
    + +
    +

    New in version 3.7: Descriptors for nested definitions. They are accessed through the +new children attribute. Each has a new parent attribute.

    +
    +

    The descriptors returned by these functions are instances of +Function and Class classes. Users are not expected to create instances +of these classes.

    +
    +

    Function Objects

    +

    Class Function instances describe functions defined by def +statements. They have the following attributes:

    +
    +
    +Function.file
    +

    Name of the file in which the function is defined.

    +
    + +
    +
    +Function.module
    +

    The name of the module defining the function described.

    +
    + +
    +
    +Function.name
    +

    The name of the function.

    +
    + +
    +
    +Function.lineno
    +

    The line number in the file where the definition starts.

    +
    + +
    +
    +Function.parent
    +

    For top-level functions, None. For nested functions, the parent.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +Function.children
    +

    A dictionary mapping names to descriptors for nested functions and +classes.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +

    Class Objects

    +

    Class Class instances describe classes defined by class +statements. They have the same attributes as Functions and two more.

    +
    +
    +Class.file
    +

    Name of the file in which the class is defined.

    +
    + +
    +
    +Class.module
    +

    The name of the module defining the class described.

    +
    + +
    +
    +Class.name
    +

    The name of the class.

    +
    + +
    +
    +Class.lineno
    +

    The line number in the file where the definition starts.

    +
    + +
    +
    +Class.parent
    +

    For top-level classes, None. For nested classes, the parent.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +Class.children
    +

    A dictionary mapping names to descriptors for nested functions and +classes.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +Class.super
    +

    A list of Class objects which describe the immediate base +classes of the class being described. Classes which are named as +superclasses but which are not discoverable by readmodule_ex() +are listed as a string with the class name instead of as +Class objects.

    +
    + +
    +
    +Class.methods
    +

    A dictionary mapping method names to line numbers. This can be +derived from the newer children dictionary, but remains for +back-compatibility.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/pydoc.html b/python-3.7.4-docs-html/library/pydoc.html new file mode 100644 index 0000000..89794e4 --- /dev/null +++ b/python-3.7.4-docs-html/library/pydoc.html @@ -0,0 +1,266 @@ + + + + + + + pydoc — Documentation generator and online help system — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    pydoc — Documentation generator and online help system

    +

    Source code: Lib/pydoc.py

    +
    +

    The pydoc module automatically generates documentation from Python +modules. The documentation can be presented as pages of text on the console, +served to a Web browser, or saved to HTML files.

    +

    For modules, classes, functions and methods, the displayed documentation is +derived from the docstring (i.e. the __doc__ attribute) of the object, +and recursively of its documentable members. If there is no docstring, +pydoc tries to obtain a description from the block of comment lines just +above the definition of the class, function or method in the source file, or at +the top of the module (see inspect.getcomments()).

    +

    The built-in function help() invokes the online help system in the +interactive interpreter, which uses pydoc to generate its documentation +as text on the console. The same text documentation can also be viewed from +outside the Python interpreter by running pydoc as a script at the +operating system’s command prompt. For example, running

    +
    pydoc sys
    +
    +
    +

    at a shell prompt will display documentation on the sys module, in a +style similar to the manual pages shown by the Unix man command. The +argument to pydoc can be the name of a function, module, or package, +or a dotted reference to a class, method, or function within a module or module +in a package. If the argument to pydoc looks like a path (that is, +it contains the path separator for your operating system, such as a slash in +Unix), and refers to an existing Python source file, then documentation is +produced for that file.

    +
    +

    Note

    +

    In order to find objects and their documentation, pydoc imports the +module(s) to be documented. Therefore, any code on module level will be +executed on that occasion. Use an if __name__ == '__main__': guard to +only execute code when a file is invoked as a script and not just imported.

    +
    +

    When printing output to the console, pydoc attempts to paginate the +output for easier reading. If the PAGER environment variable is set, +pydoc will use its value as a pagination program.

    +

    Specifying a -w flag before the argument will cause HTML documentation +to be written out to a file in the current directory, instead of displaying text +on the console.

    +

    Specifying a -k flag before the argument will search the synopsis +lines of all available modules for the keyword given as the argument, again in a +manner similar to the Unix man command. The synopsis line of a +module is the first line of its documentation string.

    +

    You can also use pydoc to start an HTTP server on the local machine +that will serve documentation to visiting Web browsers. pydoc -p 1234 +will start a HTTP server on port 1234, allowing you to browse the +documentation at http://localhost:1234/ in your preferred Web browser. +Specifying 0 as the port number will select an arbitrary unused port.

    +

    pydoc -n <hostname> will start the server listening at the given +hostname. By default the hostname is ‘localhost’ but if you want the server to +be reached from other machines, you may want to change the host name that the +server responds to. During development this is especially useful if you want +to run pydoc from within a container.

    +

    pydoc -b will start the server and additionally open a web +browser to a module index page. Each served page has a navigation bar at the +top where you can Get help on an individual item, Search all modules with a +keyword in their synopsis line, and go to the Module index, Topics and +Keywords pages.

    +

    When pydoc generates documentation, it uses the current environment +and path to locate modules. Thus, invoking pydoc spam +documents precisely the version of the module you would get if you started the +Python interpreter and typed import spam.

    +

    Module docs for core modules are assumed to reside in +https://docs.python.org/X.Y/library/ where X and Y are the +major and minor version numbers of the Python interpreter. This can +be overridden by setting the PYTHONDOCS environment variable +to a different URL or to a local directory containing the Library +Reference Manual pages.

    +
    +

    Changed in version 3.2: Added the -b option.

    +
    +
    +

    Changed in version 3.3: The -g command line option was removed.

    +
    +
    +

    Changed in version 3.4: pydoc now uses inspect.signature() rather than +inspect.getfullargspec() to extract signature information from +callables.

    +
    +
    +

    Changed in version 3.7: Added the -n option.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/pyexpat.html b/python-3.7.4-docs-html/library/pyexpat.html new file mode 100644 index 0000000..2dd72c6 --- /dev/null +++ b/python-3.7.4-docs-html/library/pyexpat.html @@ -0,0 +1,1103 @@ + + + + + + + xml.parsers.expat — Fast XML parsing using Expat — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    xml.parsers.expat — Fast XML parsing using Expat

    +
    +
    +

    Warning

    +

    The pyexpat module is not secure against maliciously +constructed data. If you need to parse untrusted or unauthenticated data see +XML vulnerabilities.

    +
    +

    The xml.parsers.expat module is a Python interface to the Expat +non-validating XML parser. The module provides a single extension type, +xmlparser, that represents the current state of an XML parser. After +an xmlparser object has been created, various attributes of the object +can be set to handler functions. When an XML document is then fed to the +parser, the handler functions are called for the character data and markup in +the XML document.

    +

    This module uses the pyexpat module to provide access to the Expat +parser. Direct use of the pyexpat module is deprecated.

    +

    This module provides one exception and one type object:

    +
    +
    +exception xml.parsers.expat.ExpatError
    +

    The exception raised when Expat reports an error. See section +ExpatError Exceptions for more information on interpreting Expat errors.

    +
    + +
    +
    +exception xml.parsers.expat.error
    +

    Alias for ExpatError.

    +
    + +
    +
    +xml.parsers.expat.XMLParserType
    +

    The type of the return values from the ParserCreate() function.

    +
    + +

    The xml.parsers.expat module contains two functions:

    +
    +
    +xml.parsers.expat.ErrorString(errno)
    +

    Returns an explanatory string for a given error number errno.

    +
    + +
    +
    +xml.parsers.expat.ParserCreate(encoding=None, namespace_separator=None)
    +

    Creates and returns a new xmlparser object. encoding, if specified, +must be a string naming the encoding used by the XML data. Expat doesn’t +support as many encodings as Python does, and its repertoire of encodings can’t +be extended; it supports UTF-8, UTF-16, ISO-8859-1 (Latin1), and ASCII. If +encoding 1 is given it will override the implicit or explicit encoding of the +document.

    +

    Expat can optionally do XML namespace processing for you, enabled by providing a +value for namespace_separator. The value must be a one-character string; a +ValueError will be raised if the string has an illegal length (None +is considered the same as omission). When namespace processing is enabled, +element type names and attribute names that belong to a namespace will be +expanded. The element name passed to the element handlers +StartElementHandler and EndElementHandler will be the +concatenation of the namespace URI, the namespace separator character, and the +local part of the name. If the namespace separator is a zero byte (chr(0)) +then the namespace URI and the local part will be concatenated without any +separator.

    +

    For example, if namespace_separator is set to a space character (' ') and +the following document is parsed:

    +
    <?xml version="1.0"?>
    +<root xmlns    = "http://default-namespace.org/"
    +      xmlns:py = "http://www.python.org/ns/">
    +  <py:elem1 />
    +  <elem2 xmlns="" />
    +</root>
    +
    +
    +

    StartElementHandler will receive the following strings for each +element:

    +
    http://default-namespace.org/ root
    +http://www.python.org/ns/ elem1
    +elem2
    +
    +
    +

    Due to limitations in the Expat library used by pyexpat, +the xmlparser instance returned can only be used to parse a single +XML document. Call ParserCreate for each document to provide unique +parser instances.

    +
    + +
    +

    See also

    +
    +
    The Expat XML Parser

    Home page of the Expat project.

    +
    +
    +
    +
    +

    XMLParser Objects

    +

    xmlparser objects have the following methods:

    +
    +
    +xmlparser.Parse(data[, isfinal])
    +

    Parses the contents of the string data, calling the appropriate handler +functions to process the parsed data. isfinal must be true on the final call +to this method; it allows the parsing of a single file in fragments, +not the submission of multiple files. +data can be the empty string at any time.

    +
    + +
    +
    +xmlparser.ParseFile(file)
    +

    Parse XML data reading from the object file. file only needs to provide +the read(nbytes) method, returning the empty string when there’s no more +data.

    +
    + +
    +
    +xmlparser.SetBase(base)
    +

    Sets the base to be used for resolving relative URIs in system identifiers in +declarations. Resolving relative identifiers is left to the application: this +value will be passed through as the base argument to the +ExternalEntityRefHandler(), NotationDeclHandler(), and +UnparsedEntityDeclHandler() functions.

    +
    + +
    +
    +xmlparser.GetBase()
    +

    Returns a string containing the base set by a previous call to SetBase(), +or None if SetBase() hasn’t been called.

    +
    + +
    +
    +xmlparser.GetInputContext()
    +

    Returns the input data that generated the current event as a string. The data is +in the encoding of the entity which contains the text. When called while an +event handler is not active, the return value is None.

    +
    + +
    +
    +xmlparser.ExternalEntityParserCreate(context[, encoding])
    +

    Create a “child” parser which can be used to parse an external parsed entity +referred to by content parsed by the parent parser. The context parameter +should be the string passed to the ExternalEntityRefHandler() handler +function, described below. The child parser is created with the +ordered_attributes and specified_attributes set to the values of +this parser.

    +
    + +
    +
    +xmlparser.SetParamEntityParsing(flag)
    +

    Control parsing of parameter entities (including the external DTD subset). +Possible flag values are XML_PARAM_ENTITY_PARSING_NEVER, +XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE and +XML_PARAM_ENTITY_PARSING_ALWAYS. Return true if setting the flag +was successful.

    +
    + +
    +
    +xmlparser.UseForeignDTD([flag])
    +

    Calling this with a true value for flag (the default) will cause Expat to call +the ExternalEntityRefHandler with None for all arguments to +allow an alternate DTD to be loaded. If the document does not contain a +document type declaration, the ExternalEntityRefHandler will still be +called, but the StartDoctypeDeclHandler and +EndDoctypeDeclHandler will not be called.

    +

    Passing a false value for flag will cancel a previous call that passed a true +value, but otherwise has no effect.

    +

    This method can only be called before the Parse() or ParseFile() +methods are called; calling it after either of those have been called causes +ExpatError to be raised with the code attribute set to +errors.codes[errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING].

    +
    + +

    xmlparser objects have the following attributes:

    +
    +
    +xmlparser.buffer_size
    +

    The size of the buffer used when buffer_text is true. +A new buffer size can be set by assigning a new integer value +to this attribute. +When the size is changed, the buffer will be flushed.

    +
    + +
    +
    +xmlparser.buffer_text
    +

    Setting this to true causes the xmlparser object to buffer textual +content returned by Expat to avoid multiple calls to the +CharacterDataHandler() callback whenever possible. This can improve +performance substantially since Expat normally breaks character data into chunks +at every line ending. This attribute is false by default, and may be changed at +any time.

    +
    + +
    +
    +xmlparser.buffer_used
    +

    If buffer_text is enabled, the number of bytes stored in the buffer. +These bytes represent UTF-8 encoded text. This attribute has no meaningful +interpretation when buffer_text is false.

    +
    + +
    +
    +xmlparser.ordered_attributes
    +

    Setting this attribute to a non-zero integer causes the attributes to be +reported as a list rather than a dictionary. The attributes are presented in +the order found in the document text. For each attribute, two list entries are +presented: the attribute name and the attribute value. (Older versions of this +module also used this format.) By default, this attribute is false; it may be +changed at any time.

    +
    + +
    +
    +xmlparser.specified_attributes
    +

    If set to a non-zero integer, the parser will report only those attributes which +were specified in the document instance and not those which were derived from +attribute declarations. Applications which set this need to be especially +careful to use what additional information is available from the declarations as +needed to comply with the standards for the behavior of XML processors. By +default, this attribute is false; it may be changed at any time.

    +
    + +

    The following attributes contain values relating to the most recent error +encountered by an xmlparser object, and will only have correct values +once a call to Parse() or ParseFile() has raised an +xml.parsers.expat.ExpatError exception.

    +
    +
    +xmlparser.ErrorByteIndex
    +

    Byte index at which an error occurred.

    +
    + +
    +
    +xmlparser.ErrorCode
    +

    Numeric code specifying the problem. This value can be passed to the +ErrorString() function, or compared to one of the constants defined in the +errors object.

    +
    + +
    +
    +xmlparser.ErrorColumnNumber
    +

    Column number at which an error occurred.

    +
    + +
    +
    +xmlparser.ErrorLineNumber
    +

    Line number at which an error occurred.

    +
    + +

    The following attributes contain values relating to the current parse location +in an xmlparser object. During a callback reporting a parse event they +indicate the location of the first of the sequence of characters that generated +the event. When called outside of a callback, the position indicated will be +just past the last parse event (regardless of whether there was an associated +callback).

    +
    +
    +xmlparser.CurrentByteIndex
    +

    Current byte index in the parser input.

    +
    + +
    +
    +xmlparser.CurrentColumnNumber
    +

    Current column number in the parser input.

    +
    + +
    +
    +xmlparser.CurrentLineNumber
    +

    Current line number in the parser input.

    +
    + +

    Here is the list of handlers that can be set. To set a handler on an +xmlparser object o, use o.handlername = func. handlername must +be taken from the following list, and func must be a callable object accepting +the correct number of arguments. The arguments are all strings, unless +otherwise stated.

    +
    +
    +xmlparser.XmlDeclHandler(version, encoding, standalone)
    +

    Called when the XML declaration is parsed. The XML declaration is the +(optional) declaration of the applicable version of the XML recommendation, the +encoding of the document text, and an optional “standalone” declaration. +version and encoding will be strings, and standalone will be 1 if the +document is declared standalone, 0 if it is declared not to be standalone, +or -1 if the standalone clause was omitted. This is only available with +Expat version 1.95.0 or newer.

    +
    + +
    +
    +xmlparser.StartDoctypeDeclHandler(doctypeName, systemId, publicId, has_internal_subset)
    +

    Called when Expat begins parsing the document type declaration (<!DOCTYPE +...). The doctypeName is provided exactly as presented. The systemId and +publicId parameters give the system and public identifiers if specified, or +None if omitted. has_internal_subset will be true if the document +contains and internal document declaration subset. This requires Expat version +1.2 or newer.

    +
    + +
    +
    +xmlparser.EndDoctypeDeclHandler()
    +

    Called when Expat is done parsing the document type declaration. This requires +Expat version 1.2 or newer.

    +
    + +
    +
    +xmlparser.ElementDeclHandler(name, model)
    +

    Called once for each element type declaration. name is the name of the +element type, and model is a representation of the content model.

    +
    + +
    +
    +xmlparser.AttlistDeclHandler(elname, attname, type, default, required)
    +

    Called for each declared attribute for an element type. If an attribute list +declaration declares three attributes, this handler is called three times, once +for each attribute. elname is the name of the element to which the +declaration applies and attname is the name of the attribute declared. The +attribute type is a string passed as type; the possible values are +'CDATA', 'ID', 'IDREF', … default gives the default value for +the attribute used when the attribute is not specified by the document instance, +or None if there is no default value (#IMPLIED values). If the +attribute is required to be given in the document instance, required will be +true. This requires Expat version 1.95.0 or newer.

    +
    + +
    +
    +xmlparser.StartElementHandler(name, attributes)
    +

    Called for the start of every element. name is a string containing the +element name, and attributes is the element attributes. If +ordered_attributes is true, this is a list (see +ordered_attributes for a full description). Otherwise it’s a +dictionary mapping names to values.

    +
    + +
    +
    +xmlparser.EndElementHandler(name)
    +

    Called for the end of every element.

    +
    + +
    +
    +xmlparser.ProcessingInstructionHandler(target, data)
    +

    Called for every processing instruction.

    +
    + +
    +
    +xmlparser.CharacterDataHandler(data)
    +

    Called for character data. This will be called for normal character data, CDATA +marked content, and ignorable whitespace. Applications which must distinguish +these cases can use the StartCdataSectionHandler, +EndCdataSectionHandler, and ElementDeclHandler callbacks to +collect the required information.

    +
    + +
    +
    +xmlparser.UnparsedEntityDeclHandler(entityName, base, systemId, publicId, notationName)
    +

    Called for unparsed (NDATA) entity declarations. This is only present for +version 1.2 of the Expat library; for more recent versions, use +EntityDeclHandler instead. (The underlying function in the Expat +library has been declared obsolete.)

    +
    + +
    +
    +xmlparser.EntityDeclHandler(entityName, is_parameter_entity, value, base, systemId, publicId, notationName)
    +

    Called for all entity declarations. For parameter and internal entities, +value will be a string giving the declared contents of the entity; this will +be None for external entities. The notationName parameter will be +None for parsed entities, and the name of the notation for unparsed +entities. is_parameter_entity will be true if the entity is a parameter entity +or false for general entities (most applications only need to be concerned with +general entities). This is only available starting with version 1.95.0 of the +Expat library.

    +
    + +
    +
    +xmlparser.NotationDeclHandler(notationName, base, systemId, publicId)
    +

    Called for notation declarations. notationName, base, and systemId, and +publicId are strings if given. If the public identifier is omitted, +publicId will be None.

    +
    + +
    +
    +xmlparser.StartNamespaceDeclHandler(prefix, uri)
    +

    Called when an element contains a namespace declaration. Namespace declarations +are processed before the StartElementHandler is called for the element +on which declarations are placed.

    +
    + +
    +
    +xmlparser.EndNamespaceDeclHandler(prefix)
    +

    Called when the closing tag is reached for an element that contained a +namespace declaration. This is called once for each namespace declaration on +the element in the reverse of the order for which the +StartNamespaceDeclHandler was called to indicate the start of each +namespace declaration’s scope. Calls to this handler are made after the +corresponding EndElementHandler for the end of the element.

    +
    + +
    +
    +xmlparser.CommentHandler(data)
    +

    Called for comments. data is the text of the comment, excluding the leading +'<!--' and trailing '-->'.

    +
    + +
    +
    +xmlparser.StartCdataSectionHandler()
    +

    Called at the start of a CDATA section. This and EndCdataSectionHandler +are needed to be able to identify the syntactical start and end for CDATA +sections.

    +
    + +
    +
    +xmlparser.EndCdataSectionHandler()
    +

    Called at the end of a CDATA section.

    +
    + +
    +
    +xmlparser.DefaultHandler(data)
    +

    Called for any characters in the XML document for which no applicable handler +has been specified. This means characters that are part of a construct which +could be reported, but for which no handler has been supplied.

    +
    + +
    +
    +xmlparser.DefaultHandlerExpand(data)
    +

    This is the same as the DefaultHandler(), but doesn’t inhibit expansion +of internal entities. The entity reference will not be passed to the default +handler.

    +
    + +
    +
    +xmlparser.NotStandaloneHandler()
    +

    Called if the XML document hasn’t been declared as being a standalone document. +This happens when there is an external subset or a reference to a parameter +entity, but the XML declaration does not set standalone to yes in an XML +declaration. If this handler returns 0, then the parser will raise an +XML_ERROR_NOT_STANDALONE error. If this handler is not set, no +exception is raised by the parser for this condition.

    +
    + +
    +
    +xmlparser.ExternalEntityRefHandler(context, base, systemId, publicId)
    +

    Called for references to external entities. base is the current base, as set +by a previous call to SetBase(). The public and system identifiers, +systemId and publicId, are strings if given; if the public identifier is not +given, publicId will be None. The context value is opaque and should +only be used as described below.

    +

    For external entities to be parsed, this handler must be implemented. It is +responsible for creating the sub-parser using +ExternalEntityParserCreate(context), initializing it with the appropriate +callbacks, and parsing the entity. This handler should return an integer; if it +returns 0, the parser will raise an +XML_ERROR_EXTERNAL_ENTITY_HANDLING error, otherwise parsing will +continue.

    +

    If this handler is not provided, external entities are reported by the +DefaultHandler callback, if provided.

    +
    + +
    +
    +

    ExpatError Exceptions

    +

    ExpatError exceptions have a number of interesting attributes:

    +
    +
    +ExpatError.code
    +

    Expat’s internal error number for the specific error. The +errors.messages dictionary maps +these error numbers to Expat’s error messages. For example:

    +
    from xml.parsers.expat import ParserCreate, ExpatError, errors
    +
    +p = ParserCreate()
    +try:
    +    p.Parse(some_xml_document)
    +except ExpatError as err:
    +    print("Error:", errors.messages[err.code])
    +
    +
    +

    The errors module also provides error message +constants and a dictionary codes mapping +these messages back to the error codes, see below.

    +
    + +
    +
    +ExpatError.lineno
    +

    Line number on which the error was detected. The first line is numbered 1.

    +
    + +
    +
    +ExpatError.offset
    +

    Character offset into the line where the error occurred. The first column is +numbered 0.

    +
    + +
    +
    +

    Example

    +

    The following program defines three handlers that just print out their +arguments.

    +
    import xml.parsers.expat
    +
    +# 3 handler functions
    +def start_element(name, attrs):
    +    print('Start element:', name, attrs)
    +def end_element(name):
    +    print('End element:', name)
    +def char_data(data):
    +    print('Character data:', repr(data))
    +
    +p = xml.parsers.expat.ParserCreate()
    +
    +p.StartElementHandler = start_element
    +p.EndElementHandler = end_element
    +p.CharacterDataHandler = char_data
    +
    +p.Parse("""<?xml version="1.0"?>
    +<parent id="top"><child1 name="paul">Text goes here</child1>
    +<child2 name="fred">More text</child2>
    +</parent>""", 1)
    +
    +
    +

    The output from this program is:

    +
    Start element: parent {'id': 'top'}
    +Start element: child1 {'name': 'paul'}
    +Character data: 'Text goes here'
    +End element: child1
    +Character data: '\n'
    +Start element: child2 {'name': 'fred'}
    +Character data: 'More text'
    +End element: child2
    +Character data: '\n'
    +End element: parent
    +
    +
    +
    +
    +

    Content Model Descriptions

    +

    Content models are described using nested tuples. Each tuple contains four +values: the type, the quantifier, the name, and a tuple of children. Children +are simply additional content model descriptions.

    +

    The values of the first two fields are constants defined in the +xml.parsers.expat.model module. These constants can be collected in two +groups: the model type group and the quantifier group.

    +

    The constants in the model type group are:

    +
    +
    +xml.parsers.expat.model.XML_CTYPE_ANY
    +

    The element named by the model name was declared to have a content model of +ANY.

    +
    + +
    +
    +xml.parsers.expat.model.XML_CTYPE_CHOICE
    +

    The named element allows a choice from a number of options; this is used for +content models such as (A | B | C).

    +
    + +
    +
    +xml.parsers.expat.model.XML_CTYPE_EMPTY
    +

    Elements which are declared to be EMPTY have this model type.

    +
    + +
    +
    +xml.parsers.expat.model.XML_CTYPE_MIXED
    +
    + +
    +
    +xml.parsers.expat.model.XML_CTYPE_NAME
    +
    + +
    +
    +xml.parsers.expat.model.XML_CTYPE_SEQ
    +

    Models which represent a series of models which follow one after the other are +indicated with this model type. This is used for models such as (A, B, C).

    +
    + +

    The constants in the quantifier group are:

    +
    +
    +xml.parsers.expat.model.XML_CQUANT_NONE
    +

    No modifier is given, so it can appear exactly once, as for A.

    +
    + +
    +
    +xml.parsers.expat.model.XML_CQUANT_OPT
    +

    The model is optional: it can appear once or not at all, as for A?.

    +
    + +
    +
    +xml.parsers.expat.model.XML_CQUANT_PLUS
    +

    The model must occur one or more times (like A+).

    +
    + +
    +
    +xml.parsers.expat.model.XML_CQUANT_REP
    +

    The model must occur zero or more times, as for A*.

    +
    + +
    +
    +

    Expat error constants

    +

    The following constants are provided in the xml.parsers.expat.errors +module. These constants are useful in interpreting some of the attributes of +the ExpatError exception objects raised when an error has occurred. +Since for backwards compatibility reasons, the constants’ value is the error +message and not the numeric error code, you do this by comparing its +code attribute with +errors.codes[errors.XML_ERROR_CONSTANT_NAME].

    +

    The errors module has the following attributes:

    +
    +
    +xml.parsers.expat.errors.codes
    +

    A dictionary mapping numeric error codes to their string descriptions.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +xml.parsers.expat.errors.messages
    +

    A dictionary mapping string descriptions to their error codes.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_ASYNC_ENTITY
    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF
    +

    An entity reference in an attribute value referred to an external entity instead +of an internal entity.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_BAD_CHAR_REF
    +

    A character reference referred to a character which is illegal in XML (for +example, character 0, or ‘&#0;’).

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_BINARY_ENTITY_REF
    +

    An entity reference referred to an entity which was declared with a notation, so +cannot be parsed.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_DUPLICATE_ATTRIBUTE
    +

    An attribute was used more than once in a start tag.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_INCORRECT_ENCODING
    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_INVALID_TOKEN
    +

    Raised when an input byte could not properly be assigned to a character; for +example, a NUL byte (value 0) in a UTF-8 input stream.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_JUNK_AFTER_DOC_ELEMENT
    +

    Something other than whitespace occurred after the document element.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_MISPLACED_XML_PI
    +

    An XML declaration was found somewhere other than the start of the input data.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_NO_ELEMENTS
    +

    The document contains no elements (XML requires all documents to contain exactly +one top-level element)..

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_NO_MEMORY
    +

    Expat was not able to allocate memory internally.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_PARAM_ENTITY_REF
    +

    A parameter entity reference was found where it was not allowed.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_PARTIAL_CHAR
    +

    An incomplete character was found in the input.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_RECURSIVE_ENTITY_REF
    +

    An entity reference contained another reference to the same entity; possibly via +a different name, and possibly indirectly.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_SYNTAX
    +

    Some unspecified syntax error was encountered.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_TAG_MISMATCH
    +

    An end tag did not match the innermost open start tag.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_UNCLOSED_TOKEN
    +

    Some token (such as a start tag) was not closed before the end of the stream or +the next token was encountered.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_UNDEFINED_ENTITY
    +

    A reference was made to an entity which was not defined.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_UNKNOWN_ENCODING
    +

    The document encoding is not supported by Expat.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_UNCLOSED_CDATA_SECTION
    +

    A CDATA marked section was not closed.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_EXTERNAL_ENTITY_HANDLING
    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_NOT_STANDALONE
    +

    The parser determined that the document was not “standalone” though it declared +itself to be in the XML declaration, and the NotStandaloneHandler was +set and returned 0.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_UNEXPECTED_STATE
    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_ENTITY_DECLARED_IN_PE
    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_FEATURE_REQUIRES_XML_DTD
    +

    An operation was requested that requires DTD support to be compiled in, but +Expat was configured without DTD support. This should never be reported by a +standard build of the xml.parsers.expat module.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING
    +

    A behavioral change was requested after parsing started that can only be changed +before parsing has started. This is (currently) only raised by +UseForeignDTD().

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_UNBOUND_PREFIX
    +

    An undeclared prefix was found when namespace processing was enabled.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_UNDECLARING_PREFIX
    +

    The document attempted to remove the namespace declaration associated with a +prefix.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_INCOMPLETE_PE
    +

    A parameter entity contained incomplete markup.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_XML_DECL
    +

    The document contained no document element at all.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_TEXT_DECL
    +

    There was an error parsing a text declaration in an external entity.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_PUBLICID
    +

    Characters were found in the public id that are not allowed.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_SUSPENDED
    +

    The requested operation was made on a suspended parser, but isn’t allowed. This +includes attempts to provide additional input or to stop the parser.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_NOT_SUSPENDED
    +

    An attempt to resume the parser was made when the parser had not been suspended.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_ABORTED
    +

    This should not be reported to Python applications.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_FINISHED
    +

    The requested operation was made on a parser which was finished parsing input, +but isn’t allowed. This includes attempts to provide additional input or to +stop the parser.

    +
    + +
    +
    +xml.parsers.expat.errors.XML_ERROR_SUSPEND_PE
    +
    + +

    Footnotes

    +
    +
    1
    +

    The encoding string included in XML output should conform to the +appropriate standards. For example, “UTF-8” is valid, but “UTF8” is +not. See https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl +and https://www.iana.org/assignments/character-sets/character-sets.xhtml.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/python.html b/python-3.7.4-docs-html/library/python.html new file mode 100644 index 0000000..f918404 --- /dev/null +++ b/python-3.7.4-docs-html/library/python.html @@ -0,0 +1,273 @@ + + + + + + + Python Runtime Services — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Python Runtime Services

    +

    The modules described in this chapter provide a wide range of services related +to the Python interpreter and its interaction with its environment. Here’s an +overview:

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/queue.html b/python-3.7.4-docs-html/library/queue.html new file mode 100644 index 0000000..732a719 --- /dev/null +++ b/python-3.7.4-docs-html/library/queue.html @@ -0,0 +1,478 @@ + + + + + + + queue — A synchronized queue class — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    queue — A synchronized queue class

    +

    Source code: Lib/queue.py

    +
    +

    The queue module implements multi-producer, multi-consumer queues. +It is especially useful in threaded programming when information must be +exchanged safely between multiple threads. The Queue class in this +module implements all the required locking semantics. It depends on the +availability of thread support in Python; see the threading +module.

    +

    The module implements three types of queue, which differ only in the order in +which the entries are retrieved. In a FIFO +queue, the first tasks added are the first retrieved. In a +LIFO queue, the most recently added entry is +the first retrieved (operating like a stack). With a priority queue, +the entries are kept sorted (using the heapq module) and the +lowest valued entry is retrieved first.

    +

    Internally, those three types of queues use locks to temporarily block +competing threads; however, they are not designed to handle reentrancy +within a thread.

    +

    In addition, the module implements a “simple” +FIFO queue type, SimpleQueue, whose +specific implementation provides additional guarantees +in exchange for the smaller functionality.

    +

    The queue module defines the following classes and exceptions:

    +
    +
    +class queue.Queue(maxsize=0)
    +

    Constructor for a FIFO queue. maxsize is +an integer that sets the upperbound +limit on the number of items that can be placed in the queue. Insertion will +block once this size has been reached, until queue items are consumed. If +maxsize is less than or equal to zero, the queue size is infinite.

    +
    + +
    +
    +class queue.LifoQueue(maxsize=0)
    +

    Constructor for a LIFO queue. maxsize is +an integer that sets the upperbound +limit on the number of items that can be placed in the queue. Insertion will +block once this size has been reached, until queue items are consumed. If +maxsize is less than or equal to zero, the queue size is infinite.

    +
    + +
    +
    +class queue.PriorityQueue(maxsize=0)
    +

    Constructor for a priority queue. maxsize is an integer that sets the upperbound +limit on the number of items that can be placed in the queue. Insertion will +block once this size has been reached, until queue items are consumed. If +maxsize is less than or equal to zero, the queue size is infinite.

    +

    The lowest valued entries are retrieved first (the lowest valued entry is the +one returned by sorted(list(entries))[0]). A typical pattern for entries +is a tuple in the form: (priority_number, data).

    +

    If the data elements are not comparable, the data can be wrapped in a class +that ignores the data item and only compares the priority number:

    +
    from dataclasses import dataclass, field
    +from typing import Any
    +
    +@dataclass(order=True)
    +class PrioritizedItem:
    +    priority: int
    +    item: Any=field(compare=False)
    +
    +
    +
    + +
    +
    +class queue.SimpleQueue
    +

    Constructor for an unbounded FIFO queue. +Simple queues lack advanced functionality such as task tracking.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +exception queue.Empty
    +

    Exception raised when non-blocking get() (or +get_nowait()) is called +on a Queue object which is empty.

    +
    + +
    +
    +exception queue.Full
    +

    Exception raised when non-blocking put() (or +put_nowait()) is called +on a Queue object which is full.

    +
    + +
    +

    Queue Objects

    +

    Queue objects (Queue, LifoQueue, or PriorityQueue) +provide the public methods described below.

    +
    +
    +Queue.qsize()
    +

    Return the approximate size of the queue. Note, qsize() > 0 doesn’t +guarantee that a subsequent get() will not block, nor will qsize() < maxsize +guarantee that put() will not block.

    +
    + +
    +
    +Queue.empty()
    +

    Return True if the queue is empty, False otherwise. If empty() +returns True it doesn’t guarantee that a subsequent call to put() +will not block. Similarly, if empty() returns False it doesn’t +guarantee that a subsequent call to get() will not block.

    +
    + +
    +
    +Queue.full()
    +

    Return True if the queue is full, False otherwise. If full() +returns True it doesn’t guarantee that a subsequent call to get() +will not block. Similarly, if full() returns False it doesn’t +guarantee that a subsequent call to put() will not block.

    +
    + +
    +
    +Queue.put(item, block=True, timeout=None)
    +

    Put item into the queue. If optional args block is true and timeout is +None (the default), block if necessary until a free slot is available. If +timeout is a positive number, it blocks at most timeout seconds and raises +the Full exception if no free slot was available within that time. +Otherwise (block is false), put an item on the queue if a free slot is +immediately available, else raise the Full exception (timeout is +ignored in that case).

    +
    + +
    +
    +Queue.put_nowait(item)
    +

    Equivalent to put(item, False).

    +
    + +
    +
    +Queue.get(block=True, timeout=None)
    +

    Remove and return an item from the queue. If optional args block is true and +timeout is None (the default), block if necessary until an item is available. +If timeout is a positive number, it blocks at most timeout seconds and +raises the Empty exception if no item was available within that time. +Otherwise (block is false), return an item if one is immediately available, +else raise the Empty exception (timeout is ignored in that case).

    +

    Prior to 3.0 on POSIX systems, and for all versions on Windows, if +block is true and timeout is None, this operation goes into +an uninterruptible wait on an underlying lock. This means that no exceptions +can occur, and in particular a SIGINT will not trigger a KeyboardInterrupt.

    +
    + +
    +
    +Queue.get_nowait()
    +

    Equivalent to get(False).

    +
    + +

    Two methods are offered to support tracking whether enqueued tasks have been +fully processed by daemon consumer threads.

    +
    +
    +Queue.task_done()
    +

    Indicate that a formerly enqueued task is complete. Used by queue consumer +threads. For each get() used to fetch a task, a subsequent call to +task_done() tells the queue that the processing on the task is complete.

    +

    If a join() is currently blocking, it will resume when all items have been +processed (meaning that a task_done() call was received for every item +that had been put() into the queue).

    +

    Raises a ValueError if called more times than there were items placed in +the queue.

    +
    + +
    +
    +Queue.join()
    +

    Blocks until all items in the queue have been gotten and processed.

    +

    The count of unfinished tasks goes up whenever an item is added to the queue. +The count goes down whenever a consumer thread calls task_done() to +indicate that the item was retrieved and all work on it is complete. When the +count of unfinished tasks drops to zero, join() unblocks.

    +
    + +

    Example of how to wait for enqueued tasks to be completed:

    +
    def worker():
    +    while True:
    +        item = q.get()
    +        if item is None:
    +            break
    +        do_work(item)
    +        q.task_done()
    +
    +q = queue.Queue()
    +threads = []
    +for i in range(num_worker_threads):
    +    t = threading.Thread(target=worker)
    +    t.start()
    +    threads.append(t)
    +
    +for item in source():
    +    q.put(item)
    +
    +# block until all tasks are done
    +q.join()
    +
    +# stop workers
    +for i in range(num_worker_threads):
    +    q.put(None)
    +for t in threads:
    +    t.join()
    +
    +
    +
    +
    +

    SimpleQueue Objects

    +

    SimpleQueue objects provide the public methods described below.

    +
    +
    +SimpleQueue.qsize()
    +

    Return the approximate size of the queue. Note, qsize() > 0 doesn’t +guarantee that a subsequent get() will not block.

    +
    + +
    +
    +SimpleQueue.empty()
    +

    Return True if the queue is empty, False otherwise. If empty() +returns False it doesn’t guarantee that a subsequent call to get() +will not block.

    +
    + +
    +
    +SimpleQueue.put(item, block=True, timeout=None)
    +

    Put item into the queue. The method never blocks and always succeeds +(except for potential low-level errors such as failure to allocate memory). +The optional args block and timeout are ignored and only provided +for compatibility with Queue.put().

    +
    +

    CPython implementation detail: This method has a C implementation which is reentrant. That is, a +put() or get() call can be interrupted by another put() +call in the same thread without deadlocking or corrupting internal +state inside the queue. This makes it appropriate for use in +destructors such as __del__ methods or weakref callbacks.

    +
    +
    + +
    +
    +SimpleQueue.put_nowait(item)
    +

    Equivalent to put(item), provided for compatibility with +Queue.put_nowait().

    +
    + +
    +
    +SimpleQueue.get(block=True, timeout=None)
    +

    Remove and return an item from the queue. If optional args block is true and +timeout is None (the default), block if necessary until an item is available. +If timeout is a positive number, it blocks at most timeout seconds and +raises the Empty exception if no item was available within that time. +Otherwise (block is false), return an item if one is immediately available, +else raise the Empty exception (timeout is ignored in that case).

    +
    + +
    +
    +SimpleQueue.get_nowait()
    +

    Equivalent to get(False).

    +
    + +
    +

    See also

    +
    +
    Class multiprocessing.Queue

    A queue class for use in a multi-processing (rather than multi-threading) +context.

    +
    +
    +

    collections.deque is an alternative implementation of unbounded +queues with fast atomic append() and +popleft() operations that do not require locking.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/quopri.html b/python-3.7.4-docs-html/library/quopri.html new file mode 100644 index 0000000..5a91060 --- /dev/null +++ b/python-3.7.4-docs-html/library/quopri.html @@ -0,0 +1,238 @@ + + + + + + + quopri — Encode and decode MIME quoted-printable data — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    quopri — Encode and decode MIME quoted-printable data

    +

    Source code: Lib/quopri.py

    +
    +

    This module performs quoted-printable transport encoding and decoding, as +defined in RFC 1521: “MIME (Multipurpose Internet Mail Extensions) Part One: +Mechanisms for Specifying and Describing the Format of Internet Message Bodies”. +The quoted-printable encoding is designed for data where there are relatively +few nonprintable characters; the base64 encoding scheme available via the +base64 module is more compact if there are many such characters, as when +sending a graphics file.

    +
    +
    +quopri.decode(input, output, header=False)
    +

    Decode the contents of the input file and write the resulting decoded binary +data to the output file. input and output must be binary file objects. If the optional argument header is present and true, underscore +will be decoded as space. This is used to decode “Q”-encoded headers as +described in RFC 1522: “MIME (Multipurpose Internet Mail Extensions) +Part Two: Message Header Extensions for Non-ASCII Text”.

    +
    + +
    +
    +quopri.encode(input, output, quotetabs, header=False)
    +

    Encode the contents of the input file and write the resulting quoted-printable +data to the output file. input and output must be +binary file objects. quotetabs, a +non-optional flag which controls whether to encode embedded spaces +and tabs; when true it encodes such embedded whitespace, and when +false it leaves them unencoded. +Note that spaces and tabs appearing at the end of lines are always encoded, +as per RFC 1521. header is a flag which controls if spaces are encoded +as underscores as per RFC 1522.

    +
    + +
    +
    +quopri.decodestring(s, header=False)
    +

    Like decode(), except that it accepts a source bytes and +returns the corresponding decoded bytes.

    +
    + +
    +
    +quopri.encodestring(s, quotetabs=False, header=False)
    +

    Like encode(), except that it accepts a source bytes and +returns the corresponding encoded bytes. By default, it sends a +False value to quotetabs parameter of the encode() function.

    +
    + +
    +

    See also

    +
    +
    Module base64

    Encode and decode MIME base64 data

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/random.html b/python-3.7.4-docs-html/library/random.html new file mode 100644 index 0000000..a13f389 --- /dev/null +++ b/python-3.7.4-docs-html/library/random.html @@ -0,0 +1,675 @@ + + + + + + + random — Generate pseudo-random numbers — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    random — Generate pseudo-random numbers

    +

    Source code: Lib/random.py

    +
    +

    This module implements pseudo-random number generators for various +distributions.

    +

    For integers, there is uniform selection from a range. For sequences, there is +uniform selection of a random element, a function to generate a random +permutation of a list in-place, and a function for random sampling without +replacement.

    +

    On the real line, there are functions to compute uniform, normal (Gaussian), +lognormal, negative exponential, gamma, and beta distributions. For generating +distributions of angles, the von Mises distribution is available.

    +

    Almost all module functions depend on the basic function random(), which +generates a random float uniformly in the semi-open range [0.0, 1.0). Python +uses the Mersenne Twister as the core generator. It produces 53-bit precision +floats and has a period of 2**19937-1. The underlying implementation in C is +both fast and threadsafe. The Mersenne Twister is one of the most extensively +tested random number generators in existence. However, being completely +deterministic, it is not suitable for all purposes, and is completely unsuitable +for cryptographic purposes.

    +

    The functions supplied by this module are actually bound methods of a hidden +instance of the random.Random class. You can instantiate your own +instances of Random to get generators that don’t share state.

    +

    Class Random can also be subclassed if you want to use a different +basic generator of your own devising: in that case, override the random(), +seed(), getstate(), and setstate() methods. +Optionally, a new generator can supply a getrandbits() method — this +allows randrange() to produce selections over an arbitrarily large range.

    +

    The random module also provides the SystemRandom class which +uses the system function os.urandom() to generate random numbers +from sources provided by the operating system.

    +
    +

    Warning

    +

    The pseudo-random generators of this module should not be used for +security purposes. For security or cryptographic uses, see the +secrets module.

    +
    +
    +

    See also

    +

    M. Matsumoto and T. Nishimura, “Mersenne Twister: A 623-dimensionally +equidistributed uniform pseudorandom number generator”, ACM Transactions on +Modeling and Computer Simulation Vol. 8, No. 1, January pp.3–30 1998.

    +

    Complementary-Multiply-with-Carry recipe for a compatible alternative +random number generator with a long period and comparatively simple update +operations.

    +
    +
    +

    Bookkeeping functions

    +
    +
    +random.seed(a=None, version=2)
    +

    Initialize the random number generator.

    +

    If a is omitted or None, the current system time is used. If +randomness sources are provided by the operating system, they are used +instead of the system time (see the os.urandom() function for details +on availability).

    +

    If a is an int, it is used directly.

    +

    With version 2 (the default), a str, bytes, or bytearray +object gets converted to an int and all of its bits are used.

    +

    With version 1 (provided for reproducing random sequences from older versions +of Python), the algorithm for str and bytes generates a +narrower range of seeds.

    +
    +

    Changed in version 3.2: Moved to the version 2 scheme which uses all of the bits in a string seed.

    +
    +
    + +
    +
    +random.getstate()
    +

    Return an object capturing the current internal state of the generator. This +object can be passed to setstate() to restore the state.

    +
    + +
    +
    +random.setstate(state)
    +

    state should have been obtained from a previous call to getstate(), and +setstate() restores the internal state of the generator to what it was at +the time getstate() was called.

    +
    + +
    +
    +random.getrandbits(k)
    +

    Returns a Python integer with k random bits. This method is supplied with +the MersenneTwister generator and some other generators may also provide it +as an optional part of the API. When available, getrandbits() enables +randrange() to handle arbitrarily large ranges.

    +
    + +
    +
    +

    Functions for integers

    +
    +
    +random.randrange(stop)
    +
    +random.randrange(start, stop[, step])
    +

    Return a randomly selected element from range(start, stop, step). This is +equivalent to choice(range(start, stop, step)), but doesn’t actually build a +range object.

    +

    The positional argument pattern matches that of range(). Keyword arguments +should not be used because the function may use them in unexpected ways.

    +
    +

    Changed in version 3.2: randrange() is more sophisticated about producing equally distributed +values. Formerly it used a style like int(random()*n) which could produce +slightly uneven distributions.

    +
    +
    + +
    +
    +random.randint(a, b)
    +

    Return a random integer N such that a <= N <= b. Alias for +randrange(a, b+1).

    +
    + +
    +
    +

    Functions for sequences

    +
    +
    +random.choice(seq)
    +

    Return a random element from the non-empty sequence seq. If seq is empty, +raises IndexError.

    +
    + +
    +
    +random.choices(population, weights=None, *, cum_weights=None, k=1)
    +

    Return a k sized list of elements chosen from the population with replacement. +If the population is empty, raises IndexError.

    +

    If a weights sequence is specified, selections are made according to the +relative weights. Alternatively, if a cum_weights sequence is given, the +selections are made according to the cumulative weights (perhaps computed +using itertools.accumulate()). For example, the relative weights +[10, 5, 30, 5] are equivalent to the cumulative weights +[10, 15, 45, 50]. Internally, the relative weights are converted to +cumulative weights before making selections, so supplying the cumulative +weights saves work.

    +

    If neither weights nor cum_weights are specified, selections are made +with equal probability. If a weights sequence is supplied, it must be +the same length as the population sequence. It is a TypeError +to specify both weights and cum_weights.

    +

    The weights or cum_weights can use any numeric type that interoperates +with the float values returned by random() (that includes +integers, floats, and fractions but excludes decimals).

    +

    For a given seed, the choices() function with equal weighting +typically produces a different sequence than repeated calls to +choice(). The algorithm used by choices() uses floating +point arithmetic for internal consistency and speed. The algorithm used +by choice() defaults to integer arithmetic with repeated selections +to avoid small biases from round-off error.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +random.shuffle(x[, random])
    +

    Shuffle the sequence x in place.

    +

    The optional argument random is a 0-argument function returning a random +float in [0.0, 1.0); by default, this is the function random().

    +

    To shuffle an immutable sequence and return a new shuffled list, use +sample(x, k=len(x)) instead.

    +

    Note that even for small len(x), the total number of permutations of x +can quickly grow larger than the period of most random number generators. +This implies that most permutations of a long sequence can never be +generated. For example, a sequence of length 2080 is the largest that +can fit within the period of the Mersenne Twister random number generator.

    +
    + +
    +
    +random.sample(population, k)
    +

    Return a k length list of unique elements chosen from the population sequence +or set. Used for random sampling without replacement.

    +

    Returns a new list containing elements from the population while leaving the +original population unchanged. The resulting list is in selection order so that +all sub-slices will also be valid random samples. This allows raffle winners +(the sample) to be partitioned into grand prize and second place winners (the +subslices).

    +

    Members of the population need not be hashable or unique. If the population +contains repeats, then each occurrence is a possible selection in the sample.

    +

    To choose a sample from a range of integers, use a range() object as an +argument. This is especially fast and space efficient for sampling from a large +population: sample(range(10000000), k=60).

    +

    If the sample size is larger than the population size, a ValueError +is raised.

    +
    + +
    +
    +

    Real-valued distributions

    +

    The following functions generate specific real-valued distributions. Function +parameters are named after the corresponding variables in the distribution’s +equation, as used in common mathematical practice; most of these equations can +be found in any statistics text.

    +
    +
    +random.random()
    +

    Return the next random floating point number in the range [0.0, 1.0).

    +
    + +
    +
    +random.uniform(a, b)
    +

    Return a random floating point number N such that a <= N <= b for +a <= b and b <= N <= a for b < a.

    +

    The end-point value b may or may not be included in the range +depending on floating-point rounding in the equation a + (b-a) * random().

    +
    + +
    +
    +random.triangular(low, high, mode)
    +

    Return a random floating point number N such that low <= N <= high and +with the specified mode between those bounds. The low and high bounds +default to zero and one. The mode argument defaults to the midpoint +between the bounds, giving a symmetric distribution.

    +
    + +
    +
    +random.betavariate(alpha, beta)
    +

    Beta distribution. Conditions on the parameters are alpha > 0 and +beta > 0. Returned values range between 0 and 1.

    +
    + +
    +
    +random.expovariate(lambd)
    +

    Exponential distribution. lambd is 1.0 divided by the desired +mean. It should be nonzero. (The parameter would be called +“lambda”, but that is a reserved word in Python.) Returned values +range from 0 to positive infinity if lambd is positive, and from +negative infinity to 0 if lambd is negative.

    +
    + +
    +
    +random.gammavariate(alpha, beta)
    +

    Gamma distribution. (Not the gamma function!) Conditions on the +parameters are alpha > 0 and beta > 0.

    +

    The probability distribution function is:

    +
              x ** (alpha - 1) * math.exp(-x / beta)
    +pdf(x) =  --------------------------------------
    +            math.gamma(alpha) * beta ** alpha
    +
    +
    +
    + +
    +
    +random.gauss(mu, sigma)
    +

    Gaussian distribution. mu is the mean, and sigma is the standard +deviation. This is slightly faster than the normalvariate() function +defined below.

    +
    + +
    +
    +random.lognormvariate(mu, sigma)
    +

    Log normal distribution. If you take the natural logarithm of this +distribution, you’ll get a normal distribution with mean mu and standard +deviation sigma. mu can have any value, and sigma must be greater than +zero.

    +
    + +
    +
    +random.normalvariate(mu, sigma)
    +

    Normal distribution. mu is the mean, and sigma is the standard deviation.

    +
    + +
    +
    +random.vonmisesvariate(mu, kappa)
    +

    mu is the mean angle, expressed in radians between 0 and 2*pi, and kappa +is the concentration parameter, which must be greater than or equal to zero. If +kappa is equal to zero, this distribution reduces to a uniform random angle +over the range 0 to 2*pi.

    +
    + +
    +
    +random.paretovariate(alpha)
    +

    Pareto distribution. alpha is the shape parameter.

    +
    + +
    +
    +random.weibullvariate(alpha, beta)
    +

    Weibull distribution. alpha is the scale parameter and beta is the shape +parameter.

    +
    + +
    +
    +

    Alternative Generator

    +
    +
    +class random.Random([seed])
    +

    Class that implements the default pseudo-random number generator used by the +random module.

    +
    + +
    +
    +class random.SystemRandom([seed])
    +

    Class that uses the os.urandom() function for generating random numbers +from sources provided by the operating system. Not available on all systems. +Does not rely on software state, and sequences are not reproducible. Accordingly, +the seed() method has no effect and is ignored. +The getstate() and setstate() methods raise +NotImplementedError if called.

    +
    + +
    +
    +

    Notes on Reproducibility

    +

    Sometimes it is useful to be able to reproduce the sequences given by a pseudo +random number generator. By re-using a seed value, the same sequence should be +reproducible from run to run as long as multiple threads are not running.

    +

    Most of the random module’s algorithms and seeding functions are subject to +change across Python versions, but two aspects are guaranteed not to change:

    +
      +
    • If a new seeding method is added, then a backward compatible seeder will be +offered.

    • +
    • The generator’s random() method will continue to produce the same +sequence when the compatible seeder is given the same seed.

    • +
    +
    +
    +

    Examples and Recipes

    +

    Basic examples:

    +
    >>> random()                             # Random float:  0.0 <= x < 1.0
    +0.37444887175646646
    +
    +>>> uniform(2.5, 10.0)                   # Random float:  2.5 <= x < 10.0
    +3.1800146073117523
    +
    +>>> expovariate(1 / 5)                   # Interval between arrivals averaging 5 seconds
    +5.148957571865031
    +
    +>>> randrange(10)                        # Integer from 0 to 9 inclusive
    +7
    +
    +>>> randrange(0, 101, 2)                 # Even integer from 0 to 100 inclusive
    +26
    +
    +>>> choice(['win', 'lose', 'draw'])      # Single random element from a sequence
    +'draw'
    +
    +>>> deck = 'ace two three four'.split()
    +>>> shuffle(deck)                        # Shuffle a list
    +>>> deck
    +['four', 'two', 'ace', 'three']
    +
    +>>> sample([10, 20, 30, 40, 50], k=4)    # Four samples without replacement
    +[40, 10, 50, 30]
    +
    +
    +

    Simulations:

    +
    >>> # Six roulette wheel spins (weighted sampling with replacement)
    +>>> choices(['red', 'black', 'green'], [18, 18, 2], k=6)
    +['red', 'green', 'black', 'black', 'red', 'black']
    +
    +>>> # Deal 20 cards without replacement from a deck of 52 playing cards
    +>>> # and determine the proportion of cards with a ten-value
    +>>> # (a ten, jack, queen, or king).
    +>>> deck = collections.Counter(tens=16, low_cards=36)
    +>>> seen = sample(list(deck.elements()), k=20)
    +>>> seen.count('tens') / 20
    +0.15
    +
    +>>> # Estimate the probability of getting 5 or more heads from 7 spins
    +>>> # of a biased coin that settles on heads 60% of the time.
    +>>> def trial():
    +...     return choices('HT', cum_weights=(0.60, 1.00), k=7).count('H') >= 5
    +...
    +>>> sum(trial() for i in range(10000)) / 10000
    +0.4169
    +
    +>>> # Probability of the median of 5 samples being in middle two quartiles
    +>>> def trial():
    +...     return 2500 <= sorted(choices(range(10000), k=5))[2] < 7500
    +...
    +>>> sum(trial() for i in range(10000)) / 10000
    +0.7958
    +
    +
    +

    Example of statistical bootstrapping using resampling +with replacement to estimate a confidence interval for the mean of a sample of +size five:

    +
    # http://statistics.about.com/od/Applications/a/Example-Of-Bootstrapping.htm
    +from statistics import mean
    +from random import choices
    +
    +data = 1, 2, 4, 4, 10
    +means = sorted(mean(choices(data, k=5)) for i in range(20))
    +print(f'The sample mean of {mean(data):.1f} has a 90% confidence '
    +      f'interval from {means[1]:.1f} to {means[-2]:.1f}')
    +
    +
    +

    Example of a resampling permutation test +to determine the statistical significance or p-value of an observed difference +between the effects of a drug versus a placebo:

    +
    # Example from "Statistics is Easy" by Dennis Shasha and Manda Wilson
    +from statistics import mean
    +from random import shuffle
    +
    +drug = [54, 73, 53, 70, 73, 68, 52, 65, 65]
    +placebo = [54, 51, 58, 44, 55, 52, 42, 47, 58, 46]
    +observed_diff = mean(drug) - mean(placebo)
    +
    +n = 10000
    +count = 0
    +combined = drug + placebo
    +for i in range(n):
    +    shuffle(combined)
    +    new_diff = mean(combined[:len(drug)]) - mean(combined[len(drug):])
    +    count += (new_diff >= observed_diff)
    +
    +print(f'{n} label reshufflings produced only {count} instances with a difference')
    +print(f'at least as extreme as the observed difference of {observed_diff:.1f}.')
    +print(f'The one-sided p-value of {count / n:.4f} leads us to reject the null')
    +print(f'hypothesis that there is no difference between the drug and the placebo.')
    +
    +
    +

    Simulation of arrival times and service deliveries in a single server queue:

    +
    from random import expovariate, gauss
    +from statistics import mean, median, stdev
    +
    +average_arrival_interval = 5.6
    +average_service_time = 5.0
    +stdev_service_time = 0.5
    +
    +num_waiting = 0
    +arrivals = []
    +starts = []
    +arrival = service_end = 0.0
    +for i in range(20000):
    +    if arrival <= service_end:
    +        num_waiting += 1
    +        arrival += expovariate(1.0 / average_arrival_interval)
    +        arrivals.append(arrival)
    +    else:
    +        num_waiting -= 1
    +        service_start = service_end if num_waiting else arrival
    +        service_time = gauss(average_service_time, stdev_service_time)
    +        service_end = service_start + service_time
    +        starts.append(service_start)
    +
    +waits = [start - arrival for arrival, start in zip(arrivals, starts)]
    +print(f'Mean wait: {mean(waits):.1f}.  Stdev wait: {stdev(waits):.1f}.')
    +print(f'Median wait: {median(waits):.1f}.  Max wait: {max(waits):.1f}.')
    +
    +
    +
    +

    See also

    +

    Statistics for Hackers +a video tutorial by +Jake Vanderplas +on statistical analysis using just a few fundamental concepts +including simulation, sampling, shuffling, and cross-validation.

    +

    Economics Simulation +a simulation of a marketplace by +Peter Norvig that shows effective +use of many of the tools and distributions provided by this module +(gauss, uniform, sample, betavariate, choice, triangular, and randrange).

    +

    A Concrete Introduction to Probability (using Python) +a tutorial by Peter Norvig covering +the basics of probability theory, how to write simulations, and +how to perform data analysis using Python.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/re.html b/python-3.7.4-docs-html/library/re.html new file mode 100644 index 0000000..c35c1ff --- /dev/null +++ b/python-3.7.4-docs-html/library/re.html @@ -0,0 +1,1839 @@ + + + + + + + re — Regular expression operations — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    re — Regular expression operations

    +

    Source code: Lib/re.py

    +
    +

    This module provides regular expression matching operations similar to +those found in Perl.

    +

    Both patterns and strings to be searched can be Unicode strings (str) +as well as 8-bit strings (bytes). +However, Unicode strings and 8-bit strings cannot be mixed: +that is, you cannot match a Unicode string with a byte pattern or +vice-versa; similarly, when asking for a substitution, the replacement +string must be of the same type as both the pattern and the search string.

    +

    Regular expressions use the backslash character ('\') to indicate +special forms or to allow special characters to be used without invoking +their special meaning. This collides with Python’s usage of the same +character for the same purpose in string literals; for example, to match +a literal backslash, one might have to write '\\\\' as the pattern +string, because the regular expression must be \\, and each +backslash must be expressed as \\ inside a regular Python string +literal.

    +

    The solution is to use Python’s raw string notation for regular expression +patterns; backslashes are not handled in any special way in a string literal +prefixed with 'r'. So r"\n" is a two-character string containing +'\' and 'n', while "\n" is a one-character string containing a +newline. Usually patterns will be expressed in Python code using this raw +string notation.

    +

    It is important to note that most regular expression operations are available as +module-level functions and methods on +compiled regular expressions. The functions are shortcuts +that don’t require you to compile a regex object first, but miss some +fine-tuning parameters.

    +
    +

    See also

    +

    The third-party regex module, +which has an API compatible with the standard library re module, +but offers additional functionality and a more thorough Unicode support.

    +
    +
    +

    Regular Expression Syntax

    +

    A regular expression (or RE) specifies a set of strings that matches it; the +functions in this module let you check if a particular string matches a given +regular expression (or if a given regular expression matches a particular +string, which comes down to the same thing).

    +

    Regular expressions can be concatenated to form new regular expressions; if A +and B are both regular expressions, then AB is also a regular expression. +In general, if a string p matches A and another string q matches B, the +string pq will match AB. This holds unless A or B contain low precedence +operations; boundary conditions between A and B; or have numbered group +references. Thus, complex expressions can easily be constructed from simpler +primitive expressions like the ones described here. For details of the theory +and implementation of regular expressions, consult the Friedl book [Frie09], +or almost any textbook about compiler construction.

    +

    A brief explanation of the format of regular expressions follows. For further +information and a gentler presentation, consult the Regular Expression HOWTO.

    +

    Regular expressions can contain both special and ordinary characters. Most +ordinary characters, like 'A', 'a', or '0', are the simplest regular +expressions; they simply match themselves. You can concatenate ordinary +characters, so last matches the string 'last'. (In the rest of this +section, we’ll write RE’s in this special style, usually without quotes, and +strings to be matched 'in single quotes'.)

    +

    Some characters, like '|' or '(', are special. Special +characters either stand for classes of ordinary characters, or affect +how the regular expressions around them are interpreted.

    +

    Repetition qualifiers (*, +, ?, {m,n}, etc) cannot be +directly nested. This avoids ambiguity with the non-greedy modifier suffix +?, and with other modifiers in other implementations. To apply a second +repetition to an inner repetition, parentheses may be used. For example, +the expression (?:a{6})* matches any multiple of six 'a' characters.

    +

    The special characters are:

    +
    +
    .

    (Dot.) In the default mode, this matches any character except a newline. If +the DOTALL flag has been specified, this matches any character +including a newline.

    +
    +
    +
    +
    ^

    (Caret.) Matches the start of the string, and in MULTILINE mode also +matches immediately after each newline.

    +
    +
    +
    +
    $

    Matches the end of the string or just before the newline at the end of the +string, and in MULTILINE mode also matches before a newline. foo +matches both ‘foo’ and ‘foobar’, while the regular expression foo$ matches +only ‘foo’. More interestingly, searching for foo.$ in 'foo1\nfoo2\n' +matches ‘foo2’ normally, but ‘foo1’ in MULTILINE mode; searching for +a single $ in 'foo\n' will find two (empty) matches: one just before +the newline, and one at the end of the string.

    +
    +
    +
    +
    *

    Causes the resulting RE to match 0 or more repetitions of the preceding RE, as +many repetitions as are possible. ab* will match ‘a’, ‘ab’, or ‘a’ followed +by any number of ‘b’s.

    +
    +
    +
    +
    +

    Causes the resulting RE to match 1 or more repetitions of the preceding RE. +ab+ will match ‘a’ followed by any non-zero number of ‘b’s; it will not +match just ‘a’.

    +
    +
    +
    +
    ?

    Causes the resulting RE to match 0 or 1 repetitions of the preceding RE. +ab? will match either ‘a’ or ‘ab’.

    +
    +
    +
    +
    *?, +?, ??

    The '*', '+', and '?' qualifiers are all greedy; they match +as much text as possible. Sometimes this behaviour isn’t desired; if the RE +<.*> is matched against '<a> b <c>', it will match the entire +string, and not just '<a>'. Adding ? after the qualifier makes it +perform the match in non-greedy or minimal fashion; as few +characters as possible will be matched. Using the RE <.*?> will match +only '<a>'.

    +
    +
    +
    +
    {m}

    Specifies that exactly m copies of the previous RE should be matched; fewer +matches cause the entire RE not to match. For example, a{6} will match +exactly six 'a' characters, but not five.

    +
    +
    {m,n}

    Causes the resulting RE to match from m to n repetitions of the preceding +RE, attempting to match as many repetitions as possible. For example, +a{3,5} will match from 3 to 5 'a' characters. Omitting m specifies a +lower bound of zero, and omitting n specifies an infinite upper bound. As an +example, a{4,}b will match 'aaaab' or a thousand 'a' characters +followed by a 'b', but not 'aaab'. The comma may not be omitted or the +modifier would be confused with the previously described form.

    +
    +
    {m,n}?

    Causes the resulting RE to match from m to n repetitions of the preceding +RE, attempting to match as few repetitions as possible. This is the +non-greedy version of the previous qualifier. For example, on the +6-character string 'aaaaaa', a{3,5} will match 5 'a' characters, +while a{3,5}? will only match 3 characters.

    +
    +
    +
    +
    \

    Either escapes special characters (permitting you to match characters like +'*', '?', and so forth), or signals a special sequence; special +sequences are discussed below.

    +

    If you’re not using a raw string to express the pattern, remember that Python +also uses the backslash as an escape sequence in string literals; if the escape +sequence isn’t recognized by Python’s parser, the backslash and subsequent +character are included in the resulting string. However, if Python would +recognize the resulting sequence, the backslash should be repeated twice. This +is complicated and hard to understand, so it’s highly recommended that you use +raw strings for all but the simplest expressions.

    +
    +
    +
    +
    []

    Used to indicate a set of characters. In a set:

    +
      +
    • Characters can be listed individually, e.g. [amk] will match 'a', +'m', or 'k'.

    • +
    +
      +
    • Ranges of characters can be indicated by giving two characters and separating +them by a '-', for example [a-z] will match any lowercase ASCII letter, +[0-5][0-9] will match all the two-digits numbers from 00 to 59, and +[0-9A-Fa-f] will match any hexadecimal digit. If - is escaped (e.g. +[a\-z]) or if it’s placed as the first or last character +(e.g. [-a] or [a-]), it will match a literal '-'.

    • +
    • Special characters lose their special meaning inside sets. For example, +[(+*)] will match any of the literal characters '(', '+', +'*', or ')'.

    • +
    +
      +
    • Character classes such as \w or \S (defined below) are also accepted +inside a set, although the characters they match depends on whether +ASCII or LOCALE mode is in force.

    • +
    +
      +
    • Characters that are not within a range can be matched by complementing +the set. If the first character of the set is '^', all the characters +that are not in the set will be matched. For example, [^5] will match +any character except '5', and [^^] will match any character except +'^'. ^ has no special meaning if it’s not the first character in +the set.

    • +
    • To match a literal ']' inside a set, precede it with a backslash, or +place it at the beginning of the set. For example, both [()[\]{}] and +[]()[{}] will both match a parenthesis.

    • +
    +
      +
    • Support of nested sets and set operations as in Unicode Technical +Standard #18 might be added in the future. This would change the +syntax, so to facilitate this change a FutureWarning will be raised +in ambiguous cases for the time being. +That includes sets starting with a literal '[' or containing literal +character sequences '--', '&&', '~~', and '||'. To +avoid a warning escape them with a backslash.

    • +
    +
    +

    Changed in version 3.7: FutureWarning is raised if a character set contains constructs +that will change semantically in the future.

    +
    +
    +
    +
    +
    |

    A|B, where A and B can be arbitrary REs, creates a regular expression that +will match either A or B. An arbitrary number of REs can be separated by the +'|' in this way. This can be used inside groups (see below) as well. As +the target string is scanned, REs separated by '|' are tried from left to +right. When one pattern completely matches, that branch is accepted. This means +that once A matches, B will not be tested further, even if it would +produce a longer overall match. In other words, the '|' operator is never +greedy. To match a literal '|', use \|, or enclose it inside a +character class, as in [|].

    +
    +
    +
    +
    (...)

    Matches whatever regular expression is inside the parentheses, and indicates the +start and end of a group; the contents of a group can be retrieved after a match +has been performed, and can be matched later in the string with the \number +special sequence, described below. To match the literals '(' or ')', +use \( or \), or enclose them inside a character class: [(], [)].

    +
    +
    +
    +
    (?...)

    This is an extension notation (a '?' following a '(' is not meaningful +otherwise). The first character after the '?' determines what the meaning +and further syntax of the construct is. Extensions usually do not create a new +group; (?P<name>...) is the only exception to this rule. Following are the +currently supported extensions.

    +
    +
    (?aiLmsux)

    (One or more letters from the set 'a', 'i', 'L', 'm', +'s', 'u', 'x'.) The group matches the empty string; the +letters set the corresponding flags: re.A (ASCII-only matching), +re.I (ignore case), re.L (locale dependent), +re.M (multi-line), re.S (dot matches all), +re.U (Unicode matching), and re.X (verbose), +for the entire regular expression. +(The flags are described in Module Contents.) +This is useful if you wish to include the flags as part of the +regular expression, instead of passing a flag argument to the +re.compile() function. Flags should be used first in the +expression string.

    +
    +
    +
    +
    (?:...)

    A non-capturing version of regular parentheses. Matches whatever regular +expression is inside the parentheses, but the substring matched by the group +cannot be retrieved after performing a match or referenced later in the +pattern.

    +
    +
    (?aiLmsux-imsx:...)

    (Zero or more letters from the set 'a', 'i', 'L', 'm', +'s', 'u', 'x', optionally followed by '-' followed by +one or more letters from the 'i', 'm', 's', 'x'.) +The letters set or remove the corresponding flags: +re.A (ASCII-only matching), re.I (ignore case), +re.L (locale dependent), re.M (multi-line), +re.S (dot matches all), re.U (Unicode matching), +and re.X (verbose), for the part of the expression. +(The flags are described in Module Contents.)

    +

    The letters 'a', 'L' and 'u' are mutually exclusive when used +as inline flags, so they can’t be combined or follow '-'. Instead, +when one of them appears in an inline group, it overrides the matching mode +in the enclosing group. In Unicode patterns (?a:...) switches to +ASCII-only matching, and (?u:...) switches to Unicode matching +(default). In byte pattern (?L:...) switches to locale depending +matching, and (?a:...) switches to ASCII-only matching (default). +This override is only in effect for the narrow inline group, and the +original matching mode is restored outside of the group.

    +
    +

    New in version 3.6.

    +
    +
    +

    Changed in version 3.7: The letters 'a', 'L' and 'u' also can be used in a group.

    +
    +
    +
    +
    +
    (?P<name>...)

    Similar to regular parentheses, but the substring matched by the group is +accessible via the symbolic group name name. Group names must be valid +Python identifiers, and each group name must be defined only once within a +regular expression. A symbolic group is also a numbered group, just as if +the group were not named.

    +

    Named groups can be referenced in three contexts. If the pattern is +(?P<quote>['"]).*?(?P=quote) (i.e. matching a string quoted with either +single or double quotes):

    + ++++ + + + + + + + + + + + + + + + + +

    Context of reference to group “quote”

    Ways to reference it

    in the same pattern itself

      +
    • (?P=quote) (as shown)

    • +
    • \1

    • +
    +

    when processing match object m

      +
    • m.group('quote')

    • +
    • m.end('quote') (etc.)

    • +
    +

    in a string passed to the repl +argument of re.sub()

      +
    • \g<quote>

    • +
    • \g<1>

    • +
    • \1

    • +
    +
    +
    +
    +
    +
    (?P=name)

    A backreference to a named group; it matches whatever text was matched by the +earlier group named name.

    +
    +
    +
    +
    (?#...)

    A comment; the contents of the parentheses are simply ignored.

    +
    +
    +
    +
    (?=...)

    Matches if ... matches next, but doesn’t consume any of the string. This is +called a lookahead assertion. For example, Isaac (?=Asimov) will match +'Isaac ' only if it’s followed by 'Asimov'.

    +
    +
    +
    +
    (?!...)

    Matches if ... doesn’t match next. This is a negative lookahead assertion. +For example, Isaac (?!Asimov) will match 'Isaac ' only if it’s not +followed by 'Asimov'.

    +
    +
    +
    +
    (?<=...)

    Matches if the current position in the string is preceded by a match for ... +that ends at the current position. This is called a positive lookbehind +assertion. (?<=abc)def will find a match in 'abcdef', since the +lookbehind will back up 3 characters and check if the contained pattern matches. +The contained pattern must only match strings of some fixed length, meaning that +abc or a|b are allowed, but a* and a{3,4} are not. Note that +patterns which start with positive lookbehind assertions will not match at the +beginning of the string being searched; you will most likely want to use the +search() function rather than the match() function:

    +
    >>> import re
    +>>> m = re.search('(?<=abc)def', 'abcdef')
    +>>> m.group(0)
    +'def'
    +
    +
    +

    This example looks for a word following a hyphen:

    +
    >>> m = re.search(r'(?<=-)\w+', 'spam-egg')
    +>>> m.group(0)
    +'egg'
    +
    +
    +
    +

    Changed in version 3.5: Added support for group references of fixed length.

    +
    +
    +
    +
    +
    (?<!...)

    Matches if the current position in the string is not preceded by a match for +.... This is called a negative lookbehind assertion. Similar to +positive lookbehind assertions, the contained pattern must only match strings of +some fixed length. Patterns which start with negative lookbehind assertions may +match at the beginning of the string being searched.

    +
    +
    (?(id/name)yes-pattern|no-pattern)

    Will try to match with yes-pattern if the group with given id or +name exists, and with no-pattern if it doesn’t. no-pattern is +optional and can be omitted. For example, +(<)?(\w+@\w+(?:\.\w+)+)(?(1)>|$) is a poor email matching pattern, which +will match with '<user@host.com>' as well as 'user@host.com', but +not with '<user@host.com' nor 'user@host.com>'.

    +
    +
    +

    The special sequences consist of '\' and a character from the list below. +If the ordinary character is not an ASCII digit or an ASCII letter, then the +resulting RE will match the second character. For example, \$ matches the +character '$'.

    +
    +
    \number

    Matches the contents of the group of the same number. Groups are numbered +starting from 1. For example, (.+) \1 matches 'the the' or '55 55', +but not 'thethe' (note the space after the group). This special sequence +can only be used to match one of the first 99 groups. If the first digit of +number is 0, or number is 3 octal digits long, it will not be interpreted as +a group match, but as the character with octal value number. Inside the +'[' and ']' of a character class, all numeric escapes are treated as +characters.

    +
    +
    +
    +
    \A

    Matches only at the start of the string.

    +
    +
    +
    +
    \b

    Matches the empty string, but only at the beginning or end of a word. +A word is defined as a sequence of word characters. Note that formally, +\b is defined as the boundary between a \w and a \W character +(or vice versa), or between \w and the beginning/end of the string. +This means that r'\bfoo\b' matches 'foo', 'foo.', '(foo)', +'bar foo baz' but not 'foobar' or 'foo3'.

    +

    By default Unicode alphanumerics are the ones used in Unicode patterns, but +this can be changed by using the ASCII flag. Word boundaries are +determined by the current locale if the LOCALE flag is used. +Inside a character range, \b represents the backspace character, for +compatibility with Python’s string literals.

    +
    +
    +
    +
    \B

    Matches the empty string, but only when it is not at the beginning or end +of a word. This means that r'py\B' matches 'python', 'py3', +'py2', but not 'py', 'py.', or 'py!'. +\B is just the opposite of \b, so word characters in Unicode +patterns are Unicode alphanumerics or the underscore, although this can +be changed by using the ASCII flag. Word boundaries are +determined by the current locale if the LOCALE flag is used.

    +
    +
    +
    +
    \d
    +
    For Unicode (str) patterns:

    Matches any Unicode decimal digit (that is, any character in +Unicode character category [Nd]). This includes [0-9], and +also many other digit characters. If the ASCII flag is +used only [0-9] is matched.

    +
    +
    For 8-bit (bytes) patterns:

    Matches any decimal digit; this is equivalent to [0-9].

    +
    +
    +
    +
    +
    +
    \D

    Matches any character which is not a decimal digit. This is +the opposite of \d. If the ASCII flag is used this +becomes the equivalent of [^0-9].

    +
    +
    +
    +
    \s
    +
    For Unicode (str) patterns:

    Matches Unicode whitespace characters (which includes +[ \t\n\r\f\v], and also many other characters, for example the +non-breaking spaces mandated by typography rules in many +languages). If the ASCII flag is used, only +[ \t\n\r\f\v] is matched.

    +
    +
    For 8-bit (bytes) patterns:

    Matches characters considered whitespace in the ASCII character set; +this is equivalent to [ \t\n\r\f\v].

    +
    +
    +
    +
    +
    +
    \S

    Matches any character which is not a whitespace character. This is +the opposite of \s. If the ASCII flag is used this +becomes the equivalent of [^ \t\n\r\f\v].

    +
    +
    +
    +
    \w
    +
    For Unicode (str) patterns:

    Matches Unicode word characters; this includes most characters +that can be part of a word in any language, as well as numbers and +the underscore. If the ASCII flag is used, only +[a-zA-Z0-9_] is matched.

    +
    +
    For 8-bit (bytes) patterns:

    Matches characters considered alphanumeric in the ASCII character set; +this is equivalent to [a-zA-Z0-9_]. If the LOCALE flag is +used, matches characters considered alphanumeric in the current locale +and the underscore.

    +
    +
    +
    +
    +
    +
    \W

    Matches any character which is not a word character. This is +the opposite of \w. If the ASCII flag is used this +becomes the equivalent of [^a-zA-Z0-9_]. If the LOCALE flag is +used, matches characters considered alphanumeric in the current locale +and the underscore.

    +
    +
    +
    +
    \Z

    Matches only at the end of the string.

    +
    +
    +

    Most of the standard escapes supported by Python string literals are also +accepted by the regular expression parser:

    +
    \a      \b      \f      \n
    +\r      \t      \u      \U
    +\v      \x      \\
    +
    +
    +

    (Note that \b is used to represent word boundaries, and means “backspace” +only inside character classes.)

    +

    '\u' and '\U' escape sequences are only recognized in Unicode +patterns. In bytes patterns they are errors. Unknown escapes of ASCII +letters are reserved for future use and treated as errors.

    +

    Octal escapes are included in a limited form. If the first digit is a 0, or if +there are three octal digits, it is considered an octal escape. Otherwise, it is +a group reference. As for string literals, octal escapes are always at most +three digits in length.

    +
    +

    Changed in version 3.3: The '\u' and '\U' escape sequences have been added.

    +
    +
    +

    Changed in version 3.6: Unknown escapes consisting of '\' and an ASCII letter now are errors.

    +
    +
    +
    +

    Module Contents

    +

    The module defines several functions, constants, and an exception. Some of the +functions are simplified versions of the full featured methods for compiled +regular expressions. Most non-trivial applications always use the compiled +form.

    +
    +

    Changed in version 3.6: Flag constants are now instances of RegexFlag, which is a subclass of +enum.IntFlag.

    +
    +
    +
    +re.compile(pattern, flags=0)
    +

    Compile a regular expression pattern into a regular expression object, which can be used for matching using its +match(), search() and other methods, described +below.

    +

    The expression’s behaviour can be modified by specifying a flags value. +Values can be any of the following variables, combined using bitwise OR (the +| operator).

    +

    The sequence

    +
    prog = re.compile(pattern)
    +result = prog.match(string)
    +
    +
    +

    is equivalent to

    +
    result = re.match(pattern, string)
    +
    +
    +

    but using re.compile() and saving the resulting regular expression +object for reuse is more efficient when the expression will be used several +times in a single program.

    +
    +

    Note

    +

    The compiled versions of the most recent patterns passed to +re.compile() and the module-level matching functions are cached, so +programs that use only a few regular expressions at a time needn’t worry +about compiling regular expressions.

    +
    +
    + +
    +
    +re.A
    +
    +re.ASCII
    +

    Make \w, \W, \b, \B, \d, \D, \s and \S +perform ASCII-only matching instead of full Unicode matching. This is only +meaningful for Unicode patterns, and is ignored for byte patterns. +Corresponds to the inline flag (?a).

    +

    Note that for backward compatibility, the re.U flag still +exists (as well as its synonym re.UNICODE and its embedded +counterpart (?u)), but these are redundant in Python 3 since +matches are Unicode by default for strings (and Unicode matching +isn’t allowed for bytes).

    +
    + +
    +
    +re.DEBUG
    +

    Display debug information about compiled expression. +No corresponding inline flag.

    +
    + +
    +
    +re.I
    +
    +re.IGNORECASE
    +

    Perform case-insensitive matching; expressions like [A-Z] will also +match lowercase letters. Full Unicode matching (such as Ü matching +ü) also works unless the re.ASCII flag is used to disable +non-ASCII matches. The current locale does not change the effect of this +flag unless the re.LOCALE flag is also used. +Corresponds to the inline flag (?i).

    +

    Note that when the Unicode patterns [a-z] or [A-Z] are used in +combination with the IGNORECASE flag, they will match the 52 ASCII +letters and 4 additional non-ASCII letters: ‘İ’ (U+0130, Latin capital +letter I with dot above), ‘ı’ (U+0131, Latin small letter dotless i), +‘ſ’ (U+017F, Latin small letter long s) and ‘K’ (U+212A, Kelvin sign). +If the ASCII flag is used, only letters ‘a’ to ‘z’ +and ‘A’ to ‘Z’ are matched.

    +
    + +
    +
    +re.L
    +
    +re.LOCALE
    +

    Make \w, \W, \b, \B and case-insensitive matching +dependent on the current locale. This flag can be used only with bytes +patterns. The use of this flag is discouraged as the locale mechanism +is very unreliable, it only handles one “culture” at a time, and it only +works with 8-bit locales. Unicode matching is already enabled by default +in Python 3 for Unicode (str) patterns, and it is able to handle different +locales/languages. +Corresponds to the inline flag (?L).

    +
    +

    Changed in version 3.6: re.LOCALE can be used only with bytes patterns and is +not compatible with re.ASCII.

    +
    +
    +

    Changed in version 3.7: Compiled regular expression objects with the re.LOCALE flag no +longer depend on the locale at compile time. Only the locale at +matching time affects the result of matching.

    +
    +
    + +
    +
    +re.M
    +
    +re.MULTILINE
    +

    When specified, the pattern character '^' matches at the beginning of the +string and at the beginning of each line (immediately following each newline); +and the pattern character '$' matches at the end of the string and at the +end of each line (immediately preceding each newline). By default, '^' +matches only at the beginning of the string, and '$' only at the end of the +string and immediately before the newline (if any) at the end of the string. +Corresponds to the inline flag (?m).

    +
    + +
    +
    +re.S
    +
    +re.DOTALL
    +

    Make the '.' special character match any character at all, including a +newline; without this flag, '.' will match anything except a newline. +Corresponds to the inline flag (?s).

    +
    + +
    +
    +re.X
    +
    +re.VERBOSE
    +

    This flag allows you to write regular expressions that look nicer and are +more readable by allowing you to visually separate logical sections of the +pattern and add comments. Whitespace within the pattern is ignored, except +when in a character class, or when preceded by an unescaped backslash, +or within tokens like *?, (?: or (?P<...>. +When a line contains a # that is not in a character class and is not +preceded by an unescaped backslash, all characters from the leftmost such +# through the end of the line are ignored.

    +

    This means that the two following regular expression objects that match a +decimal number are functionally equal:

    +
    a = re.compile(r"""\d +  # the integral part
    +                   \.    # the decimal point
    +                   \d *  # some fractional digits""", re.X)
    +b = re.compile(r"\d+\.\d*")
    +
    +
    +

    Corresponds to the inline flag (?x).

    +
    + +
    +
    +re.search(pattern, string, flags=0)
    +

    Scan through string looking for the first location where the regular expression +pattern produces a match, and return a corresponding match object. Return None if no position in the string matches the +pattern; note that this is different from finding a zero-length match at some +point in the string.

    +
    + +
    +
    +re.match(pattern, string, flags=0)
    +

    If zero or more characters at the beginning of string match the regular +expression pattern, return a corresponding match object. Return None if the string does not match the pattern; +note that this is different from a zero-length match.

    +

    Note that even in MULTILINE mode, re.match() will only match +at the beginning of the string and not at the beginning of each line.

    +

    If you want to locate a match anywhere in string, use search() +instead (see also search() vs. match()).

    +
    + +
    +
    +re.fullmatch(pattern, string, flags=0)
    +

    If the whole string matches the regular expression pattern, return a +corresponding match object. Return None if the +string does not match the pattern; note that this is different from a +zero-length match.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +re.split(pattern, string, maxsplit=0, flags=0)
    +

    Split string by the occurrences of pattern. If capturing parentheses are +used in pattern, then the text of all groups in the pattern are also returned +as part of the resulting list. If maxsplit is nonzero, at most maxsplit +splits occur, and the remainder of the string is returned as the final element +of the list.

    +
    >>> re.split(r'\W+', 'Words, words, words.')
    +['Words', 'words', 'words', '']
    +>>> re.split(r'(\W+)', 'Words, words, words.')
    +['Words', ', ', 'words', ', ', 'words', '.', '']
    +>>> re.split(r'\W+', 'Words, words, words.', 1)
    +['Words', 'words, words.']
    +>>> re.split('[a-f]+', '0a3B9', flags=re.IGNORECASE)
    +['0', '3', '9']
    +
    +
    +

    If there are capturing groups in the separator and it matches at the start of +the string, the result will start with an empty string. The same holds for +the end of the string:

    +
    >>> re.split(r'(\W+)', '...words, words...')
    +['', '...', 'words', ', ', 'words', '...', '']
    +
    +
    +

    That way, separator components are always found at the same relative +indices within the result list.

    +

    Empty matches for the pattern split the string only when not adjacent +to a previous empty match.

    +
    >>> re.split(r'\b', 'Words, words, words.')
    +['', 'Words', ', ', 'words', ', ', 'words', '.']
    +>>> re.split(r'\W*', '...words...')
    +['', '', 'w', 'o', 'r', 'd', 's', '', '']
    +>>> re.split(r'(\W*)', '...words...')
    +['', '...', '', '', 'w', '', 'o', '', 'r', '', 'd', '', 's', '...', '', '', '']
    +
    +
    +
    +

    Changed in version 3.1: Added the optional flags argument.

    +
    +
    +

    Changed in version 3.7: Added support of splitting on a pattern that could match an empty string.

    +
    +
    + +
    +
    +re.findall(pattern, string, flags=0)
    +

    Return all non-overlapping matches of pattern in string, as a list of +strings. The string is scanned left-to-right, and matches are returned in +the order found. If one or more groups are present in the pattern, return a +list of groups; this will be a list of tuples if the pattern has more than +one group. Empty matches are included in the result.

    +
    +

    Changed in version 3.7: Non-empty matches can now start just after a previous empty match.

    +
    +
    + +
    +
    +re.finditer(pattern, string, flags=0)
    +

    Return an iterator yielding match objects over +all non-overlapping matches for the RE pattern in string. The string +is scanned left-to-right, and matches are returned in the order found. Empty +matches are included in the result.

    +
    +

    Changed in version 3.7: Non-empty matches can now start just after a previous empty match.

    +
    +
    + +
    +
    +re.sub(pattern, repl, string, count=0, flags=0)
    +

    Return the string obtained by replacing the leftmost non-overlapping occurrences +of pattern in string by the replacement repl. If the pattern isn’t found, +string is returned unchanged. repl can be a string or a function; if it is +a string, any backslash escapes in it are processed. That is, \n is +converted to a single newline character, \r is converted to a carriage return, and +so forth. Unknown escapes of ASCII letters are reserved for future use and +treated as errors. Other unknown escapes such as \& are left alone. +Backreferences, such +as \6, are replaced with the substring matched by group 6 in the pattern. +For example:

    +
    >>> re.sub(r'def\s+([a-zA-Z_][a-zA-Z_0-9]*)\s*\(\s*\):',
    +...        r'static PyObject*\npy_\1(void)\n{',
    +...        'def myfunc():')
    +'static PyObject*\npy_myfunc(void)\n{'
    +
    +
    +

    If repl is a function, it is called for every non-overlapping occurrence of +pattern. The function takes a single match object +argument, and returns the replacement string. For example:

    +
    >>> def dashrepl(matchobj):
    +...     if matchobj.group(0) == '-': return ' '
    +...     else: return '-'
    +>>> re.sub('-{1,2}', dashrepl, 'pro----gram-files')
    +'pro--gram files'
    +>>> re.sub(r'\sAND\s', ' & ', 'Baked Beans And Spam', flags=re.IGNORECASE)
    +'Baked Beans & Spam'
    +
    +
    +

    The pattern may be a string or a pattern object.

    +

    The optional argument count is the maximum number of pattern occurrences to be +replaced; count must be a non-negative integer. If omitted or zero, all +occurrences will be replaced. Empty matches for the pattern are replaced only +when not adjacent to a previous empty match, so sub('x*', '-', 'abxd') returns +'-a-b--d-'.

    +

    In string-type repl arguments, in addition to the character escapes and +backreferences described above, +\g<name> will use the substring matched by the group named name, as +defined by the (?P<name>...) syntax. \g<number> uses the corresponding +group number; \g<2> is therefore equivalent to \2, but isn’t ambiguous +in a replacement such as \g<2>0. \20 would be interpreted as a +reference to group 20, not a reference to group 2 followed by the literal +character '0'. The backreference \g<0> substitutes in the entire +substring matched by the RE.

    +
    +

    Changed in version 3.1: Added the optional flags argument.

    +
    +
    +

    Changed in version 3.5: Unmatched groups are replaced with an empty string.

    +
    +
    +

    Changed in version 3.6: Unknown escapes in pattern consisting of '\' and an ASCII letter +now are errors.

    +
    +
    +

    Changed in version 3.7: Unknown escapes in repl consisting of '\' and an ASCII letter +now are errors.

    +
    +
    +

    Changed in version 3.7: Empty matches for the pattern are replaced when adjacent to a previous +non-empty match.

    +
    +
    + +
    +
    +re.subn(pattern, repl, string, count=0, flags=0)
    +

    Perform the same operation as sub(), but return a tuple (new_string, +number_of_subs_made).

    +
    +

    Changed in version 3.1: Added the optional flags argument.

    +
    +
    +

    Changed in version 3.5: Unmatched groups are replaced with an empty string.

    +
    +
    + +
    +
    +re.escape(pattern)
    +

    Escape special characters in pattern. +This is useful if you want to match an arbitrary literal string that may +have regular expression metacharacters in it. For example:

    +
    >>> print(re.escape('python.exe'))
    +python\.exe
    +
    +>>> legal_chars = string.ascii_lowercase + string.digits + "!#$%&'*+-.^_`|~:"
    +>>> print('[%s]+' % re.escape(legal_chars))
    +[abcdefghijklmnopqrstuvwxyz0123456789!\#\$%\&'\*\+\-\.\^_`\|\~:]+
    +
    +>>> operators = ['+', '-', '*', '/', '**']
    +>>> print('|'.join(map(re.escape, sorted(operators, reverse=True))))
    +/|\-|\+|\*\*|\*
    +
    +
    +

    This functions must not be used for the replacement string in sub() +and subn(), only backslashes should be escaped. For example:

    +
    >>> digits_re = r'\d+'
    +>>> sample = '/usr/sbin/sendmail - 0 errors, 12 warnings'
    +>>> print(re.sub(digits_re, digits_re.replace('\\', r'\\'), sample))
    +/usr/sbin/sendmail - \d+ errors, \d+ warnings
    +
    +
    +
    +

    Changed in version 3.3: The '_' character is no longer escaped.

    +
    +
    +

    Changed in version 3.7: Only characters that can have special meaning in a regular expression +are escaped.

    +
    +
    + +
    +
    +re.purge()
    +

    Clear the regular expression cache.

    +
    + +
    +
    +exception re.error(msg, pattern=None, pos=None)
    +

    Exception raised when a string passed to one of the functions here is not a +valid regular expression (for example, it might contain unmatched parentheses) +or when some other error occurs during compilation or matching. It is never an +error if a string contains no match for a pattern. The error instance has +the following additional attributes:

    +
    +
    +msg
    +

    The unformatted error message.

    +
    + +
    +
    +pattern
    +

    The regular expression pattern.

    +
    + +
    +
    +pos
    +

    The index in pattern where compilation failed (may be None).

    +
    + +
    +
    +lineno
    +

    The line corresponding to pos (may be None).

    +
    + +
    +
    +colno
    +

    The column corresponding to pos (may be None).

    +
    + +
    +

    Changed in version 3.5: Added additional attributes.

    +
    +
    + +
    +
    +

    Regular Expression Objects

    +

    Compiled regular expression objects support the following methods and +attributes:

    +
    +
    +Pattern.search(string[, pos[, endpos]])
    +

    Scan through string looking for the first location where this regular +expression produces a match, and return a corresponding match object. Return None if no position in the string matches the +pattern; note that this is different from finding a zero-length match at some +point in the string.

    +

    The optional second parameter pos gives an index in the string where the +search is to start; it defaults to 0. This is not completely equivalent to +slicing the string; the '^' pattern character matches at the real beginning +of the string and at positions just after a newline, but not necessarily at the +index where the search is to start.

    +

    The optional parameter endpos limits how far the string will be searched; it +will be as if the string is endpos characters long, so only the characters +from pos to endpos - 1 will be searched for a match. If endpos is less +than pos, no match will be found; otherwise, if rx is a compiled regular +expression object, rx.search(string, 0, 50) is equivalent to +rx.search(string[:50], 0).

    +
    >>> pattern = re.compile("d")
    +>>> pattern.search("dog")     # Match at index 0
    +<re.Match object; span=(0, 1), match='d'>
    +>>> pattern.search("dog", 1)  # No match; search doesn't include the "d"
    +
    +
    +
    + +
    +
    +Pattern.match(string[, pos[, endpos]])
    +

    If zero or more characters at the beginning of string match this regular +expression, return a corresponding match object. +Return None if the string does not match the pattern; note that this is +different from a zero-length match.

    +

    The optional pos and endpos parameters have the same meaning as for the +search() method.

    +
    >>> pattern = re.compile("o")
    +>>> pattern.match("dog")      # No match as "o" is not at the start of "dog".
    +>>> pattern.match("dog", 1)   # Match as "o" is the 2nd character of "dog".
    +<re.Match object; span=(1, 2), match='o'>
    +
    +
    +

    If you want to locate a match anywhere in string, use +search() instead (see also search() vs. match()).

    +
    + +
    +
    +Pattern.fullmatch(string[, pos[, endpos]])
    +

    If the whole string matches this regular expression, return a corresponding +match object. Return None if the string does not +match the pattern; note that this is different from a zero-length match.

    +

    The optional pos and endpos parameters have the same meaning as for the +search() method.

    +
    >>> pattern = re.compile("o[gh]")
    +>>> pattern.fullmatch("dog")      # No match as "o" is not at the start of "dog".
    +>>> pattern.fullmatch("ogre")     # No match as not the full string matches.
    +>>> pattern.fullmatch("doggie", 1, 3)   # Matches within given limits.
    +<re.Match object; span=(1, 3), match='og'>
    +
    +
    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +Pattern.split(string, maxsplit=0)
    +

    Identical to the split() function, using the compiled pattern.

    +
    + +
    +
    +Pattern.findall(string[, pos[, endpos]])
    +

    Similar to the findall() function, using the compiled pattern, but +also accepts optional pos and endpos parameters that limit the search +region like for search().

    +
    + +
    +
    +Pattern.finditer(string[, pos[, endpos]])
    +

    Similar to the finditer() function, using the compiled pattern, but +also accepts optional pos and endpos parameters that limit the search +region like for search().

    +
    + +
    +
    +Pattern.sub(repl, string, count=0)
    +

    Identical to the sub() function, using the compiled pattern.

    +
    + +
    +
    +Pattern.subn(repl, string, count=0)
    +

    Identical to the subn() function, using the compiled pattern.

    +
    + +
    +
    +Pattern.flags
    +

    The regex matching flags. This is a combination of the flags given to +compile(), any (?...) inline flags in the pattern, and implicit +flags such as UNICODE if the pattern is a Unicode string.

    +
    + +
    +
    +Pattern.groups
    +

    The number of capturing groups in the pattern.

    +
    + +
    +
    +Pattern.groupindex
    +

    A dictionary mapping any symbolic group names defined by (?P<id>) to group +numbers. The dictionary is empty if no symbolic groups were used in the +pattern.

    +
    + +
    +
    +Pattern.pattern
    +

    The pattern string from which the pattern object was compiled.

    +
    + +
    +

    Changed in version 3.7: Added support of copy.copy() and copy.deepcopy(). Compiled +regular expression objects are considered atomic.

    +
    +
    +
    +

    Match Objects

    +

    Match objects always have a boolean value of True. +Since match() and search() return None +when there is no match, you can test whether there was a match with a simple +if statement:

    +
    match = re.search(pattern, string)
    +if match:
    +    process(match)
    +
    +
    +

    Match objects support the following methods and attributes:

    +
    +
    +Match.expand(template)
    +

    Return the string obtained by doing backslash substitution on the template +string template, as done by the sub() method. +Escapes such as \n are converted to the appropriate characters, +and numeric backreferences (\1, \2) and named backreferences +(\g<1>, \g<name>) are replaced by the contents of the +corresponding group.

    +
    +

    Changed in version 3.5: Unmatched groups are replaced with an empty string.

    +
    +
    + +
    +
    +Match.group([group1, ...])
    +

    Returns one or more subgroups of the match. If there is a single argument, the +result is a single string; if there are multiple arguments, the result is a +tuple with one item per argument. Without arguments, group1 defaults to zero +(the whole match is returned). If a groupN argument is zero, the corresponding +return value is the entire matching string; if it is in the inclusive range +[1..99], it is the string matching the corresponding parenthesized group. If a +group number is negative or larger than the number of groups defined in the +pattern, an IndexError exception is raised. If a group is contained in a +part of the pattern that did not match, the corresponding result is None. +If a group is contained in a part of the pattern that matched multiple times, +the last match is returned.

    +
    >>> m = re.match(r"(\w+) (\w+)", "Isaac Newton, physicist")
    +>>> m.group(0)       # The entire match
    +'Isaac Newton'
    +>>> m.group(1)       # The first parenthesized subgroup.
    +'Isaac'
    +>>> m.group(2)       # The second parenthesized subgroup.
    +'Newton'
    +>>> m.group(1, 2)    # Multiple arguments give us a tuple.
    +('Isaac', 'Newton')
    +
    +
    +

    If the regular expression uses the (?P<name>...) syntax, the groupN +arguments may also be strings identifying groups by their group name. If a +string argument is not used as a group name in the pattern, an IndexError +exception is raised.

    +

    A moderately complicated example:

    +
    >>> m = re.match(r"(?P<first_name>\w+) (?P<last_name>\w+)", "Malcolm Reynolds")
    +>>> m.group('first_name')
    +'Malcolm'
    +>>> m.group('last_name')
    +'Reynolds'
    +
    +
    +

    Named groups can also be referred to by their index:

    +
    >>> m.group(1)
    +'Malcolm'
    +>>> m.group(2)
    +'Reynolds'
    +
    +
    +

    If a group matches multiple times, only the last match is accessible:

    +
    >>> m = re.match(r"(..)+", "a1b2c3")  # Matches 3 times.
    +>>> m.group(1)                        # Returns only the last match.
    +'c3'
    +
    +
    +
    + +
    +
    +Match.__getitem__(g)
    +

    This is identical to m.group(g). This allows easier access to +an individual group from a match:

    +
    >>> m = re.match(r"(\w+) (\w+)", "Isaac Newton, physicist")
    +>>> m[0]       # The entire match
    +'Isaac Newton'
    +>>> m[1]       # The first parenthesized subgroup.
    +'Isaac'
    +>>> m[2]       # The second parenthesized subgroup.
    +'Newton'
    +
    +
    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +Match.groups(default=None)
    +

    Return a tuple containing all the subgroups of the match, from 1 up to however +many groups are in the pattern. The default argument is used for groups that +did not participate in the match; it defaults to None.

    +

    For example:

    +
    >>> m = re.match(r"(\d+)\.(\d+)", "24.1632")
    +>>> m.groups()
    +('24', '1632')
    +
    +
    +

    If we make the decimal place and everything after it optional, not all groups +might participate in the match. These groups will default to None unless +the default argument is given:

    +
    >>> m = re.match(r"(\d+)\.?(\d+)?", "24")
    +>>> m.groups()      # Second group defaults to None.
    +('24', None)
    +>>> m.groups('0')   # Now, the second group defaults to '0'.
    +('24', '0')
    +
    +
    +
    + +
    +
    +Match.groupdict(default=None)
    +

    Return a dictionary containing all the named subgroups of the match, keyed by +the subgroup name. The default argument is used for groups that did not +participate in the match; it defaults to None. For example:

    +
    >>> m = re.match(r"(?P<first_name>\w+) (?P<last_name>\w+)", "Malcolm Reynolds")
    +>>> m.groupdict()
    +{'first_name': 'Malcolm', 'last_name': 'Reynolds'}
    +
    +
    +
    + +
    +
    +Match.start([group])
    +
    +Match.end([group])
    +

    Return the indices of the start and end of the substring matched by group; +group defaults to zero (meaning the whole matched substring). Return -1 if +group exists but did not contribute to the match. For a match object m, and +a group g that did contribute to the match, the substring matched by group g +(equivalent to m.group(g)) is

    +
    m.string[m.start(g):m.end(g)]
    +
    +
    +

    Note that m.start(group) will equal m.end(group) if group matched a +null string. For example, after m = re.search('b(c?)', 'cba'), +m.start(0) is 1, m.end(0) is 2, m.start(1) and m.end(1) are both +2, and m.start(2) raises an IndexError exception.

    +

    An example that will remove remove_this from email addresses:

    +
    >>> email = "tony@tiremove_thisger.net"
    +>>> m = re.search("remove_this", email)
    +>>> email[:m.start()] + email[m.end():]
    +'tony@tiger.net'
    +
    +
    +
    + +
    +
    +Match.span([group])
    +

    For a match m, return the 2-tuple (m.start(group), m.end(group)). Note +that if group did not contribute to the match, this is (-1, -1). +group defaults to zero, the entire match.

    +
    + +
    +
    +Match.pos
    +

    The value of pos which was passed to the search() or +match() method of a regex object. This is +the index into the string at which the RE engine started looking for a match.

    +
    + +
    +
    +Match.endpos
    +

    The value of endpos which was passed to the search() or +match() method of a regex object. This is +the index into the string beyond which the RE engine will not go.

    +
    + +
    +
    +Match.lastindex
    +

    The integer index of the last matched capturing group, or None if no group +was matched at all. For example, the expressions (a)b, ((a)(b)), and +((ab)) will have lastindex == 1 if applied to the string 'ab', while +the expression (a)(b) will have lastindex == 2, if applied to the same +string.

    +
    + +
    +
    +Match.lastgroup
    +

    The name of the last matched capturing group, or None if the group didn’t +have a name, or if no group was matched at all.

    +
    + +
    +
    +Match.re
    +

    The regular expression object whose match() or +search() method produced this match instance.

    +
    + +
    +
    +Match.string
    +

    The string passed to match() or search().

    +
    + +
    +

    Changed in version 3.7: Added support of copy.copy() and copy.deepcopy(). Match objects +are considered atomic.

    +
    +
    +
    +

    Regular Expression Examples

    +
    +

    Checking for a Pair

    +

    In this example, we’ll use the following helper function to display match +objects a little more gracefully:

    +
    def displaymatch(match):
    +    if match is None:
    +        return None
    +    return '<Match: %r, groups=%r>' % (match.group(), match.groups())
    +
    +
    +

    Suppose you are writing a poker program where a player’s hand is represented as +a 5-character string with each character representing a card, “a” for ace, “k” +for king, “q” for queen, “j” for jack, “t” for 10, and “2” through “9” +representing the card with that value.

    +

    To see if a given string is a valid hand, one could do the following:

    +
    >>> valid = re.compile(r"^[a2-9tjqk]{5}$")
    +>>> displaymatch(valid.match("akt5q"))  # Valid.
    +"<Match: 'akt5q', groups=()>"
    +>>> displaymatch(valid.match("akt5e"))  # Invalid.
    +>>> displaymatch(valid.match("akt"))    # Invalid.
    +>>> displaymatch(valid.match("727ak"))  # Valid.
    +"<Match: '727ak', groups=()>"
    +
    +
    +

    That last hand, "727ak", contained a pair, or two of the same valued cards. +To match this with a regular expression, one could use backreferences as such:

    +
    >>> pair = re.compile(r".*(.).*\1")
    +>>> displaymatch(pair.match("717ak"))     # Pair of 7s.
    +"<Match: '717', groups=('7',)>"
    +>>> displaymatch(pair.match("718ak"))     # No pairs.
    +>>> displaymatch(pair.match("354aa"))     # Pair of aces.
    +"<Match: '354aa', groups=('a',)>"
    +
    +
    +

    To find out what card the pair consists of, one could use the +group() method of the match object in the following manner:

    +
    >>> pair.match("717ak").group(1)
    +'7'
    +
    +# Error because re.match() returns None, which doesn't have a group() method:
    +>>> pair.match("718ak").group(1)
    +Traceback (most recent call last):
    +  File "<pyshell#23>", line 1, in <module>
    +    re.match(r".*(.).*\1", "718ak").group(1)
    +AttributeError: 'NoneType' object has no attribute 'group'
    +
    +>>> pair.match("354aa").group(1)
    +'a'
    +
    +
    +
    +
    +

    Simulating scanf()

    +

    Python does not currently have an equivalent to scanf(). Regular +expressions are generally more powerful, though also more verbose, than +scanf() format strings. The table below offers some more-or-less +equivalent mappings between scanf() format tokens and regular +expressions.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    scanf() Token

    Regular Expression

    %c

    .

    %5c

    .{5}

    %d

    [-+]?\d+

    %e, %E, %f, %g

    [-+]?(\d+(\.\d*)?|\.\d+)([eE][-+]?\d+)?

    %i

    [-+]?(0[xX][\dA-Fa-f]+|0[0-7]*|\d+)

    %o

    [-+]?[0-7]+

    %s

    \S+

    %u

    \d+

    %x, %X

    [-+]?(0[xX])?[\dA-Fa-f]+

    +

    To extract the filename and numbers from a string like

    +
    /usr/sbin/sendmail - 0 errors, 4 warnings
    +
    +
    +

    you would use a scanf() format like

    +
    %s - %d errors, %d warnings
    +
    +
    +

    The equivalent regular expression would be

    +
    (\S+) - (\d+) errors, (\d+) warnings
    +
    +
    +
    +
    +

    search() vs. match()

    +

    Python offers two different primitive operations based on regular expressions: +re.match() checks for a match only at the beginning of the string, while +re.search() checks for a match anywhere in the string (this is what Perl +does by default).

    +

    For example:

    +
    >>> re.match("c", "abcdef")    # No match
    +>>> re.search("c", "abcdef")   # Match
    +<re.Match object; span=(2, 3), match='c'>
    +
    +
    +

    Regular expressions beginning with '^' can be used with search() to +restrict the match at the beginning of the string:

    +
    >>> re.match("c", "abcdef")    # No match
    +>>> re.search("^c", "abcdef")  # No match
    +>>> re.search("^a", "abcdef")  # Match
    +<re.Match object; span=(0, 1), match='a'>
    +
    +
    +

    Note however that in MULTILINE mode match() only matches at the +beginning of the string, whereas using search() with a regular expression +beginning with '^' will match at the beginning of each line.

    +
    >>> re.match('X', 'A\nB\nX', re.MULTILINE)  # No match
    +>>> re.search('^X', 'A\nB\nX', re.MULTILINE)  # Match
    +<re.Match object; span=(4, 5), match='X'>
    +
    +
    +
    +
    +

    Making a Phonebook

    +

    split() splits a string into a list delimited by the passed pattern. The +method is invaluable for converting textual data into data structures that can be +easily read and modified by Python as demonstrated in the following example that +creates a phonebook.

    +

    First, here is the input. Normally it may come from a file, here we are using +triple-quoted string syntax:

    +
    >>> text = """Ross McFluff: 834.345.1254 155 Elm Street
    +...
    +... Ronald Heathmore: 892.345.3428 436 Finley Avenue
    +... Frank Burger: 925.541.7625 662 South Dogwood Way
    +...
    +...
    +... Heather Albrecht: 548.326.4584 919 Park Place"""
    +
    +
    +

    The entries are separated by one or more newlines. Now we convert the string +into a list with each nonempty line having its own entry:

    +
    >>> entries = re.split("\n+", text)
    +>>> entries
    +['Ross McFluff: 834.345.1254 155 Elm Street',
    +'Ronald Heathmore: 892.345.3428 436 Finley Avenue',
    +'Frank Burger: 925.541.7625 662 South Dogwood Way',
    +'Heather Albrecht: 548.326.4584 919 Park Place']
    +
    +
    +

    Finally, split each entry into a list with first name, last name, telephone +number, and address. We use the maxsplit parameter of split() +because the address has spaces, our splitting pattern, in it:

    +
    >>> [re.split(":? ", entry, 3) for entry in entries]
    +[['Ross', 'McFluff', '834.345.1254', '155 Elm Street'],
    +['Ronald', 'Heathmore', '892.345.3428', '436 Finley Avenue'],
    +['Frank', 'Burger', '925.541.7625', '662 South Dogwood Way'],
    +['Heather', 'Albrecht', '548.326.4584', '919 Park Place']]
    +
    +
    +

    The :? pattern matches the colon after the last name, so that it does not +occur in the result list. With a maxsplit of 4, we could separate the +house number from the street name:

    +
    >>> [re.split(":? ", entry, 4) for entry in entries]
    +[['Ross', 'McFluff', '834.345.1254', '155', 'Elm Street'],
    +['Ronald', 'Heathmore', '892.345.3428', '436', 'Finley Avenue'],
    +['Frank', 'Burger', '925.541.7625', '662', 'South Dogwood Way'],
    +['Heather', 'Albrecht', '548.326.4584', '919', 'Park Place']]
    +
    +
    +
    +
    +

    Text Munging

    +

    sub() replaces every occurrence of a pattern with a string or the +result of a function. This example demonstrates using sub() with +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)
    +>>> text = "Professor Abdolmalek, please report your absences promptly."
    +>>> re.sub(r"(\w)(\w+)(\w)", repl, text)
    +'Poefsrosr Aealmlobdk, pslaee reorpt your abnseces plmrptoy.'
    +>>> re.sub(r"(\w)(\w+)(\w)", repl, text)
    +'Pofsroser Aodlambelk, plasee reoprt yuor asnebces potlmrpy.'
    +
    +
    +
    +
    +

    Finding all Adverbs

    +

    findall() matches all occurrences of a pattern, not just the first +one as search() does. For example, if a writer wanted to +find all of the adverbs in some text, they might use findall() in +the following manner:

    +
    >>> text = "He was carefully disguised but captured quickly by police."
    +>>> re.findall(r"\w+ly", text)
    +['carefully', 'quickly']
    +
    +
    +
    +
    +

    Finding all Adverbs and their Positions

    +

    If one wants more information about all matches of a pattern than the matched +text, finditer() is useful as it provides match objects instead of strings. Continuing with the previous example, if +a writer wanted to find all of the adverbs and their positions in +some text, they would use finditer() in the following manner:

    +
    >>> text = "He was carefully disguised but captured quickly by police."
    +>>> for m in re.finditer(r"\w+ly", text):
    +...     print('%02d-%02d: %s' % (m.start(), m.end(), m.group(0)))
    +07-16: carefully
    +40-47: quickly
    +
    +
    +
    +
    +

    Raw String Notation

    +

    Raw string notation (r"text") keeps regular expressions sane. Without it, +every backslash ('\') in a regular expression would have to be prefixed with +another one to escape it. For example, the two following lines of code are +functionally identical:

    +
    >>> re.match(r"\W(.)\1\W", " ff ")
    +<re.Match object; span=(0, 4), match=' ff '>
    +>>> re.match("\\W(.)\\1\\W", " ff ")
    +<re.Match object; span=(0, 4), match=' ff '>
    +
    +
    +

    When one wants to match a literal backslash, it must be escaped in the regular +expression. With raw string notation, this means r"\\". Without raw string +notation, one must use "\\\\", making the following lines of code +functionally identical:

    +
    >>> re.match(r"\\", r"\\")
    +<re.Match object; span=(0, 1), match='\\'>
    +>>> re.match("\\\\", r"\\")
    +<re.Match object; span=(0, 1), match='\\'>
    +
    +
    +
    +
    +

    Writing a Tokenizer

    +

    A tokenizer or scanner +analyzes a string to categorize groups of characters. This is a useful first +step in writing a compiler or interpreter.

    +

    The text categories are specified with regular expressions. The technique is +to combine those into a single master regular expression and to loop over +successive matches:

    +
    import collections
    +import re
    +
    +Token = collections.namedtuple('Token', ['type', 'value', 'line', 'column'])
    +
    +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
    +    ]
    +    tok_regex = '|'.join('(?P<%s>%s)' % pair for pair in token_specification)
    +    line_num = 1
    +    line_start = 0
    +    for mo in re.finditer(tok_regex, code):
    +        kind = mo.lastgroup
    +        value = mo.group()
    +        column = mo.start() - line_start
    +        if kind == 'NUMBER':
    +            value = float(value) if '.' in value else int(value)
    +        elif kind == 'ID' and value in keywords:
    +            kind = value
    +        elif kind == 'NEWLINE':
    +            line_start = mo.end()
    +            line_num += 1
    +            continue
    +        elif kind == 'SKIP':
    +            continue
    +        elif kind == 'MISMATCH':
    +            raise RuntimeError(f'{value!r} unexpected on line {line_num}')
    +        yield Token(kind, value, line_num, column)
    +
    +statements = '''
    +    IF quantity THEN
    +        total := total + price * quantity;
    +        tax := price * 0.05;
    +    ENDIF;
    +'''
    +
    +for token in tokenize(statements):
    +    print(token)
    +
    +
    +

    The tokenizer produces the following output:

    +
    Token(type='IF', value='IF', line=2, column=4)
    +Token(type='ID', value='quantity', line=2, column=7)
    +Token(type='THEN', value='THEN', line=2, column=16)
    +Token(type='ID', value='total', line=3, column=8)
    +Token(type='ASSIGN', value=':=', line=3, column=14)
    +Token(type='ID', value='total', line=3, column=17)
    +Token(type='OP', value='+', line=3, column=23)
    +Token(type='ID', value='price', line=3, column=25)
    +Token(type='OP', value='*', line=3, column=31)
    +Token(type='ID', value='quantity', line=3, column=33)
    +Token(type='END', value=';', line=3, column=41)
    +Token(type='ID', value='tax', line=4, column=8)
    +Token(type='ASSIGN', value=':=', line=4, column=12)
    +Token(type='ID', value='price', line=4, column=15)
    +Token(type='OP', value='*', line=4, column=21)
    +Token(type='NUMBER', value=0.05, line=4, column=23)
    +Token(type='END', value=';', line=4, column=27)
    +Token(type='ENDIF', value='ENDIF', line=5, column=4)
    +Token(type='END', value=';', line=5, column=9)
    +
    +
    +
    +
    Frie09
    +

    Friedl, Jeffrey. Mastering Regular Expressions. 3rd ed., O’Reilly +Media, 2009. The third edition of the book no longer covers Python at all, +but the first edition covered writing good regular expression patterns in +great detail.

    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/readline.html b/python-3.7.4-docs-html/library/readline.html new file mode 100644 index 0000000..fea2def --- /dev/null +++ b/python-3.7.4-docs-html/library/readline.html @@ -0,0 +1,556 @@ + + + + + + + readline — GNU readline interface — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    readline — GNU readline interface

    +
    +

    The readline module defines a number of functions to facilitate +completion and reading/writing of history files from the Python interpreter. +This module can be used directly, or via the rlcompleter module, which +supports completion of Python identifiers at the interactive prompt. Settings +made using this module affect the behaviour of both the interpreter’s +interactive prompt and the prompts offered by the built-in input() +function.

    +

    Readline keybindings may be configured via an initialization file, typically +.inputrc in your home directory. See Readline Init File +in the GNU Readline manual for information about the format and +allowable constructs of that file, and the capabilities of the +Readline library in general.

    +
    +

    Note

    +

    The underlying Readline library API may be implemented by +the libedit library instead of GNU readline. +On macOS the readline module detects which library is being used +at run time.

    +

    The configuration file for libedit is different from that +of GNU readline. If you programmatically load configuration strings +you can check for the text “libedit” in readline.__doc__ +to differentiate between GNU readline and libedit.

    +

    If you use editline/libedit readline emulation on macOS, the +initialization file located in your home directory is named +.editrc. For example, the following content in ~/.editrc will +turn ON vi keybindings and TAB completion:

    +
    python:bind -v
    +python:bind ^I rl_complete
    +
    +
    +
    +
    +

    Init file

    +

    The following functions relate to the init file and user configuration:

    +
    +
    +readline.parse_and_bind(string)
    +

    Execute the init line provided in the string argument. This calls +rl_parse_and_bind() in the underlying library.

    +
    + +
    +
    +readline.read_init_file([filename])
    +

    Execute a readline initialization file. The default filename is the last filename +used. This calls rl_read_init_file() in the underlying library.

    +
    + +
    +
    +

    Line buffer

    +

    The following functions operate on the line buffer:

    +
    +
    +readline.get_line_buffer()
    +

    Return the current contents of the line buffer (rl_line_buffer +in the underlying library).

    +
    + +
    +
    +readline.insert_text(string)
    +

    Insert text into the line buffer at the cursor position. This calls +rl_insert_text() in the underlying library, but ignores +the return value.

    +
    + +
    +
    +readline.redisplay()
    +

    Change what’s displayed on the screen to reflect the current contents of the +line buffer. This calls rl_redisplay() in the underlying library.

    +
    + +
    +
    +

    History file

    +

    The following functions operate on a history file:

    +
    +
    +readline.read_history_file([filename])
    +

    Load a readline history file, and append it to the history list. +The default filename is ~/.history. This calls +read_history() in the underlying library.

    +
    + +
    +
    +readline.write_history_file([filename])
    +

    Save the history list to a readline history file, overwriting any +existing file. The default filename is ~/.history. This calls +write_history() in the underlying library.

    +
    + +
    +
    +readline.append_history_file(nelements[, filename])
    +

    Append the last nelements items of history to a file. The default filename is +~/.history. The file must already exist. This calls +append_history() in the underlying library. This function +only exists if Python was compiled for a version of the library +that supports it.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +readline.get_history_length()
    +
    +readline.set_history_length(length)
    +

    Set or return the desired number of lines to save in the history file. +The write_history_file() function uses this value to truncate +the history file, by calling history_truncate_file() in +the underlying library. Negative values imply +unlimited history file size.

    +
    + +
    +
    +

    History list

    +

    The following functions operate on a global history list:

    +
    +
    +readline.clear_history()
    +

    Clear the current history. This calls clear_history() in the +underlying library. The Python function only exists if Python was +compiled for a version of the library that supports it.

    +
    + +
    +
    +readline.get_current_history_length()
    +

    Return the number of items currently in the history. (This is different from +get_history_length(), which returns the maximum number of lines that will +be written to a history file.)

    +
    + +
    +
    +readline.get_history_item(index)
    +

    Return the current contents of history item at index. The item index +is one-based. This calls history_get() in the underlying library.

    +
    + +
    +
    +readline.remove_history_item(pos)
    +

    Remove history item specified by its position from the history. +The position is zero-based. This calls remove_history() in +the underlying library.

    +
    + +
    +
    +readline.replace_history_item(pos, line)
    +

    Replace history item specified by its position with line. +The position is zero-based. This calls replace_history_entry() +in the underlying library.

    +
    + +
    +
    +readline.add_history(line)
    +

    Append line to the history buffer, as if it was the last line typed. +This calls add_history() in the underlying library.

    +
    + +
    +
    +readline.set_auto_history(enabled)
    +

    Enable or disable automatic calls to add_history() when reading +input via readline. The enabled argument should be a Boolean value +that when true, enables auto history, and that when false, disables +auto history.

    +
    +

    New in version 3.6.

    +
    +
    +

    CPython implementation detail: Auto history is enabled by default, and changes to this do not persist +across multiple sessions.

    +
    +
    + +
    +
    +

    Startup hooks

    +
    +
    +readline.set_startup_hook([function])
    +

    Set or remove the function invoked by the rl_startup_hook +callback of the underlying library. If function is specified, it will +be used as the new hook function; if omitted or None, any function +already installed is removed. The hook is called with no +arguments just before readline prints the first prompt.

    +
    + +
    +
    +readline.set_pre_input_hook([function])
    +

    Set or remove the function invoked by the rl_pre_input_hook +callback of the underlying library. If function is specified, it will +be used as the new hook function; if omitted or None, any +function already installed is removed. The hook is called +with no arguments after the first prompt has been printed and just before +readline starts reading input characters. This function only exists +if Python was compiled for a version of the library that supports it.

    +
    + +
    +
    +

    Completion

    +

    The following functions relate to implementing a custom word completion +function. This is typically operated by the Tab key, and can suggest and +automatically complete a word being typed. By default, Readline is set up +to be used by rlcompleter to complete Python identifiers for +the interactive interpreter. If the readline module is to be used +with a custom completer, a different set of word delimiters should be set.

    +
    +
    +readline.set_completer([function])
    +

    Set or remove the completer function. If function is specified, it will be +used as the new completer function; if omitted or None, any completer +function already installed is removed. The completer function is called as +function(text, state), for state in 0, 1, 2, …, until it +returns a non-string value. It should return the next possible completion +starting with text.

    +

    The installed completer function is invoked by the entry_func callback +passed to rl_completion_matches() in the underlying library. +The text string comes from the first parameter to the +rl_attempted_completion_function callback of the +underlying library.

    +
    + +
    +
    +readline.get_completer()
    +

    Get the completer function, or None if no completer function has been set.

    +
    + +
    +
    +readline.get_completion_type()
    +

    Get the type of completion being attempted. This returns the +rl_completion_type variable in the underlying library as +an integer.

    +
    + +
    +
    +readline.get_begidx()
    +
    +readline.get_endidx()
    +

    Get the beginning or ending index of the completion scope. +These indexes are the start and end arguments passed to the +rl_attempted_completion_function callback of the +underlying library.

    +
    + +
    +
    +readline.set_completer_delims(string)
    +
    +readline.get_completer_delims()
    +

    Set or get the word delimiters for completion. These determine the +start of the word to be considered for completion (the completion scope). +These functions access the rl_completer_word_break_characters +variable in the underlying library.

    +
    + +
    +
    +readline.set_completion_display_matches_hook([function])
    +

    Set or remove the completion display function. If function is +specified, it will be used as the new completion display function; +if omitted or None, any completion display function already +installed is removed. This sets or clears the +rl_completion_display_matches_hook callback in the +underlying library. The completion display function is called as +function(substitution, [matches], longest_match_length) once +each time matches need to be displayed.

    +
    + +
    +
    +

    Example

    +

    The following example demonstrates how to use the readline module’s +history reading and writing functions to automatically load and save a history +file named .python_history from the user’s home directory. The code +below would normally be executed automatically during interactive sessions +from the user’s PYTHONSTARTUP file.

    +
    import atexit
    +import os
    +import readline
    +
    +histfile = os.path.join(os.path.expanduser("~"), ".python_history")
    +try:
    +    readline.read_history_file(histfile)
    +    # default history len is -1 (infinite), which may grow unruly
    +    readline.set_history_length(1000)
    +except FileNotFoundError:
    +    pass
    +
    +atexit.register(readline.write_history_file, histfile)
    +
    +
    +

    This code is actually automatically run when Python is run in +interactive mode (see Readline configuration).

    +

    The following example achieves the same goal but supports concurrent interactive +sessions, by only appending the new history.

    +
    import atexit
    +import os
    +import readline
    +histfile = os.path.join(os.path.expanduser("~"), ".python_history")
    +
    +try:
    +    readline.read_history_file(histfile)
    +    h_len = readline.get_current_history_length()
    +except FileNotFoundError:
    +    open(histfile, 'wb').close()
    +    h_len = 0
    +
    +def save(prev_h_len, histfile):
    +    new_h_len = readline.get_current_history_length()
    +    readline.set_history_length(1000)
    +    readline.append_history_file(new_h_len - prev_h_len, histfile)
    +atexit.register(save, h_len, histfile)
    +
    +
    +

    The following example extends the code.InteractiveConsole class to +support history save/restore.

    +
    import atexit
    +import code
    +import os
    +import readline
    +
    +class HistoryConsole(code.InteractiveConsole):
    +    def __init__(self, locals=None, filename="<console>",
    +                 histfile=os.path.expanduser("~/.console-history")):
    +        code.InteractiveConsole.__init__(self, locals, filename)
    +        self.init_history(histfile)
    +
    +    def init_history(self, histfile):
    +        readline.parse_and_bind("tab: complete")
    +        if hasattr(readline, "read_history_file"):
    +            try:
    +                readline.read_history_file(histfile)
    +            except FileNotFoundError:
    +                pass
    +            atexit.register(self.save_history, histfile)
    +
    +    def save_history(self, histfile):
    +        readline.set_history_length(1000)
    +        readline.write_history_file(histfile)
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/reprlib.html b/python-3.7.4-docs-html/library/reprlib.html new file mode 100644 index 0000000..3d32257 --- /dev/null +++ b/python-3.7.4-docs-html/library/reprlib.html @@ -0,0 +1,353 @@ + + + + + + + reprlib — Alternate repr() implementation — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    reprlib — Alternate repr() implementation

    +

    Source code: Lib/reprlib.py

    +
    +

    The reprlib module provides a means for producing object representations +with limits on the size of the resulting strings. This is used in the Python +debugger and may be useful in other contexts as well.

    +

    This module provides a class, an instance, and a function:

    +
    +
    +class reprlib.Repr
    +

    Class which provides formatting services useful in implementing functions +similar to the built-in repr(); size limits for different object types +are added to avoid the generation of representations which are excessively long.

    +
    + +
    +
    +reprlib.aRepr
    +

    This is an instance of Repr which is used to provide the +repr() function described below. Changing the attributes of this +object will affect the size limits used by repr() and the Python +debugger.

    +
    + +
    +
    +reprlib.repr(obj)
    +

    This is the repr() method of aRepr. It returns a string +similar to that returned by the built-in function of the same name, but with +limits on most sizes.

    +
    + +

    In addition to size-limiting tools, the module also provides a decorator for +detecting recursive calls to __repr__() and substituting a placeholder +string instead.

    +
    +
    +@reprlib.recursive_repr(fillvalue="...")
    +

    Decorator for __repr__() methods to detect recursive calls within the +same thread. If a recursive call is made, the fillvalue is returned, +otherwise, the usual __repr__() call is made. For example:

    +
    >>> from reprlib import recursive_repr
    +>>> class MyList(list):
    +...     @recursive_repr()
    +...     def __repr__(self):
    +...         return '<' + '|'.join(map(repr, self)) + '>'
    +...
    +>>> m = MyList('abc')
    +>>> m.append(m)
    +>>> m.append('x')
    +>>> print(m)
    +<'a'|'b'|'c'|...|'x'>
    +
    +
    +
    +

    New in version 3.2.

    +
    +
    + +
    +

    Repr Objects

    +

    Repr instances provide several attributes which can be used to provide +size limits for the representations of different object types, and methods +which format specific object types.

    +
    +
    +Repr.maxlevel
    +

    Depth limit on the creation of recursive representations. The default is 6.

    +
    + +
    +
    +Repr.maxdict
    +
    +Repr.maxlist
    +
    +Repr.maxtuple
    +
    +Repr.maxset
    +
    +Repr.maxfrozenset
    +
    +Repr.maxdeque
    +
    +Repr.maxarray
    +

    Limits on the number of entries represented for the named object type. The +default is 4 for maxdict, 5 for maxarray, and 6 for +the others.

    +
    + +
    +
    +Repr.maxlong
    +

    Maximum number of characters in the representation for an integer. Digits +are dropped from the middle. The default is 40.

    +
    + +
    +
    +Repr.maxstring
    +

    Limit on the number of characters in the representation of the string. Note +that the “normal” representation of the string is used as the character source: +if escape sequences are needed in the representation, these may be mangled when +the representation is shortened. The default is 30.

    +
    + +
    +
    +Repr.maxother
    +

    This limit is used to control the size of object types for which no specific +formatting method is available on the Repr object. It is applied in a +similar manner as maxstring. The default is 20.

    +
    + +
    +
    +Repr.repr(obj)
    +

    The equivalent to the built-in repr() that uses the formatting imposed by +the instance.

    +
    + +
    +
    +Repr.repr1(obj, level)
    +

    Recursive implementation used by repr(). This uses the type of obj to +determine which formatting method to call, passing it obj and level. The +type-specific methods should call repr1() to perform recursive formatting, +with level - 1 for the value of level in the recursive call.

    +
    + +
    +
    +Repr.repr_TYPE(obj, level)
    +

    Formatting methods for specific types are implemented as methods with a name +based on the type name. In the method name, TYPE is replaced by +'_'.join(type(obj).__name__.split()). Dispatch to these methods is +handled by repr1(). Type-specific methods which need to recursively +format a value should call self.repr1(subobj, level - 1).

    +
    + +
    +
    +

    Subclassing Repr Objects

    +

    The use of dynamic dispatching by Repr.repr1() allows subclasses of +Repr to add support for additional built-in object types or to modify +the handling of types already supported. This example shows how special support +for file objects could be added:

    +
    import reprlib
    +import sys
    +
    +class MyRepr(reprlib.Repr):
    +
    +    def repr_TextIOWrapper(self, obj, level):
    +        if obj.name in {'<stdin>', '<stdout>', '<stderr>'}:
    +            return obj.name
    +        return repr(obj)
    +
    +aRepr = MyRepr()
    +print(aRepr.repr(sys.stdin))         # prints '<stdin>'
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/resource.html b/python-3.7.4-docs-html/library/resource.html new file mode 100644 index 0000000..1515d0f --- /dev/null +++ b/python-3.7.4-docs-html/library/resource.html @@ -0,0 +1,592 @@ + + + + + + + resource — Resource usage information — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    resource — Resource usage information

    +
    +

    This module provides basic mechanisms for measuring and controlling system +resources utilized by a program.

    +

    Symbolic constants are used to specify particular system resources and to +request usage information about either the current process or its children.

    +

    An OSError is raised on syscall failure.

    +
    +
    +exception resource.error
    +

    A deprecated alias of OSError.

    +
    +

    Changed in version 3.3: Following PEP 3151, this class was made an alias of OSError.

    +
    +
    + +
    +

    Resource Limits

    +

    Resources usage can be limited using the setrlimit() function described +below. Each resource is controlled by a pair of limits: a soft limit and a hard +limit. The soft limit is the current limit, and may be lowered or raised by a +process over time. The soft limit can never exceed the hard limit. The hard +limit can be lowered to any value greater than the soft limit, but not raised. +(Only processes with the effective UID of the super-user can raise a hard +limit.)

    +

    The specific resources that can be limited are system dependent. They are +described in the getrlimit(2) man page. The resources listed below +are supported when the underlying operating system supports them; resources +which cannot be checked or controlled by the operating system are not defined in +this module for those platforms.

    +
    +
    +resource.RLIM_INFINITY
    +

    Constant used to represent the limit for an unlimited resource.

    +
    + +
    +
    +resource.getrlimit(resource)
    +

    Returns a tuple (soft, hard) with the current soft and hard limits of +resource. Raises ValueError if an invalid resource is specified, or +error if the underlying system call fails unexpectedly.

    +
    + +
    +
    +resource.setrlimit(resource, limits)
    +

    Sets new limits of consumption of resource. The limits argument must be a +tuple (soft, hard) of two integers describing the new limits. A value of +RLIM_INFINITY can be used to request a limit that is +unlimited.

    +

    Raises ValueError if an invalid resource is specified, if the new soft +limit exceeds the hard limit, or if a process tries to raise its hard limit. +Specifying a limit of RLIM_INFINITY when the hard or +system limit for that resource is not unlimited will result in a +ValueError. A process with the effective UID of super-user can +request any valid limit value, including unlimited, but ValueError +will still be raised if the requested limit exceeds the system imposed +limit.

    +

    setrlimit may also raise error if the underlying system call +fails.

    +
    + +
    +
    +resource.prlimit(pid, resource[, limits])
    +

    Combines setrlimit() and getrlimit() in one function and +supports to get and set the resources limits of an arbitrary process. If +pid is 0, then the call applies to the current process. resource and +limits have the same meaning as in setrlimit(), except that +limits is optional.

    +

    When limits is not given the function returns the resource limit of the +process pid. When limits is given the resource limit of the process is +set and the former resource limit is returned.

    +

    Raises ProcessLookupError when pid can’t be found and +PermissionError when the user doesn’t have CAP_SYS_RESOURCE for +the process.

    +

    Availability: Linux 2.6.36 or later with glibc 2.13 or later.

    +
    +

    New in version 3.4.

    +
    +
    + +

    These symbols define resources whose consumption can be controlled using the +setrlimit() and getrlimit() functions described below. The values of +these symbols are exactly the constants used by C programs.

    +

    The Unix man page for getrlimit(2) lists the available resources. +Note that not all systems use the same symbol or same value to denote the same +resource. This module does not attempt to mask platform differences — symbols +not defined for a platform will not be available from this module on that +platform.

    +
    +
    +resource.RLIMIT_CORE
    +

    The maximum size (in bytes) of a core file that the current process can create. +This may result in the creation of a partial core file if a larger core would be +required to contain the entire process image.

    +
    + +
    +
    +resource.RLIMIT_CPU
    +

    The maximum amount of processor time (in seconds) that a process can use. If +this limit is exceeded, a SIGXCPU signal is sent to the process. (See +the signal module documentation for information about how to catch this +signal and do something useful, e.g. flush open files to disk.)

    +
    + +
    +
    +resource.RLIMIT_FSIZE
    +

    The maximum size of a file which the process may create.

    +
    + +
    +
    +resource.RLIMIT_DATA
    +

    The maximum size (in bytes) of the process’s heap.

    +
    + +
    +
    +resource.RLIMIT_STACK
    +

    The maximum size (in bytes) of the call stack for the current process. This only +affects the stack of the main thread in a multi-threaded process.

    +
    + +
    +
    +resource.RLIMIT_RSS
    +

    The maximum resident set size that should be made available to the process.

    +
    + +
    +
    +resource.RLIMIT_NPROC
    +

    The maximum number of processes the current process may create.

    +
    + +
    +
    +resource.RLIMIT_NOFILE
    +

    The maximum number of open file descriptors for the current process.

    +
    + +
    +
    +resource.RLIMIT_OFILE
    +

    The BSD name for RLIMIT_NOFILE.

    +
    + +
    +
    +resource.RLIMIT_MEMLOCK
    +

    The maximum address space which may be locked in memory.

    +
    + +
    +
    +resource.RLIMIT_VMEM
    +

    The largest area of mapped memory which the process may occupy.

    +
    + +
    +
    +resource.RLIMIT_AS
    +

    The maximum area (in bytes) of address space which may be taken by the process.

    +
    + +
    +
    +resource.RLIMIT_MSGQUEUE
    +

    The number of bytes that can be allocated for POSIX message queues.

    +

    Availability: Linux 2.6.8 or later.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +resource.RLIMIT_NICE
    +

    The ceiling for the process’s nice level (calculated as 20 - rlim_cur).

    +

    Availability: Linux 2.6.12 or later.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +resource.RLIMIT_RTPRIO
    +

    The ceiling of the real-time priority.

    +

    Availability: Linux 2.6.12 or later.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +resource.RLIMIT_RTTIME
    +

    The time limit (in microseconds) on CPU time that a process can spend +under real-time scheduling without making a blocking syscall.

    +

    Availability: Linux 2.6.25 or later.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +resource.RLIMIT_SIGPENDING
    +

    The number of signals which the process may queue.

    +

    Availability: Linux 2.6.8 or later.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +resource.RLIMIT_SBSIZE
    +

    The maximum size (in bytes) of socket buffer usage for this user. +This limits the amount of network memory, and hence the amount of mbufs, +that this user may hold at any time.

    +

    Availability: FreeBSD 9 or later.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +resource.RLIMIT_SWAP
    +

    The maximum size (in bytes) of the swap space that may be reserved or +used by all of this user id’s processes. +This limit is enforced only if bit 1 of the vm.overcommit sysctl is set. +Please see tuning(7) for a complete description of this sysctl.

    +

    Availability: FreeBSD 9 or later.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +resource.RLIMIT_NPTS
    +

    The maximum number of pseudo-terminals created by this user id.

    +

    Availability: FreeBSD 9 or later.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +

    Resource Usage

    +

    These functions are used to retrieve resource usage information:

    +
    +
    +resource.getrusage(who)
    +

    This function returns an object that describes the resources consumed by either +the current process or its children, as specified by the who parameter. The +who parameter should be specified using one of the RUSAGE_* +constants described below.

    +

    The fields of the return value each describe how a particular system resource +has been used, e.g. amount of time spent running is user mode or number of times +the process was swapped out of main memory. Some values are dependent on the +clock tick internal, e.g. the amount of memory the process is using.

    +

    For backward compatibility, the return value is also accessible as a tuple of 16 +elements.

    +

    The fields ru_utime and ru_stime of the return value are +floating point values representing the amount of time spent executing in user +mode and the amount of time spent executing in system mode, respectively. The +remaining values are integers. Consult the getrusage(2) man page for +detailed information about these values. A brief summary is presented here:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Index

    Field

    Resource

    0

    ru_utime

    time in user mode (float)

    1

    ru_stime

    time in system mode (float)

    2

    ru_maxrss

    maximum resident set size

    3

    ru_ixrss

    shared memory size

    4

    ru_idrss

    unshared memory size

    5

    ru_isrss

    unshared stack size

    6

    ru_minflt

    page faults not requiring I/O

    7

    ru_majflt

    page faults requiring I/O

    8

    ru_nswap

    number of swap outs

    9

    ru_inblock

    block input operations

    10

    ru_oublock

    block output operations

    11

    ru_msgsnd

    messages sent

    12

    ru_msgrcv

    messages received

    13

    ru_nsignals

    signals received

    14

    ru_nvcsw

    voluntary context switches

    15

    ru_nivcsw

    involuntary context switches

    +

    This function will raise a ValueError if an invalid who parameter is +specified. It may also raise error exception in unusual circumstances.

    +
    + +
    +
    +resource.getpagesize()
    +

    Returns the number of bytes in a system page. (This need not be the same as the +hardware page size.)

    +
    + +

    The following RUSAGE_* symbols are passed to the getrusage() +function to specify which processes information should be provided for.

    +
    +
    +resource.RUSAGE_SELF
    +

    Pass to getrusage() to request resources consumed by the calling +process, which is the sum of resources used by all threads in the process.

    +
    + +
    +
    +resource.RUSAGE_CHILDREN
    +

    Pass to getrusage() to request resources consumed by child processes +of the calling process which have been terminated and waited for.

    +
    + +
    +
    +resource.RUSAGE_BOTH
    +

    Pass to getrusage() to request resources consumed by both the current +process and child processes. May not be available on all systems.

    +
    + +
    +
    +resource.RUSAGE_THREAD
    +

    Pass to getrusage() to request resources consumed by the current +thread. May not be available on all systems.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/rlcompleter.html b/python-3.7.4-docs-html/library/rlcompleter.html new file mode 100644 index 0000000..6ff1b46 --- /dev/null +++ b/python-3.7.4-docs-html/library/rlcompleter.html @@ -0,0 +1,233 @@ + + + + + + + rlcompleter — Completion function for GNU readline — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    rlcompleter — Completion function for GNU readline

    +

    Source code: Lib/rlcompleter.py

    +
    +

    The rlcompleter module defines a completion function suitable for the +readline module by completing valid Python identifiers and keywords.

    +

    When this module is imported on a Unix platform with the readline module +available, an instance of the Completer class is automatically created +and its complete() method is set as the readline completer.

    +

    Example:

    +
    >>> import rlcompleter
    +>>> import readline
    +>>> readline.parse_and_bind("tab: complete")
    +>>> readline. <TAB PRESSED>
    +readline.__doc__          readline.get_line_buffer(  readline.read_init_file(
    +readline.__file__         readline.insert_text(      readline.set_completer(
    +readline.__name__         readline.parse_and_bind(
    +>>> readline.
    +
    +
    +

    The rlcompleter module is designed for use with Python’s +interactive mode. Unless Python is run with the +-S option, the module is automatically imported and configured +(see Readline configuration).

    +

    On platforms without readline, the Completer class defined by +this module can still be used for custom purposes.

    +
    +

    Completer Objects

    +

    Completer objects have the following method:

    +
    +
    +Completer.complete(text, state)
    +

    Return the stateth completion for text.

    +

    If called for text that doesn’t include a period character ('.'), it will +complete from names currently defined in __main__, builtins and +keywords (as defined by the keyword module).

    +

    If called for a dotted name, it will try to evaluate anything without obvious +side-effects (functions will not be evaluated, but it can generate calls to +__getattr__()) up to the last part, and find matches for the rest via the +dir() function. Any exception raised during the evaluation of the +expression is caught, silenced and None is returned.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/runpy.html b/python-3.7.4-docs-html/library/runpy.html new file mode 100644 index 0000000..bba354c --- /dev/null +++ b/python-3.7.4-docs-html/library/runpy.html @@ -0,0 +1,331 @@ + + + + + + + runpy — Locating and executing Python modules — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    runpy — Locating and executing Python modules

    +

    Source code: Lib/runpy.py

    +
    +

    The runpy module is used to locate and run Python modules without +importing them first. Its main use is to implement the -m command +line switch that allows scripts to be located using the Python module +namespace rather than the filesystem.

    +

    Note that this is not a sandbox module - all code is executed in the +current process, and any side effects (such as cached imports of other +modules) will remain in place after the functions have returned.

    +

    Furthermore, any functions and classes defined by the executed code are not +guaranteed to work correctly after a runpy function has returned. +If that limitation is not acceptable for a given use case, importlib +is likely to be a more suitable choice than this module.

    +

    The runpy module provides two functions:

    +
    +
    +runpy.run_module(mod_name, init_globals=None, run_name=None, alter_sys=False)
    +

    Execute the code of the specified module and return the resulting module +globals dictionary. The module’s code is first located using the standard +import mechanism (refer to PEP 302 for details) and then executed in a +fresh module namespace.

    +

    The mod_name argument should be an absolute module name. +If the module name refers to a package rather than a normal +module, then that package is imported and the __main__ submodule within +that package is then executed and the resulting module globals dictionary +returned.

    +

    The optional dictionary argument init_globals may be used to pre-populate +the module’s globals dictionary before the code is executed. The supplied +dictionary will not be modified. If any of the special global variables +below are defined in the supplied dictionary, those definitions are +overridden by run_module().

    +

    The special global variables __name__, __spec__, __file__, +__cached__, __loader__ and __package__ are set in the globals +dictionary before the module code is executed (Note that this is a +minimal set of variables - other variables may be set implicitly as an +interpreter implementation detail).

    +

    __name__ is set to run_name if this optional argument is not +None, to mod_name + '.__main__' if the named module is a +package and to the mod_name argument otherwise.

    +

    __spec__ will be set appropriately for the actually imported +module (that is, __spec__.name will always be mod_name or +mod_name + '.__main__, never run_name).

    +

    __file__, __cached__, __loader__ and __package__ are +set as normal based on the module spec.

    +

    If the argument alter_sys is supplied and evaluates to True, +then sys.argv[0] is updated with the value of __file__ and +sys.modules[__name__] is updated with a temporary module object for the +module being executed. Both sys.argv[0] and sys.modules[__name__] +are restored to their original values before the function returns.

    +

    Note that this manipulation of sys is not thread-safe. Other threads +may see the partially initialised module, as well as the altered list of +arguments. It is recommended that the sys module be left alone when +invoking this function from threaded code.

    +
    +

    See also

    +

    The -m option offering equivalent functionality from the +command line.

    +
    +
    +

    Changed in version 3.1: Added ability to execute packages by looking for a __main__ submodule.

    +
    +
    +

    Changed in version 3.2: Added __cached__ global variable (see PEP 3147).

    +
    +
    +

    Changed in version 3.4: Updated to take advantage of the module spec feature added by +PEP 451. This allows __cached__ to be set correctly for modules +run this way, as well as ensuring the real module name is always +accessible as __spec__.name.

    +
    +
    + +
    +
    +runpy.run_path(file_path, init_globals=None, run_name=None)
    +

    Execute the code at the named filesystem location and return the resulting +module globals dictionary. As with a script name supplied to the CPython +command line, the supplied path may refer to a Python source file, a +compiled bytecode file or a valid sys.path entry containing a __main__ +module (e.g. a zipfile containing a top-level __main__.py file).

    +

    For a simple script, the specified code is simply executed in a fresh +module namespace. For a valid sys.path entry (typically a zipfile or +directory), the entry is first added to the beginning of sys.path. The +function then looks for and executes a __main__ module using the +updated path. Note that there is no special protection against invoking +an existing __main__ entry located elsewhere on sys.path if +there is no such module at the specified location.

    +

    The optional dictionary argument init_globals may be used to pre-populate +the module’s globals dictionary before the code is executed. The supplied +dictionary will not be modified. If any of the special global variables +below are defined in the supplied dictionary, those definitions are +overridden by run_path().

    +

    The special global variables __name__, __spec__, __file__, +__cached__, __loader__ and __package__ are set in the globals +dictionary before the module code is executed (Note that this is a +minimal set of variables - other variables may be set implicitly as an +interpreter implementation detail).

    +

    __name__ is set to run_name if this optional argument is not +None and to '<run_path>' otherwise.

    +

    If the supplied path directly references a script file (whether as source +or as precompiled byte code), then __file__ will be set to the +supplied path, and __spec__, __cached__, __loader__ and +__package__ will all be set to None.

    +

    If the supplied path is a reference to a valid sys.path entry, then +__spec__ will be set appropriately for the imported __main__ +module (that is, __spec__.name will always be __main__). +__file__, __cached__, __loader__ and __package__ will be +set as normal based on the module spec.

    +

    A number of alterations are also made to the sys module. Firstly, +sys.path may be altered as described above. sys.argv[0] is updated +with the value of file_path and sys.modules[__name__] is updated +with a temporary module object for the module being executed. All +modifications to items in sys are reverted before the function +returns.

    +

    Note that, unlike run_module(), the alterations made to sys +are not optional in this function as these adjustments are essential to +allowing the execution of sys.path entries. As the thread-safety +limitations still apply, use of this function in threaded code should be +either serialised with the import lock or delegated to a separate process.

    +
    +

    See also

    +

    Interface options for equivalent functionality on the +command line (python path/to/script).

    +
    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.4: Updated to take advantage of the module spec feature added by +PEP 451. This allows __cached__ to be set correctly in the +case where __main__ is imported from a valid sys.path entry rather +than being executed directly.

    +
    +
    + +
    +

    See also

    +
    +
    PEP 338 – Executing modules as scripts

    PEP written and implemented by Nick Coghlan.

    +
    +
    PEP 366 – Main module explicit relative imports

    PEP written and implemented by Nick Coghlan.

    +
    +
    PEP 451 – A ModuleSpec Type for the Import System

    PEP written and implemented by Eric Snow

    +
    +
    +

    Command line and environment - CPython command line details

    +

    The importlib.import_module() function

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/sched.html b/python-3.7.4-docs-html/library/sched.html new file mode 100644 index 0000000..916f709 --- /dev/null +++ b/python-3.7.4-docs-html/library/sched.html @@ -0,0 +1,318 @@ + + + + + + + sched — Event scheduler — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    sched — Event scheduler

    +

    Source code: Lib/sched.py

    +
    +

    The sched module defines a class which implements a general purpose event +scheduler:

    +
    +
    +class sched.scheduler(timefunc=time.monotonic, delayfunc=time.sleep)
    +

    The scheduler class defines a generic interface to scheduling events. +It needs two functions to actually deal with the “outside world” — timefunc +should be callable without arguments, and return a number (the “time”, in any +units whatsoever). The delayfunc function should be callable with one +argument, compatible with the output of timefunc, and should delay that many +time units. delayfunc will also be called with the argument 0 after each +event is run to allow other threads an opportunity to run in multi-threaded +applications.

    +
    +

    Changed in version 3.3: timefunc and delayfunc parameters are optional.

    +
    +
    +

    Changed in version 3.3: scheduler class can be safely used in multi-threaded +environments.

    +
    +
    + +

    Example:

    +
    >>> import sched, time
    +>>> s = sched.scheduler(time.time, time.sleep)
    +>>> def print_time(a='default'):
    +...     print("From print_time", time.time(), a)
    +...
    +>>> def print_some_times():
    +...     print(time.time())
    +...     s.enter(10, 1, print_time)
    +...     s.enter(5, 2, print_time, argument=('positional',))
    +...     s.enter(5, 1, print_time, kwargs={'a': 'keyword'})
    +...     s.run()
    +...     print(time.time())
    +...
    +>>> print_some_times()
    +930343690.257
    +From print_time 930343695.274 positional
    +From print_time 930343695.275 keyword
    +From print_time 930343700.273 default
    +930343700.276
    +
    +
    +
    +

    Scheduler Objects

    +

    scheduler instances have the following methods and attributes:

    +
    +
    +scheduler.enterabs(time, priority, action, argument=(), kwargs={})
    +

    Schedule a new event. The time argument should be a numeric type compatible +with the return value of the timefunc function passed to the constructor. +Events scheduled for the same time will be executed in the order of their +priority. A lower number represents a higher priority.

    +

    Executing the event means executing action(*argument, **kwargs). +argument is a sequence holding the positional arguments for action. +kwargs is a dictionary holding the keyword arguments for action.

    +

    Return value is an event which may be used for later cancellation of the event +(see cancel()).

    +
    +

    Changed in version 3.3: argument parameter is optional.

    +
    +
    +

    New in version 3.3: kwargs parameter was added.

    +
    +
    + +
    +
    +scheduler.enter(delay, priority, action, argument=(), kwargs={})
    +

    Schedule an event for delay more time units. Other than the relative time, the +other arguments, the effect and the return value are the same as those for +enterabs().

    +
    +

    Changed in version 3.3: argument parameter is optional.

    +
    +
    +

    New in version 3.3: kwargs parameter was added.

    +
    +
    + +
    +
    +scheduler.cancel(event)
    +

    Remove the event from the queue. If event is not an event currently in the +queue, this method will raise a ValueError.

    +
    + +
    +
    +scheduler.empty()
    +

    Return true if the event queue is empty.

    +
    + +
    +
    +scheduler.run(blocking=True)
    +

    Run all scheduled events. This method will wait (using the delayfunc() +function passed to the constructor) for the next event, then execute it and so +on until there are no more scheduled events.

    +

    If blocking is false executes the scheduled events due to expire soonest +(if any) and then return the deadline of the next scheduled call in the +scheduler (if any).

    +

    Either action or delayfunc can raise an exception. In either case, the +scheduler will maintain a consistent state and propagate the exception. If an +exception is raised by action, the event will not be attempted in future calls +to run().

    +

    If a sequence of events takes longer to run than the time available before the +next event, the scheduler will simply fall behind. No events will be dropped; +the calling code is responsible for canceling events which are no longer +pertinent.

    +
    +

    New in version 3.3: blocking parameter was added.

    +
    +
    + +
    +
    +scheduler.queue
    +

    Read-only attribute returning a list of upcoming events in the order they +will be run. Each event is shown as a named tuple with the +following fields: time, priority, action, argument, kwargs.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/secrets.html b/python-3.7.4-docs-html/library/secrets.html new file mode 100644 index 0000000..defcf17 --- /dev/null +++ b/python-3.7.4-docs-html/library/secrets.html @@ -0,0 +1,363 @@ + + + + + + + secrets — Generate secure random numbers for managing secrets — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    secrets — Generate secure random numbers for managing secrets

    +
    +

    New in version 3.6.

    +
    +

    Source code: Lib/secrets.py

    +
    +

    The secrets module is used for generating cryptographically strong +random numbers suitable for managing data such as passwords, account +authentication, security tokens, and related secrets.

    +

    In particularly, secrets should be used in preference to the +default pseudo-random number generator in the random module, which +is designed for modelling and simulation, not security or cryptography.

    +
    +

    See also

    +

    PEP 506

    +
    +
    +

    Random numbers

    +

    The secrets module provides access to the most secure source of +randomness that your operating system provides.

    +
    +
    +class secrets.SystemRandom
    +

    A class for generating random numbers using the highest-quality +sources provided by the operating system. See +random.SystemRandom for additional details.

    +
    + +
    +
    +secrets.choice(sequence)
    +

    Return a randomly-chosen element from a non-empty sequence.

    +
    + +
    +
    +secrets.randbelow(n)
    +

    Return a random int in the range [0, n).

    +
    + +
    +
    +secrets.randbits(k)
    +

    Return an int with k random bits.

    +
    + +
    +
    +

    Generating tokens

    +

    The secrets module provides functions for generating secure +tokens, suitable for applications such as password resets, +hard-to-guess URLs, and similar.

    +
    +
    +secrets.token_bytes([nbytes=None])
    +

    Return a random byte string containing nbytes number of bytes. +If nbytes is None or not supplied, a reasonable default is +used.

    +
    >>> token_bytes(16)  
    +b'\xebr\x17D*t\xae\xd4\xe3S\xb6\xe2\xebP1\x8b'
    +
    +
    +
    + +
    +
    +secrets.token_hex([nbytes=None])
    +

    Return a random text string, in hexadecimal. The string has nbytes +random bytes, each byte converted to two hex digits. If nbytes is +None or not supplied, a reasonable default is used.

    +
    >>> token_hex(16)  
    +'f9bf78b9a18ce6d46a0cd2b0b86df9da'
    +
    +
    +
    + +
    +
    +secrets.token_urlsafe([nbytes=None])
    +

    Return a random URL-safe text string, containing nbytes random +bytes. The text is Base64 encoded, so on average each byte results +in approximately 1.3 characters. If nbytes is None or not +supplied, a reasonable default is used.

    +
    >>> token_urlsafe(16)  
    +'Drmhze6EPcv0fN_81Bj-nA'
    +
    +
    +
    + +
    +

    How many bytes should tokens use?

    +

    To be secure against +brute-force attacks, +tokens need to have sufficient randomness. Unfortunately, what is +considered sufficient will necessarily increase as computers get more +powerful and able to make more guesses in a shorter period. As of 2015, +it is believed that 32 bytes (256 bits) of randomness is sufficient for +the typical use-case expected for the secrets module.

    +

    For those who want to manage their own token length, you can explicitly +specify how much randomness is used for tokens by giving an int +argument to the various token_* functions. That argument is taken +as the number of bytes of randomness to use.

    +

    Otherwise, if no argument is provided, or if the argument is None, +the token_* functions will use a reasonable default instead.

    +
    +

    Note

    +

    That default is subject to change at any time, including during +maintenance releases.

    +
    +
    +
    +
    +

    Other functions

    +
    +
    +secrets.compare_digest(a, b)
    +

    Return True if strings a and b are equal, otherwise False, +in such a way as to reduce the risk of +timing attacks. +See hmac.compare_digest() for additional details.

    +
    + +
    +
    +

    Recipes and best practices

    +

    This section shows recipes and best practices for using secrets +to manage a basic level of security.

    +

    Generate an eight-character alphanumeric password:

    +
    import string
    +alphabet = string.ascii_letters + string.digits
    +password = ''.join(choice(alphabet) for i in range(8))
    +
    +
    +
    +

    Note

    +

    Applications should not +store passwords in a recoverable format, +whether plain text or encrypted. They should be salted and hashed +using a cryptographically-strong one-way (irreversible) hash function.

    +
    +

    Generate a ten-character alphanumeric password with at least one +lowercase character, at least one uppercase character, and at least +three digits:

    +
    import string
    +alphabet = string.ascii_letters + string.digits
    +while True:
    +    password = ''.join(choice(alphabet) for i in range(10))
    +    if (any(c.islower() for c in password)
    +            and any(c.isupper() for c in password)
    +            and sum(c.isdigit() for c in password) >= 3):
    +        break
    +
    +
    +

    Generate an XKCD-style passphrase:

    +
    # On standard Linux systems, use a convenient dictionary file.
    +# Other platforms may need to provide their own word-list.
    +with open('/usr/share/dict/words') as f:
    +    words = [word.strip() for word in f]
    +    password = ' '.join(choice(words) for i in range(4))
    +
    +
    +

    Generate a hard-to-guess temporary URL containing a security token +suitable for password recovery applications:

    +
    url = 'https://mydomain.com/reset=' + token_urlsafe()
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/select.html b/python-3.7.4-docs-html/library/select.html new file mode 100644 index 0000000..0a12a09 --- /dev/null +++ b/python-3.7.4-docs-html/library/select.html @@ -0,0 +1,966 @@ + + + + + + + select — Waiting for I/O completion — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    select — Waiting for I/O completion

    +
    +

    This module provides access to the select() and poll() functions +available in most operating systems, devpoll() available on +Solaris and derivatives, epoll() available on Linux 2.5+ and +kqueue() available on most BSD. +Note that on Windows, it only works for sockets; on other operating systems, +it also works for other file types (in particular, on Unix, it works on pipes). +It cannot be used on regular files to determine whether a file has grown since +it was last read.

    +
    +

    Note

    +

    The selectors module allows high-level and efficient I/O +multiplexing, built upon the select module primitives. Users are +encouraged to use the selectors module instead, unless they want +precise control over the OS-level primitives used.

    +
    +

    The module defines the following:

    +
    +
    +exception select.error
    +

    A deprecated alias of OSError.

    +
    +

    Changed in version 3.3: Following PEP 3151, this class was made an alias of OSError.

    +
    +
    + +
    +
    +select.devpoll()
    +

    (Only supported on Solaris and derivatives.) Returns a /dev/poll +polling object; see section /dev/poll Polling Objects below for the +methods supported by devpoll objects.

    +

    devpoll() objects are linked to the number of file +descriptors allowed at the time of instantiation. If your program +reduces this value, devpoll() will fail. If your program +increases this value, devpoll() may return an +incomplete list of active file descriptors.

    +

    The new file descriptor is non-inheritable.

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.4: The new file descriptor is now non-inheritable.

    +
    +
    + +
    +
    +select.epoll(sizehint=-1, flags=0)
    +

    (Only supported on Linux 2.5.44 and newer.) Return an edge polling object, +which can be used as Edge or Level Triggered interface for I/O +events.

    +

    sizehint informs epoll about the expected number of events to be +registered. It must be positive, or -1 to use the default. It is only +used on older systems where epoll_create1() is not available; +otherwise it has no effect (though its value is still checked).

    +

    flags is deprecated and completely ignored. However, when supplied, its +value must be 0 or select.EPOLL_CLOEXEC, otherwise OSError is +raised.

    +

    See the Edge and Level Trigger Polling (epoll) Objects section below for the methods supported by +epolling objects.

    +

    epoll objects support the context management protocol: when used in a +with statement, the new file descriptor is automatically closed +at the end of the block.

    +

    The new file descriptor is non-inheritable.

    +
    +

    Changed in version 3.3: Added the flags parameter.

    +
    +
    +

    Changed in version 3.4: Support for the with statement was added. +The new file descriptor is now non-inheritable.

    +
    +
    +

    Deprecated since version 3.4: The flags parameter. select.EPOLL_CLOEXEC is used by default now. +Use os.set_inheritable() to make the file descriptor inheritable.

    +
    +
    + +
    +
    +select.poll()
    +

    (Not supported by all operating systems.) Returns a polling object, which +supports registering and unregistering file descriptors, and then polling them +for I/O events; see section Polling Objects below for the methods supported +by polling objects.

    +
    + +
    +
    +select.kqueue()
    +

    (Only supported on BSD.) Returns a kernel queue object; see section +Kqueue Objects below for the methods supported by kqueue objects.

    +

    The new file descriptor is non-inheritable.

    +
    +

    Changed in version 3.4: The new file descriptor is now non-inheritable.

    +
    +
    + +
    +
    +select.kevent(ident, filter=KQ_FILTER_READ, flags=KQ_EV_ADD, fflags=0, data=0, udata=0)
    +

    (Only supported on BSD.) Returns a kernel event object; see section +Kevent Objects below for the methods supported by kevent objects.

    +
    + +
    +
    +select.select(rlist, wlist, xlist[, timeout])
    +

    This is a straightforward interface to the Unix select() system call. +The first three arguments are sequences of ‘waitable objects’: either +integers representing file descriptors or objects with a parameterless method +named fileno() returning such an integer:

    +
      +
    • rlist: wait until ready for reading

    • +
    • wlist: wait until ready for writing

    • +
    • xlist: wait for an “exceptional condition” (see the manual page for what +your system considers such a condition)

    • +
    +

    Empty sequences are allowed, but acceptance of three empty sequences is +platform-dependent. (It is known to work on Unix but not on Windows.) The +optional timeout argument specifies a time-out as a floating point number +in seconds. When the timeout argument is omitted the function blocks until +at least one file descriptor is ready. A time-out value of zero specifies a +poll and never blocks.

    +

    The return value is a triple of lists of objects that are ready: subsets of the +first three arguments. When the time-out is reached without a file descriptor +becoming ready, three empty lists are returned.

    +

    Among the acceptable object types in the sequences are Python file +objects (e.g. sys.stdin, or objects returned by +open() or os.popen()), socket objects returned by +socket.socket(). You may also define a wrapper class yourself, +as long as it has an appropriate fileno() method (that +really returns a file descriptor, not just a random integer).

    +
    +

    Note

    +

    File objects on Windows are not acceptable, but sockets are. On Windows, +the underlying select() function is provided by the WinSock +library, and does not handle file descriptors that don’t originate from +WinSock.

    +
    +
    +

    Changed in version 3.5: The function is now retried with a recomputed timeout when interrupted by +a signal, except if the signal handler raises an exception (see +PEP 475 for the rationale), instead of raising +InterruptedError.

    +
    +
    + +
    +
    +select.PIPE_BUF
    +

    The minimum number of bytes which can be written without blocking to a pipe +when the pipe has been reported as ready for writing by select(), +poll() or another interface in this module. This doesn’t apply +to other kind of file-like objects such as sockets.

    +

    This value is guaranteed by POSIX to be at least 512.

    +

    Availability: Unix

    +
    +

    New in version 3.2.

    +
    +
    + +
    +

    /dev/poll Polling Objects

    +

    Solaris and derivatives have /dev/poll. While select() is +O(highest file descriptor) and poll() is O(number of file +descriptors), /dev/poll is O(active file descriptors).

    +

    /dev/poll behaviour is very close to the standard poll() +object.

    +
    +
    +devpoll.close()
    +

    Close the file descriptor of the polling object.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +devpoll.closed
    +

    True if the polling object is closed.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +devpoll.fileno()
    +

    Return the file descriptor number of the polling object.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +devpoll.register(fd[, eventmask])
    +

    Register a file descriptor with the polling object. Future calls to the +poll() method will then check whether the file descriptor has any +pending I/O events. fd can be either an integer, or an object with a +fileno() method that returns an integer. File objects +implement fileno(), so they can also be used as the argument.

    +

    eventmask is an optional bitmask describing the type of events you want to +check for. The constants are the same that with poll() +object. The default value is a combination of the constants POLLIN, +POLLPRI, and POLLOUT.

    +
    +

    Warning

    +

    Registering a file descriptor that’s already registered is not an +error, but the result is undefined. The appropriate action is to +unregister or modify it first. This is an important difference +compared with poll().

    +
    +
    + +
    +
    +devpoll.modify(fd[, eventmask])
    +

    This method does an unregister() followed by a +register(). It is (a bit) more efficient that doing the same +explicitly.

    +
    + +
    +
    +devpoll.unregister(fd)
    +

    Remove a file descriptor being tracked by a polling object. Just like the +register() method, fd can be an integer or an object with a +fileno() method that returns an integer.

    +

    Attempting to remove a file descriptor that was never registered is +safely ignored.

    +
    + +
    +
    +devpoll.poll([timeout])
    +

    Polls the set of registered file descriptors, and returns a possibly-empty list +containing (fd, event) 2-tuples for the descriptors that have events or +errors to report. fd is the file descriptor, and event is a bitmask with +bits set for the reported events for that descriptor — POLLIN for +waiting input, POLLOUT to indicate that the descriptor can be written +to, and so forth. An empty list indicates that the call timed out and no file +descriptors had any events to report. If timeout is given, it specifies the +length of time in milliseconds which the system will wait for events before +returning. If timeout is omitted, -1, or None, the call will +block until there is an event for this poll object.

    +
    +

    Changed in version 3.5: The function is now retried with a recomputed timeout when interrupted by +a signal, except if the signal handler raises an exception (see +PEP 475 for the rationale), instead of raising +InterruptedError.

    +
    +
    + +
    +
    +

    Edge and Level Trigger Polling (epoll) Objects

    +
    +

    https://linux.die.net/man/4/epoll

    +

    eventmask

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Constant

    Meaning

    EPOLLIN

    Available for read

    EPOLLOUT

    Available for write

    EPOLLPRI

    Urgent data for read

    EPOLLERR

    Error condition happened on the assoc. fd

    EPOLLHUP

    Hang up happened on the assoc. fd

    EPOLLET

    Set Edge Trigger behavior, the default is +Level Trigger behavior

    EPOLLONESHOT

    Set one-shot behavior. After one event is +pulled out, the fd is internally disabled

    EPOLLEXCLUSIVE

    Wake only one epoll object when the +associated fd has an event. The default (if +this flag is not set) is to wake all epoll +objects polling on a fd.

    EPOLLRDHUP

    Stream socket peer closed connection or shut +down writing half of connection.

    EPOLLRDNORM

    Equivalent to EPOLLIN

    EPOLLRDBAND

    Priority data band can be read.

    EPOLLWRNORM

    Equivalent to EPOLLOUT

    EPOLLWRBAND

    Priority data may be written.

    EPOLLMSG

    Ignored.

    +
    +

    New in version 3.6: EPOLLEXCLUSIVE was added. It’s only supported by Linux Kernel 4.5 +or later.

    +
    +
    +
    +
    +epoll.close()
    +

    Close the control file descriptor of the epoll object.

    +
    + +
    +
    +epoll.closed
    +

    True if the epoll object is closed.

    +
    + +
    +
    +epoll.fileno()
    +

    Return the file descriptor number of the control fd.

    +
    + +
    +
    +epoll.fromfd(fd)
    +

    Create an epoll object from a given file descriptor.

    +
    + +
    +
    +epoll.register(fd[, eventmask])
    +

    Register a fd descriptor with the epoll object.

    +
    + +
    +
    +epoll.modify(fd, eventmask)
    +

    Modify a registered file descriptor.

    +
    + +
    +
    +epoll.unregister(fd)
    +

    Remove a registered file descriptor from the epoll object.

    +
    + +
    +
    +epoll.poll(timeout=-1, maxevents=-1)
    +

    Wait for events. timeout in seconds (float)

    +
    +

    Changed in version 3.5: The function is now retried with a recomputed timeout when interrupted by +a signal, except if the signal handler raises an exception (see +PEP 475 for the rationale), instead of raising +InterruptedError.

    +
    +
    + +
    +
    +

    Polling Objects

    +

    The poll() system call, supported on most Unix systems, provides better +scalability for network servers that service many, many clients at the same +time. poll() scales better because the system call only requires listing +the file descriptors of interest, while select() builds a bitmap, turns +on bits for the fds of interest, and then afterward the whole bitmap has to be +linearly scanned again. select() is O(highest file descriptor), while +poll() is O(number of file descriptors).

    +
    +
    +poll.register(fd[, eventmask])
    +

    Register a file descriptor with the polling object. Future calls to the +poll() method will then check whether the file descriptor has any +pending I/O events. fd can be either an integer, or an object with a +fileno() method that returns an integer. File objects +implement fileno(), so they can also be used as the argument.

    +

    eventmask is an optional bitmask describing the type of events you want to +check for, and can be a combination of the constants POLLIN, +POLLPRI, and POLLOUT, described in the table below. If not +specified, the default value used will check for all 3 types of events.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Constant

    Meaning

    POLLIN

    There is data to read

    POLLPRI

    There is urgent data to read

    POLLOUT

    Ready for output: writing will not block

    POLLERR

    Error condition of some sort

    POLLHUP

    Hung up

    POLLRDHUP

    Stream socket peer closed connection, or +shut down writing half of connection

    POLLNVAL

    Invalid request: descriptor not open

    +

    Registering a file descriptor that’s already registered is not an error, and has +the same effect as registering the descriptor exactly once.

    +
    + +
    +
    +poll.modify(fd, eventmask)
    +

    Modifies an already registered fd. This has the same effect as +register(fd, eventmask). Attempting to modify a file descriptor +that was never registered causes an OSError exception with errno +ENOENT to be raised.

    +
    + +
    +
    +poll.unregister(fd)
    +

    Remove a file descriptor being tracked by a polling object. Just like the +register() method, fd can be an integer or an object with a +fileno() method that returns an integer.

    +

    Attempting to remove a file descriptor that was never registered causes a +KeyError exception to be raised.

    +
    + +
    +
    +poll.poll([timeout])
    +

    Polls the set of registered file descriptors, and returns a possibly-empty list +containing (fd, event) 2-tuples for the descriptors that have events or +errors to report. fd is the file descriptor, and event is a bitmask with +bits set for the reported events for that descriptor — POLLIN for +waiting input, POLLOUT to indicate that the descriptor can be written +to, and so forth. An empty list indicates that the call timed out and no file +descriptors had any events to report. If timeout is given, it specifies the +length of time in milliseconds which the system will wait for events before +returning. If timeout is omitted, negative, or None, the call will +block until there is an event for this poll object.

    +
    +

    Changed in version 3.5: The function is now retried with a recomputed timeout when interrupted by +a signal, except if the signal handler raises an exception (see +PEP 475 for the rationale), instead of raising +InterruptedError.

    +
    +
    + +
    +
    +

    Kqueue Objects

    +
    +
    +kqueue.close()
    +

    Close the control file descriptor of the kqueue object.

    +
    + +
    +
    +kqueue.closed
    +

    True if the kqueue object is closed.

    +
    + +
    +
    +kqueue.fileno()
    +

    Return the file descriptor number of the control fd.

    +
    + +
    +
    +kqueue.fromfd(fd)
    +

    Create a kqueue object from a given file descriptor.

    +
    + +
    +
    +kqueue.control(changelist, max_events[, timeout]) → eventlist
    +

    Low level interface to kevent

    +
      +
    • changelist must be an iterable of kevent objects or None

    • +
    • max_events must be 0 or a positive integer

    • +
    • timeout in seconds (floats possible); the default is None, +to wait forever

    • +
    +
    +

    Changed in version 3.5: The function is now retried with a recomputed timeout when interrupted by +a signal, except if the signal handler raises an exception (see +PEP 475 for the rationale), instead of raising +InterruptedError.

    +
    +
    + +
    +
    +

    Kevent Objects

    +

    https://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2

    +
    +
    +kevent.ident
    +

    Value used to identify the event. The interpretation depends on the filter +but it’s usually the file descriptor. In the constructor ident can either +be an int or an object with a fileno() method. kevent +stores the integer internally.

    +
    + +
    +
    +kevent.filter
    +

    Name of the kernel filter.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Constant

    Meaning

    KQ_FILTER_READ

    Takes a descriptor and returns whenever +there is data available to read

    KQ_FILTER_WRITE

    Takes a descriptor and returns whenever +there is data available to write

    KQ_FILTER_AIO

    AIO requests

    KQ_FILTER_VNODE

    Returns when one or more of the requested +events watched in fflag occurs

    KQ_FILTER_PROC

    Watch for events on a process id

    KQ_FILTER_NETDEV

    Watch for events on a network device +[not available on Mac OS X]

    KQ_FILTER_SIGNAL

    Returns whenever the watched signal is +delivered to the process

    KQ_FILTER_TIMER

    Establishes an arbitrary timer

    +
    + +
    +
    +kevent.flags
    +

    Filter action.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Constant

    Meaning

    KQ_EV_ADD

    Adds or modifies an event

    KQ_EV_DELETE

    Removes an event from the queue

    KQ_EV_ENABLE

    Permitscontrol() to returns the event

    KQ_EV_DISABLE

    Disablesevent

    KQ_EV_ONESHOT

    Removes event after first occurrence

    KQ_EV_CLEAR

    Reset the state after an event is retrieved

    KQ_EV_SYSFLAGS

    internal event

    KQ_EV_FLAG1

    internal event

    KQ_EV_EOF

    Filter specific EOF condition

    KQ_EV_ERROR

    See return values

    +
    + +
    +
    +kevent.fflags
    +

    Filter specific flags.

    +

    KQ_FILTER_READ and KQ_FILTER_WRITE filter flags:

    + ++++ + + + + + + + + + + +

    Constant

    Meaning

    KQ_NOTE_LOWAT

    low water mark of a socket buffer

    +

    KQ_FILTER_VNODE filter flags:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Constant

    Meaning

    KQ_NOTE_DELETE

    unlink() was called

    KQ_NOTE_WRITE

    a write occurred

    KQ_NOTE_EXTEND

    the file was extended

    KQ_NOTE_ATTRIB

    an attribute was changed

    KQ_NOTE_LINK

    the link count has changed

    KQ_NOTE_RENAME

    the file was renamed

    KQ_NOTE_REVOKE

    access to the file was revoked

    +

    KQ_FILTER_PROC filter flags:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Constant

    Meaning

    KQ_NOTE_EXIT

    the process has exited

    KQ_NOTE_FORK

    the process has called fork()

    KQ_NOTE_EXEC

    the process has executed a new process

    KQ_NOTE_PCTRLMASK

    internal filter flag

    KQ_NOTE_PDATAMASK

    internal filter flag

    KQ_NOTE_TRACK

    follow a process across fork()

    KQ_NOTE_CHILD

    returned on the child process for +NOTE_TRACK

    KQ_NOTE_TRACKERR

    unable to attach to a child

    +

    KQ_FILTER_NETDEV filter flags (not available on Mac OS X):

    + ++++ + + + + + + + + + + + + + + + + +

    Constant

    Meaning

    KQ_NOTE_LINKUP

    link is up

    KQ_NOTE_LINKDOWN

    link is down

    KQ_NOTE_LINKINV

    link state is invalid

    +
    + +
    +
    +kevent.data
    +

    Filter specific data.

    +
    + +
    +
    +kevent.udata
    +

    User defined value.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/selectors.html b/python-3.7.4-docs-html/library/selectors.html new file mode 100644 index 0000000..b5e85cc --- /dev/null +++ b/python-3.7.4-docs-html/library/selectors.html @@ -0,0 +1,501 @@ + + + + + + + selectors — High-level I/O multiplexing — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    selectors — High-level I/O multiplexing

    +
    +

    New in version 3.4.

    +
    +

    Source code: Lib/selectors.py

    +
    +
    +

    Introduction

    +

    This module allows high-level and efficient I/O multiplexing, built upon the +select module primitives. Users are encouraged to use this module +instead, unless they want precise control over the OS-level primitives used.

    +

    It defines a BaseSelector abstract base class, along with several +concrete implementations (KqueueSelector, EpollSelector…), +that can be used to wait for I/O readiness notification on multiple file +objects. In the following, “file object” refers to any object with a +fileno() method, or a raw file descriptor. See file object.

    +

    DefaultSelector is an alias to the most efficient implementation +available on the current platform: this should be the default choice for most +users.

    +
    +

    Note

    +

    The type of file objects supported depends on the platform: on Windows, +sockets are supported, but not pipes, whereas on Unix, both are supported +(some other types may be supported as well, such as fifos or special file +devices).

    +
    +
    +

    See also

    +
    +
    select

    Low-level I/O multiplexing module.

    +
    +
    +
    +
    +
    +

    Classes

    +

    Classes hierarchy:

    +
    BaseSelector
    ++-- SelectSelector
    ++-- PollSelector
    ++-- EpollSelector
    ++-- DevpollSelector
    ++-- KqueueSelector
    +
    +
    +

    In the following, events is a bitwise mask indicating which I/O events should +be waited for on a given file object. It can be a combination of the modules +constants below:

    +
    +
    ++++ + + + + + + + + + + + + + +

    Constant

    Meaning

    EVENT_READ

    Available for read

    EVENT_WRITE

    Available for write

    +
    +
    +
    +class selectors.SelectorKey
    +

    A SelectorKey is a namedtuple used to +associate a file object to its underlying file descriptor, selected event +mask and attached data. It is returned by several BaseSelector +methods.

    +
    +
    +fileobj
    +

    File object registered.

    +
    + +
    +
    +fd
    +

    Underlying file descriptor.

    +
    + +
    +
    +events
    +

    Events that must be waited for on this file object.

    +
    + +
    +
    +data
    +

    Optional opaque data associated to this file object: for example, this +could be used to store a per-client session ID.

    +
    + +
    + +
    +
    +class selectors.BaseSelector
    +

    A BaseSelector is used to wait for I/O event readiness on multiple +file objects. It supports file stream registration, unregistration, and a +method to wait for I/O events on those streams, with an optional timeout. +It’s an abstract base class, so cannot be instantiated. Use +DefaultSelector instead, or one of SelectSelector, +KqueueSelector etc. if you want to specifically use an +implementation, and your platform supports it. +BaseSelector and its concrete implementations support the +context manager protocol.

    +
    +
    +abstractmethod register(fileobj, events, data=None)
    +

    Register a file object for selection, monitoring it for I/O events.

    +

    fileobj is the file object to monitor. It may either be an integer +file descriptor or an object with a fileno() method. +events is a bitwise mask of events to monitor. +data is an opaque object.

    +

    This returns a new SelectorKey instance, or raises a +ValueError in case of invalid event mask or file descriptor, or +KeyError if the file object is already registered.

    +
    + +
    +
    +abstractmethod unregister(fileobj)
    +

    Unregister a file object from selection, removing it from monitoring. A +file object shall be unregistered prior to being closed.

    +

    fileobj must be a file object previously registered.

    +

    This returns the associated SelectorKey instance, or raises a +KeyError if fileobj is not registered. It will raise +ValueError if fileobj is invalid (e.g. it has no fileno() +method or its fileno() method has an invalid return value).

    +
    + +
    +
    +modify(fileobj, events, data=None)
    +

    Change a registered file object’s monitored events or attached data.

    +

    This is equivalent to BaseSelector.unregister(fileobj)() followed +by BaseSelector.register(fileobj, events, data)(), except that it +can be implemented more efficiently.

    +

    This returns a new SelectorKey instance, or raises a +ValueError in case of invalid event mask or file descriptor, or +KeyError if the file object is not registered.

    +
    + +
    +
    +abstractmethod select(timeout=None)
    +

    Wait until some registered file objects become ready, or the timeout +expires.

    +

    If timeout > 0, this specifies the maximum wait time, in seconds. +If timeout <= 0, the call won’t block, and will report the currently +ready file objects. +If timeout is None, the call will block until a monitored file object +becomes ready.

    +

    This returns a list of (key, events) tuples, one for each ready file +object.

    +

    key is the SelectorKey instance corresponding to a ready file +object. +events is a bitmask of events ready on this file object.

    +
    +

    Note

    +

    This method can return before any file object becomes ready or the +timeout has elapsed if the current process receives a signal: in this +case, an empty list will be returned.

    +
    +
    +

    Changed in version 3.5: The selector is now retried with a recomputed timeout when interrupted +by a signal if the signal handler did not raise an exception (see +PEP 475 for the rationale), instead of returning an empty list +of events before the timeout.

    +
    +
    + +
    +
    +close()
    +

    Close the selector.

    +

    This must be called to make sure that any underlying resource is freed. +The selector shall not be used once it has been closed.

    +
    + +
    +
    +get_key(fileobj)
    +

    Return the key associated with a registered file object.

    +

    This returns the SelectorKey instance associated to this file +object, or raises KeyError if the file object is not registered.

    +
    + +
    +
    +abstractmethod get_map()
    +

    Return a mapping of file objects to selector keys.

    +

    This returns a Mapping instance mapping +registered file objects to their associated SelectorKey +instance.

    +
    + +
    + +
    +
    +class selectors.DefaultSelector
    +

    The default selector class, using the most efficient implementation +available on the current platform. This should be the default choice for +most users.

    +
    + +
    +
    +class selectors.SelectSelector
    +

    select.select()-based selector.

    +
    + +
    +
    +class selectors.PollSelector
    +

    select.poll()-based selector.

    +
    + +
    +
    +class selectors.EpollSelector
    +

    select.epoll()-based selector.

    +
    +
    +fileno()
    +

    This returns the file descriptor used by the underlying +select.epoll() object.

    +
    + +
    + +
    +
    +class selectors.DevpollSelector
    +

    select.devpoll()-based selector.

    +
    +
    +fileno()
    +

    This returns the file descriptor used by the underlying +select.devpoll() object.

    +
    + +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +class selectors.KqueueSelector
    +

    select.kqueue()-based selector.

    +
    +
    +fileno()
    +

    This returns the file descriptor used by the underlying +select.kqueue() object.

    +
    + +
    + +
    +
    +

    Examples

    +

    Here is a simple echo server implementation:

    +
    import selectors
    +import socket
    +
    +sel = selectors.DefaultSelector()
    +
    +def accept(sock, mask):
    +    conn, addr = sock.accept()  # Should be ready
    +    print('accepted', conn, 'from', addr)
    +    conn.setblocking(False)
    +    sel.register(conn, selectors.EVENT_READ, read)
    +
    +def read(conn, mask):
    +    data = conn.recv(1000)  # Should be ready
    +    if data:
    +        print('echoing', repr(data), 'to', conn)
    +        conn.send(data)  # Hope it won't block
    +    else:
    +        print('closing', conn)
    +        sel.unregister(conn)
    +        conn.close()
    +
    +sock = socket.socket()
    +sock.bind(('localhost', 1234))
    +sock.listen(100)
    +sock.setblocking(False)
    +sel.register(sock, selectors.EVENT_READ, accept)
    +
    +while True:
    +    events = sel.select()
    +    for key, mask in events:
    +        callback = key.data
    +        callback(key.fileobj, mask)
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/shelve.html b/python-3.7.4-docs-html/library/shelve.html new file mode 100644 index 0000000..b982a82 --- /dev/null +++ b/python-3.7.4-docs-html/library/shelve.html @@ -0,0 +1,377 @@ + + + + + + + shelve — Python object persistence — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    shelve — Python object persistence

    +

    Source code: Lib/shelve.py

    +
    +

    A “shelf” is a persistent, dictionary-like object. The difference with “dbm” +databases is that the values (not the keys!) in a shelf can be essentially +arbitrary Python objects — anything that the pickle module can handle. +This includes most class instances, recursive data types, and objects containing +lots of shared sub-objects. The keys are ordinary strings.

    +
    +
    +shelve.open(filename, flag='c', protocol=None, writeback=False)
    +

    Open a persistent dictionary. The filename specified is the base filename for +the underlying database. As a side-effect, an extension may be added to the +filename and more than one file may be created. By default, the underlying +database file is opened for reading and writing. The optional flag parameter +has the same interpretation as the flag parameter of dbm.open().

    +

    By default, version 3 pickles are used to serialize values. The version of the +pickle protocol can be specified with the protocol parameter.

    +

    Because of Python semantics, a shelf cannot know when a mutable +persistent-dictionary entry is modified. By default modified objects are +written only when assigned to the shelf (see Example). If the +optional writeback parameter is set to True, all entries accessed are also +cached in memory, and written back on sync() and +close(); this can make it handier to mutate mutable entries in +the persistent dictionary, but, if many entries are accessed, it can consume +vast amounts of memory for the cache, and it can make the close operation +very slow since all accessed entries are written back (there is no way to +determine which accessed entries are mutable, nor which ones were actually +mutated).

    +
    +

    Note

    +

    Do not rely on the shelf being closed automatically; always call +close() explicitly when you don’t need it any more, or +use shelve.open() as a context manager:

    +
    with shelve.open('spam') as db:
    +    db['eggs'] = 'eggs'
    +
    +
    +
    +
    + +
    +

    Warning

    +

    Because the shelve module is backed by pickle, it is insecure +to load a shelf from an untrusted source. Like with pickle, loading a shelf +can execute arbitrary code.

    +
    +

    Shelf objects support all methods supported by dictionaries. This eases the +transition from dictionary based scripts to those requiring persistent storage.

    +

    Two additional methods are supported:

    +
    +
    +Shelf.sync()
    +

    Write back all entries in the cache if the shelf was opened with writeback +set to True. Also empty the cache and synchronize the persistent +dictionary on disk, if feasible. This is called automatically when the shelf +is closed with close().

    +
    + +
    +
    +Shelf.close()
    +

    Synchronize and close the persistent dict object. Operations on a closed +shelf will fail with a ValueError.

    +
    + +
    +

    See also

    +

    Persistent dictionary recipe +with widely supported storage formats and having the speed of native +dictionaries.

    +
    +
    +

    Restrictions

    +
    +
    +
      +
    • The choice of which database package will be used (such as dbm.ndbm or +dbm.gnu) depends on which interface is available. Therefore it is not +safe to open the database directly using dbm. The database is also +(unfortunately) subject to the limitations of dbm, if it is used — +this means that (the pickled representation of) the objects stored in the +database should be fairly small, and in rare cases key collisions may cause +the database to refuse updates.

    • +
    • The shelve module does not support concurrent read/write access to +shelved objects. (Multiple simultaneous read accesses are safe.) When a +program has a shelf open for writing, no other program should have it open for +reading or writing. Unix file locking can be used to solve this, but this +differs across Unix versions and requires knowledge about the database +implementation used.

    • +
    +
    +
    +class shelve.Shelf(dict, protocol=None, writeback=False, keyencoding='utf-8')
    +

    A subclass of collections.abc.MutableMapping which stores pickled +values in the dict object.

    +

    By default, version 3 pickles are used to serialize values. The version of the +pickle protocol can be specified with the protocol parameter. See the +pickle documentation for a discussion of the pickle protocols.

    +

    If the writeback parameter is True, the object will hold a cache of all +entries accessed and write them back to the dict at sync and close times. +This allows natural operations on mutable entries, but can consume much more +memory and make sync and close take a long time.

    +

    The keyencoding parameter is the encoding used to encode keys before they +are used with the underlying dict.

    +

    A Shelf object can also be used as a context manager, in which +case it will be automatically closed when the with block ends.

    +
    +

    Changed in version 3.2: Added the keyencoding parameter; previously, keys were always encoded in +UTF-8.

    +
    +
    +

    Changed in version 3.4: Added context manager support.

    +
    +
    + +
    +
    +class shelve.BsdDbShelf(dict, protocol=None, writeback=False, keyencoding='utf-8')
    +

    A subclass of Shelf which exposes first(), next(), +previous(), last() and set_location() which are available +in the third-party bsddb module from pybsddb but not in other database +modules. The dict object passed to the constructor must support those +methods. This is generally accomplished by calling one of +bsddb.hashopen(), bsddb.btopen() or bsddb.rnopen(). The +optional protocol, writeback, and keyencoding parameters have the same +interpretation as for the Shelf class.

    +
    + +
    +
    +class shelve.DbfilenameShelf(filename, flag='c', protocol=None, writeback=False)
    +

    A subclass of Shelf which accepts a filename instead of a dict-like +object. The underlying file will be opened using dbm.open(). By +default, the file will be created and opened for both read and write. The +optional flag parameter has the same interpretation as for the open() +function. The optional protocol and writeback parameters have the same +interpretation as for the Shelf class.

    +
    + +
    +
    +

    Example

    +

    To summarize the interface (key is a string, data is an arbitrary +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!)
    +
    +# 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]!
    +
    +# 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
    +
    +# 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
    +
    +
    +
    +

    See also

    +
    +
    Module dbm

    Generic interface to dbm-style databases.

    +
    +
    Module pickle

    Object serialization used by shelve.

    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/shlex.html b/python-3.7.4-docs-html/library/shlex.html new file mode 100644 index 0000000..98c6043 --- /dev/null +++ b/python-3.7.4-docs-html/library/shlex.html @@ -0,0 +1,598 @@ + + + + + + + shlex — Simple lexical analysis — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    shlex — Simple lexical analysis

    +

    Source code: Lib/shlex.py

    +
    +

    The shlex class makes it easy to write lexical analyzers for +simple syntaxes resembling that of the Unix shell. This will often be useful +for writing minilanguages, (for example, in run control files for Python +applications) or for parsing quoted strings.

    +

    The shlex module defines the following functions:

    +
    +
    +shlex.split(s, comments=False, posix=True)
    +

    Split the string s using shell-like syntax. If comments is False +(the default), the parsing of comments in the given string will be disabled +(setting the commenters attribute of the +shlex instance to the empty string). This function operates +in POSIX mode by default, but uses non-POSIX mode if the posix argument is +false.

    +
    +

    Note

    +

    Since the split() function instantiates a shlex +instance, passing None for s will read the string to split from +standard input.

    +
    +
    + +
    +
    +shlex.quote(s)
    +

    Return a shell-escaped version of the string s. The returned value is a +string that can safely be used as one token in a shell command line, for +cases where you cannot use a list.

    +

    This idiom would be unsafe:

    +
    >>> filename = 'somefile; rm -rf ~'
    +>>> command = 'ls -l {}'.format(filename)
    +>>> print(command)  # executed by a shell: boom!
    +ls -l somefile; rm -rf ~
    +
    +
    +

    quote() lets you plug the security hole:

    +
    >>> from shlex import quote
    +>>> command = 'ls -l {}'.format(quote(filename))
    +>>> print(command)
    +ls -l 'somefile; rm -rf ~'
    +>>> remote_command = 'ssh home {}'.format(quote(command))
    +>>> print(remote_command)
    +ssh home 'ls -l '"'"'somefile; rm -rf ~'"'"''
    +
    +
    +

    The quoting is compatible with UNIX shells and with split():

    +
    >>> from shlex import split
    +>>> remote_command = split(remote_command)
    +>>> remote_command
    +['ssh', 'home', "ls -l 'somefile; rm -rf ~'"]
    +>>> command = split(remote_command[-1])
    +>>> command
    +['ls', '-l', 'somefile; rm -rf ~']
    +
    +
    +
    +

    New in version 3.3.

    +
    +
    + +

    The shlex module defines the following class:

    +
    +
    +class shlex.shlex(instream=None, infile=None, posix=False, punctuation_chars=False)
    +

    A shlex instance or subclass instance is a lexical analyzer +object. The initialization argument, if present, specifies where to read +characters from. It must be a file-/stream-like object with +read() and readline() methods, or +a string. If no argument is given, input will be taken from sys.stdin. +The second optional argument is a filename string, which sets the initial +value of the infile attribute. If the instream +argument is omitted or equal to sys.stdin, this second argument +defaults to “stdin”. The posix argument defines the operational mode: +when posix is not true (default), the shlex instance will +operate in compatibility mode. When operating in POSIX mode, +shlex will try to be as close as possible to the POSIX shell +parsing rules. The punctuation_chars argument provides a way to make the +behaviour even closer to how real shells parse. This can take a number of +values: the default value, False, preserves the behaviour seen under +Python 3.5 and earlier. If set to True, then parsing of the characters +();<>|& is changed: any run of these characters (considered punctuation +characters) is returned as a single token. If set to a non-empty string of +characters, those characters will be used as the punctuation characters. Any +characters in the wordchars attribute that appear in +punctuation_chars will be removed from wordchars. See +Improved Compatibility with Shells for more information.

    +
    +

    Changed in version 3.6: The punctuation_chars parameter was added.

    +
    +
    + +
    +

    See also

    +
    +
    Module configparser

    Parser for configuration files similar to the Windows .ini files.

    +
    +
    +
    +
    +

    shlex Objects

    +

    A shlex instance has the following methods:

    +
    +
    +shlex.get_token()
    +

    Return a token. If tokens have been stacked using push_token(), pop a +token off the stack. Otherwise, read one from the input stream. If reading +encounters an immediate end-of-file, eof is returned (the empty +string ('') in non-POSIX mode, and None in POSIX mode).

    +
    + +
    +
    +shlex.push_token(str)
    +

    Push the argument onto the token stack.

    +
    + +
    +
    +shlex.read_token()
    +

    Read a raw token. Ignore the pushback stack, and do not interpret source +requests. (This is not ordinarily a useful entry point, and is documented here +only for the sake of completeness.)

    +
    + +
    +
    +shlex.sourcehook(filename)
    +

    When shlex detects a source request (see source +below) this method is given the following token as argument, and expected +to return a tuple consisting of a filename and an open file-like object.

    +

    Normally, this method first strips any quotes off the argument. If the result +is an absolute pathname, or there was no previous source request in effect, or +the previous source was a stream (such as sys.stdin), the result is left +alone. Otherwise, if the result is a relative pathname, the directory part of +the name of the file immediately before it on the source inclusion stack is +prepended (this behavior is like the way the C preprocessor handles #include +"file.h").

    +

    The result of the manipulations is treated as a filename, and returned as the +first component of the tuple, with open() called on it to yield the second +component. (Note: this is the reverse of the order of arguments in instance +initialization!)

    +

    This hook is exposed so that you can use it to implement directory search paths, +addition of file extensions, and other namespace hacks. There is no +corresponding ‘close’ hook, but a shlex instance will call the +close() method of the sourced input stream when it returns +EOF.

    +

    For more explicit control of source stacking, use the push_source() and +pop_source() methods.

    +
    + +
    +
    +shlex.push_source(newstream, newfile=None)
    +

    Push an input source stream onto the input stack. If the filename argument is +specified it will later be available for use in error messages. This is the +same method used internally by the sourcehook() method.

    +
    + +
    +
    +shlex.pop_source()
    +

    Pop the last-pushed input source from the input stack. This is the same method +used internally when the lexer reaches EOF on a stacked input stream.

    +
    + +
    +
    +shlex.error_leader(infile=None, lineno=None)
    +

    This method generates an error message leader in the format of a Unix C compiler +error label; the format is '"%s", line %d: ', where the %s is replaced +with the name of the current source file and the %d with the current input +line number (the optional arguments can be used to override these).

    +

    This convenience is provided to encourage shlex users to generate error +messages in the standard, parseable format understood by Emacs and other Unix +tools.

    +
    + +

    Instances of shlex subclasses have some public instance +variables which either control lexical analysis or can be used for debugging:

    +
    +
    +shlex.commenters
    +

    The string of characters that are recognized as comment beginners. All +characters from the comment beginner to end of line are ignored. Includes just +'#' by default.

    +
    + +
    +
    +shlex.wordchars
    +

    The string of characters that will accumulate into multi-character tokens. By +default, includes all ASCII alphanumerics and underscore. In POSIX mode, the +accented characters in the Latin-1 set are also included. If +punctuation_chars is not empty, the characters ~-./*?=, which can +appear in filename specifications and command line parameters, will also be +included in this attribute, and any characters which appear in +punctuation_chars will be removed from wordchars if they are present +there.

    +
    + +
    +
    +shlex.whitespace
    +

    Characters that will be considered whitespace and skipped. Whitespace bounds +tokens. By default, includes space, tab, linefeed and carriage-return.

    +
    + +
    +
    +shlex.escape
    +

    Characters that will be considered as escape. This will be only used in POSIX +mode, and includes just '\' by default.

    +
    + +
    +
    +shlex.quotes
    +

    Characters that will be considered string quotes. The token accumulates until +the same quote is encountered again (thus, different quote types protect each +other as in the shell.) By default, includes ASCII single and double quotes.

    +
    + +
    +
    +shlex.escapedquotes
    +

    Characters in quotes that will interpret escape characters defined in +escape. This is only used in POSIX mode, and includes just '"' by +default.

    +
    + +
    +
    +shlex.whitespace_split
    +

    If True, tokens will only be split in whitespaces. This is useful, for +example, for parsing command lines with shlex, getting +tokens in a similar way to shell arguments. If this attribute is True, +punctuation_chars will have no effect, and splitting will happen +only on whitespaces. When using punctuation_chars, which is +intended to provide parsing closer to that implemented by shells, it is +advisable to leave whitespace_split as False (the default value).

    +
    + +
    +
    +shlex.infile
    +

    The name of the current input file, as initially set at class instantiation time +or stacked by later source requests. It may be useful to examine this when +constructing error messages.

    +
    + +
    +
    +shlex.instream
    +

    The input stream from which this shlex instance is reading +characters.

    +
    + +
    +
    +shlex.source
    +

    This attribute is None by default. If you assign a string to it, that +string will be recognized as a lexical-level inclusion request similar to the +source keyword in various shells. That is, the immediately following token +will be opened as a filename and input will be taken from that stream until +EOF, at which point the close() method of that stream will be +called and the input source will again become the original input stream. Source +requests may be stacked any number of levels deep.

    +
    + +
    +
    +shlex.debug
    +

    If this attribute is numeric and 1 or more, a shlex +instance will print verbose progress output on its behavior. If you need +to use this, you can read the module source code to learn the details.

    +
    + +
    +
    +shlex.lineno
    +

    Source line number (count of newlines seen so far plus one).

    +
    + +
    +
    +shlex.token
    +

    The token buffer. It may be useful to examine this when catching exceptions.

    +
    + +
    +
    +shlex.eof
    +

    Token used to determine end of file. This will be set to the empty string +(''), in non-POSIX mode, and to None in POSIX mode.

    +
    + +
    +
    +shlex.punctuation_chars
    +

    Characters that will be considered punctuation. Runs of punctuation +characters will be returned as a single token. However, note that no +semantic validity checking will be performed: for example, ‘>>>’ could be +returned as a token, even though it may not be recognised as such by shells.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +

    Parsing Rules

    +

    When operating in non-POSIX mode, shlex will try to obey to the +following rules.

    +
      +
    • Quote characters are not recognized within words (Do"Not"Separate is +parsed as the single word Do"Not"Separate);

    • +
    • Escape characters are not recognized;

    • +
    • Enclosing characters in quotes preserve the literal value of all characters +within the quotes;

    • +
    • Closing quotes separate words ("Do"Separate is parsed as "Do" and +Separate);

    • +
    • If whitespace_split is False, any character not +declared to be a word character, whitespace, or a quote will be returned as +a single-character token. If it is True, shlex will only +split words in whitespaces;

    • +
    • EOF is signaled with an empty string ('');

    • +
    • It’s not possible to parse empty strings, even if quoted.

    • +
    +

    When operating in POSIX mode, shlex will try to obey to the +following parsing rules.

    +
      +
    • Quotes are stripped out, and do not separate words ("Do"Not"Separate" is +parsed as the single word DoNotSeparate);

    • +
    • Non-quoted escape characters (e.g. '\') preserve the literal value of the +next character that follows;

    • +
    • Enclosing characters in quotes which are not part of +escapedquotes (e.g. "'") preserve the literal value +of all characters within the quotes;

    • +
    • Enclosing characters in quotes which are part of +escapedquotes (e.g. '"') preserves the literal value +of all characters within the quotes, with the exception of the characters +mentioned in escape. The escape characters retain its +special meaning only when followed by the quote in use, or the escape +character itself. Otherwise the escape character will be considered a +normal character.

    • +
    • EOF is signaled with a None value;

    • +
    • Quoted empty strings ('') are allowed.

    • +
    +
    +
    +

    Improved Compatibility with Shells

    +
    +

    New in version 3.6.

    +
    +

    The shlex class provides compatibility with the parsing performed by +common Unix shells like bash, dash, and sh. To take advantage of +this compatibility, specify the punctuation_chars argument in the +constructor. This defaults to False, which preserves pre-3.6 behaviour. +However, if it is set to True, then parsing of the characters ();<>|& +is changed: any run of these characters is returned as a single token. While +this is short of a full parser for shells (which would be out of scope for the +standard library, given the multiplicity of shells out there), it does allow +you to perform processing of command lines more easily than you could +otherwise. To illustrate, you can see the difference in the following snippet:

    +
     >>> import shlex
    + >>> text = "a && b; c && d || e; f >'abc'; (def \"ghi\")"
    + >>> list(shlex.shlex(text))
    + ['a', '&', '&', 'b', ';', 'c', '&', '&', 'd', '|', '|', 'e', ';', 'f', '>',
    + "'abc'", ';', '(', 'def', '"ghi"', ')']
    + >>> list(shlex.shlex(text, punctuation_chars=True))
    + ['a', '&&', 'b', ';', 'c', '&&', 'd', '||', 'e', ';', 'f', '>', "'abc'",
    + ';', '(', 'def', '"ghi"', ')']
    +
    +
    +

    Of course, tokens will be returned which are not valid for shells, and you’ll +need to implement your own error checks on the returned tokens.

    +

    Instead of passing True as the value for the punctuation_chars parameter, +you can pass a string with specific characters, which will be used to determine +which characters constitute punctuation. For example:

    +
    >>> import shlex
    +>>> s = shlex.shlex("a && b || c", punctuation_chars="|")
    +>>> list(s)
    +['a', '&', '&', 'b', '||', 'c']
    +
    +
    +
    +

    Note

    +

    When punctuation_chars is specified, the wordchars +attribute is augmented with the characters ~-./*?=. That is because these +characters can appear in file names (including wildcards) and command-line +arguments (e.g. --color=auto). Hence:

    +
    >>> import shlex
    +>>> s = shlex.shlex('~/a && b-c --color=auto || d *.py?',
    +...                 punctuation_chars=True)
    +>>> list(s)
    +['~/a', '&&', 'b-c', '--color=auto', '||', 'd', '*.py?']
    +
    +
    +
    +

    For best effect, punctuation_chars should be set in conjunction with +posix=True. (Note that posix=False is the default for +shlex.)

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/shutil.html b/python-3.7.4-docs-html/library/shutil.html new file mode 100644 index 0000000..6b62d11 --- /dev/null +++ b/python-3.7.4-docs-html/library/shutil.html @@ -0,0 +1,809 @@ + + + + + + + shutil — High-level file operations — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    shutil — High-level file operations

    +

    Source code: Lib/shutil.py

    +
    +

    The shutil module offers a number of high-level operations on files and +collections of files. In particular, functions are provided which support file +copying and removal. For operations on individual files, see also the +os module.

    +
    +

    Warning

    +

    Even the higher-level file copying functions (shutil.copy(), +shutil.copy2()) cannot copy all file metadata.

    +

    On POSIX platforms, this means that file owner and group are lost as well +as ACLs. On Mac OS, the resource fork and other metadata are not used. +This means that resources will be lost and file type and creator codes will +not be correct. On Windows, file owners, ACLs and alternate data streams +are not copied.

    +
    +
    +

    Directory and files operations

    +
    +
    +shutil.copyfileobj(fsrc, fdst[, length])
    +

    Copy the contents of the file-like object fsrc to the file-like object fdst. +The integer length, if given, is the buffer size. In particular, a negative +length value means to copy the data without looping over the source data in +chunks; by default the data is read in chunks to avoid uncontrolled memory +consumption. Note that if the current file position of the fsrc object is not +0, only the contents from the current file position to the end of the file will +be copied.

    +
    + +
    +
    +shutil.copyfile(src, dst, *, follow_symlinks=True)
    +

    Copy the contents (no metadata) of the file named src to a file named +dst and return dst. src and dst are path names given as strings. +dst must be the complete target file name; look at shutil.copy() +for a copy that accepts a target directory path. If src and dst +specify the same file, SameFileError is raised.

    +

    The destination location must be writable; otherwise, an OSError +exception will be raised. If dst already exists, it will be replaced. +Special files such as character or block devices and pipes cannot be +copied with this function.

    +

    If follow_symlinks is false and src is a symbolic link, +a new symbolic link will be created instead of copying the +file src points to.

    +
    +

    Changed in version 3.3: IOError used to be raised instead of OSError. +Added follow_symlinks argument. +Now returns dst.

    +
    +
    +

    Changed in version 3.4: Raise SameFileError instead of Error. Since the former is +a subclass of the latter, this change is backward compatible.

    +
    +
    + +
    +
    +exception shutil.SameFileError
    +

    This exception is raised if source and destination in copyfile() +are the same file.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +shutil.copymode(src, dst, *, follow_symlinks=True)
    +

    Copy the permission bits from src to dst. The file contents, owner, and +group are unaffected. src and dst are path names given as strings. +If follow_symlinks is false, and both src and dst are symbolic links, +copymode() will attempt to modify the mode of dst itself (rather +than the file it points to). This functionality is not available on every +platform; please see copystat() for more information. If +copymode() cannot modify symbolic links on the local platform, and it +is asked to do so, it will do nothing and return.

    +
    +

    Changed in version 3.3: Added follow_symlinks argument.

    +
    +
    + +
    +
    +shutil.copystat(src, dst, *, follow_symlinks=True)
    +

    Copy the permission bits, last access time, last modification time, and +flags from src to dst. On Linux, copystat() also copies the +“extended attributes” where possible. The file contents, owner, and +group are unaffected. src and dst are path names given as strings.

    +

    If follow_symlinks is false, and src and dst both +refer to symbolic links, copystat() will operate on +the symbolic links themselves rather than the files the +symbolic links refer to—reading the information from the +src symbolic link, and writing the information to the +dst symbolic link.

    +
    +

    Note

    +

    Not all platforms provide the ability to examine and +modify symbolic links. Python itself can tell you what +functionality is locally available.

    +
      +
    • If os.chmod in os.supports_follow_symlinks is +True, copystat() can modify the permission +bits of a symbolic link.

    • +
    • If os.utime in os.supports_follow_symlinks is +True, copystat() can modify the last access +and modification times of a symbolic link.

    • +
    • If os.chflags in os.supports_follow_symlinks is +True, copystat() can modify the flags of +a symbolic link. (os.chflags is not available on +all platforms.)

    • +
    +

    On platforms where some or all of this functionality +is unavailable, when asked to modify a symbolic link, +copystat() will copy everything it can. +copystat() never returns failure.

    +

    Please see os.supports_follow_symlinks +for more information.

    +
    +
    +

    Changed in version 3.3: Added follow_symlinks argument and support for Linux extended attributes.

    +
    +
    + +
    +
    +shutil.copy(src, dst, *, follow_symlinks=True)
    +

    Copies the file src to the file or directory dst. src and dst +should be strings. If dst specifies a directory, the file will be +copied into dst using the base filename from src. Returns the +path to the newly created file.

    +

    If follow_symlinks is false, and src is a symbolic link, +dst will be created as a symbolic link. If follow_symlinks +is true and src is a symbolic link, dst will be a copy of +the file src refers to.

    +

    copy() copies the file data and the file’s permission +mode (see os.chmod()). Other metadata, like the +file’s creation and modification times, is not preserved. +To preserve all file metadata from the original, use +copy2() instead.

    +
    +

    Changed in version 3.3: Added follow_symlinks argument. +Now returns path to the newly created file.

    +
    +
    + +
    +
    +shutil.copy2(src, dst, *, follow_symlinks=True)
    +

    Identical to copy() except that copy2() +also attempts to preserve file metadata.

    +

    When follow_symlinks is false, and src is a symbolic +link, copy2() attempts to copy all metadata from the +src symbolic link to the newly-created dst symbolic link. +However, this functionality is not available on all platforms. +On platforms where some or all of this functionality is +unavailable, copy2() will preserve all the metadata +it can; copy2() never returns failure.

    +

    copy2() uses copystat() to copy the file metadata. +Please see copystat() for more information +about platform support for modifying symbolic link metadata.

    +
    +

    Changed in version 3.3: Added follow_symlinks argument, try to copy extended +file system attributes too (currently Linux only). +Now returns path to the newly created file.

    +
    +
    + +
    +
    +shutil.ignore_patterns(*patterns)
    +

    This factory function creates a function that can be used as a callable for +copytree()’s ignore argument, ignoring files and directories that +match one of the glob-style patterns provided. See the example below.

    +
    + +
    +
    +shutil.copytree(src, dst, symlinks=False, ignore=None, copy_function=copy2, ignore_dangling_symlinks=False)
    +

    Recursively copy an entire directory tree rooted at src, returning the +destination directory. The destination +directory, named by dst, must not already exist; it will be created as +well as missing parent directories. Permissions and times of directories +are copied with copystat(), individual files are copied using +shutil.copy2().

    +

    If symlinks is true, symbolic links in the source tree are represented as +symbolic links in the new tree and the metadata of the original links will +be copied as far as the platform allows; if false or omitted, the contents +and metadata of the linked files are copied to the new tree.

    +

    When symlinks is false, if the file pointed by the symlink doesn’t +exist, an exception will be added in the list of errors raised in +an Error exception at the end of the copy process. +You can set the optional ignore_dangling_symlinks flag to true if you +want to silence this exception. Notice that this option has no effect +on platforms that don’t support os.symlink().

    +

    If ignore is given, it must be a callable that will receive as its +arguments the directory being visited by copytree(), and a list of its +contents, as returned by os.listdir(). Since copytree() is +called recursively, the ignore callable will be called once for each +directory that is copied. The callable must return a sequence of directory +and file names relative to the current directory (i.e. a subset of the items +in its second argument); these names will then be ignored in the copy +process. ignore_patterns() can be used to create such a callable that +ignores names based on glob-style patterns.

    +

    If exception(s) occur, an Error is raised with a list of reasons.

    +

    If copy_function is given, it must be a callable that will be used to copy +each file. It will be called with the source path and the destination path +as arguments. By default, shutil.copy2() is used, but any function +that supports the same signature (like shutil.copy()) can be used.

    +
    +

    Changed in version 3.3: Copy metadata when symlinks is false. +Now returns dst.

    +
    +
    +

    Changed in version 3.2: Added the copy_function argument to be able to provide a custom copy +function. +Added the ignore_dangling_symlinks argument to silent dangling symlinks +errors when symlinks is false.

    +
    +
    + +
    +
    +shutil.rmtree(path, ignore_errors=False, onerror=None)
    +

    Delete an entire directory tree; path must point to a directory (but not a +symbolic link to a directory). If ignore_errors is true, errors resulting +from failed removals will be ignored; if false or omitted, such errors are +handled by calling a handler specified by onerror or, if that is omitted, +they raise an exception.

    +
    +

    Note

    +

    On platforms that support the necessary fd-based functions a symlink +attack resistant version of rmtree() is used by default. On other +platforms, the rmtree() implementation is susceptible to a symlink +attack: given proper timing and circumstances, attackers can manipulate +symlinks on the filesystem to delete files they wouldn’t be able to access +otherwise. Applications can use the rmtree.avoids_symlink_attacks +function attribute to determine which case applies.

    +
    +

    If onerror is provided, it must be a callable that accepts three +parameters: function, path, and excinfo.

    +

    The first parameter, function, is the function which raised the exception; +it depends on the platform and implementation. The second parameter, +path, will be the path name passed to function. The third parameter, +excinfo, will be the exception information returned by +sys.exc_info(). Exceptions raised by onerror will not be caught.

    +
    +

    Changed in version 3.3: Added a symlink attack resistant version that is used automatically +if platform supports fd-based functions.

    +
    +
    + +

    Indicates whether the current platform and implementation provides a +symlink attack resistant version of rmtree(). Currently this is +only true for platforms supporting fd-based directory access functions.

    +
    +

    New in version 3.3.

    +
    +
    + +
    + +
    +
    +shutil.move(src, dst, copy_function=copy2)
    +

    Recursively move a file or directory (src) to another location (dst) +and return the destination.

    +

    If the destination is an existing directory, then src is moved inside that +directory. If the destination already exists but is not a directory, it may +be overwritten depending on os.rename() semantics.

    +

    If the destination is on the current filesystem, then os.rename() is +used. Otherwise, src is copied to dst using copy_function and then +removed. In case of symlinks, a new symlink pointing to the target of src +will be created in or as dst and src will be removed.

    +

    If copy_function is given, it must be a callable that takes two arguments +src and dst, and will be used to copy src to dest if +os.rename() cannot be used. If the source is a directory, +copytree() is called, passing it the copy_function(). The +default copy_function is copy2(). Using copy() as the +copy_function allows the move to succeed when it is not possible to also +copy the metadata, at the expense of not copying any of the metadata.

    +
    +

    Changed in version 3.3: Added explicit symlink handling for foreign filesystems, thus adapting +it to the behavior of GNU’s mv. +Now returns dst.

    +
    +
    +

    Changed in version 3.5: Added the copy_function keyword argument.

    +
    +
    + +
    +
    +shutil.disk_usage(path)
    +

    Return disk usage statistics about the given path as a named tuple +with the attributes total, used and free, which are the amount of +total, used and free space, in bytes. On Windows, path must be a +directory; on Unix, it can be a file or directory.

    +
    +

    New in version 3.3.

    +
    +

    Availability: Unix, Windows.

    +
    + +
    +
    +shutil.chown(path, user=None, group=None)
    +

    Change owner user and/or group of the given path.

    +

    user can be a system user name or a uid; the same applies to group. At +least one argument is required.

    +

    See also os.chown(), the underlying function.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +shutil.which(cmd, mode=os.F_OK | os.X_OK, path=None)
    +

    Return the path to an executable which would be run if the given cmd was +called. If no cmd would be called, return None.

    +

    mode is a permission mask passed to os.access(), by default +determining if the file exists and executable.

    +

    When no path is specified, the results of os.environ() are used, +returning either the “PATH” value or a fallback of os.defpath.

    +

    On Windows, the current directory is always prepended to the path whether +or not you use the default or provide your own, which is the behavior the +command shell uses when finding executables. Additionally, when finding the +cmd in the path, the PATHEXT environment variable is checked. For +example, if you call shutil.which("python"), which() will search +PATHEXT to know that it should look for python.exe within the path +directories. For example, on Windows:

    +
    >>> shutil.which("python")
    +'C:\\Python33\\python.EXE'
    +
    +
    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +exception shutil.Error
    +

    This exception collects exceptions that are raised during a multi-file +operation. For copytree(), the exception argument is a list of 3-tuples +(srcname, dstname, exception).

    +
    + +
    +

    copytree example

    +

    This example is the implementation of the copytree() function, described +above, with the docstring omitted. It demonstrates many of the other functions +provided by this module.

    +
    def copytree(src, dst, symlinks=False):
    +    names = os.listdir(src)
    +    os.makedirs(dst)
    +    errors = []
    +    for name in names:
    +        srcname = os.path.join(src, name)
    +        dstname = os.path.join(dst, name)
    +        try:
    +            if symlinks and os.path.islink(srcname):
    +                linkto = os.readlink(srcname)
    +                os.symlink(linkto, dstname)
    +            elif os.path.isdir(srcname):
    +                copytree(srcname, dstname, symlinks)
    +            else:
    +                copy2(srcname, dstname)
    +            # XXX What about devices, sockets etc.?
    +        except OSError as why:
    +            errors.append((srcname, dstname, str(why)))
    +        # catch the Error from the recursive copytree so that we can
    +        # continue with other files
    +        except Error as err:
    +            errors.extend(err.args[0])
    +    try:
    +        copystat(src, dst)
    +    except OSError as why:
    +        # can't copy file access times on Windows
    +        if why.winerror is None:
    +            errors.extend((src, dst, str(why)))
    +    if errors:
    +        raise Error(errors)
    +
    +
    +

    Another example that uses the ignore_patterns() helper:

    +
    from shutil import copytree, ignore_patterns
    +
    +copytree(source, destination, ignore=ignore_patterns('*.pyc', 'tmp*'))
    +
    +
    +

    This will copy everything except .pyc files and files or directories whose +name starts with tmp.

    +

    Another example that uses the ignore argument to add a logging call:

    +
    from shutil import copytree
    +import logging
    +
    +def _logpath(path, names):
    +    logging.info('Working in %s', path)
    +    return []   # nothing will be ignored
    +
    +copytree(source, destination, ignore=_logpath)
    +
    +
    +
    +
    +

    rmtree example

    +

    This example shows how to remove a directory tree on Windows where some +of the files have their read-only bit set. It uses the onerror callback +to clear the readonly bit and reattempt the remove. Any subsequent failure +will propagate.

    +
    import os, stat
    +import shutil
    +
    +def remove_readonly(func, path, _):
    +    "Clear the readonly bit and reattempt the removal"
    +    os.chmod(path, stat.S_IWRITE)
    +    func(path)
    +
    +shutil.rmtree(directory, onerror=remove_readonly)
    +
    +
    +
    +
    +
    +

    Archiving operations

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.5: Added support for the xztar format.

    +
    +

    High-level utilities to create and read compressed and archived files are also +provided. They rely on the zipfile and tarfile modules.

    +
    +
    +shutil.make_archive(base_name, format[, root_dir[, base_dir[, verbose[, dry_run[, owner[, group[, logger]]]]]]])
    +

    Create an archive file (such as zip or tar) and return its name.

    +

    base_name is the name of the file to create, including the path, minus +any format-specific extension. format is the archive format: one of +“zip” (if the zlib module is available), “tar”, “gztar” (if the +zlib module is available), “bztar” (if the bz2 module is +available), or “xztar” (if the lzma module is available).

    +

    root_dir is a directory that will be the root directory of the +archive; for example, we typically chdir into root_dir before creating the +archive.

    +

    base_dir is the directory where we start archiving from; +i.e. base_dir will be the common prefix of all files and +directories in the archive.

    +

    root_dir and base_dir both default to the current directory.

    +

    If dry_run is true, no archive is created, but the operations that would be +executed are logged to logger.

    +

    owner and group are used when creating a tar archive. By default, +uses the current owner and group.

    +

    logger must be an object compatible with PEP 282, usually an instance of +logging.Logger.

    +

    The verbose argument is unused and deprecated.

    +
    + +
    +
    +shutil.get_archive_formats()
    +

    Return a list of supported formats for archiving. +Each element of the returned sequence is a tuple (name, description).

    +

    By default shutil provides these formats:

    +
      +
    • zip: ZIP file (if the zlib module is available).

    • +
    • tar: uncompressed tar file.

    • +
    • gztar: gzip’ed tar-file (if the zlib module is available).

    • +
    • bztar: bzip2’ed tar-file (if the bz2 module is available).

    • +
    • xztar: xz’ed tar-file (if the lzma module is available).

    • +
    +

    You can register new formats or provide your own archiver for any existing +formats, by using register_archive_format().

    +
    + +
    +
    +shutil.register_archive_format(name, function[, extra_args[, description]])
    +

    Register an archiver for the format name.

    +

    function is the callable that will be used to unpack archives. The callable +will receive the base_name of the file to create, followed by the +base_dir (which defaults to os.curdir) to start archiving from. +Further arguments are passed as keyword arguments: owner, group, +dry_run and logger (as passed in make_archive()).

    +

    If given, extra_args is a sequence of (name, value) pairs that will be +used as extra keywords arguments when the archiver callable is used.

    +

    description is used by get_archive_formats() which returns the +list of archivers. Defaults to an empty string.

    +
    + +
    +
    +shutil.unregister_archive_format(name)
    +

    Remove the archive format name from the list of supported formats.

    +
    + +
    +
    +shutil.unpack_archive(filename[, extract_dir[, format]])
    +

    Unpack an archive. filename is the full path of the archive.

    +

    extract_dir is the name of the target directory where the archive is +unpacked. If not provided, the current working directory is used.

    +

    format is the archive format: one of “zip”, “tar”, “gztar”, “bztar”, or +“xztar”. Or any other format registered with +register_unpack_format(). If not provided, unpack_archive() +will use the archive file name extension and see if an unpacker was +registered for that extension. In case none is found, +a ValueError is raised.

    +
    +

    Changed in version 3.7: Accepts a path-like object for filename and extract_dir.

    +
    +
    + +
    +
    +shutil.register_unpack_format(name, extensions, function[, extra_args[, description]])
    +

    Registers an unpack format. name is the name of the format and +extensions is a list of extensions corresponding to the format, like +.zip for Zip files.

    +

    function is the callable that will be used to unpack archives. The +callable will receive the path of the archive, followed by the directory +the archive must be extracted to.

    +

    When provided, extra_args is a sequence of (name, value) tuples that +will be passed as keywords arguments to the callable.

    +

    description can be provided to describe the format, and will be returned +by the get_unpack_formats() function.

    +
    + +
    +
    +shutil.unregister_unpack_format(name)
    +

    Unregister an unpack format. name is the name of the format.

    +
    + +
    +
    +shutil.get_unpack_formats()
    +

    Return a list of all registered formats for unpacking. +Each element of the returned sequence is a tuple +(name, extensions, description).

    +

    By default shutil provides these formats:

    +
      +
    • zip: ZIP file (unpacking compressed files works only if the corresponding +module is available).

    • +
    • tar: uncompressed tar file.

    • +
    • gztar: gzip’ed tar-file (if the zlib module is available).

    • +
    • bztar: bzip2’ed tar-file (if the bz2 module is available).

    • +
    • xztar: xz’ed tar-file (if the lzma module is available).

    • +
    +

    You can register new formats or provide your own unpacker for any existing +formats, by using register_unpack_format().

    +
    + +
    +

    Archiving example

    +

    In this example, we create a gzip’ed tar-file archive containing all files +found in the .ssh directory of the user:

    +
    >>> from shutil import make_archive
    +>>> import os
    +>>> archive_name = os.path.expanduser(os.path.join('~', 'myarchive'))
    +>>> root_dir = os.path.expanduser(os.path.join('~', '.ssh'))
    +>>> make_archive(archive_name, 'gztar', root_dir)
    +'/Users/tarek/myarchive.tar.gz'
    +
    +
    +

    The resulting archive contains:

    +
    $ tar -tzvf /Users/tarek/myarchive.tar.gz
    +drwx------ tarek/staff       0 2010-02-01 16:23:40 ./
    +-rw-r--r-- tarek/staff     609 2008-06-09 13:26:54 ./authorized_keys
    +-rwxr-xr-x tarek/staff      65 2008-06-09 13:26:54 ./config
    +-rwx------ tarek/staff     668 2008-06-09 13:26:54 ./id_dsa
    +-rwxr-xr-x tarek/staff     609 2008-06-09 13:26:54 ./id_dsa.pub
    +-rw------- tarek/staff    1675 2008-06-09 13:26:54 ./id_rsa
    +-rw-r--r-- tarek/staff     397 2008-06-09 13:26:54 ./id_rsa.pub
    +-rw-r--r-- tarek/staff   37192 2010-02-06 18:23:10 ./known_hosts
    +
    +
    +
    +
    +
    +

    Querying the size of the output terminal

    +
    +
    +shutil.get_terminal_size(fallback=(columns, lines))
    +

    Get the size of the terminal window.

    +

    For each of the two dimensions, the environment variable, COLUMNS +and LINES respectively, is checked. If the variable is defined and +the value is a positive integer, it is used.

    +

    When COLUMNS or LINES is not defined, which is the common case, +the terminal connected to sys.__stdout__ is queried +by invoking os.get_terminal_size().

    +

    If the terminal size cannot be successfully queried, either because +the system doesn’t support querying, or because we are not +connected to a terminal, the value given in fallback parameter +is used. fallback defaults to (80, 24) which is the default +size used by many terminal emulators.

    +

    The value returned is a named tuple of type os.terminal_size.

    +

    See also: The Single UNIX Specification, Version 2, +Other Environment Variables.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/signal.html b/python-3.7.4-docs-html/library/signal.html new file mode 100644 index 0000000..7e7baa1 --- /dev/null +++ b/python-3.7.4-docs-html/library/signal.html @@ -0,0 +1,704 @@ + + + + + + + signal — Set handlers for asynchronous events — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    signal — Set handlers for asynchronous events

    +
    +

    This module provides mechanisms to use signal handlers in Python.

    +
    +

    General rules

    +

    The signal.signal() function allows defining custom handlers to be +executed when a signal is received. A small number of default handlers are +installed: SIGPIPE is ignored (so write errors on pipes and sockets +can be reported as ordinary Python exceptions) and SIGINT is +translated into a KeyboardInterrupt exception if the parent process +has not changed it.

    +

    A handler for a particular signal, once set, remains installed until it is +explicitly reset (Python emulates the BSD style interface regardless of the +underlying implementation), with the exception of the handler for +SIGCHLD, which follows the underlying implementation.

    +
    +

    Execution of Python signal handlers

    +

    A Python signal handler does not get executed inside the low-level (C) signal +handler. Instead, the low-level signal handler sets a flag which tells the +virtual machine to execute the corresponding Python signal handler +at a later point(for example at the next bytecode instruction). +This has consequences:

    +
      +
    • It makes little sense to catch synchronous errors like SIGFPE or +SIGSEGV that are caused by an invalid operation in C code. Python +will return from the signal handler to the C code, which is likely to raise +the same signal again, causing Python to apparently hang. From Python 3.3 +onwards, you can use the faulthandler module to report on synchronous +errors.

    • +
    • A long-running calculation implemented purely in C (such as regular +expression matching on a large body of text) may run uninterrupted for an +arbitrary amount of time, regardless of any signals received. The Python +signal handlers will be called when the calculation finishes.

    • +
    +
    +
    +

    Signals and threads

    +

    Python signal handlers are always executed in the main Python thread, +even if the signal was received in another thread. This means that signals +can’t be used as a means of inter-thread communication. You can use +the synchronization primitives from the threading module instead.

    +

    Besides, only the main thread is allowed to set a new signal handler.

    +
    +
    +
    +

    Module contents

    +
    +

    Changed in version 3.5: signal (SIG*), handler (SIG_DFL, SIG_IGN) and sigmask +(SIG_BLOCK, SIG_UNBLOCK, SIG_SETMASK) +related constants listed below were turned into +enums. +getsignal(), pthread_sigmask(), sigpending() and +sigwait() functions return human-readable +enums.

    +
    +

    The variables defined in the signal module are:

    +
    +
    +signal.SIG_DFL
    +

    This is one of two standard signal handling options; it will simply perform +the default function for the signal. For example, on most systems the +default action for SIGQUIT is to dump core and exit, while the +default action for SIGCHLD is to simply ignore it.

    +
    + +
    +
    +signal.SIG_IGN
    +

    This is another standard signal handler, which will simply ignore the given +signal.

    +
    + +
    +
    +SIG*
    +

    All the signal numbers are defined symbolically. For example, the hangup signal +is defined as signal.SIGHUP; the variable names are identical to the +names used in C programs, as found in <signal.h>. The Unix man page for +‘signal()’ lists the existing signals (on some systems this is +signal(2), on others the list is in signal(7)). Note that +not all systems define the same set of signal names; only those names defined by +the system are defined by this module.

    +
    + +
    +
    +signal.CTRL_C_EVENT
    +

    The signal corresponding to the Ctrl+C keystroke event. This signal can +only be used with os.kill().

    +

    Availability: Windows.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +signal.CTRL_BREAK_EVENT
    +

    The signal corresponding to the Ctrl+Break keystroke event. This signal can +only be used with os.kill().

    +

    Availability: Windows.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +signal.NSIG
    +

    One more than the number of the highest signal number.

    +
    + +
    +
    +signal.ITIMER_REAL
    +

    Decrements interval timer in real time, and delivers SIGALRM upon +expiration.

    +
    + +
    +
    +signal.ITIMER_VIRTUAL
    +

    Decrements interval timer only when the process is executing, and delivers +SIGVTALRM upon expiration.

    +
    + +
    +
    +signal.ITIMER_PROF
    +

    Decrements interval timer both when the process executes and when the +system is executing on behalf of the process. Coupled with ITIMER_VIRTUAL, +this timer is usually used to profile the time spent by the application +in user and kernel space. SIGPROF is delivered upon expiration.

    +
    + +
    +
    +signal.SIG_BLOCK
    +

    A possible value for the how parameter to pthread_sigmask() +indicating that signals are to be blocked.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +signal.SIG_UNBLOCK
    +

    A possible value for the how parameter to pthread_sigmask() +indicating that signals are to be unblocked.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +signal.SIG_SETMASK
    +

    A possible value for the how parameter to pthread_sigmask() +indicating that the signal mask is to be replaced.

    +
    +

    New in version 3.3.

    +
    +
    + +

    The signal module defines one exception:

    +
    +
    +exception signal.ItimerError
    +

    Raised to signal an error from the underlying setitimer() or +getitimer() implementation. Expect this error if an invalid +interval timer or a negative time is passed to setitimer(). +This error is a subtype of OSError.

    +
    +

    New in version 3.3: This error used to be a subtype of IOError, which is now an +alias of OSError.

    +
    +
    + +

    The signal module defines the following functions:

    +
    +
    +signal.alarm(time)
    +

    If time is non-zero, this function requests that a SIGALRM signal be +sent to the process in time seconds. Any previously scheduled alarm is +canceled (only one alarm can be scheduled at any time). The returned value is +then the number of seconds before any previously set alarm was to have been +delivered. If time is zero, no alarm is scheduled, and any scheduled alarm is +canceled. If the return value is zero, no alarm is currently scheduled. (See +the Unix man page alarm(2).)

    +

    Availability: Unix.

    +
    + +
    +
    +signal.getsignal(signalnum)
    +

    Return the current signal handler for the signal signalnum. The returned value +may be a callable Python object, or one of the special values +signal.SIG_IGN, signal.SIG_DFL or None. Here, +signal.SIG_IGN means that the signal was previously ignored, +signal.SIG_DFL means that the default way of handling the signal was +previously in use, and None means that the previous signal handler was not +installed from Python.

    +
    + +
    +
    +signal.pause()
    +

    Cause the process to sleep until a signal is received; the appropriate handler +will then be called. Returns nothing. Not on Windows. (See the Unix man page +signal(2).)

    +

    See also sigwait(), sigwaitinfo(), sigtimedwait() and +sigpending().

    +
    + +
    +
    +signal.pthread_kill(thread_id, signalnum)
    +

    Send the signal signalnum to the thread thread_id, another thread in the +same process as the caller. The target thread can be executing any code +(Python or not). However, if the target thread is executing the Python +interpreter, the Python signal handlers will be executed by the main +thread. Therefore, the only point of sending a +signal to a particular Python thread would be to force a running system call +to fail with InterruptedError.

    +

    Use threading.get_ident() or the ident +attribute of threading.Thread objects to get a suitable value +for thread_id.

    +

    If signalnum is 0, then no signal is sent, but error checking is still +performed; this can be used to check if the target thread is still running.

    +

    Availability: Unix (see the man page pthread_kill(3) for further +information).

    +

    See also os.kill().

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +signal.pthread_sigmask(how, mask)
    +

    Fetch and/or change the signal mask of the calling thread. The signal mask +is the set of signals whose delivery is currently blocked for the caller. +Return the old signal mask as a set of signals.

    +

    The behavior of the call is dependent on the value of how, as follows.

    +
      +
    • SIG_BLOCK: The set of blocked signals is the union of the current +set and the mask argument.

    • +
    • SIG_UNBLOCK: The signals in mask are removed from the current +set of blocked signals. It is permissible to attempt to unblock a +signal which is not blocked.

    • +
    • SIG_SETMASK: The set of blocked signals is set to the mask +argument.

    • +
    +

    mask is a set of signal numbers (e.g. {signal.SIGINT, +signal.SIGTERM}). Use range(1, signal.NSIG) for a full mask +including all signals.

    +

    For example, signal.pthread_sigmask(signal.SIG_BLOCK, []) reads the +signal mask of the calling thread.

    +

    Availability: Unix. See the man page sigprocmask(3) and +pthread_sigmask(3) for further information.

    +

    See also pause(), sigpending() and sigwait().

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +signal.setitimer(which, seconds, interval=0.0)
    +

    Sets given interval timer (one of signal.ITIMER_REAL, +signal.ITIMER_VIRTUAL or signal.ITIMER_PROF) specified +by which to fire after seconds (float is accepted, different from +alarm()) and after that every interval seconds (if interval +is non-zero). The interval timer specified by which can be cleared by +setting seconds to zero.

    +

    When an interval timer fires, a signal is sent to the process. +The signal sent is dependent on the timer being used; +signal.ITIMER_REAL will deliver SIGALRM, +signal.ITIMER_VIRTUAL sends SIGVTALRM, +and signal.ITIMER_PROF will deliver SIGPROF.

    +

    The old values are returned as a tuple: (delay, interval).

    +

    Attempting to pass an invalid interval timer will cause an +ItimerError.

    +

    Availability: Unix.

    +
    + +
    +
    +signal.getitimer(which)
    +

    Returns current value of a given interval timer specified by which.

    +

    Availability: Unix.

    +
    + +
    +
    +signal.set_wakeup_fd(fd, *, warn_on_full_buffer=True)
    +

    Set the wakeup file descriptor to fd. When a signal is received, the +signal number is written as a single byte into the fd. This can be used by +a library to wakeup a poll or select call, allowing the signal to be fully +processed.

    +

    The old wakeup fd is returned (or -1 if file descriptor wakeup was not +enabled). If fd is -1, file descriptor wakeup is disabled. +If not -1, fd must be non-blocking. It is up to the library to remove +any bytes from fd before calling poll or select again.

    +

    When threads are enabled, this function can only be called from the main thread; +attempting to call it from other threads will cause a ValueError +exception to be raised.

    +

    There are two common ways to use this function. In both approaches, +you use the fd to wake up when a signal arrives, but then they +differ in how they determine which signal or signals have +arrived.

    +

    In the first approach, we read the data out of the fd’s buffer, and +the byte values give you the signal numbers. This is simple, but in +rare cases it can run into a problem: generally the fd will have a +limited amount of buffer space, and if too many signals arrive too +quickly, then the buffer may become full, and some signals may be +lost. If you use this approach, then you should set +warn_on_full_buffer=True, which will at least cause a warning +to be printed to stderr when signals are lost.

    +

    In the second approach, we use the wakeup fd only for wakeups, +and ignore the actual byte values. In this case, all we care about +is whether the fd’s buffer is empty or non-empty; a full buffer +doesn’t indicate a problem at all. If you use this approach, then +you should set warn_on_full_buffer=False, so that your users +are not confused by spurious warning messages.

    +
    +

    Changed in version 3.5: On Windows, the function now also supports socket handles.

    +
    +
    +

    Changed in version 3.7: Added warn_on_full_buffer parameter.

    +
    +
    + +
    +
    +signal.siginterrupt(signalnum, flag)
    +

    Change system call restart behaviour: if flag is False, system +calls will be restarted when interrupted by signal signalnum, otherwise +system calls will be interrupted. Returns nothing.

    +

    Availability: Unix (see the man page siginterrupt(3) +for further information).

    +

    Note that installing a signal handler with signal() will reset the +restart behaviour to interruptible by implicitly calling +siginterrupt() with a true flag value for the given signal.

    +
    + +
    +
    +signal.signal(signalnum, handler)
    +

    Set the handler for signal signalnum to the function handler. handler can +be a callable Python object taking two arguments (see below), or one of the +special values signal.SIG_IGN or signal.SIG_DFL. The previous +signal handler will be returned (see the description of getsignal() +above). (See the Unix man page signal(2).)

    +

    When threads are enabled, this function can only be called from the main thread; +attempting to call it from other threads will cause a ValueError +exception to be raised.

    +

    The handler is called with two arguments: the signal number and the current +stack frame (None or a frame object; for a description of frame objects, +see the description in the type hierarchy or see the +attribute descriptions in the inspect module).

    +

    On Windows, signal() can only be called with SIGABRT, +SIGFPE, SIGILL, SIGINT, SIGSEGV, +SIGTERM, or SIGBREAK. +A ValueError will be raised in any other case. +Note that not all systems define the same set of signal names; an +AttributeError will be raised if a signal name is not defined as +SIG* module level constant.

    +
    + +
    +
    +signal.sigpending()
    +

    Examine the set of signals that are pending for delivery to the calling +thread (i.e., the signals which have been raised while blocked). Return the +set of the pending signals.

    +

    Availability: Unix (see the man page sigpending(2) for further +information).

    +

    See also pause(), pthread_sigmask() and sigwait().

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +signal.sigwait(sigset)
    +

    Suspend execution of the calling thread until the delivery of one of the +signals specified in the signal set sigset. The function accepts the signal +(removes it from the pending list of signals), and returns the signal number.

    +

    Availability: Unix (see the man page sigwait(3) for further +information).

    +

    See also pause(), pthread_sigmask(), sigpending(), +sigwaitinfo() and sigtimedwait().

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +signal.sigwaitinfo(sigset)
    +

    Suspend execution of the calling thread until the delivery of one of the +signals specified in the signal set sigset. The function accepts the +signal and removes it from the pending list of signals. If one of the +signals in sigset is already pending for the calling thread, the function +will return immediately with information about that signal. The signal +handler is not called for the delivered signal. The function raises an +InterruptedError if it is interrupted by a signal that is not in +sigset.

    +

    The return value is an object representing the data contained in the +siginfo_t structure, namely: si_signo, si_code, +si_errno, si_pid, si_uid, si_status, +si_band.

    +

    Availability: Unix (see the man page sigwaitinfo(2) for further +information).

    +

    See also pause(), sigwait() and sigtimedwait().

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.5: The function is now retried if interrupted by a signal not in sigset +and the signal handler does not raise an exception (see PEP 475 for +the rationale).

    +
    +
    + +
    +
    +signal.sigtimedwait(sigset, timeout)
    +

    Like sigwaitinfo(), but takes an additional timeout argument +specifying a timeout. If timeout is specified as 0, a poll is +performed. Returns None if a timeout occurs.

    +

    Availability: Unix (see the man page sigtimedwait(2) for further +information).

    +

    See also pause(), sigwait() and sigwaitinfo().

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.5: The function is now retried with the recomputed timeout if interrupted +by a signal not in sigset and the signal handler does not raise an +exception (see PEP 475 for the rationale).

    +
    +
    + +
    +
    +

    Example

    +

    Here is a minimal example program. It uses the alarm() function to limit +the time spent waiting to open a file; this is useful if the file is for a +serial device that may not be turned on, which would normally cause the +os.open() to hang indefinitely. The solution is to set a 5-second alarm +before opening the file; if the operation takes too long, the alarm signal will +be sent, and the handler raises an exception.

    +
    import signal, os
    +
    +def handler(signum, frame):
    +    print('Signal handler called with signal', signum)
    +    raise OSError("Couldn't open device!")
    +
    +# Set the signal handler and a 5-second alarm
    +signal.signal(signal.SIGALRM, handler)
    +signal.alarm(5)
    +
    +# This open() may hang indefinitely
    +fd = os.open('/dev/ttyS0', os.O_RDWR)
    +
    +signal.alarm(0)          # Disable the alarm
    +
    +
    +
    +
    +

    Note on SIGPIPE

    +

    Piping output of your program to tools like head(1) will +cause a SIGPIPE signal to be sent to your process when the receiver +of its standard output closes early. This results in an exception +like BrokenPipeError: [Errno 32] Broken pipe. To handle this +case, wrap your entry point to catch this exception as follows:

    +
    import os
    +import sys
    +
    +def main():
    +    try:
    +        # simulate large output (your code replaces this loop)
    +        for x in range(10000):
    +            print("y")
    +        # flush output here to force SIGPIPE to be triggered
    +        # while inside this try block.
    +        sys.stdout.flush()
    +    except BrokenPipeError:
    +        # Python flushes standard streams on exit; redirect remaining output
    +        # to devnull to avoid another BrokenPipeError at shutdown
    +        devnull = os.open(os.devnull, os.O_WRONLY)
    +        os.dup2(devnull, sys.stdout.fileno())
    +        sys.exit(1)  # Python exits with error code 1 on EPIPE
    +
    +if __name__ == '__main__':
    +    main()
    +
    +
    +

    Do not set SIGPIPE’s disposition to SIG_DFL +in order to avoid BrokenPipeError. Doing that would cause +your program to exit unexpectedly also whenever any socket connection +is interrupted while your program is still writing to it.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/site.html b/python-3.7.4-docs-html/library/site.html new file mode 100644 index 0000000..a50c2c0 --- /dev/null +++ b/python-3.7.4-docs-html/library/site.html @@ -0,0 +1,420 @@ + + + + + + + site — Site-specific configuration hook — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    site — Site-specific configuration hook

    +

    Source code: Lib/site.py

    +
    +

    This module is automatically imported during initialization. The automatic +import can be suppressed using the interpreter’s -S option.

    +

    Importing this module will append site-specific paths to the module search path +and add a few builtins, unless -S was used. In that case, this module +can be safely imported with no automatic modifications to the module search path +or additions to the builtins. To explicitly trigger the usual site-specific +additions, call the site.main() function.

    +
    +

    Changed in version 3.3: Importing the module used to trigger paths manipulation even when using +-S.

    +
    +

    It starts by constructing up to four directories from a head and a tail part. +For the head part, it uses sys.prefix and sys.exec_prefix; empty heads +are skipped. For the tail part, it uses the empty string and then +lib/site-packages (on Windows) or +lib/pythonX.Y/site-packages (on Unix and Macintosh). For each +of the distinct head-tail combinations, it sees if it refers to an existing +directory, and if so, adds it to sys.path and also inspects the newly +added path for configuration files.

    +
    +

    Changed in version 3.5: Support for the “site-python” directory has been removed.

    +
    +

    If a file named “pyvenv.cfg” exists one directory above sys.executable, +sys.prefix and sys.exec_prefix are set to that directory and +it is also checked for site-packages (sys.base_prefix and +sys.base_exec_prefix will always be the “real” prefixes of the Python +installation). If “pyvenv.cfg” (a bootstrap configuration file) contains +the key “include-system-site-packages” set to anything other than “false” +(case-insensitive), the system-level prefixes will still also be +searched for site-packages; otherwise they won’t.

    +

    A path configuration file is a file whose name has the form name.pth +and exists in one of the four directories mentioned above; its contents are +additional items (one per line) to be added to sys.path. Non-existing items +are never added to sys.path, and no check is made that the item refers to a +directory rather than a file. No item is added to sys.path more than +once. Blank lines and lines beginning with # are skipped. Lines starting +with import (followed by space or tab) are executed.

    +

    For example, suppose sys.prefix and sys.exec_prefix are set to +/usr/local. The Python X.Y library is then installed in +/usr/local/lib/pythonX.Y. Suppose this has +a subdirectory /usr/local/lib/pythonX.Y/site-packages with three +subsubdirectories, foo, bar and spam, and two path +configuration files, foo.pth and bar.pth. Assume +foo.pth contains the following:

    +
    # foo package configuration
    +
    +foo
    +bar
    +bletch
    +
    +
    +

    and bar.pth contains:

    +
    # bar package configuration
    +
    +bar
    +
    +
    +

    Then the following version-specific directories are added to +sys.path, in this order:

    +
    /usr/local/lib/pythonX.Y/site-packages/bar
    +/usr/local/lib/pythonX.Y/site-packages/foo
    +
    +
    +

    Note that bletch is omitted because it doesn’t exist; the bar +directory precedes the foo directory because bar.pth comes +alphabetically before foo.pth; and spam is omitted because it is +not mentioned in either path configuration file.

    +

    After these path manipulations, an attempt is made to import a module named +sitecustomize, which can perform arbitrary site-specific customizations. +It is typically created by a system administrator in the site-packages +directory. If this import fails with an ImportError or its subclass +exception, and the exception’s name attribute equals to 'sitecustomize', +it is silently ignored. If Python is started without output streams available, as +with pythonw.exe on Windows (which is used by default to start IDLE), +attempted output from sitecustomize is ignored. Any other exception +causes a silent and perhaps mysterious failure of the process.

    +

    After this, an attempt is made to import a module named usercustomize, +which can perform arbitrary user-specific customizations, if +ENABLE_USER_SITE is true. This file is intended to be created in the +user site-packages directory (see below), which is part of sys.path unless +disabled by -s. If this import fails with an ImportError or +its subclass exception, and the exception’s name attribute equals to +'usercustomize', it is silently ignored.

    +

    Note that for some non-Unix systems, sys.prefix and sys.exec_prefix are +empty, and the path manipulations are skipped; however the import of +sitecustomize and usercustomize is still attempted.

    +
    +

    Readline configuration

    +

    On systems that support readline, this module will also import and +configure the rlcompleter module, if Python is started in +interactive mode and without the -S option. +The default behavior is enable tab-completion and to use +~/.python_history as the history save file. To disable it, delete (or +override) the sys.__interactivehook__ attribute in your +sitecustomize or usercustomize module or your +PYTHONSTARTUP file.

    +
    +

    Changed in version 3.4: Activation of rlcompleter and history was made automatic.

    +
    +
    +
    +

    Module contents

    +
    +
    +site.PREFIXES
    +

    A list of prefixes for site-packages directories.

    +
    + +
    +
    +site.ENABLE_USER_SITE
    +

    Flag showing the status of the user site-packages directory. True means +that it is enabled and was added to sys.path. False means that it +was disabled by user request (with -s or +PYTHONNOUSERSITE). None means it was disabled for security +reasons (mismatch between user or group id and effective id) or by an +administrator.

    +
    + +
    +
    +site.USER_SITE
    +

    Path to the user site-packages for the running Python. Can be None if +getusersitepackages() hasn’t been called yet. Default value is +~/.local/lib/pythonX.Y/site-packages for UNIX and non-framework Mac +OS X builds, ~/Library/Python/X.Y/lib/python/site-packages for Mac +framework builds, and %APPDATA%\Python\PythonXY\site-packages +on Windows. This directory is a site directory, which means that +.pth files in it will be processed.

    +
    + +
    +
    +site.USER_BASE
    +

    Path to the base directory for the user site-packages. Can be None if +getuserbase() hasn’t been called yet. Default value is +~/.local for UNIX and Mac OS X non-framework builds, +~/Library/Python/X.Y for Mac framework builds, and +%APPDATA%\Python for Windows. This value is used by Distutils to +compute the installation directories for scripts, data files, Python modules, +etc. for the user installation scheme. +See also PYTHONUSERBASE.

    +
    + +
    +
    +site.main()
    +

    Adds all the standard site-specific directories to the module search +path. This function is called automatically when this module is imported, +unless the Python interpreter was started with the -S flag.

    +
    +

    Changed in version 3.3: This function used to be called unconditionally.

    +
    +
    + +
    +
    +site.addsitedir(sitedir, known_paths=None)
    +

    Add a directory to sys.path and process its .pth files. Typically +used in sitecustomize or usercustomize (see above).

    +
    + +
    +
    +site.getsitepackages()
    +

    Return a list containing all global site-packages directories.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +site.getuserbase()
    +

    Return the path of the user base directory, USER_BASE. If it is not +initialized yet, this function will also set it, respecting +PYTHONUSERBASE.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +site.getusersitepackages()
    +

    Return the path of the user-specific site-packages directory, +USER_SITE. If it is not initialized yet, this function will also set +it, respecting PYTHONNOUSERSITE and USER_BASE.

    +
    +

    New in version 3.2.

    +
    +
    + +

    The site module also provides a way to get the user directories from the +command line:

    +
    $ python3 -m site --user-site
    +/home/user/.local/lib/python3.3/site-packages
    +
    +
    +

    If it is called without arguments, it will print the contents of +sys.path on the standard output, followed by the value of +USER_BASE and whether the directory exists, then the same thing for +USER_SITE, and finally the value of ENABLE_USER_SITE.

    +
    +
    +--user-base
    +

    Print the path to the user base directory.

    +
    + +
    +
    +--user-site
    +

    Print the path to the user site-packages directory.

    +
    + +

    If both options are given, user base and user site will be printed (always in +this order), separated by os.pathsep.

    +

    If any option is given, the script will exit with one of these values: 0 if +the user site-packages directory is enabled, 1 if it was disabled by the +user, 2 if it is disabled for security reasons or by an administrator, and a +value greater than 2 if there is an error.

    +
    +

    See also

    +

    PEP 370 – Per user site-packages directory

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/smtpd.html b/python-3.7.4-docs-html/library/smtpd.html new file mode 100644 index 0000000..7035df3 --- /dev/null +++ b/python-3.7.4-docs-html/library/smtpd.html @@ -0,0 +1,500 @@ + + + + + + + smtpd — SMTP Server — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    smtpd — SMTP Server

    +

    Source code: Lib/smtpd.py

    +
    +

    This module offers several classes to implement SMTP (email) servers.

    +
    +

    See also

    +

    The aiosmtpd package is a recommended +replacement for this module. It is based on asyncio and provides a +more straightforward API. smtpd should be considered deprecated.

    +
    +

    Several server implementations are present; one is a generic +do-nothing implementation, which can be overridden, while the other two offer +specific mail-sending strategies.

    +

    Additionally the SMTPChannel may be extended to implement very specific +interaction behaviour with SMTP clients.

    +

    The code supports RFC 5321, plus the RFC 1870 SIZE and RFC 6531 +SMTPUTF8 extensions.

    +
    +

    SMTPServer Objects

    +
    +
    +class smtpd.SMTPServer(localaddr, remoteaddr, data_size_limit=33554432, map=None, enable_SMTPUTF8=False, decode_data=False)
    +

    Create a new SMTPServer object, which binds to local address +localaddr. It will treat remoteaddr as an upstream SMTP relayer. Both +localaddr and remoteaddr should be a (host, port) +tuple. The object inherits from asyncore.dispatcher, and so will +insert itself into asyncore’s event loop on instantiation.

    +

    data_size_limit specifies the maximum number of bytes that will be +accepted in a DATA command. A value of None or 0 means no +limit.

    +

    map is the socket map to use for connections (an initially empty +dictionary is a suitable value). If not specified the asyncore +global socket map is used.

    +

    enable_SMTPUTF8 determines whether the SMTPUTF8 extension (as defined +in RFC 6531) should be enabled. The default is False. +When True, SMTPUTF8 is accepted as a parameter to the MAIL +command and when present is passed to process_message() in the +kwargs['mail_options'] list. decode_data and enable_SMTPUTF8 +cannot be set to True at the same time.

    +

    decode_data specifies whether the data portion of the SMTP transaction +should be decoded using UTF-8. When decode_data is False (the +default), the server advertises the 8BITMIME +extension (RFC 6152), accepts the BODY=8BITMIME parameter to +the MAIL command, and when present passes it to process_message() +in the kwargs['mail_options'] list. decode_data and enable_SMTPUTF8 +cannot be set to True at the same time.

    +
    +
    +process_message(peer, mailfrom, rcpttos, data, **kwargs)
    +

    Raise a NotImplementedError exception. Override this in subclasses to +do something useful with this message. Whatever was passed in the +constructor as remoteaddr will be available as the _remoteaddr +attribute. peer is the remote host’s address, mailfrom is the envelope +originator, rcpttos are the envelope recipients and data is a string +containing the contents of the e-mail (which should be in RFC 5321 +format).

    +

    If the decode_data constructor keyword is set to True, the data +argument will be a unicode string. If it is set to False, it +will be a bytes object.

    +

    kwargs is a dictionary containing additional information. It is empty +if decode_data=True was given as an init argument, otherwise +it contains the following keys:

    +
    +
    +
    mail_options:

    a list of all received parameters to the MAIL +command (the elements are uppercase strings; example: +['BODY=8BITMIME', 'SMTPUTF8']).

    +
    +
    rcpt_options:

    same as mail_options but for the RCPT command. +Currently no RCPT TO options are supported, so for now +this will always be an empty list.

    +
    +
    +
    +

    Implementations of process_message should use the **kwargs +signature to accept arbitrary keyword arguments, since future feature +enhancements may add keys to the kwargs dictionary.

    +

    Return None to request a normal 250 Ok response; otherwise +return the desired response string in RFC 5321 format.

    +
    + +
    +
    +channel_class
    +

    Override this in subclasses to use a custom SMTPChannel for +managing SMTP clients.

    +
    + +
    +

    New in version 3.4: The map constructor argument.

    +
    +
    +

    Changed in version 3.5: localaddr and remoteaddr may now contain IPv6 addresses.

    +
    +
    +

    New in version 3.5: The decode_data and enable_SMTPUTF8 constructor parameters, and the +kwargs parameter to process_message() when decode_data is +False.

    +
    +
    +

    Changed in version 3.6: decode_data is now False by default.

    +
    +
    + +
    +
    +

    DebuggingServer Objects

    +
    +
    +class smtpd.DebuggingServer(localaddr, remoteaddr)
    +

    Create a new debugging server. Arguments are as per SMTPServer. +Messages will be discarded, and printed on stdout.

    +
    + +
    +
    +

    PureProxy Objects

    +
    +
    +class smtpd.PureProxy(localaddr, remoteaddr)
    +

    Create a new pure proxy server. Arguments are as per SMTPServer. +Everything will be relayed to remoteaddr. Note that running this has a good +chance to make you into an open relay, so please be careful.

    +
    + +
    +
    +

    MailmanProxy Objects

    +
    +
    +class smtpd.MailmanProxy(localaddr, remoteaddr)
    +

    Create a new pure proxy server. Arguments are as per SMTPServer. +Everything will be relayed to remoteaddr, unless local mailman configurations +knows about an address, in which case it will be handled via mailman. Note that +running this has a good chance to make you into an open relay, so please be +careful.

    +
    + +
    +
    +

    SMTPChannel Objects

    +
    +
    +class smtpd.SMTPChannel(server, conn, addr, data_size_limit=33554432, map=None, enable_SMTPUTF8=False, decode_data=False)
    +

    Create a new SMTPChannel object which manages the communication +between the server and a single SMTP client.

    +

    conn and addr are as per the instance variables described below.

    +

    data_size_limit specifies the maximum number of bytes that will be +accepted in a DATA command. A value of None or 0 means no +limit.

    +

    enable_SMTPUTF8 determines whether the SMTPUTF8 extension (as defined +in RFC 6531) should be enabled. The default is False. +decode_data and enable_SMTPUTF8 cannot be set to True at the same +time.

    +

    A dictionary can be specified in map to avoid using a global socket map.

    +

    decode_data specifies whether the data portion of the SMTP transaction +should be decoded using UTF-8. The default is False. +decode_data and enable_SMTPUTF8 cannot be set to True at the same +time.

    +

    To use a custom SMTPChannel implementation you need to override the +SMTPServer.channel_class of your SMTPServer.

    +
    +

    Changed in version 3.5: The decode_data and enable_SMTPUTF8 parameters were added.

    +
    +
    +

    Changed in version 3.6: decode_data is now False by default.

    +
    +

    The SMTPChannel has the following instance variables:

    +
    +
    +smtp_server
    +

    Holds the SMTPServer that spawned this channel.

    +
    + +
    +
    +conn
    +

    Holds the socket object connecting to the client.

    +
    + +
    +
    +addr
    +

    Holds the address of the client, the second value returned by +socket.accept

    +
    + +
    +
    +received_lines
    +

    Holds a list of the line strings (decoded using UTF-8) received from +the client. The lines have their "\r\n" line ending translated to +"\n".

    +
    + +
    +
    +smtp_state
    +

    Holds the current state of the channel. This will be either +COMMAND initially and then DATA after the client sends +a “DATA” line.

    +
    + +
    +
    +seen_greeting
    +

    Holds a string containing the greeting sent by the client in its “HELO”.

    +
    + +
    +
    +mailfrom
    +

    Holds a string containing the address identified in the “MAIL FROM:” line +from the client.

    +
    + +
    +
    +rcpttos
    +

    Holds a list of strings containing the addresses identified in the +“RCPT TO:” lines from the client.

    +
    + +
    +
    +received_data
    +

    Holds a string containing all of the data sent by the client during the +DATA state, up to but not including the terminating "\r\n.\r\n".

    +
    + +
    +
    +fqdn
    +

    Holds the fully-qualified domain name of the server as returned by +socket.getfqdn().

    +
    + +
    +
    +peer
    +

    Holds the name of the client peer as returned by conn.getpeername() +where conn is conn.

    +
    + +

    The SMTPChannel operates by invoking methods named smtp_<command> +upon reception of a command line from the client. Built into the base +SMTPChannel class are methods for handling the following commands +(and responding to them appropriately):

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Command

    Action taken

    HELO

    Accepts the greeting from the client and stores it in +seen_greeting. Sets server to base command mode.

    EHLO

    Accepts the greeting from the client and stores it in +seen_greeting. Sets server to extended command mode.

    NOOP

    Takes no action.

    QUIT

    Closes the connection cleanly.

    MAIL

    Accepts the “MAIL FROM:” syntax and stores the supplied address as +mailfrom. In extended command mode, accepts the +RFC 1870 SIZE attribute and responds appropriately based on the +value of data_size_limit.

    RCPT

    Accepts the “RCPT TO:” syntax and stores the supplied addresses in +the rcpttos list.

    RSET

    Resets the mailfrom, rcpttos, and +received_data, but not the greeting.

    DATA

    Sets the internal state to DATA and stores remaining lines +from the client in received_data until the terminator +"\r\n.\r\n" is received.

    HELP

    Returns minimal information on command syntax

    VRFY

    Returns code 252 (the server doesn’t know if the address is valid)

    EXPN

    Reports that the command is not implemented.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/smtplib.html b/python-3.7.4-docs-html/library/smtplib.html new file mode 100644 index 0000000..06d41b9 --- /dev/null +++ b/python-3.7.4-docs-html/library/smtplib.html @@ -0,0 +1,750 @@ + + + + + + + smtplib — SMTP protocol client — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    smtplib — SMTP protocol client

    +

    Source code: Lib/smtplib.py

    +
    +

    The smtplib module defines an SMTP client session object that can be used +to send mail to any Internet machine with an SMTP or ESMTP listener daemon. For +details of SMTP and ESMTP operation, consult RFC 821 (Simple Mail Transfer +Protocol) and RFC 1869 (SMTP Service Extensions).

    +
    +
    +class smtplib.SMTP(host='', port=0, local_hostname=None, [timeout, ]source_address=None)
    +

    An SMTP instance encapsulates an SMTP connection. It has methods +that support a full repertoire of SMTP and ESMTP operations. If the optional +host and port parameters are given, the SMTP connect() method is +called with those parameters during initialization. If specified, +local_hostname is used as the FQDN of the local host in the HELO/EHLO +command. Otherwise, the local hostname is found using +socket.getfqdn(). If the connect() call returns anything other +than a success code, an SMTPConnectError is raised. The optional +timeout parameter specifies a timeout in seconds for blocking operations +like the connection attempt (if not specified, the global default timeout +setting will be used). If the timeout expires, socket.timeout is +raised. The optional source_address parameter allows binding +to some specific source address in a machine with multiple network +interfaces, and/or to some specific source TCP port. It takes a 2-tuple +(host, port), for the socket to bind to as its source address before +connecting. If omitted (or if host or port are '' and/or 0 respectively) +the OS default behavior will be used.

    +

    For normal use, you should only require the initialization/connect, +sendmail(), and SMTP.quit() methods. +An example is included below.

    +

    The SMTP class supports the with statement. When used +like this, the SMTP QUIT command is issued automatically when the +with statement exits. E.g.:

    +
    >>> from smtplib import SMTP
    +>>> with SMTP("domain.org") as smtp:
    +...     smtp.noop()
    +...
    +(250, b'Ok')
    +>>>
    +
    +
    +
    +

    Changed in version 3.3: Support for the with statement was added.

    +
    +
    +

    Changed in version 3.3: source_address argument was added.

    +
    +
    +

    New in version 3.5: The SMTPUTF8 extension (RFC 6531) is now supported.

    +
    +
    + +
    +
    +class smtplib.SMTP_SSL(host='', port=0, local_hostname=None, keyfile=None, certfile=None, [timeout, ]context=None, source_address=None)
    +

    An SMTP_SSL instance behaves exactly the same as instances of +SMTP. SMTP_SSL should be used for situations where SSL is +required from the beginning of the connection and using starttls() is +not appropriate. If host is not specified, the local host is used. If +port is zero, the standard SMTP-over-SSL port (465) is used. The optional +arguments local_hostname, timeout and source_address have the same +meaning as they do in the SMTP class. context, also optional, +can contain a SSLContext and allows configuring various +aspects of the secure connection. Please read Security considerations for +best practices.

    +

    keyfile and certfile are a legacy alternative to context, and can +point to a PEM formatted private key and certificate chain file for the +SSL connection.

    +
    +

    Changed in version 3.3: context was added.

    +
    +
    +

    Changed in version 3.3: source_address argument was added.

    +
    +
    +

    Changed in version 3.4: The class now supports hostname check with +ssl.SSLContext.check_hostname and Server Name Indication (see +ssl.HAS_SNI).

    +
    +
    +

    Deprecated since version 3.6: keyfile and certfile are deprecated in favor of context. +Please use ssl.SSLContext.load_cert_chain() instead, or let +ssl.create_default_context() select the system’s trusted CA +certificates for you.

    +
    +
    + +
    +
    +class smtplib.LMTP(host='', port=LMTP_PORT, local_hostname=None, source_address=None)
    +

    The LMTP protocol, which is very similar to ESMTP, is heavily based on the +standard SMTP client. It’s common to use Unix sockets for LMTP, so our +connect() method must support that as well as a regular host:port +server. The optional arguments local_hostname and source_address have the +same meaning as they do in the SMTP class. To specify a Unix +socket, you must use an absolute path for host, starting with a ‘/’.

    +

    Authentication is supported, using the regular SMTP mechanism. When using a +Unix socket, LMTP generally don’t support or require any authentication, but +your mileage might vary.

    +
    + +

    A nice selection of exceptions is defined as well:

    +
    +
    +exception smtplib.SMTPException
    +

    Subclass of OSError that is the base exception class for all +the other exceptions provided by this module.

    +
    +

    Changed in version 3.4: SMTPException became subclass of OSError

    +
    +
    + +
    +
    +exception smtplib.SMTPServerDisconnected
    +

    This exception is raised when the server unexpectedly disconnects, or when an +attempt is made to use the SMTP instance before connecting it to a +server.

    +
    + +
    +
    +exception smtplib.SMTPResponseException
    +

    Base class for all exceptions that include an SMTP error code. These exceptions +are generated in some instances when the SMTP server returns an error code. The +error code is stored in the smtp_code attribute of the error, and the +smtp_error attribute is set to the error message.

    +
    + +
    +
    +exception smtplib.SMTPSenderRefused
    +

    Sender address refused. In addition to the attributes set by on all +SMTPResponseException exceptions, this sets ‘sender’ to the string that +the SMTP server refused.

    +
    + +
    +
    +exception smtplib.SMTPRecipientsRefused
    +

    All recipient addresses refused. The errors for each recipient are accessible +through the attribute recipients, which is a dictionary of exactly the +same sort as SMTP.sendmail() returns.

    +
    + +
    +
    +exception smtplib.SMTPDataError
    +

    The SMTP server refused to accept the message data.

    +
    + +
    +
    +exception smtplib.SMTPConnectError
    +

    Error occurred during establishment of a connection with the server.

    +
    + +
    +
    +exception smtplib.SMTPHeloError
    +

    The server refused our HELO message.

    +
    + +
    +
    +exception smtplib.SMTPNotSupportedError
    +

    The command or option attempted is not supported by the server.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +exception smtplib.SMTPAuthenticationError
    +

    SMTP authentication went wrong. Most probably the server didn’t accept the +username/password combination provided.

    +
    + +
    +

    See also

    +
    +
    RFC 821 - Simple Mail Transfer Protocol

    Protocol definition for SMTP. This document covers the model, operating +procedure, and protocol details for SMTP.

    +
    +
    RFC 1869 - SMTP Service Extensions

    Definition of the ESMTP extensions for SMTP. This describes a framework for +extending SMTP with new commands, supporting dynamic discovery of the commands +provided by the server, and defines a few additional commands.

    +
    +
    +
    +
    +

    SMTP Objects

    +

    An SMTP instance has the following methods:

    +
    +
    +SMTP.set_debuglevel(level)
    +

    Set the debug output level. A value of 1 or True for level results in +debug messages for connection and for all messages sent to and received from +the server. A value of 2 for level results in these messages being +timestamped.

    +
    +

    Changed in version 3.5: Added debuglevel 2.

    +
    +
    + +
    +
    +SMTP.docmd(cmd, args='')
    +

    Send a command cmd to the server. The optional argument args is simply +concatenated to the command, separated by a space.

    +

    This returns a 2-tuple composed of a numeric response code and the actual +response line (multiline responses are joined into one long line.)

    +

    In normal operation it should not be necessary to call this method explicitly. +It is used to implement other methods and may be useful for testing private +extensions.

    +

    If the connection to the server is lost while waiting for the reply, +SMTPServerDisconnected will be raised.

    +
    + +
    +
    +SMTP.connect(host='localhost', port=0)
    +

    Connect to a host on a given port. The defaults are to connect to the local +host at the standard SMTP port (25). If the hostname ends with a colon (':') +followed by a number, that suffix will be stripped off and the number +interpreted as the port number to use. This method is automatically invoked by +the constructor if a host is specified during instantiation. Returns a +2-tuple of the response code and message sent by the server in its +connection response.

    +
    + +
    +
    +SMTP.helo(name='')
    +

    Identify yourself to the SMTP server using HELO. The hostname argument +defaults to the fully qualified domain name of the local host. +The message returned by the server is stored as the helo_resp attribute +of the object.

    +

    In normal operation it should not be necessary to call this method explicitly. +It will be implicitly called by the sendmail() when necessary.

    +
    + +
    +
    +SMTP.ehlo(name='')
    +

    Identify yourself to an ESMTP server using EHLO. The hostname argument +defaults to the fully qualified domain name of the local host. Examine the +response for ESMTP option and store them for use by has_extn(). +Also sets several informational attributes: the message returned by +the server is stored as the ehlo_resp attribute, does_esmtp +is set to true or false depending on whether the server supports ESMTP, and +esmtp_features will be a dictionary containing the names of the +SMTP service extensions this server supports, and their parameters (if any).

    +

    Unless you wish to use has_extn() before sending mail, it should not be +necessary to call this method explicitly. It will be implicitly called by +sendmail() when necessary.

    +
    + +
    +
    +SMTP.ehlo_or_helo_if_needed()
    +

    This method calls ehlo() and/or helo() if there has been no +previous EHLO or HELO command this session. It tries ESMTP EHLO +first.

    +
    +
    SMTPHeloError

    The server didn’t reply properly to the HELO greeting.

    +
    +
    +
    + +
    +
    +SMTP.has_extn(name)
    +

    Return True if name is in the set of SMTP service extensions returned +by the server, False otherwise. Case is ignored.

    +
    + +
    +
    +SMTP.verify(address)
    +

    Check the validity of an address on this server using SMTP VRFY. Returns a +tuple consisting of code 250 and a full RFC 822 address (including human +name) if the user address is valid. Otherwise returns an SMTP error code of 400 +or greater and an error string.

    +
    +

    Note

    +

    Many sites disable SMTP VRFY in order to foil spammers.

    +
    +
    + +
    +
    +SMTP.login(user, password, *, initial_response_ok=True)
    +

    Log in on an SMTP server that requires authentication. The arguments are the +username and the password to authenticate with. If there has been no previous +EHLO or HELO command this session, this method tries ESMTP EHLO +first. This method will return normally if the authentication was successful, or +may raise the following exceptions:

    +
    +
    SMTPHeloError

    The server didn’t reply properly to the HELO greeting.

    +
    +
    SMTPAuthenticationError

    The server didn’t accept the username/password combination.

    +
    +
    SMTPNotSupportedError

    The AUTH command is not supported by the server.

    +
    +
    SMTPException

    No suitable authentication method was found.

    +
    +
    +

    Each of the authentication methods supported by smtplib are tried in +turn if they are advertised as supported by the server. See auth() +for a list of supported authentication methods. initial_response_ok is +passed through to auth().

    +

    Optional keyword argument initial_response_ok specifies whether, for +authentication methods that support it, an “initial response” as specified +in RFC 4954 can be sent along with the AUTH command, rather than +requiring a challenge/response.

    +
    +

    Changed in version 3.5: SMTPNotSupportedError may be raised, and the +initial_response_ok parameter was added.

    +
    +
    + +
    +
    +SMTP.auth(mechanism, authobject, *, initial_response_ok=True)
    +

    Issue an SMTP AUTH command for the specified authentication +mechanism, and handle the challenge response via authobject.

    +

    mechanism specifies which authentication mechanism is to +be used as argument to the AUTH command; the valid values are +those listed in the auth element of esmtp_features.

    +

    authobject must be a callable object taking an optional single argument:

    +
    +

    data = authobject(challenge=None)

    +
    +

    If optional keyword argument initial_response_ok is true, +authobject() will be called first with no argument. It can return the +RFC 4954 “initial response” ASCII str which will be encoded and sent with +the AUTH command as below. If the authobject() does not support an +initial response (e.g. because it requires a challenge), it should return +None when called with challenge=None. If initial_response_ok is +false, then authobject() will not be called first with None.

    +

    If the initial response check returns None, or if initial_response_ok is +false, authobject() will be called to process the server’s challenge +response; the challenge argument it is passed will be a bytes. It +should return ASCII str data that will be base64 encoded and sent to the +server.

    +

    The SMTP class provides authobjects for the CRAM-MD5, PLAIN, +and LOGIN mechanisms; they are named SMTP.auth_cram_md5, +SMTP.auth_plain, and SMTP.auth_login respectively. They all require +that the user and password properties of the SMTP instance are +set to appropriate values.

    +

    User code does not normally need to call auth directly, but can instead +call the login() method, which will try each of the above mechanisms +in turn, in the order listed. auth is exposed to facilitate the +implementation of authentication methods not (or not yet) supported +directly by smtplib.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +SMTP.starttls(keyfile=None, certfile=None, context=None)
    +

    Put the SMTP connection in TLS (Transport Layer Security) mode. All SMTP +commands that follow will be encrypted. You should then call ehlo() +again.

    +

    If keyfile and certfile are provided, they are used to create an +ssl.SSLContext.

    +

    Optional context parameter is an ssl.SSLContext object; This is +an alternative to using a keyfile and a certfile and if specified both +keyfile and certfile should be None.

    +

    If there has been no previous EHLO or HELO command this session, +this method tries ESMTP EHLO first.

    +
    +

    Deprecated since version 3.6: keyfile and certfile are deprecated in favor of context. +Please use ssl.SSLContext.load_cert_chain() instead, or let +ssl.create_default_context() select the system’s trusted CA +certificates for you.

    +
    +
    +
    SMTPHeloError

    The server didn’t reply properly to the HELO greeting.

    +
    +
    SMTPNotSupportedError

    The server does not support the STARTTLS extension.

    +
    +
    RuntimeError

    SSL/TLS support is not available to your Python interpreter.

    +
    +
    +
    +

    Changed in version 3.3: context was added.

    +
    +
    +

    Changed in version 3.4: The method now supports hostname check with +SSLContext.check_hostname and Server Name Indicator (see +HAS_SNI).

    +
    +
    +

    Changed in version 3.5: The error raised for lack of STARTTLS support is now the +SMTPNotSupportedError subclass instead of the base +SMTPException.

    +
    +
    + +
    +
    +SMTP.sendmail(from_addr, to_addrs, msg, mail_options=(), rcpt_options=())
    +

    Send mail. The required arguments are an RFC 822 from-address string, a list +of RFC 822 to-address strings (a bare string will be treated as a list with 1 +address), and a message string. The caller may pass a list of ESMTP options +(such as 8bitmime) to be used in MAIL FROM commands as mail_options. +ESMTP options (such as DSN commands) that should be used with all RCPT +commands can be passed as rcpt_options. (If you need to use different ESMTP +options to different recipients you have to use the low-level methods such as +mail(), rcpt() and data() to send the message.)

    +
    +

    Note

    +

    The from_addr and to_addrs parameters are used to construct the message +envelope used by the transport agents. sendmail does not modify the +message headers in any way.

    +
    +

    msg may be a string containing characters in the ASCII range, or a byte +string. A string is encoded to bytes using the ascii codec, and lone \r +and \n characters are converted to \r\n characters. A byte string is +not modified.

    +

    If there has been no previous EHLO or HELO command this session, this +method tries ESMTP EHLO first. If the server does ESMTP, message size and +each of the specified options will be passed to it (if the option is in the +feature set the server advertises). If EHLO fails, HELO will be tried +and ESMTP options suppressed.

    +

    This method will return normally if the mail is accepted for at least one +recipient. Otherwise it will raise an exception. That is, if this method does +not raise an exception, then someone should get your mail. If this method does +not raise an exception, it returns a dictionary, with one entry for each +recipient that was refused. Each entry contains a tuple of the SMTP error code +and the accompanying error message sent by the server.

    +

    If SMTPUTF8 is included in mail_options, and the server supports it, +from_addr and to_addrs may contain non-ASCII characters.

    +

    This method may raise the following exceptions:

    +
    +
    SMTPRecipientsRefused

    All recipients were refused. Nobody got the mail. The recipients +attribute of the exception object is a dictionary with information about the +refused recipients (like the one returned when at least one recipient was +accepted).

    +
    +
    SMTPHeloError

    The server didn’t reply properly to the HELO greeting.

    +
    +
    SMTPSenderRefused

    The server didn’t accept the from_addr.

    +
    +
    SMTPDataError

    The server replied with an unexpected error code (other than a refusal of a +recipient).

    +
    +
    SMTPNotSupportedError

    SMTPUTF8 was given in the mail_options but is not supported by the +server.

    +
    +
    +

    Unless otherwise noted, the connection will be open even after an exception is +raised.

    +
    +

    Changed in version 3.2: msg may be a byte string.

    +
    +
    +

    Changed in version 3.5: SMTPUTF8 support added, and SMTPNotSupportedError may be +raised if SMTPUTF8 is specified but the server does not support it.

    +
    +
    + +
    +
    +SMTP.send_message(msg, from_addr=None, to_addrs=None, mail_options=(), rcpt_options=())
    +

    This is a convenience method for calling sendmail() with the message +represented by an email.message.Message object. The arguments have +the same meaning as for sendmail(), except that msg is a Message +object.

    +

    If from_addr is None or to_addrs is None, send_message fills +those arguments with addresses extracted from the headers of msg as +specified in RFC 5322: from_addr is set to the Sender +field if it is present, and otherwise to the From field. +to_addrs combines the values (if any) of the To, +Cc, and Bcc fields from msg. If exactly one +set of Resent-* headers appear in the message, the regular +headers are ignored and the Resent-* headers are used instead. +If the message contains more than one set of Resent-* headers, +a ValueError is raised, since there is no way to unambiguously detect +the most recent set of Resent- headers.

    +

    send_message serializes msg using +BytesGenerator with \r\n as the linesep, and +calls sendmail() to transmit the resulting message. Regardless of the +values of from_addr and to_addrs, send_message does not transmit any +Bcc or Resent-Bcc headers that may appear +in msg. If any of the addresses in from_addr and to_addrs contain +non-ASCII characters and the server does not advertise SMTPUTF8 support, +an SMTPNotSupported error is raised. Otherwise the Message is +serialized with a clone of its policy with the +utf8 attribute set to True, and +SMTPUTF8 and BODY=8BITMIME are added to mail_options.

    +
    +

    New in version 3.2.

    +
    +
    +

    New in version 3.5: Support for internationalized addresses (SMTPUTF8).

    +
    +
    + +
    +
    +SMTP.quit()
    +

    Terminate the SMTP session and close the connection. Return the result of +the SMTP QUIT command.

    +
    + +

    Low-level methods corresponding to the standard SMTP/ESMTP commands HELP, +RSET, NOOP, MAIL, RCPT, and DATA are also supported. +Normally these do not need to be called directly, so they are not documented +here. For details, consult the module code.

    +
    +
    +

    SMTP Example

    +

    This example prompts the user for addresses needed in the message envelope (‘To’ +and ‘From’ addresses), and the message to be delivered. Note that the headers +to be included with the message must be included in the message as entered; this +example doesn’t do any processing of the RFC 822 headers. In particular, the +‘To’ and ‘From’ addresses must be included in the message headers explicitly.

    +
    import smtplib
    +
    +def prompt(prompt):
    +    return input(prompt).strip()
    +
    +fromaddr = prompt("From: ")
    +toaddrs  = prompt("To: ").split()
    +print("Enter message, end with ^D (Unix) or ^Z (Windows):")
    +
    +# Add the From: and To: headers at the start!
    +msg = ("From: %s\r\nTo: %s\r\n\r\n"
    +       % (fromaddr, ", ".join(toaddrs)))
    +while True:
    +    try:
    +        line = input()
    +    except EOFError:
    +        break
    +    if not line:
    +        break
    +    msg = msg + line
    +
    +print("Message length is", len(msg))
    +
    +server = smtplib.SMTP('localhost')
    +server.set_debuglevel(1)
    +server.sendmail(fromaddr, toaddrs, msg)
    +server.quit()
    +
    +
    +
    +

    Note

    +

    In general, you will want to use the email package’s features to +construct an email message, which you can then send +via send_message(); see email: Examples.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/sndhdr.html b/python-3.7.4-docs-html/library/sndhdr.html new file mode 100644 index 0000000..8a0ca10 --- /dev/null +++ b/python-3.7.4-docs-html/library/sndhdr.html @@ -0,0 +1,220 @@ + + + + + + + sndhdr — Determine type of sound file — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    sndhdr — Determine type of sound file

    +

    Source code: Lib/sndhdr.py

    +
    +

    The sndhdr provides utility functions which attempt to determine the type +of sound data which is in a file. When these functions are able to determine +what type of sound data is stored in a file, they return a +namedtuple(), containing five attributes: (filetype, +framerate, nchannels, nframes, sampwidth). The value for type +indicates the data type and will be one of the strings 'aifc', 'aiff', +'au', 'hcom', 'sndr', 'sndt', 'voc', 'wav', '8svx', +'sb', 'ub', or 'ul'. The sampling_rate will be either the actual +value or 0 if unknown or difficult to decode. Similarly, channels will be +either the number of channels or 0 if it cannot be determined or if the +value is difficult to decode. The value for frames will be either the number +of frames or -1. The last item in the tuple, bits_per_sample, will either +be the sample size in bits or 'A' for A-LAW or 'U' for u-LAW.

    +
    +
    +sndhdr.what(filename)
    +

    Determines the type of sound data stored in the file filename using +whathdr(). If it succeeds, returns a namedtuple as described above, otherwise +None is returned.

    +
    +

    Changed in version 3.5: Result changed from a tuple to a namedtuple.

    +
    +
    + +
    +
    +sndhdr.whathdr(filename)
    +

    Determines the type of sound data stored in a file based on the file header. +The name of the file is given by filename. This function returns a namedtuple as +described above on success, or None.

    +
    +

    Changed in version 3.5: Result changed from a tuple to a namedtuple.

    +
    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/socket.html b/python-3.7.4-docs-html/library/socket.html new file mode 100644 index 0000000..6c9010b --- /dev/null +++ b/python-3.7.4-docs-html/library/socket.html @@ -0,0 +1,2170 @@ + + + + + + + socket — Low-level networking interface — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    socket — Low-level networking interface

    +

    Source code: Lib/socket.py

    +
    +

    This module provides access to the BSD socket interface. It is available on +all modern Unix systems, Windows, MacOS, and probably additional platforms.

    +
    +

    Note

    +

    Some behavior may be platform dependent, since calls are made to the operating +system socket APIs.

    +
    +

    The Python interface is a straightforward transliteration of the Unix system +call and library interface for sockets to Python’s object-oriented style: the +socket() function returns a socket object whose methods implement +the various socket system calls. Parameter types are somewhat higher-level than +in the C interface: as with read() and write() operations on Python +files, buffer allocation on receive operations is automatic, and buffer length +is implicit on send operations.

    +
    +

    See also

    +
    +
    Module socketserver

    Classes that simplify writing network servers.

    +
    +
    Module ssl

    A TLS/SSL wrapper for socket objects.

    +
    +
    +
    +
    +

    Socket families

    +

    Depending on the system and the build options, various socket families +are supported by this module.

    +

    The address format required by a particular socket object is automatically +selected based on the address family specified when the socket object was +created. Socket addresses are represented as follows:

    +
      +
    • The address of an AF_UNIX socket bound to a file system node +is represented as a string, using the file system encoding and the +'surrogateescape' error handler (see PEP 383). An address in +Linux’s abstract namespace is returned as a bytes-like object with +an initial null byte; note that sockets in this namespace can +communicate with normal file system sockets, so programs intended to +run on Linux may need to deal with both types of address. A string or +bytes-like object can be used for either type of address when +passing it as an argument.

      +
      +
      +

      Changed in version 3.3: Previously, AF_UNIX socket paths were assumed to use UTF-8 +encoding.

      +
      +
      +

      Changed in version 3.5: Writable bytes-like object is now accepted.

      +
      +
      +
    • +
    +
      +
    • A pair (host, port) is used for the AF_INET address family, +where host is a string representing either a hostname in Internet domain +notation like 'daring.cwi.nl' or an IPv4 address like '100.50.200.5', +and port is an integer.

      +
        +
      • For IPv4 addresses, two special forms are accepted instead of a host +address: '' represents INADDR_ANY, which is used to bind to all +interfaces, and the string '<broadcast>' represents +INADDR_BROADCAST. This behavior is not compatible with IPv6, +therefore, you may want to avoid these if you intend to support IPv6 with your +Python programs.

      • +
      +
    • +
    • For AF_INET6 address family, a four-tuple (host, port, flowinfo, +scopeid) is used, where flowinfo and scopeid represent the sin6_flowinfo +and sin6_scope_id members in struct sockaddr_in6 in C. For +socket module methods, flowinfo and scopeid can be omitted just for +backward compatibility. Note, however, omission of scopeid can cause problems +in manipulating scoped IPv6 addresses.

      +
      +

      Changed in version 3.7: For multicast addresses (with scopeid meaningful) address may not contain +%scope (or zone id) part. This information is superfluous and may +be safely omitted (recommended).

      +
      +
    • +
    • AF_NETLINK sockets are represented as pairs (pid, groups).

    • +
    • Linux-only support for TIPC is available using the AF_TIPC +address family. TIPC is an open, non-IP based networked protocol designed +for use in clustered computer environments. Addresses are represented by a +tuple, and the fields depend on the address type. The general tuple form is +(addr_type, v1, v2, v3 [, scope]), where:

      +
        +
      • addr_type is one of TIPC_ADDR_NAMESEQ, TIPC_ADDR_NAME, +or TIPC_ADDR_ID.

      • +
      • scope is one of TIPC_ZONE_SCOPE, TIPC_CLUSTER_SCOPE, and +TIPC_NODE_SCOPE.

      • +
      • If addr_type is TIPC_ADDR_NAME, then v1 is the server type, v2 is +the port identifier, and v3 should be 0.

        +

        If addr_type is TIPC_ADDR_NAMESEQ, then v1 is the server type, v2 +is the lower port number, and v3 is the upper port number.

        +

        If addr_type is TIPC_ADDR_ID, then v1 is the node, v2 is the +reference, and v3 should be set to 0.

        +
      • +
      +
    • +
    • A tuple (interface, ) is used for the AF_CAN address family, +where interface is a string representing a network interface name like +'can0'. The network interface name '' can be used to receive packets +from all network interfaces of this family.

      +
        +
      • CAN_ISOTP protocol require a tuple (interface, rx_addr, tx_addr) +where both additional parameters are unsigned long integer that represent a +CAN identifier (standard or extended).

      • +
      +
    • +
    • A string or a tuple (id, unit) is used for the SYSPROTO_CONTROL +protocol of the PF_SYSTEM family. The string is the name of a +kernel control using a dynamically-assigned ID. The tuple can be used if ID +and unit number of the kernel control are known or if a registered ID is +used.

      +
      +

      New in version 3.3.

      +
      +
    • +
    • AF_BLUETOOTH supports the following protocols and address +formats:

      +
        +
      • BTPROTO_L2CAP accepts (bdaddr, psm) where bdaddr is +the Bluetooth address as a string and psm is an integer.

      • +
      • BTPROTO_RFCOMM accepts (bdaddr, channel) where bdaddr +is the Bluetooth address as a string and channel is an integer.

      • +
      • BTPROTO_HCI accepts (device_id,) where device_id is +either an integer or a string with the Bluetooth address of the +interface. (This depends on your OS; NetBSD and DragonFlyBSD expect +a Bluetooth address while everything else expects an integer.)

        +
        +

        Changed in version 3.2: NetBSD and DragonFlyBSD support added.

        +
        +
      • +
      • BTPROTO_SCO accepts bdaddr where bdaddr is a +bytes object containing the Bluetooth address in a +string format. (ex. b'12:23:34:45:56:67') This protocol is not +supported under FreeBSD.

      • +
      +
    • +
    • AF_ALG is a Linux-only socket based interface to Kernel +cryptography. An algorithm socket is configured with a tuple of two to four +elements (type, name [, feat [, mask]]), where:

      +
        +
      • type is the algorithm type as string, e.g. aead, hash, +skcipher or rng.

      • +
      • name is the algorithm name and operation mode as string, e.g. +sha256, hmac(sha256), cbc(aes) or drbg_nopr_ctr_aes256.

      • +
      • feat and mask are unsigned 32bit integers.

      • +
      +

      Availability: Linux 2.6.38, some algorithm types require more recent Kernels.

      +
      +

      New in version 3.6.

      +
      +
    • +
    • AF_VSOCK allows communication between virtual machines and +their hosts. The sockets are represented as a (CID, port) tuple +where the context ID or CID and port are integers.

      +

      Availability: Linux >= 4.8 QEMU >= 2.8 ESX >= 4.0 ESX Workstation >= 6.5.

      +
      +

      New in version 3.7.

      +
      +
    • +
    • AF_PACKET is a low-level interface directly to network devices. +The packets are represented by the tuple +(ifname, proto[, pkttype[, hatype[, addr]]]) where:

      +
        +
      • ifname - String specifying the device name.

      • +
      • proto - An in network-byte-order integer specifying the Ethernet +protocol number.

      • +
      • pkttype - Optional integer specifying the packet type:

        +
          +
        • PACKET_HOST (the default) - Packet addressed to the local host.

        • +
        • PACKET_BROADCAST - Physical-layer broadcast packet.

        • +
        • PACKET_MULTIHOST - Packet sent to a physical-layer multicast address.

        • +
        • PACKET_OTHERHOST - Packet to some other host that has been caught by +a device driver in promiscuous mode.

        • +
        • PACKET_OUTGOING - Packet originating from the local host that is +looped back to a packet socket.

        • +
        +
      • +
      • hatype - Optional integer specifying the ARP hardware address type.

      • +
      • addr - Optional bytes-like object specifying the hardware physical +address, whose interpretation depends on the device.

      • +
      +
    • +
    +

    If you use a hostname in the host portion of IPv4/v6 socket address, the +program may show a nondeterministic behavior, as Python uses the first address +returned from the DNS resolution. The socket address will be resolved +differently into an actual IPv4/v6 address, depending on the results from DNS +resolution and/or the host configuration. For deterministic behavior use a +numeric address in host portion.

    +

    All errors raise exceptions. The normal exceptions for invalid argument types +and out-of-memory conditions can be raised; starting from Python 3.3, errors +related to socket or address semantics raise OSError or one of its +subclasses (they used to raise socket.error).

    +

    Non-blocking mode is supported through setblocking(). A +generalization of this based on timeouts is supported through +settimeout().

    +
    +
    +

    Module contents

    +

    The module socket exports the following elements.

    +
    +

    Exceptions

    +
    +
    +exception socket.error
    +

    A deprecated alias of OSError.

    +
    +

    Changed in version 3.3: Following PEP 3151, this class was made an alias of OSError.

    +
    +
    + +
    +
    +exception socket.herror
    +

    A subclass of OSError, this exception is raised for +address-related errors, i.e. for functions that use h_errno in the POSIX +C API, including gethostbyname_ex() and gethostbyaddr(). +The accompanying value is a pair (h_errno, string) representing an +error returned by a library call. h_errno is a numeric value, while +string represents the description of h_errno, as returned by the +hstrerror() C function.

    +
    +

    Changed in version 3.3: This class was made a subclass of OSError.

    +
    +
    + +
    +
    +exception socket.gaierror
    +

    A subclass of OSError, this exception is raised for +address-related errors by getaddrinfo() and getnameinfo(). +The accompanying value is a pair (error, string) representing an error +returned by a library call. string represents the description of +error, as returned by the gai_strerror() C function. The +numeric error value will match one of the EAI_* constants +defined in this module.

    +
    +

    Changed in version 3.3: This class was made a subclass of OSError.

    +
    +
    + +
    +
    +exception socket.timeout
    +

    A subclass of OSError, this exception is raised when a timeout +occurs on a socket which has had timeouts enabled via a prior call to +settimeout() (or implicitly through +setdefaulttimeout()). The accompanying value is a string +whose value is currently always “timed out”.

    +
    +

    Changed in version 3.3: This class was made a subclass of OSError.

    +
    +
    + +
    +
    +

    Constants

    +
    +

    The AF_* and SOCK_* constants are now AddressFamily and +SocketKind IntEnum collections.

    +
    +

    New in version 3.4.

    +
    +
    +
    +
    +socket.AF_UNIX
    +
    +socket.AF_INET
    +
    +socket.AF_INET6
    +

    These constants represent the address (and protocol) families, used for the +first argument to socket(). If the AF_UNIX constant is not +defined then this protocol is unsupported. More constants may be available +depending on the system.

    +
    + +
    +
    +socket.SOCK_STREAM
    +
    +socket.SOCK_DGRAM
    +
    +socket.SOCK_RAW
    +
    +socket.SOCK_RDM
    +
    +socket.SOCK_SEQPACKET
    +

    These constants represent the socket types, used for the second argument to +socket(). More constants may be available depending on the system. +(Only SOCK_STREAM and SOCK_DGRAM appear to be generally +useful.)

    +
    + +
    +
    +socket.SOCK_CLOEXEC
    +
    +socket.SOCK_NONBLOCK
    +

    These two constants, if defined, can be combined with the socket types and +allow you to set some flags atomically (thus avoiding possible race +conditions and the need for separate calls).

    +
    +

    See also

    +

    Secure File Descriptor Handling +for a more thorough explanation.

    +
    +

    Availability: Linux >= 2.6.27.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +SO_*
    +
    +socket.SOMAXCONN
    +
    +MSG_*
    +
    +SOL_*
    +
    +SCM_*
    +
    +IPPROTO_*
    +
    +IPPORT_*
    +
    +INADDR_*
    +
    +IP_*
    +
    +IPV6_*
    +
    +EAI_*
    +
    +AI_*
    +
    +NI_*
    +
    +TCP_*
    +

    Many constants of these forms, documented in the Unix documentation on sockets +and/or the IP protocol, are also defined in the socket module. They are +generally used in arguments to the setsockopt() and getsockopt() +methods of socket objects. In most cases, only those symbols that are defined +in the Unix header files are defined; for a few symbols, default values are +provided.

    +
    +

    Changed in version 3.6: SO_DOMAIN, SO_PROTOCOL, SO_PEERSEC, SO_PASSSEC, +TCP_USER_TIMEOUT, TCP_CONGESTION were added.

    +
    +
    +

    Changed in version 3.6.5: On Windows, TCP_FASTOPEN, TCP_KEEPCNT appear if run-time Windows +supports.

    +
    +
    +

    Changed in version 3.7: TCP_NOTSENT_LOWAT was added.

    +

    On Windows, TCP_KEEPIDLE, TCP_KEEPINTVL appear if run-time Windows +supports.

    +
    +
    + +
    +
    +socket.AF_CAN
    +
    +socket.PF_CAN
    +
    +SOL_CAN_*
    +
    +CAN_*
    +

    Many constants of these forms, documented in the Linux documentation, are +also defined in the socket module.

    +

    Availability: Linux >= 2.6.25.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +socket.CAN_BCM
    +
    +CAN_BCM_*
    +

    CAN_BCM, in the CAN protocol family, is the broadcast manager (BCM) protocol. +Broadcast manager constants, documented in the Linux documentation, are also +defined in the socket module.

    +

    Availability: Linux >= 2.6.25.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +socket.CAN_RAW_FD_FRAMES
    +

    Enables CAN FD support in a CAN_RAW socket. This is disabled by default. +This allows your application to send both CAN and CAN FD frames; however, +you must accept both CAN and CAN FD frames when reading from the socket.

    +

    This constant is documented in the Linux documentation.

    +

    Availability: Linux >= 3.6.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +socket.CAN_ISOTP
    +

    CAN_ISOTP, in the CAN protocol family, is the ISO-TP (ISO 15765-2) protocol. +ISO-TP constants, documented in the Linux documentation.

    +

    Availability: Linux >= 2.6.25.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +socket.AF_PACKET
    +
    +socket.PF_PACKET
    +
    +PACKET_*
    +

    Many constants of these forms, documented in the Linux documentation, are +also defined in the socket module.

    +

    Availability: Linux >= 2.2.

    +
    + +
    +
    +socket.AF_RDS
    +
    +socket.PF_RDS
    +
    +socket.SOL_RDS
    +
    +RDS_*
    +

    Many constants of these forms, documented in the Linux documentation, are +also defined in the socket module.

    +

    Availability: Linux >= 2.6.30.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +socket.SIO_RCVALL
    +
    +socket.SIO_KEEPALIVE_VALS
    +
    +socket.SIO_LOOPBACK_FAST_PATH
    +
    +RCVALL_*
    +

    Constants for Windows’ WSAIoctl(). The constants are used as arguments to the +ioctl() method of socket objects.

    +
    +

    Changed in version 3.6: SIO_LOOPBACK_FAST_PATH was added.

    +
    +
    + +
    +
    +TIPC_*
    +

    TIPC related constants, matching the ones exported by the C socket API. See +the TIPC documentation for more information.

    +
    + +
    +
    +socket.AF_ALG
    +
    +socket.SOL_ALG
    +
    +ALG_*
    +

    Constants for Linux Kernel cryptography.

    +

    Availability: Linux >= 2.6.38.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +socket.AF_VSOCK
    +
    +socket.IOCTL_VM_SOCKETS_GET_LOCAL_CID
    +
    +VMADDR*
    +
    +SO_VM*
    +

    Constants for Linux host/guest communication.

    +

    Availability: Linux >= 4.8.

    +
    +

    New in version 3.7.

    +
    +
    + +
    + +

    Availability: BSD, OSX.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +socket.has_ipv6
    +

    This constant contains a boolean value which indicates if IPv6 is supported on +this platform.

    +
    + +
    +
    +socket.BDADDR_ANY
    +
    +socket.BDADDR_LOCAL
    +

    These are string constants containing Bluetooth addresses with special +meanings. For example, BDADDR_ANY can be used to indicate +any address when specifying the binding socket with +BTPROTO_RFCOMM.

    +
    + +
    +
    +socket.HCI_FILTER
    +
    +socket.HCI_TIME_STAMP
    +
    +socket.HCI_DATA_DIR
    +

    For use with BTPROTO_HCI. HCI_FILTER is not +available for NetBSD or DragonFlyBSD. HCI_TIME_STAMP and +HCI_DATA_DIR are not available for FreeBSD, NetBSD, or +DragonFlyBSD.

    +
    + +
    +
    +

    Functions

    +
    +

    Creating sockets

    +

    The following functions all create socket objects.

    +
    +
    +socket.socket(family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None)
    +

    Create a new socket using the given address family, socket type and protocol +number. The address family should be AF_INET (the default), +AF_INET6, AF_UNIX, AF_CAN, AF_PACKET, +or AF_RDS. The socket type should be SOCK_STREAM (the +default), SOCK_DGRAM, SOCK_RAW or perhaps one of the other +SOCK_ constants. The protocol number is usually zero and may be omitted +or in the case where the address family is AF_CAN the protocol +should be one of CAN_RAW, CAN_BCM or CAN_ISOTP.

    +

    If fileno is specified, the values for family, type, and proto are +auto-detected from the specified file descriptor. Auto-detection can be +overruled by calling the function with explicit family, type, or proto +arguments. This only affects how Python represents e.g. the return value +of socket.getpeername() but not the actual OS resource. Unlike +socket.fromfd(), fileno will return the same socket and not a +duplicate. This may help close a detached socket using +socket.close().

    +

    The newly created socket is non-inheritable.

    +
    +

    Changed in version 3.3: The AF_CAN family was added. +The AF_RDS family was added.

    +
    +
    +

    Changed in version 3.4: The CAN_BCM protocol was added.

    +
    +
    +

    Changed in version 3.4: The returned socket is now non-inheritable.

    +
    +
    +

    Changed in version 3.7: The CAN_ISOTP protocol was added.

    +
    +
    +

    Changed in version 3.7: When SOCK_NONBLOCK or SOCK_CLOEXEC +bit flags are applied to type they are cleared, and +socket.type will not reflect them. They are still passed +to the underlying system socket() call. Therefore::

    +
    +
    +
    sock = socket.socket(

    socket.AF_INET, +socket.SOCK_STREAM | socket.SOCK_NONBLOCK)

    +
    +
    +
    +

    will still create a non-blocking socket on OSes that support +SOCK_NONBLOCK, but sock.type will be set to +socket.SOCK_STREAM.

    +
    +
    + +
    +
    +socket.socketpair([family[, type[, proto]]])
    +

    Build a pair of connected socket objects using the given address family, socket +type, and protocol number. Address family, socket type, and protocol number are +as for the socket() function above. The default family is AF_UNIX +if defined on the platform; otherwise, the default is AF_INET.

    +

    The newly created sockets are non-inheritable.

    +
    +

    Changed in version 3.2: The returned socket objects now support the whole socket API, rather +than a subset.

    +
    +
    +

    Changed in version 3.4: The returned sockets are now non-inheritable.

    +
    +
    +

    Changed in version 3.5: Windows support added.

    +
    +
    + +
    +
    +socket.create_connection(address[, timeout[, source_address]])
    +

    Connect to a TCP service listening on the Internet address (a 2-tuple +(host, port)), and return the socket object. This is a higher-level +function than socket.connect(): if host is a non-numeric hostname, +it will try to resolve it for both AF_INET and AF_INET6, +and then try to connect to all possible addresses in turn until a +connection succeeds. This makes it easy to write clients that are +compatible to both IPv4 and IPv6.

    +

    Passing the optional timeout parameter will set the timeout on the +socket instance before attempting to connect. If no timeout is +supplied, the global default timeout setting returned by +getdefaulttimeout() is used.

    +

    If supplied, source_address must be a 2-tuple (host, port) for the +socket to bind to as its source address before connecting. If host or port +are ‘’ or 0 respectively the OS default behavior will be used.

    +
    +

    Changed in version 3.2: source_address was added.

    +
    +
    + +
    +
    +socket.fromfd(fd, family, type, proto=0)
    +

    Duplicate the file descriptor fd (an integer as returned by a file object’s +fileno() method) and build a socket object from the result. Address +family, socket type and protocol number are as for the socket() function +above. The file descriptor should refer to a socket, but this is not checked — +subsequent operations on the object may fail if the file descriptor is invalid. +This function is rarely needed, but can be used to get or set socket options on +a socket passed to a program as standard input or output (such as a server +started by the Unix inet daemon). The socket is assumed to be in blocking mode.

    +

    The newly created socket is non-inheritable.

    +
    +

    Changed in version 3.4: The returned socket is now non-inheritable.

    +
    +
    + +
    +
    +socket.fromshare(data)
    +

    Instantiate a socket from data obtained from the socket.share() +method. The socket is assumed to be in blocking mode.

    +

    Availability: Windows.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +socket.SocketType
    +

    This is a Python type object that represents the socket object type. It is the +same as type(socket(...)).

    +
    + +
    +
    +

    Other functions

    +

    The socket module also offers various network-related services:

    +
    +
    +socket.close(fd)
    +

    Close a socket file descriptor. This is like os.close(), but for +sockets. On some platforms (most noticeable Windows) os.close() +does not work for socket file descriptors.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +socket.getaddrinfo(host, port, family=0, type=0, proto=0, flags=0)
    +

    Translate the host/port argument into a sequence of 5-tuples that contain +all the necessary arguments for creating a socket connected to that service. +host is a domain name, a string representation of an IPv4/v6 address +or None. port is a string service name such as 'http', a numeric +port number or None. By passing None as the value of host +and port, you can pass NULL to the underlying C API.

    +

    The family, type and proto arguments can be optionally specified +in order to narrow the list of addresses returned. Passing zero as a +value for each of these arguments selects the full range of results. +The flags argument can be one or several of the AI_* constants, +and will influence how results are computed and returned. +For example, AI_NUMERICHOST will disable domain name resolution +and will raise an error if host is a domain name.

    +

    The function returns a list of 5-tuples with the following structure:

    +

    (family, type, proto, canonname, sockaddr)

    +

    In these tuples, family, type, proto are all integers and are +meant to be passed to the socket() function. canonname will be +a string representing the canonical name of the host if +AI_CANONNAME is part of the flags argument; else canonname +will be empty. sockaddr is a tuple describing a socket address, whose +format depends on the returned family (a (address, port) 2-tuple for +AF_INET, a (address, port, flow info, scope id) 4-tuple for +AF_INET6), and is meant to be passed to the socket.connect() +method.

    +

    The following example fetches address information for a hypothetical TCP +connection to example.org on port 80 (results may differ on your +system if IPv6 isn’t enabled):

    +
    >>> socket.getaddrinfo("example.org", 80, proto=socket.IPPROTO_TCP)
    +[(<AddressFamily.AF_INET6: 10>, <SocketType.SOCK_STREAM: 1>,
    + 6, '', ('2606:2800:220:1:248:1893:25c8:1946', 80, 0, 0)),
    + (<AddressFamily.AF_INET: 2>, <SocketType.SOCK_STREAM: 1>,
    + 6, '', ('93.184.216.34', 80))]
    +
    +
    +
    +

    Changed in version 3.2: parameters can now be passed using keyword arguments.

    +
    +
    +

    Changed in version 3.7: for IPv6 multicast addresses, string representing an address will not +contain %scope part.

    +
    +
    + +
    +
    +socket.getfqdn([name])
    +

    Return a fully qualified domain name for name. If name is omitted or empty, +it is interpreted as the local host. To find the fully qualified name, the +hostname returned by gethostbyaddr() is checked, followed by aliases for the +host, if available. The first name which includes a period is selected. In +case no fully qualified domain name is available, the hostname as returned by +gethostname() is returned.

    +
    + +
    +
    +socket.gethostbyname(hostname)
    +

    Translate a host name to IPv4 address format. The IPv4 address is returned as a +string, such as '100.50.200.5'. If the host name is an IPv4 address itself +it is returned unchanged. See gethostbyname_ex() for a more complete +interface. gethostbyname() does not support IPv6 name resolution, and +getaddrinfo() should be used instead for IPv4/v6 dual stack support.

    +
    + +
    +
    +socket.gethostbyname_ex(hostname)
    +

    Translate a host name to IPv4 address format, extended interface. Return a +triple (hostname, aliaslist, ipaddrlist) where hostname is the primary +host name responding to the given ip_address, aliaslist is a (possibly +empty) list of alternative host names for the same address, and ipaddrlist is +a list of IPv4 addresses for the same interface on the same host (often but not +always a single address). gethostbyname_ex() does not support IPv6 name +resolution, and getaddrinfo() should be used instead for IPv4/v6 dual +stack support.

    +
    + +
    +
    +socket.gethostname()
    +

    Return a string containing the hostname of the machine where the Python +interpreter is currently executing.

    +

    Note: gethostname() doesn’t always return the fully qualified domain +name; use getfqdn() for that.

    +
    + +
    +
    +socket.gethostbyaddr(ip_address)
    +

    Return a triple (hostname, aliaslist, ipaddrlist) where hostname is the +primary host name responding to the given ip_address, aliaslist is a +(possibly empty) list of alternative host names for the same address, and +ipaddrlist is a list of IPv4/v6 addresses for the same interface on the same +host (most likely containing only a single address). To find the fully qualified +domain name, use the function getfqdn(). gethostbyaddr() supports +both IPv4 and IPv6.

    +
    + +
    +
    +socket.getnameinfo(sockaddr, flags)
    +

    Translate a socket address sockaddr into a 2-tuple (host, port). Depending +on the settings of flags, the result can contain a fully-qualified domain name +or numeric address representation in host. Similarly, port can contain a +string port name or a numeric port number.

    +

    For IPv6 addresses, %scope is appended to the host part if sockaddr +contains meaningful scopeid. Usually this happens for multicast addresses.

    +
    + +
    +
    +socket.getprotobyname(protocolname)
    +

    Translate an Internet protocol name (for example, 'icmp') to a constant +suitable for passing as the (optional) third argument to the socket() +function. This is usually only needed for sockets opened in “raw” mode +(SOCK_RAW); for the normal socket modes, the correct protocol is chosen +automatically if the protocol is omitted or zero.

    +
    + +
    +
    +socket.getservbyname(servicename[, protocolname])
    +

    Translate an Internet service name and protocol name to a port number for that +service. The optional protocol name, if given, should be 'tcp' or +'udp', otherwise any protocol will match.

    +
    + +
    +
    +socket.getservbyport(port[, protocolname])
    +

    Translate an Internet port number and protocol name to a service name for that +service. The optional protocol name, if given, should be 'tcp' or +'udp', otherwise any protocol will match.

    +
    + +
    +
    +socket.ntohl(x)
    +

    Convert 32-bit positive integers from network to host byte order. On machines +where the host byte order is the same as network byte order, this is a no-op; +otherwise, it performs a 4-byte swap operation.

    +
    + +
    +
    +socket.ntohs(x)
    +

    Convert 16-bit positive integers from network to host byte order. On machines +where the host byte order is the same as network byte order, this is a no-op; +otherwise, it performs a 2-byte swap operation.

    +
    +

    Deprecated since version 3.7: In case x does not fit in 16-bit unsigned integer, but does fit in a +positive C int, it is silently truncated to 16-bit unsigned integer. +This silent truncation feature is deprecated, and will raise an +exception in future versions of Python.

    +
    +
    + +
    +
    +socket.htonl(x)
    +

    Convert 32-bit positive integers from host to network byte order. On machines +where the host byte order is the same as network byte order, this is a no-op; +otherwise, it performs a 4-byte swap operation.

    +
    + +
    +
    +socket.htons(x)
    +

    Convert 16-bit positive integers from host to network byte order. On machines +where the host byte order is the same as network byte order, this is a no-op; +otherwise, it performs a 2-byte swap operation.

    +
    +

    Deprecated since version 3.7: In case x does not fit in 16-bit unsigned integer, but does fit in a +positive C int, it is silently truncated to 16-bit unsigned integer. +This silent truncation feature is deprecated, and will raise an +exception in future versions of Python.

    +
    +
    + +
    +
    +socket.inet_aton(ip_string)
    +

    Convert an IPv4 address from dotted-quad string format (for example, +‘123.45.67.89’) to 32-bit packed binary format, as a bytes object four characters in +length. This is useful when conversing with a program that uses the standard C +library and needs objects of type struct in_addr, which is the C type +for the 32-bit packed binary this function returns.

    +

    inet_aton() also accepts strings with less than three dots; see the +Unix manual page inet(3) for details.

    +

    If the IPv4 address string passed to this function is invalid, +OSError will be raised. Note that exactly what is valid depends on +the underlying C implementation of inet_aton().

    +

    inet_aton() does not support IPv6, and inet_pton() should be used +instead for IPv4/v6 dual stack support.

    +
    + +
    +
    +socket.inet_ntoa(packed_ip)
    +

    Convert a 32-bit packed IPv4 address (a bytes-like object four +bytes in length) to its standard dotted-quad string representation (for example, +‘123.45.67.89’). This is useful when conversing with a program that uses the +standard C library and needs objects of type struct in_addr, which +is the C type for the 32-bit packed binary data this function takes as an +argument.

    +

    If the byte sequence passed to this function is not exactly 4 bytes in +length, OSError will be raised. inet_ntoa() does not +support IPv6, and inet_ntop() should be used instead for IPv4/v6 dual +stack support.

    +
    +

    Changed in version 3.5: Writable bytes-like object is now accepted.

    +
    +
    + +
    +
    +socket.inet_pton(address_family, ip_string)
    +

    Convert an IP address from its family-specific string format to a packed, +binary format. inet_pton() is useful when a library or network protocol +calls for an object of type struct in_addr (similar to +inet_aton()) or struct in6_addr.

    +

    Supported values for address_family are currently AF_INET and +AF_INET6. If the IP address string ip_string is invalid, +OSError will be raised. Note that exactly what is valid depends on +both the value of address_family and the underlying implementation of +inet_pton().

    +

    Availability: Unix (maybe not all platforms), Windows.

    +
    +

    Changed in version 3.4: Windows support added

    +
    +
    + +
    +
    +socket.inet_ntop(address_family, packed_ip)
    +

    Convert a packed IP address (a bytes-like object of some number of +bytes) to its standard, family-specific string representation (for +example, '7.10.0.5' or '5aef:2b::8'). +inet_ntop() is useful when a library or network protocol returns an +object of type struct in_addr (similar to inet_ntoa()) or +struct in6_addr.

    +

    Supported values for address_family are currently AF_INET and +AF_INET6. If the bytes object packed_ip is not the correct +length for the specified address family, ValueError will be raised. +OSError is raised for errors from the call to inet_ntop().

    +

    Availability: Unix (maybe not all platforms), Windows.

    +
    +

    Changed in version 3.4: Windows support added

    +
    +
    +

    Changed in version 3.5: Writable bytes-like object is now accepted.

    +
    +
    + +
    +
    +socket.CMSG_LEN(length)
    +

    Return the total length, without trailing padding, of an ancillary +data item with associated data of the given length. This value +can often be used as the buffer size for recvmsg() to +receive a single item of ancillary data, but RFC 3542 requires +portable applications to use CMSG_SPACE() and thus include +space for padding, even when the item will be the last in the +buffer. Raises OverflowError if length is outside the +permissible range of values.

    +

    Availability: most Unix platforms, possibly others.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +socket.CMSG_SPACE(length)
    +

    Return the buffer size needed for recvmsg() to +receive an ancillary data item with associated data of the given +length, along with any trailing padding. The buffer space needed +to receive multiple items is the sum of the CMSG_SPACE() +values for their associated data lengths. Raises +OverflowError if length is outside the permissible range +of values.

    +

    Note that some systems might support ancillary data without +providing this function. Also note that setting the buffer size +using the results of this function may not precisely limit the +amount of ancillary data that can be received, since additional +data may be able to fit into the padding area.

    +

    Availability: most Unix platforms, possibly others.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +socket.getdefaulttimeout()
    +

    Return the default timeout in seconds (float) for new socket objects. A value +of None indicates that new socket objects have no timeout. When the socket +module is first imported, the default is None.

    +
    + +
    +
    +socket.setdefaulttimeout(timeout)
    +

    Set the default timeout in seconds (float) for new socket objects. When +the socket module is first imported, the default is None. See +settimeout() for possible values and their respective +meanings.

    +
    + +
    +
    +socket.sethostname(name)
    +

    Set the machine’s hostname to name. This will raise an +OSError if you don’t have enough rights.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +socket.if_nameindex()
    +

    Return a list of network interface information +(index int, name string) tuples. +OSError if the system call fails.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +socket.if_nametoindex(if_name)
    +

    Return a network interface index number corresponding to an +interface name. +OSError if no interface with the given name exists.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +socket.if_indextoname(if_index)
    +

    Return a network interface name corresponding to an +interface index number. +OSError if no interface with the given index exists.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +
    +
    +

    Socket Objects

    +

    Socket objects have the following methods. Except for +makefile(), these correspond to Unix system calls applicable +to sockets.

    +
    +

    Changed in version 3.2: Support for the context manager protocol was added. Exiting the +context manager is equivalent to calling close().

    +
    +
    +
    +socket.accept()
    +

    Accept a connection. The socket must be bound to an address and listening for +connections. The return value is a pair (conn, address) where conn is a +new socket object usable to send and receive data on the connection, and +address is the address bound to the socket on the other end of the connection.

    +

    The newly created socket is non-inheritable.

    +
    +

    Changed in version 3.4: The socket is now non-inheritable.

    +
    +
    +

    Changed in version 3.5: If the system call is interrupted and the signal handler does not raise +an exception, the method now retries the system call instead of raising +an InterruptedError exception (see PEP 475 for the rationale).

    +
    +
    + +
    +
    +socket.bind(address)
    +

    Bind the socket to address. The socket must not already be bound. (The format +of address depends on the address family — see above.)

    +
    + +
    +
    +socket.close()
    +

    Mark the socket closed. The underlying system resource (e.g. a file +descriptor) is also closed when all file objects from makefile() +are closed. Once that happens, all future operations on the socket +object will fail. The remote end will receive no more data (after +queued data is flushed).

    +

    Sockets are automatically closed when they are garbage-collected, but +it is recommended to close() them explicitly, or to use a +with statement around them.

    +
    +

    Changed in version 3.6: OSError is now raised if an error occurs when the underlying +close() call is made.

    +
    +
    +

    Note

    +

    close() releases the resource associated with a connection but +does not necessarily close the connection immediately. If you want +to close the connection in a timely fashion, call shutdown() +before close().

    +
    +
    + +
    +
    +socket.connect(address)
    +

    Connect to a remote socket at address. (The format of address depends on the +address family — see above.)

    +

    If the connection is interrupted by a signal, the method waits until the +connection completes, or raise a socket.timeout on timeout, if the +signal handler doesn’t raise an exception and the socket is blocking or has +a timeout. For non-blocking sockets, the method raises an +InterruptedError exception if the connection is interrupted by a +signal (or the exception raised by the signal handler).

    +
    +

    Changed in version 3.5: The method now waits until the connection completes instead of raising an +InterruptedError exception if the connection is interrupted by a +signal, the signal handler doesn’t raise an exception and the socket is +blocking or has a timeout (see the PEP 475 for the rationale).

    +
    +
    + +
    +
    +socket.connect_ex(address)
    +

    Like connect(address), but return an error indicator instead of raising an +exception for errors returned by the C-level connect() call (other +problems, such as “host not found,” can still raise exceptions). The error +indicator is 0 if the operation succeeded, otherwise the value of the +errno variable. This is useful to support, for example, asynchronous +connects.

    +
    + +
    +
    +socket.detach()
    +

    Put the socket object into closed state without actually closing the +underlying file descriptor. The file descriptor is returned, and can +be reused for other purposes.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +socket.dup()
    +

    Duplicate the socket.

    +

    The newly created socket is non-inheritable.

    +
    +

    Changed in version 3.4: The socket is now non-inheritable.

    +
    +
    + +
    +
    +socket.fileno()
    +

    Return the socket’s file descriptor (a small integer), or -1 on failure. This +is useful with select.select().

    +

    Under Windows the small integer returned by this method cannot be used where a +file descriptor can be used (such as os.fdopen()). Unix does not have +this limitation.

    +
    + +
    +
    +socket.get_inheritable()
    +

    Get the inheritable flag of the socket’s file +descriptor or socket’s handle: True if the socket can be inherited in +child processes, False if it cannot.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +socket.getpeername()
    +

    Return the remote address to which the socket is connected. This is useful to +find out the port number of a remote IPv4/v6 socket, for instance. (The format +of the address returned depends on the address family — see above.) On some +systems this function is not supported.

    +
    + +
    +
    +socket.getsockname()
    +

    Return the socket’s own address. This is useful to find out the port number of +an IPv4/v6 socket, for instance. (The format of the address returned depends on +the address family — see above.)

    +
    + +
    +
    +socket.getsockopt(level, optname[, buflen])
    +

    Return the value of the given socket option (see the Unix man page +getsockopt(2)). The needed symbolic constants (SO_* etc.) +are defined in this module. If buflen is absent, an integer option is assumed +and its integer value is returned by the function. If buflen is present, it +specifies the maximum length of the buffer used to receive the option in, and +this buffer is returned as a bytes object. It is up to the caller to decode the +contents of the buffer (see the optional built-in module struct for a way +to decode C structures encoded as byte strings).

    +
    + +
    +
    +socket.getblocking()
    +

    Return True if socket is in blocking mode, False if in +non-blocking.

    +

    This is equivalent to checking socket.gettimeout() == 0.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +socket.gettimeout()
    +

    Return the timeout in seconds (float) associated with socket operations, +or None if no timeout is set. This reflects the last call to +setblocking() or settimeout().

    +
    + +
    +
    +socket.ioctl(control, option)
    +
    +
    Platform
    +

    Windows

    +
    +
    +

    The ioctl() method is a limited interface to the WSAIoctl system +interface. Please refer to the Win32 documentation for more +information.

    +

    On other platforms, the generic fcntl.fcntl() and fcntl.ioctl() +functions may be used; they accept a socket object as their first argument.

    +

    Currently only the following control codes are supported: +SIO_RCVALL, SIO_KEEPALIVE_VALS, and SIO_LOOPBACK_FAST_PATH.

    +
    +

    Changed in version 3.6: SIO_LOOPBACK_FAST_PATH was added.

    +
    +
    + +
    +
    +socket.listen([backlog])
    +

    Enable a server to accept connections. If backlog is specified, it must +be at least 0 (if it is lower, it is set to 0); it specifies the number of +unaccepted connections that the system will allow before refusing new +connections. If not specified, a default reasonable value is chosen.

    +
    +

    Changed in version 3.5: The backlog parameter is now optional.

    +
    +
    + +
    +
    +socket.makefile(mode='r', buffering=None, *, encoding=None, errors=None, newline=None)
    +

    Return a file object associated with the socket. The exact returned +type depends on the arguments given to makefile(). These arguments are +interpreted the same way as by the built-in open() function, except +the only supported mode values are 'r' (default), 'w' and 'b'.

    +

    The socket must be in blocking mode; it can have a timeout, but the file +object’s internal buffer may end up in an inconsistent state if a timeout +occurs.

    +

    Closing the file object returned by makefile() won’t close the +original socket unless all other file objects have been closed and +socket.close() has been called on the socket object.

    +
    +

    Note

    +

    On Windows, the file-like object created by makefile() cannot be +used where a file object with a file descriptor is expected, such as the +stream arguments of subprocess.Popen().

    +
    +
    + +
    +
    +socket.recv(bufsize[, flags])
    +

    Receive data from the socket. The return value is a bytes object representing the +data received. The maximum amount of data to be received at once is specified +by bufsize. See the Unix manual page recv(2) for the meaning of +the optional argument flags; it defaults to zero.

    +
    +

    Note

    +

    For best match with hardware and network realities, the value of bufsize +should be a relatively small power of 2, for example, 4096.

    +
    +
    +

    Changed in version 3.5: If the system call is interrupted and the signal handler does not raise +an exception, the method now retries the system call instead of raising +an InterruptedError exception (see PEP 475 for the rationale).

    +
    +
    + +
    +
    +socket.recvfrom(bufsize[, flags])
    +

    Receive data from the socket. The return value is a pair (bytes, address) +where bytes is a bytes object representing the data received and address is the +address of the socket sending the data. See the Unix manual page +recv(2) for the meaning of the optional argument flags; it defaults +to zero. (The format of address depends on the address family — see above.)

    +
    +

    Changed in version 3.5: If the system call is interrupted and the signal handler does not raise +an exception, the method now retries the system call instead of raising +an InterruptedError exception (see PEP 475 for the rationale).

    +
    +
    +

    Changed in version 3.7: For multicast IPv6 address, first item of address does not contain +%scope part anymore. In order to get full IPv6 address use +getnameinfo().

    +
    +
    + +
    +
    +socket.recvmsg(bufsize[, ancbufsize[, flags]])
    +

    Receive normal data (up to bufsize bytes) and ancillary data from +the socket. The ancbufsize argument sets the size in bytes of +the internal buffer used to receive the ancillary data; it defaults +to 0, meaning that no ancillary data will be received. Appropriate +buffer sizes for ancillary data can be calculated using +CMSG_SPACE() or CMSG_LEN(), and items which do not fit +into the buffer might be truncated or discarded. The flags +argument defaults to 0 and has the same meaning as for +recv().

    +

    The return value is a 4-tuple: (data, ancdata, msg_flags, +address). The data item is a bytes object holding the +non-ancillary data received. The ancdata item is a list of zero +or more tuples (cmsg_level, cmsg_type, cmsg_data) representing +the ancillary data (control messages) received: cmsg_level and +cmsg_type are integers specifying the protocol level and +protocol-specific type respectively, and cmsg_data is a +bytes object holding the associated data. The msg_flags +item is the bitwise OR of various flags indicating conditions on +the received message; see your system documentation for details. +If the receiving socket is unconnected, address is the address of +the sending socket, if available; otherwise, its value is +unspecified.

    +

    On some systems, sendmsg() and recvmsg() can be used to +pass file descriptors between processes over an AF_UNIX +socket. When this facility is used (it is often restricted to +SOCK_STREAM sockets), recvmsg() will return, in its +ancillary data, items of the form (socket.SOL_SOCKET, +socket.SCM_RIGHTS, fds), where fds is a bytes object +representing the new file descriptors as a binary array of the +native C int type. If recvmsg() raises an +exception after the system call returns, it will first attempt to +close any file descriptors received via this mechanism.

    +

    Some systems do not indicate the truncated length of ancillary data +items which have been only partially received. If an item appears +to extend beyond the end of the buffer, recvmsg() will issue +a RuntimeWarning, and will return the part of it which is +inside the buffer provided it has not been truncated before the +start of its associated data.

    +

    On systems which support the SCM_RIGHTS mechanism, the +following function will receive up to maxfds file descriptors, +returning the message data and a list containing the descriptors +(while ignoring unexpected conditions such as unrelated control +messages being received). See also sendmsg().

    +
    import socket, array
    +
    +def recv_fds(sock, msglen, maxfds):
    +    fds = array.array("i")   # Array of ints
    +    msg, ancdata, flags, addr = sock.recvmsg(msglen, socket.CMSG_LEN(maxfds * fds.itemsize))
    +    for cmsg_level, cmsg_type, cmsg_data in ancdata:
    +        if (cmsg_level == socket.SOL_SOCKET and cmsg_type == socket.SCM_RIGHTS):
    +            # Append data, ignoring any truncated integers at the end.
    +            fds.fromstring(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])
    +    return msg, list(fds)
    +
    +
    +

    Availability: most Unix platforms, possibly others.

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.5: If the system call is interrupted and the signal handler does not raise +an exception, the method now retries the system call instead of raising +an InterruptedError exception (see PEP 475 for the rationale).

    +
    +
    + +
    +
    +socket.recvmsg_into(buffers[, ancbufsize[, flags]])
    +

    Receive normal data and ancillary data from the socket, behaving as +recvmsg() would, but scatter the non-ancillary data into a +series of buffers instead of returning a new bytes object. The +buffers argument must be an iterable of objects that export +writable buffers (e.g. bytearray objects); these will be +filled with successive chunks of the non-ancillary data until it +has all been written or there are no more buffers. The operating +system may set a limit (sysconf() value SC_IOV_MAX) +on the number of buffers that can be used. The ancbufsize and +flags arguments have the same meaning as for recvmsg().

    +

    The return value is a 4-tuple: (nbytes, ancdata, msg_flags, +address), where nbytes is the total number of bytes of +non-ancillary data written into the buffers, and ancdata, +msg_flags and address are the same as for recvmsg().

    +

    Example:

    +
    >>> import socket
    +>>> s1, s2 = socket.socketpair()
    +>>> b1 = bytearray(b'----')
    +>>> b2 = bytearray(b'0123456789')
    +>>> b3 = bytearray(b'--------------')
    +>>> s1.send(b'Mary had a little lamb')
    +22
    +>>> s2.recvmsg_into([b1, memoryview(b2)[2:9], b3])
    +(22, [], 0, None)
    +>>> [b1, b2, b3]
    +[bytearray(b'Mary'), bytearray(b'01 had a 9'), bytearray(b'little lamb---')]
    +
    +
    +

    Availability: most Unix platforms, possibly others.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +socket.recvfrom_into(buffer[, nbytes[, flags]])
    +

    Receive data from the socket, writing it into buffer instead of creating a +new bytestring. The return value is a pair (nbytes, address) where nbytes is +the number of bytes received and address is the address of the socket sending +the data. See the Unix manual page recv(2) for the meaning of the +optional argument flags; it defaults to zero. (The format of address +depends on the address family — see above.)

    +
    + +
    +
    +socket.recv_into(buffer[, nbytes[, flags]])
    +

    Receive up to nbytes bytes from the socket, storing the data into a buffer +rather than creating a new bytestring. If nbytes is not specified (or 0), +receive up to the size available in the given buffer. Returns the number of +bytes received. See the Unix manual page recv(2) for the meaning +of the optional argument flags; it defaults to zero.

    +
    + +
    +
    +socket.send(bytes[, flags])
    +

    Send data to the socket. The socket must be connected to a remote socket. The +optional flags argument has the same meaning as for recv() above. +Returns the number of bytes sent. Applications are responsible for checking that +all data has been sent; if only some of the data was transmitted, the +application needs to attempt delivery of the remaining data. For further +information on this topic, consult the Socket Programming HOWTO.

    +
    +

    Changed in version 3.5: If the system call is interrupted and the signal handler does not raise +an exception, the method now retries the system call instead of raising +an InterruptedError exception (see PEP 475 for the rationale).

    +
    +
    + +
    +
    +socket.sendall(bytes[, flags])
    +

    Send data to the socket. The socket must be connected to a remote socket. The +optional flags argument has the same meaning as for recv() above. +Unlike send(), this method continues to send data from bytes until +either all data has been sent or an error occurs. None is returned on +success. On error, an exception is raised, and there is no way to determine how +much data, if any, was successfully sent.

    +
    +

    Changed in version 3.5: The socket timeout is no more reset each time data is sent successfully. +The socket timeout is now the maximum total duration to send all data.

    +
    +
    +

    Changed in version 3.5: If the system call is interrupted and the signal handler does not raise +an exception, the method now retries the system call instead of raising +an InterruptedError exception (see PEP 475 for the rationale).

    +
    +
    + +
    +
    +socket.sendto(bytes, address)
    +
    +socket.sendto(bytes, flags, address)
    +

    Send data to the socket. The socket should not be connected to a remote socket, +since the destination socket is specified by address. The optional flags +argument has the same meaning as for recv() above. Return the number of +bytes sent. (The format of address depends on the address family — see +above.)

    +
    +

    Changed in version 3.5: If the system call is interrupted and the signal handler does not raise +an exception, the method now retries the system call instead of raising +an InterruptedError exception (see PEP 475 for the rationale).

    +
    +
    + +
    +
    +socket.sendmsg(buffers[, ancdata[, flags[, address]]])
    +

    Send normal and ancillary data to the socket, gathering the +non-ancillary data from a series of buffers and concatenating it +into a single message. The buffers argument specifies the +non-ancillary data as an iterable of +bytes-like objects +(e.g. bytes objects); the operating system may set a limit +(sysconf() value SC_IOV_MAX) on the number of buffers +that can be used. The ancdata argument specifies the ancillary +data (control messages) as an iterable of zero or more tuples +(cmsg_level, cmsg_type, cmsg_data), where cmsg_level and +cmsg_type are integers specifying the protocol level and +protocol-specific type respectively, and cmsg_data is a +bytes-like object holding the associated data. Note that +some systems (in particular, systems without CMSG_SPACE()) +might support sending only one control message per call. The +flags argument defaults to 0 and has the same meaning as for +send(). If address is supplied and not None, it sets a +destination address for the message. The return value is the +number of bytes of non-ancillary data sent.

    +

    The following function sends the list of file descriptors fds +over an AF_UNIX socket, on systems which support the +SCM_RIGHTS mechanism. See also recvmsg().

    +
    import socket, array
    +
    +def send_fds(sock, msg, fds):
    +    return sock.sendmsg([msg], [(socket.SOL_SOCKET, socket.SCM_RIGHTS, array.array("i", fds))])
    +
    +
    +

    Availability: most Unix platforms, possibly others.

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.5: If the system call is interrupted and the signal handler does not raise +an exception, the method now retries the system call instead of raising +an InterruptedError exception (see PEP 475 for the rationale).

    +
    +
    + +
    +
    +socket.sendmsg_afalg([msg, ]*, op[, iv[, assoclen[, flags]]])
    +

    Specialized version of sendmsg() for AF_ALG socket. +Set mode, IV, AEAD associated data length and flags for AF_ALG socket.

    +

    Availability: Linux >= 2.6.38.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +socket.sendfile(file, offset=0, count=None)
    +

    Send a file until EOF is reached by using high-performance +os.sendfile and return the total number of bytes which were sent. +file must be a regular file object opened in binary mode. If +os.sendfile is not available (e.g. Windows) or file is not a +regular file send() will be used instead. offset tells from where to +start reading the file. If specified, count is the total number of bytes +to transmit as opposed to sending the file until EOF is reached. File +position is updated on return or also in case of error in which case +file.tell() can be used to figure out the number of +bytes which were sent. The socket must be of SOCK_STREAM type. +Non-blocking sockets are not supported.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +socket.set_inheritable(inheritable)
    +

    Set the inheritable flag of the socket’s file +descriptor or socket’s handle.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +socket.setblocking(flag)
    +

    Set blocking or non-blocking mode of the socket: if flag is false, the +socket is set to non-blocking, else to blocking mode.

    +

    This method is a shorthand for certain settimeout() calls:

    +
      +
    • sock.setblocking(True) is equivalent to sock.settimeout(None)

    • +
    • sock.setblocking(False) is equivalent to sock.settimeout(0.0)

    • +
    +
    +

    Changed in version 3.7: The method no longer applies SOCK_NONBLOCK flag on +socket.type.

    +
    +
    + +
    +
    +socket.settimeout(value)
    +

    Set a timeout on blocking socket operations. The value argument can be a +nonnegative floating point number expressing seconds, or None. +If a non-zero value is given, subsequent socket operations will raise a +timeout exception if the timeout period value has elapsed before +the operation has completed. If zero is given, the socket is put in +non-blocking mode. If None is given, the socket is put in blocking mode.

    +

    For further information, please consult the notes on socket timeouts.

    +
    +

    Changed in version 3.7: The method no longer toggles SOCK_NONBLOCK flag on +socket.type.

    +
    +
    + +
    +
    +socket.setsockopt(level, optname, value: int)
    +
    + +
    +
    +socket.setsockopt(level, optname, value: buffer)
    +
    + +
    +
    +socket.setsockopt(level, optname, None, optlen: int)
    +

    Set the value of the given socket option (see the Unix manual page +setsockopt(2)). The needed symbolic constants are defined in the +socket module (SO_* etc.). The value can be an integer, +None or a bytes-like object representing a buffer. In the later +case it is up to the caller to ensure that the bytestring contains the +proper bits (see the optional built-in module struct for a way to +encode C structures as bytestrings). When value is set to None, +optlen argument is required. It’s equivalent to call setsockopt C +function with optval=NULL and optlen=optlen.

    +
    +

    Changed in version 3.5: Writable bytes-like object is now accepted.

    +
    +
    +

    Changed in version 3.6: setsockopt(level, optname, None, optlen: int) form added.

    +
    +
    + +
    +
    +socket.shutdown(how)
    +

    Shut down one or both halves of the connection. If how is SHUT_RD, +further receives are disallowed. If how is SHUT_WR, further sends +are disallowed. If how is SHUT_RDWR, further sends and receives are +disallowed.

    +
    + +
    +
    +socket.share(process_id)
    +

    Duplicate a socket and prepare it for sharing with a target process. The +target process must be provided with process_id. The resulting bytes object +can then be passed to the target process using some form of interprocess +communication and the socket can be recreated there using fromshare(). +Once this method has been called, it is safe to close the socket since +the operating system has already duplicated it for the target process.

    +

    Availability: Windows.

    +
    +

    New in version 3.3.

    +
    +
    + +

    Note that there are no methods read() or write(); use +recv() and send() without flags argument instead.

    +

    Socket objects also have these (read-only) attributes that correspond to the +values given to the socket constructor.

    +
    +
    +socket.family
    +

    The socket family.

    +
    + +
    +
    +socket.type
    +

    The socket type.

    +
    + +
    +
    +socket.proto
    +

    The socket protocol.

    +
    + +
    +
    +

    Notes on socket timeouts

    +

    A socket object can be in one of three modes: blocking, non-blocking, or +timeout. Sockets are by default always created in blocking mode, but this +can be changed by calling setdefaulttimeout().

    +
      +
    • In blocking mode, operations block until complete or the system returns +an error (such as connection timed out).

    • +
    • In non-blocking mode, operations fail (with an error that is unfortunately +system-dependent) if they cannot be completed immediately: functions from the +select can be used to know when and whether a socket is available for +reading or writing.

    • +
    • In timeout mode, operations fail if they cannot be completed within the +timeout specified for the socket (they raise a timeout exception) +or if the system returns an error.

    • +
    +
    +

    Note

    +

    At the operating system level, sockets in timeout mode are internally set +in non-blocking mode. Also, the blocking and timeout modes are shared between +file descriptors and socket objects that refer to the same network endpoint. +This implementation detail can have visible consequences if e.g. you decide +to use the fileno() of a socket.

    +
    +
    +

    Timeouts and the connect method

    +

    The connect() operation is also subject to the timeout +setting, and in general it is recommended to call settimeout() +before calling connect() or pass a timeout parameter to +create_connection(). However, the system network stack may also +return a connection timeout error of its own regardless of any Python socket +timeout setting.

    +
    +
    +

    Timeouts and the accept method

    +

    If getdefaulttimeout() is not None, sockets returned by +the accept() method inherit that timeout. Otherwise, the +behaviour depends on settings of the listening socket:

    +
      +
    • if the listening socket is in blocking mode or in timeout mode, +the socket returned by accept() is in blocking mode;

    • +
    • if the listening socket is in non-blocking mode, whether the socket +returned by accept() is in blocking or non-blocking mode +is operating system-dependent. If you want to ensure cross-platform +behaviour, it is recommended you manually override this setting.

    • +
    +
    +
    +
    +

    Example

    +

    Here are four minimal example programs using the TCP/IP protocol: a server that +echoes all data that it receives back (servicing only one client), and a client +using it. Note that a server must perform the sequence socket(), +bind(), listen(), accept() (possibly +repeating the accept() to service more than one client), while a +client only needs the sequence socket(), connect(). Also +note that the server does not sendall()/recv() on +the socket it is listening on but on the new socket returned by +accept().

    +

    The first two examples support IPv4 only.

    +
    # Echo server program
    +import socket
    +
    +HOST = ''                 # Symbolic name meaning all available interfaces
    +PORT = 50007              # Arbitrary non-privileged port
    +with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
    +    s.bind((HOST, PORT))
    +    s.listen(1)
    +    conn, addr = s.accept()
    +    with conn:
    +        print('Connected by', addr)
    +        while True:
    +            data = conn.recv(1024)
    +            if not data: break
    +            conn.sendall(data)
    +
    +
    +
    # Echo client program
    +import socket
    +
    +HOST = 'daring.cwi.nl'    # The remote host
    +PORT = 50007              # The same port as used by the server
    +with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
    +    s.connect((HOST, PORT))
    +    s.sendall(b'Hello, world')
    +    data = s.recv(1024)
    +print('Received', repr(data))
    +
    +
    +

    The next two examples are identical to the above two, but support both IPv4 and +IPv6. The server side will listen to the first address family available (it +should listen to both instead). On most of IPv6-ready systems, IPv6 will take +precedence and the server may not accept IPv4 traffic. The client side will try +to connect to the all addresses returned as a result of the name resolution, and +sends traffic to the first one connected successfully.

    +
    # Echo server program
    +import socket
    +import sys
    +
    +HOST = None               # Symbolic name meaning all available interfaces
    +PORT = 50007              # Arbitrary non-privileged port
    +s = None
    +for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC,
    +                              socket.SOCK_STREAM, 0, socket.AI_PASSIVE):
    +    af, socktype, proto, canonname, sa = res
    +    try:
    +        s = socket.socket(af, socktype, proto)
    +    except OSError as msg:
    +        s = None
    +        continue
    +    try:
    +        s.bind(sa)
    +        s.listen(1)
    +    except OSError as msg:
    +        s.close()
    +        s = None
    +        continue
    +    break
    +if s is None:
    +    print('could not open socket')
    +    sys.exit(1)
    +conn, addr = s.accept()
    +with conn:
    +    print('Connected by', addr)
    +    while True:
    +        data = conn.recv(1024)
    +        if not data: break
    +        conn.send(data)
    +
    +
    +
    # Echo client program
    +import socket
    +import sys
    +
    +HOST = 'daring.cwi.nl'    # The remote host
    +PORT = 50007              # The same port as used by the server
    +s = None
    +for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC, socket.SOCK_STREAM):
    +    af, socktype, proto, canonname, sa = res
    +    try:
    +        s = socket.socket(af, socktype, proto)
    +    except OSError as msg:
    +        s = None
    +        continue
    +    try:
    +        s.connect(sa)
    +    except OSError as msg:
    +        s.close()
    +        s = None
    +        continue
    +    break
    +if s is None:
    +    print('could not open socket')
    +    sys.exit(1)
    +with s:
    +    s.sendall(b'Hello, world')
    +    data = s.recv(1024)
    +print('Received', repr(data))
    +
    +
    +

    The next example shows how to write a very simple network sniffer with raw +sockets on Windows. The example requires administrator privileges to modify +the interface:

    +
    import socket
    +
    +# the public network interface
    +HOST = socket.gethostbyname(socket.gethostname())
    +
    +# create a raw socket and bind it to the public interface
    +s = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.IPPROTO_IP)
    +s.bind((HOST, 0))
    +
    +# Include IP headers
    +s.setsockopt(socket.IPPROTO_IP, socket.IP_HDRINCL, 1)
    +
    +# receive all packages
    +s.ioctl(socket.SIO_RCVALL, socket.RCVALL_ON)
    +
    +# receive a package
    +print(s.recvfrom(65565))
    +
    +# disabled promiscuous mode
    +s.ioctl(socket.SIO_RCVALL, socket.RCVALL_OFF)
    +
    +
    +

    The next example shows how to use the socket interface to communicate to a CAN +network using the raw socket protocol. To use CAN with the broadcast +manager protocol instead, open a socket with:

    +
    socket.socket(socket.AF_CAN, socket.SOCK_DGRAM, socket.CAN_BCM)
    +
    +
    +

    After binding (CAN_RAW) or connecting (CAN_BCM) the socket, you +can use the socket.send(), and the socket.recv() operations (and +their counterparts) on the socket object as usual.

    +

    This last example might require special privileges:

    +
    import socket
    +import struct
    +
    +
    +# CAN frame packing/unpacking (see 'struct can_frame' in <linux/can.h>)
    +
    +can_frame_fmt = "=IB3x8s"
    +can_frame_size = struct.calcsize(can_frame_fmt)
    +
    +def build_can_frame(can_id, data):
    +    can_dlc = len(data)
    +    data = data.ljust(8, b'\x00')
    +    return struct.pack(can_frame_fmt, can_id, can_dlc, data)
    +
    +def dissect_can_frame(frame):
    +    can_id, can_dlc, data = struct.unpack(can_frame_fmt, frame)
    +    return (can_id, can_dlc, data[:can_dlc])
    +
    +
    +# create a raw socket and bind it to the 'vcan0' interface
    +s = socket.socket(socket.AF_CAN, socket.SOCK_RAW, socket.CAN_RAW)
    +s.bind(('vcan0',))
    +
    +while True:
    +    cf, addr = s.recvfrom(can_frame_size)
    +
    +    print('Received: can_id=%x, can_dlc=%x, data=%s' % dissect_can_frame(cf))
    +
    +    try:
    +        s.send(cf)
    +    except OSError:
    +        print('Error sending CAN frame')
    +
    +    try:
    +        s.send(build_can_frame(0x01, b'\x01\x02\x03'))
    +    except OSError:
    +        print('Error sending CAN frame')
    +
    +
    +

    Running an example several times with too small delay between executions, could +lead to this error:

    +
    OSError: [Errno 98] Address already in use
    +
    +
    +

    This is because the previous execution has left the socket in a TIME_WAIT +state, and can’t be immediately reused.

    +

    There is a socket flag to set, in order to prevent this, +socket.SO_REUSEADDR:

    +
    s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
    +s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
    +s.bind((HOST, PORT))
    +
    +
    +

    the SO_REUSEADDR flag tells the kernel to reuse a local socket in +TIME_WAIT state, without waiting for its natural timeout to expire.

    +
    +

    See also

    +

    For an introduction to socket programming (in C), see the following papers:

    +
      +
    • An Introductory 4.3BSD Interprocess Communication Tutorial, by Stuart Sechrest

    • +
    • An Advanced 4.3BSD Interprocess Communication Tutorial, by Samuel J. Leffler et +al,

    • +
    +

    both in the UNIX Programmer’s Manual, Supplementary Documents 1 (sections +PS1:7 and PS1:8). The platform-specific reference material for the various +socket-related system calls are also a valuable source of information on the +details of socket semantics. For Unix, refer to the manual pages; for Windows, +see the WinSock (or Winsock 2) specification. For IPv6-ready APIs, readers may +want to refer to RFC 3493 titled Basic Socket Interface Extensions for IPv6.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/socketserver.html b/python-3.7.4-docs-html/library/socketserver.html new file mode 100644 index 0000000..26974bb --- /dev/null +++ b/python-3.7.4-docs-html/library/socketserver.html @@ -0,0 +1,838 @@ + + + + + + + socketserver — A framework for network servers — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    socketserver — A framework for network servers

    +

    Source code: Lib/socketserver.py

    +
    +

    The socketserver module simplifies the task of writing network servers.

    +

    There are four basic concrete server classes:

    +
    +
    +class socketserver.TCPServer(server_address, RequestHandlerClass, bind_and_activate=True)
    +

    This uses the Internet TCP protocol, which provides for +continuous streams of data between the client and server. +If bind_and_activate is true, the constructor automatically attempts to +invoke server_bind() and +server_activate(). The other parameters are passed to +the BaseServer base class.

    +
    + +
    +
    +class socketserver.UDPServer(server_address, RequestHandlerClass, bind_and_activate=True)
    +

    This uses datagrams, which are discrete packets of information that may +arrive out of order or be lost while in transit. The parameters are +the same as for TCPServer.

    +
    + +
    +
    +class socketserver.UnixStreamServer(server_address, RequestHandlerClass, bind_and_activate=True)
    +
    +class socketserver.UnixDatagramServer(server_address, RequestHandlerClass, bind_and_activate=True)
    +

    These more infrequently used classes are similar to the TCP and +UDP classes, but use Unix domain sockets; they’re not available on +non-Unix platforms. The parameters are the same as for +TCPServer.

    +
    + +

    These four classes process requests synchronously; each request must be +completed before the next request can be started. This isn’t suitable if each +request takes a long time to complete, because it requires a lot of computation, +or because it returns a lot of data which the client is slow to process. The +solution is to create a separate process or thread to handle each request; the +ForkingMixIn and ThreadingMixIn mix-in classes can be used to +support asynchronous behaviour.

    +

    Creating a server requires several steps. First, you must create a request +handler class by subclassing the BaseRequestHandler class and +overriding its handle() method; +this method will process incoming +requests. Second, you must instantiate one of the server classes, passing it +the server’s address and the request handler class. It is recommended to use +the server in a with statement. Then call the +handle_request() or +serve_forever() method of the server object to +process one or many requests. Finally, call server_close() +to close the socket (unless you used a with statement).

    +

    When inheriting from ThreadingMixIn for threaded connection behavior, +you should explicitly declare how you want your threads to behave on an abrupt +shutdown. The ThreadingMixIn class defines an attribute +daemon_threads, which indicates whether or not the server should wait for +thread termination. You should set the flag explicitly if you would like +threads to behave autonomously; the default is False, meaning that +Python will not exit until all threads created by ThreadingMixIn have +exited.

    +

    Server classes have the same external methods and attributes, no matter what +network protocol they use.

    +
    +

    Server Creation Notes

    +

    There are five classes in an inheritance diagram, four of which represent +synchronous servers of four types:

    +
    +------------+
    +| BaseServer |
    ++------------+
    +      |
    +      v
    ++-----------+        +------------------+
    +| TCPServer |------->| UnixStreamServer |
    ++-----------+        +------------------+
    +      |
    +      v
    ++-----------+        +--------------------+
    +| UDPServer |------->| UnixDatagramServer |
    ++-----------+        +--------------------+
    +
    +
    +

    Note that UnixDatagramServer derives from UDPServer, not from +UnixStreamServer — the only difference between an IP and a Unix +stream server is the address family, which is simply repeated in both Unix +server classes.

    +
    +
    +class socketserver.ForkingMixIn
    +
    +class socketserver.ThreadingMixIn
    +

    Forking and threading versions of each type of server can be created +using these mix-in classes. For instance, ThreadingUDPServer +is created as follows:

    +
    class ThreadingUDPServer(ThreadingMixIn, UDPServer):
    +    pass
    +
    +
    +

    The mix-in class comes first, since it overrides a method defined in +UDPServer. Setting the various attributes also changes the +behavior of the underlying server mechanism.

    +

    ForkingMixIn and the Forking classes mentioned below are +only available on POSIX platforms that support fork().

    +

    socketserver.ForkingMixIn.server_close() waits until all child +processes complete, except if +socketserver.ForkingMixIn.block_on_close attribute is false.

    +

    socketserver.ThreadingMixIn.server_close() waits until all non-daemon +threads complete, except if +socketserver.ThreadingMixIn.block_on_close attribute is false. Use +daemonic threads by setting +ThreadingMixIn.daemon_threads to True to not wait until threads +complete.

    +
    +

    Changed in version 3.7: socketserver.ForkingMixIn.server_close() and +socketserver.ThreadingMixIn.server_close() now waits until all +child processes and non-daemonic threads complete. +Add a new socketserver.ForkingMixIn.block_on_close class +attribute to opt-in for the pre-3.7 behaviour.

    +
    +
    + +
    +
    +class socketserver.ForkingTCPServer
    +
    +class socketserver.ForkingUDPServer
    +
    +class socketserver.ThreadingTCPServer
    +
    +class socketserver.ThreadingUDPServer
    +

    These classes are pre-defined using the mix-in classes.

    +
    + +

    To implement a service, you must derive a class from BaseRequestHandler +and redefine its handle() method. +You can then run various versions of +the service by combining one of the server classes with your request handler +class. The request handler class must be different for datagram or stream +services. This can be hidden by using the handler subclasses +StreamRequestHandler or DatagramRequestHandler.

    +

    Of course, you still have to use your head! For instance, it makes no sense to +use a forking server if the service contains state in memory that can be +modified by different requests, since the modifications in the child process +would never reach the initial state kept in the parent process and passed to +each child. In this case, you can use a threading server, but you will probably +have to use locks to protect the integrity of the shared data.

    +

    On the other hand, if you are building an HTTP server where all data is stored +externally (for instance, in the file system), a synchronous class will +essentially render the service “deaf” while one request is being handled – +which may be for a very long time if a client is slow to receive all the data it +has requested. Here a threading or forking server is appropriate.

    +

    In some cases, it may be appropriate to process part of a request synchronously, +but to finish processing in a forked child depending on the request data. This +can be implemented by using a synchronous server and doing an explicit fork in +the request handler class handle() method.

    +

    Another approach to handling multiple simultaneous requests in an environment +that supports neither threads nor fork() (or where these are too +expensive or inappropriate for the service) is to maintain an explicit table of +partially finished requests and to use selectors to decide which +request to work on next (or whether to handle a new incoming request). This is +particularly important for stream services where each client can potentially be +connected for a long time (if threads or subprocesses cannot be used). See +asyncore for another way to manage this.

    +
    +
    +

    Server Objects

    +
    +
    +class socketserver.BaseServer(server_address, RequestHandlerClass)
    +

    This is the superclass of all Server objects in the module. It defines the +interface, given below, but does not implement most of the methods, which is +done in subclasses. The two parameters are stored in the respective +server_address and RequestHandlerClass attributes.

    +
    +
    +fileno()
    +

    Return an integer file descriptor for the socket on which the server is +listening. This function is most commonly passed to selectors, to +allow monitoring multiple servers in the same process.

    +
    + +
    +
    +handle_request()
    +

    Process a single request. This function calls the following methods in +order: get_request(), verify_request(), and +process_request(). If the user-provided +handle() method of the +handler class raises an exception, the server’s handle_error() method +will be called. If no request is received within timeout +seconds, handle_timeout() will be called and handle_request() +will return.

    +
    + +
    +
    +serve_forever(poll_interval=0.5)
    +

    Handle requests until an explicit shutdown() request. Poll for +shutdown every poll_interval seconds. +Ignores the timeout attribute. It +also calls service_actions(), which may be used by a subclass or mixin +to provide actions specific to a given service. For example, the +ForkingMixIn class uses service_actions() to clean up zombie +child processes.

    +
    +

    Changed in version 3.3: Added service_actions call to the serve_forever method.

    +
    +
    + +
    +
    +service_actions()
    +

    This is called in the serve_forever() loop. This method can be +overridden by subclasses or mixin classes to perform actions specific to +a given service, such as cleanup actions.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +shutdown()
    +

    Tell the serve_forever() loop to stop and wait until it does.

    +
    + +
    +
    +server_close()
    +

    Clean up the server. May be overridden.

    +
    + +
    +
    +address_family
    +

    The family of protocols to which the server’s socket belongs. +Common examples are socket.AF_INET and socket.AF_UNIX.

    +
    + +
    +
    +RequestHandlerClass
    +

    The user-provided request handler class; an instance of this class is created +for each request.

    +
    + +
    +
    +server_address
    +

    The address on which the server is listening. The format of addresses varies +depending on the protocol family; +see the documentation for the socket module +for details. For Internet protocols, this is a tuple containing a string giving +the address, and an integer port number: ('127.0.0.1', 80), for example.

    +
    + +
    +
    +socket
    +

    The socket object on which the server will listen for incoming requests.

    +
    + +

    The server classes support the following class variables:

    +
    +
    +allow_reuse_address
    +

    Whether the server will allow the reuse of an address. This defaults to +False, and can be set in subclasses to change the policy.

    +
    + +
    +
    +request_queue_size
    +

    The size of the request queue. If it takes a long time to process a single +request, any requests that arrive while the server is busy are placed into a +queue, up to request_queue_size requests. Once the queue is full, +further requests from clients will get a “Connection denied” error. The default +value is usually 5, but this can be overridden by subclasses.

    +
    + +
    +
    +socket_type
    +

    The type of socket used by the server; socket.SOCK_STREAM and +socket.SOCK_DGRAM are two common values.

    +
    + +
    +
    +timeout
    +

    Timeout duration, measured in seconds, or None if no timeout is +desired. If handle_request() receives no incoming requests within the +timeout period, the handle_timeout() method is called.

    +
    + +

    There are various server methods that can be overridden by subclasses of base +server classes like TCPServer; these methods aren’t useful to external +users of the server object.

    +
    +
    +finish_request(request, client_address)
    +

    Actually processes the request by instantiating RequestHandlerClass and +calling its handle() method.

    +
    + +
    +
    +get_request()
    +

    Must accept a request from the socket, and return a 2-tuple containing the new +socket object to be used to communicate with the client, and the client’s +address.

    +
    + +
    +
    +handle_error(request, client_address)
    +

    This function is called if the handle() +method of a RequestHandlerClass instance raises +an exception. The default action is to print the traceback to +standard error and continue handling further requests.

    +
    +

    Changed in version 3.6: Now only called for exceptions derived from the Exception +class.

    +
    +
    + +
    +
    +handle_timeout()
    +

    This function is called when the timeout attribute has been set to a +value other than None and the timeout period has passed with no +requests being received. The default action for forking servers is +to collect the status of any child processes that have exited, while +in threading servers this method does nothing.

    +
    + +
    +
    +process_request(request, client_address)
    +

    Calls finish_request() to create an instance of the +RequestHandlerClass. If desired, this function can create a new process +or thread to handle the request; the ForkingMixIn and +ThreadingMixIn classes do this.

    +
    + +
    +
    +server_activate()
    +

    Called by the server’s constructor to activate the server. The default behavior +for a TCP server just invokes listen() +on the server’s socket. May be overridden.

    +
    + +
    +
    +server_bind()
    +

    Called by the server’s constructor to bind the socket to the desired address. +May be overridden.

    +
    + +
    +
    +verify_request(request, client_address)
    +

    Must return a Boolean value; if the value is True, the request will +be processed, and if it’s False, the request will be denied. This +function can be overridden to implement access controls for a server. The +default implementation always returns True.

    +
    + +
    +

    Changed in version 3.6: Support for the context manager protocol was added. Exiting the +context manager is equivalent to calling server_close().

    +
    +
    + +
    +
    +

    Request Handler Objects

    +
    +
    +class socketserver.BaseRequestHandler
    +

    This is the superclass of all request handler objects. It defines +the interface, given below. A concrete request handler subclass must +define a new handle() method, and can override any of +the other methods. A new instance of the subclass is created for each +request.

    +
    +
    +setup()
    +

    Called before the handle() method to perform any initialization actions +required. The default implementation does nothing.

    +
    + +
    +
    +handle()
    +

    This function must do all the work required to service a request. The +default implementation does nothing. Several instance attributes are +available to it; the request is available as self.request; the client +address as self.client_address; and the server instance as +self.server, in case it needs access to per-server information.

    +

    The type of self.request is different for datagram or stream +services. For stream services, self.request is a socket object; for +datagram services, self.request is a pair of string and socket.

    +
    + +
    +
    +finish()
    +

    Called after the handle() method to perform any clean-up actions +required. The default implementation does nothing. If setup() +raises an exception, this function will not be called.

    +
    + +
    + +
    +
    +class socketserver.StreamRequestHandler
    +
    +class socketserver.DatagramRequestHandler
    +

    These BaseRequestHandler subclasses override the +setup() and finish() +methods, and provide self.rfile and self.wfile attributes. +The self.rfile and self.wfile attributes can be +read or written, respectively, to get the request data or return data +to the client.

    +

    The rfile attributes of both classes support the +io.BufferedIOBase readable interface, and +DatagramRequestHandler.wfile supports the +io.BufferedIOBase writable interface.

    +
    +

    Changed in version 3.6: StreamRequestHandler.wfile also supports the +io.BufferedIOBase writable interface.

    +
    +
    + +
    +
    +

    Examples

    +
    +

    socketserver.TCPServer Example

    +

    This is the server side:

    +
    import socketserver
    +
    +class MyTCPHandler(socketserver.BaseRequestHandler):
    +    """
    +    The request handler class for our server.
    +
    +    It is instantiated once per connection to the server, and must
    +    override the handle() method to implement communication to the
    +    client.
    +    """
    +
    +    def handle(self):
    +        # self.request is the TCP socket connected to the client
    +        self.data = self.request.recv(1024).strip()
    +        print("{} wrote:".format(self.client_address[0]))
    +        print(self.data)
    +        # just send back the same data, but upper-cased
    +        self.request.sendall(self.data.upper())
    +
    +if __name__ == "__main__":
    +    HOST, PORT = "localhost", 9999
    +
    +    # Create the server, binding to localhost on port 9999
    +    with socketserver.TCPServer((HOST, PORT), MyTCPHandler) as server:
    +        # Activate the server; this will keep running until you
    +        # interrupt the program with Ctrl-C
    +        server.serve_forever()
    +
    +
    +

    An alternative request handler class that makes use of streams (file-like +objects that simplify communication by providing the standard file interface):

    +
    class MyTCPHandler(socketserver.StreamRequestHandler):
    +
    +    def handle(self):
    +        # self.rfile is a file-like object created by the handler;
    +        # we can now use e.g. readline() instead of raw recv() calls
    +        self.data = self.rfile.readline().strip()
    +        print("{} wrote:".format(self.client_address[0]))
    +        print(self.data)
    +        # Likewise, self.wfile is a file-like object used to write back
    +        # to the client
    +        self.wfile.write(self.data.upper())
    +
    +
    +

    The difference is that the readline() call in the second handler will call +recv() multiple times until it encounters a newline character, while the +single recv() call in the first handler will just return what has been sent +from the client in one sendall() call.

    +

    This is the client side:

    +
    import socket
    +import sys
    +
    +HOST, PORT = "localhost", 9999
    +data = " ".join(sys.argv[1:])
    +
    +# Create a socket (SOCK_STREAM means a TCP socket)
    +with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
    +    # Connect to server and send data
    +    sock.connect((HOST, PORT))
    +    sock.sendall(bytes(data + "\n", "utf-8"))
    +
    +    # Receive data from the server and shut down
    +    received = str(sock.recv(1024), "utf-8")
    +
    +print("Sent:     {}".format(data))
    +print("Received: {}".format(received))
    +
    +
    +

    The output of the example should look something like this:

    +

    Server:

    +
    $ python TCPServer.py
    +127.0.0.1 wrote:
    +b'hello world with TCP'
    +127.0.0.1 wrote:
    +b'python is nice'
    +
    +
    +

    Client:

    +
    $ python TCPClient.py hello world with TCP
    +Sent:     hello world with TCP
    +Received: HELLO WORLD WITH TCP
    +$ python TCPClient.py python is nice
    +Sent:     python is nice
    +Received: PYTHON IS NICE
    +
    +
    +
    +
    +

    socketserver.UDPServer Example

    +

    This is the server side:

    +
    import socketserver
    +
    +class MyUDPHandler(socketserver.BaseRequestHandler):
    +    """
    +    This class works similar to the TCP handler class, except that
    +    self.request consists of a pair of data and client socket, and since
    +    there is no connection the client address must be given explicitly
    +    when sending data back via sendto().
    +    """
    +
    +    def handle(self):
    +        data = self.request[0].strip()
    +        socket = self.request[1]
    +        print("{} wrote:".format(self.client_address[0]))
    +        print(data)
    +        socket.sendto(data.upper(), self.client_address)
    +
    +if __name__ == "__main__":
    +    HOST, PORT = "localhost", 9999
    +    with socketserver.UDPServer((HOST, PORT), MyUDPHandler) as server:
    +        server.serve_forever()
    +
    +
    +

    This is the client side:

    +
    import socket
    +import sys
    +
    +HOST, PORT = "localhost", 9999
    +data = " ".join(sys.argv[1:])
    +
    +# SOCK_DGRAM is the socket type to use for UDP sockets
    +sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
    +
    +# As you can see, there is no connect() call; UDP has no connections.
    +# Instead, data is directly sent to the recipient via sendto().
    +sock.sendto(bytes(data + "\n", "utf-8"), (HOST, PORT))
    +received = str(sock.recv(1024), "utf-8")
    +
    +print("Sent:     {}".format(data))
    +print("Received: {}".format(received))
    +
    +
    +

    The output of the example should look exactly like for the TCP server example.

    +
    +
    +

    Asynchronous Mixins

    +

    To build asynchronous handlers, use the ThreadingMixIn and +ForkingMixIn classes.

    +

    An example for the ThreadingMixIn class:

    +
    import socket
    +import threading
    +import socketserver
    +
    +class ThreadedTCPRequestHandler(socketserver.BaseRequestHandler):
    +
    +    def handle(self):
    +        data = str(self.request.recv(1024), 'ascii')
    +        cur_thread = threading.current_thread()
    +        response = bytes("{}: {}".format(cur_thread.name, data), 'ascii')
    +        self.request.sendall(response)
    +
    +class ThreadedTCPServer(socketserver.ThreadingMixIn, socketserver.TCPServer):
    +    pass
    +
    +def client(ip, port, message):
    +    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
    +        sock.connect((ip, port))
    +        sock.sendall(bytes(message, 'ascii'))
    +        response = str(sock.recv(1024), 'ascii')
    +        print("Received: {}".format(response))
    +
    +if __name__ == "__main__":
    +    # Port 0 means to select an arbitrary unused port
    +    HOST, PORT = "localhost", 0
    +
    +    server = ThreadedTCPServer((HOST, PORT), ThreadedTCPRequestHandler)
    +    with server:
    +        ip, port = server.server_address
    +
    +        # Start a thread with the server -- that thread will then start one
    +        # more thread for each request
    +        server_thread = threading.Thread(target=server.serve_forever)
    +        # Exit the server thread when the main thread terminates
    +        server_thread.daemon = True
    +        server_thread.start()
    +        print("Server loop running in thread:", server_thread.name)
    +
    +        client(ip, port, "Hello World 1")
    +        client(ip, port, "Hello World 2")
    +        client(ip, port, "Hello World 3")
    +
    +        server.shutdown()
    +
    +
    +

    The output of the example should look something like this:

    +
    $ python ThreadedTCPServer.py
    +Server loop running in thread: Thread-1
    +Received: Thread-2: Hello World 1
    +Received: Thread-3: Hello World 2
    +Received: Thread-4: Hello World 3
    +
    +
    +

    The ForkingMixIn class is used in the same way, except that the server +will spawn a new process for each request. +Available only on POSIX platforms that support fork().

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/spwd.html b/python-3.7.4-docs-html/library/spwd.html new file mode 100644 index 0000000..d63902f --- /dev/null +++ b/python-3.7.4-docs-html/library/spwd.html @@ -0,0 +1,277 @@ + + + + + + + spwd — The shadow password database — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    spwd — The shadow password database

    +
    +

    This module provides access to the Unix shadow password database. It is +available on various Unix versions.

    +

    You must have enough privileges to access the shadow password database (this +usually means you have to be root).

    +

    Shadow password database entries are reported as a tuple-like object, whose +attributes correspond to the members of the spwd structure (Attribute field +below, see <shadow.h>):

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Index

    Attribute

    Meaning

    0

    sp_namp

    Login name

    1

    sp_pwdp

    Encrypted password

    2

    sp_lstchg

    Date of last change

    3

    sp_min

    Minimal number of days between +changes

    4

    sp_max

    Maximum number of days between +changes

    5

    sp_warn

    Number of days before password +expires to warn user about it

    6

    sp_inact

    Number of days after password +expires until account is +disabled

    7

    sp_expire

    Number of days since 1970-01-01 +when account expires

    8

    sp_flag

    Reserved

    +

    The sp_namp and sp_pwdp items are strings, all others are integers. +KeyError is raised if the entry asked for cannot be found.

    +

    The following functions are defined:

    +
    +
    +spwd.getspnam(name)
    +

    Return the shadow password database entry for the given user name.

    +
    +

    Changed in version 3.6: Raises a PermissionError instead of KeyError if the user +doesn’t have privileges.

    +
    +
    + +
    +
    +spwd.getspall()
    +

    Return a list of all available shadow password database entries, in arbitrary +order.

    +
    + +
    +

    See also

    +
    +
    Module grp

    An interface to the group database, similar to this.

    +
    +
    Module pwd

    An interface to the normal password database, similar to this.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/sqlite3.html b/python-3.7.4-docs-html/library/sqlite3.html new file mode 100644 index 0000000..b212ae0 --- /dev/null +++ b/python-3.7.4-docs-html/library/sqlite3.html @@ -0,0 +1,1729 @@ + + + + + + + sqlite3 — DB-API 2.0 interface for SQLite databases — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    sqlite3 — DB-API 2.0 interface for SQLite databases

    +

    Source code: Lib/sqlite3/

    +
    +

    SQLite is a C library that provides a lightweight disk-based database that +doesn’t require a separate server process and allows accessing the database +using a nonstandard variant of the SQL query language. Some applications can use +SQLite for internal data storage. It’s also possible to prototype an +application using SQLite and then port the code to a larger database such as +PostgreSQL or Oracle.

    +

    The sqlite3 module was written by Gerhard Häring. It provides a SQL interface +compliant with the DB-API 2.0 specification described by PEP 249.

    +

    To use the module, you must first create a Connection object that +represents the database. Here the data will be stored in the +example.db file:

    +
    import sqlite3
    +conn = sqlite3.connect('example.db')
    +
    +
    +

    You can also supply the special name :memory: to create a database in RAM.

    +

    Once you have a Connection, you can create a Cursor object +and call its execute() method to perform SQL commands:

    +
    c = conn.cursor()
    +
    +# Create table
    +c.execute('''CREATE TABLE stocks
    +             (date text, trans text, symbol text, qty real, price real)''')
    +
    +# Insert a row of data
    +c.execute("INSERT INTO stocks VALUES ('2006-01-05','BUY','RHAT',100,35.14)")
    +
    +# Save (commit) the changes
    +conn.commit()
    +
    +# We can also close the connection if we are done with it.
    +# Just be sure any changes have been committed or they will be lost.
    +conn.close()
    +
    +
    +

    The data you’ve saved is persistent and is available in subsequent sessions:

    +
    import sqlite3
    +conn = sqlite3.connect('example.db')
    +c = conn.cursor()
    +
    +
    +

    Usually your SQL operations will need to use values from Python variables. You +shouldn’t assemble your query using Python’s string operations because doing so +is insecure; it makes your program vulnerable to an SQL injection attack +(see https://xkcd.com/327/ for humorous example of what can go wrong).

    +

    Instead, use the DB-API’s parameter substitution. Put ? as a placeholder +wherever you want to use a value, and then provide a tuple of values as the +second argument to the cursor’s execute() method. (Other database +modules may use a different placeholder, such as %s or :1.) For +example:

    +
    # Never do this -- insecure!
    +symbol = 'RHAT'
    +c.execute("SELECT * FROM stocks WHERE symbol = '%s'" % symbol)
    +
    +# Do this instead
    +t = ('RHAT',)
    +c.execute('SELECT * FROM stocks WHERE symbol=?', t)
    +print(c.fetchone())
    +
    +# Larger example that inserts many records at a time
    +purchases = [('2006-03-28', 'BUY', 'IBM', 1000, 45.00),
    +             ('2006-04-05', 'BUY', 'MSFT', 1000, 72.00),
    +             ('2006-04-06', 'SELL', 'IBM', 500, 53.00),
    +            ]
    +c.executemany('INSERT INTO stocks VALUES (?,?,?,?,?)', purchases)
    +
    +
    +

    To retrieve data after executing a SELECT statement, you can either treat the +cursor as an iterator, call the cursor’s fetchone() method to +retrieve a single matching row, or call fetchall() to get a list of the +matching rows.

    +

    This example uses the iterator form:

    +
    >>> for row in c.execute('SELECT * FROM stocks ORDER BY price'):
    +        print(row)
    +
    +('2006-01-05', 'BUY', 'RHAT', 100, 35.14)
    +('2006-03-28', 'BUY', 'IBM', 1000, 45.0)
    +('2006-04-06', 'SELL', 'IBM', 500, 53.0)
    +('2006-04-05', 'BUY', 'MSFT', 1000, 72.0)
    +
    +
    +
    +

    See also

    +
    +
    https://github.com/ghaering/pysqlite

    The pysqlite web page – sqlite3 is developed externally under the name +“pysqlite”.

    +
    +
    https://www.sqlite.org

    The SQLite web page; the documentation describes the syntax and the +available data types for the supported SQL dialect.

    +
    +
    https://www.w3schools.com/sql/

    Tutorial, reference and examples for learning SQL syntax.

    +
    +
    PEP 249 - Database API Specification 2.0

    PEP written by Marc-André Lemburg.

    +
    +
    +
    +
    +

    Module functions and constants

    +
    +
    +sqlite3.version
    +

    The version number of this module, as a string. This is not the version of +the SQLite library.

    +
    + +
    +
    +sqlite3.version_info
    +

    The version number of this module, as a tuple of integers. This is not the +version of the SQLite library.

    +
    + +
    +
    +sqlite3.sqlite_version
    +

    The version number of the run-time SQLite library, as a string.

    +
    + +
    +
    +sqlite3.sqlite_version_info
    +

    The version number of the run-time SQLite library, as a tuple of integers.

    +
    + +
    +
    +sqlite3.PARSE_DECLTYPES
    +

    This constant is meant to be used with the detect_types parameter of the +connect() function.

    +

    Setting it makes the sqlite3 module parse the declared type for each +column it returns. It will parse out the first word of the declared type, +i. e. for “integer primary key”, it will parse out “integer”, or for +“number(10)” it will parse out “number”. Then for that column, it will look +into the converters dictionary and use the converter function registered for +that type there.

    +
    + +
    +
    +sqlite3.PARSE_COLNAMES
    +

    This constant is meant to be used with the detect_types parameter of the +connect() function.

    +

    Setting this makes the SQLite interface parse the column name for each column it +returns. It will look for a string formed [mytype] in there, and then decide +that ‘mytype’ is the type of the column. It will try to find an entry of +‘mytype’ in the converters dictionary and then use the converter function found +there to return the value. The column name found in Cursor.description +is only the first word of the column name, i. e. if you use something like +'as "x [datetime]"' in your SQL, then we will parse out everything until the +first blank for the column name: the column name would simply be “x”.

    +
    + +
    +
    +sqlite3.connect(database[, timeout, detect_types, isolation_level, check_same_thread, factory, cached_statements, uri])
    +

    Opens a connection to the SQLite database file database. By default returns a +Connection object, unless a custom factory is given.

    +

    database is a path-like object giving the pathname (absolute or +relative to the current working directory) of the database file to be opened. +You can use ":memory:" to open a database connection to a database that +resides in RAM instead of on disk.

    +

    When a database is accessed by multiple connections, and one of the processes +modifies the database, the SQLite database is locked until that transaction is +committed. The timeout parameter specifies how long the connection should wait +for the lock to go away until raising an exception. The default for the timeout +parameter is 5.0 (five seconds).

    +

    For the isolation_level parameter, please see the +isolation_level property of Connection objects.

    +

    SQLite natively supports only the types TEXT, INTEGER, REAL, BLOB and NULL. If +you want to use other types you must add support for them yourself. The +detect_types parameter and the using custom converters registered with the +module-level register_converter() function allow you to easily do that.

    +

    detect_types defaults to 0 (i. e. off, no type detection), you can set it to +any combination of PARSE_DECLTYPES and PARSE_COLNAMES to turn +type detection on.

    +

    By default, check_same_thread is True and only the creating thread may +use the connection. If set False, the returned connection may be shared +across multiple threads. When using multiple threads with the same connection +writing operations should be serialized by the user to avoid data corruption.

    +

    By default, the sqlite3 module uses its Connection class for the +connect call. You can, however, subclass the Connection class and make +connect() use your class instead by providing your class for the factory +parameter.

    +

    Consult the section SQLite and Python types of this manual for details.

    +

    The sqlite3 module internally uses a statement cache to avoid SQL parsing +overhead. If you want to explicitly set the number of statements that are cached +for the connection, you can set the cached_statements parameter. The currently +implemented default is to cache 100 statements.

    +

    If uri is true, database is interpreted as a URI. This allows you +to specify options. For example, to open a database in read-only mode +you can use:

    +
    db = sqlite3.connect('file:path/to/database?mode=ro', uri=True)
    +
    +
    +

    More information about this feature, including a list of recognized options, can +be found in the SQLite URI documentation.

    +
    +

    Changed in version 3.4: Added the uri parameter.

    +
    +
    +

    Changed in version 3.7: database can now also be a path-like object, not only a string.

    +
    +
    + +
    +
    +sqlite3.register_converter(typename, callable)
    +

    Registers a callable to convert a bytestring from the database into a custom +Python type. The callable will be invoked for all database values that are of +the type typename. Confer the parameter detect_types of the connect() +function for how the type detection works. Note that typename and the name of +the type in your query are matched in case-insensitive manner.

    +
    + +
    +
    +sqlite3.register_adapter(type, callable)
    +

    Registers a callable to convert the custom Python type type into one of +SQLite’s supported types. The callable callable accepts as single parameter +the Python value, and must return a value of the following types: int, +float, str or bytes.

    +
    + +
    +
    +sqlite3.complete_statement(sql)
    +

    Returns True if the string sql contains one or more complete SQL +statements terminated by semicolons. It does not verify that the SQL is +syntactically correct, only that there are no unclosed string literals and the +statement is terminated by a semicolon.

    +

    This can be used to build a shell for SQLite, as in the following example:

    +
    # A minimal SQLite shell for experiments
    +
    +import sqlite3
    +
    +con = sqlite3.connect(":memory:")
    +con.isolation_level = None
    +cur = con.cursor()
    +
    +buffer = ""
    +
    +print("Enter your SQL commands to execute in sqlite3.")
    +print("Enter a blank line to exit.")
    +
    +while True:
    +    line = input()
    +    if line == "":
    +        break
    +    buffer += line
    +    if sqlite3.complete_statement(buffer):
    +        try:
    +            buffer = buffer.strip()
    +            cur.execute(buffer)
    +
    +            if buffer.lstrip().upper().startswith("SELECT"):
    +                print(cur.fetchall())
    +        except sqlite3.Error as e:
    +            print("An error occurred:", e.args[0])
    +        buffer = ""
    +
    +con.close()
    +
    +
    +
    + +
    +
    +sqlite3.enable_callback_tracebacks(flag)
    +

    By default you will not get any tracebacks in user-defined functions, +aggregates, converters, authorizer callbacks etc. If you want to debug them, +you can call this function with flag set to True. Afterwards, you will +get tracebacks from callbacks on sys.stderr. Use False to +disable the feature again.

    +
    + +
    +
    +

    Connection Objects

    +
    +
    +class sqlite3.Connection
    +

    A SQLite database connection has the following attributes and methods:

    +
    +
    +isolation_level
    +

    Get or set the current default isolation level. None for autocommit mode or +one of “DEFERRED”, “IMMEDIATE” or “EXCLUSIVE”. See section +Controlling Transactions for a more detailed explanation.

    +
    + +
    +
    +in_transaction
    +

    True if a transaction is active (there are uncommitted changes), +False otherwise. Read-only attribute.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +cursor(factory=Cursor)
    +

    The cursor method accepts a single optional parameter factory. If +supplied, this must be a callable returning an instance of Cursor +or its subclasses.

    +
    + +
    +
    +commit()
    +

    This method commits the current transaction. If you don’t call this method, +anything you did since the last call to commit() is not visible from +other database connections. If you wonder why you don’t see the data you’ve +written to the database, please check you didn’t forget to call this method.

    +
    + +
    +
    +rollback()
    +

    This method rolls back any changes to the database since the last call to +commit().

    +
    + +
    +
    +close()
    +

    This closes the database connection. Note that this does not automatically +call commit(). If you just close your database connection without +calling commit() first, your changes will be lost!

    +
    + +
    +
    +execute(sql[, parameters])
    +

    This is a nonstandard shortcut that creates a cursor object by calling +the cursor() method, calls the cursor’s +execute() method with the parameters given, and returns +the cursor.

    +
    + +
    +
    +executemany(sql[, parameters])
    +

    This is a nonstandard shortcut that creates a cursor object by +calling the cursor() method, calls the cursor’s +executemany() method with the parameters given, and +returns the cursor.

    +
    + +
    +
    +executescript(sql_script)
    +

    This is a nonstandard shortcut that creates a cursor object by +calling the cursor() method, calls the cursor’s +executescript() method with the given sql_script, and +returns the cursor.

    +
    + +
    +
    +create_function(name, num_params, func)
    +

    Creates a user-defined function that you can later use from within SQL +statements under the function name name. num_params is the number of +parameters the function accepts (if num_params is -1, the function may +take any number of arguments), and func is a Python callable that is +called as the SQL function.

    +

    The function can return any of the types supported by SQLite: bytes, str, int, +float and None.

    +

    Example:

    +
    import sqlite3
    +import hashlib
    +
    +def md5sum(t):
    +    return hashlib.md5(t).hexdigest()
    +
    +con = sqlite3.connect(":memory:")
    +con.create_function("md5", 1, md5sum)
    +cur = con.cursor()
    +cur.execute("select md5(?)", (b"foo",))
    +print(cur.fetchone()[0])
    +
    +con.close()
    +
    +
    +
    + +
    +
    +create_aggregate(name, num_params, aggregate_class)
    +

    Creates a user-defined aggregate function.

    +

    The aggregate class must implement a step method, which accepts the number +of parameters num_params (if num_params is -1, the function may take +any number of arguments), and a finalize method which will return the +final result of the aggregate.

    +

    The finalize method can return any of the types supported by SQLite: +bytes, str, int, float and None.

    +

    Example:

    +
    import sqlite3
    +
    +class MySum:
    +    def __init__(self):
    +        self.count = 0
    +
    +    def step(self, value):
    +        self.count += value
    +
    +    def finalize(self):
    +        return self.count
    +
    +con = sqlite3.connect(":memory:")
    +con.create_aggregate("mysum", 1, MySum)
    +cur = con.cursor()
    +cur.execute("create table test(i)")
    +cur.execute("insert into test(i) values (1)")
    +cur.execute("insert into test(i) values (2)")
    +cur.execute("select mysum(i) from test")
    +print(cur.fetchone()[0])
    +
    +con.close()
    +
    +
    +
    + +
    +
    +create_collation(name, callable)
    +

    Creates a collation with the specified name and callable. The callable will +be passed two string arguments. It should return -1 if the first is ordered +lower than the second, 0 if they are ordered equal and 1 if the first is ordered +higher than the second. Note that this controls sorting (ORDER BY in SQL) so +your comparisons don’t affect other SQL operations.

    +

    Note that the callable will get its parameters as Python bytestrings, which will +normally be encoded in UTF-8.

    +

    The following example shows a custom collation that sorts “the wrong way”:

    +
    import sqlite3
    +
    +def collate_reverse(string1, string2):
    +    if string1 == string2:
    +        return 0
    +    elif string1 < string2:
    +        return 1
    +    else:
    +        return -1
    +
    +con = sqlite3.connect(":memory:")
    +con.create_collation("reverse", collate_reverse)
    +
    +cur = con.cursor()
    +cur.execute("create table test(x)")
    +cur.executemany("insert into test(x) values (?)", [("a",), ("b",)])
    +cur.execute("select x from test order by x collate reverse")
    +for row in cur:
    +    print(row)
    +con.close()
    +
    +
    +

    To remove a collation, call create_collation with None as callable:

    +
    con.create_collation("reverse", None)
    +
    +
    +
    + +
    +
    +interrupt()
    +

    You can call this method from a different thread to abort any queries that might +be executing on the connection. The query will then abort and the caller will +get an exception.

    +
    + +
    +
    +set_authorizer(authorizer_callback)
    +

    This routine registers a callback. The callback is invoked for each attempt to +access a column of a table in the database. The callback should return +SQLITE_OK if access is allowed, SQLITE_DENY if the entire SQL +statement should be aborted with an error and SQLITE_IGNORE if the +column should be treated as a NULL value. These constants are available in the +sqlite3 module.

    +

    The first argument to the callback signifies what kind of operation is to be +authorized. The second and third argument will be arguments or None +depending on the first argument. The 4th argument is the name of the database +(“main”, “temp”, etc.) if applicable. The 5th argument is the name of the +inner-most trigger or view that is responsible for the access attempt or +None if this access attempt is directly from input SQL code.

    +

    Please consult the SQLite documentation about the possible values for the first +argument and the meaning of the second and third argument depending on the first +one. All necessary constants are available in the sqlite3 module.

    +
    + +
    +
    +set_progress_handler(handler, n)
    +

    This routine registers a callback. The callback is invoked for every n +instructions of the SQLite virtual machine. This is useful if you want to +get called from SQLite during long-running operations, for example to update +a GUI.

    +

    If you want to clear any previously installed progress handler, call the +method with None for handler.

    +

    Returning a non-zero value from the handler function will terminate the +currently executing query and cause it to raise an OperationalError +exception.

    +
    + +
    +
    +set_trace_callback(trace_callback)
    +

    Registers trace_callback to be called for each SQL statement that is +actually executed by the SQLite backend.

    +

    The only argument passed to the callback is the statement (as string) that +is being executed. The return value of the callback is ignored. Note that +the backend does not only run statements passed to the Cursor.execute() +methods. Other sources include the transaction management of the Python +module and the execution of triggers defined in the current database.

    +

    Passing None as trace_callback will disable the trace callback.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +enable_load_extension(enabled)
    +

    This routine allows/disallows the SQLite engine to load SQLite extensions +from shared libraries. SQLite extensions can define new functions, +aggregates or whole new virtual table implementations. One well-known +extension is the fulltext-search extension distributed with SQLite.

    +

    Loadable extensions are disabled by default. See 1.

    +
    +

    New in version 3.2.

    +
    +
    import sqlite3
    +
    +con = sqlite3.connect(":memory:")
    +
    +# enable extension loading
    +con.enable_load_extension(True)
    +
    +# Load the fulltext search extension
    +con.execute("select load_extension('./fts3.so')")
    +
    +# alternatively you can load the extension using an API call:
    +# con.load_extension("./fts3.so")
    +
    +# disable extension loading again
    +con.enable_load_extension(False)
    +
    +# example from SQLite wiki
    +con.execute("create virtual table recipe using fts3(name, ingredients)")
    +con.executescript("""
    +    insert into recipe (name, ingredients) values ('broccoli stew', 'broccoli peppers cheese tomatoes');
    +    insert into recipe (name, ingredients) values ('pumpkin stew', 'pumpkin onions garlic celery');
    +    insert into recipe (name, ingredients) values ('broccoli pie', 'broccoli cheese onions flour');
    +    insert into recipe (name, ingredients) values ('pumpkin pie', 'pumpkin sugar flour butter');
    +    """)
    +for row in con.execute("select rowid, name, ingredients from recipe where name match 'pie'"):
    +    print(row)
    +
    +con.close()
    +
    +
    +
    + +
    +
    +load_extension(path)
    +

    This routine loads a SQLite extension from a shared library. You have to +enable extension loading with enable_load_extension() before you can +use this routine.

    +

    Loadable extensions are disabled by default. See 1.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +row_factory
    +

    You can change this attribute to a callable that accepts the cursor and the +original row as a tuple and will return the real result row. This way, you can +implement more advanced ways of returning results, such as returning an object +that can also access columns by name.

    +

    Example:

    +
    import sqlite3
    +
    +def dict_factory(cursor, row):
    +    d = {}
    +    for idx, col in enumerate(cursor.description):
    +        d[col[0]] = row[idx]
    +    return d
    +
    +con = sqlite3.connect(":memory:")
    +con.row_factory = dict_factory
    +cur = con.cursor()
    +cur.execute("select 1 as a")
    +print(cur.fetchone()["a"])
    +
    +con.close()
    +
    +
    +

    If returning a tuple doesn’t suffice and you want name-based access to +columns, you should consider setting row_factory to the +highly-optimized sqlite3.Row type. Row provides both +index-based and case-insensitive name-based access to columns with almost no +memory overhead. It will probably be better than your own custom +dictionary-based approach or even a db_row based solution.

    +
    + +
    +
    +text_factory
    +

    Using this attribute you can control what objects are returned for the TEXT +data type. By default, this attribute is set to str and the +sqlite3 module will return Unicode objects for TEXT. If you want to +return bytestrings instead, you can set it to bytes.

    +

    You can also set it to any other callable that accepts a single bytestring +parameter and returns the resulting object.

    +

    See the following example code for illustration:

    +
    import sqlite3
    +
    +con = sqlite3.connect(":memory:")
    +cur = con.cursor()
    +
    +AUSTRIA = "\xd6sterreich"
    +
    +# by default, rows are returned as Unicode
    +cur.execute("select ?", (AUSTRIA,))
    +row = cur.fetchone()
    +assert row[0] == AUSTRIA
    +
    +# but we can make sqlite3 always return bytestrings ...
    +con.text_factory = bytes
    +cur.execute("select ?", (AUSTRIA,))
    +row = cur.fetchone()
    +assert type(row[0]) is bytes
    +# the bytestrings will be encoded in UTF-8, unless you stored garbage in the
    +# database ...
    +assert row[0] == AUSTRIA.encode("utf-8")
    +
    +# we can also implement a custom text_factory ...
    +# here we implement one that appends "foo" to all strings
    +con.text_factory = lambda x: x.decode("utf-8") + "foo"
    +cur.execute("select ?", ("bar",))
    +row = cur.fetchone()
    +assert row[0] == "barfoo"
    +
    +con.close()
    +
    +
    +
    + +
    +
    +total_changes
    +

    Returns the total number of database rows that have been modified, inserted, or +deleted since the database connection was opened.

    +
    + +
    +
    +iterdump()
    +

    Returns an iterator to dump the database in an SQL text format. Useful when +saving an in-memory database for later restoration. This function provides +the same capabilities as the .dump command in the sqlite3 +shell.

    +

    Example:

    +
    # Convert file existing_db.db to SQL dump file dump.sql
    +import sqlite3
    +
    +con = sqlite3.connect('existing_db.db')
    +with open('dump.sql', 'w') as f:
    +    for line in con.iterdump():
    +        f.write('%s\n' % line)
    +con.close()
    +
    +
    +
    + +
    +
    +backup(target, *, pages=0, progress=None, name="main", sleep=0.250)
    +

    This method makes a backup of a SQLite database even while it’s being accessed +by other clients, or concurrently by the same connection. The copy will be +written into the mandatory argument target, that must be another +Connection instance.

    +

    By default, or when pages is either 0 or a negative integer, the entire +database is copied in a single step; otherwise the method performs a loop +copying up to pages pages at a time.

    +

    If progress is specified, it must either be None or a callable object that +will be executed at each iteration with three integer arguments, respectively +the status of the last iteration, the remaining number of pages still to be +copied and the total number of pages.

    +

    The name argument specifies the database name that will be copied: it must be +a string containing either "main", the default, to indicate the main +database, "temp" to indicate the temporary database or the name specified +after the AS keyword in an ATTACH DATABASE statement for an attached +database.

    +

    The sleep argument specifies the number of seconds to sleep by between +successive attempts to backup remaining pages, can be specified either as an +integer or a floating point value.

    +

    Example 1, copy an existing database into another:

    +
    import sqlite3
    +
    +def progress(status, remaining, total):
    +    print(f'Copied {total-remaining} of {total} pages...')
    +
    +con = sqlite3.connect('existing_db.db')
    +bck = sqlite3.connect('backup.db')
    +with bck:
    +    con.backup(bck, pages=1, progress=progress)
    +bck.close()
    +con.close()
    +
    +
    +

    Example 2, copy an existing database into a transient copy:

    +
    import sqlite3
    +
    +source = sqlite3.connect('existing_db.db')
    +dest = sqlite3.connect(':memory:')
    +source.backup(dest)
    +
    +
    +

    Availability: SQLite 3.6.11 or higher

    +
    +

    New in version 3.7.

    +
    +
    + +
    + +
    +
    +

    Cursor Objects

    +
    +
    +class sqlite3.Cursor
    +

    A Cursor instance has the following attributes and methods.

    +
    +
    +execute(sql[, parameters])
    +

    Executes an SQL statement. The SQL statement may be parameterized (i. e. +placeholders instead of SQL literals). The sqlite3 module supports two +kinds of placeholders: question marks (qmark style) and named placeholders +(named style).

    +

    Here’s an example of both styles:

    +
    import sqlite3
    +
    +con = sqlite3.connect(":memory:")
    +cur = con.cursor()
    +cur.execute("create table people (name_last, age)")
    +
    +who = "Yeltsin"
    +age = 72
    +
    +# This is the qmark style:
    +cur.execute("insert into people values (?, ?)", (who, age))
    +
    +# And this is the named style:
    +cur.execute("select * from people where name_last=:who and age=:age", {"who": who, "age": age})
    +
    +print(cur.fetchone())
    +
    +con.close()
    +
    +
    +

    execute() will only execute a single SQL statement. If you try to execute +more than one statement with it, it will raise a Warning. Use +executescript() if you want to execute multiple SQL statements with one +call.

    +
    + +
    +
    +executemany(sql, seq_of_parameters)
    +

    Executes an SQL command against all parameter sequences or mappings found in +the sequence seq_of_parameters. The sqlite3 module also allows +using an iterator yielding parameters instead of a sequence.

    +
    import sqlite3
    +
    +class IterChars:
    +    def __init__(self):
    +        self.count = ord('a')
    +
    +    def __iter__(self):
    +        return self
    +
    +    def __next__(self):
    +        if self.count > ord('z'):
    +            raise StopIteration
    +        self.count += 1
    +        return (chr(self.count - 1),) # this is a 1-tuple
    +
    +con = sqlite3.connect(":memory:")
    +cur = con.cursor()
    +cur.execute("create table characters(c)")
    +
    +theIter = IterChars()
    +cur.executemany("insert into characters(c) values (?)", theIter)
    +
    +cur.execute("select c from characters")
    +print(cur.fetchall())
    +
    +con.close()
    +
    +
    +

    Here’s a shorter example using a generator:

    +
    import sqlite3
    +import string
    +
    +def char_generator():
    +    for c in string.ascii_lowercase:
    +        yield (c,)
    +
    +con = sqlite3.connect(":memory:")
    +cur = con.cursor()
    +cur.execute("create table characters(c)")
    +
    +cur.executemany("insert into characters(c) values (?)", char_generator())
    +
    +cur.execute("select c from characters")
    +print(cur.fetchall())
    +
    +con.close()
    +
    +
    +
    + +
    +
    +executescript(sql_script)
    +

    This is a nonstandard convenience method for executing multiple SQL statements +at once. It issues a COMMIT statement first, then executes the SQL script it +gets as a parameter.

    +

    sql_script can be an instance of str.

    +

    Example:

    +
    import sqlite3
    +
    +con = sqlite3.connect(":memory:")
    +cur = con.cursor()
    +cur.executescript("""
    +    create table person(
    +        firstname,
    +        lastname,
    +        age
    +    );
    +
    +    create table book(
    +        title,
    +        author,
    +        published
    +    );
    +
    +    insert into book(title, author, published)
    +    values (
    +        'Dirk Gently''s Holistic Detective Agency',
    +        'Douglas Adams',
    +        1987
    +    );
    +    """)
    +con.close()
    +
    +
    +
    + +
    +
    +fetchone()
    +

    Fetches the next row of a query result set, returning a single sequence, +or None when no more data is available.

    +
    + +
    +
    +fetchmany(size=cursor.arraysize)
    +

    Fetches the next set of rows of a query result, returning a list. An empty +list is returned when no more rows are available.

    +

    The number of rows to fetch per call is specified by the size parameter. +If it is not given, the cursor’s arraysize determines the number of rows +to be fetched. The method should try to fetch as many rows as indicated by +the size parameter. If this is not possible due to the specified number of +rows not being available, fewer rows may be returned.

    +

    Note there are performance considerations involved with the size parameter. +For optimal performance, it is usually best to use the arraysize attribute. +If the size parameter is used, then it is best for it to retain the same +value from one fetchmany() call to the next.

    +
    + +
    +
    +fetchall()
    +

    Fetches all (remaining) rows of a query result, returning a list. Note that +the cursor’s arraysize attribute can affect the performance of this operation. +An empty list is returned when no rows are available.

    +
    + +
    +
    +close()
    +

    Close the cursor now (rather than whenever __del__ is called).

    +

    The cursor will be unusable from this point forward; a ProgrammingError +exception will be raised if any operation is attempted with the cursor.

    +
    + +
    +
    +rowcount
    +

    Although the Cursor class of the sqlite3 module implements this +attribute, the database engine’s own support for the determination of “rows +affected”/”rows selected” is quirky.

    +

    For executemany() statements, the number of modifications are summed up +into rowcount.

    +

    As required by the Python DB API Spec, the rowcount attribute “is -1 in +case no executeXX() has been performed on the cursor or the rowcount of the +last operation is not determinable by the interface”. This includes SELECT +statements because we cannot determine the number of rows a query produced +until all rows were fetched.

    +

    With SQLite versions before 3.6.5, rowcount is set to 0 if +you make a DELETE FROM table without any condition.

    +
    + +
    +
    +lastrowid
    +

    This read-only attribute provides the rowid of the last modified row. It is +only set if you issued an INSERT or a REPLACE statement using the +execute() method. For operations other than INSERT or +REPLACE or when executemany() is called, lastrowid is +set to None.

    +

    If the INSERT or REPLACE statement failed to insert the previous +successful rowid is returned.

    +
    +

    Changed in version 3.6: Added support for the REPLACE statement.

    +
    +
    + +
    +
    +arraysize
    +

    Read/write attribute that controls the number of rows returned by fetchmany(). +The default value is 1 which means a single row would be fetched per call.

    +
    + +
    +
    +description
    +

    This read-only attribute provides the column names of the last query. To +remain compatible with the Python DB API, it returns a 7-tuple for each +column where the last six items of each tuple are None.

    +

    It is set for SELECT statements without any matching rows as well.

    +
    + +
    +
    +connection
    +

    This read-only attribute provides the SQLite database Connection +used by the Cursor object. A Cursor object created by +calling con.cursor() will have a +connection attribute that refers to con:

    +
    >>> con = sqlite3.connect(":memory:")
    +>>> cur = con.cursor()
    +>>> cur.connection == con
    +True
    +
    +
    +
    + +
    + +
    +
    +

    Row Objects

    +
    +
    +class sqlite3.Row
    +

    A Row instance serves as a highly optimized +row_factory for Connection objects. +It tries to mimic a tuple in most of its features.

    +

    It supports mapping access by column name and index, iteration, +representation, equality testing and len().

    +

    If two Row objects have exactly the same columns and their +members are equal, they compare equal.

    +
    +
    +keys()
    +

    This method returns a list of column names. Immediately after a query, +it is the first member of each tuple in Cursor.description.

    +
    + +
    +

    Changed in version 3.5: Added support of slicing.

    +
    +
    + +

    Let’s assume we initialize a table as in the example given above:

    +
    conn = sqlite3.connect(":memory:")
    +c = conn.cursor()
    +c.execute('''create table stocks
    +(date text, trans text, symbol text,
    + qty real, price real)''')
    +c.execute("""insert into stocks
    +          values ('2006-01-05','BUY','RHAT',100,35.14)""")
    +conn.commit()
    +c.close()
    +
    +
    +

    Now we plug Row in:

    +
    >>> conn.row_factory = sqlite3.Row
    +>>> c = conn.cursor()
    +>>> c.execute('select * from stocks')
    +<sqlite3.Cursor object at 0x7f4e7dd8fa80>
    +>>> r = c.fetchone()
    +>>> type(r)
    +<class 'sqlite3.Row'>
    +>>> tuple(r)
    +('2006-01-05', 'BUY', 'RHAT', 100.0, 35.14)
    +>>> len(r)
    +5
    +>>> r[2]
    +'RHAT'
    +>>> r.keys()
    +['date', 'trans', 'symbol', 'qty', 'price']
    +>>> r['qty']
    +100.0
    +>>> for member in r:
    +...     print(member)
    +...
    +2006-01-05
    +BUY
    +RHAT
    +100.0
    +35.14
    +
    +
    +
    +
    +

    Exceptions

    +
    +
    +exception sqlite3.Warning
    +

    A subclass of Exception.

    +
    + +
    +
    +exception sqlite3.Error
    +

    The base class of the other exceptions in this module. It is a subclass +of Exception.

    +
    + +
    +
    +exception sqlite3.DatabaseError
    +

    Exception raised for errors that are related to the database.

    +
    + +
    +
    +exception sqlite3.IntegrityError
    +

    Exception raised when the relational integrity of the database is affected, +e.g. a foreign key check fails. It is a subclass of DatabaseError.

    +
    + +
    +
    +exception sqlite3.ProgrammingError
    +

    Exception raised for programming errors, e.g. table not found or already +exists, syntax error in the SQL statement, wrong number of parameters +specified, etc. It is a subclass of DatabaseError.

    +
    + +
    +
    +exception sqlite3.OperationalError
    +

    Exception raised for errors that are related to the database’s operation +and not necessarily under the control of the programmer, e.g. an unexpected +disconnect occurs, the data source name is not found, a transaction could +not be processed, etc. It is a subclass of DatabaseError.

    +
    + +
    +
    +exception sqlite3.NotSupportedError
    +

    Exception raised in case a method or database API was used which is not +supported by the database, e.g. calling the rollback() +method on a connection that does not support transaction or has +transactions turned off. It is a subclass of DatabaseError.

    +
    + +
    +
    +

    SQLite and Python types

    +
    +

    Introduction

    +

    SQLite natively supports the following types: NULL, INTEGER, +REAL, TEXT, BLOB.

    +

    The following Python types can thus be sent to SQLite without any problem:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + +

    Python type

    SQLite type

    None

    NULL

    int

    INTEGER

    float

    REAL

    str

    TEXT

    bytes

    BLOB

    +

    This is how SQLite types are converted to Python types by default:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + +

    SQLite type

    Python type

    NULL

    None

    INTEGER

    int

    REAL

    float

    TEXT

    depends on text_factory, +str by default

    BLOB

    bytes

    +

    The type system of the sqlite3 module is extensible in two ways: you can +store additional Python types in a SQLite database via object adaptation, and +you can let the sqlite3 module convert SQLite types to different Python +types via converters.

    +
    +
    +

    Using adapters to store additional Python types in SQLite databases

    +

    As described before, SQLite supports only a limited set of types natively. To +use other Python types with SQLite, you must adapt them to one of the +sqlite3 module’s supported types for SQLite: one of NoneType, int, float, +str, bytes.

    +

    There are two ways to enable the sqlite3 module to adapt a custom Python +type to one of the supported ones.

    +
    +

    Letting your object adapt itself

    +

    This is a good approach if you write the class yourself. Let’s suppose you have +a class like this:

    +
    class Point:
    +    def __init__(self, x, y):
    +        self.x, self.y = x, y
    +
    +
    +

    Now you want to store the point in a single SQLite column. First you’ll have to +choose one of the supported types first to be used for representing the point. +Let’s just use str and separate the coordinates using a semicolon. Then you need +to give your class a method __conform__(self, protocol) which must return +the converted value. The parameter protocol will be PrepareProtocol.

    +
    import sqlite3
    +
    +class Point:
    +    def __init__(self, x, y):
    +        self.x, self.y = x, y
    +
    +    def __conform__(self, protocol):
    +        if protocol is sqlite3.PrepareProtocol:
    +            return "%f;%f" % (self.x, self.y)
    +
    +con = sqlite3.connect(":memory:")
    +cur = con.cursor()
    +
    +p = Point(4.0, -3.2)
    +cur.execute("select ?", (p,))
    +print(cur.fetchone()[0])
    +
    +con.close()
    +
    +
    +
    +
    +

    Registering an adapter callable

    +

    The other possibility is to create a function that converts the type to the +string representation and register the function with register_adapter().

    +
    import sqlite3
    +
    +class Point:
    +    def __init__(self, x, y):
    +        self.x, self.y = x, y
    +
    +def adapt_point(point):
    +    return "%f;%f" % (point.x, point.y)
    +
    +sqlite3.register_adapter(Point, adapt_point)
    +
    +con = sqlite3.connect(":memory:")
    +cur = con.cursor()
    +
    +p = Point(4.0, -3.2)
    +cur.execute("select ?", (p,))
    +print(cur.fetchone()[0])
    +
    +con.close()
    +
    +
    +

    The sqlite3 module has two default adapters for Python’s built-in +datetime.date and datetime.datetime types. Now let’s suppose +we want to store datetime.datetime objects not in ISO representation, +but as a Unix timestamp.

    +
    import sqlite3
    +import datetime
    +import time
    +
    +def adapt_datetime(ts):
    +    return time.mktime(ts.timetuple())
    +
    +sqlite3.register_adapter(datetime.datetime, adapt_datetime)
    +
    +con = sqlite3.connect(":memory:")
    +cur = con.cursor()
    +
    +now = datetime.datetime.now()
    +cur.execute("select ?", (now,))
    +print(cur.fetchone()[0])
    +
    +con.close()
    +
    +
    +
    +
    +
    +

    Converting SQLite values to custom Python types

    +

    Writing an adapter lets you send custom Python types to SQLite. But to make it +really useful we need to make the Python to SQLite to Python roundtrip work.

    +

    Enter converters.

    +

    Let’s go back to the Point class. We stored the x and y coordinates +separated via semicolons as strings in SQLite.

    +

    First, we’ll define a converter function that accepts the string as a parameter +and constructs a Point object from it.

    +
    +

    Note

    +

    Converter functions always get called with a bytes object, no +matter under which data type you sent the value to SQLite.

    +
    +
    def convert_point(s):
    +    x, y = map(float, s.split(b";"))
    +    return Point(x, y)
    +
    +
    +

    Now you need to make the sqlite3 module know that what you select from +the database is actually a point. There are two ways of doing this:

    +
      +
    • Implicitly via the declared type

    • +
    • Explicitly via the column name

    • +
    +

    Both ways are described in section Module functions and constants, in the entries +for the constants PARSE_DECLTYPES and PARSE_COLNAMES.

    +

    The following example illustrates both approaches.

    +
    import sqlite3
    +
    +class Point:
    +    def __init__(self, x, y):
    +        self.x, self.y = x, y
    +
    +    def __repr__(self):
    +        return "(%f;%f)" % (self.x, self.y)
    +
    +def adapt_point(point):
    +    return ("%f;%f" % (point.x, point.y)).encode('ascii')
    +
    +def convert_point(s):
    +    x, y = list(map(float, s.split(b";")))
    +    return Point(x, y)
    +
    +# Register the adapter
    +sqlite3.register_adapter(Point, adapt_point)
    +
    +# Register the converter
    +sqlite3.register_converter("point", convert_point)
    +
    +p = Point(4.0, -3.2)
    +
    +#########################
    +# 1) Using declared types
    +con = sqlite3.connect(":memory:", detect_types=sqlite3.PARSE_DECLTYPES)
    +cur = con.cursor()
    +cur.execute("create table test(p point)")
    +
    +cur.execute("insert into test(p) values (?)", (p,))
    +cur.execute("select p from test")
    +print("with declared types:", cur.fetchone()[0])
    +cur.close()
    +con.close()
    +
    +#######################
    +# 1) Using column names
    +con = sqlite3.connect(":memory:", detect_types=sqlite3.PARSE_COLNAMES)
    +cur = con.cursor()
    +cur.execute("create table test(p)")
    +
    +cur.execute("insert into test(p) values (?)", (p,))
    +cur.execute('select p as "p [point]" from test')
    +print("with column names:", cur.fetchone()[0])
    +cur.close()
    +con.close()
    +
    +
    +
    +
    +

    Default adapters and converters

    +

    There are default adapters for the date and datetime types in the datetime +module. They will be sent as ISO dates/ISO timestamps to SQLite.

    +

    The default converters are registered under the name “date” for +datetime.date and under the name “timestamp” for +datetime.datetime.

    +

    This way, you can use date/timestamps from Python without any additional +fiddling in most cases. The format of the adapters is also compatible with the +experimental SQLite date/time functions.

    +

    The following example demonstrates this.

    +
    import sqlite3
    +import datetime
    +
    +con = sqlite3.connect(":memory:", detect_types=sqlite3.PARSE_DECLTYPES|sqlite3.PARSE_COLNAMES)
    +cur = con.cursor()
    +cur.execute("create table test(d date, ts timestamp)")
    +
    +today = datetime.date.today()
    +now = datetime.datetime.now()
    +
    +cur.execute("insert into test(d, ts) values (?, ?)", (today, now))
    +cur.execute("select d, ts from test")
    +row = cur.fetchone()
    +print(today, "=>", row[0], type(row[0]))
    +print(now, "=>", row[1], type(row[1]))
    +
    +cur.execute('select current_date as "d [date]", current_timestamp as "ts [timestamp]"')
    +row = cur.fetchone()
    +print("current_date", row[0], type(row[0]))
    +print("current_timestamp", row[1], type(row[1]))
    +
    +con.close()
    +
    +
    +

    If a timestamp stored in SQLite has a fractional part longer than 6 +numbers, its value will be truncated to microsecond precision by the +timestamp converter.

    +
    +
    +
    +

    Controlling Transactions

    +

    The underlying sqlite3 library operates in autocommit mode by default, +but the Python sqlite3 module by default does not.

    +

    autocommit mode means that statements that modify the database take effect +immediately. A BEGIN or SAVEPOINT statement disables autocommit +mode, and a COMMIT, a ROLLBACK, or a RELEASE that ends the +outermost transaction, turns autocommit mode back on.

    +

    The Python sqlite3 module by default issues a BEGIN statement +implicitly before a Data Modification Language (DML) statement (i.e. +INSERT/UPDATE/DELETE/REPLACE).

    +

    You can control which kind of BEGIN statements sqlite3 implicitly +executes via the isolation_level parameter to the connect() +call, or via the isolation_level property of connections. +If you specify no isolation_level, a plain BEGIN is used, which is +equivalent to specifying DEFERRED. Other possible values are IMMEDIATE +and EXCLUSIVE.

    +

    You can disable the sqlite3 module’s implicit transaction management by +setting isolation_level to None. This will leave the underlying +sqlite3 library operating in autocommit mode. You can then completely +control the transaction state by explicitly issuing BEGIN, ROLLBACK, +SAVEPOINT, and RELEASE statements in your code.

    +
    +

    Changed in version 3.6: sqlite3 used to implicitly commit an open transaction before DDL +statements. This is no longer the case.

    +
    +
    +
    +

    Using sqlite3 efficiently

    +
    +

    Using shortcut methods

    +

    Using the nonstandard execute(), executemany() and +executescript() methods of the Connection object, your code can +be written more concisely because you don’t have to create the (often +superfluous) Cursor objects explicitly. Instead, the Cursor +objects are created implicitly and these shortcut methods return the cursor +objects. This way, you can execute a SELECT statement and iterate over it +directly using only a single call on the Connection object.

    +
    import sqlite3
    +
    +persons = [
    +    ("Hugo", "Boss"),
    +    ("Calvin", "Klein")
    +    ]
    +
    +con = sqlite3.connect(":memory:")
    +
    +# Create the table
    +con.execute("create table person(firstname, lastname)")
    +
    +# Fill the table
    +con.executemany("insert into person(firstname, lastname) values (?, ?)", persons)
    +
    +# Print the table contents
    +for row in con.execute("select firstname, lastname from person"):
    +    print(row)
    +
    +print("I just deleted", con.execute("delete from person").rowcount, "rows")
    +
    +# close is not a shortcut method and it's not called automatically,
    +# so the connection object should be closed manually
    +con.close()
    +
    +
    +
    +
    +

    Accessing columns by name instead of by index

    +

    One useful feature of the sqlite3 module is the built-in +sqlite3.Row class designed to be used as a row factory.

    +

    Rows wrapped with this class can be accessed both by index (like tuples) and +case-insensitively by name:

    +
    import sqlite3
    +
    +con = sqlite3.connect(":memory:")
    +con.row_factory = sqlite3.Row
    +
    +cur = con.cursor()
    +cur.execute("select 'John' as name, 42 as age")
    +for row in cur:
    +    assert row[0] == row["name"]
    +    assert row["name"] == row["nAmE"]
    +    assert row[1] == row["age"]
    +    assert row[1] == row["AgE"]
    +
    +con.close()
    +
    +
    +
    +
    +

    Using the connection as a context manager

    +

    Connection objects can be used as context managers +that automatically commit or rollback transactions. In the event of an +exception, the transaction is rolled back; otherwise, the transaction is +committed:

    +
    import sqlite3
    +
    +con = sqlite3.connect(":memory:")
    +con.execute("create table person (id integer primary key, firstname varchar unique)")
    +
    +# Successful, con.commit() is called automatically afterwards
    +with con:
    +    con.execute("insert into person(firstname) values (?)", ("Joe",))
    +
    +# con.rollback() is called after the with block finishes with an exception, the
    +# exception is still raised and must be caught
    +try:
    +    with con:
    +        con.execute("insert into person(firstname) values (?)", ("Joe",))
    +except sqlite3.IntegrityError:
    +    print("couldn't add Joe twice")
    +
    +# Connection object used as context manager only commits or rollbacks transactions,
    +# so the connection object should be closed manually
    +con.close()
    +
    +
    +
    +
    +
    +

    Common issues

    +
    +

    Multithreading

    +

    Older SQLite versions had issues with sharing connections between threads. +That’s why the Python module disallows sharing connections and cursors between +threads. If you still try to do so, you will get an exception at runtime.

    +

    The only exception is calling the interrupt() method, which +only makes sense to call from a different thread.

    +

    Footnotes

    +
    +
    1(1,2)
    +

    The sqlite3 module is not built with loadable extension support by +default, because some platforms (notably Mac OS X) have SQLite +libraries which are compiled without this feature. To get loadable +extension support, you must pass –enable-loadable-sqlite-extensions to +configure.

    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/ssl.html b/python-3.7.4-docs-html/library/ssl.html new file mode 100644 index 0000000..a7bfb41 --- /dev/null +++ b/python-3.7.4-docs-html/library/ssl.html @@ -0,0 +1,3252 @@ + + + + + + + ssl — TLS/SSL wrapper for socket objects — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    ssl — TLS/SSL wrapper for socket objects

    +

    Source code: Lib/ssl.py

    +
    +

    This module provides access to Transport Layer Security (often known as “Secure +Sockets Layer”) encryption and peer authentication facilities for network +sockets, both client-side and server-side. This module uses the OpenSSL +library. It is available on all modern Unix systems, Windows, Mac OS X, and +probably additional platforms, as long as OpenSSL is installed on that platform.

    +
    +

    Note

    +

    Some behavior may be platform dependent, since calls are made to the +operating system socket APIs. The installed version of OpenSSL may also +cause variations in behavior. For example, TLSv1.1 and TLSv1.2 come with +openssl version 1.0.1.

    +
    +
    +

    Warning

    +

    Don’t use this module without reading the Security considerations. Doing so +may lead to a false sense of security, as the default settings of the +ssl module are not necessarily appropriate for your application.

    +
    +

    This section documents the objects and functions in the ssl module; for more +general information about TLS, SSL, and certificates, the reader is referred to +the documents in the “See Also” section at the bottom.

    +

    This module provides a class, ssl.SSLSocket, which is derived from the +socket.socket type, and provides a socket-like wrapper that also +encrypts and decrypts the data going over the socket with SSL. It supports +additional methods such as getpeercert(), which retrieves the +certificate of the other side of the connection, and cipher(),which +retrieves the cipher being used for the secure connection.

    +

    For more sophisticated applications, the ssl.SSLContext class +helps manage settings and certificates, which can then be inherited +by SSL sockets created through the SSLContext.wrap_socket() method.

    +
    +

    Changed in version 3.5.3: Updated to support linking with OpenSSL 1.1.0

    +
    +
    +

    Changed in version 3.6: OpenSSL 0.9.8, 1.0.0 and 1.0.1 are deprecated and no longer supported. +In the future the ssl module will require at least OpenSSL 1.0.2 or +1.1.0.

    +
    +
    +

    Functions, Constants, and Exceptions

    +
    +

    Socket creation

    +

    Since Python 3.2 and 2.7.9, it is recommended to use the +SSLContext.wrap_socket() of an SSLContext instance to wrap +sockets as SSLSocket objects. The helper functions +create_default_context() returns a new context with secure default +settings. The old wrap_socket() function is deprecated since it is +both inefficient and has no support for server name indication (SNI) and +hostname matching.

    +

    Client socket example with default context and IPv4/IPv6 dual stack:

    +
    import socket
    +import ssl
    +
    +hostname = 'www.python.org'
    +context = ssl.create_default_context()
    +
    +with socket.create_connection((hostname, 443)) as sock:
    +    with context.wrap_socket(sock, server_hostname=hostname) as ssock:
    +        print(ssock.version())
    +
    +
    +

    Client socket example with custom context and IPv4:

    +
    hostname = 'www.python.org'
    +# PROTOCOL_TLS_CLIENT requires valid cert chain and hostname
    +context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
    +context.load_verify_locations('path/to/cabundle.pem')
    +
    +with socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0) as sock:
    +    with context.wrap_socket(sock, server_hostname=hostname) as ssock:
    +        print(ssock.version())
    +
    +
    +

    Server socket example listening on localhost IPv4:

    +
    context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
    +context.load_cert_chain('/path/to/certchain.pem', '/path/to/private.key')
    +
    +with socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0) as sock:
    +    sock.bind(('127.0.0.1', 8443))
    +    sock.listen(5)
    +    with context.wrap_socket(sock, server_side=True) as ssock:
    +        conn, addr = ssock.accept()
    +        ...
    +
    +
    +
    +
    +

    Context creation

    +

    A convenience function helps create SSLContext objects for common +purposes.

    +
    +
    +ssl.create_default_context(purpose=Purpose.SERVER_AUTH, cafile=None, capath=None, cadata=None)
    +

    Return a new SSLContext object with default settings for +the given purpose. The settings are chosen by the ssl module, +and usually represent a higher security level than when calling the +SSLContext constructor directly.

    +

    cafile, capath, cadata represent optional CA certificates to +trust for certificate verification, as in +SSLContext.load_verify_locations(). If all three are +None, this function can choose to trust the system’s default +CA certificates instead.

    +

    The settings are: PROTOCOL_TLS, OP_NO_SSLv2, and +OP_NO_SSLv3 with high encryption cipher suites without RC4 and +without unauthenticated cipher suites. Passing SERVER_AUTH +as purpose sets verify_mode to CERT_REQUIRED +and either loads CA certificates (when at least one of cafile, capath or +cadata is given) or uses SSLContext.load_default_certs() to load +default CA certificates.

    +
    +

    Note

    +

    The protocol, options, cipher and other settings may change to more +restrictive values anytime without prior deprecation. The values +represent a fair balance between compatibility and security.

    +

    If your application needs specific settings, you should create a +SSLContext and apply the settings yourself.

    +
    +
    +

    Note

    +

    If you find that when certain older clients or servers attempt to connect +with a SSLContext created by this function that they get an error +stating “Protocol or cipher suite mismatch”, it may be that they only +support SSL3.0 which this function excludes using the +OP_NO_SSLv3. SSL3.0 is widely considered to be completely broken. If you still wish to continue to +use this function but still allow SSL 3.0 connections you can re-enable +them using:

    +
    ctx = ssl.create_default_context(Purpose.CLIENT_AUTH)
    +ctx.options &= ~ssl.OP_NO_SSLv3
    +
    +
    +
    +
    +

    New in version 3.4.

    +
    +
    +

    Changed in version 3.4.4: RC4 was dropped from the default cipher string.

    +
    +
    +

    Changed in version 3.6: ChaCha20/Poly1305 was added to the default cipher string.

    +

    3DES was dropped from the default cipher string.

    +
    +
    + +
    +
    +

    Exceptions

    +
    +
    +exception ssl.SSLError
    +

    Raised to signal an error from the underlying SSL implementation +(currently provided by the OpenSSL library). This signifies some +problem in the higher-level encryption and authentication layer that’s +superimposed on the underlying network connection. This error +is a subtype of OSError. The error code and message of +SSLError instances are provided by the OpenSSL library.

    +
    +

    Changed in version 3.3: SSLError used to be a subtype of socket.error.

    +
    +
    +
    +library
    +

    A string mnemonic designating the OpenSSL submodule in which the error +occurred, such as SSL, PEM or X509. The range of possible +values depends on the OpenSSL version.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +reason
    +

    A string mnemonic designating the reason this error occurred, for +example CERTIFICATE_VERIFY_FAILED. The range of possible +values depends on the OpenSSL version.

    +
    +

    New in version 3.3.

    +
    +
    + +
    + +
    +
    +exception ssl.SSLZeroReturnError
    +

    A subclass of SSLError raised when trying to read or write and +the SSL connection has been closed cleanly. Note that this doesn’t +mean that the underlying transport (read TCP) has been closed.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +exception ssl.SSLWantReadError
    +

    A subclass of SSLError raised by a non-blocking SSL socket when trying to read or write data, but more data needs +to be received on the underlying TCP transport before the request can be +fulfilled.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +exception ssl.SSLWantWriteError
    +

    A subclass of SSLError raised by a non-blocking SSL socket when trying to read or write data, but more data needs +to be sent on the underlying TCP transport before the request can be +fulfilled.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +exception ssl.SSLSyscallError
    +

    A subclass of SSLError raised when a system error was encountered +while trying to fulfill an operation on a SSL socket. Unfortunately, +there is no easy way to inspect the original errno number.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +exception ssl.SSLEOFError
    +

    A subclass of SSLError raised when the SSL connection has been +terminated abruptly. Generally, you shouldn’t try to reuse the underlying +transport when this error is encountered.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +exception ssl.SSLCertVerificationError
    +

    A subclass of SSLError raised when certificate validation has +failed.

    +
    +

    New in version 3.7.

    +
    +
    +
    +verify_code
    +

    A numeric error number that denotes the verification error.

    +
    + +
    +
    +verify_message
    +

    A human readable string of the verification error.

    +
    + +
    + +
    +
    +exception ssl.CertificateError
    +

    An alias for SSLCertVerificationError.

    +
    +

    Changed in version 3.7: The exception is now an alias for SSLCertVerificationError.

    +
    +
    + +
    +
    +

    Random generation

    +
    +
    +ssl.RAND_bytes(num)
    +

    Return num cryptographically strong pseudo-random bytes. Raises an +SSLError if the PRNG has not been seeded with enough data or if the +operation is not supported by the current RAND method. RAND_status() +can be used to check the status of the PRNG and RAND_add() can be used +to seed the PRNG.

    +

    For almost all applications os.urandom() is preferable.

    +

    Read the Wikipedia article, Cryptographically secure pseudorandom number +generator (CSPRNG), +to get the requirements of a cryptographically generator.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +ssl.RAND_pseudo_bytes(num)
    +

    Return (bytes, is_cryptographic): bytes are num pseudo-random bytes, +is_cryptographic is True if the bytes generated are cryptographically +strong. Raises an SSLError if the operation is not supported by the +current RAND method.

    +

    Generated pseudo-random byte sequences will be unique if they are of +sufficient length, but are not necessarily unpredictable. They can be used +for non-cryptographic purposes and for certain purposes in cryptographic +protocols, but usually not for key generation etc.

    +

    For almost all applications os.urandom() is preferable.

    +
    +

    New in version 3.3.

    +
    +
    +

    Deprecated since version 3.6: OpenSSL has deprecated ssl.RAND_pseudo_bytes(), use +ssl.RAND_bytes() instead.

    +
    +
    + +
    +
    +ssl.RAND_status()
    +

    Return True if the SSL pseudo-random number generator has been seeded +with ‘enough’ randomness, and False otherwise. You can use +ssl.RAND_egd() and ssl.RAND_add() to increase the randomness of +the pseudo-random number generator.

    +
    + +
    +
    +ssl.RAND_egd(path)
    +

    If you are running an entropy-gathering daemon (EGD) somewhere, and path +is the pathname of a socket connection open to it, this will read 256 bytes +of randomness from the socket, and add it to the SSL pseudo-random number +generator to increase the security of generated secret keys. This is +typically only necessary on systems without better sources of randomness.

    +

    See http://egd.sourceforge.net/ or http://prngd.sourceforge.net/ for sources +of entropy-gathering daemons.

    +

    Availability: not available with LibreSSL and OpenSSL > 1.1.0.

    +
    + +
    +
    +ssl.RAND_add(bytes, entropy)
    +

    Mix the given bytes into the SSL pseudo-random number generator. The +parameter entropy (a float) is a lower bound on the entropy contained in +string (so you can always use 0.0). See RFC 1750 for more +information on sources of entropy.

    +
    +

    Changed in version 3.5: Writable bytes-like object is now accepted.

    +
    +
    + +
    +
    +

    Certificate handling

    +
    +
    +ssl.match_hostname(cert, hostname)
    +

    Verify that cert (in decoded format as returned by +SSLSocket.getpeercert()) matches the given hostname. The rules +applied are those for checking the identity of HTTPS servers as outlined +in RFC 2818, RFC 5280 and RFC 6125. In addition to HTTPS, this +function should be suitable for checking the identity of servers in +various SSL-based protocols such as FTPS, IMAPS, POPS and others.

    +

    CertificateError is raised on failure. On success, the function +returns nothing:

    +
    >>> cert = {'subject': ((('commonName', 'example.com'),),)}
    +>>> ssl.match_hostname(cert, "example.com")
    +>>> ssl.match_hostname(cert, "example.org")
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +  File "/home/py3k/Lib/ssl.py", line 130, in match_hostname
    +ssl.CertificateError: hostname 'example.org' doesn't match 'example.com'
    +
    +
    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.3.3: The function now follows RFC 6125, section 6.4.3 and does neither +match multiple wildcards (e.g. *.*.com or *a*.example.org) nor +a wildcard inside an internationalized domain names (IDN) fragment. +IDN A-labels such as www*.xn--pthon-kva.org are still supported, +but x*.python.org no longer matches xn--tda.python.org.

    +
    +
    +

    Changed in version 3.5: Matching of IP addresses, when present in the subjectAltName field +of the certificate, is now supported.

    +
    +
    +

    Changed in version 3.7: The function is no longer used to TLS connections. Hostname matching +is now performed by OpenSSL.

    +

    Allow wildcard when it is the leftmost and the only character +in that segment. Partial wildcards like www*.example.com are no +longer supported.

    +
    +
    +

    Deprecated since version 3.7.

    +
    +
    + +
    +
    +ssl.cert_time_to_seconds(cert_time)
    +

    Return the time in seconds since the Epoch, given the cert_time +string representing the “notBefore” or “notAfter” date from a +certificate in "%b %d %H:%M:%S %Y %Z" strptime format (C +locale).

    +

    Here’s an example:

    +
    >>> import ssl
    +>>> timestamp = ssl.cert_time_to_seconds("Jan  5 09:34:43 2018 GMT")
    +>>> timestamp  
    +1515144883
    +>>> from datetime import datetime
    +>>> print(datetime.utcfromtimestamp(timestamp))  
    +2018-01-05 09:34:43
    +
    +
    +

    “notBefore” or “notAfter” dates must use GMT (RFC 5280).

    +
    +

    Changed in version 3.5: Interpret the input time as a time in UTC as specified by ‘GMT’ +timezone in the input string. Local timezone was used +previously. Return an integer (no fractions of a second in the +input format)

    +
    +
    + +
    +
    +ssl.get_server_certificate(addr, ssl_version=PROTOCOL_TLS, ca_certs=None)
    +

    Given the address addr of an SSL-protected server, as a (hostname, +port-number) pair, fetches the server’s certificate, and returns it as a +PEM-encoded string. If ssl_version is specified, uses that version of +the SSL protocol to attempt to connect to the server. If ca_certs is +specified, it should be a file containing a list of root certificates, the +same format as used for the same parameter in +SSLContext.wrap_socket(). The call will attempt to validate the +server certificate against that set of root certificates, and will fail +if the validation attempt fails.

    +
    +

    Changed in version 3.3: This function is now IPv6-compatible.

    +
    +
    +

    Changed in version 3.5: The default ssl_version is changed from PROTOCOL_SSLv3 to +PROTOCOL_TLS for maximum compatibility with modern servers.

    +
    +
    + +
    +
    +ssl.DER_cert_to_PEM_cert(DER_cert_bytes)
    +

    Given a certificate as a DER-encoded blob of bytes, returns a PEM-encoded +string version of the same certificate.

    +
    + +
    +
    +ssl.PEM_cert_to_DER_cert(PEM_cert_string)
    +

    Given a certificate as an ASCII PEM string, returns a DER-encoded sequence of +bytes for that same certificate.

    +
    + +
    +
    +ssl.get_default_verify_paths()
    +

    Returns a named tuple with paths to OpenSSL’s default cafile and capath. +The paths are the same as used by +SSLContext.set_default_verify_paths(). The return value is a +named tuple DefaultVerifyPaths:

    +
      +
    • cafile - resolved path to cafile or None if the file doesn’t exist,

    • +
    • capath - resolved path to capath or None if the directory doesn’t exist,

    • +
    • openssl_cafile_env - OpenSSL’s environment key that points to a cafile,

    • +
    • openssl_cafile - hard coded path to a cafile,

    • +
    • openssl_capath_env - OpenSSL’s environment key that points to a capath,

    • +
    • openssl_capath - hard coded path to a capath directory

    • +
    +

    Availability: LibreSSL ignores the environment vars +openssl_cafile_env and openssl_capath_env.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +ssl.enum_certificates(store_name)
    +

    Retrieve certificates from Windows’ system cert store. store_name may be +one of CA, ROOT or MY. Windows may provide additional cert +stores, too.

    +

    The function returns a list of (cert_bytes, encoding_type, trust) tuples. +The encoding_type specifies the encoding of cert_bytes. It is either +x509_asn for X.509 ASN.1 data or pkcs_7_asn for +PKCS#7 ASN.1 data. Trust specifies the purpose of the certificate as a set +of OIDS or exactly True if the certificate is trustworthy for all +purposes.

    +

    Example:

    +
    >>> ssl.enum_certificates("CA")
    +[(b'data...', 'x509_asn', {'1.3.6.1.5.5.7.3.1', '1.3.6.1.5.5.7.3.2'}),
    + (b'data...', 'x509_asn', True)]
    +
    +
    +

    Availability: Windows.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +ssl.enum_crls(store_name)
    +

    Retrieve CRLs from Windows’ system cert store. store_name may be +one of CA, ROOT or MY. Windows may provide additional cert +stores, too.

    +

    The function returns a list of (cert_bytes, encoding_type, trust) tuples. +The encoding_type specifies the encoding of cert_bytes. It is either +x509_asn for X.509 ASN.1 data or pkcs_7_asn for +PKCS#7 ASN.1 data.

    +

    Availability: Windows.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +ssl.wrap_socket(sock, keyfile=None, certfile=None, server_side=False, cert_reqs=CERT_NONE, ssl_version=PROTOCOL_TLS, ca_certs=None, do_handshake_on_connect=True, suppress_ragged_eofs=True, ciphers=None)
    +

    Takes an instance sock of socket.socket, and returns an instance +of ssl.SSLSocket, a subtype of socket.socket, which wraps +the underlying socket in an SSL context. sock must be a +SOCK_STREAM socket; other socket types are unsupported.

    +

    Internally, function creates a SSLContext with protocol +ssl_version and SSLContext.options set to cert_reqs. If +parameters keyfile, certfile, ca_certs or ciphers are set, then +the values are passed to SSLContext.load_cert_chain(), +SSLContext.load_verify_locations(), and +SSLContext.set_ciphers().

    +

    The arguments server_side, do_handshake_on_connect, and +suppress_ragged_eofs have the same meaning as +SSLContext.wrap_socket().

    +
    +

    Deprecated since version 3.7: Since Python 3.2 and 2.7.9, it is recommended to use the +SSLContext.wrap_socket() instead of wrap_socket(). The +top-level function is limited and creates an insecure client socket +without server name indication or hostname matching.

    +
    +
    + +
    +
    +

    Constants

    +
    +

    All constants are now enum.IntEnum or enum.IntFlag collections.

    +
    +

    New in version 3.6.

    +
    +
    +
    +
    +ssl.CERT_NONE
    +

    Possible value for SSLContext.verify_mode, or the cert_reqs +parameter to wrap_socket(). Except for PROTOCOL_TLS_CLIENT, +it is the default mode. With client-side sockets, just about any +cert is accepted. Validation errors, such as untrusted or expired cert, +are ignored and do not abort the TLS/SSL handshake.

    +

    In server mode, no certificate is requested from the client, so the client +does not send any for client cert authentication.

    +

    See the discussion of Security considerations below.

    +
    + +
    +
    +ssl.CERT_OPTIONAL
    +

    Possible value for SSLContext.verify_mode, or the cert_reqs +parameter to wrap_socket(). In client mode, CERT_OPTIONAL +has the same meaning as CERT_REQUIRED. It is recommended to +use CERT_REQUIRED for client-side sockets instead.

    +

    In server mode, a client certificate request is sent to the client. The +client may either ignore the request or send a certificate in order +perform TLS client cert authentication. If the client chooses to send +a certificate, it is verified. Any verification error immediately aborts +the TLS handshake.

    +

    Use of this setting requires a valid set of CA certificates to +be passed, either to SSLContext.load_verify_locations() or as a +value of the ca_certs parameter to wrap_socket().

    +
    + +
    +
    +ssl.CERT_REQUIRED
    +

    Possible value for SSLContext.verify_mode, or the cert_reqs +parameter to wrap_socket(). In this mode, certificates are +required from the other side of the socket connection; an SSLError +will be raised if no certificate is provided, or if its validation fails. +This mode is not sufficient to verify a certificate in client mode as +it does not match hostnames. check_hostname must be +enabled as well to verify the authenticity of a cert. +PROTOCOL_TLS_CLIENT uses CERT_REQUIRED and +enables check_hostname by default.

    +

    With server socket, this mode provides mandatory TLS client cert +authentication. A client certificate request is sent to the client and +the client must provide a valid and trusted certificate.

    +

    Use of this setting requires a valid set of CA certificates to +be passed, either to SSLContext.load_verify_locations() or as a +value of the ca_certs parameter to wrap_socket().

    +
    + +
    +
    +class ssl.VerifyMode
    +

    enum.IntEnum collection of CERT_* constants.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +ssl.VERIFY_DEFAULT
    +

    Possible value for SSLContext.verify_flags. In this mode, certificate +revocation lists (CRLs) are not checked. By default OpenSSL does neither +require nor verify CRLs.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +ssl.VERIFY_CRL_CHECK_LEAF
    +

    Possible value for SSLContext.verify_flags. In this mode, only the +peer cert is check but non of the intermediate CA certificates. The mode +requires a valid CRL that is signed by the peer cert’s issuer (its direct +ancestor CA). If no proper has been loaded +SSLContext.load_verify_locations, validation will fail.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +ssl.VERIFY_CRL_CHECK_CHAIN
    +

    Possible value for SSLContext.verify_flags. In this mode, CRLs of +all certificates in the peer cert chain are checked.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +ssl.VERIFY_X509_STRICT
    +

    Possible value for SSLContext.verify_flags to disable workarounds +for broken X.509 certificates.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +ssl.VERIFY_X509_TRUSTED_FIRST
    +

    Possible value for SSLContext.verify_flags. It instructs OpenSSL to +prefer trusted certificates when building the trust chain to validate a +certificate. This flag is enabled by default.

    +
    +

    New in version 3.4.4.

    +
    +
    + +
    +
    +class ssl.VerifyFlags
    +

    enum.IntFlag collection of VERIFY_* constants.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +ssl.PROTOCOL_TLS
    +

    Selects the highest protocol version that both the client and server support. +Despite the name, this option can select both “SSL” and “TLS” protocols.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +ssl.PROTOCOL_TLS_CLIENT
    +

    Auto-negotiate the highest protocol version like PROTOCOL_TLS, +but only support client-side SSLSocket connections. The protocol +enables CERT_REQUIRED and check_hostname by +default.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +ssl.PROTOCOL_TLS_SERVER
    +

    Auto-negotiate the highest protocol version like PROTOCOL_TLS, +but only support server-side SSLSocket connections.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +ssl.PROTOCOL_SSLv23
    +

    Alias for PROTOCOL_TLS.

    +
    +

    Deprecated since version 3.6: Use PROTOCOL_TLS instead.

    +
    +
    + +
    +
    +ssl.PROTOCOL_SSLv2
    +

    Selects SSL version 2 as the channel encryption protocol.

    +

    This protocol is not available if OpenSSL is compiled with the +OPENSSL_NO_SSL2 flag.

    +
    +

    Warning

    +

    SSL version 2 is insecure. Its use is highly discouraged.

    +
    +
    +

    Deprecated since version 3.6: OpenSSL has removed support for SSLv2.

    +
    +
    + +
    +
    +ssl.PROTOCOL_SSLv3
    +

    Selects SSL version 3 as the channel encryption protocol.

    +

    This protocol is not be available if OpenSSL is compiled with the +OPENSSL_NO_SSLv3 flag.

    +
    +

    Warning

    +

    SSL version 3 is insecure. Its use is highly discouraged.

    +
    +
    +

    Deprecated since version 3.6: OpenSSL has deprecated all version specific protocols. Use the default +protocol PROTOCOL_TLS with flags like OP_NO_SSLv3 instead.

    +
    +
    + +
    +
    +ssl.PROTOCOL_TLSv1
    +

    Selects TLS version 1.0 as the channel encryption protocol.

    +
    +

    Deprecated since version 3.6: OpenSSL has deprecated all version specific protocols. Use the default +protocol PROTOCOL_TLS with flags like OP_NO_SSLv3 instead.

    +
    +
    + +
    +
    +ssl.PROTOCOL_TLSv1_1
    +

    Selects TLS version 1.1 as the channel encryption protocol. +Available only with openssl version 1.0.1+.

    +
    +

    New in version 3.4.

    +
    +
    +

    Deprecated since version 3.6: OpenSSL has deprecated all version specific protocols. Use the default +protocol PROTOCOL_TLS with flags like OP_NO_SSLv3 instead.

    +
    +
    + +
    +
    +ssl.PROTOCOL_TLSv1_2
    +

    Selects TLS version 1.2 as the channel encryption protocol. This is the +most modern version, and probably the best choice for maximum protection, +if both sides can speak it. Available only with openssl version 1.0.1+.

    +
    +

    New in version 3.4.

    +
    +
    +

    Deprecated since version 3.6: OpenSSL has deprecated all version specific protocols. Use the default +protocol PROTOCOL_TLS with flags like OP_NO_SSLv3 instead.

    +
    +
    + +
    +
    +ssl.OP_ALL
    +

    Enables workarounds for various bugs present in other SSL implementations. +This option is set by default. It does not necessarily set the same +flags as OpenSSL’s SSL_OP_ALL constant.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +ssl.OP_NO_SSLv2
    +

    Prevents an SSLv2 connection. This option is only applicable in +conjunction with PROTOCOL_TLS. It prevents the peers from +choosing SSLv2 as the protocol version.

    +
    +

    New in version 3.2.

    +
    +
    +

    Deprecated since version 3.6: SSLv2 is deprecated

    +
    +
    + +
    +
    +ssl.OP_NO_SSLv3
    +

    Prevents an SSLv3 connection. This option is only applicable in +conjunction with PROTOCOL_TLS. It prevents the peers from +choosing SSLv3 as the protocol version.

    +
    +

    New in version 3.2.

    +
    +
    +

    Deprecated since version 3.6: SSLv3 is deprecated

    +
    +
    + +
    +
    +ssl.OP_NO_TLSv1
    +

    Prevents a TLSv1 connection. This option is only applicable in +conjunction with PROTOCOL_TLS. It prevents the peers from +choosing TLSv1 as the protocol version.

    +
    +

    New in version 3.2.

    +
    +
    +

    Deprecated since version 3.7: The option is deprecated since OpenSSL 1.1.0, use the new +SSLContext.minimum_version and +SSLContext.maximum_version instead.

    +
    +
    + +
    +
    +ssl.OP_NO_TLSv1_1
    +

    Prevents a TLSv1.1 connection. This option is only applicable in conjunction +with PROTOCOL_TLS. It prevents the peers from choosing TLSv1.1 as +the protocol version. Available only with openssl version 1.0.1+.

    +
    +

    New in version 3.4.

    +
    +
    +

    Deprecated since version 3.7: The option is deprecated since OpenSSL 1.1.0.

    +
    +
    + +
    +
    +ssl.OP_NO_TLSv1_2
    +

    Prevents a TLSv1.2 connection. This option is only applicable in conjunction +with PROTOCOL_TLS. It prevents the peers from choosing TLSv1.2 as +the protocol version. Available only with openssl version 1.0.1+.

    +
    +

    New in version 3.4.

    +
    +
    +

    Deprecated since version 3.7: The option is deprecated since OpenSSL 1.1.0.

    +
    +
    + +
    +
    +ssl.OP_NO_TLSv1_3
    +

    Prevents a TLSv1.3 connection. This option is only applicable in conjunction +with PROTOCOL_TLS. It prevents the peers from choosing TLSv1.3 as +the protocol version. TLS 1.3 is available with OpenSSL 1.1.1 or later. +When Python has been compiled against an older version of OpenSSL, the +flag defaults to 0.

    +
    +

    New in version 3.7.

    +
    +
    +

    Deprecated since version 3.7: The option is deprecated since OpenSSL 1.1.0. It was added to 2.7.15, +3.6.3 and 3.7.0 for backwards compatibility with OpenSSL 1.0.2.

    +
    +
    + +
    +
    +ssl.OP_NO_RENEGOTIATION
    +

    Disable all renegotiation in TLSv1.2 and earlier. Do not send +HelloRequest messages, and ignore renegotiation requests via ClientHello.

    +

    This option is only available with OpenSSL 1.1.0h and later.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +ssl.OP_CIPHER_SERVER_PREFERENCE
    +

    Use the server’s cipher ordering preference, rather than the client’s. +This option has no effect on client sockets and SSLv2 server sockets.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +ssl.OP_SINGLE_DH_USE
    +

    Prevents re-use of the same DH key for distinct SSL sessions. This +improves forward secrecy but requires more computational resources. +This option only applies to server sockets.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +ssl.OP_SINGLE_ECDH_USE
    +

    Prevents re-use of the same ECDH key for distinct SSL sessions. This +improves forward secrecy but requires more computational resources. +This option only applies to server sockets.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +ssl.OP_ENABLE_MIDDLEBOX_COMPAT
    +

    Send dummy Change Cipher Spec (CCS) messages in TLS 1.3 handshake to make +a TLS 1.3 connection look more like a TLS 1.2 connection.

    +

    This option is only available with OpenSSL 1.1.1 and later.

    +
    +

    New in version 3.8.

    +
    +
    + +
    +
    +ssl.OP_NO_COMPRESSION
    +

    Disable compression on the SSL channel. This is useful if the application +protocol supports its own compression scheme.

    +

    This option is only available with OpenSSL 1.0.0 and later.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +class ssl.Options
    +

    enum.IntFlag collection of OP_* constants.

    +
    + +
    +
    +ssl.OP_NO_TICKET
    +

    Prevent client side from requesting a session ticket.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +ssl.HAS_ALPN
    +

    Whether the OpenSSL library has built-in support for the Application-Layer +Protocol Negotiation TLS extension as described in RFC 7301.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +ssl.HAS_NEVER_CHECK_COMMON_NAME
    +

    Whether the OpenSSL library has built-in support not checking subject +common name and SSLContext.hostname_checks_common_name is +writeable.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +ssl.HAS_ECDH
    +

    Whether the OpenSSL library has built-in support for the Elliptic Curve-based +Diffie-Hellman key exchange. This should be true unless the feature was +explicitly disabled by the distributor.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +ssl.HAS_SNI
    +

    Whether the OpenSSL library has built-in support for the Server Name +Indication extension (as defined in RFC 6066).

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +ssl.HAS_NPN
    +

    Whether the OpenSSL library has built-in support for the Next Protocol +Negotiation as described in the Application Layer Protocol +Negotiation. +When true, you can use the SSLContext.set_npn_protocols() method to advertise +which protocols you want to support.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +ssl.HAS_SSLv2
    +

    Whether the OpenSSL library has built-in support for the SSL 2.0 protocol.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +ssl.HAS_SSLv3
    +

    Whether the OpenSSL library has built-in support for the SSL 3.0 protocol.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +ssl.HAS_TLSv1
    +

    Whether the OpenSSL library has built-in support for the TLS 1.0 protocol.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +ssl.HAS_TLSv1_1
    +

    Whether the OpenSSL library has built-in support for the TLS 1.1 protocol.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +ssl.HAS_TLSv1_2
    +

    Whether the OpenSSL library has built-in support for the TLS 1.2 protocol.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +ssl.HAS_TLSv1_3
    +

    Whether the OpenSSL library has built-in support for the TLS 1.3 protocol.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +ssl.CHANNEL_BINDING_TYPES
    +

    List of supported TLS channel binding types. Strings in this list +can be used as arguments to SSLSocket.get_channel_binding().

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +ssl.OPENSSL_VERSION
    +

    The version string of the OpenSSL library loaded by the interpreter:

    +
    >>> ssl.OPENSSL_VERSION
    +'OpenSSL 1.0.2k  26 Jan 2017'
    +
    +
    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +ssl.OPENSSL_VERSION_INFO
    +

    A tuple of five integers representing version information about the +OpenSSL library:

    +
    >>> ssl.OPENSSL_VERSION_INFO
    +(1, 0, 2, 11, 15)
    +
    +
    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +ssl.OPENSSL_VERSION_NUMBER
    +

    The raw version number of the OpenSSL library, as a single integer:

    +
    >>> ssl.OPENSSL_VERSION_NUMBER
    +268443839
    +>>> hex(ssl.OPENSSL_VERSION_NUMBER)
    +'0x100020bf'
    +
    +
    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +ssl.ALERT_DESCRIPTION_HANDSHAKE_FAILURE
    +
    +ssl.ALERT_DESCRIPTION_INTERNAL_ERROR
    +
    +ALERT_DESCRIPTION_*
    +

    Alert Descriptions from RFC 5246 and others. The IANA TLS Alert Registry +contains this list and references to the RFCs where their meaning is defined.

    +

    Used as the return value of the callback function in +SSLContext.set_servername_callback().

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +class ssl.AlertDescription
    +

    enum.IntEnum collection of ALERT_DESCRIPTION_* constants.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +Purpose.SERVER_AUTH
    +

    Option for create_default_context() and +SSLContext.load_default_certs(). This value indicates that the +context may be used to authenticate Web servers (therefore, it will +be used to create client-side sockets).

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +Purpose.CLIENT_AUTH
    +

    Option for create_default_context() and +SSLContext.load_default_certs(). This value indicates that the +context may be used to authenticate Web clients (therefore, it will +be used to create server-side sockets).

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +class ssl.SSLErrorNumber
    +

    enum.IntEnum collection of SSL_ERROR_* constants.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +class ssl.TLSVersion
    +

    enum.IntEnum collection of SSL and TLS versions for +SSLContext.maximum_version and SSLContext.minimum_version.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +TLSVersion.MINIMUM_SUPPORTED
    +
    + +
    +
    +TLSVersion.MAXIMUM_SUPPORTED
    +

    The minimum or maximum supported SSL or TLS version. These are magic +constants. Their values don’t reflect the lowest and highest available +TLS/SSL versions.

    +
    + +
    +
    +TLSVersion.SSLv3
    +
    + +
    +
    +TLSVersion.TLSv1
    +
    + +
    +
    +TLSVersion.TLSv1_1
    +
    + +
    +
    +TLSVersion.TLSv1_2
    +
    + +
    +
    +TLSVersion.TLSv1_3
    +

    SSL 3.0 to TLS 1.3.

    +
    + +
    +
    +
    +

    SSL Sockets

    +
    +
    +class ssl.SSLSocket(socket.socket)
    +

    SSL sockets provide the following methods of Socket Objects:

    + +

    However, since the SSL (and TLS) protocol has its own framing atop +of TCP, the SSL sockets abstraction can, in certain respects, diverge from +the specification of normal, OS-level sockets. See especially the +notes on non-blocking sockets.

    +

    Instances of SSLSocket must be created using the +SSLContext.wrap_socket() method.

    +
    +

    Changed in version 3.5: The sendfile() method was added.

    +
    +
    +

    Changed in version 3.5: The shutdown() does not reset the socket timeout each time bytes +are received or sent. The socket timeout is now to maximum total duration +of the shutdown.

    +
    +
    +

    Deprecated since version 3.6: It is deprecated to create a SSLSocket instance directly, use +SSLContext.wrap_socket() to wrap a socket.

    +
    +
    +

    Changed in version 3.7: SSLSocket instances must to created with +wrap_socket(). In earlier versions, it was possible +to create instances directly. This was never documented or officially +supported.

    +
    +
    + +

    SSL sockets also have the following additional methods and attributes:

    +
    +
    +SSLSocket.read(len=1024, buffer=None)
    +

    Read up to len bytes of data from the SSL socket and return the result as +a bytes instance. If buffer is specified, then read into the buffer +instead, and return the number of bytes read.

    +

    Raise SSLWantReadError or SSLWantWriteError if the socket is +non-blocking and the read would block.

    +

    As at any time a re-negotiation is possible, a call to read() can also +cause write operations.

    +
    +

    Changed in version 3.5: The socket timeout is no more reset each time bytes are received or sent. +The socket timeout is now to maximum total duration to read up to len +bytes.

    +
    +
    +

    Deprecated since version 3.6: Use recv() instead of read().

    +
    +
    + +
    +
    +SSLSocket.write(buf)
    +

    Write buf to the SSL socket and return the number of bytes written. The +buf argument must be an object supporting the buffer interface.

    +

    Raise SSLWantReadError or SSLWantWriteError if the socket is +non-blocking and the write would block.

    +

    As at any time a re-negotiation is possible, a call to write() can +also cause read operations.

    +
    +

    Changed in version 3.5: The socket timeout is no more reset each time bytes are received or sent. +The socket timeout is now to maximum total duration to write buf.

    +
    +
    +

    Deprecated since version 3.6: Use send() instead of write().

    +
    +
    + +
    +

    Note

    +

    The read() and write() methods are the +low-level methods that read and write unencrypted, application-level data +and decrypt/encrypt it to encrypted, wire-level data. These methods +require an active SSL connection, i.e. the handshake was completed and +SSLSocket.unwrap() was not called.

    +

    Normally you should use the socket API methods like +recv() and send() instead of these +methods.

    +
    +
    +
    +SSLSocket.do_handshake()
    +

    Perform the SSL setup handshake.

    +
    +

    Changed in version 3.4: The handshake method also performs match_hostname() when the +check_hostname attribute of the socket’s +context is true.

    +
    +
    +

    Changed in version 3.5: The socket timeout is no more reset each time bytes are received or sent. +The socket timeout is now to maximum total duration of the handshake.

    +
    +
    +

    Changed in version 3.7: Hostname or IP address is matched by OpenSSL during handshake. The +function match_hostname() is no longer used. In case OpenSSL +refuses a hostname or IP address, the handshake is aborted early and +a TLS alert message is send to the peer.

    +
    +
    + +
    +
    +SSLSocket.getpeercert(binary_form=False)
    +

    If there is no certificate for the peer on the other end of the connection, +return None. If the SSL handshake hasn’t been done yet, raise +ValueError.

    +

    If the binary_form parameter is False, and a certificate was +received from the peer, this method returns a dict instance. If the +certificate was not validated, the dict is empty. If the certificate was +validated, it returns a dict with several keys, amongst them subject +(the principal for which the certificate was issued) and issuer +(the principal issuing the certificate). If a certificate contains an +instance of the Subject Alternative Name extension (see RFC 3280), +there will also be a subjectAltName key in the dictionary.

    +

    The subject and issuer fields are tuples containing the sequence +of relative distinguished names (RDNs) given in the certificate’s data +structure for the respective fields, and each RDN is a sequence of +name-value pairs. Here is a real-world example:

    +
    {'issuer': ((('countryName', 'IL'),),
    +            (('organizationName', 'StartCom Ltd.'),),
    +            (('organizationalUnitName',
    +              'Secure Digital Certificate Signing'),),
    +            (('commonName',
    +              'StartCom Class 2 Primary Intermediate Server CA'),)),
    + 'notAfter': 'Nov 22 08:15:19 2013 GMT',
    + 'notBefore': 'Nov 21 03:09:52 2011 GMT',
    + 'serialNumber': '95F0',
    + 'subject': ((('description', '571208-SLe257oHY9fVQ07Z'),),
    +             (('countryName', 'US'),),
    +             (('stateOrProvinceName', 'California'),),
    +             (('localityName', 'San Francisco'),),
    +             (('organizationName', 'Electronic Frontier Foundation, Inc.'),),
    +             (('commonName', '*.eff.org'),),
    +             (('emailAddress', 'hostmaster@eff.org'),)),
    + 'subjectAltName': (('DNS', '*.eff.org'), ('DNS', 'eff.org')),
    + 'version': 3}
    +
    +
    +
    +

    Note

    +

    To validate a certificate for a particular service, you can use the +match_hostname() function.

    +
    +

    If the binary_form parameter is True, and a certificate was +provided, this method returns the DER-encoded form of the entire certificate +as a sequence of bytes, or None if the peer did not provide a +certificate. Whether the peer provides a certificate depends on the SSL +socket’s role:

    +
      +
    • for a client SSL socket, the server will always provide a certificate, +regardless of whether validation was required;

    • +
    • for a server SSL socket, the client will only provide a certificate +when requested by the server; therefore getpeercert() will return +None if you used CERT_NONE (rather than +CERT_OPTIONAL or CERT_REQUIRED).

    • +
    +
    +

    Changed in version 3.2: The returned dictionary includes additional items such as issuer +and notBefore.

    +
    +
    +

    Changed in version 3.4: ValueError is raised when the handshake isn’t done. +The returned dictionary includes additional X509v3 extension items + such as crlDistributionPoints, caIssuers and OCSP URIs.

    +
    +
    + +
    +
    +SSLSocket.cipher()
    +

    Returns a three-value tuple containing the name of the cipher being used, the +version of the SSL protocol that defines its use, and the number of secret +bits being used. If no connection has been established, returns None.

    +
    + +
    +
    +SSLSocket.shared_ciphers()
    +

    Return the list of ciphers shared by the client during the handshake. Each +entry of the returned list is a three-value tuple containing the name of the +cipher, the version of the SSL protocol that defines its use, and the number +of secret bits the cipher uses. shared_ciphers() returns +None if no connection has been established or the socket is a client +socket.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +SSLSocket.compression()
    +

    Return the compression algorithm being used as a string, or None +if the connection isn’t compressed.

    +

    If the higher-level protocol supports its own compression mechanism, +you can use OP_NO_COMPRESSION to disable SSL-level compression.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +SSLSocket.get_channel_binding(cb_type="tls-unique")
    +

    Get channel binding data for current connection, as a bytes object. Returns +None if not connected or the handshake has not been completed.

    +

    The cb_type parameter allow selection of the desired channel binding +type. Valid channel binding types are listed in the +CHANNEL_BINDING_TYPES list. Currently only the ‘tls-unique’ channel +binding, defined by RFC 5929, is supported. ValueError will be +raised if an unsupported channel binding type is requested.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +SSLSocket.selected_alpn_protocol()
    +

    Return the protocol that was selected during the TLS handshake. If +SSLContext.set_alpn_protocols() was not called, if the other party does +not support ALPN, if this socket does not support any of the client’s +proposed protocols, or if the handshake has not happened yet, None is +returned.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +SSLSocket.selected_npn_protocol()
    +

    Return the higher-level protocol that was selected during the TLS/SSL +handshake. If SSLContext.set_npn_protocols() was not called, or +if the other party does not support NPN, or if the handshake has not yet +happened, this will return None.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +SSLSocket.unwrap()
    +

    Performs the SSL shutdown handshake, which removes the TLS layer from the +underlying socket, and returns the underlying socket object. This can be +used to go from encrypted operation over a connection to unencrypted. The +returned socket should always be used for further communication with the +other side of the connection, rather than the original socket.

    +
    + +
    +
    +SSLSocket.verify_client_post_handshake()
    +

    Requests post-handshake authentication (PHA) from a TLS 1.3 client. PHA +can only be initiated for a TLS 1.3 connection from a server-side socket, +after the initial TLS handshake and with PHA enabled on both sides, see +SSLContext.post_handshake_auth.

    +

    The method does not perform a cert exchange immediately. The server-side +sends a CertificateRequest during the next write event and expects the +client to respond with a certificate on the next read event.

    +

    If any precondition isn’t met (e.g. not TLS 1.3, PHA not enabled), an +SSLError is raised.

    +
    +

    Note

    +

    Only available with OpenSSL 1.1.1 and TLS 1.3 enabled. Without TLS 1.3 +support, the method raises NotImplementedError.

    +
    +
    +

    New in version 3.7.1.

    +
    +
    + +
    +
    +SSLSocket.version()
    +

    Return the actual SSL protocol version negotiated by the connection +as a string, or None is no secure connection is established. +As of this writing, possible return values include "SSLv2", +"SSLv3", "TLSv1", "TLSv1.1" and "TLSv1.2". +Recent OpenSSL versions may define more return values.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +SSLSocket.pending()
    +

    Returns the number of already decrypted bytes available for read, pending on +the connection.

    +
    + +
    +
    +SSLSocket.context
    +

    The SSLContext object this SSL socket is tied to. If the SSL +socket was created using the deprecated wrap_socket() function +(rather than SSLContext.wrap_socket()), this is a custom context +object created for this SSL socket.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +SSLSocket.server_side
    +

    A boolean which is True for server-side sockets and False for +client-side sockets.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +SSLSocket.server_hostname
    +

    Hostname of the server: str type, or None for server-side +socket or if the hostname was not specified in the constructor.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.7: The attribute is now always ASCII text. When server_hostname is +an internationalized domain name (IDN), this attribute now stores the +A-label form ("xn--pythn-mua.org"), rather than the U-label form +("pythön.org").

    +
    +
    + +
    +
    +SSLSocket.session
    +

    The SSLSession for this SSL connection. The session is available +for client and server side sockets after the TLS handshake has been +performed. For client sockets the session can be set before +do_handshake() has been called to reuse a session.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +SSLSocket.session_reused
    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +

    SSL Contexts

    +
    +

    New in version 3.2.

    +
    +

    An SSL context holds various data longer-lived than single SSL connections, +such as SSL configuration options, certificate(s) and private key(s). +It also manages a cache of SSL sessions for server-side sockets, in order +to speed up repeated connections from the same clients.

    +
    +
    +class ssl.SSLContext(protocol=PROTOCOL_TLS)
    +

    Create a new SSL context. You may pass protocol which must be one +of the PROTOCOL_* constants defined in this module. The parameter +specifies which version of the SSL protocol to use. Typically, the +server chooses a particular protocol version, and the client must adapt +to the server’s choice. Most of the versions are not interoperable +with the other versions. If not specified, the default is +PROTOCOL_TLS; it provides the most compatibility with other +versions.

    +

    Here’s a table showing which versions in a client (down the side) can connect +to which versions in a server (along the top):

    +
    +
    +++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    client / server

    SSLv2

    SSLv3

    TLS 3

    TLSv1

    TLSv1.1

    TLSv1.2

    SSLv2

    yes

    no

    no 1

    no

    no

    no

    SSLv3

    no

    yes

    no 2

    no

    no

    no

    TLS (SSLv23) 3

    no 1

    no 2

    yes

    yes

    yes

    yes

    TLSv1

    no

    no

    yes

    yes

    no

    no

    TLSv1.1

    no

    no

    yes

    no

    yes

    no

    TLSv1.2

    no

    no

    yes

    no

    no

    yes

    +
    +

    Footnotes

    +
    +
    1(1,2)
    +

    SSLContext disables SSLv2 with OP_NO_SSLv2 by default.

    +
    +
    2(1,2)
    +

    SSLContext disables SSLv3 with OP_NO_SSLv3 by default.

    +
    +
    3(1,2)
    +

    TLS 1.3 protocol will be available with PROTOCOL_TLS in +OpenSSL >= 1.1.1. There is no dedicated PROTOCOL constant for just +TLS 1.3.

    +
    +
    +
    +

    See also

    +

    create_default_context() lets the ssl module choose +security settings for a given purpose.

    +
    +
    +

    Changed in version 3.6: The context is created with secure default values. The options +OP_NO_COMPRESSION, OP_CIPHER_SERVER_PREFERENCE, +OP_SINGLE_DH_USE, OP_SINGLE_ECDH_USE, +OP_NO_SSLv2 (except for PROTOCOL_SSLv2), +and OP_NO_SSLv3 (except for PROTOCOL_SSLv3) are +set by default. The initial cipher suite list contains only HIGH +ciphers, no NULL ciphers and no MD5 ciphers (except for +PROTOCOL_SSLv2).

    +
    +
    + +

    SSLContext objects have the following methods and attributes:

    +
    +
    +SSLContext.cert_store_stats()
    +

    Get statistics about quantities of loaded X.509 certificates, count of +X.509 certificates flagged as CA certificates and certificate revocation +lists as dictionary.

    +

    Example for a context with one CA cert and one other cert:

    +
    >>> context.cert_store_stats()
    +{'crl': 0, 'x509_ca': 1, 'x509': 2}
    +
    +
    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +SSLContext.load_cert_chain(certfile, keyfile=None, password=None)
    +

    Load a private key and the corresponding certificate. The certfile +string must be the path to a single file in PEM format containing the +certificate as well as any number of CA certificates needed to establish +the certificate’s authenticity. The keyfile string, if present, must +point to a file containing the private key in. Otherwise the private +key will be taken from certfile as well. See the discussion of +Certificates for more information on how the certificate +is stored in the certfile.

    +

    The password argument may be a function to call to get the password for +decrypting the private key. It will only be called if the private key is +encrypted and a password is necessary. It will be called with no arguments, +and it should return a string, bytes, or bytearray. If the return value is +a string it will be encoded as UTF-8 before using it to decrypt the key. +Alternatively a string, bytes, or bytearray value may be supplied directly +as the password argument. It will be ignored if the private key is not +encrypted and no password is needed.

    +

    If the password argument is not specified and a password is required, +OpenSSL’s built-in password prompting mechanism will be used to +interactively prompt the user for a password.

    +

    An SSLError is raised if the private key doesn’t +match with the certificate.

    +
    +

    Changed in version 3.3: New optional argument password.

    +
    +
    + +
    +
    +SSLContext.load_default_certs(purpose=Purpose.SERVER_AUTH)
    +

    Load a set of default “certification authority” (CA) certificates from +default locations. On Windows it loads CA certs from the CA and +ROOT system stores. On other systems it calls +SSLContext.set_default_verify_paths(). In the future the method may +load CA certificates from other locations, too.

    +

    The purpose flag specifies what kind of CA certificates are loaded. The +default settings Purpose.SERVER_AUTH loads certificates, that are +flagged and trusted for TLS web server authentication (client side +sockets). Purpose.CLIENT_AUTH loads CA certificates for client +certificate verification on the server side.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +SSLContext.load_verify_locations(cafile=None, capath=None, cadata=None)
    +

    Load a set of “certification authority” (CA) certificates used to validate +other peers’ certificates when verify_mode is other than +CERT_NONE. At least one of cafile or capath must be specified.

    +

    This method can also load certification revocation lists (CRLs) in PEM or +DER format. In order to make use of CRLs, SSLContext.verify_flags +must be configured properly.

    +

    The cafile string, if present, is the path to a file of concatenated +CA certificates in PEM format. See the discussion of +Certificates for more information about how to arrange the +certificates in this file.

    +

    The capath string, if present, is +the path to a directory containing several CA certificates in PEM format, +following an OpenSSL specific layout.

    +

    The cadata object, if present, is either an ASCII string of one or more +PEM-encoded certificates or a bytes-like object of DER-encoded +certificates. Like with capath extra lines around PEM-encoded +certificates are ignored but at least one certificate must be present.

    +
    +

    Changed in version 3.4: New optional argument cadata

    +
    +
    + +
    +
    +SSLContext.get_ca_certs(binary_form=False)
    +

    Get a list of loaded “certification authority” (CA) certificates. If the +binary_form parameter is False each list +entry is a dict like the output of SSLSocket.getpeercert(). Otherwise +the method returns a list of DER-encoded certificates. The returned list +does not contain certificates from capath unless a certificate was +requested and loaded by a SSL connection.

    +
    +

    Note

    +

    Certificates in a capath directory aren’t loaded unless they have +been used at least once.

    +
    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +SSLContext.get_ciphers()
    +

    Get a list of enabled ciphers. The list is in order of cipher priority. +See SSLContext.set_ciphers().

    +

    Example:

    +
    >>> ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
    +>>> ctx.set_ciphers('ECDHE+AESGCM:!ECDSA')
    +>>> ctx.get_ciphers()  # OpenSSL 1.0.x
    +[{'alg_bits': 256,
    +  'description': 'ECDHE-RSA-AES256-GCM-SHA384 TLSv1.2 Kx=ECDH     Au=RSA  '
    +                 'Enc=AESGCM(256) Mac=AEAD',
    +  'id': 50380848,
    +  'name': 'ECDHE-RSA-AES256-GCM-SHA384',
    +  'protocol': 'TLSv1/SSLv3',
    +  'strength_bits': 256},
    + {'alg_bits': 128,
    +  'description': 'ECDHE-RSA-AES128-GCM-SHA256 TLSv1.2 Kx=ECDH     Au=RSA  '
    +                 'Enc=AESGCM(128) Mac=AEAD',
    +  'id': 50380847,
    +  'name': 'ECDHE-RSA-AES128-GCM-SHA256',
    +  'protocol': 'TLSv1/SSLv3',
    +  'strength_bits': 128}]
    +
    +
    +

    On OpenSSL 1.1 and newer the cipher dict contains additional fields:

    +
    >>> ctx.get_ciphers()  # OpenSSL 1.1+
    +[{'aead': True,
    +  'alg_bits': 256,
    +  'auth': 'auth-rsa',
    +  'description': 'ECDHE-RSA-AES256-GCM-SHA384 TLSv1.2 Kx=ECDH     Au=RSA  '
    +                 'Enc=AESGCM(256) Mac=AEAD',
    +  'digest': None,
    +  'id': 50380848,
    +  'kea': 'kx-ecdhe',
    +  'name': 'ECDHE-RSA-AES256-GCM-SHA384',
    +  'protocol': 'TLSv1.2',
    +  'strength_bits': 256,
    +  'symmetric': 'aes-256-gcm'},
    + {'aead': True,
    +  'alg_bits': 128,
    +  'auth': 'auth-rsa',
    +  'description': 'ECDHE-RSA-AES128-GCM-SHA256 TLSv1.2 Kx=ECDH     Au=RSA  '
    +                 'Enc=AESGCM(128) Mac=AEAD',
    +  'digest': None,
    +  'id': 50380847,
    +  'kea': 'kx-ecdhe',
    +  'name': 'ECDHE-RSA-AES128-GCM-SHA256',
    +  'protocol': 'TLSv1.2',
    +  'strength_bits': 128,
    +  'symmetric': 'aes-128-gcm'}]
    +
    +
    +

    Availability: OpenSSL 1.0.2+.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +SSLContext.set_default_verify_paths()
    +

    Load a set of default “certification authority” (CA) certificates from +a filesystem path defined when building the OpenSSL library. Unfortunately, +there’s no easy way to know whether this method succeeds: no error is +returned if no certificates are to be found. When the OpenSSL library is +provided as part of the operating system, though, it is likely to be +configured properly.

    +
    + +
    +
    +SSLContext.set_ciphers(ciphers)
    +

    Set the available ciphers for sockets created with this context. +It should be a string in the OpenSSL cipher list format. +If no cipher can be selected (because compile-time options or other +configuration forbids use of all the specified ciphers), an +SSLError will be raised.

    +
    +

    Note

    +

    when connected, the SSLSocket.cipher() method of SSL sockets will +give the currently selected cipher.

    +

    OpenSSL 1.1.1 has TLS 1.3 cipher suites enabled by default. The suites +cannot be disabled with set_ciphers().

    +
    +
    + +
    +
    +SSLContext.set_alpn_protocols(protocols)
    +

    Specify which protocols the socket should advertise during the SSL/TLS +handshake. It should be a list of ASCII strings, like ['http/1.1', +'spdy/2'], ordered by preference. The selection of a protocol will happen +during the handshake, and will play out according to RFC 7301. After a +successful handshake, the SSLSocket.selected_alpn_protocol() method will +return the agreed-upon protocol.

    +

    This method will raise NotImplementedError if HAS_ALPN is +False.

    +

    OpenSSL 1.1.0 to 1.1.0e will abort the handshake and raise SSLError +when both sides support ALPN but cannot agree on a protocol. 1.1.0f+ +behaves like 1.0.2, SSLSocket.selected_alpn_protocol() returns None.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +SSLContext.set_npn_protocols(protocols)
    +

    Specify which protocols the socket should advertise during the SSL/TLS +handshake. It should be a list of strings, like ['http/1.1', 'spdy/2'], +ordered by preference. The selection of a protocol will happen during the +handshake, and will play out according to the Application Layer Protocol Negotiation. After a +successful handshake, the SSLSocket.selected_npn_protocol() method will +return the agreed-upon protocol.

    +

    This method will raise NotImplementedError if HAS_NPN is +False.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +SSLContext.sni_callback
    +

    Register a callback function that will be called after the TLS Client Hello +handshake message has been received by the SSL/TLS server when the TLS client +specifies a server name indication. The server name indication mechanism +is specified in RFC 6066 section 3 - Server Name Indication.

    +

    Only one callback can be set per SSLContext. If sni_callback +is set to None then the callback is disabled. Calling this function a +subsequent time will disable the previously registered callback.

    +

    The callback function will be called with three +arguments; the first being the ssl.SSLSocket, the second is a string +that represents the server name that the client is intending to communicate +(or None if the TLS Client Hello does not contain a server name) +and the third argument is the original SSLContext. The server name +argument is text. For internationalized domain name, the server +name is an IDN A-label ("xn--pythn-mua.org").

    +

    A typical use of this callback is to change the ssl.SSLSocket’s +SSLSocket.context attribute to a new object of type +SSLContext representing a certificate chain that matches the server +name.

    +

    Due to the early negotiation phase of the TLS connection, only limited +methods and attributes are usable like +SSLSocket.selected_alpn_protocol() and SSLSocket.context. +SSLSocket.getpeercert(), SSLSocket.getpeercert(), +SSLSocket.cipher() and SSLSocket.compress() methods require that +the TLS connection has progressed beyond the TLS Client Hello and therefore +will not contain return meaningful values nor can they be called safely.

    +

    The sni_callback function must return None to allow the +TLS negotiation to continue. If a TLS failure is required, a constant +ALERT_DESCRIPTION_* can be +returned. Other return values will result in a TLS fatal error with +ALERT_DESCRIPTION_INTERNAL_ERROR.

    +

    If an exception is raised from the sni_callback function the TLS +connection will terminate with a fatal TLS alert message +ALERT_DESCRIPTION_HANDSHAKE_FAILURE.

    +

    This method will raise NotImplementedError if the OpenSSL library +had OPENSSL_NO_TLSEXT defined when it was built.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +SSLContext.set_servername_callback(server_name_callback)
    +

    This is a legacy API retained for backwards compatibility. When possible, +you should use sni_callback instead. The given server_name_callback +is similar to sni_callback, except that when the server hostname is an +IDN-encoded internationalized domain name, the server_name_callback +receives a decoded U-label ("pythön.org").

    +

    If there is an decoding error on the server name, the TLS connection will +terminate with an ALERT_DESCRIPTION_INTERNAL_ERROR fatal TLS +alert message to the client.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +SSLContext.load_dh_params(dhfile)
    +

    Load the key generation parameters for Diffie-Hellman (DH) key exchange. +Using DH key exchange improves forward secrecy at the expense of +computational resources (both on the server and on the client). +The dhfile parameter should be the path to a file containing DH +parameters in PEM format.

    +

    This setting doesn’t apply to client sockets. You can also use the +OP_SINGLE_DH_USE option to further improve security.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +SSLContext.set_ecdh_curve(curve_name)
    +

    Set the curve name for Elliptic Curve-based Diffie-Hellman (ECDH) key +exchange. ECDH is significantly faster than regular DH while arguably +as secure. The curve_name parameter should be a string describing +a well-known elliptic curve, for example prime256v1 for a widely +supported curve.

    +

    This setting doesn’t apply to client sockets. You can also use the +OP_SINGLE_ECDH_USE option to further improve security.

    +

    This method is not available if HAS_ECDH is False.

    +
    +

    New in version 3.3.

    +
    +
    +

    See also

    +
    +
    SSL/TLS & Perfect Forward Secrecy

    Vincent Bernat.

    +
    +
    +
    +
    + +
    +
    +SSLContext.wrap_socket(sock, server_side=False, do_handshake_on_connect=True, suppress_ragged_eofs=True, server_hostname=None, session=None)
    +

    Wrap an existing Python socket sock and return an instance of +SSLContext.sslsocket_class (default SSLSocket). The +returned SSL socket is tied to the context, its settings and certificates. +sock must be a SOCK_STREAM socket; other +socket types are unsupported.

    +

    The parameter server_side is a boolean which identifies whether +server-side or client-side behavior is desired from this socket.

    +

    For client-side sockets, the context construction is lazy; if the +underlying socket isn’t connected yet, the context construction will be +performed after connect() is called on the socket. For +server-side sockets, if the socket has no remote peer, it is assumed +to be a listening socket, and the server-side SSL wrapping is +automatically performed on client connections accepted via the +accept() method. The method may raise SSLError.

    +

    On client connections, the optional parameter server_hostname specifies +the hostname of the service which we are connecting to. This allows a +single server to host multiple SSL-based services with distinct certificates, +quite similarly to HTTP virtual hosts. Specifying server_hostname will +raise a ValueError if server_side is true.

    +

    The parameter do_handshake_on_connect specifies whether to do the SSL +handshake automatically after doing a socket.connect(), or whether the +application program will call it explicitly, by invoking the +SSLSocket.do_handshake() method. Calling +SSLSocket.do_handshake() explicitly gives the program control over the +blocking behavior of the socket I/O involved in the handshake.

    +

    The parameter suppress_ragged_eofs specifies how the +SSLSocket.recv() method should signal unexpected EOF from the other end +of the connection. If specified as True (the default), it returns a +normal EOF (an empty bytes object) in response to unexpected EOF errors +raised from the underlying socket; if False, it will raise the +exceptions back to the caller.

    +

    session, see session.

    +
    +

    Changed in version 3.5: Always allow a server_hostname to be passed, even if OpenSSL does not +have SNI.

    +
    +
    +

    Changed in version 3.6: session argument was added.

    +
    +

    Changed in version 3.7: The method returns on instance of SSLContext.sslsocket_class +instead of hard-coded SSLSocket.

    +
    +
    +
    + +
    +
    +SSLContext.sslsocket_class
    +

    The return type of SSLContext.wrap_socket(), defaults to +SSLSocket. The attribute can be overridden on instance of class +in order to return a custom subclass of SSLSocket.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +SSLContext.wrap_bio(incoming, outgoing, server_side=False, server_hostname=None, session=None)
    +

    Wrap the BIO objects incoming and outgoing and return an instance of +SSLContext.sslobject_class (default SSLObject). The SSL +routines will read input data from the incoming BIO and write data to the +outgoing BIO.

    +

    The server_side, server_hostname and session parameters have the +same meaning as in SSLContext.wrap_socket().

    +
    +

    Changed in version 3.6: session argument was added.

    +
    +
    +

    Changed in version 3.7: The method returns on instance of SSLContext.sslobject_class +instead of hard-coded SSLObject.

    +
    +
    + +
    +
    +SSLContext.sslobject_class
    +

    The return type of SSLContext.wrap_bio(), defaults to +SSLObject. The attribute can be overridden on instance of class +in order to return a custom subclass of SSLObject.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +SSLContext.session_stats()
    +

    Get statistics about the SSL sessions created or managed by this context. +A dictionary is returned which maps the names of each piece of information to their +numeric values. For example, here is the total number of hits and misses +in the session cache since the context was created:

    +
    >>> stats = context.session_stats()
    +>>> stats['hits'], stats['misses']
    +(0, 0)
    +
    +
    +
    + +
    +
    +SSLContext.check_hostname
    +

    Whether to match the peer cert’s hostname with match_hostname() in +SSLSocket.do_handshake(). The context’s +verify_mode must be set to CERT_OPTIONAL or +CERT_REQUIRED, and you must pass server_hostname to +wrap_socket() in order to match the hostname. Enabling +hostname checking automatically sets verify_mode from +CERT_NONE to CERT_REQUIRED. It cannot be set back to +CERT_NONE as long as hostname checking is enabled.

    +

    Example:

    +
    import socket, ssl
    +
    +context = ssl.SSLContext()
    +context.verify_mode = ssl.CERT_REQUIRED
    +context.check_hostname = True
    +context.load_default_certs()
    +
    +s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
    +ssl_sock = context.wrap_socket(s, server_hostname='www.verisign.com')
    +ssl_sock.connect(('www.verisign.com', 443))
    +
    +
    +
    +

    New in version 3.4.

    +
    +
    +

    Changed in version 3.7: verify_mode is now automatically changed +to CERT_REQUIRED when hostname checking is enabled and +verify_mode is CERT_NONE. Previously +the same operation would have failed with a ValueError.

    +
    +
    +

    Note

    +

    This features requires OpenSSL 0.9.8f or newer.

    +
    +
    + +
    +
    +SSLContext.maximum_version
    +

    A TLSVersion enum member representing the highest supported +TLS version. The value defaults to TLSVersion.MAXIMUM_SUPPORTED. +The attribute is read-only for protocols other than PROTOCOL_TLS, +PROTOCOL_TLS_CLIENT, and PROTOCOL_TLS_SERVER.

    +

    The attributes maximum_version, +minimum_version and +SSLContext.options all affect the supported SSL +and TLS versions of the context. The implementation does not prevent +invalid combination. For example a context with +OP_NO_TLSv1_2 in options and +maximum_version set to TLSVersion.TLSv1_2 +will not be able to establish a TLS 1.2 connection.

    +
    +

    Note

    +

    This attribute is not available unless the ssl module is compiled +with OpenSSL 1.1.0g or newer.

    +
    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +SSLContext.minimum_version
    +

    Like SSLContext.maximum_version except it is the lowest +supported version or TLSVersion.MINIMUM_SUPPORTED.

    +
    +

    Note

    +

    This attribute is not available unless the ssl module is compiled +with OpenSSL 1.1.0g or newer.

    +
    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +SSLContext.options
    +

    An integer representing the set of SSL options enabled on this context. +The default value is OP_ALL, but you can specify other options +such as OP_NO_SSLv2 by ORing them together.

    +
    +

    Note

    +

    With versions of OpenSSL older than 0.9.8m, it is only possible +to set options, not to clear them. Attempting to clear an option +(by resetting the corresponding bits) will raise a ValueError.

    +
    +
    +

    Changed in version 3.6: SSLContext.options returns Options flags:

    +
    >>> ssl.create_default_context().options  # doctest: +SKIP
    +<Options.OP_ALL|OP_NO_SSLv3|OP_NO_SSLv2|OP_NO_COMPRESSION: 2197947391>
    +
    +
    +
    +
    + +
    +
    +SSLContext.post_handshake_auth
    +

    Enable TLS 1.3 post-handshake client authentication. Post-handshake auth +is disabled by default and a server can only request a TLS client +certificate during the initial handshake. When enabled, a server may +request a TLS client certificate at any time after the handshake.

    +

    When enabled on client-side sockets, the client signals the server that +it supports post-handshake authentication.

    +

    When enabled on server-side sockets, SSLContext.verify_mode must +be set to CERT_OPTIONAL or CERT_REQUIRED, too. The +actual client cert exchange is delayed until +SSLSocket.verify_client_post_handshake() is called and some I/O is +performed.

    +
    +

    Note

    +

    Only available with OpenSSL 1.1.1 and TLS 1.3 enabled. Without TLS 1.3 +support, the property value is None and can’t be modified

    +
    +
    +

    New in version 3.7.1.

    +
    +
    + +
    +
    +SSLContext.protocol
    +

    The protocol version chosen when constructing the context. This attribute +is read-only.

    +
    + +
    +
    +SSLContext.hostname_checks_common_name
    +

    Whether check_hostname falls back to verify the cert’s +subject common name in the absence of a subject alternative name +extension (default: true).

    +
    +

    Note

    +

    Only writeable with OpenSSL 1.1.0 or higher.

    +
    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +SSLContext.verify_flags
    +

    The flags for certificate verification operations. You can set flags like +VERIFY_CRL_CHECK_LEAF by ORing them together. By default OpenSSL +does neither require nor verify certificate revocation lists (CRLs). +Available only with openssl version 0.9.8+.

    +
    +

    New in version 3.4.

    +
    +
    +

    Changed in version 3.6: SSLContext.verify_flags returns VerifyFlags flags:

    +
    >>> ssl.create_default_context().verify_flags  # doctest: +SKIP
    +<VerifyFlags.VERIFY_X509_TRUSTED_FIRST: 32768>
    +
    +
    +
    +
    + +
    +
    +SSLContext.verify_mode
    +

    Whether to try to verify other peers’ certificates and how to behave +if verification fails. This attribute must be one of +CERT_NONE, CERT_OPTIONAL or CERT_REQUIRED.

    +
    +

    Changed in version 3.6: SSLContext.verify_mode returns VerifyMode enum:

    +
    >>> ssl.create_default_context().verify_mode
    +<VerifyMode.CERT_REQUIRED: 2>
    +
    +
    +
    +
    + +
    +
    +

    Certificates

    +

    Certificates in general are part of a public-key / private-key system. In this +system, each principal, (which may be a machine, or a person, or an +organization) is assigned a unique two-part encryption key. One part of the key +is public, and is called the public key; the other part is kept secret, and is +called the private key. The two parts are related, in that if you encrypt a +message with one of the parts, you can decrypt it with the other part, and +only with the other part.

    +

    A certificate contains information about two principals. It contains the name +of a subject, and the subject’s public key. It also contains a statement by a +second principal, the issuer, that the subject is who they claim to be, and +that this is indeed the subject’s public key. The issuer’s statement is signed +with the issuer’s private key, which only the issuer knows. However, anyone can +verify the issuer’s statement by finding the issuer’s public key, decrypting the +statement with it, and comparing it to the other information in the certificate. +The certificate also contains information about the time period over which it is +valid. This is expressed as two fields, called “notBefore” and “notAfter”.

    +

    In the Python use of certificates, a client or server can use a certificate to +prove who they are. The other side of a network connection can also be required +to produce a certificate, and that certificate can be validated to the +satisfaction of the client or server that requires such validation. The +connection attempt can be set to raise an exception if the validation fails. +Validation is done automatically, by the underlying OpenSSL framework; the +application need not concern itself with its mechanics. But the application +does usually need to provide sets of certificates to allow this process to take +place.

    +

    Python uses files to contain certificates. They should be formatted as “PEM” +(see RFC 1422), which is a base-64 encoded form wrapped with a header line +and a footer line:

    +
    -----BEGIN CERTIFICATE-----
    +... (certificate in base64 PEM encoding) ...
    +-----END CERTIFICATE-----
    +
    +
    +
    +

    Certificate chains

    +

    The Python files which contain certificates can contain a sequence of +certificates, sometimes called a certificate chain. This chain should start +with the specific certificate for the principal who “is” the client or server, +and then the certificate for the issuer of that certificate, and then the +certificate for the issuer of that certificate, and so on up the chain till +you get to a certificate which is self-signed, that is, a certificate which +has the same subject and issuer, sometimes called a root certificate. The +certificates should just be concatenated together in the certificate file. For +example, suppose we had a three certificate chain, from our server certificate +to the certificate of the certification authority that signed our server +certificate, to the root certificate of the agency which issued the +certification authority’s certificate:

    +
    -----BEGIN CERTIFICATE-----
    +... (certificate for your server)...
    +-----END CERTIFICATE-----
    +-----BEGIN CERTIFICATE-----
    +... (the certificate for the CA)...
    +-----END CERTIFICATE-----
    +-----BEGIN CERTIFICATE-----
    +... (the root certificate for the CA's issuer)...
    +-----END CERTIFICATE-----
    +
    +
    +
    +
    +

    CA certificates

    +

    If you are going to require validation of the other side of the connection’s +certificate, you need to provide a “CA certs” file, filled with the certificate +chains for each issuer you are willing to trust. Again, this file just contains +these chains concatenated together. For validation, Python will use the first +chain it finds in the file which matches. The platform’s certificates file can +be used by calling SSLContext.load_default_certs(), this is done +automatically with create_default_context().

    +
    +
    +

    Combined key and certificate

    +

    Often the private key is stored in the same file as the certificate; in this +case, only the certfile parameter to SSLContext.load_cert_chain() +and wrap_socket() needs to be passed. If the private key is stored +with the certificate, it should come before the first certificate in +the certificate chain:

    +
    -----BEGIN RSA PRIVATE KEY-----
    +... (private key in base64 encoding) ...
    +-----END RSA PRIVATE KEY-----
    +-----BEGIN CERTIFICATE-----
    +... (certificate in base64 PEM encoding) ...
    +-----END CERTIFICATE-----
    +
    +
    +
    +
    +

    Self-signed certificates

    +

    If you are going to create a server that provides SSL-encrypted connection +services, you will need to acquire a certificate for that service. There are +many ways of acquiring appropriate certificates, such as buying one from a +certification authority. Another common practice is to generate a self-signed +certificate. The simplest way to do this is with the OpenSSL package, using +something like the following:

    +
    % openssl req -new -x509 -days 365 -nodes -out cert.pem -keyout cert.pem
    +Generating a 1024 bit RSA private key
    +.......++++++
    +.............................++++++
    +writing new private key to 'cert.pem'
    +-----
    +You are about to be asked to enter information that will be incorporated
    +into your certificate request.
    +What you are about to enter is what is called a Distinguished Name or a DN.
    +There are quite a few fields but you can leave some blank
    +For some fields there will be a default value,
    +If you enter '.', the field will be left blank.
    +-----
    +Country Name (2 letter code) [AU]:US
    +State or Province Name (full name) [Some-State]:MyState
    +Locality Name (eg, city) []:Some City
    +Organization Name (eg, company) [Internet Widgits Pty Ltd]:My Organization, Inc.
    +Organizational Unit Name (eg, section) []:My Group
    +Common Name (eg, YOUR name) []:myserver.mygroup.myorganization.com
    +Email Address []:ops@myserver.mygroup.myorganization.com
    +%
    +
    +
    +

    The disadvantage of a self-signed certificate is that it is its own root +certificate, and no one else will have it in their cache of known (and trusted) +root certificates.

    +
    +
    +
    +

    Examples

    +
    +

    Testing for SSL support

    +

    To test for the presence of SSL support in a Python installation, user code +should use the following idiom:

    +
    try:
    +    import ssl
    +except ImportError:
    +    pass
    +else:
    +    ...  # do something that requires SSL support
    +
    +
    +
    +
    +

    Client-side operation

    +

    This example creates a SSL context with the recommended security settings +for client sockets, including automatic certificate verification:

    +
    >>> context = ssl.create_default_context()
    +
    +
    +

    If you prefer to tune security settings yourself, you might create +a context from scratch (but beware that you might not get the settings +right):

    +
    >>> context = ssl.SSLContext()
    +>>> context.verify_mode = ssl.CERT_REQUIRED
    +>>> context.check_hostname = True
    +>>> context.load_verify_locations("/etc/ssl/certs/ca-bundle.crt")
    +
    +
    +

    (this snippet assumes your operating system places a bundle of all CA +certificates in /etc/ssl/certs/ca-bundle.crt; if not, you’ll get an +error and have to adjust the location)

    +

    When you use the context to connect to a server, CERT_REQUIRED +validates the server certificate: it ensures that the server certificate +was signed with one of the CA certificates, and checks the signature for +correctness:

    +
    >>> conn = context.wrap_socket(socket.socket(socket.AF_INET),
    +...                            server_hostname="www.python.org")
    +>>> conn.connect(("www.python.org", 443))
    +
    +
    +

    You may then fetch the certificate:

    +
    >>> cert = conn.getpeercert()
    +
    +
    +

    Visual inspection shows that the certificate does identify the desired service +(that is, the HTTPS host www.python.org):

    +
    >>> pprint.pprint(cert)
    +{'OCSP': ('http://ocsp.digicert.com',),
    + 'caIssuers': ('http://cacerts.digicert.com/DigiCertSHA2ExtendedValidationServerCA.crt',),
    + 'crlDistributionPoints': ('http://crl3.digicert.com/sha2-ev-server-g1.crl',
    +                           'http://crl4.digicert.com/sha2-ev-server-g1.crl'),
    + 'issuer': ((('countryName', 'US'),),
    +            (('organizationName', 'DigiCert Inc'),),
    +            (('organizationalUnitName', 'www.digicert.com'),),
    +            (('commonName', 'DigiCert SHA2 Extended Validation Server CA'),)),
    + 'notAfter': 'Sep  9 12:00:00 2016 GMT',
    + 'notBefore': 'Sep  5 00:00:00 2014 GMT',
    + 'serialNumber': '01BB6F00122B177F36CAB49CEA8B6B26',
    + 'subject': ((('businessCategory', 'Private Organization'),),
    +             (('1.3.6.1.4.1.311.60.2.1.3', 'US'),),
    +             (('1.3.6.1.4.1.311.60.2.1.2', 'Delaware'),),
    +             (('serialNumber', '3359300'),),
    +             (('streetAddress', '16 Allen Rd'),),
    +             (('postalCode', '03894-4801'),),
    +             (('countryName', 'US'),),
    +             (('stateOrProvinceName', 'NH'),),
    +             (('localityName', 'Wolfeboro,'),),
    +             (('organizationName', 'Python Software Foundation'),),
    +             (('commonName', 'www.python.org'),)),
    + 'subjectAltName': (('DNS', 'www.python.org'),
    +                    ('DNS', 'python.org'),
    +                    ('DNS', 'pypi.org'),
    +                    ('DNS', 'docs.python.org'),
    +                    ('DNS', 'testpypi.org'),
    +                    ('DNS', 'bugs.python.org'),
    +                    ('DNS', 'wiki.python.org'),
    +                    ('DNS', 'hg.python.org'),
    +                    ('DNS', 'mail.python.org'),
    +                    ('DNS', 'packaging.python.org'),
    +                    ('DNS', 'pythonhosted.org'),
    +                    ('DNS', 'www.pythonhosted.org'),
    +                    ('DNS', 'test.pythonhosted.org'),
    +                    ('DNS', 'us.pycon.org'),
    +                    ('DNS', 'id.python.org')),
    + 'version': 3}
    +
    +
    +

    Now the SSL channel is established and the certificate verified, you can +proceed to talk with the server:

    +
    >>> conn.sendall(b"HEAD / HTTP/1.0\r\nHost: linuxfr.org\r\n\r\n")
    +>>> pprint.pprint(conn.recv(1024).split(b"\r\n"))
    +[b'HTTP/1.1 200 OK',
    + b'Date: Sat, 18 Oct 2014 18:27:20 GMT',
    + b'Server: nginx',
    + b'Content-Type: text/html; charset=utf-8',
    + b'X-Frame-Options: SAMEORIGIN',
    + b'Content-Length: 45679',
    + b'Accept-Ranges: bytes',
    + b'Via: 1.1 varnish',
    + b'Age: 2188',
    + b'X-Served-By: cache-lcy1134-LCY',
    + b'X-Cache: HIT',
    + b'X-Cache-Hits: 11',
    + b'Vary: Cookie',
    + b'Strict-Transport-Security: max-age=63072000; includeSubDomains',
    + b'Connection: close',
    + b'',
    + b'']
    +
    +
    +

    See the discussion of Security considerations below.

    +
    +
    +

    Server-side operation

    +

    For server operation, typically you’ll need to have a server certificate, and +private key, each in a file. You’ll first create a context holding the key +and the certificate, so that clients can check your authenticity. Then +you’ll open a socket, bind it to a port, call listen() on it, and start +waiting for clients to connect:

    +
    import socket, ssl
    +
    +context = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
    +context.load_cert_chain(certfile="mycertfile", keyfile="mykeyfile")
    +
    +bindsocket = socket.socket()
    +bindsocket.bind(('myaddr.mydomain.com', 10023))
    +bindsocket.listen(5)
    +
    +
    +

    When a client connects, you’ll call accept() on the socket to get the +new socket from the other end, and use the context’s SSLContext.wrap_socket() +method to create a server-side SSL socket for the connection:

    +
    while True:
    +    newsocket, fromaddr = bindsocket.accept()
    +    connstream = context.wrap_socket(newsocket, server_side=True)
    +    try:
    +        deal_with_client(connstream)
    +    finally:
    +        connstream.shutdown(socket.SHUT_RDWR)
    +        connstream.close()
    +
    +
    +

    Then you’ll read data from the connstream and do something with it till you +are finished with the client (or the client is finished with you):

    +
    def deal_with_client(connstream):
    +    data = connstream.recv(1024)
    +    # empty data means the client is finished with us
    +    while data:
    +        if not do_something(connstream, data):
    +            # we'll assume do_something returns False
    +            # when we're finished with client
    +            break
    +        data = connstream.recv(1024)
    +    # finished with client
    +
    +
    +

    And go back to listening for new client connections (of course, a real server +would probably handle each client connection in a separate thread, or put +the sockets in non-blocking mode and use an event loop).

    +
    +
    +
    +

    Notes on non-blocking sockets

    +

    SSL sockets behave slightly different than regular sockets in +non-blocking mode. When working with non-blocking sockets, there are +thus several things you need to be aware of:

    +
      +
    • Most SSLSocket methods will raise either +SSLWantWriteError or SSLWantReadError instead of +BlockingIOError if an I/O operation would +block. SSLWantReadError will be raised if a read operation on +the underlying socket is necessary, and SSLWantWriteError for +a write operation on the underlying socket. Note that attempts to +write to an SSL socket may require reading from the underlying +socket first, and attempts to read from the SSL socket may require +a prior write to the underlying socket.

      +
      +

      Changed in version 3.5: In earlier Python versions, the SSLSocket.send() method +returned zero instead of raising SSLWantWriteError or +SSLWantReadError.

      +
      +
    • +
    • Calling select() tells you that the OS-level socket can be +read from (or written to), but it does not imply that there is sufficient +data at the upper SSL layer. For example, only part of an SSL frame might +have arrived. Therefore, you must be ready to handle SSLSocket.recv() +and SSLSocket.send() failures, and retry after another call to +select().

    • +
    • Conversely, since the SSL layer has its own framing, a SSL socket may +still have data available for reading without select() +being aware of it. Therefore, you should first call +SSLSocket.recv() to drain any potentially available data, and then +only block on a select() call if still necessary.

      +

      (of course, similar provisions apply when using other primitives such as +poll(), or those in the selectors module)

      +
    • +
    • The SSL handshake itself will be non-blocking: the +SSLSocket.do_handshake() method has to be retried until it returns +successfully. Here is a synopsis using select() to wait for +the socket’s readiness:

      +
      while True:
      +    try:
      +        sock.do_handshake()
      +        break
      +    except ssl.SSLWantReadError:
      +        select.select([sock], [], [])
      +    except ssl.SSLWantWriteError:
      +        select.select([], [sock], [])
      +
      +
      +
    • +
    +
    +

    See also

    +

    The asyncio module supports non-blocking SSL sockets and provides a +higher level API. It polls for events using the selectors module and +handles SSLWantWriteError, SSLWantReadError and +BlockingIOError exceptions. It runs the SSL handshake asynchronously +as well.

    +
    +
    +
    +

    Memory BIO Support

    +
    +

    New in version 3.5.

    +
    +

    Ever since the SSL module was introduced in Python 2.6, the SSLSocket +class has provided two related but distinct areas of functionality:

    +
      +
    • SSL protocol handling

    • +
    • Network IO

    • +
    +

    The network IO API is identical to that provided by socket.socket, +from which SSLSocket also inherits. This allows an SSL socket to be +used as a drop-in replacement for a regular socket, making it very easy to add +SSL support to an existing application.

    +

    Combining SSL protocol handling and network IO usually works well, but there +are some cases where it doesn’t. An example is async IO frameworks that want to +use a different IO multiplexing model than the “select/poll on a file +descriptor” (readiness based) model that is assumed by socket.socket +and by the internal OpenSSL socket IO routines. This is mostly relevant for +platforms like Windows where this model is not efficient. For this purpose, a +reduced scope variant of SSLSocket called SSLObject is +provided.

    +
    +
    +class ssl.SSLObject
    +

    A reduced-scope variant of SSLSocket representing an SSL protocol +instance that does not contain any network IO methods. This class is +typically used by framework authors that want to implement asynchronous IO +for SSL through memory buffers.

    +

    This class implements an interface on top of a low-level SSL object as +implemented by OpenSSL. This object captures the state of an SSL connection +but does not provide any network IO itself. IO needs to be performed through +separate “BIO” objects which are OpenSSL’s IO abstraction layer.

    +

    This class has no public constructor. An SSLObject instance +must be created using the wrap_bio() method. This +method will create the SSLObject instance and bind it to a +pair of BIOs. The incoming BIO is used to pass data from Python to the +SSL protocol instance, while the outgoing BIO is used to pass data the +other way around.

    +

    The following methods are available:

    + +

    When compared to SSLSocket, this object lacks the following +features:

    +
      +
    • Any form of network IO; recv() and send() read and write only to +the underlying MemoryBIO buffers.

    • +
    • There is no do_handshake_on_connect machinery. You must always manually +call do_handshake() to start the handshake.

    • +
    • There is no handling of suppress_ragged_eofs. All end-of-file conditions +that are in violation of the protocol are reported via the +SSLEOFError exception.

    • +
    • The method unwrap() call does not return anything, +unlike for an SSL socket where it returns the underlying socket.

    • +
    • The server_name_callback callback passed to +SSLContext.set_servername_callback() will get an SSLObject +instance instead of a SSLSocket instance as its first parameter.

    • +
    +

    Some notes related to the use of SSLObject:

    + +
    +

    Changed in version 3.7: SSLObject instances must to created with +wrap_bio(). In earlier versions, it was possible to +create instances directly. This was never documented or officially +supported.

    +
    +
    + +

    An SSLObject communicates with the outside world using memory buffers. The +class MemoryBIO provides a memory buffer that can be used for this +purpose. It wraps an OpenSSL memory BIO (Basic IO) object:

    +
    +
    +class ssl.MemoryBIO
    +

    A memory buffer that can be used to pass data between Python and an SSL +protocol instance.

    +
    +
    +pending
    +

    Return the number of bytes currently in the memory buffer.

    +
    + +
    +
    +eof
    +

    A boolean indicating whether the memory BIO is current at the end-of-file +position.

    +
    + +
    +
    +read(n=-1)
    +

    Read up to n bytes from the memory buffer. If n is not specified or +negative, all bytes are returned.

    +
    + +
    +
    +write(buf)
    +

    Write the bytes from buf to the memory BIO. The buf argument must be an +object supporting the buffer protocol.

    +

    The return value is the number of bytes written, which is always equal to +the length of buf.

    +
    + +
    +
    +write_eof()
    +

    Write an EOF marker to the memory BIO. After this method has been called, it +is illegal to call write(). The attribute eof will +become true after all data currently in the buffer has been read.

    +
    + +
    + +
    +
    +

    SSL session

    +
    +

    New in version 3.6.

    +
    +
    +
    +class ssl.SSLSession
    +

    Session object used by session.

    +
    +
    +id
    +
    + +
    +
    +time
    +
    + +
    +
    +timeout
    +
    + +
    +
    +ticket_lifetime_hint
    +
    + +
    +
    +has_ticket
    +
    + +
    + +
    +
    +

    Security considerations

    +
    +

    Best defaults

    +

    For client use, if you don’t have any special requirements for your +security policy, it is highly recommended that you use the +create_default_context() function to create your SSL context. +It will load the system’s trusted CA certificates, enable certificate +validation and hostname checking, and try to choose reasonably secure +protocol and cipher settings.

    +

    For example, here is how you would use the smtplib.SMTP class to +create a trusted, secure connection to a SMTP server:

    +
    >>> import ssl, smtplib
    +>>> smtp = smtplib.SMTP("mail.python.org", port=587)
    +>>> context = ssl.create_default_context()
    +>>> smtp.starttls(context=context)
    +(220, b'2.0.0 Ready to start TLS')
    +
    +
    +

    If a client certificate is needed for the connection, it can be added with +SSLContext.load_cert_chain().

    +

    By contrast, if you create the SSL context by calling the SSLContext +constructor yourself, it will not have certificate validation nor hostname +checking enabled by default. If you do so, please read the paragraphs below +to achieve a good security level.

    +
    +
    +

    Manual settings

    +
    +

    Verifying certificates

    +

    When calling the SSLContext constructor directly, +CERT_NONE is the default. Since it does not authenticate the other +peer, it can be insecure, especially in client mode where most of time you +would like to ensure the authenticity of the server you’re talking to. +Therefore, when in client mode, it is highly recommended to use +CERT_REQUIRED. However, it is in itself not sufficient; you also +have to check that the server certificate, which can be obtained by calling +SSLSocket.getpeercert(), matches the desired service. For many +protocols and applications, the service can be identified by the hostname; +in this case, the match_hostname() function can be used. This common +check is automatically performed when SSLContext.check_hostname is +enabled.

    +
    +

    Changed in version 3.7: Hostname matchings is now performed by OpenSSL. Python no longer uses +match_hostname().

    +
    +

    In server mode, if you want to authenticate your clients using the SSL layer +(rather than using a higher-level authentication mechanism), you’ll also have +to specify CERT_REQUIRED and similarly check the client certificate.

    +
    +
    +

    Protocol versions

    +

    SSL versions 2 and 3 are considered insecure and are therefore dangerous to +use. If you want maximum compatibility between clients and servers, it is +recommended to use PROTOCOL_TLS_CLIENT or +PROTOCOL_TLS_SERVER as the protocol version. SSLv2 and SSLv3 are +disabled by default.

    +
    >>> client_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
    +>>> client_context.options |= ssl.OP_NO_TLSv1
    +>>> client_context.options |= ssl.OP_NO_TLSv1_1
    +
    +
    +

    The SSL context created above will only allow TLSv1.2 and later (if +supported by your system) connections to a server. PROTOCOL_TLS_CLIENT +implies certificate validation and hostname checks by default. You have to +load certificates into the context.

    +
    +
    +

    Cipher selection

    +

    If you have advanced security requirements, fine-tuning of the ciphers +enabled when negotiating a SSL session is possible through the +SSLContext.set_ciphers() method. Starting from Python 3.2.3, the +ssl module disables certain weak ciphers by default, but you may want +to further restrict the cipher choice. Be sure to read OpenSSL’s documentation +about the cipher list format. +If you want to check which ciphers are enabled by a given cipher list, use +SSLContext.get_ciphers() or the openssl ciphers command on your +system.

    +
    +
    +
    +

    Multi-processing

    +

    If using this module as part of a multi-processed application (using, +for example the multiprocessing or concurrent.futures modules), +be aware that OpenSSL’s internal random number generator does not properly +handle forked processes. Applications must change the PRNG state of the +parent process if they use any SSL feature with os.fork(). Any +successful call of RAND_add(), RAND_bytes() or +RAND_pseudo_bytes() is sufficient.

    +
    +
    +
    +

    TLS 1.3

    +
    +

    New in version 3.7.

    +
    +

    Python has provisional and experimental support for TLS 1.3 with OpenSSL +1.1.1. The new protocol behaves slightly differently than previous version +of TLS/SSL. Some new TLS 1.3 features are not yet available.

    +
      +
    • TLS 1.3 uses a disjunct set of cipher suites. All AES-GCM and +ChaCha20 cipher suites are enabled by default. The method +SSLContext.set_ciphers() cannot enable or disable any TLS 1.3 +ciphers yet, but SSLContext.get_ciphers() returns them.

    • +
    • Session tickets are no longer sent as part of the initial handshake and +are handled differently. SSLSocket.session and SSLSession +are not compatible with TLS 1.3.

    • +
    • Client-side certificates are also no longer verified during the initial +handshake. A server can request a certificate at any time. Clients +process certificate requests while they send or receive application data +from the server.

    • +
    • TLS 1.3 features like early data, deferred TLS client cert request, +signature algorithm configuration, and rekeying are not supported yet.

    • +
    +
    +
    +

    LibreSSL support

    +

    LibreSSL is a fork of OpenSSL 1.0.1. The ssl module has limited support for +LibreSSL. Some features are not available when the ssl module is compiled +with LibreSSL.

    + + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/stat.html b/python-3.7.4-docs-html/library/stat.html new file mode 100644 index 0000000..463e32f --- /dev/null +++ b/python-3.7.4-docs-html/library/stat.html @@ -0,0 +1,721 @@ + + + + + + + stat — Interpreting stat() results — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    stat — Interpreting stat() results

    +

    Source code: Lib/stat.py

    +
    +

    The stat module defines constants and functions for interpreting the +results of os.stat(), os.fstat() and os.lstat() (if they +exist). For complete details about the stat(), fstat() and +lstat() calls, consult the documentation for your system.

    +
    +

    Changed in version 3.4: The stat module is backed by a C implementation.

    +
    +

    The stat module defines the following functions to test for specific file +types:

    +
    +
    +stat.S_ISDIR(mode)
    +

    Return non-zero if the mode is from a directory.

    +
    + +
    +
    +stat.S_ISCHR(mode)
    +

    Return non-zero if the mode is from a character special device file.

    +
    + +
    +
    +stat.S_ISBLK(mode)
    +

    Return non-zero if the mode is from a block special device file.

    +
    + +
    +
    +stat.S_ISREG(mode)
    +

    Return non-zero if the mode is from a regular file.

    +
    + +
    +
    +stat.S_ISFIFO(mode)
    +

    Return non-zero if the mode is from a FIFO (named pipe).

    +
    + +
    +
    +stat.S_ISLNK(mode)
    +

    Return non-zero if the mode is from a symbolic link.

    +
    + +
    +
    +stat.S_ISSOCK(mode)
    +

    Return non-zero if the mode is from a socket.

    +
    + +
    +
    +stat.S_ISDOOR(mode)
    +

    Return non-zero if the mode is from a door.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +stat.S_ISPORT(mode)
    +

    Return non-zero if the mode is from an event port.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +stat.S_ISWHT(mode)
    +

    Return non-zero if the mode is from a whiteout.

    +
    +

    New in version 3.4.

    +
    +
    + +

    Two additional functions are defined for more general manipulation of the file’s +mode:

    +
    +
    +stat.S_IMODE(mode)
    +

    Return the portion of the file’s mode that can be set by +os.chmod()—that is, the file’s permission bits, plus the sticky +bit, set-group-id, and set-user-id bits (on systems that support them).

    +
    + +
    +
    +stat.S_IFMT(mode)
    +

    Return the portion of the file’s mode that describes the file type (used by the +S_IS*() functions above).

    +
    + +

    Normally, you would use the os.path.is*() functions for testing the type +of a file; the functions here are useful when you are doing multiple tests of +the same file and wish to avoid the overhead of the stat() system call +for each test. These are also useful when checking for information about a file +that isn’t handled by os.path, like the tests for block and character +devices.

    +

    Example:

    +
    import os, sys
    +from stat import *
    +
    +def walktree(top, callback):
    +    '''recursively descend the directory tree rooted at top,
    +       calling the callback function for each regular file'''
    +
    +    for f in os.listdir(top):
    +        pathname = os.path.join(top, f)
    +        mode = os.stat(pathname).st_mode
    +        if S_ISDIR(mode):
    +            # It's a directory, recurse into it
    +            walktree(pathname, callback)
    +        elif S_ISREG(mode):
    +            # It's a file, call the callback function
    +            callback(pathname)
    +        else:
    +            # Unknown file type, print a message
    +            print('Skipping %s' % pathname)
    +
    +def visitfile(file):
    +    print('visiting', file)
    +
    +if __name__ == '__main__':
    +    walktree(sys.argv[1], visitfile)
    +
    +
    +

    An additional utility function is provided to convert a file’s mode in a human +readable string:

    +
    +
    +stat.filemode(mode)
    +

    Convert a file’s mode to a string of the form ‘-rwxrwxrwx’.

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.4: The function supports S_IFDOOR, S_IFPORT and +S_IFWHT.

    +
    +
    + +

    All the variables below are simply symbolic indexes into the 10-tuple returned +by os.stat(), os.fstat() or os.lstat().

    +
    +
    +stat.ST_MODE
    +

    Inode protection mode.

    +
    + +
    +
    +stat.ST_INO
    +

    Inode number.

    +
    + +
    +
    +stat.ST_DEV
    +

    Device inode resides on.

    +
    + +
    + +

    Number of links to the inode.

    +
    + +
    +
    +stat.ST_UID
    +

    User id of the owner.

    +
    + +
    +
    +stat.ST_GID
    +

    Group id of the owner.

    +
    + +
    +
    +stat.ST_SIZE
    +

    Size in bytes of a plain file; amount of data waiting on some special files.

    +
    + +
    +
    +stat.ST_ATIME
    +

    Time of last access.

    +
    + +
    +
    +stat.ST_MTIME
    +

    Time of last modification.

    +
    + +
    +
    +stat.ST_CTIME
    +

    The “ctime” as reported by the operating system. On some systems (like Unix) is +the time of the last metadata change, and, on others (like Windows), is the +creation time (see platform documentation for details).

    +
    + +

    The interpretation of “file size” changes according to the file type. For plain +files this is the size of the file in bytes. For FIFOs and sockets under most +flavors of Unix (including Linux in particular), the “size” is the number of +bytes waiting to be read at the time of the call to os.stat(), +os.fstat(), or os.lstat(); this can sometimes be useful, especially +for polling one of these special files after a non-blocking open. The meaning +of the size field for other character and block devices varies more, depending +on the implementation of the underlying system call.

    +

    The variables below define the flags used in the ST_MODE field.

    +

    Use of the functions above is more portable than use of the first set of flags:

    +
    +
    +stat.S_IFSOCK
    +

    Socket.

    +
    + +
    +
    +stat.S_IFLNK
    +

    Symbolic link.

    +
    + +
    +
    +stat.S_IFREG
    +

    Regular file.

    +
    + +
    +
    +stat.S_IFBLK
    +

    Block device.

    +
    + +
    +
    +stat.S_IFDIR
    +

    Directory.

    +
    + +
    +
    +stat.S_IFCHR
    +

    Character device.

    +
    + +
    +
    +stat.S_IFIFO
    +

    FIFO.

    +
    + +
    +
    +stat.S_IFDOOR
    +

    Door.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +stat.S_IFPORT
    +

    Event port.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +stat.S_IFWHT
    +

    Whiteout.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +

    Note

    +

    S_IFDOOR, S_IFPORT or S_IFWHT are defined as +0 when the platform does not have support for the file types.

    +
    +

    The following flags can also be used in the mode argument of os.chmod():

    +
    +
    +stat.S_ISUID
    +

    Set UID bit.

    +
    + +
    +
    +stat.S_ISGID
    +

    Set-group-ID bit. This bit has several special uses. For a directory +it indicates that BSD semantics is to be used for that directory: +files created there inherit their group ID from the directory, not +from the effective group ID of the creating process, and directories +created there will also get the S_ISGID bit set. For a +file that does not have the group execution bit (S_IXGRP) +set, the set-group-ID bit indicates mandatory file/record locking +(see also S_ENFMT).

    +
    + +
    +
    +stat.S_ISVTX
    +

    Sticky bit. When this bit is set on a directory it means that a file +in that directory can be renamed or deleted only by the owner of the +file, by the owner of the directory, or by a privileged process.

    +
    + +
    +
    +stat.S_IRWXU
    +

    Mask for file owner permissions.

    +
    + +
    +
    +stat.S_IRUSR
    +

    Owner has read permission.

    +
    + +
    +
    +stat.S_IWUSR
    +

    Owner has write permission.

    +
    + +
    +
    +stat.S_IXUSR
    +

    Owner has execute permission.

    +
    + +
    +
    +stat.S_IRWXG
    +

    Mask for group permissions.

    +
    + +
    +
    +stat.S_IRGRP
    +

    Group has read permission.

    +
    + +
    +
    +stat.S_IWGRP
    +

    Group has write permission.

    +
    + +
    +
    +stat.S_IXGRP
    +

    Group has execute permission.

    +
    + +
    +
    +stat.S_IRWXO
    +

    Mask for permissions for others (not in group).

    +
    + +
    +
    +stat.S_IROTH
    +

    Others have read permission.

    +
    + +
    +
    +stat.S_IWOTH
    +

    Others have write permission.

    +
    + +
    +
    +stat.S_IXOTH
    +

    Others have execute permission.

    +
    + +
    +
    +stat.S_ENFMT
    +

    System V file locking enforcement. This flag is shared with S_ISGID: +file/record locking is enforced on files that do not have the group +execution bit (S_IXGRP) set.

    +
    + +
    +
    +stat.S_IREAD
    +

    Unix V7 synonym for S_IRUSR.

    +
    + +
    +
    +stat.S_IWRITE
    +

    Unix V7 synonym for S_IWUSR.

    +
    + +
    +
    +stat.S_IEXEC
    +

    Unix V7 synonym for S_IXUSR.

    +
    + +

    The following flags can be used in the flags argument of os.chflags():

    +
    +
    +stat.UF_NODUMP
    +

    Do not dump the file.

    +
    + +
    +
    +stat.UF_IMMUTABLE
    +

    The file may not be changed.

    +
    + +
    +
    +stat.UF_APPEND
    +

    The file may only be appended to.

    +
    + +
    +
    +stat.UF_OPAQUE
    +

    The directory is opaque when viewed through a union stack.

    +
    + +
    + +

    The file may not be renamed or deleted.

    +
    + +
    +
    +stat.UF_COMPRESSED
    +

    The file is stored compressed (Mac OS X 10.6+).

    +
    + +
    +
    +stat.UF_HIDDEN
    +

    The file should not be displayed in a GUI (Mac OS X 10.5+).

    +
    + +
    +
    +stat.SF_ARCHIVED
    +

    The file may be archived.

    +
    + +
    +
    +stat.SF_IMMUTABLE
    +

    The file may not be changed.

    +
    + +
    +
    +stat.SF_APPEND
    +

    The file may only be appended to.

    +
    + +
    + +

    The file may not be renamed or deleted.

    +
    + +
    +
    +stat.SF_SNAPSHOT
    +

    The file is a snapshot file.

    +
    + +

    See the *BSD or Mac OS systems man page chflags(2) for more information.

    +

    On Windows, the following file attribute constants are available for use when +testing bits in the st_file_attributes member returned by os.stat(). +See the Windows API documentation +for more detail on the meaning of these constants.

    +
    +
    +stat.FILE_ATTRIBUTE_ARCHIVE
    +
    +stat.FILE_ATTRIBUTE_COMPRESSED
    +
    +stat.FILE_ATTRIBUTE_DEVICE
    +
    +stat.FILE_ATTRIBUTE_DIRECTORY
    +
    +stat.FILE_ATTRIBUTE_ENCRYPTED
    +
    +stat.FILE_ATTRIBUTE_HIDDEN
    +
    +stat.FILE_ATTRIBUTE_INTEGRITY_STREAM
    +
    +stat.FILE_ATTRIBUTE_NORMAL
    +
    +stat.FILE_ATTRIBUTE_NOT_CONTENT_INDEXED
    +
    +stat.FILE_ATTRIBUTE_NO_SCRUB_DATA
    +
    +stat.FILE_ATTRIBUTE_OFFLINE
    +
    +stat.FILE_ATTRIBUTE_READONLY
    +
    +stat.FILE_ATTRIBUTE_REPARSE_POINT
    +
    +stat.FILE_ATTRIBUTE_SPARSE_FILE
    +
    +stat.FILE_ATTRIBUTE_SYSTEM
    +
    +stat.FILE_ATTRIBUTE_TEMPORARY
    +
    +stat.FILE_ATTRIBUTE_VIRTUAL
    +
    +

    New in version 3.5.

    +
    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/statistics.html b/python-3.7.4-docs-html/library/statistics.html new file mode 100644 index 0000000..4439bf3 --- /dev/null +++ b/python-3.7.4-docs-html/library/statistics.html @@ -0,0 +1,613 @@ + + + + + + + statistics — Mathematical statistics functions — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    statistics — Mathematical statistics functions

    +
    +

    New in version 3.4.

    +
    +

    Source code: Lib/statistics.py

    +
    +

    This module provides functions for calculating mathematical statistics of +numeric (Real-valued) data.

    +
    +

    Note

    +

    Unless explicitly noted otherwise, these functions support int, +float, decimal.Decimal and fractions.Fraction. +Behaviour with other types (whether in the numeric tower or not) is +currently unsupported. Mixed types are also undefined and +implementation-dependent. If your input data consists of mixed types, +you may be able to use map() to ensure a consistent result, e.g. +map(float, input_data).

    +
    +
    +

    Averages and measures of central location

    +

    These functions calculate an average or typical value from a population +or sample.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + +

    mean()

    Arithmetic mean (“average”) of data.

    harmonic_mean()

    Harmonic mean of data.

    median()

    Median (middle value) of data.

    median_low()

    Low median of data.

    median_high()

    High median of data.

    median_grouped()

    Median, or 50th percentile, of grouped data.

    mode()

    Mode (most common value) of discrete data.

    +
    +
    +

    Measures of spread

    +

    These functions calculate a measure of how much the population or sample +tends to deviate from the typical or average values.

    + ++++ + + + + + + + + + + + + + + +

    pstdev()

    Population standard deviation of data.

    pvariance()

    Population variance of data.

    stdev()

    Sample standard deviation of data.

    variance()

    Sample variance of data.

    +
    +
    +

    Function details

    +

    Note: The functions do not require the data given to them to be sorted. +However, for reading convenience, most of the examples show sorted sequences.

    +
    +
    +statistics.mean(data)
    +

    Return the sample arithmetic mean of data which can be a sequence or iterator.

    +

    The arithmetic mean is the sum of the data divided by the number of data +points. It is commonly called “the average”, although it is only one of many +different mathematical averages. It is a measure of the central location of +the data.

    +

    If data is empty, StatisticsError will be raised.

    +

    Some examples of use:

    +
    >>> mean([1, 2, 3, 4, 4])
    +2.8
    +>>> mean([-1.0, 2.5, 3.25, 5.75])
    +2.625
    +
    +>>> from fractions import Fraction as F
    +>>> mean([F(3, 7), F(1, 21), F(5, 3), F(1, 3)])
    +Fraction(13, 21)
    +
    +>>> from decimal import Decimal as D
    +>>> mean([D("0.5"), D("0.75"), D("0.625"), D("0.375")])
    +Decimal('0.5625')
    +
    +
    +
    +

    Note

    +

    The mean is strongly affected by outliers and is not a robust estimator +for central location: the mean is not necessarily a typical example of the +data points. For more robust, although less efficient, measures of +central location, see median() and mode(). (In this case, +“efficient” refers to statistical efficiency rather than computational +efficiency.)

    +

    The sample mean gives an unbiased estimate of the true population mean, +which means that, taken on average over all the possible samples, +mean(sample) converges on the true mean of the entire population. If +data represents the entire population rather than a sample, then +mean(data) is equivalent to calculating the true population mean μ.

    +
    +
    + +
    +
    +statistics.harmonic_mean(data)
    +

    Return the harmonic mean of data, a sequence or iterator of +real-valued numbers.

    +

    The harmonic mean, sometimes called the subcontrary mean, is the +reciprocal of the arithmetic mean() of the reciprocals of the +data. For example, the harmonic mean of three values a, b and c +will be equivalent to 3/(1/a + 1/b + 1/c).

    +

    The harmonic mean is a type of average, a measure of the central +location of the data. It is often appropriate when averaging quantities +which are rates or ratios, for example speeds. For example:

    +

    Suppose an investor purchases an equal value of shares in each of +three companies, with P/E (price/earning) ratios of 2.5, 3 and 10. +What is the average P/E ratio for the investor’s portfolio?

    +
    >>> harmonic_mean([2.5, 3, 10])  # For an equal investment portfolio.
    +3.6
    +
    +
    +

    Using the arithmetic mean would give an average of about 5.167, which +is too high.

    +

    StatisticsError is raised if data is empty, or any element +is less than zero.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +statistics.median(data)
    +

    Return the median (middle value) of numeric data, using the common “mean of +middle two” method. If data is empty, StatisticsError is raised. +data can be a sequence or iterator.

    +

    The median is a robust measure of central location, and is less affected by +the presence of outliers in your data. When the number of data points is +odd, the middle data point is returned:

    +
    >>> median([1, 3, 5])
    +3
    +
    +
    +

    When the number of data points is even, the median is interpolated by taking +the average of the two middle values:

    +
    >>> median([1, 3, 5, 7])
    +4.0
    +
    +
    +

    This is suited for when your data is discrete, and you don’t mind that the +median may not be an actual data point.

    +

    If your data is ordinal (supports order operations) but not numeric (doesn’t +support addition), you should use median_low() or median_high() +instead.

    + +
    + +
    +
    +statistics.median_low(data)
    +

    Return the low median of numeric data. If data is empty, +StatisticsError is raised. data can be a sequence or iterator.

    +

    The low median is always a member of the data set. When the number of data +points is odd, the middle value is returned. When it is even, the smaller of +the two middle values is returned.

    +
    >>> median_low([1, 3, 5])
    +3
    +>>> median_low([1, 3, 5, 7])
    +3
    +
    +
    +

    Use the low median when your data are discrete and you prefer the median to +be an actual data point rather than interpolated.

    +
    + +
    +
    +statistics.median_high(data)
    +

    Return the high median of data. If data is empty, StatisticsError +is raised. data can be a sequence or iterator.

    +

    The high median is always a member of the data set. When the number of data +points is odd, the middle value is returned. When it is even, the larger of +the two middle values is returned.

    +
    >>> median_high([1, 3, 5])
    +3
    +>>> median_high([1, 3, 5, 7])
    +5
    +
    +
    +

    Use the high median when your data are discrete and you prefer the median to +be an actual data point rather than interpolated.

    +
    + +
    +
    +statistics.median_grouped(data, interval=1)
    +

    Return the median of grouped continuous data, calculated as the 50th +percentile, using interpolation. If data is empty, StatisticsError +is raised. data can be a sequence or iterator.

    +
    >>> median_grouped([52, 52, 53, 54])
    +52.5
    +
    +
    +

    In the following example, the data are rounded, so that each value represents +the midpoint of data classes, e.g. 1 is the midpoint of the class 0.5–1.5, 2 +is the midpoint of 1.5–2.5, 3 is the midpoint of 2.5–3.5, etc. With the data +given, the middle value falls somewhere in the class 3.5–4.5, and +interpolation is used to estimate it:

    +
    >>> median_grouped([1, 2, 2, 3, 4, 4, 4, 4, 4, 5])
    +3.7
    +
    +
    +

    Optional argument interval represents the class interval, and defaults +to 1. Changing the class interval naturally will change the interpolation:

    +
    >>> median_grouped([1, 3, 3, 5, 7], interval=1)
    +3.25
    +>>> median_grouped([1, 3, 3, 5, 7], interval=2)
    +3.5
    +
    +
    +

    This function does not check whether the data points are at least +interval apart.

    +
    +

    CPython implementation detail: Under some circumstances, median_grouped() may coerce data points to +floats. This behaviour is likely to change in the future.

    +
    +
    +

    See also

    +
      +
    • “Statistics for the Behavioral Sciences”, Frederick J Gravetter and +Larry B Wallnau (8th Edition).

    • +
    • The SSMEDIAN +function in the Gnome Gnumeric spreadsheet, including this discussion.

    • +
    +
    +
    + +
    +
    +statistics.mode(data)
    +

    Return the most common data point from discrete or nominal data. The mode +(when it exists) is the most typical value, and is a robust measure of +central location.

    +

    If data is empty, or if there is not exactly one most common value, +StatisticsError is raised.

    +

    mode assumes discrete data, and returns a single value. This is the +standard treatment of the mode as commonly taught in schools:

    +
    >>> mode([1, 1, 2, 3, 3, 3, 3, 4])
    +3
    +
    +
    +

    The mode is unique in that it is the only statistic which also applies +to nominal (non-numeric) data:

    +
    >>> mode(["red", "blue", "blue", "red", "green", "red", "red"])
    +'red'
    +
    +
    +
    + +
    +
    +statistics.pstdev(data, mu=None)
    +

    Return the population standard deviation (the square root of the population +variance). See pvariance() for arguments and other details.

    +
    >>> pstdev([1.5, 2.5, 2.5, 2.75, 3.25, 4.75])
    +0.986893273527251
    +
    +
    +
    + +
    +
    +statistics.pvariance(data, mu=None)
    +

    Return the population variance of data, a non-empty iterable of real-valued +numbers. Variance, or second moment about the mean, is a measure of the +variability (spread or dispersion) of data. A large variance indicates that +the data is spread out; a small variance indicates it is clustered closely +around the mean.

    +

    If the optional second argument mu is given, it should be the mean of +data. If it is missing or None (the default), the mean is +automatically calculated.

    +

    Use this function to calculate the variance from the entire population. To +estimate the variance from a sample, the variance() function is usually +a better choice.

    +

    Raises StatisticsError if data is empty.

    +

    Examples:

    +
    >>> data = [0.0, 0.25, 0.25, 1.25, 1.5, 1.75, 2.75, 3.25]
    +>>> pvariance(data)
    +1.25
    +
    +
    +

    If you have already calculated the mean of your data, you can pass it as the +optional second argument mu to avoid recalculation:

    +
    >>> mu = mean(data)
    +>>> pvariance(data, mu)
    +1.25
    +
    +
    +

    This function does not attempt to verify that you have passed the actual mean +as mu. Using arbitrary values for mu may lead to invalid or impossible +results.

    +

    Decimals and Fractions are supported:

    +
    >>> from decimal import Decimal as D
    +>>> pvariance([D("27.5"), D("30.25"), D("30.25"), D("34.5"), D("41.75")])
    +Decimal('24.815')
    +
    +>>> from fractions import Fraction as F
    +>>> pvariance([F(1, 4), F(5, 4), F(1, 2)])
    +Fraction(13, 72)
    +
    +
    +
    +

    Note

    +

    When called with the entire population, this gives the population variance +σ². When called on a sample instead, this is the biased sample variance +s², also known as variance with N degrees of freedom.

    +

    If you somehow know the true population mean μ, you may use this function +to calculate the variance of a sample, giving the known population mean as +the second argument. Provided the data points are representative +(e.g. independent and identically distributed), the result will be an +unbiased estimate of the population variance.

    +
    +
    + +
    +
    +statistics.stdev(data, xbar=None)
    +

    Return the sample standard deviation (the square root of the sample +variance). See variance() for arguments and other details.

    +
    >>> stdev([1.5, 2.5, 2.5, 2.75, 3.25, 4.75])
    +1.0810874155219827
    +
    +
    +
    + +
    +
    +statistics.variance(data, xbar=None)
    +

    Return the sample variance of data, an iterable of at least two real-valued +numbers. Variance, or second moment about the mean, is a measure of the +variability (spread or dispersion) of data. A large variance indicates that +the data is spread out; a small variance indicates it is clustered closely +around the mean.

    +

    If the optional second argument xbar is given, it should be the mean of +data. If it is missing or None (the default), the mean is +automatically calculated.

    +

    Use this function when your data is a sample from a population. To calculate +the variance from the entire population, see pvariance().

    +

    Raises StatisticsError if data has fewer than two values.

    +

    Examples:

    +
    >>> data = [2.75, 1.75, 1.25, 0.25, 0.5, 1.25, 3.5]
    +>>> variance(data)
    +1.3720238095238095
    +
    +
    +

    If you have already calculated the mean of your data, you can pass it as the +optional second argument xbar to avoid recalculation:

    +
    >>> m = mean(data)
    +>>> variance(data, m)
    +1.3720238095238095
    +
    +
    +

    This function does not attempt to verify that you have passed the actual mean +as xbar. Using arbitrary values for xbar can lead to invalid or +impossible results.

    +

    Decimal and Fraction values are supported:

    +
    >>> from decimal import Decimal as D
    +>>> variance([D("27.5"), D("30.25"), D("30.25"), D("34.5"), D("41.75")])
    +Decimal('31.01875')
    +
    +>>> from fractions import Fraction as F
    +>>> variance([F(1, 6), F(1, 2), F(5, 3)])
    +Fraction(67, 108)
    +
    +
    +
    +

    Note

    +

    This is the sample variance s² with Bessel’s correction, also known as +variance with N-1 degrees of freedom. Provided that the data points are +representative (e.g. independent and identically distributed), the result +should be an unbiased estimate of the true population variance.

    +

    If you somehow know the actual population mean μ you should pass it to the +pvariance() function as the mu parameter to get the variance of a +sample.

    +
    +
    + +
    +
    +

    Exceptions

    +

    A single exception is defined:

    +
    +
    +exception statistics.StatisticsError
    +

    Subclass of ValueError for statistics-related exceptions.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/stdtypes.html b/python-3.7.4-docs-html/library/stdtypes.html new file mode 100644 index 0000000..82b4ea5 --- /dev/null +++ b/python-3.7.4-docs-html/library/stdtypes.html @@ -0,0 +1,4946 @@ + + + + + + + Built-in Types — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Built-in Types

    +

    The following sections describe the standard types that are built into the +interpreter.

    +

    The principal built-in types are numerics, sequences, mappings, classes, +instances and exceptions.

    +

    Some collection classes are mutable. The methods that add, subtract, or +rearrange their members in place, and don’t return a specific item, never return +the collection instance itself but None.

    +

    Some operations are supported by several object types; in particular, +practically all objects can be compared, tested for truth value, and converted +to a string (with the repr() function or the slightly different +str() function). The latter function is implicitly used when an object is +written by the print() function.

    +
    +

    Truth Value Testing

    +

    Any object can be tested for truth value, for use in an if or +while condition or as operand of the Boolean operations below.

    +

    By default, an object is considered true unless its class defines either a +__bool__() method that returns False or a __len__() method that +returns zero, when called with the object. 1 Here are most of the built-in +objects considered false:

    +
    +
    +
      +
    • constants defined to be false: None and False.

    • +
    • zero of any numeric type: 0, 0.0, 0j, Decimal(0), +Fraction(0, 1)

    • +
    • empty sequences and collections: '', (), [], {}, set(), +range(0)

    • +
    +

    Operations and built-in functions that have a Boolean result always return 0 +or False for false and 1 or True for true, unless otherwise stated. +(Important exception: the Boolean operations or and and always return +one of their operands.)

    +
    +
    +

    Boolean Operations — and, or, not

    +

    These are the Boolean operations, ordered by ascending priority:

    + +++++ + + + + + + + + + + + + + + + + + + + + +

    Operation

    Result

    Notes

    x or y

    if x is false, then y, else +x

    (1)

    x and y

    if x is false, then x, else +y

    (2)

    not x

    if x is false, then True, +else False

    (3)

    +

    Notes:

    +
      +
    1. This is a short-circuit operator, so it only evaluates the second +argument if the first one is false.

    2. +
    3. This is a short-circuit operator, so it only evaluates the second +argument if the first one is true.

    4. +
    5. not has a lower priority than non-Boolean operators, so not a == b is +interpreted as not (a == b), and a == not b is a syntax error.

    6. +
    +
    +
    +

    Comparisons

    +

    There are eight comparison operations in Python. They all have the same +priority (which is higher than that of the Boolean operations). Comparisons can +be chained arbitrarily; for example, x < y <= z is equivalent to x < y and +y <= z, except that y is evaluated only once (but in both cases z is not +evaluated at all when x < y is found to be false).

    +

    This table summarizes the comparison operations:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Operation

    Meaning

    <

    strictly less than

    <=

    less than or equal

    >

    strictly greater than

    >=

    greater than or equal

    ==

    equal

    !=

    not equal

    is

    object identity

    is not

    negated object identity

    +

    Objects of different types, except different numeric types, never compare equal. +Furthermore, some types (for example, function objects) support only a degenerate +notion of comparison where any two objects of that type are unequal. The <, +<=, > and >= operators will raise a TypeError exception when +comparing a complex number with another built-in numeric type, when the objects +are of different types that cannot be compared, or in other cases where there is +no defined ordering.

    +

    Non-identical instances of a class normally compare as non-equal unless the +class defines the __eq__() method.

    +

    Instances of a class cannot be ordered with respect to other instances of the +same class, or other types of object, unless the class defines enough of the +methods __lt__(), __le__(), __gt__(), and __ge__() (in +general, __lt__() and __eq__() are sufficient, if you want the +conventional meanings of the comparison operators).

    +

    The behavior of the is and is not operators cannot be +customized; also they can be applied to any two objects and never raise an +exception.

    +

    Two more operations with the same syntactic priority, in and +not in, are supported by types that are iterable or +implement the __contains__() method.

    +
    +
    +

    Numeric Types — int, float, complex

    +

    There are three distinct numeric types: integers, floating +point numbers, and complex numbers. In addition, Booleans are a +subtype of integers. Integers have unlimited precision. Floating point +numbers are usually implemented using double in C; information +about the precision and internal representation of floating point +numbers for the machine on which your program is running is available +in sys.float_info. Complex numbers have a real and imaginary +part, which are each a floating point number. To extract these parts +from a complex number z, use z.real and z.imag. (The standard +library includes additional numeric types, fractions that hold +rationals, and decimal that hold floating-point numbers with +user-definable precision.)

    +

    Numbers are created by numeric literals or as the result of built-in functions +and operators. Unadorned integer literals (including hex, octal and binary +numbers) yield integers. Numeric literals containing a decimal point or an +exponent sign yield floating point numbers. Appending 'j' or 'J' to a +numeric literal yields an imaginary number (a complex number with a zero real +part) which you can add to an integer or float to get a complex number with real +and imaginary parts.

    +

    Python fully supports mixed arithmetic: when a binary arithmetic operator has +operands of different numeric types, the operand with the “narrower” type is +widened to that of the other, where integer is narrower than floating point, +which is narrower than complex. Comparisons between numbers of mixed type use +the same rule. 2 The constructors int(), float(), and +complex() can be used to produce numbers of a specific type.

    +

    All numeric types (except complex) support the following operations, sorted by +ascending priority (all numeric operations have a higher priority than +comparison operations):

    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Operation

    Result

    Notes

    Full documentation

    x + y

    sum of x and y

    x - y

    difference of x and y

    x * y

    product of x and y

    x / y

    quotient of x and y

    x // y

    floored quotient of x and +y

    (1)

    x % y

    remainder of x / y

    (2)

    -x

    x negated

    +x

    x unchanged

    abs(x)

    absolute value or magnitude of +x

    abs()

    int(x)

    x converted to integer

    (3)(6)

    int()

    float(x)

    x converted to floating point

    (4)(6)

    float()

    complex(re, im)

    a complex number with real part +re, imaginary part im. +im defaults to zero.

    (6)

    complex()

    c.conjugate()

    conjugate of the complex number +c

    divmod(x, y)

    the pair (x // y, x % y)

    (2)

    divmod()

    pow(x, y)

    x to the power y

    (5)

    pow()

    x ** y

    x to the power y

    (5)

    +

    Notes:

    +
      +
    1. Also referred to as integer division. The resultant value is a whole +integer, though the result’s type is not necessarily int. The result is +always rounded towards minus infinity: 1//2 is 0, (-1)//2 is +-1, 1//(-2) is -1, and (-1)//(-2) is 0.

    2. +
    3. Not for complex numbers. Instead convert to floats using abs() if +appropriate.

    4. +
    5. Conversion from floating point to integer may round or truncate +as in C; see functions math.floor() and math.ceil() for +well-defined conversions.

      +
    6. +
    7. float also accepts the strings “nan” and “inf” with an optional prefix “+” +or “-” for Not a Number (NaN) and positive or negative infinity.

    8. +
    9. Python defines pow(0, 0) and 0 ** 0 to be 1, as is common for +programming languages.

    10. +
    11. The numeric literals accepted include the digits 0 to 9 or any +Unicode equivalent (code points with the Nd property).

      +

      See http://www.unicode.org/Public/10.0.0/ucd/extracted/DerivedNumericType.txt +for a complete list of code points with the Nd property.

      +
    12. +
    +

    All numbers.Real types (int and float) also include +the following operations:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Operation

    Result

    math.trunc(x)

    x truncated to Integral

    round(x[, +n])

    x rounded to n digits, +rounding half to even. If n is +omitted, it defaults to 0.

    math.floor(x)

    the greatest Integral +<= x

    math.ceil(x)

    the least Integral >= x

    +

    For additional numeric operations see the math and cmath +modules.

    +
    +

    Bitwise Operations on Integer Types

    +

    Bitwise operations only make sense for integers. The result of bitwise +operations is calculated as though carried out in two’s complement with an +infinite number of sign bits.

    +

    The priorities of the binary bitwise operations are all lower than the numeric +operations and higher than the comparisons; the unary operation ~ has the +same priority as the other unary numeric operations (+ and -).

    +

    This table lists the bitwise operations sorted in ascending priority:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Operation

    Result

    Notes

    x | y

    bitwise or of x and +y

    (4)

    x ^ y

    bitwise exclusive or of +x and y

    (4)

    x & y

    bitwise and of x and +y

    (4)

    x << n

    x shifted left by n bits

    (1)(2)

    x >> n

    x shifted right by n bits

    (1)(3)

    ~x

    the bits of x inverted

    +

    Notes:

    +
      +
    1. Negative shift counts are illegal and cause a ValueError to be raised.

    2. +
    3. A left shift by n bits is equivalent to multiplication by pow(2, n) +without overflow check.

    4. +
    5. A right shift by n bits is equivalent to division by pow(2, n) without +overflow check.

    6. +
    7. Performing these calculations with at least one extra sign extension bit in +a finite two’s complement representation (a working bit-width of +1 + max(x.bit_length(), y.bit_length()) or more) is sufficient to get the +same result as if there were an infinite number of sign bits.

    8. +
    +
    +
    +

    Additional Methods on Integer Types

    +

    The int type implements the numbers.Integral abstract base +class. In addition, it provides a few more methods:

    +
    +
    +int.bit_length()
    +

    Return the number of bits necessary to represent an integer in binary, +excluding the sign and leading zeros:

    +
    >>> n = -37
    +>>> bin(n)
    +'-0b100101'
    +>>> n.bit_length()
    +6
    +
    +
    +

    More precisely, if x is nonzero, then x.bit_length() is the +unique positive integer k such that 2**(k-1) <= abs(x) < 2**k. +Equivalently, when abs(x) is small enough to have a correctly +rounded logarithm, then k = 1 + int(log(abs(x), 2)). +If x is zero, then x.bit_length() returns 0.

    +

    Equivalent to:

    +
    def bit_length(self):
    +    s = bin(self)       # binary representation:  bin(-37) --> '-0b100101'
    +    s = s.lstrip('-0b') # remove leading zeros and minus sign
    +    return len(s)       # len('100101') --> 6
    +
    +
    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +int.to_bytes(length, byteorder, *, signed=False)
    +

    Return an array of bytes representing an integer.

    +
    >>> (1024).to_bytes(2, byteorder='big')
    +b'\x04\x00'
    +>>> (1024).to_bytes(10, byteorder='big')
    +b'\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00'
    +>>> (-1024).to_bytes(10, byteorder='big', signed=True)
    +b'\xff\xff\xff\xff\xff\xff\xff\xff\xfc\x00'
    +>>> x = 1000
    +>>> x.to_bytes((x.bit_length() + 7) // 8, byteorder='little')
    +b'\xe8\x03'
    +
    +
    +

    The integer is represented using length bytes. An OverflowError +is raised if the integer is not representable with the given number of +bytes.

    +

    The byteorder argument determines the byte order used to represent the +integer. If byteorder is "big", the most significant byte is at the +beginning of the byte array. If byteorder is "little", the most +significant byte is at the end of the byte array. To request the native +byte order of the host system, use sys.byteorder as the byte order +value.

    +

    The signed argument determines whether two’s complement is used to +represent the integer. If signed is False and a negative integer is +given, an OverflowError is raised. The default value for signed +is False.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +classmethod int.from_bytes(bytes, byteorder, *, signed=False)
    +

    Return the integer represented by the given array of bytes.

    +
    >>> int.from_bytes(b'\x00\x10', byteorder='big')
    +16
    +>>> int.from_bytes(b'\x00\x10', byteorder='little')
    +4096
    +>>> int.from_bytes(b'\xfc\x00', byteorder='big', signed=True)
    +-1024
    +>>> int.from_bytes(b'\xfc\x00', byteorder='big', signed=False)
    +64512
    +>>> int.from_bytes([255, 0, 0], byteorder='big')
    +16711680
    +
    +
    +

    The argument bytes must either be a bytes-like object or an +iterable producing bytes.

    +

    The byteorder argument determines the byte order used to represent the +integer. If byteorder is "big", the most significant byte is at the +beginning of the byte array. If byteorder is "little", the most +significant byte is at the end of the byte array. To request the native +byte order of the host system, use sys.byteorder as the byte order +value.

    +

    The signed argument indicates whether two’s complement is used to +represent the integer.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +

    Additional Methods on Float

    +

    The float type implements the numbers.Real abstract base +class. float also has the following additional methods.

    +
    +
    +float.as_integer_ratio()
    +

    Return a pair of integers whose ratio is exactly equal to the +original float and with a positive denominator. Raises +OverflowError on infinities and a ValueError on +NaNs.

    +
    + +
    +
    +float.is_integer()
    +

    Return True if the float instance is finite with integral +value, and False otherwise:

    +
    >>> (-2.0).is_integer()
    +True
    +>>> (3.2).is_integer()
    +False
    +
    +
    +
    + +

    Two methods support conversion to +and from hexadecimal strings. Since Python’s floats are stored +internally as binary numbers, converting a float to or from a +decimal string usually involves a small rounding error. In +contrast, hexadecimal strings allow exact representation and +specification of floating-point numbers. This can be useful when +debugging, and in numerical work.

    +
    +
    +float.hex()
    +

    Return a representation of a floating-point number as a hexadecimal +string. For finite floating-point numbers, this representation +will always include a leading 0x and a trailing p and +exponent.

    +
    + +
    +
    +classmethod float.fromhex(s)
    +

    Class method to return the float represented by a hexadecimal +string s. The string s may have leading and trailing +whitespace.

    +
    + +

    Note that float.hex() is an instance method, while +float.fromhex() is a class method.

    +

    A hexadecimal string takes the form:

    +
    [sign] ['0x'] integer ['.' fraction] ['p' exponent]
    +
    +
    +

    where the optional sign may by either + or -, integer +and fraction are strings of hexadecimal digits, and exponent +is a decimal integer with an optional leading sign. Case is not +significant, and there must be at least one hexadecimal digit in +either the integer or the fraction. This syntax is similar to the +syntax specified in section 6.4.4.2 of the C99 standard, and also to +the syntax used in Java 1.5 onwards. In particular, the output of +float.hex() is usable as a hexadecimal floating-point literal in +C or Java code, and hexadecimal strings produced by C’s %a format +character or Java’s Double.toHexString are accepted by +float.fromhex().

    +

    Note that the exponent is written in decimal rather than hexadecimal, +and that it gives the power of 2 by which to multiply the coefficient. +For example, the hexadecimal string 0x3.a7p10 represents the +floating-point number (3 + 10./16 + 7./16**2) * 2.0**10, or +3740.0:

    +
    >>> float.fromhex('0x3.a7p10')
    +3740.0
    +
    +
    +

    Applying the reverse conversion to 3740.0 gives a different +hexadecimal string representing the same number:

    +
    >>> float.hex(3740.0)
    +'0x1.d380000000000p+11'
    +
    +
    +
    +
    +

    Hashing of numeric types

    +

    For numbers x and y, possibly of different types, it’s a requirement +that hash(x) == hash(y) whenever x == y (see the __hash__() +method documentation for more details). For ease of implementation and +efficiency across a variety of numeric types (including int, +float, decimal.Decimal and fractions.Fraction) +Python’s hash for numeric types is based on a single mathematical function +that’s defined for any rational number, and hence applies to all instances of +int and fractions.Fraction, and all finite instances of +float and decimal.Decimal. Essentially, this function is +given by reduction modulo P for a fixed prime P. The value of P is +made available to Python as the modulus attribute of +sys.hash_info.

    +
    +

    CPython implementation detail: Currently, the prime used is P = 2**31 - 1 on machines with 32-bit C +longs and P = 2**61 - 1 on machines with 64-bit C longs.

    +
    +

    Here are the rules in detail:

    +
      +
    • If x = m / n is a nonnegative rational number and n is not divisible +by P, define hash(x) as m * invmod(n, P) % P, where invmod(n, +P) gives the inverse of n modulo P.

    • +
    • If x = m / n is a nonnegative rational number and n is +divisible by P (but m is not) then n has no inverse +modulo P and the rule above doesn’t apply; in this case define +hash(x) to be the constant value sys.hash_info.inf.

    • +
    • If x = m / n is a negative rational number define hash(x) +as -hash(-x). If the resulting hash is -1, replace it with +-2.

    • +
    • The particular values sys.hash_info.inf, -sys.hash_info.inf +and sys.hash_info.nan are used as hash values for positive +infinity, negative infinity, or nans (respectively). (All hashable +nans have the same hash value.)

    • +
    • For a complex number z, the hash values of the real +and imaginary parts are combined by computing hash(z.real) + +sys.hash_info.imag * hash(z.imag), reduced modulo +2**sys.hash_info.width so that it lies in +range(-2**(sys.hash_info.width - 1), 2**(sys.hash_info.width - +1)). Again, if the result is -1, it’s replaced with -2.

    • +
    +

    To clarify the above rules, here’s some example Python code, +equivalent to the built-in hash, for computing the hash of a rational +number, float, or complex:

    +
    import sys, math
    +
    +def hash_fraction(m, n):
    +    """Compute the hash of a rational number m / n.
    +
    +    Assumes m and n are integers, with n positive.
    +    Equivalent to hash(fractions.Fraction(m, n)).
    +
    +    """
    +    P = sys.hash_info.modulus
    +    # Remove common factors of P.  (Unnecessary if m and n already coprime.)
    +    while m % P == n % P == 0:
    +        m, n = m // P, n // P
    +
    +    if n % P == 0:
    +        hash_value = sys.hash_info.inf
    +    else:
    +        # Fermat's Little Theorem: pow(n, P-1, P) is 1, so
    +        # pow(n, P-2, P) gives the inverse of n modulo P.
    +        hash_value = (abs(m) % P) * pow(n, P - 2, P) % P
    +    if m < 0:
    +        hash_value = -hash_value
    +    if hash_value == -1:
    +        hash_value = -2
    +    return hash_value
    +
    +def hash_float(x):
    +    """Compute the hash of a float x."""
    +
    +    if math.isnan(x):
    +        return sys.hash_info.nan
    +    elif math.isinf(x):
    +        return sys.hash_info.inf if x > 0 else -sys.hash_info.inf
    +    else:
    +        return hash_fraction(*x.as_integer_ratio())
    +
    +def hash_complex(z):
    +    """Compute the hash of a complex number z."""
    +
    +    hash_value = hash_float(z.real) + sys.hash_info.imag * hash_float(z.imag)
    +    # do a signed reduction modulo 2**sys.hash_info.width
    +    M = 2**(sys.hash_info.width - 1)
    +    hash_value = (hash_value & (M - 1)) - (hash_value & M)
    +    if hash_value == -1:
    +        hash_value = -2
    +    return hash_value
    +
    +
    +
    +
    +
    +

    Iterator Types

    +

    Python supports a concept of iteration over containers. This is implemented +using two distinct methods; these are used to allow user-defined classes to +support iteration. Sequences, described below in more detail, always support +the iteration methods.

    +

    One method needs to be defined for container objects to provide iteration +support:

    +
    +
    +container.__iter__()
    +

    Return an iterator object. The object is required to support the iterator +protocol described below. If a container supports different types of +iteration, additional methods can be provided to specifically request +iterators for those iteration types. (An example of an object supporting +multiple forms of iteration would be a tree structure which supports both +breadth-first and depth-first traversal.) This method corresponds to the +tp_iter slot of the type structure for Python objects in the Python/C +API.

    +
    + +

    The iterator objects themselves are required to support the following two +methods, which together form the iterator protocol:

    +
    +
    +iterator.__iter__()
    +

    Return the iterator object itself. This is required to allow both containers +and iterators to be used with the for and in statements. +This method corresponds to the tp_iter slot of the type structure for +Python objects in the Python/C API.

    +
    + +
    +
    +iterator.__next__()
    +

    Return the next item from the container. If there are no further items, raise +the StopIteration exception. This method corresponds to the +tp_iternext slot of the type structure for Python objects in the +Python/C API.

    +
    + +

    Python defines several iterator objects to support iteration over general and +specific sequence types, dictionaries, and other more specialized forms. The +specific types are not important beyond their implementation of the iterator +protocol.

    +

    Once an iterator’s __next__() method raises +StopIteration, it must continue to do so on subsequent calls. +Implementations that do not obey this property are deemed broken.

    +
    +

    Generator Types

    +

    Python’s generators provide a convenient way to implement the iterator +protocol. If a container object’s __iter__() method is implemented as a +generator, it will automatically return an iterator object (technically, a +generator object) supplying the __iter__() and __next__() +methods. +More information about generators can be found in the documentation for +the yield expression.

    +
    +
    +
    +

    Sequence Types — list, tuple, range

    +

    There are three basic sequence types: lists, tuples, and range objects. +Additional sequence types tailored for processing of +binary data and text strings are +described in dedicated sections.

    +
    +

    Common Sequence Operations

    +

    The operations in the following table are supported by most sequence types, +both mutable and immutable. The collections.abc.Sequence ABC is +provided to make it easier to correctly implement these operations on +custom sequence types.

    +

    This table lists the sequence operations sorted in ascending priority. In the +table, s and t are sequences of the same type, n, i, j and k are +integers and x is an arbitrary object that meets any type and value +restrictions imposed by s.

    +

    The in and not in operations have the same priorities as the +comparison operations. The + (concatenation) and * (repetition) +operations have the same priority as the corresponding numeric operations. 3

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Operation

    Result

    Notes

    x in s

    True if an item of s is +equal to x, else False

    (1)

    x not in s

    False if an item of s is +equal to x, else True

    (1)

    s + t

    the concatenation of s and +t

    (6)(7)

    s * n or +n * s

    equivalent to adding s to +itself n times

    (2)(7)

    s[i]

    ith item of s, origin 0

    (3)

    s[i:j]

    slice of s from i to j

    (3)(4)

    s[i:j:k]

    slice of s from i to j +with step k

    (3)(5)

    len(s)

    length of s

    min(s)

    smallest item of s

    max(s)

    largest item of s

    s.index(x[, i[, j]])

    index of the first occurrence +of x in s (at or after +index i and before index j)

    (8)

    s.count(x)

    total number of occurrences of +x in s

    +

    Sequences of the same type also support comparisons. In particular, tuples +and lists are compared lexicographically by comparing corresponding elements. +This means that to compare equal, every element must compare equal and the +two sequences must be of the same type and have the same length. (For full +details see Comparisons in the language reference.)

    +

    Notes:

    +
      +
    1. While the in and not in operations are used only for simple +containment testing in the general case, some specialised sequences +(such as str, bytes and bytearray) also use +them for subsequence testing:

      +
      >>> "gg" in "eggs"
      +True
      +
      +
      +
    2. +
    3. Values of n less than 0 are treated as 0 (which yields an empty +sequence of the same type as s). Note that items in the sequence s +are not copied; they are referenced multiple times. This often haunts +new Python programmers; consider:

      +
      >>> lists = [[]] * 3
      +>>> lists
      +[[], [], []]
      +>>> lists[0].append(3)
      +>>> lists
      +[[3], [3], [3]]
      +
      +
      +

      What has happened is that [[]] is a one-element list containing an empty +list, so all three elements of [[]] * 3 are references to this single empty +list. Modifying any of the elements of lists modifies this single list. +You can create a list of different lists this way:

      +
      >>> lists = [[] for i in range(3)]
      +>>> lists[0].append(3)
      +>>> lists[1].append(5)
      +>>> lists[2].append(7)
      +>>> lists
      +[[3], [5], [7]]
      +
      +
      +

      Further explanation is available in the FAQ entry +How do I create a multidimensional list?.

      +
    4. +
    5. If i or j is negative, the index is relative to the end of sequence s: +len(s) + i or len(s) + j is substituted. But note that -0 is +still 0.

    6. +
    7. The slice of s from i to j is defined as the sequence of items with index +k such that i <= k < j. If i or j is greater than len(s), use +len(s). If i is omitted or None, use 0. If j is omitted or +None, use len(s). If i is greater than or equal to j, the slice is +empty.

    8. +
    9. The slice of s from i to j with step k is defined as the sequence of +items with index x = i + n*k such that 0 <= n < (j-i)/k. In other words, +the indices are i, i+k, i+2*k, i+3*k and so on, stopping when +j is reached (but never including j). When k is positive, +i and j are reduced to len(s) if they are greater. +When k is negative, i and j are reduced to len(s) - 1 if +they are greater. If i or j are omitted or None, they become +“end” values (which end depends on the sign of k). Note, k cannot be zero. +If k is None, it is treated like 1.

    10. +
    11. Concatenating immutable sequences always results in a new object. This +means that building up a sequence by repeated concatenation will have a +quadratic runtime cost in the total sequence length. To get a linear +runtime cost, you must switch to one of the alternatives below:

      +
        +
      • if concatenating str objects, you can build a list and use +str.join() at the end or else write to an io.StringIO +instance and retrieve its value when complete

      • +
      • if concatenating bytes objects, you can similarly use +bytes.join() or io.BytesIO, or you can do in-place +concatenation with a bytearray object. bytearray +objects are mutable and have an efficient overallocation mechanism

      • +
      • if concatenating tuple objects, extend a list instead

      • +
      • for other types, investigate the relevant class documentation

      • +
      +
    12. +
    13. Some sequence types (such as range) only support item sequences +that follow specific patterns, and hence don’t support sequence +concatenation or repetition.

    14. +
    15. index raises ValueError when x is not found in s. +Not all implementations support passing the additional arguments i and j. +These arguments allow efficient searching of subsections of the sequence. Passing +the extra arguments is roughly equivalent to using s[i:j].index(x), only +without copying any data and with the returned index being relative to +the start of the sequence rather than the start of the slice.

    16. +
    +
    +
    +

    Immutable Sequence Types

    +

    The only operation that immutable sequence types generally implement that is +not also implemented by mutable sequence types is support for the hash() +built-in.

    +

    This support allows immutable sequences, such as tuple instances, to +be used as dict keys and stored in set and frozenset +instances.

    +

    Attempting to hash an immutable sequence that contains unhashable values will +result in TypeError.

    +
    +
    +

    Mutable Sequence Types

    +

    The operations in the following table are defined on mutable sequence types. +The collections.abc.MutableSequence ABC is provided to make it +easier to correctly implement these operations on custom sequence types.

    +

    In the table s is an instance of a mutable sequence type, t is any +iterable object and x is an arbitrary object that meets any type +and value restrictions imposed by s (for example, bytearray only +accepts integers that meet the value restriction 0 <= x <= 255).

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Operation

    Result

    Notes

    s[i] = x

    item i of s is replaced by +x

    s[i:j] = t

    slice of s from i to j +is replaced by the contents of +the iterable t

    del s[i:j]

    same as s[i:j] = []

    s[i:j:k] = t

    the elements of s[i:j:k] +are replaced by those of t

    (1)

    del s[i:j:k]

    removes the elements of +s[i:j:k] from the list

    s.append(x)

    appends x to the end of the +sequence (same as +s[len(s):len(s)] = [x])

    s.clear()

    removes all items from s +(same as del s[:])

    (5)

    s.copy()

    creates a shallow copy of s +(same as s[:])

    (5)

    s.extend(t) or +s += t

    extends s with the +contents of t (for the +most part the same as +s[len(s):len(s)] = t)

    s *= n

    updates s with its contents +repeated n times

    (6)

    s.insert(i, x)

    inserts x into s at the +index given by i +(same as s[i:i] = [x])

    s.pop([i])

    retrieves the item at i and +also removes it from s

    (2)

    s.remove(x)

    remove the first item from s +where s[i] is equal to x

    (3)

    s.reverse()

    reverses the items of s in +place

    (4)

    +

    Notes:

    +
      +
    1. t must have the same length as the slice it is replacing.

    2. +
    3. The optional argument i defaults to -1, so that by default the last +item is removed and returned.

    4. +
    5. remove raises ValueError when x is not found in s.

    6. +
    7. The reverse() method modifies the sequence in place for economy of +space when reversing a large sequence. To remind users that it operates by +side effect, it does not return the reversed sequence.

    8. +
    9. clear() and copy() are included for consistency with the +interfaces of mutable containers that don’t support slicing operations +(such as dict and set)

      +
      +

      New in version 3.3: clear() and copy() methods.

      +
      +
    10. +
    11. The value n is an integer, or an object implementing +__index__(). Zero and negative values of n clear +the sequence. Items in the sequence are not copied; they are referenced +multiple times, as explained for s * n under Common Sequence Operations.

    12. +
    +
    +
    +

    Lists

    +

    Lists are mutable sequences, typically used to store collections of +homogeneous items (where the precise degree of similarity will vary by +application).

    +
    +
    +class list([iterable])
    +

    Lists may be constructed in several ways:

    +
      +
    • Using a pair of square brackets to denote the empty list: []

    • +
    • Using square brackets, separating items with commas: [a], [a, b, c]

    • +
    • Using a list comprehension: [x for x in iterable]

    • +
    • Using the type constructor: list() or list(iterable)

    • +
    +

    The constructor builds a list whose items are the same and in the same +order as iterable’s items. iterable may be either a sequence, a +container that supports iteration, or an iterator object. If iterable +is already a list, a copy is made and returned, similar to iterable[:]. +For example, list('abc') returns ['a', 'b', 'c'] and +list( (1, 2, 3) ) returns [1, 2, 3]. +If no argument is given, the constructor creates a new empty list, [].

    +

    Many other operations also produce lists, including the sorted() +built-in.

    +

    Lists implement all of the common and +mutable sequence operations. Lists also provide the +following additional method:

    +
    +
    +sort(*, key=None, reverse=False)
    +

    This method sorts the list in place, using only < comparisons +between items. Exceptions are not suppressed - if any comparison operations +fail, the entire sort operation will fail (and the list will likely be left +in a partially modified state).

    +

    sort() accepts two arguments that can only be passed by keyword +(keyword-only arguments):

    +

    key specifies a function of one argument that is used to extract a +comparison key from each list element (for example, key=str.lower). +The key corresponding to each item in the list is calculated once and +then used for the entire sorting process. The default value of None +means that list items are sorted directly without calculating a separate +key value.

    +

    The functools.cmp_to_key() utility is available to convert a 2.x +style cmp function to a key function.

    +

    reverse is a boolean value. If set to True, then the list elements +are sorted as if each comparison were reversed.

    +

    This method modifies the sequence in place for economy of space when +sorting a large sequence. To remind users that it operates by side +effect, it does not return the sorted sequence (use sorted() to +explicitly request a new sorted list instance).

    +

    The sort() method is guaranteed to be stable. A sort is stable if it +guarantees not to change the relative order of elements that compare equal +— this is helpful for sorting in multiple passes (for example, sort by +department, then by salary grade).

    +
    +

    CPython implementation detail: While a list is being sorted, the effect of attempting to mutate, or even +inspect, the list is undefined. The C implementation of Python makes the +list appear empty for the duration, and raises ValueError if it can +detect that the list has been mutated during a sort.

    +
    +
    + +
    + +
    +
    +

    Tuples

    +

    Tuples are immutable sequences, typically used to store collections of +heterogeneous data (such as the 2-tuples produced by the enumerate() +built-in). Tuples are also used for cases where an immutable sequence of +homogeneous data is needed (such as allowing storage in a set or +dict instance).

    +
    +
    +class tuple([iterable])
    +

    Tuples may be constructed in a number of ways:

    +
      +
    • Using a pair of parentheses to denote the empty tuple: ()

    • +
    • Using a trailing comma for a singleton tuple: a, or (a,)

    • +
    • Separating items with commas: a, b, c or (a, b, c)

    • +
    • Using the tuple() built-in: tuple() or tuple(iterable)

    • +
    +

    The constructor builds a tuple whose items are the same and in the same +order as iterable’s items. iterable may be either a sequence, a +container that supports iteration, or an iterator object. If iterable +is already a tuple, it is returned unchanged. For example, +tuple('abc') returns ('a', 'b', 'c') and +tuple( [1, 2, 3] ) returns (1, 2, 3). +If no argument is given, the constructor creates a new empty tuple, ().

    +

    Note that it is actually the comma which makes a tuple, not the parentheses. +The parentheses are optional, except in the empty tuple case, or +when they are needed to avoid syntactic ambiguity. For example, +f(a, b, c) is a function call with three arguments, while +f((a, b, c)) is a function call with a 3-tuple as the sole argument.

    +

    Tuples implement all of the common sequence +operations.

    +
    + +

    For heterogeneous collections of data where access by name is clearer than +access by index, collections.namedtuple() may be a more appropriate +choice than a simple tuple object.

    +
    +
    +

    Ranges

    +

    The range type represents an immutable sequence of numbers and is +commonly used for looping a specific number of times in for +loops.

    +
    +
    +class range(stop)
    +
    +class range(start, stop[, step])
    +

    The arguments to the range constructor must be integers (either built-in +int or any object that implements the __index__ special +method). If the step argument is omitted, it defaults to 1. +If the start argument is omitted, it defaults to 0. +If step is zero, ValueError is raised.

    +

    For a positive step, the contents of a range r are determined by the +formula r[i] = start + step*i where i >= 0 and +r[i] < stop.

    +

    For a negative step, the contents of the range are still determined by +the formula r[i] = start + step*i, but the constraints are i >= 0 +and r[i] > stop.

    +

    A range object will be empty if r[0] does not meet the value +constraint. Ranges do support negative indices, but these are interpreted +as indexing from the end of the sequence determined by the positive +indices.

    +

    Ranges containing absolute values larger than sys.maxsize are +permitted but some features (such as len()) may raise +OverflowError.

    +

    Range examples:

    +
    >>> list(range(10))
    +[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
    +>>> list(range(1, 11))
    +[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
    +>>> list(range(0, 30, 5))
    +[0, 5, 10, 15, 20, 25]
    +>>> list(range(0, 10, 3))
    +[0, 3, 6, 9]
    +>>> list(range(0, -10, -1))
    +[0, -1, -2, -3, -4, -5, -6, -7, -8, -9]
    +>>> list(range(0))
    +[]
    +>>> list(range(1, 0))
    +[]
    +
    +
    +

    Ranges implement all of the common sequence operations +except concatenation and repetition (due to the fact that range objects can +only represent sequences that follow a strict pattern and repetition and +concatenation will usually violate that pattern).

    +
    +
    +start
    +

    The value of the start parameter (or 0 if the parameter was +not supplied)

    +
    + +
    +
    +stop
    +

    The value of the stop parameter

    +
    + +
    +
    +step
    +

    The value of the step parameter (or 1 if the parameter was +not supplied)

    +
    + +
    + +

    The advantage of the range type over a regular list or +tuple is that a range object will always take the same +(small) amount of memory, no matter the size of the range it represents (as it +only stores the start, stop and step values, calculating individual +items and subranges as needed).

    +

    Range objects implement the collections.abc.Sequence ABC, and provide +features such as containment tests, element index lookup, slicing and +support for negative indices (see Sequence Types — list, tuple, range):

    +
    >>> r = range(0, 20, 2)
    +>>> r
    +range(0, 20, 2)
    +>>> 11 in r
    +False
    +>>> 10 in r
    +True
    +>>> r.index(10)
    +5
    +>>> r[5]
    +10
    +>>> r[:5]
    +range(0, 10, 2)
    +>>> r[-1]
    +18
    +
    +
    +

    Testing range objects for equality with == and != compares +them as sequences. That is, two range objects are considered equal if +they represent the same sequence of values. (Note that two range +objects that compare equal might have different start, +stop and step attributes, for example +range(0) == range(2, 1, 3) or range(0, 3, 2) == range(0, 4, 2).)

    +
    +

    Changed in version 3.2: Implement the Sequence ABC. +Support slicing and negative indices. +Test int objects for membership in constant time instead of +iterating through all items.

    +
    +
    +

    Changed in version 3.3: Define ‘==’ and ‘!=’ to compare range objects based on the +sequence of values they define (instead of comparing based on +object identity).

    +
    +
    +

    New in version 3.3: The start, stop and step +attributes.

    +
    +
    +

    See also

    +
      +
    • The linspace recipe +shows how to implement a lazy version of range suitable for floating +point applications.

    • +
    +
    +
    +
    +
    +

    Text Sequence Type — str

    +

    Textual data in Python is handled with str objects, or strings. +Strings are immutable +sequences of Unicode code points. String literals are +written in a variety of ways:

    +
      +
    • Single quotes: 'allows embedded "double" quotes'

    • +
    • Double quotes: "allows embedded 'single' quotes".

    • +
    • Triple quoted: '''Three single quotes''', """Three double quotes"""

    • +
    +

    Triple quoted strings may span multiple lines - all associated whitespace will +be included in the string literal.

    +

    String literals that are part of a single expression and have only whitespace +between them will be implicitly converted to a single string literal. That +is, ("spam " "eggs") == "spam eggs".

    +

    See String and Bytes literals for more about the various forms of string literal, +including supported escape sequences, and the r (“raw”) prefix that +disables most escape sequence processing.

    +

    Strings may also be created from other objects using the str +constructor.

    +

    Since there is no separate “character” type, indexing a string produces +strings of length 1. That is, for a non-empty string s, s[0] == s[0:1].

    +

    There is also no mutable string type, but str.join() or +io.StringIO can be used to efficiently construct strings from +multiple fragments.

    +
    +

    Changed in version 3.3: For backwards compatibility with the Python 2 series, the u prefix is +once again permitted on string literals. It has no effect on the meaning +of string literals and cannot be combined with the r prefix.

    +
    +
    +
    +class str(object='')
    +
    +class str(object=b'', encoding='utf-8', errors='strict')
    +

    Return a string version of object. If object is not +provided, returns the empty string. Otherwise, the behavior of str() +depends on whether encoding or errors is given, as follows.

    +

    If neither encoding nor errors is given, str(object) returns +object.__str__(), which is the “informal” or nicely +printable string representation of object. For string objects, this is +the string itself. If object does not have a __str__() +method, then str() falls back to returning +repr(object).

    +

    If at least one of encoding or errors is given, object should be a +bytes-like object (e.g. bytes or bytearray). In +this case, if object is a bytes (or bytearray) object, +then str(bytes, encoding, errors) is equivalent to +bytes.decode(encoding, errors). Otherwise, the bytes +object underlying the buffer object is obtained before calling +bytes.decode(). See Binary Sequence Types — bytes, bytearray, memoryview and +Buffer Protocol for information on buffer objects.

    +

    Passing a bytes object to str() without the encoding +or errors arguments falls under the first case of returning the informal +string representation (see also the -b command-line option to +Python). For example:

    +
    >>> str(b'Zoot!')
    +"b'Zoot!'"
    +
    +
    +

    For more information on the str class and its methods, see +Text Sequence Type — str and the String Methods section below. To output +formatted strings, see the Formatted string literals and Format String Syntax +sections. In addition, see the Text Processing Services section.

    +
    + +
    +

    String Methods

    +

    Strings implement all of the common sequence +operations, along with the additional methods described below.

    +

    Strings also support two styles of string formatting, one providing a large +degree of flexibility and customization (see str.format(), +Format String Syntax and Custom String Formatting) and the other based on C +printf style formatting that handles a narrower range of types and is +slightly harder to use correctly, but is often faster for the cases it can +handle (printf-style String Formatting).

    +

    The Text Processing Services section of the standard library covers a number of +other modules that provide various text related utilities (including regular +expression support in the re module).

    +
    +
    +str.capitalize()
    +

    Return a copy of the string with its first character capitalized and the +rest lowercased.

    +
    + +
    +
    +str.casefold()
    +

    Return a casefolded copy of the string. Casefolded strings may be used for +caseless matching.

    +

    Casefolding is similar to lowercasing but more aggressive because it is +intended to remove all case distinctions in a string. For example, the German +lowercase letter 'ß' is equivalent to "ss". Since it is already +lowercase, lower() would do nothing to 'ß'; casefold() +converts it to "ss".

    +

    The casefolding algorithm is described in section 3.13 of the Unicode +Standard.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +str.center(width[, fillchar])
    +

    Return centered in a string of length width. Padding is done using the +specified fillchar (default is an ASCII space). The original string is +returned if width is less than or equal to len(s).

    +
    + +
    +
    +str.count(sub[, start[, end]])
    +

    Return the number of non-overlapping occurrences of substring sub in the +range [start, end]. Optional arguments start and end are +interpreted as in slice notation.

    +
    + +
    +
    +str.encode(encoding="utf-8", errors="strict")
    +

    Return an encoded version of the string as a bytes object. Default encoding +is 'utf-8'. errors may be given to set a different error handling scheme. +The default for errors is 'strict', meaning that encoding errors raise +a UnicodeError. Other possible +values are 'ignore', 'replace', 'xmlcharrefreplace', +'backslashreplace' and any other name registered via +codecs.register_error(), see section Error Handlers. For a +list of possible encodings, see section Standard Encodings.

    +
    +

    Changed in version 3.1: Support for keyword arguments added.

    +
    +
    + +
    +
    +str.endswith(suffix[, start[, end]])
    +

    Return True if the string ends with the specified suffix, otherwise return +False. suffix can also be a tuple of suffixes to look for. With optional +start, test beginning at that position. With optional end, stop comparing +at that position.

    +
    + +
    +
    +str.expandtabs(tabsize=8)
    +

    Return a copy of the string where all tab characters are replaced by one or +more spaces, depending on the current column and the given tab size. Tab +positions occur every tabsize characters (default is 8, giving tab +positions at columns 0, 8, 16 and so on). To expand the string, the current +column is set to zero and the string is examined character by character. If +the character is a tab (\t), one or more space characters are inserted +in the result until the current column is equal to the next tab position. +(The tab character itself is not copied.) If the character is a newline +(\n) or return (\r), it is copied and the current column is reset to +zero. Any other character is copied unchanged and the current column is +incremented by one regardless of how the character is represented when +printed.

    +
    >>> '01\t012\t0123\t01234'.expandtabs()
    +'01      012     0123    01234'
    +>>> '01\t012\t0123\t01234'.expandtabs(4)
    +'01  012 0123    01234'
    +
    +
    +
    + +
    +
    +str.find(sub[, start[, end]])
    +

    Return the lowest index in the string where substring sub is found within +the slice s[start:end]. Optional arguments start and end are +interpreted as in slice notation. Return -1 if sub is not found.

    +
    +

    Note

    +

    The find() method should be used only if you need to know the +position of sub. To check if sub is a substring or not, use the +in operator:

    +
    >>> 'Py' in 'Python'
    +True
    +
    +
    +
    +
    + +
    +
    +str.format(*args, **kwargs)
    +

    Perform a string formatting operation. The string on which this method is +called can contain literal text or replacement fields delimited by braces +{}. Each replacement field contains either the numeric index of a +positional argument, or the name of a keyword argument. Returns a copy of +the string where each replacement field is replaced with the string value of +the corresponding argument.

    +
    >>> "The sum of 1 + 2 is {0}".format(1+2)
    +'The sum of 1 + 2 is 3'
    +
    +
    +

    See Format String Syntax for a description of the various formatting options +that can be specified in format strings.

    +
    +

    Note

    +

    When formatting a number (int, float, complex, +decimal.Decimal and subclasses) with the n type +(ex: '{:n}'.format(1234)), the function temporarily sets the +LC_CTYPE locale to the LC_NUMERIC locale to decode +decimal_point and thousands_sep fields of localeconv() if +they are non-ASCII or longer than 1 byte, and the LC_NUMERIC locale is +different than the LC_CTYPE locale. This temporary change affects +other threads.

    +
    +
    +

    Changed in version 3.7: When formatting a number with the n type, the function sets +temporarily the LC_CTYPE locale to the LC_NUMERIC locale in some +cases.

    +
    +
    + +
    +
    +str.format_map(mapping)
    +

    Similar to str.format(**mapping), except that mapping is +used directly and not copied to a dict. This is useful +if for example mapping is a dict subclass:

    +
    >>> class Default(dict):
    +...     def __missing__(self, key):
    +...         return key
    +...
    +>>> '{name} was born in {country}'.format_map(Default(name='Guido'))
    +'Guido was born in country'
    +
    +
    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +str.index(sub[, start[, end]])
    +

    Like find(), but raise ValueError when the substring is +not found.

    +
    + +
    +
    +str.isalnum()
    +

    Return true if all characters in the string are alphanumeric and there is at +least one character, false otherwise. A character c is alphanumeric if one +of the following returns True: c.isalpha(), c.isdecimal(), +c.isdigit(), or c.isnumeric().

    +
    + +
    +
    +str.isalpha()
    +

    Return true if all characters in the string are alphabetic and there is at least +one character, false otherwise. Alphabetic characters are those characters defined +in the Unicode character database as “Letter”, i.e., those with general category +property being one of “Lm”, “Lt”, “Lu”, “Ll”, or “Lo”. Note that this is different +from the “Alphabetic” property defined in the Unicode Standard.

    +
    + +
    +
    +str.isascii()
    +

    Return true if the string is empty or all characters in the string are ASCII, +false otherwise. +ASCII characters have code points in the range U+0000-U+007F.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +str.isdecimal()
    +

    Return true if all characters in the string are decimal +characters and there is at least one character, false +otherwise. Decimal characters are those that can be used to form +numbers in base 10, e.g. U+0660, ARABIC-INDIC DIGIT +ZERO. Formally a decimal character is a character in the Unicode +General Category “Nd”.

    +
    + +
    +
    +str.isdigit()
    +

    Return true if all characters in the string are digits and there is at least one +character, false otherwise. Digits include decimal characters and digits that need +special handling, such as the compatibility superscript digits. +This covers digits which cannot be used to form numbers in base 10, +like the Kharosthi numbers. Formally, a digit is a character that has the +property value Numeric_Type=Digit or Numeric_Type=Decimal.

    +
    + +
    +
    +str.isidentifier()
    +

    Return true if the string is a valid identifier according to the language +definition, section Identifiers and keywords.

    +

    Use keyword.iskeyword() to test for reserved identifiers such as +def and class.

    +
    + +
    +
    +str.islower()
    +

    Return true if all cased characters 4 in the string are lowercase and +there is at least one cased character, false otherwise.

    +
    + +
    +
    +str.isnumeric()
    +

    Return true if all characters in the string are numeric +characters, and there is at least one character, false +otherwise. Numeric characters include digit characters, and all characters +that have the Unicode numeric value property, e.g. U+2155, +VULGAR FRACTION ONE FIFTH. Formally, numeric characters are those with the property +value Numeric_Type=Digit, Numeric_Type=Decimal or Numeric_Type=Numeric.

    +
    + +
    +
    +str.isprintable()
    +

    Return true if all characters in the string are printable or the string is +empty, false otherwise. Nonprintable characters are those characters defined +in the Unicode character database as “Other” or “Separator”, excepting the +ASCII space (0x20) which is considered printable. (Note that printable +characters in this context are those which should not be escaped when +repr() is invoked on a string. It has no bearing on the handling of +strings written to sys.stdout or sys.stderr.)

    +
    + +
    +
    +str.isspace()
    +

    Return true if there are only whitespace characters in the string and there is +at least one character, false otherwise. Whitespace characters are those +characters defined in the Unicode character database as “Other” or “Separator” +and those with bidirectional property being one of “WS”, “B”, or “S”.

    +
    + +
    +
    +str.istitle()
    +

    Return true if the string is a titlecased string and there is at least one +character, for example uppercase characters may only follow uncased characters +and lowercase characters only cased ones. Return false otherwise.

    +
    + +
    +
    +str.isupper()
    +

    Return true if all cased characters 4 in the string are uppercase and +there is at least one cased character, false otherwise.

    +
    + +
    +
    +str.join(iterable)
    +

    Return a string which is the concatenation of the strings in iterable. +A TypeError will be raised if there are any non-string values in +iterable, including bytes objects. The separator between +elements is the string providing this method.

    +
    + +
    +
    +str.ljust(width[, fillchar])
    +

    Return the string left justified in a string of length width. Padding is +done using the specified fillchar (default is an ASCII space). The +original string is returned if width is less than or equal to len(s).

    +
    + +
    +
    +str.lower()
    +

    Return a copy of the string with all the cased characters 4 converted to +lowercase.

    +

    The lowercasing algorithm used is described in section 3.13 of the Unicode +Standard.

    +
    + +
    +
    +str.lstrip([chars])
    +

    Return a copy of the string with leading characters removed. The chars +argument is a string specifying the set of characters to be removed. If omitted +or None, the chars argument defaults to removing whitespace. The chars +argument is not a prefix; rather, all combinations of its values are stripped:

    +
    >>> '   spacious   '.lstrip()
    +'spacious   '
    +>>> 'www.example.com'.lstrip('cmowz.')
    +'example.com'
    +
    +
    +
    + +
    +
    +static str.maketrans(x[, y[, z]])
    +

    This static method returns a translation table usable for str.translate().

    +

    If there is only one argument, it must be a dictionary mapping Unicode +ordinals (integers) or characters (strings of length 1) to Unicode ordinals, +strings (of arbitrary lengths) or None. Character keys will then be +converted to ordinals.

    +

    If there are two arguments, they must be strings of equal length, and in the +resulting dictionary, each character in x will be mapped to the character at +the same position in y. If there is a third argument, it must be a string, +whose characters will be mapped to None in the result.

    +
    + +
    +
    +str.partition(sep)
    +

    Split the string at the first occurrence of sep, and return a 3-tuple +containing the part before the separator, the separator itself, and the part +after the separator. If the separator is not found, return a 3-tuple containing +the string itself, followed by two empty strings.

    +
    + +
    +
    +str.replace(old, new[, count])
    +

    Return a copy of the string with all occurrences of substring old replaced by +new. If the optional argument count is given, only the first count +occurrences are replaced.

    +
    + +
    +
    +str.rfind(sub[, start[, end]])
    +

    Return the highest index in the string where substring sub is found, such +that sub is contained within s[start:end]. Optional arguments start +and end are interpreted as in slice notation. Return -1 on failure.

    +
    + +
    +
    +str.rindex(sub[, start[, end]])
    +

    Like rfind() but raises ValueError when the substring sub is not +found.

    +
    + +
    +
    +str.rjust(width[, fillchar])
    +

    Return the string right justified in a string of length width. Padding is +done using the specified fillchar (default is an ASCII space). The +original string is returned if width is less than or equal to len(s).

    +
    + +
    +
    +str.rpartition(sep)
    +

    Split the string at the last occurrence of sep, and return a 3-tuple +containing the part before the separator, the separator itself, and the part +after the separator. If the separator is not found, return a 3-tuple containing +two empty strings, followed by the string itself.

    +
    + +
    +
    +str.rsplit(sep=None, maxsplit=-1)
    +

    Return a list of the words in the string, using sep as the delimiter string. +If maxsplit is given, at most maxsplit splits are done, the rightmost +ones. If sep is not specified or None, any whitespace string is a +separator. Except for splitting from the right, rsplit() behaves like +split() which is described in detail below.

    +
    + +
    +
    +str.rstrip([chars])
    +

    Return a copy of the string with trailing characters removed. The chars +argument is a string specifying the set of characters to be removed. If omitted +or None, the chars argument defaults to removing whitespace. The chars +argument is not a suffix; rather, all combinations of its values are stripped:

    +
    >>> '   spacious   '.rstrip()
    +'   spacious'
    +>>> 'mississippi'.rstrip('ipz')
    +'mississ'
    +
    +
    +
    + +
    +
    +str.split(sep=None, maxsplit=-1)
    +

    Return a list of the words in the string, using sep as the delimiter +string. If maxsplit is given, at most maxsplit splits are done (thus, +the list will have at most maxsplit+1 elements). If maxsplit is not +specified or -1, then there is no limit on the number of splits +(all possible splits are made).

    +

    If sep is given, consecutive delimiters are not grouped together and are +deemed to delimit empty strings (for example, '1,,2'.split(',') returns +['1', '', '2']). The sep argument may consist of multiple characters +(for example, '1<>2<>3'.split('<>') returns ['1', '2', '3']). +Splitting an empty string with a specified separator returns [''].

    +

    For example:

    +
    >>> '1,2,3'.split(',')
    +['1', '2', '3']
    +>>> '1,2,3'.split(',', maxsplit=1)
    +['1', '2,3']
    +>>> '1,2,,3,'.split(',')
    +['1', '2', '', '3', '']
    +
    +
    +

    If sep is not specified or is None, a different splitting algorithm is +applied: runs of consecutive whitespace are regarded as a single separator, +and the result will contain no empty strings at the start or end if the +string has leading or trailing whitespace. Consequently, splitting an empty +string or a string consisting of just whitespace with a None separator +returns [].

    +

    For example:

    +
    >>> '1 2 3'.split()
    +['1', '2', '3']
    +>>> '1 2 3'.split(maxsplit=1)
    +['1', '2 3']
    +>>> '   1   2   3   '.split()
    +['1', '2', '3']
    +
    +
    +
    + +
    +
    +str.splitlines([keepends])
    +

    Return a list of the lines in the string, breaking at line boundaries. Line +breaks are not included in the resulting list unless keepends is given and +true.

    +

    This method splits on the following line boundaries. In particular, the +boundaries are a superset of universal newlines.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Representation

    Description

    \n

    Line Feed

    \r

    Carriage Return

    \r\n

    Carriage Return + Line Feed

    \v or \x0b

    Line Tabulation

    \f or \x0c

    Form Feed

    \x1c

    File Separator

    \x1d

    Group Separator

    \x1e

    Record Separator

    \x85

    Next Line (C1 Control Code)

    \u2028

    Line Separator

    \u2029

    Paragraph Separator

    +
    +

    Changed in version 3.2: \v and \f added to list of line boundaries.

    +
    +

    For example:

    +
    >>> 'ab c\n\nde fg\rkl\r\n'.splitlines()
    +['ab c', '', 'de fg', 'kl']
    +>>> 'ab c\n\nde fg\rkl\r\n'.splitlines(keepends=True)
    +['ab c\n', '\n', 'de fg\r', 'kl\r\n']
    +
    +
    +

    Unlike split() when a delimiter string sep is given, this +method returns an empty list for the empty string, and a terminal line +break does not result in an extra line:

    +
    >>> "".splitlines()
    +[]
    +>>> "One line\n".splitlines()
    +['One line']
    +
    +
    +

    For comparison, split('\n') gives:

    +
    >>> ''.split('\n')
    +['']
    +>>> 'Two lines\n'.split('\n')
    +['Two lines', '']
    +
    +
    +
    + +
    +
    +str.startswith(prefix[, start[, end]])
    +

    Return True if string starts with the prefix, otherwise return False. +prefix can also be a tuple of prefixes to look for. With optional start, +test string beginning at that position. With optional end, stop comparing +string at that position.

    +
    + +
    +
    +str.strip([chars])
    +

    Return a copy of the string with the leading and trailing characters removed. +The chars argument is a string specifying the set of characters to be removed. +If omitted or None, the chars argument defaults to removing whitespace. +The chars argument is not a prefix or suffix; rather, all combinations of its +values are stripped:

    +
    >>> '   spacious   '.strip()
    +'spacious'
    +>>> 'www.example.com'.strip('cmowz.')
    +'example'
    +
    +
    +

    The outermost leading and trailing chars argument values are stripped +from the string. Characters are removed from the leading end until +reaching a string character that is not contained in the set of +characters in chars. A similar action takes place on the trailing end. +For example:

    +
    >>> comment_string = '#....... Section 3.2.1 Issue #32 .......'
    +>>> comment_string.strip('.#! ')
    +'Section 3.2.1 Issue #32'
    +
    +
    +
    + +
    +
    +str.swapcase()
    +

    Return a copy of the string with uppercase characters converted to lowercase and +vice versa. Note that it is not necessarily true that +s.swapcase().swapcase() == s.

    +
    + +
    +
    +str.title()
    +

    Return a titlecased version of the string where words start with an uppercase +character and the remaining characters are lowercase.

    +

    For example:

    +
    >>> 'Hello world'.title()
    +'Hello World'
    +
    +
    +

    The algorithm uses a simple language-independent definition of a word as +groups of consecutive letters. The definition works in many contexts but +it means that apostrophes in contractions and possessives form word +boundaries, which may not be the desired result:

    +
    >>> "they're bill's friends from the UK".title()
    +"They'Re Bill'S Friends From The Uk"
    +
    +
    +

    A workaround for apostrophes can be constructed using regular expressions:

    +
    >>> import re
    +>>> def titlecase(s):
    +...     return re.sub(r"[A-Za-z]+('[A-Za-z]+)?",
    +...                   lambda mo: mo.group(0)[0].upper() +
    +...                              mo.group(0)[1:].lower(),
    +...                   s)
    +...
    +>>> titlecase("they're bill's friends.")
    +"They're Bill's Friends."
    +
    +
    +
    + +
    +
    +str.translate(table)
    +

    Return a copy of the string in which each character has been mapped through +the given translation table. The table must be an object that implements +indexing via __getitem__(), typically a mapping or +sequence. When indexed by a Unicode ordinal (an integer), the +table object can do any of the following: return a Unicode ordinal or a +string, to map the character to one or more other characters; return +None, to delete the character from the return string; or raise a +LookupError exception, to map the character to itself.

    +

    You can use str.maketrans() to create a translation map from +character-to-character mappings in different formats.

    +

    See also the codecs module for a more flexible approach to custom +character mappings.

    +
    + +
    +
    +str.upper()
    +

    Return a copy of the string with all the cased characters 4 converted to +uppercase. Note that s.upper().isupper() might be False if s +contains uncased characters or if the Unicode category of the resulting +character(s) is not “Lu” (Letter, uppercase), but e.g. “Lt” (Letter, +titlecase).

    +

    The uppercasing algorithm used is described in section 3.13 of the Unicode +Standard.

    +
    + +
    +
    +str.zfill(width)
    +

    Return a copy of the string left filled with ASCII '0' digits to +make a string of length width. A leading sign prefix ('+'/'-') +is handled by inserting the padding after the sign character rather +than before. The original string is returned if width is less than +or equal to len(s).

    +

    For example:

    +
    >>> "42".zfill(5)
    +'00042'
    +>>> "-42".zfill(5)
    +'-0042'
    +
    +
    +
    + +
    +
    +

    printf-style String Formatting

    +
    +

    Note

    +

    The formatting operations described here exhibit a variety of quirks that +lead to a number of common errors (such as failing to display tuples and +dictionaries correctly). Using the newer formatted string literals, the str.format() interface, or template strings may help avoid these errors. Each of these +alternatives provides their own trade-offs and benefits of simplicity, +flexibility, and/or extensibility.

    +
    +

    String objects have one unique built-in operation: the % operator (modulo). +This is also known as the string formatting or interpolation operator. +Given format % values (where format is a string), % conversion +specifications in format are replaced with zero or more elements of values. +The effect is similar to using the sprintf() in the C language.

    +

    If format requires a single argument, values may be a single non-tuple +object. 5 Otherwise, values must be a tuple with exactly the number of +items specified by the format string, or a single mapping object (for example, a +dictionary).

    +

    A conversion specifier contains two or more characters and has the following +components, which must occur in this order:

    +
      +
    1. The '%' character, which marks the start of the specifier.

    2. +
    3. Mapping key (optional), consisting of a parenthesised sequence of characters +(for example, (somename)).

    4. +
    5. Conversion flags (optional), which affect the result of some conversion +types.

    6. +
    7. Minimum field width (optional). If specified as an '*' (asterisk), the +actual width is read from the next element of the tuple in values, and the +object to convert comes after the minimum field width and optional precision.

    8. +
    9. Precision (optional), given as a '.' (dot) followed by the precision. If +specified as '*' (an asterisk), the actual precision is read from the next +element of the tuple in values, and the value to convert comes after the +precision.

    10. +
    11. Length modifier (optional).

    12. +
    13. Conversion type.

    14. +
    +

    When the right argument is a dictionary (or other mapping type), then the +formats in the string must include a parenthesised mapping key into that +dictionary inserted immediately after the '%' character. The mapping key +selects the value to be formatted from the mapping. For example:

    +
    >>> print('%(language)s has %(number)03d quote types.' %
    +...       {'language': "Python", "number": 2})
    +Python has 002 quote types.
    +
    +
    +

    In this case no * specifiers may occur in a format (since they require a +sequential parameter list).

    +

    The conversion flag characters are:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + +

    Flag

    Meaning

    '#'

    The value conversion will use the “alternate form” (where defined +below).

    '0'

    The conversion will be zero padded for numeric values.

    '-'

    The converted value is left adjusted (overrides the '0' +conversion if both are given).

    ' '

    (a space) A blank should be left before a positive number (or empty +string) produced by a signed conversion.

    '+'

    A sign character ('+' or '-') will precede the conversion +(overrides a “space” flag).

    +

    A length modifier (h, l, or L) may be present, but is ignored as it +is not necessary for Python – so e.g. %ld is identical to %d.

    +

    The conversion types are:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Conversion

    Meaning

    Notes

    'd'

    Signed integer decimal.

    'i'

    Signed integer decimal.

    'o'

    Signed octal value.

    (1)

    'u'

    Obsolete type – it is identical to 'd'.

    (6)

    'x'

    Signed hexadecimal (lowercase).

    (2)

    'X'

    Signed hexadecimal (uppercase).

    (2)

    'e'

    Floating point exponential format (lowercase).

    (3)

    'E'

    Floating point exponential format (uppercase).

    (3)

    'f'

    Floating point decimal format.

    (3)

    'F'

    Floating point decimal format.

    (3)

    'g'

    Floating point format. Uses lowercase exponential +format if exponent is less than -4 or not less than +precision, decimal format otherwise.

    (4)

    'G'

    Floating point format. Uses uppercase exponential +format if exponent is less than -4 or not less than +precision, decimal format otherwise.

    (4)

    'c'

    Single character (accepts integer or single +character string).

    'r'

    String (converts any Python object using +repr()).

    (5)

    's'

    String (converts any Python object using +str()).

    (5)

    'a'

    String (converts any Python object using +ascii()).

    (5)

    '%'

    No argument is converted, results in a '%' +character in the result.

    +

    Notes:

    +
      +
    1. The alternate form causes a leading octal specifier ('0o') to be +inserted before the first digit.

    2. +
    3. The alternate form causes a leading '0x' or '0X' (depending on whether +the 'x' or 'X' format was used) to be inserted before the first digit.

    4. +
    5. The alternate form causes the result to always contain a decimal point, even if +no digits follow it.

      +

      The precision determines the number of digits after the decimal point and +defaults to 6.

      +
    6. +
    7. The alternate form causes the result to always contain a decimal point, and +trailing zeroes are not removed as they would otherwise be.

      +

      The precision determines the number of significant digits before and after the +decimal point and defaults to 6.

      +
    8. +
    9. If precision is N, the output is truncated to N characters.

    10. +
    11. See PEP 237.

    12. +
    +

    Since Python strings have an explicit length, %s conversions do not assume +that '\0' is the end of the string.

    +
    +

    Changed in version 3.1: %f conversions for numbers whose absolute value is over 1e50 are no +longer replaced by %g conversions.

    +
    +
    +
    +
    +

    Binary Sequence Types — bytes, bytearray, memoryview

    +

    The core built-in types for manipulating binary data are bytes and +bytearray. They are supported by memoryview which uses +the buffer protocol to access the memory of other +binary objects without needing to make a copy.

    +

    The array module supports efficient storage of basic data types like +32-bit integers and IEEE754 double-precision floating values.

    +
    +

    Bytes Objects

    +

    Bytes objects are immutable sequences of single bytes. Since many major +binary protocols are based on the ASCII text encoding, bytes objects offer +several methods that are only valid when working with ASCII compatible +data and are closely related to string objects in a variety of other ways.

    +
    +
    +class bytes([source[, encoding[, errors]]])
    +

    Firstly, the syntax for bytes literals is largely the same as that for string +literals, except that a b prefix is added:

    +
      +
    • Single quotes: b'still allows embedded "double" quotes'

    • +
    • Double quotes: b"still allows embedded 'single' quotes".

    • +
    • Triple quoted: b'''3 single quotes''', b"""3 double quotes"""

    • +
    +

    Only ASCII characters are permitted in bytes literals (regardless of the +declared source code encoding). Any binary values over 127 must be entered +into bytes literals using the appropriate escape sequence.

    +

    As with string literals, bytes literals may also use a r prefix to disable +processing of escape sequences. See String and Bytes literals for more about the various +forms of bytes literal, including supported escape sequences.

    +

    While bytes literals and representations are based on ASCII text, bytes +objects actually behave like immutable sequences of integers, with each +value in the sequence restricted such that 0 <= x < 256 (attempts to +violate this restriction will trigger ValueError). This is done +deliberately to emphasise that while many binary formats include ASCII based +elements and can be usefully manipulated with some text-oriented algorithms, +this is not generally the case for arbitrary binary data (blindly applying +text processing algorithms to binary data formats that are not ASCII +compatible will usually lead to data corruption).

    +

    In addition to the literal forms, bytes objects can be created in a number of +other ways:

    +
      +
    • A zero-filled bytes object of a specified length: bytes(10)

    • +
    • From an iterable of integers: bytes(range(20))

    • +
    • Copying existing binary data via the buffer protocol: bytes(obj)

    • +
    +

    Also see the bytes built-in.

    +

    Since 2 hexadecimal digits correspond precisely to a single byte, hexadecimal +numbers are a commonly used format for describing binary data. Accordingly, +the bytes type has an additional class method to read data in that format:

    +
    +
    +classmethod fromhex(string)
    +

    This bytes class method returns a bytes object, decoding the +given string object. The string must contain two hexadecimal digits per +byte, with ASCII whitespace being ignored.

    +
    >>> bytes.fromhex('2Ef0 F1f2  ')
    +b'.\xf0\xf1\xf2'
    +
    +
    +
    +

    Changed in version 3.7: bytes.fromhex() now skips all ASCII whitespace in the string, +not just spaces.

    +
    +
    + +

    A reverse conversion function exists to transform a bytes object into its +hexadecimal representation.

    +
    +
    +hex()
    +

    Return a string object containing two hexadecimal digits for each +byte in the instance.

    +
    >>> b'\xf0\xf1\xf2'.hex()
    +'f0f1f2'
    +
    +
    +
    +

    New in version 3.5.

    +
    +
    + +
    + +

    Since bytes objects are sequences of integers (akin to a tuple), for a bytes +object b, b[0] will be an integer, while b[0:1] will be a bytes +object of length 1. (This contrasts with text strings, where both indexing +and slicing will produce a string of length 1)

    +

    The representation of bytes objects uses the literal format (b'...') +since it is often more useful than e.g. bytes([46, 46, 46]). You can +always convert a bytes object into a list of integers using list(b).

    +
    +

    Note

    +

    For Python 2.x users: In the Python 2.x series, a variety of implicit +conversions between 8-bit strings (the closest thing 2.x offers to a +built-in binary data type) and Unicode strings were permitted. This was a +backwards compatibility workaround to account for the fact that Python +originally only supported 8-bit text, and Unicode text was a later +addition. In Python 3.x, those implicit conversions are gone - conversions +between 8-bit binary data and Unicode text must be explicit, and bytes and +string objects will always compare unequal.

    +
    +
    +
    +

    Bytearray Objects

    +

    bytearray objects are a mutable counterpart to bytes +objects.

    +
    +
    +class bytearray([source[, encoding[, errors]]])
    +

    There is no dedicated literal syntax for bytearray objects, instead +they are always created by calling the constructor:

    +
      +
    • Creating an empty instance: bytearray()

    • +
    • Creating a zero-filled instance with a given length: bytearray(10)

    • +
    • From an iterable of integers: bytearray(range(20))

    • +
    • Copying existing binary data via the buffer protocol: bytearray(b'Hi!')

    • +
    +

    As bytearray objects are mutable, they support the +mutable sequence operations in addition to the +common bytes and bytearray operations described in Bytes and Bytearray Operations.

    +

    Also see the bytearray built-in.

    +

    Since 2 hexadecimal digits correspond precisely to a single byte, hexadecimal +numbers are a commonly used format for describing binary data. Accordingly, +the bytearray type has an additional class method to read data in that format:

    +
    +
    +classmethod fromhex(string)
    +

    This bytearray class method returns bytearray object, decoding +the given string object. The string must contain two hexadecimal digits +per byte, with ASCII whitespace being ignored.

    +
    >>> bytearray.fromhex('2Ef0 F1f2  ')
    +bytearray(b'.\xf0\xf1\xf2')
    +
    +
    +
    +

    Changed in version 3.7: bytearray.fromhex() now skips all ASCII whitespace in the string, +not just spaces.

    +
    +
    + +

    A reverse conversion function exists to transform a bytearray object into its +hexadecimal representation.

    +
    +
    +hex()
    +

    Return a string object containing two hexadecimal digits for each +byte in the instance.

    +
    >>> bytearray(b'\xf0\xf1\xf2').hex()
    +'f0f1f2'
    +
    +
    +
    +

    New in version 3.5.

    +
    +
    + +
    + +

    Since bytearray objects are sequences of integers (akin to a list), for a +bytearray object b, b[0] will be an integer, while b[0:1] will be +a bytearray object of length 1. (This contrasts with text strings, where +both indexing and slicing will produce a string of length 1)

    +

    The representation of bytearray objects uses the bytes literal format +(bytearray(b'...')) since it is often more useful than e.g. +bytearray([46, 46, 46]). You can always convert a bytearray object into +a list of integers using list(b).

    +
    +
    +

    Bytes and Bytearray Operations

    +

    Both bytes and bytearray objects support the common +sequence operations. They interoperate not just with operands of the same +type, but with any bytes-like object. Due to this flexibility, they can be +freely mixed in operations without causing errors. However, the return type +of the result may depend on the order of operands.

    +
    +

    Note

    +

    The methods on bytes and bytearray objects don’t accept strings as their +arguments, just as the methods on strings don’t accept bytes as their +arguments. For example, you have to write:

    +
    a = "abc"
    +b = a.replace("a", "f")
    +
    +
    +

    and:

    +
    a = b"abc"
    +b = a.replace(b"a", b"f")
    +
    +
    +
    +

    Some bytes and bytearray operations assume the use of ASCII compatible +binary formats, and hence should be avoided when working with arbitrary +binary data. These restrictions are covered below.

    +
    +

    Note

    +

    Using these ASCII based operations to manipulate binary data that is not +stored in an ASCII based format may lead to data corruption.

    +
    +

    The following methods on bytes and bytearray objects can be used with +arbitrary binary data.

    +
    +
    +bytes.count(sub[, start[, end]])
    +
    +bytearray.count(sub[, start[, end]])
    +

    Return the number of non-overlapping occurrences of subsequence sub in +the range [start, end]. Optional arguments start and end are +interpreted as in slice notation.

    +

    The subsequence to search for may be any bytes-like object or an +integer in the range 0 to 255.

    +
    +

    Changed in version 3.3: Also accept an integer in the range 0 to 255 as the subsequence.

    +
    +
    + +
    +
    +bytes.decode(encoding="utf-8", errors="strict")
    +
    +bytearray.decode(encoding="utf-8", errors="strict")
    +

    Return a string decoded from the given bytes. Default encoding is +'utf-8'. errors may be given to set a different +error handling scheme. The default for errors is 'strict', meaning +that encoding errors raise a UnicodeError. Other possible values are +'ignore', 'replace' and any other name registered via +codecs.register_error(), see section Error Handlers. For a +list of possible encodings, see section Standard Encodings.

    +
    +

    Note

    +

    Passing the encoding argument to str allows decoding any +bytes-like object directly, without needing to make a temporary +bytes or bytearray object.

    +
    +
    +

    Changed in version 3.1: Added support for keyword arguments.

    +
    +
    + +
    +
    +bytes.endswith(suffix[, start[, end]])
    +
    +bytearray.endswith(suffix[, start[, end]])
    +

    Return True if the binary data ends with the specified suffix, +otherwise return False. suffix can also be a tuple of suffixes to +look for. With optional start, test beginning at that position. With +optional end, stop comparing at that position.

    +

    The suffix(es) to search for may be any bytes-like object.

    +
    + +
    +
    +bytes.find(sub[, start[, end]])
    +
    +bytearray.find(sub[, start[, end]])
    +

    Return the lowest index in the data where the subsequence sub is found, +such that sub is contained in the slice s[start:end]. Optional +arguments start and end are interpreted as in slice notation. Return +-1 if sub is not found.

    +

    The subsequence to search for may be any bytes-like object or an +integer in the range 0 to 255.

    +
    +

    Note

    +

    The find() method should be used only if you need to know the +position of sub. To check if sub is a substring or not, use the +in operator:

    +
    >>> b'Py' in b'Python'
    +True
    +
    +
    +
    +
    +

    Changed in version 3.3: Also accept an integer in the range 0 to 255 as the subsequence.

    +
    +
    + +
    +
    +bytes.index(sub[, start[, end]])
    +
    +bytearray.index(sub[, start[, end]])
    +

    Like find(), but raise ValueError when the +subsequence is not found.

    +

    The subsequence to search for may be any bytes-like object or an +integer in the range 0 to 255.

    +
    +

    Changed in version 3.3: Also accept an integer in the range 0 to 255 as the subsequence.

    +
    +
    + +
    +
    +bytes.join(iterable)
    +
    +bytearray.join(iterable)
    +

    Return a bytes or bytearray object which is the concatenation of the +binary data sequences in iterable. A TypeError will be raised +if there are any values in iterable that are not bytes-like +objects, including str objects. The +separator between elements is the contents of the bytes or +bytearray object providing this method.

    +
    + +
    +
    +static bytes.maketrans(from, to)
    +
    +static bytearray.maketrans(from, to)
    +

    This static method returns a translation table usable for +bytes.translate() that will map each character in from into the +character at the same position in to; from and to must both be +bytes-like objects and have the same length.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +bytes.partition(sep)
    +
    +bytearray.partition(sep)
    +

    Split the sequence at the first occurrence of sep, and return a 3-tuple +containing the part before the separator, the separator itself or its +bytearray copy, and the part after the separator. +If the separator is not found, return a 3-tuple +containing a copy of the original sequence, followed by two empty bytes or +bytearray objects.

    +

    The separator to search for may be any bytes-like object.

    +
    + +
    +
    +bytes.replace(old, new[, count])
    +
    +bytearray.replace(old, new[, count])
    +

    Return a copy of the sequence with all occurrences of subsequence old +replaced by new. If the optional argument count is given, only the +first count occurrences are replaced.

    +

    The subsequence to search for and its replacement may be any +bytes-like object.

    +
    +

    Note

    +

    The bytearray version of this method does not operate in place - it +always produces a new object, even if no changes were made.

    +
    +
    + +
    +
    +bytes.rfind(sub[, start[, end]])
    +
    +bytearray.rfind(sub[, start[, end]])
    +

    Return the highest index in the sequence where the subsequence sub is +found, such that sub is contained within s[start:end]. Optional +arguments start and end are interpreted as in slice notation. Return +-1 on failure.

    +

    The subsequence to search for may be any bytes-like object or an +integer in the range 0 to 255.

    +
    +

    Changed in version 3.3: Also accept an integer in the range 0 to 255 as the subsequence.

    +
    +
    + +
    +
    +bytes.rindex(sub[, start[, end]])
    +
    +bytearray.rindex(sub[, start[, end]])
    +

    Like rfind() but raises ValueError when the +subsequence sub is not found.

    +

    The subsequence to search for may be any bytes-like object or an +integer in the range 0 to 255.

    +
    +

    Changed in version 3.3: Also accept an integer in the range 0 to 255 as the subsequence.

    +
    +
    + +
    +
    +bytes.rpartition(sep)
    +
    +bytearray.rpartition(sep)
    +

    Split the sequence at the last occurrence of sep, and return a 3-tuple +containing the part before the separator, the separator itself or its +bytearray copy, and the part after the separator. +If the separator is not found, return a 3-tuple +containing two empty bytes or bytearray objects, followed by a copy of the +original sequence.

    +

    The separator to search for may be any bytes-like object.

    +
    + +
    +
    +bytes.startswith(prefix[, start[, end]])
    +
    +bytearray.startswith(prefix[, start[, end]])
    +

    Return True if the binary data starts with the specified prefix, +otherwise return False. prefix can also be a tuple of prefixes to +look for. With optional start, test beginning at that position. With +optional end, stop comparing at that position.

    +

    The prefix(es) to search for may be any bytes-like object.

    +
    + +
    +
    +bytes.translate(table, delete=b'')
    +
    +bytearray.translate(table, delete=b'')
    +

    Return a copy of the bytes or bytearray object where all bytes occurring in +the optional argument delete are removed, and the remaining bytes have +been mapped through the given translation table, which must be a bytes +object of length 256.

    +

    You can use the bytes.maketrans() method to create a translation +table.

    +

    Set the table argument to None for translations that only delete +characters:

    +
    >>> b'read this short text'.translate(None, b'aeiou')
    +b'rd ths shrt txt'
    +
    +
    +
    +

    Changed in version 3.6: delete is now supported as a keyword argument.

    +
    +
    + +

    The following methods on bytes and bytearray objects have default behaviours +that assume the use of ASCII compatible binary formats, but can still be used +with arbitrary binary data by passing appropriate arguments. Note that all of +the bytearray methods in this section do not operate in place, and instead +produce new objects.

    +
    +
    +bytes.center(width[, fillbyte])
    +
    +bytearray.center(width[, fillbyte])
    +

    Return a copy of the object centered in a sequence of length width. +Padding is done using the specified fillbyte (default is an ASCII +space). For bytes objects, the original sequence is returned if +width is less than or equal to len(s).

    +
    +

    Note

    +

    The bytearray version of this method does not operate in place - +it always produces a new object, even if no changes were made.

    +
    +
    + +
    +
    +bytes.ljust(width[, fillbyte])
    +
    +bytearray.ljust(width[, fillbyte])
    +

    Return a copy of the object left justified in a sequence of length width. +Padding is done using the specified fillbyte (default is an ASCII +space). For bytes objects, the original sequence is returned if +width is less than or equal to len(s).

    +
    +

    Note

    +

    The bytearray version of this method does not operate in place - +it always produces a new object, even if no changes were made.

    +
    +
    + +
    +
    +bytes.lstrip([chars])
    +
    +bytearray.lstrip([chars])
    +

    Return a copy of the sequence with specified leading bytes removed. The +chars argument is a binary sequence specifying the set of byte values to +be removed - the name refers to the fact this method is usually used with +ASCII characters. If omitted or None, the chars argument defaults +to removing ASCII whitespace. The chars argument is not a prefix; +rather, all combinations of its values are stripped:

    +
    >>> b'   spacious   '.lstrip()
    +b'spacious   '
    +>>> b'www.example.com'.lstrip(b'cmowz.')
    +b'example.com'
    +
    +
    +

    The binary sequence of byte values to remove may be any +bytes-like object.

    +
    +

    Note

    +

    The bytearray version of this method does not operate in place - +it always produces a new object, even if no changes were made.

    +
    +
    + +
    +
    +bytes.rjust(width[, fillbyte])
    +
    +bytearray.rjust(width[, fillbyte])
    +

    Return a copy of the object right justified in a sequence of length width. +Padding is done using the specified fillbyte (default is an ASCII +space). For bytes objects, the original sequence is returned if +width is less than or equal to len(s).

    +
    +

    Note

    +

    The bytearray version of this method does not operate in place - +it always produces a new object, even if no changes were made.

    +
    +
    + +
    +
    +bytes.rsplit(sep=None, maxsplit=-1)
    +
    +bytearray.rsplit(sep=None, maxsplit=-1)
    +

    Split the binary sequence into subsequences of the same type, using sep +as the delimiter string. If maxsplit is given, at most maxsplit splits +are done, the rightmost ones. If sep is not specified or None, +any subsequence consisting solely of ASCII whitespace is a separator. +Except for splitting from the right, rsplit() behaves like +split() which is described in detail below.

    +
    + +
    +
    +bytes.rstrip([chars])
    +
    +bytearray.rstrip([chars])
    +

    Return a copy of the sequence with specified trailing bytes removed. The +chars argument is a binary sequence specifying the set of byte values to +be removed - the name refers to the fact this method is usually used with +ASCII characters. If omitted or None, the chars argument defaults to +removing ASCII whitespace. The chars argument is not a suffix; rather, +all combinations of its values are stripped:

    +
    >>> b'   spacious   '.rstrip()
    +b'   spacious'
    +>>> b'mississippi'.rstrip(b'ipz')
    +b'mississ'
    +
    +
    +

    The binary sequence of byte values to remove may be any +bytes-like object.

    +
    +

    Note

    +

    The bytearray version of this method does not operate in place - +it always produces a new object, even if no changes were made.

    +
    +
    + +
    +
    +bytes.split(sep=None, maxsplit=-1)
    +
    +bytearray.split(sep=None, maxsplit=-1)
    +

    Split the binary sequence into subsequences of the same type, using sep +as the delimiter string. If maxsplit is given and non-negative, at most +maxsplit splits are done (thus, the list will have at most maxsplit+1 +elements). If maxsplit is not specified or is -1, then there is no +limit on the number of splits (all possible splits are made).

    +

    If sep is given, consecutive delimiters are not grouped together and are +deemed to delimit empty subsequences (for example, b'1,,2'.split(b',') +returns [b'1', b'', b'2']). The sep argument may consist of a +multibyte sequence (for example, b'1<>2<>3'.split(b'<>') returns +[b'1', b'2', b'3']). Splitting an empty sequence with a specified +separator returns [b''] or [bytearray(b'')] depending on the type +of object being split. The sep argument may be any +bytes-like object.

    +

    For example:

    +
    >>> b'1,2,3'.split(b',')
    +[b'1', b'2', b'3']
    +>>> b'1,2,3'.split(b',', maxsplit=1)
    +[b'1', b'2,3']
    +>>> b'1,2,,3,'.split(b',')
    +[b'1', b'2', b'', b'3', b'']
    +
    +
    +

    If sep is not specified or is None, a different splitting algorithm +is applied: runs of consecutive ASCII whitespace are regarded as a single +separator, and the result will contain no empty strings at the start or +end if the sequence has leading or trailing whitespace. Consequently, +splitting an empty sequence or a sequence consisting solely of ASCII +whitespace without a specified separator returns [].

    +

    For example:

    +
    >>> b'1 2 3'.split()
    +[b'1', b'2', b'3']
    +>>> b'1 2 3'.split(maxsplit=1)
    +[b'1', b'2 3']
    +>>> b'   1   2   3   '.split()
    +[b'1', b'2', b'3']
    +
    +
    +
    + +
    +
    +bytes.strip([chars])
    +
    +bytearray.strip([chars])
    +

    Return a copy of the sequence with specified leading and trailing bytes +removed. The chars argument is a binary sequence specifying the set of +byte values to be removed - the name refers to the fact this method is +usually used with ASCII characters. If omitted or None, the chars +argument defaults to removing ASCII whitespace. The chars argument is +not a prefix or suffix; rather, all combinations of its values are +stripped:

    +
    >>> b'   spacious   '.strip()
    +b'spacious'
    +>>> b'www.example.com'.strip(b'cmowz.')
    +b'example'
    +
    +
    +

    The binary sequence of byte values to remove may be any +bytes-like object.

    +
    +

    Note

    +

    The bytearray version of this method does not operate in place - +it always produces a new object, even if no changes were made.

    +
    +
    + +

    The following methods on bytes and bytearray objects assume the use of ASCII +compatible binary formats and should not be applied to arbitrary binary data. +Note that all of the bytearray methods in this section do not operate in +place, and instead produce new objects.

    +
    +
    +bytes.capitalize()
    +
    +bytearray.capitalize()
    +

    Return a copy of the sequence with each byte interpreted as an ASCII +character, and the first byte capitalized and the rest lowercased. +Non-ASCII byte values are passed through unchanged.

    +
    +

    Note

    +

    The bytearray version of this method does not operate in place - it +always produces a new object, even if no changes were made.

    +
    +
    + +
    +
    +bytes.expandtabs(tabsize=8)
    +
    +bytearray.expandtabs(tabsize=8)
    +

    Return a copy of the sequence where all ASCII tab characters are replaced +by one or more ASCII spaces, depending on the current column and the given +tab size. Tab positions occur every tabsize bytes (default is 8, +giving tab positions at columns 0, 8, 16 and so on). To expand the +sequence, the current column is set to zero and the sequence is examined +byte by byte. If the byte is an ASCII tab character (b'\t'), one or +more space characters are inserted in the result until the current column +is equal to the next tab position. (The tab character itself is not +copied.) If the current byte is an ASCII newline (b'\n') or +carriage return (b'\r'), it is copied and the current column is reset +to zero. Any other byte value is copied unchanged and the current column +is incremented by one regardless of how the byte value is represented when +printed:

    +
    >>> b'01\t012\t0123\t01234'.expandtabs()
    +b'01      012     0123    01234'
    +>>> b'01\t012\t0123\t01234'.expandtabs(4)
    +b'01  012 0123    01234'
    +
    +
    +
    +

    Note

    +

    The bytearray version of this method does not operate in place - it +always produces a new object, even if no changes were made.

    +
    +
    + +
    +
    +bytes.isalnum()
    +
    +bytearray.isalnum()
    +

    Return true if all bytes in the sequence are alphabetical ASCII characters +or ASCII decimal digits and the sequence is not empty, false otherwise. +Alphabetic ASCII characters are those byte values in the sequence +b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'. ASCII decimal +digits are those byte values in the sequence b'0123456789'.

    +

    For example:

    +
    >>> b'ABCabc1'.isalnum()
    +True
    +>>> b'ABC abc1'.isalnum()
    +False
    +
    +
    +
    + +
    +
    +bytes.isalpha()
    +
    +bytearray.isalpha()
    +

    Return true if all bytes in the sequence are alphabetic ASCII characters +and the sequence is not empty, false otherwise. Alphabetic ASCII +characters are those byte values in the sequence +b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'.

    +

    For example:

    +
    >>> b'ABCabc'.isalpha()
    +True
    +>>> b'ABCabc1'.isalpha()
    +False
    +
    +
    +
    + +
    +
    +bytes.isascii()
    +
    +bytearray.isascii()
    +

    Return true if the sequence is empty or all bytes in the sequence are ASCII, +false otherwise. +ASCII bytes are in the range 0-0x7F.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +bytes.isdigit()
    +
    +bytearray.isdigit()
    +

    Return true if all bytes in the sequence are ASCII decimal digits +and the sequence is not empty, false otherwise. ASCII decimal digits are +those byte values in the sequence b'0123456789'.

    +

    For example:

    +
    >>> b'1234'.isdigit()
    +True
    +>>> b'1.23'.isdigit()
    +False
    +
    +
    +
    + +
    +
    +bytes.islower()
    +
    +bytearray.islower()
    +

    Return true if there is at least one lowercase ASCII character +in the sequence and no uppercase ASCII characters, false otherwise.

    +

    For example:

    +
    >>> b'hello world'.islower()
    +True
    +>>> b'Hello world'.islower()
    +False
    +
    +
    +

    Lowercase ASCII characters are those byte values in the sequence +b'abcdefghijklmnopqrstuvwxyz'. Uppercase ASCII characters +are those byte values in the sequence b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'.

    +
    + +
    +
    +bytes.isspace()
    +
    +bytearray.isspace()
    +

    Return true if all bytes in the sequence are ASCII whitespace and the +sequence is not empty, false otherwise. ASCII whitespace characters are +those byte values in the sequence b' \t\n\r\x0b\f' (space, tab, newline, +carriage return, vertical tab, form feed).

    +
    + +
    +
    +bytes.istitle()
    +
    +bytearray.istitle()
    +

    Return true if the sequence is ASCII titlecase and the sequence is not +empty, false otherwise. See bytes.title() for more details on the +definition of “titlecase”.

    +

    For example:

    +
    >>> b'Hello World'.istitle()
    +True
    +>>> b'Hello world'.istitle()
    +False
    +
    +
    +
    + +
    +
    +bytes.isupper()
    +
    +bytearray.isupper()
    +

    Return true if there is at least one uppercase alphabetic ASCII character +in the sequence and no lowercase ASCII characters, false otherwise.

    +

    For example:

    +
    >>> b'HELLO WORLD'.isupper()
    +True
    +>>> b'Hello world'.isupper()
    +False
    +
    +
    +

    Lowercase ASCII characters are those byte values in the sequence +b'abcdefghijklmnopqrstuvwxyz'. Uppercase ASCII characters +are those byte values in the sequence b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'.

    +
    + +
    +
    +bytes.lower()
    +
    +bytearray.lower()
    +

    Return a copy of the sequence with all the uppercase ASCII characters +converted to their corresponding lowercase counterpart.

    +

    For example:

    +
    >>> b'Hello World'.lower()
    +b'hello world'
    +
    +
    +

    Lowercase ASCII characters are those byte values in the sequence +b'abcdefghijklmnopqrstuvwxyz'. Uppercase ASCII characters +are those byte values in the sequence b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'.

    +
    +

    Note

    +

    The bytearray version of this method does not operate in place - it +always produces a new object, even if no changes were made.

    +
    +
    + +
    +
    +bytes.splitlines(keepends=False)
    +
    +bytearray.splitlines(keepends=False)
    +

    Return a list of the lines in the binary sequence, breaking at ASCII +line boundaries. This method uses the universal newlines approach +to splitting lines. Line breaks are not included in the resulting list +unless keepends is given and true.

    +

    For example:

    +
    >>> b'ab c\n\nde fg\rkl\r\n'.splitlines()
    +[b'ab c', b'', b'de fg', b'kl']
    +>>> b'ab c\n\nde fg\rkl\r\n'.splitlines(keepends=True)
    +[b'ab c\n', b'\n', b'de fg\r', b'kl\r\n']
    +
    +
    +

    Unlike split() when a delimiter string sep is given, this +method returns an empty list for the empty string, and a terminal line +break does not result in an extra line:

    +
    >>> b"".split(b'\n'), b"Two lines\n".split(b'\n')
    +([b''], [b'Two lines', b''])
    +>>> b"".splitlines(), b"One line\n".splitlines()
    +([], [b'One line'])
    +
    +
    +
    + +
    +
    +bytes.swapcase()
    +
    +bytearray.swapcase()
    +

    Return a copy of the sequence with all the lowercase ASCII characters +converted to their corresponding uppercase counterpart and vice-versa.

    +

    For example:

    +
    >>> b'Hello World'.swapcase()
    +b'hELLO wORLD'
    +
    +
    +

    Lowercase ASCII characters are those byte values in the sequence +b'abcdefghijklmnopqrstuvwxyz'. Uppercase ASCII characters +are those byte values in the sequence b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'.

    +

    Unlike str.swapcase(), it is always the case that +bin.swapcase().swapcase() == bin for the binary versions. Case +conversions are symmetrical in ASCII, even though that is not generally +true for arbitrary Unicode code points.

    +
    +

    Note

    +

    The bytearray version of this method does not operate in place - it +always produces a new object, even if no changes were made.

    +
    +
    + +
    +
    +bytes.title()
    +
    +bytearray.title()
    +

    Return a titlecased version of the binary sequence where words start with +an uppercase ASCII character and the remaining characters are lowercase. +Uncased byte values are left unmodified.

    +

    For example:

    +
    >>> b'Hello world'.title()
    +b'Hello World'
    +
    +
    +

    Lowercase ASCII characters are those byte values in the sequence +b'abcdefghijklmnopqrstuvwxyz'. Uppercase ASCII characters +are those byte values in the sequence b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'. +All other byte values are uncased.

    +

    The algorithm uses a simple language-independent definition of a word as +groups of consecutive letters. The definition works in many contexts but +it means that apostrophes in contractions and possessives form word +boundaries, which may not be the desired result:

    +
    >>> b"they're bill's friends from the UK".title()
    +b"They'Re Bill'S Friends From The Uk"
    +
    +
    +

    A workaround for apostrophes can be constructed using regular expressions:

    +
    >>> import re
    +>>> def titlecase(s):
    +...     return re.sub(rb"[A-Za-z]+('[A-Za-z]+)?",
    +...                   lambda mo: mo.group(0)[0:1].upper() +
    +...                              mo.group(0)[1:].lower(),
    +...                   s)
    +...
    +>>> titlecase(b"they're bill's friends.")
    +b"They're Bill's Friends."
    +
    +
    +
    +

    Note

    +

    The bytearray version of this method does not operate in place - it +always produces a new object, even if no changes were made.

    +
    +
    + +
    +
    +bytes.upper()
    +
    +bytearray.upper()
    +

    Return a copy of the sequence with all the lowercase ASCII characters +converted to their corresponding uppercase counterpart.

    +

    For example:

    +
    >>> b'Hello World'.upper()
    +b'HELLO WORLD'
    +
    +
    +

    Lowercase ASCII characters are those byte values in the sequence +b'abcdefghijklmnopqrstuvwxyz'. Uppercase ASCII characters +are those byte values in the sequence b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'.

    +
    +

    Note

    +

    The bytearray version of this method does not operate in place - it +always produces a new object, even if no changes were made.

    +
    +
    + +
    +
    +bytes.zfill(width)
    +
    +bytearray.zfill(width)
    +

    Return a copy of the sequence left filled with ASCII b'0' digits to +make a sequence of length width. A leading sign prefix (b'+'/ +b'-') is handled by inserting the padding after the sign character +rather than before. For bytes objects, the original sequence is +returned if width is less than or equal to len(seq).

    +

    For example:

    +
    >>> b"42".zfill(5)
    +b'00042'
    +>>> b"-42".zfill(5)
    +b'-0042'
    +
    +
    +
    +

    Note

    +

    The bytearray version of this method does not operate in place - it +always produces a new object, even if no changes were made.

    +
    +
    + +
    +
    +

    printf-style Bytes Formatting

    +
    +

    Note

    +

    The formatting operations described here exhibit a variety of quirks that +lead to a number of common errors (such as failing to display tuples and +dictionaries correctly). If the value being printed may be a tuple or +dictionary, wrap it in a tuple.

    +
    +

    Bytes objects (bytes/bytearray) have one unique built-in operation: +the % operator (modulo). +This is also known as the bytes formatting or interpolation operator. +Given format % values (where format is a bytes object), % conversion +specifications in format are replaced with zero or more elements of values. +The effect is similar to using the sprintf() in the C language.

    +

    If format requires a single argument, values may be a single non-tuple +object. 5 Otherwise, values must be a tuple with exactly the number of +items specified by the format bytes object, or a single mapping object (for +example, a dictionary).

    +

    A conversion specifier contains two or more characters and has the following +components, which must occur in this order:

    +
      +
    1. The '%' character, which marks the start of the specifier.

    2. +
    3. Mapping key (optional), consisting of a parenthesised sequence of characters +(for example, (somename)).

    4. +
    5. Conversion flags (optional), which affect the result of some conversion +types.

    6. +
    7. Minimum field width (optional). If specified as an '*' (asterisk), the +actual width is read from the next element of the tuple in values, and the +object to convert comes after the minimum field width and optional precision.

    8. +
    9. Precision (optional), given as a '.' (dot) followed by the precision. If +specified as '*' (an asterisk), the actual precision is read from the next +element of the tuple in values, and the value to convert comes after the +precision.

    10. +
    11. Length modifier (optional).

    12. +
    13. Conversion type.

    14. +
    +

    When the right argument is a dictionary (or other mapping type), then the +formats in the bytes object must include a parenthesised mapping key into that +dictionary inserted immediately after the '%' character. The mapping key +selects the value to be formatted from the mapping. For example:

    +
    >>> print(b'%(language)s has %(number)03d quote types.' %
    +...       {b'language': b"Python", b"number": 2})
    +b'Python has 002 quote types.'
    +
    +
    +

    In this case no * specifiers may occur in a format (since they require a +sequential parameter list).

    +

    The conversion flag characters are:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + +

    Flag

    Meaning

    '#'

    The value conversion will use the “alternate form” (where defined +below).

    '0'

    The conversion will be zero padded for numeric values.

    '-'

    The converted value is left adjusted (overrides the '0' +conversion if both are given).

    ' '

    (a space) A blank should be left before a positive number (or empty +string) produced by a signed conversion.

    '+'

    A sign character ('+' or '-') will precede the conversion +(overrides a “space” flag).

    +

    A length modifier (h, l, or L) may be present, but is ignored as it +is not necessary for Python – so e.g. %ld is identical to %d.

    +

    The conversion types are:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Conversion

    Meaning

    Notes

    'd'

    Signed integer decimal.

    'i'

    Signed integer decimal.

    'o'

    Signed octal value.

    (1)

    'u'

    Obsolete type – it is identical to 'd'.

    (8)

    'x'

    Signed hexadecimal (lowercase).

    (2)

    'X'

    Signed hexadecimal (uppercase).

    (2)

    'e'

    Floating point exponential format (lowercase).

    (3)

    'E'

    Floating point exponential format (uppercase).

    (3)

    'f'

    Floating point decimal format.

    (3)

    'F'

    Floating point decimal format.

    (3)

    'g'

    Floating point format. Uses lowercase exponential +format if exponent is less than -4 or not less than +precision, decimal format otherwise.

    (4)

    'G'

    Floating point format. Uses uppercase exponential +format if exponent is less than -4 or not less than +precision, decimal format otherwise.

    (4)

    'c'

    Single byte (accepts integer or single +byte objects).

    'b'

    Bytes (any object that follows the +buffer protocol or has +__bytes__()).

    (5)

    's'

    's' is an alias for 'b' and should only +be used for Python2/3 code bases.

    (6)

    'a'

    Bytes (converts any Python object using +repr(obj).encode('ascii','backslashreplace)).

    (5)

    'r'

    'r' is an alias for 'a' and should only +be used for Python2/3 code bases.

    (7)

    '%'

    No argument is converted, results in a '%' +character in the result.

    +

    Notes:

    +
      +
    1. The alternate form causes a leading octal specifier ('0o') to be +inserted before the first digit.

    2. +
    3. The alternate form causes a leading '0x' or '0X' (depending on whether +the 'x' or 'X' format was used) to be inserted before the first digit.

    4. +
    5. The alternate form causes the result to always contain a decimal point, even if +no digits follow it.

      +

      The precision determines the number of digits after the decimal point and +defaults to 6.

      +
    6. +
    7. The alternate form causes the result to always contain a decimal point, and +trailing zeroes are not removed as they would otherwise be.

      +

      The precision determines the number of significant digits before and after the +decimal point and defaults to 6.

      +
    8. +
    9. If precision is N, the output is truncated to N characters.

    10. +
    11. b'%s' is deprecated, but will not be removed during the 3.x series.

    12. +
    13. b'%r' is deprecated, but will not be removed during the 3.x series.

    14. +
    15. See PEP 237.

    16. +
    +
    +

    Note

    +

    The bytearray version of this method does not operate in place - it +always produces a new object, even if no changes were made.

    +
    +
    +

    See also

    +

    PEP 461 - Adding % formatting to bytes and bytearray

    +
    +
    +

    New in version 3.5.

    +
    +
    +
    +

    Memory Views

    +

    memoryview objects allow Python code to access the internal data +of an object that supports the buffer protocol without +copying.

    +
    +
    +class memoryview(obj)
    +

    Create a memoryview that references obj. obj must support the +buffer protocol. Built-in objects that support the buffer protocol include +bytes and bytearray.

    +

    A memoryview has the notion of an element, which is the +atomic memory unit handled by the originating object obj. For many +simple types such as bytes and bytearray, an element +is a single byte, but other types such as array.array may have +bigger elements.

    +

    len(view) is equal to the length of tolist. +If view.ndim = 0, the length is 1. If view.ndim = 1, the length +is equal to the number of elements in the view. For higher dimensions, +the length is equal to the length of the nested list representation of +the view. The itemsize attribute will give you the +number of bytes in a single element.

    +

    A memoryview supports slicing and indexing to expose its data. +One-dimensional slicing will result in a subview:

    +
    >>> v = memoryview(b'abcefg')
    +>>> v[1]
    +98
    +>>> v[-1]
    +103
    +>>> v[1:4]
    +<memory at 0x7f3ddc9f4350>
    +>>> bytes(v[1:4])
    +b'bce'
    +
    +
    +

    If format is one of the native format specifiers +from the struct module, indexing with an integer or a tuple of +integers is also supported and returns a single element with +the correct type. One-dimensional memoryviews can be indexed +with an integer or a one-integer tuple. Multi-dimensional memoryviews +can be indexed with tuples of exactly ndim integers where ndim is +the number of dimensions. Zero-dimensional memoryviews can be indexed +with the empty tuple.

    +

    Here is an example with a non-byte format:

    +
    >>> import array
    +>>> a = array.array('l', [-11111111, 22222222, -33333333, 44444444])
    +>>> m = memoryview(a)
    +>>> m[0]
    +-11111111
    +>>> m[-1]
    +44444444
    +>>> m[::2].tolist()
    +[-11111111, -33333333]
    +
    +
    +

    If the underlying object is writable, the memoryview supports +one-dimensional slice assignment. Resizing is not allowed:

    +
    >>> data = bytearray(b'abcefg')
    +>>> v = memoryview(data)
    +>>> v.readonly
    +False
    +>>> v[0] = ord(b'z')
    +>>> data
    +bytearray(b'zbcefg')
    +>>> v[1:4] = b'123'
    +>>> data
    +bytearray(b'z123fg')
    +>>> v[2:3] = b'spam'
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +ValueError: memoryview assignment: lvalue and rvalue have different structures
    +>>> v[2:6] = b'spam'
    +>>> data
    +bytearray(b'z1spam')
    +
    +
    +

    One-dimensional memoryviews of hashable (read-only) types with formats +‘B’, ‘b’ or ‘c’ are also hashable. The hash is defined as +hash(m) == hash(m.tobytes()):

    +
    >>> v = memoryview(b'abcefg')
    +>>> hash(v) == hash(b'abcefg')
    +True
    +>>> hash(v[2:4]) == hash(b'ce')
    +True
    +>>> hash(v[::-2]) == hash(b'abcefg'[::-2])
    +True
    +
    +
    +
    +

    Changed in version 3.3: One-dimensional memoryviews can now be sliced. +One-dimensional memoryviews with formats ‘B’, ‘b’ or ‘c’ are now hashable.

    +
    +
    +

    Changed in version 3.4: memoryview is now registered automatically with +collections.abc.Sequence

    +
    +
    +

    Changed in version 3.5: memoryviews can now be indexed with tuple of integers.

    +
    +

    memoryview has several methods:

    +
    +
    +__eq__(exporter)
    +

    A memoryview and a PEP 3118 exporter are equal if their shapes are +equivalent and if all corresponding values are equal when the operands’ +respective format codes are interpreted using struct syntax.

    +

    For the subset of struct format strings currently supported by +tolist(), v and w are equal if v.tolist() == w.tolist():

    +
    >>> import array
    +>>> a = array.array('I', [1, 2, 3, 4, 5])
    +>>> b = array.array('d', [1.0, 2.0, 3.0, 4.0, 5.0])
    +>>> c = array.array('b', [5, 3, 1])
    +>>> x = memoryview(a)
    +>>> y = memoryview(b)
    +>>> x == a == y == b
    +True
    +>>> x.tolist() == a.tolist() == y.tolist() == b.tolist()
    +True
    +>>> z = y[::-2]
    +>>> z == c
    +True
    +>>> z.tolist() == c.tolist()
    +True
    +
    +
    +

    If either format string is not supported by the struct module, +then the objects will always compare as unequal (even if the format +strings and buffer contents are identical):

    +
    >>> from ctypes import BigEndianStructure, c_long
    +>>> class BEPoint(BigEndianStructure):
    +...     _fields_ = [("x", c_long), ("y", c_long)]
    +...
    +>>> point = BEPoint(100, 200)
    +>>> a = memoryview(point)
    +>>> b = memoryview(point)
    +>>> a == point
    +False
    +>>> a == b
    +False
    +
    +
    +

    Note that, as with floating point numbers, v is w does not imply +v == w for memoryview objects.

    +
    +

    Changed in version 3.3: Previous versions compared the raw memory disregarding the item format +and the logical array structure.

    +
    +
    + +
    +
    +tobytes()
    +

    Return the data in the buffer as a bytestring. This is equivalent to +calling the bytes constructor on the memoryview.

    +
    >>> m = memoryview(b"abc")
    +>>> m.tobytes()
    +b'abc'
    +>>> bytes(m)
    +b'abc'
    +
    +
    +

    For non-contiguous arrays the result is equal to the flattened list +representation with all elements converted to bytes. tobytes() +supports all format strings, including those that are not in +struct module syntax.

    +
    + +
    +
    +hex()
    +

    Return a string object containing two hexadecimal digits for each +byte in the buffer.

    +
    >>> m = memoryview(b"abc")
    +>>> m.hex()
    +'616263'
    +
    +
    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +tolist()
    +

    Return the data in the buffer as a list of elements.

    +
    >>> memoryview(b'abc').tolist()
    +[97, 98, 99]
    +>>> import array
    +>>> a = array.array('d', [1.1, 2.2, 3.3])
    +>>> m = memoryview(a)
    +>>> m.tolist()
    +[1.1, 2.2, 3.3]
    +
    +
    +
    +

    Changed in version 3.3: tolist() now supports all single character native formats in +struct module syntax as well as multi-dimensional +representations.

    +
    +
    + +
    +
    +release()
    +

    Release the underlying buffer exposed by the memoryview object. Many +objects take special actions when a view is held on them (for example, +a bytearray would temporarily forbid resizing); therefore, +calling release() is handy to remove these restrictions (and free any +dangling resources) as soon as possible.

    +

    After this method has been called, any further operation on the view +raises a ValueError (except release() itself which can +be called multiple times):

    +
    >>> m = memoryview(b'abc')
    +>>> m.release()
    +>>> m[0]
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +ValueError: operation forbidden on released memoryview object
    +
    +
    +

    The context management protocol can be used for a similar effect, +using the with statement:

    +
    >>> with memoryview(b'abc') as m:
    +...     m[0]
    +...
    +97
    +>>> m[0]
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +ValueError: operation forbidden on released memoryview object
    +
    +
    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +cast(format[, shape])
    +

    Cast a memoryview to a new format or shape. shape defaults to +[byte_length//new_itemsize], which means that the result view +will be one-dimensional. The return value is a new memoryview, but +the buffer itself is not copied. Supported casts are 1D -> C-contiguous +and C-contiguous -> 1D.

    +

    The destination format is restricted to a single element native format in +struct syntax. One of the formats must be a byte format +(‘B’, ‘b’ or ‘c’). The byte length of the result must be the same +as the original length.

    +

    Cast 1D/long to 1D/unsigned bytes:

    +
    >>> import array
    +>>> a = array.array('l', [1,2,3])
    +>>> x = memoryview(a)
    +>>> x.format
    +'l'
    +>>> x.itemsize
    +8
    +>>> len(x)
    +3
    +>>> x.nbytes
    +24
    +>>> y = x.cast('B')
    +>>> y.format
    +'B'
    +>>> y.itemsize
    +1
    +>>> len(y)
    +24
    +>>> y.nbytes
    +24
    +
    +
    +

    Cast 1D/unsigned bytes to 1D/char:

    +
    >>> b = bytearray(b'zyz')
    +>>> x = memoryview(b)
    +>>> x[0] = b'a'
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +ValueError: memoryview: invalid value for format "B"
    +>>> y = x.cast('c')
    +>>> y[0] = b'a'
    +>>> b
    +bytearray(b'ayz')
    +
    +
    +

    Cast 1D/bytes to 3D/ints to 1D/signed char:

    +
    >>> import struct
    +>>> buf = struct.pack("i"*12, *list(range(12)))
    +>>> x = memoryview(buf)
    +>>> y = x.cast('i', shape=[2,2,3])
    +>>> y.tolist()
    +[[[0, 1, 2], [3, 4, 5]], [[6, 7, 8], [9, 10, 11]]]
    +>>> y.format
    +'i'
    +>>> y.itemsize
    +4
    +>>> len(y)
    +2
    +>>> y.nbytes
    +48
    +>>> z = y.cast('b')
    +>>> z.format
    +'b'
    +>>> z.itemsize
    +1
    +>>> len(z)
    +48
    +>>> z.nbytes
    +48
    +
    +
    +

    Cast 1D/unsigned long to 2D/unsigned long:

    +
    >>> buf = struct.pack("L"*6, *list(range(6)))
    +>>> x = memoryview(buf)
    +>>> y = x.cast('L', shape=[2,3])
    +>>> len(y)
    +2
    +>>> y.nbytes
    +48
    +>>> y.tolist()
    +[[0, 1, 2], [3, 4, 5]]
    +
    +
    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.5: The source format is no longer restricted when casting to a byte view.

    +
    +
    + +

    There are also several readonly attributes available:

    +
    +
    +obj
    +

    The underlying object of the memoryview:

    +
    >>> b  = bytearray(b'xyz')
    +>>> m = memoryview(b)
    +>>> m.obj is b
    +True
    +
    +
    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +nbytes
    +

    nbytes == product(shape) * itemsize == len(m.tobytes()). This is +the amount of space in bytes that the array would use in a contiguous +representation. It is not necessarily equal to len(m):

    +
    >>> import array
    +>>> a = array.array('i', [1,2,3,4,5])
    +>>> m = memoryview(a)
    +>>> len(m)
    +5
    +>>> m.nbytes
    +20
    +>>> y = m[::2]
    +>>> len(y)
    +3
    +>>> y.nbytes
    +12
    +>>> len(y.tobytes())
    +12
    +
    +
    +

    Multi-dimensional arrays:

    +
    >>> import struct
    +>>> buf = struct.pack("d"*12, *[1.5*x for x in range(12)])
    +>>> x = memoryview(buf)
    +>>> y = x.cast('d', shape=[3,4])
    +>>> y.tolist()
    +[[0.0, 1.5, 3.0, 4.5], [6.0, 7.5, 9.0, 10.5], [12.0, 13.5, 15.0, 16.5]]
    +>>> len(y)
    +3
    +>>> y.nbytes
    +96
    +
    +
    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +readonly
    +

    A bool indicating whether the memory is read only.

    +
    + +
    +
    +format
    +

    A string containing the format (in struct module style) for each +element in the view. A memoryview can be created from exporters with +arbitrary format strings, but some methods (e.g. tolist()) are +restricted to native single element formats.

    +
    +

    Changed in version 3.3: format 'B' is now handled according to the struct module syntax. +This means that memoryview(b'abc')[0] == b'abc'[0] == 97.

    +
    +
    + +
    +
    +itemsize
    +

    The size in bytes of each element of the memoryview:

    +
    >>> import array, struct
    +>>> m = memoryview(array.array('H', [32000, 32001, 32002]))
    +>>> m.itemsize
    +2
    +>>> m[0]
    +32000
    +>>> struct.calcsize('H') == m.itemsize
    +True
    +
    +
    +
    + +
    +
    +ndim
    +

    An integer indicating how many dimensions of a multi-dimensional array the +memory represents.

    +
    + +
    +
    +shape
    +

    A tuple of integers the length of ndim giving the shape of the +memory as an N-dimensional array.

    +
    +

    Changed in version 3.3: An empty tuple instead of None when ndim = 0.

    +
    +
    + +
    +
    +strides
    +

    A tuple of integers the length of ndim giving the size in bytes to +access each element for each dimension of the array.

    +
    +

    Changed in version 3.3: An empty tuple instead of None when ndim = 0.

    +
    +
    + +
    +
    +suboffsets
    +

    Used internally for PIL-style arrays. The value is informational only.

    +
    + +
    +
    +c_contiguous
    +

    A bool indicating whether the memory is C-contiguous.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +f_contiguous
    +

    A bool indicating whether the memory is Fortran contiguous.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +contiguous
    +

    A bool indicating whether the memory is contiguous.

    +
    +

    New in version 3.3.

    +
    +
    + +
    + +
    +
    +
    +

    Set Types — set, frozenset

    +

    A set object is an unordered collection of distinct hashable objects. +Common uses include membership testing, removing duplicates from a sequence, and +computing mathematical operations such as intersection, union, difference, and +symmetric difference. +(For other containers see the built-in dict, list, +and tuple classes, and the collections module.)

    +

    Like other collections, sets support x in set, len(set), and for x in +set. Being an unordered collection, sets do not record element position or +order of insertion. Accordingly, sets do not support indexing, slicing, or +other sequence-like behavior.

    +

    There are currently two built-in set types, set and frozenset. +The set type is mutable — the contents can be changed using methods +like add() and remove(). Since it is mutable, it has no +hash value and cannot be used as either a dictionary key or as an element of +another set. The frozenset type is immutable and hashable — +its contents cannot be altered after it is created; it can therefore be used as +a dictionary key or as an element of another set.

    +

    Non-empty sets (not frozensets) can be created by placing a comma-separated list +of elements within braces, for example: {'jack', 'sjoerd'}, in addition to the +set constructor.

    +

    The constructors for both classes work the same:

    +
    +
    +class set([iterable])
    +
    +class frozenset([iterable])
    +

    Return a new set or frozenset object whose elements are taken from +iterable. The elements of a set must be hashable. To +represent sets of sets, the inner sets must be frozenset +objects. If iterable is not specified, a new empty set is +returned.

    +

    Instances of set and frozenset provide the following +operations:

    +
    +
    +len(s)
    +

    Return the number of elements in set s (cardinality of s).

    +
    + +
    +
    +x in s
    +

    Test x for membership in s.

    +
    + +
    +
    +x not in s
    +

    Test x for non-membership in s.

    +
    + +
    +
    +isdisjoint(other)
    +

    Return True if the set has no elements in common with other. Sets are +disjoint if and only if their intersection is the empty set.

    +
    + +
    +
    +issubset(other)
    +
    +set <= other
    +

    Test whether every element in the set is in other.

    +
    + +
    +
    +set < other
    +

    Test whether the set is a proper subset of other, that is, +set <= other and set != other.

    +
    + +
    +
    +issuperset(other)
    +
    +set >= other
    +

    Test whether every element in other is in the set.

    +
    + +
    +
    +set > other
    +

    Test whether the set is a proper superset of other, that is, set >= +other and set != other.

    +
    + +
    +
    +union(*others)
    +
    +set | other | ...
    +

    Return a new set with elements from the set and all others.

    +
    + +
    +
    +intersection(*others)
    +
    +set & other & ...
    +

    Return a new set with elements common to the set and all others.

    +
    + +
    +
    +difference(*others)
    +
    +set - other - ...
    +

    Return a new set with elements in the set that are not in the others.

    +
    + +
    +
    +symmetric_difference(other)
    +
    +set ^ other
    +

    Return a new set with elements in either the set or other but not both.

    +
    + +
    +
    +copy()
    +

    Return a shallow copy of the set.

    +
    + +

    Note, the non-operator versions of union(), intersection(), +difference(), and symmetric_difference(), issubset(), and +issuperset() methods will accept any iterable as an argument. In +contrast, their operator based counterparts require their arguments to be +sets. This precludes error-prone constructions like set('abc') & 'cbs' +in favor of the more readable set('abc').intersection('cbs').

    +

    Both set and frozenset support set to set comparisons. Two +sets are equal if and only if every element of each set is contained in the +other (each is a subset of the other). A set is less than another set if and +only if the first set is a proper subset of the second set (is a subset, but +is not equal). A set is greater than another set if and only if the first set +is a proper superset of the second set (is a superset, but is not equal).

    +

    Instances of set are compared to instances of frozenset +based on their members. For example, set('abc') == frozenset('abc') +returns True and so does set('abc') in set([frozenset('abc')]).

    +

    The subset and equality comparisons do not generalize to a total ordering +function. For example, any two nonempty disjoint sets are not equal and are not +subsets of each other, so all of the following return False: a<b, +a==b, or a>b.

    +

    Since sets only define partial ordering (subset relationships), the output of +the list.sort() method is undefined for lists of sets.

    +

    Set elements, like dictionary keys, must be hashable.

    +

    Binary operations that mix set instances with frozenset +return the type of the first operand. For example: frozenset('ab') | +set('bc') returns an instance of frozenset.

    +

    The following table lists operations available for set that do not +apply to immutable instances of frozenset:

    +
    +
    +update(*others)
    +
    +set |= other | ...
    +

    Update the set, adding elements from all others.

    +
    + +
    +
    +intersection_update(*others)
    +
    +set &= other & ...
    +

    Update the set, keeping only elements found in it and all others.

    +
    + +
    +
    +difference_update(*others)
    +
    +set -= other | ...
    +

    Update the set, removing elements found in others.

    +
    + +
    +
    +symmetric_difference_update(other)
    +
    +set ^= other
    +

    Update the set, keeping only elements found in either set, but not in both.

    +
    + +
    +
    +add(elem)
    +

    Add element elem to the set.

    +
    + +
    +
    +remove(elem)
    +

    Remove element elem from the set. Raises KeyError if elem is +not contained in the set.

    +
    + +
    +
    +discard(elem)
    +

    Remove element elem from the set if it is present.

    +
    + +
    +
    +pop()
    +

    Remove and return an arbitrary element from the set. Raises +KeyError if the set is empty.

    +
    + +
    +
    +clear()
    +

    Remove all elements from the set.

    +
    + +

    Note, the non-operator versions of the update(), +intersection_update(), difference_update(), and +symmetric_difference_update() methods will accept any iterable as an +argument.

    +

    Note, the elem argument to the __contains__(), remove(), and +discard() methods may be a set. To support searching for an equivalent +frozenset, a temporary one is created from elem.

    +
    + +
    +
    +

    Mapping Types — dict

    +

    A mapping object maps hashable values to arbitrary objects. +Mappings are mutable objects. There is currently only one standard mapping +type, the dictionary. (For other containers see the built-in +list, set, and tuple classes, and the +collections module.)

    +

    A dictionary’s keys are almost arbitrary values. Values that are not +hashable, that is, values containing lists, dictionaries or other +mutable types (that are compared by value rather than by object identity) may +not be used as keys. Numeric types used for keys obey the normal rules for +numeric comparison: if two numbers compare equal (such as 1 and 1.0) +then they can be used interchangeably to index the same dictionary entry. (Note +however, that since computers store floating-point numbers as approximations it +is usually unwise to use them as dictionary keys.)

    +

    Dictionaries can be created by placing a comma-separated list of key: value +pairs within braces, for example: {'jack': 4098, 'sjoerd': 4127} or {4098: +'jack', 4127: 'sjoerd'}, or by the dict constructor.

    +
    +
    +class dict(**kwarg)
    +
    +class dict(mapping, **kwarg)
    +
    +class dict(iterable, **kwarg)
    +

    Return a new dictionary initialized from an optional positional argument +and a possibly empty set of keyword arguments.

    +

    If no positional argument is given, an empty dictionary is created. +If a positional argument is given and it is a mapping object, a dictionary +is created with the same key-value pairs as the mapping object. Otherwise, +the positional argument must be an iterable object. Each item in +the iterable must itself be an iterable with exactly two objects. The +first object of each item becomes a key in the new dictionary, and the +second object the corresponding value. If a key occurs more than once, the +last value for that key becomes the corresponding value in the new +dictionary.

    +

    If keyword arguments are given, the keyword arguments and their values are +added to the dictionary created from the positional argument. If a key +being added is already present, the value from the keyword argument +replaces the value from the positional argument.

    +

    To illustrate, the following examples all return a dictionary equal to +{"one": 1, "two": 2, "three": 3}:

    +
    >>> a = dict(one=1, two=2, three=3)
    +>>> b = {'one': 1, 'two': 2, 'three': 3}
    +>>> c = dict(zip(['one', 'two', 'three'], [1, 2, 3]))
    +>>> d = dict([('two', 2), ('one', 1), ('three', 3)])
    +>>> e = dict({'three': 3, 'one': 1, 'two': 2})
    +>>> a == b == c == d == e
    +True
    +
    +
    +

    Providing keyword arguments as in the first example only works for keys that +are valid Python identifiers. Otherwise, any valid keys can be used.

    +

    These are the operations that dictionaries support (and therefore, custom +mapping types should support too):

    +
    +
    +len(d)
    +

    Return the number of items in the dictionary d.

    +
    + +
    +
    +d[key]
    +

    Return the item of d with key key. Raises a KeyError if key is +not in the map.

    +

    If a subclass of dict defines a method __missing__() and key +is not present, the d[key] operation calls that method with the key key +as argument. The d[key] operation then returns or raises whatever is +returned or raised by the __missing__(key) call. +No other operations or methods invoke __missing__(). If +__missing__() is not defined, KeyError is raised. +__missing__() must be a method; it cannot be an instance variable:

    +
    >>> class Counter(dict):
    +...     def __missing__(self, key):
    +...         return 0
    +>>> c = Counter()
    +>>> c['red']
    +0
    +>>> c['red'] += 1
    +>>> c['red']
    +1
    +
    +
    +

    The example above shows part of the implementation of +collections.Counter. A different __missing__ method is used +by collections.defaultdict.

    +
    + +
    +
    +d[key] = value
    +

    Set d[key] to value.

    +
    + +
    +
    +del d[key]
    +

    Remove d[key] from d. Raises a KeyError if key is not in the +map.

    +
    + +
    +
    +key in d
    +

    Return True if d has a key key, else False.

    +
    + +
    +
    +key not in d
    +

    Equivalent to not key in d.

    +
    + +
    +
    +iter(d)
    +

    Return an iterator over the keys of the dictionary. This is a shortcut +for iter(d.keys()).

    +
    + +
    +
    +clear()
    +

    Remove all items from the dictionary.

    +
    + +
    +
    +copy()
    +

    Return a shallow copy of the dictionary.

    +
    + +
    +
    +classmethod fromkeys(iterable[, value])
    +

    Create a new dictionary with keys from iterable and values set to value.

    +

    fromkeys() is a class method that returns a new dictionary. value +defaults to None.

    +
    + +
    +
    +get(key[, default])
    +

    Return the value for key if key is in the dictionary, else default. +If default is not given, it defaults to None, so that this method +never raises a KeyError.

    +
    + +
    +
    +items()
    +

    Return a new view of the dictionary’s items ((key, value) pairs). +See the documentation of view objects.

    +
    + +
    +
    +keys()
    +

    Return a new view of the dictionary’s keys. See the documentation +of view objects.

    +
    + +
    +
    +pop(key[, default])
    +

    If key is in the dictionary, remove it and return its value, else return +default. If default is not given and key is not in the dictionary, +a KeyError is raised.

    +
    + +
    +
    +popitem()
    +

    Remove and return a (key, value) pair from the dictionary. +Pairs are returned in LIFO order.

    +

    popitem() is useful to destructively iterate over a dictionary, as +often used in set algorithms. If the dictionary is empty, calling +popitem() raises a KeyError.

    +
    +

    Changed in version 3.7: LIFO order is now guaranteed. In prior versions, popitem() would +return an arbitrary key/value pair.

    +
    +
    + +
    +
    +setdefault(key[, default])
    +

    If key is in the dictionary, return its value. If not, insert key +with a value of default and return default. default defaults to +None.

    +
    + +
    +
    +update([other])
    +

    Update the dictionary with the key/value pairs from other, overwriting +existing keys. Return None.

    +

    update() accepts either another dictionary object or an iterable of +key/value pairs (as tuples or other iterables of length two). If keyword +arguments are specified, the dictionary is then updated with those +key/value pairs: d.update(red=1, blue=2).

    +
    + +
    +
    +values()
    +

    Return a new view of the dictionary’s values. See the +documentation of view objects.

    +
    + +

    Dictionaries compare equal if and only if they have the same (key, +value) pairs. Order comparisons (‘<’, ‘<=’, ‘>=’, ‘>’) raise +TypeError.

    +

    Dictionaries preserve insertion order. Note that updating a key does not +affect the order. Keys added after deletion are inserted at the end.

    +
    >>> d = {"one": 1, "two": 2, "three": 3, "four": 4}
    +>>> d
    +{'one': 1, 'two': 2, 'three': 3, 'four': 4}
    +>>> list(d)
    +['one', 'two', 'three', 'four']
    +>>> list(d.values())
    +[1, 2, 3, 4]
    +>>> d["one"] = 42
    +>>> d
    +{'one': 42, 'two': 2, 'three': 3, 'four': 4}
    +>>> del d["two"]
    +>>> d["two"] = None
    +>>> d
    +{'one': 42, 'three': 3, 'four': 4, 'two': None}
    +
    +
    +
    +

    Changed in version 3.7: Dictionary order is guaranteed to be insertion order. This behavior was +an implementation detail of CPython from 3.6.

    +
    +
    + +
    +

    See also

    +

    types.MappingProxyType can be used to create a read-only view +of a dict.

    +
    +
    +

    Dictionary view objects

    +

    The objects returned by dict.keys(), dict.values() and +dict.items() are view objects. They provide a dynamic view on the +dictionary’s entries, which means that when the dictionary changes, the view +reflects these changes.

    +

    Dictionary views can be iterated over to yield their respective data, and +support membership tests:

    +
    +
    +len(dictview)
    +

    Return the number of entries in the dictionary.

    +
    + +
    +
    +iter(dictview)
    +

    Return an iterator over the keys, values or items (represented as tuples of +(key, value)) in the dictionary.

    +

    Keys and values are iterated over in insertion order. +This allows the creation of (value, key) pairs +using zip(): pairs = zip(d.values(), d.keys()). Another way to +create the same list is pairs = [(v, k) for (k, v) in d.items()].

    +

    Iterating views while adding or deleting entries in the dictionary may raise +a RuntimeError or fail to iterate over all entries.

    +
    +

    Changed in version 3.7: Dictionary order is guaranteed to be insertion order.

    +
    +
    + +
    +
    +x in dictview
    +

    Return True if x is in the underlying dictionary’s keys, values or +items (in the latter case, x should be a (key, value) tuple).

    +
    + +

    Keys views are set-like since their entries are unique and hashable. If all +values are hashable, so that (key, value) pairs are unique and hashable, +then the items view is also set-like. (Values views are not treated as set-like +since the entries are generally not unique.) For set-like views, all of the +operations defined for the abstract base class collections.abc.Set are +available (for example, ==, <, or ^).

    +

    An example of dictionary view usage:

    +
    >>> dishes = {'eggs': 2, 'sausage': 1, 'bacon': 1, 'spam': 500}
    +>>> keys = dishes.keys()
    +>>> values = dishes.values()
    +
    +>>> # iteration
    +>>> n = 0
    +>>> for val in values:
    +...     n += val
    +>>> print(n)
    +504
    +
    +>>> # keys and values are iterated over in the same order (insertion order)
    +>>> list(keys)
    +['eggs', 'sausage', 'bacon', 'spam']
    +>>> list(values)
    +[2, 1, 1, 500]
    +
    +>>> # view objects are dynamic and reflect dict changes
    +>>> del dishes['eggs']
    +>>> del dishes['sausage']
    +>>> list(keys)
    +['bacon', 'spam']
    +
    +>>> # set operations
    +>>> keys & {'eggs', 'bacon', 'salad'}
    +{'bacon'}
    +>>> keys ^ {'sausage', 'juice'}
    +{'juice', 'sausage', 'bacon', 'spam'}
    +
    +
    +
    +
    +
    +

    Context Manager Types

    +

    Python’s with statement supports the concept of a runtime context +defined by a context manager. This is implemented using a pair of methods +that allow user-defined classes to define a runtime context that is entered +before the statement body is executed and exited when the statement ends:

    +
    +
    +contextmanager.__enter__()
    +

    Enter the runtime context and return either this object or another object +related to the runtime context. The value returned by this method is bound to +the identifier in the as clause of with statements using +this context manager.

    +

    An example of a context manager that returns itself is a file object. +File objects return themselves from __enter__() to allow open() to be +used as the context expression in a with statement.

    +

    An example of a context manager that returns a related object is the one +returned by decimal.localcontext(). These managers set the active +decimal context to a copy of the original decimal context and then return the +copy. This allows changes to be made to the current decimal context in the body +of the with statement without affecting code outside the +with statement.

    +
    + +
    +
    +contextmanager.__exit__(exc_type, exc_val, exc_tb)
    +

    Exit the runtime context and return a Boolean flag indicating if any exception +that occurred should be suppressed. If an exception occurred while executing the +body of the with statement, the arguments contain the exception type, +value and traceback information. Otherwise, all three arguments are None.

    +

    Returning a true value from this method will cause the with statement +to suppress the exception and continue execution with the statement immediately +following the with statement. Otherwise the exception continues +propagating after this method has finished executing. Exceptions that occur +during execution of this method will replace any exception that occurred in the +body of the with statement.

    +

    The exception passed in should never be reraised explicitly - instead, this +method should return a false value to indicate that the method completed +successfully and does not want to suppress the raised exception. This allows +context management code to easily detect whether or not an __exit__() +method has actually failed.

    +
    + +

    Python defines several context managers to support easy thread synchronisation, +prompt closure of files or other objects, and simpler manipulation of the active +decimal arithmetic context. The specific types are not treated specially beyond +their implementation of the context management protocol. See the +contextlib module for some examples.

    +

    Python’s generators and the contextlib.contextmanager decorator +provide a convenient way to implement these protocols. If a generator function is +decorated with the contextlib.contextmanager decorator, it will return a +context manager implementing the necessary __enter__() and +__exit__() methods, rather than the iterator produced by an undecorated +generator function.

    +

    Note that there is no specific slot for any of these methods in the type +structure for Python objects in the Python/C API. Extension types wanting to +define these methods must provide them as a normal Python accessible method. +Compared to the overhead of setting up the runtime context, the overhead of a +single class dictionary lookup is negligible.

    +
    +
    +

    Other Built-in Types

    +

    The interpreter supports several other kinds of objects. Most of these support +only one or two operations.

    +
    +

    Modules

    +

    The only special operation on a module is attribute access: m.name, where +m is a module and name accesses a name defined in m’s symbol table. +Module attributes can be assigned to. (Note that the import +statement is not, strictly speaking, an operation on a module object; import +foo does not require a module object named foo to exist, rather it requires +an (external) definition for a module named foo somewhere.)

    +

    A special attribute of every module is __dict__. This is the +dictionary containing the module’s symbol table. Modifying this dictionary will +actually change the module’s symbol table, but direct assignment to the +__dict__ attribute is not possible (you can write +m.__dict__['a'] = 1, which defines m.a to be 1, but you can’t write +m.__dict__ = {}). Modifying __dict__ directly is +not recommended.

    +

    Modules built into the interpreter are written like this: <module 'sys' +(built-in)>. If loaded from a file, they are written as <module 'os' from +'/usr/local/lib/pythonX.Y/os.pyc'>.

    +
    +
    +

    Classes and Class Instances

    +

    See Objects, values and types and Class definitions for these.

    +
    +
    +

    Functions

    +

    Function objects are created by function definitions. The only operation on a +function object is to call it: func(argument-list).

    +

    There are really two flavors of function objects: built-in functions and +user-defined functions. Both support the same operation (to call the function), +but the implementation is different, hence the different object types.

    +

    See Function definitions for more information.

    +
    +
    +

    Methods

    +

    Methods are functions that are called using the attribute notation. There are +two flavors: built-in methods (such as append() on lists) and class +instance methods. Built-in methods are described with the types that support +them.

    +

    If you access a method (a function defined in a class namespace) through an +instance, you get a special object: a bound method (also called +instance method) object. When called, it will add the self argument +to the argument list. Bound methods have two special read-only attributes: +m.__self__ is the object on which the method operates, and m.__func__ is +the function implementing the method. Calling m(arg-1, arg-2, ..., arg-n) +is completely equivalent to calling m.__func__(m.__self__, arg-1, arg-2, ..., +arg-n).

    +

    Like function objects, bound method objects support getting arbitrary +attributes. However, since method attributes are actually stored on the +underlying function object (meth.__func__), setting method attributes on +bound methods is disallowed. Attempting to set an attribute on a method +results in an AttributeError being raised. In order to set a method +attribute, you need to explicitly set it on the underlying function object:

    +
    >>> class C:
    +...     def method(self):
    +...         pass
    +...
    +>>> c = C()
    +>>> c.method.whoami = 'my name is method'  # can't set on the method
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +AttributeError: 'method' object has no attribute 'whoami'
    +>>> c.method.__func__.whoami = 'my name is method'
    +>>> c.method.whoami
    +'my name is method'
    +
    +
    +

    See The standard type hierarchy for more information.

    +
    +
    +

    Code Objects

    +

    Code objects are used by the implementation to represent “pseudo-compiled” +executable Python code such as a function body. They differ from function +objects because they don’t contain a reference to their global execution +environment. Code objects are returned by the built-in compile() function +and can be extracted from function objects through their __code__ +attribute. See also the code module.

    +

    A code object can be executed or evaluated by passing it (instead of a source +string) to the exec() or eval() built-in functions.

    +

    See The standard type hierarchy for more information.

    +
    +
    +

    Type Objects

    +

    Type objects represent the various object types. An object’s type is accessed +by the built-in function type(). There are no special operations on +types. The standard module types defines names for all standard built-in +types.

    +

    Types are written like this: <class 'int'>.

    +
    +
    +

    The Null Object

    +

    This object is returned by functions that don’t explicitly return a value. It +supports no special operations. There is exactly one null object, named +None (a built-in name). type(None)() produces the same singleton.

    +

    It is written as None.

    +
    +
    +

    The Ellipsis Object

    +

    This object is commonly used by slicing (see Slicings). It supports no +special operations. There is exactly one ellipsis object, named +Ellipsis (a built-in name). type(Ellipsis)() produces the +Ellipsis singleton.

    +

    It is written as Ellipsis or ....

    +
    +
    +

    The NotImplemented Object

    +

    This object is returned from comparisons and binary operations when they are +asked to operate on types they don’t support. See Comparisons for more +information. There is exactly one NotImplemented object. +type(NotImplemented)() produces the singleton instance.

    +

    It is written as NotImplemented.

    +
    +
    +

    Boolean Values

    +

    Boolean values are the two constant objects False and True. They are +used to represent truth values (although other values can also be considered +false or true). In numeric contexts (for example when used as the argument to +an arithmetic operator), they behave like the integers 0 and 1, respectively. +The built-in function bool() can be used to convert any value to a +Boolean, if the value can be interpreted as a truth value (see section +Truth Value Testing above).

    +

    They are written as False and True, respectively.

    +
    +
    +

    Internal Objects

    +

    See The standard type hierarchy for this information. It describes stack frame objects, +traceback objects, and slice objects.

    +
    +
    +
    +

    Special Attributes

    +

    The implementation adds a few special read-only attributes to several object +types, where they are relevant. Some of these are not reported by the +dir() built-in function.

    +
    +
    +object.__dict__
    +

    A dictionary or other mapping object used to store an object’s (writable) +attributes.

    +
    + +
    +
    +instance.__class__
    +

    The class to which a class instance belongs.

    +
    + +
    +
    +class.__bases__
    +

    The tuple of base classes of a class object.

    +
    + +
    +
    +definition.__name__
    +

    The name of the class, function, method, descriptor, or +generator instance.

    +
    + +
    +
    +definition.__qualname__
    +

    The qualified name of the class, function, method, descriptor, +or generator instance.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +class.__mro__
    +

    This attribute is a tuple of classes that are considered when looking for +base classes during method resolution.

    +
    + +
    +
    +class.mro()
    +

    This method can be overridden by a metaclass to customize the method +resolution order for its instances. It is called at class instantiation, and +its result is stored in __mro__.

    +
    + +
    +
    +class.__subclasses__()
    +

    Each class keeps a list of weak references to its immediate subclasses. This +method returns a list of all those references still alive. +Example:

    +
    >>> int.__subclasses__()
    +[<class 'bool'>]
    +
    +
    +
    + +

    Footnotes

    +
    +
    1
    +

    Additional information on these special methods may be found in the Python +Reference Manual (Basic customization).

    +
    +
    2
    +

    As a consequence, the list [1, 2] is considered equal to [1.0, 2.0], and +similarly for tuples.

    +
    +
    3
    +

    They must have since the parser can’t tell the type of the operands.

    +
    +
    4(1,2,3,4)
    +

    Cased characters are those with general category property being one of +“Lu” (Letter, uppercase), “Ll” (Letter, lowercase), or “Lt” (Letter, titlecase).

    +
    +
    5(1,2)
    +

    To format only a tuple you should therefore provide a singleton tuple whose only +element is the tuple to be formatted.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/string.html b/python-3.7.4-docs-html/library/string.html new file mode 100644 index 0000000..4598966 --- /dev/null +++ b/python-3.7.4-docs-html/library/string.html @@ -0,0 +1,1054 @@ + + + + + + + string — Common string operations — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    string — Common string operations

    +

    Source code: Lib/string.py

    +
    + +
    +

    String constants

    +

    The constants defined in this module are:

    +
    +
    +string.ascii_letters
    +

    The concatenation of the ascii_lowercase and ascii_uppercase +constants described below. This value is not locale-dependent.

    +
    + +
    +
    +string.ascii_lowercase
    +

    The lowercase letters 'abcdefghijklmnopqrstuvwxyz'. This value is not +locale-dependent and will not change.

    +
    + +
    +
    +string.ascii_uppercase
    +

    The uppercase letters 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'. This value is not +locale-dependent and will not change.

    +
    + +
    +
    +string.digits
    +

    The string '0123456789'.

    +
    + +
    +
    +string.hexdigits
    +

    The string '0123456789abcdefABCDEF'.

    +
    + +
    +
    +string.octdigits
    +

    The string '01234567'.

    +
    + +
    +
    +string.punctuation
    +

    String of ASCII characters which are considered punctuation characters +in the C locale.

    +
    + +
    +
    +string.printable
    +

    String of ASCII characters which are considered printable. This is a +combination of digits, ascii_letters, punctuation, +and whitespace.

    +
    + +
    +
    +string.whitespace
    +

    A string containing all ASCII characters that are considered whitespace. +This includes the characters space, tab, linefeed, return, formfeed, and +vertical tab.

    +
    + +
    +
    +

    Custom String Formatting

    +

    The built-in string class provides the ability to do complex variable +substitutions and value formatting via the format() method described in +PEP 3101. The Formatter class in the string module allows +you to create and customize your own string formatting behaviors using the same +implementation as the built-in format() method.

    +
    +
    +class string.Formatter
    +

    The Formatter class has the following public methods:

    +
    +
    +format(format_string, *args, **kwargs)
    +

    The primary API method. It takes a format string and +an arbitrary set of positional and keyword arguments. +It is just a wrapper that calls vformat().

    +
    +

    Changed in version 3.7: A format string argument is now positional-only.

    +
    +
    + +
    +
    +vformat(format_string, args, kwargs)
    +

    This function does the actual work of formatting. It is exposed as a +separate function for cases where you want to pass in a predefined +dictionary of arguments, rather than unpacking and repacking the +dictionary as individual arguments using the *args and **kwargs +syntax. vformat() does the work of breaking up the format string +into character data and replacement fields. It calls the various +methods described below.

    +
    + +

    In addition, the Formatter defines a number of methods that are +intended to be replaced by subclasses:

    +
    +
    +parse(format_string)
    +

    Loop over the format_string and return an iterable of tuples +(literal_text, field_name, format_spec, conversion). This is used +by vformat() to break the string into either literal text, or +replacement fields.

    +

    The values in the tuple conceptually represent a span of literal text +followed by a single replacement field. If there is no literal text +(which can happen if two replacement fields occur consecutively), then +literal_text will be a zero-length string. If there is no replacement +field, then the values of field_name, format_spec and conversion +will be None.

    +
    + +
    +
    +get_field(field_name, args, kwargs)
    +

    Given field_name as returned by parse() (see above), convert it to +an object to be formatted. Returns a tuple (obj, used_key). The default +version takes strings of the form defined in PEP 3101, such as +“0[name]” or “label.title”. args and kwargs are as passed in to +vformat(). The return value used_key has the same meaning as the +key parameter to get_value().

    +
    + +
    +
    +get_value(key, args, kwargs)
    +

    Retrieve a given field value. The key argument will be either an +integer or a string. If it is an integer, it represents the index of the +positional argument in args; if it is a string, then it represents a +named argument in kwargs.

    +

    The args parameter is set to the list of positional arguments to +vformat(), and the kwargs parameter is set to the dictionary of +keyword arguments.

    +

    For compound field names, these functions are only called for the first +component of the field name; Subsequent components are handled through +normal attribute and indexing operations.

    +

    So for example, the field expression ‘0.name’ would cause +get_value() to be called with a key argument of 0. The name +attribute will be looked up after get_value() returns by calling the +built-in getattr() function.

    +

    If the index or keyword refers to an item that does not exist, then an +IndexError or KeyError should be raised.

    +
    + +
    +
    +check_unused_args(used_args, args, kwargs)
    +

    Implement checking for unused arguments if desired. The arguments to this +function is the set of all argument keys that were actually referred to in +the format string (integers for positional arguments, and strings for +named arguments), and a reference to the args and kwargs that was +passed to vformat. The set of unused args can be calculated from these +parameters. check_unused_args() is assumed to raise an exception if +the check fails.

    +
    + +
    +
    +format_field(value, format_spec)
    +

    format_field() simply calls the global format() built-in. The +method is provided so that subclasses can override it.

    +
    + +
    +
    +convert_field(value, conversion)
    +

    Converts the value (returned by get_field()) given a conversion type +(as in the tuple returned by the parse() method). The default +version understands ‘s’ (str), ‘r’ (repr) and ‘a’ (ascii) conversion +types.

    +
    + +
    + +
    +
    +

    Format String Syntax

    +

    The str.format() method and the Formatter class share the same +syntax for format strings (although in the case of Formatter, +subclasses can define their own format string syntax). The syntax is +related to that of formatted string literals, but +there are differences.

    +

    Format strings contain “replacement fields” surrounded by curly braces {}. +Anything that is not contained in braces is considered literal text, which is +copied unchanged to the output. If you need to include a brace character in the +literal text, it can be escaped by doubling: {{ and }}.

    +

    The grammar for a replacement field is as follows:

    +
    +
    +replacement_field ::=  "{" [field_name] ["!" conversion] [":" format_spec] "}"
    +field_name        ::=  arg_name ("." attribute_name | "[" element_index "]")*
    +arg_name          ::=  [identifier | digit+]
    +attribute_name    ::=  identifier
    +element_index     ::=  digit+ | index_string
    +index_string      ::=  <any source character except "]"> +
    +conversion        ::=  "r" | "s" | "a"
    +format_spec       ::=  <described in the next section>
    +
    +
    +

    In less formal terms, the replacement field can start with a field_name that specifies +the object whose value is to be formatted and inserted +into the output instead of the replacement field. +The field_name is optionally followed by a conversion field, which is +preceded by an exclamation point '!', and a format_spec, which is preceded +by a colon ':'. These specify a non-default format for the replacement value.

    +

    See also the Format Specification Mini-Language section.

    +

    The field_name itself begins with an arg_name that is either a number or a +keyword. If it’s a number, it refers to a positional argument, and if it’s a keyword, +it refers to a named keyword argument. If the numerical arg_names in a format string +are 0, 1, 2, … in sequence, they can all be omitted (not just some) +and the numbers 0, 1, 2, … will be automatically inserted in that order. +Because arg_name is not quote-delimited, it is not possible to specify arbitrary +dictionary keys (e.g., the strings '10' or ':-]') within a format string. +The arg_name can be followed by any number of index or +attribute expressions. An expression of the form '.name' selects the named +attribute using getattr(), while an expression of the form '[index]' +does an index lookup using __getitem__().

    +
    +

    Changed in version 3.1: The positional argument specifiers can be omitted for str.format(), +so '{} {}'.format(a, b) is equivalent to '{0} {1}'.format(a, b).

    +
    +
    +

    Changed in version 3.4: The positional argument specifiers can be omitted for Formatter.

    +
    +

    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'.
    +
    +
    +

    The conversion field causes a type coercion before formatting. Normally, the +job of formatting a value is done by the __format__() method of the value +itself. However, in some cases it is desirable to force a type to be formatted +as a string, overriding its own definition of formatting. By converting the +value to a string before calling __format__(), the normal formatting logic +is bypassed.

    +

    Three conversion flags are currently supported: '!s' which calls str() +on the value, '!r' which calls repr() and '!a' which calls +ascii().

    +

    Some examples:

    +
    "Harold's a clever {0!s}"        # Calls str() on the argument first
    +"Bring out the holy {name!r}"    # Calls repr() on the argument first
    +"More {!a}"                      # Calls ascii() on the argument first
    +
    +
    +

    The format_spec field contains a specification of how the value should be +presented, including such details as field width, alignment, padding, decimal +precision and so on. Each value type can define its own “formatting +mini-language” or interpretation of the format_spec.

    +

    Most built-in types support a common formatting mini-language, which is +described in the next section.

    +

    A format_spec field can also include nested replacement fields within it. +These nested replacement fields may contain a field name, conversion flag +and format specification, but deeper nesting is +not allowed. The replacement fields within the +format_spec are substituted before the format_spec string is interpreted. +This allows the formatting of a value to be dynamically specified.

    +

    See the Format examples section for some examples.

    +
    +

    Format Specification Mini-Language

    +

    “Format specifications” are used within replacement fields contained within a +format string to define how individual values are presented (see +Format String Syntax and Formatted string literals). +They can also be passed directly to the built-in +format() function. Each formattable type may define how the format +specification is to be interpreted.

    +

    Most built-in types implement the following options for format specifications, +although some of the formatting options are only supported by the numeric types.

    +

    A general convention is that an empty format string ("") produces +the same result as if you had called str() on the value. A +non-empty format string typically modifies the result.

    +

    The general form of a standard format specifier is:

    +
    +format_spec     ::=  [[fill]align][sign][#][0][width][grouping_option][.precision][type]
    +fill            ::=  <any character>
    +align           ::=  "<" | ">" | "=" | "^"
    +sign            ::=  "+" | "-" | " "
    +width           ::=  digit+
    +grouping_option ::=  "_" | ","
    +precision       ::=  digit+
    +type            ::=  "b" | "c" | "d" | "e" | "E" | "f" | "F" | "g" | "G" | "n" | "o" | "s" | "x" | "X" | "%"
    +
    +

    If a valid align value is specified, it can be preceded by a fill +character that can be any character and defaults to a space if omitted. +It is not possible to use a literal curly brace (“{” or “}”) as +the fill character in a formatted string literal or when using the str.format() +method. However, it is possible to insert a curly brace +with a nested replacement field. This limitation doesn’t +affect the format() function.

    +

    The meaning of the various alignment options is as follows:

    +
    +
    ++++ + + + + + + + + + + + + + + + + + + + +

    Option

    Meaning

    '<'

    Forces the field to be left-aligned within the available +space (this is the default for most objects).

    '>'

    Forces the field to be right-aligned within the +available space (this is the default for numbers).

    '='

    Forces the padding to be placed after the sign (if any) +but before the digits. This is used for printing fields +in the form ‘+000000120’. This alignment option is only +valid for numeric types. It becomes the default when ‘0’ +immediately precedes the field width.

    '^'

    Forces the field to be centered within the available +space.

    +
    +

    Note that unless a minimum field width is defined, the field width will always +be the same size as the data to fill it, so that the alignment option has no +meaning in this case.

    +

    The sign option is only valid for number types, and can be one of the +following:

    +
    +
    ++++ + + + + + + + + + + + + + + + + +

    Option

    Meaning

    '+'

    indicates that a sign should be used for both +positive as well as negative numbers.

    '-'

    indicates that a sign should be used only for negative +numbers (this is the default behavior).

    space

    indicates that a leading space should be used on +positive numbers, and a minus sign on negative numbers.

    +
    +

    The '#' option causes the “alternate form” to be used for the +conversion. The alternate form is defined differently for different +types. This option is only valid for integer, float, complex and +Decimal types. For integers, when binary, octal, or hexadecimal output +is used, this option adds the prefix respective '0b', '0o', or +'0x' to the output value. For floats, complex and Decimal the +alternate form causes the result of the conversion to always contain a +decimal-point character, even if no digits follow it. Normally, a +decimal-point character appears in the result of these conversions +only if a digit follows it. In addition, for 'g' and 'G' +conversions, trailing zeros are not removed from the result.

    +

    The ',' option signals the use of a comma for a thousands separator. +For a locale aware separator, use the 'n' integer presentation type +instead.

    +
    +

    Changed in version 3.1: Added the ',' option (see also PEP 378).

    +
    +

    The '_' option signals the use of an underscore for a thousands +separator for floating point presentation types and for integer +presentation type 'd'. For integer presentation types 'b', +'o', 'x', and 'X', underscores will be inserted every 4 +digits. For other presentation types, specifying this option is an +error.

    +
    +

    Changed in version 3.6: Added the '_' option (see also PEP 515).

    +
    +

    width is a decimal integer defining the minimum field width. If not +specified, then the field width will be determined by the content.

    +

    When no explicit alignment is given, preceding the width field by a zero +('0') character enables +sign-aware zero-padding for numeric types. This is equivalent to a fill +character of '0' with an alignment type of '='.

    +

    The precision is a decimal number indicating how many digits should be +displayed after the decimal point for a floating point value formatted with +'f' and 'F', or before and after the decimal point for a floating point +value formatted with 'g' or 'G'. For non-number types the field +indicates the maximum field size - in other words, how many characters will be +used from the field content. The precision is not allowed for integer values.

    +

    Finally, the type determines how the data should be presented.

    +

    The available string presentation types are:

    +
    +
    ++++ + + + + + + + + + + + + + +

    Type

    Meaning

    's'

    String format. This is the default type for strings and +may be omitted.

    None

    The same as 's'.

    +
    +

    The available integer presentation types are:

    +
    +
    ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Type

    Meaning

    'b'

    Binary format. Outputs the number in base 2.

    'c'

    Character. Converts the integer to the corresponding +unicode character before printing.

    'd'

    Decimal Integer. Outputs the number in base 10.

    'o'

    Octal format. Outputs the number in base 8.

    'x'

    Hex format. Outputs the number in base 16, using +lower-case letters for the digits above 9.

    'X'

    Hex format. Outputs the number in base 16, using +upper-case letters for the digits above 9.

    'n'

    Number. This is the same as 'd', except that it uses +the current locale setting to insert the appropriate +number separator characters.

    None

    The same as 'd'.

    +
    +

    In addition to the above presentation types, integers can be formatted +with the floating point presentation types listed below (except +'n' and None). When doing so, float() is used to convert the +integer to a floating point number before formatting.

    +

    The available presentation types for floating point and decimal values are:

    +
    +
    ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Type

    Meaning

    'e'

    Exponent notation. Prints the number in scientific +notation using the letter ‘e’ to indicate the exponent. +The default precision is 6.

    'E'

    Exponent notation. Same as 'e' except it uses an +upper case ‘E’ as the separator character.

    'f'

    Fixed-point notation. Displays the number as a +fixed-point number. The default precision is 6.

    'F'

    Fixed-point notation. Same as 'f', but converts +nan to NAN and inf to INF.

    'g'

    General format. For a given precision p >= 1, +this rounds the number to p significant digits and +then formats the result in either fixed-point format +or in scientific notation, depending on its magnitude.

    +

    The precise rules are as follows: suppose that the +result formatted with presentation type 'e' and +precision p-1 would have exponent exp. Then +if -4 <= exp < p, the number is formatted +with presentation type 'f' and precision +p-1-exp. Otherwise, the number is formatted +with presentation type 'e' and precision p-1. +In both cases insignificant trailing zeros are removed +from the significand, and the decimal point is also +removed if there are no remaining digits following it.

    +

    Positive and negative infinity, positive and negative +zero, and nans, are formatted as inf, -inf, +0, -0 and nan respectively, regardless of +the precision.

    +

    A precision of 0 is treated as equivalent to a +precision of 1. The default precision is 6.

    +

    'G'

    General format. Same as 'g' except switches to +'E' if the number gets too large. The +representations of infinity and NaN are uppercased, too.

    'n'

    Number. This is the same as 'g', except that it uses +the current locale setting to insert the appropriate +number separator characters.

    '%'

    Percentage. Multiplies the number by 100 and displays +in fixed ('f') format, followed by a percent sign.

    None

    Similar to 'g', except that fixed-point notation, +when used, has at least one digit past the decimal point. +The default precision is as high as needed to represent +the particular value. The overall effect is to match the +output of str() as altered by the other format +modifiers.

    +
    +
    +
    +

    Format examples

    +

    This section contains examples of the str.format() syntax and +comparison with the old %-formatting.

    +

    In most of the cases the syntax is similar to the old %-formatting, with the +addition of the {} and with : used instead of %. +For example, '%03.2f' can be translated to '{:03.2f}'.

    +

    The new format syntax also supports new and different options, shown in the +following examples.

    +

    Accessing arguments by position:

    +
    >>> '{0}, {1}, {2}'.format('a', 'b', 'c')
    +'a, b, c'
    +>>> '{}, {}, {}'.format('a', 'b', 'c')  # 3.1+ only
    +'a, b, c'
    +>>> '{2}, {1}, {0}'.format('a', 'b', 'c')
    +'c, b, a'
    +>>> '{2}, {1}, {0}'.format(*'abc')      # unpacking argument sequence
    +'c, b, a'
    +>>> '{0}{1}{0}'.format('abra', 'cad')   # arguments' indices can be repeated
    +'abracadabra'
    +
    +
    +

    Accessing arguments by name:

    +
    >>> 'Coordinates: {latitude}, {longitude}'.format(latitude='37.24N', longitude='-115.81W')
    +'Coordinates: 37.24N, -115.81W'
    +>>> coord = {'latitude': '37.24N', 'longitude': '-115.81W'}
    +>>> 'Coordinates: {latitude}, {longitude}'.format(**coord)
    +'Coordinates: 37.24N, -115.81W'
    +
    +
    +

    Accessing arguments’ attributes:

    +
    >>> c = 3-5j
    +>>> ('The complex number {0} is formed from the real part {0.real} '
    +...  'and the imaginary part {0.imag}.').format(c)
    +'The complex number (3-5j) is formed from the real part 3.0 and the imaginary part -5.0.'
    +>>> class Point:
    +...     def __init__(self, x, y):
    +...         self.x, self.y = x, y
    +...     def __str__(self):
    +...         return 'Point({self.x}, {self.y})'.format(self=self)
    +...
    +>>> str(Point(4, 2))
    +'Point(4, 2)'
    +
    +
    +

    Accessing arguments’ items:

    +
    >>> coord = (3, 5)
    +>>> 'X: {0[0]};  Y: {0[1]}'.format(coord)
    +'X: 3;  Y: 5'
    +
    +
    +

    Replacing %s and %r:

    +
    >>> "repr() shows quotes: {!r}; str() doesn't: {!s}".format('test1', 'test2')
    +"repr() shows quotes: 'test1'; str() doesn't: test2"
    +
    +
    +

    Aligning the text and specifying a width:

    +
    >>> '{:<30}'.format('left aligned')
    +'left aligned                  '
    +>>> '{:>30}'.format('right aligned')
    +'                 right aligned'
    +>>> '{:^30}'.format('centered')
    +'           centered           '
    +>>> '{:*^30}'.format('centered')  # use '*' as a fill char
    +'***********centered***********'
    +
    +
    +

    Replacing %+f, %-f, and % f and specifying a sign:

    +
    >>> '{:+f}; {:+f}'.format(3.14, -3.14)  # show it always
    +'+3.140000; -3.140000'
    +>>> '{: f}; {: f}'.format(3.14, -3.14)  # show a space for positive numbers
    +' 3.140000; -3.140000'
    +>>> '{:-f}; {:-f}'.format(3.14, -3.14)  # show only the minus -- same as '{:f}; {:f}'
    +'3.140000; -3.140000'
    +
    +
    +

    Replacing %x and %o and converting the value to different bases:

    +
    >>> # format also supports binary numbers
    +>>> "int: {0:d};  hex: {0:x};  oct: {0:o};  bin: {0:b}".format(42)
    +'int: 42;  hex: 2a;  oct: 52;  bin: 101010'
    +>>> # with 0x, 0o, or 0b as prefix:
    +>>> "int: {0:d};  hex: {0:#x};  oct: {0:#o};  bin: {0:#b}".format(42)
    +'int: 42;  hex: 0x2a;  oct: 0o52;  bin: 0b101010'
    +
    +
    +

    Using the comma as a thousands separator:

    +
    >>> '{:,}'.format(1234567890)
    +'1,234,567,890'
    +
    +
    +

    Expressing a percentage:

    +
    >>> points = 19
    +>>> total = 22
    +>>> 'Correct answers: {:.2%}'.format(points/total)
    +'Correct answers: 86.36%'
    +
    +
    +

    Using type-specific formatting:

    +
    >>> import datetime
    +>>> d = datetime.datetime(2010, 7, 4, 12, 15, 58)
    +>>> '{:%Y-%m-%d %H:%M:%S}'.format(d)
    +'2010-07-04 12:15:58'
    +
    +
    +

    Nesting arguments and more complex examples:

    +
    >>> for align, text in zip('<^>', ['left', 'center', 'right']):
    +...     '{0:{fill}{align}16}'.format(text, fill=align, align=align)
    +...
    +'left<<<<<<<<<<<<'
    +'^^^^^center^^^^^'
    +'>>>>>>>>>>>right'
    +>>>
    +>>> octets = [192, 168, 0, 1]
    +>>> '{:02X}{:02X}{:02X}{:02X}'.format(*octets)
    +'C0A80001'
    +>>> int(_, 16)
    +3232235521
    +>>>
    +>>> width = 5
    +>>> for num in range(5,12): 
    +...     for base in 'dXob':
    +...         print('{0:{width}{base}}'.format(num, base=base, width=width), end=' ')
    +...     print()
    +...
    +    5     5     5   101
    +    6     6     6   110
    +    7     7     7   111
    +    8     8    10  1000
    +    9     9    11  1001
    +   10     A    12  1010
    +   11     B    13  1011
    +
    +
    +
    +
    +
    +

    Template strings

    +

    Template strings provide simpler string substitutions as described in +PEP 292. A primary use case for template strings is for +internationalization (i18n) since in that context, the simpler syntax and +functionality makes it easier to translate than other built-in string +formatting facilities in Python. As an example of a library built on template +strings for i18n, see the +flufl.i18n package.

    +

    Template strings support $-based substitutions, using the following rules:

    +
      +
    • $$ is an escape; it is replaced with a single $.

    • +
    • $identifier names a substitution placeholder matching a mapping key of +"identifier". By default, "identifier" is restricted to any +case-insensitive ASCII alphanumeric string (including underscores) that +starts with an underscore or ASCII letter. The first non-identifier +character after the $ character terminates this placeholder +specification.

    • +
    • ${identifier} is equivalent to $identifier. It is required when +valid identifier characters follow the placeholder but are not part of the +placeholder, such as "${noun}ification".

    • +
    +

    Any other appearance of $ in the string will result in a ValueError +being raised.

    +

    The string module provides a Template class that implements +these rules. The methods of Template are:

    +
    +
    +class string.Template(template)
    +

    The constructor takes a single argument which is the template string.

    +
    +
    +substitute(mapping, **kwds)
    +

    Performs the template substitution, returning a new string. mapping is +any dictionary-like object with keys that match the placeholders in the +template. Alternatively, you can provide keyword arguments, where the +keywords are the placeholders. When both mapping and kwds are given +and there are duplicates, the placeholders from kwds take precedence.

    +
    + +
    +
    +safe_substitute(mapping, **kwds)
    +

    Like substitute(), except that if placeholders are missing from +mapping and kwds, instead of raising a KeyError exception, the +original placeholder will appear in the resulting string intact. Also, +unlike with substitute(), any other appearances of the $ will +simply return $ instead of raising ValueError.

    +

    While other exceptions may still occur, this method is called “safe” +because it always tries to return a usable string instead of +raising an exception. In another sense, safe_substitute() may be +anything other than safe, since it will silently ignore malformed +templates containing dangling delimiters, unmatched braces, or +placeholders that are not valid Python identifiers.

    +
    + +

    Template instances also provide one public data attribute:

    +
    +
    +template
    +

    This is the object passed to the constructor’s template argument. In +general, you shouldn’t change it, but read-only access is not enforced.

    +
    + +
    + +

    Here is an example of how to use a Template:

    +
    >>> from string import Template
    +>>> s = Template('$who likes $what')
    +>>> s.substitute(who='tim', what='kung pao')
    +'tim likes kung pao'
    +>>> d = dict(who='tim')
    +>>> Template('Give $who $100').substitute(d)
    +Traceback (most recent call last):
    +...
    +ValueError: Invalid placeholder in string: line 1, col 11
    +>>> Template('$who likes $what').substitute(d)
    +Traceback (most recent call last):
    +...
    +KeyError: 'what'
    +>>> Template('$who likes $what').safe_substitute(d)
    +'tim likes $what'
    +
    +
    +

    Advanced usage: you can derive subclasses of Template to customize +the placeholder syntax, delimiter character, or the entire regular expression +used to parse template strings. To do this, you can override these class +attributes:

    +
      +
    • delimiter – This is the literal string describing a placeholder +introducing delimiter. The default value is $. Note that this should +not be a regular expression, as the implementation will call +re.escape() on this string as needed. Note further that you cannot +change the delimiter after class creation (i.e. a different delimiter must +be set in the subclass’s class namespace).

    • +
    • idpattern – This is the regular expression describing the pattern for +non-braced placeholders. The default value is the regular expression +(?a:[_a-z][_a-z0-9]*). If this is given and braceidpattern is +None this pattern will also apply to braced placeholders.

      +
      +

      Note

      +

      Since default flags is re.IGNORECASE, pattern [a-z] can match +with some non-ASCII characters. That’s why we use the local a flag +here.

      +
      +
      +

      Changed in version 3.7: braceidpattern can be used to define separate patterns used inside and +outside the braces.

      +
      +
    • +
    • braceidpattern – This is like idpattern but describes the pattern for +braced placeholders. Defaults to None which means to fall back to +idpattern (i.e. the same pattern is used both inside and outside braces). +If given, this allows you to define different patterns for braced and +unbraced placeholders.

      +
      +

      New in version 3.7.

      +
      +
    • +
    • flags – The regular expression flags that will be applied when compiling +the regular expression used for recognizing substitutions. The default value +is re.IGNORECASE. Note that re.VERBOSE will always be added to the +flags, so custom idpatterns must follow conventions for verbose regular +expressions.

      +
      +

      New in version 3.2.

      +
      +
    • +
    +

    Alternatively, you can provide the entire regular expression pattern by +overriding the class attribute pattern. If you do this, the value must be a +regular expression object with four named capturing groups. The capturing +groups correspond to the rules given above, along with the invalid placeholder +rule:

    +
      +
    • escaped – This group matches the escape sequence, e.g. $$, in the +default pattern.

    • +
    • named – This group matches the unbraced placeholder name; it should not +include the delimiter in capturing group.

    • +
    • braced – This group matches the brace enclosed placeholder name; it should +not include either the delimiter or braces in the capturing group.

    • +
    • invalid – This group matches any other delimiter pattern (usually a single +delimiter), and it should appear last in the regular expression.

    • +
    +
    +
    +

    Helper functions

    +
    +
    +string.capwords(s, sep=None)
    +

    Split the argument into words using str.split(), capitalize each word +using str.capitalize(), and join the capitalized words using +str.join(). If the optional second argument sep is absent +or None, runs of whitespace characters are replaced by a single space +and leading and trailing whitespace are removed, otherwise sep is used to +split and join the words.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/stringprep.html b/python-3.7.4-docs-html/library/stringprep.html new file mode 100644 index 0000000..042e53c --- /dev/null +++ b/python-3.7.4-docs-html/library/stringprep.html @@ -0,0 +1,330 @@ + + + + + + + stringprep — Internet String Preparation — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    stringprep — Internet String Preparation

    +

    Source code: Lib/stringprep.py

    +
    +

    When identifying things (such as host names) in the internet, it is often +necessary to compare such identifications for “equality”. Exactly how this +comparison is executed may depend on the application domain, e.g. whether it +should be case-insensitive or not. It may be also necessary to restrict the +possible identifications, to allow only identifications consisting of +“printable” characters.

    +

    RFC 3454 defines a procedure for “preparing” Unicode strings in internet +protocols. Before passing strings onto the wire, they are processed with the +preparation procedure, after which they have a certain normalized form. The RFC +defines a set of tables, which can be combined into profiles. Each profile must +define which tables it uses, and what other optional parts of the stringprep +procedure are part of the profile. One example of a stringprep profile is +nameprep, which is used for internationalized domain names.

    +

    The module stringprep only exposes the tables from RFC 3454. As these +tables would be very large to represent them as dictionaries or lists, the +module uses the Unicode character database internally. The module source code +itself was generated using the mkstringprep.py utility.

    +

    As a result, these tables are exposed as functions, not as data structures. +There are two kinds of tables in the RFC: sets and mappings. For a set, +stringprep provides the “characteristic function”, i.e. a function that +returns true if the parameter is part of the set. For mappings, it provides the +mapping function: given the key, it returns the associated value. Below is a +list of all functions available in the module.

    +
    +
    +stringprep.in_table_a1(code)
    +

    Determine whether code is in tableA.1 (Unassigned code points in Unicode 3.2).

    +
    + +
    +
    +stringprep.in_table_b1(code)
    +

    Determine whether code is in tableB.1 (Commonly mapped to nothing).

    +
    + +
    +
    +stringprep.map_table_b2(code)
    +

    Return the mapped value for code according to tableB.2 (Mapping for +case-folding used with NFKC).

    +
    + +
    +
    +stringprep.map_table_b3(code)
    +

    Return the mapped value for code according to tableB.3 (Mapping for +case-folding used with no normalization).

    +
    + +
    +
    +stringprep.in_table_c11(code)
    +

    Determine whether code is in tableC.1.1 (ASCII space characters).

    +
    + +
    +
    +stringprep.in_table_c12(code)
    +

    Determine whether code is in tableC.1.2 (Non-ASCII space characters).

    +
    + +
    +
    +stringprep.in_table_c11_c12(code)
    +

    Determine whether code is in tableC.1 (Space characters, union of C.1.1 and +C.1.2).

    +
    + +
    +
    +stringprep.in_table_c21(code)
    +

    Determine whether code is in tableC.2.1 (ASCII control characters).

    +
    + +
    +
    +stringprep.in_table_c22(code)
    +

    Determine whether code is in tableC.2.2 (Non-ASCII control characters).

    +
    + +
    +
    +stringprep.in_table_c21_c22(code)
    +

    Determine whether code is in tableC.2 (Control characters, union of C.2.1 and +C.2.2).

    +
    + +
    +
    +stringprep.in_table_c3(code)
    +

    Determine whether code is in tableC.3 (Private use).

    +
    + +
    +
    +stringprep.in_table_c4(code)
    +

    Determine whether code is in tableC.4 (Non-character code points).

    +
    + +
    +
    +stringprep.in_table_c5(code)
    +

    Determine whether code is in tableC.5 (Surrogate codes).

    +
    + +
    +
    +stringprep.in_table_c6(code)
    +

    Determine whether code is in tableC.6 (Inappropriate for plain text).

    +
    + +
    +
    +stringprep.in_table_c7(code)
    +

    Determine whether code is in tableC.7 (Inappropriate for canonical +representation).

    +
    + +
    +
    +stringprep.in_table_c8(code)
    +

    Determine whether code is in tableC.8 (Change display properties or are +deprecated).

    +
    + +
    +
    +stringprep.in_table_c9(code)
    +

    Determine whether code is in tableC.9 (Tagging characters).

    +
    + +
    +
    +stringprep.in_table_d1(code)
    +

    Determine whether code is in tableD.1 (Characters with bidirectional property +“R” or “AL”).

    +
    + +
    +
    +stringprep.in_table_d2(code)
    +

    Determine whether code is in tableD.2 (Characters with bidirectional property +“L”).

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/struct.html b/python-3.7.4-docs-html/library/struct.html new file mode 100644 index 0000000..0450ca0 --- /dev/null +++ b/python-3.7.4-docs-html/library/struct.html @@ -0,0 +1,737 @@ + + + + + + + struct — Interpret bytes as packed binary data — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    struct — Interpret bytes as packed binary data

    +

    Source code: Lib/struct.py

    +
    +

    This module performs conversions between Python values and C structs represented +as Python bytes objects. This can be used in handling binary data +stored in files or from network connections, among other sources. It uses +Format Strings as compact descriptions of the layout of the C +structs and the intended conversion to/from Python values.

    +
    +

    Note

    +

    By default, the result of packing a given C struct includes pad bytes in +order to maintain proper alignment for the C types involved; similarly, +alignment is taken into account when unpacking. This behavior is chosen so +that the bytes of a packed struct correspond exactly to the layout in memory +of the corresponding C struct. To handle platform-independent data formats +or omit implicit pad bytes, use standard size and alignment instead of +native size and alignment: see Byte Order, Size, and Alignment for details.

    +
    +

    Several struct functions (and methods of Struct) take a buffer +argument. This refers to objects that implement the Buffer Protocol and +provide either a readable or read-writable buffer. The most common types used +for that purpose are bytes and bytearray, but many other types +that can be viewed as an array of bytes implement the buffer protocol, so that +they can be read/filled without additional copying from a bytes object.

    +
    +

    Functions and Exceptions

    +

    The module defines the following exception and functions:

    +
    +
    +exception struct.error
    +

    Exception raised on various occasions; argument is a string describing what +is wrong.

    +
    + +
    +
    +struct.pack(format, v1, v2, ...)
    +

    Return a bytes object containing the values v1, v2, … packed according +to the format string format. The arguments must match the values required by +the format exactly.

    +
    + +
    +
    +struct.pack_into(format, buffer, offset, v1, v2, ...)
    +

    Pack the values v1, v2, … according to the format string format and +write the packed bytes into the writable buffer buffer starting at +position offset. Note that offset is a required argument.

    +
    + +
    +
    +struct.unpack(format, buffer)
    +

    Unpack from the buffer buffer (presumably packed by pack(format, ...)) +according to the format string format. The result is a tuple even if it +contains exactly one item. The buffer’s size in bytes must match the +size required by the format, as reflected by calcsize().

    +
    + +
    +
    +struct.unpack_from(format, buffer, offset=0)
    +

    Unpack from buffer starting at position offset, according to the format +string format. The result is a tuple even if it contains exactly one +item. The buffer’s size in bytes, minus offset, must be at least +the size required by the format, as reflected by calcsize().

    +
    + +
    +
    +struct.iter_unpack(format, buffer)
    +

    Iteratively unpack from the buffer buffer according to the format +string format. This function returns an iterator which will read +equally-sized chunks from the buffer until all its contents have been +consumed. The buffer’s size in bytes must be a multiple of the size +required by the format, as reflected by calcsize().

    +

    Each iteration yields a tuple as specified by the format string.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +struct.calcsize(format)
    +

    Return the size of the struct (and hence of the bytes object produced by +pack(format, ...)) corresponding to the format string format.

    +
    + +
    +
    +

    Format Strings

    +

    Format strings are the mechanism used to specify the expected layout when +packing and unpacking data. They are built up from Format Characters, +which specify the type of data being packed/unpacked. In addition, there are +special characters for controlling the Byte Order, Size, and Alignment.

    +
    +

    Byte Order, Size, and Alignment

    +

    By default, C types are represented in the machine’s native format and byte +order, and properly aligned by skipping pad bytes if necessary (according to the +rules used by the C compiler).

    +

    Alternatively, the first character of the format string can be used to indicate +the byte order, size and alignment of the packed data, according to the +following table:

    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Character

    Byte order

    Size

    Alignment

    @

    native

    native

    native

    =

    native

    standard

    none

    <

    little-endian

    standard

    none

    >

    big-endian

    standard

    none

    !

    network (= big-endian)

    standard

    none

    +

    If the first character is not one of these, '@' is assumed.

    +

    Native byte order is big-endian or little-endian, depending on the host +system. For example, Intel x86 and AMD64 (x86-64) are little-endian; +Motorola 68000 and PowerPC G5 are big-endian; ARM and Intel Itanium feature +switchable endianness (bi-endian). Use sys.byteorder to check the +endianness of your system.

    +

    Native size and alignment are determined using the C compiler’s +sizeof expression. This is always combined with native byte order.

    +

    Standard size depends only on the format character; see the table in +the Format Characters section.

    +

    Note the difference between '@' and '=': both use native byte order, but +the size and alignment of the latter is standardized.

    +

    The form '!' is available for those poor souls who claim they can’t remember +whether network byte order is big-endian or little-endian.

    +

    There is no way to indicate non-native byte order (force byte-swapping); use the +appropriate choice of '<' or '>'.

    +

    Notes:

    +
      +
    1. Padding is only automatically added between successive structure members. +No padding is added at the beginning or the end of the encoded struct.

    2. +
    3. No padding is added when using non-native size and alignment, e.g. +with ‘<’, ‘>’, ‘=’, and ‘!’.

    4. +
    5. To align the end of a structure to the alignment requirement of a +particular type, end the format with the code for that type with a repeat +count of zero. See Examples.

    6. +
    +
    +
    +

    Format Characters

    +

    Format characters have the following meaning; the conversion between C and +Python values should be obvious given their types. The ‘Standard size’ column +refers to the size of the packed value in bytes when using standard size; that +is, when the format string starts with one of '<', '>', '!' or +'='. When using native size, the size of the packed value is +platform-dependent.

    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Format

    C Type

    Python type

    Standard size

    Notes

    x

    pad byte

    no value

    c

    char

    bytes of length 1

    1

    b

    signed char

    integer

    1

    (1),(3)

    B

    unsigned char

    integer

    1

    (3)

    ?

    _Bool

    bool

    1

    (1)

    h

    short

    integer

    2

    (3)

    H

    unsigned short

    integer

    2

    (3)

    i

    int

    integer

    4

    (3)

    I

    unsigned int

    integer

    4

    (3)

    l

    long

    integer

    4

    (3)

    L

    unsigned long

    integer

    4

    (3)

    q

    long long

    integer

    8

    (2), (3)

    Q

    unsigned long +long

    integer

    8

    (2), (3)

    n

    ssize_t

    integer

    (4)

    N

    size_t

    integer

    (4)

    e

    (7)

    float

    2

    (5)

    f

    float

    float

    4

    (5)

    d

    double

    float

    8

    (5)

    s

    char[]

    bytes

    p

    char[]

    bytes

    P

    void *

    integer

    (6)

    +
    +

    Changed in version 3.3: Added support for the 'n' and 'N' formats.

    +
    +
    +

    Changed in version 3.6: Added support for the 'e' format.

    +
    +

    Notes:

    +
      +
    1. The '?' conversion code corresponds to the _Bool type defined by +C99. If this type is not available, it is simulated using a char. In +standard mode, it is always represented by one byte.

      +
    2. +
    3. The 'q' and 'Q' conversion codes are available in native mode only if +the platform C compiler supports C long long, or, on Windows, +__int64. They are always available in standard modes.

    4. +
    5. When attempting to pack a non-integer using any of the integer conversion +codes, if the non-integer has a __index__() method then that method is +called to convert the argument to an integer before packing.

      +
      +

      Changed in version 3.2: Use of the __index__() method for non-integers is new in 3.2.

      +
      +
    6. +
    7. The 'n' and 'N' conversion codes are only available for the native +size (selected as the default or with the '@' byte order character). +For the standard size, you can use whichever of the other integer formats +fits your application.

    8. +
    9. For the 'f', 'd' and 'e' conversion codes, the packed +representation uses the IEEE 754 binary32, binary64 or binary16 format (for +'f', 'd' or 'e' respectively), regardless of the floating-point +format used by the platform.

    10. +
    11. The 'P' format character is only available for the native byte ordering +(selected as the default or with the '@' byte order character). The byte +order character '=' chooses to use little- or big-endian ordering based +on the host system. The struct module does not interpret this as native +ordering, so the 'P' format is not available.

    12. +
    13. The IEEE 754 binary16 “half precision” type was introduced in the 2008 +revision of the IEEE 754 standard. It has a sign +bit, a 5-bit exponent and 11-bit precision (with 10 bits explicitly stored), +and can represent numbers between approximately 6.1e-05 and 6.5e+04 +at full precision. This type is not widely supported by C compilers: on a +typical machine, an unsigned short can be used for storage, but not for math +operations. See the Wikipedia page on the half-precision floating-point +format for more information.

    14. +
    +

    A format character may be preceded by an integral repeat count. For example, +the format string '4h' means exactly the same as 'hhhh'.

    +

    Whitespace characters between formats are ignored; a count and its format must +not contain whitespace though.

    +

    For the 's' format character, the count is interpreted as the length of the +bytes, not a repeat count like for the other format characters; for example, +'10s' means a single 10-byte string, while '10c' means 10 characters. +If a count is not given, it defaults to 1. For packing, the string is +truncated or padded with null bytes as appropriate to make it fit. For +unpacking, the resulting bytes object always has exactly the specified number +of bytes. As a special case, '0s' means a single, empty string (while +'0c' means 0 characters).

    +

    When packing a value x using one of the integer formats ('b', +'B', 'h', 'H', 'i', 'I', 'l', 'L', +'q', 'Q'), if x is outside the valid range for that format +then struct.error is raised.

    +
    +

    Changed in version 3.1: In 3.0, some of the integer formats wrapped out-of-range values and +raised DeprecationWarning instead of struct.error.

    +
    +

    The 'p' format character encodes a “Pascal string”, meaning a short +variable-length string stored in a fixed number of bytes, given by the count. +The first byte stored is the length of the string, or 255, whichever is +smaller. The bytes of the string follow. If the string passed in to +pack() is too long (longer than the count minus 1), only the leading +count-1 bytes of the string are stored. If the string is shorter than +count-1, it is padded with null bytes so that exactly count bytes in all +are used. Note that for unpack(), the 'p' format character consumes +count bytes, but that the string returned can never contain more than 255 +bytes.

    +

    For the '?' format character, the return value is either True or +False. When packing, the truth value of the argument object is used. +Either 0 or 1 in the native or standard bool representation will be packed, and +any non-zero value will be True when unpacking.

    +
    +
    +

    Examples

    +
    +

    Note

    +

    All examples assume a native byte order, size, and alignment with a +big-endian machine.

    +
    +

    A basic example of packing/unpacking three integers:

    +
    >>> from struct import *
    +>>> pack('hhl', 1, 2, 3)
    +b'\x00\x01\x00\x02\x00\x00\x00\x03'
    +>>> unpack('hhl', b'\x00\x01\x00\x02\x00\x00\x00\x03')
    +(1, 2, 3)
    +>>> calcsize('hhl')
    +8
    +
    +
    +

    Unpacked fields can be named by assigning them to variables or by wrapping +the result in a named tuple:

    +
    >>> record = b'raymond   \x32\x12\x08\x01\x08'
    +>>> name, serialnum, school, gradelevel = unpack('<10sHHb', record)
    +
    +>>> from collections import namedtuple
    +>>> Student = namedtuple('Student', 'name serialnum school gradelevel')
    +>>> Student._make(unpack('<10sHHb', record))
    +Student(name=b'raymond   ', serialnum=4658, school=264, gradelevel=8)
    +
    +
    +

    The ordering of format characters may have an impact on size since the padding +needed to satisfy alignment requirements is different:

    +
    >>> pack('ci', b'*', 0x12131415)
    +b'*\x00\x00\x00\x12\x13\x14\x15'
    +>>> pack('ic', 0x12131415, b'*')
    +b'\x12\x13\x14\x15*'
    +>>> calcsize('ci')
    +8
    +>>> calcsize('ic')
    +5
    +
    +
    +

    The following format 'llh0l' specifies two pad bytes at the end, assuming +longs are aligned on 4-byte boundaries:

    +
    >>> pack('llh0l', 1, 2, 3)
    +b'\x00\x00\x00\x01\x00\x00\x00\x02\x00\x03\x00\x00'
    +
    +
    +

    This only works when native size and alignment are in effect; standard size and +alignment does not enforce any alignment.

    +
    +

    See also

    +
    +
    Module array

    Packed binary storage of homogeneous data.

    +
    +
    Module xdrlib

    Packing and unpacking of XDR data.

    +
    +
    +
    +
    +
    +
    +

    Classes

    +

    The struct module also defines the following type:

    +
    +
    +class struct.Struct(format)
    +

    Return a new Struct object which writes and reads binary data according to +the format string format. Creating a Struct object once and calling its +methods is more efficient than calling the struct functions with the +same format since the format string only needs to be compiled once.

    +
    +

    Note

    +

    The compiled versions of the most recent format strings passed to +Struct and the module-level functions are cached, so programs +that use only a few format strings needn’t worry about reusing a single +Struct instance.

    +
    +

    Compiled Struct objects support the following methods and attributes:

    +
    +
    +pack(v1, v2, ...)
    +

    Identical to the pack() function, using the compiled format. +(len(result) will equal size.)

    +
    + +
    +
    +pack_into(buffer, offset, v1, v2, ...)
    +

    Identical to the pack_into() function, using the compiled format.

    +
    + +
    +
    +unpack(buffer)
    +

    Identical to the unpack() function, using the compiled format. +The buffer’s size in bytes must equal size.

    +
    + +
    +
    +unpack_from(buffer, offset=0)
    +

    Identical to the unpack_from() function, using the compiled format. +The buffer’s size in bytes, minus offset, must be at least +size.

    +
    + +
    +
    +iter_unpack(buffer)
    +

    Identical to the iter_unpack() function, using the compiled format. +The buffer’s size in bytes must be a multiple of size.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +format
    +

    The format string used to construct this Struct object.

    +
    +

    Changed in version 3.7: The format string type is now str instead of bytes.

    +
    +
    + +
    +
    +size
    +

    The calculated size of the struct (and hence of the bytes object produced +by the pack() method) corresponding to format.

    +
    + +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/subprocess.html b/python-3.7.4-docs-html/library/subprocess.html new file mode 100644 index 0000000..ef92ee8 --- /dev/null +++ b/python-3.7.4-docs-html/library/subprocess.html @@ -0,0 +1,1612 @@ + + + + + + + subprocess — Subprocess management — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    subprocess — Subprocess management

    +

    Source code: Lib/subprocess.py

    +
    +

    The subprocess module allows you to spawn new processes, connect to their +input/output/error pipes, and obtain their return codes. This module intends to +replace several older modules and functions:

    +
    os.system
    +os.spawn*
    +
    +
    +

    Information about how the subprocess module can be used to replace these +modules and functions can be found in the following sections.

    +
    +

    See also

    +

    PEP 324 – PEP proposing the subprocess module

    +
    +
    +

    Using the subprocess Module

    +

    The recommended approach to invoking subprocesses is to use the run() +function for all use cases it can handle. For more advanced use cases, the +underlying Popen interface can be used directly.

    +

    The run() function was added in Python 3.5; if you need to retain +compatibility with older versions, see the Older high-level API section.

    +
    +
    +subprocess.run(args, *, stdin=None, input=None, stdout=None, stderr=None, capture_output=False, shell=False, cwd=None, timeout=None, check=False, encoding=None, errors=None, text=None, env=None, universal_newlines=None)
    +

    Run the command described by args. Wait for command to complete, then +return a CompletedProcess instance.

    +

    The arguments shown above are merely the most common ones, described below +in Frequently Used Arguments (hence the use of keyword-only notation +in the abbreviated signature). The full function signature is largely the +same as that of the Popen constructor - most of the arguments to +this function are passed through to that interface. (timeout, input, +check, and capture_output are not.)

    +

    If capture_output is true, stdout and stderr will be captured. +When used, the internal Popen object is automatically created with +stdout=PIPE and stderr=PIPE. The stdout and stderr arguments may +not be supplied at the same time as capture_output. If you wish to capture +and combine both streams into one, use stdout=PIPE and stderr=STDOUT +instead of capture_output.

    +

    The timeout argument is passed to Popen.communicate(). If the timeout +expires, the child process will be killed and waited for. The +TimeoutExpired exception will be re-raised after the child process +has terminated.

    +

    The input argument is passed to Popen.communicate() and thus to the +subprocess’s stdin. If used it must be a byte sequence, or a string if +encoding or errors is specified or text is true. When +used, the internal Popen object is automatically created with +stdin=PIPE, and the stdin argument may not be used as well.

    +

    If check is true, and the process exits with a non-zero exit code, a +CalledProcessError exception will be raised. Attributes of that +exception hold the arguments, the exit code, and stdout and stderr if they +were captured.

    +

    If encoding or errors are specified, or text is true, +file objects for stdin, stdout and stderr are opened in text mode using the +specified encoding and errors or the io.TextIOWrapper default. +The universal_newlines argument is equivalent to text and is provided +for backwards compatibility. By default, file objects are opened in binary mode.

    +

    If env is not None, it must be a mapping that defines the environment +variables for the new process; these are used instead of the default +behavior of inheriting the current process’ environment. It is passed directly +to Popen.

    +

    Examples:

    +
    >>> subprocess.run(["ls", "-l"])  # doesn't capture output
    +CompletedProcess(args=['ls', '-l'], returncode=0)
    +
    +>>> subprocess.run("exit 1", shell=True, check=True)
    +Traceback (most recent call last):
    +  ...
    +subprocess.CalledProcessError: Command 'exit 1' returned non-zero exit status 1
    +
    +>>> subprocess.run(["ls", "-l", "/dev/null"], capture_output=True)
    +CompletedProcess(args=['ls', '-l', '/dev/null'], returncode=0,
    +stdout=b'crw-rw-rw- 1 root root 1, 3 Jan 23 16:23 /dev/null\n', stderr=b'')
    +
    +
    +
    +

    New in version 3.5.

    +
    +
    +

    Changed in version 3.6: Added encoding and errors parameters

    +
    +
    +

    Changed in version 3.7: Added the text parameter, as a more understandable alias of universal_newlines. +Added the capture_output parameter.

    +
    +
    + +
    +
    +class subprocess.CompletedProcess
    +

    The return value from run(), representing a process that has finished.

    +
    +
    +args
    +

    The arguments used to launch the process. This may be a list or a string.

    +
    + +
    +
    +returncode
    +

    Exit status of the child process. Typically, an exit status of 0 indicates +that it ran successfully.

    +

    A negative value -N indicates that the child was terminated by signal +N (POSIX only).

    +
    + +
    +
    +stdout
    +

    Captured stdout from the child process. A bytes sequence, or a string if +run() was called with an encoding, errors, or text=True. +None if stdout was not captured.

    +

    If you ran the process with stderr=subprocess.STDOUT, stdout and +stderr will be combined in this attribute, and stderr will be +None.

    +
    + +
    +
    +stderr
    +

    Captured stderr from the child process. A bytes sequence, or a string if +run() was called with an encoding, errors, or text=True. +None if stderr was not captured.

    +
    + +
    +
    +check_returncode()
    +

    If returncode is non-zero, raise a CalledProcessError.

    +
    + +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +subprocess.DEVNULL
    +

    Special value that can be used as the stdin, stdout or stderr argument +to Popen and indicates that the special file os.devnull +will be used.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +subprocess.PIPE
    +

    Special value that can be used as the stdin, stdout or stderr argument +to Popen and indicates that a pipe to the standard stream should be +opened. Most useful with Popen.communicate().

    +
    + +
    +
    +subprocess.STDOUT
    +

    Special value that can be used as the stderr argument to Popen and +indicates that standard error should go into the same handle as standard +output.

    +
    + +
    +
    +exception subprocess.SubprocessError
    +

    Base class for all other exceptions from this module.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +exception subprocess.TimeoutExpired
    +

    Subclass of SubprocessError, raised when a timeout expires +while waiting for a child process.

    +
    +
    +cmd
    +

    Command that was used to spawn the child process.

    +
    + +
    +
    +timeout
    +

    Timeout in seconds.

    +
    + +
    +
    +output
    +

    Output of the child process if it was captured by run() or +check_output(). Otherwise, None.

    +
    + +
    +
    +stdout
    +

    Alias for output, for symmetry with stderr.

    +
    + +
    +
    +stderr
    +

    Stderr output of the child process if it was captured by run(). +Otherwise, None.

    +
    + +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.5: stdout and stderr attributes added

    +
    +
    + +
    +
    +exception subprocess.CalledProcessError
    +

    Subclass of SubprocessError, raised when a process run by +check_call() or check_output() returns a non-zero exit status.

    +
    +
    +returncode
    +

    Exit status of the child process. If the process exited due to a +signal, this will be the negative signal number.

    +
    + +
    +
    +cmd
    +

    Command that was used to spawn the child process.

    +
    + +
    +
    +output
    +

    Output of the child process if it was captured by run() or +check_output(). Otherwise, None.

    +
    + +
    +
    +stdout
    +

    Alias for output, for symmetry with stderr.

    +
    + +
    +
    +stderr
    +

    Stderr output of the child process if it was captured by run(). +Otherwise, None.

    +
    + +
    +

    Changed in version 3.5: stdout and stderr attributes added

    +
    +
    + +
    +

    Frequently Used Arguments

    +

    To support a wide variety of use cases, the Popen constructor (and +the convenience functions) accept a large number of optional arguments. For +most typical use cases, many of these arguments can be safely left at their +default values. The arguments that are most commonly needed are:

    +
    +

    args is required for all calls and should be a string, or a sequence of +program arguments. Providing a sequence of arguments is generally +preferred, as it allows the module to take care of any required escaping +and quoting of arguments (e.g. to permit spaces in file names). If passing +a single string, either shell must be True (see below) or else +the string must simply name the program to be executed without specifying +any arguments.

    +

    stdin, stdout and stderr specify the executed program’s standard input, +standard output and standard error file handles, respectively. Valid values +are PIPE, DEVNULL, an existing file descriptor (a positive +integer), an existing file object, and None. PIPE indicates +that a new pipe to the child should be created. DEVNULL indicates +that the special file os.devnull will be used. With the default +settings of None, no redirection will occur; the child’s file handles +will be inherited from the parent. Additionally, stderr can be +STDOUT, which indicates that the stderr data from the child +process should be captured into the same file handle as for stdout.

    +

    If encoding or errors are specified, or text (also known as +universal_newlines) is true, +the file objects stdin, stdout and stderr will be opened in text +mode using the encoding and errors specified in the call or the +defaults for io.TextIOWrapper.

    +

    For stdin, line ending characters '\n' in the input will be converted +to the default line separator os.linesep. For stdout and stderr, +all line endings in the output will be converted to '\n'. For more +information see the documentation of the io.TextIOWrapper class +when the newline argument to its constructor is None.

    +

    If text mode is not used, stdin, stdout and stderr will be opened as +binary streams. No encoding or line ending conversion is performed.

    +
    +

    New in version 3.6: Added encoding and errors parameters.

    +
    +
    +

    New in version 3.7: Added the text parameter as an alias for universal_newlines.

    +
    +
    +

    Note

    +

    The newlines attribute of the file objects Popen.stdin, +Popen.stdout and Popen.stderr are not updated by +the Popen.communicate() method.

    +
    +

    If shell is True, the specified command will be executed through +the shell. This can be useful if you are using Python primarily for the +enhanced control flow it offers over most system shells and still want +convenient access to other shell features such as shell pipes, filename +wildcards, environment variable expansion, and expansion of ~ to a +user’s home directory. However, note that Python itself offers +implementations of many shell-like features (in particular, glob, +fnmatch, os.walk(), os.path.expandvars(), +os.path.expanduser(), and shutil).

    +
    +

    Changed in version 3.3: When universal_newlines is True, the class uses the encoding +locale.getpreferredencoding(False) +instead of locale.getpreferredencoding(). See the +io.TextIOWrapper class for more information on this change.

    +
    +
    +

    Note

    +

    Read the Security Considerations section before using shell=True.

    +
    +
    +

    These options, along with all of the other options, are described in more +detail in the Popen constructor documentation.

    +
    +
    +

    Popen Constructor

    +

    The underlying process creation and management in this module is handled by +the Popen class. It offers a lot of flexibility so that developers +are able to handle the less common cases not covered by the convenience +functions.

    +
    +
    +class subprocess.Popen(args, bufsize=-1, executable=None, stdin=None, stdout=None, stderr=None, preexec_fn=None, close_fds=True, shell=False, cwd=None, env=None, universal_newlines=None, startupinfo=None, creationflags=0, restore_signals=True, start_new_session=False, pass_fds=(), *, encoding=None, errors=None, text=None)
    +

    Execute a child program in a new process. On POSIX, the class uses +os.execvp()-like behavior to execute the child program. On Windows, +the class uses the Windows CreateProcess() function. The arguments to +Popen are as follows.

    +

    args should be a sequence of program arguments or else a single string. +By default, the program to execute is the first item in args if args is +a sequence. If args is a string, the interpretation is +platform-dependent and described below. See the shell and executable +arguments for additional differences from the default behavior. Unless +otherwise stated, it is recommended to pass args as a sequence.

    +

    On POSIX, if args is a string, the string is interpreted as the name or +path of the program to execute. However, this can only be done if not +passing arguments to the program.

    +
    +

    Note

    +

    shlex.split() can be useful when determining the correct +tokenization for args, especially in complex cases:

    +
    >>> import shlex, subprocess
    +>>> command_line = input()
    +/bin/vikings -input eggs.txt -output "spam spam.txt" -cmd "echo '$MONEY'"
    +>>> args = shlex.split(command_line)
    +>>> print(args)
    +['/bin/vikings', '-input', 'eggs.txt', '-output', 'spam spam.txt', '-cmd', "echo '$MONEY'"]
    +>>> p = subprocess.Popen(args) # Success!
    +
    +
    +

    Note in particular that options (such as -input) and arguments (such +as eggs.txt) that are separated by whitespace in the shell go in separate +list elements, while arguments that need quoting or backslash escaping when +used in the shell (such as filenames containing spaces or the echo command +shown above) are single list elements.

    +
    +

    On Windows, if args is a sequence, it will be converted to a string in a +manner described in Converting an argument sequence to a string on Windows. This is because +the underlying CreateProcess() operates on strings.

    +

    The shell argument (which defaults to False) specifies whether to use +the shell as the program to execute. If shell is True, it is +recommended to pass args as a string rather than as a sequence.

    +

    On POSIX with shell=True, the shell defaults to /bin/sh. If +args is a string, the string specifies the command +to execute through the shell. This means that the string must be +formatted exactly as it would be when typed at the shell prompt. This +includes, for example, quoting or backslash escaping filenames with spaces in +them. If args is a sequence, the first item specifies the command string, and +any additional items will be treated as additional arguments to the shell +itself. That is to say, Popen does the equivalent of:

    +
    Popen(['/bin/sh', '-c', args[0], args[1], ...])
    +
    +
    +

    On Windows with shell=True, the COMSPEC environment variable +specifies the default shell. The only time you need to specify +shell=True on Windows is when the command you wish to execute is built +into the shell (e.g. dir or copy). You do not need +shell=True to run a batch file or console-based executable.

    +
    +

    Note

    +

    Read the Security Considerations section before using shell=True.

    +
    +

    bufsize will be supplied as the corresponding argument to the +open() function when creating the stdin/stdout/stderr pipe +file objects:

    +
      +
    • 0 means unbuffered (read and write are one +system call and can return short)

    • +
    • 1 means line buffered +(only usable if universal_newlines=True i.e., in a text mode)

    • +
    • any other positive value means use a buffer of approximately that +size

    • +
    • negative bufsize (the default) means the system default of +io.DEFAULT_BUFFER_SIZE will be used.

    • +
    +
    +

    Changed in version 3.3.1: bufsize now defaults to -1 to enable buffering by default to match the +behavior that most code expects. In versions prior to Python 3.2.4 and +3.3.1 it incorrectly defaulted to 0 which was unbuffered +and allowed short reads. This was unintentional and did not match the +behavior of Python 2 as most code expected.

    +
    +

    The executable argument specifies a replacement program to execute. It +is very seldom needed. When shell=False, executable replaces the +program to execute specified by args. However, the original args is +still passed to the program. Most programs treat the program specified +by args as the command name, which can then be different from the program +actually executed. On POSIX, the args name +becomes the display name for the executable in utilities such as +ps. If shell=True, on POSIX the executable argument +specifies a replacement shell for the default /bin/sh.

    +

    stdin, stdout and stderr specify the executed program’s standard input, +standard output and standard error file handles, respectively. Valid values +are PIPE, DEVNULL, an existing file descriptor (a positive +integer), an existing file object, and None. PIPE +indicates that a new pipe to the child should be created. DEVNULL +indicates that the special file os.devnull will be used. With the +default settings of None, no redirection will occur; the child’s file +handles will be inherited from the parent. Additionally, stderr can be +STDOUT, which indicates that the stderr data from the applications +should be captured into the same file handle as for stdout.

    +

    If preexec_fn is set to a callable object, this object will be called in the +child process just before the child is executed. +(POSIX only)

    +
    +

    Warning

    +

    The preexec_fn parameter is not safe to use in the presence of threads +in your application. The child process could deadlock before exec is +called. +If you must use it, keep it trivial! Minimize the number of libraries +you call into.

    +
    +
    +

    Note

    +

    If you need to modify the environment for the child use the env +parameter rather than doing it in a preexec_fn. +The start_new_session parameter can take the place of a previously +common use of preexec_fn to call os.setsid() in the child.

    +
    +

    If close_fds is true, all file descriptors except 0, 1 and +2 will be closed before the child process is executed. Otherwise +when close_fds is false, file descriptors obey their inheritable flag +as described in Inheritance of File Descriptors.

    +

    On Windows, if close_fds is true then no handles will be inherited by the +child process unless explicitly passed in the handle_list element of +STARTUPINFO.lpAttributeList, or by standard handle redirection.

    +
    +

    Changed in version 3.2: The default for close_fds was changed from False to +what is described above.

    +
    +
    +

    Changed in version 3.7: On Windows the default for close_fds was changed from False to +True when redirecting the standard handles. It’s now possible to +set close_fds to True when redirecting the standard handles.

    +
    +

    pass_fds is an optional sequence of file descriptors to keep open +between the parent and child. Providing any pass_fds forces +close_fds to be True. (POSIX only)

    +
    +

    New in version 3.2: The pass_fds parameter was added.

    +
    +

    If cwd is not None, the function changes the working directory to +cwd before executing the child. cwd can be a str and +path-like object. In particular, the function +looks for executable (or for the first item in args) relative to cwd +if the executable path is a relative path.

    +
    +

    Changed in version 3.6: cwd parameter accepts a path-like object.

    +
    +

    If restore_signals is true (the default) all signals that Python has set to +SIG_IGN are restored to SIG_DFL in the child process before the exec. +Currently this includes the SIGPIPE, SIGXFZ and SIGXFSZ signals. +(POSIX only)

    +
    +

    Changed in version 3.2: restore_signals was added.

    +
    +

    If start_new_session is true the setsid() system call will be made in the +child process prior to the execution of the subprocess. (POSIX only)

    +
    +

    Changed in version 3.2: start_new_session was added.

    +
    +

    If env is not None, it must be a mapping that defines the environment +variables for the new process; these are used instead of the default +behavior of inheriting the current process’ environment.

    +
    +

    Note

    +

    If specified, env must provide any variables required for the program to +execute. On Windows, in order to run a side-by-side assembly the +specified env must include a valid SystemRoot.

    +
    +

    If encoding or errors are specified, or text is true, the file objects +stdin, stdout and stderr are opened in text mode with the specified +encoding and errors, as described above in Frequently Used Arguments. +The universal_newlines argument is equivalent to text and is provided +for backwards compatibility. By default, file objects are opened in binary mode.

    +
    +

    New in version 3.6: encoding and errors were added.

    +
    +
    +

    New in version 3.7: text was added as a more readable alias for universal_newlines.

    +
    +

    If given, startupinfo will be a STARTUPINFO object, which is +passed to the underlying CreateProcess function. +creationflags, if given, can be one or more of the following flags:

    +
    +
    +

    Popen objects are supported as context managers via the with statement: +on exit, standard file descriptors are closed, and the process is waited for.

    +
    with Popen(["ifconfig"], stdout=PIPE) as proc:
    +    log.write(proc.stdout.read())
    +
    +
    +
    +

    Changed in version 3.2: Added context manager support.

    +
    +
    +

    Changed in version 3.6: Popen destructor now emits a ResourceWarning warning if the child +process is still running.

    +
    +
    + +
    +
    +

    Exceptions

    +

    Exceptions raised in the child process, before the new program has started to +execute, will be re-raised in the parent.

    +

    The most common exception raised is OSError. This occurs, for example, +when trying to execute a non-existent file. Applications should prepare for +OSError exceptions.

    +

    A ValueError will be raised if Popen is called with invalid +arguments.

    +

    check_call() and check_output() will raise +CalledProcessError if the called process returns a non-zero return +code.

    +

    All of the functions and methods that accept a timeout parameter, such as +call() and Popen.communicate() will raise TimeoutExpired if +the timeout expires before the process exits.

    +

    Exceptions defined in this module all inherit from SubprocessError.

    +
    +
    +

    New in version 3.3: The SubprocessError base class was added.

    +
    +
    +
    +
    +
    +

    Security Considerations

    +

    Unlike some other popen functions, this implementation will never +implicitly call a system shell. This means that all characters, +including shell metacharacters, can safely be passed to child processes. +If the shell is invoked explicitly, via shell=True, it is the application’s +responsibility to ensure that all whitespace and metacharacters are +quoted appropriately to avoid +shell injection +vulnerabilities.

    +

    When using shell=True, the shlex.quote() function can be +used to properly escape whitespace and shell metacharacters in strings +that are going to be used to construct shell commands.

    +
    +
    +

    Popen Objects

    +

    Instances of the Popen class have the following methods:

    +
    +
    +Popen.poll()
    +

    Check if child process has terminated. Set and return +returncode attribute. Otherwise, returns None.

    +
    + +
    +
    +Popen.wait(timeout=None)
    +

    Wait for child process to terminate. Set and return +returncode attribute.

    +

    If the process does not terminate after timeout seconds, raise a +TimeoutExpired exception. It is safe to catch this exception and +retry the wait.

    +
    +

    Note

    +

    This will deadlock when using stdout=PIPE or stderr=PIPE +and the child process generates enough output to a pipe such that +it blocks waiting for the OS pipe buffer to accept more data. +Use Popen.communicate() when using pipes to avoid that.

    +
    +
    +

    Note

    +

    The function is implemented using a busy loop (non-blocking call and +short sleeps). Use the asyncio module for an asynchronous wait: +see asyncio.create_subprocess_exec.

    +
    +
    +

    Changed in version 3.3: timeout was added.

    +
    +
    + +
    +
    +Popen.communicate(input=None, timeout=None)
    +

    Interact with process: Send data to stdin. Read data from stdout and stderr, +until end-of-file is reached. Wait for process to terminate. The optional +input argument should be data to be sent to the child process, or +None, if no data should be sent to the child. If streams were opened in +text mode, input must be a string. Otherwise, it must be bytes.

    +

    communicate() returns a tuple (stdout_data, stderr_data). +The data will be strings if streams were opened in text mode; otherwise, +bytes.

    +

    Note that if you want to send data to the process’s stdin, you need to create +the Popen object with stdin=PIPE. Similarly, to get anything other than +None in the result tuple, you need to give stdout=PIPE and/or +stderr=PIPE too.

    +

    If the process does not terminate after timeout seconds, a +TimeoutExpired exception will be raised. Catching this exception and +retrying communication will not lose any output.

    +

    The child process is not killed if the timeout expires, so in order to +cleanup properly a well-behaved application should kill the child process and +finish communication:

    +
    proc = subprocess.Popen(...)
    +try:
    +    outs, errs = proc.communicate(timeout=15)
    +except TimeoutExpired:
    +    proc.kill()
    +    outs, errs = proc.communicate()
    +
    +
    +
    +

    Note

    +

    The data read is buffered in memory, so do not use this method if the data +size is large or unlimited.

    +
    +
    +

    Changed in version 3.3: timeout was added.

    +
    +
    + +
    +
    +Popen.send_signal(signal)
    +

    Sends the signal signal to the child.

    +
    +

    Note

    +

    On Windows, SIGTERM is an alias for terminate(). CTRL_C_EVENT and +CTRL_BREAK_EVENT can be sent to processes started with a creationflags +parameter which includes CREATE_NEW_PROCESS_GROUP.

    +
    +
    + +
    +
    +Popen.terminate()
    +

    Stop the child. On Posix OSs the method sends SIGTERM to the +child. On Windows the Win32 API function TerminateProcess() is called +to stop the child.

    +
    + +
    +
    +Popen.kill()
    +

    Kills the child. On Posix OSs the function sends SIGKILL to the child. +On Windows kill() is an alias for terminate().

    +
    + +

    The following attributes are also available:

    +
    +
    +Popen.args
    +

    The args argument as it was passed to Popen – a +sequence of program arguments or else a single string.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +Popen.stdin
    +

    If the stdin argument was PIPE, this attribute is a writeable +stream object as returned by open(). If the encoding or errors +arguments were specified or the universal_newlines argument was True, +the stream is a text stream, otherwise it is a byte stream. If the stdin +argument was not PIPE, this attribute is None.

    +
    + +
    +
    +Popen.stdout
    +

    If the stdout argument was PIPE, this attribute is a readable +stream object as returned by open(). Reading from the stream provides +output from the child process. If the encoding or errors arguments were +specified or the universal_newlines argument was True, the stream is a +text stream, otherwise it is a byte stream. If the stdout argument was not +PIPE, this attribute is None.

    +
    + +
    +
    +Popen.stderr
    +

    If the stderr argument was PIPE, this attribute is a readable +stream object as returned by open(). Reading from the stream provides +error output from the child process. If the encoding or errors arguments +were specified or the universal_newlines argument was True, the stream +is a text stream, otherwise it is a byte stream. If the stderr argument was +not PIPE, this attribute is None.

    +
    + +
    +

    Warning

    +

    Use communicate() rather than .stdin.write, +.stdout.read or .stderr.read to avoid +deadlocks due to any of the other OS pipe buffers filling up and blocking the +child process.

    +
    +
    +
    +Popen.pid
    +

    The process ID of the child process.

    +

    Note that if you set the shell argument to True, this is the process ID +of the spawned shell.

    +
    + +
    +
    +Popen.returncode
    +

    The child return code, set by poll() and wait() (and indirectly +by communicate()). A None value indicates that the process +hasn’t terminated yet.

    +

    A negative value -N indicates that the child was terminated by signal +N (POSIX only).

    +
    + +
    +
    +

    Windows Popen Helpers

    +

    The STARTUPINFO class and following constants are only available +on Windows.

    +
    +
    +class subprocess.STARTUPINFO(*, dwFlags=0, hStdInput=None, hStdOutput=None, hStdError=None, wShowWindow=0, lpAttributeList=None)
    +

    Partial support of the Windows +STARTUPINFO +structure is used for Popen creation. The following attributes can +be set by passing them as keyword-only arguments.

    +
    +

    Changed in version 3.7: Keyword-only argument support was added.

    +
    +
    +
    +dwFlags
    +

    A bit field that determines whether certain STARTUPINFO +attributes are used when the process creates a window.

    +
    si = subprocess.STARTUPINFO()
    +si.dwFlags = subprocess.STARTF_USESTDHANDLES | subprocess.STARTF_USESHOWWINDOW
    +
    +
    +
    + +
    +
    +hStdInput
    +

    If dwFlags specifies STARTF_USESTDHANDLES, this attribute +is the standard input handle for the process. If +STARTF_USESTDHANDLES is not specified, the default for standard +input is the keyboard buffer.

    +
    + +
    +
    +hStdOutput
    +

    If dwFlags specifies STARTF_USESTDHANDLES, this attribute +is the standard output handle for the process. Otherwise, this attribute +is ignored and the default for standard output is the console window’s +buffer.

    +
    + +
    +
    +hStdError
    +

    If dwFlags specifies STARTF_USESTDHANDLES, this attribute +is the standard error handle for the process. Otherwise, this attribute is +ignored and the default for standard error is the console window’s buffer.

    +
    + +
    +
    +wShowWindow
    +

    If dwFlags specifies STARTF_USESHOWWINDOW, this attribute +can be any of the values that can be specified in the nCmdShow +parameter for the +ShowWindow +function, except for SW_SHOWDEFAULT. Otherwise, this attribute is +ignored.

    +

    SW_HIDE is provided for this attribute. It is used when +Popen is called with shell=True.

    +
    + +
    +
    +lpAttributeList
    +

    A dictionary of additional attributes for process creation as given in +STARTUPINFOEX, see +UpdateProcThreadAttribute.

    +

    Supported attributes:

    +
    +
    handle_list

    Sequence of handles that will be inherited. close_fds must be true if +non-empty.

    +

    The handles must be temporarily made inheritable by +os.set_handle_inheritable() when passed to the Popen +constructor, else OSError will be raised with Windows error +ERROR_INVALID_PARAMETER (87).

    +
    +

    Warning

    +

    In a multithreaded process, use caution to avoid leaking handles +that are marked inheritable when combining this feature with +concurrent calls to other process creation functions that inherit +all handles such as os.system(). This also applies to +standard handle redirection, which temporarily creates inheritable +handles.

    +
    +
    +
    +
    +

    New in version 3.7.

    +
    +
    + +
    + +
    +

    Windows Constants

    +

    The subprocess module exposes the following constants.

    +
    +
    +subprocess.STD_INPUT_HANDLE
    +

    The standard input device. Initially, this is the console input buffer, +CONIN$.

    +
    + +
    +
    +subprocess.STD_OUTPUT_HANDLE
    +

    The standard output device. Initially, this is the active console screen +buffer, CONOUT$.

    +
    + +
    +
    +subprocess.STD_ERROR_HANDLE
    +

    The standard error device. Initially, this is the active console screen +buffer, CONOUT$.

    +
    + +
    +
    +subprocess.SW_HIDE
    +

    Hides the window. Another window will be activated.

    +
    + +
    +
    +subprocess.STARTF_USESTDHANDLES
    +

    Specifies that the STARTUPINFO.hStdInput, +STARTUPINFO.hStdOutput, and STARTUPINFO.hStdError attributes +contain additional information.

    +
    + +
    +
    +subprocess.STARTF_USESHOWWINDOW
    +

    Specifies that the STARTUPINFO.wShowWindow attribute contains +additional information.

    +
    + +
    +
    +subprocess.CREATE_NEW_CONSOLE
    +

    The new process has a new console, instead of inheriting its parent’s +console (the default).

    +
    + +
    +
    +subprocess.CREATE_NEW_PROCESS_GROUP
    +

    A Popen creationflags parameter to specify that a new process +group will be created. This flag is necessary for using os.kill() +on the subprocess.

    +

    This flag is ignored if CREATE_NEW_CONSOLE is specified.

    +
    + +
    +
    +subprocess.ABOVE_NORMAL_PRIORITY_CLASS
    +

    A Popen creationflags parameter to specify that a new process +will have an above average priority.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +subprocess.BELOW_NORMAL_PRIORITY_CLASS
    +

    A Popen creationflags parameter to specify that a new process +will have a below average priority.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +subprocess.HIGH_PRIORITY_CLASS
    +

    A Popen creationflags parameter to specify that a new process +will have a high priority.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +subprocess.IDLE_PRIORITY_CLASS
    +

    A Popen creationflags parameter to specify that a new process +will have an idle (lowest) priority.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +subprocess.NORMAL_PRIORITY_CLASS
    +

    A Popen creationflags parameter to specify that a new process +will have an normal priority. (default)

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +subprocess.REALTIME_PRIORITY_CLASS
    +

    A Popen creationflags parameter to specify that a new process +will have realtime priority. +You should almost never use REALTIME_PRIORITY_CLASS, because this interrupts +system threads that manage mouse input, keyboard input, and background disk +flushing. This class can be appropriate for applications that “talk” directly +to hardware or that perform brief tasks that should have limited interruptions.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +subprocess.CREATE_NO_WINDOW
    +

    A Popen creationflags parameter to specify that a new process +will not create a window.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +subprocess.DETACHED_PROCESS
    +

    A Popen creationflags parameter to specify that a new process +will not inherit its parent’s console. +This value cannot be used with CREATE_NEW_CONSOLE.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +subprocess.CREATE_DEFAULT_ERROR_MODE
    +

    A Popen creationflags parameter to specify that a new process +does not inherit the error mode of the calling process. Instead, the new +process gets the default error mode. +This feature is particularly useful for multithreaded shell applications +that run with hard errors disabled.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +subprocess.CREATE_BREAKAWAY_FROM_JOB
    +

    A Popen creationflags parameter to specify that a new process +is not associated with the job.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +
    +

    Older high-level API

    +

    Prior to Python 3.5, these three functions comprised the high level API to +subprocess. You can now use run() in many cases, but lots of existing code +calls these functions.

    +
    +
    +subprocess.call(args, *, stdin=None, stdout=None, stderr=None, shell=False, cwd=None, timeout=None)
    +

    Run the command described by args. Wait for command to complete, then +return the returncode attribute.

    +

    Code needing to capture stdout or stderr should use run() instead:

    +
    +

    run(…).returncode

    +
    +

    To suppress stdout or stderr, supply a value of DEVNULL.

    +

    The arguments shown above are merely some common ones. +The full function signature is the +same as that of the Popen constructor - this function passes all +supplied arguments other than timeout directly through to that interface.

    +
    +

    Note

    +

    Do not use stdout=PIPE or stderr=PIPE with this +function. The child process will block if it generates enough +output to a pipe to fill up the OS pipe buffer as the pipes are +not being read from.

    +
    +
    +

    Changed in version 3.3: timeout was added.

    +
    +
    + +
    +
    +subprocess.check_call(args, *, stdin=None, stdout=None, stderr=None, shell=False, cwd=None, timeout=None)
    +

    Run command with arguments. Wait for command to complete. If the return +code was zero then return, otherwise raise CalledProcessError. The +CalledProcessError object will have the return code in the +returncode attribute.

    +

    Code needing to capture stdout or stderr should use run() instead:

    +
    +

    run(…, check=True)

    +
    +

    To suppress stdout or stderr, supply a value of DEVNULL.

    +

    The arguments shown above are merely some common ones. +The full function signature is the +same as that of the Popen constructor - this function passes all +supplied arguments other than timeout directly through to that interface.

    +
    +

    Note

    +

    Do not use stdout=PIPE or stderr=PIPE with this +function. The child process will block if it generates enough +output to a pipe to fill up the OS pipe buffer as the pipes are +not being read from.

    +
    +
    +

    Changed in version 3.3: timeout was added.

    +
    +
    + +
    +
    +subprocess.check_output(args, *, stdin=None, stderr=None, shell=False, cwd=None, encoding=None, errors=None, universal_newlines=None, timeout=None, text=None)
    +

    Run command with arguments and return its output.

    +

    If the return code was non-zero it raises a CalledProcessError. The +CalledProcessError object will have the return code in the +returncode attribute and any output in the +output attribute.

    +

    This is equivalent to:

    +
    run(..., check=True, stdout=PIPE).stdout
    +
    +
    +

    The arguments shown above are merely some common ones. +The full function signature is largely the same as that of run() - +most arguments are passed directly through to that interface. +However, explicitly passing input=None to inherit the parent’s +standard input file handle is not supported.

    +

    By default, this function will return the data as encoded bytes. The actual +encoding of the output data may depend on the command being invoked, so the +decoding to text will often need to be handled at the application level.

    +

    This behaviour may be overridden by setting text, encoding, errors, +or universal_newlines to True as described in +Frequently Used Arguments and run().

    +

    To also capture standard error in the result, use +stderr=subprocess.STDOUT:

    +
    >>> subprocess.check_output(
    +...     "ls non_existent_file; exit 0",
    +...     stderr=subprocess.STDOUT,
    +...     shell=True)
    +'ls: non_existent_file: No such file or directory\n'
    +
    +
    +
    +

    New in version 3.1.

    +
    +
    +

    Changed in version 3.3: timeout was added.

    +
    +
    +

    Changed in version 3.4: Support for the input keyword argument was added.

    +
    +
    +

    Changed in version 3.6: encoding and errors were added. See run() for details.

    +
    +
    +

    New in version 3.7: text was added as a more readable alias for universal_newlines.

    +
    +
    + +
    +
    +

    Replacing Older Functions with the subprocess Module

    +

    In this section, “a becomes b” means that b can be used as a replacement for a.

    +
    +

    Note

    +

    All “a” functions in this section fail (more or less) silently if the +executed program cannot be found; the “b” replacements raise OSError +instead.

    +

    In addition, the replacements using check_output() will fail with a +CalledProcessError if the requested operation produces a non-zero +return code. The output is still available as the +output attribute of the raised exception.

    +
    +

    In the following examples, we assume that the relevant functions have already +been imported from the subprocess module.

    +
    +

    Replacing /bin/sh shell backquote

    +
    output=`mycmd myarg`
    +
    +
    +

    becomes:

    +
    output = check_output(["mycmd", "myarg"])
    +
    +
    +
    +
    +

    Replacing shell pipeline

    +
    output=`dmesg | grep hda`
    +
    +
    +

    becomes:

    +
    p1 = Popen(["dmesg"], stdout=PIPE)
    +p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
    +p1.stdout.close()  # Allow p1 to receive a SIGPIPE if p2 exits.
    +output = p2.communicate()[0]
    +
    +
    +

    The p1.stdout.close() call after starting the p2 is important in order for p1 +to receive a SIGPIPE if p2 exits before p1.

    +

    Alternatively, for trusted input, the shell’s own pipeline support may still +be used directly:

    +
    output=`dmesg | grep hda`
    +
    +
    +

    becomes:

    +
    output=check_output("dmesg | grep hda", shell=True)
    +
    +
    +
    +
    +

    Replacing os.system()

    +
    sts = os.system("mycmd" + " myarg")
    +# becomes
    +sts = call("mycmd" + " myarg", shell=True)
    +
    +
    +

    Notes:

    +
      +
    • Calling the program through the shell is usually not required.

    • +
    +

    A more realistic example would look like this:

    +
    try:
    +    retcode = call("mycmd" + " myarg", shell=True)
    +    if retcode < 0:
    +        print("Child was terminated by signal", -retcode, file=sys.stderr)
    +    else:
    +        print("Child returned", retcode, file=sys.stderr)
    +except OSError as e:
    +    print("Execution failed:", e, file=sys.stderr)
    +
    +
    +
    +
    +

    Replacing the os.spawn family

    +

    P_NOWAIT example:

    +
    pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")
    +==>
    +pid = Popen(["/bin/mycmd", "myarg"]).pid
    +
    +
    +

    P_WAIT example:

    +
    retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")
    +==>
    +retcode = call(["/bin/mycmd", "myarg"])
    +
    +
    +

    Vector example:

    +
    os.spawnvp(os.P_NOWAIT, path, args)
    +==>
    +Popen([path] + args[1:])
    +
    +
    +

    Environment example:

    +
    os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env)
    +==>
    +Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})
    +
    +
    +
    +
    +

    Replacing os.popen(), os.popen2(), os.popen3()

    +
    (child_stdin, child_stdout) = os.popen2(cmd, mode, bufsize)
    +==>
    +p = Popen(cmd, shell=True, bufsize=bufsize,
    +          stdin=PIPE, stdout=PIPE, close_fds=True)
    +(child_stdin, child_stdout) = (p.stdin, p.stdout)
    +
    +
    +
    (child_stdin,
    + child_stdout,
    + child_stderr) = os.popen3(cmd, mode, bufsize)
    +==>
    +p = Popen(cmd, shell=True, bufsize=bufsize,
    +          stdin=PIPE, stdout=PIPE, stderr=PIPE, close_fds=True)
    +(child_stdin,
    + child_stdout,
    + child_stderr) = (p.stdin, p.stdout, p.stderr)
    +
    +
    +
    (child_stdin, child_stdout_and_stderr) = os.popen4(cmd, mode, bufsize)
    +==>
    +p = Popen(cmd, shell=True, bufsize=bufsize,
    +          stdin=PIPE, stdout=PIPE, stderr=STDOUT, close_fds=True)
    +(child_stdin, child_stdout_and_stderr) = (p.stdin, p.stdout)
    +
    +
    +

    Return code handling translates as follows:

    +
    pipe = os.popen(cmd, 'w')
    +...
    +rc = pipe.close()
    +if rc is not None and rc >> 8:
    +    print("There were some errors")
    +==>
    +process = Popen(cmd, stdin=PIPE)
    +...
    +process.stdin.close()
    +if process.wait() != 0:
    +    print("There were some errors")
    +
    +
    +
    +
    +

    Replacing functions from the popen2 module

    +
    +

    Note

    +

    If the cmd argument to popen2 functions is a string, the command is executed +through /bin/sh. If it is a list, the command is directly executed.

    +
    +
    (child_stdout, child_stdin) = popen2.popen2("somestring", bufsize, mode)
    +==>
    +p = Popen("somestring", shell=True, bufsize=bufsize,
    +          stdin=PIPE, stdout=PIPE, close_fds=True)
    +(child_stdout, child_stdin) = (p.stdout, p.stdin)
    +
    +
    +
    (child_stdout, child_stdin) = popen2.popen2(["mycmd", "myarg"], bufsize, mode)
    +==>
    +p = Popen(["mycmd", "myarg"], bufsize=bufsize,
    +          stdin=PIPE, stdout=PIPE, close_fds=True)
    +(child_stdout, child_stdin) = (p.stdout, p.stdin)
    +
    +
    +

    popen2.Popen3 and popen2.Popen4 basically work as +subprocess.Popen, except that:

    +
      +
    • Popen raises an exception if the execution fails.

    • +
    • The capturestderr argument is replaced with the stderr argument.

    • +
    • stdin=PIPE and stdout=PIPE must be specified.

    • +
    • popen2 closes all file descriptors by default, but you have to specify +close_fds=True with Popen to guarantee this behavior on +all platforms or past Python versions.

    • +
    +
    +
    +
    +

    Legacy Shell Invocation Functions

    +

    This module also provides the following legacy functions from the 2.x +commands module. These operations implicitly invoke the system shell and +none of the guarantees described above regarding security and exception +handling consistency are valid for these functions.

    +
    +
    +subprocess.getstatusoutput(cmd)
    +

    Return (exitcode, output) of executing cmd in a shell.

    +

    Execute the string cmd in a shell with Popen.check_output() and +return a 2-tuple (exitcode, output). The locale encoding is used; +see the notes on Frequently Used Arguments for more details.

    +

    A trailing newline is stripped from the output. +The exit code for the command can be interpreted as the return code +of subprocess. Example:

    +
    >>> subprocess.getstatusoutput('ls /bin/ls')
    +(0, '/bin/ls')
    +>>> subprocess.getstatusoutput('cat /bin/junk')
    +(1, 'cat: /bin/junk: No such file or directory')
    +>>> subprocess.getstatusoutput('/bin/junk')
    +(127, 'sh: /bin/junk: not found')
    +>>> subprocess.getstatusoutput('/bin/kill $$')
    +(-15, '')
    +
    +
    +

    Availability: POSIX & Windows.

    +
    +

    Changed in version 3.3.4: Windows support was added.

    +

    The function now returns (exitcode, output) instead of (status, output) +as it did in Python 3.3.3 and earlier. exitcode has the same value as +returncode.

    +
    +
    + +
    +
    +subprocess.getoutput(cmd)
    +

    Return output (stdout and stderr) of executing cmd in a shell.

    +

    Like getstatusoutput(), except the exit code is ignored and the return +value is a string containing the command’s output. Example:

    +
    >>> subprocess.getoutput('ls /bin/ls')
    +'/bin/ls'
    +
    +
    +

    Availability: POSIX & Windows.

    +
    +

    Changed in version 3.3.4: Windows support added

    +
    +
    + +
    +
    +

    Notes

    +
    +

    Converting an argument sequence to a string on Windows

    +

    On Windows, an args sequence is converted to a string that can be parsed +using the following rules (which correspond to the rules used by the MS C +runtime):

    +
      +
    1. Arguments are delimited by white space, which is either a +space or a tab.

    2. +
    3. A string surrounded by double quotation marks is +interpreted as a single argument, regardless of white space +contained within. A quoted string can be embedded in an +argument.

    4. +
    5. A double quotation mark preceded by a backslash is +interpreted as a literal double quotation mark.

    6. +
    7. Backslashes are interpreted literally, unless they +immediately precede a double quotation mark.

    8. +
    9. If backslashes immediately precede a double quotation mark, +every pair of backslashes is interpreted as a literal +backslash. If the number of backslashes is odd, the last +backslash escapes the next double quotation mark as +described in rule 3.

    10. +
    +
    +

    See also

    +
    +
    shlex

    Module which provides function to parse and escape command lines.

    +
    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/sunau.html b/python-3.7.4-docs-html/library/sunau.html new file mode 100644 index 0000000..5b43d72 --- /dev/null +++ b/python-3.7.4-docs-html/library/sunau.html @@ -0,0 +1,495 @@ + + + + + + + sunau — Read and write Sun AU files — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    sunau — Read and write Sun AU files

    +

    Source code: Lib/sunau.py

    +
    +

    The sunau module provides a convenient interface to the Sun AU sound +format. Note that this module is interface-compatible with the modules +aifc and wave.

    +

    An audio file consists of a header followed by the data. The fields of the +header are:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Field

    Contents

    magic word

    The four bytes .snd.

    header size

    Size of the header, including info, in bytes.

    data size

    Physical size of the data, in bytes.

    encoding

    Indicates how the audio samples are encoded.

    sample rate

    The sampling rate.

    # of channels

    The number of channels in the samples.

    info

    ASCII string giving a description of the +audio file (padded with null bytes).

    +

    Apart from the info field, all header fields are 4 bytes in size. They are all +32-bit unsigned integers encoded in big-endian byte order.

    +

    The sunau module defines the following functions:

    +
    +
    +sunau.open(file, mode)
    +

    If file is a string, open the file by that name, otherwise treat it as a +seekable file-like object. mode can be any of

    +
    +
    'r'

    Read only mode.

    +
    +
    'w'

    Write only mode.

    +
    +
    +

    Note that it does not allow read/write files.

    +

    A mode of 'r' returns an AU_read object, while a mode of 'w' +or 'wb' returns an AU_write object.

    +
    + +
    +
    +sunau.openfp(file, mode)
    +

    A synonym for open(), maintained for backwards compatibility.

    +
    +

    Deprecated since version 3.7, will be removed in version 3.9.

    +
    +
    + +

    The sunau module defines the following exception:

    +
    +
    +exception sunau.Error
    +

    An error raised when something is impossible because of Sun AU specs or +implementation deficiency.

    +
    + +

    The sunau module defines the following data items:

    +
    +
    +sunau.AUDIO_FILE_MAGIC
    +

    An integer every valid Sun AU file begins with, stored in big-endian form. This +is the string .snd interpreted as an integer.

    +
    + +
    +
    +sunau.AUDIO_FILE_ENCODING_MULAW_8
    +
    +sunau.AUDIO_FILE_ENCODING_LINEAR_8
    +
    +sunau.AUDIO_FILE_ENCODING_LINEAR_16
    +
    +sunau.AUDIO_FILE_ENCODING_LINEAR_24
    +
    +sunau.AUDIO_FILE_ENCODING_LINEAR_32
    +
    +sunau.AUDIO_FILE_ENCODING_ALAW_8
    +

    Values of the encoding field from the AU header which are supported by this +module.

    +
    + +
    +
    +sunau.AUDIO_FILE_ENCODING_FLOAT
    +
    +sunau.AUDIO_FILE_ENCODING_DOUBLE
    +
    +sunau.AUDIO_FILE_ENCODING_ADPCM_G721
    +
    +sunau.AUDIO_FILE_ENCODING_ADPCM_G722
    +
    +sunau.AUDIO_FILE_ENCODING_ADPCM_G723_3
    +
    +sunau.AUDIO_FILE_ENCODING_ADPCM_G723_5
    +

    Additional known values of the encoding field from the AU header, but which are +not supported by this module.

    +
    + +
    +

    AU_read Objects

    +

    AU_read objects, as returned by open() above, have the following methods:

    +
    +
    +AU_read.close()
    +

    Close the stream, and make the instance unusable. (This is called automatically +on deletion.)

    +
    + +
    +
    +AU_read.getnchannels()
    +

    Returns number of audio channels (1 for mono, 2 for stereo).

    +
    + +
    +
    +AU_read.getsampwidth()
    +

    Returns sample width in bytes.

    +
    + +
    +
    +AU_read.getframerate()
    +

    Returns sampling frequency.

    +
    + +
    +
    +AU_read.getnframes()
    +

    Returns number of audio frames.

    +
    + +
    +
    +AU_read.getcomptype()
    +

    Returns compression type. Supported compression types are 'ULAW', 'ALAW' +and 'NONE'.

    +
    + +
    +
    +AU_read.getcompname()
    +

    Human-readable version of getcomptype(). The supported types have the +respective names 'CCITT G.711 u-law', 'CCITT G.711 A-law' and 'not +compressed'.

    +
    + +
    +
    +AU_read.getparams()
    +

    Returns a namedtuple() (nchannels, sampwidth, +framerate, nframes, comptype, compname), equivalent to output of the +get*() methods.

    +
    + +
    +
    +AU_read.readframes(n)
    +

    Reads and returns at most n frames of audio, as a bytes object. The data +will be returned in linear format. If the original data is in u-LAW format, it +will be converted.

    +
    + +
    +
    +AU_read.rewind()
    +

    Rewind the file pointer to the beginning of the audio stream.

    +
    + +

    The following two methods define a term “position” which is compatible between +them, and is otherwise implementation dependent.

    +
    +
    +AU_read.setpos(pos)
    +

    Set the file pointer to the specified position. Only values returned from +tell() should be used for pos.

    +
    + +
    +
    +AU_read.tell()
    +

    Return current file pointer position. Note that the returned value has nothing +to do with the actual position in the file.

    +
    + +

    The following two functions are defined for compatibility with the aifc, +and don’t do anything interesting.

    +
    +
    +AU_read.getmarkers()
    +

    Returns None.

    +
    + +
    +
    +AU_read.getmark(id)
    +

    Raise an error.

    +
    + +
    +
    +

    AU_write Objects

    +

    AU_write objects, as returned by open() above, have the following methods:

    +
    +
    +AU_write.setnchannels(n)
    +

    Set the number of channels.

    +
    + +
    +
    +AU_write.setsampwidth(n)
    +

    Set the sample width (in bytes.)

    +
    +

    Changed in version 3.4: Added support for 24-bit samples.

    +
    +
    + +
    +
    +AU_write.setframerate(n)
    +

    Set the frame rate.

    +
    + +
    +
    +AU_write.setnframes(n)
    +

    Set the number of frames. This can be later changed, when and if more frames +are written.

    +
    + +
    +
    +AU_write.setcomptype(type, name)
    +

    Set the compression type and description. Only 'NONE' and 'ULAW' are +supported on output.

    +
    + +
    +
    +AU_write.setparams(tuple)
    +

    The tuple should be (nchannels, sampwidth, framerate, nframes, comptype, +compname), with values valid for the set*() methods. Set all +parameters.

    +
    + +
    +
    +AU_write.tell()
    +

    Return current position in the file, with the same disclaimer for the +AU_read.tell() and AU_read.setpos() methods.

    +
    + +
    +
    +AU_write.writeframesraw(data)
    +

    Write audio frames, without correcting nframes.

    +
    +

    Changed in version 3.4: Any bytes-like object is now accepted.

    +
    +
    + +
    +
    +AU_write.writeframes(data)
    +

    Write audio frames and make sure nframes is correct.

    +
    +

    Changed in version 3.4: Any bytes-like object is now accepted.

    +
    +
    + +
    +
    +AU_write.close()
    +

    Make sure nframes is correct, and close the file.

    +

    This method is called upon deletion.

    +
    + +

    Note that it is invalid to set any parameters after calling writeframes() +or writeframesraw().

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/superseded.html b/python-3.7.4-docs-html/library/superseded.html new file mode 100644 index 0000000..6e6ef0a --- /dev/null +++ b/python-3.7.4-docs-html/library/superseded.html @@ -0,0 +1,246 @@ + + + + + + + Superseded Modules — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/symbol.html b/python-3.7.4-docs-html/library/symbol.html new file mode 100644 index 0000000..ff485b0 --- /dev/null +++ b/python-3.7.4-docs-html/library/symbol.html @@ -0,0 +1,200 @@ + + + + + + + symbol — Constants used with Python parse trees — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    symbol — Constants used with Python parse trees

    +

    Source code: Lib/symbol.py

    +
    +

    This module provides constants which represent the numeric values of internal +nodes of the parse tree. Unlike most Python constants, these use lower-case +names. Refer to the file Grammar/Grammar in the Python distribution for +the definitions of the names in the context of the language grammar. The +specific numeric values which the names map to may change between Python +versions.

    +

    This module also provides one additional data object:

    +
    +
    +symbol.sym_name
    +

    Dictionary mapping the numeric values of the constants defined in this module +back to name strings, allowing more human-readable representation of parse trees +to be generated.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/symtable.html b/python-3.7.4-docs-html/library/symtable.html new file mode 100644 index 0000000..3e6e516 --- /dev/null +++ b/python-3.7.4-docs-html/library/symtable.html @@ -0,0 +1,429 @@ + + + + + + + symtable — Access to the compiler’s symbol tables — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    symtable — Access to the compiler’s symbol tables

    +

    Source code: Lib/symtable.py

    +
    +

    Symbol tables are generated by the compiler from AST just before bytecode is +generated. The symbol table is responsible for calculating the scope of every +identifier in the code. symtable provides an interface to examine these +tables.

    +
    +

    Generating Symbol Tables

    +
    +
    +symtable.symtable(code, filename, compile_type)
    +

    Return the toplevel SymbolTable for the Python source code. +filename is the name of the file containing the code. compile_type is +like the mode argument to compile().

    +
    + +
    +
    +

    Examining Symbol Tables

    +
    +
    +class symtable.SymbolTable
    +

    A namespace table for a block. The constructor is not public.

    +
    +
    +get_type()
    +

    Return the type of the symbol table. Possible values are 'class', +'module', and 'function'.

    +
    + +
    +
    +get_id()
    +

    Return the table’s identifier.

    +
    + +
    +
    +get_name()
    +

    Return the table’s name. This is the name of the class if the table is +for a class, the name of the function if the table is for a function, or +'top' if the table is global (get_type() returns 'module').

    +
    + +
    +
    +get_lineno()
    +

    Return the number of the first line in the block this table represents.

    +
    + +
    +
    +is_optimized()
    +

    Return True if the locals in this table can be optimized.

    +
    + +
    +
    +is_nested()
    +

    Return True if the block is a nested class or function.

    +
    + +
    +
    +has_children()
    +

    Return True if the block has nested namespaces within it. These can +be obtained with get_children().

    +
    + +
    +
    +has_exec()
    +

    Return True if the block uses exec.

    +
    + +
    +
    +get_identifiers()
    +

    Return a list of names of symbols in this table.

    +
    + +
    +
    +lookup(name)
    +

    Lookup name in the table and return a Symbol instance.

    +
    + +
    +
    +get_symbols()
    +

    Return a list of Symbol instances for names in the table.

    +
    + +
    +
    +get_children()
    +

    Return a list of the nested symbol tables.

    +
    + +
    + +
    +
    +class symtable.Function
    +

    A namespace for a function or method. This class inherits +SymbolTable.

    +
    +
    +get_parameters()
    +

    Return a tuple containing names of parameters to this function.

    +
    + +
    +
    +get_locals()
    +

    Return a tuple containing names of locals in this function.

    +
    + +
    +
    +get_globals()
    +

    Return a tuple containing names of globals in this function.

    +
    + +
    +
    +get_frees()
    +

    Return a tuple containing names of free variables in this function.

    +
    + +
    + +
    +
    +class symtable.Class
    +

    A namespace of a class. This class inherits SymbolTable.

    +
    +
    +get_methods()
    +

    Return a tuple containing the names of methods declared in the class.

    +
    + +
    + +
    +
    +class symtable.Symbol
    +

    An entry in a SymbolTable corresponding to an identifier in the +source. The constructor is not public.

    +
    +
    +get_name()
    +

    Return the symbol’s name.

    +
    + +
    +
    +is_referenced()
    +

    Return True if the symbol is used in its block.

    +
    + +
    +
    +is_imported()
    +

    Return True if the symbol is created from an import statement.

    +
    + +
    +
    +is_parameter()
    +

    Return True if the symbol is a parameter.

    +
    + +
    +
    +is_global()
    +

    Return True if the symbol is global.

    +
    + +
    +
    +is_declared_global()
    +

    Return True if the symbol is declared global with a global statement.

    +
    + +
    +
    +is_local()
    +

    Return True if the symbol is local to its block.

    +
    + +
    +
    +is_free()
    +

    Return True if the symbol is referenced in its block, but not assigned +to.

    +
    + +
    +
    +is_assigned()
    +

    Return True if the symbol is assigned to in its block.

    +
    + +
    +
    +is_namespace()
    +

    Return True if name binding introduces new namespace.

    +

    If the name is used as the target of a function or class statement, this +will be true.

    +

    For example:

    +
    >>> table = symtable.symtable("def some_func(): pass", "string", "exec")
    +>>> table.lookup("some_func").is_namespace()
    +True
    +
    +
    +

    Note that a single name can be bound to multiple objects. If the result +is True, the name may also be bound to other objects, like an int or +list, that does not introduce a new namespace.

    +
    + +
    +
    +get_namespaces()
    +

    Return a list of namespaces bound to this name.

    +
    + +
    +
    +get_namespace()
    +

    Return the namespace bound to this name. If more than one namespace is +bound, ValueError is raised.

    +
    + +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/sys.html b/python-3.7.4-docs-html/library/sys.html new file mode 100644 index 0000000..7adb314 --- /dev/null +++ b/python-3.7.4-docs-html/library/sys.html @@ -0,0 +1,1871 @@ + + + + + + + sys — System-specific parameters and functions — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    sys — System-specific parameters and functions

    +
    +

    This module provides access to some variables used or maintained by the +interpreter and to functions that interact strongly with the interpreter. It is +always available.

    +
    +
    +sys.abiflags
    +

    On POSIX systems where Python was built with the standard configure +script, this contains the ABI flags as specified by PEP 3149.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +sys.argv
    +

    The list of command line arguments passed to a Python script. argv[0] is the +script name (it is operating system dependent whether this is a full pathname or +not). If the command was executed using the -c command line option to +the interpreter, argv[0] is set to the string '-c'. If no script name +was passed to the Python interpreter, argv[0] is the empty string.

    +

    To loop over the standard input, or the list of files given on the +command line, see the fileinput module.

    +
    +

    Note

    +

    On Unix, command line arguments are passed by bytes from OS. Python decodes +them with filesystem encoding and “surrogateescape” error handler. +When you need original bytes, you can get it by +[os.fsencode(arg) for arg in sys.argv].

    +
    +
    + +
    +
    +sys.base_exec_prefix
    +

    Set during Python startup, before site.py is run, to the same value as +exec_prefix. If not running in a +virtual environment, the values will stay the same; if +site.py finds that a virtual environment is in use, the values of +prefix and exec_prefix will be changed to point to the +virtual environment, whereas base_prefix and +base_exec_prefix will remain pointing to the base Python +installation (the one which the virtual environment was created from).

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +sys.base_prefix
    +

    Set during Python startup, before site.py is run, to the same value as +prefix. If not running in a virtual environment, the values +will stay the same; if site.py finds that a virtual environment is in +use, the values of prefix and exec_prefix will be changed to +point to the virtual environment, whereas base_prefix and +base_exec_prefix will remain pointing to the base Python +installation (the one which the virtual environment was created from).

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +sys.byteorder
    +

    An indicator of the native byte order. This will have the value 'big' on +big-endian (most-significant byte first) platforms, and 'little' on +little-endian (least-significant byte first) platforms.

    +
    + +
    +
    +sys.builtin_module_names
    +

    A tuple of strings giving the names of all modules that are compiled into this +Python interpreter. (This information is not available in any other way — +modules.keys() only lists the imported modules.)

    +
    + +
    +
    +sys.call_tracing(func, args)
    +

    Call func(*args), while tracing is enabled. The tracing state is saved, +and restored afterwards. This is intended to be called from a debugger from +a checkpoint, to recursively debug some other code.

    +
    + +
    +
    +sys.copyright
    +

    A string containing the copyright pertaining to the Python interpreter.

    +
    + +
    +
    +sys._clear_type_cache()
    +

    Clear the internal type cache. The type cache is used to speed up attribute +and method lookups. Use the function only to drop unnecessary references +during reference leak debugging.

    +

    This function should be used for internal and specialized purposes only.

    +
    + +
    +
    +sys._current_frames()
    +

    Return a dictionary mapping each thread’s identifier to the topmost stack frame +currently active in that thread at the time the function is called. Note that +functions in the traceback module can build the call stack given such a +frame.

    +

    This is most useful for debugging deadlock: this function does not require the +deadlocked threads’ cooperation, and such threads’ call stacks are frozen for as +long as they remain deadlocked. The frame returned for a non-deadlocked thread +may bear no relationship to that thread’s current activity by the time calling +code examines the frame.

    +

    This function should be used for internal and specialized purposes only.

    +
    + +
    +
    +sys.breakpointhook()
    +

    This hook function is called by built-in breakpoint(). By default, +it drops you into the pdb debugger, but it can be set to any other +function so that you can choose which debugger gets used.

    +

    The signature of this function is dependent on what it calls. For example, +the default binding (e.g. pdb.set_trace()) expects no arguments, but +you might bind it to a function that expects additional arguments +(positional and/or keyword). The built-in breakpoint() function passes +its *args and **kws straight through. Whatever +breakpointhooks() returns is returned from breakpoint().

    +

    The default implementation first consults the environment variable +PYTHONBREAKPOINT. If that is set to "0" then this function +returns immediately; i.e. it is a no-op. If the environment variable is +not set, or is set to the empty string, pdb.set_trace() is called. +Otherwise this variable should name a function to run, using Python’s +dotted-import nomenclature, e.g. package.subpackage.module.function. +In this case, package.subpackage.module would be imported and the +resulting module must have a callable named function(). This is run, +passing in *args and **kws, and whatever function() returns, +sys.breakpointhook() returns to the built-in breakpoint() +function.

    +

    Note that if anything goes wrong while importing the callable named by +PYTHONBREAKPOINT, a RuntimeWarning is reported and the +breakpoint is ignored.

    +

    Also note that if sys.breakpointhook() is overridden programmatically, +PYTHONBREAKPOINT is not consulted.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +sys._debugmallocstats()
    +

    Print low-level information to stderr about the state of CPython’s memory +allocator.

    +

    If Python is configured –with-pydebug, it also performs some expensive +internal consistency checks.

    +
    +

    New in version 3.3.

    +
    +
    +

    CPython implementation detail: This function is specific to CPython. The exact output format is not +defined here, and may change.

    +
    +
    + +
    +
    +sys.dllhandle
    +

    Integer specifying the handle of the Python DLL.

    +

    Availability: Windows.

    +
    + +
    +
    +sys.displayhook(value)
    +

    If value is not None, this function prints repr(value) to +sys.stdout, and saves value in builtins._. If repr(value) is +not encodable to sys.stdout.encoding with sys.stdout.errors error +handler (which is probably 'strict'), encode it to +sys.stdout.encoding with 'backslashreplace' error handler.

    +

    sys.displayhook is called on the result of evaluating an expression +entered in an interactive Python session. The display of these values can be +customized by assigning another one-argument function to sys.displayhook.

    +

    Pseudo-code:

    +
    def displayhook(value):
    +    if value is None:
    +        return
    +    # Set '_' to None to avoid recursion
    +    builtins._ = None
    +    text = repr(value)
    +    try:
    +        sys.stdout.write(text)
    +    except UnicodeEncodeError:
    +        bytes = text.encode(sys.stdout.encoding, 'backslashreplace')
    +        if hasattr(sys.stdout, 'buffer'):
    +            sys.stdout.buffer.write(bytes)
    +        else:
    +            text = bytes.decode(sys.stdout.encoding, 'strict')
    +            sys.stdout.write(text)
    +    sys.stdout.write("\n")
    +    builtins._ = value
    +
    +
    +
    +

    Changed in version 3.2: Use 'backslashreplace' error handler on UnicodeEncodeError.

    +
    +
    + +
    +
    +sys.dont_write_bytecode
    +

    If this is true, Python won’t try to write .pyc files on the +import of source modules. This value is initially set to True or +False depending on the -B command line option and the +PYTHONDONTWRITEBYTECODE environment variable, but you can set it +yourself to control bytecode file generation.

    +
    + +
    +
    +sys.excepthook(type, value, traceback)
    +

    This function prints out a given traceback and exception to sys.stderr.

    +

    When an exception is raised and uncaught, the interpreter calls +sys.excepthook with three arguments, the exception class, exception +instance, and a traceback object. In an interactive session this happens just +before control is returned to the prompt; in a Python program this happens just +before the program exits. The handling of such top-level exceptions can be +customized by assigning another three-argument function to sys.excepthook.

    +
    + +
    +
    +sys.__breakpointhook__
    +
    +sys.__displayhook__
    +
    +sys.__excepthook__
    +

    These objects contain the original values of breakpointhook, +displayhook, and excepthook at the start of the program. They are +saved so that breakpointhook, displayhook and excepthook can be +restored in case they happen to get replaced with broken or alternative +objects.

    +
    +

    New in version 3.7: __breakpointhook__

    +
    +
    + +
    +
    +sys.exc_info()
    +

    This function returns a tuple of three values that give information about the +exception that is currently being handled. The information returned is specific +both to the current thread and to the current stack frame. If the current stack +frame is not handling an exception, the information is taken from the calling +stack frame, or its caller, and so on until a stack frame is found that is +handling an exception. Here, “handling an exception” is defined as “executing +an except clause.” For any stack frame, only information about the exception +being currently handled is accessible.

    +

    If no exception is being handled anywhere on the stack, a tuple containing +three None values is returned. Otherwise, the values returned are +(type, value, traceback). Their meaning is: type gets the type of the +exception being handled (a subclass of BaseException); value gets +the exception instance (an instance of the exception type); traceback gets +a traceback object (see the Reference Manual) which encapsulates the call +stack at the point where the exception originally occurred.

    +
    + +
    +
    +sys.exec_prefix
    +

    A string giving the site-specific directory prefix where the platform-dependent +Python files are installed; by default, this is also '/usr/local'. This can +be set at build time with the --exec-prefix argument to the +configure script. Specifically, all configuration files (e.g. the +pyconfig.h header file) are installed in the directory +exec_prefix/lib/pythonX.Y/config, and shared library modules are +installed in exec_prefix/lib/pythonX.Y/lib-dynload, where X.Y +is the version number of Python, for example 3.2.

    +
    +

    Note

    +

    If a virtual environment is in effect, this +value will be changed in site.py to point to the virtual environment. +The value for the Python installation will still be available, via +base_exec_prefix.

    +
    +
    + +
    +
    +sys.executable
    +

    A string giving the absolute path of the executable binary for the Python +interpreter, on systems where this makes sense. If Python is unable to retrieve +the real path to its executable, sys.executable will be an empty string +or None.

    +
    + +
    +
    +sys.exit([arg])
    +

    Exit from Python. This is implemented by raising the SystemExit +exception, so cleanup actions specified by finally clauses of try +statements are honored, and it is possible to intercept the exit attempt at +an outer level.

    +

    The optional argument arg can be an integer giving the exit status +(defaulting to zero), or another type of object. If it is an integer, zero +is considered “successful termination” and any nonzero value is considered +“abnormal termination” by shells and the like. Most systems require it to be +in the range 0–127, and produce undefined results otherwise. Some systems +have a convention for assigning specific meanings to specific exit codes, but +these are generally underdeveloped; Unix programs generally use 2 for command +line syntax errors and 1 for all other kind of errors. If another type of +object is passed, None is equivalent to passing zero, and any other +object is printed to stderr and results in an exit code of 1. In +particular, sys.exit("some error message") is a quick way to exit a +program when an error occurs.

    +

    Since exit() ultimately “only” raises an exception, it will only exit +the process when called from the main thread, and the exception is not +intercepted.

    +
    +

    Changed in version 3.6: If an error occurs in the cleanup after the Python interpreter +has caught SystemExit (such as an error flushing buffered data +in the standard streams), the exit status is changed to 120.

    +
    +
    + +
    +
    +sys.flags
    +

    The struct sequence flags exposes the status of command line +flags. The attributes are read only.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    attribute

    flag

    debug

    -d

    inspect

    -i

    interactive

    -i

    isolated

    -I

    optimize

    -O or -OO

    dont_write_bytecode

    -B

    no_user_site

    -s

    no_site

    -S

    ignore_environment

    -E

    verbose

    -v

    bytes_warning

    -b

    quiet

    -q

    hash_randomization

    -R

    dev_mode

    -X dev

    utf8_mode

    -X utf8

    +
    +

    Changed in version 3.2: Added quiet attribute for the new -q flag.

    +
    +
    +

    New in version 3.2.3: The hash_randomization attribute.

    +
    +
    +

    Changed in version 3.3: Removed obsolete division_warning attribute.

    +
    +
    +

    Changed in version 3.4: Added isolated attribute for -I isolated flag.

    +
    +
    +

    Changed in version 3.7: Added dev_mode attribute for the new -X dev flag +and utf8_mode attribute for the new -X utf8 flag.

    +
    +
    + +
    +
    +sys.float_info
    +

    A struct sequence holding information about the float type. It +contains low level information about the precision and internal +representation. The values correspond to the various floating-point +constants defined in the standard header file float.h for the ‘C’ +programming language; see section 5.2.4.2.2 of the 1999 ISO/IEC C standard +[C99], ‘Characteristics of floating types’, for details.

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    attribute

    float.h macro

    explanation

    epsilon

    DBL_EPSILON

    difference between 1 and the least value greater +than 1 that is representable as a float

    dig

    DBL_DIG

    maximum number of decimal digits that can be +faithfully represented in a float; see below

    mant_dig

    DBL_MANT_DIG

    float precision: the number of base-radix +digits in the significand of a float

    max

    DBL_MAX

    maximum representable finite float

    max_exp

    DBL_MAX_EXP

    maximum integer e such that radix**(e-1) is +a representable finite float

    max_10_exp

    DBL_MAX_10_EXP

    maximum integer e such that 10**e is in the +range of representable finite floats

    min

    DBL_MIN

    minimum positive normalized float

    min_exp

    DBL_MIN_EXP

    minimum integer e such that radix**(e-1) is +a normalized float

    min_10_exp

    DBL_MIN_10_EXP

    minimum integer e such that 10**e is a +normalized float

    radix

    FLT_RADIX

    radix of exponent representation

    rounds

    FLT_ROUNDS

    integer constant representing the rounding mode +used for arithmetic operations. This reflects +the value of the system FLT_ROUNDS macro at +interpreter startup time. See section 5.2.4.2.2 +of the C99 standard for an explanation of the +possible values and their meanings.

    +

    The attribute sys.float_info.dig needs further explanation. If +s is any string representing a decimal number with at most +sys.float_info.dig significant digits, then converting s to a +float and back again will recover a string representing the same decimal +value:

    +
    >>> import sys
    +>>> sys.float_info.dig
    +15
    +>>> s = '3.14159265358979'    # decimal string with 15 significant digits
    +>>> format(float(s), '.15g')  # convert to float and back -> same value
    +'3.14159265358979'
    +
    +
    +

    But for strings with more than sys.float_info.dig significant digits, +this isn’t always true:

    +
    >>> s = '9876543211234567'    # 16 significant digits is too many!
    +>>> format(float(s), '.16g')  # conversion changes value
    +'9876543211234568'
    +
    +
    +
    + +
    +
    +sys.float_repr_style
    +

    A string indicating how the repr() function behaves for +floats. If the string has value 'short' then for a finite +float x, repr(x) aims to produce a short string with the +property that float(repr(x)) == x. This is the usual behaviour +in Python 3.1 and later. Otherwise, float_repr_style has value +'legacy' and repr(x) behaves in the same way as it did in +versions of Python prior to 3.1.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +sys.getallocatedblocks()
    +

    Return the number of memory blocks currently allocated by the interpreter, +regardless of their size. This function is mainly useful for tracking +and debugging memory leaks. Because of the interpreter’s internal +caches, the result can vary from call to call; you may have to call +_clear_type_cache() and gc.collect() to get more +predictable results.

    +

    If a Python build or implementation cannot reasonably compute this +information, getallocatedblocks() is allowed to return 0 instead.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +sys.getandroidapilevel()
    +

    Return the build time API version of Android as an integer.

    +

    Availability: Android.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +sys.getcheckinterval()
    +

    Return the interpreter’s “check interval”; see setcheckinterval().

    +
    +

    Deprecated since version 3.2: Use getswitchinterval() instead.

    +
    +
    + +
    +
    +sys.getdefaultencoding()
    +

    Return the name of the current default string encoding used by the Unicode +implementation.

    +
    + +
    +
    +sys.getdlopenflags()
    +

    Return the current value of the flags that are used for +dlopen() calls. Symbolic names for the flag values can be +found in the os module (RTLD_xxx constants, e.g. +os.RTLD_LAZY).

    +

    Availability: Unix.

    +
    + +
    +
    +sys.getfilesystemencoding()
    +

    Return the name of the encoding used to convert between Unicode +filenames and bytes filenames. For best compatibility, str should be +used for filenames in all cases, although representing filenames as bytes +is also supported. Functions accepting or returning filenames should support +either str or bytes and internally convert to the system’s preferred +representation.

    +

    This encoding is always ASCII-compatible.

    +

    os.fsencode() and os.fsdecode() should be used to ensure that +the correct encoding and errors mode are used.

    +
      +
    • In the UTF-8 mode, the encoding is utf-8 on any platform.

    • +
    • On Mac OS X, the encoding is 'utf-8'.

    • +
    • On Unix, the encoding is the locale encoding.

    • +
    • On Windows, the encoding may be 'utf-8' or 'mbcs', depending +on user configuration.

    • +
    +
    +

    Changed in version 3.2: getfilesystemencoding() result cannot be None anymore.

    +
    +
    +

    Changed in version 3.6: Windows is no longer guaranteed to return 'mbcs'. See PEP 529 +and _enablelegacywindowsfsencoding() for more information.

    +
    +
    +

    Changed in version 3.7: Return ‘utf-8’ in the UTF-8 mode.

    +
    +
    + +
    +
    +sys.getfilesystemencodeerrors()
    +

    Return the name of the error mode used to convert between Unicode filenames +and bytes filenames. The encoding name is returned from +getfilesystemencoding().

    +

    os.fsencode() and os.fsdecode() should be used to ensure that +the correct encoding and errors mode are used.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +sys.getrefcount(object)
    +

    Return the reference count of the object. The count returned is generally one +higher than you might expect, because it includes the (temporary) reference as +an argument to getrefcount().

    +
    + +
    +
    +sys.getrecursionlimit()
    +

    Return the current value of the recursion limit, the maximum depth of the Python +interpreter stack. This limit prevents infinite recursion from causing an +overflow of the C stack and crashing Python. It can be set by +setrecursionlimit().

    +
    + +
    +
    +sys.getsizeof(object[, default])
    +

    Return the size of an object in bytes. The object can be any type of +object. All built-in objects will return correct results, but this +does not have to hold true for third-party extensions as it is implementation +specific.

    +

    Only the memory consumption directly attributed to the object is +accounted for, not the memory consumption of objects it refers to.

    +

    If given, default will be returned if the object does not provide means to +retrieve the size. Otherwise a TypeError will be raised.

    +

    getsizeof() calls the object’s __sizeof__ method and adds an +additional garbage collector overhead if the object is managed by the garbage +collector.

    +

    See recursive sizeof recipe +for an example of using getsizeof() recursively to find the size of +containers and all their contents.

    +
    + +
    +
    +sys.getswitchinterval()
    +

    Return the interpreter’s “thread switch interval”; see +setswitchinterval().

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +sys._getframe([depth])
    +

    Return a frame object from the call stack. If optional integer depth is +given, return the frame object that many calls below the top of the stack. If +that is deeper than the call stack, ValueError is raised. The default +for depth is zero, returning the frame at the top of the call stack.

    +
    +

    CPython implementation detail: This function should be used for internal and specialized purposes only. +It is not guaranteed to exist in all implementations of Python.

    +
    +
    + +
    +
    +sys.getprofile()
    +

    Get the profiler function as set by setprofile().

    +
    + +
    +
    +sys.gettrace()
    +

    Get the trace function as set by settrace().

    +
    +

    CPython implementation detail: The gettrace() function is intended only for implementing debuggers, +profilers, coverage tools and the like. Its behavior is part of the +implementation platform, rather than part of the language definition, and +thus may not be available in all Python implementations.

    +
    +
    + +
    +
    +sys.getwindowsversion()
    +

    Return a named tuple describing the Windows version +currently running. The named elements are major, minor, +build, platform, service_pack, service_pack_minor, +service_pack_major, suite_mask, product_type and +platform_version. service_pack contains a string, +platform_version a 3-tuple and all other values are +integers. The components can also be accessed by name, so +sys.getwindowsversion()[0] is equivalent to +sys.getwindowsversion().major. For compatibility with prior +versions, only the first 5 elements are retrievable by indexing.

    +

    platform will be 2 (VER_PLATFORM_WIN32_NT).

    +

    product_type may be one of the following values:

    + ++++ + + + + + + + + + + + + + + + + +

    Constant

    Meaning

    1 (VER_NT_WORKSTATION)

    The system is a workstation.

    2 (VER_NT_DOMAIN_CONTROLLER)

    The system is a domain +controller.

    3 (VER_NT_SERVER)

    The system is a server, but not +a domain controller.

    +

    This function wraps the Win32 GetVersionEx() function; see the +Microsoft documentation on OSVERSIONINFOEX() for more information +about these fields.

    +

    platform_version returns the accurate major version, minor version and +build number of the current operating system, rather than the version that +is being emulated for the process. It is intended for use in logging rather +than for feature detection.

    +

    Availability: Windows.

    +
    +

    Changed in version 3.2: Changed to a named tuple and added service_pack_minor, +service_pack_major, suite_mask, and product_type.

    +
    +
    +

    Changed in version 3.6: Added platform_version

    +
    +
    + +
    +
    +sys.get_asyncgen_hooks()
    +

    Returns an asyncgen_hooks object, which is similar to a +namedtuple of the form (firstiter, finalizer), +where firstiter and finalizer are expected to be either None or +functions which take an asynchronous generator iterator as an +argument, and are used to schedule finalization of an asynchronous +generator by an event loop.

    +
    +

    New in version 3.6: See PEP 525 for more details.

    +
    +
    +

    Note

    +

    This function has been added on a provisional basis (see PEP 411 +for details.)

    +
    +
    + +
    +
    +sys.get_coroutine_origin_tracking_depth()
    +

    Get the current coroutine origin tracking depth, as set by +set_coroutine_origin_tracking_depth().

    +
    +

    New in version 3.7.

    +
    +
    +

    Note

    +

    This function has been added on a provisional basis (see PEP 411 +for details.) Use it only for debugging purposes.

    +
    +
    + +
    +
    +sys.get_coroutine_wrapper()
    +

    Returns None, or a wrapper set by set_coroutine_wrapper().

    +
    +

    New in version 3.5: See PEP 492 for more details.

    +
    +
    +

    Note

    +

    This function has been added on a provisional basis (see PEP 411 +for details.) Use it only for debugging purposes.

    +
    +
    +

    Deprecated since version 3.7: The coroutine wrapper functionality has been deprecated, and +will be removed in 3.8. See bpo-32591 for details.

    +
    +
    + +
    +
    +sys.hash_info
    +

    A struct sequence giving parameters of the numeric hash +implementation. For more details about hashing of numeric types, see +Hashing of numeric types.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    attribute

    explanation

    width

    width in bits used for hash values

    modulus

    prime modulus P used for numeric hash scheme

    inf

    hash value returned for a positive infinity

    nan

    hash value returned for a nan

    imag

    multiplier used for the imaginary part of a +complex number

    algorithm

    name of the algorithm for hashing of str, bytes, +and memoryview

    hash_bits

    internal output size of the hash algorithm

    seed_bits

    size of the seed key of the hash algorithm

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.4: Added algorithm, hash_bits and seed_bits

    +
    +
    + +
    +
    +sys.hexversion
    +

    The version number encoded as a single integer. This is guaranteed to increase +with each version, including proper support for non-production releases. For +example, to test that the Python interpreter is at least version 1.5.2, use:

    +
    if sys.hexversion >= 0x010502F0:
    +    # use some advanced feature
    +    ...
    +else:
    +    # use an alternative implementation or warn the user
    +    ...
    +
    +
    +

    This is called hexversion since it only really looks meaningful when viewed +as the result of passing it to the built-in hex() function. The +struct sequence sys.version_info may be used for a more +human-friendly encoding of the same information.

    +

    More details of hexversion can be found at API and ABI Versioning.

    +
    + +
    +
    +sys.implementation
    +

    An object containing information about the implementation of the +currently running Python interpreter. The following attributes are +required to exist in all Python implementations.

    +

    name is the implementation’s identifier, e.g. 'cpython'. The actual +string is defined by the Python implementation, but it is guaranteed to be +lower case.

    +

    version is a named tuple, in the same format as +sys.version_info. It represents the version of the Python +implementation. This has a distinct meaning from the specific +version of the Python language to which the currently running +interpreter conforms, which sys.version_info represents. For +example, for PyPy 1.8 sys.implementation.version might be +sys.version_info(1, 8, 0, 'final', 0), whereas sys.version_info +would be sys.version_info(2, 7, 2, 'final', 0). For CPython they +are the same value, since it is the reference implementation.

    +

    hexversion is the implementation version in hexadecimal format, like +sys.hexversion.

    +

    cache_tag is the tag used by the import machinery in the filenames of +cached modules. By convention, it would be a composite of the +implementation’s name and version, like 'cpython-33'. However, a +Python implementation may use some other value if appropriate. If +cache_tag is set to None, it indicates that module caching should +be disabled.

    +

    sys.implementation may contain additional attributes specific to +the Python implementation. These non-standard attributes must start with +an underscore, and are not described here. Regardless of its contents, +sys.implementation will not change during a run of the interpreter, +nor between implementation versions. (It may change between Python +language versions, however.) See PEP 421 for more information.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +sys.int_info
    +

    A struct sequence that holds information about Python’s internal +representation of integers. The attributes are read only.

    + ++++ + + + + + + + + + + + + + +

    Attribute

    Explanation

    bits_per_digit

    number of bits held in each digit. Python +integers are stored internally in base +2**int_info.bits_per_digit

    sizeof_digit

    size in bytes of the C type used to +represent a digit

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +sys.__interactivehook__
    +

    When this attribute exists, its value is automatically called (with no +arguments) when the interpreter is launched in interactive mode. This is done after the PYTHONSTARTUP file is +read, so that you can set this hook there. The site module +sets this.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +sys.intern(string)
    +

    Enter string in the table of “interned” strings and return the interned string +– which is string itself or a copy. Interning strings is useful to gain a +little performance on dictionary lookup – if the keys in a dictionary are +interned, and the lookup key is interned, the key comparisons (after hashing) +can be done by a pointer compare instead of a string compare. Normally, the +names used in Python programs are automatically interned, and the dictionaries +used to hold module, class or instance attributes have interned keys.

    +

    Interned strings are not immortal; you must keep a reference to the return +value of intern() around to benefit from it.

    +
    + +
    +
    +sys.is_finalizing()
    +

    Return True if the Python interpreter is +shutting down, False otherwise.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +sys.last_type
    +
    +sys.last_value
    +
    +sys.last_traceback
    +

    These three variables are not always defined; they are set when an exception is +not handled and the interpreter prints an error message and a stack traceback. +Their intended use is to allow an interactive user to import a debugger module +and engage in post-mortem debugging without having to re-execute the command +that caused the error. (Typical use is import pdb; pdb.pm() to enter the +post-mortem debugger; see pdb module for +more information.)

    +

    The meaning of the variables is the same as that of the return values from +exc_info() above.

    +
    + +
    +
    +sys.maxsize
    +

    An integer giving the maximum value a variable of type Py_ssize_t can +take. It’s usually 2**31 - 1 on a 32-bit platform and 2**63 - 1 on a +64-bit platform.

    +
    + +
    +
    +sys.maxunicode
    +

    An integer giving the value of the largest Unicode code point, +i.e. 1114111 (0x10FFFF in hexadecimal).

    +
    +

    Changed in version 3.3: Before PEP 393, sys.maxunicode used to be either 0xFFFF +or 0x10FFFF, depending on the configuration option that specified +whether Unicode characters were stored as UCS-2 or UCS-4.

    +
    +
    + +
    +
    +sys.meta_path
    +

    A list of meta path finder objects that have their +find_spec() methods called to see if one +of the objects can find the module to be imported. The +find_spec() method is called with at +least the absolute name of the module being imported. If the module to be +imported is contained in a package, then the parent package’s __path__ +attribute is passed in as a second argument. The method returns a +module spec, or None if the module cannot be found.

    +
    +

    See also

    +
    +
    importlib.abc.MetaPathFinder

    The abstract base class defining the interface of finder objects on +meta_path.

    +
    +
    importlib.machinery.ModuleSpec

    The concrete class which +find_spec() should return +instances of.

    +
    +
    +
    +
    +

    Changed in version 3.4: Module specs were introduced in Python 3.4, by +PEP 451. Earlier versions of Python looked for a method called +find_module(). +This is still called as a fallback if a meta_path entry doesn’t +have a find_spec() method.

    +
    +
    + +
    +
    +sys.modules
    +

    This is a dictionary that maps module names to modules which have already been +loaded. This can be manipulated to force reloading of modules and other tricks. +However, replacing the dictionary will not necessarily work as expected and +deleting essential items from the dictionary may cause Python to fail.

    +
    + +
    +
    +sys.path
    +

    A list of strings that specifies the search path for modules. Initialized from +the environment variable PYTHONPATH, plus an installation-dependent +default.

    +

    As initialized upon program startup, the first item of this list, path[0], +is the directory containing the script that was used to invoke the Python +interpreter. If the script directory is not available (e.g. if the interpreter +is invoked interactively or if the script is read from standard input), +path[0] is the empty string, which directs Python to search modules in the +current directory first. Notice that the script directory is inserted before +the entries inserted as a result of PYTHONPATH.

    +

    A program is free to modify this list for its own purposes. Only strings +and bytes should be added to sys.path; all other data types are +ignored during import.

    +
    +

    See also

    +

    Module site This describes how to use .pth files to extend +sys.path.

    +
    +
    + +
    +
    +sys.path_hooks
    +

    A list of callables that take a path argument to try to create a +finder for the path. If a finder can be created, it is to be +returned by the callable, else raise ImportError.

    +

    Originally specified in PEP 302.

    +
    + +
    +
    +sys.path_importer_cache
    +

    A dictionary acting as a cache for finder objects. The keys are +paths that have been passed to sys.path_hooks and the values are +the finders that are found. If a path is a valid file system path but no +finder is found on sys.path_hooks then None is +stored.

    +

    Originally specified in PEP 302.

    +
    +

    Changed in version 3.3: None is stored instead of imp.NullImporter when no finder +is found.

    +
    +
    + +
    +
    +sys.platform
    +

    This string contains a platform identifier that can be used to append +platform-specific components to sys.path, for instance.

    +

    For Unix systems, except on Linux, this is the lowercased OS name as +returned by uname -s with the first part of the version as returned by +uname -r appended, e.g. 'sunos5' or 'freebsd8', at the time +when Python was built. Unless you want to test for a specific system +version, it is therefore recommended to use the following idiom:

    +
    if sys.platform.startswith('freebsd'):
    +    # FreeBSD-specific code here...
    +elif sys.platform.startswith('linux'):
    +    # Linux-specific code here...
    +
    +
    +

    For other systems, the values are:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    System

    platform value

    Linux

    'linux'

    Windows

    'win32'

    Windows/Cygwin

    'cygwin'

    Mac OS X

    'darwin'

    +
    +

    Changed in version 3.3: On Linux, sys.platform doesn’t contain the major version anymore. +It is always 'linux', instead of 'linux2' or 'linux3'. Since +older Python versions include the version number, it is recommended to +always use the startswith idiom presented above.

    +
    +
    +

    See also

    +

    os.name has a coarser granularity. os.uname() gives +system-dependent version information.

    +

    The platform module provides detailed checks for the +system’s identity.

    +
    +
    + +
    +
    +sys.prefix
    +

    A string giving the site-specific directory prefix where the platform +independent Python files are installed; by default, this is the string +'/usr/local'. This can be set at build time with the --prefix +argument to the configure script. The main collection of Python +library modules is installed in the directory prefix/lib/pythonX.Y +while the platform independent header files (all except pyconfig.h) are +stored in prefix/include/pythonX.Y, where X.Y is the version +number of Python, for example 3.2.

    +
    +

    Note

    +

    If a virtual environment is in effect, this +value will be changed in site.py to point to the virtual +environment. The value for the Python installation will still be +available, via base_prefix.

    +
    +
    + +
    +
    +sys.ps1
    +
    +sys.ps2
    +

    Strings specifying the primary and secondary prompt of the interpreter. These +are only defined if the interpreter is in interactive mode. Their initial +values in this case are '>>> ' and '... '. If a non-string object is +assigned to either variable, its str() is re-evaluated each time the +interpreter prepares to read a new interactive command; this can be used to +implement a dynamic prompt.

    +
    + +
    +
    +sys.setcheckinterval(interval)
    +

    Set the interpreter’s “check interval”. This integer value determines how often +the interpreter checks for periodic things such as thread switches and signal +handlers. The default is 100, meaning the check is performed every 100 +Python virtual instructions. Setting it to a larger value may increase +performance for programs using threads. Setting it to a value <= 0 checks +every virtual instruction, maximizing responsiveness as well as overhead.

    +
    +

    Deprecated since version 3.2: This function doesn’t have an effect anymore, as the internal logic for +thread switching and asynchronous tasks has been rewritten. Use +setswitchinterval() instead.

    +
    +
    + +
    +
    +sys.setdlopenflags(n)
    +

    Set the flags used by the interpreter for dlopen() calls, such as when +the interpreter loads extension modules. Among other things, this will enable a +lazy resolving of symbols when importing a module, if called as +sys.setdlopenflags(0). To share symbols across extension modules, call as +sys.setdlopenflags(os.RTLD_GLOBAL). Symbolic names for the flag values +can be found in the os module (RTLD_xxx constants, e.g. +os.RTLD_LAZY).

    +

    Availability: Unix.

    +
    + +
    +
    +sys.setprofile(profilefunc)
    +

    Set the system’s profile function, which allows you to implement a Python source +code profiler in Python. See chapter The Python Profilers for more information on the +Python profiler. The system’s profile function is called similarly to the +system’s trace function (see settrace()), but it is called with different events, +for example it isn’t called for each executed line of code (only on call and return, +but the return event is reported even when an exception has been set). The function is +thread-specific, but there is no way for the profiler to know about context switches between +threads, so it does not make sense to use this in the presence of multiple threads. Also, +its return value is not used, so it can simply return None. Error in the profile +function will cause itself unset.

    +

    Profile functions should have three arguments: frame, event, and +arg. frame is the current stack frame. event is a string: 'call', +'return', 'c_call', 'c_return', or 'c_exception'. arg depends +on the event type.

    +

    The events have the following meaning:

    +
    +
    'call'

    A function is called (or some other code block entered). The +profile function is called; arg is None.

    +
    +
    'return'

    A function (or other code block) is about to return. The profile +function is called; arg is the value that will be returned, or None +if the event is caused by an exception being raised.

    +
    +
    'c_call'

    A C function is about to be called. This may be an extension function or +a built-in. arg is the C function object.

    +
    +
    'c_return'

    A C function has returned. arg is the C function object.

    +
    +
    'c_exception'

    A C function has raised an exception. arg is the C function object.

    +
    +
    +
    + +
    +
    +sys.setrecursionlimit(limit)
    +

    Set the maximum depth of the Python interpreter stack to limit. This limit +prevents infinite recursion from causing an overflow of the C stack and crashing +Python.

    +

    The highest possible limit is platform-dependent. A user may need to set the +limit higher when they have a program that requires deep recursion and a platform +that supports a higher limit. This should be done with care, because a too-high +limit can lead to a crash.

    +

    If the new limit is too low at the current recursion depth, a +RecursionError exception is raised.

    +
    +

    Changed in version 3.5.1: A RecursionError exception is now raised if the new limit is too +low at the current recursion depth.

    +
    +
    + +
    +
    +sys.setswitchinterval(interval)
    +

    Set the interpreter’s thread switch interval (in seconds). This floating-point +value determines the ideal duration of the “timeslices” allocated to +concurrently running Python threads. Please note that the actual value +can be higher, especially if long-running internal functions or methods +are used. Also, which thread becomes scheduled at the end of the interval +is the operating system’s decision. The interpreter doesn’t have its +own scheduler.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +sys.settrace(tracefunc)
    +

    Set the system’s trace function, which allows you to implement a Python +source code debugger in Python. The function is thread-specific; for a +debugger to support multiple threads, it must register a trace function using +settrace() for each thread being debugged or use threading.settrace().

    +

    Trace functions should have three arguments: frame, event, and +arg. frame is the current stack frame. event is a string: 'call', +'line', 'return', 'exception' or 'opcode'. arg depends on +the event type.

    +

    The trace function is invoked (with event set to 'call') whenever a new +local scope is entered; it should return a reference to a local trace +function to be used that scope, or None if the scope shouldn’t be traced.

    +

    The local trace function should return a reference to itself (or to another +function for further tracing in that scope), or None to turn off tracing +in that scope.

    +

    If there is any error occurred in the trace function, it will be unset, just +like settrace(None) is called.

    +

    The events have the following meaning:

    +
    +
    'call'

    A function is called (or some other code block entered). The +global trace function is called; arg is None; the return value +specifies the local trace function.

    +
    +
    'line'

    The interpreter is about to execute a new line of code or re-execute the +condition of a loop. The local trace function is called; arg is +None; the return value specifies the new local trace function. See +Objects/lnotab_notes.txt for a detailed explanation of how this +works. +Per-line events may be disabled for a frame by setting +f_trace_lines to False on that frame.

    +
    +
    'return'

    A function (or other code block) is about to return. The local trace +function is called; arg is the value that will be returned, or None +if the event is caused by an exception being raised. The trace function’s +return value is ignored.

    +
    +
    'exception'

    An exception has occurred. The local trace function is called; arg is a +tuple (exception, value, traceback); the return value specifies the +new local trace function.

    +
    +
    'opcode'

    The interpreter is about to execute a new opcode (see dis for +opcode details). The local trace function is called; arg is +None; the return value specifies the new local trace function. +Per-opcode events are not emitted by default: they must be explicitly +requested by setting f_trace_opcodes to True on the +frame.

    +
    +
    +

    Note that as an exception is propagated down the chain of callers, an +'exception' event is generated at each level.

    +

    For more information on code and frame objects, refer to The standard type hierarchy.

    +
    +

    CPython implementation detail: The settrace() function is intended only for implementing debuggers, +profilers, coverage tools and the like. Its behavior is part of the +implementation platform, rather than part of the language definition, and +thus may not be available in all Python implementations.

    +
    +
    +

    Changed in version 3.7: 'opcode' event type added; f_trace_lines and +f_trace_opcodes attributes added to frames

    +
    +
    + +
    +
    +sys.set_asyncgen_hooks(firstiter, finalizer)
    +

    Accepts two optional keyword arguments which are callables that accept an +asynchronous generator iterator as an argument. The firstiter +callable will be called when an asynchronous generator is iterated for the +first time. The finalizer will be called when an asynchronous generator +is about to be garbage collected.

    +
    +

    New in version 3.6: See PEP 525 for more details, and for a reference example of a +finalizer method see the implementation of +asyncio.Loop.shutdown_asyncgens in +Lib/asyncio/base_events.py

    +
    +
    +

    Note

    +

    This function has been added on a provisional basis (see PEP 411 +for details.)

    +
    +
    + +
    +
    +sys.set_coroutine_origin_tracking_depth(depth)
    +

    Allows enabling or disabling coroutine origin tracking. When +enabled, the cr_origin attribute on coroutine objects will +contain a tuple of (filename, line number, function name) tuples +describing the traceback where the coroutine object was created, +with the most recent call first. When disabled, cr_origin will +be None.

    +

    To enable, pass a depth value greater than zero; this sets the +number of frames whose information will be captured. To disable, +pass set depth to zero.

    +

    This setting is thread-specific.

    +
    +

    New in version 3.7.

    +
    +
    +

    Note

    +

    This function has been added on a provisional basis (see PEP 411 +for details.) Use it only for debugging purposes.

    +
    +
    + +
    +
    +sys.set_coroutine_wrapper(wrapper)
    +

    Allows intercepting creation of coroutine objects (only ones that +are created by an async def function; generators decorated with +types.coroutine() or asyncio.coroutine() will not be +intercepted).

    +

    The wrapper argument must be either:

    +
      +
    • a callable that accepts one argument (a coroutine object);

    • +
    • None, to reset the wrapper.

    • +
    +

    If called twice, the new wrapper replaces the previous one. The function +is thread-specific.

    +

    The wrapper callable cannot define new coroutines directly or indirectly:

    +
    def wrapper(coro):
    +    async def wrap(coro):
    +        return await coro
    +    return wrap(coro)
    +sys.set_coroutine_wrapper(wrapper)
    +
    +async def foo():
    +    pass
    +
    +# The following line will fail with a RuntimeError, because
    +# ``wrapper`` creates a ``wrap(coro)`` coroutine:
    +foo()
    +
    +
    +

    See also get_coroutine_wrapper().

    +
    +

    New in version 3.5: See PEP 492 for more details.

    +
    +
    +

    Note

    +

    This function has been added on a provisional basis (see PEP 411 +for details.) Use it only for debugging purposes.

    +
    +
    +

    Deprecated since version 3.7: The coroutine wrapper functionality has been deprecated, and +will be removed in 3.8. See bpo-32591 for details.

    +
    +
    + +
    +
    +sys._enablelegacywindowsfsencoding()
    +

    Changes the default filesystem encoding and errors mode to ‘mbcs’ and +‘replace’ respectively, for consistency with versions of Python prior to 3.6.

    +

    This is equivalent to defining the PYTHONLEGACYWINDOWSFSENCODING +environment variable before launching Python.

    +

    Availability: Windows.

    +
    +

    New in version 3.6: See PEP 529 for more details.

    +
    +
    + +
    +
    +sys.stdin
    +
    +sys.stdout
    +
    +sys.stderr
    +

    File objects used by the interpreter for standard +input, output and errors:

    +
      +
    • stdin is used for all interactive input (including calls to +input());

    • +
    • stdout is used for the output of print() and expression +statements and for the prompts of input();

    • +
    • The interpreter’s own prompts and its error messages go to stderr.

    • +
    +

    These streams are regular text files like those +returned by the open() function. Their parameters are chosen as +follows:

    +
      +
    • The character encoding is platform-dependent. Non-Windows +platforms use the locale encoding (see +locale.getpreferredencoding()).

      +

      On Windows, UTF-8 is used for the console device. Non-character +devices such as disk files and pipes use the system locale +encoding (i.e. the ANSI codepage). Non-console character +devices such as NUL (i.e. where isatty() returns True) use the +value of the console input and output codepages at startup, +respectively for stdin and stdout/stderr. This defaults to the +system locale encoding if the process is not initially attached +to a console.

      +

      The special behaviour of the console can be overridden +by setting the environment variable PYTHONLEGACYWINDOWSSTDIO +before starting Python. In that case, the console codepages are +used as for any other character device.

      +

      Under all platforms, you can override the character encoding by +setting the PYTHONIOENCODING environment variable before +starting Python or by using the new -X utf8 command +line option and PYTHONUTF8 environment variable. However, +for the Windows console, this only applies when +PYTHONLEGACYWINDOWSSTDIO is also set.

      +
    • +
    • When interactive, stdout and stderr streams are line-buffered. +Otherwise, they are block-buffered like regular text files. You can +override this value with the -u command-line option.

    • +
    +
    +

    Note

    +

    To write or read binary data from/to the standard streams, use the +underlying binary buffer object. For example, to +write bytes to stdout, use sys.stdout.buffer.write(b'abc').

    +

    However, if you are writing a library (and do not control in which +context its code will be executed), be aware that the standard streams +may be replaced with file-like objects like io.StringIO which +do not support the buffer attribute.

    +
    +
    + +
    +
    +sys.__stdin__
    +
    +sys.__stdout__
    +
    +sys.__stderr__
    +

    These objects contain the original values of stdin, stderr and +stdout at the start of the program. They are used during finalization, +and could be useful to print to the actual standard stream no matter if the +sys.std* object has been redirected.

    +

    It can also be used to restore the actual files to known working file objects +in case they have been overwritten with a broken object. However, the +preferred way to do this is to explicitly save the previous stream before +replacing it, and restore the saved object.

    +
    +

    Note

    +

    Under some conditions stdin, stdout and stderr as well as the +original values __stdin__, __stdout__ and __stderr__ can be +None. It is usually the case for Windows GUI apps that aren’t connected +to a console and Python apps started with pythonw.

    +
    +
    + +
    +
    +sys.thread_info
    +

    A struct sequence holding information about the thread +implementation.

    + ++++ + + + + + + + + + + + + + + + + +

    Attribute

    Explanation

    name

    Name of the thread implementation:

    +
    +
      +
    • 'nt': Windows threads

    • +
    • 'pthread': POSIX threads

    • +
    • 'solaris': Solaris threads

    • +
    +
    +

    lock

    Name of the lock implementation:

    +
    +
      +
    • 'semaphore': a lock uses a semaphore

    • +
    • 'mutex+cond': a lock uses a mutex +and a condition variable

    • +
    • None if this information is unknown

    • +
    +
    +

    version

    Name and version of the thread library. It is a string, +or None if this information is unknown.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +sys.tracebacklimit
    +

    When this variable is set to an integer value, it determines the maximum number +of levels of traceback information printed when an unhandled exception occurs. +The default is 1000. When set to 0 or less, all traceback information +is suppressed and only the exception type and value are printed.

    +
    + +
    +
    +sys.version
    +

    A string containing the version number of the Python interpreter plus additional +information on the build number and compiler used. This string is displayed +when the interactive interpreter is started. Do not extract version information +out of it, rather, use version_info and the functions provided by the +platform module.

    +
    + +
    +
    +sys.api_version
    +

    The C API version for this interpreter. Programmers may find this useful when +debugging version conflicts between Python and extension modules.

    +
    + +
    +
    +sys.version_info
    +

    A tuple containing the five components of the version number: major, minor, +micro, releaselevel, and serial. All values except releaselevel are +integers; the release level is 'alpha', 'beta', 'candidate', or +'final'. The version_info value corresponding to the Python version 2.0 +is (2, 0, 0, 'final', 0). The components can also be accessed by name, +so sys.version_info[0] is equivalent to sys.version_info.major +and so on.

    +
    +

    Changed in version 3.1: Added named component attributes.

    +
    +
    + +
    +
    +sys.warnoptions
    +

    This is an implementation detail of the warnings framework; do not modify this +value. Refer to the warnings module for more information on the warnings +framework.

    +
    + +
    +
    +sys.winver
    +

    The version number used to form registry keys on Windows platforms. This is +stored as string resource 1000 in the Python DLL. The value is normally the +first three characters of version. It is provided in the sys +module for informational purposes; modifying this value has no effect on the +registry keys used by Python.

    +

    Availability: Windows.

    +
    + +
    +
    +sys._xoptions
    +

    A dictionary of the various implementation-specific flags passed through +the -X command-line option. Option names are either mapped to +their values, if given explicitly, or to True. Example:

    +
    $ ./python -Xa=b -Xc
    +Python 3.2a3+ (py3k, Oct 16 2010, 20:14:50)
    +[GCC 4.4.3] on linux2
    +Type "help", "copyright", "credits" or "license" for more information.
    +>>> import sys
    +>>> sys._xoptions
    +{'a': 'b', 'c': True}
    +
    +
    +
    +

    CPython implementation detail: This is a CPython-specific way of accessing options passed through +-X. Other implementations may export them through other +means, or not at all.

    +
    +
    +

    New in version 3.2.

    +
    +
    + +

    Citations

    +
    +
    C99
    +

    ISO/IEC 9899:1999. “Programming languages – C.” A public draft of this standard is available at http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1256.pdf.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/sysconfig.html b/python-3.7.4-docs-html/library/sysconfig.html new file mode 100644 index 0000000..429c6ef --- /dev/null +++ b/python-3.7.4-docs-html/library/sysconfig.html @@ -0,0 +1,426 @@ + + + + + + + sysconfig — Provide access to Python’s configuration information — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    sysconfig — Provide access to Python’s configuration information

    +
    +

    New in version 3.2.

    +
    +

    Source code: Lib/sysconfig.py

    +
    +

    The sysconfig module provides access to Python’s configuration +information like the list of installation paths and the configuration variables +relevant for the current platform.

    +
    +

    Configuration variables

    +

    A Python distribution contains a Makefile and a pyconfig.h +header file that are necessary to build both the Python binary itself and +third-party C extensions compiled using distutils.

    +

    sysconfig puts all variables found in these files in a dictionary that +can be accessed using get_config_vars() or get_config_var().

    +

    Notice that on Windows, it’s a much smaller set.

    +
    +
    +sysconfig.get_config_vars(*args)
    +

    With no arguments, return a dictionary of all configuration variables +relevant for the current platform.

    +

    With arguments, return a list of values that result from looking up each +argument in the configuration variable dictionary.

    +

    For each argument, if the value is not found, return None.

    +
    + +
    +
    +sysconfig.get_config_var(name)
    +

    Return the value of a single variable name. Equivalent to +get_config_vars().get(name).

    +

    If name is not found, return None.

    +
    + +

    Example of usage:

    +
    >>> import sysconfig
    +>>> sysconfig.get_config_var('Py_ENABLE_SHARED')
    +0
    +>>> sysconfig.get_config_var('LIBDIR')
    +'/usr/local/lib'
    +>>> sysconfig.get_config_vars('AR', 'CXX')
    +['ar', 'g++']
    +
    +
    +
    +
    +

    Installation paths

    +

    Python uses an installation scheme that differs depending on the platform and on +the installation options. These schemes are stored in sysconfig under +unique identifiers based on the value returned by os.name.

    +

    Every new component that is installed using distutils or a +Distutils-based system will follow the same scheme to copy its file in the right +places.

    +

    Python currently supports seven schemes:

    +
      +
    • posix_prefix: scheme for Posix platforms like Linux or Mac OS X. This is +the default scheme used when Python or a component is installed.

    • +
    • posix_home: scheme for Posix platforms used when a home option is used +upon installation. This scheme is used when a component is installed through +Distutils with a specific home prefix.

    • +
    • posix_user: scheme for Posix platforms used when a component is installed +through Distutils and the user option is used. This scheme defines paths +located under the user home directory.

    • +
    • nt: scheme for NT platforms like Windows.

    • +
    • nt_user: scheme for NT platforms, when the user option is used.

    • +
    +

    Each scheme is itself composed of a series of paths and each path has a unique +identifier. Python currently uses eight paths:

    +
      +
    • stdlib: directory containing the standard Python library files that are not +platform-specific.

    • +
    • platstdlib: directory containing the standard Python library files that are +platform-specific.

    • +
    • platlib: directory for site-specific, platform-specific files.

    • +
    • purelib: directory for site-specific, non-platform-specific files.

    • +
    • include: directory for non-platform-specific header files.

    • +
    • platinclude: directory for platform-specific header files.

    • +
    • scripts: directory for script files.

    • +
    • data: directory for data files.

    • +
    +

    sysconfig provides some functions to determine these paths.

    +
    +
    +sysconfig.get_scheme_names()
    +

    Return a tuple containing all schemes currently supported in +sysconfig.

    +
    + +
    +
    +sysconfig.get_path_names()
    +

    Return a tuple containing all path names currently supported in +sysconfig.

    +
    + +
    +
    +sysconfig.get_path(name[, scheme[, vars[, expand]]])
    +

    Return an installation path corresponding to the path name, from the +install scheme named scheme.

    +

    name has to be a value from the list returned by get_path_names().

    +

    sysconfig stores installation paths corresponding to each path name, +for each platform, with variables to be expanded. For instance the stdlib +path for the nt scheme is: {base}/Lib.

    +

    get_path() will use the variables returned by get_config_vars() +to expand the path. All variables have default values for each platform so +one may call this function and get the default value.

    +

    If scheme is provided, it must be a value from the list returned by +get_scheme_names(). Otherwise, the default scheme for the current +platform is used.

    +

    If vars is provided, it must be a dictionary of variables that will update +the dictionary return by get_config_vars().

    +

    If expand is set to False, the path will not be expanded using the +variables.

    +

    If name is not found, return None.

    +
    + +
    +
    +sysconfig.get_paths([scheme[, vars[, expand]]])
    +

    Return a dictionary containing all installation paths corresponding to an +installation scheme. See get_path() for more information.

    +

    If scheme is not provided, will use the default scheme for the current +platform.

    +

    If vars is provided, it must be a dictionary of variables that will +update the dictionary used to expand the paths.

    +

    If expand is set to false, the paths will not be expanded.

    +

    If scheme is not an existing scheme, get_paths() will raise a +KeyError.

    +
    + +
    +
    +

    Other functions

    +
    +
    +sysconfig.get_python_version()
    +

    Return the MAJOR.MINOR Python version number as a string. Similar to +'%d.%d' % sys.version_info[:2].

    +
    + +
    +
    +sysconfig.get_platform()
    +

    Return a string that identifies the current platform.

    +

    This is used mainly to distinguish platform-specific build directories and +platform-specific built distributions. Typically includes the OS name and +version and the architecture (as supplied by ‘os.uname()’), although the +exact information included depends on the OS; e.g., on Linux, the kernel +version isn’t particularly important.

    +

    Examples of returned values:

    +
      +
    • linux-i586

    • +
    • linux-alpha (?)

    • +
    • solaris-2.6-sun4u

    • +
    +

    Windows will return one of:

    +
      +
    • win-amd64 (64bit Windows on AMD64, aka x86_64, Intel64, and EM64T)

    • +
    • win32 (all others - specifically, sys.platform is returned)

    • +
    +

    Mac OS X can return:

    +
      +
    • macosx-10.6-ppc

    • +
    • macosx-10.4-ppc64

    • +
    • macosx-10.3-i386

    • +
    • macosx-10.4-fat

    • +
    +

    For other non-POSIX platforms, currently just returns sys.platform.

    +
    + +
    +
    +sysconfig.is_python_build()
    +

    Return True if the running Python interpreter was built from source and +is being run from its built location, and not from a location resulting from +e.g. running make install or installing via a binary installer.

    +
    + +
    +
    +sysconfig.parse_config_h(fp[, vars])
    +

    Parse a config.h-style file.

    +

    fp is a file-like object pointing to the config.h-like file.

    +

    A dictionary containing name/value pairs is returned. If an optional +dictionary is passed in as the second argument, it is used instead of a new +dictionary, and updated with the values read in the file.

    +
    + +
    +
    +sysconfig.get_config_h_filename()
    +

    Return the path of pyconfig.h.

    +
    + +
    +
    +sysconfig.get_makefile_filename()
    +

    Return the path of Makefile.

    +
    + +
    +
    +

    Using sysconfig as a script

    +

    You can use sysconfig as a script with Python’s -m option:

    +
    $ python -m sysconfig
    +Platform: "macosx-10.4-i386"
    +Python version: "3.2"
    +Current installation scheme: "posix_prefix"
    +
    +Paths:
    +        data = "/usr/local"
    +        include = "/Users/tarek/Dev/svn.python.org/py3k/Include"
    +        platinclude = "."
    +        platlib = "/usr/local/lib/python3.2/site-packages"
    +        platstdlib = "/usr/local/lib/python3.2"
    +        purelib = "/usr/local/lib/python3.2/site-packages"
    +        scripts = "/usr/local/bin"
    +        stdlib = "/usr/local/lib/python3.2"
    +
    +Variables:
    +        AC_APPLE_UNIVERSAL_BUILD = "0"
    +        AIX_GENUINE_CPLUSPLUS = "0"
    +        AR = "ar"
    +        ARFLAGS = "rc"
    +        ...
    +
    +
    +

    This call will print in the standard output the information returned by +get_platform(), get_python_version(), get_path() and +get_config_vars().

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/syslog.html b/python-3.7.4-docs-html/library/syslog.html new file mode 100644 index 0000000..d6559cb --- /dev/null +++ b/python-3.7.4-docs-html/library/syslog.html @@ -0,0 +1,295 @@ + + + + + + + syslog — Unix syslog library routines — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    syslog — Unix syslog library routines

    +
    +

    This module provides an interface to the Unix syslog library routines. +Refer to the Unix manual pages for a detailed description of the syslog +facility.

    +

    This module wraps the system syslog family of routines. A pure Python +library that can speak to a syslog server is available in the +logging.handlers module as SysLogHandler.

    +

    The module defines the following functions:

    +
    +
    +syslog.syslog(message)
    +
    +syslog.syslog(priority, message)
    +

    Send the string message to the system logger. A trailing newline is added +if necessary. Each message is tagged with a priority composed of a +facility and a level. The optional priority argument, which defaults +to LOG_INFO, determines the message priority. If the facility is +not encoded in priority using logical-or (LOG_INFO | LOG_USER), the +value given in the openlog() call is used.

    +

    If openlog() has not been called prior to the call to syslog(), +openlog() will be called with no arguments.

    +
    + +
    +
    +syslog.openlog([ident[, logoption[, facility]]])
    +

    Logging options of subsequent syslog() calls can be set by calling +openlog(). syslog() will call openlog() with no arguments +if the log is not currently open.

    +

    The optional ident keyword argument is a string which is prepended to every +message, and defaults to sys.argv[0] with leading path components +stripped. The optional logoption keyword argument (default is 0) is a bit +field – see below for possible values to combine. The optional facility +keyword argument (default is LOG_USER) sets the default facility for +messages which do not have a facility explicitly encoded.

    +
    +

    Changed in version 3.2: In previous versions, keyword arguments were not allowed, and ident was +required. The default for ident was dependent on the system libraries, +and often was python instead of the name of the Python program file.

    +
    +
    + +
    +
    +syslog.closelog()
    +

    Reset the syslog module values and call the system library closelog().

    +

    This causes the module to behave as it does when initially imported. For +example, openlog() will be called on the first syslog() call (if +openlog() hasn’t already been called), and ident and other +openlog() parameters are reset to defaults.

    +
    + +
    +
    +syslog.setlogmask(maskpri)
    +

    Set the priority mask to maskpri and return the previous mask value. Calls +to syslog() with a priority level not set in maskpri are ignored. +The default is to log all priorities. The function LOG_MASK(pri) +calculates the mask for the individual priority pri. The function +LOG_UPTO(pri) calculates the mask for all priorities up to and including +pri.

    +
    + +

    The module defines the following constants:

    +
    +
    Priority levels (high to low):

    LOG_EMERG, LOG_ALERT, LOG_CRIT, LOG_ERR, +LOG_WARNING, LOG_NOTICE, LOG_INFO, +LOG_DEBUG.

    +
    +
    Facilities:

    LOG_KERN, LOG_USER, LOG_MAIL, LOG_DAEMON, +LOG_AUTH, LOG_LPR, LOG_NEWS, LOG_UUCP, +LOG_CRON, LOG_SYSLOG, LOG_LOCAL0 to +LOG_LOCAL7, and, if defined in <syslog.h>, +LOG_AUTHPRIV.

    +
    +
    Log options:

    LOG_PID, LOG_CONS, LOG_NDELAY, and, if defined +in <syslog.h>, LOG_ODELAY, LOG_NOWAIT, and +LOG_PERROR.

    +
    +
    +
    +

    Examples

    +
    +

    Simple example

    +

    A simple set of examples:

    +
    import syslog
    +
    +syslog.syslog('Processing started')
    +if error:
    +    syslog.syslog(syslog.LOG_ERR, 'Processing started')
    +
    +
    +

    An example of setting some log options, these would include the process ID in +logged messages, and write the messages to the destination facility used for +mail logging:

    +
    syslog.openlog(logoption=syslog.LOG_PID, facility=syslog.LOG_MAIL)
    +syslog.syslog('E-mail processing initiated...')
    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/tabnanny.html b/python-3.7.4-docs-html/library/tabnanny.html new file mode 100644 index 0000000..854fbed --- /dev/null +++ b/python-3.7.4-docs-html/library/tabnanny.html @@ -0,0 +1,239 @@ + + + + + + + tabnanny — Detection of ambiguous indentation — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    tabnanny — Detection of ambiguous indentation

    +

    Source code: Lib/tabnanny.py

    +
    +

    For the time being this module is intended to be called as a script. However it +is possible to import it into an IDE and use the function check() +described below.

    +
    +

    Note

    +

    The API provided by this module is likely to change in future releases; such +changes may not be backward compatible.

    +
    +
    +
    +tabnanny.check(file_or_dir)
    +

    If file_or_dir is a directory and not a symbolic link, then recursively +descend the directory tree named by file_or_dir, checking all .py +files along the way. If file_or_dir is an ordinary Python source file, it +is checked for whitespace related problems. The diagnostic messages are +written to standard output using the print() function.

    +
    + +
    +
    +tabnanny.verbose
    +

    Flag indicating whether to print verbose messages. This is incremented by the +-v option if called as a script.

    +
    + +
    +
    +tabnanny.filename_only
    +

    Flag indicating whether to print only the filenames of files containing +whitespace related problems. This is set to true by the -q option if called +as a script.

    +
    + +
    +
    +exception tabnanny.NannyNag
    +

    Raised by process_tokens() if detecting an ambiguous indent. Captured and +handled in check().

    +
    + +
    +
    +tabnanny.process_tokens(tokens)
    +

    This function is used by check() to process tokens generated by the +tokenize module.

    +
    + +
    +

    See also

    +
    +
    Module tokenize

    Lexical scanner for Python source code.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/tarfile.html b/python-3.7.4-docs-html/library/tarfile.html new file mode 100644 index 0000000..e11fd19 --- /dev/null +++ b/python-3.7.4-docs-html/library/tarfile.html @@ -0,0 +1,1100 @@ + + + + + + + tarfile — Read and write tar archive files — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    tarfile — Read and write tar archive files

    +

    Source code: Lib/tarfile.py

    +
    +

    The tarfile module makes it possible to read and write tar +archives, including those using gzip, bz2 and lzma compression. +Use the zipfile module to read or write .zip files, or the +higher-level functions in shutil.

    +

    Some facts and figures:

    +
      +
    • reads and writes gzip, bz2 and lzma compressed archives +if the respective modules are available.

    • +
    • read/write support for the POSIX.1-1988 (ustar) format.

    • +
    • read/write support for the GNU tar format including longname and longlink +extensions, read-only support for all variants of the sparse extension +including restoration of sparse files.

    • +
    • read/write support for the POSIX.1-2001 (pax) format.

    • +
    • handles directories, regular files, hardlinks, symbolic links, fifos, +character devices and block devices and is able to acquire and restore file +information like timestamp, access permissions and owner.

    • +
    +
    +

    Changed in version 3.3: Added support for lzma compression.

    +
    +
    +
    +tarfile.open(name=None, mode='r', fileobj=None, bufsize=10240, **kwargs)
    +

    Return a TarFile object for the pathname name. For detailed +information on TarFile objects and the keyword arguments that are +allowed, see TarFile Objects.

    +

    mode has to be a string of the form 'filemode[:compression]', it defaults +to 'r'. Here is a full list of mode combinations:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    mode

    action

    'r' or 'r:*'

    Open for reading with transparent +compression (recommended).

    'r:'

    Open for reading exclusively without +compression.

    'r:gz'

    Open for reading with gzip compression.

    'r:bz2'

    Open for reading with bzip2 compression.

    'r:xz'

    Open for reading with lzma compression.

    'x' or +'x:'

    Create a tarfile exclusively without +compression. +Raise an FileExistsError exception +if it already exists.

    'x:gz'

    Create a tarfile with gzip compression. +Raise an FileExistsError exception +if it already exists.

    'x:bz2'

    Create a tarfile with bzip2 compression. +Raise an FileExistsError exception +if it already exists.

    'x:xz'

    Create a tarfile with lzma compression. +Raise an FileExistsError exception +if it already exists.

    'a' or 'a:'

    Open for appending with no compression. The +file is created if it does not exist.

    'w' or 'w:'

    Open for uncompressed writing.

    'w:gz'

    Open for gzip compressed writing.

    'w:bz2'

    Open for bzip2 compressed writing.

    'w:xz'

    Open for lzma compressed writing.

    +

    Note that 'a:gz', 'a:bz2' or 'a:xz' is not possible. If mode +is not suitable to open a certain (compressed) file for reading, +ReadError is raised. Use mode 'r' to avoid this. If a +compression method is not supported, CompressionError is raised.

    +

    If fileobj is specified, it is used as an alternative to a file object +opened in binary mode for name. It is supposed to be at position 0.

    +

    For modes 'w:gz', 'r:gz', 'w:bz2', 'r:bz2', 'x:gz', +'x:bz2', tarfile.open() accepts the keyword argument +compresslevel (default 9) to specify the compression level of the file.

    +

    For special purposes, there is a second format for mode: +'filemode|[compression]'. tarfile.open() will return a TarFile +object that processes its data as a stream of blocks. No random seeking will +be done on the file. If given, fileobj may be any object that has a +read() or write() method (depending on the mode). bufsize +specifies the blocksize and defaults to 20 * 512 bytes. Use this variant +in combination with e.g. sys.stdin, a socket file object or a tape +device. However, such a TarFile object is limited in that it does +not allow random access, see Examples. The currently +possible modes:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Mode

    Action

    'r|*'

    Open a stream of tar blocks for reading +with transparent compression.

    'r|'

    Open a stream of uncompressed tar blocks +for reading.

    'r|gz'

    Open a gzip compressed stream for +reading.

    'r|bz2'

    Open a bzip2 compressed stream for +reading.

    'r|xz'

    Open an lzma compressed stream for +reading.

    'w|'

    Open an uncompressed stream for writing.

    'w|gz'

    Open a gzip compressed stream for +writing.

    'w|bz2'

    Open a bzip2 compressed stream for +writing.

    'w|xz'

    Open an lzma compressed stream for +writing.

    +
    +

    Changed in version 3.5: The 'x' (exclusive creation) mode was added.

    +
    +
    +

    Changed in version 3.6: The name parameter accepts a path-like object.

    +
    +
    + +
    +
    +class tarfile.TarFile
    +

    Class for reading and writing tar archives. Do not use this class directly: +use tarfile.open() instead. See TarFile Objects.

    +
    + +
    +
    +tarfile.is_tarfile(name)
    +

    Return True if name is a tar archive file, that the tarfile +module can read.

    +
    + +

    The tarfile module defines the following exceptions:

    +
    +
    +exception tarfile.TarError
    +

    Base class for all tarfile exceptions.

    +
    + +
    +
    +exception tarfile.ReadError
    +

    Is raised when a tar archive is opened, that either cannot be handled by the +tarfile module or is somehow invalid.

    +
    + +
    +
    +exception tarfile.CompressionError
    +

    Is raised when a compression method is not supported or when the data cannot be +decoded properly.

    +
    + +
    +
    +exception tarfile.StreamError
    +

    Is raised for the limitations that are typical for stream-like TarFile +objects.

    +
    + +
    +
    +exception tarfile.ExtractError
    +

    Is raised for non-fatal errors when using TarFile.extract(), but only if +TarFile.errorlevel== 2.

    +
    + +
    +
    +exception tarfile.HeaderError
    +

    Is raised by TarInfo.frombuf() if the buffer it gets is invalid.

    +
    + +

    The following constants are available at the module level:

    +
    +
    +tarfile.ENCODING
    +

    The default character encoding: 'utf-8' on Windows, the value returned by +sys.getfilesystemencoding() otherwise.

    +
    + +

    Each of the following constants defines a tar archive format that the +tarfile module is able to create. See section Supported tar formats for +details.

    +
    +
    +tarfile.USTAR_FORMAT
    +

    POSIX.1-1988 (ustar) format.

    +
    + +
    +
    +tarfile.GNU_FORMAT
    +

    GNU tar format.

    +
    + +
    +
    +tarfile.PAX_FORMAT
    +

    POSIX.1-2001 (pax) format.

    +
    + +
    +
    +tarfile.DEFAULT_FORMAT
    +

    The default format for creating archives. This is currently GNU_FORMAT.

    +
    + +
    +

    See also

    +
    +
    Module zipfile

    Documentation of the zipfile standard module.

    +
    +
    Archiving operations

    Documentation of the higher-level archiving facilities provided by the +standard shutil module.

    +
    +
    GNU tar manual, Basic Tar Format

    Documentation for tar archive files, including GNU tar extensions.

    +
    +
    +
    +
    +

    TarFile Objects

    +

    The TarFile object provides an interface to a tar archive. A tar +archive is a sequence of blocks. An archive member (a stored file) is made up of +a header block followed by data blocks. It is possible to store a file in a tar +archive several times. Each archive member is represented by a TarInfo +object, see TarInfo Objects for details.

    +

    A TarFile object can be used as a context manager in a with +statement. It will automatically be closed when the block is completed. Please +note that in the event of an exception an archive opened for writing will not +be finalized; only the internally used file object will be closed. See the +Examples section for a use case.

    +
    +

    New in version 3.2: Added support for the context management protocol.

    +
    +
    +
    +class tarfile.TarFile(name=None, mode='r', fileobj=None, format=DEFAULT_FORMAT, tarinfo=TarInfo, dereference=False, ignore_zeros=False, encoding=ENCODING, errors='surrogateescape', pax_headers=None, debug=0, errorlevel=0)
    +

    All following arguments are optional and can be accessed as instance attributes +as well.

    +

    name is the pathname of the archive. name may be a path-like object. +It can be omitted if fileobj is given. +In this case, the file object’s name attribute is used if it exists.

    +

    mode is either 'r' to read from an existing archive, 'a' to append +data to an existing file, 'w' to create a new file overwriting an existing +one, or 'x' to create a new file only if it does not already exist.

    +

    If fileobj is given, it is used for reading or writing data. If it can be +determined, mode is overridden by fileobj’s mode. fileobj will be used +from position 0.

    +
    +

    Note

    +

    fileobj is not closed, when TarFile is closed.

    +
    +

    format controls the archive format. It must be one of the constants +USTAR_FORMAT, GNU_FORMAT or PAX_FORMAT that are +defined at module level.

    +

    The tarinfo argument can be used to replace the default TarInfo class +with a different one.

    +

    If dereference is False, add symbolic and hard links to the archive. If it +is True, add the content of the target files to the archive. This has no +effect on systems that do not support symbolic links.

    +

    If ignore_zeros is False, treat an empty block as the end of the archive. +If it is True, skip empty (and invalid) blocks and try to get as many members +as possible. This is only useful for reading concatenated or damaged archives.

    +

    debug can be set from 0 (no debug messages) up to 3 (all debug +messages). The messages are written to sys.stderr.

    +

    If errorlevel is 0, all errors are ignored when using TarFile.extract(). +Nevertheless, they appear as error messages in the debug output, when debugging +is enabled. If 1, all fatal errors are raised as OSError +exceptions. If 2, all non-fatal errors are raised as TarError +exceptions as well.

    +

    The encoding and errors arguments define the character encoding to be +used for reading or writing the archive and how conversion errors are going +to be handled. The default settings will work for most users. +See section Unicode issues for in-depth information.

    +

    The pax_headers argument is an optional dictionary of strings which +will be added as a pax global header if format is PAX_FORMAT.

    +
    +

    Changed in version 3.2: Use 'surrogateescape' as the default for the errors argument.

    +
    +
    +

    Changed in version 3.5: The 'x' (exclusive creation) mode was added.

    +
    +
    +

    Changed in version 3.6: The name parameter accepts a path-like object.

    +
    +
    + +
    +
    +classmethod TarFile.open(...)
    +

    Alternative constructor. The tarfile.open() function is actually a +shortcut to this classmethod.

    +
    + +
    +
    +TarFile.getmember(name)
    +

    Return a TarInfo object for member name. If name can not be found +in the archive, KeyError is raised.

    +
    +

    Note

    +

    If a member occurs more than once in the archive, its last occurrence is assumed +to be the most up-to-date version.

    +
    +
    + +
    +
    +TarFile.getmembers()
    +

    Return the members of the archive as a list of TarInfo objects. The +list has the same order as the members in the archive.

    +
    + +
    +
    +TarFile.getnames()
    +

    Return the members as a list of their names. It has the same order as the list +returned by getmembers().

    +
    + +
    +
    +TarFile.list(verbose=True, *, members=None)
    +

    Print a table of contents to sys.stdout. If verbose is False, +only the names of the members are printed. If it is True, output +similar to that of ls -l is produced. If optional members is +given, it must be a subset of the list returned by getmembers().

    +
    +

    Changed in version 3.5: Added the members parameter.

    +
    +
    + +
    +
    +TarFile.next()
    +

    Return the next member of the archive as a TarInfo object, when +TarFile is opened for reading. Return None if there is no more +available.

    +
    + +
    +
    +TarFile.extractall(path=".", members=None, *, numeric_owner=False)
    +

    Extract all members from the archive to the current working directory or +directory path. If optional members is given, it must be a subset of the +list returned by getmembers(). Directory information like owner, +modification time and permissions are set after all members have been extracted. +This is done to work around two problems: A directory’s modification time is +reset each time a file is created in it. And, if a directory’s permissions do +not allow writing, extracting files to it will fail.

    +

    If numeric_owner is True, the uid and gid numbers from the tarfile +are used to set the owner/group for the extracted files. Otherwise, the named +values from the tarfile are used.

    +
    +

    Warning

    +

    Never extract archives from untrusted sources without prior inspection. +It is possible that files are created outside of path, e.g. members +that have absolute filenames starting with "/" or filenames with two +dots "..".

    +
    +
    +

    Changed in version 3.5: Added the numeric_owner parameter.

    +
    +
    +

    Changed in version 3.6: The path parameter accepts a path-like object.

    +
    +
    + +
    +
    +TarFile.extract(member, path="", set_attrs=True, *, numeric_owner=False)
    +

    Extract a member from the archive to the current working directory, using its +full name. Its file information is extracted as accurately as possible. member +may be a filename or a TarInfo object. You can specify a different +directory using path. path may be a path-like object. +File attributes (owner, mtime, mode) are set unless set_attrs is false.

    +

    If numeric_owner is True, the uid and gid numbers from the tarfile +are used to set the owner/group for the extracted files. Otherwise, the named +values from the tarfile are used.

    +
    +

    Note

    +

    The extract() method does not take care of several extraction issues. +In most cases you should consider using the extractall() method.

    +
    +
    +

    Warning

    +

    See the warning for extractall().

    +
    +
    +

    Changed in version 3.2: Added the set_attrs parameter.

    +
    +
    +

    Changed in version 3.5: Added the numeric_owner parameter.

    +
    +
    +

    Changed in version 3.6: The path parameter accepts a path-like object.

    +
    +
    + +
    +
    +TarFile.extractfile(member)
    +

    Extract a member from the archive as a file object. member may be a filename +or a TarInfo object. If member is a regular file or a link, an +io.BufferedReader object is returned. Otherwise, None is +returned.

    +
    +

    Changed in version 3.3: Return an io.BufferedReader object.

    +
    +
    + +
    +
    +TarFile.add(name, arcname=None, recursive=True, *, filter=None)
    +

    Add the file name to the archive. name may be any type of file +(directory, fifo, symbolic link, etc.). If given, arcname specifies an +alternative name for the file in the archive. Directories are added +recursively by default. This can be avoided by setting recursive to +False. Recursion adds entries in sorted order. +If filter is given, it +should be a function that takes a TarInfo object argument and +returns the changed TarInfo object. If it instead returns +None the TarInfo object will be excluded from the +archive. See Examples for an example.

    +
    +

    Changed in version 3.2: Added the filter parameter.

    +
    +
    +

    Changed in version 3.7: Recursion adds entries in sorted order.

    +
    +
    + +
    +
    +TarFile.addfile(tarinfo, fileobj=None)
    +

    Add the TarInfo object tarinfo to the archive. If fileobj is given, +it should be a binary file, and +tarinfo.size bytes are read from it and added to the archive. You can +create TarInfo objects directly, or by using gettarinfo().

    +
    + +
    +
    +TarFile.gettarinfo(name=None, arcname=None, fileobj=None)
    +

    Create a TarInfo object from the result of os.stat() or +equivalent on an existing file. The file is either named by name, or +specified as a file object fileobj with a file descriptor. +name may be a path-like object. If +given, arcname specifies an alternative name for the file in the +archive, otherwise, the name is taken from fileobj’s +name attribute, or the name argument. The name +should be a text string.

    +

    You can modify +some of the TarInfo’s attributes before you add it using addfile(). +If the file object is not an ordinary file object positioned at the +beginning of the file, attributes such as size may need +modifying. This is the case for objects such as GzipFile. +The name may also be modified, in which case arcname +could be a dummy string.

    +
    +

    Changed in version 3.6: The name parameter accepts a path-like object.

    +
    +
    + +
    +
    +TarFile.close()
    +

    Close the TarFile. In write mode, two finishing zero blocks are +appended to the archive.

    +
    + +
    +
    +TarFile.pax_headers
    +

    A dictionary containing key-value pairs of pax global headers.

    +
    + +
    +
    +

    TarInfo Objects

    +

    A TarInfo object represents one member in a TarFile. Aside +from storing all required attributes of a file (like file type, size, time, +permissions, owner etc.), it provides some useful methods to determine its type. +It does not contain the file’s data itself.

    +

    TarInfo objects are returned by TarFile’s methods +getmember(), getmembers() and gettarinfo().

    +
    +
    +class tarfile.TarInfo(name="")
    +

    Create a TarInfo object.

    +
    + +
    +
    +classmethod TarInfo.frombuf(buf, encoding, errors)
    +

    Create and return a TarInfo object from string buffer buf.

    +

    Raises HeaderError if the buffer is invalid.

    +
    + +
    +
    +classmethod TarInfo.fromtarfile(tarfile)
    +

    Read the next member from the TarFile object tarfile and return it as +a TarInfo object.

    +
    + +
    +
    +TarInfo.tobuf(format=DEFAULT_FORMAT, encoding=ENCODING, errors='surrogateescape')
    +

    Create a string buffer from a TarInfo object. For information on the +arguments see the constructor of the TarFile class.

    +
    +

    Changed in version 3.2: Use 'surrogateescape' as the default for the errors argument.

    +
    +
    + +

    A TarInfo object has the following public data attributes:

    +
    +
    +TarInfo.name
    +

    Name of the archive member.

    +
    + +
    +
    +TarInfo.size
    +

    Size in bytes.

    +
    + +
    +
    +TarInfo.mtime
    +

    Time of last modification.

    +
    + +
    +
    +TarInfo.mode
    +

    Permission bits.

    +
    + +
    +
    +TarInfo.type
    +

    File type. type is usually one of these constants: REGTYPE, +AREGTYPE, LNKTYPE, SYMTYPE, DIRTYPE, +FIFOTYPE, CONTTYPE, CHRTYPE, BLKTYPE, +GNUTYPE_SPARSE. To determine the type of a TarInfo object +more conveniently, use the is*() methods below.

    +
    + +
    +
    +TarInfo.linkname
    +

    Name of the target file name, which is only present in TarInfo objects +of type LNKTYPE and SYMTYPE.

    +
    + +
    +
    +TarInfo.uid
    +

    User ID of the user who originally stored this member.

    +
    + +
    +
    +TarInfo.gid
    +

    Group ID of the user who originally stored this member.

    +
    + +
    +
    +TarInfo.uname
    +

    User name.

    +
    + +
    +
    +TarInfo.gname
    +

    Group name.

    +
    + +
    +
    +TarInfo.pax_headers
    +

    A dictionary containing key-value pairs of an associated pax extended header.

    +
    + +

    A TarInfo object also provides some convenient query methods:

    +
    +
    +TarInfo.isfile()
    +

    Return True if the Tarinfo object is a regular file.

    +
    + +
    +
    +TarInfo.isreg()
    +

    Same as isfile().

    +
    + +
    +
    +TarInfo.isdir()
    +

    Return True if it is a directory.

    +
    + +
    +
    +TarInfo.issym()
    +

    Return True if it is a symbolic link.

    +
    + +
    +
    +TarInfo.islnk()
    +

    Return True if it is a hard link.

    +
    + +
    +
    +TarInfo.ischr()
    +

    Return True if it is a character device.

    +
    + +
    +
    +TarInfo.isblk()
    +

    Return True if it is a block device.

    +
    + +
    +
    +TarInfo.isfifo()
    +

    Return True if it is a FIFO.

    +
    + +
    +
    +TarInfo.isdev()
    +

    Return True if it is one of character device, block device or FIFO.

    +
    + +
    +
    +

    Command-Line Interface

    +
    +

    New in version 3.4.

    +
    +

    The tarfile module provides a simple command-line interface to interact +with tar archives.

    +

    If you want to create a new tar archive, specify its name after the -c +option and then list the filename(s) that should be included:

    +
    $ python -m tarfile -c monty.tar  spam.txt eggs.txt
    +
    +
    +

    Passing a directory is also acceptable:

    +
    $ python -m tarfile -c monty.tar life-of-brian_1979/
    +
    +
    +

    If you want to extract a tar archive into the current directory, use +the -e option:

    +
    $ python -m tarfile -e monty.tar
    +
    +
    +

    You can also extract a tar archive into a different directory by passing the +directory’s name:

    +
    $ python -m tarfile -e monty.tar  other-dir/
    +
    +
    +

    For a list of the files in a tar archive, use the -l option:

    +
    $ python -m tarfile -l monty.tar
    +
    +
    +
    +

    Command-line options

    +
    +
    +-l <tarfile>
    +
    +--list <tarfile>
    +

    List files in a tarfile.

    +
    + +
    +
    +-c <tarfile> <source1> ... <sourceN>
    +
    +--create <tarfile> <source1> ... <sourceN>
    +

    Create tarfile from source files.

    +
    + +
    +
    +-e <tarfile> [<output_dir>]
    +
    +--extract <tarfile> [<output_dir>]
    +

    Extract tarfile into the current directory if output_dir is not specified.

    +
    + +
    +
    +-t <tarfile>
    +
    +--test <tarfile>
    +

    Test whether the tarfile is valid or not.

    +
    + +
    +
    +-v, --verbose
    +

    Verbose output.

    +
    + +
    +
    +
    +

    Examples

    +

    How to extract an entire tar archive to the current working directory:

    +
    import tarfile
    +tar = tarfile.open("sample.tar.gz")
    +tar.extractall()
    +tar.close()
    +
    +
    +

    How to extract a subset of a tar archive with TarFile.extractall() using +a generator function instead of a list:

    +
    import os
    +import tarfile
    +
    +def py_files(members):
    +    for tarinfo in members:
    +        if os.path.splitext(tarinfo.name)[1] == ".py":
    +            yield tarinfo
    +
    +tar = tarfile.open("sample.tar.gz")
    +tar.extractall(members=py_files(tar))
    +tar.close()
    +
    +
    +

    How to create an uncompressed tar archive from a list of filenames:

    +
    import tarfile
    +tar = tarfile.open("sample.tar", "w")
    +for name in ["foo", "bar", "quux"]:
    +    tar.add(name)
    +tar.close()
    +
    +
    +

    The same example using the with statement:

    +
    import tarfile
    +with tarfile.open("sample.tar", "w") as tar:
    +    for name in ["foo", "bar", "quux"]:
    +        tar.add(name)
    +
    +
    +

    How to read a gzip compressed tar archive and display some member information:

    +
    import tarfile
    +tar = tarfile.open("sample.tar.gz", "r:gz")
    +for tarinfo in tar:
    +    print(tarinfo.name, "is", tarinfo.size, "bytes in size and is", end="")
    +    if tarinfo.isreg():
    +        print("a regular file.")
    +    elif tarinfo.isdir():
    +        print("a directory.")
    +    else:
    +        print("something else.")
    +tar.close()
    +
    +
    +

    How to create an archive and reset the user information using the filter +parameter in TarFile.add():

    +
    import tarfile
    +def reset(tarinfo):
    +    tarinfo.uid = tarinfo.gid = 0
    +    tarinfo.uname = tarinfo.gname = "root"
    +    return tarinfo
    +tar = tarfile.open("sample.tar.gz", "w:gz")
    +tar.add("foo", filter=reset)
    +tar.close()
    +
    +
    +
    +
    +

    Supported tar formats

    +

    There are three tar formats that can be created with the tarfile module:

    +
      +
    • The POSIX.1-1988 ustar format (USTAR_FORMAT). It supports filenames +up to a length of at best 256 characters and linknames up to 100 characters. The +maximum file size is 8 GiB. This is an old and limited but widely +supported format.

    • +
    • The GNU tar format (GNU_FORMAT). It supports long filenames and +linknames, files bigger than 8 GiB and sparse files. It is the de facto +standard on GNU/Linux systems. tarfile fully supports the GNU tar +extensions for long names, sparse file support is read-only.

    • +
    • The POSIX.1-2001 pax format (PAX_FORMAT). It is the most flexible +format with virtually no limits. It supports long filenames and linknames, large +files and stores pathnames in a portable way. However, not all tar +implementations today are able to handle pax archives properly.

      +

      The pax format is an extension to the existing ustar format. It uses extra +headers for information that cannot be stored otherwise. There are two flavours +of pax headers: Extended headers only affect the subsequent file header, global +headers are valid for the complete archive and affect all following files. All +the data in a pax header is encoded in UTF-8 for portability reasons.

      +
    • +
    +

    There are some more variants of the tar format which can be read, but not +created:

    +
      +
    • The ancient V7 format. This is the first tar format from Unix Seventh Edition, +storing only regular files and directories. Names must not be longer than 100 +characters, there is no user/group name information. Some archives have +miscalculated header checksums in case of fields with non-ASCII characters.

    • +
    • The SunOS tar extended format. This format is a variant of the POSIX.1-2001 +pax format, but is not compatible.

    • +
    +
    +
    +

    Unicode issues

    +

    The tar format was originally conceived to make backups on tape drives with the +main focus on preserving file system information. Nowadays tar archives are +commonly used for file distribution and exchanging archives over networks. One +problem of the original format (which is the basis of all other formats) is +that there is no concept of supporting different character encodings. For +example, an ordinary tar archive created on a UTF-8 system cannot be read +correctly on a Latin-1 system if it contains non-ASCII characters. Textual +metadata (like filenames, linknames, user/group names) will appear damaged. +Unfortunately, there is no way to autodetect the encoding of an archive. The +pax format was designed to solve this problem. It stores non-ASCII metadata +using the universal character encoding UTF-8.

    +

    The details of character conversion in tarfile are controlled by the +encoding and errors keyword arguments of the TarFile class.

    +

    encoding defines the character encoding to use for the metadata in the +archive. The default value is sys.getfilesystemencoding() or 'ascii' +as a fallback. Depending on whether the archive is read or written, the +metadata must be either decoded or encoded. If encoding is not set +appropriately, this conversion may fail.

    +

    The errors argument defines how characters are treated that cannot be +converted. Possible values are listed in section Error Handlers. +The default scheme is 'surrogateescape' which Python also uses for its +file system calls, see File Names, Command Line Arguments, and Environment Variables.

    +

    In case of PAX_FORMAT archives, encoding is generally not needed +because all the metadata is stored using UTF-8. encoding is only used in +the rare cases when binary pax headers are decoded or when strings with +surrogate characters are stored.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/telnetlib.html b/python-3.7.4-docs-html/library/telnetlib.html new file mode 100644 index 0000000..87d2c75 --- /dev/null +++ b/python-3.7.4-docs-html/library/telnetlib.html @@ -0,0 +1,430 @@ + + + + + + + telnetlib — Telnet client — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    telnetlib — Telnet client

    +

    Source code: Lib/telnetlib.py

    +
    +

    The telnetlib module provides a Telnet class that implements the +Telnet protocol. See RFC 854 for details about the protocol. In addition, it +provides symbolic constants for the protocol characters (see below), and for the +telnet options. The symbolic names of the telnet options follow the definitions +in arpa/telnet.h, with the leading TELOPT_ removed. For symbolic names +of options which are traditionally not included in arpa/telnet.h, see the +module source itself.

    +

    The symbolic constants for the telnet commands are: IAC, DONT, DO, WONT, WILL, +SE (Subnegotiation End), NOP (No Operation), DM (Data Mark), BRK (Break), IP +(Interrupt process), AO (Abort output), AYT (Are You There), EC (Erase +Character), EL (Erase Line), GA (Go Ahead), SB (Subnegotiation Begin).

    +
    +
    +class telnetlib.Telnet(host=None, port=0[, timeout])
    +

    Telnet represents a connection to a Telnet server. The instance is +initially not connected by default; the open() method must be used to +establish a connection. Alternatively, the host name and optional port +number can be passed to the constructor too, in which case the connection to +the server will be established before the constructor returns. The optional +timeout parameter specifies a timeout in seconds for blocking operations +like the connection attempt (if not specified, the global default timeout +setting will be used).

    +

    Do not reopen an already connected instance.

    +

    This class has many read_*() methods. Note that some of them raise +EOFError when the end of the connection is read, because they can return +an empty string for other reasons. See the individual descriptions below.

    +

    A Telnet object is a context manager and can be used in a +with statement. When the with block ends, the +close() method is called:

    +
    >>> from telnetlib import Telnet
    +>>> with Telnet('localhost', 23) as tn:
    +...     tn.interact()
    +...
    +
    +
    +
    +

    Changed in version 3.6: Context manager support added

    +
    +
    + +
    +

    See also

    +
    +
    RFC 854 - Telnet Protocol Specification

    Definition of the Telnet protocol.

    +
    +
    +
    +
    +

    Telnet Objects

    +

    Telnet instances have the following methods:

    +
    +
    +Telnet.read_until(expected, timeout=None)
    +

    Read until a given byte string, expected, is encountered or until timeout +seconds have passed.

    +

    When no match is found, return whatever is available instead, possibly empty +bytes. Raise EOFError if the connection is closed and no cooked data +is available.

    +
    + +
    +
    +Telnet.read_all()
    +

    Read all data until EOF as bytes; block until connection closed.

    +
    + +
    +
    +Telnet.read_some()
    +

    Read at least one byte of cooked data unless EOF is hit. Return b'' if +EOF is hit. Block if no data is immediately available.

    +
    + +
    +
    +Telnet.read_very_eager()
    +

    Read everything that can be without blocking in I/O (eager).

    +

    Raise EOFError if connection closed and no cooked data available. +Return b'' if no cooked data available otherwise. Do not block unless in +the midst of an IAC sequence.

    +
    + +
    +
    +Telnet.read_eager()
    +

    Read readily available data.

    +

    Raise EOFError if connection closed and no cooked data available. +Return b'' if no cooked data available otherwise. Do not block unless in +the midst of an IAC sequence.

    +
    + +
    +
    +Telnet.read_lazy()
    +

    Process and return data already in the queues (lazy).

    +

    Raise EOFError if connection closed and no data available. Return +b'' if no cooked data available otherwise. Do not block unless in the +midst of an IAC sequence.

    +
    + +
    +
    +Telnet.read_very_lazy()
    +

    Return any data available in the cooked queue (very lazy).

    +

    Raise EOFError if connection closed and no data available. Return +b'' if no cooked data available otherwise. This method never blocks.

    +
    + +
    +
    +Telnet.read_sb_data()
    +

    Return the data collected between a SB/SE pair (suboption begin/end). The +callback should access these data when it was invoked with a SE command. +This method never blocks.

    +
    + +
    +
    +Telnet.open(host, port=0[, timeout])
    +

    Connect to a host. The optional second argument is the port number, which +defaults to the standard Telnet port (23). The optional timeout parameter +specifies a timeout in seconds for blocking operations like the connection +attempt (if not specified, the global default timeout setting will be used).

    +

    Do not try to reopen an already connected instance.

    +
    + +
    +
    +Telnet.msg(msg, *args)
    +

    Print a debug message when the debug level is > 0. If extra arguments are +present, they are substituted in the message using the standard string +formatting operator.

    +
    + +
    +
    +Telnet.set_debuglevel(debuglevel)
    +

    Set the debug level. The higher the value of debuglevel, the more debug +output you get (on sys.stdout).

    +
    + +
    +
    +Telnet.close()
    +

    Close the connection.

    +
    + +
    +
    +Telnet.get_socket()
    +

    Return the socket object used internally.

    +
    + +
    +
    +Telnet.fileno()
    +

    Return the file descriptor of the socket object used internally.

    +
    + +
    +
    +Telnet.write(buffer)
    +

    Write a byte string to the socket, doubling any IAC characters. This can +block if the connection is blocked. May raise OSError if the +connection is closed.

    +
    +

    Changed in version 3.3: This method used to raise socket.error, which is now an alias +of OSError.

    +
    +
    + +
    +
    +Telnet.interact()
    +

    Interaction function, emulates a very dumb Telnet client.

    +
    + +
    +
    +Telnet.mt_interact()
    +

    Multithreaded version of interact().

    +
    + +
    +
    +Telnet.expect(list, timeout=None)
    +

    Read until one from a list of a regular expressions matches.

    +

    The first argument is a list of regular expressions, either compiled +(regex objects) or uncompiled (byte strings). The +optional second argument is a timeout, in seconds; the default is to block +indefinitely.

    +

    Return a tuple of three items: the index in the list of the first regular +expression that matches; the match object returned; and the bytes read up +till and including the match.

    +

    If end of file is found and no bytes were read, raise EOFError. +Otherwise, when nothing matches, return (-1, None, data) where data is +the bytes received so far (may be empty bytes if a timeout happened).

    +

    If a regular expression ends with a greedy match (such as .*) or if more +than one expression can match the same input, the results are +non-deterministic, and may depend on the I/O timing.

    +
    + +
    +
    +Telnet.set_option_negotiation_callback(callback)
    +

    Each time a telnet option is read on the input flow, this callback (if set) is +called with the following parameters: callback(telnet socket, command +(DO/DONT/WILL/WONT), option). No other action is done afterwards by telnetlib.

    +
    + +
    +
    +

    Telnet Example

    +

    A simple example illustrating typical use:

    +
    import getpass
    +import telnetlib
    +
    +HOST = "localhost"
    +user = input("Enter your remote account: ")
    +password = getpass.getpass()
    +
    +tn = telnetlib.Telnet(HOST)
    +
    +tn.read_until(b"login: ")
    +tn.write(user.encode('ascii') + b"\n")
    +if password:
    +    tn.read_until(b"Password: ")
    +    tn.write(password.encode('ascii') + b"\n")
    +
    +tn.write(b"ls\n")
    +tn.write(b"exit\n")
    +
    +print(tn.read_all().decode('ascii'))
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/tempfile.html b/python-3.7.4-docs-html/library/tempfile.html new file mode 100644 index 0000000..20433fc --- /dev/null +++ b/python-3.7.4-docs-html/library/tempfile.html @@ -0,0 +1,501 @@ + + + + + + + tempfile — Generate temporary files and directories — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    tempfile — Generate temporary files and directories

    +

    Source code: Lib/tempfile.py

    +
    +

    This module creates temporary files and directories. It works on all +supported platforms. TemporaryFile, NamedTemporaryFile, +TemporaryDirectory, and SpooledTemporaryFile are high-level +interfaces which provide automatic cleanup and can be used as +context managers. mkstemp() and +mkdtemp() are lower-level functions which require manual cleanup.

    +

    All the user-callable functions and constructors take additional arguments which +allow direct control over the location and name of temporary files and +directories. Files names used by this module include a string of +random characters which allows those files to be securely created in +shared temporary directories. +To maintain backward compatibility, the argument order is somewhat odd; it +is recommended to use keyword arguments for clarity.

    +

    The module defines the following user-callable items:

    +
    +
    +tempfile.TemporaryFile(mode='w+b', buffering=None, encoding=None, newline=None, suffix=None, prefix=None, dir=None)
    +

    Return a file-like object that can be used as a temporary storage area. +The file is created securely, using the same rules as mkstemp(). It will be destroyed as soon +as it is closed (including an implicit close when the object is garbage +collected). Under Unix, the directory entry for the file is either not created at all or is removed +immediately after the file is created. Other platforms do not support +this; your code should not rely on a temporary file created using this +function having or not having a visible name in the file system.

    +

    The resulting object can be used as a context manager (see +Examples). On completion of the context or +destruction of the file object the temporary file will be removed +from the filesystem.

    +

    The mode parameter defaults to 'w+b' so that the file created can +be read and written without being closed. Binary mode is used so that it +behaves consistently on all platforms without regard for the data that is +stored. buffering, encoding and newline are interpreted as for +open().

    +

    The dir, prefix and suffix parameters have the same meaning and +defaults as with mkstemp().

    +

    The returned object is a true file object on POSIX platforms. On other +platforms, it is a file-like object whose file attribute is the +underlying true file object.

    +

    The os.O_TMPFILE flag is used if it is available and works +(Linux-specific, requires Linux kernel 3.11 or later).

    +
    +

    Changed in version 3.5: The os.O_TMPFILE flag is now used if available.

    +
    +
    + +
    +
    +tempfile.NamedTemporaryFile(mode='w+b', buffering=None, encoding=None, newline=None, suffix=None, prefix=None, dir=None, delete=True)
    +

    This function operates exactly as TemporaryFile() does, except that +the file is guaranteed to have a visible name in the file system (on +Unix, the directory entry is not unlinked). That name can be retrieved +from the name attribute of the returned +file-like object. Whether the name can be +used to open the file a second time, while the named temporary file is +still open, varies across platforms (it can be so used on Unix; it cannot +on Windows NT or later). If delete is true (the default), the file is +deleted as soon as it is closed. +The returned object is always a file-like object whose file +attribute is the underlying true file object. This file-like object can +be used in a with statement, just like a normal file.

    +
    + +
    +
    +tempfile.SpooledTemporaryFile(max_size=0, mode='w+b', buffering=None, encoding=None, newline=None, suffix=None, prefix=None, dir=None)
    +

    This function operates exactly as TemporaryFile() does, except that +data is spooled in memory until the file size exceeds max_size, or +until the file’s fileno() method is called, at which point the +contents are written to disk and operation proceeds as with +TemporaryFile().

    +

    The resulting file has one additional method, rollover(), which +causes the file to roll over to an on-disk file regardless of its size.

    +

    The returned object is a file-like object whose _file attribute +is either an io.BytesIO or io.StringIO object (depending on +whether binary or text mode was specified) or a true file +object, depending on whether rollover() has been called. This +file-like object can be used in a with statement, just like +a normal file.

    +
    +

    Changed in version 3.3: the truncate method now accepts a size argument.

    +
    +
    + +
    +
    +tempfile.TemporaryDirectory(suffix=None, prefix=None, dir=None)
    +

    This function securely creates a temporary directory using the same rules as mkdtemp(). +The resulting object can be used as a context manager (see +Examples). On completion of the context or destruction +of the temporary directory object the newly created temporary directory +and all its contents are removed from the filesystem.

    +

    The directory name can be retrieved from the name attribute of the +returned object. When the returned object is used as a context manager, the +name will be assigned to the target of the as clause in +the with statement, if there is one.

    +

    The directory can be explicitly cleaned up by calling the +cleanup() method.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +tempfile.mkstemp(suffix=None, prefix=None, dir=None, text=False)
    +

    Creates a temporary file in the most secure manner possible. There are +no race conditions in the file’s creation, assuming that the platform +properly implements the os.O_EXCL flag for os.open(). The +file is readable and writable only by the creating user ID. If the +platform uses permission bits to indicate whether a file is executable, +the file is executable by no one. The file descriptor is not inherited +by child processes.

    +

    Unlike TemporaryFile(), the user of mkstemp() is responsible +for deleting the temporary file when done with it.

    +

    If suffix is not None, the file name will end with that suffix, +otherwise there will be no suffix. mkstemp() does not put a dot +between the file name and the suffix; if you need one, put it at the +beginning of suffix.

    +

    If prefix is not None, the file name will begin with that prefix; +otherwise, a default prefix is used. The default is the return value of +gettempprefix() or gettempprefixb(), as appropriate.

    +

    If dir is not None, the file will be created in that directory; +otherwise, a default directory is used. The default directory is chosen +from a platform-dependent list, but the user of the application can +control the directory location by setting the TMPDIR, TEMP or TMP +environment variables. There is thus no guarantee that the generated +filename will have any nice properties, such as not requiring quoting +when passed to external commands via os.popen().

    +

    If any of suffix, prefix, and dir are not +None, they must be the same type. +If they are bytes, the returned name will be bytes instead of str. +If you want to force a bytes return value with otherwise default behavior, +pass suffix=b''.

    +

    If text is specified, it indicates whether to open the file in binary +mode (the default) or text mode. On some platforms, this makes no +difference.

    +

    mkstemp() returns a tuple containing an OS-level handle to an open +file (as would be returned by os.open()) and the absolute pathname +of that file, in that order.

    +
    +

    Changed in version 3.5: suffix, prefix, and dir may now be supplied in bytes in order to +obtain a bytes return value. Prior to this, only str was allowed. +suffix and prefix now accept and default to None to cause +an appropriate default value to be used.

    +
    +
    + +
    +
    +tempfile.mkdtemp(suffix=None, prefix=None, dir=None)
    +

    Creates a temporary directory in the most secure manner possible. There +are no race conditions in the directory’s creation. The directory is +readable, writable, and searchable only by the creating user ID.

    +

    The user of mkdtemp() is responsible for deleting the temporary +directory and its contents when done with it.

    +

    The prefix, suffix, and dir arguments are the same as for +mkstemp().

    +

    mkdtemp() returns the absolute pathname of the new directory.

    +
    +

    Changed in version 3.5: suffix, prefix, and dir may now be supplied in bytes in order to +obtain a bytes return value. Prior to this, only str was allowed. +suffix and prefix now accept and default to None to cause +an appropriate default value to be used.

    +
    +
    + +
    +
    +tempfile.gettempdir()
    +

    Return the name of the directory used for temporary files. This +defines the default value for the dir argument to all functions +in this module.

    +

    Python searches a standard list of directories to find one which +the calling user can create files in. The list is:

    +
      +
    1. The directory named by the TMPDIR environment variable.

    2. +
    3. The directory named by the TEMP environment variable.

    4. +
    5. The directory named by the TMP environment variable.

    6. +
    7. A platform-specific location:

      +
        +
      • On Windows, the directories C:\TEMP, C:\TMP, +\TEMP, and \TMP, in that order.

      • +
      • On all other platforms, the directories /tmp, /var/tmp, and +/usr/tmp, in that order.

      • +
      +
    8. +
    9. As a last resort, the current working directory.

    10. +
    +

    The result of this search is cached, see the description of +tempdir below.

    +
    + +
    +
    +tempfile.gettempdirb()
    +

    Same as gettempdir() but the return value is in bytes.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +tempfile.gettempprefix()
    +

    Return the filename prefix used to create temporary files. This does not +contain the directory component.

    +
    + +
    +
    +tempfile.gettempprefixb()
    +

    Same as gettempprefix() but the return value is in bytes.

    +
    +

    New in version 3.5.

    +
    +
    + +

    The module uses a global variable to store the name of the directory +used for temporary files returned by gettempdir(). It can be +set directly to override the selection process, but this is discouraged. +All functions in this module take a dir argument which can be used +to specify the directory and this is the recommended approach.

    +
    +
    +tempfile.tempdir
    +

    When set to a value other than None, this variable defines the +default value for the dir argument to the functions defined in this +module.

    +

    If tempdir is None (the default) at any call to any of the above +functions except gettempprefix() it is initialized following the +algorithm described in gettempdir().

    +
    + +
    +

    Examples

    +

    Here are some examples of typical usage of the tempfile module:

    +
    >>> import tempfile
    +
    +# create a temporary file and write some data to it
    +>>> fp = tempfile.TemporaryFile()
    +>>> fp.write(b'Hello world!')
    +# read data from file
    +>>> fp.seek(0)
    +>>> fp.read()
    +b'Hello world!'
    +# close the file, it will be removed
    +>>> fp.close()
    +
    +# create a temporary file using a context manager
    +>>> with tempfile.TemporaryFile() as fp:
    +...     fp.write(b'Hello world!')
    +...     fp.seek(0)
    +...     fp.read()
    +b'Hello world!'
    +>>>
    +# file is now closed and removed
    +
    +# create a temporary directory using the context manager
    +>>> with tempfile.TemporaryDirectory() as tmpdirname:
    +...     print('created temporary directory', tmpdirname)
    +>>>
    +# directory and contents have been removed
    +
    +
    +
    +
    +

    Deprecated functions and variables

    +

    A historical way to create temporary files was to first generate a +file name with the mktemp() function and then create a file +using this name. Unfortunately this is not secure, because a different +process may create a file with this name in the time between the call +to mktemp() and the subsequent attempt to create the file by the +first process. The solution is to combine the two steps and create the +file immediately. This approach is used by mkstemp() and the +other functions described above.

    +
    +
    +tempfile.mktemp(suffix='', prefix='tmp', dir=None)
    +
    +

    Deprecated since version 2.3: Use mkstemp() instead.

    +
    +

    Return an absolute pathname of a file that did not exist at the time the +call is made. The prefix, suffix, and dir arguments are similar +to those of mkstemp(), except that bytes file names, suffix=None +and prefix=None are not supported.

    +
    +

    Warning

    +

    Use of this function may introduce a security hole in your program. By +the time you get around to doing anything with the file name it returns, +someone else may have beaten you to the punch. mktemp() usage can +be replaced easily with NamedTemporaryFile(), passing it the +delete=False parameter:

    +
    >>> f = NamedTemporaryFile(delete=False)
    +>>> f.name
    +'/tmp/tmptjujjt'
    +>>> f.write(b"Hello World!\n")
    +13
    +>>> f.close()
    +>>> os.unlink(f.name)
    +>>> os.path.exists(f.name)
    +False
    +
    +
    +
    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/termios.html b/python-3.7.4-docs-html/library/termios.html new file mode 100644 index 0000000..57a9096 --- /dev/null +++ b/python-3.7.4-docs-html/library/termios.html @@ -0,0 +1,284 @@ + + + + + + + termios — POSIX style tty control — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    termios — POSIX style tty control

    +
    +

    This module provides an interface to the POSIX calls for tty I/O control. For a +complete description of these calls, see termios(3) Unix manual +page. It is only available for those Unix versions that support POSIX +termios style tty I/O control configured during installation.

    +

    All functions in this module take a file descriptor fd as their first +argument. This can be an integer file descriptor, such as returned by +sys.stdin.fileno(), or a file object, such as sys.stdin itself.

    +

    This module also defines all the constants needed to work with the functions +provided here; these have the same name as their counterparts in C. Please +refer to your system documentation for more information on using these terminal +control interfaces.

    +

    The module defines the following functions:

    +
    +
    +termios.tcgetattr(fd)
    +

    Return a list containing the tty attributes for file descriptor fd, as +follows: [iflag, oflag, cflag, lflag, ispeed, ospeed, cc] where cc is a +list of the tty special characters (each a string of length 1, except the +items with indices VMIN and VTIME, which are integers when +these fields are defined). The interpretation of the flags and the speeds as +well as the indexing in the cc array must be done using the symbolic +constants defined in the termios module.

    +
    + +
    +
    +termios.tcsetattr(fd, when, attributes)
    +

    Set the tty attributes for file descriptor fd from the attributes, which is +a list like the one returned by tcgetattr(). The when argument +determines when the attributes are changed: TCSANOW to change +immediately, TCSADRAIN to change after transmitting all queued output, +or TCSAFLUSH to change after transmitting all queued output and +discarding all queued input.

    +
    + +
    +
    +termios.tcsendbreak(fd, duration)
    +

    Send a break on file descriptor fd. A zero duration sends a break for +0.25–0.5 seconds; a nonzero duration has a system dependent meaning.

    +
    + +
    +
    +termios.tcdrain(fd)
    +

    Wait until all output written to file descriptor fd has been transmitted.

    +
    + +
    +
    +termios.tcflush(fd, queue)
    +

    Discard queued data on file descriptor fd. The queue selector specifies +which queue: TCIFLUSH for the input queue, TCOFLUSH for the +output queue, or TCIOFLUSH for both queues.

    +
    + +
    +
    +termios.tcflow(fd, action)
    +

    Suspend or resume input or output on file descriptor fd. The action +argument can be TCOOFF to suspend output, TCOON to restart +output, TCIOFF to suspend input, or TCION to restart input.

    +
    + +
    +

    See also

    +
    +
    Module tty

    Convenience functions for common terminal control operations.

    +
    +
    +
    +
    +

    Example

    +

    Here’s a function that prompts for a password with echoing turned off. Note the +technique using a separate tcgetattr() call and a try … +finally statement to ensure that the old tty attributes are restored +exactly no matter what happens:

    +
    def getpass(prompt="Password: "):
    +    import termios, sys
    +    fd = sys.stdin.fileno()
    +    old = termios.tcgetattr(fd)
    +    new = termios.tcgetattr(fd)
    +    new[3] = new[3] & ~termios.ECHO          # lflags
    +    try:
    +        termios.tcsetattr(fd, termios.TCSADRAIN, new)
    +        passwd = input(prompt)
    +    finally:
    +        termios.tcsetattr(fd, termios.TCSADRAIN, old)
    +    return passwd
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/test.html b/python-3.7.4-docs-html/library/test.html new file mode 100644 index 0000000..6faae97 --- /dev/null +++ b/python-3.7.4-docs-html/library/test.html @@ -0,0 +1,1673 @@ + + + + + + + test — Regression tests package for Python — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    test — Regression tests package for Python

    +
    +

    Note

    +

    The test package is meant for internal use by Python only. It is +documented for the benefit of the core developers of Python. Any use of +this package outside of Python’s standard library is discouraged as code +mentioned here can change or be removed without notice between releases of +Python.

    +
    +
    +

    The test package contains all regression tests for Python as well as the +modules test.support and test.regrtest. +test.support is used to enhance your tests while +test.regrtest drives the testing suite.

    +

    Each module in the test package whose name starts with test_ is a +testing suite for a specific module or feature. All new tests should be written +using the unittest or doctest module. Some older tests are +written using a “traditional” testing style that compares output printed to +sys.stdout; this style of test is considered deprecated.

    +
    +

    See also

    +
    +
    Module unittest

    Writing PyUnit regression tests.

    +
    +
    Module doctest

    Tests embedded in documentation strings.

    +
    +
    +
    +
    +

    Writing Unit Tests for the test package

    +

    It is preferred that tests that use the unittest module follow a few +guidelines. One is to name the test module by starting it with test_ and end +it with the name of the module being tested. The test methods in the test module +should start with test_ and end with a description of what the method is +testing. This is needed so that the methods are recognized by the test driver as +test methods. Also, no documentation string for the method should be included. A +comment (such as # Tests function returns only True or False) should be used +to provide documentation for test methods. This is done because documentation +strings get printed out if they exist and thus what test is being run is not +stated.

    +

    A basic boilerplate is often used:

    +
    import unittest
    +from test import support
    +
    +class MyTestCase1(unittest.TestCase):
    +
    +    # Only use setUp() and tearDown() if necessary
    +
    +    def setUp(self):
    +        ... code to execute in preparation for tests ...
    +
    +    def tearDown(self):
    +        ... code to execute to clean up after tests ...
    +
    +    def test_feature_one(self):
    +        # Test feature one.
    +        ... testing code ...
    +
    +    def test_feature_two(self):
    +        # Test feature two.
    +        ... testing code ...
    +
    +    ... more test methods ...
    +
    +class MyTestCase2(unittest.TestCase):
    +    ... same structure as MyTestCase1 ...
    +
    +... more test classes ...
    +
    +if __name__ == '__main__':
    +    unittest.main()
    +
    +
    +

    This code pattern allows the testing suite to be run by test.regrtest, +on its own as a script that supports the unittest CLI, or via the +python -m unittest CLI.

    +

    The goal for regression testing is to try to break code. This leads to a few +guidelines to be followed:

    +
      +
    • The testing suite should exercise all classes, functions, and constants. This +includes not just the external API that is to be presented to the outside +world but also “private” code.

    • +
    • Whitebox testing (examining the code being tested when the tests are being +written) is preferred. Blackbox testing (testing only the published user +interface) is not complete enough to make sure all boundary and edge cases +are tested.

    • +
    • Make sure all possible values are tested including invalid ones. This makes +sure that not only all valid values are acceptable but also that improper +values are handled correctly.

    • +
    • Exhaust as many code paths as possible. Test where branching occurs and thus +tailor input to make sure as many different paths through the code are taken.

    • +
    • Add an explicit test for any bugs discovered for the tested code. This will +make sure that the error does not crop up again if the code is changed in the +future.

    • +
    • Make sure to clean up after your tests (such as close and remove all temporary +files).

    • +
    • If a test is dependent on a specific condition of the operating system then +verify the condition already exists before attempting the test.

    • +
    • Import as few modules as possible and do it as soon as possible. This +minimizes external dependencies of tests and also minimizes possible anomalous +behavior from side-effects of importing a module.

    • +
    • Try to maximize code reuse. On occasion, tests will vary by something as small +as what type of input is used. Minimize code duplication by subclassing a +basic test class with a class that specifies the input:

      +
      class TestFuncAcceptsSequencesMixin:
      +
      +    func = mySuperWhammyFunction
      +
      +    def test_func(self):
      +        self.func(self.arg)
      +
      +class AcceptLists(TestFuncAcceptsSequencesMixin, unittest.TestCase):
      +    arg = [1, 2, 3]
      +
      +class AcceptStrings(TestFuncAcceptsSequencesMixin, unittest.TestCase):
      +    arg = 'abc'
      +
      +class AcceptTuples(TestFuncAcceptsSequencesMixin, unittest.TestCase):
      +    arg = (1, 2, 3)
      +
      +
      +

      When using this pattern, remember that all classes that inherit from +unittest.TestCase are run as tests. The Mixin class in the example above +does not have any data and so can’t be run by itself, thus it does not +inherit from unittest.TestCase.

      +
    • +
    +
    +

    See also

    +
    +
    Test Driven Development

    A book by Kent Beck on writing tests before code.

    +
    +
    +
    +
    +
    +

    Running tests using the command-line interface

    +

    The test package can be run as a script to drive Python’s regression +test suite, thanks to the -m option: python -m test. Under +the hood, it uses test.regrtest; the call python -m +test.regrtest used in previous Python versions still works. Running the +script by itself automatically starts running all regression tests in the +test package. It does this by finding all modules in the package whose +name starts with test_, importing them, and executing the function +test_main() if present or loading the tests via +unittest.TestLoader.loadTestsFromModule if test_main does not exist. The +names of tests to execute may also be passed to the script. Specifying a single +regression test (python -m test test_spam) will minimize output and +only print whether the test passed or failed.

    +

    Running test directly allows what resources are available for +tests to use to be set. You do this by using the -u command-line +option. Specifying all as the value for the -u option enables all +possible resources: python -m test -uall. +If all but one resource is desired (a more common case), a +comma-separated list of resources that are not desired may be listed after +all. The command python -m test -uall,-audio,-largefile +will run test with all resources except the audio and +largefile resources. For a list of all resources and more command-line +options, run python -m test -h.

    +

    Some other ways to execute the regression tests depend on what platform the +tests are being executed on. On Unix, you can run make test at the +top-level directory where Python was built. On Windows, +executing rt.bat from your PCbuild directory will run all +regression tests.

    +
    +
    +
    +

    test.support — Utilities for the Python test suite

    +

    The test.support module provides support for Python’s regression +test suite.

    +
    +

    Note

    +

    test.support is not a public module. It is documented here to help +Python developers write tests. The API of this module is subject to change +without backwards compatibility concerns between releases.

    +
    +

    This module defines the following exceptions:

    +
    +
    +exception test.support.TestFailed
    +

    Exception to be raised when a test fails. This is deprecated in favor of +unittest-based tests and unittest.TestCase’s assertion +methods.

    +
    + +
    +
    +exception test.support.ResourceDenied
    +

    Subclass of unittest.SkipTest. Raised when a resource (such as a +network connection) is not available. Raised by the requires() +function.

    +
    + +

    The test.support module defines the following constants:

    +
    +
    +test.support.verbose
    +

    True when verbose output is enabled. Should be checked when more +detailed information is desired about a running test. verbose is set by +test.regrtest.

    +
    + +
    +
    +test.support.is_jython
    +

    True if the running interpreter is Jython.

    +
    + +
    +
    +test.support.is_android
    +

    True if the system is Android.

    +
    + +
    +
    +test.support.unix_shell
    +

    Path for shell if not on Windows; otherwise None.

    +
    + +
    +
    +test.support.FS_NONASCII
    +

    A non-ASCII character encodable by os.fsencode().

    +
    + +
    +
    +test.support.TESTFN
    +

    Set to a name that is safe to use as the name of a temporary file. Any +temporary file that is created should be closed and unlinked (removed).

    +
    + +
    +
    +test.support.TESTFN_UNICODE
    +

    Set to a non-ASCII name for a temporary file.

    +
    + +
    +
    +test.support.TESTFN_ENCODING
    +

    Set to sys.getfilesystemencoding().

    +
    + +
    +
    +test.support.TESTFN_UNENCODABLE
    +

    Set to a filename (str type) that should not be able to be encoded by file +system encoding in strict mode. It may be None if it’s not possible to +generate such a filename.

    +
    + +
    +
    +test.support.TESTFN_UNDECODABLE
    +

    Set to a filename (bytes type) that should not be able to be decoded by +file system encoding in strict mode. It may be None if it’s not +possible to generate such a filename.

    +
    + +
    +
    +test.support.TESTFN_NONASCII
    +

    Set to a filename containing the FS_NONASCII character.

    +
    + +
    +
    +test.support.IPV6_ENABLED
    +

    Set to True if IPV6 is enabled on this host, False otherwise.

    +
    + +
    +
    +test.support.SAVEDCWD
    +

    Set to os.getcwd().

    +
    + +
    +
    +test.support.PGO
    +

    Set when tests can be skipped when they are not useful for PGO.

    +
    + +
    +
    +test.support.PIPE_MAX_SIZE
    +

    A constant that is likely larger than the underlying OS pipe buffer size, +to make writes blocking.

    +
    + +
    +
    +test.support.SOCK_MAX_SIZE
    +

    A constant that is likely larger than the underlying OS socket buffer size, +to make writes blocking.

    +
    + +
    +
    +test.support.TEST_SUPPORT_DIR
    +

    Set to the top level directory that contains test.support.

    +
    + +
    +
    +test.support.TEST_HOME_DIR
    +

    Set to the top level directory for the test package.

    +
    + +
    +
    +test.support.TEST_DATA_DIR
    +

    Set to the data directory within the test package.

    +
    + +
    +
    +test.support.MAX_Py_ssize_t
    +

    Set to sys.maxsize for big memory tests.

    +
    + +
    +
    +test.support.max_memuse
    +

    Set by set_memlimit() as the memory limit for big memory tests. +Limited by MAX_Py_ssize_t.

    +
    + +
    +
    +test.support.real_max_memuse
    +

    Set by set_memlimit() as the memory limit for big memory tests. Not +limited by MAX_Py_ssize_t.

    +
    + +
    +
    +test.support.MISSING_C_DOCSTRINGS
    +

    Return True if running on CPython, not on Windows, and configuration +not set with WITH_DOC_STRINGS.

    +
    + +
    +
    +test.support.HAVE_DOCSTRINGS
    +

    Check for presence of docstrings.

    +
    + +
    +
    +test.support.TEST_HTTP_URL
    +

    Define the URL of a dedicated HTTP server for the network tests.

    +
    + +

    The test.support module defines the following functions:

    +
    +
    +test.support.forget(module_name)
    +

    Remove the module named module_name from sys.modules and delete any +byte-compiled files of the module.

    +
    + +
    +
    +test.support.unload(name)
    +

    Delete name from sys.modules.

    +
    + +
    + +

    Call os.unlink() on filename. On Windows platforms, this is +wrapped with a wait loop that checks for the existence fo the file.

    +
    + +
    +
    +test.support.rmdir(filename)
    +

    Call os.rmdir() on filename. On Windows platforms, this is +wrapped with a wait loop that checks for the existence of the file.

    +
    + +
    +
    +test.support.rmtree(path)
    +

    Call shutil.rmtree() on path or call os.lstat() and +os.rmdir() to remove a path and its contents. On Windows platforms, +this is wrapped with a wait loop that checks for the existence of the files.

    +
    + +
    +
    +test.support.make_legacy_pyc(source)
    +

    Move a PEP 3147/488 pyc file to its legacy pyc location and return the file +system path to the legacy pyc file. The source value is the file system +path to the source file. It does not need to exist, however the PEP +3147/488 pyc file must exist.

    +
    + +
    +
    +test.support.is_resource_enabled(resource)
    +

    Return True if resource is enabled and available. The list of +available resources is only set when test.regrtest is executing the +tests.

    +
    + +
    +
    +test.support.python_is_optimized()
    +

    Return True if Python was not built with -O0 or -Og.

    +
    + +
    +
    +test.support.with_pymalloc()
    +

    Return _testcapi.WITH_PYMALLOC.

    +
    + +
    +
    +test.support.requires(resource, msg=None)
    +

    Raise ResourceDenied if resource is not available. msg is the +argument to ResourceDenied if it is raised. Always returns +True if called by a function whose __name__ is '__main__'. +Used when tests are executed by test.regrtest.

    +
    + +
    +
    +test.support.system_must_validate_cert(f)
    +

    Raise unittest.SkipTest on TLS certification validation failures.

    +
    + +
    +
    +test.support.sortdict(dict)
    +

    Return a repr of dict with keys sorted.

    +
    + +
    +
    +test.support.findfile(filename, subdir=None)
    +

    Return the path to the file named filename. If no match is found +filename is returned. This does not equal a failure since it could be the +path to the file.

    +

    Setting subdir indicates a relative path to use to find the file +rather than looking directly in the path directories.

    +
    + +
    +
    +test.support.create_empty_file(filename)
    +

    Create an empty file with filename. If it already exists, truncate it.

    +
    + +
    +
    +test.support.fd_count()
    +

    Count the number of open file descriptors.

    +
    + +
    +
    +test.support.match_test(test)
    +

    Match test to patterns set in set_match_tests().

    +
    + +
    +
    +test.support.set_match_tests(patterns)
    +

    Define match test with regular expression patterns.

    +
    + +
    +
    +test.support.run_unittest(*classes)
    +

    Execute unittest.TestCase subclasses passed to the function. The +function scans the classes for methods starting with the prefix test_ +and executes the tests individually.

    +

    It is also legal to pass strings as parameters; these should be keys in +sys.modules. Each associated module will be scanned by +unittest.TestLoader.loadTestsFromModule(). This is usually seen in the +following test_main() function:

    +
    def test_main():
    +    support.run_unittest(__name__)
    +
    +
    +

    This will run all tests defined in the named module.

    +
    + +
    +
    +test.support.run_doctest(module, verbosity=None, optionflags=0)
    +

    Run doctest.testmod() on the given module. Return +(failure_count, test_count).

    +

    If verbosity is None, doctest.testmod() is run with verbosity +set to verbose. Otherwise, it is run with verbosity set to +None. optionflags is passed as optionflags to +doctest.testmod().

    +
    + +
    +
    +test.support.setswitchinterval(interval)
    +

    Set the sys.setswitchinterval() to the given interval. Defines +a minimum interval for Android systems to prevent the system from hanging.

    +
    + +
    +
    +test.support.check_impl_detail(**guards)
    +

    Use this check to guard CPython’s implementation-specific tests or to +run them only on the implementations guarded by the arguments:

    +
    check_impl_detail()               # Only on CPython (default).
    +check_impl_detail(jython=True)    # Only on Jython.
    +check_impl_detail(cpython=False)  # Everywhere except CPython.
    +
    +
    +
    + +
    +
    +test.support.check_warnings(*filters, quiet=True)
    +

    A convenience wrapper for warnings.catch_warnings() that makes it +easier to test that a warning was correctly raised. It is approximately +equivalent to calling warnings.catch_warnings(record=True) with +warnings.simplefilter() set to always and with the option to +automatically validate the results that are recorded.

    +

    check_warnings accepts 2-tuples of the form ("message regexp", +WarningCategory) as positional arguments. If one or more filters are +provided, or if the optional keyword argument quiet is False, +it checks to make sure the warnings are as expected: each specified filter +must match at least one of the warnings raised by the enclosed code or the +test fails, and if any warnings are raised that do not match any of the +specified filters the test fails. To disable the first of these checks, +set quiet to True.

    +

    If no arguments are specified, it defaults to:

    +
    check_warnings(("", Warning), quiet=True)
    +
    +
    +

    In this case all warnings are caught and no errors are raised.

    +

    On entry to the context manager, a WarningRecorder instance is +returned. The underlying warnings list from +catch_warnings() is available via the recorder object’s +warnings attribute. As a convenience, the attributes of the object +representing the most recent warning can also be accessed directly through +the recorder object (see example below). If no warning has been raised, +then any of the attributes that would otherwise be expected on an object +representing a warning will return None.

    +

    The recorder object also has a reset() method, which clears the +warnings list.

    +

    The context manager is designed to be used like this:

    +
    with check_warnings(("assertion is always true", SyntaxWarning),
    +                    ("", UserWarning)):
    +    exec('assert(False, "Hey!")')
    +    warnings.warn(UserWarning("Hide me!"))
    +
    +
    +

    In this case if either warning was not raised, or some other warning was +raised, check_warnings() would raise an error.

    +

    When a test needs to look more deeply into the warnings, rather than +just checking whether or not they occurred, code like this can be used:

    +
    with check_warnings(quiet=True) as w:
    +    warnings.warn("foo")
    +    assert str(w.args[0]) == "foo"
    +    warnings.warn("bar")
    +    assert str(w.args[0]) == "bar"
    +    assert str(w.warnings[0].args[0]) == "foo"
    +    assert str(w.warnings[1].args[0]) == "bar"
    +    w.reset()
    +    assert len(w.warnings) == 0
    +
    +
    +

    Here all warnings will be caught, and the test code tests the captured +warnings directly.

    +
    +

    Changed in version 3.2: New optional arguments filters and quiet.

    +
    +
    + +
    +
    +test.support.check_no_resource_warning(testcase)
    +

    Context manager to check that no ResourceWarning was raised. You +must remove the object which may emit ResourceWarning before the +end of the context manager.

    +
    + +
    +
    +test.support.set_memlimit(limit)
    +

    Set the values for max_memuse and real_max_memuse for big +memory tests.

    +
    + +
    +
    +test.support.record_original_stdout(stdout)
    +

    Store the value from stdout. It is meant to hold the stdout at the +time the regrtest began.

    +
    + +
    +
    +test.support.get_original_stdout()
    +

    Return the original stdout set by record_original_stdout() or +sys.stdout if it’s not set.

    +
    + +
    +
    +test.support.strip_python_strerr(stderr)
    +

    Strip the stderr of a Python process from potential debug output +emitted by the interpreter. This will typically be run on the result of +subprocess.Popen.communicate().

    +
    + +
    +
    +test.support.args_from_interpreter_flags()
    +

    Return a list of command line arguments reproducing the current settings +in sys.flags and sys.warnoptions.

    +
    + +
    +
    +test.support.optim_args_from_interpreter_flags()
    +

    Return a list of command line arguments reproducing the current +optimization settings in sys.flags.

    +
    + +
    +
    +test.support.captured_stdin()
    +
    +test.support.captured_stdout()
    +
    +test.support.captured_stderr()
    +

    A context managers that temporarily replaces the named stream with +io.StringIO object.

    +

    Example use with output streams:

    +
    with captured_stdout() as stdout, captured_stderr() as stderr:
    +    print("hello")
    +    print("error", file=sys.stderr)
    +assert stdout.getvalue() == "hello\n"
    +assert stderr.getvalue() == "error\n"
    +
    +
    +

    Example use with input stream:

    +
    with captured_stdin() as stdin:
    +    stdin.write('hello\n')
    +    stdin.seek(0)
    +    # call test code that consumes from sys.stdin
    +    captured = input()
    +self.assertEqual(captured, "hello")
    +
    +
    +
    + +
    +
    +test.support.temp_dir(path=None, quiet=False)
    +

    A context manager that creates a temporary directory at path and +yields the directory.

    +

    If path is None, the temporary directory is created using +tempfile.mkdtemp(). If quiet is False, the context manager +raises an exception on error. Otherwise, if path is specified and +cannot be created, only a warning is issued.

    +
    + +
    +
    +test.support.change_cwd(path, quiet=False)
    +

    A context manager that temporarily changes the current working +directory to path and yields the directory.

    +

    If quiet is False, the context manager raises an exception +on error. Otherwise, it issues only a warning and keeps the current +working directory the same.

    +
    + +
    +
    +test.support.temp_cwd(name='tempcwd', quiet=False)
    +

    A context manager that temporarily creates a new directory and +changes the current working directory (CWD).

    +

    The context manager creates a temporary directory in the current +directory with name name before temporarily changing the current +working directory. If name is None, the temporary directory is +created using tempfile.mkdtemp().

    +

    If quiet is False and it is not possible to create or change +the CWD, an error is raised. Otherwise, only a warning is raised +and the original CWD is used.

    +
    + +
    +
    +test.support.temp_umask(umask)
    +

    A context manager that temporarily sets the process umask.

    +
    + +
    +
    +test.support.transient_internet(resource_name, *, timeout=30.0, errnos=())
    +

    A context manager that raises ResourceDenied when various issues +with the internet connection manifest themselves as exceptions.

    +
    + +
    +
    +test.support.disable_faulthandler()
    +

    A context manager that replaces sys.stderr with sys.__stderr__.

    +
    + +
    +
    +test.support.gc_collect()
    +

    Force as many objects as possible to be collected. This is needed because +timely deallocation is not guaranteed by the garbage collector. This means +that __del__ methods may be called later than expected and weakrefs +may remain alive for longer than expected.

    +
    + +
    +
    +test.support.disable_gc()
    +

    A context manager that disables the garbage collector upon entry and +reenables it upon exit.

    +
    + +
    +
    +test.support.swap_attr(obj, attr, new_val)
    +

    Context manager to swap out an attribute with a new object.

    +

    Usage:

    +
    with swap_attr(obj, "attr", 5):
    +    ...
    +
    +
    +

    This will set obj.attr to 5 for the duration of the with block, +restoring the old value at the end of the block. If attr doesn’t +exist on obj, it will be created and then deleted at the end of the +block.

    +

    The old value (or None if it doesn’t exist) will be assigned to the +target of the “as” clause, if there is one.

    +
    + +
    +
    +test.support.swap_item(obj, attr, new_val)
    +

    Context manager to swap out an item with a new object.

    +

    Usage:

    +
    with swap_item(obj, "item", 5):
    +    ...
    +
    +
    +

    This will set obj["item"] to 5 for the duration of the with block, +restoring the old value at the end of the block. If item doesn’t +exist on obj, it will be created and then deleted at the end of the +block.

    +

    The old value (or None if it doesn’t exist) will be assigned to the +target of the “as” clause, if there is one.

    +
    + +
    +
    +test.support.wait_threads_exit(timeout=60.0)
    +

    Context manager to wait until all threads created in the with statement +exit.

    +
    + +
    +
    +test.support.start_threads(threads, unlock=None)
    +

    Context manager to start threads. It attempts to join the threads upon +exit.

    +
    + +
    +
    +test.support.calcobjsize(fmt)
    +

    Return struct.calcsize() for nP{fmt}0n or, if gettotalrefcount +exists, 2PnP{fmt}0P.

    +
    + +
    +
    +test.support.calcvobjsize(fmt)
    +

    Return struct.calcsize() for nPn{fmt}0n or, if gettotalrefcount +exists, 2PnPn{fmt}0P.

    +
    + +
    +
    +test.support.checksizeof(test, o, size)
    +

    For testcase test, assert that the sys.getsizeof for o plus the GC +header size equals size.

    +
    + +
    + +

    Return True if the OS supports symbolic links, False +otherwise.

    +
    + +
    +
    +test.support.can_xattr()
    +

    Return True if the OS supports xattr, False +otherwise.

    +
    + +
    + +

    A decorator for running tests that require support for symbolic links.

    +
    + +
    +
    +@test.support.skip_unless_xattr
    +

    A decorator for running tests that require support for xattr.

    +
    + +
    +
    +@test.support.skip_unless_bind_unix_socket
    +

    A decorator for running tests that require a functional bind() for Unix +sockets.

    +
    + +
    +
    +@test.support.anticipate_failure(condition)
    +

    A decorator to conditionally mark tests with +unittest.expectedFailure(). Any use of this decorator should +have an associated comment identifying the relevant tracker issue.

    +
    + +
    +
    +@test.support.run_with_locale(catstr, *locales)
    +

    A decorator for running a function in a different locale, correctly +resetting it after it has finished. catstr is the locale category as +a string (for example "LC_ALL"). The locales passed will be tried +sequentially, and the first valid locale will be used.

    +
    + +
    +
    +@test.support.run_with_tz(tz)
    +

    A decorator for running a function in a specific timezone, correctly +resetting it after it has finished.

    +
    + +
    +
    +@test.support.requires_freebsd_version(*min_version)
    +

    Decorator for the minimum version when running test on FreeBSD. If the +FreeBSD version is less than the minimum, raise unittest.SkipTest.

    +
    + +
    +
    +@test.support.requires_linux_version(*min_version)
    +

    Decorator for the minimum version when running test on Linux. If the +Linux version is less than the minimum, raise unittest.SkipTest.

    +
    + +
    +
    +@test.support.requires_mac_version(*min_version)
    +

    Decorator for the minimum version when running test on Mac OS X. If the +MAC OS X version is less than the minimum, raise unittest.SkipTest.

    +
    + +
    +
    +@test.support.requires_IEEE_754
    +

    Decorator for skipping tests on non-IEEE 754 platforms.

    +
    + +
    +
    +@test.support.requires_zlib
    +

    Decorator for skipping tests if zlib doesn’t exist.

    +
    + +
    +
    +@test.support.requires_gzip
    +

    Decorator for skipping tests if gzip doesn’t exist.

    +
    + +
    +
    +@test.support.requires_bz2
    +

    Decorator for skipping tests if bz2 doesn’t exist.

    +
    + +
    +
    +@test.support.requires_lzma
    +

    Decorator for skipping tests if lzma doesn’t exist.

    +
    + +
    +
    +@test.support.requires_resource(resource)
    +

    Decorator for skipping tests if resource is not available.

    +
    + +
    +
    +@test.support.requires_docstrings
    +

    Decorator for only running the test if HAVE_DOCSTRINGS.

    +
    + +
    +
    +@test.support.cpython_only(test)
    +

    Decorator for tests only applicable to CPython.

    +
    + +
    +
    +@test.support.impl_detail(msg=None, **guards)
    +

    Decorator for invoking check_impl_detail() on guards. If that +returns False, then uses msg as the reason for skipping the test.

    +
    + +
    +
    +@test.support.no_tracing(func)
    +

    Decorator to temporarily turn off tracing for the duration of the test.

    +
    + +
    +
    +@test.support.refcount_test(test)
    +

    Decorator for tests which involve reference counting. The decorator does +not run the test if it is not run by CPython. Any trace function is unset +for the duration of the test to prevent unexpected refcounts caused by +the trace function.

    +
    + +
    +
    +@test.support.reap_threads(func)
    +

    Decorator to ensure the threads are cleaned up even if the test fails.

    +
    + +
    +
    +@test.support.bigmemtest(size, memuse, dry_run=True)
    +

    Decorator for bigmem tests.

    +

    size is a requested size for the test (in arbitrary, test-interpreted +units.) memuse is the number of bytes per unit for the test, or a good +estimate of it. For example, a test that needs two byte buffers, of 4 GiB +each, could be decorated with @bigmemtest(size=_4G, memuse=2).

    +

    The size argument is normally passed to the decorated test method as an +extra argument. If dry_run is True, the value passed to the test +method may be less than the requested value. If dry_run is False, it +means the test doesn’t support dummy runs when -M is not specified.

    +
    + +
    +
    +@test.support.bigaddrspacetest(f)
    +

    Decorator for tests that fill the address space. f is the function to +wrap.

    +
    + +
    +
    +test.support.make_bad_fd()
    +

    Create an invalid file descriptor by opening and closing a temporary file, +and returning its descriptor.

    +
    + +
    +
    +test.support.check_syntax_error(testcase, statement, errtext='', *, lineno=None, offset=None)
    +

    Test for syntax errors in statement by attempting to compile statement. +testcase is the unittest instance for the test. errtext is the +text of the error raised by SyntaxError. If lineno is not None, +compares to the line of the SyntaxError. If offset is not None, +compares to the offset of the SyntaxError.

    +
    + +
    +
    +test.support.open_urlresource(url, *args, **kw)
    +

    Open url. If open fails, raises TestFailed.

    +
    + +
    +
    +test.support.import_module(name, deprecated=False, *, required_on())
    +

    This function imports and returns the named module. Unlike a normal +import, this function raises unittest.SkipTest if the module +cannot be imported.

    +

    Module and package deprecation messages are suppressed during this import +if deprecated is True. If a module is required on a platform but +optional for others, set required_on to an iterable of platform prefixes +which will be compared against sys.platform.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +test.support.import_fresh_module(name, fresh=(), blocked=(), deprecated=False)
    +

    This function imports and returns a fresh copy of the named Python module +by removing the named module from sys.modules before doing the import. +Note that unlike reload(), the original module is not affected by +this operation.

    +

    fresh is an iterable of additional module names that are also removed +from the sys.modules cache before doing the import.

    +

    blocked is an iterable of module names that are replaced with None +in the module cache during the import to ensure that attempts to import +them raise ImportError.

    +

    The named module and any modules named in the fresh and blocked +parameters are saved before starting the import and then reinserted into +sys.modules when the fresh import is complete.

    +

    Module and package deprecation messages are suppressed during this import +if deprecated is True.

    +

    This function will raise ImportError if the named module cannot be +imported.

    +

    Example use:

    +
    # Get copies of the warnings module for testing without affecting the
    +# version being used by the rest of the test suite. One copy uses the
    +# C implementation, the other is forced to use the pure Python fallback
    +# implementation
    +py_warnings = import_fresh_module('warnings', blocked=['_warnings'])
    +c_warnings = import_fresh_module('warnings', fresh=['_warnings'])
    +
    +
    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +test.support.modules_setup()
    +

    Return a copy of sys.modules.

    +
    + +
    +
    +test.support.modules_cleanup(oldmodules)
    +

    Remove modules except for oldmodules and encodings in order to +preserve internal cache.

    +
    + +
    +
    +test.support.threading_setup()
    +

    Return current thread count and copy of dangling threads.

    +
    + +
    +
    +test.support.threading_cleanup(*original_values)
    +

    Cleanup up threads not specified in original_values. Designed to emit +a warning if a test leaves running threads in the background.

    +
    + +
    +
    +test.support.join_thread(thread, timeout=30.0)
    +

    Join a thread within timeout. Raise an AssertionError if thread +is still alive after timeout seconds.

    +
    + +
    +
    +test.support.reap_children()
    +

    Use this at the end of test_main whenever sub-processes are started. +This will help ensure that no extra children (zombies) stick around to +hog resources and create problems when looking for refleaks.

    +
    + +
    +
    +test.support.get_attribute(obj, name)
    +

    Get an attribute, raising unittest.SkipTest if AttributeError +is raised.

    +
    + +
    +
    +test.support.bind_port(sock, host=HOST)
    +

    Bind the socket to a free port and return the port number. Relies on +ephemeral ports in order to ensure we are using an unbound port. This is +important as many tests may be running simultaneously, especially in a +buildbot environment. This method raises an exception if the +sock.family is AF_INET and sock.type is +SOCK_STREAM, and the socket has +SO_REUSEADDR or SO_REUSEPORT set on it. +Tests should never set these socket options for TCP/IP sockets. +The only case for setting these options is testing multicasting via +multiple UDP sockets.

    +

    Additionally, if the SO_EXCLUSIVEADDRUSE socket option is +available (i.e. on Windows), it will be set on the socket. This will +prevent anyone else from binding to our host/port for the duration of the +test.

    +
    + +
    +
    +test.support.bind_unix_socket(sock, addr)
    +

    Bind a unix socket, raising unittest.SkipTest if +PermissionError is raised.

    +
    + +
    +
    +test.support.find_unused_port(family=socket.AF_INET, socktype=socket.SOCK_STREAM)
    +

    Returns an unused port that should be suitable for binding. This is +achieved by creating a temporary socket with the same family and type as +the sock parameter (default is AF_INET, +SOCK_STREAM), +and binding it to the specified host address (defaults to 0.0.0.0) +with the port set to 0, eliciting an unused ephemeral port from the OS. +The temporary socket is then closed and deleted, and the ephemeral port is +returned.

    +

    Either this method or bind_port() should be used for any tests +where a server socket needs to be bound to a particular port for the +duration of the test. +Which one to use depends on whether the calling code is creating a Python +socket, or if an unused port needs to be provided in a constructor +or passed to an external program (i.e. the -accept argument to +openssl’s s_server mode). Always prefer bind_port() over +find_unused_port() where possible. Using a hard coded port is +discouraged since it can make multiple instances of the test impossible to +run simultaneously, which is a problem for buildbots.

    +
    + +
    +
    +test.support.load_package_tests(pkg_dir, loader, standard_tests, pattern)
    +

    Generic implementation of the unittest load_tests protocol for +use in test packages. pkg_dir is the root directory of the package; +loader, standard_tests, and pattern are the arguments expected by +load_tests. In simple cases, the test package’s __init__.py +can be the following:

    +
    import os
    +from test.support import load_package_tests
    +
    +def load_tests(*args):
    +    return load_package_tests(os.path.dirname(__file__), *args)
    +
    +
    +
    + +
    +
    +test.support.fs_is_case_insensitive(directory)
    +

    Return True if the file system for directory is case-insensitive.

    +
    + +
    +
    +test.support.detect_api_mismatch(ref_api, other_api, *, ignore=())
    +

    Returns the set of attributes, functions or methods of ref_api not +found on other_api, except for a defined list of items to be +ignored in this check specified in ignore.

    +

    By default this skips private attributes beginning with ‘_’ but +includes all magic methods, i.e. those starting and ending in ‘__’.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +test.support.patch(test_instance, object_to_patch, attr_name, new_value)
    +

    Override object_to_patch.attr_name with new_value. Also add +cleanup procedure to test_instance to restore object_to_patch for +attr_name. The attr_name should be a valid attribute for +object_to_patch.

    +
    + +
    +
    +test.support.run_in_subinterp(code)
    +

    Run code in subinterpreter. Raise unittest.SkipTest if +tracemalloc is enabled.

    +
    + +
    +
    +test.support.check_free_after_iterating(test, iter, cls, args=())
    +

    Assert that iter is deallocated after iterating.

    +
    + +
    +
    +test.support.missing_compiler_executable(cmd_names=[])
    +

    Check for the existence of the compiler executables whose names are listed +in cmd_names or all the compiler executables when cmd_names is empty +and return the first missing executable or None when none is found +missing.

    +
    + +
    +
    +test.support.check__all__(test_case, module, name_of_module=None, extra=(), blacklist=())
    +

    Assert that the __all__ variable of module contains all public names.

    +

    The module’s public names (its API) are detected automatically +based on whether they match the public name convention and were defined in +module.

    +

    The name_of_module argument can specify (as a string or tuple thereof) what +module(s) an API could be defined in order to be detected as a public +API. One case for this is when module imports part of its public API from +other modules, possibly a C backend (like csv and its _csv).

    +

    The extra argument can be a set of names that wouldn’t otherwise be automatically +detected as “public”, like objects without a proper __module__ +attribute. If provided, it will be added to the automatically detected ones.

    +

    The blacklist argument can be a set of names that must not be treated as part of +the public API even though their names indicate otherwise.

    +

    Example use:

    +
    import bar
    +import foo
    +import unittest
    +from test import support
    +
    +class MiscTestCase(unittest.TestCase):
    +    def test__all__(self):
    +        support.check__all__(self, foo)
    +
    +class OtherTestCase(unittest.TestCase):
    +    def test__all__(self):
    +        extra = {'BAR_CONST', 'FOO_CONST'}
    +        blacklist = {'baz'}  # Undocumented name.
    +        # bar imports part of its API from _bar.
    +        support.check__all__(self, bar, ('bar', '_bar'),
    +                             extra=extra, blacklist=blacklist)
    +
    +
    +
    +

    New in version 3.6.

    +
    +
    + +

    The test.support module defines the following classes:

    +
    +
    +class test.support.TransientResource(exc, **kwargs)
    +

    Instances are a context manager that raises ResourceDenied if the +specified exception type is raised. Any keyword arguments are treated as +attribute/value pairs to be compared against any exception raised within the +with statement. Only if all pairs match properly against +attributes on the exception is ResourceDenied raised.

    +
    + +
    +
    +class test.support.EnvironmentVarGuard
    +

    Class used to temporarily set or unset environment variables. Instances can +be used as a context manager and have a complete dictionary interface for +querying/modifying the underlying os.environ. After exit from the +context manager all changes to environment variables done through this +instance will be rolled back.

    +
    +

    Changed in version 3.1: Added dictionary interface.

    +
    +
    + +
    +
    +EnvironmentVarGuard.set(envvar, value)
    +

    Temporarily set the environment variable envvar to the value of +value.

    +
    + +
    +
    +EnvironmentVarGuard.unset(envvar)
    +

    Temporarily unset the environment variable envvar.

    +
    + +
    +
    +class test.support.SuppressCrashReport
    +

    A context manager used to try to prevent crash dialog popups on tests that +are expected to crash a subprocess.

    +

    On Windows, it disables Windows Error Reporting dialogs using +SetErrorMode.

    +

    On UNIX, resource.setrlimit() is used to set +resource.RLIMIT_CORE’s soft limit to 0 to prevent coredump file +creation.

    +

    On both platforms, the old value is restored by __exit__().

    +
    + +
    +
    +class test.support.CleanImport(*module_names)
    +

    A context manager to force import to return a new module reference. This +is useful for testing module-level behaviors, such as the emission of a +DeprecationWarning on import. Example usage:

    +
    with CleanImport('foo'):
    +    importlib.import_module('foo')  # New reference.
    +
    +
    +
    + +
    +
    +class test.support.DirsOnSysPath(*paths)
    +

    A context manager to temporarily add directories to sys.path.

    +

    This makes a copy of sys.path, appends any directories given +as positional arguments, then reverts sys.path to the copied +settings when the context ends.

    +

    Note that all sys.path modifications in the body of the +context manager, including replacement of the object, +will be reverted at the end of the block.

    +
    + +
    +
    +class test.support.SaveSignals
    +

    Class to save and restore signal handlers registered by the Python signal +handler.

    +
    + +
    +
    +class test.support.Matcher
    +
    +
    +matches(self, d, **kwargs)
    +

    Try to match a single dict with the supplied arguments.

    +
    + +
    +
    +match_value(self, k, dv, v)
    +

    Try to match a single stored value (dv) with a supplied value (v).

    +
    + +
    + +
    +
    +class test.support.WarningsRecorder
    +

    Class used to record warnings for unit tests. See documentation of +check_warnings() above for more details.

    +
    + +
    +
    +class test.support.BasicTestRunner
    +
    +
    +run(test)
    +

    Run test and return the result.

    +
    + +
    + +
    +
    +class test.support.TestHandler(logging.handlers.BufferingHandler)
    +

    Class for logging support.

    +
    + +
    +
    +class test.support.FakePath(path)
    +

    Simple path-like object. It implements the __fspath__() +method which just returns the path argument. If path is an exception, +it will be raised in __fspath__().

    +
    + +
    +
    +

    test.support.script_helper — Utilities for the Python execution tests

    +

    The test.support.script_helper module provides support for Python’s +script execution tests.

    +
    +
    +test.support.script_helper.interpreter_requires_environment()
    +

    Return True if sys.executable interpreter requires environment +variables in order to be able to run at all.

    +

    This is designed to be used with @unittest.skipIf() to annotate tests +that need to use an assert_python*() function to launch an isolated +mode (-I) or no environment mode (-E) sub-interpreter process.

    +

    A normal build & test does not run into this situation but it can happen +when trying to run the standard library test suite from an interpreter that +doesn’t have an obvious home with Python’s current home finding logic.

    +

    Setting PYTHONHOME is one way to get most of the testsuite to run +in that situation. PYTHONPATH or PYTHONUSERSITE are +other common environment variables that might impact whether or not the +interpreter can start.

    +
    + +
    +
    +test.support.script_helper.run_python_until_end(*args, **env_vars)
    +

    Set up the environment based on env_vars for running the interpreter +in a subprocess. The values can include __isolated, __cleanenv, +__cwd, and TERM.

    +
    + +
    +
    +test.support.script_helper.assert_python_ok(*args, **env_vars)
    +

    Assert that running the interpreter with args and optional environment +variables env_vars succeeds (rc == 0) and return a (return code, +stdout, stderr) tuple.

    +

    If the __cleanenv keyword is set, env_vars is used as a fresh +environment.

    +

    Python is started in isolated mode (command line option -I), +except if the __isolated keyword is set to False.

    +
    + +
    +
    +test.support.script_helper.assert_python_failure(*args, **env_vars)
    +

    Assert that running the interpreter with args and optional environment +variables env_vars fails (rc != 0) and return a (return code, +stdout, stderr) tuple.

    +

    See assert_python_ok() for more options.

    +
    + +
    +
    +test.support.script_helper.spawn_python(*args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, **kw)
    +

    Run a Python subprocess with the given arguments.

    +

    kw is extra keyword args to pass to subprocess.Popen(). Returns a +subprocess.Popen object.

    +
    + +
    +
    +test.support.script_helper.kill_python(p)
    +

    Run the given subprocess.Popen process until completion and return +stdout.

    +
    + +
    +
    +test.support.script_helper.make_script(script_dir, script_basename, source, omit_suffix=False)
    +

    Create script containing source in path script_dir and script_basename. +If omit_suffix is False, append .py to the name. Return the full +script path.

    +
    + +
    +
    +test.support.script_helper.make_zip_script(zip_dir, zip_basename, script_name, name_in_zip=None)
    +

    Create zip file at zip_dir and zip_basename with extension zip which +contains the files in script_name. name_in_zip is the archive name. +Return a tuple containing (full path, full path of archive name).

    +
    + +
    +
    +test.support.script_helper.make_pkg(pkg_dir, init_source='')
    +

    Create a directory named pkg_dir containing an __init__ file with +init_source as its contents.

    +
    + +
    +
    +test.support.script_helper.make_zip_pkg(zip_dir, zip_basename, pkg_name, script_basename, source, depth=1, compiled=False)
    +

    Create a zip package directory with a path of zip_dir and zip_basename +containing an empty __init__ file and a file script_basename +containing the source. If compiled is True, both source files will +be compiled and added to the zip package. Return a tuple of the full zip +path and the archive name for the zip file.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/text.html b/python-3.7.4-docs-html/library/text.html new file mode 100644 index 0000000..ea89c91 --- /dev/null +++ b/python-3.7.4-docs-html/library/text.html @@ -0,0 +1,246 @@ + + + + + + + Text Processing Services — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/textwrap.html b/python-3.7.4-docs-html/library/textwrap.html new file mode 100644 index 0000000..23628be --- /dev/null +++ b/python-3.7.4-docs-html/library/textwrap.html @@ -0,0 +1,482 @@ + + + + + + + textwrap — Text wrapping and filling — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    textwrap — Text wrapping and filling

    +

    Source code: Lib/textwrap.py

    +
    +

    The textwrap module provides some convenience functions, +as well as TextWrapper, the class that does all the work. +If you’re just wrapping or filling one or two text strings, the convenience +functions should be good enough; otherwise, you should use an instance of +TextWrapper for efficiency.

    +
    +
    +textwrap.wrap(text, width=70, **kwargs)
    +

    Wraps the single paragraph in text (a string) so every line is at most +width characters long. Returns a list of output lines, without final +newlines.

    +

    Optional keyword arguments correspond to the instance attributes of +TextWrapper, documented below. width defaults to 70.

    +

    See the TextWrapper.wrap() method for additional details on how +wrap() behaves.

    +
    + +
    +
    +textwrap.fill(text, width=70, **kwargs)
    +

    Wraps the single paragraph in text, and returns a single string containing the +wrapped paragraph. fill() is shorthand for

    +
    "\n".join(wrap(text, ...))
    +
    +
    +

    In particular, fill() accepts exactly the same keyword arguments as +wrap().

    +
    + +
    +
    +textwrap.shorten(text, width, **kwargs)
    +

    Collapse and truncate the given text to fit in the given width.

    +

    First the whitespace in text is collapsed (all whitespace is replaced by +single spaces). If the result fits in the width, it is returned. +Otherwise, enough words are dropped from the end so that the remaining words +plus the placeholder fit within width:

    +
    >>> textwrap.shorten("Hello  world!", width=12)
    +'Hello world!'
    +>>> textwrap.shorten("Hello  world!", width=11)
    +'Hello [...]'
    +>>> textwrap.shorten("Hello world", width=10, placeholder="...")
    +'Hello...'
    +
    +
    +

    Optional keyword arguments correspond to the instance attributes of +TextWrapper, documented below. Note that the whitespace is +collapsed before the text is passed to the TextWrapper fill() +function, so changing the value of tabsize, expand_tabs, +drop_whitespace, and replace_whitespace will have no effect.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +textwrap.dedent(text)
    +

    Remove any common leading whitespace from every line in text.

    +

    This can be used to make triple-quoted strings line up with the left edge of the +display, while still presenting them in the source code in indented form.

    +

    Note that tabs and spaces are both treated as whitespace, but they are not +equal: the lines "  hello" and "\thello" are considered to have no +common leading whitespace.

    +

    Lines containing only whitespace are ignored in the input and normalized to a +single newline character in the output.

    +

    For example:

    +
    def test():
    +    # end first line with \ to avoid the empty line!
    +    s = '''\
    +    hello
    +      world
    +    '''
    +    print(repr(s))          # prints '    hello\n      world\n    '
    +    print(repr(dedent(s)))  # prints 'hello\n  world\n'
    +
    +
    +
    + +
    +
    +textwrap.indent(text, prefix, predicate=None)
    +

    Add prefix to the beginning of selected lines in text.

    +

    Lines are separated by calling text.splitlines(True).

    +

    By default, prefix is added to all lines that do not consist +solely of whitespace (including any line endings).

    +

    For example:

    +
    >>> s = 'hello\n\n \nworld'
    +>>> indent(s, '  ')
    +'  hello\n\n \n  world'
    +
    +
    +

    The optional predicate argument can be used to control which lines +are indented. For example, it is easy to add prefix to even empty +and whitespace-only lines:

    +
    >>> print(indent(s, '+ ', lambda line: True))
    ++ hello
    ++
    ++
    ++ world
    +
    +
    +
    +

    New in version 3.3.

    +
    +
    + +

    wrap(), fill() and shorten() work by creating a +TextWrapper instance and calling a single method on it. That +instance is not reused, so for applications that process many text +strings using wrap() and/or fill(), it may be more efficient to +create your own TextWrapper object.

    +

    Text is preferably wrapped on whitespaces and right after the hyphens in +hyphenated words; only then will long words be broken if necessary, unless +TextWrapper.break_long_words is set to false.

    +
    +
    +class textwrap.TextWrapper(**kwargs)
    +

    The TextWrapper constructor accepts a number of optional keyword +arguments. Each keyword argument corresponds to an instance attribute, so +for example

    +
    wrapper = TextWrapper(initial_indent="* ")
    +
    +
    +

    is the same as

    +
    wrapper = TextWrapper()
    +wrapper.initial_indent = "* "
    +
    +
    +

    You can re-use the same TextWrapper object many times, and you can +change any of its options through direct assignment to instance attributes +between uses.

    +

    The TextWrapper instance attributes (and keyword arguments to the +constructor) are as follows:

    +
    +
    +width
    +

    (default: 70) The maximum length of wrapped lines. As long as there +are no individual words in the input text longer than width, +TextWrapper guarantees that no output line will be longer than +width characters.

    +
    + +
    +
    +expand_tabs
    +

    (default: True) If true, then all tab characters in text will be +expanded to spaces using the expandtabs() method of text.

    +
    + +
    +
    +tabsize
    +

    (default: 8) If expand_tabs is true, then all tab characters +in text will be expanded to zero or more spaces, depending on the +current column and the given tab size.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +replace_whitespace
    +

    (default: True) If true, after tab expansion but before wrapping, +the wrap() method will replace each whitespace character +with a single space. The whitespace characters replaced are +as follows: tab, newline, vertical tab, formfeed, and carriage +return ('\t\n\v\f\r').

    +
    +

    Note

    +

    If expand_tabs is false and replace_whitespace is true, +each tab character will be replaced by a single space, which is not +the same as tab expansion.

    +
    +
    +

    Note

    +

    If replace_whitespace is false, newlines may appear in the +middle of a line and cause strange output. For this reason, text should +be split into paragraphs (using str.splitlines() or similar) +which are wrapped separately.

    +
    +
    + +
    +
    +drop_whitespace
    +

    (default: True) If true, whitespace at the beginning and ending of +every line (after wrapping but before indenting) is dropped. +Whitespace at the beginning of the paragraph, however, is not dropped +if non-whitespace follows it. If whitespace being dropped takes up an +entire line, the whole line is dropped.

    +
    + +
    +
    +initial_indent
    +

    (default: '') String that will be prepended to the first line of +wrapped output. Counts towards the length of the first line. The empty +string is not indented.

    +
    + +
    +
    +subsequent_indent
    +

    (default: '') String that will be prepended to all lines of wrapped +output except the first. Counts towards the length of each line except +the first.

    +
    + +
    +
    +fix_sentence_endings
    +

    (default: False) If true, TextWrapper attempts to detect +sentence endings and ensure that sentences are always separated by exactly +two spaces. This is generally desired for text in a monospaced font. +However, the sentence detection algorithm is imperfect: it assumes that a +sentence ending consists of a lowercase letter followed by one of '.', +'!', or '?', possibly followed by one of '"' or "'", +followed by a space. One problem with this is algorithm is that it is +unable to detect the difference between “Dr.” in

    +
    [...] Dr. Frankenstein's monster [...]
    +
    +
    +

    and “Spot.” in

    +
    [...] See Spot. See Spot run [...]
    +
    +
    +

    fix_sentence_endings is false by default.

    +

    Since the sentence detection algorithm relies on string.lowercase for +the definition of “lowercase letter,” and a convention of using two spaces +after a period to separate sentences on the same line, it is specific to +English-language texts.

    +
    + +
    +
    +break_long_words
    +

    (default: True) If true, then words longer than width will be +broken in order to ensure that no lines are longer than width. If +it is false, long words will not be broken, and some lines may be longer +than width. (Long words will be put on a line by themselves, in +order to minimize the amount by which width is exceeded.)

    +
    + +
    +
    +break_on_hyphens
    +

    (default: True) If true, wrapping will occur preferably on whitespaces +and right after hyphens in compound words, as it is customary in English. +If false, only whitespaces will be considered as potentially good places +for line breaks, but you need to set break_long_words to false if +you want truly insecable words. Default behaviour in previous versions +was to always allow breaking hyphenated words.

    +
    + +
    +
    +max_lines
    +

    (default: None) If not None, then the output will contain at most +max_lines lines, with placeholder appearing at the end of the output.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +placeholder
    +

    (default: ' [...]') String that will appear at the end of the output +text if it has been truncated.

    +
    +

    New in version 3.4.

    +
    +
    + +

    TextWrapper also provides some public methods, analogous to the +module-level convenience functions:

    +
    +
    +wrap(text)
    +

    Wraps the single paragraph in text (a string) so every line is at most +width characters long. All wrapping options are taken from +instance attributes of the TextWrapper instance. Returns a list +of output lines, without final newlines. If the wrapped output has no +content, the returned list is empty.

    +
    + +
    +
    +fill(text)
    +

    Wraps the single paragraph in text, and returns a single string +containing the wrapped paragraph.

    +
    + +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/threading.html b/python-3.7.4-docs-html/library/threading.html new file mode 100644 index 0000000..032db24 --- /dev/null +++ b/python-3.7.4-docs-html/library/threading.html @@ -0,0 +1,1151 @@ + + + + + + + threading — Thread-based parallelism — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    threading — Thread-based parallelism

    +

    Source code: Lib/threading.py

    +
    +

    This module constructs higher-level threading interfaces on top of the lower +level _thread module. See also the queue module.

    +
    +

    Changed in version 3.7: This module used to be optional, it is now always available.

    +
    +
    +

    Note

    +

    While they are not listed below, the camelCase names used for some +methods and functions in this module in the Python 2.x series are still +supported by this module.

    +
    +

    This module defines the following functions:

    +
    +
    +threading.active_count()
    +

    Return the number of Thread objects currently alive. The returned +count is equal to the length of the list returned by enumerate().

    +
    + +
    +
    +threading.current_thread()
    +

    Return the current Thread object, corresponding to the caller’s thread +of control. If the caller’s thread of control was not created through the +threading module, a dummy thread object with limited functionality is +returned.

    +
    + +
    +
    +threading.get_ident()
    +

    Return the ‘thread identifier’ of the current thread. This is a nonzero +integer. Its value has no direct meaning; it is intended as a magic cookie +to be used e.g. to index a dictionary of thread-specific data. Thread +identifiers may be recycled when a thread exits and another thread is +created.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +threading.enumerate()
    +

    Return a list of all Thread objects currently alive. The list +includes daemonic threads, dummy thread objects created by +current_thread(), and the main thread. It excludes terminated threads +and threads that have not yet been started.

    +
    + +
    +
    +threading.main_thread()
    +

    Return the main Thread object. In normal conditions, the +main thread is the thread from which the Python interpreter was +started.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +threading.settrace(func)
    +

    Set a trace function for all threads started from the threading module. +The func will be passed to sys.settrace() for each thread, before its +run() method is called.

    +
    + +
    +
    +threading.setprofile(func)
    +

    Set a profile function for all threads started from the threading module. +The func will be passed to sys.setprofile() for each thread, before its +run() method is called.

    +
    + +
    +
    +threading.stack_size([size])
    +

    Return the thread stack size used when creating new threads. The optional +size argument specifies the stack size to be used for subsequently created +threads, and must be 0 (use platform or configured default) or a positive +integer value of at least 32,768 (32 KiB). If size is not specified, +0 is used. If changing the thread stack size is +unsupported, a RuntimeError is raised. If the specified stack size is +invalid, a ValueError is raised and the stack size is unmodified. 32 KiB +is currently the minimum supported stack size value to guarantee sufficient +stack space for the interpreter itself. Note that some platforms may have +particular restrictions on values for the stack size, such as requiring a +minimum stack size > 32 KiB or requiring allocation in multiples of the system +memory page size - platform documentation should be referred to for more +information (4 KiB pages are common; using multiples of 4096 for the stack size is +the suggested approach in the absence of more specific information).

    +

    Availability: Windows, systems with POSIX threads.

    +
    + +

    This module also defines the following constant:

    +
    +
    +threading.TIMEOUT_MAX
    +

    The maximum value allowed for the timeout parameter of blocking functions +(Lock.acquire(), RLock.acquire(), Condition.wait(), etc.). +Specifying a timeout greater than this value will raise an +OverflowError.

    +
    +

    New in version 3.2.

    +
    +
    + +

    This module defines a number of classes, which are detailed in the sections +below.

    +

    The design of this module is loosely based on Java’s threading model. However, +where Java makes locks and condition variables basic behavior of every object, +they are separate objects in Python. Python’s Thread class supports a +subset of the behavior of Java’s Thread class; currently, there are no +priorities, no thread groups, and threads cannot be destroyed, stopped, +suspended, resumed, or interrupted. The static methods of Java’s Thread class, +when implemented, are mapped to module-level functions.

    +

    All of the methods described below are executed atomically.

    +
    +

    Thread-Local Data

    +

    Thread-local data is data whose values are thread specific. To manage +thread-local data, just create an instance of local (or a +subclass) and store attributes on it:

    +
    mydata = threading.local()
    +mydata.x = 1
    +
    +
    +

    The instance’s values will be different for separate threads.

    +
    +
    +class threading.local
    +

    A class that represents thread-local data.

    +

    For more details and extensive examples, see the documentation string of the +_threading_local module.

    +
    + +
    +
    +

    Thread Objects

    +

    The Thread class represents an activity that is run in a separate +thread of control. There are two ways to specify the activity: by passing a +callable object to the constructor, or by overriding the run() +method in a subclass. No other methods (except for the constructor) should be +overridden in a subclass. In other words, only override the +__init__() and run() methods of this class.

    +

    Once a thread object is created, its activity must be started by calling the +thread’s start() method. This invokes the run() +method in a separate thread of control.

    +

    Once the thread’s activity is started, the thread is considered ‘alive’. It +stops being alive when its run() method terminates – either +normally, or by raising an unhandled exception. The is_alive() +method tests whether the thread is alive.

    +

    Other threads can call a thread’s join() method. This blocks +the calling thread until the thread whose join() method is +called is terminated.

    +

    A thread has a name. The name can be passed to the constructor, and read or +changed through the name attribute.

    +

    A thread can be flagged as a “daemon thread”. The significance of this flag is +that the entire Python program exits when only daemon threads are left. The +initial value is inherited from the creating thread. The flag can be set +through the daemon property or the daemon constructor +argument.

    +
    +

    Note

    +

    Daemon threads are abruptly stopped at shutdown. Their resources (such +as open files, database transactions, etc.) may not be released properly. +If you want your threads to stop gracefully, make them non-daemonic and +use a suitable signalling mechanism such as an Event.

    +
    +

    There is a “main thread” object; this corresponds to the initial thread of +control in the Python program. It is not a daemon thread.

    +

    There is the possibility that “dummy thread objects” are created. These are +thread objects corresponding to “alien threads”, which are threads of control +started outside the threading module, such as directly from C code. Dummy +thread objects have limited functionality; they are always considered alive and +daemonic, and cannot be join()ed. They are never deleted, +since it is impossible to detect the termination of alien threads.

    +
    +
    +class threading.Thread(group=None, target=None, name=None, args=(), kwargs={}, *, daemon=None)
    +

    This constructor should always be called with keyword arguments. Arguments +are:

    +

    group should be None; reserved for future extension when a +ThreadGroup class is implemented.

    +

    target is the callable object to be invoked by the run() method. +Defaults to None, meaning nothing is called.

    +

    name is the thread name. By default, a unique name is constructed of the +form “Thread-N” where N is a small decimal number.

    +

    args is the argument tuple for the target invocation. Defaults to ().

    +

    kwargs is a dictionary of keyword arguments for the target invocation. +Defaults to {}.

    +

    If not None, daemon explicitly sets whether the thread is daemonic. +If None (the default), the daemonic property is inherited from the +current thread.

    +

    If the subclass overrides the constructor, it must make sure to invoke the +base class constructor (Thread.__init__()) before doing anything else to +the thread.

    +
    +

    Changed in version 3.3: Added the daemon argument.

    +
    +
    +
    +start()
    +

    Start the thread’s activity.

    +

    It must be called at most once per thread object. It arranges for the +object’s run() method to be invoked in a separate thread +of control.

    +

    This method will raise a RuntimeError if called more than once +on the same thread object.

    +
    + +
    +
    +run()
    +

    Method representing the thread’s activity.

    +

    You may override this method in a subclass. The standard run() +method invokes the callable object passed to the object’s constructor as +the target argument, if any, with positional and keyword arguments taken +from the args and kwargs arguments, respectively.

    +
    + +
    +
    +join(timeout=None)
    +

    Wait until the thread terminates. This blocks the calling thread until +the thread whose join() method is called terminates – either +normally or through an unhandled exception – or until the optional +timeout occurs.

    +

    When the timeout argument is present and not None, it should be a +floating point number specifying a timeout for the operation in seconds +(or fractions thereof). As join() always returns None, +you must call is_alive() after join() to +decide whether a timeout happened – if the thread is still alive, the +join() call timed out.

    +

    When the timeout argument is not present or None, the operation will +block until the thread terminates.

    +

    A thread can be join()ed many times.

    +

    join() raises a RuntimeError if an attempt is made +to join the current thread as that would cause a deadlock. It is also +an error to join() a thread before it has been started +and attempts to do so raise the same exception.

    +
    + +
    +
    +name
    +

    A string used for identification purposes only. It has no semantics. +Multiple threads may be given the same name. The initial name is set by +the constructor.

    +
    + +
    +
    +getName()
    +
    +setName()
    +

    Old getter/setter API for name; use it directly as a +property instead.

    +
    + +
    +
    +ident
    +

    The ‘thread identifier’ of this thread or None if the thread has not +been started. This is a nonzero integer. See the get_ident() +function. Thread identifiers may be recycled when a thread exits and +another thread is created. The identifier is available even after the +thread has exited.

    +
    + +
    +
    +is_alive()
    +

    Return whether the thread is alive.

    +

    This method returns True just before the run() method +starts until just after the run() method terminates. The +module function enumerate() returns a list of all alive threads.

    +
    + +
    +
    +daemon
    +

    A boolean value indicating whether this thread is a daemon thread (True) +or not (False). This must be set before start() is called, +otherwise RuntimeError is raised. Its initial value is inherited +from the creating thread; the main thread is not a daemon thread and +therefore all threads created in the main thread default to +daemon = False.

    +

    The entire Python program exits when no alive non-daemon threads are left.

    +
    + +
    +
    +isDaemon()
    +
    +setDaemon()
    +

    Old getter/setter API for daemon; use it directly as a +property instead.

    +
    + +
    + +
    +

    CPython implementation detail: In CPython, due to the Global Interpreter Lock, only one thread +can execute Python code at once (even though certain performance-oriented +libraries might overcome this limitation). +If you want your application to make better use of the computational +resources of multi-core machines, you are advised to use +multiprocessing or concurrent.futures.ProcessPoolExecutor. +However, threading is still an appropriate model if you want to run +multiple I/O-bound tasks simultaneously.

    +
    +
    +
    +

    Lock Objects

    +

    A primitive lock is a synchronization primitive that is not owned by a +particular thread when locked. In Python, it is currently the lowest level +synchronization primitive available, implemented directly by the _thread +extension module.

    +

    A primitive lock is in one of two states, “locked” or “unlocked”. It is created +in the unlocked state. It has two basic methods, acquire() and +release(). When the state is unlocked, acquire() +changes the state to locked and returns immediately. When the state is locked, +acquire() blocks until a call to release() in another +thread changes it to unlocked, then the acquire() call resets it +to locked and returns. The release() method should only be +called in the locked state; it changes the state to unlocked and returns +immediately. If an attempt is made to release an unlocked lock, a +RuntimeError will be raised.

    +

    Locks also support the context management protocol.

    +

    When more than one thread is blocked in acquire() waiting for the +state to turn to unlocked, only one thread proceeds when a release() +call resets the state to unlocked; which one of the waiting threads proceeds +is not defined, and may vary across implementations.

    +

    All methods are executed atomically.

    +
    +
    +class threading.Lock
    +

    The class implementing primitive lock objects. Once a thread has acquired a +lock, subsequent attempts to acquire it block, until it is released; any +thread may release it.

    +

    Note that Lock is actually a factory function which returns an instance +of the most efficient version of the concrete Lock class that is supported +by the platform.

    +
    +
    +acquire(blocking=True, timeout=-1)
    +

    Acquire a lock, blocking or non-blocking.

    +

    When invoked with the blocking argument set to True (the default), +block until the lock is unlocked, then set it to locked and return True.

    +

    When invoked with the blocking argument set to False, do not block. +If a call with blocking set to True would block, return False +immediately; otherwise, set the lock to locked and return True.

    +

    When invoked with the floating-point timeout argument set to a positive +value, block for at most the number of seconds specified by timeout +and as long as the lock cannot be acquired. A timeout argument of -1 +specifies an unbounded wait. It is forbidden to specify a timeout +when blocking is false.

    +

    The return value is True if the lock is acquired successfully, +False if not (for example if the timeout expired).

    +
    +

    Changed in version 3.2: The timeout parameter is new.

    +
    +
    +

    Changed in version 3.2: Lock acquisition can now be interrupted by signals on POSIX if the +underlying threading implementation supports it.

    +
    +
    + +
    +
    +release()
    +

    Release a lock. This can be called from any thread, not only the thread +which has acquired the lock.

    +

    When the lock is locked, reset it to unlocked, and return. If any other threads +are blocked waiting for the lock to become unlocked, allow exactly one of them +to proceed.

    +

    When invoked on an unlocked lock, a RuntimeError is raised.

    +

    There is no return value.

    +
    + +
    + +
    +
    +

    RLock Objects

    +

    A reentrant lock is a synchronization primitive that may be acquired multiple +times by the same thread. Internally, it uses the concepts of “owning thread” +and “recursion level” in addition to the locked/unlocked state used by primitive +locks. In the locked state, some thread owns the lock; in the unlocked state, +no thread owns it.

    +

    To lock the lock, a thread calls its acquire() method; this +returns once the thread owns the lock. To unlock the lock, a thread calls +its release() method. acquire()/release() +call pairs may be nested; only the final release() (the +release() of the outermost pair) resets the lock to unlocked and +allows another thread blocked in acquire() to proceed.

    +

    Reentrant locks also support the context management protocol.

    +
    +
    +class threading.RLock
    +

    This class implements reentrant lock objects. A reentrant lock must be +released by the thread that acquired it. Once a thread has acquired a +reentrant lock, the same thread may acquire it again without blocking; the +thread must release it once for each time it has acquired it.

    +

    Note that RLock is actually a factory function which returns an instance +of the most efficient version of the concrete RLock class that is supported +by the platform.

    +
    +
    +acquire(blocking=True, timeout=-1)
    +

    Acquire a lock, blocking or non-blocking.

    +

    When invoked without arguments: if this thread already owns the lock, increment +the recursion level by one, and return immediately. Otherwise, if another +thread owns the lock, block until the lock is unlocked. Once the lock is +unlocked (not owned by any thread), then grab ownership, set the recursion level +to one, and return. If more than one thread is blocked waiting until the lock +is unlocked, only one at a time will be able to grab ownership of the lock. +There is no return value in this case.

    +

    When invoked with the blocking argument set to true, do the same thing as when +called without arguments, and return true.

    +

    When invoked with the blocking argument set to false, do not block. If a call +without an argument would block, return false immediately; otherwise, do the +same thing as when called without arguments, and return true.

    +

    When invoked with the floating-point timeout argument set to a positive +value, block for at most the number of seconds specified by timeout +and as long as the lock cannot be acquired. Return true if the lock has +been acquired, false if the timeout has elapsed.

    +
    +

    Changed in version 3.2: The timeout parameter is new.

    +
    +
    + +
    +
    +release()
    +

    Release a lock, decrementing the recursion level. If after the decrement it is +zero, reset the lock to unlocked (not owned by any thread), and if any other +threads are blocked waiting for the lock to become unlocked, allow exactly one +of them to proceed. If after the decrement the recursion level is still +nonzero, the lock remains locked and owned by the calling thread.

    +

    Only call this method when the calling thread owns the lock. A +RuntimeError is raised if this method is called when the lock is +unlocked.

    +

    There is no return value.

    +
    + +
    + +
    +
    +

    Condition Objects

    +

    A condition variable is always associated with some kind of lock; this can be +passed in or one will be created by default. Passing one in is useful when +several condition variables must share the same lock. The lock is part of +the condition object: you don’t have to track it separately.

    +

    A condition variable obeys the context management protocol: +using the with statement acquires the associated lock for the duration of +the enclosed block. The acquire() and +release() methods also call the corresponding methods of +the associated lock.

    +

    Other methods must be called with the associated lock held. The +wait() method releases the lock, and then blocks until +another thread awakens it by calling notify() or +notify_all(). Once awakened, wait() +re-acquires the lock and returns. It is also possible to specify a timeout.

    +

    The notify() method wakes up one of the threads waiting for +the condition variable, if any are waiting. The notify_all() +method wakes up all threads waiting for the condition variable.

    +

    Note: the notify() and notify_all() methods +don’t release the lock; this means that the thread or threads awakened will +not return from their wait() call immediately, but only when +the thread that called notify() or notify_all() +finally relinquishes ownership of the lock.

    +

    The typical programming style using condition variables uses the lock to +synchronize access to some shared state; threads that are interested in a +particular change of state call wait() repeatedly until they +see the desired state, while threads that modify the state call +notify() or notify_all() when they change +the state in such a way that it could possibly be a desired state for one +of the waiters. For example, the following code is a generic +producer-consumer situation with unlimited buffer capacity:

    +
    # Consume one item
    +with cv:
    +    while not an_item_is_available():
    +        cv.wait()
    +    get_an_available_item()
    +
    +# Produce one item
    +with cv:
    +    make_an_item_available()
    +    cv.notify()
    +
    +
    +

    The while loop checking for the application’s condition is necessary +because wait() can return after an arbitrary long time, +and the condition which prompted the notify() call may +no longer hold true. This is inherent to multi-threaded programming. The +wait_for() method can be used to automate the condition +checking, and eases the computation of timeouts:

    +
    # Consume an item
    +with cv:
    +    cv.wait_for(an_item_is_available)
    +    get_an_available_item()
    +
    +
    +

    To choose between notify() and notify_all(), +consider whether one state change can be interesting for only one or several +waiting threads. E.g. in a typical producer-consumer situation, adding one +item to the buffer only needs to wake up one consumer thread.

    +
    +
    +class threading.Condition(lock=None)
    +

    This class implements condition variable objects. A condition variable +allows one or more threads to wait until they are notified by another thread.

    +

    If the lock argument is given and not None, it must be a Lock +or RLock object, and it is used as the underlying lock. Otherwise, +a new RLock object is created and used as the underlying lock.

    +
    +

    Changed in version 3.3: changed from a factory function to a class.

    +
    +
    +
    +acquire(*args)
    +

    Acquire the underlying lock. This method calls the corresponding method on +the underlying lock; the return value is whatever that method returns.

    +
    + +
    +
    +release()
    +

    Release the underlying lock. This method calls the corresponding method on +the underlying lock; there is no return value.

    +
    + +
    +
    +wait(timeout=None)
    +

    Wait until notified or until a timeout occurs. If the calling thread has +not acquired the lock when this method is called, a RuntimeError is +raised.

    +

    This method releases the underlying lock, and then blocks until it is +awakened by a notify() or notify_all() call for the same +condition variable in another thread, or until the optional timeout +occurs. Once awakened or timed out, it re-acquires the lock and returns.

    +

    When the timeout argument is present and not None, it should be a +floating point number specifying a timeout for the operation in seconds +(or fractions thereof).

    +

    When the underlying lock is an RLock, it is not released using +its release() method, since this may not actually unlock the lock +when it was acquired multiple times recursively. Instead, an internal +interface of the RLock class is used, which really unlocks it +even when it has been recursively acquired several times. Another internal +interface is then used to restore the recursion level when the lock is +reacquired.

    +

    The return value is True unless a given timeout expired, in which +case it is False.

    +
    +

    Changed in version 3.2: Previously, the method always returned None.

    +
    +
    + +
    +
    +wait_for(predicate, timeout=None)
    +

    Wait until a condition evaluates to true. predicate should be a +callable which result will be interpreted as a boolean value. +A timeout may be provided giving the maximum time to wait.

    +

    This utility method may call wait() repeatedly until the predicate +is satisfied, or until a timeout occurs. The return value is +the last return value of the predicate and will evaluate to +False if the method timed out.

    +

    Ignoring the timeout feature, calling this method is roughly equivalent to +writing:

    +
    while not predicate():
    +    cv.wait()
    +
    +
    +

    Therefore, the same rules apply as with wait(): The lock must be +held when called and is re-acquired on return. The predicate is evaluated +with the lock held.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +notify(n=1)
    +

    By default, wake up one thread waiting on this condition, if any. If the +calling thread has not acquired the lock when this method is called, a +RuntimeError is raised.

    +

    This method wakes up at most n of the threads waiting for the condition +variable; it is a no-op if no threads are waiting.

    +

    The current implementation wakes up exactly n threads, if at least n +threads are waiting. However, it’s not safe to rely on this behavior. +A future, optimized implementation may occasionally wake up more than +n threads.

    +

    Note: an awakened thread does not actually return from its wait() +call until it can reacquire the lock. Since notify() does not +release the lock, its caller should.

    +
    + +
    +
    +notify_all()
    +

    Wake up all threads waiting on this condition. This method acts like +notify(), but wakes up all waiting threads instead of one. If the +calling thread has not acquired the lock when this method is called, a +RuntimeError is raised.

    +
    + +
    + +
    +
    +

    Semaphore Objects

    +

    This is one of the oldest synchronization primitives in the history of computer +science, invented by the early Dutch computer scientist Edsger W. Dijkstra (he +used the names P() and V() instead of acquire() and +release()).

    +

    A semaphore manages an internal counter which is decremented by each +acquire() call and incremented by each release() +call. The counter can never go below zero; when acquire() +finds that it is zero, it blocks, waiting until some other thread calls +release().

    +

    Semaphores also support the context management protocol.

    +
    +
    +class threading.Semaphore(value=1)
    +

    This class implements semaphore objects. A semaphore manages an atomic +counter representing the number of release() calls minus the number of +acquire() calls, plus an initial value. The acquire() method +blocks if necessary until it can return without making the counter negative. +If not given, value defaults to 1.

    +

    The optional argument gives the initial value for the internal counter; it +defaults to 1. If the value given is less than 0, ValueError is +raised.

    +
    +

    Changed in version 3.3: changed from a factory function to a class.

    +
    +
    +
    +acquire(blocking=True, timeout=None)
    +

    Acquire a semaphore.

    +

    When invoked without arguments:

    +
      +
    • If the internal counter is larger than zero on entry, decrement it by +one and return true immediately.

    • +
    • If the internal counter is zero on entry, block until awoken by a call to +release(). Once awoken (and the counter is greater +than 0), decrement the counter by 1 and return true. Exactly one +thread will be awoken by each call to release(). The +order in which threads are awoken should not be relied on.

    • +
    +

    When invoked with blocking set to false, do not block. If a call +without an argument would block, return false immediately; otherwise, do +the same thing as when called without arguments, and return true.

    +

    When invoked with a timeout other than None, it will block for at +most timeout seconds. If acquire does not complete successfully in +that interval, return false. Return true otherwise.

    +
    +

    Changed in version 3.2: The timeout parameter is new.

    +
    +
    + +
    +
    +release()
    +

    Release a semaphore, incrementing the internal counter by one. When it +was zero on entry and another thread is waiting for it to become larger +than zero again, wake up that thread.

    +
    + +
    + +
    +
    +class threading.BoundedSemaphore(value=1)
    +

    Class implementing bounded semaphore objects. A bounded semaphore checks to +make sure its current value doesn’t exceed its initial value. If it does, +ValueError is raised. In most situations semaphores are used to guard +resources with limited capacity. If the semaphore is released too many times +it’s a sign of a bug. If not given, value defaults to 1.

    +
    +

    Changed in version 3.3: changed from a factory function to a class.

    +
    +
    + +
    +

    Semaphore Example

    +

    Semaphores are often used to guard resources with limited capacity, for example, +a database server. In any situation where the size of the resource is fixed, +you should use a bounded semaphore. Before spawning any worker threads, your +main thread would initialize the semaphore:

    +
    maxconnections = 5
    +# ...
    +pool_sema = BoundedSemaphore(value=maxconnections)
    +
    +
    +

    Once spawned, worker threads call the semaphore’s acquire and release methods +when they need to connect to the server:

    +
    with pool_sema:
    +    conn = connectdb()
    +    try:
    +        # ... use connection ...
    +    finally:
    +        conn.close()
    +
    +
    +

    The use of a bounded semaphore reduces the chance that a programming error which +causes the semaphore to be released more than it’s acquired will go undetected.

    +
    +
    +
    +

    Event Objects

    +

    This is one of the simplest mechanisms for communication between threads: one +thread signals an event and other threads wait for it.

    +

    An event object manages an internal flag that can be set to true with the +set() method and reset to false with the clear() +method. The wait() method blocks until the flag is true.

    +
    +
    +class threading.Event
    +

    Class implementing event objects. An event manages a flag that can be set to +true with the set() method and reset to false with the +clear() method. The wait() method blocks until the flag is true. +The flag is initially false.

    +
    +

    Changed in version 3.3: changed from a factory function to a class.

    +
    +
    +
    +is_set()
    +

    Return true if and only if the internal flag is true.

    +
    + +
    +
    +set()
    +

    Set the internal flag to true. All threads waiting for it to become true +are awakened. Threads that call wait() once the flag is true will +not block at all.

    +
    + +
    +
    +clear()
    +

    Reset the internal flag to false. Subsequently, threads calling +wait() will block until set() is called to set the internal +flag to true again.

    +
    + +
    +
    +wait(timeout=None)
    +

    Block until the internal flag is true. If the internal flag is true on +entry, return immediately. Otherwise, block until another thread calls +set() to set the flag to true, or until the optional timeout occurs.

    +

    When the timeout argument is present and not None, it should be a +floating point number specifying a timeout for the operation in seconds +(or fractions thereof).

    +

    This method returns true if and only if the internal flag has been set to +true, either before the wait call or after the wait starts, so it will +always return True except if a timeout is given and the operation +times out.

    +
    +

    Changed in version 3.1: Previously, the method always returned None.

    +
    +
    + +
    + +
    +
    +

    Timer Objects

    +

    This class represents an action that should be run only after a certain amount +of time has passed — a timer. Timer is a subclass of Thread +and as such also functions as an example of creating custom threads.

    +

    Timers are started, as with threads, by calling their start() +method. The timer can be stopped (before its action has begun) by calling the +cancel() method. The interval the timer will wait before +executing its action may not be exactly the same as the interval specified by +the user.

    +

    For example:

    +
    def hello():
    +    print("hello, world")
    +
    +t = Timer(30.0, hello)
    +t.start()  # after 30 seconds, "hello, world" will be printed
    +
    +
    +
    +
    +class threading.Timer(interval, function, args=None, kwargs=None)
    +

    Create a timer that will run function with arguments args and keyword +arguments kwargs, after interval seconds have passed. +If args is None (the default) then an empty list will be used. +If kwargs is None (the default) then an empty dict will be used.

    +
    +

    Changed in version 3.3: changed from a factory function to a class.

    +
    +
    +
    +cancel()
    +

    Stop the timer, and cancel the execution of the timer’s action. This will +only work if the timer is still in its waiting stage.

    +
    + +
    + +
    +
    +

    Barrier Objects

    +
    +

    New in version 3.2.

    +
    +

    This class provides a simple synchronization primitive for use by a fixed number +of threads that need to wait for each other. Each of the threads tries to pass +the barrier by calling the wait() method and will block until +all of the threads have made their wait() calls. At this point, +the threads are released simultaneously.

    +

    The barrier can be reused any number of times for the same number of threads.

    +

    As an example, here is a simple way to synchronize a client and server thread:

    +
    b = Barrier(2, timeout=5)
    +
    +def server():
    +    start_server()
    +    b.wait()
    +    while True:
    +        connection = accept_connection()
    +        process_server_connection(connection)
    +
    +def client():
    +    b.wait()
    +    while True:
    +        connection = make_connection()
    +        process_client_connection(connection)
    +
    +
    +
    +
    +class threading.Barrier(parties, action=None, timeout=None)
    +

    Create a barrier object for parties number of threads. An action, when +provided, is a callable to be called by one of the threads when they are +released. timeout is the default timeout value if none is specified for +the wait() method.

    +
    +
    +wait(timeout=None)
    +

    Pass the barrier. When all the threads party to the barrier have called +this function, they are all released simultaneously. If a timeout is +provided, it is used in preference to any that was supplied to the class +constructor.

    +

    The return value is an integer in the range 0 to parties – 1, different +for each thread. This can be used to select a thread to do some special +housekeeping, e.g.:

    +
    i = barrier.wait()
    +if i == 0:
    +    # Only one thread needs to print this
    +    print("passed the barrier")
    +
    +
    +

    If an action was provided to the constructor, one of the threads will +have called it prior to being released. Should this call raise an error, +the barrier is put into the broken state.

    +

    If the call times out, the barrier is put into the broken state.

    +

    This method may raise a BrokenBarrierError exception if the +barrier is broken or reset while a thread is waiting.

    +
    + +
    +
    +reset()
    +

    Return the barrier to the default, empty state. Any threads waiting on it +will receive the BrokenBarrierError exception.

    +

    Note that using this function may can require some external +synchronization if there are other threads whose state is unknown. If a +barrier is broken it may be better to just leave it and create a new one.

    +
    + +
    +
    +abort()
    +

    Put the barrier into a broken state. This causes any active or future +calls to wait() to fail with the BrokenBarrierError. Use +this for example if one of the needs to abort, to avoid deadlocking the +application.

    +

    It may be preferable to simply create the barrier with a sensible +timeout value to automatically guard against one of the threads going +awry.

    +
    + +
    +
    +parties
    +

    The number of threads required to pass the barrier.

    +
    + +
    +
    +n_waiting
    +

    The number of threads currently waiting in the barrier.

    +
    + +
    +
    +broken
    +

    A boolean that is True if the barrier is in the broken state.

    +
    + +
    + +
    +
    +exception threading.BrokenBarrierError
    +

    This exception, a subclass of RuntimeError, is raised when the +Barrier object is reset or broken.

    +
    + +
    +
    +

    Using locks, conditions, and semaphores in the with statement

    +

    All of the objects provided by this module that have acquire() and +release() methods can be used as context managers for a with +statement. The acquire() method will be called when the block is +entered, and release() will be called when the block is exited. Hence, +the following snippet:

    +
    with some_lock:
    +    # do something...
    +
    +
    +

    is equivalent to:

    +
    some_lock.acquire()
    +try:
    +    # do something...
    +finally:
    +    some_lock.release()
    +
    +
    +

    Currently, Lock, RLock, Condition, +Semaphore, and BoundedSemaphore objects may be used as +with statement context managers.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/time.html b/python-3.7.4-docs-html/library/time.html new file mode 100644 index 0000000..41d3f78 --- /dev/null +++ b/python-3.7.4-docs-html/library/time.html @@ -0,0 +1,1147 @@ + + + + + + + time — Time access and conversions — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    time — Time access and conversions

    +
    +

    This module provides various time-related functions. For related +functionality, see also the datetime and calendar modules.

    +

    Although this module is always available, +not all functions are available on all platforms. Most of the functions +defined in this module call platform C library functions with the same name. It +may sometimes be helpful to consult the platform documentation, because the +semantics of these functions varies among platforms.

    +

    An explanation of some terminology and conventions is in order.

    +
      +
    • The epoch is the point where the time starts, and is platform +dependent. For Unix, the epoch is January 1, 1970, 00:00:00 (UTC). +To find out what the epoch is on a given platform, look at +time.gmtime(0).

    • +
    +
      +
    • The term seconds since the epoch refers to the total number +of elapsed seconds since the epoch, typically excluding +leap seconds. Leap seconds are excluded from this total on all +POSIX-compliant platforms.

    • +
    +
      +
    • The functions in this module may not handle dates and times before the epoch or +far in the future. The cut-off point in the future is determined by the C +library; for 32-bit systems, it is typically in 2038.

    • +
    +
      +
    • Year 2000 (Y2K) issues: Python depends on the platform’s C library, which +generally doesn’t have year 2000 issues, since all dates and times are +represented internally as seconds since the epoch. Function strptime() +can parse 2-digit years when given %y format code. When 2-digit years are +parsed, they are converted according to the POSIX and ISO C standards: values +69–99 are mapped to 1969–1999, and values 0–68 are mapped to 2000–2068.

    • +
    +
      +
    • UTC is Coordinated Universal Time (formerly known as Greenwich Mean Time, or +GMT). The acronym UTC is not a mistake but a compromise between English and +French.

    • +
    +
      +
    • DST is Daylight Saving Time, an adjustment of the timezone by (usually) one +hour during part of the year. DST rules are magic (determined by local law) and +can change from year to year. The C library has a table containing the local +rules (often it is read from a system file for flexibility) and is the only +source of True Wisdom in this respect.

    • +
    • The precision of the various real-time functions may be less than suggested by +the units in which their value or argument is expressed. E.g. on most Unix +systems, the clock “ticks” only 50 or 100 times a second.

    • +
    • On the other hand, the precision of time() and sleep() is better +than their Unix equivalents: times are expressed as floating point numbers, +time() returns the most accurate time available (using Unix +gettimeofday() where available), and sleep() will accept a time +with a nonzero fraction (Unix select() is used to implement this, where +available).

    • +
    • The time value as returned by gmtime(), localtime(), and +strptime(), and accepted by asctime(), mktime() and +strftime(), is a sequence of 9 integers. The return values of +gmtime(), localtime(), and strptime() also offer attribute +names for individual fields.

      +

      See struct_time for a description of these objects.

      +
      +

      Changed in version 3.3: The struct_time type was extended to provide the tm_gmtoff +and tm_zone attributes when platform supports corresponding +struct tm members.

      +
      +
      +

      Changed in version 3.6: The struct_time attributes tm_gmtoff and tm_zone +are now available on all platforms.

      +
      +
    • +
    • Use the following functions to convert between time representations:

      + +++++ + + + + + + + + + + + + + + + + + + + + + + + + +

      From

      To

      Use

      seconds since the epoch

      struct_time in +UTC

      gmtime()

      seconds since the epoch

      struct_time in +local time

      localtime()

      struct_time in +UTC

      seconds since the epoch

      calendar.timegm()

      struct_time in +local time

      seconds since the epoch

      mktime()

      +
    • +
    +
    +

    Functions

    +
    +
    +time.asctime([t])
    +

    Convert a tuple or struct_time representing a time as returned by +gmtime() or localtime() to a string of the following +form: 'Sun Jun 20 23:21:05 1993'. If t is not provided, the current time +as returned by localtime() is used. Locale information is not used by +asctime().

    +
    +

    Note

    +

    Unlike the C function of the same name, asctime() does not add a +trailing newline.

    +
    +
    + +
    +
    +time.clock()
    +

    On Unix, return the current processor time as a floating point number expressed +in seconds. The precision, and in fact the very definition of the meaning of +“processor time”, depends on that of the C function of the same name.

    +

    On Windows, this function returns wall-clock seconds elapsed since the first +call to this function, as a floating point number, based on the Win32 function +QueryPerformanceCounter(). The resolution is typically better than one +microsecond.

    +
    +

    Deprecated since version 3.3, will be removed in version 3.8: The behaviour of this function depends on the platform: use +perf_counter() or process_time() instead, depending on your +requirements, to have a well defined behaviour.

    +
    +
    + +
    +
    +time.pthread_getcpuclockid(thread_id)
    +

    Return the clk_id of the thread-specific CPU-time clock for the specified thread_id.

    +

    Use threading.get_ident() or the ident +attribute of threading.Thread objects to get a suitable value +for thread_id.

    +
    +

    Warning

    +

    Passing an invalid or expired thread_id may result in +undefined behavior, such as segmentation fault.

    +
    +

    Availability: Unix (see the man page for pthread_getcpuclockid(3) for +further information).

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +time.clock_getres(clk_id)
    +

    Return the resolution (precision) of the specified clock clk_id. Refer to +Clock ID Constants for a list of accepted values for clk_id.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +time.clock_gettime(clk_id) → float
    +

    Return the time of the specified clock clk_id. Refer to +Clock ID Constants for a list of accepted values for clk_id.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +time.clock_gettime_ns(clk_id) → int
    +

    Similar to clock_gettime() but return time as nanoseconds.

    +

    Availability: Unix.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +time.clock_settime(clk_id, time: float)
    +

    Set the time of the specified clock clk_id. Currently, +CLOCK_REALTIME is the only accepted value for clk_id.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +time.clock_settime_ns(clk_id, time: int)
    +

    Similar to clock_settime() but set time with nanoseconds.

    +

    Availability: Unix.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +time.ctime([secs])
    +

    Convert a time expressed in seconds since the epoch to a string representing +local time. If secs is not provided or None, the current time as +returned by time() is used. ctime(secs) is equivalent to +asctime(localtime(secs)). Locale information is not used by ctime().

    +
    + +
    +
    +time.get_clock_info(name)
    +

    Get information on the specified clock as a namespace object. +Supported clock names and the corresponding functions to read their value +are:

    + +

    The result has the following attributes:

    +
      +
    • adjustable: True if the clock can be changed automatically (e.g. by +a NTP daemon) or manually by the system administrator, False otherwise

    • +
    • implementation: The name of the underlying C function used to get +the clock value. Refer to Clock ID Constants for possible values.

    • +
    • monotonic: True if the clock cannot go backward, +False otherwise

    • +
    • resolution: The resolution of the clock in seconds (float)

    • +
    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +time.gmtime([secs])
    +

    Convert a time expressed in seconds since the epoch to a struct_time in +UTC in which the dst flag is always zero. If secs is not provided or +None, the current time as returned by time() is used. Fractions +of a second are ignored. See above for a description of the +struct_time object. See calendar.timegm() for the inverse of this +function.

    +
    + +
    +
    +time.localtime([secs])
    +

    Like gmtime() but converts to local time. If secs is not provided or +None, the current time as returned by time() is used. The dst +flag is set to 1 when DST applies to the given time.

    +
    + +
    +
    +time.mktime(t)
    +

    This is the inverse function of localtime(). Its argument is the +struct_time or full 9-tuple (since the dst flag is needed; use -1 +as the dst flag if it is unknown) which expresses the time in local time, not +UTC. It returns a floating point number, for compatibility with time(). +If the input value cannot be represented as a valid time, either +OverflowError or ValueError will be raised (which depends on +whether the invalid value is caught by Python or the underlying C libraries). +The earliest date for which it can generate a time is platform-dependent.

    +
    + +
    +
    +time.monotonic() → float
    +

    Return the value (in fractional seconds) of a monotonic clock, i.e. a clock +that cannot go backwards. The clock is not affected by system clock updates. +The reference point of the returned value is undefined, so that only the +difference between the results of consecutive calls is valid.

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.5: The function is now always available and always system-wide.

    +
    +
    + +
    +
    +time.monotonic_ns() → int
    +

    Similar to monotonic(), but return time as nanoseconds.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +time.perf_counter() → float
    +

    Return the value (in fractional seconds) of a performance counter, i.e. a +clock with the highest available resolution to measure a short duration. It +does include time elapsed during sleep and is system-wide. The reference +point of the returned value is undefined, so that only the difference between +the results of consecutive calls is valid.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +time.perf_counter_ns() → int
    +

    Similar to perf_counter(), but return time as nanoseconds.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +time.process_time() → float
    +

    Return the value (in fractional seconds) of the sum of the system and user +CPU time of the current process. It does not include time elapsed during +sleep. It is process-wide by definition. The reference point of the +returned value is undefined, so that only the difference between the results +of consecutive calls is valid.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +time.process_time_ns() → int
    +

    Similar to process_time() but return time as nanoseconds.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +time.sleep(secs)
    +

    Suspend execution of the calling thread for the given number of seconds. +The argument may be a floating point number to indicate a more precise sleep +time. The actual suspension time may be less than that requested because any +caught signal will terminate the sleep() following execution of that +signal’s catching routine. Also, the suspension time may be longer than +requested by an arbitrary amount because of the scheduling of other activity +in the system.

    +
    +

    Changed in version 3.5: The function now sleeps at least secs even if the sleep is interrupted +by a signal, except if the signal handler raises an exception (see +PEP 475 for the rationale).

    +
    +
    + +
    +
    +time.strftime(format[, t])
    +

    Convert a tuple or struct_time representing a time as returned by +gmtime() or localtime() to a string as specified by the format +argument. If t is not provided, the current time as returned by +localtime() is used. format must be a string. ValueError is +raised if any field in t is outside of the allowed range.

    +

    0 is a legal argument for any position in the time tuple; if it is normally +illegal the value is forced to a correct one.

    +

    The following directives can be embedded in the format string. They are shown +without the optional field width and precision specification, and are replaced +by the indicated characters in the strftime() result:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Directive

    Meaning

    Notes

    %a

    Locale’s abbreviated weekday name.

    %A

    Locale’s full weekday name.

    %b

    Locale’s abbreviated month name.

    %B

    Locale’s full month name.

    %c

    Locale’s appropriate date and time +representation.

    %d

    Day of the month as a decimal number [01,31].

    %H

    Hour (24-hour clock) as a decimal number +[00,23].

    %I

    Hour (12-hour clock) as a decimal number +[01,12].

    %j

    Day of the year as a decimal number [001,366].

    %m

    Month as a decimal number [01,12].

    %M

    Minute as a decimal number [00,59].

    %p

    Locale’s equivalent of either AM or PM.

    (1)

    %S

    Second as a decimal number [00,61].

    (2)

    %U

    Week number of the year (Sunday as the first +day of the week) as a decimal number [00,53]. +All days in a new year preceding the first +Sunday are considered to be in week 0.

    (3)

    %w

    Weekday as a decimal number [0(Sunday),6].

    %W

    Week number of the year (Monday as the first +day of the week) as a decimal number [00,53]. +All days in a new year preceding the first +Monday are considered to be in week 0.

    (3)

    %x

    Locale’s appropriate date representation.

    %X

    Locale’s appropriate time representation.

    %y

    Year without century as a decimal number +[00,99].

    %Y

    Year with century as a decimal number.

    %z

    Time zone offset indicating a positive or +negative time difference from UTC/GMT of the +form +HHMM or -HHMM, where H represents decimal +hour digits and M represents decimal minute +digits [-23:59, +23:59].

    %Z

    Time zone name (no characters if no time zone +exists).

    %%

    A literal '%' character.

    +

    Notes:

    +
      +
    1. When used with the strptime() function, the %p directive only affects +the output hour field if the %I directive is used to parse the hour.

    2. +
    3. The range really is 0 to 61; value 60 is valid in +timestamps representing leap seconds and value 61 is supported +for historical reasons.

    4. +
    5. When used with the strptime() function, %U and %W are only used in +calculations when the day of the week and the year are specified.

    6. +
    +

    Here is an example, a format for dates compatible with that specified in the +RFC 2822 Internet email standard. 1

    +
    >>> from time import gmtime, strftime
    +>>> strftime("%a, %d %b %Y %H:%M:%S +0000", gmtime())
    +'Thu, 28 Jun 2001 14:17:15 +0000'
    +
    +
    +

    Additional directives may be supported on certain platforms, but only the +ones listed here have a meaning standardized by ANSI C. To see the full set +of format codes supported on your platform, consult the strftime(3) +documentation.

    +

    On some platforms, an optional field width and precision specification can +immediately follow the initial '%' of a directive in the following order; +this is also not portable. The field width is normally 2 except for %j where +it is 3.

    +
    + +
    +
    +time.strptime(string[, format])
    +

    Parse a string representing a time according to a format. The return value +is a struct_time as returned by gmtime() or +localtime().

    +

    The format parameter uses the same directives as those used by +strftime(); it defaults to "%a %b %d %H:%M:%S %Y" which matches the +formatting returned by ctime(). If string cannot be parsed according +to format, or if it has excess data after parsing, ValueError is +raised. The default values used to fill in any missing data when more +accurate values cannot be inferred are (1900, 1, 1, 0, 0, 0, 0, 1, -1). +Both string and format must be strings.

    +

    For example:

    +
    >>> import time
    +>>> time.strptime("30 Nov 00", "%d %b %y")   # doctest: +NORMALIZE_WHITESPACE
    +time.struct_time(tm_year=2000, tm_mon=11, tm_mday=30, tm_hour=0, tm_min=0,
    +                 tm_sec=0, tm_wday=3, tm_yday=335, tm_isdst=-1)
    +
    +
    +

    Support for the %Z directive is based on the values contained in tzname +and whether daylight is true. Because of this, it is platform-specific +except for recognizing UTC and GMT which are always known (and are considered to +be non-daylight savings timezones).

    +

    Only the directives specified in the documentation are supported. Because +strftime() is implemented per platform it can sometimes offer more +directives than those listed. But strptime() is independent of any platform +and thus does not necessarily support all directives available that are not +documented as supported.

    +
    + +
    +
    +class time.struct_time
    +

    The type of the time value sequence returned by gmtime(), +localtime(), and strptime(). It is an object with a named +tuple interface: values can be accessed by index and by attribute name. The +following values are present:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Index

    Attribute

    Values

    0

    tm_year

    (for example, 1993)

    1

    tm_mon

    range [1, 12]

    2

    tm_mday

    range [1, 31]

    3

    tm_hour

    range [0, 23]

    4

    tm_min

    range [0, 59]

    5

    tm_sec

    range [0, 61]; see (2) in +strftime() description

    6

    tm_wday

    range [0, 6], Monday is 0

    7

    tm_yday

    range [1, 366]

    8

    tm_isdst

    0, 1 or -1; see below

    N/A

    tm_zone

    abbreviation of timezone name

    N/A

    tm_gmtoff

    offset east of UTC in seconds

    +

    Note that unlike the C structure, the month value is a range of [1, 12], not +[0, 11].

    +

    In calls to mktime(), tm_isdst may be set to 1 when daylight +savings time is in effect, and 0 when it is not. A value of -1 indicates that +this is not known, and will usually result in the correct state being filled in.

    +

    When a tuple with an incorrect length is passed to a function expecting a +struct_time, or having elements of the wrong type, a +TypeError is raised.

    +
    + +
    +
    +time.time() → float
    +

    Return the time in seconds since the epoch as a floating point +number. The specific date of the epoch and the handling of +leap seconds is platform dependent. +On Windows and most Unix systems, the epoch is January 1, 1970, +00:00:00 (UTC) and leap seconds are not counted towards the time +in seconds since the epoch. This is commonly referred to as +Unix time. +To find out what the epoch is on a given platform, look at +gmtime(0).

    +

    Note that even though the time is always returned as a floating point +number, not all systems provide time with a better precision than 1 second. +While this function normally returns non-decreasing values, it can return a +lower value than a previous call if the system clock has been set back +between the two calls.

    +

    The number returned by time() may be converted into a more common +time format (i.e. year, month, day, hour, etc…) in UTC by passing it to +gmtime() function or in local time by passing it to the +localtime() function. In both cases a +struct_time object is returned, from which the components +of the calendar date may be accessed as attributes.

    +
    + +
    +
    +time.thread_time() → float
    +

    Return the value (in fractional seconds) of the sum of the system and user +CPU time of the current thread. It does not include time elapsed during +sleep. It is thread-specific by definition. The reference point of the +returned value is undefined, so that only the difference between the results +of consecutive calls in the same thread is valid.

    +

    Availability: Windows, Linux, Unix systems supporting +CLOCK_THREAD_CPUTIME_ID.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +time.thread_time_ns() → int
    +

    Similar to thread_time() but return time as nanoseconds.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +time.time_ns() → int
    +

    Similar to time() but returns time as an integer number of nanoseconds +since the epoch.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +time.tzset()
    +

    Reset the time conversion rules used by the library routines. The environment +variable TZ specifies how this is done. It will also set the variables +tzname (from the TZ environment variable), timezone (non-DST +seconds West of UTC), altzone (DST seconds west of UTC) and daylight +(to 0 if this timezone does not have any daylight saving time rules, or to +nonzero if there is a time, past, present or future when daylight saving time +applies).

    +

    Availability: Unix.

    +
    +

    Note

    +

    Although in many cases, changing the TZ environment variable may +affect the output of functions like localtime() without calling +tzset(), this behavior should not be relied on.

    +

    The TZ environment variable should contain no whitespace.

    +
    +

    The standard format of the TZ environment variable is (whitespace +added for clarity):

    +
    std offset [dst [offset [,start[/time], end[/time]]]]
    +
    +
    +

    Where the components are:

    +
    +
    std and dst

    Three or more alphanumerics giving the timezone abbreviations. These will be +propagated into time.tzname

    +
    +
    offset

    The offset has the form: ± hh[:mm[:ss]]. This indicates the value +added the local time to arrive at UTC. If preceded by a ‘-‘, the timezone +is east of the Prime Meridian; otherwise, it is west. If no offset follows +dst, summer time is assumed to be one hour ahead of standard time.

    +
    +
    start[/time], end[/time]

    Indicates when to change to and back from DST. The format of the +start and end dates are one of the following:

    +
    +
    Jn

    The Julian day n (1 <= n <= 365). Leap days are not counted, so in +all years February 28 is day 59 and March 1 is day 60.

    +
    +
    n

    The zero-based Julian day (0 <= n <= 365). Leap days are counted, and +it is possible to refer to February 29.

    +
    +
    Mm.n.d

    The d’th day (0 <= d <= 6) of week n of month m of the year (1 +<= n <= 5, 1 <= m <= 12, where week 5 means “the last d day in +month m” which may occur in either the fourth or the fifth +week). Week 1 is the first week in which the d’th day occurs. Day +zero is a Sunday.

    +
    +
    +

    time has the same format as offset except that no leading sign +(‘-‘ or ‘+’) is allowed. The default, if time is not given, is 02:00:00.

    +
    +
    +
    >>> os.environ['TZ'] = 'EST+05EDT,M4.1.0,M10.5.0'
    +>>> time.tzset()
    +>>> time.strftime('%X %x %Z')
    +'02:07:36 05/08/03 EDT'
    +>>> os.environ['TZ'] = 'AEST-10AEDT-11,M10.5.0,M3.5.0'
    +>>> time.tzset()
    +>>> time.strftime('%X %x %Z')
    +'16:08:12 05/08/03 AEST'
    +
    +
    +

    On many Unix systems (including *BSD, Linux, Solaris, and Darwin), it is more +convenient to use the system’s zoneinfo (tzfile(5)) database to +specify the timezone rules. To do this, set the TZ environment +variable to the path of the required timezone datafile, relative to the root of +the systems ‘zoneinfo’ timezone database, usually located at +/usr/share/zoneinfo. For example, 'US/Eastern', +'Australia/Melbourne', 'Egypt' or 'Europe/Amsterdam'.

    +
    >>> os.environ['TZ'] = 'US/Eastern'
    +>>> time.tzset()
    +>>> time.tzname
    +('EST', 'EDT')
    +>>> os.environ['TZ'] = 'Egypt'
    +>>> time.tzset()
    +>>> time.tzname
    +('EET', 'EEST')
    +
    +
    +
    + +
    +
    +

    Clock ID Constants

    +

    These constants are used as parameters for clock_getres() and +clock_gettime().

    +
    +
    +time.CLOCK_BOOTTIME
    +

    Identical to CLOCK_MONOTONIC, except it also includes any time that +the system is suspended.

    +

    This allows applications to get a suspend-aware monotonic clock without +having to deal with the complications of CLOCK_REALTIME, which may +have discontinuities if the time is changed using settimeofday() or +similar.

    +

    Availability: Linux 2.6.39 or later.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +time.CLOCK_HIGHRES
    +

    The Solaris OS has a CLOCK_HIGHRES timer that attempts to use an optimal +hardware source, and may give close to nanosecond resolution. +CLOCK_HIGHRES is the nonadjustable, high-resolution clock.

    +

    Availability: Solaris.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +time.CLOCK_MONOTONIC
    +

    Clock that cannot be set and represents monotonic time since some unspecified +starting point.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +time.CLOCK_MONOTONIC_RAW
    +

    Similar to CLOCK_MONOTONIC, but provides access to a raw +hardware-based time that is not subject to NTP adjustments.

    +

    Availability: Linux 2.6.28 and newer, macOS 10.12 and newer.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +time.CLOCK_PROCESS_CPUTIME_ID
    +

    High-resolution per-process timer from the CPU.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +time.CLOCK_PROF
    +

    High-resolution per-process timer from the CPU.

    +

    Availability: FreeBSD, NetBSD 7 or later, OpenBSD.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +time.CLOCK_THREAD_CPUTIME_ID
    +

    Thread-specific CPU-time clock.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +time.CLOCK_UPTIME
    +

    Time whose absolute value is the time the system has been running and not +suspended, providing accurate uptime measurement, both absolute and +interval.

    +

    Availability: FreeBSD, OpenBSD 5.5 or later.

    +
    +

    New in version 3.7.

    +
    +
    + +

    The following constant is the only parameter that can be sent to +clock_settime().

    +
    +
    +time.CLOCK_REALTIME
    +

    System-wide real-time clock. Setting this clock requires appropriate +privileges.

    +

    Availability: Unix.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +

    Timezone Constants

    +
    +
    +time.altzone
    +

    The offset of the local DST timezone, in seconds west of UTC, if one is defined. +This is negative if the local DST timezone is east of UTC (as in Western Europe, +including the UK). Only use this if daylight is nonzero. See note below.

    +
    + +
    +
    +time.daylight
    +

    Nonzero if a DST timezone is defined. See note below.

    +
    + +
    +
    +time.timezone
    +

    The offset of the local (non-DST) timezone, in seconds west of UTC (negative in +most of Western Europe, positive in the US, zero in the UK). See note below.

    +
    + +
    +
    +time.tzname
    +

    A tuple of two strings: the first is the name of the local non-DST timezone, the +second is the name of the local DST timezone. If no DST timezone is defined, +the second string should not be used. See note below.

    +
    + +
    +

    Note

    +

    For the above Timezone constants (altzone, daylight, timezone, +and tzname), the value is determined by the timezone rules in effect +at module load time or the last time tzset() is called and may be incorrect +for times in the past. It is recommended to use the tm_gmtoff and +tm_zone results from localtime() to obtain timezone information.

    +
    +
    +

    See also

    +
    +
    Module datetime

    More object-oriented interface to dates and times.

    +
    +
    Module locale

    Internationalization services. The locale setting affects the interpretation +of many format specifiers in strftime() and strptime().

    +
    +
    Module calendar

    General calendar-related functions. timegm() is the +inverse of gmtime() from this module.

    +
    +
    +
    +

    Footnotes

    +
    +
    1
    +

    The use of %Z is now deprecated, but the %z escape that expands to the +preferred hour/minute offset is not supported by all ANSI C libraries. Also, a +strict reading of the original 1982 RFC 822 standard calls for a two-digit +year (%y rather than %Y), but practice moved to 4-digit years long before the +year 2000. After that, RFC 822 became obsolete and the 4-digit year has +been first recommended by RFC 1123 and then mandated by RFC 2822.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/timeit.html b/python-3.7.4-docs-html/library/timeit.html new file mode 100644 index 0000000..f27fbb3 --- /dev/null +++ b/python-3.7.4-docs-html/library/timeit.html @@ -0,0 +1,547 @@ + + + + + + + timeit — Measure execution time of small code snippets — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    timeit — Measure execution time of small code snippets

    +

    Source code: Lib/timeit.py

    +
    +

    This module provides a simple way to time small bits of Python code. It has both +a Command-Line Interface as well as a callable +one. It avoids a number of common traps for measuring execution times. +See also Tim Peters’ introduction to the “Algorithms” chapter in the Python +Cookbook, published by O’Reilly.

    +
    +

    Basic Examples

    +

    The following example shows how the Command-Line Interface +can be used to compare three different expressions:

    +
    $ python3 -m timeit '"-".join(str(n) for n in range(100))'
    +10000 loops, best of 5: 30.2 usec per loop
    +$ python3 -m timeit '"-".join([str(n) for n in range(100)])'
    +10000 loops, best of 5: 27.5 usec per loop
    +$ python3 -m timeit '"-".join(map(str, range(100)))'
    +10000 loops, best of 5: 23.2 usec per loop
    +
    +
    +

    This can be achieved from the Python Interface with:

    +
    >>> import timeit
    +>>> timeit.timeit('"-".join(str(n) for n in range(100))', number=10000)
    +0.3018611848820001
    +>>> timeit.timeit('"-".join([str(n) for n in range(100)])', number=10000)
    +0.2727368790656328
    +>>> timeit.timeit('"-".join(map(str, range(100)))', number=10000)
    +0.23702679807320237
    +
    +
    +

    A callable can also be passed from the Python Interface:

    +
    >>> timeit.timeit(lambda: "-".join(map(str, range(100))), number=10000)
    +0.19665591977536678
    +
    +
    +

    Note however that timeit() will automatically determine the number of +repetitions only when the command-line interface is used. In the +Examples section you can find more advanced examples.

    +
    +
    +

    Python Interface

    +

    The module defines three convenience functions and a public class:

    +
    +
    +timeit.timeit(stmt='pass', setup='pass', timer=<default timer>, number=1000000, globals=None)
    +

    Create a Timer instance with the given statement, setup code and +timer function and run its timeit() method with number executions. +The optional globals argument specifies a namespace in which to execute the +code.

    +
    +

    Changed in version 3.5: The optional globals parameter was added.

    +
    +
    + +
    +
    +timeit.repeat(stmt='pass', setup='pass', timer=<default timer>, repeat=5, number=1000000, globals=None)
    +

    Create a Timer instance with the given statement, setup code and +timer function and run its repeat() method with the given repeat +count and number executions. The optional globals argument specifies a +namespace in which to execute the code.

    +
    +

    Changed in version 3.5: The optional globals parameter was added.

    +
    +
    +

    Changed in version 3.7: Default value of repeat changed from 3 to 5.

    +
    +
    + +
    +
    +timeit.default_timer()
    +

    The default timer, which is always time.perf_counter().

    +
    +

    Changed in version 3.3: time.perf_counter() is now the default timer.

    +
    +
    + +
    +
    +class timeit.Timer(stmt='pass', setup='pass', timer=<timer function>, globals=None)
    +

    Class for timing execution speed of small code snippets.

    +

    The constructor takes a statement to be timed, an additional statement used +for setup, and a timer function. Both statements default to 'pass'; +the timer function is platform-dependent (see the module doc string). +stmt and setup may also contain multiple statements separated by ; +or newlines, as long as they don’t contain multi-line string literals. The +statement will by default be executed within timeit’s namespace; this behavior +can be controlled by passing a namespace to globals.

    +

    To measure the execution time of the first statement, use the timeit() +method. The repeat() and autorange() methods are convenience +methods to call timeit() multiple times.

    +

    The execution time of setup is excluded from the overall timed execution run.

    +

    The stmt and setup parameters can also take objects that are callable +without arguments. This will embed calls to them in a timer function that +will then be executed by timeit(). Note that the timing overhead is a +little larger in this case because of the extra function calls.

    +
    +

    Changed in version 3.5: The optional globals parameter was added.

    +
    +
    +
    +timeit(number=1000000)
    +

    Time number executions of the main statement. This executes the setup +statement once, and then returns the time it takes to execute the main +statement a number of times, measured in seconds as a float. +The argument is the number of times through the loop, defaulting to one +million. The main statement, the setup statement and the timer function +to be used are passed to the constructor.

    +
    +

    Note

    +

    By default, timeit() temporarily turns off garbage +collection during the timing. The advantage of this approach is that +it makes independent timings more comparable. The disadvantage is +that GC may be an important component of the performance of the +function being measured. If so, GC can be re-enabled as the first +statement in the setup string. For example:

    +
    timeit.Timer('for i in range(10): oct(i)', 'gc.enable()').timeit()
    +
    +
    +
    +
    + +
    +
    +autorange(callback=None)
    +

    Automatically determine how many times to call timeit().

    +

    This is a convenience function that calls timeit() repeatedly +so that the total time >= 0.2 second, returning the eventual +(number of loops, time taken for that number of loops). It calls +timeit() with increasing numbers from the sequence 1, 2, 5, +10, 20, 50, … until the time taken is at least 0.2 second.

    +

    If callback is given and is not None, it will be called after +each trial with two arguments: callback(number, time_taken).

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +repeat(repeat=5, number=1000000)
    +

    Call timeit() a few times.

    +

    This is a convenience function that calls the timeit() repeatedly, +returning a list of results. The first argument specifies how many times +to call timeit(). The second argument specifies the number +argument for timeit().

    +
    +

    Note

    +

    It’s tempting to calculate mean and standard deviation from the result +vector and report these. However, this is not very useful. +In a typical case, the lowest value gives a lower bound for how fast +your machine can run the given code snippet; higher values in the +result vector are typically not caused by variability in Python’s +speed, but by other processes interfering with your timing accuracy. +So the min() of the result is probably the only number you +should be interested in. After that, you should look at the entire +vector and apply common sense rather than statistics.

    +
    +
    +

    Changed in version 3.7: Default value of repeat changed from 3 to 5.

    +
    +
    + +
    +
    +print_exc(file=None)
    +

    Helper to print a traceback from the timed code.

    +

    Typical use:

    +
    t = Timer(...)       # outside the try/except
    +try:
    +    t.timeit(...)    # or t.repeat(...)
    +except Exception:
    +    t.print_exc()
    +
    +
    +

    The advantage over the standard traceback is that source lines in the +compiled template will be displayed. The optional file argument directs +where the traceback is sent; it defaults to sys.stderr.

    +
    + +
    + +
    +
    +

    Command-Line Interface

    +

    When called as a program from the command line, the following form is used:

    +
    python -m timeit [-n N] [-r N] [-u U] [-s S] [-h] [statement ...]
    +
    +
    +

    Where the following options are understood:

    +
    +
    +-n N, --number=N
    +

    how many times to execute ‘statement’

    +
    + +
    +
    +-r N, --repeat=N
    +

    how many times to repeat the timer (default 5)

    +
    + +
    +
    +-s S, --setup=S
    +

    statement to be executed once initially (default pass)

    +
    + +
    +
    +-p, --process
    +

    measure process time, not wallclock time, using time.process_time() +instead of time.perf_counter(), which is the default

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +-u, --unit=U
    +
    +

    specify a time unit for timer output; can select nsec, usec, msec, or sec

    +
    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +-v, --verbose
    +

    print raw timing results; repeat for more digits precision

    +
    + +
    +
    +-h, --help
    +

    print a short usage message and exit

    +
    + +

    A multi-line statement may be given by specifying each line as a separate +statement argument; indented lines are possible by enclosing an argument in +quotes and using leading spaces. Multiple -s options are treated +similarly.

    +

    If -n is not given, a suitable number of loops is calculated by trying +successive powers of 10 until the total time is at least 0.2 seconds.

    +

    default_timer() measurements can be affected by other programs running on +the same machine, so the best thing to do when accurate timing is necessary is +to repeat the timing a few times and use the best time. The -r +option is good for this; the default of 5 repetitions is probably enough in +most cases. You can use time.process_time() to measure CPU time.

    +
    +

    Note

    +

    There is a certain baseline overhead associated with executing a pass statement. +The code here doesn’t try to hide it, but you should be aware of it. The +baseline overhead can be measured by invoking the program without arguments, +and it might differ between Python versions.

    +
    +
    +
    +

    Examples

    +

    It is possible to provide a setup statement that is executed only once at the beginning:

    +
    $ python -m timeit -s 'text = "sample string"; char = "g"'  'char in text'
    +5000000 loops, best of 5: 0.0877 usec per loop
    +$ python -m timeit -s 'text = "sample string"; char = "g"'  'text.find(char)'
    +1000000 loops, best of 5: 0.342 usec per loop
    +
    +
    +
    >>> import timeit
    +>>> timeit.timeit('char in text', setup='text = "sample string"; char = "g"')
    +0.41440500499993504
    +>>> timeit.timeit('text.find(char)', setup='text = "sample string"; char = "g"')
    +1.7246671520006203
    +
    +
    +

    The same can be done using the Timer class and its methods:

    +
    >>> import timeit
    +>>> t = timeit.Timer('char in text', setup='text = "sample string"; char = "g"')
    +>>> t.timeit()
    +0.3955516149999312
    +>>> t.repeat()
    +[0.40183617287970225, 0.37027556854118704, 0.38344867356679524, 0.3712595970846668, 0.37866875250654886]
    +
    +
    +

    The following examples show how to time expressions that contain multiple lines. +Here we compare the cost of using hasattr() vs. try/except +to test for missing and present object attributes:

    +
    $ python -m timeit 'try:' '  str.__bool__' 'except AttributeError:' '  pass'
    +20000 loops, best of 5: 15.7 usec per loop
    +$ python -m timeit 'if hasattr(str, "__bool__"): pass'
    +50000 loops, best of 5: 4.26 usec per loop
    +
    +$ python -m timeit 'try:' '  int.__bool__' 'except AttributeError:' '  pass'
    +200000 loops, best of 5: 1.43 usec per loop
    +$ python -m timeit 'if hasattr(int, "__bool__"): pass'
    +100000 loops, best of 5: 2.23 usec per loop
    +
    +
    +
    >>> import timeit
    +>>> # attribute is missing
    +>>> s = """\
    +... try:
    +...     str.__bool__
    +... except AttributeError:
    +...     pass
    +... """
    +>>> timeit.timeit(stmt=s, number=100000)
    +0.9138244460009446
    +>>> s = "if hasattr(str, '__bool__'): pass"
    +>>> timeit.timeit(stmt=s, number=100000)
    +0.5829014980008651
    +>>>
    +>>> # attribute is present
    +>>> s = """\
    +... try:
    +...     int.__bool__
    +... except AttributeError:
    +...     pass
    +... """
    +>>> timeit.timeit(stmt=s, number=100000)
    +0.04215312199994514
    +>>> s = "if hasattr(int, '__bool__'): pass"
    +>>> timeit.timeit(stmt=s, number=100000)
    +0.08588060699912603
    +
    +
    +

    To give the timeit module access to functions you define, you can pass a +setup parameter which contains an import statement:

    +
    def test():
    +    """Stupid test function"""
    +    L = [i for i in range(100)]
    +
    +if __name__ == '__main__':
    +    import timeit
    +    print(timeit.timeit("test()", setup="from __main__ import test"))
    +
    +
    +

    Another option is to pass globals() to the globals parameter, which will cause the code +to be executed within your current global namespace. This can be more convenient +than individually specifying imports:

    +
    def f(x):
    +    return x**2
    +def g(x):
    +    return x**4
    +def h(x):
    +    return x**8
    +
    +import timeit
    +print(timeit.timeit('[func(42) for func in (f,g,h)]', globals=globals()))
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/tk.html b/python-3.7.4-docs-html/library/tk.html new file mode 100644 index 0000000..5a13954 --- /dev/null +++ b/python-3.7.4-docs-html/library/tk.html @@ -0,0 +1,349 @@ + + + + + + + Graphical User Interfaces with Tk — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Graphical User Interfaces with Tk

    +

    Tk/Tcl has long been an integral part of Python. It provides a robust and +platform independent windowing toolkit, that is available to Python programmers +using the tkinter package, and its extension, the tkinter.tix and +the tkinter.ttk modules.

    +

    The tkinter package is a thin object-oriented layer on top of Tcl/Tk. To +use tkinter, you don’t need to write Tcl code, but you will need to +consult the Tk documentation, and occasionally the Tcl documentation. +tkinter is a set of wrappers that implement the Tk widgets as Python +classes. In addition, the internal module _tkinter provides a threadsafe +mechanism which allows Python and Tcl to interact.

    +

    tkinter’s chief virtues are that it is fast, and that it usually comes +bundled with Python. Although its standard documentation is weak, good +material is available, which includes: references, tutorials, a book and +others. tkinter is also famous for having an outdated look and feel, +which has been vastly improved in Tk 8.5. Nevertheless, there are many other +GUI libraries that you could be interested in. For more information about +alternatives, see the Other Graphical User Interface Packages section.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/tkinter.html b/python-3.7.4-docs-html/library/tkinter.html new file mode 100644 index 0000000..430673b --- /dev/null +++ b/python-3.7.4-docs-html/library/tkinter.html @@ -0,0 +1,1003 @@ + + + + + + + tkinter — Python interface to Tcl/Tk — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    tkinter — Python interface to Tcl/Tk

    +

    Source code: Lib/tkinter/__init__.py

    +
    +

    The tkinter package (“Tk interface”) is the standard Python interface to +the Tk GUI toolkit. Both Tk and tkinter are available on most Unix +platforms, as well as on Windows systems. (Tk itself is not part of Python; it +is maintained at ActiveState.)

    +

    Running python -m tkinter from the command line should open a window +demonstrating a simple Tk interface, letting you know that tkinter is +properly installed on your system, and also showing what version of Tcl/Tk is +installed, so you can read the Tcl/Tk documentation specific to that version.

    +
    +

    See also

    +

    Tkinter documentation:

    +
    +
    Python Tkinter Resources

    The Python Tkinter Topic Guide provides a great deal of information on using Tk +from Python and links to other sources of information on Tk.

    +
    +
    TKDocs

    Extensive tutorial plus friendlier widget pages for some of the widgets.

    +
    +
    Tkinter 8.5 reference: a GUI for Python

    On-line reference material.

    +
    +
    Tkinter docs from effbot

    Online reference for tkinter supported by effbot.org.

    +
    +
    Programming Python

    Book by Mark Lutz, has excellent coverage of Tkinter.

    +
    +
    Modern Tkinter for Busy Python Developers

    Book by Mark Roseman about building attractive and modern graphical user interfaces with Python and Tkinter.

    +
    +
    Python and Tkinter Programming

    Book by John Grayson (ISBN 1-884777-81-3).

    +
    +
    +

    Tcl/Tk documentation:

    +
    +
    Tk commands

    Most commands are available as tkinter or tkinter.ttk classes. +Change ‘8.6’ to match the version of your Tcl/Tk installation.

    +
    +
    Tcl/Tk recent man pages

    Recent Tcl/Tk manuals on www.tcl.tk.

    +
    +
    ActiveState Tcl Home Page

    The Tk/Tcl development is largely taking place at ActiveState.

    +
    +
    Tcl and the Tk Toolkit

    Book by John Ousterhout, the inventor of Tcl.

    +
    +
    Practical Programming in Tcl and Tk

    Brent Welch’s encyclopedic book.

    +
    +
    +
    +
    +

    Tkinter Modules

    +

    Most of the time, tkinter is all you really need, but a number of +additional modules are available as well. The Tk interface is located in a +binary module named _tkinter. This module contains the low-level +interface to Tk, and should never be used directly by application programmers. +It is usually a shared library (or DLL), but might in some cases be statically +linked with the Python interpreter.

    +

    In addition to the Tk interface module, tkinter includes a number of +Python modules, tkinter.constants being one of the most important. +Importing tkinter will automatically import tkinter.constants, +so, usually, to use Tkinter all you need is a simple import statement:

    +
    import tkinter
    +
    +
    +

    Or, more often:

    +
    from tkinter import *
    +
    +
    +
    +
    +class tkinter.Tk(screenName=None, baseName=None, className='Tk', useTk=1)
    +

    The Tk class is instantiated without arguments. This creates a toplevel +widget of Tk which usually is the main window of an application. Each instance +has its own associated Tcl interpreter.

    +
    + +
    +
    +tkinter.Tcl(screenName=None, baseName=None, className='Tk', useTk=0)
    +

    The Tcl() function is a factory function which creates an object much like +that created by the Tk class, except that it does not initialize the Tk +subsystem. This is most often useful when driving the Tcl interpreter in an +environment where one doesn’t want to create extraneous toplevel windows, or +where one cannot (such as Unix/Linux systems without an X server). An object +created by the Tcl() object can have a Toplevel window created (and the Tk +subsystem initialized) by calling its loadtk() method.

    +
    + +

    Other modules that provide Tk support include:

    +
    +
    tkinter.scrolledtext

    Text widget with a vertical scroll bar built in.

    +
    +
    tkinter.colorchooser

    Dialog to let the user choose a color.

    +
    +
    tkinter.commondialog

    Base class for the dialogs defined in the other modules listed here.

    +
    +
    tkinter.filedialog

    Common dialogs to allow the user to specify a file to open or save.

    +
    +
    tkinter.font

    Utilities to help work with fonts.

    +
    +
    tkinter.messagebox

    Access to standard Tk dialog boxes.

    +
    +
    tkinter.simpledialog

    Basic dialogs and convenience functions.

    +
    +
    tkinter.dnd

    Drag-and-drop support for tkinter. This is experimental and should +become deprecated when it is replaced with the Tk DND.

    +
    +
    turtle

    Turtle graphics in a Tk window.

    +
    +
    +
    +
    +

    Tkinter Life Preserver

    +

    This section is not designed to be an exhaustive tutorial on either Tk or +Tkinter. Rather, it is intended as a stop gap, providing some introductory +orientation on the system.

    +

    Credits:

    +
      +
    • Tk was written by John Ousterhout while at Berkeley.

    • +
    • Tkinter was written by Steen Lumholt and Guido van Rossum.

    • +
    • This Life Preserver was written by Matt Conway at the University of Virginia.

    • +
    • The HTML rendering, and some liberal editing, was produced from a FrameMaker +version by Ken Manheimer.

    • +
    • Fredrik Lundh elaborated and revised the class interface descriptions, to get +them current with Tk 4.2.

    • +
    • Mike Clarkson converted the documentation to LaTeX, and compiled the User +Interface chapter of the reference manual.

    • +
    +
    +

    How To Use This Section

    +

    This section is designed in two parts: the first half (roughly) covers +background material, while the second half can be taken to the keyboard as a +handy reference.

    +

    When trying to answer questions of the form “how do I do blah”, it is often best +to find out how to do “blah” in straight Tk, and then convert this back into the +corresponding tkinter call. Python programmers can often guess at the +correct Python command by looking at the Tk documentation. This means that in +order to use Tkinter, you will have to know a little bit about Tk. This document +can’t fulfill that role, so the best we can do is point you to the best +documentation that exists. Here are some hints:

    +
      +
    • The authors strongly suggest getting a copy of the Tk man pages. +Specifically, the man pages in the manN directory are most useful. +The man3 man pages describe the C interface to the Tk library and thus +are not especially helpful for script writers.

    • +
    • Addison-Wesley publishes a book called Tcl and the Tk Toolkit by John +Ousterhout (ISBN 0-201-63337-X) which is a good introduction to Tcl and Tk for +the novice. The book is not exhaustive, and for many details it defers to the +man pages.

    • +
    • tkinter/__init__.py is a last resort for most, but can be a good +place to go when nothing else makes sense.

    • +
    +
    +
    +

    A Simple Hello World Program

    +
    import tkinter as tk
    +
    +class Application(tk.Frame):
    +    def __init__(self, master=None):
    +        super().__init__(master)
    +        self.master = master
    +        self.pack()
    +        self.create_widgets()
    +
    +    def create_widgets(self):
    +        self.hi_there = tk.Button(self)
    +        self.hi_there["text"] = "Hello World\n(click me)"
    +        self.hi_there["command"] = self.say_hi
    +        self.hi_there.pack(side="top")
    +
    +        self.quit = tk.Button(self, text="QUIT", fg="red",
    +                              command=self.master.destroy)
    +        self.quit.pack(side="bottom")
    +
    +    def say_hi(self):
    +        print("hi there, everyone!")
    +
    +root = tk.Tk()
    +app = Application(master=root)
    +app.mainloop()
    +
    +
    +
    +
    +
    +

    A (Very) Quick Look at Tcl/Tk

    +

    The class hierarchy looks complicated, but in actual practice, application +programmers almost always refer to the classes at the very bottom of the +hierarchy.

    +

    Notes:

    +
      +
    • These classes are provided for the purposes of organizing certain functions +under one namespace. They aren’t meant to be instantiated independently.

    • +
    • The Tk class is meant to be instantiated only once in an application. +Application programmers need not instantiate one explicitly, the system creates +one whenever any of the other classes are instantiated.

    • +
    • The Widget class is not meant to be instantiated, it is meant only +for subclassing to make “real” widgets (in C++, this is called an ‘abstract +class’).

    • +
    +

    To make use of this reference material, there will be times when you will need +to know how to read short passages of Tk and how to identify the various parts +of a Tk command. (See section Mapping Basic Tk into Tkinter for the +tkinter equivalents of what’s below.)

    +

    Tk scripts are Tcl programs. Like all Tcl programs, Tk scripts are just lists +of tokens separated by spaces. A Tk widget is just its class, the options +that help configure it, and the actions that make it do useful things.

    +

    To make a widget in Tk, the command is always of the form:

    +
    classCommand newPathname options
    +
    +
    +
    +
    classCommand

    denotes which kind of widget to make (a button, a label, a menu…)

    +
    +
    +
    +
    newPathname

    is the new name for this widget. All names in Tk must be unique. To help +enforce this, widgets in Tk are named with pathnames, just like files in a +file system. The top level widget, the root, is called . (period) and +children are delimited by more periods. For example, +.myApp.controlPanel.okButton might be the name of a widget.

    +
    +
    options

    configure the widget’s appearance and in some cases, its behavior. The options +come in the form of a list of flags and values. Flags are preceded by a ‘-‘, +like Unix shell command flags, and values are put in quotes if they are more +than one word.

    +
    +
    +

    For example:

    +
    button   .fred   -fg red -text "hi there"
    +   ^       ^     \______________________/
    +   |       |                |
    + class    new            options
    +command  widget  (-opt val -opt val ...)
    +
    +
    +

    Once created, the pathname to the widget becomes a new command. This new +widget command is the programmer’s handle for getting the new widget to +perform some action. In C, you’d express this as someAction(fred, +someOptions), in C++, you would express this as fred.someAction(someOptions), +and in Tk, you say:

    +
    .fred someAction someOptions
    +
    +
    +

    Note that the object name, .fred, starts with a dot.

    +

    As you’d expect, the legal values for someAction will depend on the widget’s +class: .fred disable works if fred is a button (fred gets greyed out), but +does not work if fred is a label (disabling of labels is not supported in Tk).

    +

    The legal values of someOptions is action dependent. Some actions, like +disable, require no arguments, others, like a text-entry box’s delete +command, would need arguments to specify what range of text to delete.

    +
    +
    +

    Mapping Basic Tk into Tkinter

    +

    Class commands in Tk correspond to class constructors in Tkinter.

    +
    button .fred                =====>  fred = Button()
    +
    +
    +

    The master of an object is implicit in the new name given to it at creation +time. In Tkinter, masters are specified explicitly.

    +
    button .panel.fred          =====>  fred = Button(panel)
    +
    +
    +

    The configuration options in Tk are given in lists of hyphened tags followed by +values. In Tkinter, options are specified as keyword-arguments in the instance +constructor, and keyword-args for configure calls or as instance indices, in +dictionary style, for established instances. See section +Setting Options on setting options.

    +
    button .fred -fg red        =====>  fred = Button(panel, fg="red")
    +.fred configure -fg red     =====>  fred["fg"] = red
    +                            OR ==>  fred.config(fg="red")
    +
    +
    +

    In Tk, to perform an action on a widget, use the widget name as a command, and +follow it with an action name, possibly with arguments (options). In Tkinter, +you call methods on the class instance to invoke actions on the widget. The +actions (methods) that a given widget can perform are listed in +tkinter/__init__.py.

    +
    .fred invoke                =====>  fred.invoke()
    +
    +
    +

    To give a widget to the packer (geometry manager), you call pack with optional +arguments. In Tkinter, the Pack class holds all this functionality, and the +various forms of the pack command are implemented as methods. All widgets in +tkinter are subclassed from the Packer, and so inherit all the packing +methods. See the tkinter.tix module documentation for additional +information on the Form geometry manager.

    +
    pack .fred -side left       =====>  fred.pack(side="left")
    +
    +
    +
    + +
    +

    Handy Reference

    +
    +

    Setting Options

    +

    Options control things like the color and border width of a widget. Options can +be set in three ways:

    +
    +
    At object creation time, using keyword arguments
    fred = Button(self, fg="red", bg="blue")
    +
    +
    +
    +
    After object creation, treating the option name like a dictionary index
    fred["fg"] = "red"
    +fred["bg"] = "blue"
    +
    +
    +
    +
    Use the config() method to update multiple attrs subsequent to object creation
    fred.config(fg="red", bg="blue")
    +
    +
    +
    +
    +

    For a complete explanation of a given option and its behavior, see the Tk man +pages for the widget in question.

    +

    Note that the man pages list “STANDARD OPTIONS” and “WIDGET SPECIFIC OPTIONS” +for each widget. The former is a list of options that are common to many +widgets, the latter are the options that are idiosyncratic to that particular +widget. The Standard Options are documented on the options(3) man +page.

    +

    No distinction between standard and widget-specific options is made in this +document. Some options don’t apply to some kinds of widgets. Whether a given +widget responds to a particular option depends on the class of the widget; +buttons have a command option, labels do not.

    +

    The options supported by a given widget are listed in that widget’s man page, or +can be queried at runtime by calling the config() method without +arguments, or by calling the keys() method on that widget. The return +value of these calls is a dictionary whose key is the name of the option as a +string (for example, 'relief') and whose values are 5-tuples.

    +

    Some options, like bg are synonyms for common options with long names +(bg is shorthand for “background”). Passing the config() method the name +of a shorthand option will return a 2-tuple, not 5-tuple. The 2-tuple passed +back will contain the name of the synonym and the “real” option (such as +('bg', 'background')).

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Index

    Meaning

    Example

    0

    option name

    'relief'

    1

    option name for database lookup

    'relief'

    2

    option class for database +lookup

    'Relief'

    3

    default value

    'raised'

    4

    current value

    'groove'

    +

    Example:

    +
    >>> print(fred.config())
    +{'relief': ('relief', 'relief', 'Relief', 'raised', 'groove')}
    +
    +
    +

    Of course, the dictionary printed will include all the options available and +their values. This is meant only as an example.

    +
    +
    +

    The Packer

    +

    The packer is one of Tk’s geometry-management mechanisms. Geometry managers +are used to specify the relative positioning of the positioning of widgets +within their container - their mutual master. In contrast to the more +cumbersome placer (which is used less commonly, and we do not cover here), the +packer takes qualitative relationship specification - above, to the left of, +filling, etc - and works everything out to determine the exact placement +coordinates for you.

    +

    The size of any master widget is determined by the size of the “slave widgets” +inside. The packer is used to control where slave widgets appear inside the +master into which they are packed. You can pack widgets into frames, and frames +into other frames, in order to achieve the kind of layout you desire. +Additionally, the arrangement is dynamically adjusted to accommodate incremental +changes to the configuration, once it is packed.

    +

    Note that widgets do not appear until they have had their geometry specified +with a geometry manager. It’s a common early mistake to leave out the geometry +specification, and then be surprised when the widget is created but nothing +appears. A widget will appear only after it has had, for example, the packer’s +pack() method applied to it.

    +

    The pack() method can be called with keyword-option/value pairs that control +where the widget is to appear within its container, and how it is to behave when +the main application window is resized. Here are some examples:

    +
    fred.pack()                     # defaults to side = "top"
    +fred.pack(side="left")
    +fred.pack(expand=1)
    +
    +
    +
    +
    +

    Packer Options

    +

    For more extensive information on the packer and the options that it can take, +see the man pages and page 183 of John Ousterhout’s book.

    +
    +
    anchor

    Anchor type. Denotes where the packer is to place each slave in its parcel.

    +
    +
    expand

    Boolean, 0 or 1.

    +
    +
    fill

    Legal values: 'x', 'y', 'both', 'none'.

    +
    +
    ipadx and ipady

    A distance - designating internal padding on each side of the slave widget.

    +
    +
    padx and pady

    A distance - designating external padding on each side of the slave widget.

    +
    +
    side

    Legal values are: 'left', 'right', 'top', 'bottom'.

    +
    +
    +
    +
    +

    Coupling Widget Variables

    +

    The current-value setting of some widgets (like text entry widgets) can be +connected directly to application variables by using special options. These +options are variable, textvariable, onvalue, offvalue, and +value. This connection works both ways: if the variable changes for any +reason, the widget it’s connected to will be updated to reflect the new value.

    +

    Unfortunately, in the current implementation of tkinter it is not +possible to hand over an arbitrary Python variable to a widget through a +variable or textvariable option. The only kinds of variables for which +this works are variables that are subclassed from a class called Variable, +defined in tkinter.

    +

    There are many useful subclasses of Variable already defined: +StringVar, IntVar, DoubleVar, and +BooleanVar. To read the current value of such a variable, call the +get() method on it, and to change its value you call the set() +method. If you follow this protocol, the widget will always track the value of +the variable, with no further intervention on your part.

    +

    For example:

    +
    class App(Frame):
    +    def __init__(self, master=None):
    +        super().__init__(master)
    +        self.pack()
    +
    +        self.entrythingy = Entry()
    +        self.entrythingy.pack()
    +
    +        # here is the application variable
    +        self.contents = StringVar()
    +        # set it to some value
    +        self.contents.set("this is a variable")
    +        # tell the entry widget to watch this variable
    +        self.entrythingy["textvariable"] = self.contents
    +
    +        # and here we get a callback when the user hits return.
    +        # we will have the program print out the value of the
    +        # application variable when the user hits return
    +        self.entrythingy.bind('<Key-Return>',
    +                              self.print_contents)
    +
    +    def print_contents(self, event):
    +        print("hi. contents of entry is now ---->",
    +              self.contents.get())
    +
    +
    +
    +
    +

    The Window Manager

    +

    In Tk, there is a utility command, wm, for interacting with the window +manager. Options to the wm command allow you to control things like titles, +placement, icon bitmaps, and the like. In tkinter, these commands have +been implemented as methods on the Wm class. Toplevel widgets are +subclassed from the Wm class, and so can call the Wm methods +directly.

    +

    To get at the toplevel window that contains a given widget, you can often just +refer to the widget’s master. Of course if the widget has been packed inside of +a frame, the master won’t represent a toplevel window. To get at the toplevel +window that contains an arbitrary widget, you can call the _root() method. +This method begins with an underscore to denote the fact that this function is +part of the implementation, and not an interface to Tk functionality.

    +

    Here are some examples of typical usage:

    +
    import tkinter as tk
    +
    +class App(tk.Frame):
    +    def __init__(self, master=None):
    +        super().__init__(master)
    +        self.pack()
    +
    +# create the application
    +myapp = App()
    +
    +#
    +# here are method calls to the window manager class
    +#
    +myapp.master.title("My Do-Nothing Application")
    +myapp.master.maxsize(1000, 400)
    +
    +# start the program
    +myapp.mainloop()
    +
    +
    +
    +
    +

    Tk Option Data Types

    +
    +
    anchor

    Legal values are points of the compass: "n", "ne", "e", "se", +"s", "sw", "w", "nw", and also "center".

    +
    +
    bitmap

    There are eight built-in, named bitmaps: 'error', 'gray25', +'gray50', 'hourglass', 'info', 'questhead', 'question', +'warning'. To specify an X bitmap filename, give the full path to the file, +preceded with an @, as in "@/usr/contrib/bitmap/gumby.bit".

    +
    +
    boolean

    You can pass integers 0 or 1 or the strings "yes" or "no".

    +
    +
    callback

    This is any Python function that takes no arguments. For example:

    +
    def print_it():
    +    print("hi there")
    +fred["command"] = print_it
    +
    +
    +
    +
    color

    Colors can be given as the names of X colors in the rgb.txt file, or as strings +representing RGB values in 4 bit: "#RGB", 8 bit: "#RRGGBB", 12 bit” +"#RRRGGGBBB", or 16 bit "#RRRRGGGGBBBB" ranges, where R,G,B here +represent any legal hex digit. See page 160 of Ousterhout’s book for details.

    +
    +
    cursor

    The standard X cursor names from cursorfont.h can be used, without the +XC_ prefix. For example to get a hand cursor (XC_hand2), use the +string "hand2". You can also specify a bitmap and mask file of your own. +See page 179 of Ousterhout’s book.

    +
    +
    distance

    Screen distances can be specified in either pixels or absolute distances. +Pixels are given as numbers and absolute distances as strings, with the trailing +character denoting units: c for centimetres, i for inches, m for +millimetres, p for printer’s points. For example, 3.5 inches is expressed +as "3.5i".

    +
    +
    font

    Tk uses a list font name format, such as {courier 10 bold}. Font sizes with +positive numbers are measured in points; sizes with negative numbers are +measured in pixels.

    +
    +
    geometry

    This is a string of the form widthxheight, where width and height are +measured in pixels for most widgets (in characters for widgets displaying text). +For example: fred["geometry"] = "200x100".

    +
    +
    justify

    Legal values are the strings: "left", "center", "right", and +"fill".

    +
    +
    region

    This is a string with four space-delimited elements, each of which is a legal +distance (see above). For example: "2 3 4 5" and "3i 2i 4.5i 2i" and +"3c 2c 4c 10.43c" are all legal regions.

    +
    +
    relief

    Determines what the border style of a widget will be. Legal values are: +"raised", "sunken", "flat", "groove", and "ridge".

    +
    +
    scrollcommand

    This is almost always the set() method of some scrollbar widget, but can +be any widget method that takes a single argument.

    +
    +
    wrap:

    Must be one of: "none", "char", or "word".

    +
    +
    +
    +
    +

    Bindings and Events

    +

    The bind method from the widget command allows you to watch for certain events +and to have a callback function trigger when that event type occurs. The form +of the bind method is:

    +
    def bind(self, sequence, func, add=''):
    +
    +
    +

    where:

    +
    +
    sequence

    is a string that denotes the target kind of event. (See the bind man page and +page 201 of John Ousterhout’s book for details).

    +
    +
    func

    is a Python function, taking one argument, to be invoked when the event occurs. +An Event instance will be passed as the argument. (Functions deployed this way +are commonly known as callbacks.)

    +
    +
    add

    is optional, either '' or '+'. Passing an empty string denotes that +this binding is to replace any other bindings that this event is associated +with. Passing a '+' means that this function is to be added to the list +of functions bound to this event type.

    +
    +
    +

    For example:

    +
    def turn_red(self, event):
    +    event.widget["activeforeground"] = "red"
    +
    +self.button.bind("<Enter>", self.turn_red)
    +
    +
    +

    Notice how the widget field of the event is being accessed in the +turn_red() callback. This field contains the widget that caught the X +event. The following table lists the other event fields you can access, and how +they are denoted in Tk, which can be useful when referring to the Tk man pages.

    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Tk

    Tkinter Event Field

    Tk

    Tkinter Event Field

    %f

    focus

    %A

    char

    %h

    height

    %E

    send_event

    %k

    keycode

    %K

    keysym

    %s

    state

    %N

    keysym_num

    %t

    time

    %T

    type

    %w

    width

    %W

    widget

    %x

    x

    %X

    x_root

    %y

    y

    %Y

    y_root

    +
    +
    +

    The index Parameter

    +

    A number of widgets require “index” parameters to be passed. These are used to +point at a specific place in a Text widget, or to particular characters in an +Entry widget, or to particular menu items in a Menu widget.

    +
    +
    Entry widget indexes (index, view index, etc.)

    Entry widgets have options that refer to character positions in the text being +displayed. You can use these tkinter functions to access these special +points in text widgets:

    +
    +
    Text widget indexes

    The index notation for Text widgets is very rich and is best described in the Tk +man pages.

    +
    +
    Menu indexes (menu.invoke(), menu.entryconfig(), etc.)

    Some options and methods for menus manipulate specific menu entries. Anytime a +menu index is needed for an option or a parameter, you may pass in:

    +
      +
    • an integer which refers to the numeric position of the entry in the widget, +counted from the top, starting with 0;

    • +
    • the string "active", which refers to the menu position that is currently +under the cursor;

    • +
    • the string "last" which refers to the last menu item;

    • +
    • An integer preceded by @, as in @6, where the integer is interpreted +as a y pixel coordinate in the menu’s coordinate system;

    • +
    • the string "none", which indicates no menu entry at all, most often used +with menu.activate() to deactivate all entries, and finally,

    • +
    • a text string that is pattern matched against the label of the menu entry, as +scanned from the top of the menu to the bottom. Note that this index type is +considered after all the others, which means that matches for menu items +labelled last, active, or none may be interpreted as the above +literals, instead.

    • +
    +
    +
    +
    +
    +

    Images

    +

    Images of different formats can be created through the corresponding subclass +of tkinter.Image:

    +
      +
    • BitmapImage for images in XBM format.

    • +
    • PhotoImage for images in PGM, PPM, GIF and PNG formats. The latter +is supported starting with Tk 8.6.

    • +
    +

    Either type of image is created through either the file or the data +option (other options are available as well).

    +

    The image object can then be used wherever an image option is supported by +some widget (e.g. labels, buttons, menus). In these cases, Tk will not keep a +reference to the image. When the last Python reference to the image object is +deleted, the image data is deleted as well, and Tk will display an empty box +wherever the image was used.

    +
    +

    See also

    +

    The Pillow package adds support for +formats such as BMP, JPEG, TIFF, and WebP, among others.

    +
    +
    +
    +
    +

    File Handlers

    +

    Tk allows you to register and unregister a callback function which will be +called from the Tk mainloop when I/O is possible on a file descriptor. +Only one handler may be registered per file descriptor. Example code:

    +
    import tkinter
    +widget = tkinter.Tk()
    +mask = tkinter.READABLE | tkinter.WRITABLE
    +widget.tk.createfilehandler(file, mask, callback)
    +...
    +widget.tk.deletefilehandler(file)
    +
    +
    +

    This feature is not available on Windows.

    +

    Since you don’t know how many bytes are available for reading, you may not +want to use the BufferedIOBase or TextIOBase +read() or readline() methods, +since these will insist on reading a predefined number of bytes. +For sockets, the recv() or +recvfrom() methods will work fine; for other files, +use raw reads or os.read(file.fileno(), maxbytecount).

    +
    +
    +Widget.tk.createfilehandler(file, mask, func)
    +

    Registers the file handler callback function func. The file argument +may either be an object with a fileno() method (such as +a file or socket object), or an integer file descriptor. The mask +argument is an ORed combination of any of the three constants below. +The callback is called as follows:

    +
    callback(file, mask)
    +
    +
    +
    + +
    +
    +Widget.tk.deletefilehandler(file)
    +

    Unregisters a file handler.

    +
    + +
    +
    +tkinter.READABLE
    +
    +tkinter.WRITABLE
    +
    +tkinter.EXCEPTION
    +

    Constants used in the mask arguments.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/tkinter.scrolledtext.html b/python-3.7.4-docs-html/library/tkinter.scrolledtext.html new file mode 100644 index 0000000..d6fbec8 --- /dev/null +++ b/python-3.7.4-docs-html/library/tkinter.scrolledtext.html @@ -0,0 +1,208 @@ + + + + + + + tkinter.scrolledtext — Scrolled Text Widget — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    tkinter.scrolledtext — Scrolled Text Widget

    +

    Source code: Lib/tkinter/scrolledtext.py

    +
    +

    The tkinter.scrolledtext module provides a class of the same name which +implements a basic text widget which has a vertical scroll bar configured to do +the “right thing.” Using the ScrolledText class is a lot easier than +setting up a text widget and scroll bar directly. The constructor is the same +as that of the tkinter.Text class.

    +

    The text widget and scrollbar are packed together in a Frame, and the +methods of the Grid and Pack geometry managers are acquired +from the Frame object. This allows the ScrolledText widget to +be used directly to achieve most normal geometry management behavior.

    +

    Should more specific control be necessary, the following attributes are +available:

    +
    +
    +ScrolledText.frame
    +

    The frame which surrounds the text and scroll bar widgets.

    +
    + +
    +
    +ScrolledText.vbar
    +

    The scroll bar widget.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/tkinter.tix.html b/python-3.7.4-docs-html/library/tkinter.tix.html new file mode 100644 index 0000000..15800bb --- /dev/null +++ b/python-3.7.4-docs-html/library/tkinter.tix.html @@ -0,0 +1,655 @@ + + + + + + + tkinter.tix — Extension widgets for Tk — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    tkinter.tix — Extension widgets for Tk

    +

    Source code: Lib/tkinter/tix.py

    +
    +

    Deprecated since version 3.6: This Tk extension is unmaintained and should not be used in new code. Use +tkinter.ttk instead.

    +
    +
    +

    The tkinter.tix (Tk Interface Extension) module provides an additional +rich set of widgets. Although the standard Tk library has many useful widgets, +they are far from complete. The tkinter.tix library provides most of the +commonly needed widgets that are missing from standard Tk: HList, +ComboBox, Control (a.k.a. SpinBox) and an assortment of +scrollable widgets. +tkinter.tix also includes many more widgets that are generally useful in +a wide range of applications: NoteBook, FileEntry, +PanedWindow, etc; there are more than 40 of them.

    +

    With all these new widgets, you can introduce new interaction techniques into +applications, creating more useful and more intuitive user interfaces. You can +design your application by choosing the most appropriate widgets to match the +special needs of your application and users.

    +
    +

    See also

    +
    +
    Tix Homepage

    The home page for Tix. This includes links to additional documentation +and downloads.

    +
    +
    Tix Man Pages

    On-line version of the man pages and reference material.

    +
    +
    Tix Programming Guide

    On-line version of the programmer’s reference material.

    +
    +
    Tix Development Applications

    Tix applications for development of Tix and Tkinter programs. Tide applications +work under Tk or Tkinter, and include TixInspect, an inspector to +remotely modify and debug Tix/Tk/Tkinter applications.

    +
    +
    +
    +
    +

    Using Tix

    +
    +
    +class tkinter.tix.Tk(screenName=None, baseName=None, className='Tix')
    +

    Toplevel widget of Tix which represents mostly the main window of an +application. It has an associated Tcl interpreter.

    +

    Classes in the tkinter.tix module subclasses the classes in the +tkinter. The former imports the latter, so to use tkinter.tix +with Tkinter, all you need to do is to import one module. In general, you +can just import tkinter.tix, and replace the toplevel call to +tkinter.Tk with tix.Tk:

    +
    from tkinter import tix
    +from tkinter.constants import *
    +root = tix.Tk()
    +
    +
    +
    + +

    To use tkinter.tix, you must have the Tix widgets installed, usually +alongside your installation of the Tk widgets. To test your installation, try +the following:

    +
    from tkinter import tix
    +root = tix.Tk()
    +root.tk.eval('package require Tix')
    +
    +
    +
    +
    +

    Tix Widgets

    +

    Tix +introduces over 40 widget classes to the tkinter repertoire.

    +
    +

    Basic Widgets

    +
    +
    +class tkinter.tix.Balloon
    +

    A Balloon that +pops up over a widget to provide help. When the user moves the cursor inside a +widget to which a Balloon widget has been bound, a small pop-up window with a +descriptive message will be shown on the screen.

    +
    + +
    +
    +class tkinter.tix.ButtonBox
    +

    The ButtonBox +widget creates a box of buttons, such as is commonly used for Ok Cancel.

    +
    + +
    +
    +class tkinter.tix.ComboBox
    +

    The ComboBox +widget is similar to the combo box control in MS Windows. The user can select a +choice by either typing in the entry subwidget or selecting from the listbox +subwidget.

    +
    + +
    +
    +class tkinter.tix.Control
    +

    The Control +widget is also known as the SpinBox widget. The user can adjust the +value by pressing the two arrow buttons or by entering the value directly into +the entry. The new value will be checked against the user-defined upper and +lower limits.

    +
    + +
    +
    +class tkinter.tix.LabelEntry
    +

    The LabelEntry +widget packages an entry widget and a label into one mega widget. It can +be used to simplify the creation of “entry-form” type of interface.

    +
    + +
    +
    +class tkinter.tix.LabelFrame
    +

    The LabelFrame +widget packages a frame widget and a label into one mega widget. To create +widgets inside a LabelFrame widget, one creates the new widgets relative to the +frame subwidget and manage them inside the frame subwidget.

    +
    + +
    +
    +class tkinter.tix.Meter
    +

    The Meter widget +can be used to show the progress of a background job which may take a long time +to execute.

    +
    + +
    +
    +class tkinter.tix.OptionMenu
    +

    The OptionMenu +creates a menu button of options.

    +
    + +
    +
    +class tkinter.tix.PopupMenu
    +

    The PopupMenu +widget can be used as a replacement of the tk_popup command. The advantage +of the Tix PopupMenu widget is it requires less application code +to manipulate.

    +
    + +
    +
    +class tkinter.tix.Select
    +

    The Select widget +is a container of button subwidgets. It can be used to provide radio-box or +check-box style of selection options for the user.

    +
    + +
    +
    +class tkinter.tix.StdButtonBox
    +

    The StdButtonBox +widget is a group of standard buttons for Motif-like dialog boxes.

    +
    + +
    +
    +

    File Selectors

    +
    +
    +class tkinter.tix.DirList
    +

    The DirList +widget displays a list view of a directory, its previous directories and its +sub-directories. The user can choose one of the directories displayed in the +list or change to another directory.

    +
    + +
    +
    +class tkinter.tix.DirTree
    +

    The DirTree +widget displays a tree view of a directory, its previous directories and its +sub-directories. The user can choose one of the directories displayed in the +list or change to another directory.

    +
    + +
    +
    +class tkinter.tix.DirSelectDialog
    +

    The DirSelectDialog +widget presents the directories in the file system in a dialog window. The user +can use this dialog window to navigate through the file system to select the +desired directory.

    +
    + +
    +
    +class tkinter.tix.DirSelectBox
    +

    The DirSelectBox is similar to the standard Motif(TM) +directory-selection box. It is generally used for the user to choose a +directory. DirSelectBox stores the directories mostly recently selected into +a ComboBox widget so that they can be quickly selected again.

    +
    + +
    +
    +class tkinter.tix.ExFileSelectBox
    +

    The ExFileSelectBox +widget is usually embedded in a tixExFileSelectDialog widget. It provides a +convenient method for the user to select files. The style of the +ExFileSelectBox widget is very similar to the standard file dialog on +MS Windows 3.1.

    +
    + +
    +
    +class tkinter.tix.FileSelectBox
    +

    The FileSelectBox +is similar to the standard Motif(TM) file-selection box. It is generally used +for the user to choose a file. FileSelectBox stores the files mostly recently +selected into a ComboBox widget so that they can be quickly selected +again.

    +
    + +
    +
    +class tkinter.tix.FileEntry
    +

    The FileEntry +widget can be used to input a filename. The user can type in the filename +manually. Alternatively, the user can press the button widget that sits next to +the entry, which will bring up a file selection dialog.

    +
    + +
    +
    +

    Hierarchical ListBox

    +
    +
    +class tkinter.tix.HList
    +

    The HList widget +can be used to display any data that have a hierarchical structure, for example, +file system directory trees. The list entries are indented and connected by +branch lines according to their places in the hierarchy.

    +
    + +
    +
    +class tkinter.tix.CheckList
    +

    The CheckList +widget displays a list of items to be selected by the user. CheckList acts +similarly to the Tk checkbutton or radiobutton widgets, except it is capable of +handling many more items than checkbuttons or radiobuttons.

    +
    + +
    +
    +class tkinter.tix.Tree
    +

    The Tree widget +can be used to display hierarchical data in a tree form. The user can adjust the +view of the tree by opening or closing parts of the tree.

    +
    + +
    +
    +

    Tabular ListBox

    +
    +
    +class tkinter.tix.TList
    +

    The TList widget +can be used to display data in a tabular format. The list entries of a +TList widget are similar to the entries in the Tk listbox widget. The +main differences are (1) the TList widget can display the list entries +in a two dimensional format and (2) you can use graphical images as well as +multiple colors and fonts for the list entries.

    +
    + +
    +
    +

    Manager Widgets

    +
    +
    +class tkinter.tix.PanedWindow
    +

    The PanedWindow +widget allows the user to interactively manipulate the sizes of several panes. +The panes can be arranged either vertically or horizontally. The user changes +the sizes of the panes by dragging the resize handle between two panes.

    +
    + +
    +
    +class tkinter.tix.ListNoteBook
    +

    The ListNoteBook +widget is very similar to the TixNoteBook widget: it can be used to +display many windows in a limited space using a notebook metaphor. The notebook +is divided into a stack of pages (windows). At one time only one of these pages +can be shown. The user can navigate through these pages by choosing the name of +the desired page in the hlist subwidget.

    +
    + +
    +
    +class tkinter.tix.NoteBook
    +

    The NoteBook +widget can be used to display many windows in a limited space using a notebook +metaphor. The notebook is divided into a stack of pages. At one time only one of +these pages can be shown. The user can navigate through these pages by choosing +the visual “tabs” at the top of the NoteBook widget.

    +
    + +
    +
    +

    Image Types

    +

    The tkinter.tix module adds:

    +
      +
    • pixmap +capabilities to all tkinter.tix and tkinter widgets to create +color images from XPM files.

      +
    • +
    • Compound image +types can be used to create images that consists of multiple horizontal lines; +each line is composed of a series of items (texts, bitmaps, images or spaces) +arranged from left to right. For example, a compound image can be used to +display a bitmap and a text string simultaneously in a Tk Button +widget.

      +
    • +
    +
    +
    +

    Miscellaneous Widgets

    +
    +
    +class tkinter.tix.InputOnly
    +

    The InputOnly +widgets are to accept inputs from the user, which can be done with the bind +command (Unix only).

    +
    + +
    +
    +

    Form Geometry Manager

    +

    In addition, tkinter.tix augments tkinter by providing:

    +
    +
    +class tkinter.tix.Form
    +

    The Form geometry +manager based on attachment rules for all Tk widgets.

    +
    + +
    +
    +
    +

    Tix Commands

    +
    +
    +class tkinter.tix.tixCommand
    +

    The tix commands provide +access to miscellaneous elements of Tix’s internal state and the +Tix application context. Most of the information manipulated by these +methods pertains to the application as a whole, or to a screen or display, +rather than to a particular window.

    +

    To view the current settings, the common usage is:

    +
    from tkinter import tix
    +root = tix.Tk()
    +print(root.tix_configure())
    +
    +
    +
    + +
    +
    +tixCommand.tix_configure(cnf=None, **kw)
    +

    Query or modify the configuration options of the Tix application context. If no +option is specified, returns a dictionary all of the available options. If +option is specified with no value, then the method returns a list describing the +one named option (this list will be identical to the corresponding sublist of +the value returned if no option is specified). If one or more option-value +pairs are specified, then the method modifies the given option(s) to have the +given value(s); in this case the method returns an empty string. Option may be +any of the configuration options.

    +
    + +
    +
    +tixCommand.tix_cget(option)
    +

    Returns the current value of the configuration option given by option. Option +may be any of the configuration options.

    +
    + +
    +
    +tixCommand.tix_getbitmap(name)
    +

    Locates a bitmap file of the name name.xpm or name in one of the bitmap +directories (see the tix_addbitmapdir() method). By using +tix_getbitmap(), you can avoid hard coding the pathnames of the bitmap +files in your application. When successful, it returns the complete pathname of +the bitmap file, prefixed with the character @. The returned value can be +used to configure the bitmap option of the Tk and Tix widgets.

    +
    + +
    +
    +tixCommand.tix_addbitmapdir(directory)
    +

    Tix maintains a list of directories under which the tix_getimage() and +tix_getbitmap() methods will search for image files. The standard bitmap +directory is $TIX_LIBRARY/bitmaps. The tix_addbitmapdir() method +adds directory into this list. By using this method, the image files of an +applications can also be located using the tix_getimage() or +tix_getbitmap() method.

    +
    + +
    +
    +tixCommand.tix_filedialog([dlgclass])
    +

    Returns the file selection dialog that may be shared among different calls from +this application. This method will create a file selection dialog widget when +it is called the first time. This dialog will be returned by all subsequent +calls to tix_filedialog(). An optional dlgclass parameter can be passed +as a string to specified what type of file selection dialog widget is desired. +Possible options are tix, FileSelectDialog or tixExFileSelectDialog.

    +
    + +
    +
    +tixCommand.tix_getimage(self, name)
    +

    Locates an image file of the name name.xpm, name.xbm or +name.ppm in one of the bitmap directories (see the +tix_addbitmapdir() method above). If more than one file with the same name +(but different extensions) exist, then the image type is chosen according to the +depth of the X display: xbm images are chosen on monochrome displays and color +images are chosen on color displays. By using tix_getimage(), you can +avoid hard coding the pathnames of the image files in your application. When +successful, this method returns the name of the newly created image, which can +be used to configure the image option of the Tk and Tix widgets.

    +
    + +
    +
    +tixCommand.tix_option_get(name)
    +

    Gets the options maintained by the Tix scheme mechanism.

    +
    + +
    +
    +tixCommand.tix_resetoptions(newScheme, newFontSet[, newScmPrio])
    +

    Resets the scheme and fontset of the Tix application to newScheme and +newFontSet, respectively. This affects only those widgets created after this +call. Therefore, it is best to call the resetoptions method before the creation +of any widgets in a Tix application.

    +

    The optional parameter newScmPrio can be given to reset the priority level of +the Tk options set by the Tix schemes.

    +

    Because of the way Tk handles the X option database, after Tix has been has +imported and inited, it is not possible to reset the color schemes and font sets +using the tix_config() method. Instead, the tix_resetoptions() +method must be used.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/tkinter.ttk.html b/python-3.7.4-docs-html/library/tkinter.ttk.html new file mode 100644 index 0000000..06a8867 --- /dev/null +++ b/python-3.7.4-docs-html/library/tkinter.ttk.html @@ -0,0 +1,2009 @@ + + + + + + + tkinter.ttk — Tk themed widgets — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    tkinter.ttk — Tk themed widgets

    +

    Source code: Lib/tkinter/ttk.py

    +
    +

    The tkinter.ttk module provides access to the Tk themed widget set, +introduced in Tk 8.5. If Python has not been compiled against Tk 8.5, this +module can still be accessed if Tile has been installed. The former +method using Tk 8.5 provides additional benefits including anti-aliased font +rendering under X11 and window transparency (requiring a composition +window manager on X11).

    +

    The basic idea for tkinter.ttk is to separate, to the extent possible, +the code implementing a widget’s behavior from the code implementing its +appearance.

    +
    +

    See also

    +
    +
    Tk Widget Styling Support

    A document introducing theming support for Tk

    +
    +
    +
    +
    +

    Using Ttk

    +

    To start using Ttk, import its module:

    +
    from tkinter import ttk
    +
    +
    +

    To override the basic Tk widgets, the import should follow the Tk import:

    +
    from tkinter import *
    +from tkinter.ttk import *
    +
    +
    +

    That code causes several tkinter.ttk widgets (Button, +Checkbutton, Entry, Frame, Label, +LabelFrame, Menubutton, PanedWindow, +Radiobutton, Scale and Scrollbar) to +automatically replace the Tk widgets.

    +

    This has the direct benefit of using the new widgets which gives a better +look and feel across platforms; however, the replacement widgets are not +completely compatible. The main difference is that widget options such as +“fg”, “bg” and others related to widget styling are no +longer present in Ttk widgets. Instead, use the ttk.Style class +for improved styling effects.

    +
    +

    See also

    +
    +
    Converting existing applications to use Tile widgets

    A monograph (using Tcl terminology) about differences typically +encountered when moving applications to use the new widgets.

    +
    +
    +
    +
    +
    +

    Ttk Widgets

    +

    Ttk comes with 18 widgets, twelve of which already existed in tkinter: +Button, Checkbutton, Entry, Frame, +Label, LabelFrame, Menubutton, PanedWindow, +Radiobutton, Scale, Scrollbar, and Spinbox. +The other six are new: Combobox, Notebook, +Progressbar, Separator, Sizegrip and +Treeview. And all them are subclasses of Widget.

    +

    Using the Ttk widgets gives the application an improved look and feel. +As discussed above, there are differences in how the styling is coded.

    +

    Tk code:

    +
    l1 = tkinter.Label(text="Test", fg="black", bg="white")
    +l2 = tkinter.Label(text="Test", fg="black", bg="white")
    +
    +
    +

    Ttk code:

    +
    style = ttk.Style()
    +style.configure("BW.TLabel", foreground="black", background="white")
    +
    +l1 = ttk.Label(text="Test", style="BW.TLabel")
    +l2 = ttk.Label(text="Test", style="BW.TLabel")
    +
    +
    +

    For more information about TtkStyling, see the Style class +documentation.

    +
    +
    +

    Widget

    +

    ttk.Widget defines standard options and methods supported by Tk +themed widgets and is not supposed to be directly instantiated.

    +
    +

    Standard Options

    +

    All the ttk Widgets accepts the following options:

    +
    +
    ++++ + + + + + + + + + + + + + + + + + + + +

    Option

    Description

    class

    Specifies the window class. The class is used when querying +the option database for the window’s other options, to +determine the default bindtags for the window, and to select +the widget’s default layout and style. This option is +read-only, and may only be specified when the window is +created.

    cursor

    Specifies the mouse cursor to be used for the widget. If set +to the empty string (the default), the cursor is inherited +for the parent widget.

    takefocus

    Determines whether the window accepts the focus during +keyboard traversal. 0, 1 or an empty string is returned. +If 0 is returned, it means that the window should be skipped +entirely during keyboard traversal. If 1, it means that the +window should receive the input focus as long as it is +viewable. And an empty string means that the traversal +scripts make the decision about whether or not to focus +on the window.

    style

    May be used to specify a custom widget style.

    +
    +
    +
    +

    Scrollable Widget Options

    +

    The following options are supported by widgets that are controlled by a +scrollbar.

    +
    +
    ++++ + + + + + + + + + + + + + +

    Option

    Description

    xscrollcommand

    Used to communicate with horizontal scrollbars.

    +

    When the view in the widget’s window change, the widget +will generate a Tcl command based on the scrollcommand.

    +

    Usually this option consists of the method +Scrollbar.set() of some scrollbar. This will cause +the scrollbar to be updated whenever the view in the +window changes.

    +

    yscrollcommand

    Used to communicate with vertical scrollbars. +For some more information, see above.

    +
    +
    +
    +

    Label Options

    +

    The following options are supported by labels, buttons and other button-like +widgets.

    +
    +
    ++++ + + + + + + + + + + + + + + + + + + + + + + + + + +

    Option

    Description

    text

    Specifies a text string to be displayed inside the widget.

    textvariable

    Specifies a name whose value will be used in place of the +text option resource.

    underline

    If set, specifies the index (0-based) of a character to +underline in the text string. The underline character is +used for mnemonic activation.

    image

    Specifies an image to display. This is a list of 1 or more +elements. The first element is the default image name. The +rest of the list if a sequence of statespec/value pairs as +defined by Style.map(), specifying different images +to use when the widget is in a particular state or a +combination of states. All images in the list should have +the same size.

    compound

    Specifies how to display the image relative to the text, +in the case both text and images options are present. +Valid values are:

    +
      +
    • text: display text only

    • +
    • image: display image only

    • +
    • top, bottom, left, right: display image above, below, +left of, or right of the text, respectively.

    • +
    • none: the default. display the image if present, +otherwise the text.

    • +
    +

    width

    If greater than zero, specifies how much space, in +character widths, to allocate for the text label, if less +than zero, specifies a minimum width. If zero or +unspecified, the natural width of the text label is used.

    +
    +
    +
    +

    Compatibility Options

    +
    +
    ++++ + + + + + + + + + + +

    Option

    Description

    state

    May be set to “normal” or “disabled” to control the “disabled” +state bit. This is a write-only option: setting it changes the +widget state, but the Widget.state() method does not +affect this option.

    +
    +
    +
    +

    Widget States

    +

    The widget state is a bitmap of independent state flags.

    +
    +
    ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Flag

    Description

    active

    The mouse cursor is over the widget and pressing a mouse +button will cause some action to occur

    disabled

    Widget is disabled under program control

    focus

    Widget has keyboard focus

    pressed

    Widget is being pressed

    selected

    “On”, “true”, or “current” for things like Checkbuttons and +radiobuttons

    background

    Windows and Mac have a notion of an “active” or foreground +window. The background state is set for widgets in a +background window, and cleared for those in the foreground +window

    readonly

    Widget should not allow user modification

    alternate

    A widget-specific alternate display format

    invalid

    The widget’s value is invalid

    +
    +

    A state specification is a sequence of state names, optionally prefixed with +an exclamation point indicating that the bit is off.

    +
    +
    +

    ttk.Widget

    +

    Besides the methods described below, the ttk.Widget supports the +methods tkinter.Widget.cget() and tkinter.Widget.configure().

    +
    +
    +class tkinter.ttk.Widget
    +
    +
    +identify(x, y)
    +

    Returns the name of the element at position x y, or the empty string +if the point does not lie within any element.

    +

    x and y are pixel coordinates relative to the widget.

    +
    + +
    +
    +instate(statespec, callback=None, *args, **kw)
    +

    Test the widget’s state. If a callback is not specified, returns True +if the widget state matches statespec and False otherwise. If callback +is specified then it is called with args if widget state matches +statespec.

    +
    + +
    +
    +state(statespec=None)
    +

    Modify or inquire widget state. If statespec is specified, sets the +widget state according to it and return a new statespec indicating +which flags were changed. If statespec is not specified, returns +the currently-enabled state flags.

    +
    + +

    statespec will usually be a list or a tuple.

    +
    + +
    +
    +
    +

    Combobox

    +

    The ttk.Combobox widget combines a text field with a pop-down list of +values. This widget is a subclass of Entry.

    +

    Besides the methods inherited from Widget: Widget.cget(), +Widget.configure(), Widget.identify(), Widget.instate() +and Widget.state(), and the following inherited from Entry: +Entry.bbox(), Entry.delete(), Entry.icursor(), +Entry.index(), Entry.insert(), Entry.selection(), +Entry.xview(), it has some other methods, described at +ttk.Combobox.

    +
    +

    Options

    +

    This widget accepts the following specific options:

    +
    +
    ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Option

    Description

    exportselection

    Boolean value. If set, the widget selection is linked +to the Window Manager selection (which can be returned +by invoking Misc.selection_get, for example).

    justify

    Specifies how the text is aligned within the widget. +One of “left”, “center”, or “right”.

    height

    Specifies the height of the pop-down listbox, in rows.

    postcommand

    A script (possibly registered with Misc.register) that +is called immediately before displaying the values. It +may specify which values to display.

    state

    One of “normal”, “readonly”, or “disabled”. In the +“readonly” state, the value may not be edited directly, +and the user can only selection of the values from the +dropdown list. In the “normal” state, the text field is +directly editable. In the “disabled” state, no +interaction is possible.

    textvariable

    Specifies a name whose value is linked to the widget +value. Whenever the value associated with that name +changes, the widget value is updated, and vice versa. +See tkinter.StringVar.

    values

    Specifies the list of values to display in the +drop-down listbox.

    width

    Specifies an integer value indicating the desired width +of the entry window, in average-size characters of the +widget’s font.

    +
    +
    +
    +

    Virtual events

    +

    The combobox widgets generates a <<ComboboxSelected>> virtual event +when the user selects an element from the list of values.

    +
    +
    +

    ttk.Combobox

    +
    +
    +class tkinter.ttk.Combobox
    +
    +
    +current(newindex=None)
    +

    If newindex is specified, sets the combobox value to the element +position newindex. Otherwise, returns the index of the current value or +-1 if the current value is not in the values list.

    +
    + +
    +
    +get()
    +

    Returns the current value of the combobox.

    +
    + +
    +
    +set(value)
    +

    Sets the value of the combobox to value.

    +
    + +
    + +
    +
    +
    +

    Spinbox

    +

    The ttk.Spinbox widget is a ttk.Entry enhanced with increment +and decrement arrows. It can be used for numbers or lists of string values. +This widget is a subclass of Entry.

    +

    Besides the methods inherited from Widget: Widget.cget(), +Widget.configure(), Widget.identify(), Widget.instate() +and Widget.state(), and the following inherited from Entry: +Entry.bbox(), Entry.delete(), Entry.icursor(), +Entry.index(), Entry.insert(), Entry.xview(), +it has some other methods, described at ttk.Spinbox.

    +
    +

    Options

    +

    This widget accepts the following specific options:

    +
    +
    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Option

    Description

    from

    Float value. If set, this is the minimum value to +which the decrement button will decrement. Must be +spelled as from_ when used as an argument, since +from is a Python keyword.

    to

    Float value. If set, this is the maximum value to +which the increment button will increment.

    increment

    Float value. Specifies the amount which the +increment/decrement buttons change the +value. Defaults to 1.0.

    values

    Sequence of string or float values. If specified, +the increment/decrement buttons will cycle through +the items in this sequence rather than incrementing +or decrementing numbers.

    wrap

    Boolean value. If True, increment and decrement +buttons will cycle from the to value to the +from value or the from value to the to +value, respectively.

    format

    String value. This specifies the format of numbers +set by the increment/decrement buttons. It must be +in the form “%W.Pf”, where W is the padded width of +the value, P is the precision, and ‘%’ and ‘f’ are +literal.

    command

    Python callable. Will be called with no arguments +whenever either of the increment or decrement buttons +are pressed.

    +
    +
    +

    Virtual events

    +

    The spinbox widget generates an <<Increment>> virtual event when the +user presses <Up>, and a <<Decrement>> virtual event when the user +presses <Down>.

    +
    +
    +

    ttk.Spinbox

    +
    +
    +class tkinter.ttk.Spinbox
    +
    +
    +get()
    +

    Returns the current value of the spinbox.

    +
    + +
    +
    +set(value)
    +

    Sets the value of the spinbox to value.

    +
    + +
    + +
    +
    +
    +

    Notebook

    +

    Ttk Notebook widget manages a collection of windows and displays a single +one at a time. Each child window is associated with a tab, which the user +may select to change the currently-displayed window.

    +
    +

    Options

    +

    This widget accepts the following specific options:

    +
    +
    ++++ + + + + + + + + + + + + + + + + +

    Option

    Description

    height

    If present and greater than zero, specifies the desired height +of the pane area (not including internal padding or tabs). +Otherwise, the maximum height of all panes is used.

    padding

    Specifies the amount of extra space to add around the outside +of the notebook. The padding is a list up to four length +specifications left top right bottom. If fewer than four +elements are specified, bottom defaults to top, right defaults +to left, and top defaults to left.

    width

    If present and greater than zero, specified the desired width +of the pane area (not including internal padding). Otherwise, +the maximum width of all panes is used.

    +
    +
    +
    +

    Tab Options

    +

    There are also specific options for tabs:

    +
    +
    ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Option

    Description

    state

    Either “normal”, “disabled” or “hidden”. If “disabled”, then +the tab is not selectable. If “hidden”, then the tab is not +shown.

    sticky

    Specifies how the child window is positioned within the pane +area. Value is a string containing zero or more of the +characters “n”, “s”, “e” or “w”. Each letter refers to a +side (north, south, east or west) that the child window will +stick to, as per the grid() geometry manager.

    padding

    Specifies the amount of extra space to add between the +notebook and this pane. Syntax is the same as for the option +padding used by this widget.

    text

    Specifies a text to be displayed in the tab.

    image

    Specifies an image to display in the tab. See the option +image described in Widget.

    compound

    Specifies how to display the image relative to the text, in +the case both options text and image are present. See +Label Options for legal values.

    underline

    Specifies the index (0-based) of a character to underline in +the text string. The underlined character is used for +mnemonic activation if Notebook.enable_traversal() is +called.

    +
    +
    +
    +

    Tab Identifiers

    +

    The tab_id present in several methods of ttk.Notebook may take any +of the following forms:

    +
      +
    • An integer between zero and the number of tabs

    • +
    • The name of a child window

    • +
    • A positional specification of the form “@x,y”, which identifies the tab

    • +
    • The literal string “current”, which identifies the currently-selected tab

    • +
    • The literal string “end”, which returns the number of tabs (only valid for +Notebook.index())

    • +
    +
    +
    +

    Virtual Events

    +

    This widget generates a <<NotebookTabChanged>> virtual event after a new +tab is selected.

    +
    +
    +

    ttk.Notebook

    +
    +
    +class tkinter.ttk.Notebook
    +
    +
    +add(child, **kw)
    +

    Adds a new tab to the notebook.

    +

    If window is currently managed by the notebook but hidden, it is +restored to its previous position.

    +

    See Tab Options for the list of available options.

    +
    + +
    +
    +forget(tab_id)
    +

    Removes the tab specified by tab_id, unmaps and unmanages the +associated window.

    +
    + +
    +
    +hide(tab_id)
    +

    Hides the tab specified by tab_id.

    +

    The tab will not be displayed, but the associated window remains +managed by the notebook and its configuration remembered. Hidden tabs +may be restored with the add() command.

    +
    + +
    +
    +identify(x, y)
    +

    Returns the name of the tab element at position x, y, or the empty +string if none.

    +
    + +
    +
    +index(tab_id)
    +

    Returns the numeric index of the tab specified by tab_id, or the total +number of tabs if tab_id is the string “end”.

    +
    + +
    +
    +insert(pos, child, **kw)
    +

    Inserts a pane at the specified position.

    +

    pos is either the string “end”, an integer index, or the name of a +managed child. If child is already managed by the notebook, moves it to +the specified position.

    +

    See Tab Options for the list of available options.

    +
    + +
    +
    +select(tab_id=None)
    +

    Selects the specified tab_id.

    +

    The associated child window will be displayed, and the +previously-selected window (if different) is unmapped. If tab_id is +omitted, returns the widget name of the currently selected pane.

    +
    + +
    +
    +tab(tab_id, option=None, **kw)
    +

    Query or modify the options of the specific tab_id.

    +

    If kw is not given, returns a dictionary of the tab option values. If +option is specified, returns the value of that option. Otherwise, +sets the options to the corresponding values.

    +
    + +
    +
    +tabs()
    +

    Returns a list of windows managed by the notebook.

    +
    + +
    +
    +enable_traversal()
    +

    Enable keyboard traversal for a toplevel window containing this notebook.

    +

    This will extend the bindings for the toplevel window containing the +notebook as follows:

    +
      +
    • Control-Tab: selects the tab following the currently selected one.

    • +
    • Shift-Control-Tab: selects the tab preceding the currently selected one.

    • +
    • Alt-K: where K is the mnemonic (underlined) character of any tab, will +select that tab.

    • +
    +

    Multiple notebooks in a single toplevel may be enabled for traversal, +including nested notebooks. However, notebook traversal only works +properly if all panes have the notebook they are in as master.

    +
    + +
    + +
    +
    +
    +

    Progressbar

    +

    The ttk.Progressbar widget shows the status of a long-running +operation. It can operate in two modes: 1) the determinate mode which shows the +amount completed relative to the total amount of work to be done and 2) the +indeterminate mode which provides an animated display to let the user know that +work is progressing.

    +
    +

    Options

    +

    This widget accepts the following specific options:

    +
    +
    ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Option

    Description

    orient

    One of “horizontal” or “vertical”. Specifies the orientation +of the progress bar.

    length

    Specifies the length of the long axis of the progress bar +(width if horizontal, height if vertical).

    mode

    One of “determinate” or “indeterminate”.

    maximum

    A number specifying the maximum value. Defaults to 100.

    value

    The current value of the progress bar. In “determinate” mode, +this represents the amount of work completed. In +“indeterminate” mode, it is interpreted as modulo maximum; +that is, the progress bar completes one “cycle” when its value +increases by maximum.

    variable

    A name which is linked to the option value. If specified, the +value of the progress bar is automatically set to the value of +this name whenever the latter is modified.

    phase

    Read-only option. The widget periodically increments the value +of this option whenever its value is greater than 0 and, in +determinate mode, less than maximum. This option may be used +by the current theme to provide additional animation effects.

    +
    +
    +
    +

    ttk.Progressbar

    +
    +
    +class tkinter.ttk.Progressbar
    +
    +
    +start(interval=None)
    +

    Begin autoincrement mode: schedules a recurring timer event that calls +Progressbar.step() every interval milliseconds. If omitted, +interval defaults to 50 milliseconds.

    +
    + +
    +
    +step(amount=None)
    +

    Increments the progress bar’s value by amount.

    +

    amount defaults to 1.0 if omitted.

    +
    + +
    +
    +stop()
    +

    Stop autoincrement mode: cancels any recurring timer event initiated by +Progressbar.start() for this progress bar.

    +
    + +
    + +
    +
    +
    +

    Separator

    +

    The ttk.Separator widget displays a horizontal or vertical separator +bar.

    +

    It has no other methods besides the ones inherited from ttk.Widget.

    +
    +

    Options

    +

    This widget accepts the following specific option:

    +
    +
    ++++ + + + + + + + + + + +

    Option

    Description

    orient

    One of “horizontal” or “vertical”. Specifies the orientation of +the separator.

    +
    +
    +
    +
    +

    Sizegrip

    +

    The ttk.Sizegrip widget (also known as a grow box) allows the user to +resize the containing toplevel window by pressing and dragging the grip.

    +

    This widget has neither specific options nor specific methods, besides the +ones inherited from ttk.Widget.

    +
    +

    Platform-specific notes

    +
      +
    • On MacOS X, toplevel windows automatically include a built-in size grip +by default. Adding a Sizegrip is harmless, since the built-in +grip will just mask the widget.

    • +
    +
    +
    +

    Bugs

    +
      +
    • If the containing toplevel’s position was specified relative to the right +or bottom of the screen (e.g. ….), the Sizegrip widget will +not resize the window.

    • +
    • This widget supports only “southeast” resizing.

    • +
    +
    +
    +
    +

    Treeview

    +

    The ttk.Treeview widget displays a hierarchical collection of items. +Each item has a textual label, an optional image, and an optional list of data +values. The data values are displayed in successive columns after the tree +label.

    +

    The order in which data values are displayed may be controlled by setting +the widget option displaycolumns. The tree widget can also display column +headings. Columns may be accessed by number or symbolic names listed in the +widget option columns. See Column Identifiers.

    +

    Each item is identified by a unique name. The widget will generate item IDs +if they are not supplied by the caller. There is a distinguished root item, +named {}. The root item itself is not displayed; its children appear at the +top level of the hierarchy.

    +

    Each item also has a list of tags, which can be used to associate event bindings +with individual items and control the appearance of the item.

    +

    The Treeview widget supports horizontal and vertical scrolling, according to +the options described in Scrollable Widget Options and the methods +Treeview.xview() and Treeview.yview().

    +
    +

    Options

    +

    This widget accepts the following specific options:

    +
    +
    ++++ + + + + + + + + + + + + + + + + + + + + + + + + + +

    Option

    Description

    columns

    A list of column identifiers, specifying the number of +columns and their names.

    displaycolumns

    A list of column identifiers (either symbolic or +integer indices) specifying which data columns are +displayed and the order in which they appear, or the +string “#all”.

    height

    Specifies the number of rows which should be visible. +Note: the requested width is determined from the sum +of the column widths.

    padding

    Specifies the internal padding for the widget. The +padding is a list of up to four length specifications.

    selectmode

    Controls how the built-in class bindings manage the +selection. One of “extended”, “browse” or “none”. +If set to “extended” (the default), multiple items may +be selected. If “browse”, only a single item will be +selected at a time. If “none”, the selection will not +be changed.

    +

    Note that the application code and tag bindings can set +the selection however they wish, regardless of the +value of this option.

    +

    show

    A list containing zero or more of the following values, +specifying which elements of the tree to display.

    +
      +
    • tree: display tree labels in column #0.

    • +
    • headings: display the heading row.

    • +
    +

    The default is “tree headings”, i.e., show all +elements.

    +

    Note: Column #0 always refers to the tree column, +even if show=”tree” is not specified.

    +
    +
    +
    +
    +

    Item Options

    +

    The following item options may be specified for items in the insert and item +widget commands.

    +
    +
    ++++ + + + + + + + + + + + + + + + + + + + + + + +

    Option

    Description

    text

    The textual label to display for the item.

    image

    A Tk Image, displayed to the left of the label.

    values

    The list of values associated with the item.

    +

    Each item should have the same number of values as the widget +option columns. If there are fewer values than columns, the +remaining values are assumed empty. If there are more values +than columns, the extra values are ignored.

    +

    open

    True/False value indicating whether the item’s children should +be displayed or hidden.

    tags

    A list of tags associated with this item.

    +
    +
    +
    +

    Tag Options

    +

    The following options may be specified on tags:

    +
    +
    ++++ + + + + + + + + + + + + + + + + + + + +

    Option

    Description

    foreground

    Specifies the text foreground color.

    background

    Specifies the cell or item background color.

    font

    Specifies the font to use when drawing text.

    image

    Specifies the item image, in case the item’s image option +is empty.

    +
    +
    +
    +

    Column Identifiers

    +

    Column identifiers take any of the following forms:

    +
      +
    • A symbolic name from the list of columns option.

    • +
    • An integer n, specifying the nth data column.

    • +
    • A string of the form #n, where n is an integer, specifying the nth display +column.

    • +
    +

    Notes:

    +
      +
    • Item’s option values may be displayed in a different order than the order +in which they are stored.

    • +
    • Column #0 always refers to the tree column, even if show=”tree” is not +specified.

    • +
    +

    A data column number is an index into an item’s option values list; a display +column number is the column number in the tree where the values are displayed. +Tree labels are displayed in column #0. If option displaycolumns is not set, +then data column n is displayed in column #n+1. Again, column #0 always +refers to the tree column.

    +
    +
    +

    Virtual Events

    +

    The Treeview widget generates the following virtual events.

    +
    +
    ++++ + + + + + + + + + + + + + + + + +

    Event

    Description

    <<TreeviewSelect>>

    Generated whenever the selection changes.

    <<TreeviewOpen>>

    Generated just before settings the focus item to +open=True.

    <<TreeviewClose>>

    Generated just after setting the focus item to +open=False.

    +
    +

    The Treeview.focus() and Treeview.selection() methods can be used +to determine the affected item or items.

    +
    +
    +

    ttk.Treeview

    +
    +
    +class tkinter.ttk.Treeview
    +
    +
    +bbox(item, column=None)
    +

    Returns the bounding box (relative to the treeview widget’s window) of +the specified item in the form (x, y, width, height).

    +

    If column is specified, returns the bounding box of that cell. If the +item is not visible (i.e., if it is a descendant of a closed item or is +scrolled offscreen), returns an empty string.

    +
    + +
    +
    +get_children(item=None)
    +

    Returns the list of children belonging to item.

    +

    If item is not specified, returns root children.

    +
    + +
    +
    +set_children(item, *newchildren)
    +

    Replaces item’s child with newchildren.

    +

    Children present in item that are not present in newchildren are +detached from the tree. No items in newchildren may be an ancestor of +item. Note that not specifying newchildren results in detaching +item’s children.

    +
    + +
    +
    +column(column, option=None, **kw)
    +

    Query or modify the options for the specified column.

    +

    If kw is not given, returns a dict of the column option values. If +option is specified then the value for that option is returned. +Otherwise, sets the options to the corresponding values.

    +

    The valid options/values are:

    +
      +
    • +
      id

      Returns the column name. This is a read-only option.

      +
      +
      +
    • +
    • +
      anchor: One of the standard Tk anchor values.

      Specifies how the text in this column should be aligned with respect +to the cell.

      +
      +
      +
    • +
    • +
      minwidth: width

      The minimum width of the column in pixels. The treeview widget will +not make the column any smaller than specified by this option when +the widget is resized or the user drags a column.

      +
      +
      +
    • +
    • +
      stretch: True/False

      Specifies whether the column’s width should be adjusted when +the widget is resized.

      +
      +
      +
    • +
    • +
      width: width

      The width of the column in pixels.

      +
      +
      +
    • +
    +

    To configure the tree column, call this with column = “#0”

    +
    + +
    +
    +delete(*items)
    +

    Delete all specified items and all their descendants.

    +

    The root item may not be deleted.

    +
    + +
    +
    +detach(*items)
    +

    Unlinks all of the specified items from the tree.

    +

    The items and all of their descendants are still present, and may be +reinserted at another point in the tree, but will not be displayed.

    +

    The root item may not be detached.

    +
    + +
    +
    +exists(item)
    +

    Returns True if the specified item is present in the tree.

    +
    + +
    +
    +focus(item=None)
    +

    If item is specified, sets the focus item to item. Otherwise, returns +the current focus item, or ‘’ if there is none.

    +
    + +
    +
    +heading(column, option=None, **kw)
    +

    Query or modify the heading options for the specified column.

    +

    If kw is not given, returns a dict of the heading option values. If +option is specified then the value for that option is returned. +Otherwise, sets the options to the corresponding values.

    +

    The valid options/values are:

    +
      +
    • +
      text: text

      The text to display in the column heading.

      +
      +
      +
    • +
    • +
      image: imageName

      Specifies an image to display to the right of the column heading.

      +
      +
      +
    • +
    • +
      anchor: anchor

      Specifies how the heading text should be aligned. One of the standard +Tk anchor values.

      +
      +
      +
    • +
    • +
      command: callback

      A callback to be invoked when the heading label is pressed.

      +
      +
      +
    • +
    +

    To configure the tree column heading, call this with column = “#0”.

    +
    + +
    +
    +identify(component, x, y)
    +

    Returns a description of the specified component under the point given +by x and y, or the empty string if no such component is present at +that position.

    +
    + +
    +
    +identify_row(y)
    +

    Returns the item ID of the item at position y.

    +
    + +
    +
    +identify_column(x)
    +

    Returns the data column identifier of the cell at position x.

    +

    The tree column has ID #0.

    +
    + +
    +
    +identify_region(x, y)
    +

    Returns one of:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    region

    meaning

    heading

    Tree heading area.

    separator

    Space between two columns headings.

    tree

    The tree area.

    cell

    A data cell.

    +

    Availability: Tk 8.6.

    +
    + +
    +
    +identify_element(x, y)
    +

    Returns the element at position x, y.

    +

    Availability: Tk 8.6.

    +
    + +
    +
    +index(item)
    +

    Returns the integer index of item within its parent’s list of children.

    +
    + +
    +
    +insert(parent, index, iid=None, **kw)
    +

    Creates a new item and returns the item identifier of the newly created +item.

    +

    parent is the item ID of the parent item, or the empty string to create +a new top-level item. index is an integer, or the value “end”, +specifying where in the list of parent’s children to insert the new item. +If index is less than or equal to zero, the new node is inserted at +the beginning; if index is greater than or equal to the current number +of children, it is inserted at the end. If iid is specified, it is used +as the item identifier; iid must not already exist in the tree. +Otherwise, a new unique identifier is generated.

    +

    See Item Options for the list of available points.

    +
    + +
    +
    +item(item, option=None, **kw)
    +

    Query or modify the options for the specified item.

    +

    If no options are given, a dict with options/values for the item is +returned. +If option is specified then the value for that option is returned. +Otherwise, sets the options to the corresponding values as given by kw.

    +
    + +
    +
    +move(item, parent, index)
    +

    Moves item to position index in parent’s list of children.

    +

    It is illegal to move an item under one of its descendants. If index is +less than or equal to zero, item is moved to the beginning; if greater +than or equal to the number of children, it is moved to the end. If item +was detached it is reattached.

    +
    + +
    +
    +next(item)
    +

    Returns the identifier of item’s next sibling, or ‘’ if item is the +last child of its parent.

    +
    + +
    +
    +parent(item)
    +

    Returns the ID of the parent of item, or ‘’ if item is at the top +level of the hierarchy.

    +
    + +
    +
    +prev(item)
    +

    Returns the identifier of item’s previous sibling, or ‘’ if item is +the first child of its parent.

    +
    + +
    +
    +reattach(item, parent, index)
    +

    An alias for Treeview.move().

    +
    + +
    +
    +see(item)
    +

    Ensure that item is visible.

    +

    Sets all of item’s ancestors open option to True, and scrolls the +widget if necessary so that item is within the visible portion of +the tree.

    +
    + +
    +
    +selection(selop=None, items=None)
    +

    If selop is not specified, returns selected items. Otherwise, it will +act according to the following selection methods.

    +
    +

    Deprecated since version 3.6, will be removed in version 3.8: Using selection() for changing the selection state is deprecated. +Use the following selection methods instead.

    +
    +
    + +
    +
    +selection_set(*items)
    +

    items becomes the new selection.

    +
    +

    Changed in version 3.6: items can be passed as separate arguments, not just as a single tuple.

    +
    +
    + +
    +
    +selection_add(*items)
    +

    Add items to the selection.

    +
    +

    Changed in version 3.6: items can be passed as separate arguments, not just as a single tuple.

    +
    +
    + +
    +
    +selection_remove(*items)
    +

    Remove items from the selection.

    +
    +

    Changed in version 3.6: items can be passed as separate arguments, not just as a single tuple.

    +
    +
    + +
    +
    +selection_toggle(*items)
    +

    Toggle the selection state of each item in items.

    +
    +

    Changed in version 3.6: items can be passed as separate arguments, not just as a single tuple.

    +
    +
    + +
    +
    +set(item, column=None, value=None)
    +

    With one argument, returns a dictionary of column/value pairs for the +specified item. With two arguments, returns the current value of the +specified column. With three arguments, sets the value of given +column in given item to the specified value.

    +
    + +
    +
    +tag_bind(tagname, sequence=None, callback=None)
    +

    Bind a callback for the given event sequence to the tag tagname. +When an event is delivered to an item, the callbacks for each of the +item’s tags option are called.

    +
    + +
    +
    +tag_configure(tagname, option=None, **kw)
    +

    Query or modify the options for the specified tagname.

    +

    If kw is not given, returns a dict of the option settings for +tagname. If option is specified, returns the value for that option +for the specified tagname. Otherwise, sets the options to the +corresponding values for the given tagname.

    +
    + +
    +
    +tag_has(tagname, item=None)
    +

    If item is specified, returns 1 or 0 depending on whether the specified +item has the given tagname. Otherwise, returns a list of all items +that have the specified tag.

    +

    Availability: Tk 8.6

    +
    + +
    +
    +xview(*args)
    +

    Query or modify horizontal position of the treeview.

    +
    + +
    +
    +yview(*args)
    +

    Query or modify vertical position of the treeview.

    +
    + +
    + +
    +
    +
    +

    Ttk Styling

    +

    Each widget in ttk is assigned a style, which specifies the set of +elements making up the widget and how they are arranged, along with dynamic +and default settings for element options. By default the style name is the +same as the widget’s class name, but it may be overridden by the widget’s style +option. If you don’t know the class name of a widget, use the method +Misc.winfo_class() (somewidget.winfo_class()).

    +
    +

    See also

    +
    +
    Tcl‘2004 conference presentation

    This document explains how the theme engine works

    +
    +
    +
    +
    +
    +class tkinter.ttk.Style
    +

    This class is used to manipulate the style database.

    +
    +
    +configure(style, query_opt=None, **kw)
    +

    Query or set the default value of the specified option(s) in style.

    +

    Each key in kw is an option and each value is a string identifying +the value for that option.

    +

    For example, to change every default button to be a flat button with +some padding and a different background color:

    +
    from tkinter import ttk
    +import tkinter
    +
    +root = tkinter.Tk()
    +
    +ttk.Style().configure("TButton", padding=6, relief="flat",
    +   background="#ccc")
    +
    +btn = ttk.Button(text="Sample")
    +btn.pack()
    +
    +root.mainloop()
    +
    +
    +
    + +
    +
    +map(style, query_opt=None, **kw)
    +

    Query or sets dynamic values of the specified option(s) in style.

    +

    Each key in kw is an option and each value should be a list or a +tuple (usually) containing statespecs grouped in tuples, lists, or +some other preference. A statespec is a compound of one +or more states and then a value.

    +

    An example may make it more understandable:

    +
    import tkinter
    +from tkinter import ttk
    +
    +root = tkinter.Tk()
    +
    +style = ttk.Style()
    +style.map("C.TButton",
    +    foreground=[('pressed', 'red'), ('active', 'blue')],
    +    background=[('pressed', '!disabled', 'black'), ('active', 'white')]
    +    )
    +
    +colored_btn = ttk.Button(text="Test", style="C.TButton").pack()
    +
    +root.mainloop()
    +
    +
    +

    Note that the order of the (states, value) sequences for an option does +matter, if the order is changed to [('active', 'blue'), ('pressed', +'red')] in the foreground option, for example, the result would be a +blue foreground when the widget were in active or pressed states.

    +
    + +
    +
    +lookup(style, option, state=None, default=None)
    +

    Returns the value specified for option in style.

    +

    If state is specified, it is expected to be a sequence of one or more +states. If the default argument is set, it is used as a fallback value +in case no specification for option is found.

    +

    To check what font a Button uses by default:

    +
    from tkinter import ttk
    +
    +print(ttk.Style().lookup("TButton", "font"))
    +
    +
    +
    + +
    +
    +layout(style, layoutspec=None)
    +

    Define the widget layout for given style. If layoutspec is omitted, +return the layout specification for given style.

    +

    layoutspec, if specified, is expected to be a list or some other +sequence type (excluding strings), where each item should be a tuple and +the first item is the layout name and the second item should have the +format described in Layouts.

    +

    To understand the format, see the following example (it is not +intended to do anything useful):

    +
    from tkinter import ttk
    +import tkinter
    +
    +root = tkinter.Tk()
    +
    +style = ttk.Style()
    +style.layout("TMenubutton", [
    +   ("Menubutton.background", None),
    +   ("Menubutton.button", {"children":
    +       [("Menubutton.focus", {"children":
    +           [("Menubutton.padding", {"children":
    +               [("Menubutton.label", {"side": "left", "expand": 1})]
    +           })]
    +       })]
    +   }),
    +])
    +
    +mbtn = ttk.Menubutton(text='Text')
    +mbtn.pack()
    +root.mainloop()
    +
    +
    +
    + +
    +
    +element_create(elementname, etype, *args, **kw)
    +

    Create a new element in the current theme, of the given etype which is +expected to be either “image”, “from” or “vsapi”. The latter is only +available in Tk 8.6a for Windows XP and Vista and is not described here.

    +

    If “image” is used, args should contain the default image name followed +by statespec/value pairs (this is the imagespec), and kw may have the +following options:

    +
    +
      +
    • +
      border=padding

      padding is a list of up to four integers, specifying the left, top, +right, and bottom borders, respectively.

      +
      +
      +
    • +
    • +
      height=height

      Specifies a minimum height for the element. If less than zero, the +base image’s height is used as a default.

      +
      +
      +
    • +
    • +
      padding=padding

      Specifies the element’s interior padding. Defaults to border’s value +if not specified.

      +
      +
      +
    • +
    • +
      sticky=spec

      Specifies how the image is placed within the final parcel. spec +contains zero or more characters “n”, “s”, “w”, or “e”.

      +
      +
      +
    • +
    • +
      width=width

      Specifies a minimum width for the element. If less than zero, the +base image’s width is used as a default.

      +
      +
      +
    • +
    +
    +

    If “from” is used as the value of etype, +element_create() will clone an existing +element. args is expected to contain a themename, from which +the element will be cloned, and optionally an element to clone from. +If this element to clone from is not specified, an empty element will +be used. kw is discarded.

    +
    + +
    +
    +element_names()
    +

    Returns the list of elements defined in the current theme.

    +
    + +
    +
    +element_options(elementname)
    +

    Returns the list of elementname’s options.

    +
    + +
    +
    +theme_create(themename, parent=None, settings=None)
    +

    Create a new theme.

    +

    It is an error if themename already exists. If parent is specified, +the new theme will inherit styles, elements and layouts from the parent +theme. If settings are present they are expected to have the same +syntax used for theme_settings().

    +
    + +
    +
    +theme_settings(themename, settings)
    +

    Temporarily sets the current theme to themename, apply specified +settings and then restore the previous theme.

    +

    Each key in settings is a style and each value may contain the keys +‘configure’, ‘map’, ‘layout’ and ‘element create’ and they are expected +to have the same format as specified by the methods +Style.configure(), Style.map(), Style.layout() and +Style.element_create() respectively.

    +

    As an example, let’s change the Combobox for the default theme a bit:

    +
    from tkinter import ttk
    +import tkinter
    +
    +root = tkinter.Tk()
    +
    +style = ttk.Style()
    +style.theme_settings("default", {
    +   "TCombobox": {
    +       "configure": {"padding": 5},
    +       "map": {
    +           "background": [("active", "green2"),
    +                          ("!disabled", "green4")],
    +           "fieldbackground": [("!disabled", "green3")],
    +           "foreground": [("focus", "OliveDrab1"),
    +                          ("!disabled", "OliveDrab2")]
    +       }
    +   }
    +})
    +
    +combo = ttk.Combobox().pack()
    +
    +root.mainloop()
    +
    +
    +
    + +
    +
    +theme_names()
    +

    Returns a list of all known themes.

    +
    + +
    +
    +theme_use(themename=None)
    +

    If themename is not given, returns the theme in use. Otherwise, sets +the current theme to themename, refreshes all widgets and emits a +<<ThemeChanged>> event.

    +
    + +
    + +
    +

    Layouts

    +

    A layout can be just None, if it takes no options, or a dict of +options specifying how to arrange the element. The layout mechanism +uses a simplified version of the pack geometry manager: given an +initial cavity, each element is allocated a parcel. Valid +options/values are:

    +
    +
      +
    • +
      side: whichside

      Specifies which side of the cavity to place the element; one of +top, right, bottom or left. If omitted, the element occupies the +entire cavity.

      +
      +
      +
    • +
    • +
      sticky: nswe

      Specifies where the element is placed inside its allocated parcel.

      +
      +
      +
    • +
    • +
      unit: 0 or 1

      If set to 1, causes the element and all of its descendants to be treated as +a single element for the purposes of Widget.identify() et al. It’s +used for things like scrollbar thumbs with grips.

      +
      +
      +
    • +
    • +
      children: [sublayout… ]

      Specifies a list of elements to place inside the element. Each +element is a tuple (or other sequence type) where the first item is +the layout name, and the other is a Layout.

      +
      +
      +
    • +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/token.html b/python-3.7.4-docs-html/library/token.html new file mode 100644 index 0000000..15d477d --- /dev/null +++ b/python-3.7.4-docs-html/library/token.html @@ -0,0 +1,371 @@ + + + + + + + token — Constants used with Python parse trees — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    token — Constants used with Python parse trees

    +

    Source code: Lib/token.py

    +
    +

    This module provides constants which represent the numeric values of leaf nodes +of the parse tree (terminal tokens). Refer to the file Grammar/Grammar +in the Python distribution for the definitions of the names in the context of +the language grammar. The specific numeric values which the names map to may +change between Python versions.

    +

    The module also provides a mapping from numeric codes to names and some +functions. The functions mirror definitions in the Python C header files.

    +
    +
    +token.tok_name
    +

    Dictionary mapping the numeric values of the constants defined in this module +back to name strings, allowing more human-readable representation of parse trees +to be generated.

    +
    + +
    +
    +token.ISTERMINAL(x)
    +

    Return true for terminal token values.

    +
    + +
    +
    +token.ISNONTERMINAL(x)
    +

    Return true for non-terminal token values.

    +
    + +
    +
    +token.ISEOF(x)
    +

    Return true if x is the marker indicating the end of input.

    +
    + +

    The token constants are:

    +
    +
    +token.ENDMARKER
    +
    +token.NAME
    +
    +token.NUMBER
    +
    +token.STRING
    +
    +token.NEWLINE
    +
    +token.INDENT
    +
    +token.DEDENT
    +
    +token.LPAR
    +
    +token.RPAR
    +
    +token.LSQB
    +
    +token.RSQB
    +
    +token.COLON
    +
    +token.COMMA
    +
    +token.SEMI
    +
    +token.PLUS
    +
    +token.MINUS
    +
    +token.STAR
    +
    +token.SLASH
    +
    +token.VBAR
    +
    +token.AMPER
    +
    +token.LESS
    +
    +token.GREATER
    +
    +token.EQUAL
    +
    +token.DOT
    +
    +token.PERCENT
    +
    +token.LBRACE
    +
    +token.RBRACE
    +
    +token.EQEQUAL
    +
    +token.NOTEQUAL
    +
    +token.LESSEQUAL
    +
    +token.GREATEREQUAL
    +
    +token.TILDE
    +
    +token.CIRCUMFLEX
    +
    +token.LEFTSHIFT
    +
    +token.RIGHTSHIFT
    +
    +token.DOUBLESTAR
    +
    +token.PLUSEQUAL
    +
    +token.MINEQUAL
    +
    +token.STAREQUAL
    +
    +token.SLASHEQUAL
    +
    +token.PERCENTEQUAL
    +
    +token.AMPEREQUAL
    +
    +token.VBAREQUAL
    +
    +token.CIRCUMFLEXEQUAL
    +
    +token.LEFTSHIFTEQUAL
    +
    +token.RIGHTSHIFTEQUAL
    +
    +token.DOUBLESTAREQUAL
    +
    +token.DOUBLESLASH
    +
    +token.DOUBLESLASHEQUAL
    +
    +token.AT
    +
    +token.ATEQUAL
    +
    +token.RARROW
    +
    +token.ELLIPSIS
    +
    +token.OP
    +
    +token.ERRORTOKEN
    +
    +token.N_TOKENS
    +
    +token.NT_OFFSET
    +
    + +

    The following token type values aren’t used by the C tokenizer but are needed for +the tokenize module.

    +
    +
    +token.COMMENT
    +

    Token value used to indicate a comment.

    +
    + +
    +
    +token.NL
    +

    Token value used to indicate a non-terminating newline. The +NEWLINE token indicates the end of a logical line of Python code; +NL tokens are generated when a logical line of code is continued over +multiple physical lines.

    +
    + +
    +
    +token.ENCODING
    +

    Token value that indicates the encoding used to decode the source bytes +into text. The first token returned by tokenize.tokenize() will +always be an ENCODING token.

    +
    + +
    +

    Changed in version 3.5: Added AWAIT and ASYNC tokens.

    +
    +
    +

    Changed in version 3.7: Added COMMENT, NL and ENCODING tokens.

    +
    +
    +

    Changed in version 3.7: Removed AWAIT and ASYNC tokens. “async” and “await” are +now tokenized as NAME tokens.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/tokenize.html b/python-3.7.4-docs-html/library/tokenize.html new file mode 100644 index 0000000..8f0c111 --- /dev/null +++ b/python-3.7.4-docs-html/library/tokenize.html @@ -0,0 +1,436 @@ + + + + + + + tokenize — Tokenizer for Python source — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    tokenize — Tokenizer for Python source

    +

    Source code: Lib/tokenize.py

    +
    +

    The tokenize module provides a lexical scanner for Python source code, +implemented in Python. The scanner in this module returns comments as tokens +as well, making it useful for implementing “pretty-printers,” including +colorizers for on-screen displays.

    +

    To simplify token stream handling, all operator and +delimiter tokens and Ellipsis are returned using +the generic OP token type. The exact +type can be determined by checking the exact_type property on the +named tuple returned from tokenize.tokenize().

    +
    +

    Tokenizing Input

    +

    The primary entry point is a generator:

    +
    +
    +tokenize.tokenize(readline)
    +

    The tokenize() generator requires one argument, readline, which +must be a callable object which provides the same interface as the +io.IOBase.readline() method of file objects. Each call to the +function should return one line of input as bytes.

    +

    The generator produces 5-tuples with these members: the token type; the +token string; a 2-tuple (srow, scol) of ints specifying the row and +column where the token begins in the source; a 2-tuple (erow, ecol) of +ints specifying the row and column where the token ends in the source; and +the line on which the token was found. The line passed (the last tuple item) +is the logical line; continuation lines are included. The 5 tuple is +returned as a named tuple with the field names: +type string start end line.

    +

    The returned named tuple has an additional property named +exact_type that contains the exact operator type for +OP tokens. For all other token types exact_type +equals the named tuple type field.

    +
    +

    Changed in version 3.1: Added support for named tuples.

    +
    +
    +

    Changed in version 3.3: Added support for exact_type.

    +
    +

    tokenize() determines the source encoding of the file by looking for a +UTF-8 BOM or encoding cookie, according to PEP 263.

    +
    + +

    All constants from the token module are also exported from +tokenize.

    +

    Another function is provided to reverse the tokenization process. This is +useful for creating tools that tokenize a script, modify the token stream, and +write back the modified script.

    +
    +
    +tokenize.untokenize(iterable)
    +

    Converts tokens back into Python source code. The iterable must return +sequences with at least two elements, the token type and the token string. +Any additional sequence elements are ignored.

    +

    The reconstructed script is returned as a single string. The result is +guaranteed to tokenize back to match the input so that the conversion is +lossless and round-trips are assured. The guarantee applies only to the +token type and token string as the spacing between tokens (column +positions) may change.

    +

    It returns bytes, encoded using the ENCODING token, which +is the first token sequence output by tokenize().

    +
    + +

    tokenize() needs to detect the encoding of source files it tokenizes. The +function it uses to do this is available:

    +
    +
    +tokenize.detect_encoding(readline)
    +

    The detect_encoding() function is used to detect the encoding that +should be used to decode a Python source file. It requires one argument, +readline, in the same way as the tokenize() generator.

    +

    It will call readline a maximum of twice, and return the encoding used +(as a string) and a list of any lines (not decoded from bytes) it has read +in.

    +

    It detects the encoding from the presence of a UTF-8 BOM or an encoding +cookie as specified in PEP 263. If both a BOM and a cookie are present, +but disagree, a SyntaxError will be raised. Note that if the BOM is found, +'utf-8-sig' will be returned as an encoding.

    +

    If no encoding is specified, then the default of 'utf-8' will be +returned.

    +

    Use open() to open Python source files: it uses +detect_encoding() to detect the file encoding.

    +
    + +
    +
    +tokenize.open(filename)
    +

    Open a file in read only mode using the encoding detected by +detect_encoding().

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +exception tokenize.TokenError
    +

    Raised when either a docstring or expression that may be split over several +lines is not completed anywhere in the file, for example:

    +
    """Beginning of
    +docstring
    +
    +
    +

    or:

    +
    [1,
    + 2,
    + 3
    +
    +
    +
    + +

    Note that unclosed single-quoted strings do not cause an error to be +raised. They are tokenized as ERRORTOKEN, followed by the +tokenization of their contents.

    +
    +
    +

    Command-Line Usage

    +
    +

    New in version 3.3.

    +
    +

    The tokenize module can be executed as a script from the command line. +It is as simple as:

    +
    python -m tokenize [-e] [filename.py]
    +
    +
    +

    The following options are accepted:

    +
    +
    +-h, --help
    +

    show this help message and exit

    +
    + +
    +
    +-e, --exact
    +

    display token names using the exact type

    +
    + +

    If filename.py is specified its contents are tokenized to stdout. +Otherwise, tokenization is performed on stdin.

    +
    +
    +

    Examples

    +

    Example of a script rewriter that transforms float literals into Decimal +objects:

    +
    from tokenize import tokenize, untokenize, NUMBER, STRING, NAME, OP
    +from io import BytesIO
    +
    +def decistmt(s):
    +    """Substitute Decimals for floats in a string of statements.
    +
    +    >>> from decimal import Decimal
    +    >>> s = 'print(+21.3e-5*-.1234/81.7)'
    +    >>> decistmt(s)
    +    "print (+Decimal ('21.3e-5')*-Decimal ('.1234')/Decimal ('81.7'))"
    +
    +    The format of the exponent is inherited from the platform C library.
    +    Known cases are "e-007" (Windows) and "e-07" (not Windows).  Since
    +    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
    +    -3.21716034272e-0...7
    +
    +    Output from calculations with Decimal should be identical across all
    +    platforms.
    +
    +    >>> exec(decistmt(s))
    +    -3.217160342717258261933904529E-7
    +    """
    +    result = []
    +    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'),
    +                (OP, '('),
    +                (STRING, repr(tokval)),
    +                (OP, ')')
    +            ])
    +        else:
    +            result.append((toknum, tokval))
    +    return untokenize(result).decode('utf-8')
    +
    +
    +

    Example of tokenizing from the command line. The script:

    +
    def say_hello():
    +    print("Hello, World!")
    +
    +say_hello()
    +
    +
    +

    will be tokenized to the following output where the first column is the range +of the line/column coordinates where the token is found, the second column is +the name of the token, and the final column is the value of the token (if any)

    +
    $ python -m tokenize hello.py
    +0,0-0,0:            ENCODING       'utf-8'
    +1,0-1,3:            NAME           'def'
    +1,4-1,13:           NAME           'say_hello'
    +1,13-1,14:          OP             '('
    +1,14-1,15:          OP             ')'
    +1,15-1,16:          OP             ':'
    +1,16-1,17:          NEWLINE        '\n'
    +2,0-2,4:            INDENT         '    '
    +2,4-2,9:            NAME           'print'
    +2,9-2,10:           OP             '('
    +2,10-2,25:          STRING         '"Hello, World!"'
    +2,25-2,26:          OP             ')'
    +2,26-2,27:          NEWLINE        '\n'
    +3,0-3,1:            NL             '\n'
    +4,0-4,0:            DEDENT         ''
    +4,0-4,9:            NAME           'say_hello'
    +4,9-4,10:           OP             '('
    +4,10-4,11:          OP             ')'
    +4,11-4,12:          NEWLINE        '\n'
    +5,0-5,0:            ENDMARKER      ''
    +
    +
    +

    The exact token type names can be displayed using the -e option:

    +
    $ python -m tokenize -e hello.py
    +0,0-0,0:            ENCODING       'utf-8'
    +1,0-1,3:            NAME           'def'
    +1,4-1,13:           NAME           'say_hello'
    +1,13-1,14:          LPAR           '('
    +1,14-1,15:          RPAR           ')'
    +1,15-1,16:          COLON          ':'
    +1,16-1,17:          NEWLINE        '\n'
    +2,0-2,4:            INDENT         '    '
    +2,4-2,9:            NAME           'print'
    +2,9-2,10:           LPAR           '('
    +2,10-2,25:          STRING         '"Hello, World!"'
    +2,25-2,26:          RPAR           ')'
    +2,26-2,27:          NEWLINE        '\n'
    +3,0-3,1:            NL             '\n'
    +4,0-4,0:            DEDENT         ''
    +4,0-4,9:            NAME           'say_hello'
    +4,9-4,10:           LPAR           '('
    +4,10-4,11:          RPAR           ')'
    +4,11-4,12:          NEWLINE        '\n'
    +5,0-5,0:            ENDMARKER      ''
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/trace.html b/python-3.7.4-docs-html/library/trace.html new file mode 100644 index 0000000..b98d236 --- /dev/null +++ b/python-3.7.4-docs-html/library/trace.html @@ -0,0 +1,437 @@ + + + + + + + trace — Trace or track Python statement execution — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    trace — Trace or track Python statement execution

    +

    Source code: Lib/trace.py

    +
    +

    The trace module allows you to trace program execution, generate +annotated statement coverage listings, print caller/callee relationships and +list functions executed during a program run. It can be used in another program +or from the command line.

    +
    +

    See also

    +
    +
    Coverage.py

    A popular third-party coverage tool that provides HTML +output along with advanced features such as branch coverage.

    +
    +
    +
    +
    +

    Command-Line Usage

    +

    The trace module can be invoked from the command line. It can be as +simple as

    +
    python -m trace --count -C . somefile.py ...
    +
    +
    +

    The above will execute somefile.py and generate annotated listings of +all Python modules imported during the execution into the current directory.

    +
    +
    +--help
    +

    Display usage and exit.

    +
    + +
    +
    +--version
    +

    Display the version of the module and exit.

    +
    + +
    +

    Main options

    +

    At least one of the following options must be specified when invoking +trace. The --listfuncs option is mutually exclusive with +the --trace and --count options. When +--listfuncs is provided, neither --count nor +--trace are accepted, and vice versa.

    +
    +
    +-c, --count
    +

    Produce a set of annotated listing files upon program completion that shows +how many times each statement was executed. See also +--coverdir, --file and +--no-report below.

    +
    + +
    +
    +-t, --trace
    +

    Display lines as they are executed.

    +
    + +
    +
    +-l, --listfuncs
    +

    Display the functions executed by running the program.

    +
    + +
    +
    +-r, --report
    +

    Produce an annotated list from an earlier program run that used the +--count and --file option. This does not +execute any code.

    +
    + +
    +
    +-T, --trackcalls
    +

    Display the calling relationships exposed by running the program.

    +
    + +
    +
    +

    Modifiers

    +
    +
    +-f, --file=<file>
    +

    Name of a file to accumulate counts over several tracing runs. Should be +used with the --count option.

    +
    + +
    +
    +-C, --coverdir=<dir>
    +

    Directory where the report files go. The coverage report for +package.module is written to file dir/package/module.cover.

    +
    + +
    +
    +-m, --missing
    +

    When generating annotated listings, mark lines which were not executed with +>>>>>>.

    +
    + +
    +
    +-s, --summary
    +

    When using --count or --report, write a brief +summary to stdout for each file processed.

    +
    + +
    +
    +-R, --no-report
    +

    Do not generate annotated listings. This is useful if you intend to make +several runs with --count, and then produce a single set of +annotated listings at the end.

    +
    + +
    +
    +-g, --timing
    +

    Prefix each line with the time since the program started. Only used while +tracing.

    +
    + +
    +
    +

    Filters

    +

    These options may be repeated multiple times.

    +
    +
    +--ignore-module=<mod>
    +

    Ignore each of the given module names and its submodules (if it is a +package). The argument can be a list of names separated by a comma.

    +
    + +
    +
    +--ignore-dir=<dir>
    +

    Ignore all modules and packages in the named directory and subdirectories. +The argument can be a list of directories separated by os.pathsep.

    +
    + +
    +
    +
    +

    Programmatic Interface

    +
    +
    +class trace.Trace(count=1, trace=1, countfuncs=0, countcallers=0, ignoremods=(), ignoredirs=(), infile=None, outfile=None, timing=False)
    +

    Create an object to trace execution of a single statement or expression. All +parameters are optional. count enables counting of line numbers. trace +enables line execution tracing. countfuncs enables listing of the +functions called during the run. countcallers enables call relationship +tracking. ignoremods is a list of modules or packages to ignore. +ignoredirs is a list of directories whose modules or packages should be +ignored. infile is the name of the file from which to read stored count +information. outfile is the name of the file in which to write updated +count information. timing enables a timestamp relative to when tracing was +started to be displayed.

    +
    +
    +
    +run(cmd)
    +

    Execute the command and gather statistics from the execution with +the current tracing parameters. cmd must be a string or code object, +suitable for passing into exec().

    +
    + +
    +
    +runctx(cmd, globals=None, locals=None)
    +

    Execute the command and gather statistics from the execution with the +current tracing parameters, in the defined global and local +environments. If not defined, globals and locals default to empty +dictionaries.

    +
    + +
    +
    +runfunc(func, *args, **kwds)
    +

    Call func with the given arguments under control of the Trace +object with the current tracing parameters.

    +
    + +
    +
    +results()
    +

    Return a CoverageResults object that contains the cumulative +results of all previous calls to run, runctx and runfunc +for the given Trace instance. Does not reset the accumulated +trace results.

    +
    + +
    +
    + +
    +
    +class trace.CoverageResults
    +

    A container for coverage results, created by Trace.results(). Should +not be created directly by the user.

    +
    +
    +
    +update(other)
    +

    Merge in data from another CoverageResults object.

    +
    + +
    +
    +write_results(show_missing=True, summary=False, coverdir=None)
    +

    Write coverage results. Set show_missing to show lines that had no +hits. Set summary to include in the output the coverage summary per +module. coverdir specifies the directory into which the coverage +result files will be output. If None, the results for each source +file are placed in its directory.

    +
    + +
    +
    + +

    A simple example demonstrating the use of the programmatic interface:

    +
    import sys
    +import trace
    +
    +# create a Trace object, telling it what to ignore, and whether to
    +# do tracing or line-counting or both.
    +tracer = trace.Trace(
    +    ignoredirs=[sys.prefix, sys.exec_prefix],
    +    trace=0,
    +    count=1)
    +
    +# run the new command using the given tracer
    +tracer.run('main()')
    +
    +# make a report, placing output in the current directory
    +r = tracer.results()
    +r.write_results(show_missing=True, coverdir=".")
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/traceback.html b/python-3.7.4-docs-html/library/traceback.html new file mode 100644 index 0000000..247ee00 --- /dev/null +++ b/python-3.7.4-docs-html/library/traceback.html @@ -0,0 +1,701 @@ + + + + + + + traceback — Print or retrieve a stack traceback — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    traceback — Print or retrieve a stack traceback

    +

    Source code: Lib/traceback.py

    +
    +

    This module provides a standard interface to extract, format and print stack +traces of Python programs. It exactly mimics the behavior of the Python +interpreter when it prints a stack trace. This is useful when you want to print +stack traces under program control, such as in a “wrapper” around the +interpreter.

    +

    The module uses traceback objects — this is the object type that is stored in +the sys.last_traceback variable and returned as the third item from +sys.exc_info().

    +

    The module defines the following functions:

    +
    +
    +traceback.print_tb(tb, limit=None, file=None)
    +

    Print up to limit stack trace entries from traceback object tb (starting +from the caller’s frame) if limit is positive. Otherwise, print the last +abs(limit) entries. If limit is omitted or None, all entries are +printed. If file is omitted or None, the output goes to +sys.stderr; otherwise it should be an open file or file-like object to +receive the output.

    +
    +

    Changed in version 3.5: Added negative limit support.

    +
    +
    + +
    +
    +traceback.print_exception(etype, value, tb, limit=None, file=None, chain=True)
    +

    Print exception information and stack trace entries from traceback object +tb to file. This differs from print_tb() in the following +ways:

    +
      +
    • if tb is not None, it prints a header Traceback (most recent +call last):

    • +
    • it prints the exception etype and value after the stack trace

    • +
    +
      +
    • if type(value) is SyntaxError and value has the appropriate +format, it prints the line where the syntax error occurred with a caret +indicating the approximate position of the error.

    • +
    +

    The optional limit argument has the same meaning as for print_tb(). +If chain is true (the default), then chained exceptions (the +__cause__ or __context__ attributes of the exception) will be +printed as well, like the interpreter itself does when printing an unhandled +exception.

    +
    +

    Changed in version 3.5: The etype argument is ignored and inferred from the type of value.

    +
    +
    + +
    +
    +traceback.print_exc(limit=None, file=None, chain=True)
    +

    This is a shorthand for print_exception(*sys.exc_info(), limit, file, +chain).

    +
    + +
    +
    +traceback.print_last(limit=None, file=None, chain=True)
    +

    This is a shorthand for print_exception(sys.last_type, sys.last_value, +sys.last_traceback, limit, file, chain). In general it will work only +after an exception has reached an interactive prompt (see +sys.last_type).

    +
    + +
    +
    +traceback.print_stack(f=None, limit=None, file=None)
    +

    Print up to limit stack trace entries (starting from the invocation +point) if limit is positive. Otherwise, print the last abs(limit) +entries. If limit is omitted or None, all entries are printed. +The optional f argument can be used to specify an alternate stack frame +to start. The optional file argument has the same meaning as for +print_tb().

    +
    +

    Changed in version 3.5: Added negative limit support.

    +
    +
    + +
    +
    +traceback.extract_tb(tb, limit=None)
    +

    Return a StackSummary object representing a list of “pre-processed” +stack trace entries extracted from the traceback object tb. It is useful +for alternate formatting of stack traces. The optional limit argument has +the same meaning as for print_tb(). A “pre-processed” stack trace +entry is a FrameSummary object containing attributes +filename, lineno, +name, and line representing the +information that is usually printed for a stack trace. The +line is a string with leading and trailing +whitespace stripped; if the source is not available it is None.

    +
    + +
    +
    +traceback.extract_stack(f=None, limit=None)
    +

    Extract the raw traceback from the current stack frame. The return value has +the same format as for extract_tb(). The optional f and limit +arguments have the same meaning as for print_stack().

    +
    + +
    +
    +traceback.format_list(extracted_list)
    +

    Given a list of tuples or FrameSummary objects as returned by +extract_tb() or extract_stack(), return a list of strings ready +for printing. Each string in the resulting list corresponds to the item with +the same index in the argument list. Each string ends in a newline; the +strings may contain internal newlines as well, for those items whose source +text line is not None.

    +
    + +
    +
    +traceback.format_exception_only(etype, value)
    +

    Format the exception part of a traceback. The arguments are the exception +type and value such as given by sys.last_type and sys.last_value. +The return value is a list of strings, each ending in a newline. Normally, +the list contains a single string; however, for SyntaxError +exceptions, it contains several lines that (when printed) display detailed +information about where the syntax error occurred. The message indicating +which exception occurred is the always last string in the list.

    +
    + +
    +
    +traceback.format_exception(etype, value, tb, limit=None, chain=True)
    +

    Format a stack trace and the exception information. The arguments have the +same meaning as the corresponding arguments to print_exception(). The +return value is a list of strings, each ending in a newline and some +containing internal newlines. When these lines are concatenated and printed, +exactly the same text is printed as does print_exception().

    +
    +

    Changed in version 3.5: The etype argument is ignored and inferred from the type of value.

    +
    +
    + +
    +
    +traceback.format_exc(limit=None, chain=True)
    +

    This is like print_exc(limit) but returns a string instead of printing to +a file.

    +
    + +
    +
    +traceback.format_tb(tb, limit=None)
    +

    A shorthand for format_list(extract_tb(tb, limit)).

    +
    + +
    +
    +traceback.format_stack(f=None, limit=None)
    +

    A shorthand for format_list(extract_stack(f, limit)).

    +
    + +
    +
    +traceback.clear_frames(tb)
    +

    Clears the local variables of all the stack frames in a traceback tb +by calling the clear() method of each frame object.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +traceback.walk_stack(f)
    +

    Walk a stack following f.f_back from the given frame, yielding the frame +and line number for each frame. If f is None, the current stack is +used. This helper is used with StackSummary.extract().

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +traceback.walk_tb(tb)
    +

    Walk a traceback following tb_next yielding the frame and line number +for each frame. This helper is used with StackSummary.extract().

    +
    +

    New in version 3.5.

    +
    +
    + +

    The module also defines the following classes:

    +
    +

    TracebackException Objects

    +
    +

    New in version 3.5.

    +
    +

    TracebackException objects are created from actual exceptions to +capture data for later printing in a lightweight fashion.

    +
    +
    +class traceback.TracebackException(exc_type, exc_value, exc_traceback, *, limit=None, lookup_lines=True, capture_locals=False)
    +

    Capture an exception for later rendering. limit, lookup_lines and +capture_locals are as for the StackSummary class.

    +

    Note that when locals are captured, they are also shown in the traceback.

    +
    +
    +__cause__
    +

    A TracebackException of the original __cause__.

    +
    + +
    +
    +__context__
    +

    A TracebackException of the original __context__.

    +
    + +
    +
    +__suppress_context__
    +

    The __suppress_context__ value from the original exception.

    +
    + +
    +
    +stack
    +

    A StackSummary representing the traceback.

    +
    + +
    +
    +exc_type
    +

    The class of the original traceback.

    +
    + +
    +
    +filename
    +

    For syntax errors - the file name where the error occurred.

    +
    + +
    +
    +lineno
    +

    For syntax errors - the line number where the error occurred.

    +
    + +
    +
    +text
    +

    For syntax errors - the text where the error occurred.

    +
    + +
    +
    +offset
    +

    For syntax errors - the offset into the text where the error occurred.

    +
    + +
    +
    +msg
    +

    For syntax errors - the compiler error message.

    +
    + +
    +
    +classmethod from_exception(exc, *, limit=None, lookup_lines=True, capture_locals=False)
    +

    Capture an exception for later rendering. limit, lookup_lines and +capture_locals are as for the StackSummary class.

    +

    Note that when locals are captured, they are also shown in the traceback.

    +
    + +
    +
    +format(*, chain=True)
    +

    Format the exception.

    +

    If chain is not True, __cause__ and __context__ will not +be formatted.

    +

    The return value is a generator of strings, each ending in a newline and +some containing internal newlines. print_exception() +is a wrapper around this method which just prints the lines to a file.

    +

    The message indicating which exception occurred is always the last +string in the output.

    +
    + +
    +
    +format_exception_only()
    +

    Format the exception part of the traceback.

    +

    The return value is a generator of strings, each ending in a newline.

    +

    Normally, the generator emits a single string; however, for +SyntaxError exceptions, it emits several lines that (when +printed) display detailed information about where the syntax +error occurred.

    +

    The message indicating which exception occurred is always the last +string in the output.

    +
    + +
    + +
    +
    +

    StackSummary Objects

    +
    +

    New in version 3.5.

    +
    +

    StackSummary objects represent a call stack ready for formatting.

    +
    +
    +class traceback.StackSummary
    +
    +
    +classmethod extract(frame_gen, *, limit=None, lookup_lines=True, capture_locals=False)
    +

    Construct a StackSummary object from a frame generator (such as +is returned by walk_stack() or +walk_tb()).

    +

    If limit is supplied, only this many frames are taken from frame_gen. +If lookup_lines is False, the returned FrameSummary +objects will not have read their lines in yet, making the cost of +creating the StackSummary cheaper (which may be valuable if it +may not actually get formatted). If capture_locals is True the +local variables in each FrameSummary are captured as object +representations.

    +
    + +
    +
    +classmethod from_list(a_list)
    +

    Construct a StackSummary object from a supplied list of +FrameSummary objects or old-style list of tuples. Each tuple +should be a 4-tuple with filename, lineno, name, line as the elements.

    +
    + +
    +
    +format()
    +

    Returns a list of strings ready for printing. Each string in the +resulting list corresponds to a single frame from the stack. +Each string ends in a newline; the strings may contain internal +newlines as well, for those items with source text lines.

    +

    For long sequences of the same frame and line, the first few +repetitions are shown, followed by a summary line stating the exact +number of further repetitions.

    +
    +

    Changed in version 3.6: Long sequences of repeated frames are now abbreviated.

    +
    +
    + +
    + +
    +
    +

    FrameSummary Objects

    +
    +

    New in version 3.5.

    +
    +

    FrameSummary objects represent a single frame in a traceback.

    +
    +
    +class traceback.FrameSummary(filename, lineno, name, lookup_line=True, locals=None, line=None)
    +

    Represent a single frame in the traceback or stack that is being formatted +or printed. It may optionally have a stringified version of the frames +locals included in it. If lookup_line is False, the source code is not +looked up until the FrameSummary has the line +attribute accessed (which also happens when casting it to a tuple). +line may be directly provided, and will prevent line +lookups happening at all. locals is an optional local variable +dictionary, and if supplied the variable representations are stored in the +summary for later display.

    +
    + +
    +
    +

    Traceback Examples

    +

    This simple example implements a basic read-eval-print loop, similar to (but +less useful than) the standard Python interactive interpreter loop. For a more +complete implementation of the interpreter loop, refer to the code +module.

    +
    import sys, traceback
    +
    +def run_user_code(envdir):
    +    source = input(">>> ")
    +    try:
    +        exec(source, envdir)
    +    except Exception:
    +        print("Exception in user code:")
    +        print("-"*60)
    +        traceback.print_exc(file=sys.stdout)
    +        print("-"*60)
    +
    +envdir = {}
    +while True:
    +    run_user_code(envdir)
    +
    +
    +

    The following example demonstrates the different ways to print and format the +exception and traceback:

    +
    import sys, traceback
    +
    +def lumberjack():
    +    bright_side_of_death()
    +
    +def bright_side_of_death():
    +    return tuple()[0]
    +
    +try:
    +    lumberjack()
    +except IndexError:
    +    exc_type, exc_value, exc_traceback = sys.exc_info()
    +    print("*** print_tb:")
    +    traceback.print_tb(exc_traceback, limit=1, file=sys.stdout)
    +    print("*** print_exception:")
    +    # exc_type below is ignored on 3.5 and later
    +    traceback.print_exception(exc_type, exc_value, exc_traceback,
    +                              limit=2, file=sys.stdout)
    +    print("*** print_exc:")
    +    traceback.print_exc(limit=2, file=sys.stdout)
    +    print("*** format_exc, first and last line:")
    +    formatted_lines = traceback.format_exc().splitlines()
    +    print(formatted_lines[0])
    +    print(formatted_lines[-1])
    +    print("*** format_exception:")
    +    # exc_type below is ignored on 3.5 and later
    +    print(repr(traceback.format_exception(exc_type, exc_value,
    +                                          exc_traceback)))
    +    print("*** extract_tb:")
    +    print(repr(traceback.extract_tb(exc_traceback)))
    +    print("*** format_tb:")
    +    print(repr(traceback.format_tb(exc_traceback)))
    +    print("*** tb_lineno:", exc_traceback.tb_lineno)
    +
    +
    +

    The output for the example would look similar to this:

    +
    *** print_tb:
    +  File "<doctest...>", line 10, in <module>
    +    lumberjack()
    +*** print_exception:
    +Traceback (most recent call last):
    +  File "<doctest...>", line 10, in <module>
    +    lumberjack()
    +  File "<doctest...>", line 4, in lumberjack
    +    bright_side_of_death()
    +IndexError: tuple index out of range
    +*** print_exc:
    +Traceback (most recent call last):
    +  File "<doctest...>", line 10, in <module>
    +    lumberjack()
    +  File "<doctest...>", line 4, in lumberjack
    +    bright_side_of_death()
    +IndexError: tuple index out of range
    +*** format_exc, first and last line:
    +Traceback (most recent call last):
    +IndexError: tuple index out of range
    +*** format_exception:
    +['Traceback (most recent call last):\n',
    + '  File "<doctest...>", line 10, in <module>\n    lumberjack()\n',
    + '  File "<doctest...>", line 4, in lumberjack\n    bright_side_of_death()\n',
    + '  File "<doctest...>", line 7, in bright_side_of_death\n    return tuple()[0]\n',
    + 'IndexError: tuple index out of range\n']
    +*** extract_tb:
    +[<FrameSummary file <doctest...>, line 10 in <module>>,
    + <FrameSummary file <doctest...>, line 4 in lumberjack>,
    + <FrameSummary file <doctest...>, line 7 in bright_side_of_death>]
    +*** format_tb:
    +['  File "<doctest...>", line 10, in <module>\n    lumberjack()\n',
    + '  File "<doctest...>", line 4, in lumberjack\n    bright_side_of_death()\n',
    + '  File "<doctest...>", line 7, in bright_side_of_death\n    return tuple()[0]\n']
    +*** tb_lineno: 10
    +
    +
    +

    The following example shows the different ways to print and format the stack:

    +
    >>> import traceback
    +>>> def another_function():
    +...     lumberstack()
    +...
    +>>> def lumberstack():
    +...     traceback.print_stack()
    +...     print(repr(traceback.extract_stack()))
    +...     print(repr(traceback.format_stack()))
    +...
    +>>> another_function()
    +  File "<doctest>", line 10, in <module>
    +    another_function()
    +  File "<doctest>", line 3, in another_function
    +    lumberstack()
    +  File "<doctest>", line 6, in lumberstack
    +    traceback.print_stack()
    +[('<doctest>', 10, '<module>', 'another_function()'),
    + ('<doctest>', 3, 'another_function', 'lumberstack()'),
    + ('<doctest>', 7, 'lumberstack', 'print(repr(traceback.extract_stack()))')]
    +['  File "<doctest>", line 10, in <module>\n    another_function()\n',
    + '  File "<doctest>", line 3, in another_function\n    lumberstack()\n',
    + '  File "<doctest>", line 8, in lumberstack\n    print(repr(traceback.format_stack()))\n']
    +
    +
    +

    This last example demonstrates the final few formatting functions:

    +
    >>> import traceback
    +>>> traceback.format_list([('spam.py', 3, '<module>', 'spam.eggs()'),
    +...                        ('eggs.py', 42, 'eggs', 'return "bacon"')])
    +['  File "spam.py", line 3, in <module>\n    spam.eggs()\n',
    + '  File "eggs.py", line 42, in eggs\n    return "bacon"\n']
    +>>> an_error = IndexError('tuple index out of range')
    +>>> traceback.format_exception_only(type(an_error), an_error)
    +['IndexError: tuple index out of range\n']
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/tracemalloc.html b/python-3.7.4-docs-html/library/tracemalloc.html new file mode 100644 index 0000000..02b5098 --- /dev/null +++ b/python-3.7.4-docs-html/library/tracemalloc.html @@ -0,0 +1,925 @@ + + + + + + + tracemalloc — Trace memory allocations — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    tracemalloc — Trace memory allocations

    +
    +

    New in version 3.4.

    +
    +

    Source code: Lib/tracemalloc.py

    +
    +

    The tracemalloc module is a debug tool to trace memory blocks allocated by +Python. It provides the following information:

    +
      +
    • Traceback where an object was allocated

    • +
    • Statistics on allocated memory blocks per filename and per line number: +total size, number and average size of allocated memory blocks

    • +
    • Compute the differences between two snapshots to detect memory leaks

    • +
    +

    To trace most memory blocks allocated by Python, the module should be started +as early as possible by setting the PYTHONTRACEMALLOC environment +variable to 1, or by using -X tracemalloc command line +option. The tracemalloc.start() function can be called at runtime to +start tracing Python memory allocations.

    +

    By default, a trace of an allocated memory block only stores the most recent +frame (1 frame). To store 25 frames at startup: set the +PYTHONTRACEMALLOC environment variable to 25, or use the +-X tracemalloc=25 command line option.

    +
    +

    Examples

    +
    +

    Display the top 10

    +

    Display the 10 files allocating the most memory:

    +
    import tracemalloc
    +
    +tracemalloc.start()
    +
    +# ... run your application ...
    +
    +snapshot = tracemalloc.take_snapshot()
    +top_stats = snapshot.statistics('lineno')
    +
    +print("[ Top 10 ]")
    +for stat in top_stats[:10]:
    +    print(stat)
    +
    +
    +

    Example of output of the Python test suite:

    +
    [ Top 10 ]
    +<frozen importlib._bootstrap>:716: size=4855 KiB, count=39328, average=126 B
    +<frozen importlib._bootstrap>:284: size=521 KiB, count=3199, average=167 B
    +/usr/lib/python3.4/collections/__init__.py:368: size=244 KiB, count=2315, average=108 B
    +/usr/lib/python3.4/unittest/case.py:381: size=185 KiB, count=779, average=243 B
    +/usr/lib/python3.4/unittest/case.py:402: size=154 KiB, count=378, average=416 B
    +/usr/lib/python3.4/abc.py:133: size=88.7 KiB, count=347, average=262 B
    +<frozen importlib._bootstrap>:1446: size=70.4 KiB, count=911, average=79 B
    +<frozen importlib._bootstrap>:1454: size=52.0 KiB, count=25, average=2131 B
    +<string>:5: size=49.7 KiB, count=148, average=344 B
    +/usr/lib/python3.4/sysconfig.py:411: size=48.0 KiB, count=1, average=48.0 KiB
    +
    +
    +

    We can see that Python loaded 4855 KiB data (bytecode and constants) from +modules and that the collections module allocated 244 KiB to build +namedtuple types.

    +

    See Snapshot.statistics() for more options.

    +
    +
    +

    Compute differences

    +

    Take two snapshots and display the differences:

    +
    import tracemalloc
    +tracemalloc.start()
    +# ... start your application ...
    +
    +snapshot1 = tracemalloc.take_snapshot()
    +# ... call the function leaking memory ...
    +snapshot2 = tracemalloc.take_snapshot()
    +
    +top_stats = snapshot2.compare_to(snapshot1, 'lineno')
    +
    +print("[ Top 10 differences ]")
    +for stat in top_stats[:10]:
    +    print(stat)
    +
    +
    +

    Example of output before/after running some tests of the Python test suite:

    +
    [ Top 10 differences ]
    +<frozen importlib._bootstrap>:716: size=8173 KiB (+4428 KiB), count=71332 (+39369), average=117 B
    +/usr/lib/python3.4/linecache.py:127: size=940 KiB (+940 KiB), count=8106 (+8106), average=119 B
    +/usr/lib/python3.4/unittest/case.py:571: size=298 KiB (+298 KiB), count=589 (+589), average=519 B
    +<frozen importlib._bootstrap>:284: size=1005 KiB (+166 KiB), count=7423 (+1526), average=139 B
    +/usr/lib/python3.4/mimetypes.py:217: size=112 KiB (+112 KiB), count=1334 (+1334), average=86 B
    +/usr/lib/python3.4/http/server.py:848: size=96.0 KiB (+96.0 KiB), count=1 (+1), average=96.0 KiB
    +/usr/lib/python3.4/inspect.py:1465: size=83.5 KiB (+83.5 KiB), count=109 (+109), average=784 B
    +/usr/lib/python3.4/unittest/mock.py:491: size=77.7 KiB (+77.7 KiB), count=143 (+143), average=557 B
    +/usr/lib/python3.4/urllib/parse.py:476: size=71.8 KiB (+71.8 KiB), count=969 (+969), average=76 B
    +/usr/lib/python3.4/contextlib.py:38: size=67.2 KiB (+67.2 KiB), count=126 (+126), average=546 B
    +
    +
    +

    We can see that Python has loaded 8173 KiB of module data (bytecode and +constants), and that this is 4428 KiB more than had been loaded before the +tests, when the previous snapshot was taken. Similarly, the linecache +module has cached 940 KiB of Python source code to format tracebacks, all +of it since the previous snapshot.

    +

    If the system has little free memory, snapshots can be written on disk using +the Snapshot.dump() method to analyze the snapshot offline. Then use the +Snapshot.load() method reload the snapshot.

    +
    +
    +

    Get the traceback of a memory block

    +

    Code to display the traceback of the biggest memory block:

    +
    import tracemalloc
    +
    +# Store 25 frames
    +tracemalloc.start(25)
    +
    +# ... run your application ...
    +
    +snapshot = tracemalloc.take_snapshot()
    +top_stats = snapshot.statistics('traceback')
    +
    +# pick the biggest memory block
    +stat = top_stats[0]
    +print("%s memory blocks: %.1f KiB" % (stat.count, stat.size / 1024))
    +for line in stat.traceback.format():
    +    print(line)
    +
    +
    +

    Example of output of the Python test suite (traceback limited to 25 frames):

    +
    903 memory blocks: 870.1 KiB
    +  File "<frozen importlib._bootstrap>", line 716
    +  File "<frozen importlib._bootstrap>", line 1036
    +  File "<frozen importlib._bootstrap>", line 934
    +  File "<frozen importlib._bootstrap>", line 1068
    +  File "<frozen importlib._bootstrap>", line 619
    +  File "<frozen importlib._bootstrap>", line 1581
    +  File "<frozen importlib._bootstrap>", line 1614
    +  File "/usr/lib/python3.4/doctest.py", line 101
    +    import pdb
    +  File "<frozen importlib._bootstrap>", line 284
    +  File "<frozen importlib._bootstrap>", line 938
    +  File "<frozen importlib._bootstrap>", line 1068
    +  File "<frozen importlib._bootstrap>", line 619
    +  File "<frozen importlib._bootstrap>", line 1581
    +  File "<frozen importlib._bootstrap>", line 1614
    +  File "/usr/lib/python3.4/test/support/__init__.py", line 1728
    +    import doctest
    +  File "/usr/lib/python3.4/test/test_pickletools.py", line 21
    +    support.run_doctest(pickletools)
    +  File "/usr/lib/python3.4/test/regrtest.py", line 1276
    +    test_runner()
    +  File "/usr/lib/python3.4/test/regrtest.py", line 976
    +    display_failure=not verbose)
    +  File "/usr/lib/python3.4/test/regrtest.py", line 761
    +    match_tests=ns.match_tests)
    +  File "/usr/lib/python3.4/test/regrtest.py", line 1563
    +    main()
    +  File "/usr/lib/python3.4/test/__main__.py", line 3
    +    regrtest.main_in_temp_cwd()
    +  File "/usr/lib/python3.4/runpy.py", line 73
    +    exec(code, run_globals)
    +  File "/usr/lib/python3.4/runpy.py", line 160
    +    "__main__", fname, loader, pkg_name)
    +
    +
    +

    We can see that the most memory was allocated in the importlib module to +load data (bytecode and constants) from modules: 870.1 KiB. The traceback is +where the importlib loaded data most recently: on the import pdb +line of the doctest module. The traceback may change if a new module is +loaded.

    +
    +
    +

    Pretty top

    +

    Code to display the 10 lines allocating the most memory with a pretty output, +ignoring <frozen importlib._bootstrap> and <unknown> files:

    +
    import linecache
    +import os
    +import tracemalloc
    +
    +def display_top(snapshot, key_type='lineno', limit=10):
    +    snapshot = snapshot.filter_traces((
    +        tracemalloc.Filter(False, "<frozen importlib._bootstrap>"),
    +        tracemalloc.Filter(False, "<unknown>"),
    +    ))
    +    top_stats = snapshot.statistics(key_type)
    +
    +    print("Top %s lines" % limit)
    +    for index, stat in enumerate(top_stats[:limit], 1):
    +        frame = stat.traceback[0]
    +        # replace "/path/to/module/file.py" with "module/file.py"
    +        filename = os.sep.join(frame.filename.split(os.sep)[-2:])
    +        print("#%s: %s:%s: %.1f KiB"
    +              % (index, filename, frame.lineno, stat.size / 1024))
    +        line = linecache.getline(frame.filename, frame.lineno).strip()
    +        if line:
    +            print('    %s' % line)
    +
    +    other = top_stats[limit:]
    +    if other:
    +        size = sum(stat.size for stat in other)
    +        print("%s other: %.1f KiB" % (len(other), size / 1024))
    +    total = sum(stat.size for stat in top_stats)
    +    print("Total allocated size: %.1f KiB" % (total / 1024))
    +
    +tracemalloc.start()
    +
    +# ... run your application ...
    +
    +snapshot = tracemalloc.take_snapshot()
    +display_top(snapshot)
    +
    +
    +

    Example of output of the Python test suite:

    +
    Top 10 lines
    +#1: Lib/base64.py:414: 419.8 KiB
    +    _b85chars2 = [(a + b) for a in _b85chars for b in _b85chars]
    +#2: Lib/base64.py:306: 419.8 KiB
    +    _a85chars2 = [(a + b) for a in _a85chars for b in _a85chars]
    +#3: collections/__init__.py:368: 293.6 KiB
    +    exec(class_definition, namespace)
    +#4: Lib/abc.py:133: 115.2 KiB
    +    cls = super().__new__(mcls, name, bases, namespace)
    +#5: unittest/case.py:574: 103.1 KiB
    +    testMethod()
    +#6: Lib/linecache.py:127: 95.4 KiB
    +    lines = fp.readlines()
    +#7: urllib/parse.py:476: 71.8 KiB
    +    for a in _hexdig for b in _hexdig}
    +#8: <string>:5: 62.0 KiB
    +#9: Lib/_weakrefset.py:37: 60.0 KiB
    +    self.data = set()
    +#10: Lib/base64.py:142: 59.8 KiB
    +    _b32tab2 = [a + b for a in _b32tab for b in _b32tab]
    +6220 other: 3602.8 KiB
    +Total allocated size: 5303.1 KiB
    +
    +
    +

    See Snapshot.statistics() for more options.

    +
    +
    +
    +

    API

    +
    +

    Functions

    +
    +
    +tracemalloc.clear_traces()
    +

    Clear traces of memory blocks allocated by Python.

    +

    See also stop().

    +
    + +
    +
    +tracemalloc.get_object_traceback(obj)
    +

    Get the traceback where the Python object obj was allocated. +Return a Traceback instance, or None if the tracemalloc +module is not tracing memory allocations or did not trace the allocation of +the object.

    +

    See also gc.get_referrers() and sys.getsizeof() functions.

    +
    + +
    +
    +tracemalloc.get_traceback_limit()
    +

    Get the maximum number of frames stored in the traceback of a trace.

    +

    The tracemalloc module must be tracing memory allocations to +get the limit, otherwise an exception is raised.

    +

    The limit is set by the start() function.

    +
    + +
    +
    +tracemalloc.get_traced_memory()
    +

    Get the current size and peak size of memory blocks traced by the +tracemalloc module as a tuple: (current: int, peak: int).

    +
    + +
    +
    +tracemalloc.get_tracemalloc_memory()
    +

    Get the memory usage in bytes of the tracemalloc module used to store +traces of memory blocks. +Return an int.

    +
    + +
    +
    +tracemalloc.is_tracing()
    +

    True if the tracemalloc module is tracing Python memory +allocations, False otherwise.

    +

    See also start() and stop() functions.

    +
    + +
    +
    +tracemalloc.start(nframe: int=1)
    +

    Start tracing Python memory allocations: install hooks on Python memory +allocators. Collected tracebacks of traces will be limited to nframe +frames. By default, a trace of a memory block only stores the most recent +frame: the limit is 1. nframe must be greater or equal to 1.

    +

    Storing more than 1 frame is only useful to compute statistics grouped +by 'traceback' or to compute cumulative statistics: see the +Snapshot.compare_to() and Snapshot.statistics() methods.

    +

    Storing more frames increases the memory and CPU overhead of the +tracemalloc module. Use the get_tracemalloc_memory() function +to measure how much memory is used by the tracemalloc module.

    +

    The PYTHONTRACEMALLOC environment variable +(PYTHONTRACEMALLOC=NFRAME) and the -X tracemalloc=NFRAME +command line option can be used to start tracing at startup.

    +

    See also stop(), is_tracing() and get_traceback_limit() +functions.

    +
    + +
    +
    +tracemalloc.stop()
    +

    Stop tracing Python memory allocations: uninstall hooks on Python memory +allocators. Also clears all previously collected traces of memory blocks +allocated by Python.

    +

    Call take_snapshot() function to take a snapshot of traces before +clearing them.

    +

    See also start(), is_tracing() and clear_traces() +functions.

    +
    + +
    +
    +tracemalloc.take_snapshot()
    +

    Take a snapshot of traces of memory blocks allocated by Python. Return a new +Snapshot instance.

    +

    The snapshot does not include memory blocks allocated before the +tracemalloc module started to trace memory allocations.

    +

    Tracebacks of traces are limited to get_traceback_limit() frames. Use +the nframe parameter of the start() function to store more frames.

    +

    The tracemalloc module must be tracing memory allocations to take a +snapshot, see the start() function.

    +

    See also the get_object_traceback() function.

    +
    + +
    +
    +

    DomainFilter

    +
    +
    +class tracemalloc.DomainFilter(inclusive: bool, domain: int)
    +

    Filter traces of memory blocks by their address space (domain).

    +
    +

    New in version 3.6.

    +
    +
    +
    +inclusive
    +

    If inclusive is True (include), match memory blocks allocated +in the address space domain.

    +

    If inclusive is False (exclude), match memory blocks not allocated +in the address space domain.

    +
    + +
    +
    +domain
    +

    Address space of a memory block (int). Read-only property.

    +
    + +
    + +
    +
    +

    Filter

    +
    +
    +class tracemalloc.Filter(inclusive: bool, filename_pattern: str, lineno: int=None, all_frames: bool=False, domain: int=None)
    +

    Filter on traces of memory blocks.

    +

    See the fnmatch.fnmatch() function for the syntax of +filename_pattern. The '.pyc' file extension is +replaced with '.py'.

    +

    Examples:

    +
      +
    • Filter(True, subprocess.__file__) only includes traces of the +subprocess module

    • +
    • Filter(False, tracemalloc.__file__) excludes traces of the +tracemalloc module

    • +
    • Filter(False, "<unknown>") excludes empty tracebacks

    • +
    +
    +

    Changed in version 3.5: The '.pyo' file extension is no longer replaced with '.py'.

    +
    +
    +

    Changed in version 3.6: Added the domain attribute.

    +
    +
    +
    +domain
    +

    Address space of a memory block (int or None).

    +

    tracemalloc uses the domain 0 to trace memory allocations made by +Python. C extensions can use other domains to trace other resources.

    +
    + +
    +
    +inclusive
    +

    If inclusive is True (include), only match memory blocks allocated +in a file with a name matching filename_pattern at line number +lineno.

    +

    If inclusive is False (exclude), ignore memory blocks allocated in +a file with a name matching filename_pattern at line number +lineno.

    +
    + +
    +
    +lineno
    +

    Line number (int) of the filter. If lineno is None, the filter +matches any line number.

    +
    + +
    +
    +filename_pattern
    +

    Filename pattern of the filter (str). Read-only property.

    +
    + +
    +
    +all_frames
    +

    If all_frames is True, all frames of the traceback are checked. If +all_frames is False, only the most recent frame is checked.

    +

    This attribute has no effect if the traceback limit is 1. See the +get_traceback_limit() function and Snapshot.traceback_limit +attribute.

    +
    + +
    + +
    +
    +

    Frame

    +
    +
    +class tracemalloc.Frame
    +

    Frame of a traceback.

    +

    The Traceback class is a sequence of Frame instances.

    +
    +
    +filename
    +

    Filename (str).

    +
    + +
    +
    +lineno
    +

    Line number (int).

    +
    + +
    + +
    +
    +

    Snapshot

    +
    +
    +class tracemalloc.Snapshot
    +

    Snapshot of traces of memory blocks allocated by Python.

    +

    The take_snapshot() function creates a snapshot instance.

    +
    +
    +compare_to(old_snapshot: Snapshot, key_type: str, cumulative: bool=False)
    +

    Compute the differences with an old snapshot. Get statistics as a sorted +list of StatisticDiff instances grouped by key_type.

    +

    See the Snapshot.statistics() method for key_type and cumulative +parameters.

    +

    The result is sorted from the biggest to the smallest by: absolute value +of StatisticDiff.size_diff, StatisticDiff.size, absolute +value of StatisticDiff.count_diff, Statistic.count and +then by StatisticDiff.traceback.

    +
    + +
    +
    +dump(filename)
    +

    Write the snapshot into a file.

    +

    Use load() to reload the snapshot.

    +
    + +
    +
    +filter_traces(filters)
    +

    Create a new Snapshot instance with a filtered traces +sequence, filters is a list of DomainFilter and +Filter instances. If filters is an empty list, return a new +Snapshot instance with a copy of the traces.

    +

    All inclusive filters are applied at once, a trace is ignored if no +inclusive filters match it. A trace is ignored if at least one exclusive +filter matches it.

    +
    +

    Changed in version 3.6: DomainFilter instances are now also accepted in filters.

    +
    +
    + +
    +
    +classmethod load(filename)
    +

    Load a snapshot from a file.

    +

    See also dump().

    +
    + +
    +
    +statistics(key_type: str, cumulative: bool=False)
    +

    Get statistics as a sorted list of Statistic instances grouped +by key_type:

    + ++++ + + + + + + + + + + + + + + + + +

    key_type

    description

    'filename'

    filename

    'lineno'

    filename and line number

    'traceback'

    traceback

    +

    If cumulative is True, cumulate size and count of memory blocks of +all frames of the traceback of a trace, not only the most recent frame. +The cumulative mode can only be used with key_type equals to +'filename' and 'lineno'.

    +

    The result is sorted from the biggest to the smallest by: +Statistic.size, Statistic.count and then by +Statistic.traceback.

    +
    + +
    +
    +traceback_limit
    +

    Maximum number of frames stored in the traceback of traces: +result of the get_traceback_limit() when the snapshot was taken.

    +
    + +
    +
    +traces
    +

    Traces of all memory blocks allocated by Python: sequence of +Trace instances.

    +

    The sequence has an undefined order. Use the Snapshot.statistics() +method to get a sorted list of statistics.

    +
    + +
    + +
    +
    +

    Statistic

    +
    +
    +class tracemalloc.Statistic
    +

    Statistic on memory allocations.

    +

    Snapshot.statistics() returns a list of Statistic instances.

    +

    See also the StatisticDiff class.

    +
    +
    +count
    +

    Number of memory blocks (int).

    +
    + +
    +
    +size
    +

    Total size of memory blocks in bytes (int).

    +
    + +
    +
    +traceback
    +

    Traceback where the memory block was allocated, Traceback +instance.

    +
    + +
    + +
    +
    +

    StatisticDiff

    +
    +
    +class tracemalloc.StatisticDiff
    +

    Statistic difference on memory allocations between an old and a new +Snapshot instance.

    +

    Snapshot.compare_to() returns a list of StatisticDiff +instances. See also the Statistic class.

    +
    +
    +count
    +

    Number of memory blocks in the new snapshot (int): 0 if +the memory blocks have been released in the new snapshot.

    +
    + +
    +
    +count_diff
    +

    Difference of number of memory blocks between the old and the new +snapshots (int): 0 if the memory blocks have been allocated in +the new snapshot.

    +
    + +
    +
    +size
    +

    Total size of memory blocks in bytes in the new snapshot (int): +0 if the memory blocks have been released in the new snapshot.

    +
    + +
    +
    +size_diff
    +

    Difference of total size of memory blocks in bytes between the old and +the new snapshots (int): 0 if the memory blocks have been +allocated in the new snapshot.

    +
    + +
    +
    +traceback
    +

    Traceback where the memory blocks were allocated, Traceback +instance.

    +
    + +
    + +
    +
    +

    Trace

    +
    +
    +class tracemalloc.Trace
    +

    Trace of a memory block.

    +

    The Snapshot.traces attribute is a sequence of Trace +instances.

    +
    +

    Changed in version 3.6: Added the domain attribute.

    +
    +
    +
    +domain
    +

    Address space of a memory block (int). Read-only property.

    +

    tracemalloc uses the domain 0 to trace memory allocations made by +Python. C extensions can use other domains to trace other resources.

    +
    + +
    +
    +size
    +

    Size of the memory block in bytes (int).

    +
    + +
    +
    +traceback
    +

    Traceback where the memory block was allocated, Traceback +instance.

    +
    + +
    + +
    +
    +

    Traceback

    +
    +
    +class tracemalloc.Traceback
    +

    Sequence of Frame instances sorted from the oldest frame to the +most recent frame.

    +

    A traceback contains at least 1 frame. If the tracemalloc module +failed to get a frame, the filename "<unknown>" at line number 0 is +used.

    +

    When a snapshot is taken, tracebacks of traces are limited to +get_traceback_limit() frames. See the take_snapshot() function.

    +

    The Trace.traceback attribute is an instance of Traceback +instance.

    +
    +

    Changed in version 3.7: Frames are now sorted from the oldest to the most recent, instead of most recent to oldest.

    +
    +
    +
    +format(limit=None, most_recent_first=False)
    +

    Format the traceback as a list of lines with newlines. Use the +linecache module to retrieve lines from the source code. +If limit is set, format the limit most recent frames if limit +is positive. Otherwise, format the abs(limit) oldest frames. +If most_recent_first is True, the order of the formatted frames +is reversed, returning the most recent frame first instead of last.

    +

    Similar to the traceback.format_tb() function, except that +format() does not include newlines.

    +

    Example:

    +
    print("Traceback (most recent call first):")
    +for line in traceback:
    +    print(line)
    +
    +
    +

    Output:

    +
    Traceback (most recent call first):
    +  File "test.py", line 9
    +    obj = Object()
    +  File "test.py", line 12
    +    tb = tracemalloc.get_object_traceback(f())
    +
    +
    +
    + +
    + +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/tty.html b/python-3.7.4-docs-html/library/tty.html new file mode 100644 index 0000000..b07d3ba --- /dev/null +++ b/python-3.7.4-docs-html/library/tty.html @@ -0,0 +1,212 @@ + + + + + + + tty — Terminal control functions — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    tty — Terminal control functions

    +

    Source code: Lib/tty.py

    +
    +

    The tty module defines functions for putting the tty into cbreak and raw +modes.

    +

    Because it requires the termios module, it will work only on Unix.

    +

    The tty module defines the following functions:

    +
    +
    +tty.setraw(fd, when=termios.TCSAFLUSH)
    +

    Change the mode of the file descriptor fd to raw. If when is omitted, it +defaults to termios.TCSAFLUSH, and is passed to +termios.tcsetattr().

    +
    + +
    +
    +tty.setcbreak(fd, when=termios.TCSAFLUSH)
    +

    Change the mode of file descriptor fd to cbreak. If when is omitted, it +defaults to termios.TCSAFLUSH, and is passed to +termios.tcsetattr().

    +
    + +
    +

    See also

    +
    +
    Module termios

    Low-level terminal control interface.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/turtle.html b/python-3.7.4-docs-html/library/turtle.html new file mode 100644 index 0000000..22099f3 --- /dev/null +++ b/python-3.7.4-docs-html/library/turtle.html @@ -0,0 +1,2925 @@ + + + + + + + turtle — Turtle graphics — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    turtle — Turtle graphics

    +

    Source code: Lib/turtle.py

    +
    +
    +

    Introduction

    +

    Turtle graphics is a popular way for introducing programming to kids. It was +part of the original Logo programming language developed by Wally Feurzeig, +Seymour Papert and Cynthia Solomon in 1967.

    +

    Imagine a robotic turtle starting at (0, 0) in the x-y plane. After an import turtle, give it the +command turtle.forward(15), and it moves (on-screen!) 15 pixels in the +direction it is facing, drawing a line as it moves. Give it the command +turtle.right(25), and it rotates in-place 25 degrees clockwise.

    + +

    By combining together these and similar commands, intricate shapes and pictures +can easily be drawn.

    +

    The turtle module is an extended reimplementation of the same-named +module from the Python standard distribution up to version Python 2.5.

    +

    It tries to keep the merits of the old turtle module and to be (nearly) 100% +compatible with it. This means in the first place to enable the learning +programmer to use all the commands, classes and methods interactively when using +the module from within IDLE run with the -n switch.

    +

    The turtle module provides turtle graphics primitives, in both object-oriented +and procedure-oriented ways. Because it uses tkinter for the underlying +graphics, it needs a version of Python installed with Tk support.

    +

    The object-oriented interface uses essentially two+two classes:

    +
      +
    1. The TurtleScreen class defines graphics windows as a playground for +the drawing turtles. Its constructor needs a tkinter.Canvas or a +ScrolledCanvas as argument. It should be used when turtle is +used as part of some application.

      +

      The function Screen() returns a singleton object of a +TurtleScreen subclass. This function should be used when +turtle is used as a standalone tool for doing graphics. +As a singleton object, inheriting from its class is not possible.

      +

      All methods of TurtleScreen/Screen also exist as functions, i.e. as part of +the procedure-oriented interface.

      +
    2. +
    3. RawTurtle (alias: RawPen) defines Turtle objects which draw +on a TurtleScreen. Its constructor needs a Canvas, ScrolledCanvas +or TurtleScreen as argument, so the RawTurtle objects know where to draw.

      +

      Derived from RawTurtle is the subclass Turtle (alias: Pen), +which draws on “the” Screen instance which is automatically +created, if not already present.

      +

      All methods of RawTurtle/Turtle also exist as functions, i.e. part of the +procedure-oriented interface.

      +
    4. +
    +

    The procedural interface provides functions which are derived from the methods +of the classes Screen and Turtle. They have the same names as +the corresponding methods. A screen object is automatically created whenever a +function derived from a Screen method is called. An (unnamed) turtle object is +automatically created whenever any of the functions derived from a Turtle method +is called.

    +

    To use multiple turtles on a screen one has to use the object-oriented interface.

    +
    +

    Note

    +

    In the following documentation the argument list for functions is given. +Methods, of course, have the additional first argument self which is +omitted here.

    +
    +
    +
    +

    Overview of available Turtle and Screen methods

    +
    +

    Turtle methods

    +
    +
    Turtle motion
    +
    Move and draw
    +
    +
    Tell Turtle’s state
    +
    +
    Setting and measurement
    +
    +
    +
    +
    Pen control
    +
    Drawing state
    +
    +
    Color control
    +
    +
    Filling
    +
    +
    More drawing control
    +
    +
    +
    +
    Turtle state
    +
    Visibility
    +
    +
    Appearance
    +
    +
    +
    +
    Using events
    +
    +
    Special Turtle methods
    +
    +
    +
    +
    +

    Methods of TurtleScreen/Screen

    +
    +
    Window control
    +
    +
    Animation control
    +
    +
    Using screen events
    +
    +
    Settings and special methods
    +
    +
    Input methods
    +
    +
    Methods specific to Screen
    +
    +
    +
    +
    +
    +

    Methods of RawTurtle/Turtle and corresponding functions

    +

    Most of the examples in this section refer to a Turtle instance called +turtle.

    +
    +

    Turtle motion

    +
    +
    +turtle.forward(distance)
    +
    +turtle.fd(distance)
    +
    +
    Parameters
    +

    distance – a number (integer or float)

    +
    +
    +

    Move the turtle forward by the specified distance, in the direction the +turtle is headed.

    +
    >>> turtle.position()
    +(0.00,0.00)
    +>>> turtle.forward(25)
    +>>> turtle.position()
    +(25.00,0.00)
    +>>> turtle.forward(-75)
    +>>> turtle.position()
    +(-50.00,0.00)
    +
    +
    +
    + +
    +
    +turtle.back(distance)
    +
    +turtle.bk(distance)
    +
    +turtle.backward(distance)
    +
    +
    Parameters
    +

    distance – a number

    +
    +
    +

    Move the turtle backward by distance, opposite to the direction the +turtle is headed. Do not change the turtle’s heading.

    +
    >>> turtle.position()
    +(0.00,0.00)
    +>>> turtle.backward(30)
    +>>> turtle.position()
    +(-30.00,0.00)
    +
    +
    +
    + +
    +
    +turtle.right(angle)
    +
    +turtle.rt(angle)
    +
    +
    Parameters
    +

    angle – a number (integer or float)

    +
    +
    +

    Turn turtle right by angle units. (Units are by default degrees, but +can be set via the degrees() and radians() functions.) Angle +orientation depends on the turtle mode, see mode().

    +
    >>> turtle.heading()
    +22.0
    +>>> turtle.right(45)
    +>>> turtle.heading()
    +337.0
    +
    +
    +
    + +
    +
    +turtle.left(angle)
    +
    +turtle.lt(angle)
    +
    +
    Parameters
    +

    angle – a number (integer or float)

    +
    +
    +

    Turn turtle left by angle units. (Units are by default degrees, but +can be set via the degrees() and radians() functions.) Angle +orientation depends on the turtle mode, see mode().

    +
    >>> turtle.heading()
    +22.0
    +>>> turtle.left(45)
    +>>> turtle.heading()
    +67.0
    +
    +
    +
    + +
    +
    +turtle.goto(x, y=None)
    +
    +turtle.setpos(x, y=None)
    +
    +turtle.setposition(x, y=None)
    +
    +
    Parameters
    +
      +
    • x – a number or a pair/vector of numbers

    • +
    • y – a number or None

    • +
    +
    +
    +

    If y is None, x must be a pair of coordinates or a Vec2D +(e.g. as returned by pos()).

    +

    Move turtle to an absolute position. If the pen is down, draw line. Do +not change the turtle’s orientation.

    +
    >>> tp = turtle.pos()
    +>>> tp
    +(0.00,0.00)
    +>>> turtle.setpos(60,30)
    +>>> turtle.pos()
    +(60.00,30.00)
    +>>> turtle.setpos((20,80))
    +>>> turtle.pos()
    +(20.00,80.00)
    +>>> turtle.setpos(tp)
    +>>> turtle.pos()
    +(0.00,0.00)
    +
    +
    +
    + +
    +
    +turtle.setx(x)
    +
    +
    Parameters
    +

    x – a number (integer or float)

    +
    +
    +

    Set the turtle’s first coordinate to x, leave second coordinate +unchanged.

    +
    >>> turtle.position()
    +(0.00,240.00)
    +>>> turtle.setx(10)
    +>>> turtle.position()
    +(10.00,240.00)
    +
    +
    +
    + +
    +
    +turtle.sety(y)
    +
    +
    Parameters
    +

    y – a number (integer or float)

    +
    +
    +

    Set the turtle’s second coordinate to y, leave first coordinate unchanged.

    +
    >>> turtle.position()
    +(0.00,40.00)
    +>>> turtle.sety(-10)
    +>>> turtle.position()
    +(0.00,-10.00)
    +
    +
    +
    + +
    +
    +turtle.setheading(to_angle)
    +
    +turtle.seth(to_angle)
    +
    +
    Parameters
    +

    to_angle – a number (integer or float)

    +
    +
    +

    Set the orientation of the turtle to to_angle. Here are some common +directions in degrees:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    standard mode

    logo mode

    0 - east

    0 - north

    90 - north

    90 - east

    180 - west

    180 - south

    270 - south

    270 - west

    +
    >>> turtle.setheading(90)
    +>>> turtle.heading()
    +90.0
    +
    +
    +
    + +
    +
    +turtle.home()
    +

    Move turtle to the origin – coordinates (0,0) – and set its heading to +its start-orientation (which depends on the mode, see mode()).

    +
    >>> turtle.heading()
    +90.0
    +>>> turtle.position()
    +(0.00,-10.00)
    +>>> turtle.home()
    +>>> turtle.position()
    +(0.00,0.00)
    +>>> turtle.heading()
    +0.0
    +
    +
    +
    + +
    +
    +turtle.circle(radius, extent=None, steps=None)
    +
    +
    Parameters
    +
      +
    • radius – a number

    • +
    • extent – a number (or None)

    • +
    • steps – an integer (or None)

    • +
    +
    +
    +

    Draw a circle with given radius. The center is radius units left of +the turtle; extent – an angle – determines which part of the circle +is drawn. If extent is not given, draw the entire circle. If extent +is not a full circle, one endpoint of the arc is the current pen +position. Draw the arc in counterclockwise direction if radius is +positive, otherwise in clockwise direction. Finally the direction of the +turtle is changed by the amount of extent.

    +

    As the circle is approximated by an inscribed regular polygon, steps +determines the number of steps to use. If not given, it will be +calculated automatically. May be used to draw regular polygons.

    +
    >>> turtle.home()
    +>>> turtle.position()
    +(0.00,0.00)
    +>>> turtle.heading()
    +0.0
    +>>> turtle.circle(50)
    +>>> turtle.position()
    +(-0.00,0.00)
    +>>> turtle.heading()
    +0.0
    +>>> turtle.circle(120, 180)  # draw a semicircle
    +>>> turtle.position()
    +(0.00,240.00)
    +>>> turtle.heading()
    +180.0
    +
    +
    +
    + +
    +
    +turtle.dot(size=None, *color)
    +
    +
    Parameters
    +
      +
    • size – an integer >= 1 (if given)

    • +
    • color – a colorstring or a numeric color tuple

    • +
    +
    +
    +

    Draw a circular dot with diameter size, using color. If size is +not given, the maximum of pensize+4 and 2*pensize is used.

    +
    >>> turtle.home()
    +>>> turtle.dot()
    +>>> turtle.fd(50); turtle.dot(20, "blue"); turtle.fd(50)
    +>>> turtle.position()
    +(100.00,-0.00)
    +>>> turtle.heading()
    +0.0
    +
    +
    +
    + +
    +
    +turtle.stamp()
    +

    Stamp a copy of the turtle shape onto the canvas at the current turtle +position. Return a stamp_id for that stamp, which can be used to delete +it by calling clearstamp(stamp_id).

    +
    >>> turtle.color("blue")
    +>>> turtle.stamp()
    +11
    +>>> turtle.fd(50)
    +
    +
    +
    + +
    +
    +turtle.clearstamp(stampid)
    +
    +
    Parameters
    +

    stampid – an integer, must be return value of previous +stamp() call

    +
    +
    +

    Delete stamp with given stampid.

    +
    >>> turtle.position()
    +(150.00,-0.00)
    +>>> turtle.color("blue")
    +>>> astamp = turtle.stamp()
    +>>> turtle.fd(50)
    +>>> turtle.position()
    +(200.00,-0.00)
    +>>> turtle.clearstamp(astamp)
    +>>> turtle.position()
    +(200.00,-0.00)
    +
    +
    +
    + +
    +
    +turtle.clearstamps(n=None)
    +
    +
    Parameters
    +

    n – an integer (or None)

    +
    +
    +

    Delete all or first/last n of turtle’s stamps. If n is None, delete +all stamps, if n > 0 delete first n stamps, else if n < 0 delete +last n stamps.

    +
    >>> for i in range(8):
    +...     turtle.stamp(); turtle.fd(30)
    +13
    +14
    +15
    +16
    +17
    +18
    +19
    +20
    +>>> turtle.clearstamps(2)
    +>>> turtle.clearstamps(-2)
    +>>> turtle.clearstamps()
    +
    +
    +
    + +
    +
    +turtle.undo()
    +

    Undo (repeatedly) the last turtle action(s). Number of available +undo actions is determined by the size of the undobuffer.

    +
    >>> for i in range(4):
    +...     turtle.fd(50); turtle.lt(80)
    +...
    +>>> for i in range(8):
    +...     turtle.undo()
    +
    +
    +
    + +
    +
    +turtle.speed(speed=None)
    +
    +
    Parameters
    +

    speed – an integer in the range 0..10 or a speedstring (see below)

    +
    +
    +

    Set the turtle’s speed to an integer value in the range 0..10. If no +argument is given, return current speed.

    +

    If input is a number greater than 10 or smaller than 0.5, speed is set +to 0. Speedstrings are mapped to speedvalues as follows:

    +
      +
    • “fastest”: 0

    • +
    • “fast”: 10

    • +
    • “normal”: 6

    • +
    • “slow”: 3

    • +
    • “slowest”: 1

    • +
    +

    Speeds from 1 to 10 enforce increasingly faster animation of line drawing +and turtle turning.

    +

    Attention: speed = 0 means that no animation takes +place. forward/back makes turtle jump and likewise left/right make the +turtle turn instantly.

    +
    >>> turtle.speed()
    +3
    +>>> turtle.speed('normal')
    +>>> turtle.speed()
    +6
    +>>> turtle.speed(9)
    +>>> turtle.speed()
    +9
    +
    +
    +
    + +
    +
    +

    Tell Turtle’s state

    +
    +
    +turtle.position()
    +
    +turtle.pos()
    +

    Return the turtle’s current location (x,y) (as a Vec2D vector).

    +
    >>> turtle.pos()
    +(440.00,-0.00)
    +
    +
    +
    + +
    +
    +turtle.towards(x, y=None)
    +
    +
    Parameters
    +
      +
    • x – a number or a pair/vector of numbers or a turtle instance

    • +
    • y – a number if x is a number, else None

    • +
    +
    +
    +

    Return the angle between the line from turtle position to position specified +by (x,y), the vector or the other turtle. This depends on the turtle’s start +orientation which depends on the mode - “standard”/”world” or “logo”).

    +
    >>> turtle.goto(10, 10)
    +>>> turtle.towards(0,0)
    +225.0
    +
    +
    +
    + +
    +
    +turtle.xcor()
    +

    Return the turtle’s x coordinate.

    +
    >>> turtle.home()
    +>>> turtle.left(50)
    +>>> turtle.forward(100)
    +>>> turtle.pos()
    +(64.28,76.60)
    +>>> print(round(turtle.xcor(), 5))
    +64.27876
    +
    +
    +
    + +
    +
    +turtle.ycor()
    +

    Return the turtle’s y coordinate.

    +
    >>> turtle.home()
    +>>> turtle.left(60)
    +>>> turtle.forward(100)
    +>>> print(turtle.pos())
    +(50.00,86.60)
    +>>> print(round(turtle.ycor(), 5))
    +86.60254
    +
    +
    +
    + +
    +
    +turtle.heading()
    +

    Return the turtle’s current heading (value depends on the turtle mode, see +mode()).

    +
    >>> turtle.home()
    +>>> turtle.left(67)
    +>>> turtle.heading()
    +67.0
    +
    +
    +
    + +
    +
    +turtle.distance(x, y=None)
    +
    +
    Parameters
    +
      +
    • x – a number or a pair/vector of numbers or a turtle instance

    • +
    • y – a number if x is a number, else None

    • +
    +
    +
    +

    Return the distance from the turtle to (x,y), the given vector, or the given +other turtle, in turtle step units.

    +
    >>> turtle.home()
    +>>> turtle.distance(30,40)
    +50.0
    +>>> turtle.distance((30,40))
    +50.0
    +>>> joe = Turtle()
    +>>> joe.forward(77)
    +>>> turtle.distance(joe)
    +77.0
    +
    +
    +
    + +
    +
    +

    Settings for measurement

    +
    +
    +turtle.degrees(fullcircle=360.0)
    +
    +
    Parameters
    +

    fullcircle – a number

    +
    +
    +

    Set angle measurement units, i.e. set number of “degrees” for a full circle. +Default value is 360 degrees.

    +
    >>> turtle.home()
    +>>> turtle.left(90)
    +>>> turtle.heading()
    +90.0
    +
    +Change angle measurement unit to grad (also known as gon,
    +grade, or gradian and equals 1/100-th of the right angle.)
    +>>> turtle.degrees(400.0)
    +>>> turtle.heading()
    +100.0
    +>>> turtle.degrees(360)
    +>>> turtle.heading()
    +90.0
    +
    +
    +
    + +
    +
    +turtle.radians()
    +

    Set the angle measurement units to radians. Equivalent to +degrees(2*math.pi).

    +
    >>> turtle.home()
    +>>> turtle.left(90)
    +>>> turtle.heading()
    +90.0
    +>>> turtle.radians()
    +>>> turtle.heading()
    +1.5707963267948966
    +
    +
    +
    + +
    +
    +

    Pen control

    +
    +

    Drawing state

    +
    +
    +turtle.pendown()
    +
    +turtle.pd()
    +
    +turtle.down()
    +

    Pull the pen down – drawing when moving.

    +
    + +
    +
    +turtle.penup()
    +
    +turtle.pu()
    +
    +turtle.up()
    +

    Pull the pen up – no drawing when moving.

    +
    + +
    +
    +turtle.pensize(width=None)
    +
    +turtle.width(width=None)
    +
    +
    Parameters
    +

    width – a positive number

    +
    +
    +

    Set the line thickness to width or return it. If resizemode is set to +“auto” and turtleshape is a polygon, that polygon is drawn with the same line +thickness. If no argument is given, the current pensize is returned.

    +
    >>> turtle.pensize()
    +1
    +>>> turtle.pensize(10)   # from here on lines of width 10 are drawn
    +
    +
    +
    + +
    +
    +turtle.pen(pen=None, **pendict)
    +
    +
    Parameters
    +
      +
    • pen – a dictionary with some or all of the below listed keys

    • +
    • pendict – one or more keyword-arguments with the below listed keys as keywords

    • +
    +
    +
    +

    Return or set the pen’s attributes in a “pen-dictionary” with the following +key/value pairs:

    +
      +
    • “shown”: True/False

    • +
    • “pendown”: True/False

    • +
    • “pencolor”: color-string or color-tuple

    • +
    • “fillcolor”: color-string or color-tuple

    • +
    • “pensize”: positive number

    • +
    • “speed”: number in range 0..10

    • +
    • “resizemode”: “auto” or “user” or “noresize”

    • +
    • “stretchfactor”: (positive number, positive number)

    • +
    • “outline”: positive number

    • +
    • “tilt”: number

    • +
    +

    This dictionary can be used as argument for a subsequent call to pen() +to restore the former pen-state. Moreover one or more of these attributes +can be provided as keyword-arguments. This can be used to set several pen +attributes in one statement.

    +
    >>> turtle.pen(fillcolor="black", pencolor="red", pensize=10)
    +>>> sorted(turtle.pen().items())
    +[('fillcolor', 'black'), ('outline', 1), ('pencolor', 'red'),
    + ('pendown', True), ('pensize', 10), ('resizemode', 'noresize'),
    + ('shearfactor', 0.0), ('shown', True), ('speed', 9),
    + ('stretchfactor', (1.0, 1.0)), ('tilt', 0.0)]
    +>>> penstate=turtle.pen()
    +>>> turtle.color("yellow", "")
    +>>> turtle.penup()
    +>>> sorted(turtle.pen().items())[:3]
    +[('fillcolor', ''), ('outline', 1), ('pencolor', 'yellow')]
    +>>> turtle.pen(penstate, fillcolor="green")
    +>>> sorted(turtle.pen().items())[:3]
    +[('fillcolor', 'green'), ('outline', 1), ('pencolor', 'red')]
    +
    +
    +
    + +
    +
    +turtle.isdown()
    +

    Return True if pen is down, False if it’s up.

    +
    >>> turtle.penup()
    +>>> turtle.isdown()
    +False
    +>>> turtle.pendown()
    +>>> turtle.isdown()
    +True
    +
    +
    +
    + +
    +
    +

    Color control

    +
    +
    +turtle.pencolor(*args)
    +

    Return or set the pencolor.

    +

    Four input formats are allowed:

    +
    +
    pencolor()

    Return the current pencolor as color specification string or +as a tuple (see example). May be used as input to another +color/pencolor/fillcolor call.

    +
    +
    pencolor(colorstring)

    Set pencolor to colorstring, which is a Tk color specification string, +such as "red", "yellow", or "#33cc8c".

    +
    +
    pencolor((r, g, b))

    Set pencolor to the RGB color represented by the tuple of r, g, and +b. Each of r, g, and b must be in the range 0..colormode, where +colormode is either 1.0 or 255 (see colormode()).

    +
    +
    pencolor(r, g, b)
    +

    Set pencolor to the RGB color represented by r, g, and b. Each of +r, g, and b must be in the range 0..colormode.

    +
    +

    If turtleshape is a polygon, the outline of that polygon is drawn with the +newly set pencolor.

    +
    +
    +
    >>> colormode()
    +1.0
    +>>> turtle.pencolor()
    +'red'
    +>>> turtle.pencolor("brown")
    +>>> turtle.pencolor()
    +'brown'
    +>>> tup = (0.2, 0.8, 0.55)
    +>>> turtle.pencolor(tup)
    +>>> turtle.pencolor()
    +(0.2, 0.8, 0.5490196078431373)
    +>>> colormode(255)
    +>>> turtle.pencolor()
    +(51.0, 204.0, 140.0)
    +>>> turtle.pencolor('#32c18f')
    +>>> turtle.pencolor()
    +(50.0, 193.0, 143.0)
    +
    +
    +
    + +
    +
    +turtle.fillcolor(*args)
    +

    Return or set the fillcolor.

    +

    Four input formats are allowed:

    +
    +
    fillcolor()

    Return the current fillcolor as color specification string, possibly +in tuple format (see example). May be used as input to another +color/pencolor/fillcolor call.

    +
    +
    fillcolor(colorstring)

    Set fillcolor to colorstring, which is a Tk color specification string, +such as "red", "yellow", or "#33cc8c".

    +
    +
    fillcolor((r, g, b))

    Set fillcolor to the RGB color represented by the tuple of r, g, and +b. Each of r, g, and b must be in the range 0..colormode, where +colormode is either 1.0 or 255 (see colormode()).

    +
    +
    fillcolor(r, g, b)
    +

    Set fillcolor to the RGB color represented by r, g, and b. Each of +r, g, and b must be in the range 0..colormode.

    +
    +

    If turtleshape is a polygon, the interior of that polygon is drawn +with the newly set fillcolor.

    +
    +
    +
    >>> turtle.fillcolor("violet")
    +>>> turtle.fillcolor()
    +'violet'
    +>>> turtle.pencolor()
    +(50.0, 193.0, 143.0)
    +>>> turtle.fillcolor((50, 193, 143))  # Integers, not floats
    +>>> turtle.fillcolor()
    +(50.0, 193.0, 143.0)
    +>>> turtle.fillcolor('#ffffff')
    +>>> turtle.fillcolor()
    +(255.0, 255.0, 255.0)
    +
    +
    +
    + +
    +
    +turtle.color(*args)
    +

    Return or set pencolor and fillcolor.

    +

    Several input formats are allowed. They use 0 to 3 arguments as +follows:

    +
    +
    color()

    Return the current pencolor and the current fillcolor as a pair of color +specification strings or tuples as returned by pencolor() and +fillcolor().

    +
    +
    color(colorstring), color((r,g,b)), color(r,g,b)

    Inputs as in pencolor(), set both, fillcolor and pencolor, to the +given value.

    +
    +
    color(colorstring1, colorstring2), color((r1,g1,b1), (r2,g2,b2))
    +

    Equivalent to pencolor(colorstring1) and fillcolor(colorstring2) +and analogously if the other input format is used.

    +
    +

    If turtleshape is a polygon, outline and interior of that polygon is drawn +with the newly set colors.

    +
    +
    +
    >>> turtle.color("red", "green")
    +>>> turtle.color()
    +('red', 'green')
    +>>> color("#285078", "#a0c8f0")
    +>>> color()
    +((40.0, 80.0, 120.0), (160.0, 200.0, 240.0))
    +
    +
    +
    + +

    See also: Screen method colormode().

    +
    +
    +

    Filling

    +
    +
    +turtle.filling()
    +

    Return fillstate (True if filling, False else).

    +
    >>> turtle.begin_fill()
    +>>> if turtle.filling():
    +...    turtle.pensize(5)
    +... else:
    +...    turtle.pensize(3)
    +
    +
    +
    + +
    +
    +turtle.begin_fill()
    +

    To be called just before drawing a shape to be filled.

    +
    + +
    +
    +turtle.end_fill()
    +

    Fill the shape drawn after the last call to begin_fill().

    +
    >>> turtle.color("black", "red")
    +>>> turtle.begin_fill()
    +>>> turtle.circle(80)
    +>>> turtle.end_fill()
    +
    +
    +
    + +
    +
    +

    More drawing control

    +
    +
    +turtle.reset()
    +

    Delete the turtle’s drawings from the screen, re-center the turtle and set +variables to the default values.

    +
    >>> turtle.goto(0,-22)
    +>>> turtle.left(100)
    +>>> turtle.position()
    +(0.00,-22.00)
    +>>> turtle.heading()
    +100.0
    +>>> turtle.reset()
    +>>> turtle.position()
    +(0.00,0.00)
    +>>> turtle.heading()
    +0.0
    +
    +
    +
    + +
    +
    +turtle.clear()
    +

    Delete the turtle’s drawings from the screen. Do not move turtle. State and +position of the turtle as well as drawings of other turtles are not affected.

    +
    + +
    +
    +turtle.write(arg, move=False, align="left", font=("Arial", 8, "normal"))
    +
    +
    Parameters
    +
      +
    • arg – object to be written to the TurtleScreen

    • +
    • move – True/False

    • +
    • align – one of the strings “left”, “center” or right”

    • +
    • font – a triple (fontname, fontsize, fonttype)

    • +
    +
    +
    +

    Write text - the string representation of arg - at the current turtle +position according to align (“left”, “center” or right”) and with the given +font. If move is true, the pen is moved to the bottom-right corner of the +text. By default, move is False.

    +
    >>> turtle.write("Home = ", True, align="center")
    +>>> turtle.write((0,0), True)
    +
    +
    +
    + +
    +
    +
    +

    Turtle state

    +
    +

    Visibility

    +
    +
    +turtle.hideturtle()
    +
    +turtle.ht()
    +

    Make the turtle invisible. It’s a good idea to do this while you’re in the +middle of doing some complex drawing, because hiding the turtle speeds up the +drawing observably.

    +
    >>> turtle.hideturtle()
    +
    +
    +
    + +
    +
    +turtle.showturtle()
    +
    +turtle.st()
    +

    Make the turtle visible.

    +
    >>> turtle.showturtle()
    +
    +
    +
    + +
    +
    +turtle.isvisible()
    +

    Return True if the Turtle is shown, False if it’s hidden.

    +
    >>> turtle.hideturtle()
    +>>> turtle.isvisible()
    +False
    +>>> turtle.showturtle()
    +>>> turtle.isvisible()
    +True
    +
    +
    +
    + +
    +
    +

    Appearance

    +
    +
    +turtle.shape(name=None)
    +
    +
    Parameters
    +

    name – a string which is a valid shapename

    +
    +
    +

    Set turtle shape to shape with given name or, if name is not given, return +name of current shape. Shape with name must exist in the TurtleScreen’s +shape dictionary. Initially there are the following polygon shapes: “arrow”, +“turtle”, “circle”, “square”, “triangle”, “classic”. To learn about how to +deal with shapes see Screen method register_shape().

    +
    >>> turtle.shape()
    +'classic'
    +>>> turtle.shape("turtle")
    +>>> turtle.shape()
    +'turtle'
    +
    +
    +
    + +
    +
    +turtle.resizemode(rmode=None)
    +
    +
    Parameters
    +

    rmode – one of the strings “auto”, “user”, “noresize”

    +
    +
    +

    Set resizemode to one of the values: “auto”, “user”, “noresize”. If rmode +is not given, return current resizemode. Different resizemodes have the +following effects:

    +
      +
    • “auto”: adapts the appearance of the turtle corresponding to the value of pensize.

    • +
    • “user”: adapts the appearance of the turtle according to the values of +stretchfactor and outlinewidth (outline), which are set by +shapesize().

    • +
    • “noresize”: no adaption of the turtle’s appearance takes place.

    • +
    +

    resizemode(“user”) is called by shapesize() when used with arguments.

    +
    >>> turtle.resizemode()
    +'noresize'
    +>>> turtle.resizemode("auto")
    +>>> turtle.resizemode()
    +'auto'
    +
    +
    +
    + +
    +
    +turtle.shapesize(stretch_wid=None, stretch_len=None, outline=None)
    +
    +turtle.turtlesize(stretch_wid=None, stretch_len=None, outline=None)
    +
    +
    Parameters
    +
      +
    • stretch_wid – positive number

    • +
    • stretch_len – positive number

    • +
    • outline – positive number

    • +
    +
    +
    +

    Return or set the pen’s attributes x/y-stretchfactors and/or outline. Set +resizemode to “user”. If and only if resizemode is set to “user”, the turtle +will be displayed stretched according to its stretchfactors: stretch_wid is +stretchfactor perpendicular to its orientation, stretch_len is +stretchfactor in direction of its orientation, outline determines the width +of the shapes’s outline.

    +
    >>> turtle.shapesize()
    +(1.0, 1.0, 1)
    +>>> turtle.resizemode("user")
    +>>> turtle.shapesize(5, 5, 12)
    +>>> turtle.shapesize()
    +(5, 5, 12)
    +>>> turtle.shapesize(outline=8)
    +>>> turtle.shapesize()
    +(5, 5, 8)
    +
    +
    +
    + +
    +
    +turtle.shearfactor(shear=None)
    +
    +
    Parameters
    +

    shear – number (optional)

    +
    +
    +

    Set or return the current shearfactor. Shear the turtleshape according to +the given shearfactor shear, which is the tangent of the shear angle. +Do not change the turtle’s heading (direction of movement). +If shear is not given: return the current shearfactor, i. e. the +tangent of the shear angle, by which lines parallel to the +heading of the turtle are sheared.

    +
    >>> turtle.shape("circle")
    +>>> turtle.shapesize(5,2)
    +>>> turtle.shearfactor(0.5)
    +>>> turtle.shearfactor()
    +0.5
    +
    +
    +
    + +
    +
    +turtle.tilt(angle)
    +
    +
    Parameters
    +

    angle – a number

    +
    +
    +

    Rotate the turtleshape by angle from its current tilt-angle, but do not +change the turtle’s heading (direction of movement).

    +
    >>> turtle.reset()
    +>>> turtle.shape("circle")
    +>>> turtle.shapesize(5,2)
    +>>> turtle.tilt(30)
    +>>> turtle.fd(50)
    +>>> turtle.tilt(30)
    +>>> turtle.fd(50)
    +
    +
    +
    + +
    +
    +turtle.settiltangle(angle)
    +
    +
    Parameters
    +

    angle – a number

    +
    +
    +

    Rotate the turtleshape to point in the direction specified by angle, +regardless of its current tilt-angle. Do not change the turtle’s heading +(direction of movement).

    +
    >>> turtle.reset()
    +>>> turtle.shape("circle")
    +>>> turtle.shapesize(5,2)
    +>>> turtle.settiltangle(45)
    +>>> turtle.fd(50)
    +>>> turtle.settiltangle(-45)
    +>>> turtle.fd(50)
    +
    +
    +
    +

    Deprecated since version 3.1.

    +
    +
    + +
    +
    +turtle.tiltangle(angle=None)
    +
    +
    Parameters
    +

    angle – a number (optional)

    +
    +
    +

    Set or return the current tilt-angle. If angle is given, rotate the +turtleshape to point in the direction specified by angle, +regardless of its current tilt-angle. Do not change the turtle’s +heading (direction of movement). +If angle is not given: return the current tilt-angle, i. e. the angle +between the orientation of the turtleshape and the heading of the +turtle (its direction of movement).

    +
    >>> turtle.reset()
    +>>> turtle.shape("circle")
    +>>> turtle.shapesize(5,2)
    +>>> turtle.tilt(45)
    +>>> turtle.tiltangle()
    +45.0
    +
    +
    +
    + +
    +
    +turtle.shapetransform(t11=None, t12=None, t21=None, t22=None)
    +
    +
    Parameters
    +
      +
    • t11 – a number (optional)

    • +
    • t12 – a number (optional)

    • +
    • t21 – a number (optional)

    • +
    • t12 – a number (optional)

    • +
    +
    +
    +

    Set or return the current transformation matrix of the turtle shape.

    +

    If none of the matrix elements are given, return the transformation +matrix as a tuple of 4 elements. +Otherwise set the given elements and transform the turtleshape +according to the matrix consisting of first row t11, t12 and +second row t21, 22. The determinant t11 * t22 - t12 * t21 must not be +zero, otherwise an error is raised. +Modify stretchfactor, shearfactor and tiltangle according to the +given matrix.

    +
    >>> turtle = Turtle()
    +>>> turtle.shape("square")
    +>>> turtle.shapesize(4,2)
    +>>> turtle.shearfactor(-0.5)
    +>>> turtle.shapetransform()
    +(4.0, -1.0, -0.0, 2.0)
    +
    +
    +
    + +
    +
    +turtle.get_shapepoly()
    +

    Return the current shape polygon as tuple of coordinate pairs. This +can be used to define a new shape or components of a compound shape.

    +
    >>> turtle.shape("square")
    +>>> turtle.shapetransform(4, -1, 0, 2)
    +>>> turtle.get_shapepoly()
    +((50, -20), (30, 20), (-50, 20), (-30, -20))
    +
    +
    +
    + +
    +
    +
    +

    Using events

    +
    +
    +turtle.onclick(fun, btn=1, add=None)
    +
    +
    Parameters
    +
      +
    • fun – a function with two arguments which will be called with the +coordinates of the clicked point on the canvas

    • +
    • btn – number of the mouse-button, defaults to 1 (left mouse button)

    • +
    • addTrue or False – if True, a new binding will be +added, otherwise it will replace a former binding

    • +
    +
    +
    +

    Bind fun to mouse-click events on this turtle. If fun is None, +existing bindings are removed. Example for the anonymous turtle, i.e. the +procedural way:

    +
    >>> def turn(x, y):
    +...     left(180)
    +...
    +>>> onclick(turn)  # Now clicking into the turtle will turn it.
    +>>> onclick(None)  # event-binding will be removed
    +
    +
    +
    + +
    +
    +turtle.onrelease(fun, btn=1, add=None)
    +
    +
    Parameters
    +
      +
    • fun – a function with two arguments which will be called with the +coordinates of the clicked point on the canvas

    • +
    • btn – number of the mouse-button, defaults to 1 (left mouse button)

    • +
    • addTrue or False – if True, a new binding will be +added, otherwise it will replace a former binding

    • +
    +
    +
    +

    Bind fun to mouse-button-release events on this turtle. If fun is +None, existing bindings are removed.

    +
    >>> class MyTurtle(Turtle):
    +...     def glow(self,x,y):
    +...         self.fillcolor("red")
    +...     def unglow(self,x,y):
    +...         self.fillcolor("")
    +...
    +>>> turtle = MyTurtle()
    +>>> turtle.onclick(turtle.glow)     # clicking on turtle turns fillcolor red,
    +>>> turtle.onrelease(turtle.unglow) # releasing turns it to transparent.
    +
    +
    +
    + +
    +
    +turtle.ondrag(fun, btn=1, add=None)
    +
    +
    Parameters
    +
      +
    • fun – a function with two arguments which will be called with the +coordinates of the clicked point on the canvas

    • +
    • btn – number of the mouse-button, defaults to 1 (left mouse button)

    • +
    • addTrue or False – if True, a new binding will be +added, otherwise it will replace a former binding

    • +
    +
    +
    +

    Bind fun to mouse-move events on this turtle. If fun is None, +existing bindings are removed.

    +

    Remark: Every sequence of mouse-move-events on a turtle is preceded by a +mouse-click event on that turtle.

    +
    >>> turtle.ondrag(turtle.goto)
    +
    +
    +

    Subsequently, clicking and dragging the Turtle will move it across +the screen thereby producing handdrawings (if pen is down).

    +
    + +
    +
    +

    Special Turtle methods

    +
    +
    +turtle.begin_poly()
    +

    Start recording the vertices of a polygon. Current turtle position is first +vertex of polygon.

    +
    + +
    +
    +turtle.end_poly()
    +

    Stop recording the vertices of a polygon. Current turtle position is last +vertex of polygon. This will be connected with the first vertex.

    +
    + +
    +
    +turtle.get_poly()
    +

    Return the last recorded polygon.

    +
    >>> turtle.home()
    +>>> turtle.begin_poly()
    +>>> turtle.fd(100)
    +>>> turtle.left(20)
    +>>> turtle.fd(30)
    +>>> turtle.left(60)
    +>>> turtle.fd(50)
    +>>> turtle.end_poly()
    +>>> p = turtle.get_poly()
    +>>> register_shape("myFavouriteShape", p)
    +
    +
    +
    + +
    +
    +turtle.clone()
    +

    Create and return a clone of the turtle with same position, heading and +turtle properties.

    +
    >>> mick = Turtle()
    +>>> joe = mick.clone()
    +
    +
    +
    + +
    +
    +turtle.getturtle()
    +
    +turtle.getpen()
    +

    Return the Turtle object itself. Only reasonable use: as a function to +return the “anonymous turtle”:

    +
    >>> pet = getturtle()
    +>>> pet.fd(50)
    +>>> pet
    +<turtle.Turtle object at 0x...>
    +
    +
    +
    + +
    +
    +turtle.getscreen()
    +

    Return the TurtleScreen object the turtle is drawing on. +TurtleScreen methods can then be called for that object.

    +
    >>> ts = turtle.getscreen()
    +>>> ts
    +<turtle._Screen object at 0x...>
    +>>> ts.bgcolor("pink")
    +
    +
    +
    + +
    +
    +turtle.setundobuffer(size)
    +
    +
    Parameters
    +

    size – an integer or None

    +
    +
    +

    Set or disable undobuffer. If size is an integer an empty undobuffer of +given size is installed. size gives the maximum number of turtle actions +that can be undone by the undo() method/function. If size is +None, the undobuffer is disabled.

    +
    >>> turtle.setundobuffer(42)
    +
    +
    +
    + +
    +
    +turtle.undobufferentries()
    +

    Return number of entries in the undobuffer.

    +
    >>> while undobufferentries():
    +...     undo()
    +
    +
    +
    + +
    +
    +

    Compound shapes

    +

    To use compound turtle shapes, which consist of several polygons of different +color, you must use the helper class Shape explicitly as described +below:

    +
      +
    1. Create an empty Shape object of type “compound”.

    2. +
    3. Add as many components to this object as desired, using the +addcomponent() method.

      +

      For example:

      +
      >>> s = Shape("compound")
      +>>> poly1 = ((0,0),(10,-5),(0,10),(-10,-5))
      +>>> s.addcomponent(poly1, "red", "blue")
      +>>> poly2 = ((0,0),(10,-5),(-10,-5))
      +>>> s.addcomponent(poly2, "blue", "red")
      +
      +
      +
    4. +
    5. Now add the Shape to the Screen’s shapelist and use it:

      +
      >>> register_shape("myshape", s)
      +>>> shape("myshape")
      +
      +
      +
    6. +
    +
    +

    Note

    +

    The Shape class is used internally by the register_shape() +method in different ways. The application programmer has to deal with the +Shape class only when using compound shapes like shown above!

    +
    +
    +
    +
    +

    Methods of TurtleScreen/Screen and corresponding functions

    +

    Most of the examples in this section refer to a TurtleScreen instance called +screen.

    +
    +

    Window control

    +
    +
    +turtle.bgcolor(*args)
    +
    +
    Parameters
    +

    args – a color string or three numbers in the range 0..colormode or a +3-tuple of such numbers

    +
    +
    +

    Set or return background color of the TurtleScreen.

    +
    >>> screen.bgcolor("orange")
    +>>> screen.bgcolor()
    +'orange'
    +>>> screen.bgcolor("#800080")
    +>>> screen.bgcolor()
    +(128.0, 0.0, 128.0)
    +
    +
    +
    + +
    +
    +turtle.bgpic(picname=None)
    +
    +
    Parameters
    +

    picname – a string, name of a gif-file or "nopic", or None

    +
    +
    +

    Set background image or return name of current backgroundimage. If picname +is a filename, set the corresponding image as background. If picname is +"nopic", delete background image, if present. If picname is None, +return the filename of the current backgroundimage.

    +
    >>> screen.bgpic()
    +'nopic'
    +>>> screen.bgpic("landscape.gif")
    +>>> screen.bgpic()
    +"landscape.gif"
    +
    +
    +
    + +
    +
    +turtle.clear()
    +
    +turtle.clearscreen()
    +

    Delete all drawings and all turtles from the TurtleScreen. Reset the now +empty TurtleScreen to its initial state: white background, no background +image, no event bindings and tracing on.

    +
    +

    Note

    +

    This TurtleScreen method is available as a global function only under the +name clearscreen. The global function clear is a different one +derived from the Turtle method clear.

    +
    +
    + +
    +
    +turtle.reset()
    +
    +turtle.resetscreen()
    +

    Reset all Turtles on the Screen to their initial state.

    +
    +

    Note

    +

    This TurtleScreen method is available as a global function only under the +name resetscreen. The global function reset is another one +derived from the Turtle method reset.

    +
    +
    + +
    +
    +turtle.screensize(canvwidth=None, canvheight=None, bg=None)
    +
    +
    Parameters
    +
      +
    • canvwidth – positive integer, new width of canvas in pixels

    • +
    • canvheight – positive integer, new height of canvas in pixels

    • +
    • bg – colorstring or color-tuple, new background color

    • +
    +
    +
    +

    If no arguments are given, return current (canvaswidth, canvasheight). Else +resize the canvas the turtles are drawing on. Do not alter the drawing +window. To observe hidden parts of the canvas, use the scrollbars. With this +method, one can make visible those parts of a drawing which were outside the +canvas before.

    +
    >>> screen.screensize()
    +(400, 300)
    +>>> screen.screensize(2000,1500)
    +>>> screen.screensize()
    +(2000, 1500)
    +
    +
    +

    e.g. to search for an erroneously escaped turtle ;-)

    +
    + +
    +
    +turtle.setworldcoordinates(llx, lly, urx, ury)
    +
    +
    Parameters
    +
      +
    • llx – a number, x-coordinate of lower left corner of canvas

    • +
    • lly – a number, y-coordinate of lower left corner of canvas

    • +
    • urx – a number, x-coordinate of upper right corner of canvas

    • +
    • ury – a number, y-coordinate of upper right corner of canvas

    • +
    +
    +
    +

    Set up user-defined coordinate system and switch to mode “world” if +necessary. This performs a screen.reset(). If mode “world” is already +active, all drawings are redrawn according to the new coordinates.

    +

    ATTENTION: in user-defined coordinate systems angles may appear +distorted.

    +
    >>> screen.reset()
    +>>> screen.setworldcoordinates(-50,-7.5,50,7.5)
    +>>> for _ in range(72):
    +...     left(10)
    +...
    +>>> for _ in range(8):
    +...     left(45); fd(2)   # a regular octagon
    +
    +
    +
    + +
    +
    +

    Animation control

    +
    +
    +turtle.delay(delay=None)
    +
    +
    Parameters
    +

    delay – positive integer

    +
    +
    +

    Set or return the drawing delay in milliseconds. (This is approximately +the time interval between two consecutive canvas updates.) The longer the +drawing delay, the slower the animation.

    +

    Optional argument:

    +
    >>> screen.delay()
    +10
    +>>> screen.delay(5)
    +>>> screen.delay()
    +5
    +
    +
    +
    + +
    +
    +turtle.tracer(n=None, delay=None)
    +
    +
    Parameters
    +
      +
    • n – nonnegative integer

    • +
    • delay – nonnegative integer

    • +
    +
    +
    +

    Turn turtle animation on/off and set delay for update drawings. If +n is given, only each n-th regular screen update is really +performed. (Can be used to accelerate the drawing of complex +graphics.) When called without arguments, returns the currently +stored value of n. Second argument sets delay value (see +delay()).

    +
    >>> screen.tracer(8, 25)
    +>>> dist = 2
    +>>> for i in range(200):
    +...     fd(dist)
    +...     rt(90)
    +...     dist += 2
    +
    +
    +
    + +
    +
    +turtle.update()
    +

    Perform a TurtleScreen update. To be used when tracer is turned off.

    +
    + +

    See also the RawTurtle/Turtle method speed().

    +
    +
    +

    Using screen events

    +
    +
    +turtle.listen(xdummy=None, ydummy=None)
    +

    Set focus on TurtleScreen (in order to collect key-events). Dummy arguments +are provided in order to be able to pass listen() to the onclick method.

    +
    + +
    +
    +turtle.onkey(fun, key)
    +
    +turtle.onkeyrelease(fun, key)
    +
    +
    Parameters
    +
      +
    • fun – a function with no arguments or None

    • +
    • key – a string: key (e.g. “a”) or key-symbol (e.g. “space”)

    • +
    +
    +
    +

    Bind fun to key-release event of key. If fun is None, event bindings +are removed. Remark: in order to be able to register key-events, TurtleScreen +must have the focus. (See method listen().)

    +
    >>> def f():
    +...     fd(50)
    +...     lt(60)
    +...
    +>>> screen.onkey(f, "Up")
    +>>> screen.listen()
    +
    +
    +
    + +
    +
    +turtle.onkeypress(fun, key=None)
    +
    +
    Parameters
    +
      +
    • fun – a function with no arguments or None

    • +
    • key – a string: key (e.g. “a”) or key-symbol (e.g. “space”)

    • +
    +
    +
    +

    Bind fun to key-press event of key if key is given, +or to any key-press-event if no key is given. +Remark: in order to be able to register key-events, TurtleScreen +must have focus. (See method listen().)

    +
    >>> def f():
    +...     fd(50)
    +...
    +>>> screen.onkey(f, "Up")
    +>>> screen.listen()
    +
    +
    +
    + +
    +
    +turtle.onclick(fun, btn=1, add=None)
    +
    +turtle.onscreenclick(fun, btn=1, add=None)
    +
    +
    Parameters
    +
      +
    • fun – a function with two arguments which will be called with the +coordinates of the clicked point on the canvas

    • +
    • btn – number of the mouse-button, defaults to 1 (left mouse button)

    • +
    • addTrue or False – if True, a new binding will be +added, otherwise it will replace a former binding

    • +
    +
    +
    +

    Bind fun to mouse-click events on this screen. If fun is None, +existing bindings are removed.

    +

    Example for a TurtleScreen instance named screen and a Turtle instance +named turtle:

    +
    >>> screen.onclick(turtle.goto) # Subsequently clicking into the TurtleScreen will
    +>>>                             # make the turtle move to the clicked point.
    +>>> screen.onclick(None)        # remove event binding again
    +
    +
    +
    +

    Note

    +

    This TurtleScreen method is available as a global function only under the +name onscreenclick. The global function onclick is another one +derived from the Turtle method onclick.

    +
    +
    + +
    +
    +turtle.ontimer(fun, t=0)
    +
    +
    Parameters
    +
      +
    • fun – a function with no arguments

    • +
    • t – a number >= 0

    • +
    +
    +
    +

    Install a timer that calls fun after t milliseconds.

    +
    >>> running = True
    +>>> def f():
    +...     if running:
    +...         fd(50)
    +...         lt(60)
    +...         screen.ontimer(f, 250)
    +>>> f()   ### makes the turtle march around
    +>>> running = False
    +
    +
    +
    + +
    +
    +turtle.mainloop()
    +
    +turtle.done()
    +

    Starts event loop - calling Tkinter’s mainloop function. +Must be the last statement in a turtle graphics program. +Must not be used if a script is run from within IDLE in -n mode +(No subprocess) - for interactive use of turtle graphics.

    +
    >>> screen.mainloop()
    +
    +
    +
    + +
    +
    +

    Input methods

    +
    +
    +turtle.textinput(title, prompt)
    +
    +
    Parameters
    +
      +
    • title – string

    • +
    • prompt – string

    • +
    +
    +
    +

    Pop up a dialog window for input of a string. Parameter title is +the title of the dialog window, prompt is a text mostly describing +what information to input. +Return the string input. If the dialog is canceled, return None.

    +
    >>> screen.textinput("NIM", "Name of first player:")
    +
    +
    +
    + +
    +
    +turtle.numinput(title, prompt, default=None, minval=None, maxval=None)
    +
    +
    Parameters
    +
      +
    • title – string

    • +
    • prompt – string

    • +
    • default – number (optional)

    • +
    • minval – number (optional)

    • +
    • maxval – number (optional)

    • +
    +
    +
    +

    Pop up a dialog window for input of a number. title is the title of the +dialog window, prompt is a text mostly describing what numerical information +to input. default: default value, minval: minimum value for input, +maxval: maximum value for input +The number input must be in the range minval .. maxval if these are +given. If not, a hint is issued and the dialog remains open for +correction. +Return the number input. If the dialog is canceled, return None.

    +
    >>> screen.numinput("Poker", "Your stakes:", 1000, minval=10, maxval=10000)
    +
    +
    +
    + +
    +
    +

    Settings and special methods

    +
    +
    +turtle.mode(mode=None)
    +
    +
    Parameters
    +

    mode – one of the strings “standard”, “logo” or “world”

    +
    +
    +

    Set turtle mode (“standard”, “logo” or “world”) and perform reset. If mode +is not given, current mode is returned.

    +

    Mode “standard” is compatible with old turtle. Mode “logo” is +compatible with most Logo turtle graphics. Mode “world” uses user-defined +“world coordinates”. Attention: in this mode angles appear distorted if +x/y unit-ratio doesn’t equal 1.

    + +++++ + + + + + + + + + + + + + + + + +

    Mode

    Initial turtle heading

    positive angles

    “standard”

    to the right (east)

    counterclockwise

    “logo”

    upward (north)

    clockwise

    +
    >>> mode("logo")   # resets turtle heading to north
    +>>> mode()
    +'logo'
    +
    +
    +
    + +
    +
    +turtle.colormode(cmode=None)
    +
    +
    Parameters
    +

    cmode – one of the values 1.0 or 255

    +
    +
    +

    Return the colormode or set it to 1.0 or 255. Subsequently r, g, b +values of color triples have to be in the range 0..cmode.

    +
    >>> screen.colormode(1)
    +>>> turtle.pencolor(240, 160, 80)
    +Traceback (most recent call last):
    +     ...
    +TurtleGraphicsError: bad color sequence: (240, 160, 80)
    +>>> screen.colormode()
    +1.0
    +>>> screen.colormode(255)
    +>>> screen.colormode()
    +255
    +>>> turtle.pencolor(240,160,80)
    +
    +
    +
    + +
    +
    +turtle.getcanvas()
    +

    Return the Canvas of this TurtleScreen. Useful for insiders who know what to +do with a Tkinter Canvas.

    +
    >>> cv = screen.getcanvas()
    +>>> cv
    +<turtle.ScrolledCanvas object ...>
    +
    +
    +
    + +
    +
    +turtle.getshapes()
    +

    Return a list of names of all currently available turtle shapes.

    +
    >>> screen.getshapes()
    +['arrow', 'blank', 'circle', ..., 'turtle']
    +
    +
    +
    + +
    +
    +turtle.register_shape(name, shape=None)
    +
    +turtle.addshape(name, shape=None)
    +

    There are three different ways to call this function:

    +
      +
    1. name is the name of a gif-file and shape is None: Install the +corresponding image shape.

      +
      >>> screen.register_shape("turtle.gif")
      +
      +
      +
      +

      Note

      +

      Image shapes do not rotate when turning the turtle, so they do not +display the heading of the turtle!

      +
      +
    2. +
    3. name is an arbitrary string and shape is a tuple of pairs of +coordinates: Install the corresponding polygon shape.

      +
      >>> screen.register_shape("triangle", ((5,-3), (0,5), (-5,-3)))
      +
      +
      +
    4. +
    5. name is an arbitrary string and shape is a (compound) Shape +object: Install the corresponding compound shape.

    6. +
    +

    Add a turtle shape to TurtleScreen’s shapelist. Only thusly registered +shapes can be used by issuing the command shape(shapename).

    +
    + +
    +
    +turtle.turtles()
    +

    Return the list of turtles on the screen.

    +
    >>> for turtle in screen.turtles():
    +...     turtle.color("red")
    +
    +
    +
    + +
    +
    +turtle.window_height()
    +

    Return the height of the turtle window.

    +
    >>> screen.window_height()
    +480
    +
    +
    +
    + +
    +
    +turtle.window_width()
    +

    Return the width of the turtle window.

    +
    >>> screen.window_width()
    +640
    +
    +
    +
    + +
    +
    +

    Methods specific to Screen, not inherited from TurtleScreen

    +
    +
    +turtle.bye()
    +

    Shut the turtlegraphics window.

    +
    + +
    +
    +turtle.exitonclick()
    +

    Bind bye() method to mouse clicks on the Screen.

    +

    If the value “using_IDLE” in the configuration dictionary is False +(default value), also enter mainloop. Remark: If IDLE with the -n switch +(no subprocess) is used, this value should be set to True in +turtle.cfg. In this case IDLE’s own mainloop is active also for the +client script.

    +
    + +
    +
    +turtle.setup(width=_CFG["width"], height=_CFG["height"], startx=_CFG["leftright"], starty=_CFG["topbottom"])
    +

    Set the size and position of the main window. Default values of arguments +are stored in the configuration dictionary and can be changed via a +turtle.cfg file.

    +
    +
    Parameters
    +
      +
    • width – if an integer, a size in pixels, if a float, a fraction of the +screen; default is 50% of screen

    • +
    • height – if an integer, the height in pixels, if a float, a fraction of +the screen; default is 75% of screen

    • +
    • startx – if positive, starting position in pixels from the left +edge of the screen, if negative from the right edge, if None, +center window horizontally

    • +
    • starty – if positive, starting position in pixels from the top +edge of the screen, if negative from the bottom edge, if None, +center window vertically

    • +
    +
    +
    +
    >>> screen.setup (width=200, height=200, startx=0, starty=0)
    +>>>              # sets window to 200x200 pixels, in upper left of screen
    +>>> screen.setup(width=.75, height=0.5, startx=None, starty=None)
    +>>>              # sets window to 75% of screen by 50% of screen and centers
    +
    +
    +
    + +
    +
    +turtle.title(titlestring)
    +
    +
    Parameters
    +

    titlestring – a string that is shown in the titlebar of the turtle +graphics window

    +
    +
    +

    Set title of turtle window to titlestring.

    +
    >>> screen.title("Welcome to the turtle zoo!")
    +
    +
    +
    + +
    +
    +
    +

    Public classes

    +
    +
    +class turtle.RawTurtle(canvas)
    +
    +class turtle.RawPen(canvas)
    +
    +
    Parameters
    +

    canvas – a tkinter.Canvas, a ScrolledCanvas or a +TurtleScreen

    +
    +
    +

    Create a turtle. The turtle has all methods described above as “methods of +Turtle/RawTurtle”.

    +
    + +
    +
    +class turtle.Turtle
    +

    Subclass of RawTurtle, has the same interface but draws on a default +Screen object created automatically when needed for the first time.

    +
    + +
    +
    +class turtle.TurtleScreen(cv)
    +
    +
    Parameters
    +

    cv – a tkinter.Canvas

    +
    +
    +

    Provides screen oriented methods like setbg() etc. that are described +above.

    +
    + +
    +
    +class turtle.Screen
    +

    Subclass of TurtleScreen, with four methods added.

    +
    + +
    +
    +class turtle.ScrolledCanvas(master)
    +
    +
    Parameters
    +

    master – some Tkinter widget to contain the ScrolledCanvas, i.e. +a Tkinter-canvas with scrollbars added

    +
    +
    +

    Used by class Screen, which thus automatically provides a ScrolledCanvas as +playground for the turtles.

    +
    + +
    +
    +class turtle.Shape(type_, data)
    +
    +
    Parameters
    +

    type_ – one of the strings “polygon”, “image”, “compound”

    +
    +
    +

    Data structure modeling shapes. The pair (type_, data) must follow this +specification:

    + ++++ + + + + + + + + + + + + + + + + +

    type_

    data

    “polygon”

    a polygon-tuple, i.e. a tuple of pairs of coordinates

    “image”

    an image (in this form only used internally!)

    “compound”

    None (a compound shape has to be constructed using the +addcomponent() method)

    +
    +
    +addcomponent(poly, fill, outline=None)
    +
    +
    Parameters
    +
      +
    • poly – a polygon, i.e. a tuple of pairs of numbers

    • +
    • fill – a color the poly will be filled with

    • +
    • outline – a color for the poly’s outline (if given)

    • +
    +
    +
    +

    Example:

    +
    >>> poly = ((0,0),(10,-5),(0,10),(-10,-5))
    +>>> s = Shape("compound")
    +>>> s.addcomponent(poly, "red", "blue")
    +>>> # ... add more components and then use register_shape()
    +
    +
    +

    See Compound shapes.

    +
    + +
    + +
    +
    +class turtle.Vec2D(x, y)
    +

    A two-dimensional vector class, used as a helper class for implementing +turtle graphics. May be useful for turtle graphics programs too. Derived +from tuple, so a vector is a tuple!

    +

    Provides (for a, b vectors, k number):

    +
      +
    • a + b vector addition

    • +
    • a - b vector subtraction

    • +
    • a * b inner product

    • +
    • k * a and a * k multiplication with scalar

    • +
    • abs(a) absolute value of a

    • +
    • a.rotate(angle) rotation

    • +
    +
    + +
    +
    +

    Help and configuration

    +
    +

    How to use help

    +

    The public methods of the Screen and Turtle classes are documented extensively +via docstrings. So these can be used as online-help via the Python help +facilities:

    +
      +
    • When using IDLE, tooltips show the signatures and first lines of the +docstrings of typed in function-/method calls.

    • +
    • Calling help() on methods or functions displays the docstrings:

      +
      >>> help(Screen.bgcolor)
      +Help on method bgcolor in module turtle:
      +
      +bgcolor(self, *args) unbound turtle.Screen method
      +    Set or return backgroundcolor of the TurtleScreen.
      +
      +    Arguments (if given): a color string or three numbers
      +    in the range 0..colormode or a 3-tuple of such numbers.
      +
      +
      +      >>> screen.bgcolor("orange")
      +      >>> screen.bgcolor()
      +      "orange"
      +      >>> screen.bgcolor(0.5,0,0.5)
      +      >>> screen.bgcolor()
      +      "#800080"
      +
      +>>> help(Turtle.penup)
      +Help on method penup in module turtle:
      +
      +penup(self) unbound turtle.Turtle method
      +    Pull the pen up -- no drawing when moving.
      +
      +    Aliases: penup | pu | up
      +
      +    No argument
      +
      +    >>> turtle.penup()
      +
      +
      +
    • +
    • The docstrings of the functions which are derived from methods have a modified +form:

      +
      >>> help(bgcolor)
      +Help on function bgcolor in module turtle:
      +
      +bgcolor(*args)
      +    Set or return backgroundcolor of the TurtleScreen.
      +
      +    Arguments (if given): a color string or three numbers
      +    in the range 0..colormode or a 3-tuple of such numbers.
      +
      +    Example::
      +
      +      >>> bgcolor("orange")
      +      >>> bgcolor()
      +      "orange"
      +      >>> bgcolor(0.5,0,0.5)
      +      >>> bgcolor()
      +      "#800080"
      +
      +>>> help(penup)
      +Help on function penup in module turtle:
      +
      +penup()
      +    Pull the pen up -- no drawing when moving.
      +
      +    Aliases: penup | pu | up
      +
      +    No argument
      +
      +    Example:
      +    >>> penup()
      +
      +
      +
    • +
    +

    These modified docstrings are created automatically together with the function +definitions that are derived from the methods at import time.

    +
    +
    +

    Translation of docstrings into different languages

    +

    There is a utility to create a dictionary the keys of which are the method names +and the values of which are the docstrings of the public methods of the classes +Screen and Turtle.

    +
    +
    +turtle.write_docstringdict(filename="turtle_docstringdict")
    +
    +
    Parameters
    +

    filename – a string, used as filename

    +
    +
    +

    Create and write docstring-dictionary to a Python script with the given +filename. This function has to be called explicitly (it is not used by the +turtle graphics classes). The docstring dictionary will be written to the +Python script filename.py. It is intended to serve as a template +for translation of the docstrings into different languages.

    +
    + +

    If you (or your students) want to use turtle with online help in your +native language, you have to translate the docstrings and save the resulting +file as e.g. turtle_docstringdict_german.py.

    +

    If you have an appropriate entry in your turtle.cfg file this dictionary +will be read in at import time and will replace the original English docstrings.

    +

    At the time of this writing there are docstring dictionaries in German and in +Italian. (Requests please to glingl@aon.at.)

    +
    +
    +

    How to configure Screen and Turtles

    +

    The built-in default configuration mimics the appearance and behaviour of the +old turtle module in order to retain best possible compatibility with it.

    +

    If you want to use a different configuration which better reflects the features +of this module or which better fits to your needs, e.g. for use in a classroom, +you can prepare a configuration file turtle.cfg which will be read at import +time and modify the configuration according to its settings.

    +

    The built in configuration would correspond to the following turtle.cfg:

    +
    width = 0.5
    +height = 0.75
    +leftright = None
    +topbottom = None
    +canvwidth = 400
    +canvheight = 300
    +mode = standard
    +colormode = 1.0
    +delay = 10
    +undobuffersize = 1000
    +shape = classic
    +pencolor = black
    +fillcolor = black
    +resizemode = noresize
    +visible = True
    +language = english
    +exampleturtle = turtle
    +examplescreen = screen
    +title = Python Turtle Graphics
    +using_IDLE = False
    +
    +
    +

    Short explanation of selected entries:

    +
      +
    • The first four lines correspond to the arguments of the Screen.setup() +method.

    • +
    • Line 5 and 6 correspond to the arguments of the method +Screen.screensize().

    • +
    • shape can be any of the built-in shapes, e.g: arrow, turtle, etc. For more +info try help(shape).

    • +
    • If you want to use no fillcolor (i.e. make the turtle transparent), you have +to write fillcolor = "" (but all nonempty strings must not have quotes in +the cfg-file).

    • +
    • If you want to reflect the turtle its state, you have to use resizemode = +auto.

    • +
    • If you set e.g. language = italian the docstringdict +turtle_docstringdict_italian.py will be loaded at import time (if +present on the import path, e.g. in the same directory as turtle.

    • +
    • The entries exampleturtle and examplescreen define the names of these +objects as they occur in the docstrings. The transformation of +method-docstrings to function-docstrings will delete these names from the +docstrings.

    • +
    • using_IDLE: Set this to True if you regularly work with IDLE and its -n +switch (“no subprocess”). This will prevent exitonclick() to enter the +mainloop.

    • +
    +

    There can be a turtle.cfg file in the directory where turtle is +stored and an additional one in the current working directory. The latter will +override the settings of the first one.

    +

    The Lib/turtledemo directory contains a turtle.cfg file. You can +study it as an example and see its effects when running the demos (preferably +not from within the demo-viewer).

    +
    +
    +
    +

    turtledemo — Demo scripts

    +

    The turtledemo package includes a set of demo scripts. These +scripts can be run and viewed using the supplied demo viewer as follows:

    +
    python -m turtledemo
    +
    +
    +

    Alternatively, you can run the demo scripts individually. For example,

    +
    python -m turtledemo.bytedesign
    +
    +
    +

    The turtledemo package directory contains:

    +
      +
    • A demo viewer __main__.py which can be used to view the sourcecode +of the scripts and run them at the same time.

    • +
    • Multiple scripts demonstrating different features of the turtle +module. Examples can be accessed via the Examples menu. They can also +be run standalone.

    • +
    • A turtle.cfg file which serves as an example of how to write +and use such files.

    • +
    +

    The demo scripts are:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Name

    Description

    Features

    bytedesign

    complex classical +turtle graphics pattern

    tracer(), delay, +update()

    chaos

    graphs Verhulst dynamics, +shows that computer’s +computations can generate +results sometimes against the +common sense expectations

    world coordinates

    clock

    analog clock showing time +of your computer

    turtles as clock’s +hands, ontimer

    colormixer

    experiment with r, g, b

    ondrag()

    forest

    3 breadth-first trees

    randomization

    fractalcurves

    Hilbert & Koch curves

    recursion

    lindenmayer

    ethnomathematics +(indian kolams)

    L-System

    minimal_hanoi

    Towers of Hanoi

    Rectangular Turtles +as Hanoi discs +(shape, shapesize)

    nim

    play the classical nim game +with three heaps of sticks +against the computer.

    turtles as nimsticks, +event driven (mouse, +keyboard)

    paint

    super minimalistic +drawing program

    onclick()

    peace

    elementary

    turtle: appearance +and animation

    penrose

    aperiodic tiling with +kites and darts

    stamp()

    planet_and_moon

    simulation of +gravitational system

    compound shapes, +Vec2D

    round_dance

    dancing turtles rotating +pairwise in opposite +direction

    compound shapes, clone +shapesize, tilt, +get_shapepoly, update

    sorting_animate

    visual demonstration of +different sorting methods

    simple alignment, +randomization

    tree

    a (graphical) breadth +first tree (using generators)

    clone()

    two_canvases

    simple design

    turtles on two +canvases

    wikipedia

    a pattern from the wikipedia +article on turtle graphics

    clone(), +undo()

    yinyang

    another elementary example

    circle()

    +

    Have fun!

    +
    +
    +

    Changes since Python 2.6

    +
      +
    • The methods Turtle.tracer(), Turtle.window_width() and +Turtle.window_height() have been eliminated. +Methods with these names and functionality are now available only +as methods of Screen. The functions derived from these remain +available. (In fact already in Python 2.6 these methods were merely +duplications of the corresponding +TurtleScreen/Screen-methods.)

    • +
    • The method Turtle.fill() has been eliminated. +The behaviour of begin_fill() and end_fill() +have changed slightly: now every filling-process must be completed with an +end_fill() call.

    • +
    • A method Turtle.filling() has been added. It returns a boolean +value: True if a filling process is under way, False otherwise. +This behaviour corresponds to a fill() call without arguments in +Python 2.6.

    • +
    +
    +
    +

    Changes since Python 3.0

    +
      +
    • The methods Turtle.shearfactor(), Turtle.shapetransform() and +Turtle.get_shapepoly() have been added. Thus the full range of +regular linear transforms is now available for transforming turtle shapes. +Turtle.tiltangle() has been enhanced in functionality: it now can +be used to get or set the tiltangle. Turtle.settiltangle() has been +deprecated.

    • +
    • The method Screen.onkeypress() has been added as a complement to +Screen.onkey() which in fact binds actions to the keyrelease event. +Accordingly the latter has got an alias: Screen.onkeyrelease().

    • +
    • The method Screen.mainloop() has been added. So when working only +with Screen and Turtle objects one must not additionally import +mainloop() anymore.

    • +
    • Two input methods has been added Screen.textinput() and +Screen.numinput(). These popup input dialogs and return +strings and numbers respectively.

    • +
    • Two example scripts tdemo_nim.py and tdemo_round_dance.py +have been added to the Lib/turtledemo directory.

    • +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/types.html b/python-3.7.4-docs-html/library/types.html new file mode 100644 index 0000000..291faab --- /dev/null +++ b/python-3.7.4-docs-html/library/types.html @@ -0,0 +1,606 @@ + + + + + + + types — Dynamic type creation and names for built-in types — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    types — Dynamic type creation and names for built-in types

    +

    Source code: Lib/types.py

    +
    +

    This module defines utility functions to assist in dynamic creation of +new types.

    +

    It also defines names for some object types that are used by the standard +Python interpreter, but not exposed as builtins like int or +str are.

    +

    Finally, it provides some additional type-related utility classes and functions +that are not fundamental enough to be builtins.

    +
    +

    Dynamic Type Creation

    +
    +
    +types.new_class(name, bases=(), kwds=None, exec_body=None)
    +

    Creates a class object dynamically using the appropriate metaclass.

    +

    The first three arguments are the components that make up a class +definition header: the class name, the base classes (in order), the +keyword arguments (such as metaclass).

    +

    The exec_body argument is a callback that is used to populate the +freshly created class namespace. It should accept the class namespace +as its sole argument and update the namespace directly with the class +contents. If no callback is provided, it has the same effect as passing +in lambda ns: ns.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +types.prepare_class(name, bases=(), kwds=None)
    +

    Calculates the appropriate metaclass and creates the class namespace.

    +

    The arguments are the components that make up a class definition header: +the class name, the base classes (in order) and the keyword arguments +(such as metaclass).

    +

    The return value is a 3-tuple: metaclass, namespace, kwds

    +

    metaclass is the appropriate metaclass, namespace is the +prepared class namespace and kwds is an updated copy of the passed +in kwds argument with any 'metaclass' entry removed. If no kwds +argument is passed in, this will be an empty dict.

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.6: The default value for the namespace element of the returned +tuple has changed. Now an insertion-order-preserving mapping is +used when the metaclass does not have a __prepare__ method.

    +
    +
    + +
    +

    See also

    +
    +
    Metaclasses

    Full details of the class creation process supported by these functions

    +
    +
    PEP 3115 - Metaclasses in Python 3000

    Introduced the __prepare__ namespace hook

    +
    +
    +
    +
    +
    +types.resolve_bases(bases)
    +

    Resolve MRO entries dynamically as specified by PEP 560.

    +

    This function looks for items in bases that are not instances of +type, and returns a tuple where each such object that has +an __mro_entries__ method is replaced with an unpacked result of +calling this method. If a bases item is an instance of type, +or it doesn’t have an __mro_entries__ method, then it is included in +the return tuple unchanged.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +

    See also

    +

    PEP 560 - Core support for typing module and generic types

    +
    +
    +
    +

    Standard Interpreter Types

    +

    This module provides names for many of the types that are required to +implement a Python interpreter. It deliberately avoids including some of +the types that arise only incidentally during processing such as the +listiterator type.

    +

    Typical use of these names is for isinstance() or +issubclass() checks.

    +

    Standard names are defined for the following types:

    +
    +
    +types.FunctionType
    +
    +types.LambdaType
    +

    The type of user-defined functions and functions created by +lambda expressions.

    +
    + +
    +
    +types.GeneratorType
    +

    The type of generator-iterator objects, created by +generator functions.

    +
    + +
    +
    +types.CoroutineType
    +

    The type of coroutine objects, created by +async def functions.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +types.AsyncGeneratorType
    +

    The type of asynchronous generator-iterator objects, created by +asynchronous generator functions.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +types.CodeType
    +

    The type for code objects such as returned by compile().

    +
    + +
    +
    +types.MethodType
    +

    The type of methods of user-defined class instances.

    +
    + +
    +
    +types.BuiltinFunctionType
    +
    +types.BuiltinMethodType
    +

    The type of built-in functions like len() or sys.exit(), and +methods of built-in classes. (Here, the term “built-in” means “written in +C”.)

    +
    + +
    +
    +types.WrapperDescriptorType
    +

    The type of methods of some built-in data types and base classes such as +object.__init__() or object.__lt__().

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +types.MethodWrapperType
    +

    The type of bound methods of some built-in data types and base classes. +For example it is the type of object().__str__.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +types.MethodDescriptorType
    +

    The type of methods of some built-in data types such as str.join().

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +types.ClassMethodDescriptorType
    +

    The type of unbound class methods of some built-in data types such as +dict.__dict__['fromkeys'].

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +class types.ModuleType(name, doc=None)
    +

    The type of modules. Constructor takes the name of the +module to be created and optionally its docstring.

    +
    +

    Note

    +

    Use importlib.util.module_from_spec() to create a new module if you +wish to set the various import-controlled attributes.

    +
    +
    +
    +__doc__
    +

    The docstring of the module. Defaults to None.

    +
    + +
    +
    +__loader__
    +

    The loader which loaded the module. Defaults to None.

    +
    +

    Changed in version 3.4: Defaults to None. Previously the attribute was optional.

    +
    +
    + +
    +
    +__name__
    +

    The name of the module.

    +
    + +
    +
    +__package__
    +

    Which package a module belongs to. If the module is top-level +(i.e. not a part of any specific package) then the attribute should be set +to '', else it should be set to the name of the package (which can be +__name__ if the module is a package itself). Defaults to None.

    +
    +

    Changed in version 3.4: Defaults to None. Previously the attribute was optional.

    +
    +
    + +
    + +
    +
    +class types.TracebackType(tb_next, tb_frame, tb_lasti, tb_lineno)
    +

    The type of traceback objects such as found in sys.exc_info()[2].

    +

    See the language reference for details of the +available attributes and operations, and guidance on creating tracebacks +dynamically.

    +
    + +
    +
    +types.FrameType
    +

    The type of frame objects such as found in tb.tb_frame if tb is a +traceback object.

    +

    See the language reference for details of the +available attributes and operations.

    +
    + +
    +
    +types.GetSetDescriptorType
    +

    The type of objects defined in extension modules with PyGetSetDef, such +as FrameType.f_locals or array.array.typecode. This type is used as +descriptor for object attributes; it has the same purpose as the +property type, but for classes defined in extension modules.

    +
    + +
    +
    +types.MemberDescriptorType
    +

    The type of objects defined in extension modules with PyMemberDef, such +as datetime.timedelta.days. This type is used as descriptor for simple C +data members which use standard conversion functions; it has the same purpose +as the property type, but for classes defined in extension modules.

    +
    +

    CPython implementation detail: In other implementations of Python, this type may be identical to +GetSetDescriptorType.

    +
    +
    + +
    +
    +class types.MappingProxyType(mapping)
    +

    Read-only proxy of a mapping. It provides a dynamic view on the mapping’s +entries, which means that when the mapping changes, the view reflects these +changes.

    +
    +

    New in version 3.3.

    +
    +
    +
    +key in proxy
    +

    Return True if the underlying mapping has a key key, else +False.

    +
    + +
    +
    +proxy[key]
    +

    Return the item of the underlying mapping with key key. Raises a +KeyError if key is not in the underlying mapping.

    +
    + +
    +
    +iter(proxy)
    +

    Return an iterator over the keys of the underlying mapping. This is a +shortcut for iter(proxy.keys()).

    +
    + +
    +
    +len(proxy)
    +

    Return the number of items in the underlying mapping.

    +
    + +
    +
    +copy()
    +

    Return a shallow copy of the underlying mapping.

    +
    + +
    +
    +get(key[, default])
    +

    Return the value for key if key is in the underlying mapping, else +default. If default is not given, it defaults to None, so that +this method never raises a KeyError.

    +
    + +
    +
    +items()
    +

    Return a new view of the underlying mapping’s items ((key, value) +pairs).

    +
    + +
    +
    +keys()
    +

    Return a new view of the underlying mapping’s keys.

    +
    + +
    +
    +values()
    +

    Return a new view of the underlying mapping’s values.

    +
    + +
    + +
    +
    +

    Additional Utility Classes and Functions

    +
    +
    +class types.SimpleNamespace
    +

    A simple object subclass that provides attribute access to its +namespace, as well as a meaningful repr.

    +

    Unlike object, with SimpleNamespace you can add and remove +attributes. If a SimpleNamespace object is initialized with keyword +arguments, those are directly added to the underlying namespace.

    +

    The type is roughly equivalent to the following code:

    +
    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__
    +
    +
    +

    SimpleNamespace may be useful as a replacement for class NS: pass. +However, for a structured record type use namedtuple() +instead.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +types.DynamicClassAttribute(fget=None, fset=None, fdel=None, doc=None)
    +

    Route attribute access on a class to __getattr__.

    +

    This is a descriptor, used to define attributes that act differently when +accessed through an instance and through a class. Instance access remains +normal, but access to an attribute through a class will be routed to the +class’s __getattr__ method; this is done by raising AttributeError.

    +

    This allows one to have properties active on an instance, and have virtual +attributes on the class with the same name (see Enum for an example).

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +

    Coroutine Utility Functions

    +
    +
    +types.coroutine(gen_func)
    +

    This function transforms a generator function into a +coroutine function which returns a generator-based coroutine. +The generator-based coroutine is still a generator iterator, +but is also considered to be a coroutine object and is +awaitable. However, it may not necessarily implement +the __await__() method.

    +

    If gen_func is a generator function, it will be modified in-place.

    +

    If gen_func is not a generator function, it will be wrapped. If it +returns an instance of collections.abc.Generator, the instance +will be wrapped in an awaitable proxy object. All other types +of objects will be returned as is.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/typing.html b/python-3.7.4-docs-html/library/typing.html new file mode 100644 index 0000000..151e640 --- /dev/null +++ b/python-3.7.4-docs-html/library/typing.html @@ -0,0 +1,1453 @@ + + + + + + + typing — Support for type hints — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    typing — Support for type hints

    +
    +

    New in version 3.5.

    +
    +

    Source code: Lib/typing.py

    +
    +

    Note

    +

    The typing module has been included in the standard library on a +provisional basis. New features might +be added and API may change even between minor releases if deemed +necessary by the core developers.

    +
    +
    +

    This module supports type hints as specified by PEP 484 and PEP 526. +The most fundamental support consists of the types Any, Union, +Tuple, Callable, TypeVar, and +Generic. For full specification please see PEP 484. For +a simplified introduction to type hints see PEP 483.

    +

    The function below takes and returns a string and is annotated as follows:

    +
    def greeting(name: str) -> str:
    +    return 'Hello ' + name
    +
    +
    +

    In the function greeting, the argument name is expected to be of type +str and the return type str. Subtypes are accepted as +arguments.

    +
    +

    Type aliases

    +

    A type alias is defined by assigning the type to the alias. In this example, +Vector and List[float] will be treated as interchangeable synonyms:

    +
    from typing import List
    +Vector = List[float]
    +
    +def scale(scalar: float, vector: Vector) -> Vector:
    +    return [scalar * num for num in vector]
    +
    +# typechecks; a list of floats qualifies as a Vector.
    +new_vector = scale(2.0, [1.0, -4.2, 5.4])
    +
    +
    +

    Type aliases are useful for simplifying complex type signatures. For example:

    +
    from typing import Dict, Tuple, Sequence
    +
    +ConnectionOptions = Dict[str, str]
    +Address = Tuple[str, int]
    +Server = Tuple[Address, ConnectionOptions]
    +
    +def broadcast_message(message: str, servers: Sequence[Server]) -> None:
    +    ...
    +
    +# The static type checker will treat the previous type signature as
    +# being exactly equivalent to this one.
    +def broadcast_message(
    +        message: str,
    +        servers: Sequence[Tuple[Tuple[str, int], Dict[str, str]]]) -> None:
    +    ...
    +
    +
    +

    Note that None as a type hint is a special case and is replaced by +type(None).

    +
    +
    +

    NewType

    +

    Use the NewType() helper function to create distinct types:

    +
    from typing import NewType
    +
    +UserId = NewType('UserId', int)
    +some_id = UserId(524313)
    +
    +
    +

    The static type checker will treat the new type as if it were a subclass +of the original type. This is useful in helping catch logical errors:

    +
    def get_user_name(user_id: UserId) -> str:
    +    ...
    +
    +# typechecks
    +user_a = get_user_name(UserId(42351))
    +
    +# does not typecheck; an int is not a UserId
    +user_b = get_user_name(-1)
    +
    +
    +

    You may still perform all int operations on a variable of type UserId, +but the result will always be of type int. This lets you pass in a +UserId wherever an int might be expected, but will prevent you from +accidentally creating a UserId in an invalid way:

    +
    # 'output' is of type 'int', not 'UserId'
    +output = UserId(23413) + UserId(54341)
    +
    +
    +

    Note that these checks are enforced only by the static type checker. At runtime +the statement Derived = NewType('Derived', Base) will make Derived a +function that immediately returns whatever parameter you pass it. That means +the expression Derived(some_value) does not create a new class or introduce +any overhead beyond that of a regular function call.

    +

    More precisely, the expression some_value is Derived(some_value) is always +true at runtime.

    +

    This also means that it is not possible to create a subtype of Derived +since it is an identity function at runtime, not an actual type:

    +
    from typing import NewType
    +
    +UserId = NewType('UserId', int)
    +
    +# Fails at runtime and does not typecheck
    +class AdminUserId(UserId): pass
    +
    +
    +

    However, it is possible to create a NewType() based on a ‘derived’ NewType:

    +
    from typing import NewType
    +
    +UserId = NewType('UserId', int)
    +
    +ProUserId = NewType('ProUserId', UserId)
    +
    +
    +

    and typechecking for ProUserId will work as expected.

    +

    See PEP 484 for more details.

    +
    +

    Note

    +

    Recall that the use of a type alias declares two types to be equivalent to +one another. Doing Alias = Original will make the static type checker +treat Alias as being exactly equivalent to Original in all cases. +This is useful when you want to simplify complex type signatures.

    +

    In contrast, NewType declares one type to be a subtype of another. +Doing Derived = NewType('Derived', Original) will make the static type +checker treat Derived as a subclass of Original, which means a +value of type Original cannot be used in places where a value of type +Derived is expected. This is useful when you want to prevent logic +errors with minimal runtime cost.

    +
    +
    +

    New in version 3.5.2.

    +
    +
    +
    +

    Callable

    +

    Frameworks expecting callback functions of specific signatures might be +type hinted using Callable[[Arg1Type, Arg2Type], ReturnType].

    +

    For example:

    +
    from typing import Callable
    +
    +def feeder(get_next_item: Callable[[], str]) -> None:
    +    # Body
    +
    +def async_query(on_success: Callable[[int], None],
    +                on_error: Callable[[int, Exception], None]) -> None:
    +    # Body
    +
    +
    +

    It is possible to declare the return type of a callable without specifying +the call signature by substituting a literal ellipsis +for the list of arguments in the type hint: Callable[..., ReturnType].

    +
    +
    +

    Generics

    +

    Since type information about objects kept in containers cannot be statically +inferred in a generic way, abstract base classes have been extended to support +subscription to denote expected types for container elements.

    +
    from typing import Mapping, Sequence
    +
    +def notify_by_email(employees: Sequence[Employee],
    +                    overrides: Mapping[str, str]) -> None: ...
    +
    +
    +

    Generics can be parameterized by using a new factory available in typing +called TypeVar.

    +
    from typing import Sequence, TypeVar
    +
    +T = TypeVar('T')      # Declare type variable
    +
    +def first(l: Sequence[T]) -> T:   # Generic function
    +    return l[0]
    +
    +
    +
    +
    +

    User-defined generic types

    +

    A user-defined class can be defined as a generic class.

    +
    from typing import TypeVar, Generic
    +from logging import Logger
    +
    +T = TypeVar('T')
    +
    +class LoggedVar(Generic[T]):
    +    def __init__(self, value: T, name: str, logger: Logger) -> None:
    +        self.name = name
    +        self.logger = logger
    +        self.value = value
    +
    +    def set(self, new: T) -> None:
    +        self.log('Set ' + repr(self.value))
    +        self.value = new
    +
    +    def get(self) -> T:
    +        self.log('Get ' + repr(self.value))
    +        return self.value
    +
    +    def log(self, message: str) -> None:
    +        self.logger.info('%s: %s', self.name, message)
    +
    +
    +

    Generic[T] as a base class defines that the class LoggedVar takes a +single type parameter T . This also makes T valid as a type within the +class body.

    +

    The Generic base class uses a metaclass that defines +__getitem__() so that LoggedVar[t] is valid as a type:

    +
    from typing import Iterable
    +
    +def zero_all_vars(vars: Iterable[LoggedVar[int]]) -> None:
    +    for var in vars:
    +        var.set(0)
    +
    +
    +

    A generic type can have any number of type variables, and type variables may +be constrained:

    +
    from typing import TypeVar, Generic
    +...
    +
    +T = TypeVar('T')
    +S = TypeVar('S', int, str)
    +
    +class StrangePair(Generic[T, S]):
    +    ...
    +
    +
    +

    Each type variable argument to Generic must be distinct. +This is thus invalid:

    +
    from typing import TypeVar, Generic
    +...
    +
    +T = TypeVar('T')
    +
    +class Pair(Generic[T, T]):   # INVALID
    +    ...
    +
    +
    +

    You can use multiple inheritance with Generic:

    +
    from typing import TypeVar, Generic, Sized
    +
    +T = TypeVar('T')
    +
    +class LinkedList(Sized, Generic[T]):
    +    ...
    +
    +
    +

    When inheriting from generic classes, some type variables could be fixed:

    +
    from typing import TypeVar, Mapping
    +
    +T = TypeVar('T')
    +
    +class MyDict(Mapping[str, T]):
    +    ...
    +
    +
    +

    In this case MyDict has a single parameter, T.

    +

    Using a generic class without specifying type parameters assumes +Any for each position. In the following example, MyIterable is +not generic but implicitly inherits from Iterable[Any]:

    +
    from typing import Iterable
    +
    +class MyIterable(Iterable): # Same as Iterable[Any]
    +
    +
    +

    User defined generic type aliases are also supported. Examples:

    +
    from typing import TypeVar, Iterable, Tuple, Union
    +S = TypeVar('S')
    +Response = Union[Iterable[S], int]
    +
    +# Return type here is same as Union[Iterable[str], int]
    +def response(query: str) -> Response[str]:
    +    ...
    +
    +T = TypeVar('T', int, float, complex)
    +Vec = Iterable[Tuple[T, T]]
    +
    +def inproduct(v: Vec[T]) -> T: # Same as Iterable[Tuple[T, T]]
    +    return sum(x*y for x, y in v)
    +
    +
    +

    The metaclass used by Generic is a subclass of abc.ABCMeta. +A generic class can be an ABC by including abstract methods or properties, +and generic classes can also have ABCs as base classes without a metaclass +conflict. Generic metaclasses are not supported. The outcome of parameterizing +generics is cached, and most types in the typing module are hashable and +comparable for equality.

    +
    +
    +

    The Any type

    +

    A special kind of type is Any. A static type checker will treat +every type as being compatible with Any and Any as being +compatible with every type.

    +

    This means that it is possible to perform any operation or method call on a +value of type on Any and assign it to any variable:

    +
    from typing import Any
    +
    +a = None    # type: Any
    +a = []      # OK
    +a = 2       # OK
    +
    +s = ''      # type: str
    +s = a       # OK
    +
    +def foo(item: Any) -> int:
    +    # Typechecks; 'item' could be any type,
    +    # and that type might have a 'bar' method
    +    item.bar()
    +    ...
    +
    +
    +

    Notice that no typechecking is performed when assigning a value of type +Any to a more precise type. For example, the static type checker did +not report an error when assigning a to s even though s was +declared to be of type str and receives an int value at +runtime!

    +

    Furthermore, all functions without a return type or parameter types will +implicitly default to using Any:

    +
    def legacy_parser(text):
    +    ...
    +    return data
    +
    +# A static type checker will treat the above
    +# as having the same signature as:
    +def legacy_parser(text: Any) -> Any:
    +    ...
    +    return data
    +
    +
    +

    This behavior allows Any to be used as an escape hatch when you +need to mix dynamically and statically typed code.

    +

    Contrast the behavior of Any with the behavior of object. +Similar to Any, every type is a subtype of object. However, +unlike Any, the reverse is not true: object is not a +subtype of every other type.

    +

    That means when the type of a value is object, a type checker will +reject almost all operations on it, and assigning it to a variable (or using +it as a return value) of a more specialized type is a type error. For example:

    +
    def hash_a(item: object) -> int:
    +    # Fails; an object does not have a 'magic' method.
    +    item.magic()
    +    ...
    +
    +def hash_b(item: Any) -> int:
    +    # Typechecks
    +    item.magic()
    +    ...
    +
    +# Typechecks, since ints and strs are subclasses of object
    +hash_a(42)
    +hash_a("foo")
    +
    +# Typechecks, since Any is compatible with all types
    +hash_b(42)
    +hash_b("foo")
    +
    +
    +

    Use object to indicate that a value could be any type in a typesafe +manner. Use Any to indicate that a value is dynamically typed.

    +
    +
    +

    Classes, functions, and decorators

    +

    The module defines the following classes, functions and decorators:

    +
    +
    +class typing.TypeVar
    +

    Type variable.

    +

    Usage:

    +
    T = TypeVar('T')  # Can be anything
    +A = TypeVar('A', str, bytes)  # Must be str or bytes
    +
    +
    +

    Type variables exist primarily for the benefit of static type +checkers. They serve as the parameters for generic types as well +as for generic function definitions. See class Generic for more +information on generic types. Generic functions work as follows:

    +
    def repeat(x: T, n: int) -> Sequence[T]:
    +    """Return a list containing n references to x."""
    +    return [x]*n
    +
    +def longest(x: A, y: A) -> A:
    +    """Return the longest of two strings."""
    +    return x if len(x) >= len(y) else y
    +
    +
    +

    The latter example’s signature is essentially the overloading +of (str, str) -> str and (bytes, bytes) -> bytes. Also note +that if the arguments are instances of some subclass of str, +the return type is still plain str.

    +

    At runtime, isinstance(x, T) will raise TypeError. In general, +isinstance() and issubclass() should not be used with types.

    +

    Type variables may be marked covariant or contravariant by passing +covariant=True or contravariant=True. See PEP 484 for more +details. By default type variables are invariant. Alternatively, +a type variable may specify an upper bound using bound=<type>. +This means that an actual type substituted (explicitly or implicitly) +for the type variable must be a subclass of the boundary type, +see PEP 484.

    +
    + +
    +
    +class typing.Generic
    +

    Abstract base class for generic types.

    +

    A generic type is typically declared by inheriting from an +instantiation of this class with one or more type variables. +For example, a generic mapping type might be defined as:

    +
    class Mapping(Generic[KT, VT]):
    +    def __getitem__(self, key: KT) -> VT:
    +        ...
    +        # Etc.
    +
    +
    +

    This class can then be used as follows:

    +
    X = TypeVar('X')
    +Y = TypeVar('Y')
    +
    +def lookup_name(mapping: Mapping[X, Y], key: X, default: Y) -> Y:
    +    try:
    +        return mapping[key]
    +    except KeyError:
    +        return default
    +
    +
    +
    + +
    +
    +class typing.Type(Generic[CT_co])
    +

    A variable annotated with C may accept a value of type C. In +contrast, a variable annotated with Type[C] may accept values that are +classes themselves – specifically, it will accept the class object of +C. For example:

    +
    a = 3         # Has type 'int'
    +b = int       # Has type 'Type[int]'
    +c = type(a)   # Also has type 'Type[int]'
    +
    +
    +

    Note that Type[C] is covariant:

    +
    class User: ...
    +class BasicUser(User): ...
    +class ProUser(User): ...
    +class TeamUser(User): ...
    +
    +# Accepts User, BasicUser, ProUser, TeamUser, ...
    +def make_new_user(user_class: Type[User]) -> User:
    +    # ...
    +    return user_class()
    +
    +
    +

    The fact that Type[C] is covariant implies that all subclasses of +C should implement the same constructor signature and class method +signatures as C. The type checker should flag violations of this, +but should also allow constructor calls in subclasses that match the +constructor calls in the indicated base class. How the type checker is +required to handle this particular case may change in future revisions of +PEP 484.

    +

    The only legal parameters for Type are classes, Any, +type variables, and unions of any of these types. +For example:

    +
    def new_non_team_user(user_class: Type[Union[BaseUser, ProUser]]): ...
    +
    +
    +

    Type[Any] is equivalent to Type which in turn is equivalent +to type, which is the root of Python’s metaclass hierarchy.

    +
    +

    New in version 3.5.2.

    +
    +
    + +
    +
    +class typing.Iterable(Generic[T_co])
    +

    A generic version of collections.abc.Iterable.

    +
    + +
    +
    +class typing.Iterator(Iterable[T_co])
    +

    A generic version of collections.abc.Iterator.

    +
    + +
    +
    +class typing.Reversible(Iterable[T_co])
    +

    A generic version of collections.abc.Reversible.

    +
    + +
    +
    +class typing.SupportsInt
    +

    An ABC with one abstract method __int__.

    +
    + +
    +
    +class typing.SupportsFloat
    +

    An ABC with one abstract method __float__.

    +
    + +
    +
    +class typing.SupportsComplex
    +

    An ABC with one abstract method __complex__.

    +
    + +
    +
    +class typing.SupportsBytes
    +

    An ABC with one abstract method __bytes__.

    +
    + +
    +
    +class typing.SupportsAbs
    +

    An ABC with one abstract method __abs__ that is covariant +in its return type.

    +
    + +
    +
    +class typing.SupportsRound
    +

    An ABC with one abstract method __round__ +that is covariant in its return type.

    +
    + +
    +
    +class typing.Container(Generic[T_co])
    +

    A generic version of collections.abc.Container.

    +
    + +
    +
    +class typing.Hashable
    +

    An alias to collections.abc.Hashable

    +
    + +
    +
    +class typing.Sized
    +

    An alias to collections.abc.Sized

    +
    + +
    +
    +class typing.Collection(Sized, Iterable[T_co], Container[T_co])
    +

    A generic version of collections.abc.Collection

    +
    +

    New in version 3.6.0.

    +
    +
    + +
    +
    +class typing.AbstractSet(Sized, Collection[T_co])
    +

    A generic version of collections.abc.Set.

    +
    + +
    +
    +class typing.MutableSet(AbstractSet[T])
    +

    A generic version of collections.abc.MutableSet.

    +
    + +
    +
    +class typing.Mapping(Sized, Collection[KT], Generic[VT_co])
    +

    A generic version of collections.abc.Mapping. +This type can be used as follows:

    +
    def get_position_in_index(word_list: Mapping[str, int], word: str) -> int:
    +    return word_list[word]
    +
    +
    +
    + +
    +
    +class typing.MutableMapping(Mapping[KT, VT])
    +

    A generic version of collections.abc.MutableMapping.

    +
    + +
    +
    +class typing.Sequence(Reversible[T_co], Collection[T_co])
    +

    A generic version of collections.abc.Sequence.

    +
    + +
    +
    +class typing.MutableSequence(Sequence[T])
    +

    A generic version of collections.abc.MutableSequence.

    +
    + +
    +
    +class typing.ByteString(Sequence[int])
    +

    A generic version of collections.abc.ByteString.

    +

    This type represents the types bytes, bytearray, +and memoryview.

    +

    As a shorthand for this type, bytes can be used to +annotate arguments of any of the types mentioned above.

    +
    + +
    +
    +class typing.Deque(deque, MutableSequence[T])
    +

    A generic version of collections.deque.

    +
    +

    New in version 3.5.4.

    +
    +
    +

    New in version 3.6.1.

    +
    +
    + +
    +
    +class typing.List(list, MutableSequence[T])
    +

    Generic version of list. +Useful for annotating return types. To annotate arguments it is preferred +to use an abstract collection type such as Sequence or +Iterable.

    +

    This type may be used as follows:

    +
    T = TypeVar('T', int, float)
    +
    +def vec2(x: T, y: T) -> List[T]:
    +    return [x, y]
    +
    +def keep_positives(vector: Sequence[T]) -> List[T]:
    +    return [item for item in vector if item > 0]
    +
    +
    +
    + +
    +
    +class typing.Set(set, MutableSet[T])
    +

    A generic version of builtins.set. +Useful for annotating return types. To annotate arguments it is preferred +to use an abstract collection type such as AbstractSet.

    +
    + +
    +
    +class typing.FrozenSet(frozenset, AbstractSet[T_co])
    +

    A generic version of builtins.frozenset.

    +
    + +
    +
    +class typing.MappingView(Sized, Iterable[T_co])
    +

    A generic version of collections.abc.MappingView.

    +
    + +
    +
    +class typing.KeysView(MappingView[KT_co], AbstractSet[KT_co])
    +

    A generic version of collections.abc.KeysView.

    +
    + +
    +
    +class typing.ItemsView(MappingView, Generic[KT_co, VT_co])
    +

    A generic version of collections.abc.ItemsView.

    +
    + +
    +
    +class typing.ValuesView(MappingView[VT_co])
    +

    A generic version of collections.abc.ValuesView.

    +
    + +
    +
    +class typing.Awaitable(Generic[T_co])
    +

    A generic version of collections.abc.Awaitable.

    +
    +

    New in version 3.5.2.

    +
    +
    + +
    +
    +class typing.Coroutine(Awaitable[V_co], Generic[T_co T_contra, V_co])
    +

    A generic version of collections.abc.Coroutine. +The variance and order of type variables +correspond to those of Generator, for example:

    +
    from typing import List, Coroutine
    +c = None # type: Coroutine[List[str], str, int]
    +...
    +x = c.send('hi') # type: List[str]
    +async def bar() -> None:
    +    x = await c # type: int
    +
    +
    +
    +

    New in version 3.5.3.

    +
    +
    + +
    +
    +class typing.AsyncIterable(Generic[T_co])
    +

    A generic version of collections.abc.AsyncIterable.

    +
    +

    New in version 3.5.2.

    +
    +
    + +
    +
    +class typing.AsyncIterator(AsyncIterable[T_co])
    +

    A generic version of collections.abc.AsyncIterator.

    +
    +

    New in version 3.5.2.

    +
    +
    + +
    +
    +class typing.ContextManager(Generic[T_co])
    +

    A generic version of contextlib.AbstractContextManager.

    +
    +

    New in version 3.5.4.

    +
    +
    +

    New in version 3.6.0.

    +
    +
    + +
    +
    +class typing.AsyncContextManager(Generic[T_co])
    +

    A generic version of contextlib.AbstractAsyncContextManager.

    +
    +

    New in version 3.5.4.

    +
    +
    +

    New in version 3.6.2.

    +
    +
    + +
    +
    +class typing.Dict(dict, MutableMapping[KT, VT])
    +

    A generic version of dict. +Useful for annotating return types. To annotate arguments it is preferred +to use an abstract collection type such as Mapping.

    +

    This type can be used as follows:

    +
    def count_words(text: str) -> Dict[str, int]:
    +    ...
    +
    +
    +
    + +
    +
    +class typing.DefaultDict(collections.defaultdict, MutableMapping[KT, VT])
    +

    A generic version of collections.defaultdict.

    +
    +

    New in version 3.5.2.

    +
    +
    + +
    +
    +class typing.OrderedDict(collections.OrderedDict, MutableMapping[KT, VT])
    +

    A generic version of collections.OrderedDict.

    +
    +

    New in version 3.7.2.

    +
    +
    + +
    +
    +class typing.Counter(collections.Counter, Dict[T, int])
    +

    A generic version of collections.Counter.

    +
    +

    New in version 3.5.4.

    +
    +
    +

    New in version 3.6.1.

    +
    +
    + +
    +
    +class typing.ChainMap(collections.ChainMap, MutableMapping[KT, VT])
    +

    A generic version of collections.ChainMap.

    +
    +

    New in version 3.5.4.

    +
    +
    +

    New in version 3.6.1.

    +
    +
    + +
    +
    +class typing.Generator(Iterator[T_co], Generic[T_co, T_contra, V_co])
    +

    A generator can be annotated by the generic type +Generator[YieldType, SendType, ReturnType]. For example:

    +
    def echo_round() -> Generator[int, float, str]:
    +    sent = yield 0
    +    while sent >= 0:
    +        sent = yield round(sent)
    +    return 'Done'
    +
    +
    +

    Note that unlike many other generics in the typing module, the SendType +of Generator behaves contravariantly, not covariantly or +invariantly.

    +

    If your generator will only yield values, set the SendType and +ReturnType to None:

    +
    def infinite_stream(start: int) -> Generator[int, None, None]:
    +    while True:
    +        yield start
    +        start += 1
    +
    +
    +

    Alternatively, annotate your generator as having a return type of +either Iterable[YieldType] or Iterator[YieldType]:

    +
    def infinite_stream(start: int) -> Iterator[int]:
    +    while True:
    +        yield start
    +        start += 1
    +
    +
    +
    + +
    +
    +class typing.AsyncGenerator(AsyncIterator[T_co], Generic[T_co, T_contra])
    +

    An async generator can be annotated by the generic type +AsyncGenerator[YieldType, SendType]. For example:

    +
    async def echo_round() -> AsyncGenerator[int, float]:
    +    sent = yield 0
    +    while sent >= 0.0:
    +        rounded = await round(sent)
    +        sent = yield rounded
    +
    +
    +

    Unlike normal generators, async generators cannot return a value, so there +is no ReturnType type parameter. As with Generator, the +SendType behaves contravariantly.

    +

    If your generator will only yield values, set the SendType to +None:

    +
    async def infinite_stream(start: int) -> AsyncGenerator[int, None]:
    +    while True:
    +        yield start
    +        start = await increment(start)
    +
    +
    +

    Alternatively, annotate your generator as having a return type of +either AsyncIterable[YieldType] or AsyncIterator[YieldType]:

    +
    async def infinite_stream(start: int) -> AsyncIterator[int]:
    +    while True:
    +        yield start
    +        start = await increment(start)
    +
    +
    +
    +

    New in version 3.6.1.

    +
    +
    + +
    +
    +class typing.Text
    +

    Text is an alias for str. It is provided to supply a forward +compatible path for Python 2 code: in Python 2, Text is an alias for +unicode.

    +

    Use Text to indicate that a value must contain a unicode string in +a manner that is compatible with both Python 2 and Python 3:

    +
    def add_unicode_checkmark(text: Text) -> Text:
    +    return text + u' \u2713'
    +
    +
    +
    +

    New in version 3.5.2.

    +
    +
    + +
    +
    +class typing.IO
    +
    +class typing.TextIO
    +
    +class typing.BinaryIO
    +

    Generic type IO[AnyStr] and its subclasses TextIO(IO[str]) +and BinaryIO(IO[bytes]) +represent the types of I/O streams such as returned by +open().

    +
    + +
    +
    +class typing.Pattern
    +
    +class typing.Match
    +

    These type aliases +correspond to the return types from re.compile() and +re.match(). These types (and the corresponding functions) +are generic in AnyStr and can be made specific by writing +Pattern[str], Pattern[bytes], Match[str], or +Match[bytes].

    +
    + +
    +
    +class typing.NamedTuple
    +

    Typed version of collections.namedtuple().

    +

    Usage:

    +
    class Employee(NamedTuple):
    +    name: str
    +    id: int
    +
    +
    +

    This is equivalent to:

    +
    Employee = collections.namedtuple('Employee', ['name', 'id'])
    +
    +
    +

    To give a field a default value, you can assign to it in the class body:

    +
    class Employee(NamedTuple):
    +    name: str
    +    id: int = 3
    +
    +employee = Employee('Guido')
    +assert employee.id == 3
    +
    +
    +

    Fields with a default value must come after any fields without a default.

    +

    The resulting class has two extra attributes: _field_types, +giving a dict mapping field names to types, and _field_defaults, a dict +mapping field names to default values. (The field names are in the +_fields attribute, which is part of the namedtuple API.)

    +

    NamedTuple subclasses can also have docstrings and methods:

    +
    class Employee(NamedTuple):
    +    """Represents an employee."""
    +    name: str
    +    id: int = 3
    +
    +    def __repr__(self) -> str:
    +        return f'<Employee {self.name}, id={self.id}>'
    +
    +
    +

    Backward-compatible usage:

    +
    Employee = NamedTuple('Employee', [('name', str), ('id', int)])
    +
    +
    +
    +

    Changed in version 3.6: Added support for PEP 526 variable annotation syntax.

    +
    +
    +

    Changed in version 3.6.1: Added support for default values, methods, and docstrings.

    +
    +
    + +
    +
    +class typing.ForwardRef
    +

    A class used for internal typing representation of string forward references. +For example, List["SomeClass"] is implicitly transformed into +List[ForwardRef("SomeClass")]. This class should not be instantiated by +a user, but may be used by introspection tools.

    +
    + +
    +
    +typing.NewType(typ)
    +

    A helper function to indicate a distinct types to a typechecker, +see NewType. At runtime it returns a function that returns +its argument. Usage:

    +
    UserId = NewType('UserId', int)
    +first_user = UserId(1)
    +
    +
    +
    +

    New in version 3.5.2.

    +
    +
    + +
    +
    +typing.cast(typ, val)
    +

    Cast a value to a type.

    +

    This returns the value unchanged. To the type checker this +signals that the return value has the designated type, but at +runtime we intentionally don’t check anything (we want this +to be as fast as possible).

    +
    + +
    +
    +typing.get_type_hints(obj[, globals[, locals]])
    +

    Return a dictionary containing type hints for a function, method, module +or class object.

    +

    This is often the same as obj.__annotations__. In addition, +forward references encoded as string literals are handled by evaluating +them in globals and locals namespaces. If necessary, +Optional[t] is added for function and method annotations if a default +value equal to None is set. For a class C, return +a dictionary constructed by merging all the __annotations__ along +C.__mro__ in reverse order.

    +
    + +
    +
    +@typing.overload
    +

    The @overload decorator allows describing functions and methods +that support multiple different combinations of argument types. A series +of @overload-decorated definitions must be followed by exactly one +non-@overload-decorated definition (for the same function/method). +The @overload-decorated definitions are for the benefit of the +type checker only, since they will be overwritten by the +non-@overload-decorated definition, while the latter is used at +runtime but should be ignored by a type checker. At runtime, calling +a @overload-decorated function directly will raise +NotImplementedError. An example of overload that gives a more +precise type than can be expressed using a union or a type variable:

    +
    @overload
    +def process(response: None) -> None:
    +    ...
    +@overload
    +def process(response: int) -> Tuple[int, str]:
    +    ...
    +@overload
    +def process(response: bytes) -> str:
    +    ...
    +def process(response):
    +    <actual implementation>
    +
    +
    +

    See PEP 484 for details and comparison with other typing semantics.

    +
    + +
    +
    +@typing.no_type_check
    +

    Decorator to indicate that annotations are not type hints.

    +

    This works as class or function decorator. With a class, it +applies recursively to all methods defined in that class (but not +to methods defined in its superclasses or subclasses).

    +

    This mutates the function(s) in place.

    +
    + +
    +
    +@typing.no_type_check_decorator
    +

    Decorator to give another decorator the no_type_check() effect.

    +

    This wraps the decorator with something that wraps the decorated +function in no_type_check().

    +
    + +
    +
    +@typing.type_check_only
    +

    Decorator to mark a class or function to be unavailable at runtime.

    +

    This decorator is itself not available at runtime. It is mainly +intended to mark classes that are defined in type stub files if +an implementation returns an instance of a private class:

    +
    @type_check_only
    +class Response:  # private or not available at runtime
    +    code: int
    +    def get_header(self, name: str) -> str: ...
    +
    +def fetch_response() -> Response: ...
    +
    +
    +

    Note that returning instances of private classes is not recommended. +It is usually preferable to make such classes public.

    +
    + +
    +
    +typing.Any
    +

    Special type indicating an unconstrained type.

    +
      +
    • Every type is compatible with Any.

    • +
    • Any is compatible with every type.

    • +
    +
    + +
    +
    +typing.NoReturn
    +

    Special type indicating that a function never returns. +For example:

    +
    from typing import NoReturn
    +
    +def stop() -> NoReturn:
    +    raise RuntimeError('no way')
    +
    +
    +
    +

    New in version 3.5.4.

    +
    +
    +

    New in version 3.6.2.

    +
    +
    + +
    +
    +typing.Union
    +

    Union type; Union[X, Y] means either X or Y.

    +

    To define a union, use e.g. Union[int, str]. Details:

    +
      +
    • The arguments must be types and there must be at least one.

    • +
    • Unions of unions are flattened, e.g.:

      +
      Union[Union[int, str], float] == Union[int, str, float]
      +
      +
      +
    • +
    • Unions of a single argument vanish, e.g.:

      +
      Union[int] == int  # The constructor actually returns int
      +
      +
      +
    • +
    • Redundant arguments are skipped, e.g.:

      +
      Union[int, str, int] == Union[int, str]
      +
      +
      +
    • +
    • When comparing unions, the argument order is ignored, e.g.:

      +
      Union[int, str] == Union[str, int]
      +
      +
      +
    • +
    • You cannot subclass or instantiate a union.

    • +
    • You cannot write Union[X][Y].

    • +
    • You can use Optional[X] as a shorthand for Union[X, None].

    • +
    +
    +

    Changed in version 3.7: Don’t remove explicit subclasses from unions at runtime.

    +
    +
    + +
    +
    +typing.Optional
    +

    Optional type.

    +

    Optional[X] is equivalent to Union[X, None].

    +

    Note that this is not the same concept as an optional argument, +which is one that has a default. An optional argument with a +default does not require the Optional qualifier on its type +annotation just because it is optional. For example:

    +
    def foo(arg: int = 0) -> None:
    +    ...
    +
    +
    +

    On the other hand, if an explicit value of None is allowed, the +use of Optional is appropriate, whether the argument is optional +or not. For example:

    +
    def foo(arg: Optional[int] = None) -> None:
    +    ...
    +
    +
    +
    + +
    +
    +typing.Tuple
    +

    Tuple type; Tuple[X, Y] is the type of a tuple of two items +with the first item of type X and the second of type Y.

    +

    Example: Tuple[T1, T2] is a tuple of two elements corresponding +to type variables T1 and T2. Tuple[int, float, str] is a tuple +of an int, a float and a string.

    +

    To specify a variable-length tuple of homogeneous type, +use literal ellipsis, e.g. Tuple[int, ...]. A plain Tuple +is equivalent to Tuple[Any, ...], and in turn to tuple.

    +
    + +
    +
    +typing.Callable
    +

    Callable type; Callable[[int], str] is a function of (int) -> str.

    +

    The subscription syntax must always be used with exactly two +values: the argument list and the return type. The argument list +must be a list of types or an ellipsis; the return type must be +a single type.

    +

    There is no syntax to indicate optional or keyword arguments; +such function types are rarely used as callback types. +Callable[..., ReturnType] (literal ellipsis) can be used to +type hint a callable taking any number of arguments and returning +ReturnType. A plain Callable is equivalent to +Callable[..., Any], and in turn to +collections.abc.Callable.

    +
    + +
    +
    +typing.ClassVar
    +

    Special type construct to mark class variables.

    +

    As introduced in PEP 526, a variable annotation wrapped in ClassVar +indicates that a given attribute is intended to be used as a class variable +and should not be set on instances of that class. Usage:

    +
    class Starship:
    +    stats: ClassVar[Dict[str, int]] = {} # class variable
    +    damage: int = 10                     # instance variable
    +
    +
    +

    ClassVar accepts only types and cannot be further subscribed.

    +

    ClassVar is not a class itself, and should not +be used with isinstance() or issubclass(). +ClassVar does not change Python runtime behavior, but +it can be used by third-party type checkers. For example, a type checker +might flag the following code as an error:

    +
    enterprise_d = Starship(3000)
    +enterprise_d.stats = {} # Error, setting class variable on instance
    +Starship.stats = {}     # This is OK
    +
    +
    +
    +

    New in version 3.5.3.

    +
    +
    + +
    +
    +typing.AnyStr
    +

    AnyStr is a type variable defined as +AnyStr = TypeVar('AnyStr', str, bytes).

    +

    It is meant to be used for functions that may accept any kind of string +without allowing different kinds of strings to mix. For example:

    +
    def concat(a: AnyStr, b: AnyStr) -> AnyStr:
    +    return a + b
    +
    +concat(u"foo", u"bar")  # Ok, output has type 'unicode'
    +concat(b"foo", b"bar")  # Ok, output has type 'bytes'
    +concat(u"foo", b"bar")  # Error, cannot mix unicode and bytes
    +
    +
    +
    + +
    +
    +typing.TYPE_CHECKING
    +

    A special constant that is assumed to be True by 3rd party static +type checkers. It is False at runtime. Usage:

    +
    if TYPE_CHECKING:
    +    import expensive_mod
    +
    +def fun(arg: 'expensive_mod.SomeType') -> None:
    +    local_var: expensive_mod.AnotherType = other_fun()
    +
    +
    +

    Note that the first type annotation must be enclosed in quotes, making it a +“forward reference”, to hide the expensive_mod reference from the +interpreter runtime. Type annotations for local variables are not +evaluated, so the second annotation does not need to be enclosed in quotes.

    +
    +

    New in version 3.5.2.

    +
    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/undoc.html b/python-3.7.4-docs-html/library/undoc.html new file mode 100644 index 0000000..e102943 --- /dev/null +++ b/python-3.7.4-docs-html/library/undoc.html @@ -0,0 +1,206 @@ + + + + + + + Undocumented Modules — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Undocumented Modules

    +

    Here’s a quick listing of modules that are currently undocumented, but that +should be documented. Feel free to contribute documentation for them! (Send +via email to docs@python.org.)

    +

    The idea and original contents for this chapter were taken from a posting by +Fredrik Lundh; the specific contents of this chapter have been substantially +revised.

    +
    +

    Platform specific modules

    +

    These modules are used to implement the os.path module, and are not +documented beyond this mention. There’s little need to document these.

    +
    +
    ntpath

    — Implementation of os.path on Win32 and Win64 platforms.

    +
    +
    posixpath

    — Implementation of os.path on POSIX.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/unicodedata.html b/python-3.7.4-docs-html/library/unicodedata.html new file mode 100644 index 0000000..75b216c --- /dev/null +++ b/python-3.7.4-docs-html/library/unicodedata.html @@ -0,0 +1,347 @@ + + + + + + + unicodedata — Unicode Database — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    unicodedata — Unicode Database

    +
    +

    This module provides access to the Unicode Character Database (UCD) which +defines character properties for all Unicode characters. The data contained in +this database is compiled from the UCD version 11.0.0.

    +

    The module uses the same names and symbols as defined by Unicode +Standard Annex #44, “Unicode Character Database”. It defines the +following functions:

    +
    +
    +unicodedata.lookup(name)
    +

    Look up character by name. If a character with the given name is found, return +the corresponding character. If not found, KeyError is raised.

    +
    +

    Changed in version 3.3: Support for name aliases 1 and named sequences 2 has been added.

    +
    +
    + +
    +
    +unicodedata.name(chr[, default])
    +

    Returns the name assigned to the character chr as a string. If no +name is defined, default is returned, or, if not given, ValueError is +raised.

    +
    + +
    +
    +unicodedata.decimal(chr[, default])
    +

    Returns the decimal value assigned to the character chr as integer. +If no such value is defined, default is returned, or, if not given, +ValueError is raised.

    +
    + +
    +
    +unicodedata.digit(chr[, default])
    +

    Returns the digit value assigned to the character chr as integer. +If no such value is defined, default is returned, or, if not given, +ValueError is raised.

    +
    + +
    +
    +unicodedata.numeric(chr[, default])
    +

    Returns the numeric value assigned to the character chr as float. +If no such value is defined, default is returned, or, if not given, +ValueError is raised.

    +
    + +
    +
    +unicodedata.category(chr)
    +

    Returns the general category assigned to the character chr as +string.

    +
    + +
    +
    +unicodedata.bidirectional(chr)
    +

    Returns the bidirectional class assigned to the character chr as +string. If no such value is defined, an empty string is returned.

    +
    + +
    +
    +unicodedata.combining(chr)
    +

    Returns the canonical combining class assigned to the character chr +as integer. Returns 0 if no combining class is defined.

    +
    + +
    +
    +unicodedata.east_asian_width(chr)
    +

    Returns the east asian width assigned to the character chr as +string.

    +
    + +
    +
    +unicodedata.mirrored(chr)
    +

    Returns the mirrored property assigned to the character chr as +integer. Returns 1 if the character has been identified as a “mirrored” +character in bidirectional text, 0 otherwise.

    +
    + +
    +
    +unicodedata.decomposition(chr)
    +

    Returns the character decomposition mapping assigned to the character +chr as string. An empty string is returned in case no such mapping is +defined.

    +
    + +
    +
    +unicodedata.normalize(form, unistr)
    +

    Return the normal form form for the Unicode string unistr. Valid values for +form are ‘NFC’, ‘NFKC’, ‘NFD’, and ‘NFKD’.

    +

    The Unicode standard defines various normalization forms of a Unicode string, +based on the definition of canonical equivalence and compatibility equivalence. +In Unicode, several characters can be expressed in various way. For example, the +character U+00C7 (LATIN CAPITAL LETTER C WITH CEDILLA) can also be expressed as +the sequence U+0043 (LATIN CAPITAL LETTER C) U+0327 (COMBINING CEDILLA).

    +

    For each character, there are two normal forms: normal form C and normal form D. +Normal form D (NFD) is also known as canonical decomposition, and translates +each character into its decomposed form. Normal form C (NFC) first applies a +canonical decomposition, then composes pre-combined characters again.

    +

    In addition to these two forms, there are two additional normal forms based on +compatibility equivalence. In Unicode, certain characters are supported which +normally would be unified with other characters. For example, U+2160 (ROMAN +NUMERAL ONE) is really the same thing as U+0049 (LATIN CAPITAL LETTER I). +However, it is supported in Unicode for compatibility with existing character +sets (e.g. gb2312).

    +

    The normal form KD (NFKD) will apply the compatibility decomposition, i.e. +replace all compatibility characters with their equivalents. The normal form KC +(NFKC) first applies the compatibility decomposition, followed by the canonical +composition.

    +

    Even if two unicode strings are normalized and look the same to +a human reader, if one has combining characters and the other +doesn’t, they may not compare equal.

    +
    + +

    In addition, the module exposes the following constant:

    +
    +
    +unicodedata.unidata_version
    +

    The version of the Unicode database used in this module.

    +
    + +
    +
    +unicodedata.ucd_3_2_0
    +

    This is an object that has the same methods as the entire module, but uses the +Unicode database version 3.2 instead, for applications that require this +specific version of the Unicode database (such as IDNA).

    +
    + +

    Examples:

    +
    >>> import unicodedata
    +>>> unicodedata.lookup('LEFT CURLY BRACKET')
    +'{'
    +>>> unicodedata.name('/')
    +'SOLIDUS'
    +>>> unicodedata.decimal('9')
    +9
    +>>> unicodedata.decimal('a')
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +ValueError: not a decimal
    +>>> unicodedata.category('A')  # 'L'etter, 'u'ppercase
    +'Lu'
    +>>> unicodedata.bidirectional('\u0660') # 'A'rabic, 'N'umber
    +'AN'
    +
    +
    +

    Footnotes

    +
    +
    1
    +

    http://www.unicode.org/Public/11.0.0/ucd/NameAliases.txt

    +
    +
    2
    +

    http://www.unicode.org/Public/11.0.0/ucd/NamedSequences.txt

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/unittest.html b/python-3.7.4-docs-html/library/unittest.html new file mode 100644 index 0000000..5c2c38e --- /dev/null +++ b/python-3.7.4-docs-html/library/unittest.html @@ -0,0 +1,2665 @@ + + + + + + + unittest — Unit testing framework — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    unittest — Unit testing framework

    +

    Source code: Lib/unittest/__init__.py

    +
    +

    (If you are already familiar with the basic concepts of testing, you might want +to skip to the list of assert methods.)

    +

    The unittest unit testing framework was originally inspired by JUnit +and has a similar flavor as major unit testing frameworks in other +languages. It supports test automation, sharing of setup and shutdown code +for tests, aggregation of tests into collections, and independence of the +tests from the reporting framework.

    +

    To achieve this, unittest supports some important concepts in an +object-oriented way:

    +
    +
    test fixture

    A test fixture represents the preparation needed to perform one or more +tests, and any associate cleanup actions. This may involve, for example, +creating temporary or proxy databases, directories, or starting a server +process.

    +
    +
    test case

    A test case is the individual unit of testing. It checks for a specific +response to a particular set of inputs. unittest provides a base class, +TestCase, which may be used to create new test cases.

    +
    +
    test suite

    A test suite is a collection of test cases, test suites, or both. It is +used to aggregate tests that should be executed together.

    +
    +
    test runner

    A test runner is a component which orchestrates the execution of tests +and provides the outcome to the user. The runner may use a graphical interface, +a textual interface, or return a special value to indicate the results of +executing the tests.

    +
    +
    +
    +

    See also

    +
    +
    Module doctest

    Another test-support module with a very different flavor.

    +
    +
    Simple Smalltalk Testing: With Patterns

    Kent Beck’s original paper on testing frameworks using the pattern shared +by unittest.

    +
    +
    Nose and pytest

    Third-party unittest frameworks with a lighter-weight syntax for writing +tests. For example, assert func(10) == 42.

    +
    +
    The Python Testing Tools Taxonomy

    An extensive list of Python testing tools including functional testing +frameworks and mock object libraries.

    +
    +
    Testing in Python Mailing List

    A special-interest-group for discussion of testing, and testing tools, +in Python.

    +
    +
    +

    The script Tools/unittestgui/unittestgui.py in the Python source distribution is +a GUI tool for test discovery and execution. This is intended largely for ease of use +for those new to unit testing. For production environments it is +recommended that tests be driven by a continuous integration system such as +Buildbot, Jenkins +or Hudson.

    +
    +
    +

    Basic example

    +

    The unittest module provides a rich set of tools for constructing and +running tests. This section demonstrates that a small subset of the tools +suffice to meet the needs of most users.

    +

    Here is a short script to test three string methods:

    +
    import unittest
    +
    +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)
    +
    +if __name__ == '__main__':
    +    unittest.main()
    +
    +
    +

    A testcase is created by subclassing unittest.TestCase. The three +individual tests are defined with methods whose names start with the letters +test. This naming convention informs the test runner about which methods +represent tests.

    +

    The crux of each test is a call to assertEqual() to check for an +expected result; assertTrue() or assertFalse() +to verify a condition; or assertRaises() to verify that a +specific exception gets raised. These methods are used instead of the +assert statement so the test runner can accumulate all test results +and produce a report.

    +

    The setUp() and tearDown() methods allow you +to define instructions that will be executed before and after each test method. +They are covered in more detail in the section Organizing test code.

    +

    The final block shows a simple way to run the tests. unittest.main() +provides a command-line interface to the test script. When run from the command +line, the above script produces an output that looks like this:

    +
    ...
    +----------------------------------------------------------------------
    +Ran 3 tests in 0.000s
    +
    +OK
    +
    +
    +

    Passing the -v option to your test script will instruct unittest.main() +to enable a higher level of verbosity, and produce the following output:

    +
    test_isupper (__main__.TestStringMethods) ... ok
    +test_split (__main__.TestStringMethods) ... ok
    +test_upper (__main__.TestStringMethods) ... ok
    +
    +----------------------------------------------------------------------
    +Ran 3 tests in 0.001s
    +
    +OK
    +
    +
    +

    The above examples show the most commonly used unittest features which +are sufficient to meet many everyday testing needs. The remainder of the +documentation explores the full feature set from first principles.

    +
    +
    +

    Command-Line Interface

    +

    The unittest module can be used from the command line to run tests from +modules, classes or even individual test methods:

    +
    python -m unittest test_module1 test_module2
    +python -m unittest test_module.TestClass
    +python -m unittest test_module.TestClass.test_method
    +
    +
    +

    You can pass in a list with any combination of module names, and fully +qualified class or method names.

    +

    Test modules can be specified by file path as well:

    +
    python -m unittest tests/test_something.py
    +
    +
    +

    This allows you to use the shell filename completion to specify the test module. +The file specified must still be importable as a module. The path is converted +to a module name by removing the ‘.py’ and converting path separators into ‘.’. +If you want to execute a test file that isn’t importable as a module you should +execute the file directly instead.

    +

    You can run tests with more detail (higher verbosity) by passing in the -v flag:

    +
    python -m unittest -v test_module
    +
    +
    +

    When executed without arguments Test Discovery is started:

    +
    python -m unittest
    +
    +
    +

    For a list of all the command-line options:

    +
    python -m unittest -h
    +
    +
    +
    +

    Changed in version 3.2: In earlier versions it was only possible to run individual test methods and +not modules or classes.

    +
    +
    +

    Command-line options

    +

    unittest supports these command-line options:

    +
    +
    +-b, --buffer
    +

    The standard output and standard error streams are buffered during the test +run. Output during a passing test is discarded. Output is echoed normally +on test fail or error and is added to the failure messages.

    +
    + +
    +
    +-c, --catch
    +

    Control-C during the test run waits for the current test to end and then +reports all the results so far. A second Control-C raises the normal +KeyboardInterrupt exception.

    +

    See Signal Handling for the functions that provide this functionality.

    +
    + +
    +
    +-f, --failfast
    +

    Stop the test run on the first error or failure.

    +
    + +
    +
    +-k
    +

    Only run test methods and classes that match the pattern or substring. +This option may be used multiple times, in which case all test cases that +match of the given patterns are included.

    +

    Patterns that contain a wildcard character (*) are matched against the +test name using fnmatch.fnmatchcase(); otherwise simple case-sensitive +substring matching is used.

    +

    Patterns are matched against the fully qualified test method name as +imported by the test loader.

    +

    For example, -k foo matches foo_tests.SomeTest.test_something, +bar_tests.SomeTest.test_foo, but not bar_tests.FooTest.test_something.

    +
    + +
    +
    +--locals
    +

    Show local variables in tracebacks.

    +
    + +
    +

    New in version 3.2: The command-line options -b, -c and -f were added.

    +
    +
    +

    New in version 3.5: The command-line option --locals.

    +
    +
    +

    New in version 3.7: The command-line option -k.

    +
    +

    The command line can also be used for test discovery, for running all of the +tests in a project or just a subset.

    +
    +
    +
    +

    Test Discovery

    +
    +

    New in version 3.2.

    +
    +

    Unittest supports simple test discovery. In order to be compatible with test +discovery, all of the test files must be modules or +packages (including namespace packages) importable from the top-level directory of +the project (this means that their filenames must be valid identifiers).

    +

    Test discovery is implemented in TestLoader.discover(), but can also be +used from the command line. The basic command-line usage is:

    +
    cd project_directory
    +python -m unittest discover
    +
    +
    +
    +

    Note

    +

    As a shortcut, python -m unittest is the equivalent of +python -m unittest discover. If you want to pass arguments to test +discovery the discover sub-command must be used explicitly.

    +
    +

    The discover sub-command has the following options:

    +
    +
    +-v, --verbose
    +

    Verbose output

    +
    + +
    +
    +-s, --start-directory directory
    +

    Directory to start discovery (. default)

    +
    + +
    +
    +-p, --pattern pattern
    +

    Pattern to match test files (test*.py default)

    +
    + +
    +
    +-t, --top-level-directory directory
    +

    Top level directory of project (defaults to start directory)

    +
    + +

    The -s, -p, and -t options can be passed in +as positional arguments in that order. The following two command lines +are equivalent:

    +
    python -m unittest discover -s project_directory -p "*_test.py"
    +python -m unittest discover project_directory "*_test.py"
    +
    +
    +

    As well as being a path it is possible to pass a package name, for example +myproject.subpackage.test, as the start directory. The package name you +supply will then be imported and its location on the filesystem will be used +as the start directory.

    +
    +

    Caution

    +

    Test discovery loads tests by importing them. Once test discovery has found +all the test files from the start directory you specify it turns the paths +into package names to import. For example foo/bar/baz.py will be +imported as foo.bar.baz.

    +

    If you have a package installed globally and attempt test discovery on +a different copy of the package then the import could happen from the +wrong place. If this happens test discovery will warn you and exit.

    +

    If you supply the start directory as a package name rather than a +path to a directory then discover assumes that whichever location it +imports from is the location you intended, so you will not get the +warning.

    +
    +

    Test modules and packages can customize test loading and discovery by through +the load_tests protocol.

    +
    +

    Changed in version 3.4: Test discovery supports namespace packages.

    +
    +
    +
    +

    Organizing test code

    +

    The basic building blocks of unit testing are test cases — single +scenarios that must be set up and checked for correctness. In unittest, +test cases are represented by unittest.TestCase instances. +To make your own test cases you must write subclasses of +TestCase or use FunctionTestCase.

    +

    The testing code of a TestCase instance should be entirely self +contained, such that it can be run either in isolation or in arbitrary +combination with any number of other test cases.

    +

    The simplest TestCase subclass will simply implement a test method +(i.e. a method whose name starts with test) in order to perform specific +testing code:

    +
    import unittest
    +
    +class DefaultWidgetSizeTestCase(unittest.TestCase):
    +    def test_default_widget_size(self):
    +        widget = Widget('The widget')
    +        self.assertEqual(widget.size(), (50, 50))
    +
    +
    +

    Note that in order to test something, we use one of the assert*() +methods provided by the TestCase base class. If the test fails, an +exception will be raised with an explanatory message, and unittest +will identify the test case as a failure. Any other exceptions will be +treated as errors.

    +

    Tests can be numerous, and their set-up can be repetitive. Luckily, we +can factor out set-up code by implementing a method called +setUp(), which the testing framework will automatically +call for every single test we run:

    +
    import unittest
    +
    +class WidgetTestCase(unittest.TestCase):
    +    def setUp(self):
    +        self.widget = Widget('The widget')
    +
    +    def test_default_widget_size(self):
    +        self.assertEqual(self.widget.size(), (50,50),
    +                         'incorrect default size')
    +
    +    def test_widget_resize(self):
    +        self.widget.resize(100,150)
    +        self.assertEqual(self.widget.size(), (100,150),
    +                         'wrong size after resize')
    +
    +
    +
    +

    Note

    +

    The order in which the various tests will be run is determined +by sorting the test method names with respect to the built-in +ordering for strings.

    +
    +

    If the setUp() method raises an exception while the test is +running, the framework will consider the test to have suffered an error, and +the test method will not be executed.

    +

    Similarly, we can provide a tearDown() method that tidies up +after the test method has been run:

    +
    import unittest
    +
    +class WidgetTestCase(unittest.TestCase):
    +    def setUp(self):
    +        self.widget = Widget('The widget')
    +
    +    def tearDown(self):
    +        self.widget.dispose()
    +
    +
    +

    If setUp() succeeded, tearDown() will be +run whether the test method succeeded or not.

    +

    Such a working environment for the testing code is called a +test fixture. A new TestCase instance is created as a unique +test fixture used to execute each individual test method. Thus +setUp(), tearDown(), and __init__() +will be called once per test.

    +

    It is recommended that you use TestCase implementations to group tests together +according to the features they test. unittest provides a mechanism for +this: the test suite, represented by unittest’s +TestSuite class. In most cases, calling unittest.main() will do +the right thing and collect all the module’s test cases for you and execute +them.

    +

    However, should you want to customize the building of your test suite, +you can do it yourself:

    +
    def suite():
    +    suite = unittest.TestSuite()
    +    suite.addTest(WidgetTestCase('test_default_widget_size'))
    +    suite.addTest(WidgetTestCase('test_widget_resize'))
    +    return suite
    +
    +if __name__ == '__main__':
    +    runner = unittest.TextTestRunner()
    +    runner.run(suite())
    +
    +
    +

    You can place the definitions of test cases and test suites in the same modules +as the code they are to test (such as widget.py), but there are several +advantages to placing the test code in a separate module, such as +test_widget.py:

    +
      +
    • The test module can be run standalone from the command line.

    • +
    • The test code can more easily be separated from shipped code.

    • +
    • There is less temptation to change test code to fit the code it tests without +a good reason.

    • +
    • Test code should be modified much less frequently than the code it tests.

    • +
    • Tested code can be refactored more easily.

    • +
    • Tests for modules written in C must be in separate modules anyway, so why not +be consistent?

    • +
    • If the testing strategy changes, there is no need to change the source code.

    • +
    +
    +
    +

    Re-using old test code

    +

    Some users will find that they have existing test code that they would like to +run from unittest, without converting every old test function to a +TestCase subclass.

    +

    For this reason, unittest provides a FunctionTestCase class. +This subclass of TestCase can be used to wrap an existing test +function. Set-up and tear-down functions can also be provided.

    +

    Given the following test function:

    +
    def testSomething():
    +    something = makeSomething()
    +    assert something.name is not None
    +    # ...
    +
    +
    +

    one can create an equivalent test case instance as follows, with optional +set-up and tear-down methods:

    +
    testcase = unittest.FunctionTestCase(testSomething,
    +                                     setUp=makeSomethingDB,
    +                                     tearDown=deleteSomethingDB)
    +
    +
    +
    +

    Note

    +

    Even though FunctionTestCase can be used to quickly convert an +existing test base over to a unittest-based system, this approach is +not recommended. Taking the time to set up proper TestCase +subclasses will make future test refactorings infinitely easier.

    +
    +

    In some cases, the existing tests may have been written using the doctest +module. If so, doctest provides a DocTestSuite class that can +automatically build unittest.TestSuite instances from the existing +doctest-based tests.

    +
    +
    +

    Skipping tests and expected failures

    +
    +

    New in version 3.1.

    +
    +

    Unittest supports skipping individual test methods and even whole classes of +tests. In addition, it supports marking a test as an “expected failure,” a test +that is broken and will fail, but shouldn’t be counted as a failure on a +TestResult.

    +

    Skipping a test is simply a matter of using the skip() decorator +or one of its conditional variants, calling TestCase.skipTest() within a +setUp() or test method, or raising SkipTest directly.

    +

    Basic skipping looks like this:

    +
    class MyTestCase(unittest.TestCase):
    +
    +    @unittest.skip("demonstrating skipping")
    +    def test_nothing(self):
    +        self.fail("shouldn't happen")
    +
    +    @unittest.skipIf(mylib.__version__ < (1, 3),
    +                     "not supported in this library version")
    +    def test_format(self):
    +        # Tests that work for only a certain version of the library.
    +        pass
    +
    +    @unittest.skipUnless(sys.platform.startswith("win"), "requires Windows")
    +    def test_windows_support(self):
    +        # windows specific testing code
    +        pass
    +
    +    def test_maybe_skipped(self):
    +        if not external_resource_available():
    +            self.skipTest("external resource not available")
    +        # test code that depends on the external resource
    +        pass
    +
    +
    +

    This is the output of running the example above in verbose mode:

    +
    test_format (__main__.MyTestCase) ... skipped 'not supported in this library version'
    +test_nothing (__main__.MyTestCase) ... skipped 'demonstrating skipping'
    +test_maybe_skipped (__main__.MyTestCase) ... skipped 'external resource not available'
    +test_windows_support (__main__.MyTestCase) ... skipped 'requires Windows'
    +
    +----------------------------------------------------------------------
    +Ran 4 tests in 0.005s
    +
    +OK (skipped=4)
    +
    +
    +

    Classes can be skipped just like methods:

    +
    @unittest.skip("showing class skipping")
    +class MySkippedTestCase(unittest.TestCase):
    +    def test_not_run(self):
    +        pass
    +
    +
    +

    TestCase.setUp() can also skip the test. This is useful when a resource +that needs to be set up is not available.

    +

    Expected failures use the expectedFailure() decorator.

    +
    class ExpectedFailureTestCase(unittest.TestCase):
    +    @unittest.expectedFailure
    +    def test_fail(self):
    +        self.assertEqual(1, 0, "broken")
    +
    +
    +

    It’s easy to roll your own skipping decorators by making a decorator that calls +skip() on the test when it wants it to be skipped. This decorator skips +the test unless the passed object has a certain attribute:

    +
    def skipUnlessHasattr(obj, attr):
    +    if hasattr(obj, attr):
    +        return lambda func: func
    +    return unittest.skip("{!r} doesn't have {!r}".format(obj, attr))
    +
    +
    +

    The following decorators and exception implement test skipping and expected failures:

    +
    +
    +@unittest.skip(reason)
    +

    Unconditionally skip the decorated test. reason should describe why the +test is being skipped.

    +
    + +
    +
    +@unittest.skipIf(condition, reason)
    +

    Skip the decorated test if condition is true.

    +
    + +
    +
    +@unittest.skipUnless(condition, reason)
    +

    Skip the decorated test unless condition is true.

    +
    + +
    +
    +@unittest.expectedFailure
    +

    Mark the test as an expected failure. If the test fails it will be +considered a success. If the test passes, it will be considered a failure.

    +
    + +
    +
    +exception unittest.SkipTest(reason)
    +

    This exception is raised to skip a test.

    +

    Usually you can use TestCase.skipTest() or one of the skipping +decorators instead of raising this directly.

    +
    + +

    Skipped tests will not have setUp() or tearDown() run around them. +Skipped classes will not have setUpClass() or tearDownClass() run. +Skipped modules will not have setUpModule() or tearDownModule() run.

    +
    +
    +

    Distinguishing test iterations using subtests

    +
    +

    New in version 3.4.

    +
    +

    When there are very small differences among your tests, for +instance some parameters, unittest allows you to distinguish them inside +the body of a test method using the subTest() context manager.

    +

    For example, the following test:

    +
    class NumbersTest(unittest.TestCase):
    +
    +    def test_even(self):
    +        """
    +        Test that numbers between 0 and 5 are all even.
    +        """
    +        for i in range(0, 6):
    +            with self.subTest(i=i):
    +                self.assertEqual(i % 2, 0)
    +
    +
    +

    will produce the following output:

    +
    ======================================================================
    +FAIL: test_even (__main__.NumbersTest) (i=1)
    +----------------------------------------------------------------------
    +Traceback (most recent call last):
    +  File "subtests.py", line 32, in test_even
    +    self.assertEqual(i % 2, 0)
    +AssertionError: 1 != 0
    +
    +======================================================================
    +FAIL: test_even (__main__.NumbersTest) (i=3)
    +----------------------------------------------------------------------
    +Traceback (most recent call last):
    +  File "subtests.py", line 32, in test_even
    +    self.assertEqual(i % 2, 0)
    +AssertionError: 1 != 0
    +
    +======================================================================
    +FAIL: test_even (__main__.NumbersTest) (i=5)
    +----------------------------------------------------------------------
    +Traceback (most recent call last):
    +  File "subtests.py", line 32, in test_even
    +    self.assertEqual(i % 2, 0)
    +AssertionError: 1 != 0
    +
    +
    +

    Without using a subtest, execution would stop after the first failure, +and the error would be less easy to diagnose because the value of i +wouldn’t be displayed:

    +
    ======================================================================
    +FAIL: test_even (__main__.NumbersTest)
    +----------------------------------------------------------------------
    +Traceback (most recent call last):
    +  File "subtests.py", line 32, in test_even
    +    self.assertEqual(i % 2, 0)
    +AssertionError: 1 != 0
    +
    +
    +
    +
    +

    Classes and functions

    +

    This section describes in depth the API of unittest.

    +
    +

    Test cases

    +
    +
    +class unittest.TestCase(methodName='runTest')
    +

    Instances of the TestCase class represent the logical test units +in the unittest universe. This class is intended to be used as a base +class, with specific tests being implemented by concrete subclasses. This class +implements the interface needed by the test runner to allow it to drive the +tests, and methods that the test code can use to check for and report various +kinds of failure.

    +

    Each instance of TestCase will run a single base method: the method +named methodName. +In most uses of TestCase, you will neither change +the methodName nor reimplement the default runTest() method.

    +
    +

    Changed in version 3.2: TestCase can be instantiated successfully without providing a +methodName. This makes it easier to experiment with TestCase +from the interactive interpreter.

    +
    +

    TestCase instances provide three groups of methods: one group used +to run the test, another used by the test implementation to check conditions +and report failures, and some inquiry methods allowing information about the +test itself to be gathered.

    +

    Methods in the first group (running the test) are:

    +
    +
    +setUp()
    +

    Method called to prepare the test fixture. This is called immediately +before calling the test method; other than AssertionError or SkipTest, +any exception raised by this method will be considered an error rather than +a test failure. The default implementation does nothing.

    +
    + +
    +
    +tearDown()
    +

    Method called immediately after the test method has been called and the +result recorded. This is called even if the test method raised an +exception, so the implementation in subclasses may need to be particularly +careful about checking internal state. Any exception, other than +AssertionError or SkipTest, raised by this method will be +considered an additional error rather than a test failure (thus increasing +the total number of reported errors). This method will only be called if +the setUp() succeeds, regardless of the outcome of the test method. +The default implementation does nothing.

    +
    + +
    +
    +setUpClass()
    +

    A class method called before tests in an individual class are run. +setUpClass is called with the class as the only argument +and must be decorated as a classmethod():

    +
    @classmethod
    +def setUpClass(cls):
    +    ...
    +
    +
    +

    See Class and Module Fixtures for more details.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +tearDownClass()
    +

    A class method called after tests in an individual class have run. +tearDownClass is called with the class as the only argument +and must be decorated as a classmethod():

    +
    @classmethod
    +def tearDownClass(cls):
    +    ...
    +
    +
    +

    See Class and Module Fixtures for more details.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +run(result=None)
    +

    Run the test, collecting the result into the TestResult object +passed as result. If result is omitted or None, a temporary +result object is created (by calling the defaultTestResult() +method) and used. The result object is returned to run()’s +caller.

    +

    The same effect may be had by simply calling the TestCase +instance.

    +
    +

    Changed in version 3.3: Previous versions of run did not return the result. Neither did +calling an instance.

    +
    +
    + +
    +
    +skipTest(reason)
    +

    Calling this during a test method or setUp() skips the current +test. See Skipping tests and expected failures for more information.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +subTest(msg=None, **params)
    +

    Return a context manager which executes the enclosed code block as a +subtest. msg and params are optional, arbitrary values which are +displayed whenever a subtest fails, allowing you to identify them +clearly.

    +

    A test case can contain any number of subtest declarations, and +they can be arbitrarily nested.

    +

    See Distinguishing test iterations using subtests for more information.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +debug()
    +

    Run the test without collecting the result. This allows exceptions raised +by the test to be propagated to the caller, and can be used to support +running tests under a debugger.

    +
    + +

    The TestCase class provides several assert methods to check for and +report failures. The following table lists the most commonly used methods +(see the tables below for more assert methods):

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Method

    Checks that

    New in

    assertEqual(a, b)

    a == b

    assertNotEqual(a, b)

    a != b

    assertTrue(x)

    bool(x) is True

    assertFalse(x)

    bool(x) is False

    assertIs(a, b)

    a is b

    3.1

    assertIsNot(a, b)

    a is not b

    3.1

    assertIsNone(x)

    x is None

    3.1

    assertIsNotNone(x)

    x is not None

    3.1

    assertIn(a, b)

    a in b

    3.1

    assertNotIn(a, b)

    a not in b

    3.1

    assertIsInstance(a, b)

    isinstance(a, b)

    3.2

    assertNotIsInstance(a, b)

    not isinstance(a, b)

    3.2

    +

    All the assert methods accept a msg argument that, if specified, is used +as the error message on failure (see also longMessage). +Note that the msg keyword argument can be passed to assertRaises(), +assertRaisesRegex(), assertWarns(), assertWarnsRegex() +only when they are used as a context manager.

    +
    +
    +assertEqual(first, second, msg=None)
    +

    Test that first and second are equal. If the values do not +compare equal, the test will fail.

    +

    In addition, if first and second are the exact same type and one of +list, tuple, dict, set, frozenset or str or any type that a subclass +registers with addTypeEqualityFunc() the type-specific equality +function will be called in order to generate a more useful default +error message (see also the list of type-specific methods).

    +
    +

    Changed in version 3.1: Added the automatic calling of type-specific equality function.

    +
    +
    +

    Changed in version 3.2: assertMultiLineEqual() added as the default type equality +function for comparing strings.

    +
    +
    + +
    +
    +assertNotEqual(first, second, msg=None)
    +

    Test that first and second are not equal. If the values do +compare equal, the test will fail.

    +
    + +
    +
    +assertTrue(expr, msg=None)
    +
    +assertFalse(expr, msg=None)
    +

    Test that expr is true (or false).

    +

    Note that this is equivalent to bool(expr) is True and not to expr +is True (use assertIs(expr, True) for the latter). This method +should also be avoided when more specific methods are available (e.g. +assertEqual(a, b) instead of assertTrue(a == b)), because they +provide a better error message in case of failure.

    +
    + +
    +
    +assertIs(first, second, msg=None)
    +
    +assertIsNot(first, second, msg=None)
    +

    Test that first and second evaluate (or don’t evaluate) to the +same object.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +assertIsNone(expr, msg=None)
    +
    +assertIsNotNone(expr, msg=None)
    +

    Test that expr is (or is not) None.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +assertIn(first, second, msg=None)
    +
    +assertNotIn(first, second, msg=None)
    +

    Test that first is (or is not) in second.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +assertIsInstance(obj, cls, msg=None)
    +
    +assertNotIsInstance(obj, cls, msg=None)
    +

    Test that obj is (or is not) an instance of cls (which can be a +class or a tuple of classes, as supported by isinstance()). +To check for the exact type, use assertIs(type(obj), cls).

    +
    +

    New in version 3.2.

    +
    +
    + +

    It is also possible to check the production of exceptions, warnings, and +log messages using the following methods:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Method

    Checks that

    New in

    assertRaises(exc, fun, *args, **kwds)

    fun(*args, **kwds) raises exc

    assertRaisesRegex(exc, r, fun, *args, **kwds)

    fun(*args, **kwds) raises exc +and the message matches regex r

    3.1

    assertWarns(warn, fun, *args, **kwds)

    fun(*args, **kwds) raises warn

    3.2

    assertWarnsRegex(warn, r, fun, *args, **kwds)

    fun(*args, **kwds) raises warn +and the message matches regex r

    3.2

    assertLogs(logger, level)

    The with block logs on logger +with minimum level

    3.4

    +
    +
    +assertRaises(exception, callable, *args, **kwds)
    +
    +assertRaises(exception, *, msg=None)
    +

    Test that an exception is raised when callable is called with any +positional or keyword arguments that are also passed to +assertRaises(). The test passes if exception is raised, is an +error if another exception is raised, or fails if no exception is raised. +To catch any of a group of exceptions, a tuple containing the exception +classes may be passed as exception.

    +

    If only the exception and possibly the msg arguments are given, +return a context manager so that the code under test can be written +inline rather than as a function:

    +
    with self.assertRaises(SomeException):
    +    do_something()
    +
    +
    +

    When used as a context manager, assertRaises() accepts the +additional keyword argument msg.

    +

    The context manager will store the caught exception object in its +exception attribute. This can be useful if the intention +is to perform additional checks on the exception raised:

    +
    with self.assertRaises(SomeException) as cm:
    +    do_something()
    +
    +the_exception = cm.exception
    +self.assertEqual(the_exception.error_code, 3)
    +
    +
    +
    +

    Changed in version 3.1: Added the ability to use assertRaises() as a context manager.

    +
    +
    +

    Changed in version 3.2: Added the exception attribute.

    +
    +
    +

    Changed in version 3.3: Added the msg keyword argument when used as a context manager.

    +
    +
    + +
    +
    +assertRaisesRegex(exception, regex, callable, *args, **kwds)
    +
    +assertRaisesRegex(exception, regex, *, msg=None)
    +

    Like assertRaises() but also tests that regex matches +on the string representation of the raised exception. regex may be +a regular expression object or a string containing a regular expression +suitable for use by re.search(). Examples:

    +
    self.assertRaisesRegex(ValueError, "invalid literal for.*XYZ'$",
    +                       int, 'XYZ')
    +
    +
    +

    or:

    +
    with self.assertRaisesRegex(ValueError, 'literal'):
    +   int('XYZ')
    +
    +
    +
    +

    New in version 3.1: Added under the name assertRaisesRegexp.

    +
    +
    +

    Changed in version 3.2: Renamed to assertRaisesRegex().

    +
    +
    +

    Changed in version 3.3: Added the msg keyword argument when used as a context manager.

    +
    +
    + +
    +
    +assertWarns(warning, callable, *args, **kwds)
    +
    +assertWarns(warning, *, msg=None)
    +

    Test that a warning is triggered when callable is called with any +positional or keyword arguments that are also passed to +assertWarns(). The test passes if warning is triggered and +fails if it isn’t. Any exception is an error. +To catch any of a group of warnings, a tuple containing the warning +classes may be passed as warnings.

    +

    If only the warning and possibly the msg arguments are given, +return a context manager so that the code under test can be written +inline rather than as a function:

    +
    with self.assertWarns(SomeWarning):
    +    do_something()
    +
    +
    +

    When used as a context manager, assertWarns() accepts the +additional keyword argument msg.

    +

    The context manager will store the caught warning object in its +warning attribute, and the source line which triggered the +warnings in the filename and lineno attributes. +This can be useful if the intention is to perform additional checks +on the warning caught:

    +
    with self.assertWarns(SomeWarning) as cm:
    +    do_something()
    +
    +self.assertIn('myfile.py', cm.filename)
    +self.assertEqual(320, cm.lineno)
    +
    +
    +

    This method works regardless of the warning filters in place when it +is called.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.3: Added the msg keyword argument when used as a context manager.

    +
    +
    + +
    +
    +assertWarnsRegex(warning, regex, callable, *args, **kwds)
    +
    +assertWarnsRegex(warning, regex, *, msg=None)
    +

    Like assertWarns() but also tests that regex matches on the +message of the triggered warning. regex may be a regular expression +object or a string containing a regular expression suitable for use +by re.search(). Example:

    +
    self.assertWarnsRegex(DeprecationWarning,
    +                      r'legacy_function\(\) is deprecated',
    +                      legacy_function, 'XYZ')
    +
    +
    +

    or:

    +
    with self.assertWarnsRegex(RuntimeWarning, 'unsafe frobnicating'):
    +    frobnicate('/etc/passwd')
    +
    +
    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.3: Added the msg keyword argument when used as a context manager.

    +
    +
    + +
    +
    +assertLogs(logger=None, level=None)
    +

    A context manager to test that at least one message is logged on +the logger or one of its children, with at least the given +level.

    +

    If given, logger should be a logging.Logger object or a +str giving the name of a logger. The default is the root +logger, which will catch all messages.

    +

    If given, level should be either a numeric logging level or +its string equivalent (for example either "ERROR" or +logging.ERROR). The default is logging.INFO.

    +

    The test passes if at least one message emitted inside the with +block matches the logger and level conditions, otherwise it fails.

    +

    The object returned by the context manager is a recording helper +which keeps tracks of the matching log messages. It has two +attributes:

    +
    +
    +records
    +

    A list of logging.LogRecord objects of the matching +log messages.

    +
    + +
    +
    +output
    +

    A list of str objects with the formatted output of +matching messages.

    +
    + +

    Example:

    +
    with self.assertLogs('foo', level='INFO') as cm:
    +   logging.getLogger('foo').info('first message')
    +   logging.getLogger('foo.bar').error('second message')
    +self.assertEqual(cm.output, ['INFO:foo:first message',
    +                             'ERROR:foo.bar:second message'])
    +
    +
    +
    +

    New in version 3.4.

    +
    +
    + +

    There are also other methods used to perform more specific checks, such as:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Method

    Checks that

    New in

    assertAlmostEqual(a, b)

    round(a-b, 7) == 0

    assertNotAlmostEqual(a, b)

    round(a-b, 7) != 0

    assertGreater(a, b)

    a > b

    3.1

    assertGreaterEqual(a, b)

    a >= b

    3.1

    assertLess(a, b)

    a < b

    3.1

    assertLessEqual(a, b)

    a <= b

    3.1

    assertRegex(s, r)

    r.search(s)

    3.1

    assertNotRegex(s, r)

    not r.search(s)

    3.2

    assertCountEqual(a, b)

    a and b have the same +elements in the same number, +regardless of their order.

    3.2

    +
    +
    +assertAlmostEqual(first, second, places=7, msg=None, delta=None)
    +
    +assertNotAlmostEqual(first, second, places=7, msg=None, delta=None)
    +

    Test that first and second are approximately (or not approximately) +equal by computing the difference, rounding to the given number of +decimal places (default 7), and comparing to zero. Note that these +methods round the values to the given number of decimal places (i.e. +like the round() function) and not significant digits.

    +

    If delta is supplied instead of places then the difference +between first and second must be less or equal to (or greater than) delta.

    +

    Supplying both delta and places raises a TypeError.

    +
    +

    Changed in version 3.2: assertAlmostEqual() automatically considers almost equal objects +that compare equal. assertNotAlmostEqual() automatically fails +if the objects compare equal. Added the delta keyword argument.

    +
    +
    + +
    +
    +assertGreater(first, second, msg=None)
    +
    +assertGreaterEqual(first, second, msg=None)
    +
    +assertLess(first, second, msg=None)
    +
    +assertLessEqual(first, second, msg=None)
    +

    Test that first is respectively >, >=, < or <= than second depending +on the method name. If not, the test will fail:

    +
    >>> self.assertGreaterEqual(3, 4)
    +AssertionError: "3" unexpectedly not greater than or equal to "4"
    +
    +
    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +assertRegex(text, regex, msg=None)
    +
    +assertNotRegex(text, regex, msg=None)
    +

    Test that a regex search matches (or does not match) text. In case +of failure, the error message will include the pattern and the text (or +the pattern and the part of text that unexpectedly matched). regex +may be a regular expression object or a string containing a regular +expression suitable for use by re.search().

    +
    +

    New in version 3.1: Added under the name assertRegexpMatches.

    +
    +
    +

    Changed in version 3.2: The method assertRegexpMatches() has been renamed to +assertRegex().

    +
    +
    +

    New in version 3.2: assertNotRegex().

    +
    +
    +

    New in version 3.5: The name assertNotRegexpMatches is a deprecated alias +for assertNotRegex().

    +
    +
    + +
    +
    +assertCountEqual(first, second, msg=None)
    +

    Test that sequence first contains the same elements as second, +regardless of their order. When they don’t, an error message listing the +differences between the sequences will be generated.

    +

    Duplicate elements are not ignored when comparing first and +second. It verifies whether each element has the same count in both +sequences. Equivalent to: +assertEqual(Counter(list(first)), Counter(list(second))) +but works with sequences of unhashable objects as well.

    +
    +

    New in version 3.2.

    +
    +
    + +

    The assertEqual() method dispatches the equality check for objects of +the same type to different type-specific methods. These methods are already +implemented for most of the built-in types, but it’s also possible to +register new methods using addTypeEqualityFunc():

    +
    +
    +addTypeEqualityFunc(typeobj, function)
    +

    Registers a type-specific method called by assertEqual() to check +if two objects of exactly the same typeobj (not subclasses) compare +equal. function must take two positional arguments and a third msg=None +keyword argument just as assertEqual() does. It must raise +self.failureException(msg) when inequality +between the first two parameters is detected – possibly providing useful +information and explaining the inequalities in details in the error +message.

    +
    +

    New in version 3.1.

    +
    +
    + +

    The list of type-specific methods automatically used by +assertEqual() are summarized in the following table. Note +that it’s usually not necessary to invoke these methods directly.

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Method

    Used to compare

    New in

    assertMultiLineEqual(a, b)

    strings

    3.1

    assertSequenceEqual(a, b)

    sequences

    3.1

    assertListEqual(a, b)

    lists

    3.1

    assertTupleEqual(a, b)

    tuples

    3.1

    assertSetEqual(a, b)

    sets or frozensets

    3.1

    assertDictEqual(a, b)

    dicts

    3.1

    +
    +
    +assertMultiLineEqual(first, second, msg=None)
    +

    Test that the multiline string first is equal to the string second. +When not equal a diff of the two strings highlighting the differences +will be included in the error message. This method is used by default +when comparing strings with assertEqual().

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +assertSequenceEqual(first, second, msg=None, seq_type=None)
    +

    Tests that two sequences are equal. If a seq_type is supplied, both +first and second must be instances of seq_type or a failure will +be raised. If the sequences are different an error message is +constructed that shows the difference between the two.

    +

    This method is not called directly by assertEqual(), but +it’s used to implement assertListEqual() and +assertTupleEqual().

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +assertListEqual(first, second, msg=None)
    +
    +assertTupleEqual(first, second, msg=None)
    +

    Tests that two lists or tuples are equal. If not, an error message is +constructed that shows only the differences between the two. An error +is also raised if either of the parameters are of the wrong type. +These methods are used by default when comparing lists or tuples with +assertEqual().

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +assertSetEqual(first, second, msg=None)
    +

    Tests that two sets are equal. If not, an error message is constructed +that lists the differences between the sets. This method is used by +default when comparing sets or frozensets with assertEqual().

    +

    Fails if either of first or second does not have a set.difference() +method.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +assertDictEqual(first, second, msg=None)
    +

    Test that two dictionaries are equal. If not, an error message is +constructed that shows the differences in the dictionaries. This +method will be used by default to compare dictionaries in +calls to assertEqual().

    +
    +

    New in version 3.1.

    +
    +
    + +

    Finally the TestCase provides the following methods and attributes:

    +
    +
    +fail(msg=None)
    +

    Signals a test failure unconditionally, with msg or None for +the error message.

    +
    + +
    +
    +failureException
    +

    This class attribute gives the exception raised by the test method. If a +test framework needs to use a specialized exception, possibly to carry +additional information, it must subclass this exception in order to “play +fair” with the framework. The initial value of this attribute is +AssertionError.

    +
    + +
    +
    +longMessage
    +

    This class attribute determines what happens when a custom failure message +is passed as the msg argument to an assertXYY call that fails. +True is the default value. In this case, the custom message is appended +to the end of the standard failure message. +When set to False, the custom message replaces the standard message.

    +

    The class setting can be overridden in individual test methods by assigning +an instance attribute, self.longMessage, to True or False before +calling the assert methods.

    +

    The class setting gets reset before each test call.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +maxDiff
    +

    This attribute controls the maximum length of diffs output by assert +methods that report diffs on failure. It defaults to 80*8 characters. +Assert methods affected by this attribute are +assertSequenceEqual() (including all the sequence comparison +methods that delegate to it), assertDictEqual() and +assertMultiLineEqual().

    +

    Setting maxDiff to None means that there is no maximum length of +diffs.

    +
    +

    New in version 3.2.

    +
    +
    + +

    Testing frameworks can use the following methods to collect information on +the test:

    +
    +
    +countTestCases()
    +

    Return the number of tests represented by this test object. For +TestCase instances, this will always be 1.

    +
    + +
    +
    +defaultTestResult()
    +

    Return an instance of the test result class that should be used for this +test case class (if no other result instance is provided to the +run() method).

    +

    For TestCase instances, this will always be an instance of +TestResult; subclasses of TestCase should override this +as necessary.

    +
    + +
    +
    +id()
    +

    Return a string identifying the specific test case. This is usually the +full name of the test method, including the module and class name.

    +
    + +
    +
    +shortDescription()
    +

    Returns a description of the test, or None if no description +has been provided. The default implementation of this method +returns the first line of the test method’s docstring, if available, +or None.

    +
    +

    Changed in version 3.1: In 3.1 this was changed to add the test name to the short description +even in the presence of a docstring. This caused compatibility issues +with unittest extensions and adding the test name was moved to the +TextTestResult in Python 3.2.

    +
    +
    + +
    +
    +addCleanup(function, *args, **kwargs)
    +

    Add a function to be called after tearDown() to cleanup resources +used during the test. Functions will be called in reverse order to the +order they are added (LIFO). They +are called with any arguments and keyword arguments passed into +addCleanup() when they are added.

    +

    If setUp() fails, meaning that tearDown() is not called, +then any cleanup functions added will still be called.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +doCleanups()
    +

    This method is called unconditionally after tearDown(), or +after setUp() if setUp() raises an exception.

    +

    It is responsible for calling all the cleanup functions added by +addCleanup(). If you need cleanup functions to be called +prior to tearDown() then you can call doCleanups() +yourself.

    +

    doCleanups() pops methods off the stack of cleanup +functions one at a time, so it can be called at any time.

    +
    +

    New in version 3.1.

    +
    +
    + +
    + +
    +
    +class unittest.FunctionTestCase(testFunc, setUp=None, tearDown=None, description=None)
    +

    This class implements the portion of the TestCase interface which +allows the test runner to drive the test, but does not provide the methods +which test code can use to check and report errors. This is used to create +test cases using legacy test code, allowing it to be integrated into a +unittest-based test framework.

    +
    + +
    +

    Deprecated aliases

    +

    For historical reasons, some of the TestCase methods had one or more +aliases that are now deprecated. The following table lists the correct names +along with their deprecated aliases:

    +
    +
    +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Method Name

    Deprecated alias

    Deprecated alias

    assertEqual()

    failUnlessEqual

    assertEquals

    assertNotEqual()

    failIfEqual

    assertNotEquals

    assertTrue()

    failUnless

    assert_

    assertFalse()

    failIf

    assertRaises()

    failUnlessRaises

    assertAlmostEqual()

    failUnlessAlmostEqual

    assertAlmostEquals

    assertNotAlmostEqual()

    failIfAlmostEqual

    assertNotAlmostEquals

    assertRegex()

    assertRegexpMatches

    assertNotRegex()

    assertNotRegexpMatches

    assertRaisesRegex()

    assertRaisesRegexp

    +
    +

    Deprecated since version 3.1: The fail* aliases listed in the second column have been deprecated.

    +
    +
    +

    Deprecated since version 3.2: The assert* aliases listed in the third column have been deprecated.

    +
    +
    +

    Deprecated since version 3.2: assertRegexpMatches and assertRaisesRegexp have been renamed to +assertRegex() and assertRaisesRegex().

    +
    +
    +

    Deprecated since version 3.5: The assertNotRegexpMatches name is deprecated in favor of assertNotRegex().

    +
    +
    +
    +
    +
    +

    Grouping tests

    +
    +
    +class unittest.TestSuite(tests=())
    +

    This class represents an aggregation of individual test cases and test suites. +The class presents the interface needed by the test runner to allow it to be run +as any other test case. Running a TestSuite instance is the same as +iterating over the suite, running each test individually.

    +

    If tests is given, it must be an iterable of individual test cases or other +test suites that will be used to build the suite initially. Additional methods +are provided to add test cases and suites to the collection later on.

    +

    TestSuite objects behave much like TestCase objects, except +they do not actually implement a test. Instead, they are used to aggregate +tests into groups of tests that should be run together. Some additional +methods are available to add tests to TestSuite instances:

    +
    +
    +addTest(test)
    +

    Add a TestCase or TestSuite to the suite.

    +
    + +
    +
    +addTests(tests)
    +

    Add all the tests from an iterable of TestCase and TestSuite +instances to this test suite.

    +

    This is equivalent to iterating over tests, calling addTest() for +each element.

    +
    + +

    TestSuite shares the following methods with TestCase:

    +
    +
    +run(result)
    +

    Run the tests associated with this suite, collecting the result into the +test result object passed as result. Note that unlike +TestCase.run(), TestSuite.run() requires the result object to +be passed in.

    +
    + +
    +
    +debug()
    +

    Run the tests associated with this suite without collecting the +result. This allows exceptions raised by the test to be propagated to the +caller and can be used to support running tests under a debugger.

    +
    + +
    +
    +countTestCases()
    +

    Return the number of tests represented by this test object, including all +individual tests and sub-suites.

    +
    + +
    +
    +__iter__()
    +

    Tests grouped by a TestSuite are always accessed by iteration. +Subclasses can lazily provide tests by overriding __iter__(). Note +that this method may be called several times on a single suite (for +example when counting tests or comparing for equality) so the tests +returned by repeated iterations before TestSuite.run() must be the +same for each call iteration. After TestSuite.run(), callers should +not rely on the tests returned by this method unless the caller uses a +subclass that overrides TestSuite._removeTestAtIndex() to preserve +test references.

    +
    +

    Changed in version 3.2: In earlier versions the TestSuite accessed tests directly rather +than through iteration, so overriding __iter__() wasn’t sufficient +for providing tests.

    +
    +
    +

    Changed in version 3.4: In earlier versions the TestSuite held references to each +TestCase after TestSuite.run(). Subclasses can restore +that behavior by overriding TestSuite._removeTestAtIndex().

    +
    +
    + +

    In the typical usage of a TestSuite object, the run() method +is invoked by a TestRunner rather than by the end-user test harness.

    +
    + +
    +
    +

    Loading and running tests

    +
    +
    +class unittest.TestLoader
    +

    The TestLoader class is used to create test suites from classes and +modules. Normally, there is no need to create an instance of this class; the +unittest module provides an instance that can be shared as +unittest.defaultTestLoader. Using a subclass or instance, however, +allows customization of some configurable properties.

    +

    TestLoader objects have the following attributes:

    +
    +
    +errors
    +

    A list of the non-fatal errors encountered while loading tests. Not reset +by the loader at any point. Fatal errors are signalled by the relevant +a method raising an exception to the caller. Non-fatal errors are also +indicated by a synthetic test that will raise the original error when +run.

    +
    +

    New in version 3.5.

    +
    +
    + +

    TestLoader objects have the following methods:

    +
    +
    +loadTestsFromTestCase(testCaseClass)
    +

    Return a suite of all test cases contained in the TestCase-derived +testCaseClass.

    +

    A test case instance is created for each method named by +getTestCaseNames(). By default these are the method names +beginning with test. If getTestCaseNames() returns no +methods, but the runTest() method is implemented, a single test +case is created for that method instead.

    +
    + +
    +
    +loadTestsFromModule(module, pattern=None)
    +

    Return a suite of all test cases contained in the given module. This +method searches module for classes derived from TestCase and +creates an instance of the class for each test method defined for the +class.

    +
    +

    Note

    +

    While using a hierarchy of TestCase-derived classes can be +convenient in sharing fixtures and helper functions, defining test +methods on base classes that are not intended to be instantiated +directly does not play well with this method. Doing so, however, can +be useful when the fixtures are different and defined in subclasses.

    +
    +

    If a module provides a load_tests function it will be called to +load the tests. This allows modules to customize test loading. +This is the load_tests protocol. The pattern argument is passed as +the third argument to load_tests.

    +
    +

    Changed in version 3.2: Support for load_tests added.

    +
    +
    +

    Changed in version 3.5: The undocumented and unofficial use_load_tests default argument is +deprecated and ignored, although it is still accepted for backward +compatibility. The method also now accepts a keyword-only argument +pattern which is passed to load_tests as the third argument.

    +
    +
    + +
    +
    +loadTestsFromName(name, module=None)
    +

    Return a suite of all test cases given a string specifier.

    +

    The specifier name is a “dotted name” that may resolve either to a +module, a test case class, a test method within a test case class, a +TestSuite instance, or a callable object which returns a +TestCase or TestSuite instance. These checks are +applied in the order listed here; that is, a method on a possible test +case class will be picked up as “a test method within a test case class”, +rather than “a callable object”.

    +

    For example, if you have a module SampleTests containing a +TestCase-derived class SampleTestCase with three test +methods (test_one(), test_two(), and test_three()), the +specifier 'SampleTests.SampleTestCase' would cause this method to +return a suite which will run all three test methods. Using the specifier +'SampleTests.SampleTestCase.test_two' would cause it to return a test +suite which will run only the test_two() test method. The specifier +can refer to modules and packages which have not been imported; they will +be imported as a side-effect.

    +

    The method optionally resolves name relative to the given module.

    +
    +

    Changed in version 3.5: If an ImportError or AttributeError occurs while traversing +name then a synthetic test that raises that error when run will be +returned. These errors are included in the errors accumulated by +self.errors.

    +
    +
    + +
    +
    +loadTestsFromNames(names, module=None)
    +

    Similar to loadTestsFromName(), but takes a sequence of names rather +than a single name. The return value is a test suite which supports all +the tests defined for each name.

    +
    + +
    +
    +getTestCaseNames(testCaseClass)
    +

    Return a sorted sequence of method names found within testCaseClass; +this should be a subclass of TestCase.

    +
    + +
    +
    +discover(start_dir, pattern='test*.py', top_level_dir=None)
    +

    Find all the test modules by recursing into subdirectories from the +specified start directory, and return a TestSuite object containing them. +Only test files that match pattern will be loaded. (Using shell style +pattern matching.) Only module names that are importable (i.e. are valid +Python identifiers) will be loaded.

    +

    All test modules must be importable from the top level of the project. If +the start directory is not the top level directory then the top level +directory must be specified separately.

    +

    If importing a module fails, for example due to a syntax error, then +this will be recorded as a single error and discovery will continue. If +the import failure is due to SkipTest being raised, it will be +recorded as a skip instead of an error.

    +

    If a package (a directory containing a file named __init__.py) is +found, the package will be checked for a load_tests function. If this +exists then it will be called +package.load_tests(loader, tests, pattern). Test discovery takes care +to ensure that a package is only checked for tests once during an +invocation, even if the load_tests function itself calls +loader.discover.

    +

    If load_tests exists then discovery does not recurse into the +package, load_tests is responsible for loading all tests in the +package.

    +

    The pattern is deliberately not stored as a loader attribute so that +packages can continue discovery themselves. top_level_dir is stored so +load_tests does not need to pass this argument in to +loader.discover().

    +

    start_dir can be a dotted module name as well as a directory.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.4: Modules that raise SkipTest on import are recorded as skips, + not errors. +Discovery works for namespace packages. +Paths are sorted before being imported so that execution order is + the same even if the underlying file system’s ordering is not + dependent on file name.

    +
    +
    +

    Changed in version 3.5: Found packages are now checked for load_tests regardless of +whether their path matches pattern, because it is impossible for +a package name to match the default pattern.

    +
    +
    + +

    The following attributes of a TestLoader can be configured either by +subclassing or assignment on an instance:

    +
    +
    +testMethodPrefix
    +

    String giving the prefix of method names which will be interpreted as test +methods. The default value is 'test'.

    +

    This affects getTestCaseNames() and all the loadTestsFrom*() +methods.

    +
    + +
    +
    +sortTestMethodsUsing
    +

    Function to be used to compare method names when sorting them in +getTestCaseNames() and all the loadTestsFrom*() methods.

    +
    + +
    +
    +suiteClass
    +

    Callable object that constructs a test suite from a list of tests. No +methods on the resulting object are needed. The default value is the +TestSuite class.

    +

    This affects all the loadTestsFrom*() methods.

    +
    + +
    +
    +testNamePatterns
    +

    List of Unix shell-style wildcard test name patterns that test methods +have to match to be included in test suites (see -v option).

    +

    If this attribute is not None (the default), all test methods to be +included in test suites must match one of the patterns in this list. +Note that matches are always performed using fnmatch.fnmatchcase(), +so unlike patterns passed to the -v option, simple substring patterns +will have to be converted using * wildcards.

    +

    This affects all the loadTestsFrom*() methods.

    +
    +

    New in version 3.7.

    +
    +
    + +
    + +
    +
    +class unittest.TestResult
    +

    This class is used to compile information about which tests have succeeded +and which have failed.

    +

    A TestResult object stores the results of a set of tests. The +TestCase and TestSuite classes ensure that results are +properly recorded; test authors do not need to worry about recording the +outcome of tests.

    +

    Testing frameworks built on top of unittest may want access to the +TestResult object generated by running a set of tests for reporting +purposes; a TestResult instance is returned by the +TestRunner.run() method for this purpose.

    +

    TestResult instances have the following attributes that will be of +interest when inspecting the results of running a set of tests:

    +
    +
    +errors
    +

    A list containing 2-tuples of TestCase instances and strings +holding formatted tracebacks. Each tuple represents a test which raised an +unexpected exception.

    +
    + +
    +
    +failures
    +

    A list containing 2-tuples of TestCase instances and strings +holding formatted tracebacks. Each tuple represents a test where a failure +was explicitly signalled using the TestCase.assert*() methods.

    +
    + +
    +
    +skipped
    +

    A list containing 2-tuples of TestCase instances and strings +holding the reason for skipping the test.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +expectedFailures
    +

    A list containing 2-tuples of TestCase instances and strings +holding formatted tracebacks. Each tuple represents an expected failure +of the test case.

    +
    + +
    +
    +unexpectedSuccesses
    +

    A list containing TestCase instances that were marked as expected +failures, but succeeded.

    +
    + +
    +
    +shouldStop
    +

    Set to True when the execution of tests should stop by stop().

    +
    + +
    +
    +testsRun
    +

    The total number of tests run so far.

    +
    + +
    +
    +buffer
    +

    If set to true, sys.stdout and sys.stderr will be buffered in between +startTest() and stopTest() being called. Collected output will +only be echoed onto the real sys.stdout and sys.stderr if the test +fails or errors. Any output is also attached to the failure / error message.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +failfast
    +

    If set to true stop() will be called on the first failure or error, +halting the test run.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +tb_locals
    +

    If set to true then local variables will be shown in tracebacks.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +wasSuccessful()
    +

    Return True if all tests run so far have passed, otherwise returns +False.

    +
    +

    Changed in version 3.4: Returns False if there were any unexpectedSuccesses +from tests marked with the expectedFailure() decorator.

    +
    +
    + +
    +
    +stop()
    +

    This method can be called to signal that the set of tests being run should +be aborted by setting the shouldStop attribute to True. +TestRunner objects should respect this flag and return without +running any additional tests.

    +

    For example, this feature is used by the TextTestRunner class to +stop the test framework when the user signals an interrupt from the +keyboard. Interactive tools which provide TestRunner +implementations can use this in a similar manner.

    +
    + +

    The following methods of the TestResult class are used to maintain +the internal data structures, and may be extended in subclasses to support +additional reporting requirements. This is particularly useful in building +tools which support interactive reporting while tests are being run.

    +
    +
    +startTest(test)
    +

    Called when the test case test is about to be run.

    +
    + +
    +
    +stopTest(test)
    +

    Called after the test case test has been executed, regardless of the +outcome.

    +
    + +
    +
    +startTestRun()
    +

    Called once before any tests are executed.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +stopTestRun()
    +

    Called once after all tests are executed.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +addError(test, err)
    +

    Called when the test case test raises an unexpected exception. err is a +tuple of the form returned by sys.exc_info(): (type, value, +traceback).

    +

    The default implementation appends a tuple (test, formatted_err) to +the instance’s errors attribute, where formatted_err is a +formatted traceback derived from err.

    +
    + +
    +
    +addFailure(test, err)
    +

    Called when the test case test signals a failure. err is a tuple of +the form returned by sys.exc_info(): (type, value, traceback).

    +

    The default implementation appends a tuple (test, formatted_err) to +the instance’s failures attribute, where formatted_err is a +formatted traceback derived from err.

    +
    + +
    +
    +addSuccess(test)
    +

    Called when the test case test succeeds.

    +

    The default implementation does nothing.

    +
    + +
    +
    +addSkip(test, reason)
    +

    Called when the test case test is skipped. reason is the reason the +test gave for skipping.

    +

    The default implementation appends a tuple (test, reason) to the +instance’s skipped attribute.

    +
    + +
    +
    +addExpectedFailure(test, err)
    +

    Called when the test case test fails, but was marked with the +expectedFailure() decorator.

    +

    The default implementation appends a tuple (test, formatted_err) to +the instance’s expectedFailures attribute, where formatted_err +is a formatted traceback derived from err.

    +
    + +
    +
    +addUnexpectedSuccess(test)
    +

    Called when the test case test was marked with the +expectedFailure() decorator, but succeeded.

    +

    The default implementation appends the test to the instance’s +unexpectedSuccesses attribute.

    +
    + +
    +
    +addSubTest(test, subtest, outcome)
    +

    Called when a subtest finishes. test is the test case +corresponding to the test method. subtest is a custom +TestCase instance describing the subtest.

    +

    If outcome is None, the subtest succeeded. Otherwise, +it failed with an exception where outcome is a tuple of the form +returned by sys.exc_info(): (type, value, traceback).

    +

    The default implementation does nothing when the outcome is a +success, and records subtest failures as normal failures.

    +
    +

    New in version 3.4.

    +
    +
    + +
    + +
    +
    +class unittest.TextTestResult(stream, descriptions, verbosity)
    +

    A concrete implementation of TestResult used by the +TextTestRunner.

    +
    +

    New in version 3.2: This class was previously named _TextTestResult. The old name still +exists as an alias but is deprecated.

    +
    +
    + +
    +
    +unittest.defaultTestLoader
    +

    Instance of the TestLoader class intended to be shared. If no +customization of the TestLoader is needed, this instance can be used +instead of repeatedly creating new instances.

    +
    + +
    +
    +class unittest.TextTestRunner(stream=None, descriptions=True, verbosity=1, failfast=False, buffer=False, resultclass=None, warnings=None, *, tb_locals=False)
    +

    A basic test runner implementation that outputs results to a stream. If stream +is None, the default, sys.stderr is used as the output stream. This class +has a few configurable parameters, but is essentially very simple. Graphical +applications which run test suites should provide alternate implementations. Such +implementations should accept **kwargs as the interface to construct runners +changes when features are added to unittest.

    +

    By default this runner shows DeprecationWarning, +PendingDeprecationWarning, ResourceWarning and +ImportWarning even if they are ignored by default. Deprecation warnings caused by deprecated unittest +methods are also special-cased and, when the warning +filters are 'default' or 'always', they will appear only once +per-module, in order to avoid too many warning messages. This behavior can +be overridden using Python’s -Wd or -Wa options +(see Warning control) and leaving +warnings to None.

    +
    +

    Changed in version 3.2: Added the warnings argument.

    +
    +
    +

    Changed in version 3.2: The default stream is set to sys.stderr at instantiation time rather +than import time.

    +
    +
    +

    Changed in version 3.5: Added the tb_locals parameter.

    +
    +
    +
    +_makeResult()
    +

    This method returns the instance of TestResult used by run(). +It is not intended to be called directly, but can be overridden in +subclasses to provide a custom TestResult.

    +

    _makeResult() instantiates the class or callable passed in the +TextTestRunner constructor as the resultclass argument. It +defaults to TextTestResult if no resultclass is provided. +The result class is instantiated with the following arguments:

    +
    stream, descriptions, verbosity
    +
    +
    +
    + +
    +
    +run(test)
    +

    This method is the main public interface to the TextTestRunner. This +method takes a TestSuite or TestCase instance. A +TestResult is created by calling +_makeResult() and the test(s) are run and the +results printed to stdout.

    +
    + +
    + +
    +
    +unittest.main(module='__main__', defaultTest=None, argv=None, testRunner=None, testLoader=unittest.defaultTestLoader, exit=True, verbosity=1, failfast=None, catchbreak=None, buffer=None, warnings=None)
    +

    A command-line program that loads a set of tests from module and runs them; +this is primarily for making test modules conveniently executable. +The simplest use for this function is to include the following line at the +end of a test script:

    +
    if __name__ == '__main__':
    +    unittest.main()
    +
    +
    +

    You can run tests with more detailed information by passing in the verbosity +argument:

    +
    if __name__ == '__main__':
    +    unittest.main(verbosity=2)
    +
    +
    +

    The defaultTest argument is either the name of a single test or an +iterable of test names to run if no test names are specified via argv. If +not specified or None and no test names are provided via argv, all +tests found in module are run.

    +

    The argv argument can be a list of options passed to the program, with the +first element being the program name. If not specified or None, +the values of sys.argv are used.

    +

    The testRunner argument can either be a test runner class or an already +created instance of it. By default main calls sys.exit() with +an exit code indicating success or failure of the tests run.

    +

    The testLoader argument has to be a TestLoader instance, +and defaults to defaultTestLoader.

    +

    main supports being used from the interactive interpreter by passing in the +argument exit=False. This displays the result on standard output without +calling sys.exit():

    +
    >>> from unittest import main
    +>>> main(module='test_module', exit=False)
    +
    +
    +

    The failfast, catchbreak and buffer parameters have the same +effect as the same-name command-line options.

    +

    The warnings argument specifies the warning filter +that should be used while running the tests. If it’s not specified, it will +remain None if a -W option is passed to python +(see Warning control), +otherwise it will be set to 'default'.

    +

    Calling main actually returns an instance of the TestProgram class. +This stores the result of the tests run as the result attribute.

    +
    +

    Changed in version 3.1: The exit parameter was added.

    +
    +
    +

    Changed in version 3.2: The verbosity, failfast, catchbreak, buffer +and warnings parameters were added.

    +
    +
    +

    Changed in version 3.4: The defaultTest parameter was changed to also accept an iterable of +test names.

    +
    +
    + +
    +

    load_tests Protocol

    +
    +

    New in version 3.2.

    +
    +

    Modules or packages can customize how tests are loaded from them during normal +test runs or test discovery by implementing a function called load_tests.

    +

    If a test module defines load_tests it will be called by +TestLoader.loadTestsFromModule() with the following arguments:

    +
    load_tests(loader, standard_tests, pattern)
    +
    +
    +

    where pattern is passed straight through from loadTestsFromModule. It +defaults to None.

    +

    It should return a TestSuite.

    +

    loader is the instance of TestLoader doing the loading. +standard_tests are the tests that would be loaded by default from the +module. It is common for test modules to only want to add or remove tests +from the standard set of tests. +The third argument is used when loading packages as part of test discovery.

    +

    A typical load_tests function that loads tests from a specific set of +TestCase classes may look like:

    +
    test_cases = (TestCase1, TestCase2, TestCase3)
    +
    +def load_tests(loader, tests, pattern):
    +    suite = TestSuite()
    +    for test_class in test_cases:
    +        tests = loader.loadTestsFromTestCase(test_class)
    +        suite.addTests(tests)
    +    return suite
    +
    +
    +

    If discovery is started in a directory containing a package, either from the +command line or by calling TestLoader.discover(), then the package +__init__.py will be checked for load_tests. If that function does +not exist, discovery will recurse into the package as though it were just +another directory. Otherwise, discovery of the package’s tests will be left up +to load_tests which is called with the following arguments:

    +
    load_tests(loader, standard_tests, pattern)
    +
    +
    +

    This should return a TestSuite representing all the tests +from the package. (standard_tests will only contain tests +collected from __init__.py.)

    +

    Because the pattern is passed into load_tests the package is free to +continue (and potentially modify) test discovery. A ‘do nothing’ +load_tests function for a test package would look like:

    +
    def load_tests(loader, standard_tests, pattern):
    +    # top level directory cached on loader instance
    +    this_dir = os.path.dirname(__file__)
    +    package_tests = loader.discover(start_dir=this_dir, pattern=pattern)
    +    standard_tests.addTests(package_tests)
    +    return standard_tests
    +
    +
    +
    +

    Changed in version 3.5: Discovery no longer checks package names for matching pattern due to the +impossibility of package names matching the default pattern.

    +
    +
    +
    +
    +
    +

    Class and Module Fixtures

    +

    Class and module level fixtures are implemented in TestSuite. When +the test suite encounters a test from a new class then tearDownClass() +from the previous class (if there is one) is called, followed by +setUpClass() from the new class.

    +

    Similarly if a test is from a different module from the previous test then +tearDownModule from the previous module is run, followed by +setUpModule from the new module.

    +

    After all the tests have run the final tearDownClass and +tearDownModule are run.

    +

    Note that shared fixtures do not play well with [potential] features like test +parallelization and they break test isolation. They should be used with care.

    +

    The default ordering of tests created by the unittest test loaders is to group +all tests from the same modules and classes together. This will lead to +setUpClass / setUpModule (etc) being called exactly once per class and +module. If you randomize the order, so that tests from different modules and +classes are adjacent to each other, then these shared fixture functions may be +called multiple times in a single test run.

    +

    Shared fixtures are not intended to work with suites with non-standard +ordering. A BaseTestSuite still exists for frameworks that don’t want to +support shared fixtures.

    +

    If there are any exceptions raised during one of the shared fixture functions +the test is reported as an error. Because there is no corresponding test +instance an _ErrorHolder object (that has the same interface as a +TestCase) is created to represent the error. If you are just using +the standard unittest test runner then this detail doesn’t matter, but if you +are a framework author it may be relevant.

    +
    +

    setUpClass and tearDownClass

    +

    These must be implemented as class methods:

    +
    import unittest
    +
    +class Test(unittest.TestCase):
    +    @classmethod
    +    def setUpClass(cls):
    +        cls._connection = createExpensiveConnectionObject()
    +
    +    @classmethod
    +    def tearDownClass(cls):
    +        cls._connection.destroy()
    +
    +
    +

    If you want the setUpClass and tearDownClass on base classes called +then you must call up to them yourself. The implementations in +TestCase are empty.

    +

    If an exception is raised during a setUpClass then the tests in the class +are not run and the tearDownClass is not run. Skipped classes will not +have setUpClass or tearDownClass run. If the exception is a +SkipTest exception then the class will be reported as having been skipped +instead of as an error.

    +
    +
    +

    setUpModule and tearDownModule

    +

    These should be implemented as functions:

    +
    def setUpModule():
    +    createConnection()
    +
    +def tearDownModule():
    +    closeConnection()
    +
    +
    +

    If an exception is raised in a setUpModule then none of the tests in the +module will be run and the tearDownModule will not be run. If the exception is a +SkipTest exception then the module will be reported as having been skipped +instead of as an error.

    +
    +
    +
    +

    Signal Handling

    +
    +

    New in version 3.2.

    +
    +

    The -c/--catch command-line option to unittest, +along with the catchbreak parameter to unittest.main(), provide +more friendly handling of control-C during a test run. With catch break +behavior enabled control-C will allow the currently running test to complete, +and the test run will then end and report all the results so far. A second +control-c will raise a KeyboardInterrupt in the usual way.

    +

    The control-c handling signal handler attempts to remain compatible with code or +tests that install their own signal.SIGINT handler. If the unittest +handler is called but isn’t the installed signal.SIGINT handler, +i.e. it has been replaced by the system under test and delegated to, then it +calls the default handler. This will normally be the expected behavior by code +that replaces an installed handler and delegates to it. For individual tests +that need unittest control-c handling disabled the removeHandler() +decorator can be used.

    +

    There are a few utility functions for framework authors to enable control-c +handling functionality within test frameworks.

    +
    +
    +unittest.installHandler()
    +

    Install the control-c handler. When a signal.SIGINT is received +(usually in response to the user pressing control-c) all registered results +have stop() called.

    +
    + +
    +
    +unittest.registerResult(result)
    +

    Register a TestResult object for control-c handling. Registering a +result stores a weak reference to it, so it doesn’t prevent the result from +being garbage collected.

    +

    Registering a TestResult object has no side-effects if control-c +handling is not enabled, so test frameworks can unconditionally register +all results they create independently of whether or not handling is enabled.

    +
    + +
    +
    +unittest.removeResult(result)
    +

    Remove a registered result. Once a result has been removed then +stop() will no longer be called on that result object in +response to a control-c.

    +
    + +
    +
    +unittest.removeHandler(function=None)
    +

    When called without arguments this function removes the control-c handler +if it has been installed. This function can also be used as a test decorator +to temporarily remove the handler while the test is being executed:

    +
    @unittest.removeHandler
    +def test_signal_handling(self):
    +    ...
    +
    +
    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/unittest.mock-examples.html b/python-3.7.4-docs-html/library/unittest.mock-examples.html new file mode 100644 index 0000000..f189e29 --- /dev/null +++ b/python-3.7.4-docs-html/library/unittest.mock-examples.html @@ -0,0 +1,1399 @@ + + + + + + + unittest.mock — getting started — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    unittest.mock — getting started

    +
    +

    New in version 3.3.

    +
    +
    +

    Using Mock

    +
    +

    Mock Patching Methods

    +

    Common uses for Mock objects include:

    +
      +
    • Patching methods

    • +
    • Recording method calls on objects

    • +
    +

    You might want to replace a method on an object to check that +it is called with the correct arguments by another part of the system:

    +
    >>> real = SomeClass()
    +>>> real.method = MagicMock(name='method')
    +>>> real.method(3, 4, 5, key='value')
    +<MagicMock name='method()' id='...'>
    +
    +
    +

    Once our mock has been used (real.method in this example) it has methods +and attributes that allow you to make assertions about how it has been used.

    +
    +

    Note

    +

    In most of these examples the Mock and MagicMock classes +are interchangeable. As the MagicMock is the more capable class it makes +a sensible one to use by default.

    +
    +

    Once the mock has been called its called attribute is set to +True. More importantly we can use the assert_called_with() or +assert_called_once_with() method to check that it was called with +the correct arguments.

    +

    This example tests that calling ProductionClass().method results in a call to +the something method:

    +
    >>> class ProductionClass:
    +...     def method(self):
    +...         self.something(1, 2, 3)
    +...     def something(self, a, b, c):
    +...         pass
    +...
    +>>> real = ProductionClass()
    +>>> real.something = MagicMock()
    +>>> real.method()
    +>>> real.something.assert_called_once_with(1, 2, 3)
    +
    +
    +
    +
    +

    Mock for Method Calls on an Object

    +

    In the last example we patched a method directly on an object to check that it +was called correctly. Another common use case is to pass an object into a +method (or some part of the system under test) and then check that it is used +in the correct way.

    +

    The simple ProductionClass below has a closer method. If it is called with +an object then it calls close on it.

    +
    >>> class ProductionClass:
    +...     def closer(self, something):
    +...         something.close()
    +...
    +
    +
    +

    So to test it we need to pass in an object with a close method and check +that it was called correctly.

    +
    >>> real = ProductionClass()
    +>>> mock = Mock()
    +>>> real.closer(mock)
    +>>> mock.close.assert_called_with()
    +
    +
    +

    We don’t have to do any work to provide the ‘close’ method on our mock. +Accessing close creates it. So, if ‘close’ hasn’t already been called then +accessing it in the test will create it, but assert_called_with() +will raise a failure exception.

    +
    +
    +

    Mocking Classes

    +

    A common use case is to mock out classes instantiated by your code under test. +When you patch a class, then that class is replaced with a mock. Instances +are created by calling the class. This means you access the “mock instance” +by looking at the return value of the mocked class.

    +

    In the example below we have a function some_function that instantiates Foo +and calls a method on it. The call to patch() replaces the class Foo with a +mock. The Foo instance is the result of calling the mock, so it is configured +by modifying the mock return_value.

    +
    >>> def some_function():
    +...     instance = module.Foo()
    +...     return instance.method()
    +...
    +>>> with patch('module.Foo') as mock:
    +...     instance = mock.return_value
    +...     instance.method.return_value = 'the result'
    +...     result = some_function()
    +...     assert result == 'the result'
    +
    +
    +
    +
    +

    Naming your mocks

    +

    It can be useful to give your mocks a name. The name is shown in the repr of +the mock and can be helpful when the mock appears in test failure messages. The +name is also propagated to attributes or methods of the mock:

    +
    >>> mock = MagicMock(name='foo')
    +>>> mock
    +<MagicMock name='foo' id='...'>
    +>>> mock.method
    +<MagicMock name='foo.method' id='...'>
    +
    +
    +
    +
    +

    Tracking all Calls

    +

    Often you want to track more than a single call to a method. The +mock_calls attribute records all calls +to child attributes of the mock - and also to their children.

    +
    >>> mock = MagicMock()
    +>>> mock.method()
    +<MagicMock name='mock.method()' id='...'>
    +>>> mock.attribute.method(10, x=53)
    +<MagicMock name='mock.attribute.method()' id='...'>
    +>>> mock.mock_calls
    +[call.method(), call.attribute.method(10, x=53)]
    +
    +
    +

    If you make an assertion about mock_calls and any unexpected methods +have been called, then the assertion will fail. This is useful because as well +as asserting that the calls you expected have been made, you are also checking +that they were made in the right order and with no additional calls:

    +

    You use the call object to construct lists for comparing with +mock_calls:

    +
    >>> expected = [call.method(), call.attribute.method(10, x=53)]
    +>>> mock.mock_calls == expected
    +True
    +
    +
    +

    However, parameters to calls that return mocks are not recorded, which means it is not +possible to track nested calls where the parameters used to create ancestors are important:

    +
    >>> m = Mock()
    +>>> m.factory(important=True).deliver()
    +<Mock name='mock.factory().deliver()' id='...'>
    +>>> m.mock_calls[-1] == call.factory(important=False).deliver()
    +True
    +
    +
    +
    +
    +

    Setting Return Values and Attributes

    +

    Setting the return values on a mock object is trivially easy:

    +
    >>> mock = Mock()
    +>>> mock.return_value = 3
    +>>> mock()
    +3
    +
    +
    +

    Of course you can do the same for methods on the mock:

    +
    >>> mock = Mock()
    +>>> mock.method.return_value = 3
    +>>> mock.method()
    +3
    +
    +
    +

    The return value can also be set in the constructor:

    +
    >>> mock = Mock(return_value=3)
    +>>> mock()
    +3
    +
    +
    +

    If you need an attribute setting on your mock, just do it:

    +
    >>> mock = Mock()
    +>>> mock.x = 3
    +>>> mock.x
    +3
    +
    +
    +

    Sometimes you want to mock up a more complex situation, like for example +mock.connection.cursor().execute("SELECT 1"). If we wanted this call to +return a list, then we have to configure the result of the nested call.

    +

    We can use call to construct the set of calls in a “chained call” like +this for easy assertion afterwards:

    +
    >>> mock = Mock()
    +>>> cursor = mock.connection.cursor.return_value
    +>>> cursor.execute.return_value = ['foo']
    +>>> mock.connection.cursor().execute("SELECT 1")
    +['foo']
    +>>> expected = call.connection.cursor().execute("SELECT 1").call_list()
    +>>> mock.mock_calls
    +[call.connection.cursor(), call.connection.cursor().execute('SELECT 1')]
    +>>> mock.mock_calls == expected
    +True
    +
    +
    +

    It is the call to .call_list() that turns our call object into a list of +calls representing the chained calls.

    +
    +
    +

    Raising exceptions with mocks

    +

    A useful attribute is side_effect. If you set this to an +exception class or instance then the exception will be raised when the mock +is called.

    +
    >>> mock = Mock(side_effect=Exception('Boom!'))
    +>>> mock()
    +Traceback (most recent call last):
    +  ...
    +Exception: Boom!
    +
    +
    +
    +
    +

    Side effect functions and iterables

    +

    side_effect can also be set to a function or an iterable. The use case for +side_effect as an iterable is where your mock is going to be called several +times, and you want each call to return a different value. When you set +side_effect to an iterable every call to the mock returns the next value +from the iterable:

    +
    >>> mock = MagicMock(side_effect=[4, 5, 6])
    +>>> mock()
    +4
    +>>> mock()
    +5
    +>>> mock()
    +6
    +
    +
    +

    For more advanced use cases, like dynamically varying the return values +depending on what the mock is called with, side_effect can be a function. +The function will be called with the same arguments as the mock. Whatever the +function returns is what the call returns:

    +
    >>> vals = {(1, 2): 1, (2, 3): 2}
    +>>> def side_effect(*args):
    +...     return vals[args]
    +...
    +>>> mock = MagicMock(side_effect=side_effect)
    +>>> mock(1, 2)
    +1
    +>>> mock(2, 3)
    +2
    +
    +
    +
    +
    +

    Creating a Mock from an Existing Object

    +

    One problem with over use of mocking is that it couples your tests to the +implementation of your mocks rather than your real code. Suppose you have a +class that implements some_method. In a test for another class, you +provide a mock of this object that also provides some_method. If later +you refactor the first class, so that it no longer has some_method - then +your tests will continue to pass even though your code is now broken!

    +

    Mock allows you to provide an object as a specification for the mock, +using the spec keyword argument. Accessing methods / attributes on the +mock that don’t exist on your specification object will immediately raise an +attribute error. If you change the implementation of your specification, then +tests that use that class will start failing immediately without you having to +instantiate the class in those tests.

    +
    >>> mock = Mock(spec=SomeClass)
    +>>> mock.old_method()
    +Traceback (most recent call last):
    +   ...
    +AttributeError: object has no attribute 'old_method'
    +
    +
    +

    Using a specification also enables a smarter matching of calls made to the +mock, regardless of whether some parameters were passed as positional or +named arguments:

    +
    >>> def f(a, b, c): pass
    +...
    +>>> mock = Mock(spec=f)
    +>>> mock(1, 2, 3)
    +<Mock name='mock()' id='140161580456576'>
    +>>> mock.assert_called_with(a=1, b=2, c=3)
    +
    +
    +

    If you want this smarter matching to also work with method calls on the mock, +you can use auto-speccing.

    +

    If you want a stronger form of specification that prevents the setting +of arbitrary attributes as well as the getting of them then you can use +spec_set instead of spec.

    +
    +
    +
    +

    Patch Decorators

    +
    +

    Note

    +

    With patch() it matters that you patch objects in the namespace where +they are looked up. This is normally straightforward, but for a quick guide +read where to patch.

    +
    +

    A common need in tests is to patch a class attribute or a module attribute, +for example patching a builtin or patching a class in a module to test that it +is instantiated. Modules and classes are effectively global, so patching on +them has to be undone after the test or the patch will persist into other +tests and cause hard to diagnose problems.

    +

    mock provides three convenient decorators for this: patch(), patch.object() and +patch.dict(). patch takes a single string, of the form +package.module.Class.attribute to specify the attribute you are patching. It +also optionally takes a value that you want the attribute (or class or +whatever) to be replaced with. ‘patch.object’ takes an object and the name of +the attribute you would like patched, plus optionally the value to patch it +with.

    +

    patch.object:

    +
    >>> original = SomeClass.attribute
    +>>> @patch.object(SomeClass, 'attribute', sentinel.attribute)
    +... def test():
    +...     assert SomeClass.attribute == sentinel.attribute
    +...
    +>>> test()
    +>>> assert SomeClass.attribute == original
    +
    +
    +
    >>> @patch('package.module.attribute', sentinel.attribute)
    +... def test():
    +...     from package.module import attribute
    +...     assert attribute is sentinel.attribute
    +...
    +>>> test()
    +
    +
    +

    If you are patching a module (including builtins) then use patch() +instead of patch.object():

    +
    >>> mock = MagicMock(return_value=sentinel.file_handle)
    +>>> with patch('builtins.open', mock):
    +...     handle = open('filename', 'r')
    +...
    +>>> mock.assert_called_with('filename', 'r')
    +>>> assert handle == sentinel.file_handle, "incorrect file handle returned"
    +
    +
    +

    The module name can be ‘dotted’, in the form package.module if needed:

    +
    >>> @patch('package.module.ClassName.attribute', sentinel.attribute)
    +... def test():
    +...     from package.module import ClassName
    +...     assert ClassName.attribute == sentinel.attribute
    +...
    +>>> test()
    +
    +
    +

    A nice pattern is to actually decorate test methods themselves:

    +
    >>> class MyTest(unittest.TestCase):
    +...     @patch.object(SomeClass, 'attribute', sentinel.attribute)
    +...     def test_something(self):
    +...         self.assertEqual(SomeClass.attribute, sentinel.attribute)
    +...
    +>>> original = SomeClass.attribute
    +>>> MyTest('test_something').test_something()
    +>>> assert SomeClass.attribute == original
    +
    +
    +

    If you want to patch with a Mock, you can use patch() with only one argument +(or patch.object() with two arguments). The mock will be created for you and +passed into the test function / method:

    +
    >>> class MyTest(unittest.TestCase):
    +...     @patch.object(SomeClass, 'static_method')
    +...     def test_something(self, mock_method):
    +...         SomeClass.static_method()
    +...         mock_method.assert_called_with()
    +...
    +>>> MyTest('test_something').test_something()
    +
    +
    +

    You can stack up multiple patch decorators using this pattern:

    +
    >>> class MyTest(unittest.TestCase):
    +...     @patch('package.module.ClassName1')
    +...     @patch('package.module.ClassName2')
    +...     def test_something(self, MockClass2, MockClass1):
    +...         self.assertIs(package.module.ClassName1, MockClass1)
    +...         self.assertIs(package.module.ClassName2, MockClass2)
    +...
    +>>> MyTest('test_something').test_something()
    +
    +
    +

    When you nest patch decorators the mocks are passed in to the decorated +function in the same order they applied (the normal Python order that +decorators are applied). This means from the bottom up, so in the example +above the mock for test_module.ClassName2 is passed in first.

    +

    There is also patch.dict() for setting values in a dictionary just +during a scope and restoring the dictionary to its original state when the test +ends:

    +
    >>> foo = {'key': 'value'}
    +>>> original = foo.copy()
    +>>> with patch.dict(foo, {'newkey': 'newvalue'}, clear=True):
    +...     assert foo == {'newkey': 'newvalue'}
    +...
    +>>> assert foo == original
    +
    +
    +

    patch, patch.object and patch.dict can all be used as context managers.

    +

    Where you use patch() to create a mock for you, you can get a reference to the +mock using the “as” form of the with statement:

    +
    >>> class ProductionClass:
    +...     def method(self):
    +...         pass
    +...
    +>>> with patch.object(ProductionClass, 'method') as mock_method:
    +...     mock_method.return_value = None
    +...     real = ProductionClass()
    +...     real.method(1, 2, 3)
    +...
    +>>> mock_method.assert_called_with(1, 2, 3)
    +
    +
    +

    As an alternative patch, patch.object and patch.dict can be used as +class decorators. When used in this way it is the same as applying the +decorator individually to every method whose name starts with “test”.

    +
    +
    +

    Further Examples

    +

    Here are some more examples for some slightly more advanced scenarios.

    +
    +

    Mocking chained calls

    +

    Mocking chained calls is actually straightforward with mock once you +understand the return_value attribute. When a mock is called for +the first time, or you fetch its return_value before it has been called, a +new Mock is created.

    +

    This means that you can see how the object returned from a call to a mocked +object has been used by interrogating the return_value mock:

    +
    >>> mock = Mock()
    +>>> mock().foo(a=2, b=3)
    +<Mock name='mock().foo()' id='...'>
    +>>> mock.return_value.foo.assert_called_with(a=2, b=3)
    +
    +
    +

    From here it is a simple step to configure and then make assertions about +chained calls. Of course another alternative is writing your code in a more +testable way in the first place…

    +

    So, suppose we have some code that looks a little bit like this:

    +
    >>> class Something:
    +...     def __init__(self):
    +...         self.backend = BackendProvider()
    +...     def method(self):
    +...         response = self.backend.get_endpoint('foobar').create_call('spam', 'eggs').start_call()
    +...         # more code
    +
    +
    +

    Assuming that BackendProvider is already well tested, how do we test +method()? Specifically, we want to test that the code section # more +code uses the response object in the correct way.

    +

    As this chain of calls is made from an instance attribute we can monkey patch +the backend attribute on a Something instance. In this particular case +we are only interested in the return value from the final call to +start_call so we don’t have much configuration to do. Let’s assume the +object it returns is ‘file-like’, so we’ll ensure that our response object +uses the builtin open() as its spec.

    +

    To do this we create a mock instance as our mock backend and create a mock +response object for it. To set the response as the return value for that final +start_call we could do this:

    +
    mock_backend.get_endpoint.return_value.create_call.return_value.start_call.return_value = mock_response
    +
    +
    +

    We can do that in a slightly nicer way using the configure_mock() +method to directly set the return value for us:

    +
    >>> something = Something()
    +>>> mock_response = Mock(spec=open)
    +>>> mock_backend = Mock()
    +>>> config = {'get_endpoint.return_value.create_call.return_value.start_call.return_value': mock_response}
    +>>> mock_backend.configure_mock(**config)
    +
    +
    +

    With these we monkey patch the “mock backend” in place and can make the real +call:

    +
    >>> something.backend = mock_backend
    +>>> something.method()
    +
    +
    +

    Using mock_calls we can check the chained call with a single +assert. A chained call is several calls in one line of code, so there will be +several entries in mock_calls. We can use call.call_list() to create +this list of calls for us:

    +
    >>> chained = call.get_endpoint('foobar').create_call('spam', 'eggs').start_call()
    +>>> call_list = chained.call_list()
    +>>> assert mock_backend.mock_calls == call_list
    +
    +
    +
    +
    +

    Partial mocking

    +

    In some tests I wanted to mock out a call to datetime.date.today() +to return a known date, but I didn’t want to prevent the code under test from +creating new date objects. Unfortunately datetime.date is written in C, and +so I couldn’t just monkey-patch out the static date.today() method.

    +

    I found a simple way of doing this that involved effectively wrapping the date +class with a mock, but passing through calls to the constructor to the real +class (and returning real instances).

    +

    The patch decorator is used here to +mock out the date class in the module under test. The side_effect +attribute on the mock date class is then set to a lambda function that returns +a real date. When the mock date class is called a real date will be +constructed and returned by side_effect.

    +
    >>> from datetime import date
    +>>> with patch('mymodule.date') as mock_date:
    +...     mock_date.today.return_value = date(2010, 10, 8)
    +...     mock_date.side_effect = lambda *args, **kw: date(*args, **kw)
    +...
    +...     assert mymodule.date.today() == date(2010, 10, 8)
    +...     assert mymodule.date(2009, 6, 8) == date(2009, 6, 8)
    +...
    +
    +
    +

    Note that we don’t patch datetime.date globally, we patch date in the +module that uses it. See where to patch.

    +

    When date.today() is called a known date is returned, but calls to the +date(...) constructor still return normal dates. Without this you can find +yourself having to calculate an expected result using exactly the same +algorithm as the code under test, which is a classic testing anti-pattern.

    +

    Calls to the date constructor are recorded in the mock_date attributes +(call_count and friends) which may also be useful for your tests.

    +

    An alternative way of dealing with mocking dates, or other builtin classes, +is discussed in this blog entry.

    +
    +
    +

    Mocking a Generator Method

    +

    A Python generator is a function or method that uses the yield statement +to return a series of values when iterated over 1.

    +

    A generator method / function is called to return the generator object. It is +the generator object that is then iterated over. The protocol method for +iteration is __iter__(), so we can +mock this using a MagicMock.

    +

    Here’s an example class with an “iter” method implemented as a generator:

    +
    >>> class Foo:
    +...     def iter(self):
    +...         for i in [1, 2, 3]:
    +...             yield i
    +...
    +>>> foo = Foo()
    +>>> list(foo.iter())
    +[1, 2, 3]
    +
    +
    +

    How would we mock this class, and in particular its “iter” method?

    +

    To configure the values returned from the iteration (implicit in the call to +list), we need to configure the object returned by the call to foo.iter().

    +
    >>> mock_foo = MagicMock()
    +>>> mock_foo.iter.return_value = iter([1, 2, 3])
    +>>> list(mock_foo.iter())
    +[1, 2, 3]
    +
    +
    +
    +
    1
    +

    There are also generator expressions and more advanced uses of generators, but we aren’t +concerned about them here. A very good introduction to generators and how +powerful they are is: Generator Tricks for Systems Programmers.

    +
    +
    +
    +
    +

    Applying the same patch to every test method

    +

    If you want several patches in place for multiple test methods the obvious way +is to apply the patch decorators to every method. This can feel like unnecessary +repetition. For Python 2.6 or more recent you can use patch() (in all its +various forms) as a class decorator. This applies the patches to all test +methods on the class. A test method is identified by methods whose names start +with test:

    +
    >>> @patch('mymodule.SomeClass')
    +... class MyTest(TestCase):
    +...
    +...     def test_one(self, MockSomeClass):
    +...         self.assertIs(mymodule.SomeClass, MockSomeClass)
    +...
    +...     def test_two(self, MockSomeClass):
    +...         self.assertIs(mymodule.SomeClass, MockSomeClass)
    +...
    +...     def not_a_test(self):
    +...         return 'something'
    +...
    +>>> MyTest('test_one').test_one()
    +>>> MyTest('test_two').test_two()
    +>>> MyTest('test_two').not_a_test()
    +'something'
    +
    +
    +

    An alternative way of managing patches is to use the patch methods: start and stop. +These allow you to move the patching into your setUp and tearDown methods.

    +
    >>> class MyTest(TestCase):
    +...     def setUp(self):
    +...         self.patcher = patch('mymodule.foo')
    +...         self.mock_foo = self.patcher.start()
    +...
    +...     def test_foo(self):
    +...         self.assertIs(mymodule.foo, self.mock_foo)
    +...
    +...     def tearDown(self):
    +...         self.patcher.stop()
    +...
    +>>> MyTest('test_foo').run()
    +
    +
    +

    If you use this technique you must ensure that the patching is “undone” by +calling stop. This can be fiddlier than you might think, because if an +exception is raised in the setUp then tearDown is not called. +unittest.TestCase.addCleanup() makes this easier:

    +
    >>> class MyTest(TestCase):
    +...     def setUp(self):
    +...         patcher = patch('mymodule.foo')
    +...         self.addCleanup(patcher.stop)
    +...         self.mock_foo = patcher.start()
    +...
    +...     def test_foo(self):
    +...         self.assertIs(mymodule.foo, self.mock_foo)
    +...
    +>>> MyTest('test_foo').run()
    +
    +
    +
    +
    +

    Mocking Unbound Methods

    +

    Whilst writing tests today I needed to patch an unbound method (patching the +method on the class rather than on the instance). I needed self to be passed +in as the first argument because I want to make asserts about which objects +were calling this particular method. The issue is that you can’t patch with a +mock for this, because if you replace an unbound method with a mock it doesn’t +become a bound method when fetched from the instance, and so it doesn’t get +self passed in. The workaround is to patch the unbound method with a real +function instead. The patch() decorator makes it so simple to +patch out methods with a mock that having to create a real function becomes a +nuisance.

    +

    If you pass autospec=True to patch then it does the patching with a +real function object. This function object has the same signature as the one +it is replacing, but delegates to a mock under the hood. You still get your +mock auto-created in exactly the same way as before. What it means though, is +that if you use it to patch out an unbound method on a class the mocked +function will be turned into a bound method if it is fetched from an instance. +It will have self passed in as the first argument, which is exactly what I +wanted:

    +
    >>> class Foo:
    +...   def foo(self):
    +...     pass
    +...
    +>>> with patch.object(Foo, 'foo', autospec=True) as mock_foo:
    +...   mock_foo.return_value = 'foo'
    +...   foo = Foo()
    +...   foo.foo()
    +...
    +'foo'
    +>>> mock_foo.assert_called_once_with(foo)
    +
    +
    +

    If we don’t use autospec=True then the unbound method is patched out +with a Mock instance instead, and isn’t called with self.

    +
    +
    +

    Checking multiple calls with mock

    +

    mock has a nice API for making assertions about how your mock objects are used.

    +
    >>> mock = Mock()
    +>>> mock.foo_bar.return_value = None
    +>>> mock.foo_bar('baz', spam='eggs')
    +>>> mock.foo_bar.assert_called_with('baz', spam='eggs')
    +
    +
    +

    If your mock is only being called once you can use the +assert_called_once_with() method that also asserts that the +call_count is one.

    +
    >>> mock.foo_bar.assert_called_once_with('baz', spam='eggs')
    +>>> mock.foo_bar()
    +>>> mock.foo_bar.assert_called_once_with('baz', spam='eggs')
    +Traceback (most recent call last):
    +    ...
    +AssertionError: Expected to be called once. Called 2 times.
    +
    +
    +

    Both assert_called_with and assert_called_once_with make assertions about +the most recent call. If your mock is going to be called several times, and +you want to make assertions about all those calls you can use +call_args_list:

    +
    >>> mock = Mock(return_value=None)
    +>>> mock(1, 2, 3)
    +>>> mock(4, 5, 6)
    +>>> mock()
    +>>> mock.call_args_list
    +[call(1, 2, 3), call(4, 5, 6), call()]
    +
    +
    +

    The call helper makes it easy to make assertions about these calls. You +can build up a list of expected calls and compare it to call_args_list. This +looks remarkably similar to the repr of the call_args_list:

    +
    >>> expected = [call(1, 2, 3), call(4, 5, 6), call()]
    +>>> mock.call_args_list == expected
    +True
    +
    +
    +
    +
    +

    Coping with mutable arguments

    +

    Another situation is rare, but can bite you, is when your mock is called with +mutable arguments. call_args and call_args_list store references to the +arguments. If the arguments are mutated by the code under test then you can no +longer make assertions about what the values were when the mock was called.

    +

    Here’s some example code that shows the problem. Imagine the following functions +defined in ‘mymodule’:

    +
    def frob(val):
    +    pass
    +
    +def grob(val):
    +    "First frob and then clear val"
    +    frob(val)
    +    val.clear()
    +
    +
    +

    When we try to test that grob calls frob with the correct argument look +what happens:

    +
    >>> with patch('mymodule.frob') as mock_frob:
    +...     val = {6}
    +...     mymodule.grob(val)
    +...
    +>>> val
    +set()
    +>>> mock_frob.assert_called_with({6})
    +Traceback (most recent call last):
    +    ...
    +AssertionError: Expected: (({6},), {})
    +Called with: ((set(),), {})
    +
    +
    +

    One possibility would be for mock to copy the arguments you pass in. This +could then cause problems if you do assertions that rely on object identity +for equality.

    +

    Here’s one solution that uses the side_effect +functionality. If you provide a side_effect function for a mock then +side_effect will be called with the same args as the mock. This gives us an +opportunity to copy the arguments and store them for later assertions. In this +example I’m using another mock to store the arguments so that I can use the +mock methods for doing the assertion. Again a helper function sets this up for +me.

    +
    >>> from copy import deepcopy
    +>>> from unittest.mock import Mock, patch, DEFAULT
    +>>> def copy_call_args(mock):
    +...     new_mock = Mock()
    +...     def side_effect(*args, **kwargs):
    +...         args = deepcopy(args)
    +...         kwargs = deepcopy(kwargs)
    +...         new_mock(*args, **kwargs)
    +...         return DEFAULT
    +...     mock.side_effect = side_effect
    +...     return new_mock
    +...
    +>>> with patch('mymodule.frob') as mock_frob:
    +...     new_mock = copy_call_args(mock_frob)
    +...     val = {6}
    +...     mymodule.grob(val)
    +...
    +>>> new_mock.assert_called_with({6})
    +>>> new_mock.call_args
    +call({6})
    +
    +
    +

    copy_call_args is called with the mock that will be called. It returns a new +mock that we do the assertion on. The side_effect function makes a copy of +the args and calls our new_mock with the copy.

    +
    +

    Note

    +

    If your mock is only going to be used once there is an easier way of +checking arguments at the point they are called. You can simply do the +checking inside a side_effect function.

    +
    >>> def side_effect(arg):
    +...     assert arg == {6}
    +...
    +>>> mock = Mock(side_effect=side_effect)
    +>>> mock({6})
    +>>> mock(set())
    +Traceback (most recent call last):
    +    ...
    +AssertionError
    +
    +
    +
    +

    An alternative approach is to create a subclass of Mock or +MagicMock that copies (using copy.deepcopy()) the arguments. +Here’s an example implementation:

    +
    >>> from copy import deepcopy
    +>>> class CopyingMock(MagicMock):
    +...     def __call__(self, *args, **kwargs):
    +...         args = deepcopy(args)
    +...         kwargs = deepcopy(kwargs)
    +...         return super(CopyingMock, self).__call__(*args, **kwargs)
    +...
    +>>> c = CopyingMock(return_value=None)
    +>>> arg = set()
    +>>> c(arg)
    +>>> arg.add(1)
    +>>> c.assert_called_with(set())
    +>>> c.assert_called_with(arg)
    +Traceback (most recent call last):
    +    ...
    +AssertionError: Expected call: mock({1})
    +Actual call: mock(set())
    +>>> c.foo
    +<CopyingMock name='mock.foo' id='...'>
    +
    +
    +

    When you subclass Mock or MagicMock all dynamically created attributes, +and the return_value will use your subclass automatically. That means all +children of a CopyingMock will also have the type CopyingMock.

    +
    +
    +

    Nesting Patches

    +

    Using patch as a context manager is nice, but if you do multiple patches you +can end up with nested with statements indenting further and further to the +right:

    +
    >>> class MyTest(TestCase):
    +...
    +...     def test_foo(self):
    +...         with patch('mymodule.Foo') as mock_foo:
    +...             with patch('mymodule.Bar') as mock_bar:
    +...                 with patch('mymodule.Spam') as mock_spam:
    +...                     assert mymodule.Foo is mock_foo
    +...                     assert mymodule.Bar is mock_bar
    +...                     assert mymodule.Spam is mock_spam
    +...
    +>>> original = mymodule.Foo
    +>>> MyTest('test_foo').test_foo()
    +>>> assert mymodule.Foo is original
    +
    +
    +

    With unittest cleanup functions and the patch methods: start and stop we can +achieve the same effect without the nested indentation. A simple helper +method, create_patch, puts the patch in place and returns the created mock +for us:

    +
    >>> class MyTest(TestCase):
    +...
    +...     def create_patch(self, name):
    +...         patcher = patch(name)
    +...         thing = patcher.start()
    +...         self.addCleanup(patcher.stop)
    +...         return thing
    +...
    +...     def test_foo(self):
    +...         mock_foo = self.create_patch('mymodule.Foo')
    +...         mock_bar = self.create_patch('mymodule.Bar')
    +...         mock_spam = self.create_patch('mymodule.Spam')
    +...
    +...         assert mymodule.Foo is mock_foo
    +...         assert mymodule.Bar is mock_bar
    +...         assert mymodule.Spam is mock_spam
    +...
    +>>> original = mymodule.Foo
    +>>> MyTest('test_foo').run()
    +>>> assert mymodule.Foo is original
    +
    +
    +
    +
    +

    Mocking a dictionary with MagicMock

    +

    You may want to mock a dictionary, or other container object, recording all +access to it whilst having it still behave like a dictionary.

    +

    We can do this with MagicMock, which will behave like a dictionary, +and using side_effect to delegate dictionary access to a real +underlying dictionary that is under our control.

    +

    When the __getitem__() and __setitem__() methods of our MagicMock are called +(normal dictionary access) then side_effect is called with the key (and in +the case of __setitem__ the value too). We can also control what is returned.

    +

    After the MagicMock has been used we can use attributes like +call_args_list to assert about how the dictionary was used:

    +
    >>> my_dict = {'a': 1, 'b': 2, 'c': 3}
    +>>> def getitem(name):
    +...      return my_dict[name]
    +...
    +>>> def setitem(name, val):
    +...     my_dict[name] = val
    +...
    +>>> mock = MagicMock()
    +>>> mock.__getitem__.side_effect = getitem
    +>>> mock.__setitem__.side_effect = setitem
    +
    +
    +
    +

    Note

    +

    An alternative to using MagicMock is to use Mock and only provide +the magic methods you specifically want:

    +
    >>> mock = Mock()
    +>>> mock.__getitem__ = Mock(side_effect=getitem)
    +>>> mock.__setitem__ = Mock(side_effect=setitem)
    +
    +
    +

    A third option is to use MagicMock but passing in dict as the spec +(or spec_set) argument so that the MagicMock created only has +dictionary magic methods available:

    +
    >>> mock = MagicMock(spec_set=dict)
    +>>> mock.__getitem__.side_effect = getitem
    +>>> mock.__setitem__.side_effect = setitem
    +
    +
    +
    +

    With these side effect functions in place, the mock will behave like a normal +dictionary but recording the access. It even raises a KeyError if you try +to access a key that doesn’t exist.

    +
    >>> mock['a']
    +1
    +>>> mock['c']
    +3
    +>>> mock['d']
    +Traceback (most recent call last):
    +    ...
    +KeyError: 'd'
    +>>> mock['b'] = 'fish'
    +>>> mock['d'] = 'eggs'
    +>>> mock['b']
    +'fish'
    +>>> mock['d']
    +'eggs'
    +
    +
    +

    After it has been used you can make assertions about the access using the normal +mock methods and attributes:

    +
    >>> mock.__getitem__.call_args_list
    +[call('a'), call('c'), call('d'), call('b'), call('d')]
    +>>> mock.__setitem__.call_args_list
    +[call('b', 'fish'), call('d', 'eggs')]
    +>>> my_dict
    +{'a': 1, 'c': 3, 'b': 'fish', 'd': 'eggs'}
    +
    +
    +
    +
    +

    Mock subclasses and their attributes

    +

    There are various reasons why you might want to subclass Mock. One +reason might be to add helper methods. Here’s a silly example:

    +
    >>> class MyMock(MagicMock):
    +...     def has_been_called(self):
    +...         return self.called
    +...
    +>>> mymock = MyMock(return_value=None)
    +>>> mymock
    +<MyMock id='...'>
    +>>> mymock.has_been_called()
    +False
    +>>> mymock()
    +>>> mymock.has_been_called()
    +True
    +
    +
    +

    The standard behaviour for Mock instances is that attributes and the return +value mocks are of the same type as the mock they are accessed on. This ensures +that Mock attributes are Mocks and MagicMock attributes are MagicMocks +2. So if you’re subclassing to add helper methods then they’ll also be +available on the attributes and return value mock of instances of your +subclass.

    +
    >>> mymock.foo
    +<MyMock name='mock.foo' id='...'>
    +>>> mymock.foo.has_been_called()
    +False
    +>>> mymock.foo()
    +<MyMock name='mock.foo()' id='...'>
    +>>> mymock.foo.has_been_called()
    +True
    +
    +
    +

    Sometimes this is inconvenient. For example, one user is subclassing mock to +created a Twisted adaptor. +Having this applied to attributes too actually causes errors.

    +

    Mock (in all its flavours) uses a method called _get_child_mock to create +these “sub-mocks” for attributes and return values. You can prevent your +subclass being used for attributes by overriding this method. The signature is +that it takes arbitrary keyword arguments (**kwargs) which are then passed +onto the mock constructor:

    +
    >>> class Subclass(MagicMock):
    +...     def _get_child_mock(self, **kwargs):
    +...         return MagicMock(**kwargs)
    +...
    +>>> mymock = Subclass()
    +>>> mymock.foo
    +<MagicMock name='mock.foo' id='...'>
    +>>> assert isinstance(mymock, Subclass)
    +>>> assert not isinstance(mymock.foo, Subclass)
    +>>> assert not isinstance(mymock(), Subclass)
    +
    +
    +
    +
    2
    +

    An exception to this rule are the non-callable mocks. Attributes use the +callable variant because otherwise non-callable mocks couldn’t have callable +methods.

    +
    +
    +
    +
    +

    Mocking imports with patch.dict

    +

    One situation where mocking can be hard is where you have a local import inside +a function. These are harder to mock because they aren’t using an object from +the module namespace that we can patch out.

    +

    Generally local imports are to be avoided. They are sometimes done to prevent +circular dependencies, for which there is usually a much better way to solve +the problem (refactor the code) or to prevent “up front costs” by delaying the +import. This can also be solved in better ways than an unconditional local +import (store the module as a class or module attribute and only do the import +on first use).

    +

    That aside there is a way to use mock to affect the results of an import. +Importing fetches an object from the sys.modules dictionary. Note that it +fetches an object, which need not be a module. Importing a module for the +first time results in a module object being put in sys.modules, so usually +when you import something you get a module back. This need not be the case +however.

    +

    This means you can use patch.dict() to temporarily put a mock in place +in sys.modules. Any imports whilst this patch is active will fetch the mock. +When the patch is complete (the decorated function exits, the with statement +body is complete or patcher.stop() is called) then whatever was there +previously will be restored safely.

    +

    Here’s an example that mocks out the ‘fooble’ module.

    +
    >>> mock = Mock()
    +>>> with patch.dict('sys.modules', {'fooble': mock}):
    +...    import fooble
    +...    fooble.blob()
    +...
    +<Mock name='mock.blob()' id='...'>
    +>>> assert 'fooble' not in sys.modules
    +>>> mock.blob.assert_called_once_with()
    +
    +
    +

    As you can see the import fooble succeeds, but on exit there is no ‘fooble’ +left in sys.modules.

    +

    This also works for the from module import name form:

    +
    >>> mock = Mock()
    +>>> with patch.dict('sys.modules', {'fooble': mock}):
    +...    from fooble import blob
    +...    blob.blip()
    +...
    +<Mock name='mock.blob.blip()' id='...'>
    +>>> mock.blob.blip.assert_called_once_with()
    +
    +
    +

    With slightly more work you can also mock package imports:

    +
    >>> mock = Mock()
    +>>> modules = {'package': mock, 'package.module': mock.module}
    +>>> with patch.dict('sys.modules', modules):
    +...    from package.module import fooble
    +...    fooble()
    +...
    +<Mock name='mock.module.fooble()' id='...'>
    +>>> mock.module.fooble.assert_called_once_with()
    +
    +
    +
    +
    +

    Tracking order of calls and less verbose call assertions

    +

    The Mock class allows you to track the order of method calls on +your mock objects through the method_calls attribute. This +doesn’t allow you to track the order of calls between separate mock objects, +however we can use mock_calls to achieve the same effect.

    +

    Because mocks track calls to child mocks in mock_calls, and accessing an +arbitrary attribute of a mock creates a child mock, we can create our separate +mocks from a parent one. Calls to those child mock will then all be recorded, +in order, in the mock_calls of the parent:

    +
    >>> manager = Mock()
    +>>> mock_foo = manager.foo
    +>>> mock_bar = manager.bar
    +
    +
    +
    >>> mock_foo.something()
    +<Mock name='mock.foo.something()' id='...'>
    +>>> mock_bar.other.thing()
    +<Mock name='mock.bar.other.thing()' id='...'>
    +
    +
    +
    >>> manager.mock_calls
    +[call.foo.something(), call.bar.other.thing()]
    +
    +
    +

    We can then assert about the calls, including the order, by comparing with +the mock_calls attribute on the manager mock:

    +
    >>> expected_calls = [call.foo.something(), call.bar.other.thing()]
    +>>> manager.mock_calls == expected_calls
    +True
    +
    +
    +

    If patch is creating, and putting in place, your mocks then you can attach +them to a manager mock using the attach_mock() method. After +attaching calls will be recorded in mock_calls of the manager.

    +
    >>> manager = MagicMock()
    +>>> with patch('mymodule.Class1') as MockClass1:
    +...     with patch('mymodule.Class2') as MockClass2:
    +...         manager.attach_mock(MockClass1, 'MockClass1')
    +...         manager.attach_mock(MockClass2, 'MockClass2')
    +...         MockClass1().foo()
    +...         MockClass2().bar()
    +...
    +<MagicMock name='mock.MockClass1().foo()' id='...'>
    +<MagicMock name='mock.MockClass2().bar()' id='...'>
    +>>> manager.mock_calls
    +[call.MockClass1(),
    + call.MockClass1().foo(),
    + call.MockClass2(),
    + call.MockClass2().bar()]
    +
    +
    +

    If many calls have been made, but you’re only interested in a particular +sequence of them then an alternative is to use the +assert_has_calls() method. This takes a list of calls (constructed +with the call object). If that sequence of calls are in +mock_calls then the assert succeeds.

    +
    >>> m = MagicMock()
    +>>> m().foo().bar().baz()
    +<MagicMock name='mock().foo().bar().baz()' id='...'>
    +>>> m.one().two().three()
    +<MagicMock name='mock.one().two().three()' id='...'>
    +>>> calls = call.one().two().three().call_list()
    +>>> m.assert_has_calls(calls)
    +
    +
    +

    Even though the chained call m.one().two().three() aren’t the only calls that +have been made to the mock, the assert still succeeds.

    +

    Sometimes a mock may have several calls made to it, and you are only interested +in asserting about some of those calls. You may not even care about the +order. In this case you can pass any_order=True to assert_has_calls:

    +
    >>> m = MagicMock()
    +>>> m(1), m.two(2, 3), m.seven(7), m.fifty('50')
    +(...)
    +>>> calls = [call.fifty('50'), call(1), call.seven(7)]
    +>>> m.assert_has_calls(calls, any_order=True)
    +
    +
    +
    +
    +

    More complex argument matching

    +

    Using the same basic concept as ANY we can implement matchers to do more +complex assertions on objects used as arguments to mocks.

    +

    Suppose we expect some object to be passed to a mock that by default +compares equal based on object identity (which is the Python default for user +defined classes). To use assert_called_with() we would need to pass +in the exact same object. If we are only interested in some of the attributes +of this object then we can create a matcher that will check these attributes +for us.

    +

    You can see in this example how a ‘standard’ call to assert_called_with isn’t +sufficient:

    +
    >>> class Foo:
    +...     def __init__(self, a, b):
    +...         self.a, self.b = a, b
    +...
    +>>> mock = Mock(return_value=None)
    +>>> mock(Foo(1, 2))
    +>>> mock.assert_called_with(Foo(1, 2))
    +Traceback (most recent call last):
    +    ...
    +AssertionError: Expected: call(<__main__.Foo object at 0x...>)
    +Actual call: call(<__main__.Foo object at 0x...>)
    +
    +
    +

    A comparison function for our Foo class might look something like this:

    +
    >>> def compare(self, other):
    +...     if not type(self) == type(other):
    +...         return False
    +...     if self.a != other.a:
    +...         return False
    +...     if self.b != other.b:
    +...         return False
    +...     return True
    +...
    +
    +
    +

    And a matcher object that can use comparison functions like this for its +equality operation would look something like this:

    +
    >>> class Matcher:
    +...     def __init__(self, compare, some_obj):
    +...         self.compare = compare
    +...         self.some_obj = some_obj
    +...     def __eq__(self, other):
    +...         return self.compare(self.some_obj, other)
    +...
    +
    +
    +

    Putting all this together:

    +
    >>> match_foo = Matcher(compare, Foo(1, 2))
    +>>> mock.assert_called_with(match_foo)
    +
    +
    +

    The Matcher is instantiated with our compare function and the Foo object +we want to compare against. In assert_called_with the Matcher equality +method will be called, which compares the object the mock was called with +against the one we created our matcher with. If they match then +assert_called_with passes, and if they don’t an AssertionError is raised:

    +
    >>> match_wrong = Matcher(compare, Foo(3, 4))
    +>>> mock.assert_called_with(match_wrong)
    +Traceback (most recent call last):
    +    ...
    +AssertionError: Expected: ((<Matcher object at 0x...>,), {})
    +Called with: ((<Foo object at 0x...>,), {})
    +
    +
    +

    With a bit of tweaking you could have the comparison function raise the +AssertionError directly and provide a more useful failure message.

    +

    As of version 1.5, the Python testing library PyHamcrest provides similar functionality, +that may be useful here, in the form of its equality matcher +(hamcrest.library.integration.match_equality).

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/unittest.mock.html b/python-3.7.4-docs-html/library/unittest.mock.html new file mode 100644 index 0000000..e5fe3a9 --- /dev/null +++ b/python-3.7.4-docs-html/library/unittest.mock.html @@ -0,0 +1,2580 @@ + + + + + + + unittest.mock — mock object library — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    unittest.mock — mock object library

    +
    +

    New in version 3.3.

    +
    +

    Source code: Lib/unittest/mock.py

    +
    +

    unittest.mock is a library for testing in Python. It allows you to +replace parts of your system under test with mock objects and make assertions +about how they have been used.

    +

    unittest.mock provides a core Mock class removing the need to +create a host of stubs throughout your test suite. After performing an +action, you can make assertions about which methods / attributes were used +and arguments they were called with. You can also specify return values and +set needed attributes in the normal way.

    +

    Additionally, mock provides a patch() decorator that handles patching +module and class level attributes within the scope of a test, along with +sentinel for creating unique objects. See the quick guide for +some examples of how to use Mock, MagicMock and +patch().

    +

    Mock is very easy to use and is designed for use with unittest. Mock +is based on the ‘action -> assertion’ pattern instead of ‘record -> replay’ +used by many mocking frameworks.

    +

    There is a backport of unittest.mock for earlier versions of Python, +available as mock on PyPI.

    +
    +

    Quick Guide

    +

    Mock and MagicMock objects create all attributes and +methods as you access them and store details of how they have been used. You +can configure them, to specify return values or limit what attributes are +available, and then make assertions about how they have been used:

    +
    >>> from unittest.mock import MagicMock
    +>>> thing = ProductionClass()
    +>>> thing.method = MagicMock(return_value=3)
    +>>> thing.method(3, 4, 5, key='value')
    +3
    +>>> thing.method.assert_called_with(3, 4, 5, key='value')
    +
    +
    +

    side_effect allows you to perform side effects, including raising an +exception when a mock is called:

    +
    >>> mock = Mock(side_effect=KeyError('foo'))
    +>>> mock()
    +Traceback (most recent call last):
    + ...
    +KeyError: 'foo'
    +
    +
    +
    >>> values = {'a': 1, 'b': 2, 'c': 3}
    +>>> def side_effect(arg):
    +...     return values[arg]
    +...
    +>>> mock.side_effect = side_effect
    +>>> mock('a'), mock('b'), mock('c')
    +(1, 2, 3)
    +>>> mock.side_effect = [5, 4, 3, 2, 1]
    +>>> mock(), mock(), mock()
    +(5, 4, 3)
    +
    +
    +

    Mock has many other ways you can configure it and control its behaviour. For +example the spec argument configures the mock to take its specification +from another object. Attempting to access attributes or methods on the mock +that don’t exist on the spec will fail with an AttributeError.

    +

    The patch() decorator / context manager makes it easy to mock classes or +objects in a module under test. The object you specify will be replaced with a +mock (or other object) during the test and restored when the test ends:

    +
    >>> from unittest.mock import patch
    +>>> @patch('module.ClassName2')
    +... @patch('module.ClassName1')
    +... def test(MockClass1, MockClass2):
    +...     module.ClassName1()
    +...     module.ClassName2()
    +...     assert MockClass1 is module.ClassName1
    +...     assert MockClass2 is module.ClassName2
    +...     assert MockClass1.called
    +...     assert MockClass2.called
    +...
    +>>> test()
    +
    +
    +
    +

    Note

    +

    When you nest patch decorators the mocks are passed in to the decorated +function in the same order they applied (the normal Python order that +decorators are applied). This means from the bottom up, so in the example +above the mock for module.ClassName1 is passed in first.

    +

    With patch() it matters that you patch objects in the namespace where they +are looked up. This is normally straightforward, but for a quick guide +read where to patch.

    +
    +

    As well as a decorator patch() can be used as a context manager in a with +statement:

    +
    >>> with patch.object(ProductionClass, 'method', return_value=None) as mock_method:
    +...     thing = ProductionClass()
    +...     thing.method(1, 2, 3)
    +...
    +>>> mock_method.assert_called_once_with(1, 2, 3)
    +
    +
    +

    There is also patch.dict() for setting values in a dictionary just +during a scope and restoring the dictionary to its original state when the test +ends:

    +
    >>> foo = {'key': 'value'}
    +>>> original = foo.copy()
    +>>> with patch.dict(foo, {'newkey': 'newvalue'}, clear=True):
    +...     assert foo == {'newkey': 'newvalue'}
    +...
    +>>> assert foo == original
    +
    +
    +

    Mock supports the mocking of Python magic methods. The +easiest way of using magic methods is with the MagicMock class. It +allows you to do things like:

    +
    >>> mock = MagicMock()
    +>>> mock.__str__.return_value = 'foobarbaz'
    +>>> str(mock)
    +'foobarbaz'
    +>>> mock.__str__.assert_called_with()
    +
    +
    +

    Mock allows you to assign functions (or other Mock instances) to magic methods +and they will be called appropriately. The MagicMock class is just a Mock +variant that has all of the magic methods pre-created for you (well, all the +useful ones anyway).

    +

    The following is an example of using magic methods with the ordinary Mock +class:

    +
    >>> mock = Mock()
    +>>> mock.__str__ = Mock(return_value='wheeeeee')
    +>>> str(mock)
    +'wheeeeee'
    +
    +
    +

    For ensuring that the mock objects in your tests have the same api as the +objects they are replacing, you can use auto-speccing. +Auto-speccing can be done through the autospec argument to patch, or the +create_autospec() function. Auto-speccing creates mock objects that +have the same attributes and methods as the objects they are replacing, and +any functions and methods (including constructors) have the same call +signature as the real object.

    +

    This ensures that your mocks will fail in the same way as your production +code if they are used incorrectly:

    +
    >>> from unittest.mock import create_autospec
    +>>> def function(a, b, c):
    +...     pass
    +...
    +>>> mock_function = create_autospec(function, return_value='fishy')
    +>>> mock_function(1, 2, 3)
    +'fishy'
    +>>> mock_function.assert_called_once_with(1, 2, 3)
    +>>> mock_function('wrong arguments')
    +Traceback (most recent call last):
    + ...
    +TypeError: <lambda>() takes exactly 3 arguments (1 given)
    +
    +
    +

    create_autospec() can also be used on classes, where it copies the signature of +the __init__ method, and on callable objects where it copies the signature of +the __call__ method.

    +
    +
    +

    The Mock Class

    +

    Mock is a flexible mock object intended to replace the use of stubs and +test doubles throughout your code. Mocks are callable and create attributes as +new mocks when you access them 1. Accessing the same attribute will always +return the same mock. Mocks record how you use them, allowing you to make +assertions about what your code has done to them.

    +

    MagicMock is a subclass of Mock with all the magic methods +pre-created and ready to use. There are also non-callable variants, useful +when you are mocking out objects that aren’t callable: +NonCallableMock and NonCallableMagicMock

    +

    The patch() decorators makes it easy to temporarily replace classes +in a particular module with a Mock object. By default patch() will create +a MagicMock for you. You can specify an alternative class of Mock using +the new_callable argument to patch().

    +
    +
    +class unittest.mock.Mock(spec=None, side_effect=None, return_value=DEFAULT, wraps=None, name=None, spec_set=None, unsafe=False, **kwargs)
    +

    Create a new Mock object. Mock takes several optional arguments +that specify the behaviour of the Mock object:

    +
      +
    • spec: This can be either a list of strings or an existing object (a +class or instance) that acts as the specification for the mock object. If +you pass in an object then a list of strings is formed by calling dir on +the object (excluding unsupported magic attributes and methods). +Accessing any attribute not in this list will raise an AttributeError.

      +

      If spec is an object (rather than a list of strings) then +__class__ returns the class of the spec object. This +allows mocks to pass isinstance() tests.

      +
    • +
    • spec_set: A stricter variant of spec. If used, attempting to set +or get an attribute on the mock that isn’t on the object passed as +spec_set will raise an AttributeError.

    • +
    • side_effect: A function to be called whenever the Mock is called. See +the side_effect attribute. Useful for raising exceptions or +dynamically changing return values. The function is called with the same +arguments as the mock, and unless it returns DEFAULT, the return +value of this function is used as the return value.

      +

      Alternatively side_effect can be an exception class or instance. In +this case the exception will be raised when the mock is called.

      +

      If side_effect is an iterable then each call to the mock will return +the next value from the iterable.

      +

      A side_effect can be cleared by setting it to None.

      +
    • +
    • return_value: The value returned when the mock is called. By default +this is a new Mock (created on first access). See the +return_value attribute.

    • +
    • unsafe: By default if any attribute starts with assert or +assret will raise an AttributeError. Passing unsafe=True +will allow access to these attributes.

      +
      +

      New in version 3.5.

      +
      +
    • +
    • wraps: Item for the mock object to wrap. If wraps is not None then +calling the Mock will pass the call through to the wrapped object +(returning the real result). Attribute access on the mock will return a +Mock object that wraps the corresponding attribute of the wrapped +object (so attempting to access an attribute that doesn’t exist will +raise an AttributeError).

      +

      If the mock has an explicit return_value set then calls are not passed +to the wrapped object and the return_value is returned instead.

      +
    • +
    • name: If the mock has a name then it will be used in the repr of the +mock. This can be useful for debugging. The name is propagated to child +mocks.

    • +
    +

    Mocks can also be called with arbitrary keyword arguments. These will be +used to set attributes on the mock after it is created. See the +configure_mock() method for details.

    +
    +
    +assert_called(*args, **kwargs)
    +

    Assert that the mock was called at least once.

    +
    >>> mock = Mock()
    +>>> mock.method()
    +<Mock name='mock.method()' id='...'>
    +>>> mock.method.assert_called()
    +
    +
    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +assert_called_once(*args, **kwargs)
    +

    Assert that the mock was called exactly once.

    +
    >>> mock = Mock()
    +>>> mock.method()
    +<Mock name='mock.method()' id='...'>
    +>>> mock.method.assert_called_once()
    +>>> mock.method()
    +<Mock name='mock.method()' id='...'>
    +>>> mock.method.assert_called_once()
    +Traceback (most recent call last):
    +...
    +AssertionError: Expected 'method' to have been called once. Called 2 times.
    +
    +
    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +assert_called_with(*args, **kwargs)
    +

    This method is a convenient way of asserting that calls are made in a +particular way:

    +
    >>> mock = Mock()
    +>>> mock.method(1, 2, 3, test='wow')
    +<Mock name='mock.method()' id='...'>
    +>>> mock.method.assert_called_with(1, 2, 3, test='wow')
    +
    +
    +
    + +
    +
    +assert_called_once_with(*args, **kwargs)
    +

    Assert that the mock was called exactly once and that that call was +with the specified arguments.

    +
    >>> mock = Mock(return_value=None)
    +>>> mock('foo', bar='baz')
    +>>> mock.assert_called_once_with('foo', bar='baz')
    +>>> mock('other', bar='values')
    +>>> mock.assert_called_once_with('other', bar='values')
    +Traceback (most recent call last):
    +  ...
    +AssertionError: Expected 'mock' to be called once. Called 2 times.
    +
    +
    +
    + +
    +
    +assert_any_call(*args, **kwargs)
    +

    assert the mock has been called with the specified arguments.

    +

    The assert passes if the mock has ever been called, unlike +assert_called_with() and assert_called_once_with() that +only pass if the call is the most recent one, and in the case of +assert_called_once_with() it must also be the only call.

    +
    >>> mock = Mock(return_value=None)
    +>>> mock(1, 2, arg='thing')
    +>>> mock('some', 'thing', 'else')
    +>>> mock.assert_any_call(1, 2, arg='thing')
    +
    +
    +
    + +
    +
    +assert_has_calls(calls, any_order=False)
    +

    assert the mock has been called with the specified calls. +The mock_calls list is checked for the calls.

    +

    If any_order is false (the default) then the calls must be +sequential. There can be extra calls before or after the +specified calls.

    +

    If any_order is true then the calls can be in any order, but +they must all appear in mock_calls.

    +
    >>> mock = Mock(return_value=None)
    +>>> mock(1)
    +>>> mock(2)
    +>>> mock(3)
    +>>> mock(4)
    +>>> calls = [call(2), call(3)]
    +>>> mock.assert_has_calls(calls)
    +>>> calls = [call(4), call(2), call(3)]
    +>>> mock.assert_has_calls(calls, any_order=True)
    +
    +
    +
    + +
    +
    +assert_not_called()
    +

    Assert the mock was never called.

    +
    >>> m = Mock()
    +>>> m.hello.assert_not_called()
    +>>> obj = m.hello()
    +>>> m.hello.assert_not_called()
    +Traceback (most recent call last):
    +  ...
    +AssertionError: Expected 'hello' to not have been called. Called 1 times.
    +
    +
    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +reset_mock(*, return_value=False, side_effect=False)
    +

    The reset_mock method resets all the call attributes on a mock object:

    +
    >>> mock = Mock(return_value=None)
    +>>> mock('hello')
    +>>> mock.called
    +True
    +>>> mock.reset_mock()
    +>>> mock.called
    +False
    +
    +
    +
    +

    Changed in version 3.6: Added two keyword only argument to the reset_mock function.

    +
    +

    This can be useful where you want to make a series of assertions that +reuse the same object. Note that reset_mock() doesn’t clear the +return value, side_effect or any child attributes you have +set using normal assignment by default. In case you want to reset +return_value or side_effect, then pass the corresponding +parameter as True. Child mocks and the return value mock +(if any) are reset as well.

    +
    +

    Note

    +

    return_value, and side_effect are keyword only +argument.

    +
    +
    + +
    +
    +mock_add_spec(spec, spec_set=False)
    +

    Add a spec to a mock. spec can either be an object or a +list of strings. Only attributes on the spec can be fetched as +attributes from the mock.

    +

    If spec_set is true then only attributes on the spec can be set.

    +
    + +
    +
    +attach_mock(mock, attribute)
    +

    Attach a mock as an attribute of this one, replacing its name and +parent. Calls to the attached mock will be recorded in the +method_calls and mock_calls attributes of this one.

    +
    + +
    +
    +configure_mock(**kwargs)
    +

    Set attributes on the mock through keyword arguments.

    +

    Attributes plus return values and side effects can be set on child +mocks using standard dot notation and unpacking a dictionary in the +method call:

    +
    >>> mock = Mock()
    +>>> attrs = {'method.return_value': 3, 'other.side_effect': KeyError}
    +>>> mock.configure_mock(**attrs)
    +>>> mock.method()
    +3
    +>>> mock.other()
    +Traceback (most recent call last):
    +  ...
    +KeyError
    +
    +
    +

    The same thing can be achieved in the constructor call to mocks:

    +
    >>> attrs = {'method.return_value': 3, 'other.side_effect': KeyError}
    +>>> mock = Mock(some_attribute='eggs', **attrs)
    +>>> mock.some_attribute
    +'eggs'
    +>>> mock.method()
    +3
    +>>> mock.other()
    +Traceback (most recent call last):
    +  ...
    +KeyError
    +
    +
    +

    configure_mock() exists to make it easier to do configuration +after the mock has been created.

    +
    + +
    +
    +__dir__()
    +

    Mock objects limit the results of dir(some_mock) to useful results. +For mocks with a spec this includes all the permitted attributes +for the mock.

    +

    See FILTER_DIR for what this filtering does, and how to +switch it off.

    +
    + +
    +
    +_get_child_mock(**kw)
    +

    Create the child mocks for attributes and return value. +By default child mocks will be the same type as the parent. +Subclasses of Mock may want to override this to customize the way +child mocks are made.

    +

    For non-callable mocks the callable variant will be used (rather than +any custom subclass).

    +
    + +
    +
    +called
    +

    A boolean representing whether or not the mock object has been called:

    +
    >>> mock = Mock(return_value=None)
    +>>> mock.called
    +False
    +>>> mock()
    +>>> mock.called
    +True
    +
    +
    +
    + +
    +
    +call_count
    +

    An integer telling you how many times the mock object has been called:

    +
    >>> mock = Mock(return_value=None)
    +>>> mock.call_count
    +0
    +>>> mock()
    +>>> mock()
    +>>> mock.call_count
    +2
    +
    +
    +
    + +
    +
    +return_value
    +

    Set this to configure the value returned by calling the mock:

    +
    >>> mock = Mock()
    +>>> mock.return_value = 'fish'
    +>>> mock()
    +'fish'
    +
    +
    +

    The default return value is a mock object and you can configure it in +the normal way:

    +
    >>> mock = Mock()
    +>>> mock.return_value.attribute = sentinel.Attribute
    +>>> mock.return_value()
    +<Mock name='mock()()' id='...'>
    +>>> mock.return_value.assert_called_with()
    +
    +
    +

    return_value can also be set in the constructor:

    +
    >>> mock = Mock(return_value=3)
    +>>> mock.return_value
    +3
    +>>> mock()
    +3
    +
    +
    +
    + +
    +
    +side_effect
    +

    This can either be a function to be called when the mock is called, +an iterable or an exception (class or instance) to be raised.

    +

    If you pass in a function it will be called with same arguments as the +mock and unless the function returns the DEFAULT singleton the +call to the mock will then return whatever the function returns. If the +function returns DEFAULT then the mock will return its normal +value (from the return_value).

    +

    If you pass in an iterable, it is used to retrieve an iterator which +must yield a value on every call. This value can either be an exception +instance to be raised, or a value to be returned from the call to the +mock (DEFAULT handling is identical to the function case).

    +

    An example of a mock that raises an exception (to test exception +handling of an API):

    +
    >>> mock = Mock()
    +>>> mock.side_effect = Exception('Boom!')
    +>>> mock()
    +Traceback (most recent call last):
    +  ...
    +Exception: Boom!
    +
    +
    +

    Using side_effect to return a sequence of values:

    +
    >>> mock = Mock()
    +>>> mock.side_effect = [3, 2, 1]
    +>>> mock(), mock(), mock()
    +(3, 2, 1)
    +
    +
    +

    Using a callable:

    +
    >>> mock = Mock(return_value=3)
    +>>> def side_effect(*args, **kwargs):
    +...     return DEFAULT
    +...
    +>>> mock.side_effect = side_effect
    +>>> mock()
    +3
    +
    +
    +

    side_effect can be set in the constructor. Here’s an example that +adds one to the value the mock is called with and returns it:

    +
    >>> side_effect = lambda value: value + 1
    +>>> mock = Mock(side_effect=side_effect)
    +>>> mock(3)
    +4
    +>>> mock(-8)
    +-7
    +
    +
    +

    Setting side_effect to None clears it:

    +
    >>> m = Mock(side_effect=KeyError, return_value=3)
    +>>> m()
    +Traceback (most recent call last):
    + ...
    +KeyError
    +>>> m.side_effect = None
    +>>> m()
    +3
    +
    +
    +
    + +
    +
    +call_args
    +

    This is either None (if the mock hasn’t been called), or the +arguments that the mock was last called with. This will be in the +form of a tuple: the first member is any ordered arguments the mock +was called with (or an empty tuple) and the second member is any +keyword arguments (or an empty dictionary).

    +
    >>> mock = Mock(return_value=None)
    +>>> print(mock.call_args)
    +None
    +>>> mock()
    +>>> mock.call_args
    +call()
    +>>> mock.call_args == ()
    +True
    +>>> mock(3, 4)
    +>>> mock.call_args
    +call(3, 4)
    +>>> mock.call_args == ((3, 4),)
    +True
    +>>> mock(3, 4, 5, key='fish', next='w00t!')
    +>>> mock.call_args
    +call(3, 4, 5, key='fish', next='w00t!')
    +
    +
    +

    call_args, along with members of the lists call_args_list, +method_calls and mock_calls are call objects. +These are tuples, so they can be unpacked to get at the individual +arguments and make more complex assertions. See +calls as tuples.

    +
    + +
    +
    +call_args_list
    +

    This is a list of all the calls made to the mock object in sequence +(so the length of the list is the number of times it has been +called). Before any calls have been made it is an empty list. The +call object can be used for conveniently constructing lists of +calls to compare with call_args_list.

    +
    >>> mock = Mock(return_value=None)
    +>>> mock()
    +>>> mock(3, 4)
    +>>> mock(key='fish', next='w00t!')
    +>>> mock.call_args_list
    +[call(), call(3, 4), call(key='fish', next='w00t!')]
    +>>> expected = [(), ((3, 4),), ({'key': 'fish', 'next': 'w00t!'},)]
    +>>> mock.call_args_list == expected
    +True
    +
    +
    +

    Members of call_args_list are call objects. These can be +unpacked as tuples to get at the individual arguments. See +calls as tuples.

    +
    + +
    +
    +method_calls
    +

    As well as tracking calls to themselves, mocks also track calls to +methods and attributes, and their methods and attributes:

    +
    >>> mock = Mock()
    +>>> mock.method()
    +<Mock name='mock.method()' id='...'>
    +>>> mock.property.method.attribute()
    +<Mock name='mock.property.method.attribute()' id='...'>
    +>>> mock.method_calls
    +[call.method(), call.property.method.attribute()]
    +
    +
    +

    Members of method_calls are call objects. These can be +unpacked as tuples to get at the individual arguments. See +calls as tuples.

    +
    + +
    +
    +mock_calls
    +

    mock_calls records all calls to the mock object, its methods, +magic methods and return value mocks.

    +
    >>> mock = MagicMock()
    +>>> result = mock(1, 2, 3)
    +>>> mock.first(a=3)
    +<MagicMock name='mock.first()' id='...'>
    +>>> mock.second()
    +<MagicMock name='mock.second()' id='...'>
    +>>> int(mock)
    +1
    +>>> result(1)
    +<MagicMock name='mock()()' id='...'>
    +>>> expected = [call(1, 2, 3), call.first(a=3), call.second(),
    +... call.__int__(), call()(1)]
    +>>> mock.mock_calls == expected
    +True
    +
    +
    +

    Members of mock_calls are call objects. These can be +unpacked as tuples to get at the individual arguments. See +calls as tuples.

    +
    +

    Note

    +

    The way mock_calls are recorded means that where nested +calls are made, the parameters of ancestor calls are not recorded +and so will always compare equal:

    +
    >>> mock = MagicMock()
    +>>> mock.top(a=3).bottom()
    +<MagicMock name='mock.top().bottom()' id='...'>
    +>>> mock.mock_calls
    +[call.top(a=3), call.top().bottom()]
    +>>> mock.mock_calls[-1] == call.top(a=-1).bottom()
    +True
    +
    +
    +
    +
    + +
    +
    +__class__
    +

    Normally the __class__ attribute of an object will return its type. +For a mock object with a spec, __class__ returns the spec class +instead. This allows mock objects to pass isinstance() tests for the +object they are replacing / masquerading as:

    +
    >>> mock = Mock(spec=3)
    +>>> isinstance(mock, int)
    +True
    +
    +
    +

    __class__ is assignable to, this allows a mock to pass an +isinstance() check without forcing you to use a spec:

    +
    >>> mock = Mock()
    +>>> mock.__class__ = dict
    +>>> isinstance(mock, dict)
    +True
    +
    +
    +
    + +
    + +
    +
    +class unittest.mock.NonCallableMock(spec=None, wraps=None, name=None, spec_set=None, **kwargs)
    +

    A non-callable version of Mock. The constructor parameters have the same +meaning of Mock, with the exception of return_value and side_effect +which have no meaning on a non-callable mock.

    +
    + +

    Mock objects that use a class or an instance as a spec or +spec_set are able to pass isinstance() tests:

    +
    >>> mock = Mock(spec=SomeClass)
    +>>> isinstance(mock, SomeClass)
    +True
    +>>> mock = Mock(spec_set=SomeClass())
    +>>> isinstance(mock, SomeClass)
    +True
    +
    +
    +

    The Mock classes have support for mocking magic methods. See magic +methods for the full details.

    +

    The mock classes and the patch() decorators all take arbitrary keyword +arguments for configuration. For the patch() decorators the keywords are +passed to the constructor of the mock being created. The keyword arguments +are for configuring attributes of the mock:

    +
    >>> m = MagicMock(attribute=3, other='fish')
    +>>> m.attribute
    +3
    +>>> m.other
    +'fish'
    +
    +
    +

    The return value and side effect of child mocks can be set in the same way, +using dotted notation. As you can’t use dotted names directly in a call you +have to create a dictionary and unpack it using **:

    +
    >>> attrs = {'method.return_value': 3, 'other.side_effect': KeyError}
    +>>> mock = Mock(some_attribute='eggs', **attrs)
    +>>> mock.some_attribute
    +'eggs'
    +>>> mock.method()
    +3
    +>>> mock.other()
    +Traceback (most recent call last):
    +  ...
    +KeyError
    +
    +
    +

    A callable mock which was created with a spec (or a spec_set) will +introspect the specification object’s signature when matching calls to +the mock. Therefore, it can match the actual call’s arguments regardless +of whether they were passed positionally or by name:

    +
    >>> def f(a, b, c): pass
    +...
    +>>> mock = Mock(spec=f)
    +>>> mock(1, 2, c=3)
    +<Mock name='mock()' id='140161580456576'>
    +>>> mock.assert_called_with(1, 2, 3)
    +>>> mock.assert_called_with(a=1, b=2, c=3)
    +
    +
    +

    This applies to assert_called_with(), +assert_called_once_with(), assert_has_calls() and +assert_any_call(). When Autospeccing, it will also +apply to method calls on the mock object.

    +
    +
    +

    Changed in version 3.4: Added signature introspection on specced and autospecced mock objects.

    +
    +
    +
    +
    +class unittest.mock.PropertyMock(*args, **kwargs)
    +

    A mock intended to be used as a property, or other descriptor, on a class. +PropertyMock provides __get__() and __set__() methods +so you can specify a return value when it is fetched.

    +

    Fetching a PropertyMock instance from an object calls the mock, with +no args. Setting it calls the mock with the value being set.

    +
    >>> class Foo:
    +...     @property
    +...     def foo(self):
    +...         return 'something'
    +...     @foo.setter
    +...     def foo(self, value):
    +...         pass
    +...
    +>>> with patch('__main__.Foo.foo', new_callable=PropertyMock) as mock_foo:
    +...     mock_foo.return_value = 'mockity-mock'
    +...     this_foo = Foo()
    +...     print(this_foo.foo)
    +...     this_foo.foo = 6
    +...
    +mockity-mock
    +>>> mock_foo.mock_calls
    +[call(), call(6)]
    +
    +
    +
    + +

    Because of the way mock attributes are stored you can’t directly attach a +PropertyMock to a mock object. Instead you can attach it to the mock type +object:

    +
    >>> m = MagicMock()
    +>>> p = PropertyMock(return_value=3)
    +>>> type(m).foo = p
    +>>> m.foo
    +3
    +>>> p.assert_called_once_with()
    +
    +
    +
    +

    Calling

    +

    Mock objects are callable. The call will return the value set as the +return_value attribute. The default return value is a new Mock +object; it is created the first time the return value is accessed (either +explicitly or by calling the Mock) - but it is stored and the same one +returned each time.

    +

    Calls made to the object will be recorded in the attributes +like call_args and call_args_list.

    +

    If side_effect is set then it will be called after the call has +been recorded, so if side_effect raises an exception the call is still +recorded.

    +

    The simplest way to make a mock raise an exception when called is to make +side_effect an exception class or instance:

    +
    >>> m = MagicMock(side_effect=IndexError)
    +>>> m(1, 2, 3)
    +Traceback (most recent call last):
    +  ...
    +IndexError
    +>>> m.mock_calls
    +[call(1, 2, 3)]
    +>>> m.side_effect = KeyError('Bang!')
    +>>> m('two', 'three', 'four')
    +Traceback (most recent call last):
    +  ...
    +KeyError: 'Bang!'
    +>>> m.mock_calls
    +[call(1, 2, 3), call('two', 'three', 'four')]
    +
    +
    +

    If side_effect is a function then whatever that function returns is what +calls to the mock return. The side_effect function is called with the +same arguments as the mock. This allows you to vary the return value of the +call dynamically, based on the input:

    +
    >>> def side_effect(value):
    +...     return value + 1
    +...
    +>>> m = MagicMock(side_effect=side_effect)
    +>>> m(1)
    +2
    +>>> m(2)
    +3
    +>>> m.mock_calls
    +[call(1), call(2)]
    +
    +
    +

    If you want the mock to still return the default return value (a new mock), or +any set return value, then there are two ways of doing this. Either return +mock.return_value from inside side_effect, or return DEFAULT:

    +
    >>> m = MagicMock()
    +>>> def side_effect(*args, **kwargs):
    +...     return m.return_value
    +...
    +>>> m.side_effect = side_effect
    +>>> m.return_value = 3
    +>>> m()
    +3
    +>>> def side_effect(*args, **kwargs):
    +...     return DEFAULT
    +...
    +>>> m.side_effect = side_effect
    +>>> m()
    +3
    +
    +
    +

    To remove a side_effect, and return to the default behaviour, set the +side_effect to None:

    +
    >>> m = MagicMock(return_value=6)
    +>>> def side_effect(*args, **kwargs):
    +...     return 3
    +...
    +>>> m.side_effect = side_effect
    +>>> m()
    +3
    +>>> m.side_effect = None
    +>>> m()
    +6
    +
    +
    +

    The side_effect can also be any iterable object. Repeated calls to the mock +will return values from the iterable (until the iterable is exhausted and +a StopIteration is raised):

    +
    >>> m = MagicMock(side_effect=[1, 2, 3])
    +>>> m()
    +1
    +>>> m()
    +2
    +>>> m()
    +3
    +>>> m()
    +Traceback (most recent call last):
    +  ...
    +StopIteration
    +
    +
    +

    If any members of the iterable are exceptions they will be raised instead of +returned:

    +
    >>> iterable = (33, ValueError, 66)
    +>>> m = MagicMock(side_effect=iterable)
    +>>> m()
    +33
    +>>> m()
    +Traceback (most recent call last):
    + ...
    +ValueError
    +>>> m()
    +66
    +
    +
    +
    +
    +

    Deleting Attributes

    +

    Mock objects create attributes on demand. This allows them to pretend to be +objects of any type.

    +

    You may want a mock object to return False to a hasattr() call, or raise an +AttributeError when an attribute is fetched. You can do this by providing +an object as a spec for a mock, but that isn’t always convenient.

    +

    You “block” attributes by deleting them. Once deleted, accessing an attribute +will raise an AttributeError.

    +
    >>> mock = MagicMock()
    +>>> hasattr(mock, 'm')
    +True
    +>>> del mock.m
    +>>> hasattr(mock, 'm')
    +False
    +>>> del mock.f
    +>>> mock.f
    +Traceback (most recent call last):
    +    ...
    +AttributeError: f
    +
    +
    +
    +
    +

    Mock names and the name attribute

    +

    Since “name” is an argument to the Mock constructor, if you want your +mock object to have a “name” attribute you can’t just pass it in at creation +time. There are two alternatives. One option is to use +configure_mock():

    +
    >>> mock = MagicMock()
    +>>> mock.configure_mock(name='my_name')
    +>>> mock.name
    +'my_name'
    +
    +
    +

    A simpler option is to simply set the “name” attribute after mock creation:

    +
    >>> mock = MagicMock()
    +>>> mock.name = "foo"
    +
    +
    +
    +
    +

    Attaching Mocks as Attributes

    +

    When you attach a mock as an attribute of another mock (or as the return +value) it becomes a “child” of that mock. Calls to the child are recorded in +the method_calls and mock_calls attributes of the +parent. This is useful for configuring child mocks and then attaching them to +the parent, or for attaching mocks to a parent that records all calls to the +children and allows you to make assertions about the order of calls between +mocks:

    +
    >>> parent = MagicMock()
    +>>> child1 = MagicMock(return_value=None)
    +>>> child2 = MagicMock(return_value=None)
    +>>> parent.child1 = child1
    +>>> parent.child2 = child2
    +>>> child1(1)
    +>>> child2(2)
    +>>> parent.mock_calls
    +[call.child1(1), call.child2(2)]
    +
    +
    +

    The exception to this is if the mock has a name. This allows you to prevent +the “parenting” if for some reason you don’t want it to happen.

    +
    >>> mock = MagicMock()
    +>>> not_a_child = MagicMock(name='not-a-child')
    +>>> mock.attribute = not_a_child
    +>>> mock.attribute()
    +<MagicMock name='not-a-child()' id='...'>
    +>>> mock.mock_calls
    +[]
    +
    +
    +

    Mocks created for you by patch() are automatically given names. To +attach mocks that have names to a parent you use the attach_mock() +method:

    +
    >>> thing1 = object()
    +>>> thing2 = object()
    +>>> parent = MagicMock()
    +>>> with patch('__main__.thing1', return_value=None) as child1:
    +...     with patch('__main__.thing2', return_value=None) as child2:
    +...         parent.attach_mock(child1, 'child1')
    +...         parent.attach_mock(child2, 'child2')
    +...         child1('one')
    +...         child2('two')
    +...
    +>>> parent.mock_calls
    +[call.child1('one'), call.child2('two')]
    +
    +
    +
    +
    1
    +

    The only exceptions are magic methods and attributes (those that have +leading and trailing double underscores). Mock doesn’t create these but +instead raises an AttributeError. This is because the interpreter +will often implicitly request these methods, and gets very confused to +get a new Mock object when it expects a magic method. If you need magic +method support see magic methods.

    +
    +
    +
    +
    +
    +

    The patchers

    +

    The patch decorators are used for patching objects only within the scope of +the function they decorate. They automatically handle the unpatching for you, +even if exceptions are raised. All of these functions can also be used in with +statements or as class decorators.

    +
    +

    patch

    +
    +

    Note

    +

    patch() is straightforward to use. The key is to do the patching in the +right namespace. See the section where to patch.

    +
    +
    +
    +unittest.mock.patch(target, new=DEFAULT, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)
    +

    patch() acts as a function decorator, class decorator or a context +manager. Inside the body of the function or with statement, the target +is patched with a new object. When the function/with statement exits +the patch is undone.

    +

    If new is omitted, then the target is replaced with a +MagicMock. If patch() is used as a decorator and new is +omitted, the created mock is passed in as an extra argument to the +decorated function. If patch() is used as a context manager the created +mock is returned by the context manager.

    +

    target should be a string in the form 'package.module.ClassName'. The +target is imported and the specified object replaced with the new +object, so the target must be importable from the environment you are +calling patch() from. The target is imported when the decorated function +is executed, not at decoration time.

    +

    The spec and spec_set keyword arguments are passed to the MagicMock +if patch is creating one for you.

    +

    In addition you can pass spec=True or spec_set=True, which causes +patch to pass in the object being mocked as the spec/spec_set object.

    +

    new_callable allows you to specify a different class, or callable object, +that will be called to create the new object. By default MagicMock is +used.

    +

    A more powerful form of spec is autospec. If you set autospec=True +then the mock will be created with a spec from the object being replaced. +All attributes of the mock will also have the spec of the corresponding +attribute of the object being replaced. Methods and functions being mocked +will have their arguments checked and will raise a TypeError if they are +called with the wrong signature. For mocks +replacing a class, their return value (the ‘instance’) will have the same +spec as the class. See the create_autospec() function and +Autospeccing.

    +

    Instead of autospec=True you can pass autospec=some_object to use an +arbitrary object as the spec instead of the one being replaced.

    +

    By default patch() will fail to replace attributes that don’t exist. +If you pass in create=True, and the attribute doesn’t exist, patch will +create the attribute for you when the patched function is called, and delete +it again after the patched function has exited. This is useful for writing +tests against attributes that your production code creates at runtime. It is +off by default because it can be dangerous. With it switched on you can +write passing tests against APIs that don’t actually exist!

    +
    +

    Note

    +
    +

    Changed in version 3.5: If you are patching builtins in a module then you don’t +need to pass create=True, it will be added by default.

    +
    +
    +

    Patch can be used as a TestCase class decorator. It works by +decorating each test method in the class. This reduces the boilerplate +code when your test methods share a common patchings set. patch() finds +tests by looking for method names that start with patch.TEST_PREFIX. +By default this is 'test', which matches the way unittest finds tests. +You can specify an alternative prefix by setting patch.TEST_PREFIX.

    +

    Patch can be used as a context manager, with the with statement. Here the +patching applies to the indented block after the with statement. If you +use “as” then the patched object will be bound to the name after the +“as”; very useful if patch() is creating a mock object for you.

    +

    patch() takes arbitrary keyword arguments. These will be passed to +the Mock (or new_callable) on construction.

    +

    patch.dict(...), patch.multiple(...) and patch.object(...) are +available for alternate use-cases.

    +
    + +

    patch() as function decorator, creating the mock for you and passing it into +the decorated function:

    +
    >>> @patch('__main__.SomeClass')
    +... def function(normal_argument, mock_class):
    +...     print(mock_class is SomeClass)
    +...
    +>>> function(None)
    +True
    +
    +
    +

    Patching a class replaces the class with a MagicMock instance. If the +class is instantiated in the code under test then it will be the +return_value of the mock that will be used.

    +

    If the class is instantiated multiple times you could use +side_effect to return a new mock each time. Alternatively you +can set the return_value to be anything you want.

    +

    To configure return values on methods of instances on the patched class +you must do this on the return_value. For example:

    +
    >>> class Class:
    +...     def method(self):
    +...         pass
    +...
    +>>> with patch('__main__.Class') as MockClass:
    +...     instance = MockClass.return_value
    +...     instance.method.return_value = 'foo'
    +...     assert Class() is instance
    +...     assert Class().method() == 'foo'
    +...
    +
    +
    +

    If you use spec or spec_set and patch() is replacing a class, then the +return value of the created mock will have the same spec.

    +
    >>> Original = Class
    +>>> patcher = patch('__main__.Class', spec=True)
    +>>> MockClass = patcher.start()
    +>>> instance = MockClass()
    +>>> assert isinstance(instance, Original)
    +>>> patcher.stop()
    +
    +
    +

    The new_callable argument is useful where you want to use an alternative +class to the default MagicMock for the created mock. For example, if +you wanted a NonCallableMock to be used:

    +
    >>> thing = object()
    +>>> with patch('__main__.thing', new_callable=NonCallableMock) as mock_thing:
    +...     assert thing is mock_thing
    +...     thing()
    +...
    +Traceback (most recent call last):
    +  ...
    +TypeError: 'NonCallableMock' object is not callable
    +
    +
    +

    Another use case might be to replace an object with an io.StringIO instance:

    +
    >>> from io import StringIO
    +>>> def foo():
    +...     print('Something')
    +...
    +>>> @patch('sys.stdout', new_callable=StringIO)
    +... def test(mock_stdout):
    +...     foo()
    +...     assert mock_stdout.getvalue() == 'Something\n'
    +...
    +>>> test()
    +
    +
    +

    When patch() is creating a mock for you, it is common that the first thing +you need to do is to configure the mock. Some of that configuration can be done +in the call to patch. Any arbitrary keywords you pass into the call will be +used to set attributes on the created mock:

    +
    >>> patcher = patch('__main__.thing', first='one', second='two')
    +>>> mock_thing = patcher.start()
    +>>> mock_thing.first
    +'one'
    +>>> mock_thing.second
    +'two'
    +
    +
    +

    As well as attributes on the created mock attributes, like the +return_value and side_effect, of child mocks can +also be configured. These aren’t syntactically valid to pass in directly as +keyword arguments, but a dictionary with these as keys can still be expanded +into a patch() call using **:

    +
    >>> config = {'method.return_value': 3, 'other.side_effect': KeyError}
    +>>> patcher = patch('__main__.thing', **config)
    +>>> mock_thing = patcher.start()
    +>>> mock_thing.method()
    +3
    +>>> mock_thing.other()
    +Traceback (most recent call last):
    +  ...
    +KeyError
    +
    +
    +

    By default, attempting to patch a function in a module (or a method or an +attribute in a class) that does not exist will fail with AttributeError:

    +
    >>> @patch('sys.non_existing_attribute', 42)
    +... def test():
    +...     assert sys.non_existing_attribute == 42
    +...
    +>>> test()
    +Traceback (most recent call last):
    +  ...
    +AttributeError: <module 'sys' (built-in)> does not have the attribute 'non_existing'
    +
    +
    +

    but adding create=True in the call to patch() will make the previous example +work as expected:

    +
    >>> @patch('sys.non_existing_attribute', 42, create=True)
    +... def test(mock_stdout):
    +...     assert sys.non_existing_attribute == 42
    +...
    +>>> test()
    +
    +
    +
    +
    +

    patch.object

    +
    +
    +patch.object(target, attribute, new=DEFAULT, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)
    +

    patch the named member (attribute) on an object (target) with a mock +object.

    +

    patch.object() can be used as a decorator, class decorator or a context +manager. Arguments new, spec, create, spec_set, autospec and +new_callable have the same meaning as for patch(). Like patch(), +patch.object() takes arbitrary keyword arguments for configuring the mock +object it creates.

    +

    When used as a class decorator patch.object() honours patch.TEST_PREFIX +for choosing which methods to wrap.

    +
    + +

    You can either call patch.object() with three arguments or two arguments. The +three argument form takes the object to be patched, the attribute name and the +object to replace the attribute with.

    +

    When calling with the two argument form you omit the replacement object, and a +mock is created for you and passed in as an extra argument to the decorated +function:

    +
    >>> @patch.object(SomeClass, 'class_method')
    +... def test(mock_method):
    +...     SomeClass.class_method(3)
    +...     mock_method.assert_called_with(3)
    +...
    +>>> test()
    +
    +
    +

    spec, create and the other arguments to patch.object() have the same +meaning as they do for patch().

    +
    +
    +

    patch.dict

    +
    +
    +patch.dict(in_dict, values=(), clear=False, **kwargs)
    +

    Patch a dictionary, or dictionary like object, and restore the dictionary +to its original state after the test.

    +

    in_dict can be a dictionary or a mapping like container. If it is a +mapping then it must at least support getting, setting and deleting items +plus iterating over keys.

    +

    in_dict can also be a string specifying the name of the dictionary, which +will then be fetched by importing it.

    +

    values can be a dictionary of values to set in the dictionary. values +can also be an iterable of (key, value) pairs.

    +

    If clear is true then the dictionary will be cleared before the new +values are set.

    +

    patch.dict() can also be called with arbitrary keyword arguments to set +values in the dictionary.

    +

    patch.dict() can be used as a context manager, decorator or class +decorator. When used as a class decorator patch.dict() honours +patch.TEST_PREFIX for choosing which methods to wrap.

    +
    + +

    patch.dict() can be used to add members to a dictionary, or simply let a test +change a dictionary, and ensure the dictionary is restored when the test +ends.

    +
    >>> foo = {}
    +>>> with patch.dict(foo, {'newkey': 'newvalue'}):
    +...     assert foo == {'newkey': 'newvalue'}
    +...
    +>>> assert foo == {}
    +
    +
    +
    >>> import os
    +>>> with patch.dict('os.environ', {'newkey': 'newvalue'}):
    +...     print(os.environ['newkey'])
    +...
    +newvalue
    +>>> assert 'newkey' not in os.environ
    +
    +
    +

    Keywords can be used in the patch.dict() call to set values in the dictionary:

    +
    >>> mymodule = MagicMock()
    +>>> mymodule.function.return_value = 'fish'
    +>>> with patch.dict('sys.modules', mymodule=mymodule):
    +...     import mymodule
    +...     mymodule.function('some', 'args')
    +...
    +'fish'
    +
    +
    +

    patch.dict() can be used with dictionary like objects that aren’t actually +dictionaries. At the very minimum they must support item getting, setting, +deleting and either iteration or membership test. This corresponds to the +magic methods __getitem__(), __setitem__(), __delitem__() and either +__iter__() or __contains__().

    +
    >>> class Container:
    +...     def __init__(self):
    +...         self.values = {}
    +...     def __getitem__(self, name):
    +...         return self.values[name]
    +...     def __setitem__(self, name, value):
    +...         self.values[name] = value
    +...     def __delitem__(self, name):
    +...         del self.values[name]
    +...     def __iter__(self):
    +...         return iter(self.values)
    +...
    +>>> thing = Container()
    +>>> thing['one'] = 1
    +>>> with patch.dict(thing, one=2, two=3):
    +...     assert thing['one'] == 2
    +...     assert thing['two'] == 3
    +...
    +>>> assert thing['one'] == 1
    +>>> assert list(thing) == ['one']
    +
    +
    +
    +
    +

    patch.multiple

    +
    +
    +patch.multiple(target, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)
    +

    Perform multiple patches in a single call. It takes the object to be +patched (either as an object or a string to fetch the object by importing) +and keyword arguments for the patches:

    +
    with patch.multiple(settings, FIRST_PATCH='one', SECOND_PATCH='two'):
    +    ...
    +
    +
    +

    Use DEFAULT as the value if you want patch.multiple() to create +mocks for you. In this case the created mocks are passed into a decorated +function by keyword, and a dictionary is returned when patch.multiple() is +used as a context manager.

    +

    patch.multiple() can be used as a decorator, class decorator or a context +manager. The arguments spec, spec_set, create, autospec and +new_callable have the same meaning as for patch(). These arguments will +be applied to all patches done by patch.multiple().

    +

    When used as a class decorator patch.multiple() honours patch.TEST_PREFIX +for choosing which methods to wrap.

    +
    + +

    If you want patch.multiple() to create mocks for you, then you can use +DEFAULT as the value. If you use patch.multiple() as a decorator +then the created mocks are passed into the decorated function by keyword.

    +
    >>> thing = object()
    +>>> other = object()
    +
    +
    +
    >>> @patch.multiple('__main__', thing=DEFAULT, other=DEFAULT)
    +... def test_function(thing, other):
    +...     assert isinstance(thing, MagicMock)
    +...     assert isinstance(other, MagicMock)
    +...
    +>>> test_function()
    +
    +
    +

    patch.multiple() can be nested with other patch decorators, but put arguments +passed by keyword after any of the standard arguments created by patch():

    +
    >>> @patch('sys.exit')
    +... @patch.multiple('__main__', thing=DEFAULT, other=DEFAULT)
    +... def test_function(mock_exit, other, thing):
    +...     assert 'other' in repr(other)
    +...     assert 'thing' in repr(thing)
    +...     assert 'exit' in repr(mock_exit)
    +...
    +>>> test_function()
    +
    +
    +

    If patch.multiple() is used as a context manager, the value returned by the +context manager is a dictionary where created mocks are keyed by name:

    +
    >>> with patch.multiple('__main__', thing=DEFAULT, other=DEFAULT) as values:
    +...     assert 'other' in repr(values['other'])
    +...     assert 'thing' in repr(values['thing'])
    +...     assert values['thing'] is thing
    +...     assert values['other'] is other
    +...
    +
    +
    +
    +
    +

    patch methods: start and stop

    +

    All the patchers have start() and stop() methods. These make it simpler to do +patching in setUp methods or where you want to do multiple patches without +nesting decorators or with statements.

    +

    To use them call patch(), patch.object() or patch.dict() as +normal and keep a reference to the returned patcher object. You can then +call start() to put the patch in place and stop() to undo it.

    +

    If you are using patch() to create a mock for you then it will be returned by +the call to patcher.start.

    +
    >>> patcher = patch('package.module.ClassName')
    +>>> from package import module
    +>>> original = module.ClassName
    +>>> new_mock = patcher.start()
    +>>> assert module.ClassName is not original
    +>>> assert module.ClassName is new_mock
    +>>> patcher.stop()
    +>>> assert module.ClassName is original
    +>>> assert module.ClassName is not new_mock
    +
    +
    +

    A typical use case for this might be for doing multiple patches in the setUp +method of a TestCase:

    +
    >>> class MyTest(TestCase):
    +...     def setUp(self):
    +...         self.patcher1 = patch('package.module.Class1')
    +...         self.patcher2 = patch('package.module.Class2')
    +...         self.MockClass1 = self.patcher1.start()
    +...         self.MockClass2 = self.patcher2.start()
    +...
    +...     def tearDown(self):
    +...         self.patcher1.stop()
    +...         self.patcher2.stop()
    +...
    +...     def test_something(self):
    +...         assert package.module.Class1 is self.MockClass1
    +...         assert package.module.Class2 is self.MockClass2
    +...
    +>>> MyTest('test_something').run()
    +
    +
    +
    +

    Caution

    +

    If you use this technique you must ensure that the patching is “undone” by +calling stop. This can be fiddlier than you might think, because if an +exception is raised in the setUp then tearDown is not called. +unittest.TestCase.addCleanup() makes this easier:

    +
    >>> class MyTest(TestCase):
    +...     def setUp(self):
    +...         patcher = patch('package.module.Class')
    +...         self.MockClass = patcher.start()
    +...         self.addCleanup(patcher.stop)
    +...
    +...     def test_something(self):
    +...         assert package.module.Class is self.MockClass
    +...
    +
    +
    +

    As an added bonus you no longer need to keep a reference to the patcher +object.

    +
    +

    It is also possible to stop all patches which have been started by using +patch.stopall().

    +
    +
    +patch.stopall()
    +

    Stop all active patches. Only stops patches started with start.

    +
    + +
    +
    +

    patch builtins

    +

    You can patch any builtins within a module. The following example patches +builtin ord():

    +
    >>> @patch('__main__.ord')
    +... def test(mock_ord):
    +...     mock_ord.return_value = 101
    +...     print(ord('c'))
    +...
    +>>> test()
    +101
    +
    +
    +
    +
    +

    TEST_PREFIX

    +

    All of the patchers can be used as class decorators. When used in this way +they wrap every test method on the class. The patchers recognise methods that +start with 'test' as being test methods. This is the same way that the +unittest.TestLoader finds test methods by default.

    +

    It is possible that you want to use a different prefix for your tests. You can +inform the patchers of the different prefix by setting patch.TEST_PREFIX:

    +
    >>> patch.TEST_PREFIX = 'foo'
    +>>> value = 3
    +>>>
    +>>> @patch('__main__.value', 'not three')
    +... class Thing:
    +...     def foo_one(self):
    +...         print(value)
    +...     def foo_two(self):
    +...         print(value)
    +...
    +>>>
    +>>> Thing().foo_one()
    +not three
    +>>> Thing().foo_two()
    +not three
    +>>> value
    +3
    +
    +
    +
    +
    +

    Nesting Patch Decorators

    +

    If you want to perform multiple patches then you can simply stack up the +decorators.

    +

    You can stack up multiple patch decorators using this pattern:

    +
    >>> @patch.object(SomeClass, 'class_method')
    +... @patch.object(SomeClass, 'static_method')
    +... def test(mock1, mock2):
    +...     assert SomeClass.static_method is mock1
    +...     assert SomeClass.class_method is mock2
    +...     SomeClass.static_method('foo')
    +...     SomeClass.class_method('bar')
    +...     return mock1, mock2
    +...
    +>>> mock1, mock2 = test()
    +>>> mock1.assert_called_once_with('foo')
    +>>> mock2.assert_called_once_with('bar')
    +
    +
    +

    Note that the decorators are applied from the bottom upwards. This is the +standard way that Python applies decorators. The order of the created mocks +passed into your test function matches this order.

    +
    +
    +

    Where to patch

    +

    patch() works by (temporarily) changing the object that a name points to with +another one. There can be many names pointing to any individual object, so +for patching to work you must ensure that you patch the name used by the system +under test.

    +

    The basic principle is that you patch where an object is looked up, which +is not necessarily the same place as where it is defined. A couple of +examples will help to clarify this.

    +

    Imagine we have a project that we want to test with the following structure:

    +
    a.py
    +    -> Defines SomeClass
    +
    +b.py
    +    -> from a import SomeClass
    +    -> some_function instantiates SomeClass
    +
    +
    +

    Now we want to test some_function but we want to mock out SomeClass using +patch(). The problem is that when we import module b, which we will have to +do then it imports SomeClass from module a. If we use patch() to mock out +a.SomeClass then it will have no effect on our test; module b already has a +reference to the real SomeClass and it looks like our patching had no +effect.

    +

    The key is to patch out SomeClass where it is used (or where it is looked up). +In this case some_function will actually look up SomeClass in module b, +where we have imported it. The patching should look like:

    +
    @patch('b.SomeClass')
    +
    +
    +

    However, consider the alternative scenario where instead of from a import +SomeClass module b does import a and some_function uses a.SomeClass. Both +of these import forms are common. In this case the class we want to patch is +being looked up in the module and so we have to patch a.SomeClass instead:

    +
    @patch('a.SomeClass')
    +
    +
    +
    +
    +

    Patching Descriptors and Proxy Objects

    +

    Both patch and patch.object correctly patch and restore descriptors: class +methods, static methods and properties. You should patch these on the class +rather than an instance. They also work with some objects +that proxy attribute access, like the django settings object.

    +
    +
    +
    +

    MagicMock and magic method support

    +
    +

    Mocking Magic Methods

    +

    Mock supports mocking the Python protocol methods, also known as +“magic methods”. This allows mock objects to replace containers or other +objects that implement Python protocols.

    +

    Because magic methods are looked up differently from normal methods 2, this +support has been specially implemented. This means that only specific magic +methods are supported. The supported list includes almost all of them. If +there are any missing that you need please let us know.

    +

    You mock magic methods by setting the method you are interested in to a function +or a mock instance. If you are using a function then it must take self as +the first argument 3.

    +
    >>> def __str__(self):
    +...     return 'fooble'
    +...
    +>>> mock = Mock()
    +>>> mock.__str__ = __str__
    +>>> str(mock)
    +'fooble'
    +
    +
    +
    >>> mock = Mock()
    +>>> mock.__str__ = Mock()
    +>>> mock.__str__.return_value = 'fooble'
    +>>> str(mock)
    +'fooble'
    +
    +
    +
    >>> mock = Mock()
    +>>> mock.__iter__ = Mock(return_value=iter([]))
    +>>> list(mock)
    +[]
    +
    +
    +

    One use case for this is for mocking objects used as context managers in a +with statement:

    +
    >>> mock = Mock()
    +>>> mock.__enter__ = Mock(return_value='foo')
    +>>> mock.__exit__ = Mock(return_value=False)
    +>>> with mock as m:
    +...     assert m == 'foo'
    +...
    +>>> mock.__enter__.assert_called_with()
    +>>> mock.__exit__.assert_called_with(None, None, None)
    +
    +
    +

    Calls to magic methods do not appear in method_calls, but they +are recorded in mock_calls.

    +
    +

    Note

    +

    If you use the spec keyword argument to create a mock then attempting to +set a magic method that isn’t in the spec will raise an AttributeError.

    +
    +

    The full list of supported magic methods is:

    +
      +
    • __hash__, __sizeof__, __repr__ and __str__

    • +
    • __dir__, __format__ and __subclasses__

    • +
    • __floor__, __trunc__ and __ceil__

    • +
    • Comparisons: __lt__, __gt__, __le__, __ge__, +__eq__ and __ne__

    • +
    • Container methods: __getitem__, __setitem__, __delitem__, +__contains__, __len__, __iter__, __reversed__ +and __missing__

    • +
    • Context manager: __enter__ and __exit__

    • +
    • Unary numeric methods: __neg__, __pos__ and __invert__

    • +
    • The numeric methods (including right hand and in-place variants): +__add__, __sub__, __mul__, __matmul__, __div__, __truediv__, +__floordiv__, __mod__, __divmod__, __lshift__, +__rshift__, __and__, __xor__, __or__, and __pow__

    • +
    • Numeric conversion methods: __complex__, __int__, __float__ +and __index__

    • +
    • Descriptor methods: __get__, __set__ and __delete__

    • +
    • Pickling: __reduce__, __reduce_ex__, __getinitargs__, +__getnewargs__, __getstate__ and __setstate__

    • +
    +

    The following methods exist but are not supported as they are either in use +by mock, can’t be set dynamically, or can cause problems:

    +
      +
    • __getattr__, __setattr__, __init__ and __new__

    • +
    • __prepare__, __instancecheck__, __subclasscheck__, __del__

    • +
    +
    +
    +

    Magic Mock

    +

    There are two MagicMock variants: MagicMock and NonCallableMagicMock.

    +
    +
    +class unittest.mock.MagicMock(*args, **kw)
    +

    MagicMock is a subclass of Mock with default implementations +of most of the magic methods. You can use MagicMock without having to +configure the magic methods yourself.

    +

    The constructor parameters have the same meaning as for Mock.

    +

    If you use the spec or spec_set arguments then only magic methods +that exist in the spec will be created.

    +
    + +
    +
    +class unittest.mock.NonCallableMagicMock(*args, **kw)
    +

    A non-callable version of MagicMock.

    +

    The constructor parameters have the same meaning as for +MagicMock, with the exception of return_value and +side_effect which have no meaning on a non-callable mock.

    +
    + +

    The magic methods are setup with MagicMock objects, so you can configure them +and use them in the usual way:

    +
    >>> mock = MagicMock()
    +>>> mock[3] = 'fish'
    +>>> mock.__setitem__.assert_called_with(3, 'fish')
    +>>> mock.__getitem__.return_value = 'result'
    +>>> mock[2]
    +'result'
    +
    +
    +

    By default many of the protocol methods are required to return objects of a +specific type. These methods are preconfigured with a default return value, so +that they can be used without you having to do anything if you aren’t interested +in the return value. You can still set the return value manually if you want +to change the default.

    +

    Methods and their defaults:

    +
      +
    • __lt__: NotImplemented

    • +
    • __gt__: NotImplemented

    • +
    • __le__: NotImplemented

    • +
    • __ge__: NotImplemented

    • +
    • __int__: 1

    • +
    • __contains__: False

    • +
    • __len__: 0

    • +
    • __iter__: iter([])

    • +
    • __exit__: False

    • +
    • __complex__: 1j

    • +
    • __float__: 1.0

    • +
    • __bool__: True

    • +
    • __index__: 1

    • +
    • __hash__: default hash for the mock

    • +
    • __str__: default str for the mock

    • +
    • __sizeof__: default sizeof for the mock

    • +
    +

    For example:

    +
    >>> mock = MagicMock()
    +>>> int(mock)
    +1
    +>>> len(mock)
    +0
    +>>> list(mock)
    +[]
    +>>> object() in mock
    +False
    +
    +
    +

    The two equality methods, __eq__() and __ne__(), are special. +They do the default equality comparison on identity, using the +side_effect attribute, unless you change their return value to +return something else:

    +
    >>> MagicMock() == 3
    +False
    +>>> MagicMock() != 3
    +True
    +>>> mock = MagicMock()
    +>>> mock.__eq__.return_value = True
    +>>> mock == 3
    +True
    +
    +
    +

    The return value of MagicMock.__iter__() can be any iterable object and isn’t +required to be an iterator:

    +
    >>> mock = MagicMock()
    +>>> mock.__iter__.return_value = ['a', 'b', 'c']
    +>>> list(mock)
    +['a', 'b', 'c']
    +>>> list(mock)
    +['a', 'b', 'c']
    +
    +
    +

    If the return value is an iterator, then iterating over it once will consume +it and subsequent iterations will result in an empty list:

    +
    >>> mock.__iter__.return_value = iter(['a', 'b', 'c'])
    +>>> list(mock)
    +['a', 'b', 'c']
    +>>> list(mock)
    +[]
    +
    +
    +

    MagicMock has all of the supported magic methods configured except for some +of the obscure and obsolete ones. You can still set these up if you want.

    +

    Magic methods that are supported but not setup by default in MagicMock are:

    +
      +
    • __subclasses__

    • +
    • __dir__

    • +
    • __format__

    • +
    • __get__, __set__ and __delete__

    • +
    • __reversed__ and __missing__

    • +
    • __reduce__, __reduce_ex__, __getinitargs__, __getnewargs__, +__getstate__ and __setstate__

    • +
    • __getformat__ and __setformat__

    • +
    +
    +
    2
    +

    Magic methods should be looked up on the class rather than the +instance. Different versions of Python are inconsistent about applying this +rule. The supported protocol methods should work with all supported versions +of Python.

    +
    +
    3
    +

    The function is basically hooked up to the class, but each Mock +instance is kept isolated from the others.

    +
    +
    +
    +
    +
    +

    Helpers

    +
    +

    sentinel

    +
    +
    +unittest.mock.sentinel
    +

    The sentinel object provides a convenient way of providing unique +objects for your tests.

    +

    Attributes are created on demand when you access them by name. Accessing +the same attribute will always return the same object. The objects +returned have a sensible repr so that test failure messages are readable.

    +
    +

    Changed in version 3.7: The sentinel attributes now preserve their identity when they are +copied or pickled.

    +
    +
    + +

    Sometimes when testing you need to test that a specific object is passed as an +argument to another method, or returned. It can be common to create named +sentinel objects to test this. sentinel provides a convenient way of +creating and testing the identity of objects like this.

    +

    In this example we monkey patch method to return sentinel.some_object:

    +
    >>> real = ProductionClass()
    +>>> real.method = Mock(name="method")
    +>>> real.method.return_value = sentinel.some_object
    +>>> result = real.method()
    +>>> assert result is sentinel.some_object
    +>>> sentinel.some_object
    +sentinel.some_object
    +
    +
    +
    +
    +

    DEFAULT

    +
    +
    +unittest.mock.DEFAULT
    +

    The DEFAULT object is a pre-created sentinel (actually +sentinel.DEFAULT). It can be used by side_effect +functions to indicate that the normal return value should be used.

    +
    + +
    +
    +

    call

    +
    +
    +unittest.mock.call(*args, **kwargs)
    +

    call() is a helper object for making simpler assertions, for comparing with +call_args, call_args_list, +mock_calls and method_calls. call() can also be +used with assert_has_calls().

    +
    >>> m = MagicMock(return_value=None)
    +>>> m(1, 2, a='foo', b='bar')
    +>>> m()
    +>>> m.call_args_list == [call(1, 2, a='foo', b='bar'), call()]
    +True
    +
    +
    +
    + +
    +
    +call.call_list()
    +

    For a call object that represents multiple calls, call_list() +returns a list of all the intermediate calls as well as the +final call.

    +
    + +

    call_list is particularly useful for making assertions on “chained calls”. A +chained call is multiple calls on a single line of code. This results in +multiple entries in mock_calls on a mock. Manually constructing +the sequence of calls can be tedious.

    +

    call_list() can construct the sequence of calls from the same +chained call:

    +
    >>> m = MagicMock()
    +>>> m(1).method(arg='foo').other('bar')(2.0)
    +<MagicMock name='mock().method().other()()' id='...'>
    +>>> kall = call(1).method(arg='foo').other('bar')(2.0)
    +>>> kall.call_list()
    +[call(1),
    + call().method(arg='foo'),
    + call().method().other('bar'),
    + call().method().other()(2.0)]
    +>>> m.mock_calls == kall.call_list()
    +True
    +
    +
    +

    A call object is either a tuple of (positional args, keyword args) or +(name, positional args, keyword args) depending on how it was constructed. When +you construct them yourself this isn’t particularly interesting, but the call +objects that are in the Mock.call_args, Mock.call_args_list and +Mock.mock_calls attributes can be introspected to get at the individual +arguments they contain.

    +

    The call objects in Mock.call_args and Mock.call_args_list +are two-tuples of (positional args, keyword args) whereas the call objects +in Mock.mock_calls, along with ones you construct yourself, are +three-tuples of (name, positional args, keyword args).

    +

    You can use their “tupleness” to pull out the individual arguments for more +complex introspection and assertions. The positional arguments are a tuple +(an empty tuple if there are no positional arguments) and the keyword +arguments are a dictionary:

    +
    >>> m = MagicMock(return_value=None)
    +>>> m(1, 2, 3, arg='one', arg2='two')
    +>>> kall = m.call_args
    +>>> args, kwargs = kall
    +>>> args
    +(1, 2, 3)
    +>>> kwargs
    +{'arg2': 'two', 'arg': 'one'}
    +>>> args is kall[0]
    +True
    +>>> kwargs is kall[1]
    +True
    +
    +
    +
    >>> m = MagicMock()
    +>>> m.foo(4, 5, 6, arg='two', arg2='three')
    +<MagicMock name='mock.foo()' id='...'>
    +>>> kall = m.mock_calls[0]
    +>>> name, args, kwargs = kall
    +>>> name
    +'foo'
    +>>> args
    +(4, 5, 6)
    +>>> kwargs
    +{'arg2': 'three', 'arg': 'two'}
    +>>> name is m.mock_calls[0][0]
    +True
    +
    +
    +
    +
    +

    create_autospec

    +
    +
    +unittest.mock.create_autospec(spec, spec_set=False, instance=False, **kwargs)
    +

    Create a mock object using another object as a spec. Attributes on the +mock will use the corresponding attribute on the spec object as their +spec.

    +

    Functions or methods being mocked will have their arguments checked to +ensure that they are called with the correct signature.

    +

    If spec_set is True then attempting to set attributes that don’t exist +on the spec object will raise an AttributeError.

    +

    If a class is used as a spec then the return value of the mock (the +instance of the class) will have the same spec. You can use a class as the +spec for an instance object by passing instance=True. The returned mock +will only be callable if instances of the mock are callable.

    +

    create_autospec() also takes arbitrary keyword arguments that are passed to +the constructor of the created mock.

    +
    + +

    See Autospeccing for examples of how to use auto-speccing with +create_autospec() and the autospec argument to patch().

    +
    +
    +

    ANY

    +
    +
    +unittest.mock.ANY
    +
    + +

    Sometimes you may need to make assertions about some of the arguments in a +call to mock, but either not care about some of the arguments or want to pull +them individually out of call_args and make more complex +assertions on them.

    +

    To ignore certain arguments you can pass in objects that compare equal to +everything. Calls to assert_called_with() and +assert_called_once_with() will then succeed no matter what was +passed in.

    +
    >>> mock = Mock(return_value=None)
    +>>> mock('foo', bar=object())
    +>>> mock.assert_called_once_with('foo', bar=ANY)
    +
    +
    +

    ANY can also be used in comparisons with call lists like +mock_calls:

    +
    >>> m = MagicMock(return_value=None)
    +>>> m(1)
    +>>> m(1, 2)
    +>>> m(object())
    +>>> m.mock_calls == [call(1), call(1, 2), ANY]
    +True
    +
    +
    +
    +
    +

    FILTER_DIR

    +
    +
    +unittest.mock.FILTER_DIR
    +
    + +

    FILTER_DIR is a module level variable that controls the way mock objects +respond to dir() (only for Python 2.6 or more recent). The default is True, +which uses the filtering described below, to only show useful members. If you +dislike this filtering, or need to switch it off for diagnostic purposes, then +set mock.FILTER_DIR = False.

    +

    With filtering on, dir(some_mock) shows only useful attributes and will +include any dynamically created attributes that wouldn’t normally be shown. +If the mock was created with a spec (or autospec of course) then all the +attributes from the original are shown, even if they haven’t been accessed +yet:

    +
    >>> dir(Mock())
    +['assert_any_call',
    + 'assert_called_once_with',
    + 'assert_called_with',
    + 'assert_has_calls',
    + 'attach_mock',
    + ...
    +>>> from urllib import request
    +>>> dir(Mock(spec=request))
    +['AbstractBasicAuthHandler',
    + 'AbstractDigestAuthHandler',
    + 'AbstractHTTPHandler',
    + 'BaseHandler',
    + ...
    +
    +
    +

    Many of the not-very-useful (private to Mock rather than the thing being +mocked) underscore and double underscore prefixed attributes have been +filtered from the result of calling dir() on a Mock. If you dislike this +behaviour you can switch it off by setting the module level switch +FILTER_DIR:

    +
    >>> from unittest import mock
    +>>> mock.FILTER_DIR = False
    +>>> dir(mock.Mock())
    +['_NonCallableMock__get_return_value',
    + '_NonCallableMock__get_side_effect',
    + '_NonCallableMock__return_value_doc',
    + '_NonCallableMock__set_return_value',
    + '_NonCallableMock__set_side_effect',
    + '__call__',
    + '__class__',
    + ...
    +
    +
    +

    Alternatively you can just use vars(my_mock) (instance members) and +dir(type(my_mock)) (type members) to bypass the filtering irrespective of +mock.FILTER_DIR.

    +
    +
    +

    mock_open

    +
    +
    +unittest.mock.mock_open(mock=None, read_data=None)
    +

    A helper function to create a mock to replace the use of open(). It works +for open() called directly or used as a context manager.

    +

    The mock argument is the mock object to configure. If None (the +default) then a MagicMock will be created for you, with the API limited +to methods or attributes available on standard file handles.

    +

    read_data is a string for the read(), +readline(), and readlines() methods +of the file handle to return. Calls to those methods will take data from +read_data until it is depleted. The mock of these methods is pretty +simplistic: every time the mock is called, the read_data is rewound to +the start. If you need more control over the data that you are feeding to +the tested code you will need to customize this mock for yourself. When that +is insufficient, one of the in-memory filesystem packages on PyPI can offer a realistic filesystem for testing.

    +
    +

    Changed in version 3.4: Added readline() and readlines() support. +The mock of read() changed to consume read_data rather +than returning it on each call.

    +
    +
    +

    Changed in version 3.5: read_data is now reset on each call to the mock.

    +
    +
    +

    Changed in version 3.7.1: Added __iter__() to implementation so that iteration (such as in for +loops) correctly consumes read_data.

    +
    +
    + +

    Using open() as a context manager is a great way to ensure your file handles +are closed properly and is becoming common:

    +
    with open('/some/path', 'w') as f:
    +    f.write('something')
    +
    +
    +

    The issue is that even if you mock out the call to open() it is the +returned object that is used as a context manager (and has __enter__() and +__exit__() called).

    +

    Mocking context managers with a MagicMock is common enough and fiddly +enough that a helper function is useful.

    +
    >>> m = mock_open()
    +>>> with patch('__main__.open', m):
    +...     with open('foo', 'w') as h:
    +...         h.write('some stuff')
    +...
    +>>> m.mock_calls
    +[call('foo', 'w'),
    + call().__enter__(),
    + call().write('some stuff'),
    + call().__exit__(None, None, None)]
    +>>> m.assert_called_once_with('foo', 'w')
    +>>> handle = m()
    +>>> handle.write.assert_called_once_with('some stuff')
    +
    +
    +

    And for reading files:

    +
    >>> with patch('__main__.open', mock_open(read_data='bibble')) as m:
    +...     with open('foo') as h:
    +...         result = h.read()
    +...
    +>>> m.assert_called_once_with('foo')
    +>>> assert result == 'bibble'
    +
    +
    +
    +
    +

    Autospeccing

    +

    Autospeccing is based on the existing spec feature of mock. It limits the +api of mocks to the api of an original object (the spec), but it is recursive +(implemented lazily) so that attributes of mocks only have the same api as +the attributes of the spec. In addition mocked functions / methods have the +same call signature as the original so they raise a TypeError if they are +called incorrectly.

    +

    Before I explain how auto-speccing works, here’s why it is needed.

    +

    Mock is a very powerful and flexible object, but it suffers from two flaws +when used to mock out objects from a system under test. One of these flaws is +specific to the Mock api and the other is a more general problem with using +mock objects.

    +

    First the problem specific to Mock. Mock has two assert methods that are +extremely handy: assert_called_with() and +assert_called_once_with().

    +
    >>> mock = Mock(name='Thing', return_value=None)
    +>>> mock(1, 2, 3)
    +>>> mock.assert_called_once_with(1, 2, 3)
    +>>> mock(1, 2, 3)
    +>>> mock.assert_called_once_with(1, 2, 3)
    +Traceback (most recent call last):
    + ...
    +AssertionError: Expected 'mock' to be called once. Called 2 times.
    +
    +
    +

    Because mocks auto-create attributes on demand, and allow you to call them +with arbitrary arguments, if you misspell one of these assert methods then +your assertion is gone:

    +
    >>> mock = Mock(name='Thing', return_value=None)
    +>>> mock(1, 2, 3)
    +>>> mock.assret_called_once_with(4, 5, 6)
    +
    +
    +

    Your tests can pass silently and incorrectly because of the typo.

    +

    The second issue is more general to mocking. If you refactor some of your +code, rename members and so on, any tests for code that is still using the +old api but uses mocks instead of the real objects will still pass. This +means your tests can all pass even though your code is broken.

    +

    Note that this is another reason why you need integration tests as well as +unit tests. Testing everything in isolation is all fine and dandy, but if you +don’t test how your units are “wired together” there is still lots of room +for bugs that tests might have caught.

    +

    mock already provides a feature to help with this, called speccing. If you +use a class or instance as the spec for a mock then you can only access +attributes on the mock that exist on the real class:

    +
    >>> from urllib import request
    +>>> mock = Mock(spec=request.Request)
    +>>> mock.assret_called_with
    +Traceback (most recent call last):
    + ...
    +AttributeError: Mock object has no attribute 'assret_called_with'
    +
    +
    +

    The spec only applies to the mock itself, so we still have the same issue +with any methods on the mock:

    +
    >>> mock.has_data()
    +<mock.Mock object at 0x...>
    +>>> mock.has_data.assret_called_with()
    +
    +
    +

    Auto-speccing solves this problem. You can either pass autospec=True to +patch() / patch.object() or use the create_autospec() function to create a +mock with a spec. If you use the autospec=True argument to patch() then the +object that is being replaced will be used as the spec object. Because the +speccing is done “lazily” (the spec is created as attributes on the mock are +accessed) you can use it with very complex or deeply nested objects (like +modules that import modules that import modules) without a big performance +hit.

    +

    Here’s an example of it in use:

    +
    >>> from urllib import request
    +>>> patcher = patch('__main__.request', autospec=True)
    +>>> mock_request = patcher.start()
    +>>> request is mock_request
    +True
    +>>> mock_request.Request
    +<MagicMock name='request.Request' spec='Request' id='...'>
    +
    +
    +

    You can see that request.Request has a spec. request.Request takes two +arguments in the constructor (one of which is self). Here’s what happens if +we try to call it incorrectly:

    +
    >>> req = request.Request()
    +Traceback (most recent call last):
    + ...
    +TypeError: <lambda>() takes at least 2 arguments (1 given)
    +
    +
    +

    The spec also applies to instantiated classes (i.e. the return value of +specced mocks):

    +
    >>> req = request.Request('foo')
    +>>> req
    +<NonCallableMagicMock name='request.Request()' spec='Request' id='...'>
    +
    +
    +

    Request objects are not callable, so the return value of instantiating our +mocked out request.Request is a non-callable mock. With the spec in place +any typos in our asserts will raise the correct error:

    +
    >>> req.add_header('spam', 'eggs')
    +<MagicMock name='request.Request().add_header()' id='...'>
    +>>> req.add_header.assret_called_with
    +Traceback (most recent call last):
    + ...
    +AttributeError: Mock object has no attribute 'assret_called_with'
    +>>> req.add_header.assert_called_with('spam', 'eggs')
    +
    +
    +

    In many cases you will just be able to add autospec=True to your existing +patch() calls and then be protected against bugs due to typos and api +changes.

    +

    As well as using autospec through patch() there is a +create_autospec() for creating autospecced mocks directly:

    +
    >>> from urllib import request
    +>>> mock_request = create_autospec(request)
    +>>> mock_request.Request('foo', 'bar')
    +<NonCallableMagicMock name='mock.Request()' spec='Request' id='...'>
    +
    +
    +

    This isn’t without caveats and limitations however, which is why it is not +the default behaviour. In order to know what attributes are available on the +spec object, autospec has to introspect (access attributes) the spec. As you +traverse attributes on the mock a corresponding traversal of the original +object is happening under the hood. If any of your specced objects have +properties or descriptors that can trigger code execution then you may not be +able to use autospec. On the other hand it is much better to design your +objects so that introspection is safe 4.

    +

    A more serious problem is that it is common for instance attributes to be +created in the __init__() method and not to exist on the class at all. +autospec can’t know about any dynamically created attributes and restricts +the api to visible attributes.

    +
    >>> class Something:
    +...   def __init__(self):
    +...     self.a = 33
    +...
    +>>> with patch('__main__.Something', autospec=True):
    +...   thing = Something()
    +...   thing.a
    +...
    +Traceback (most recent call last):
    +  ...
    +AttributeError: Mock object has no attribute 'a'
    +
    +
    +

    There are a few different ways of resolving this problem. The easiest, but +not necessarily the least annoying, way is to simply set the required +attributes on the mock after creation. Just because autospec doesn’t allow +you to fetch attributes that don’t exist on the spec it doesn’t prevent you +setting them:

    +
    >>> with patch('__main__.Something', autospec=True):
    +...   thing = Something()
    +...   thing.a = 33
    +...
    +
    +
    +

    There is a more aggressive version of both spec and autospec that does +prevent you setting non-existent attributes. This is useful if you want to +ensure your code only sets valid attributes too, but obviously it prevents +this particular scenario:

    +
    >>> with patch('__main__.Something', autospec=True, spec_set=True):
    +...   thing = Something()
    +...   thing.a = 33
    +...
    +Traceback (most recent call last):
    + ...
    +AttributeError: Mock object has no attribute 'a'
    +
    +
    +

    Probably the best way of solving the problem is to add class attributes as +default values for instance members initialised in __init__(). Note that if +you are only setting default attributes in __init__() then providing them via +class attributes (shared between instances of course) is faster too. e.g.

    +
    class Something:
    +    a = 33
    +
    +
    +

    This brings up another issue. It is relatively common to provide a default +value of None for members that will later be an object of a different type. +None would be useless as a spec because it wouldn’t let you access any +attributes or methods on it. As None is never going to be useful as a +spec, and probably indicates a member that will normally of some other type, +autospec doesn’t use a spec for members that are set to None. These will +just be ordinary mocks (well - MagicMocks):

    +
    >>> class Something:
    +...     member = None
    +...
    +>>> mock = create_autospec(Something)
    +>>> mock.member.foo.bar.baz()
    +<MagicMock name='mock.member.foo.bar.baz()' id='...'>
    +
    +
    +

    If modifying your production classes to add defaults isn’t to your liking +then there are more options. One of these is simply to use an instance as the +spec rather than the class. The other is to create a subclass of the +production class and add the defaults to the subclass without affecting the +production class. Both of these require you to use an alternative object as +the spec. Thankfully patch() supports this - you can simply pass the +alternative object as the autospec argument:

    +
    >>> class Something:
    +...   def __init__(self):
    +...     self.a = 33
    +...
    +>>> class SomethingForTest(Something):
    +...   a = 33
    +...
    +>>> p = patch('__main__.Something', autospec=SomethingForTest)
    +>>> mock = p.start()
    +>>> mock.a
    +<NonCallableMagicMock name='Something.a' spec='int' id='...'>
    +
    +
    +
    +
    4
    +

    This only applies to classes or already instantiated objects. Calling +a mocked class to create a mock instance does not create a real instance. +It is only attribute lookups - along with calls to dir() - that are done.

    +
    +
    +
    +
    +

    Sealing mocks

    +
    +
    +unittest.mock.seal(mock)
    +

    Seal will disable the automatic creation of mocks when accessing an attribute of +the mock being sealed or any of its attributes that are already mocks recursively.

    +

    If a mock instance with a name or a spec is assigned to an attribute +it won’t be considered in the sealing chain. This allows one to prevent seal from +fixing part of the mock object.

    +
    >>> mock = Mock()
    +>>> mock.submock.attribute1 = 2
    +>>> mock.not_submock = mock.Mock(name="sample_name")
    +>>> seal(mock)
    +>>> mock.new_attribute  # This will raise AttributeError.
    +>>> mock.submock.attribute2  # This will raise AttributeError.
    +>>> mock.not_submock.attribute2  # This won't raise.
    +
    +
    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/unix.html b/python-3.7.4-docs-html/library/unix.html new file mode 100644 index 0000000..6976db3 --- /dev/null +++ b/python-3.7.4-docs-html/library/unix.html @@ -0,0 +1,230 @@ + + + + + + + Unix Specific Services — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/urllib.error.html b/python-3.7.4-docs-html/library/urllib.error.html new file mode 100644 index 0000000..56e30e1 --- /dev/null +++ b/python-3.7.4-docs-html/library/urllib.error.html @@ -0,0 +1,250 @@ + + + + + + + urllib.error — Exception classes raised by urllib.request — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    urllib.error — Exception classes raised by urllib.request

    +

    Source code: Lib/urllib/error.py

    +
    +

    The urllib.error module defines the exception classes for exceptions +raised by urllib.request. The base exception class is URLError.

    +

    The following exceptions are raised by urllib.error as appropriate:

    +
    +
    +exception urllib.error.URLError
    +

    The handlers raise this exception (or derived exceptions) when they run into +a problem. It is a subclass of OSError.

    +
    +
    +reason
    +

    The reason for this error. It can be a message string or another +exception instance.

    +
    + +
    +

    Changed in version 3.3: URLError has been made a subclass of OSError instead +of IOError.

    +
    +
    + +
    +
    +exception urllib.error.HTTPError
    +

    Though being an exception (a subclass of URLError), an +HTTPError can also function as a non-exceptional file-like return +value (the same thing that urlopen() returns). This +is useful when handling exotic HTTP errors, such as requests for +authentication.

    +
    +
    +code
    +

    An HTTP status code as defined in RFC 2616. This numeric value corresponds +to a value found in the dictionary of codes as found in +http.server.BaseHTTPRequestHandler.responses.

    +
    + +
    +
    +reason
    +

    This is usually a string explaining the reason for this error.

    +
    + +
    +
    +headers
    +

    The HTTP response headers for the HTTP request that caused the +HTTPError.

    +
    +

    New in version 3.4.

    +
    +
    + +
    + +
    +
    +exception urllib.error.ContentTooShortError(msg, content)
    +

    This exception is raised when the urlretrieve() +function detects that +the amount of the downloaded data is less than the expected amount (given by +the Content-Length header). The content attribute stores the +downloaded (and supposedly truncated) data.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/urllib.html b/python-3.7.4-docs-html/library/urllib.html new file mode 100644 index 0000000..13e06a6 --- /dev/null +++ b/python-3.7.4-docs-html/library/urllib.html @@ -0,0 +1,192 @@ + + + + + + + urllib — URL handling modules — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    urllib — URL handling modules

    +

    Source code: Lib/urllib/

    +
    +

    urllib is a package that collects several modules for working with URLs:

    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/urllib.parse.html b/python-3.7.4-docs-html/library/urllib.parse.html new file mode 100644 index 0000000..03b4743 --- /dev/null +++ b/python-3.7.4-docs-html/library/urllib.parse.html @@ -0,0 +1,906 @@ + + + + + + + urllib.parse — Parse URLs into components — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    urllib.parse — Parse URLs into components

    +

    Source code: Lib/urllib/parse.py

    +
    +

    This module defines a standard interface to break Uniform Resource Locator (URL) +strings up in components (addressing scheme, network location, path etc.), to +combine the components back into a URL string, and to convert a “relative URL” +to an absolute URL given a “base URL.”

    +

    The module has been designed to match the Internet RFC on Relative Uniform +Resource Locators. It supports the following URL schemes: file, ftp, +gopher, hdl, http, https, imap, mailto, mms, +news, nntp, prospero, rsync, rtsp, rtspu, sftp, +shttp, sip, sips, snews, svn, svn+ssh, telnet, +wais, ws, wss.

    +

    The urllib.parse module defines functions that fall into two broad +categories: URL parsing and URL quoting. These are covered in detail in +the following sections.

    +
    +

    URL Parsing

    +

    The URL parsing functions focus on splitting a URL string into its components, +or on combining URL components into a URL string.

    +
    +
    +urllib.parse.urlparse(urlstring, scheme='', allow_fragments=True)
    +

    Parse a URL into six components, returning a 6-item named tuple. This +corresponds to the general structure of a URL: +scheme://netloc/path;parameters?query#fragment. +Each tuple item is a string, possibly empty. The components are not broken up in +smaller parts (for example, the network location is a single string), and % +escapes are not expanded. The delimiters as shown above are not part of the +result, except for a leading slash in the path component, which is retained if +present. For example:

    +
    >>> from urllib.parse import urlparse
    +>>> o = urlparse('http://www.cwi.nl:80/%7Eguido/Python.html')
    +>>> o   # doctest: +NORMALIZE_WHITESPACE
    +ParseResult(scheme='http', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',
    +            params='', query='', fragment='')
    +>>> o.scheme
    +'http'
    +>>> o.port
    +80
    +>>> o.geturl()
    +'http://www.cwi.nl:80/%7Eguido/Python.html'
    +
    +
    +

    Following the syntax specifications in RFC 1808, urlparse recognizes +a netloc only if it is properly introduced by ‘//’. Otherwise the +input is presumed to be a relative URL and thus to start with +a path component.

    +
     >>> from urllib.parse import urlparse
    + >>> urlparse('//www.cwi.nl:80/%7Eguido/Python.html')
    + ParseResult(scheme='', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',
    +            params='', query='', fragment='')
    + >>> urlparse('www.cwi.nl/%7Eguido/Python.html')
    + ParseResult(scheme='', netloc='', path='www.cwi.nl/%7Eguido/Python.html',
    +            params='', query='', fragment='')
    + >>> urlparse('help/Python.html')
    + ParseResult(scheme='', netloc='', path='help/Python.html', params='',
    +            query='', fragment='')
    +
    +
    +

    The scheme argument gives the default addressing scheme, to be +used only if the URL does not specify one. It should be the same type +(text or bytes) as urlstring, except that the default value '' is +always allowed, and is automatically converted to b'' if appropriate.

    +

    If the allow_fragments argument is false, fragment identifiers are not +recognized. Instead, they are parsed as part of the path, parameters +or query component, and fragment is set to the empty string in +the return value.

    +

    The return value is a named tuple, which means that its items can +be accessed by index or as named attributes, which are:

    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Attribute

    Index

    Value

    Value if not present

    scheme

    0

    URL scheme specifier

    scheme parameter

    netloc

    1

    Network location part

    empty string

    path

    2

    Hierarchical path

    empty string

    params

    3

    Parameters for last path +element

    empty string

    query

    4

    Query component

    empty string

    fragment

    5

    Fragment identifier

    empty string

    username

    User name

    None

    password

    Password

    None

    hostname

    Host name (lower case)

    None

    port

    Port number as integer, +if present

    None

    +

    Reading the port attribute will raise a ValueError if +an invalid port is specified in the URL. See section +Structured Parse Results for more information on the result object.

    +

    Unmatched square brackets in the netloc attribute will raise a +ValueError.

    +

    Characters in the netloc attribute that decompose under NFKC +normalization (as used by the IDNA encoding) into any of /, ?, +#, @, or : will raise a ValueError. If the URL is +decomposed before parsing, no error will be raised.

    +

    As is the case with all named tuples, the subclass has a few additional methods +and attributes that are particularly useful. One such method is _replace(). +The _replace() method will return a new ParseResult object replacing specified +fields with new values.

    +
     >>> from urllib.parse import urlparse
    + >>> u = urlparse('//www.cwi.nl:80/%7Eguido/Python.html')
    + >>> u
    + ParseResult(scheme='', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',
    +             params='', query='', fragment='')
    + >>> u._replace(scheme='http')
    + ParseResult(scheme='http', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',
    +             params='', query='', fragment='')
    +
    +
    +
    +

    Changed in version 3.2: Added IPv6 URL parsing capabilities.

    +
    +
    +

    Changed in version 3.3: The fragment is now parsed for all URL schemes (unless allow_fragment is +false), in accordance with RFC 3986. Previously, a whitelist of +schemes that support fragments existed.

    +
    +
    +

    Changed in version 3.6: Out-of-range port numbers now raise ValueError, instead of +returning None.

    +
    +
    +

    Changed in version 3.7.3: Characters that affect netloc parsing under NFKC normalization will +now raise ValueError.

    +
    +
    + +
    +
    +urllib.parse.parse_qs(qs, keep_blank_values=False, strict_parsing=False, encoding='utf-8', errors='replace', max_num_fields=None)
    +

    Parse a query string given as a string argument (data of type +application/x-www-form-urlencoded). Data are returned as a +dictionary. The dictionary keys are the unique query variable names and the +values are lists of values for each name.

    +

    The optional argument keep_blank_values is a flag indicating whether blank +values in percent-encoded queries should be treated as blank strings. A true value +indicates that blanks should be retained as blank strings. The default false +value indicates that blank values are to be ignored and treated as if they were +not included.

    +

    The optional argument strict_parsing is a flag indicating what to do with +parsing errors. If false (the default), errors are silently ignored. If true, +errors raise a ValueError exception.

    +

    The optional encoding and errors parameters specify how to decode +percent-encoded sequences into Unicode characters, as accepted by the +bytes.decode() method.

    +

    The optional argument max_num_fields is the maximum number of fields to +read. If set, then throws a ValueError if there are more than +max_num_fields fields read.

    +

    Use the urllib.parse.urlencode() function (with the doseq +parameter set to True) to convert such dictionaries into query +strings.

    +
    +

    Changed in version 3.2: Add encoding and errors parameters.

    +
    +
    +

    Changed in version 3.7.2: Added max_num_fields parameter.

    +
    +
    + +
    +
    +urllib.parse.parse_qsl(qs, keep_blank_values=False, strict_parsing=False, encoding='utf-8', errors='replace', max_num_fields=None)
    +

    Parse a query string given as a string argument (data of type +application/x-www-form-urlencoded). Data are returned as a list of +name, value pairs.

    +

    The optional argument keep_blank_values is a flag indicating whether blank +values in percent-encoded queries should be treated as blank strings. A true value +indicates that blanks should be retained as blank strings. The default false +value indicates that blank values are to be ignored and treated as if they were +not included.

    +

    The optional argument strict_parsing is a flag indicating what to do with +parsing errors. If false (the default), errors are silently ignored. If true, +errors raise a ValueError exception.

    +

    The optional encoding and errors parameters specify how to decode +percent-encoded sequences into Unicode characters, as accepted by the +bytes.decode() method.

    +

    The optional argument max_num_fields is the maximum number of fields to +read. If set, then throws a ValueError if there are more than +max_num_fields fields read.

    +

    Use the urllib.parse.urlencode() function to convert such lists of pairs into +query strings.

    +
    +

    Changed in version 3.2: Add encoding and errors parameters.

    +
    +
    +

    Changed in version 3.7.2: Added max_num_fields parameter.

    +
    +
    + +
    +
    +urllib.parse.urlunparse(parts)
    +

    Construct a URL from a tuple as returned by urlparse(). The parts +argument can be any six-item iterable. This may result in a slightly +different, but equivalent URL, if the URL that was parsed originally had +unnecessary delimiters (for example, a ? with an empty query; the RFC +states that these are equivalent).

    +
    + +
    +
    +urllib.parse.urlsplit(urlstring, scheme='', allow_fragments=True)
    +

    This is similar to urlparse(), but does not split the params from the URL. +This should generally be used instead of urlparse() if the more recent URL +syntax allowing parameters to be applied to each segment of the path portion +of the URL (see RFC 2396) is wanted. A separate function is needed to +separate the path segments and parameters. This function returns a 5-item +named tuple:

    +
    (addressing scheme, network location, path, query, fragment identifier).
    +
    +
    +

    The return value is a named tuple, its items can be accessed by index +or as named attributes:

    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Attribute

    Index

    Value

    Value if not present

    scheme

    0

    URL scheme specifier

    scheme parameter

    netloc

    1

    Network location part

    empty string

    path

    2

    Hierarchical path

    empty string

    query

    3

    Query component

    empty string

    fragment

    4

    Fragment identifier

    empty string

    username

    User name

    None

    password

    Password

    None

    hostname

    Host name (lower case)

    None

    port

    Port number as integer, +if present

    None

    +

    Reading the port attribute will raise a ValueError if +an invalid port is specified in the URL. See section +Structured Parse Results for more information on the result object.

    +

    Unmatched square brackets in the netloc attribute will raise a +ValueError.

    +

    Characters in the netloc attribute that decompose under NFKC +normalization (as used by the IDNA encoding) into any of /, ?, +#, @, or : will raise a ValueError. If the URL is +decomposed before parsing, no error will be raised.

    +
    +

    Changed in version 3.6: Out-of-range port numbers now raise ValueError, instead of +returning None.

    +
    +
    +

    Changed in version 3.7.3: Characters that affect netloc parsing under NFKC normalization will +now raise ValueError.

    +
    +
    + +
    +
    +urllib.parse.urlunsplit(parts)
    +

    Combine the elements of a tuple as returned by urlsplit() into a +complete URL as a string. The parts argument can be any five-item +iterable. This may result in a slightly different, but equivalent URL, if the +URL that was parsed originally had unnecessary delimiters (for example, a ? +with an empty query; the RFC states that these are equivalent).

    +
    + +
    +
    +urllib.parse.urljoin(base, url, allow_fragments=True)
    +

    Construct a full (“absolute”) URL by combining a “base URL” (base) with +another URL (url). Informally, this uses components of the base URL, in +particular the addressing scheme, the network location and (part of) the +path, to provide missing components in the relative URL. For example:

    +
    >>> from urllib.parse import urljoin
    +>>> urljoin('http://www.cwi.nl/%7Eguido/Python.html', 'FAQ.html')
    +'http://www.cwi.nl/%7Eguido/FAQ.html'
    +
    +
    +

    The allow_fragments argument has the same meaning and default as for +urlparse().

    +
    +

    Note

    +

    If url is an absolute URL (that is, starting with // or scheme://), +the url’s host name and/or scheme will be present in the result. For example:

    +
    +
    >>> urljoin('http://www.cwi.nl/%7Eguido/Python.html',
    +...         '//www.python.org/%7Eguido')
    +'http://www.python.org/%7Eguido'
    +
    +
    +

    If you do not want that behavior, preprocess the url with urlsplit() and +urlunsplit(), removing possible scheme and netloc parts.

    +
    +

    Changed in version 3.5: Behaviour updated to match the semantics defined in RFC 3986.

    +
    +
    + +
    +
    +urllib.parse.urldefrag(url)
    +

    If url contains a fragment identifier, return a modified version of url +with no fragment identifier, and the fragment identifier as a separate +string. If there is no fragment identifier in url, return url unmodified +and an empty string.

    +

    The return value is a named tuple, its items can be accessed by index +or as named attributes:

    + ++++++ + + + + + + + + + + + + + + + + + + + +

    Attribute

    Index

    Value

    Value if not present

    url

    0

    URL with no fragment

    empty string

    fragment

    1

    Fragment identifier

    empty string

    +

    See section Structured Parse Results for more information on the result +object.

    +
    +

    Changed in version 3.2: Result is a structured object rather than a simple 2-tuple.

    +
    +
    + +
    +
    +

    Parsing ASCII Encoded Bytes

    +

    The URL parsing functions were originally designed to operate on character +strings only. In practice, it is useful to be able to manipulate properly +quoted and encoded URLs as sequences of ASCII bytes. Accordingly, the +URL parsing functions in this module all operate on bytes and +bytearray objects in addition to str objects.

    +

    If str data is passed in, the result will also contain only +str data. If bytes or bytearray data is +passed in, the result will contain only bytes data.

    +

    Attempting to mix str data with bytes or +bytearray in a single function call will result in a +TypeError being raised, while attempting to pass in non-ASCII +byte values will trigger UnicodeDecodeError.

    +

    To support easier conversion of result objects between str and +bytes, all return values from URL parsing functions provide +either an encode() method (when the result contains str +data) or a decode() method (when the result contains bytes +data). The signatures of these methods match those of the corresponding +str and bytes methods (except that the default encoding +is 'ascii' rather than 'utf-8'). Each produces a value of a +corresponding type that contains either bytes data (for +encode() methods) or str data (for +decode() methods).

    +

    Applications that need to operate on potentially improperly quoted URLs +that may contain non-ASCII data will need to do their own decoding from +bytes to characters before invoking the URL parsing methods.

    +

    The behaviour described in this section applies only to the URL parsing +functions. The URL quoting functions use their own rules when producing +or consuming byte sequences as detailed in the documentation of the +individual URL quoting functions.

    +
    +

    Changed in version 3.2: URL parsing functions now accept ASCII encoded byte sequences

    +
    +
    +
    +

    Structured Parse Results

    +

    The result objects from the urlparse(), urlsplit() and +urldefrag() functions are subclasses of the tuple type. +These subclasses add the attributes listed in the documentation for +those functions, the encoding and decoding support described in the +previous section, as well as an additional method:

    +
    +
    +urllib.parse.SplitResult.geturl()
    +

    Return the re-combined version of the original URL as a string. This may +differ from the original URL in that the scheme may be normalized to lower +case and empty components may be dropped. Specifically, empty parameters, +queries, and fragment identifiers will be removed.

    +

    For urldefrag() results, only empty fragment identifiers will be removed. +For urlsplit() and urlparse() results, all noted changes will be +made to the URL returned by this method.

    +

    The result of this method remains unchanged if passed back through the original +parsing function:

    +
    >>> from urllib.parse import urlsplit
    +>>> url = 'HTTP://www.Python.org/doc/#'
    +>>> r1 = urlsplit(url)
    +>>> r1.geturl()
    +'http://www.Python.org/doc/'
    +>>> r2 = urlsplit(r1.geturl())
    +>>> r2.geturl()
    +'http://www.Python.org/doc/'
    +
    +
    +
    + +

    The following classes provide the implementations of the structured parse +results when operating on str objects:

    +
    +
    +class urllib.parse.DefragResult(url, fragment)
    +

    Concrete class for urldefrag() results containing str +data. The encode() method returns a DefragResultBytes +instance.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +class urllib.parse.ParseResult(scheme, netloc, path, params, query, fragment)
    +

    Concrete class for urlparse() results containing str +data. The encode() method returns a ParseResultBytes +instance.

    +
    + +
    +
    +class urllib.parse.SplitResult(scheme, netloc, path, query, fragment)
    +

    Concrete class for urlsplit() results containing str +data. The encode() method returns a SplitResultBytes +instance.

    +
    + +

    The following classes provide the implementations of the parse results when +operating on bytes or bytearray objects:

    +
    +
    +class urllib.parse.DefragResultBytes(url, fragment)
    +

    Concrete class for urldefrag() results containing bytes +data. The decode() method returns a DefragResult +instance.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +class urllib.parse.ParseResultBytes(scheme, netloc, path, params, query, fragment)
    +

    Concrete class for urlparse() results containing bytes +data. The decode() method returns a ParseResult +instance.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +class urllib.parse.SplitResultBytes(scheme, netloc, path, query, fragment)
    +

    Concrete class for urlsplit() results containing bytes +data. The decode() method returns a SplitResult +instance.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +

    URL Quoting

    +

    The URL quoting functions focus on taking program data and making it safe +for use as URL components by quoting special characters and appropriately +encoding non-ASCII text. They also support reversing these operations to +recreate the original data from the contents of a URL component if that +task isn’t already covered by the URL parsing functions above.

    +
    +
    +urllib.parse.quote(string, safe='/', encoding=None, errors=None)
    +

    Replace special characters in string using the %xx escape. Letters, +digits, and the characters '_.-~' are never quoted. By default, this +function is intended for quoting the path section of URL. The optional safe +parameter specifies additional ASCII characters that should not be quoted +— its default value is '/'.

    +

    string may be either a str or a bytes.

    +
    +

    Changed in version 3.7: Moved from RFC 2396 to RFC 3986 for quoting URL strings. “~” is now +included in the set of reserved characters.

    +
    +

    The optional encoding and errors parameters specify how to deal with +non-ASCII characters, as accepted by the str.encode() method. +encoding defaults to 'utf-8'. +errors defaults to 'strict', meaning unsupported characters raise a +UnicodeEncodeError. +encoding and errors must not be supplied if string is a +bytes, or a TypeError is raised.

    +

    Note that quote(string, safe, encoding, errors) is equivalent to +quote_from_bytes(string.encode(encoding, errors), safe).

    +

    Example: quote('/El Niño/') yields '/El%20Ni%C3%B1o/'.

    +
    + +
    +
    +urllib.parse.quote_plus(string, safe='', encoding=None, errors=None)
    +

    Like quote(), but also replace spaces by plus signs, as required for +quoting HTML form values when building up a query string to go into a URL. +Plus signs in the original string are escaped unless they are included in +safe. It also does not have safe default to '/'.

    +

    Example: quote_plus('/El Niño/') yields '%2FEl+Ni%C3%B1o%2F'.

    +
    + +
    +
    +urllib.parse.quote_from_bytes(bytes, safe='/')
    +

    Like quote(), but accepts a bytes object rather than a +str, and does not perform string-to-bytes encoding.

    +

    Example: quote_from_bytes(b'a&\xef') yields +'a%26%EF'.

    +
    + +
    +
    +urllib.parse.unquote(string, encoding='utf-8', errors='replace')
    +

    Replace %xx escapes by their single-character equivalent. +The optional encoding and errors parameters specify how to decode +percent-encoded sequences into Unicode characters, as accepted by the +bytes.decode() method.

    +

    string must be a str.

    +

    encoding defaults to 'utf-8'. +errors defaults to 'replace', meaning invalid sequences are replaced +by a placeholder character.

    +

    Example: unquote('/El%20Ni%C3%B1o/') yields '/El Niño/'.

    +
    + +
    +
    +urllib.parse.unquote_plus(string, encoding='utf-8', errors='replace')
    +

    Like unquote(), but also replace plus signs by spaces, as required for +unquoting HTML form values.

    +

    string must be a str.

    +

    Example: unquote_plus('/El+Ni%C3%B1o/') yields '/El Niño/'.

    +
    + +
    +
    +urllib.parse.unquote_to_bytes(string)
    +

    Replace %xx escapes by their single-octet equivalent, and return a +bytes object.

    +

    string may be either a str or a bytes.

    +

    If it is a str, unescaped non-ASCII characters in string +are encoded into UTF-8 bytes.

    +

    Example: unquote_to_bytes('a%26%EF') yields b'a&\xef'.

    +
    + +
    +
    +urllib.parse.urlencode(query, doseq=False, safe='', encoding=None, errors=None, quote_via=quote_plus)
    +

    Convert a mapping object or a sequence of two-element tuples, which may +contain str or bytes objects, to a percent-encoded ASCII +text string. If the resultant string is to be used as a data for POST +operation with the urlopen() function, then +it should be encoded to bytes, otherwise it would result in a +TypeError.

    +

    The resulting string is a series of key=value pairs separated by '&' +characters, where both key and value are quoted using the quote_via +function. By default, quote_plus() is used to quote the values, which +means spaces are quoted as a '+' character and ‘/’ characters are +encoded as %2F, which follows the standard for GET requests +(application/x-www-form-urlencoded). An alternate function that can be +passed as quote_via is quote(), which will encode spaces as %20 +and not encode ‘/’ characters. For maximum control of what is quoted, use +quote and specify a value for safe.

    +

    When a sequence of two-element tuples is used as the query +argument, the first element of each tuple is a key and the second is a +value. The value element in itself can be a sequence and in that case, if +the optional parameter doseq is evaluates to True, individual +key=value pairs separated by '&' are generated for each element of +the value sequence for the key. The order of parameters in the encoded +string will match the order of parameter tuples in the sequence.

    +

    The safe, encoding, and errors parameters are passed down to +quote_via (the encoding and errors parameters are only passed +when a query element is a str).

    +

    To reverse this encoding process, parse_qs() and parse_qsl() are +provided in this module to parse query strings into Python data structures.

    +

    Refer to urllib examples to find out how urlencode +method can be used for generating query string for a URL or data for POST.

    +
    +

    Changed in version 3.2: Query parameter supports bytes and string objects.

    +
    +
    +

    New in version 3.5: quote_via parameter.

    +
    +
    + +
    +

    See also

    +
    +
    RFC 3986 - Uniform Resource Identifiers

    This is the current standard (STD66). Any changes to urllib.parse module +should conform to this. Certain deviations could be observed, which are +mostly for backward compatibility purposes and for certain de-facto +parsing requirements as commonly observed in major browsers.

    +
    +
    RFC 2732 - Format for Literal IPv6 Addresses in URL’s.

    This specifies the parsing requirements of IPv6 URLs.

    +
    +
    RFC 2396 - Uniform Resource Identifiers (URI): Generic Syntax

    Document describing the generic syntactic requirements for both Uniform Resource +Names (URNs) and Uniform Resource Locators (URLs).

    +
    +
    RFC 2368 - The mailto URL scheme.

    Parsing requirements for mailto URL schemes.

    +
    +
    RFC 1808 - Relative Uniform Resource Locators

    This Request For Comments includes the rules for joining an absolute and a +relative URL, including a fair number of “Abnormal Examples” which govern the +treatment of border cases.

    +
    +
    RFC 1738 - Uniform Resource Locators (URL)

    This specifies the formal syntax and semantics of absolute URLs.

    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/urllib.request.html b/python-3.7.4-docs-html/library/urllib.request.html new file mode 100644 index 0000000..4d83dc6 --- /dev/null +++ b/python-3.7.4-docs-html/library/urllib.request.html @@ -0,0 +1,1729 @@ + + + + + + + urllib.request — Extensible library for opening URLs — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    urllib.request — Extensible library for opening URLs

    +

    Source code: Lib/urllib/request.py

    +
    +

    The urllib.request module defines functions and classes which help in +opening URLs (mostly HTTP) in a complex world — basic and digest +authentication, redirections, cookies and more.

    +
    +

    See also

    +

    The Requests package +is recommended for a higher-level HTTP client interface.

    +
    +

    The urllib.request module defines the following functions:

    +
    +
    +urllib.request.urlopen(url, data=None, [timeout, ]*, cafile=None, capath=None, cadefault=False, context=None)
    +

    Open the URL url, which can be either a string or a +Request object.

    +

    data must be an object specifying additional data to be sent to the +server, or None if no such data is needed. See Request +for details.

    +

    urllib.request module uses HTTP/1.1 and includes Connection:close header +in its HTTP requests.

    +

    The optional timeout parameter specifies a timeout in seconds for +blocking operations like the connection attempt (if not specified, +the global default timeout setting will be used). This actually +only works for HTTP, HTTPS and FTP connections.

    +

    If context is specified, it must be a ssl.SSLContext instance +describing the various SSL options. See HTTPSConnection +for more details.

    +

    The optional cafile and capath parameters specify a set of trusted +CA certificates for HTTPS requests. cafile should point to a single +file containing a bundle of CA certificates, whereas capath should +point to a directory of hashed certificate files. More information can +be found in ssl.SSLContext.load_verify_locations().

    +

    The cadefault parameter is ignored.

    +

    This function always returns an object which can work as a +context manager and has methods such as

    +
      +
    • geturl() — return the URL of the resource retrieved, +commonly used to determine if a redirect was followed

    • +
    • info() — return the meta-information of the page, such as headers, +in the form of an email.message_from_string() instance (see +Quick Reference to HTTP Headers)

    • +
    • getcode() – return the HTTP status code of the response.

    • +
    +

    For HTTP and HTTPS URLs, this function returns a +http.client.HTTPResponse object slightly modified. In addition +to the three new methods above, the msg attribute contains the +same information as the reason +attribute — the reason phrase returned by server — instead of +the response headers as it is specified in the documentation for +HTTPResponse.

    +

    For FTP, file, and data URLs and requests explicitly handled by legacy +URLopener and FancyURLopener classes, this function +returns a urllib.response.addinfourl object.

    +

    Raises URLError on protocol errors.

    +

    Note that None may be returned if no handler handles the request (though +the default installed global OpenerDirector uses +UnknownHandler to ensure this never happens).

    +

    In addition, if proxy settings are detected (for example, when a *_proxy +environment variable like http_proxy is set), +ProxyHandler is default installed and makes sure the requests are +handled through the proxy.

    +

    The legacy urllib.urlopen function from Python 2.6 and earlier has been +discontinued; urllib.request.urlopen() corresponds to the old +urllib2.urlopen. Proxy handling, which was done by passing a dictionary +parameter to urllib.urlopen, can be obtained by using +ProxyHandler objects.

    +
    +

    Changed in version 3.2: cafile and capath were added.

    +
    +
    +

    Changed in version 3.2: HTTPS virtual hosts are now supported if possible (that is, if +ssl.HAS_SNI is true).

    +
    +
    +

    New in version 3.2: data can be an iterable object.

    +
    +
    +

    Changed in version 3.3: cadefault was added.

    +
    +
    +

    Changed in version 3.4.3: context was added.

    +
    +
    +

    Deprecated since version 3.6: cafile, capath and cadefault are deprecated in favor of context. +Please use ssl.SSLContext.load_cert_chain() instead, or let +ssl.create_default_context() select the system’s trusted CA +certificates for you.

    +
    +
    + +
    +
    +urllib.request.install_opener(opener)
    +

    Install an OpenerDirector instance as the default global opener. +Installing an opener is only necessary if you want urlopen to use that +opener; otherwise, simply call OpenerDirector.open() instead of +urlopen(). The code does not check for a real +OpenerDirector, and any class with the appropriate interface will +work.

    +
    + +
    +
    +urllib.request.build_opener([handler, ...])
    +

    Return an OpenerDirector instance, which chains the handlers in the +order given. handlers can be either instances of BaseHandler, or +subclasses of BaseHandler (in which case it must be possible to call +the constructor without any parameters). Instances of the following classes +will be in front of the handlers, unless the handlers contain them, +instances of them or subclasses of them: ProxyHandler (if proxy +settings are detected), UnknownHandler, HTTPHandler, +HTTPDefaultErrorHandler, HTTPRedirectHandler, +FTPHandler, FileHandler, HTTPErrorProcessor.

    +

    If the Python installation has SSL support (i.e., if the ssl module +can be imported), HTTPSHandler will also be added.

    +

    A BaseHandler subclass may also change its handler_order +attribute to modify its position in the handlers list.

    +
    + +
    +
    +urllib.request.pathname2url(path)
    +

    Convert the pathname path from the local syntax for a path to the form used in +the path component of a URL. This does not produce a complete URL. The return +value will already be quoted using the quote() function.

    +
    + +
    +
    +urllib.request.url2pathname(path)
    +

    Convert the path component path from a percent-encoded URL to the local syntax for a +path. This does not accept a complete URL. This function uses +unquote() to decode path.

    +
    + +
    +
    +urllib.request.getproxies()
    +

    This helper function returns a dictionary of scheme to proxy server URL +mappings. It scans the environment for variables named <scheme>_proxy, +in a case insensitive approach, for all operating systems first, and when it +cannot find it, looks for proxy information from Mac OSX System +Configuration for Mac OS X and Windows Systems Registry for Windows. +If both lowercase and uppercase environment variables exist (and disagree), +lowercase is preferred.

    +
    +

    Note

    +

    If the environment variable REQUEST_METHOD is set, which usually +indicates your script is running in a CGI environment, the environment +variable HTTP_PROXY (uppercase _PROXY) will be ignored. This is +because that variable can be injected by a client using the “Proxy:” HTTP +header. If you need to use an HTTP proxy in a CGI environment, either use +ProxyHandler explicitly, or make sure the variable name is in +lowercase (or at least the _proxy suffix).

    +
    +
    + +

    The following classes are provided:

    +
    +
    +class urllib.request.Request(url, data=None, headers={}, origin_req_host=None, unverifiable=False, method=None)
    +

    This class is an abstraction of a URL request.

    +

    url should be a string containing a valid URL.

    +

    data must be an object specifying additional data to send to the +server, or None if no such data is needed. Currently HTTP +requests are the only ones that use data. The supported object +types include bytes, file-like objects, and iterables. If no +Content-Length nor Transfer-Encoding header field +has been provided, HTTPHandler will set these headers according +to the type of data. Content-Length will be used to send +bytes objects, while Transfer-Encoding: chunked as specified in +RFC 7230, Section 3.3.1 will be used to send files and other iterables.

    +

    For an HTTP POST request method, data should be a buffer in the +standard application/x-www-form-urlencoded format. The +urllib.parse.urlencode() function takes a mapping or sequence +of 2-tuples and returns an ASCII string in this format. It should +be encoded to bytes before being used as the data parameter.

    +

    headers should be a dictionary, and will be treated as if +add_header() was called with each key and value as arguments. +This is often used to “spoof” the User-Agent header value, which is +used by a browser to identify itself – some HTTP servers only +allow requests coming from common browsers as opposed to scripts. +For example, Mozilla Firefox may identify itself as "Mozilla/5.0 +(X11; U; Linux i686) Gecko/20071127 Firefox/2.0.0.11", while +urllib’s default user agent string is +"Python-urllib/2.6" (on Python 2.6).

    +

    An appropriate Content-Type header should be included if the data +argument is present. If this header has not been provided and data +is not None, Content-Type: application/x-www-form-urlencoded will +be added as a default.

    +

    The final two arguments are only of interest for correct handling +of third-party HTTP cookies:

    +

    origin_req_host should be the request-host of the origin +transaction, as defined by RFC 2965. It defaults to +http.cookiejar.request_host(self). This is the host name or IP +address of the original request that was initiated by the user. +For example, if the request is for an image in an HTML document, +this should be the request-host of the request for the page +containing the image.

    +

    unverifiable should indicate whether the request is unverifiable, +as defined by RFC 2965. It defaults to False. An unverifiable +request is one whose URL the user did not have the option to +approve. For example, if the request is for an image in an HTML +document, and the user had no option to approve the automatic +fetching of the image, this should be true.

    +

    method should be a string that indicates the HTTP request method that +will be used (e.g. 'HEAD'). If provided, its value is stored in the +method attribute and is used by get_method(). +The default is 'GET' if data is None or 'POST' otherwise. +Subclasses may indicate a different default method by setting the +method attribute in the class itself.

    +
    +

    Note

    +

    The request will not work as expected if the data object is unable +to deliver its content more than once (e.g. a file or an iterable +that can produce the content only once) and the request is retried +for HTTP redirects or authentication. The data is sent to the +HTTP server right away after the headers. There is no support for +a 100-continue expectation in the library.

    +
    +
    +

    Changed in version 3.3: Request.method argument is added to the Request class.

    +
    +
    +

    Changed in version 3.4: Default Request.method may be indicated at the class level.

    +
    +
    +

    Changed in version 3.6: Do not raise an error if the Content-Length has not been +provided and data is neither None nor a bytes object. +Fall back to use chunked transfer encoding instead.

    +
    +
    + +
    +
    +class urllib.request.OpenerDirector
    +

    The OpenerDirector class opens URLs via BaseHandlers chained +together. It manages the chaining of handlers, and recovery from errors.

    +
    + +
    +
    +class urllib.request.BaseHandler
    +

    This is the base class for all registered handlers — and handles only the +simple mechanics of registration.

    +
    + +
    +
    +class urllib.request.HTTPDefaultErrorHandler
    +

    A class which defines a default handler for HTTP error responses; all responses +are turned into HTTPError exceptions.

    +
    + +
    +
    +class urllib.request.HTTPRedirectHandler
    +

    A class to handle redirections.

    +
    + +
    +
    +class urllib.request.HTTPCookieProcessor(cookiejar=None)
    +

    A class to handle HTTP Cookies.

    +
    + +
    +
    +class urllib.request.ProxyHandler(proxies=None)
    +

    Cause requests to go through a proxy. If proxies is given, it must be a +dictionary mapping protocol names to URLs of proxies. The default is to read +the list of proxies from the environment variables +<protocol>_proxy. If no proxy environment variables are set, then +in a Windows environment proxy settings are obtained from the registry’s +Internet Settings section, and in a Mac OS X environment proxy information +is retrieved from the OS X System Configuration Framework.

    +

    To disable autodetected proxy pass an empty dictionary.

    +

    The no_proxy environment variable can be used to specify hosts +which shouldn’t be reached via proxy; if set, it should be a comma-separated +list of hostname suffixes, optionally with :port appended, for example +cern.ch,ncsa.uiuc.edu,some.host:8080.

    +
    +
    +

    Note

    +

    HTTP_PROXY will be ignored if a variable REQUEST_METHOD is set; +see the documentation on getproxies().

    +
    +
    +
    + +
    +
    +class urllib.request.HTTPPasswordMgr
    +

    Keep a database of (realm, uri) -> (user, password) mappings.

    +
    + +
    +
    +class urllib.request.HTTPPasswordMgrWithDefaultRealm
    +

    Keep a database of (realm, uri) -> (user, password) mappings. A realm of +None is considered a catch-all realm, which is searched if no other realm +fits.

    +
    + +
    +
    +class urllib.request.HTTPPasswordMgrWithPriorAuth
    +

    A variant of HTTPPasswordMgrWithDefaultRealm that also has a +database of uri -> is_authenticated mappings. Can be used by a +BasicAuth handler to determine when to send authentication credentials +immediately instead of waiting for a 401 response first.

    +
    +

    New in version 3.5.

    +
    +
    + +
    +
    +class urllib.request.AbstractBasicAuthHandler(password_mgr=None)
    +

    This is a mixin class that helps with HTTP authentication, both to the remote +host and to a proxy. password_mgr, if given, should be something that is +compatible with HTTPPasswordMgr; refer to section +HTTPPasswordMgr Objects for information on the interface that must be +supported. If passwd_mgr also provides is_authenticated and +update_authenticated methods (see +HTTPPasswordMgrWithPriorAuth Objects), then the handler will use the +is_authenticated result for a given URI to determine whether or not to +send authentication credentials with the request. If is_authenticated +returns True for the URI, credentials are sent. If is_authenticated +is False, credentials are not sent, and then if a 401 response is +received the request is re-sent with the authentication credentials. If +authentication succeeds, update_authenticated is called to set +is_authenticated True for the URI, so that subsequent requests to +the URI or any of its super-URIs will automatically include the +authentication credentials.

    +
    +

    New in version 3.5: Added is_authenticated support.

    +
    +
    + +
    +
    +class urllib.request.HTTPBasicAuthHandler(password_mgr=None)
    +

    Handle authentication with the remote host. password_mgr, if given, should +be something that is compatible with HTTPPasswordMgr; refer to +section HTTPPasswordMgr Objects for information on the interface that must +be supported. HTTPBasicAuthHandler will raise a ValueError when +presented with a wrong Authentication scheme.

    +
    + +
    +
    +class urllib.request.ProxyBasicAuthHandler(password_mgr=None)
    +

    Handle authentication with the proxy. password_mgr, if given, should be +something that is compatible with HTTPPasswordMgr; refer to section +HTTPPasswordMgr Objects for information on the interface that must be +supported.

    +
    + +
    +
    +class urllib.request.AbstractDigestAuthHandler(password_mgr=None)
    +

    This is a mixin class that helps with HTTP authentication, both to the remote +host and to a proxy. password_mgr, if given, should be something that is +compatible with HTTPPasswordMgr; refer to section +HTTPPasswordMgr Objects for information on the interface that must be +supported.

    +
    + +
    +
    +class urllib.request.HTTPDigestAuthHandler(password_mgr=None)
    +

    Handle authentication with the remote host. password_mgr, if given, should +be something that is compatible with HTTPPasswordMgr; refer to +section HTTPPasswordMgr Objects for information on the interface that must +be supported. When both Digest Authentication Handler and Basic +Authentication Handler are both added, Digest Authentication is always tried +first. If the Digest Authentication returns a 40x response again, it is sent +to Basic Authentication handler to Handle. This Handler method will raise a +ValueError when presented with an authentication scheme other than +Digest or Basic.

    +
    +

    Changed in version 3.3: Raise ValueError on unsupported Authentication Scheme.

    +
    +
    + +
    +
    +class urllib.request.ProxyDigestAuthHandler(password_mgr=None)
    +

    Handle authentication with the proxy. password_mgr, if given, should be +something that is compatible with HTTPPasswordMgr; refer to section +HTTPPasswordMgr Objects for information on the interface that must be +supported.

    +
    + +
    +
    +class urllib.request.HTTPHandler
    +

    A class to handle opening of HTTP URLs.

    +
    + +
    +
    +class urllib.request.HTTPSHandler(debuglevel=0, context=None, check_hostname=None)
    +

    A class to handle opening of HTTPS URLs. context and check_hostname +have the same meaning as in http.client.HTTPSConnection.

    +
    +

    Changed in version 3.2: context and check_hostname were added.

    +
    +
    + +
    +
    +class urllib.request.FileHandler
    +

    Open local files.

    +
    + +
    +
    +class urllib.request.DataHandler
    +

    Open data URLs.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +class urllib.request.FTPHandler
    +

    Open FTP URLs.

    +
    + +
    +
    +class urllib.request.CacheFTPHandler
    +

    Open FTP URLs, keeping a cache of open FTP connections to minimize delays.

    +
    + +
    +
    +class urllib.request.UnknownHandler
    +

    A catch-all class to handle unknown URLs.

    +
    + +
    +
    +class urllib.request.HTTPErrorProcessor
    +

    Process HTTP error responses.

    +
    + +
    +

    Request Objects

    +

    The following methods describe Request’s public interface, +and so all may be overridden in subclasses. It also defines several +public attributes that can be used by clients to inspect the parsed +request.

    +
    +
    +Request.full_url
    +

    The original URL passed to the constructor.

    +
    +

    Changed in version 3.4.

    +
    +

    Request.full_url is a property with setter, getter and a deleter. Getting +full_url returns the original request URL with the +fragment, if it was present.

    +
    + +
    +
    +Request.type
    +

    The URI scheme.

    +
    + +
    +
    +Request.host
    +

    The URI authority, typically a host, but may also contain a port +separated by a colon.

    +
    + +
    +
    +Request.origin_req_host
    +

    The original host for the request, without port.

    +
    + +
    +
    +Request.selector
    +

    The URI path. If the Request uses a proxy, then selector +will be the full URL that is passed to the proxy.

    +
    + +
    +
    +Request.data
    +

    The entity body for the request, or None if not specified.

    +
    +

    Changed in version 3.4: Changing value of Request.data now deletes “Content-Length” +header if it was previously set or calculated.

    +
    +
    + +
    +
    +Request.unverifiable
    +

    boolean, indicates whether the request is unverifiable as defined +by RFC 2965.

    +
    + +
    +
    +Request.method
    +

    The HTTP request method to use. By default its value is None, +which means that get_method() will do its normal computation +of the method to be used. Its value can be set (thus overriding the default +computation in get_method()) either by providing a default +value by setting it at the class level in a Request subclass, or by +passing a value in to the Request constructor via the method +argument.

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.4: A default value can now be set in subclasses; previously it could only +be set via the constructor argument.

    +
    +
    + +
    +
    +Request.get_method()
    +

    Return a string indicating the HTTP request method. If +Request.method is not None, return its value, otherwise return +'GET' if Request.data is None, or 'POST' if it’s not. +This is only meaningful for HTTP requests.

    +
    +

    Changed in version 3.3: get_method now looks at the value of Request.method.

    +
    +
    + +
    +
    +Request.add_header(key, val)
    +

    Add another header to the request. Headers are currently ignored by all +handlers except HTTP handlers, where they are added to the list of headers sent +to the server. Note that there cannot be more than one header with the same +name, and later calls will overwrite previous calls in case the key collides. +Currently, this is no loss of HTTP functionality, since all headers which have +meaning when used more than once have a (header-specific) way of gaining the +same functionality using only one header.

    +
    + +
    +
    +Request.add_unredirected_header(key, header)
    +

    Add a header that will not be added to a redirected request.

    +
    + +
    +
    +Request.has_header(header)
    +

    Return whether the instance has the named header (checks both regular and +unredirected).

    +
    + +
    +
    +Request.remove_header(header)
    +

    Remove named header from the request instance (both from regular and +unredirected headers).

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +Request.get_full_url()
    +

    Return the URL given in the constructor.

    +
    +

    Changed in version 3.4.

    +
    +

    Returns Request.full_url

    +
    + +
    +
    +Request.set_proxy(host, type)
    +

    Prepare the request by connecting to a proxy server. The host and type will +replace those of the instance, and the instance’s selector will be the original +URL given in the constructor.

    +
    + +
    +
    +Request.get_header(header_name, default=None)
    +

    Return the value of the given header. If the header is not present, return +the default value.

    +
    + +
    +
    +Request.header_items()
    +

    Return a list of tuples (header_name, header_value) of the Request headers.

    +
    + +
    +

    Changed in version 3.4: The request methods add_data, has_data, get_data, get_type, get_host, +get_selector, get_origin_req_host and is_unverifiable that were deprecated +since 3.3 have been removed.

    +
    +
    +
    +

    OpenerDirector Objects

    +

    OpenerDirector instances have the following methods:

    +
    +
    +OpenerDirector.add_handler(handler)
    +

    handler should be an instance of BaseHandler. The following methods +are searched, and added to the possible chains (note that HTTP errors are a +special case). Note that, in the following, protocol should be replaced +with the actual protocol to handle, for example http_response() would +be the HTTP protocol response handler. Also type should be replaced with +the actual HTTP code, for example http_error_404() would handle HTTP +404 errors.

    +
      +
    • <protocol>_open() — signal that the handler knows how to open protocol +URLs.

      +

      See BaseHandler.<protocol>_open() for more information.

      +
    • +
    • http_error_<type>() — signal that the handler knows how to handle HTTP +errors with HTTP error code type.

      +

      See BaseHandler.http_error_<nnn>() for more information.

      +
    • +
    • <protocol>_error() — signal that the handler knows how to handle errors +from (non-http) protocol.

    • +
    • <protocol>_request() — signal that the handler knows how to pre-process +protocol requests.

      +

      See BaseHandler.<protocol>_request() for more information.

      +
    • +
    • <protocol>_response() — signal that the handler knows how to +post-process protocol responses.

      +

      See BaseHandler.<protocol>_response() for more information.

      +
    • +
    +
    + +
    +
    +OpenerDirector.open(url, data=None[, timeout])
    +

    Open the given url (which can be a request object or a string), optionally +passing the given data. Arguments, return values and exceptions raised are +the same as those of urlopen() (which simply calls the open() +method on the currently installed global OpenerDirector). The +optional timeout parameter specifies a timeout in seconds for blocking +operations like the connection attempt (if not specified, the global default +timeout setting will be used). The timeout feature actually works only for +HTTP, HTTPS and FTP connections).

    +
    + +
    +
    +OpenerDirector.error(proto, *args)
    +

    Handle an error of the given protocol. This will call the registered error +handlers for the given protocol with the given arguments (which are protocol +specific). The HTTP protocol is a special case which uses the HTTP response +code to determine the specific error handler; refer to the http_error_<type>() +methods of the handler classes.

    +

    Return values and exceptions raised are the same as those of urlopen().

    +
    + +

    OpenerDirector objects open URLs in three stages:

    +

    The order in which these methods are called within each stage is determined by +sorting the handler instances.

    +
      +
    1. Every handler with a method named like <protocol>_request() has that +method called to pre-process the request.

    2. +
    3. Handlers with a method named like <protocol>_open() are called to handle +the request. This stage ends when a handler either returns a non-None +value (ie. a response), or raises an exception (usually +URLError). Exceptions are allowed to propagate.

      +

      In fact, the above algorithm is first tried for methods named +default_open(). If all such methods return None, the algorithm +is repeated for methods named like <protocol>_open(). If all such methods +return None, the algorithm is repeated for methods named +unknown_open().

      +

      Note that the implementation of these methods may involve calls of the parent +OpenerDirector instance’s open() and +error() methods.

      +
    4. +
    5. Every handler with a method named like <protocol>_response() has that +method called to post-process the response.

    6. +
    +
    +
    +

    BaseHandler Objects

    +

    BaseHandler objects provide a couple of methods that are directly +useful, and others that are meant to be used by derived classes. These are +intended for direct use:

    +
    +
    +BaseHandler.add_parent(director)
    +

    Add a director as parent.

    +
    + +
    +
    +BaseHandler.close()
    +

    Remove any parents.

    +
    + +

    The following attribute and methods should only be used by classes derived from +BaseHandler.

    +
    +

    Note

    +

    The convention has been adopted that subclasses defining +<protocol>_request() or <protocol>_response() methods are named +*Processor; all others are named *Handler.

    +
    +
    +
    +BaseHandler.parent
    +

    A valid OpenerDirector, which can be used to open using a different +protocol, or handle errors.

    +
    + +
    +
    +BaseHandler.default_open(req)
    +

    This method is not defined in BaseHandler, but subclasses should +define it if they want to catch all URLs.

    +

    This method, if implemented, will be called by the parent +OpenerDirector. It should return a file-like object as described in +the return value of the open() of OpenerDirector, or None. +It should raise URLError, unless a truly exceptional +thing happens (for example, MemoryError should not be mapped to +URLError).

    +

    This method will be called before any protocol-specific open method.

    +
    + +
    +
    +BaseHandler.<protocol>_open(req)
    +

    This method is not defined in BaseHandler, but subclasses should +define it if they want to handle URLs with the given protocol.

    +

    This method, if defined, will be called by the parent OpenerDirector. +Return values should be the same as for default_open().

    +
    + +
    +
    +BaseHandler.unknown_open(req)
    +

    This method is not defined in BaseHandler, but subclasses should +define it if they want to catch all URLs with no specific registered handler to +open it.

    +

    This method, if implemented, will be called by the parent +OpenerDirector. Return values should be the same as for +default_open().

    +
    + +
    +
    +BaseHandler.http_error_default(req, fp, code, msg, hdrs)
    +

    This method is not defined in BaseHandler, but subclasses should +override it if they intend to provide a catch-all for otherwise unhandled HTTP +errors. It will be called automatically by the OpenerDirector getting +the error, and should not normally be called in other circumstances.

    +

    req will be a Request object, fp will be a file-like object with +the HTTP error body, code will be the three-digit code of the error, msg +will be the user-visible explanation of the code and hdrs will be a mapping +object with the headers of the error.

    +

    Return values and exceptions raised should be the same as those of +urlopen().

    +
    + +
    +
    +BaseHandler.http_error_<nnn>(req, fp, code, msg, hdrs)
    +

    nnn should be a three-digit HTTP error code. This method is also not defined +in BaseHandler, but will be called, if it exists, on an instance of a +subclass, when an HTTP error with code nnn occurs.

    +

    Subclasses should override this method to handle specific HTTP errors.

    +

    Arguments, return values and exceptions raised should be the same as for +http_error_default().

    +
    + +
    +
    +BaseHandler.<protocol>_request(req)
    +

    This method is not defined in BaseHandler, but subclasses should +define it if they want to pre-process requests of the given protocol.

    +

    This method, if defined, will be called by the parent OpenerDirector. +req will be a Request object. The return value should be a +Request object.

    +
    + +
    +
    +BaseHandler.<protocol>_response(req, response)
    +

    This method is not defined in BaseHandler, but subclasses should +define it if they want to post-process responses of the given protocol.

    +

    This method, if defined, will be called by the parent OpenerDirector. +req will be a Request object. response will be an object +implementing the same interface as the return value of urlopen(). The +return value should implement the same interface as the return value of +urlopen().

    +
    + +
    +
    +

    HTTPRedirectHandler Objects

    +
    +

    Note

    +

    Some HTTP redirections require action from this module’s client code. If this +is the case, HTTPError is raised. See RFC 2616 for +details of the precise meanings of the various redirection codes.

    +

    An HTTPError exception raised as a security consideration if the +HTTPRedirectHandler is presented with a redirected URL which is not an HTTP, +HTTPS or FTP URL.

    +
    +
    +
    +HTTPRedirectHandler.redirect_request(req, fp, code, msg, hdrs, newurl)
    +

    Return a Request or None in response to a redirect. This is called +by the default implementations of the http_error_30*() methods when a +redirection is received from the server. If a redirection should take place, +return a new Request to allow http_error_30*() to perform the +redirect to newurl. Otherwise, raise HTTPError if +no other handler should try to handle this URL, or return None if you +can’t but another handler might.

    +
    +

    Note

    +

    The default implementation of this method does not strictly follow RFC 2616, +which says that 301 and 302 responses to POST requests must not be +automatically redirected without confirmation by the user. In reality, browsers +do allow automatic redirection of these responses, changing the POST to a +GET, and the default implementation reproduces this behavior.

    +
    +
    + +
    +
    +HTTPRedirectHandler.http_error_301(req, fp, code, msg, hdrs)
    +

    Redirect to the Location: or URI: URL. This method is called by the +parent OpenerDirector when getting an HTTP ‘moved permanently’ response.

    +
    + +
    +
    +HTTPRedirectHandler.http_error_302(req, fp, code, msg, hdrs)
    +

    The same as http_error_301(), but called for the ‘found’ response.

    +
    + +
    +
    +HTTPRedirectHandler.http_error_303(req, fp, code, msg, hdrs)
    +

    The same as http_error_301(), but called for the ‘see other’ response.

    +
    + +
    +
    +HTTPRedirectHandler.http_error_307(req, fp, code, msg, hdrs)
    +

    The same as http_error_301(), but called for the ‘temporary redirect’ +response.

    +
    + +
    +
    +

    HTTPCookieProcessor Objects

    +

    HTTPCookieProcessor instances have one attribute:

    +
    +
    +HTTPCookieProcessor.cookiejar
    +

    The http.cookiejar.CookieJar in which cookies are stored.

    +
    + +
    +
    +

    ProxyHandler Objects

    +
    +
    +ProxyHandler.<protocol>_open(request)
    +

    The ProxyHandler will have a method <protocol>_open() for every +protocol which has a proxy in the proxies dictionary given in the +constructor. The method will modify requests to go through the proxy, by +calling request.set_proxy(), and call the next handler in the chain to +actually execute the protocol.

    +
    + +
    +
    +

    HTTPPasswordMgr Objects

    +

    These methods are available on HTTPPasswordMgr and +HTTPPasswordMgrWithDefaultRealm objects.

    +
    +
    +HTTPPasswordMgr.add_password(realm, uri, user, passwd)
    +

    uri can be either a single URI, or a sequence of URIs. realm, user and +passwd must be strings. This causes (user, passwd) to be used as +authentication tokens when authentication for realm and a super-URI of any of +the given URIs is given.

    +
    + +
    +
    +HTTPPasswordMgr.find_user_password(realm, authuri)
    +

    Get user/password for given realm and URI, if any. This method will return +(None, None) if there is no matching user/password.

    +

    For HTTPPasswordMgrWithDefaultRealm objects, the realm None will be +searched if the given realm has no matching user/password.

    +
    + +
    +
    +

    HTTPPasswordMgrWithPriorAuth Objects

    +

    This password manager extends HTTPPasswordMgrWithDefaultRealm to support +tracking URIs for which authentication credentials should always be sent.

    +
    +
    +HTTPPasswordMgrWithPriorAuth.add_password(realm, uri, user, passwd, is_authenticated=False)
    +

    realm, uri, user, passwd are as for +HTTPPasswordMgr.add_password(). is_authenticated sets the initial +value of the is_authenticated flag for the given URI or list of URIs. +If is_authenticated is specified as True, realm is ignored.

    +
    + +
    +
    +HTTPPasswordMgr.find_user_password(realm, authuri)
    +

    Same as for HTTPPasswordMgrWithDefaultRealm objects

    +
    + +
    +
    +HTTPPasswordMgrWithPriorAuth.update_authenticated(self, uri, is_authenticated=False)
    +

    Update the is_authenticated flag for the given uri or list +of URIs.

    +
    + +
    +
    +HTTPPasswordMgrWithPriorAuth.is_authenticated(self, authuri)
    +

    Returns the current state of the is_authenticated flag for +the given URI.

    +
    + +
    +
    +

    AbstractBasicAuthHandler Objects

    +
    +
    +AbstractBasicAuthHandler.http_error_auth_reqed(authreq, host, req, headers)
    +

    Handle an authentication request by getting a user/password pair, and re-trying +the request. authreq should be the name of the header where the information +about the realm is included in the request, host specifies the URL and path to +authenticate for, req should be the (failed) Request object, and +headers should be the error headers.

    +

    host is either an authority (e.g. "python.org") or a URL containing an +authority component (e.g. "http://python.org/"). In either case, the +authority must not contain a userinfo component (so, "python.org" and +"python.org:80" are fine, "joe:password@python.org" is not).

    +
    + +
    +
    +

    HTTPBasicAuthHandler Objects

    +
    +
    +HTTPBasicAuthHandler.http_error_401(req, fp, code, msg, hdrs)
    +

    Retry the request with authentication information, if available.

    +
    + +
    +
    +

    ProxyBasicAuthHandler Objects

    +
    +
    +ProxyBasicAuthHandler.http_error_407(req, fp, code, msg, hdrs)
    +

    Retry the request with authentication information, if available.

    +
    + +
    +
    +

    AbstractDigestAuthHandler Objects

    +
    +
    +AbstractDigestAuthHandler.http_error_auth_reqed(authreq, host, req, headers)
    +

    authreq should be the name of the header where the information about the realm +is included in the request, host should be the host to authenticate to, req +should be the (failed) Request object, and headers should be the +error headers.

    +
    + +
    +
    +

    HTTPDigestAuthHandler Objects

    +
    +
    +HTTPDigestAuthHandler.http_error_401(req, fp, code, msg, hdrs)
    +

    Retry the request with authentication information, if available.

    +
    + +
    +
    +

    ProxyDigestAuthHandler Objects

    +
    +
    +ProxyDigestAuthHandler.http_error_407(req, fp, code, msg, hdrs)
    +

    Retry the request with authentication information, if available.

    +
    + +
    +
    +

    HTTPHandler Objects

    +
    +
    +HTTPHandler.http_open(req)
    +

    Send an HTTP request, which can be either GET or POST, depending on +req.has_data().

    +
    + +
    +
    +

    HTTPSHandler Objects

    +
    +
    +HTTPSHandler.https_open(req)
    +

    Send an HTTPS request, which can be either GET or POST, depending on +req.has_data().

    +
    + +
    +
    +

    FileHandler Objects

    +
    +
    +FileHandler.file_open(req)
    +

    Open the file locally, if there is no host name, or the host name is +'localhost'.

    +
    +

    Changed in version 3.2: This method is applicable only for local hostnames. When a remote +hostname is given, an URLError is raised.

    +
    +
    + +
    +
    +

    DataHandler Objects

    +
    +
    +DataHandler.data_open(req)
    +

    Read a data URL. This kind of URL contains the content encoded in the URL +itself. The data URL syntax is specified in RFC 2397. This implementation +ignores white spaces in base64 encoded data URLs so the URL may be wrapped +in whatever source file it comes from. But even though some browsers don’t +mind about a missing padding at the end of a base64 encoded data URL, this +implementation will raise an ValueError in that case.

    +
    + +
    +
    +

    FTPHandler Objects

    +
    +
    +FTPHandler.ftp_open(req)
    +

    Open the FTP file indicated by req. The login is always done with empty +username and password.

    +
    + +
    +
    +

    CacheFTPHandler Objects

    +

    CacheFTPHandler objects are FTPHandler objects with the +following additional methods:

    +
    +
    +CacheFTPHandler.setTimeout(t)
    +

    Set timeout of connections to t seconds.

    +
    + +
    +
    +CacheFTPHandler.setMaxConns(m)
    +

    Set maximum number of cached connections to m.

    +
    + +
    +
    +

    UnknownHandler Objects

    +
    +
    +UnknownHandler.unknown_open()
    +

    Raise a URLError exception.

    +
    + +
    +
    +

    HTTPErrorProcessor Objects

    +
    +
    +HTTPErrorProcessor.http_response(request, response)
    +

    Process HTTP error responses.

    +

    For 200 error codes, the response object is returned immediately.

    +

    For non-200 error codes, this simply passes the job on to the +http_error_<type>() handler methods, via OpenerDirector.error(). +Eventually, HTTPDefaultErrorHandler will raise an +HTTPError if no other handler handles the error.

    +
    + +
    +
    +HTTPErrorProcessor.https_response(request, response)
    +

    Process HTTPS error responses.

    +

    The behavior is same as http_response().

    +
    + +
    +
    +

    Examples

    +

    In addition to the examples below, more examples are given in +HOWTO Fetch Internet Resources Using The urllib Package.

    +

    This example gets the python.org main page and displays the first 300 bytes of +it.

    +
    >>> import urllib.request
    +>>> with urllib.request.urlopen('http://www.python.org/') as f:
    +...     print(f.read(300))
    +...
    +b'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    +"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n\n\n<html
    +xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\n\n<head>\n
    +<meta http-equiv="content-type" content="text/html; charset=utf-8" />\n
    +<title>Python Programming '
    +
    +
    +

    Note that urlopen returns a bytes object. This is because there is no way +for urlopen to automatically determine the encoding of the byte stream +it receives from the HTTP server. In general, a program will decode +the returned bytes object to string once it determines or guesses +the appropriate encoding.

    +

    The following W3C document, https://www.w3.org/International/O-charset, lists +the various ways in which an (X)HTML or an XML document could have specified its +encoding information.

    +

    As the python.org website uses utf-8 encoding as specified in its meta tag, we +will use the same for decoding the bytes object.

    +
    >>> with urllib.request.urlopen('http://www.python.org/') as f:
    +...     print(f.read(100).decode('utf-8'))
    +...
    +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    +"http://www.w3.org/TR/xhtml1/DTD/xhtm
    +
    +
    +

    It is also possible to achieve the same result without using the +context manager approach.

    +
    >>> import urllib.request
    +>>> f = urllib.request.urlopen('http://www.python.org/')
    +>>> print(f.read(100).decode('utf-8'))
    +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    +"http://www.w3.org/TR/xhtml1/DTD/xhtm
    +
    +
    +

    In the following example, we are sending a data-stream to the stdin of a CGI +and reading the data it returns to us. Note that this example will only work +when the Python installation supports SSL.

    +
    >>> import urllib.request
    +>>> req = urllib.request.Request(url='https://localhost/cgi-bin/test.cgi',
    +...                       data=b'This data is passed to stdin of the CGI')
    +>>> with urllib.request.urlopen(req) as f:
    +...     print(f.read().decode('utf-8'))
    +...
    +Got Data: "This data is passed to stdin of the CGI"
    +
    +
    +

    The code for the sample CGI used in the above example is:

    +
    #!/usr/bin/env python
    +import sys
    +data = sys.stdin.read()
    +print('Content-type: text/plain\n\nGot Data: "%s"' % data)
    +
    +
    +

    Here is an example of doing a PUT request using Request:

    +
    import urllib.request
    +DATA = b'some data'
    +req = urllib.request.Request(url='http://localhost:8080', data=DATA,method='PUT')
    +with urllib.request.urlopen(req) as f:
    +    pass
    +print(f.status)
    +print(f.reason)
    +
    +
    +

    Use of Basic HTTP Authentication:

    +
    import urllib.request
    +# Create an OpenerDirector with support for Basic HTTP Authentication...
    +auth_handler = urllib.request.HTTPBasicAuthHandler()
    +auth_handler.add_password(realm='PDQ Application',
    +                          uri='https://mahler:8092/site-updates.py',
    +                          user='klem',
    +                          passwd='kadidd!ehopper')
    +opener = urllib.request.build_opener(auth_handler)
    +# ...and install it globally so it can be used with urlopen.
    +urllib.request.install_opener(opener)
    +urllib.request.urlopen('http://www.example.com/login.html')
    +
    +
    +

    build_opener() provides many handlers by default, including a +ProxyHandler. By default, ProxyHandler uses the environment +variables named <scheme>_proxy, where <scheme> is the URL scheme +involved. For example, the http_proxy environment variable is read to +obtain the HTTP proxy’s URL.

    +

    This example replaces the default ProxyHandler with one that uses +programmatically-supplied proxy URLs, and adds proxy authorization support with +ProxyBasicAuthHandler.

    +
    proxy_handler = urllib.request.ProxyHandler({'http': 'http://www.example.com:3128/'})
    +proxy_auth_handler = urllib.request.ProxyBasicAuthHandler()
    +proxy_auth_handler.add_password('realm', 'host', 'username', 'password')
    +
    +opener = urllib.request.build_opener(proxy_handler, proxy_auth_handler)
    +# This time, rather than install the OpenerDirector, we use it directly:
    +opener.open('http://www.example.com/login.html')
    +
    +
    +

    Adding HTTP headers:

    +

    Use the headers argument to the Request constructor, or:

    +
    import urllib.request
    +req = urllib.request.Request('http://www.example.com/')
    +req.add_header('Referer', 'http://www.python.org/')
    +# Customize the default User-Agent header value:
    +req.add_header('User-Agent', 'urllib-example/0.1 (Contact: . . .)')
    +r = urllib.request.urlopen(req)
    +
    +
    +

    OpenerDirector automatically adds a User-Agent header to +every Request. To change this:

    +
    import urllib.request
    +opener = urllib.request.build_opener()
    +opener.addheaders = [('User-agent', 'Mozilla/5.0')]
    +opener.open('http://www.example.com/')
    +
    +
    +

    Also, remember that a few standard headers (Content-Length, +Content-Type and Host) +are added when the Request is passed to urlopen() (or +OpenerDirector.open()).

    +

    Here is an example session that uses the GET method to retrieve a URL +containing parameters:

    +
    >>> import urllib.request
    +>>> import urllib.parse
    +>>> params = urllib.parse.urlencode({'spam': 1, 'eggs': 2, 'bacon': 0})
    +>>> url = "http://www.musi-cal.com/cgi-bin/query?%s" % params
    +>>> with urllib.request.urlopen(url) as f:
    +...     print(f.read().decode('utf-8'))
    +...
    +
    +
    +

    The following example uses the POST method instead. Note that params output +from urlencode is encoded to bytes before it is sent to urlopen as data:

    +
    >>> import urllib.request
    +>>> import urllib.parse
    +>>> data = urllib.parse.urlencode({'spam': 1, 'eggs': 2, 'bacon': 0})
    +>>> data = data.encode('ascii')
    +>>> with urllib.request.urlopen("http://requestb.in/xrbl82xr", data) as f:
    +...     print(f.read().decode('utf-8'))
    +...
    +
    +
    +

    The following example uses an explicitly specified HTTP proxy, overriding +environment settings:

    +
    >>> import urllib.request
    +>>> proxies = {'http': 'http://proxy.example.com:8080/'}
    +>>> opener = urllib.request.FancyURLopener(proxies)
    +>>> with opener.open("http://www.python.org") as f:
    +...     f.read().decode('utf-8')
    +...
    +
    +
    +

    The following example uses no proxies at all, overriding environment settings:

    +
    >>> import urllib.request
    +>>> opener = urllib.request.FancyURLopener({})
    +>>> with opener.open("http://www.python.org/") as f:
    +...     f.read().decode('utf-8')
    +...
    +
    +
    +
    +
    +

    Legacy interface

    +

    The following functions and classes are ported from the Python 2 module +urllib (as opposed to urllib2). They might become deprecated at +some point in the future.

    +
    +
    +urllib.request.urlretrieve(url, filename=None, reporthook=None, data=None)
    +

    Copy a network object denoted by a URL to a local file. If the URL +points to a local file, the object will not be copied unless filename is supplied. +Return a tuple (filename, headers) where filename is the +local file name under which the object can be found, and headers is whatever +the info() method of the object returned by urlopen() returned (for +a remote object). Exceptions are the same as for urlopen().

    +

    The second argument, if present, specifies the file location to copy to (if +absent, the location will be a tempfile with a generated name). The third +argument, if present, is a callable that will be called once on +establishment of the network connection and once after each block read +thereafter. The callable will be passed three arguments; a count of blocks +transferred so far, a block size in bytes, and the total size of the file. The +third argument may be -1 on older FTP servers which do not return a file +size in response to a retrieval request.

    +

    The following example illustrates the most common usage scenario:

    +
    >>> import urllib.request
    +>>> local_filename, headers = urllib.request.urlretrieve('http://python.org/')
    +>>> html = open(local_filename)
    +>>> html.close()
    +
    +
    +

    If the url uses the http: scheme identifier, the optional data +argument may be given to specify a POST request (normally the request +type is GET). The data argument must be a bytes object in standard +application/x-www-form-urlencoded format; see the +urllib.parse.urlencode() function.

    +

    urlretrieve() will raise ContentTooShortError when it detects that +the amount of data available was less than the expected amount (which is the +size reported by a Content-Length header). This can occur, for example, when +the download is interrupted.

    +

    The Content-Length is treated as a lower bound: if there’s more data to read, +urlretrieve reads more data, but if less data is available, it raises the +exception.

    +

    You can still retrieve the downloaded data in this case, it is stored in the +content attribute of the exception instance.

    +

    If no Content-Length header was supplied, urlretrieve can not check the size +of the data it has downloaded, and just returns it. In this case you just have +to assume that the download was successful.

    +
    + +
    +
    +urllib.request.urlcleanup()
    +

    Cleans up temporary files that may have been left behind by previous +calls to urlretrieve().

    +
    + +
    +
    +class urllib.request.URLopener(proxies=None, **x509)
    +
    +

    Deprecated since version 3.3.

    +
    +

    Base class for opening and reading URLs. Unless you need to support opening +objects using schemes other than http:, ftp:, or file:, +you probably want to use FancyURLopener.

    +

    By default, the URLopener class sends a User-Agent header +of urllib/VVV, where VVV is the urllib version number. +Applications can define their own User-Agent header by subclassing +URLopener or FancyURLopener and setting the class attribute +version to an appropriate string value in the subclass definition.

    +

    The optional proxies parameter should be a dictionary mapping scheme names to +proxy URLs, where an empty dictionary turns proxies off completely. Its default +value is None, in which case environmental proxy settings will be used if +present, as discussed in the definition of urlopen(), above.

    +

    Additional keyword parameters, collected in x509, may be used for +authentication of the client when using the https: scheme. The keywords +key_file and cert_file are supported to provide an SSL key and certificate; +both are needed to support client authentication.

    +

    URLopener objects will raise an OSError exception if the server +returns an error code.

    +
    +
    +open(fullurl, data=None)
    +

    Open fullurl using the appropriate protocol. This method sets up cache and +proxy information, then calls the appropriate open method with its input +arguments. If the scheme is not recognized, open_unknown() is called. +The data argument has the same meaning as the data argument of +urlopen().

    +

    This method always quotes fullurl using quote().

    +
    + +
    +
    +open_unknown(fullurl, data=None)
    +

    Overridable interface to open unknown URL types.

    +
    + +
    +
    +retrieve(url, filename=None, reporthook=None, data=None)
    +

    Retrieves the contents of url and places it in filename. The return value +is a tuple consisting of a local filename and either an +email.message.Message object containing the response headers (for remote +URLs) or None (for local URLs). The caller must then open and read the +contents of filename. If filename is not given and the URL refers to a +local file, the input filename is returned. If the URL is non-local and +filename is not given, the filename is the output of tempfile.mktemp() +with a suffix that matches the suffix of the last path component of the input +URL. If reporthook is given, it must be a function accepting three numeric +parameters: A chunk number, the maximum size chunks are read in and the total size of the download +(-1 if unknown). It will be called once at the start and after each chunk of data is read from the +network. reporthook is ignored for local URLs.

    +

    If the url uses the http: scheme identifier, the optional data +argument may be given to specify a POST request (normally the request type +is GET). The data argument must in standard +application/x-www-form-urlencoded format; see the +urllib.parse.urlencode() function.

    +
    + +
    +
    +version
    +

    Variable that specifies the user agent of the opener object. To get +urllib to tell servers that it is a particular user agent, set this in a +subclass as a class variable or in the constructor before calling the base +constructor.

    +
    + +
    + +
    +
    +class urllib.request.FancyURLopener(...)
    +
    +

    Deprecated since version 3.3.

    +
    +

    FancyURLopener subclasses URLopener providing default handling +for the following HTTP response codes: 301, 302, 303, 307 and 401. For the 30x +response codes listed above, the Location header is used to fetch +the actual URL. For 401 response codes (authentication required), basic HTTP +authentication is performed. For the 30x response codes, recursion is bounded +by the value of the maxtries attribute, which defaults to 10.

    +

    For all other response codes, the method http_error_default() is called +which you can override in subclasses to handle the error appropriately.

    +
    +

    Note

    +

    According to the letter of RFC 2616, 301 and 302 responses to POST requests +must not be automatically redirected without confirmation by the user. In +reality, browsers do allow automatic redirection of these responses, changing +the POST to a GET, and urllib reproduces this behaviour.

    +
    +

    The parameters to the constructor are the same as those for URLopener.

    +
    +

    Note

    +

    When performing basic authentication, a FancyURLopener instance calls +its prompt_user_passwd() method. The default implementation asks the +users for the required information on the controlling terminal. A subclass may +override this method to support more appropriate behavior if needed.

    +
    +

    The FancyURLopener class offers one additional method that should be +overloaded to provide the appropriate behavior:

    +
    +
    +prompt_user_passwd(host, realm)
    +

    Return information needed to authenticate the user at the given host in the +specified security realm. The return value should be a tuple, (user, +password), which can be used for basic authentication.

    +

    The implementation prompts for this information on the terminal; an application +should override this method to use an appropriate interaction model in the local +environment.

    +
    + +
    + +
    +
    +

    urllib.request Restrictions

    +
    +
    +
      +
    • Currently, only the following protocols are supported: HTTP (versions 0.9 and +1.0), FTP, local files, and data URLs.

      +
      +

      Changed in version 3.4: Added support for data URLs.

      +
      +
    • +
    • The caching feature of urlretrieve() has been disabled until someone +finds the time to hack proper processing of Expiration time headers.

    • +
    • There should be a function to query whether a particular URL is in the cache.

    • +
    • For backward compatibility, if a URL appears to point to a local file but the +file can’t be opened, the URL is re-interpreted using the FTP protocol. This +can sometimes cause confusing error messages.

    • +
    • The urlopen() and urlretrieve() functions can cause arbitrarily +long delays while waiting for a network connection to be set up. This means +that it is difficult to build an interactive Web client using these functions +without using threads.

      +
    • +
    • The data returned by urlopen() or urlretrieve() is the raw data +returned by the server. This may be binary data (such as an image), plain text +or (for example) HTML. The HTTP protocol provides type information in the reply +header, which can be inspected by looking at the Content-Type +header. If the returned data is HTML, you can use the module +html.parser to parse it.

      +
    • +
    • The code handling the FTP protocol cannot differentiate between a file and a +directory. This can lead to unexpected behavior when attempting to read a URL +that points to a file that is not accessible. If the URL ends in a /, it is +assumed to refer to a directory and will be handled accordingly. But if an +attempt to read a file leads to a 550 error (meaning the URL cannot be found or +is not accessible, often for permission reasons), then the path is treated as a +directory in order to handle the case when a directory is specified by a URL but +the trailing / has been left off. This can cause misleading results when +you try to fetch a file whose read permissions make it inaccessible; the FTP +code will try to read it, fail with a 550 error, and then perform a directory +listing for the unreadable file. If fine-grained control is needed, consider +using the ftplib module, subclassing FancyURLopener, or changing +_urlopener to meet your needs.

    • +
    +
    +
    +
    +

    urllib.response — Response classes used by urllib

    +

    The urllib.response module defines functions and classes which define a +minimal file like interface, including read() and readline(). The +typical response object is an addinfourl instance, which defines an info() +method and that returns headers and a geturl() method that returns the url. +Functions defined by this module are used internally by the +urllib.request module.

    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/urllib.robotparser.html b/python-3.7.4-docs-html/library/urllib.robotparser.html new file mode 100644 index 0000000..1a3ec7a --- /dev/null +++ b/python-3.7.4-docs-html/library/urllib.robotparser.html @@ -0,0 +1,281 @@ + + + + + + + urllib.robotparser — Parser for robots.txt — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    urllib.robotparser — Parser for robots.txt

    +

    Source code: Lib/urllib/robotparser.py

    +
    +

    This module provides a single class, RobotFileParser, which answers +questions about whether or not a particular user agent can fetch a URL on the +Web site that published the robots.txt file. For more details on the +structure of robots.txt files, see http://www.robotstxt.org/orig.html.

    +
    +
    +class urllib.robotparser.RobotFileParser(url='')
    +

    This class provides methods to read, parse and answer questions about the +robots.txt file at url.

    +
    +
    +set_url(url)
    +

    Sets the URL referring to a robots.txt file.

    +
    + +
    +
    +read()
    +

    Reads the robots.txt URL and feeds it to the parser.

    +
    + +
    +
    +parse(lines)
    +

    Parses the lines argument.

    +
    + +
    +
    +can_fetch(useragent, url)
    +

    Returns True if the useragent is allowed to fetch the url +according to the rules contained in the parsed robots.txt +file.

    +
    + +
    +
    +mtime()
    +

    Returns the time the robots.txt file was last fetched. This is +useful for long-running web spiders that need to check for new +robots.txt files periodically.

    +
    + +
    +
    +modified()
    +

    Sets the time the robots.txt file was last fetched to the current +time.

    +
    + +
    +
    +crawl_delay(useragent)
    +

    Returns the value of the Crawl-delay parameter from robots.txt +for the useragent in question. If there is no such parameter or it +doesn’t apply to the useragent specified or the robots.txt entry +for this parameter has invalid syntax, return None.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +request_rate(useragent)
    +

    Returns the contents of the Request-rate parameter from +robots.txt as a named tuple RequestRate(requests, seconds). +If there is no such parameter or it doesn’t apply to the useragent +specified or the robots.txt entry for this parameter has invalid +syntax, return None.

    +
    +

    New in version 3.6.

    +
    +
    + +
    + +

    The following example demonstrates basic use of the RobotFileParser +class:

    +
    >>> import urllib.robotparser
    +>>> rp = urllib.robotparser.RobotFileParser()
    +>>> rp.set_url("http://www.musi-cal.com/robots.txt")
    +>>> rp.read()
    +>>> rrate = rp.request_rate("*")
    +>>> rrate.requests
    +3
    +>>> rrate.seconds
    +20
    +>>> rp.crawl_delay("*")
    +6
    +>>> rp.can_fetch("*", "http://www.musi-cal.com/cgi-bin/search?city=San+Francisco")
    +False
    +>>> rp.can_fetch("*", "http://www.musi-cal.com/")
    +True
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/uu.html b/python-3.7.4-docs-html/library/uu.html new file mode 100644 index 0000000..634a3a9 --- /dev/null +++ b/python-3.7.4-docs-html/library/uu.html @@ -0,0 +1,236 @@ + + + + + + + uu — Encode and decode uuencode files — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    uu — Encode and decode uuencode files

    +

    Source code: Lib/uu.py

    +
    +

    This module encodes and decodes files in uuencode format, allowing arbitrary +binary data to be transferred over ASCII-only connections. Wherever a file +argument is expected, the methods accept a file-like object. For backwards +compatibility, a string containing a pathname is also accepted, and the +corresponding file will be opened for reading and writing; the pathname '-' +is understood to mean the standard input or output. However, this interface is +deprecated; it’s better for the caller to open the file itself, and be sure +that, when required, the mode is 'rb' or 'wb' on Windows.

    +

    This code was contributed by Lance Ellinghouse, and modified by Jack Jansen.

    +

    The uu module defines the following functions:

    +
    +
    +uu.encode(in_file, out_file, name=None, mode=None, *, backtick=False)
    +

    Uuencode file in_file into file out_file. The uuencoded file will have +the header specifying name and mode as the defaults for the results of +decoding the file. The default defaults are taken from in_file, or '-' +and 0o666 respectively. If backtick is true, zeros are represented by +'`' instead of spaces.

    +
    +

    Changed in version 3.7: Added the backtick parameter.

    +
    +
    + +
    +
    +uu.decode(in_file, out_file=None, mode=None, quiet=False)
    +

    This call decodes uuencoded file in_file placing the result on file +out_file. If out_file is a pathname, mode is used to set the permission +bits if the file must be created. Defaults for out_file and mode are taken +from the uuencode header. However, if the file specified in the header already +exists, a uu.Error is raised.

    +

    decode() may print a warning to standard error if the input was produced +by an incorrect uuencoder and Python could recover from that error. Setting +quiet to a true value silences this warning.

    +
    + +
    +
    +exception uu.Error
    +

    Subclass of Exception, this can be raised by uu.decode() under +various situations, such as described above, but also including a badly +formatted header, or truncated input file.

    +
    + +
    +

    See also

    +
    +
    Module binascii

    Support module containing ASCII-to-binary and binary-to-ASCII conversions.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/uuid.html b/python-3.7.4-docs-html/library/uuid.html new file mode 100644 index 0000000..f52bbe4 --- /dev/null +++ b/python-3.7.4-docs-html/library/uuid.html @@ -0,0 +1,517 @@ + + + + + + + uuid — UUID objects according to RFC 4122 — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    uuid — UUID objects according to RFC 4122

    +

    Source code: Lib/uuid.py

    +
    +

    This module provides immutable UUID objects (the UUID class) +and the functions uuid1(), uuid3(), uuid4(), uuid5() for +generating version 1, 3, 4, and 5 UUIDs as specified in RFC 4122.

    +

    If all you want is a unique ID, you should probably call uuid1() or +uuid4(). Note that uuid1() may compromise privacy since it creates +a UUID containing the computer’s network address. uuid4() creates a +random UUID.

    +

    Depending on support from the underlying platform, uuid1() may or may +not return a “safe” UUID. A safe UUID is one which is generated using +synchronization methods that ensure no two processes can obtain the same +UUID. All instances of UUID have an is_safe attribute +which relays any information about the UUID’s safety, using this enumeration:

    +
    +
    +class uuid.SafeUUID
    +
    +

    New in version 3.7.

    +
    +
    +
    +safe
    +

    The UUID was generated by the platform in a multiprocessing-safe way.

    +
    + +
    +
    +unsafe
    +

    The UUID was not generated in a multiprocessing-safe way.

    +
    + +
    +
    +unknown
    +

    The platform does not provide information on whether the UUID was +generated safely or not.

    +
    + +
    + +
    +
    +class uuid.UUID(hex=None, bytes=None, bytes_le=None, fields=None, int=None, version=None, *, is_safe=SafeUUID.unknown)
    +

    Create a UUID from either a string of 32 hexadecimal digits, a string of 16 +bytes in big-endian order as the bytes argument, a string of 16 bytes in +little-endian order as the bytes_le argument, a tuple of six integers +(32-bit time_low, 16-bit time_mid, 16-bit time_hi_version, +8-bit clock_seq_hi_variant, 8-bit clock_seq_low, 48-bit node) as the +fields argument, or a single 128-bit integer as the int argument. +When a string of hex digits is given, curly braces, hyphens, +and a URN prefix are all optional. For example, these +expressions all yield the same UUID:

    +
    UUID('{12345678-1234-5678-1234-567812345678}')
    +UUID('12345678123456781234567812345678')
    +UUID('urn:uuid:12345678-1234-5678-1234-567812345678')
    +UUID(bytes=b'\x12\x34\x56\x78'*4)
    +UUID(bytes_le=b'\x78\x56\x34\x12\x34\x12\x78\x56' +
    +              b'\x12\x34\x56\x78\x12\x34\x56\x78')
    +UUID(fields=(0x12345678, 0x1234, 0x5678, 0x12, 0x34, 0x567812345678))
    +UUID(int=0x12345678123456781234567812345678)
    +
    +
    +

    Exactly one of hex, bytes, bytes_le, fields, or int must be given. +The version argument is optional; if given, the resulting UUID will have its +variant and version number set according to RFC 4122, overriding bits in the +given hex, bytes, bytes_le, fields, or int.

    +

    Comparison of UUID objects are made by way of comparing their +UUID.int attributes. Comparison with a non-UUID object +raises a TypeError.

    +

    str(uuid) returns a string in the form +12345678-1234-5678-1234-567812345678 where the 32 hexadecimal digits +represent the UUID.

    +
    + +

    UUID instances have these read-only attributes:

    +
    +
    +UUID.bytes
    +

    The UUID as a 16-byte string (containing the six integer fields in big-endian +byte order).

    +
    + +
    +
    +UUID.bytes_le
    +

    The UUID as a 16-byte string (with time_low, time_mid, and time_hi_version +in little-endian byte order).

    +
    + +
    +
    +UUID.fields
    +

    A tuple of the six integer fields of the UUID, which are also available as six +individual attributes and two derived attributes:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Field

    Meaning

    time_low

    the first 32 bits of the UUID

    time_mid

    the next 16 bits of the UUID

    time_hi_version

    the next 16 bits of the UUID

    clock_seq_hi_variant

    the next 8 bits of the UUID

    clock_seq_low

    the next 8 bits of the UUID

    node

    the last 48 bits of the UUID

    time

    the 60-bit timestamp

    clock_seq

    the 14-bit sequence number

    +
    + +
    +
    +UUID.hex
    +

    The UUID as a 32-character hexadecimal string.

    +
    + +
    +
    +UUID.int
    +

    The UUID as a 128-bit integer.

    +
    + +
    +
    +UUID.urn
    +

    The UUID as a URN as specified in RFC 4122.

    +
    + +
    +
    +UUID.variant
    +

    The UUID variant, which determines the internal layout of the UUID. This will be +one of the constants RESERVED_NCS, RFC_4122, +RESERVED_MICROSOFT, or RESERVED_FUTURE.

    +
    + +
    +
    +UUID.version
    +

    The UUID version number (1 through 5, meaningful only when the variant is +RFC_4122).

    +
    + +
    +
    +UUID.is_safe
    +

    An enumeration of SafeUUID which indicates whether the platform +generated the UUID in a multiprocessing-safe way.

    +
    +

    New in version 3.7.

    +
    +
    + +

    The uuid module defines the following functions:

    +
    +
    +uuid.getnode()
    +

    Get the hardware address as a 48-bit positive integer. The first time this +runs, it may launch a separate program, which could be quite slow. If all +attempts to obtain the hardware address fail, we choose a random 48-bit +number with the multicast bit (least significant bit of the first octet) +set to 1 as recommended in RFC 4122. “Hardware address” means the MAC +address of a network interface. On a machine with multiple network +interfaces, universally administered MAC addresses (i.e. where the second +least significant bit of the first octet is unset) will be preferred over +locally administered MAC addresses, but with no other ordering guarantees.

    +
    +

    Changed in version 3.7: Universally administered MAC addresses are preferred over locally +administered MAC addresses, since the former are guaranteed to be +globally unique, while the latter are not.

    +
    +
    + +
    +
    +uuid.uuid1(node=None, clock_seq=None)
    +

    Generate a UUID from a host ID, sequence number, and the current time. If node +is not given, getnode() is used to obtain the hardware address. If +clock_seq is given, it is used as the sequence number; otherwise a random +14-bit sequence number is chosen.

    +
    + +
    +
    +uuid.uuid3(namespace, name)
    +

    Generate a UUID based on the MD5 hash of a namespace identifier (which is a +UUID) and a name (which is a string).

    +
    + +
    +
    +uuid.uuid4()
    +

    Generate a random UUID.

    +
    + +
    +
    +uuid.uuid5(namespace, name)
    +

    Generate a UUID based on the SHA-1 hash of a namespace identifier (which is a +UUID) and a name (which is a string).

    +
    + +

    The uuid module defines the following namespace identifiers for use with +uuid3() or uuid5().

    +
    +
    +uuid.NAMESPACE_DNS
    +

    When this namespace is specified, the name string is a fully-qualified domain +name.

    +
    + +
    +
    +uuid.NAMESPACE_URL
    +

    When this namespace is specified, the name string is a URL.

    +
    + +
    +
    +uuid.NAMESPACE_OID
    +

    When this namespace is specified, the name string is an ISO OID.

    +
    + +
    +
    +uuid.NAMESPACE_X500
    +

    When this namespace is specified, the name string is an X.500 DN in DER or a +text output format.

    +
    + +

    The uuid module defines the following constants for the possible values +of the variant attribute:

    +
    +
    +uuid.RESERVED_NCS
    +

    Reserved for NCS compatibility.

    +
    + +
    +
    +uuid.RFC_4122
    +

    Specifies the UUID layout given in RFC 4122.

    +
    + +
    +
    +uuid.RESERVED_MICROSOFT
    +

    Reserved for Microsoft compatibility.

    +
    + +
    +
    +uuid.RESERVED_FUTURE
    +

    Reserved for future definition.

    +
    + +
    +

    See also

    +
    +
    RFC 4122 - A Universally Unique IDentifier (UUID) URN Namespace

    This specification defines a Uniform Resource Name namespace for UUIDs, the +internal format of UUIDs, and methods of generating UUIDs.

    +
    +
    +
    +
    +

    Example

    +

    Here are some examples of typical usage of the uuid module:

    +
    >>> import uuid
    +
    +>>> # make a UUID based on the host ID and current time
    +>>> uuid.uuid1()
    +UUID('a8098c1a-f86e-11da-bd1a-00112444be1e')
    +
    +>>> # make a UUID using an MD5 hash of a namespace UUID and a name
    +>>> uuid.uuid3(uuid.NAMESPACE_DNS, 'python.org')
    +UUID('6fa459ea-ee8a-3ca4-894e-db77e160355e')
    +
    +>>> # make a random UUID
    +>>> uuid.uuid4()
    +UUID('16fd2706-8baf-433b-82eb-8c7fada847da')
    +
    +>>> # make a UUID using a SHA-1 hash of a namespace UUID and a name
    +>>> uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org')
    +UUID('886313e1-3b8a-5372-9b90-0c9aee199e5d')
    +
    +>>> # make a UUID from a string of hex digits (braces and hyphens ignored)
    +>>> x = uuid.UUID('{00010203-0405-0607-0809-0a0b0c0d0e0f}')
    +
    +>>> # convert a UUID to a string of hex digits in standard form
    +>>> str(x)
    +'00010203-0405-0607-0809-0a0b0c0d0e0f'
    +
    +>>> # get the raw 16 bytes of the UUID
    +>>> x.bytes
    +b'\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\r\x0e\x0f'
    +
    +>>> # make a UUID from a 16-byte string
    +>>> uuid.UUID(bytes=x.bytes)
    +UUID('00010203-0405-0607-0809-0a0b0c0d0e0f')
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/venv.html b/python-3.7.4-docs-html/library/venv.html new file mode 100644 index 0000000..bea5df6 --- /dev/null +++ b/python-3.7.4-docs-html/library/venv.html @@ -0,0 +1,780 @@ + + + + + + + venv — Creation of virtual environments — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    venv — Creation of virtual environments

    +
    +

    New in version 3.3.

    +
    +

    Source code: Lib/venv/

    +
    +

    The venv module provides support for creating lightweight “virtual +environments” with their own site directories, optionally isolated from system +site directories. Each virtual environment has its own Python binary (which +matches the version of the binary that was used to create this environment) and +can have its own independent set of installed Python packages in its site +directories.

    +

    See PEP 405 for more information about Python virtual environments.

    + +
    +

    Note

    +

    The pyvenv script has been deprecated as of Python 3.6 in favor of using +python3 -m venv to help prevent any potential confusion as to which +Python interpreter a virtual environment will be based on.

    +
    +
    +

    Creating virtual environments

    +

    Creation of virtual environments is done by executing the +command venv:

    +
    python3 -m venv /path/to/new/virtual/environment
    +
    +
    +

    Running this command creates the target directory (creating any parent +directories that don’t exist already) and places a pyvenv.cfg file in it +with a home key pointing to the Python installation from which the command +was run. It also creates a bin (or Scripts on Windows) subdirectory +containing a copy/symlink of the Python binary/binaries (as appropriate for the +platform or arguments used at environment creation time). It also creates an +(initially empty) lib/pythonX.Y/site-packages subdirectory +(on Windows, this is Lib\site-packages). If an existing +directory is specified, it will be re-used.

    +
    +

    Deprecated since version 3.6: pyvenv was the recommended tool for creating virtual environments for +Python 3.3 and 3.4, and is deprecated in Python 3.6.

    +
    +
    +

    Changed in version 3.5: The use of venv is now recommended for creating virtual environments.

    +
    +

    On Windows, invoke the venv command as follows:

    +
    c:\>c:\Python35\python -m venv c:\path\to\myenv
    +
    +
    +

    Alternatively, if you configured the PATH and PATHEXT variables for +your Python installation:

    +
    c:\>python -m venv c:\path\to\myenv
    +
    +
    +

    The command, if run with -h, will show the available options:

    +
    usage: venv [-h] [--system-site-packages] [--symlinks | --copies] [--clear]
    +            [--upgrade] [--without-pip] [--prompt PROMPT]
    +            ENV_DIR [ENV_DIR ...]
    +
    +Creates virtual Python environments in one or more target directories.
    +
    +positional arguments:
    +  ENV_DIR               A directory to create the environment in.
    +
    +optional arguments:
    +  -h, --help            show this help message and exit
    +  --system-site-packages
    +                        Give the virtual environment access to the system
    +                        site-packages dir.
    +  --symlinks            Try to use symlinks rather than copies, when symlinks
    +                        are not the default for the platform.
    +  --copies              Try to use copies rather than symlinks, even when
    +                        symlinks are the default for the platform.
    +  --clear               Delete the contents of the environment directory if it
    +                        already exists, before environment creation.
    +  --upgrade             Upgrade the environment directory to use this version
    +                        of Python, assuming Python has been upgraded in-place.
    +  --without-pip         Skips installing or upgrading pip in the virtual
    +                        environment (pip is bootstrapped by default)
    +  --prompt PROMPT       Provides an alternative prompt prefix for this
    +                        environment.
    +
    +Once an environment has been created, you may wish to activate it, e.g. by
    +sourcing an activate script in its bin directory.
    +
    +
    +
    +

    Changed in version 3.4: Installs pip by default, added the --without-pip and --copies +options

    +
    +
    +

    Changed in version 3.4: In earlier versions, if the target directory already existed, an error was +raised, unless the --clear or --upgrade option was provided.

    +
    +
    +

    Note

    +

    While symlinks are supported on Windows, they are not recommended. Of +particular note is that double-clicking python.exe in File Explorer +will resolve the symlink eagerly and ignore the virtual environment.

    +
    +

    The created pyvenv.cfg file also includes the +include-system-site-packages key, set to true if venv is +run with the --system-site-packages option, false otherwise.

    +

    Unless the --without-pip option is given, ensurepip will be +invoked to bootstrap pip into the virtual environment.

    +

    Multiple paths can be given to venv, in which case an identical virtual +environment will be created, according to the given options, at each provided +path.

    +

    Once a virtual environment has been created, it can be “activated” using a +script in the virtual environment’s binary directory. The invocation of the +script is platform-specific (<venv> must be replaced by the path of the +directory containing the virtual environment):

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Platform

    Shell

    Command to activate virtual environment

    Posix

    bash/zsh

    $ source <venv>/bin/activate

    fish

    $ . <venv>/bin/activate.fish

    csh/tcsh

    $ source <venv>/bin/activate.csh

    Windows

    cmd.exe

    C:\> <venv>\Scripts\activate.bat

    PowerShell

    PS C:\> <venv>\Scripts\Activate.ps1

    +

    You don’t specifically need to activate an environment; activation just +prepends the virtual environment’s binary directory to your path, so that +“python” invokes the virtual environment’s Python interpreter and you can run +installed scripts without having to use their full path. However, all scripts +installed in a virtual environment should be runnable without activating it, +and run with the virtual environment’s Python automatically.

    +

    You can deactivate a virtual environment by typing “deactivate” in your shell. +The exact mechanism is platform-specific: for example, the Bash activation +script defines a “deactivate” function, whereas on Windows there are separate +scripts called deactivate.bat and Deactivate.ps1 which are installed +when the virtual environment is created.

    +
    +

    New in version 3.4: fish and csh activation scripts.

    +
    +
    +

    Note

    +

    A virtual environment is a Python environment such that the Python +interpreter, libraries and scripts installed into it are isolated from those +installed in other virtual environments, and (by default) any libraries +installed in a “system” Python, i.e., one which is installed as part of your +operating system.

    +

    A virtual environment is a directory tree which contains Python executable +files and other files which indicate that it is a virtual environment.

    +

    Common installation tools such as Setuptools and pip work as +expected with virtual environments. In other words, when a virtual +environment is active, they install Python packages into the virtual +environment without needing to be told to do so explicitly.

    +

    When a virtual environment is active (i.e., the virtual environment’s Python +interpreter is running), the attributes sys.prefix and +sys.exec_prefix point to the base directory of the virtual +environment, whereas sys.base_prefix and +sys.base_exec_prefix point to the non-virtual environment Python +installation which was used to create the virtual environment. If a virtual +environment is not active, then sys.prefix is the same as +sys.base_prefix and sys.exec_prefix is the same as +sys.base_exec_prefix (they all point to a non-virtual environment +Python installation).

    +

    When a virtual environment is active, any options that change the +installation path will be ignored from all distutils configuration files to +prevent projects being inadvertently installed outside of the virtual +environment.

    +

    When working in a command shell, users can make a virtual environment active +by running an activate script in the virtual environment’s executables +directory (the precise filename is shell-dependent), which prepends the +virtual environment’s directory for executables to the PATH environment +variable for the running shell. There should be no need in other +circumstances to activate a virtual environment—scripts installed into +virtual environments have a “shebang” line which points to the virtual +environment’s Python interpreter. This means that the script will run with +that interpreter regardless of the value of PATH. On Windows, “shebang” +line processing is supported if you have the Python Launcher for Windows +installed (this was added to Python in 3.3 - see PEP 397 for more +details). Thus, double-clicking an installed script in a Windows Explorer +window should run the script with the correct interpreter without there +needing to be any reference to its virtual environment in PATH.

    +
    +
    +
    +

    API

    +

    The high-level method described above makes use of a simple API which provides +mechanisms for third-party virtual environment creators to customize environment +creation according to their needs, the EnvBuilder class.

    +
    +
    +class venv.EnvBuilder(system_site_packages=False, clear=False, symlinks=False, upgrade=False, with_pip=False, prompt=None)
    +

    The EnvBuilder class accepts the following keyword arguments on +instantiation:

    +
      +
    • system_site_packages – a Boolean value indicating that the system Python +site-packages should be available to the environment (defaults to False).

    • +
    • clear – a Boolean value which, if true, will delete the contents of +any existing target directory, before creating the environment.

    • +
    • symlinks – a Boolean value indicating whether to attempt to symlink the +Python binary rather than copying.

    • +
    • upgrade – a Boolean value which, if true, will upgrade an existing +environment with the running Python - for use when that Python has been +upgraded in-place (defaults to False).

    • +
    • with_pip – a Boolean value which, if true, ensures pip is +installed in the virtual environment. This uses ensurepip with +the --default-pip option.

    • +
    • prompt – a String to be used after virtual environment is activated +(defaults to None which means directory name of the environment would +be used).

    • +
    +
    +

    Changed in version 3.4: Added the with_pip parameter

    +
    +
    +

    New in version 3.6: Added the prompt parameter

    +
    +

    Creators of third-party virtual environment tools will be free to use the +provided EnvBuilder class as a base class.

    +

    The returned env-builder is an object which has a method, create:

    +
    +
    +create(env_dir)
    +

    This method takes as required argument the path (absolute or relative to +the current directory) of the target directory which is to contain the +virtual environment. The create method will either create the +environment in the specified directory, or raise an appropriate +exception.

    +

    The create method of the EnvBuilder class illustrates the hooks +available for subclass customization:

    +
    def create(self, env_dir):
    +    """
    +    Create a virtualized Python environment in a directory.
    +    env_dir is the target directory to create an environment in.
    +    """
    +    env_dir = os.path.abspath(env_dir)
    +    context = self.ensure_directories(env_dir)
    +    self.create_configuration(context)
    +    self.setup_python(context)
    +    self.setup_scripts(context)
    +    self.post_setup(context)
    +
    +
    +

    Each of the methods ensure_directories(), +create_configuration(), setup_python(), +setup_scripts() and post_setup() can be overridden.

    +
    + +
    +
    +ensure_directories(env_dir)
    +

    Creates the environment directory and all necessary directories, and +returns a context object. This is just a holder for attributes (such as +paths), for use by the other methods. The directories are allowed to +exist already, as long as either clear or upgrade were +specified to allow operating on an existing environment directory.

    +
    + +
    +
    +create_configuration(context)
    +

    Creates the pyvenv.cfg configuration file in the environment.

    +
    + +
    +
    +setup_python(context)
    +

    Creates a copy or symlink to the Python executable in the environment. +On POSIX systems, if a specific executable python3.x was used, +symlinks to python and python3 will be created pointing to that +executable, unless files with those names already exist.

    +
    + +
    +
    +setup_scripts(context)
    +

    Installs activation scripts appropriate to the platform into the virtual +environment.

    +
    + +
    +
    +post_setup(context)
    +

    A placeholder method which can be overridden in third party +implementations to pre-install packages in the virtual environment or +perform other post-creation steps.

    +
    + +
    +

    Changed in version 3.7.2: Windows now uses redirector scripts for python[w].exe instead of +copying the actual binaries. In 3.7.2 only setup_python() does +nothing unless running from a build in the source tree.

    +
    +
    +

    Changed in version 3.7.3: Windows copies the redirector scripts as part of setup_python() +instead of setup_scripts(). This was not the case in 3.7.2. +When using symlinks, the original executables will be linked.

    +
    +

    In addition, EnvBuilder provides this utility method that can be +called from setup_scripts() or post_setup() in subclasses to +assist in installing custom scripts into the virtual environment.

    +
    +
    +install_scripts(context, path)
    +

    path is the path to a directory that should contain subdirectories +“common”, “posix”, “nt”, each containing scripts destined for the bin +directory in the environment. The contents of “common” and the +directory corresponding to os.name are copied after some text +replacement of placeholders:

    +
      +
    • __VENV_DIR__ is replaced with the absolute path of the environment +directory.

    • +
    • __VENV_NAME__ is replaced with the environment name (final path +segment of environment directory).

    • +
    • __VENV_PROMPT__ is replaced with the prompt (the environment +name surrounded by parentheses and with a following space)

    • +
    • __VENV_BIN_NAME__ is replaced with the name of the bin directory +(either bin or Scripts).

    • +
    • __VENV_PYTHON__ is replaced with the absolute path of the +environment’s executable.

    • +
    +

    The directories are allowed to exist (for when an existing environment +is being upgraded).

    +
    + +
    + +

    There is also a module-level convenience function:

    +
    +
    +venv.create(env_dir, system_site_packages=False, clear=False, symlinks=False, with_pip=False, prompt=None)
    +

    Create an EnvBuilder with the given keyword arguments, and call its +create() method with the env_dir argument.

    +
    +

    New in version 3.3.

    +
    +
    +

    Changed in version 3.4: Added the with_pip parameter

    +
    +
    +

    Changed in version 3.6: Added the prompt parameter

    +
    +
    + +
    +
    +

    An example of extending EnvBuilder

    +

    The following script shows how to extend EnvBuilder by implementing a +subclass which installs setuptools and pip into a created virtual environment:

    +
    import os
    +import os.path
    +from subprocess import Popen, PIPE
    +import sys
    +from threading import Thread
    +from urllib.parse import urlparse
    +from urllib.request import urlretrieve
    +import venv
    +
    +class ExtendedEnvBuilder(venv.EnvBuilder):
    +    """
    +    This builder installs setuptools and pip so that you can pip or
    +    easy_install other packages into the created virtual environment.
    +
    +    :param nodist: If True, setuptools and pip are not installed into the
    +                   created virtual environment.
    +    :param nopip: If True, pip is not installed into the created
    +                  virtual environment.
    +    :param progress: If setuptools or pip are installed, the progress of the
    +                     installation can be monitored by passing a progress
    +                     callable. If specified, it is called with two
    +                     arguments: a string indicating some progress, and a
    +                     context indicating where the string is coming from.
    +                     The context argument can have one of three values:
    +                     'main', indicating that it is called from virtualize()
    +                     itself, and 'stdout' and 'stderr', which are obtained
    +                     by reading lines from the output streams of a subprocess
    +                     which is used to install the app.
    +
    +                     If a callable is not specified, default progress
    +                     information is output to sys.stderr.
    +    """
    +
    +    def __init__(self, *args, **kwargs):
    +        self.nodist = kwargs.pop('nodist', False)
    +        self.nopip = kwargs.pop('nopip', False)
    +        self.progress = kwargs.pop('progress', None)
    +        self.verbose = kwargs.pop('verbose', False)
    +        super().__init__(*args, **kwargs)
    +
    +    def post_setup(self, context):
    +        """
    +        Set up any packages which need to be pre-installed into the
    +        virtual environment being created.
    +
    +        :param context: The information for the virtual environment
    +                        creation request being processed.
    +        """
    +        os.environ['VIRTUAL_ENV'] = context.env_dir
    +        if not self.nodist:
    +            self.install_setuptools(context)
    +        # Can't install pip without setuptools
    +        if not self.nopip and not self.nodist:
    +            self.install_pip(context)
    +
    +    def reader(self, stream, context):
    +        """
    +        Read lines from a subprocess' output stream and either pass to a progress
    +        callable (if specified) or write progress information to sys.stderr.
    +        """
    +        progress = self.progress
    +        while True:
    +            s = stream.readline()
    +            if not s:
    +                break
    +            if progress is not None:
    +                progress(s, context)
    +            else:
    +                if not self.verbose:
    +                    sys.stderr.write('.')
    +                else:
    +                    sys.stderr.write(s.decode('utf-8'))
    +                sys.stderr.flush()
    +        stream.close()
    +
    +    def install_script(self, context, name, url):
    +        _, _, path, _, _, _ = urlparse(url)
    +        fn = os.path.split(path)[-1]
    +        binpath = context.bin_path
    +        distpath = os.path.join(binpath, fn)
    +        # Download script into the virtual environment's binaries folder
    +        urlretrieve(url, distpath)
    +        progress = self.progress
    +        if self.verbose:
    +            term = '\n'
    +        else:
    +            term = ''
    +        if progress is not None:
    +            progress('Installing %s ...%s' % (name, term), 'main')
    +        else:
    +            sys.stderr.write('Installing %s ...%s' % (name, term))
    +            sys.stderr.flush()
    +        # Install in the virtual environment
    +        args = [context.env_exe, fn]
    +        p = Popen(args, stdout=PIPE, stderr=PIPE, cwd=binpath)
    +        t1 = Thread(target=self.reader, args=(p.stdout, 'stdout'))
    +        t1.start()
    +        t2 = Thread(target=self.reader, args=(p.stderr, 'stderr'))
    +        t2.start()
    +        p.wait()
    +        t1.join()
    +        t2.join()
    +        if progress is not None:
    +            progress('done.', 'main')
    +        else:
    +            sys.stderr.write('done.\n')
    +        # Clean up - no longer needed
    +        os.unlink(distpath)
    +
    +    def install_setuptools(self, context):
    +        """
    +        Install setuptools in the virtual environment.
    +
    +        :param context: The information for the virtual environment
    +                        creation request being processed.
    +        """
    +        url = 'https://bitbucket.org/pypa/setuptools/downloads/ez_setup.py'
    +        self.install_script(context, 'setuptools', url)
    +        # clear up the setuptools archive which gets downloaded
    +        pred = lambda o: o.startswith('setuptools-') and o.endswith('.tar.gz')
    +        files = filter(pred, os.listdir(context.bin_path))
    +        for f in files:
    +            f = os.path.join(context.bin_path, f)
    +            os.unlink(f)
    +
    +    def install_pip(self, context):
    +        """
    +        Install pip in the virtual environment.
    +
    +        :param context: The information for the virtual environment
    +                        creation request being processed.
    +        """
    +        url = 'https://raw.github.com/pypa/pip/master/contrib/get-pip.py'
    +        self.install_script(context, 'pip', url)
    +
    +def main(args=None):
    +    compatible = True
    +    if sys.version_info < (3, 3):
    +        compatible = False
    +    elif not hasattr(sys, 'base_prefix'):
    +        compatible = False
    +    if not compatible:
    +        raise ValueError('This script is only for use with '
    +                         'Python 3.3 or later')
    +    else:
    +        import argparse
    +
    +        parser = argparse.ArgumentParser(prog=__name__,
    +                                         description='Creates virtual Python '
    +                                                     'environments in one or '
    +                                                     'more target '
    +                                                     'directories.')
    +        parser.add_argument('dirs', metavar='ENV_DIR', nargs='+',
    +                            help='A directory in which to create the
    +                                 'virtual environment.')
    +        parser.add_argument('--no-setuptools', default=False,
    +                            action='store_true', dest='nodist',
    +                            help="Don't install setuptools or pip in the "
    +                                 "virtual environment.")
    +        parser.add_argument('--no-pip', default=False,
    +                            action='store_true', dest='nopip',
    +                            help="Don't install pip in the virtual "
    +                                 "environment.")
    +        parser.add_argument('--system-site-packages', default=False,
    +                            action='store_true', dest='system_site',
    +                            help='Give the virtual environment access to the '
    +                                 'system site-packages dir.')
    +        if os.name == 'nt':
    +            use_symlinks = False
    +        else:
    +            use_symlinks = True
    +        parser.add_argument('--symlinks', default=use_symlinks,
    +                            action='store_true', dest='symlinks',
    +                            help='Try to use symlinks rather than copies, '
    +                                 'when symlinks are not the default for '
    +                                 'the platform.')
    +        parser.add_argument('--clear', default=False, action='store_true',
    +                            dest='clear', help='Delete the contents of the '
    +                                               'virtual environment '
    +                                               'directory if it already '
    +                                               'exists, before virtual '
    +                                               'environment creation.')
    +        parser.add_argument('--upgrade', default=False, action='store_true',
    +                            dest='upgrade', help='Upgrade the virtual '
    +                                                 'environment directory to '
    +                                                 'use this version of '
    +                                                 'Python, assuming Python '
    +                                                 'has been upgraded '
    +                                                 'in-place.')
    +        parser.add_argument('--verbose', default=False, action='store_true',
    +                            dest='verbose', help='Display the output '
    +                                               'from the scripts which '
    +                                               'install setuptools and pip.')
    +        options = parser.parse_args(args)
    +        if options.upgrade and options.clear:
    +            raise ValueError('you cannot supply --upgrade and --clear together.')
    +        builder = ExtendedEnvBuilder(system_site_packages=options.system_site,
    +                                       clear=options.clear,
    +                                       symlinks=options.symlinks,
    +                                       upgrade=options.upgrade,
    +                                       nodist=options.nodist,
    +                                       nopip=options.nopip,
    +                                       verbose=options.verbose)
    +        for d in options.dirs:
    +            builder.create(d)
    +
    +if __name__ == '__main__':
    +    rc = 1
    +    try:
    +        main()
    +        rc = 0
    +    except Exception as e:
    +        print('Error: %s' % e, file=sys.stderr)
    +    sys.exit(rc)
    +
    +
    +

    This script is also available for download online.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/warnings.html b/python-3.7.4-docs-html/library/warnings.html new file mode 100644 index 0000000..1c54aab --- /dev/null +++ b/python-3.7.4-docs-html/library/warnings.html @@ -0,0 +1,689 @@ + + + + + + + warnings — Warning control — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    warnings — Warning control

    +

    Source code: Lib/warnings.py

    +
    +

    Warning messages are typically issued in situations where it is useful to alert +the user of some condition in a program, where that condition (normally) doesn’t +warrant raising an exception and terminating the program. For example, one +might want to issue a warning when a program uses an obsolete module.

    +

    Python programmers issue warnings by calling the warn() function defined +in this module. (C programmers use PyErr_WarnEx(); see +Exception Handling for details).

    +

    Warning messages are normally written to sys.stderr, but their disposition +can be changed flexibly, from ignoring all warnings to turning them into +exceptions. The disposition of warnings can vary based on the warning category +(see below), the text of the warning message, and the source location where it +is issued. Repetitions of a particular warning for the same source location are +typically suppressed.

    +

    There are two stages in warning control: first, each time a warning is issued, a +determination is made whether a message should be issued or not; next, if a +message is to be issued, it is formatted and printed using a user-settable hook.

    +

    The determination whether to issue a warning message is controlled by the +warning filter, which is a sequence of matching rules and actions. Rules can be +added to the filter by calling filterwarnings() and reset to its default +state by calling resetwarnings().

    +

    The printing of warning messages is done by calling showwarning(), which +may be overridden; the default implementation of this function formats the +message by calling formatwarning(), which is also available for use by +custom implementations.

    +
    +

    See also

    +

    logging.captureWarnings() allows you to handle all warnings with +the standard logging infrastructure.

    +
    +
    +

    Warning Categories

    +

    There are a number of built-in exceptions that represent warning categories. +This categorization is useful to be able to filter out groups of warnings.

    +

    While these are technically +built-in exceptions, they are +documented here, because conceptually they belong to the warnings mechanism.

    +

    User code can define additional warning categories by subclassing one of the +standard warning categories. A warning category must always be a subclass of +the Warning class.

    +

    The following warnings category classes are currently defined:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Class

    Description

    Warning

    This is the base class of all warning +category classes. It is a subclass of +Exception.

    UserWarning

    The default category for warn().

    DeprecationWarning

    Base category for warnings about deprecated +features when those warnings are intended for +other Python developers (ignored by default, +unless triggered by code in __main__).

    SyntaxWarning

    Base category for warnings about dubious +syntactic features.

    RuntimeWarning

    Base category for warnings about dubious +runtime features.

    FutureWarning

    Base category for warnings about deprecated +features when those warnings are intended for +end users of applications that are written in +Python.

    PendingDeprecationWarning

    Base category for warnings about features +that will be deprecated in the future +(ignored by default).

    ImportWarning

    Base category for warnings triggered during +the process of importing a module (ignored by +default).

    UnicodeWarning

    Base category for warnings related to +Unicode.

    BytesWarning

    Base category for warnings related to +bytes and bytearray.

    ResourceWarning

    Base category for warnings related to +resource usage.

    +
    +

    Changed in version 3.7: Previously DeprecationWarning and FutureWarning were +distinguished based on whether a feature was being removed entirely or +changing its behaviour. They are now distinguished based on their +intended audience and the way they’re handled by the default warnings +filters.

    +
    +
    +
    +

    The Warnings Filter

    +

    The warnings filter controls whether warnings are ignored, displayed, or turned +into errors (raising an exception).

    +

    Conceptually, the warnings filter maintains an ordered list of filter +specifications; any specific warning is matched against each filter +specification in the list in turn until a match is found; the filter determines +the disposition of the match. Each entry is a tuple of the form (action, +message, category, module, lineno), where:

    +
      +
    • action is one of the following strings:

      + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + +

      Value

      Disposition

      "default"

      print the first occurrence of matching +warnings for each location (module + +line number) where the warning is issued

      "error"

      turn matching warnings into exceptions

      "ignore"

      never print matching warnings

      "always"

      always print matching warnings

      "module"

      print the first occurrence of matching +warnings for each module where the warning +is issued (regardless of line number)

      "once"

      print only the first occurrence of matching +warnings, regardless of location

      +
    • +
    • message is a string containing a regular expression that the start of +the warning message must match. The expression is compiled to always be +case-insensitive.

    • +
    • category is a class (a subclass of Warning) of which the warning +category must be a subclass in order to match.

    • +
    • module is a string containing a regular expression that the module name must +match. The expression is compiled to be case-sensitive.

    • +
    • lineno is an integer that the line number where the warning occurred must +match, or 0 to match all line numbers.

    • +
    +

    Since the Warning class is derived from the built-in Exception +class, to turn a warning into an error we simply raise category(message).

    +

    If a warning is reported and doesn’t match any registered filter then the +“default” action is applied (hence its name).

    +
    +

    Describing Warning Filters

    +

    The warnings filter is initialized by -W options passed to the Python +interpreter command line and the PYTHONWARNINGS environment variable. +The interpreter saves the arguments for all supplied entries without +interpretation in sys.warnoptions; the warnings module parses these +when it is first imported (invalid options are ignored, after printing a +message to sys.stderr).

    +

    Individual warnings filters are specified as a sequence of fields separated by +colons:

    +
    action:message:category:module:line
    +
    +
    +

    The meaning of each of these fields is as described in The Warnings Filter. +When listing multiple filters on a single line (as for +PYTHONWARNINGS), the individual filters are separated by commas,and +the filters listed later take precedence over those listed before them (as +they’re applied left-to-right, and the most recently applied filters take +precedence over earlier ones).

    +

    Commonly used warning filters apply to either all warnings, warnings in a +particular category, or warnings raised by particular modules or packages. +Some examples:

    +
    default                      # Show all warnings (even those ignored by default)
    +ignore                       # Ignore all warnings
    +error                        # Convert all warnings to errors
    +error::ResourceWarning       # Treat ResourceWarning messages as errors
    +default::DeprecationWarning  # Show DeprecationWarning messages
    +ignore,default:::mymodule    # Only report warnings triggered by "mymodule"
    +error:::mymodule[.*]         # Convert warnings to errors in "mymodule"
    +                             # and any subpackages of "mymodule"
    +
    +
    +
    +
    +

    Default Warning Filter

    +

    By default, Python installs several warning filters, which can be overridden by +the -W command-line option, the PYTHONWARNINGS environment +variable and calls to filterwarnings().

    +

    In regular release builds, the default warning filter has the following entries +(in order of precedence):

    +
    default::DeprecationWarning:__main__
    +ignore::DeprecationWarning
    +ignore::PendingDeprecationWarning
    +ignore::ImportWarning
    +ignore::ResourceWarning
    +
    +
    +

    In debug builds, the list of default warning filters is empty.

    +
    +

    Changed in version 3.2: DeprecationWarning is now ignored by default in addition to +PendingDeprecationWarning.

    +
    +
    +

    Changed in version 3.7: DeprecationWarning is once again shown by default when triggered +directly by code in __main__.

    +
    +
    +

    Changed in version 3.7: BytesWarning no longer appears in the default filter list and is +instead configured via sys.warnoptions when -b is specified +twice.

    +
    +
    +
    +

    Overriding the default filter

    +

    Developers of applications written in Python may wish to hide all Python level +warnings from their users by default, and only display them when running tests +or otherwise working on the application. The sys.warnoptions attribute +used to pass filter configurations to the interpreter can be used as a marker to +indicate whether or not warnings should be disabled:

    +
    import sys
    +
    +if not sys.warnoptions:
    +    import warnings
    +    warnings.simplefilter("ignore")
    +
    +
    +

    Developers of test runners for Python code are advised to instead ensure that +all warnings are displayed by default for the code under test, using code +like:

    +
    import sys
    +
    +if not sys.warnoptions:
    +    import os, warnings
    +    warnings.simplefilter("default") # Change the filter in this process
    +    os.environ["PYTHONWARNINGS"] = "default" # Also affect subprocesses
    +
    +
    +

    Finally, developers of interactive shells that run user code in a namespace +other than __main__ are advised to ensure that DeprecationWarning +messages are made visible by default, using code like the following (where +user_ns is the module used to execute code entered interactively):

    +
    import warnings
    +warnings.filterwarnings("default", category=DeprecationWarning,
    +                                   module=user_ns.get("__name__"))
    +
    +
    +
    +
    +
    +

    Temporarily Suppressing Warnings

    +

    If you are using code that you know will raise a warning, such as a deprecated +function, but do not want to see the warning (even when warnings have been +explicitly configured via the command line), then it is possible to suppress +the warning using the catch_warnings context manager:

    +
    import warnings
    +
    +def fxn():
    +    warnings.warn("deprecated", DeprecationWarning)
    +
    +with warnings.catch_warnings():
    +    warnings.simplefilter("ignore")
    +    fxn()
    +
    +
    +

    While within the context manager all warnings will simply be ignored. This +allows you to use known-deprecated code without having to see the warning while +not suppressing the warning for other code that might not be aware of its use +of deprecated code. Note: this can only be guaranteed in a single-threaded +application. If two or more threads use the catch_warnings context +manager at the same time, the behavior is undefined.

    +
    +
    +

    Testing Warnings

    +

    To test warnings raised by code, use the catch_warnings context +manager. With it you can temporarily mutate the warnings filter to facilitate +your testing. For instance, do the following to capture all raised warnings to +check:

    +
    import warnings
    +
    +def fxn():
    +    warnings.warn("deprecated", DeprecationWarning)
    +
    +with warnings.catch_warnings(record=True) as w:
    +    # Cause all warnings to always be triggered.
    +    warnings.simplefilter("always")
    +    # Trigger a warning.
    +    fxn()
    +    # Verify some things
    +    assert len(w) == 1
    +    assert issubclass(w[-1].category, DeprecationWarning)
    +    assert "deprecated" in str(w[-1].message)
    +
    +
    +

    One can also cause all warnings to be exceptions by using error instead of +always. One thing to be aware of is that if a warning has already been +raised because of a once/default rule, then no matter what filters are +set the warning will not be seen again unless the warnings registry related to +the warning has been cleared.

    +

    Once the context manager exits, the warnings filter is restored to its state +when the context was entered. This prevents tests from changing the warnings +filter in unexpected ways between tests and leading to indeterminate test +results. The showwarning() function in the module is also restored to +its original value. Note: this can only be guaranteed in a single-threaded +application. If two or more threads use the catch_warnings context +manager at the same time, the behavior is undefined.

    +

    When testing multiple operations that raise the same kind of warning, it +is important to test them in a manner that confirms each operation is raising +a new warning (e.g. set warnings to be raised as exceptions and check the +operations raise exceptions, check that the length of the warning list +continues to increase after each operation, or else delete the previous +entries from the warnings list before each new operation).

    +
    +
    +

    Updating Code For New Versions of Dependencies

    +

    Warning categories that are primarily of interest to Python developers (rather +than end users of applications written in Python) are ignored by default.

    +

    Notably, this “ignored by default” list includes DeprecationWarning +(for every module except __main__), which means developers should make sure +to test their code with typically ignored warnings made visible in order to +receive timely notifications of future breaking API changes (whether in the +standard library or third party packages).

    +

    In the ideal case, the code will have a suitable test suite, and the test runner +will take care of implicitly enabling all warnings when running tests +(the test runner provided by the unittest module does this).

    +

    In less ideal cases, applications can be checked for use of deprecated +interfaces by passing -Wd to the Python interpreter (this is +shorthand for -W default) or setting PYTHONWARNINGS=default in +the environment. This enables default handling for all warnings, including those +that are ignored by default. To change what action is taken for encountered +warnings you can change what argument is passed to -W (e.g. +-W error). See the -W flag for more details on what is +possible.

    +
    +
    +

    Available Functions

    +
    +
    +warnings.warn(message, category=None, stacklevel=1, source=None)
    +

    Issue a warning, or maybe ignore it or raise an exception. The category +argument, if given, must be a warning category class (see above); it defaults to +UserWarning. Alternatively message can be a Warning instance, +in which case category will be ignored and message.__class__ will be used. +In this case the message text will be str(message). This function raises an +exception if the particular warning issued is changed into an error by the +warnings filter see above. The stacklevel argument can be used by wrapper +functions written in Python, like this:

    +
    def deprecation(message):
    +    warnings.warn(message, DeprecationWarning, stacklevel=2)
    +
    +
    +

    This makes the warning refer to deprecation()’s caller, rather than to the +source of deprecation() itself (since the latter would defeat the purpose +of the warning message).

    +

    source, if supplied, is the destroyed object which emitted a +ResourceWarning.

    +
    +

    Changed in version 3.6: Added source parameter.

    +
    +
    + +
    +
    +warnings.warn_explicit(message, category, filename, lineno, module=None, registry=None, module_globals=None, source=None)
    +

    This is a low-level interface to the functionality of warn(), passing in +explicitly the message, category, filename and line number, and optionally the +module name and the registry (which should be the __warningregistry__ +dictionary of the module). The module name defaults to the filename with +.py stripped; if no registry is passed, the warning is never suppressed. +message must be a string and category a subclass of Warning or +message may be a Warning instance, in which case category will be +ignored.

    +

    module_globals, if supplied, should be the global namespace in use by the code +for which the warning is issued. (This argument is used to support displaying +source for modules found in zipfiles or other non-filesystem import +sources).

    +

    source, if supplied, is the destroyed object which emitted a +ResourceWarning.

    +
    +

    Changed in version 3.6: Add the source parameter.

    +
    +
    + +
    +
    +warnings.showwarning(message, category, filename, lineno, file=None, line=None)
    +

    Write a warning to a file. The default implementation calls +formatwarning(message, category, filename, lineno, line) and writes the +resulting string to file, which defaults to sys.stderr. You may replace +this function with any callable by assigning to warnings.showwarning. +line is a line of source code to be included in the warning +message; if line is not supplied, showwarning() will +try to read the line specified by filename and lineno.

    +
    + +
    +
    +warnings.formatwarning(message, category, filename, lineno, line=None)
    +

    Format a warning the standard way. This returns a string which may contain +embedded newlines and ends in a newline. line is a line of source code to +be included in the warning message; if line is not supplied, +formatwarning() will try to read the line specified by filename and +lineno.

    +
    + +
    +
    +warnings.filterwarnings(action, message='', category=Warning, module='', lineno=0, append=False)
    +

    Insert an entry into the list of warnings filter specifications. The entry is inserted at the front by default; if +append is true, it is inserted at the end. This checks the types of the +arguments, compiles the message and module regular expressions, and +inserts them as a tuple in the list of warnings filters. Entries closer to +the front of the list override entries later in the list, if both match a +particular warning. Omitted arguments default to a value that matches +everything.

    +
    + +
    +
    +warnings.simplefilter(action, category=Warning, lineno=0, append=False)
    +

    Insert a simple entry into the list of warnings filter specifications. The meaning of the function parameters is as for +filterwarnings(), but regular expressions are not needed as the filter +inserted always matches any message in any module as long as the category and +line number match.

    +
    + +
    +
    +warnings.resetwarnings()
    +

    Reset the warnings filter. This discards the effect of all previous calls to +filterwarnings(), including that of the -W command line options +and calls to simplefilter().

    +
    + +
    +
    +

    Available Context Managers

    +
    +
    +class warnings.catch_warnings(*, record=False, module=None)
    +

    A context manager that copies and, upon exit, restores the warnings filter +and the showwarning() function. +If the record argument is False (the default) the context manager +returns None on entry. If record is True, a list is +returned that is progressively populated with objects as seen by a custom +showwarning() function (which also suppresses output to sys.stdout). +Each object in the list has attributes with the same names as the arguments to +showwarning().

    +

    The module argument takes a module that will be used instead of the +module returned when you import warnings whose filter will be +protected. This argument exists primarily for testing the warnings +module itself.

    +
    +

    Note

    +

    The catch_warnings manager works by replacing and +then later restoring the module’s +showwarning() function and internal list of filter +specifications. This means the context manager is modifying +global state and therefore is not thread-safe.

    +
    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/wave.html b/python-3.7.4-docs-html/library/wave.html new file mode 100644 index 0000000..1ed8143 --- /dev/null +++ b/python-3.7.4-docs-html/library/wave.html @@ -0,0 +1,438 @@ + + + + + + + wave — Read and write WAV files — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    wave — Read and write WAV files

    +

    Source code: Lib/wave.py

    +
    +

    The wave module provides a convenient interface to the WAV sound format. +It does not support compression/decompression, but it does support mono/stereo.

    +

    The wave module defines the following function and exception:

    +
    +
    +wave.open(file, mode=None)
    +

    If file is a string, open the file by that name, otherwise treat it as a +file-like object. mode can be:

    +
    +
    'rb'

    Read only mode.

    +
    +
    'wb'

    Write only mode.

    +
    +
    +

    Note that it does not allow read/write WAV files.

    +

    A mode of 'rb' returns a Wave_read object, while a mode of +'wb' returns a Wave_write object. If mode is omitted and a +file-like object is passed as file, file.mode is used as the default +value for mode.

    +

    If you pass in a file-like object, the wave object will not close it when its +close() method is called; it is the caller’s responsibility to close +the file object.

    +

    The open() function may be used in a with statement. When +the with block completes, the Wave_read.close() or Wave_write.close() method is called.

    +
    +

    Changed in version 3.4: Added support for unseekable files.

    +
    +
    + +
    +
    +wave.openfp(file, mode)
    +

    A synonym for open(), maintained for backwards compatibility.

    +
    +

    Deprecated since version 3.7, will be removed in version 3.9.

    +
    +
    + +
    +
    +exception wave.Error
    +

    An error raised when something is impossible because it violates the WAV +specification or hits an implementation deficiency.

    +
    + +
    +

    Wave_read Objects

    +

    Wave_read objects, as returned by open(), have the following methods:

    +
    +
    +Wave_read.close()
    +

    Close the stream if it was opened by wave, and make the instance +unusable. This is called automatically on object collection.

    +
    + +
    +
    +Wave_read.getnchannels()
    +

    Returns number of audio channels (1 for mono, 2 for stereo).

    +
    + +
    +
    +Wave_read.getsampwidth()
    +

    Returns sample width in bytes.

    +
    + +
    +
    +Wave_read.getframerate()
    +

    Returns sampling frequency.

    +
    + +
    +
    +Wave_read.getnframes()
    +

    Returns number of audio frames.

    +
    + +
    +
    +Wave_read.getcomptype()
    +

    Returns compression type ('NONE' is the only supported type).

    +
    + +
    +
    +Wave_read.getcompname()
    +

    Human-readable version of getcomptype(). Usually 'not compressed' +parallels 'NONE'.

    +
    + +
    +
    +Wave_read.getparams()
    +

    Returns a namedtuple() (nchannels, sampwidth, +framerate, nframes, comptype, compname), equivalent to output of the +get*() methods.

    +
    + +
    +
    +Wave_read.readframes(n)
    +

    Reads and returns at most n frames of audio, as a bytes object.

    +
    + +
    +
    +Wave_read.rewind()
    +

    Rewind the file pointer to the beginning of the audio stream.

    +
    + +

    The following two methods are defined for compatibility with the aifc +module, and don’t do anything interesting.

    +
    +
    +Wave_read.getmarkers()
    +

    Returns None.

    +
    + +
    +
    +Wave_read.getmark(id)
    +

    Raise an error.

    +
    + +

    The following two methods define a term “position” which is compatible between +them, and is otherwise implementation dependent.

    +
    +
    +Wave_read.setpos(pos)
    +

    Set the file pointer to the specified position.

    +
    + +
    +
    +Wave_read.tell()
    +

    Return current file pointer position.

    +
    + +
    +
    +

    Wave_write Objects

    +

    For seekable output streams, the wave header will automatically be updated +to reflect the number of frames actually written. For unseekable streams, the +nframes value must be accurate when the first frame data is written. An +accurate nframes value can be achieved either by calling +setnframes() or setparams() with the number +of frames that will be written before close() is called and +then using writeframesraw() to write the frame data, or by +calling writeframes() with all of the frame data to be +written. In the latter case writeframes() will calculate +the number of frames in the data and set nframes accordingly before writing +the frame data.

    +

    Wave_write objects, as returned by open(), have the following methods:

    +
    +

    Changed in version 3.4: Added support for unseekable files.

    +
    +
    +
    +Wave_write.close()
    +

    Make sure nframes is correct, and close the file if it was opened by +wave. This method is called upon object collection. It will raise +an exception if the output stream is not seekable and nframes does not +match the number of frames actually written.

    +
    + +
    +
    +Wave_write.setnchannels(n)
    +

    Set the number of channels.

    +
    + +
    +
    +Wave_write.setsampwidth(n)
    +

    Set the sample width to n bytes.

    +
    + +
    +
    +Wave_write.setframerate(n)
    +

    Set the frame rate to n.

    +
    +

    Changed in version 3.2: A non-integral input to this method is rounded to the nearest +integer.

    +
    +
    + +
    +
    +Wave_write.setnframes(n)
    +

    Set the number of frames to n. This will be changed later if the number +of frames actually written is different (this update attempt will +raise an error if the output stream is not seekable).

    +
    + +
    +
    +Wave_write.setcomptype(type, name)
    +

    Set the compression type and description. At the moment, only compression type +NONE is supported, meaning no compression.

    +
    + +
    +
    +Wave_write.setparams(tuple)
    +

    The tuple should be (nchannels, sampwidth, framerate, nframes, comptype, +compname), with values valid for the set*() methods. Sets all +parameters.

    +
    + +
    +
    +Wave_write.tell()
    +

    Return current position in the file, with the same disclaimer for the +Wave_read.tell() and Wave_read.setpos() methods.

    +
    + +
    +
    +Wave_write.writeframesraw(data)
    +

    Write audio frames, without correcting nframes.

    +
    +

    Changed in version 3.4: Any bytes-like object is now accepted.

    +
    +
    + +
    +
    +Wave_write.writeframes(data)
    +

    Write audio frames and make sure nframes is correct. It will raise an +error if the output stream is not seekable and the total number of frames +that have been written after data has been written does not match the +previously set value for nframes.

    +
    +

    Changed in version 3.4: Any bytes-like object is now accepted.

    +
    +
    + +

    Note that it is invalid to set any parameters after calling writeframes() +or writeframesraw(), and any attempt to do so will raise +wave.Error.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/weakref.html b/python-3.7.4-docs-html/library/weakref.html new file mode 100644 index 0000000..6f513b0 --- /dev/null +++ b/python-3.7.4-docs-html/library/weakref.html @@ -0,0 +1,745 @@ + + + + + + + weakref — Weak references — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    weakref — Weak references

    +

    Source code: Lib/weakref.py

    +
    +

    The weakref module allows the Python programmer to create weak +references to objects.

    +

    In the following, the term referent means the object which is referred to +by a weak reference.

    +

    A weak reference to an object is not enough to keep the object alive: when the +only remaining references to a referent are weak references, +garbage collection is free to destroy the referent and reuse its memory +for something else. However, until the object is actually destroyed the weak +reference may return the object even if there are no strong references to it.

    +

    A primary use for weak references is to implement caches or +mappings holding large objects, where it’s desired that a large object not be +kept alive solely because it appears in a cache or mapping.

    +

    For example, if you have a number of large binary image objects, you may wish to +associate a name with each. If you used a Python dictionary to map names to +images, or images to names, the image objects would remain alive just because +they appeared as values or keys in the dictionaries. The +WeakKeyDictionary and WeakValueDictionary classes supplied by +the weakref module are an alternative, using weak references to construct +mappings that don’t keep objects alive solely because they appear in the mapping +objects. If, for example, an image object is a value in a +WeakValueDictionary, then when the last remaining references to that +image object are the weak references held by weak mappings, garbage collection +can reclaim the object, and its corresponding entries in weak mappings are +simply deleted.

    +

    WeakKeyDictionary and WeakValueDictionary use weak references +in their implementation, setting up callback functions on the weak references +that notify the weak dictionaries when a key or value has been reclaimed by +garbage collection. WeakSet implements the set interface, +but keeps weak references to its elements, just like a +WeakKeyDictionary does.

    +

    finalize provides a straight forward way to register a +cleanup function to be called when an object is garbage collected. +This is simpler to use than setting up a callback function on a raw +weak reference, since the module automatically ensures that the finalizer +remains alive until the object is collected.

    +

    Most programs should find that using one of these weak container types +or finalize is all they need – it’s not usually necessary to +create your own weak references directly. The low-level machinery is +exposed by the weakref module for the benefit of advanced uses.

    +

    Not all objects can be weakly referenced; those objects which can include class +instances, functions written in Python (but not in C), instance methods, sets, +frozensets, some file objects, generators, +type objects, sockets, arrays, deques, regular expression pattern objects, and code +objects.

    +
    +

    Changed in version 3.2: Added support for thread.lock, threading.Lock, and code objects.

    +
    +

    Several built-in types such as list and dict do not directly +support weak references but can add support through subclassing:

    +
    class Dict(dict):
    +    pass
    +
    +obj = Dict(red=1, green=2, blue=3)   # this object is weak referenceable
    +
    +
    +
    +

    CPython implementation detail: Other built-in types such as tuple and int do not support weak +references even when subclassed.

    +
    +

    Extension types can easily be made to support weak references; see +Weak Reference Support.

    +
    +
    +class weakref.ref(object[, callback])
    +

    Return a weak reference to object. The original object can be retrieved by +calling the reference object if the referent is still alive; if the referent is +no longer alive, calling the reference object will cause None to be +returned. If callback is provided and not None, and the returned +weakref object is still alive, the callback will be called when the object is +about to be finalized; the weak reference object will be passed as the only +parameter to the callback; the referent will no longer be available.

    +

    It is allowable for many weak references to be constructed for the same object. +Callbacks registered for each weak reference will be called from the most +recently registered callback to the oldest registered callback.

    +

    Exceptions raised by the callback will be noted on the standard error output, +but cannot be propagated; they are handled in exactly the same way as exceptions +raised from an object’s __del__() method.

    +

    Weak references are hashable if the object is hashable. They will +maintain their hash value even after the object was deleted. If +hash() is called the first time only after the object was deleted, +the call will raise TypeError.

    +

    Weak references support tests for equality, but not ordering. If the referents +are still alive, two references have the same equality relationship as their +referents (regardless of the callback). If either referent has been deleted, +the references are equal only if the reference objects are the same object.

    +

    This is a subclassable type rather than a factory function.

    +
    +
    +__callback__
    +

    This read-only attribute returns the callback currently associated to the +weakref. If there is no callback or if the referent of the weakref is +no longer alive then this attribute will have value None.

    +
    + +
    +

    Changed in version 3.4: Added the __callback__ attribute.

    +
    +
    + +
    +
    +weakref.proxy(object[, callback])
    +

    Return a proxy to object which uses a weak reference. This supports use of +the proxy in most contexts instead of requiring the explicit dereferencing used +with weak reference objects. The returned object will have a type of either +ProxyType or CallableProxyType, depending on whether object is +callable. Proxy objects are not hashable regardless of the referent; this +avoids a number of problems related to their fundamentally mutable nature, and +prevent their use as dictionary keys. callback is the same as the parameter +of the same name to the ref() function.

    +
    + +
    +
    +weakref.getweakrefcount(object)
    +

    Return the number of weak references and proxies which refer to object.

    +
    + +
    +
    +weakref.getweakrefs(object)
    +

    Return a list of all weak reference and proxy objects which refer to object.

    +
    + +
    +
    +class weakref.WeakKeyDictionary([dict])
    +

    Mapping class that references keys weakly. Entries in the dictionary will be +discarded when there is no longer a strong reference to the key. This can be +used to associate additional data with an object owned by other parts of an +application without adding attributes to those objects. This can be especially +useful with objects that override attribute accesses.

    +
    +

    Note

    +

    Caution: Because a WeakKeyDictionary is built on top of a Python +dictionary, it must not change size when iterating over it. This can be +difficult to ensure for a WeakKeyDictionary because actions +performed by the program during iteration may cause items in the +dictionary to vanish “by magic” (as a side effect of garbage collection).

    +
    +
    + +

    WeakKeyDictionary objects have an additional method that +exposes the internal references directly. The references are not guaranteed to +be “live” at the time they are used, so the result of calling the references +needs to be checked before being used. This can be used to avoid creating +references that will cause the garbage collector to keep the keys around longer +than needed.

    +
    +
    +WeakKeyDictionary.keyrefs()
    +

    Return an iterable of the weak references to the keys.

    +
    + +
    +
    +class weakref.WeakValueDictionary([dict])
    +

    Mapping class that references values weakly. Entries in the dictionary will be +discarded when no strong reference to the value exists any more.

    +
    +

    Note

    +

    Caution: Because a WeakValueDictionary is built on top of a Python +dictionary, it must not change size when iterating over it. This can be +difficult to ensure for a WeakValueDictionary because actions performed +by the program during iteration may cause items in the dictionary to vanish “by +magic” (as a side effect of garbage collection).

    +
    +
    + +

    WeakValueDictionary objects have an additional method that has the +same issues as the keyrefs() method of WeakKeyDictionary +objects.

    +
    +
    +WeakValueDictionary.valuerefs()
    +

    Return an iterable of the weak references to the values.

    +
    + +
    +
    +class weakref.WeakSet([elements])
    +

    Set class that keeps weak references to its elements. An element will be +discarded when no strong reference to it exists any more.

    +
    + +
    +
    +class weakref.WeakMethod(method)
    +

    A custom ref subclass which simulates a weak reference to a bound +method (i.e., a method defined on a class and looked up on an instance). +Since a bound method is ephemeral, a standard weak reference cannot keep +hold of it. WeakMethod has special code to recreate the bound +method until either the object or the original function dies:

    +
    >>> class C:
    +...     def method(self):
    +...         print("method called!")
    +...
    +>>> c = C()
    +>>> r = weakref.ref(c.method)
    +>>> r()
    +>>> r = weakref.WeakMethod(c.method)
    +>>> r()
    +<bound method C.method of <__main__.C object at 0x7fc859830220>>
    +>>> r()()
    +method called!
    +>>> del c
    +>>> gc.collect()
    +0
    +>>> r()
    +>>>
    +
    +
    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +class weakref.finalize(obj, func, *args, **kwargs)
    +

    Return a callable finalizer object which will be called when obj +is garbage collected. Unlike an ordinary weak reference, a finalizer +will always survive until the reference object is collected, greatly +simplifying lifecycle management.

    +

    A finalizer is considered alive until it is called (either explicitly +or at garbage collection), and after that it is dead. Calling a live +finalizer returns the result of evaluating func(*arg, **kwargs), +whereas calling a dead finalizer returns None.

    +

    Exceptions raised by finalizer callbacks during garbage collection +will be shown on the standard error output, but cannot be +propagated. They are handled in the same way as exceptions raised +from an object’s __del__() method or a weak reference’s +callback.

    +

    When the program exits, each remaining live finalizer is called +unless its atexit attribute has been set to false. They +are called in reverse order of creation.

    +

    A finalizer will never invoke its callback during the later part of +the interpreter shutdown when module globals are liable to have +been replaced by None.

    +
    +
    +__call__()
    +

    If self is alive then mark it as dead and return the result of +calling func(*args, **kwargs). If self is dead then return +None.

    +
    + +
    +
    +detach()
    +

    If self is alive then mark it as dead and return the tuple +(obj, func, args, kwargs). If self is dead then return +None.

    +
    + +
    +
    +peek()
    +

    If self is alive then return the tuple (obj, func, args, +kwargs). If self is dead then return None.

    +
    + +
    +
    +alive
    +

    Property which is true if the finalizer is alive, false otherwise.

    +
    + +
    +
    +atexit
    +

    A writable boolean property which by default is true. When the +program exits, it calls all remaining live finalizers for which +atexit is true. They are called in reverse order of +creation.

    +
    + +
    +

    Note

    +

    It is important to ensure that func, args and kwargs do +not own any references to obj, either directly or indirectly, +since otherwise obj will never be garbage collected. In +particular, func should not be a bound method of obj.

    +
    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +weakref.ReferenceType
    +

    The type object for weak references objects.

    +
    + +
    +
    +weakref.ProxyType
    +

    The type object for proxies of objects which are not callable.

    +
    + +
    +
    +weakref.CallableProxyType
    +

    The type object for proxies of callable objects.

    +
    + +
    +
    +weakref.ProxyTypes
    +

    Sequence containing all the type objects for proxies. This can make it simpler +to test if an object is a proxy without being dependent on naming both proxy +types.

    +
    + +
    +
    +exception weakref.ReferenceError
    +

    Exception raised when a proxy object is used but the underlying object has been +collected. This is the same as the standard ReferenceError exception.

    +
    + +
    +

    See also

    +
    +
    PEP 205 - Weak References

    The proposal and rationale for this feature, including links to earlier +implementations and information about similar features in other languages.

    +
    +
    +
    +
    +

    Weak Reference Objects

    +

    Weak reference objects have no methods and no attributes besides +ref.__callback__. A weak reference object allows the referent to be +obtained, if it still exists, by calling it:

    +
    >>> import weakref
    +>>> class Object:
    +...     pass
    +...
    +>>> o = Object()
    +>>> r = weakref.ref(o)
    +>>> o2 = r()
    +>>> o is o2
    +True
    +
    +
    +

    If the referent no longer exists, calling the reference object returns +None:

    +
    >>> del o, o2
    +>>> print(r())
    +None
    +
    +
    +

    Testing that a weak reference object is still live should be done using the +expression ref() is not None. Normally, application code that needs to use +a reference object should follow this pattern:

    +
    # r is a weak reference object
    +o = r()
    +if o is None:
    +    # referent has been garbage collected
    +    print("Object has been deallocated; can't frobnicate.")
    +else:
    +    print("Object is still live!")
    +    o.do_something_useful()
    +
    +
    +

    Using a separate test for “liveness” creates race conditions in threaded +applications; another thread can cause a weak reference to become invalidated +before the weak reference is called; the idiom shown above is safe in threaded +applications as well as single-threaded applications.

    +

    Specialized versions of ref objects can be created through subclassing. +This is used in the implementation of the WeakValueDictionary to reduce +the memory overhead for each entry in the mapping. This may be most useful to +associate additional information with a reference, but could also be used to +insert additional processing on calls to retrieve the referent.

    +

    This example shows how a subclass of ref can be used to store +additional information about an object and affect the value that’s returned when +the referent is accessed:

    +
    import weakref
    +
    +class ExtendedRef(weakref.ref):
    +    def __init__(self, ob, callback=None, **annotations):
    +        super(ExtendedRef, self).__init__(ob, callback)
    +        self.__counter = 0
    +        for k, v in annotations.items():
    +            setattr(self, k, v)
    +
    +    def __call__(self):
    +        """Return a pair containing the referent and the number of
    +        times the reference has been called.
    +        """
    +        ob = super(ExtendedRef, self).__call__()
    +        if ob is not None:
    +            self.__counter += 1
    +            ob = (ob, self.__counter)
    +        return ob
    +
    +
    +
    +
    +

    Example

    +

    This simple example shows how an application can use object IDs to retrieve +objects that it has seen before. The IDs of the objects can then be used in +other data structures without forcing the objects to remain alive, but the +objects can still be retrieved by ID if they do.

    +
    import weakref
    +
    +_id2obj_dict = weakref.WeakValueDictionary()
    +
    +def remember(obj):
    +    oid = id(obj)
    +    _id2obj_dict[oid] = obj
    +    return oid
    +
    +def id2obj(oid):
    +    return _id2obj_dict[oid]
    +
    +
    +
    +
    +

    Finalizer Objects

    +

    The main benefit of using finalize is that it makes it simple +to register a callback without needing to preserve the returned finalizer +object. For instance

    +
    >>> import weakref
    +>>> class Object:
    +...     pass
    +...
    +>>> kenny = Object()
    +>>> weakref.finalize(kenny, print, "You killed Kenny!")  #doctest:+ELLIPSIS
    +<finalize object at ...; for 'Object' at ...>
    +>>> del kenny
    +You killed Kenny!
    +
    +
    +

    The finalizer can be called directly as well. However the finalizer +will invoke the callback at most once.

    +
    >>> def callback(x, y, z):
    +...     print("CALLBACK")
    +...     return x + y + z
    +...
    +>>> obj = Object()
    +>>> f = weakref.finalize(obj, callback, 1, 2, z=3)
    +>>> assert f.alive
    +>>> assert f() == 6
    +CALLBACK
    +>>> assert not f.alive
    +>>> f()                     # callback not called because finalizer dead
    +>>> del obj                 # callback not called because finalizer dead
    +
    +
    +

    You can unregister a finalizer using its detach() +method. This kills the finalizer and returns the arguments passed to +the constructor when it was created.

    +
    >>> obj = Object()
    +>>> f = weakref.finalize(obj, callback, 1, 2, z=3)
    +>>> f.detach()                                           #doctest:+ELLIPSIS
    +(<...Object object ...>, <function callback ...>, (1, 2), {'z': 3})
    +>>> newobj, func, args, kwargs = _
    +>>> assert not f.alive
    +>>> assert newobj is obj
    +>>> assert func(*args, **kwargs) == 6
    +CALLBACK
    +
    +
    +

    Unless you set the atexit attribute to +False, a finalizer will be called when the program exits if it +is still alive. For instance

    +
    >>> obj = Object()
    +>>> weakref.finalize(obj, print, "obj dead or exiting")
    +<finalize object at ...; for 'Object' at ...>
    +>>> exit()
    +obj dead or exiting
    +
    +
    +
    +
    +

    Comparing finalizers with __del__() methods

    +

    Suppose we want to create a class whose instances represent temporary +directories. The directories should be deleted with their contents +when the first of the following events occurs:

    +
      +
    • the object is garbage collected,

    • +
    • the object’s remove() method is called, or

    • +
    • the program exits.

    • +
    +

    We might try to implement the class using a __del__() method as +follows:

    +
    class TempDir:
    +    def __init__(self):
    +        self.name = tempfile.mkdtemp()
    +
    +    def remove(self):
    +        if self.name is not None:
    +            shutil.rmtree(self.name)
    +            self.name = None
    +
    +    @property
    +    def removed(self):
    +        return self.name is None
    +
    +    def __del__(self):
    +        self.remove()
    +
    +
    +

    Starting with Python 3.4, __del__() methods no longer prevent +reference cycles from being garbage collected, and module globals are +no longer forced to None during interpreter shutdown. +So this code should work without any issues on CPython.

    +

    However, handling of __del__() methods is notoriously implementation +specific, since it depends on internal details of the interpreter’s garbage +collector implementation.

    +

    A more robust alternative can be to define a finalizer which only references +the specific functions and objects that it needs, rather than having access +to the full state of the object:

    +
    class TempDir:
    +    def __init__(self):
    +        self.name = tempfile.mkdtemp()
    +        self._finalizer = weakref.finalize(self, shutil.rmtree, self.name)
    +
    +    def remove(self):
    +        self._finalizer()
    +
    +    @property
    +    def removed(self):
    +        return not self._finalizer.alive
    +
    +
    +

    Defined like this, our finalizer only receives a reference to the details +it needs to clean up the directory appropriately. If the object never gets +garbage collected the finalizer will still be called at exit.

    +

    The other advantage of weakref based finalizers is that they can be used to +register finalizers for classes where the definition is controlled by a +third party, such as running code when a module is unloaded:

    +
    import weakref, sys
    +def unloading_module():
    +    # implicit reference to the module globals from the function body
    +weakref.finalize(sys.modules[__name__], unloading_module)
    +
    +
    +
    +

    Note

    +

    If you create a finalizer object in a daemonic thread just as the program +exits then there is the possibility that the finalizer +does not get called at exit. However, in a daemonic thread +atexit.register(), try: ... finally: ... and with: ... +do not guarantee that cleanup occurs either.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/webbrowser.html b/python-3.7.4-docs-html/library/webbrowser.html new file mode 100644 index 0000000..4c7adc0 --- /dev/null +++ b/python-3.7.4-docs-html/library/webbrowser.html @@ -0,0 +1,449 @@ + + + + + + + webbrowser — Convenient Web-browser controller — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    webbrowser — Convenient Web-browser controller

    +

    Source code: Lib/webbrowser.py

    +
    +

    The webbrowser module provides a high-level interface to allow displaying +Web-based documents to users. Under most circumstances, simply calling the +open() function from this module will do the right thing.

    +

    Under Unix, graphical browsers are preferred under X11, but text-mode browsers +will be used if graphical browsers are not available or an X11 display isn’t +available. If text-mode browsers are used, the calling process will block until +the user exits the browser.

    +

    If the environment variable BROWSER exists, it is interpreted as the +os.pathsep-separated list of browsers to try ahead of the platform +defaults. When the value of a list part contains the string %s, then it is +interpreted as a literal browser command line to be used with the argument URL +substituted for %s; if the part does not contain %s, it is simply +interpreted as the name of the browser to launch. 1

    +

    For non-Unix platforms, or when a remote browser is available on Unix, the +controlling process will not wait for the user to finish with the browser, but +allow the remote browser to maintain its own windows on the display. If remote +browsers are not available on Unix, the controlling process will launch a new +browser and wait.

    +

    The script webbrowser can be used as a command-line interface for the +module. It accepts a URL as the argument. It accepts the following optional +parameters: -n opens the URL in a new browser window, if possible; +-t opens the URL in a new browser page (“tab”). The options are, +naturally, mutually exclusive. Usage example:

    +
    python -m webbrowser -t "http://www.python.org"
    +
    +
    +

    The following exception is defined:

    +
    +
    +exception webbrowser.Error
    +

    Exception raised when a browser control error occurs.

    +
    + +

    The following functions are defined:

    +
    +
    +webbrowser.open(url, new=0, autoraise=True)
    +

    Display url using the default browser. If new is 0, the url is opened +in the same browser window if possible. If new is 1, a new browser window +is opened if possible. If new is 2, a new browser page (“tab”) is opened +if possible. If autoraise is True, the window is raised if possible +(note that under many window managers this will occur regardless of the +setting of this variable).

    +

    Note that on some platforms, trying to open a filename using this function, +may work and start the operating system’s associated program. However, this +is neither supported nor portable.

    +
    + +
    +
    +webbrowser.open_new(url)
    +

    Open url in a new window of the default browser, if possible, otherwise, open +url in the only browser window.

    +
    + +
    +
    +webbrowser.open_new_tab(url)
    +

    Open url in a new page (“tab”) of the default browser, if possible, otherwise +equivalent to open_new().

    +
    + +
    +
    +webbrowser.get(using=None)
    +

    Return a controller object for the browser type using. If using is +None, return a controller for a default browser appropriate to the +caller’s environment.

    +
    + +
    +
    +webbrowser.register(name, constructor, instance=None, *, preferred=False)
    +

    Register the browser type name. Once a browser type is registered, the +get() function can return a controller for that browser type. If +instance is not provided, or is None, constructor will be called without +parameters to create an instance when needed. If instance is provided, +constructor will never be called, and may be None.

    +

    Setting preferred to True makes this browser a preferred result for +a get() call with no argument. Otherwise, this entry point is only +useful if you plan to either set the BROWSER variable or call +get() with a nonempty argument matching the name of a handler you +declare.

    +
    +

    Changed in version 3.7: preferred keyword-only parameter was added.

    +
    +
    + +

    A number of browser types are predefined. This table gives the type names that +may be passed to the get() function and the corresponding instantiations +for the controller classes, all defined in this module.

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Type Name

    Class Name

    Notes

    'mozilla'

    Mozilla('mozilla')

    'firefox'

    Mozilla('mozilla')

    'netscape'

    Mozilla('netscape')

    'galeon'

    Galeon('galeon')

    'epiphany'

    Galeon('epiphany')

    'skipstone'

    BackgroundBrowser('skipstone')

    'kfmclient'

    Konqueror()

    (1)

    'konqueror'

    Konqueror()

    (1)

    'kfm'

    Konqueror()

    (1)

    'mosaic'

    BackgroundBrowser('mosaic')

    'opera'

    Opera()

    'grail'

    Grail()

    'links'

    GenericBrowser('links')

    'elinks'

    Elinks('elinks')

    'lynx'

    GenericBrowser('lynx')

    'w3m'

    GenericBrowser('w3m')

    'windows-default'

    WindowsDefault

    (2)

    'macosx'

    MacOSX('default')

    (3)

    'safari'

    MacOSX('safari')

    (3)

    'google-chrome'

    Chrome('google-chrome')

    'chrome'

    Chrome('chrome')

    'chromium'

    Chromium('chromium')

    'chromium-browser'

    Chromium('chromium-browser')

    +

    Notes:

    +
      +
    1. “Konqueror” is the file manager for the KDE desktop environment for Unix, and +only makes sense to use if KDE is running. Some way of reliably detecting KDE +would be nice; the KDEDIR variable is not sufficient. Note also that +the name “kfm” is used even when using the konqueror command with KDE +2 — the implementation selects the best strategy for running Konqueror.

    2. +
    3. Only on Windows platforms.

    4. +
    5. Only on Mac OS X platform.

    6. +
    +
    +

    New in version 3.3: Support for Chrome/Chromium has been added.

    +
    +

    Here are some simple examples:

    +
    url = 'http://docs.python.org/'
    +
    +# Open URL in a new tab, if a browser window is already open.
    +webbrowser.open_new_tab(url)
    +
    +# Open URL in new window, raising the window if possible.
    +webbrowser.open_new(url)
    +
    +
    +
    +

    Browser Controller Objects

    +

    Browser controllers provide these methods which parallel three of the +module-level convenience functions:

    +
    +
    +controller.open(url, new=0, autoraise=True)
    +

    Display url using the browser handled by this controller. If new is 1, a new +browser window is opened if possible. If new is 2, a new browser page (“tab”) +is opened if possible.

    +
    + +
    +
    +controller.open_new(url)
    +

    Open url in a new window of the browser handled by this controller, if +possible, otherwise, open url in the only browser window. Alias +open_new().

    +
    + +
    +
    +controller.open_new_tab(url)
    +

    Open url in a new page (“tab”) of the browser handled by this controller, if +possible, otherwise equivalent to open_new().

    +
    + +

    Footnotes

    +
    +
    1
    +

    Executables named here without a full path will be searched in the +directories given in the PATH environment variable.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/windows.html b/python-3.7.4-docs-html/library/windows.html new file mode 100644 index 0000000..532d9c7 --- /dev/null +++ b/python-3.7.4-docs-html/library/windows.html @@ -0,0 +1,220 @@ + + + + + + + MS Windows Specific Services — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/winreg.html b/python-3.7.4-docs-html/library/winreg.html new file mode 100644 index 0000000..b0a2ea9 --- /dev/null +++ b/python-3.7.4-docs-html/library/winreg.html @@ -0,0 +1,947 @@ + + + + + + + winreg — Windows registry access — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    winreg — Windows registry access

    +
    +

    These functions expose the Windows registry API to Python. Instead of using an +integer as the registry handle, a handle object is used +to ensure that the handles are closed correctly, even if the programmer neglects +to explicitly close them.

    +
    +

    Changed in version 3.3: Several functions in this module used to raise a +WindowsError, which is now an alias of OSError.

    +
    +
    +

    Functions

    +

    This module offers the following functions:

    +
    +
    +winreg.CloseKey(hkey)
    +

    Closes a previously opened registry key. The hkey argument specifies a +previously opened key.

    +
    +

    Note

    +

    If hkey is not closed using this method (or via hkey.Close()), it is closed when the hkey object is destroyed by +Python.

    +
    +
    + +
    +
    +winreg.ConnectRegistry(computer_name, key)
    +

    Establishes a connection to a predefined registry handle on another computer, +and returns a handle object.

    +

    computer_name is the name of the remote computer, of the form +r"\\computername". If None, the local computer is used.

    +

    key is the predefined handle to connect to.

    +

    The return value is the handle of the opened key. If the function fails, an +OSError exception is raised.

    +
    +

    Changed in version 3.3: See above.

    +
    +
    + +
    +
    +winreg.CreateKey(key, sub_key)
    +

    Creates or opens the specified key, returning a +handle object.

    +

    key is an already open key, or one of the predefined +HKEY_* constants.

    +

    sub_key is a string that names the key this method opens or creates.

    +

    If key is one of the predefined keys, sub_key may be None. In that +case, the handle returned is the same key handle passed in to the function.

    +

    If the key already exists, this function opens the existing key.

    +

    The return value is the handle of the opened key. If the function fails, an +OSError exception is raised.

    +
    +

    Changed in version 3.3: See above.

    +
    +
    + +
    +
    +winreg.CreateKeyEx(key, sub_key, reserved=0, access=KEY_WRITE)
    +

    Creates or opens the specified key, returning a +handle object.

    +

    key is an already open key, or one of the predefined +HKEY_* constants.

    +

    sub_key is a string that names the key this method opens or creates.

    +

    reserved is a reserved integer, and must be zero. The default is zero.

    +

    access is an integer that specifies an access mask that describes the desired +security access for the key. Default is KEY_WRITE. See +Access Rights for other allowed values.

    +

    If key is one of the predefined keys, sub_key may be None. In that +case, the handle returned is the same key handle passed in to the function.

    +

    If the key already exists, this function opens the existing key.

    +

    The return value is the handle of the opened key. If the function fails, an +OSError exception is raised.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.3: See above.

    +
    +
    + +
    +
    +winreg.DeleteKey(key, sub_key)
    +

    Deletes the specified key.

    +

    key is an already open key, or one of the predefined +HKEY_* constants.

    +

    sub_key is a string that must be a subkey of the key identified by the key +parameter. This value must not be None, and the key may not have subkeys.

    +

    This method can not delete keys with subkeys.

    +

    If the method succeeds, the entire key, including all of its values, is removed. +If the method fails, an OSError exception is raised.

    +
    +

    Changed in version 3.3: See above.

    +
    +
    + +
    +
    +winreg.DeleteKeyEx(key, sub_key, access=KEY_WOW64_64KEY, reserved=0)
    +

    Deletes the specified key.

    +
    +

    Note

    +

    The DeleteKeyEx() function is implemented with the RegDeleteKeyEx +Windows API function, which is specific to 64-bit versions of Windows. +See the RegDeleteKeyEx documentation.

    +
    +

    key is an already open key, or one of the predefined +HKEY_* constants.

    +

    sub_key is a string that must be a subkey of the key identified by the +key parameter. This value must not be None, and the key may not have +subkeys.

    +

    reserved is a reserved integer, and must be zero. The default is zero.

    +

    access is an integer that specifies an access mask that describes the desired +security access for the key. Default is KEY_WOW64_64KEY. See +Access Rights for other allowed values.

    +

    This method can not delete keys with subkeys.

    +

    If the method succeeds, the entire key, including all of its values, is +removed. If the method fails, an OSError exception is raised.

    +

    On unsupported Windows versions, NotImplementedError is raised.

    +
    +

    New in version 3.2.

    +
    +
    +

    Changed in version 3.3: See above.

    +
    +
    + +
    +
    +winreg.DeleteValue(key, value)
    +

    Removes a named value from a registry key.

    +

    key is an already open key, or one of the predefined +HKEY_* constants.

    +

    value is a string that identifies the value to remove.

    +
    + +
    +
    +winreg.EnumKey(key, index)
    +

    Enumerates subkeys of an open registry key, returning a string.

    +

    key is an already open key, or one of the predefined +HKEY_* constants.

    +

    index is an integer that identifies the index of the key to retrieve.

    +

    The function retrieves the name of one subkey each time it is called. It is +typically called repeatedly until an OSError exception is +raised, indicating, no more values are available.

    +
    +

    Changed in version 3.3: See above.

    +
    +
    + +
    +
    +winreg.EnumValue(key, index)
    +

    Enumerates values of an open registry key, returning a tuple.

    +

    key is an already open key, or one of the predefined +HKEY_* constants.

    +

    index is an integer that identifies the index of the value to retrieve.

    +

    The function retrieves the name of one subkey each time it is called. It is +typically called repeatedly, until an OSError exception is +raised, indicating no more values.

    +

    The result is a tuple of 3 items:

    + ++++ + + + + + + + + + + + + + + + + +

    Index

    Meaning

    0

    A string that identifies the value name

    1

    An object that holds the value data, and +whose type depends on the underlying +registry type

    2

    An integer that identifies the type of the +value data (see table in docs for +SetValueEx())

    +
    +

    Changed in version 3.3: See above.

    +
    +
    + +
    +
    +winreg.ExpandEnvironmentStrings(str)
    +

    Expands environment variable placeholders %NAME% in strings like +REG_EXPAND_SZ:

    +
    >>> ExpandEnvironmentStrings('%windir%')
    +'C:\\Windows'
    +
    +
    +
    + +
    +
    +winreg.FlushKey(key)
    +

    Writes all the attributes of a key to the registry.

    +

    key is an already open key, or one of the predefined +HKEY_* constants.

    +

    It is not necessary to call FlushKey() to change a key. Registry changes are +flushed to disk by the registry using its lazy flusher. Registry changes are +also flushed to disk at system shutdown. Unlike CloseKey(), the +FlushKey() method returns only when all the data has been written to the +registry. An application should only call FlushKey() if it requires +absolute certainty that registry changes are on disk.

    +
    +

    Note

    +

    If you don’t know whether a FlushKey() call is required, it probably +isn’t.

    +
    +
    + +
    +
    +winreg.LoadKey(key, sub_key, file_name)
    +

    Creates a subkey under the specified key and stores registration information +from a specified file into that subkey.

    +

    key is a handle returned by ConnectRegistry() or one of the constants +HKEY_USERS or HKEY_LOCAL_MACHINE.

    +

    sub_key is a string that identifies the subkey to load.

    +

    file_name is the name of the file to load registry data from. This file must +have been created with the SaveKey() function. Under the file allocation +table (FAT) file system, the filename may not have an extension.

    +

    A call to LoadKey() fails if the calling process does not have the +SE_RESTORE_PRIVILEGE privilege. Note that privileges are different +from permissions – see the RegLoadKey documentation for +more details.

    +

    If key is a handle returned by ConnectRegistry(), then the path +specified in file_name is relative to the remote computer.

    +
    + +
    +
    +winreg.OpenKey(key, sub_key, reserved=0, access=KEY_READ)
    +
    +winreg.OpenKeyEx(key, sub_key, reserved=0, access=KEY_READ)
    +

    Opens the specified key, returning a handle object.

    +

    key is an already open key, or one of the predefined +HKEY_* constants.

    +

    sub_key is a string that identifies the sub_key to open.

    +

    reserved is a reserved integer, and must be zero. The default is zero.

    +

    access is an integer that specifies an access mask that describes the desired +security access for the key. Default is KEY_READ. See Access +Rights for other allowed values.

    +

    The result is a new handle to the specified key.

    +

    If the function fails, OSError is raised.

    +
    +

    Changed in version 3.2: Allow the use of named arguments.

    +
    +
    +

    Changed in version 3.3: See above.

    +
    +
    + +
    +
    +winreg.QueryInfoKey(key)
    +

    Returns information about a key, as a tuple.

    +

    key is an already open key, or one of the predefined +HKEY_* constants.

    +

    The result is a tuple of 3 items:

    + ++++ + + + + + + + + + + + + + + + + +

    Index

    Meaning

    0

    An integer giving the number of sub keys +this key has.

    1

    An integer giving the number of values this +key has.

    2

    An integer giving when the key was last +modified (if available) as 100’s of +nanoseconds since Jan 1, 1601.

    +
    + +
    +
    +winreg.QueryValue(key, sub_key)
    +

    Retrieves the unnamed value for a key, as a string.

    +

    key is an already open key, or one of the predefined +HKEY_* constants.

    +

    sub_key is a string that holds the name of the subkey with which the value is +associated. If this parameter is None or empty, the function retrieves the +value set by the SetValue() method for the key identified by key.

    +

    Values in the registry have name, type, and data components. This method +retrieves the data for a key’s first value that has a NULL name. But the +underlying API call doesn’t return the type, so always use +QueryValueEx() if possible.

    +
    + +
    +
    +winreg.QueryValueEx(key, value_name)
    +

    Retrieves the type and data for a specified value name associated with +an open registry key.

    +

    key is an already open key, or one of the predefined +HKEY_* constants.

    +

    value_name is a string indicating the value to query.

    +

    The result is a tuple of 2 items:

    + ++++ + + + + + + + + + + + + + +

    Index

    Meaning

    0

    The value of the registry item.

    1

    An integer giving the registry type for +this value (see table in docs for +SetValueEx())

    +
    + +
    +
    +winreg.SaveKey(key, file_name)
    +

    Saves the specified key, and all its subkeys to the specified file.

    +

    key is an already open key, or one of the predefined +HKEY_* constants.

    +

    file_name is the name of the file to save registry data to. This file +cannot already exist. If this filename includes an extension, it cannot be +used on file allocation table (FAT) file systems by the LoadKey() +method.

    +

    If key represents a key on a remote computer, the path described by +file_name is relative to the remote computer. The caller of this method must +possess the SeBackupPrivilege security privilege. Note that +privileges are different than permissions – see the +Conflicts Between User Rights and Permissions documentation +for more details.

    +

    This function passes NULL for security_attributes to the API.

    +
    + +
    +
    +winreg.SetValue(key, sub_key, type, value)
    +

    Associates a value with a specified key.

    +

    key is an already open key, or one of the predefined +HKEY_* constants.

    +

    sub_key is a string that names the subkey with which the value is associated.

    +

    type is an integer that specifies the type of the data. Currently this must be +REG_SZ, meaning only strings are supported. Use the SetValueEx() +function for support for other data types.

    +

    value is a string that specifies the new value.

    +

    If the key specified by the sub_key parameter does not exist, the SetValue +function creates it.

    +

    Value lengths are limited by available memory. Long values (more than 2048 +bytes) should be stored as files with the filenames stored in the configuration +registry. This helps the registry perform efficiently.

    +

    The key identified by the key parameter must have been opened with +KEY_SET_VALUE access.

    +
    + +
    +
    +winreg.SetValueEx(key, value_name, reserved, type, value)
    +

    Stores data in the value field of an open registry key.

    +

    key is an already open key, or one of the predefined +HKEY_* constants.

    +

    value_name is a string that names the subkey with which the value is +associated.

    +

    reserved can be anything – zero is always passed to the API.

    +

    type is an integer that specifies the type of the data. See +Value Types for the available types.

    +

    value is a string that specifies the new value.

    +

    This method can also set additional value and type information for the specified +key. The key identified by the key parameter must have been opened with +KEY_SET_VALUE access.

    +

    To open the key, use the CreateKey() or OpenKey() methods.

    +

    Value lengths are limited by available memory. Long values (more than 2048 +bytes) should be stored as files with the filenames stored in the configuration +registry. This helps the registry perform efficiently.

    +
    + +
    +
    +winreg.DisableReflectionKey(key)
    +

    Disables registry reflection for 32-bit processes running on a 64-bit +operating system.

    +

    key is an already open key, or one of the predefined HKEY_* constants.

    +

    Will generally raise NotImplemented if executed on a 32-bit operating +system.

    +

    If the key is not on the reflection list, the function succeeds but has no +effect. Disabling reflection for a key does not affect reflection of any +subkeys.

    +
    + +
    +
    +winreg.EnableReflectionKey(key)
    +

    Restores registry reflection for the specified disabled key.

    +

    key is an already open key, or one of the predefined HKEY_* constants.

    +

    Will generally raise NotImplemented if executed on a 32-bit operating +system.

    +

    Restoring reflection for a key does not affect reflection of any subkeys.

    +
    + +
    +
    +winreg.QueryReflectionKey(key)
    +

    Determines the reflection state for the specified key.

    +

    key is an already open key, or one of the predefined +HKEY_* constants.

    +

    Returns True if reflection is disabled.

    +

    Will generally raise NotImplemented if executed on a 32-bit +operating system.

    +
    + +
    +
    +

    Constants

    +

    The following constants are defined for use in many _winreg functions.

    +
    +

    HKEY_* Constants

    +
    +
    +winreg.HKEY_CLASSES_ROOT
    +

    Registry entries subordinate to this key define types (or classes) of +documents and the properties associated with those types. Shell and +COM applications use the information stored under this key.

    +
    + +
    +
    +winreg.HKEY_CURRENT_USER
    +

    Registry entries subordinate to this key define the preferences of +the current user. These preferences include the settings of +environment variables, data about program groups, colors, printers, +network connections, and application preferences.

    +
    + +
    +
    +winreg.HKEY_LOCAL_MACHINE
    +

    Registry entries subordinate to this key define the physical state +of the computer, including data about the bus type, system memory, +and installed hardware and software.

    +
    + +
    +
    +winreg.HKEY_USERS
    +

    Registry entries subordinate to this key define the default user +configuration for new users on the local computer and the user +configuration for the current user.

    +
    + +
    +
    +winreg.HKEY_PERFORMANCE_DATA
    +

    Registry entries subordinate to this key allow you to access +performance data. The data is not actually stored in the registry; +the registry functions cause the system to collect the data from +its source.

    +
    + +
    +
    +winreg.HKEY_CURRENT_CONFIG
    +

    Contains information about the current hardware profile of the +local computer system.

    +
    + +
    +
    +winreg.HKEY_DYN_DATA
    +

    This key is not used in versions of Windows after 98.

    +
    + +
    +
    +

    Access Rights

    +

    For more information, see Registry Key Security and Access.

    +
    +
    +winreg.KEY_ALL_ACCESS
    +

    Combines the STANDARD_RIGHTS_REQUIRED, KEY_QUERY_VALUE, +KEY_SET_VALUE, KEY_CREATE_SUB_KEY, +KEY_ENUMERATE_SUB_KEYS, KEY_NOTIFY, +and KEY_CREATE_LINK access rights.

    +
    + +
    +
    +winreg.KEY_WRITE
    +

    Combines the STANDARD_RIGHTS_WRITE, KEY_SET_VALUE, and +KEY_CREATE_SUB_KEY access rights.

    +
    + +
    +
    +winreg.KEY_READ
    +

    Combines the STANDARD_RIGHTS_READ, KEY_QUERY_VALUE, +KEY_ENUMERATE_SUB_KEYS, and KEY_NOTIFY values.

    +
    + +
    +
    +winreg.KEY_EXECUTE
    +

    Equivalent to KEY_READ.

    +
    + +
    +
    +winreg.KEY_QUERY_VALUE
    +

    Required to query the values of a registry key.

    +
    + +
    +
    +winreg.KEY_SET_VALUE
    +

    Required to create, delete, or set a registry value.

    +
    + +
    +
    +winreg.KEY_CREATE_SUB_KEY
    +

    Required to create a subkey of a registry key.

    +
    + +
    +
    +winreg.KEY_ENUMERATE_SUB_KEYS
    +

    Required to enumerate the subkeys of a registry key.

    +
    + +
    +
    +winreg.KEY_NOTIFY
    +

    Required to request change notifications for a registry key or for +subkeys of a registry key.

    +
    + +
    + +

    Reserved for system use.

    +
    + +
    +

    64-bit Specific

    +

    For more information, see Accessing an Alternate Registry View.

    +
    +
    +winreg.KEY_WOW64_64KEY
    +

    Indicates that an application on 64-bit Windows should operate on +the 64-bit registry view.

    +
    + +
    +
    +winreg.KEY_WOW64_32KEY
    +

    Indicates that an application on 64-bit Windows should operate on +the 32-bit registry view.

    +
    + +
    +
    +
    +

    Value Types

    +

    For more information, see Registry Value Types.

    +
    +
    +winreg.REG_BINARY
    +

    Binary data in any form.

    +
    + +
    +
    +winreg.REG_DWORD
    +

    32-bit number.

    +
    + +
    +
    +winreg.REG_DWORD_LITTLE_ENDIAN
    +

    A 32-bit number in little-endian format. Equivalent to REG_DWORD.

    +
    + +
    +
    +winreg.REG_DWORD_BIG_ENDIAN
    +

    A 32-bit number in big-endian format.

    +
    + +
    +
    +winreg.REG_EXPAND_SZ
    +

    Null-terminated string containing references to environment +variables (%PATH%).

    +
    + +
    + +

    A Unicode symbolic link.

    +
    + +
    +
    +winreg.REG_MULTI_SZ
    +

    A sequence of null-terminated strings, terminated by two null characters. +(Python handles this termination automatically.)

    +
    + +
    +
    +winreg.REG_NONE
    +

    No defined value type.

    +
    + +
    +
    +winreg.REG_QWORD
    +

    A 64-bit number.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +winreg.REG_QWORD_LITTLE_ENDIAN
    +

    A 64-bit number in little-endian format. Equivalent to REG_QWORD.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +winreg.REG_RESOURCE_LIST
    +

    A device-driver resource list.

    +
    + +
    +
    +winreg.REG_FULL_RESOURCE_DESCRIPTOR
    +

    A hardware setting.

    +
    + +
    +
    +winreg.REG_RESOURCE_REQUIREMENTS_LIST
    +

    A hardware resource list.

    +
    + +
    +
    +winreg.REG_SZ
    +

    A null-terminated string.

    +
    + +
    +
    +
    +

    Registry Handle Objects

    +

    This object wraps a Windows HKEY object, automatically closing it when the +object is destroyed. To guarantee cleanup, you can call either the +Close() method on the object, or the CloseKey() function.

    +

    All registry functions in this module return one of these objects.

    +

    All registry functions in this module which accept a handle object also accept +an integer, however, use of the handle object is encouraged.

    +

    Handle objects provide semantics for __bool__() – thus

    +
    if handle:
    +    print("Yes")
    +
    +
    +

    will print Yes if the handle is currently valid (has not been closed or +detached).

    +

    The object also support comparison semantics, so handle objects will compare +true if they both reference the same underlying Windows handle value.

    +

    Handle objects can be converted to an integer (e.g., using the built-in +int() function), in which case the underlying Windows handle value is +returned. You can also use the Detach() method to return the +integer handle, and also disconnect the Windows handle from the handle object.

    +
    +
    +PyHKEY.Close()
    +

    Closes the underlying Windows handle.

    +

    If the handle is already closed, no error is raised.

    +
    + +
    +
    +PyHKEY.Detach()
    +

    Detaches the Windows handle from the handle object.

    +

    The result is an integer that holds the value of the handle before it is +detached. If the handle is already detached or closed, this will return +zero.

    +

    After calling this function, the handle is effectively invalidated, but the +handle is not closed. You would call this function when you need the +underlying Win32 handle to exist beyond the lifetime of the handle object.

    +
    + +
    +
    +PyHKEY.__enter__()
    +
    +PyHKEY.__exit__(*exc_info)
    +

    The HKEY object implements __enter__() and +__exit__() and thus supports the context protocol for the +with statement:

    +
    with OpenKey(HKEY_LOCAL_MACHINE, "foo") as key:
    +    ...  # work with key
    +
    +
    +

    will automatically close key when control leaves the with block.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/winsound.html b/python-3.7.4-docs-html/library/winsound.html new file mode 100644 index 0000000..67a720a --- /dev/null +++ b/python-3.7.4-docs-html/library/winsound.html @@ -0,0 +1,362 @@ + + + + + + + winsound — Sound-playing interface for Windows — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    winsound — Sound-playing interface for Windows

    +
    +

    The winsound module provides access to the basic sound-playing machinery +provided by Windows platforms. It includes functions and several constants.

    +
    +
    +winsound.Beep(frequency, duration)
    +

    Beep the PC’s speaker. The frequency parameter specifies frequency, in hertz, +of the sound, and must be in the range 37 through 32,767. The duration +parameter specifies the number of milliseconds the sound should last. If the +system is not able to beep the speaker, RuntimeError is raised.

    +
    + +
    +
    +winsound.PlaySound(sound, flags)
    +

    Call the underlying PlaySound() function from the Platform API. The +sound parameter may be a filename, a system sound alias, audio data as a +bytes-like object, or None. Its +interpretation depends on the value of flags, which can be a bitwise ORed +combination of the constants described below. If the sound parameter is +None, any currently playing waveform sound is stopped. If the system +indicates an error, RuntimeError is raised.

    +
    + +
    +
    +winsound.MessageBeep(type=MB_OK)
    +

    Call the underlying MessageBeep() function from the Platform API. This +plays a sound as specified in the registry. The type argument specifies which +sound to play; possible values are -1, MB_ICONASTERISK, +MB_ICONEXCLAMATION, MB_ICONHAND, MB_ICONQUESTION, and MB_OK, all +described below. The value -1 produces a “simple beep”; this is the final +fallback if a sound cannot be played otherwise. If the system indicates an +error, RuntimeError is raised.

    +
    + +
    +
    +winsound.SND_FILENAME
    +

    The sound parameter is the name of a WAV file. Do not use with +SND_ALIAS.

    +
    + +
    +
    +winsound.SND_ALIAS
    +

    The sound parameter is a sound association name from the registry. If the +registry contains no such name, play the system default sound unless +SND_NODEFAULT is also specified. If no default sound is registered, +raise RuntimeError. Do not use with SND_FILENAME.

    +

    All Win32 systems support at least the following; most systems support many +more:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + +

    PlaySound() name

    Corresponding Control Panel Sound name

    'SystemAsterisk'

    Asterisk

    'SystemExclamation'

    Exclamation

    'SystemExit'

    Exit Windows

    'SystemHand'

    Critical Stop

    'SystemQuestion'

    Question

    +

    For example:

    +
    import winsound
    +# Play Windows exit sound.
    +winsound.PlaySound("SystemExit", winsound.SND_ALIAS)
    +
    +# Probably play Windows default sound, if any is registered (because
    +# "*" probably isn't the registered name of any sound).
    +winsound.PlaySound("*", winsound.SND_ALIAS)
    +
    +
    +
    + +
    +
    +winsound.SND_LOOP
    +

    Play the sound repeatedly. The SND_ASYNC flag must also be used to +avoid blocking. Cannot be used with SND_MEMORY.

    +
    + +
    +
    +winsound.SND_MEMORY
    +

    The sound parameter to PlaySound() is a memory image of a WAV file, as a +bytes-like object.

    +
    +

    Note

    +

    This module does not support playing from a memory image asynchronously, so a +combination of this flag and SND_ASYNC will raise RuntimeError.

    +
    +
    + +
    +
    +winsound.SND_PURGE
    +

    Stop playing all instances of the specified sound.

    +
    +

    Note

    +

    This flag is not supported on modern Windows platforms.

    +
    +
    + +
    +
    +winsound.SND_ASYNC
    +

    Return immediately, allowing sounds to play asynchronously.

    +
    + +
    +
    +winsound.SND_NODEFAULT
    +

    If the specified sound cannot be found, do not play the system default sound.

    +
    + +
    +
    +winsound.SND_NOSTOP
    +

    Do not interrupt sounds currently playing.

    +
    + +
    +
    +winsound.SND_NOWAIT
    +

    Return immediately if the sound driver is busy.

    +
    +

    Note

    +

    This flag is not supported on modern Windows platforms.

    +
    +
    + +
    +
    +winsound.MB_ICONASTERISK
    +

    Play the SystemDefault sound.

    +
    + +
    +
    +winsound.MB_ICONEXCLAMATION
    +

    Play the SystemExclamation sound.

    +
    + +
    +
    +winsound.MB_ICONHAND
    +

    Play the SystemHand sound.

    +
    + +
    +
    +winsound.MB_ICONQUESTION
    +

    Play the SystemQuestion sound.

    +
    + +
    +
    +winsound.MB_OK
    +

    Play the SystemDefault sound.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/wsgiref.html b/python-3.7.4-docs-html/library/wsgiref.html new file mode 100644 index 0000000..7bd2a7a --- /dev/null +++ b/python-3.7.4-docs-html/library/wsgiref.html @@ -0,0 +1,938 @@ + + + + + + + wsgiref — WSGI Utilities and Reference Implementation — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    wsgiref — WSGI Utilities and Reference Implementation

    +
    +

    The Web Server Gateway Interface (WSGI) is a standard interface between web +server software and web applications written in Python. Having a standard +interface makes it easy to use an application that supports WSGI with a number +of different web servers.

    +

    Only authors of web servers and programming frameworks need to know every detail +and corner case of the WSGI design. You don’t need to understand every detail +of WSGI just to install a WSGI application or to write a web application using +an existing framework.

    +

    wsgiref is a reference implementation of the WSGI specification that can +be used to add WSGI support to a web server or framework. It provides utilities +for manipulating WSGI environment variables and response headers, base classes +for implementing WSGI servers, a demo HTTP server that serves WSGI applications, +and a validation tool that checks WSGI servers and applications for conformance +to the WSGI specification (PEP 3333).

    +

    See wsgi.readthedocs.io for more information about WSGI, and links +to tutorials and other resources.

    +
    +

    wsgiref.util – WSGI environment utilities

    +

    This module provides a variety of utility functions for working with WSGI +environments. A WSGI environment is a dictionary containing HTTP request +variables as described in PEP 3333. All of the functions taking an environ +parameter expect a WSGI-compliant dictionary to be supplied; please see +PEP 3333 for a detailed specification.

    +
    +
    +wsgiref.util.guess_scheme(environ)
    +

    Return a guess for whether wsgi.url_scheme should be “http” or “https”, by +checking for a HTTPS environment variable in the environ dictionary. The +return value is a string.

    +

    This function is useful when creating a gateway that wraps CGI or a CGI-like +protocol such as FastCGI. Typically, servers providing such protocols will +include a HTTPS variable with a value of “1” “yes”, or “on” when a request +is received via SSL. So, this function returns “https” if such a value is +found, and “http” otherwise.

    +
    + +
    +
    +wsgiref.util.request_uri(environ, include_query=True)
    +

    Return the full request URI, optionally including the query string, using the +algorithm found in the “URL Reconstruction” section of PEP 3333. If +include_query is false, the query string is not included in the resulting URI.

    +
    + +
    +
    +wsgiref.util.application_uri(environ)
    +

    Similar to request_uri(), except that the PATH_INFO and +QUERY_STRING variables are ignored. The result is the base URI of the +application object addressed by the request.

    +
    + +
    +
    +wsgiref.util.shift_path_info(environ)
    +

    Shift a single name from PATH_INFO to SCRIPT_NAME and return the name. +The environ dictionary is modified in-place; use a copy if you need to keep +the original PATH_INFO or SCRIPT_NAME intact.

    +

    If there are no remaining path segments in PATH_INFO, None is returned.

    +

    Typically, this routine is used to process each portion of a request URI path, +for example to treat the path as a series of dictionary keys. This routine +modifies the passed-in environment to make it suitable for invoking another WSGI +application that is located at the target URI. For example, if there is a WSGI +application at /foo, and the request URI path is /foo/bar/baz, and the +WSGI application at /foo calls shift_path_info(), it will receive the +string “bar”, and the environment will be updated to be suitable for passing to +a WSGI application at /foo/bar. That is, SCRIPT_NAME will change from +/foo to /foo/bar, and PATH_INFO will change from /bar/baz to +/baz.

    +

    When PATH_INFO is just a “/”, this routine returns an empty string and +appends a trailing slash to SCRIPT_NAME, even though empty path segments are +normally ignored, and SCRIPT_NAME doesn’t normally end in a slash. This is +intentional behavior, to ensure that an application can tell the difference +between URIs ending in /x from ones ending in /x/ when using this +routine to do object traversal.

    +
    + +
    +
    +wsgiref.util.setup_testing_defaults(environ)
    +

    Update environ with trivial defaults for testing purposes.

    +

    This routine adds various parameters required for WSGI, including HTTP_HOST, +SERVER_NAME, SERVER_PORT, REQUEST_METHOD, SCRIPT_NAME, +PATH_INFO, and all of the PEP 3333-defined wsgi.* variables. It +only supplies default values, and does not replace any existing settings for +these variables.

    +

    This routine is intended to make it easier for unit tests of WSGI servers and +applications to set up dummy environments. It should NOT be used by actual WSGI +servers or applications, since the data is fake!

    +

    Example usage:

    +
    from wsgiref.util import setup_testing_defaults
    +from wsgiref.simple_server import make_server
    +
    +# A relatively simple WSGI application. It's going to print out the
    +# environment dictionary after being updated by setup_testing_defaults
    +def simple_app(environ, start_response):
    +    setup_testing_defaults(environ)
    +
    +    status = '200 OK'
    +    headers = [('Content-type', 'text/plain; charset=utf-8')]
    +
    +    start_response(status, headers)
    +
    +    ret = [("%s: %s\n" % (key, value)).encode("utf-8")
    +           for key, value in environ.items()]
    +    return ret
    +
    +with make_server('', 8000, simple_app) as httpd:
    +    print("Serving on port 8000...")
    +    httpd.serve_forever()
    +
    +
    +
    + +

    In addition to the environment functions above, the wsgiref.util module +also provides these miscellaneous utilities:

    +
    +
    +wsgiref.util.is_hop_by_hop(header_name)
    +

    Return true if ‘header_name’ is an HTTP/1.1 “Hop-by-Hop” header, as defined by +RFC 2616.

    +
    + +
    +
    +class wsgiref.util.FileWrapper(filelike, blksize=8192)
    +

    A wrapper to convert a file-like object to an iterator. The resulting objects +support both __getitem__() and __iter__() iteration styles, for +compatibility with Python 2.1 and Jython. As the object is iterated over, the +optional blksize parameter will be repeatedly passed to the filelike +object’s read() method to obtain bytestrings to yield. When read() +returns an empty bytestring, iteration is ended and is not resumable.

    +

    If filelike has a close() method, the returned object will also have a +close() method, and it will invoke the filelike object’s close() +method when called.

    +

    Example usage:

    +
    from io import StringIO
    +from wsgiref.util import FileWrapper
    +
    +# We're using a StringIO-buffer for as the file-like object
    +filelike = StringIO("This is an example file-like object"*10)
    +wrapper = FileWrapper(filelike, blksize=5)
    +
    +for chunk in wrapper:
    +    print(chunk)
    +
    +
    +
    + +
    +
    +

    wsgiref.headers – WSGI response header tools

    +

    This module provides a single class, Headers, for convenient +manipulation of WSGI response headers using a mapping-like interface.

    +
    +
    +class wsgiref.headers.Headers([headers])
    +

    Create a mapping-like object wrapping headers, which must be a list of header +name/value tuples as described in PEP 3333. The default value of headers is +an empty list.

    +

    Headers objects support typical mapping operations including +__getitem__(), get(), __setitem__(), setdefault(), +__delitem__() and __contains__(). For each of +these methods, the key is the header name (treated case-insensitively), and the +value is the first value associated with that header name. Setting a header +deletes any existing values for that header, then adds a new value at the end of +the wrapped header list. Headers’ existing order is generally maintained, with +new headers added to the end of the wrapped list.

    +

    Unlike a dictionary, Headers objects do not raise an error when you try +to get or delete a key that isn’t in the wrapped header list. Getting a +nonexistent header just returns None, and deleting a nonexistent header does +nothing.

    +

    Headers objects also support keys(), values(), and +items() methods. The lists returned by keys() and items() can +include the same key more than once if there is a multi-valued header. The +len() of a Headers object is the same as the length of its +items(), which is the same as the length of the wrapped header list. In +fact, the items() method just returns a copy of the wrapped header list.

    +

    Calling bytes() on a Headers object returns a formatted bytestring +suitable for transmission as HTTP response headers. Each header is placed on a +line with its value, separated by a colon and a space. Each line is terminated +by a carriage return and line feed, and the bytestring is terminated with a +blank line.

    +

    In addition to their mapping interface and formatting features, Headers +objects also have the following methods for querying and adding multi-valued +headers, and for adding headers with MIME parameters:

    +
    +
    +get_all(name)
    +

    Return a list of all the values for the named header.

    +

    The returned list will be sorted in the order they appeared in the original +header list or were added to this instance, and may contain duplicates. Any +fields deleted and re-inserted are always appended to the header list. If no +fields exist with the given name, returns an empty list.

    +
    + +
    +
    +add_header(name, value, **_params)
    +

    Add a (possibly multi-valued) header, with optional MIME parameters specified +via keyword arguments.

    +

    name is the header field to add. Keyword arguments can be used to set MIME +parameters for the header field. Each parameter must be a string or None. +Underscores in parameter names are converted to dashes, since dashes are illegal +in Python identifiers, but many MIME parameter names include dashes. If the +parameter value is a string, it is added to the header value parameters in the +form name="value". If it is None, only the parameter name is added. +(This is used for MIME parameters without a value.) Example usage:

    +
    h.add_header('content-disposition', 'attachment', filename='bud.gif')
    +
    +
    +

    The above will add a header that looks like this:

    +
    Content-Disposition: attachment; filename="bud.gif"
    +
    +
    +
    + +
    +

    Changed in version 3.5: headers parameter is optional.

    +
    +
    + +
    +
    +

    wsgiref.simple_server – a simple WSGI HTTP server

    +

    This module implements a simple HTTP server (based on http.server) +that serves WSGI applications. Each server instance serves a single WSGI +application on a given host and port. If you want to serve multiple +applications on a single host and port, you should create a WSGI application +that parses PATH_INFO to select which application to invoke for each +request. (E.g., using the shift_path_info() function from +wsgiref.util.)

    +
    +
    +wsgiref.simple_server.make_server(host, port, app, server_class=WSGIServer, handler_class=WSGIRequestHandler)
    +

    Create a new WSGI server listening on host and port, accepting connections +for app. The return value is an instance of the supplied server_class, and +will process requests using the specified handler_class. app must be a WSGI +application object, as defined by PEP 3333.

    +

    Example usage:

    +
    from wsgiref.simple_server import make_server, demo_app
    +
    +with make_server('', 8000, demo_app) as httpd:
    +    print("Serving HTTP on port 8000...")
    +
    +    # Respond to requests until process is killed
    +    httpd.serve_forever()
    +
    +    # Alternative: serve one request, then exit
    +    httpd.handle_request()
    +
    +
    +
    + +
    +
    +wsgiref.simple_server.demo_app(environ, start_response)
    +

    This function is a small but complete WSGI application that returns a text page +containing the message “Hello world!” and a list of the key/value pairs provided +in the environ parameter. It’s useful for verifying that a WSGI server (such +as wsgiref.simple_server) is able to run a simple WSGI application +correctly.

    +
    + +
    +
    +class wsgiref.simple_server.WSGIServer(server_address, RequestHandlerClass)
    +

    Create a WSGIServer instance. server_address should be a +(host,port) tuple, and RequestHandlerClass should be the subclass of +http.server.BaseHTTPRequestHandler that will be used to process +requests.

    +

    You do not normally need to call this constructor, as the make_server() +function can handle all the details for you.

    +

    WSGIServer is a subclass of http.server.HTTPServer, so all +of its methods (such as serve_forever() and handle_request()) are +available. WSGIServer also provides these WSGI-specific methods:

    +
    +
    +set_app(application)
    +

    Sets the callable application as the WSGI application that will receive +requests.

    +
    + +
    +
    +get_app()
    +

    Returns the currently-set application callable.

    +
    + +

    Normally, however, you do not need to use these additional methods, as +set_app() is normally called by make_server(), and the +get_app() exists mainly for the benefit of request handler instances.

    +
    + +
    +
    +class wsgiref.simple_server.WSGIRequestHandler(request, client_address, server)
    +

    Create an HTTP handler for the given request (i.e. a socket), client_address +(a (host,port) tuple), and server (WSGIServer instance).

    +

    You do not need to create instances of this class directly; they are +automatically created as needed by WSGIServer objects. You can, +however, subclass this class and supply it as a handler_class to the +make_server() function. Some possibly relevant methods for overriding in +subclasses:

    +
    +
    +get_environ()
    +

    Returns a dictionary containing the WSGI environment for a request. The default +implementation copies the contents of the WSGIServer object’s +base_environ dictionary attribute and then adds various headers derived +from the HTTP request. Each call to this method should return a new dictionary +containing all of the relevant CGI environment variables as specified in +PEP 3333.

    +
    + +
    +
    +get_stderr()
    +

    Return the object that should be used as the wsgi.errors stream. The default +implementation just returns sys.stderr.

    +
    + +
    +
    +handle()
    +

    Process the HTTP request. The default implementation creates a handler instance +using a wsgiref.handlers class to implement the actual WSGI application +interface.

    +
    + +
    + +
    +
    +

    wsgiref.validate — WSGI conformance checker

    +

    When creating new WSGI application objects, frameworks, servers, or middleware, +it can be useful to validate the new code’s conformance using +wsgiref.validate. This module provides a function that creates WSGI +application objects that validate communications between a WSGI server or +gateway and a WSGI application object, to check both sides for protocol +conformance.

    +

    Note that this utility does not guarantee complete PEP 3333 compliance; an +absence of errors from this module does not necessarily mean that errors do not +exist. However, if this module does produce an error, then it is virtually +certain that either the server or application is not 100% compliant.

    +

    This module is based on the paste.lint module from Ian Bicking’s “Python +Paste” library.

    +
    +
    +wsgiref.validate.validator(application)
    +

    Wrap application and return a new WSGI application object. The returned +application will forward all requests to the original application, and will +check that both the application and the server invoking it are conforming to +the WSGI specification and to RFC 2616.

    +

    Any detected nonconformance results in an AssertionError being raised; +note, however, that how these errors are handled is server-dependent. For +example, wsgiref.simple_server and other servers based on +wsgiref.handlers (that don’t override the error handling methods to do +something else) will simply output a message that an error has occurred, and +dump the traceback to sys.stderr or some other error stream.

    +

    This wrapper may also generate output using the warnings module to +indicate behaviors that are questionable but which may not actually be +prohibited by PEP 3333. Unless they are suppressed using Python command-line +options or the warnings API, any such warnings will be written to +sys.stderr (not wsgi.errors, unless they happen to be the same +object).

    +

    Example usage:

    +
    from wsgiref.validate import validator
    +from wsgiref.simple_server import make_server
    +
    +# 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
    +    start_response(status, headers)
    +
    +    # This is going to break because we need to return a list, and
    +    # the validator is going to inform us
    +    return b"Hello World"
    +
    +# This is the application wrapped in a validator
    +validator_app = validator(simple_app)
    +
    +with make_server('', 8000, validator_app) as httpd:
    +    print("Listening on port 8000....")
    +    httpd.serve_forever()
    +
    +
    +
    + +
    +
    +

    wsgiref.handlers – server/gateway base classes

    +

    This module provides base handler classes for implementing WSGI servers and +gateways. These base classes handle most of the work of communicating with a +WSGI application, as long as they are given a CGI-like environment, along with +input, output, and error streams.

    +
    +
    +class wsgiref.handlers.CGIHandler
    +

    CGI-based invocation via sys.stdin, sys.stdout, sys.stderr and +os.environ. This is useful when you have a WSGI application and want to run +it as a CGI script. Simply invoke CGIHandler().run(app), where app is +the WSGI application object you wish to invoke.

    +

    This class is a subclass of BaseCGIHandler that sets wsgi.run_once +to true, wsgi.multithread to false, and wsgi.multiprocess to true, and +always uses sys and os to obtain the necessary CGI streams and +environment.

    +
    + +
    +
    +class wsgiref.handlers.IISCGIHandler
    +

    A specialized alternative to CGIHandler, for use when deploying on +Microsoft’s IIS web server, without having set the config allowPathInfo +option (IIS>=7) or metabase allowPathInfoForScriptMappings (IIS<7).

    +

    By default, IIS gives a PATH_INFO that duplicates the SCRIPT_NAME at +the front, causing problems for WSGI applications that wish to implement +routing. This handler strips any such duplicated path.

    +

    IIS can be configured to pass the correct PATH_INFO, but this causes +another bug where PATH_TRANSLATED is wrong. Luckily this variable is +rarely used and is not guaranteed by WSGI. On IIS<7, though, the +setting can only be made on a vhost level, affecting all other script +mappings, many of which break when exposed to the PATH_TRANSLATED bug. +For this reason IIS<7 is almost never deployed with the fix. (Even IIS7 +rarely uses it because there is still no UI for it.)

    +

    There is no way for CGI code to tell whether the option was set, so a +separate handler class is provided. It is used in the same way as +CGIHandler, i.e., by calling IISCGIHandler().run(app), where +app is the WSGI application object you wish to invoke.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +class wsgiref.handlers.BaseCGIHandler(stdin, stdout, stderr, environ, multithread=True, multiprocess=False)
    +

    Similar to CGIHandler, but instead of using the sys and +os modules, the CGI environment and I/O streams are specified explicitly. +The multithread and multiprocess values are used to set the +wsgi.multithread and wsgi.multiprocess flags for any applications run by +the handler instance.

    +

    This class is a subclass of SimpleHandler intended for use with +software other than HTTP “origin servers”. If you are writing a gateway +protocol implementation (such as CGI, FastCGI, SCGI, etc.) that uses a +Status: header to send an HTTP status, you probably want to subclass this +instead of SimpleHandler.

    +
    + +
    +
    +class wsgiref.handlers.SimpleHandler(stdin, stdout, stderr, environ, multithread=True, multiprocess=False)
    +

    Similar to BaseCGIHandler, but designed for use with HTTP origin +servers. If you are writing an HTTP server implementation, you will probably +want to subclass this instead of BaseCGIHandler.

    +

    This class is a subclass of BaseHandler. It overrides the +__init__(), get_stdin(), get_stderr(), add_cgi_vars(), +_write(), and _flush() methods to support explicitly setting the +environment and streams via the constructor. The supplied environment and +streams are stored in the stdin, stdout, stderr, and +environ attributes.

    +

    The write() method of stdout should write +each chunk in full, like io.BufferedIOBase.

    +
    + +
    +
    +class wsgiref.handlers.BaseHandler
    +

    This is an abstract base class for running WSGI applications. Each instance +will handle a single HTTP request, although in principle you could create a +subclass that was reusable for multiple requests.

    +

    BaseHandler instances have only one method intended for external use:

    +
    +
    +run(app)
    +

    Run the specified WSGI application, app.

    +
    + +

    All of the other BaseHandler methods are invoked by this method in the +process of running the application, and thus exist primarily to allow +customizing the process.

    +

    The following methods MUST be overridden in a subclass:

    +
    +
    +_write(data)
    +

    Buffer the bytes data for transmission to the client. It’s okay if this +method actually transmits the data; BaseHandler just separates write +and flush operations for greater efficiency when the underlying system actually +has such a distinction.

    +
    + +
    +
    +_flush()
    +

    Force buffered data to be transmitted to the client. It’s okay if this method +is a no-op (i.e., if _write() actually sends the data).

    +
    + +
    +
    +get_stdin()
    +

    Return an input stream object suitable for use as the wsgi.input of the +request currently being processed.

    +
    + +
    +
    +get_stderr()
    +

    Return an output stream object suitable for use as the wsgi.errors of the +request currently being processed.

    +
    + +
    +
    +add_cgi_vars()
    +

    Insert CGI variables for the current request into the environ attribute.

    +
    + +

    Here are some other methods and attributes you may wish to override. This list +is only a summary, however, and does not include every method that can be +overridden. You should consult the docstrings and source code for additional +information before attempting to create a customized BaseHandler +subclass.

    +

    Attributes and methods for customizing the WSGI environment:

    +
    +
    +wsgi_multithread
    +

    The value to be used for the wsgi.multithread environment variable. It +defaults to true in BaseHandler, but may have a different default (or +be set by the constructor) in the other subclasses.

    +
    + +
    +
    +wsgi_multiprocess
    +

    The value to be used for the wsgi.multiprocess environment variable. It +defaults to true in BaseHandler, but may have a different default (or +be set by the constructor) in the other subclasses.

    +
    + +
    +
    +wsgi_run_once
    +

    The value to be used for the wsgi.run_once environment variable. It +defaults to false in BaseHandler, but CGIHandler sets it to +true by default.

    +
    + +
    +
    +os_environ
    +

    The default environment variables to be included in every request’s WSGI +environment. By default, this is a copy of os.environ at the time that +wsgiref.handlers was imported, but subclasses can either create their own +at the class or instance level. Note that the dictionary should be considered +read-only, since the default value is shared between multiple classes and +instances.

    +
    + +
    +
    +server_software
    +

    If the origin_server attribute is set, this attribute’s value is used to +set the default SERVER_SOFTWARE WSGI environment variable, and also to set a +default Server: header in HTTP responses. It is ignored for handlers (such +as BaseCGIHandler and CGIHandler) that are not HTTP origin +servers.

    +
    +

    Changed in version 3.3: The term “Python” is replaced with implementation specific term like +“CPython”, “Jython” etc.

    +
    +
    + +
    +
    +get_scheme()
    +

    Return the URL scheme being used for the current request. The default +implementation uses the guess_scheme() function from wsgiref.util +to guess whether the scheme should be “http” or “https”, based on the current +request’s environ variables.

    +
    + +
    +
    +setup_environ()
    +

    Set the environ attribute to a fully-populated WSGI environment. The +default implementation uses all of the above methods and attributes, plus the +get_stdin(), get_stderr(), and add_cgi_vars() methods and the +wsgi_file_wrapper attribute. It also inserts a SERVER_SOFTWARE key +if not present, as long as the origin_server attribute is a true value +and the server_software attribute is set.

    +
    + +

    Methods and attributes for customizing exception handling:

    +
    +
    +log_exception(exc_info)
    +

    Log the exc_info tuple in the server log. exc_info is a (type, value, +traceback) tuple. The default implementation simply writes the traceback to +the request’s wsgi.errors stream and flushes it. Subclasses can override +this method to change the format or retarget the output, mail the traceback to +an administrator, or whatever other action may be deemed suitable.

    +
    + +
    +
    +traceback_limit
    +

    The maximum number of frames to include in tracebacks output by the default +log_exception() method. If None, all frames are included.

    +
    + +
    +
    +error_output(environ, start_response)
    +

    This method is a WSGI application to generate an error page for the user. It is +only invoked if an error occurs before headers are sent to the client.

    +

    This method can access the current error information using sys.exc_info(), +and should pass that information to start_response when calling it (as +described in the “Error Handling” section of PEP 3333).

    +

    The default implementation just uses the error_status, +error_headers, and error_body attributes to generate an output +page. Subclasses can override this to produce more dynamic error output.

    +

    Note, however, that it’s not recommended from a security perspective to spit out +diagnostics to any old user; ideally, you should have to do something special to +enable diagnostic output, which is why the default implementation doesn’t +include any.

    +
    + +
    +
    +error_status
    +

    The HTTP status used for error responses. This should be a status string as +defined in PEP 3333; it defaults to a 500 code and message.

    +
    + +
    +
    +error_headers
    +

    The HTTP headers used for error responses. This should be a list of WSGI +response headers ((name, value) tuples), as described in PEP 3333. The +default list just sets the content type to text/plain.

    +
    + +
    +
    +error_body
    +

    The error response body. This should be an HTTP response body bytestring. It +defaults to the plain text, “A server error occurred. Please contact the +administrator.”

    +
    + +

    Methods and attributes for PEP 3333’s “Optional Platform-Specific File +Handling” feature:

    +
    +
    +wsgi_file_wrapper
    +

    A wsgi.file_wrapper factory, or None. The default value of this +attribute is the wsgiref.util.FileWrapper class.

    +
    + +
    +
    +sendfile()
    +

    Override to implement platform-specific file transmission. This method is +called only if the application’s return value is an instance of the class +specified by the wsgi_file_wrapper attribute. It should return a true +value if it was able to successfully transmit the file, so that the default +transmission code will not be executed. The default implementation of this +method just returns a false value.

    +
    + +

    Miscellaneous methods and attributes:

    +
    +
    +origin_server
    +

    This attribute should be set to a true value if the handler’s _write() and +_flush() are being used to communicate directly to the client, rather than +via a CGI-like gateway protocol that wants the HTTP status in a special +Status: header.

    +

    This attribute’s default value is true in BaseHandler, but false in +BaseCGIHandler and CGIHandler.

    +
    + +
    +
    +http_version
    +

    If origin_server is true, this string attribute is used to set the HTTP +version of the response set to the client. It defaults to "1.0".

    +
    + +
    + +
    +
    +wsgiref.handlers.read_environ()
    +

    Transcode CGI variables from os.environ to PEP 3333 “bytes in unicode” +strings, returning a new dictionary. This function is used by +CGIHandler and IISCGIHandler in place of directly using +os.environ, which is not necessarily WSGI-compliant on all platforms +and web servers using Python 3 – specifically, ones where the OS’s +actual environment is Unicode (i.e. Windows), or ones where the environment +is bytes, but the system encoding used by Python to decode it is anything +other than ISO-8859-1 (e.g. Unix systems using UTF-8).

    +

    If you are implementing a CGI-based handler of your own, you probably want +to use this routine instead of just copying values out of os.environ +directly.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +

    Examples

    +

    This is a working “Hello World” WSGI application:

    +
    from wsgiref.simple_server import make_server
    +
    +# Every WSGI application must have an application object - a callable
    +# object that accepts two arguments. For that purpose, we're going to
    +# use a function (note that you're not limited to a function, you can
    +# use a class for example). The first argument passed to the function
    +# 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
    +    start_response(status, headers)
    +
    +    # The returned object is going to be printed
    +    return [b"Hello World"]
    +
    +with make_server('', 8000, hello_world_app) as httpd:
    +    print("Serving on port 8000...")
    +
    +    # Serve until process is killed
    +    httpd.serve_forever()
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/xdrlib.html b/python-3.7.4-docs-html/library/xdrlib.html new file mode 100644 index 0000000..6c4bc92 --- /dev/null +++ b/python-3.7.4-docs-html/library/xdrlib.html @@ -0,0 +1,470 @@ + + + + + + + xdrlib — Encode and decode XDR data — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    xdrlib — Encode and decode XDR data

    +

    Source code: Lib/xdrlib.py

    +
    +

    The xdrlib module supports the External Data Representation Standard as +described in RFC 1014, written by Sun Microsystems, Inc. June 1987. It +supports most of the data types described in the RFC.

    +

    The xdrlib module defines two classes, one for packing variables into XDR +representation, and another for unpacking from XDR representation. There are +also two exception classes.

    +
    +
    +class xdrlib.Packer
    +

    Packer is the class for packing data into XDR representation. The +Packer class is instantiated with no arguments.

    +
    + +
    +
    +class xdrlib.Unpacker(data)
    +

    Unpacker is the complementary class which unpacks XDR data values from a +string buffer. The input buffer is given as data.

    +
    + +
    +

    See also

    +
    +
    RFC 1014 - XDR: External Data Representation Standard

    This RFC defined the encoding of data which was XDR at the time this module was +originally written. It has apparently been obsoleted by RFC 1832.

    +
    +
    RFC 1832 - XDR: External Data Representation Standard

    Newer RFC that provides a revised definition of XDR.

    +
    +
    +
    +
    +

    Packer Objects

    +

    Packer instances have the following methods:

    +
    +
    +Packer.get_buffer()
    +

    Returns the current pack buffer as a string.

    +
    + +
    +
    +Packer.reset()
    +

    Resets the pack buffer to the empty string.

    +
    + +

    In general, you can pack any of the most common XDR data types by calling the +appropriate pack_type() method. Each method takes a single argument, the +value to pack. The following simple data type packing methods are supported: +pack_uint(), pack_int(), pack_enum(), pack_bool(), +pack_uhyper(), and pack_hyper().

    +
    +
    +Packer.pack_float(value)
    +

    Packs the single-precision floating point number value.

    +
    + +
    +
    +Packer.pack_double(value)
    +

    Packs the double-precision floating point number value.

    +
    + +

    The following methods support packing strings, bytes, and opaque data:

    +
    +
    +Packer.pack_fstring(n, s)
    +

    Packs a fixed length string, s. n is the length of the string but it is +not packed into the data buffer. The string is padded with null bytes if +necessary to guaranteed 4 byte alignment.

    +
    + +
    +
    +Packer.pack_fopaque(n, data)
    +

    Packs a fixed length opaque data stream, similarly to pack_fstring().

    +
    + +
    +
    +Packer.pack_string(s)
    +

    Packs a variable length string, s. The length of the string is first packed +as an unsigned integer, then the string data is packed with +pack_fstring().

    +
    + +
    +
    +Packer.pack_opaque(data)
    +

    Packs a variable length opaque data string, similarly to pack_string().

    +
    + +
    +
    +Packer.pack_bytes(bytes)
    +

    Packs a variable length byte stream, similarly to pack_string().

    +
    + +

    The following methods support packing arrays and lists:

    +
    +
    +Packer.pack_list(list, pack_item)
    +

    Packs a list of homogeneous items. This method is useful for lists with an +indeterminate size; i.e. the size is not available until the entire list has +been walked. For each item in the list, an unsigned integer 1 is packed +first, followed by the data value from the list. pack_item is the function +that is called to pack the individual item. At the end of the list, an unsigned +integer 0 is packed.

    +

    For example, to pack a list of integers, the code might appear like this:

    +
    import xdrlib
    +p = xdrlib.Packer()
    +p.pack_list([1, 2, 3], p.pack_int)
    +
    +
    +
    + +
    +
    +Packer.pack_farray(n, array, pack_item)
    +

    Packs a fixed length list (array) of homogeneous items. n is the length of +the list; it is not packed into the buffer, but a ValueError exception +is raised if len(array) is not equal to n. As above, pack_item is the +function used to pack each element.

    +
    + +
    +
    +Packer.pack_array(list, pack_item)
    +

    Packs a variable length list of homogeneous items. First, the length of the +list is packed as an unsigned integer, then each element is packed as in +pack_farray() above.

    +
    + +
    +
    +

    Unpacker Objects

    +

    The Unpacker class offers the following methods:

    +
    +
    +Unpacker.reset(data)
    +

    Resets the string buffer with the given data.

    +
    + +
    +
    +Unpacker.get_position()
    +

    Returns the current unpack position in the data buffer.

    +
    + +
    +
    +Unpacker.set_position(position)
    +

    Sets the data buffer unpack position to position. You should be careful about +using get_position() and set_position().

    +
    + +
    +
    +Unpacker.get_buffer()
    +

    Returns the current unpack data buffer as a string.

    +
    + +
    +
    +Unpacker.done()
    +

    Indicates unpack completion. Raises an Error exception if all of the +data has not been unpacked.

    +
    + +

    In addition, every data type that can be packed with a Packer, can be +unpacked with an Unpacker. Unpacking methods are of the form +unpack_type(), and take no arguments. They return the unpacked object.

    +
    +
    +Unpacker.unpack_float()
    +

    Unpacks a single-precision floating point number.

    +
    + +
    +
    +Unpacker.unpack_double()
    +

    Unpacks a double-precision floating point number, similarly to +unpack_float().

    +
    + +

    In addition, the following methods unpack strings, bytes, and opaque data:

    +
    +
    +Unpacker.unpack_fstring(n)
    +

    Unpacks and returns a fixed length string. n is the number of characters +expected. Padding with null bytes to guaranteed 4 byte alignment is assumed.

    +
    + +
    +
    +Unpacker.unpack_fopaque(n)
    +

    Unpacks and returns a fixed length opaque data stream, similarly to +unpack_fstring().

    +
    + +
    +
    +Unpacker.unpack_string()
    +

    Unpacks and returns a variable length string. The length of the string is first +unpacked as an unsigned integer, then the string data is unpacked with +unpack_fstring().

    +
    + +
    +
    +Unpacker.unpack_opaque()
    +

    Unpacks and returns a variable length opaque data string, similarly to +unpack_string().

    +
    + +
    +
    +Unpacker.unpack_bytes()
    +

    Unpacks and returns a variable length byte stream, similarly to +unpack_string().

    +
    + +

    The following methods support unpacking arrays and lists:

    +
    +
    +Unpacker.unpack_list(unpack_item)
    +

    Unpacks and returns a list of homogeneous items. The list is unpacked one +element at a time by first unpacking an unsigned integer flag. If the flag is +1, then the item is unpacked and appended to the list. A flag of 0 +indicates the end of the list. unpack_item is the function that is called to +unpack the items.

    +
    + +
    +
    +Unpacker.unpack_farray(n, unpack_item)
    +

    Unpacks and returns (as a list) a fixed length array of homogeneous items. n +is number of list elements to expect in the buffer. As above, unpack_item is +the function used to unpack each element.

    +
    + +
    +
    +Unpacker.unpack_array(unpack_item)
    +

    Unpacks and returns a variable length list of homogeneous items. First, the +length of the list is unpacked as an unsigned integer, then each element is +unpacked as in unpack_farray() above.

    +
    + +
    +
    +

    Exceptions

    +

    Exceptions in this module are coded as class instances:

    +
    +
    +exception xdrlib.Error
    +

    The base exception class. Error has a single public attribute +msg containing the description of the error.

    +
    + +
    +
    +exception xdrlib.ConversionError
    +

    Class derived from Error. Contains no additional instance variables.

    +
    + +

    Here is an example of how you would catch one of these exceptions:

    +
    import xdrlib
    +p = xdrlib.Packer()
    +try:
    +    p.pack_double(8.01)
    +except xdrlib.ConversionError as instance:
    +    print('packing the double failed:', instance.msg)
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/xml.dom.html b/python-3.7.4-docs-html/library/xml.dom.html new file mode 100644 index 0000000..576e7ee --- /dev/null +++ b/python-3.7.4-docs-html/library/xml.dom.html @@ -0,0 +1,1289 @@ + + + + + + + xml.dom — The Document Object Model API — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    xml.dom — The Document Object Model API

    +

    Source code: Lib/xml/dom/__init__.py

    +
    +

    The Document Object Model, or “DOM,” is a cross-language API from the World Wide +Web Consortium (W3C) for accessing and modifying XML documents. A DOM +implementation presents an XML document as a tree structure, or allows client +code to build such a structure from scratch. It then gives access to the +structure through a set of objects which provided well-known interfaces.

    +

    The DOM is extremely useful for random-access applications. SAX only allows you +a view of one bit of the document at a time. If you are looking at one SAX +element, you have no access to another. If you are looking at a text node, you +have no access to a containing element. When you write a SAX application, you +need to keep track of your program’s position in the document somewhere in your +own code. SAX does not do it for you. Also, if you need to look ahead in the +XML document, you are just out of luck.

    +

    Some applications are simply impossible in an event driven model with no access +to a tree. Of course you could build some sort of tree yourself in SAX events, +but the DOM allows you to avoid writing that code. The DOM is a standard tree +representation for XML data.

    +

    The Document Object Model is being defined by the W3C in stages, or “levels” in +their terminology. The Python mapping of the API is substantially based on the +DOM Level 2 recommendation.

    +

    DOM applications typically start by parsing some XML into a DOM. How this is +accomplished is not covered at all by DOM Level 1, and Level 2 provides only +limited improvements: There is a DOMImplementation object class which +provides access to Document creation methods, but no way to access an +XML reader/parser/Document builder in an implementation-independent way. There +is also no well-defined way to access these methods without an existing +Document object. In Python, each DOM implementation will provide a +function getDOMImplementation(). DOM Level 3 adds a Load/Store +specification, which defines an interface to the reader, but this is not yet +available in the Python standard library.

    +

    Once you have a DOM document object, you can access the parts of your XML +document through its properties and methods. These properties are defined in +the DOM specification; this portion of the reference manual describes the +interpretation of the specification in Python.

    +

    The specification provided by the W3C defines the DOM API for Java, ECMAScript, +and OMG IDL. The Python mapping defined here is based in large part on the IDL +version of the specification, but strict compliance is not required (though +implementations are free to support the strict mapping from IDL). See section +Conformance for a detailed discussion of mapping requirements.

    +
    +

    See also

    +
    +
    Document Object Model (DOM) Level 2 Specification

    The W3C recommendation upon which the Python DOM API is based.

    +
    +
    Document Object Model (DOM) Level 1 Specification

    The W3C recommendation for the DOM supported by xml.dom.minidom.

    +
    +
    Python Language Mapping Specification

    This specifies the mapping from OMG IDL to Python.

    +
    +
    +
    +
    +

    Module Contents

    +

    The xml.dom contains the following functions:

    +
    +
    +xml.dom.registerDOMImplementation(name, factory)
    +

    Register the factory function with the name name. The factory function +should return an object which implements the DOMImplementation +interface. The factory function can return the same object every time, or a new +one for each call, as appropriate for the specific implementation (e.g. if that +implementation supports some customization).

    +
    + +
    +
    +xml.dom.getDOMImplementation(name=None, features=())
    +

    Return a suitable DOM implementation. The name is either well-known, the +module name of a DOM implementation, or None. If it is not None, imports +the corresponding module and returns a DOMImplementation object if the +import succeeds. If no name is given, and if the environment variable +PYTHON_DOM is set, this variable is used to find the implementation.

    +

    If name is not given, this examines the available implementations to find one +with the required feature set. If no implementation can be found, raise an +ImportError. The features list must be a sequence of (feature, +version) pairs which are passed to the hasFeature() method on available +DOMImplementation objects.

    +
    + +

    Some convenience constants are also provided:

    +
    +
    +xml.dom.EMPTY_NAMESPACE
    +

    The value used to indicate that no namespace is associated with a node in the +DOM. This is typically found as the namespaceURI of a node, or used as +the namespaceURI parameter to a namespaces-specific method.

    +
    + +
    +
    +xml.dom.XML_NAMESPACE
    +

    The namespace URI associated with the reserved prefix xml, as defined by +Namespaces in XML (section 4).

    +
    + +
    +
    +xml.dom.XMLNS_NAMESPACE
    +

    The namespace URI for namespace declarations, as defined by Document Object +Model (DOM) Level 2 Core Specification (section 1.1.8).

    +
    + +
    +
    +xml.dom.XHTML_NAMESPACE
    +

    The URI of the XHTML namespace as defined by XHTML 1.0: The Extensible +HyperText Markup Language (section 3.1.1).

    +
    + +

    In addition, xml.dom contains a base Node class and the DOM +exception classes. The Node class provided by this module does not +implement any of the methods or attributes defined by the DOM specification; +concrete DOM implementations must provide those. The Node class +provided as part of this module does provide the constants used for the +nodeType attribute on concrete Node objects; they are located +within the class rather than at the module level to conform with the DOM +specifications.

    +
    +
    +

    Objects in the DOM

    +

    The definitive documentation for the DOM is the DOM specification from the W3C.

    +

    Note that DOM attributes may also be manipulated as nodes instead of as simple +strings. It is fairly rare that you must do this, however, so this usage is not +yet documented.

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Interface

    Section

    Purpose

    DOMImplementation

    DOMImplementation Objects

    Interface to the underlying +implementation.

    Node

    Node Objects

    Base interface for most objects +in a document.

    NodeList

    NodeList Objects

    Interface for a sequence of +nodes.

    DocumentType

    DocumentType Objects

    Information about the +declarations needed to process +a document.

    Document

    Document Objects

    Object which represents an +entire document.

    Element

    Element Objects

    Element nodes in the document +hierarchy.

    Attr

    Attr Objects

    Attribute value nodes on +element nodes.

    Comment

    Comment Objects

    Representation of comments in +the source document.

    Text

    Text and CDATASection Objects

    Nodes containing textual +content from the document.

    ProcessingInstruction

    ProcessingInstruction Objects

    Processing instruction +representation.

    +

    An additional section describes the exceptions defined for working with the DOM +in Python.

    +
    +

    DOMImplementation Objects

    +

    The DOMImplementation interface provides a way for applications to +determine the availability of particular features in the DOM they are using. +DOM Level 2 added the ability to create new Document and +DocumentType objects using the DOMImplementation as well.

    +
    +
    +DOMImplementation.hasFeature(feature, version)
    +

    Return true if the feature identified by the pair of strings feature and +version is implemented.

    +
    + +
    +
    +DOMImplementation.createDocument(namespaceUri, qualifiedName, doctype)
    +

    Return a new Document object (the root of the DOM), with a child +Element object having the given namespaceUri and qualifiedName. The +doctype must be a DocumentType object created by +createDocumentType(), or None. In the Python DOM API, the first two +arguments can also be None in order to indicate that no Element +child is to be created.

    +
    + +
    +
    +DOMImplementation.createDocumentType(qualifiedName, publicId, systemId)
    +

    Return a new DocumentType object that encapsulates the given +qualifiedName, publicId, and systemId strings, representing the +information contained in an XML document type declaration.

    +
    + +
    +
    +

    Node Objects

    +

    All of the components of an XML document are subclasses of Node.

    +
    +
    +Node.nodeType
    +

    An integer representing the node type. Symbolic constants for the types are on +the Node object: ELEMENT_NODE, ATTRIBUTE_NODE, +TEXT_NODE, CDATA_SECTION_NODE, ENTITY_NODE, +PROCESSING_INSTRUCTION_NODE, COMMENT_NODE, +DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE. +This is a read-only attribute.

    +
    + +
    +
    +Node.parentNode
    +

    The parent of the current node, or None for the document node. The value is +always a Node object or None. For Element nodes, this +will be the parent element, except for the root element, in which case it will +be the Document object. For Attr nodes, this is always +None. This is a read-only attribute.

    +
    + +
    +
    +Node.attributes
    +

    A NamedNodeMap of attribute objects. Only elements have actual values +for this; others provide None for this attribute. This is a read-only +attribute.

    +
    + +
    +
    +Node.previousSibling
    +

    The node that immediately precedes this one with the same parent. For +instance the element with an end-tag that comes just before the self +element’s start-tag. Of course, XML documents are made up of more than just +elements so the previous sibling could be text, a comment, or something else. +If this node is the first child of the parent, this attribute will be +None. This is a read-only attribute.

    +
    + +
    +
    +Node.nextSibling
    +

    The node that immediately follows this one with the same parent. See also +previousSibling. If this is the last child of the parent, this +attribute will be None. This is a read-only attribute.

    +
    + +
    +
    +Node.childNodes
    +

    A list of nodes contained within this node. This is a read-only attribute.

    +
    + +
    +
    +Node.firstChild
    +

    The first child of the node, if there are any, or None. This is a read-only +attribute.

    +
    + +
    +
    +Node.lastChild
    +

    The last child of the node, if there are any, or None. This is a read-only +attribute.

    +
    + +
    +
    +Node.localName
    +

    The part of the tagName following the colon if there is one, else the +entire tagName. The value is a string.

    +
    + +
    +
    +Node.prefix
    +

    The part of the tagName preceding the colon if there is one, else the +empty string. The value is a string, or None.

    +
    + +
    +
    +Node.namespaceURI
    +

    The namespace associated with the element name. This will be a string or +None. This is a read-only attribute.

    +
    + +
    +
    +Node.nodeName
    +

    This has a different meaning for each node type; see the DOM specification for +details. You can always get the information you would get here from another +property such as the tagName property for elements or the name +property for attributes. For all node types, the value of this attribute will be +either a string or None. This is a read-only attribute.

    +
    + +
    +
    +Node.nodeValue
    +

    This has a different meaning for each node type; see the DOM specification for +details. The situation is similar to that with nodeName. The value is +a string or None.

    +
    + +
    +
    +Node.hasAttributes()
    +

    Returns true if the node has any attributes.

    +
    + +
    +
    +Node.hasChildNodes()
    +

    Returns true if the node has any child nodes.

    +
    + +
    +
    +Node.isSameNode(other)
    +

    Returns true if other refers to the same node as this node. This is especially +useful for DOM implementations which use any sort of proxy architecture (because +more than one object can refer to the same node).

    +
    +

    Note

    +

    This is based on a proposed DOM Level 3 API which is still in the “working +draft” stage, but this particular interface appears uncontroversial. Changes +from the W3C will not necessarily affect this method in the Python DOM interface +(though any new W3C API for this would also be supported).

    +
    +
    + +
    +
    +Node.appendChild(newChild)
    +

    Add a new child node to this node at the end of the list of +children, returning newChild. If the node was already in +the tree, it is removed first.

    +
    + +
    +
    +Node.insertBefore(newChild, refChild)
    +

    Insert a new child node before an existing child. It must be the case that +refChild is a child of this node; if not, ValueError is raised. +newChild is returned. If refChild is None, it inserts newChild at the +end of the children’s list.

    +
    + +
    +
    +Node.removeChild(oldChild)
    +

    Remove a child node. oldChild must be a child of this node; if not, +ValueError is raised. oldChild is returned on success. If oldChild +will not be used further, its unlink() method should be called.

    +
    + +
    +
    +Node.replaceChild(newChild, oldChild)
    +

    Replace an existing node with a new node. It must be the case that oldChild +is a child of this node; if not, ValueError is raised.

    +
    + +
    +
    +Node.normalize()
    +

    Join adjacent text nodes so that all stretches of text are stored as single +Text instances. This simplifies processing text from a DOM tree for +many applications.

    +
    + +
    +
    +Node.cloneNode(deep)
    +

    Clone this node. Setting deep means to clone all child nodes as well. This +returns the clone.

    +
    + +
    +
    +

    NodeList Objects

    +

    A NodeList represents a sequence of nodes. These objects are used in +two ways in the DOM Core recommendation: an Element object provides +one as its list of child nodes, and the getElementsByTagName() and +getElementsByTagNameNS() methods of Node return objects with this +interface to represent query results.

    +

    The DOM Level 2 recommendation defines one method and one attribute for these +objects:

    +
    +
    +NodeList.item(i)
    +

    Return the i’th item from the sequence, if there is one, or None. The +index i is not allowed to be less than zero or greater than or equal to the +length of the sequence.

    +
    + +
    +
    +NodeList.length
    +

    The number of nodes in the sequence.

    +
    + +

    In addition, the Python DOM interface requires that some additional support is +provided to allow NodeList objects to be used as Python sequences. All +NodeList implementations must include support for +__len__() and +__getitem__(); this allows iteration over the NodeList in +for statements and proper support for the len() built-in +function.

    +

    If a DOM implementation supports modification of the document, the +NodeList implementation must also support the +__setitem__() and __delitem__() methods.

    +
    +
    +

    DocumentType Objects

    +

    Information about the notations and entities declared by a document (including +the external subset if the parser uses it and can provide the information) is +available from a DocumentType object. The DocumentType for a +document is available from the Document object’s doctype +attribute; if there is no DOCTYPE declaration for the document, the +document’s doctype attribute will be set to None instead of an +instance of this interface.

    +

    DocumentType is a specialization of Node, and adds the +following attributes:

    +
    +
    +DocumentType.publicId
    +

    The public identifier for the external subset of the document type definition. +This will be a string or None.

    +
    + +
    +
    +DocumentType.systemId
    +

    The system identifier for the external subset of the document type definition. +This will be a URI as a string, or None.

    +
    + +
    +
    +DocumentType.internalSubset
    +

    A string giving the complete internal subset from the document. This does not +include the brackets which enclose the subset. If the document has no internal +subset, this should be None.

    +
    + +
    +
    +DocumentType.name
    +

    The name of the root element as given in the DOCTYPE declaration, if +present.

    +
    + +
    +
    +DocumentType.entities
    +

    This is a NamedNodeMap giving the definitions of external entities. +For entity names defined more than once, only the first definition is provided +(others are ignored as required by the XML recommendation). This may be +None if the information is not provided by the parser, or if no entities are +defined.

    +
    + +
    +
    +DocumentType.notations
    +

    This is a NamedNodeMap giving the definitions of notations. For +notation names defined more than once, only the first definition is provided +(others are ignored as required by the XML recommendation). This may be +None if the information is not provided by the parser, or if no notations +are defined.

    +
    + +
    +
    +

    Document Objects

    +

    A Document represents an entire XML document, including its constituent +elements, attributes, processing instructions, comments etc. Remember that it +inherits properties from Node.

    +
    +
    +Document.documentElement
    +

    The one and only root element of the document.

    +
    + +
    +
    +Document.createElement(tagName)
    +

    Create and return a new element node. The element is not inserted into the +document when it is created. You need to explicitly insert it with one of the +other methods such as insertBefore() or appendChild().

    +
    + +
    +
    +Document.createElementNS(namespaceURI, tagName)
    +

    Create and return a new element with a namespace. The tagName may have a +prefix. The element is not inserted into the document when it is created. You +need to explicitly insert it with one of the other methods such as +insertBefore() or appendChild().

    +
    + +
    +
    +Document.createTextNode(data)
    +

    Create and return a text node containing the data passed as a parameter. As +with the other creation methods, this one does not insert the node into the +tree.

    +
    + +
    +
    +Document.createComment(data)
    +

    Create and return a comment node containing the data passed as a parameter. As +with the other creation methods, this one does not insert the node into the +tree.

    +
    + +
    +
    +Document.createProcessingInstruction(target, data)
    +

    Create and return a processing instruction node containing the target and +data passed as parameters. As with the other creation methods, this one does +not insert the node into the tree.

    +
    + +
    +
    +Document.createAttribute(name)
    +

    Create and return an attribute node. This method does not associate the +attribute node with any particular element. You must use +setAttributeNode() on the appropriate Element object to use the +newly created attribute instance.

    +
    + +
    +
    +Document.createAttributeNS(namespaceURI, qualifiedName)
    +

    Create and return an attribute node with a namespace. The tagName may have a +prefix. This method does not associate the attribute node with any particular +element. You must use setAttributeNode() on the appropriate +Element object to use the newly created attribute instance.

    +
    + +
    +
    +Document.getElementsByTagName(tagName)
    +

    Search for all descendants (direct children, children’s children, etc.) with a +particular element type name.

    +
    + +
    +
    +Document.getElementsByTagNameNS(namespaceURI, localName)
    +

    Search for all descendants (direct children, children’s children, etc.) with a +particular namespace URI and localname. The localname is the part of the +namespace after the prefix.

    +
    + +
    +
    +

    Element Objects

    +

    Element is a subclass of Node, so inherits all the attributes +of that class.

    +
    +
    +Element.tagName
    +

    The element type name. In a namespace-using document it may have colons in it. +The value is a string.

    +
    + +
    +
    +Element.getElementsByTagName(tagName)
    +

    Same as equivalent method in the Document class.

    +
    + +
    +
    +Element.getElementsByTagNameNS(namespaceURI, localName)
    +

    Same as equivalent method in the Document class.

    +
    + +
    +
    +Element.hasAttribute(name)
    +

    Returns true if the element has an attribute named by name.

    +
    + +
    +
    +Element.hasAttributeNS(namespaceURI, localName)
    +

    Returns true if the element has an attribute named by namespaceURI and +localName.

    +
    + +
    +
    +Element.getAttribute(name)
    +

    Return the value of the attribute named by name as a string. If no such +attribute exists, an empty string is returned, as if the attribute had no value.

    +
    + +
    +
    +Element.getAttributeNode(attrname)
    +

    Return the Attr node for the attribute named by attrname.

    +
    + +
    +
    +Element.getAttributeNS(namespaceURI, localName)
    +

    Return the value of the attribute named by namespaceURI and localName as a +string. If no such attribute exists, an empty string is returned, as if the +attribute had no value.

    +
    + +
    +
    +Element.getAttributeNodeNS(namespaceURI, localName)
    +

    Return an attribute value as a node, given a namespaceURI and localName.

    +
    + +
    +
    +Element.removeAttribute(name)
    +

    Remove an attribute by name. If there is no matching attribute, a +NotFoundErr is raised.

    +
    + +
    +
    +Element.removeAttributeNode(oldAttr)
    +

    Remove and return oldAttr from the attribute list, if present. If oldAttr is +not present, NotFoundErr is raised.

    +
    + +
    +
    +Element.removeAttributeNS(namespaceURI, localName)
    +

    Remove an attribute by name. Note that it uses a localName, not a qname. No +exception is raised if there is no matching attribute.

    +
    + +
    +
    +Element.setAttribute(name, value)
    +

    Set an attribute value from a string.

    +
    + +
    +
    +Element.setAttributeNode(newAttr)
    +

    Add a new attribute node to the element, replacing an existing attribute if +necessary if the name attribute matches. If a replacement occurs, the +old attribute node will be returned. If newAttr is already in use, +InuseAttributeErr will be raised.

    +
    + +
    +
    +Element.setAttributeNodeNS(newAttr)
    +

    Add a new attribute node to the element, replacing an existing attribute if +necessary if the namespaceURI and localName attributes match. +If a replacement occurs, the old attribute node will be returned. If newAttr +is already in use, InuseAttributeErr will be raised.

    +
    + +
    +
    +Element.setAttributeNS(namespaceURI, qname, value)
    +

    Set an attribute value from a string, given a namespaceURI and a qname. +Note that a qname is the whole attribute name. This is different than above.

    +
    + +
    +
    +

    Attr Objects

    +

    Attr inherits from Node, so inherits all its attributes.

    +
    +
    +Attr.name
    +

    The attribute name. +In a namespace-using document it may include a colon.

    +
    + +
    +
    +Attr.localName
    +

    The part of the name following the colon if there is one, else the +entire name. +This is a read-only attribute.

    +
    + +
    +
    +Attr.prefix
    +

    The part of the name preceding the colon if there is one, else the +empty string.

    +
    + +
    +
    +Attr.value
    +

    The text value of the attribute. This is a synonym for the +nodeValue attribute.

    +
    + +
    +
    +

    NamedNodeMap Objects

    +

    NamedNodeMap does not inherit from Node.

    +
    +
    +NamedNodeMap.length
    +

    The length of the attribute list.

    +
    + +
    +
    +NamedNodeMap.item(index)
    +

    Return an attribute with a particular index. The order you get the attributes +in is arbitrary but will be consistent for the life of a DOM. Each item is an +attribute node. Get its value with the value attribute.

    +
    + +

    There are also experimental methods that give this class more mapping behavior. +You can use them or you can use the standardized getAttribute*() family +of methods on the Element objects.

    +
    +
    +

    Comment Objects

    +

    Comment represents a comment in the XML document. It is a subclass of +Node, but cannot have child nodes.

    +
    +
    +Comment.data
    +

    The content of the comment as a string. The attribute contains all characters +between the leading <!-- and trailing -->, but does not +include them.

    +
    + +
    +
    +

    Text and CDATASection Objects

    +

    The Text interface represents text in the XML document. If the parser +and DOM implementation support the DOM’s XML extension, portions of the text +enclosed in CDATA marked sections are stored in CDATASection objects. +These two interfaces are identical, but provide different values for the +nodeType attribute.

    +

    These interfaces extend the Node interface. They cannot have child +nodes.

    +
    +
    +Text.data
    +

    The content of the text node as a string.

    +
    + +
    +

    Note

    +

    The use of a CDATASection node does not indicate that the node +represents a complete CDATA marked section, only that the content of the node +was part of a CDATA section. A single CDATA section may be represented by more +than one node in the document tree. There is no way to determine whether two +adjacent CDATASection nodes represent different CDATA marked sections.

    +
    +
    +
    +

    ProcessingInstruction Objects

    +

    Represents a processing instruction in the XML document; this inherits from the +Node interface and cannot have child nodes.

    +
    +
    +ProcessingInstruction.target
    +

    The content of the processing instruction up to the first whitespace character. +This is a read-only attribute.

    +
    + +
    +
    +ProcessingInstruction.data
    +

    The content of the processing instruction following the first whitespace +character.

    +
    + +
    +
    +

    Exceptions

    +

    The DOM Level 2 recommendation defines a single exception, DOMException, +and a number of constants that allow applications to determine what sort of +error occurred. DOMException instances carry a code attribute +that provides the appropriate value for the specific exception.

    +

    The Python DOM interface provides the constants, but also expands the set of +exceptions so that a specific exception exists for each of the exception codes +defined by the DOM. The implementations must raise the appropriate specific +exception, each of which carries the appropriate value for the code +attribute.

    +
    +
    +exception xml.dom.DOMException
    +

    Base exception class used for all specific DOM exceptions. This exception class +cannot be directly instantiated.

    +
    + +
    +
    +exception xml.dom.DomstringSizeErr
    +

    Raised when a specified range of text does not fit into a string. This is not +known to be used in the Python DOM implementations, but may be received from DOM +implementations not written in Python.

    +
    + +
    +
    +exception xml.dom.HierarchyRequestErr
    +

    Raised when an attempt is made to insert a node where the node type is not +allowed.

    +
    + +
    +
    +exception xml.dom.IndexSizeErr
    +

    Raised when an index or size parameter to a method is negative or exceeds the +allowed values.

    +
    + +
    +
    +exception xml.dom.InuseAttributeErr
    +

    Raised when an attempt is made to insert an Attr node that is already +present elsewhere in the document.

    +
    + +
    +
    +exception xml.dom.InvalidAccessErr
    +

    Raised if a parameter or an operation is not supported on the underlying object.

    +
    + +
    +
    +exception xml.dom.InvalidCharacterErr
    +

    This exception is raised when a string parameter contains a character that is +not permitted in the context it’s being used in by the XML 1.0 recommendation. +For example, attempting to create an Element node with a space in the +element type name will cause this error to be raised.

    +
    + +
    +
    +exception xml.dom.InvalidModificationErr
    +

    Raised when an attempt is made to modify the type of a node.

    +
    + +
    +
    +exception xml.dom.InvalidStateErr
    +

    Raised when an attempt is made to use an object that is not defined or is no +longer usable.

    +
    + +
    +
    +exception xml.dom.NamespaceErr
    +

    If an attempt is made to change any object in a way that is not permitted with +regard to the Namespaces in XML +recommendation, this exception is raised.

    +
    + +
    +
    +exception xml.dom.NotFoundErr
    +

    Exception when a node does not exist in the referenced context. For example, +NamedNodeMap.removeNamedItem() will raise this if the node passed in does +not exist in the map.

    +
    + +
    +
    +exception xml.dom.NotSupportedErr
    +

    Raised when the implementation does not support the requested type of object or +operation.

    +
    + +
    +
    +exception xml.dom.NoDataAllowedErr
    +

    This is raised if data is specified for a node which does not support data.

    +
    + +
    +
    +exception xml.dom.NoModificationAllowedErr
    +

    Raised on attempts to modify an object where modifications are not allowed (such +as for read-only nodes).

    +
    + +
    +
    +exception xml.dom.SyntaxErr
    +

    Raised when an invalid or illegal string is specified.

    +
    + +
    +
    +exception xml.dom.WrongDocumentErr
    +

    Raised when a node is inserted in a different document than it currently belongs +to, and the implementation does not support migrating the node from one document +to the other.

    +
    + +

    The exception codes defined in the DOM recommendation map to the exceptions +described above according to this table:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Constant

    Exception

    DOMSTRING_SIZE_ERR

    DomstringSizeErr

    HIERARCHY_REQUEST_ERR

    HierarchyRequestErr

    INDEX_SIZE_ERR

    IndexSizeErr

    INUSE_ATTRIBUTE_ERR

    InuseAttributeErr

    INVALID_ACCESS_ERR

    InvalidAccessErr

    INVALID_CHARACTER_ERR

    InvalidCharacterErr

    INVALID_MODIFICATION_ERR

    InvalidModificationErr

    INVALID_STATE_ERR

    InvalidStateErr

    NAMESPACE_ERR

    NamespaceErr

    NOT_FOUND_ERR

    NotFoundErr

    NOT_SUPPORTED_ERR

    NotSupportedErr

    NO_DATA_ALLOWED_ERR

    NoDataAllowedErr

    NO_MODIFICATION_ALLOWED_ERR

    NoModificationAllowedErr

    SYNTAX_ERR

    SyntaxErr

    WRONG_DOCUMENT_ERR

    WrongDocumentErr

    +
    +
    +
    +

    Conformance

    +

    This section describes the conformance requirements and relationships between +the Python DOM API, the W3C DOM recommendations, and the OMG IDL mapping for +Python.

    +
    +

    Type Mapping

    +

    The IDL types used in the DOM specification are mapped to Python types +according to the following table.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + +

    IDL Type

    Python Type

    boolean

    bool or int

    int

    int

    long int

    int

    unsigned int

    int

    DOMString

    str or bytes

    null

    None

    +
    +
    +

    Accessor Methods

    +

    The mapping from OMG IDL to Python defines accessor functions for IDL +attribute declarations in much the way the Java mapping does. +Mapping the IDL declarations

    +
    readonly attribute string someValue;
    +         attribute string anotherValue;
    +
    +
    +

    yields three accessor functions: a “get” method for someValue +(_get_someValue()), and “get” and “set” methods for anotherValue +(_get_anotherValue() and _set_anotherValue()). The mapping, in +particular, does not require that the IDL attributes are accessible as normal +Python attributes: object.someValue is not required to work, and may +raise an AttributeError.

    +

    The Python DOM API, however, does require that normal attribute access work. +This means that the typical surrogates generated by Python IDL compilers are not +likely to work, and wrapper objects may be needed on the client if the DOM +objects are accessed via CORBA. While this does require some additional +consideration for CORBA DOM clients, the implementers with experience using DOM +over CORBA from Python do not consider this a problem. Attributes that are +declared readonly may not restrict write access in all DOM +implementations.

    +

    In the Python DOM API, accessor functions are not required. If provided, they +should take the form defined by the Python IDL mapping, but these methods are +considered unnecessary since the attributes are accessible directly from Python. +“Set” accessors should never be provided for readonly attributes.

    +

    The IDL definitions do not fully embody the requirements of the W3C DOM API, +such as the notion of certain objects, such as the return value of +getElementsByTagName(), being “live”. The Python DOM API does not require +implementations to enforce such requirements.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/xml.dom.minidom.html b/python-3.7.4-docs-html/library/xml.dom.minidom.html new file mode 100644 index 0000000..87aa6cd --- /dev/null +++ b/python-3.7.4-docs-html/library/xml.dom.minidom.html @@ -0,0 +1,468 @@ + + + + + + + xml.dom.minidom — Minimal DOM implementation — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    xml.dom.minidom — Minimal DOM implementation

    +

    Source code: Lib/xml/dom/minidom.py

    +
    +

    xml.dom.minidom is a minimal implementation of the Document Object +Model interface, with an API similar to that in other languages. It is intended +to be simpler than the full DOM and also significantly smaller. Users who are +not already proficient with the DOM should consider using the +xml.etree.ElementTree module for their XML processing instead.

    +
    +

    Warning

    +

    The xml.dom.minidom module is not secure against +maliciously constructed data. If you need to parse untrusted or +unauthenticated data see XML vulnerabilities.

    +
    +

    DOM applications typically start by parsing some XML into a DOM. With +xml.dom.minidom, this is done through the parse functions:

    +
    from xml.dom.minidom import parse, parseString
    +
    +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
    +
    +dom3 = parseString('<myxml>Some data<empty/> some more data</myxml>')
    +
    +
    +

    The parse() function can take either a filename or an open file object.

    +
    +
    +xml.dom.minidom.parse(filename_or_file, parser=None, bufsize=None)
    +

    Return a Document from the given input. filename_or_file may be +either a file name, or a file-like object. parser, if given, must be a SAX2 +parser object. This function will change the document handler of the parser and +activate namespace support; other parser configuration (like setting an entity +resolver) must have been done in advance.

    +
    + +

    If you have XML in a string, you can use the parseString() function +instead:

    +
    +
    +xml.dom.minidom.parseString(string, parser=None)
    +

    Return a Document that represents the string. This method creates an +io.StringIO object for the string and passes that on to parse().

    +
    + +

    Both functions return a Document object representing the content of the +document.

    +

    What the parse() and parseString() functions do is connect an XML +parser with a “DOM builder” that can accept parse events from any SAX parser and +convert them into a DOM tree. The name of the functions are perhaps misleading, +but are easy to grasp when learning the interfaces. The parsing of the document +will be completed before these functions return; it’s simply that these +functions do not provide a parser implementation themselves.

    +

    You can also create a Document by calling a method on a “DOM +Implementation” object. You can get this object either by calling the +getDOMImplementation() function in the xml.dom package or the +xml.dom.minidom module. Once you have a Document, you +can add child nodes to it to populate the DOM:

    +
    from xml.dom.minidom import getDOMImplementation
    +
    +impl = getDOMImplementation()
    +
    +newdoc = impl.createDocument(None, "some_tag", None)
    +top_element = newdoc.documentElement
    +text = newdoc.createTextNode('Some textual content.')
    +top_element.appendChild(text)
    +
    +
    +

    Once you have a DOM document object, you can access the parts of your XML +document through its properties and methods. These properties are defined in +the DOM specification. The main property of the document object is the +documentElement property. It gives you the main element in the XML +document: the one that holds all others. Here is an example program:

    +
    dom3 = parseString("<myxml>Some data</myxml>")
    +assert dom3.documentElement.tagName == "myxml"
    +
    +
    +

    When you are finished with a DOM tree, you may optionally call the +unlink() method to encourage early cleanup of the now-unneeded +objects. unlink() is an xml.dom.minidom-specific +extension to the DOM API that renders the node and its descendants are +essentially useless. Otherwise, Python’s garbage collector will +eventually take care of the objects in the tree.

    +
    +

    See also

    +
    +
    Document Object Model (DOM) Level 1 Specification

    The W3C recommendation for the DOM supported by xml.dom.minidom.

    +
    +
    +
    +
    +

    DOM Objects

    +

    The definition of the DOM API for Python is given as part of the xml.dom +module documentation. This section lists the differences between the API and +xml.dom.minidom.

    +
    + +

    Break internal references within the DOM so that it will be garbage collected on +versions of Python without cyclic GC. Even when cyclic GC is available, using +this can make large amounts of memory available sooner, so calling this on DOM +objects as soon as they are no longer needed is good practice. This only needs +to be called on the Document object, but may be called on child nodes +to discard children of that node.

    +

    You can avoid calling this method explicitly by using the with +statement. The following code will automatically unlink dom when the +with block is exited:

    +
    with xml.dom.minidom.parse(datasource) as dom:
    +    ... # Work with dom.
    +
    +
    +
    + +
    +
    +Node.writexml(writer, indent="", addindent="", newl="")
    +

    Write XML to the writer object. The writer receives texts but not bytes as input, +it should have a write() method which matches that of the file object +interface. The indent parameter is the indentation of the current node. +The addindent parameter is the incremental indentation to use for subnodes +of the current one. The newl parameter specifies the string to use to +terminate newlines.

    +

    For the Document node, an additional keyword argument encoding can +be used to specify the encoding field of the XML header.

    +
    + +
    +
    +Node.toxml(encoding=None)
    +

    Return a string or byte string containing the XML represented by +the DOM node.

    +

    With an explicit encoding 1 argument, the result is a byte +string in the specified encoding. +With no encoding argument, the result is a Unicode string, and the +XML declaration in the resulting string does not specify an +encoding. Encoding this string in an encoding other than UTF-8 is +likely incorrect, since UTF-8 is the default encoding of XML.

    +
    + +
    +
    +Node.toprettyxml(indent="\t", newl="\n", encoding=None)
    +

    Return a pretty-printed version of the document. indent specifies the +indentation string and defaults to a tabulator; newl specifies the string +emitted at the end of each line and defaults to \n.

    +

    The encoding argument behaves like the corresponding argument of +toxml().

    +
    + +
    +
    +

    DOM Example

    +

    This example program is a fairly realistic example of a simple program. In this +particular case, we do not take much advantage of the flexibility of the DOM.

    +
    import xml.dom.minidom
    +
    +document = """\
    +<slideshow>
    +<title>Demo slideshow</title>
    +<slide><title>Slide title</title>
    +<point>This is a demo</point>
    +<point>Of a program for processing slides</point>
    +</slide>
    +
    +<slide><title>Another demo slide</title>
    +<point>It is important</point>
    +<point>To have more than</point>
    +<point>one slide</point>
    +</slide>
    +</slideshow>
    +"""
    +
    +dom = xml.dom.minidom.parseString(document)
    +
    +def getText(nodelist):
    +    rc = []
    +    for node in nodelist:
    +        if node.nodeType == node.TEXT_NODE:
    +            rc.append(node.data)
    +    return ''.join(rc)
    +
    +def handleSlideshow(slideshow):
    +    print("<html>")
    +    handleSlideshowTitle(slideshow.getElementsByTagName("title")[0])
    +    slides = slideshow.getElementsByTagName("slide")
    +    handleToc(slides)
    +    handleSlides(slides)
    +    print("</html>")
    +
    +def handleSlides(slides):
    +    for slide in slides:
    +        handleSlide(slide)
    +
    +def handleSlide(slide):
    +    handleSlideTitle(slide.getElementsByTagName("title")[0])
    +    handlePoints(slide.getElementsByTagName("point"))
    +
    +def handleSlideshowTitle(title):
    +    print("<title>%s</title>" % getText(title.childNodes))
    +
    +def handleSlideTitle(title):
    +    print("<h2>%s</h2>" % getText(title.childNodes))
    +
    +def handlePoints(points):
    +    print("<ul>")
    +    for point in points:
    +        handlePoint(point)
    +    print("</ul>")
    +
    +def handlePoint(point):
    +    print("<li>%s</li>" % getText(point.childNodes))
    +
    +def handleToc(slides):
    +    for slide in slides:
    +        title = slide.getElementsByTagName("title")[0]
    +        print("<p>%s</p>" % getText(title.childNodes))
    +
    +handleSlideshow(dom)
    +
    +
    +
    +
    +

    minidom and the DOM standard

    +

    The xml.dom.minidom module is essentially a DOM 1.0-compatible DOM with +some DOM 2 features (primarily namespace features).

    +

    Usage of the DOM interface in Python is straight-forward. The following mapping +rules apply:

    +
      +
    • Interfaces are accessed through instance objects. Applications should not +instantiate the classes themselves; they should use the creator functions +available on the Document object. Derived interfaces support all +operations (and attributes) from the base interfaces, plus any new operations.

    • +
    • Operations are used as methods. Since the DOM uses only in +parameters, the arguments are passed in normal order (from left to right). +There are no optional arguments. void operations return None.

    • +
    • IDL attributes map to instance attributes. For compatibility with the OMG IDL +language mapping for Python, an attribute foo can also be accessed through +accessor methods _get_foo() and _set_foo(). readonly +attributes must not be changed; this is not enforced at runtime.

    • +
    • The types short int, unsigned int, unsigned long long, and +boolean all map to Python integer objects.

    • +
    • The type DOMString maps to Python strings. xml.dom.minidom supports +either bytes or strings, but will normally produce strings. +Values of type DOMString may also be None where allowed to have the IDL +null value by the DOM specification from the W3C.

    • +
    • const declarations map to variables in their respective scope (e.g. +xml.dom.minidom.Node.PROCESSING_INSTRUCTION_NODE); they must not be changed.

    • +
    • DOMException is currently not supported in xml.dom.minidom. +Instead, xml.dom.minidom uses standard Python exceptions such as +TypeError and AttributeError.

    • +
    • NodeList objects are implemented using Python’s built-in list type. +These objects provide the interface defined in the DOM specification, but with +earlier versions of Python they do not support the official API. They are, +however, much more “Pythonic” than the interface defined in the W3C +recommendations.

    • +
    +

    The following interfaces have no implementation in xml.dom.minidom:

    +
      +
    • DOMTimeStamp

    • +
    • EntityReference

    • +
    +

    Most of these reflect information in the XML document that is not of general +utility to most DOM users.

    +

    Footnotes

    +
    +
    1
    +

    The encoding name included in the XML output should conform to +the appropriate standards. For example, “UTF-8” is valid, but +“UTF8” is not valid in an XML document’s declaration, even though +Python accepts it as an encoding name. +See https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl +and https://www.iana.org/assignments/character-sets/character-sets.xhtml.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/xml.dom.pulldom.html b/python-3.7.4-docs-html/library/xml.dom.pulldom.html new file mode 100644 index 0000000..093c07d --- /dev/null +++ b/python-3.7.4-docs-html/library/xml.dom.pulldom.html @@ -0,0 +1,334 @@ + + + + + + + xml.dom.pulldom — Support for building partial DOM trees — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    xml.dom.pulldom — Support for building partial DOM trees

    +

    Source code: Lib/xml/dom/pulldom.py

    +
    +

    The xml.dom.pulldom module provides a “pull parser” which can also be +asked to produce DOM-accessible fragments of the document where necessary. The +basic concept involves pulling “events” from a stream of incoming XML and +processing them. In contrast to SAX which also employs an event-driven +processing model together with callbacks, the user of a pull parser is +responsible for explicitly pulling events from the stream, looping over those +events until either processing is finished or an error condition occurs.

    +
    +

    Warning

    +

    The xml.dom.pulldom module is not secure against +maliciously constructed data. If you need to parse untrusted or +unauthenticated data see XML vulnerabilities.

    +
    +
    +

    Changed in version 3.7.1: The SAX parser no longer processes general external entities by default to +increase security by default. To enable processing of external entities, +pass a custom parser instance in:

    +
    from xml.dom.pulldom import parse
    +from xml.sax import make_parser
    +from xml.sax.handler import feature_external_ges
    +
    +parser = make_parser()
    +parser.setFeature(feature_external_ges, True)
    +parse(filename, parser=parser)
    +
    +
    +
    +

    Example:

    +
    from xml.dom import pulldom
    +
    +doc = pulldom.parse('sales_items.xml')
    +for event, node in doc:
    +    if event == pulldom.START_ELEMENT and node.tagName == 'item':
    +        if int(node.getAttribute('price')) > 50:
    +            doc.expandNode(node)
    +            print(node.toxml())
    +
    +
    +

    event is a constant and can be one of:

    +
      +
    • START_ELEMENT

    • +
    • END_ELEMENT

    • +
    • COMMENT

    • +
    • START_DOCUMENT

    • +
    • END_DOCUMENT

    • +
    • CHARACTERS

    • +
    • PROCESSING_INSTRUCTION

    • +
    • IGNORABLE_WHITESPACE

    • +
    +

    node is an object of type xml.dom.minidom.Document, +xml.dom.minidom.Element or xml.dom.minidom.Text.

    +

    Since the document is treated as a “flat” stream of events, the document “tree” +is implicitly traversed and the desired elements are found regardless of their +depth in the tree. In other words, one does not need to consider hierarchical +issues such as recursive searching of the document nodes, although if the +context of elements were important, one would either need to maintain some +context-related state (i.e. remembering where one is in the document at any +given point) or to make use of the DOMEventStream.expandNode() method +and switch to DOM-related processing.

    +
    +
    +class xml.dom.pulldom.PullDom(documentFactory=None)
    +

    Subclass of xml.sax.handler.ContentHandler.

    +
    + +
    +
    +class xml.dom.pulldom.SAX2DOM(documentFactory=None)
    +

    Subclass of xml.sax.handler.ContentHandler.

    +
    + +
    +
    +xml.dom.pulldom.parse(stream_or_string, parser=None, bufsize=None)
    +

    Return a DOMEventStream from the given input. stream_or_string may be +either a file name, or a file-like object. parser, if given, must be an +XMLReader object. This function will change the +document handler of the +parser and activate namespace support; other parser configuration (like +setting an entity resolver) must have been done in advance.

    +
    + +

    If you have XML in a string, you can use the parseString() function instead:

    +
    +
    +xml.dom.pulldom.parseString(string, parser=None)
    +

    Return a DOMEventStream that represents the (Unicode) string.

    +
    + +
    +
    +xml.dom.pulldom.default_bufsize
    +

    Default value for the bufsize parameter to parse().

    +

    The value of this variable can be changed before calling parse() and +the new value will take effect.

    +
    + +
    +

    DOMEventStream Objects

    +
    +
    +class xml.dom.pulldom.DOMEventStream(stream, parser, bufsize)
    +
    +
    +getEvent()
    +

    Return a tuple containing event and the current node as +xml.dom.minidom.Document if event equals START_DOCUMENT, +xml.dom.minidom.Element if event equals START_ELEMENT or +END_ELEMENT or xml.dom.minidom.Text if event equals +CHARACTERS. +The current node does not contain information about its children, unless +expandNode() is called.

    +
    + +
    +
    +expandNode(node)
    +

    Expands all children of node into node. Example:

    +
    from xml.dom import pulldom
    +
    +xml = '<html><title>Foo</title> <p>Some text <div>and more</div></p> </html>'
    +doc = pulldom.parseString(xml)
    +for event, node in doc:
    +    if event == pulldom.START_ELEMENT and node.tagName == 'p':
    +        # Following statement only prints '<p/>'
    +        print(node.toxml())
    +        doc.expandNode(node)
    +        # Following statement prints node with all its children '<p>Some text <div>and more</div></p>'
    +        print(node.toxml())
    +
    +
    +
    + +
    +
    +reset()
    +
    + +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/xml.etree.elementtree.html b/python-3.7.4-docs-html/library/xml.etree.elementtree.html new file mode 100644 index 0000000..9178ece --- /dev/null +++ b/python-3.7.4-docs-html/library/xml.etree.elementtree.html @@ -0,0 +1,1446 @@ + + + + + + + xml.etree.ElementTree — The ElementTree XML API — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    xml.etree.ElementTree — The ElementTree XML API

    +

    Source code: Lib/xml/etree/ElementTree.py

    +
    +

    The xml.etree.ElementTree module implements a simple and efficient API +for parsing and creating XML data.

    +
    +

    Changed in version 3.3: This module will use a fast implementation whenever available. +The xml.etree.cElementTree module is deprecated.

    +
    +
    +

    Warning

    +

    The xml.etree.ElementTree module is not secure against +maliciously constructed data. If you need to parse untrusted or +unauthenticated data see XML vulnerabilities.

    +
    +
    +

    Tutorial

    +

    This is a short tutorial for using xml.etree.ElementTree (ET in +short). The goal is to demonstrate some of the building blocks and basic +concepts of the module.

    +
    +

    XML tree and elements

    +

    XML is an inherently hierarchical data format, and the most natural way to +represent it is with a tree. ET has two classes for this purpose - +ElementTree represents the whole XML document as a tree, and +Element represents a single node in this tree. Interactions with +the whole document (reading and writing to/from files) are usually done +on the ElementTree level. Interactions with a single XML element +and its sub-elements are done on the Element level.

    +
    +
    +

    Parsing XML

    +

    We’ll be using the following XML document as the sample data for this section:

    +
    <?xml version="1.0"?>
    +<data>
    +    <country name="Liechtenstein">
    +        <rank>1</rank>
    +        <year>2008</year>
    +        <gdppc>141100</gdppc>
    +        <neighbor name="Austria" direction="E"/>
    +        <neighbor name="Switzerland" direction="W"/>
    +    </country>
    +    <country name="Singapore">
    +        <rank>4</rank>
    +        <year>2011</year>
    +        <gdppc>59900</gdppc>
    +        <neighbor name="Malaysia" direction="N"/>
    +    </country>
    +    <country name="Panama">
    +        <rank>68</rank>
    +        <year>2011</year>
    +        <gdppc>13600</gdppc>
    +        <neighbor name="Costa Rica" direction="W"/>
    +        <neighbor name="Colombia" direction="E"/>
    +    </country>
    +</data>
    +
    +
    +

    We can import this data by reading from a file:

    +
    import xml.etree.ElementTree as ET
    +tree = ET.parse('country_data.xml')
    +root = tree.getroot()
    +
    +
    +

    Or directly from a string:

    +
    root = ET.fromstring(country_data_as_string)
    +
    +
    +

    fromstring() parses XML from a string directly into an Element, +which is the root element of the parsed tree. Other parsing functions may +create an ElementTree. Check the documentation to be sure.

    +

    As an Element, root has a tag and a dictionary of attributes:

    +
    >>> root.tag
    +'data'
    +>>> root.attrib
    +{}
    +
    +
    +

    It also has children nodes over which we can iterate:

    +
    >>> for child in root:
    +...     print(child.tag, child.attrib)
    +...
    +country {'name': 'Liechtenstein'}
    +country {'name': 'Singapore'}
    +country {'name': 'Panama'}
    +
    +
    +

    Children are nested, and we can access specific child nodes by index:

    +
    >>> root[0][1].text
    +'2008'
    +
    +
    +
    +

    Note

    +

    Not all elements of the XML input will end up as elements of the +parsed tree. Currently, this module skips over any XML comments, +processing instructions, and document type declarations in the +input. Nevertheless, trees built using this module’s API rather +than parsing from XML text can have comments and processing +instructions in them; they will be included when generating XML +output. A document type declaration may be accessed by passing a +custom TreeBuilder instance to the XMLParser +constructor.

    +
    +
    +
    +

    Pull API for non-blocking parsing

    +

    Most parsing functions provided by this module require the whole document +to be read at once before returning any result. It is possible to use an +XMLParser and feed data into it incrementally, but it is a push API that +calls methods on a callback target, which is too low-level and inconvenient for +most needs. Sometimes what the user really wants is to be able to parse XML +incrementally, without blocking operations, while enjoying the convenience of +fully constructed Element objects.

    +

    The most powerful tool for doing this is XMLPullParser. It does not +require a blocking read to obtain the XML data, and is instead fed with data +incrementally with XMLPullParser.feed() calls. To get the parsed XML +elements, call XMLPullParser.read_events(). Here is an example:

    +
    >>> parser = ET.XMLPullParser(['start', 'end'])
    +>>> parser.feed('<mytag>sometext')
    +>>> list(parser.read_events())
    +[('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)
    +...
    +end
    +
    +
    +

    The obvious use case is applications that operate in a non-blocking fashion +where the XML data is being received from a socket or read incrementally from +some storage device. In such cases, blocking reads are unacceptable.

    +

    Because it’s so flexible, XMLPullParser can be inconvenient to use for +simpler use-cases. If you don’t mind your application blocking on reading XML +data but would still like to have incremental parsing capabilities, take a look +at iterparse(). It can be useful when you’re reading a large XML document +and don’t want to hold it wholly in memory.

    +
    +
    +

    Finding interesting elements

    +

    Element has some useful methods that help iterate recursively over all +the sub-tree below it (its children, their children, and so on). For example, +Element.iter():

    +
    >>> for neighbor in root.iter('neighbor'):
    +...     print(neighbor.attrib)
    +...
    +{'name': 'Austria', 'direction': 'E'}
    +{'name': 'Switzerland', 'direction': 'W'}
    +{'name': 'Malaysia', 'direction': 'N'}
    +{'name': 'Costa Rica', 'direction': 'W'}
    +{'name': 'Colombia', 'direction': 'E'}
    +
    +
    +

    Element.findall() finds only elements with a tag which are direct +children of the current element. Element.find() finds the first child +with a particular tag, and Element.text accesses the element’s text +content. 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)
    +...
    +Liechtenstein 1
    +Singapore 4
    +Panama 68
    +
    +
    +

    More sophisticated specification of which elements to look for is possible by +using XPath.

    +
    +
    +

    Modifying an XML File

    +

    ElementTree provides a simple way to build XML documents and write them to files. +The ElementTree.write() method serves this purpose.

    +

    Once created, an Element object may be manipulated by directly changing +its fields (such as Element.text), adding and modifying attributes +(Element.set() method), as well as adding new children (for example +with Element.append()).

    +

    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')
    +...
    +>>> tree.write('output.xml')
    +
    +
    +

    Our XML now looks like this:

    +
    <?xml version="1.0"?>
    +<data>
    +    <country name="Liechtenstein">
    +        <rank updated="yes">2</rank>
    +        <year>2008</year>
    +        <gdppc>141100</gdppc>
    +        <neighbor name="Austria" direction="E"/>
    +        <neighbor name="Switzerland" direction="W"/>
    +    </country>
    +    <country name="Singapore">
    +        <rank updated="yes">5</rank>
    +        <year>2011</year>
    +        <gdppc>59900</gdppc>
    +        <neighbor name="Malaysia" direction="N"/>
    +    </country>
    +    <country name="Panama">
    +        <rank updated="yes">69</rank>
    +        <year>2011</year>
    +        <gdppc>13600</gdppc>
    +        <neighbor name="Costa Rica" direction="W"/>
    +        <neighbor name="Colombia" direction="E"/>
    +    </country>
    +</data>
    +
    +
    +

    We can remove elements using 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)
    +...
    +>>> tree.write('output.xml')
    +
    +
    +

    Our XML now looks like this:

    +
    <?xml version="1.0"?>
    +<data>
    +    <country name="Liechtenstein">
    +        <rank updated="yes">2</rank>
    +        <year>2008</year>
    +        <gdppc>141100</gdppc>
    +        <neighbor name="Austria" direction="E"/>
    +        <neighbor name="Switzerland" direction="W"/>
    +    </country>
    +    <country name="Singapore">
    +        <rank updated="yes">5</rank>
    +        <year>2011</year>
    +        <gdppc>59900</gdppc>
    +        <neighbor name="Malaysia" direction="N"/>
    +    </country>
    +</data>
    +
    +
    +
    +
    +

    Building XML documents

    +

    The SubElement() function also provides a convenient way to create new +sub-elements for a given element:

    +
    >>> a = ET.Element('a')
    +>>> b = ET.SubElement(a, 'b')
    +>>> c = ET.SubElement(a, 'c')
    +>>> d = ET.SubElement(c, 'd')
    +>>> ET.dump(a)
    +<a><b /><c><d /></c></a>
    +
    +
    +
    +
    +

    Parsing XML with Namespaces

    +

    If the XML input has namespaces, tags and attributes +with prefixes in the form prefix:sometag get expanded to +{uri}sometag where the prefix is replaced by the full URI. +Also, if there is a default namespace, +that full URI gets prepended to all of the non-prefixed tags.

    +

    Here is an XML example that incorporates two namespaces, one with the +prefix “fictional” and the other serving as the default namespace:

    +
    <?xml version="1.0"?>
    +<actors xmlns:fictional="http://characters.example.com"
    +        xmlns="http://people.example.com">
    +    <actor>
    +        <name>John Cleese</name>
    +        <fictional:character>Lancelot</fictional:character>
    +        <fictional:character>Archie Leach</fictional:character>
    +    </actor>
    +    <actor>
    +        <name>Eric Idle</name>
    +        <fictional:character>Sir Robin</fictional:character>
    +        <fictional:character>Gunther</fictional:character>
    +        <fictional:character>Commander Clement</fictional:character>
    +    </actor>
    +</actors>
    +
    +
    +

    One way to search and explore this XML example is to manually add the +URI to every tag or attribute in the xpath of a +find() or findall():

    +
    root = fromstring(xml_text)
    +for actor in root.findall('{http://people.example.com}actor'):
    +    name = actor.find('{http://people.example.com}name')
    +    print(name.text)
    +    for char in actor.findall('{http://characters.example.com}character'):
    +        print(' |-->', char.text)
    +
    +
    +

    A better way to search the namespaced XML example is to create a +dictionary with your own prefixes and use those in the search functions:

    +
    ns = {'real_person': 'http://people.example.com',
    +      'role': 'http://characters.example.com'}
    +
    +for actor in root.findall('real_person:actor', ns):
    +    name = actor.find('real_person:name', ns)
    +    print(name.text)
    +    for char in actor.findall('role:character', ns):
    +        print(' |-->', char.text)
    +
    +
    +

    These two approaches both output:

    +
    John Cleese
    + |--> Lancelot
    + |--> Archie Leach
    +Eric Idle
    + |--> Sir Robin
    + |--> Gunther
    + |--> Commander Clement
    +
    +
    +
    +
    +

    Additional resources

    +

    See http://effbot.org/zone/element-index.htm for tutorials and links to other +docs.

    +
    +
    +
    +

    XPath support

    +

    This module provides limited support for +XPath expressions for locating elements in a +tree. The goal is to support a small subset of the abbreviated syntax; a full +XPath engine is outside the scope of the module.

    +
    +

    Example

    +

    Here’s an example that demonstrates some of the XPath capabilities of the +module. We’ll be using the countrydata XML document from the +Parsing XML section:

    +
    import xml.etree.ElementTree as ET
    +
    +root = ET.fromstring(countrydata)
    +
    +# Top-level elements
    +root.findall(".")
    +
    +# All 'neighbor' grand-children of 'country' children of the top-level
    +# elements
    +root.findall("./country/neighbor")
    +
    +# Nodes with name='Singapore' that have a 'year' child
    +root.findall(".//year/..[@name='Singapore']")
    +
    +# 'year' nodes that are children of nodes with name='Singapore'
    +root.findall(".//*[@name='Singapore']/year")
    +
    +# All 'neighbor' nodes that are the second child of their parent
    +root.findall(".//neighbor[2]")
    +
    +
    +
    +
    +

    Supported XPath syntax

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Syntax

    Meaning

    tag

    Selects all child elements with the given tag. +For example, spam selects all child elements +named spam, and spam/egg selects all +grandchildren named egg in all children named +spam.

    *

    Selects all child elements. For example, */egg +selects all grandchildren named egg.

    .

    Selects the current node. This is mostly useful +at the beginning of the path, to indicate that it’s +a relative path.

    //

    Selects all subelements, on all levels beneath the +current element. For example, .//egg selects +all egg elements in the entire tree.

    ..

    Selects the parent element. Returns None if the +path attempts to reach the ancestors of the start +element (the element find was called on).

    [@attrib]

    Selects all elements that have the given attribute.

    [@attrib='value']

    Selects all elements for which the given attribute +has the given value. The value cannot contain +quotes.

    [tag]

    Selects all elements that have a child named +tag. Only immediate children are supported.

    [.='text']

    Selects all elements whose complete text content, +including descendants, equals the given text.

    +
    +

    New in version 3.7.

    +
    +

    [tag='text']

    Selects all elements that have a child named +tag whose complete text content, including +descendants, equals the given text.

    [position]

    Selects all elements that are located at the given +position. The position can be either an integer +(1 is the first position), the expression last() +(for the last position), or a position relative to +the last position (e.g. last()-1).

    +

    Predicates (expressions within square brackets) must be preceded by a tag +name, an asterisk, or another predicate. position predicates must be +preceded by a tag name.

    +
    +
    +
    +

    Reference

    +
    +

    Functions

    +
    +
    +xml.etree.ElementTree.Comment(text=None)
    +

    Comment element factory. This factory function creates a special element +that will be serialized as an XML comment by the standard serializer. The +comment string can be either a bytestring or a Unicode string. text is a +string containing the comment string. Returns an element instance +representing a comment.

    +

    Note that XMLParser skips over comments in the input +instead of creating comment objects for them. An ElementTree will +only contain comment nodes if they have been inserted into to +the tree using one of the Element methods.

    +
    + +
    +
    +xml.etree.ElementTree.dump(elem)
    +

    Writes an element tree or element structure to sys.stdout. This function +should be used for debugging only.

    +

    The exact output format is implementation dependent. In this version, it’s +written as an ordinary XML file.

    +

    elem is an element tree or an individual element.

    +
    + +
    +
    +xml.etree.ElementTree.fromstring(text, parser=None)
    +

    Parses an XML section from a string constant. Same as XML(). text +is a string containing XML data. parser is an optional parser instance. +If not given, the standard XMLParser parser is used. +Returns an Element instance.

    +
    + +
    +
    +xml.etree.ElementTree.fromstringlist(sequence, parser=None)
    +

    Parses an XML document from a sequence of string fragments. sequence is a +list or other sequence containing XML data fragments. parser is an +optional parser instance. If not given, the standard XMLParser +parser is used. Returns an Element instance.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +xml.etree.ElementTree.iselement(element)
    +

    Checks if an object appears to be a valid element object. element is an +element instance. Returns a true value if this is an element object.

    +
    + +
    +
    +xml.etree.ElementTree.iterparse(source, events=None, parser=None)
    +

    Parses an XML section into an element tree incrementally, and reports what’s +going on to the user. source is a filename or file object +containing XML data. events is a sequence of events to report back. The +supported events are the strings "start", "end", "start-ns" and +"end-ns" (the “ns” events are used to get detailed namespace +information). If events is omitted, only "end" events are reported. +parser is an optional parser instance. If not given, the standard +XMLParser parser is used. parser must be a subclass of +XMLParser and can only use the default TreeBuilder as a +target. Returns an iterator providing (event, elem) pairs.

    +

    Note that while iterparse() builds the tree incrementally, it issues +blocking reads on source (or the file it names). As such, it’s unsuitable +for applications where blocking reads can’t be made. For fully non-blocking +parsing, see XMLPullParser.

    +
    +

    Note

    +

    iterparse() only guarantees that it has seen the “>” character of a +starting tag when it emits a “start” event, so the attributes are defined, +but the contents of the text and tail attributes are undefined at that +point. The same applies to the element children; they may or may not be +present.

    +

    If you need a fully populated element, look for “end” events instead.

    +
    +
    +

    Deprecated since version 3.4: The parser argument.

    +
    +
    + +
    +
    +xml.etree.ElementTree.parse(source, parser=None)
    +

    Parses an XML section into an element tree. source is a filename or file +object containing XML data. parser is an optional parser instance. If +not given, the standard XMLParser parser is used. Returns an +ElementTree instance.

    +
    + +
    +
    +xml.etree.ElementTree.ProcessingInstruction(target, text=None)
    +

    PI element factory. This factory function creates a special element that +will be serialized as an XML processing instruction. target is a string +containing the PI target. text is a string containing the PI contents, if +given. Returns an element instance, representing a processing instruction.

    +

    Note that XMLParser skips over processing instructions +in the input instead of creating comment objects for them. An +ElementTree will only contain processing instruction nodes if +they have been inserted into to the tree using one of the +Element methods.

    +
    + +
    +
    +xml.etree.ElementTree.register_namespace(prefix, uri)
    +

    Registers a namespace prefix. The registry is global, and any existing +mapping for either the given prefix or the namespace URI will be removed. +prefix is a namespace prefix. uri is a namespace uri. Tags and +attributes in this namespace will be serialized with the given prefix, if at +all possible.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +xml.etree.ElementTree.SubElement(parent, tag, attrib={}, **extra)
    +

    Subelement factory. This function creates an element instance, and appends +it to an existing element.

    +

    The element name, attribute names, and attribute values can be either +bytestrings or Unicode strings. parent is the parent element. tag is +the subelement name. attrib is an optional dictionary, containing element +attributes. extra contains additional attributes, given as keyword +arguments. Returns an element instance.

    +
    + +
    +
    +xml.etree.ElementTree.tostring(element, encoding="us-ascii", method="xml", *, short_empty_elements=True)
    +

    Generates a string representation of an XML element, including all +subelements. element is an Element instance. encoding 1 is +the output encoding (default is US-ASCII). Use encoding="unicode" to +generate a Unicode string (otherwise, a bytestring is generated). method +is either "xml", "html" or "text" (default is "xml"). +short_empty_elements has the same meaning as in ElementTree.write(). +Returns an (optionally) encoded string containing the XML data.

    +
    +

    New in version 3.4: The short_empty_elements parameter.

    +
    +
    + +
    +
    +xml.etree.ElementTree.tostringlist(element, encoding="us-ascii", method="xml", *, short_empty_elements=True)
    +

    Generates a string representation of an XML element, including all +subelements. element is an Element instance. encoding 1 is +the output encoding (default is US-ASCII). Use encoding="unicode" to +generate a Unicode string (otherwise, a bytestring is generated). method +is either "xml", "html" or "text" (default is "xml"). +short_empty_elements has the same meaning as in ElementTree.write(). +Returns a list of (optionally) encoded strings containing the XML data. +It does not guarantee any specific sequence, except that +b"".join(tostringlist(element)) == tostring(element).

    +
    +

    New in version 3.2.

    +
    +
    +

    New in version 3.4: The short_empty_elements parameter.

    +
    +
    + +
    +
    +xml.etree.ElementTree.XML(text, parser=None)
    +

    Parses an XML section from a string constant. This function can be used to +embed “XML literals” in Python code. text is a string containing XML +data. parser is an optional parser instance. If not given, the standard +XMLParser parser is used. Returns an Element instance.

    +
    + +
    +
    +xml.etree.ElementTree.XMLID(text, parser=None)
    +

    Parses an XML section from a string constant, and also returns a dictionary +which maps from element id:s to elements. text is a string containing XML +data. parser is an optional parser instance. If not given, the standard +XMLParser parser is used. Returns a tuple containing an +Element instance and a dictionary.

    +
    + +
    +
    +

    Element Objects

    +
    +
    +class xml.etree.ElementTree.Element(tag, attrib={}, **extra)
    +

    Element class. This class defines the Element interface, and provides a +reference implementation of this interface.

    +

    The element name, attribute names, and attribute values can be either +bytestrings or Unicode strings. tag is the element name. attrib is +an optional dictionary, containing element attributes. extra contains +additional attributes, given as keyword arguments.

    +
    +
    +tag
    +

    A string identifying what kind of data this element represents (the +element type, in other words).

    +
    + +
    +
    +text
    +
    +tail
    +

    These attributes can be used to hold additional data associated with +the element. Their values are usually strings but may be any +application-specific object. If the element is created from +an XML file, the text attribute holds either the text between +the element’s start tag and its first child or end tag, or None, and +the tail attribute holds either the text between the element’s +end tag and the next tag, or None. For the XML data

    +
    <a><b>1<c>2<d/>3</c></b>4</a>
    +
    +
    +

    the a element has None for both text and tail attributes, +the b element has text "1" and tail "4", +the c element has text "2" and tail None, +and the d element has text None and tail "3".

    +

    To collect the inner text of an element, see itertext(), for +example "".join(element.itertext()).

    +

    Applications may store arbitrary objects in these attributes.

    +
    + +
    +
    +attrib
    +

    A dictionary containing the element’s attributes. Note that while the +attrib value is always a real mutable Python dictionary, an ElementTree +implementation may choose to use another internal representation, and +create the dictionary only if someone asks for it. To take advantage of +such implementations, use the dictionary methods below whenever possible.

    +
    + +

    The following dictionary-like methods work on the element attributes.

    +
    +
    +clear()
    +

    Resets an element. This function removes all subelements, clears all +attributes, and sets the text and tail attributes to None.

    +
    + +
    +
    +get(key, default=None)
    +

    Gets the element attribute named key.

    +

    Returns the attribute value, or default if the attribute was not found.

    +
    + +
    +
    +items()
    +

    Returns the element attributes as a sequence of (name, value) pairs. The +attributes are returned in an arbitrary order.

    +
    + +
    +
    +keys()
    +

    Returns the elements attribute names as a list. The names are returned +in an arbitrary order.

    +
    + +
    +
    +set(key, value)
    +

    Set the attribute key on the element to value.

    +
    + +

    The following methods work on the element’s children (subelements).

    +
    +
    +append(subelement)
    +

    Adds the element subelement to the end of this element’s internal list +of subelements. Raises TypeError if subelement is not an +Element.

    +
    + +
    +
    +extend(subelements)
    +

    Appends subelements from a sequence object with zero or more elements. +Raises TypeError if a subelement is not an Element.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +find(match, namespaces=None)
    +

    Finds the first subelement matching match. match may be a tag name +or a path. Returns an element instance +or None. namespaces is an optional mapping from namespace prefix +to full name.

    +
    + +
    +
    +findall(match, namespaces=None)
    +

    Finds all matching subelements, by tag name or +path. Returns a list containing all matching +elements in document order. namespaces is an optional mapping from +namespace prefix to full name.

    +
    + +
    +
    +findtext(match, default=None, namespaces=None)
    +

    Finds text for the first subelement matching match. match may be +a tag name or a path. Returns the text content +of the first matching element, or default if no element was found. +Note that if the matching element has no text content an empty string +is returned. namespaces is an optional mapping from namespace prefix +to full name.

    +
    + +
    +
    +getchildren()
    +
    +

    Deprecated since version 3.2: Use list(elem) or iteration.

    +
    +
    + +
    +
    +getiterator(tag=None)
    +
    +

    Deprecated since version 3.2: Use method Element.iter() instead.

    +
    +
    + +
    +
    +insert(index, subelement)
    +

    Inserts subelement at the given position in this element. Raises +TypeError if subelement is not an Element.

    +
    + +
    +
    +iter(tag=None)
    +

    Creates a tree iterator with the current element as the root. +The iterator iterates over this element and all elements below it, in +document (depth first) order. If tag is not None or '*', only +elements whose tag equals tag are returned from the iterator. If the +tree structure is modified during iteration, the result is undefined.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +iterfind(match, namespaces=None)
    +

    Finds all matching subelements, by tag name or +path. Returns an iterable yielding all +matching elements in document order. namespaces is an optional mapping +from namespace prefix to full name.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +itertext()
    +

    Creates a text iterator. The iterator loops over this element and all +subelements, in document order, and returns all inner text.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +makeelement(tag, attrib)
    +

    Creates a new element object of the same type as this element. Do not +call this method, use the SubElement() factory function instead.

    +
    + +
    +
    +remove(subelement)
    +

    Removes subelement from the element. Unlike the find* methods this +method compares elements based on the instance identity, not on tag value +or contents.

    +
    + +

    Element objects also support the following sequence type methods +for working with subelements: __delitem__(), +__getitem__(), __setitem__(), +__len__().

    +

    Caution: Elements with no subelements will test as False. This behavior +will change in future versions. Use specific len(elem) or elem is +None test instead.

    +
    element = root.find('foo')
    +
    +if not element:  # careful!
    +    print("element not found, or element has no subelements")
    +
    +if element is None:
    +    print("element not found")
    +
    +
    +
    + +
    +
    +

    ElementTree Objects

    +
    +
    +class xml.etree.ElementTree.ElementTree(element=None, file=None)
    +

    ElementTree wrapper class. This class represents an entire element +hierarchy, and adds some extra support for serialization to and from +standard XML.

    +

    element is the root element. The tree is initialized with the contents +of the XML file if given.

    +
    +
    +_setroot(element)
    +

    Replaces the root element for this tree. This discards the current +contents of the tree, and replaces it with the given element. Use with +care. element is an element instance.

    +
    + +
    +
    +find(match, namespaces=None)
    +

    Same as Element.find(), starting at the root of the tree.

    +
    + +
    +
    +findall(match, namespaces=None)
    +

    Same as Element.findall(), starting at the root of the tree.

    +
    + +
    +
    +findtext(match, default=None, namespaces=None)
    +

    Same as Element.findtext(), starting at the root of the tree.

    +
    + +
    +
    +getiterator(tag=None)
    +
    +

    Deprecated since version 3.2: Use method ElementTree.iter() instead.

    +
    +
    + +
    +
    +getroot()
    +

    Returns the root element for this tree.

    +
    + +
    +
    +iter(tag=None)
    +

    Creates and returns a tree iterator for the root element. The iterator +loops over all elements in this tree, in section order. tag is the tag +to look for (default is to return all elements).

    +
    + +
    +
    +iterfind(match, namespaces=None)
    +

    Same as Element.iterfind(), starting at the root of the tree.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +parse(source, parser=None)
    +

    Loads an external XML section into this element tree. source is a file +name or file object. parser is an optional parser instance. +If not given, the standard XMLParser parser is used. Returns the +section root element.

    +
    + +
    +
    +write(file, encoding="us-ascii", xml_declaration=None, default_namespace=None, method="xml", *, short_empty_elements=True)
    +

    Writes the element tree to a file, as XML. file is a file name, or a +file object opened for writing. encoding 1 is the output +encoding (default is US-ASCII). +xml_declaration controls if an XML declaration should be added to the +file. Use False for never, True for always, None +for only if not US-ASCII or UTF-8 or Unicode (default is None). +default_namespace sets the default XML namespace (for “xmlns”). +method is either "xml", "html" or "text" (default is +"xml"). +The keyword-only short_empty_elements parameter controls the formatting +of elements that contain no content. If True (the default), they are +emitted as a single self-closed tag, otherwise they are emitted as a pair +of start/end tags.

    +

    The output is either a string (str) or binary (bytes). +This is controlled by the encoding argument. If encoding is +"unicode", the output is a string; otherwise, it’s binary. Note that +this may conflict with the type of file if it’s an open +file object; make sure you do not try to write a string to a +binary stream and vice versa.

    +
    +

    New in version 3.4: The short_empty_elements parameter.

    +
    +
    + +
    + +

    This is the XML file that is going to be manipulated:

    +
    <html>
    +    <head>
    +        <title>Example page</title>
    +    </head>
    +    <body>
    +        <p>Moved to <a href="http://example.org/">example.org</a>
    +        or <a href="http://example.com/">example.com</a>.</p>
    +    </body>
    +</html>
    +
    +
    +

    Example of changing the attribute “target” of every link in first paragraph:

    +
    >>> from xml.etree.ElementTree import ElementTree
    +>>> tree = ElementTree()
    +>>> tree.parse("index.xhtml")
    +<Element 'html' at 0xb77e6fac>
    +>>> p = tree.find("body/p")     # Finds first occurrence of tag p in body
    +>>> p
    +<Element 'p' at 0xb77ec26c>
    +>>> links = list(p.iter("a"))   # Returns list of all links
    +>>> links
    +[<Element 'a' at 0xb77ec2ac>, <Element 'a' at 0xb77ec1cc>]
    +>>> for i in links:             # Iterates through all found links
    +...     i.attrib["target"] = "blank"
    +>>> tree.write("output.xhtml")
    +
    +
    +
    +
    +

    QName Objects

    +
    +
    +class xml.etree.ElementTree.QName(text_or_uri, tag=None)
    +

    QName wrapper. This can be used to wrap a QName attribute value, in order +to get proper namespace handling on output. text_or_uri is a string +containing the QName value, in the form {uri}local, or, if the tag argument +is given, the URI part of a QName. If tag is given, the first argument is +interpreted as a URI, and this argument is interpreted as a local name. +QName instances are opaque.

    +
    + +
    +
    +

    TreeBuilder Objects

    +
    +
    +class xml.etree.ElementTree.TreeBuilder(element_factory=None)
    +

    Generic element structure builder. This builder converts a sequence of +start, data, and end method calls to a well-formed element structure. You +can use this class to build an element structure using a custom XML parser, +or a parser for some other XML-like format. element_factory, when given, +must be a callable accepting two positional arguments: a tag and +a dict of attributes. It is expected to return a new element instance.

    +
    +
    +close()
    +

    Flushes the builder buffers, and returns the toplevel document +element. Returns an Element instance.

    +
    + +
    +
    +data(data)
    +

    Adds text to the current element. data is a string. This should be +either a bytestring, or a Unicode string.

    +
    + +
    +
    +end(tag)
    +

    Closes the current element. tag is the element name. Returns the +closed element.

    +
    + +
    +
    +start(tag, attrs)
    +

    Opens a new element. tag is the element name. attrs is a dictionary +containing element attributes. Returns the opened element.

    +
    + +

    In addition, a custom TreeBuilder object can provide the +following method:

    +
    +
    +doctype(name, pubid, system)
    +

    Handles a doctype declaration. name is the doctype name. pubid is +the public identifier. system is the system identifier. This method +does not exist on the default TreeBuilder class.

    +
    +

    New in version 3.2.

    +
    +
    + +
    + +
    +
    +

    XMLParser Objects

    +
    +
    +class xml.etree.ElementTree.XMLParser(html=0, target=None, encoding=None)
    +

    This class is the low-level building block of the module. It uses +xml.parsers.expat for efficient, event-based parsing of XML. It can +be fed XML data incrementally with the feed() method, and parsing +events are translated to a push API - by invoking callbacks on the target +object. If target is omitted, the standard TreeBuilder is used. +The html argument was historically used for backwards compatibility and is +now deprecated. If encoding 1 is given, the value overrides the +encoding specified in the XML file.

    +
    +

    Deprecated since version 3.4: The html argument. The remaining arguments should be passed via +keyword to prepare for the removal of the html argument.

    +
    +
    +
    +close()
    +

    Finishes feeding data to the parser. Returns the result of calling the +close() method of the target passed during construction; by default, +this is the toplevel document element.

    +
    + +
    +
    +doctype(name, pubid, system)
    +
    +

    Deprecated since version 3.2: Define the TreeBuilder.doctype() method on a custom TreeBuilder +target.

    +
    +
    + +
    +
    +feed(data)
    +

    Feeds data to the parser. data is encoded data.

    +
    + +

    XMLParser.feed() calls target’s start(tag, attrs_dict) method +for each opening tag, its end(tag) method for each closing tag, and data +is processed by method data(data). XMLParser.close() calls +target’s method close(). XMLParser can be used not only for +building a tree structure. This is an example of counting the maximum depth +of an XML file:

    +
    >>> from xml.etree.ElementTree import XMLParser
    +>>> class MaxDepth:                     # The target object of the parser
    +...     maxDepth = 0
    +...     depth = 0
    +...     def start(self, tag, attrib):   # Called for each opening tag.
    +...         self.depth += 1
    +...         if self.depth > self.maxDepth:
    +...             self.maxDepth = self.depth
    +...     def end(self, tag):             # Called for each closing tag.
    +...         self.depth -= 1
    +...     def data(self, data):
    +...         pass            # We do not need to do anything with data.
    +...     def close(self):    # Called when all data has been parsed.
    +...         return self.maxDepth
    +...
    +>>> target = MaxDepth()
    +>>> parser = XMLParser(target=target)
    +>>> exampleXml = """
    +... <a>
    +...   <b>
    +...   </b>
    +...   <b>
    +...     <c>
    +...       <d>
    +...       </d>
    +...     </c>
    +...   </b>
    +... </a>"""
    +>>> parser.feed(exampleXml)
    +>>> parser.close()
    +4
    +
    +
    +
    + +
    +
    +

    XMLPullParser Objects

    +
    +
    +class xml.etree.ElementTree.XMLPullParser(events=None)
    +

    A pull parser suitable for non-blocking applications. Its input-side API is +similar to that of XMLParser, but instead of pushing calls to a +callback target, XMLPullParser collects an internal list of parsing +events and lets the user read from it. events is a sequence of events to +report back. The supported events are the strings "start", "end", +"start-ns" and "end-ns" (the “ns” events are used to get detailed +namespace information). If events is omitted, only "end" events are +reported.

    +
    +
    +feed(data)
    +

    Feed the given bytes data to the parser.

    +
    + +
    +
    +close()
    +

    Signal the parser that the data stream is terminated. Unlike +XMLParser.close(), this method always returns None. +Any events not yet retrieved when the parser is closed can still be +read with read_events().

    +
    + +
    +
    +read_events()
    +

    Return an iterator over the events which have been encountered in the +data fed to the +parser. The iterator yields (event, elem) pairs, where event is a +string representing the type of event (e.g. "end") and elem is the +encountered Element object.

    +

    Events provided in a previous call to read_events() will not be +yielded again. Events are consumed from the internal queue only when +they are retrieved from the iterator, so multiple readers iterating in +parallel over iterators obtained from read_events() will have +unpredictable results.

    +
    + +
    +

    Note

    +

    XMLPullParser only guarantees that it has seen the “>” +character of a starting tag when it emits a “start” event, so the +attributes are defined, but the contents of the text and tail attributes +are undefined at that point. The same applies to the element children; +they may or may not be present.

    +

    If you need a fully populated element, look for “end” events instead.

    +
    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +

    Exceptions

    +
    +
    +class xml.etree.ElementTree.ParseError
    +

    XML parse error, raised by the various parsing methods in this module when +parsing fails. The string representation of an instance of this exception +will contain a user-friendly error message. In addition, it will have +the following attributes available:

    +
    +
    +code
    +

    A numeric error code from the expat parser. See the documentation of +xml.parsers.expat for the list of error codes and their meanings.

    +
    + +
    +
    +position
    +

    A tuple of line, column numbers, specifying where the error occurred.

    +
    + +
    + +

    Footnotes

    +
    +
    1(1,2,3,4)
    +

    The encoding string included in XML output should conform to the +appropriate standards. For example, “UTF-8” is valid, but “UTF8” is +not. See https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl +and https://www.iana.org/assignments/character-sets/character-sets.xhtml.

    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/xml.html b/python-3.7.4-docs-html/library/xml.html new file mode 100644 index 0000000..537e9db --- /dev/null +++ b/python-3.7.4-docs-html/library/xml.html @@ -0,0 +1,340 @@ + + + + + + + XML Processing Modules — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    XML Processing Modules

    +

    Source code: Lib/xml/

    +
    +

    Python’s interfaces for processing XML are grouped in the xml package.

    +
    +

    Warning

    +

    The XML modules are not secure against erroneous or maliciously +constructed data. If you need to parse untrusted or +unauthenticated data see the XML vulnerabilities and +The defusedxml and defusedexpat Packages sections.

    +
    +

    It is important to note that modules in the xml package require that +there be at least one SAX-compliant XML parser available. The Expat parser is +included with Python, so the xml.parsers.expat module will always be +available.

    +

    The documentation for the xml.dom and xml.sax packages are the +definition of the Python bindings for the DOM and SAX interfaces.

    +

    The XML handling submodules are:

    + + + +
    +

    XML vulnerabilities

    +

    The XML processing modules are not secure against maliciously constructed data. +An attacker can abuse XML features to carry out denial of service attacks, +access local files, generate network connections to other machines, or +circumvent firewalls.

    +

    The following table gives an overview of the known attacks and whether +the various modules are vulnerable to them.

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    kind

    sax

    etree

    minidom

    pulldom

    xmlrpc

    billion laughs

    Vulnerable

    Vulnerable

    Vulnerable

    Vulnerable

    Vulnerable

    quadratic blowup

    Vulnerable

    Vulnerable

    Vulnerable

    Vulnerable

    Vulnerable

    external entity expansion

    Safe (4)

    Safe (1)

    Safe (2)

    Safe (4)

    Safe (3)

    DTD retrieval

    Safe (4)

    Safe

    Safe

    Safe (4)

    Safe

    decompression bomb

    Safe

    Safe

    Safe

    Safe

    Vulnerable

    +
      +
    1. xml.etree.ElementTree doesn’t expand external entities and raises a +ParserError when an entity occurs.

    2. +
    3. xml.dom.minidom doesn’t expand external entities and simply returns +the unexpanded entity verbatim.

    4. +
    5. xmlrpclib doesn’t expand external entities and omits them.

    6. +
    7. Since Python 3.7.1, external general entities are no longer processed by +default.

    8. +
    +
    +
    billion laughs / exponential entity expansion

    The Billion Laughs attack – also known as exponential entity expansion – +uses multiple levels of nested entities. Each entity refers to another entity +several times, and the final entity definition contains a small string. +The exponential expansion results in several gigabytes of text and +consumes lots of memory and CPU time.

    +
    +
    quadratic blowup entity expansion

    A quadratic blowup attack is similar to a Billion Laughs attack; it abuses +entity expansion, too. Instead of nested entities it repeats one large entity +with a couple of thousand chars over and over again. The attack isn’t as +efficient as the exponential case but it avoids triggering parser countermeasures +that forbid deeply-nested entities.

    +
    +
    external entity expansion

    Entity declarations can contain more than just text for replacement. They can +also point to external resources or local files. The XML +parser accesses the resource and embeds the content into the XML document.

    +
    +
    DTD retrieval

    Some XML libraries like Python’s xml.dom.pulldom retrieve document type +definitions from remote or local locations. The feature has similar +implications as the external entity expansion issue.

    +
    +
    decompression bomb

    Decompression bombs (aka ZIP bomb) apply to all XML libraries +that can parse compressed XML streams such as gzipped HTTP streams or +LZMA-compressed +files. For an attacker it can reduce the amount of transmitted data by three +magnitudes or more.

    +
    +
    +

    The documentation for defusedxml on PyPI has further information about +all known attack vectors with examples and references.

    +
    +
    +

    The defusedxml and defusedexpat Packages

    +

    defusedxml is a pure Python package with modified subclasses of all stdlib +XML parsers that prevent any potentially malicious operation. Use of this +package is recommended for any server code that parses untrusted XML data. The +package also ships with example exploits and extended documentation on more +XML exploits such as XPath injection.

    +

    defusedexpat provides a modified libexpat and a patched +pyexpat module that have countermeasures against entity expansion +DoS attacks. The defusedexpat module still allows a sane and configurable amount of entity +expansions. The modifications may be included in some future release of Python, +but will not be included in any bugfix releases of +Python because they break backward compatibility.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/xml.sax.handler.html b/python-3.7.4-docs-html/library/xml.sax.handler.html new file mode 100644 index 0000000..f64cd35 --- /dev/null +++ b/python-3.7.4-docs-html/library/xml.sax.handler.html @@ -0,0 +1,612 @@ + + + + + + + xml.sax.handler — Base classes for SAX handlers — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    xml.sax.handler — Base classes for SAX handlers

    +

    Source code: Lib/xml/sax/handler.py

    +
    +

    The SAX API defines four kinds of handlers: content handlers, DTD handlers, +error handlers, and entity resolvers. Applications normally only need to +implement those interfaces whose events they are interested in; they can +implement the interfaces in a single object or in multiple objects. Handler +implementations should inherit from the base classes provided in the module +xml.sax.handler, so that all methods get default implementations.

    +
    +
    +class xml.sax.handler.ContentHandler
    +

    This is the main callback interface in SAX, and the one most important to +applications. The order of events in this interface mirrors the order of the +information in the document.

    +
    + +
    +
    +class xml.sax.handler.DTDHandler
    +

    Handle DTD events.

    +

    This interface specifies only those DTD events required for basic parsing +(unparsed entities and attributes).

    +
    + +
    +
    +class xml.sax.handler.EntityResolver
    +

    Basic interface for resolving entities. If you create an object implementing +this interface, then register the object with your Parser, the parser will call +the method in your object to resolve all external entities.

    +
    + +
    +
    +class xml.sax.handler.ErrorHandler
    +

    Interface used by the parser to present error and warning messages to the +application. The methods of this object control whether errors are immediately +converted to exceptions or are handled in some other way.

    +
    + +

    In addition to these classes, xml.sax.handler provides symbolic constants +for the feature and property names.

    +
    +
    +xml.sax.handler.feature_namespaces
    +
    +
    value: "http://xml.org/sax/features/namespaces"
    +
    true: Perform Namespace processing.
    +
    false: Optionally do not perform Namespace processing (implies +namespace-prefixes; default).
    +
    access: (parsing) read-only; (not parsing) read/write
    +
    +
    + +
    +
    +xml.sax.handler.feature_namespace_prefixes
    +
    +
    value: "http://xml.org/sax/features/namespace-prefixes"
    +
    true: Report the original prefixed names and attributes used for Namespace +declarations.
    +
    false: Do not report attributes used for Namespace declarations, and +optionally do not report original prefixed names (default).
    +
    access: (parsing) read-only; (not parsing) read/write
    +
    +
    + +
    +
    +xml.sax.handler.feature_string_interning
    +
    +
    value: "http://xml.org/sax/features/string-interning"
    +
    true: All element names, prefixes, attribute names, Namespace URIs, and +local names are interned using the built-in intern function.
    +
    false: Names are not necessarily interned, although they may be (default).
    +
    access: (parsing) read-only; (not parsing) read/write
    +
    +
    + +
    +
    +xml.sax.handler.feature_validation
    +
    +
    value: "http://xml.org/sax/features/validation"
    +
    true: Report all validation errors (implies external-general-entities and +external-parameter-entities).
    +
    false: Do not report validation errors.
    +
    access: (parsing) read-only; (not parsing) read/write
    +
    +
    + +
    +
    +xml.sax.handler.feature_external_ges
    +
    +
    value: "http://xml.org/sax/features/external-general-entities"
    +
    true: Include all external general (text) entities.
    +
    false: Do not include external general entities.
    +
    access: (parsing) read-only; (not parsing) read/write
    +
    +
    + +
    +
    +xml.sax.handler.feature_external_pes
    +
    +
    value: "http://xml.org/sax/features/external-parameter-entities"
    +
    true: Include all external parameter entities, including the external DTD +subset.
    +
    false: Do not include any external parameter entities, even the external +DTD subset.
    +
    access: (parsing) read-only; (not parsing) read/write
    +
    +
    + +
    +
    +xml.sax.handler.all_features
    +

    List of all features.

    +
    + +
    +
    +xml.sax.handler.property_lexical_handler
    +
    +
    value: "http://xml.org/sax/properties/lexical-handler"
    +
    data type: xml.sax.sax2lib.LexicalHandler (not supported in Python 2)
    +
    description: An optional extension handler for lexical events like +comments.
    +
    access: read/write
    +
    +
    + +
    +
    +xml.sax.handler.property_declaration_handler
    +
    +
    value: "http://xml.org/sax/properties/declaration-handler"
    +
    data type: xml.sax.sax2lib.DeclHandler (not supported in Python 2)
    +
    description: An optional extension handler for DTD-related events other +than notations and unparsed entities.
    +
    access: read/write
    +
    +
    + +
    +
    +xml.sax.handler.property_dom_node
    +
    +
    value: "http://xml.org/sax/properties/dom-node"
    +
    data type: org.w3c.dom.Node (not supported in Python 2)
    +
    description: When parsing, the current DOM node being visited if this is +a DOM iterator; when not parsing, the root DOM node for iteration.
    +
    access: (parsing) read-only; (not parsing) read/write
    +
    +
    + +
    +
    +xml.sax.handler.property_xml_string
    +
    +
    value: "http://xml.org/sax/properties/xml-string"
    +
    data type: String
    +
    description: The literal string of characters that was the source for the +current event.
    +
    access: read-only
    +
    +
    + +
    +
    +xml.sax.handler.all_properties
    +

    List of all known property names.

    +
    + +
    +

    ContentHandler Objects

    +

    Users are expected to subclass ContentHandler to support their +application. The following methods are called by the parser on the appropriate +events in the input document:

    +
    +
    +ContentHandler.setDocumentLocator(locator)
    +

    Called by the parser to give the application a locator for locating the origin +of document events.

    +

    SAX parsers are strongly encouraged (though not absolutely required) to supply a +locator: if it does so, it must supply the locator to the application by +invoking this method before invoking any of the other methods in the +DocumentHandler interface.

    +

    The locator allows the application to determine the end position of any +document-related event, even if the parser is not reporting an error. Typically, +the application will use this information for reporting its own errors (such as +character content that does not match an application’s business rules). The +information returned by the locator is probably not sufficient for use with a +search engine.

    +

    Note that the locator will return correct information only during the invocation +of the events in this interface. The application should not attempt to use it at +any other time.

    +
    + +
    +
    +ContentHandler.startDocument()
    +

    Receive notification of the beginning of a document.

    +

    The SAX parser will invoke this method only once, before any other methods in +this interface or in DTDHandler (except for setDocumentLocator()).

    +
    + +
    +
    +ContentHandler.endDocument()
    +

    Receive notification of the end of a document.

    +

    The SAX parser will invoke this method only once, and it will be the last method +invoked during the parse. The parser shall not invoke this method until it has +either abandoned parsing (because of an unrecoverable error) or reached the end +of input.

    +
    + +
    +
    +ContentHandler.startPrefixMapping(prefix, uri)
    +

    Begin the scope of a prefix-URI Namespace mapping.

    +

    The information from this event is not necessary for normal Namespace +processing: the SAX XML reader will automatically replace prefixes for element +and attribute names when the feature_namespaces feature is enabled (the +default).

    +

    There are cases, however, when applications need to use prefixes in character +data or in attribute values, where they cannot safely be expanded automatically; +the startPrefixMapping() and endPrefixMapping() events supply the +information to the application to expand prefixes in those contexts itself, if +necessary.

    +

    Note that startPrefixMapping() and endPrefixMapping() events are not +guaranteed to be properly nested relative to each-other: all +startPrefixMapping() events will occur before the corresponding +startElement() event, and all endPrefixMapping() events will occur +after the corresponding endElement() event, but their order is not +guaranteed.

    +
    + +
    +
    +ContentHandler.endPrefixMapping(prefix)
    +

    End the scope of a prefix-URI mapping.

    +

    See startPrefixMapping() for details. This event will always occur after +the corresponding endElement() event, but the order of +endPrefixMapping() events is not otherwise guaranteed.

    +
    + +
    +
    +ContentHandler.startElement(name, attrs)
    +

    Signals the start of an element in non-namespace mode.

    +

    The name parameter contains the raw XML 1.0 name of the element type as a +string and the attrs parameter holds an object of the +Attributes +interface (see The Attributes Interface) containing the attributes of +the element. The object passed as attrs may be re-used by the parser; holding +on to a reference to it is not a reliable way to keep a copy of the attributes. +To keep a copy of the attributes, use the copy() method of the attrs +object.

    +
    + +
    +
    +ContentHandler.endElement(name)
    +

    Signals the end of an element in non-namespace mode.

    +

    The name parameter contains the name of the element type, just as with the +startElement() event.

    +
    + +
    +
    +ContentHandler.startElementNS(name, qname, attrs)
    +

    Signals the start of an element in namespace mode.

    +

    The name parameter contains the name of the element type as a (uri, +localname) tuple, the qname parameter contains the raw XML 1.0 name used in +the source document, and the attrs parameter holds an instance of the +AttributesNS interface (see +The AttributesNS Interface) +containing the attributes of the element. If no namespace is associated with +the element, the uri component of name will be None. The object passed +as attrs may be re-used by the parser; holding on to a reference to it is not +a reliable way to keep a copy of the attributes. To keep a copy of the +attributes, use the copy() method of the attrs object.

    +

    Parsers may set the qname parameter to None, unless the +feature_namespace_prefixes feature is activated.

    +
    + +
    +
    +ContentHandler.endElementNS(name, qname)
    +

    Signals the end of an element in namespace mode.

    +

    The name parameter contains the name of the element type, just as with the +startElementNS() method, likewise the qname parameter.

    +
    + +
    +
    +ContentHandler.characters(content)
    +

    Receive notification of character data.

    +

    The Parser will call this method to report each chunk of character data. SAX +parsers may return all contiguous character data in a single chunk, or they may +split it into several chunks; however, all of the characters in any single event +must come from the same external entity so that the Locator provides useful +information.

    +

    content may be a string or bytes instance; the expat reader module +always produces strings.

    +
    +

    Note

    +

    The earlier SAX 1 interface provided by the Python XML Special Interest Group +used a more Java-like interface for this method. Since most parsers used from +Python did not take advantage of the older interface, the simpler signature was +chosen to replace it. To convert old code to the new interface, use content +instead of slicing content with the old offset and length parameters.

    +
    +
    + +
    +
    +ContentHandler.ignorableWhitespace(whitespace)
    +

    Receive notification of ignorable whitespace in element content.

    +

    Validating Parsers must use this method to report each chunk of ignorable +whitespace (see the W3C XML 1.0 recommendation, section 2.10): non-validating +parsers may also use this method if they are capable of parsing and using +content models.

    +

    SAX parsers may return all contiguous whitespace in a single chunk, or they may +split it into several chunks; however, all of the characters in any single event +must come from the same external entity, so that the Locator provides useful +information.

    +
    + +
    +
    +ContentHandler.processingInstruction(target, data)
    +

    Receive notification of a processing instruction.

    +

    The Parser will invoke this method once for each processing instruction found: +note that processing instructions may occur before or after the main document +element.

    +

    A SAX parser should never report an XML declaration (XML 1.0, section 2.8) or a +text declaration (XML 1.0, section 4.3.1) using this method.

    +
    + +
    +
    +ContentHandler.skippedEntity(name)
    +

    Receive notification of a skipped entity.

    +

    The Parser will invoke this method once for each entity skipped. Non-validating +processors may skip entities if they have not seen the declarations (because, +for example, the entity was declared in an external DTD subset). All processors +may skip external entities, depending on the values of the +feature_external_ges and the feature_external_pes properties.

    +
    + +
    +
    +

    DTDHandler Objects

    +

    DTDHandler instances provide the following methods:

    +
    +
    +DTDHandler.notationDecl(name, publicId, systemId)
    +

    Handle a notation declaration event.

    +
    + +
    +
    +DTDHandler.unparsedEntityDecl(name, publicId, systemId, ndata)
    +

    Handle an unparsed entity declaration event.

    +
    + +
    +
    +

    EntityResolver Objects

    +
    +
    +EntityResolver.resolveEntity(publicId, systemId)
    +

    Resolve the system identifier of an entity and return either the system +identifier to read from as a string, or an InputSource to read from. The default +implementation returns systemId.

    +
    + +
    +
    +

    ErrorHandler Objects

    +

    Objects with this interface are used to receive error and warning information +from the XMLReader. If you create an object that +implements this interface, then register the object with your +XMLReader, the parser +will call the methods in your object to report all warnings and errors. There +are three levels of errors available: warnings, (possibly) recoverable errors, +and unrecoverable errors. All methods take a SAXParseException as the +only parameter. Errors and warnings may be converted to an exception by raising +the passed-in exception object.

    +
    +
    +ErrorHandler.error(exception)
    +

    Called when the parser encounters a recoverable error. If this method does not +raise an exception, parsing may continue, but further document information +should not be expected by the application. Allowing the parser to continue may +allow additional errors to be discovered in the input document.

    +
    + +
    +
    +ErrorHandler.fatalError(exception)
    +

    Called when the parser encounters an error it cannot recover from; parsing is +expected to terminate when this method returns.

    +
    + +
    +
    +ErrorHandler.warning(exception)
    +

    Called when the parser presents minor warning information to the application. +Parsing is expected to continue when this method returns, and document +information will continue to be passed to the application. Raising an exception +in this method will cause parsing to end.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/xml.sax.html b/python-3.7.4-docs-html/library/xml.sax.html new file mode 100644 index 0000000..db4ec61 --- /dev/null +++ b/python-3.7.4-docs-html/library/xml.sax.html @@ -0,0 +1,346 @@ + + + + + + + xml.sax — Support for SAX2 parsers — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    xml.sax — Support for SAX2 parsers

    +

    Source code: Lib/xml/sax/__init__.py

    +
    +

    The xml.sax package provides a number of modules which implement the +Simple API for XML (SAX) interface for Python. The package itself provides the +SAX exceptions and the convenience functions which will be most used by users of +the SAX API.

    +
    +

    Warning

    +

    The xml.sax module is not secure against maliciously +constructed data. If you need to parse untrusted or unauthenticated data see +XML vulnerabilities.

    +
    +
    +

    Changed in version 3.7.1: The SAX parser no longer processes general external entities by default +to increase security. Before, the parser created network connections +to fetch remote files or loaded local files from the file +system for DTD and entities. The feature can be enabled again with method +setFeature() on the parser object +and argument feature_external_ges.

    +
    +

    The convenience functions are:

    +
    +
    +xml.sax.make_parser(parser_list=[])
    +

    Create and return a SAX XMLReader object. The +first parser found will +be used. If parser_list is provided, it must be a list of strings which +name modules that have a function named create_parser(). Modules listed +in parser_list will be used before modules in the default list of parsers.

    +
    + +
    +
    +xml.sax.parse(filename_or_stream, handler, error_handler=handler.ErrorHandler())
    +

    Create a SAX parser and use it to parse a document. The document, passed in as +filename_or_stream, can be a filename or a file object. The handler +parameter needs to be a SAX ContentHandler instance. If +error_handler is given, it must be a SAX ErrorHandler +instance; if +omitted, SAXParseException will be raised on all errors. There is no +return value; all work must be done by the handler passed in.

    +
    + +
    +
    +xml.sax.parseString(string, handler, error_handler=handler.ErrorHandler())
    +

    Similar to parse(), but parses from a buffer string received as a +parameter. string must be a str instance or a +bytes-like object.

    +
    +

    Changed in version 3.5: Added support of str instances.

    +
    +
    + +

    A typical SAX application uses three kinds of objects: readers, handlers and +input sources. “Reader” in this context is another term for parser, i.e. some +piece of code that reads the bytes or characters from the input source, and +produces a sequence of events. The events then get distributed to the handler +objects, i.e. the reader invokes a method on the handler. A SAX application +must therefore obtain a reader object, create or open the input sources, create +the handlers, and connect these objects all together. As the final step of +preparation, the reader is called to parse the input. During parsing, methods on +the handler objects are called based on structural and syntactic events from the +input data.

    +

    For these objects, only the interfaces are relevant; they are normally not +instantiated by the application itself. Since Python does not have an explicit +notion of interface, they are formally introduced as classes, but applications +may use implementations which do not inherit from the provided classes. The +InputSource, Locator, +Attributes, AttributesNS, +and XMLReader interfaces are defined in the +module xml.sax.xmlreader. The handler interfaces are defined in +xml.sax.handler. For convenience, +InputSource (which is often +instantiated directly) and the handler classes are also available from +xml.sax. These interfaces are described below.

    +

    In addition to these classes, xml.sax provides the following exception +classes.

    +
    +
    +exception xml.sax.SAXException(msg, exception=None)
    +

    Encapsulate an XML error or warning. This class can contain basic error or +warning information from either the XML parser or the application: it can be +subclassed to provide additional functionality or to add localization. Note +that although the handlers defined in the +ErrorHandler interface +receive instances of this exception, it is not required to actually raise the +exception — it is also useful as a container for information.

    +

    When instantiated, msg should be a human-readable description of the error. +The optional exception parameter, if given, should be None or an exception +that was caught by the parsing code and is being passed along as information.

    +

    This is the base class for the other SAX exception classes.

    +
    + +
    +
    +exception xml.sax.SAXParseException(msg, exception, locator)
    +

    Subclass of SAXException raised on parse errors. Instances of this +class are passed to the methods of the SAX +ErrorHandler interface to provide information +about the parse error. This class supports the SAX +Locator interface as well as the +SAXException interface.

    +
    + +
    +
    +exception xml.sax.SAXNotRecognizedException(msg, exception=None)
    +

    Subclass of SAXException raised when a SAX +XMLReader is +confronted with an unrecognized feature or property. SAX applications and +extensions may use this class for similar purposes.

    +
    + +
    +
    +exception xml.sax.SAXNotSupportedException(msg, exception=None)
    +

    Subclass of SAXException raised when a SAX +XMLReader is asked to +enable a feature that is not supported, or to set a property to a value that the +implementation does not support. SAX applications and extensions may use this +class for similar purposes.

    +
    + +
    +

    See also

    +
    +
    SAX: The Simple API for XML

    This site is the focal point for the definition of the SAX API. It provides a +Java implementation and online documentation. Links to implementations and +historical information are also available.

    +
    +
    Module xml.sax.handler

    Definitions of the interfaces for application-provided objects.

    +
    +
    Module xml.sax.saxutils

    Convenience functions for use in SAX applications.

    +
    +
    Module xml.sax.xmlreader

    Definitions of the interfaces for parser-provided objects.

    +
    +
    +
    +
    +

    SAXException Objects

    +

    The SAXException exception class supports the following methods:

    +
    +
    +SAXException.getMessage()
    +

    Return a human-readable message describing the error condition.

    +
    + +
    +
    +SAXException.getException()
    +

    Return an encapsulated exception object, or None.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/xml.sax.reader.html b/python-3.7.4-docs-html/library/xml.sax.reader.html new file mode 100644 index 0000000..0aa06a7 --- /dev/null +++ b/python-3.7.4-docs-html/library/xml.sax.reader.html @@ -0,0 +1,581 @@ + + + + + + + xml.sax.xmlreader — Interface for XML parsers — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    xml.sax.xmlreader — Interface for XML parsers

    +

    Source code: Lib/xml/sax/xmlreader.py

    +
    +

    SAX parsers implement the XMLReader interface. They are implemented in +a Python module, which must provide a function create_parser(). This +function is invoked by xml.sax.make_parser() with no arguments to create +a new parser object.

    +
    +
    +class xml.sax.xmlreader.XMLReader
    +

    Base class which can be inherited by SAX parsers.

    +
    + +
    +
    +class xml.sax.xmlreader.IncrementalParser
    +

    In some cases, it is desirable not to parse an input source at once, but to feed +chunks of the document as they get available. Note that the reader will normally +not read the entire file, but read it in chunks as well; still parse() +won’t return until the entire document is processed. So these interfaces should +be used if the blocking behaviour of parse() is not desirable.

    +

    When the parser is instantiated it is ready to begin accepting data from the +feed method immediately. After parsing has been finished with a call to close +the reset method must be called to make the parser ready to accept new data, +either from feed or using the parse method.

    +

    Note that these methods must not be called during parsing, that is, after +parse has been called and before it returns.

    +

    By default, the class also implements the parse method of the XMLReader +interface using the feed, close and reset methods of the IncrementalParser +interface as a convenience to SAX 2.0 driver writers.

    +
    + +
    +
    +class xml.sax.xmlreader.Locator
    +

    Interface for associating a SAX event with a document location. A locator object +will return valid results only during calls to DocumentHandler methods; at any +other time, the results are unpredictable. If information is not available, +methods may return None.

    +
    + +
    +
    +class xml.sax.xmlreader.InputSource(system_id=None)
    +

    Encapsulation of the information needed by the XMLReader to read +entities.

    +

    This class may include information about the public identifier, system +identifier, byte stream (possibly with character encoding information) and/or +the character stream of an entity.

    +

    Applications will create objects of this class for use in the +XMLReader.parse() method and for returning from +EntityResolver.resolveEntity.

    +

    An InputSource belongs to the application, the XMLReader is +not allowed to modify InputSource objects passed to it from the +application, although it may make copies and modify those.

    +
    + +
    +
    +class xml.sax.xmlreader.AttributesImpl(attrs)
    +

    This is an implementation of the Attributes interface (see section +The Attributes Interface). This is a dictionary-like object which +represents the element attributes in a startElement() call. In addition +to the most useful dictionary operations, it supports a number of other +methods as described by the interface. Objects of this class should be +instantiated by readers; attrs must be a dictionary-like object containing +a mapping from attribute names to attribute values.

    +
    + +
    +
    +class xml.sax.xmlreader.AttributesNSImpl(attrs, qnames)
    +

    Namespace-aware variant of AttributesImpl, which will be passed to +startElementNS(). It is derived from AttributesImpl, but +understands attribute names as two-tuples of namespaceURI and +localname. In addition, it provides a number of methods expecting qualified +names as they appear in the original document. This class implements the +AttributesNS interface (see section The AttributesNS Interface).

    +
    + +
    +

    XMLReader Objects

    +

    The XMLReader interface supports the following methods:

    +
    +
    +XMLReader.parse(source)
    +

    Process an input source, producing SAX events. The source object can be a +system identifier (a string identifying the input source – typically a file +name or a URL), a file-like object, or an InputSource object. When +parse() returns, the input is completely processed, and the parser object +can be discarded or reset.

    +
    +

    Changed in version 3.5: Added support of character streams.

    +
    +
    + +
    +
    +XMLReader.getContentHandler()
    +

    Return the current ContentHandler.

    +
    + +
    +
    +XMLReader.setContentHandler(handler)
    +

    Set the current ContentHandler. If no +ContentHandler is set, content events will be +discarded.

    +
    + +
    +
    +XMLReader.getDTDHandler()
    +

    Return the current DTDHandler.

    +
    + +
    +
    +XMLReader.setDTDHandler(handler)
    +

    Set the current DTDHandler. If no +DTDHandler is set, DTD +events will be discarded.

    +
    + +
    +
    +XMLReader.getEntityResolver()
    +

    Return the current EntityResolver.

    +
    + +
    +
    +XMLReader.setEntityResolver(handler)
    +

    Set the current EntityResolver. If no +EntityResolver is set, +attempts to resolve an external entity will result in opening the system +identifier for the entity, and fail if it is not available.

    +
    + +
    +
    +XMLReader.getErrorHandler()
    +

    Return the current ErrorHandler.

    +
    + +
    +
    +XMLReader.setErrorHandler(handler)
    +

    Set the current error handler. If no ErrorHandler +is set, errors will be raised as exceptions, and warnings will be printed.

    +
    + +
    +
    +XMLReader.setLocale(locale)
    +

    Allow an application to set the locale for errors and warnings.

    +

    SAX parsers are not required to provide localization for errors and warnings; if +they cannot support the requested locale, however, they must raise a SAX +exception. Applications may request a locale change in the middle of a parse.

    +
    + +
    +
    +XMLReader.getFeature(featurename)
    +

    Return the current setting for feature featurename. If the feature is not +recognized, SAXNotRecognizedException is raised. The well-known +featurenames are listed in the module xml.sax.handler.

    +
    + +
    +
    +XMLReader.setFeature(featurename, value)
    +

    Set the featurename to value. If the feature is not recognized, +SAXNotRecognizedException is raised. If the feature or its setting is not +supported by the parser, SAXNotSupportedException is raised.

    +
    + +
    +
    +XMLReader.getProperty(propertyname)
    +

    Return the current setting for property propertyname. If the property is not +recognized, a SAXNotRecognizedException is raised. The well-known +propertynames are listed in the module xml.sax.handler.

    +
    + +
    +
    +XMLReader.setProperty(propertyname, value)
    +

    Set the propertyname to value. If the property is not recognized, +SAXNotRecognizedException is raised. If the property or its setting is +not supported by the parser, SAXNotSupportedException is raised.

    +
    + +
    +
    +

    IncrementalParser Objects

    +

    Instances of IncrementalParser offer the following additional methods:

    +
    +
    +IncrementalParser.feed(data)
    +

    Process a chunk of data.

    +
    + +
    +
    +IncrementalParser.close()
    +

    Assume the end of the document. That will check well-formedness conditions that +can be checked only at the end, invoke handlers, and may clean up resources +allocated during parsing.

    +
    + +
    +
    +IncrementalParser.reset()
    +

    This method is called after close has been called to reset the parser so that it +is ready to parse new documents. The results of calling parse or feed after +close without calling reset are undefined.

    +
    + +
    +
    +

    Locator Objects

    +

    Instances of Locator provide these methods:

    +
    +
    +Locator.getColumnNumber()
    +

    Return the column number where the current event begins.

    +
    + +
    +
    +Locator.getLineNumber()
    +

    Return the line number where the current event begins.

    +
    + +
    +
    +Locator.getPublicId()
    +

    Return the public identifier for the current event.

    +
    + +
    +
    +Locator.getSystemId()
    +

    Return the system identifier for the current event.

    +
    + +
    +
    +

    InputSource Objects

    +
    +
    +InputSource.setPublicId(id)
    +

    Sets the public identifier of this InputSource.

    +
    + +
    +
    +InputSource.getPublicId()
    +

    Returns the public identifier of this InputSource.

    +
    + +
    +
    +InputSource.setSystemId(id)
    +

    Sets the system identifier of this InputSource.

    +
    + +
    +
    +InputSource.getSystemId()
    +

    Returns the system identifier of this InputSource.

    +
    + +
    +
    +InputSource.setEncoding(encoding)
    +

    Sets the character encoding of this InputSource.

    +

    The encoding must be a string acceptable for an XML encoding declaration (see +section 4.3.3 of the XML recommendation).

    +

    The encoding attribute of the InputSource is ignored if the +InputSource also contains a character stream.

    +
    + +
    +
    +InputSource.getEncoding()
    +

    Get the character encoding of this InputSource.

    +
    + +
    +
    +InputSource.setByteStream(bytefile)
    +

    Set the byte stream (a binary file) for this input source.

    +

    The SAX parser will ignore this if there is also a character stream specified, +but it will use a byte stream in preference to opening a URI connection itself.

    +

    If the application knows the character encoding of the byte stream, it should +set it with the setEncoding method.

    +
    + +
    +
    +InputSource.getByteStream()
    +

    Get the byte stream for this input source.

    +

    The getEncoding method will return the character encoding for this byte stream, +or None if unknown.

    +
    + +
    +
    +InputSource.setCharacterStream(charfile)
    +

    Set the character stream (a text file) for this input source.

    +

    If there is a character stream specified, the SAX parser will ignore any byte +stream and will not attempt to open a URI connection to the system identifier.

    +
    + +
    +
    +InputSource.getCharacterStream()
    +

    Get the character stream for this input source.

    +
    + +
    +
    +

    The Attributes Interface

    +

    Attributes objects implement a portion of the mapping protocol, including the methods copy(), +get(), __contains__(), +items(), keys(), +and values(). The following methods +are also provided:

    +
    +
    +Attributes.getLength()
    +

    Return the number of attributes.

    +
    + +
    +
    +Attributes.getNames()
    +

    Return the names of the attributes.

    +
    + +
    +
    +Attributes.getType(name)
    +

    Returns the type of the attribute name, which is normally 'CDATA'.

    +
    + +
    +
    +Attributes.getValue(name)
    +

    Return the value of attribute name.

    +
    + +
    +
    +

    The AttributesNS Interface

    +

    This interface is a subtype of the Attributes interface (see section +The Attributes Interface). All methods supported by that interface are also +available on AttributesNS objects.

    +

    The following methods are also available:

    +
    +
    +AttributesNS.getValueByQName(name)
    +

    Return the value for a qualified name.

    +
    + +
    +
    +AttributesNS.getNameByQName(name)
    +

    Return the (namespace, localname) pair for a qualified name.

    +
    + +
    +
    +AttributesNS.getQNameByName(name)
    +

    Return the qualified name for a (namespace, localname) pair.

    +
    + +
    +
    +AttributesNS.getQNames()
    +

    Return the qualified names of all attributes.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/xml.sax.utils.html b/python-3.7.4-docs-html/library/xml.sax.utils.html new file mode 100644 index 0000000..bbbe84e --- /dev/null +++ b/python-3.7.4-docs-html/library/xml.sax.utils.html @@ -0,0 +1,266 @@ + + + + + + + xml.sax.saxutils — SAX Utilities — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    xml.sax.saxutils — SAX Utilities

    +

    Source code: Lib/xml/sax/saxutils.py

    +
    +

    The module xml.sax.saxutils contains a number of classes and functions +that are commonly useful when creating SAX applications, either in direct use, +or as base classes.

    +
    +
    +xml.sax.saxutils.escape(data, entities={})
    +

    Escape '&', '<', and '>' in a string of data.

    +

    You can escape other strings of data by passing a dictionary as the optional +entities parameter. The keys and values must all be strings; each key will be +replaced with its corresponding value. The characters '&', '<' and +'>' are always escaped, even if entities is provided.

    +
    + +
    +
    +xml.sax.saxutils.unescape(data, entities={})
    +

    Unescape '&amp;', '&lt;', and '&gt;' in a string of data.

    +

    You can unescape other strings of data by passing a dictionary as the optional +entities parameter. The keys and values must all be strings; each key will be +replaced with its corresponding value. '&amp', '&lt;', and '&gt;' +are always unescaped, even if entities is provided.

    +
    + +
    +
    +xml.sax.saxutils.quoteattr(data, entities={})
    +

    Similar to escape(), but also prepares data to be used as an +attribute value. The return value is a quoted version of data with any +additional required replacements. quoteattr() will select a quote +character based on the content of data, attempting to avoid encoding any +quote characters in the string. If both single- and double-quote characters +are already in data, the double-quote characters will be encoded and data +will be wrapped in double-quotes. The resulting string can be used directly +as an attribute value:

    +
    >>> print("<element attr=%s>" % quoteattr("ab ' cd \" ef"))
    +<element attr="ab ' cd &quot; ef">
    +
    +
    +

    This function is useful when generating attribute values for HTML or any SGML +using the reference concrete syntax.

    +
    + +
    +
    +class xml.sax.saxutils.XMLGenerator(out=None, encoding='iso-8859-1', short_empty_elements=False)
    +

    This class implements the ContentHandler interface +by writing SAX +events back into an XML document. In other words, using an XMLGenerator +as the content handler will reproduce the original document being parsed. out +should be a file-like object which will default to sys.stdout. encoding is +the encoding of the output stream which defaults to 'iso-8859-1'. +short_empty_elements controls the formatting of elements that contain no +content: if False (the default) they are emitted as a pair of start/end +tags, if set to True they are emitted as a single self-closed tag.

    +
    +

    New in version 3.2: The short_empty_elements parameter.

    +
    +
    + +
    +
    +class xml.sax.saxutils.XMLFilterBase(base)
    +

    This class is designed to sit between an +XMLReader and the client +application’s event handlers. By default, it does nothing but pass requests up +to the reader and events on to the handlers unmodified, but subclasses can +override specific methods to modify the event stream or the configuration +requests as they pass through.

    +
    + +
    +
    +xml.sax.saxutils.prepare_input_source(source, base='')
    +

    This function takes an input source and an optional base URL and returns a +fully resolved InputSource object ready for +reading. The input source can be given as a string, a file-like object, or +an InputSource object; parsers will use this +function to implement the polymorphic source argument to their +parse() method.

    +
    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/xmlrpc.client.html b/python-3.7.4-docs-html/library/xmlrpc.client.html new file mode 100644 index 0000000..44d3bc4 --- /dev/null +++ b/python-3.7.4-docs-html/library/xmlrpc.client.html @@ -0,0 +1,788 @@ + + + + + + + xmlrpc.client — XML-RPC client access — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    xmlrpc.client — XML-RPC client access

    +

    Source code: Lib/xmlrpc/client.py

    +
    +

    XML-RPC is a Remote Procedure Call method that uses XML passed via HTTP(S) as a +transport. With it, a client can call methods with parameters on a remote +server (the server is named by a URI) and get back structured data. This module +supports writing XML-RPC client code; it handles all the details of translating +between conformable Python objects and XML on the wire.

    +
    +

    Warning

    +

    The xmlrpc.client module is not secure against maliciously +constructed data. If you need to parse untrusted or unauthenticated data see +XML vulnerabilities.

    +
    +
    +

    Changed in version 3.5: For HTTPS URIs, xmlrpc.client now performs all the necessary +certificate and hostname checks by default.

    +
    +
    +
    +class xmlrpc.client.ServerProxy(uri, transport=None, encoding=None, verbose=False, allow_none=False, use_datetime=False, use_builtin_types=False, *, context=None)
    +
    +

    Changed in version 3.3: The use_builtin_types flag was added.

    +
    +

    A ServerProxy instance is an object that manages communication with a +remote XML-RPC server. The required first argument is a URI (Uniform Resource +Indicator), and will normally be the URL of the server. The optional second +argument is a transport factory instance; by default it is an internal +SafeTransport instance for https: URLs and an internal HTTP +Transport instance otherwise. The optional third argument is an +encoding, by default UTF-8. The optional fourth argument is a debugging flag.

    +

    The following parameters govern the use of the returned proxy instance. +If allow_none is true, the Python constant None will be translated into +XML; the default behaviour is for None to raise a TypeError. This is +a commonly-used extension to the XML-RPC specification, but isn’t supported by +all clients and servers; see http://ontosys.com/xml-rpc/extensions.php +for a description. +The use_builtin_types flag can be used to cause date/time values +to be presented as datetime.datetime objects and binary data to be +presented as bytes objects; this flag is false by default. +datetime.datetime, bytes and bytearray objects +may be passed to calls. +The obsolete use_datetime flag is similar to use_builtin_types but it +applies only to date/time values.

    +

    Both the HTTP and HTTPS transports support the URL syntax extension for HTTP +Basic Authentication: http://user:pass@host:port/path. The user:pass +portion will be base64-encoded as an HTTP ‘Authorization’ header, and sent to +the remote server as part of the connection process when invoking an XML-RPC +method. You only need to use this if the remote server requires a Basic +Authentication user and password. If an HTTPS URL is provided, context may +be ssl.SSLContext and configures the SSL settings of the underlying +HTTPS connection.

    +

    The returned instance is a proxy object with methods that can be used to invoke +corresponding RPC calls on the remote server. If the remote server supports the +introspection API, the proxy can also be used to query the remote server for the +methods it supports (service discovery) and fetch other server-associated +metadata.

    +

    Types that are conformable (e.g. that can be marshalled through XML), +include the following (and except where noted, they are unmarshalled +as the same Python type):

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    XML-RPC type

    Python type

    boolean

    bool

    int, i1, +i2, i4, +i8 or +biginteger

    int in range from -2147483648 to 2147483647. +Values get the <int> tag.

    double or +float

    float. Values get the <double> tag.

    string

    str

    array

    list or tuple containing +conformable elements. Arrays are returned as +lists.

    struct

    dict. Keys must be strings, values may be +any conformable type. Objects of user-defined +classes can be passed in; only their +__dict__ attribute is transmitted.

    dateTime.iso8601

    DateTime or datetime.datetime. +Returned type depends on values of +use_builtin_types and use_datetime flags.

    base64

    Binary, bytes or +bytearray. Returned type depends on the +value of the use_builtin_types flag.

    nil

    The None constant. Passing is allowed only if +allow_none is true.

    bigdecimal

    decimal.Decimal. Returned type only.

    +

    This is the full set of data types supported by XML-RPC. Method calls may also +raise a special Fault instance, used to signal XML-RPC server errors, or +ProtocolError used to signal an error in the HTTP/HTTPS transport layer. +Both Fault and ProtocolError derive from a base class called +Error. Note that the xmlrpc client module currently does not marshal +instances of subclasses of built-in types.

    +

    When passing strings, characters special to XML such as <, >, and & +will be automatically escaped. However, it’s the caller’s responsibility to +ensure that the string is free of characters that aren’t allowed in XML, such as +the control characters with ASCII values between 0 and 31 (except, of course, +tab, newline and carriage return); failing to do this will result in an XML-RPC +request that isn’t well-formed XML. If you have to pass arbitrary bytes +via XML-RPC, use bytes or bytearray classes or the +Binary wrapper class described below.

    +

    Server is retained as an alias for ServerProxy for backwards +compatibility. New code should use ServerProxy.

    +
    +

    Changed in version 3.5: Added the context argument.

    +
    +
    +

    Changed in version 3.6: Added support of type tags with prefixes (e.g. ex:nil). +Added support of unmarshalling additional types used by Apache XML-RPC +implementation for numerics: i1, i2, i8, biginteger, +float and bigdecimal. +See http://ws.apache.org/xmlrpc/types.html for a description.

    +
    +
    + +
    +

    See also

    +
    +
    XML-RPC HOWTO

    A good description of XML-RPC operation and client software in several languages. +Contains pretty much everything an XML-RPC client developer needs to know.

    +
    +
    XML-RPC Introspection

    Describes the XML-RPC protocol extension for introspection.

    +
    +
    XML-RPC Specification

    The official specification.

    +
    +
    Unofficial XML-RPC Errata

    Fredrik Lundh’s “unofficial errata, intended to clarify certain +details in the XML-RPC specification, as well as hint at +‘best practices’ to use when designing your own XML-RPC +implementations.”

    +
    +
    +
    +
    +

    ServerProxy Objects

    +

    A ServerProxy instance has a method corresponding to each remote +procedure call accepted by the XML-RPC server. Calling the method performs an +RPC, dispatched by both name and argument signature (e.g. the same method name +can be overloaded with multiple argument signatures). The RPC finishes by +returning a value, which may be either returned data in a conformant type or a +Fault or ProtocolError object indicating an error.

    +

    Servers that support the XML introspection API support some common methods +grouped under the reserved system attribute:

    +
    +
    +ServerProxy.system.listMethods()
    +

    This method returns a list of strings, one for each (non-system) method +supported by the XML-RPC server.

    +
    + +
    +
    +ServerProxy.system.methodSignature(name)
    +

    This method takes one parameter, the name of a method implemented by the XML-RPC +server. It returns an array of possible signatures for this method. A signature +is an array of types. The first of these types is the return type of the method, +the rest are parameters.

    +

    Because multiple signatures (ie. overloading) is permitted, this method returns +a list of signatures rather than a singleton.

    +

    Signatures themselves are restricted to the top level parameters expected by a +method. For instance if a method expects one array of structs as a parameter, +and it returns a string, its signature is simply “string, array”. If it expects +three integers and returns a string, its signature is “string, int, int, int”.

    +

    If no signature is defined for the method, a non-array value is returned. In +Python this means that the type of the returned value will be something other +than list.

    +
    + +
    +
    +ServerProxy.system.methodHelp(name)
    +

    This method takes one parameter, the name of a method implemented by the XML-RPC +server. It returns a documentation string describing the use of that method. If +no such string is available, an empty string is returned. The documentation +string may contain HTML markup.

    +
    + +
    +

    Changed in version 3.5: Instances of ServerProxy support the context manager protocol +for closing the underlying transport.

    +
    +

    A working example follows. The server code:

    +
    from xmlrpc.server import SimpleXMLRPCServer
    +
    +def is_even(n):
    +    return n % 2 == 0
    +
    +server = SimpleXMLRPCServer(("localhost", 8000))
    +print("Listening on port 8000...")
    +server.register_function(is_even, "is_even")
    +server.serve_forever()
    +
    +
    +

    The client code for the preceding server:

    +
    import xmlrpc.client
    +
    +with xmlrpc.client.ServerProxy("http://localhost:8000/") as proxy:
    +    print("3 is even: %s" % str(proxy.is_even(3)))
    +    print("100 is even: %s" % str(proxy.is_even(100)))
    +
    +
    +
    +
    +

    DateTime Objects

    +
    +
    +class xmlrpc.client.DateTime
    +

    This class may be initialized with seconds since the epoch, a time +tuple, an ISO 8601 time/date string, or a datetime.datetime +instance. It has the following methods, supported mainly for internal +use by the marshalling/unmarshalling code:

    +
    +
    +decode(string)
    +

    Accept a string as the instance’s new time value.

    +
    + +
    +
    +encode(out)
    +

    Write the XML-RPC encoding of this DateTime item to the out stream +object.

    +
    + +

    It also supports certain of Python’s built-in operators through rich comparison +and __repr__() methods.

    +
    + +

    A working example follows. The server code:

    +
    import datetime
    +from xmlrpc.server import SimpleXMLRPCServer
    +import xmlrpc.client
    +
    +def today():
    +    today = datetime.datetime.today()
    +    return xmlrpc.client.DateTime(today)
    +
    +server = SimpleXMLRPCServer(("localhost", 8000))
    +print("Listening on port 8000...")
    +server.register_function(today, "today")
    +server.serve_forever()
    +
    +
    +

    The client code for the preceding server:

    +
    import xmlrpc.client
    +import datetime
    +
    +proxy = xmlrpc.client.ServerProxy("http://localhost:8000/")
    +
    +today = proxy.today()
    +# convert the ISO8601 string to a datetime object
    +converted = datetime.datetime.strptime(today.value, "%Y%m%dT%H:%M:%S")
    +print("Today: %s" % converted.strftime("%d.%m.%Y, %H:%M"))
    +
    +
    +
    +
    +

    Binary Objects

    +
    +
    +class xmlrpc.client.Binary
    +

    This class may be initialized from bytes data (which may include NULs). The +primary access to the content of a Binary object is provided by an +attribute:

    +
    +
    +data
    +

    The binary data encapsulated by the Binary instance. The data is +provided as a bytes object.

    +
    + +

    Binary objects have the following methods, supported mainly for +internal use by the marshalling/unmarshalling code:

    +
    +
    +decode(bytes)
    +

    Accept a base64 bytes object and decode it as the instance’s new data.

    +
    + +
    +
    +encode(out)
    +

    Write the XML-RPC base 64 encoding of this binary item to the out stream object.

    +

    The encoded data will have newlines every 76 characters as per +RFC 2045 section 6.8, +which was the de facto standard base64 specification when the +XML-RPC spec was written.

    +
    + +

    It also supports certain of Python’s built-in operators through __eq__() +and __ne__() methods.

    +
    + +

    Example usage of the binary objects. We’re going to transfer an image over +XMLRPC:

    +
    from xmlrpc.server import SimpleXMLRPCServer
    +import xmlrpc.client
    +
    +def python_logo():
    +    with open("python_logo.jpg", "rb") as handle:
    +        return xmlrpc.client.Binary(handle.read())
    +
    +server = SimpleXMLRPCServer(("localhost", 8000))
    +print("Listening on port 8000...")
    +server.register_function(python_logo, 'python_logo')
    +
    +server.serve_forever()
    +
    +
    +

    The client gets the image and saves it to a file:

    +
    import xmlrpc.client
    +
    +proxy = xmlrpc.client.ServerProxy("http://localhost:8000/")
    +with open("fetched_python_logo.jpg", "wb") as handle:
    +    handle.write(proxy.python_logo().data)
    +
    +
    +
    +
    +

    Fault Objects

    +
    +
    +class xmlrpc.client.Fault
    +

    A Fault object encapsulates the content of an XML-RPC fault tag. Fault +objects have the following attributes:

    +
    +
    +faultCode
    +

    A string indicating the fault type.

    +
    + +
    +
    +faultString
    +

    A string containing a diagnostic message associated with the fault.

    +
    + +
    + +

    In the following example we’re going to intentionally cause a Fault by +returning a complex type object. The server code:

    +
    from xmlrpc.server import SimpleXMLRPCServer
    +
    +# A marshalling error is going to occur because we're returning a
    +# complex number
    +def add(x, y):
    +    return x+y+0j
    +
    +server = SimpleXMLRPCServer(("localhost", 8000))
    +print("Listening on port 8000...")
    +server.register_function(add, 'add')
    +
    +server.serve_forever()
    +
    +
    +

    The client code for the preceding server:

    +
    import xmlrpc.client
    +
    +proxy = xmlrpc.client.ServerProxy("http://localhost:8000/")
    +try:
    +    proxy.add(2, 5)
    +except xmlrpc.client.Fault as err:
    +    print("A fault occurred")
    +    print("Fault code: %d" % err.faultCode)
    +    print("Fault string: %s" % err.faultString)
    +
    +
    +
    +
    +

    ProtocolError Objects

    +
    +
    +class xmlrpc.client.ProtocolError
    +

    A ProtocolError object describes a protocol error in the underlying +transport layer (such as a 404 ‘not found’ error if the server named by the URI +does not exist). It has the following attributes:

    +
    +
    +url
    +

    The URI or URL that triggered the error.

    +
    + +
    +
    +errcode
    +

    The error code.

    +
    + +
    +
    +errmsg
    +

    The error message or diagnostic string.

    +
    + +
    +
    +headers
    +

    A dict containing the headers of the HTTP/HTTPS request that triggered the +error.

    +
    + +
    + +

    In the following example we’re going to intentionally cause a ProtocolError +by providing an invalid URI:

    +
    import xmlrpc.client
    +
    +# create a ServerProxy with a URI that doesn't respond to XMLRPC requests
    +proxy = xmlrpc.client.ServerProxy("http://google.com/")
    +
    +try:
    +    proxy.some_method()
    +except xmlrpc.client.ProtocolError as err:
    +    print("A protocol error occurred")
    +    print("URL: %s" % err.url)
    +    print("HTTP/HTTPS headers: %s" % err.headers)
    +    print("Error code: %d" % err.errcode)
    +    print("Error message: %s" % err.errmsg)
    +
    +
    +
    +
    +

    MultiCall Objects

    +

    The MultiCall object provides a way to encapsulate multiple calls to a +remote server into a single request 1.

    +
    +
    +class xmlrpc.client.MultiCall(server)
    +

    Create an object used to boxcar method calls. server is the eventual target of +the call. Calls can be made to the result object, but they will immediately +return None, and only store the call name and parameters in the +MultiCall object. Calling the object itself causes all stored calls to +be transmitted as a single system.multicall request. The result of this call +is a generator; iterating over this generator yields the individual +results.

    +
    + +

    A usage example of this class follows. The server code:

    +
    from xmlrpc.server import SimpleXMLRPCServer
    +
    +def add(x, y):
    +    return x + y
    +
    +def subtract(x, y):
    +    return x - y
    +
    +def multiply(x, y):
    +    return x * y
    +
    +def divide(x, y):
    +    return x // y
    +
    +# A simple server with simple arithmetic functions
    +server = SimpleXMLRPCServer(("localhost", 8000))
    +print("Listening on port 8000...")
    +server.register_multicall_functions()
    +server.register_function(add, 'add')
    +server.register_function(subtract, 'subtract')
    +server.register_function(multiply, 'multiply')
    +server.register_function(divide, 'divide')
    +server.serve_forever()
    +
    +
    +

    The client code for the preceding server:

    +
    import xmlrpc.client
    +
    +proxy = xmlrpc.client.ServerProxy("http://localhost:8000/")
    +multicall = xmlrpc.client.MultiCall(proxy)
    +multicall.add(7, 3)
    +multicall.subtract(7, 3)
    +multicall.multiply(7, 3)
    +multicall.divide(7, 3)
    +result = multicall()
    +
    +print("7+3=%d, 7-3=%d, 7*3=%d, 7//3=%d" % tuple(result))
    +
    +
    +
    +
    +

    Convenience Functions

    +
    +
    +xmlrpc.client.dumps(params, methodname=None, methodresponse=None, encoding=None, allow_none=False)
    +

    Convert params into an XML-RPC request. or into a response if methodresponse +is true. params can be either a tuple of arguments or an instance of the +Fault exception class. If methodresponse is true, only a single value +can be returned, meaning that params must be of length 1. encoding, if +supplied, is the encoding to use in the generated XML; the default is UTF-8. +Python’s None value cannot be used in standard XML-RPC; to allow using +it via an extension, provide a true value for allow_none.

    +
    + +
    +
    +xmlrpc.client.loads(data, use_datetime=False, use_builtin_types=False)
    +

    Convert an XML-RPC request or response into Python objects, a (params, +methodname). params is a tuple of argument; methodname is a string, or +None if no method name is present in the packet. If the XML-RPC packet +represents a fault condition, this function will raise a Fault exception. +The use_builtin_types flag can be used to cause date/time values to be +presented as datetime.datetime objects and binary data to be +presented as bytes objects; this flag is false by default.

    +

    The obsolete use_datetime flag is similar to use_builtin_types but it +applies only to date/time values.

    +
    +

    Changed in version 3.3: The use_builtin_types flag was added.

    +
    +
    + +
    +
    +

    Example of Client Usage

    +
    # simple test program (from the XML-RPC specification)
    +from xmlrpc.client import ServerProxy, Error
    +
    +# server = ServerProxy("http://localhost:8000") # local server
    +with ServerProxy("http://betty.userland.com") as proxy:
    +
    +    print(proxy)
    +
    +    try:
    +        print(proxy.examples.getStateName(41))
    +    except Error as v:
    +        print("ERROR", v)
    +
    +
    +

    To access an XML-RPC server through a HTTP proxy, you need to define a custom +transport. The following example shows how:

    +
    import http.client
    +import xmlrpc.client
    +
    +class ProxiedTransport(xmlrpc.client.Transport):
    +
    +    def set_proxy(self, host, port=None, headers=None):
    +        self.proxy = host, port
    +        self.proxy_headers = headers
    +
    +    def make_connection(self, host):
    +        connection = http.client.HTTPConnection(*self.proxy)
    +        connection.set_tunnel(host, headers=self.proxy_headers)
    +        self._connection = host, connection
    +        return connection
    +
    +transport = ProxiedTransport()
    +transport.set_proxy('proxy-server', 8080)
    +server = xmlrpc.client.ServerProxy('http://betty.userland.com', transport=transport)
    +print(server.examples.getStateName(41))
    +
    +
    +
    +
    +

    Example of Client and Server Usage

    +

    See SimpleXMLRPCServer Example.

    +

    Footnotes

    +
    +
    1
    +

    This approach has been first presented in a discussion on xmlrpc.com.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/xmlrpc.html b/python-3.7.4-docs-html/library/xmlrpc.html new file mode 100644 index 0000000..bcc1cd7 --- /dev/null +++ b/python-3.7.4-docs-html/library/xmlrpc.html @@ -0,0 +1,192 @@ + + + + + + + xmlrpc — XMLRPC server and client modules — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    xmlrpc — XMLRPC server and client modules

    +

    XML-RPC is a Remote Procedure Call method that uses XML passed via HTTP as a +transport. With it, a client can call methods with parameters on a remote +server (the server is named by a URI) and get back structured data.

    +

    xmlrpc is a package that collects server and client modules implementing +XML-RPC. The modules are:

    + +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/xmlrpc.server.html b/python-3.7.4-docs-html/library/xmlrpc.server.html new file mode 100644 index 0000000..44f5f74 --- /dev/null +++ b/python-3.7.4-docs-html/library/xmlrpc.server.html @@ -0,0 +1,626 @@ + + + + + + + xmlrpc.server — Basic XML-RPC servers — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    xmlrpc.server — Basic XML-RPC servers

    +

    Source code: Lib/xmlrpc/server.py

    +
    +

    The xmlrpc.server module provides a basic server framework for XML-RPC +servers written in Python. Servers can either be free standing, using +SimpleXMLRPCServer, or embedded in a CGI environment, using +CGIXMLRPCRequestHandler.

    +
    +

    Warning

    +

    The xmlrpc.server module is not secure against maliciously +constructed data. If you need to parse untrusted or unauthenticated data see +XML vulnerabilities.

    +
    +
    +
    +class xmlrpc.server.SimpleXMLRPCServer(addr, requestHandler=SimpleXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True, use_builtin_types=False)
    +

    Create a new server instance. This class provides methods for registration of +functions that can be called by the XML-RPC protocol. The requestHandler +parameter should be a factory for request handler instances; it defaults to +SimpleXMLRPCRequestHandler. The addr and requestHandler parameters +are passed to the socketserver.TCPServer constructor. If logRequests +is true (the default), requests will be logged; setting this parameter to false +will turn off logging. The allow_none and encoding parameters are passed +on to xmlrpc.client and control the XML-RPC responses that will be returned +from the server. The bind_and_activate parameter controls whether +server_bind() and server_activate() are called immediately by the +constructor; it defaults to true. Setting it to false allows code to manipulate +the allow_reuse_address class variable before the address is bound. +The use_builtin_types parameter is passed to the +loads() function and controls which types are processed +when date/times values or binary data are received; it defaults to false.

    +
    +

    Changed in version 3.3: The use_builtin_types flag was added.

    +
    +
    + +
    +
    +class xmlrpc.server.CGIXMLRPCRequestHandler(allow_none=False, encoding=None, use_builtin_types=False)
    +

    Create a new instance to handle XML-RPC requests in a CGI environment. The +allow_none and encoding parameters are passed on to xmlrpc.client +and control the XML-RPC responses that will be returned from the server. +The use_builtin_types parameter is passed to the +loads() function and controls which types are processed +when date/times values or binary data are received; it defaults to false.

    +
    +

    Changed in version 3.3: The use_builtin_types flag was added.

    +
    +
    + +
    +
    +class xmlrpc.server.SimpleXMLRPCRequestHandler
    +

    Create a new request handler instance. This request handler supports POST +requests and modifies logging so that the logRequests parameter to the +SimpleXMLRPCServer constructor parameter is honored.

    +
    + +
    +

    SimpleXMLRPCServer Objects

    +

    The SimpleXMLRPCServer class is based on +socketserver.TCPServer and provides a means of creating simple, stand +alone XML-RPC servers.

    +
    +
    +SimpleXMLRPCServer.register_function(function=None, name=None)
    +

    Register a function that can respond to XML-RPC requests. If name is given, +it will be the method name associated with function, otherwise +function.__name__ will be used. name is a string, and may contain +characters not legal in Python identifiers, including the period character.

    +

    This method can also be used as a decorator. When used as a decorator, +name can only be given as a keyword argument to register function under +name. If no name is given, function.__name__ will be used.

    +
    +

    Changed in version 3.7: register_function() can be used as a decorator.

    +
    +
    + +
    +
    +SimpleXMLRPCServer.register_instance(instance, allow_dotted_names=False)
    +

    Register an object which is used to expose method names which have not been +registered using register_function(). If instance contains a +_dispatch() method, it is called with the requested method name and the +parameters from the request. Its API is def _dispatch(self, method, params) +(note that params does not represent a variable argument list). If it calls +an underlying function to perform its task, that function is called as +func(*params), expanding the parameter list. The return value from +_dispatch() is returned to the client as the result. If instance does +not have a _dispatch() method, it is searched for an attribute matching +the name of the requested method.

    +

    If the optional allow_dotted_names argument is true and the instance does not +have a _dispatch() method, then if the requested method name contains +periods, each component of the method name is searched for individually, with +the effect that a simple hierarchical search is performed. The value found from +this search is then called with the parameters from the request, and the return +value is passed back to the client.

    +
    +

    Warning

    +

    Enabling the allow_dotted_names option allows intruders to access your +module’s global variables and may allow intruders to execute arbitrary code on +your machine. Only use this option on a secure, closed network.

    +
    +
    + +
    +
    +SimpleXMLRPCServer.register_introspection_functions()
    +

    Registers the XML-RPC introspection functions system.listMethods, +system.methodHelp and system.methodSignature.

    +
    + +
    +
    +SimpleXMLRPCServer.register_multicall_functions()
    +

    Registers the XML-RPC multicall function system.multicall.

    +
    + +
    +
    +SimpleXMLRPCRequestHandler.rpc_paths
    +

    An attribute value that must be a tuple listing valid path portions of the URL +for receiving XML-RPC requests. Requests posted to other paths will result in a +404 “no such page” HTTP error. If this tuple is empty, all paths will be +considered valid. The default value is ('/', '/RPC2').

    +
    + +
    +

    SimpleXMLRPCServer Example

    +

    Server code:

    +
    from xmlrpc.server import SimpleXMLRPCServer
    +from xmlrpc.server import SimpleXMLRPCRequestHandler
    +
    +# Restrict to a particular path.
    +class RequestHandler(SimpleXMLRPCRequestHandler):
    +    rpc_paths = ('/RPC2',)
    +
    +# Create server
    +with SimpleXMLRPCServer(('localhost', 8000),
    +                        requestHandler=RequestHandler) as server:
    +    server.register_introspection_functions()
    +
    +    # Register pow() function; this will use the value of
    +    # pow.__name__ as the name, which is just 'pow'.
    +    server.register_function(pow)
    +
    +    # Register a function under a different name
    +    def adder_function(x, y):
    +        return x + y
    +    server.register_function(adder_function, 'add')
    +
    +    # Register an instance; all the methods of the instance are
    +    # published as XML-RPC methods (in this case, just 'mul').
    +    class MyFuncs:
    +        def mul(self, x, y):
    +            return x * y
    +
    +    server.register_instance(MyFuncs())
    +
    +    # Run the server's main loop
    +    server.serve_forever()
    +
    +
    +

    The following client code will call the methods made available by the preceding +server:

    +
    import xmlrpc.client
    +
    +s = xmlrpc.client.ServerProxy('http://localhost:8000')
    +print(s.pow(2,3))  # Returns 2**3 = 8
    +print(s.add(2,3))  # Returns 5
    +print(s.mul(5,2))  # Returns 5*2 = 10
    +
    +# Print list of available methods
    +print(s.system.listMethods())
    +
    +
    +

    register_function() can also be used as a decorator. The previous server +example can register functions in a decorator way:

    +
    from xmlrpc.server import SimpleXMLRPCServer
    +from xmlrpc.server import SimpleXMLRPCRequestHandler
    +
    +class RequestHandler(SimpleXMLRPCRequestHandler):
    +    rpc_paths = ('/RPC2',)
    +
    +with SimpleXMLRPCServer(('localhost', 8000),
    +                        requestHandler=RequestHandler) as server:
    +    server.register_introspection_functions()
    +
    +    # Register pow() function; this will use the value of
    +    # pow.__name__ as the name, which is just 'pow'.
    +    server.register_function(pow)
    +
    +    # Register a function under a different name, using
    +    # register_function as a decorator. *name* can only be given
    +    # as a keyword argument.
    +    @server.register_function(name='add')
    +    def adder_function(x, y):
    +        return x + y
    +
    +    # Register a function under function.__name__.
    +    @server.register_function
    +    def mul(x, y):
    +        return x * y
    +
    +    server.serve_forever()
    +
    +
    +

    The following example included in the Lib/xmlrpc/server.py module shows +a server allowing dotted names and registering a multicall function.

    +
    +

    Warning

    +

    Enabling the allow_dotted_names option allows intruders to access your +module’s global variables and may allow intruders to execute arbitrary code on +your machine. Only use this example only within a secure, closed network.

    +
    +
    import datetime
    +
    +class ExampleService:
    +    def getData(self):
    +        return '42'
    +
    +    class currentTime:
    +        @staticmethod
    +        def getCurrentTime():
    +            return datetime.datetime.now()
    +
    +with SimpleXMLRPCServer(("localhost", 8000)) as server:
    +    server.register_function(pow)
    +    server.register_function(lambda x,y: x+y, 'add')
    +    server.register_instance(ExampleService(), allow_dotted_names=True)
    +    server.register_multicall_functions()
    +    print('Serving XML-RPC on localhost port 8000')
    +    try:
    +        server.serve_forever()
    +    except KeyboardInterrupt:
    +        print("\nKeyboard interrupt received, exiting.")
    +        sys.exit(0)
    +
    +
    +

    This ExampleService demo can be invoked from the command line:

    +
    python -m xmlrpc.server
    +
    +
    +

    The client that interacts with the above server is included in +Lib/xmlrpc/client.py:

    +
    server = ServerProxy("http://localhost:8000")
    +
    +try:
    +    print(server.currentTime.getCurrentTime())
    +except Error as v:
    +    print("ERROR", v)
    +
    +multi = MultiCall(server)
    +multi.getData()
    +multi.pow(2,9)
    +multi.add(1,2)
    +try:
    +    for response in multi():
    +        print(response)
    +except Error as v:
    +    print("ERROR", v)
    +
    +
    +

    This client which interacts with the demo XMLRPC server can be invoked as:

    +
    python -m xmlrpc.client
    +
    +
    +
    +
    +
    +

    CGIXMLRPCRequestHandler

    +

    The CGIXMLRPCRequestHandler class can be used to handle XML-RPC +requests sent to Python CGI scripts.

    +
    +
    +CGIXMLRPCRequestHandler.register_function(function=None, name=None)
    +

    Register a function that can respond to XML-RPC requests. If name is given, +it will be the method name associated with function, otherwise +function.__name__ will be used. name is a string, and may contain +characters not legal in Python identifiers, including the period character.

    +

    This method can also be used as a decorator. When used as a decorator, +name can only be given as a keyword argument to register function under +name. If no name is given, function.__name__ will be used.

    +
    +

    Changed in version 3.7: register_function() can be used as a decorator.

    +
    +
    + +
    +
    +CGIXMLRPCRequestHandler.register_instance(instance)
    +

    Register an object which is used to expose method names which have not been +registered using register_function(). If instance contains a +_dispatch() method, it is called with the requested method name and the +parameters from the request; the return value is returned to the client as the +result. If instance does not have a _dispatch() method, it is searched +for an attribute matching the name of the requested method; if the requested +method name contains periods, each component of the method name is searched for +individually, with the effect that a simple hierarchical search is performed. +The value found from this search is then called with the parameters from the +request, and the return value is passed back to the client.

    +
    + +
    +
    +CGIXMLRPCRequestHandler.register_introspection_functions()
    +

    Register the XML-RPC introspection functions system.listMethods, +system.methodHelp and system.methodSignature.

    +
    + +
    +
    +CGIXMLRPCRequestHandler.register_multicall_functions()
    +

    Register the XML-RPC multicall function system.multicall.

    +
    + +
    +
    +CGIXMLRPCRequestHandler.handle_request(request_text=None)
    +

    Handle an XML-RPC request. If request_text is given, it should be the POST +data provided by the HTTP server, otherwise the contents of stdin will be used.

    +
    + +

    Example:

    +
    class MyFuncs:
    +    def mul(self, x, y):
    +        return x * y
    +
    +
    +handler = CGIXMLRPCRequestHandler()
    +handler.register_function(pow)
    +handler.register_function(lambda x,y: x+y, 'add')
    +handler.register_introspection_functions()
    +handler.register_instance(MyFuncs())
    +handler.handle_request()
    +
    +
    +
    +
    +

    Documenting XMLRPC server

    +

    These classes extend the above classes to serve HTML documentation in response +to HTTP GET requests. Servers can either be free standing, using +DocXMLRPCServer, or embedded in a CGI environment, using +DocCGIXMLRPCRequestHandler.

    +
    +
    +class xmlrpc.server.DocXMLRPCServer(addr, requestHandler=DocXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True, use_builtin_types=True)
    +

    Create a new server instance. All parameters have the same meaning as for +SimpleXMLRPCServer; requestHandler defaults to +DocXMLRPCRequestHandler.

    +
    +

    Changed in version 3.3: The use_builtin_types flag was added.

    +
    +
    + +
    +
    +class xmlrpc.server.DocCGIXMLRPCRequestHandler
    +

    Create a new instance to handle XML-RPC requests in a CGI environment.

    +
    + +
    +
    +class xmlrpc.server.DocXMLRPCRequestHandler
    +

    Create a new request handler instance. This request handler supports XML-RPC +POST requests, documentation GET requests, and modifies logging so that the +logRequests parameter to the DocXMLRPCServer constructor parameter is +honored.

    +
    + +
    +
    +

    DocXMLRPCServer Objects

    +

    The DocXMLRPCServer class is derived from SimpleXMLRPCServer +and provides a means of creating self-documenting, stand alone XML-RPC +servers. HTTP POST requests are handled as XML-RPC method calls. HTTP GET +requests are handled by generating pydoc-style HTML documentation. This allows a +server to provide its own web-based documentation.

    +
    +
    +DocXMLRPCServer.set_server_title(server_title)
    +

    Set the title used in the generated HTML documentation. This title will be used +inside the HTML “title” element.

    +
    + +
    +
    +DocXMLRPCServer.set_server_name(server_name)
    +

    Set the name used in the generated HTML documentation. This name will appear at +the top of the generated documentation inside a “h1” element.

    +
    + +
    +
    +DocXMLRPCServer.set_server_documentation(server_documentation)
    +

    Set the description used in the generated HTML documentation. This description +will appear as a paragraph, below the server name, in the documentation.

    +
    + +
    +
    +

    DocCGIXMLRPCRequestHandler

    +

    The DocCGIXMLRPCRequestHandler class is derived from +CGIXMLRPCRequestHandler and provides a means of creating +self-documenting, XML-RPC CGI scripts. HTTP POST requests are handled as XML-RPC +method calls. HTTP GET requests are handled by generating pydoc-style HTML +documentation. This allows a server to provide its own web-based documentation.

    +
    +
    +DocCGIXMLRPCRequestHandler.set_server_title(server_title)
    +

    Set the title used in the generated HTML documentation. This title will be used +inside the HTML “title” element.

    +
    + +
    +
    +DocCGIXMLRPCRequestHandler.set_server_name(server_name)
    +

    Set the name used in the generated HTML documentation. This name will appear at +the top of the generated documentation inside a “h1” element.

    +
    + +
    +
    +DocCGIXMLRPCRequestHandler.set_server_documentation(server_documentation)
    +

    Set the description used in the generated HTML documentation. This description +will appear as a paragraph, below the server name, in the documentation.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/zipapp.html b/python-3.7.4-docs-html/library/zipapp.html new file mode 100644 index 0000000..9f7b070 --- /dev/null +++ b/python-3.7.4-docs-html/library/zipapp.html @@ -0,0 +1,597 @@ + + + + + + + zipapp — Manage executable Python zip archives — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    zipapp — Manage executable Python zip archives

    +
    +

    New in version 3.5.

    +
    +

    Source code: Lib/zipapp.py

    +
    +

    This module provides tools to manage the creation of zip files containing +Python code, which can be executed directly by the Python interpreter. The module provides both a +Command-Line Interface and a Python API.

    +
    +

    Basic Example

    +

    The following example shows how the Command-Line Interface +can be used to create an executable archive from a directory containing +Python code. When run, the archive will execute the main function from +the module myapp in the archive.

    +
    $ python -m zipapp myapp -m "myapp:main"
    +$ python myapp.pyz
    +<output from myapp>
    +
    +
    +
    +
    +

    Command-Line Interface

    +

    When called as a program from the command line, the following form is used:

    +
    $ python -m zipapp source [options]
    +
    +
    +

    If source is a directory, this will create an archive from the contents of +source. If source is a file, it should be an archive, and it will be +copied to the target archive (or the contents of its shebang line will be +displayed if the –info option is specified).

    +

    The following options are understood:

    +
    +
    +-o <output>, --output=<output>
    +

    Write the output to a file named output. If this option is not specified, +the output filename will be the same as the input source, with the +extension .pyz added. If an explicit filename is given, it is used as +is (so a .pyz extension should be included if required).

    +

    An output filename must be specified if the source is an archive (and in +that case, output must not be the same as source).

    +
    + +
    +
    +-p <interpreter>, --python=<interpreter>
    +

    Add a #! line to the archive specifying interpreter as the command +to run. Also, on POSIX, make the archive executable. The default is to +write no #! line, and not make the file executable.

    +
    + +
    +
    +-m <mainfn>, --main=<mainfn>
    +

    Write a __main__.py file to the archive that executes mainfn. The +mainfn argument should have the form “pkg.mod:fn”, where “pkg.mod” is a +package/module in the archive, and “fn” is a callable in the given module. +The __main__.py file will execute that callable.

    +

    --main cannot be specified when copying an archive.

    +
    + +
    +
    +-c, --compress
    +

    Compress files with the deflate method, reducing the size of the output +file. By default, files are stored uncompressed in the archive.

    +

    --compress has no effect when copying an archive.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +--info
    +

    Display the interpreter embedded in the archive, for diagnostic purposes. In +this case, any other options are ignored and SOURCE must be an archive, not a +directory.

    +
    + +
    +
    +-h, --help
    +

    Print a short usage message and exit.

    +
    + +
    +
    +

    Python API

    +

    The module defines two convenience functions:

    +
    +
    +zipapp.create_archive(source, target=None, interpreter=None, main=None, filter=None, compressed=False)
    +

    Create an application archive from source. The source can be any +of the following:

    +
      +
    • The name of a directory, or a path-like object referring +to a directory, in which case a new application archive will be +created from the content of that directory.

    • +
    • The name of an existing application archive file, or a path-like object +referring to such a file, in which case the file is copied to +the target (modifying it to reflect the value given for the interpreter +argument). The file name should include the .pyz extension, if required.

    • +
    • A file object open for reading in bytes mode. The content of the +file should be an application archive, and the file object is +assumed to be positioned at the start of the archive.

    • +
    +

    The target argument determines where the resulting archive will be +written:

    +
      +
    • If it is the name of a file, or a path-like object, +the archive will be written to that file.

    • +
    • If it is an open file object, the archive will be written to that +file object, which must be open for writing in bytes mode.

    • +
    • If the target is omitted (or None), the source must be a directory +and the target will be a file with the same name as the source, with +a .pyz extension added.

    • +
    +

    The interpreter argument specifies the name of the Python +interpreter with which the archive will be executed. It is written as +a “shebang” line at the start of the archive. On POSIX, this will be +interpreted by the OS, and on Windows it will be handled by the Python +launcher. Omitting the interpreter results in no shebang line being +written. If an interpreter is specified, and the target is a +filename, the executable bit of the target file will be set.

    +

    The main argument specifies the name of a callable which will be +used as the main program for the archive. It can only be specified if +the source is a directory, and the source does not already contain a +__main__.py file. The main argument should take the form +“pkg.module:callable” and the archive will be run by importing +“pkg.module” and executing the given callable with no arguments. It +is an error to omit main if the source is a directory and does not +contain a __main__.py file, as otherwise the resulting archive +would not be executable.

    +

    The optional filter argument specifies a callback function that +is passed a Path object representing the path to the file being added +(relative to the source directory). It should return True if the +file is to be added.

    +

    The optional compressed argument determines whether files are +compressed. If set to True, files in the archive are compressed +with the deflate method; otherwise, files are stored uncompressed. +This argument has no effect when copying an existing archive.

    +

    If a file object is specified for source or target, it is the +caller’s responsibility to close it after calling create_archive.

    +

    When copying an existing archive, file objects supplied only need +read and readline, or write methods. When creating an +archive from a directory, if the target is a file object it will be +passed to the zipfile.ZipFile class, and must supply the methods +needed by that class.

    +
    +

    New in version 3.7: Added the filter and compressed arguments.

    +
    +
    + +
    +
    +zipapp.get_interpreter(archive)
    +

    Return the interpreter specified in the #! line at the start of the +archive. If there is no #! line, return None. +The archive argument can be a filename or a file-like object open +for reading in bytes mode. It is assumed to be at the start of the archive.

    +
    + +
    +
    +

    Examples

    +

    Pack up a directory into an archive, and run it.

    +
    $ python -m zipapp myapp
    +$ python myapp.pyz
    +<output from myapp>
    +
    +
    +

    The same can be done using the create_archive() function:

    +
    >>> import zipapp
    +>>> zipapp.create_archive('myapp.pyz', 'myapp')
    +
    +
    +

    To make the application directly executable on POSIX, specify an interpreter +to use.

    +
    $ python -m zipapp myapp -p "/usr/bin/env python"
    +$ ./myapp.pyz
    +<output from myapp>
    +
    +
    +

    To replace the shebang line on an existing archive, create a modified archive +using the create_archive() function:

    +
    >>> import zipapp
    +>>> zipapp.create_archive('old_archive.pyz', 'new_archive.pyz', '/usr/bin/python3')
    +
    +
    +

    To update the file in place, do the replacement in memory using a BytesIO +object, and then overwrite the source afterwards. Note that there is a risk +when overwriting a file in place that an error will result in the loss of +the original file. This code does not protect against such errors, but +production code should do so. Also, this method will only work if the archive +fits in memory:

    +
    >>> import zipapp
    +>>> import io
    +>>> temp = io.BytesIO()
    +>>> zipapp.create_archive('myapp.pyz', temp, '/usr/bin/python2')
    +>>> with open('myapp.pyz', 'wb') as f:
    +>>>     f.write(temp.getvalue())
    +
    +
    +
    +
    +

    Specifying the Interpreter

    +

    Note that if you specify an interpreter and then distribute your application +archive, you need to ensure that the interpreter used is portable. The Python +launcher for Windows supports most common forms of POSIX #! line, but there +are other issues to consider:

    +
      +
    • If you use “/usr/bin/env python” (or other forms of the “python” command, +such as “/usr/bin/python”), you need to consider that your users may have +either Python 2 or Python 3 as their default, and write your code to work +under both versions.

    • +
    • If you use an explicit version, for example “/usr/bin/env python3” your +application will not work for users who do not have that version. (This +may be what you want if you have not made your code Python 2 compatible).

    • +
    • There is no way to say “python X.Y or later”, so be careful of using an +exact version like “/usr/bin/env python3.4” as you will need to change your +shebang line for users of Python 3.5, for example.

    • +
    +

    Typically, you should use an “/usr/bin/env python2” or “/usr/bin/env python3”, +depending on whether your code is written for Python 2 or 3.

    +
    +
    +

    Creating Standalone Applications with zipapp

    +

    Using the zipapp module, it is possible to create self-contained Python +programs, which can be distributed to end users who only need to have a +suitable version of Python installed on their system. The key to doing this +is to bundle all of the application’s dependencies into the archive, along +with the application code.

    +

    The steps to create a standalone archive are as follows:

    +
      +
    1. Create your application in a directory as normal, so you have a myapp +directory containing a __main__.py file, and any supporting application +code.

    2. +
    3. Install all of your application’s dependencies into the myapp directory, +using pip:

      +
      $ python -m pip install -r requirements.txt --target myapp
      +
      +
      +

      (this assumes you have your project requirements in a requirements.txt +file - if not, you can just list the dependencies manually on the pip command +line).

      +
    4. +
    5. Optionally, delete the .dist-info directories created by pip in the +myapp directory. These hold metadata for pip to manage the packages, and +as you won’t be making any further use of pip they aren’t required - +although it won’t do any harm if you leave them.

    6. +
    7. Package the application using:

      +
      $ python -m zipapp -p "interpreter" myapp
      +
      +
      +
    8. +
    +

    This will produce a standalone executable, which can be run on any machine with +the appropriate interpreter available. See Specifying the Interpreter +for details. It can be shipped to users as a single file.

    +

    On Unix, the myapp.pyz file is executable as it stands. You can rename the +file to remove the .pyz extension if you prefer a “plain” command name. On +Windows, the myapp.pyz[w] file is executable by virtue of the fact that +the Python interpreter registers the .pyz and .pyzw file extensions +when installed.

    +
    +

    Making a Windows executable

    +

    On Windows, registration of the .pyz extension is optional, and +furthermore, there are certain places that don’t recognise registered +extensions “transparently” (the simplest example is that +subprocess.run(['myapp']) won’t find your application - you need to +explicitly specify the extension).

    +

    On Windows, therefore, it is often preferable to create an executable from the +zipapp. This is relatively easy, although it does require a C compiler. The +basic approach relies on the fact that zipfiles can have arbitrary data +prepended, and Windows exe files can have arbitrary data appended. So by +creating a suitable launcher and tacking the .pyz file onto the end of it, +you end up with a single-file executable that runs your application.

    +

    A suitable launcher can be as simple as the following:

    +
    #define Py_LIMITED_API 1
    +#include "Python.h"
    +
    +#define WIN32_LEAN_AND_MEAN
    +#include <windows.h>
    +
    +#ifdef WINDOWS
    +int WINAPI wWinMain(
    +    HINSTANCE hInstance,      /* handle to current instance */
    +    HINSTANCE hPrevInstance,  /* handle to previous instance */
    +    LPWSTR lpCmdLine,         /* pointer to command line */
    +    int nCmdShow              /* show state of window */
    +)
    +#else
    +int wmain()
    +#endif
    +{
    +    wchar_t **myargv = _alloca((__argc + 1) * sizeof(wchar_t*));
    +    myargv[0] = __wargv[0];
    +    memcpy(myargv + 1, __wargv, __argc * sizeof(wchar_t *));
    +    return Py_Main(__argc+1, myargv);
    +}
    +
    +
    +

    If you define the WINDOWS preprocessor symbol, this will generate a +GUI executable, and without it, a console executable.

    +

    To compile the executable, you can either just use the standard MSVC +command line tools, or you can take advantage of the fact that distutils +knows how to compile Python source:

    +
    >>> from distutils.ccompiler import new_compiler
    +>>> import distutils.sysconfig
    +>>> import sys
    +>>> import os
    +>>> from pathlib import Path
    +
    +>>> def compile(src):
    +>>>     src = Path(src)
    +>>>     cc = new_compiler()
    +>>>     exe = src.stem
    +>>>     cc.add_include_dir(distutils.sysconfig.get_python_inc())
    +>>>     cc.add_library_dir(os.path.join(sys.base_exec_prefix, 'libs'))
    +>>>     # First the CLI executable
    +>>>     objs = cc.compile([str(src)])
    +>>>     cc.link_executable(objs, exe)
    +>>>     # Now the GUI executable
    +>>>     cc.define_macro('WINDOWS')
    +>>>     objs = cc.compile([str(src)])
    +>>>     cc.link_executable(objs, exe + 'w')
    +
    +>>> if __name__ == "__main__":
    +>>>     compile("zastub.c")
    +
    +
    +

    The resulting launcher uses the “Limited ABI”, so it will run unchanged with +any version of Python 3.x. All it needs is for Python (python3.dll) to be +on the user’s PATH.

    +

    For a fully standalone distribution, you can distribute the launcher with your +application appended, bundled with the Python “embedded” distribution. This +will run on any PC with the appropriate architecture (32 bit or 64 bit).

    +
    +
    +

    Caveats

    +

    There are some limitations to the process of bundling your application into +a single file. In most, if not all, cases they can be addressed without +needing major changes to your application.

    +
      +
    1. If your application depends on a package that includes a C extension, that +package cannot be run from a zip file (this is an OS limitation, as executable +code must be present in the filesystem for the OS loader to load it). In this +case, you can exclude that dependency from the zipfile, and either require +your users to have it installed, or ship it alongside your zipfile and add code +to your __main__.py to include the directory containing the unzipped +module in sys.path. In this case, you will need to make sure to ship +appropriate binaries for your target architecture(s) (and potentially pick the +correct version to add to sys.path at runtime, based on the user’s machine).

    2. +
    3. If you are shipping a Windows executable as described above, you either need to +ensure that your users have python3.dll on their PATH (which is not the +default behaviour of the installer) or you should bundle your application with +the embedded distribution.

    4. +
    5. The suggested launcher above uses the Python embedding API. This means that in +your application, sys.executable will be your application, and not a +conventional Python interpreter. Your code and its dependencies need to be +prepared for this possibility. For example, if your application uses the +multiprocessing module, it will need to call +multiprocessing.set_executable() to let the module know where to find the +standard Python interpreter.

    6. +
    +
    +
    +
    +

    The Python Zip Application Archive Format

    +

    Python has been able to execute zip files which contain a __main__.py file +since version 2.6. In order to be executed by Python, an application archive +simply has to be a standard zip file containing a __main__.py file which +will be run as the entry point for the application. As usual for any Python +script, the parent of the script (in this case the zip file) will be placed on +sys.path and thus further modules can be imported from the zip file.

    +

    The zip file format allows arbitrary data to be prepended to a zip file. The +zip application format uses this ability to prepend a standard POSIX “shebang” +line to the file (#!/path/to/interpreter).

    +

    Formally, the Python zip application format is therefore:

    +
      +
    1. An optional shebang line, containing the characters b'#!' followed by an +interpreter name, and then a newline (b'\n') character. The interpreter +name can be anything acceptable to the OS “shebang” processing, or the Python +launcher on Windows. The interpreter should be encoded in UTF-8 on Windows, +and in sys.getfilesystemencoding() on POSIX.

    2. +
    3. Standard zipfile data, as generated by the zipfile module. The +zipfile content must include a file called __main__.py (which must be +in the “root” of the zipfile - i.e., it cannot be in a subdirectory). The +zipfile data can be compressed or uncompressed.

    4. +
    +

    If an application archive has a shebang line, it may have the executable bit set +on POSIX systems, to allow it to be executed directly.

    +

    There is no requirement that the tools in this module are used to create +application archives - the module is a convenience, but archives in the above +format created by any means are acceptable to Python.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/zipfile.html b/python-3.7.4-docs-html/library/zipfile.html new file mode 100644 index 0000000..730f8ee --- /dev/null +++ b/python-3.7.4-docs-html/library/zipfile.html @@ -0,0 +1,953 @@ + + + + + + + zipfile — Work with ZIP archives — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    zipfile — Work with ZIP archives

    +

    Source code: Lib/zipfile.py

    +
    +

    The ZIP file format is a common archive and compression standard. This module +provides tools to create, read, write, append, and list a ZIP file. Any +advanced use of this module will require an understanding of the format, as +defined in PKZIP Application Note.

    +

    This module does not currently handle multi-disk ZIP files. +It can handle ZIP files that use the ZIP64 extensions +(that is ZIP files that are more than 4 GiB in size). It supports +decryption of encrypted files in ZIP archives, but it currently cannot +create an encrypted file. Decryption is extremely slow as it is +implemented in native Python rather than C.

    +

    The module defines the following items:

    +
    +
    +exception zipfile.BadZipFile
    +

    The error raised for bad ZIP files.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +exception zipfile.BadZipfile
    +

    Alias of BadZipFile, for compatibility with older Python versions.

    +
    +

    Deprecated since version 3.2.

    +
    +
    + +
    +
    +exception zipfile.LargeZipFile
    +

    The error raised when a ZIP file would require ZIP64 functionality but that has +not been enabled.

    +
    + +
    +
    +class zipfile.ZipFile
    +

    The class for reading and writing ZIP files. See section +ZipFile Objects for constructor details.

    +
    + +
    +
    +class zipfile.PyZipFile
    +

    Class for creating ZIP archives containing Python libraries.

    +
    + +
    +
    +class zipfile.ZipInfo(filename='NoName', date_time=(1980, 1, 1, 0, 0, 0))
    +

    Class used to represent information about a member of an archive. Instances +of this class are returned by the getinfo() and infolist() +methods of ZipFile objects. Most users of the zipfile module +will not need to create these, but only use those created by this +module. filename should be the full name of the archive member, and +date_time should be a tuple containing six fields which describe the time +of the last modification to the file; the fields are described in section +ZipInfo Objects.

    +
    + +
    +
    +zipfile.is_zipfile(filename)
    +

    Returns True if filename is a valid ZIP file based on its magic number, +otherwise returns False. filename may be a file or file-like object too.

    +
    +

    Changed in version 3.1: Support for file and file-like objects.

    +
    +
    + +
    +
    +zipfile.ZIP_STORED
    +

    The numeric constant for an uncompressed archive member.

    +
    + +
    +
    +zipfile.ZIP_DEFLATED
    +

    The numeric constant for the usual ZIP compression method. This requires the +zlib module.

    +
    + +
    +
    +zipfile.ZIP_BZIP2
    +

    The numeric constant for the BZIP2 compression method. This requires the +bz2 module.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +zipfile.ZIP_LZMA
    +

    The numeric constant for the LZMA compression method. This requires the +lzma module.

    +
    +

    New in version 3.3.

    +
    +
    +

    Note

    +

    The ZIP file format specification has included support for bzip2 compression +since 2001, and for LZMA compression since 2006. However, some tools +(including older Python releases) do not support these compression +methods, and may either refuse to process the ZIP file altogether, +or fail to extract individual files.

    +
    +
    + +
    +

    See also

    +
    +
    PKZIP Application Note

    Documentation on the ZIP file format by Phil Katz, the creator of the format and +algorithms used.

    +
    +
    Info-ZIP Home Page

    Information about the Info-ZIP project’s ZIP archive programs and development +libraries.

    +
    +
    +
    +
    +

    ZipFile Objects

    +
    +
    +class zipfile.ZipFile(file, mode='r', compression=ZIP_STORED, allowZip64=True, compresslevel=None)
    +

    Open a ZIP file, where file can be a path to a file (a string), a +file-like object or a path-like object.

    +

    The mode parameter should be 'r' to read an existing +file, 'w' to truncate and write a new file, 'a' to append to an +existing file, or 'x' to exclusively create and write a new file. +If mode is 'x' and file refers to an existing file, +a FileExistsError will be raised. +If mode is 'a' and file refers to an existing ZIP +file, then additional files are added to it. If file does not refer to a +ZIP file, then a new ZIP archive is appended to the file. This is meant for +adding a ZIP archive to another file (such as python.exe). If +mode is 'a' and the file does not exist at all, it is created. +If mode is 'r' or 'a', the file should be seekable.

    +

    compression is the ZIP compression method to use when writing the archive, +and should be ZIP_STORED, ZIP_DEFLATED, +ZIP_BZIP2 or ZIP_LZMA; unrecognized +values will cause NotImplementedError to be raised. If +ZIP_DEFLATED, ZIP_BZIP2 or ZIP_LZMA is specified +but the corresponding module (zlib, bz2 or lzma) is not +available, RuntimeError is raised. The default is ZIP_STORED.

    +

    If allowZip64 is True (the default) zipfile will create ZIP files that +use the ZIP64 extensions when the zipfile is larger than 4 GiB. If it is +false zipfile will raise an exception when the ZIP file would +require ZIP64 extensions.

    +

    The compresslevel parameter controls the compression level to use when +writing files to the archive. +When using ZIP_STORED or ZIP_LZMA it has no effect. +When using ZIP_DEFLATED integers 0 through 9 are accepted +(see zlib for more information). +When using ZIP_BZIP2 integers 1 through 9 are accepted +(see bz2 for more information).

    +

    If the file is created with mode 'w', 'x' or 'a' and then +closed without adding any files to the archive, the appropriate +ZIP structures for an empty archive will be written to the file.

    +

    ZipFile is also a context manager and therefore supports the +with statement. In the example, myzip is closed after the +with statement’s suite is finished—even if an exception occurs:

    +
    with ZipFile('spam.zip', 'w') as myzip:
    +    myzip.write('eggs.txt')
    +
    +
    +
    +

    New in version 3.2: Added the ability to use ZipFile as a context manager.

    +
    +
    +

    Changed in version 3.3: Added support for bzip2 and lzma compression.

    +
    +
    +

    Changed in version 3.4: ZIP64 extensions are enabled by default.

    +
    +
    +

    Changed in version 3.5: Added support for writing to unseekable streams. +Added support for the 'x' mode.

    +
    +
    +

    Changed in version 3.6: Previously, a plain RuntimeError was raised for unrecognized +compression values.

    +
    +
    +

    Changed in version 3.6.2: The file parameter accepts a path-like object.

    +
    +
    +

    Changed in version 3.7: Add the compresslevel parameter.

    +
    +
    + +
    +
    +ZipFile.close()
    +

    Close the archive file. You must call close() before exiting your program +or essential records will not be written.

    +
    + +
    +
    +ZipFile.getinfo(name)
    +

    Return a ZipInfo object with information about the archive member +name. Calling getinfo() for a name not currently contained in the +archive will raise a KeyError.

    +
    + +
    +
    +ZipFile.infolist()
    +

    Return a list containing a ZipInfo object for each member of the +archive. The objects are in the same order as their entries in the actual ZIP +file on disk if an existing archive was opened.

    +
    + +
    +
    +ZipFile.namelist()
    +

    Return a list of archive members by name.

    +
    + +
    +
    +ZipFile.open(name, mode='r', pwd=None, *, force_zip64=False)
    +

    Access a member of the archive as a binary file-like object. name +can be either the name of a file within the archive or a ZipInfo +object. The mode parameter, if included, must be 'r' (the default) +or 'w'. pwd is the password used to decrypt encrypted ZIP files.

    +

    open() is also a context manager and therefore supports the +with statement:

    +
    with ZipFile('spam.zip') as myzip:
    +    with myzip.open('eggs.txt') as myfile:
    +        print(myfile.read())
    +
    +
    +

    With mode 'r' the file-like object +(ZipExtFile) is read-only and provides the following methods: +read(), readline(), +readlines(), seek(), +tell(), __iter__(), __next__(). +These objects can operate independently of the ZipFile.

    +

    With mode='w', a writable file handle is returned, which supports the +write() method. While a writable file handle is open, +attempting to read or write other files in the ZIP file will raise a +ValueError.

    +

    When writing a file, if the file size is not known in advance but may exceed +2 GiB, pass force_zip64=True to ensure that the header format is +capable of supporting large files. If the file size is known in advance, +construct a ZipInfo object with file_size set, and +use that as the name parameter.

    +
    +

    Note

    +

    The open(), read() and extract() methods can take a filename +or a ZipInfo object. You will appreciate this when trying to read a +ZIP file that contains members with duplicate names.

    +
    +
    +

    Changed in version 3.6: Removed support of mode='U'. Use io.TextIOWrapper for reading +compressed text files in universal newlines mode.

    +
    +
    +

    Changed in version 3.6: open() can now be used to write files into the archive with the +mode='w' option.

    +
    +
    +

    Changed in version 3.6: Calling open() on a closed ZipFile will raise a ValueError. +Previously, a RuntimeError was raised.

    +
    +
    + +
    +
    +ZipFile.extract(member, path=None, pwd=None)
    +

    Extract a member from the archive to the current working directory; member +must be its full name or a ZipInfo object. Its file information is +extracted as accurately as possible. path specifies a different directory +to extract to. member can be a filename or a ZipInfo object. +pwd is the password used for encrypted files.

    +

    Returns the normalized path created (a directory or new file).

    +
    +

    Note

    +

    If a member filename is an absolute path, a drive/UNC sharepoint and +leading (back)slashes will be stripped, e.g.: ///foo/bar becomes +foo/bar on Unix, and C:\foo\bar becomes foo\bar on Windows. +And all ".." components in a member filename will be removed, e.g.: +../../foo../../ba..r becomes foo../ba..r. On Windows illegal +characters (:, <, >, |, ", ?, and *) +replaced by underscore (_).

    +
    +
    +

    Changed in version 3.6: Calling extract() on a closed ZipFile will raise a +ValueError. Previously, a RuntimeError was raised.

    +
    +
    +

    Changed in version 3.6.2: The path parameter accepts a path-like object.

    +
    +
    + +
    +
    +ZipFile.extractall(path=None, members=None, pwd=None)
    +

    Extract all members from the archive to the current working directory. path +specifies a different directory to extract to. members is optional and must +be a subset of the list returned by namelist(). pwd is the password +used for encrypted files.

    +
    +

    Warning

    +

    Never extract archives from untrusted sources without prior inspection. +It is possible that files are created outside of path, e.g. members +that have absolute filenames starting with "/" or filenames with two +dots "..". This module attempts to prevent that. +See extract() note.

    +
    +
    +

    Changed in version 3.6: Calling extractall() on a closed ZipFile will raise a +ValueError. Previously, a RuntimeError was raised.

    +
    +
    +

    Changed in version 3.6.2: The path parameter accepts a path-like object.

    +
    +
    + +
    +
    +ZipFile.printdir()
    +

    Print a table of contents for the archive to sys.stdout.

    +
    + +
    +
    +ZipFile.setpassword(pwd)
    +

    Set pwd as default password to extract encrypted files.

    +
    + +
    +
    +ZipFile.read(name, pwd=None)
    +

    Return the bytes of the file name in the archive. name is the name of the +file in the archive, or a ZipInfo object. The archive must be open for +read or append. pwd is the password used for encrypted files and, if specified, +it will override the default password set with setpassword(). Calling +read() on a ZipFile that uses a compression method other than +ZIP_STORED, ZIP_DEFLATED, ZIP_BZIP2 or +ZIP_LZMA will raise a NotImplementedError. An error will also +be raised if the corresponding compression module is not available.

    +
    +

    Changed in version 3.6: Calling read() on a closed ZipFile will raise a ValueError. +Previously, a RuntimeError was raised.

    +
    +
    + +
    +
    +ZipFile.testzip()
    +

    Read all the files in the archive and check their CRC’s and file headers. +Return the name of the first bad file, or else return None.

    +
    +

    Changed in version 3.6: Calling testzip() on a closed ZipFile will raise a +ValueError. Previously, a RuntimeError was raised.

    +
    +
    + +
    +
    +ZipFile.write(filename, arcname=None, compress_type=None, compresslevel=None)
    +

    Write the file named filename to the archive, giving it the archive name +arcname (by default, this will be the same as filename, but without a drive +letter and with leading path separators removed). If given, compress_type +overrides the value given for the compression parameter to the constructor for +the new entry. Similarly, compresslevel will override the constructor if +given. +The archive must be open with mode 'w', 'x' or 'a'.

    +
    +

    Note

    +

    Archive names should be relative to the archive root, that is, they should not +start with a path separator.

    +
    +
    +

    Note

    +

    If arcname (or filename, if arcname is not given) contains a null +byte, the name of the file in the archive will be truncated at the null byte.

    +
    +
    +

    Changed in version 3.6: Calling write() on a ZipFile created with mode 'r' or +a closed ZipFile will raise a ValueError. Previously, +a RuntimeError was raised.

    +
    +
    + +
    +
    +ZipFile.writestr(zinfo_or_arcname, data, compress_type=None, compresslevel=None)
    +

    Write a file into the archive. The contents is data, which may be either +a str or a bytes instance; if it is a str, +it is encoded as UTF-8 first. zinfo_or_arcname is either the file +name it will be given in the archive, or a ZipInfo instance. If it’s +an instance, at least the filename, date, and time must be given. If it’s a +name, the date and time is set to the current date and time. +The archive must be opened with mode 'w', 'x' or 'a'.

    +

    If given, compress_type overrides the value given for the compression +parameter to the constructor for the new entry, or in the zinfo_or_arcname +(if that is a ZipInfo instance). Similarly, compresslevel will +override the constructor if given.

    +
    +

    Note

    +

    When passing a ZipInfo instance as the zinfo_or_arcname parameter, +the compression method used will be that specified in the compress_type +member of the given ZipInfo instance. By default, the +ZipInfo constructor sets this member to ZIP_STORED.

    +
    +
    +

    Changed in version 3.2: The compress_type argument.

    +
    +
    +

    Changed in version 3.6: Calling writestr() on a ZipFile created with mode 'r' or +a closed ZipFile will raise a ValueError. Previously, +a RuntimeError was raised.

    +
    +
    + +

    The following data attributes are also available:

    +
    +
    +ZipFile.filename
    +

    Name of the ZIP file.

    +
    + +
    +
    +ZipFile.debug
    +

    The level of debug output to use. This may be set from 0 (the default, no +output) to 3 (the most output). Debugging information is written to +sys.stdout.

    +
    + +
    +
    +ZipFile.comment
    +

    The comment associated with the ZIP file as a bytes object. +If assigning a comment to a +ZipFile instance created with mode 'w', 'x' or 'a', +it should be no longer than 65535 bytes. Comments longer than this will be +truncated.

    +
    + +
    +
    +

    PyZipFile Objects

    +

    The PyZipFile constructor takes the same parameters as the +ZipFile constructor, and one additional parameter, optimize.

    +
    +
    +class zipfile.PyZipFile(file, mode='r', compression=ZIP_STORED, allowZip64=True, optimize=-1)
    +
    +

    New in version 3.2: The optimize parameter.

    +
    +
    +

    Changed in version 3.4: ZIP64 extensions are enabled by default.

    +
    +

    Instances have one method in addition to those of ZipFile objects:

    +
    +
    +writepy(pathname, basename='', filterfunc=None)
    +

    Search for files *.py and add the corresponding file to the +archive.

    +

    If the optimize parameter to PyZipFile was not given or -1, +the corresponding file is a *.pyc file, compiling if necessary.

    +

    If the optimize parameter to PyZipFile was 0, 1 or +2, only files with that optimization level (see compile()) are +added to the archive, compiling if necessary.

    +

    If pathname is a file, the filename must end with .py, and +just the (corresponding *.pyc) file is added at the top level +(no path information). If pathname is a file that does not end with +.py, a RuntimeError will be raised. If it is a directory, +and the directory is not a package directory, then all the files +*.pyc are added at the top level. If the directory is a +package directory, then all *.pyc are added under the package +name as a file path, and if any subdirectories are package directories, +all of these are added recursively in sorted order.

    +

    basename is intended for internal use only.

    +

    filterfunc, if given, must be a function taking a single string +argument. It will be passed each path (including each individual full +file path) before it is added to the archive. If filterfunc returns a +false value, the path will not be added, and if it is a directory its +contents will be ignored. For example, if our test files are all either +in test directories or start with the string test_, we can use a +filterfunc to exclude them:

    +
    >>> zf = PyZipFile('myprog.zip')
    +>>> def notests(s):
    +...     fn = os.path.basename(s)
    +...     return (not (fn == 'test' or fn.startswith('test_')))
    +>>> zf.writepy('myprog', filterfunc=notests)
    +
    +
    +

    The writepy() method makes archives with file names like +this:

    +
    string.pyc                   # Top level name
    +test/__init__.pyc            # Package directory
    +test/testall.pyc             # Module test.testall
    +test/bogus/__init__.pyc      # Subpackage directory
    +test/bogus/myfile.pyc        # Submodule test.bogus.myfile
    +
    +
    +
    +

    New in version 3.4: The filterfunc parameter.

    +
    +
    +

    Changed in version 3.6.2: The pathname parameter accepts a path-like object.

    +
    +
    +

    Changed in version 3.7: Recursion sorts directory entries.

    +
    +
    + +
    + +
    +
    +

    ZipInfo Objects

    +

    Instances of the ZipInfo class are returned by the getinfo() and +infolist() methods of ZipFile objects. Each object stores +information about a single member of the ZIP archive.

    +

    There is one classmethod to make a ZipInfo instance for a filesystem +file:

    +
    +
    +classmethod ZipInfo.from_file(filename, arcname=None)
    +

    Construct a ZipInfo instance for a file on the filesystem, in +preparation for adding it to a zip file.

    +

    filename should be the path to a file or directory on the filesystem.

    +

    If arcname is specified, it is used as the name within the archive. +If arcname is not specified, the name will be the same as filename, but +with any drive letter and leading path separators removed.

    +
    +

    New in version 3.6.

    +
    +
    +

    Changed in version 3.6.2: The filename parameter accepts a path-like object.

    +
    +
    + +

    Instances have the following methods and attributes:

    +
    +
    +ZipInfo.is_dir()
    +

    Return True if this archive member is a directory.

    +

    This uses the entry’s name: directories should always end with /.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +ZipInfo.filename
    +

    Name of the file in the archive.

    +
    + +
    +
    +ZipInfo.date_time
    +

    The time and date of the last modification to the archive member. This is a +tuple of six values:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + +

    Index

    Value

    0

    Year (>= 1980)

    1

    Month (one-based)

    2

    Day of month (one-based)

    3

    Hours (zero-based)

    4

    Minutes (zero-based)

    5

    Seconds (zero-based)

    +
    +

    Note

    +

    The ZIP file format does not support timestamps before 1980.

    +
    +
    + +
    +
    +ZipInfo.compress_type
    +

    Type of compression for the archive member.

    +
    + +
    +
    +ZipInfo.comment
    +

    Comment for the individual archive member as a bytes object.

    +
    + +
    +
    +ZipInfo.extra
    +

    Expansion field data. The PKZIP Application Note contains +some comments on the internal structure of the data contained in this +bytes object.

    +
    + +
    +
    +ZipInfo.create_system
    +

    System which created ZIP archive.

    +
    + +
    +
    +ZipInfo.create_version
    +

    PKZIP version which created ZIP archive.

    +
    + +
    +
    +ZipInfo.extract_version
    +

    PKZIP version needed to extract archive.

    +
    + +
    +
    +ZipInfo.reserved
    +

    Must be zero.

    +
    + +
    +
    +ZipInfo.flag_bits
    +

    ZIP flag bits.

    +
    + +
    +
    +ZipInfo.volume
    +

    Volume number of file header.

    +
    + +
    +
    +ZipInfo.internal_attr
    +

    Internal attributes.

    +
    + +
    +
    +ZipInfo.external_attr
    +

    External file attributes.

    +
    + +
    +
    +ZipInfo.header_offset
    +

    Byte offset to the file header.

    +
    + +
    +
    +ZipInfo.CRC
    +

    CRC-32 of the uncompressed file.

    +
    + +
    +
    +ZipInfo.compress_size
    +

    Size of the compressed data.

    +
    + +
    +
    +ZipInfo.file_size
    +

    Size of the uncompressed file.

    +
    + +
    +
    +

    Command-Line Interface

    +

    The zipfile module provides a simple command-line interface to interact +with ZIP archives.

    +

    If you want to create a new ZIP archive, specify its name after the -c +option and then list the filename(s) that should be included:

    +
    $ python -m zipfile -c monty.zip spam.txt eggs.txt
    +
    +
    +

    Passing a directory is also acceptable:

    +
    $ python -m zipfile -c monty.zip life-of-brian_1979/
    +
    +
    +

    If you want to extract a ZIP archive into the specified directory, use +the -e option:

    +
    $ python -m zipfile -e monty.zip target-dir/
    +
    +
    +

    For a list of the files in a ZIP archive, use the -l option:

    +
    $ python -m zipfile -l monty.zip
    +
    +
    +
    +

    Command-line options

    +
    +
    +-l <zipfile>
    +
    +--list <zipfile>
    +

    List files in a zipfile.

    +
    + +
    +
    +-c <zipfile> <source1> ... <sourceN>
    +
    +--create <zipfile> <source1> ... <sourceN>
    +

    Create zipfile from source files.

    +
    + +
    +
    +-e <zipfile> <output_dir>
    +
    +--extract <zipfile> <output_dir>
    +

    Extract zipfile into target directory.

    +
    + +
    +
    +-t <zipfile>
    +
    +--test <zipfile>
    +

    Test whether the zipfile is valid or not.

    +
    + +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/zipimport.html b/python-3.7.4-docs-html/library/zipimport.html new file mode 100644 index 0000000..7891203 --- /dev/null +++ b/python-3.7.4-docs-html/library/zipimport.html @@ -0,0 +1,349 @@ + + + + + + + zipimport — Import modules from Zip archives — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    zipimport — Import modules from Zip archives

    +
    +

    This module adds the ability to import Python modules (*.py, +*.pyc) and packages from ZIP-format archives. It is usually not +needed to use the zipimport module explicitly; it is automatically used +by the built-in import mechanism for sys.path items that are paths +to ZIP archives.

    +

    Typically, sys.path is a list of directory names as strings. This module +also allows an item of sys.path to be a string naming a ZIP file archive. +The ZIP archive can contain a subdirectory structure to support package imports, +and a path within the archive can be specified to only import from a +subdirectory. For example, the path example.zip/lib/ would only +import from the lib/ subdirectory within the archive.

    +

    Any files may be present in the ZIP archive, but only files .py and +.pyc are available for import. ZIP import of dynamic modules +(.pyd, .so) is disallowed. Note that if an archive only contains +.py files, Python will not attempt to modify the archive by adding the +corresponding .pyc file, meaning that if a ZIP archive +doesn’t contain .pyc files, importing may be rather slow.

    +

    ZIP archives with an archive comment are currently not supported.

    +
    +

    See also

    +
    +
    PKZIP Application Note

    Documentation on the ZIP file format by Phil Katz, the creator of the format and +algorithms used.

    +
    +
    PEP 273 - Import Modules from Zip Archives

    Written by James C. Ahlstrom, who also provided an implementation. Python 2.3 +follows the specification in PEP 273, but uses an implementation written by Just +van Rossum that uses the import hooks described in PEP 302.

    +
    +
    PEP 302 - New Import Hooks

    The PEP to add the import hooks that help this module work.

    +
    +
    +
    +

    This module defines an exception:

    +
    +
    +exception zipimport.ZipImportError
    +

    Exception raised by zipimporter objects. It’s a subclass of ImportError, +so it can be caught as ImportError, too.

    +
    + +
    +

    zipimporter Objects

    +

    zipimporter is the class for importing ZIP files.

    +
    +
    +class zipimport.zipimporter(archivepath)
    +

    Create a new zipimporter instance. archivepath must be a path to a ZIP +file, or to a specific path within a ZIP file. For example, an archivepath +of foo/bar.zip/lib will look for modules in the lib directory +inside the ZIP file foo/bar.zip (provided that it exists).

    +

    ZipImportError is raised if archivepath doesn’t point to a valid ZIP +archive.

    +
    +
    +find_module(fullname[, path])
    +

    Search for a module specified by fullname. fullname must be the fully +qualified (dotted) module name. It returns the zipimporter instance itself +if the module was found, or None if it wasn’t. The optional +path argument is ignored—it’s there for compatibility with the +importer protocol.

    +
    + +
    +
    +get_code(fullname)
    +

    Return the code object for the specified module. Raise +ZipImportError if the module couldn’t be found.

    +
    + +
    +
    +get_data(pathname)
    +

    Return the data associated with pathname. Raise OSError if the +file wasn’t found.

    +
    +

    Changed in version 3.3: IOError used to be raised instead of OSError.

    +
    +
    + +
    +
    +get_filename(fullname)
    +

    Return the value __file__ would be set to if the specified module +was imported. Raise ZipImportError if the module couldn’t be +found.

    +
    +

    New in version 3.1.

    +
    +
    + +
    +
    +get_source(fullname)
    +

    Return the source code for the specified module. Raise +ZipImportError if the module couldn’t be found, return +None if the archive does contain the module, but has no source +for it.

    +
    + +
    +
    +is_package(fullname)
    +

    Return True if the module specified by fullname is a package. Raise +ZipImportError if the module couldn’t be found.

    +
    + +
    +
    +load_module(fullname)
    +

    Load the module specified by fullname. fullname must be the fully +qualified (dotted) module name. It returns the imported module, or raises +ZipImportError if it wasn’t found.

    +
    + +
    +
    +archive
    +

    The file name of the importer’s associated ZIP file, without a possible +subpath.

    +
    + +
    +
    +prefix
    +

    The subpath within the ZIP file where modules are searched. This is the +empty string for zipimporter objects which point to the root of the ZIP +file.

    +
    + +

    The archive and prefix attributes, when combined with a +slash, equal the original archivepath argument given to the +zipimporter constructor.

    +
    + +
    +
    +

    Examples

    +

    Here is an example that imports a module from a ZIP archive - note that the +zipimport module is not explicitly used.

    +
    $ unzip -l example.zip
    +Archive:  example.zip
    +  Length     Date   Time    Name
    + --------    ----   ----    ----
    +     8467  11-26-02 22:30   jwzthreading.py
    + --------                   -------
    +     8467                   1 file
    +$ ./python
    +Python 2.3 (#1, Aug 1 2003, 19:54:32)
    +>>> import sys
    +>>> sys.path.insert(0, 'example.zip')  # Add .zip file to front of path
    +>>> import jwzthreading
    +>>> jwzthreading.__file__
    +'example.zip/jwzthreading.py'
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/library/zlib.html b/python-3.7.4-docs-html/library/zlib.html new file mode 100644 index 0000000..5c54114 --- /dev/null +++ b/python-3.7.4-docs-html/library/zlib.html @@ -0,0 +1,491 @@ + + + + + + + zlib — Compression compatible with gzip — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    zlib — Compression compatible with gzip

    +
    +

    For applications that require data compression, the functions in this module +allow compression and decompression, using the zlib library. The zlib library +has its own home page at http://www.zlib.net. There are known +incompatibilities between the Python module and versions of the zlib library +earlier than 1.1.3; 1.1.3 has a security vulnerability, so we recommend using +1.1.4 or later.

    +

    zlib’s functions have many options and often need to be used in a particular +order. This documentation doesn’t attempt to cover all of the permutations; +consult the zlib manual at http://www.zlib.net/manual.html for authoritative +information.

    +

    For reading and writing .gz files see the gzip module.

    +

    The available exception and functions in this module are:

    +
    +
    +exception zlib.error
    +

    Exception raised on compression and decompression errors.

    +
    + +
    +
    +zlib.adler32(data[, value])
    +

    Computes an Adler-32 checksum of data. (An Adler-32 checksum is almost as +reliable as a CRC32 but can be computed much more quickly.) The result +is an unsigned 32-bit integer. If value is present, it is used as +the starting value of the checksum; otherwise, a default value of 1 +is used. Passing in value allows computing a running checksum over the +concatenation of several inputs. The algorithm is not cryptographically +strong, and should not be used for authentication or digital signatures. Since +the algorithm is designed for use as a checksum algorithm, it is not suitable +for use as a general hash algorithm.

    +
    +

    Changed in version 3.0: Always returns an unsigned value. +To generate the same numeric value across all Python versions and +platforms, use adler32(data) & 0xffffffff.

    +
    +
    + +
    +
    +zlib.compress(data, level=-1)
    +

    Compresses the bytes in data, returning a bytes object containing compressed data. +level is an integer from 0 to 9 or -1 controlling the level of compression; +1 (Z_BEST_SPEED) is fastest and produces the least compression, 9 (Z_BEST_COMPRESSION) +is slowest and produces the most. 0 (Z_NO_COMPRESSION) is no compression. +The default value is -1 (Z_DEFAULT_COMPRESSION). Z_DEFAULT_COMPRESSION represents a default +compromise between speed and compression (currently equivalent to level 6). +Raises the error exception if any error occurs.

    +
    +

    Changed in version 3.6: level can now be used as a keyword parameter.

    +
    +
    + +
    +
    +zlib.compressobj(level=-1, method=DEFLATED, wbits=MAX_WBITS, memLevel=DEF_MEM_LEVEL, strategy=Z_DEFAULT_STRATEGY[, zdict])
    +

    Returns a compression object, to be used for compressing data streams that won’t +fit into memory at once.

    +

    level is the compression level – an integer from 0 to 9 or -1. +A value of 1 (Z_BEST_SPEED) is fastest and produces the least compression, +while a value of 9 (Z_BEST_COMPRESSION) is slowest and produces the most. +0 (Z_NO_COMPRESSION) is no compression. The default value is -1 (Z_DEFAULT_COMPRESSION). +Z_DEFAULT_COMPRESSION represents a default compromise between speed and compression +(currently equivalent to level 6).

    +

    method is the compression algorithm. Currently, the only supported value is +DEFLATED.

    +

    The wbits argument controls the size of the history buffer (or the +“window size”) used when compressing data, and whether a header and +trailer is included in the output. It can take several ranges of values, +defaulting to 15 (MAX_WBITS):

    +
      +
    • +9 to +15: The base-two logarithm of the window size, which +therefore ranges between 512 and 32768. Larger values produce +better compression at the expense of greater memory usage. The +resulting output will include a zlib-specific header and trailer.

    • +
    • −9 to −15: Uses the absolute value of wbits as the +window size logarithm, while producing a raw output stream with no +header or trailing checksum.

    • +
    • +25 to +31 = 16 + (9 to 15): Uses the low 4 bits of the value as the +window size logarithm, while including a basic gzip header +and trailing checksum in the output.

    • +
    +

    The memLevel argument controls the amount of memory used for the +internal compression state. Valid values range from 1 to 9. +Higher values use more memory, but are faster and produce smaller output.

    +

    strategy is used to tune the compression algorithm. Possible values are +Z_DEFAULT_STRATEGY, Z_FILTERED, Z_HUFFMAN_ONLY, +Z_RLE (zlib 1.2.0.1) and Z_FIXED (zlib 1.2.2.2).

    +

    zdict is a predefined compression dictionary. This is a sequence of bytes +(such as a bytes object) containing subsequences that are expected +to occur frequently in the data that is to be compressed. Those subsequences +that are expected to be most common should come at the end of the dictionary.

    +
    +

    Changed in version 3.3: Added the zdict parameter and keyword argument support.

    +
    +
    + +
    +
    +zlib.crc32(data[, value])
    +

    Computes a CRC (Cyclic Redundancy Check) checksum of data. The +result is an unsigned 32-bit integer. If value is present, it is used +as the starting value of the checksum; otherwise, a default value of 0 +is used. Passing in value allows computing a running checksum over the +concatenation of several inputs. The algorithm is not cryptographically +strong, and should not be used for authentication or digital signatures. Since +the algorithm is designed for use as a checksum algorithm, it is not suitable +for use as a general hash algorithm.

    +
    +

    Changed in version 3.0: Always returns an unsigned value. +To generate the same numeric value across all Python versions and +platforms, use crc32(data) & 0xffffffff.

    +
    +
    + +
    +
    +zlib.decompress(data, wbits=MAX_WBITS, bufsize=DEF_BUF_SIZE)
    +

    Decompresses the bytes in data, returning a bytes object containing the +uncompressed data. The wbits parameter depends on +the format of data, and is discussed further below. +If bufsize is given, it is used as the initial size of the output +buffer. Raises the error exception if any error occurs.

    +

    The wbits parameter controls the size of the history buffer +(or “window size”), and what header and trailer format is expected. +It is similar to the parameter for compressobj(), but accepts +more ranges of values:

    +
      +
    • +8 to +15: The base-two logarithm of the window size. The input +must include a zlib header and trailer.

    • +
    • 0: Automatically determine the window size from the zlib header. +Only supported since zlib 1.2.3.5.

    • +
    • −8 to −15: Uses the absolute value of wbits as the window size +logarithm. The input must be a raw stream with no header or trailer.

    • +
    • +24 to +31 = 16 + (8 to 15): Uses the low 4 bits of the value as +the window size logarithm. The input must include a gzip header and +trailer.

    • +
    • +40 to +47 = 32 + (8 to 15): Uses the low 4 bits of the value as +the window size logarithm, and automatically accepts either +the zlib or gzip format.

    • +
    +

    When decompressing a stream, the window size must not be smaller +than the size originally used to compress the stream; using a too-small +value may result in an error exception. The default wbits value +corresponds to the largest window size and requires a zlib header and +trailer to be included.

    +

    bufsize is the initial size of the buffer used to hold decompressed data. If +more space is required, the buffer size will be increased as needed, so you +don’t have to get this value exactly right; tuning it will only save a few calls +to malloc().

    +
    +

    Changed in version 3.6: wbits and bufsize can be used as keyword arguments.

    +
    +
    + +
    +
    +zlib.decompressobj(wbits=MAX_WBITS[, zdict])
    +

    Returns a decompression object, to be used for decompressing data streams that +won’t fit into memory at once.

    +

    The wbits parameter controls the size of the history buffer (or the +“window size”), and what header and trailer format is expected. It has +the same meaning as described for decompress().

    +

    The zdict parameter specifies a predefined compression dictionary. If +provided, this must be the same dictionary as was used by the compressor that +produced the data that is to be decompressed.

    +
    +

    Note

    +

    If zdict is a mutable object (such as a bytearray), you must not +modify its contents between the call to decompressobj() and the first +call to the decompressor’s decompress() method.

    +
    +
    +

    Changed in version 3.3: Added the zdict parameter.

    +
    +
    + +

    Compression objects support the following methods:

    +
    +
    +Compress.compress(data)
    +

    Compress data, returning a bytes object containing compressed data for at least +part of the data in data. This data should be concatenated to the output +produced by any preceding calls to the compress() method. Some input may +be kept in internal buffers for later processing.

    +
    + +
    +
    +Compress.flush([mode])
    +

    All pending input is processed, and a bytes object containing the remaining compressed +output is returned. mode can be selected from the constants +Z_NO_FLUSH, Z_PARTIAL_FLUSH, Z_SYNC_FLUSH, +Z_FULL_FLUSH, Z_BLOCK (zlib 1.2.3.4), or Z_FINISH, +defaulting to Z_FINISH. Except Z_FINISH, all constants +allow compressing further bytestrings of data, while Z_FINISH finishes the +compressed stream and prevents compressing any more data. After calling flush() +with mode set to Z_FINISH, the compress() method cannot be called again; +the only realistic action is to delete the object.

    +
    + +
    +
    +Compress.copy()
    +

    Returns a copy of the compression object. This can be used to efficiently +compress a set of data that share a common initial prefix.

    +
    + +

    Decompression objects support the following methods and attributes:

    +
    +
    +Decompress.unused_data
    +

    A bytes object which contains any bytes past the end of the compressed data. That is, +this remains b"" until the last byte that contains compression data is +available. If the whole bytestring turned out to contain compressed data, this is +b"", an empty bytes object.

    +
    + +
    +
    +Decompress.unconsumed_tail
    +

    A bytes object that contains any data that was not consumed by the last +decompress() call because it exceeded the limit for the uncompressed data +buffer. This data has not yet been seen by the zlib machinery, so you must feed +it (possibly with further data concatenated to it) back to a subsequent +decompress() method call in order to get correct output.

    +
    + +
    +
    +Decompress.eof
    +

    A boolean indicating whether the end of the compressed data stream has been +reached.

    +

    This makes it possible to distinguish between a properly-formed compressed +stream, and an incomplete or truncated one.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +Decompress.decompress(data, max_length=0)
    +

    Decompress data, returning a bytes object containing the uncompressed data +corresponding to at least part of the data in string. This data should be +concatenated to the output produced by any preceding calls to the +decompress() method. Some of the input data may be preserved in internal +buffers for later processing.

    +

    If the optional parameter max_length is non-zero then the return value will be +no longer than max_length. This may mean that not all of the compressed input +can be processed; and unconsumed data will be stored in the attribute +unconsumed_tail. This bytestring must be passed to a subsequent call to +decompress() if decompression is to continue. If max_length is zero +then the whole input is decompressed, and unconsumed_tail is empty.

    +
    +

    Changed in version 3.6: max_length can be used as a keyword argument.

    +
    +
    + +
    +
    +Decompress.flush([length])
    +

    All pending input is processed, and a bytes object containing the remaining +uncompressed output is returned. After calling flush(), the +decompress() method cannot be called again; the only realistic action is +to delete the object.

    +

    The optional parameter length sets the initial size of the output buffer.

    +
    + +
    +
    +Decompress.copy()
    +

    Returns a copy of the decompression object. This can be used to save the state +of the decompressor midway through the data stream in order to speed up random +seeks into the stream at a future point.

    +
    + +

    Information about the version of the zlib library in use is available through +the following constants:

    +
    +
    +zlib.ZLIB_VERSION
    +

    The version string of the zlib library that was used for building the module. +This may be different from the zlib library actually used at runtime, which +is available as ZLIB_RUNTIME_VERSION.

    +
    + +
    +
    +zlib.ZLIB_RUNTIME_VERSION
    +

    The version string of the zlib library actually loaded by the interpreter.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +

    See also

    +
    +
    Module gzip

    Reading and writing gzip-format files.

    +
    +
    http://www.zlib.net

    The zlib library home page.

    +
    +
    http://www.zlib.net/manual.html

    The zlib manual explains the semantics and usage of the library’s many +functions.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/license.html b/python-3.7.4-docs-html/license.html new file mode 100644 index 0000000..038f9d6 --- /dev/null +++ b/python-3.7.4-docs-html/license.html @@ -0,0 +1,1144 @@ + + + + + + + History and License — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    History and License

    +
    +

    History of the software

    +

    Python was created in the early 1990s by Guido van Rossum at Stichting +Mathematisch Centrum (CWI, see https://www.cwi.nl/) in the Netherlands as a +successor of a language called ABC. Guido remains Python’s principal author, +although it includes many contributions from others.

    +

    In 1995, Guido continued his work on Python at the Corporation for National +Research Initiatives (CNRI, see https://www.cnri.reston.va.us/) in Reston, +Virginia where he released several versions of the software.

    +

    In May 2000, Guido and the Python core development team moved to BeOpen.com to +form the BeOpen PythonLabs team. In October of the same year, the PythonLabs +team moved to Digital Creations (now Zope Corporation; see +http://www.zope.com/). In 2001, the Python Software Foundation (PSF, see +https://www.python.org/psf/) was formed, a non-profit organization created +specifically to own Python-related Intellectual Property. Zope Corporation is a +sponsoring member of the PSF.

    +

    All Python releases are Open Source (see https://opensource.org/ for the Open +Source Definition). Historically, most, but not all, Python releases have also +been GPL-compatible; the table below summarizes the various releases.

    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Release

    Derived from

    Year

    Owner

    GPL compatible?

    0.9.0 thru 1.2

    n/a

    1991-1995

    CWI

    yes

    1.3 thru 1.5.2

    1.2

    1995-1999

    CNRI

    yes

    1.6

    1.5.2

    2000

    CNRI

    no

    2.0

    1.6

    2000

    BeOpen.com

    no

    1.6.1

    1.6

    2001

    CNRI

    no

    2.1

    2.0+1.6.1

    2001

    PSF

    no

    2.0.1

    2.0+1.6.1

    2001

    PSF

    yes

    2.1.1

    2.1+2.0.1

    2001

    PSF

    yes

    2.1.2

    2.1.1

    2002

    PSF

    yes

    2.1.3

    2.1.2

    2002

    PSF

    yes

    2.2 and above

    2.1.1

    2001-now

    PSF

    yes

    +
    +

    Note

    +

    GPL-compatible doesn’t mean that we’re distributing Python under the GPL. All +Python licenses, unlike the GPL, let you distribute a modified version without +making your changes open source. The GPL-compatible licenses make it possible to +combine Python with other software that is released under the GPL; the others +don’t.

    +
    +

    Thanks to the many outside volunteers who have worked under Guido’s direction to +make these releases possible.

    +
    +
    +

    Terms and conditions for accessing or otherwise using Python

    +
    +

    PSF LICENSE AGREEMENT FOR PYTHON 3.7.4

    +
    1. This LICENSE AGREEMENT is between the Python Software Foundation ("PSF"), and
    +   the Individual or Organization ("Licensee") accessing and otherwise using Python
    +   3.7.4 software in source or binary form and its associated documentation.
    +
    +2. Subject to the terms and conditions of this License Agreement, PSF hereby
    +   grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
    +   analyze, test, perform and/or display publicly, prepare derivative works,
    +   distribute, and otherwise use Python 3.7.4 alone or in any derivative
    +   version, provided, however, that PSF's License Agreement and PSF's notice of
    +   copyright, i.e., "Copyright © 2001-2019 Python Software Foundation; All Rights
    +   Reserved" are retained in Python 3.7.4 alone or in any derivative version
    +   prepared by Licensee.
    +
    +3. In the event Licensee prepares a derivative work that is based on or
    +   incorporates Python 3.7.4 or any part thereof, and wants to make the
    +   derivative work available to others as provided herein, then Licensee hereby
    +   agrees to include in any such work a brief summary of the changes made to Python
    +   3.7.4.
    +
    +4. PSF is making Python 3.7.4 available to Licensee on an "AS IS" basis.
    +   PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED.  BY WAY OF
    +   EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND DISCLAIMS ANY REPRESENTATION OR
    +   WARRANTY OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE
    +   USE OF PYTHON 3.7.4 WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.
    +
    +5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON 3.7.4
    +   FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF
    +   MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 3.7.4, OR ANY DERIVATIVE
    +   THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
    +
    +6. This License Agreement will automatically terminate upon a material breach of
    +   its terms and conditions.
    +
    +7. Nothing in this License Agreement shall be deemed to create any relationship
    +   of agency, partnership, or joint venture between PSF and Licensee.  This License
    +   Agreement does not grant permission to use PSF trademarks or trade name in a
    +   trademark sense to endorse or promote products or services of Licensee, or any
    +   third party.
    +
    +8. By copying, installing or otherwise using Python 3.7.4, Licensee agrees
    +   to be bound by the terms and conditions of this License Agreement.
    +
    +
    +

    BEOPEN.COM LICENSE AGREEMENT FOR PYTHON 2.0

    +

    BEOPEN PYTHON OPEN SOURCE LICENSE AGREEMENT VERSION 1

    +
    1. This LICENSE AGREEMENT is between BeOpen.com ("BeOpen"), having an office at
    +   160 Saratoga Avenue, Santa Clara, CA 95051, and the Individual or Organization
    +   ("Licensee") accessing and otherwise using this software in source or binary
    +   form and its associated documentation ("the Software").
    +
    +2. Subject to the terms and conditions of this BeOpen Python License Agreement,
    +   BeOpen hereby grants Licensee a non-exclusive, royalty-free, world-wide license
    +   to reproduce, analyze, test, perform and/or display publicly, prepare derivative
    +   works, distribute, and otherwise use the Software alone or in any derivative
    +   version, provided, however, that the BeOpen Python License is retained in the
    +   Software, alone or in any derivative version prepared by Licensee.
    +
    +3. BeOpen is making the Software available to Licensee on an "AS IS" basis.
    +   BEOPEN MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED.  BY WAY OF
    +   EXAMPLE, BUT NOT LIMITATION, BEOPEN MAKES NO AND DISCLAIMS ANY REPRESENTATION OR
    +   WARRANTY OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE
    +   USE OF THE SOFTWARE WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.
    +
    +4. BEOPEN SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF THE SOFTWARE FOR
    +   ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF USING,
    +   MODIFYING OR DISTRIBUTING THE SOFTWARE, OR ANY DERIVATIVE THEREOF, EVEN IF
    +   ADVISED OF THE POSSIBILITY THEREOF.
    +
    +5. This License Agreement will automatically terminate upon a material breach of
    +   its terms and conditions.
    +
    +6. This License Agreement shall be governed by and interpreted in all respects
    +   by the law of the State of California, excluding conflict of law provisions.
    +   Nothing in this License Agreement shall be deemed to create any relationship of
    +   agency, partnership, or joint venture between BeOpen and Licensee.  This License
    +   Agreement does not grant permission to use BeOpen trademarks or trade names in a
    +   trademark sense to endorse or promote products or services of Licensee, or any
    +   third party.  As an exception, the "BeOpen Python" logos available at
    +   http://www.pythonlabs.com/logos.html may be used according to the permissions
    +   granted on that web page.
    +
    +7. By copying, installing or otherwise using the software, Licensee agrees to be
    +   bound by the terms and conditions of this License Agreement.
    +
    +
    +
    +
    +

    CNRI LICENSE AGREEMENT FOR PYTHON 1.6.1

    +
    1. This LICENSE AGREEMENT is between the Corporation for National Research
    +   Initiatives, having an office at 1895 Preston White Drive, Reston, VA 20191
    +   ("CNRI"), and the Individual or Organization ("Licensee") accessing and
    +   otherwise using Python 1.6.1 software in source or binary form and its
    +   associated documentation.
    +
    +2. Subject to the terms and conditions of this License Agreement, CNRI hereby
    +   grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
    +   analyze, test, perform and/or display publicly, prepare derivative works,
    +   distribute, and otherwise use Python 1.6.1 alone or in any derivative version,
    +   provided, however, that CNRI's License Agreement and CNRI's notice of copyright,
    +   i.e., "Copyright © 1995-2001 Corporation for National Research Initiatives; All
    +   Rights Reserved" are retained in Python 1.6.1 alone or in any derivative version
    +   prepared by Licensee.  Alternately, in lieu of CNRI's License Agreement,
    +   Licensee may substitute the following text (omitting the quotes): "Python 1.6.1
    +   is made available subject to the terms and conditions in CNRI's License
    +   Agreement.  This Agreement together with Python 1.6.1 may be located on the
    +   Internet using the following unique, persistent identifier (known as a handle):
    +   1895.22/1013.  This Agreement may also be obtained from a proxy server on the
    +   Internet using the following URL: http://hdl.handle.net/1895.22/1013."
    +
    +3. In the event Licensee prepares a derivative work that is based on or
    +   incorporates Python 1.6.1 or any part thereof, and wants to make the derivative
    +   work available to others as provided herein, then Licensee hereby agrees to
    +   include in any such work a brief summary of the changes made to Python 1.6.1.
    +
    +4. CNRI is making Python 1.6.1 available to Licensee on an "AS IS" basis.  CNRI
    +   MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED.  BY WAY OF EXAMPLE,
    +   BUT NOT LIMITATION, CNRI MAKES NO AND DISCLAIMS ANY REPRESENTATION OR WARRANTY
    +   OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF
    +   PYTHON 1.6.1 WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.
    +
    +5. CNRI SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON 1.6.1 FOR
    +   ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF
    +   MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 1.6.1, OR ANY DERIVATIVE
    +   THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
    +
    +6. This License Agreement will automatically terminate upon a material breach of
    +   its terms and conditions.
    +
    +7. This License Agreement shall be governed by the federal intellectual property
    +   law of the United States, including without limitation the federal copyright
    +   law, and, to the extent such U.S. federal law does not apply, by the law of the
    +   Commonwealth of Virginia, excluding Virginia's conflict of law provisions.
    +   Notwithstanding the foregoing, with regard to derivative works based on Python
    +   1.6.1 that incorporate non-separable material that was previously distributed
    +   under the GNU General Public License (GPL), the law of the Commonwealth of
    +   Virginia shall govern this License Agreement only as to issues arising under or
    +   with respect to Paragraphs 4, 5, and 7 of this License Agreement.  Nothing in
    +   this License Agreement shall be deemed to create any relationship of agency,
    +   partnership, or joint venture between CNRI and Licensee.  This License Agreement
    +   does not grant permission to use CNRI trademarks or trade name in a trademark
    +   sense to endorse or promote products or services of Licensee, or any third
    +   party.
    +
    +8. By clicking on the "ACCEPT" button where indicated, or by copying, installing
    +   or otherwise using Python 1.6.1, Licensee agrees to be bound by the terms and
    +   conditions of this License Agreement.
    +
    +
    +
    +
    +

    CWI LICENSE AGREEMENT FOR PYTHON 0.9.0 THROUGH 1.2

    +
    Copyright © 1991 - 1995, Stichting Mathematisch Centrum Amsterdam, The
    +Netherlands.  All rights reserved.
    +
    +Permission to use, copy, modify, and distribute this software and its
    +documentation for any purpose and without fee is hereby granted, provided that
    +the above copyright notice appear in all copies and that both that copyright
    +notice and this permission notice appear in supporting documentation, and that
    +the name of Stichting Mathematisch Centrum or CWI not be used in advertising or
    +publicity pertaining to distribution of the software without specific, written
    +prior permission.
    +
    +STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
    +SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
    +EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE FOR ANY SPECIAL, INDIRECT
    +OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
    +DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
    +ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
    +SOFTWARE.
    +
    +
    +
    +
    +
    +

    Licenses and Acknowledgements for Incorporated Software

    +

    This section is an incomplete, but growing list of licenses and acknowledgements +for third-party software incorporated in the Python distribution.

    +
    +

    Mersenne Twister

    +

    The _random module includes code based on a download from +http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/emt19937ar.html. The following are +the verbatim comments from the original code:

    +
    A C-program for MT19937, with initialization improved 2002/1/26.
    +Coded by Takuji Nishimura and Makoto Matsumoto.
    +
    +Before using, initialize the state by using init_genrand(seed)
    +or init_by_array(init_key, key_length).
    +
    +Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
    +All rights reserved.
    +
    +Redistribution and use in source and binary forms, with or without
    +modification, are permitted provided that the following conditions
    +are met:
    +
    + 1. Redistributions of source code must retain the above copyright
    +    notice, this list of conditions and the following disclaimer.
    +
    + 2. Redistributions in binary form must reproduce the above copyright
    +    notice, this list of conditions and the following disclaimer in the
    +    documentation and/or other materials provided with the distribution.
    +
    + 3. The names of its contributors may not be used to endorse or promote
    +    products derived from this software without specific prior written
    +    permission.
    +
    +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    +A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
    +CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
    +EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
    +PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
    +PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
    +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
    +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    +
    +
    +Any feedback is very welcome.
    +http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html
    +email: m-mat @ math.sci.hiroshima-u.ac.jp (remove space)
    +
    +
    +
    +
    +

    Sockets

    +

    The socket module uses the functions, getaddrinfo(), and +getnameinfo(), which are coded in separate source files from the WIDE +Project, http://www.wide.ad.jp/.

    +
    Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
    +All rights reserved.
    +
    +Redistribution and use in source and binary forms, with or without
    +modification, are permitted provided that the following conditions
    +are met:
    +1. Redistributions of source code must retain the above copyright
    +   notice, this list of conditions and the following disclaimer.
    +2. Redistributions in binary form must reproduce the above copyright
    +   notice, this list of conditions and the following disclaimer in the
    +   documentation and/or other materials provided with the distribution.
    +3. Neither the name of the project nor the names of its contributors
    +   may be used to endorse or promote products derived from this software
    +   without specific prior written permission.
    +
    +THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
    +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    +ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
    +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    +OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    +OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    +SUCH DAMAGE.
    +
    +
    +
    +
    +

    Asynchronous socket services

    +

    The asynchat and asyncore modules contain the following notice:

    +
    Copyright 1996 by Sam Rushing
    +
    +                        All Rights Reserved
    +
    +Permission to use, copy, modify, and distribute this software and
    +its documentation for any purpose and without fee is hereby
    +granted, provided that the above copyright notice appear in all
    +copies and that both that copyright notice and this permission
    +notice appear in supporting documentation, and that the name of Sam
    +Rushing not be used in advertising or publicity pertaining to
    +distribution of the software without specific, written prior
    +permission.
    +
    +SAM RUSHING DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
    +INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
    +NO EVENT SHALL SAM RUSHING BE LIABLE FOR ANY SPECIAL, INDIRECT OR
    +CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
    +OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
    +NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
    +CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
    +
    +
    +
    + +
    +

    Execution tracing

    +

    The trace module contains the following notice:

    +
    portions copyright 2001, Autonomous Zones Industries, Inc., all rights...
    +err...  reserved and offered to the public under the terms of the
    +Python 2.2 license.
    +Author: Zooko O'Whielacronx
    +http://zooko.com/
    +mailto:zooko@zooko.com
    +
    +Copyright 2000, Mojam Media, Inc., all rights reserved.
    +Author: Skip Montanaro
    +
    +Copyright 1999, Bioreason, Inc., all rights reserved.
    +Author: Andrew Dalke
    +
    +Copyright 1995-1997, Automatrix, Inc., all rights reserved.
    +Author: Skip Montanaro
    +
    +Copyright 1991-1995, Stichting Mathematisch Centrum, all rights reserved.
    +
    +
    +Permission to use, copy, modify, and distribute this Python software and
    +its associated documentation for any purpose without fee is hereby
    +granted, provided that the above copyright notice appears in all copies,
    +and that both that copyright notice and this permission notice appear in
    +supporting documentation, and that the name of neither Automatrix,
    +Bioreason or Mojam Media be used in advertising or publicity pertaining to
    +distribution of the software without specific, written prior permission.
    +
    +
    +
    +
    +

    UUencode and UUdecode functions

    +

    The uu module contains the following notice:

    +
    Copyright 1994 by Lance Ellinghouse
    +Cathedral City, California Republic, United States of America.
    +                       All Rights Reserved
    +Permission to use, copy, modify, and distribute this software and its
    +documentation for any purpose and without fee is hereby granted,
    +provided that the above copyright notice appear in all copies and that
    +both that copyright notice and this permission notice appear in
    +supporting documentation, and that the name of Lance Ellinghouse
    +not be used in advertising or publicity pertaining to distribution
    +of the software without specific, written prior permission.
    +LANCE ELLINGHOUSE DISCLAIMS ALL WARRANTIES WITH REGARD TO
    +THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
    +FITNESS, IN NO EVENT SHALL LANCE ELLINGHOUSE CENTRUM BE LIABLE
    +FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
    +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
    +OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
    +
    +Modified by Jack Jansen, CWI, July 1995:
    +- Use binascii module to do the actual line-by-line conversion
    +  between ascii and binary. This results in a 1000-fold speedup. The C
    +  version is still 5 times faster, though.
    +- Arguments more compliant with Python standard
    +
    +
    +
    +
    +

    XML Remote Procedure Calls

    +

    The xmlrpc.client module contains the following notice:

    +
        The XML-RPC client interface is
    +
    +Copyright (c) 1999-2002 by Secret Labs AB
    +Copyright (c) 1999-2002 by Fredrik Lundh
    +
    +By obtaining, using, and/or copying this software and/or its
    +associated documentation, you agree that you have read, understood,
    +and will comply with the following terms and conditions:
    +
    +Permission to use, copy, modify, and distribute this software and
    +its associated documentation for any purpose and without fee is
    +hereby granted, provided that the above copyright notice appears in
    +all copies, and that both that copyright notice and this permission
    +notice appear in supporting documentation, and that the name of
    +Secret Labs AB or the author not be used in advertising or publicity
    +pertaining to distribution of the software without specific, written
    +prior permission.
    +
    +SECRET LABS AB AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
    +TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANT-
    +ABILITY AND FITNESS.  IN NO EVENT SHALL SECRET LABS AB OR THE AUTHOR
    +BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
    +DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
    +WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
    +ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
    +OF THIS SOFTWARE.
    +
    +
    +
    +
    +

    test_epoll

    +

    The test_epoll module contains the following notice:

    +
    Copyright (c) 2001-2006 Twisted Matrix Laboratories.
    +
    +Permission is hereby granted, free of charge, to any person obtaining
    +a copy of this software and associated documentation files (the
    +"Software"), to deal in the Software without restriction, including
    +without limitation the rights to use, copy, modify, merge, publish,
    +distribute, sublicense, and/or sell copies of the Software, and to
    +permit persons to whom the Software is furnished to do so, subject to
    +the following conditions:
    +
    +The above copyright notice and this permission notice shall be
    +included in all copies or substantial portions of the Software.
    +
    +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
    +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
    +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
    +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
    +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
    +
    +
    +
    +
    +

    Select kqueue

    +

    The select module contains the following notice for the kqueue +interface:

    +
    Copyright (c) 2000 Doug White, 2006 James Knight, 2007 Christian Heimes
    +All rights reserved.
    +
    +Redistribution and use in source and binary forms, with or without
    +modification, are permitted provided that the following conditions
    +are met:
    +1. Redistributions of source code must retain the above copyright
    +   notice, this list of conditions and the following disclaimer.
    +2. Redistributions in binary form must reproduce the above copyright
    +   notice, this list of conditions and the following disclaimer in the
    +   documentation and/or other materials provided with the distribution.
    +
    +THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
    +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    +ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
    +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    +OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    +OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    +SUCH DAMAGE.
    +
    +
    +
    +
    +

    SipHash24

    +

    The file Python/pyhash.c contains Marek Majkowski’ implementation of +Dan Bernstein’s SipHash24 algorithm. It contains the following note:

    +
    <MIT License>
    +Copyright (c) 2013  Marek Majkowski <marek@popcount.org>
    +
    +Permission is hereby granted, free of charge, to any person obtaining a copy
    +of this software and associated documentation files (the "Software"), to deal
    +in the Software without restriction, including without limitation the rights
    +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    +copies of the Software, and to permit persons to whom the Software is
    +furnished to do so, subject to the following conditions:
    +
    +The above copyright notice and this permission notice shall be included in
    +all copies or substantial portions of the Software.
    +</MIT License>
    +
    +Original location:
    +   https://github.com/majek/csiphash/
    +
    +Solution inspired by code from:
    +   Samuel Neves (supercop/crypto_auth/siphash24/little)
    +   djb (supercop/crypto_auth/siphash24/little2)
    +   Jean-Philippe Aumasson (https://131002.net/siphash/siphash24.c)
    +
    +
    +
    +
    +

    strtod and dtoa

    +

    The file Python/dtoa.c, which supplies C functions dtoa and +strtod for conversion of C doubles to and from strings, is derived +from the file of the same name by David M. Gay, currently available +from http://www.netlib.org/fp/. The original file, as retrieved on +March 16, 2009, contains the following copyright and licensing +notice:

    +
    /****************************************************************
    + *
    + * The author of this software is David M. Gay.
    + *
    + * Copyright (c) 1991, 2000, 2001 by Lucent Technologies.
    + *
    + * Permission to use, copy, modify, and distribute this software for any
    + * purpose without fee is hereby granted, provided that this entire notice
    + * is included in all copies of any software which is or includes a copy
    + * or modification of this software and in all copies of the supporting
    + * documentation for such software.
    + *
    + * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED
    + * WARRANTY.  IN PARTICULAR, NEITHER THE AUTHOR NOR LUCENT MAKES ANY
    + * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE MERCHANTABILITY
    + * OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR PURPOSE.
    + *
    + ***************************************************************/
    +
    +
    +
    +
    +

    OpenSSL

    +

    The modules hashlib, posix, ssl, crypt use +the OpenSSL library for added performance if made available by the +operating system. Additionally, the Windows and Mac OS X installers for +Python may include a copy of the OpenSSL libraries, so we include a copy +of the OpenSSL license here:

    +
     LICENSE ISSUES
    + ==============
    +
    + The OpenSSL toolkit stays under a dual license, i.e. both the conditions of
    + the OpenSSL License and the original SSLeay license apply to the toolkit.
    + See below for the actual license texts. Actually both licenses are BSD-style
    + Open Source licenses. In case of any license issues related to OpenSSL
    + please contact openssl-core@openssl.org.
    +
    + OpenSSL License
    + ---------------
    +
    +   /* ====================================================================
    +    * Copyright (c) 1998-2008 The OpenSSL Project.  All rights reserved.
    +    *
    +    * Redistribution and use in source and binary forms, with or without
    +    * modification, are permitted provided that the following conditions
    +    * are met:
    +    *
    +    * 1. Redistributions of source code must retain the above copyright
    +    *    notice, this list of conditions and the following disclaimer.
    +    *
    +    * 2. Redistributions in binary form must reproduce the above copyright
    +    *    notice, this list of conditions and the following disclaimer in
    +    *    the documentation and/or other materials provided with the
    +    *    distribution.
    +    *
    +    * 3. All advertising materials mentioning features or use of this
    +    *    software must display the following acknowledgment:
    +    *    "This product includes software developed by the OpenSSL Project
    +    *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
    +    *
    +    * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
    +    *    endorse or promote products derived from this software without
    +    *    prior written permission. For written permission, please contact
    +    *    openssl-core@openssl.org.
    +    *
    +    * 5. Products derived from this software may not be called "OpenSSL"
    +    *    nor may "OpenSSL" appear in their names without prior written
    +    *    permission of the OpenSSL Project.
    +    *
    +    * 6. Redistributions of any form whatsoever must retain the following
    +    *    acknowledgment:
    +    *    "This product includes software developed by the OpenSSL Project
    +    *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
    +    *
    +    * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
    +    * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    +    * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
    +    * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
    +    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    +    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
    +    * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    +    * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    +    * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
    +    * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    +    * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    +    * OF THE POSSIBILITY OF SUCH DAMAGE.
    +    * ====================================================================
    +    *
    +    * This product includes cryptographic software written by Eric Young
    +    * (eay@cryptsoft.com).  This product includes software written by Tim
    +    * Hudson (tjh@cryptsoft.com).
    +    *
    +    */
    +
    +Original SSLeay License
    +-----------------------
    +
    +   /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
    +    * All rights reserved.
    +    *
    +    * This package is an SSL implementation written
    +    * by Eric Young (eay@cryptsoft.com).
    +    * The implementation was written so as to conform with Netscapes SSL.
    +    *
    +    * This library is free for commercial and non-commercial use as long as
    +    * the following conditions are aheared to.  The following conditions
    +    * apply to all code found in this distribution, be it the RC4, RSA,
    +    * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
    +    * included with this distribution is covered by the same copyright terms
    +    * except that the holder is Tim Hudson (tjh@cryptsoft.com).
    +    *
    +    * Copyright remains Eric Young's, and as such any Copyright notices in
    +    * the code are not to be removed.
    +    * If this package is used in a product, Eric Young should be given attribution
    +    * as the author of the parts of the library used.
    +    * This can be in the form of a textual message at program startup or
    +    * in documentation (online or textual) provided with the package.
    +    *
    +    * Redistribution and use in source and binary forms, with or without
    +    * modification, are permitted provided that the following conditions
    +    * are met:
    +    * 1. Redistributions of source code must retain the copyright
    +    *    notice, this list of conditions and the following disclaimer.
    +    * 2. Redistributions in binary form must reproduce the above copyright
    +    *    notice, this list of conditions and the following disclaimer in the
    +    *    documentation and/or other materials provided with the distribution.
    +    * 3. All advertising materials mentioning features or use of this software
    +    *    must display the following acknowledgement:
    +    *    "This product includes cryptographic software written by
    +    *     Eric Young (eay@cryptsoft.com)"
    +    *    The word 'cryptographic' can be left out if the rouines from the library
    +    *    being used are not cryptographic related :-).
    +    * 4. If you include any Windows specific code (or a derivative thereof) from
    +    *    the apps directory (application code) you must include an acknowledgement:
    +    *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
    +    *
    +    * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
    +    * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    +    * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    +    * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
    +    * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    +    * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    +    * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    +    * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    +    * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    +    * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    +    * SUCH DAMAGE.
    +    *
    +    * The licence and distribution terms for any publically available version or
    +    * derivative of this code cannot be changed.  i.e. this code cannot simply be
    +    * copied and put under another distribution licence
    +    * [including the GNU Public Licence.]
    +    */
    +
    +
    +
    +
    +

    expat

    +

    The pyexpat extension is built using an included copy of the expat +sources unless the build is configured --with-system-expat:

    +
    Copyright (c) 1998, 1999, 2000 Thai Open Source Software Center Ltd
    +                               and Clark Cooper
    +
    +Permission is hereby granted, free of charge, to any person obtaining
    +a copy of this software and associated documentation files (the
    +"Software"), to deal in the Software without restriction, including
    +without limitation the rights to use, copy, modify, merge, publish,
    +distribute, sublicense, and/or sell copies of the Software, and to
    +permit persons to whom the Software is furnished to do so, subject to
    +the following conditions:
    +
    +The above copyright notice and this permission notice shall be included
    +in all copies or substantial portions of the Software.
    +
    +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
    +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
    +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
    +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
    +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
    +
    +
    +
    +
    +

    libffi

    +

    The _ctypes extension is built using an included copy of the libffi +sources unless the build is configured --with-system-libffi:

    +
    Copyright (c) 1996-2008  Red Hat, Inc and others.
    +
    +Permission is hereby granted, free of charge, to any person obtaining
    +a copy of this software and associated documentation files (the
    +``Software''), to deal in the Software without restriction, including
    +without limitation the rights to use, copy, modify, merge, publish,
    +distribute, sublicense, and/or sell copies of the Software, and to
    +permit persons to whom the Software is furnished to do so, subject to
    +the following conditions:
    +
    +The above copyright notice and this permission notice shall be included
    +in all copies or substantial portions of the Software.
    +
    +THE SOFTWARE IS PROVIDED ``AS IS'', WITHOUT WARRANTY OF ANY KIND,
    +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
    +NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
    +HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
    +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    +DEALINGS IN THE SOFTWARE.
    +
    +
    +
    +
    +

    zlib

    +

    The zlib extension is built using an included copy of the zlib +sources if the zlib version found on the system is too old to be +used for the build:

    +
    Copyright (C) 1995-2011 Jean-loup Gailly and Mark Adler
    +
    +This software is provided 'as-is', without any express or implied
    +warranty.  In no event will the authors be held liable for any damages
    +arising from the use of this software.
    +
    +Permission is granted to anyone to use this software for any purpose,
    +including commercial applications, and to alter it and redistribute it
    +freely, subject to the following restrictions:
    +
    +1. The origin of this software must not be misrepresented; you must not
    +   claim that you wrote the original software. If you use this software
    +   in a product, an acknowledgment in the product documentation would be
    +   appreciated but is not required.
    +
    +2. Altered source versions must be plainly marked as such, and must not be
    +   misrepresented as being the original software.
    +
    +3. This notice may not be removed or altered from any source distribution.
    +
    +Jean-loup Gailly        Mark Adler
    +jloup@gzip.org          madler@alumni.caltech.edu
    +
    +
    +
    +
    +

    cfuhash

    +

    The implementation of the hash table used by the tracemalloc is based +on the cfuhash project:

    +
    Copyright (c) 2005 Don Owens
    +All rights reserved.
    +
    +This code is released under the BSD license:
    +
    +Redistribution and use in source and binary forms, with or without
    +modification, are permitted provided that the following conditions
    +are met:
    +
    +  * Redistributions of source code must retain the above copyright
    +    notice, this list of conditions and the following disclaimer.
    +
    +  * Redistributions in binary form must reproduce the above
    +    copyright notice, this list of conditions and the following
    +    disclaimer in the documentation and/or other materials provided
    +    with the distribution.
    +
    +  * Neither the name of the author nor the names of its
    +    contributors may be used to endorse or promote products derived
    +    from this software without specific prior written permission.
    +
    +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
    +FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
    +COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
    +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
    +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
    +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
    +STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    +ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    +OF THE POSSIBILITY OF SUCH DAMAGE.
    +
    +
    +
    +
    +

    libmpdec

    +

    The _decimal module is built using an included copy of the libmpdec +library unless the build is configured --with-system-libmpdec:

    +
    Copyright (c) 2008-2016 Stefan Krah. All rights reserved.
    +
    +Redistribution and use in source and binary forms, with or without
    +modification, are permitted provided that the following conditions
    +are met:
    +
    +1. Redistributions of source code must retain the above copyright
    +   notice, this list of conditions and the following disclaimer.
    +
    +2. Redistributions in binary form must reproduce the above copyright
    +   notice, this list of conditions and the following disclaimer in the
    +   documentation and/or other materials provided with the distribution.
    +
    +THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
    +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    +ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
    +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    +OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    +OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    +SUCH DAMAGE.
    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/objects.inv b/python-3.7.4-docs-html/objects.inv new file mode 100644 index 0000000000000000000000000000000000000000..e189c367fe27a105018d4840c97520ac327f942e GIT binary patch literal 103237 zcmV)CK*GNxAX9K?X>NERX>N99Zgg*Qc_4OWa&u{KZXhxWBOp+6Z)#;@bUGkVd30!R zZVDqHR%LQ?X>V>iATusE3L_v?Xk{RBWo=<;Ze(S0Aa78b#rNMXCQiPX<{x4c-pkR-E!kNmacuiuVNzhcRK2+?4F*AeJ0CtT2r>< zmgLN;K4Cy4B(Y2pOoFtny7~_Qe?*A@h_%3s=&sBZ@w@=>y8r?UvsLi$x_w>GgZss| z#b&Wu{zv%#-bwx+zx+q|pCpU__D=KjF+Ln8$KsUy-*EE({l|a)pO-(L=g-0Y>Up|Y z2I8+b$cdg*@Dl;5^;T7K_#HPZ|~?baBpT8@x>8kVW(+e0tu{BA6X% z_$GjTnTAEo(iY;hFaz^XqM~u2@m90m9}4WDUoWGcq1x*`9;c7K|I2{{EME@&=D zQSWv%2eK*sEU@f{h}n_7dwmF|%RhqIYPnr}eO*wj#J^1U>6DTm`1s*Ujuvp$N*7KSBD=hDwg9_c%`hEiq4|(U!;`!xi?jC%* zUfj>`q2WO(Qi%IYe_t=Q(>vF9U@S3@20QUo6aFD*rze&k91#`mOU^>KZm1J}vfBp- zT2u*l?Gdi=oFk3Nc>wGKv*MHAZ@S1XLyyygPWtF@(!YvFpS7ojV zJzRzL)Iim>LIb6zWv$iSOjxVA9ZoK{n07`ixREQi16f~)laFlVThR%U}Qj*VAwY>>sVK@6AE^QjW}A_GV(hKV)C+?+*KxY3iEQLoFeul(YJ;`q#3cmcD(6GTWp!R8EM{sg>|OD}~+7!R+Eh4pUyyU|3Z3 z1PyCP9&Px>%DX9g^|QdaHvE>o(G&#@mZOV?_U-K8HPE9z~RlXC4Q$gpyoZeotad!YQ!qj0R_Ao(pRM#m|ismO=6}#zl#&Q^11FnQ2JL zSwHMx4bVcyH_?XHrvEnNJt^omK3S$8@^gG4LfAOtiwwZ`)9qX>zdf#A*FOC7Vzypw z=ChUhw(23XeBI7{6!2-7KW(Q<;(q$a#!H}+8Gb@|4P`=ze@xRz{@Y(c{PDn&2q`50 z!V7ZB5PV%ENb-5L+&&`NKju?Rqu4H|f;Cu#gXnX$-2#WA6Z}0VSq6+&%=GmpOBCOJQITO^a`t&PnIL+^Qqe5o&2`KG zNoyDy-ex_UIAQ#eIOQNjZ)O{Ui{`Q@=m}1kKbaahQNe*R)dV&s`E}B`c4j~&2g&W< z=ou3HndS!y4X?g5(;r^|9IVMK4PT%P!PU2?Jt-3)1T6gxvh+<~$qm6ZQx-$W*DNv( zntI?HNlNNiJw!zf?nt})SO?M1kY@51u003BjsrFJx(L` z!NrebXviw^5GOP>Y$@>3Gwcx6ywN?k6#TGS=l=G^Xqt?o5 z`;gImbf-7vE|gP4jEWr5^D@H}&XT2=*G5+cvzcZE&tiV_`NTqk>FTd(csG2_<6d2M z;qaI%Dof%pE__&gnsK&}`o8~~<|O9C@WIrGzmp`GhCj+Ury|SsJ3rI7FjL!OPDupd zs|+|b{+aNrn)k$G3fNnuzb$mu?z>L)#GOza>i0J#u^WtYf! zzb0&Fn4%1!vY8{ug{WFp#p8gQr{?XqJ4GM`yQa8^>w`(a23Awx238xQU~WU+5fGK@ zf%{nB?UE$etG?R`oudF@w6Hvh713*JjL*HVmqoqoHLPD-aK=#?b}b=m(F-Y#az&Pdl?rs$S3`M~27Y@6 z*o=K`mT~oVjh%cZhd4AFMGo+m91tX?p0u3&Xboh|r)&qIZn1a^psHu}heryKEvpMZ z(RaO91qko`_Dgn`n3jyp3StCg1lkd&k?n9&s+!C#5*NWq#nS(nLsiEhCToA&m2o2f zatrf;~x|t(BspnR<<0b)v%Uz`puglrC@`Q+yFbvxcq-HSIQ=+%aaw`7Ym_%2@ za^JAICCuAF9N2qdQn}h;Jy`bF_el29c`34oJ`??P+yOOtvTz~wt7{HuW$*%Cc+gje zCcH6yz2I_HM{gM?;z>VjZG`E>O#nCgpEMB0x3z^g8sH{qXkE*|$!=t^Ri05Hh{@TE z2{CWiGZUL64k7t0`Y4)1-rdk(458OzXf!wyH4qzk-fqAdwSi}pX-lIiI0NOXW^B-e zWa+`sPTB34E5lk>m5qqW;h`0nrqN22^gdx9U=|gjPo%Oag93(dIP;qF_>j^F{C-`~ z8-6DI4J`nMzp*%aDRKZ~?&vMy%^kfSvVVrKK)~#85CjIUlnUY~%J^l)0@Yp`aFls+ zWMxt9=N3ia@LH_vzk4B{NtTI>hq$V~Mkc2$Ae;xh+*OBr9R0lZRm3#zP#n=XG69yU zUll-4S6eEu#H!qnoKY&WIh05 zz;b?6+iFPkM4EY#+R|Xy^>V5Ri;U<9yaYx_!$rcD_X8rEW3}RkONQEgA@gF(@ODdTMVGxtYXcMtP7O3FL?4It*!y{vF9DoWF z0q}{jI=J*LrXRM|Vj1RLgfX(Ruexg-;$sEOho~F{%*L;SfLu4an{MVl`0K;Ne2o>T zb`qL>-kUX~wFoM6_}77k8Cu7)u+T3G9$ykV=w|-(0K@=>-s!fzG*}cti4;uOzA;%i&^Df$xsTsZ44Oc7kO9uHT*MYf z&@5l1FVdehJm(uQMS|W*e&WY?U*OnhB3jMobD0!zmYk6qUi2!*aWCwHBGEOK%V`lB z_sH)}xf51uh@`i9NquU{?+pIRk>0Vlm3cSp@UTFpk7hOmQx0Ag9*HgKffVsOw9vpU z@a%*}upe`CFWT08ba zOun>r+#TJsoI(;G8p9V*M|JB$)gPWNG2fU%;Qr?^8?(b`G(lgr?Tz={jh zz4xv+;57`Fm$H~YdqQ&Cs!bMmjebs_wShvB!@3^J+M>)Mfy}i!?$!&HC{t6C#h*svQaTKjgW8UHS%?4%Ed#-%dCGQ>B5;##X4}`^k-fMQS;~XK~y?Pc|(z} zDVC)v6^4V{k^!%87udAOIt*`oV%{KQ?hl}#`iM+&fo`12DHx*nvYh#_$F?Xa^!*;^ zQ+ZbFq`tAZnP-X#7R$vJ3=)ngf|^1VfnbjaWXa@_<3wGINTGwQ>C@%F;2|+X?=?j7 z=8z#YrQGHe(+bKtIS?{$7afEi4K9H#;4{YJFbq5c`EMR}hCl{=E2DE{3j^Ft)>0X? zp|0cbsIGI&DW1Gz3~GySJVyrHV7BoX88)aM-n8}EhJatI{`v+*K$o=F+_&i(HvYVj zoXfSxSoY28AEqt9`XwYi4|EIJ7co}>n8HX2Q8KnK;Rd;!Wi&6&+KU(r_sFcvG?=Dm zSSfTMh@aIf4473N7D2*a5A$y57el_4I*?96`ElZjvCIqhi++_-9~KdL)n?%3df}j@ z+a=KnhITZ!Bqm}^l$gji^vAG=1Jdh(8qDOv!3t@5IwMfh)`^GPZj&2k!hfh^dvP`H zyQ~^(6hfAUr10XKd#sQOajNe4_D)HolhcfP>3HQQ=m?~SN2T88XtN4o;+i~1fX3^~ z2GKIbL}^)>943u^83xb?!V4s3_2=Qro1A;N@G|ZV0=BFc4U^c6MrKsK=LKDl+s#6C ztAq1~tuq6hdFf&Zj8PR5{el~GW!T^=gK1tmfEm33nK*-gqMj3A=`7f=XHXl~-S4pq zZSt#S4sAP?q^GR?wFbD4c}Q~iSGIRn8ohe5UoxhVe zT4oQR3&>Ox5S8c8k{6=05dYAZfefZ2%~i=nD0k)Xh%T6ZCSn9l1!)Se%X3rM*EA#U zudlqISslpgwtZLFL!6?xH9fI+3MJ)gRL49~*R5Pn0AyEYr5<9cc8CEnn^EFGn@59T zSlxSKSPXQhzu<5~Ep-C%iQahS_Qof-UsJhS7d6$S+uU^Unah?V?~hs;FK6s+Q|nO{ zcRnWgcVK+g^;VlAqWY`k><}vpXXvZ#(lirMzYce1)|AVUrO82eP<^C0yu0~&>;ML* zwk8Ca1@bN**A1UCe0_Tgs5BeKwJ^8;miKo+FRJfSz?JQ^!lg*I0| zJ7KJRW^8CF$4CNaaTmz6L}P|PbC8xXuKXDx_X%1R{)GSwX@kkL4dV4pD^Ny2vm&Ak zD?%A+viOH7?4-!rVbtZ5l7{3sln1+JuPU6@d-QPxIhKq=y(=3BIwau{ORBRX2vG08 z$bpO~zDlT_JGB9Wr8$f<8Hyn(s{n!XlSpK-0BsV3X`=+=+_QDbb9Gkp`PvjHd%TxqMvIehdE-bPd z>K(4RfXeK_aL8iG>J8s;GOsppBfvO3hV3?PIL|#g7w*%!aBQUYAqZq=YIbqw0Dn;O zmQ?czJPaNyEt4j#aXK_*GC zOi*Fm6lq3kpN6i)BjFE}6oz|P4bWl}e4RnU%Y#FO={uXAd1g_(kM+x821K6VJp;n) zW@f#R^+&IJD*rprbCz2i_?h+zXhcL&%~SDD!**GyQsggU{uTt&5yimupZs7tn}X!N z$=QsNH=B{(X@h?!RaJbeUsuGh`t_6|e-U)`yU{@x)s4;=MYS0tZ#E;nlSlQ_uS}KI zLoKn*Ny-yZPd)4GjSjl9^>xtotuKWxp1u^egl?2JBjwX(yqEK+e!(wye{AQ${d7Ck z(YAV6qrWYd{d0p>?h8K3FUTnWfsgVZ$S9{9TzrCiT`uY`IzW^w|3v1KLIbq)Q*fu6Nkcq0hv2 z+U!5Ug_BDlKE1K|WX=#~Jg+bSW@lNrBBQJIV<>JooMxp^17tPtLt;h;ehzFsJR<3b z%{|?dGAVp{Z2wcqRAVd_W+6$a7wngMImCOQYM& z|9?DC|JZ-^Kz(EPsy~&1jl^(WU&Ug(zM2;Qe<25K!tp(4#Us1C8pd^b6^!bxD%88L zsbp|{P0J$siI)8zJo+mZ^~$k_%}n`DHu&xvV5|0xAmb!KK>8)9K?r5~SEqpBSk6xM zl7M+da8SV`@(TTiVt*5vC2W;@QVdeo0fpmy8QAurlk)_Z=Mi14XIVgOilty6-j3P(?oAMbgS{vLr5Wl)RP#z5uZ)cO2I)wj@r( zFcHF=vic0O7lVu#`{NTywhU)ux1V$HB-TLJY}BxZ|E^jl{AQ zIqaf~7LXT70CtMD9Ks3ncS_!Jx;L+gepCT0)Jx7j&p33gzXj3?%5ida_rLSm7LMA! z2U|(eljB}ffS{MmNtT&C*O^>y2GhGuugK%H$k}bUD0-o(+z(>9-lBj0Dwr1Y&)Dsl zc5pZUx>yF&r>E8TVEZUX7+u18QQSSPX1{@eGESmzrW2_oKir0wH-N|^`n40n!Bb~y zV0@l#esjv#+0$GH2===F>J%51Z(mmak zjs-TfF5IuI_be@{du2rJP|G_`5zUwP@ESf(k~rfrA9kBFxZ2Zyk$D;^lRC?(VZ}g~ zB1x=iSmr!_r>6eEv}q%7?-L$K!f!|R9b-u^SV0oCi^Nejl0NQRr>~CC01O3#(F^wg3W}o}3+Wa(XC}1eml6G#!vPKdoJ+P5HiKJ!EZHlkxeR|F=b|#Q{Okgyx8r3he(Hs~xsRqB zUU$PnAl*}m9>Fo`|0-kZ*my**Fu9p4anw)8aZx_!m zPxI&bay#!Y5@@riM%Rnk<81Z(GF{J2M@@Ru@P^&4U)^4cX8AldR6Ap zwiri)hx{>D|*D18-iYGZeU8Y;iHZzP#YFD0p0a zeGE3Q>-FmEbUSxj9`5pTZtsC((f?g7mKS&fq_-<{BM>OA5o}k;dc0ks>+yDltWnz) zxJHTAJ$tNM%}B*WVT!eIXex1`WOu=sKyGXYLqxv=D#C ztmyrYnPs+ah^~eq-F2CD(24k?|M|oQ?3>LU07hL@pOOSf86APxsD!34AdTV^j1VR* z43ORlS(=<-6hD#-`1105YNT_;V1>$Esw$PKE&Qq^7zDW^!&l{{v}UF1u-)h-LYIhjlQ3FG~< z)Pr1=!-4c%7X?AWNQ8=BCxc2(`lF0hmS5EaZO0<_TLI-WwJtPikO`)IZ#7V*T=~l+ z(q*~RzMU%kiDX%|Cgn<`r3&W`G&d)?A+_Hs(dUFtMfM)^xNr_V&Bb7PqD355A9}O% z|7+JQ1)0RVoaE=;I;KK7r@8zMP8Py?+?BP90thJ`N6p)?Sa2eySzOYjNeGDk5Ls4P zU_0qASLjsU@rFdi2=^wc)?x*J?Q3)rwudo;4^e;xO+jyyvp1T)#2F(0m6Z<1I-7kU z-0UbO%P*oXQ_jJW&RCjK)muz=qSn*ML%{=G3p<^AMXqi$0rU5w%b=A>g~<8&>H!>M zyQ4-hkvto52_A}o1xbr;=*t&scubfspxX7~l(y;y;FuTiS|`yZD;`*x!pr%1@rWPgiXr0)U9FteR6HF~qyc%Oq>#03NBlh!R1GjyW$gOpmkR z)AqA87#4G446|b-kJ>~-;3vl3$_yOm^L+al%$}y3O{X>Lr|*~GtNHJX&DI@wm~OV} zjt6IAxtgxO0+O_H54zb-w~Lv3_;1s-ds^rTQ(3Cp_0T<){8kKyXb3kO zFg@x0;ckj?7@D)z@i$`=53+uhnP`5;?qYa(c$$9Q1b5TTTu`NQ<}X$xZ(vn?*R$LY6u@UU1;pX8nzF!^-`W9HKra7jFgp$qqNPpjou99bPf z1QUzpR}i#)eR-PWQYf<#M>Zdj-QjxICZY|C`5VpUat(sytjt41U@eiJ|peL-~tR}=)drIHy`R@g{8 zGZDkgn{r&xuYOl(m)S0!=d0JPIx7Rf>OBiIkY8sERmuocTVpg+wFLr+NnSJ@%SBKq z7&mKzs>(uXnJE(z%5Tk7`;E*_%KubrH$X6_2_+mDrRbKzx5~u>@HN#SCvTkUR9Y9F z>_Tn*7QgrEw)|~+r{<~Z3Z#y18@vPt7<{ zM7m-jVWFa{gX^=*h~lU$XBo|lGnC`<<3R|EQ#Ls@bOwd|)ar(D_fbjo`Kc&1A}=hv zDXvSeOh2=ns&%Vdl7tDnX(3J+uWeBnC2BtV0Acao&^E+_e&diow*S#r!j|g+dl1mi zw;@8*1i5LeS*C?@MLm*1xP2}n%jGszAb2AA8-|fSp@CQ$9!Z+g1P-dV17jHx7?|SZ zlzqfeaRh;~pGTxJryp?|fe?(L*ONxOJTm>m;l7IlY$A==a zqQm9n!xa_7q;bT$4qd&5fGGxyLx?-=P{Gj#` z*8YU~BTcf(NoZ}`AhcfOzx?0{iK2kiKk17QB^4ZUR%Rmzp2T!p)P!>&CNfDW9V3h; zEv!=Y%rw3@i-nc%UitEY+|nw{vY^=m=pozA;e0ge8J&kjbx4IVC~d{$4<(V4vteKrPc);d{I#X} z5wy@v=!x{4XtHR{RCN$g)c!pKqjH<^2g#tEI^zn3MD8QrZlAN0N+t%BOXV0&U0sdf zYNxpfvOc~IMPs?)5)R382wNZSiw*=tYDb>RWMBL zDj2SA6%1Lkw8g?Il25J{#dT8U}uCTJjS$Ju3E>N6?x!MgITuRxA6P8F2 z%7Z&W+O!>K?oxGKkVG;hQ78XhnRZ>lCGZDH-rT~TcFeMEjcN%B#{TzMXh8f*$7m6@On|q zLy|}JTXGMjz1-XssHs{?3e$Rklay?yqX=asKYHSUI^`%&x|bpKNef56RLsonDQ5cS zBz~XPAMVuQ!SC|&2GdZZ!vAL`EST`zi(9LsmZhrB?MTunvE>X{x+q9^6urC2yu^rF zzF1-8Dm!+>9GJh05$36WWm5@J8A#@fgU*YJ(5Jj_q^gg(>V-cpmC65wJL>BF{0sh8 zT5d}CNz(kM<_Y)D6M16$C1(W_1BbOT)M4xjasjzMj4P64n(m+_Pb8vaNM@vz!)+cH z#;FxdFsHmcjiIQlez{2uUly%|OP}Vbq#EC+sDqZ}CWK_xsd(OkF%RSmkCgwaZTY58 zT0At`&=bjyET^_Im49dyYFB%nE%ZjESvoAUh!lpsV+d8s_CZcV8o!UHDQijXLJy}n zBWXy5No+r<*bbnY&AqJ>OQYEMz0_KaEo$B8=c-}Z@#iX$vLfD}N010el6cA3b|JcI ze2}>C76|q%M~KL~Eu~LrzZQC{GKuORd>d3xSbd5eOVx9<>d8#Vj^)KziJHi5cm;N} zs<$_cU@t2Pc&DK-F@{rush1TUOD9SN8uww5jZ*q8^qr7a{yl7Db@ahRs>!QdhY3Q_ zy%~KMIf{j91oBr%2Ab=Dh<#mYn5SJ=GFTBgoDWV_1~lra^=RcIZTF<`QBc#cF|tPr zc_imitur7O2rAg6wz`T8RalG8BCR|)7F1r?>TSAdY*A zPLep<6hlY*T*RK@J^NQlOKZLOAp_{xQ(Q==5_y@9kdPZOIkT73X0IZ6s*e=G#@45y zGdB)6+6;dhI(=iuU-FpcadE~LsxSqKbQj~hqUdMwURk=n_UM>XP;9m;ZbIcQb8F02 zd|wVsr>yj0z+4-GgOm+gZB~sxS)AhO6Zy1mG;z_8j=|9h5U_U^{AgYQhZlsu1%sxV zO=8~EKwCd;6L_fWAcB{ppy!O1Gz(1ecB zt9vX~wy4L*deJ}+uNMjY7`vfqw67dgPTxtKkX_<$iEU{9ZZBMGxk%VyNq<Ew7v(tRp_TMNt5$9V#*i$C`!^vRN^6}uITnCuZow`Y4vH5dKOzF zH`s?b$wWCBu=bo}0G}3}^c+6}I%ySMTgKL(IH|dI18!pSkC9}?sa8r#wmpv1DtB4s z1=4R~+1Ht5aYlo2b|#qA$C$(ytBP_qtfzpVXlz1B63EBAO$bKC zVcC3;9$GKA36yy*w}BPi48;fyEz}Z0{nH!sx|m2$3Qzc zsC1ceN}b&6t58Q_BDbew=P#ZkPwmyOw{(sFD6fnb-&9>`cx_&|k#e{Aoh4=CswC^( zUy1x4!+(b(G>nCe+}1K+MUW`U(1cs;v~N zCF_8MGS{i7S?cTND4OyW)w1X)YSrY&U#=Qy>vLfO1#|_ z;H%UOw!S)Is`5E<87RpS-n90DHgZ2yx!~KC2XB?})1@|q?bWK+*;h=ACi&n;RtFvF zq}f}i{!WYE649vCwv3ldz3MxH0Z=QAXam%WBbWgqr+l~Bv^sIBW-VpG{I%3Ji*~)q zOODqYw>(A0=npzx8^_5iK6(ek$LwJEu`D9x-c$a1pegs06Shum`S|P9qnW=@PQ&+c zRHWNd<}W2H{LmR(XCeQVqjt>|iD%Il_|1uxK!0gv46Sxm1uZ7;9K;Iry_Dc)?b2=e zjd^EVB{FQ+Q7Rfs5g{dp0MxW!4jt_R!p*D=EXGG#@!=z_`0x=|eE3m%i^FA0LTQF0 z+YPjXd1lXkH=Opu3z^u36>%Drhoa)_r$p=x)vw?#IOcz}T zoD2=Tg91C_9UV^iz~ad;KQ!PEE7a5TfhCtgoytxNyfgGlherNNzFFMJc;|F2WVs{& zB=b2&HruzhyQ&OqFBp`O9)oRrZUzP9Ysj-JUJ^EocM#{)s~?a#==TDZf5s*mfZkBu zw~6jc6)lH=42%vL4%bxCUX0NjDb%C>I8puFy^T&6QwQ!)WeVlWC~nRg^%7V;>!+~( zokT{XrAuBTS$O)A7;j-Tg9-USaqkBNl4Ve67ZVOucfdGV^!0oJHCuVjsZl+|PO~G6V>=t)~(|`U$+uK)IH&@5F0UTa{>H`c*i#RPQ zjFOkT!-yYc3?!iKldBp+GZ-PA`~zR!?4m-C6f6S{Gb&N-LYO;Oa(TZIs9q`r(fcY6 z*7GU^SgQZ3tBr1jqaR*Y|8~FOu<_6apX{=#uXapV7gPse!CXY;zME$X2V-troV9T@ zb;rUZ4d0|yCwHBhEWBHY?)UPO^t&@~)%pej<9t|igPjQ6-g(zIIqQdgyR&&QJ?2&#V!5>KQM~36d63*?u5OnTH7L_{+{DA~9xg$AD?u2>x z_b(_6_kJQbllm?L7?>w&&WVdvz>x=Drif(M^+wl;h)23EME*R~fwX9cxkRQI|9TRy-eGn?X#F%H6fNfd%=7A0!J+{+Mkbu6t2UDKWXDu#vcK>94)X4~w4S?q&|hnK&G7-f*yK z!{KHP$Cxx6XU=e_DZ{a53sdbQ-q_;5RNcGIN1E)aMOc>%?^$;IXK+h;BZrePvDWDObm`QFZcxU zMsTx&PvG4F#+=|2cozaPBmVlLUt;;|OMi7m{C4;6FEe(^a>_Z=?n-Y#Eg>D*slV#K z+}PQDQu3oScuzxcLc5GIN`Q&I;%i5aIyY&9Y)WawgE-C1uGR)M%CzJ(QqD^t8V|AF z)vGD&B%}1rEr+`Ksas;a4S!t%E`&T&>Jm15$ys|;`L^z7)w5px4@n}AO6OXrd1$02 zvkrcnx!1H7n@HykCzcjRdF8ggP6B1lBdL5DN9OP2$o#`g=0ntGubjCQ(N%r%kP;a@ zo|L!JSxi>PdA&+$jJIo)utJa9=O<+I?4py9bA<*fyG^|=PAxdr2MR}#Oj%TYB^gES zT<;?sO>EScrF=Z4pza?=Nno`}r>!g48e8j}sb9tK$YkU|p;Avw{?(%;RRUZ3Ss(>Q zLVb!wqk}1yE14|!PfC_!lF{u>H5QeHlr4npcDcqo?f}*7(Q>Euv6#fx%@Ur{m?zYD zzR|)-s<9JbWLugD43Vi72hUc;;cI}x#f0}j;cS+NB*9?FtmU-ut3=W%&*22;&=E@T z*t(i?Ws_#lq}v{h@SxvvD1PtHa>Q>B(nrjuV7VAQpL#5jSH&WW6 znX!)DhR%rjh^0PoV9#bfb1IV}mTP!0><5R2Pn-dDuT2!^v~|`+j0 za-c9&4xFxpn25OMav1&8p*9MIg4 zW%{PiA^D`AL+aOAL-nk!3v?6O;+n?-)m}ppnDHhV3l?)>*q@=4(dUbW;ily?8}nvZ z;kGb^$@APTBg=6TsQt-22uyRF{!(%S#;H8j8B(?Fz7lBT%;}!yR6P8fG(<#YqDf!i zlrv1cyxgh3qT_7@n%8z%KCe)bU`Y5noO{C*vxuXHsEIl(T&r+tFj3Cr*l}|_RG#G;rlqP9aOn9b^6_b z6jl!sb^r$d<-Z_6og9}u6+xZzKRXgw?q{*HG)v5LI319ix5#V51G@rfPr!fVpyU8M z4rsqokkTdRBSW7ZX?pBvGCOJAi?zW!;U?nG#>H2EI5z-4N?IB(%hE&5^=*|4YWLXS z01G?wEawE$Q&yafhc>lH9MQB0k7D`+ib>2$sxjV~5XD&3Rlu1!i7ptE4=klkZF9wGbMj&RfPW1(`yYGVg?P~KFXWF4 zxiOQdGpaLTFEagS`wMRYW&Kt^>GR)7A~S8yaKlAzUG_U*HKd1x>W)u@iu$XlhlSqV zqBE>~Bbc_cf>byw^Uzm^AK3>#rv>>myGMnosZ-9zTaDed%)U)E8gej-m9yB>iKM34 zlLqWoZ6_k+#)cSjZBrCK->sf?CP9a}4jkOgVd0;E;a|58zx)${fD=|xh~!mge1Qli zd4fVD?^kzXCjYQ)Vz+WMMRAMz`W#(9Wn((&)Q(C+I8D9qI1O`p5=IzFs)XcYNL7i# zOEoKtD7bPOpWCejH<8N~Jphrpdiki?xM%3(G~nWrf%liPaI8>$7|{YWB67jDAce1t z*;|sk2KP(KJoU)a8bz!{+Xm*Cn_bMZH17zT=a~Qj?x6t8 z`!4;x?N)$U2d%&rhm5Ymuy0z^cB9gX1{ajHg}HdsV|@grx`=?oI%BK9|v@>7v^Q@YX&#L*k zvDfdq_`Z-?Y+kj}5blcr*Km?l*Nd5E_U&`cOJ1JMjwDW>tIdM_1m9?w;K_+(=Cx;M z6?v7Lx@^oaPPyu2MD!YkM}p*8Z&Rteu@jo8o}D9KrB;z=uHWd{Q{}{Xp{keR=%up| zFL#AyMb%NI%p$X`JfN`><48`U`#3C6#na&@>i*b*1*WTbKw=ro#AtQG3B7WfqhG0k zC$>XzPAX6J21Qg7BA5=>)UC{|GPBM;V7y5CZ%-Lv(2Lnt?x|AW;OV6@PW5{f zvq10M6_xJ9zs2;!S0x`KDgK%An;4e8Uq@IgnQz^%HT=_3s^&aOk}9bU{ZY#OiQ{M$ zUNUQS6H)A2bw+t5-*?%>f6>TG;TuUx>Q{a1{V);MZ0YcFdu+_PsC9-tsvxoEa{12X z?I=4Sl0}VtH9=0~9fw%Uva8T|KEq(R`mIhj*A`SMd}Z@#`R3+41D0H!ZU_Ik23~RhCJN<@{`1KT{8N)4cjY!sY5g ze%P6-Ku6-5F<5~WWX3y~tI4dCd`?d?Ijwebgpt)J4U!cunO_8>bn#I^C zHZPE0>lg&~wv7u;3K=mU`!y&e9ruhwnU#iRE|*Cs`?4r=YH9_y!8DoI3v!pUH=52r zX;>C!C;KLCgXl~izY?uDvU=_Zigwf3H}gb9?D4iox%*&j(fCAJS&Z4q z6CSjuevAVuNHMGOvmWR=xjRyd3zf6A{3V-5QkM(&xO~{h2j!$8HyI0U0G*j|d3Z;7 z99FyLSwhS!?zeh9p_%%}OPeN7iOJn+^)#O@gUxojoo~!D9hmB7KHJXL^ReXQ2+1!W zDs-I#NUu9j^cFi9x4D6JZCN?S}SE;F67#cS|-> zOOTCSyri$pntY64FW;z)VU6BOf_ukmzm0U$B)2y^`#BOI{VYTP({!eOteeaEGCA|lxY!i+5}KF5gjn30frQk}O97ET26d8N09!EFWbDEdzMuq+@+;wfTw@nBU@ z^`idw>C#U1iz+rDnWwc;j(|rSIjwwfis^+Iesg~jRw7d(@20X`tzn_- z928?nRY8G+NCy`+3rfG&u6s;lkbG_$gw(UyrT7dz#6`lu+P3*PDp=Nj+yt!44Q>*a z(-Mvfd71hNysOQ1UK-y>?o*Zm_bv>nVfP^5u46m>>aK#;=>B~xm()>t+f%9k`@Gm} z7R#^bd@|{>Bnnhj8eRF_a7ZA_1?;w8{*&&SjGAt}-E;|ZcG>gMG%Qg}n)!cU9pGr#yw#8M6)F%uy zR-N6oYzy++ZJCZ-am?8V0L&>VXuyvwFT$Q_5XHO@vI+m&u8id#U|w9IQCxl6aLAGT zTzOyXm$7`(FJblT^L+cbx)1K2R^J~M8|^yAh3;Xq^&c-=AoG0x-#}vXIQ{b9|Aa&T z{mU0usLecGRn-Ai*_*c$YMD1q64zL&O>X_NjC7!XfP_>K*)Q=;hw7P3k!==7F}?QXApDnYU%#sg|Tnd+_LuNzuVCNdR=Yj!Sv}#*M9YZpBKx;^ArFq zSIapl^z!w2zFy2+m`xftE)NHDwGOMkenN7z;kf+M4H5sZTyBV&UMh?n(}5K;7hSp; zrwVx?)%I&?l5+$s8-7sVk?o3BUP3S_{^->4+o2x7aW_ylh{UO;sE|QHc21$IZS?Y{ zg+O)lrg7(%6H~9ClW8u9yc?!rxGQ9L{?ZR!yZ-IWr~f;?v~~%v|32f zkMEr|mhKQ={XESNrF6_-?@e!)X&N@K?ltOVfhGJTNN9Q}j>gL$?6CX?6upZN^HgMg zx>55E)An3FJiD*P4AdPOvy7zJhCQgQ*1l1)-z@}KU)`c`ZiOKhtnFJ(d>G{M;9$@2b&U<+X z2!s6%iod3&Z5sOU-xo_MAHvu_q8_?$7m{G671A%MbPZK(CWJNeNNF5 zO!ciCM@!E|0f{2xRr3zG&Fi@<9hg6B3`=ArCnp3Pr$J=;E@=QCM1^`OAU%D9Oh|rc ztszK3H9XC8b-fgp7ey?8f#NSLHhS5zBRH$5rPca$3a{9kSRNt(H|GvEv9IUr1?on` z_OO13B=I4YmM#q2opTC|DGYY?;RMGl5x}{iAfQ=u0s%n=LaHS>5Yp}`cP8qMd7+08|NIA(_!R^s%-~YS1|SMVV&J&chXoiR*93qFf+@l6q=eS55?;YdcnvGz zRjdTpu@YSHC91lV@cQ!3;t1FqeSo{X4|tzPIB;l$I@iWJpzMWBQC}hJ9uLQ5Jom_WnMkPV zQ`b%c%zF6|d9shwC`c|#CK&w00GU8$zu&_g82JY{(Php}E1>F8e+9JqdA?rjKEQOC zPTY?T9Zcn2RHwnPua$bxh5`Q_oKXFZS*t|IP88ReuHc>NwlX$B)glFDgvdXT>76P5$%oiOCyfQ*bL zsMlXGXhvdaGQ}T(#R}6?5#0w_&JMxJa`%K8ysEoXG(0jO zkwzcpYmp61PI$X%2!h$Z(CV3eoD>uo&t6_~14YCfFiwH(P0T;!2N?>c`1upefJ^B} zlD(>bP>ff-2ZwWUh+q;p^G1O$B{!U5`b5RS`zVR=5DM`?ZsZH9d0YgAF%4PdWAh;s z0L4iHZ~Ssm1|HY2-P0pvgH$u_cak8`6XC!yFeTXu*j7^dk&y_@fXg=p=0M6YMnKBo z!%oWJY5NhYZW@Z^VpQFlB~FUqNz|*)5}z8!9*)gWH($Xk%@S0Tz=tJ_Dn%CM1}#KI$_DPFjg7dehZf})i((|N05GDU($?*UeF z_jZVo7&1bZM>I!)p9m^E9tb9xmP>_(IrfGk^MVOO9E(zxU{LX|a~hTzf{kc`YLkK! z)?JdK(7ayt0fKT#rdg$fqN&9z)DX!c+o51PEk7$DV(koEaB@cv=T9Vx>q^=I6VBD^ z-f-|lKCy2ptQIVa8%_j>itw1kDW>|wQHbil;wZs!rxT5EWQwXdamulr=($kcR&_5L z7DXB`f<%Kjjw@TVU}bou5l%q-4bO}IAR`!14BGD$RR@RGLrvH_dL%o&wQ;PmEXc#mHT$<-9K+G^M{-FeJGH+=F&mD{X14*-{c`0Mn^47DDULUdrSRQI^TH#IF+4(sRFBqy4qVkc%J_L z$9$^W{C~|}LyILGYIY)O+K3IA1i@bU<}i3w8pefTj%33&W1(b3jCYI=q4JP<%vtr) z=BsdBWLO@>DM|c9X(>|5#OwH~S2iPX7 zf&Hrbi(lVbOQ8E#^%r4xh(G=^-EZn55wg>+wi8k1UWs6tni2f+%D!<=y%vNZCONj>q> z>{-`I!DCcbe@UzThWHxkF|^mb=kTun;$M_LMnWTyT@8IG6|W>*buwrLw6$|l_zRDF z8BDc=htX6i{1vBr=2M%BznVRJs05TnIO3oo)V!Oy&|v$$X}5@@f`9Gu9X60=EyASr zG-rKGS*#J}V}OlheEAqTe#VK1RWX7^;bBeqSrR^Dxc~U=H+FlC+kPFrMvt%q#5Tok{X{4qGPjkj$SFS>3VOFxl)-~L2!V9W#0 zUQ8(Lr5hrO#)W0>CymaWDSq1IhShxcI-LuAVE*$+)lC(g-bWWle*|c(cB5@jF z)7|32cqCX2VRT~$Zca`#P?=YrkP33!46_Jc0hcr*y-LC51;Z};h5=OD}bBswK#gZ z*C^m-UJZ?yd9|p=)Tz}#Or07QKXqyq5L2g?g-@MY^ar+Q@|gT|B$~;Ow*Y4Lq?2i{ zbp^}J+fVDTsg!a{i21mCAHT=a!{FWd-}Q*>jLts`Dw<1#iS|JnovVzhIUDR{AE)2u z!S-=IpWbhD8w*U_B5h08Ij%)2iZYIH34Naa9?ZpmAc>UB%X&ToF^i>$XR!n`+r{z^ z2(%I=$Uf=pZ+C&#tJmdy@L&J^`T~inqGt2O(_;A*4&JZ6FX7a~(`vPbV~^9P2V{&2 zoqwBSQB0-+8CJ?R4l43ZcXr@Ry~?2%T)m__yi5P1+oxk96L~%l$#O)jYMLrSO@ct~ zbqtL6mGdIHx!dsy78XJR7f574Lt>ksxs#+%|{&! z;K8sf)DS!_=!rvsCQ+{8Gs8wGb8wj?2qNlc?WPz)U9JmrC6tll{_gv|c>ZS3T=* zkgI>ckDDujd%Z%J>?8J-RTKLtevmvU!UhuUQ(gKL;Nq-&$?W5V`tSwWK?N3@VD>m& zPiNctI{4q$N$$t&>tmDL;6gL@CYpF8@9f$m!${F#Wb9le5E?;N$;?S zoRt}k0+z`us=2?QN|(AYTMR;PBM6R?vL9s}zS+K_xC)ISLB%v`v;?WUJm`;KMp5}P ziVCo-YHK5i>W&H0yyTz3?p#m~C1ur8yRoYp3l~T+>CHvcWjTdnWg72e(Mn-af@~sr zy9CS6LA9~*)@4}~^Fm(w&HuJ5J5mZaisRC?z-?aY1@HAo0aO0jbdERCRq?93N>=?Qr;ipqOeN{$cl zrR1EsBjFv>e5lw|=#&?ZVfQ(8mHo5cE8r3|r-@@wwXonA*0p`G>_jrRfUc7AD!(8! z-)+_h3ejx`RLrc*u10T|YCJRzeAQFk@K-+}xiFL8X(0b~C2|>RNhU_+y`x4oJ*s~( zj^16#AuZ8db|gtg(fTXSnwcL^YZqpjY*2#EvH28^CNP=JI#SKh>+&8N33-l7^f6&l zioUxx*V^IVN3(M@aZJ6D)0n;m!k(iyAEkUW^D>pEp~p{enle#q=_q3LPvdA+r;tSN zRm5S?EJFFJMs!ymf-Jv1QH0kML$I7@g*W?R@Pfi<7FIe*4<$K_la=(7hNW6vQfpMb zBl~{3<7ib2Ky~Hbk5!4}wefAIJceMW`3dWFblFjhrx6`Bo$1?XLcyh8j;G0w!aR*e z>o2;RBlhU0w~Q3WairKg9k0Pu@7UHuK8k22C)q5dd>lE=P&j5Cmn(gjn#o7g>{vtN ziB@?K)3FuLV<)qMy=OWn4Ob0C}FM=OMsGibS|3bawDMC;GPSIp`xr7=t?Yp4Td{etmyCnsy zMjbJ=X<|G%(NB2syxcYSbocJJcGBwH@r@~=IvG3p(BQsFgsvq)HStO+ zBjKBvI_2XeEYD8k2z`iZosLj~Wt>E#hy>y7)(*5%y`#!ssNP;Qg3gs7sxsXQ1z!sG zcRw{A=5bbV-**g;wE7a~C6dtkD3Ol{OZV}?S4FmqdO3Ck8Fi`CSXxI)qIyssLvDl? z*GP?2mvVX#zxnr;+;4cwsSk@bVI+GW^J+l9`ReQ}pmx-AEG^8FfJ?967{gBrpyBgD zj7i=f5Y&?a zx;$z_#c-Kq;K`Onwy0--0n2ZFtN1E6`H9xMEg4{)ywZ}lpazCT7jz1 zKz_}>s9Y^cqgB+s);=dJr3tm z02d8UJS=&^PI4{CW3BBXr}oCGzXr#vrQI_O3Wmv@!srs(u0Ksy|MY)eXG^8ejN4hv(@v z!fxyAhQueCiTL-$dx-X`ogoGKNlsb4KLaJuwTVyyhlK6$(aYf~WoX$umni2h57@RnKglc%%J){L1M-C7T-q|^W z;yEkxkfQMqf_U|Z>EbDPm~OU^B3^u5uGaHl{<}1v7Q%kJpKpZ@L_!EWPoEb5o(JC_ z7u)&fWjX`dZ>zG%%3>y`J-}}4imWG2O#KFHSJyg~f;v)7bDD<0M!KHAtk&Db@+;gF zuFzn1zj$~+a7!e&T0Z>|JS^6mZ6NE=>w1n5d4)#4`EBt63IE!5;aC3RKsK0018s=u zwZg!96i2!4*SMhU&G@gw^k)9jZK(e0 zKlMZ(UM`R2&6TBkt`1@6C$o#r?O>siG4hijpg#<5i-0;Q9Y@D}BRfcF$D(r}#x7>K zI}9miS#kg=%1KjC)i06iYj-trcWarKX0?57w0yjh3;GNA-lAg_Pn_Ol<5-H~y~9!T z`XxP@q<0$Sfn$=y#58a?i*(-3OQv}vu!!`(loltF_BMpy@K*s%efM>sS@qB7i@2dD z*JwM6s<)T@!jYs=Vz^vroLKlzkEQ;)UC^}nNip#8WB3V)&dG<`q8xOp<;@fVp*qI9 zSN(dzfGKSq&C8Oufy`cbkhk8x7{eT6rm z3Si3U>fxRA^DB_K?UL`lTu~Jo$AK8JPLHi40A9T~tVxQNzbXcag!l zo>e4Lttq$^v2k3p$|%oRo+8!KTz(#`XiY$Cg=+&%qbRRG$=Pb&wdjzVa|Hm(3d=kX zcs4YjLup4b&k}MDY+DI@hc%FZ&)$%aF#Avs_;c*E3(Gh}3fUmND_&lJ$-nKBnZTHM*nd zuwM?V99`DWeu8>;xn^YP&LYjo$|K7*K6yu$)w*r=laz=2<^JrEBx64QKrS>-&1Q$O zB#n3LqO|hPOOGm>HCJGbAZWZE7%o-aT{OBGsANy^=VnHCgij*0oQa|oPf)^EKtBzT^1?eszVDEa7F%8(m8nA2B_$?5&#w*p1UI?2j}l# zO=XyjDCjilhKmkQyrG(IlW(Z1eFBb98<>P+6deYBjI6@}F1#uqTh@6N?W68CllFXk=9f%NZ)`xF7(Q9at2A>J3b| zp>l3BPpGQ%>=P=?f6hR}f673_e_qeRe?k|)e@bhWsz2f7e?kW^IDLi+4osmPAEARmz|OX83y$18H7VtVTvG|iJL{T;ZQCuUdDj<5}^#a!uVMp(xh#Nbfpch1RHEolqM|bBuPPll5;Z zUDceb!nZpu1!|VX{#OsF$L;pT=-S0fdNtRkr4BeAaMF-BzYQMra#8YW;o~*#rUoi6 zM?v**##d{!<~(vs9={Qf-hOLA<% znA3ozoto?^*!V*AYZ{wpY{w_b*X_fvI6CYY!Em}>(!{}X%_oGi>h2SZ;a}aHqPP2- z>tB!nQ78eQl4u3wAza_8 z)e%EyiMkdF3zsPzubnaQNgSm_+kYv4otm!eikxiObTeBl3~_fgwD4;hH;#_rxcqjV z!pP+3NWj5O}$q-icZ}zXvhv`GaVGP-ZiC&(C{N+n;`e1z*h| zz-BAEh4uVj?#${L5Oyp6=N|lDuYl0=-xnMA&=1pBK(&8>bli`tjd;!POAzoXs={>k z=*%qc*Y5egc-jC;bg_I{ufB?!xd9;CH6ZY}sr!htSh)w?$R-5{e!l>udb6Cm=lIi? zM?m#@`m)^ov2^dWpZ*R~|N9!yFrF57!t#Iw7efdnxV+jP68?GmJ0$pK=3WDymXJZ@ zX|;NB4*dMEcyhNjo}U&=_ikF)4x7cl0qUZwTRZ|1FKYUHyIMW10J*b-8IsF6tdA7o zVPmBLpnd8RRA$T7bh!eAzI%Px0D{jp3qa`m>2?YUKK}*?JqMV4A~d9ZFIP_h`$U9> zw3FrPdHxIu4Y0|Vt0kl|u3mnFXo~?@w7(Zf1e+H~u5Z?mz*|u0KOoh7d-nt>&@E_$ z7vUj8ya+yje%by30U$vFmU6xHiyzIIRg_topu{T*m2=68sR_WQ%@le6iq zZr5o(;0yroBmpdne;V(K(}s?9-|a&Ys32+438}URbZgqaIm2gEFd#ULZtI|6Y+gD|I!Bccu=s(7KkM*nSB z#z`UndCi3<{fE-}SwFw(-|wr1*r2*geq-87btTi~Ymbd2JQ{1N5j|xHME;dSxhT%- z*lxdE4j^)C)yeGf+KmpxzqqGF``SJlWtyI`8d1F8`=vrf?hJMos%D>6&z}0>W4BfcPK(VM;kBq$qa#yU{ zHyEKMs@<3+JY(*GqL|^F*VWpp} zI4$Ub=0Pscf@?cDkyrAZM-P@;>5ufYjnEmaA?NUMn@U$KJ&~gJ)z#}ks%QQFqyF8V z>0S7Wy2OaULSpWAOlTo*ze+3{!g`?EW(=rJDtuv@&Nff`8QDIWZi0nw{o#hafp&5~ zVpu$MqwiH{7lrTg22(hGU!HbIbSX>^e7Yr#jQH|5>7h@wnvXa=sB6UaW{bPlk%_LM zOsKC;LUwXZV}ul`V>df71AOyWl6Q@akSZ~L=0%k-UoDzO>Wsx9C)v?QXrGk)7;v^P zct%36^2=BjkR(2&Mpx7Tp*{20IFbAir@kt@IQ!M>Oy=-786%avb4H4ckTt5__~woD zS0pQ*$p@#S%tzZFY9|jikqWKa0Xzvcozf4V67HzrO1C3`E!mC)xzIr=Gg?7 z2Bzz5wPnoLL|G}8oxzY?s;=JJ0}aZoIV=fO;33K3`6E{Wa!x~|mta>IoA8*6r2olc z!%%KVdAT$B+8hEinqyF5<${@BZ?!~K5byV zwX_a-IYO*Pj~{NRk9<%OBT$F3>Y7d>||%b&Q{WhBUjK z16V=vnhZrsNAG78SjR10JTs1CPw=tlpF0>@J7$Jk3JWXYdXnG`<5je zT<@LmKqn+Wm^Tf$2*_W&1VqMtusrfgMcsr<-(*d6PNOnJMn_q##l54jw{nBRPb<)**hnpWnTH4Q8vSr}=CsLdkbGA=ZnwW$b(v1>GSNY|F}d7>SILG(!ghZ)mw>qe^=cIu$!QKi zctIdB6vv$MW9`Os7>T*s0scmv!`nA$-vsBd!sGB4C{y=JO4DkAa}oq{3((DS@@4Un zeyW{V*K3v+x<8qBM&+~vM~ZA=A23vY_M@TPI4OOys+)IdqQ1{U_k!xu3(X6v-@h(jxAm^6<_p)YRdyv|VJF>m z+)k66MUrt;(otk^Dss~jI#X}qiN$5GyNKEXRU18?QnvfC+*L-&*h!r3nYV-(*A16s zx~nAPyiYPtg&V2fPFPuFrTs=UcQI*F_z3ReGz#S3A||h`4CD^$T14MTnq@93P&(>l zEQm{y;66?xD1(fu(-I(9g3Xfzohb>H!$yeZ@D;7NG#zI&Vfqhm@Pf`p?ZW&6SLSKa@oD5Ji1io2$Ss zA#eXbZ*SVAIF7At|D$+LWp~Fp=OY1*3{Db21Cc|2@e;NGRd_1Pj-h`2E6D=}ELnTY z`L5MnnTd7Xk~M4%mbT~@U7H-j?w%(<{n`Ahx83;~KW0`E-@IRFe(i0xt0fxWP8Qg- zb6l=*_gv$SxyIdcjpK4n{wWmF;MH$Fn}Sg77A`XuvLn@O0bhQzudFPz70$(9)nJ`>Wrc%O|(iy!uuA zmmPGU5j*51Qg1&4A*Hr|GBSv$>ifDOSWNRH2uLE5H-%%(@K_Aq08o?xdi3h(rDfo{ z72MVp@!+#-(;nZJ`uC7Ilz`=!bE>)!2F>{dnn z2(LI+y8{Tl+bLV+~wl`Px?w%L=yLN9>^tfTqDnvzl zu`@)Z{tlWK1v&cK6-J<9mU3sA`ierivY6AuXmV++J>-Uv)1F%vB-MtqWDo>@478W zQSyF+SY(&-!tSxA@%6@1J@1dKe)d4ZD#}Ie7Nzg=?Ty&A%9JEYT5LtdsqSANL1;t& zD(i6uN=atsv^ticIadgjs79#95g<^|)NKKk4CgPPS|abO3t9Ona-#bZ4L1{WgmGRq zD~nTG$Hq|0&lSyCZcMG44LEqA!IJx5EQ>t$|Y) zR$|)`y4bC+aZ_$Zqv3g+}o^s;adjT{3$=(Lyf?lcgkQtu&OMa-VC5;Yc+# zn^?g?)sX%}$DZvP0)xIs3Fy%uwOp8%<)fVdmqa&r3eq=1Cd>k>kY?f3G@Hg;rxeOR@hWxwCl}8fxox^}9bfHv!1%{o>%Hd|n+~sng2Gk)|KY z?dZ6oF?prqDstK+acn)G9sKllJk>0XSn%ntw{CTuDtIN+bip|-$~+n6eQV(p3!9?; zGD@qibrV{&Yu#gM%Kqs$WWjGx6dla}-v4XNcUPPHol-cX>Oz;1YG;qy-Aq-|1=~wM zf{rh**WWx&W#&FNN6mjrBwOhas`$ znEXC@F$%9^_zlWQTKIMLjICY|Uwt_@8OO@@#Uc&PZ!TXM#cwWSuG)Yf{;n2K>nHsG zk0@k*ohSEEMDpJr-3U`cb0lRVrW9gs*X-2)JrUI%@|dy7rN1%eF&8@0JstUsQWB1t zx{JGBMiXsPiEXZzYB?1pQ;es_$(z$uWAS4>M(Hj@CK=EATk1Tge>2hGU6aIz7G}9= zS(e{D5KgTYW_f?~9f7+)d3{=SsF*CYZ0e$g%xLLRD=u=2Q2lLS6uIioBdlB{Wm^|@ zD$i-otB=x%!mr@FmC9u~I!%t)x2dJnB~ZTY`qrRW_UV`&#y6DH{Edd+sH>K9`>1tl zS8Q&1GfGPI+wTAhVb#k!3YoULTZ_2XyRG_?h_a`uk{Ld;RnPm4dHqb@D zzDBq=9bH8`sk>*&IXTj4RC{RAW)ni2grPj%>hl3Jf{?C0ZTfW#V<%i~6Y_(LZ4aaB zr*TY@aBNxSTu&Z${vA24F4Y*?3WU*B4lqSt7qUR5Bki%XrHUc0D!PBZ?QG0As!NrA zNB&ehtbc=~{JbfuxBtg~{nzhMPZR17Zk5EypYwRk0*q31>&)+KKQe;WJJ_hIb<}7NxVf)%Oi^_&(fCb-pL?$Hb%(dT zyDGQ0G><6Xj7!HYJ^A!^H4^^Gf0uME`#Ws@yHhinew~jr_U~1?3y#bWSuVx^Y0eyM zM8A5N`s>wphs#g3Ww@=T;P7`TutB1@xljxH-nT@PUKg7UY zIeYbEl8v7gBiWVRsoL#-L{u%U2do~~2ux&x&NEW|>}JN_{62r4tpC}UstfRjxLa>l zyVZ2H@V|ST?R>S=Wzv95dzDb%y5kU=WxAtGL!>!HH_Tc@BZvlX*j+ zZVhsX6EzU`j;+sXM5!7sQ?eq7<_PToeD>=OCQZxVL+nRZCP!4X2ijZ=4+N!KYFr*k zQXYjR+H32E1^y~i&2f55Hc!(6!$*wcIPJ|@HlQEmB=+O*Ur2?t#3h=SdkhzU=InSX zIEIxUgY`Fb55cMChQ9%>aWDwwI`_JO(LDY5)Lw!#0BcVIT5!#b8^bn}GK7s1gGQY< zjX_d-1KJ>In5GV}oRS=8899w~2i6Bk++c#EZ83MX#oWOb^HW)b={qi7xi<@!$-0{( zhdAZzBjQN5KHCZ>(;QcS%RLXos0jrZC#;1j84gRF(pwgX|M5F_q96v0AEZcQMBM&% zyMRw#R-0co>0AHur>p1n zeBsS3gFkLo|M8ZVfw!xd&D66AOoG2kmQ!EuRodjQ461C}+ z%sTT#9>p#ks?CMM9Tl~Dyad(vErz3Mox3JiHOBpn1h3>cikfrPzLcwta*?)~C#O;@ zfa^L`j5;mVLblV(ja9eC%IsRFl8_fU=Qy2bT9CCcAP#omQo`LH^y$f(HHsRmJQ>OA zpoR(@rz#b_q{u%V^6g5adeJD=?)$(Ax|Bq(AigNB+oU%PNPnqafD$zc|5RC66j zo5h{1tXUdwa))*CYYW5LSlez^b}{s3W%QDUSr)y*ah8>8$gz5#h}&RYuZSC5_v(!> zy6)8-wJ@sA_>@*&h*YtllbEM}(=n|5vob;3x+I)Ms?QRkW0rOFr2oh$4T$NWA6)fZ zm&epo<19L!>Iep=qn76E$VSXVd3BZED=b`(m-~8wr`prf7CU#0W3}GRpXdMaW}^>k z9M+QhM6TB`oGgTHQE4pEUW@A_UVSeet8A)?%P51xYpIdO6gRR?(@2Bv2zKN~bA*nu zR}(u|HOS&;t=FOv<$S~%btyN>xLqskKDh3c9f;sUUd~b8NC{!zs4Q57uCNlmTadp$kv+r}e|I455k|z& zN~t|hzRsuq^5yx#+n`L7QUUBX8&IlTdbz4x3~5mc^<3kS<__!97fLE~T#_VfaP&s~ zrguV#$kC4D3sr6_TZ4MH0_d44qd^lQIin!&lPRDRUY=j}Dl@8lx%`aVW- zI6Ee!FkE4w6`HR6$@bTB>VNf?-e$5}ZTf~M270>MtX_8Wr3d7&@y&Mvdsukrh?m}W z*T37^2>n>Brjx}M%B>zZ9yEpRY7vn8KG{q*U$=1ToA>L-YBK|oYm$pTLbvieNZnl? zrUKR3vq;B}AX0(GS@G$>zcRg>HVfQ13mnFCnnl_JpgMfpH5S$-*HU+TraOCQ$NI*z zpu-xtB0KZ-fFO#R1L&G@?XXhT6a;rjj$0Wv7hgCuCwZ}rnDA={jashEH;ff^ zY~^H6c72A?>L9FqcXB8$Pu1fhu1I{WqE!59S1y89H8wwDB32c=$SFm!DHrwZjpV49 ztGo7aXr79ZZbIcyIdW2HKZ*eb5RF1mjZY^iCfgB94k?B$tGa=!(?^=noQPRII;UF& zY)-R82&f#uL?6?5Pf_*Lyq#+hOc16|!a1gpMO}8tBlBviO- z8iM4XNpPeIo@^<&!aHF_GqixA`)UUr91I%o%s{OE)B~kzv+982vscbfLMjiyXGNOB zdDL)4VCV$5w$TA~iM>$%*6|ru8CN$2HLOK)PBEj*JLBjIF6|ZF6aC3s9eS~X0|E;~ zY$};hs7&7T%7LFHRgfg0cfPNzQ*~;$Z(_oWP38N=PTnK9}V14<>5ec8qQbJ&1mne z-UQr*(kYJS;D-^+$-8#8X$G}EQwFg=ken#G)B(jr`<^qMW4(TE^J7g|4k*BloVdpj zKz~Nc1l(nmzJlJQIavfN=MDzS@Edl~;avM1Yc&mSVoLNm&(A4x0BWGJw2< z+IviF8T(A`0M<=m<~>ec7CZmpHyQPs;0Wll{P9E|G2hoIzFx5lM_NUWPg9bQa$isBOh$ZDi_{i#Lt&iIT7 z2Qb{y$aR7PU!1PPvt5f3RKF-XehO2+{r##^ zK?}N($b~^k4(wRw@bp%%=@%z4g+HDwqkla_+qvA?I4!6>`j7aPY-Sh zs${sUh?pWJx*G+cD$eiZI`V0B#u+MHsEyTD#u+BuJIwp;$D8-vk2UXWg;@6XPkFUm zHink#9P)nDIpqC_bIAKK=aBc~%^~kcoI`fCxLgMsE%!(0k?%*Hk=~CpBfTGaM%wCe z_EDsVv~*W0uH^8J`oE|Rlq7w41#74AKX|l_2d6-SIcVCt#M>=7SNG$e358Z)-3q?fIO0x zTLqn>kNMGo&Qgw|d-p_|iQ45{Z}&Dp=H%Un(_R8iX-#xp>Hs6FcK2eEc_-Tij1J3K zXBRY~xqWbhyHQPOfVgb`_6=SP*2SPV>;>v)I!5#s9l9rR7kn3deUDgW!>-Qj+z^p= z_iN8EQ9Sxmr2puB7y01kMPz4}@IHsBL8^wq#f5r8TQ`3<`t8%6NSY_&|G}%tQ{a`z z6&*>R@mN~S(IWkcV*i&zxsKy*!i>h z*ZHo`3t1QKFw>{W#($pt1Q4s4xAk@aV6&Y5+U_>?#LRzu-a&%zV1T!ofCBq7u)dE; z6c{m$T{O&M>Q5F6`#41S>1wf<>^vB=`?ZD<&)#-B`RZ+9kmvw+lirKs_0aO=+1t#g zAZ9mz2E5L4<^5a(D*R?LoBxze(H_}7tzNd?8UVoRmJ04qp4ZRz%r9XWK<`b8YALnP zG4?CzMfH?de$?ntA3XU@1IB#M*XwV7O#TbM%ooH zoS28{(3ll?nPT8o`jL9s&>Zazs*Dym!iMS?N<^GB?X}}GCz);Is0c5y(_KibRj{df z8b*H1NSN-U#2`(Aze<)%lylv6 zQ6_~W(2!IJwlSaSju8XnLC)k>um}Z*bYC7(B!$=OhQ#$YHGRNmw7kz{N+N7Vi+VLZ zu_(mC-r+#Sxa*DL+QboQj#`x0wTz?qX4nr0xtGY#;Nc^(zKDOKxR|`svmpWFS)OL( zXxJAyB!IWT7XmJ}0d0UK{7&+unG*onNl3B+WlL*P=6=vP)3AE85H4|~IU1ZAwo7X1 zQ+EWVT_?M+EN35?spoHr zBpoGl8h>abmE)D1OJA!Ob?JBYs{E9eQTRB9_KXzdm^%(ybZVpI>9wYubZo_#k&dp+ zX%f0>KJ9kvaq_aGG)g{p^`K8rb2{yEM&UuZdfsnAG{(jG4*#ejH6@}qlo zypkQSjW2iJ8%<=dJWeUy=#5iSx3XhY`&(7HP$YkvihlK2kBoj#47<;a{ucFm^>sdT zRsVNMOFB-i=t_-Ja+iY1U-F-$YGyf=r@cqftmZ%CWMZQwCO6}~bSqltq%V3qbu-+! z>Q3t?8qMEPPU>7lF}7ryxhgi}XXj7;CdIoj-K0?@4-Ef?^p4W_x6fmZqdH1sr%amS zZMpxmx!T)BRgGvzdgHFvIDPY#q*}NgXApj=JW2swC|Z9bh6>Ah$eIPO5glLmcVz7t zvzzTFA8izQp*2!1y^tKGE?p|B<2CD?r8z4;$JG{7vay8a7N2nZjzlLrVsE02VvMr< zL5ko+!|^iYR`55a^Dd{-NB;bA3p(B|w4=o@YQQ5h85&7QU1 z{bQ%}y-4*c(tuv9Za|X2-B-@J(*ig@l|`7ogFhE^z9m~>f5)VMja@vrU00VsF8=d8 znbs%N)Bd*8vKr{(g!^q39>fjHH~p+U0g6a*7pso6X{*15Ku9sKeIY@sV-naDB*JcR z(Uh{XaFHpKlGD&vM>}9L=7UQ8%p;2^pv+`&{T+Kf(15pv9^$ef?HI;=Re}8WdK7!s za52hd=$HfHO27VXmy4Wpjvn7aqE|BU*|<^sGSloy@m7VMiMvS1^! zrxC}{k#3jC09PhRva>-FmPs`zH%e6Ri;vtb&$=RSjI%we+!~c?tCjN`@iE?rkMc%k zCJZ6P2^sC7p861DqJ%_pU~$4pR6{Eq`}_cTK!(2rs?E<&)qRevpt0rzfQgm$|ByzZ zW>#TB^^-{x6*3+W&G#@9ryrDkukf~r>l;^H7zbB@H~5j<)Q$v4OpUx(v}#ing|e8 zQO;ati6e4E$6V!=P~eUdc^cytnilT#Cfxl^IPOi(!*%;YtpD`=AWaIw5)ST%TLo-K z-U^5UbQ3VRMYNzJn&4sXmUhvAaG>&sgGJ$Ep!!eTK&bu`Ga9P@)a{|M0sXzaVI7Yn zEP02H4X5F(1kN56;JmDv9F69V_$&Q%pw-pPNFEN(EH1Y`+MHzXCBJH$9@%FN%9kR<|8rmqJ z8iXWWCW*BKwmm8q*&YRpngd***lEC}h%9~Amq1S^ZdJ5rZXqJP+}BnMErXw%TS%kSiuRKaoiDLh4!13st`xJSShE*9?b31~1A+1{_i6Mw%B354LFz<{KO^q5l$ zkf*&h@itg~0BGii01)~k0|k!%un&G9dkzUL_n|QYDEvc|YLBY-1s4q#5IP6t&4HJ( zedr^JtDR||TPoG&@*asJ*SG!uscsmidROSb{uMtGlsj&^7K7--Qf0GVEA`EY&7m}R*1-9Gl5gp4Ervm(Z!L=4O*z)paAT3AQR z|H=VP6Vxlidf9@McBNC~LeEn7128UC$AI4$eYd+^;2i$W_vv5O7l3uRKz$!%$1*Lo z*SVMl>U&aw(Yi%?a832uZ6z2z(GU3hsxK|IlV)&?N&A5dj)p8of$9EF6qi#Hrb+aP zg!Mi-ji8vNWVpPQU*AGx=JIl%9uB;|p%jc4ss6*|0N7kWV#6^JNdDA6Z)=|3PTtxl z&*E>pM&V}l=2AdI-ZdWBxnEDz`*O=t>sZPgC`lCg^rN5&Z|-EfUC4mwwOZ~{h3@RX zrHX7ruDt&)`uFr*UK)KAl||#~03dkCToibDIIxcq3Sa$uOdX$9uKK}Ra!Il&>Aqor zi4D>?P7}Xvm)9c>6MNH?Ah53OKwqGz&EO=kIVk5)SgtyU0m-)4Bz;fhN;|l;R9lq) zJQp@J$(L;h68S}Au>k?Mk;SoYML6zT4wgSQ$W0#-U##RdK~0~yO@#IedL1R#s6o*f zKA>v|{U#0#pzi|=fZ7QKrkab>08lfOwMW2t%yq}Pv;Z_s1&tyQ@SZbZ_A0` ztp}DW6Q2h;%g}P0>H_FG-(h*qnF!Ed=IYUHX;(i#u!K}YyPJ~fa2;Sed4Pq!BUz^N z9$}#507r8iUPp-ueV#^;)K!FBO9+|P<^2Fm-|7pyp`d8GnRef%235XOjEB=Tq;yxf z7c=9#slH1bBEconqF<$}8)2*R&v{ZUoB%VsRa%L<^u1o*vW6L{7m+RNMFrgLS|y>>)1v=|Ki7Syx9+gX!* z)H7>RKQF%di`Dd7Zxm#mtQ+_x*YV9p`9jf2MX+Yr7yd&ay z2S;?GB-5{VYM|HsNx$mckI3!Pdf!|cNIL()7F1S(3rZm1Oc#Si(XfDND-%RDQV<}0 zWmK^Gf-BvnyH{au?ZnmdNuCp(FSuTgCPH1Z*`QNS-sz(ww!182E%V z+zO+fol?!r!CFk+SFuae?Wtawb9%pNcWDQmD6d)LK`Z=U%G5P`|89J8kE3+=XUa4a zcbr~9_^ThLx}^kL(dJ$@^jk^+;}yOzCDXnTYo#^Qe`&PVIA5HH&YN1}jtG13O0^qh zz{opcDV9IwJDxjWy_X{L4P>m?WuXn(r8Aq##-ZPOlqx0cP)G#X`mCWY=MTqJHoxp?MeBd^8W z*FSF*s_vie&srnCtbEr|i&c*5M@(NWH*Ok7`e-gsp-{E2oa`g#6)8UQ zLIFP!QGEl0Llt2E(G?tLpW%h#hP?k4(NVr$U5JjaD7|2gDtP^{Gc6h|4%s44d77}l zDY&vGw8(?rTB)Ag)Wz!8rTp)jpe90gw=2Tz6_icneI4z{p>b>>fe{k-MY6vcDZZdPV^5f&>Su`llxRNnl@uvKm7w3 zty~o7)&{I;j=(F2++@!pRxpZGc&Aa2#+Y~4pHnt-C*2;YAuPhg#!lo7^LCNWi{b#r za9Da|m>QJOcU24=$BO^q$Pdg*%76H3`%f&ojn-#DuNfZ}>NrV)*{wUAO(I?x-oBH{;{<0PnM!qfeq^;iAtpgnV)DzKRQ zk^S{Wv^hP{TpkerfASEsJX9L>abbw#gb}*AJJuHcU$36Y(!a+rh$dAY9!66gU0OR&+u(Hw~)tvAckcN~~I)I*WQI1t+r zvm!4ky2*VYGdH40EWvWe;^d#O)z87QL^#aB9>q+3P{pxGQ-)1zLXp@J$>EwbvX*Bl zM{>Ai=GY!P$M)E{!{i~SVHto&K{W**cJ+L&w@s(~YC@4O=`^It9Sl$IU_x?qnWAGv zHnCi8WXF-{R_4&ZJE6#-LGIGS=hz;eBWIJ6lWv2sFnTJ=9cGdoIi=%KTGU-c?fTL( zKI}UptB^|#QkP7kNNCjy0K1l?Z%R<;_A|uI$EoJw&DW{+LFaoxPkfjBHQ4m%U@$>~ zL7D{3!V`k+tnotWi&ax7+$<JeEw3|*NRx;8PF>crd%=VCz! z40nf5a5%;07e3DOq7WQ?Lxb(I447@KI~Z&SZeTKZsSs`F2_`SPPcZ#~&8P@zoLrhs zgydXW8@jQfV@xQPJ0igpnXlNo(=J`WL1g1}X`9@oJ4Lr^r)G_8)nXutfWi;~i7p>O ziRqUZ+!Weco&`QmhVeupX+yLHZY*X+}YCQtJ!J$P~C&J0gmXp{k}F zjv^>*{bKk6sE42ku<8&oV2a5bTwHR$j}Q#jpj3-*a?2v72vODumCl4>m?Hub zV{teohI?=*OF0HYm>{eL;@Hsw%9x<-fdI7^NECt2EoM z8DD=I9U@k8a-_~GoukQUofF|>o^|zI^d!J=ch)7s4v|?B#iF8`k?d-`R%UZ6<3g;Tg-lr0Bm! zUK8|=CH3uNx4Eq&xI7gEMYK268yNl>M=W^-VW!)`bWC#w9l~gj*IxnNPk%aD?xq`W zvKuZz8G5yRoPV_nI-Be!-ezMJcD}L=xm-Q1wmZw9^X2-*HtgElJX;3cJ+5AsGt0m) zThH#zR^RM`ZEdq^wSAl~JgcDV&1$!rt`=5-x2wn9kIBYPdFMT^A18A=<(K8;y9hgZ zuuS&LcJkFCl zb|HUktist=k*)Xd7f%f1CRPR>=!gj}wEOl*u+6LMt} zboJfaSQ+lM$kF-CDx6&~%a;*Tj0Jn87E`k(sN6@)<G^VVWWV3BYY z{Oe-%U{ifn;Kk%Wzifl9rq;5{mFRN4oo5|Um$NA&RHtc+6)0b3XSGy-0GgAfLcw2Ahua^GfYGeJH z8*BNk>{(}Xi)`L{-Zy{xvat+lHKG09L+4 z*o`NbzH}couY%jIe5ruj-DLN&wN#!zUL@O!IH$%c_;&tvIaxq}-Ktr;vk1RjJx!Jt zYd=41tH+N{{1zd%)xwiSN_XDo**^5ka<`dGt&(A7;C@bayG=Ds^=w0Ly!Aq)!8Z7I z{vXeOp8T{3ZV4VW1wup7Nh_KeLHa5(DtRL&al@mf-Qo- zlgP3J<;I77lm@TX_V-v{Eacl~p+rt33Dt&_6U~|FPNE(b1=aT`MLuVL+hf6d2noBl z4or{CUYRCukg$MMlz>z~Qmi)eG}kED6Wls@l#-CV9RcBwEU^xqLEbex=9zt9h%hK{ z&Qj4RKCJ=iV=0a8gHsO46cHR!w>TgyME67P%diVAJqki9A>%^ZGP_?{6xoN&EUR?{ znnOi^kw*j=c|P!bKaPzgFRVvYGBBW+W#?u&wkftB6~yGvG`9`G59|ZViY&w=mVU7MDmoaIiEgmu zG{=!|BnQW-d`vU=8_FRjl8cd?d92)z$^Gjb4jFBX4r+FW!YFe`q@!Z)dWkoA&Jme=<)S_ZWoV`ioOT156PrlS-R)>7F1)nrKfSqC5=a(Wadn&v(! zeEa3m>d*`%to?Yt3J;hE)+pyLt$s%Gq63=7nxdjizcncW#{Ml}33ltAdG*nlP zGz%$yOg?NQyJc+`n_89}4sr$J6Nrg92Z@1<`b!zn9Ky8`4QxT{gl_)cS(&mpCR0Iq z?pI5_qLsao2$E8c%S?{QOpeUVPevn48z!c1p?U0b8QP-1-w z3)vj7kj-Js(j2mI%pnWM9J;>CM7@b2bjSf5D3U`OMd^Fv{lF%gv!4WuOtaph#6P+H!eAZP zc3n^eH+Xov3|j=C4H`uN8kXPeDH<4NT!g<1(x{BB4b3I1KDyhI%zEtxwy&%xKJC|# z%9wD=YE}YN6Z_g*CLFMps)X#1Db3&4x@Ft~u~sqbOwNQo02(IGCz$~N=Z7^-IWd<0fY zlYR5`Y=l=$Mg48hu#BX4$mv*>E=&1XDQmuLjUpvFyOFfGs=4EdsbzL5JrRzjnNd1c z#x-Ny5v1CFZY(WQ?IOj=sXk>St9z-HCPkjQbO;x6u15Dl?C8=6u9d_bHsEBf6}1v3WI^tADPXLK;VLU4ag{-O25Xna<~+o?@JS zWH}h(rOry|sUmI8R)Cc&2HG>RC@itbSkDoBgiWMlQH(;C$k{r>Yvc z>cEzY42Yh$U4p^xCSo9bjM6;@(|SrabEh<>*bHL4`bbn8bwun!K};WWCjp%U*+H;5 znt&lAWMX6Oyk!vOBBv>qHF&=rfJH}*%i##yWFxIVTr=06O967t;tUjfPf!h9PU@vvG%o!4HPYQrjE&2zt7wxnx zC^BxLAlH}jHyR=p-dS<-5&h)_e@;A50d4kvup~_1IhX}=p=R_B-4E&z73hGJx#fO^TG{MXN_gh zCSxpvQ~kdBo8T9jG6=BXHR`{2u6lG^WvZWN-s9wDu`^wG&=u&APxG%&-WEfy)gR`C zLKE40XOx+ccRXdX2lLw<@qHiOhD6F(vjAY`4n%*s*Z?Xoj*{n|lEP;pIBu34G1>f* zWZ;Z$nY)89bbdtv(tGBmpBWt4$tbb_2 zRL?|1Gsf6axJHjONi#GpFUE@XhvzkXMs=?%p7gw^{B=iTFl2&A4>0_I7za%zo!il z{v>Zi-gXElMUVhXCgq1O)2jwo_3el-jhG-K7vPB{i2P0Tt}+c&w@Ls>!v;wcmZ#EZ zb&ANE>{FQJ#24X`;DpCZraiYiOxIt>@u?TqBBHSvQ4(Cms%3Ke#<+_>=LS(1-Zy^h z)~n<+qIyR+2GDqNV36}k#0ZDertRzo44ujEEcwS5paBu~O8b4ke%NE%>j$&C&%GHQ zT#y&Y%u4@^US=0V1P zW_Kwt`ZUwlRrTn$rdB_%SL=WD*3%Ak6C+QeO->t8Zt$%WpSi^C|e&EQu#QR!RPeeJ={I|88gz3drI4m79wZM)Z$A%?yxpQr7Ho|`&f zJ-e;+_3!I5dsE-LXb*Fzd|yys+GdTN9a0FT%T!%eAB4p))g^M8;Nw;$tP}%&{&7uAN=D zs$R03DRty?JdaI%PUQ@q`e`2OhB!u^r#U`yx%`;y_Xe;{aBotEf*K^f7?f^i&M{9Ex77}CKK-yp!!*#eb@Ak;ssB~dvcF$ZPx`~(d2!uI_jMv2 z@Ju|`_ikDP3wB8V-6Zb1hv_BOwbxS^g$R8|o7cY?EE%9fshNWq7~PR{GvX&{<2eXI zHuq0Jn5--i2r_|xX+6^zpn~vMKh$kP>IJvz+bOJKbQoy$=%SzkzXHLz+T}q7c?CK} z3@B9AcfKGHQ{93j1@DGTv-+&etx=PYdaRoI*?4Pc7rkNR97^jTTSFRe9W^qb*v`Jm zZgQh~bdwwP&zly!ZUJ4c18mi&Z!or}1$iSm)BBRsfWax%U*lzDI1Hj6S&B;Gk;E}U zk|hVGvc9Kr&k8sw*8_kljMAgL4hZ#j5+o4{l_RhMR~qsU{W7ru(z^CDFs4i0H5ezc zevgZesl6FN2ux}7Q+YT*6DQ1+$b~W@IgBe4X4osHf!@+2W}I?V)p)03EFZyZ842yyaIxD-Y(n$%7uM?rDHADTL{t0OYr$fAQ0#rw`6)SL|-GozCaO!DimW%U6qF ztKDR=7!GF<59UCkbd1SazK#*bUw=?s1F4DvDfbHy znnZB&vg%J@G@Q!q_mFtn8w{<1at{n{Rgt&Dw)4BUd05$4|DVG_%uD!JfvM@MOJ7*& z@ms$@+Dn+%RC|$_A3@<^RjOvJ%^c+c$t*LpV@vD;GyQ>`>(E_WFdQ5ZG%NF?<@=qR zp+#836{6QctEOiaFtG}$ZcWq;AghNx!^rvp2}A$H#Ar4D)JE3TxP;Z2#D@0|rpBlh z2_liv_%z66x4pbP>jTG1BN9o#-zN0ZE%MwoW!Z%#gYk-wIMqdoW{XI)UIIp~jxwR=JA@5W~ z^U~=-L_RU7yxP>U64XA;99880ZBiB~-nei#1Hnfz5d6|W)FtDqUXODBl%}sZQP*b1 z)g7wxl1cdq0-p{w^C>f=Lgl>-*s?h(#_mZ1GM|>eM56M&=7{FWgh5;;?=_*6H!0dEauPi zoj>WHMR(~wY`WTbIB@-f;%1ZG1O+~B=l{Va_1Sw~tft>^?Dp%wU%VGw#LM{<39cUJ z3naSUtfokEhpR*Q#BR2@7&p81X1+qAa&IXL-9DhJ;CB9X?JZ~X6t^0|)*2@^QYL?|uQ%m+j=M=Rd4=PbhHuG+)d%-Vz0Gy~QI6+&yi)$qa@LtS4$Y zx$j(ha?!h+GQ*o-MRmU(wz^FXBn4sPEyXWV(U2o^vwEbK2 zTmQJ^T2AStWdccZnPmM3IMkEdWU61qe|_T~)((7085}!ZFTvX=-90`4 zmU$%4;o8Fy4GK*SkdJyQfckkoUyEM*06d+zX6#c!>wjEV2Deq>B6!B zQsf#td}7EZkDy#mkJ2Y;j$z9LLsNKhQe0tDd{I(lLDpQJ#)lBj!Hb`w3ZJ5jp1Ksg zX*jE4Ud3Q7DPXmwV(uEpkAPCI$%Aoo$pFiuLccUOz~ZB2q2a`m87(mx)s8g)#Zqnc z2e;xb7oyVHTu6zC6>b3<5NrbAW)W#KP$mOyF&qrWd8lEXCuzl2PPDjpjDHbfM*Lh zx7QW`Ihr0Yl=4>?QKEA;WMbPry3j}!7^6n;La*E+&t&lAqAg3lvp8=o(SocZ!Mf{EEORE3nxq28psw zCosl$c@qN92r9W}*l+iULnYEYL{ulkj`SNqd%a2ZsK=Jx@d>lioWx4$O)E) z4NmF1zMtwx>Pu{3#1}YX*mpQU)gvhw80-BO7^uc0F^m!>7#LT`_^WUF*sS4X52LOg zd82;i=9I$)!~h^>35k5eCw2o~Ci1QoT=Yzy$ESXMMh6JTP=@uU4IORJNbjDV(ygBjb>fqNC9sR=Pn%JtZ20 zuO8hR{OafFZnN+oHs0i$?|t`{yPh30U4d(I3Z>?9hu2146Zr^+L@F0x==*%LdjW9; zi)n7|%=*dYcK+2q9ue4o(CmFQAhX8>448ji!ho%}d!B58$$D7=--Sd(>x@E!sKfcP zaKPBPdDvqaDYaMJ=#b*1#?P-Tig2X(XH57j43-Bj-bGhaX8s`rqnIoee<<(jd6^Yp z5?m7E4|yn2@104{$#)AIKUyFX4YB&JJ}a=$taFJ6Jr-O1=q)D?3(tSq3e&co@4Vgy zSJ2Bi?$#UcasJcW+J#o)5B&~3biwV@Lc&n~88UsHyJ1ulF6h9OdHtZg;9^eBpxvq;6ja5!>h8dU_&BQtdH>GP3^Z_X`ZcL7F6J z`0!VVhef@LMJ@&66T>M@{G*s~6o#W! z!z$tzpSMlKL8EaT29f|a&NFfsRFR)Az;y?AG!0pQ2t%mNfW&NzzBFWzu zB4*vYUL4qJe%NAwJ5m-W?W^c9X%(~|$&F-~262es=qXB(n4jkUiHbkj!A~d+DJK3C z;XeH+5)4XFNsrPa!$haO#mtOx=>=n`a+`5!u~F#Y6=eeg^6a(l&M`A8TDErMi3yyD zc0-eb1?p3YdG2h|nN|%6FCcHi#M532VCW}NvGH*)(_&j@>N4sOud<;5%b46%u%U;t z-oS@Y;h7kJQn&oriZ(!VmvmHp&5ZHdz#?UIH_zQdNq7qT&m2{cZu_U|=l7F-ajyej z5p`TPP#U~a%^?8w=r&>1&yz=gvglou>R^}Qr;{Zp{Cw%{z`#9-Sj?B-K)`x3{RT|c zX0`=|e_76df`IQ^&H7kB@i3drW*dL9`~_x|3r%}U6uAE|eTD(^?P|A%A)Cn$|8eF& zZYIwjAg`y-+pqqjIzQUiR1DNs)B_L3Jx%B87`#85Z|u`3smJ+Z=K&eHMD4eC>DY1e z)pWP;zd!r3K6$&X|JB=7Mea}MGkcviu&J-%&1wy7R@?c?|K@q?$zuN9^S@6PKz6ZO ztsg`h{m036CsNycV%flNrr-O$;_4Vt0{(Qd@_u?#AT|3cngNhmuJnuS228X&C^3U3 zZR`CTS~)6ixA9>4uz+=F5`fjg)$`=%bhQMujIH`(S9^K0W7=(i_NJ-6=dvCP>2Idj z;O65%{ml7Pg?&7d;U|&<-|k2lCWS{@$OS#qqPrFhtDWWY8$ntYV7yt*13{;h7yHj< z4HAJi7cC)C{iR1{8WpXCP$i?TeMY{kT#|D_KjR#L4X4toH=1gnDHe_wFfp94LMUBVt0Z?;!fSEdwm_=Hr zh6AkO7?BZ_d;3@-Oerh0S7;9^>?85l`a2MumLJucY7eL7-`waF)dU3GY3D$gr9lxP zIO)Anx2xO;%3YN0#quyzjU#ZiGN-{CB1VacN?D{xw)w=1L|vk;{nq11Y{ZYy^ICVg@s5tc`0ud9jVP9~DOm?`dJrrIeem@A90K9m4N8$a)0W0MgE zoDO#K#eM>D-mIYcickg6d`qYw%5&Wt>4TUTPb3L-F2Zi~EQI8h5{#P$El|Oe`g24< zQ6-Jzqd`5xwhf5D-DSF_#;qJ6VYxIRH+I;J=&UuPD1G;HT1qGSmHs%wgF{DqAzAZ8 z5>>8_ASlPCF z{o)hR5xkLtj;J_h!>ct1=F&j5p(!>*js;ZZVZHq2syI9-u$F3bNs_NhBn; zBmRn5LI2U8sOs5my6WGj7vD>7a;!`DV|RNJyy`~%7Pz5Xv!T;C*6m=m!K;tP?qsG3cS#KWph4-7yEPw^Yf<62gEU#e`smY7}5)*e=+aL!CoISl@5w`S#N7>Oz;Xn&f zWptk>Y+!Wa6`dxyoRe3s3;V)CY_SPANK1ofWF0R@$nub``Q(F+#!++8KOJ*ceByBX z0~kA_fCEuF`>+W~roZKM zm=|v%CXxt+>Q7%@{8M)Vwzcb$^qbv-wm2e2a8z95XNUJV*%7}@7T#tjn%Z`{nXh;A z)zW{OEN9!N$v4k`oXi(5y_fv8YI>RZa_4Q9lZEeXHmi-5h8Ud{v&-K3rWsyCQyK4a zwX{m53cOP3>pz0h3v9f9zsxt@%nA^>xAYeN!(3h2=4RIBo1EA;mY_{+oRzGFaUr%Rki?%+12Gs!pAUn zg;VBP%IRH|1^(n^_XNReb7+fg#1LBUXt1qpD!lQwzg~hKVKHQ!mSKvBNKQ6OYeZCL zIhy@0Kd@W*+^`jBzS#%0FJh}f#E@9Wi;A^gn#dJgD;snUey2nW5Znh|v`| zQ8DxGo@D{1Snc}?h%$um=oQSeQ+?k7h;0(>t9RhO{B9^_wb=JipF3231}CC(yfeht zXNr)yQAwQqjN~Ln;&l~_(yCsJX4Dslc2P4zrJnTbA)&vmL4jS*dzw8+u!rE?{tVAiQA4 zjh+VD@cqp|Rq^=|J5afe(?7AK!0Et73|-E&ceD>}>#$Yk*2iL%A-Ash4VA`OelAQH z+73oxFLo!U0&UL=ja7{WYfqhWo3-}*l~F>TPi-dU5VW(92*K=E5zkC@w;T;GJ9)H9 z;v}N>p<~AXmkOMPIGRI8h?it_#wNrF$m4P$c$8GrWg`0|DAi0hBk8cvzZ|F{v@mTO zu!Jq4PcBD2;C}H3Ns5hV8Yu9GOd^>456#mJEy^6YGO$~0zn`;m&@7*W-#t%$&YxeN z{q4(oz1r-muX$Fruq!fOx{I`HeNeDnR6~Kj1NsGz+P~>{Z!>@V-YnfNq@0H$HZ)DjSS`NP-@Q2u%p+^yXqYA2^35r* zb9!y*m=wXuA96u+OLBnI)B_kBLa#XOsDyySd|(yW9(Gmy`AOX=Pc^+nva*`LkyodI}0H?45Pkuk)F8*!gm09rk%O zvrq6d==C5av-7v}|JX~vSm%bY?T^p4#qG~^PI7w#KRztJ*$19JZR`VU96M_QuU3H2 z^T(Ba;KdT~hE+cI4N>~T%gK|y`o{ZeA6Vzcyg&4hC;N0X4aWL4W$$FIzWKUY+Xr6t z??dPh{Ia#LB%2>Uzd{19Ac0@318?gFW}VmDx{=ufbwdLHbz`$9nigkI*c*EhxNf5M z>P@q=C+enW4>Zlso_K-0^7q|O`@nVMwob|qNE7@4X@WmCn)?U)Lqi(uPe`JFLK6Mc zIvFpp5uykVoi7RmGTC|o4=G>dkaG6&yaoh^j6emjT2KD{VwoK2Im&e7`VGN?dWqQH zje?}O0J(PApnBZ9cu+suwtqFR<6enfshmh2rwI%En3BZs$_5D+GGuP7f6UV|)4H&* z(>Sr?$w?rp&aEMMb3HSV881TmhGgGJE|MJ}qjrcH6>dm@0JxvKDy)*DtY12qhPix~#M#y6X-Zf6PdQO^uP{rsr<(L%HP zv4i$8^=XGPkz0m*k{@+dVMwO(65xxzMmxM3kT4D)tXP-W<;Q17{Eb8<#o@x9a3uN$ z&$k_ov!>=-R+t94nu1tcCnxEU2@NPGIjU5d1NMg82UzXBB6KFMqfzi2u8%!&%`Ut^)sb z75JB{z`d)$f4d6&kE_7{ItqlY^)Wnkt%TVMP5wgsLaO&(U?n>~yEdNW_C?T^#NWZUb> z;!5*M?7>^CevBnH-FTCo=Rb%)zD<5ie)*4^)wBP9s|U1Hy`#MHeWu-NWhJ%re#o7g z+ttENW4&2Tz3tZjx>>!f@k%TI$9y?k{Xi&?D5BxI`j`20Aynuti1nw6z+!1xWQLQ1 zV7*)&bTK-u0Bg$cUwJ;NUW$L`+9_ot+1t~?B<`98pAnK%uOwX-!)<2+6m>7vYely* z?NP&*=*-(qrcd6iu^RB!KJ&gWU;4d{nZc*|*C%I-KA$Z-XOWS5m-T#&u-xl3qY0uR zDbA(!R07gJOPRFCT%fI`5_#3GG274?3!PpeOI>1jZr+uQyc*Nz?3fUTv^W`tR)Qt2 z3V3@`Nr=&O%o3+6^-gr(k<7Fhy)5J&cIVc--Ay*TN9nC@`?UIj9Se0-b~EX4ci~~v z^0IC`NCGWIhrSEnAB}EC?3GU2;(U;J1g&|3AB$aUty~6nU9l*eGy)68$54FVp3?Up zED5V!Tqw2K>Sc$iM6-IDQq@D8!hE@Y**PhQ#5+m+kUK;%VEb2>ImxbaFXDYRytO?hWxvj#R9|SU<0I@Te$M)5`rrnY2k=h?j2o3@-hK| zF<_r^nUGSm>?EG_tT@SECoi-4N}bGBkDFDISF8o_w88?KxjMS2Eq}WWt0Ek{+-c_XsGsxn>p&A94|GuAh~d>6qlNXi)3RXn;*> z*IP(hy)lk8c{?3IIf=7(7V38AnP~YRY@&1euHB<);<$L(6cJxRwaX6ulydTfXgL+f zk+r|2an--YaaHk*BZ{?!5tXrJaka6+kwvWji+;SZTD zk!kO1>Kpuh#`{!rp^HsE2*=R1c<&f7hGkmkack zQ9CoMGSt)uy})DVdRjod4OZx+jsFhV*^yD51;%Ewr7fUS``?FF+<% zkcwG9V6nyxr$%5J$d|uk+!wFTjtLF%3LzC4C_OY*RRS+0DNP*H}p}RtJRE@hz$rCL}>Z*db zI%kcl6Lfwd{jk$cLwcefqok#dycpL-LpDFk3#UpiMdWP=G5gz1CrZ=TGJ`5~hcbO* zu^v*hqwBM0E0_4q_xECw^O~hB5vfXFeZO~rbuogIRLFQ1kxvLx4ObzAy3t);4F5(U zShb=J2+a~e;Iu3(LkAHhxoS~PKHt?RD}LbWuy}n;%u1zMd9emQI@gR0WhU9P_TGfSuo*L51$z@bKfc+7llMg{ zo8)JrKV=`*3?TSLTeQu{eaWIi)ZwaWS3?e~*ggxI=3zCk7z!*uh^RY)0aYSMv(KCz zPlZhc9gAYCA4ZXM;N5@X=O%C}T2yr#qs}%MyGm|NDKuF5O`?a zv{)kYC`5H%tu64*M8P9UUETQ(2wx8lI-RQxD8}+9Yin_$AAr7_$vv{71{B&eoHs;b zZ@E;CTEC`T>|lxX69lM?Vm@6c^F*7wt%ed+5%o09DsX#Pd?<8GKAK}V7D451Qp-+M zOnHcM&~6o24P&f2B3nrr?%a)7g|1hQ^7GJr5Q|75513hnweIdS{)b(#FE+tAx?knv z09`<$zxAu!rC;U9K8~Y$Dh}=|IJU3gSUb*vcKp2IYp}L7dyFjt)?2lPLKY|aP1V{0 zx0bQZ${_;KdDKCz6Z1~;1TbY4o#mU=+$uYsdBRTJYR zysM`bdLy~J0>?^7CsFc6oZqJDAF%9sE{#>d!=2s)#ea%PXyOkJ)yyhf*xH!lvq65o zs1hOkPVaF9ZjYFm|f)Yqis&uZgFjrK>?!W~L>EnrBPZt+J<_$!cW-_3$4 z$UY%S^4Xge&BL3_Xdf))f0yK_+i`HIaDl3hT9Zlx*0g$G^q`+T_S1mYJ5&84eWeM9 zM=hGmKJ9g&(+B0vz@R5v)w7;lt$v@LuZJ{l=eW@63N+`DALWs@U2l3dWV4eH#C*t( zxWFa#>+%JW%qKBSpgAta_2efa#=#r&wB%L{`ACdocO*xHkF5Wz>=1KD!v1erHeg%l z!LWWu+#pJ;3g`qA%^ojX9{=KUb0}>t4R*jenoqQQ)NE++Q!_?}^AY37a!cx~=iubU zQCm2kkq`f*?2q;Uok?R}=M|(`O6E>F@Yt6JT*_O8PQQdyIqDDU4zs44YzJw^_t7i3 z%xg3_j^KsXtWcxkEgcL{iOTX9d3F~uXcQCNj=k-jY-mWsrtDjWMv0gz zvVH$#qj`Ee-Dsce)Zco0rAxXGGmYFVX!?;+-Pp|nSJS~1jjLsh_SRLDM6(YGEfDh~ zo-KUm_?x=z{zonV=&Bt*_H>--*L3QKJyy1UuoOK{ zD1Aq#5_mLp3Kvor8rv*QBWINspRrun-ZcMo(7+`@&Kt$w>)|n$-J{|2Csqd>5qYP#KR=F6{JSe*0q_j})4%DWzCF!Fiw(_er3TuyrZ z0?5v{Tj^k7ica@4ky}%st)!;zV)>`xVh>vh-8!!xUw>V}UQ{|j^krUaZu&N$8_Lr% z59o|0Oz&37Ag~oRYc~A>tQhhZTV#s27<7`C@zbt2-h+A`2s|~Nx?!eEd{r;H;SbsLzP5l1*+K14m)w731ce}O! zvRNR|?aNwT0gZ@Q{Ns^`5gw)qO87~gyMWrdoxBK(iQcR+13>-<$rF|w`GyAV!4&{b z#JoFT87ZiL5HDZm`e}_`BR_KGX}wyN5e-~!5;biqG>Gllk%VEc4hT1cJFr4bV=SA5 zeq)soXqm8&&e9r8LHhhp_kSAP{tv)!4s;@q%gWCRIQYXjXg8o)QOYy*=N*`M0mFRC zicd>Sp`A!_q<-)oVp!=HPc9@@$0sqgbSB`FgKTl~CI?dJciInX$)f{)C?;Sm!b&8m zpVx-Wf3HjvR*HWn1^MvXJ1sC8brLv|Hy%4N!SxQmX15lQ7BgpIkE!%{u=p{rU z(xC9=vCo)sH3&wCFs?4JQOBT8=iUvcatz??A@ofrg-m2+jn%!1ID0M?aG8Hd^CQOo zAGpuBFK??89Vw?`SRjvi!*z~<$h9b{KQIAVc^abqN{GU%gAgP_n^Y$=R2@>0W|5!j z?$NQUb)>z@DGM+!_tw8F^8Rx1H# z7Y=8@ac8w5;22s?L*4s;=8Q11N#^vglI4`+Nq_Enp8wzf`lo}${_igibSQn6?H6Tud#?j}ej){T&krJSM>iiNG7GR^sn^>k<%;O&^a9SW)|& z19D{|t0A%tmhv2-ysf&j#yEvCVFf<^cUGJ#e|6MBp!gdO^B`wg;h$*KTv`wR)_9?D zM>v;vyw@EJdbQ3Zn!dW~bvxd+uG8~3J6C;q-BO)eS1C1S%wCV9=u|(AA|>qXXvvaV z<0MTshPsxhy;`DBLsw0nk@o~&n(A0=Gi>Kb0UDc*q?>80!|5i8S5Z7=63OFv?#str zHS}6;R|L7H%f){}hFN^z1rfFgJ@%BNrL3u>;vc95W&SRPzsMJtC@W};K$Y7bUkvt@ zZxR;D1;Bt})~)15CERkfB2nWDMV5v`yCzl@x0(lIr>-s={AT z4|d`&KhB<1Za<241$1QPe^3k|Mdf-IGh6+s6NsF!Pp8l9RG-IokPGuP^WRUx=(HY{ z9n|PYMno@EkiBcV4otf_-jWw>Nwi1lpjnPInpv)H%ap96w11T?rg)vgH4x?cJ6f$FXd|cmE2FS=(6FRLZj}GP~<^jm;^OOY#VH z$|X-p9ue8cj?w5OBr$^`l_cfv%BT8>d6;81^Kux2d~@d}NuZgQi||_9t@|t#cq>iV1^%3XFAQxj>Ov7Yuq5(2ux2?^ zc{ga7M7nU$4L0df7usO6&FJ_-yQset)Przl^F0K=wTy(bk=7V^!i!zanq?mDzq~lSuor=M>iEhdAKtryVGG z*X{Hgp;8IJ=(`#0)_2J%wp&{{!+~TgUG$GG_@Gf(?Lv^wBfP8RYgqCo%EBNpp63**tO;nsu~F)^C8cA6MS zbjjl)nu2BAARDlZA!StGC%08esR`cdy0#77?v!2ekTW9+C z1mET?W`^i{lk}VUWNBK3J6eI0nPmZ=9=m7fhS?u+L^>u;J<*Zsx?L6Eg|Xg4r6#$9 zUj0)GlttMD%!!OMOzkpEZ89{=$ak-yCM--%YIG`$MQez|QinU4l?rERGsx+iVfvVE zed8$bEFeY=awf^1t+jeB_GXk>cEatdQEjLwv+TGRafo+vzF^-7{O<5HB;;(6JWKXw zA4U;pW5mVFWc^j-gernpfmt>R$f&{%bFrcCKFMc)XyO3ZrcL$No0a52rWHYgtX2r2 zkM+W|0xPG#buU?*fH76QB;5o(ClJGgym{u(gq(?+nd6ko>4@X;gs`hM%|JEKypY{7 zc>%j%Sn!DYwr20Djm@9WzfR{=dRf;RWvf^f1fr78oLPt2dD^QKEu{Y3NtgV~X0bCZ z)tA7hlkRQyjoWR(_Chh1s`id{BA?>8^+th@QnuBEJJBl;g*22O6| z_k_crj_do+L3VP_TF2gogx*1SX=+M@5pFKJOEyC`khpxgeDtQHAIYk1D7N6_9)|f+ z?pAcDWgftjF#H82?3xnWPb+?zrVl4IbLo)mc1rPcE3P80d$tv5$XlD<`v%7wHC zN#;KHXGrZR9+UV0zU25u(YVVi_@-N9Ga7Opf+edpY-EXcdT>;TeWs?B6_D zF^pqB8oVLoHVXZiE~({L!Cv7dAg@*fNPusj`Sf9*KOKhQA1 z$9i*F!YEUmdT?Cr zIoO@AmB_}gi~B9Yf+V6FU|VsEbC@y+6TIrNAH1m^_~FyZ!{fZxuXm0qC7%ECG+A~= z?7F8kBAzZb)2D~~<@~ET!YrfpvR)CRKJmlD#3b>2)wzOZ^O;HNwL#LSyXAbloNPZ? zK#VGr<93scIl?HT`Et2<+%C4A(>Fvis82t8m~4LTK6K{4n3dls@n*B$?AAZeJNMI% zn>ihC8^h#Ag<7mky6a*)XZqxIx=8ha)p|wC^srd5GIa;qpq6)=$#mZJYnJo--S*Ss zerF6Ys$x1WwkB!K$RE28(&hG-yRK%$ z8CN@JeSg25ckV5#r-!@lgLmcN)X=#O*NajFzO3IKz>6LH(d@#!>vA&Gk+8pR)?OorkEy}(AV3Z{IPT~ABp$aPMJ9O};uU7J+8Wp7?^ zn-|4HRplu?3`G_1_x#L#2sX6%ABs#^@)&cWUnB<&b+pEZO?W=vI`V6539@G!bl$uB zq4Pf6m!mPHR|g`oR#?KV+kxZlnxSA`X$`h-1V%w;pUfU@U2_a>S8=ay_{~0NL>p(E zJJ_uk^w|4)QIEfy#o%b=J_vQ@DP^7}f?FSdG)`Zgxq`?GFDZAeWJTBGt9Th8Tw^|? z_9#T(n&B)$I&sdFg(SWChN|N(D}5u2)-bCRvYXV_PSf)%wvl^Ik8x)8Ap(30A;R2* zI9aTh?K%085%%q7LbhYfXDyxN*~EcSV4r`3qx3?h*mBiO%Dt$3 z2>TN!*WN_zcTct;ZHt`Q#vrYi?7;Ea7Mo${D@DTTOp;yecPQDlx-+5AQj&QXIzyL< zz$t*leeIO`a;~>JN;4l05mPm3l7*VP6MR)IJA1rwUmr>R(XN6k0(LU9j+m{N5Ti_l zzm=&Qy|}3f@aUe2X?n0M1u-^`v|85nXyb}t0ORWTOuP>>gY@)!Qc)3gova?!G#Ba- zuWsTSqR1hLoTl&-O}KNcKjqTk4qhC_i7Du;cl@V;nAYCauz|cF@j_FKa6fMdNo5~3 z1!nH)Y>P`xf!q(B0mQs3AcW4GhB^7(@~o;MK4L zk;u207XW2GD?q5QIP${4bkf@!PIvG@7QGH&4T6^j6es5MG02SO^#>?iWUQc`T-c3Z zXVWQ(Vr*tIfWfz!moOK^3}A5jn7JTN!x3G9EV709@+!z^QtVDl1*vLrAqsOj948yR%R$iTuT5RkH* zBQakjIn*XoFo3XtIDYJz8hIZ{1mV%*WXH2Bn=X~^hw$g!h0ZTQbk9p-0e!%m5fk7Ps)4~~gi2Jw z*|5-4DjJ%lPvQ$Lsu5^*joeeIhIH%OppeMzCu1k0jfY%&zX2?&;Zg zO%M<6`AkRhV-mkzcbbvV33%(pXN|c)C%D#GWG6JZj!JvrzmaPn_=_7}hzS8XJ(I+) zjr)vE^XY&gc)WWfAWnm3T}nc39av-<%y?Sipbkhk(>)ka5w-{Z?0VnagDJ%}IGsZR zaZA&)PMN6=CslTgYMi&LU1##d#BDO~M DMKb`M6M{Oc#=wN6ari={cszMd(LiOZ@xr8lRaA7XuWwD_ZI&3M2gzf~Y~mi=i1xCvTf8}n@2H4{ko*)`}H zQ&89Ov{s@zP?XWK8FeD--Zxcem(Ca&ld&UW#v-ZB0xvT{{eCeimm&QxXZmSA{aNExNCV^c=v{N6$&D5VIkr0% zN56a0CI9T2ED28$m$|x?=QAEG7*5t+gL!j30?iQUw>ZZj%2G3I6f>v?p(cAk9iPx0 zrQ2|IRZjwLeT4B}ca)NElO28ue2D@t_6fFK-40QCU)d(A@16rcNSOTX>a-^-TxAl^ z&B#G-Ez*vUPtQT5zr$`NpbZwB?8^`BeQLSdZYK#2S~H$jFrfp*anrz!8t+e9dGbgm zHt16TKE|}ysI7QmnQVmx`>s%bZ`V$6If?Cn4gBKy&X3Lq=U;24#CC8L!2cZ-MrvnO z9R(G5(o8pk@nzlcWiRAK0R1uLYGvh#xyVw0Z@&fS9nZbar(6TnGDiUeGm~jZ+(;92 zry~WddGp^dwAWY#^H6qY^lV8dsESLk^m_MBQmNZjh365RyTPGXRG;M;W5kw`7pc zvr8_0+Z*@kLzLxaI;$pvK zq$GPf_d`#GI)EL;F;1kKl`b?{Cn9A>XGd^(?uE~Yo6NY8PA>xM3SFYMjm5r{0l_BP zgL6Flyl)8{qS*Fk&T$}e%3f)sxpt$16G`})-Y4;i=>-kNw&LeKLvaoEndZG*XX#VQk0(2&t&+p!B%a*U|hU1O_;W$SII52H7 zh2rf@yo~twY?1CqHV6qEvh`%JpOaM*&$HZ4=Oj-N;q}{}F1P5i?ri-gTES85F+JHp zINb9)uYN53%R;4!OXzR8C#)VkvQ`tST1kM-7{!L9aYZ&?qi;!R8wk;PU(1>ZU+_ZzW2u_!QE)Pizol5cCO_li0= zsR~2&7o$1?jG!BapWMg~wZ@wbc;Uj-5EW}e`V>;=Z$ZoYA5i;XSAgL??Phq&HjYBz?yU228{slFNx(uP-bJo!5XVm<+}`9O2PTku)8KE{cb0mMn9<;}BgBisQJ+ zA?-i1B$bT7G5}wr&u}xY4x5H{o;cbE2fBO>QTGg*cd&j%gTEXqr8y~GXZw~6xCSa0 zI@B4Wx)M|qchID?f3ecQCk~;zey?BmTE&qtW$M3Ds$_k59+UV?C!A|960sCD$xCf` zHi*T1VAuE_>eo2#C5uJZwk;C&>xKZLok-5Yp1C|r$Uz|hIpNV;s@6Q9r z2|asGO5C3K2n^&x3z1iN8_PFYX4{2?oZ=T^y+>hi+sspbx@(SF?Co$*QKvs|_ZwHc4w(>v z`!&*V3~jTos~`$PpMv1O&hOfZs5?VwPx1RD*1Fp13U@Fh?DJLc>aR1? zIlT1XxI{fahZ77_3@3~GRto*$vANZL8`NVDJ0RY72>t=J-_q)gbeW%0(N|_Jt8{L2C6tJyncfpCo zmtJi%qZ{P@pRBOlqU~Yd))=HAl*-!E{@lAvZsc9*h6H%}m8(E>d!|C)Idd*4N$5P2 zrmwx`zxyB@VE$8BFwAf7%7bm?fXiVWojPm%^sj&ETiR(He+$TC5`*4H+_$hLHoD`7 z-@my@f&xwj_VC=XM$L$3X`d;_-?e)>>NRU~62O-Oow9pX4 z{t@Q1IPo72eT$|rajA^`9nBpmSLc{R&tv&R5J)neJ%U2Ye z{@S~|L&|yeghQ9Oe>pe#81BcwIyMoyu(qG2vRxuE)sP{ng=4NB`wT&~zl5Q~kD3Rd z14T-evhSAy-*EK?Y@A~NHc%%Vu566S(R=te<%`p7phnHBYyh%22_RlJee4WaM5bvm zU~{A-l*{G-l9nH$^X? z5R&PI48x|lb?a06>;wBRr$wT{j^m#%pk1GL5dCFd8xzD^rXwk6yFPB?;RYy!l`bDL8XF?zOwIB(H-3&Yyee+gJyVi(V7lGF z-*CMCD4BI5uT0#H@z!%AXHU46s&@R@k|*wK==dabukS%m>yEB2E$1+{+z@{FJ&1D! zvw?{d;`;Byiyhxdco4s#`9XSV6XA+h*0mi^_^Vb@hrn#k9>zK83X0 zWm2`gfnQT%`fxRQm~S5^)44NSZR_-tC9(#xUd&7(RBAAVeEqk7{nu`o&3rrGe4fvo z`={O0W^M?2SWGwT?fQOah+9oNR@~-(>iqPV4`zhnUHU0P%0AeKc)Abx>=_ko|;1Cg|`VP zsSgL-l%Dqo2n(w1g8>$1*_pnA_(+b*-6kl$S79VWRAe@Ytpo55_>iZqOs`fedcnabxU3GMMDPR>9 zQ_<0buq?Eoi76NlNzC&Uu=$%Aa7IF6k)MRw<@Z_mp)vplDM(jT{NOR>jmtcbdJ|ku zRv?Sdoxh#k$e%|qK@vwN5@lOD$u^t_)wA4(m-J{{CtMzViZ&=V@p5~ihozIiylVN7Ga%N_T?R;mG(Uw&x#OLsqJ&|l~l@w$li zv2n#Bvd036c#Fj@$CsUn?hFSa&nzSlG70Fi)0zCy<|ADAR2%R?VnrpG|d>p_}~yV;&0Cqatq6pBrp0P zc!rcI-7(_9-!Oc-ctvI`DT#b=W;F;ERF;#*d(d?r##*^9-tFU1!1C3{go zwW^)APFB{E0vdQ>JOVLj!19;QfWaMzQ~C#P6&m<-_}3q&YX zda?=8B@05U-VZ=@SotMikUBRIf+;Kn|6jDE&Ls(KN`8Bw{Vi4GS!04Ab&m1bdA`E` ztQdq@r|l;&`2%8h1kph_{!Q(uj=?^2z%bnjqJ3=2@#2PoFLYl``-1?BKjO|^@y$*84->BfDk|<~!%p(=+>brU)0Oy@N+;wHLXa=7_mUNRuWBc6!EKLh- zzn_^72LYqXhLLydy3Ac142M< z{Wu~vd0CF70{k4Ofp#0;Mqph_%)L;btS^z>Tu>%3o)5|d=5s=sVc+{BjOT_5f%!12 zP?(RkGKJ|pQO5WG2$OF()eDRCd3BMd&;0nLO;6wHFt-!Bv%kgA_A71$SGU(MuvFlY zHS$cwli;_V6s-8X#g)^D*@S~D9+7oXR&uV>4I-q zv+Z<-Sq6+pH@&BvJe;`!6E6cV(nMDAAS}$Wh&2!I0KGWotd@r0==n9=)jFM377?9Y zE}nkH>&UnxZ`q1_P_Q8J`5#IZnGG>PM5PDLk=|W*?qQ`f(zT352SGZ(AV>!p1nEG7Aj|u`(WLe%AT)t@yz*0jn|W;!`Q*)ZQd~rr zH18C440u>M@jzPXK`=eK5ND4hJvbiF2O~QU??JQ8T)Vn}KHx(?dT`IT;NRM;Hx=L^ zi4M${fKiVEj+Aam?aCiRIJ8L^#;?S;BT$>57m-ika)U&)V+5gZSdoYp)n+dDAl`#~ z;V)Z!7)KUU6Jqy4l4kP5&GS|luhb%cik}uf-w+=}DM_+BvX2v+&kxcqto?R%7rMQw z&i=#%;gJ}BPn(4$1Kp-=11f8?^CSxbSjg-@fc~> z)ew)q1#fp^C9p3+d`Ww?84T zwY7%Y0cpEb4n;Lr?OKjg5Cv^#^E{3Aj9$FQ5uC+z8p*P&xFFDt!UAan+b}$rh|Xx= z1|ULx_}*n|inDG;vXxghHdNekOMmZ1(y6~| zsf6p7UehL_EltFs$&UW59X>22VJY$NxnWA{j=BzE%g1-O+755e ziwl2~2w+VOQC5=SOH9Rqh1V z;rkHtZZ@J%HXxxs zJZC?~p?hskJb2H_srQ8V!}4Cj@EvMcvc5+x=j88L9o(EAPIL#{r1_WAdC2jxPlO)n z`>+aAl%be|lnlSTf#}zEuxv~^IH5RlcBD?lknCAJd^ZrB{W<}QEt}%yO;&qCe!k+n z+B5M2ni=Rep8OZMG$inEqp7bENux|`#uNq-iQ-|n;{CosS-%4pn+B&%k@h;U$fZjY zDg3>PkZ(}MuJ!L^UY?xaVB@`&2B#H@ks?Xa5w18SG&dT*P$qPyUpV6X*YM~ zUw8A(YO>_~&Sri;P#$-anKS(~*$hdEE_jD8>U08b7Td?=WJ)_QJbPRWM7vt=ob8Tw+sU%t@v}AQ)An(` znhn;wR%=nA+u<0sZeVTr=!7_V7=8k#w7UhJVqm=(it_1>PPU7onudp*0?$wwIH50l;W(@>OjiNdvSAik&7-TDbCkhbyS>tLkQ<$6n} zwkZT~akg~6uXnHAi+sqbo>l?M6Ldiux+-RrZAFVas8IW~nty$y)k=BkY(JQ6MHjr) z`patQ#Tmt%zJ1mcMl03~C+2?Ll7w!HNZ51tM4zw+;1L6k6K2E<6`zQe!?h0O$~mR2 z9hiF!$I5i?hU2>=V9{}R%?R2!_Sl+NNT+dlIYq0>=~?dv)`oW(L}WnL8B-)3tV)Y~ zEY4YfR(=FFXcwJF{uGAZmW9I^l6S^#8-^|}uZ1Bgr7`EgWzB-@IxHp3o5K!Nq@4CU zDXg#!Jm`^i;2}SMW4=RJE0xa_dp1*ndqehvb%2i~12@xy5G|tfg-+0sRwc-Y5X{6f z7qpk+hz$00Xk1{v&ow?lOrN<=@}J>_FY=Zwva7E}k` zWfel^_gIIJc<7Y~N#AEJ0zZ265C0w3q$fHE;)Dc;h##Exqx*Ua2Q40Rzv&43px)~S z=WEi4wc)#@#2z>t;oUSWz0zu8c z9D^)ZPZ^B=Y~=sZCWn+{qMIyZuTekVivC-0K8uxoSY|Fg4d264MSOZU;(>cPQV-bA zskAi2RF~682b3T`4OKRDyj+wV`%#NMaTEc0V7~J(d{PI~ zVSbVZW*vl$DPKCw`!4S*eK~m~7QXh{vhluhb$mKcQJD|p^(ZoGf8O}yMEtO{H(5yD z0*`i`Aqz-fC{FTC=`c9cS!&&D^lEE&0&Qx^dQhvwj9MuD58?==jav^)q1|{03b+`( z4?^0T#W9&~zE}8kL?20%8$sIgkkoU}ZME4(LMIUL)keqZ`I0$ld`Y~%l)qo%jKG$^ zC(kA7^M&;PNgj$%*Y+%lw(%v&ZSKJl_V!EZVNJXIsmxs{@knn_#>UtLHiXib;2@0P zxu&W6n{chRq6+V>zcf0%wqyQMG0Bx880Ggde#qish`&K?z$197QRvop?9)NPEFw|7BAA(|Pp z%%X$0ImzzML%asxx}9lA)Q@Hc(cJ>ASDo$zy+242_5GxK&{MYl9z@@wuJg3n0h19| zej;ei_CRTZDR-r2^=)(zX0aECO)jepS>Oi9>swD1##4G2kno7pN;)9pB?)`6ZAn5G z7s~l&KOZR^JT%@dSbIF+m`Ux2PYo|4`b5I>JJ4=}L)5r{wR3}~msEf7+D;J0u5U+> z;%7CjO)Q0OZQ^gI9~ZD(K2CWwujY%|GHqu*eof*e>}gYt+wn`sE3zWrFN+{bGdJ?c zyJnFkG3W{6t(*9!^c{0N!6fhDWpn@BX0bPP$I??`e07$}5dmM_eqEqjW>Ler@lbit zJweznlc8II@onYwGX&53G@&ks-tDF%?%7z|0HPEO+Fp9fTbjx_yV>dLyfjfBWO0iUry@XY&GJR|Mf62#cX%$jbTm}H7V** zf6v+u&7;E9P0p=&pFCd<)@bsU!Bv)B(K%S>d%YD8Kbk_ww-SK+^k^U3Nv_n$q=S&C1Yn)gTWK<;KtByHX?^eAVG|kK_Y{7e$ z$z%YS+v#R%)1wjFV>S?Yx?ZMfqwQXImaHMzYC8*C{n=SeUluC8qz&%mTWNeC$%2#p z=SZz(q048>lDPfQUe>!d;77kM(r4~w1fhFyo`Wp4XGr3cvsagFtfsU z(B67>y>B`*Bnm_pQnIHyw|otBhdCE={y-nDV=bArz!qe8wof-aGLZ5Y6$*oxwvyS zPpjSHVeWjMZ?^SL4RuH(gbN3dKYq|H4OM{JhGvNP`8NYl;+d4H*tbkEMkQ->k6ujw zzm3w&|J&JrhCKuLN>iLk_&ioyaMKHw=(@3qP3<-hse4lf=hX2NUQ zMkc=aUL!;4$Q5KJW9N|tdOWY_8 z@s^$Cgy(@Q=5D<)Vld_{iUkxOXPj zg!IkLzyCCT4zjW9fw!4)5*&`1rh;FCC?N-yQx(E^MqB2O%e(pS|NXzWG%Ib?yZQZk zGv~ovzASd15E7rUQuCbsfZvp|H`pI|*pta@W{z2zWA2x02v)NAyqL|6!OQKZ#r@70 z_AuFP7GIr*r{!+(xct=|zn(oU*XA(W{MH*|$m9CU+#I#BtIzGz-FCXMf$cVvsd;|8 z&C}er%X~Ge%*}lAvqO96qXFh=v79;6^=i9wex5^TGX^gg+no)@d0IVArazlPElNls z_L*@c&P&d8vRs;SZ09=*h-HDd%f)nV4B9~;15?!Q>2W!?0$F~WinVDDNbTG|typvk zJD4;7YK#2&iy`u1zWcN`Sfe2P(gebDJ(^%vyTyu5P-fG{Y>siBAXb+#Xf}uVFs7*c ziODR(K_8dvyUEfRwwgT5jX|c%%IxXU*%{S2130@c28%faySb-p$Ah zTC$e}hN8X1S?9R6XhuWnUcfe%wQ4S?3#65#F2F{j`hPw>JUWxR?Rp7;F3n(c#{4qb z%nVVBd%A=!x6p#LK_1P~SUIL(l=CN#5Od7{w4TfiMGJ)Rz07j5-5MehV?jgb-7S2|=cUDuT?`k%!68a|_uW_HRb3$jYR5)1lzpE!QSH8Gy{c zPUnw1GfZI&+d*Lfn<0(F(?`08+|h4)G#IvzztWDg!gIgHdN#j%V&W!=US8a!{z`zo zQ_y(o@wi@a`Ns%5oowgppDl3f`DQw&gP-ox=H_tAFP+Ul(*@rqKf1~LvZ0dY-LJd( z)Q*C7B02$W&5`r3^XXGAMH^x7Csa_upvqi;FhYNtY(H)1^O*&5{a{hr#cB&N7A=5l z89>n(yPSWVOn?2dppE=xd%qosXuF#&*5(`!bf3AN+TtKGr9}r@t)I4_Dzmd_vi0L` z@v!(W3*_U3UsIT&HtYMva?W-|pciCL0b8lv)1x_X_leGwGt0RLB7G z8=IjBZF@J_T2$22?*6}-qdwE@);8HunVil5AB{TjX0o6X`RB=oZs84N*3EqPv{{*+ zv~1Qp2l{|1#N@bXOG`#2E;=UZSf-NN));DW2gs17QWZlPpN%n?*=Z@m7=M(RMWG*eASgTfpewnW9#7;oL1g&y8_wWGv}g&6-V+5Bu@75ID!!~`b69_(rTIjUkMrvwh(xu^%-I=02}ieI|3II0c{;*dUf3A z=Y+gy2$KW)@#M;Lkbcb5)9;J?BC27c_?OXL9EZe>MlmZ6eFFr&rW@KoV#1+JVEx;J z3E{vL(OE#Wc+ID!=&Zv@vr{I&Z4zO4Dcb267EOCoc*1+Jc< zI7Y&;$V_P2x2QDIF4#7AVG$o+Lkv~2&8wP1JxL$ zJS(aR)I6aoCwGg{XZDKrB}#SBl6R5{%^pFr!G(<8K( ztTR~*b>dA9<1>#?U03;uER~33O&>8y4U6>*gC8EhK*SB?V@|jXS4k)b;-ER$N;9Ut zElvVAtZRnia>R^w0(B%F|2;q^p?JQ$&qG~1+M^2 zK(fEoPV+QR>!33d%VmypjFE$Krn*HAY})A5;1`#<9Th=dgY1|uZImJbH=xjK$K4zf$wLL|yf}OAYn1!ax#2RW3-ck!RN6(>S4< zwIG5aj%c6kO&Aa~29RVLN&86p802f>jh3~Ch zpJCyqD_DVsOE9A?!XQ*7<8f#WH}=cA8ZGxs-fo4CiSF%0_v*vTX#_1a+#m%8qC$!3 z_La)6E(}B6eww8c6)S#IF&0srhBp}ROe5ZzT8}OiY`G)K5_0N;47+DSnxnLIqL13~ z$}V2c0G~heYVArZL3L!NWz>{RDSPgXvHKQyQeTUbN|#sdvS^W0{#l%nWf;U`_tgzD zsJ*nIE7NqDn|_mdNQ|WM#4JCiThMXp9SPXx`OTa@dC9kz8B976p@Kgv69s#vMF=5u z8#;!`&wv`-=RHt}!VJ&Krk;7qm4h zrn*Wpj>$=QG=&xto=Vd2-#O3k7jkJU3Z@YhzaT*3Q;ZPTLckKqDTG0Cipw)CC!U%& zv&eLkNj@QUbn^34vs%h&Ybs2kXC1Fcsj(057)xyiVA%|P$NmF$k|NKbvK^|Fnf_05 z@dY*bgB`6tCc!BH1NWRT^Uh=99qBTN5gu&%#BTaH0*VojR3uEei#DMmjVO9dVsK=Q@240OF!J2uN@&U+4hLp-y|SW{?a3P#RxC3CK5&{-@i zXCxIB%ESk^>HOy+(lG8!LRD;Lp(){5$XcX&gs2 zogZZi#}{Y1U1X1P8SvHE7e~59{xl@yY+H>CTtmvj;aZOgj;|rkJ24LPJ~KgC{uyB_ zmWIi9f5OEipFPF0(p0n*8oS>BQwqn}YU%<`udw@d6;djhz_Ar$sM15L({&*7NNC$V z;LVs*)MVhD9au0Owj4V)3uYxpPqV~>I8(D~R|~@fy9`>GvP2*YQ(WX_VJ=bd=D_K^ zYk2HXE&&jY1<{r+9qjKB*C9%A3E3__f^`aZ^To&AeDhE#5G*&2JZ7=&4#1M10M+ye zNKiTBH{;*ONiA{a9i4r@sT@hhl;jKiF>*)f?ARx%mjq`#rlbF%UwtIX7h-w5=AfHI ztVq*u%#Y}pt3~AaSbSKyjfoQ?OaGUK9OL{@MEn*<&?8iF8-3dC9{HA|O8uc1wX(^$ zp)$o=&~|8!X(TEB$`8!5_+)wai6P+cgf?^f=Kq<>;`A)cv* zCR|GnK?0*wT}Xce{$FVqN)9B0V^(5v1B+uILs(mp2P< zUaJ^-6eut$xEs99F&X8UK7YXodZ~+|fFcw|#pP9(X%KF8vbc8Hf?y#L9J>D?|B^aF z6a|}kI1&*H80wjG@vM1#)T?^mQG8js8#xnH`HT+D`r}fKjSGk>?S?aOdZcADrm;HA zv%e2J)hmmmZlFWV04|*?jwg~)@j_8*<7_ClwPencjxnhyM(ZqEjor(OBO8M8;87m^n6oqLEP~gZ`Dq!@<9~|^H3%e{$E}TJ_ z92|0E?Uih``LkEbBDDPBx|L473;qpE+xD5KF&=0FsE)GGjlPY+o>bf7^)*CE0Xjk` zrJ-}p_?g)RjF}o~#}DRq1fQAeDI-D~sb+bjL<6_D`N%~QLTB7FEiWhP#sh-XoC7(Z zpli7RuU>qEPJK2GBJ~EGanW8Jh#>e96w23~$b;Fna=3MIRM+-7viJjGKCSUBTr+`}2jX&T~^y_{}Uu zXT%MqKGYq3e1moez}eU=C3>Ps&}_Ci!+)`K~8Y)Tg-+zdVuE@er{=nG`P-o-@pipi8OQ(i!M&S z)my9FSO`KzSEM5;cEAE0=rUK7l_l*y`v4&Gd*^acw&1{15ddgDMp--EG^`NOnmT?m#D7dN~qdIM0` zj2b@yIxhibqw5-)qCs|>Id+Y`Vhv}-oKa`YC@t`6NVr*EN29!4#H>$k3wdc)s{t1#yt?U5>D=}3G>4`o6dlFsg>SSAIR1hmr|gFWiJSZ)fJo!7uwPmN03IysaU$G=5 zzlSZ6@sn!BB&}E!P+P+Q(iNX54f1*GdQ&FJ|7e;|q z2L6VVh;&8x!Bch93wZg8_Z{{F1@EgD2HxnSn><6H*eUETnWaBRlA7Yshm1&G&XSXYi5i7(c^G>$GnL$MDTE#Z9$5=S*_Ej*PU zhexSJ)X6=cgE}C8!LScJRp}$Cl$9Rcunvqbarm4e`FdGuF#6#-iAcU;_;u)O1S4hRQzj610ODY%iiFd)S}43I zV2kEh(&&Z(go}{co~yiMj3qZA`T9UphD0-8=kFv*aav8qMO6hV-td`Pq$|}%O0qhr znBPfxeA6viZD#P8V=zStm0u1QVfb9gA(&=zK2ri#-TdApSEmptane`EDBelQ?IagC z^^A}wzt(YFIk@8M=_!Nj_dvq4%en5e@G&1dn4(x4u&J&A(We}v9_1HKKI>89NVE>f zPgbfx^~h!P#8U~$6wlDu*$YoCKD>rVyy8@)DxyN=^%xwERiJp2Pcn4lb{&0!#7j^E zF9^u5#Qi4JhYB?O1!MUF2lV+!%j@Dbp^FEc3CH{F)h!?42X00dolLTiZbD?-{YBNxq<{(j^A$A4&!QLc)@nCCv%r#hv95~q4PxyuXhdPlO) z&V4i;roeH(dn{`^fHHj#jVv@-5i;eNZX{xzdQ#b3jn3?}7|{G-9RE+HGHf*@a8*<#NQdpjT1PPvG{PxjBbtDhv2nS<*N_P|Ts#3M#*mo?v%U0>>>~VEbw`%^?QOT4Q1MQYj)IeJ9*h@U^PAu*!(3%aI zV=hR-k6vC%WSv#@RLyA!cjakxx$B+$W~~&OK-R>`m%3|!Yn;eSI62ZlH$!+gX`c;X zRp+Ng2=x@_tfZ4l6+27=oi^67Ny>?i{Fq}Lut?JE>{J)e_$R6Rt)|Xm&Yz!|Aa`@k z6w0@S>-iAWspoLRgtJ8i{z};oPACrp>t;21awtEy?d*^yYMLgMyDZv6Vv=|r{YQH8 z*d(oUr>k!<3A=Tlm2Z)c^8@@+OJYy9@U{kjR~x)tZE4DJNWknjb=UnRS)POIrFlBU z9bpY)F3SLX%&cLMDcJWR3igsGBfW}*c+SQ2VETQc!u4vF{aW#`&8X zx^W@D=YI6hB|5(!onNBc_oLgF=z^YgS)%)`AKh;yy09NzSfcyAAKmXIx}+anQlfk7 zNB35w^Mi!W`{JC|nic${=2V3oxz z^pWCW6q`FklC_-(B%w^G=7SFuu@ax?^=pe#rA&MyE>M-@;HDi5OFibP#{%9cOyw7` zGVkhDESK?3J#tEvv}-D)wBJ&Q6hdoL{7#RqRx6jvGFh>fS>X_Z3<)_hrM8}nw&XEc zx4BmmW(Wei2_}Rf zgK+DmQ-Ko+Dz3o5N|sw%+(-pY8!4GXn}?`$Hl~z=XPI|!sU_;7 zCZ0U8!Ui0b6IAxNcrebNskh9d8IR7w1VfQT;>YoxpGu8&E?{!&aDI(9Es%8gc3O3C zDhN8CJaGo~?1?`LqJ3mq6(#R1{D*Mz@fauPF6eRQe_$|Ok>W(I!fx18FdJfTtbMr5;yI&Sv;=0w2&AG7Ry%Mzv~{bGUt z&23p46%Lv=sY%FlEu08evMY7sbio*+<+pwb*ijH320r`g~w@$P-yBuy6NVp=Ifd23kB8I zU0G|U8eRvx`#HR%@L%UMIdPY-7zKfO$)EpBxtQ|c7zb$Gm=!5wy{d$6D(6$LkmSp z8pG8jJ1D8Q?rLPt(d9`zxt?{t?by4V1b)%w?0lqakTkmY(wA{Tim%e7FIvf)f}71b z6tFPoK-B(}LDV3vJ4^*P3*1oZ<>ZDyV7WlohzzS2RVKJ&A!s{!Sv3Zwg>e|WKE(ag z`eyeEralwFlV5r<9ooF_AtfE{HF5(&%MJWFoBE@)WBg&e`mp&KctEaHR| zYCwP$FJOZ0ImpKQfP{VuCUW^@6&Mt1kI}rcyMYm-fayrlYlHk4jmS;-!`FpMsLx=^ zQR>}g&R6IsUFiy)LdzzlTi=TJdnvE``YbSpNcP50Ib@t3T{L?}SkR5_o_if( z*pb9a?l>XAAu{W0_Y73+Yf|3~T|{>NWNGY>!xTo}#j}~vupaMoWKB=0=he9YG+_o~ zT6Tory{rp~;a(m%7fk8U^8S_XI06s6k$f|2|0QD>aRzWo@~zqnL_Rh>Oyr>JVGx@E zt-1}S_D6=1^ZMw!IQiS?ES}1>b@Y7A2kxI_jwU&kR*r;d3UEZARB zY^2-V0IF2(pF1;eB@5nt3#NPv&6vL1R|k)*3At?fhJ#1yZ}>Gm+-g1DHm#tN5g(5+ z5HZ#km_m-@L>ud{n8#T1U6OMWq#eIiBo=6P2BtemsV71G?!ws#<6uxh=eWo z5{wp8=JN*qk#Ck57o2pS+Z;U>3%R3^=lCtxRc1_VYh*&ic0#2Rv5)Ik+l9|l>m0=@ zb{L;KU@|$^5=y1CE97|9wv=TdT`XHrL*q(3wlZ8rva6`?{v>ihCG#%9Xc;XtK#)~H z(BQ-o~+m+@hP1e_7qgR`zt@)V^~@zVvoAv-60=Vztudx!3X3)mYR={<}LK&UKV zj{zs@FE;WOjUQ$lQy_tXZ0C+~#?itRqpXY0mBnla;R%8pCPVqU0A=Equy-C~Bo7@t zH;JZbOsUjDj+Z9Yoj5Ypuv+q%yJ)N!X-lr|<;k>oTECgworEQ?W%?tI3`+Ay9MzTR zkLpdPmW8D)b2J)xi$VEPD*2tq%&c8^ScYj>l4@Xikm@kOh^1h>+8}H4!s}l~ z^iTBT2A5~z3Y%jk2?$ZHRsvGU#yO;*a@>RwxuMoCASj0yoakPvQT?4KD&KU*vR)Yn z|9>Zr8Bbg0*t@?Q;qNEENNj^A%@Vp~>d!oD3L3gB1?P@L85d zkk%Zx^AH8#spX}>h`$gXj97Kk5=P{;ZbO$}pV0*P-Vx(UDKAnecV8&m{7oH5dwF!y zyJKA-dWX2%(rareY91U!pE9jP_LIDw-Hg@@za(pr{dDRh3?ei~=&xR?9~3XNKIor> zDL>@#1G-y=&Ny0$J^+jmOtC>(NoSiglSoQJr!d;XY5o6r`%{}$mzsL~6Xg*j|NnRYxg8JNfb{DC^s6%zD z)@7%%pb%Upb6-em0h-hnO5T*@Hx>LT<%zm$0Z1Pj)pEgC(+MTb0uN5}_chw`QZU5V zQeOT7k>3|7#<-RoaNxr@{!Ym;0`y56@k>ciiW-fWT^ysN@I(b9W=%P<2(emR_lRu6dnPnE2=g&=_3MboBG6Wc;E!ssSEn2rYChP?3n0(%~Q4 zhgVQAM*baL243l_TOfIItXfXcG`@nokJLCE^8@r*+^kCgiPVD<#7HeJPSMy`>lxHS z(6{42cwFg3G8qZoNbp8K%E4JY;z@4?2||D*XEzyuDA5Kui#dv>f%s*Z*aO?irfP+$ zi6$yY3Efc2o#HJV=4KumoI*`#bszG&QD-XNF>3S6I3}HB0U)pi-=EU_Ov&1 zima(rPB+rmRi_nGAUH18EFpB(R8Edp$YD5$zO`Qi=^?lJ1 zY=NDhavqKL|UDNUE=g#tIw;bz*PNvJF)D1fhm>>Au(NKIfMeeMP7hX&p3&el-czs-` z1y`npdh+tTQPTsq{N^IZ&;`;X`fi`UFZFwOw8dA2uCEYZ&Y@5=s^gWfxvM*wTAVD2 z0Cj~*x$z_P;SzY}2X0W&cvYJs3o4D&`s}ZADGOcfjoEb`53byN<;T*ZsS?TF%Mx5NQ@o4VuXdZv4Zi0k>7d4LHYxA)cXC6_2N|v1$@r;Tdt%OlkhxHOK}1&%P}$-lNHwd99j|>( zviX#6irq74i*?F@rIlE5xZZireByw@v?-3fyY+IOI7c4??>LsLM%MvIK}v0mCOjf~ z5V3B2;?^f|(j3YLZi#5>qOD1sa7WrHV}eNFt)2l?779?Nm{Wd*1I{sws2~QqzlweG z;GPSV+|8O18F#T(;$cShT6={GhfI%npL;JbDu{4-P$-FDY7cR!VJmn!21dfJ7mUc} z3{&K3T44kp?i$oWtsnCJB62jZFy&(8p(z0!6x@xQ)z12%u#TF@)vSkpoy`RHWMj}sp!CuPzY&G+H zIb@mbW)*GIi}!8JPGvi7OSr|$o^B7NJNb@5mlZ!XwBecFF*kn^bT_I+O~YYuDV8C- zlYxxW(H+TN32h#5{)OF5SiKT=f9~>$#1EKu0fvZv2@W;)$#pKi<_yOj5eVE3+3y1n zG(sJ=B0F$&>e3IXp#`Vv=UfAyF-w9m56xU8K#4nGvhgXV6NgMcdUdbp3_+$R;JW2H z5~4vC9|-tn|N9MJ51jl+qjK@UKy^J^EG7&*7G!h`k?so(f#kOeRJZKZu;bsobJ)>G zwYjud1T=EzrU5GBnZ-|oBL)jj5q<6J!?MTl4wn^f`=~oXt54 znf(qES&vHp1?0Ed>Q0r&9(4|W{whW8vya*??6&7`g?9YQ?T-ag_y?~(y3Cx~LId?3 zW2r4V1$S`-)|dxv)sj1~at^ee2FZo;H01;?;cS>65y!*6PyxtL*AdR|5F<3lNT`n- z-<1L!*R~uBFdw*u^KVLpPyd!5giHUEogGxpC4wLSQo(Ez#W3%xky~=+G3ZI^WNP+K zG5A$(Jzo>1!iJXjY!!iJfi4foEljy&MnTl>6{O48fKL#*x>#K^(^jObun0J9=be#o zC+5b=d(!*4PrT3-L0Ki;IDP?#7hJKW#i#mQ76Lw;M~Arq6|U?$re6?;FP1{v962_e zA|I>g*wc(p)kkt(WS0bJQy_G+zC*%4{8BGOj~m82^X;>4j#?jU%_N z7;I`P^aog?gKYd;%=Gw8*BFi;p`srr0al#G`fB9~o;><#KeB?4+?H)}Uyr&)l5xHO z)YPta0l*3t9Fy1I+ly5er+xJw5wA`$@%K0tOf^pc$jq}fBX^ujY%|2 z^efCAg1SbtEoUxhw&g`cGAV9nx&DY^%U;N$q8-*y_&ggztvY%d3R z33^#+D!d|LluEXYbS%Mj$2j&;QrxfBf?w{|{}5(?9?5zy9Yaaf6g# z@Flt3c|8(#w6hz7+=vw+xu9n}^p}E>W9pr)LJ>+APx4DC1?A=y%eiFH8ZQ?h`FEm`;NeghIUCGG4bz{E$!Sg5y9U7~*9H{+QuE@-(8K z2=TUzD#l z91Z5|=H6-U(b`>{RUwPGU)C9Wsfna0oTeATWDz_DQEXms_P!HDRQ?Gvy(Wz?Alv(6 zHSI$An~q)3A}d(K@>^ru-4d>ywfETdPL}S)B{lk=ZLt2*UzH+K=m20F> zUJe{94(J;LUDo@2D7u_aFVBJldbStyu!r)V{*^qBo)g;J;Jg;IxAH3mxeA|BDvOQl zEQKrYz`$vHkbvEb9U&kO1`ac59!OtmBUy{ObN3_cL5o_?F`r(T`B%<>jDsALE49SR z$-K)o*lF?vg_>f*BP&*eHyn9+o}c#uqQUA{H95na)YeU}4aHQ##v>4e+R9308jOO4 z%2#7?)6+aDaWc5CPQRCyJ4-mun+RFud$uA(FF_KcESQIhfeb^_d4g9{);hps0kh&T z5J;25Uw99;=0I?OyoUGTn3v9J&Kmww&->4T)%fkd0JLGYq`f z_zIKl6UKBG=LauAmjiK3J(j6y5#lh6U!C-N0!_BGMeM=EW0@G>iFwapAlWnGq-Q)v z${>!BxkFPrs6l;Cd(F!!BmqDE>*XrP(zk zsoAuG@}vu69JJ_Oh~i*%#P~S71M^_7;|g9#pb_=hJawq6f~*Ar;S91=-OyWZQp+T| zhad{ZOE)@PAjUE$Y%(#Z=VYfa+iR4$Z=3~|4-mR_YqUsIK7dL_MMdmX=O(*Qd(@?-II6wcmlGzW8!Df&~?NHE@+<qbV+Co9X zcf==CcV_f)jBZrq1e=|E?O%3}mF-K`<})QbtNYR2V-BTaHhN{pfGyocaRE!sAXUFi zZ3tTBe~>68hOp|HV;h1wA=ImF>2OIkN@E+u_-p7yY6ie#VIv3_RHf#kKSc_!l-Aw{ zfux^}gkWiM;AY?qT9xTw6U48ASJj-XRz(H(6EfzC%#UAfvH#h-s|`Z^>&Rft%Bo ztyaOyL4f_W}^&Xy)--+g%HaRZt@IH6FjI3CmjY^p18ZNk;D|Q5_2jsG`bT>ghEqq4BM#X^07+D zNfg=!&-Y~~f_ddK@As0VfAsREN(A$(juRzMuZFr5kE9_lkNaHpBB}Sc@sSrpdSvA> zpHa->8KhnOiE$!Ub@W4R8dK?-$WwEnDxR_%8RoI%Kr-*uzZlO62Nsfe9H(z}M=~eZ zD+e!zlSai))Pw7BMHoRPq8nSxmTZ6WKwsS)g0Rz&4nmw5>n09Zh;zHvXw2`f*sZWH zU6NDgXV=)hutW)YoIeP1g_RK)Ftzq+gpC#07-3^hh<4x*;U{hT#E+~1Ucvj)i#!Kr zbiHPOULrC3^N&&Q3kx3zCBk3Dq|mp##N*9ME&Wtfak6g4}Sz_y4!=5 zr+G1lgk`06IIBVI4cl&wl}nixfo4Mv;I`<>jSb|g)$R6*-|?4rX=2ZZK6N^T$B}jp zM>lo8k*o0(L2<{i8y;ee2Clp2qluKg;V1fYlw%kNM2PW6=d0H?Ci2u{NX?2M4SZT= zgd+*h=7vCk8Z$3cY5UpWC(MJTrqH)Re5F#JfdU#FgTs-)}82a?{{8#7yP~un|<1};lVMv`= zLuXIICq+m)#-y}Ta3cfGARzuktww3>_?e8@v?$I%8PN}JazHCcb@nU1;Xd6&I;s1o z#sjFLl{f+NWN9>Ii9f}!<6V4H402sVp@zTi82nm|$yURdM=xuO)W!fM59$T7lG}3C zX*vDCT|D}D34Bq_`QEZhRN8mS&7WITZ~3(TvRiYyiXxEmxS-&Ipj4vZW+C^}QG+ie z5Q3R_h)SEP#_VjDz=<*pj4j>;@7%M<>+JeI2!J)Yh*#2EU{LZF2uf!;0oya*6nb@) zRqgH&_3Titv+`lGmZEsvEV-uqDW^MMwH;T!D)wAna~~*^PilHCoh<4a6(2Jux(?%U zx1!Roej%GOYHFOnU?f}oq3v3!?yFMuo3=a^MUEu&!pt?RQ2v5DFXXAzOxfA)hZ-b% z!H|d;-P0|?k=;l{^gFIR{fp@cKU8vt`t?`E+H65bZW)XM`8PyiAR0593G zS#ziUtoqY#_lQmbCzPNf4*|ajLc>n#V`Fw6d`7|xhj-*S{1r%WXMh!isAR`7DAp}Vr z?4M2)McqG2>DPc`rJ;gfM7(xSSxjlLpeo8nsel)1=R~_ZZ0&3)9~id4N0*2*l{W1N zHym7GO#2R;ZMjzjfBA1ZpFs3Y!A6WZ>H+;9c8eSM^%|S)x-<0Kpo{qN_Rw(oBjv*kQb+Opy9?O`Qg=02TIO9N)s16x8FXFxqQ4fZ`X zkAl58;|dN@oLKl3p?gfapjJ-2I<&V0O3gIj8b&dVGM#^FwrPhX$~n&BVe5_Fl$0>SN)DE25xBy(Uid6J^0wuE5nC_OwE*?-32xrx%EzQ~>tqqce z=1`JKRhxz!`xx*qPIU(SQX8b74v9izG>I^n^w8AMk}T;MlL{bQ=8khkfx1S;bV?Nf zDj}ibZ)=oC-{Z8sj<$Kp#IVO--4t6{T8-O~x({Jj988O~2=0^sg5Ot0Y?&3 z$!MG&Nf=_JG+M>a0iDFJI@^mdw}@PDI9i6~Ks+nj0wb;8$lx~df#6hi49+8T3a!pZ zp!dKO9U!7|-0G38=sRhV!)FYg&+ZB{nl@N7&m%o^SJ!jk$qMfG6f3curQ~-Gj{nrN zJ(KAsQ0mZL;?79=h^WY?TM*_|0Ozf}PTzB&1 z(gH-Wfs;td$-Y*91W+bZ4TW+wCqh(Nmxt(L5Xq2Q9Y>Xg0#em z@ow-5+VHqxh_}@uXgFaJ$Wh&ivF6#as_&A?hR|_EUT|146ne*#Oqt8?>D!2K;#V&C z5h-~ZbZyE!m=c=j#Aa&2aXY4ya^?!BGTzDOci0*#nP4mmA>h!#;m|V7L`bk=$@s&f zWxgUfv)5u`D>99b@rfAG1q$8Yuw5C2cce3Nm7i8G9jFim;jKqD=z{q>G{i?fp533c z`PG`;8)YesqC4e!sf2AYu0=+n)S~b*Gp+R$HJ(BKrg*|)eBgy9MFBdf`tz*iWP2R|J_H_JOyWIQXbQaI7Y8#q)2|1smoaKa z)hy1nc|3B|C`U26l(>m^99Nwc*V52!AGcOzSC|-8Xp0mh@LS9|>5iYN(p}D7Ic~ff3}1o6x5-6jV~hPQ>)o+Aq%+e0z9m%r`UP&Z{nO-V~`(ptFaZjR}FH!0Dx6ot~k=8#2G zQui+vMVFFxRGq2|XEafE8A#KO)0khY@a*$Lb{-nU;;3H)6?q{RUOyHJnmPX{^R*oc z=E(=~&Y|#0Cmr}Kve;pBRTIsYh`lY|RWb#eEcW7%$)H>A$v@wA`JJmp?9z^xOa{DZ zI;&Q6uqCEI)qb8;*RF~WLuI6u!ozmF+9*n3af^@mAeLd7c)A;@9>y%YYKM41&x{3f z?xblJoHbVA^hJK?n}Oh&TM}U1pvnrKS%AtD7Ys~{Vc0!sc14kZ%4jJ{Xekv7v+nnb z=@^o0sKi`rJ`A8IbiMRajfu)9ZHkq-FtC$@<)*6{lA24?f+5mWa+E!oKFH!YOsy&e zk*()rBB5Fcc%UASNwS1^f&KtSM}=WF0hcp5wpS3pr5ITh*9N?{{PzEWjSu6 zOBbEvRVV`}Qq;)ru=ikh#5phL zCpqhy7a$XtqIzJ9g-c8wd*cc^Qe?>La-vPMlW*by?`;;Z|=**aTq^CyTWIsg^+saOp?3*t%i06Cwke z_va?xAu->Xi zIEYTfs8>o`VRtq1PJ-#-3v^&wWHA44+Y=yoj5ipKZ{FR`BvXrKisL6JgWmJ5pOZ7tYY|FrszV6*cauRz4;PWbtSnC^k}i?o8|KH zlAW4^6}SXai^qdiy{(|GVg-Y5y~t+#CO9DQxTkb-*fY32ReF^<)trahW2TGp2-{W`f#Nd76G{T5A28uc%v8u; zVDjoes;@vI2L66sMH#J1R5OXvbt-!Qev zEakx4ZJNbm)CY0M)HCv7@Qdg@W$zmsB5|11TS`@$cIeARF?;MqBntJvM9bsAd#^?5 z)C(ju40VC~Eh|-U@h~dh4m6(?dT@z=LH~h&b|E+cdmjc)0*OeF%#RJ1SPAL@!|VK(z3wxDp400|u;oo1_Iy+O0_q{<$+D4~m2 zWyL5H2QNdQT*8<_g^(y|yg2xQ{@vTrzpwXsk2c9zZ8h_&U>%|XO0b;dul#C5 z*-lL;OABHBN!ln>B1wXniki_8HjuEM6-5jL%cMO@iH(9&!hK#fCN+(;grtx2s`8L5Q)y9VU}e)JcS^& zjByPmf@|g!eQ10ptiId{nim9@Sb7PT^T%Ha6Tty(8D+Ai_ zK&Lz5E3~`hcwH=b9{=(_(d&G}e!E!(S2!vVT%s|8JWB8M2;SVA?X#uY>9n!1K(L60 zR}VP$U~G3hWZSC>k&xGLEKkHI$f;l+hMz0=yfX?=%1&W)Qa&eRXX4yCI`FM10iByi zKHXvs?xiCxU+S~D<6Gay(8Ml35h@-D@F$!MC8QBHG721Cr@6!e%PM`$Ry=x6XJv|E z(LjNbrkY}fwe+%fHE@!KPQZac7P=wqXORv)+>^k7;dzS8-WsDv555RA#DT zO1lnox;I^mi9ozi+zO~i)j+FLg_de1hMJbR$0k<;JpCrjT6mqenr$jnP(6n0FvTi; z$b-hF5AK3By;!o&qmIepSWC2u067cs^#G_)X=ik}Nn=48Pl=w5xttbB;|Wl#b7Sw6 zNPVW<)MPp2`#R>VbcMvFZY56Oq;3sdXwwDKPGut}Ih2^cLOsd4I8tibsnpoY&kZ^! z6*9Uhw1U-o32mn;6TdE87Z!V!5xve|G-bB=Of2gf(V~*UCizlW?u|#xz*!3JixI)kcoyhiYsGnF}uxSrzCrJ z4Q$bZEu*-iXE>(6ZzNAzM>L$(K?MLjmUcloeUJ0sI3LX?QQKjk{tlv*tAUzzl5_ec z0?Aagdg55hG4GtYiqv#yILIWllmY2Psq#w%o~cOK$g3r~A|)onJMH0`7$TkJu=LG~ z8jjPCb*q|ZQHj|tcdLA6C1-!Gkg#m4?bNi+R{5f*CMx%8Vh-*>#G=13Ua^xPL5=2t=W0z4KtC^s?~3dQMf}mKS$~Qb5>ZCiXO4uUYX$RsN#YcPrO3TTi$p4G z@eN%^S<2Rh6dc)#;3S{|u8e7D;atfN?7GwUr|;}0(H1P3AJ=cqyb!EF2%L)a(IM=b zc+?jwX|od~P*%6AAy4qV-Bh9*_0-p*bSu_J66UDYfK1)>nchU9Ao^{(Z#J{Se7 zM$hd%?Q-e7?(j+uIovjdMZo?)=F(QJ;!$45>r)E1CVh4&s-~*l%@m=k50uJ1NP2Q; zZx?t%=hvuvYM+IL#f_;DuEq_7%@rNm*a|+aAM!p3XGq+Jn}>%QZQOJ@fJh3P)?6Wv z=bpJ_J)#r$$zeP46znZr60X506$WZjx^9hHa;U<}uiW&HEj1nU_~|Ty6&ez^F7xov zNpa!x4NlkiEFGAg?TR9jjV<-6fZxzJ82TKsTT7l=b8%v#8NAr+wpCsHWb2l@Rq~TV zx>&Y#%FDF7Eq*iQmV5B@K1*xd z5tN@zp#U3N+NsMDlbvPjwXU>Sq6wrcr-sck48B<^?q=E1CFXR0-a6I7>{tcQhg2YF zL_=_Dwj*p37v*tz<;raRH?r-USfh&wT*<{d8hm@3J#WWJ zK^NCnn?k`hw4_Ip&9ZZ+(8_w(#dLGtg)-jx>Dz)JHnCeGR5VmC&JuIi&!H}N+A(Ot z=gpC!xldaM6W<>sg4teEe(osRh|;*GgkX#(NMdQ}SXta)#;3AE*}=93N2(JZ4lgMr zQc33?@FsYVa3fa-H+)<0izH4u=9>h}B4m6&3`^dWVRa#w2q06DYK{{^iq6pONR*Bs^BEd8;Ug1ah6PfN08K!$zhdp6=h^ztAT|~VGSRTU zC0i$KoYTEazg=d*QGcsZRTH8>od3)p^LdKtK~xQ^5qL48GD^NP-zt~bL)aK{oU!qL z)W%1cq8B)&59waw9kJO1KjU zkshtkm7!gF`mmgYf-1q!`Um~hx*x(=!(ns@@thC^brwc?ZYzeIn8r~UC**PB(i_m& zj={tfX#Ia>RUBU_+$szg-wEL_UztxebA@%N#(JQ>x>H+i--t6z*~DTyfw0?Ad?zY* z;?i4m`fXcnLOZw6Okn45SZ6nmZ;)N%`*L*OR>0OEhZD;+Q92S1DXMGiI~U8F+j$iR z#1h3LDxOCTUC`vL*MnJ1>9JQ>r*rHr!h&|8LUthnHVcyMq0B)VWm9nkcR!S77tslF z=|s`gmA~kO(PWw(&m|%VZH+)jcuHujuP~Ag1C}TqUpnyL3slm!r4!F3zk}#F(04 zDbDtS&JCnf!7L0dd)#=>_Ks6>5ZCiqPAsi^Ib3r#I|}w{bXuecFt+t*VC|kz&{s87 zpYdx=hyrW*pXVPxB%(rfjP&e&qrR8{I4NR8rPGT9UA1NWo1o@x*R>F^=hoKa)TZRH zuFSI8Z5T@n8O+l1fowI06K^KVNtuwuN@rnc=2_a1+n3| z;30+Dn5o;0z2!Lh*XdC}o&{lb9WfM?B1Ts_HWr*EAJ3CF92MJJNV=9FsB63`zl1BG zBCUYwTDHvc7(|qUGd!Y}^17w_L84i7o))QC=224w zQz)2*mVwuajhYC{2x;7XgMwvI&%(g9Y%ab=y0gkHgUaHisEX-?z0BuD7UGPIk);_R zOC24Q+CGJ!Ycwe?7TtptA1JO-%n3?>Zn>bl9IPK*sgGfe@h#`c)nk&0S#YbOI$no- zi*CquLsl0N`HxGac}x}X5wyVu->de%b$(yg_p_=A*MKEj15uH#qRy{3i^RBTkj53) zsnhf1x8r~R_oUja@I%@fNE>UXSEwqVMCxquk!pv3YL-s1ax7}QEP^zM+Kx~yQq&S1 z$tLI5_A&w`)hq&1$#7>HY!?5;#*n7L7AtJwu~G|t!utNJHt}8|l*;vkr7u(sJEI-BYzp;hR49)UZ}F?3=5OxuvYh z-fCJJFI~ChG0IpM_E}6MkRq+%nGp%Zb;76}U7^55uE{Sc;)3ZEYYmp(J?@quew>@k z19-i{-cGr{-k0#@tD8;GqEXAZqL271`GqY;VVr!%{eQJTkcsPJTCDJ6OqWLgF{9*Fw3DYTd;q58&!koONVlnD-W$<+o5sIil zaa9=d)?vz(L52RIYJGQuSMEVjE)rOwicjl4#Yk0qZGt8z@L1Z?umizaop0u4+Nd3Q*CJ&75Y&ReV?lbD zo9;4qXPvvF_2Z>F-h{wRsbE^_fE$%$I%tiQ$Jyd4yhc-r0uz<9%#hHLTvg=*E%7a> zfBlGHK~Q+0m{>+%RgBH}aBQvF=#q6sn>xp@y2~Jd20=z>4rwZ=5Pz_k(shmEsEZ#j)MP1k(*L9|0!~NPgd&6$U1=QURU|K_%(4AJAhoKutG@<{qWg7=w7r}`MQcMpHiflOh;eMm=&D|tesN=T%w7>(JE?%NnTCco1qq?w8`oa0&SzB~HkFbhK@vJ|0M~qJ z?hjzW)P z)ky1$dsIeg>pnOTxkPZ8sw-ix141k1FbgAUa1@7;-r*^>K;f8JW*{ zYZ3(lD+c8x3S&}+?xJ4JBNw_{B5+LAy3m!& z+!|Aj(O0sl94#b-N+p8IRDRH~mAz@}F6Yb$BT`>& z#J<{<`|8_lUOx1QfAyajk3JaQPKpFo=%}xMN->Dg?z88%FR0Py|2VQ8 z)H)k#v4TB0|MC3%BzZtXoTcRXuYBm=$>^P6-!-Y zqPABf@OjP|{|pMU*4121w=)s&joG)D%KKjA4M#dX^ov5ZJcohtgvkD=N$qG!4mF#@ znV$h$n|ia#HepmKP(Y*!DC^HRtK{f&>o5ez7?{oZJR*LWQVs27sM{J-HjWR1P>D2- zsl=;Y{P^jDgX|f4)L_7A!+>{dpfXbjQ~H`g_2|OWFR3h~EsgI|AFX{p~O^)RMuRSf2#|+ z-p3eJ=(bh1S_LIyEn{RusoUaAErzn?6*L`%3Mc!hQ$rQgZb*^hGhJZFLs7y3B-=`W zCSSlR5fKqgp;TaK*>(eewdDgC3+rfWrA*O;(i6Y&Y01w1lmd>PC@c+#6n8sxYImCXDdB);+Mi|Pyk(W5-*IOv?@TJam0-#7+y*uRYxyC zBuDAR-A*gWbr_7}UvqdW-=q@mij;#QlSD}wU3%NYtQS*B- zzsZ|Uy-ipf>=gU8G@=msB^nb$EkSqq3WI(qqzT58 zcj7D=$GB)6Sm@M4w7d_aQXcB6IG1jYCK(iKr0Z-)PjJ44mBLQ3QLDJGe$lQK z*43D4h*Qj9F1?6cv@XAGABQ#WegxIVEle(=FN7HaF%kVt#2z-3z!Aj^4 zQH`|?g+1!D&-p)08LJbWrsULI!H00``w~I_qTdfF&Q)CRh#H$}5s?PDL>k0Y)Wx4p ztoubV3Wnn#|yHMkNZ`;&q7yQSiQ~nhm*VnJfynr4Lz!A0RkewT!V1C2RNT zN9TC)kcCz5_*`M`gU7eukA7=)A|}19^6MZR7YU-!QM=%8n@PmQx-yr!Avi5nL_=-j zP_D?i;P?D0)gpO!_g2PDsNSx_Ni2i*jhZ<N9H6sEo@V&9C5qynL%W}pA^-iaKCL*kQuL9}NL-7|if z$F4BBM6Sl?<^r=jb^mz#$=Bt52|HeXQNK&PO?M8kZLt99A{WY1Wbf;fGdiB_V(jx><(Ai)|vX zNE`g4214Zc=vmG!!@pw<=n&dwaM3$1!kieUx7}y>LEHUYXJ2CVL6NNi>Dn)Ne)Pw# z*!$Hx9nN^fj~0nn$ul?Z$4`zutk&4|5>d`78qCP2@auzrh0(WP!|MJp9=P4wqLF7j z0>3W!&&G7aclq40Gs5PC{m{6?03sE_KpQ`u9m~}fYg*V}ciEk<$RGFq^$6U0Tn}KV zF2(xfQESB&`uOFXN8r`rT+eZUMy;uRDfhKlXX~KWj7u0*sKl{`EeG+mOv-aPNux); zXiz=)n66WbOa(^M`8!@7l3L+k@6Upe;;0%1(8xWSA@1m=QYRR`gc`T*#6791L?QF=e;S7KpeC!HAfJ-gSL3ooM1g{#fVDX3gF* zw*UAr48loqU(8YXwX>f=MVGw|>ceeG!8MFIIDGziUSTYD5uCtXodkUSNf43Q3EE4E z+_&s${_ccuiBTD!l9pa@Qo=E?_4F|>ndv2l`?RrMnyqeVw3BOU>c(veBri0ste6bk z+{9^Qkr_yhixRV)pr)=I$dVq|Y$+q+%*!slK!r#zj(=0Z5O)s$4JL$E=j0Iy89y<# z18~z$iP@9Q(G4|7KhtcUt(!>*N5bI(;oQvT_n3Hmp2A!#(awKFX2&DpG0w9W!fQ~k za2K5d$=hxek1u0!j`zQ^bJy!+pzL_c`l$0_hD+>fmG|Wf4_6`Q2!}g}j-CVPSPFw~ z3c8&R3Sg~c0<{#YS;c3J#gtm!J8Z|k&vmepC%%dT^uEdlB(J%gZAaFCH)ttk#)OgC zgN^o`%WV5`gc#^yj}b))s$Gc74Vr3Y|e^@i9evn%v({S2vEO-4h$ZNZ+b|81371 z&;yJHvTsfEsy=1@9SPe3l9whs@1VKSKS<;P zN}tb-FFlG~;_Dd{?>=$}!Gs`JZv1y%RHK+rnYPV4CnzUa+>QsTpVBL;m|JC7`)Oo*lTECoMk7GT3`?JS2sa{}i*F34eBjOVkPR-J&u?#dM%M=*`czX6%%xZ=idmKqt(&BwIoxEOmb{uAwBHL`H)WC2a z>wvmJNJSMGY$}?lz?-ydlT)0DE`%*M;fMkw$^<0BuQ(i%NJ0$ZUXohXeWxRAP$GaO z_hg6B_{CDh>HZ;K<@N{1b)>UQi~nCl-wP>E_7;G@c3{22dCd*-X9QUI7cIeNq6*l^-2 z^~o|oPh%++dWJ}iq1HGxuOnF*b^>Cb@X70x$2qiIuK@`oRHpY6L7Mrbup zm>}fFNMjJdwZ3SfxWV5Cag?})!G5CSAk?R{1>qVn4Pq#dl5hMgMZpiBZm2z-M1ZA}|llt-46(Cf!Q-&28jET>K2NsR?}(C^G~n0( z$1k7XoA`Ff#{P+8IL}ari)kQ1#uu+f4y=e8|GJEhI~$0RPenxf{>P8X%_qJQyp+-A zqazYmv(hj+fTRVDGeIWTp}^Jav;Y zb-!sK+9u1;6m4AdGj*^xAf?~sj}uY7j2Re3yNf)a?F$3jb5aX!K@mV;=}INl!X(%e zk!rNH0V=d>Y%NiY(rB3-7H10c+Dk5T>$>e<7L0-8>%3PV>W^_{ACy2 z7A?7d^ed$!F9mzR#vTg>whIbb84<(^C!&8$5JP@gi#O}x>WDODQf92zonyJaTUOmz zCk_!jJ{T76!WPDeH)Ue==pE5sV$k~v2I-73SGOXrc-~R<1M}c)xGLy41~4nX)5F=X zLj9djJ}AP7#{IIMmFwYmCfbx~k+tdS5kk>`)h55^-Nj72PLhW24FC!Kq8e4DNC%8YPcjly{~gyUuh2ZCNJyJ{=~-%1RCL zrcLQDTiC{880&$V=tRB7l?!8Co2gi?a*adVeP=B7)@t}ItjI~mg|TI`d*EjbhfkcH z4HOY?t3XhYlt5Ah{hG_^YSLF=zIky|G*2}QSe4BLjr~t09AGjpdLjZ8tI-%hj!wrt zs(+xkG=90$FZ{6rVyAZtoILvE3>bRCv$JYaTC362bF0gQ4;K_o5Kabqp|IL47F%Kg zr;D;KY4NN_D_}o-J~>IwglmUm5C*3cmDp;D&RoTD>4fVw0qEYYxdH1Z7;kBmc{O|9 zal_MhR~08fy~7+0Q7`nQ91A0Qak~IgGYyv4iME8@=@lxlR`*;kyjxQIb^r{bU54zG zMoDnm905oT;(fN*`uO&zOD6f>>U{i4ulWwwi~k2AQ6@%GA;U zS9DY1lGZ+IW`V;uAo>Tpqv!ieU;L0zxAH-jM?g7izR7YAIE5I%Jr!v&m*JG!M8)G~ z4TT847CA_w$^C4T9ha-ivbrpdL{gh|EGl#XuE0M;A)HjfkJ3q{1R?6Z7M;b3jTkBOUwY2FT7zNFWS z?55@$Ksa^_y_4beOXf6)_)hsuYA1^+c_0v!vp{%M*tEAu(im>JLLM(#+LooaeQeb+LxOGs4I_)hZm#M_HVvR?QGqQ)O&FfMiLf_ zBuPY4vlfm+JCocafhBZZuH|GoX^}cJY{6xU{H-T>?%!_!~M9 zq(zg$hXWb^CXe5Dckr1xfin}v=2T{j4nj2=Y0{NoVY)}g*OXrRhXB!W%>_#y%T1-? zLA&$NjgGERY09L99n<4#{lxq-K~BA3>V10!kx@W2z zaean6!&0nF;JvG-DZ|U^DZXlDrOs-A^8^(*;D`pitZraE`if(OgG%>1nQ5OGE>_N? z5@e?gYV|aDyE$%CuxU=uX2T1W@MUpY57?24nbX^xO~g^T;dE_H)>3KIJ+c8@|XN3M;NLJMj7m8dA1x^m8cjsjvyj* z-88zqEo)%z_V-Spdc<)OCiFmw%ZlqsA)js+N|h=q0|&)C_^*A9TwIQDjb?7n6uPKY{OYg8NXOU2j1trw(UK88NG6T zDJsYSSNc*aeeXOLeE9M=BbGQ~KLOee8k6YlxhJoZR?PYX3@#C=u+xGwT{A~5VqONC zaB-lDMms1TR(zFMb&YO&uEahn8;ld2wd?5@+anEn9MUvk-ERG3gvc7YizMRv9JASb z^4;0v+57JeFuCFcdLZn__&>xT;o0RSGG1Qp_`2-DxABO(I}`=C1tF#1n%=-%+VEN1 zU>O`TA?yHOqD>n}2lcnAAvJ(hl>~#IqI4%N=y#JccKR+a5On)u5%Zc7J&u=R&OAN@ zt9MA$vbJ?&X4AVblti37H*LNaIF;Bq{q}~y;=@e3%O5dc)%c0~pUmLagK}f6B05Re zv!X~jcARb)_tpScg8^wIRn6wahE6KZjBASj3|M)yq@=qVC;yAx7uq-?lrW6=j-(O z-pjpVL$)>D{*1^FcX2x9sMW5n?}> zI{6t5<}>utUx{Ic;JoIW-@j%0tXs0e?G76< zGTiQ=UfRI{@+00H<#<{#aiu6eyuEc6_}63MUmwbax_W3xDE5n6I4EFTqU4;Dx0MxP z?>&D#EJqUbbAUe93ny5@-q{^Rklu_%dUJ?ND=maZraM~WxZuMJ!M%7s_7ef+p$$ye zH7gLf{n2pyhis{k9HF7E@kwQz7h^{wP#)UwS*cO}s~9eDyQAS?=-}RCLpTb;!Ds}S ze;@J(%H?_@$t48i^=J$j2A|+;hD-ZTo9k=WN=&iR&3c|i9RwXaTMLQJvd-zPklAd> z&Xt*DqH{Ohw^sdT^lQKvJi4k$bm4f<$KoHxNV~7bBJI99G@+&B%a~}@*zWU3XyX@! z9o@iPXdpESPQtTN%o!Nu<;Z#V;^iTE29iO&lN{*0ylx&)g{Ftr=UtyWS*ub1@;)7)BX2AUyW5>b%3mjUSffer^KAy9a_{YS=tV?dSF2>&-yMFDy zrZ0~E^tlAT_ctKM+Z&6w_ZnxnCZQHfLQG?M&PoS{>*-D(4tw+S3K#5o0%F9E{K7w8 zW1gXfyz9%|v0%GAqvReFzRAyd#`c#Cv^N%LX!qaSAKRw=-9tB+AaoS8Fg+(zFmLYd zk8RvOH10EP#xZVA@Xf2Sfbib3IGkj# z-Q9}RplK%%?PYWWZK1uy{qr|ThVsr$hC(pW4X+J@`yHJ4((~Jl-p~q34D{+?NUJ75 zuTbn|%264OtS#q|2ol2S(H~K0Wu7&$zw2#5PFUr*PC{C zv9cmfvlY2eFy?GIms`R%tfSj7M5$AhW_aNAkU1+Y=Uaaw_@V=j668}+mmSn{)2uhm zQ*p}N*Jor7$5h`M47(RCef!bWKmw zy|`raDvkw(ip4mbw|7t)5gd3%lN~;)AX(zPK)YxSmQ-o@3z@pao#( zeSudztP`Z>J9>4Tg>qDGV`yL!8RarMcBex;RSp3Wsvs>4J81;!u-kveJu*^Vut#w1C0byel}g+#Uaj=>TI`ySEp zdT+EJ*%{HR`h;D_O;ia)Yv5E|ku&JPV(xvkGh#erM!Tw41$1VSPl^0_raZ#^_>=)l zI@-w>u&l$^)Xn{-O={k9EcrKud5s2Or28oc0+68%!=}QE)@Ron(!jK!&j9M3Ksl46 zG|9lapN0!VW&&J-syF@%ElZIrZvNN;JGS%&qu?y&qxjzoEn3HLz{hO0$rc7{VWP;^ zqws9hS^G|S*r`W%%{fuiiPIop@WE;v1nZYFO+`VRic_VoANk1saTq`_A>-=SSBpeT zcGtr*Lx{^X<~65#j;g%5988853K@f(P8v1iu8jxlERk48JMwRIx;G#I;<@h9COEdv zG&rssGg1`_F=79@tTEHuw$cMZqzpmxn@;9zUp*L|vz2;~JC^_`%$&2>@l#9~vKsHT zX<9>Uwsn_os^@7)%ISf@lC+As%M73iE5Y5R2l6vM1Hc0$-&mV#YTZYhjsCNUJ;&j~fmiyI7J{iG`15=Oj^ZE-tjo2x}ZK?n2@ z6wj?k&NFC2;~A8F;=E?G=y--@lo=fF%-QOH4Ksg>Tp?$;V3^DxjIu1}G4a^TO0VqF zEc*`d3L|+BOXfsSB*{!aU~;`Tl>lN zK6YEIQ)d}`SD&yZ*$O;0Pl;O)AB1apb%)hHmC$dQ?>dMfwT_|1u;I?Z7VVbxl)mLra^&`pB{!=sz4gC}wPTWB@B9gZE8oZ3kcIJ@4K+pagJu{nv#9q4 zJBGQ=WO$as3;GME5&0(HE_Bd8kX2&`F^)0UcV-lt=Ty$&XU zrBE-u$9tt}YquoxUw;5sFVJ)=O>C9J;<&|d&Cv)IPT=Wm8ULmdn$T7)Od7T@(U6gV zcRedN9l4~(M%%iO9uuR5fbkmG2**QlrfJz7cFY8f?J%-{0G)FPUGgLnRtJQdIJCxF zpIRnQEkMY%*FS7R4I{}qp7|_=!N-84!y%WRa=CS3xwb6~htV8CnZBsf zk}KX$>(fUdY+8%4W1^#Q3V^l*D^KUN6Tfu~!v*gqlM{ZL=+m9>b{K~2Y?#S;AuDWP zyatp?Vc3}VDY+=uoc}VhC0K#jSceV^w$xdRzh8VrkgAF5 ze_V$<^<`u?UUGG0<-Q0=xcwwXz(-)Jaiso5$Q|8FC1#PAPs^F2FcLx60WOw-8`0Pa zR6XB1#+rauX7epJNb3eXjc>ik_>6uDQvPE8l*@bvEM+jNK#rbQo10eW;1e4?CnLo# zxwQTS1;|-#^FGy(ptY_%Az|&xdZe$~CWzf9(Oz1px?I3$3wUSu>#T*5gQlZ#lu594 z%~xIsjUnx~IB$rh)g{(Du}#F765~(mM#TZaxd@Jvh7&4kHq~nK$ws-%(Z<3|d{5+i z+UbTM%<(4Q)TjoVCVetbK=>?Xx3lFMRYT(=X+k3wGr4W3BrSWySf*%lS2aot>C8>V z4p1eA&FUNF&27bMRReVbJa%|fRN)n8hTrZS|4ATFIibh-YO~Gf-mFr&#~Pug*QPO_nE;gYXmFz^hbXfOLGf{s?5z|=*UZC21t1v z6g*<7z!(`4o2qeg+h|-UjghR&)-LLKZK zCg+>_jBCKyrtQO9iX3gcK5Vnr`FgL%pU(FN zKzBMn;s6ECc0GyS>In2}*d1Gg_@}Tim;73mcP*s-u}J%ee6CMx_G^TZLQ!CRxL0H0 z&=GSThBbR~`7^1Mh4!u8KM#5=-l)5u>`tEG=%fsqq#U z=fv%2r>gTQ=_$^E8l7Mk*(0%D%8xBgN&q2Mgp}|kLjB}(7V!4;E0nr#;JiD@jQQ&R zKC9{xIlDpJ*;MtWJ~TFpxf7u3-UO(k;2S}y*p(@;)V&+iyg(>BoFhVV?25^>;0koV zNo*hubQhcbCwK6=@qR%4&NOZ1dwpA6H%|%2MgSU-jehi|;OdS>WpM(;)whfM%Yf*K zBt~??A9h3#w+1z-;yFe=42@sHVUB88p&J_kY`hDziOwe1!t<1_so>{*#3Q$X?(;#PES6a z9rGS*7ZlroZB;+gI#K=bFK!06qW=SoZLs|`@K15g78UG}fdQ~mPPr#xz+WqR03c>B#I^~ z$>_Z=>BdqDq(f1eqKv`Kw8op>TVR8#JIyBJ=@y|&j~@8;<#}xEWle%NNjX@N%WVOJN2?z z53I>cFBjnX>BX6y{>Z(R`V?VQZAvKpGFYGuW=xc`yL`aeiD^3f3UhAPe&RK6AV{&> zM=ozMds&D1{!wuH`@(w{fogRInhutmaR?vEhV9$Tu>u=S3YquMmmr!{?}1MG^ScQLpaQtm%<}A%j~8Q%fjTY?3@!l;vGJ?@7-j zJNIj4ZUyU!?b=Syr8q}6{epn>-p&oRhi~KRH7!5zXWcbgA4sgb&a*o=m#%{B)PLf^ zd=Gd1RX)OiSm>P`FT!TWwM9gaFG}`-n`GS^W4(*3%;=qCm@PV-)`y%^+L*-BX=iRj z>Wo3L5qJ!Oo8opgvN7UeYx10tJOK#g{bivm%r!FM9Y2*1ofqs$2GHU@{|Cn3qNb<` zF{{mL5DRVCml#-W#_zF1Ox#EVLvAt1iBZ+^^YfELL{#Elm8&bfNQ|e+vjAp|T;U~$ z;o?=D(CQopPtiOMLY*riewSiyH4y;PEb99gmwN*khBDntE>6yq7ti)~>ZUhYjBhLI z#(Tn`>Euym5_Jz55cpV*QFI;fwGfGpN}S{nNautWOnxdT%Az%HH@PPwcR^OJp69c= zlXk+n0g^}5JJa=q${m@`{Cc*u+Yo1B%d>~9Ldzi>#y4fxPj?XVcjixy4FEz{RX)E2 zic2qi?-n90L(#d$K&7Sz%l$-r2gss7MX(oK73~G_DZ;%Vs(6n^E7UD@Q?4h+;FY-U zhY1_MaAwqUy<_wWqmE8K@wQ>Uff)(2s;J`|R7(gswhX|ZZxNILoAkuE;#gq62gd2y zQg|m`BfK*bDu{+H@BQTl89x!9vkJOs4`@SBO$Ga%xjK-@u~iF+v5m)Vn-14)-8G&W z@OExZe_Z9a*?kd99fL7Qk<6&nh5x(nWmYf>{QOC9unJ9H=I`AZozb^)PGZMwP1Fs!D`>qr(K@FOMiF}% zfynDw1~mDfPga)`oO_M;WH5==@lCMmEe8pHMG8o7GouTj_zuPljKA2hG^qJIvyrWh z*CAhmCu48pnLIV*sQ{$eqPSTtqhbA+%7l8s2*(r``-kMb_?mONog;-%%>JuyAJX1* zGcS+vG}!TB1P!Up9E#I_vhe^kz-hg?VrNVY#eynL2^2gK@8R5Mv!{#A6}jKirC`3U z#+mY-TQ1+M7vLnoiEE-9dqG3&m*_xI>cB%jPoy zS$@dAE2~_a4YTMWCx82KjPgY=tUy+Yguo~;{<{J5A}F7Qwy5h3H-h64v6xP#)?;AA zWiO=^Z1&KuaQ$X#KGa24dG6g>oN^lH_@$JGWACNRD=~NK0Op($XIn&NcOlJjW(zzy z$5=4qc(etWqEiZzLxLKLY10sXsmjgTxM=Q>C538} zhYn3-t73>#W;U_^h8T&EnfQ{5vbc?rkLb{MVOR)4PuYVfbz(L)z?1>x@4x;J4hX?{ z^3fAUM@sqH;hb`t!g#ycgvD~8)R^-eOf^g0Y$cg{^TCVabt+)`Lb}Jrt?^u=}hTuM!r{BQ$ z5nD44IY4sAs?>FYpBCjRcCujHfj!wnvO6+APSe|b5f2^jGCKkr*Ly3SM=&eOqqH5+ z$^~*WK~F|nyGT{O&a-AapvnazPk`-kY8MCh;_YBIF3jK|rVr`fLArhVcV9jIi?5&l zsjH`d^4%Qn4x|%1Vmnk5I7op}d1QluOaxsxK+A%Un_Ivv z9hg;_a@3w}fGo2G+#b#Cf4L>v2BvmkVDsCuk8WI)O6Bp1AWaM84tB@IR$t!Xwvevz z#6&!0HDJfzW?A_3jfT<1x9X(X6PL~FC$4c%9ej%?t`o~AE)dldXL9|-Dcn41-l6(! zKn<&8MikHo&Y9Ri1;yyzKu%3npo8I`o3f!R>S~NW)#VYjHbHHg+mXsmBK<8}Y;w{K zqd8MkJ;vG{y18dnBr|D@F8KAL*WGg11OOq_-4g!ZeLCE(1NU?^1J>Nt&EsP5fYR6l z&_#2XoHNf(v%#ArN;Nh;P9HJ%xcpJMsTF_Nv)ZQ7yqDdhOM}|RB3t|@ej(S3@}U!l z{>XAO+Io%3|TlQZ^9tnT^rNCO>SX&_Xg%p?;Sv;T#5$jru8A zt;A72$sWnIjPT7x;ixWTa&c&Z>A&G5LTn4g=4knX6UJ|9cGfs4%eB^3$Q2LS%oqT)BBl}~65t%N? zTaD3SAL!eK!tkdUf(yp-v0-O4veNEc&PVql6kd*nhb;!x*bmXLYI=RwJ!j}^(b9Zu znG`9PSR2JMug3yOpP`~vT9nUj7fQE{lXNzFoFw}xMjg%LR1LHd&HCXDkNB2jqG7K`t()(dlsp`*7aoB` zy!m24KKFIn-yM_ygp-r|hU$1+690e`^$H+BRPsL*i}@_8=HuoYY59Lw7K0LW?C5Kl zMnMH>#J9o}zzI;A#ti#gqlaGTc`5S|LWoZ@`;j=K&au6w7Cl223%VK`IZmKeW&g6C%Il@FK$u%u zhDI$Jx@NW4j^cWJZvbs;bQSC^u$VCDk5=kqu;^qtm6R=vOwo?BPHfOvKfSjM0>FoW zNn*A+Ik?M?NP#1_2v-<9#SHKcL^E)r_C-x!ti+l4ZqBP1j_zLzG`@Ny$CRdMHfDEp zkj9_h+y}bxb@^{KGVS`d}l*dDsENwe3r%u-2VHm zTps@u&$>raDlqru-6UPdd*x_uyAppJh2_h0f-sO*1#cJLwU~~rWMRujheAS6mN34uu#YTtzX~Oe=GE?g`x5$=P z^K3lI3DdV%RlGb*o3dPtR4`o-Dekv$T5Dbm#Qn%$8Htw7<}UyOQHz zS;q`-BeUrv2Sr9D7<)N7Hb00*JK697r}e4AhnjGT?AW-GqzARI))V$FqHami@SgM* z6rDcLY8d5RFZf6&ompO3I}9)5-rb~}C5uAGjC(guwSe9E|0F+SqLEBrmocm2zLT{g zHVDpy*w@2T2HfT`?O#Lu*Zc?b=n6tOm@swh@#mA!woX4)wz`?1qvmw6z|z)8L8oWc z-N>o&iPE;hnV5Kpzn+!rJa~s51355n;xk zJuc|7k(7_j3X_VZ9~X5^SHUaJ+A*}qw_={0F>i7zybkV^{nS+!+YvQQ1&*gGC*ub} z(M93}^)cT(iWZq5#4U65-gjZ>nSHZfOni}xjY%wwC-{-6Q2pkqE&Tj=w%5354Ft{5%S>hqj z?riqpu_g{^hG3Gw3eauVti&m;3m~OdHv;qaL;3I@J4zACQtb3nI7#t^5bSi8DmM{p zcpdX>T6_&ol-a0vdXzifZWlyycS2XC-x;i7?$%)LJLiPvRS+~V^+GF%JMx1#&ZLOn zJq7gaL9nhSeoH;PGl+r}g|i)Z2bZ&@L~#5qC#Y=e=&vGBzJ6;<)of>xiC5+IY2 zgMjW*>@LKQ>rtr-EZwx!C&ULws;nL~lm*I^DTVE}7>*4}TtvuB)@8gm)L%Pdf-;ZJ zvPLlmjK%_fV7{QNsx1KITicY%%g9Dz(>}y>6YI zk0`|UrO=W`fTqOV)PS4J89L=gIdxCKhm^!LmJ+wk`9X+nVwid_7^3k=ABnw5jF{Ua?$m0-@5QgVK=u?Y4l6POgj?mYnmHaZ)=@2U-!(?!}-! zA*sVk{XWtUgpR~Jo2Mia+-MTP&B|`dlcH5^R$1KlBoNQ?Gtp;8WT%;MRWuJpoxAA> zH!C+o=ENq=%UNunha%gQxftg;;Ue7_f>Ty|;fp7}5rTI7LC$s~g;Rs;D@Zq)xB$vJ z3q2Faio~d`cBvg4X%i8*qJS2m8aTv0t3k^iSK0A3)sdQvXZ<&=t%=k& z6vkwH4fo+1*8hDUrT*{x3eA6Cm*0QuzFrn9GG_1fyll@cj_sj&GYwW93dHN=6n|w_ zlJ%T2r?d2Tm?(k+byxJrrtS8eD>X+`CYPx%aAd+duCro6sxE`=^~U3bsC{ph$6&!6 zxY}G__e4z^{47__*TB#ZCKu#ZXfq!TU;a9)pD-Y=eL#vP_k^h<{4VCzx9Ypux9Ya* zZ`ECQ+XLM(5IXMm4ubg-9pzt~-TjLbR!<`%ZdP}z@?oX1dIlm@ zRtr?bRVYZ?x$~JJBzBJ@(=^3m3vqD04G+l4bBPl~X`a$}WNGqR1robh33H;%2{HpH zh_{zl=%&1_xQ+-ZBS0gm^QKFx#5NE?F8pB(b6m=$a&tvQ(rxl{j!TrW(EXJ2C3r0w zW>me%yQsy7R3p`I)mG!-55@cip=URXuxU~Y%KMz>)=2e?KISLF0pL2n-Yg8*q~H&CkQL}y6);UdP0DnRpoubE+)w_hOi_v&};?ota*ARc>z}txKyJ8|3*zM zCMfV7P7{t(#1OF3z?#zyi_SPw)OLNuXO=%--QQ>JZVK`{s_n!$<60p0f>=y!2ygO^ zCAYydr;cz?upqKIZ6v~D;g)TaeFlKXL8oLia!5`wEk#q-w+;-*4ig%53gr1>k*)G_ zQ+FHHUD6rFThLq0q6HrB?KuLk!IHFXV_KCuTrk+mhai&_#oF;Z7Yh_d-ksePZuq8d zgw~s)dyfteHGQ>3qOdY;h1=EUrjFjjliN@td^_G-yB96p?ieu|ySJ0=dD=Tmf7GGp zG3&q^9(F&PQQ`rZF*0g|{OEpY56At?@sHfhqNbJoNm#9AWy0>dY;p1V;yC&4m(z>y zllvmWhzZxl&4#s1JD5bbXd;ORO`#bI`e0|XDdqzQAfRZ6|Gr08+rD(6&_PvhR(Xl= zLaIew1rr#&jEB8*4M#9CGEvX->tSj{t{!iTo7+%VYMFc4@*5td zeno~83eIR*S2sJ#>`Z-4zhuW#`sB>ta33Ye-%0&2kLmW@&i>XD7qt z9iPH4?f}&#W+j=U;F=G&BDI_gIDf*<5@*^EFfHMzbqjma-f&ey>hO|JkjZ+1F&sf8 zyPMSL5;G*`bG-7O)NVA-SFJ{GT|($^=Iiw3-oY^E*}Jm@2oJ5%@9_e2aI~Oa?v8|d zxqFzLXV*IUU^BzZRE|v3#@ru^xqsLSaRZyru}mg0k2zYPa+Ex9TeXbsgqP3>FkE3H zI;JFHbB=xSHfOgBG~7I@^5g>?-_$+q3Rh3Rw%5ZSm}`5Tq{-2oBmZD1abtbWu?Doy z+OM0ffjoX1#||SFA8kE#Ll^l+zCu zrKW;s;>?J2-P!bN?EAgK_bcmX^$gliaeY+6O#c4sf5SoeDsR-`A8$Y4PkS4xZt?BP z$G+_=n984W3bx7agdD{dZ(5Ak_Ph5VE-U=BGckcWidBtS zqiy(*R#mTGj;sm@Q=V177OSQMGqy`!@8d)@-+*SQ$geP&s`5**MEAX1Joehv9E`07 z=FVw$m%HkllMHG_yQvH$XiDxCI5l=&Z0r*E`ZX*Mi$dL$XifO%N6MGg!5sT}U&H5R zKi~CjR_82Jl9E?cU=$%Rw&T3n9a#+!rf}}5O7y|j#115Y(X@c>!bBzjM_n%`$le%88LF!eH47%U4Mg8ghM=PWo zB-E?aT{r#UI~ZDr-)0*gY=@<_{LP|HU%W_P>`r=r6Y_YtQbXF}US=qJ4A<%qTZFI0 z8fN)$20&i8AiEKe-2sqY7i2F2vNr&-=YqV9 zfV><4dFg`eM?m%mK=xgbg9ymM0LXz0@+t!IY5?Tbjx&V9<76*5PTm`kJ$Ib!MaIcq zaGbaxFIMsyPfa7OzTxKWiLUFdLf=B6B!?hRXWQlMg;mUPGLUa@V2w2SG{mxjQOGK ziIQ>vn`oRa9>_{B4_*&L@%aU$yfcg|SWy(Kc37z7BkDfd=&xUmM1TDXPJGnTDw(xa z0OU2AP)hH>8@zs%&YiRS`1}oWkpEF@LgpTvnTgMl6v;v*@HYJJ^O5ko&%MFSPANwX^y$^6$=wL# zp<%thyEnF;J@+-L3`RqaH=;bW(TJrfRm0V(WbAj?#e*fDS#IGZhlUWpbdS7>c`z0e zH830k0oTpIRcsgg^;qoJ=IAaL;CMq_mjG`fgh01^zW6zP-Kk{k0NQ=ise}%sJc9ular6f-sP@-3m1C$baN0t-3Wi@)-A;S zma@sPqXc#3MYhK2c;#r$JmAOmC|stqoUio01lD%wPS%*kP+rBZP8=8v`!o!Yx~%j3 zzW3VVl?_~b4?@zKzRo8!*j#d4&%-4BBLNf_lm^%9VN4!eFjG$Qn{4)&9P^HX;STa@ z=ItW_`erQX8`6I}Ms%EiIrVZ`x8Ywt9|`~RIc-xj_+B)#ydLSG?vF)21$}>aB>MjDAt{wHktekK+4^xN!K>Sddt(t{;Wti-l)HpNIehnh2l3S~BKqx0 zkDmFg8yFn$${HQc=VaWw*ffDz zc`$Z>AHV=Vzbzlo*n-wO08_&l7($nq%dA*kUUu+D3?DhEpdG5uK4wM4^smd#9o62e z%c1-1SI%9zw-g6f=}Qirw2};8mZeSW_B+)Fvxyi1r)Zmlj7f*4Y?^z5em^nk z7-4AIG5FDNY`a+F7Wo%UvU~|Wxp=G#Yb;_pukz+0&oNXA;Ny3EL`8aQ^j>Fw{s;%b z;$~$L9+M?3L&@KN{a>X2`>+23sAPj{d@lEyi$|PZ>@u3zd_{ceN0(OrvGY*OC4An* zz#nwl7mLl9jZDi9_y|^MVK~BDp$xw*z|0qmdL#r}nZ7+ap(EKDh0dAfJ3Pvt%424ueGQG+5B*-H*_M=$N}EKOgk(wSVX!*OaW|Ey5ETfO(`5bT5XW}-M2evWCALP#(VpLGp3~MnHl~{j+>7rSosW# z6&XR+#^3|V?C_~CX|I{=F7;(z4O-g*jT_9;#yLagHF*m3n;QB6XY7-pwtNV}VGgIk zd=?%HRLn0;%D~7F3U5LFAOf7!;G_gg4(m_FWDo#cMxxX}fxg@yrzfbY6caTQz5yuG z`^^HCK3758{s>fy2XV*=Y@ox}kFa@Wje|rkVosMY7r3GfemH1Noqc)6v<}=Sdf>sW zXP9&zCSSkhE0aEB(w6-z8Iw_gxQ~1(tEYq!0d@@}^2G)}nKaAr&8^4k6xPQgU(91W zLrseG?!KT*x>D2c%M6ZbTXq2fqy!*My0jcm!gOF1xo;2XzHtatwgCEJKK!@{F8`#i za|(98=5)$rrQVRU1Q4g?wP*mL319Q7T>d%6i?ZYKbH2GET>vfslo~=khSMZV{sp+F z|1dEJzKYH8l##^-2$MpTFv~!I62a~FYW0zfH>>b+_r*PVd~T7<(4|NCIV|3zy1}($ zLk{4b8}3df8X-(g2F9pIy9;Uk*|pD2_XE^zzF2PubL+xj(x~lVh|@tr1;lnpOBcoo zB03q!YmYPYCIhVW2nV2FUiuo@8v9x_jdeB%$+)baQMb^^|px0?n0U{Zd>3HuM0-UfGxp@*8!Vt z-ES_+*1hj_{9@}Ka#6PL8b*;kAA@@t(}lJ(E*X-LI}i@1JIZmXo;p)77_q_l{{c)X FVOM~Fs^$Oy literal 0 HcmV?d00001 diff --git a/python-3.7.4-docs-html/py-modindex.html b/python-3.7.4-docs-html/py-modindex.html new file mode 100644 index 0000000..30beee0 --- /dev/null +++ b/python-3.7.4-docs-html/py-modindex.html @@ -0,0 +1,2052 @@ + + + + + + + Python Module Index — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + +

    Python Module Index

    + +
    + _ | + a | + b | + c | + d | + e | + f | + g | + h | + i | + j | + k | + l | + m | + n | + o | + p | + q | + r | + s | + t | + u | + v | + w | + x | + z +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
     
    + _
    + __future__ + Future statement definitions
    + __main__ + The environment where the top-level script is run.
    + _dummy_thread + Drop-in replacement for the _thread module.
    + _thread + Low-level threading API.
     
    + a
    + abc + Abstract base classes according to PEP 3119.
    + aifc + Read and write audio files in AIFF or AIFC format.
    + argparse + Command-line option and argument parsing library.
    + array + Space efficient arrays of uniformly typed numeric values.
    + ast + Abstract Syntax Tree classes and manipulation.
    + asynchat + Support for asynchronous command/response protocols.
    + asyncio + Asynchronous I/O.
    + asyncore + A base class for developing asynchronous socket handling +services.
    + atexit + Register and execute cleanup functions.
    + audioop + Manipulate raw audio data.
     
    + b
    + base64 + RFC 3548: Base16, Base32, Base64 Data Encodings; +Base85 and Ascii85
    + bdb + Debugger framework.
    + binascii + Tools for converting between binary and various ASCII-encoded binary +representations.
    + binhex + Encode and decode files in binhex4 format.
    + bisect + Array bisection algorithms for binary searching.
    + builtins + The module that provides the built-in namespace.
    + bz2 + Interfaces for bzip2 compression and decompression.
     
    + c
    + calendar + Functions for working with calendars, including some emulation +of the Unix cal program.
    + cgi + Helpers for running Python scripts via the Common Gateway Interface.
    + cgitb + Configurable traceback handler for CGI scripts.
    + chunk + Module to read IFF chunks.
    + cmath + Mathematical functions for complex numbers.
    + cmd + Build line-oriented command interpreters.
    + code + Facilities to implement read-eval-print loops.
    + codecs + Encode and decode data and streams.
    + codeop + Compile (possibly incomplete) Python code.
    + collections + Container datatypes
    + collections +
        + collections.abc + Abstract base classes for containers
    + colorsys + Conversion functions between RGB and other color systems.
    + compileall + Tools for byte-compiling all Python source files in a directory tree.
    + concurrent +
        + concurrent.futures + Execute computations concurrently using threads or processes.
    + configparser + Configuration file parser.
    + contextlib + Utilities for with-statement contexts.
    + contextvars + Context Variables
    + copy + Shallow and deep copy operations.
    + copyreg + Register pickle support functions.
    + cProfile +
    + crypt (Unix) + The crypt() function used to check Unix passwords.
    + csv + Write and read tabular data to and from delimited files.
    + ctypes + A foreign function library for Python.
    + curses (Unix) + An interface to the curses library, providing portable +terminal handling.
    + curses +
        + curses.ascii + Constants and set-membership functions for ASCII characters.
        + curses.panel + A panel stack extension that adds depth to curses windows.
        + curses.textpad + Emacs-like input editing in a curses window.
     
    + d
    + dataclasses + Generate special methods on user-defined classes.
    + datetime + Basic date and time types.
    + dbm + Interfaces to various Unix "database" formats.
    + dbm +
        + dbm.dumb + Portable implementation of the simple DBM interface.
        + dbm.gnu (Unix) + GNU's reinterpretation of dbm.
        + dbm.ndbm (Unix) + The standard "database" interface, based on ndbm.
    + decimal + Implementation of the General Decimal Arithmetic Specification.
    + difflib + Helpers for computing differences between objects.
    + dis + Disassembler for Python bytecode.
    + distutils + Support for building and installing Python modules into an +existing Python installation.
    + distutils +
        + distutils.archive_util + Utility functions for creating archive files (tarballs, zip files, ...)
        + distutils.bcppcompiler +
        + distutils.ccompiler + Abstract CCompiler class
        + distutils.cmd + This module provides the abstract base class Command. This class +is subclassed by the modules in the distutils.command subpackage.
        + distutils.command + This subpackage contains one module for each standard Distutils command.
        + distutils.command.bdist + Build a binary installer for a package
        + distutils.command.bdist_dumb + Build a "dumb" installer - a simple archive of files
        + distutils.command.bdist_msi + Build a binary distribution as a Windows MSI file
        + distutils.command.bdist_packager + Abstract base class for packagers
        + distutils.command.bdist_rpm + Build a binary distribution as a Redhat RPM and SRPM
        + distutils.command.bdist_wininst + Build a Windows installer
        + distutils.command.build + Build all files of a package
        + distutils.command.build_clib + Build any C libraries in a package
        + distutils.command.build_ext + Build any extensions in a package
        + distutils.command.build_py + Build the .py/.pyc files of a package
        + distutils.command.build_scripts + Build the scripts of a package
        + distutils.command.check + Check the metadata of a package
        + distutils.command.clean + Clean a package build area
        + distutils.command.config + Perform package configuration
        + distutils.command.install + Install a package
        + distutils.command.install_data + Install data files from a package
        + distutils.command.install_headers + Install C/C++ header files from a package
        + distutils.command.install_lib + Install library files from a package
        + distutils.command.install_scripts + Install script files from a package
        + distutils.command.register + Register a module with the Python Package Index
        + distutils.command.sdist + Build a source distribution
        + distutils.core + The core Distutils functionality
        + distutils.cygwinccompiler +
        + distutils.debug + Provides the debug flag for distutils
        + distutils.dep_util + Utility functions for simple dependency checking
        + distutils.dir_util + Utility functions for operating on directories and directory trees
        + distutils.dist + Provides the Distribution class, which represents the module distribution being +built/installed/distributed
        + distutils.errors + Provides standard distutils exceptions
        + distutils.extension + Provides the Extension class, used to describe C/C++ extension modules in setup +scripts
        + distutils.fancy_getopt + Additional getopt functionality
        + distutils.file_util + Utility functions for operating on single files
        + distutils.filelist + The FileList class, used for poking about the file system and +building lists of files.
        + distutils.log + A simple logging mechanism, 282-style
        + distutils.msvccompiler + Microsoft Compiler
        + distutils.spawn + Provides the spawn() function
        + distutils.sysconfig + Low-level access to configuration information of the Python interpreter.
        + distutils.text_file + provides the TextFile class, a simple interface to text files
        + distutils.unixccompiler + UNIX C Compiler
        + distutils.util + Miscellaneous other utility functions
        + distutils.version + implements classes that represent module version numbers.
    + doctest + Test pieces of code within docstrings.
    + dummy_threading + Drop-in replacement for the threading module.
     
    + e
    + email + Package supporting the parsing, manipulating, and generating +email messages.
    + email +
        + email.charset + Character Sets
        + email.contentmanager + Storing and Retrieving Content from MIME Parts
        + email.encoders + Encoders for email message payloads.
        + email.errors + The exception classes used by the email package.
        + email.generator + Generate flat text email messages from a message structure.
        + email.header + Representing non-ASCII headers
        + email.headerregistry + Automatic Parsing of headers based on the field name
        + email.iterators + Iterate over a message object tree.
        + email.message + The base class representing email messages.
        + email.mime + Build MIME messages.
        + email.parser + Parse flat text email messages to produce a message object structure.
        + email.policy + Controlling the parsing and generating of messages
        + email.utils + Miscellaneous email package utilities.
    + encodings +
        + encodings.idna + Internationalized Domain Names implementation
        + encodings.mbcs + Windows ANSI codepage
        + encodings.utf_8_sig + UTF-8 codec with BOM signature
    + ensurepip + Bootstrapping the "pip" installer into an existing Python +installation or virtual environment.
    + enum + Implementation of an enumeration class.
    + errno + Standard errno system symbols.
     
    + f
    + faulthandler + Dump the Python traceback.
    + fcntl (Unix) + The fcntl() and ioctl() system calls.
    + filecmp + Compare files efficiently.
    + fileinput + Loop over standard input or a list of files.
    + fnmatch + Unix shell style filename pattern matching.
    + formatterDeprecated: + Generic output formatter and device interface.
    + fractions + Rational numbers.
    + ftplib + FTP protocol client (requires sockets).
    + functools + Higher-order functions and operations on callable objects.
     
    + g
    + gc + Interface to the cycle-detecting garbage collector.
    + getopt + Portable parser for command line options; support both short and +long option names.
    + getpass + Portable reading of passwords and retrieval of the userid.
    + gettext + Multilingual internationalization services.
    + glob + Unix shell style pathname pattern expansion.
    + grp (Unix) + The group database (getgrnam() and friends).
    + gzip + Interfaces for gzip compression and decompression using file objects.
     
    + h
    + hashlib + Secure hash and message digest algorithms.
    + heapq + Heap queue algorithm (a.k.a. priority queue).
    + hmac + Keyed-Hashing for Message Authentication (HMAC) implementation
    + html + Helpers for manipulating HTML.
    + html +
        + html.entities + Definitions of HTML general entities.
        + html.parser + A simple parser that can handle HTML and XHTML.
    + http + HTTP status codes and messages
    + http +
        + http.client + HTTP and HTTPS protocol client (requires sockets).
        + http.cookiejar + Classes for automatic handling of HTTP cookies.
        + http.cookies + Support for HTTP state management (cookies).
        + http.server + HTTP server and request handlers.
     
    + i
    + imaplib + IMAP4 protocol client (requires sockets).
    + imghdr + Determine the type of image contained in a file or byte stream.
    + impDeprecated: + Access the implementation of the import statement.
    + importlib + The implementation of the import machinery.
    + importlib +
        + importlib.abc + Abstract base classes related to import
        + importlib.machinery + Importers and path hooks
        + importlib.resources + Package resource reading, opening, and access
        + importlib.util + Utility code for importers
    + inspect + Extract information and source code from live objects.
    + io + Core tools for working with streams.
    + ipaddress + IPv4/IPv6 manipulation library.
    + itertools + Functions creating iterators for efficient looping.
     
    + j
    + json + Encode and decode the JSON format.
    + json +
        + json.tool + A command line to validate and pretty-print JSON.
     
    + k
    + keyword + Test whether a string is a keyword in Python.
     
    + l
    + lib2to3 + the 2to3 library
    + linecache + This module provides random access to individual lines from text files.
    + locale + Internationalization services.
    + logging + Flexible event logging system for applications.
    + logging +
        + logging.config + Configuration of the logging module.
        + logging.handlers + Handlers for the logging module.
    + lzma + A Python wrapper for the liblzma compression library.
     
    + m
    + macpath + Mac OS 9 path manipulation functions.
    + mailbox + Manipulate mailboxes in various formats
    + mailcap + Mailcap file handling.
    + marshal + Convert Python objects to streams of bytes and back (with different +constraints).
    + math + Mathematical functions (sin() etc.).
    + mimetypes + Mapping of filename extensions to MIME types.
    + mmap + Interface to memory-mapped files for Unix and Windows.
    + modulefinder + Find modules used by a script.
    + msilib (Windows) + Creation of Microsoft Installer files, and CAB files.
    + msvcrt (Windows) + Miscellaneous useful routines from the MS VC++ runtime.
    + multiprocessing + Process-based parallelism.
    + multiprocessing +
        + multiprocessing.connection + API for dealing with sockets.
        + multiprocessing.dummy + Dumb wrapper around threading.
        + multiprocessing.managers + Share data between process with shared objects.
        + multiprocessing.pool + Create pools of processes.
        + multiprocessing.sharedctypes + Allocate ctypes objects from shared memory.
     
    + n
    + netrc + Loading of .netrc files.
    + nis (Unix) + Interface to Sun's NIS (Yellow Pages) library.
    + nntplib + NNTP protocol client (requires sockets).
    + numbers + Numeric abstract base classes (Complex, Real, Integral, etc.).
     
    + o
    + operator + Functions corresponding to the standard operators.
    + optparseDeprecated: + Command-line option parsing library.
    + os + Miscellaneous operating system interfaces.
    + os +
        + os.path + Operations on pathnames.
    + ossaudiodev (Linux, FreeBSD) + Access to OSS-compatible audio devices.
     
    + p
    + parser + Access parse trees for Python source code.
    + pathlib + Object-oriented filesystem paths
    + pdb + The Python debugger for interactive interpreters.
    + pickle + Convert Python objects to streams of bytes and back.
    + pickletools + Contains extensive comments about the pickle protocols and +pickle-machine opcodes, as well as some useful functions.
    + pipes (Unix) + A Python interface to Unix shell pipelines.
    + pkgutil + Utilities for the import system.
    + platform + Retrieves as much platform identifying data as possible.
    + plistlib + Generate and parse Mac OS X plist files.
    + poplib + POP3 protocol client (requires sockets).
    + posix (Unix) + The most common POSIX system calls (normally used via module os).
    + pprint + Data pretty printer.
    + profile + Python source profiler.
    + pstats + Statistics object for use with the profiler.
    + pty (Linux) + Pseudo-Terminal Handling for Linux.
    + pwd (Unix) + The password database (getpwnam() and friends).
    + py_compile + Generate byte-code files from Python source files.
    + pyclbr + Supports information extraction for a Python class browser.
    + pydoc + Documentation generator and online help system.
     
    + q
    + queue + A synchronized queue class.
    + quopri + Encode and decode files using the MIME quoted-printable encoding.
     
    + r
    + random + Generate pseudo-random numbers with various common distributions.
    + re + Regular expression operations.
    + readline (Unix) + GNU readline support for Python.
    + reprlib + Alternate repr() implementation with size limits.
    + resource (Unix) + An interface to provide resource usage information on the current process.
    + rlcompleter + Python identifier completion, suitable for the GNU readline library.
    + runpy + Locate and run Python modules without importing them first.
     
    + s
    + sched + General purpose event scheduler.
    + secrets + Generate secure random numbers for managing secrets.
    + select + Wait for I/O completion on multiple streams.
    + selectors + High-level I/O multiplexing.
    + shelve + Python object persistence.
    + shlex + Simple lexical analysis for Unix shell-like languages.
    + shutil + High-level file operations, including copying.
    + signal + Set handlers for asynchronous events.
    + site + Module responsible for site-specific configuration.
    + smtpd + A SMTP server implementation in Python.
    + smtplib + SMTP protocol client (requires sockets).
    + sndhdr + Determine type of a sound file.
    + socket + Low-level networking interface.
    + socketserver + A framework for network servers.
    + spwd (Unix) + The shadow password database (getspnam() and friends).
    + sqlite3 + A DB-API 2.0 implementation using SQLite 3.x.
    + ssl + TLS/SSL wrapper for socket objects
    + stat + Utilities for interpreting the results of os.stat(), +os.lstat() and os.fstat().
    + statistics + mathematical statistics functions
    + string + Common string operations.
    + stringprep + String preparation, as per RFC 3453
    + struct + Interpret bytes as packed binary data.
    + subprocess + Subprocess management.
    + sunau + Provide an interface to the Sun AU sound format.
    + symbol + Constants representing internal nodes of the parse tree.
    + symtable + Interface to the compiler's internal symbol tables.
    + sys + Access system-specific parameters and functions.
    + sysconfig + Python's configuration information
    + syslog (Unix) + An interface to the Unix syslog library routines.
     
    + t
    + tabnanny + Tool for detecting white space related problems in Python +source files in a directory tree.
    + tarfile + Read and write tar-format archive files.
    + telnetlib + Telnet client class.
    + tempfile + Generate temporary files and directories.
    + termios (Unix) + POSIX style tty control.
    + test + Regression tests package containing the testing suite for Python.
    + test +
        + test.support + Support for Python's regression test suite.
        + test.support.script_helper + Support for Python's script execution tests.
    + textwrap + Text wrapping and filling
    + threading + Thread-based parallelism.
    + time + Time access and conversions.
    + timeit + Measure the execution time of small code snippets.
    + tkinter + Interface to Tcl/Tk for graphical user interfaces
    + tkinter +
        + tkinter.scrolledtext (Tk) + Text widget with a vertical scroll bar.
        + tkinter.tix + Tk Extension Widgets for Tkinter
        + tkinter.ttk + Tk themed widget set
    + token + Constants representing terminal nodes of the parse tree.
    + tokenize + Lexical scanner for Python source code.
    + trace + Trace or track Python statement execution.
    + traceback + Print or retrieve a stack traceback.
    + tracemalloc + Trace memory allocations.
    + tty (Unix) + Utility functions that perform common terminal control operations.
    + turtle + An educational framework for simple graphics applications
    + turtledemo + A viewer for example turtle scripts
    + types + Names for built-in types.
    + typing + Support for type hints (see PEP 484).
     
    + u
    + unicodedata + Access the Unicode Database.
    + unittest + Unit testing framework for Python.
    + unittest +
        + unittest.mock + Mock object library.
    + urllib +
    + urllib +
        + urllib.error + Exception classes raised by urllib.request.
        + urllib.parse + Parse URLs into or assemble them from components.
        + urllib.request + Extensible library for opening URLs.
        + urllib.response + Response classes used by urllib.
        + urllib.robotparser + Load a robots.txt file and answer questions about +fetchability of other URLs.
    + uu + Encode and decode files in uuencode format.
    + uuid + UUID objects (universally unique identifiers) according to RFC 4122
     
    + v
    + venv + Creation of virtual environments.
     
    + w
    + warnings + Issue warning messages and control their disposition.
    + wave + Provide an interface to the WAV sound format.
    + weakref + Support for weak references and weak dictionaries.
    + webbrowser + Easy-to-use controller for Web browsers.
    + winreg (Windows) + Routines and objects for manipulating the Windows registry.
    + winsound (Windows) + Access to the sound-playing machinery for Windows.
    + wsgiref + WSGI Utilities and Reference Implementation.
    + wsgiref +
        + wsgiref.handlers + WSGI server/gateway base classes.
        + wsgiref.headers + WSGI response header tools.
        + wsgiref.simple_server + A simple WSGI HTTP server.
        + wsgiref.util + WSGI environment utilities.
        + wsgiref.validate + WSGI conformance checker.
     
    + x
    + xdrlib + Encoders and decoders for the External Data Representation (XDR).
    + xml + Package containing XML processing modules
    + xml +
        + xml.dom + Document Object Model API for Python.
        + xml.dom.minidom + Minimal Document Object Model (DOM) implementation.
        + xml.dom.pulldom + Support for building partial DOM trees from SAX events.
        + xml.etree.ElementTree + Implementation of the ElementTree API.
        + xml.parsers.expat + An interface to the Expat non-validating XML parser.
        + xml.parsers.expat.errors +
        + xml.parsers.expat.model +
        + xml.sax + Package containing SAX2 base classes and convenience functions.
        + xml.sax.handler + Base classes for SAX event handlers.
        + xml.sax.saxutils + Convenience functions and classes for use with SAX.
        + xml.sax.xmlreader + Interface which SAX-compliant XML parsers must implement.
    + xmlrpc +
        + xmlrpc.client + XML-RPC client access.
        + xmlrpc.server + Basic XML-RPC server implementations.
     
    + z
    + zipapp + Manage executable Python zip archives
    + zipfile + Read and write ZIP-format archive files.
    + zipimport + support for importing Python modules from ZIP archives.
    + zlib + Low-level interface to compression and decompression routines +compatible with gzip.
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/reference/compound_stmts.html b/python-3.7.4-docs-html/reference/compound_stmts.html new file mode 100644 index 0000000..e33bb61 --- /dev/null +++ b/python-3.7.4-docs-html/reference/compound_stmts.html @@ -0,0 +1,820 @@ + + + + + + + 8. Compound statements — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    8. Compound statements

    +

    Compound statements contain (groups of) other statements; they affect or control +the execution of those other statements in some way. In general, compound +statements span multiple lines, although in simple incarnations a whole compound +statement may be contained in one line.

    +

    The if, while and for statements implement +traditional control flow constructs. try specifies exception +handlers and/or cleanup code for a group of statements, while the +with statement allows the execution of initialization and +finalization code around a block of code. Function and class definitions are +also syntactically compound statements.

    +

    A compound statement consists of one or more ‘clauses.’ A clause consists of a +header and a ‘suite.’ The clause headers of a particular compound statement are +all at the same indentation level. Each clause header begins with a uniquely +identifying keyword and ends with a colon. A suite is a group of statements +controlled by a clause. A suite can be one or more semicolon-separated simple +statements on the same line as the header, following the header’s colon, or it +can be one or more indented statements on subsequent lines. Only the latter +form of a suite can contain nested compound statements; the following is illegal, +mostly because it wouldn’t be clear to which if clause a following +else clause would belong:

    +
    if test1: if test2: print(x)
    +
    +
    +

    Also note that the semicolon binds tighter than the colon in this context, so +that in the following example, either all or none of the print() calls are +executed:

    +
    if x < y < z: print(x); print(y); print(z)
    +
    +
    +

    Summarizing:

    +
    +compound_stmt ::=  if_stmt
    +                   | while_stmt
    +                   | for_stmt
    +                   | try_stmt
    +                   | with_stmt
    +                   | funcdef
    +                   | classdef
    +                   | async_with_stmt
    +                   | async_for_stmt
    +                   | async_funcdef
    +suite         ::=  stmt_list NEWLINE | NEWLINE INDENT statement+ DEDENT
    +statement     ::=  stmt_list NEWLINE | compound_stmt
    +stmt_list     ::=  simple_stmt (";" simple_stmt)* [";"]
    +
    +

    Note that statements always end in a NEWLINE possibly followed by a +DEDENT. Also note that optional continuation clauses always begin with a +keyword that cannot start a statement, thus there are no ambiguities (the +‘dangling else’ problem is solved in Python by requiring nested +if statements to be indented).

    +

    The formatting of the grammar rules in the following sections places each clause +on a separate line for clarity.

    +
    +

    8.1. The if statement

    +

    The if statement is used for conditional execution:

    +
    +if_stmt ::=  "if" expression ":" suite
    +             ("elif" expression ":" suite)*
    +             ["else" ":" suite]
    +
    +

    It selects exactly one of the suites by evaluating the expressions one by one +until one is found to be true (see section Boolean operations for the definition of +true and false); then that suite is executed (and no other part of the +if statement is executed or evaluated). If all expressions are +false, the suite of the else clause, if present, is executed.

    +
    +
    +

    8.2. The while statement

    +

    The while statement is used for repeated execution as long as an +expression is true:

    +
    +while_stmt ::=  "while" expression ":" suite
    +                ["else" ":" suite]
    +
    +

    This repeatedly tests the expression and, if it is true, executes the first +suite; if the expression is false (which may be the first time it is tested) the +suite of the else clause, if present, is executed and the loop +terminates.

    +

    A break statement executed in the first suite terminates the loop +without executing the else clause’s suite. A continue +statement executed in the first suite skips the rest of the suite and goes back +to testing the expression.

    +
    +
    +

    8.3. The for statement

    +

    The for statement is used to iterate over the elements of a sequence +(such as a string, tuple or list) or other iterable object:

    +
    +for_stmt ::=  "for" target_list "in" expression_list ":" suite
    +              ["else" ":" suite]
    +
    +

    The expression list is evaluated once; it should yield an iterable object. An +iterator is created for the result of the expression_list. The suite is +then executed once for each item provided by the iterator, in the order returned +by the iterator. Each item in turn is assigned to the target list using the +standard rules for assignments (see Assignment statements), and then the suite is +executed. When the items are exhausted (which is immediately when the sequence +is empty or an iterator raises a StopIteration exception), the suite in +the else clause, if present, is executed, and the loop terminates.

    +

    A break statement executed in the first suite terminates the loop +without executing the else clause’s suite. A continue +statement executed in the first suite skips the rest of the suite and continues +with the next item, or with the else clause if there is no next +item.

    +

    The for-loop makes assignments to the variables(s) in the target list. +This overwrites all previous assignments to those variables including +those made in the suite of the for-loop:

    +
    for i in range(10):
    +    print(i)
    +    i = 5             # this will not affect the for-loop
    +                      # because i will be overwritten with the next
    +                      # index in the range
    +
    +
    +

    Names in the target list are not deleted when the loop is finished, but if the +sequence is empty, they will not have been assigned to at all by the loop. Hint: +the built-in function range() returns an iterator of integers suitable to +emulate the effect of Pascal’s for i := a to b do; e.g., list(range(3)) +returns the list [0, 1, 2].

    +
    +

    Note

    +

    There is a subtlety when the sequence is being modified by the loop (this can +only occur for mutable sequences, e.g. lists). An internal counter is used +to keep track of which item is used next, and this is incremented on each +iteration. When this counter has reached the length of the sequence the loop +terminates. This means that if the suite deletes the current (or a previous) +item from the sequence, the next item will be skipped (since it gets the +index of the current item which has already been treated). Likewise, if the +suite inserts an item in the sequence before the current item, the current +item will be treated again the next time through the loop. This can lead to +nasty bugs that can be avoided by making a temporary copy using a slice of +the whole sequence, e.g.,

    +
    for x in a[:]:
    +    if x < 0: a.remove(x)
    +
    +
    +
    +
    +
    +

    8.4. The try statement

    +

    The try statement specifies exception handlers and/or cleanup code +for a group of statements:

    +
    +try_stmt  ::=  try1_stmt | try2_stmt
    +try1_stmt ::=  "try" ":" suite
    +               ("except" [expression ["as" identifier]] ":" suite)+
    +               ["else" ":" suite]
    +               ["finally" ":" suite]
    +try2_stmt ::=  "try" ":" suite
    +               "finally" ":" suite
    +
    +

    The except clause(s) specify one or more exception handlers. When no +exception occurs in the try clause, no exception handler is executed. +When an exception occurs in the try suite, a search for an exception +handler is started. This search inspects the except clauses in turn until one +is found that matches the exception. An expression-less except clause, if +present, must be last; it matches any exception. For an except clause with an +expression, that expression is evaluated, and the clause matches the exception +if the resulting object is “compatible” with the exception. An object is +compatible with an exception if it is the class or a base class of the exception +object or a tuple containing an item compatible with the exception.

    +

    If no except clause matches the exception, the search for an exception handler +continues in the surrounding code and on the invocation stack. 1

    +

    If the evaluation of an expression in the header of an except clause raises an +exception, the original search for a handler is canceled and a search starts for +the new exception in the surrounding code and on the call stack (it is treated +as if the entire try statement raised the exception).

    +

    When a matching except clause is found, the exception is assigned to the target +specified after the as keyword in that except clause, if present, and +the except clause’s suite is executed. All except clauses must have an +executable block. When the end of this block is reached, execution continues +normally after the entire try statement. (This means that if two nested +handlers exist for the same exception, and the exception occurs in the try +clause of the inner handler, the outer handler will not handle the exception.)

    +

    When an exception has been assigned using as target, it is cleared at the +end of the except clause. This is as if

    +
    except E as N:
    +    foo
    +
    +
    +

    was translated to

    +
    except E as N:
    +    try:
    +        foo
    +    finally:
    +        del N
    +
    +
    +

    This means the exception must be assigned to a different name to be able to +refer to it after the except clause. Exceptions are cleared because with the +traceback attached to them, they form a reference cycle with the stack frame, +keeping all locals in that frame alive until the next garbage collection occurs.

    +

    Before an except clause’s suite is executed, details about the exception are +stored in the sys module and can be accessed via sys.exc_info(). +sys.exc_info() returns a 3-tuple consisting of the exception class, the +exception instance and a traceback object (see section The standard type hierarchy) identifying +the point in the program where the exception occurred. sys.exc_info() +values are restored to their previous values (before the call) when returning +from a function that handled an exception.

    +

    The optional else clause is executed if the control flow leaves the +try suite, no exception was raised, and no return, +continue, or break statement was executed. Exceptions in +the else clause are not handled by the preceding except +clauses.

    +

    If finally is present, it specifies a ‘cleanup’ handler. The +try clause is executed, including any except and +else clauses. If an exception occurs in any of the clauses and is +not handled, the exception is temporarily saved. The finally clause +is executed. If there is a saved exception it is re-raised at the end of the +finally clause. If the finally clause raises another +exception, the saved exception is set as the context of the new exception. +If the finally clause executes a return or break +statement, the saved exception is discarded:

    +
    >>> def f():
    +...     try:
    +...         1/0
    +...     finally:
    +...         return 42
    +...
    +>>> f()
    +42
    +
    +
    +

    The exception information is not available to the program during execution of +the finally clause.

    +

    When a return, break or continue statement is +executed in the try suite of a tryfinally +statement, the finally clause is also executed ‘on the way out.’ A +continue statement is illegal in the finally clause. (The +reason is a problem with the current implementation — this restriction may be +lifted in the future).

    +

    The return value of a function is determined by the last return +statement executed. Since the finally clause always executes, a +return statement executed in the finally clause will +always be the last one executed:

    +
    >>> def foo():
    +...     try:
    +...         return 'try'
    +...     finally:
    +...         return 'finally'
    +...
    +>>> foo()
    +'finally'
    +
    +
    +

    Additional information on exceptions can be found in section Exceptions, +and information on using the raise statement to generate exceptions +may be found in section The raise statement.

    +
    +
    +

    8.5. The with statement

    +

    The with statement is used to wrap the execution of a block with +methods defined by a context manager (see section With Statement Context Managers). +This allows common tryexceptfinally +usage patterns to be encapsulated for convenient reuse.

    +
    +with_stmt ::=  "with" with_item ("," with_item)* ":" suite
    +with_item ::=  expression ["as" target]
    +
    +

    The execution of the with statement with one “item” proceeds as follows:

    +
      +
    1. The context expression (the expression given in the with_item) is +evaluated to obtain a context manager.

    2. +
    3. The context manager’s __exit__() is loaded for later use.

    4. +
    5. The context manager’s __enter__() method is invoked.

    6. +
    7. If a target was included in the with statement, the return value +from __enter__() is assigned to it.

      +
      +

      Note

      +

      The with statement guarantees that if the __enter__() +method returns without an error, then __exit__() will always be +called. Thus, if an error occurs during the assignment to the target list, +it will be treated the same as an error occurring within the suite would +be. See step 6 below.

      +
      +
    8. +
    9. The suite is executed.

    10. +
    11. The context manager’s __exit__() method is invoked. If an exception +caused the suite to be exited, its type, value, and traceback are passed as +arguments to __exit__(). Otherwise, three None arguments are +supplied.

      +

      If the suite was exited due to an exception, and the return value from the +__exit__() method was false, the exception is reraised. If the return +value was true, the exception is suppressed, and execution continues with the +statement following the with statement.

      +

      If the suite was exited for any reason other than an exception, the return +value from __exit__() is ignored, and execution proceeds at the normal +location for the kind of exit that was taken.

      +
    12. +
    +

    With more than one item, the context managers are processed as if multiple +with statements were nested:

    +
    with A() as a, B() as b:
    +    suite
    +
    +
    +

    is equivalent to

    +
    with A() as a:
    +    with B() as b:
    +        suite
    +
    +
    +
    +

    Changed in version 3.1: Support for multiple context expressions.

    +
    +
    +

    See also

    +
    +
    PEP 343 - The “with” statement

    The specification, background, and examples for the Python with +statement.

    +
    +
    +
    +
    +
    +

    8.6. Function definitions

    +

    A function definition defines a user-defined function object (see section +The standard type hierarchy):

    +
    +funcdef                 ::=  [decorators] "def" funcname "(" [parameter_list] ")"
    +                             ["->" expression] ":" suite
    +decorators              ::=  decorator+
    +decorator               ::=  "@" dotted_name ["(" [argument_list [","]] ")"] NEWLINE
    +dotted_name             ::=  identifier ("." identifier)*
    +parameter_list          ::=  defparameter ("," defparameter)* ["," [parameter_list_starargs]]
    +                             | parameter_list_starargs
    +parameter_list_starargs ::=  "*" [parameter] ("," defparameter)* ["," ["**" parameter [","]]]
    +                             | "**" parameter [","]
    +parameter               ::=  identifier [":" expression]
    +defparameter            ::=  parameter ["=" expression]
    +funcname                ::=  identifier
    +
    +

    A function definition is an executable statement. Its execution binds the +function name in the current local namespace to a function object (a wrapper +around the executable code for the function). This function object contains a +reference to the current global namespace as the global namespace to be used +when the function is called.

    +

    The function definition does not execute the function body; this gets executed +only when the function is called. 2

    +

    A function definition may be wrapped by one or more decorator expressions. +Decorator expressions are evaluated when the function is defined, in the scope +that contains the function definition. The result must be a callable, which is +invoked with the function object as the only argument. The returned value is +bound to the function name instead of the function object. Multiple decorators +are applied in nested fashion. For example, the following code

    +
    @f1(arg)
    +@f2
    +def func(): pass
    +
    +
    +

    is roughly equivalent to

    +
    def func(): pass
    +func = f1(arg)(f2(func))
    +
    +
    +

    except that the original function is not temporarily bound to the name func.

    +

    When one or more parameters have the form parameter = +expression, the function is said to have “default parameter values.” For a +parameter with a default value, the corresponding argument may be +omitted from a call, in which +case the parameter’s default value is substituted. If a parameter has a default +value, all following parameters up until the “*” must also have a default +value — this is a syntactic restriction that is not expressed by the grammar.

    +

    Default parameter values are evaluated from left to right when the function +definition is executed. This means that the expression is evaluated once, when +the function is defined, and that the same “pre-computed” value is used for each +call. This is especially important to understand when a default parameter is a +mutable object, such as a list or a dictionary: if the function modifies the +object (e.g. by appending an item to a list), the default value is in effect +modified. This is generally not what was intended. A way around this is to use +None as the default, and explicitly test for it in the body of the function, +e.g.:

    +
    def whats_on_the_telly(penguin=None):
    +    if penguin is None:
    +        penguin = []
    +    penguin.append("property of the zoo")
    +    return penguin
    +
    +
    +

    Function call semantics are described in more detail in section Calls. A +function call always assigns values to all parameters mentioned in the parameter +list, either from position arguments, from keyword arguments, or from default +values. If the form “*identifier” is present, it is initialized to a tuple +receiving any excess positional parameters, defaulting to the empty tuple. +If the form “**identifier” is present, it is initialized to a new +ordered mapping receiving any excess keyword arguments, defaulting to a +new empty mapping of the same type. Parameters after “*” or +“*identifier” are keyword-only parameters and may only be passed +used keyword arguments.

    +

    Parameters may have an annotation of the form “: expression” +following the parameter name. Any parameter may have an annotation, even those of the form +*identifier or **identifier. Functions may have “return” annotation of +the form “-> expression” after the parameter list. These annotations can be +any valid Python expression. The presence of annotations does not change the +semantics of a function. The annotation values are available as values of +a dictionary keyed by the parameters’ names in the __annotations__ +attribute of the function object. If the annotations import from +__future__ is used, annotations are preserved as strings at runtime which +enables postponed evaluation. Otherwise, they are evaluated when the function +definition is executed. In this case annotations may be evaluated in +a different order than they appear in the source code.

    +

    It is also possible to create anonymous functions (functions not bound to a +name), for immediate use in expressions. This uses lambda expressions, described in +section Lambdas. Note that the lambda expression is merely a shorthand for a +simplified function definition; a function defined in a “def” +statement can be passed around or assigned to another name just like a function +defined by a lambda expression. The “def” form is actually more powerful +since it allows the execution of multiple statements and annotations.

    +

    Programmer’s note: Functions are first-class objects. A “def” statement +executed inside a function definition defines a local function that can be +returned or passed around. Free variables used in the nested function can +access the local variables of the function containing the def. See section +Naming and binding for details.

    +
    +

    See also

    +
    +
    PEP 3107 - Function Annotations

    The original specification for function annotations.

    +
    +
    PEP 484 - Type Hints

    Definition of a standard meaning for annotations: type hints.

    +
    +
    PEP 526 - Syntax for Variable Annotations

    Ability to type hint variable declarations, including class +variables and instance variables

    +
    +
    PEP 563 - Postponed Evaluation of Annotations

    Support for forward references within annotations by preserving +annotations in a string form at runtime instead of eager evaluation.

    +
    +
    +
    +
    +
    +

    8.7. Class definitions

    +

    A class definition defines a class object (see section The standard type hierarchy):

    +
    +classdef    ::=  [decorators] "class" classname [inheritance] ":" suite
    +inheritance ::=  "(" [argument_list] ")"
    +classname   ::=  identifier
    +
    +

    A class definition is an executable statement. The inheritance list usually +gives a list of base classes (see Metaclasses for more advanced uses), so +each item in the list should evaluate to a class object which allows +subclassing. Classes without an inheritance list inherit, by default, from the +base class object; hence,

    +
    class Foo:
    +    pass
    +
    +
    +

    is equivalent to

    +
    class Foo(object):
    +    pass
    +
    +
    +

    The class’s suite is then executed in a new execution frame (see Naming and binding), +using a newly created local namespace and the original global namespace. +(Usually, the suite contains mostly function definitions.) When the class’s +suite finishes execution, its execution frame is discarded but its local +namespace is saved. 3 A class object is then created using the inheritance +list for the base classes and the saved local namespace for the attribute +dictionary. The class name is bound to this class object in the original local +namespace.

    +

    The order in which attributes are defined in the class body is preserved +in the new class’s __dict__. Note that this is reliable only right +after the class is created and only for classes that were defined using +the definition syntax.

    +

    Class creation can be customized heavily using metaclasses.

    +

    Classes can also be decorated: just like when decorating functions,

    +
    @f1(arg)
    +@f2
    +class Foo: pass
    +
    +
    +

    is roughly equivalent to

    +
    class Foo: pass
    +Foo = f1(arg)(f2(Foo))
    +
    +
    +

    The evaluation rules for the decorator expressions are the same as for function +decorators. The result is then bound to the class name.

    +

    Programmer’s note: Variables defined in the class definition are class +attributes; they are shared by instances. Instance attributes can be set in a +method with self.name = value. Both class and instance attributes are +accessible through the notation “self.name”, and an instance attribute hides +a class attribute with the same name when accessed in this way. Class +attributes can be used as defaults for instance attributes, but using mutable +values there can lead to unexpected results. Descriptors +can be used to create instance variables with different implementation details.

    +
    +

    See also

    +
    +
    PEP 3115 - Metaclasses in Python 3000

    The proposal that changed the declaration of metaclasses to the current +syntax, and the semantics for how classes with metaclasses are +constructed.

    +
    +
    PEP 3129 - Class Decorators

    The proposal that added class decorators. Function and method decorators +were introduced in PEP 318.

    +
    +
    +
    +
    +
    +

    8.8. Coroutines

    +
    +

    New in version 3.5.

    +
    +
    +

    8.8.1. Coroutine function definition

    +
    +async_funcdef ::=  [decorators] "async" "def" funcname "(" [parameter_list] ")"
    +                   ["->" expression] ":" suite
    +
    +

    Execution of Python coroutines can be suspended and resumed at many points +(see coroutine). Inside the body of a coroutine function, await and +async identifiers become reserved keywords; await expressions, +async for and async with can only be used in +coroutine function bodies.

    +

    Functions defined with async def syntax are always coroutine functions, +even if they do not contain await or async keywords.

    +

    It is a SyntaxError to use a yield from expression inside the body +of a coroutine function.

    +

    An example of a coroutine function:

    +
    async def func(param1, param2):
    +    do_stuff()
    +    await some_coroutine()
    +
    +
    +
    +
    +

    8.8.2. The async for statement

    +
    +async_for_stmt ::=  "async" for_stmt
    +
    +

    An asynchronous iterable is able to call asynchronous code in its +iter implementation, and asynchronous iterator can call asynchronous +code in its next method.

    +

    The async for statement allows convenient iteration over asynchronous +iterators.

    +

    The following code:

    +
    async for TARGET in ITER:
    +    BLOCK
    +else:
    +    BLOCK2
    +
    +
    +

    Is semantically equivalent to:

    +
    iter = (ITER)
    +iter = type(iter).__aiter__(iter)
    +running = True
    +while running:
    +    try:
    +        TARGET = await type(iter).__anext__(iter)
    +    except StopAsyncIteration:
    +        running = False
    +    else:
    +        BLOCK
    +else:
    +    BLOCK2
    +
    +
    +

    See also __aiter__() and __anext__() for details.

    +

    It is a SyntaxError to use an async for statement outside the +body of a coroutine function.

    +
    +
    +

    8.8.3. The async with statement

    +
    +async_with_stmt ::=  "async" with_stmt
    +
    +

    An asynchronous context manager is a context manager that is +able to suspend execution in its enter and exit methods.

    +

    The following code:

    +
    async with EXPR as VAR:
    +    BLOCK
    +
    +
    +

    Is semantically equivalent to:

    +
    mgr = (EXPR)
    +aexit = type(mgr).__aexit__
    +aenter = type(mgr).__aenter__(mgr)
    +
    +VAR = await aenter
    +try:
    +    BLOCK
    +except:
    +    if not await aexit(mgr, *sys.exc_info()):
    +        raise
    +else:
    +    await aexit(mgr, None, None, None)
    +
    +
    +

    See also __aenter__() and __aexit__() for details.

    +

    It is a SyntaxError to use an async with statement outside the +body of a coroutine function.

    +
    +

    See also

    +
    +
    PEP 492 - Coroutines with async and await syntax

    The proposal that made coroutines a proper standalone concept in Python, +and added supporting syntax.

    +
    +
    +
    +

    Footnotes

    +
    +
    1
    +

    The exception is propagated to the invocation stack unless +there is a finally clause which happens to raise another +exception. That new exception causes the old one to be lost.

    +
    +
    2
    +

    A string literal appearing as the first statement in the function body is +transformed into the function’s __doc__ attribute and therefore the +function’s docstring.

    +
    +
    3
    +

    A string literal appearing as the first statement in the class body is +transformed into the namespace’s __doc__ item and therefore the class’s +docstring.

    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/reference/datamodel.html b/python-3.7.4-docs-html/reference/datamodel.html new file mode 100644 index 0000000..283f239 --- /dev/null +++ b/python-3.7.4-docs-html/reference/datamodel.html @@ -0,0 +1,2440 @@ + + + + + + + 3. Data model — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    3. Data model

    +
    +

    3.1. Objects, values and types

    +

    Objects are Python’s abstraction for data. All data in a Python program +is represented by objects or by relations between objects. (In a sense, and in +conformance to Von Neumann’s model of a “stored program computer,” code is also +represented by objects.)

    +

    Every object has an identity, a type and a value. An object’s identity never +changes once it has been created; you may think of it as the object’s address in +memory. The ‘is’ operator compares the identity of two objects; the +id() function returns an integer representing its identity.

    +
    +

    CPython implementation detail: For CPython, id(x) is the memory address where x is stored.

    +
    +

    An object’s type determines the operations that the object supports (e.g., “does +it have a length?”) and also defines the possible values for objects of that +type. The type() function returns an object’s type (which is an object +itself). Like its identity, an object’s type is also unchangeable. +1

    +

    The value of some objects can change. Objects whose value can +change are said to be mutable; objects whose value is unchangeable once they +are created are called immutable. (The value of an immutable container object +that contains a reference to a mutable object can change when the latter’s value +is changed; however the container is still considered immutable, because the +collection of objects it contains cannot be changed. So, immutability is not +strictly the same as having an unchangeable value, it is more subtle.) An +object’s mutability is determined by its type; for instance, numbers, strings +and tuples are immutable, while dictionaries and lists are mutable.

    +

    Objects are never explicitly destroyed; however, when they become unreachable +they may be garbage-collected. An implementation is allowed to postpone garbage +collection or omit it altogether — it is a matter of implementation quality +how garbage collection is implemented, as long as no objects are collected that +are still reachable.

    +
    +

    CPython implementation detail: CPython currently uses a reference-counting scheme with (optional) delayed +detection of cyclically linked garbage, which collects most objects as soon +as they become unreachable, but is not guaranteed to collect garbage +containing circular references. See the documentation of the gc +module for information on controlling the collection of cyclic garbage. +Other implementations act differently and CPython may change. +Do not depend on immediate finalization of objects when they become +unreachable (so you should always close files explicitly).

    +
    +

    Note that the use of the implementation’s tracing or debugging facilities may +keep objects alive that would normally be collectable. Also note that catching +an exception with a ‘tryexcept’ statement may keep +objects alive.

    +

    Some objects contain references to “external” resources such as open files or +windows. It is understood that these resources are freed when the object is +garbage-collected, but since garbage collection is not guaranteed to happen, +such objects also provide an explicit way to release the external resource, +usually a close() method. Programs are strongly recommended to explicitly +close such objects. The ‘tryfinally’ statement +and the ‘with’ statement provide convenient ways to do this.

    +

    Some objects contain references to other objects; these are called containers. +Examples of containers are tuples, lists and dictionaries. The references are +part of a container’s value. In most cases, when we talk about the value of a +container, we imply the values, not the identities of the contained objects; +however, when we talk about the mutability of a container, only the identities +of the immediately contained objects are implied. So, if an immutable container +(like a tuple) contains a reference to a mutable object, its value changes if +that mutable object is changed.

    +

    Types affect almost all aspects of object behavior. Even the importance of +object identity is affected in some sense: for immutable types, operations that +compute new values may actually return a reference to any existing object with +the same type and value, while for mutable objects this is not allowed. E.g., +after a = 1; b = 1, a and b may or may not refer to the same object +with the value one, depending on the implementation, but after c = []; d = +[], c and d are guaranteed to refer to two different, unique, newly +created empty lists. (Note that c = d = [] assigns the same object to both +c and d.)

    +
    +
    +

    3.2. The standard type hierarchy

    +

    Below is a list of the types that are built into Python. Extension modules +(written in C, Java, or other languages, depending on the implementation) can +define additional types. Future versions of Python may add types to the type +hierarchy (e.g., rational numbers, efficiently stored arrays of integers, etc.), +although such additions will often be provided via the standard library instead.

    +

    Some of the type descriptions below contain a paragraph listing ‘special +attributes.’ These are attributes that provide access to the implementation and +are not intended for general use. Their definition may change in the future.

    +
    +
    None

    This type has a single value. There is a single object with this value. This +object is accessed through the built-in name None. It is used to signify the +absence of a value in many situations, e.g., it is returned from functions that +don’t explicitly return anything. Its truth value is false.

    +
    +
    NotImplemented

    This type has a single value. There is a single object with this value. This +object is accessed through the built-in name NotImplemented. Numeric methods +and rich comparison methods should return this value if they do not implement the +operation for the operands provided. (The interpreter will then try the +reflected operation, or some other fallback, depending on the operator.) Its +truth value is true.

    +

    See +Implementing the arithmetic operations +for more details.

    +
    +
    Ellipsis

    This type has a single value. There is a single object with this value. This +object is accessed through the literal ... or the built-in name +Ellipsis. Its truth value is true.

    +
    +
    numbers.Number

    These are created by numeric literals and returned as results by arithmetic +operators and arithmetic built-in functions. Numeric objects are immutable; +once created their value never changes. Python numbers are of course strongly +related to mathematical numbers, but subject to the limitations of numerical +representation in computers.

    +

    Python distinguishes between integers, floating point numbers, and complex +numbers:

    +
    +
    numbers.Integral

    These represent elements from the mathematical set of integers (positive and +negative).

    +

    There are two types of integers:

    +

    Integers (int)

    +
    +

    These represent numbers in an unlimited range, subject to available (virtual) +memory only. For the purpose of shift and mask operations, a binary +representation is assumed, and negative numbers are represented in a variant of +2’s complement which gives the illusion of an infinite string of sign bits +extending to the left.

    +
    +
    +
    Booleans (bool)

    These represent the truth values False and True. The two objects representing +the values False and True are the only Boolean objects. The Boolean type is a +subtype of the integer type, and Boolean values behave like the values 0 and 1, +respectively, in almost all contexts, the exception being that when converted to +a string, the strings "False" or "True" are returned, respectively.

    +
    +
    +

    The rules for integer representation are intended to give the most meaningful +interpretation of shift and mask operations involving negative integers.

    +
    +
    numbers.Real (float)

    These represent machine-level double precision floating point numbers. You are +at the mercy of the underlying machine architecture (and C or Java +implementation) for the accepted range and handling of overflow. Python does not +support single-precision floating point numbers; the savings in processor and +memory usage that are usually the reason for using these are dwarfed by the +overhead of using objects in Python, so there is no reason to complicate the +language with two kinds of floating point numbers.

    +
    +
    numbers.Complex (complex)

    These represent complex numbers as a pair of machine-level double precision +floating point numbers. The same caveats apply as for floating point numbers. +The real and imaginary parts of a complex number z can be retrieved through +the read-only attributes z.real and z.imag.

    +
    +
    +
    +
    Sequences

    These represent finite ordered sets indexed by non-negative numbers. The +built-in function len() returns the number of items of a sequence. When +the length of a sequence is n, the index set contains the numbers 0, 1, +…, n-1. Item i of sequence a is selected by a[i].

    +

    Sequences also support slicing: a[i:j] selects all items with index k such +that i <= k < j. When used as an expression, a slice is a +sequence of the same type. This implies that the index set is renumbered so +that it starts at 0.

    +

    Some sequences also support “extended slicing” with a third “step” parameter: +a[i:j:k] selects all items of a with index x where x = i + n*k, n +>= 0 and i <= x < j.

    +

    Sequences are distinguished according to their mutability:

    +
    +
    Immutable sequences

    An object of an immutable sequence type cannot change once it is created. (If +the object contains references to other objects, these other objects may be +mutable and may be changed; however, the collection of objects directly +referenced by an immutable object cannot change.)

    +

    The following types are immutable sequences:

    +
    +
    Strings

    A string is a sequence of values that represent Unicode code points. +All the code points in the range U+0000 - U+10FFFF can be +represented in a string. Python doesn’t have a char type; +instead, every code point in the string is represented as a string +object with length 1. The built-in function ord() +converts a code point from its string form to an integer in the +range 0 - 10FFFF; chr() converts an integer in the range +0 - 10FFFF to the corresponding length 1 string object. +str.encode() can be used to convert a str to +bytes using the given text encoding, and +bytes.decode() can be used to achieve the opposite.

    +
    +
    Tuples

    The items of a tuple are arbitrary Python objects. Tuples of two or +more items are formed by comma-separated lists of expressions. A tuple +of one item (a ‘singleton’) can be formed by affixing a comma to an +expression (an expression by itself does not create a tuple, since +parentheses must be usable for grouping of expressions). An empty +tuple can be formed by an empty pair of parentheses.

    +
    +
    Bytes

    A bytes object is an immutable array. The items are 8-bit bytes, +represented by integers in the range 0 <= x < 256. Bytes literals +(like b'abc') and the built-in bytes() constructor +can be used to create bytes objects. Also, bytes objects can be +decoded to strings via the decode() method.

    +
    +
    +
    +
    Mutable sequences

    Mutable sequences can be changed after they are created. The subscription and +slicing notations can be used as the target of assignment and del +(delete) statements.

    +

    There are currently two intrinsic mutable sequence types:

    +
    +
    Lists

    The items of a list are arbitrary Python objects. Lists are formed by +placing a comma-separated list of expressions in square brackets. (Note +that there are no special cases needed to form lists of length 0 or 1.)

    +
    +
    Byte Arrays

    A bytearray object is a mutable array. They are created by the built-in +bytearray() constructor. Aside from being mutable +(and hence unhashable), byte arrays otherwise provide the same interface +and functionality as immutable bytes objects.

    +
    +
    +

    The extension module array provides an additional example of a +mutable sequence type, as does the collections module.

    +
    +
    +
    +
    Set types

    These represent unordered, finite sets of unique, immutable objects. As such, +they cannot be indexed by any subscript. However, they can be iterated over, and +the built-in function len() returns the number of items in a set. Common +uses for sets are fast membership testing, removing duplicates from a sequence, +and computing mathematical operations such as intersection, union, difference, +and symmetric difference.

    +

    For set elements, the same immutability rules apply as for dictionary keys. Note +that numeric types obey the normal rules for numeric comparison: if two numbers +compare equal (e.g., 1 and 1.0), only one of them can be contained in a +set.

    +

    There are currently two intrinsic set types:

    +
    +
    Sets

    These represent a mutable set. They are created by the built-in set() +constructor and can be modified afterwards by several methods, such as +add().

    +
    +
    Frozen sets

    These represent an immutable set. They are created by the built-in +frozenset() constructor. As a frozenset is immutable and +hashable, it can be used again as an element of another set, or as +a dictionary key.

    +
    +
    +
    +
    Mappings

    These represent finite sets of objects indexed by arbitrary index sets. The +subscript notation a[k] selects the item indexed by k from the mapping +a; this can be used in expressions and as the target of assignments or +del statements. The built-in function len() returns the number +of items in a mapping.

    +

    There is currently a single intrinsic mapping type:

    +
    +
    Dictionaries

    These represent finite sets of objects indexed by nearly arbitrary values. The +only types of values not acceptable as keys are values containing lists or +dictionaries or other mutable types that are compared by value rather than by +object identity, the reason being that the efficient implementation of +dictionaries requires a key’s hash value to remain constant. Numeric types used +for keys obey the normal rules for numeric comparison: if two numbers compare +equal (e.g., 1 and 1.0) then they can be used interchangeably to index +the same dictionary entry.

    +

    Dictionaries are mutable; they can be created by the {...} notation (see +section Dictionary displays).

    +

    The extension modules dbm.ndbm and dbm.gnu provide +additional examples of mapping types, as does the collections +module.

    +
    +
    +
    +
    Callable types

    These are the types to which the function call operation (see section +Calls) can be applied:

    +
    +
    User-defined functions

    A user-defined function object is created by a function definition (see +section Function definitions). It should be called with an argument list +containing the same number of items as the function’s formal parameter +list.

    +

    Special attributes:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Attribute

    Meaning

    __doc__

    The function’s documentation +string, or None if +unavailable; not inherited by +subclasses.

    Writable

    __name__

    The function’s name.

    Writable

    __qualname__

    The function’s +qualified name.

    +
    +

    New in version 3.3.

    +
    +

    Writable

    __module__

    The name of the module the +function was defined in, or +None if unavailable.

    Writable

    __defaults__

    A tuple containing default +argument values for those +arguments that have defaults, +or None if no arguments +have a default value.

    Writable

    __code__

    The code object representing +the compiled function body.

    Writable

    __globals__

    A reference to the dictionary +that holds the function’s +global variables — the +global namespace of the +module in which the function +was defined.

    Read-only

    __dict__

    The namespace supporting +arbitrary function +attributes.

    Writable

    __closure__

    None or a tuple of cells +that contain bindings for the +function’s free variables. +See below for information on +the cell_contents +attribute.

    Read-only

    __annotations__

    A dict containing annotations +of parameters. The keys of +the dict are the parameter +names, and 'return' for +the return annotation, if +provided.

    Writable

    __kwdefaults__

    A dict containing defaults +for keyword-only parameters.

    Writable

    +

    Most of the attributes labelled “Writable” check the type of the assigned value.

    +

    Function objects also support getting and setting arbitrary attributes, which +can be used, for example, to attach metadata to functions. Regular attribute +dot-notation is used to get and set such attributes. Note that the current +implementation only supports function attributes on user-defined functions. +Function attributes on built-in functions may be supported in the future.

    +

    A cell object has the attribute cell_contents. This can be used to get +the value of the cell, as well as set the value.

    +

    Additional information about a function’s definition can be retrieved from its +code object; see the description of internal types below.

    +
    +
    Instance methods

    An instance method object combines a class, a class instance and any +callable object (normally a user-defined function).

    +

    Special read-only attributes: __self__ is the class instance object, +__func__ is the function object; __doc__ is the method’s +documentation (same as __func__.__doc__); __name__ is the +method name (same as __func__.__name__); __module__ is the +name of the module the method was defined in, or None if unavailable.

    +

    Methods also support accessing (but not setting) the arbitrary function +attributes on the underlying function object.

    +

    User-defined method objects may be created when getting an attribute of a +class (perhaps via an instance of that class), if that attribute is a +user-defined function object or a class method object.

    +

    When an instance method object is created by retrieving a user-defined +function object from a class via one of its instances, its +__self__ attribute is the instance, and the method object is said +to be bound. The new method’s __func__ attribute is the original +function object.

    +

    When a user-defined method object is created by retrieving another method +object from a class or instance, the behaviour is the same as for a +function object, except that the __func__ attribute of the new +instance is not the original method object but its __func__ +attribute.

    +

    When an instance method object is created by retrieving a class method +object from a class or instance, its __self__ attribute is the +class itself, and its __func__ attribute is the function object +underlying the class method.

    +

    When an instance method object is called, the underlying function +(__func__) is called, inserting the class instance +(__self__) in front of the argument list. For instance, when +C is a class which contains a definition for a function +f(), and x is an instance of C, calling x.f(1) is +equivalent to calling C.f(x, 1).

    +

    When an instance method object is derived from a class method object, the +“class instance” stored in __self__ will actually be the class +itself, so that calling either x.f(1) or C.f(1) is equivalent to +calling f(C,1) where f is the underlying function.

    +

    Note that the transformation from function object to instance method +object happens each time the attribute is retrieved from the instance. In +some cases, a fruitful optimization is to assign the attribute to a local +variable and call that local variable. Also notice that this +transformation only happens for user-defined functions; other callable +objects (and all non-callable objects) are retrieved without +transformation. It is also important to note that user-defined functions +which are attributes of a class instance are not converted to bound +methods; this only happens when the function is an attribute of the +class.

    +
    +
    Generator functions

    A function or method which uses the yield statement (see section +The yield statement) is called a generator function. Such a function, when +called, always returns an iterator object which can be used to execute the +body of the function: calling the iterator’s iterator.__next__() +method will cause the function to execute until it provides a value +using the yield statement. When the function executes a +return statement or falls off the end, a StopIteration +exception is raised and the iterator will have reached the end of the set of +values to be returned.

    +
    +
    Coroutine functions

    A function or method which is defined using async def is called +a coroutine function. Such a function, when called, returns a +coroutine object. It may contain await expressions, +as well as async with and async for statements. See +also the Coroutine Objects section.

    +
    +
    Asynchronous generator functions

    A function or method which is defined using async def and +which uses the yield statement is called a +asynchronous generator function. Such a function, when called, +returns an asynchronous iterator object which can be used in an +async for statement to execute the body of the function.

    +

    Calling the asynchronous iterator’s aiterator.__anext__() method +will return an awaitable which when awaited +will execute until it provides a value using the yield +expression. When the function executes an empty return +statement or falls off the end, a StopAsyncIteration exception +is raised and the asynchronous iterator will have reached the end of +the set of values to be yielded.

    +
    +
    Built-in functions

    A built-in function object is a wrapper around a C function. Examples of +built-in functions are len() and math.sin() (math is a +standard built-in module). The number and type of the arguments are +determined by the C function. Special read-only attributes: +__doc__ is the function’s documentation string, or None if +unavailable; __name__ is the function’s name; __self__ is +set to None (but see the next item); __module__ is the name of +the module the function was defined in or None if unavailable.

    +
    +
    Built-in methods

    This is really a different disguise of a built-in function, this time containing +an object passed to the C function as an implicit extra argument. An example of +a built-in method is alist.append(), assuming alist is a list object. In +this case, the special read-only attribute __self__ is set to the object +denoted by alist.

    +
    +
    Classes

    Classes are callable. These objects normally act as factories for new +instances of themselves, but variations are possible for class types that +override __new__(). The arguments of the call are passed to +__new__() and, in the typical case, to __init__() to +initialize the new instance.

    +
    +
    Class Instances

    Instances of arbitrary classes can be made callable by defining a +__call__() method in their class.

    +
    +
    +
    +
    Modules

    Modules are a basic organizational unit of Python code, and are created by +the import system as invoked either by the +import statement, or by calling +functions such as importlib.import_module() and built-in +__import__(). A module object has a namespace implemented by a +dictionary object (this is the dictionary referenced by the __globals__ +attribute of functions defined in the module). Attribute references are +translated to lookups in this dictionary, e.g., m.x is equivalent to +m.__dict__["x"]. A module object does not contain the code object used +to initialize the module (since it isn’t needed once the initialization is +done).

    +

    Attribute assignment updates the module’s namespace dictionary, e.g., +m.x = 1 is equivalent to m.__dict__["x"] = 1.

    +

    Predefined (writable) attributes: __name__ is the module’s name; +__doc__ is the module’s documentation string, or None if +unavailable; __annotations__ (optional) is a dictionary containing +variable annotations collected during module +body execution; __file__ is the pathname of the file from which the +module was loaded, if it was loaded from a file. The __file__ +attribute may be missing for certain types of modules, such as C modules +that are statically linked into the interpreter; for extension modules +loaded dynamically from a shared library, it is the pathname of the shared +library file.

    +

    Special read-only attribute: __dict__ is the module’s +namespace as a dictionary object.

    +
    +

    CPython implementation detail: Because of the way CPython clears module dictionaries, the module +dictionary will be cleared when the module falls out of scope even if the +dictionary still has live references. To avoid this, copy the dictionary +or keep the module around while using its dictionary directly.

    +
    +
    +
    Custom classes

    Custom class types are typically created by class definitions (see section +Class definitions). A class has a namespace implemented by a dictionary object. +Class attribute references are translated to lookups in this dictionary, e.g., +C.x is translated to C.__dict__["x"] (although there are a number of +hooks which allow for other means of locating attributes). When the attribute +name is not found there, the attribute search continues in the base classes. +This search of the base classes uses the C3 method resolution order which +behaves correctly even in the presence of ‘diamond’ inheritance structures +where there are multiple inheritance paths leading back to a common ancestor. +Additional details on the C3 MRO used by Python can be found in the +documentation accompanying the 2.3 release at +https://www.python.org/download/releases/2.3/mro/.

    +

    When a class attribute reference (for class C, say) would yield a +class method object, it is transformed into an instance method object whose +__self__ attribute is C. When it would yield a static +method object, it is transformed into the object wrapped by the static method +object. See section Implementing Descriptors for another way in which attributes +retrieved from a class may differ from those actually contained in its +__dict__.

    +

    Class attribute assignments update the class’s dictionary, never the dictionary +of a base class.

    +

    A class object can be called (see above) to yield a class instance (see below).

    +

    Special attributes: __name__ is the class name; __module__ is +the module name in which the class was defined; __dict__ is the +dictionary containing the class’s namespace; __bases__ is a +tuple containing the base classes, in the order of their occurrence in the +base class list; __doc__ is the class’s documentation string, +or None if undefined; __annotations__ (optional) is a dictionary +containing variable annotations collected during +class body execution.

    +
    +
    Class instances

    A class instance is created by calling a class object (see above). A class +instance has a namespace implemented as a dictionary which is the first place +in which attribute references are searched. When an attribute is not found +there, and the instance’s class has an attribute by that name, the search +continues with the class attributes. If a class attribute is found that is a +user-defined function object, it is transformed into an instance method +object whose __self__ attribute is the instance. Static method and +class method objects are also transformed; see above under “Classes”. See +section Implementing Descriptors for another way in which attributes of a class +retrieved via its instances may differ from the objects actually stored in +the class’s __dict__. If no class attribute is found, and the +object’s class has a __getattr__() method, that is called to satisfy +the lookup.

    +

    Attribute assignments and deletions update the instance’s dictionary, never a +class’s dictionary. If the class has a __setattr__() or +__delattr__() method, this is called instead of updating the instance +dictionary directly.

    +

    Class instances can pretend to be numbers, sequences, or mappings if they have +methods with certain special names. See section Special method names.

    +

    Special attributes: __dict__ is the attribute dictionary; +__class__ is the instance’s class.

    +
    +
    I/O objects (also known as file objects)

    A file object represents an open file. Various shortcuts are +available to create file objects: the open() built-in function, and +also os.popen(), os.fdopen(), and the +makefile() method of socket objects (and perhaps by +other functions or methods provided by extension modules).

    +

    The objects sys.stdin, sys.stdout and sys.stderr are +initialized to file objects corresponding to the interpreter’s standard +input, output and error streams; they are all open in text mode and +therefore follow the interface defined by the io.TextIOBase +abstract class.

    +
    +
    Internal types

    A few types used internally by the interpreter are exposed to the user. Their +definitions may change with future versions of the interpreter, but they are +mentioned here for completeness.

    +
    +
    Code objects

    Code objects represent byte-compiled executable Python code, or bytecode. +The difference between a code object and a function object is that the function +object contains an explicit reference to the function’s globals (the module in +which it was defined), while a code object contains no context; also the default +argument values are stored in the function object, not in the code object +(because they represent values calculated at run-time). Unlike function +objects, code objects are immutable and contain no references (directly or +indirectly) to mutable objects.

    +

    Special read-only attributes: co_name gives the function name; +co_argcount is the number of positional arguments (including arguments +with default values); co_nlocals is the number of local variables used +by the function (including arguments); co_varnames is a tuple containing +the names of the local variables (starting with the argument names); +co_cellvars is a tuple containing the names of local variables that are +referenced by nested functions; co_freevars is a tuple containing the +names of free variables; co_code is a string representing the sequence +of bytecode instructions; co_consts is a tuple containing the literals +used by the bytecode; co_names is a tuple containing the names used by +the bytecode; co_filename is the filename from which the code was +compiled; co_firstlineno is the first line number of the function; +co_lnotab is a string encoding the mapping from bytecode offsets to +line numbers (for details see the source code of the interpreter); +co_stacksize is the required stack size (including local variables); +co_flags is an integer encoding a number of flags for the interpreter.

    +

    The following flag bits are defined for co_flags: bit 0x04 is set if +the function uses the *arguments syntax to accept an arbitrary number of +positional arguments; bit 0x08 is set if the function uses the +**keywords syntax to accept arbitrary keyword arguments; bit 0x20 is set +if the function is a generator.

    +

    Future feature declarations (from __future__ import division) also use bits +in co_flags to indicate whether a code object was compiled with a +particular feature enabled: bit 0x2000 is set if the function was compiled +with future division enabled; bits 0x10 and 0x1000 were used in earlier +versions of Python.

    +

    Other bits in co_flags are reserved for internal use.

    +

    If a code object represents a function, the first item in co_consts is +the documentation string of the function, or None if undefined.

    +
    +
    +
    +
    Frame objects

    Frame objects represent execution frames. They may occur in traceback objects +(see below), and are also passed to registered trace functions.

    +

    Special read-only attributes: f_back is to the previous stack frame +(towards the caller), or None if this is the bottom stack frame; +f_code is the code object being executed in this frame; f_locals +is the dictionary used to look up local variables; f_globals is used for +global variables; f_builtins is used for built-in (intrinsic) names; +f_lasti gives the precise instruction (this is an index into the +bytecode string of the code object).

    +

    Special writable attributes: f_trace, if not None, is a function +called for various events during code execution (this is used by the debugger). +Normally an event is triggered for each new source line - this can be +disabled by setting f_trace_lines to False.

    +

    Implementations may allow per-opcode events to be requested by setting +f_trace_opcodes to True. Note that this may lead to +undefined interpreter behaviour if exceptions raised by the trace +function escape to the function being traced.

    +

    f_lineno is the current line number of the frame — writing to this +from within a trace function jumps to the given line (only for the bottom-most +frame). A debugger can implement a Jump command (aka Set Next Statement) +by writing to f_lineno.

    +

    Frame objects support one method:

    +
    +
    +frame.clear()
    +

    This method clears all references to local variables held by the +frame. Also, if the frame belonged to a generator, the generator +is finalized. This helps break reference cycles involving frame +objects (for example when catching an exception and storing its +traceback for later use).

    +

    RuntimeError is raised if the frame is currently executing.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +
    +
    Traceback objects

    Traceback objects represent a stack trace of an exception. A traceback object +is implicitly created when an exception occurs, and may also be explicitly +created by calling types.TracebackType.

    +

    For implicitly created tracebacks, when the search for an exception handler +unwinds the execution stack, at each unwound level a traceback object is +inserted in front of the current traceback. When an exception handler is +entered, the stack trace is made available to the program. (See section +The try statement.) It is accessible as the third item of the +tuple returned by sys.exc_info(), and as the __traceback__ attribute +of the caught exception.

    +

    When the program contains no suitable +handler, the stack trace is written (nicely formatted) to the standard error +stream; if the interpreter is interactive, it is also made available to the user +as sys.last_traceback.

    +

    For explicitly created tracebacks, it is up to the creator of the traceback +to determine how the tb_next attributes should be linked to form a +full stack trace.

    +

    Special read-only attributes: +tb_frame points to the execution frame of the current level; +tb_lineno gives the line number where the exception occurred; +tb_lasti indicates the precise instruction. +The line number and last instruction in the traceback may differ from the +line number of its frame object if the exception occurred in a +try statement with no matching except clause or with a +finally clause.

    +

    Special writable attribute: tb_next is the next level in the stack +trace (towards the frame where the exception occurred), or None if +there is no next level.

    +
    +

    Changed in version 3.7: Traceback objects can now be explicitly instantiated from Python code, +and the tb_next attribute of existing instances can be updated.

    +
    +
    +
    Slice objects

    Slice objects are used to represent slices for __getitem__() +methods. They are also created by the built-in slice() function.

    +

    Special read-only attributes: start is the lower bound; +stop is the upper bound; step is the step +value; each is None if omitted. These attributes can have any type.

    +

    Slice objects support one method:

    +
    +
    +slice.indices(self, length)
    +

    This method takes a single integer argument length and computes +information about the slice that the slice object would describe if +applied to a sequence of length items. It returns a tuple of three +integers; respectively these are the start and stop indices and the +step or stride length of the slice. Missing or out-of-bounds indices +are handled in a manner consistent with regular slices.

    +
    + +
    +
    Static method objects

    Static method objects provide a way of defeating the transformation of function +objects to method objects described above. A static method object is a wrapper +around any other object, usually a user-defined method object. When a static +method object is retrieved from a class or a class instance, the object actually +returned is the wrapped object, which is not subject to any further +transformation. Static method objects are not themselves callable, although the +objects they wrap usually are. Static method objects are created by the built-in +staticmethod() constructor.

    +
    +
    Class method objects

    A class method object, like a static method object, is a wrapper around another +object that alters the way in which that object is retrieved from classes and +class instances. The behaviour of class method objects upon such retrieval is +described above, under “User-defined methods”. Class method objects are created +by the built-in classmethod() constructor.

    +
    +
    +
    +
    +
    +
    +

    3.3. Special method names

    +

    A class can implement certain operations that are invoked by special syntax +(such as arithmetic operations or subscripting and slicing) by defining methods +with special names. This is Python’s approach to operator overloading, +allowing classes to define their own behavior with respect to language +operators. For instance, if a class defines a method named __getitem__(), +and x is an instance of this class, then x[i] is roughly equivalent +to type(x).__getitem__(x, i). Except where mentioned, attempts to execute an +operation raise an exception when no appropriate method is defined (typically +AttributeError or TypeError).

    +

    Setting a special method to None indicates that the corresponding +operation is not available. For example, if a class sets +__iter__() to None, the class is not iterable, so calling +iter() on its instances will raise a TypeError (without +falling back to __getitem__()). 2

    +

    When implementing a class that emulates any built-in type, it is important that +the emulation only be implemented to the degree that it makes sense for the +object being modelled. For example, some sequences may work well with retrieval +of individual elements, but extracting a slice may not make sense. (One example +of this is the NodeList interface in the W3C’s Document +Object Model.)

    +
    +

    3.3.1. Basic customization

    +
    +
    +object.__new__(cls[, ...])
    +

    Called to create a new instance of class cls. __new__() is a static +method (special-cased so you need not declare it as such) that takes the class +of which an instance was requested as its first argument. The remaining +arguments are those passed to the object constructor expression (the call to the +class). The return value of __new__() should be the new object instance +(usually an instance of cls).

    +

    Typical implementations create a new instance of the class by invoking the +superclass’s __new__() method using super().__new__(cls[, ...]) +with appropriate arguments and then modifying the newly-created instance +as necessary before returning it.

    +

    If __new__() returns an instance of cls, then the new instance’s +__init__() method will be invoked like __init__(self[, ...]), where +self is the new instance and the remaining arguments are the same as were +passed to __new__().

    +

    If __new__() does not return an instance of cls, then the new instance’s +__init__() method will not be invoked.

    +

    __new__() is intended mainly to allow subclasses of immutable types (like +int, str, or tuple) to customize instance creation. It is also commonly +overridden in custom metaclasses in order to customize class creation.

    +
    + +
    +
    +object.__init__(self[, ...])
    +

    Called after the instance has been created (by __new__()), but before +it is returned to the caller. The arguments are those passed to the +class constructor expression. If a base class has an __init__() +method, the derived class’s __init__() method, if any, must explicitly +call it to ensure proper initialization of the base class part of the +instance; for example: super().__init__([args...]).

    +

    Because __new__() and __init__() work together in constructing +objects (__new__() to create it, and __init__() to customize it), +no non-None value may be returned by __init__(); doing so will +cause a TypeError to be raised at runtime.

    +
    + +
    +
    +object.__del__(self)
    +

    Called when the instance is about to be destroyed. This is also called a +finalizer or (improperly) a destructor. If a base class has a +__del__() method, the derived class’s __del__() method, +if any, must explicitly call it to ensure proper deletion of the base +class part of the instance.

    +

    It is possible (though not recommended!) for the __del__() method +to postpone destruction of the instance by creating a new reference to +it. This is called object resurrection. It is implementation-dependent +whether __del__() is called a second time when a resurrected object +is about to be destroyed; the current CPython implementation +only calls it once.

    +

    It is not guaranteed that __del__() methods are called for objects +that still exist when the interpreter exits.

    +
    +

    Note

    +

    del x doesn’t directly call x.__del__() — the former decrements +the reference count for x by one, and the latter is only called when +x’s reference count reaches zero.

    +
    +
    +

    CPython implementation detail: It is possible for a reference cycle to prevent the reference count +of an object from going to zero. In this case, the cycle will be +later detected and deleted by the cyclic garbage collector. A common cause of reference cycles is when +an exception has been caught in a local variable. The frame’s +locals then reference the exception, which references its own +traceback, which references the locals of all frames caught in the +traceback.

    +
    +

    See also

    +

    Documentation for the gc module.

    +
    +
    +
    +

    Warning

    +

    Due to the precarious circumstances under which __del__() methods are +invoked, exceptions that occur during their execution are ignored, and a warning +is printed to sys.stderr instead. In particular:

    +
      +
    • __del__() can be invoked when arbitrary code is being executed, +including from any arbitrary thread. If __del__() needs to take +a lock or invoke any other blocking resource, it may deadlock as +the resource may already be taken by the code that gets interrupted +to execute __del__().

    • +
    • __del__() can be executed during interpreter shutdown. As a +consequence, the global variables it needs to access (including other +modules) may already have been deleted or set to None. Python +guarantees that globals whose name begins with a single underscore +are deleted from their module before other globals are deleted; if +no other references to such globals exist, this may help in assuring +that imported modules are still available at the time when the +__del__() method is called.

    • +
    +
    +
    + +
    +
    +object.__repr__(self)
    +

    Called by the repr() built-in function to compute the “official” string +representation of an object. If at all possible, this should look like a +valid Python expression that could be used to recreate an object with the +same value (given an appropriate environment). If this is not possible, a +string of the form <...some useful description...> should be returned. +The return value must be a string object. If a class defines __repr__() +but not __str__(), then __repr__() is also used when an +“informal” string representation of instances of that class is required.

    +

    This is typically used for debugging, so it is important that the representation +is information-rich and unambiguous.

    +
    + +
    +
    +object.__str__(self)
    +

    Called by str(object) and the built-in functions +format() and print() to compute the “informal” or nicely +printable string representation of an object. The return value must be a +string object.

    +

    This method differs from object.__repr__() in that there is no +expectation that __str__() return a valid Python expression: a more +convenient or concise representation can be used.

    +

    The default implementation defined by the built-in type object +calls object.__repr__().

    +
    + +
    +
    +object.__bytes__(self)
    +

    Called by bytes to compute a byte-string representation +of an object. This should return a bytes object.

    +
    + +
    +
    +object.__format__(self, format_spec)
    +

    Called by the format() built-in function, +and by extension, evaluation of formatted string literals and the str.format() method, to produce a “formatted” +string representation of an object. The format_spec argument is +a string that contains a description of the formatting options desired. +The interpretation of the format_spec argument is up to the type +implementing __format__(), however most classes will either +delegate formatting to one of the built-in types, or use a similar +formatting option syntax.

    +

    See Format Specification Mini-Language for a description of the standard formatting syntax.

    +

    The return value must be a string object.

    +
    +

    Changed in version 3.4: The __format__ method of object itself raises a TypeError +if passed any non-empty string.

    +
    +
    +

    Changed in version 3.7: object.__format__(x, '') is now equivalent to str(x) rather +than format(str(self), '').

    +
    +
    + +
    +
    +object.__lt__(self, other)
    +
    +object.__le__(self, other)
    +
    +object.__eq__(self, other)
    +
    +object.__ne__(self, other)
    +
    +object.__gt__(self, other)
    +
    +object.__ge__(self, other)
    +

    These are the so-called “rich comparison” methods. The correspondence between +operator symbols and method names is as follows: x<y calls x.__lt__(y), +x<=y calls x.__le__(y), x==y calls x.__eq__(y), x!=y calls +x.__ne__(y), x>y calls x.__gt__(y), and x>=y calls +x.__ge__(y).

    +

    A rich comparison method may return the singleton NotImplemented if it does +not implement the operation for a given pair of arguments. By convention, +False and True are returned for a successful comparison. However, these +methods can return any value, so if the comparison operator is used in a Boolean +context (e.g., in the condition of an if statement), Python will call +bool() on the value to determine if the result is true or false.

    +

    By default, __ne__() delegates to __eq__() and +inverts the result unless it is NotImplemented. There are no other +implied relationships among the comparison operators, for example, +the truth of (x<y or x==y) does not imply x<=y. +To automatically generate ordering operations from a single root operation, +see functools.total_ordering().

    +

    See the paragraph on __hash__() for +some important notes on creating hashable objects which support +custom comparison operations and are usable as dictionary keys.

    +

    There are no swapped-argument versions of these methods (to be used when the +left argument does not support the operation but the right argument does); +rather, __lt__() and __gt__() are each other’s reflection, +__le__() and __ge__() are each other’s reflection, and +__eq__() and __ne__() are their own reflection. +If the operands are of different types, and right operand’s type is +a direct or indirect subclass of the left operand’s type, +the reflected method of the right operand has priority, otherwise +the left operand’s method has priority. Virtual subclassing is +not considered.

    +
    + +
    +
    +object.__hash__(self)
    +

    Called by built-in function hash() and for operations on members of +hashed collections including set, frozenset, and +dict. __hash__() should return an integer. The only required +property is that objects which compare equal have the same hash value; it is +advised to mix together the hash values of the components of the object that +also play a part in comparison of objects by packing them into a tuple and +hashing the tuple. Example:

    +
    def __hash__(self):
    +    return hash((self.name, self.nick, self.color))
    +
    +
    +
    +

    Note

    +

    hash() truncates the value returned from an object’s custom +__hash__() method to the size of a Py_ssize_t. This is +typically 8 bytes on 64-bit builds and 4 bytes on 32-bit builds. If an +object’s __hash__() must interoperate on builds of different bit +sizes, be sure to check the width on all supported builds. An easy way +to do this is with +python -c "import sys; print(sys.hash_info.width)".

    +
    +

    If a class does not define an __eq__() method it should not define a +__hash__() operation either; if it defines __eq__() but not +__hash__(), its instances will not be usable as items in hashable +collections. If a class defines mutable objects and implements an +__eq__() method, it should not implement __hash__(), since the +implementation of hashable collections requires that a key’s hash value is +immutable (if the object’s hash value changes, it will be in the wrong hash +bucket).

    +

    User-defined classes have __eq__() and __hash__() methods +by default; with them, all objects compare unequal (except with themselves) +and x.__hash__() returns an appropriate value such that x == y +implies both that x is y and hash(x) == hash(y).

    +

    A class that overrides __eq__() and does not define __hash__() +will have its __hash__() implicitly set to None. When the +__hash__() method of a class is None, instances of the class will +raise an appropriate TypeError when a program attempts to retrieve +their hash value, and will also be correctly identified as unhashable when +checking isinstance(obj, collections.abc.Hashable).

    +

    If a class that overrides __eq__() needs to retain the implementation +of __hash__() from a parent class, the interpreter must be told this +explicitly by setting __hash__ = <ParentClass>.__hash__.

    +

    If a class that does not override __eq__() wishes to suppress hash +support, it should include __hash__ = None in the class definition. +A class which defines its own __hash__() that explicitly raises +a TypeError would be incorrectly identified as hashable by +an isinstance(obj, collections.abc.Hashable) call.

    +
    +

    Note

    +

    By default, the __hash__() values of str, bytes and datetime +objects are “salted” with an unpredictable random value. Although they +remain constant within an individual Python process, they are not +predictable between repeated invocations of Python.

    +

    This is intended to provide protection against a denial-of-service caused +by carefully-chosen inputs that exploit the worst case performance of a +dict insertion, O(n^2) complexity. See +http://www.ocert.org/advisories/ocert-2011-003.html for details.

    +

    Changing hash values affects the iteration order of sets. +Python has never made guarantees about this ordering +(and it typically varies between 32-bit and 64-bit builds).

    +

    See also PYTHONHASHSEED.

    +
    +
    +

    Changed in version 3.3: Hash randomization is enabled by default.

    +
    +
    + +
    +
    +object.__bool__(self)
    +

    Called to implement truth value testing and the built-in operation +bool(); should return False or True. When this method is not +defined, __len__() is called, if it is defined, and the object is +considered true if its result is nonzero. If a class defines neither +__len__() nor __bool__(), all its instances are considered +true.

    +
    + +
    +
    +

    3.3.2. Customizing attribute access

    +

    The following methods can be defined to customize the meaning of attribute +access (use of, assignment to, or deletion of x.name) for class instances.

    +
    +
    +object.__getattr__(self, name)
    +

    Called when the default attribute access fails with an AttributeError +(either __getattribute__() raises an AttributeError because +name is not an instance attribute or an attribute in the class tree +for self; or __get__() of a name property raises +AttributeError). This method should either return the (computed) +attribute value or raise an AttributeError exception.

    +

    Note that if the attribute is found through the normal mechanism, +__getattr__() is not called. (This is an intentional asymmetry between +__getattr__() and __setattr__().) This is done both for efficiency +reasons and because otherwise __getattr__() would have no way to access +other attributes of the instance. Note that at least for instance variables, +you can fake total control by not inserting any values in the instance attribute +dictionary (but instead inserting them in another object). See the +__getattribute__() method below for a way to actually get total control +over attribute access.

    +
    + +
    +
    +object.__getattribute__(self, name)
    +

    Called unconditionally to implement attribute accesses for instances of the +class. If the class also defines __getattr__(), the latter will not be +called unless __getattribute__() either calls it explicitly or raises an +AttributeError. This method should return the (computed) attribute value +or raise an AttributeError exception. In order to avoid infinite +recursion in this method, its implementation should always call the base class +method with the same name to access any attributes it needs, for example, +object.__getattribute__(self, name).

    +
    +

    Note

    +

    This method may still be bypassed when looking up special methods as the +result of implicit invocation via language syntax or built-in functions. +See Special method lookup.

    +
    +
    + +
    +
    +object.__setattr__(self, name, value)
    +

    Called when an attribute assignment is attempted. This is called instead of +the normal mechanism (i.e. store the value in the instance dictionary). +name is the attribute name, value is the value to be assigned to it.

    +

    If __setattr__() wants to assign to an instance attribute, it should +call the base class method with the same name, for example, +object.__setattr__(self, name, value).

    +
    + +
    +
    +object.__delattr__(self, name)
    +

    Like __setattr__() but for attribute deletion instead of assignment. This +should only be implemented if del obj.name is meaningful for the object.

    +
    + +
    +
    +object.__dir__(self)
    +

    Called when dir() is called on the object. A sequence must be +returned. dir() converts the returned sequence to a list and sorts it.

    +
    + +
    +

    3.3.2.1. Customizing module attribute access

    +

    Special names __getattr__ and __dir__ can be also used to customize +access to module attributes. The __getattr__ function at the module level +should accept one argument which is the name of an attribute and return the +computed value or raise an AttributeError. If an attribute is +not found on a module object through the normal lookup, i.e. +object.__getattribute__(), then __getattr__ is searched in +the module __dict__ before raising an AttributeError. If found, +it is called with the attribute name and the result is returned.

    +

    The __dir__ function should accept no arguments, and return a list of +strings that represents the names accessible on module. If present, this +function overrides the standard dir() search on a module.

    +

    For a more fine grained customization of the module behavior (setting +attributes, properties, etc.), one can set the __class__ attribute of +a module object to a subclass of types.ModuleType. For example:

    +
    import sys
    +from types import ModuleType
    +
    +class VerboseModule(ModuleType):
    +    def __repr__(self):
    +        return f'Verbose {self.__name__}'
    +
    +    def __setattr__(self, attr, value):
    +        print(f'Setting {attr}...')
    +        super().__setattr__(attr, value)
    +
    +sys.modules[__name__].__class__ = VerboseModule
    +
    +
    +
    +

    Note

    +

    Defining module __getattr__ and setting module __class__ only +affect lookups made using the attribute access syntax – directly accessing +the module globals (whether by code within the module, or via a reference +to the module’s globals dictionary) is unaffected.

    +
    +
    +

    Changed in version 3.5: __class__ module attribute is now writable.

    +
    +
    +

    New in version 3.7: __getattr__ and __dir__ module attributes.

    +
    +
    +

    See also

    +
    +
    PEP 562 - Module __getattr__ and __dir__

    Describes the __getattr__ and __dir__ functions on modules.

    +
    +
    +
    +
    +
    +

    3.3.2.2. Implementing Descriptors

    +

    The following methods only apply when an instance of the class containing the +method (a so-called descriptor class) appears in an owner class (the +descriptor must be in either the owner’s class dictionary or in the class +dictionary for one of its parents). In the examples below, “the attribute” +refers to the attribute whose name is the key of the property in the owner +class’ __dict__.

    +
    +
    +object.__get__(self, instance, owner)
    +

    Called to get the attribute of the owner class (class attribute access) or of an +instance of that class (instance attribute access). owner is always the owner +class, while instance is the instance that the attribute was accessed through, +or None when the attribute is accessed through the owner. This method +should return the (computed) attribute value or raise an AttributeError +exception.

    +
    + +
    +
    +object.__set__(self, instance, value)
    +

    Called to set the attribute on an instance instance of the owner class to a +new value, value.

    +
    + +
    +
    +object.__delete__(self, instance)
    +

    Called to delete the attribute on an instance instance of the owner class.

    +
    + +
    +
    +object.__set_name__(self, owner, name)
    +

    Called at the time the owning class owner is created. The +descriptor has been assigned to name.

    +
    +

    New in version 3.6.

    +
    +
    + +

    The attribute __objclass__ is interpreted by the inspect module +as specifying the class where this object was defined (setting this +appropriately can assist in runtime introspection of dynamic class attributes). +For callables, it may indicate that an instance of the given type (or a +subclass) is expected or required as the first positional argument (for example, +CPython sets this attribute for unbound methods that are implemented in C).

    +
    +
    +

    3.3.2.3. Invoking Descriptors

    +

    In general, a descriptor is an object attribute with “binding behavior”, one +whose attribute access has been overridden by methods in the descriptor +protocol: __get__(), __set__(), and __delete__(). If any of +those methods are defined for an object, it is said to be a descriptor.

    +

    The default behavior for attribute access is to get, set, or delete the +attribute from an object’s dictionary. For instance, a.x has a lookup chain +starting with a.__dict__['x'], then type(a).__dict__['x'], and +continuing through the base classes of type(a) excluding metaclasses.

    +

    However, if the looked-up value is an object defining one of the descriptor +methods, then Python may override the default behavior and invoke the descriptor +method instead. Where this occurs in the precedence chain depends on which +descriptor methods were defined and how they were called.

    +

    The starting point for descriptor invocation is a binding, a.x. How the +arguments are assembled depends on a:

    +
    +
    Direct Call

    The simplest and least common call is when user code directly invokes a +descriptor method: x.__get__(a).

    +
    +
    Instance Binding

    If binding to an object instance, a.x is transformed into the call: +type(a).__dict__['x'].__get__(a, type(a)).

    +
    +
    Class Binding

    If binding to a class, A.x is transformed into the call: +A.__dict__['x'].__get__(None, A).

    +
    +
    Super Binding

    If a is an instance of super, then the binding super(B, obj).m() +searches obj.__class__.__mro__ for the base class A +immediately preceding B and then invokes the descriptor with the call: +A.__dict__['m'].__get__(obj, obj.__class__).

    +
    +
    +

    For instance bindings, the precedence of descriptor invocation depends on the +which descriptor methods are defined. A descriptor can define any combination +of __get__(), __set__() and __delete__(). If it does not +define __get__(), then accessing the attribute will return the descriptor +object itself unless there is a value in the object’s instance dictionary. If +the descriptor defines __set__() and/or __delete__(), it is a data +descriptor; if it defines neither, it is a non-data descriptor. Normally, data +descriptors define both __get__() and __set__(), while non-data +descriptors have just the __get__() method. Data descriptors with +__set__() and __get__() defined always override a redefinition in an +instance dictionary. In contrast, non-data descriptors can be overridden by +instances.

    +

    Python methods (including staticmethod() and classmethod()) are +implemented as non-data descriptors. Accordingly, instances can redefine and +override methods. This allows individual instances to acquire behaviors that +differ from other instances of the same class.

    +

    The property() function is implemented as a data descriptor. Accordingly, +instances cannot override the behavior of a property.

    +
    +
    +

    3.3.2.4. __slots__

    +

    __slots__ allow us to explicitly declare data members (like +properties) and deny the creation of __dict__ and __weakref__ +(unless explicitly declared in __slots__ or available in a parent.)

    +

    The space saved over using __dict__ can be significant. +Attribute lookup speed can be significantly improved as well.

    +
    +
    +object.__slots__
    +

    This class variable can be assigned a string, iterable, or sequence of +strings with variable names used by instances. __slots__ reserves space +for the declared variables and prevents the automatic creation of __dict__ +and __weakref__ for each instance.

    +
    + +
    +
    3.3.2.4.1. Notes on using __slots__
    +
      +
    • When inheriting from a class without __slots__, the __dict__ and +__weakref__ attribute of the instances will always be accessible.

    • +
    • Without a __dict__ variable, instances cannot be assigned new variables not +listed in the __slots__ definition. Attempts to assign to an unlisted +variable name raises AttributeError. If dynamic assignment of new +variables is desired, then add '__dict__' to the sequence of strings in +the __slots__ declaration.

    • +
    • Without a __weakref__ variable for each instance, classes defining +__slots__ do not support weak references to its instances. If weak reference +support is needed, then add '__weakref__' to the sequence of strings in the +__slots__ declaration.

    • +
    • __slots__ are implemented at the class level by creating descriptors +(Implementing Descriptors) for each variable name. As a result, class attributes +cannot be used to set default values for instance variables defined by +__slots__; otherwise, the class attribute would overwrite the descriptor +assignment.

    • +
    • The action of a __slots__ declaration is not limited to the class +where it is defined. __slots__ declared in parents are available in +child classes. However, child subclasses will get a __dict__ and +__weakref__ unless they also define __slots__ (which should only +contain names of any additional slots).

    • +
    • If a class defines a slot also defined in a base class, the instance variable +defined by the base class slot is inaccessible (except by retrieving its +descriptor directly from the base class). This renders the meaning of the +program undefined. In the future, a check may be added to prevent this.

    • +
    • Nonempty __slots__ does not work for classes derived from “variable-length” +built-in types such as int, bytes and tuple.

    • +
    • Any non-string iterable may be assigned to __slots__. Mappings may also be +used; however, in the future, special meaning may be assigned to the values +corresponding to each key.

    • +
    • __class__ assignment works only if both classes have the same __slots__.

    • +
    • Multiple inheritance with multiple slotted parent classes can be used, +but only one parent is allowed to have attributes created by slots +(the other bases must have empty slot layouts) - violations raise +TypeError.

    • +
    +
    +
    +
    +
    +

    3.3.3. Customizing class creation

    +

    Whenever a class inherits from another class, __init_subclass__ is +called on that class. This way, it is possible to write classes which +change the behavior of subclasses. This is closely related to class +decorators, but where class decorators only affect the specific class they’re +applied to, __init_subclass__ solely applies to future subclasses of the +class defining the method.

    +
    +
    +classmethod object.__init_subclass__(cls)
    +

    This method is called whenever the containing class is subclassed. +cls is then the new subclass. If defined as a normal instance method, +this method is implicitly converted to a class method.

    +

    Keyword arguments which are given to a new class are passed to +the parent’s class __init_subclass__. For compatibility with +other classes using __init_subclass__, one should take out the +needed keyword arguments and pass the others over to the base +class, as in:

    +
    class Philosopher:
    +    def __init_subclass__(cls, default_name, **kwargs):
    +        super().__init_subclass__(**kwargs)
    +        cls.default_name = default_name
    +
    +class AustralianPhilosopher(Philosopher, default_name="Bruce"):
    +    pass
    +
    +
    +

    The default implementation object.__init_subclass__ does +nothing, but raises an error if it is called with any arguments.

    +
    +

    Note

    +

    The metaclass hint metaclass is consumed by the rest of the type +machinery, and is never passed to __init_subclass__ implementations. +The actual metaclass (rather than the explicit hint) can be accessed as +type(cls).

    +
    +
    +

    New in version 3.6.

    +
    +
    + +
    +

    3.3.3.1. Metaclasses

    +

    By default, classes are constructed using type(). The class body is +executed in a new namespace and the class name is bound locally to the +result of type(name, bases, namespace).

    +

    The class creation process can be customized by passing the metaclass +keyword argument in the class definition line, or by inheriting from an +existing class that included such an argument. In the following example, +both MyClass and MySubclass are instances of Meta:

    +
    class Meta(type):
    +    pass
    +
    +class MyClass(metaclass=Meta):
    +    pass
    +
    +class MySubclass(MyClass):
    +    pass
    +
    +
    +

    Any other keyword arguments that are specified in the class definition are +passed through to all metaclass operations described below.

    +

    When a class definition is executed, the following steps occur:

    +
      +
    • MRO entries are resolved;

    • +
    • the appropriate metaclass is determined;

    • +
    • the class namespace is prepared;

    • +
    • the class body is executed;

    • +
    • the class object is created.

    • +
    +
    +
    +

    3.3.3.2. Resolving MRO entries

    +

    If a base that appears in class definition is not an instance of type, +then an __mro_entries__ method is searched on it. If found, it is called +with the original bases tuple. This method must return a tuple of classes that +will be used instead of this base. The tuple may be empty, in such case +the original base is ignored.

    +
    +

    See also

    +

    PEP 560 - Core support for typing module and generic types

    +
    +
    +
    +

    3.3.3.3. Determining the appropriate metaclass

    +

    The appropriate metaclass for a class definition is determined as follows:

    +
      +
    • if no bases and no explicit metaclass are given, then type() is used;

    • +
    • if an explicit metaclass is given and it is not an instance of +type(), then it is used directly as the metaclass;

    • +
    • if an instance of type() is given as the explicit metaclass, or +bases are defined, then the most derived metaclass is used.

    • +
    +

    The most derived metaclass is selected from the explicitly specified +metaclass (if any) and the metaclasses (i.e. type(cls)) of all specified +base classes. The most derived metaclass is one which is a subtype of all +of these candidate metaclasses. If none of the candidate metaclasses meets +that criterion, then the class definition will fail with TypeError.

    +
    +
    +

    3.3.3.4. Preparing the class namespace

    +

    Once the appropriate metaclass has been identified, then the class namespace +is prepared. If the metaclass has a __prepare__ attribute, it is called +as namespace = metaclass.__prepare__(name, bases, **kwds) (where the +additional keyword arguments, if any, come from the class definition).

    +

    If the metaclass has no __prepare__ attribute, then the class namespace +is initialised as an empty ordered mapping.

    +
    +

    See also

    +
    +
    PEP 3115 - Metaclasses in Python 3000

    Introduced the __prepare__ namespace hook

    +
    +
    +
    +
    +
    +

    3.3.3.5. Executing the class body

    +

    The class body is executed (approximately) as +exec(body, globals(), namespace). The key difference from a normal +call to exec() is that lexical scoping allows the class body (including +any methods) to reference names from the current and outer scopes when the +class definition occurs inside a function.

    +

    However, even when the class definition occurs inside the function, methods +defined inside the class still cannot see names defined at the class scope. +Class variables must be accessed through the first parameter of instance or +class methods, or through the implicit lexically scoped __class__ reference +described in the next section.

    +
    +
    +

    3.3.3.6. Creating the class object

    +

    Once the class namespace has been populated by executing the class body, +the class object is created by calling +metaclass(name, bases, namespace, **kwds) (the additional keywords +passed here are the same as those passed to __prepare__).

    +

    This class object is the one that will be referenced by the zero-argument +form of super(). __class__ is an implicit closure reference +created by the compiler if any methods in a class body refer to either +__class__ or super. This allows the zero argument form of +super() to correctly identify the class being defined based on +lexical scoping, while the class or instance that was used to make the +current call is identified based on the first argument passed to the method.

    +
    +

    CPython implementation detail: In CPython 3.6 and later, the __class__ cell is passed to the metaclass +as a __classcell__ entry in the class namespace. If present, this must +be propagated up to the type.__new__ call in order for the class to be +initialised correctly. +Failing to do so will result in a DeprecationWarning in Python 3.6, +and a RuntimeError in Python 3.8.

    +
    +

    When using the default metaclass type, or any metaclass that ultimately +calls type.__new__, the following additional customisation steps are +invoked after creating the class object:

    +
      +
    • first, type.__new__ collects all of the descriptors in the class +namespace that define a __set_name__() method;

    • +
    • second, all of these __set_name__ methods are called with the class +being defined and the assigned name of that particular descriptor;

    • +
    • finally, the __init_subclass__() hook is called on the +immediate parent of the new class in its method resolution order.

    • +
    +

    After the class object is created, it is passed to the class decorators +included in the class definition (if any) and the resulting object is bound +in the local namespace as the defined class.

    +

    When a new class is created by type.__new__, the object provided as the +namespace parameter is copied to a new ordered mapping and the original +object is discarded. The new copy is wrapped in a read-only proxy, which +becomes the __dict__ attribute of the class object.

    +
    +

    See also

    +
    +
    PEP 3135 - New super

    Describes the implicit __class__ closure reference

    +
    +
    +
    +
    +
    +

    3.3.3.7. Uses for metaclasses

    +

    The potential uses for metaclasses are boundless. Some ideas that have been +explored include enum, logging, interface checking, automatic delegation, +automatic property creation, proxies, frameworks, and automatic resource +locking/synchronization.

    +
    +
    +
    +

    3.3.4. Customizing instance and subclass checks

    +

    The following methods are used to override the default behavior of the +isinstance() and issubclass() built-in functions.

    +

    In particular, the metaclass abc.ABCMeta implements these methods in +order to allow the addition of Abstract Base Classes (ABCs) as “virtual base +classes” to any class or type (including built-in types), including other +ABCs.

    +
    +
    +class.__instancecheck__(self, instance)
    +

    Return true if instance should be considered a (direct or indirect) +instance of class. If defined, called to implement isinstance(instance, +class).

    +
    + +
    +
    +class.__subclasscheck__(self, subclass)
    +

    Return true if subclass should be considered a (direct or indirect) +subclass of class. If defined, called to implement issubclass(subclass, +class).

    +
    + +

    Note that these methods are looked up on the type (metaclass) of a class. They +cannot be defined as class methods in the actual class. This is consistent with +the lookup of special methods that are called on instances, only in this +case the instance is itself a class.

    +
    +

    See also

    +
    +
    PEP 3119 - Introducing Abstract Base Classes

    Includes the specification for customizing isinstance() and +issubclass() behavior through __instancecheck__() and +__subclasscheck__(), with motivation for this functionality +in the context of adding Abstract Base Classes (see the abc +module) to the language.

    +
    +
    +
    +
    +
    +

    3.3.5. Emulating generic types

    +

    One can implement the generic class syntax as specified by PEP 484 +(for example List[int]) by defining a special method:

    +
    +
    +classmethod object.__class_getitem__(cls, key)
    +

    Return an object representing the specialization of a generic class +by type arguments found in key.

    +
    + +

    This method is looked up on the class object itself, and when defined in +the class body, this method is implicitly a class method. Note, this +mechanism is primarily reserved for use with static type hints, other usage +is discouraged.

    +
    +

    See also

    +

    PEP 560 - Core support for typing module and generic types

    +
    +
    +
    +

    3.3.6. Emulating callable objects

    +
    +
    +object.__call__(self[, args...])
    +

    Called when the instance is “called” as a function; if this method is defined, +x(arg1, arg2, ...) is a shorthand for x.__call__(arg1, arg2, ...).

    +
    + +
    +
    +

    3.3.7. Emulating container types

    +

    The following methods can be defined to implement container objects. Containers +usually are sequences (such as lists or tuples) or mappings (like dictionaries), +but can represent other containers as well. The first set of methods is used +either to emulate a sequence or to emulate a mapping; the difference is that for +a sequence, the allowable keys should be the integers k for which 0 <= k < +N where N is the length of the sequence, or slice objects, which define a +range of items. It is also recommended that mappings provide the methods +keys(), values(), items(), get(), clear(), +setdefault(), pop(), popitem(), copy(), and +update() behaving similar to those for Python’s standard dictionary +objects. The collections.abc module provides a +MutableMapping +abstract base class to help create those methods from a base set of +__getitem__(), __setitem__(), __delitem__(), and keys(). +Mutable sequences should provide methods append(), count(), +index(), extend(), insert(), pop(), remove(), +reverse() and sort(), like Python standard list objects. Finally, +sequence types should implement addition (meaning concatenation) and +multiplication (meaning repetition) by defining the methods __add__(), +__radd__(), __iadd__(), __mul__(), __rmul__() and +__imul__() described below; they should not define other numerical +operators. It is recommended that both mappings and sequences implement the +__contains__() method to allow efficient use of the in operator; for +mappings, in should search the mapping’s keys; for sequences, it should +search through the values. It is further recommended that both mappings and +sequences implement the __iter__() method to allow efficient iteration +through the container; for mappings, __iter__() should be the same as +keys(); for sequences, it should iterate through the values.

    +
    +
    +object.__len__(self)
    +

    Called to implement the built-in function len(). Should return the length +of the object, an integer >= 0. Also, an object that doesn’t define a +__bool__() method and whose __len__() method returns zero is +considered to be false in a Boolean context.

    +
    +

    CPython implementation detail: In CPython, the length is required to be at most sys.maxsize. +If the length is larger than sys.maxsize some features (such as +len()) may raise OverflowError. To prevent raising +OverflowError by truth value testing, an object must define a +__bool__() method.

    +
    +
    + +
    +
    +object.__length_hint__(self)
    +

    Called to implement operator.length_hint(). Should return an estimated +length for the object (which may be greater or less than the actual length). +The length must be an integer >= 0. This method is purely an +optimization and is never required for correctness.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +

    Note

    +

    Slicing is done exclusively with the following three methods. A call like

    +
    a[1:2] = b
    +
    +
    +

    is translated to

    +
    a[slice(1, 2, None)] = b
    +
    +
    +

    and so forth. Missing slice items are always filled in with None.

    +
    +
    +
    +object.__getitem__(self, key)
    +

    Called to implement evaluation of self[key]. For sequence types, the +accepted keys should be integers and slice objects. Note that the special +interpretation of negative indexes (if the class wishes to emulate a sequence +type) is up to the __getitem__() method. If key is of an inappropriate +type, TypeError may be raised; if of a value outside the set of indexes +for the sequence (after any special interpretation of negative values), +IndexError should be raised. For mapping types, if key is missing (not +in the container), KeyError should be raised.

    +
    +

    Note

    +

    for loops expect that an IndexError will be raised for illegal +indexes to allow proper detection of the end of the sequence.

    +
    +
    + +
    +
    +object.__setitem__(self, key, value)
    +

    Called to implement assignment to self[key]. Same note as for +__getitem__(). This should only be implemented for mappings if the +objects support changes to the values for keys, or if new keys can be added, or +for sequences if elements can be replaced. The same exceptions should be raised +for improper key values as for the __getitem__() method.

    +
    + +
    +
    +object.__delitem__(self, key)
    +

    Called to implement deletion of self[key]. Same note as for +__getitem__(). This should only be implemented for mappings if the +objects support removal of keys, or for sequences if elements can be removed +from the sequence. The same exceptions should be raised for improper key +values as for the __getitem__() method.

    +
    + +
    +
    +object.__missing__(self, key)
    +

    Called by dict.__getitem__() to implement self[key] for dict subclasses +when key is not in the dictionary.

    +
    + +
    +
    +object.__iter__(self)
    +

    This method is called when an iterator is required for a container. This method +should return a new iterator object that can iterate over all the objects in the +container. For mappings, it should iterate over the keys of the container.

    +

    Iterator objects also need to implement this method; they are required to return +themselves. For more information on iterator objects, see Iterator Types.

    +
    + +
    +
    +object.__reversed__(self)
    +

    Called (if present) by the reversed() built-in to implement +reverse iteration. It should return a new iterator object that iterates +over all the objects in the container in reverse order.

    +

    If the __reversed__() method is not provided, the reversed() +built-in will fall back to using the sequence protocol (__len__() and +__getitem__()). Objects that support the sequence protocol should +only provide __reversed__() if they can provide an implementation +that is more efficient than the one provided by reversed().

    +
    + +

    The membership test operators (in and not in) are normally +implemented as an iteration through a sequence. However, container objects can +supply the following special method with a more efficient implementation, which +also does not require the object be a sequence.

    +
    +
    +object.__contains__(self, item)
    +

    Called to implement membership test operators. Should return true if item +is in self, false otherwise. For mapping objects, this should consider the +keys of the mapping rather than the values or the key-item pairs.

    +

    For objects that don’t define __contains__(), the membership test first +tries iteration via __iter__(), then the old sequence iteration +protocol via __getitem__(), see this section in the language +reference.

    +
    + +
    +
    +

    3.3.8. Emulating numeric types

    +

    The following methods can be defined to emulate numeric objects. Methods +corresponding to operations that are not supported by the particular kind of +number implemented (e.g., bitwise operations for non-integral numbers) should be +left undefined.

    +
    +
    +object.__add__(self, other)
    +
    +object.__sub__(self, other)
    +
    +object.__mul__(self, other)
    +
    +object.__matmul__(self, other)
    +
    +object.__truediv__(self, other)
    +
    +object.__floordiv__(self, other)
    +
    +object.__mod__(self, other)
    +
    +object.__divmod__(self, other)
    +
    +object.__pow__(self, other[, modulo])
    +
    +object.__lshift__(self, other)
    +
    +object.__rshift__(self, other)
    +
    +object.__and__(self, other)
    +
    +object.__xor__(self, other)
    +
    +object.__or__(self, other)
    +

    These methods are called to implement the binary arithmetic operations +(+, -, *, @, /, //, %, divmod(), +pow(), **, <<, >>, &, ^, |). For instance, to +evaluate the expression x + y, where x is an instance of a class that +has an __add__() method, x.__add__(y) is called. The +__divmod__() method should be the equivalent to using +__floordiv__() and __mod__(); it should not be related to +__truediv__(). Note that __pow__() should be defined to accept +an optional third argument if the ternary version of the built-in pow() +function is to be supported.

    +

    If one of those methods does not support the operation with the supplied +arguments, it should return NotImplemented.

    +
    + +
    +
    +object.__radd__(self, other)
    +
    +object.__rsub__(self, other)
    +
    +object.__rmul__(self, other)
    +
    +object.__rmatmul__(self, other)
    +
    +object.__rtruediv__(self, other)
    +
    +object.__rfloordiv__(self, other)
    +
    +object.__rmod__(self, other)
    +
    +object.__rdivmod__(self, other)
    +
    +object.__rpow__(self, other)
    +
    +object.__rlshift__(self, other)
    +
    +object.__rrshift__(self, other)
    +
    +object.__rand__(self, other)
    +
    +object.__rxor__(self, other)
    +
    +object.__ror__(self, other)
    +

    These methods are called to implement the binary arithmetic operations +(+, -, *, @, /, //, %, divmod(), +pow(), **, <<, >>, &, ^, |) with reflected +(swapped) operands. These functions are only called if the left operand does +not support the corresponding operation 3 and the operands are of different +types. 4 For instance, to evaluate the expression x - y, where y is +an instance of a class that has an __rsub__() method, y.__rsub__(x) +is called if x.__sub__(y) returns NotImplemented.

    +

    Note that ternary pow() will not try calling __rpow__() (the +coercion rules would become too complicated).

    +
    +

    Note

    +

    If the right operand’s type is a subclass of the left operand’s type and that +subclass provides the reflected method for the operation, this method will be +called before the left operand’s non-reflected method. This behavior allows +subclasses to override their ancestors’ operations.

    +
    +
    + +
    +
    +object.__iadd__(self, other)
    +
    +object.__isub__(self, other)
    +
    +object.__imul__(self, other)
    +
    +object.__imatmul__(self, other)
    +
    +object.__itruediv__(self, other)
    +
    +object.__ifloordiv__(self, other)
    +
    +object.__imod__(self, other)
    +
    +object.__ipow__(self, other[, modulo])
    +
    +object.__ilshift__(self, other)
    +
    +object.__irshift__(self, other)
    +
    +object.__iand__(self, other)
    +
    +object.__ixor__(self, other)
    +
    +object.__ior__(self, other)
    +

    These methods are called to implement the augmented arithmetic assignments +(+=, -=, *=, @=, /=, //=, %=, **=, <<=, +>>=, &=, ^=, |=). These methods should attempt to do the +operation in-place (modifying self) and return the result (which could be, +but does not have to be, self). If a specific method is not defined, the +augmented assignment falls back to the normal methods. For instance, if x +is an instance of a class with an __iadd__() method, x += y is +equivalent to x = x.__iadd__(y) . Otherwise, x.__add__(y) and +y.__radd__(x) are considered, as with the evaluation of x + y. In +certain situations, augmented assignment can result in unexpected errors (see +Why does a_tuple[i] += [‘item’] raise an exception when the addition works?), but this behavior is in fact +part of the data model.

    +
    + +
    +
    +object.__neg__(self)
    +
    +object.__pos__(self)
    +
    +object.__abs__(self)
    +
    +object.__invert__(self)
    +

    Called to implement the unary arithmetic operations (-, +, abs() +and ~).

    +
    + +
    +
    +object.__complex__(self)
    +
    +object.__int__(self)
    +
    +object.__float__(self)
    +

    Called to implement the built-in functions complex(), +int() and float(). Should return a value +of the appropriate type.

    +
    + +
    +
    +object.__index__(self)
    +

    Called to implement operator.index(), and whenever Python needs to +losslessly convert the numeric object to an integer object (such as in +slicing, or in the built-in bin(), hex() and oct() +functions). Presence of this method indicates that the numeric object is +an integer type. Must return an integer.

    +
    +

    Note

    +

    In order to have a coherent integer type class, when __index__() is +defined __int__() should also be defined, and both should return +the same value.

    +
    +
    + +
    +
    +object.__round__(self[, ndigits])
    +
    +object.__trunc__(self)
    +
    +object.__floor__(self)
    +
    +object.__ceil__(self)
    +

    Called to implement the built-in function round() and math +functions trunc(), floor() and ceil(). +Unless ndigits is passed to __round__() all these methods should +return the value of the object truncated to an Integral +(typically an int).

    +

    If __int__() is not defined then the built-in function int() +falls back to __trunc__().

    +
    + +
    +
    +

    3.3.9. With Statement Context Managers

    +

    A context manager is an object that defines the runtime context to be +established when executing a with statement. The context manager +handles the entry into, and the exit from, the desired runtime context for the +execution of the block of code. Context managers are normally invoked using the +with statement (described in section The with statement), but can also be +used by directly invoking their methods.

    +

    Typical uses of context managers include saving and restoring various kinds of +global state, locking and unlocking resources, closing opened files, etc.

    +

    For more information on context managers, see Context Manager Types.

    +
    +
    +object.__enter__(self)
    +

    Enter the runtime context related to this object. The with statement +will bind this method’s return value to the target(s) specified in the +as clause of the statement, if any.

    +
    + +
    +
    +object.__exit__(self, exc_type, exc_value, traceback)
    +

    Exit the runtime context related to this object. The parameters describe the +exception that caused the context to be exited. If the context was exited +without an exception, all three arguments will be None.

    +

    If an exception is supplied, and the method wishes to suppress the exception +(i.e., prevent it from being propagated), it should return a true value. +Otherwise, the exception will be processed normally upon exit from this method.

    +

    Note that __exit__() methods should not reraise the passed-in exception; +this is the caller’s responsibility.

    +
    + +
    +

    See also

    +
    +
    PEP 343 - The “with” statement

    The specification, background, and examples for the Python with +statement.

    +
    +
    +
    +
    +
    +

    3.3.10. Special method lookup

    +

    For custom classes, implicit invocations of special methods are only guaranteed +to work correctly if defined on an object’s type, not in the object’s instance +dictionary. That behaviour is the reason why the following code raises an +exception:

    +
    >>> class C:
    +...     pass
    +...
    +>>> c = C()
    +>>> c.__len__ = lambda: 5
    +>>> len(c)
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +TypeError: object of type 'C' has no len()
    +
    +
    +

    The rationale behind this behaviour lies with a number of special methods such +as __hash__() and __repr__() that are implemented by all objects, +including type objects. If the implicit lookup of these methods used the +conventional lookup process, they would fail when invoked on the type object +itself:

    +
    >>> 1 .__hash__() == hash(1)
    +True
    +>>> int.__hash__() == hash(int)
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +TypeError: descriptor '__hash__' of 'int' object needs an argument
    +
    +
    +

    Incorrectly attempting to invoke an unbound method of a class in this way is +sometimes referred to as ‘metaclass confusion’, and is avoided by bypassing +the instance when looking up special methods:

    +
    >>> type(1).__hash__(1) == hash(1)
    +True
    +>>> type(int).__hash__(int) == hash(int)
    +True
    +
    +
    +

    In addition to bypassing any instance attributes in the interest of +correctness, implicit special method lookup generally also bypasses the +__getattribute__() method even of the object’s metaclass:

    +
    >>> class Meta(type):
    +...     def __getattribute__(*args):
    +...         print("Metaclass getattribute invoked")
    +...         return type.__getattribute__(*args)
    +...
    +>>> class C(object, metaclass=Meta):
    +...     def __len__(self):
    +...         return 10
    +...     def __getattribute__(*args):
    +...         print("Class getattribute invoked")
    +...         return object.__getattribute__(*args)
    +...
    +>>> c = C()
    +>>> c.__len__()                 # Explicit lookup via instance
    +Class getattribute invoked
    +10
    +>>> type(c).__len__(c)          # Explicit lookup via type
    +Metaclass getattribute invoked
    +10
    +>>> len(c)                      # Implicit lookup
    +10
    +
    +
    +

    Bypassing the __getattribute__() machinery in this fashion +provides significant scope for speed optimisations within the +interpreter, at the cost of some flexibility in the handling of +special methods (the special method must be set on the class +object itself in order to be consistently invoked by the interpreter).

    +
    +
    +
    +

    3.4. Coroutines

    +
    +

    3.4.1. Awaitable Objects

    +

    An awaitable object generally implements an __await__() method. +Coroutine objects returned from async def functions +are awaitable.

    +
    +

    Note

    +

    The generator iterator objects returned from generators +decorated with types.coroutine() or asyncio.coroutine() +are also awaitable, but they do not implement __await__().

    +
    +
    +
    +object.__await__(self)
    +

    Must return an iterator. Should be used to implement +awaitable objects. For instance, asyncio.Future implements +this method to be compatible with the await expression.

    +
    + +
    +

    New in version 3.5.

    +
    +
    +

    See also

    +

    PEP 492 for additional information about awaitable objects.

    +
    +
    +
    +

    3.4.2. Coroutine Objects

    +

    Coroutine objects are awaitable objects. +A coroutine’s execution can be controlled by calling __await__() and +iterating over the result. When the coroutine has finished executing and +returns, the iterator raises StopIteration, and the exception’s +value attribute holds the return value. If the +coroutine raises an exception, it is propagated by the iterator. Coroutines +should not directly raise unhandled StopIteration exceptions.

    +

    Coroutines also have the methods listed below, which are analogous to +those of generators (see Generator-iterator methods). However, unlike +generators, coroutines do not directly support iteration.

    +
    +

    Changed in version 3.5.2: It is a RuntimeError to await on a coroutine more than once.

    +
    +
    +
    +coroutine.send(value)
    +

    Starts or resumes execution of the coroutine. If value is None, +this is equivalent to advancing the iterator returned by +__await__(). If value is not None, this method delegates +to the send() method of the iterator that caused +the coroutine to suspend. The result (return value, +StopIteration, or other exception) is the same as when +iterating over the __await__() return value, described above.

    +
    + +
    +
    +coroutine.throw(type[, value[, traceback]])
    +

    Raises the specified exception in the coroutine. This method delegates +to the throw() method of the iterator that caused +the coroutine to suspend, if it has such a method. Otherwise, +the exception is raised at the suspension point. The result +(return value, StopIteration, or other exception) is the same as +when iterating over the __await__() return value, described +above. If the exception is not caught in the coroutine, it propagates +back to the caller.

    +
    + +
    +
    +coroutine.close()
    +

    Causes the coroutine to clean itself up and exit. If the coroutine +is suspended, this method first delegates to the close() +method of the iterator that caused the coroutine to suspend, if it +has such a method. Then it raises GeneratorExit at the +suspension point, causing the coroutine to immediately clean itself up. +Finally, the coroutine is marked as having finished executing, even if +it was never started.

    +

    Coroutine objects are automatically closed using the above process when +they are about to be destroyed.

    +
    + +
    +
    +

    3.4.3. Asynchronous Iterators

    +

    An asynchronous iterator can call asynchronous code in +its __anext__ method.

    +

    Asynchronous iterators can be used in an async for statement.

    +
    +
    +object.__aiter__(self)
    +

    Must return an asynchronous iterator object.

    +
    + +
    +
    +object.__anext__(self)
    +

    Must return an awaitable resulting in a next value of the iterator. Should +raise a StopAsyncIteration error when the iteration is over.

    +
    + +

    An example of an asynchronous iterable object:

    +
    class Reader:
    +    async def readline(self):
    +        ...
    +
    +    def __aiter__(self):
    +        return self
    +
    +    async def __anext__(self):
    +        val = await self.readline()
    +        if val == b'':
    +            raise StopAsyncIteration
    +        return val
    +
    +
    +
    +

    New in version 3.5.

    +
    +
    +

    Changed in version 3.7: Prior to Python 3.7, __aiter__ could return an awaitable +that would resolve to an +asynchronous iterator.

    +

    Starting with Python 3.7, __aiter__ must return an +asynchronous iterator object. Returning anything else +will result in a TypeError error.

    +
    +
    +
    +

    3.4.4. Asynchronous Context Managers

    +

    An asynchronous context manager is a context manager that is able to +suspend execution in its __aenter__ and __aexit__ methods.

    +

    Asynchronous context managers can be used in an async with statement.

    +
    +
    +object.__aenter__(self)
    +

    This method is semantically similar to the __enter__(), with only +difference that it must return an awaitable.

    +
    + +
    +
    +object.__aexit__(self, exc_type, exc_value, traceback)
    +

    This method is semantically similar to the __exit__(), with only +difference that it must return an awaitable.

    +
    + +

    An example of an asynchronous context manager class:

    +
    class AsyncContextManager:
    +    async def __aenter__(self):
    +        await log('entering context')
    +
    +    async def __aexit__(self, exc_type, exc, tb):
    +        await log('exiting context')
    +
    +
    +
    +

    New in version 3.5.

    +
    +

    Footnotes

    +
    +
    1
    +

    It is possible in some cases to change an object’s type, under certain +controlled conditions. It generally isn’t a good idea though, since it can +lead to some very strange behaviour if it is handled incorrectly.

    +
    +
    2
    +

    The __hash__(), __iter__(), __reversed__(), and +__contains__() methods have special handling for this; others +will still raise a TypeError, but may do so by relying on +the behavior that None is not callable.

    +
    +
    3
    +

    “Does not support” here means that the class has no such method, or +the method returns NotImplemented. Do not set the method to +None if you want to force fallback to the right operand’s reflected +method—that will instead have the opposite effect of explicitly +blocking such fallback.

    +
    +
    4
    +

    For operands of the same type, it is assumed that if the non-reflected method +(such as __add__()) fails the operation is not supported, which is why the +reflected method is not called.

    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/reference/executionmodel.html b/python-3.7.4-docs-html/reference/executionmodel.html new file mode 100644 index 0000000..d68df00 --- /dev/null +++ b/python-3.7.4-docs-html/reference/executionmodel.html @@ -0,0 +1,368 @@ + + + + + + + 4. Execution model — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    4. Execution model

    +
    +

    4.1. Structure of a program

    +

    A Python program is constructed from code blocks. +A block is a piece of Python program text that is executed as a unit. +The following are blocks: a module, a function body, and a class definition. +Each command typed interactively is a block. A script file (a file given as +standard input to the interpreter or specified as a command line argument to the +interpreter) is a code block. A script command (a command specified on the +interpreter command line with the -c option) is a code block. The string +argument passed to the built-in functions eval() and exec() is a +code block.

    +

    A code block is executed in an execution frame. A frame contains some +administrative information (used for debugging) and determines where and how +execution continues after the code block’s execution has completed.

    +
    +
    +

    4.2. Naming and binding

    +
    +

    4.2.1. Binding of names

    +

    Names refer to objects. Names are introduced by name binding operations.

    +

    The following constructs bind names: formal parameters to functions, +import statements, class and function definitions (these bind the +class or function name in the defining block), and targets that are identifiers +if occurring in an assignment, for loop header, or after +as in a with statement or except clause. +The import statement +of the form from ... import * binds all names defined in the imported +module, except those beginning with an underscore. This form may only be used +at the module level.

    +

    A target occurring in a del statement is also considered bound for +this purpose (though the actual semantics are to unbind the name).

    +

    Each assignment or import statement occurs within a block defined by a class or +function definition or at the module level (the top-level code block).

    +

    If a name is bound in a block, it is a local variable of that block, unless +declared as nonlocal or global. If a name is bound at +the module level, it is a global variable. (The variables of the module code +block are local and global.) If a variable is used in a code block but not +defined there, it is a free variable.

    +

    Each occurrence of a name in the program text refers to the binding of +that name established by the following name resolution rules.

    +
    +
    +

    4.2.2. Resolution of names

    +

    A scope defines the visibility of a name within a block. If a local +variable is defined in a block, its scope includes that block. If the +definition occurs in a function block, the scope extends to any blocks contained +within the defining one, unless a contained block introduces a different binding +for the name.

    +

    When a name is used in a code block, it is resolved using the nearest enclosing +scope. The set of all such scopes visible to a code block is called the block’s +environment.

    +

    When a name is not found at all, a NameError exception is raised. +If the current scope is a function scope, and the name refers to a local +variable that has not yet been bound to a value at the point where the name is +used, an UnboundLocalError exception is raised. +UnboundLocalError is a subclass of NameError.

    +

    If a name binding operation occurs anywhere within a code block, all uses of the +name within the block are treated as references to the current block. This can +lead to errors when a name is used within a block before it is bound. This rule +is subtle. Python lacks declarations and allows name binding operations to +occur anywhere within a code block. The local variables of a code block can be +determined by scanning the entire text of the block for name binding operations.

    +

    If the global statement occurs within a block, all uses of the name +specified in the statement refer to the binding of that name in the top-level +namespace. Names are resolved in the top-level namespace by searching the +global namespace, i.e. the namespace of the module containing the code block, +and the builtins namespace, the namespace of the module builtins. The +global namespace is searched first. If the name is not found there, the +builtins namespace is searched. The global statement must precede +all uses of the name.

    +

    The global statement has the same scope as a name binding operation +in the same block. If the nearest enclosing scope for a free variable contains +a global statement, the free variable is treated as a global.

    +

    The nonlocal statement causes corresponding names to refer +to previously bound variables in the nearest enclosing function scope. +SyntaxError is raised at compile time if the given name does not +exist in any enclosing function scope.

    +

    The namespace for a module is automatically created the first time a module is +imported. The main module for a script is always called __main__.

    +

    Class definition blocks and arguments to exec() and eval() are +special in the context of name resolution. +A class definition is an executable statement that may use and define names. +These references follow the normal rules for name resolution with an exception +that unbound local variables are looked up in the global namespace. +The namespace of the class definition becomes the attribute dictionary of +the class. The scope of names defined in a class block is limited to the +class block; it does not extend to the code blocks of methods – this includes +comprehensions and generator expressions since they are implemented using a +function scope. This means that the following will fail:

    +
    class A:
    +    a = 42
    +    b = list(a + i for i in range(10))
    +
    +
    +
    +
    +

    4.2.3. Builtins and restricted execution

    +
    +

    CPython implementation detail: Users should not touch __builtins__; it is strictly an implementation +detail. Users wanting to override values in the builtins namespace should +import the builtins module and modify its +attributes appropriately.

    +
    +

    The builtins namespace associated with the execution of a code block +is actually found by looking up the name __builtins__ in its +global namespace; this should be a dictionary or a module (in the +latter case the module’s dictionary is used). By default, when in the +__main__ module, __builtins__ is the built-in module +builtins; when in any other module, __builtins__ is an +alias for the dictionary of the builtins module itself.

    +
    +
    +

    4.2.4. Interaction with dynamic features

    +

    Name resolution of free variables occurs at runtime, not at compile time. +This means that the following code will print 42:

    +
    i = 10
    +def f():
    +    print(i)
    +i = 42
    +f()
    +
    +
    +

    The eval() and exec() functions do not have access to the full +environment for resolving names. Names may be resolved in the local and global +namespaces of the caller. Free variables are not resolved in the nearest +enclosing namespace, but in the global namespace. 1 The exec() and +eval() functions have optional arguments to override the global and local +namespace. If only one namespace is specified, it is used for both.

    +
    +
    +
    +

    4.3. Exceptions

    +

    Exceptions are a means of breaking out of the normal flow of control of a code +block in order to handle errors or other exceptional conditions. An exception +is raised at the point where the error is detected; it may be handled by the +surrounding code block or by any code block that directly or indirectly invoked +the code block where the error occurred.

    +

    The Python interpreter raises an exception when it detects a run-time error +(such as division by zero). A Python program can also explicitly raise an +exception with the raise statement. Exception handlers are specified +with the tryexcept statement. The finally +clause of such a statement can be used to specify cleanup code which does not +handle the exception, but is executed whether an exception occurred or not in +the preceding code.

    +

    Python uses the “termination” model of error handling: an exception handler can +find out what happened and continue execution at an outer level, but it cannot +repair the cause of the error and retry the failing operation (except by +re-entering the offending piece of code from the top).

    +

    When an exception is not handled at all, the interpreter terminates execution of +the program, or returns to its interactive main loop. In either case, it prints +a stack traceback, except when the exception is SystemExit.

    +

    Exceptions are identified by class instances. The except clause is +selected depending on the class of the instance: it must reference the class of +the instance or a base class thereof. The instance can be received by the +handler and can carry additional information about the exceptional condition.

    +
    +

    Note

    +

    Exception messages are not part of the Python API. Their contents may change +from one version of Python to the next without warning and should not be +relied on by code which will run under multiple versions of the interpreter.

    +
    +

    See also the description of the try statement in section The try statement +and raise statement in section The raise statement.

    +

    Footnotes

    +
    +
    1
    +

    This limitation occurs because the code that is executed by these operations +is not available at the time the module is compiled.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/reference/expressions.html b/python-3.7.4-docs-html/reference/expressions.html new file mode 100644 index 0000000..04ebb6e --- /dev/null +++ b/python-3.7.4-docs-html/reference/expressions.html @@ -0,0 +1,1557 @@ + + + + + + + 6. Expressions — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    6. Expressions

    +

    This chapter explains the meaning of the elements of expressions in Python.

    +

    Syntax Notes: In this and the following chapters, extended BNF notation will +be used to describe syntax, not lexical analysis. When (one alternative of) a +syntax rule has the form

    +
    +name ::=  othername
    +
    +

    and no semantics are given, the semantics of this form of name are the same +as for othername.

    +
    +

    6.1. Arithmetic conversions

    +

    When a description of an arithmetic operator below uses the phrase “the numeric +arguments are converted to a common type,” this means that the operator +implementation for built-in types works as follows:

    +
      +
    • If either argument is a complex number, the other is converted to complex;

    • +
    • otherwise, if either argument is a floating point number, the other is +converted to floating point;

    • +
    • otherwise, both must be integers and no conversion is necessary.

    • +
    +

    Some additional rules apply for certain operators (e.g., a string as a left +argument to the ‘%’ operator). Extensions must define their own conversion +behavior.

    +
    +
    +

    6.2. Atoms

    +

    Atoms are the most basic elements of expressions. The simplest atoms are +identifiers or literals. Forms enclosed in parentheses, brackets or braces are +also categorized syntactically as atoms. The syntax for atoms is:

    +
    +atom      ::=  identifier | literal | enclosure
    +enclosure ::=  parenth_form | list_display | dict_display | set_display
    +               | generator_expression | yield_atom
    +
    +
    +

    6.2.1. Identifiers (Names)

    +

    An identifier occurring as an atom is a name. See section Identifiers and keywords +for lexical definition and section Naming and binding for documentation of naming and +binding.

    +

    When the name is bound to an object, evaluation of the atom yields that object. +When a name is not bound, an attempt to evaluate it raises a NameError +exception.

    +

    Private name mangling: When an identifier that textually occurs in a class +definition begins with two or more underscore characters and does not end in two +or more underscores, it is considered a private name of that class. +Private names are transformed to a longer form before code is generated for +them. The transformation inserts the class name, with leading underscores +removed and a single underscore inserted, in front of the name. For example, +the identifier __spam occurring in a class named Ham will be transformed +to _Ham__spam. This transformation is independent of the syntactical +context in which the identifier is used. If the transformed name is extremely +long (longer than 255 characters), implementation defined truncation may happen. +If the class name consists only of underscores, no transformation is done.

    +
    +
    +

    6.2.2. Literals

    +

    Python supports string and bytes literals and various numeric literals:

    +
    +literal ::=  stringliteral | bytesliteral
    +             | integer | floatnumber | imagnumber
    +
    +

    Evaluation of a literal yields an object of the given type (string, bytes, +integer, floating point number, complex number) with the given value. The value +may be approximated in the case of floating point and imaginary (complex) +literals. See section Literals for details.

    +

    All literals correspond to immutable data types, and hence the object’s identity +is less important than its value. Multiple evaluations of literals with the +same value (either the same occurrence in the program text or a different +occurrence) may obtain the same object or a different object with the same +value.

    +
    +
    +

    6.2.3. Parenthesized forms

    +

    A parenthesized form is an optional expression list enclosed in parentheses:

    +
    +parenth_form ::=  "(" [starred_expression] ")"
    +
    +

    A parenthesized expression list yields whatever that expression list yields: if +the list contains at least one comma, it yields a tuple; otherwise, it yields +the single expression that makes up the expression list.

    +

    An empty pair of parentheses yields an empty tuple object. Since tuples are +immutable, the same rules as for literals apply (i.e., two occurrences of the empty +tuple may or may not yield the same object).

    +

    Note that tuples are not formed by the parentheses, but rather by use of the +comma operator. The exception is the empty tuple, for which parentheses are +required — allowing unparenthesized “nothing” in expressions would cause +ambiguities and allow common typos to pass uncaught.

    +
    +
    +

    6.2.4. Displays for lists, sets and dictionaries

    +

    For constructing a list, a set or a dictionary Python provides special syntax +called “displays”, each of them in two flavors:

    +
      +
    • either the container contents are listed explicitly, or

    • +
    • they are computed via a set of looping and filtering instructions, called a +comprehension.

    • +
    +

    Common syntax elements for comprehensions are:

    +
    +comprehension ::=  expression comp_for
    +comp_for      ::=  ["async"] "for" target_list "in" or_test [comp_iter]
    +comp_iter     ::=  comp_for | comp_if
    +comp_if       ::=  "if" expression_nocond [comp_iter]
    +
    +

    The comprehension consists of a single expression followed by at least one +for clause and zero or more for or if clauses. +In this case, the elements of the new container are those that would be produced +by considering each of the for or if clauses a block, +nesting from left to right, and evaluating the expression to produce an element +each time the innermost block is reached.

    +

    However, aside from the iterable expression in the leftmost for clause, +the comprehension is executed in a separate implicitly nested scope. This ensures +that names assigned to in the target list don’t “leak” into the enclosing scope.

    +

    The iterable expression in the leftmost for clause is evaluated +directly in the enclosing scope and then passed as an argument to the implictly +nested scope. Subsequent for clauses and any filter condition in the +leftmost for clause cannot be evaluated in the enclosing scope as +they may depend on the values obtained from the leftmost iterable. For example: +[x*y for x in range(10) for y in range(x, x+10)].

    +

    To ensure the comprehension always results in a container of the appropriate +type, yield and yield from expressions are prohibited in the implicitly +nested scope (in Python 3.7, such expressions emit DeprecationWarning +when compiled, in Python 3.8+ they will emit SyntaxError).

    +

    Since Python 3.6, in an async def function, an async for +clause may be used to iterate over a asynchronous iterator. +A comprehension in an async def function may consist of either a +for or async for clause following the leading +expression, may contain additional for or async for +clauses, and may also use await expressions. +If a comprehension contains either async for clauses +or await expressions it is called an +asynchronous comprehension. An asynchronous comprehension may +suspend the execution of the coroutine function in which it appears. +See also PEP 530.

    +
    +

    New in version 3.6: Asynchronous comprehensions were introduced.

    +
    +
    +

    Deprecated since version 3.7: yield and yield from deprecated in the implicitly nested scope.

    +
    +
    +
    +

    6.2.5. List displays

    +

    A list display is a possibly empty series of expressions enclosed in square +brackets:

    +
    +list_display ::=  "[" [starred_list | comprehension] "]"
    +
    +

    A list display yields a new list object, the contents being specified by either +a list of expressions or a comprehension. When a comma-separated list of +expressions is supplied, its elements are evaluated from left to right and +placed into the list object in that order. When a comprehension is supplied, +the list is constructed from the elements resulting from the comprehension.

    +
    +
    +

    6.2.6. Set displays

    +

    A set display is denoted by curly braces and distinguishable from dictionary +displays by the lack of colons separating keys and values:

    +
    +set_display ::=  "{" (starred_list | comprehension) "}"
    +
    +

    A set display yields a new mutable set object, the contents being specified by +either a sequence of expressions or a comprehension. When a comma-separated +list of expressions is supplied, its elements are evaluated from left to right +and added to the set object. When a comprehension is supplied, the set is +constructed from the elements resulting from the comprehension.

    +

    An empty set cannot be constructed with {}; this literal constructs an empty +dictionary.

    +
    +
    +

    6.2.7. Dictionary displays

    +

    A dictionary display is a possibly empty series of key/datum pairs enclosed in +curly braces:

    +
    +dict_display       ::=  "{" [key_datum_list | dict_comprehension] "}"
    +key_datum_list     ::=  key_datum ("," key_datum)* [","]
    +key_datum          ::=  expression ":" expression | "**" or_expr
    +dict_comprehension ::=  expression ":" expression comp_for
    +
    +

    A dictionary display yields a new dictionary object.

    +

    If a comma-separated sequence of key/datum pairs is given, they are evaluated +from left to right to define the entries of the dictionary: each key object is +used as a key into the dictionary to store the corresponding datum. This means +that you can specify the same key multiple times in the key/datum list, and the +final dictionary’s value for that key will be the last one given.

    +

    A double asterisk ** denotes dictionary unpacking. +Its operand must be a mapping. Each mapping item is added +to the new dictionary. Later values replace values already set by +earlier key/datum pairs and earlier dictionary unpackings.

    +
    +

    New in version 3.5: Unpacking into dictionary displays, originally proposed by PEP 448.

    +
    +

    A dict comprehension, in contrast to list and set comprehensions, needs two +expressions separated with a colon followed by the usual “for” and “if” clauses. +When the comprehension is run, the resulting key and value elements are inserted +in the new dictionary in the order they are produced.

    +

    Restrictions on the types of the key values are listed earlier in section +The standard type hierarchy. (To summarize, the key type should be hashable, which excludes +all mutable objects.) Clashes between duplicate keys are not detected; the last +datum (textually rightmost in the display) stored for a given key value +prevails.

    +
    +
    +

    6.2.8. Generator expressions

    +

    A generator expression is a compact generator notation in parentheses:

    +
    +generator_expression ::=  "(" expression comp_for ")"
    +
    +

    A generator expression yields a new generator object. Its syntax is the same as +for comprehensions, except that it is enclosed in parentheses instead of +brackets or curly braces.

    +

    Variables used in the generator expression are evaluated lazily when the +__next__() method is called for the generator object (in the same +fashion as normal generators). However, the iterable expression in the +leftmost for clause is immediately evaluated, so that an error +produced by it will be emitted at the point where the generator expression +is defined, rather than at the point where the first value is retrieved. +Subsequent for clauses and any filter condition in the leftmost +for clause cannot be evaluated in the enclosing scope as they may +depend on the values obtained from the leftmost iterable. For example: +(x*y for x in range(10) for y in range(x, x+10)).

    +

    The parentheses can be omitted on calls with only one argument. See section +Calls for details.

    +

    To avoid interfering with the expected operation of the generator expression +itself, yield and yield from expressions are prohibited in the +implicitly defined generator (in Python 3.7, such expressions emit +DeprecationWarning when compiled, in Python 3.8+ they will emit +SyntaxError).

    +

    If a generator expression contains either async for +clauses or await expressions it is called an +asynchronous generator expression. An asynchronous generator +expression returns a new asynchronous generator object, +which is an asynchronous iterator (see Asynchronous Iterators).

    +
    +

    New in version 3.6: Asynchronous generator expressions were introduced.

    +
    +
    +

    Changed in version 3.7: Prior to Python 3.7, asynchronous generator expressions could +only appear in async def coroutines. Starting +with 3.7, any function can use asynchronous generator expressions.

    +
    +
    +

    Deprecated since version 3.7: yield and yield from deprecated in the implicitly nested scope.

    +
    +
    +
    +

    6.2.9. Yield expressions

    +
    +yield_atom       ::=  "(" yield_expression ")"
    +yield_expression ::=  "yield" [expression_list | "from" expression]
    +
    +

    The yield expression is used when defining a generator function +or an asynchronous generator function and +thus can only be used in the body of a function definition. Using a yield +expression in a function’s body causes that function to be a generator, +and using it in an async def function’s body causes that +coroutine function to be an asynchronous generator. For example:

    +
    def gen():  # defines a generator function
    +    yield 123
    +
    +async def agen(): # defines an asynchronous generator function
    +    yield 123
    +
    +
    +

    Due to their side effects on the containing scope, yield expressions +are not permitted as part of the implicitly defined scopes used to +implement comprehensions and generator expressions (in Python 3.7, such +expressions emit DeprecationWarning when compiled, in Python 3.8+ +they will emit SyntaxError)..

    +
    +

    Deprecated since version 3.7: Yield expressions deprecated in the implicitly nested scopes used to +implement comprehensions and generator expressions.

    +
    +

    Generator functions are described below, while asynchronous generator +functions are described separately in section +Asynchronous generator functions.

    +

    When a generator function is called, it returns an iterator known as a +generator. That generator then controls the execution of the generator function. +The execution starts when one of the generator’s methods is called. At that +time, the execution proceeds to the first yield expression, where it is +suspended again, returning the value of expression_list to the generator’s +caller. By suspended, we mean that all local state is retained, including the +current bindings of local variables, the instruction pointer, the internal +evaluation stack, and the state of any exception handling. When the execution +is resumed by calling one of the +generator’s methods, the function can proceed exactly as if the yield expression +were just another external call. The value of the yield expression after +resuming depends on the method which resumed the execution. If +__next__() is used (typically via either a for or +the next() builtin) then the result is None. Otherwise, if +send() is used, then the result will be the value passed in to +that method.

    +

    All of this makes generator functions quite similar to coroutines; they yield +multiple times, they have more than one entry point and their execution can be +suspended. The only difference is that a generator function cannot control +where the execution should continue after it yields; the control is always +transferred to the generator’s caller.

    +

    Yield expressions are allowed anywhere in a try construct. If the +generator is not resumed before it is +finalized (by reaching a zero reference count or by being garbage collected), +the generator-iterator’s close() method will be called, +allowing any pending finally clauses to execute.

    +

    When yield from <expr> is used, it treats the supplied expression as +a subiterator. All values produced by that subiterator are passed directly +to the caller of the current generator’s methods. Any values passed in with +send() and any exceptions passed in with +throw() are passed to the underlying iterator if it has the +appropriate methods. If this is not the case, then send() +will raise AttributeError or TypeError, while +throw() will just raise the passed in exception immediately.

    +

    When the underlying iterator is complete, the value +attribute of the raised StopIteration instance becomes the value of +the yield expression. It can be either set explicitly when raising +StopIteration, or automatically when the subiterator is a generator +(by returning a value from the subgenerator).

    +
    +
    +

    Changed in version 3.3: Added yield from <expr> to delegate control flow to a subiterator.

    +
    +
    +

    The parentheses may be omitted when the yield expression is the sole expression +on the right hand side of an assignment statement.

    +
    +

    See also

    +
    +
    PEP 255 - Simple Generators

    The proposal for adding generators and the yield statement to Python.

    +
    +
    PEP 342 - Coroutines via Enhanced Generators

    The proposal to enhance the API and syntax of generators, making them +usable as simple coroutines.

    +
    +
    PEP 380 - Syntax for Delegating to a Subgenerator

    The proposal to introduce the yield_from syntax, making delegation +to subgenerators easy.

    +
    +
    PEP 525 - Asynchronous Generators

    The proposal that expanded on PEP 492 by adding generator capabilities to +coroutine functions.

    +
    +
    +
    +
    +

    6.2.9.1. Generator-iterator methods

    +

    This subsection describes the methods of a generator iterator. They can +be used to control the execution of a generator function.

    +

    Note that calling any of the generator methods below when the generator +is already executing raises a ValueError exception.

    +
    +
    +generator.__next__()
    +

    Starts the execution of a generator function or resumes it at the last +executed yield expression. When a generator function is resumed with a +__next__() method, the current yield expression always +evaluates to None. The execution then continues to the next yield +expression, where the generator is suspended again, and the value of the +expression_list is returned to __next__()’s caller. If the +generator exits without yielding another value, a StopIteration +exception is raised.

    +

    This method is normally called implicitly, e.g. by a for loop, or +by the built-in next() function.

    +
    + +
    +
    +generator.send(value)
    +

    Resumes the execution and “sends” a value into the generator function. The +value argument becomes the result of the current yield expression. The +send() method returns the next value yielded by the generator, or +raises StopIteration if the generator exits without yielding another +value. When send() is called to start the generator, it must be called +with None as the argument, because there is no yield expression that +could receive the value.

    +
    + +
    +
    +generator.throw(type[, value[, traceback]])
    +

    Raises an exception of type type at the point where the generator was paused, +and returns the next value yielded by the generator function. If the generator +exits without yielding another value, a StopIteration exception is +raised. If the generator function does not catch the passed-in exception, or +raises a different exception, then that exception propagates to the caller.

    +
    + +
    +
    +generator.close()
    +

    Raises a GeneratorExit at the point where the generator function was +paused. If the generator function then exits gracefully, is already closed, +or raises GeneratorExit (by not catching the exception), close +returns to its caller. If the generator yields a value, a +RuntimeError is raised. If the generator raises any other exception, +it is propagated to the caller. close() does nothing if the generator +has already exited due to an exception or normal exit.

    +
    + +
    +
    +

    6.2.9.2. Examples

    +

    Here is a simple example that demonstrates the behavior of generators and +generator functions:

    +
    >>> def echo(value=None):
    +...     print("Execution starts when 'next()' is called for the first time.")
    +...     try:
    +...         while True:
    +...             try:
    +...                 value = (yield value)
    +...             except Exception as e:
    +...                 value = e
    +...     finally:
    +...         print("Don't forget to clean up when 'close()' is called.")
    +...
    +>>> generator = echo(1)
    +>>> print(next(generator))
    +Execution starts when 'next()' is called for the first time.
    +1
    +>>> print(next(generator))
    +None
    +>>> print(generator.send(2))
    +2
    +>>> generator.throw(TypeError, "spam")
    +TypeError('spam',)
    +>>> generator.close()
    +Don't forget to clean up when 'close()' is called.
    +
    +
    +

    For examples using yield from, see PEP 380: Syntax for Delegating to a Subgenerator in “What’s New in +Python.”

    +
    +
    +

    6.2.9.3. Asynchronous generator functions

    +

    The presence of a yield expression in a function or method defined using +async def further defines the function as an +asynchronous generator function.

    +

    When an asynchronous generator function is called, it returns an +asynchronous iterator known as an asynchronous generator object. +That object then controls the execution of the generator function. +An asynchronous generator object is typically used in an +async for statement in a coroutine function analogously to +how a generator object would be used in a for statement.

    +

    Calling one of the asynchronous generator’s methods returns an +awaitable object, and the execution starts when this object +is awaited on. At that time, the execution proceeds to the first yield +expression, where it is suspended again, returning the value of +expression_list to the awaiting coroutine. As with a generator, +suspension means that all local state is retained, including the +current bindings of local variables, the instruction pointer, the internal +evaluation stack, and the state of any exception handling. When the execution +is resumed by awaiting on the next object returned by the asynchronous +generator’s methods, the function can proceed exactly as if the yield +expression were just another external call. The value of the yield expression +after resuming depends on the method which resumed the execution. If +__anext__() is used then the result is None. Otherwise, if +asend() is used, then the result will be the value passed in to +that method.

    +

    In an asynchronous generator function, yield expressions are allowed anywhere +in a try construct. However, if an asynchronous generator is not +resumed before it is finalized (by reaching a zero reference count or by +being garbage collected), then a yield expression within a try +construct could result in a failure to execute pending finally +clauses. In this case, it is the responsibility of the event loop or +scheduler running the asynchronous generator to call the asynchronous +generator-iterator’s aclose() method and run the resulting +coroutine object, thus allowing any pending finally clauses +to execute.

    +

    To take care of finalization, an event loop should define +a finalizer function which takes an asynchronous generator-iterator +and presumably calls aclose() and executes the coroutine. +This finalizer may be registered by calling sys.set_asyncgen_hooks(). +When first iterated over, an asynchronous generator-iterator will store the +registered finalizer to be called upon finalization. For a reference example +of a finalizer method see the implementation of +asyncio.Loop.shutdown_asyncgens in Lib/asyncio/base_events.py.

    +

    The expression yield from <expr> is a syntax error when used in an +asynchronous generator function.

    +
    +
    +

    6.2.9.4. Asynchronous generator-iterator methods

    +

    This subsection describes the methods of an asynchronous generator iterator, +which are used to control the execution of a generator function.

    +
    +
    +coroutine agen.__anext__()
    +

    Returns an awaitable which when run starts to execute the asynchronous +generator or resumes it at the last executed yield expression. When an +asynchronous generator function is resumed with an __anext__() +method, the current yield expression always evaluates to None in +the returned awaitable, which when run will continue to the next yield +expression. The value of the expression_list of the yield +expression is the value of the StopIteration exception raised by +the completing coroutine. If the asynchronous generator exits without +yielding another value, the awaitable instead raises a +StopAsyncIteration exception, signalling that the asynchronous +iteration has completed.

    +

    This method is normally called implicitly by a async for loop.

    +
    + +
    +
    +coroutine agen.asend(value)
    +

    Returns an awaitable which when run resumes the execution of the +asynchronous generator. As with the send() method for a +generator, this “sends” a value into the asynchronous generator function, +and the value argument becomes the result of the current yield expression. +The awaitable returned by the asend() method will return the next +value yielded by the generator as the value of the raised +StopIteration, or raises StopAsyncIteration if the +asynchronous generator exits without yielding another value. When +asend() is called to start the asynchronous +generator, it must be called with None as the argument, +because there is no yield expression that could receive the value.

    +
    + +
    +
    +coroutine agen.athrow(type[, value[, traceback]])
    +

    Returns an awaitable that raises an exception of type type at the point +where the asynchronous generator was paused, and returns the next value +yielded by the generator function as the value of the raised +StopIteration exception. If the asynchronous generator exits +without yielding another value, a StopAsyncIteration exception is +raised by the awaitable. +If the generator function does not catch the passed-in exception, or +raises a different exception, then when the awaitable is run that exception +propagates to the caller of the awaitable.

    +
    + +
    +
    +coroutine agen.aclose()
    +

    Returns an awaitable that when run will throw a GeneratorExit into +the asynchronous generator function at the point where it was paused. +If the asynchronous generator function then exits gracefully, is already +closed, or raises GeneratorExit (by not catching the exception), +then the returned awaitable will raise a StopIteration exception. +Any further awaitables returned by subsequent calls to the asynchronous +generator will raise a StopAsyncIteration exception. If the +asynchronous generator yields a value, a RuntimeError is raised +by the awaitable. If the asynchronous generator raises any other exception, +it is propagated to the caller of the awaitable. If the asynchronous +generator has already exited due to an exception or normal exit, then +further calls to aclose() will return an awaitable that does nothing.

    +
    + +
    +
    +
    +
    +

    6.3. Primaries

    +

    Primaries represent the most tightly bound operations of the language. Their +syntax is:

    +
    +primary ::=  atom | attributeref | subscription | slicing | call
    +
    +
    +

    6.3.1. Attribute references

    +

    An attribute reference is a primary followed by a period and a name:

    +
    +attributeref ::=  primary "." identifier
    +
    +

    The primary must evaluate to an object of a type that supports attribute +references, which most objects do. This object is then asked to produce the +attribute whose name is the identifier. This production can be customized by +overriding the __getattr__() method. If this attribute is not available, +the exception AttributeError is raised. Otherwise, the type and value of +the object produced is determined by the object. Multiple evaluations of the +same attribute reference may yield different objects.

    +
    +
    +

    6.3.2. Subscriptions

    +

    A subscription selects an item of a sequence (string, tuple or list) or mapping +(dictionary) object:

    +
    +subscription ::=  primary "[" expression_list "]"
    +
    +

    The primary must evaluate to an object that supports subscription (lists or +dictionaries for example). User-defined objects can support subscription by +defining a __getitem__() method.

    +

    For built-in objects, there are two types of objects that support subscription:

    +

    If the primary is a mapping, the expression list must evaluate to an object +whose value is one of the keys of the mapping, and the subscription selects the +value in the mapping that corresponds to that key. (The expression list is a +tuple except if it has exactly one item.)

    +

    If the primary is a sequence, the expression list must evaluate to an integer +or a slice (as discussed in the following section).

    +

    The formal syntax makes no special provision for negative indices in +sequences; however, built-in sequences all provide a __getitem__() +method that interprets negative indices by adding the length of the sequence +to the index (so that x[-1] selects the last item of x). The +resulting value must be a nonnegative integer less than the number of items in +the sequence, and the subscription selects the item whose index is that value +(counting from zero). Since the support for negative indices and slicing +occurs in the object’s __getitem__() method, subclasses overriding +this method will need to explicitly add that support.

    +

    A string’s items are characters. A character is not a separate data type but a +string of exactly one character.

    +
    +
    +

    6.3.3. Slicings

    +

    A slicing selects a range of items in a sequence object (e.g., a string, tuple +or list). Slicings may be used as expressions or as targets in assignment or +del statements. The syntax for a slicing:

    +
    +slicing      ::=  primary "[" slice_list "]"
    +slice_list   ::=  slice_item ("," slice_item)* [","]
    +slice_item   ::=  expression | proper_slice
    +proper_slice ::=  [lower_bound] ":" [upper_bound] [ ":" [stride] ]
    +lower_bound  ::=  expression
    +upper_bound  ::=  expression
    +stride       ::=  expression
    +
    +

    There is ambiguity in the formal syntax here: anything that looks like an +expression list also looks like a slice list, so any subscription can be +interpreted as a slicing. Rather than further complicating the syntax, this is +disambiguated by defining that in this case the interpretation as a subscription +takes priority over the interpretation as a slicing (this is the case if the +slice list contains no proper slice).

    +

    The semantics for a slicing are as follows. The primary is indexed (using the +same __getitem__() method as +normal subscription) with a key that is constructed from the slice list, as +follows. If the slice list contains at least one comma, the key is a tuple +containing the conversion of the slice items; otherwise, the conversion of the +lone slice item is the key. The conversion of a slice item that is an +expression is that expression. The conversion of a proper slice is a slice +object (see section The standard type hierarchy) whose start, +stop and step attributes are the values of the +expressions given as lower bound, upper bound and stride, respectively, +substituting None for missing expressions.

    +
    +
    +

    6.3.4. Calls

    +

    A call calls a callable object (e.g., a function) with a possibly empty +series of arguments:

    +
    +call                 ::=  primary "(" [argument_list [","] | comprehension] ")"
    +argument_list        ::=  positional_arguments ["," starred_and_keywords]
    +                            ["," keywords_arguments]
    +                          | starred_and_keywords ["," keywords_arguments]
    +                          | keywords_arguments
    +positional_arguments ::=  ["*"] expression ("," ["*"] expression)*
    +starred_and_keywords ::=  ("*" expression | keyword_item)
    +                          ("," "*" expression | "," keyword_item)*
    +keywords_arguments   ::=  (keyword_item | "**" expression)
    +                          ("," keyword_item | "," "**" expression)*
    +keyword_item         ::=  identifier "=" expression
    +
    +

    An optional trailing comma may be present after the positional and keyword arguments +but does not affect the semantics.

    +

    The primary must evaluate to a callable object (user-defined functions, built-in +functions, methods of built-in objects, class objects, methods of class +instances, and all objects having a __call__() method are callable). All +argument expressions are evaluated before the call is attempted. Please refer +to section Function definitions for the syntax of formal parameter lists.

    +

    If keyword arguments are present, they are first converted to positional +arguments, as follows. First, a list of unfilled slots is created for the +formal parameters. If there are N positional arguments, they are placed in the +first N slots. Next, for each keyword argument, the identifier is used to +determine the corresponding slot (if the identifier is the same as the first +formal parameter name, the first slot is used, and so on). If the slot is +already filled, a TypeError exception is raised. Otherwise, the value of +the argument is placed in the slot, filling it (even if the expression is +None, it fills the slot). When all arguments have been processed, the slots +that are still unfilled are filled with the corresponding default value from the +function definition. (Default values are calculated, once, when the function is +defined; thus, a mutable object such as a list or dictionary used as default +value will be shared by all calls that don’t specify an argument value for the +corresponding slot; this should usually be avoided.) If there are any unfilled +slots for which no default value is specified, a TypeError exception is +raised. Otherwise, the list of filled slots is used as the argument list for +the call.

    +
    +

    CPython implementation detail: An implementation may provide built-in functions whose positional parameters +do not have names, even if they are ‘named’ for the purpose of documentation, +and which therefore cannot be supplied by keyword. In CPython, this is the +case for functions implemented in C that use PyArg_ParseTuple() to +parse their arguments.

    +
    +

    If there are more positional arguments than there are formal parameter slots, a +TypeError exception is raised, unless a formal parameter using the syntax +*identifier is present; in this case, that formal parameter receives a tuple +containing the excess positional arguments (or an empty tuple if there were no +excess positional arguments).

    +

    If any keyword argument does not correspond to a formal parameter name, a +TypeError exception is raised, unless a formal parameter using the syntax +**identifier is present; in this case, that formal parameter receives a +dictionary containing the excess keyword arguments (using the keywords as keys +and the argument values as corresponding values), or a (new) empty dictionary if +there were no excess keyword arguments.

    +

    If the syntax *expression appears in the function call, expression must +evaluate to an iterable. Elements from these iterables are +treated as if they were additional positional arguments. For the call +f(x1, x2, *y, x3, x4), if y evaluates to a sequence y1, …, yM, +this is equivalent to a call with M+4 positional arguments x1, x2, +y1, …, yM, x3, x4.

    +

    A consequence of this is that although the *expression syntax may appear +after explicit keyword arguments, it is processed before the +keyword arguments (and any **expression arguments – see below). So:

    +
    >>> def f(a, b):
    +...     print(a, b)
    +...
    +>>> f(b=1, *(2,))
    +2 1
    +>>> f(a=1, *(2,))
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +TypeError: f() got multiple values for keyword argument 'a'
    +>>> f(1, *(2,))
    +1 2
    +
    +
    +

    It is unusual for both keyword arguments and the *expression syntax to be +used in the same call, so in practice this confusion does not arise.

    +

    If the syntax **expression appears in the function call, expression must +evaluate to a mapping, the contents of which are treated as +additional keyword arguments. If a keyword is already present +(as an explicit keyword argument, or from another unpacking), +a TypeError exception is raised.

    +

    Formal parameters using the syntax *identifier or **identifier cannot be +used as positional argument slots or as keyword argument names.

    +
    +

    Changed in version 3.5: Function calls accept any number of * and ** unpackings, +positional arguments may follow iterable unpackings (*), +and keyword arguments may follow dictionary unpackings (**). +Originally proposed by PEP 448.

    +
    +

    A call always returns some value, possibly None, unless it raises an +exception. How this value is computed depends on the type of the callable +object.

    +

    If it is—

    +
    +
    a user-defined function:

    The code block for the function is executed, passing it the argument list. The +first thing the code block will do is bind the formal parameters to the +arguments; this is described in section Function definitions. When the code block +executes a return statement, this specifies the return value of the +function call.

    +
    +
    a built-in function or method:

    The result is up to the interpreter; see Built-in Functions for the +descriptions of built-in functions and methods.

    +
    +
    a class object:

    A new instance of that class is returned.

    +
    +
    a class instance method:

    The corresponding user-defined function is called, with an argument list that is +one longer than the argument list of the call: the instance becomes the first +argument.

    +
    +
    a class instance:

    The class must define a __call__() method; the effect is then the same as +if that method was called.

    +
    +
    +
    +
    +
    +

    6.4. Await expression

    +

    Suspend the execution of coroutine on an awaitable object. +Can only be used inside a coroutine function.

    +
    +await_expr ::=  "await" primary
    +
    +
    +

    New in version 3.5.

    +
    +
    +
    +

    6.5. The power operator

    +

    The power operator binds more tightly than unary operators on its left; it binds +less tightly than unary operators on its right. The syntax is:

    +
    +power ::=  (await_expr | primary) ["**" u_expr]
    +
    +

    Thus, in an unparenthesized sequence of power and unary operators, the operators +are evaluated from right to left (this does not constrain the evaluation order +for the operands): -1**2 results in -1.

    +

    The power operator has the same semantics as the built-in pow() function, +when called with two arguments: it yields its left argument raised to the power +of its right argument. The numeric arguments are first converted to a common +type, and the result is of that type.

    +

    For int operands, the result has the same type as the operands unless the second +argument is negative; in that case, all arguments are converted to float and a +float result is delivered. For example, 10**2 returns 100, but +10**-2 returns 0.01.

    +

    Raising 0.0 to a negative power results in a ZeroDivisionError. +Raising a negative number to a fractional power results in a complex +number. (In earlier versions it raised a ValueError.)

    +
    +
    +

    6.6. Unary arithmetic and bitwise operations

    +

    All unary arithmetic and bitwise operations have the same priority:

    +
    +u_expr ::=  power | "-" u_expr | "+" u_expr | "~" u_expr
    +
    +

    The unary - (minus) operator yields the negation of its numeric argument.

    +

    The unary + (plus) operator yields its numeric argument unchanged.

    +

    The unary ~ (invert) operator yields the bitwise inversion of its integer +argument. The bitwise inversion of x is defined as -(x+1). It only +applies to integral numbers.

    +

    In all three cases, if the argument does not have the proper type, a +TypeError exception is raised.

    +
    +
    +

    6.7. Binary arithmetic operations

    +

    The binary arithmetic operations have the conventional priority levels. Note +that some of these operations also apply to certain non-numeric types. Apart +from the power operator, there are only two levels, one for multiplicative +operators and one for additive operators:

    +
    +m_expr ::=  u_expr | m_expr "*" u_expr | m_expr "@" m_expr |
    +            m_expr "//" u_expr | m_expr "/" u_expr |
    +            m_expr "%" u_expr
    +a_expr ::=  m_expr | a_expr "+" m_expr | a_expr "-" m_expr
    +
    +

    The * (multiplication) operator yields the product of its arguments. The +arguments must either both be numbers, or one argument must be an integer and +the other must be a sequence. In the former case, the numbers are converted to a +common type and then multiplied together. In the latter case, sequence +repetition is performed; a negative repetition factor yields an empty sequence.

    +

    The @ (at) operator is intended to be used for matrix multiplication. No +builtin Python types implement this operator.

    +
    +

    New in version 3.5.

    +
    +

    The / (division) and // (floor division) operators yield the quotient of +their arguments. The numeric arguments are first converted to a common type. +Division of integers yields a float, while floor division of integers results in an +integer; the result is that of mathematical division with the ‘floor’ function +applied to the result. Division by zero raises the ZeroDivisionError +exception.

    +

    The % (modulo) operator yields the remainder from the division of the first +argument by the second. The numeric arguments are first converted to a common +type. A zero right argument raises the ZeroDivisionError exception. The +arguments may be floating point numbers, e.g., 3.14%0.7 equals 0.34 +(since 3.14 equals 4*0.7 + 0.34.) The modulo operator always yields a +result with the same sign as its second operand (or zero); the absolute value of +the result is strictly smaller than the absolute value of the second operand +1.

    +

    The floor division and modulo operators are connected by the following +identity: x == (x//y)*y + (x%y). Floor division and modulo are also +connected with the built-in function divmod(): divmod(x, y) == (x//y, +x%y). 2.

    +

    In addition to performing the modulo operation on numbers, the % operator is +also overloaded by string objects to perform old-style string formatting (also +known as interpolation). The syntax for string formatting is described in the +Python Library Reference, section printf-style String Formatting.

    +

    The floor division operator, the modulo operator, and the divmod() +function are not defined for complex numbers. Instead, convert to a floating +point number using the abs() function if appropriate.

    +

    The + (addition) operator yields the sum of its arguments. The arguments +must either both be numbers or both be sequences of the same type. In the +former case, the numbers are converted to a common type and then added together. +In the latter case, the sequences are concatenated.

    +

    The - (subtraction) operator yields the difference of its arguments. The +numeric arguments are first converted to a common type.

    +
    +
    +

    6.8. Shifting operations

    +

    The shifting operations have lower priority than the arithmetic operations:

    +
    +shift_expr ::=  a_expr | shift_expr ("<<" | ">>") a_expr
    +
    +

    These operators accept integers as arguments. They shift the first argument to +the left or right by the number of bits given by the second argument.

    +

    A right shift by n bits is defined as floor division by pow(2,n). A left +shift by n bits is defined as multiplication with pow(2,n).

    +
    +
    +

    6.9. Binary bitwise operations

    +

    Each of the three bitwise operations has a different priority level:

    +
    +and_expr ::=  shift_expr | and_expr "&" shift_expr
    +xor_expr ::=  and_expr | xor_expr "^" and_expr
    +or_expr  ::=  xor_expr | or_expr "|" xor_expr
    +
    +

    The & operator yields the bitwise AND of its arguments, which must be +integers.

    +

    The ^ operator yields the bitwise XOR (exclusive OR) of its arguments, which +must be integers.

    +

    The | operator yields the bitwise (inclusive) OR of its arguments, which +must be integers.

    +
    +
    +

    6.10. Comparisons

    +

    Unlike C, all comparison operations in Python have the same priority, which is +lower than that of any arithmetic, shifting or bitwise operation. Also unlike +C, expressions like a < b < c have the interpretation that is conventional +in mathematics:

    +
    +comparison    ::=  or_expr (comp_operator or_expr)*
    +comp_operator ::=  "<" | ">" | "==" | ">=" | "<=" | "!="
    +                   | "is" ["not"] | ["not"] "in"
    +
    +

    Comparisons yield boolean values: True or False.

    +

    Comparisons can be chained arbitrarily, e.g., x < y <= z is equivalent to +x < y and y <= z, except that y is evaluated only once (but in both +cases z is not evaluated at all when x < y is found to be false).

    +

    Formally, if a, b, c, …, y, z are expressions and op1, op2, …, +opN are comparison operators, then a op1 b op2 c ... y opN z is equivalent +to a op1 b and b op2 c and ... y opN z, except that each expression is +evaluated at most once.

    +

    Note that a op1 b op2 c doesn’t imply any kind of comparison between a and +c, so that, e.g., x < y > z is perfectly legal (though perhaps not +pretty).

    +
    +

    6.10.1. Value comparisons

    +

    The operators <, >, ==, >=, <=, and != compare the +values of two objects. The objects do not need to have the same type.

    +

    Chapter Objects, values and types states that objects have a value (in addition to type +and identity). The value of an object is a rather abstract notion in Python: +For example, there is no canonical access method for an object’s value. Also, +there is no requirement that the value of an object should be constructed in a +particular way, e.g. comprised of all its data attributes. Comparison operators +implement a particular notion of what the value of an object is. One can think +of them as defining the value of an object indirectly, by means of their +comparison implementation.

    +

    Because all types are (direct or indirect) subtypes of object, they +inherit the default comparison behavior from object. Types can +customize their comparison behavior by implementing +rich comparison methods like __lt__(), described in +Basic customization.

    +

    The default behavior for equality comparison (== and !=) is based on +the identity of the objects. Hence, equality comparison of instances with the +same identity results in equality, and equality comparison of instances with +different identities results in inequality. A motivation for this default +behavior is the desire that all objects should be reflexive (i.e. x is y +implies x == y).

    +

    A default order comparison (<, >, <=, and >=) is not provided; +an attempt raises TypeError. A motivation for this default behavior is +the lack of a similar invariant as for equality.

    +

    The behavior of the default equality comparison, that instances with different +identities are always unequal, may be in contrast to what types will need that +have a sensible definition of object value and value-based equality. Such +types will need to customize their comparison behavior, and in fact, a number +of built-in types have done that.

    +

    The following list describes the comparison behavior of the most important +built-in types.

    +
      +
    • Numbers of built-in numeric types (Numeric Types — int, float, complex) and of the standard +library types fractions.Fraction and decimal.Decimal can be +compared within and across their types, with the restriction that complex +numbers do not support order comparison. Within the limits of the types +involved, they compare mathematically (algorithmically) correct without loss +of precision.

      +

      The not-a-number values float('NaN') and decimal.Decimal('NaN') are +special. Any ordered comparison of a number to a not-a-number value is false. +A counter-intuitive implication is that not-a-number values are not equal to +themselves. For example, if x = float('NaN'), 3 < x, x < 3, x +== x, x != x are all false. This behavior is compliant with IEEE 754.

      +
    • +
    • Binary sequences (instances of bytes or bytearray) can be +compared within and across their types. They compare lexicographically using +the numeric values of their elements.

    • +
    • Strings (instances of str) compare lexicographically using the +numerical Unicode code points (the result of the built-in function +ord()) of their characters. 3

      +

      Strings and binary sequences cannot be directly compared.

      +
    • +
    • Sequences (instances of tuple, list, or range) can +be compared only within each of their types, with the restriction that ranges +do not support order comparison. Equality comparison across these types +results in inequality, and ordering comparison across these types raises +TypeError.

      +

      Sequences compare lexicographically using comparison of corresponding +elements, whereby reflexivity of the elements is enforced.

      +

      In enforcing reflexivity of elements, the comparison of collections assumes +that for a collection element x, x == x is always true. Based on +that assumption, element identity is compared first, and element comparison +is performed only for distinct elements. This approach yields the same +result as a strict element comparison would, if the compared elements are +reflexive. For non-reflexive elements, the result is different than for +strict element comparison, and may be surprising: The non-reflexive +not-a-number values for example result in the following comparison behavior +when used in a list:

      +
      >>> nan = float('NaN')
      +>>> nan is nan
      +True
      +>>> nan == nan
      +False                 <-- the defined non-reflexive behavior of NaN
      +>>> [nan] == [nan]
      +True                  <-- list enforces reflexivity and tests identity first
      +
      +
      +

      Lexicographical comparison between built-in collections works as follows:

      +
        +
      • For two collections to compare equal, they must be of the same type, have +the same length, and each pair of corresponding elements must compare +equal (for example, [1,2] == (1,2) is false because the type is not the +same).

      • +
      • Collections that support order comparison are ordered the same as their +first unequal elements (for example, [1,2,x] <= [1,2,y] has the same +value as x <= y). If a corresponding element does not exist, the +shorter collection is ordered first (for example, [1,2] < [1,2,3] is +true).

      • +
      +
    • +
    • Mappings (instances of dict) compare equal if and only if they have +equal (key, value) pairs. Equality comparison of the keys and values +enforces reflexivity.

      +

      Order comparisons (<, >, <=, and >=) raise TypeError.

      +
    • +
    • Sets (instances of set or frozenset) can be compared within +and across their types.

      +

      They define order +comparison operators to mean subset and superset tests. Those relations do +not define total orderings (for example, the two sets {1,2} and {2,3} +are not equal, nor subsets of one another, nor supersets of one +another). Accordingly, sets are not appropriate arguments for functions +which depend on total ordering (for example, min(), max(), and +sorted() produce undefined results given a list of sets as inputs).

      +

      Comparison of sets enforces reflexivity of its elements.

      +
    • +
    • Most other built-in types have no comparison methods implemented, so they +inherit the default comparison behavior.

    • +
    +

    User-defined classes that customize their comparison behavior should follow +some consistency rules, if possible:

    +
      +
    • Equality comparison should be reflexive. +In other words, identical objects should compare equal:

      +
      +

      x is y implies x == y

      +
      +
    • +
    • Comparison should be symmetric. +In other words, the following expressions should have the same result:

      +
      +

      x == y and y == x

      +

      x != y and y != x

      +

      x < y and y > x

      +

      x <= y and y >= x

      +
      +
    • +
    • Comparison should be transitive. +The following (non-exhaustive) examples illustrate that:

      +
      +

      x > y and y > z implies x > z

      +

      x < y and y <= z implies x < z

      +
      +
    • +
    • Inverse comparison should result in the boolean negation. +In other words, the following expressions should have the same result:

      +
      +

      x == y and not x != y

      +

      x < y and not x >= y (for total ordering)

      +

      x > y and not x <= y (for total ordering)

      +
      +

      The last two expressions apply to totally ordered collections (e.g. to +sequences, but not to sets or mappings). See also the +total_ordering() decorator.

      +
    • +
    • The hash() result should be consistent with equality. +Objects that are equal should either have the same hash value, +or be marked as unhashable.

    • +
    +

    Python does not enforce these consistency rules. In fact, the not-a-number +values are an example for not following these rules.

    +
    +
    +

    6.10.2. Membership test operations

    +

    The operators in and not in test for membership. x in +s evaluates to True if x is a member of s, and False otherwise. +x not in s returns the negation of x in s. All built-in sequences and +set types support this as well as dictionary, for which in tests +whether the dictionary has a given key. For container types such as list, tuple, +set, frozenset, dict, or collections.deque, the expression x in y is equivalent +to any(x is e or x == e for e in y).

    +

    For the string and bytes types, x in y is True if and only if x is a +substring of y. An equivalent test is y.find(x) != -1. Empty strings are +always considered to be a substring of any other string, so "" in "abc" will +return True.

    +

    For user-defined classes which define the __contains__() method, x in +y returns True if y.__contains__(x) returns a true value, and +False otherwise.

    +

    For user-defined classes which do not define __contains__() but do define +__iter__(), x in y is True if some value z, for which the +expression x is z or x == z is true, is produced while iterating over y. +If an exception is raised during the iteration, it is as if in raised +that exception.

    +

    Lastly, the old-style iteration protocol is tried: if a class defines +__getitem__(), x in y is True if and only if there is a non-negative +integer index i such that x is y[i] or x == y[i], and no lower integer index +raises the IndexError exception. (If any other exception is raised, it is as +if in raised that exception).

    +

    The operator not in is defined to have the inverse truth value of +in.

    +
    +
    +

    6.10.3. Identity comparisons

    +

    The operators is and is not test for an object’s identity: x +is y is true if and only if x and y are the same object. An Object’s identity +is determined using the id() function. x is not y yields the inverse +truth value. 4

    +
    +
    +
    +

    6.11. Boolean operations

    +
    +or_test  ::=  and_test | or_test "or" and_test
    +and_test ::=  not_test | and_test "and" not_test
    +not_test ::=  comparison | "not" not_test
    +
    +

    In the context of Boolean operations, and also when expressions are used by +control flow statements, the following values are interpreted as false: +False, None, numeric zero of all types, and empty strings and containers +(including strings, tuples, lists, dictionaries, sets and frozensets). All +other values are interpreted as true. User-defined objects can customize their +truth value by providing a __bool__() method.

    +

    The operator not yields True if its argument is false, False +otherwise.

    +

    The expression x and y first evaluates x; if x is false, its value is +returned; otherwise, y is evaluated and the resulting value is returned.

    +

    The expression x or y first evaluates x; if x is true, its value is +returned; otherwise, y is evaluated and the resulting value is returned.

    +

    Note that neither and nor or restrict the value and type +they return to False and True, but rather return the last evaluated +argument. This is sometimes useful, e.g., if s is a string that should be +replaced by a default value if it is empty, the expression s or 'foo' yields +the desired value. Because not has to create a new value, it +returns a boolean value regardless of the type of its argument +(for example, not 'foo' produces False rather than ''.)

    +
    +
    +

    6.12. Conditional expressions

    +
    +conditional_expression ::=  or_test ["if" or_test "else" expression]
    +expression             ::=  conditional_expression | lambda_expr
    +expression_nocond      ::=  or_test | lambda_expr_nocond
    +
    +

    Conditional expressions (sometimes called a “ternary operator”) have the lowest +priority of all Python operations.

    +

    The expression x if C else y first evaluates the condition, C rather than x. +If C is true, x is evaluated and its value is returned; otherwise, y is +evaluated and its value is returned.

    +

    See PEP 308 for more details about conditional expressions.

    +
    +
    +

    6.13. Lambdas

    +
    +lambda_expr        ::=  "lambda" [parameter_list] ":" expression
    +lambda_expr_nocond ::=  "lambda" [parameter_list] ":" expression_nocond
    +
    +

    Lambda expressions (sometimes called lambda forms) are used to create anonymous +functions. The expression lambda parameters: expression yields a function +object. The unnamed object behaves like a function object defined with:

    +
    def <lambda>(parameters):
    +    return expression
    +
    +
    +

    See section Function definitions for the syntax of parameter lists. Note that +functions created with lambda expressions cannot contain statements or +annotations.

    +
    +
    +

    6.14. Expression lists

    +
    +expression_list    ::=  expression ("," expression)* [","]
    +starred_list       ::=  starred_item ("," starred_item)* [","]
    +starred_expression ::=  expression | (starred_item ",")* [starred_item]
    +starred_item       ::=  expression | "*" or_expr
    +
    +

    Except when part of a list or set display, an expression list +containing at least one comma yields a tuple. The length of +the tuple is the number of expressions in the list. The expressions are +evaluated from left to right.

    +

    An asterisk * denotes iterable unpacking. Its operand must be +an iterable. The iterable is expanded into a sequence of items, +which are included in the new tuple, list, or set, at the site of +the unpacking.

    +
    +

    New in version 3.5: Iterable unpacking in expression lists, originally proposed by PEP 448.

    +
    +

    The trailing comma is required only to create a single tuple (a.k.a. a +singleton); it is optional in all other cases. A single expression without a +trailing comma doesn’t create a tuple, but rather yields the value of that +expression. (To create an empty tuple, use an empty pair of parentheses: +().)

    +
    +
    +

    6.15. Evaluation order

    +

    Python evaluates expressions from left to right. Notice that while evaluating +an assignment, the right-hand side is evaluated before the left-hand side.

    +

    In the following lines, expressions will be evaluated in the arithmetic order of +their suffixes:

    +
    expr1, expr2, expr3, expr4
    +(expr1, expr2, expr3, expr4)
    +{expr1: expr2, expr3: expr4}
    +expr1 + expr2 * (expr3 - expr4)
    +expr1(expr2, expr3, *expr4, **expr5)
    +expr3, expr4 = expr1, expr2
    +
    +
    +
    +
    +

    6.16. Operator precedence

    +

    The following table summarizes the operator precedence in Python, from lowest +precedence (least binding) to highest precedence (most binding). Operators in +the same box have the same precedence. Unless the syntax is explicitly given, +operators are binary. Operators in the same box group left to right (except for +exponentiation, which groups from right to left).

    +

    Note that comparisons, membership tests, and identity tests, all have the same +precedence and have a left-to-right chaining feature as described in the +Comparisons section.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Operator

    Description

    lambda

    Lambda expression

    ifelse

    Conditional expression

    or

    Boolean OR

    and

    Boolean AND

    not x

    Boolean NOT

    in, not in, +is, is not, <, +<=, >, >=, !=, ==

    Comparisons, including membership +tests and identity tests

    |

    Bitwise OR

    ^

    Bitwise XOR

    &

    Bitwise AND

    <<, >>

    Shifts

    +, -

    Addition and subtraction

    *, @, /, //, %

    Multiplication, matrix +multiplication, division, floor +division, remainder 5

    +x, -x, ~x

    Positive, negative, bitwise NOT

    **

    Exponentiation 6

    await x

    Await expression

    x[index], x[index:index], +x(arguments...), x.attribute

    Subscription, slicing, +call, attribute reference

    (expressions...), +[expressions...], +{key: value...}, +{expressions...}

    Binding or tuple display, +list display, +dictionary display, +set display

    +

    Footnotes

    +
    +
    1
    +

    While abs(x%y) < abs(y) is true mathematically, for floats it may not be +true numerically due to roundoff. For example, and assuming a platform on which +a Python float is an IEEE 754 double-precision number, in order that -1e-100 % +1e100 have the same sign as 1e100, the computed result is -1e-100 + +1e100, which is numerically exactly equal to 1e100. The function +math.fmod() returns a result whose sign matches the sign of the +first argument instead, and so returns -1e-100 in this case. Which approach +is more appropriate depends on the application.

    +
    +
    2
    +

    If x is very close to an exact integer multiple of y, it’s possible for +x//y to be one larger than (x-x%y)//y due to rounding. In such +cases, Python returns the latter result, in order to preserve that +divmod(x,y)[0] * y + x % y be very close to x.

    +
    +
    3
    +

    The Unicode standard distinguishes between code points +(e.g. U+0041) and abstract characters (e.g. “LATIN CAPITAL LETTER A”). +While most abstract characters in Unicode are only represented using one +code point, there is a number of abstract characters that can in addition be +represented using a sequence of more than one code point. For example, the +abstract character “LATIN CAPITAL LETTER C WITH CEDILLA” can be represented +as a single precomposed character at code position U+00C7, or as a +sequence of a base character at code position U+0043 (LATIN CAPITAL +LETTER C), followed by a combining character at code position U+0327 +(COMBINING CEDILLA).

    +

    The comparison operators on strings compare at the level of Unicode code +points. This may be counter-intuitive to humans. For example, +"\u00C7" == "\u0043\u0327" is False, even though both strings +represent the same abstract character “LATIN CAPITAL LETTER C WITH CEDILLA”.

    +

    To compare strings at the level of abstract characters (that is, in a way +intuitive to humans), use unicodedata.normalize().

    +
    +
    4
    +

    Due to automatic garbage-collection, free lists, and the dynamic nature of +descriptors, you may notice seemingly unusual behaviour in certain uses of +the is operator, like those involving comparisons between instance +methods, or constants. Check their documentation for more info.

    +
    +
    5
    +

    The % operator is also used for string formatting; the same +precedence applies.

    +
    +
    6
    +

    The power operator ** binds less tightly than an arithmetic or +bitwise unary operator on its right, that is, 2**-1 is 0.5.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/reference/grammar.html b/python-3.7.4-docs-html/reference/grammar.html new file mode 100644 index 0000000..629b8f3 --- /dev/null +++ b/python-3.7.4-docs-html/reference/grammar.html @@ -0,0 +1,335 @@ + + + + + + + 10. Full Grammar specification — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    10. Full Grammar specification

    +

    This is the full Python grammar, as it is read by the parser generator and used +to parse Python source files:

    +
    # Grammar for Python
    +
    +# NOTE WELL: You should also follow all the steps listed at
    +# https://devguide.python.org/grammar/
    +
    +# Start symbols for the grammar:
    +#       single_input is a single interactive statement;
    +#       file_input is a module or sequence of commands read from an input file;
    +#       eval_input is the input for the eval() functions.
    +# NB: compound_stmt in single_input is followed by extra NEWLINE!
    +single_input: NEWLINE | simple_stmt | compound_stmt NEWLINE
    +file_input: (NEWLINE | stmt)* ENDMARKER
    +eval_input: testlist NEWLINE* ENDMARKER
    +
    +decorator: '@' dotted_name [ '(' [arglist] ')' ] NEWLINE
    +decorators: decorator+
    +decorated: decorators (classdef | funcdef | async_funcdef)
    +
    +async_funcdef: 'async' funcdef
    +funcdef: 'def' NAME parameters ['->' test] ':' suite
    +
    +parameters: '(' [typedargslist] ')'
    +typedargslist: (tfpdef ['=' test] (',' tfpdef ['=' test])* [',' [
    +        '*' [tfpdef] (',' tfpdef ['=' test])* [',' ['**' tfpdef [',']]]
    +      | '**' tfpdef [',']]]
    +  | '*' [tfpdef] (',' tfpdef ['=' test])* [',' ['**' tfpdef [',']]]
    +  | '**' tfpdef [','])
    +tfpdef: NAME [':' test]
    +varargslist: (vfpdef ['=' test] (',' vfpdef ['=' test])* [',' [
    +        '*' [vfpdef] (',' vfpdef ['=' test])* [',' ['**' vfpdef [',']]]
    +      | '**' vfpdef [',']]]
    +  | '*' [vfpdef] (',' vfpdef ['=' test])* [',' ['**' vfpdef [',']]]
    +  | '**' vfpdef [',']
    +)
    +vfpdef: NAME
    +
    +stmt: simple_stmt | compound_stmt
    +simple_stmt: small_stmt (';' small_stmt)* [';'] NEWLINE
    +small_stmt: (expr_stmt | del_stmt | pass_stmt | flow_stmt |
    +             import_stmt | global_stmt | nonlocal_stmt | assert_stmt)
    +expr_stmt: testlist_star_expr (annassign | augassign (yield_expr|testlist) |
    +                     ('=' (yield_expr|testlist_star_expr))*)
    +annassign: ':' test ['=' test]
    +testlist_star_expr: (test|star_expr) (',' (test|star_expr))* [',']
    +augassign: ('+=' | '-=' | '*=' | '@=' | '/=' | '%=' | '&=' | '|=' | '^=' |
    +            '<<=' | '>>=' | '**=' | '//=')
    +# For normal and annotated assignments, additional restrictions enforced by the interpreter
    +del_stmt: 'del' exprlist
    +pass_stmt: 'pass'
    +flow_stmt: break_stmt | continue_stmt | return_stmt | raise_stmt | yield_stmt
    +break_stmt: 'break'
    +continue_stmt: 'continue'
    +return_stmt: 'return' [testlist]
    +yield_stmt: yield_expr
    +raise_stmt: 'raise' [test ['from' test]]
    +import_stmt: import_name | import_from
    +import_name: 'import' dotted_as_names
    +# note below: the ('.' | '...') is necessary because '...' is tokenized as ELLIPSIS
    +import_from: ('from' (('.' | '...')* dotted_name | ('.' | '...')+)
    +              'import' ('*' | '(' import_as_names ')' | import_as_names))
    +import_as_name: NAME ['as' NAME]
    +dotted_as_name: dotted_name ['as' NAME]
    +import_as_names: import_as_name (',' import_as_name)* [',']
    +dotted_as_names: dotted_as_name (',' dotted_as_name)*
    +dotted_name: NAME ('.' NAME)*
    +global_stmt: 'global' NAME (',' NAME)*
    +nonlocal_stmt: 'nonlocal' NAME (',' NAME)*
    +assert_stmt: 'assert' test [',' test]
    +
    +compound_stmt: if_stmt | while_stmt | for_stmt | try_stmt | with_stmt | funcdef | classdef | decorated | async_stmt
    +async_stmt: 'async' (funcdef | with_stmt | for_stmt)
    +if_stmt: 'if' test ':' suite ('elif' test ':' suite)* ['else' ':' suite]
    +while_stmt: 'while' test ':' suite ['else' ':' suite]
    +for_stmt: 'for' exprlist 'in' testlist ':' suite ['else' ':' suite]
    +try_stmt: ('try' ':' suite
    +           ((except_clause ':' suite)+
    +            ['else' ':' suite]
    +            ['finally' ':' suite] |
    +           'finally' ':' suite))
    +with_stmt: 'with' with_item (',' with_item)*  ':' suite
    +with_item: test ['as' expr]
    +# NB compile.c makes sure that the default except clause is last
    +except_clause: 'except' [test ['as' NAME]]
    +suite: simple_stmt | NEWLINE INDENT stmt+ DEDENT
    +
    +test: or_test ['if' or_test 'else' test] | lambdef
    +test_nocond: or_test | lambdef_nocond
    +lambdef: 'lambda' [varargslist] ':' test
    +lambdef_nocond: 'lambda' [varargslist] ':' test_nocond
    +or_test: and_test ('or' and_test)*
    +and_test: not_test ('and' not_test)*
    +not_test: 'not' not_test | comparison
    +comparison: expr (comp_op expr)*
    +# <> isn't actually a valid comparison operator in Python. It's here for the
    +# sake of a __future__ import described in PEP 401 (which really works :-)
    +comp_op: '<'|'>'|'=='|'>='|'<='|'<>'|'!='|'in'|'not' 'in'|'is'|'is' 'not'
    +star_expr: '*' expr
    +expr: xor_expr ('|' xor_expr)*
    +xor_expr: and_expr ('^' and_expr)*
    +and_expr: shift_expr ('&' shift_expr)*
    +shift_expr: arith_expr (('<<'|'>>') arith_expr)*
    +arith_expr: term (('+'|'-') term)*
    +term: factor (('*'|'@'|'/'|'%'|'//') factor)*
    +factor: ('+'|'-'|'~') factor | power
    +power: atom_expr ['**' factor]
    +atom_expr: ['await'] atom trailer*
    +atom: ('(' [yield_expr|testlist_comp] ')' |
    +       '[' [testlist_comp] ']' |
    +       '{' [dictorsetmaker] '}' |
    +       NAME | NUMBER | STRING+ | '...' | 'None' | 'True' | 'False')
    +testlist_comp: (test|star_expr) ( comp_for | (',' (test|star_expr))* [','] )
    +trailer: '(' [arglist] ')' | '[' subscriptlist ']' | '.' NAME
    +subscriptlist: subscript (',' subscript)* [',']
    +subscript: test | [test] ':' [test] [sliceop]
    +sliceop: ':' [test]
    +exprlist: (expr|star_expr) (',' (expr|star_expr))* [',']
    +testlist: test (',' test)* [',']
    +dictorsetmaker: ( ((test ':' test | '**' expr)
    +                   (comp_for | (',' (test ':' test | '**' expr))* [','])) |
    +                  ((test | star_expr)
    +                   (comp_for | (',' (test | star_expr))* [','])) )
    +
    +classdef: 'class' NAME ['(' [arglist] ')'] ':' suite
    +
    +arglist: argument (',' argument)*  [',']
    +
    +# The reason that keywords are test nodes instead of NAME is that using NAME
    +# results in an ambiguity. ast.c makes sure it's a NAME.
    +# "test '=' test" is really "keyword '=' test", but we have no such token.
    +# These need to be in a single rule to avoid grammar that is ambiguous
    +# to our LL(1) parser. Even though 'test' includes '*expr' in star_expr,
    +# we explicitly match '*' here, too, to give it proper precedence.
    +# Illegal combinations and orderings are blocked in ast.c:
    +# multiple (test comp_for) arguments are blocked; keyword unpackings
    +# that precede iterable unpackings are blocked; etc.
    +argument: ( test [comp_for] |
    +            test '=' test |
    +            '**' test |
    +            '*' test )
    +
    +comp_iter: comp_for | comp_if
    +sync_comp_for: 'for' exprlist 'in' or_test [comp_iter]
    +comp_for: ['async'] sync_comp_for
    +comp_if: 'if' test_nocond [comp_iter]
    +
    +# not used in grammar, but may appear in "node" passed from Parser to Compiler
    +encoding_decl: NAME
    +
    +yield_expr: 'yield' [yield_arg]
    +yield_arg: 'from' test | testlist
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/reference/import.html b/python-3.7.4-docs-html/reference/import.html new file mode 100644 index 0000000..1fb5217 --- /dev/null +++ b/python-3.7.4-docs-html/reference/import.html @@ -0,0 +1,1135 @@ + + + + + + + 5. The import system — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    5. The import system

    +

    Python code in one module gains access to the code in another module +by the process of importing it. The import statement is +the most common way of invoking the import machinery, but it is not the only +way. Functions such as importlib.import_module() and built-in +__import__() can also be used to invoke the import machinery.

    +

    The import statement combines two operations; it searches for the +named module, then it binds the results of that search to a name in the local +scope. The search operation of the import statement is defined as +a call to the __import__() function, with the appropriate arguments. +The return value of __import__() is used to perform the name +binding operation of the import statement. See the +import statement for the exact details of that name binding +operation.

    +

    A direct call to __import__() performs only the module search and, if +found, the module creation operation. While certain side-effects may occur, +such as the importing of parent packages, and the updating of various caches +(including sys.modules), only the import statement performs +a name binding operation.

    +

    When an import statement is executed, the standard builtin +__import__() function is called. Other mechanisms for invoking the +import system (such as importlib.import_module()) may choose to bypass +__import__() and use their own solutions to implement import semantics.

    +

    When a module is first imported, Python searches for the module and if found, +it creates a module object 1, initializing it. If the named module +cannot be found, a ModuleNotFoundError is raised. Python implements various +strategies to search for the named module when the import machinery is +invoked. These strategies can be modified and extended by using various hooks +described in the sections below.

    +
    +

    Changed in version 3.3: The import system has been updated to fully implement the second phase +of PEP 302. There is no longer any implicit import machinery - the full +import system is exposed through sys.meta_path. In addition, +native namespace package support has been implemented (see PEP 420).

    +
    +
    +

    5.1. importlib

    +

    The importlib module provides a rich API for interacting with the +import system. For example importlib.import_module() provides a +recommended, simpler API than built-in __import__() for invoking the +import machinery. Refer to the importlib library documentation for +additional detail.

    +
    +
    +

    5.2. Packages

    +

    Python has only one type of module object, and all modules are of this type, +regardless of whether the module is implemented in Python, C, or something +else. To help organize modules and provide a naming hierarchy, Python has a +concept of packages.

    +

    You can think of packages as the directories on a file system and modules as +files within directories, but don’t take this analogy too literally since +packages and modules need not originate from the file system. For the +purposes of this documentation, we’ll use this convenient analogy of +directories and files. Like file system directories, packages are organized +hierarchically, and packages may themselves contain subpackages, as well as +regular modules.

    +

    It’s important to keep in mind that all packages are modules, but not all +modules are packages. Or put another way, packages are just a special kind of +module. Specifically, any module that contains a __path__ attribute is +considered a package.

    +

    All modules have a name. Subpackage names are separated from their parent +package name by dots, akin to Python’s standard attribute access syntax. Thus +you might have a module called sys and a package called email, +which in turn has a subpackage called email.mime and a module within +that subpackage called email.mime.text.

    +
    +

    5.2.1. Regular packages

    +

    Python defines two types of packages, regular packages and namespace packages. Regular +packages are traditional packages as they existed in Python 3.2 and earlier. +A regular package is typically implemented as a directory containing an +__init__.py file. When a regular package is imported, this +__init__.py file is implicitly executed, and the objects it defines are +bound to names in the package’s namespace. The __init__.py file can +contain the same Python code that any other module can contain, and Python +will add some additional attributes to the module when it is imported.

    +

    For example, the following file system layout defines a top level parent +package with three subpackages:

    +
    parent/
    +    __init__.py
    +    one/
    +        __init__.py
    +    two/
    +        __init__.py
    +    three/
    +        __init__.py
    +
    +
    +

    Importing parent.one will implicitly execute parent/__init__.py and +parent/one/__init__.py. Subsequent imports of parent.two or +parent.three will execute parent/two/__init__.py and +parent/three/__init__.py respectively.

    +
    +
    +

    5.2.2. Namespace packages

    +

    A namespace package is a composite of various portions, +where each portion contributes a subpackage to the parent package. Portions +may reside in different locations on the file system. Portions may also be +found in zip files, on the network, or anywhere else that Python searches +during import. Namespace packages may or may not correspond directly to +objects on the file system; they may be virtual modules that have no concrete +representation.

    +

    Namespace packages do not use an ordinary list for their __path__ +attribute. They instead use a custom iterable type which will automatically +perform a new search for package portions on the next import attempt within +that package if the path of their parent package (or sys.path for a +top level package) changes.

    +

    With namespace packages, there is no parent/__init__.py file. In fact, +there may be multiple parent directories found during import search, where +each one is provided by a different portion. Thus parent/one may not be +physically located next to parent/two. In this case, Python will create a +namespace package for the top-level parent package whenever it or one of +its subpackages is imported.

    +

    See also PEP 420 for the namespace package specification.

    +
    +
    +
    +

    5.3. Searching

    +

    To begin the search, Python needs the fully qualified +name of the module (or package, but for the purposes of this discussion, the +difference is immaterial) being imported. This name may come from various +arguments to the import statement, or from the parameters to the +importlib.import_module() or __import__() functions.

    +

    This name will be used in various phases of the import search, and it may be +the dotted path to a submodule, e.g. foo.bar.baz. In this case, Python +first tries to import foo, then foo.bar, and finally foo.bar.baz. +If any of the intermediate imports fail, a ModuleNotFoundError is raised.

    +
    +

    5.3.1. The module cache

    +

    The first place checked during import search is sys.modules. This +mapping serves as a cache of all modules that have been previously imported, +including the intermediate paths. So if foo.bar.baz was previously +imported, sys.modules will contain entries for foo, foo.bar, +and foo.bar.baz. Each key will have as its value the corresponding module +object.

    +

    During import, the module name is looked up in sys.modules and if +present, the associated value is the module satisfying the import, and the +process completes. However, if the value is None, then a +ModuleNotFoundError is raised. If the module name is missing, Python will +continue searching for the module.

    +

    sys.modules is writable. Deleting a key may not destroy the +associated module (as other modules may hold references to it), +but it will invalidate the cache entry for the named module, causing +Python to search anew for the named module upon its next +import. The key can also be assigned to None, forcing the next import +of the module to result in a ModuleNotFoundError.

    +

    Beware though, as if you keep a reference to the module object, +invalidate its cache entry in sys.modules, and then re-import the +named module, the two module objects will not be the same. By contrast, +importlib.reload() will reuse the same module object, and simply +reinitialise the module contents by rerunning the module’s code.

    +
    +
    +

    5.3.2. Finders and loaders

    +

    If the named module is not found in sys.modules, then Python’s import +protocol is invoked to find and load the module. This protocol consists of +two conceptual objects, finders and loaders. +A finder’s job is to determine whether it can find the named module using +whatever strategy it knows about. Objects that implement both of these +interfaces are referred to as importers - they return +themselves when they find that they can load the requested module.

    +

    Python includes a number of default finders and importers. The first one +knows how to locate built-in modules, and the second knows how to locate +frozen modules. A third default finder searches an import path +for modules. The import path is a list of locations that may +name file system paths or zip files. It can also be extended to search +for any locatable resource, such as those identified by URLs.

    +

    The import machinery is extensible, so new finders can be added to extend the +range and scope of module searching.

    +

    Finders do not actually load modules. If they can find the named module, they +return a module spec, an encapsulation of the module’s import-related +information, which the import machinery then uses when loading the module.

    +

    The following sections describe the protocol for finders and loaders in more +detail, including how you can create and register new ones to extend the +import machinery.

    +
    +

    Changed in version 3.4: In previous versions of Python, finders returned loaders +directly, whereas now they return module specs which contain loaders. +Loaders are still used during import but have fewer responsibilities.

    +
    +
    +
    +

    5.3.3. Import hooks

    +

    The import machinery is designed to be extensible; the primary mechanism for +this are the import hooks. There are two types of import hooks: meta +hooks and import path hooks.

    +

    Meta hooks are called at the start of import processing, before any other +import processing has occurred, other than sys.modules cache look up. +This allows meta hooks to override sys.path processing, frozen +modules, or even built-in modules. Meta hooks are registered by adding new +finder objects to sys.meta_path, as described below.

    +

    Import path hooks are called as part of sys.path (or +package.__path__) processing, at the point where their associated path +item is encountered. Import path hooks are registered by adding new callables +to sys.path_hooks as described below.

    +
    +
    +

    5.3.4. The meta path

    +

    When the named module is not found in sys.modules, Python next +searches sys.meta_path, which contains a list of meta path finder +objects. These finders are queried in order to see if they know how to handle +the named module. Meta path finders must implement a method called +find_spec() which takes three arguments: +a name, an import path, and (optionally) a target module. The meta path +finder can use any strategy it wants to determine whether it can handle +the named module or not.

    +

    If the meta path finder knows how to handle the named module, it returns a +spec object. If it cannot handle the named module, it returns None. If +sys.meta_path processing reaches the end of its list without returning +a spec, then a ModuleNotFoundError is raised. Any other exceptions +raised are simply propagated up, aborting the import process.

    +

    The find_spec() method of meta path +finders is called with two or three arguments. The first is the fully +qualified name of the module being imported, for example foo.bar.baz. +The second argument is the path entries to use for the module search. For +top-level modules, the second argument is None, but for submodules or +subpackages, the second argument is the value of the parent package’s +__path__ attribute. If the appropriate __path__ attribute cannot +be accessed, a ModuleNotFoundError is raised. The third argument +is an existing module object that will be the target of loading later. +The import system passes in a target module only during reload.

    +

    The meta path may be traversed multiple times for a single import request. +For example, assuming none of the modules involved has already been cached, +importing foo.bar.baz will first perform a top level import, calling +mpf.find_spec("foo", None, None) on each meta path finder (mpf). After +foo has been imported, foo.bar will be imported by traversing the +meta path a second time, calling +mpf.find_spec("foo.bar", foo.__path__, None). Once foo.bar has been +imported, the final traversal will call +mpf.find_spec("foo.bar.baz", foo.bar.__path__, None).

    +

    Some meta path finders only support top level imports. These importers will +always return None when anything other than None is passed as the +second argument.

    +

    Python’s default sys.meta_path has three meta path finders, one that +knows how to import built-in modules, one that knows how to import frozen +modules, and one that knows how to import modules from an import path +(i.e. the path based finder).

    +
    +

    Changed in version 3.4: The find_spec() method of meta path +finders replaced find_module(), which +is now deprecated. While it will continue to work without change, the +import machinery will try it only if the finder does not implement +find_spec().

    +
    +
    +
    +
    +

    5.4. Loading

    +

    If and when a module spec is found, the import machinery will use it (and +the loader it contains) when loading the module. Here is an approximation +of what happens during the loading portion of import:

    +
    module = None
    +if spec.loader is not None and hasattr(spec.loader, 'create_module'):
    +    # It is assumed 'exec_module' will also be defined on the loader.
    +    module = spec.loader.create_module(spec)
    +if module is None:
    +    module = ModuleType(spec.name)
    +# The import-related module attributes get set here:
    +_init_module_attrs(spec, module)
    +
    +if spec.loader is None:
    +    if spec.submodule_search_locations is not None:
    +        # namespace package
    +        sys.modules[spec.name] = module
    +    else:
    +        # unsupported
    +        raise ImportError
    +elif not hasattr(spec.loader, 'exec_module'):
    +    module = spec.loader.load_module(spec.name)
    +    # Set __loader__ and __package__ if missing.
    +else:
    +    sys.modules[spec.name] = module
    +    try:
    +        spec.loader.exec_module(module)
    +    except BaseException:
    +        try:
    +            del sys.modules[spec.name]
    +        except KeyError:
    +            pass
    +        raise
    +return sys.modules[spec.name]
    +
    +
    +

    Note the following details:

    +
    +
      +
    • If there is an existing module object with the given name in +sys.modules, import will have already returned it.

    • +
    • The module will exist in sys.modules before the loader +executes the module code. This is crucial because the module code may +(directly or indirectly) import itself; adding it to sys.modules +beforehand prevents unbounded recursion in the worst case and multiple +loading in the best.

    • +
    • If loading fails, the failing module – and only the failing module – +gets removed from sys.modules. Any module already in the +sys.modules cache, and any module that was successfully loaded +as a side-effect, must remain in the cache. This contrasts with +reloading where even the failing module is left in sys.modules.

    • +
    • After the module is created but before execution, the import machinery +sets the import-related module attributes (“_init_module_attrs” in +the pseudo-code example above), as summarized in a +later section.

    • +
    • Module execution is the key moment of loading in which the module’s +namespace gets populated. Execution is entirely delegated to the +loader, which gets to decide what gets populated and how.

    • +
    • The module created during loading and passed to exec_module() may +not be the one returned at the end of import 2.

    • +
    +
    +
    +

    Changed in version 3.4: The import system has taken over the boilerplate responsibilities of +loaders. These were previously performed by the +importlib.abc.Loader.load_module() method.

    +
    +
    +

    5.4.1. Loaders

    +

    Module loaders provide the critical function of loading: module execution. +The import machinery calls the importlib.abc.Loader.exec_module() +method with a single argument, the module object to execute. Any value +returned from exec_module() is ignored.

    +

    Loaders must satisfy the following requirements:

    +
    +
      +
    • If the module is a Python module (as opposed to a built-in module or a +dynamically loaded extension), the loader should execute the module’s code +in the module’s global name space (module.__dict__).

    • +
    • If the loader cannot execute the module, it should raise an +ImportError, although any other exception raised during +exec_module() will be propagated.

    • +
    +
    +

    In many cases, the finder and loader can be the same object; in such cases the +find_spec() method would just return a +spec with the loader set to self.

    +

    Module loaders may opt in to creating the module object during loading +by implementing a create_module() method. +It takes one argument, the module spec, and returns the new module object +to use during loading. create_module() does not need to set any attributes +on the module object. If the method returns None, the +import machinery will create the new module itself.

    +
    +

    New in version 3.4: The create_module() method of loaders.

    +
    +
    +

    Changed in version 3.4: The load_module() method was replaced by +exec_module() and the import +machinery assumed all the boilerplate responsibilities of loading.

    +

    For compatibility with existing loaders, the import machinery will use +the load_module() method of loaders if it exists and the loader does +not also implement exec_module(). However, load_module() has been +deprecated and loaders should implement exec_module() instead.

    +

    The load_module() method must implement all the boilerplate loading +functionality described above in addition to executing the module. All +the same constraints apply, with some additional clarification:

    +
    +
      +
    • If there is an existing module object with the given name in +sys.modules, the loader must use that existing module. +(Otherwise, importlib.reload() will not work correctly.) If the +named module does not exist in sys.modules, the loader +must create a new module object and add it to sys.modules.

    • +
    • The module must exist in sys.modules before the loader +executes the module code, to prevent unbounded recursion or multiple +loading.

    • +
    • If loading fails, the loader must remove any modules it has inserted +into sys.modules, but it must remove only the failing +module(s), and only if the loader itself has loaded the module(s) +explicitly.

    • +
    +
    +
    +
    +

    Changed in version 3.5: A DeprecationWarning is raised when exec_module() is defined but +create_module() is not.

    +
    +
    +

    Changed in version 3.6: An ImportError is raised when exec_module() is defined but +create_module() is not.

    +
    +
    +
    +

    5.4.2. Submodules

    +

    When a submodule is loaded using any mechanism (e.g. importlib APIs, the +import or import-from statements, or built-in __import__()) a +binding is placed in the parent module’s namespace to the submodule object. +For example, if package spam has a submodule foo, after importing +spam.foo, spam will have an attribute foo which is bound to the +submodule. Let’s say you have the following directory structure:

    +
    spam/
    +    __init__.py
    +    foo.py
    +    bar.py
    +
    +
    +

    and spam/__init__.py has the following lines in it:

    +
    from .foo import Foo
    +from .bar import Bar
    +
    +
    +

    then executing the following puts a name binding to foo and bar in the +spam module:

    +
    >>> import spam
    +>>> spam.foo
    +<module 'spam.foo' from '/tmp/imports/spam/foo.py'>
    +>>> spam.bar
    +<module 'spam.bar' from '/tmp/imports/spam/bar.py'>
    +
    +
    +

    Given Python’s familiar name binding rules this might seem surprising, but +it’s actually a fundamental feature of the import system. The invariant +holding is that if you have sys.modules['spam'] and +sys.modules['spam.foo'] (as you would after the above import), the latter +must appear as the foo attribute of the former.

    +
    +
    +

    5.4.3. Module spec

    +

    The import machinery uses a variety of information about each module +during import, especially before loading. Most of the information is +common to all modules. The purpose of a module’s spec is to encapsulate +this import-related information on a per-module basis.

    +

    Using a spec during import allows state to be transferred between import +system components, e.g. between the finder that creates the module spec +and the loader that executes it. Most importantly, it allows the +import machinery to perform the boilerplate operations of loading, +whereas without a module spec the loader had that responsibility.

    +

    The module’s spec is exposed as the __spec__ attribute on a module object. +See ModuleSpec for details on the contents of +the module spec.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +

    5.4.5. module.__path__

    +

    By definition, if a module has a __path__ attribute, it is a package.

    +

    A package’s __path__ attribute is used during imports of its subpackages. +Within the import machinery, it functions much the same as sys.path, +i.e. providing a list of locations to search for modules during import. +However, __path__ is typically much more constrained than +sys.path.

    +

    __path__ must be an iterable of strings, but it may be empty. +The same rules used for sys.path also apply to a package’s +__path__, and sys.path_hooks (described below) are +consulted when traversing a package’s __path__.

    +

    A package’s __init__.py file may set or alter the package’s __path__ +attribute, and this was typically the way namespace packages were implemented +prior to PEP 420. With the adoption of PEP 420, namespace packages no +longer need to supply __init__.py files containing only __path__ +manipulation code; the import machinery automatically sets __path__ +correctly for the namespace package.

    +
    +
    +

    5.4.6. Module reprs

    +

    By default, all modules have a usable repr, however depending on the +attributes set above, and in the module’s spec, you can more explicitly +control the repr of module objects.

    +

    If the module has a spec (__spec__), the import machinery will try +to generate a repr from it. If that fails or there is no spec, the import +system will craft a default repr using whatever information is available +on the module. It will try to use the module.__name__, +module.__file__, and module.__loader__ as input into the repr, +with defaults for whatever information is missing.

    +

    Here are the exact rules used:

    +
    +
      +
    • If the module has a __spec__ attribute, the information in the spec +is used to generate the repr. The “name”, “loader”, “origin”, and +“has_location” attributes are consulted.

    • +
    • If the module has a __file__ attribute, this is used as part of the +module’s repr.

    • +
    • If the module has no __file__ but does have a __loader__ that is not +None, then the loader’s repr is used as part of the module’s repr.

    • +
    • Otherwise, just use the module’s __name__ in the repr.

    • +
    +
    +
    +

    Changed in version 3.4: Use of loader.module_repr() +has been deprecated and the module spec is now used by the import +machinery to generate a module repr.

    +

    For backward compatibility with Python 3.3, the module repr will be +generated by calling the loader’s +module_repr() method, if defined, before +trying either approach described above. However, the method is deprecated.

    +
    +
    +
    +

    5.4.7. Cached bytecode invalidation

    +

    Before Python loads cached bytecode from .pyc file, it checks whether the +cache is up-to-date with the source .py file. By default, Python does this +by storing the source’s last-modified timestamp and size in the cache file when +writing it. At runtime, the import system then validates the cache file by +checking the stored metadata in the cache file against at source’s +metadata.

    +

    Python also supports “hash-based” cache files, which store a hash of the source +file’s contents rather than its metadata. There are two variants of hash-based +.pyc files: checked and unchecked. For checked hash-based .pyc files, +Python validates the cache file by hashing the source file and comparing the +resulting hash with the hash in the cache file. If a checked hash-based cache +file is found to be invalid, Python regenerates it and writes a new checked +hash-based cache file. For unchecked hash-based .pyc files, Python simply +assumes the cache file is valid if it exists. Hash-based .pyc files +validation behavior may be overridden with the --check-hash-based-pycs +flag.

    +
    +

    Changed in version 3.7: Added hash-based .pyc files. Previously, Python only supported +timestamp-based invalidation of bytecode caches.

    +
    +
    +
    +
    +

    5.5. The Path Based Finder

    +

    As mentioned previously, Python comes with several default meta path finders. +One of these, called the path based finder +(PathFinder), searches an import path, +which contains a list of path entries. Each path +entry names a location to search for modules.

    +

    The path based finder itself doesn’t know how to import anything. Instead, it +traverses the individual path entries, associating each of them with a +path entry finder that knows how to handle that particular kind of path.

    +

    The default set of path entry finders implement all the semantics for finding +modules on the file system, handling special file types such as Python source +code (.py files), Python byte code (.pyc files) and +shared libraries (e.g. .so files). When supported by the zipimport +module in the standard library, the default path entry finders also handle +loading all of these file types (other than shared libraries) from zipfiles.

    +

    Path entries need not be limited to file system locations. They can refer to +URLs, database queries, or any other location that can be specified as a +string.

    +

    The path based finder provides additional hooks and protocols so that you +can extend and customize the types of searchable path entries. For example, +if you wanted to support path entries as network URLs, you could write a hook +that implements HTTP semantics to find modules on the web. This hook (a +callable) would return a path entry finder supporting the protocol +described below, which was then used to get a loader for the module from the +web.

    +

    A word of warning: this section and the previous both use the term finder, +distinguishing between them by using the terms meta path finder and +path entry finder. These two types of finders are very similar, +support similar protocols, and function in similar ways during the import +process, but it’s important to keep in mind that they are subtly different. +In particular, meta path finders operate at the beginning of the import +process, as keyed off the sys.meta_path traversal.

    +

    By contrast, path entry finders are in a sense an implementation detail +of the path based finder, and in fact, if the path based finder were to be +removed from sys.meta_path, none of the path entry finder semantics +would be invoked.

    +
    +

    5.5.1. Path entry finders

    +

    The path based finder is responsible for finding and loading +Python modules and packages whose location is specified with a string +path entry. Most path entries name locations in the file system, +but they need not be limited to this.

    +

    As a meta path finder, the path based finder implements the +find_spec() protocol previously +described, however it exposes additional hooks that can be used to +customize how modules are found and loaded from the import path.

    +

    Three variables are used by the path based finder, sys.path, +sys.path_hooks and sys.path_importer_cache. The __path__ +attributes on package objects are also used. These provide additional ways +that the import machinery can be customized.

    +

    sys.path contains a list of strings providing search locations for +modules and packages. It is initialized from the PYTHONPATH +environment variable and various other installation- and +implementation-specific defaults. Entries in sys.path can name +directories on the file system, zip files, and potentially other “locations” +(see the site module) that should be searched for modules, such as +URLs, or database queries. Only strings and bytes should be present on +sys.path; all other data types are ignored. The encoding of bytes +entries is determined by the individual path entry finders.

    +

    The path based finder is a meta path finder, so the import +machinery begins the import path search by calling the path +based finder’s find_spec() method as +described previously. When the path argument to +find_spec() is given, it will be a +list of string paths to traverse - typically a package’s __path__ +attribute for an import within that package. If the path argument is +None, this indicates a top level import and sys.path is used.

    +

    The path based finder iterates over every entry in the search path, and +for each of these, looks for an appropriate path entry finder +(PathEntryFinder) for the +path entry. Because this can be an expensive operation (e.g. there may be +stat() call overheads for this search), the path based finder maintains +a cache mapping path entries to path entry finders. This cache is maintained +in sys.path_importer_cache (despite the name, this cache actually +stores finder objects rather than being limited to importer objects). +In this way, the expensive search for a particular path entry +location’s path entry finder need only be done once. User code is +free to remove cache entries from sys.path_importer_cache forcing +the path based finder to perform the path entry search again 3.

    +

    If the path entry is not present in the cache, the path based finder iterates +over every callable in sys.path_hooks. Each of the path entry +hooks in this list is called with a single argument, the +path entry to be searched. This callable may either return a path +entry finder that can handle the path entry, or it may raise +ImportError. An ImportError is used by the path based finder to +signal that the hook cannot find a path entry finder +for that path entry. The +exception is ignored and import path iteration continues. The hook +should expect either a string or bytes object; the encoding of bytes objects +is up to the hook (e.g. it may be a file system encoding, UTF-8, or something +else), and if the hook cannot decode the argument, it should raise +ImportError.

    +

    If sys.path_hooks iteration ends with no path entry finder +being returned, then the path based finder’s +find_spec() method will store None +in sys.path_importer_cache (to indicate that there is no finder for +this path entry) and return None, indicating that this +meta path finder could not find the module.

    +

    If a path entry finder is returned by one of the path entry +hook callables on sys.path_hooks, then the following protocol is used +to ask the finder for a module spec, which is then used when loading the +module.

    +

    The current working directory – denoted by an empty string – is handled +slightly differently from other entries on sys.path. First, if the +current working directory is found to not exist, no value is stored in +sys.path_importer_cache. Second, the value for the current working +directory is looked up fresh for each module lookup. Third, the path used for +sys.path_importer_cache and returned by +importlib.machinery.PathFinder.find_spec() will be the actual current +working directory and not the empty string.

    +
    +
    +

    5.5.2. Path entry finder protocol

    +

    In order to support imports of modules and initialized packages and also to +contribute portions to namespace packages, path entry finders must implement +the find_spec() method.

    +

    find_spec() takes two argument, the +fully qualified name of the module being imported, and the (optional) target +module. find_spec() returns a fully populated spec for the module. +This spec will always have “loader” set (with one exception).

    +

    To indicate to the import machinery that the spec represents a namespace +portion. the path entry finder sets “loader” on the spec to +None and “submodule_search_locations” to a list containing the +portion.

    +
    +

    Changed in version 3.4: find_spec() replaced +find_loader() and +find_module(), both of which +are now deprecated, but will be used if find_spec() is not defined.

    +

    Older path entry finders may implement one of these two deprecated methods +instead of find_spec(). The methods are still respected for the +sake of backward compatibility. However, if find_spec() is +implemented on the path entry finder, the legacy methods are ignored.

    +

    find_loader() takes one argument, the +fully qualified name of the module being imported. find_loader() +returns a 2-tuple where the first item is the loader and the second item +is a namespace portion. When the first item (i.e. the loader) is +None, this means that while the path entry finder does not have a +loader for the named module, it knows that the path entry contributes to +a namespace portion for the named module. This will almost always be the +case where Python is asked to import a namespace package that has no +physical presence on the file system. When a path entry finder returns +None for the loader, the second item of the 2-tuple return value must +be a sequence, although it can be empty.

    +

    If find_loader() returns a non-None loader value, the portion is +ignored and the loader is returned from the path based finder, terminating +the search through the path entries.

    +

    For backwards compatibility with other implementations of the import +protocol, many path entry finders also support the same, +traditional find_module() method that meta path finders support. +However path entry finder find_module() methods are never called +with a path argument (they are expected to record the appropriate +path information from the initial call to the path hook).

    +

    The find_module() method on path entry finders is deprecated, +as it does not allow the path entry finder to contribute portions to +namespace packages. If both find_loader() and find_module() +exist on a path entry finder, the import system will always call +find_loader() in preference to find_module().

    +
    +
    +
    +
    +

    5.6. Replacing the standard import system

    +

    The most reliable mechanism for replacing the entire import system is to +delete the default contents of sys.meta_path, replacing them +entirely with a custom meta path hook.

    +

    If it is acceptable to only alter the behaviour of import statements +without affecting other APIs that access the import system, then replacing +the builtin __import__() function may be sufficient. This technique +may also be employed at the module level to only alter the behaviour of +import statements within that module.

    +

    To selectively prevent import of some modules from a hook early on the +meta path (rather than disabling the standard import system entirely), +it is sufficient to raise ModuleNotFoundError directly from +find_spec() instead of returning +None. The latter indicates that the meta path search should continue, +while raising an exception terminates it immediately.

    +
    +
    +

    5.7. Package Relative Imports

    +

    Relative imports use leading dots. A single leading dot indicates a relative +import, starting with the current package. Two or more leading dots indicate a +relative import to the parent(s) of the current package, one level per dot +after the first. For example, given the following package layout:

    +
    package/
    +    __init__.py
    +    subpackage1/
    +        __init__.py
    +        moduleX.py
    +        moduleY.py
    +    subpackage2/
    +        __init__.py
    +        moduleZ.py
    +    moduleA.py
    +
    +
    +

    In either subpackage1/moduleX.py or subpackage1/__init__.py, +the following are valid relative imports:

    +
    from .moduleY import spam
    +from .moduleY import spam as ham
    +from . import moduleY
    +from ..subpackage1 import moduleY
    +from ..subpackage2.moduleZ import eggs
    +from ..moduleA import foo
    +
    +
    +

    Absolute imports may use either the import <> or from <> import <> +syntax, but relative imports may only use the second form; the reason +for this is that:

    +
    import XXX.YYY.ZZZ
    +
    +
    +

    should expose XXX.YYY.ZZZ as a usable expression, but .moduleY is +not a valid expression.

    +
    +
    +

    5.8. Special considerations for __main__

    +

    The __main__ module is a special case relative to Python’s import +system. As noted elsewhere, the __main__ module +is directly initialized at interpreter startup, much like sys and +builtins. However, unlike those two, it doesn’t strictly +qualify as a built-in module. This is because the manner in which +__main__ is initialized depends on the flags and other options with +which the interpreter is invoked.

    +
    +

    5.8.1. __main__.__spec__

    +

    Depending on how __main__ is initialized, __main__.__spec__ +gets set appropriately or to None.

    +

    When Python is started with the -m option, __spec__ is set +to the module spec of the corresponding module or package. __spec__ is +also populated when the __main__ module is loaded as part of executing a +directory, zipfile or other sys.path entry.

    +

    In the remaining cases +__main__.__spec__ is set to None, as the code used to populate the +__main__ does not correspond directly with an importable module:

    +
      +
    • interactive prompt

    • +
    • -c option

    • +
    • running from stdin

    • +
    • running directly from a source or bytecode file

    • +
    +

    Note that __main__.__spec__ is always None in the last case, +even if the file could technically be imported directly as a module +instead. Use the -m switch if valid module metadata is desired +in __main__.

    +

    Note also that even when __main__ corresponds with an importable module +and __main__.__spec__ is set accordingly, they’re still considered +distinct modules. This is due to the fact that blocks guarded by +if __name__ == "__main__": checks only execute when the module is used +to populate the __main__ namespace, and not during normal import.

    +
    +
    +
    +

    5.9. Open issues

    +

    XXX It would be really nice to have a diagram.

    +

    XXX * (import_machinery.rst) how about a section devoted just to the +attributes of modules and packages, perhaps expanding upon or supplanting the +related entries in the data model reference page?

    +

    XXX runpy, pkgutil, et al in the library manual should all get “See Also” +links at the top pointing to the new import system section.

    +

    XXX Add more explanation regarding the different ways in which +__main__ is initialized?

    +

    XXX Add more info on __main__ quirks/pitfalls (i.e. copy from +PEP 395).

    +
    +
    +

    5.10. References

    +

    The import machinery has evolved considerably since Python’s early days. The +original specification for packages is still available to read, +although some details have changed since the writing of that document.

    +

    The original specification for sys.meta_path was PEP 302, with +subsequent extension in PEP 420.

    +

    PEP 420 introduced namespace packages for +Python 3.3. PEP 420 also introduced the find_loader() protocol as an +alternative to find_module().

    +

    PEP 366 describes the addition of the __package__ attribute for +explicit relative imports in main modules.

    +

    PEP 328 introduced absolute and explicit relative imports and initially +proposed __name__ for semantics PEP 366 would eventually specify for +__package__.

    +

    PEP 338 defines executing modules as scripts.

    +

    PEP 451 adds the encapsulation of per-module import state in spec +objects. It also off-loads most of the boilerplate responsibilities of +loaders back onto the import machinery. These changes allow the +deprecation of several APIs in the import system and also addition of new +methods to finders and loaders.

    +

    Footnotes

    +
    +
    1
    +

    See types.ModuleType.

    +
    +
    2
    +

    The importlib implementation avoids using the return value +directly. Instead, it gets the module object by looking the module name up +in sys.modules. The indirect effect of this is that an imported +module may replace itself in sys.modules. This is +implementation-specific behavior that is not guaranteed to work in other +Python implementations.

    +
    +
    3
    +

    In legacy code, it is possible to find instances of +imp.NullImporter in the sys.path_importer_cache. It +is recommended that code be changed to use None instead. See +Porting Python code for more details.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/reference/index.html b/python-3.7.4-docs-html/reference/index.html new file mode 100644 index 0000000..8e1cea9 --- /dev/null +++ b/python-3.7.4-docs-html/reference/index.html @@ -0,0 +1,285 @@ + + + + + + + The Python Language Reference — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    The Python Language Reference

    +

    This reference manual describes the syntax and “core semantics” of the +language. It is terse, but attempts to be exact and complete. The semantics of +non-essential built-in object types and of the built-in functions and modules +are described in The Python Standard Library. For an informal introduction to the +language, see The Python Tutorial. For C or C++ programmers, two additional +manuals exist: Extending and Embedding the Python Interpreter describes the high-level picture of how to +write a Python extension module, and the Python/C API Reference Manual describes the +interfaces available to C/C++ programmers in detail.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/reference/introduction.html b/python-3.7.4-docs-html/reference/introduction.html new file mode 100644 index 0000000..c22be39 --- /dev/null +++ b/python-3.7.4-docs-html/reference/introduction.html @@ -0,0 +1,289 @@ + + + + + + + 1. Introduction — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    1. Introduction

    +

    This reference manual describes the Python programming language. It is not +intended as a tutorial.

    +

    While I am trying to be as precise as possible, I chose to use English rather +than formal specifications for everything except syntax and lexical analysis. +This should make the document more understandable to the average reader, but +will leave room for ambiguities. Consequently, if you were coming from Mars and +tried to re-implement Python from this document alone, you might have to guess +things and in fact you would probably end up implementing quite a different +language. On the other hand, if you are using Python and wonder what the precise +rules about a particular area of the language are, you should definitely be able +to find them here. If you would like to see a more formal definition of the +language, maybe you could volunteer your time — or invent a cloning machine +:-).

    +

    It is dangerous to add too many implementation details to a language reference +document — the implementation may change, and other implementations of the +same language may work differently. On the other hand, CPython is the one +Python implementation in widespread use (although alternate implementations +continue to gain support), and its particular quirks are sometimes worth being +mentioned, especially where the implementation imposes additional limitations. +Therefore, you’ll find short “implementation notes” sprinkled throughout the +text.

    +

    Every Python implementation comes with a number of built-in and standard +modules. These are documented in The Python Standard Library. A few built-in modules +are mentioned when they interact in a significant way with the language +definition.

    +
    +

    1.1. Alternate Implementations

    +

    Though there is one Python implementation which is by far the most popular, +there are some alternate implementations which are of particular interest to +different audiences.

    +

    Known implementations include:

    +
    +
    CPython

    This is the original and most-maintained implementation of Python, written in C. +New language features generally appear here first.

    +
    +
    Jython

    Python implemented in Java. This implementation can be used as a scripting +language for Java applications, or can be used to create applications using the +Java class libraries. It is also often used to create tests for Java libraries. +More information can be found at the Jython website.

    +
    +
    Python for .NET

    This implementation actually uses the CPython implementation, but is a managed +.NET application and makes .NET libraries available. It was created by Brian +Lloyd. For more information, see the Python for .NET home page.

    +
    +
    IronPython

    An alternate Python for .NET. Unlike Python.NET, this is a complete Python +implementation that generates IL, and compiles Python code directly to .NET +assemblies. It was created by Jim Hugunin, the original creator of Jython. For +more information, see the IronPython website.

    +
    +
    PyPy

    An implementation of Python written completely in Python. It supports several +advanced features not found in other implementations like stackless support +and a Just in Time compiler. One of the goals of the project is to encourage +experimentation with the language itself by making it easier to modify the +interpreter (since it is written in Python). Additional information is +available on the PyPy project’s home page.

    +
    +
    +

    Each of these implementations varies in some way from the language as documented +in this manual, or introduces specific information beyond what’s covered in the +standard Python documentation. Please refer to the implementation-specific +documentation to determine what else you need to know about the specific +implementation you’re using.

    +
    +
    +

    1.2. Notation

    +

    The descriptions of lexical analysis and syntax use a modified BNF grammar +notation. This uses the following style of definition:

    +
    +name      ::=  lc_letter (lc_letter | "_")*
    +lc_letter ::=  "a"..."z"
    +
    +

    The first line says that a name is an lc_letter followed by a sequence +of zero or more lc_letters and underscores. An lc_letter in turn is +any of the single characters 'a' through 'z'. (This rule is actually +adhered to for the names defined in lexical and grammar rules in this document.)

    +

    Each rule begins with a name (which is the name defined by the rule) and +::=. A vertical bar (|) is used to separate alternatives; it is the +least binding operator in this notation. A star (*) means zero or more +repetitions of the preceding item; likewise, a plus (+) means one or more +repetitions, and a phrase enclosed in square brackets ([ ]) means zero or +one occurrences (in other words, the enclosed phrase is optional). The * +and + operators bind as tightly as possible; parentheses are used for +grouping. Literal strings are enclosed in quotes. White space is only +meaningful to separate tokens. Rules are normally contained on a single line; +rules with many alternatives may be formatted alternatively with each line after +the first beginning with a vertical bar.

    +

    In lexical definitions (as the example above), two more conventions are used: +Two literal characters separated by three dots mean a choice of any single +character in the given (inclusive) range of ASCII characters. A phrase between +angular brackets (<...>) gives an informal description of the symbol +defined; e.g., this could be used to describe the notion of ‘control character’ +if needed.

    +

    Even though the notation used is almost the same, there is a big difference +between the meaning of lexical and syntactic definitions: a lexical definition +operates on the individual characters of the input source, while a syntax +definition operates on the stream of tokens generated by the lexical analysis. +All uses of BNF in the next chapter (“Lexical Analysis”) are lexical +definitions; uses in subsequent chapters are syntactic definitions.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/reference/lexical_analysis.html b/python-3.7.4-docs-html/reference/lexical_analysis.html new file mode 100644 index 0000000..333001c --- /dev/null +++ b/python-3.7.4-docs-html/reference/lexical_analysis.html @@ -0,0 +1,940 @@ + + + + + + + 2. Lexical analysis — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    2. Lexical analysis

    +

    A Python program is read by a parser. Input to the parser is a stream of +tokens, generated by the lexical analyzer. This chapter describes how the +lexical analyzer breaks a file into tokens.

    +

    Python reads program text as Unicode code points; the encoding of a source file +can be given by an encoding declaration and defaults to UTF-8, see PEP 3120 +for details. If the source file cannot be decoded, a SyntaxError is +raised.

    +
    +

    2.1. Line structure

    +

    A Python program is divided into a number of logical lines.

    +
    +

    2.1.1. Logical lines

    +

    The end of a logical line is represented by the token NEWLINE. Statements +cannot cross logical line boundaries except where NEWLINE is allowed by the +syntax (e.g., between statements in compound statements). A logical line is +constructed from one or more physical lines by following the explicit or +implicit line joining rules.

    +
    +
    +

    2.1.2. Physical lines

    +

    A physical line is a sequence of characters terminated by an end-of-line +sequence. In source files and strings, any of the standard platform line +termination sequences can be used - the Unix form using ASCII LF (linefeed), +the Windows form using the ASCII sequence CR LF (return followed by linefeed), +or the old Macintosh form using the ASCII CR (return) character. All of these +forms can be used equally, regardless of platform. The end of input also serves +as an implicit terminator for the final physical line.

    +

    When embedding Python, source code strings should be passed to Python APIs using +the standard C conventions for newline characters (the \n character, +representing ASCII LF, is the line terminator).

    +
    +
    +

    2.1.3. Comments

    +

    A comment starts with a hash character (#) that is not part of a string +literal, and ends at the end of the physical line. A comment signifies the end +of the logical line unless the implicit line joining rules are invoked. Comments +are ignored by the syntax.

    +
    +
    +

    2.1.4. Encoding declarations

    +

    If a comment in the first or second line of the Python script matches the +regular expression coding[=:]\s*([-\w.]+), this comment is processed as an +encoding declaration; the first group of this expression names the encoding of +the source code file. The encoding declaration must appear on a line of its +own. If it is the second line, the first line must also be a comment-only line. +The recommended forms of an encoding expression are

    +
    # -*- coding: <encoding-name> -*-
    +
    +
    +

    which is recognized also by GNU Emacs, and

    +
    # vim:fileencoding=<encoding-name>
    +
    +
    +

    which is recognized by Bram Moolenaar’s VIM.

    +

    If no encoding declaration is found, the default encoding is UTF-8. In +addition, if the first bytes of the file are the UTF-8 byte-order mark +(b'\xef\xbb\xbf'), the declared file encoding is UTF-8 (this is supported, +among others, by Microsoft’s notepad).

    +

    If an encoding is declared, the encoding name must be recognized by Python. The +encoding is used for all lexical analysis, including string literals, comments +and identifiers.

    +
    +
    +

    2.1.5. Explicit line joining

    +

    Two or more physical lines may be joined into logical lines using backslash +characters (\), as follows: when a physical line ends in a backslash that is +not part of a string literal or comment, it is joined with the following forming +a single logical line, deleting the backslash and the following end-of-line +character. For example:

    +
    if 1900 < year < 2100 and 1 <= month <= 12 \
    +   and 1 <= day <= 31 and 0 <= hour < 24 \
    +   and 0 <= minute < 60 and 0 <= second < 60:   # Looks like a valid date
    +        return 1
    +
    +
    +

    A line ending in a backslash cannot carry a comment. A backslash does not +continue a comment. A backslash does not continue a token except for string +literals (i.e., tokens other than string literals cannot be split across +physical lines using a backslash). A backslash is illegal elsewhere on a line +outside a string literal.

    +
    +
    +

    2.1.6. Implicit line joining

    +

    Expressions in parentheses, square brackets or curly braces can be split over +more than one physical line without using backslashes. For example:

    +
    month_names = ['Januari', 'Februari', 'Maart',      # These are the
    +               'April',   'Mei',      'Juni',       # Dutch names
    +               'Juli',    'Augustus', 'September',  # for the months
    +               'Oktober', 'November', 'December']   # of the year
    +
    +
    +

    Implicitly continued lines can carry comments. The indentation of the +continuation lines is not important. Blank continuation lines are allowed. +There is no NEWLINE token between implicit continuation lines. Implicitly +continued lines can also occur within triple-quoted strings (see below); in that +case they cannot carry comments.

    +
    +
    +

    2.1.7. Blank lines

    +

    A logical line that contains only spaces, tabs, formfeeds and possibly a +comment, is ignored (i.e., no NEWLINE token is generated). During interactive +input of statements, handling of a blank line may differ depending on the +implementation of the read-eval-print loop. In the standard interactive +interpreter, an entirely blank logical line (i.e. one containing not even +whitespace or a comment) terminates a multi-line statement.

    +
    +
    +

    2.1.8. Indentation

    +

    Leading whitespace (spaces and tabs) at the beginning of a logical line is used +to compute the indentation level of the line, which in turn is used to determine +the grouping of statements.

    +

    Tabs are replaced (from left to right) by one to eight spaces such that the +total number of characters up to and including the replacement is a multiple of +eight (this is intended to be the same rule as used by Unix). The total number +of spaces preceding the first non-blank character then determines the line’s +indentation. Indentation cannot be split over multiple physical lines using +backslashes; the whitespace up to the first backslash determines the +indentation.

    +

    Indentation is rejected as inconsistent if a source file mixes tabs and spaces +in a way that makes the meaning dependent on the worth of a tab in spaces; a +TabError is raised in that case.

    +

    Cross-platform compatibility note: because of the nature of text editors on +non-UNIX platforms, it is unwise to use a mixture of spaces and tabs for the +indentation in a single source file. It should also be noted that different +platforms may explicitly limit the maximum indentation level.

    +

    A formfeed character may be present at the start of the line; it will be ignored +for the indentation calculations above. Formfeed characters occurring elsewhere +in the leading whitespace have an undefined effect (for instance, they may reset +the space count to zero).

    +

    The indentation levels of consecutive lines are used to generate INDENT and +DEDENT tokens, using a stack, as follows.

    +

    Before the first line of the file is read, a single zero is pushed on the stack; +this will never be popped off again. The numbers pushed on the stack will +always be strictly increasing from bottom to top. At the beginning of each +logical line, the line’s indentation level is compared to the top of the stack. +If it is equal, nothing happens. If it is larger, it is pushed on the stack, and +one INDENT token is generated. If it is smaller, it must be one of the +numbers occurring on the stack; all numbers on the stack that are larger are +popped off, and for each number popped off a DEDENT token is generated. At the +end of the file, a DEDENT token is generated for each number remaining on the +stack that is larger than zero.

    +

    Here is an example of a correctly (though confusingly) indented piece of Python +code:

    +
    def perm(l):
    +        # Compute the list of all permutations of l
    +    if len(l) <= 1:
    +                  return [l]
    +    r = []
    +    for i in range(len(l)):
    +             s = l[:i] + l[i+1:]
    +             p = perm(s)
    +             for x in p:
    +              r.append(l[i:i+1] + x)
    +    return r
    +
    +
    +

    The following example shows various indentation errors:

    +
     def perm(l):                       # error: first line indented
    +for i in range(len(l)):             # error: not indented
    +    s = l[:i] + l[i+1:]
    +        p = perm(l[:i] + l[i+1:])   # error: unexpected indent
    +        for x in p:
    +                r.append(l[i:i+1] + x)
    +            return r                # error: inconsistent dedent
    +
    +
    +

    (Actually, the first three errors are detected by the parser; only the last +error is found by the lexical analyzer — the indentation of return r does +not match a level popped off the stack.)

    +
    +
    +

    2.1.9. Whitespace between tokens

    +

    Except at the beginning of a logical line or in string literals, the whitespace +characters space, tab and formfeed can be used interchangeably to separate +tokens. Whitespace is needed between two tokens only if their concatenation +could otherwise be interpreted as a different token (e.g., ab is one token, but +a b is two tokens).

    +
    +
    +
    +

    2.2. Other tokens

    +

    Besides NEWLINE, INDENT and DEDENT, the following categories of tokens exist: +identifiers, keywords, literals, operators, and delimiters. Whitespace +characters (other than line terminators, discussed earlier) are not tokens, but +serve to delimit tokens. Where ambiguity exists, a token comprises the longest +possible string that forms a legal token, when read from left to right.

    +
    +
    +

    2.3. Identifiers and keywords

    +

    Identifiers (also referred to as names) are described by the following lexical +definitions.

    +

    The syntax of identifiers in Python is based on the Unicode standard annex +UAX-31, with elaboration and changes as defined below; see also PEP 3131 for +further details.

    +

    Within the ASCII range (U+0001..U+007F), the valid characters for identifiers +are the same as in Python 2.x: the uppercase and lowercase letters A through +Z, the underscore _ and, except for the first character, the digits +0 through 9.

    +

    Python 3.0 introduces additional characters from outside the ASCII range (see +PEP 3131). For these characters, the classification uses the version of the +Unicode Character Database as included in the unicodedata module.

    +

    Identifiers are unlimited in length. Case is significant.

    +
    +identifier   ::=  xid_start xid_continue*
    +id_start     ::=  <all characters in general categories Lu, Ll, Lt, Lm, Lo, Nl, the underscore, and characters with the Other_ID_Start property>
    +id_continue  ::=  <all characters in id_start, plus characters in the categories Mn, Mc, Nd, Pc and others with the Other_ID_Continue property>
    +xid_start    ::=  <all characters in id_start whose NFKC normalization is in "id_start xid_continue*">
    +xid_continue ::=  <all characters in id_continue whose NFKC normalization is in "id_continue*">
    +
    +

    The Unicode category codes mentioned above stand for:

    +
      +
    • Lu - uppercase letters

    • +
    • Ll - lowercase letters

    • +
    • Lt - titlecase letters

    • +
    • Lm - modifier letters

    • +
    • Lo - other letters

    • +
    • Nl - letter numbers

    • +
    • Mn - nonspacing marks

    • +
    • Mc - spacing combining marks

    • +
    • Nd - decimal numbers

    • +
    • Pc - connector punctuations

    • +
    • Other_ID_Start - explicit list of characters in PropList.txt to support backwards +compatibility

    • +
    • Other_ID_Continue - likewise

    • +
    +

    All identifiers are converted into the normal form NFKC while parsing; comparison +of identifiers is based on NFKC.

    +

    A non-normative HTML file listing all valid identifier characters for Unicode +4.1 can be found at +https://www.dcl.hpi.uni-potsdam.de/home/loewis/table-3131.html.

    +
    +

    2.3.1. Keywords

    +

    The following identifiers are used as reserved words, or keywords of the +language, and cannot be used as ordinary identifiers. They must be spelled +exactly as written here:

    +
    False      await      else       import     pass
    +None       break      except     in         raise
    +True       class      finally    is         return
    +and        continue   for        lambda     try
    +as         def        from       nonlocal   while
    +assert     del        global     not        with
    +async      elif       if         or         yield
    +
    +
    +
    +
    +

    2.3.2. Reserved classes of identifiers

    +

    Certain classes of identifiers (besides keywords) have special meanings. These +classes are identified by the patterns of leading and trailing underscore +characters:

    +
    +
    _*

    Not imported by from module import *. The special identifier _ is used +in the interactive interpreter to store the result of the last evaluation; it is +stored in the builtins module. When not in interactive mode, _ +has no special meaning and is not defined. See section The import statement.

    +
    +

    Note

    +

    The name _ is often used in conjunction with internationalization; +refer to the documentation for the gettext module for more +information on this convention.

    +
    +
    +
    __*__

    System-defined names. These names are defined by the interpreter and its +implementation (including the standard library). Current system names are +discussed in the Special method names section and elsewhere. More will likely +be defined in future versions of Python. Any use of __*__ names, in +any context, that does not follow explicitly documented use, is subject to +breakage without warning.

    +
    +
    __*

    Class-private names. Names in this category, when used within the context of a +class definition, are re-written to use a mangled form to help avoid name +clashes between “private” attributes of base and derived classes. See section +Identifiers (Names).

    +
    +
    +
    +
    +
    +

    2.4. Literals

    +

    Literals are notations for constant values of some built-in types.

    +
    +

    2.4.1. String and Bytes literals

    +

    String literals are described by the following lexical definitions:

    +
    +stringliteral   ::=  [stringprefix](shortstring | longstring)
    +stringprefix    ::=  "r" | "u" | "R" | "U" | "f" | "F"
    +                     | "fr" | "Fr" | "fR" | "FR" | "rf" | "rF" | "Rf" | "RF"
    +shortstring     ::=  "'" shortstringitem* "'" | '"' shortstringitem* '"'
    +longstring      ::=  "'''" longstringitem* "'''" | '"""' longstringitem* '"""'
    +shortstringitem ::=  shortstringchar | stringescapeseq
    +longstringitem  ::=  longstringchar | stringescapeseq
    +shortstringchar ::=  <any source character except "\" or newline or the quote>
    +longstringchar  ::=  <any source character except "\">
    +stringescapeseq ::=  "\" <any source character>
    +
    +
    +bytesliteral   ::=  bytesprefix(shortbytes | longbytes)
    +bytesprefix    ::=  "b" | "B" | "br" | "Br" | "bR" | "BR" | "rb" | "rB" | "Rb" | "RB"
    +shortbytes     ::=  "'" shortbytesitem* "'" | '"' shortbytesitem* '"'
    +longbytes      ::=  "'''" longbytesitem* "'''" | '"""' longbytesitem* '"""'
    +shortbytesitem ::=  shortbyteschar | bytesescapeseq
    +longbytesitem  ::=  longbyteschar | bytesescapeseq
    +shortbyteschar ::=  <any ASCII character except "\" or newline or the quote>
    +longbyteschar  ::=  <any ASCII character except "\">
    +bytesescapeseq ::=  "\" <any ASCII character>
    +
    +

    One syntactic restriction not indicated by these productions is that whitespace +is not allowed between the stringprefix or bytesprefix and the +rest of the literal. The source character set is defined by the encoding +declaration; it is UTF-8 if no encoding declaration is given in the source file; +see section Encoding declarations.

    +

    In plain English: Both types of literals can be enclosed in matching single quotes +(') or double quotes ("). They can also be enclosed in matching groups +of three single or double quotes (these are generally referred to as +triple-quoted strings). The backslash (\) character is used to escape +characters that otherwise have a special meaning, such as newline, backslash +itself, or the quote character.

    +

    Bytes literals are always prefixed with 'b' or 'B'; they produce an +instance of the bytes type instead of the str type. They +may only contain ASCII characters; bytes with a numeric value of 128 or greater +must be expressed with escapes.

    +

    Both string and bytes literals may optionally be prefixed with a letter 'r' +or 'R'; such strings are called raw strings and treat backslashes as +literal characters. As a result, in string literals, '\U' and '\u' +escapes in raw strings are not treated specially. Given that Python 2.x’s raw +unicode literals behave differently than Python 3.x’s the 'ur' syntax +is not supported.

    +
    +

    New in version 3.3: The 'rb' prefix of raw bytes literals has been added as a synonym +of 'br'.

    +
    +
    +

    New in version 3.3: Support for the unicode legacy literal (u'value') was reintroduced +to simplify the maintenance of dual Python 2.x and 3.x codebases. +See PEP 414 for more information.

    +
    +

    A string literal with 'f' or 'F' in its prefix is a +formatted string literal; see Formatted string literals. The 'f' may be +combined with 'r', but not with 'b' or 'u', therefore raw +formatted strings are possible, but formatted bytes literals are not.

    +

    In triple-quoted literals, unescaped newlines and quotes are allowed (and are +retained), except that three unescaped quotes in a row terminate the literal. (A +“quote” is the character used to open the literal, i.e. either ' or ".)

    +

    Unless an 'r' or 'R' prefix is present, escape sequences in string and +bytes literals are interpreted according to rules similar to those used by +Standard C. The recognized escape sequences are:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Escape Sequence

    Meaning

    Notes

    \newline

    Backslash and newline ignored

    \\

    Backslash (\)

    \'

    Single quote (')

    \"

    Double quote (")

    \a

    ASCII Bell (BEL)

    \b

    ASCII Backspace (BS)

    \f

    ASCII Formfeed (FF)

    \n

    ASCII Linefeed (LF)

    \r

    ASCII Carriage Return (CR)

    \t

    ASCII Horizontal Tab (TAB)

    \v

    ASCII Vertical Tab (VT)

    \ooo

    Character with octal value +ooo

    (1,3)

    \xhh

    Character with hex value hh

    (2,3)

    +

    Escape sequences only recognized in string literals are:

    + +++++ + + + + + + + + + + + + + + + + + + + + +

    Escape Sequence

    Meaning

    Notes

    \N{name}

    Character named name in the +Unicode database

    (4)

    \uxxxx

    Character with 16-bit hex value +xxxx

    (5)

    \Uxxxxxxxx

    Character with 32-bit hex value +xxxxxxxx

    (6)

    +

    Notes:

    +
      +
    1. As in Standard C, up to three octal digits are accepted.

    2. +
    3. Unlike in Standard C, exactly two hex digits are required.

    4. +
    5. In a bytes literal, hexadecimal and octal escapes denote the byte with the +given value. In a string literal, these escapes denote a Unicode character +with the given value.

    6. +
    7. +

      Changed in version 3.3: Support for name aliases 1 has been added.

      +
      +
    8. +
    9. Exactly four hex digits are required.

    10. +
    11. Any Unicode character can be encoded this way. Exactly eight hex digits +are required.

    12. +
    +

    Unlike Standard C, all unrecognized escape sequences are left in the string +unchanged, i.e., the backslash is left in the result. (This behavior is +useful when debugging: if an escape sequence is mistyped, the resulting output +is more easily recognized as broken.) It is also important to note that the +escape sequences only recognized in string literals fall into the category of +unrecognized escapes for bytes literals.

    +
    +
    +

    Changed in version 3.6: Unrecognized escape sequences produce a DeprecationWarning. In +some future version of Python they will be a SyntaxError.

    +
    +
    +

    Even in a raw literal, quotes can be escaped with a backslash, but the +backslash remains in the result; for example, r"\"" is a valid string +literal consisting of two characters: a backslash and a double quote; r"\" +is not a valid string literal (even a raw string cannot end in an odd number of +backslashes). Specifically, a raw literal cannot end in a single backslash +(since the backslash would escape the following quote character). Note also +that a single backslash followed by a newline is interpreted as those two +characters as part of the literal, not as a line continuation.

    +
    +
    +

    2.4.2. String literal concatenation

    +

    Multiple adjacent string or bytes literals (delimited by whitespace), possibly +using different quoting conventions, are allowed, and their meaning is the same +as their concatenation. Thus, "hello" 'world' is equivalent to +"helloworld". This feature can be used to reduce the number of backslashes +needed, to split long strings conveniently across long lines, or even to add +comments to parts of strings, for example:

    +
    re.compile("[A-Za-z_]"       # letter or underscore
    +           "[A-Za-z0-9_]*"   # letter, digit or underscore
    +          )
    +
    +
    +

    Note that this feature is defined at the syntactical level, but implemented at +compile time. The ‘+’ operator must be used to concatenate string expressions +at run time. Also note that literal concatenation can use different quoting +styles for each component (even mixing raw strings and triple quoted strings), +and formatted string literals may be concatenated with plain string literals.

    +
    +
    +

    2.4.3. Formatted string literals

    +
    +

    New in version 3.6.

    +
    +

    A formatted string literal or f-string is a string literal +that is prefixed with 'f' or 'F'. These strings may contain +replacement fields, which are expressions delimited by curly braces {}. +While other string literals always have a constant value, formatted strings +are really expressions evaluated at run time.

    +

    Escape sequences are decoded like in ordinary string literals (except when +a literal is also marked as a raw string). After decoding, the grammar +for the contents of the string is:

    +
    +f_string          ::=  (literal_char | "{{" | "}}" | replacement_field)*
    +replacement_field ::=  "{" f_expression ["!" conversion] [":" format_spec] "}"
    +f_expression      ::=  (conditional_expression | "*" or_expr)
    +                         ("," conditional_expression | "," "*" or_expr)* [","]
    +                       | yield_expression
    +conversion        ::=  "s" | "r" | "a"
    +format_spec       ::=  (literal_char | NULL | replacement_field)*
    +literal_char      ::=  <any code point except "{", "}" or NULL>
    +
    +

    The parts of the string outside curly braces are treated literally, +except that any doubled curly braces '{{' or '}}' are replaced +with the corresponding single curly brace. A single opening curly +bracket '{' marks a replacement field, which starts with a +Python expression. After the expression, there may be a conversion field, +introduced by an exclamation point '!'. A format specifier may also +be appended, introduced by a colon ':'. A replacement field ends +with a closing curly bracket '}'.

    +

    Expressions in formatted string literals are treated like regular +Python expressions surrounded by parentheses, with a few exceptions. +An empty expression is not allowed, and a lambda expression +must be surrounded by explicit parentheses. Replacement expressions +can contain line breaks (e.g. in triple-quoted strings), but they +cannot contain comments. Each expression is evaluated in the context +where the formatted string literal appears, in order from left to right.

    +

    If a conversion is specified, the result of evaluating the expression +is converted before formatting. Conversion '!s' calls str() on +the result, '!r' calls repr(), and '!a' calls ascii().

    +

    The result is then formatted using the format() protocol. The +format specifier is passed to the __format__() method of the +expression or conversion result. An empty string is passed when the +format specifier is omitted. The formatted result is then included in +the final value of the whole string.

    +

    Top-level format specifiers may include nested replacement fields. These nested +fields may include their own conversion fields and format specifiers, but may not include more deeply-nested replacement fields. The +format specifier mini-language is the same as that used by +the string .format() method.

    +

    Formatted string literals may be concatenated, but replacement fields +cannot be split across literals.

    +

    Some examples of formatted string literals:

    +
    >>> name = "Fred"
    +>>> f"He said his name is {name!r}."
    +"He said his name is 'Fred'."
    +>>> f"He said his name is {repr(name)}."  # repr() is equivalent to !r
    +"He said his name is 'Fred'."
    +>>> width = 10
    +>>> precision = 4
    +>>> value = decimal.Decimal("12.34567")
    +>>> f"result: {value:{width}.{precision}}"  # nested fields
    +'result:      12.35'
    +>>> today = datetime(year=2017, month=1, day=27)
    +>>> f"{today:%B %d, %Y}"  # using date format specifier
    +'January 27, 2017'
    +>>> number = 1024
    +>>> f"{number:#0x}"  # using integer format specifier
    +'0x400'
    +
    +
    +

    A consequence of sharing the same syntax as regular string literals is +that characters in the replacement fields must not conflict with the +quoting used in the outer formatted string literal:

    +
    f"abc {a["x"]} def"    # error: outer string literal ended prematurely
    +f"abc {a['x']} def"    # workaround: use different quoting
    +
    +
    +

    Backslashes are not allowed in format expressions and will raise +an error:

    +
    f"newline: {ord('\n')}"  # raises SyntaxError
    +
    +
    +

    To include a value in which a backslash escape is required, create +a temporary variable.

    +
    >>> newline = ord('\n')
    +>>> f"newline: {newline}"
    +'newline: 10'
    +
    +
    +

    Formatted string literals cannot be used as docstrings, even if they do not +include expressions.

    +
    >>> def foo():
    +...     f"Not a docstring"
    +...
    +>>> foo.__doc__ is None
    +True
    +
    +
    +

    See also PEP 498 for the proposal that added formatted string literals, +and str.format(), which uses a related format string mechanism.

    +
    +
    +

    2.4.4. Numeric literals

    +

    There are three types of numeric literals: integers, floating point numbers, and +imaginary numbers. There are no complex literals (complex numbers can be formed +by adding a real number and an imaginary number).

    +

    Note that numeric literals do not include a sign; a phrase like -1 is +actually an expression composed of the unary operator ‘-‘ and the literal +1.

    +
    +
    +

    2.4.5. Integer literals

    +

    Integer literals are described by the following lexical definitions:

    +
    +integer      ::=  decinteger | bininteger | octinteger | hexinteger
    +decinteger   ::=  nonzerodigit (["_"] digit)* | "0"+ (["_"] "0")*
    +bininteger   ::=  "0" ("b" | "B") (["_"] bindigit)+
    +octinteger   ::=  "0" ("o" | "O") (["_"] octdigit)+
    +hexinteger   ::=  "0" ("x" | "X") (["_"] hexdigit)+
    +nonzerodigit ::=  "1"..."9"
    +digit        ::=  "0"..."9"
    +bindigit     ::=  "0" | "1"
    +octdigit     ::=  "0"..."7"
    +hexdigit     ::=  digit | "a"..."f" | "A"..."F"
    +
    +

    There is no limit for the length of integer literals apart from what can be +stored in available memory.

    +

    Underscores are ignored for determining the numeric value of the literal. They +can be used to group digits for enhanced readability. One underscore can occur +between digits, and after base specifiers like 0x.

    +

    Note that leading zeros in a non-zero decimal number are not allowed. This is +for disambiguation with C-style octal literals, which Python used before version +3.0.

    +

    Some examples of integer literals:

    +
    7     2147483647                        0o177    0b100110111
    +3     79228162514264337593543950336     0o377    0xdeadbeef
    +      100_000_000_000                   0b_1110_0101
    +
    +
    +
    +

    Changed in version 3.6: Underscores are now allowed for grouping purposes in literals.

    +
    +
    +
    +

    2.4.6. Floating point literals

    +

    Floating point literals are described by the following lexical definitions:

    +
    +floatnumber   ::=  pointfloat | exponentfloat
    +pointfloat    ::=  [digitpart] fraction | digitpart "."
    +exponentfloat ::=  (digitpart | pointfloat) exponent
    +digitpart     ::=  digit (["_"] digit)*
    +fraction      ::=  "." digitpart
    +exponent      ::=  ("e" | "E") ["+" | "-"] digitpart
    +
    +

    Note that the integer and exponent parts are always interpreted using radix 10. +For example, 077e010 is legal, and denotes the same number as 77e10. The +allowed range of floating point literals is implementation-dependent. As in +integer literals, underscores are supported for digit grouping.

    +

    Some examples of floating point literals:

    +
    3.14    10.    .001    1e100    3.14e-10    0e0    3.14_15_93
    +
    +
    +
    +

    Changed in version 3.6: Underscores are now allowed for grouping purposes in literals.

    +
    +
    +
    +

    2.4.7. Imaginary literals

    +

    Imaginary literals are described by the following lexical definitions:

    +
    +imagnumber ::=  (floatnumber | digitpart) ("j" | "J")
    +
    +

    An imaginary literal yields a complex number with a real part of 0.0. Complex +numbers are represented as a pair of floating point numbers and have the same +restrictions on their range. To create a complex number with a nonzero real +part, add a floating point number to it, e.g., (3+4j). Some examples of +imaginary literals:

    +
    3.14j   10.j    10j     .001j   1e100j   3.14e-10j   3.14_15_93j
    +
    +
    +
    +
    +
    +

    2.5. Operators

    +

    The following tokens are operators:

    +
    +       -       *       **      /       //      %      @
    +<<      >>      &       |       ^       ~
    +<       >       <=      >=      ==      !=
    +
    +
    +
    +
    +

    2.6. Delimiters

    +

    The following tokens serve as delimiters in the grammar:

    +
    (       )       [       ]       {       }
    +,       :       .       ;       @       =       ->
    ++=      -=      *=      /=      //=     %=      @=
    +&=      |=      ^=      >>=     <<=     **=
    +
    +
    +

    The period can also occur in floating-point and imaginary literals. A sequence +of three periods has a special meaning as an ellipsis literal. The second half +of the list, the augmented assignment operators, serve lexically as delimiters, +but also perform an operation.

    +

    The following printing ASCII characters have special meaning as part of other +tokens or are otherwise significant to the lexical analyzer:

    +
    '       "       #       \
    +
    +
    +

    The following printing ASCII characters are not used in Python. Their +occurrence outside string literals and comments is an unconditional error:

    +
    $       ?       `
    +
    +
    +

    Footnotes

    +
    +
    1
    +

    http://www.unicode.org/Public/11.0.0/ucd/NameAliases.txt

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/reference/simple_stmts.html b/python-3.7.4-docs-html/reference/simple_stmts.html new file mode 100644 index 0000000..f5dc94f --- /dev/null +++ b/python-3.7.4-docs-html/reference/simple_stmts.html @@ -0,0 +1,903 @@ + + + + + + + 7. Simple statements — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    7. Simple statements

    +

    A simple statement is comprised within a single logical line. Several simple +statements may occur on a single line separated by semicolons. The syntax for +simple statements is:

    +
    +simple_stmt ::=  expression_stmt
    +                 | assert_stmt
    +                 | assignment_stmt
    +                 | augmented_assignment_stmt
    +                 | annotated_assignment_stmt
    +                 | pass_stmt
    +                 | del_stmt
    +                 | return_stmt
    +                 | yield_stmt
    +                 | raise_stmt
    +                 | break_stmt
    +                 | continue_stmt
    +                 | import_stmt
    +                 | future_stmt
    +                 | global_stmt
    +                 | nonlocal_stmt
    +
    +
    +

    7.1. Expression statements

    +

    Expression statements are used (mostly interactively) to compute and write a +value, or (usually) to call a procedure (a function that returns no meaningful +result; in Python, procedures return the value None). Other uses of +expression statements are allowed and occasionally useful. The syntax for an +expression statement is:

    +
    +expression_stmt ::=  starred_expression
    +
    +

    An expression statement evaluates the expression list (which may be a single +expression).

    +

    In interactive mode, if the value is not None, it is converted to a string +using the built-in repr() function and the resulting string is written to +standard output on a line by itself (except if the result is None, so that +procedure calls do not cause any output.)

    +
    +
    +

    7.2. Assignment statements

    +

    Assignment statements are used to (re)bind names to values and to modify +attributes or items of mutable objects:

    +
    +assignment_stmt ::=  (target_list "=")+ (starred_expression | yield_expression)
    +target_list     ::=  target ("," target)* [","]
    +target          ::=  identifier
    +                     | "(" [target_list] ")"
    +                     | "[" [target_list] "]"
    +                     | attributeref
    +                     | subscription
    +                     | slicing
    +                     | "*" target
    +
    +

    (See section Primaries for the syntax definitions for attributeref, +subscription, and slicing.)

    +

    An assignment statement evaluates the expression list (remember that this can be +a single expression or a comma-separated list, the latter yielding a tuple) and +assigns the single resulting object to each of the target lists, from left to +right.

    +

    Assignment is defined recursively depending on the form of the target (list). +When a target is part of a mutable object (an attribute reference, subscription +or slicing), the mutable object must ultimately perform the assignment and +decide about its validity, and may raise an exception if the assignment is +unacceptable. The rules observed by various types and the exceptions raised are +given with the definition of the object types (see section The standard type hierarchy).

    +

    Assignment of an object to a target list, optionally enclosed in parentheses or +square brackets, is recursively defined as follows.

    +
      +
    • If the target list is a single target with no trailing comma, +optionally in parentheses, the object is assigned to that target.

    • +
    • Else: The object must be an iterable with the same number of +items as there are targets in the target list, and the items are assigned, +from left to right, to the corresponding targets.

      +
        +
      • If the target list contains one target prefixed with an asterisk, called a +“starred” target: The object must be an iterable with at least as many items +as there are targets in the target list, minus one. The first items of the +iterable are assigned, from left to right, to the targets before the starred +target. The final items of the iterable are assigned to the targets after +the starred target. A list of the remaining items in the iterable is then +assigned to the starred target (the list can be empty).

      • +
      • Else: The object must be an iterable with the same number of items as there +are targets in the target list, and the items are assigned, from left to +right, to the corresponding targets.

      • +
      +
    • +
    +

    Assignment of an object to a single target is recursively defined as follows.

    +
      +
    • If the target is an identifier (name):

      +
        +
      • If the name does not occur in a global or nonlocal +statement in the current code block: the name is bound to the object in the +current local namespace.

      • +
      • Otherwise: the name is bound to the object in the global namespace or the +outer namespace determined by nonlocal, respectively.

      • +
      +

      The name is rebound if it was already bound. This may cause the reference +count for the object previously bound to the name to reach zero, causing the +object to be deallocated and its destructor (if it has one) to be called.

      +
    • +
    • If the target is an attribute reference: The primary expression in the +reference is evaluated. It should yield an object with assignable attributes; +if this is not the case, TypeError is raised. That object is then +asked to assign the assigned object to the given attribute; if it cannot +perform the assignment, it raises an exception (usually but not necessarily +AttributeError).

      +

      Note: If the object is a class instance and the attribute reference occurs on +both sides of the assignment operator, the RHS expression, a.x can access +either an instance attribute or (if no instance attribute exists) a class +attribute. The LHS target a.x is always set as an instance attribute, +creating it if necessary. Thus, the two occurrences of a.x do not +necessarily refer to the same attribute: if the RHS expression refers to a +class attribute, the LHS creates a new instance attribute as the target of the +assignment:

      +
      class Cls:
      +    x = 3             # class variable
      +inst = Cls()
      +inst.x = inst.x + 1   # writes inst.x as 4 leaving Cls.x as 3
      +
      +
      +

      This description does not necessarily apply to descriptor attributes, such as +properties created with property().

      +
    • +
    • If the target is a subscription: The primary expression in the reference is +evaluated. It should yield either a mutable sequence object (such as a list) +or a mapping object (such as a dictionary). Next, the subscript expression is +evaluated.

      +

      If the primary is a mutable sequence object (such as a list), the subscript +must yield an integer. If it is negative, the sequence’s length is added to +it. The resulting value must be a nonnegative integer less than the +sequence’s length, and the sequence is asked to assign the assigned object to +its item with that index. If the index is out of range, IndexError is +raised (assignment to a subscripted sequence cannot add new items to a list).

      +

      If the primary is a mapping object (such as a dictionary), the subscript must +have a type compatible with the mapping’s key type, and the mapping is then +asked to create a key/datum pair which maps the subscript to the assigned +object. This can either replace an existing key/value pair with the same key +value, or insert a new key/value pair (if no key with the same value existed).

      +

      For user-defined objects, the __setitem__() method is called with +appropriate arguments.

      +
    • +
    • If the target is a slicing: The primary expression in the reference is +evaluated. It should yield a mutable sequence object (such as a list). The +assigned object should be a sequence object of the same type. Next, the lower +and upper bound expressions are evaluated, insofar they are present; defaults +are zero and the sequence’s length. The bounds should evaluate to integers. +If either bound is negative, the sequence’s length is added to it. The +resulting bounds are clipped to lie between zero and the sequence’s length, +inclusive. Finally, the sequence object is asked to replace the slice with +the items of the assigned sequence. The length of the slice may be different +from the length of the assigned sequence, thus changing the length of the +target sequence, if the target sequence allows it.

    • +
    +
    +

    CPython implementation detail: In the current implementation, the syntax for targets is taken to be the same +as for expressions, and invalid syntax is rejected during the code generation +phase, causing less detailed error messages.

    +
    +

    Although the definition of assignment implies that overlaps between the +left-hand side and the right-hand side are ‘simultaneous’ (for example a, b = +b, a swaps two variables), overlaps within the collection of assigned-to +variables occur left-to-right, sometimes resulting in confusion. For instance, +the following program prints [0, 2]:

    +
    x = [0, 1]
    +i = 0
    +i, x[i] = 1, 2         # i is updated, then x[i] is updated
    +print(x)
    +
    +
    +
    +

    See also

    +
    +
    PEP 3132 - Extended Iterable Unpacking

    The specification for the *target feature.

    +
    +
    +
    +
    +

    7.2.1. Augmented assignment statements

    +

    Augmented assignment is the combination, in a single statement, of a binary +operation and an assignment statement:

    +
    +augmented_assignment_stmt ::=  augtarget augop (expression_list | yield_expression)
    +augtarget                 ::=  identifier | attributeref | subscription | slicing
    +augop                     ::=  "+=" | "-=" | "*=" | "@=" | "/=" | "//=" | "%=" | "**="
    +                               | ">>=" | "<<=" | "&=" | "^=" | "|="
    +
    +

    (See section Primaries for the syntax definitions of the last three +symbols.)

    +

    An augmented assignment evaluates the target (which, unlike normal assignment +statements, cannot be an unpacking) and the expression list, performs the binary +operation specific to the type of assignment on the two operands, and assigns +the result to the original target. The target is only evaluated once.

    +

    An augmented assignment expression like x += 1 can be rewritten as x = x + +1 to achieve a similar, but not exactly equal effect. In the augmented +version, x is only evaluated once. Also, when possible, the actual operation +is performed in-place, meaning that rather than creating a new object and +assigning that to the target, the old object is modified instead.

    +

    Unlike normal assignments, augmented assignments evaluate the left-hand side +before evaluating the right-hand side. For example, a[i] += f(x) first +looks-up a[i], then it evaluates f(x) and performs the addition, and +lastly, it writes the result back to a[i].

    +

    With the exception of assigning to tuples and multiple targets in a single +statement, the assignment done by augmented assignment statements is handled the +same way as normal assignments. Similarly, with the exception of the possible +in-place behavior, the binary operation performed by augmented assignment is +the same as the normal binary operations.

    +

    For targets which are attribute references, the same caveat about class +and instance attributes applies as for regular assignments.

    +
    +
    +

    7.2.2. Annotated assignment statements

    +

    Annotation assignment is the combination, in a single +statement, of a variable or attribute annotation and an optional assignment statement:

    +
    +annotated_assignment_stmt ::=  augtarget ":" expression ["=" expression]
    +
    +

    The difference from normal Assignment statements is that only single target and +only single right hand side value is allowed.

    +

    For simple names as assignment targets, if in class or module scope, +the annotations are evaluated and stored in a special class or module +attribute __annotations__ +that is a dictionary mapping from variable names (mangled if private) to +evaluated annotations. This attribute is writable and is automatically +created at the start of class or module body execution, if annotations +are found statically.

    +

    For expressions as assignment targets, the annotations are evaluated if +in class or module scope, but not stored.

    +

    If a name is annotated in a function scope, then this name is local for +that scope. Annotations are never evaluated and stored in function scopes.

    +

    If the right hand side is present, an annotated +assignment performs the actual assignment before evaluating annotations +(where applicable). If the right hand side is not present for an expression +target, then the interpreter evaluates the target except for the last +__setitem__() or __setattr__() call.

    +
    +

    See also

    +
    +
    PEP 526 - Syntax for Variable Annotations

    The proposal that added syntax for annotating the types of variables +(including class variables and instance variables), instead of expressing +them through comments.

    +
    +
    PEP 484 - Type hints

    The proposal that added the typing module to provide a standard +syntax for type annotations that can be used in static analysis tools and +IDEs.

    +
    +
    +
    +
    +
    +
    +

    7.3. The assert statement

    +

    Assert statements are a convenient way to insert debugging assertions into a +program:

    +
    +assert_stmt ::=  "assert" expression ["," expression]
    +
    +

    The simple form, assert expression, is equivalent to

    +
    if __debug__:
    +    if not expression: raise AssertionError
    +
    +
    +

    The extended form, assert expression1, expression2, is equivalent to

    +
    if __debug__:
    +    if not expression1: raise AssertionError(expression2)
    +
    +
    +

    These equivalences assume that __debug__ and AssertionError refer to +the built-in variables with those names. In the current implementation, the +built-in variable __debug__ is True under normal circumstances, +False when optimization is requested (command line option -O). The current +code generator emits no code for an assert statement when optimization is +requested at compile time. Note that it is unnecessary to include the source +code for the expression that failed in the error message; it will be displayed +as part of the stack trace.

    +

    Assignments to __debug__ are illegal. The value for the built-in variable +is determined when the interpreter starts.

    +
    +
    +

    7.4. The pass statement

    +
    +pass_stmt ::=  "pass"
    +
    +

    pass is a null operation — when it is executed, nothing happens. +It is useful as a placeholder when a statement is required syntactically, but no +code needs to be executed, for example:

    +
    def f(arg): pass    # a function that does nothing (yet)
    +
    +class C: pass       # a class with no methods (yet)
    +
    +
    +
    +
    +

    7.5. The del statement

    +
    +del_stmt ::=  "del" target_list
    +
    +

    Deletion is recursively defined very similar to the way assignment is defined. +Rather than spelling it out in full details, here are some hints.

    +

    Deletion of a target list recursively deletes each target, from left to right.

    +

    Deletion of a name removes the binding of that name from the local or global +namespace, depending on whether the name occurs in a global statement +in the same code block. If the name is unbound, a NameError exception +will be raised.

    +

    Deletion of attribute references, subscriptions and slicings is passed to the +primary object involved; deletion of a slicing is in general equivalent to +assignment of an empty slice of the right type (but even this is determined by +the sliced object).

    +
    +

    Changed in version 3.2: Previously it was illegal to delete a name from the local namespace if it +occurs as a free variable in a nested block.

    +
    +
    +
    +

    7.6. The return statement

    +
    +return_stmt ::=  "return" [expression_list]
    +
    +

    return may only occur syntactically nested in a function definition, +not within a nested class definition.

    +

    If an expression list is present, it is evaluated, else None is substituted.

    +

    return leaves the current function call with the expression list (or +None) as return value.

    +

    When return passes control out of a try statement with a +finally clause, that finally clause is executed before +really leaving the function.

    +

    In a generator function, the return statement indicates that the +generator is done and will cause StopIteration to be raised. The returned +value (if any) is used as an argument to construct StopIteration and +becomes the StopIteration.value attribute.

    +

    In an asynchronous generator function, an empty return statement +indicates that the asynchronous generator is done and will cause +StopAsyncIteration to be raised. A non-empty return +statement is a syntax error in an asynchronous generator function.

    +
    +
    +

    7.7. The yield statement

    +
    +yield_stmt ::=  yield_expression
    +
    +

    A yield statement is semantically equivalent to a yield +expression. The yield statement can be used to omit the parentheses +that would otherwise be required in the equivalent yield expression +statement. For example, the yield statements

    +
    yield <expr>
    +yield from <expr>
    +
    +
    +

    are equivalent to the yield expression statements

    +
    (yield <expr>)
    +(yield from <expr>)
    +
    +
    +

    Yield expressions and statements are only used when defining a generator +function, and are only used in the body of the generator function. Using yield +in a function definition is sufficient to cause that definition to create a +generator function instead of a normal function.

    +

    For full details of yield semantics, refer to the +Yield expressions section.

    +
    +
    +

    7.8. The raise statement

    +
    +raise_stmt ::=  "raise" [expression ["from" expression]]
    +
    +

    If no expressions are present, raise re-raises the last exception +that was active in the current scope. If no exception is active in the current +scope, a RuntimeError exception is raised indicating that this is an +error.

    +

    Otherwise, raise evaluates the first expression as the exception +object. It must be either a subclass or an instance of BaseException. +If it is a class, the exception instance will be obtained when needed by +instantiating the class with no arguments.

    +

    The type of the exception is the exception instance’s class, the +value is the instance itself.

    +

    A traceback object is normally created automatically when an exception is raised +and attached to it as the __traceback__ attribute, which is writable. +You can create an exception and set your own traceback in one step using the +with_traceback() exception method (which returns the same exception +instance, with its traceback set to its argument), like so:

    +
    raise Exception("foo occurred").with_traceback(tracebackobj)
    +
    +
    +

    The from clause is used for exception chaining: if given, the second +expression must be another exception class or instance, which will then be +attached to the raised exception as the __cause__ attribute (which is +writable). If the raised exception is not handled, both exceptions will be +printed:

    +
    >>> try:
    +...     print(1 / 0)
    +... except Exception as exc:
    +...     raise RuntimeError("Something bad happened") from exc
    +...
    +Traceback (most recent call last):
    +  File "<stdin>", line 2, in <module>
    +ZeroDivisionError: division by zero
    +
    +The above exception was the direct cause of the following exception:
    +
    +Traceback (most recent call last):
    +  File "<stdin>", line 4, in <module>
    +RuntimeError: Something bad happened
    +
    +
    +

    A similar mechanism works implicitly if an exception is raised inside an +exception handler or a finally clause: the previous exception is then +attached as the new exception’s __context__ attribute:

    +
    >>> try:
    +...     print(1 / 0)
    +... except:
    +...     raise RuntimeError("Something bad happened")
    +...
    +Traceback (most recent call last):
    +  File "<stdin>", line 2, in <module>
    +ZeroDivisionError: division by zero
    +
    +During handling of the above exception, another exception occurred:
    +
    +Traceback (most recent call last):
    +  File "<stdin>", line 4, in <module>
    +RuntimeError: Something bad happened
    +
    +
    +

    Exception chaining can be explicitly suppressed by specifying None in +the from clause:

    +
    >>> try:
    +...     print(1 / 0)
    +... except:
    +...     raise RuntimeError("Something bad happened") from None
    +...
    +Traceback (most recent call last):
    +  File "<stdin>", line 4, in <module>
    +RuntimeError: Something bad happened
    +
    +
    +

    Additional information on exceptions can be found in section Exceptions, +and information about handling exceptions is in section The try statement.

    +
    +

    Changed in version 3.3: None is now permitted as Y in raise X from Y.

    +
    +
    +

    New in version 3.3: The __suppress_context__ attribute to suppress automatic display of the +exception context.

    +
    +
    +
    +

    7.9. The break statement

    +
    +break_stmt ::=  "break"
    +
    +

    break may only occur syntactically nested in a for or +while loop, but not nested in a function or class definition within +that loop.

    +

    It terminates the nearest enclosing loop, skipping the optional else +clause if the loop has one.

    +

    If a for loop is terminated by break, the loop control +target keeps its current value.

    +

    When break passes control out of a try statement with a +finally clause, that finally clause is executed before +really leaving the loop.

    +
    +
    +

    7.10. The continue statement

    +
    +continue_stmt ::=  "continue"
    +
    +

    continue may only occur syntactically nested in a for or +while loop, but not nested in a function or class definition or +finally clause within that loop. It continues with the next +cycle of the nearest enclosing loop.

    +

    When continue passes control out of a try statement with a +finally clause, that finally clause is executed before +really starting the next loop cycle.

    +
    +
    +

    7.11. The import statement

    +
    +import_stmt     ::=  "import" module ["as" identifier] ("," module ["as" identifier])*
    +                     | "from" relative_module "import" identifier ["as" identifier]
    +                     ("," identifier ["as" identifier])*
    +                     | "from" relative_module "import" "(" identifier ["as" identifier]
    +                     ("," identifier ["as" identifier])* [","] ")"
    +                     | "from" module "import" "*"
    +module          ::=  (identifier ".")* identifier
    +relative_module ::=  "."* module | "."+
    +
    +

    The basic import statement (no from clause) is executed in two +steps:

    +
      +
    1. find a module, loading and initializing it if necessary

    2. +
    3. define a name or names in the local namespace for the scope where +the import statement occurs.

    4. +
    +

    When the statement contains multiple clauses (separated by +commas) the two steps are carried out separately for each clause, just +as though the clauses had been separated out into individual import +statements.

    +

    The details of the first step, finding and loading modules are described in +greater detail in the section on the import system, +which also describes the various types of packages and modules that can +be imported, as well as all the hooks that can be used to customize +the import system. Note that failures in this step may indicate either +that the module could not be located, or that an error occurred while +initializing the module, which includes execution of the module’s code.

    +

    If the requested module is retrieved successfully, it will be made +available in the local namespace in one of three ways:

    +
      +
    • If the module name is followed by as, then the name +following as is bound directly to the imported module.

    • +
    • If no other name is specified, and the module being imported is a top +level module, the module’s name is bound in the local namespace as a +reference to the imported module

    • +
    • If the module being imported is not a top level module, then the name +of the top level package that contains the module is bound in the local +namespace as a reference to the top level package. The imported module +must be accessed using its full qualified name rather than directly

    • +
    +

    The from form uses a slightly more complex process:

    +
      +
    1. find the module specified in the from clause, loading and +initializing it if necessary;

    2. +
    3. for each of the identifiers specified in the import clauses:

      +
        +
      1. check if the imported module has an attribute by that name

      2. +
      3. if not, attempt to import a submodule with that name and then +check the imported module again for that attribute

      4. +
      5. if the attribute is not found, ImportError is raised.

      6. +
      7. otherwise, a reference to that value is stored in the local namespace, +using the name in the as clause if it is present, +otherwise using the attribute name

      8. +
      +
    4. +
    +

    Examples:

    +
    import foo                 # foo imported and bound locally
    +import foo.bar.baz         # foo.bar.baz imported, foo bound locally
    +import foo.bar.baz as fbb  # foo.bar.baz imported and bound as fbb
    +from foo.bar import baz    # foo.bar.baz imported and bound as baz
    +from foo import attr       # foo imported and foo.attr bound as attr
    +
    +
    +

    If the list of identifiers is replaced by a star ('*'), all public +names defined in the module are bound in the local namespace for the scope +where the import statement occurs.

    +

    The public names defined by a module are determined by checking the module’s +namespace for a variable named __all__; if defined, it must be a sequence +of strings which are names defined or imported by that module. The names +given in __all__ are all considered public and are required to exist. If +__all__ is not defined, the set of public names includes all names found +in the module’s namespace which do not begin with an underscore character +('_'). __all__ should contain the entire public API. It is intended +to avoid accidentally exporting items that are not part of the API (such as +library modules which were imported and used within the module).

    +

    The wild card form of import — from module import * — is only allowed at +the module level. Attempting to use it in class or function definitions will +raise a SyntaxError.

    +

    When specifying what module to import you do not have to specify the absolute +name of the module. When a module or package is contained within another +package it is possible to make a relative import within the same top package +without having to mention the package name. By using leading dots in the +specified module or package after from you can specify how high to +traverse up the current package hierarchy without specifying exact names. One +leading dot means the current package where the module making the import +exists. Two dots means up one package level. Three dots is up two levels, etc. +So if you execute from . import mod from a module in the pkg package +then you will end up importing pkg.mod. If you execute from ..subpkg2 +import mod from within pkg.subpkg1 you will import pkg.subpkg2.mod. +The specification for relative imports is contained in +the Package Relative Imports section.

    +

    importlib.import_module() is provided to support applications that +determine dynamically the modules to be loaded.

    +
    +

    7.11.1. Future statements

    +

    A future statement is a directive to the compiler that a particular +module should be compiled using syntax or semantics that will be available in a +specified future release of Python where the feature becomes standard.

    +

    The future statement is intended to ease migration to future versions of Python +that introduce incompatible changes to the language. It allows use of the new +features on a per-module basis before the release in which the feature becomes +standard.

    +
    +future_stmt ::=  "from" "__future__" "import" feature ["as" identifier]
    +                 ("," feature ["as" identifier])*
    +                 | "from" "__future__" "import" "(" feature ["as" identifier]
    +                 ("," feature ["as" identifier])* [","] ")"
    +feature     ::=  identifier
    +
    +

    A future statement must appear near the top of the module. The only lines that +can appear before a future statement are:

    +
      +
    • the module docstring (if any),

    • +
    • comments,

    • +
    • blank lines, and

    • +
    • other future statements.

    • +
    +

    The only feature in Python 3.7 that requires using the future statement is +annotations.

    +

    All historical features enabled by the future statement are still recognized +by Python 3. The list includes absolute_import, division, +generators, generator_stop, unicode_literals, +print_function, nested_scopes and with_statement. They are +all redundant because they are always enabled, and only kept for +backwards compatibility.

    +

    A future statement is recognized and treated specially at compile time: Changes +to the semantics of core constructs are often implemented by generating +different code. It may even be the case that a new feature introduces new +incompatible syntax (such as a new reserved word), in which case the compiler +may need to parse the module differently. Such decisions cannot be pushed off +until runtime.

    +

    For any given release, the compiler knows which feature names have been defined, +and raises a compile-time error if a future statement contains a feature not +known to it.

    +

    The direct runtime semantics are the same as for any import statement: there is +a standard module __future__, described later, and it will be imported in +the usual way at the time the future statement is executed.

    +

    The interesting runtime semantics depend on the specific feature enabled by the +future statement.

    +

    Note that there is nothing special about the statement:

    +
    import __future__ [as name]
    +
    +
    +

    That is not a future statement; it’s an ordinary import statement with no +special semantics or syntax restrictions.

    +

    Code compiled by calls to the built-in functions exec() and compile() +that occur in a module M containing a future statement will, by default, +use the new syntax or semantics associated with the future statement. This can +be controlled by optional arguments to compile() — see the documentation +of that function for details.

    +

    A future statement typed at an interactive interpreter prompt will take effect +for the rest of the interpreter session. If an interpreter is started with the +-i option, is passed a script name to execute, and the script includes +a future statement, it will be in effect in the interactive session started +after the script is executed.

    +
    +

    See also

    +
    +
    PEP 236 - Back to the __future__

    The original proposal for the __future__ mechanism.

    +
    +
    +
    +
    +
    +
    +

    7.12. The global statement

    +
    +global_stmt ::=  "global" identifier ("," identifier)*
    +
    +

    The global statement is a declaration which holds for the entire +current code block. It means that the listed identifiers are to be interpreted +as globals. It would be impossible to assign to a global variable without +global, although free variables may refer to globals without being +declared global.

    +

    Names listed in a global statement must not be used in the same code +block textually preceding that global statement.

    +

    Names listed in a global statement must not be defined as formal +parameters or in a for loop control target, class +definition, function definition, import statement, or variable +annotation.

    +
    +

    CPython implementation detail: The current implementation does not enforce some of these restrictions, but +programs should not abuse this freedom, as future implementations may enforce +them or silently change the meaning of the program.

    +
    +

    Programmer’s note: global is a directive to the parser. It +applies only to code parsed at the same time as the global statement. +In particular, a global statement contained in a string or code +object supplied to the built-in exec() function does not affect the code +block containing the function call, and code contained in such a string is +unaffected by global statements in the code containing the function +call. The same applies to the eval() and compile() functions.

    +
    +
    +

    7.13. The nonlocal statement

    +
    +nonlocal_stmt ::=  "nonlocal" identifier ("," identifier)*
    +
    +

    The nonlocal statement causes the listed identifiers to refer to +previously bound variables in the nearest enclosing scope excluding globals. +This is important because the default behavior for binding is to search the +local namespace first. The statement allows encapsulated code to rebind +variables outside of the local scope besides the global (module) scope.

    +

    Names listed in a nonlocal statement, unlike those listed in a +global statement, must refer to pre-existing bindings in an +enclosing scope (the scope in which a new binding should be created cannot +be determined unambiguously).

    +

    Names listed in a nonlocal statement must not collide with +pre-existing bindings in the local scope.

    +
    +

    See also

    +
    +
    PEP 3104 - Access to Names in Outer Scopes

    The specification for the nonlocal statement.

    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/reference/toplevel_components.html b/python-3.7.4-docs-html/reference/toplevel_components.html new file mode 100644 index 0000000..ecfc4e7 --- /dev/null +++ b/python-3.7.4-docs-html/reference/toplevel_components.html @@ -0,0 +1,248 @@ + + + + + + + 9. Top-level components — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    9. Top-level components

    +

    The Python interpreter can get its input from a number of sources: from a script +passed to it as standard input or as program argument, typed in interactively, +from a module source file, etc. This chapter gives the syntax used in these +cases.

    +
    +

    9.1. Complete Python programs

    +

    While a language specification need not prescribe how the language interpreter +is invoked, it is useful to have a notion of a complete Python program. A +complete Python program is executed in a minimally initialized environment: all +built-in and standard modules are available, but none have been initialized, +except for sys (various system services), builtins (built-in +functions, exceptions and None) and __main__. The latter is used to +provide the local and global namespace for execution of the complete program.

    +

    The syntax for a complete Python program is that for file input, described in +the next section.

    +

    The interpreter may also be invoked in interactive mode; in this case, it does +not read and execute a complete program but reads and executes one statement +(possibly compound) at a time. The initial environment is identical to that of +a complete program; each statement is executed in the namespace of +__main__.

    +

    A complete program can be passed to the interpreter +in three forms: with the -c string command line option, as a file +passed as the first command line argument, or as standard input. If the file +or standard input is a tty device, the interpreter enters interactive mode; +otherwise, it executes the file as a complete program.

    +
    +
    +

    9.2. File input

    +

    All input read from non-interactive files has the same form:

    +
    +file_input ::=  (NEWLINE | statement)*
    +
    +

    This syntax is used in the following situations:

    +
      +
    • when parsing a complete Python program (from a file or from a string);

    • +
    • when parsing a module;

    • +
    • when parsing a string passed to the exec() function;

    • +
    +
    +
    +

    9.3. Interactive input

    +

    Input in interactive mode is parsed using the following grammar:

    +
    +interactive_input ::=  [stmt_list] NEWLINE | compound_stmt NEWLINE
    +
    +

    Note that a (top-level) compound statement must be followed by a blank line in +interactive mode; this is needed to help the parser detect the end of the input.

    +
    +
    +

    9.4. Expression input

    +

    eval() is used for expression input. It ignores leading whitespace. The +string argument to eval() must have the following form:

    +
    +eval_input ::=  expression_list NEWLINE*
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/search.html b/python-3.7.4-docs-html/search.html new file mode 100644 index 0000000..818e2a2 --- /dev/null +++ b/python-3.7.4-docs-html/search.html @@ -0,0 +1,144 @@ + + + + + + + Search — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +

    Search

    +
    + +

    + Please activate JavaScript to enable the search + functionality. +

    +
    +

    + From here you can search these documents. Enter your search + words into the box below and click "search". Note that the search + function will automatically search for all of the words. Pages + containing fewer words won't appear in the result list. +

    +
    + + + +
    + +
    + +
    + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/searchindex.js b/python-3.7.4-docs-html/searchindex.js new file mode 100644 index 0000000..2ea5296 --- /dev/null +++ b/python-3.7.4-docs-html/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["about","bugs","c-api/abstract","c-api/allocation","c-api/apiabiversion","c-api/arg","c-api/bool","c-api/buffer","c-api/bytearray","c-api/bytes","c-api/capsule","c-api/cell","c-api/code","c-api/codec","c-api/complex","c-api/concrete","c-api/contextvars","c-api/conversion","c-api/coro","c-api/datetime","c-api/descriptor","c-api/dict","c-api/exceptions","c-api/file","c-api/float","c-api/function","c-api/gcsupport","c-api/gen","c-api/import","c-api/index","c-api/init","c-api/intro","c-api/iter","c-api/iterator","c-api/list","c-api/long","c-api/mapping","c-api/marshal","c-api/memory","c-api/memoryview","c-api/method","c-api/module","c-api/none","c-api/number","c-api/objbuffer","c-api/object","c-api/objimpl","c-api/refcounting","c-api/reflection","c-api/sequence","c-api/set","c-api/slice","c-api/stable","c-api/structures","c-api/sys","c-api/tuple","c-api/type","c-api/typeobj","c-api/unicode","c-api/utilities","c-api/veryhigh","c-api/weakref","contents","copyright","distributing/index","distutils/apiref","distutils/builtdist","distutils/commandref","distutils/configfile","distutils/examples","distutils/extending","distutils/index","distutils/introduction","distutils/packageindex","distutils/setupscript","distutils/sourcedist","distutils/uploading","extending/building","extending/embedding","extending/extending","extending/index","extending/newtypes","extending/newtypes_tutorial","extending/windows","faq/design","faq/extending","faq/general","faq/gui","faq/index","faq/installed","faq/library","faq/programming","faq/windows","glossary","howto/argparse","howto/clinic","howto/cporting","howto/curses","howto/descriptor","howto/functional","howto/index","howto/instrumentation","howto/ipaddress","howto/logging","howto/logging-cookbook","howto/pyporting","howto/regex","howto/sockets","howto/sorting","howto/unicode","howto/urllib2","install/index","installing/index","library/2to3","library/__future__","library/__main__","library/_dummy_thread","library/_thread","library/abc","library/aifc","library/allos","library/archiving","library/argparse","library/array","library/ast","library/asynchat","library/asyncio","library/asyncio-api-index","library/asyncio-dev","library/asyncio-eventloop","library/asyncio-exceptions","library/asyncio-future","library/asyncio-llapi-index","library/asyncio-platforms","library/asyncio-policy","library/asyncio-protocol","library/asyncio-queue","library/asyncio-stream","library/asyncio-subprocess","library/asyncio-sync","library/asyncio-task","library/asyncore","library/atexit","library/audioop","library/base64","library/bdb","library/binary","library/binascii","library/binhex","library/bisect","library/builtins","library/bz2","library/calendar","library/cgi","library/cgitb","library/chunk","library/cmath","library/cmd","library/code","library/codecs","library/codeop","library/collections","library/collections.abc","library/colorsys","library/compileall","library/concurrency","library/concurrent","library/concurrent.futures","library/configparser","library/constants","library/contextlib","library/contextvars","library/copy","library/copyreg","library/crypt","library/crypto","library/csv","library/ctypes","library/curses","library/curses.ascii","library/curses.panel","library/custominterp","library/dataclasses","library/datatypes","library/datetime","library/dbm","library/debug","library/decimal","library/development","library/difflib","library/dis","library/distribution","library/distutils","library/doctest","library/dummy_threading","library/email","library/email.charset","library/email.compat32-message","library/email.contentmanager","library/email.encoders","library/email.errors","library/email.examples","library/email.generator","library/email.header","library/email.headerregistry","library/email.iterators","library/email.message","library/email.mime","library/email.parser","library/email.policy","library/email.utils","library/ensurepip","library/enum","library/errno","library/exceptions","library/faulthandler","library/fcntl","library/filecmp","library/fileformats","library/fileinput","library/filesys","library/fnmatch","library/formatter","library/fractions","library/frameworks","library/ftplib","library/functional","library/functions","library/functools","library/gc","library/getopt","library/getpass","library/gettext","library/glob","library/grp","library/gzip","library/hashlib","library/heapq","library/hmac","library/html","library/html.entities","library/html.parser","library/http","library/http.client","library/http.cookiejar","library/http.cookies","library/http.server","library/i18n","library/idle","library/imaplib","library/imghdr","library/imp","library/importlib","library/index","library/inspect","library/internet","library/intro","library/io","library/ipaddress","library/ipc","library/itertools","library/json","library/keyword","library/language","library/linecache","library/locale","library/logging","library/logging.config","library/logging.handlers","library/lzma","library/macpath","library/mailbox","library/mailcap","library/markup","library/marshal","library/math","library/mimetypes","library/misc","library/mm","library/mmap","library/modulefinder","library/modules","library/msilib","library/msvcrt","library/multiprocessing","library/netdata","library/netrc","library/nis","library/nntplib","library/numbers","library/numeric","library/operator","library/optparse","library/os","library/os.path","library/ossaudiodev","library/othergui","library/parser","library/pathlib","library/pdb","library/persistence","library/pickle","library/pickletools","library/pipes","library/pkgutil","library/platform","library/plistlib","library/poplib","library/posix","library/pprint","library/profile","library/pty","library/pwd","library/py_compile","library/pyclbr","library/pydoc","library/pyexpat","library/python","library/queue","library/quopri","library/random","library/re","library/readline","library/reprlib","library/resource","library/rlcompleter","library/runpy","library/sched","library/secrets","library/select","library/selectors","library/shelve","library/shlex","library/shutil","library/signal","library/site","library/smtpd","library/smtplib","library/sndhdr","library/socket","library/socketserver","library/spwd","library/sqlite3","library/ssl","library/stat","library/statistics","library/stdtypes","library/string","library/stringprep","library/struct","library/subprocess","library/sunau","library/superseded","library/symbol","library/symtable","library/sys","library/sysconfig","library/syslog","library/tabnanny","library/tarfile","library/telnetlib","library/tempfile","library/termios","library/test","library/text","library/textwrap","library/threading","library/time","library/timeit","library/tk","library/tkinter","library/tkinter.scrolledtext","library/tkinter.tix","library/tkinter.ttk","library/token","library/tokenize","library/trace","library/traceback","library/tracemalloc","library/tty","library/turtle","library/types","library/typing","library/undoc","library/unicodedata","library/unittest","library/unittest.mock","library/unittest.mock-examples","library/unix","library/urllib","library/urllib.error","library/urllib.parse","library/urllib.request","library/urllib.robotparser","library/uu","library/uuid","library/venv","library/warnings","library/wave","library/weakref","library/webbrowser","library/windows","library/winreg","library/winsound","library/wsgiref","library/xdrlib","library/xml","library/xml.dom","library/xml.dom.minidom","library/xml.dom.pulldom","library/xml.etree.elementtree","library/xml.sax","library/xml.sax.handler","library/xml.sax.reader","library/xml.sax.utils","library/xmlrpc","library/xmlrpc.client","library/xmlrpc.server","library/zipapp","library/zipfile","library/zipimport","library/zlib","license","reference/compound_stmts","reference/datamodel","reference/executionmodel","reference/expressions","reference/grammar","reference/import","reference/index","reference/introduction","reference/lexical_analysis","reference/simple_stmts","reference/toplevel_components","tutorial/appendix","tutorial/appetite","tutorial/classes","tutorial/controlflow","tutorial/datastructures","tutorial/errors","tutorial/floatingpoint","tutorial/index","tutorial/inputoutput","tutorial/interactive","tutorial/interpreter","tutorial/introduction","tutorial/modules","tutorial/stdlib","tutorial/stdlib2","tutorial/venv","tutorial/whatnow","using/cmdline","using/index","using/mac","using/unix","using/windows","whatsnew/2.0","whatsnew/2.1","whatsnew/2.2","whatsnew/2.3","whatsnew/2.4","whatsnew/2.5","whatsnew/2.6","whatsnew/2.7","whatsnew/3.0","whatsnew/3.1","whatsnew/3.2","whatsnew/3.3","whatsnew/3.4","whatsnew/3.5","whatsnew/3.6","whatsnew/3.7","whatsnew/changelog","whatsnew/index"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:56},filenames:["about.rst","bugs.rst","c-api/abstract.rst","c-api/allocation.rst","c-api/apiabiversion.rst","c-api/arg.rst","c-api/bool.rst","c-api/buffer.rst","c-api/bytearray.rst","c-api/bytes.rst","c-api/capsule.rst","c-api/cell.rst","c-api/code.rst","c-api/codec.rst","c-api/complex.rst","c-api/concrete.rst","c-api/contextvars.rst","c-api/conversion.rst","c-api/coro.rst","c-api/datetime.rst","c-api/descriptor.rst","c-api/dict.rst","c-api/exceptions.rst","c-api/file.rst","c-api/float.rst","c-api/function.rst","c-api/gcsupport.rst","c-api/gen.rst","c-api/import.rst","c-api/index.rst","c-api/init.rst","c-api/intro.rst","c-api/iter.rst","c-api/iterator.rst","c-api/list.rst","c-api/long.rst","c-api/mapping.rst","c-api/marshal.rst","c-api/memory.rst","c-api/memoryview.rst","c-api/method.rst","c-api/module.rst","c-api/none.rst","c-api/number.rst","c-api/objbuffer.rst","c-api/object.rst","c-api/objimpl.rst","c-api/refcounting.rst","c-api/reflection.rst","c-api/sequence.rst","c-api/set.rst","c-api/slice.rst","c-api/stable.rst","c-api/structures.rst","c-api/sys.rst","c-api/tuple.rst","c-api/type.rst","c-api/typeobj.rst","c-api/unicode.rst","c-api/utilities.rst","c-api/veryhigh.rst","c-api/weakref.rst","contents.rst","copyright.rst","distributing/index.rst","distutils/apiref.rst","distutils/builtdist.rst","distutils/commandref.rst","distutils/configfile.rst","distutils/examples.rst","distutils/extending.rst","distutils/index.rst","distutils/introduction.rst","distutils/packageindex.rst","distutils/setupscript.rst","distutils/sourcedist.rst","distutils/uploading.rst","extending/building.rst","extending/embedding.rst","extending/extending.rst","extending/index.rst","extending/newtypes.rst","extending/newtypes_tutorial.rst","extending/windows.rst","faq/design.rst","faq/extending.rst","faq/general.rst","faq/gui.rst","faq/index.rst","faq/installed.rst","faq/library.rst","faq/programming.rst","faq/windows.rst","glossary.rst","howto/argparse.rst","howto/clinic.rst","howto/cporting.rst","howto/curses.rst","howto/descriptor.rst","howto/functional.rst","howto/index.rst","howto/instrumentation.rst","howto/ipaddress.rst","howto/logging.rst","howto/logging-cookbook.rst","howto/pyporting.rst","howto/regex.rst","howto/sockets.rst","howto/sorting.rst","howto/unicode.rst","howto/urllib2.rst","install/index.rst","installing/index.rst","library/2to3.rst","library/__future__.rst","library/__main__.rst","library/_dummy_thread.rst","library/_thread.rst","library/abc.rst","library/aifc.rst","library/allos.rst","library/archiving.rst","library/argparse.rst","library/array.rst","library/ast.rst","library/asynchat.rst","library/asyncio.rst","library/asyncio-api-index.rst","library/asyncio-dev.rst","library/asyncio-eventloop.rst","library/asyncio-exceptions.rst","library/asyncio-future.rst","library/asyncio-llapi-index.rst","library/asyncio-platforms.rst","library/asyncio-policy.rst","library/asyncio-protocol.rst","library/asyncio-queue.rst","library/asyncio-stream.rst","library/asyncio-subprocess.rst","library/asyncio-sync.rst","library/asyncio-task.rst","library/asyncore.rst","library/atexit.rst","library/audioop.rst","library/base64.rst","library/bdb.rst","library/binary.rst","library/binascii.rst","library/binhex.rst","library/bisect.rst","library/builtins.rst","library/bz2.rst","library/calendar.rst","library/cgi.rst","library/cgitb.rst","library/chunk.rst","library/cmath.rst","library/cmd.rst","library/code.rst","library/codecs.rst","library/codeop.rst","library/collections.rst","library/collections.abc.rst","library/colorsys.rst","library/compileall.rst","library/concurrency.rst","library/concurrent.rst","library/concurrent.futures.rst","library/configparser.rst","library/constants.rst","library/contextlib.rst","library/contextvars.rst","library/copy.rst","library/copyreg.rst","library/crypt.rst","library/crypto.rst","library/csv.rst","library/ctypes.rst","library/curses.rst","library/curses.ascii.rst","library/curses.panel.rst","library/custominterp.rst","library/dataclasses.rst","library/datatypes.rst","library/datetime.rst","library/dbm.rst","library/debug.rst","library/decimal.rst","library/development.rst","library/difflib.rst","library/dis.rst","library/distribution.rst","library/distutils.rst","library/doctest.rst","library/dummy_threading.rst","library/email.rst","library/email.charset.rst","library/email.compat32-message.rst","library/email.contentmanager.rst","library/email.encoders.rst","library/email.errors.rst","library/email.examples.rst","library/email.generator.rst","library/email.header.rst","library/email.headerregistry.rst","library/email.iterators.rst","library/email.message.rst","library/email.mime.rst","library/email.parser.rst","library/email.policy.rst","library/email.utils.rst","library/ensurepip.rst","library/enum.rst","library/errno.rst","library/exceptions.rst","library/faulthandler.rst","library/fcntl.rst","library/filecmp.rst","library/fileformats.rst","library/fileinput.rst","library/filesys.rst","library/fnmatch.rst","library/formatter.rst","library/fractions.rst","library/frameworks.rst","library/ftplib.rst","library/functional.rst","library/functions.rst","library/functools.rst","library/gc.rst","library/getopt.rst","library/getpass.rst","library/gettext.rst","library/glob.rst","library/grp.rst","library/gzip.rst","library/hashlib.rst","library/heapq.rst","library/hmac.rst","library/html.rst","library/html.entities.rst","library/html.parser.rst","library/http.rst","library/http.client.rst","library/http.cookiejar.rst","library/http.cookies.rst","library/http.server.rst","library/i18n.rst","library/idle.rst","library/imaplib.rst","library/imghdr.rst","library/imp.rst","library/importlib.rst","library/index.rst","library/inspect.rst","library/internet.rst","library/intro.rst","library/io.rst","library/ipaddress.rst","library/ipc.rst","library/itertools.rst","library/json.rst","library/keyword.rst","library/language.rst","library/linecache.rst","library/locale.rst","library/logging.rst","library/logging.config.rst","library/logging.handlers.rst","library/lzma.rst","library/macpath.rst","library/mailbox.rst","library/mailcap.rst","library/markup.rst","library/marshal.rst","library/math.rst","library/mimetypes.rst","library/misc.rst","library/mm.rst","library/mmap.rst","library/modulefinder.rst","library/modules.rst","library/msilib.rst","library/msvcrt.rst","library/multiprocessing.rst","library/netdata.rst","library/netrc.rst","library/nis.rst","library/nntplib.rst","library/numbers.rst","library/numeric.rst","library/operator.rst","library/optparse.rst","library/os.rst","library/os.path.rst","library/ossaudiodev.rst","library/othergui.rst","library/parser.rst","library/pathlib.rst","library/pdb.rst","library/persistence.rst","library/pickle.rst","library/pickletools.rst","library/pipes.rst","library/pkgutil.rst","library/platform.rst","library/plistlib.rst","library/poplib.rst","library/posix.rst","library/pprint.rst","library/profile.rst","library/pty.rst","library/pwd.rst","library/py_compile.rst","library/pyclbr.rst","library/pydoc.rst","library/pyexpat.rst","library/python.rst","library/queue.rst","library/quopri.rst","library/random.rst","library/re.rst","library/readline.rst","library/reprlib.rst","library/resource.rst","library/rlcompleter.rst","library/runpy.rst","library/sched.rst","library/secrets.rst","library/select.rst","library/selectors.rst","library/shelve.rst","library/shlex.rst","library/shutil.rst","library/signal.rst","library/site.rst","library/smtpd.rst","library/smtplib.rst","library/sndhdr.rst","library/socket.rst","library/socketserver.rst","library/spwd.rst","library/sqlite3.rst","library/ssl.rst","library/stat.rst","library/statistics.rst","library/stdtypes.rst","library/string.rst","library/stringprep.rst","library/struct.rst","library/subprocess.rst","library/sunau.rst","library/superseded.rst","library/symbol.rst","library/symtable.rst","library/sys.rst","library/sysconfig.rst","library/syslog.rst","library/tabnanny.rst","library/tarfile.rst","library/telnetlib.rst","library/tempfile.rst","library/termios.rst","library/test.rst","library/text.rst","library/textwrap.rst","library/threading.rst","library/time.rst","library/timeit.rst","library/tk.rst","library/tkinter.rst","library/tkinter.scrolledtext.rst","library/tkinter.tix.rst","library/tkinter.ttk.rst","library/token.rst","library/tokenize.rst","library/trace.rst","library/traceback.rst","library/tracemalloc.rst","library/tty.rst","library/turtle.rst","library/types.rst","library/typing.rst","library/undoc.rst","library/unicodedata.rst","library/unittest.rst","library/unittest.mock.rst","library/unittest.mock-examples.rst","library/unix.rst","library/urllib.rst","library/urllib.error.rst","library/urllib.parse.rst","library/urllib.request.rst","library/urllib.robotparser.rst","library/uu.rst","library/uuid.rst","library/venv.rst","library/warnings.rst","library/wave.rst","library/weakref.rst","library/webbrowser.rst","library/windows.rst","library/winreg.rst","library/winsound.rst","library/wsgiref.rst","library/xdrlib.rst","library/xml.rst","library/xml.dom.rst","library/xml.dom.minidom.rst","library/xml.dom.pulldom.rst","library/xml.etree.elementtree.rst","library/xml.sax.rst","library/xml.sax.handler.rst","library/xml.sax.reader.rst","library/xml.sax.utils.rst","library/xmlrpc.rst","library/xmlrpc.client.rst","library/xmlrpc.server.rst","library/zipapp.rst","library/zipfile.rst","library/zipimport.rst","library/zlib.rst","license.rst","reference/compound_stmts.rst","reference/datamodel.rst","reference/executionmodel.rst","reference/expressions.rst","reference/grammar.rst","reference/import.rst","reference/index.rst","reference/introduction.rst","reference/lexical_analysis.rst","reference/simple_stmts.rst","reference/toplevel_components.rst","tutorial/appendix.rst","tutorial/appetite.rst","tutorial/classes.rst","tutorial/controlflow.rst","tutorial/datastructures.rst","tutorial/errors.rst","tutorial/floatingpoint.rst","tutorial/index.rst","tutorial/inputoutput.rst","tutorial/interactive.rst","tutorial/interpreter.rst","tutorial/introduction.rst","tutorial/modules.rst","tutorial/stdlib.rst","tutorial/stdlib2.rst","tutorial/venv.rst","tutorial/whatnow.rst","using/cmdline.rst","using/index.rst","using/mac.rst","using/unix.rst","using/windows.rst","whatsnew/2.0.rst","whatsnew/2.1.rst","whatsnew/2.2.rst","whatsnew/2.3.rst","whatsnew/2.4.rst","whatsnew/2.5.rst","whatsnew/2.6.rst","whatsnew/2.7.rst","whatsnew/3.0.rst","whatsnew/3.1.rst","whatsnew/3.2.rst","whatsnew/3.3.rst","whatsnew/3.4.rst","whatsnew/3.5.rst","whatsnew/3.6.rst","whatsnew/3.7.rst","whatsnew/changelog.rst","whatsnew/index.rst"],objects:{"":{"!":[299,14,1,"-"],"--check-hash-based-pycs":[451,15,1,"cmdoption-check-hash-based-pycs"],"--help":[451,15,1,"cmdoption-help"],"--version":[451,15,1,"cmdoption-version"],"-?":[451,15,1,"cmdoption"],"-B":[451,15,1,"id1"],"-E":[451,15,1,"cmdoption-e"],"-I":[451,15,1,"id2"],"-J":[451,15,1,"cmdoption-j"],"-O":[451,15,1,"cmdoption-o"],"-OO":[451,15,1,"cmdoption-oo"],"-R":[451,15,1,"cmdoption-r"],"-S":[451,15,1,"id3"],"-V":[451,15,1,"cmdoption-v"],"-W":[451,15,1,"cmdoption-w"],"-X":[451,15,1,"id5"],"-b":[451,15,1,"cmdoption-b"],"-c":[451,15,1,"cmdoption-c"],"-d":[451,15,1,"cmdoption-d"],"-h":[451,15,1,"cmdoption-h"],"-i":[451,15,1,"cmdoption-i"],"-m":[451,15,1,"cmdoption-m"],"-q":[451,15,1,"cmdoption-q"],"-s":[451,15,1,"cmdoption-s"],"-u":[451,15,1,"cmdoption-u"],"-v":[451,15,1,"id4"],"-x":[451,15,1,"cmdoption-x"],"break":[299,14,1,"-"],"continue":[299,14,1,"-"],"enum":[212,9,0,"-"],"float":[227,11,1,""],"import":[113,18,1,"-"],"int":[227,11,1,""],"long":[113,18,1,"-"],"return":[299,14,1,"-"],"super":[227,10,1,""],"throw":[113,18,1,"-"],ArithmeticError:[214,5,1,""],AssertionError:[214,5,1,""],AttributeError:[214,5,1,""],BEFORE_ASYNC_WITH:[190,16,1,"-"],BINARY_ADD:[190,16,1,"-"],BINARY_AND:[190,16,1,"-"],BINARY_FLOOR_DIVIDE:[190,16,1,"-"],BINARY_LSHIFT:[190,16,1,"-"],BINARY_MATRIX_MULTIPLY:[190,16,1,"-"],BINARY_MODULO:[190,16,1,"-"],BINARY_MULTIPLY:[190,16,1,"-"],BINARY_OR:[190,16,1,"-"],BINARY_POWER:[190,16,1,"-"],BINARY_RSHIFT:[190,16,1,"-"],BINARY_SUBSCR:[190,16,1,"-"],BINARY_SUBTRACT:[190,16,1,"-"],BINARY_TRUE_DIVIDE:[190,16,1,"-"],BINARY_XOR:[190,16,1,"-"],BREAK_LOOP:[190,16,1,"-"],BUILD_CONST_KEY_MAP:[190,16,1,"-"],BUILD_LIST:[190,16,1,"-"],BUILD_LIST_UNPACK:[190,16,1,"-"],BUILD_MAP:[190,16,1,"-"],BUILD_MAP_UNPACK:[190,16,1,"-"],BUILD_MAP_UNPACK_WITH_CALL:[190,16,1,"-"],BUILD_SET:[190,16,1,"-"],BUILD_SET_UNPACK:[190,16,1,"-"],BUILD_SLICE:[190,16,1,"-"],BUILD_STRING:[190,16,1,"-"],BUILD_TUPLE:[190,16,1,"-"],BUILD_TUPLE_UNPACK:[190,16,1,"-"],BUILD_TUPLE_UNPACK_WITH_CALL:[190,16,1,"-"],BaseException:[214,5,1,""],BlockingIOError:[214,5,1,""],BrokenPipeError:[214,5,1,""],BufferError:[214,5,1,""],BytesWarning:[214,5,1,""],CALL_FUNCTION:[190,16,1,"-"],CALL_FUNCTION_EX:[190,16,1,"-"],CALL_FUNCTION_KW:[190,16,1,"-"],CALL_METHOD:[190,16,1,"-"],COMPARE_OP:[190,16,1,"-"],CONTINUE_LOOP:[190,16,1,"-"],CO_FUTURE_DIVISION:[60,0,1,"c.CO_FUTURE_DIVISION"],ChildProcessError:[214,5,1,""],ConnectionAbortedError:[214,5,1,""],ConnectionError:[214,5,1,""],ConnectionRefusedError:[214,5,1,""],ConnectionResetError:[214,5,1,""],DELETE_ATTR:[190,16,1,"-"],DELETE_DEREF:[190,16,1,"-"],DELETE_FAST:[190,16,1,"-"],DELETE_GLOBAL:[190,16,1,"-"],DELETE_NAME:[190,16,1,"-"],DELETE_SUBSCR:[190,16,1,"-"],DUP_TOP:[190,16,1,"-"],DUP_TOP_TWO:[190,16,1,"-"],DeprecationWarning:[214,5,1,""],END_FINALLY:[190,16,1,"-"],EOFError:[214,5,1,""],EXTENDED_ARG:[190,16,1,"-"],Ellipsis:[169,8,1,""],EnvironmentError:[214,5,1,""],Exception:[214,5,1,""],FORMAT_VALUE:[190,16,1,"-"],FOR_ITER:[190,16,1,"-"],False:[169,8,1,""],FileExistsError:[214,5,1,""],FileNotFoundError:[214,5,1,""],FloatingPointError:[214,5,1,""],FutureWarning:[214,5,1,""],GET_AITER:[190,16,1,"-"],GET_ANEXT:[190,16,1,"-"],GET_AWAITABLE:[190,16,1,"-"],GET_ITER:[190,16,1,"-"],GET_YIELD_FROM_ITER:[190,16,1,"-"],GeneratorExit:[214,5,1,""],HAVE_ARGUMENT:[190,16,1,"-"],IMPORT_FROM:[190,16,1,"-"],IMPORT_NAME:[190,16,1,"-"],IMPORT_STAR:[190,16,1,"-"],INPLACE_ADD:[190,16,1,"-"],INPLACE_AND:[190,16,1,"-"],INPLACE_FLOOR_DIVIDE:[190,16,1,"-"],INPLACE_LSHIFT:[190,16,1,"-"],INPLACE_MATRIX_MULTIPLY:[190,16,1,"-"],INPLACE_MODULO:[190,16,1,"-"],INPLACE_MULTIPLY:[190,16,1,"-"],INPLACE_OR:[190,16,1,"-"],INPLACE_POWER:[190,16,1,"-"],INPLACE_RSHIFT:[190,16,1,"-"],INPLACE_SUBTRACT:[190,16,1,"-"],INPLACE_TRUE_DIVIDE:[190,16,1,"-"],INPLACE_XOR:[190,16,1,"-"],IOError:[214,5,1,""],ImportError:[214,5,1,""],ImportWarning:[214,5,1,""],IndentationError:[214,5,1,""],IndexError:[214,5,1,""],InterruptedError:[214,5,1,""],IsADirectoryError:[214,5,1,""],JUMP_ABSOLUTE:[190,16,1,"-"],JUMP_FORWARD:[190,16,1,"-"],JUMP_IF_FALSE_OR_POP:[190,16,1,"-"],JUMP_IF_TRUE_OR_POP:[190,16,1,"-"],KeyError:[214,5,1,""],KeyboardInterrupt:[214,5,1,""],LIST_APPEND:[190,16,1,"-"],LOAD_ATTR:[190,16,1,"-"],LOAD_BUILD_CLASS:[190,16,1,"-"],LOAD_CLASSDEREF:[190,16,1,"-"],LOAD_CLOSURE:[190,16,1,"-"],LOAD_CONST:[190,16,1,"-"],LOAD_DEREF:[190,16,1,"-"],LOAD_FAST:[190,16,1,"-"],LOAD_GLOBAL:[190,16,1,"-"],LOAD_METHOD:[190,16,1,"-"],LOAD_NAME:[190,16,1,"-"],LookupError:[214,5,1,""],MAKE_FUNCTION:[190,16,1,"-"],MAP_ADD:[190,16,1,"-"],METH_CLASS:[53,8,1,""],METH_COEXIST:[53,8,1,""],METH_FASTCALL:[53,8,1,""],METH_NOARGS:[53,8,1,""],METH_O:[53,8,1,""],METH_STATIC:[53,8,1,""],METH_VARARGS:[53,8,1,""],MemoryError:[214,5,1,""],ModuleNotFoundError:[214,5,1,""],NOP:[190,16,1,"-"],NameError:[214,5,1,""],None:[169,8,1,""],NotADirectoryError:[214,5,1,""],NotImplemented:[169,8,1,""],NotImplementedError:[214,5,1,""],OSError:[214,5,1,""],OverflowError:[214,5,1,""],POP_BLOCK:[190,16,1,"-"],POP_EXCEPT:[190,16,1,"-"],POP_JUMP_IF_FALSE:[190,16,1,"-"],POP_JUMP_IF_TRUE:[190,16,1,"-"],POP_TOP:[190,16,1,"-"],PRINT_EXPR:[190,16,1,"-"],PYMEM_DOMAIN_MEM:[38,0,1,"c.PYMEM_DOMAIN_MEM"],PYMEM_DOMAIN_OBJ:[38,0,1,"c.PYMEM_DOMAIN_OBJ"],PYMEM_DOMAIN_RAW:[38,0,1,"c.PYMEM_DOMAIN_RAW"],PYTHONASYNCIODEBUG:[451,17,1,"-"],PYTHONBREAKPOINT:[451,17,1,"-"],PYTHONCASEOK:[451,17,1,"-"],PYTHONCOERCECLOCALE:[451,17,1,"-"],PYTHONDEBUG:[451,17,1,"-"],PYTHONDEVMODE:[451,17,1,"-"],PYTHONDONTWRITEBYTECODE:[451,17,1,"-"],PYTHONDUMPREFS:[451,17,1,"-"],PYTHONEXECUTABLE:[451,17,1,"-"],PYTHONFAULTHANDLER:[451,17,1,"-"],PYTHONHASHSEED:[451,17,1,"-"],PYTHONHOME:[451,17,1,"-"],PYTHONINSPECT:[451,17,1,"-"],PYTHONIOENCODING:[451,17,1,"-"],PYTHONLEGACYWINDOWSFSENCODING:[451,17,1,"-"],PYTHONLEGACYWINDOWSSTDIO:[451,17,1,"-"],PYTHONMALLOC:[451,17,1,"-"],PYTHONMALLOCSTATS:[451,17,1,"-"],PYTHONNOUSERSITE:[451,17,1,"-"],PYTHONOPTIMIZE:[451,17,1,"-"],PYTHONPATH:[451,17,1,"-"],PYTHONPROFILEIMPORTTIME:[451,17,1,"-"],PYTHONSTARTUP:[451,17,1,"-"],PYTHONTHREADDEBUG:[451,17,1,"-"],PYTHONTRACEMALLOC:[451,17,1,"-"],PYTHONUNBUFFERED:[451,17,1,"-"],PYTHONUSERBASE:[451,17,1,"-"],PYTHONUTF8:[451,17,1,"-"],PYTHONVERBOSE:[451,17,1,"-"],PYTHONWARNINGS:[451,17,1,"-"],PendingDeprecationWarning:[214,5,1,""],PermissionError:[214,5,1,""],ProcessLookupError:[214,5,1,""],PyASCIIObject:[58,1,1,"c.PyASCIIObject"],PyAnySet_Check:[50,2,1,"c.PyAnySet_Check"],PyAnySet_CheckExact:[50,2,1,"c.PyAnySet_CheckExact"],PyArg_Parse:[5,2,1,"c.PyArg_Parse"],PyArg_ParseTuple:[5,2,1,"c.PyArg_ParseTuple"],PyArg_ParseTupleAndKeywords:[5,2,1,"c.PyArg_ParseTupleAndKeywords"],PyArg_UnpackTuple:[5,2,1,"c.PyArg_UnpackTuple"],PyArg_VaParse:[5,2,1,"c.PyArg_VaParse"],PyArg_VaParseTupleAndKeywords:[5,2,1,"c.PyArg_VaParseTupleAndKeywords"],PyArg_ValidateKeywordArguments:[5,2,1,"c.PyArg_ValidateKeywordArguments"],PyAsyncMethods:[57,1,1,"c.PyAsyncMethods"],PyBUF_ANY_CONTIGUOUS:[7,4,1,"c.PyBUF_ANY_CONTIGUOUS"],PyBUF_CONTIG:[7,4,1,"c.PyBUF_CONTIG"],PyBUF_CONTIG_RO:[7,4,1,"c.PyBUF_CONTIG_RO"],PyBUF_C_CONTIGUOUS:[7,4,1,"c.PyBUF_C_CONTIGUOUS"],PyBUF_FORMAT:[7,4,1,"c.PyBUF_FORMAT"],PyBUF_FULL:[7,4,1,"c.PyBUF_FULL"],PyBUF_FULL_RO:[7,4,1,"c.PyBUF_FULL_RO"],PyBUF_F_CONTIGUOUS:[7,4,1,"c.PyBUF_F_CONTIGUOUS"],PyBUF_INDIRECT:[7,4,1,"c.PyBUF_INDIRECT"],PyBUF_ND:[7,4,1,"c.PyBUF_ND"],PyBUF_RECORDS:[7,4,1,"c.PyBUF_RECORDS"],PyBUF_RECORDS_RO:[7,4,1,"c.PyBUF_RECORDS_RO"],PyBUF_SIMPLE:[7,4,1,"c.PyBUF_SIMPLE"],PyBUF_STRIDED:[7,4,1,"c.PyBUF_STRIDED"],PyBUF_STRIDED_RO:[7,4,1,"c.PyBUF_STRIDED_RO"],PyBUF_STRIDES:[7,4,1,"c.PyBUF_STRIDES"],PyBUF_WRITABLE:[7,4,1,"c.PyBUF_WRITABLE"],PyBool_Check:[6,2,1,"c.PyBool_Check"],PyBool_FromLong:[6,2,1,"c.PyBool_FromLong"],PyBufferProcs:[57,1,1,"c.PyBufferProcs"],PyBuffer_FillContiguousStrides:[7,2,1,"c.PyBuffer_FillContiguousStrides"],PyBuffer_FillInfo:[7,2,1,"c.PyBuffer_FillInfo"],PyBuffer_IsContiguous:[7,2,1,"c.PyBuffer_IsContiguous"],PyBuffer_Release:[7,2,1,"c.PyBuffer_Release"],PyBuffer_SizeFromFormat:[7,2,1,"c.PyBuffer_SizeFromFormat"],PyBuffer_ToContiguous:[7,2,1,"c.PyBuffer_ToContiguous"],PyByteArrayObject:[8,1,1,"c.PyByteArrayObject"],PyByteArray_AS_STRING:[8,2,1,"c.PyByteArray_AS_STRING"],PyByteArray_AsString:[8,2,1,"c.PyByteArray_AsString"],PyByteArray_Check:[8,2,1,"c.PyByteArray_Check"],PyByteArray_CheckExact:[8,2,1,"c.PyByteArray_CheckExact"],PyByteArray_Concat:[8,2,1,"c.PyByteArray_Concat"],PyByteArray_FromObject:[8,2,1,"c.PyByteArray_FromObject"],PyByteArray_FromStringAndSize:[8,2,1,"c.PyByteArray_FromStringAndSize"],PyByteArray_GET_SIZE:[8,2,1,"c.PyByteArray_GET_SIZE"],PyByteArray_Resize:[8,2,1,"c.PyByteArray_Resize"],PyByteArray_Size:[8,2,1,"c.PyByteArray_Size"],PyByteArray_Type:[8,0,1,"c.PyByteArray_Type"],PyBytesObject:[9,1,1,"c.PyBytesObject"],PyBytes_AS_STRING:[9,2,1,"c.PyBytes_AS_STRING"],PyBytes_AsString:[9,2,1,"c.PyBytes_AsString"],PyBytes_AsStringAndSize:[9,2,1,"c.PyBytes_AsStringAndSize"],PyBytes_Check:[9,2,1,"c.PyBytes_Check"],PyBytes_CheckExact:[9,2,1,"c.PyBytes_CheckExact"],PyBytes_Concat:[9,2,1,"c.PyBytes_Concat"],PyBytes_ConcatAndDel:[9,2,1,"c.PyBytes_ConcatAndDel"],PyBytes_FromFormat:[9,2,1,"c.PyBytes_FromFormat"],PyBytes_FromFormatV:[9,2,1,"c.PyBytes_FromFormatV"],PyBytes_FromObject:[9,2,1,"c.PyBytes_FromObject"],PyBytes_FromString:[9,2,1,"c.PyBytes_FromString"],PyBytes_FromStringAndSize:[9,2,1,"c.PyBytes_FromStringAndSize"],PyBytes_GET_SIZE:[9,2,1,"c.PyBytes_GET_SIZE"],PyBytes_Size:[9,2,1,"c.PyBytes_Size"],PyBytes_Type:[9,0,1,"c.PyBytes_Type"],PyCFunction:[53,1,1,"c.PyCFunction"],PyCFunctionWithKeywords:[53,1,1,"c.PyCFunctionWithKeywords"],PyCallIter_Check:[33,2,1,"c.PyCallIter_Check"],PyCallIter_New:[33,2,1,"c.PyCallIter_New"],PyCallIter_Type:[33,0,1,"c.PyCallIter_Type"],PyCallable_Check:[45,2,1,"c.PyCallable_Check"],PyCapsule:[10,1,1,"c.PyCapsule"],PyCapsule_CheckExact:[10,2,1,"c.PyCapsule_CheckExact"],PyCapsule_Destructor:[10,1,1,"c.PyCapsule_Destructor"],PyCapsule_GetContext:[10,2,1,"c.PyCapsule_GetContext"],PyCapsule_GetDestructor:[10,2,1,"c.PyCapsule_GetDestructor"],PyCapsule_GetName:[10,2,1,"c.PyCapsule_GetName"],PyCapsule_GetPointer:[10,2,1,"c.PyCapsule_GetPointer"],PyCapsule_Import:[10,2,1,"c.PyCapsule_Import"],PyCapsule_IsValid:[10,2,1,"c.PyCapsule_IsValid"],PyCapsule_New:[10,2,1,"c.PyCapsule_New"],PyCapsule_SetContext:[10,2,1,"c.PyCapsule_SetContext"],PyCapsule_SetDestructor:[10,2,1,"c.PyCapsule_SetDestructor"],PyCapsule_SetName:[10,2,1,"c.PyCapsule_SetName"],PyCapsule_SetPointer:[10,2,1,"c.PyCapsule_SetPointer"],PyCellObject:[11,1,1,"c.PyCellObject"],PyCell_Check:[11,2,1,"c.PyCell_Check"],PyCell_GET:[11,2,1,"c.PyCell_GET"],PyCell_Get:[11,2,1,"c.PyCell_Get"],PyCell_New:[11,2,1,"c.PyCell_New"],PyCell_SET:[11,2,1,"c.PyCell_SET"],PyCell_Set:[11,2,1,"c.PyCell_Set"],PyCell_Type:[11,0,1,"c.PyCell_Type"],PyCodeObject:[12,1,1,"c.PyCodeObject"],PyCode_Check:[12,2,1,"c.PyCode_Check"],PyCode_GetNumFree:[12,2,1,"c.PyCode_GetNumFree"],PyCode_New:[12,2,1,"c.PyCode_New"],PyCode_NewEmpty:[12,2,1,"c.PyCode_NewEmpty"],PyCode_Type:[12,0,1,"c.PyCode_Type"],PyCodec_BackslashReplaceErrors:[13,2,1,"c.PyCodec_BackslashReplaceErrors"],PyCodec_Decode:[13,2,1,"c.PyCodec_Decode"],PyCodec_Decoder:[13,2,1,"c.PyCodec_Decoder"],PyCodec_Encode:[13,2,1,"c.PyCodec_Encode"],PyCodec_Encoder:[13,2,1,"c.PyCodec_Encoder"],PyCodec_IgnoreErrors:[13,2,1,"c.PyCodec_IgnoreErrors"],PyCodec_IncrementalDecoder:[13,2,1,"c.PyCodec_IncrementalDecoder"],PyCodec_IncrementalEncoder:[13,2,1,"c.PyCodec_IncrementalEncoder"],PyCodec_KnownEncoding:[13,2,1,"c.PyCodec_KnownEncoding"],PyCodec_LookupError:[13,2,1,"c.PyCodec_LookupError"],PyCodec_NameReplaceErrors:[13,2,1,"c.PyCodec_NameReplaceErrors"],PyCodec_Register:[13,2,1,"c.PyCodec_Register"],PyCodec_RegisterError:[13,2,1,"c.PyCodec_RegisterError"],PyCodec_ReplaceErrors:[13,2,1,"c.PyCodec_ReplaceErrors"],PyCodec_StreamReader:[13,2,1,"c.PyCodec_StreamReader"],PyCodec_StreamWriter:[13,2,1,"c.PyCodec_StreamWriter"],PyCodec_StrictErrors:[13,2,1,"c.PyCodec_StrictErrors"],PyCodec_XMLCharRefReplaceErrors:[13,2,1,"c.PyCodec_XMLCharRefReplaceErrors"],PyCompactUnicodeObject:[58,1,1,"c.PyCompactUnicodeObject"],PyCompilerFlags:[60,1,1,"c.PyCompilerFlags"],PyComplexObject:[14,1,1,"c.PyComplexObject"],PyComplex_AsCComplex:[14,2,1,"c.PyComplex_AsCComplex"],PyComplex_Check:[14,2,1,"c.PyComplex_Check"],PyComplex_CheckExact:[14,2,1,"c.PyComplex_CheckExact"],PyComplex_FromCComplex:[14,2,1,"c.PyComplex_FromCComplex"],PyComplex_FromDoubles:[14,2,1,"c.PyComplex_FromDoubles"],PyComplex_ImagAsDouble:[14,2,1,"c.PyComplex_ImagAsDouble"],PyComplex_RealAsDouble:[14,2,1,"c.PyComplex_RealAsDouble"],PyComplex_Type:[14,0,1,"c.PyComplex_Type"],PyContext:[16,1,1,"c.PyContext"],PyContextToken:[16,1,1,"c.PyContextToken"],PyContextToken_CheckExact:[16,2,1,"c.PyContextToken_CheckExact"],PyContextToken_Type:[16,0,1,"c.PyContextToken_Type"],PyContextVar:[16,1,1,"c.PyContextVar"],PyContextVar_CheckExact:[16,2,1,"c.PyContextVar_CheckExact"],PyContextVar_Get:[16,2,1,"c.PyContextVar_Get"],PyContextVar_New:[16,2,1,"c.PyContextVar_New"],PyContextVar_Reset:[16,2,1,"c.PyContextVar_Reset"],PyContextVar_Set:[16,2,1,"c.PyContextVar_Set"],PyContextVar_Type:[16,0,1,"c.PyContextVar_Type"],PyContext_CheckExact:[16,2,1,"c.PyContext_CheckExact"],PyContext_ClearFreeList:[16,2,1,"c.PyContext_ClearFreeList"],PyContext_Copy:[16,2,1,"c.PyContext_Copy"],PyContext_CopyCurrent:[16,2,1,"c.PyContext_CopyCurrent"],PyContext_Enter:[16,2,1,"c.PyContext_Enter"],PyContext_Exit:[16,2,1,"c.PyContext_Exit"],PyContext_New:[16,2,1,"c.PyContext_New"],PyContext_Type:[16,0,1,"c.PyContext_Type"],PyCoroObject:[18,1,1,"c.PyCoroObject"],PyCoro_CheckExact:[18,2,1,"c.PyCoro_CheckExact"],PyCoro_New:[18,2,1,"c.PyCoro_New"],PyCoro_Type:[18,0,1,"c.PyCoro_Type"],PyDateTime_Check:[19,2,1,"c.PyDateTime_Check"],PyDateTime_CheckExact:[19,2,1,"c.PyDateTime_CheckExact"],PyDateTime_DATE_GET_HOUR:[19,2,1,"c.PyDateTime_DATE_GET_HOUR"],PyDateTime_DATE_GET_MICROSECOND:[19,2,1,"c.PyDateTime_DATE_GET_MICROSECOND"],PyDateTime_DATE_GET_MINUTE:[19,2,1,"c.PyDateTime_DATE_GET_MINUTE"],PyDateTime_DATE_GET_SECOND:[19,2,1,"c.PyDateTime_DATE_GET_SECOND"],PyDateTime_DELTA_GET_DAYS:[19,2,1,"c.PyDateTime_DELTA_GET_DAYS"],PyDateTime_DELTA_GET_MICROSECONDS:[19,2,1,"c.PyDateTime_DELTA_GET_MICROSECONDS"],PyDateTime_DELTA_GET_SECONDS:[19,2,1,"c.PyDateTime_DELTA_GET_SECONDS"],PyDateTime_FromDateAndTime:[19,2,1,"c.PyDateTime_FromDateAndTime"],PyDateTime_FromDateAndTimeAndFold:[19,2,1,"c.PyDateTime_FromDateAndTimeAndFold"],PyDateTime_FromTimestamp:[19,2,1,"c.PyDateTime_FromTimestamp"],PyDateTime_GET_DAY:[19,2,1,"c.PyDateTime_GET_DAY"],PyDateTime_GET_MONTH:[19,2,1,"c.PyDateTime_GET_MONTH"],PyDateTime_GET_YEAR:[19,2,1,"c.PyDateTime_GET_YEAR"],PyDateTime_TIME_GET_HOUR:[19,2,1,"c.PyDateTime_TIME_GET_HOUR"],PyDateTime_TIME_GET_MICROSECOND:[19,2,1,"c.PyDateTime_TIME_GET_MICROSECOND"],PyDateTime_TIME_GET_MINUTE:[19,2,1,"c.PyDateTime_TIME_GET_MINUTE"],PyDateTime_TIME_GET_SECOND:[19,2,1,"c.PyDateTime_TIME_GET_SECOND"],PyDateTime_TimeZone_UTC:[19,0,1,"c.PyDateTime_TimeZone_UTC"],PyDate_Check:[19,2,1,"c.PyDate_Check"],PyDate_CheckExact:[19,2,1,"c.PyDate_CheckExact"],PyDate_FromDate:[19,2,1,"c.PyDate_FromDate"],PyDate_FromTimestamp:[19,2,1,"c.PyDate_FromTimestamp"],PyDelta_Check:[19,2,1,"c.PyDelta_Check"],PyDelta_CheckExact:[19,2,1,"c.PyDelta_CheckExact"],PyDelta_FromDSU:[19,2,1,"c.PyDelta_FromDSU"],PyDescr_IsData:[20,2,1,"c.PyDescr_IsData"],PyDescr_NewClassMethod:[20,2,1,"c.PyDescr_NewClassMethod"],PyDescr_NewGetSet:[20,2,1,"c.PyDescr_NewGetSet"],PyDescr_NewMember:[20,2,1,"c.PyDescr_NewMember"],PyDescr_NewMethod:[20,2,1,"c.PyDescr_NewMethod"],PyDescr_NewWrapper:[20,2,1,"c.PyDescr_NewWrapper"],PyDictObject:[21,1,1,"c.PyDictObject"],PyDictProxy_New:[21,2,1,"c.PyDictProxy_New"],PyDict_Check:[21,2,1,"c.PyDict_Check"],PyDict_CheckExact:[21,2,1,"c.PyDict_CheckExact"],PyDict_Clear:[21,2,1,"c.PyDict_Clear"],PyDict_ClearFreeList:[21,2,1,"c.PyDict_ClearFreeList"],PyDict_Contains:[21,2,1,"c.PyDict_Contains"],PyDict_Copy:[21,2,1,"c.PyDict_Copy"],PyDict_DelItem:[21,2,1,"c.PyDict_DelItem"],PyDict_DelItemString:[21,2,1,"c.PyDict_DelItemString"],PyDict_GetItem:[21,2,1,"c.PyDict_GetItem"],PyDict_GetItemString:[21,2,1,"c.PyDict_GetItemString"],PyDict_GetItemWithError:[21,2,1,"c.PyDict_GetItemWithError"],PyDict_Items:[21,2,1,"c.PyDict_Items"],PyDict_Keys:[21,2,1,"c.PyDict_Keys"],PyDict_Merge:[21,2,1,"c.PyDict_Merge"],PyDict_MergeFromSeq2:[21,2,1,"c.PyDict_MergeFromSeq2"],PyDict_New:[21,2,1,"c.PyDict_New"],PyDict_Next:[21,2,1,"c.PyDict_Next"],PyDict_SetDefault:[21,2,1,"c.PyDict_SetDefault"],PyDict_SetItem:[21,2,1,"c.PyDict_SetItem"],PyDict_SetItemString:[21,2,1,"c.PyDict_SetItemString"],PyDict_Size:[21,2,1,"c.PyDict_Size"],PyDict_Type:[21,0,1,"c.PyDict_Type"],PyDict_Update:[21,2,1,"c.PyDict_Update"],PyDict_Values:[21,2,1,"c.PyDict_Values"],PyErr_BadArgument:[22,2,1,"c.PyErr_BadArgument"],PyErr_BadInternalCall:[22,2,1,"c.PyErr_BadInternalCall"],PyErr_CheckSignals:[22,2,1,"c.PyErr_CheckSignals"],PyErr_Clear:[22,2,1,"c.PyErr_Clear"],PyErr_ExceptionMatches:[22,2,1,"c.PyErr_ExceptionMatches"],PyErr_Fetch:[22,2,1,"c.PyErr_Fetch"],PyErr_Format:[22,2,1,"c.PyErr_Format"],PyErr_FormatV:[22,2,1,"c.PyErr_FormatV"],PyErr_GetExcInfo:[22,2,1,"c.PyErr_GetExcInfo"],PyErr_GivenExceptionMatches:[22,2,1,"c.PyErr_GivenExceptionMatches"],PyErr_NewException:[22,2,1,"c.PyErr_NewException"],PyErr_NewExceptionWithDoc:[22,2,1,"c.PyErr_NewExceptionWithDoc"],PyErr_NoMemory:[22,2,1,"c.PyErr_NoMemory"],PyErr_NormalizeException:[22,2,1,"c.PyErr_NormalizeException"],PyErr_Occurred:[22,2,1,"c.PyErr_Occurred"],PyErr_Print:[22,2,1,"c.PyErr_Print"],PyErr_PrintEx:[22,2,1,"c.PyErr_PrintEx"],PyErr_ResourceWarning:[22,2,1,"c.PyErr_ResourceWarning"],PyErr_Restore:[22,2,1,"c.PyErr_Restore"],PyErr_SetExcFromWindowsErr:[22,2,1,"c.PyErr_SetExcFromWindowsErr"],PyErr_SetExcFromWindowsErrWithFilename:[22,2,1,"c.PyErr_SetExcFromWindowsErrWithFilename"],PyErr_SetExcFromWindowsErrWithFilenameObject:[22,2,1,"c.PyErr_SetExcFromWindowsErrWithFilenameObject"],PyErr_SetExcFromWindowsErrWithFilenameObjects:[22,2,1,"c.PyErr_SetExcFromWindowsErrWithFilenameObjects"],PyErr_SetExcInfo:[22,2,1,"c.PyErr_SetExcInfo"],PyErr_SetFromErrno:[22,2,1,"c.PyErr_SetFromErrno"],PyErr_SetFromErrnoWithFilename:[22,2,1,"c.PyErr_SetFromErrnoWithFilename"],PyErr_SetFromErrnoWithFilenameObject:[22,2,1,"c.PyErr_SetFromErrnoWithFilenameObject"],PyErr_SetFromErrnoWithFilenameObjects:[22,2,1,"c.PyErr_SetFromErrnoWithFilenameObjects"],PyErr_SetFromWindowsErr:[22,2,1,"c.PyErr_SetFromWindowsErr"],PyErr_SetFromWindowsErrWithFilename:[22,2,1,"c.PyErr_SetFromWindowsErrWithFilename"],PyErr_SetImportError:[22,2,1,"c.PyErr_SetImportError"],PyErr_SetImportErrorSubclass:[22,2,1,"c.PyErr_SetImportErrorSubclass"],PyErr_SetInterrupt:[22,2,1,"c.PyErr_SetInterrupt"],PyErr_SetNone:[22,2,1,"c.PyErr_SetNone"],PyErr_SetObject:[22,2,1,"c.PyErr_SetObject"],PyErr_SetString:[22,2,1,"c.PyErr_SetString"],PyErr_SyntaxLocation:[22,2,1,"c.PyErr_SyntaxLocation"],PyErr_SyntaxLocationEx:[22,2,1,"c.PyErr_SyntaxLocationEx"],PyErr_SyntaxLocationObject:[22,2,1,"c.PyErr_SyntaxLocationObject"],PyErr_WarnEx:[22,2,1,"c.PyErr_WarnEx"],PyErr_WarnExplicit:[22,2,1,"c.PyErr_WarnExplicit"],PyErr_WarnExplicitObject:[22,2,1,"c.PyErr_WarnExplicitObject"],PyErr_WarnFormat:[22,2,1,"c.PyErr_WarnFormat"],PyErr_WriteUnraisable:[22,2,1,"c.PyErr_WriteUnraisable"],PyEval_AcquireLock:[30,2,1,"c.PyEval_AcquireLock"],PyEval_AcquireThread:[30,2,1,"c.PyEval_AcquireThread"],PyEval_EvalCode:[60,2,1,"c.PyEval_EvalCode"],PyEval_EvalCodeEx:[60,2,1,"c.PyEval_EvalCodeEx"],PyEval_EvalFrame:[60,2,1,"c.PyEval_EvalFrame"],PyEval_EvalFrameEx:[60,2,1,"c.PyEval_EvalFrameEx"],PyEval_GetBuiltins:[48,2,1,"c.PyEval_GetBuiltins"],PyEval_GetFrame:[48,2,1,"c.PyEval_GetFrame"],PyEval_GetFuncDesc:[48,2,1,"c.PyEval_GetFuncDesc"],PyEval_GetFuncName:[48,2,1,"c.PyEval_GetFuncName"],PyEval_GetGlobals:[48,2,1,"c.PyEval_GetGlobals"],PyEval_GetLocals:[48,2,1,"c.PyEval_GetLocals"],PyEval_InitThreads:[30,2,1,"c.PyEval_InitThreads"],PyEval_MergeCompilerFlags:[60,2,1,"c.PyEval_MergeCompilerFlags"],PyEval_ReInitThreads:[30,2,1,"c.PyEval_ReInitThreads"],PyEval_ReleaseLock:[30,2,1,"c.PyEval_ReleaseLock"],PyEval_ReleaseThread:[30,2,1,"c.PyEval_ReleaseThread"],PyEval_RestoreThread:[30,2,1,"c.PyEval_RestoreThread"],PyEval_SaveThread:[30,2,1,"c.PyEval_SaveThread"],PyEval_SetProfile:[30,2,1,"c.PyEval_SetProfile"],PyEval_SetTrace:[30,2,1,"c.PyEval_SetTrace"],PyEval_ThreadsInitialized:[30,2,1,"c.PyEval_ThreadsInitialized"],PyException_GetCause:[22,2,1,"c.PyException_GetCause"],PyException_GetContext:[22,2,1,"c.PyException_GetContext"],PyException_GetTraceback:[22,2,1,"c.PyException_GetTraceback"],PyException_SetCause:[22,2,1,"c.PyException_SetCause"],PyException_SetContext:[22,2,1,"c.PyException_SetContext"],PyException_SetTraceback:[22,2,1,"c.PyException_SetTraceback"],PyFile_FromFd:[23,2,1,"c.PyFile_FromFd"],PyFile_GetLine:[23,2,1,"c.PyFile_GetLine"],PyFile_WriteObject:[23,2,1,"c.PyFile_WriteObject"],PyFile_WriteString:[23,2,1,"c.PyFile_WriteString"],PyFloatObject:[24,1,1,"c.PyFloatObject"],PyFloat_AS_DOUBLE:[24,2,1,"c.PyFloat_AS_DOUBLE"],PyFloat_AsDouble:[24,2,1,"c.PyFloat_AsDouble"],PyFloat_Check:[24,2,1,"c.PyFloat_Check"],PyFloat_CheckExact:[24,2,1,"c.PyFloat_CheckExact"],PyFloat_ClearFreeList:[24,2,1,"c.PyFloat_ClearFreeList"],PyFloat_FromDouble:[24,2,1,"c.PyFloat_FromDouble"],PyFloat_FromString:[24,2,1,"c.PyFloat_FromString"],PyFloat_GetInfo:[24,2,1,"c.PyFloat_GetInfo"],PyFloat_GetMax:[24,2,1,"c.PyFloat_GetMax"],PyFloat_GetMin:[24,2,1,"c.PyFloat_GetMin"],PyFloat_Type:[24,0,1,"c.PyFloat_Type"],PyFrameObject:[60,1,1,"c.PyFrameObject"],PyFrame_GetLineNumber:[48,2,1,"c.PyFrame_GetLineNumber"],PyFrozenSet_Check:[50,2,1,"c.PyFrozenSet_Check"],PyFrozenSet_CheckExact:[50,2,1,"c.PyFrozenSet_CheckExact"],PyFrozenSet_New:[50,2,1,"c.PyFrozenSet_New"],PyFrozenSet_Type:[50,0,1,"c.PyFrozenSet_Type"],PyFunctionObject:[25,1,1,"c.PyFunctionObject"],PyFunction_Check:[25,2,1,"c.PyFunction_Check"],PyFunction_GetAnnotations:[25,2,1,"c.PyFunction_GetAnnotations"],PyFunction_GetClosure:[25,2,1,"c.PyFunction_GetClosure"],PyFunction_GetCode:[25,2,1,"c.PyFunction_GetCode"],PyFunction_GetDefaults:[25,2,1,"c.PyFunction_GetDefaults"],PyFunction_GetGlobals:[25,2,1,"c.PyFunction_GetGlobals"],PyFunction_GetModule:[25,2,1,"c.PyFunction_GetModule"],PyFunction_New:[25,2,1,"c.PyFunction_New"],PyFunction_NewWithQualName:[25,2,1,"c.PyFunction_NewWithQualName"],PyFunction_SetAnnotations:[25,2,1,"c.PyFunction_SetAnnotations"],PyFunction_SetClosure:[25,2,1,"c.PyFunction_SetClosure"],PyFunction_SetDefaults:[25,2,1,"c.PyFunction_SetDefaults"],PyFunction_Type:[25,0,1,"c.PyFunction_Type"],PyGILState_Check:[30,2,1,"c.PyGILState_Check"],PyGILState_Ensure:[30,2,1,"c.PyGILState_Ensure"],PyGILState_GetThisThreadState:[30,2,1,"c.PyGILState_GetThisThreadState"],PyGILState_Release:[30,2,1,"c.PyGILState_Release"],PyGenObject:[27,1,1,"c.PyGenObject"],PyGen_Check:[27,2,1,"c.PyGen_Check"],PyGen_CheckExact:[27,2,1,"c.PyGen_CheckExact"],PyGen_New:[27,2,1,"c.PyGen_New"],PyGen_NewWithQualName:[27,2,1,"c.PyGen_NewWithQualName"],PyGen_Type:[27,0,1,"c.PyGen_Type"],PyGetSetDef:[53,1,1,"c.PyGetSetDef"],PyImport_AddModule:[28,2,1,"c.PyImport_AddModule"],PyImport_AddModuleObject:[28,2,1,"c.PyImport_AddModuleObject"],PyImport_AppendInittab:[28,2,1,"c.PyImport_AppendInittab"],PyImport_Cleanup:[28,2,1,"c.PyImport_Cleanup"],PyImport_ExecCodeModule:[28,2,1,"c.PyImport_ExecCodeModule"],PyImport_ExecCodeModuleEx:[28,2,1,"c.PyImport_ExecCodeModuleEx"],PyImport_ExecCodeModuleObject:[28,2,1,"c.PyImport_ExecCodeModuleObject"],PyImport_ExecCodeModuleWithPathnames:[28,2,1,"c.PyImport_ExecCodeModuleWithPathnames"],PyImport_ExtendInittab:[28,2,1,"c.PyImport_ExtendInittab"],PyImport_FrozenModules:[28,0,1,"c.PyImport_FrozenModules"],PyImport_GetImporter:[28,2,1,"c.PyImport_GetImporter"],PyImport_GetMagicNumber:[28,2,1,"c.PyImport_GetMagicNumber"],PyImport_GetMagicTag:[28,2,1,"c.PyImport_GetMagicTag"],PyImport_GetModule:[28,2,1,"c.PyImport_GetModule"],PyImport_GetModuleDict:[28,2,1,"c.PyImport_GetModuleDict"],PyImport_Import:[28,2,1,"c.PyImport_Import"],PyImport_ImportFrozenModule:[28,2,1,"c.PyImport_ImportFrozenModule"],PyImport_ImportFrozenModuleObject:[28,2,1,"c.PyImport_ImportFrozenModuleObject"],PyImport_ImportModule:[28,2,1,"c.PyImport_ImportModule"],PyImport_ImportModuleEx:[28,2,1,"c.PyImport_ImportModuleEx"],PyImport_ImportModuleLevel:[28,2,1,"c.PyImport_ImportModuleLevel"],PyImport_ImportModuleLevelObject:[28,2,1,"c.PyImport_ImportModuleLevelObject"],PyImport_ImportModuleNoBlock:[28,2,1,"c.PyImport_ImportModuleNoBlock"],PyImport_ReloadModule:[28,2,1,"c.PyImport_ReloadModule"],PyIndex_Check:[43,2,1,"c.PyIndex_Check"],PyInit_modulename:[77,2,1,"c.PyInit_modulename"],PyInstanceMethod_Check:[40,2,1,"c.PyInstanceMethod_Check"],PyInstanceMethod_Function:[40,2,1,"c.PyInstanceMethod_Function"],PyInstanceMethod_GET_FUNCTION:[40,2,1,"c.PyInstanceMethod_GET_FUNCTION"],PyInstanceMethod_New:[40,2,1,"c.PyInstanceMethod_New"],PyInstanceMethod_Type:[40,0,1,"c.PyInstanceMethod_Type"],PyInterpreterState:[30,1,1,"c.PyInterpreterState"],PyInterpreterState_Clear:[30,2,1,"c.PyInterpreterState_Clear"],PyInterpreterState_Delete:[30,2,1,"c.PyInterpreterState_Delete"],PyInterpreterState_GetID:[30,2,1,"c.PyInterpreterState_GetID"],PyInterpreterState_Head:[30,2,1,"c.PyInterpreterState_Head"],PyInterpreterState_Main:[30,2,1,"c.PyInterpreterState_Main"],PyInterpreterState_New:[30,2,1,"c.PyInterpreterState_New"],PyInterpreterState_Next:[30,2,1,"c.PyInterpreterState_Next"],PyInterpreterState_ThreadHead:[30,2,1,"c.PyInterpreterState_ThreadHead"],PyIter_Check:[32,2,1,"c.PyIter_Check"],PyIter_Next:[32,2,1,"c.PyIter_Next"],PyListObject:[34,1,1,"c.PyListObject"],PyList_Append:[34,2,1,"c.PyList_Append"],PyList_AsTuple:[34,2,1,"c.PyList_AsTuple"],PyList_Check:[34,2,1,"c.PyList_Check"],PyList_CheckExact:[34,2,1,"c.PyList_CheckExact"],PyList_ClearFreeList:[34,2,1,"c.PyList_ClearFreeList"],PyList_GET_ITEM:[34,2,1,"c.PyList_GET_ITEM"],PyList_GET_SIZE:[34,2,1,"c.PyList_GET_SIZE"],PyList_GetItem:[34,2,1,"c.PyList_GetItem"],PyList_GetSlice:[34,2,1,"c.PyList_GetSlice"],PyList_Insert:[34,2,1,"c.PyList_Insert"],PyList_New:[34,2,1,"c.PyList_New"],PyList_Reverse:[34,2,1,"c.PyList_Reverse"],PyList_SET_ITEM:[34,2,1,"c.PyList_SET_ITEM"],PyList_SetItem:[34,2,1,"c.PyList_SetItem"],PyList_SetSlice:[34,2,1,"c.PyList_SetSlice"],PyList_Size:[34,2,1,"c.PyList_Size"],PyList_Sort:[34,2,1,"c.PyList_Sort"],PyList_Type:[34,0,1,"c.PyList_Type"],PyLongObject:[35,1,1,"c.PyLongObject"],PyLong_AsDouble:[35,2,1,"c.PyLong_AsDouble"],PyLong_AsLong:[35,2,1,"c.PyLong_AsLong"],PyLong_AsLongAndOverflow:[35,2,1,"c.PyLong_AsLongAndOverflow"],PyLong_AsLongLong:[35,2,1,"c.PyLong_AsLongLong"],PyLong_AsLongLongAndOverflow:[35,2,1,"c.PyLong_AsLongLongAndOverflow"],PyLong_AsSize_t:[35,2,1,"c.PyLong_AsSize_t"],PyLong_AsSsize_t:[35,2,1,"c.PyLong_AsSsize_t"],PyLong_AsUnsignedLong:[35,2,1,"c.PyLong_AsUnsignedLong"],PyLong_AsUnsignedLongLong:[35,2,1,"c.PyLong_AsUnsignedLongLong"],PyLong_AsUnsignedLongLongMask:[35,2,1,"c.PyLong_AsUnsignedLongLongMask"],PyLong_AsUnsignedLongMask:[35,2,1,"c.PyLong_AsUnsignedLongMask"],PyLong_AsVoidPtr:[35,2,1,"c.PyLong_AsVoidPtr"],PyLong_Check:[35,2,1,"c.PyLong_Check"],PyLong_CheckExact:[35,2,1,"c.PyLong_CheckExact"],PyLong_FromDouble:[35,2,1,"c.PyLong_FromDouble"],PyLong_FromLong:[35,2,1,"c.PyLong_FromLong"],PyLong_FromLongLong:[35,2,1,"c.PyLong_FromLongLong"],PyLong_FromSize_t:[35,2,1,"c.PyLong_FromSize_t"],PyLong_FromSsize_t:[35,2,1,"c.PyLong_FromSsize_t"],PyLong_FromString:[35,2,1,"c.PyLong_FromString"],PyLong_FromUnicode:[35,2,1,"c.PyLong_FromUnicode"],PyLong_FromUnicodeObject:[35,2,1,"c.PyLong_FromUnicodeObject"],PyLong_FromUnsignedLong:[35,2,1,"c.PyLong_FromUnsignedLong"],PyLong_FromUnsignedLongLong:[35,2,1,"c.PyLong_FromUnsignedLongLong"],PyLong_FromVoidPtr:[35,2,1,"c.PyLong_FromVoidPtr"],PyLong_Type:[35,0,1,"c.PyLong_Type"],PyMappingMethods:[57,1,1,"c.PyMappingMethods"],PyMapping_Check:[36,2,1,"c.PyMapping_Check"],PyMapping_DelItem:[36,2,1,"c.PyMapping_DelItem"],PyMapping_DelItemString:[36,2,1,"c.PyMapping_DelItemString"],PyMapping_GetItemString:[36,2,1,"c.PyMapping_GetItemString"],PyMapping_HasKey:[36,2,1,"c.PyMapping_HasKey"],PyMapping_HasKeyString:[36,2,1,"c.PyMapping_HasKeyString"],PyMapping_Items:[36,2,1,"c.PyMapping_Items"],PyMapping_Keys:[36,2,1,"c.PyMapping_Keys"],PyMapping_Length:[36,2,1,"c.PyMapping_Length"],PyMapping_SetItemString:[36,2,1,"c.PyMapping_SetItemString"],PyMapping_Size:[36,2,1,"c.PyMapping_Size"],PyMapping_Values:[36,2,1,"c.PyMapping_Values"],PyMarshal_ReadLastObjectFromFile:[37,2,1,"c.PyMarshal_ReadLastObjectFromFile"],PyMarshal_ReadLongFromFile:[37,2,1,"c.PyMarshal_ReadLongFromFile"],PyMarshal_ReadObjectFromFile:[37,2,1,"c.PyMarshal_ReadObjectFromFile"],PyMarshal_ReadObjectFromString:[37,2,1,"c.PyMarshal_ReadObjectFromString"],PyMarshal_ReadShortFromFile:[37,2,1,"c.PyMarshal_ReadShortFromFile"],PyMarshal_WriteLongToFile:[37,2,1,"c.PyMarshal_WriteLongToFile"],PyMarshal_WriteObjectToFile:[37,2,1,"c.PyMarshal_WriteObjectToFile"],PyMarshal_WriteObjectToString:[37,2,1,"c.PyMarshal_WriteObjectToString"],PyMemAllocatorDomain:[38,1,1,"c.PyMemAllocatorDomain"],PyMemAllocatorEx:[38,1,1,"c.PyMemAllocatorEx"],PyMem_Calloc:[38,2,1,"c.PyMem_Calloc"],PyMem_Del:[38,2,1,"c.PyMem_Del"],PyMem_Free:[38,2,1,"c.PyMem_Free"],PyMem_GetAllocator:[38,2,1,"c.PyMem_GetAllocator"],PyMem_Malloc:[38,2,1,"c.PyMem_Malloc"],PyMem_New:[38,2,1,"c.PyMem_New"],PyMem_RawCalloc:[38,2,1,"c.PyMem_RawCalloc"],PyMem_RawFree:[38,2,1,"c.PyMem_RawFree"],PyMem_RawMalloc:[38,2,1,"c.PyMem_RawMalloc"],PyMem_RawRealloc:[38,2,1,"c.PyMem_RawRealloc"],PyMem_Realloc:[38,2,1,"c.PyMem_Realloc"],PyMem_Resize:[38,2,1,"c.PyMem_Resize"],PyMem_SetAllocator:[38,2,1,"c.PyMem_SetAllocator"],PyMem_SetupDebugHooks:[38,2,1,"c.PyMem_SetupDebugHooks"],PyMemberDef:[53,1,1,"c.PyMemberDef"],PyMemoryView_Check:[39,2,1,"c.PyMemoryView_Check"],PyMemoryView_FromBuffer:[39,2,1,"c.PyMemoryView_FromBuffer"],PyMemoryView_FromMemory:[39,2,1,"c.PyMemoryView_FromMemory"],PyMemoryView_FromObject:[39,2,1,"c.PyMemoryView_FromObject"],PyMemoryView_GET_BASE:[39,2,1,"c.PyMemoryView_GET_BASE"],PyMemoryView_GET_BUFFER:[39,2,1,"c.PyMemoryView_GET_BUFFER"],PyMemoryView_GetContiguous:[39,2,1,"c.PyMemoryView_GetContiguous"],PyMethodDef:[53,1,1,"c.PyMethodDef"],PyMethod_Check:[40,2,1,"c.PyMethod_Check"],PyMethod_ClearFreeList:[40,2,1,"c.PyMethod_ClearFreeList"],PyMethod_Function:[40,2,1,"c.PyMethod_Function"],PyMethod_GET_FUNCTION:[40,2,1,"c.PyMethod_GET_FUNCTION"],PyMethod_GET_SELF:[40,2,1,"c.PyMethod_GET_SELF"],PyMethod_New:[40,2,1,"c.PyMethod_New"],PyMethod_Self:[40,2,1,"c.PyMethod_Self"],PyMethod_Type:[40,0,1,"c.PyMethod_Type"],PyModuleDef:[41,1,1,"c.PyModuleDef"],PyModuleDef_Init:[41,2,1,"c.PyModuleDef_Init"],PyModuleDef_Slot:[41,1,1,"c.PyModuleDef_Slot"],PyModule_AddFunctions:[41,2,1,"c.PyModule_AddFunctions"],PyModule_AddIntConstant:[41,2,1,"c.PyModule_AddIntConstant"],PyModule_AddIntMacro:[41,2,1,"c.PyModule_AddIntMacro"],PyModule_AddObject:[41,2,1,"c.PyModule_AddObject"],PyModule_AddStringConstant:[41,2,1,"c.PyModule_AddStringConstant"],PyModule_AddStringMacro:[41,2,1,"c.PyModule_AddStringMacro"],PyModule_Check:[41,2,1,"c.PyModule_Check"],PyModule_CheckExact:[41,2,1,"c.PyModule_CheckExact"],PyModule_Create2:[41,2,1,"c.PyModule_Create2"],PyModule_Create:[41,2,1,"c.PyModule_Create"],PyModule_ExecDef:[41,2,1,"c.PyModule_ExecDef"],PyModule_FromDefAndSpec2:[41,2,1,"c.PyModule_FromDefAndSpec2"],PyModule_FromDefAndSpec:[41,2,1,"c.PyModule_FromDefAndSpec"],PyModule_GetDef:[41,2,1,"c.PyModule_GetDef"],PyModule_GetDict:[41,2,1,"c.PyModule_GetDict"],PyModule_GetFilename:[41,2,1,"c.PyModule_GetFilename"],PyModule_GetFilenameObject:[41,2,1,"c.PyModule_GetFilenameObject"],PyModule_GetName:[41,2,1,"c.PyModule_GetName"],PyModule_GetNameObject:[41,2,1,"c.PyModule_GetNameObject"],PyModule_GetState:[41,2,1,"c.PyModule_GetState"],PyModule_New:[41,2,1,"c.PyModule_New"],PyModule_NewObject:[41,2,1,"c.PyModule_NewObject"],PyModule_SetDocString:[41,2,1,"c.PyModule_SetDocString"],PyModule_Type:[41,0,1,"c.PyModule_Type"],PyNumberMethods:[57,1,1,"c.PyNumberMethods"],PyNumber_Absolute:[43,2,1,"c.PyNumber_Absolute"],PyNumber_Add:[43,2,1,"c.PyNumber_Add"],PyNumber_And:[43,2,1,"c.PyNumber_And"],PyNumber_AsSsize_t:[43,2,1,"c.PyNumber_AsSsize_t"],PyNumber_Check:[43,2,1,"c.PyNumber_Check"],PyNumber_Divmod:[43,2,1,"c.PyNumber_Divmod"],PyNumber_Float:[43,2,1,"c.PyNumber_Float"],PyNumber_FloorDivide:[43,2,1,"c.PyNumber_FloorDivide"],PyNumber_InPlaceAdd:[43,2,1,"c.PyNumber_InPlaceAdd"],PyNumber_InPlaceAnd:[43,2,1,"c.PyNumber_InPlaceAnd"],PyNumber_InPlaceFloorDivide:[43,2,1,"c.PyNumber_InPlaceFloorDivide"],PyNumber_InPlaceLshift:[43,2,1,"c.PyNumber_InPlaceLshift"],PyNumber_InPlaceMatrixMultiply:[43,2,1,"c.PyNumber_InPlaceMatrixMultiply"],PyNumber_InPlaceMultiply:[43,2,1,"c.PyNumber_InPlaceMultiply"],PyNumber_InPlaceOr:[43,2,1,"c.PyNumber_InPlaceOr"],PyNumber_InPlacePower:[43,2,1,"c.PyNumber_InPlacePower"],PyNumber_InPlaceRemainder:[43,2,1,"c.PyNumber_InPlaceRemainder"],PyNumber_InPlaceRshift:[43,2,1,"c.PyNumber_InPlaceRshift"],PyNumber_InPlaceSubtract:[43,2,1,"c.PyNumber_InPlaceSubtract"],PyNumber_InPlaceTrueDivide:[43,2,1,"c.PyNumber_InPlaceTrueDivide"],PyNumber_InPlaceXor:[43,2,1,"c.PyNumber_InPlaceXor"],PyNumber_Index:[43,2,1,"c.PyNumber_Index"],PyNumber_Invert:[43,2,1,"c.PyNumber_Invert"],PyNumber_Long:[43,2,1,"c.PyNumber_Long"],PyNumber_Lshift:[43,2,1,"c.PyNumber_Lshift"],PyNumber_MatrixMultiply:[43,2,1,"c.PyNumber_MatrixMultiply"],PyNumber_Multiply:[43,2,1,"c.PyNumber_Multiply"],PyNumber_Negative:[43,2,1,"c.PyNumber_Negative"],PyNumber_Or:[43,2,1,"c.PyNumber_Or"],PyNumber_Positive:[43,2,1,"c.PyNumber_Positive"],PyNumber_Power:[43,2,1,"c.PyNumber_Power"],PyNumber_Remainder:[43,2,1,"c.PyNumber_Remainder"],PyNumber_Rshift:[43,2,1,"c.PyNumber_Rshift"],PyNumber_Subtract:[43,2,1,"c.PyNumber_Subtract"],PyNumber_ToBase:[43,2,1,"c.PyNumber_ToBase"],PyNumber_TrueDivide:[43,2,1,"c.PyNumber_TrueDivide"],PyNumber_Xor:[43,2,1,"c.PyNumber_Xor"],PyOS_AfterFork:[54,2,1,"c.PyOS_AfterFork"],PyOS_AfterFork_Child:[54,2,1,"c.PyOS_AfterFork_Child"],PyOS_AfterFork_Parent:[54,2,1,"c.PyOS_AfterFork_Parent"],PyOS_BeforeFork:[54,2,1,"c.PyOS_BeforeFork"],PyOS_CheckStack:[54,2,1,"c.PyOS_CheckStack"],PyOS_FSPath:[54,2,1,"c.PyOS_FSPath"],PyOS_InputHook:[60,0,1,"c.PyOS_InputHook"],PyOS_ReadlineFunctionPointer:[60,0,1,"c.PyOS_ReadlineFunctionPointer"],PyOS_double_to_string:[17,2,1,"c.PyOS_double_to_string"],PyOS_getsig:[54,2,1,"c.PyOS_getsig"],PyOS_setsig:[54,2,1,"c.PyOS_setsig"],PyOS_snprintf:[17,2,1,"c.PyOS_snprintf"],PyOS_stricmp:[17,2,1,"c.PyOS_stricmp"],PyOS_string_to_double:[17,2,1,"c.PyOS_string_to_double"],PyOS_strnicmp:[17,2,1,"c.PyOS_strnicmp"],PyOS_vsnprintf:[17,2,1,"c.PyOS_vsnprintf"],PyObject:[53,1,1,"c.PyObject"],PyObjectArenaAllocator:[38,1,1,"c.PyObjectArenaAllocator"],PyObject_ASCII:[45,2,1,"c.PyObject_ASCII"],PyObject_AsCharBuffer:[44,2,1,"c.PyObject_AsCharBuffer"],PyObject_AsFileDescriptor:[23,2,1,"c.PyObject_AsFileDescriptor"],PyObject_AsReadBuffer:[44,2,1,"c.PyObject_AsReadBuffer"],PyObject_AsWriteBuffer:[44,2,1,"c.PyObject_AsWriteBuffer"],PyObject_Bytes:[45,2,1,"c.PyObject_Bytes"],PyObject_Call:[45,2,1,"c.PyObject_Call"],PyObject_CallFunction:[45,2,1,"c.PyObject_CallFunction"],PyObject_CallFunctionObjArgs:[45,2,1,"c.PyObject_CallFunctionObjArgs"],PyObject_CallMethod:[45,2,1,"c.PyObject_CallMethod"],PyObject_CallMethodObjArgs:[45,2,1,"c.PyObject_CallMethodObjArgs"],PyObject_CallObject:[45,2,1,"c.PyObject_CallObject"],PyObject_Calloc:[38,2,1,"c.PyObject_Calloc"],PyObject_CheckBuffer:[7,2,1,"c.PyObject_CheckBuffer"],PyObject_CheckReadBuffer:[44,2,1,"c.PyObject_CheckReadBuffer"],PyObject_Del:[3,2,1,"c.PyObject_Del"],PyObject_DelAttr:[45,2,1,"c.PyObject_DelAttr"],PyObject_DelAttrString:[45,2,1,"c.PyObject_DelAttrString"],PyObject_DelItem:[45,2,1,"c.PyObject_DelItem"],PyObject_Dir:[45,2,1,"c.PyObject_Dir"],PyObject_Free:[38,2,1,"c.PyObject_Free"],PyObject_GC_Del:[26,2,1,"c.PyObject_GC_Del"],PyObject_GC_New:[26,2,1,"c.PyObject_GC_New"],PyObject_GC_NewVar:[26,2,1,"c.PyObject_GC_NewVar"],PyObject_GC_Resize:[26,2,1,"c.PyObject_GC_Resize"],PyObject_GC_Track:[26,2,1,"c.PyObject_GC_Track"],PyObject_GC_UnTrack:[26,2,1,"c.PyObject_GC_UnTrack"],PyObject_GenericGetAttr:[45,2,1,"c.PyObject_GenericGetAttr"],PyObject_GenericGetDict:[45,2,1,"c.PyObject_GenericGetDict"],PyObject_GenericSetAttr:[45,2,1,"c.PyObject_GenericSetAttr"],PyObject_GenericSetDict:[45,2,1,"c.PyObject_GenericSetDict"],PyObject_GetArenaAllocator:[38,2,1,"c.PyObject_GetArenaAllocator"],PyObject_GetAttr:[45,2,1,"c.PyObject_GetAttr"],PyObject_GetAttrString:[45,2,1,"c.PyObject_GetAttrString"],PyObject_GetBuffer:[7,2,1,"c.PyObject_GetBuffer"],PyObject_GetItem:[45,2,1,"c.PyObject_GetItem"],PyObject_GetIter:[45,2,1,"c.PyObject_GetIter"],PyObject_HEAD:[53,4,1,"c.PyObject_HEAD"],PyObject_HEAD_INIT:[53,4,1,"c.PyObject_HEAD_INIT"],PyObject_HasAttr:[45,2,1,"c.PyObject_HasAttr"],PyObject_HasAttrString:[45,2,1,"c.PyObject_HasAttrString"],PyObject_Hash:[45,2,1,"c.PyObject_Hash"],PyObject_HashNotImplemented:[45,2,1,"c.PyObject_HashNotImplemented"],PyObject_Init:[3,2,1,"c.PyObject_Init"],PyObject_InitVar:[3,2,1,"c.PyObject_InitVar"],PyObject_IsInstance:[45,2,1,"c.PyObject_IsInstance"],PyObject_IsSubclass:[45,2,1,"c.PyObject_IsSubclass"],PyObject_IsTrue:[45,2,1,"c.PyObject_IsTrue"],PyObject_Length:[45,2,1,"c.PyObject_Length"],PyObject_LengthHint:[45,2,1,"c.PyObject_LengthHint"],PyObject_Malloc:[38,2,1,"c.PyObject_Malloc"],PyObject_New:[3,2,1,"c.PyObject_New"],PyObject_NewVar:[3,2,1,"c.PyObject_NewVar"],PyObject_Not:[45,2,1,"c.PyObject_Not"],PyObject_Print:[45,2,1,"c.PyObject_Print"],PyObject_Realloc:[38,2,1,"c.PyObject_Realloc"],PyObject_Repr:[45,2,1,"c.PyObject_Repr"],PyObject_RichCompare:[45,2,1,"c.PyObject_RichCompare"],PyObject_RichCompareBool:[45,2,1,"c.PyObject_RichCompareBool"],PyObject_SetArenaAllocator:[38,2,1,"c.PyObject_SetArenaAllocator"],PyObject_SetAttr:[45,2,1,"c.PyObject_SetAttr"],PyObject_SetAttrString:[45,2,1,"c.PyObject_SetAttrString"],PyObject_SetItem:[45,2,1,"c.PyObject_SetItem"],PyObject_Size:[45,2,1,"c.PyObject_Size"],PyObject_Str:[45,2,1,"c.PyObject_Str"],PyObject_Type:[45,2,1,"c.PyObject_Type"],PyObject_TypeCheck:[45,2,1,"c.PyObject_TypeCheck"],PyObject_VAR_HEAD:[53,4,1,"c.PyObject_VAR_HEAD"],PyParser_SimpleParseFile:[60,2,1,"c.PyParser_SimpleParseFile"],PyParser_SimpleParseFileFlags:[60,2,1,"c.PyParser_SimpleParseFileFlags"],PyParser_SimpleParseString:[60,2,1,"c.PyParser_SimpleParseString"],PyParser_SimpleParseStringFlags:[60,2,1,"c.PyParser_SimpleParseStringFlags"],PyParser_SimpleParseStringFlagsFilename:[60,2,1,"c.PyParser_SimpleParseStringFlagsFilename"],PyProperty_Type:[20,0,1,"c.PyProperty_Type"],PyRun_AnyFile:[60,2,1,"c.PyRun_AnyFile"],PyRun_AnyFileEx:[60,2,1,"c.PyRun_AnyFileEx"],PyRun_AnyFileExFlags:[60,2,1,"c.PyRun_AnyFileExFlags"],PyRun_AnyFileFlags:[60,2,1,"c.PyRun_AnyFileFlags"],PyRun_File:[60,2,1,"c.PyRun_File"],PyRun_FileEx:[60,2,1,"c.PyRun_FileEx"],PyRun_FileExFlags:[60,2,1,"c.PyRun_FileExFlags"],PyRun_FileFlags:[60,2,1,"c.PyRun_FileFlags"],PyRun_InteractiveLoop:[60,2,1,"c.PyRun_InteractiveLoop"],PyRun_InteractiveLoopFlags:[60,2,1,"c.PyRun_InteractiveLoopFlags"],PyRun_InteractiveOne:[60,2,1,"c.PyRun_InteractiveOne"],PyRun_InteractiveOneFlags:[60,2,1,"c.PyRun_InteractiveOneFlags"],PyRun_SimpleFile:[60,2,1,"c.PyRun_SimpleFile"],PyRun_SimpleFileEx:[60,2,1,"c.PyRun_SimpleFileEx"],PyRun_SimpleFileExFlags:[60,2,1,"c.PyRun_SimpleFileExFlags"],PyRun_SimpleString:[60,2,1,"c.PyRun_SimpleString"],PyRun_SimpleStringFlags:[60,2,1,"c.PyRun_SimpleStringFlags"],PyRun_String:[60,2,1,"c.PyRun_String"],PyRun_StringFlags:[60,2,1,"c.PyRun_StringFlags"],PySeqIter_Check:[33,2,1,"c.PySeqIter_Check"],PySeqIter_New:[33,2,1,"c.PySeqIter_New"],PySeqIter_Type:[33,0,1,"c.PySeqIter_Type"],PySequenceMethods:[57,1,1,"c.PySequenceMethods"],PySequence_Check:[49,2,1,"c.PySequence_Check"],PySequence_Concat:[49,2,1,"c.PySequence_Concat"],PySequence_Contains:[49,2,1,"c.PySequence_Contains"],PySequence_Count:[49,2,1,"c.PySequence_Count"],PySequence_DelItem:[49,2,1,"c.PySequence_DelItem"],PySequence_DelSlice:[49,2,1,"c.PySequence_DelSlice"],PySequence_Fast:[49,2,1,"c.PySequence_Fast"],PySequence_Fast_GET_ITEM:[49,2,1,"c.PySequence_Fast_GET_ITEM"],PySequence_Fast_GET_SIZE:[49,2,1,"c.PySequence_Fast_GET_SIZE"],PySequence_Fast_ITEMS:[49,2,1,"c.PySequence_Fast_ITEMS"],PySequence_GetItem:[49,2,1,"c.PySequence_GetItem"],PySequence_GetSlice:[49,2,1,"c.PySequence_GetSlice"],PySequence_ITEM:[49,2,1,"c.PySequence_ITEM"],PySequence_InPlaceConcat:[49,2,1,"c.PySequence_InPlaceConcat"],PySequence_InPlaceRepeat:[49,2,1,"c.PySequence_InPlaceRepeat"],PySequence_Index:[49,2,1,"c.PySequence_Index"],PySequence_Length:[49,2,1,"c.PySequence_Length"],PySequence_List:[49,2,1,"c.PySequence_List"],PySequence_Repeat:[49,2,1,"c.PySequence_Repeat"],PySequence_SetItem:[49,2,1,"c.PySequence_SetItem"],PySequence_SetSlice:[49,2,1,"c.PySequence_SetSlice"],PySequence_Size:[49,2,1,"c.PySequence_Size"],PySequence_Tuple:[49,2,1,"c.PySequence_Tuple"],PySetObject:[50,1,1,"c.PySetObject"],PySet_Add:[50,2,1,"c.PySet_Add"],PySet_Check:[50,2,1,"c.PySet_Check"],PySet_Clear:[50,2,1,"c.PySet_Clear"],PySet_ClearFreeList:[50,2,1,"c.PySet_ClearFreeList"],PySet_Contains:[50,2,1,"c.PySet_Contains"],PySet_Discard:[50,2,1,"c.PySet_Discard"],PySet_GET_SIZE:[50,2,1,"c.PySet_GET_SIZE"],PySet_New:[50,2,1,"c.PySet_New"],PySet_Pop:[50,2,1,"c.PySet_Pop"],PySet_Size:[50,2,1,"c.PySet_Size"],PySet_Type:[50,0,1,"c.PySet_Type"],PySignal_SetWakeupFd:[22,2,1,"c.PySignal_SetWakeupFd"],PySlice_AdjustIndices:[51,2,1,"c.PySlice_AdjustIndices"],PySlice_Check:[51,2,1,"c.PySlice_Check"],PySlice_GetIndices:[51,2,1,"c.PySlice_GetIndices"],PySlice_GetIndicesEx:[51,2,1,"c.PySlice_GetIndicesEx"],PySlice_New:[51,2,1,"c.PySlice_New"],PySlice_Type:[51,0,1,"c.PySlice_Type"],PySlice_Unpack:[51,2,1,"c.PySlice_Unpack"],PyState_AddModule:[41,2,1,"c.PyState_AddModule"],PyState_FindModule:[41,2,1,"c.PyState_FindModule"],PyState_RemoveModule:[41,2,1,"c.PyState_RemoveModule"],PyStructSequence_Desc:[55,1,1,"c.PyStructSequence_Desc"],PyStructSequence_Field:[55,1,1,"c.PyStructSequence_Field"],PyStructSequence_GET_ITEM:[55,2,1,"c.PyStructSequence_GET_ITEM"],PyStructSequence_GetItem:[55,2,1,"c.PyStructSequence_GetItem"],PyStructSequence_InitType2:[55,2,1,"c.PyStructSequence_InitType2"],PyStructSequence_InitType:[55,2,1,"c.PyStructSequence_InitType"],PyStructSequence_New:[55,2,1,"c.PyStructSequence_New"],PyStructSequence_NewType:[55,2,1,"c.PyStructSequence_NewType"],PyStructSequence_SET_ITEM:[55,2,1,"c.PyStructSequence_SET_ITEM"],PyStructSequence_SetItem:[55,2,1,"c.PyStructSequence_SetItem"],PyStructSequence_UnnamedField:[55,0,1,"c.PyStructSequence_UnnamedField"],PySys_AddWarnOption:[54,2,1,"c.PySys_AddWarnOption"],PySys_AddWarnOptionUnicode:[54,2,1,"c.PySys_AddWarnOptionUnicode"],PySys_AddXOption:[54,2,1,"c.PySys_AddXOption"],PySys_FormatStderr:[54,2,1,"c.PySys_FormatStderr"],PySys_FormatStdout:[54,2,1,"c.PySys_FormatStdout"],PySys_GetObject:[54,2,1,"c.PySys_GetObject"],PySys_GetXOptions:[54,2,1,"c.PySys_GetXOptions"],PySys_ResetWarnOptions:[54,2,1,"c.PySys_ResetWarnOptions"],PySys_SetArgv:[30,2,1,"c.PySys_SetArgv"],PySys_SetArgvEx:[30,2,1,"c.PySys_SetArgvEx"],PySys_SetObject:[54,2,1,"c.PySys_SetObject"],PySys_SetPath:[54,2,1,"c.PySys_SetPath"],PySys_WriteStderr:[54,2,1,"c.PySys_WriteStderr"],PySys_WriteStdout:[54,2,1,"c.PySys_WriteStdout"],PyTZInfo_Check:[19,2,1,"c.PyTZInfo_Check"],PyTZInfo_CheckExact:[19,2,1,"c.PyTZInfo_CheckExact"],PyThreadState:[30,1,1,"c.PyThreadState"],PyThreadState_Clear:[30,2,1,"c.PyThreadState_Clear"],PyThreadState_Delete:[30,2,1,"c.PyThreadState_Delete"],PyThreadState_Get:[30,2,1,"c.PyThreadState_Get"],PyThreadState_GetDict:[30,2,1,"c.PyThreadState_GetDict"],PyThreadState_New:[30,2,1,"c.PyThreadState_New"],PyThreadState_Next:[30,2,1,"c.PyThreadState_Next"],PyThreadState_SetAsyncExc:[30,2,1,"c.PyThreadState_SetAsyncExc"],PyThreadState_Swap:[30,2,1,"c.PyThreadState_Swap"],PyThread_ReInitTLS:[30,2,1,"c.PyThread_ReInitTLS"],PyThread_create_key:[30,2,1,"c.PyThread_create_key"],PyThread_delete_key:[30,2,1,"c.PyThread_delete_key"],PyThread_delete_key_value:[30,2,1,"c.PyThread_delete_key_value"],PyThread_get_key_value:[30,2,1,"c.PyThread_get_key_value"],PyThread_set_key_value:[30,2,1,"c.PyThread_set_key_value"],PyThread_tss_alloc:[30,2,1,"c.PyThread_tss_alloc"],PyThread_tss_create:[30,2,1,"c.PyThread_tss_create"],PyThread_tss_delete:[30,2,1,"c.PyThread_tss_delete"],PyThread_tss_free:[30,2,1,"c.PyThread_tss_free"],PyThread_tss_get:[30,2,1,"c.PyThread_tss_get"],PyThread_tss_is_created:[30,2,1,"c.PyThread_tss_is_created"],PyThread_tss_set:[30,2,1,"c.PyThread_tss_set"],PyTimeZone_FromOffset:[19,2,1,"c.PyTimeZone_FromOffset"],PyTimeZone_FromOffsetAndName:[19,2,1,"c.PyTimeZone_FromOffsetAndName"],PyTime_Check:[19,2,1,"c.PyTime_Check"],PyTime_CheckExact:[19,2,1,"c.PyTime_CheckExact"],PyTime_FromTime:[19,2,1,"c.PyTime_FromTime"],PyTime_FromTimeAndFold:[19,2,1,"c.PyTime_FromTimeAndFold"],PyTrace_CALL:[30,0,1,"c.PyTrace_CALL"],PyTrace_C_CALL:[30,0,1,"c.PyTrace_C_CALL"],PyTrace_C_EXCEPTION:[30,0,1,"c.PyTrace_C_EXCEPTION"],PyTrace_C_RETURN:[30,0,1,"c.PyTrace_C_RETURN"],PyTrace_EXCEPTION:[30,0,1,"c.PyTrace_EXCEPTION"],PyTrace_LINE:[30,0,1,"c.PyTrace_LINE"],PyTrace_OPCODE:[30,0,1,"c.PyTrace_OPCODE"],PyTrace_RETURN:[30,0,1,"c.PyTrace_RETURN"],PyTupleObject:[55,1,1,"c.PyTupleObject"],PyTuple_Check:[55,2,1,"c.PyTuple_Check"],PyTuple_CheckExact:[55,2,1,"c.PyTuple_CheckExact"],PyTuple_ClearFreeList:[55,2,1,"c.PyTuple_ClearFreeList"],PyTuple_GET_ITEM:[55,2,1,"c.PyTuple_GET_ITEM"],PyTuple_GET_SIZE:[55,2,1,"c.PyTuple_GET_SIZE"],PyTuple_GetItem:[55,2,1,"c.PyTuple_GetItem"],PyTuple_GetSlice:[55,2,1,"c.PyTuple_GetSlice"],PyTuple_New:[55,2,1,"c.PyTuple_New"],PyTuple_Pack:[55,2,1,"c.PyTuple_Pack"],PyTuple_SET_ITEM:[55,2,1,"c.PyTuple_SET_ITEM"],PyTuple_SetItem:[55,2,1,"c.PyTuple_SetItem"],PyTuple_Size:[55,2,1,"c.PyTuple_Size"],PyTuple_Type:[55,0,1,"c.PyTuple_Type"],PyTypeObject:[56,1,1,"c.PyTypeObject"],PyType_Check:[56,2,1,"c.PyType_Check"],PyType_CheckExact:[56,2,1,"c.PyType_CheckExact"],PyType_ClearCache:[56,2,1,"c.PyType_ClearCache"],PyType_FromSpec:[56,2,1,"c.PyType_FromSpec"],PyType_FromSpecWithBases:[56,2,1,"c.PyType_FromSpecWithBases"],PyType_GenericAlloc:[56,2,1,"c.PyType_GenericAlloc"],PyType_GenericNew:[56,2,1,"c.PyType_GenericNew"],PyType_GetFlags:[56,2,1,"c.PyType_GetFlags"],PyType_GetSlot:[56,2,1,"c.PyType_GetSlot"],PyType_HasFeature:[56,2,1,"c.PyType_HasFeature"],PyType_IS_GC:[56,2,1,"c.PyType_IS_GC"],PyType_IsSubtype:[56,2,1,"c.PyType_IsSubtype"],PyType_Modified:[56,2,1,"c.PyType_Modified"],PyType_Ready:[56,2,1,"c.PyType_Ready"],PyType_Type:[56,0,1,"c.PyType_Type"],PyUnicodeDecodeError_Create:[22,2,1,"c.PyUnicodeDecodeError_Create"],PyUnicodeDecodeError_GetEncoding:[22,2,1,"c.PyUnicodeDecodeError_GetEncoding"],PyUnicodeDecodeError_GetEnd:[22,2,1,"c.PyUnicodeDecodeError_GetEnd"],PyUnicodeDecodeError_GetObject:[22,2,1,"c.PyUnicodeDecodeError_GetObject"],PyUnicodeDecodeError_GetReason:[22,2,1,"c.PyUnicodeDecodeError_GetReason"],PyUnicodeDecodeError_GetStart:[22,2,1,"c.PyUnicodeDecodeError_GetStart"],PyUnicodeDecodeError_SetEnd:[22,2,1,"c.PyUnicodeDecodeError_SetEnd"],PyUnicodeDecodeError_SetReason:[22,2,1,"c.PyUnicodeDecodeError_SetReason"],PyUnicodeDecodeError_SetStart:[22,2,1,"c.PyUnicodeDecodeError_SetStart"],PyUnicodeEncodeError_Create:[22,2,1,"c.PyUnicodeEncodeError_Create"],PyUnicodeEncodeError_GetEncoding:[22,2,1,"c.PyUnicodeEncodeError_GetEncoding"],PyUnicodeEncodeError_GetEnd:[22,2,1,"c.PyUnicodeEncodeError_GetEnd"],PyUnicodeEncodeError_GetObject:[22,2,1,"c.PyUnicodeEncodeError_GetObject"],PyUnicodeEncodeError_GetReason:[22,2,1,"c.PyUnicodeEncodeError_GetReason"],PyUnicodeEncodeError_GetStart:[22,2,1,"c.PyUnicodeEncodeError_GetStart"],PyUnicodeEncodeError_SetEnd:[22,2,1,"c.PyUnicodeEncodeError_SetEnd"],PyUnicodeEncodeError_SetReason:[22,2,1,"c.PyUnicodeEncodeError_SetReason"],PyUnicodeEncodeError_SetStart:[22,2,1,"c.PyUnicodeEncodeError_SetStart"],PyUnicodeObject:[58,1,1,"c.PyUnicodeObject"],PyUnicodeTranslateError_Create:[22,2,1,"c.PyUnicodeTranslateError_Create"],PyUnicodeTranslateError_GetEnd:[22,2,1,"c.PyUnicodeTranslateError_GetEnd"],PyUnicodeTranslateError_GetObject:[22,2,1,"c.PyUnicodeTranslateError_GetObject"],PyUnicodeTranslateError_GetReason:[22,2,1,"c.PyUnicodeTranslateError_GetReason"],PyUnicodeTranslateError_GetStart:[22,2,1,"c.PyUnicodeTranslateError_GetStart"],PyUnicodeTranslateError_SetEnd:[22,2,1,"c.PyUnicodeTranslateError_SetEnd"],PyUnicodeTranslateError_SetReason:[22,2,1,"c.PyUnicodeTranslateError_SetReason"],PyUnicodeTranslateError_SetStart:[22,2,1,"c.PyUnicodeTranslateError_SetStart"],PyUnicode_1BYTE_DATA:[58,2,1,"c.PyUnicode_1BYTE_DATA"],PyUnicode_1BYTE_KIND:[58,4,1,"c.PyUnicode_1BYTE_KIND"],PyUnicode_2BYTE_DATA:[58,2,1,"c.PyUnicode_2BYTE_DATA"],PyUnicode_2BYTE_KIND:[58,4,1,"c.PyUnicode_2BYTE_KIND"],PyUnicode_4BYTE_DATA:[58,2,1,"c.PyUnicode_4BYTE_DATA"],PyUnicode_4BYTE_KIND:[58,4,1,"c.PyUnicode_4BYTE_KIND"],PyUnicode_AS_DATA:[58,2,1,"c.PyUnicode_AS_DATA"],PyUnicode_AS_UNICODE:[58,2,1,"c.PyUnicode_AS_UNICODE"],PyUnicode_AsASCIIString:[58,2,1,"c.PyUnicode_AsASCIIString"],PyUnicode_AsCharmapString:[58,2,1,"c.PyUnicode_AsCharmapString"],PyUnicode_AsEncodedString:[58,2,1,"c.PyUnicode_AsEncodedString"],PyUnicode_AsLatin1String:[58,2,1,"c.PyUnicode_AsLatin1String"],PyUnicode_AsMBCSString:[58,2,1,"c.PyUnicode_AsMBCSString"],PyUnicode_AsRawUnicodeEscapeString:[58,2,1,"c.PyUnicode_AsRawUnicodeEscapeString"],PyUnicode_AsUCS4:[58,2,1,"c.PyUnicode_AsUCS4"],PyUnicode_AsUCS4Copy:[58,2,1,"c.PyUnicode_AsUCS4Copy"],PyUnicode_AsUTF16String:[58,2,1,"c.PyUnicode_AsUTF16String"],PyUnicode_AsUTF32String:[58,2,1,"c.PyUnicode_AsUTF32String"],PyUnicode_AsUTF8:[58,2,1,"c.PyUnicode_AsUTF8"],PyUnicode_AsUTF8AndSize:[58,2,1,"c.PyUnicode_AsUTF8AndSize"],PyUnicode_AsUTF8String:[58,2,1,"c.PyUnicode_AsUTF8String"],PyUnicode_AsUnicode:[58,2,1,"c.PyUnicode_AsUnicode"],PyUnicode_AsUnicodeAndSize:[58,2,1,"c.PyUnicode_AsUnicodeAndSize"],PyUnicode_AsUnicodeCopy:[58,2,1,"c.PyUnicode_AsUnicodeCopy"],PyUnicode_AsUnicodeEscapeString:[58,2,1,"c.PyUnicode_AsUnicodeEscapeString"],PyUnicode_AsWideChar:[58,2,1,"c.PyUnicode_AsWideChar"],PyUnicode_AsWideCharString:[58,2,1,"c.PyUnicode_AsWideCharString"],PyUnicode_Check:[58,2,1,"c.PyUnicode_Check"],PyUnicode_CheckExact:[58,2,1,"c.PyUnicode_CheckExact"],PyUnicode_ClearFreeList:[58,2,1,"c.PyUnicode_ClearFreeList"],PyUnicode_Compare:[58,2,1,"c.PyUnicode_Compare"],PyUnicode_CompareWithASCIIString:[58,2,1,"c.PyUnicode_CompareWithASCIIString"],PyUnicode_Concat:[58,2,1,"c.PyUnicode_Concat"],PyUnicode_Contains:[58,2,1,"c.PyUnicode_Contains"],PyUnicode_CopyCharacters:[58,2,1,"c.PyUnicode_CopyCharacters"],PyUnicode_Count:[58,2,1,"c.PyUnicode_Count"],PyUnicode_DATA:[58,2,1,"c.PyUnicode_DATA"],PyUnicode_Decode:[58,2,1,"c.PyUnicode_Decode"],PyUnicode_DecodeASCII:[58,2,1,"c.PyUnicode_DecodeASCII"],PyUnicode_DecodeCharmap:[58,2,1,"c.PyUnicode_DecodeCharmap"],PyUnicode_DecodeFSDefault:[58,2,1,"c.PyUnicode_DecodeFSDefault"],PyUnicode_DecodeFSDefaultAndSize:[58,2,1,"c.PyUnicode_DecodeFSDefaultAndSize"],PyUnicode_DecodeLatin1:[58,2,1,"c.PyUnicode_DecodeLatin1"],PyUnicode_DecodeLocale:[58,2,1,"c.PyUnicode_DecodeLocale"],PyUnicode_DecodeLocaleAndSize:[58,2,1,"c.PyUnicode_DecodeLocaleAndSize"],PyUnicode_DecodeMBCS:[58,2,1,"c.PyUnicode_DecodeMBCS"],PyUnicode_DecodeMBCSStateful:[58,2,1,"c.PyUnicode_DecodeMBCSStateful"],PyUnicode_DecodeRawUnicodeEscape:[58,2,1,"c.PyUnicode_DecodeRawUnicodeEscape"],PyUnicode_DecodeUTF16:[58,2,1,"c.PyUnicode_DecodeUTF16"],PyUnicode_DecodeUTF16Stateful:[58,2,1,"c.PyUnicode_DecodeUTF16Stateful"],PyUnicode_DecodeUTF32:[58,2,1,"c.PyUnicode_DecodeUTF32"],PyUnicode_DecodeUTF32Stateful:[58,2,1,"c.PyUnicode_DecodeUTF32Stateful"],PyUnicode_DecodeUTF7:[58,2,1,"c.PyUnicode_DecodeUTF7"],PyUnicode_DecodeUTF7Stateful:[58,2,1,"c.PyUnicode_DecodeUTF7Stateful"],PyUnicode_DecodeUTF8:[58,2,1,"c.PyUnicode_DecodeUTF8"],PyUnicode_DecodeUTF8Stateful:[58,2,1,"c.PyUnicode_DecodeUTF8Stateful"],PyUnicode_DecodeUnicodeEscape:[58,2,1,"c.PyUnicode_DecodeUnicodeEscape"],PyUnicode_Encode:[58,2,1,"c.PyUnicode_Encode"],PyUnicode_EncodeASCII:[58,2,1,"c.PyUnicode_EncodeASCII"],PyUnicode_EncodeCharmap:[58,2,1,"c.PyUnicode_EncodeCharmap"],PyUnicode_EncodeCodePage:[58,2,1,"c.PyUnicode_EncodeCodePage"],PyUnicode_EncodeFSDefault:[58,2,1,"c.PyUnicode_EncodeFSDefault"],PyUnicode_EncodeLatin1:[58,2,1,"c.PyUnicode_EncodeLatin1"],PyUnicode_EncodeLocale:[58,2,1,"c.PyUnicode_EncodeLocale"],PyUnicode_EncodeMBCS:[58,2,1,"c.PyUnicode_EncodeMBCS"],PyUnicode_EncodeRawUnicodeEscape:[58,2,1,"c.PyUnicode_EncodeRawUnicodeEscape"],PyUnicode_EncodeUTF16:[58,2,1,"c.PyUnicode_EncodeUTF16"],PyUnicode_EncodeUTF32:[58,2,1,"c.PyUnicode_EncodeUTF32"],PyUnicode_EncodeUTF7:[58,2,1,"c.PyUnicode_EncodeUTF7"],PyUnicode_EncodeUTF8:[58,2,1,"c.PyUnicode_EncodeUTF8"],PyUnicode_EncodeUnicodeEscape:[58,2,1,"c.PyUnicode_EncodeUnicodeEscape"],PyUnicode_FSConverter:[58,2,1,"c.PyUnicode_FSConverter"],PyUnicode_FSDecoder:[58,2,1,"c.PyUnicode_FSDecoder"],PyUnicode_Fill:[58,2,1,"c.PyUnicode_Fill"],PyUnicode_Find:[58,2,1,"c.PyUnicode_Find"],PyUnicode_FindChar:[58,2,1,"c.PyUnicode_FindChar"],PyUnicode_Format:[58,2,1,"c.PyUnicode_Format"],PyUnicode_FromEncodedObject:[58,2,1,"c.PyUnicode_FromEncodedObject"],PyUnicode_FromFormat:[58,2,1,"c.PyUnicode_FromFormat"],PyUnicode_FromFormatV:[58,2,1,"c.PyUnicode_FromFormatV"],PyUnicode_FromKindAndData:[58,2,1,"c.PyUnicode_FromKindAndData"],PyUnicode_FromObject:[58,2,1,"c.PyUnicode_FromObject"],PyUnicode_FromString:[58,2,1,"c.PyUnicode_FromString"],PyUnicode_FromStringAndSize:[58,2,1,"c.PyUnicode_FromStringAndSize"],PyUnicode_FromUnicode:[58,2,1,"c.PyUnicode_FromUnicode"],PyUnicode_FromWideChar:[58,2,1,"c.PyUnicode_FromWideChar"],PyUnicode_GET_DATA_SIZE:[58,2,1,"c.PyUnicode_GET_DATA_SIZE"],PyUnicode_GET_LENGTH:[58,2,1,"c.PyUnicode_GET_LENGTH"],PyUnicode_GET_SIZE:[58,2,1,"c.PyUnicode_GET_SIZE"],PyUnicode_GetLength:[58,2,1,"c.PyUnicode_GetLength"],PyUnicode_GetSize:[58,2,1,"c.PyUnicode_GetSize"],PyUnicode_InternFromString:[58,2,1,"c.PyUnicode_InternFromString"],PyUnicode_InternInPlace:[58,2,1,"c.PyUnicode_InternInPlace"],PyUnicode_Join:[58,2,1,"c.PyUnicode_Join"],PyUnicode_KIND:[58,2,1,"c.PyUnicode_KIND"],PyUnicode_MAX_CHAR_VALUE:[58,2,1,"c.PyUnicode_MAX_CHAR_VALUE"],PyUnicode_New:[58,2,1,"c.PyUnicode_New"],PyUnicode_READ:[58,2,1,"c.PyUnicode_READ"],PyUnicode_READY:[58,2,1,"c.PyUnicode_READY"],PyUnicode_READ_CHAR:[58,2,1,"c.PyUnicode_READ_CHAR"],PyUnicode_ReadChar:[58,2,1,"c.PyUnicode_ReadChar"],PyUnicode_Replace:[58,2,1,"c.PyUnicode_Replace"],PyUnicode_RichCompare:[58,2,1,"c.PyUnicode_RichCompare"],PyUnicode_Split:[58,2,1,"c.PyUnicode_Split"],PyUnicode_Splitlines:[58,2,1,"c.PyUnicode_Splitlines"],PyUnicode_Substring:[58,2,1,"c.PyUnicode_Substring"],PyUnicode_Tailmatch:[58,2,1,"c.PyUnicode_Tailmatch"],PyUnicode_TransformDecimalToASCII:[58,2,1,"c.PyUnicode_TransformDecimalToASCII"],PyUnicode_Translate:[58,2,1,"c.PyUnicode_Translate"],PyUnicode_TranslateCharmap:[58,2,1,"c.PyUnicode_TranslateCharmap"],PyUnicode_Type:[58,0,1,"c.PyUnicode_Type"],PyUnicode_WCHAR_KIND:[58,4,1,"c.PyUnicode_WCHAR_KIND"],PyUnicode_WRITE:[58,2,1,"c.PyUnicode_WRITE"],PyUnicode_WriteChar:[58,2,1,"c.PyUnicode_WriteChar"],PyVarObject:[53,1,1,"c.PyVarObject"],PyVarObject_HEAD_INIT:[53,4,1,"c.PyVarObject_HEAD_INIT"],PyWeakref_Check:[61,2,1,"c.PyWeakref_Check"],PyWeakref_CheckProxy:[61,2,1,"c.PyWeakref_CheckProxy"],PyWeakref_CheckRef:[61,2,1,"c.PyWeakref_CheckRef"],PyWeakref_GET_OBJECT:[61,2,1,"c.PyWeakref_GET_OBJECT"],PyWeakref_GetObject:[61,2,1,"c.PyWeakref_GetObject"],PyWeakref_NewProxy:[61,2,1,"c.PyWeakref_NewProxy"],PyWeakref_NewRef:[61,2,1,"c.PyWeakref_NewRef"],PyWrapper_New:[20,2,1,"c.PyWrapper_New"],Py_ABS:[31,4,1,"c.Py_ABS"],Py_AddPendingCall:[30,2,1,"c.Py_AddPendingCall"],Py_AtExit:[54,2,1,"c.Py_AtExit"],Py_BEGIN_ALLOW_THREADS:[30,4,1,"c.Py_BEGIN_ALLOW_THREADS"],Py_BLOCK_THREADS:[30,4,1,"c.Py_BLOCK_THREADS"],Py_BuildValue:[5,2,1,"c.Py_BuildValue"],Py_BytesWarningFlag:[30,0,1,"c.Py_BytesWarningFlag"],Py_CHARMASK:[31,4,1,"c.Py_CHARMASK"],Py_CLEAR:[47,2,1,"c.Py_CLEAR"],Py_CompileString:[60,2,1,"c.Py_CompileString"],Py_CompileStringExFlags:[60,2,1,"c.Py_CompileStringExFlags"],Py_CompileStringFlags:[60,2,1,"c.Py_CompileStringFlags"],Py_CompileStringObject:[60,2,1,"c.Py_CompileStringObject"],Py_DECREF:[47,2,1,"c.Py_DECREF"],Py_DebugFlag:[30,0,1,"c.Py_DebugFlag"],Py_DecodeLocale:[54,2,1,"c.Py_DecodeLocale"],Py_DontWriteBytecodeFlag:[30,0,1,"c.Py_DontWriteBytecodeFlag"],Py_END_ALLOW_THREADS:[30,4,1,"c.Py_END_ALLOW_THREADS"],Py_Ellipsis:[51,0,1,"c.Py_Ellipsis"],Py_EncodeLocale:[54,2,1,"c.Py_EncodeLocale"],Py_EndInterpreter:[30,2,1,"c.Py_EndInterpreter"],Py_EnterRecursiveCall:[22,2,1,"c.Py_EnterRecursiveCall"],Py_Exit:[54,2,1,"c.Py_Exit"],Py_False:[6,0,1,"c.Py_False"],Py_FatalError:[54,2,1,"c.Py_FatalError"],Py_FdIsInteractive:[54,2,1,"c.Py_FdIsInteractive"],Py_Finalize:[30,2,1,"c.Py_Finalize"],Py_FinalizeEx:[30,2,1,"c.Py_FinalizeEx"],Py_FrozenFlag:[30,0,1,"c.Py_FrozenFlag"],Py_GETENV:[31,4,1,"c.Py_GETENV"],Py_GetBuildInfo:[30,2,1,"c.Py_GetBuildInfo"],Py_GetCompiler:[30,2,1,"c.Py_GetCompiler"],Py_GetCopyright:[30,2,1,"c.Py_GetCopyright"],Py_GetExecPrefix:[30,2,1,"c.Py_GetExecPrefix"],Py_GetPath:[30,2,1,"c.Py_GetPath"],Py_GetPlatform:[30,2,1,"c.Py_GetPlatform"],Py_GetPrefix:[30,2,1,"c.Py_GetPrefix"],Py_GetProgramFullPath:[30,2,1,"c.Py_GetProgramFullPath"],Py_GetProgramName:[30,2,1,"c.Py_GetProgramName"],Py_GetPythonHome:[30,2,1,"c.Py_GetPythonHome"],Py_GetVersion:[30,2,1,"c.Py_GetVersion"],Py_HashRandomizationFlag:[30,0,1,"c.Py_HashRandomizationFlag"],Py_INCREF:[47,2,1,"c.Py_INCREF"],Py_IgnoreEnvironmentFlag:[30,0,1,"c.Py_IgnoreEnvironmentFlag"],Py_Initialize:[30,2,1,"c.Py_Initialize"],Py_InitializeEx:[30,2,1,"c.Py_InitializeEx"],Py_InspectFlag:[30,0,1,"c.Py_InspectFlag"],Py_InteractiveFlag:[30,0,1,"c.Py_InteractiveFlag"],Py_IsInitialized:[30,2,1,"c.Py_IsInitialized"],Py_IsolatedFlag:[30,0,1,"c.Py_IsolatedFlag"],Py_LeaveRecursiveCall:[22,2,1,"c.Py_LeaveRecursiveCall"],Py_LegacyWindowsFSEncodingFlag:[30,0,1,"c.Py_LegacyWindowsFSEncodingFlag"],Py_LegacyWindowsStdioFlag:[30,0,1,"c.Py_LegacyWindowsStdioFlag"],Py_MAX:[31,4,1,"c.Py_MAX"],Py_MEMBER_SIZE:[31,4,1,"c.Py_MEMBER_SIZE"],Py_MIN:[31,4,1,"c.Py_MIN"],Py_Main:[60,2,1,"c.Py_Main"],Py_NewInterpreter:[30,2,1,"c.Py_NewInterpreter"],Py_NoSiteFlag:[30,0,1,"c.Py_NoSiteFlag"],Py_NoUserSiteDirectory:[30,0,1,"c.Py_NoUserSiteDirectory"],Py_None:[42,0,1,"c.Py_None"],Py_NotImplemented:[45,0,1,"c.Py_NotImplemented"],Py_OptimizeFlag:[30,0,1,"c.Py_OptimizeFlag"],Py_QuietFlag:[30,0,1,"c.Py_QuietFlag"],Py_REFCNT:[53,4,1,"c.Py_REFCNT"],Py_RETURN_FALSE:[6,4,1,"c.Py_RETURN_FALSE"],Py_RETURN_NONE:[42,4,1,"c.Py_RETURN_NONE"],Py_RETURN_NOTIMPLEMENTED:[45,4,1,"c.Py_RETURN_NOTIMPLEMENTED"],Py_RETURN_RICHCOMPARE:[57,2,1,"c.Py_RETURN_RICHCOMPARE"],Py_RETURN_TRUE:[6,4,1,"c.Py_RETURN_TRUE"],Py_ReprEnter:[22,2,1,"c.Py_ReprEnter"],Py_ReprLeave:[22,2,1,"c.Py_ReprLeave"],Py_SIZE:[53,4,1,"c.Py_SIZE"],Py_STRINGIFY:[31,4,1,"c.Py_STRINGIFY"],Py_SetPath:[30,2,1,"c.Py_SetPath"],Py_SetProgramName:[30,2,1,"c.Py_SetProgramName"],Py_SetPythonHome:[30,2,1,"c.Py_SetPythonHome"],Py_SetStandardStreamEncoding:[30,2,1,"c.Py_SetStandardStreamEncoding"],Py_TPFLAGS_BASETYPE:[57,8,1,""],Py_TPFLAGS_BASE_EXC_SUBCLASS:[57,8,1,""],Py_TPFLAGS_BYTES_SUBCLASS:[57,8,1,""],Py_TPFLAGS_DEFAULT:[57,8,1,""],Py_TPFLAGS_DICT_SUBCLASS:[57,8,1,""],Py_TPFLAGS_HAVE_FINALIZE:[57,8,1,""],Py_TPFLAGS_HAVE_GC:[57,8,1,""],Py_TPFLAGS_HEAPTYPE:[57,8,1,""],Py_TPFLAGS_LIST_SUBCLASS:[57,8,1,""],Py_TPFLAGS_LONG_SUBCLASS:[57,8,1,""],Py_TPFLAGS_READY:[57,8,1,""],Py_TPFLAGS_READYING:[57,8,1,""],Py_TPFLAGS_TUPLE_SUBCLASS:[57,8,1,""],Py_TPFLAGS_TYPE_SUBCLASS:[57,8,1,""],Py_TPFLAGS_UNICODE_SUBCLASS:[57,8,1,""],Py_TYPE:[53,4,1,"c.Py_TYPE"],Py_True:[6,0,1,"c.Py_True"],Py_UCS1:[58,1,1,"c.Py_UCS1"],Py_UCS2:[58,1,1,"c.Py_UCS2"],Py_UCS4:[58,1,1,"c.Py_UCS4"],Py_UNBLOCK_THREADS:[30,4,1,"c.Py_UNBLOCK_THREADS"],Py_UNICODE:[58,1,1,"c.Py_UNICODE"],Py_UNICODE_ISALNUM:[58,2,1,"c.Py_UNICODE_ISALNUM"],Py_UNICODE_ISALPHA:[58,2,1,"c.Py_UNICODE_ISALPHA"],Py_UNICODE_ISDECIMAL:[58,2,1,"c.Py_UNICODE_ISDECIMAL"],Py_UNICODE_ISDIGIT:[58,2,1,"c.Py_UNICODE_ISDIGIT"],Py_UNICODE_ISLINEBREAK:[58,2,1,"c.Py_UNICODE_ISLINEBREAK"],Py_UNICODE_ISLOWER:[58,2,1,"c.Py_UNICODE_ISLOWER"],Py_UNICODE_ISNUMERIC:[58,2,1,"c.Py_UNICODE_ISNUMERIC"],Py_UNICODE_ISPRINTABLE:[58,2,1,"c.Py_UNICODE_ISPRINTABLE"],Py_UNICODE_ISSPACE:[58,2,1,"c.Py_UNICODE_ISSPACE"],Py_UNICODE_ISTITLE:[58,2,1,"c.Py_UNICODE_ISTITLE"],Py_UNICODE_ISUPPER:[58,2,1,"c.Py_UNICODE_ISUPPER"],Py_UNICODE_IS_HIGH_SURROGATE:[58,4,1,"c.Py_UNICODE_IS_HIGH_SURROGATE"],Py_UNICODE_IS_LOW_SURROGATE:[58,4,1,"c.Py_UNICODE_IS_LOW_SURROGATE"],Py_UNICODE_IS_SURROGATE:[58,4,1,"c.Py_UNICODE_IS_SURROGATE"],Py_UNICODE_JOIN_SURROGATES:[58,4,1,"c.Py_UNICODE_JOIN_SURROGATES"],Py_UNICODE_TODECIMAL:[58,2,1,"c.Py_UNICODE_TODECIMAL"],Py_UNICODE_TODIGIT:[58,2,1,"c.Py_UNICODE_TODIGIT"],Py_UNICODE_TOLOWER:[58,2,1,"c.Py_UNICODE_TOLOWER"],Py_UNICODE_TONUMERIC:[58,2,1,"c.Py_UNICODE_TONUMERIC"],Py_UNICODE_TOTITLE:[58,2,1,"c.Py_UNICODE_TOTITLE"],Py_UNICODE_TOUPPER:[58,2,1,"c.Py_UNICODE_TOUPPER"],Py_UNREACHABLE:[31,4,1,"c.Py_UNREACHABLE"],Py_UNUSED:[31,4,1,"c.Py_UNUSED"],Py_UnbufferedStdioFlag:[30,0,1,"c.Py_UnbufferedStdioFlag"],Py_VISIT:[26,2,1,"c.Py_VISIT"],Py_VaBuildValue:[5,2,1,"c.Py_VaBuildValue"],Py_VerboseFlag:[30,0,1,"c.Py_VerboseFlag"],Py_XDECREF:[47,2,1,"c.Py_XDECREF"],Py_XINCREF:[47,2,1,"c.Py_XINCREF"],Py_buffer:[7,1,1,"c.Py_buffer"],Py_complex:[14,1,1,"c.Py_complex"],Py_eval_input:[60,0,1,"c.Py_eval_input"],Py_file_input:[60,0,1,"c.Py_file_input"],Py_mod_create:[41,0,1,"c.Py_mod_create"],Py_mod_exec:[41,0,1,"c.Py_mod_exec"],Py_single_input:[60,0,1,"c.Py_single_input"],Py_tracefunc:[30,1,1,"c.Py_tracefunc"],Py_tss_NEEDS_INIT:[30,4,1,"c.Py_tss_NEEDS_INIT"],Py_tss_t:[30,1,1,"c.Py_tss_t"],RAISE_VARARGS:[190,16,1,"-"],RETURN_VALUE:[190,16,1,"-"],ROT_THREE:[190,16,1,"-"],ROT_TWO:[190,16,1,"-"],RecursionError:[214,5,1,""],ReferenceError:[214,5,1,""],ResourceWarning:[214,5,1,""],RuntimeError:[214,5,1,""],RuntimeWarning:[214,5,1,""],SETUP_ANNOTATIONS:[190,16,1,"-"],SETUP_ASYNC_WITH:[190,16,1,"-"],SETUP_EXCEPT:[190,16,1,"-"],SETUP_FINALLY:[190,16,1,"-"],SETUP_LOOP:[190,16,1,"-"],SETUP_WITH:[190,16,1,"-"],SET_ADD:[190,16,1,"-"],STORE_ATTR:[190,16,1,"-"],STORE_DEREF:[190,16,1,"-"],STORE_FAST:[190,16,1,"-"],STORE_GLOBAL:[190,16,1,"-"],STORE_NAME:[190,16,1,"-"],STORE_SUBSCR:[190,16,1,"-"],StopAsyncIteration:[214,5,1,""],StopIteration:[214,5,1,""],SyntaxError:[214,5,1,""],SyntaxWarning:[214,5,1,""],SystemError:[214,5,1,""],SystemExit:[214,5,1,""],TabError:[214,5,1,""],TimeoutError:[214,5,1,""],True:[169,8,1,""],TypeError:[214,5,1,""],UNARY_INVERT:[190,16,1,"-"],UNARY_NEGATIVE:[190,16,1,"-"],UNARY_NOT:[190,16,1,"-"],UNARY_POSITIVE:[190,16,1,"-"],UNPACK_EX:[190,16,1,"-"],UNPACK_SEQUENCE:[190,16,1,"-"],UnboundLocalError:[214,5,1,""],UnicodeDecodeError:[214,5,1,""],UnicodeEncodeError:[214,5,1,""],UnicodeError:[214,5,1,""],UnicodeTranslateError:[214,5,1,""],UnicodeWarning:[214,5,1,""],UserWarning:[214,5,1,""],ValueError:[214,5,1,""],WITH_CLEANUP_FINISH:[190,16,1,"-"],WITH_CLEANUP_START:[190,16,1,"-"],Warning:[214,5,1,""],WindowsError:[214,5,1,""],YIELD_FROM:[190,16,1,"-"],YIELD_VALUE:[190,16,1,"-"],ZeroDivisionError:[214,5,1,""],_PyBytes_Resize:[9,2,1,"c._PyBytes_Resize"],_PyCFunctionFast:[53,1,1,"c._PyCFunctionFast"],_PyCFunctionFastWithKeywords:[53,1,1,"c._PyCFunctionFastWithKeywords"],_PyImport_Fini:[28,2,1,"c._PyImport_Fini"],_PyImport_Init:[28,2,1,"c._PyImport_Init"],_PyObject_GC_TRACK:[26,2,1,"c._PyObject_GC_TRACK"],_PyObject_GC_UNTRACK:[26,2,1,"c._PyObject_GC_UNTRACK"],_PyObject_New:[3,2,1,"c._PyObject_New"],_PyObject_NewVar:[3,2,1,"c._PyObject_NewVar"],_PyTuple_Resize:[55,2,1,"c._PyTuple_Resize"],_Py_NoneStruct:[3,0,1,"c._Py_NoneStruct"],_Py_c_diff:[14,2,1,"c._Py_c_diff"],_Py_c_neg:[14,2,1,"c._Py_c_neg"],_Py_c_pow:[14,2,1,"c._Py_c_pow"],_Py_c_prod:[14,2,1,"c._Py_c_prod"],_Py_c_quot:[14,2,1,"c._Py_c_quot"],_Py_c_sum:[14,2,1,"c._Py_c_sum"],__cached__:[428,6,1,""],__debug__:[169,8,1,""],__file__:[428,6,1,""],__future__:[114,9,0,"-"],__import__:[227,10,1,""],__loader__:[428,6,1,""],__main__:[115,9,0,"-"],__name__:[428,6,1,""],__package__:[428,6,1,""],__path__:[428,6,1,""],__spec__:[428,6,1,""],_dummy_thread:[116,9,0,"-"],_frozen:[28,1,1,"c._frozen"],_inittab:[28,1,1,"c._inittab"],_thread:[117,9,0,"-"],abc:[118,9,0,"-"],abs:[227,10,1,""],aifc:[119,9,0,"-"],alias:[299,14,1,"-"],all:[227,10,1,""],any:[227,10,1,""],apply:[113,18,1,"-"],argparse:[122,9,0,"-"],args:[299,14,1,"-"],array:[123,9,0,"-"],ascii:[227,10,1,""],asserts:[113,18,1,"-"],ast:[124,9,0,"-"],asynchat:[125,9,0,"-"],asyncio:[126,9,0,"-"],asyncore:[141,9,0,"-"],atexit:[142,9,0,"-"],audioop:[143,9,0,"-"],base64:[144,9,0,"-"],basestring:[113,18,1,"-"],bdb:[145,9,0,"-"],bin:[227,10,1,""],binascii:[147,9,0,"-"],binhex:[148,9,0,"-"],bisect:[149,9,0,"-"],bool:[227,11,1,""],breakpoint:[227,10,1,""],buffer:[113,18,1,"-"],builtins:[150,9,0,"-"],bytearray:[346,11,1,""],bytes:[346,11,1,""],bz2:[151,9,0,"-"],cProfile:[310,9,0,"-"],calendar:[152,9,0,"-"],callable:[227,10,1,""],cgi:[153,9,0,"-"],cgitb:[154,9,0,"-"],chr:[227,10,1,""],chunk:[155,9,0,"-"],classmethod:[227,10,1,""],clear:[299,14,1,"-"],cmath:[156,9,0,"-"],cmd:[157,9,0,"-"],code:[158,9,0,"-"],codecs:[159,9,0,"-"],codeop:[160,9,0,"-"],collections:[161,9,0,"-"],colorsys:[163,9,0,"-"],commands:[299,14,1,"-"],compile:[227,10,1,""],compileall:[164,9,0,"-"],complex:[227,11,1,""],condition:[299,14,1,"-"],configparser:[168,9,0,"-"],contextlib:[170,9,0,"-"],contextvars:[171,9,0,"-"],copy:[172,9,0,"-"],copyreg:[173,9,0,"-"],copyright:[169,8,1,""],create_module:[41,2,1,"c.create_module"],create_shortcut:[66,10,1,""],credits:[169,8,1,""],crypt:[174,9,0,"-"],csv:[176,9,0,"-"],ctypes:[177,9,0,"-"],curses:[178,9,0,"-"],dataclasses:[182,9,0,"-"],datetime:[184,9,0,"-"],dbm:[185,9,0,"-"],decimal:[187,9,0,"-"],delattr:[227,10,1,""],dict:[113,18,1,"-"],difflib:[189,9,0,"-"],dir:[227,10,1,""],directory_created:[66,10,1,""],dis:[190,9,0,"-"],disable:[299,14,1,"-"],display:[299,14,1,"-"],distutils:[192,9,0,"-"],divmod:[227,10,1,""],doctest:[193,9,0,"-"],down:[299,14,1,"-"],dummy_threading:[194,9,0,"-"],email:[195,9,0,"-"],enable:[299,14,1,"-"],ensurepip:[211,9,0,"-"],enumerate:[227,10,1,""],errno:[213,9,0,"-"],eval:[227,10,1,""],except:[113,18,1,"-"],exec:[113,18,1,"-"],exec_module:[41,2,1,"c.exec_module"],execfile:[113,18,1,"-"],exit:[169,8,1,""],exitfunc:[113,18,1,"-"],faulthandler:[215,9,0,"-"],fcntl:[216,9,0,"-"],file_created:[66,10,1,""],filecmp:[217,9,0,"-"],fileinput:[219,9,0,"-"],filter:[113,18,1,"-"],fnmatch:[221,9,0,"-"],format:[227,10,1,""],formatter:[222,9,0,"-"],fractions:[223,9,0,"-"],frozenset:[346,11,1,""],ftplib:[225,9,0,"-"],funcattrs:[113,18,1,"-"],function__entry:[101,2,1,"c.function__entry"],function__return:[101,2,1,"c.function__return"],functools:[228,9,0,"-"],future:[113,18,1,"-"],gc:[229,9,0,"-"],gc__done:[101,2,1,"c.gc__done"],gc__start:[101,2,1,"c.gc__start"],get_special_folder_path:[66,10,1,""],getattr:[227,10,1,""],getcwdu:[113,18,1,"-"],getopt:[230,9,0,"-"],getpass:[231,9,0,"-"],gettext:[232,9,0,"-"],glob:[233,9,0,"-"],globals:[227,10,1,""],grp:[234,9,0,"-"],gzip:[235,9,0,"-"],has_key:[113,18,1,"-"],hasattr:[227,10,1,""],hash:[227,10,1,""],hashlib:[236,9,0,"-"],heapq:[237,9,0,"-"],help:[299,14,1,"-"],hex:[227,10,1,""],hmac:[238,9,0,"-"],html:[239,9,0,"-"],http:[242,9,0,"-"],id:[227,10,1,""],idioms:[113,18,1,"-"],ignore:[299,14,1,"-"],imaplib:[249,9,0,"-"],imghdr:[250,9,0,"-"],imp:[251,9,0,"-"],import__find__load__done:[101,2,1,"c.import__find__load__done"],import__find__load__start:[101,2,1,"c.import__find__load__start"],importlib:[252,9,0,"-"],imports2:[113,18,1,"-"],imports:[113,18,1,"-"],input:[113,18,1,"-"],inquiry:[26,1,1,"c.inquiry"],inspect:[254,9,0,"-"],interact:[299,14,1,"-"],intern:[113,18,1,"-"],io:[257,9,0,"-"],ipaddress:[258,9,0,"-"],isinstance:[113,18,1,"-"],issubclass:[227,10,1,""],iter:[227,10,1,""],itertools:[113,18,1,"-"],itertools_imports:[113,18,1,"-"],json:[261,9,0,"-"],jump:[299,14,1,"-"],keyword:[262,9,0,"-"],len:[227,10,1,""],lib2to3:[113,9,0,"-"],license:[169,8,1,""],line:[101,2,1,"c.line"],linecache:[264,9,0,"-"],list:[299,14,1,"-"],ll:[299,14,1,"-"],locale:[265,9,0,"-"],locals:[227,10,1,""],logging:[266,9,0,"-"],lzma:[269,9,0,"-"],macpath:[270,9,0,"-"],mailbox:[271,9,0,"-"],mailcap:[272,9,0,"-"],map:[113,18,1,"-"],marshal:[274,9,0,"-"],math:[275,9,0,"-"],max:[227,10,1,""],memoryview:[346,11,1,""],metaclass:[113,18,1,"-"],methodattrs:[113,18,1,"-"],mimetypes:[276,9,0,"-"],min:[227,10,1,""],mmap:[279,9,0,"-"],modulefinder:[280,9,0,"-"],msilib:[282,9,0,"-"],msvcrt:[283,9,0,"-"],multiprocessing:[284,9,0,"-"],ne:[113,18,1,"-"],netrc:[286,9,0,"-"],next:[299,14,1,"-"],nis:[287,9,0,"-"],nntplib:[288,9,0,"-"],nonzero:[113,18,1,"-"],numbers:[289,9,0,"-"],numliterals:[113,18,1,"-"],object:[227,11,1,""],oct:[227,10,1,""],open:[227,10,1,""],operator:[113,18,1,"-"],optparse:[292,9,0,"-"],ord:[227,10,1,""],os:[293,9,0,"-"],ossaudiodev:[295,9,0,"-"],p:[299,14,1,"-"],paren:[113,18,1,"-"],parser:[297,9,0,"-"],pathlib:[298,9,0,"-"],pdb:[299,9,0,"-"],pickle:[301,9,0,"-"],pickletools:[302,9,0,"-"],pipes:[303,9,0,"-"],pkgutil:[304,9,0,"-"],platform:[305,9,0,"-"],plistlib:[306,9,0,"-"],poplib:[307,9,0,"-"],posix:[308,9,0,"-"],pow:[227,10,1,""],pp:[299,14,1,"-"],pprint:[309,9,0,"-"],print:[113,18,1,"-"],profile:[310,9,0,"-"],property:[227,11,1,""],pstats:[310,9,0,"-"],pty:[311,9,0,"-"],pwd:[312,9,0,"-"],py_compile:[313,9,0,"-"],pyclbr:[314,9,0,"-"],pydoc:[315,9,0,"-"],queue:[318,9,0,"-"],quit:[299,14,1,"-"],quopri:[319,9,0,"-"],raise:[113,18,1,"-"],random:[320,9,0,"-"],range:[346,11,1,""],raw_input:[113,18,1,"-"],re:[321,9,0,"-"],readline:[322,9,0,"-"],reduce:[113,18,1,"-"],reload:[113,18,1,"-"],renames:[113,18,1,"-"],repr:[113,18,1,"-"],reprlib:[323,9,0,"-"],resource:[324,9,0,"-"],restart:[299,14,1,"-"],reversed:[227,10,1,""],rlcompleter:[325,9,0,"-"],round:[227,10,1,""],run:[299,14,1,"-"],runpy:[326,9,0,"-"],sched:[327,9,0,"-"],secrets:[328,9,0,"-"],select:[329,9,0,"-"],selectors:[330,9,0,"-"],set:[346,11,1,""],set_literal:[113,18,1,"-"],setattr:[227,10,1,""],shelve:[331,9,0,"-"],shlex:[332,9,0,"-"],shutil:[333,9,0,"-"],signal:[334,9,0,"-"],site:[335,9,0,"-"],slice:[227,11,1,""],smtpd:[336,9,0,"-"],smtplib:[337,9,0,"-"],sndhdr:[338,9,0,"-"],socket:[339,9,0,"-"],socketserver:[340,9,0,"-"],sorted:[227,10,1,""],source:[299,14,1,"-"],spwd:[341,9,0,"-"],sqlite3:[342,9,0,"-"],ssl:[343,9,0,"-"],standarderror:[113,18,1,"-"],stat:[344,9,0,"-"],staticmethod:[227,10,1,""],statistics:[345,9,0,"-"],step:[299,14,1,"-"],str:[346,11,1,""],string:[347,9,0,"-"],stringprep:[348,9,0,"-"],struct:[349,9,0,"-"],subprocess:[350,9,0,"-"],sum:[227,10,1,""],sunau:[351,9,0,"-"],symbol:[353,9,0,"-"],symtable:[354,9,0,"-"],sys:[355,9,0,"-"],sys_exc:[113,18,1,"-"],sysconfig:[356,9,0,"-"],syslog:[357,9,0,"-"],tabnanny:[358,9,0,"-"],tarfile:[359,9,0,"-"],tbreak:[299,14,1,"-"],telnetlib:[360,9,0,"-"],tempfile:[361,9,0,"-"],termios:[362,9,0,"-"],test:[363,9,0,"-"],textwrap:[365,9,0,"-"],threading:[366,9,0,"-"],time:[367,9,0,"-"],timeit:[368,9,0,"-"],tkinter:[370,9,0,"-"],token:[374,9,0,"-"],tokenize:[375,9,0,"-"],tp_as_async:[57,3,1,"c.tp_as_async"],tp_as_mapping:[57,3,1,"c.tp_as_mapping"],tp_as_number:[57,3,1,"c.tp_as_number"],tp_as_sequence:[57,3,1,"c.tp_as_sequence"],trace:[376,9,0,"-"],traceback:[377,9,0,"-"],tracemalloc:[378,9,0,"-"],traverseproc:[26,1,1,"c.traverseproc"],tty:[379,9,0,"-"],tuple:[346,11,1,""],tuple_params:[113,18,1,"-"],turtle:[380,9,0,"-"],turtledemo:[380,9,0,"-"],type:[227,11,1,""],types:[113,18,1,"-"],typing:[382,9,0,"-"],unalias:[299,14,1,"-"],undisplay:[299,14,1,"-"],unicode:[113,18,1,"-"],unicodedata:[384,9,0,"-"],unittest:[385,9,0,"-"],until:[299,14,1,"-"],up:[299,14,1,"-"],urllib:[113,18,1,"-"],uu:[394,9,0,"-"],uuid:[395,9,0,"-"],vars:[227,10,1,""],venv:[396,9,0,"-"],visitproc:[26,1,1,"c.visitproc"],warnings:[397,9,0,"-"],wave:[398,9,0,"-"],weakref:[399,9,0,"-"],webbrowser:[400,9,0,"-"],whatis:[299,14,1,"-"],where:[299,14,1,"-"],winreg:[402,9,0,"-"],winsound:[403,9,0,"-"],ws_comma:[113,18,1,"-"],wsgiref:[404,9,0,"-"],xdrlib:[405,9,0,"-"],xml:[406,9,0,"-"],xrange:[113,18,1,"-"],xreadlines:[113,18,1,"-"],zip:[113,18,1,"-"],zipapp:[418,9,0,"-"],zipfile:[419,9,0,"-"],zipimport:[420,9,0,"-"],zlib:[421,9,0,"-"]},"_thread.lock":{acquire:[117,7,1,""],locked:[117,7,1,""],release:[117,7,1,""]},"abc.ABCMeta":{__subclasshook__:[118,7,1,""],register:[118,7,1,""]},"aifc.aifc":{aifc:[119,7,1,""],aiff:[119,7,1,""],close:[119,7,1,""],getcompname:[119,7,1,""],getcomptype:[119,7,1,""],getframerate:[119,7,1,""],getmark:[119,7,1,""],getmarkers:[119,7,1,""],getnchannels:[119,7,1,""],getnframes:[119,7,1,""],getparams:[119,7,1,""],getsampwidth:[119,7,1,""],readframes:[119,7,1,""],rewind:[119,7,1,""],setcomptype:[119,7,1,""],setframerate:[119,7,1,""],setmark:[119,7,1,""],setnchannels:[119,7,1,""],setnframes:[119,7,1,""],setparams:[119,7,1,""],setpos:[119,7,1,""],setsampwidth:[119,7,1,""],tell:[119,7,1,""],writeframes:[119,7,1,""],writeframesraw:[119,7,1,""]},"argparse.ArgumentParser":{add_argument:[122,7,1,""],add_argument_group:[122,7,1,""],add_mutually_exclusive_group:[122,7,1,""],add_subparsers:[122,7,1,""],convert_arg_line_to_args:[122,7,1,""],error:[122,7,1,""],exit:[122,7,1,""],format_help:[122,7,1,""],format_usage:[122,7,1,""],get_default:[122,7,1,""],parse_args:[122,7,1,""],parse_intermixed_args:[122,7,1,""],parse_known_args:[122,7,1,""],parse_known_intermixed_args:[122,7,1,""],print_help:[122,7,1,""],print_usage:[122,7,1,""],set_defaults:[122,7,1,""]},"array.array":{append:[123,7,1,""],buffer_info:[123,7,1,""],byteswap:[123,7,1,""],count:[123,7,1,""],extend:[123,7,1,""],frombytes:[123,7,1,""],fromfile:[123,7,1,""],fromlist:[123,7,1,""],fromstring:[123,7,1,""],fromunicode:[123,7,1,""],index:[123,7,1,""],insert:[123,7,1,""],itemsize:[123,6,1,""],pop:[123,7,1,""],remove:[123,7,1,""],reverse:[123,7,1,""],tobytes:[123,7,1,""],tofile:[123,7,1,""],tolist:[123,7,1,""],tostring:[123,7,1,""],tounicode:[123,7,1,""],typecode:[123,6,1,""]},"ast.AST":{_fields:[124,6,1,""],col_offset:[124,6,1,""],lineno:[124,6,1,""]},"ast.NodeVisitor":{generic_visit:[124,7,1,""],visit:[124,7,1,""]},"asynchat.async_chat":{ac_in_buffer_size:[125,8,1,""],ac_out_buffer_size:[125,8,1,""],close_when_done:[125,7,1,""],collect_incoming_data:[125,7,1,""],discard_buffers:[125,7,1,""],found_terminator:[125,7,1,""],get_terminator:[125,7,1,""],push:[125,7,1,""],push_with_producer:[125,7,1,""],set_terminator:[125,7,1,""]},"asyncio.AbstractChildWatcher":{add_child_handler:[134,7,1,""],attach_loop:[134,7,1,""],close:[134,7,1,""],remove_child_handler:[134,7,1,""]},"asyncio.AbstractEventLoopPolicy":{get_child_watcher:[134,7,1,""],get_event_loop:[134,7,1,""],new_event_loop:[134,7,1,""],set_child_watcher:[134,7,1,""],set_event_loop:[134,7,1,""]},"asyncio.BaseProtocol":{connection_lost:[135,7,1,""],connection_made:[135,7,1,""],pause_writing:[135,7,1,""],resume_writing:[135,7,1,""]},"asyncio.BaseTransport":{close:[135,7,1,""],get_extra_info:[135,7,1,""],get_protocol:[135,7,1,""],is_closing:[135,7,1,""],set_protocol:[135,7,1,""]},"asyncio.BufferedProtocol":{buffer_updated:[135,7,1,""],eof_received:[135,7,1,""],get_buffer:[135,7,1,""]},"asyncio.Condition":{acquire:[139,7,1,""],locked:[139,7,1,""],notify:[139,7,1,""],notify_all:[139,7,1,""],release:[139,7,1,""],wait:[139,7,1,""],wait_for:[139,7,1,""]},"asyncio.DatagramProtocol":{datagram_received:[135,7,1,""],error_received:[135,7,1,""]},"asyncio.DatagramTransport":{abort:[135,7,1,""],sendto:[135,7,1,""]},"asyncio.Event":{clear:[139,7,1,""],is_set:[139,7,1,""],set:[139,7,1,""],wait:[139,7,1,""]},"asyncio.Future":{add_done_callback:[131,7,1,""],cancel:[131,7,1,""],cancelled:[131,7,1,""],done:[131,7,1,""],exception:[131,7,1,""],get_loop:[131,7,1,""],remove_done_callback:[131,7,1,""],result:[131,7,1,""],set_exception:[131,7,1,""],set_result:[131,7,1,""]},"asyncio.Handle":{cancel:[129,7,1,""],cancelled:[129,7,1,""]},"asyncio.IncompleteReadError":{expected:[130,6,1,""],partial:[130,6,1,""]},"asyncio.LimitOverrunError":{consumed:[130,6,1,""]},"asyncio.Lock":{acquire:[139,7,1,""],locked:[139,7,1,""],release:[139,7,1,""]},"asyncio.Protocol":{data_received:[135,7,1,""],eof_received:[135,7,1,""]},"asyncio.Queue":{empty:[136,7,1,""],full:[136,7,1,""],get:[136,7,1,""],get_nowait:[136,7,1,""],join:[136,7,1,""],maxsize:[136,6,1,""],put:[136,7,1,""],put_nowait:[136,7,1,""],qsize:[136,7,1,""],task_done:[136,7,1,""]},"asyncio.ReadTransport":{is_reading:[135,7,1,""],pause_reading:[135,7,1,""],resume_reading:[135,7,1,""]},"asyncio.Semaphore":{acquire:[139,7,1,""],locked:[139,7,1,""],release:[139,7,1,""]},"asyncio.Server":{close:[129,7,1,""],get_loop:[129,7,1,""],is_serving:[129,7,1,""],serve_forever:[129,7,1,""],sockets:[129,6,1,""],start_serving:[129,7,1,""],wait_closed:[129,7,1,""]},"asyncio.StreamReader":{at_eof:[137,7,1,""],read:[137,7,1,""],readexactly:[137,7,1,""],readline:[137,7,1,""],readuntil:[137,7,1,""]},"asyncio.StreamWriter":{can_write_eof:[137,7,1,""],close:[137,7,1,""],drain:[137,7,1,""],get_extra_info:[137,7,1,""],is_closing:[137,7,1,""],transport:[137,6,1,""],wait_closed:[137,7,1,""],write:[137,7,1,""],write_eof:[137,7,1,""],writelines:[137,7,1,""]},"asyncio.SubprocessProtocol":{pipe_connection_lost:[135,7,1,""],pipe_data_received:[135,7,1,""],process_exited:[135,7,1,""]},"asyncio.SubprocessTransport":{close:[135,7,1,""],get_pid:[135,7,1,""],get_pipe_transport:[135,7,1,""],get_returncode:[135,7,1,""],kill:[135,7,1,""],send_signal:[135,7,1,""],terminate:[135,7,1,""]},"asyncio.Task":{add_done_callback:[140,7,1,""],all_tasks:[140,12,1,""],cancel:[140,7,1,""],cancelled:[140,7,1,""],current_task:[140,12,1,""],done:[140,7,1,""],exception:[140,7,1,""],get_stack:[140,7,1,""],print_stack:[140,7,1,""],remove_done_callback:[140,7,1,""],result:[140,7,1,""]},"asyncio.TimerHandle":{when:[129,7,1,""]},"asyncio.WriteTransport":{abort:[135,7,1,""],can_write_eof:[135,7,1,""],get_write_buffer_limits:[135,7,1,""],get_write_buffer_size:[135,7,1,""],set_write_buffer_limits:[135,7,1,""],write:[135,7,1,""],write_eof:[135,7,1,""],writelines:[135,7,1,""]},"asyncio.asyncio.subprocess":{DEVNULL:[138,8,1,""],PIPE:[138,8,1,""],Process:[138,11,1,""],STDOUT:[138,8,1,""]},"asyncio.asyncio.subprocess.Process":{communicate:[138,7,1,""],kill:[138,7,1,""],pid:[138,6,1,""],returncode:[138,6,1,""],send_signal:[138,7,1,""],stderr:[138,6,1,""],stdin:[138,6,1,""],stdout:[138,6,1,""],terminate:[138,7,1,""],wait:[138,7,1,""]},"asyncio.loop":{add_reader:[129,7,1,""],add_signal_handler:[129,7,1,""],add_writer:[129,7,1,""],call_at:[129,7,1,""],call_exception_handler:[129,7,1,""],call_later:[129,7,1,""],call_soon:[129,7,1,""],call_soon_threadsafe:[129,7,1,""],close:[129,7,1,""],connect_accepted_socket:[129,7,1,""],connect_read_pipe:[129,7,1,""],connect_write_pipe:[129,7,1,""],create_connection:[129,7,1,""],create_datagram_endpoint:[129,7,1,""],create_future:[129,7,1,""],create_server:[129,7,1,""],create_task:[129,7,1,""],create_unix_connection:[129,7,1,""],create_unix_server:[129,7,1,""],default_exception_handler:[129,7,1,""],get_debug:[129,7,1,""],get_exception_handler:[129,7,1,""],get_task_factory:[129,7,1,""],getaddrinfo:[129,7,1,""],getnameinfo:[129,7,1,""],is_closed:[129,7,1,""],is_running:[129,7,1,""],remove_reader:[129,7,1,""],remove_signal_handler:[129,7,1,""],remove_writer:[129,7,1,""],run_forever:[129,7,1,""],run_in_executor:[129,7,1,""],run_until_complete:[129,7,1,""],sendfile:[129,7,1,""],set_debug:[129,7,1,""],set_default_executor:[129,7,1,""],set_exception_handler:[129,7,1,""],set_task_factory:[129,7,1,""],shutdown_asyncgens:[129,7,1,""],sock_accept:[129,7,1,""],sock_connect:[129,7,1,""],sock_recv:[129,7,1,""],sock_recv_into:[129,7,1,""],sock_sendall:[129,7,1,""],sock_sendfile:[129,7,1,""],start_tls:[129,7,1,""],stop:[129,7,1,""],subprocess_exec:[129,7,1,""],subprocess_shell:[129,7,1,""],time:[129,7,1,""]},"asyncore.dispatcher":{accept:[141,7,1,""],bind:[141,7,1,""],close:[141,7,1,""],connect:[141,7,1,""],create_socket:[141,7,1,""],handle_accept:[141,7,1,""],handle_accepted:[141,7,1,""],handle_close:[141,7,1,""],handle_connect:[141,7,1,""],handle_error:[141,7,1,""],handle_expt:[141,7,1,""],handle_read:[141,7,1,""],handle_write:[141,7,1,""],listen:[141,7,1,""],readable:[141,7,1,""],recv:[141,7,1,""],send:[141,7,1,""],writable:[141,7,1,""]},"bdb.Bdb":{break_anywhere:[145,7,1,""],break_here:[145,7,1,""],canonic:[145,7,1,""],clear_all_breaks:[145,7,1,""],clear_all_file_breaks:[145,7,1,""],clear_bpbynumber:[145,7,1,""],clear_break:[145,7,1,""],dispatch_call:[145,7,1,""],dispatch_exception:[145,7,1,""],dispatch_line:[145,7,1,""],dispatch_return:[145,7,1,""],do_clear:[145,7,1,""],format_stack_entry:[145,7,1,""],get_all_breaks:[145,7,1,""],get_bpbynumber:[145,7,1,""],get_break:[145,7,1,""],get_breaks:[145,7,1,""],get_file_breaks:[145,7,1,""],get_stack:[145,7,1,""],reset:[145,7,1,""],run:[145,7,1,""],runcall:[145,7,1,""],runctx:[145,7,1,""],runeval:[145,7,1,""],set_break:[145,7,1,""],set_continue:[145,7,1,""],set_next:[145,7,1,""],set_quit:[145,7,1,""],set_return:[145,7,1,""],set_step:[145,7,1,""],set_trace:[145,7,1,""],set_until:[145,7,1,""],stop_here:[145,7,1,""],trace_dispatch:[145,7,1,""],user_call:[145,7,1,""],user_exception:[145,7,1,""],user_line:[145,7,1,""],user_return:[145,7,1,""]},"bdb.Breakpoint":{bpformat:[145,7,1,""],bpprint:[145,7,1,""],deleteMe:[145,7,1,""],disable:[145,7,1,""],enable:[145,7,1,""]},"bz2.BZ2Compressor":{compress:[151,7,1,""],flush:[151,7,1,""]},"bz2.BZ2Decompressor":{decompress:[151,7,1,""],eof:[151,6,1,""],needs_input:[151,6,1,""],unused_data:[151,6,1,""]},"bz2.BZ2File":{peek:[151,7,1,""]},"calendar.Calendar":{itermonthdates:[152,7,1,""],itermonthdays2:[152,7,1,""],itermonthdays3:[152,7,1,""],itermonthdays4:[152,7,1,""],itermonthdays:[152,7,1,""],iterweekdays:[152,7,1,""],monthdatescalendar:[152,7,1,""],monthdays2calendar:[152,7,1,""],monthdayscalendar:[152,7,1,""],yeardatescalendar:[152,7,1,""],yeardays2calendar:[152,7,1,""],yeardayscalendar:[152,7,1,""]},"calendar.HTMLCalendar":{cssclass_month:[152,6,1,""],cssclass_month_head:[152,6,1,""],cssclass_noday:[152,6,1,""],cssclass_year:[152,6,1,""],cssclass_year_head:[152,6,1,""],cssclasses:[152,6,1,""],cssclasses_weekday_head:[152,6,1,""],formatmonth:[152,7,1,""],formatyear:[152,7,1,""],formatyearpage:[152,7,1,""]},"calendar.TextCalendar":{formatmonth:[152,7,1,""],formatyear:[152,7,1,""],prmonth:[152,7,1,""],pryear:[152,7,1,""]},"cgi.FieldStorage":{getfirst:[153,7,1,""],getlist:[153,7,1,""]},"chunk.Chunk":{close:[155,7,1,""],getname:[155,7,1,""],getsize:[155,7,1,""],isatty:[155,7,1,""],read:[155,7,1,""],seek:[155,7,1,""],skip:[155,7,1,""],tell:[155,7,1,""]},"class":{__bases__:[346,6,1,""],__instancecheck__:[424,7,1,""],__mro__:[346,6,1,""],__subclasscheck__:[424,7,1,""],__subclasses__:[346,7,1,""],mro:[346,7,1,""]},"cmd.Cmd":{"default":[157,7,1,""],cmdloop:[157,7,1,""],cmdqueue:[157,6,1,""],completedefault:[157,7,1,""],doc_header:[157,6,1,""],emptyline:[157,7,1,""],identchars:[157,6,1,""],intro:[157,6,1,""],lastcmd:[157,6,1,""],misc_header:[157,6,1,""],onecmd:[157,7,1,""],postcmd:[157,7,1,""],postloop:[157,7,1,""],precmd:[157,7,1,""],preloop:[157,7,1,""],prompt:[157,6,1,""],ruler:[157,6,1,""],undoc_header:[157,6,1,""],use_rawinput:[157,6,1,""]},"code.InteractiveConsole":{interact:[158,7,1,""],push:[158,7,1,""],raw_input:[158,7,1,""],resetbuffer:[158,7,1,""]},"code.InteractiveInterpreter":{runcode:[158,7,1,""],runsource:[158,7,1,""],showsyntaxerror:[158,7,1,""],showtraceback:[158,7,1,""],write:[158,7,1,""]},"codecs.Codec":{decode:[159,7,1,""],encode:[159,7,1,""]},"codecs.CodecInfo":{decode:[159,6,1,""],encode:[159,6,1,""],incrementaldecoder:[159,6,1,""],incrementalencoder:[159,6,1,""],name:[159,6,1,""],streamreader:[159,6,1,""],streamwriter:[159,6,1,""]},"codecs.IncrementalDecoder":{decode:[159,7,1,""],getstate:[159,7,1,""],reset:[159,7,1,""],setstate:[159,7,1,""]},"codecs.IncrementalEncoder":{encode:[159,7,1,""],getstate:[159,7,1,""],reset:[159,7,1,""],setstate:[159,7,1,""]},"codecs.StreamReader":{read:[159,7,1,""],readline:[159,7,1,""],readlines:[159,7,1,""],reset:[159,7,1,""]},"codecs.StreamWriter":{reset:[159,7,1,""],write:[159,7,1,""],writelines:[159,7,1,""]},"collections.ChainMap":{maps:[161,6,1,""],new_child:[161,7,1,""],parents:[161,6,1,""]},"collections.Counter":{elements:[161,7,1,""],fromkeys:[161,7,1,""],most_common:[161,7,1,""],subtract:[161,7,1,""],update:[161,7,1,""]},"collections.OrderedDict":{move_to_end:[161,7,1,""],popitem:[161,7,1,""]},"collections.UserDict":{data:[161,6,1,""]},"collections.UserList":{data:[161,6,1,""]},"collections.UserString":{data:[161,6,1,""]},"collections.abc":{AsyncGenerator:[162,11,1,""],AsyncIterable:[162,11,1,""],AsyncIterator:[162,11,1,""],Awaitable:[162,11,1,""],ByteString:[162,11,1,""],Callable:[162,11,1,""],Collection:[162,11,1,""],Container:[162,11,1,""],Coroutine:[162,11,1,""],Generator:[162,11,1,""],Hashable:[162,11,1,""],ItemsView:[162,11,1,""],Iterable:[162,11,1,""],Iterator:[162,11,1,""],KeysView:[162,11,1,""],Mapping:[162,11,1,""],MappingView:[162,11,1,""],MutableMapping:[162,11,1,""],MutableSequence:[162,11,1,""],MutableSet:[162,11,1,""],Reversible:[162,11,1,""],Sequence:[162,11,1,""],Set:[162,11,1,""],Sized:[162,11,1,""],ValuesView:[162,11,1,""]},"collections.defaultdict":{__missing__:[161,7,1,""],default_factory:[161,6,1,""]},"collections.deque":{append:[161,7,1,""],appendleft:[161,7,1,""],clear:[161,7,1,""],copy:[161,7,1,""],count:[161,7,1,""],extend:[161,7,1,""],extendleft:[161,7,1,""],index:[161,7,1,""],insert:[161,7,1,""],maxlen:[161,6,1,""],pop:[161,7,1,""],popleft:[161,7,1,""],remove:[161,7,1,""],reverse:[161,7,1,""],rotate:[161,7,1,""]},"collections.somenamedtuple":{_asdict:[161,7,1,""],_field_defaults:[161,6,1,""],_fields:[161,6,1,""],_make:[161,12,1,""],_replace:[161,7,1,""]},"concurrent.futures":{BrokenExecutor:[167,5,1,""],CancelledError:[167,5,1,""],Executor:[167,11,1,""],Future:[167,11,1,""],ProcessPoolExecutor:[167,11,1,""],ThreadPoolExecutor:[167,11,1,""],TimeoutError:[167,5,1,""],as_completed:[167,10,1,""],wait:[167,10,1,""]},"concurrent.futures.Executor":{map:[167,7,1,""],shutdown:[167,7,1,""],submit:[167,7,1,""]},"concurrent.futures.Future":{add_done_callback:[167,7,1,""],cancel:[167,7,1,""],cancelled:[167,7,1,""],done:[167,7,1,""],exception:[167,7,1,""],result:[167,7,1,""],running:[167,7,1,""],set_exception:[167,7,1,""],set_result:[167,7,1,""],set_running_or_notify_cancel:[167,7,1,""]},"concurrent.futures.process":{BrokenProcessPool:[167,5,1,""]},"concurrent.futures.thread":{BrokenThreadPool:[167,5,1,""]},"configparser.ConfigParser":{BOOLEAN_STATES:[168,6,1,""],SECTCRE:[168,6,1,""],add_section:[168,7,1,""],defaults:[168,7,1,""],get:[168,7,1,""],getboolean:[168,7,1,""],getfloat:[168,7,1,""],getint:[168,7,1,""],has_option:[168,7,1,""],has_section:[168,7,1,""],items:[168,7,1,""],options:[168,7,1,""],optionxform:[168,7,1,""],read:[168,7,1,""],read_dict:[168,7,1,""],read_file:[168,7,1,""],read_string:[168,7,1,""],readfp:[168,7,1,""],remove_option:[168,7,1,""],remove_section:[168,7,1,""],sections:[168,7,1,""],set:[168,7,1,""],write:[168,7,1,""]},"configparser.RawConfigParser":{add_section:[168,7,1,""],set:[168,7,1,""]},"contextlib.AsyncExitStack":{aclose:[170,7,1,""],enter_async_context:[170,7,1,""],push_async_callback:[170,7,1,""],push_async_exit:[170,7,1,""]},"contextlib.ExitStack":{callback:[170,7,1,""],close:[170,7,1,""],enter_context:[170,7,1,""],pop_all:[170,7,1,""],push:[170,7,1,""]},"contextvars.Context":{copy:[171,7,1,""],get:[171,7,1,""],items:[171,7,1,""],keys:[171,7,1,""],run:[171,7,1,""],values:[171,7,1,""]},"contextvars.ContextVar":{get:[171,7,1,""],name:[171,6,1,""],reset:[171,7,1,""],set:[171,7,1,""]},"contextvars.contextvars":{Token:[171,11,1,""]},"contextvars.contextvars.Token.Token":{"var":[171,6,1,""],MISSING:[171,6,1,""],old_value:[171,6,1,""]},"csv.Dialect":{delimiter:[176,6,1,""],doublequote:[176,6,1,""],escapechar:[176,6,1,""],lineterminator:[176,6,1,""],quotechar:[176,6,1,""],quoting:[176,6,1,""],skipinitialspace:[176,6,1,""],strict:[176,6,1,""]},"csv.DictWriter":{writeheader:[176,7,1,""]},"csv.Sniffer":{has_header:[176,7,1,""],sniff:[176,7,1,""]},"csv.csvreader":{__next__:[176,7,1,""],dialect:[176,6,1,""],fieldnames:[176,6,1,""],line_num:[176,6,1,""]},"csv.csvwriter":{dialect:[176,6,1,""],writerow:[176,7,1,""],writerows:[176,7,1,""]},"ctypes.Array":{_length_:[177,6,1,""],_type_:[177,6,1,""]},"ctypes.LibraryLoader":{LoadLibrary:[177,7,1,""]},"ctypes.PyDLL":{_handle:[177,6,1,""],_name:[177,6,1,""]},"ctypes.Structure":{_anonymous_:[177,6,1,""],_fields_:[177,6,1,""],_pack_:[177,6,1,""]},"ctypes._CData":{_b_base_:[177,6,1,""],_b_needsfree_:[177,6,1,""],_objects:[177,6,1,""],from_address:[177,7,1,""],from_buffer:[177,7,1,""],from_buffer_copy:[177,7,1,""],from_param:[177,7,1,""],in_dll:[177,7,1,""]},"ctypes._FuncPtr":{argtypes:[177,6,1,""],errcheck:[177,6,1,""],restype:[177,6,1,""]},"ctypes._Pointer":{_type_:[177,6,1,""],contents:[177,6,1,""]},"ctypes._SimpleCData":{value:[177,6,1,""]},"ctypes.util":{find_library:[177,10,1,""],find_msvcrt:[177,10,1,""]},"curses.ascii":{alt:[179,10,1,""],ascii:[179,10,1,""],controlnames:[179,8,1,""],ctrl:[179,10,1,""],isalnum:[179,10,1,""],isalpha:[179,10,1,""],isascii:[179,10,1,""],isblank:[179,10,1,""],iscntrl:[179,10,1,""],isctrl:[179,10,1,""],isdigit:[179,10,1,""],isgraph:[179,10,1,""],islower:[179,10,1,""],ismeta:[179,10,1,""],isprint:[179,10,1,""],ispunct:[179,10,1,""],isspace:[179,10,1,""],isupper:[179,10,1,""],isxdigit:[179,10,1,""],unctrl:[179,10,1,""]},"curses.panel":{bottom_panel:[180,10,1,""],new_panel:[180,10,1,""],top_panel:[180,10,1,""],update_panels:[180,10,1,""]},"curses.panel.Panel":{above:[180,7,1,""],below:[180,7,1,""],bottom:[180,7,1,""],hidden:[180,7,1,""],hide:[180,7,1,""],move:[180,7,1,""],replace:[180,7,1,""],set_userptr:[180,7,1,""],show:[180,7,1,""],top:[180,7,1,""],userptr:[180,7,1,""],window:[180,7,1,""]},"curses.textpad":{Textbox:[178,11,1,""],rectangle:[178,10,1,""]},"curses.textpad.Textbox":{do_command:[178,7,1,""],edit:[178,7,1,""],gather:[178,7,1,""],stripspaces:[178,6,1,""]},"curses.window":{addch:[178,7,1,""],addnstr:[178,7,1,""],addstr:[178,7,1,""],attroff:[178,7,1,""],attron:[178,7,1,""],attrset:[178,7,1,""],bkgd:[178,7,1,""],bkgdset:[178,7,1,""],border:[178,7,1,""],box:[178,7,1,""],chgat:[178,7,1,""],clear:[178,7,1,""],clearok:[178,7,1,""],clrtobot:[178,7,1,""],clrtoeol:[178,7,1,""],cursyncup:[178,7,1,""],delch:[178,7,1,""],deleteln:[178,7,1,""],derwin:[178,7,1,""],echochar:[178,7,1,""],enclose:[178,7,1,""],encoding:[178,6,1,""],erase:[178,7,1,""],get_wch:[178,7,1,""],getbegyx:[178,7,1,""],getbkgd:[178,7,1,""],getch:[178,7,1,""],getkey:[178,7,1,""],getmaxyx:[178,7,1,""],getparyx:[178,7,1,""],getstr:[178,7,1,""],getyx:[178,7,1,""],hline:[178,7,1,""],idcok:[178,7,1,""],idlok:[178,7,1,""],immedok:[178,7,1,""],inch:[178,7,1,""],insch:[178,7,1,""],insdelln:[178,7,1,""],insertln:[178,7,1,""],insnstr:[178,7,1,""],insstr:[178,7,1,""],instr:[178,7,1,""],is_linetouched:[178,7,1,""],is_wintouched:[178,7,1,""],keypad:[178,7,1,""],leaveok:[178,7,1,""],move:[178,7,1,""],mvderwin:[178,7,1,""],mvwin:[178,7,1,""],nodelay:[178,7,1,""],notimeout:[178,7,1,""],noutrefresh:[178,7,1,""],overlay:[178,7,1,""],overwrite:[178,7,1,""],putwin:[178,7,1,""],redrawln:[178,7,1,""],redrawwin:[178,7,1,""],refresh:[178,7,1,""],resize:[178,7,1,""],scroll:[178,7,1,""],scrollok:[178,7,1,""],setscrreg:[178,7,1,""],standend:[178,7,1,""],standout:[178,7,1,""],subpad:[178,7,1,""],subwin:[178,7,1,""],syncdown:[178,7,1,""],syncok:[178,7,1,""],syncup:[178,7,1,""],timeout:[178,7,1,""],touchline:[178,7,1,""],touchwin:[178,7,1,""],untouchwin:[178,7,1,""],vline:[178,7,1,""]},"datetime.date":{__format__:[184,7,1,""],__str__:[184,7,1,""],ctime:[184,7,1,""],day:[184,6,1,""],fromisoformat:[184,12,1,""],fromordinal:[184,12,1,""],fromtimestamp:[184,12,1,""],isocalendar:[184,7,1,""],isoformat:[184,7,1,""],isoweekday:[184,7,1,""],max:[184,6,1,""],min:[184,6,1,""],month:[184,6,1,""],replace:[184,7,1,""],resolution:[184,6,1,""],strftime:[184,7,1,""],timetuple:[184,7,1,""],today:[184,12,1,""],toordinal:[184,7,1,""],weekday:[184,7,1,""],year:[184,6,1,""]},"datetime.datetime":{__format__:[184,7,1,""],__str__:[184,7,1,""],astimezone:[184,7,1,""],combine:[184,12,1,""],ctime:[184,7,1,""],date:[184,7,1,""],day:[184,6,1,""],dst:[184,7,1,""],fold:[184,6,1,""],fromisoformat:[184,12,1,""],fromordinal:[184,12,1,""],fromtimestamp:[184,12,1,""],hour:[184,6,1,""],isocalendar:[184,7,1,""],isoformat:[184,7,1,""],isoweekday:[184,7,1,""],max:[184,6,1,""],microsecond:[184,6,1,""],min:[184,6,1,""],minute:[184,6,1,""],month:[184,6,1,""],now:[184,12,1,""],replace:[184,7,1,""],resolution:[184,6,1,""],second:[184,6,1,""],strftime:[184,7,1,""],strptime:[184,12,1,""],time:[184,7,1,""],timestamp:[184,7,1,""],timetuple:[184,7,1,""],timetz:[184,7,1,""],today:[184,12,1,""],toordinal:[184,7,1,""],tzinfo:[184,6,1,""],tzname:[184,7,1,""],utcfromtimestamp:[184,12,1,""],utcnow:[184,12,1,""],utcoffset:[184,7,1,""],utctimetuple:[184,7,1,""],weekday:[184,7,1,""],year:[184,6,1,""]},"datetime.time":{__format__:[184,7,1,""],__str__:[184,7,1,""],dst:[184,7,1,""],fold:[184,6,1,""],fromisoformat:[184,12,1,""],hour:[184,6,1,""],isoformat:[184,7,1,""],max:[184,6,1,""],microsecond:[184,6,1,""],min:[184,6,1,""],minute:[184,6,1,""],replace:[184,7,1,""],resolution:[184,6,1,""],second:[184,6,1,""],strftime:[184,7,1,""],tzinfo:[184,6,1,""],tzname:[184,7,1,""],utcoffset:[184,7,1,""]},"datetime.timedelta":{max:[184,6,1,""],min:[184,6,1,""],resolution:[184,6,1,""],total_seconds:[184,7,1,""]},"datetime.timezone":{dst:[184,7,1,""],fromutc:[184,7,1,""],tzname:[184,7,1,""],utc:[184,6,1,""],utcoffset:[184,7,1,""]},"datetime.tzinfo":{dst:[184,7,1,""],fromutc:[184,7,1,""],tzname:[184,7,1,""],utcoffset:[184,7,1,""]},"dbm.dumb":{error:[185,5,1,""],open:[185,10,1,""]},"dbm.dumb.dumbdbm":{close:[185,7,1,""],sync:[185,7,1,""]},"dbm.gnu":{error:[185,5,1,""],open:[185,10,1,""]},"dbm.gnu.gdbm":{close:[185,7,1,""],firstkey:[185,7,1,""],nextkey:[185,7,1,""],reorganize:[185,7,1,""],sync:[185,7,1,""]},"dbm.ndbm":{error:[185,5,1,""],library:[185,8,1,""],open:[185,10,1,""]},"dbm.ndbm.ndbm":{close:[185,7,1,""]},"decimal.Context":{Etiny:[187,7,1,""],Etop:[187,7,1,""],abs:[187,7,1,""],add:[187,7,1,""],canonical:[187,7,1,""],clear_flags:[187,7,1,""],clear_traps:[187,7,1,""],compare:[187,7,1,""],compare_signal:[187,7,1,""],compare_total:[187,7,1,""],compare_total_mag:[187,7,1,""],copy:[187,7,1,""],copy_abs:[187,7,1,""],copy_decimal:[187,7,1,""],copy_negate:[187,7,1,""],copy_sign:[187,7,1,""],create_decimal:[187,7,1,""],create_decimal_from_float:[187,7,1,""],divide:[187,7,1,""],divide_int:[187,7,1,""],divmod:[187,7,1,""],exp:[187,7,1,""],fma:[187,7,1,""],is_canonical:[187,7,1,""],is_finite:[187,7,1,""],is_infinite:[187,7,1,""],is_nan:[187,7,1,""],is_normal:[187,7,1,""],is_qnan:[187,7,1,""],is_signed:[187,7,1,""],is_snan:[187,7,1,""],is_subnormal:[187,7,1,""],is_zero:[187,7,1,""],ln:[187,7,1,""],log10:[187,7,1,""],logb:[187,7,1,""],logical_and:[187,7,1,""],logical_invert:[187,7,1,""],logical_or:[187,7,1,""],logical_xor:[187,7,1,""],max:[187,7,1,""],max_mag:[187,7,1,""],min:[187,7,1,""],min_mag:[187,7,1,""],minus:[187,7,1,""],multiply:[187,7,1,""],next_minus:[187,7,1,""],next_plus:[187,7,1,""],next_toward:[187,7,1,""],normalize:[187,7,1,""],number_class:[187,7,1,""],plus:[187,7,1,""],power:[187,7,1,""],quantize:[187,7,1,""],radix:[187,7,1,""],remainder:[187,7,1,""],remainder_near:[187,7,1,""],rotate:[187,7,1,""],same_quantum:[187,7,1,""],scaleb:[187,7,1,""],shift:[187,7,1,""],sqrt:[187,7,1,""],subtract:[187,7,1,""],to_eng_string:[187,7,1,""],to_integral_exact:[187,7,1,""],to_sci_string:[187,7,1,""]},"decimal.Decimal":{adjusted:[187,7,1,""],as_integer_ratio:[187,7,1,""],as_tuple:[187,7,1,""],canonical:[187,7,1,""],compare:[187,7,1,""],compare_signal:[187,7,1,""],compare_total:[187,7,1,""],compare_total_mag:[187,7,1,""],conjugate:[187,7,1,""],copy_abs:[187,7,1,""],copy_negate:[187,7,1,""],copy_sign:[187,7,1,""],exp:[187,7,1,""],fma:[187,7,1,""],from_float:[187,7,1,""],is_canonical:[187,7,1,""],is_finite:[187,7,1,""],is_infinite:[187,7,1,""],is_nan:[187,7,1,""],is_normal:[187,7,1,""],is_qnan:[187,7,1,""],is_signed:[187,7,1,""],is_snan:[187,7,1,""],is_subnormal:[187,7,1,""],is_zero:[187,7,1,""],ln:[187,7,1,""],log10:[187,7,1,""],logb:[187,7,1,""],logical_and:[187,7,1,""],logical_invert:[187,7,1,""],logical_or:[187,7,1,""],logical_xor:[187,7,1,""],max:[187,7,1,""],max_mag:[187,7,1,""],min:[187,7,1,""],min_mag:[187,7,1,""],next_minus:[187,7,1,""],next_plus:[187,7,1,""],next_toward:[187,7,1,""],normalize:[187,7,1,""],number_class:[187,7,1,""],quantize:[187,7,1,""],radix:[187,7,1,""],remainder_near:[187,7,1,""],rotate:[187,7,1,""],same_quantum:[187,7,1,""],scaleb:[187,7,1,""],shift:[187,7,1,""],sqrt:[187,7,1,""],to_eng_string:[187,7,1,""],to_integral:[187,7,1,""],to_integral_exact:[187,7,1,""],to_integral_value:[187,7,1,""]},"difflib.Differ":{compare:[189,7,1,""]},"difflib.HtmlDiff":{__init__:[189,7,1,""],make_file:[189,7,1,""],make_table:[189,7,1,""]},"difflib.SequenceMatcher":{find_longest_match:[189,7,1,""],get_grouped_opcodes:[189,7,1,""],get_matching_blocks:[189,7,1,""],get_opcodes:[189,7,1,""],quick_ratio:[189,7,1,""],ratio:[189,7,1,""],real_quick_ratio:[189,7,1,""],set_seq1:[189,7,1,""],set_seq2:[189,7,1,""],set_seqs:[189,7,1,""]},"dis.Bytecode":{codeobj:[190,8,1,""],dis:[190,7,1,""],first_line:[190,8,1,""],from_traceback:[190,12,1,""],info:[190,7,1,""]},"dis.Instruction":{arg:[190,8,1,""],argrepr:[190,8,1,""],argval:[190,8,1,""],is_jump_target:[190,8,1,""],offset:[190,8,1,""],opcode:[190,8,1,""],opname:[190,8,1,""],starts_line:[190,8,1,""]},"distutils.archive_util":{make_archive:[65,10,1,""],make_tarball:[65,10,1,""],make_zipfile:[65,10,1,""]},"distutils.ccompiler":{CCompiler:[65,11,1,""],gen_lib_options:[65,10,1,""],gen_preprocess_options:[65,10,1,""],get_default_compiler:[65,10,1,""],new_compiler:[65,10,1,""],show_compilers:[65,10,1,""]},"distutils.ccompiler.CCompiler":{add_include_dir:[65,7,1,""],add_library:[65,7,1,""],add_library_dir:[65,7,1,""],add_link_object:[65,7,1,""],add_runtime_library_dir:[65,7,1,""],announce:[65,7,1,""],compile:[65,7,1,""],create_static_lib:[65,7,1,""],debug_print:[65,7,1,""],define_macro:[65,7,1,""],detect_language:[65,7,1,""],executable_filename:[65,7,1,""],execute:[65,7,1,""],find_library_file:[65,7,1,""],has_function:[65,7,1,""],library_dir_option:[65,7,1,""],library_filename:[65,7,1,""],library_option:[65,7,1,""],link:[65,7,1,""],link_executable:[65,7,1,""],link_shared_lib:[65,7,1,""],link_shared_object:[65,7,1,""],mkpath:[65,7,1,""],move_file:[65,7,1,""],object_filenames:[65,7,1,""],preprocess:[65,7,1,""],runtime_library_dir_option:[65,7,1,""],set_executables:[65,7,1,""],set_include_dirs:[65,7,1,""],set_libraries:[65,7,1,""],set_library_dirs:[65,7,1,""],set_link_objects:[65,7,1,""],set_runtime_library_dirs:[65,7,1,""],shared_object_filename:[65,7,1,""],spawn:[65,7,1,""],undefine_macro:[65,7,1,""],warn:[65,7,1,""]},"distutils.cmd":{Command:[65,11,1,""]},"distutils.cmd.Command":{finalize_options:[65,7,1,""],initialize_options:[65,7,1,""],run:[65,7,1,""],sub_commands:[65,6,1,""]},"distutils.command":{bdist:[65,9,0,"-"],bdist_dumb:[65,9,0,"-"],bdist_msi:[65,9,0,"-"],bdist_packager:[65,9,0,"-"],bdist_rpm:[65,9,0,"-"],bdist_wininst:[65,9,0,"-"],build:[65,9,0,"-"],build_clib:[65,9,0,"-"],build_ext:[65,9,0,"-"],build_py:[65,9,0,"-"],build_scripts:[65,9,0,"-"],check:[65,9,0,"-"],clean:[65,9,0,"-"],config:[65,9,0,"-"],install:[65,9,0,"-"],install_data:[65,9,0,"-"],install_headers:[65,9,0,"-"],install_lib:[65,9,0,"-"],install_scripts:[65,9,0,"-"],register:[65,9,0,"-"],sdist:[65,9,0,"-"]},"distutils.command.bdist_msi":{bdist_msi:[65,11,1,""]},"distutils.command.build_py":{build_py:[65,11,1,""],build_py_2to3:[65,11,1,""]},"distutils.core":{Command:[65,11,1,""],Distribution:[65,11,1,""],Extension:[65,11,1,""],run_setup:[65,10,1,""],setup:[65,10,1,""]},"distutils.dep_util":{newer:[65,10,1,""],newer_group:[65,10,1,""],newer_pairwise:[65,10,1,""]},"distutils.dir_util":{copy_tree:[65,10,1,""],create_tree:[65,10,1,""],mkpath:[65,10,1,""],remove_tree:[65,10,1,""]},"distutils.fancy_getopt":{FancyGetopt:[65,11,1,""],fancy_getopt:[65,10,1,""],wrap_text:[65,10,1,""]},"distutils.fancy_getopt.FancyGetopt":{generate_help:[65,7,1,""],get_option_order:[65,7,1,""],getopt:[65,7,1,""]},"distutils.file_util":{copy_file:[65,10,1,""],move_file:[65,10,1,""],write_file:[65,10,1,""]},"distutils.sysconfig":{EXEC_PREFIX:[65,8,1,""],PREFIX:[65,8,1,""],customize_compiler:[65,10,1,""],get_config_h_filename:[65,10,1,""],get_config_var:[65,10,1,""],get_config_vars:[65,10,1,""],get_makefile_filename:[65,10,1,""],get_python_inc:[65,10,1,""],get_python_lib:[65,10,1,""],set_python_build:[65,10,1,""]},"distutils.text_file":{TextFile:[65,11,1,""]},"distutils.text_file.TextFile":{close:[65,7,1,""],open:[65,7,1,""],readline:[65,7,1,""],readlines:[65,7,1,""],unreadline:[65,7,1,""],warn:[65,7,1,""]},"distutils.util":{byte_compile:[65,10,1,""],change_root:[65,10,1,""],check_environ:[65,10,1,""],convert_path:[65,10,1,""],execute:[65,10,1,""],get_platform:[65,10,1,""],rfc822_escape:[65,10,1,""],split_quoted:[65,10,1,""],strtobool:[65,10,1,""],subst_vars:[65,10,1,""]},"doctest.DocTest":{docstring:[193,6,1,""],examples:[193,6,1,""],filename:[193,6,1,""],globs:[193,6,1,""],lineno:[193,6,1,""],name:[193,6,1,""]},"doctest.DocTestFailure":{example:[193,6,1,""],got:[193,6,1,""],test:[193,6,1,""]},"doctest.DocTestFinder":{find:[193,7,1,""]},"doctest.DocTestParser":{get_doctest:[193,7,1,""],get_examples:[193,7,1,""],parse:[193,7,1,""]},"doctest.DocTestRunner":{report_failure:[193,7,1,""],report_start:[193,7,1,""],report_success:[193,7,1,""],report_unexpected_exception:[193,7,1,""],run:[193,7,1,""],summarize:[193,7,1,""]},"doctest.Example":{exc_msg:[193,6,1,""],indent:[193,6,1,""],lineno:[193,6,1,""],options:[193,6,1,""],source:[193,6,1,""],want:[193,6,1,""]},"doctest.OutputChecker":{check_output:[193,7,1,""],output_difference:[193,7,1,""]},"doctest.UnexpectedException":{example:[193,6,1,""],exc_info:[193,6,1,""],test:[193,6,1,""]},"email.charset":{Charset:[196,11,1,""],add_alias:[196,10,1,""],add_charset:[196,10,1,""],add_codec:[196,10,1,""]},"email.charset.Charset":{__eq__:[196,7,1,""],__ne__:[196,7,1,""],__str__:[196,7,1,""],body_encode:[196,7,1,""],body_encoding:[196,6,1,""],get_body_encoding:[196,7,1,""],get_output_charset:[196,7,1,""],header_encode:[196,7,1,""],header_encode_lines:[196,7,1,""],header_encoding:[196,6,1,""],input_charset:[196,6,1,""],input_codec:[196,6,1,""],output_charset:[196,6,1,""],output_codec:[196,6,1,""]},"email.contentmanager":{ContentManager:[198,11,1,""],get_content:[198,7,1,""],raw_data_manager:[198,8,1,""],set_content:[198,7,1,""]},"email.contentmanager.ContentManager":{add_get_handler:[198,7,1,""],add_set_handler:[198,7,1,""],get_content:[198,7,1,""],set_content:[198,7,1,""]},"email.encoders":{encode_7or8bit:[199,10,1,""],encode_base64:[199,10,1,""],encode_noop:[199,10,1,""],encode_quopri:[199,10,1,""]},"email.errors":{BoundaryError:[200,5,1,""],HeaderParseError:[200,5,1,""],MessageError:[200,5,1,""],MessageParseError:[200,5,1,""],MultipartConversionError:[200,5,1,""]},"email.generator":{BytesGenerator:[202,11,1,""],DecodedGenerator:[202,11,1,""],Generator:[202,11,1,""]},"email.generator.BytesGenerator":{clone:[202,7,1,""],flatten:[202,7,1,""],write:[202,7,1,""]},"email.generator.Generator":{clone:[202,7,1,""],flatten:[202,7,1,""],write:[202,7,1,""]},"email.header":{Header:[203,11,1,""],decode_header:[203,10,1,""],make_header:[203,10,1,""]},"email.header.Header":{__eq__:[203,7,1,""],__ne__:[203,7,1,""],__str__:[203,7,1,""],append:[203,7,1,""],encode:[203,7,1,""]},"email.headerregistry":{Address:[204,11,1,""],AddressHeader:[204,11,1,""],BaseHeader:[204,11,1,""],ContentDispositionHeader:[204,11,1,""],ContentTransferEncoding:[204,11,1,""],ContentTypeHeader:[204,11,1,""],DateHeader:[204,11,1,""],Group:[204,11,1,""],HeaderRegistry:[204,11,1,""],MIMEVersionHeader:[204,11,1,""],ParameterizedMIMEHeader:[204,11,1,""],SingleAddressHeader:[204,11,1,""],UnstructuredHeader:[204,11,1,""]},"email.headerregistry.Address":{__str__:[204,7,1,""],addr_spec:[204,6,1,""],display_name:[204,6,1,""],domain:[204,6,1,""],username:[204,6,1,""]},"email.headerregistry.AddressHeader":{addresses:[204,6,1,""],groups:[204,6,1,""]},"email.headerregistry.BaseHeader":{defects:[204,6,1,""],fold:[204,7,1,""],max_count:[204,6,1,""],name:[204,6,1,""]},"email.headerregistry.ContentTransferEncoding":{cte:[204,6,1,""]},"email.headerregistry.ContentTypeHeader":{content_type:[204,6,1,""],maintype:[204,6,1,""],subtype:[204,6,1,""]},"email.headerregistry.DateHeader":{datetime:[204,6,1,""]},"email.headerregistry.Group":{__str__:[204,7,1,""],addresses:[204,6,1,""],display_name:[204,6,1,""]},"email.headerregistry.HeaderRegistry":{__call__:[204,7,1,""],__getitem__:[204,7,1,""],map_to_type:[204,7,1,""]},"email.headerregistry.MIMEVersionHeader":{major:[204,6,1,""],minor:[204,6,1,""],version:[204,6,1,""]},"email.headerregistry.ParameterizedMIMEHeader":{params:[204,6,1,""]},"email.headerregistry.SingleAddressHeader":{address:[204,6,1,""]},"email.iterators":{_structure:[205,10,1,""],body_line_iterator:[205,10,1,""],typed_subpart_iterator:[205,10,1,""]},"email.message":{EmailMessage:[206,11,1,""],MIMEPart:[206,11,1,""],Message:[197,11,1,""]},"email.message.EmailMessage":{__bytes__:[206,7,1,""],__contains__:[206,7,1,""],__delitem__:[206,7,1,""],__getitem__:[206,7,1,""],__len__:[206,7,1,""],__setitem__:[206,7,1,""],__str__:[206,7,1,""],add_alternative:[206,7,1,""],add_attachment:[206,7,1,""],add_header:[206,7,1,""],add_related:[206,7,1,""],as_bytes:[206,7,1,""],as_string:[206,7,1,""],clear:[206,7,1,""],clear_content:[206,7,1,""],defects:[206,6,1,""],del_param:[206,7,1,""],epilogue:[206,6,1,""],get:[206,7,1,""],get_all:[206,7,1,""],get_body:[206,7,1,""],get_boundary:[206,7,1,""],get_charsets:[206,7,1,""],get_content:[206,7,1,""],get_content_charset:[206,7,1,""],get_content_disposition:[206,7,1,""],get_content_maintype:[206,7,1,""],get_content_subtype:[206,7,1,""],get_content_type:[206,7,1,""],get_default_type:[206,7,1,""],get_filename:[206,7,1,""],get_unixfrom:[206,7,1,""],is_attachment:[206,7,1,""],is_multipart:[206,7,1,""],items:[206,7,1,""],iter_attachments:[206,7,1,""],iter_parts:[206,7,1,""],keys:[206,7,1,""],make_alternative:[206,7,1,""],make_mixed:[206,7,1,""],make_related:[206,7,1,""],preamble:[206,6,1,""],replace_header:[206,7,1,""],set_boundary:[206,7,1,""],set_content:[206,7,1,""],set_default_type:[206,7,1,""],set_param:[206,7,1,""],set_unixfrom:[206,7,1,""],values:[206,7,1,""],walk:[206,7,1,""]},"email.message.Message":{__bytes__:[197,7,1,""],__contains__:[197,7,1,""],__delitem__:[197,7,1,""],__getitem__:[197,7,1,""],__len__:[197,7,1,""],__setitem__:[197,7,1,""],__str__:[197,7,1,""],add_header:[197,7,1,""],as_bytes:[197,7,1,""],as_string:[197,7,1,""],attach:[197,7,1,""],defects:[197,6,1,""],del_param:[197,7,1,""],epilogue:[197,6,1,""],get:[197,7,1,""],get_all:[197,7,1,""],get_boundary:[197,7,1,""],get_charset:[197,7,1,""],get_charsets:[197,7,1,""],get_content_charset:[197,7,1,""],get_content_disposition:[197,7,1,""],get_content_maintype:[197,7,1,""],get_content_subtype:[197,7,1,""],get_content_type:[197,7,1,""],get_default_type:[197,7,1,""],get_filename:[197,7,1,""],get_param:[197,7,1,""],get_params:[197,7,1,""],get_payload:[197,7,1,""],get_unixfrom:[197,7,1,""],is_multipart:[197,7,1,""],items:[197,7,1,""],keys:[197,7,1,""],preamble:[197,6,1,""],replace_header:[197,7,1,""],set_boundary:[197,7,1,""],set_charset:[197,7,1,""],set_default_type:[197,7,1,""],set_param:[197,7,1,""],set_payload:[197,7,1,""],set_type:[197,7,1,""],set_unixfrom:[197,7,1,""],values:[197,7,1,""],walk:[197,7,1,""]},"email.mime.application":{MIMEApplication:[207,11,1,""]},"email.mime.audio":{MIMEAudio:[207,11,1,""]},"email.mime.base":{MIMEBase:[207,11,1,""]},"email.mime.image":{MIMEImage:[207,11,1,""]},"email.mime.message":{MIMEMessage:[207,11,1,""]},"email.mime.multipart":{MIMEMultipart:[207,11,1,""]},"email.mime.nonmultipart":{MIMENonMultipart:[207,11,1,""]},"email.mime.text":{MIMEText:[207,11,1,""]},"email.parser":{BytesFeedParser:[208,11,1,""],BytesHeaderParser:[208,11,1,""],BytesParser:[208,11,1,""],FeedParser:[208,11,1,""],HeaderParser:[208,11,1,""],Parser:[208,11,1,""]},"email.parser.BytesFeedParser":{close:[208,7,1,""],feed:[208,7,1,""]},"email.parser.BytesParser":{parse:[208,7,1,""],parsebytes:[208,7,1,""]},"email.parser.Parser":{parse:[208,7,1,""],parsestr:[208,7,1,""]},"email.policy":{"default":[209,8,1,""],Compat32:[209,11,1,""],EmailPolicy:[209,11,1,""],HTTP:[209,8,1,""],Policy:[209,11,1,""],SMTP:[209,8,1,""],SMTPUTF8:[209,8,1,""],compat32:[209,8,1,""],strict:[209,8,1,""]},"email.policy.Compat32":{fold:[209,7,1,""],fold_binary:[209,7,1,""],header_fetch_parse:[209,7,1,""],header_source_parse:[209,7,1,""],header_store_parse:[209,7,1,""],mangle_from_:[209,6,1,""]},"email.policy.EmailPolicy":{content_manager:[209,6,1,""],fold:[209,7,1,""],fold_binary:[209,7,1,""],header_factory:[209,6,1,""],header_fetch_parse:[209,7,1,""],header_max_count:[209,7,1,""],header_source_parse:[209,7,1,""],header_store_parse:[209,7,1,""],refold_source:[209,6,1,""],utf8:[209,6,1,""]},"email.policy.Policy":{clone:[209,7,1,""],cte_type:[209,6,1,""],fold:[209,7,1,""],fold_binary:[209,7,1,""],handle_defect:[209,7,1,""],header_fetch_parse:[209,7,1,""],header_max_count:[209,7,1,""],header_source_parse:[209,7,1,""],header_store_parse:[209,7,1,""],linesep:[209,6,1,""],mangle_from_:[209,6,1,""],max_line_length:[209,6,1,""],message_factory:[209,6,1,""],raise_on_defect:[209,6,1,""],register_defect:[209,7,1,""]},"email.utils":{collapse_rfc2231_value:[210,10,1,""],decode_params:[210,10,1,""],decode_rfc2231:[210,10,1,""],encode_rfc2231:[210,10,1,""],format_datetime:[210,10,1,""],formataddr:[210,10,1,""],formatdate:[210,10,1,""],getaddresses:[210,10,1,""],localtime:[210,10,1,""],make_msgid:[210,10,1,""],mktime_tz:[210,10,1,""],parseaddr:[210,10,1,""],parsedate:[210,10,1,""],parsedate_to_datetime:[210,10,1,""],parsedate_tz:[210,10,1,""],quote:[210,10,1,""],unquote:[210,10,1,""]},"encodings.idna":{ToASCII:[159,10,1,""],ToUnicode:[159,10,1,""],nameprep:[159,10,1,""]},"enum":{Enum:[212,11,1,""],Flag:[212,11,1,""],IntEnum:[212,11,1,""],IntFlag:[212,11,1,""],auto:[212,11,1,""],unique:[212,10,1,""]},"filecmp.dircmp":{common:[217,6,1,""],common_dirs:[217,6,1,""],common_files:[217,6,1,""],common_funny:[217,6,1,""],diff_files:[217,6,1,""],funny_files:[217,6,1,""],left:[217,6,1,""],left_list:[217,6,1,""],left_only:[217,6,1,""],report:[217,7,1,""],report_full_closure:[217,7,1,""],report_partial_closure:[217,7,1,""],right:[217,6,1,""],right_list:[217,6,1,""],right_only:[217,6,1,""],same_files:[217,6,1,""],subdirs:[217,6,1,""]},"float":{as_integer_ratio:[346,7,1,""],fromhex:[346,12,1,""],hex:[346,7,1,""],is_integer:[346,7,1,""]},"formatter.formatter":{add_flowing_data:[222,7,1,""],add_hor_rule:[222,7,1,""],add_label_data:[222,7,1,""],add_line_break:[222,7,1,""],add_literal_data:[222,7,1,""],assert_line_data:[222,7,1,""],end_paragraph:[222,7,1,""],flush_softspace:[222,7,1,""],pop_alignment:[222,7,1,""],pop_font:[222,7,1,""],pop_margin:[222,7,1,""],pop_style:[222,7,1,""],push_alignment:[222,7,1,""],push_font:[222,7,1,""],push_margin:[222,7,1,""],push_style:[222,7,1,""],set_spacing:[222,7,1,""],writer:[222,6,1,""]},"formatter.writer":{flush:[222,7,1,""],new_alignment:[222,7,1,""],new_font:[222,7,1,""],new_margin:[222,7,1,""],new_spacing:[222,7,1,""],new_styles:[222,7,1,""],send_flowing_data:[222,7,1,""],send_hor_rule:[222,7,1,""],send_label_data:[222,7,1,""],send_line_break:[222,7,1,""],send_literal_data:[222,7,1,""],send_paragraph:[222,7,1,""]},"fractions.Fraction":{__ceil__:[223,7,1,""],__floor__:[223,7,1,""],__round__:[223,7,1,""],denominator:[223,6,1,""],from_decimal:[223,7,1,""],from_float:[223,7,1,""],limit_denominator:[223,7,1,""],numerator:[223,6,1,""]},"ftplib.FTP":{"delete":[225,7,1,""],abort:[225,7,1,""],close:[225,7,1,""],connect:[225,7,1,""],cwd:[225,7,1,""],dir:[225,7,1,""],getwelcome:[225,7,1,""],login:[225,7,1,""],mkd:[225,7,1,""],mlsd:[225,7,1,""],nlst:[225,7,1,""],ntransfercmd:[225,7,1,""],pwd:[225,7,1,""],quit:[225,7,1,""],rename:[225,7,1,""],retrbinary:[225,7,1,""],retrlines:[225,7,1,""],rmd:[225,7,1,""],sendcmd:[225,7,1,""],set_debuglevel:[225,7,1,""],set_pasv:[225,7,1,""],size:[225,7,1,""],storbinary:[225,7,1,""],storlines:[225,7,1,""],transfercmd:[225,7,1,""],voidcmd:[225,7,1,""]},"ftplib.FTP_TLS":{auth:[225,7,1,""],ccc:[225,7,1,""],prot_c:[225,7,1,""],prot_p:[225,7,1,""],ssl_version:[225,6,1,""]},"functools.partial":{args:[228,6,1,""],func:[228,6,1,""],keywords:[228,6,1,""]},"gettext.GNUTranslations":{gettext:[232,7,1,""],lgettext:[232,7,1,""],lngettext:[232,7,1,""],ngettext:[232,7,1,""]},"gettext.NullTranslations":{_parse:[232,7,1,""],add_fallback:[232,7,1,""],charset:[232,7,1,""],gettext:[232,7,1,""],info:[232,7,1,""],install:[232,7,1,""],lgettext:[232,7,1,""],lngettext:[232,7,1,""],ngettext:[232,7,1,""],output_charset:[232,7,1,""],set_output_charset:[232,7,1,""]},"gzip.GzipFile":{mtime:[235,6,1,""],peek:[235,7,1,""]},"hashlib.blake2b":{MAX_DIGEST_SIZE:[236,8,1,""],MAX_KEY_SIZE:[236,8,1,""],PERSON_SIZE:[236,8,1,""],SALT_SIZE:[236,8,1,""]},"hashlib.blake2s":{MAX_DIGEST_SIZE:[236,8,1,""],MAX_KEY_SIZE:[236,8,1,""],PERSON_SIZE:[236,8,1,""],SALT_SIZE:[236,8,1,""]},"hashlib.hash":{block_size:[236,8,1,""],copy:[236,7,1,""],digest:[236,7,1,""],digest_size:[236,8,1,""],hexdigest:[236,7,1,""],name:[236,6,1,""],update:[236,7,1,""]},"hashlib.shake":{digest:[236,7,1,""],hexdigest:[236,7,1,""]},"hmac.HMAC":{block_size:[238,6,1,""],copy:[238,7,1,""],digest:[238,7,1,""],digest_size:[238,6,1,""],hexdigest:[238,7,1,""],name:[238,6,1,""],update:[238,7,1,""]},"html.entities":{codepoint2name:[240,8,1,""],entitydefs:[240,8,1,""],html5:[240,8,1,""],name2codepoint:[240,8,1,""]},"html.parser":{HTMLParser:[241,11,1,""]},"html.parser.HTMLParser":{close:[241,7,1,""],feed:[241,7,1,""],get_starttag_text:[241,7,1,""],getpos:[241,7,1,""],handle_charref:[241,7,1,""],handle_comment:[241,7,1,""],handle_data:[241,7,1,""],handle_decl:[241,7,1,""],handle_endtag:[241,7,1,""],handle_entityref:[241,7,1,""],handle_pi:[241,7,1,""],handle_startendtag:[241,7,1,""],handle_starttag:[241,7,1,""],reset:[241,7,1,""],unknown_decl:[241,7,1,""]},"http.client":{BadStatusLine:[243,5,1,""],CannotSendHeader:[243,5,1,""],CannotSendRequest:[243,5,1,""],HTTPConnection:[243,11,1,""],HTTPException:[243,5,1,""],HTTPResponse:[243,11,1,""],HTTPSConnection:[243,11,1,""],HTTPS_PORT:[243,8,1,""],HTTP_PORT:[243,8,1,""],ImproperConnectionState:[243,5,1,""],IncompleteRead:[243,5,1,""],InvalidURL:[243,5,1,""],LineTooLong:[243,5,1,""],NotConnected:[243,5,1,""],RemoteDisconnected:[243,5,1,""],ResponseNotReady:[243,5,1,""],UnimplementedFileMode:[243,5,1,""],UnknownProtocol:[243,5,1,""],UnknownTransferEncoding:[243,5,1,""],responses:[243,8,1,""]},"http.client.HTTPConnection":{blocksize:[243,6,1,""],close:[243,7,1,""],connect:[243,7,1,""],endheaders:[243,7,1,""],getresponse:[243,7,1,""],putheader:[243,7,1,""],putrequest:[243,7,1,""],request:[243,7,1,""],send:[243,7,1,""],set_debuglevel:[243,7,1,""],set_tunnel:[243,7,1,""]},"http.client.HTTPResponse":{closed:[243,6,1,""],debuglevel:[243,6,1,""],fileno:[243,7,1,""],getheader:[243,7,1,""],getheaders:[243,7,1,""],msg:[243,6,1,""],read:[243,7,1,""],readinto:[243,7,1,""],reason:[243,6,1,""],status:[243,6,1,""],version:[243,6,1,""]},"http.cookiejar":{Cookie:[244,11,1,""],CookieJar:[244,11,1,""],CookiePolicy:[244,11,1,""],DefaultCookiePolicy:[244,11,1,""],FileCookieJar:[244,11,1,""],LWPCookieJar:[244,11,1,""],LoadError:[244,5,1,""],MozillaCookieJar:[244,11,1,""]},"http.cookiejar.Cookie":{comment:[244,6,1,""],comment_url:[244,6,1,""],discard:[244,6,1,""],domain_initial_dot:[244,6,1,""],domain_specified:[244,6,1,""],expires:[244,6,1,""],get_nonstandard_attr:[244,7,1,""],has_nonstandard_attr:[244,7,1,""],is_expired:[244,7,1,""],name:[244,6,1,""],path:[244,6,1,""],port:[244,6,1,""],port_specified:[244,6,1,""],rfc2109:[244,6,1,""],secure:[244,6,1,""],set_nonstandard_attr:[244,7,1,""],value:[244,6,1,""],version:[244,6,1,""]},"http.cookiejar.CookieJar":{add_cookie_header:[244,7,1,""],clear:[244,7,1,""],clear_session_cookies:[244,7,1,""],extract_cookies:[244,7,1,""],make_cookies:[244,7,1,""],set_cookie:[244,7,1,""],set_cookie_if_ok:[244,7,1,""],set_policy:[244,7,1,""]},"http.cookiejar.CookiePolicy":{domain_return_ok:[244,7,1,""],hide_cookie2:[244,6,1,""],netscape:[244,6,1,""],path_return_ok:[244,7,1,""],return_ok:[244,7,1,""],rfc2965:[244,6,1,""],set_ok:[244,7,1,""]},"http.cookiejar.DefaultCookiePolicy":{DomainLiberal:[244,6,1,""],DomainRFC2965Match:[244,6,1,""],DomainStrict:[244,6,1,""],DomainStrictNoDots:[244,6,1,""],DomainStrictNonDomain:[244,6,1,""],allowed_domains:[244,7,1,""],blocked_domains:[244,7,1,""],is_blocked:[244,7,1,""],is_not_allowed:[244,7,1,""],rfc2109_as_netscape:[244,6,1,""],set_allowed_domains:[244,7,1,""],set_blocked_domains:[244,7,1,""],strict_domain:[244,6,1,""],strict_ns_domain:[244,6,1,""],strict_ns_set_initial_dollar:[244,6,1,""],strict_ns_set_path:[244,6,1,""],strict_ns_unverifiable:[244,6,1,""],strict_rfc2965_unverifiable:[244,6,1,""]},"http.cookiejar.FileCookieJar":{delayload:[244,6,1,""],filename:[244,6,1,""],load:[244,7,1,""],revert:[244,7,1,""],save:[244,7,1,""]},"http.cookies":{BaseCookie:[245,11,1,""],CookieError:[245,5,1,""],Morsel:[245,11,1,""],SimpleCookie:[245,11,1,""]},"http.cookies.BaseCookie":{js_output:[245,7,1,""],load:[245,7,1,""],output:[245,7,1,""],value_decode:[245,7,1,""],value_encode:[245,7,1,""]},"http.cookies.Morsel":{OutputString:[245,7,1,""],coded_value:[245,6,1,""],copy:[245,7,1,""],isReservedKey:[245,7,1,""],js_output:[245,7,1,""],key:[245,6,1,""],output:[245,7,1,""],set:[245,7,1,""],setdefault:[245,7,1,""],update:[245,7,1,""],value:[245,6,1,""]},"http.server":{BaseHTTPRequestHandler:[246,11,1,""],CGIHTTPRequestHandler:[246,11,1,""],HTTPServer:[246,11,1,""],SimpleHTTPRequestHandler:[246,11,1,""],ThreadingHTTPServer:[246,11,1,""]},"http.server.BaseHTTPRequestHandler":{MessageClass:[246,6,1,""],address_string:[246,7,1,""],client_address:[246,6,1,""],close_connection:[246,6,1,""],command:[246,6,1,""],date_time_string:[246,7,1,""],end_headers:[246,7,1,""],error_content_type:[246,6,1,""],error_message_format:[246,6,1,""],flush_headers:[246,7,1,""],handle:[246,7,1,""],handle_expect_100:[246,7,1,""],handle_one_request:[246,7,1,""],headers:[246,6,1,""],log_date_time_string:[246,7,1,""],log_error:[246,7,1,""],log_message:[246,7,1,""],log_request:[246,7,1,""],path:[246,6,1,""],protocol_version:[246,6,1,""],request_version:[246,6,1,""],requestline:[246,6,1,""],responses:[246,6,1,""],rfile:[246,6,1,""],send_error:[246,7,1,""],send_header:[246,7,1,""],send_response:[246,7,1,""],send_response_only:[246,7,1,""],server:[246,6,1,""],server_version:[246,6,1,""],sys_version:[246,6,1,""],version_string:[246,7,1,""],wfile:[246,6,1,""]},"http.server.CGIHTTPRequestHandler":{cgi_directories:[246,6,1,""],do_POST:[246,7,1,""]},"http.server.SimpleHTTPRequestHandler":{directory:[246,6,1,""],do_GET:[246,7,1,""],do_HEAD:[246,7,1,""],extensions_map:[246,6,1,""],server_version:[246,6,1,""]},"imaplib.IMAP4":{"delete":[249,7,1,""],PROTOCOL_VERSION:[249,6,1,""],abort:[249,5,1,""],append:[249,7,1,""],authenticate:[249,7,1,""],check:[249,7,1,""],close:[249,7,1,""],copy:[249,7,1,""],create:[249,7,1,""],debug:[249,6,1,""],deleteacl:[249,7,1,""],enable:[249,7,1,""],error:[249,5,1,""],expunge:[249,7,1,""],fetch:[249,7,1,""],getacl:[249,7,1,""],getannotation:[249,7,1,""],getquota:[249,7,1,""],getquotaroot:[249,7,1,""],list:[249,7,1,""],login:[249,7,1,""],login_cram_md5:[249,7,1,""],logout:[249,7,1,""],lsub:[249,7,1,""],myrights:[249,7,1,""],namespace:[249,7,1,""],noop:[249,7,1,""],open:[249,7,1,""],partial:[249,7,1,""],proxyauth:[249,7,1,""],read:[249,7,1,""],readline:[249,7,1,""],readonly:[249,5,1,""],recent:[249,7,1,""],rename:[249,7,1,""],response:[249,7,1,""],search:[249,7,1,""],select:[249,7,1,""],send:[249,7,1,""],setacl:[249,7,1,""],setannotation:[249,7,1,""],setquota:[249,7,1,""],shutdown:[249,7,1,""],socket:[249,7,1,""],sort:[249,7,1,""],starttls:[249,7,1,""],status:[249,7,1,""],store:[249,7,1,""],subscribe:[249,7,1,""],thread:[249,7,1,""],uid:[249,7,1,""],unsubscribe:[249,7,1,""],utf8_enabled:[249,6,1,""],xatom:[249,7,1,""]},"imp.NullImporter":{find_module:[251,7,1,""]},"importlib.abc":{ExecutionLoader:[252,11,1,""],FileLoader:[252,11,1,""],Finder:[252,11,1,""],InspectLoader:[252,11,1,""],Loader:[252,11,1,""],MetaPathFinder:[252,11,1,""],PathEntryFinder:[252,11,1,""],ResourceLoader:[252,11,1,""],ResourceReader:[252,11,1,""],SourceLoader:[252,11,1,""]},"importlib.abc.ExecutionLoader":{get_filename:[252,7,1,""]},"importlib.abc.FileLoader":{get_data:[252,7,1,""],get_filename:[252,7,1,""],load_module:[252,7,1,""],name:[252,6,1,""],path:[252,6,1,""]},"importlib.abc.Finder":{find_module:[252,7,1,""]},"importlib.abc.InspectLoader":{exec_module:[252,7,1,""],get_code:[252,7,1,""],get_source:[252,7,1,""],is_package:[252,7,1,""],load_module:[252,7,1,""],source_to_code:[252,13,1,""]},"importlib.abc.Loader":{create_module:[252,7,1,""],exec_module:[252,7,1,""],load_module:[252,7,1,""],module_repr:[252,7,1,""]},"importlib.abc.MetaPathFinder":{find_module:[252,7,1,""],find_spec:[252,7,1,""],invalidate_caches:[252,7,1,""]},"importlib.abc.PathEntryFinder":{find_loader:[252,7,1,""],find_module:[252,7,1,""],find_spec:[252,7,1,""],invalidate_caches:[252,7,1,""]},"importlib.abc.ResourceLoader":{get_data:[252,7,1,""]},"importlib.abc.ResourceReader":{contents:[252,7,1,""],is_resource:[252,7,1,""],open_resource:[252,7,1,""],resource_path:[252,7,1,""]},"importlib.abc.SourceLoader":{exec_module:[252,7,1,""],get_code:[252,7,1,""],get_source:[252,7,1,""],is_package:[252,7,1,""],load_module:[252,7,1,""],path_mtime:[252,7,1,""],path_stats:[252,7,1,""],set_data:[252,7,1,""]},"importlib.machinery":{BYTECODE_SUFFIXES:[252,6,1,""],BuiltinImporter:[252,11,1,""],DEBUG_BYTECODE_SUFFIXES:[252,6,1,""],EXTENSION_SUFFIXES:[252,6,1,""],ExtensionFileLoader:[252,11,1,""],FileFinder:[252,11,1,""],FrozenImporter:[252,11,1,""],ModuleSpec:[252,11,1,""],OPTIMIZED_BYTECODE_SUFFIXES:[252,6,1,""],PathFinder:[252,11,1,""],SOURCE_SUFFIXES:[252,6,1,""],SourceFileLoader:[252,11,1,""],SourcelessFileLoader:[252,11,1,""],WindowsRegistryFinder:[252,11,1,""],all_suffixes:[252,10,1,""]},"importlib.machinery.ExtensionFileLoader":{create_module:[252,7,1,""],exec_module:[252,7,1,""],get_code:[252,7,1,""],get_filename:[252,7,1,""],get_source:[252,7,1,""],is_package:[252,7,1,""],name:[252,6,1,""],path:[252,6,1,""]},"importlib.machinery.FileFinder":{find_loader:[252,7,1,""],find_spec:[252,7,1,""],invalidate_caches:[252,7,1,""],path:[252,6,1,""],path_hook:[252,12,1,""]},"importlib.machinery.ModuleSpec":{cached:[252,6,1,""],has_location:[252,6,1,""],loader:[252,6,1,""],loader_state:[252,6,1,""],name:[252,6,1,""],origin:[252,6,1,""],parent:[252,6,1,""],submodule_search_locations:[252,6,1,""]},"importlib.machinery.PathFinder":{find_module:[252,12,1,""],find_spec:[252,12,1,""],invalidate_caches:[252,12,1,""]},"importlib.machinery.SourceFileLoader":{is_package:[252,7,1,""],load_module:[252,7,1,""],name:[252,6,1,""],path:[252,6,1,""],path_stats:[252,7,1,""],set_data:[252,7,1,""]},"importlib.machinery.SourcelessFileLoader":{get_code:[252,7,1,""],get_source:[252,7,1,""],is_package:[252,7,1,""],load_module:[252,7,1,""],name:[252,6,1,""],path:[252,6,1,""]},"importlib.resources":{Package:[252,8,1,""],Resource:[252,8,1,""],contents:[252,10,1,""],is_resource:[252,10,1,""],open_binary:[252,10,1,""],open_text:[252,10,1,""],path:[252,10,1,""],read_binary:[252,10,1,""],read_text:[252,10,1,""]},"importlib.util":{LazyLoader:[252,11,1,""],MAGIC_NUMBER:[252,6,1,""],cache_from_source:[252,10,1,""],decode_source:[252,10,1,""],find_spec:[252,10,1,""],module_for_loader:[252,10,1,""],module_from_spec:[252,10,1,""],resolve_name:[252,10,1,""],set_loader:[252,10,1,""],set_package:[252,10,1,""],source_from_cache:[252,10,1,""],source_hash:[252,10,1,""],spec_from_file_location:[252,10,1,""],spec_from_loader:[252,10,1,""]},"importlib.util.LazyLoader":{factory:[252,12,1,""]},"inspect.BoundArguments":{apply_defaults:[254,7,1,""],args:[254,6,1,""],arguments:[254,6,1,""],kwargs:[254,6,1,""],signature:[254,6,1,""]},"inspect.Parameter":{"default":[254,6,1,""],annotation:[254,6,1,""],empty:[254,6,1,""],kind:[254,6,1,""],name:[254,6,1,""],replace:[254,7,1,""]},"inspect.Signature":{bind:[254,7,1,""],bind_partial:[254,7,1,""],empty:[254,6,1,""],from_callable:[254,12,1,""],parameters:[254,6,1,""],replace:[254,7,1,""],return_annotation:[254,6,1,""]},"int":{bit_length:[346,7,1,""],from_bytes:[346,12,1,""],to_bytes:[346,7,1,""]},"io.BufferedIOBase":{detach:[257,7,1,""],raw:[257,6,1,""],read1:[257,7,1,""],read:[257,7,1,""],readinto1:[257,7,1,""],readinto:[257,7,1,""],write:[257,7,1,""]},"io.BufferedReader":{peek:[257,7,1,""],read1:[257,7,1,""],read:[257,7,1,""]},"io.BufferedWriter":{flush:[257,7,1,""],write:[257,7,1,""]},"io.BytesIO":{getbuffer:[257,7,1,""],getvalue:[257,7,1,""],read1:[257,7,1,""],readinto1:[257,7,1,""]},"io.FileIO":{mode:[257,6,1,""],name:[257,6,1,""]},"io.IOBase":{__del__:[257,7,1,""],close:[257,7,1,""],closed:[257,6,1,""],fileno:[257,7,1,""],flush:[257,7,1,""],isatty:[257,7,1,""],readable:[257,7,1,""],readline:[257,7,1,""],readlines:[257,7,1,""],seek:[257,7,1,""],seekable:[257,7,1,""],tell:[257,7,1,""],truncate:[257,7,1,""],writable:[257,7,1,""],writelines:[257,7,1,""]},"io.RawIOBase":{read:[257,7,1,""],readall:[257,7,1,""],readinto:[257,7,1,""],write:[257,7,1,""]},"io.StringIO":{getvalue:[257,7,1,""]},"io.TextIOBase":{buffer:[257,6,1,""],detach:[257,7,1,""],encoding:[257,6,1,""],errors:[257,6,1,""],newlines:[257,6,1,""],read:[257,7,1,""],readline:[257,7,1,""],seek:[257,7,1,""],tell:[257,7,1,""],write:[257,7,1,""]},"io.TextIOWrapper":{line_buffering:[257,6,1,""],reconfigure:[257,7,1,""],write_through:[257,6,1,""]},"ipaddress.IPv4Address":{compressed:[258,6,1,""],exploded:[258,6,1,""],is_global:[258,6,1,""],is_link_local:[258,6,1,""],is_loopback:[258,6,1,""],is_multicast:[258,6,1,""],is_private:[258,6,1,""],is_reserved:[258,6,1,""],is_unspecified:[258,6,1,""],max_prefixlen:[258,6,1,""],packed:[258,6,1,""],reverse_pointer:[258,6,1,""],version:[258,6,1,""]},"ipaddress.IPv4Interface":{ip:[258,6,1,""],network:[258,6,1,""],with_hostmask:[258,6,1,""],with_netmask:[258,6,1,""],with_prefixlen:[258,6,1,""]},"ipaddress.IPv4Network":{address_exclude:[258,7,1,""],broadcast_address:[258,6,1,""],compare_networks:[258,7,1,""],compressed:[258,6,1,""],exploded:[258,6,1,""],hostmask:[258,6,1,""],hosts:[258,7,1,""],is_link_local:[258,6,1,""],is_loopback:[258,6,1,""],is_multicast:[258,6,1,""],is_private:[258,6,1,""],is_reserved:[258,6,1,""],is_unspecified:[258,6,1,""],max_prefixlen:[258,6,1,""],netmask:[258,6,1,""],network_address:[258,6,1,""],num_addresses:[258,6,1,""],overlaps:[258,7,1,""],prefixlen:[258,6,1,""],subnet_of:[258,7,1,""],subnets:[258,7,1,""],supernet:[258,7,1,""],supernet_of:[258,7,1,""],version:[258,6,1,""],with_hostmask:[258,6,1,""],with_netmask:[258,6,1,""],with_prefixlen:[258,6,1,""]},"ipaddress.IPv6Address":{compressed:[258,6,1,""],exploded:[258,6,1,""],ipv4_mapped:[258,6,1,""],is_global:[258,6,1,""],is_link_local:[258,6,1,""],is_loopback:[258,6,1,""],is_multicast:[258,6,1,""],is_private:[258,6,1,""],is_reserved:[258,6,1,""],is_site_local:[258,6,1,""],is_unspecified:[258,6,1,""],max_prefixlen:[258,6,1,""],packed:[258,6,1,""],reverse_pointer:[258,6,1,""],sixtofour:[258,6,1,""],teredo:[258,6,1,""],version:[258,6,1,""]},"ipaddress.IPv6Interface":{ip:[258,6,1,""],network:[258,6,1,""],with_hostmask:[258,6,1,""],with_netmask:[258,6,1,""],with_prefixlen:[258,6,1,""]},"ipaddress.IPv6Network":{address_exclude:[258,7,1,""],broadcast_address:[258,6,1,""],compare_networks:[258,7,1,""],compressed:[258,6,1,""],exploded:[258,6,1,""],hostmask:[258,6,1,""],hosts:[258,7,1,""],is_link_local:[258,6,1,""],is_loopback:[258,6,1,""],is_multicast:[258,6,1,""],is_private:[258,6,1,""],is_reserved:[258,6,1,""],is_site_local:[258,6,1,""],is_unspecified:[258,6,1,""],max_prefixlen:[258,6,1,""],netmask:[258,6,1,""],network_address:[258,6,1,""],num_addresses:[258,6,1,""],overlaps:[258,7,1,""],prefixlen:[258,6,1,""],subnet_of:[258,7,1,""],subnets:[258,7,1,""],supernet:[258,7,1,""],supernet_of:[258,7,1,""],version:[258,6,1,""],with_hostmask:[258,6,1,""],with_netmask:[258,6,1,""],with_prefixlen:[258,6,1,""]},"itertools.chain":{from_iterable:[260,12,1,""]},"json.JSONDecodeError":{colno:[261,6,1,""],doc:[261,6,1,""],lineno:[261,6,1,""],msg:[261,6,1,""],pos:[261,6,1,""]},"json.JSONDecoder":{decode:[261,7,1,""],raw_decode:[261,7,1,""]},"json.JSONEncoder":{"default":[261,7,1,""],encode:[261,7,1,""],iterencode:[261,7,1,""]},"json.tool":{"--help":[261,15,1,"cmdoption-json-tool-h"],"--sort-keys":[261,15,1,"cmdoption-json-tool-sort-keys"],"-h":[261,15,1,"cmdoption-json-tool-h"],infile:[261,15,1,"cmdoption-json-tool-arg-infile"],outfile:[261,15,1,"cmdoption-json-tool-arg-outfile"]},"logging.FileHandler":{close:[268,7,1,""],emit:[268,7,1,""]},"logging.Filter":{filter:[266,7,1,""]},"logging.Formatter":{format:[266,7,1,""],formatException:[266,7,1,""],formatStack:[266,7,1,""],formatTime:[266,7,1,""]},"logging.Handler":{__init__:[266,7,1,""],acquire:[266,7,1,""],addFilter:[266,7,1,""],close:[266,7,1,""],createLock:[266,7,1,""],emit:[266,7,1,""],filter:[266,7,1,""],flush:[266,7,1,""],format:[266,7,1,""],handle:[266,7,1,""],handleError:[266,7,1,""],release:[266,7,1,""],removeFilter:[266,7,1,""],setFormatter:[266,7,1,""],setLevel:[266,7,1,""]},"logging.LogRecord":{getMessage:[266,7,1,""]},"logging.Logger":{addFilter:[266,7,1,""],addHandler:[266,7,1,""],critical:[266,7,1,""],debug:[266,7,1,""],error:[266,7,1,""],exception:[266,7,1,""],filter:[266,7,1,""],findCaller:[266,7,1,""],getChild:[266,7,1,""],getEffectiveLevel:[266,7,1,""],handle:[266,7,1,""],hasHandlers:[266,7,1,""],info:[266,7,1,""],isEnabledFor:[266,7,1,""],log:[266,7,1,""],makeRecord:[266,7,1,""],propagate:[266,6,1,""],removeFilter:[266,7,1,""],removeHandler:[266,7,1,""],setLevel:[266,7,1,""],warning:[266,7,1,""]},"logging.LoggerAdapter":{process:[266,7,1,""]},"logging.NullHandler":{createLock:[268,7,1,""],emit:[268,7,1,""],handle:[268,7,1,""]},"logging.StreamHandler":{emit:[268,7,1,""],flush:[268,7,1,""],setStream:[268,7,1,""]},"logging.config":{dictConfig:[267,10,1,""],fileConfig:[267,10,1,""],listen:[267,10,1,""],stopListening:[267,10,1,""]},"logging.handlers":{BaseRotatingHandler:[268,11,1,""],BufferingHandler:[268,11,1,""],DatagramHandler:[268,11,1,""],HTTPHandler:[268,11,1,""],MemoryHandler:[268,11,1,""],NTEventLogHandler:[268,11,1,""],QueueHandler:[268,11,1,""],QueueListener:[268,11,1,""],RotatingFileHandler:[268,11,1,""],SMTPHandler:[268,11,1,""],SocketHandler:[268,11,1,""],SysLogHandler:[268,11,1,""],TimedRotatingFileHandler:[268,11,1,""],WatchedFileHandler:[268,11,1,""]},"logging.handlers.BaseRotatingHandler":{namer:[268,6,1,""],rotate:[268,7,1,""],rotation_filename:[268,7,1,""],rotator:[268,6,1,""]},"logging.handlers.BufferingHandler":{emit:[268,7,1,""],flush:[268,7,1,""],shouldFlush:[268,7,1,""]},"logging.handlers.DatagramHandler":{emit:[268,7,1,""],makeSocket:[268,7,1,""],send:[268,7,1,""]},"logging.handlers.HTTPHandler":{emit:[268,7,1,""],mapLogRecord:[268,7,1,""]},"logging.handlers.MemoryHandler":{close:[268,7,1,""],flush:[268,7,1,""],setTarget:[268,7,1,""],shouldFlush:[268,7,1,""]},"logging.handlers.NTEventLogHandler":{close:[268,7,1,""],emit:[268,7,1,""],getEventCategory:[268,7,1,""],getEventType:[268,7,1,""],getMessageID:[268,7,1,""]},"logging.handlers.QueueHandler":{emit:[268,7,1,""],enqueue:[268,7,1,""],prepare:[268,7,1,""]},"logging.handlers.QueueListener":{dequeue:[268,7,1,""],enqueue_sentinel:[268,7,1,""],handle:[268,7,1,""],prepare:[268,7,1,""],start:[268,7,1,""],stop:[268,7,1,""]},"logging.handlers.RotatingFileHandler":{doRollover:[268,7,1,""],emit:[268,7,1,""]},"logging.handlers.SMTPHandler":{emit:[268,7,1,""],getSubject:[268,7,1,""]},"logging.handlers.SocketHandler":{close:[268,7,1,""],createSocket:[268,7,1,""],emit:[268,7,1,""],handleError:[268,7,1,""],makePickle:[268,7,1,""],makeSocket:[268,7,1,""],send:[268,7,1,""]},"logging.handlers.SysLogHandler":{close:[268,7,1,""],emit:[268,7,1,""],encodePriority:[268,7,1,""],mapPriority:[268,7,1,""]},"logging.handlers.TimedRotatingFileHandler":{doRollover:[268,7,1,""],emit:[268,7,1,""]},"logging.handlers.WatchedFileHandler":{emit:[268,7,1,""],reopenIfNeeded:[268,7,1,""]},"logging.logging.Formatter":{__init__:[103,7,1,""]},"lzma.LZMACompressor":{compress:[269,7,1,""],flush:[269,7,1,""]},"lzma.LZMADecompressor":{check:[269,6,1,""],decompress:[269,7,1,""],eof:[269,6,1,""],needs_input:[269,6,1,""],unused_data:[269,6,1,""]},"lzma.LZMAFile":{peek:[269,7,1,""]},"mailbox.Babyl":{get_file:[271,7,1,""],get_labels:[271,7,1,""],lock:[271,7,1,""],unlock:[271,7,1,""]},"mailbox.BabylMessage":{add_label:[271,7,1,""],get_labels:[271,7,1,""],get_visible:[271,7,1,""],remove_label:[271,7,1,""],set_labels:[271,7,1,""],set_visible:[271,7,1,""],update_visible:[271,7,1,""]},"mailbox.MH":{__delitem__:[271,7,1,""],add_folder:[271,7,1,""],close:[271,7,1,""],discard:[271,7,1,""],flush:[271,7,1,""],get_file:[271,7,1,""],get_folder:[271,7,1,""],get_sequences:[271,7,1,""],list_folders:[271,7,1,""],lock:[271,7,1,""],pack:[271,7,1,""],remove:[271,7,1,""],remove_folder:[271,7,1,""],set_sequences:[271,7,1,""],unlock:[271,7,1,""]},"mailbox.MHMessage":{add_sequence:[271,7,1,""],get_sequences:[271,7,1,""],remove_sequence:[271,7,1,""],set_sequences:[271,7,1,""]},"mailbox.MMDF":{get_file:[271,7,1,""],lock:[271,7,1,""],unlock:[271,7,1,""]},"mailbox.MMDFMessage":{add_flag:[271,7,1,""],get_flags:[271,7,1,""],get_from:[271,7,1,""],remove_flag:[271,7,1,""],set_flags:[271,7,1,""],set_from:[271,7,1,""]},"mailbox.Mailbox":{__contains__:[271,7,1,""],__delitem__:[271,7,1,""],__getitem__:[271,7,1,""],__iter__:[271,7,1,""],__len__:[271,7,1,""],__setitem__:[271,7,1,""],add:[271,7,1,""],clear:[271,7,1,""],close:[271,7,1,""],discard:[271,7,1,""],flush:[271,7,1,""],get:[271,7,1,""],get_bytes:[271,7,1,""],get_file:[271,7,1,""],get_message:[271,7,1,""],get_string:[271,7,1,""],items:[271,7,1,""],iteritems:[271,7,1,""],iterkeys:[271,7,1,""],itervalues:[271,7,1,""],keys:[271,7,1,""],lock:[271,7,1,""],pop:[271,7,1,""],popitem:[271,7,1,""],remove:[271,7,1,""],unlock:[271,7,1,""],update:[271,7,1,""],values:[271,7,1,""]},"mailbox.Maildir":{__setitem__:[271,7,1,""],add:[271,7,1,""],add_folder:[271,7,1,""],clean:[271,7,1,""],close:[271,7,1,""],flush:[271,7,1,""],get_file:[271,7,1,""],get_folder:[271,7,1,""],list_folders:[271,7,1,""],lock:[271,7,1,""],remove_folder:[271,7,1,""],unlock:[271,7,1,""],update:[271,7,1,""]},"mailbox.MaildirMessage":{add_flag:[271,7,1,""],get_date:[271,7,1,""],get_flags:[271,7,1,""],get_info:[271,7,1,""],get_subdir:[271,7,1,""],remove_flag:[271,7,1,""],set_date:[271,7,1,""],set_flags:[271,7,1,""],set_info:[271,7,1,""],set_subdir:[271,7,1,""]},"mailbox.mbox":{get_file:[271,7,1,""],lock:[271,7,1,""],unlock:[271,7,1,""]},"mailbox.mboxMessage":{add_flag:[271,7,1,""],get_flags:[271,7,1,""],get_from:[271,7,1,""],remove_flag:[271,7,1,""],set_flags:[271,7,1,""],set_from:[271,7,1,""]},"mimetypes.MimeTypes":{encodings_map:[276,6,1,""],guess_all_extensions:[276,7,1,""],guess_extension:[276,7,1,""],guess_type:[276,7,1,""],read:[276,7,1,""],read_windows_registry:[276,7,1,""],readfp:[276,7,1,""],suffix_map:[276,6,1,""],types_map:[276,6,1,""],types_map_inv:[276,6,1,""]},"mmap.mmap":{close:[279,7,1,""],closed:[279,6,1,""],find:[279,7,1,""],flush:[279,7,1,""],move:[279,7,1,""],read:[279,7,1,""],read_byte:[279,7,1,""],readline:[279,7,1,""],resize:[279,7,1,""],rfind:[279,7,1,""],seek:[279,7,1,""],size:[279,7,1,""],tell:[279,7,1,""],write:[279,7,1,""],write_byte:[279,7,1,""]},"modulefinder.ModuleFinder":{modules:[280,6,1,""],report:[280,7,1,""],run_script:[280,7,1,""]},"msilib.CAB":{append:[282,7,1,""],commit:[282,7,1,""]},"msilib.Control":{condition:[282,7,1,""],event:[282,7,1,""],mapping:[282,7,1,""]},"msilib.Database":{Close:[282,7,1,""],Commit:[282,7,1,""],GetSummaryInformation:[282,7,1,""],OpenView:[282,7,1,""]},"msilib.Dialog":{bitmap:[282,7,1,""],checkbox:[282,7,1,""],control:[282,7,1,""],line:[282,7,1,""],pushbutton:[282,7,1,""],radiogroup:[282,7,1,""],text:[282,7,1,""]},"msilib.Directory":{add_file:[282,7,1,""],glob:[282,7,1,""],remove_pyc:[282,7,1,""],start_component:[282,7,1,""]},"msilib.Feature":{set_current:[282,7,1,""]},"msilib.RadioButtonGroup":{add:[282,7,1,""]},"msilib.Record":{ClearData:[282,7,1,""],GetFieldCount:[282,7,1,""],GetInteger:[282,7,1,""],GetString:[282,7,1,""],SetInteger:[282,7,1,""],SetStream:[282,7,1,""],SetString:[282,7,1,""]},"msilib.SummaryInformation":{GetProperty:[282,7,1,""],GetPropertyCount:[282,7,1,""],Persist:[282,7,1,""],SetProperty:[282,7,1,""]},"msilib.View":{Close:[282,7,1,""],Execute:[282,7,1,""],Fetch:[282,7,1,""],GetColumnInfo:[282,7,1,""],Modify:[282,7,1,""]},"multiprocessing.JoinableQueue":{join:[284,7,1,""],task_done:[284,7,1,""]},"multiprocessing.Lock":{acquire:[284,7,1,""],release:[284,7,1,""]},"multiprocessing.Process":{authkey:[284,6,1,""],close:[284,7,1,""],daemon:[284,6,1,""],exitcode:[284,6,1,""],is_alive:[284,7,1,""],join:[284,7,1,""],kill:[284,7,1,""],name:[284,6,1,""],pid:[284,6,1,""],run:[284,7,1,""],sentinel:[284,6,1,""],start:[284,7,1,""],terminate:[284,7,1,""]},"multiprocessing.Queue":{cancel_join_thread:[284,7,1,""],close:[284,7,1,""],empty:[284,7,1,""],full:[284,7,1,""],get:[284,7,1,""],get_nowait:[284,7,1,""],join_thread:[284,7,1,""],put:[284,7,1,""],put_nowait:[284,7,1,""],qsize:[284,7,1,""]},"multiprocessing.RLock":{acquire:[284,7,1,""],release:[284,7,1,""]},"multiprocessing.SimpleQueue":{empty:[284,7,1,""],get:[284,7,1,""],put:[284,7,1,""]},"multiprocessing.connection":{Client:[284,10,1,""],Connection:[284,11,1,""],Listener:[284,11,1,""],answer_challenge:[284,10,1,""],deliver_challenge:[284,10,1,""],wait:[284,10,1,""]},"multiprocessing.connection.Connection":{close:[284,7,1,""],fileno:[284,7,1,""],poll:[284,7,1,""],recv:[284,7,1,""],recv_bytes:[284,7,1,""],recv_bytes_into:[284,7,1,""],send:[284,7,1,""],send_bytes:[284,7,1,""]},"multiprocessing.connection.Listener":{accept:[284,7,1,""],address:[284,6,1,""],close:[284,7,1,""],last_accepted:[284,6,1,""]},"multiprocessing.managers":{BaseManager:[284,11,1,""],BaseProxy:[284,11,1,""],Namespace:[284,11,1,""],SyncManager:[284,11,1,""]},"multiprocessing.managers.BaseManager":{address:[284,6,1,""],connect:[284,7,1,""],get_server:[284,7,1,""],register:[284,7,1,""],shutdown:[284,7,1,""],start:[284,7,1,""]},"multiprocessing.managers.BaseProxy":{__repr__:[284,7,1,""],__str__:[284,7,1,""],_callmethod:[284,7,1,""],_getvalue:[284,7,1,""]},"multiprocessing.managers.SyncManager":{Array:[284,7,1,""],Barrier:[284,7,1,""],BoundedSemaphore:[284,7,1,""],Condition:[284,7,1,""],Event:[284,7,1,""],Lock:[284,7,1,""],Namespace:[284,7,1,""],Queue:[284,7,1,""],RLock:[284,7,1,""],Semaphore:[284,7,1,""],Value:[284,7,1,""],dict:[284,7,1,""],list:[284,7,1,""]},"multiprocessing.pool":{AsyncResult:[284,11,1,""],Pool:[284,11,1,""]},"multiprocessing.pool.AsyncResult":{get:[284,7,1,""],ready:[284,7,1,""],successful:[284,7,1,""],wait:[284,7,1,""]},"multiprocessing.pool.Pool":{apply:[284,7,1,""],apply_async:[284,7,1,""],close:[284,7,1,""],imap:[284,7,1,""],imap_unordered:[284,7,1,""],join:[284,7,1,""],map:[284,7,1,""],map_async:[284,7,1,""],starmap:[284,7,1,""],starmap_async:[284,7,1,""],terminate:[284,7,1,""]},"multiprocessing.sharedctypes":{"synchronized":[284,10,1,""],Array:[284,10,1,""],RawArray:[284,10,1,""],RawValue:[284,10,1,""],Value:[284,10,1,""],copy:[284,10,1,""]},"multiprocessing.sharedctypes.multiprocessing":{Manager:[284,10,1,""]},"netrc.netrc":{__repr__:[286,7,1,""],authenticators:[286,7,1,""],hosts:[286,6,1,""],macros:[286,6,1,""]},"nntplib.NNTP":{article:[288,7,1,""],body:[288,7,1,""],date:[288,7,1,""],description:[288,7,1,""],descriptions:[288,7,1,""],getcapabilities:[288,7,1,""],getwelcome:[288,7,1,""],group:[288,7,1,""],head:[288,7,1,""],help:[288,7,1,""],ihave:[288,7,1,""],last:[288,7,1,""],list:[288,7,1,""],login:[288,7,1,""],newgroups:[288,7,1,""],newnews:[288,7,1,""],next:[288,7,1,""],nntp_implementation:[288,6,1,""],nntp_version:[288,6,1,""],over:[288,7,1,""],post:[288,7,1,""],quit:[288,7,1,""],set_debuglevel:[288,7,1,""],slave:[288,7,1,""],starttls:[288,7,1,""],stat:[288,7,1,""],xhdr:[288,7,1,""],xover:[288,7,1,""],xpath:[288,7,1,""]},"nntplib.NNTPError":{response:[288,6,1,""]},"numbers.Complex":{conjugate:[289,7,1,""],imag:[289,6,1,""],real:[289,6,1,""]},"numbers.Rational":{denominator:[289,6,1,""],numerator:[289,6,1,""]},"optparse.Option":{"const":[292,6,1,""],"default":[292,6,1,""],ACTIONS:[292,6,1,""],ALWAYS_TYPED_ACTIONS:[292,6,1,""],STORE_ACTIONS:[292,6,1,""],TYPED_ACTIONS:[292,6,1,""],TYPES:[292,6,1,""],TYPE_CHECKER:[292,6,1,""],action:[292,6,1,""],callback:[292,6,1,""],callback_args:[292,6,1,""],callback_kwargs:[292,6,1,""],choices:[292,6,1,""],dest:[292,6,1,""],help:[292,6,1,""],metavar:[292,6,1,""],nargs:[292,6,1,""],type:[292,6,1,""]},"optparse.OptionParser":{add_option:[292,7,1,""],disable_interspersed_args:[292,7,1,""],enable_interspersed_args:[292,7,1,""],get_option:[292,7,1,""],get_option_group:[292,7,1,""],get_usage:[292,7,1,""],get_version:[292,7,1,""],has_option:[292,7,1,""],print_usage:[292,7,1,""],print_version:[292,7,1,""],remove_option:[292,7,1,""],set_defaults:[292,7,1,""],set_usage:[292,7,1,""]},"os.DirEntry":{inode:[293,7,1,""],is_dir:[293,7,1,""],is_file:[293,7,1,""],is_symlink:[293,7,1,""],name:[293,6,1,""],path:[293,6,1,""],stat:[293,7,1,""]},"os.PathLike":{__fspath__:[293,7,1,""]},"os.path":{abspath:[294,10,1,""],basename:[294,10,1,""],commonpath:[294,10,1,""],commonprefix:[294,10,1,""],dirname:[294,10,1,""],exists:[294,10,1,""],expanduser:[294,10,1,""],expandvars:[294,10,1,""],getatime:[294,10,1,""],getctime:[294,10,1,""],getmtime:[294,10,1,""],getsize:[294,10,1,""],isabs:[294,10,1,""],isdir:[294,10,1,""],isfile:[294,10,1,""],islink:[294,10,1,""],ismount:[294,10,1,""],join:[294,10,1,""],lexists:[294,10,1,""],normcase:[294,10,1,""],normpath:[294,10,1,""],realpath:[294,10,1,""],relpath:[294,10,1,""],samefile:[294,10,1,""],sameopenfile:[294,10,1,""],samestat:[294,10,1,""],split:[294,10,1,""],splitdrive:[294,10,1,""],splitext:[294,10,1,""],supports_unicode_filenames:[294,8,1,""]},"os.scandir":{close:[293,7,1,""]},"os.sched_param":{sched_priority:[293,6,1,""]},"os.stat_result":{st_atime:[293,6,1,""],st_atime_ns:[293,6,1,""],st_birthtime:[293,6,1,""],st_blksize:[293,6,1,""],st_blocks:[293,6,1,""],st_creator:[293,6,1,""],st_ctime:[293,6,1,""],st_ctime_ns:[293,6,1,""],st_dev:[293,6,1,""],st_file_attributes:[293,6,1,""],st_flags:[293,6,1,""],st_fstype:[293,6,1,""],st_gen:[293,6,1,""],st_gid:[293,6,1,""],st_ino:[293,6,1,""],st_mode:[293,6,1,""],st_mtime:[293,6,1,""],st_mtime_ns:[293,6,1,""],st_nlink:[293,6,1,""],st_rdev:[293,6,1,""],st_rsize:[293,6,1,""],st_size:[293,6,1,""],st_type:[293,6,1,""],st_uid:[293,6,1,""]},"os.terminal_size":{columns:[293,6,1,""],lines:[293,6,1,""]},"ossaudiodev.oss_audio_device":{bufsize:[295,7,1,""],channels:[295,7,1,""],close:[295,7,1,""],closed:[295,6,1,""],fileno:[295,7,1,""],getfmts:[295,7,1,""],mode:[295,6,1,""],name:[295,6,1,""],nonblock:[295,7,1,""],obufcount:[295,7,1,""],obuffree:[295,7,1,""],post:[295,7,1,""],read:[295,7,1,""],reset:[295,7,1,""],setfmt:[295,7,1,""],setparameters:[295,7,1,""],speed:[295,7,1,""],sync:[295,7,1,""],write:[295,7,1,""],writeall:[295,7,1,""]},"ossaudiodev.oss_mixer_device":{close:[295,7,1,""],controls:[295,7,1,""],fileno:[295,7,1,""],get:[295,7,1,""],get_recsrc:[295,7,1,""],reccontrols:[295,7,1,""],set:[295,7,1,""],set_recsrc:[295,7,1,""],stereocontrols:[295,7,1,""]},"parser.ST":{compile:[297,7,1,""],isexpr:[297,7,1,""],issuite:[297,7,1,""],tolist:[297,7,1,""],totuple:[297,7,1,""]},"pathlib.Path":{chmod:[298,7,1,""],cwd:[298,12,1,""],exists:[298,7,1,""],expanduser:[298,7,1,""],glob:[298,7,1,""],group:[298,7,1,""],home:[298,12,1,""],is_block_device:[298,7,1,""],is_char_device:[298,7,1,""],is_dir:[298,7,1,""],is_fifo:[298,7,1,""],is_file:[298,7,1,""],is_mount:[298,7,1,""],is_socket:[298,7,1,""],is_symlink:[298,7,1,""],iterdir:[298,7,1,""],lchmod:[298,7,1,""],lstat:[298,7,1,""],mkdir:[298,7,1,""],open:[298,7,1,""],owner:[298,7,1,""],read_bytes:[298,7,1,""],read_text:[298,7,1,""],rename:[298,7,1,""],replace:[298,7,1,""],resolve:[298,7,1,""],rglob:[298,7,1,""],rmdir:[298,7,1,""],samefile:[298,7,1,""],stat:[298,7,1,""],symlink_to:[298,7,1,""],touch:[298,7,1,""],unlink:[298,7,1,""],write_bytes:[298,7,1,""],write_text:[298,7,1,""]},"pathlib.PurePath":{anchor:[298,8,1,""],as_posix:[298,7,1,""],as_uri:[298,7,1,""],drive:[298,8,1,""],is_absolute:[298,7,1,""],is_reserved:[298,7,1,""],joinpath:[298,7,1,""],match:[298,7,1,""],name:[298,8,1,""],parent:[298,8,1,""],parents:[298,8,1,""],parts:[298,8,1,""],relative_to:[298,7,1,""],root:[298,8,1,""],stem:[298,8,1,""],suffix:[298,8,1,""],suffixes:[298,8,1,""],with_name:[298,7,1,""],with_suffix:[298,7,1,""]},"pdb.Pdb":{run:[299,7,1,""],runcall:[299,7,1,""],runeval:[299,7,1,""],set_trace:[299,7,1,""]},"pickle.Pickler":{dispatch_table:[301,6,1,""],dump:[301,7,1,""],fast:[301,6,1,""],persistent_id:[301,7,1,""]},"pickle.Unpickler":{find_class:[301,7,1,""],load:[301,7,1,""],persistent_load:[301,7,1,""]},"pipes.Template":{append:[303,7,1,""],clone:[303,7,1,""],copy:[303,7,1,""],debug:[303,7,1,""],open:[303,7,1,""],prepend:[303,7,1,""],reset:[303,7,1,""]},"poplib.POP3":{apop:[307,7,1,""],capa:[307,7,1,""],dele:[307,7,1,""],getwelcome:[307,7,1,""],list:[307,7,1,""],noop:[307,7,1,""],pass_:[307,7,1,""],quit:[307,7,1,""],retr:[307,7,1,""],rpop:[307,7,1,""],rset:[307,7,1,""],set_debuglevel:[307,7,1,""],stat:[307,7,1,""],stls:[307,7,1,""],top:[307,7,1,""],uidl:[307,7,1,""],user:[307,7,1,""],utf8:[307,7,1,""]},"pprint.PrettyPrinter":{format:[309,7,1,""],isreadable:[309,7,1,""],isrecursive:[309,7,1,""],pformat:[309,7,1,""],pprint:[309,7,1,""]},"profile.Profile":{create_stats:[310,7,1,""],disable:[310,7,1,""],dump_stats:[310,7,1,""],enable:[310,7,1,""],print_stats:[310,7,1,""],run:[310,7,1,""],runcall:[310,7,1,""],runctx:[310,7,1,""]},"pstats.Stats":{add:[310,7,1,""],dump_stats:[310,7,1,""],print_callees:[310,7,1,""],print_callers:[310,7,1,""],print_stats:[310,7,1,""],reverse_order:[310,7,1,""],sort_stats:[310,7,1,""],strip_dirs:[310,7,1,""]},"py_compile.PycInvalidationMode":{CHECKED_HASH:[313,6,1,""],TIMESTAMP:[313,6,1,""],UNCHECKED_HASH:[313,6,1,""]},"pyclbr.Class":{"super":[314,6,1,""],children:[314,6,1,""],file:[314,6,1,""],lineno:[314,6,1,""],methods:[314,6,1,""],module:[314,6,1,""],name:[314,6,1,""],parent:[314,6,1,""]},"pyclbr.Function":{children:[314,6,1,""],file:[314,6,1,""],lineno:[314,6,1,""],module:[314,6,1,""],name:[314,6,1,""],parent:[314,6,1,""]},"python.function":{"return":[101,2,1,"c.python.function.return"],entry:[101,2,1,"c.python.function.entry"]},"queue.Queue":{empty:[318,7,1,""],full:[318,7,1,""],get:[318,7,1,""],get_nowait:[318,7,1,""],join:[318,7,1,""],put:[318,7,1,""],put_nowait:[318,7,1,""],qsize:[318,7,1,""],task_done:[318,7,1,""]},"queue.SimpleQueue":{empty:[318,7,1,""],get:[318,7,1,""],get_nowait:[318,7,1,""],put:[318,7,1,""],put_nowait:[318,7,1,""],qsize:[318,7,1,""]},"re.Match":{__getitem__:[321,7,1,""],end:[321,7,1,""],endpos:[321,6,1,""],expand:[321,7,1,""],group:[321,7,1,""],groupdict:[321,7,1,""],groups:[321,7,1,""],lastgroup:[321,6,1,""],lastindex:[321,6,1,""],pos:[321,6,1,""],re:[321,6,1,""],span:[321,7,1,""],start:[321,7,1,""],string:[321,6,1,""]},"re.Pattern":{findall:[321,7,1,""],finditer:[321,7,1,""],flags:[321,6,1,""],fullmatch:[321,7,1,""],groupindex:[321,6,1,""],groups:[321,6,1,""],match:[321,7,1,""],pattern:[321,6,1,""],search:[321,7,1,""],split:[321,7,1,""],sub:[321,7,1,""],subn:[321,7,1,""]},"re.error":{colno:[321,6,1,""],lineno:[321,6,1,""],msg:[321,6,1,""],pattern:[321,6,1,""],pos:[321,6,1,""]},"reprlib.Repr":{maxarray:[323,6,1,""],maxdeque:[323,6,1,""],maxdict:[323,6,1,""],maxfrozenset:[323,6,1,""],maxlevel:[323,6,1,""],maxlist:[323,6,1,""],maxlong:[323,6,1,""],maxother:[323,6,1,""],maxset:[323,6,1,""],maxstring:[323,6,1,""],maxtuple:[323,6,1,""],repr1:[323,7,1,""],repr:[323,7,1,""]},"rlcompleter.Completer":{complete:[325,7,1,""]},"sched.scheduler":{cancel:[327,7,1,""],empty:[327,7,1,""],enter:[327,7,1,""],enterabs:[327,7,1,""],queue:[327,6,1,""],run:[327,7,1,""]},"select.devpoll":{close:[329,7,1,""],closed:[329,6,1,""],fileno:[329,7,1,""],modify:[329,7,1,""],poll:[329,7,1,""],register:[329,7,1,""],unregister:[329,7,1,""]},"select.epoll":{close:[329,7,1,""],closed:[329,6,1,""],fileno:[329,7,1,""],fromfd:[329,7,1,""],modify:[329,7,1,""],poll:[329,7,1,""],register:[329,7,1,""],unregister:[329,7,1,""]},"select.kevent":{data:[329,6,1,""],fflags:[329,6,1,""],filter:[329,6,1,""],flags:[329,6,1,""],ident:[329,6,1,""],udata:[329,6,1,""]},"select.kqueue":{close:[329,7,1,""],closed:[329,6,1,""],control:[329,7,1,""],fileno:[329,7,1,""],fromfd:[329,7,1,""]},"select.poll":{modify:[329,7,1,""],poll:[329,7,1,""],register:[329,7,1,""],unregister:[329,7,1,""]},"selectors.BaseSelector":{close:[330,7,1,""],get_key:[330,7,1,""],get_map:[330,7,1,""],modify:[330,7,1,""],register:[330,7,1,""],select:[330,7,1,""],unregister:[330,7,1,""]},"selectors.DevpollSelector":{fileno:[330,7,1,""]},"selectors.EpollSelector":{fileno:[330,7,1,""]},"selectors.KqueueSelector":{fileno:[330,7,1,""]},"selectors.SelectorKey":{data:[330,6,1,""],events:[330,6,1,""],fd:[330,6,1,""],fileobj:[330,6,1,""]},"shelve.Shelf":{close:[331,7,1,""],sync:[331,7,1,""]},"shlex.shlex":{commenters:[332,6,1,""],debug:[332,6,1,""],eof:[332,6,1,""],error_leader:[332,7,1,""],escape:[332,6,1,""],escapedquotes:[332,6,1,""],get_token:[332,7,1,""],infile:[332,6,1,""],instream:[332,6,1,""],lineno:[332,6,1,""],pop_source:[332,7,1,""],punctuation_chars:[332,6,1,""],push_source:[332,7,1,""],push_token:[332,7,1,""],quotes:[332,6,1,""],read_token:[332,7,1,""],source:[332,6,1,""],sourcehook:[332,7,1,""],token:[332,6,1,""],whitespace:[332,6,1,""],whitespace_split:[332,6,1,""],wordchars:[332,6,1,""]},"shutil.rmtree":{avoids_symlink_attacks:[333,6,1,""]},"smtpd.SMTPChannel":{addr:[336,6,1,""],conn:[336,6,1,""],fqdn:[336,6,1,""],mailfrom:[336,6,1,""],peer:[336,6,1,""],rcpttos:[336,6,1,""],received_data:[336,6,1,""],received_lines:[336,6,1,""],seen_greeting:[336,6,1,""],smtp_server:[336,6,1,""],smtp_state:[336,6,1,""]},"smtpd.SMTPServer":{channel_class:[336,6,1,""],process_message:[336,7,1,""]},"smtplib.SMTP":{auth:[337,7,1,""],connect:[337,7,1,""],docmd:[337,7,1,""],ehlo:[337,7,1,""],ehlo_or_helo_if_needed:[337,7,1,""],has_extn:[337,7,1,""],helo:[337,7,1,""],login:[337,7,1,""],quit:[337,7,1,""],send_message:[337,7,1,""],sendmail:[337,7,1,""],set_debuglevel:[337,7,1,""],starttls:[337,7,1,""],verify:[337,7,1,""]},"socket.socket":{accept:[339,7,1,""],bind:[339,7,1,""],close:[339,7,1,""],connect:[339,7,1,""],connect_ex:[339,7,1,""],detach:[339,7,1,""],dup:[339,7,1,""],family:[339,6,1,""],fileno:[339,7,1,""],get_inheritable:[339,7,1,""],getblocking:[339,7,1,""],getpeername:[339,7,1,""],getsockname:[339,7,1,""],getsockopt:[339,7,1,""],gettimeout:[339,7,1,""],ioctl:[339,7,1,""],listen:[339,7,1,""],makefile:[339,7,1,""],proto:[339,6,1,""],recv:[339,7,1,""],recv_into:[339,7,1,""],recvfrom:[339,7,1,""],recvfrom_into:[339,7,1,""],recvmsg:[339,7,1,""],recvmsg_into:[339,7,1,""],send:[339,7,1,""],sendall:[339,7,1,""],sendfile:[339,7,1,""],sendmsg:[339,7,1,""],sendmsg_afalg:[339,7,1,""],sendto:[339,7,1,""],set_inheritable:[339,7,1,""],setblocking:[339,7,1,""],setsockopt:[339,7,1,""],settimeout:[339,7,1,""],share:[339,7,1,""],shutdown:[339,7,1,""],type:[339,6,1,""]},"socketserver.BaseRequestHandler":{finish:[340,7,1,""],handle:[340,7,1,""],setup:[340,7,1,""]},"socketserver.BaseServer":{RequestHandlerClass:[340,6,1,""],address_family:[340,6,1,""],allow_reuse_address:[340,6,1,""],fileno:[340,7,1,""],finish_request:[340,7,1,""],get_request:[340,7,1,""],handle_error:[340,7,1,""],handle_request:[340,7,1,""],handle_timeout:[340,7,1,""],process_request:[340,7,1,""],request_queue_size:[340,6,1,""],serve_forever:[340,7,1,""],server_activate:[340,7,1,""],server_address:[340,6,1,""],server_bind:[340,7,1,""],server_close:[340,7,1,""],service_actions:[340,7,1,""],shutdown:[340,7,1,""],socket:[340,6,1,""],socket_type:[340,6,1,""],timeout:[340,6,1,""],verify_request:[340,7,1,""]},"sqlite3.Connection":{backup:[342,7,1,""],close:[342,7,1,""],commit:[342,7,1,""],create_aggregate:[342,7,1,""],create_collation:[342,7,1,""],create_function:[342,7,1,""],cursor:[342,7,1,""],enable_load_extension:[342,7,1,""],execute:[342,7,1,""],executemany:[342,7,1,""],executescript:[342,7,1,""],in_transaction:[342,6,1,""],interrupt:[342,7,1,""],isolation_level:[342,6,1,""],iterdump:[342,7,1,""],load_extension:[342,7,1,""],rollback:[342,7,1,""],row_factory:[342,6,1,""],set_authorizer:[342,7,1,""],set_progress_handler:[342,7,1,""],set_trace_callback:[342,7,1,""],text_factory:[342,6,1,""],total_changes:[342,6,1,""]},"sqlite3.Cursor":{arraysize:[342,6,1,""],close:[342,7,1,""],connection:[342,6,1,""],description:[342,6,1,""],execute:[342,7,1,""],executemany:[342,7,1,""],executescript:[342,7,1,""],fetchall:[342,7,1,""],fetchmany:[342,7,1,""],fetchone:[342,7,1,""],lastrowid:[342,6,1,""],rowcount:[342,6,1,""]},"sqlite3.Row":{keys:[342,7,1,""]},"ssl.MemoryBIO":{eof:[343,6,1,""],pending:[343,6,1,""],read:[343,7,1,""],write:[343,7,1,""],write_eof:[343,7,1,""]},"ssl.Purpose":{CLIENT_AUTH:[343,8,1,""],SERVER_AUTH:[343,8,1,""]},"ssl.SSLCertVerificationError":{verify_code:[343,6,1,""],verify_message:[343,6,1,""]},"ssl.SSLContext":{cert_store_stats:[343,7,1,""],check_hostname:[343,6,1,""],get_ca_certs:[343,7,1,""],get_ciphers:[343,7,1,""],hostname_checks_common_name:[343,6,1,""],load_cert_chain:[343,7,1,""],load_default_certs:[343,7,1,""],load_dh_params:[343,7,1,""],load_verify_locations:[343,7,1,""],maximum_version:[343,6,1,""],minimum_version:[343,6,1,""],options:[343,6,1,""],post_handshake_auth:[343,6,1,""],protocol:[343,6,1,""],session_stats:[343,7,1,""],set_alpn_protocols:[343,7,1,""],set_ciphers:[343,7,1,""],set_default_verify_paths:[343,7,1,""],set_ecdh_curve:[343,7,1,""],set_npn_protocols:[343,7,1,""],set_servername_callback:[343,6,1,""],sni_callback:[343,6,1,""],sslobject_class:[343,6,1,""],sslsocket_class:[343,6,1,""],verify_flags:[343,6,1,""],verify_mode:[343,6,1,""],wrap_bio:[343,7,1,""],wrap_socket:[343,7,1,""]},"ssl.SSLError":{library:[343,6,1,""],reason:[343,6,1,""]},"ssl.SSLSession":{has_ticket:[343,6,1,""],id:[343,6,1,""],ticket_lifetime_hint:[343,6,1,""],time:[343,6,1,""],timeout:[343,6,1,""]},"ssl.SSLSocket":{cipher:[343,7,1,""],compression:[343,7,1,""],context:[343,6,1,""],do_handshake:[343,7,1,""],get_channel_binding:[343,7,1,""],getpeercert:[343,7,1,""],pending:[343,7,1,""],read:[343,7,1,""],selected_alpn_protocol:[343,7,1,""],selected_npn_protocol:[343,7,1,""],server_hostname:[343,6,1,""],server_side:[343,6,1,""],session:[343,6,1,""],session_reused:[343,6,1,""],shared_ciphers:[343,7,1,""],unwrap:[343,7,1,""],verify_client_post_handshake:[343,7,1,""],version:[343,7,1,""],write:[343,7,1,""]},"ssl.TLSVersion":{MAXIMUM_SUPPORTED:[343,6,1,""],MINIMUM_SUPPORTED:[343,6,1,""],SSLv3:[343,6,1,""],TLSv1:[343,6,1,""],TLSv1_1:[343,6,1,""],TLSv1_2:[343,6,1,""],TLSv1_3:[343,6,1,""]},"string.Formatter":{check_unused_args:[347,7,1,""],convert_field:[347,7,1,""],format:[347,7,1,""],format_field:[347,7,1,""],get_field:[347,7,1,""],get_value:[347,7,1,""],parse:[347,7,1,""],vformat:[347,7,1,""]},"string.Template":{safe_substitute:[347,7,1,""],substitute:[347,7,1,""],template:[347,6,1,""]},"struct.Struct":{format:[349,6,1,""],iter_unpack:[349,7,1,""],pack:[349,7,1,""],pack_into:[349,7,1,""],size:[349,6,1,""],unpack:[349,7,1,""],unpack_from:[349,7,1,""]},"subprocess.CalledProcessError":{cmd:[350,6,1,""],output:[350,6,1,""],returncode:[350,6,1,""],stderr:[350,6,1,""],stdout:[350,6,1,""]},"subprocess.CompletedProcess":{args:[350,6,1,""],check_returncode:[350,7,1,""],returncode:[350,6,1,""],stderr:[350,6,1,""],stdout:[350,6,1,""]},"subprocess.Popen":{args:[350,6,1,""],communicate:[350,7,1,""],kill:[350,7,1,""],pid:[350,6,1,""],poll:[350,7,1,""],returncode:[350,6,1,""],send_signal:[350,7,1,""],stderr:[350,6,1,""],stdin:[350,6,1,""],stdout:[350,6,1,""],terminate:[350,7,1,""],wait:[350,7,1,""]},"subprocess.STARTUPINFO":{dwFlags:[350,6,1,""],hStdError:[350,6,1,""],hStdInput:[350,6,1,""],hStdOutput:[350,6,1,""],lpAttributeList:[350,6,1,""],wShowWindow:[350,6,1,""]},"subprocess.TimeoutExpired":{cmd:[350,6,1,""],output:[350,6,1,""],stderr:[350,6,1,""],stdout:[350,6,1,""],timeout:[350,6,1,""]},"sunau.AU_read":{close:[351,7,1,""],getcompname:[351,7,1,""],getcomptype:[351,7,1,""],getframerate:[351,7,1,""],getmark:[351,7,1,""],getmarkers:[351,7,1,""],getnchannels:[351,7,1,""],getnframes:[351,7,1,""],getparams:[351,7,1,""],getsampwidth:[351,7,1,""],readframes:[351,7,1,""],rewind:[351,7,1,""],setpos:[351,7,1,""],tell:[351,7,1,""]},"sunau.AU_write":{close:[351,7,1,""],setcomptype:[351,7,1,""],setframerate:[351,7,1,""],setnchannels:[351,7,1,""],setnframes:[351,7,1,""],setparams:[351,7,1,""],setsampwidth:[351,7,1,""],tell:[351,7,1,""],writeframes:[351,7,1,""],writeframesraw:[351,7,1,""]},"symtable.Class":{get_methods:[354,7,1,""]},"symtable.Function":{get_frees:[354,7,1,""],get_globals:[354,7,1,""],get_locals:[354,7,1,""],get_parameters:[354,7,1,""]},"symtable.Symbol":{get_name:[354,7,1,""],get_namespace:[354,7,1,""],get_namespaces:[354,7,1,""],is_assigned:[354,7,1,""],is_declared_global:[354,7,1,""],is_free:[354,7,1,""],is_global:[354,7,1,""],is_imported:[354,7,1,""],is_local:[354,7,1,""],is_namespace:[354,7,1,""],is_parameter:[354,7,1,""],is_referenced:[354,7,1,""]},"symtable.SymbolTable":{get_children:[354,7,1,""],get_id:[354,7,1,""],get_identifiers:[354,7,1,""],get_lineno:[354,7,1,""],get_name:[354,7,1,""],get_symbols:[354,7,1,""],get_type:[354,7,1,""],has_children:[354,7,1,""],has_exec:[354,7,1,""],is_nested:[354,7,1,""],is_optimized:[354,7,1,""],lookup:[354,7,1,""]},"tarfile.TarFile":{add:[359,7,1,""],addfile:[359,7,1,""],close:[359,7,1,""],extract:[359,7,1,""],extractall:[359,7,1,""],extractfile:[359,7,1,""],getmember:[359,7,1,""],getmembers:[359,7,1,""],getnames:[359,7,1,""],gettarinfo:[359,7,1,""],list:[359,7,1,""],next:[359,7,1,""],open:[359,12,1,""],pax_headers:[359,6,1,""]},"tarfile.TarInfo":{frombuf:[359,12,1,""],fromtarfile:[359,12,1,""],gid:[359,6,1,""],gname:[359,6,1,""],isblk:[359,7,1,""],ischr:[359,7,1,""],isdev:[359,7,1,""],isdir:[359,7,1,""],isfifo:[359,7,1,""],isfile:[359,7,1,""],islnk:[359,7,1,""],isreg:[359,7,1,""],issym:[359,7,1,""],linkname:[359,6,1,""],mode:[359,6,1,""],mtime:[359,6,1,""],name:[359,6,1,""],pax_headers:[359,6,1,""],size:[359,6,1,""],tobuf:[359,7,1,""],type:[359,6,1,""],uid:[359,6,1,""],uname:[359,6,1,""]},"telnetlib.Telnet":{close:[360,7,1,""],expect:[360,7,1,""],fileno:[360,7,1,""],get_socket:[360,7,1,""],interact:[360,7,1,""],msg:[360,7,1,""],mt_interact:[360,7,1,""],open:[360,7,1,""],read_all:[360,7,1,""],read_eager:[360,7,1,""],read_lazy:[360,7,1,""],read_sb_data:[360,7,1,""],read_some:[360,7,1,""],read_until:[360,7,1,""],read_very_eager:[360,7,1,""],read_very_lazy:[360,7,1,""],set_debuglevel:[360,7,1,""],set_option_negotiation_callback:[360,7,1,""],write:[360,7,1,""]},"test.support":{BasicTestRunner:[363,11,1,""],CleanImport:[363,11,1,""],DirsOnSysPath:[363,11,1,""],EnvironmentVarGuard:[363,11,1,""],FS_NONASCII:[363,8,1,""],FakePath:[363,11,1,""],HAVE_DOCSTRINGS:[363,8,1,""],IPV6_ENABLED:[363,8,1,""],MAX_Py_ssize_t:[363,8,1,""],MISSING_C_DOCSTRINGS:[363,8,1,""],Matcher:[363,11,1,""],PGO:[363,8,1,""],PIPE_MAX_SIZE:[363,8,1,""],ResourceDenied:[363,5,1,""],SAVEDCWD:[363,8,1,""],SOCK_MAX_SIZE:[363,8,1,""],SaveSignals:[363,11,1,""],SuppressCrashReport:[363,11,1,""],TESTFN:[363,8,1,""],TESTFN_ENCODING:[363,8,1,""],TESTFN_NONASCII:[363,8,1,""],TESTFN_UNDECODABLE:[363,8,1,""],TESTFN_UNENCODABLE:[363,8,1,""],TESTFN_UNICODE:[363,8,1,""],TEST_DATA_DIR:[363,8,1,""],TEST_HOME_DIR:[363,8,1,""],TEST_HTTP_URL:[363,8,1,""],TEST_SUPPORT_DIR:[363,8,1,""],TestFailed:[363,5,1,""],TestHandler:[363,11,1,""],TransientResource:[363,11,1,""],WarningsRecorder:[363,11,1,""],anticipate_failure:[363,10,1,""],args_from_interpreter_flags:[363,10,1,""],bigaddrspacetest:[363,10,1,""],bigmemtest:[363,10,1,""],bind_port:[363,10,1,""],bind_unix_socket:[363,10,1,""],calcobjsize:[363,10,1,""],calcvobjsize:[363,10,1,""],can_symlink:[363,10,1,""],can_xattr:[363,10,1,""],captured_stderr:[363,10,1,""],captured_stdin:[363,10,1,""],captured_stdout:[363,10,1,""],change_cwd:[363,10,1,""],check__all__:[363,10,1,""],check_free_after_iterating:[363,10,1,""],check_impl_detail:[363,10,1,""],check_no_resource_warning:[363,10,1,""],check_syntax_error:[363,10,1,""],check_warnings:[363,10,1,""],checksizeof:[363,10,1,""],cpython_only:[363,10,1,""],create_empty_file:[363,10,1,""],detect_api_mismatch:[363,10,1,""],disable_faulthandler:[363,10,1,""],disable_gc:[363,10,1,""],fd_count:[363,10,1,""],find_unused_port:[363,10,1,""],findfile:[363,10,1,""],forget:[363,10,1,""],fs_is_case_insensitive:[363,10,1,""],gc_collect:[363,10,1,""],get_attribute:[363,10,1,""],get_original_stdout:[363,10,1,""],impl_detail:[363,10,1,""],import_fresh_module:[363,10,1,""],import_module:[363,10,1,""],is_android:[363,8,1,""],is_jython:[363,8,1,""],is_resource_enabled:[363,10,1,""],join_thread:[363,10,1,""],load_package_tests:[363,10,1,""],make_bad_fd:[363,10,1,""],make_legacy_pyc:[363,10,1,""],match_test:[363,10,1,""],max_memuse:[363,8,1,""],missing_compiler_executable:[363,10,1,""],modules_cleanup:[363,10,1,""],modules_setup:[363,10,1,""],no_tracing:[363,10,1,""],open_urlresource:[363,10,1,""],optim_args_from_interpreter_flags:[363,10,1,""],patch:[363,10,1,""],python_is_optimized:[363,10,1,""],real_max_memuse:[363,8,1,""],reap_children:[363,10,1,""],reap_threads:[363,10,1,""],record_original_stdout:[363,10,1,""],refcount_test:[363,10,1,""],requires:[363,10,1,""],requires_IEEE_754:[363,10,1,""],requires_bz2:[363,10,1,""],requires_docstrings:[363,10,1,""],requires_freebsd_version:[363,10,1,""],requires_gzip:[363,10,1,""],requires_linux_version:[363,10,1,""],requires_lzma:[363,10,1,""],requires_mac_version:[363,10,1,""],requires_resource:[363,10,1,""],requires_zlib:[363,10,1,""],rmdir:[363,10,1,""],rmtree:[363,10,1,""],run_doctest:[363,10,1,""],run_in_subinterp:[363,10,1,""],run_unittest:[363,10,1,""],run_with_locale:[363,10,1,""],run_with_tz:[363,10,1,""],script_helper:[363,9,0,"-"],set_match_tests:[363,10,1,""],set_memlimit:[363,10,1,""],setswitchinterval:[363,10,1,""],skip_unless_bind_unix_socket:[363,10,1,""],skip_unless_symlink:[363,10,1,""],skip_unless_xattr:[363,10,1,""],sortdict:[363,10,1,""],start_threads:[363,10,1,""],strip_python_strerr:[363,10,1,""],swap_attr:[363,10,1,""],swap_item:[363,10,1,""],system_must_validate_cert:[363,10,1,""],temp_cwd:[363,10,1,""],temp_dir:[363,10,1,""],temp_umask:[363,10,1,""],threading_cleanup:[363,10,1,""],threading_setup:[363,10,1,""],transient_internet:[363,10,1,""],unix_shell:[363,8,1,""],unlink:[363,10,1,""],unload:[363,10,1,""],verbose:[363,8,1,""],wait_threads_exit:[363,10,1,""],with_pymalloc:[363,10,1,""]},"test.support.BasicTestRunner":{run:[363,7,1,""]},"test.support.EnvironmentVarGuard":{set:[363,7,1,""],unset:[363,7,1,""]},"test.support.Matcher":{match_value:[363,7,1,""],matches:[363,7,1,""]},"test.support.script_helper":{assert_python_failure:[363,10,1,""],assert_python_ok:[363,10,1,""],interpreter_requires_environment:[363,10,1,""],kill_python:[363,10,1,""],make_pkg:[363,10,1,""],make_script:[363,10,1,""],make_zip_pkg:[363,10,1,""],make_zip_script:[363,10,1,""],run_python_until_end:[363,10,1,""],spawn_python:[363,10,1,""]},"textwrap.TextWrapper":{break_long_words:[365,6,1,""],break_on_hyphens:[365,6,1,""],drop_whitespace:[365,6,1,""],expand_tabs:[365,6,1,""],fill:[365,7,1,""],fix_sentence_endings:[365,6,1,""],initial_indent:[365,6,1,""],max_lines:[365,6,1,""],placeholder:[365,6,1,""],replace_whitespace:[365,6,1,""],subsequent_indent:[365,6,1,""],tabsize:[365,6,1,""],width:[365,6,1,""],wrap:[365,7,1,""]},"threading.Barrier":{abort:[366,7,1,""],broken:[366,6,1,""],n_waiting:[366,6,1,""],parties:[366,6,1,""],reset:[366,7,1,""],wait:[366,7,1,""]},"threading.Condition":{acquire:[366,7,1,""],notify:[366,7,1,""],notify_all:[366,7,1,""],release:[366,7,1,""],wait:[366,7,1,""],wait_for:[366,7,1,""]},"threading.Event":{clear:[366,7,1,""],is_set:[366,7,1,""],set:[366,7,1,""],wait:[366,7,1,""]},"threading.Lock":{acquire:[366,7,1,""],release:[366,7,1,""]},"threading.RLock":{acquire:[366,7,1,""],release:[366,7,1,""]},"threading.Semaphore":{acquire:[366,7,1,""],release:[366,7,1,""]},"threading.Thread":{daemon:[366,6,1,""],getName:[366,7,1,""],ident:[366,6,1,""],isDaemon:[366,7,1,""],is_alive:[366,7,1,""],join:[366,7,1,""],name:[366,6,1,""],run:[366,7,1,""],setDaemon:[366,7,1,""],setName:[366,7,1,""],start:[366,7,1,""]},"threading.Timer":{cancel:[366,7,1,""]},"timeit.Timer":{autorange:[368,7,1,""],print_exc:[368,7,1,""],repeat:[368,7,1,""],timeit:[368,7,1,""]},"tkinter.Widget.tk":{createfilehandler:[370,7,1,""],deletefilehandler:[370,7,1,""]},"tkinter.scrolledtext.ScrolledText":{frame:[371,6,1,""],vbar:[371,6,1,""]},"tkinter.tix":{Balloon:[372,11,1,""],ButtonBox:[372,11,1,""],CheckList:[372,11,1,""],ComboBox:[372,11,1,""],Control:[372,11,1,""],DirList:[372,11,1,""],DirSelectBox:[372,11,1,""],DirSelectDialog:[372,11,1,""],DirTree:[372,11,1,""],ExFileSelectBox:[372,11,1,""],FileEntry:[372,11,1,""],FileSelectBox:[372,11,1,""],Form:[372,11,1,""],HList:[372,11,1,""],InputOnly:[372,11,1,""],LabelEntry:[372,11,1,""],LabelFrame:[372,11,1,""],ListNoteBook:[372,11,1,""],Meter:[372,11,1,""],NoteBook:[372,11,1,""],OptionMenu:[372,11,1,""],PanedWindow:[372,11,1,""],PopupMenu:[372,11,1,""],Select:[372,11,1,""],StdButtonBox:[372,11,1,""],TList:[372,11,1,""],Tk:[372,11,1,""],Tree:[372,11,1,""],tixCommand:[372,11,1,""]},"tkinter.tix.tixCommand":{tix_addbitmapdir:[372,7,1,""],tix_cget:[372,7,1,""],tix_configure:[372,7,1,""],tix_filedialog:[372,7,1,""],tix_getbitmap:[372,7,1,""],tix_getimage:[372,7,1,""],tix_option_get:[372,7,1,""],tix_resetoptions:[372,7,1,""]},"tkinter.ttk":{Combobox:[373,11,1,""],Notebook:[373,11,1,""],Progressbar:[373,11,1,""],Spinbox:[373,11,1,""],Style:[373,11,1,""],Treeview:[373,11,1,""],Widget:[373,11,1,""]},"tkinter.ttk.Combobox":{current:[373,7,1,""],get:[373,7,1,""],set:[373,7,1,""]},"tkinter.ttk.Notebook":{add:[373,7,1,""],enable_traversal:[373,7,1,""],forget:[373,7,1,""],hide:[373,7,1,""],identify:[373,7,1,""],index:[373,7,1,""],insert:[373,7,1,""],select:[373,7,1,""],tab:[373,7,1,""],tabs:[373,7,1,""]},"tkinter.ttk.Progressbar":{start:[373,7,1,""],step:[373,7,1,""],stop:[373,7,1,""]},"tkinter.ttk.Spinbox":{get:[373,7,1,""],set:[373,7,1,""]},"tkinter.ttk.Style":{configure:[373,7,1,""],element_create:[373,7,1,""],element_names:[373,7,1,""],element_options:[373,7,1,""],layout:[373,7,1,""],lookup:[373,7,1,""],map:[373,7,1,""],theme_create:[373,7,1,""],theme_names:[373,7,1,""],theme_settings:[373,7,1,""],theme_use:[373,7,1,""]},"tkinter.ttk.Treeview":{"delete":[373,7,1,""],bbox:[373,7,1,""],column:[373,7,1,""],detach:[373,7,1,""],exists:[373,7,1,""],focus:[373,7,1,""],get_children:[373,7,1,""],heading:[373,7,1,""],identify:[373,7,1,""],identify_column:[373,7,1,""],identify_element:[373,7,1,""],identify_region:[373,7,1,""],identify_row:[373,7,1,""],index:[373,7,1,""],insert:[373,7,1,""],item:[373,7,1,""],move:[373,7,1,""],next:[373,7,1,""],parent:[373,7,1,""],prev:[373,7,1,""],reattach:[373,7,1,""],see:[373,7,1,""],selection:[373,7,1,""],selection_add:[373,7,1,""],selection_remove:[373,7,1,""],selection_set:[373,7,1,""],selection_toggle:[373,7,1,""],set:[373,7,1,""],set_children:[373,7,1,""],tag_bind:[373,7,1,""],tag_configure:[373,7,1,""],tag_has:[373,7,1,""],xview:[373,7,1,""],yview:[373,7,1,""]},"tkinter.ttk.Widget":{identify:[373,7,1,""],instate:[373,7,1,""],state:[373,7,1,""]},"trace.CoverageResults":{update:[376,7,1,""],write_results:[376,7,1,""]},"trace.Trace":{results:[376,7,1,""],run:[376,7,1,""],runctx:[376,7,1,""],runfunc:[376,7,1,""]},"traceback.StackSummary":{extract:[377,12,1,""],format:[377,7,1,""],from_list:[377,12,1,""]},"traceback.TracebackException":{__cause__:[377,6,1,""],__context__:[377,6,1,""],__suppress_context__:[377,6,1,""],exc_type:[377,6,1,""],filename:[377,6,1,""],format:[377,7,1,""],format_exception_only:[377,7,1,""],from_exception:[377,12,1,""],lineno:[377,6,1,""],msg:[377,6,1,""],offset:[377,6,1,""],stack:[377,6,1,""],text:[377,6,1,""]},"tracemalloc.DomainFilter":{domain:[378,6,1,""],inclusive:[378,6,1,""]},"tracemalloc.Filter":{all_frames:[378,6,1,""],domain:[378,6,1,""],filename_pattern:[378,6,1,""],inclusive:[378,6,1,""],lineno:[378,6,1,""]},"tracemalloc.Frame":{filename:[378,6,1,""],lineno:[378,6,1,""]},"tracemalloc.Snapshot":{compare_to:[378,7,1,""],dump:[378,7,1,""],filter_traces:[378,7,1,""],load:[378,12,1,""],statistics:[378,7,1,""],traceback_limit:[378,6,1,""],traces:[378,6,1,""]},"tracemalloc.Statistic":{count:[378,6,1,""],size:[378,6,1,""],traceback:[378,6,1,""]},"tracemalloc.StatisticDiff":{count:[378,6,1,""],count_diff:[378,6,1,""],size:[378,6,1,""],size_diff:[378,6,1,""],traceback:[378,6,1,""]},"tracemalloc.Trace":{domain:[378,6,1,""],size:[378,6,1,""],traceback:[378,6,1,""]},"tracemalloc.Traceback":{format:[378,7,1,""]},"turtle.Shape":{addcomponent:[380,7,1,""]},"types.MappingProxyType":{copy:[381,7,1,""],get:[381,7,1,""],items:[381,7,1,""],keys:[381,7,1,""],values:[381,7,1,""]},"types.ModuleType":{__doc__:[381,6,1,""],__loader__:[381,6,1,""],__name__:[381,6,1,""],__package__:[381,6,1,""]},"unittest-discover":{"--pattern":[385,15,1,"cmdoption-unittest-discover-p"],"--start-directory":[385,15,1,"cmdoption-unittest-discover-s"],"--top-level-directory":[385,15,1,"cmdoption-unittest-discover-t"],"--verbose":[385,15,1,"cmdoption-unittest-discover-v"],"-p":[385,15,1,"cmdoption-unittest-discover-p"],"-s":[385,15,1,"cmdoption-unittest-discover-s"],"-t":[385,15,1,"cmdoption-unittest-discover-t"],"-v":[385,15,1,"cmdoption-unittest-discover-v"]},"unittest.TestCase":{addCleanup:[385,7,1,""],addTypeEqualityFunc:[385,7,1,""],assertAlmostEqual:[385,7,1,""],assertCountEqual:[385,7,1,""],assertDictEqual:[385,7,1,""],assertEqual:[385,7,1,""],assertFalse:[385,7,1,""],assertGreater:[385,7,1,""],assertGreaterEqual:[385,7,1,""],assertIn:[385,7,1,""],assertIs:[385,7,1,""],assertIsInstance:[385,7,1,""],assertIsNone:[385,7,1,""],assertIsNot:[385,7,1,""],assertIsNotNone:[385,7,1,""],assertLess:[385,7,1,""],assertLessEqual:[385,7,1,""],assertListEqual:[385,7,1,""],assertLogs:[385,7,1,""],assertMultiLineEqual:[385,7,1,""],assertNotAlmostEqual:[385,7,1,""],assertNotEqual:[385,7,1,""],assertNotIn:[385,7,1,""],assertNotIsInstance:[385,7,1,""],assertNotRegex:[385,7,1,""],assertRaises:[385,7,1,""],assertRaisesRegex:[385,7,1,""],assertRegex:[385,7,1,""],assertSequenceEqual:[385,7,1,""],assertSetEqual:[385,7,1,""],assertTrue:[385,7,1,""],assertTupleEqual:[385,7,1,""],assertWarns:[385,7,1,""],assertWarnsRegex:[385,7,1,""],countTestCases:[385,7,1,""],debug:[385,7,1,""],defaultTestResult:[385,7,1,""],doCleanups:[385,7,1,""],fail:[385,7,1,""],failureException:[385,6,1,""],id:[385,7,1,""],longMessage:[385,6,1,""],maxDiff:[385,6,1,""],output:[385,6,1,""],records:[385,6,1,""],run:[385,7,1,""],setUp:[385,7,1,""],setUpClass:[385,7,1,""],shortDescription:[385,7,1,""],skipTest:[385,7,1,""],subTest:[385,7,1,""],tearDown:[385,7,1,""],tearDownClass:[385,7,1,""]},"unittest.TestLoader":{discover:[385,7,1,""],errors:[385,6,1,""],getTestCaseNames:[385,7,1,""],loadTestsFromModule:[385,7,1,""],loadTestsFromName:[385,7,1,""],loadTestsFromNames:[385,7,1,""],loadTestsFromTestCase:[385,7,1,""],sortTestMethodsUsing:[385,6,1,""],suiteClass:[385,6,1,""],testMethodPrefix:[385,6,1,""],testNamePatterns:[385,6,1,""]},"unittest.TestResult":{addError:[385,7,1,""],addExpectedFailure:[385,7,1,""],addFailure:[385,7,1,""],addSkip:[385,7,1,""],addSubTest:[385,7,1,""],addSuccess:[385,7,1,""],addUnexpectedSuccess:[385,7,1,""],buffer:[385,6,1,""],errors:[385,6,1,""],expectedFailures:[385,6,1,""],failfast:[385,6,1,""],failures:[385,6,1,""],shouldStop:[385,6,1,""],skipped:[385,6,1,""],startTest:[385,7,1,""],startTestRun:[385,7,1,""],stop:[385,7,1,""],stopTest:[385,7,1,""],stopTestRun:[385,7,1,""],tb_locals:[385,6,1,""],testsRun:[385,6,1,""],unexpectedSuccesses:[385,6,1,""],wasSuccessful:[385,7,1,""]},"unittest.TestSuite":{__iter__:[385,7,1,""],addTest:[385,7,1,""],addTests:[385,7,1,""],countTestCases:[385,7,1,""],debug:[385,7,1,""],run:[385,7,1,""]},"unittest.TextTestRunner":{_makeResult:[385,7,1,""],run:[385,7,1,""]},"unittest.mock":{ANY:[386,8,1,""],DEFAULT:[386,8,1,""],FILTER_DIR:[386,8,1,""],MagicMock:[386,11,1,""],Mock:[386,11,1,""],NonCallableMagicMock:[386,11,1,""],NonCallableMock:[386,11,1,""],PropertyMock:[386,11,1,""],call:[386,10,1,""],create_autospec:[386,10,1,""],mock_open:[386,10,1,""],patch:[386,10,1,""],seal:[386,10,1,""],sentinel:[386,8,1,""]},"unittest.mock.Mock":{__class__:[386,6,1,""],__dir__:[386,7,1,""],_get_child_mock:[386,7,1,""],assert_any_call:[386,7,1,""],assert_called:[386,7,1,""],assert_called_once:[386,7,1,""],assert_called_once_with:[386,7,1,""],assert_called_with:[386,7,1,""],assert_has_calls:[386,7,1,""],assert_not_called:[386,7,1,""],attach_mock:[386,7,1,""],call_args:[386,6,1,""],call_args_list:[386,6,1,""],call_count:[386,6,1,""],called:[386,6,1,""],configure_mock:[386,7,1,""],method_calls:[386,6,1,""],mock_add_spec:[386,7,1,""],mock_calls:[386,6,1,""],reset_mock:[386,7,1,""],return_value:[386,6,1,""],side_effect:[386,6,1,""]},"unittest.mock.call":{call_list:[386,7,1,""]},"unittest.mock.patch":{dict:[386,10,1,""],multiple:[386,10,1,""],object:[386,10,1,""],stopall:[386,10,1,""]},"urllib.error":{ContentTooShortError:[390,5,1,""],HTTPError:[390,5,1,""],URLError:[390,5,1,""]},"urllib.error.HTTPError":{code:[390,6,1,""],headers:[390,6,1,""],reason:[390,6,1,""]},"urllib.error.URLError":{reason:[390,6,1,""]},"urllib.parse":{DefragResult:[391,11,1,""],DefragResultBytes:[391,11,1,""],ParseResult:[391,11,1,""],ParseResultBytes:[391,11,1,""],SplitResult:[391,11,1,""],SplitResultBytes:[391,11,1,""],parse_qs:[391,10,1,""],parse_qsl:[391,10,1,""],quote:[391,10,1,""],quote_from_bytes:[391,10,1,""],quote_plus:[391,10,1,""],unquote:[391,10,1,""],unquote_plus:[391,10,1,""],unquote_to_bytes:[391,10,1,""],urldefrag:[391,10,1,""],urlencode:[391,10,1,""],urljoin:[391,10,1,""],urlparse:[391,10,1,""],urlsplit:[391,10,1,""],urlunparse:[391,10,1,""],urlunsplit:[391,10,1,""]},"urllib.parse.urllib.parse.SplitResult":{geturl:[391,7,1,""]},"urllib.request":{AbstractBasicAuthHandler:[392,11,1,""],AbstractDigestAuthHandler:[392,11,1,""],BaseHandler:[392,11,1,""],CacheFTPHandler:[392,11,1,""],DataHandler:[392,11,1,""],FTPHandler:[392,11,1,""],FancyURLopener:[392,11,1,""],FileHandler:[392,11,1,""],HTTPBasicAuthHandler:[392,11,1,""],HTTPCookieProcessor:[392,11,1,""],HTTPDefaultErrorHandler:[392,11,1,""],HTTPDigestAuthHandler:[392,11,1,""],HTTPErrorProcessor:[392,11,1,""],HTTPHandler:[392,11,1,""],HTTPPasswordMgr:[392,11,1,""],HTTPPasswordMgrWithDefaultRealm:[392,11,1,""],HTTPPasswordMgrWithPriorAuth:[392,11,1,""],HTTPRedirectHandler:[392,11,1,""],HTTPSHandler:[392,11,1,""],OpenerDirector:[392,11,1,""],ProxyBasicAuthHandler:[392,11,1,""],ProxyDigestAuthHandler:[392,11,1,""],ProxyHandler:[392,11,1,""],Request:[392,11,1,""],URLopener:[392,11,1,""],UnknownHandler:[392,11,1,""],build_opener:[392,10,1,""],getproxies:[392,10,1,""],install_opener:[392,10,1,""],pathname2url:[392,10,1,""],url2pathname:[392,10,1,""],urlcleanup:[392,10,1,""],urlopen:[392,10,1,""],urlretrieve:[392,10,1,""]},"urllib.request.AbstractBasicAuthHandler":{http_error_auth_reqed:[392,7,1,""]},"urllib.request.AbstractDigestAuthHandler":{http_error_auth_reqed:[392,7,1,""]},"urllib.request.BaseHandler":{add_parent:[392,7,1,""],close:[392,7,1,""],default_open:[392,7,1,""],http_error_default:[392,7,1,""],parent:[392,6,1,""],unknown_open:[392,7,1,""]},"urllib.request.CacheFTPHandler":{setMaxConns:[392,7,1,""],setTimeout:[392,7,1,""]},"urllib.request.DataHandler":{data_open:[392,7,1,""]},"urllib.request.FTPHandler":{ftp_open:[392,7,1,""]},"urllib.request.FancyURLopener":{prompt_user_passwd:[392,7,1,""]},"urllib.request.FileHandler":{file_open:[392,7,1,""]},"urllib.request.HTTPBasicAuthHandler":{http_error_401:[392,7,1,""]},"urllib.request.HTTPCookieProcessor":{cookiejar:[392,6,1,""]},"urllib.request.HTTPDigestAuthHandler":{http_error_401:[392,7,1,""]},"urllib.request.HTTPErrorProcessor":{http_response:[392,7,1,""],https_response:[392,7,1,""]},"urllib.request.HTTPHandler":{http_open:[392,7,1,""]},"urllib.request.HTTPPasswordMgr":{add_password:[392,7,1,""],find_user_password:[392,7,1,""]},"urllib.request.HTTPPasswordMgrWithPriorAuth":{add_password:[392,7,1,""],is_authenticated:[392,7,1,""],update_authenticated:[392,7,1,""]},"urllib.request.HTTPRedirectHandler":{http_error_301:[392,7,1,""],http_error_302:[392,7,1,""],http_error_303:[392,7,1,""],http_error_307:[392,7,1,""],redirect_request:[392,7,1,""]},"urllib.request.HTTPSHandler":{https_open:[392,7,1,""]},"urllib.request.OpenerDirector":{add_handler:[392,7,1,""],error:[392,7,1,""],open:[392,7,1,""]},"urllib.request.ProxyBasicAuthHandler":{http_error_407:[392,7,1,""]},"urllib.request.ProxyDigestAuthHandler":{http_error_407:[392,7,1,""]},"urllib.request.Request":{add_header:[392,7,1,""],add_unredirected_header:[392,7,1,""],data:[392,6,1,""],full_url:[392,6,1,""],get_full_url:[392,7,1,""],get_header:[392,7,1,""],get_method:[392,7,1,""],has_header:[392,7,1,""],header_items:[392,7,1,""],host:[392,6,1,""],method:[392,6,1,""],origin_req_host:[392,6,1,""],remove_header:[392,7,1,""],selector:[392,6,1,""],set_proxy:[392,7,1,""],type:[392,6,1,""],unverifiable:[392,6,1,""]},"urllib.request.URLopener":{open:[392,7,1,""],open_unknown:[392,7,1,""],retrieve:[392,7,1,""],version:[392,6,1,""]},"urllib.request.UnknownHandler":{unknown_open:[392,7,1,""]},"urllib.robotparser":{RobotFileParser:[393,11,1,""]},"urllib.robotparser.RobotFileParser":{can_fetch:[393,7,1,""],crawl_delay:[393,7,1,""],modified:[393,7,1,""],mtime:[393,7,1,""],parse:[393,7,1,""],read:[393,7,1,""],request_rate:[393,7,1,""],set_url:[393,7,1,""]},"uuid.SafeUUID":{safe:[395,6,1,""],unknown:[395,6,1,""],unsafe:[395,6,1,""]},"uuid.UUID":{"int":[395,6,1,""],bytes:[395,6,1,""],bytes_le:[395,6,1,""],fields:[395,6,1,""],hex:[395,6,1,""],is_safe:[395,6,1,""],urn:[395,6,1,""],variant:[395,6,1,""],version:[395,6,1,""]},"venv.EnvBuilder":{create:[396,7,1,""],create_configuration:[396,7,1,""],ensure_directories:[396,7,1,""],install_scripts:[396,7,1,""],post_setup:[396,7,1,""],setup_python:[396,7,1,""],setup_scripts:[396,7,1,""]},"wave.Wave_read":{close:[398,7,1,""],getcompname:[398,7,1,""],getcomptype:[398,7,1,""],getframerate:[398,7,1,""],getmark:[398,7,1,""],getmarkers:[398,7,1,""],getnchannels:[398,7,1,""],getnframes:[398,7,1,""],getparams:[398,7,1,""],getsampwidth:[398,7,1,""],readframes:[398,7,1,""],rewind:[398,7,1,""],setpos:[398,7,1,""],tell:[398,7,1,""]},"wave.Wave_write":{close:[398,7,1,""],setcomptype:[398,7,1,""],setframerate:[398,7,1,""],setnchannels:[398,7,1,""],setnframes:[398,7,1,""],setparams:[398,7,1,""],setsampwidth:[398,7,1,""],tell:[398,7,1,""],writeframes:[398,7,1,""],writeframesraw:[398,7,1,""]},"weakref.WeakKeyDictionary":{keyrefs:[399,7,1,""]},"weakref.WeakValueDictionary":{valuerefs:[399,7,1,""]},"weakref.finalize":{__call__:[399,7,1,""],alive:[399,6,1,""],atexit:[399,6,1,""],detach:[399,7,1,""],peek:[399,7,1,""]},"weakref.ref":{__callback__:[399,6,1,""]},"webbrowser.controller":{open:[400,7,1,""],open_new:[400,7,1,""],open_new_tab:[400,7,1,""]},"winreg.PyHKEY":{Close:[402,7,1,""],Detach:[402,7,1,""],__enter__:[402,7,1,""],__exit__:[402,7,1,""]},"wsgiref.handlers":{BaseCGIHandler:[404,11,1,""],BaseHandler:[404,11,1,""],CGIHandler:[404,11,1,""],IISCGIHandler:[404,11,1,""],SimpleHandler:[404,11,1,""],read_environ:[404,10,1,""]},"wsgiref.handlers.BaseHandler":{_flush:[404,7,1,""],_write:[404,7,1,""],add_cgi_vars:[404,7,1,""],error_body:[404,6,1,""],error_headers:[404,6,1,""],error_output:[404,7,1,""],error_status:[404,6,1,""],get_scheme:[404,7,1,""],get_stderr:[404,7,1,""],get_stdin:[404,7,1,""],http_version:[404,6,1,""],log_exception:[404,7,1,""],origin_server:[404,6,1,""],os_environ:[404,6,1,""],run:[404,7,1,""],sendfile:[404,7,1,""],server_software:[404,6,1,""],setup_environ:[404,7,1,""],traceback_limit:[404,6,1,""],wsgi_file_wrapper:[404,6,1,""],wsgi_multiprocess:[404,6,1,""],wsgi_multithread:[404,6,1,""],wsgi_run_once:[404,6,1,""]},"wsgiref.headers":{Headers:[404,11,1,""]},"wsgiref.headers.Headers":{add_header:[404,7,1,""],get_all:[404,7,1,""]},"wsgiref.simple_server":{WSGIRequestHandler:[404,11,1,""],WSGIServer:[404,11,1,""],demo_app:[404,10,1,""],make_server:[404,10,1,""]},"wsgiref.simple_server.WSGIRequestHandler":{get_environ:[404,7,1,""],get_stderr:[404,7,1,""],handle:[404,7,1,""]},"wsgiref.simple_server.WSGIServer":{get_app:[404,7,1,""],set_app:[404,7,1,""]},"wsgiref.util":{FileWrapper:[404,11,1,""],application_uri:[404,10,1,""],guess_scheme:[404,10,1,""],is_hop_by_hop:[404,10,1,""],request_uri:[404,10,1,""],setup_testing_defaults:[404,10,1,""],shift_path_info:[404,10,1,""]},"wsgiref.validate":{validator:[404,10,1,""]},"xdrlib.Packer":{get_buffer:[405,7,1,""],pack_array:[405,7,1,""],pack_bytes:[405,7,1,""],pack_double:[405,7,1,""],pack_farray:[405,7,1,""],pack_float:[405,7,1,""],pack_fopaque:[405,7,1,""],pack_fstring:[405,7,1,""],pack_list:[405,7,1,""],pack_opaque:[405,7,1,""],pack_string:[405,7,1,""],reset:[405,7,1,""]},"xdrlib.Unpacker":{done:[405,7,1,""],get_buffer:[405,7,1,""],get_position:[405,7,1,""],reset:[405,7,1,""],set_position:[405,7,1,""],unpack_array:[405,7,1,""],unpack_bytes:[405,7,1,""],unpack_double:[405,7,1,""],unpack_farray:[405,7,1,""],unpack_float:[405,7,1,""],unpack_fopaque:[405,7,1,""],unpack_fstring:[405,7,1,""],unpack_list:[405,7,1,""],unpack_opaque:[405,7,1,""],unpack_string:[405,7,1,""]},"xml.dom":{DOMException:[407,5,1,""],DomstringSizeErr:[407,5,1,""],EMPTY_NAMESPACE:[407,8,1,""],HierarchyRequestErr:[407,5,1,""],IndexSizeErr:[407,5,1,""],InuseAttributeErr:[407,5,1,""],InvalidAccessErr:[407,5,1,""],InvalidCharacterErr:[407,5,1,""],InvalidModificationErr:[407,5,1,""],InvalidStateErr:[407,5,1,""],NamespaceErr:[407,5,1,""],NoDataAllowedErr:[407,5,1,""],NoModificationAllowedErr:[407,5,1,""],NotFoundErr:[407,5,1,""],NotSupportedErr:[407,5,1,""],SyntaxErr:[407,5,1,""],WrongDocumentErr:[407,5,1,""],XHTML_NAMESPACE:[407,8,1,""],XMLNS_NAMESPACE:[407,8,1,""],XML_NAMESPACE:[407,8,1,""],getDOMImplementation:[407,10,1,""],minidom:[408,9,0,"-"],pulldom:[409,9,0,"-"],registerDOMImplementation:[407,10,1,""]},"xml.dom.Attr":{localName:[407,6,1,""],name:[407,6,1,""],prefix:[407,6,1,""],value:[407,6,1,""]},"xml.dom.Comment":{data:[407,6,1,""]},"xml.dom.DOMImplementation":{createDocument:[407,7,1,""],createDocumentType:[407,7,1,""],hasFeature:[407,7,1,""]},"xml.dom.Document":{createAttribute:[407,7,1,""],createAttributeNS:[407,7,1,""],createComment:[407,7,1,""],createElement:[407,7,1,""],createElementNS:[407,7,1,""],createProcessingInstruction:[407,7,1,""],createTextNode:[407,7,1,""],documentElement:[407,6,1,""],getElementsByTagName:[407,7,1,""],getElementsByTagNameNS:[407,7,1,""]},"xml.dom.DocumentType":{entities:[407,6,1,""],internalSubset:[407,6,1,""],name:[407,6,1,""],notations:[407,6,1,""],publicId:[407,6,1,""],systemId:[407,6,1,""]},"xml.dom.Element":{getAttribute:[407,7,1,""],getAttributeNS:[407,7,1,""],getAttributeNode:[407,7,1,""],getAttributeNodeNS:[407,7,1,""],getElementsByTagName:[407,7,1,""],getElementsByTagNameNS:[407,7,1,""],hasAttribute:[407,7,1,""],hasAttributeNS:[407,7,1,""],removeAttribute:[407,7,1,""],removeAttributeNS:[407,7,1,""],removeAttributeNode:[407,7,1,""],setAttribute:[407,7,1,""],setAttributeNS:[407,7,1,""],setAttributeNode:[407,7,1,""],setAttributeNodeNS:[407,7,1,""],tagName:[407,6,1,""]},"xml.dom.NamedNodeMap":{item:[407,7,1,""],length:[407,6,1,""]},"xml.dom.Node":{appendChild:[407,7,1,""],attributes:[407,6,1,""],childNodes:[407,6,1,""],cloneNode:[407,7,1,""],firstChild:[407,6,1,""],hasAttributes:[407,7,1,""],hasChildNodes:[407,7,1,""],insertBefore:[407,7,1,""],isSameNode:[407,7,1,""],lastChild:[407,6,1,""],localName:[407,6,1,""],namespaceURI:[407,6,1,""],nextSibling:[407,6,1,""],nodeName:[407,6,1,""],nodeType:[407,6,1,""],nodeValue:[407,6,1,""],normalize:[407,7,1,""],parentNode:[407,6,1,""],prefix:[407,6,1,""],previousSibling:[407,6,1,""],removeChild:[407,7,1,""],replaceChild:[407,7,1,""]},"xml.dom.NodeList":{item:[407,7,1,""],length:[407,6,1,""]},"xml.dom.ProcessingInstruction":{data:[407,6,1,""],target:[407,6,1,""]},"xml.dom.Text":{data:[407,6,1,""]},"xml.dom.minidom":{parse:[408,10,1,""],parseString:[408,10,1,""]},"xml.dom.minidom.Node":{toprettyxml:[408,7,1,""],toxml:[408,7,1,""],unlink:[408,7,1,""],writexml:[408,7,1,""]},"xml.dom.pulldom":{DOMEventStream:[409,11,1,""],PullDom:[409,11,1,""],SAX2DOM:[409,11,1,""],default_bufsize:[409,8,1,""],parse:[409,10,1,""],parseString:[409,10,1,""]},"xml.dom.pulldom.DOMEventStream":{expandNode:[409,7,1,""],getEvent:[409,7,1,""],reset:[409,7,1,""]},"xml.etree":{ElementTree:[410,9,0,"-"]},"xml.etree.ElementTree":{Comment:[410,10,1,""],Element:[410,11,1,""],ElementTree:[410,11,1,""],ParseError:[410,11,1,""],ProcessingInstruction:[410,10,1,""],QName:[410,11,1,""],SubElement:[410,10,1,""],TreeBuilder:[410,11,1,""],XML:[410,10,1,""],XMLID:[410,10,1,""],XMLParser:[410,11,1,""],XMLPullParser:[410,11,1,""],dump:[410,10,1,""],fromstring:[410,10,1,""],fromstringlist:[410,10,1,""],iselement:[410,10,1,""],iterparse:[410,10,1,""],parse:[410,10,1,""],register_namespace:[410,10,1,""],tostring:[410,10,1,""],tostringlist:[410,10,1,""]},"xml.etree.ElementTree.Element":{append:[410,7,1,""],attrib:[410,6,1,""],clear:[410,7,1,""],extend:[410,7,1,""],find:[410,7,1,""],findall:[410,7,1,""],findtext:[410,7,1,""],get:[410,7,1,""],getchildren:[410,7,1,""],getiterator:[410,7,1,""],insert:[410,7,1,""],items:[410,7,1,""],iter:[410,7,1,""],iterfind:[410,7,1,""],itertext:[410,7,1,""],keys:[410,7,1,""],makeelement:[410,7,1,""],remove:[410,7,1,""],set:[410,7,1,""],tag:[410,6,1,""],tail:[410,6,1,""],text:[410,6,1,""]},"xml.etree.ElementTree.ElementTree":{_setroot:[410,7,1,""],find:[410,7,1,""],findall:[410,7,1,""],findtext:[410,7,1,""],getiterator:[410,7,1,""],getroot:[410,7,1,""],iter:[410,7,1,""],iterfind:[410,7,1,""],parse:[410,7,1,""],write:[410,7,1,""]},"xml.etree.ElementTree.ParseError":{code:[410,6,1,""],position:[410,6,1,""]},"xml.etree.ElementTree.TreeBuilder":{close:[410,7,1,""],data:[410,7,1,""],doctype:[410,7,1,""],end:[410,7,1,""],start:[410,7,1,""]},"xml.etree.ElementTree.XMLParser":{close:[410,7,1,""],doctype:[410,7,1,""],feed:[410,7,1,""]},"xml.etree.ElementTree.XMLPullParser":{close:[410,7,1,""],feed:[410,7,1,""],read_events:[410,7,1,""]},"xml.parsers":{expat:[316,9,0,"-"]},"xml.parsers.expat":{ErrorString:[316,10,1,""],ExpatError:[316,5,1,""],ParserCreate:[316,10,1,""],XMLParserType:[316,8,1,""],error:[316,5,1,""],errors:[316,9,0,"-"],model:[316,9,0,"-"]},"xml.parsers.expat.ExpatError":{code:[316,6,1,""],lineno:[316,6,1,""],offset:[316,6,1,""]},"xml.parsers.expat.errors":{XML_ERROR_ABORTED:[316,8,1,""],XML_ERROR_ASYNC_ENTITY:[316,8,1,""],XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF:[316,8,1,""],XML_ERROR_BAD_CHAR_REF:[316,8,1,""],XML_ERROR_BINARY_ENTITY_REF:[316,8,1,""],XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING:[316,8,1,""],XML_ERROR_DUPLICATE_ATTRIBUTE:[316,8,1,""],XML_ERROR_ENTITY_DECLARED_IN_PE:[316,8,1,""],XML_ERROR_EXTERNAL_ENTITY_HANDLING:[316,8,1,""],XML_ERROR_FEATURE_REQUIRES_XML_DTD:[316,8,1,""],XML_ERROR_FINISHED:[316,8,1,""],XML_ERROR_INCOMPLETE_PE:[316,8,1,""],XML_ERROR_INCORRECT_ENCODING:[316,8,1,""],XML_ERROR_INVALID_TOKEN:[316,8,1,""],XML_ERROR_JUNK_AFTER_DOC_ELEMENT:[316,8,1,""],XML_ERROR_MISPLACED_XML_PI:[316,8,1,""],XML_ERROR_NOT_STANDALONE:[316,8,1,""],XML_ERROR_NOT_SUSPENDED:[316,8,1,""],XML_ERROR_NO_ELEMENTS:[316,8,1,""],XML_ERROR_NO_MEMORY:[316,8,1,""],XML_ERROR_PARAM_ENTITY_REF:[316,8,1,""],XML_ERROR_PARTIAL_CHAR:[316,8,1,""],XML_ERROR_PUBLICID:[316,8,1,""],XML_ERROR_RECURSIVE_ENTITY_REF:[316,8,1,""],XML_ERROR_SUSPENDED:[316,8,1,""],XML_ERROR_SUSPEND_PE:[316,8,1,""],XML_ERROR_SYNTAX:[316,8,1,""],XML_ERROR_TAG_MISMATCH:[316,8,1,""],XML_ERROR_TEXT_DECL:[316,8,1,""],XML_ERROR_UNBOUND_PREFIX:[316,8,1,""],XML_ERROR_UNCLOSED_CDATA_SECTION:[316,8,1,""],XML_ERROR_UNCLOSED_TOKEN:[316,8,1,""],XML_ERROR_UNDECLARING_PREFIX:[316,8,1,""],XML_ERROR_UNDEFINED_ENTITY:[316,8,1,""],XML_ERROR_UNEXPECTED_STATE:[316,8,1,""],XML_ERROR_UNKNOWN_ENCODING:[316,8,1,""],XML_ERROR_XML_DECL:[316,8,1,""],codes:[316,8,1,""],messages:[316,8,1,""]},"xml.parsers.expat.xmlparser":{AttlistDeclHandler:[316,7,1,""],CharacterDataHandler:[316,7,1,""],CommentHandler:[316,7,1,""],CurrentByteIndex:[316,6,1,""],CurrentColumnNumber:[316,6,1,""],CurrentLineNumber:[316,6,1,""],DefaultHandler:[316,7,1,""],DefaultHandlerExpand:[316,7,1,""],ElementDeclHandler:[316,7,1,""],EndCdataSectionHandler:[316,7,1,""],EndDoctypeDeclHandler:[316,7,1,""],EndElementHandler:[316,7,1,""],EndNamespaceDeclHandler:[316,7,1,""],EntityDeclHandler:[316,7,1,""],ErrorByteIndex:[316,6,1,""],ErrorCode:[316,6,1,""],ErrorColumnNumber:[316,6,1,""],ErrorLineNumber:[316,6,1,""],ExternalEntityParserCreate:[316,7,1,""],ExternalEntityRefHandler:[316,7,1,""],GetBase:[316,7,1,""],GetInputContext:[316,7,1,""],NotStandaloneHandler:[316,7,1,""],NotationDeclHandler:[316,7,1,""],Parse:[316,7,1,""],ParseFile:[316,7,1,""],ProcessingInstructionHandler:[316,7,1,""],SetBase:[316,7,1,""],SetParamEntityParsing:[316,7,1,""],StartCdataSectionHandler:[316,7,1,""],StartDoctypeDeclHandler:[316,7,1,""],StartElementHandler:[316,7,1,""],StartNamespaceDeclHandler:[316,7,1,""],UnparsedEntityDeclHandler:[316,7,1,""],UseForeignDTD:[316,7,1,""],XmlDeclHandler:[316,7,1,""],buffer_size:[316,6,1,""],buffer_text:[316,6,1,""],buffer_used:[316,6,1,""],ordered_attributes:[316,6,1,""],specified_attributes:[316,6,1,""]},"xml.sax":{SAXException:[411,5,1,""],SAXNotRecognizedException:[411,5,1,""],SAXNotSupportedException:[411,5,1,""],SAXParseException:[411,5,1,""],handler:[412,9,0,"-"],make_parser:[411,10,1,""],parse:[411,10,1,""],parseString:[411,10,1,""],saxutils:[414,9,0,"-"],xmlreader:[413,9,0,"-"]},"xml.sax.SAXException":{getException:[411,7,1,""],getMessage:[411,7,1,""]},"xml.sax.handler":{ContentHandler:[412,11,1,""],DTDHandler:[412,11,1,""],EntityResolver:[412,11,1,""],ErrorHandler:[412,11,1,""],all_features:[412,8,1,""],all_properties:[412,8,1,""],feature_external_ges:[412,8,1,""],feature_external_pes:[412,8,1,""],feature_namespace_prefixes:[412,8,1,""],feature_namespaces:[412,8,1,""],feature_string_interning:[412,8,1,""],feature_validation:[412,8,1,""],property_declaration_handler:[412,8,1,""],property_dom_node:[412,8,1,""],property_lexical_handler:[412,8,1,""],property_xml_string:[412,8,1,""]},"xml.sax.handler.ContentHandler":{characters:[412,7,1,""],endDocument:[412,7,1,""],endElement:[412,7,1,""],endElementNS:[412,7,1,""],endPrefixMapping:[412,7,1,""],ignorableWhitespace:[412,7,1,""],processingInstruction:[412,7,1,""],setDocumentLocator:[412,7,1,""],skippedEntity:[412,7,1,""],startDocument:[412,7,1,""],startElement:[412,7,1,""],startElementNS:[412,7,1,""],startPrefixMapping:[412,7,1,""]},"xml.sax.handler.DTDHandler":{notationDecl:[412,7,1,""],unparsedEntityDecl:[412,7,1,""]},"xml.sax.handler.EntityResolver":{resolveEntity:[412,7,1,""]},"xml.sax.handler.ErrorHandler":{error:[412,7,1,""],fatalError:[412,7,1,""],warning:[412,7,1,""]},"xml.sax.saxutils":{XMLFilterBase:[414,11,1,""],XMLGenerator:[414,11,1,""],escape:[414,10,1,""],prepare_input_source:[414,10,1,""],quoteattr:[414,10,1,""],unescape:[414,10,1,""]},"xml.sax.xmlreader":{AttributesImpl:[413,11,1,""],AttributesNSImpl:[413,11,1,""],IncrementalParser:[413,11,1,""],InputSource:[413,11,1,""],Locator:[413,11,1,""],XMLReader:[413,11,1,""]},"xml.sax.xmlreader.Attributes":{getLength:[413,7,1,""],getNames:[413,7,1,""],getType:[413,7,1,""],getValue:[413,7,1,""]},"xml.sax.xmlreader.AttributesNS":{getNameByQName:[413,7,1,""],getQNameByName:[413,7,1,""],getQNames:[413,7,1,""],getValueByQName:[413,7,1,""]},"xml.sax.xmlreader.IncrementalParser":{close:[413,7,1,""],feed:[413,7,1,""],reset:[413,7,1,""]},"xml.sax.xmlreader.InputSource":{getByteStream:[413,7,1,""],getCharacterStream:[413,7,1,""],getEncoding:[413,7,1,""],getPublicId:[413,7,1,""],getSystemId:[413,7,1,""],setByteStream:[413,7,1,""],setCharacterStream:[413,7,1,""],setEncoding:[413,7,1,""],setPublicId:[413,7,1,""],setSystemId:[413,7,1,""]},"xml.sax.xmlreader.Locator":{getColumnNumber:[413,7,1,""],getLineNumber:[413,7,1,""],getPublicId:[413,7,1,""],getSystemId:[413,7,1,""]},"xml.sax.xmlreader.XMLReader":{getContentHandler:[413,7,1,""],getDTDHandler:[413,7,1,""],getEntityResolver:[413,7,1,""],getErrorHandler:[413,7,1,""],getFeature:[413,7,1,""],getProperty:[413,7,1,""],parse:[413,7,1,""],setContentHandler:[413,7,1,""],setDTDHandler:[413,7,1,""],setEntityResolver:[413,7,1,""],setErrorHandler:[413,7,1,""],setFeature:[413,7,1,""],setLocale:[413,7,1,""],setProperty:[413,7,1,""]},"xmlrpc.client":{Binary:[416,11,1,""],DateTime:[416,11,1,""],Fault:[416,11,1,""],MultiCall:[416,11,1,""],ProtocolError:[416,11,1,""],ServerProxy:[416,11,1,""],dumps:[416,10,1,""],loads:[416,10,1,""]},"xmlrpc.client.Binary":{data:[416,6,1,""],decode:[416,7,1,""],encode:[416,7,1,""]},"xmlrpc.client.DateTime":{decode:[416,7,1,""],encode:[416,7,1,""]},"xmlrpc.client.Fault":{faultCode:[416,6,1,""],faultString:[416,6,1,""]},"xmlrpc.client.ProtocolError":{errcode:[416,6,1,""],errmsg:[416,6,1,""],headers:[416,6,1,""],url:[416,6,1,""]},"xmlrpc.client.ServerProxy.system":{listMethods:[416,7,1,""],methodHelp:[416,7,1,""],methodSignature:[416,7,1,""]},"xmlrpc.server":{CGIXMLRPCRequestHandler:[417,11,1,""],DocCGIXMLRPCRequestHandler:[417,11,1,""],DocXMLRPCRequestHandler:[417,11,1,""],DocXMLRPCServer:[417,11,1,""],SimpleXMLRPCRequestHandler:[417,11,1,""],SimpleXMLRPCServer:[417,11,1,""]},"xmlrpc.server.CGIXMLRPCRequestHandler":{handle_request:[417,7,1,""],register_function:[417,7,1,""],register_instance:[417,7,1,""],register_introspection_functions:[417,7,1,""],register_multicall_functions:[417,7,1,""]},"xmlrpc.server.DocCGIXMLRPCRequestHandler":{set_server_documentation:[417,7,1,""],set_server_name:[417,7,1,""],set_server_title:[417,7,1,""]},"xmlrpc.server.DocXMLRPCServer":{set_server_documentation:[417,7,1,""],set_server_name:[417,7,1,""],set_server_title:[417,7,1,""]},"xmlrpc.server.SimpleXMLRPCRequestHandler":{rpc_paths:[417,6,1,""]},"xmlrpc.server.SimpleXMLRPCServer":{register_function:[417,7,1,""],register_instance:[417,7,1,""],register_introspection_functions:[417,7,1,""],register_multicall_functions:[417,7,1,""]},"zipfile.PyZipFile":{writepy:[419,7,1,""]},"zipfile.ZipFile":{close:[419,7,1,""],comment:[419,6,1,""],debug:[419,6,1,""],extract:[419,7,1,""],extractall:[419,7,1,""],filename:[419,6,1,""],getinfo:[419,7,1,""],infolist:[419,7,1,""],namelist:[419,7,1,""],open:[419,7,1,""],printdir:[419,7,1,""],read:[419,7,1,""],setpassword:[419,7,1,""],testzip:[419,7,1,""],write:[419,7,1,""],writestr:[419,7,1,""]},"zipfile.ZipInfo":{CRC:[419,6,1,""],comment:[419,6,1,""],compress_size:[419,6,1,""],compress_type:[419,6,1,""],create_system:[419,6,1,""],create_version:[419,6,1,""],date_time:[419,6,1,""],external_attr:[419,6,1,""],extra:[419,6,1,""],extract_version:[419,6,1,""],file_size:[419,6,1,""],filename:[419,6,1,""],flag_bits:[419,6,1,""],from_file:[419,12,1,""],header_offset:[419,6,1,""],internal_attr:[419,6,1,""],is_dir:[419,7,1,""],reserved:[419,6,1,""],volume:[419,6,1,""]},"zipimport.zipimporter":{archive:[420,6,1,""],find_module:[420,7,1,""],get_code:[420,7,1,""],get_data:[420,7,1,""],get_filename:[420,7,1,""],get_source:[420,7,1,""],is_package:[420,7,1,""],load_module:[420,7,1,""],prefix:[420,6,1,""]},"zlib.Compress":{compress:[421,7,1,""],copy:[421,7,1,""],flush:[421,7,1,""]},"zlib.Decompress":{copy:[421,7,1,""],decompress:[421,7,1,""],eof:[421,6,1,""],flush:[421,7,1,""],unconsumed_tail:[421,6,1,""],unused_data:[421,6,1,""]},BaseException:{args:[214,6,1,""],with_traceback:[214,7,1,""]},BlockingIOError:{characters_written:[214,6,1,""]},OSError:{errno:[214,6,1,""],filename2:[214,6,1,""],filename:[214,6,1,""],strerror:[214,6,1,""],winerror:[214,6,1,""]},PyAsyncMethods:{am_aiter:[57,3,1,"c.PyAsyncMethods.am_aiter"],am_anext:[57,3,1,"c.PyAsyncMethods.am_anext"],am_await:[57,3,1,"c.PyAsyncMethods.am_await"]},PyBufferProcs:{bf_getbuffer:[57,3,1,"c.PyBufferProcs.bf_getbuffer"],bf_releasebuffer:[57,3,1,"c.PyBufferProcs.bf_releasebuffer"]},PyMappingMethods:{mp_ass_subscript:[57,3,1,"c.PyMappingMethods.mp_ass_subscript"],mp_length:[57,3,1,"c.PyMappingMethods.mp_length"],mp_subscript:[57,3,1,"c.PyMappingMethods.mp_subscript"]},PyModuleDef:{m_base:[41,3,1,"c.PyModuleDef.m_base"],m_clear:[41,3,1,"c.PyModuleDef.m_clear"],m_doc:[41,3,1,"c.PyModuleDef.m_doc"],m_free:[41,3,1,"c.PyModuleDef.m_free"],m_methods:[41,3,1,"c.PyModuleDef.m_methods"],m_name:[41,3,1,"c.PyModuleDef.m_name"],m_reload:[41,3,1,"c.PyModuleDef.m_reload"],m_size:[41,3,1,"c.PyModuleDef.m_size"],m_slots:[41,3,1,"c.PyModuleDef.m_slots"],m_traverse:[41,3,1,"c.PyModuleDef.m_traverse"]},PyModuleDef_Slot:{slot:[41,3,1,"c.PyModuleDef_Slot.slot"],value:[41,3,1,"c.PyModuleDef_Slot.value"]},PyObject:{_ob_next:[57,3,1,"c.PyObject._ob_next"],_ob_prev:[57,3,1,"c.PyObject._ob_prev"],ob_refcnt:[57,3,1,"c.PyObject.ob_refcnt"],ob_type:[57,3,1,"c.PyObject.ob_type"]},PySequenceMethods:{sq_ass_item:[57,3,1,"c.PySequenceMethods.sq_ass_item"],sq_concat:[57,3,1,"c.PySequenceMethods.sq_concat"],sq_contains:[57,3,1,"c.PySequenceMethods.sq_contains"],sq_inplace_concat:[57,3,1,"c.PySequenceMethods.sq_inplace_concat"],sq_inplace_repeat:[57,3,1,"c.PySequenceMethods.sq_inplace_repeat"],sq_item:[57,3,1,"c.PySequenceMethods.sq_item"],sq_length:[57,3,1,"c.PySequenceMethods.sq_length"],sq_repeat:[57,3,1,"c.PySequenceMethods.sq_repeat"]},PyTypeObject:{tp_alloc:[57,3,1,"c.PyTypeObject.tp_alloc"],tp_allocs:[57,3,1,"c.PyTypeObject.tp_allocs"],tp_as_buffer:[57,3,1,"c.PyTypeObject.tp_as_buffer"],tp_base:[57,3,1,"c.PyTypeObject.tp_base"],tp_bases:[57,3,1,"c.PyTypeObject.tp_bases"],tp_basicsize:[57,3,1,"c.PyTypeObject.tp_basicsize"],tp_cache:[57,3,1,"c.PyTypeObject.tp_cache"],tp_call:[57,3,1,"c.PyTypeObject.tp_call"],tp_clear:[57,3,1,"c.PyTypeObject.tp_clear"],tp_dealloc:[57,3,1,"c.PyTypeObject.tp_dealloc"],tp_descr_get:[57,3,1,"c.PyTypeObject.tp_descr_get"],tp_descr_set:[57,3,1,"c.PyTypeObject.tp_descr_set"],tp_dict:[57,3,1,"c.PyTypeObject.tp_dict"],tp_dictoffset:[57,3,1,"c.PyTypeObject.tp_dictoffset"],tp_doc:[57,3,1,"c.PyTypeObject.tp_doc"],tp_finalize:[57,3,1,"c.PyTypeObject.tp_finalize"],tp_flags:[57,3,1,"c.PyTypeObject.tp_flags"],tp_free:[57,3,1,"c.PyTypeObject.tp_free"],tp_frees:[57,3,1,"c.PyTypeObject.tp_frees"],tp_getattr:[57,3,1,"c.PyTypeObject.tp_getattr"],tp_getattro:[57,3,1,"c.PyTypeObject.tp_getattro"],tp_getset:[57,3,1,"c.PyTypeObject.tp_getset"],tp_hash:[57,3,1,"c.PyTypeObject.tp_hash"],tp_init:[57,3,1,"c.PyTypeObject.tp_init"],tp_is_gc:[57,3,1,"c.PyTypeObject.tp_is_gc"],tp_itemsize:[57,3,1,"c.PyTypeObject.tp_itemsize"],tp_iter:[57,3,1,"c.PyTypeObject.tp_iter"],tp_iternext:[57,3,1,"c.PyTypeObject.tp_iternext"],tp_maxalloc:[57,3,1,"c.PyTypeObject.tp_maxalloc"],tp_members:[57,3,1,"c.PyTypeObject.tp_members"],tp_methods:[57,3,1,"c.PyTypeObject.tp_methods"],tp_mro:[57,3,1,"c.PyTypeObject.tp_mro"],tp_name:[57,3,1,"c.PyTypeObject.tp_name"],tp_new:[57,3,1,"c.PyTypeObject.tp_new"],tp_next:[57,3,1,"c.PyTypeObject.tp_next"],tp_print:[57,3,1,"c.PyTypeObject.tp_print"],tp_repr:[57,3,1,"c.PyTypeObject.tp_repr"],tp_richcompare:[57,3,1,"c.PyTypeObject.tp_richcompare"],tp_setattr:[57,3,1,"c.PyTypeObject.tp_setattr"],tp_setattro:[57,3,1,"c.PyTypeObject.tp_setattro"],tp_str:[57,3,1,"c.PyTypeObject.tp_str"],tp_subclasses:[57,3,1,"c.PyTypeObject.tp_subclasses"],tp_traverse:[57,3,1,"c.PyTypeObject.tp_traverse"],tp_weaklist:[57,3,1,"c.PyTypeObject.tp_weaklist"],tp_weaklistoffset:[57,3,1,"c.PyTypeObject.tp_weaklistoffset"]},PyVarObject:{ob_size:[57,3,1,"c.PyVarObject.ob_size"]},Py_buffer:{buf:[7,3,1,"c.Py_buffer.buf"],format:[7,3,1,"c.Py_buffer.format"],internal:[7,3,1,"c.Py_buffer.internal"],itemsize:[7,3,1,"c.Py_buffer.itemsize"],len:[7,3,1,"c.Py_buffer.len"],ndim:[7,3,1,"c.Py_buffer.ndim"],obj:[7,3,1,"c.Py_buffer.obj"],readonly:[7,3,1,"c.Py_buffer.readonly"],shape:[7,3,1,"c.Py_buffer.shape"],strides:[7,3,1,"c.Py_buffer.strides"],suboffsets:[7,3,1,"c.Py_buffer.suboffsets"]},SystemExit:{code:[214,6,1,""]},UnicodeError:{encoding:[214,6,1,""],end:[214,6,1,""],object:[214,6,1,""],reason:[214,6,1,""],start:[214,6,1,""]},_thread:{LockType:[117,8,1,""],TIMEOUT_MAX:[117,8,1,""],allocate_lock:[117,10,1,""],error:[117,5,1,""],exit:[117,10,1,""],get_ident:[117,10,1,""],interrupt_main:[117,10,1,""],stack_size:[117,10,1,""],start_new_thread:[117,10,1,""]},abc:{ABC:[118,11,1,""],ABCMeta:[118,11,1,""],abstractclassmethod:[118,10,1,""],abstractmethod:[118,10,1,""],abstractproperty:[118,10,1,""],abstractstaticmethod:[118,10,1,""],get_cache_token:[118,10,1,""]},agen:{__anext__:[426,7,1,""],aclose:[426,7,1,""],asend:[426,7,1,""],athrow:[426,7,1,""]},aifc:{open:[119,10,1,""]},argparse:{Action:[122,11,1,""],ArgumentDefaultsHelpFormatter:[122,11,1,""],ArgumentParser:[122,11,1,""],FileType:[122,11,1,""],MetavarTypeHelpFormatter:[122,11,1,""],Namespace:[122,11,1,""],RawDescriptionHelpFormatter:[122,11,1,""],RawTextHelpFormatter:[122,11,1,""]},array:{array:[123,11,1,""],typecodes:[123,8,1,""]},ast:{AST:[124,11,1,""],NodeTransformer:[124,11,1,""],NodeVisitor:[124,11,1,""],copy_location:[124,10,1,""],dump:[124,10,1,""],fix_missing_locations:[124,10,1,""],get_docstring:[124,10,1,""],increment_lineno:[124,10,1,""],iter_child_nodes:[124,10,1,""],iter_fields:[124,10,1,""],literal_eval:[124,10,1,""],parse:[124,10,1,""],walk:[124,10,1,""]},asynchat:{async_chat:[125,11,1,""]},asyncio:{AbstractChildWatcher:[134,11,1,""],AbstractEventLoop:[129,11,1,""],AbstractEventLoopPolicy:[134,11,1,""],BaseProtocol:[135,11,1,""],BaseTransport:[135,11,1,""],BoundedSemaphore:[139,11,1,""],BufferedProtocol:[135,11,1,""],CancelledError:[130,5,1,""],Condition:[139,11,1,""],DatagramProtocol:[135,11,1,""],DatagramTransport:[135,11,1,""],DefaultEventLoopPolicy:[134,11,1,""],Event:[139,11,1,""],FastChildWatcher:[134,11,1,""],Future:[131,11,1,""],Handle:[129,11,1,""],IncompleteReadError:[130,5,1,""],InvalidStateError:[130,5,1,""],LifoQueue:[136,11,1,""],LimitOverrunError:[130,5,1,""],Lock:[139,11,1,""],PriorityQueue:[136,11,1,""],ProactorEventLoop:[129,11,1,""],Protocol:[135,11,1,""],Queue:[136,11,1,""],QueueEmpty:[136,5,1,""],QueueFull:[136,5,1,""],ReadTransport:[135,11,1,""],SafeChildWatcher:[134,11,1,""],SelectorEventLoop:[129,11,1,""],Semaphore:[139,11,1,""],SendfileNotAvailableError:[130,5,1,""],Server:[129,11,1,""],StreamReader:[137,11,1,""],StreamWriter:[137,11,1,""],SubprocessProtocol:[135,11,1,""],SubprocessTransport:[135,11,1,""],Task:[140,11,1,""],TimeoutError:[130,5,1,""],TimerHandle:[129,11,1,""],Transport:[135,11,1,""],WindowsProactorEventLoopPolicy:[134,11,1,""],WriteTransport:[135,11,1,""],all_tasks:[140,10,1,""],as_completed:[140,10,1,""],coroutine:[140,10,1,""],create_subprocess_exec:[138,10,1,""],create_subprocess_shell:[138,10,1,""],create_task:[140,10,1,""],current_task:[140,10,1,""],ensure_future:[131,10,1,""],gather:[140,10,1,""],get_child_watcher:[134,10,1,""],get_event_loop:[129,10,1,""],get_event_loop_policy:[134,10,1,""],get_running_loop:[129,10,1,""],iscoroutine:[140,10,1,""],iscoroutinefunction:[140,10,1,""],isfuture:[131,10,1,""],new_event_loop:[129,10,1,""],open_connection:[137,10,1,""],open_unix_connection:[137,10,1,""],run:[140,10,1,""],run_coroutine_threadsafe:[140,10,1,""],set_child_watcher:[134,10,1,""],set_event_loop:[129,10,1,""],set_event_loop_policy:[134,10,1,""],shield:[140,10,1,""],sleep:[140,10,1,""],start_server:[137,10,1,""],start_unix_server:[137,10,1,""],wait:[140,10,1,""],wait_for:[140,10,1,""],wrap_future:[131,10,1,""]},asyncore:{dispatcher:[141,11,1,""],dispatcher_with_send:[141,11,1,""],file_dispatcher:[141,11,1,""],file_wrapper:[141,11,1,""],loop:[141,10,1,""]},atexit:{register:[142,10,1,""],unregister:[142,10,1,""]},audioop:{add:[143,10,1,""],adpcm2lin:[143,10,1,""],alaw2lin:[143,10,1,""],avg:[143,10,1,""],avgpp:[143,10,1,""],bias:[143,10,1,""],byteswap:[143,10,1,""],cross:[143,10,1,""],error:[143,5,1,""],findfactor:[143,10,1,""],findfit:[143,10,1,""],findmax:[143,10,1,""],getsample:[143,10,1,""],lin2adpcm:[143,10,1,""],lin2alaw:[143,10,1,""],lin2lin:[143,10,1,""],lin2ulaw:[143,10,1,""],max:[143,10,1,""],maxpp:[143,10,1,""],minmax:[143,10,1,""],mul:[143,10,1,""],ratecv:[143,10,1,""],reverse:[143,10,1,""],rms:[143,10,1,""],tomono:[143,10,1,""],tostereo:[143,10,1,""],ulaw2lin:[143,10,1,""]},base64:{a85decode:[144,10,1,""],a85encode:[144,10,1,""],b16decode:[144,10,1,""],b16encode:[144,10,1,""],b32decode:[144,10,1,""],b32encode:[144,10,1,""],b64decode:[144,10,1,""],b64encode:[144,10,1,""],b85decode:[144,10,1,""],b85encode:[144,10,1,""],decode:[144,10,1,""],decodebytes:[144,10,1,""],decodestring:[144,10,1,""],encode:[144,10,1,""],encodebytes:[144,10,1,""],encodestring:[144,10,1,""],standard_b64decode:[144,10,1,""],standard_b64encode:[144,10,1,""],urlsafe_b64decode:[144,10,1,""],urlsafe_b64encode:[144,10,1,""]},bdb:{Bdb:[145,11,1,""],BdbQuit:[145,5,1,""],Breakpoint:[145,11,1,""],checkfuncname:[145,10,1,""],effective:[145,10,1,""],set_trace:[145,10,1,""]},binascii:{Error:[147,5,1,""],Incomplete:[147,5,1,""],a2b_base64:[147,10,1,""],a2b_hex:[147,10,1,""],a2b_hqx:[147,10,1,""],a2b_qp:[147,10,1,""],a2b_uu:[147,10,1,""],b2a_base64:[147,10,1,""],b2a_hex:[147,10,1,""],b2a_hqx:[147,10,1,""],b2a_qp:[147,10,1,""],b2a_uu:[147,10,1,""],crc32:[147,10,1,""],crc_hqx:[147,10,1,""],hexlify:[147,10,1,""],rlecode_hqx:[147,10,1,""],rledecode_hqx:[147,10,1,""],unhexlify:[147,10,1,""]},binhex:{Error:[148,5,1,""],binhex:[148,10,1,""],hexbin:[148,10,1,""]},bisect:{bisect:[149,10,1,""],bisect_left:[149,10,1,""],bisect_right:[149,10,1,""],insort:[149,10,1,""],insort_left:[149,10,1,""],insort_right:[149,10,1,""]},bytearray:{capitalize:[346,7,1,""],center:[346,7,1,""],count:[346,7,1,""],decode:[346,7,1,""],endswith:[346,7,1,""],expandtabs:[346,7,1,""],find:[346,7,1,""],fromhex:[346,12,1,""],hex:[346,7,1,""],index:[346,7,1,""],isalnum:[346,7,1,""],isalpha:[346,7,1,""],isascii:[346,7,1,""],isdigit:[346,7,1,""],islower:[346,7,1,""],isspace:[346,7,1,""],istitle:[346,7,1,""],isupper:[346,7,1,""],join:[346,7,1,""],ljust:[346,7,1,""],lower:[346,7,1,""],lstrip:[346,7,1,""],maketrans:[346,13,1,""],partition:[346,7,1,""],replace:[346,7,1,""],rfind:[346,7,1,""],rindex:[346,7,1,""],rjust:[346,7,1,""],rpartition:[346,7,1,""],rsplit:[346,7,1,""],rstrip:[346,7,1,""],split:[346,7,1,""],splitlines:[346,7,1,""],startswith:[346,7,1,""],strip:[346,7,1,""],swapcase:[346,7,1,""],title:[346,7,1,""],translate:[346,7,1,""],upper:[346,7,1,""],zfill:[346,7,1,""]},bytes:{capitalize:[346,7,1,""],center:[346,7,1,""],count:[346,7,1,""],decode:[346,7,1,""],endswith:[346,7,1,""],expandtabs:[346,7,1,""],find:[346,7,1,""],fromhex:[346,12,1,""],hex:[346,7,1,""],index:[346,7,1,""],isalnum:[346,7,1,""],isalpha:[346,7,1,""],isascii:[346,7,1,""],isdigit:[346,7,1,""],islower:[346,7,1,""],isspace:[346,7,1,""],istitle:[346,7,1,""],isupper:[346,7,1,""],join:[346,7,1,""],ljust:[346,7,1,""],lower:[346,7,1,""],lstrip:[346,7,1,""],maketrans:[346,13,1,""],partition:[346,7,1,""],replace:[346,7,1,""],rfind:[346,7,1,""],rindex:[346,7,1,""],rjust:[346,7,1,""],rpartition:[346,7,1,""],rsplit:[346,7,1,""],rstrip:[346,7,1,""],split:[346,7,1,""],splitlines:[346,7,1,""],startswith:[346,7,1,""],strip:[346,7,1,""],swapcase:[346,7,1,""],title:[346,7,1,""],translate:[346,7,1,""],upper:[346,7,1,""],zfill:[346,7,1,""]},bz2:{BZ2Compressor:[151,11,1,""],BZ2Decompressor:[151,11,1,""],BZ2File:[151,11,1,""],compress:[151,10,1,""],decompress:[151,10,1,""],open:[151,10,1,""]},calendar:{Calendar:[152,11,1,""],HTMLCalendar:[152,11,1,""],LocaleHTMLCalendar:[152,11,1,""],LocaleTextCalendar:[152,11,1,""],TextCalendar:[152,11,1,""],calendar:[152,10,1,""],day_abbr:[152,8,1,""],day_name:[152,8,1,""],firstweekday:[152,10,1,""],isleap:[152,10,1,""],leapdays:[152,10,1,""],month:[152,10,1,""],month_abbr:[152,8,1,""],month_name:[152,8,1,""],monthcalendar:[152,10,1,""],monthrange:[152,10,1,""],prcal:[152,10,1,""],prmonth:[152,10,1,""],setfirstweekday:[152,10,1,""],timegm:[152,10,1,""],weekday:[152,10,1,""],weekheader:[152,10,1,""]},cgi:{escape:[153,10,1,""],parse:[153,10,1,""],parse_header:[153,10,1,""],parse_multipart:[153,10,1,""],parse_qs:[153,10,1,""],parse_qsl:[153,10,1,""],print_directory:[153,10,1,""],print_environ:[153,10,1,""],print_environ_usage:[153,10,1,""],print_form:[153,10,1,""],test:[153,10,1,""]},cgitb:{enable:[154,10,1,""],handler:[154,10,1,""],html:[154,10,1,""],text:[154,10,1,""]},chunk:{Chunk:[155,11,1,""]},cmath:{acos:[156,10,1,""],acosh:[156,10,1,""],asin:[156,10,1,""],asinh:[156,10,1,""],atan:[156,10,1,""],atanh:[156,10,1,""],cos:[156,10,1,""],cosh:[156,10,1,""],e:[156,8,1,""],exp:[156,10,1,""],inf:[156,8,1,""],infj:[156,8,1,""],isclose:[156,10,1,""],isfinite:[156,10,1,""],isinf:[156,10,1,""],isnan:[156,10,1,""],log10:[156,10,1,""],log:[156,10,1,""],nan:[156,8,1,""],nanj:[156,8,1,""],phase:[156,10,1,""],pi:[156,8,1,""],polar:[156,10,1,""],rect:[156,10,1,""],sin:[156,10,1,""],sinh:[156,10,1,""],sqrt:[156,10,1,""],tan:[156,10,1,""],tanh:[156,10,1,""],tau:[156,8,1,""]},cmd:{Cmd:[157,11,1,""]},code:{InteractiveConsole:[158,11,1,""],InteractiveInterpreter:[158,11,1,""],compile_command:[158,10,1,""],interact:[158,10,1,""]},codecs:{BOM:[159,8,1,""],BOM_BE:[159,8,1,""],BOM_LE:[159,8,1,""],BOM_UTF16:[159,8,1,""],BOM_UTF16_BE:[159,8,1,""],BOM_UTF16_LE:[159,8,1,""],BOM_UTF32:[159,8,1,""],BOM_UTF32_BE:[159,8,1,""],BOM_UTF32_LE:[159,8,1,""],BOM_UTF8:[159,8,1,""],CodecInfo:[159,11,1,""],EncodedFile:[159,10,1,""],IncrementalDecoder:[159,11,1,""],IncrementalEncoder:[159,11,1,""],StreamReader:[159,11,1,""],StreamReaderWriter:[159,11,1,""],StreamRecoder:[159,11,1,""],StreamWriter:[159,11,1,""],backslashreplace_errors:[159,10,1,""],decode:[159,10,1,""],encode:[159,10,1,""],getdecoder:[159,10,1,""],getencoder:[159,10,1,""],getincrementaldecoder:[159,10,1,""],getincrementalencoder:[159,10,1,""],getreader:[159,10,1,""],getwriter:[159,10,1,""],ignore_errors:[159,10,1,""],iterdecode:[159,10,1,""],iterencode:[159,10,1,""],lookup:[159,10,1,""],lookup_error:[159,10,1,""],namereplace_errors:[159,10,1,""],open:[159,10,1,""],register:[159,10,1,""],register_error:[159,10,1,""],replace_errors:[159,10,1,""],strict_errors:[159,10,1,""],xmlcharrefreplace_errors:[159,10,1,""]},codeop:{CommandCompiler:[160,11,1,""],Compile:[160,11,1,""],compile_command:[160,10,1,""]},collections:{ChainMap:[161,11,1,""],Counter:[161,11,1,""],OrderedDict:[161,11,1,""],UserDict:[161,11,1,""],UserList:[161,11,1,""],UserString:[161,11,1,""],abc:[162,9,0,"-"],defaultdict:[161,11,1,""],deque:[161,11,1,""],namedtuple:[161,10,1,""]},colorsys:{hls_to_rgb:[163,10,1,""],hsv_to_rgb:[163,10,1,""],rgb_to_hls:[163,10,1,""],rgb_to_hsv:[163,10,1,""],rgb_to_yiq:[163,10,1,""],yiq_to_rgb:[163,10,1,""]},compileall:{"--invalidation-mode":[164,15,1,"cmdoption-compileall-invalidation-mode"],"-b":[164,15,1,"cmdoption-compileall-b"],"-d":[164,15,1,"cmdoption-compileall-d"],"-f":[164,15,1,"cmdoption-compileall-f"],"-i":[164,15,1,"cmdoption-compileall-i"],"-j":[164,15,1,"cmdoption-compileall-j"],"-l":[164,15,1,"cmdoption-compileall-l"],"-q":[164,15,1,"cmdoption-compileall-q"],"-r":[164,15,1,"cmdoption-compileall-r"],"-x":[164,15,1,"cmdoption-compileall-x"],compile_dir:[164,10,1,""],compile_file:[164,10,1,""],compile_path:[164,10,1,""],directory:[164,15,1,"cmdoption-compileall-arg-directory"],file:[164,15,1,"cmdoption-compileall-arg-file"]},concurrent:{futures:[167,9,0,"-"]},configparser:{BasicInterpolation:[168,11,1,""],ConfigParser:[168,11,1,""],DuplicateOptionError:[168,5,1,""],DuplicateSectionError:[168,5,1,""],Error:[168,5,1,""],ExtendedInterpolation:[168,11,1,""],InterpolationDepthError:[168,5,1,""],InterpolationError:[168,5,1,""],InterpolationMissingOptionError:[168,5,1,""],InterpolationSyntaxError:[168,5,1,""],MAX_INTERPOLATION_DEPTH:[168,8,1,""],MissingSectionHeaderError:[168,5,1,""],NoOptionError:[168,5,1,""],NoSectionError:[168,5,1,""],ParsingError:[168,5,1,""],RawConfigParser:[168,11,1,""]},container:{__iter__:[346,7,1,""]},contextlib:{AbstractAsyncContextManager:[170,11,1,""],AbstractContextManager:[170,11,1,""],AsyncExitStack:[170,11,1,""],ContextDecorator:[170,11,1,""],ExitStack:[170,11,1,""],asynccontextmanager:[170,10,1,""],closing:[170,10,1,""],contextmanager:[170,10,1,""],nullcontext:[170,10,1,""],redirect_stderr:[170,10,1,""],redirect_stdout:[170,10,1,""],suppress:[170,10,1,""]},contextmanager:{__enter__:[346,7,1,""],__exit__:[346,7,1,""]},contextvars:{Context:[171,11,1,""],ContextVar:[171,11,1,""],copy_context:[171,10,1,""]},copy:{copy:[172,10,1,""],deepcopy:[172,10,1,""],error:[172,5,1,""]},copyreg:{constructor:[173,10,1,""],pickle:[173,10,1,""]},coroutine:{"throw":[424,7,1,""],close:[424,7,1,""],send:[424,7,1,""]},crypt:{METHOD_BLOWFISH:[174,8,1,""],METHOD_CRYPT:[174,8,1,""],METHOD_MD5:[174,8,1,""],METHOD_SHA256:[174,8,1,""],METHOD_SHA512:[174,8,1,""],crypt:[174,10,1,""],methods:[174,6,1,""],mksalt:[174,10,1,""]},csv:{Dialect:[176,11,1,""],DictReader:[176,11,1,""],DictWriter:[176,11,1,""],Error:[176,5,1,""],QUOTE_ALL:[176,8,1,""],QUOTE_MINIMAL:[176,8,1,""],QUOTE_NONE:[176,8,1,""],QUOTE_NONNUMERIC:[176,8,1,""],Sniffer:[176,11,1,""],excel:[176,11,1,""],excel_tab:[176,11,1,""],field_size_limit:[176,10,1,""],get_dialect:[176,10,1,""],list_dialects:[176,10,1,""],reader:[176,10,1,""],register_dialect:[176,10,1,""],unix_dialect:[176,11,1,""],unregister_dialect:[176,10,1,""],writer:[176,10,1,""]},ctypes:{ArgumentError:[177,5,1,""],Array:[177,11,1,""],BigEndianStructure:[177,11,1,""],CDLL:[177,11,1,""],CFUNCTYPE:[177,10,1,""],DllCanUnloadNow:[177,10,1,""],DllGetClassObject:[177,10,1,""],FormatError:[177,10,1,""],GetLastError:[177,10,1,""],HRESULT:[177,11,1,""],LibraryLoader:[177,11,1,""],LittleEndianStructure:[177,11,1,""],OleDLL:[177,11,1,""],POINTER:[177,10,1,""],PYFUNCTYPE:[177,10,1,""],PyDLL:[177,11,1,""],Structure:[177,11,1,""],Union:[177,11,1,""],WINFUNCTYPE:[177,10,1,""],WinDLL:[177,11,1,""],WinError:[177,10,1,""],_CData:[177,11,1,""],_FuncPtr:[177,11,1,""],_Pointer:[177,11,1,""],_SimpleCData:[177,11,1,""],addressof:[177,10,1,""],alignment:[177,10,1,""],byref:[177,10,1,""],c_bool:[177,11,1,""],c_byte:[177,11,1,""],c_char:[177,11,1,""],c_char_p:[177,11,1,""],c_double:[177,11,1,""],c_float:[177,11,1,""],c_int16:[177,11,1,""],c_int32:[177,11,1,""],c_int64:[177,11,1,""],c_int8:[177,11,1,""],c_int:[177,11,1,""],c_long:[177,11,1,""],c_longdouble:[177,11,1,""],c_longlong:[177,11,1,""],c_short:[177,11,1,""],c_size_t:[177,11,1,""],c_ssize_t:[177,11,1,""],c_ubyte:[177,11,1,""],c_uint16:[177,11,1,""],c_uint32:[177,11,1,""],c_uint64:[177,11,1,""],c_uint8:[177,11,1,""],c_uint:[177,11,1,""],c_ulong:[177,11,1,""],c_ulonglong:[177,11,1,""],c_ushort:[177,11,1,""],c_void_p:[177,11,1,""],c_wchar:[177,11,1,""],c_wchar_p:[177,11,1,""],cast:[177,10,1,""],create_string_buffer:[177,10,1,""],create_unicode_buffer:[177,10,1,""],get_errno:[177,10,1,""],get_last_error:[177,10,1,""],memmove:[177,10,1,""],memset:[177,10,1,""],pointer:[177,10,1,""],py_object:[177,11,1,""],resize:[177,10,1,""],set_errno:[177,10,1,""],set_last_error:[177,10,1,""],sizeof:[177,10,1,""],string_at:[177,10,1,""],wstring_at:[177,10,1,""]},curses:{ERR:[178,8,1,""],OK:[178,8,1,""],ascii:[179,9,0,"-"],baudrate:[178,10,1,""],beep:[178,10,1,""],can_change_color:[178,10,1,""],cbreak:[178,10,1,""],color_content:[178,10,1,""],color_pair:[178,10,1,""],curs_set:[178,10,1,""],def_prog_mode:[178,10,1,""],def_shell_mode:[178,10,1,""],delay_output:[178,10,1,""],doupdate:[178,10,1,""],echo:[178,10,1,""],endwin:[178,10,1,""],erasechar:[178,10,1,""],error:[178,5,1,""],filter:[178,10,1,""],flash:[178,10,1,""],flushinp:[178,10,1,""],getmouse:[178,10,1,""],getsyx:[178,10,1,""],getwin:[178,10,1,""],halfdelay:[178,10,1,""],has_colors:[178,10,1,""],has_ic:[178,10,1,""],has_il:[178,10,1,""],has_key:[178,10,1,""],init_color:[178,10,1,""],init_pair:[178,10,1,""],initscr:[178,10,1,""],is_term_resized:[178,10,1,""],isendwin:[178,10,1,""],keyname:[178,10,1,""],killchar:[178,10,1,""],longname:[178,10,1,""],meta:[178,10,1,""],mouseinterval:[178,10,1,""],mousemask:[178,10,1,""],napms:[178,10,1,""],newpad:[178,10,1,""],newwin:[178,10,1,""],nl:[178,10,1,""],nocbreak:[178,10,1,""],noecho:[178,10,1,""],nonl:[178,10,1,""],noqiflush:[178,10,1,""],noraw:[178,10,1,""],pair_content:[178,10,1,""],pair_number:[178,10,1,""],panel:[180,9,0,"-"],putp:[178,10,1,""],qiflush:[178,10,1,""],raw:[178,10,1,""],reset_prog_mode:[178,10,1,""],reset_shell_mode:[178,10,1,""],resetty:[178,10,1,""],resize_term:[178,10,1,""],resizeterm:[178,10,1,""],savetty:[178,10,1,""],setsyx:[178,10,1,""],setupterm:[178,10,1,""],start_color:[178,10,1,""],termattrs:[178,10,1,""],termname:[178,10,1,""],textpad:[178,9,0,"-"],tigetflag:[178,10,1,""],tigetnum:[178,10,1,""],tigetstr:[178,10,1,""],tparm:[178,10,1,""],typeahead:[178,10,1,""],unctrl:[178,10,1,""],unget_wch:[178,10,1,""],ungetch:[178,10,1,""],ungetmouse:[178,10,1,""],update_lines_cols:[178,10,1,""],use_default_colors:[178,10,1,""],use_env:[178,10,1,""],version:[178,8,1,""],wrapper:[178,10,1,""]},dataclasses:{Field:[182,11,1,""],FrozenInstanceError:[182,5,1,""],asdict:[182,10,1,""],astuple:[182,10,1,""],dataclass:[182,10,1,""],field:[182,10,1,""],fields:[182,10,1,""],is_dataclass:[182,10,1,""],make_dataclass:[182,10,1,""],replace:[182,10,1,""]},datetime:{MAXYEAR:[184,8,1,""],MINYEAR:[184,8,1,""],date:[184,11,1,""],datetime:[184,11,1,""],time:[184,11,1,""],timedelta:[184,11,1,""],timezone:[184,11,1,""],tzinfo:[184,11,1,""]},dbm:{dumb:[185,9,0,"-"],error:[185,5,1,""],gnu:[185,9,0,"-"],ndbm:[185,9,0,"-"],open:[185,10,1,""],whichdb:[185,10,1,""]},decimal:{BasicContext:[187,11,1,""],Clamped:[187,11,1,""],Context:[187,11,1,""],Decimal:[187,11,1,""],DecimalException:[187,11,1,""],DefaultContext:[187,11,1,""],DivisionByZero:[187,11,1,""],ExtendedContext:[187,11,1,""],FloatOperation:[187,11,1,""],HAVE_THREADS:[187,8,1,""],Inexact:[187,11,1,""],InvalidOperation:[187,11,1,""],MAX_EMAX:[187,8,1,""],MAX_PREC:[187,8,1,""],MIN_EMIN:[187,8,1,""],MIN_ETINY:[187,8,1,""],Overflow:[187,11,1,""],ROUND_05UP:[187,8,1,""],ROUND_CEILING:[187,8,1,""],ROUND_DOWN:[187,8,1,""],ROUND_FLOOR:[187,8,1,""],ROUND_HALF_DOWN:[187,8,1,""],ROUND_HALF_EVEN:[187,8,1,""],ROUND_HALF_UP:[187,8,1,""],ROUND_UP:[187,8,1,""],Rounded:[187,11,1,""],Subnormal:[187,11,1,""],Underflow:[187,11,1,""],getcontext:[187,10,1,""],localcontext:[187,10,1,""],setcontext:[187,10,1,""]},definition:{__name__:[346,6,1,""],__qualname__:[346,6,1,""]},dict:{clear:[346,7,1,""],copy:[346,7,1,""],fromkeys:[346,12,1,""],get:[346,7,1,""],items:[346,7,1,""],keys:[346,7,1,""],pop:[346,7,1,""],popitem:[346,7,1,""],setdefault:[346,7,1,""],update:[346,7,1,""],values:[346,7,1,""]},difflib:{Differ:[189,11,1,""],HtmlDiff:[189,11,1,""],IS_CHARACTER_JUNK:[189,10,1,""],IS_LINE_JUNK:[189,10,1,""],SequenceMatcher:[189,11,1,""],context_diff:[189,10,1,""],diff_bytes:[189,10,1,""],get_close_matches:[189,10,1,""],ndiff:[189,10,1,""],restore:[189,10,1,""],unified_diff:[189,10,1,""]},dis:{Bytecode:[190,11,1,""],Instruction:[190,11,1,""],cmp_op:[190,8,1,""],code_info:[190,10,1,""],dis:[190,10,1,""],disassemble:[190,10,1,""],disco:[190,10,1,""],distb:[190,10,1,""],findlabels:[190,10,1,""],findlinestarts:[190,10,1,""],get_instructions:[190,10,1,""],hascompare:[190,8,1,""],hasconst:[190,8,1,""],hasfree:[190,8,1,""],hasjabs:[190,8,1,""],hasjrel:[190,8,1,""],haslocal:[190,8,1,""],hasname:[190,8,1,""],opmap:[190,8,1,""],opname:[190,8,1,""],show_code:[190,10,1,""],stack_effect:[190,10,1,""]},distutils:{archive_util:[65,9,0,"-"],bcppcompiler:[65,9,0,"-"],ccompiler:[65,9,0,"-"],cmd:[65,9,0,"-"],command:[65,9,0,"-"],core:[65,9,0,"-"],cygwinccompiler:[65,9,0,"-"],debug:[65,9,0,"-"],dep_util:[65,9,0,"-"],dir_util:[65,9,0,"-"],dist:[65,9,0,"-"],errors:[65,9,0,"-"],extension:[65,9,0,"-"],fancy_getopt:[65,9,0,"-"],file_util:[65,9,0,"-"],filelist:[65,9,0,"-"],log:[65,9,0,"-"],msvccompiler:[65,9,0,"-"],spawn:[65,9,0,"-"],sysconfig:[65,9,0,"-"],text_file:[65,9,0,"-"],unixccompiler:[65,9,0,"-"],util:[65,9,0,"-"],version:[65,9,0,"-"]},doctest:{COMPARISON_FLAGS:[193,8,1,""],DONT_ACCEPT_BLANKLINE:[193,8,1,""],DONT_ACCEPT_TRUE_FOR_1:[193,8,1,""],DebugRunner:[193,11,1,""],DocFileSuite:[193,10,1,""],DocTest:[193,11,1,""],DocTestFailure:[193,5,1,""],DocTestFinder:[193,11,1,""],DocTestParser:[193,11,1,""],DocTestRunner:[193,11,1,""],DocTestSuite:[193,10,1,""],ELLIPSIS:[193,8,1,""],Example:[193,11,1,""],FAIL_FAST:[193,8,1,""],IGNORE_EXCEPTION_DETAIL:[193,8,1,""],NORMALIZE_WHITESPACE:[193,8,1,""],OutputChecker:[193,11,1,""],REPORTING_FLAGS:[193,8,1,""],REPORT_CDIFF:[193,8,1,""],REPORT_NDIFF:[193,8,1,""],REPORT_ONLY_FIRST_FAILURE:[193,8,1,""],REPORT_UDIFF:[193,8,1,""],SKIP:[193,8,1,""],UnexpectedException:[193,5,1,""],debug:[193,10,1,""],debug_src:[193,10,1,""],register_optionflag:[193,10,1,""],run_docstring_examples:[193,10,1,""],script_from_examples:[193,10,1,""],set_unittest_reportflags:[193,10,1,""],testfile:[193,10,1,""],testmod:[193,10,1,""],testsource:[193,10,1,""]},email:{charset:[196,9,0,"-"],contentmanager:[198,9,0,"-"],encoders:[199,9,0,"-"],errors:[200,9,0,"-"],generator:[202,9,0,"-"],header:[203,9,0,"-"],headerregistry:[204,9,0,"-"],iterators:[205,9,0,"-"],message:[206,9,0,"-"],message_from_binary_file:[208,10,1,""],message_from_bytes:[208,10,1,""],message_from_file:[208,10,1,""],message_from_string:[208,10,1,""],mime:[207,9,0,"-"],parser:[208,9,0,"-"],policy:[209,9,0,"-"],utils:[210,9,0,"-"]},encodings:{idna:[159,9,0,"-"],mbcs:[159,9,0,"-"],utf_8_sig:[159,9,0,"-"]},ensurepip:{bootstrap:[211,10,1,""],version:[211,10,1,""]},errno:{E2BIG:[213,8,1,""],EACCES:[213,8,1,""],EADDRINUSE:[213,8,1,""],EADDRNOTAVAIL:[213,8,1,""],EADV:[213,8,1,""],EAFNOSUPPORT:[213,8,1,""],EAGAIN:[213,8,1,""],EALREADY:[213,8,1,""],EBADE:[213,8,1,""],EBADF:[213,8,1,""],EBADFD:[213,8,1,""],EBADMSG:[213,8,1,""],EBADR:[213,8,1,""],EBADRQC:[213,8,1,""],EBADSLT:[213,8,1,""],EBFONT:[213,8,1,""],EBUSY:[213,8,1,""],ECHILD:[213,8,1,""],ECHRNG:[213,8,1,""],ECOMM:[213,8,1,""],ECONNABORTED:[213,8,1,""],ECONNREFUSED:[213,8,1,""],ECONNRESET:[213,8,1,""],EDEADLK:[213,8,1,""],EDEADLOCK:[213,8,1,""],EDESTADDRREQ:[213,8,1,""],EDOM:[213,8,1,""],EDOTDOT:[213,8,1,""],EDQUOT:[213,8,1,""],EEXIST:[213,8,1,""],EFAULT:[213,8,1,""],EFBIG:[213,8,1,""],EHOSTDOWN:[213,8,1,""],EHOSTUNREACH:[213,8,1,""],EIDRM:[213,8,1,""],EILSEQ:[213,8,1,""],EINPROGRESS:[213,8,1,""],EINTR:[213,8,1,""],EINVAL:[213,8,1,""],EIO:[213,8,1,""],EISCONN:[213,8,1,""],EISDIR:[213,8,1,""],EISNAM:[213,8,1,""],EL2HLT:[213,8,1,""],EL2NSYNC:[213,8,1,""],EL3HLT:[213,8,1,""],EL3RST:[213,8,1,""],ELIBACC:[213,8,1,""],ELIBBAD:[213,8,1,""],ELIBEXEC:[213,8,1,""],ELIBMAX:[213,8,1,""],ELIBSCN:[213,8,1,""],ELNRNG:[213,8,1,""],ELOOP:[213,8,1,""],EMFILE:[213,8,1,""],EMLINK:[213,8,1,""],EMSGSIZE:[213,8,1,""],EMULTIHOP:[213,8,1,""],ENAMETOOLONG:[213,8,1,""],ENAVAIL:[213,8,1,""],ENETDOWN:[213,8,1,""],ENETRESET:[213,8,1,""],ENETUNREACH:[213,8,1,""],ENFILE:[213,8,1,""],ENOANO:[213,8,1,""],ENOBUFS:[213,8,1,""],ENOCSI:[213,8,1,""],ENODATA:[213,8,1,""],ENODEV:[213,8,1,""],ENOENT:[213,8,1,""],ENOEXEC:[213,8,1,""],ENOLCK:[213,8,1,""],ENOLINK:[213,8,1,""],ENOMEM:[213,8,1,""],ENOMSG:[213,8,1,""],ENONET:[213,8,1,""],ENOPKG:[213,8,1,""],ENOPROTOOPT:[213,8,1,""],ENOSPC:[213,8,1,""],ENOSR:[213,8,1,""],ENOSTR:[213,8,1,""],ENOSYS:[213,8,1,""],ENOTBLK:[213,8,1,""],ENOTCONN:[213,8,1,""],ENOTDIR:[213,8,1,""],ENOTEMPTY:[213,8,1,""],ENOTNAM:[213,8,1,""],ENOTSOCK:[213,8,1,""],ENOTTY:[213,8,1,""],ENOTUNIQ:[213,8,1,""],ENXIO:[213,8,1,""],EOPNOTSUPP:[213,8,1,""],EOVERFLOW:[213,8,1,""],EPERM:[213,8,1,""],EPFNOSUPPORT:[213,8,1,""],EPIPE:[213,8,1,""],EPROTO:[213,8,1,""],EPROTONOSUPPORT:[213,8,1,""],EPROTOTYPE:[213,8,1,""],ERANGE:[213,8,1,""],EREMCHG:[213,8,1,""],EREMOTE:[213,8,1,""],EREMOTEIO:[213,8,1,""],ERESTART:[213,8,1,""],EROFS:[213,8,1,""],ESHUTDOWN:[213,8,1,""],ESOCKTNOSUPPORT:[213,8,1,""],ESPIPE:[213,8,1,""],ESRCH:[213,8,1,""],ESRMNT:[213,8,1,""],ESTALE:[213,8,1,""],ESTRPIPE:[213,8,1,""],ETIME:[213,8,1,""],ETIMEDOUT:[213,8,1,""],ETOOMANYREFS:[213,8,1,""],ETXTBSY:[213,8,1,""],EUCLEAN:[213,8,1,""],EUNATCH:[213,8,1,""],EUSERS:[213,8,1,""],EWOULDBLOCK:[213,8,1,""],EXDEV:[213,8,1,""],EXFULL:[213,8,1,""],errorcode:[213,8,1,""]},faulthandler:{cancel_dump_traceback_later:[215,10,1,""],disable:[215,10,1,""],dump_traceback:[215,10,1,""],dump_traceback_later:[215,10,1,""],enable:[215,10,1,""],is_enabled:[215,10,1,""],register:[215,10,1,""],unregister:[215,10,1,""]},fcntl:{fcntl:[216,10,1,""],flock:[216,10,1,""],ioctl:[216,10,1,""],lockf:[216,10,1,""]},filecmp:{DEFAULT_IGNORES:[217,6,1,""],clear_cache:[217,10,1,""],cmp:[217,10,1,""],cmpfiles:[217,10,1,""],dircmp:[217,11,1,""]},fileinput:{FileInput:[219,11,1,""],close:[219,10,1,""],filelineno:[219,10,1,""],filename:[219,10,1,""],fileno:[219,10,1,""],hook_compressed:[219,10,1,""],hook_encoded:[219,10,1,""],input:[219,10,1,""],isfirstline:[219,10,1,""],isstdin:[219,10,1,""],lineno:[219,10,1,""],nextfile:[219,10,1,""]},fnmatch:{filter:[221,10,1,""],fnmatch:[221,10,1,""],fnmatchcase:[221,10,1,""],translate:[221,10,1,""]},formatter:{AS_IS:[222,8,1,""],AbstractFormatter:[222,11,1,""],AbstractWriter:[222,11,1,""],DumbWriter:[222,11,1,""],NullFormatter:[222,11,1,""],NullWriter:[222,11,1,""]},fractions:{Fraction:[223,11,1,""],gcd:[223,10,1,""]},frame:{clear:[424,7,1,""]},frozenset:{add:[346,7,1,""],clear:[346,7,1,""],copy:[346,7,1,""],difference:[346,7,1,""],difference_update:[346,7,1,""],discard:[346,7,1,""],intersection:[346,7,1,""],intersection_update:[346,7,1,""],isdisjoint:[346,7,1,""],issubset:[346,7,1,""],issuperset:[346,7,1,""],pop:[346,7,1,""],remove:[346,7,1,""],symmetric_difference:[346,7,1,""],symmetric_difference_update:[346,7,1,""],union:[346,7,1,""],update:[346,7,1,""]},ftplib:{FTP:[225,11,1,""],FTP_TLS:[225,11,1,""],all_errors:[225,8,1,""],error_perm:[225,5,1,""],error_proto:[225,5,1,""],error_reply:[225,5,1,""],error_temp:[225,5,1,""]},functools:{cmp_to_key:[228,10,1,""],lru_cache:[228,10,1,""],partial:[228,10,1,""],partialmethod:[228,11,1,""],reduce:[228,10,1,""],singledispatch:[228,10,1,""],total_ordering:[228,10,1,""],update_wrapper:[228,10,1,""],wraps:[228,10,1,""]},gc:{DEBUG_COLLECTABLE:[229,8,1,""],DEBUG_LEAK:[229,8,1,""],DEBUG_SAVEALL:[229,8,1,""],DEBUG_STATS:[229,8,1,""],DEBUG_UNCOLLECTABLE:[229,8,1,""],callbacks:[229,8,1,""],collect:[229,10,1,""],disable:[229,10,1,""],enable:[229,10,1,""],freeze:[229,10,1,""],garbage:[229,8,1,""],get_count:[229,10,1,""],get_debug:[229,10,1,""],get_freeze_count:[229,10,1,""],get_objects:[229,10,1,""],get_referents:[229,10,1,""],get_referrers:[229,10,1,""],get_stats:[229,10,1,""],get_threshold:[229,10,1,""],is_tracked:[229,10,1,""],isenabled:[229,10,1,""],set_debug:[229,10,1,""],set_threshold:[229,10,1,""],unfreeze:[229,10,1,""]},generator:{"throw":[426,7,1,""],__next__:[426,7,1,""],close:[426,7,1,""],send:[426,7,1,""]},getopt:{GetoptError:[230,5,1,""],error:[230,5,1,""],getopt:[230,10,1,""],gnu_getopt:[230,10,1,""]},getpass:{GetPassWarning:[231,5,1,""],getpass:[231,10,1,""],getuser:[231,10,1,""]},gettext:{GNUTranslations:[232,11,1,""],NullTranslations:[232,11,1,""],bind_textdomain_codeset:[232,10,1,""],bindtextdomain:[232,10,1,""],dgettext:[232,10,1,""],dngettext:[232,10,1,""],find:[232,10,1,""],gettext:[232,10,1,""],install:[232,10,1,""],ldgettext:[232,10,1,""],ldngettext:[232,10,1,""],lgettext:[232,10,1,""],lngettext:[232,10,1,""],ngettext:[232,10,1,""],textdomain:[232,10,1,""],translation:[232,10,1,""]},glob:{escape:[233,10,1,""],glob:[233,10,1,""],iglob:[233,10,1,""]},grp:{getgrall:[234,10,1,""],getgrgid:[234,10,1,""],getgrnam:[234,10,1,""]},gzip:{GzipFile:[235,11,1,""],compress:[235,10,1,""],decompress:[235,10,1,""],open:[235,10,1,""]},hashlib:{"new":[236,10,1,""],algorithms_available:[236,8,1,""],algorithms_guaranteed:[236,8,1,""],blake2b:[236,10,1,""],blake2s:[236,10,1,""],pbkdf2_hmac:[236,10,1,""],scrypt:[236,10,1,""]},heapq:{heapify:[237,10,1,""],heappop:[237,10,1,""],heappush:[237,10,1,""],heappushpop:[237,10,1,""],heapreplace:[237,10,1,""],merge:[237,10,1,""],nlargest:[237,10,1,""],nsmallest:[237,10,1,""]},hmac:{"new":[238,10,1,""],compare_digest:[238,10,1,""],digest:[238,10,1,""]},html:{entities:[240,9,0,"-"],escape:[239,10,1,""],parser:[241,9,0,"-"],unescape:[239,10,1,""]},http:{HTTPStatus:[242,11,1,""],client:[243,9,0,"-"],cookiejar:[244,9,0,"-"],cookies:[245,9,0,"-"],server:[246,9,0,"-"]},imaplib:{IMAP4:[249,11,1,""],IMAP4_SSL:[249,11,1,""],IMAP4_stream:[249,11,1,""],Int2AP:[249,10,1,""],Internaldate2tuple:[249,10,1,""],ParseFlags:[249,10,1,""],Time2Internaldate:[249,10,1,""]},imghdr:{tests:[250,8,1,""],what:[250,10,1,""]},imp:{C_BUILTIN:[251,8,1,""],C_EXTENSION:[251,8,1,""],NullImporter:[251,11,1,""],PKG_DIRECTORY:[251,8,1,""],PY_COMPILED:[251,8,1,""],PY_FROZEN:[251,8,1,""],PY_SOURCE:[251,8,1,""],acquire_lock:[251,10,1,""],cache_from_source:[251,10,1,""],find_module:[251,10,1,""],get_magic:[251,10,1,""],get_suffixes:[251,10,1,""],get_tag:[251,10,1,""],load_module:[251,10,1,""],lock_held:[251,10,1,""],new_module:[251,10,1,""],release_lock:[251,10,1,""],reload:[251,10,1,""],source_from_cache:[251,10,1,""]},importlib:{__import__:[252,10,1,""],abc:[252,9,0,"-"],find_loader:[252,10,1,""],import_module:[252,10,1,""],invalidate_caches:[252,10,1,""],machinery:[252,9,0,"-"],reload:[252,10,1,""],resources:[252,9,0,"-"],util:[252,9,0,"-"]},inspect:{"--details":[254,15,1,"cmdoption-inspect-details"],BoundArguments:[254,11,1,""],CO_ASYNC_GENERATOR:[254,8,1,""],CO_COROUTINE:[254,8,1,""],CO_GENERATOR:[254,8,1,""],CO_ITERABLE_COROUTINE:[254,8,1,""],CO_NESTED:[254,8,1,""],CO_NEWLOCALS:[254,8,1,""],CO_NOFREE:[254,8,1,""],CO_OPTIMIZED:[254,8,1,""],CO_VARARGS:[254,8,1,""],CO_VARKEYWORDS:[254,8,1,""],Parameter:[254,11,1,""],Signature:[254,11,1,""],cleandoc:[254,10,1,""],currentframe:[254,10,1,""],formatargspec:[254,10,1,""],formatargvalues:[254,10,1,""],getargspec:[254,10,1,""],getargvalues:[254,10,1,""],getattr_static:[254,10,1,""],getcallargs:[254,10,1,""],getclasstree:[254,10,1,""],getclosurevars:[254,10,1,""],getcomments:[254,10,1,""],getcoroutinelocals:[254,10,1,""],getcoroutinestate:[254,10,1,""],getdoc:[254,10,1,""],getfile:[254,10,1,""],getframeinfo:[254,10,1,""],getfullargspec:[254,10,1,""],getgeneratorlocals:[254,10,1,""],getgeneratorstate:[254,10,1,""],getinnerframes:[254,10,1,""],getmembers:[254,10,1,""],getmodule:[254,10,1,""],getmodulename:[254,10,1,""],getmro:[254,10,1,""],getouterframes:[254,10,1,""],getsource:[254,10,1,""],getsourcefile:[254,10,1,""],getsourcelines:[254,10,1,""],isabstract:[254,10,1,""],isasyncgen:[254,10,1,""],isasyncgenfunction:[254,10,1,""],isawaitable:[254,10,1,""],isbuiltin:[254,10,1,""],isclass:[254,10,1,""],iscode:[254,10,1,""],iscoroutine:[254,10,1,""],iscoroutinefunction:[254,10,1,""],isdatadescriptor:[254,10,1,""],isframe:[254,10,1,""],isfunction:[254,10,1,""],isgenerator:[254,10,1,""],isgeneratorfunction:[254,10,1,""],isgetsetdescriptor:[254,10,1,""],ismemberdescriptor:[254,10,1,""],ismethod:[254,10,1,""],ismethoddescriptor:[254,10,1,""],ismodule:[254,10,1,""],isroutine:[254,10,1,""],istraceback:[254,10,1,""],signature:[254,10,1,""],stack:[254,10,1,""],trace:[254,10,1,""],unwrap:[254,10,1,""]},instance:{__class__:[346,6,1,""]},io:{BlockingIOError:[257,5,1,""],BufferedIOBase:[257,11,1,""],BufferedRWPair:[257,11,1,""],BufferedRandom:[257,11,1,""],BufferedReader:[257,11,1,""],BufferedWriter:[257,11,1,""],BytesIO:[257,11,1,""],DEFAULT_BUFFER_SIZE:[257,8,1,""],FileIO:[257,11,1,""],IOBase:[257,11,1,""],IncrementalNewlineDecoder:[257,11,1,""],RawIOBase:[257,11,1,""],StringIO:[257,11,1,""],TextIOBase:[257,11,1,""],TextIOWrapper:[257,11,1,""],UnsupportedOperation:[257,5,1,""],open:[257,10,1,""]},ipaddress:{AddressValueError:[258,5,1,""],IPv4Address:[258,11,1,""],IPv4Interface:[258,11,1,""],IPv4Network:[258,11,1,""],IPv6Address:[258,11,1,""],IPv6Interface:[258,11,1,""],IPv6Network:[258,11,1,""],NetmaskValueError:[258,5,1,""],collapse_addresses:[258,10,1,""],get_mixed_type_key:[258,10,1,""],ip_address:[258,10,1,""],ip_interface:[258,10,1,""],ip_network:[258,10,1,""],summarize_address_range:[258,10,1,""],v4_int_to_packed:[258,10,1,""],v6_int_to_packed:[258,10,1,""]},iterator:{__iter__:[346,7,1,""],__next__:[346,7,1,""]},itertools:{accumulate:[260,10,1,""],chain:[260,10,1,""],combinations:[260,10,1,""],combinations_with_replacement:[260,10,1,""],compress:[260,10,1,""],count:[260,10,1,""],cycle:[260,10,1,""],dropwhile:[260,10,1,""],filterfalse:[260,10,1,""],groupby:[260,10,1,""],islice:[260,10,1,""],permutations:[260,10,1,""],product:[260,10,1,""],repeat:[260,10,1,""],starmap:[260,10,1,""],takewhile:[260,10,1,""],tee:[260,10,1,""],zip_longest:[260,10,1,""]},json:{JSONDecodeError:[261,5,1,""],JSONDecoder:[261,11,1,""],JSONEncoder:[261,11,1,""],dump:[261,10,1,""],dumps:[261,10,1,""],load:[261,10,1,""],loads:[261,10,1,""],tool:[261,9,0,"-"]},keyword:{iskeyword:[262,10,1,""],kwlist:[262,8,1,""]},linecache:{checkcache:[264,10,1,""],clearcache:[264,10,1,""],getline:[264,10,1,""],lazycache:[264,10,1,""]},list:{sort:[346,7,1,""]},locale:{ALT_DIGITS:[265,8,1,""],CHAR_MAX:[265,8,1,""],CODESET:[265,8,1,""],CRNCYSTR:[265,8,1,""],D_FMT:[265,8,1,""],D_T_FMT:[265,8,1,""],ERA:[265,8,1,""],ERA_D_FMT:[265,8,1,""],ERA_D_T_FMT:[265,8,1,""],ERA_T_FMT:[265,8,1,""],Error:[265,5,1,""],LC_ALL:[265,8,1,""],LC_COLLATE:[265,8,1,""],LC_CTYPE:[265,8,1,""],LC_MESSAGES:[265,8,1,""],LC_MONETARY:[265,8,1,""],LC_NUMERIC:[265,8,1,""],LC_TIME:[265,8,1,""],NOEXPR:[265,8,1,""],RADIXCHAR:[265,8,1,""],THOUSEP:[265,8,1,""],T_FMT:[265,8,1,""],T_FMT_AMPM:[265,8,1,""],YESEXPR:[265,8,1,""],atof:[265,10,1,""],atoi:[265,10,1,""],bindtextdomain:[265,10,1,""],currency:[265,10,1,""],dcgettext:[265,10,1,""],delocalize:[265,10,1,""],dgettext:[265,10,1,""],format:[265,10,1,""],format_string:[265,10,1,""],getdefaultlocale:[265,10,1,""],getlocale:[265,10,1,""],getpreferredencoding:[265,10,1,""],gettext:[265,10,1,""],localeconv:[265,10,1,""],nl_langinfo:[265,10,1,""],normalize:[265,10,1,""],resetlocale:[265,10,1,""],setlocale:[265,10,1,""],str:[265,10,1,""],strcoll:[265,10,1,""],strxfrm:[265,10,1,""],textdomain:[265,10,1,""]},logging:{FileHandler:[268,11,1,""],Filter:[266,11,1,""],Formatter:[266,11,1,""],Handler:[266,11,1,""],LogRecord:[266,11,1,""],Logger:[266,11,1,""],LoggerAdapter:[266,11,1,""],NullHandler:[268,11,1,""],StreamHandler:[268,11,1,""],addLevelName:[266,10,1,""],basicConfig:[266,10,1,""],captureWarnings:[266,10,1,""],config:[267,9,0,"-"],critical:[266,10,1,""],debug:[266,10,1,""],disable:[266,10,1,""],error:[266,10,1,""],exception:[266,10,1,""],getLevelName:[266,10,1,""],getLogRecordFactory:[266,10,1,""],getLogger:[266,10,1,""],getLoggerClass:[266,10,1,""],handlers:[268,9,0,"-"],info:[266,10,1,""],lastResort:[266,6,1,""],log:[266,10,1,""],makeLogRecord:[266,10,1,""],setLogRecordFactory:[266,10,1,""],setLoggerClass:[266,10,1,""],shutdown:[266,10,1,""],warning:[266,10,1,""]},lzma:{LZMACompressor:[269,11,1,""],LZMADecompressor:[269,11,1,""],LZMAError:[269,5,1,""],LZMAFile:[269,11,1,""],compress:[269,10,1,""],decompress:[269,10,1,""],is_check_supported:[269,10,1,""],open:[269,10,1,""]},mailbox:{Babyl:[271,11,1,""],BabylMessage:[271,11,1,""],Error:[271,5,1,""],ExternalClashError:[271,5,1,""],FormatError:[271,5,1,""],MH:[271,11,1,""],MHMessage:[271,11,1,""],MMDF:[271,11,1,""],MMDFMessage:[271,11,1,""],Mailbox:[271,11,1,""],Maildir:[271,11,1,""],MaildirMessage:[271,11,1,""],Message:[271,11,1,""],NoSuchMailboxError:[271,5,1,""],NotEmptyError:[271,5,1,""],mbox:[271,11,1,""],mboxMessage:[271,11,1,""]},mailcap:{findmatch:[272,10,1,""],getcaps:[272,10,1,""]},marshal:{dump:[274,10,1,""],dumps:[274,10,1,""],load:[274,10,1,""],loads:[274,10,1,""],version:[274,8,1,""]},math:{acos:[275,10,1,""],acosh:[275,10,1,""],asin:[275,10,1,""],asinh:[275,10,1,""],atan2:[275,10,1,""],atan:[275,10,1,""],atanh:[275,10,1,""],ceil:[275,10,1,""],copysign:[275,10,1,""],cos:[275,10,1,""],cosh:[275,10,1,""],degrees:[275,10,1,""],e:[275,8,1,""],erf:[275,10,1,""],erfc:[275,10,1,""],exp:[275,10,1,""],expm1:[275,10,1,""],fabs:[275,10,1,""],factorial:[275,10,1,""],floor:[275,10,1,""],fmod:[275,10,1,""],frexp:[275,10,1,""],fsum:[275,10,1,""],gamma:[275,10,1,""],gcd:[275,10,1,""],hypot:[275,10,1,""],inf:[275,8,1,""],isclose:[275,10,1,""],isfinite:[275,10,1,""],isinf:[275,10,1,""],isnan:[275,10,1,""],ldexp:[275,10,1,""],lgamma:[275,10,1,""],log10:[275,10,1,""],log1p:[275,10,1,""],log2:[275,10,1,""],log:[275,10,1,""],modf:[275,10,1,""],nan:[275,8,1,""],pi:[275,8,1,""],pow:[275,10,1,""],radians:[275,10,1,""],remainder:[275,10,1,""],sin:[275,10,1,""],sinh:[275,10,1,""],sqrt:[275,10,1,""],tan:[275,10,1,""],tanh:[275,10,1,""],tau:[275,8,1,""],trunc:[275,10,1,""]},memoryview:{__eq__:[346,7,1,""],c_contiguous:[346,6,1,""],cast:[346,7,1,""],contiguous:[346,6,1,""],f_contiguous:[346,6,1,""],format:[346,6,1,""],hex:[346,7,1,""],itemsize:[346,6,1,""],nbytes:[346,6,1,""],ndim:[346,6,1,""],obj:[346,6,1,""],readonly:[346,6,1,""],release:[346,7,1,""],shape:[346,6,1,""],strides:[346,6,1,""],suboffsets:[346,6,1,""],tobytes:[346,7,1,""],tolist:[346,7,1,""]},mimetypes:{MimeTypes:[276,11,1,""],add_type:[276,10,1,""],common_types:[276,8,1,""],encodings_map:[276,8,1,""],guess_all_extensions:[276,10,1,""],guess_extension:[276,10,1,""],guess_type:[276,10,1,""],init:[276,10,1,""],inited:[276,8,1,""],knownfiles:[276,8,1,""],read_mime_types:[276,10,1,""],suffix_map:[276,8,1,""],types_map:[276,8,1,""]},mmap:{mmap:[279,11,1,""]},modulefinder:{AddPackagePath:[280,10,1,""],ModuleFinder:[280,11,1,""],ReplacePackage:[280,10,1,""]},msilib:{Binary:[282,11,1,""],CAB:[282,11,1,""],Control:[282,11,1,""],CreateRecord:[282,10,1,""],Dialog:[282,11,1,""],Directory:[282,11,1,""],FCICreate:[282,10,1,""],Feature:[282,11,1,""],OpenDatabase:[282,10,1,""],RadioButtonGroup:[282,11,1,""],UuidCreate:[282,10,1,""],add_data:[282,10,1,""],add_stream:[282,10,1,""],add_tables:[282,10,1,""],gen_uuid:[282,10,1,""],init_database:[282,10,1,""],schema:[282,8,1,""],sequence:[282,8,1,""],text:[282,8,1,""]},msvcrt:{LK_LOCK:[283,8,1,""],LK_NBLCK:[283,8,1,""],LK_NBRLCK:[283,8,1,""],LK_RLCK:[283,8,1,""],LK_UNLCK:[283,8,1,""],get_osfhandle:[283,10,1,""],getch:[283,10,1,""],getche:[283,10,1,""],getwch:[283,10,1,""],getwche:[283,10,1,""],heapmin:[283,10,1,""],kbhit:[283,10,1,""],locking:[283,10,1,""],open_osfhandle:[283,10,1,""],putch:[283,10,1,""],putwch:[283,10,1,""],setmode:[283,10,1,""],ungetch:[283,10,1,""],ungetwch:[283,10,1,""]},multiprocessing:{Array:[284,10,1,""],AuthenticationError:[284,5,1,""],Barrier:[284,11,1,""],BoundedSemaphore:[284,11,1,""],BufferTooShort:[284,5,1,""],Condition:[284,11,1,""],Event:[284,11,1,""],JoinableQueue:[284,11,1,""],Lock:[284,11,1,""],Pipe:[284,10,1,""],Process:[284,11,1,""],ProcessError:[284,5,1,""],Queue:[284,11,1,""],RLock:[284,11,1,""],Semaphore:[284,11,1,""],SimpleQueue:[284,11,1,""],TimeoutError:[284,5,1,""],Value:[284,10,1,""],active_children:[284,10,1,""],connection:[284,9,0,"-"],cpu_count:[284,10,1,""],current_process:[284,10,1,""],dummy:[284,9,0,"-"],freeze_support:[284,10,1,""],get_all_start_methods:[284,10,1,""],get_context:[284,10,1,""],get_logger:[284,10,1,""],get_start_method:[284,10,1,""],log_to_stderr:[284,10,1,""],managers:[284,9,0,"-"],pool:[284,9,0,"-"],set_executable:[284,10,1,""],set_start_method:[284,10,1,""],sharedctypes:[284,9,0,"-"]},netrc:{NetrcParseError:[286,5,1,""],netrc:[286,11,1,""]},nis:{cat:[287,10,1,""],error:[287,5,1,""],get_default_domain:[287,10,1,""],maps:[287,10,1,""],match:[287,10,1,""]},nntplib:{NNTP:[288,11,1,""],NNTPDataError:[288,5,1,""],NNTPError:[288,5,1,""],NNTPPermanentError:[288,5,1,""],NNTPProtocolError:[288,5,1,""],NNTPReplyError:[288,5,1,""],NNTPTemporaryError:[288,5,1,""],NNTP_SSL:[288,11,1,""],decode_header:[288,10,1,""]},numbers:{Complex:[289,11,1,""],Integral:[289,11,1,""],Number:[289,11,1,""],Rational:[289,11,1,""],Real:[289,11,1,""]},object:{__abs__:[424,7,1,""],__add__:[424,7,1,""],__aenter__:[424,7,1,""],__aexit__:[424,7,1,""],__aiter__:[424,7,1,""],__and__:[424,7,1,""],__anext__:[424,7,1,""],__await__:[424,7,1,""],__bool__:[424,7,1,""],__bytes__:[424,7,1,""],__call__:[424,7,1,""],__ceil__:[424,7,1,""],__class_getitem__:[424,12,1,""],__complex__:[424,7,1,""],__contains__:[424,7,1,""],__del__:[424,7,1,""],__delattr__:[424,7,1,""],__delete__:[424,7,1,""],__delitem__:[424,7,1,""],__dict__:[346,6,1,""],__dir__:[424,7,1,""],__divmod__:[424,7,1,""],__enter__:[424,7,1,""],__eq__:[424,7,1,""],__exit__:[424,7,1,""],__float__:[424,7,1,""],__floor__:[424,7,1,""],__floordiv__:[424,7,1,""],__format__:[424,7,1,""],__ge__:[424,7,1,""],__get__:[424,7,1,""],__getattr__:[424,7,1,""],__getattribute__:[424,7,1,""],__getitem__:[424,7,1,""],__getnewargs__:[301,7,1,""],__getnewargs_ex__:[301,7,1,""],__getstate__:[301,7,1,""],__gt__:[424,7,1,""],__hash__:[424,7,1,""],__iadd__:[424,7,1,""],__iand__:[424,7,1,""],__ifloordiv__:[424,7,1,""],__ilshift__:[424,7,1,""],__imatmul__:[424,7,1,""],__imod__:[424,7,1,""],__imul__:[424,7,1,""],__index__:[424,7,1,""],__init__:[424,7,1,""],__init_subclass__:[424,12,1,""],__int__:[424,7,1,""],__invert__:[424,7,1,""],__ior__:[424,7,1,""],__ipow__:[424,7,1,""],__irshift__:[424,7,1,""],__isub__:[424,7,1,""],__iter__:[424,7,1,""],__itruediv__:[424,7,1,""],__ixor__:[424,7,1,""],__le__:[424,7,1,""],__len__:[424,7,1,""],__length_hint__:[424,7,1,""],__lshift__:[424,7,1,""],__lt__:[424,7,1,""],__matmul__:[424,7,1,""],__missing__:[424,7,1,""],__mod__:[424,7,1,""],__mul__:[424,7,1,""],__ne__:[424,7,1,""],__neg__:[424,7,1,""],__new__:[424,7,1,""],__or__:[424,7,1,""],__pos__:[424,7,1,""],__pow__:[424,7,1,""],__radd__:[424,7,1,""],__rand__:[424,7,1,""],__rdivmod__:[424,7,1,""],__reduce__:[301,7,1,""],__reduce_ex__:[301,7,1,""],__repr__:[424,7,1,""],__reversed__:[424,7,1,""],__rfloordiv__:[424,7,1,""],__rlshift__:[424,7,1,""],__rmatmul__:[424,7,1,""],__rmod__:[424,7,1,""],__rmul__:[424,7,1,""],__ror__:[424,7,1,""],__round__:[424,7,1,""],__rpow__:[424,7,1,""],__rrshift__:[424,7,1,""],__rshift__:[424,7,1,""],__rsub__:[424,7,1,""],__rtruediv__:[424,7,1,""],__rxor__:[424,7,1,""],__set__:[424,7,1,""],__set_name__:[424,7,1,""],__setattr__:[424,7,1,""],__setitem__:[424,7,1,""],__setstate__:[301,7,1,""],__slots__:[424,8,1,""],__str__:[424,7,1,""],__sub__:[424,7,1,""],__truediv__:[424,7,1,""],__trunc__:[424,7,1,""],__xor__:[424,7,1,""]},operator:{__abs__:[291,10,1,""],__add__:[291,10,1,""],__and__:[291,10,1,""],__concat__:[291,10,1,""],__contains__:[291,10,1,""],__delitem__:[291,10,1,""],__eq__:[291,10,1,""],__floordiv__:[291,10,1,""],__ge__:[291,10,1,""],__getitem__:[291,10,1,""],__gt__:[291,10,1,""],__iadd__:[291,10,1,""],__iand__:[291,10,1,""],__iconcat__:[291,10,1,""],__ifloordiv__:[291,10,1,""],__ilshift__:[291,10,1,""],__imatmul__:[291,10,1,""],__imod__:[291,10,1,""],__imul__:[291,10,1,""],__index__:[291,10,1,""],__inv__:[291,10,1,""],__invert__:[291,10,1,""],__ior__:[291,10,1,""],__ipow__:[291,10,1,""],__irshift__:[291,10,1,""],__isub__:[291,10,1,""],__itruediv__:[291,10,1,""],__ixor__:[291,10,1,""],__le__:[291,10,1,""],__lshift__:[291,10,1,""],__lt__:[291,10,1,""],__matmul__:[291,10,1,""],__mod__:[291,10,1,""],__mul__:[291,10,1,""],__ne__:[291,10,1,""],__neg__:[291,10,1,""],__not__:[291,10,1,""],__or__:[291,10,1,""],__pos__:[291,10,1,""],__pow__:[291,10,1,""],__rshift__:[291,10,1,""],__setitem__:[291,10,1,""],__sub__:[291,10,1,""],__truediv__:[291,10,1,""],__xor__:[291,10,1,""],abs:[291,10,1,""],add:[291,10,1,""],and_:[291,10,1,""],attrgetter:[291,10,1,""],concat:[291,10,1,""],contains:[291,10,1,""],countOf:[291,10,1,""],delitem:[291,10,1,""],eq:[291,10,1,""],floordiv:[291,10,1,""],ge:[291,10,1,""],getitem:[291,10,1,""],gt:[291,10,1,""],iadd:[291,10,1,""],iand:[291,10,1,""],iconcat:[291,10,1,""],ifloordiv:[291,10,1,""],ilshift:[291,10,1,""],imatmul:[291,10,1,""],imod:[291,10,1,""],imul:[291,10,1,""],index:[291,10,1,""],indexOf:[291,10,1,""],inv:[291,10,1,""],invert:[291,10,1,""],ior:[291,10,1,""],ipow:[291,10,1,""],irshift:[291,10,1,""],is_:[291,10,1,""],is_not:[291,10,1,""],isub:[291,10,1,""],itemgetter:[291,10,1,""],itruediv:[291,10,1,""],ixor:[291,10,1,""],le:[291,10,1,""],length_hint:[291,10,1,""],lshift:[291,10,1,""],lt:[291,10,1,""],matmul:[291,10,1,""],methodcaller:[291,10,1,""],mod:[291,10,1,""],mul:[291,10,1,""],ne:[291,10,1,""],neg:[291,10,1,""],not_:[291,10,1,""],or_:[291,10,1,""],pos:[291,10,1,""],pow:[291,10,1,""],rshift:[291,10,1,""],setitem:[291,10,1,""],sub:[291,10,1,""],truediv:[291,10,1,""],truth:[291,10,1,""],xor:[291,10,1,""]},optparse:{OptionGroup:[292,11,1,""],OptionParser:[292,11,1,""]},os:{CLD_CONTINUED:[293,8,1,""],CLD_DUMPED:[293,8,1,""],CLD_EXITED:[293,8,1,""],CLD_TRAPPED:[293,8,1,""],DirEntry:[293,11,1,""],EX_CANTCREAT:[293,8,1,""],EX_CONFIG:[293,8,1,""],EX_DATAERR:[293,8,1,""],EX_IOERR:[293,8,1,""],EX_NOHOST:[293,8,1,""],EX_NOINPUT:[293,8,1,""],EX_NOPERM:[293,8,1,""],EX_NOTFOUND:[293,8,1,""],EX_NOUSER:[293,8,1,""],EX_OK:[293,8,1,""],EX_OSERR:[293,8,1,""],EX_OSFILE:[293,8,1,""],EX_PROTOCOL:[293,8,1,""],EX_SOFTWARE:[293,8,1,""],EX_TEMPFAIL:[293,8,1,""],EX_UNAVAILABLE:[293,8,1,""],EX_USAGE:[293,8,1,""],F_LOCK:[293,8,1,""],F_OK:[293,8,1,""],F_TEST:[293,8,1,""],F_TLOCK:[293,8,1,""],F_ULOCK:[293,8,1,""],GRND_NONBLOCK:[293,8,1,""],GRND_RANDOM:[293,8,1,""],O_APPEND:[293,8,1,""],O_ASYNC:[293,8,1,""],O_BINARY:[293,8,1,""],O_CLOEXEC:[293,8,1,""],O_CREAT:[293,8,1,""],O_DIRECT:[293,8,1,""],O_DIRECTORY:[293,8,1,""],O_DSYNC:[293,8,1,""],O_EXCL:[293,8,1,""],O_EXLOCK:[293,8,1,""],O_NDELAY:[293,8,1,""],O_NOATIME:[293,8,1,""],O_NOCTTY:[293,8,1,""],O_NOFOLLOW:[293,8,1,""],O_NOINHERIT:[293,8,1,""],O_NONBLOCK:[293,8,1,""],O_PATH:[293,8,1,""],O_RANDOM:[293,8,1,""],O_RDONLY:[293,8,1,""],O_RDWR:[293,8,1,""],O_RSYNC:[293,8,1,""],O_SEQUENTIAL:[293,8,1,""],O_SHLOCK:[293,8,1,""],O_SHORT_LIVED:[293,8,1,""],O_SYNC:[293,8,1,""],O_TEMPORARY:[293,8,1,""],O_TEXT:[293,8,1,""],O_TMPFILE:[293,8,1,""],O_TRUNC:[293,8,1,""],O_WRONLY:[293,8,1,""],POSIX_FADV_DONTNEED:[293,8,1,""],POSIX_FADV_NOREUSE:[293,8,1,""],POSIX_FADV_NORMAL:[293,8,1,""],POSIX_FADV_RANDOM:[293,8,1,""],POSIX_FADV_SEQUENTIAL:[293,8,1,""],POSIX_FADV_WILLNEED:[293,8,1,""],PRIO_PGRP:[293,8,1,""],PRIO_PROCESS:[293,8,1,""],PRIO_USER:[293,8,1,""],P_ALL:[293,8,1,""],P_DETACH:[293,8,1,""],P_NOWAIT:[293,8,1,""],P_NOWAITO:[293,8,1,""],P_OVERLAY:[293,8,1,""],P_PGID:[293,8,1,""],P_PID:[293,8,1,""],P_WAIT:[293,8,1,""],PathLike:[293,11,1,""],RTLD_DEEPBIND:[293,8,1,""],RTLD_GLOBAL:[293,8,1,""],RTLD_LAZY:[293,8,1,""],RTLD_LOCAL:[293,8,1,""],RTLD_NODELETE:[293,8,1,""],RTLD_NOLOAD:[293,8,1,""],RTLD_NOW:[293,8,1,""],RWF_DSYNC:[293,8,1,""],RWF_HIPRI:[293,8,1,""],RWF_NOWAIT:[293,8,1,""],RWF_SYNC:[293,8,1,""],R_OK:[293,8,1,""],SCHED_BATCH:[293,8,1,""],SCHED_FIFO:[293,8,1,""],SCHED_IDLE:[293,8,1,""],SCHED_OTHER:[293,8,1,""],SCHED_RESET_ON_FORK:[293,8,1,""],SCHED_RR:[293,8,1,""],SCHED_SPORADIC:[293,8,1,""],SEEK_CUR:[293,8,1,""],SEEK_END:[293,8,1,""],SEEK_SET:[293,8,1,""],SF_MNOWAIT:[293,8,1,""],SF_NODISKIO:[293,8,1,""],SF_SYNC:[293,8,1,""],WCONTINUED:[293,8,1,""],WCOREDUMP:[293,10,1,""],WEXITED:[293,8,1,""],WEXITSTATUS:[293,10,1,""],WIFCONTINUED:[293,10,1,""],WIFEXITED:[293,10,1,""],WIFSIGNALED:[293,10,1,""],WIFSTOPPED:[293,10,1,""],WNOHANG:[293,8,1,""],WNOWAIT:[293,8,1,""],WSTOPPED:[293,8,1,""],WSTOPSIG:[293,10,1,""],WTERMSIG:[293,10,1,""],WUNTRACED:[293,8,1,""],W_OK:[293,8,1,""],XATTR_CREATE:[293,8,1,""],XATTR_REPLACE:[293,8,1,""],XATTR_SIZE_MAX:[293,8,1,""],X_OK:[293,8,1,""],_exit:[293,10,1,""],abort:[293,10,1,""],access:[293,10,1,""],altsep:[293,8,1,""],chdir:[293,10,1,""],chflags:[293,10,1,""],chmod:[293,10,1,""],chown:[293,10,1,""],chroot:[293,10,1,""],close:[293,10,1,""],closerange:[293,10,1,""],confstr:[293,10,1,""],confstr_names:[293,8,1,""],cpu_count:[293,10,1,""],ctermid:[293,10,1,""],curdir:[293,8,1,""],defpath:[293,8,1,""],device_encoding:[293,10,1,""],devnull:[293,8,1,""],dup2:[293,10,1,""],dup:[293,10,1,""],environ:[293,8,1,""],environb:[293,8,1,""],error:[293,5,1,""],execl:[293,10,1,""],execle:[293,10,1,""],execlp:[293,10,1,""],execlpe:[293,10,1,""],execv:[293,10,1,""],execve:[293,10,1,""],execvp:[293,10,1,""],execvpe:[293,10,1,""],extsep:[293,8,1,""],fchdir:[293,10,1,""],fchmod:[293,10,1,""],fchown:[293,10,1,""],fdatasync:[293,10,1,""],fdopen:[293,10,1,""],fork:[293,10,1,""],forkpty:[293,10,1,""],fpathconf:[293,10,1,""],fsdecode:[293,10,1,""],fsencode:[293,10,1,""],fspath:[293,10,1,""],fstat:[293,10,1,""],fstatvfs:[293,10,1,""],fsync:[293,10,1,""],ftruncate:[293,10,1,""],fwalk:[293,10,1,""],get_blocking:[293,10,1,""],get_exec_path:[293,10,1,""],get_handle_inheritable:[293,10,1,""],get_inheritable:[293,10,1,""],get_terminal_size:[293,10,1,""],getcwd:[293,10,1,""],getcwdb:[293,10,1,""],getegid:[293,10,1,""],getenv:[293,10,1,""],getenvb:[293,10,1,""],geteuid:[293,10,1,""],getgid:[293,10,1,""],getgrouplist:[293,10,1,""],getgroups:[293,10,1,""],getloadavg:[293,10,1,""],getlogin:[293,10,1,""],getpgid:[293,10,1,""],getpgrp:[293,10,1,""],getpid:[293,10,1,""],getppid:[293,10,1,""],getpriority:[293,10,1,""],getrandom:[293,10,1,""],getresgid:[293,10,1,""],getresuid:[293,10,1,""],getsid:[293,10,1,""],getuid:[293,10,1,""],getxattr:[293,10,1,""],initgroups:[293,10,1,""],isatty:[293,10,1,""],kill:[293,10,1,""],killpg:[293,10,1,""],lchflags:[293,10,1,""],lchmod:[293,10,1,""],lchown:[293,10,1,""],linesep:[293,8,1,""],link:[293,10,1,""],listdir:[293,10,1,""],listxattr:[293,10,1,""],lockf:[293,10,1,""],lseek:[293,10,1,""],lstat:[293,10,1,""],major:[293,10,1,""],makedev:[293,10,1,""],makedirs:[293,10,1,""],minor:[293,10,1,""],mkdir:[293,10,1,""],mkfifo:[293,10,1,""],mknod:[293,10,1,""],name:[293,8,1,""],nice:[293,10,1,""],open:[293,10,1,""],openpty:[293,10,1,""],pardir:[293,8,1,""],path:[294,9,0,"-"],pathconf:[293,10,1,""],pathconf_names:[293,8,1,""],pathsep:[293,8,1,""],pipe2:[293,10,1,""],pipe:[293,10,1,""],plock:[293,10,1,""],popen:[293,10,1,""],posix_fadvise:[293,10,1,""],posix_fallocate:[293,10,1,""],pread:[293,10,1,""],preadv:[293,10,1,""],putenv:[293,10,1,""],pwrite:[293,10,1,""],pwritev:[293,10,1,""],read:[293,10,1,""],readlink:[293,10,1,""],readv:[293,10,1,""],register_at_fork:[293,10,1,""],remove:[293,10,1,""],removedirs:[293,10,1,""],removexattr:[293,10,1,""],rename:[293,10,1,""],renames:[293,10,1,""],replace:[293,10,1,""],rmdir:[293,10,1,""],scandir:[293,10,1,""],sched_get_priority_max:[293,10,1,""],sched_get_priority_min:[293,10,1,""],sched_getaffinity:[293,10,1,""],sched_getparam:[293,10,1,""],sched_getscheduler:[293,10,1,""],sched_param:[293,11,1,""],sched_rr_get_interval:[293,10,1,""],sched_setaffinity:[293,10,1,""],sched_setparam:[293,10,1,""],sched_setscheduler:[293,10,1,""],sched_yield:[293,10,1,""],sendfile:[293,10,1,""],sep:[293,8,1,""],set_blocking:[293,10,1,""],set_handle_inheritable:[293,10,1,""],set_inheritable:[293,10,1,""],setegid:[293,10,1,""],seteuid:[293,10,1,""],setgid:[293,10,1,""],setgroups:[293,10,1,""],setpgid:[293,10,1,""],setpgrp:[293,10,1,""],setpriority:[293,10,1,""],setregid:[293,10,1,""],setresgid:[293,10,1,""],setresuid:[293,10,1,""],setreuid:[293,10,1,""],setsid:[293,10,1,""],setuid:[293,10,1,""],setxattr:[293,10,1,""],spawnl:[293,10,1,""],spawnle:[293,10,1,""],spawnlp:[293,10,1,""],spawnlpe:[293,10,1,""],spawnv:[293,10,1,""],spawnve:[293,10,1,""],spawnvp:[293,10,1,""],spawnvpe:[293,10,1,""],startfile:[293,10,1,""],stat:[293,10,1,""],stat_result:[293,11,1,""],statvfs:[293,10,1,""],strerror:[293,10,1,""],supports_bytes_environ:[293,8,1,""],supports_dir_fd:[293,8,1,""],supports_effective_ids:[293,8,1,""],supports_fd:[293,8,1,""],supports_follow_symlinks:[293,8,1,""],symlink:[293,10,1,""],sync:[293,10,1,""],sysconf:[293,10,1,""],sysconf_names:[293,8,1,""],system:[293,10,1,""],tcgetpgrp:[293,10,1,""],tcsetpgrp:[293,10,1,""],terminal_size:[293,11,1,""],times:[293,10,1,""],truncate:[293,10,1,""],ttyname:[293,10,1,""],umask:[293,10,1,""],uname:[293,10,1,""],unlink:[293,10,1,""],unsetenv:[293,10,1,""],urandom:[293,10,1,""],utime:[293,10,1,""],wait3:[293,10,1,""],wait4:[293,10,1,""],wait:[293,10,1,""],waitid:[293,10,1,""],waitpid:[293,10,1,""],walk:[293,10,1,""],write:[293,10,1,""],writev:[293,10,1,""]},ossaudiodev:{OSSAudioError:[295,5,1,""],open:[295,10,1,""],openmixer:[295,10,1,""]},parser:{ParserError:[297,5,1,""],STType:[297,8,1,""],compilest:[297,10,1,""],expr:[297,10,1,""],isexpr:[297,10,1,""],issuite:[297,10,1,""],sequence2st:[297,10,1,""],st2list:[297,10,1,""],st2tuple:[297,10,1,""],suite:[297,10,1,""],tuple2st:[297,10,1,""]},pathlib:{Path:[298,11,1,""],PosixPath:[298,11,1,""],PurePath:[298,11,1,""],PurePosixPath:[298,11,1,""],PureWindowsPath:[298,11,1,""],WindowsPath:[298,11,1,""]},pdb:{Pdb:[299,11,1,""],pm:[299,10,1,""],post_mortem:[299,10,1,""],run:[299,10,1,""],runcall:[299,10,1,""],runeval:[299,10,1,""],set_trace:[299,10,1,""]},pickle:{DEFAULT_PROTOCOL:[301,8,1,""],HIGHEST_PROTOCOL:[301,8,1,""],PickleError:[301,5,1,""],Pickler:[301,11,1,""],PicklingError:[301,5,1,""],Unpickler:[301,11,1,""],UnpicklingError:[301,5,1,""],dump:[301,10,1,""],dumps:[301,10,1,""],load:[301,10,1,""],loads:[301,10,1,""]},pickletools:{"--annotate":[302,15,1,"cmdoption-pickletools-a"],"--indentlevel":[302,15,1,"cmdoption-pickletools-l"],"--memo":[302,15,1,"cmdoption-pickletools-m"],"--output":[302,15,1,"cmdoption-pickletools-o"],"--preamble":[302,15,1,"cmdoption-pickletools-p"],"-a":[302,15,1,"cmdoption-pickletools-a"],"-l":[302,15,1,"cmdoption-pickletools-l"],"-m":[302,15,1,"cmdoption-pickletools-m"],"-o":[302,15,1,"cmdoption-pickletools-o"],"-p":[302,15,1,"cmdoption-pickletools-p"],dis:[302,10,1,""],genops:[302,10,1,""],optimize:[302,10,1,""]},pipes:{Template:[303,11,1,""]},pkgutil:{ImpImporter:[304,11,1,""],ImpLoader:[304,11,1,""],ModuleInfo:[304,11,1,""],extend_path:[304,10,1,""],find_loader:[304,10,1,""],get_data:[304,10,1,""],get_importer:[304,10,1,""],get_loader:[304,10,1,""],iter_importers:[304,10,1,""],iter_modules:[304,10,1,""],walk_packages:[304,10,1,""]},platform:{architecture:[305,10,1,""],dist:[305,10,1,""],java_ver:[305,10,1,""],libc_ver:[305,10,1,""],linux_distribution:[305,10,1,""],mac_ver:[305,10,1,""],machine:[305,10,1,""],node:[305,10,1,""],platform:[305,10,1,""],popen:[305,10,1,""],processor:[305,10,1,""],python_branch:[305,10,1,""],python_build:[305,10,1,""],python_compiler:[305,10,1,""],python_implementation:[305,10,1,""],python_revision:[305,10,1,""],python_version:[305,10,1,""],python_version_tuple:[305,10,1,""],release:[305,10,1,""],system:[305,10,1,""],system_alias:[305,10,1,""],uname:[305,10,1,""],version:[305,10,1,""],win32_ver:[305,10,1,""]},plistlib:{Data:[306,11,1,""],FMT_BINARY:[306,8,1,""],FMT_XML:[306,8,1,""],dump:[306,10,1,""],dumps:[306,10,1,""],load:[306,10,1,""],loads:[306,10,1,""],readPlist:[306,10,1,""],readPlistFromBytes:[306,10,1,""],writePlist:[306,10,1,""],writePlistToBytes:[306,10,1,""]},poplib:{POP3:[307,11,1,""],POP3_SSL:[307,11,1,""],error_proto:[307,5,1,""]},posix:{environ:[308,8,1,""]},pprint:{PrettyPrinter:[309,11,1,""],isreadable:[309,10,1,""],isrecursive:[309,10,1,""],pformat:[309,10,1,""],pprint:[309,10,1,""],saferepr:[309,10,1,""]},profile:{Profile:[310,11,1,""],run:[310,10,1,""],runctx:[310,10,1,""]},pstats:{Stats:[310,11,1,""]},pty:{fork:[311,10,1,""],openpty:[311,10,1,""],spawn:[311,10,1,""]},pwd:{getpwall:[312,10,1,""],getpwnam:[312,10,1,""],getpwuid:[312,10,1,""]},py_compile:{PyCompileError:[313,5,1,""],PycInvalidationMode:[313,11,1,""],compile:[313,10,1,""],main:[313,10,1,""]},pyclbr:{readmodule:[314,10,1,""],readmodule_ex:[314,10,1,""]},queue:{Empty:[318,5,1,""],Full:[318,5,1,""],LifoQueue:[318,11,1,""],PriorityQueue:[318,11,1,""],Queue:[318,11,1,""],SimpleQueue:[318,11,1,""]},quopri:{decode:[319,10,1,""],decodestring:[319,10,1,""],encode:[319,10,1,""],encodestring:[319,10,1,""]},random:{Random:[320,11,1,""],SystemRandom:[320,11,1,""],betavariate:[320,10,1,""],choice:[320,10,1,""],choices:[320,10,1,""],expovariate:[320,10,1,""],gammavariate:[320,10,1,""],gauss:[320,10,1,""],getrandbits:[320,10,1,""],getstate:[320,10,1,""],lognormvariate:[320,10,1,""],normalvariate:[320,10,1,""],paretovariate:[320,10,1,""],randint:[320,10,1,""],random:[320,10,1,""],randrange:[320,10,1,""],sample:[320,10,1,""],seed:[320,10,1,""],setstate:[320,10,1,""],shuffle:[320,10,1,""],triangular:[320,10,1,""],uniform:[320,10,1,""],vonmisesvariate:[320,10,1,""],weibullvariate:[320,10,1,""]},range:{start:[346,6,1,""],step:[346,6,1,""],stop:[346,6,1,""]},re:{A:[321,8,1,""],ASCII:[321,8,1,""],DEBUG:[321,8,1,""],DOTALL:[321,8,1,""],I:[321,8,1,""],IGNORECASE:[321,8,1,""],L:[321,8,1,""],LOCALE:[321,8,1,""],M:[321,8,1,""],MULTILINE:[321,8,1,""],S:[321,8,1,""],VERBOSE:[321,8,1,""],X:[321,8,1,""],compile:[321,10,1,""],error:[321,5,1,""],escape:[321,10,1,""],findall:[321,10,1,""],finditer:[321,10,1,""],fullmatch:[321,10,1,""],match:[321,10,1,""],purge:[321,10,1,""],search:[321,10,1,""],split:[321,10,1,""],sub:[321,10,1,""],subn:[321,10,1,""]},readline:{add_history:[322,10,1,""],append_history_file:[322,10,1,""],clear_history:[322,10,1,""],get_begidx:[322,10,1,""],get_completer:[322,10,1,""],get_completer_delims:[322,10,1,""],get_completion_type:[322,10,1,""],get_current_history_length:[322,10,1,""],get_endidx:[322,10,1,""],get_history_item:[322,10,1,""],get_history_length:[322,10,1,""],get_line_buffer:[322,10,1,""],insert_text:[322,10,1,""],parse_and_bind:[322,10,1,""],read_history_file:[322,10,1,""],read_init_file:[322,10,1,""],redisplay:[322,10,1,""],remove_history_item:[322,10,1,""],replace_history_item:[322,10,1,""],set_auto_history:[322,10,1,""],set_completer:[322,10,1,""],set_completer_delims:[322,10,1,""],set_completion_display_matches_hook:[322,10,1,""],set_history_length:[322,10,1,""],set_pre_input_hook:[322,10,1,""],set_startup_hook:[322,10,1,""],write_history_file:[322,10,1,""]},reprlib:{Repr:[323,11,1,""],aRepr:[323,8,1,""],recursive_repr:[323,10,1,""],repr:[323,10,1,""]},resource:{RLIMIT_AS:[324,8,1,""],RLIMIT_CORE:[324,8,1,""],RLIMIT_CPU:[324,8,1,""],RLIMIT_DATA:[324,8,1,""],RLIMIT_FSIZE:[324,8,1,""],RLIMIT_MEMLOCK:[324,8,1,""],RLIMIT_MSGQUEUE:[324,8,1,""],RLIMIT_NICE:[324,8,1,""],RLIMIT_NOFILE:[324,8,1,""],RLIMIT_NPROC:[324,8,1,""],RLIMIT_NPTS:[324,8,1,""],RLIMIT_OFILE:[324,8,1,""],RLIMIT_RSS:[324,8,1,""],RLIMIT_RTPRIO:[324,8,1,""],RLIMIT_RTTIME:[324,8,1,""],RLIMIT_SBSIZE:[324,8,1,""],RLIMIT_SIGPENDING:[324,8,1,""],RLIMIT_STACK:[324,8,1,""],RLIMIT_SWAP:[324,8,1,""],RLIMIT_VMEM:[324,8,1,""],RLIM_INFINITY:[324,8,1,""],RUSAGE_BOTH:[324,8,1,""],RUSAGE_CHILDREN:[324,8,1,""],RUSAGE_SELF:[324,8,1,""],RUSAGE_THREAD:[324,8,1,""],error:[324,5,1,""],getpagesize:[324,10,1,""],getrlimit:[324,10,1,""],getrusage:[324,10,1,""],prlimit:[324,10,1,""],setrlimit:[324,10,1,""]},runpy:{run_module:[326,10,1,""],run_path:[326,10,1,""]},sched:{scheduler:[327,11,1,""]},secrets:{SystemRandom:[328,11,1,""],choice:[328,10,1,""],compare_digest:[328,10,1,""],randbelow:[328,10,1,""],randbits:[328,10,1,""],token_bytes:[328,10,1,""],token_hex:[328,10,1,""],token_urlsafe:[328,10,1,""]},select:{PIPE_BUF:[329,6,1,""],devpoll:[329,10,1,""],epoll:[329,10,1,""],error:[329,5,1,""],kevent:[329,10,1,""],kqueue:[329,10,1,""],poll:[329,10,1,""],select:[329,10,1,""]},selectors:{BaseSelector:[330,11,1,""],DefaultSelector:[330,11,1,""],DevpollSelector:[330,11,1,""],EpollSelector:[330,11,1,""],KqueueSelector:[330,11,1,""],PollSelector:[330,11,1,""],SelectSelector:[330,11,1,""],SelectorKey:[330,11,1,""]},shelve:{BsdDbShelf:[331,11,1,""],DbfilenameShelf:[331,11,1,""],Shelf:[331,11,1,""],open:[331,10,1,""]},shlex:{quote:[332,10,1,""],shlex:[332,11,1,""],split:[332,10,1,""]},shutil:{Error:[333,5,1,""],SameFileError:[333,5,1,""],chown:[333,10,1,""],copy2:[333,10,1,""],copy:[333,10,1,""],copyfile:[333,10,1,""],copyfileobj:[333,10,1,""],copymode:[333,10,1,""],copystat:[333,10,1,""],copytree:[333,10,1,""],disk_usage:[333,10,1,""],get_archive_formats:[333,10,1,""],get_terminal_size:[333,10,1,""],get_unpack_formats:[333,10,1,""],ignore_patterns:[333,10,1,""],make_archive:[333,10,1,""],move:[333,10,1,""],register_archive_format:[333,10,1,""],register_unpack_format:[333,10,1,""],rmtree:[333,10,1,""],unpack_archive:[333,10,1,""],unregister_archive_format:[333,10,1,""],unregister_unpack_format:[333,10,1,""],which:[333,10,1,""]},signal:{CTRL_BREAK_EVENT:[334,8,1,""],CTRL_C_EVENT:[334,8,1,""],ITIMER_PROF:[334,8,1,""],ITIMER_REAL:[334,8,1,""],ITIMER_VIRTUAL:[334,8,1,""],ItimerError:[334,5,1,""],NSIG:[334,8,1,""],SIG_BLOCK:[334,8,1,""],SIG_DFL:[334,8,1,""],SIG_IGN:[334,8,1,""],SIG_SETMASK:[334,8,1,""],SIG_UNBLOCK:[334,8,1,""],alarm:[334,10,1,""],getitimer:[334,10,1,""],getsignal:[334,10,1,""],pause:[334,10,1,""],pthread_kill:[334,10,1,""],pthread_sigmask:[334,10,1,""],set_wakeup_fd:[334,10,1,""],setitimer:[334,10,1,""],siginterrupt:[334,10,1,""],signal:[334,10,1,""],sigpending:[334,10,1,""],sigtimedwait:[334,10,1,""],sigwait:[334,10,1,""],sigwaitinfo:[334,10,1,""]},site:{"--user-base":[335,15,1,"cmdoption-site-user-base"],"--user-site":[335,15,1,"cmdoption-site-user-site"],ENABLE_USER_SITE:[335,8,1,""],PREFIXES:[335,8,1,""],USER_BASE:[335,8,1,""],USER_SITE:[335,8,1,""],addsitedir:[335,10,1,""],getsitepackages:[335,10,1,""],getuserbase:[335,10,1,""],getusersitepackages:[335,10,1,""],main:[335,10,1,""]},slice:{indices:[424,7,1,""]},smtpd:{DebuggingServer:[336,11,1,""],MailmanProxy:[336,11,1,""],PureProxy:[336,11,1,""],SMTPChannel:[336,11,1,""],SMTPServer:[336,11,1,""]},smtplib:{LMTP:[337,11,1,""],SMTP:[337,11,1,""],SMTPAuthenticationError:[337,5,1,""],SMTPConnectError:[337,5,1,""],SMTPDataError:[337,5,1,""],SMTPException:[337,5,1,""],SMTPHeloError:[337,5,1,""],SMTPNotSupportedError:[337,5,1,""],SMTPRecipientsRefused:[337,5,1,""],SMTPResponseException:[337,5,1,""],SMTPSenderRefused:[337,5,1,""],SMTPServerDisconnected:[337,5,1,""],SMTP_SSL:[337,11,1,""]},sndhdr:{what:[338,10,1,""],whathdr:[338,10,1,""]},socket:{AF_ALG:[339,8,1,""],AF_CAN:[339,8,1,""],AF_INET6:[339,8,1,""],AF_INET:[339,8,1,""],AF_LINK:[339,8,1,""],AF_PACKET:[339,8,1,""],AF_RDS:[339,8,1,""],AF_UNIX:[339,8,1,""],AF_VSOCK:[339,8,1,""],BDADDR_ANY:[339,8,1,""],BDADDR_LOCAL:[339,8,1,""],CAN_BCM:[339,8,1,""],CAN_ISOTP:[339,8,1,""],CAN_RAW_FD_FRAMES:[339,8,1,""],CMSG_LEN:[339,10,1,""],CMSG_SPACE:[339,10,1,""],HCI_DATA_DIR:[339,8,1,""],HCI_FILTER:[339,8,1,""],HCI_TIME_STAMP:[339,8,1,""],IOCTL_VM_SOCKETS_GET_LOCAL_CID:[339,8,1,""],PF_CAN:[339,8,1,""],PF_PACKET:[339,8,1,""],PF_RDS:[339,8,1,""],SIO_KEEPALIVE_VALS:[339,8,1,""],SIO_LOOPBACK_FAST_PATH:[339,8,1,""],SIO_RCVALL:[339,8,1,""],SOCK_CLOEXEC:[339,8,1,""],SOCK_DGRAM:[339,8,1,""],SOCK_NONBLOCK:[339,8,1,""],SOCK_RAW:[339,8,1,""],SOCK_RDM:[339,8,1,""],SOCK_SEQPACKET:[339,8,1,""],SOCK_STREAM:[339,8,1,""],SOL_ALG:[339,8,1,""],SOL_RDS:[339,8,1,""],SOMAXCONN:[339,8,1,""],SocketType:[339,8,1,""],close:[339,10,1,""],create_connection:[339,10,1,""],error:[339,5,1,""],fromfd:[339,10,1,""],fromshare:[339,10,1,""],gaierror:[339,5,1,""],getaddrinfo:[339,10,1,""],getdefaulttimeout:[339,10,1,""],getfqdn:[339,10,1,""],gethostbyaddr:[339,10,1,""],gethostbyname:[339,10,1,""],gethostbyname_ex:[339,10,1,""],gethostname:[339,10,1,""],getnameinfo:[339,10,1,""],getprotobyname:[339,10,1,""],getservbyname:[339,10,1,""],getservbyport:[339,10,1,""],has_ipv6:[339,8,1,""],herror:[339,5,1,""],htonl:[339,10,1,""],htons:[339,10,1,""],if_indextoname:[339,10,1,""],if_nameindex:[339,10,1,""],if_nametoindex:[339,10,1,""],inet_aton:[339,10,1,""],inet_ntoa:[339,10,1,""],inet_ntop:[339,10,1,""],inet_pton:[339,10,1,""],ntohl:[339,10,1,""],ntohs:[339,10,1,""],setdefaulttimeout:[339,10,1,""],sethostname:[339,10,1,""],socket:[339,10,1,""],socketpair:[339,10,1,""],timeout:[339,5,1,""]},socketserver:{BaseRequestHandler:[340,11,1,""],BaseServer:[340,11,1,""],DatagramRequestHandler:[340,11,1,""],ForkingMixIn:[340,11,1,""],ForkingTCPServer:[340,11,1,""],ForkingUDPServer:[340,11,1,""],StreamRequestHandler:[340,11,1,""],TCPServer:[340,11,1,""],ThreadingMixIn:[340,11,1,""],ThreadingTCPServer:[340,11,1,""],ThreadingUDPServer:[340,11,1,""],UDPServer:[340,11,1,""],UnixDatagramServer:[340,11,1,""],UnixStreamServer:[340,11,1,""]},spwd:{getspall:[341,10,1,""],getspnam:[341,10,1,""]},sqlite3:{Connection:[342,11,1,""],Cursor:[342,11,1,""],DatabaseError:[342,5,1,""],Error:[342,5,1,""],IntegrityError:[342,5,1,""],NotSupportedError:[342,5,1,""],OperationalError:[342,5,1,""],PARSE_COLNAMES:[342,8,1,""],PARSE_DECLTYPES:[342,8,1,""],ProgrammingError:[342,5,1,""],Row:[342,11,1,""],Warning:[342,5,1,""],complete_statement:[342,10,1,""],connect:[342,10,1,""],enable_callback_tracebacks:[342,10,1,""],register_adapter:[342,10,1,""],register_converter:[342,10,1,""],sqlite_version:[342,8,1,""],sqlite_version_info:[342,8,1,""],version:[342,8,1,""],version_info:[342,8,1,""]},ssl:{ALERT_DESCRIPTION_HANDSHAKE_FAILURE:[343,8,1,""],ALERT_DESCRIPTION_INTERNAL_ERROR:[343,8,1,""],AlertDescription:[343,11,1,""],CERT_NONE:[343,8,1,""],CERT_OPTIONAL:[343,8,1,""],CERT_REQUIRED:[343,8,1,""],CHANNEL_BINDING_TYPES:[343,8,1,""],CertificateError:[343,5,1,""],DER_cert_to_PEM_cert:[343,10,1,""],HAS_ALPN:[343,8,1,""],HAS_ECDH:[343,8,1,""],HAS_NEVER_CHECK_COMMON_NAME:[343,8,1,""],HAS_NPN:[343,8,1,""],HAS_SNI:[343,8,1,""],HAS_SSLv2:[343,8,1,""],HAS_SSLv3:[343,8,1,""],HAS_TLSv1:[343,8,1,""],HAS_TLSv1_1:[343,8,1,""],HAS_TLSv1_2:[343,8,1,""],HAS_TLSv1_3:[343,8,1,""],MemoryBIO:[343,11,1,""],OPENSSL_VERSION:[343,8,1,""],OPENSSL_VERSION_INFO:[343,8,1,""],OPENSSL_VERSION_NUMBER:[343,8,1,""],OP_ALL:[343,8,1,""],OP_CIPHER_SERVER_PREFERENCE:[343,8,1,""],OP_ENABLE_MIDDLEBOX_COMPAT:[343,8,1,""],OP_NO_COMPRESSION:[343,8,1,""],OP_NO_RENEGOTIATION:[343,8,1,""],OP_NO_SSLv2:[343,8,1,""],OP_NO_SSLv3:[343,8,1,""],OP_NO_TICKET:[343,8,1,""],OP_NO_TLSv1:[343,8,1,""],OP_NO_TLSv1_1:[343,8,1,""],OP_NO_TLSv1_2:[343,8,1,""],OP_NO_TLSv1_3:[343,8,1,""],OP_SINGLE_DH_USE:[343,8,1,""],OP_SINGLE_ECDH_USE:[343,8,1,""],Options:[343,11,1,""],PEM_cert_to_DER_cert:[343,10,1,""],PROTOCOL_SSLv23:[343,8,1,""],PROTOCOL_SSLv2:[343,8,1,""],PROTOCOL_SSLv3:[343,8,1,""],PROTOCOL_TLS:[343,8,1,""],PROTOCOL_TLS_CLIENT:[343,8,1,""],PROTOCOL_TLS_SERVER:[343,8,1,""],PROTOCOL_TLSv1:[343,8,1,""],PROTOCOL_TLSv1_1:[343,8,1,""],PROTOCOL_TLSv1_2:[343,8,1,""],RAND_add:[343,10,1,""],RAND_bytes:[343,10,1,""],RAND_egd:[343,10,1,""],RAND_pseudo_bytes:[343,10,1,""],RAND_status:[343,10,1,""],SSLCertVerificationError:[343,5,1,""],SSLContext:[343,11,1,""],SSLEOFError:[343,5,1,""],SSLError:[343,5,1,""],SSLErrorNumber:[343,11,1,""],SSLObject:[343,11,1,""],SSLSession:[343,11,1,""],SSLSocket:[343,11,1,""],SSLSyscallError:[343,5,1,""],SSLWantReadError:[343,5,1,""],SSLWantWriteError:[343,5,1,""],SSLZeroReturnError:[343,5,1,""],TLSVersion:[343,11,1,""],VERIFY_CRL_CHECK_CHAIN:[343,8,1,""],VERIFY_CRL_CHECK_LEAF:[343,8,1,""],VERIFY_DEFAULT:[343,8,1,""],VERIFY_X509_STRICT:[343,8,1,""],VERIFY_X509_TRUSTED_FIRST:[343,8,1,""],VerifyFlags:[343,11,1,""],VerifyMode:[343,11,1,""],cert_time_to_seconds:[343,10,1,""],create_default_context:[343,10,1,""],enum_certificates:[343,10,1,""],enum_crls:[343,10,1,""],get_default_verify_paths:[343,10,1,""],get_server_certificate:[343,10,1,""],match_hostname:[343,10,1,""],wrap_socket:[343,10,1,""]},stat:{FILE_ATTRIBUTE_ARCHIVE:[344,8,1,""],FILE_ATTRIBUTE_COMPRESSED:[344,8,1,""],FILE_ATTRIBUTE_DEVICE:[344,8,1,""],FILE_ATTRIBUTE_DIRECTORY:[344,8,1,""],FILE_ATTRIBUTE_ENCRYPTED:[344,8,1,""],FILE_ATTRIBUTE_HIDDEN:[344,8,1,""],FILE_ATTRIBUTE_INTEGRITY_STREAM:[344,8,1,""],FILE_ATTRIBUTE_NORMAL:[344,8,1,""],FILE_ATTRIBUTE_NOT_CONTENT_INDEXED:[344,8,1,""],FILE_ATTRIBUTE_NO_SCRUB_DATA:[344,8,1,""],FILE_ATTRIBUTE_OFFLINE:[344,8,1,""],FILE_ATTRIBUTE_READONLY:[344,8,1,""],FILE_ATTRIBUTE_REPARSE_POINT:[344,8,1,""],FILE_ATTRIBUTE_SPARSE_FILE:[344,8,1,""],FILE_ATTRIBUTE_SYSTEM:[344,8,1,""],FILE_ATTRIBUTE_TEMPORARY:[344,8,1,""],FILE_ATTRIBUTE_VIRTUAL:[344,8,1,""],SF_APPEND:[344,8,1,""],SF_ARCHIVED:[344,8,1,""],SF_IMMUTABLE:[344,8,1,""],SF_NOUNLINK:[344,8,1,""],SF_SNAPSHOT:[344,8,1,""],ST_ATIME:[344,8,1,""],ST_CTIME:[344,8,1,""],ST_DEV:[344,8,1,""],ST_GID:[344,8,1,""],ST_INO:[344,8,1,""],ST_MODE:[344,8,1,""],ST_MTIME:[344,8,1,""],ST_NLINK:[344,8,1,""],ST_SIZE:[344,8,1,""],ST_UID:[344,8,1,""],S_ENFMT:[344,8,1,""],S_IEXEC:[344,8,1,""],S_IFBLK:[344,8,1,""],S_IFCHR:[344,8,1,""],S_IFDIR:[344,8,1,""],S_IFDOOR:[344,8,1,""],S_IFIFO:[344,8,1,""],S_IFLNK:[344,8,1,""],S_IFMT:[344,10,1,""],S_IFPORT:[344,8,1,""],S_IFREG:[344,8,1,""],S_IFSOCK:[344,8,1,""],S_IFWHT:[344,8,1,""],S_IMODE:[344,10,1,""],S_IREAD:[344,8,1,""],S_IRGRP:[344,8,1,""],S_IROTH:[344,8,1,""],S_IRUSR:[344,8,1,""],S_IRWXG:[344,8,1,""],S_IRWXO:[344,8,1,""],S_IRWXU:[344,8,1,""],S_ISBLK:[344,10,1,""],S_ISCHR:[344,10,1,""],S_ISDIR:[344,10,1,""],S_ISDOOR:[344,10,1,""],S_ISFIFO:[344,10,1,""],S_ISGID:[344,8,1,""],S_ISLNK:[344,10,1,""],S_ISPORT:[344,10,1,""],S_ISREG:[344,10,1,""],S_ISSOCK:[344,10,1,""],S_ISUID:[344,8,1,""],S_ISVTX:[344,8,1,""],S_ISWHT:[344,10,1,""],S_IWGRP:[344,8,1,""],S_IWOTH:[344,8,1,""],S_IWRITE:[344,8,1,""],S_IWUSR:[344,8,1,""],S_IXGRP:[344,8,1,""],S_IXOTH:[344,8,1,""],S_IXUSR:[344,8,1,""],UF_APPEND:[344,8,1,""],UF_COMPRESSED:[344,8,1,""],UF_HIDDEN:[344,8,1,""],UF_IMMUTABLE:[344,8,1,""],UF_NODUMP:[344,8,1,""],UF_NOUNLINK:[344,8,1,""],UF_OPAQUE:[344,8,1,""],filemode:[344,10,1,""]},statistics:{StatisticsError:[345,5,1,""],harmonic_mean:[345,10,1,""],mean:[345,10,1,""],median:[345,10,1,""],median_grouped:[345,10,1,""],median_high:[345,10,1,""],median_low:[345,10,1,""],mode:[345,10,1,""],pstdev:[345,10,1,""],pvariance:[345,10,1,""],stdev:[345,10,1,""],variance:[345,10,1,""]},str:{capitalize:[346,7,1,""],casefold:[346,7,1,""],center:[346,7,1,""],count:[346,7,1,""],encode:[346,7,1,""],endswith:[346,7,1,""],expandtabs:[346,7,1,""],find:[346,7,1,""],format:[346,7,1,""],format_map:[346,7,1,""],index:[346,7,1,""],isalnum:[346,7,1,""],isalpha:[346,7,1,""],isascii:[346,7,1,""],isdecimal:[346,7,1,""],isdigit:[346,7,1,""],isidentifier:[346,7,1,""],islower:[346,7,1,""],isnumeric:[346,7,1,""],isprintable:[346,7,1,""],isspace:[346,7,1,""],istitle:[346,7,1,""],isupper:[346,7,1,""],join:[346,7,1,""],ljust:[346,7,1,""],lower:[346,7,1,""],lstrip:[346,7,1,""],maketrans:[346,13,1,""],partition:[346,7,1,""],replace:[346,7,1,""],rfind:[346,7,1,""],rindex:[346,7,1,""],rjust:[346,7,1,""],rpartition:[346,7,1,""],rsplit:[346,7,1,""],rstrip:[346,7,1,""],split:[346,7,1,""],splitlines:[346,7,1,""],startswith:[346,7,1,""],strip:[346,7,1,""],swapcase:[346,7,1,""],title:[346,7,1,""],translate:[346,7,1,""],upper:[346,7,1,""],zfill:[346,7,1,""]},string:{Formatter:[347,11,1,""],Template:[347,11,1,""],ascii_letters:[347,8,1,""],ascii_lowercase:[347,8,1,""],ascii_uppercase:[347,8,1,""],capwords:[347,10,1,""],digits:[347,8,1,""],hexdigits:[347,8,1,""],octdigits:[347,8,1,""],printable:[347,8,1,""],punctuation:[347,8,1,""],whitespace:[347,8,1,""]},stringprep:{in_table_a1:[348,10,1,""],in_table_b1:[348,10,1,""],in_table_c11:[348,10,1,""],in_table_c11_c12:[348,10,1,""],in_table_c12:[348,10,1,""],in_table_c21:[348,10,1,""],in_table_c21_c22:[348,10,1,""],in_table_c22:[348,10,1,""],in_table_c3:[348,10,1,""],in_table_c4:[348,10,1,""],in_table_c5:[348,10,1,""],in_table_c6:[348,10,1,""],in_table_c7:[348,10,1,""],in_table_c8:[348,10,1,""],in_table_c9:[348,10,1,""],in_table_d1:[348,10,1,""],in_table_d2:[348,10,1,""],map_table_b2:[348,10,1,""],map_table_b3:[348,10,1,""]},struct:{Struct:[349,11,1,""],calcsize:[349,10,1,""],error:[349,5,1,""],iter_unpack:[349,10,1,""],pack:[349,10,1,""],pack_into:[349,10,1,""],unpack:[349,10,1,""],unpack_from:[349,10,1,""]},subprocess:{ABOVE_NORMAL_PRIORITY_CLASS:[350,8,1,""],BELOW_NORMAL_PRIORITY_CLASS:[350,8,1,""],CREATE_BREAKAWAY_FROM_JOB:[350,8,1,""],CREATE_DEFAULT_ERROR_MODE:[350,8,1,""],CREATE_NEW_CONSOLE:[350,8,1,""],CREATE_NEW_PROCESS_GROUP:[350,8,1,""],CREATE_NO_WINDOW:[350,8,1,""],CalledProcessError:[350,5,1,""],CompletedProcess:[350,11,1,""],DETACHED_PROCESS:[350,8,1,""],DEVNULL:[350,8,1,""],HIGH_PRIORITY_CLASS:[350,8,1,""],IDLE_PRIORITY_CLASS:[350,8,1,""],NORMAL_PRIORITY_CLASS:[350,8,1,""],PIPE:[350,8,1,""],Popen:[350,11,1,""],REALTIME_PRIORITY_CLASS:[350,8,1,""],STARTF_USESHOWWINDOW:[350,8,1,""],STARTF_USESTDHANDLES:[350,8,1,""],STARTUPINFO:[350,11,1,""],STDOUT:[350,8,1,""],STD_ERROR_HANDLE:[350,8,1,""],STD_INPUT_HANDLE:[350,8,1,""],STD_OUTPUT_HANDLE:[350,8,1,""],SW_HIDE:[350,8,1,""],SubprocessError:[350,5,1,""],TimeoutExpired:[350,5,1,""],call:[350,10,1,""],check_call:[350,10,1,""],check_output:[350,10,1,""],getoutput:[350,10,1,""],getstatusoutput:[350,10,1,""],run:[350,10,1,""]},sunau:{AUDIO_FILE_ENCODING_ADPCM_G721:[351,8,1,""],AUDIO_FILE_ENCODING_ADPCM_G722:[351,8,1,""],AUDIO_FILE_ENCODING_ADPCM_G723_3:[351,8,1,""],AUDIO_FILE_ENCODING_ADPCM_G723_5:[351,8,1,""],AUDIO_FILE_ENCODING_ALAW_8:[351,8,1,""],AUDIO_FILE_ENCODING_DOUBLE:[351,8,1,""],AUDIO_FILE_ENCODING_FLOAT:[351,8,1,""],AUDIO_FILE_ENCODING_LINEAR_16:[351,8,1,""],AUDIO_FILE_ENCODING_LINEAR_24:[351,8,1,""],AUDIO_FILE_ENCODING_LINEAR_32:[351,8,1,""],AUDIO_FILE_ENCODING_LINEAR_8:[351,8,1,""],AUDIO_FILE_ENCODING_MULAW_8:[351,8,1,""],AUDIO_FILE_MAGIC:[351,8,1,""],Error:[351,5,1,""],open:[351,10,1,""],openfp:[351,10,1,""]},symbol:{sym_name:[353,8,1,""]},symtable:{Class:[354,11,1,""],Function:[354,11,1,""],Symbol:[354,11,1,""],SymbolTable:[354,11,1,""],symtable:[354,10,1,""]},sys:{__breakpointhook__:[355,8,1,""],__displayhook__:[355,8,1,""],__excepthook__:[355,8,1,""],__interactivehook__:[355,8,1,""],__stderr__:[355,8,1,""],__stdin__:[355,8,1,""],__stdout__:[355,8,1,""],_clear_type_cache:[355,10,1,""],_current_frames:[355,10,1,""],_debugmallocstats:[355,10,1,""],_enablelegacywindowsfsencoding:[355,10,1,""],_getframe:[355,10,1,""],_xoptions:[355,8,1,""],abiflags:[355,8,1,""],api_version:[355,8,1,""],argv:[355,8,1,""],base_exec_prefix:[355,8,1,""],base_prefix:[355,8,1,""],breakpointhook:[355,10,1,""],builtin_module_names:[355,8,1,""],byteorder:[355,8,1,""],call_tracing:[355,10,1,""],copyright:[355,8,1,""],displayhook:[355,10,1,""],dllhandle:[355,8,1,""],dont_write_bytecode:[355,8,1,""],exc_info:[355,10,1,""],excepthook:[355,10,1,""],exec_prefix:[355,8,1,""],executable:[355,8,1,""],exit:[355,10,1,""],flags:[355,8,1,""],float_info:[355,8,1,""],float_repr_style:[355,8,1,""],get_asyncgen_hooks:[355,10,1,""],get_coroutine_origin_tracking_depth:[355,10,1,""],get_coroutine_wrapper:[355,10,1,""],getallocatedblocks:[355,10,1,""],getandroidapilevel:[355,10,1,""],getcheckinterval:[355,10,1,""],getdefaultencoding:[355,10,1,""],getdlopenflags:[355,10,1,""],getfilesystemencodeerrors:[355,10,1,""],getfilesystemencoding:[355,10,1,""],getprofile:[355,10,1,""],getrecursionlimit:[355,10,1,""],getrefcount:[355,10,1,""],getsizeof:[355,10,1,""],getswitchinterval:[355,10,1,""],gettrace:[355,10,1,""],getwindowsversion:[355,10,1,""],hash_info:[355,8,1,""],hexversion:[355,8,1,""],implementation:[355,8,1,""],int_info:[355,8,1,""],intern:[355,10,1,""],is_finalizing:[355,10,1,""],last_traceback:[355,8,1,""],last_type:[355,8,1,""],last_value:[355,8,1,""],maxsize:[355,8,1,""],maxunicode:[355,8,1,""],meta_path:[355,8,1,""],modules:[355,8,1,""],path:[355,8,1,""],path_hooks:[355,8,1,""],path_importer_cache:[355,8,1,""],platform:[355,8,1,""],prefix:[355,8,1,""],ps1:[355,8,1,""],ps2:[355,8,1,""],set_asyncgen_hooks:[355,10,1,""],set_coroutine_origin_tracking_depth:[355,10,1,""],set_coroutine_wrapper:[355,10,1,""],setcheckinterval:[355,10,1,""],setdlopenflags:[355,10,1,""],setprofile:[355,10,1,""],setrecursionlimit:[355,10,1,""],setswitchinterval:[355,10,1,""],settrace:[355,10,1,""],stderr:[355,8,1,""],stdin:[355,8,1,""],stdout:[355,8,1,""],thread_info:[355,8,1,""],tracebacklimit:[355,8,1,""],version:[355,8,1,""],version_info:[355,8,1,""],warnoptions:[355,8,1,""],winver:[355,8,1,""]},sysconfig:{get_config_h_filename:[356,10,1,""],get_config_var:[356,10,1,""],get_config_vars:[356,10,1,""],get_makefile_filename:[356,10,1,""],get_path:[356,10,1,""],get_path_names:[356,10,1,""],get_paths:[356,10,1,""],get_platform:[356,10,1,""],get_python_version:[356,10,1,""],get_scheme_names:[356,10,1,""],is_python_build:[356,10,1,""],parse_config_h:[356,10,1,""]},syslog:{closelog:[357,10,1,""],openlog:[357,10,1,""],setlogmask:[357,10,1,""],syslog:[357,10,1,""]},tabnanny:{NannyNag:[358,5,1,""],check:[358,10,1,""],filename_only:[358,8,1,""],process_tokens:[358,10,1,""],verbose:[358,8,1,""]},tarfile:{"--create":[359,15,1,"cmdoption-tarfile-create"],"--extract":[359,15,1,"cmdoption-tarfile-extract"],"--list":[359,15,1,"cmdoption-tarfile-list"],"--test":[359,15,1,"cmdoption-tarfile-test"],"--verbose":[359,15,1,"cmdoption-tarfile-v"],"-c":[359,15,1,"cmdoption-tarfile-c"],"-e":[359,15,1,"cmdoption-tarfile-e"],"-l":[359,15,1,"cmdoption-tarfile-l"],"-t":[359,15,1,"cmdoption-tarfile-t"],"-v":[359,15,1,"cmdoption-tarfile-v"],CompressionError:[359,5,1,""],DEFAULT_FORMAT:[359,8,1,""],ENCODING:[359,8,1,""],ExtractError:[359,5,1,""],GNU_FORMAT:[359,8,1,""],HeaderError:[359,5,1,""],PAX_FORMAT:[359,8,1,""],ReadError:[359,5,1,""],StreamError:[359,5,1,""],TarError:[359,5,1,""],TarFile:[359,11,1,""],TarInfo:[359,11,1,""],USTAR_FORMAT:[359,8,1,""],is_tarfile:[359,10,1,""],open:[359,10,1,""]},telnetlib:{Telnet:[360,11,1,""]},tempfile:{NamedTemporaryFile:[361,10,1,""],SpooledTemporaryFile:[361,10,1,""],TemporaryDirectory:[361,10,1,""],TemporaryFile:[361,10,1,""],gettempdir:[361,10,1,""],gettempdirb:[361,10,1,""],gettempprefix:[361,10,1,""],gettempprefixb:[361,10,1,""],mkdtemp:[361,10,1,""],mkstemp:[361,10,1,""],mktemp:[361,10,1,""],tempdir:[361,8,1,""]},termios:{tcdrain:[362,10,1,""],tcflow:[362,10,1,""],tcflush:[362,10,1,""],tcgetattr:[362,10,1,""],tcsendbreak:[362,10,1,""],tcsetattr:[362,10,1,""]},test:{support:[363,9,0,"-"]},textwrap:{TextWrapper:[365,11,1,""],dedent:[365,10,1,""],fill:[365,10,1,""],indent:[365,10,1,""],shorten:[365,10,1,""],wrap:[365,10,1,""]},threading:{Barrier:[366,11,1,""],BoundedSemaphore:[366,11,1,""],BrokenBarrierError:[366,5,1,""],Condition:[366,11,1,""],Event:[366,11,1,""],Lock:[366,11,1,""],RLock:[366,11,1,""],Semaphore:[366,11,1,""],TIMEOUT_MAX:[366,8,1,""],Thread:[366,11,1,""],Timer:[366,11,1,""],active_count:[366,10,1,""],current_thread:[366,10,1,""],enumerate:[366,10,1,""],get_ident:[366,10,1,""],local:[366,11,1,""],main_thread:[366,10,1,""],setprofile:[366,10,1,""],settrace:[366,10,1,""],stack_size:[366,10,1,""]},time:{CLOCK_BOOTTIME:[367,8,1,""],CLOCK_HIGHRES:[367,8,1,""],CLOCK_MONOTONIC:[367,8,1,""],CLOCK_MONOTONIC_RAW:[367,8,1,""],CLOCK_PROCESS_CPUTIME_ID:[367,8,1,""],CLOCK_PROF:[367,8,1,""],CLOCK_REALTIME:[367,8,1,""],CLOCK_THREAD_CPUTIME_ID:[367,8,1,""],CLOCK_UPTIME:[367,8,1,""],altzone:[367,8,1,""],asctime:[367,10,1,""],clock:[367,10,1,""],clock_getres:[367,10,1,""],clock_gettime:[367,10,1,""],clock_gettime_ns:[367,10,1,""],clock_settime:[367,10,1,""],clock_settime_ns:[367,10,1,""],ctime:[367,10,1,""],daylight:[367,8,1,""],get_clock_info:[367,10,1,""],gmtime:[367,10,1,""],localtime:[367,10,1,""],mktime:[367,10,1,""],monotonic:[367,10,1,""],monotonic_ns:[367,10,1,""],perf_counter:[367,10,1,""],perf_counter_ns:[367,10,1,""],process_time:[367,10,1,""],process_time_ns:[367,10,1,""],pthread_getcpuclockid:[367,10,1,""],sleep:[367,10,1,""],strftime:[367,10,1,""],strptime:[367,10,1,""],struct_time:[367,11,1,""],thread_time:[367,10,1,""],thread_time_ns:[367,10,1,""],time:[367,10,1,""],time_ns:[367,10,1,""],timezone:[367,8,1,""],tzname:[367,8,1,""],tzset:[367,10,1,""]},timeit:{"--help":[368,15,1,"cmdoption-timeit-h"],"--number":[368,15,1,"cmdoption-timeit-n"],"--process":[368,15,1,"cmdoption-timeit-p"],"--repeat":[368,15,1,"cmdoption-timeit-r"],"--setup":[368,15,1,"cmdoption-timeit-s"],"--unit":[368,15,1,"cmdoption-timeit-u"],"--verbose":[368,15,1,"cmdoption-timeit-v"],"-h":[368,15,1,"cmdoption-timeit-h"],"-n":[368,15,1,"cmdoption-timeit-n"],"-p":[368,15,1,"cmdoption-timeit-p"],"-r":[368,15,1,"cmdoption-timeit-r"],"-s":[368,15,1,"cmdoption-timeit-s"],"-u":[368,15,1,"cmdoption-timeit-u"],"-v":[368,15,1,"cmdoption-timeit-v"],Timer:[368,11,1,""],default_timer:[368,10,1,""],repeat:[368,10,1,""],timeit:[368,10,1,""]},tkinter:{EXCEPTION:[370,8,1,""],READABLE:[370,8,1,""],Tcl:[370,10,1,""],Tk:[370,11,1,""],WRITABLE:[370,8,1,""],scrolledtext:[371,9,0,"-"],tix:[372,9,0,"-"],ttk:[373,9,0,"-"]},token:{AMPER:[374,8,1,""],AMPEREQUAL:[374,8,1,""],AT:[374,8,1,""],ATEQUAL:[374,8,1,""],CIRCUMFLEX:[374,8,1,""],CIRCUMFLEXEQUAL:[374,8,1,""],COLON:[374,8,1,""],COMMA:[374,8,1,""],COMMENT:[374,8,1,""],DEDENT:[374,8,1,""],DOT:[374,8,1,""],DOUBLESLASH:[374,8,1,""],DOUBLESLASHEQUAL:[374,8,1,""],DOUBLESTAR:[374,8,1,""],DOUBLESTAREQUAL:[374,8,1,""],ELLIPSIS:[374,8,1,""],ENCODING:[374,8,1,""],ENDMARKER:[374,8,1,""],EQEQUAL:[374,8,1,""],EQUAL:[374,8,1,""],ERRORTOKEN:[374,8,1,""],GREATER:[374,8,1,""],GREATEREQUAL:[374,8,1,""],INDENT:[374,8,1,""],ISEOF:[374,10,1,""],ISNONTERMINAL:[374,10,1,""],ISTERMINAL:[374,10,1,""],LBRACE:[374,8,1,""],LEFTSHIFT:[374,8,1,""],LEFTSHIFTEQUAL:[374,8,1,""],LESS:[374,8,1,""],LESSEQUAL:[374,8,1,""],LPAR:[374,8,1,""],LSQB:[374,8,1,""],MINEQUAL:[374,8,1,""],MINUS:[374,8,1,""],NAME:[374,8,1,""],NEWLINE:[374,8,1,""],NL:[374,8,1,""],NOTEQUAL:[374,8,1,""],NT_OFFSET:[374,8,1,""],NUMBER:[374,8,1,""],N_TOKENS:[374,8,1,""],OP:[374,8,1,""],PERCENT:[374,8,1,""],PERCENTEQUAL:[374,8,1,""],PLUS:[374,8,1,""],PLUSEQUAL:[374,8,1,""],RARROW:[374,8,1,""],RBRACE:[374,8,1,""],RIGHTSHIFT:[374,8,1,""],RIGHTSHIFTEQUAL:[374,8,1,""],RPAR:[374,8,1,""],RSQB:[374,8,1,""],SEMI:[374,8,1,""],SLASH:[374,8,1,""],SLASHEQUAL:[374,8,1,""],STAR:[374,8,1,""],STAREQUAL:[374,8,1,""],STRING:[374,8,1,""],TILDE:[374,8,1,""],VBAR:[374,8,1,""],VBAREQUAL:[374,8,1,""],tok_name:[374,8,1,""]},tokenize:{"--exact":[375,15,1,"cmdoption-tokenize-e"],"--help":[375,15,1,"cmdoption-tokenize-h"],"-e":[375,15,1,"cmdoption-tokenize-e"],"-h":[375,15,1,"cmdoption-tokenize-h"],TokenError:[375,5,1,""],detect_encoding:[375,10,1,""],open:[375,10,1,""],tokenize:[375,10,1,""],untokenize:[375,10,1,""]},trace:{"--count":[376,15,1,"cmdoption-trace-c"],"--coverdir":[376,15,1,"cmdoption-trace-coverdir"],"--file":[376,15,1,"cmdoption-trace-f"],"--help":[376,15,1,"cmdoption-trace-help"],"--ignore-dir":[376,15,1,"cmdoption-trace-ignore-dir"],"--ignore-module":[376,15,1,"cmdoption-trace-ignore-module"],"--listfuncs":[376,15,1,"cmdoption-trace-l"],"--missing":[376,15,1,"cmdoption-trace-m"],"--no-report":[376,15,1,"cmdoption-trace-no-report"],"--report":[376,15,1,"cmdoption-trace-r"],"--summary":[376,15,1,"cmdoption-trace-s"],"--timing":[376,15,1,"cmdoption-trace-g"],"--trace":[376,15,1,"cmdoption-trace-t"],"--trackcalls":[376,15,1,"cmdoption-trace-trackcalls"],"--version":[376,15,1,"cmdoption-trace-version"],"-C":[376,15,1,"cmdoption-trace-coverdir"],"-R":[376,15,1,"cmdoption-trace-no-report"],"-T":[376,15,1,"cmdoption-trace-trackcalls"],"-c":[376,15,1,"cmdoption-trace-c"],"-f":[376,15,1,"cmdoption-trace-f"],"-g":[376,15,1,"cmdoption-trace-g"],"-l":[376,15,1,"cmdoption-trace-l"],"-m":[376,15,1,"cmdoption-trace-m"],"-r":[376,15,1,"cmdoption-trace-r"],"-s":[376,15,1,"cmdoption-trace-s"],"-t":[376,15,1,"cmdoption-trace-t"],CoverageResults:[376,11,1,""],Trace:[376,11,1,""]},traceback:{FrameSummary:[377,11,1,""],StackSummary:[377,11,1,""],TracebackException:[377,11,1,""],clear_frames:[377,10,1,""],extract_stack:[377,10,1,""],extract_tb:[377,10,1,""],format_exc:[377,10,1,""],format_exception:[377,10,1,""],format_exception_only:[377,10,1,""],format_list:[377,10,1,""],format_stack:[377,10,1,""],format_tb:[377,10,1,""],print_exc:[377,10,1,""],print_exception:[377,10,1,""],print_last:[377,10,1,""],print_stack:[377,10,1,""],print_tb:[377,10,1,""],walk_stack:[377,10,1,""],walk_tb:[377,10,1,""]},tracemalloc:{DomainFilter:[378,11,1,""],Filter:[378,11,1,""],Frame:[378,11,1,""],Snapshot:[378,11,1,""],Statistic:[378,11,1,""],StatisticDiff:[378,11,1,""],Trace:[378,11,1,""],Traceback:[378,11,1,""],clear_traces:[378,10,1,""],get_object_traceback:[378,10,1,""],get_traceback_limit:[378,10,1,""],get_traced_memory:[378,10,1,""],get_tracemalloc_memory:[378,10,1,""],is_tracing:[378,10,1,""],start:[378,10,1,""],stop:[378,10,1,""],take_snapshot:[378,10,1,""]},tty:{setcbreak:[379,10,1,""],setraw:[379,10,1,""]},turtle:{"goto":[380,10,1,""],RawPen:[380,11,1,""],RawTurtle:[380,11,1,""],Screen:[380,11,1,""],ScrolledCanvas:[380,11,1,""],Shape:[380,11,1,""],Turtle:[380,11,1,""],TurtleScreen:[380,11,1,""],Vec2D:[380,11,1,""],addshape:[380,10,1,""],back:[380,10,1,""],backward:[380,10,1,""],begin_fill:[380,10,1,""],begin_poly:[380,10,1,""],bgcolor:[380,10,1,""],bgpic:[380,10,1,""],bk:[380,10,1,""],bye:[380,10,1,""],circle:[380,10,1,""],clear:[380,10,1,""],clearscreen:[380,10,1,""],clearstamp:[380,10,1,""],clearstamps:[380,10,1,""],clone:[380,10,1,""],color:[380,10,1,""],colormode:[380,10,1,""],degrees:[380,10,1,""],delay:[380,10,1,""],distance:[380,10,1,""],done:[380,10,1,""],dot:[380,10,1,""],down:[380,10,1,""],end_fill:[380,10,1,""],end_poly:[380,10,1,""],exitonclick:[380,10,1,""],fd:[380,10,1,""],fillcolor:[380,10,1,""],filling:[380,10,1,""],forward:[380,10,1,""],get_poly:[380,10,1,""],get_shapepoly:[380,10,1,""],getcanvas:[380,10,1,""],getpen:[380,10,1,""],getscreen:[380,10,1,""],getshapes:[380,10,1,""],getturtle:[380,10,1,""],heading:[380,10,1,""],hideturtle:[380,10,1,""],home:[380,10,1,""],ht:[380,10,1,""],isdown:[380,10,1,""],isvisible:[380,10,1,""],left:[380,10,1,""],listen:[380,10,1,""],lt:[380,10,1,""],mainloop:[380,10,1,""],mode:[380,10,1,""],numinput:[380,10,1,""],onclick:[380,10,1,""],ondrag:[380,10,1,""],onkey:[380,10,1,""],onkeypress:[380,10,1,""],onkeyrelease:[380,10,1,""],onrelease:[380,10,1,""],onscreenclick:[380,10,1,""],ontimer:[380,10,1,""],pd:[380,10,1,""],pen:[380,10,1,""],pencolor:[380,10,1,""],pendown:[380,10,1,""],pensize:[380,10,1,""],penup:[380,10,1,""],pos:[380,10,1,""],position:[380,10,1,""],pu:[380,10,1,""],radians:[380,10,1,""],register_shape:[380,10,1,""],reset:[380,10,1,""],resetscreen:[380,10,1,""],resizemode:[380,10,1,""],right:[380,10,1,""],rt:[380,10,1,""],screensize:[380,10,1,""],seth:[380,10,1,""],setheading:[380,10,1,""],setpos:[380,10,1,""],setposition:[380,10,1,""],settiltangle:[380,10,1,""],setundobuffer:[380,10,1,""],setup:[380,10,1,""],setworldcoordinates:[380,10,1,""],setx:[380,10,1,""],sety:[380,10,1,""],shape:[380,10,1,""],shapesize:[380,10,1,""],shapetransform:[380,10,1,""],shearfactor:[380,10,1,""],showturtle:[380,10,1,""],speed:[380,10,1,""],st:[380,10,1,""],stamp:[380,10,1,""],textinput:[380,10,1,""],tilt:[380,10,1,""],tiltangle:[380,10,1,""],title:[380,10,1,""],towards:[380,10,1,""],tracer:[380,10,1,""],turtles:[380,10,1,""],turtlesize:[380,10,1,""],undo:[380,10,1,""],undobufferentries:[380,10,1,""],up:[380,10,1,""],update:[380,10,1,""],width:[380,10,1,""],window_height:[380,10,1,""],window_width:[380,10,1,""],write:[380,10,1,""],write_docstringdict:[380,10,1,""],xcor:[380,10,1,""],ycor:[380,10,1,""]},types:{AsyncGeneratorType:[381,8,1,""],BuiltinFunctionType:[381,8,1,""],BuiltinMethodType:[381,8,1,""],ClassMethodDescriptorType:[381,8,1,""],CodeType:[381,8,1,""],CoroutineType:[381,8,1,""],DynamicClassAttribute:[381,10,1,""],FrameType:[381,8,1,""],FunctionType:[381,8,1,""],GeneratorType:[381,8,1,""],GetSetDescriptorType:[381,8,1,""],LambdaType:[381,8,1,""],MappingProxyType:[381,11,1,""],MemberDescriptorType:[381,8,1,""],MethodDescriptorType:[381,8,1,""],MethodType:[381,8,1,""],MethodWrapperType:[381,8,1,""],ModuleType:[381,11,1,""],SimpleNamespace:[381,11,1,""],TracebackType:[381,11,1,""],WrapperDescriptorType:[381,8,1,""],coroutine:[381,10,1,""],new_class:[381,10,1,""],prepare_class:[381,10,1,""],resolve_bases:[381,10,1,""]},typing:{AbstractSet:[382,11,1,""],Any:[382,8,1,""],AnyStr:[382,8,1,""],AsyncContextManager:[382,11,1,""],AsyncGenerator:[382,11,1,""],AsyncIterable:[382,11,1,""],AsyncIterator:[382,11,1,""],Awaitable:[382,11,1,""],BinaryIO:[382,11,1,""],ByteString:[382,11,1,""],Callable:[382,8,1,""],ChainMap:[382,11,1,""],ClassVar:[382,8,1,""],Collection:[382,11,1,""],Container:[382,11,1,""],ContextManager:[382,11,1,""],Coroutine:[382,11,1,""],Counter:[382,11,1,""],DefaultDict:[382,11,1,""],Deque:[382,11,1,""],Dict:[382,11,1,""],ForwardRef:[382,11,1,""],FrozenSet:[382,11,1,""],Generator:[382,11,1,""],Generic:[382,11,1,""],Hashable:[382,11,1,""],IO:[382,11,1,""],ItemsView:[382,11,1,""],Iterable:[382,11,1,""],Iterator:[382,11,1,""],KeysView:[382,11,1,""],List:[382,11,1,""],Mapping:[382,11,1,""],MappingView:[382,11,1,""],Match:[382,11,1,""],MutableMapping:[382,11,1,""],MutableSequence:[382,11,1,""],MutableSet:[382,11,1,""],NamedTuple:[382,11,1,""],NewType:[382,10,1,""],NoReturn:[382,8,1,""],Optional:[382,8,1,""],OrderedDict:[382,11,1,""],Pattern:[382,11,1,""],Reversible:[382,11,1,""],Sequence:[382,11,1,""],Set:[382,11,1,""],Sized:[382,11,1,""],SupportsAbs:[382,11,1,""],SupportsBytes:[382,11,1,""],SupportsComplex:[382,11,1,""],SupportsFloat:[382,11,1,""],SupportsInt:[382,11,1,""],SupportsRound:[382,11,1,""],TYPE_CHECKING:[382,8,1,""],Text:[382,11,1,""],TextIO:[382,11,1,""],Tuple:[382,8,1,""],Type:[382,11,1,""],TypeVar:[382,11,1,""],Union:[382,8,1,""],ValuesView:[382,11,1,""],cast:[382,10,1,""],get_type_hints:[382,10,1,""],no_type_check:[382,10,1,""],no_type_check_decorator:[382,10,1,""],overload:[382,10,1,""],type_check_only:[382,10,1,""]},unicodedata:{bidirectional:[384,10,1,""],category:[384,10,1,""],combining:[384,10,1,""],decimal:[384,10,1,""],decomposition:[384,10,1,""],digit:[384,10,1,""],east_asian_width:[384,10,1,""],lookup:[384,10,1,""],mirrored:[384,10,1,""],name:[384,10,1,""],normalize:[384,10,1,""],numeric:[384,10,1,""],ucd_3_2_0:[384,8,1,""],unidata_version:[384,8,1,""]},unittest:{"--buffer":[385,15,1,"cmdoption-unittest-b"],"--catch":[385,15,1,"cmdoption-unittest-c"],"--failfast":[385,15,1,"cmdoption-unittest-f"],"--locals":[385,15,1,"cmdoption-unittest-locals"],"-b":[385,15,1,"cmdoption-unittest-b"],"-c":[385,15,1,"cmdoption-unittest-c"],"-f":[385,15,1,"cmdoption-unittest-f"],"-k":[385,15,1,"cmdoption-unittest-k"],FunctionTestCase:[385,11,1,""],SkipTest:[385,5,1,""],TestCase:[385,11,1,""],TestLoader:[385,11,1,""],TestResult:[385,11,1,""],TestSuite:[385,11,1,""],TextTestResult:[385,11,1,""],TextTestRunner:[385,11,1,""],defaultTestLoader:[385,8,1,""],expectedFailure:[385,10,1,""],installHandler:[385,10,1,""],main:[385,10,1,""],mock:[386,9,0,"-"],registerResult:[385,10,1,""],removeHandler:[385,10,1,""],removeResult:[385,10,1,""],skip:[385,10,1,""],skipIf:[385,10,1,""],skipUnless:[385,10,1,""]},urllib:{error:[390,9,0,"-"],parse:[391,9,0,"-"],request:[392,9,0,"-"],response:[392,9,0,"-"],robotparser:[393,9,0,"-"]},uu:{Error:[394,5,1,""],decode:[394,10,1,""],encode:[394,10,1,""]},uuid:{NAMESPACE_DNS:[395,8,1,""],NAMESPACE_OID:[395,8,1,""],NAMESPACE_URL:[395,8,1,""],NAMESPACE_X500:[395,8,1,""],RESERVED_FUTURE:[395,8,1,""],RESERVED_MICROSOFT:[395,8,1,""],RESERVED_NCS:[395,8,1,""],RFC_4122:[395,8,1,""],SafeUUID:[395,11,1,""],UUID:[395,11,1,""],getnode:[395,10,1,""],uuid1:[395,10,1,""],uuid3:[395,10,1,""],uuid4:[395,10,1,""],uuid5:[395,10,1,""]},venv:{EnvBuilder:[396,11,1,""],create:[396,10,1,""]},warnings:{catch_warnings:[397,11,1,""],filterwarnings:[397,10,1,""],formatwarning:[397,10,1,""],resetwarnings:[397,10,1,""],showwarning:[397,10,1,""],simplefilter:[397,10,1,""],warn:[397,10,1,""],warn_explicit:[397,10,1,""]},wave:{Error:[398,5,1,""],open:[398,10,1,""],openfp:[398,10,1,""]},weakref:{CallableProxyType:[399,8,1,""],ProxyType:[399,8,1,""],ProxyTypes:[399,8,1,""],ReferenceError:[399,5,1,""],ReferenceType:[399,8,1,""],WeakKeyDictionary:[399,11,1,""],WeakMethod:[399,11,1,""],WeakSet:[399,11,1,""],WeakValueDictionary:[399,11,1,""],finalize:[399,11,1,""],getweakrefcount:[399,10,1,""],getweakrefs:[399,10,1,""],proxy:[399,10,1,""],ref:[399,11,1,""]},webbrowser:{Error:[400,5,1,""],get:[400,10,1,""],open:[400,10,1,""],open_new:[400,10,1,""],open_new_tab:[400,10,1,""],register:[400,10,1,""]},winreg:{CloseKey:[402,10,1,""],ConnectRegistry:[402,10,1,""],CreateKey:[402,10,1,""],CreateKeyEx:[402,10,1,""],DeleteKey:[402,10,1,""],DeleteKeyEx:[402,10,1,""],DeleteValue:[402,10,1,""],DisableReflectionKey:[402,10,1,""],EnableReflectionKey:[402,10,1,""],EnumKey:[402,10,1,""],EnumValue:[402,10,1,""],ExpandEnvironmentStrings:[402,10,1,""],FlushKey:[402,10,1,""],HKEY_CLASSES_ROOT:[402,8,1,""],HKEY_CURRENT_CONFIG:[402,8,1,""],HKEY_CURRENT_USER:[402,8,1,""],HKEY_DYN_DATA:[402,8,1,""],HKEY_LOCAL_MACHINE:[402,8,1,""],HKEY_PERFORMANCE_DATA:[402,8,1,""],HKEY_USERS:[402,8,1,""],KEY_ALL_ACCESS:[402,8,1,""],KEY_CREATE_LINK:[402,8,1,""],KEY_CREATE_SUB_KEY:[402,8,1,""],KEY_ENUMERATE_SUB_KEYS:[402,8,1,""],KEY_EXECUTE:[402,8,1,""],KEY_NOTIFY:[402,8,1,""],KEY_QUERY_VALUE:[402,8,1,""],KEY_READ:[402,8,1,""],KEY_SET_VALUE:[402,8,1,""],KEY_WOW64_32KEY:[402,8,1,""],KEY_WOW64_64KEY:[402,8,1,""],KEY_WRITE:[402,8,1,""],LoadKey:[402,10,1,""],OpenKey:[402,10,1,""],OpenKeyEx:[402,10,1,""],QueryInfoKey:[402,10,1,""],QueryReflectionKey:[402,10,1,""],QueryValue:[402,10,1,""],QueryValueEx:[402,10,1,""],REG_BINARY:[402,8,1,""],REG_DWORD:[402,8,1,""],REG_DWORD_BIG_ENDIAN:[402,8,1,""],REG_DWORD_LITTLE_ENDIAN:[402,8,1,""],REG_EXPAND_SZ:[402,8,1,""],REG_FULL_RESOURCE_DESCRIPTOR:[402,8,1,""],REG_LINK:[402,8,1,""],REG_MULTI_SZ:[402,8,1,""],REG_NONE:[402,8,1,""],REG_QWORD:[402,8,1,""],REG_QWORD_LITTLE_ENDIAN:[402,8,1,""],REG_RESOURCE_LIST:[402,8,1,""],REG_RESOURCE_REQUIREMENTS_LIST:[402,8,1,""],REG_SZ:[402,8,1,""],SaveKey:[402,10,1,""],SetValue:[402,10,1,""],SetValueEx:[402,10,1,""]},winsound:{Beep:[403,10,1,""],MB_ICONASTERISK:[403,8,1,""],MB_ICONEXCLAMATION:[403,8,1,""],MB_ICONHAND:[403,8,1,""],MB_ICONQUESTION:[403,8,1,""],MB_OK:[403,8,1,""],MessageBeep:[403,10,1,""],PlaySound:[403,10,1,""],SND_ALIAS:[403,8,1,""],SND_ASYNC:[403,8,1,""],SND_FILENAME:[403,8,1,""],SND_LOOP:[403,8,1,""],SND_MEMORY:[403,8,1,""],SND_NODEFAULT:[403,8,1,""],SND_NOSTOP:[403,8,1,""],SND_NOWAIT:[403,8,1,""],SND_PURGE:[403,8,1,""]},wsgiref:{handlers:[404,9,0,"-"],headers:[404,9,0,"-"],simple_server:[404,9,0,"-"],util:[404,9,0,"-"],validate:[404,9,0,"-"]},xdrlib:{ConversionError:[405,5,1,""],Error:[405,5,1,""],Packer:[405,11,1,""],Unpacker:[405,11,1,""]},xml:{dom:[407,9,0,"-"],sax:[411,9,0,"-"]},xmlrpc:{client:[416,9,0,"-"],server:[417,9,0,"-"]},zipapp:{"--compress":[418,15,1,"cmdoption-zipapp-c"],"--help":[418,15,1,"cmdoption-zipapp-h"],"--info":[418,15,1,"cmdoption-zipapp-info"],"--main":[418,15,1,"cmdoption-zipapp-m"],"--output":[418,15,1,"cmdoption-zipapp-o"],"--python":[418,15,1,"cmdoption-zipapp-p"],"-c":[418,15,1,"cmdoption-zipapp-c"],"-h":[418,15,1,"cmdoption-zipapp-h"],"-m":[418,15,1,"cmdoption-zipapp-m"],"-o":[418,15,1,"cmdoption-zipapp-o"],"-p":[418,15,1,"cmdoption-zipapp-p"],create_archive:[418,10,1,""],get_interpreter:[418,10,1,""]},zipfile:{"--create":[419,15,1,"cmdoption-zipfile-create"],"--extract":[419,15,1,"cmdoption-zipfile-extract"],"--list":[419,15,1,"cmdoption-zipfile-list"],"--test":[419,15,1,"cmdoption-zipfile-test"],"-c":[419,15,1,"cmdoption-zipfile-c"],"-e":[419,15,1,"cmdoption-zipfile-e"],"-l":[419,15,1,"cmdoption-zipfile-l"],"-t":[419,15,1,"cmdoption-zipfile-t"],BadZipFile:[419,5,1,""],BadZipfile:[419,5,1,""],LargeZipFile:[419,5,1,""],PyZipFile:[419,11,1,""],ZIP_BZIP2:[419,8,1,""],ZIP_DEFLATED:[419,8,1,""],ZIP_LZMA:[419,8,1,""],ZIP_STORED:[419,8,1,""],ZipFile:[419,11,1,""],ZipInfo:[419,11,1,""],is_zipfile:[419,10,1,""]},zipimport:{ZipImportError:[420,5,1,""],zipimporter:[420,11,1,""]},zlib:{ZLIB_RUNTIME_VERSION:[421,8,1,""],ZLIB_VERSION:[421,8,1,""],adler32:[421,10,1,""],compress:[421,10,1,""],compressobj:[421,10,1,""],crc32:[421,10,1,""],decompress:[421,10,1,""],decompressobj:[421,10,1,""],error:[421,5,1,""]}},objnames:{"0":["c","var","C variable"],"1":["c","type","C type"],"10":["py","function","Python function"],"11":["py","class","Python class"],"12":["py","classmethod","Python class method"],"13":["py","staticmethod","Python static method"],"14":["std","pdbcommand","pdbcommand"],"15":["std","cmdoption","program option"],"16":["std","opcode","opcode"],"17":["std","envvar","environment variable"],"18":["std","2to3fixer","2to3fixer"],"2":["c","function","C function"],"3":["c","member","C member"],"4":["c","macro","C macro"],"5":["py","exception","Python exception"],"6":["py","attribute","Python attribute"],"7":["py","method","Python method"],"8":["py","data","Python data"],"9":["py","module","Python module"]},objtypes:{"0":"c:var","1":"c:type","10":"py:function","11":"py:class","12":"py:classmethod","13":"py:staticmethod","14":"std:pdbcommand","15":"std:cmdoption","16":"std:opcode","17":"std:envvar","18":"std:2to3fixer","2":"c:function","3":"c:member","4":"c:macro","5":"py:exception","6":"py:attribute","7":"py:method","8":"py:data","9":"py:module"},terms:{"0000007f":159,"0000050000069649e":275,"0000050000166668e":275,"000007ff":159,"0000ffff":159,"000s":385,"0010ffff":159,"00112444be1e":[395,461],"001j":431,"001s":385,"00308d78":101,"00365b68":101,"005s":385,"007b":109,"007f":[346,431],"00c7":[384,426],"00df":109,"00e9":109,"00ea":109,"00ff":[159,466,467,472],"0102030405060708090a0b0c0d0e0f00":236,"010x":147,"0123456789abcdef":442,"0123456789abcdefabcdef":347,"017f":[106,321],"01bb6f00122b177f36cab49cea8b6b26":343,"01ff":456,"01t00":184,"01t12":184,"024e":212,"0268e7":212,"02d":321,"02e":187,"02s":467,"02x":347,"0394a2ede332c9a13eb82e9b24631604c31df978b4e2f0fbd2c549944f9d79a5":236,"03d":[201,266,346],"04d":[91,228],"04e":310,"04x":[93,109],"0518e6":212,"05edt":367,"077e010":431,"07a5610bae9d":472,"0a0b0c0d0e0f":395,"0a1":[114,472],"0a2":[114,472],"0a3":[114,472],"0a3b9":321,"0a4":472,"0a5":30,"0abc":258,"0alpha1":456,"0an":86,"0b1":[114,472],"0b100101":[346,463,465],"0b100110111":431,"0b1010":[227,464],"0b101010":347,"0b10101101":462,"0b101111":462,"0b11":227,"0b1101":462,"0b1110":227,"0b2":[451,472],"0b3":472,"0b4":470,"0b_1110_0101":431,"0beta1":456,"0bf2":109,"0bn":86,"0c076caaa8":451,"0c9aee199e5d":[395,461],"0cf1":466,"0cf2":466,"0cn":86,"0db8":102,"0def":258,"0e0":[187,431],"0f84":109,"0goofi":459,"0o10":[91,227],"0o12":227,"0o177":431,"0o21":462,"0o24":466,"0o377":[431,472],"0o444":298,"0o52":[347,462],"0o600":293,"0o644":153,"0o666":[153,185,293,298,394],"0o70":227,"0o720":464,"0o755":153,"0o777":[65,293,298],"0rc1":472,"0x0":159,"0x00":[109,179,190],"0x00000000004371c3":101,"0x00000000004374e1":101,"0x000000000053db6c":101,"0x000000000053dba8":101,"0x0000000000630ce2":101,"0x00000000008d6be8":101,"0x00000000008d6bea":101,"0x00000000008d6bf6":101,"0x00000000008d6bf8":101,"0x00000010":101,"0x00000014":101,"0x00000020":[101,177],"0x00000024":101,"0x00000030":101,"0x00000031":101,"0x00000045":101,"0x00000046":101,"0x00000144":101,"0x00000254":101,"0x00000274":101,"0x00007fb899f39700":[215,467],"0x00007fbcdbd32700":470,"0x002d6c30":101,"0x00a1db50":436,"0x00ac18f0":193,"0x00b18c90":98,"0x00c45070":98,"0x01":[190,339],"0x010502f0":355,"0x02":[190,470],"0x02070000":96,"0x03":190,"0x03000000":96,"0x03010000":96,"0x03030000":52,"0x030401a2":4,"0x03050400":[51,471,472],"0x03060000":[51,471,472],"0x03060100":[51,471,472],"0x04":[190,424],"0x08":[190,424],"0x0bf2":109,"0x1":[187,346,440,462,465],"0x10":424,"0x1000":424,"0x100020bf":343,"0x1012e1f98":98,"0x1012e5ae8":98,"0x101739a10":466,"0x1021":147,"0x1022bd788":466,"0x1035a2840":228,"0x103fe0000":228,"0x1053bb7c8":140,"0x10ffff":[109,159,227,355,467],"0x12":395,"0x12131415":349,"0x1234":395,"0x12345678":395,"0x12345678123456781234567812345678":395,"0x144":91,"0x16d07cc":91,"0x1d000000":177,"0x1f":179,"0x20":[58,144,346,424],"0x2000":424,"0x265e":109,"0x2a":[227,347],"0x3":346,"0x34":395,"0x37f080":463,"0x37f850":463,"0x400":431,"0x400cad2c":459,"0x400cad4c":459,"0x402c2080":460,"0x402c2090":460,"0x402ef0d4":460,"0x4198d0":91,"0x50":109,"0x5678":395,"0x567812345678":395,"0x7352a0":91,"0x7f":[179,346],"0x7f3ddc9f4350":346,"0x7f46b9fe31e0":467,"0x7f4e7dd8fa80":342,"0x7fa66db2be58":410,"0x7fbcd41666f8":470,"0x7fbcd41666fc":470,"0x7fc859830220":399,"0x7fffffff":472,"0x80":[54,109,179],"0x8116870":458,"0x8117f90":[458,459],"0x90":147,"0x_ff_ff_ff_ff":470,"0xa":4,"0xa5":91,"0xb":4,"0xb2":91,"0xb77e6fac":410,"0xb77ec1cc":410,"0xb77ec26c":410,"0xb77ec2ac":410,"0xbb":159,"0xbf":159,"0xc":4,"0xc000":106,"0xcb":[38,470,472],"0xcd":[38,472],"0xd800":58,"0xdb":[38,470,472],"0xdbff":58,"0xdc00":58,"0xdd":[38,472],"0xdeadbeef":431,"0xdecafbad":[104,266],"0xdfff":58,"0xef":159,"0xf":4,"0xfb":[38,470,472],"0xfd":[38,472],"0xff":[54,159,227],"0xffd2":106,"0xfffe":[58,159],"0xffff":[355,467,472],"0xffffffff":[147,421,459,470],"0xffffffffl":459,"0xxxxxxx":159,"10042ed0":437,"100_000_000_000":431,"100k":83,"100m":128,"100x":467,"1034h":472,"10aedt":367,"10c":349,"10d":442,"10e6":91,"10ffff":[424,467],"10j":431,"10px":461,"10s":[104,349,472],"10shhb":349,"10x":[466,467,468,471,472],"10xxxxxx":159,"110xxxxx":159,"1110xxxx":159,"11110xxx":159,"11da":[395,461],"120000j":465,"120x":467,"1234567890123l":458,"123e":187,"12f":460,"12g":[440,456],"12j":465,"12s":104,"12x":467,"136kb":449,"13th":375,"1492e7":212,"14_15_93":431,"14_15_93j":431,"14e":431,"14j":431,"152x261":66,"15g":355,"15s":[104,266,267,463,466],"15x":466,"16be":159,"16fd2706":[395,461],"16g":355,"16le":159,"17f":440,"17g":[456,465],"17x":472,"18014398509481984l":462,"18288201344j":460,"18446744073709551616l":458,"1970s":86,"1980s":462,"1990s":[422,462],"199999999999ap":465,"19da":466,"19s":467,"1_000_000":470,"1_000_000_000_000_000":470,"1a2":[4,74],"1beta1":456,"1bf21a98c78a1c376ae9":236,"1e100":[193,275,426,431],"1e100j":431,"1e300":193,"1e50":346,"1e500":17,"1e6":227,"1e9999999999999999999":187,"1f600":109,"1f609":109,"1mb":463,"1p2":454,"1rc":472,"1rc1":472,"1st":[91,184],"1xx":246,"200c":463,"200x100":370,"200x200":380,"20d9cd024d4fb086aae819a1432dd2466de12947831b75c5a30cf2676095d3b4":236,"20ni":391,"20th":456,"212a":[106,321],"217160342717258261933904529e":375,"21716034272e":375,"21st":472,"223967b49e49":470,"2251799813685248l":462,"23000e":187,"23e":187,"23e999":187,"24n":347,"256color":472,"256k":461,"25c8":339,"25t00":184,"265e":109,"265f":109,"29s":467,"2_147_483_648":174,"2a3":355,"2a4":472,"2am":184,"2devel9":463,"2e2":187,"2ef0":346,"2fel":391,"2gib":472,"2nd":[91,321,472],"2pnp":363,"2pnpn":363,"2to3":[62,65,93,188,253,462,463,464,466,472],"303e":212,"30pm":184,"30s":101,"30t21":459,"30x":[392,467],"320px":461,"321000e":187,"321e":187,"32be":159,"32bit":[66,339,458,472],"32c18f":380,"32le":159,"32m":466,"32mu":466,"33af":109,"33cc8c":380,"33md":466,"340k":457,"345s":467,"34a04430":90,"354aa":321,"35521e4e733823c7":95,"3603bae63c13":472,"37814e6":212,"3972e6":212,"3ad2a9b37c6070e374c7a8c508fe20ca86b6ed54e286e93a0318e95e881db5aa":236,"3b8a":[395,461],"3bd30745bf206a48f8b576a1da3d90f55a0a4187":95,"3bsd":339,"3ca4":[395,461],"3d363ff7401e02026f4a4687d4863c":236,"3de":[168,343,470,472],"3dgamer":458,"3dm":101,"3rc1":472,"3rd":[90,321,382,442,467,472],"3to2":472,"3x4":438,"3xxx":462,"400s":81,"40x":392,"417a":463,"421e":212,"42_572_654":442,"42els":472,"433b":[395,461],"4397e6":212,"43_132_495":442,"43b3c982cf697e0c5ab22172d1ca7421":236,"43c":370,"45356m":461,"4746e7":212,"49g":463,"4a0":86,"4dom":456,"4rc1":472,"4rc2":[],"4th":342,"50s":81,"50th":345,"52g":463,"5511151231257827e":187,"552eb1c0f52260d9":95,"5555555555555p":462,"5559e7":212,"561702493119680037517373933e":187,"567004bf96e4a25773ebf4":236,"57s":467,"5a1":472,"5a2":472,"5aef":339,"5r92":458,"5th":342,"6004799503160661l":462,"61261m":462,"63103m":30,"64bit":[66,356],"65535l":463,"67300e":212,"68656c6c6f":468,"686e":212,"688e":212,"68k":295,"68s":467,"6a1":[111,462],"6dm":101,"6fa1d8fcfd719046d762":236,"6fa459ea":[395,461],"6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183":236,"6final":456,"6jack":225,"6rc1":472,"6shhbbb":466,"6th":442,"6to4":258,"6yd86yt":458,"7074029114692207l":462,"70th":184,"70x":[471,472],"717ak":321,"718ak":321,"71i":458,"727ak":321,"730920th":184,"750000e":462,"77e10":431,"7a1":472,"7b1":472,"7bc817d5ba917528e8bd07ec461c635291e7b06a":472,"7bit":[196,198,199,202,204,209,271,466,467],"7eguido":391,"7rc":472,"7rc1":472,"80s":101,"81w":347,"82eb":[395,461],"869e":212,"86yd":458,"87a":250,"87ecad1261e02ac7":95,"886313e1":[395,461],"894e":[395,461],"89a":250,"89ric":467,"8baf":[395,461],"8bit":[197,198,199,202,203,204,208,209,466,467],"8bitmim":[336,337,469,472],"8c7fada847da":[395,461],"8fa3":466,"8ghz":310,"8svx":338,"8th":345,"8zc":472,"901e4e52b20a":472,"921f9f01b866ep":440,"9514790517935283e":463,"9514790517935289e":463,"95f0":343,"976e":212,"999999999999ap":187,"999_999_999":174,"9b90":[395,461],"9tjqk":321,"\u00e5strand":[459,460],"\u00e9ric":[109,467,468,472],"\u00f8yvind":467,"\u0130":[106,321],"\u0131":[106,321],"\u0142ukasz":[101,288,466,468,469,470,471,472],"\u0161arka":472,"\u0161milauer":468,"\u017f":[106,321],"\u017fpam":106,"\u03b1":472,"\u03bc":345,"\u03c0":[156,275],"\u03c3\u00b2":345,"\u03c4":[156,275,470],"\u043a\u043e\u0440\u0435\u043d\u0431\u0435\u0440\u0433":472,"\u043c\u0430\u0440\u043a":472,"\u0454":471,"\u05d0":472,"\u212a":[106,321],"\u2170":109,"\u2176":109,"\u2178":109,"abcd\u00e9":109,"abstract":[29,34,50,62,71,80,82,84,85,90,91,93,125,129,132,134,135,161,167,170,177,183,184,187,209,214,220,222,223,245,253,254,257,263,268,281,290,291,293,297,303,317,330,339,343,346,355,370,382,392,404,424,426,436,437,459,461,463,464,466,467,469,470,471,472,473],"alliancefran\u00e7ais":[159,459],"andr\u00e9":[109,232,342,456,457,458,459,461,472],"avi\u00f3n":[462,463,467,470,471],"boolean":[5,15,31,62,65,74,91,95,103,108,124,139,145,168,177,178,183,184,190,193,222,227,236,237,244,246,249,252,253,261,267,274,284,291,293,295,306,321,322,339,340,343,352,366,370,373,380,386,392,396,399,407,408,416,421,423,424,429,438,457,460,461,462,463,464,466,468,469,470,472,473],"borgstr\u00f6m":468,"br\u00e4ndstr\u00f6m":[465,466],"break":[31,52,57,58,62,68,74,81,82,84,90,93,95,97,99,104,105,106,107,111,124,134,137,140,145,153,159,171,177,178,190,193,201,203,209,212,222,237,248,252,254,260,271,284,292,299,301,309,316,318,321,328,334,337,339,342,343,346,347,360,362,363,365,380,385,391,396,397,404,406,408,423,424,425,427,429,431,436,439,441,445,448,456,457,458,459,461,462,463,465,466,467,468,469,471,472],"byte":[4,5,7,11,13,15,17,22,23,28,30,31,35,37,38,39,45,53,54,57,58,60,62,65,66,84,85,90,91,93,95,96,97,104,105,106,107,110,114,119,120,123,124,125,129,130,135,137,138,141,143,144,146,147,151,153,155,159,167,168,175,178,179,183,185,189,190,195,196,197,198,200,201,202,203,206,207,208,209,213,214,216,225,227,232,235,236,238,243,249,250,251,252,253,255,257,258,261,263,265,267,268,269,271,274,279,283,284,287,288,293,294,295,297,298,300,301,305,306,308,311,313,316,319,320,321,324,326,329,333,334,336,337,339,340,342,343,344,350,351,355,359,360,361,363,370,374,375,378,382,392,395,397,398,402,403,404,405,407,408,410,411,412,413,416,418,419,421,424,426,428,436,442,446,448,451,455,458,459,460,461,463,464,465,466,467,468,470,471,472,473],"c\u00e9dric":[469,472],"case":[1,4,5,7,13,17,21,22,23,28,30,31,35,36,41,45,47,49,51,52,53,54,56,57,58,60,62,65,66,68,69,72,74,75,77,78,79,81,82,86,90,91,93,94,95,97,98,99,102,103,104,105,106,107,108,109,110,113,114,118,119,122,123,124,128,129,135,139,140,141,143,145,147,148,150,151,153,156,157,159,160,161,164,168,170,176,177,178,179,182,184,187,188,189,190,193,196,197,202,203,204,206,208,209,210,211,212,214,215,216,221,222,227,229,232,233,235,236,237,240,241,244,245,246,249,251,252,254,257,264,265,266,267,268,269,271,272,275,276,279,282,284,288,289,292,293,294,295,297,298,299,301,304,305,307,309,310,316,318,320,321,326,327,328,330,331,332,333,334,335,336,337,339,340,342,343,345,346,347,348,349,350,353,355,359,360,363,366,367,368,370,372,373,375,378,380,382,384,386,387,388,391,392,396,397,398,402,404,406,407,408,410,412,413,417,418,422,423,424,425,426,428,431,432,433,434,436,437,438,439,440,444,446,448,451,455,456,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472,473],"catch":[22,31,62,74,84,91,93,97,99,104,105,109,110,168,176,193,214,245,254,266,292,293,317,324,332,333,334,350,367,382,385,392,405,424,426,439,456,459,461,462,463,464,466,467,468,470,472],"char":[5,7,8,9,10,12,13,16,17,21,22,23,28,30,31,35,36,37,38,39,41,44,45,48,49,53,54,55,57,58,60,78,79,81,82,85,95,96,101,123,147,159,177,178,203,241,248,261,265,283,346,347,349,368,370,406,410,424,436,459,461,462,463,468,471,472],"chrigstr\u00f6m":463,"class":[2,21,29,30,36,40,41,45,47,48,49,53,56,57,58,61,62,69,70,71,72,74,79,81,82,86,87,90,92,93,95,97,99,102,103,104,105,106,107,108,109,110,113,114,120,123,125,129,131,132,134,135,136,137,138,139,140,141,145,146,147,149,150,151,152,153,155,157,160,161,165,168,170,171,172,173,176,177,178,179,181,183,184,185,186,187,188,189,190,193,195,196,197,198,199,201,202,203,204,206,207,208,209,219,220,222,223,224,225,226,227,228,235,237,241,242,243,244,245,246,247,248,249,251,253,255,258,260,261,263,265,266,267,268,269,271,273,276,279,280,281,285,286,288,290,292,293,295,296,297,298,299,300,302,303,304,306,307,309,313,315,317,320,321,322,323,324,325,326,327,328,329,331,332,336,337,339,340,342,343,345,347,350,354,355,359,360,363,365,366,367,368,369,370,371,372,373,376,377,378,384,391,393,395,396,397,399,400,401,402,405,406,407,408,409,410,411,413,414,416,417,418,419,420,425,426,427,429,430,432,435,437,438,439,441,442,446,447,448,455,456,457,459,460,463,464,465,466,468,469,471,472,473],"const":[5,7,8,9,10,12,13,16,17,21,22,23,28,30,35,36,37,41,44,45,48,49,53,54,55,57,58,60,62,79,81,85,95,96,101,120,292,408,468,471,472],"d\u00e9buter":288,"d\u00e9jeuner":201,"d\u00f3nde":466,"d\u00f6rwald":[459,460,461],"default":[5,7,13,16,22,23,25,29,30,31,41,45,53,56,57,58,60,62,65,66,68,69,70,74,75,77,79,81,82,83,84,89,90,92,93,94,97,98,99,102,103,104,105,106,109,110,111,112,113,117,119,120,123,124,125,128,129,132,133,134,135,136,137,138,139,140,141,143,144,145,147,149,151,152,153,154,155,156,157,158,159,160,161,162,164,167,168,169,170,171,174,176,177,178,179,184,185,187,188,189,190,193,196,197,198,199,201,202,203,204,205,206,207,208,209,210,211,212,214,215,216,217,219,222,225,227,228,229,230,231,232,233,235,236,237,238,241,243,244,245,246,248,249,252,254,257,258,260,261,264,265,266,267,268,269,271,272,275,276,279,282,284,286,287,288,289,291,293,294,295,297,298,299,300,301,302,305,306,307,308,309,310,311,313,315,316,317,318,319,320,321,322,323,327,328,329,330,331,332,333,334,335,336,337,339,340,345,346,347,349,350,352,355,356,357,359,360,361,363,365,366,367,368,370,373,375,376,377,378,379,380,381,382,384,385,387,391,392,394,396,398,399,400,402,403,404,406,408,409,410,411,412,413,414,416,417,418,419,421,423,424,425,426,427,428,431,432,436,438,440,441,442,443,444,445,446,448,449,451,452,453,454,456,457,458,459,460,461,462,464,465,466,467,469,470,471,472],"devan\u0101gar\u012b":187,"enum":[38,62,164,183,242,253,261,310,313,321,334,343,381,424,467,472],"est\u00e1":466,"export":[7,22,31,38,39,41,44,47,57,62,65,74,77,78,79,83,91,93,110,111,120,124,152,176,184,291,301,308,339,346,355,375,432,446,459,463,466,467,469,470,471,472],"f\u00fcrstenau":[463,472],"fern\u00e1ndez":463,"final":[4,28,29,31,45,54,56,57,62,65,74,79,80,82,84,86,90,91,95,99,103,104,105,106,107,108,111,114,117,118,129,135,139,140,143,145,159,177,182,183,187,189,190,193,198,204,212,214,236,246,251,252,254,256,257,260,266,271,284,291,292,298,299,301,310,313,316,317,321,335,340,342,343,347,355,359,362,365,366,370,373,375,377,380,381,385,386,387,392,396,397,403,406,411,423,424,425,426,427,428,431,432,435,437,439,440,442,443,456,457,458,459,460,462,463,464,466,467,469,470,471,473],"float":[5,15,17,37,43,53,57,62,82,90,91,93,95,105,113,117,122,123,129,140,143,156,161,163,167,168,176,177,182,184,189,193,210,214,223,227,228,229,234,249,252,253,254,260,261,265,271,274,275,284,289,290,292,293,294,301,306,310,320,321,324,329,334,339,342,343,345,347,349,355,366,367,368,373,375,380,382,384,405,416,424,426,436,438,441,445,446,447,456,457,458,459,461,462,463,464,465,466,467,468,470,471,472,473],"fran\u00e7oi":[232,467,468,469],"fu\u00dfbal":[197,206],"function":[2,6,9,10,12,14,16,17,18,19,21,22,23,26,27,28,29,30,31,32,33,34,36,37,38,39,40,42,43,44,45,46,47,48,49,50,51,52,53,55,56,57,59,60,61,62,66,69,70,71,72,74,77,78,80,81,82,83,86,87,90,92,93,94,96,97,100,101,102,103,104,105,109,110,111,113,114,117,118,119,120,122,124,125,127,128,129,132,133,134,135,136,137,138,139,140,141,142,143,144,145,146,147,148,149,150,151,154,157,158,159,160,162,163,165,168,169,171,172,175,176,179,183,184,185,186,187,188,189,193,195,196,197,198,199,201,202,203,204,205,206,207,208,209,210,211,213,214,215,216,217,219,220,223,224,225,229,230,231,232,233,235,236,237,238,239,243,244,246,248,249,250,251,253,255,256,257,261,263,264,265,268,269,272,273,274,276,279,281,282,284,287,289,290,292,293,294,295,297,298,299,300,301,302,304,305,306,308,309,310,311,313,315,316,317,318,319,321,322,323,324,326,327,329,331,332,333,334,335,338,340,341,344,348,351,354,357,358,359,360,362,363,364,365,366,368,370,374,375,376,377,384,386,388,390,391,392,394,395,396,398,399,400,401,403,404,405,406,407,408,409,411,412,413,414,417,418,419,421,424,425,427,428,429,432,433,435,436,438,439,440,441,442,443,445,447,448,450,451,453,455,458,459,463,465,466,468,472,473],"g\u00fcrzenichstra\u00df":109,"g\u00fcrzenichstrass":109,"gon\u00e7alv":467,"goto":[31,62,96,157,190,380,465,466],"gr\u00e4sman":472,"gr\u00e9goir":461,"gruszczy\u0144ski":[467,468,472],"gust\u00e4bel":[459,460,461,462,463,466,467],"h\u00e4ring":[342,458,461,462,463],"h\u00e5kan":[469,472],"h\u00f6ch":472,"hron\u010dok":472,"i\u00f1igo":467,"ib\u00e1\u00f1ez":232,"import":[7,10,22,29,30,31,38,41,54,57,59,60,62,64,65,69,70,72,74,75,77,78,79,81,82,83,84,85,86,89,90,92,93,94,95,96,97,98,99,101,102,103,104,105,106,107,108,109,110,111,113,114,115,116,117,118,120,122,123,124,125,126,128,129,133,135,136,137,138,139,140,141,142,144,150,151,152,153,154,157,161,163,164,167,168,169,170,171,173,174,176,177,178,184,185,187,188,189,190,192,193,194,196,197,201,203,206,208,209,210,212,214,215,216,217,219,221,223,225,227,228,230,232,233,235,236,237,241,242,243,244,245,246,248,249,250,253,254,256,257,261,264,265,269,271,272,275,276,279,280,284,288,292,293,294,297,298,299,301,303,304,307,308,309,310,311,313,314,315,316,318,320,321,322,323,325,326,327,328,329,330,331,332,333,334,335,337,339,340,342,343,344,345,346,347,349,350,352,354,355,356,357,358,359,360,361,362,363,367,368,370,372,373,375,376,377,378,380,381,382,384,385,386,391,392,393,395,396,397,399,403,404,405,406,407,408,409,410,412,416,417,418,423,424,425,426,427,429,431,434,436,437,438,439,440,441,442,444,447,448,449,451,453,455,456,458,463,464,465,466,469,470,471,472,473],"int":[5,6,7,8,9,10,11,12,13,14,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,39,40,41,43,44,45,48,49,50,51,53,54,55,56,57,58,60,61,62,78,79,81,82,85,90,91,93,94,95,101,102,103,105,106,113,114,122,123,124,125,129,130,140,142,157,161,167,168,171,177,182,184,187,189,212,214,223,227,228,237,241,249,253,254,257,258,261,275,282,289,292,293,295,308,318,320,321,328,329,339,342,345,347,349,354,367,368,375,378,381,382,385,386,395,399,402,407,408,409,410,416,418,424,426,436,437,439,442,445,446,448,451,456,458,459,460,461,462,463,464,465,466,468,469,470,471,472],"j\u00e1n":472,"j\u00f3nsson":[463,466,468],"j\u00f6rg":460,"j\u00fcrgen":460,"j\u0119drzejewski":[467,472],"jes\u00fa":[462,463,467,470,471],"jos\u00e9":[463,472],"kalv\u0101n":472,"ko\u0142odziej":[470,472],"kristj\u00e1n":[463,466,468],"l\u00f6vdahl":[469,472],"l\u00f6wi":[109,232,288,456,458,459,460,461,462,463,466,467,468],"long":[5,6,9,21,28,30,31,35,37,41,53,54,56,57,58,60,62,65,68,69,74,79,81,84,86,90,91,93,94,95,99,101,103,104,105,106,107,110,111,113,122,123,128,129,140,144,147,148,149,167,168,170,177,178,189,193,203,209,213,216,225,227,228,229,230,242,243,246,248,249,253,257,258,260,266,267,274,284,292,293,297,301,305,307,308,309,310,320,321,323,329,331,334,337,339,340,342,343,346,349,355,359,365,366,367,368,369,370,372,373,377,392,393,396,397,402,404,407,408,422,423,424,426,431,436,442,445,446,448,451,455,456,457,459,461,462,463,464,465,466,467,468,469,470,471,472,473],"m\u00e9d\u00e9ric":472,"mart\u00ednez":472,"micha\u00ebl":[470,472],"micha\u0142":472,"micka\u00ebl":472,"na\u00efv":[298,457],"new":[0,1,3,5,6,7,8,9,10,11,12,13,14,16,17,18,19,20,21,22,23,24,25,27,28,30,31,32,33,34,35,36,37,38,39,40,41,43,44,45,46,49,50,51,52,53,54,55,56,57,58,60,61,62,66,71,74,78,79,80,81,82,84,85,90,91,92,93,94,95,96,97,98,101,103,104,105,106,107,108,109,110,113,117,118,122,123,125,129,131,132,134,135,137,139,140,141,143,144,145,151,152,153,155,156,157,158,159,161,162,164,167,168,170,171,172,174,176,177,178,179,182,184,185,187,189,190,192,193,195,196,197,198,199,200,201,202,204,206,207,208,209,210,211,212,214,215,216,217,222,223,225,227,228,229,233,235,236,237,238,239,240,242,243,246,248,249,250,251,252,254,257,258,260,261,264,265,266,267,268,269,271,272,275,276,279,281,282,284,288,291,293,294,295,297,298,299,301,302,303,304,306,307,309,310,311,313,314,316,317,318,320,321,322,323,324,326,327,328,329,330,332,333,334,335,336,337,339,340,342,343,344,345,346,347,349,350,352,354,355,356,359,361,362,363,365,366,367,368,370,372,373,375,376,377,378,380,381,382,385,386,387,390,391,392,393,395,396,399,400,402,404,407,408,409,410,412,413,414,416,417,418,419,420,421,423,424,426,428,430,431,432,435,436,437,438,439,440,441,442,445,446,447,448,450,451,453,455,472],"ni\u00f1o":391,"null":[2,5,7,8,9,10,11,13,14,15,16,17,18,19,21,22,23,24,25,26,27,28,30,31,32,34,35,36,37,38,39,40,41,43,45,47,48,49,50,51,53,54,55,56,57,58,60,61,62,78,81,82,85,96,104,105,109,111,124,176,177,190,227,229,244,261,272,282,287,293,301,320,321,339,342,343,349,350,351,402,405,407,408,419,431,432,456,460,463,465,468,469,470,471,472],"o\u017carowski":463,"orr\u00f9":[467,468],"panzenb\u00f6ck":468,"pep\u00e9":201,"petten\u00f2":461,"probl\u00e8m":288,"public":[16,30,50,62,64,86,90,107,110,112,157,161,176,177,189,205,224,225,236,241,244,254,257,258,263,284,286,292,316,318,332,339,343,346,347,354,355,359,363,365,368,382,384,385,392,405,407,410,413,422,431,432,436,456,457,459,460,462,463,466,467,468,469,470,471,472],"pyth\u00f6n":[343,471],"r\u00e9mi":472,"r\u00e9pertoir":109,"return":[3,5,6,7,8,9,10,11,12,13,14,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,48,49,50,51,52,53,54,55,56,57,58,60,61,62,65,66,77,78,79,81,82,85,90,92,93,94,96,97,98,99,101,103,104,105,106,107,108,109,110,117,118,119,120,122,123,124,125,127,128,129,131,132,134,135,136,137,138,139,140,141,142,143,144,145,147,148,149,150,151,152,153,154,155,156,157,158,159,160,161,162,164,167,168,169,170,171,172,173,174,176,178,179,180,182,184,185,187,188,189,190,193,196,197,198,200,202,203,204,205,206,207,208,209,210,211,212,214,215,216,217,219,221,223,225,227,228,229,230,231,232,233,234,235,236,237,238,241,243,244,245,246,248,249,250,251,252,254,257,258,260,261,262,264,265,266,267,268,269,271,272,274,275,276,279,282,283,284,286,287,288,289,291,292,293,294,295,297,298,299,301,302,303,304,305,306,307,309,310,311,312,313,314,316,318,319,320,321,322,323,324,325,326,327,328,329,330,332,333,334,335,336,337,338,339,340,341,342,343,344,345,346,347,348,349,350,351,354,355,356,357,359,360,361,362,363,365,366,367,368,370,372,373,374,375,376,377,378,380,381,382,384,385,386,390,391,392,393,395,396,397,398,399,400,402,403,404,405,406,407,408,409,410,411,412,413,414,416,417,418,419,420,421,423,424,425,426,427,428,429,431,434,436,437,438,439,442,445,446,447,448,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],"rodol\u00e0":[466,467],"s\u00e9bastien":[455,466],"sabl\u00e9":466,"sehensw\u00fcrdigkeiten":466,"sgha\u00efer":472,"short":[1,5,7,37,38,53,62,65,69,74,86,90,92,93,95,99,104,106,107,111,122,123,144,160,161,176,177,178,193,212,230,238,246,257,258,271,284,289,292,293,302,305,332,346,349,350,355,367,368,370,380,385,408,410,418,430,437,438,442,451,456,458,459,461,463,466,467,468,470,471,472],"skytt\u00e4":472,"st\u00e9phane":[470,471,472],"static":[5,19,26,30,31,41,53,57,58,62,65,69,78,79,81,82,83,84,85,86,93,95,96,106,114,190,216,227,228,252,317,321,346,366,370,382,386,387,424,432,436,457,458,459,460,463,465,466,469,470,471,472],"super":[91,93,98,104,106,111,118,122,134,161,170,204,227,252,284,301,314,324,370,378,380,387,392,396,399,424,436,446,458,462,464,468,470,472],"switch":[28,30,31,58,62,81,90,95,96,107,109,110,111,112,135,159,193,211,227,232,237,244,246,248,292,307,321,324,326,346,347,355,380,386,409,428,437,446,451,456,458,459,460,461,462,463,464,465,466,468,471,472],"tam\u00e1":472,"throw":[60,83,95,99,103,113,140,162,178,248,311,391,424,426,435,461,467,470,472],"tis\u00e4ter":472,"transient":[248,267,342],"trouv\u00e9":109,"true":[5,6,7,8,9,10,11,12,14,16,18,19,20,21,22,24,25,27,30,31,32,33,34,35,39,40,41,45,49,50,51,54,55,56,57,58,60,61,65,72,74,79,82,84,90,91,93,94,95,97,99,102,103,104,105,107,108,109,111,113,117,118,122,124,125,128,129,131,132,134,135,136,137,139,140,141,144,145,147,151,152,153,155,156,157,158,159,161,164,167,168,169,170,171,174,176,177,178,180,182,184,187,189,190,193,197,199,201,202,204,205,206,208,209,210,212,214,215,216,217,219,221,222,225,227,228,229,230,232,233,236,237,239,241,242,243,244,249,251,252,254,257,258,260,261,262,265,266,267,268,269,271,275,276,279,283,284,288,291,292,293,294,295,297,298,299,301,303,305,306,309,310,313,316,318,319,321,322,326,327,328,329,330,331,332,333,334,335,336,337,339,340,342,343,345,346,348,349,350,354,355,356,358,359,361,363,365,366,367,373,374,376,377,378,380,381,382,385,386,387,391,392,393,394,396,397,399,400,402,404,407,409,410,412,414,416,417,418,419,420,423,424,426,427,431,432,436,437,438,439,440,442,444,445,446,447,448,451,455,456,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],"try":[30,31,38,41,45,53,57,58,62,65,66,69,74,77,79,81,82,83,84,85,86,90,92,93,97,99,102,103,104,105,106,107,109,110,111,117,122,124,129,130,135,139,140,142,143,147,153,161,167,168,169,176,177,178,184,189,190,193,201,212,213,214,225,227,228,230,232,237,246,248,251,252,254,257,260,261,268,271,280,284,289,291,292,293,295,297,299,301,304,307,310,316,317,321,322,325,332,333,334,337,339,342,343,350,355,359,360,362,363,366,368,370,372,377,380,382,386,387,392,396,397,399,400,404,405,410,416,417,419,424,425,426,427,428,429,430,431,432,434,435,437,439,440,442,445,451,455,456,457,458,459,460,462,463,464,466,467,468,469,470,472,473],"typeof":7,"v\u00e1clav":468,"var":[16,84,93,98,122,161,168,171,212,227,268,343,356,361,382,386,423,442,446,460,461,462,463,464,466,472],"void":[3,5,7,9,10,11,16,20,21,22,24,26,28,30,31,34,35,37,38,41,44,45,47,53,54,55,56,57,58,60,77,78,79,81,82,83,92,96,177,321,349,408,463],"while":[1,7,15,21,22,26,30,31,32,36,41,44,45,47,57,58,61,62,64,65,66,70,72,74,78,79,81,82,85,86,90,91,92,93,95,96,97,99,102,103,104,105,106,107,109,111,112,113,117,118,122,124,128,129,130,135,136,137,140,141,151,153,156,159,161,168,170,171,173,176,177,178,180,184,185,187,189,190,191,193,197,200,209,210,212,214,222,227,228,232,235,236,237,243,244,248,252,253,257,258,260,264,265,266,267,268,269,271,275,284,292,293,297,299,301,304,308,310,313,316,318,320,321,328,329,330,332,334,336,337,339,340,342,343,346,347,349,350,351,355,361,363,365,366,367,370,376,377,380,382,385,391,392,395,396,397,398,407,410,419,421,424,426,427,428,429,430,431,432,433,434,436,437,438,439,440,442,445,446,447,448,449,451,455,456,457,458,459,460,461,462,463,466,467,468,469,470,471,472],"ziad\u00e9":[462,463,466,469,472],ACE:[159,459],ACS:178,AES:[343,459],AND:[74,258,422,426],ARE:422,Added:[5,57,62,65,66,75,81,99,103,129,131,140,147,151,153,158,161,164,167,174,176,184,185,190,202,203,207,208,210,214,215,219,227,228,235,237,242,246,258,260,261,269,279,284,286,293,294,298,309,310,313,315,321,326,329,331,333,334,337,340,342,346,347,349,350,351,355,359,363,366,374,375,377,378,382,385,386,391,392,394,396,397,398,399,411,413,416,418,419,421,426,428,451,456,460,461,462,465,466,467,469,470,471,472,473],Adding:[57,62,71,80,106,120,252,290,321,346,352,373,392,456,459,460,462,468,469,472,473],AgE:342,Age:[343,459],Ames:470,And:[62,66,74,79,81,94,99,103,104,105,107,111,122,124,167,170,176,187,193,201,227,232,237,256,261,291,292,321,342,343,359,373,386,387,419,457,461,465,466,467,472],Are:[62,168,188,360],BEING:422,BUT:[331,422],Being:[1,106,160,346,466],Bos:472,But:[57,68,72,79,82,84,87,90,91,94,95,96,99,104,105,106,107,110,190,193,195,212,223,257,265,271,292,342,343,346,355,367,392,402,436,440,458,459,461,463,465,468,472],CCS:343,CVS:[75,293,456,457,458,459,460,461,472],Cls:432,DES:[174,312,422],DNS:[62,104,132,159,258,339,343,469],DOS:[65,84,92,178,288,292,451,456,458,466,468,472],Das:[469,470,472],DoS:[406,472],Doing:[91,103,159,334,343,382,385,470,472],EXE:[333,442,458,466],Ewing:[456,467],FDs:472,FOR:[62,321],For:[1,4,5,7,9,11,17,21,22,23,26,28,30,31,38,39,41,43,47,57,58,60,62,64,65,66,68,69,72,74,75,77,78,79,80,81,82,83,84,85,86,87,90,91,92,93,94,95,96,98,99,101,102,103,104,105,106,107,108,109,110,111,112,113,115,117,118,119,122,124,125,128,129,134,135,136,140,141,144,145,149,150,151,152,153,156,159,160,161,162,167,168,170,171,172,174,176,177,178,182,184,187,188,189,190,192,193,195,196,197,198,201,202,203,204,205,206,207,208,209,210,212,213,214,216,217,220,221,225,227,228,230,232,233,235,236,237,241,243,244,246,247,248,249,251,252,253,254,256,257,258,260,261,266,267,268,269,270,271,272,274,275,276,279,282,283,284,289,291,292,293,295,297,298,299,301,302,304,308,310,313,314,315,316,317,318,320,321,322,323,324,326,328,332,333,334,335,337,339,340,342,343,344,345,346,347,348,349,350,354,355,356,357,358,359,360,362,363,365,366,367,368,369,370,372,373,375,377,380,381,382,384,385,386,387,391,392,393,394,395,398,399,400,402,403,404,405,406,407,408,410,411,416,418,419,420,421,422,423,424,426,427,428,429,430,431,432,435,436,437,438,439,440,441,442,443,444,445,446,447,448,449,450,451,453,454,455,456,457,458,459,460,461,462,464,465,466,467,468,469,470,471,472,473],Going:79,HLS:163,Has:[31,227,237,284,295,382],IDE:[62,86,91,358,452,455,456,458],IDEs:[62,86,91,93,432,452],IDs:[269,284,301,373,399,460,472],IIS:404,INTO:[301,342],IPS:104,IPs:472,ITS:422,Ice:62,Ides:447,Iles:468,Its:[21,28,51,53,57,62,64,78,79,81,82,91,94,95,98,117,145,151,154,168,169,177,178,182,207,227,232,237,244,257,266,284,310,326,343,355,359,366,367,380,392,403,410,417,419,423,424,426,428,441,451,456,466,471],LHS:432,LTS:471,NCS:395,NFS:[65,213,472],NIS:[62,234,253,388],NOT:[7,57,110,244,404,422,426,470],Not:[31,52,57,65,72,81,83,86,91,94,95,110,111,124,131,139,140,168,185,187,213,214,215,228,229,243,244,246,252,269,271,274,298,320,329,332,333,334,346,363,385,399,410,431,459,460,461,462,464,472],ONE:[109,122,212,346,384],ORed:[57,193,216,227,293,370,403],ORing:[293,343],OSes:[90,257,339,456,471,472],One:[53,60,62,78,79,81,84,87,90,91,93,95,97,98,99,104,106,107,109,110,112,118,121,122,128,135,144,156,158,168,177,182,193,202,222,227,232,246,248,252,258,266,284,296,307,309,310,319,321,334,342,343,346,348,359,363,365,373,386,387,391,397,410,424,426,428,430,431,432,439,440,443,444,445,446,447,456,457,458,459,460,461,462,463,465,466,467,471,472],PRs:472,PVS:472,RCS:75,RDS:472,REs:[106,321],RFS:213,RHS:[432,467],SUCH:422,Such:[7,31,52,57,65,79,84,93,102,103,122,135,173,182,189,197,204,206,208,248,293,299,301,308,385,424,426,432,446,459,463,466,471,472],Sys:472,THAT:422,THE:[202,422],THEN:321,TIS:460,TLS:[62,132,225,243,253,259,268,307,337,339,363,458,462,463,466,468,469,470,471,472],TOS:190,TTS:104,That:[30,57,62,65,66,75,78,82,85,89,91,92,94,95,97,98,103,104,105,106,107,108,111,153,161,162,168,178,182,187,189,193,195,202,204,206,227,258,260,261,266,292,318,321,328,332,337,342,346,347,350,361,365,373,382,387,404,413,421,423,424,426,432,439,440,446,458,459,461,462,464,465,466,467,471,472],The:[1,2,3,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,25,26,27,28,29,30,31,32,33,34,35,37,40,41,43,44,45,47,49,50,51,52,53,54,55,56,57,58,59,61,62,64,67,68,69,70,71,72,74,75,77,78,80,81,83,84,85,86,87,90,91,92,93,96,98,100,101,102,103,104,107,112,113,114,117,118,119,120,121,123,124,125,128,129,130,131,132,133,134,135,136,137,138,139,140,141,142,143,144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159,160,161,162,163,164,165,167,168,169,170,171,172,173,174,175,176,177,178,179,180,181,182,183,184,185,186,187,188,189,190,191,192,193,195,196,197,198,199,200,201,202,203,204,205,206,207,208,209,210,211,212,213,214,215,218,219,220,221,223,224,225,226,227,228,229,230,231,233,235,236,237,238,241,242,243,244,245,246,247,248,249,250,251,255,256,257,258,259,260,261,264,265,266,267,268,269,270,271,272,273,274,275,276,277,278,279,280,281,282,283,286,287,288,290,291,293,294,295,297,298,300,301,302,303,304,305,306,307,309,311,313,314,315,316,317,318,319,320,321,322,323,324,325,326,327,328,329,330,331,332,333,334,335,336,337,338,339,340,342,343,344,345,347,348,349,350,351,352,353,354,355,356,357,358,359,360,361,362,363,364,365,366,367,368,369,371,372,373,374,375,376,377,378,379,380,381,383,384,385,387,388,390,391,392,393,394,395,396,398,399,400,402,403,404,405,408,409,411,412,414,415,416,417,419,420,421,422,425,427,430,431,433,435,436,439,440,443,445,447,448,449,450,451,452,454,456,457,464,465,467,468,469,470,471,472,473],Their:[17,57,93,159,208,267,293,343,355,366,410,424,425,426,431,467,470,471,472],Then:[74,78,84,85,90,91,95,97,104,111,153,178,184,189,190,193,195,212,246,268,272,282,289,292,335,340,342,343,347,378,424,439,445,455,464,466],There:[5,6,7,22,25,30,31,32,37,41,42,45,53,57,58,61,65,66,70,74,75,78,79,81,82,83,84,85,86,87,89,90,91,92,93,94,95,97,99,103,104,105,106,107,108,109,110,111,112,122,124,128,134,135,140,141,144,148,153,155,156,157,159,160,161,164,168,177,180,182,184,185,187,189,193,197,204,208,209,210,212,227,228,232,236,244,248,249,251,252,254,256,257,258,260,265,266,267,271,274,282,284,288,289,292,293,296,297,298,301,310,316,329,332,334,339,340,342,343,346,348,349,350,359,360,361,366,368,370,373,380,382,383,385,386,387,392,396,397,404,405,407,408,411,412,418,419,421,423,424,426,428,431,436,437,438,439,441,442,445,446,447,450,453,454,455,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],These:[0,5,8,9,22,23,30,31,37,38,41,44,53,54,57,58,60,64,65,66,74,77,78,79,81,82,83,84,86,90,91,93,94,95,97,99,103,104,105,106,107,109,110,111,112,122,135,145,147,151,153,157,159,162,164,168,170,176,177,178,179,182,184,185,186,187,189,190,191,193,197,199,203,206,208,209,225,227,229,232,236,237,244,248,252,254,257,258,260,263,265,266,267,269,271,275,276,283,284,288,289,291,292,293,294,297,298,301,310,316,321,322,324,337,339,340,342,343,344,345,346,347,350,354,355,356,366,367,370,376,380,382,383,385,386,387,391,392,402,404,407,408,410,411,417,418,419,423,424,425,426,427,428,430,431,432,436,437,438,440,442,444,446,447,448,451,454,455,456,458,460,462,463,466,467,468,472],UCS:[5,58,355,458,467],USE:422,USING:422,Use:[22,28,30,31,35,49,54,56,58,62,79,84,85,90,91,92,93,95,97,107,110,113,118,123,129,135,137,138,139,140,147,152,153,159,161,162,164,168,169,170,177,178,190,193,197,201,206,223,227,239,244,245,248,251,252,254,258,260,261,264,265,266,267,275,284,289,292,293,301,305,306,307,308,310,315,329,330,334,340,342,343,344,345,346,349,350,355,359,361,363,366,367,369,372,373,375,378,381,382,386,391,392,402,406,410,419,422,428,436,437,439,451,453,455,457,458,461,462,463,464,465,467,469,470,471,472],Used:[62,136,165,178,184,187,189,190,197,206,209,228,252,260,268,284,318,320,321,343,346,363,373,380,385,461,463,472],Useful:[5,29,62,104,119,142,161,178,209,253,260,266,267,297,342,380,382,386,401],Uses:[28,62,65,129,134,159,244,252,346,421,472],Using:[7,26,53,62,72,79,80,82,84,86,90,91,92,98,99,100,109,118,127,128,129,132,151,159,161,162,165,175,177,182,183,184,186,188,193,202,206,224,225,230,233,252,255,261,266,267,268,271,288,292,293,298,300,301,309,317,321,333,343,345,346,347,363,369,371,382,385,386,392,399,418,426,428,432,441,442,446,449,452,456,457,458,459,460,463,464,465,468,469,471,472,473],VMS:[292,467,468],VMs:[190,467],WILL:[360,422],WITH:[109,159,340,384,422,426],Will:[65,78,113,125,177,182,249,254,284,321,373,402,471],With:[5,53,62,65,69,77,78,82,84,86,91,95,99,103,104,105,107,110,111,112,118,122,124,129,157,159,161,167,168,170,178,182,187,197,209,212,216,219,227,229,232,248,252,266,269,275,284,289,292,298,299,310,318,320,321,342,343,345,346,350,356,372,373,380,382,385,386,387,397,408,415,416,419,423,428,432,437,445,453,455,457,458,459,461,462,463,464,465,466,467,468,469,470,472],YES:442,Yes:[79,84,85,86,90,91,92,94,187,402,437,445,458],ZFS:472,_4g:363,___:91,______:91,__________:91,_________________:91,______________________:370,____________________________:91,__abs__:[291,382,424,472],__add__:[57,86,161,169,212,254,289,291,386,424,472],__aenter__:[93,170,190,423,424,472],__aexit__:[93,170,190,423,424,472],__aiter__:[93,162,190,423,424,469,470,471,472],__all__:[28,227,248,280,363,432,446,457,470,472],__and__:[162,291,386,424],__anext__:[57,93,162,190,214,423,424,426,472],__annotations__:[93,182,190,228,254,382,423,424,432,437,464,466,468,469,470],__argc:418,__await__:[93,162,190,381,424,469,472],__bases__:[45,82,204,227,346,424,459],__bool__:[113,212,291,346,368,386,402,424,426,464,472],__breakpointhook__:[355,472],__build_class__:[190,446,472],__builtin__:[459,464,465],__builtin_new:62,__builtins__:[28,85,150,227,425,446,464,472],__bytes__:[197,202,206,346,382,424,468,469,472],__cached__:[28,227,252,326,428,466,468],__call__:[91,122,160,162,204,227,284,386,387,399,424,426,470],__callback__:[399,468],__capsulethunk_h:96,__cause__:[22,190,214,377,432,464,472],__ceil__:[223,275,386,424],__class__:[45,86,91,93,98,184,212,227,252,301,346,386,397,424,436,458,459,462,470,472],__class_getitem__:[424,471,472],__classcell__:[424,470,472],__cleanenv:363,__closure__:[113,424,464,472],__cmp__:[108,456,457,459,462,463,464],__code__:[254,346,424,464],__coerce__:[458,463],__complex__:[14,156,261,382,386,424,462,468,471,472],__concat__:291,__conform__:342,__console__:158,__contains__:[50,53,86,93,101,162,197,206,212,260,271,291,346,386,404,413,424,426,456,459,460,462,472],__context__:[22,214,377,432,464,467],__copy__:[172,472],__counter:399,__cplusplu:79,__cwd:363,__debug__:[60,169,227,251,252,432,446,451,459,472],__declspec:92,__deepcopy__:172,__defaults__:[254,424,464],__del__:[22,30,47,62,79,90,183,229,257,318,342,363,386,424,468,472],__delattr__:[81,86,182,424,472],__delete__:[93,98,386,424,458],__delitem__:[86,161,162,197,206,271,291,386,404,407,410,424,459,464],__delslice__:464,__dict__:[41,45,57,91,98,104,118,145,150,193,227,228,252,254,266,268,299,301,310,346,381,416,423,424,428,436,457,458,463,464,469,470,472],__dir__:[86,212,227,254,386,424,462,468,471,472],__displayhook__:[355,446],__div__:386,__divmod__:[386,424,469],__doc__:[41,57,81,86,90,93,98,158,161,193,212,227,228,254,289,315,322,325,381,423,424,431,436,437,446,457,458,459,464,466,468,469,472],__dunder__:[62,183],__enter__:[62,93,104,190,257,284,317,346,386,402,423,424,461,462,463,467,470,472],__eq__:[21,84,86,93,108,162,169,182,196,203,228,245,291,346,381,386,387,416,424,457,462,463,464,466,471,472],__excepthook__:[355,446,472],__exit__:[93,104,170,190,257,284,346,363,386,402,423,424,461,462,463,470,472],__file__:[28,41,94,193,227,252,254,264,304,325,326,363,378,385,420,424,428,459,468,470,471,472],__float__:[24,156,227,382,386,424,471,472],__floor__:[223,275,386,424],__floordiv__:[105,291,386,424,458],__format__:[86,184,212,227,347,386,424,431,462,463,467,468,471,472],__fspath__:[54,293,363,470,472],__func__:[98,113,254,346,424,436,462,463],__future__:[60,62,93,104,105,113,160,214,227,253,262,317,423,424,427,432,458,459,461,462,464,468,469,471,472,473],__ge__:[86,108,162,182,212,228,291,346,386,424,457,463,466],__get__:[93,98,228,254,386,424,458,470],__getattr__:[45,81,91,98,177,217,227,254,301,325,381,386,424,426,443,458,462,466,467,468,471,472],__getattribute__:[45,86,93,98,227,254,301,424,458,462,466,471,472],__getformat__:386,__getinitargs__:386,__getitem__:[33,36,49,58,86,93,101,104,108,118,161,162,177,197,204,206,219,227,271,284,291,321,346,347,382,386,387,404,407,410,424,426,448,458,459,460,464,466,470,472],__getnewargs__:[161,212,301,386,459,469,472],__getnewargs_ex__:[301,472],__getslice__:464,__getstate__:[301,386,459,472],__globals__:[254,424,464],__gt__:[86,108,162,182,212,228,291,346,386,424,457,463,466],__hash__:[21,57,84,86,93,162,182,227,289,346,386,424,451,461,462,464,467,471,472],__hello__:177,__hex__:[462,464],__iadd__:[86,91,162,291,424,456],__iand__:[162,169,291,424],__iconcat__:291,__ifloordiv__:[291,424],__ignored_unused_variable__:95,__ilshift__:[291,424],__imatmul__:[291,424,469],__imod__:[291,424],__import__:[28,190,227,251,252,267,301,424,428,446,462,465,467,470,472],__imul__:[86,161,169,291,424,472],__index__:[62,227,291,346,349,386,424,462,463,464,468,471,472,473],__init__:[41,57,69,72,74,82,84,85,86,91,93,95,98,103,104,107,108,122,125,135,141,150,161,162,168,170,173,177,182,184,185,189,195,212,215,227,228,239,242,246,252,260,261,266,267,268,282,284,301,304,310,322,342,347,363,366,370,378,381,382,385,386,387,396,399,404,407,411,419,424,428,436,439,446,448,456,457,458,459,461,462,467,470,472],__init_subclass__:[424,470,472],__initializing__:227,__instancecheck__:[45,386,424],__int64:[123,177,349],__int__:[35,227,382,386,424,461,463,471,472],__interactivehook__:[335,355,451,468],__inv__:291,__invert__:[291,386,424],__ior__:[162,291,424],__ipow__:[291,424],__irshift__:[291,424],__isabstractmethod__:[118,467],__isol:363,__isub__:[162,291,424,456],__iter__:[81,86,93,104,118,162,212,227,257,260,271,284,342,346,385,386,387,404,419,424,426,436,458,459,462,468,470,472],__itruediv__:[291,424],__ixor__:[162,291,424],__kwdefaults__:[254,424,468],__le__:[86,108,162,182,212,228,291,346,386,424,457,463,466],__len__:[86,93,118,162,197,206,227,271,284,291,346,386,407,410,424,459,460,472],__length_hint__:[45,291,424,468,472],__loader__:[28,41,227,251,252,264,326,381,428,446,467,468,471,472],__lshift__:[291,386,424],__lt__:[81,86,108,162,169,182,212,228,291,346,381,386,424,426,457,463,464,466],__main__:[30,31,60,62,85,90,91,93,98,103,104,145,157,167,189,193,201,230,248,251,252,253,280,284,292,299,301,310,315,317,325,326,334,340,344,363,368,378,380,385,386,387,396,397,399,418,425,429,433,436,446,451,457,460,461,462,463,465,466,467,468,469,472],__matmul__:[291,386,424,469],__members__:[212,458,464],__metaclass__:[113,458,462,464],__methods__:[458,464,472],__missing__:[161,346,386,424,461,466],__mod__:[105,291,386,424,472],__module__:[22,25,57,161,198,212,228,254,280,363,424,459,469,470,472],__mro__:[45,98,118,198,227,346,382,424],__mro_entries__:[381,424,471,472],__mul__:[86,161,291,386,424,472],__nain__:472,__name__:[18,25,27,41,57,90,91,93,98,103,104,115,145,157,158,167,184,189,193,198,201,212,227,228,230,251,252,254,266,284,289,292,298,299,301,304,315,323,325,326,334,340,344,346,363,368,381,385,396,397,399,417,418,424,428,446,458,459,462,464,467,468,469,470,472],__ne__:[86,108,162,196,203,291,386,416,424,457,472],__neg__:[291,386,424],__new__:[41,62,82,86,95,183,204,227,298,301,378,386,424,468,470,472],__next__:[81,93,99,113,162,167,176,190,214,227,257,260,284,342,346,419,424,426,436,464,472],__nonzero__:[113,464],__not__:291,__objclass__:424,__oct__:[462,464],__or__:[162,291,386,424],__outfil:91,__package__:[41,227,252,326,381,428,446,462,467,468,470,472],__path__:[28,62,93,251,252,304,314,355,446,468,470,471,472],__phello__:177,__pickle_pickler_clear_memo_methoddef:95,__pickle_pickler_dump:95,__pickle_pickler_dump__doc__:95,__pickle_pickler_dump_methoddef:95,__pos__:[291,386,424],__post_init__:182,__pow__:[291,386,424,472],__prepare__:[381,386,424,468,470,472],__pure_virtu:62,__pycache__:[65,91,251,252,298,313,446,466,472],__pycapsule_getfield:96,__pycapsule_setfield:96,__qualname__:[18,25,27,93,98,198,212,228,254,346,424,467,469,472],__r:289,__radd__:[289,424],__rand__:424,__rdivmod__:424,__reduce__:[86,301,386,461,472],__reduce_ex__:[86,212,301,386,472],__repr__:[86,108,161,182,184,196,212,227,284,286,323,342,381,382,386,416,424,448,458,459,466,471,472],__reversed__:[86,93,161,162,227,386,424,470],__rfloordiv__:424,__rlshift__:424,__rmatmul__:[424,469],__rmod__:[161,424,469,472],__rmul__:[86,424],__ror__:424,__round__:[223,227,382,424,464],__rpow__:424,__rrshift__:424,__rshift__:[291,386,424],__rsub__:[169,424],__rtruediv__:424,__rxor__:424,__safe_for_unpickling__:459,__self__:[98,254,346,424,436,462],__set__:[93,98,254,386,424,458,470],__set_name__:[424,470,472],__setattr__:[81,86,91,182,301,386,424,432,458,472],__setformat__:386,__setitem__:[86,161,162,197,206,209,271,284,291,301,386,387,404,407,410,424,432,459,464],__setslice__:464,__setstate__:[301,386,459,472],__signature__:[254,468,472],__sizeof__:[86,355,386,462,472],__slots__:[57,62,93,161,254,458,463,472],__spam:[426,436],__spec__:[28,62,252,326,468,470,471,472],__stderr__:[248,355,363,446],__stdin__:[248,355,446],__stdout__:[248,333,355,446],__str__:[86,103,104,161,184,196,197,202,203,204,206,212,266,284,346,347,381,386,424,439,458,472],__sub__:[162,291,386,424],__subclasscheck__:[45,56,118,386,424,472],__subclasses__:[346,386,472],__subclasshook__:[86,118],__sun:472,__suppress_context__:[22,214,377,432],__svr4:472,__test__:193,__text_signature__:472,__traceback__:[22,424,432,464,472],__truediv__:[105,291,386,424,458,469],__trunc__:[227,275,386,424,472],__unicode__:[458,463],__updat:436,__venv_bin_name__:396,__venv_dir__:396,__venv_name__:396,__venv_prompt__:396,__venv_python__:396,__version__:[178,246,385,467,469,472],__wargv:418,__warningregistry__:397,__weakref__:[57,424,472],__wrapped__:[228,254,466,468,469],__x:98,__x__:464,__xor__:[162,291,386,424],_a85char:378,_a85chars2:378,_abc:472,_abc_cach:472,_abc_caches_clear:472,_abc_negative_cach:472,_abc_registri:472,_abc_registry_clear:472,_abcol:101,_add:289,_aix:472,_aliv:228,_alloca:418,_anonymous_:[177,472],_any_:92,_as_parameter_:177,_asdict:[93,161,462,463,465],_ast:[124,461,466],_asyncio:472,_asyncio_future_block:131,_audiodata:207,_b32tab2:378,_b32tab:378,_b85char:378,_b85chars2:378,_b_base_:177,_b_needsfree_:177,_bar:363,_bcd2str:468,_bcpp:111,_beginthreadex:463,_bool:[177,349,462],_bootstrap:[284,378],_buffer:472,_build:298,_build_pi:70,_builtinsuit:462,_c_api:79,_cach:[91,284,457],_call:472,_callmethod:284,_candidate_tempdir_list:472,_cdata:[177,472],_cfg:380,_charset:[199,207,232,472],_clamp:467,_class:208,_classname__spam:[91,436],_cleanup_on_error:170,_clear_type_cach:[355,446],_clearcach:227,_codec:472,_collections_abc:162,_commit:293,_compil:310,_compile_charset:310,_config_var:472,_conn_lost:472,_connect:[385,416],_contextvar:472,_convert:95,_copy_file_cont:65,_count:142,_create_unverified_context:[243,463,468],_csv:[363,472],_ctype:[177,422,463,471,472],_ctypes_test:472,_current_fram:[355,446,461],_curs:472,_darc:75,_data:207,_datetim:472,_debug:31,_debugmallocstat:[355,446],_decim:[422,467,472],_declspec:83,_deco:460,_defaultformatt:267,_defin:95,_definit:95,_dictkeysobject:472,_dispatch:417,_distutils_findv:472,_dummy_thread:[62,165,253,471],_dummythread:472,_dump_registri:472,_elementtre:472,_enablelegacywindowsfsencod:[355,451,470],_encod:207,_enter_task:472,_error:392,_errorhold:385,_eval_typ:472,_exit:[142,214,215,293],_expand:280,_exposed_:284,_extra_attribut:467,_factori:208,_fallback:232,_fdel:118,_featur:[93,114,227],_feed:472,_fget:118,_field:[124,161,382,462,463,472],_field_default:[161,382,472],_field_typ:382,_fields_:[177,284,346,472],_fields_default:472,_file:361,_final:399,_fix:[469,472],_flush:404,_foo:[74,254],_forget_codec:472,_free:461,_freeze_importlib:[30,472],_from_iter:162,_frozen:[28,177],_frozen_importlib:[177,472],_frozen_importlib_extern:177,_fset:118,_funcptr:177,_generate_next_value_:212,_gestalt:468,_get_anothervalu:407,_get_child_mock:[386,387],_get_foo:408,_get_module_lock:472,_get_running_loop:472,_get_somevalu:407,_get_type_var:472,_get_x:118,_getdiskusag:472,_getfinalpathnam:472,_getfram:[103,355,446,457],_getvalu:284,_getvolumepathnam:472,_grouper:260,_ham__spam:426,_handl:177,_hash:162,_hashopenssl:472,_header_value_pars:472,_helper:462,_hexdig:378,_home:446,_htest:472,_https_verify_certif:463,_id2obj_dict:399,_identityfunct:310,_ignore_:[212,471,472],_imagedata:207,_impl:95,_info:232,_init_module_attr:428,_inittab:28,_internaldict:[471,472],_inverted_registri:280,_io:[122,466,470,472],_iobas:472,_is_valid_operand:228,_isdir:472,_isdst:184,_iterate_directori:472,_json:472,_leave_task:472,_length:95,_length_:177,_load_windows_store_cert:472,_local:265,_log:104,_log_traceback:472,_logpath:333,_low_:92,_lsprof:310,_mac_ver_gstalt:468,_mac_ver_lookup:468,_maintyp:207,_make:[93,161,349,472],_makeresult:385,_malloc:461,_mangle_from_:202,_mapping__upd:436,_mappingsubclass__upd:436,_markupbas:464,_math:472,_maxfreelist:462,_md5:472,_mercuri:446,_method_to_typeid_:284,_methoddef:95,_missing_:[212,472],_mock_:472,_msc_ver:472,_msg:207,_msi:472,_msvccompil:472,_multiarch:472,_multiprocess:472,_myattr:204,_name:[177,197,206],_name_:212,_node:60,_noncallablemock__get_return_valu:386,_noncallablemock__get_side_effect:386,_noncallablemock__return_value_doc:386,_noncallablemock__set_return_valu:386,_noncallablemock__set_side_effect:386,_normal:472,_not_:92,_ob_next:57,_ob_prev:57,_object:177,_open:392,_open_osfhandl:472,_operator_fallback:289,_optimize_charset:310,_optimize_unicod:280,_order_:[212,472],_osx_support:472,_outfil:91,_overlap:471,_pack_:177,_param:[197,206,207,404],_pars:232,_parse_makefil:472,_patternend:280,_pickl:[95,472],_pickle_pickler_dump:95,_pickle_pickler_dump_impl:95,_pickler_clearbuff:95,_pid:284,_pointer:177,_posixsubprocess:472,_prototyp:95,_proxi:392,_pth:[455,470,471,472],_py:31,_py_atom:472,_py_atomic_load:472,_py_atomic_stor:472,_py_atomic_xxx:472,_py_c_diff:14,_py_c_neg:14,_py_c_pow:14,_py_c_prod:14,_py_c_quot:14,_py_c_sum:14,_py_char2wchar:[469,472],_py_dealloc:47,_py_dg_strtod:472,_py_forgetrefer:47,_py_hashsecret:472,_py_isfin:30,_py_newrefer:47,_py_nonestruct:[3,92],_py_packagecontext:472,_py_pyatexit:472,_py_reftot:47,_py_setlocalefromenv:472,_py_setprogramfullpath:472,_py_wchar2char:[469,472],_pybytes_res:[9,472],_pybyteswrit:472,_pycfunctionfast:53,_pycfunctionfastwithkeyword:53,_pycode_setextra:472,_pydecim:472,_pydict_contain:472,_pydict_newpres:472,_pyeval_evalframedefault:[101,472],_pygilstate_reinit:472,_pyimport_fini:28,_pyimport_init:28,_pyimport_loaddynamicmodul:85,_pyinterpreterstate_en:472,_pyio:[463,465,472],_pyio_get_console_typ:472,_pyobject_extra_init:53,_pyobject_fastcall_prepend:472,_pyobject_fre:472,_pyobject_gc_calloc:472,_pyobject_gc_track:[26,472],_pyobject_gc_untrack:26,_pyobject_getdictptr:57,_pyobject_getst:472,_pyobject_new:3,_pyobject_newvar:3,_pyobject_realloc:472,_pyparser_grammar:85,_pyruntim:472,_pyruntime_initi:472,_pystate_addmodul:472,_pysys_setobjectid:472,_pythreadstate_curr:472,_pythreadstate_uncheckedget:472,_pytime_gettimeofdai:472,_pytime_localtim:472,_pytraceback_add:472,_pytracemalloc_gettraceback:472,_pytracemalloc_track:472,_pytracemalloc_untrack:472,_pytuple_res:[55,458],_queue:472,_quote_html:472,_randbelow:466,_random:[422,472],_randommodul:472,_read_readi:472,_recursivewildcardselector:472,_register_task:472,_regrtest_top:193,_remoteaddr:336,_removetestatindex:[385,468],_replac:[161,391,462,472],_request:392,_respons:392,_resultobj:92,_root:370,_save:30,_schedule_callback:472,_scproxi:472,_screen:380,_selectorsockettransport:472,_send_traceback_head:462,_sendfile_use_sendfil:472,_set_anothervalu:407,_set_foo:408,_set_x:118,_setmod:472,_setroot:410,_sha3:472,_showwarnmsg:472,_shutdown:463,_simplecdata:177,_slotnam:[280,472],_socket:[459,472],_sourc:[161,471,472],_spam:436,_sqlite:472,_srcfile:103,_sre:[280,469,472],_ssl:472,_sslprotocoltransport:472,_stat:468,_state:96,_static:298,_stdcallfuncptr:177,_step:472,_stream:282,_strptime:472,_struct:472,_structur:[197,205,206],_subpart:207,_subtyp:[199,207],_sunder_:[62,183],_syscmd_ver:472,_sysconfigdata:472,_temp:227,_templat:298,_temporaryfileclos:472,_temporaryfilewrapp:472,_test:[385,466],_testcapi:[363,472],_testconsol:472,_testemb:472,_testmultiphas:472,_text:207,_texttestresult:385,_thread:[57,62,90,165,194,253,366,459,467,472],_threading_loc:366,_time:184,_timezon:472,_tkinter:[60,369,370,459,469,472],_tracemalloc:472,_type:280,_type_:177,_typeobject:[57,81],_unpickler_read:472,_unregister_task:472,_urlopen:392,_utest:472,_uuid:472,_v2:472,_validation_record:282,_valu:[98,197,206],_value_:212,_voltag:227,_wakeup:472,_warn:[363,472],_weakref:5,_weakrefset:378,_winapi:472,_winreg:[402,456,462,463,464],_write:404,_write_readi:472,_xoption:[54,355,446,451],_xxsubinterpret:472,a0c8f0:380,a1b2c3:321,a2b_:[147,467],a2b_base64:147,a2b_hex:[147,159,468],a2b_hqx:147,a2b_qp:[147,472],a2b_uu:147,a4337bc45a8fc544c03f52dc550cd6e1e87021bc896588bd79e901e2:236,a7p10:346,a8098c1a:[395,461],a85:468,a85decod:[144,468,472],a85encod:[144,468],a_altcharset:178,a_attribut:178,a_blink:[97,178],a_bold:[97,178,462],a_bool:168,a_chartext:178,a_color:178,a_dim:[97,178],a_expr:426,a_float:168,a_horizont:178,a_invi:178,a_ital:[178,472],a_left:178,a_list:[91,377],a_lock:117,a_low:178,a_norm:178,a_protect:178,a_revers:[97,178],a_right:178,a_standout:[97,178],a_top:178,a_tupl:424,a_underlin:[97,178],a_url:110,a_vert:178,aaa:463,aaaa:[260,463],aaaaa:463,aaaaaa:321,aaaab:321,aaaabbbccd:260,aaaabbbccdaabbb:260,aaab:321,aac:469,aahz:[90,456,460,461],aarch64:472,aaron:[468,472],ab56ef:257,aba:99,ababababab:106,abahurir:472,abandon:[214,412,466],abbc:99,abbccad:260,abbrevi:[62,93,109,120,152,178,184,187,265,292,299,310,350,367,377,410,448,451,468,469,470,472],abc123:462,abc1:346,abc:[62,79,84,86,91,93,95,99,105,106,109,113,129,135,137,161,168,171,177,183,185,230,243,253,257,258,260,266,267,281,284,290,317,321,323,331,332,346,347,355,363,378,381,382,422,424,426,428,431,436,438,456,458,459,460,461,462,463,464,470,471,472],abcabc1:346,abcabc:346,abcabcabc:456,abcb:106,abcbd:106,abcd:[106,109,161,189,227,260,459,462],abcdef:[162,177,257,260,321,463,468],abcdefg:[260,291],abcdefgh:[466,468],abcdefghijklm:462,abcdefghijklmnopqrstuvwxyz0123456789:321,abcdefghijklmnopqrstuvwxyz:[346,347,463],abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz:[346,463],abcefg:346,abcmeta:[118,382,424,462,466,467,468,472],abday_1:265,abday_7:265,abdolmalek:321,abelson:99,abhilash:[469,472],abi3:467,abi:[29,52,62,101,111,355,418,463,468,469,471,472,473],abid:471,abiflag:[111,355,446,466,472],abil:[7,64,68,78,79,91,93,94,97,99,103,104,106,111,112,119,161,192,214,229,252,284,292,326,333,347,385,407,418,419,420,422,423,437,457,458,459,461,462,463,466,467,468,469,470,472],abiv2:472,abl:[3,7,30,66,69,72,74,79,81,82,83,84,86,90,91,92,93,95,97,103,104,105,106,107,109,112,123,143,153,159,160,170,177,178,184,195,212,214,222,236,237,241,252,254,266,267,268,292,293,294,295,297,301,311,316,320,321,328,333,338,339,343,345,350,359,363,366,370,380,386,391,397,403,404,410,418,423,424,430,440,441,444,455,456,457,458,461,463,466,467,468,471,472],abmon_12:265,abmon_1:265,abnorm:[299,355,391,466],abnsec:321,abort:[5,17,31,54,65,74,79,104,129,132,135,213,214,225,249,293,299,342,343,360,366,385,428,459,471,472],about:[1,5,7,13,22,24,30,31,38,57,58,60,62,65,66,69,72,74,77,78,79,80,81,82,83,84,87,89,90,92,93,94,95,97,98,99,101,102,103,104,105,106,107,109,110,111,122,123,124,129,132,135,143,145,156,157,158,159,161,162,163,170,173,176,177,179,182,184,187,188,189,190,195,196,198,202,204,208,210,212,214,217,225,227,229,236,238,244,246,248,252,254,255,256,257,264,266,267,268,269,271,275,280,284,288,289,291,292,293,297,298,299,301,302,305,307,309,310,314,320,321,322,324,329,331,333,334,336,337,341,342,343,344,345,346,349,350,355,360,363,369,370,373,377,380,382,385,386,387,392,393,395,396,397,399,402,404,405,406,407,409,411,413,419,421,423,424,425,426,428,430,432,435,437,438,439,441,442,445,446,449,450,451,455,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472,473],abov:[5,7,22,30,31,38,53,57,58,66,70,72,74,75,77,78,79,81,82,91,93,94,95,96,97,98,99,101,102,103,104,105,106,108,109,110,111,112,113,117,118,119,122,129,131,138,139,140,149,151,152,153,156,159,161,165,168,170,176,177,178,179,180,182,184,185,187,189,193,198,201,204,206,209,212,214,216,225,227,232,235,236,237,243,244,248,251,257,260,265,266,267,268,269,275,279,284,288,289,292,293,294,297,299,301,305,310,315,321,326,333,334,335,337,338,339,342,343,344,346,347,350,351,355,361,363,367,370,372,373,376,380,382,385,386,387,391,392,394,396,397,399,402,404,405,407,417,418,422,424,428,430,431,432,436,437,439,440,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,471,472],above_normal_priority_class:350,abra:347,abracadabra:[98,161,284,347,438,460],abraham:466,abridg:271,abrupt:[340,472],abruptli:[167,343,366],abs:[43,57,93,99,156,184,187,227,275,289,291,346,377,378,380,424,426,436,438,446,471,472],abs_tol:[156,275,469],abscissa:469,absenc:[103,110,117,169,254,264,266,321,343,366,404,424,445,472],absent:[122,161,178,267,299,301,339,347,392,466,472],absolut:[28,30,31,43,57,62,74,78,82,84,90,91,92,103,111,114,129,143,145,153,155,156,157,187,190,193,214,223,227,232,233,252,257,267,269,275,279,291,292,293,294,298,305,326,332,337,342,346,355,359,361,367,370,378,380,391,396,402,412,419,421,426,428,432,436,442,446,451,455,456,460,462,463,464,466,467,468,469,471,472,473],absolute_import:[105,114,432,461],absolute_nam:252,abspath:[201,294,298,396,463,472],abstractasynccontextmanag:[170,382,471,472],abstractbasicauthhandl:[62,255,386],abstractchildwatch:134,abstractclassmethod:[118,466,467],abstractcontextmanag:[170,382,470,472],abstractdigestauthhandl:[62,255,386,472],abstracteventloop:[129,134,472],abstracteventlooppolici:[132,134],abstractformatt:222,abstracthttphandl:[386,470,472],abstractmethod:[118,228,252,289,293,330,462,467],abstractproperti:[118,462,467],abstractserv:472,abstractset:382,abstractstaticmethod:[118,466,467],abstractwrit:222,abus:[84,406,432,466],abxcd:189,abxd:[106,321,471],abycdf:189,ac_apple_universal_build:356,ac_in_buffer_s:125,ac_out_buffer_s:125,acc:467,acceler:[380,456,457,461,464,467,468,472],accent:[109,332],accept2dyear:[466,467],accept:[5,14,17,22,26,28,30,58,60,61,62,65,74,79,81,82,84,85,91,93,94,95,97,99,102,104,105,106,107,108,109,110,114,119,122,129,131,132,133,135,138,139,140,141,143,144,147,151,153,156,157,159,161,164,168,170,174,177,178,179,182,184,187,189,193,202,206,207,209,210,214,216,223,225,227,228,230,235,236,240,242,243,244,246,248,249,250,252,254,257,258,260,261,265,266,267,268,269,271,279,283,284,289,291,292,293,294,295,297,298,299,301,316,319,321,326,329,330,331,333,334,336,337,340,342,343,346,350,351,355,359,361,363,365,367,372,373,375,376,378,381,382,385,391,392,394,396,398,400,402,404,408,410,413,416,418,419,421,422,424,426,428,431,436,437,448,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],accept_connect:366,acceptlist:363,acceptstr:363,accepttupl:363,access:[3,5,7,10,11,15,19,22,23,25,28,30,31,41,43,47,49,50,53,54,55,56,57,62,65,71,72,78,79,81,82,83,86,91,92,93,98,101,102,103,104,105,106,108,109,110,111,112,118,120,123,128,132,137,139,147,150,151,153,156,159,161,162,170,171,176,183,184,187,190,193,195,197,201,204,206,208,211,213,214,218,219,223,227,228,229,232,234,236,237,243,244,245,246,247,248,252,253,254,255,256,257,258,260,263,266,268,271,275,276,278,279,282,283,284,286,291,292,293,294,296,299,300,301,304,306,308,312,314,316,317,321,322,324,326,328,329,331,333,337,339,340,341,343,344,346,347,350,352,355,359,360,363,366,368,370,372,373,377,380,381,384,385,386,387,391,392,396,399,401,403,404,406,407,408,409,410,412,417,419,423,425,426,428,432,436,438,441,442,444,445,446,448,450,453,455,456,457,459,460,461,462,463,464,465,466,467,468,469,470,472],access_copi:279,access_default:[279,472],access_read:279,access_writ:279,accesslog:447,accessor:[10,62,91,108,227,273,408,461],accessori:[72,111],accid:[82,84,436,462,463,464,472],accident:[30,84,105,130,187,189,193,214,382,432,436,439,446,457,459,462,469,472],accommod:[78,104,370,438,460,472],accompani:[31,271,337,339,424,457,466,472],accomplish:[30,31,91,95,105,122,178,249,308,331,407],accord:[7,17,30,35,58,60,62,65,74,91,98,104,109,129,153,156,159,176,182,184,187,197,202,204,206,209,210,212,217,233,234,236,244,248,249,252,253,255,260,265,266,267,275,282,284,292,293,310,320,343,344,346,348,349,367,372,373,375,380,385,391,392,393,396,407,422,424,431,438,451,455,458,459,460,461,466,467,468,469,470],accordingli:[58,82,94,97,99,102,170,219,227,228,320,346,380,391,392,398,424,426,428,451,458,462,466,467,468,470,471],account:[1,57,64,65,86,90,106,107,112,159,161,164,168,184,187,189,203,210,225,227,236,245,265,267,286,293,298,309,312,328,341,346,349,355,360,440,461,465,466,468,469,470,472],acct:225,accumul:[91,93,95,97,99,122,187,228,260,292,310,320,332,376,385,437,440,457,466,467,472],accur:[38,95,105,177,208,246,275,292,310,355,359,367,368,398,419,460,462,463,466,468,470,471,472],accuraci:[84,184,260,275,310,368,440,460],accustom:[105,187],acdeb:161,ace:[320,321],aces:321,achiev:[30,41,64,68,69,78,84,91,95,99,104,115,122,159,168,177,237,246,260,266,322,343,363,368,370,371,385,386,387,392,398,424,432,456,458,459,461,468,469],achim:462,acid:168,acidli:458,ack:[0,179,462],acknowledg:[62,168,179,247,473],acl:[249,333],aclos:[129,162,170,426,472],acm:[244,320],aco:[156,275],acosh:[156,275,462],acquaint:292,acquir:[7,30,31,44,79,94,117,139,170,209,216,251,266,271,284,293,343,359,366,371,424,461,462,463,464,466,467,469,471,472],acquire_db_connect:170,acquire_lock:[251,464],acquire_resourc:170,acquire_special_resourc:170,acquis:472,acquisit:[170,216,266,366,466],acronym:367,across:[30,38,56,59,62,64,65,68,74,75,84,94,95,101,105,111,122,147,168,170,177,184,190,192,193,210,227,254,259,260,265,266,267,268,284,301,302,320,322,329,331,342,346,355,361,366,373,375,380,421,426,431,440,459,460,462,463,466,470,471,472],acs_:97,acs_bbss:178,acs_block:178,acs_board:178,acs_bsb:178,acs_bssb:178,acs_bsss:178,acs_bte:178,acs_bullet:178,acs_ckboard:178,acs_darrow:178,acs_degre:178,acs_diamond:178,acs_gequ:178,acs_hlin:178,acs_lantern:178,acs_larrow:178,acs_lequ:178,acs_llcorn:178,acs_lrcorn:178,acs_lte:178,acs_nequ:178,acs_pi:178,acs_plminu:[97,178],acs_plu:178,acs_rarrow:178,acs_rte:178,acs_s1:178,acs_s3:178,acs_s7:178,acs_s9:178,acs_sbb:178,acs_sbsb:178,acs_sbss:178,acs_ssb:178,acs_ssbb:178,acs_sssb:178,acs_ssss:178,acs_sterl:178,acs_tte:178,acs_uarrow:178,acs_ulcorn:[97,178],acs_urcorn:178,acs_vlin:178,act:[44,57,61,74,81,86,91,96,99,103,105,118,139,145,161,177,182,184,190,197,202,206,209,227,228,245,249,252,257,258,266,293,311,313,355,366,372,373,381,386,424,445,455,456,457,462,467,468],action:[1,30,38,50,57,62,65,79,81,82,94,97,106,117,120,125,145,157,161,170,176,178,189,201,216,222,230,237,243,282,284,293,299,303,310,311,327,329,334,336,340,346,352,355,359,360,362,366,370,373,380,385,386,392,396,397,399,404,421,422,424,437,441,451,455,456,457,459,460,461,462,463,465,466,468,472],actiontext:282,activ:[31,45,57,60,64,74,78,84,86,87,91,92,97,105,106,107,111,112,129,140,141,145,153,154,161,170,178,187,211,214,219,225,244,248,262,272,284,288,292,295,299,307,310,316,329,335,340,342,343,346,350,355,366,367,370,373,380,381,386,387,396,408,409,412,432,449,451,455,456,458,459,461,462,463,466,468,469,470,471,472],active_children:284,active_count:[284,366,462],activecount:[248,462],activeforeground:370,activepython:[91,455],activest:[91,111,370,450,453,456,466],activetcl:472,actor:[410,437],actual:[5,7,14,22,30,31,35,45,50,53,56,57,60,64,65,66,69,74,79,81,82,83,84,90,91,93,94,95,96,97,102,103,104,105,106,107,109,111,119,123,124,129,140,141,151,153,159,161,168,170,174,177,178,179,182,193,198,199,201,204,207,208,210,212,214,225,227,229,232,233,235,237,246,249,252,254,257,260,264,266,267,268,269,271,279,282,284,291,292,293,295,297,298,299,305,306,307,310,320,322,326,327,331,334,337,338,339,340,342,343,345,346,347,350,351,355,359,366,367,370,377,382,385,386,387,392,396,398,399,402,404,407,411,419,421,422,423,424,425,427,428,430,431,432,436,437,440,447,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,471,472],acut:[86,109],acw:248,adam:[90,342,462,463,466,467],adapt:[38,62,104,113,143,177,227,232,299,300,333,343,380,456,457,461,463,465,470,472],adapt_datetim:342,adapt_point:342,adaptor:387,adat:306,add:[5,7,26,28,30,31,41,50,53,54,57,64,65,66,70,74,75,79,82,83,84,85,86,89,90,91,92,94,95,97,99,103,104,105,106,108,109,110,111,113,119,122,123,124,125,131,132,140,141,143,144,153,154,157,158,159,161,162,164,168,169,170,178,182,184,187,190,193,195,196,197,198,201,204,206,207,209,212,222,225,227,228,229,232,237,244,245,246,248,252,254,257,260,261,266,267,271,274,276,282,284,289,291,292,293,301,303,304,305,308,309,310,321,323,329,333,335,336,337,340,342,343,346,347,355,359,363,365,367,370,372,373,380,381,385,386,387,391,392,397,399,404,407,408,410,411,416,417,418,419,420,424,426,428,430,431,432,435,436,437,438,439,442,445,448,451,453,454,455,456,457,458,459,460,461,462,463,465,466,467,468,469,470,471,472],add_:[197,198],add_alia:196,add_altern:[201,206],add_argu:[62,94,120,161,189,201,230,311,396,463,466],add_argument_group:122,add_attach:[201,206],add_cgi_var:404,add_charset:196,add_child_handl:134,add_codec:196,add_cookie_head:244,add_data:[282,392,468],add_done_callback:[131,140,167,471,472],add_fallback:232,add_fil:282,add_flag:271,add_flowing_data:222,add_fold:271,add_get_handl:198,add_handl:[110,392],add_head:[197,206,207,386,392,404],add_help:[62,120],add_help_opt:292,add_histori:[85,322],add_hor_rul:222,add_include_dir:[65,418],add_label:271,add_label_data:222,add_librari:65,add_library_dir:[65,418],add_line_break:222,add_link_object:65,add_literal_data:222,add_mutually_exclusive_group:[94,122],add_object_typ:472,add_on:182,add_opt:[122,292,459],add_option_group:292,add_par:392,add_pars:[122,466],add_password:[110,392],add_payload:200,add_read:[129,132,133,135,137,472],add_rel:[201,206],add_runtime_library_dir:65,add_sect:[168,466],add_sequ:271,add_set_handl:198,add_signal_handl:[129,132,133,472],add_stream:282,add_subpars:[122,466,472],add_tabl:282,add_task:237,add_trick:436,add_typ:276,add_unicode_checkmark:382,add_unredirected_head:[244,392],add_writ:[129,132,133,472],addabl:260,addch:[95,97,178,472],addcleanup:[385,386,387,463,472],addcompon:380,added:[3,5,21,28,31,38,41,57,58,62,64,65,70,74,79,81,82,84,91,93,94,95,97,99,103,104,105,106,108,111,112,113,118,119,122,129,131,135,136,140,141,143,144,151,152,153,157,159,161,162,164,167,168,170,176,177,178,180,182,184,185,187,189,190,193,197,198,200,204,205,206,207,209,212,214,222,225,227,229,235,236,237,241,243,244,248,249,250,251,252,253,257,258,265,266,267,268,271,276,282,284,288,292,293,298,301,304,305,306,307,309,310,313,318,320,321,323,326,327,329,331,332,333,335,336,337,339,340,343,346,347,349,350,355,357,359,360,363,365,367,368,370,380,381,382,384,385,386,392,396,397,400,404,407,410,416,417,418,419,422,423,424,426,428,431,432,438,440,442,444,446,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],adder:99,adder_funct:417,adderror:385,adderrorinfo:472,addexpectedfailur:385,addfailur:385,addfil:359,addfilt:[103,104,266],addhandl:[103,104,266,465],addhead:392,addict:457,addin:472,addind:408,addinfourl:392,adding:[21,31,43,52,56,57,79,82,83,84,86,90,91,93,97,99,104,105,110,111,118,124,136,143,153,161,182,187,190,196,197,198,206,207,208,244,261,266,271,289,292,293,346,366,385,386,399,404,410,419,420,424,426,428,431,439,442,445,446,451,455,456,458,459,460,461,462,463,464,466,467,468,469,471,472],addison:370,addit:[1,5,7,9,22,28,30,31,37,38,41,52,53,56,57,60,62,64,65,66,69,70,71,75,77,79,81,82,86,90,93,95,99,101,102,103,104,106,109,111,112,113,117,118,119,122,124,128,141,143,144,146,152,153,158,159,161,168,170,171,172,174,176,177,178,181,182,183,184,185,187,189,190,192,193,195,197,198,200,203,204,206,207,209,211,212,214,216,219,222,223,225,227,228,229,232,235,236,241,242,243,244,246,248,253,254,257,258,260,261,265,266,267,269,271,273,274,275,276,284,285,291,292,293,294,296,297,298,300,301,305,307,308,309,310,316,318,321,323,328,331,332,334,335,336,337,339,343,344,345,347,349,350,351,353,355,360,361,363,364,365,366,367,368,369,370,372,373,375,380,382,384,385,386,387,391,392,396,397,399,402,404,405,407,408,411,412,413,414,416,419,423,424,425,426,427,428,429,430,431,432,434,436,438,439,441,442,444,445,446,448,449,450,451,452,456,457,458,459,460,461,462,463,464,465,466,467,468,470,471,472],addition:[30,57,66,95,104,106,111,122,126,129,225,269,284,292,293,307,309,315,333,336,350,363,370,380,386,422,456,463,464,467,469,470,471],addlevelnam:266,addnstr:178,addpackagepath:280,addr4:102,addr6:[102,469],addr:[125,135,137,141,153,171,258,330,336,339,343,363,417,466,469],addr_spec:[204,467],addr_typ:339,address:[5,9,22,57,58,62,65,72,74,79,81,84,86,91,93,97,103,104,106,107,113,123,129,135,141,165,171,177,184,190,193,201,204,209,210,213,216,225,227,243,244,246,255,261,266,268,269,271,321,324,336,337,339,340,343,363,378,382,391,392,395,404,417,418,424,456,458,459,461,462,463,466,467,468,469,470,471,472],address_exclud:258,address_famili:[339,340],address_in_rang:472,address_str:246,addresse:268,addressfamili:339,addresshead:204,addressof:177,addresssanit:472,addressvalueerror:[102,258],addshap:380,addsitedir:[111,335],addskip:385,addstr:[97,178,472],addsubtest:385,addsuccess:385,addtest:[193,385],addtwic:436,addtypeequalityfunc:[385,463],addunexpectedsuccess:385,adequ:[57,82,91,214,440,463,467],adher:[74,159,168,246,261,268,284,430,437],adict:306,adjac:[65,84,106,184,189,269,283,321,385,407,431,437,455,468,471,472],adject:[142,442],adjunct:466,adjust:[5,11,41,49,51,58,64,74,95,105,112,122,128,161,178,184,187,202,209,309,326,343,346,367,370,372,373,456,463,468,470,471,472],adler32:[236,421],adler:[421,422],admin:248,adminemailhandl:104,adminexecutesequ:282,administ:[395,456,462,471,472],administr:[28,30,54,65,68,72,74,86,89,103,111,153,157,249,287,288,293,335,339,367,404,425,434,444,455,460,467,472],adminuisequ:282,adminuserid:382,admittedli:95,adnan:472,ado:156,adob:[144,468,472],adopt:[309,392,428,437,457,458,459,462],adpcm2lin:[143,472],adpcm:143,adpcmfrag:143,adrian:[471,472],ads:244,advanc:[29,62,82,84,85,86,91,93,97,104,106,107,111,151,168,170,176,177,178,187,188,195,227,235,237,254,257,260,266,267,268,269,279,292,318,339,342,343,347,350,355,368,376,387,399,408,409,419,423,424,430,435,436,443,447,448,455,459,464,466,472,473],advantag:[1,74,79,81,84,91,99,103,104,108,111,141,187,198,225,251,252,301,310,326,332,346,368,372,385,399,408,410,412,418,442,447,456,459,460,465,466,467,468,469],advent:471,adverb:[62,364],advers:471,advertis:[213,288,336,337,343,422,462,468,469],advic:[293,455,472],advis:[23,103,170,229,249,284,288,293,332,366,397,422,424,444,466],advisori:[107,271,424,451,456],advtexecutesequ:282,aead:[339,343],aealmlobdk:321,aeiou:346,aenter:423,aepack:462,aes128:343,aes256:343,aes:[339,343],aesgcm:343,aest:367,aetool:462,aetyp:462,aexit:423,af_:[339,468],af_alg:[339,470,472],af_bluetooth:[339,472],af_can:339,af_inet6:[129,339],af_inet:[41,104,107,129,141,284,339,340,343,363,462],af_link:[339,468],af_netlink:[339,461],af_packet:[339,472],af_pip:284,af_rd:339,af_tipc:339,af_unix:[129,133,284,339,340,472],af_unspec:[129,137,339],af_vsock:[339,471,472],afalsevalu:306,afanasyev:472,aff:466,affair:456,affect:[3,30,31,34,41,52,54,65,68,69,79,90,98,99,104,106,111,118,145,168,178,184,187,190,193,203,206,212,227,232,244,248,251,252,257,265,271,279,291,293,308,309,321,322,323,324,339,342,343,345,346,347,359,363,367,368,372,373,380,385,386,387,391,397,399,402,404,407,423,424,426,428,432,434,436,440,446,449,451,456,457,458,459,461,462,463,464,466,467,468,469,470,471,472],affin:187,affix:424,afford:[93,456],afloat:306,afmt_a_law:295,afmt_ima_adpcm:295,afmt_mu_law:295,afmt_queri:295,afmt_s16_b:295,afmt_s16_l:295,afmt_s8:295,afmt_u16_b:295,afmt_u16_l:295,afmt_u8:295,aforement:[30,81,467],afoul:[457,459],afresh:[103,170,266],africa:462,after:[3,5,7,8,17,22,26,30,31,35,38,41,52,53,54,56,57,58,62,65,66,68,74,75,77,78,79,82,84,86,91,92,93,95,96,97,99,101,103,104,105,106,107,108,110,111,113,114,117,119,120,122,125,129,132,135,137,139,140,141,142,144,145,147,149,151,152,153,154,155,157,158,161,167,168,170,171,177,178,180,182,184,186,187,189,190,193,196,197,206,207,208,210,211,212,213,214,216,217,219,225,227,229,230,235,243,246,248,249,251,252,254,257,260,264,265,266,268,269,271,279,280,283,284,288,291,292,293,294,295,299,302,304,305,307,310,311,316,320,321,322,326,327,329,334,335,336,337,339,340,341,342,343,344,346,347,348,350,351,355,359,361,362,363,365,366,367,368,370,372,373,377,378,380,382,385,386,387,392,396,397,398,399,402,404,407,412,413,418,419,421,423,424,425,426,428,430,431,432,434,435,436,437,438,439,440,441,442,444,445,446,448,451,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472,473],after_cancel:472,after_in_child:293,after_in_par:293,after_par:472,afterward:[30,78,177,184,187,260,329,342,355,360,387,418,424,444,445,458,459],again:[26,30,41,57,65,66,69,74,75,79,81,82,84,89,90,91,92,93,97,99,104,106,107,108,109,110,112,129,135,137,139,147,153,161,168,171,177,178,184,201,212,213,215,223,244,248,251,260,266,268,275,279,283,284,292,293,295,299,301,310,315,329,332,334,337,342,343,346,355,363,366,372,373,380,384,386,387,392,397,406,410,411,421,423,424,426,428,431,432,436,437,439,440,442,443,445,446,450,455,456,458,459,462,464,466,467,471,472],against:[45,65,74,78,79,81,82,84,91,92,93,96,105,106,113,122,129,143,174,177,182,189,190,193,212,236,254,274,279,292,298,301,305,307,309,310,313,316,321,326,328,342,343,363,366,370,372,373,380,385,386,387,397,406,408,409,410,411,416,417,418,424,428,446,451,456,457,458,459,460,461,466,468,469,471,472],age:[65,105,108,161,244,245,342,343,447,458,460],agen:[254,426],agenc:[342,343,422],agent:[106,110,271,272,337,392,393,458,462],ages:463,agffno5wuhb77vbri6f9iv2qixu7whw:236,aggrav:466,aggreg:[140,227,260,342,385],aggregate_class:342,aggress:[37,84,346,386,461],aging:466,agl:177,agnost:102,ago:[91,93,458,472],agre:[343,422,472],agreement:[62,456],aguiar:472,agument:91,ahead:[119,260,360,367,400,407,446,460,472],ahear:422,ahi:189,ahlstrom:[420,456,459],ahoi:245,ai_:339,ai_canonnam:339,ai_numerichost:339,ai_pass:[129,137,339],aid:[57,93,447,455,459,460,463,466,467,468,472],aifc:[62,253,278,338,351,398,456,472],aifc_read:472,aiff:[62,155,253,278,338,446,472],aiffread:446,aiffwrit:446,ailmsux:321,aim:[38,64,78,81,84,87,102,105,109,110,111,269,282,355,455,458,460,461,468],aio:329,aiosmtpd:[336,472],aiter:[424,470],aivar:472,aix:[79,308,472],aix_genuine_cplusplu:356,aka:[62,124,183,193,356,406,424,455,471,472],akei:306,akin:[93,252,346,428],akira:[469,472],akm:106,akshit:469,akt5:321,akt5q:321,akt:321,akuchl:449,ala:92,alacazam:[438,460],alan:[461,462,471,472],alarm:[310,334,468,472],alaw2lin:143,alaw:[119,351],albatross:232,albeit:[232,437],albert:[469,471,472],alberto:[462,467],albrecht:321,alecsandru:[470,472],aleksi:472,alert:[97,107,241,268,343,397,471],alert_description_:343,alert_description_handshake_failur:343,alert_description_internal_error:343,alertdescript:343,alessandro:470,alex:[85,90,459,462,463,469,470,472],alexand:[109,462,463,465,466,469,470,471,472],alexandr:[236,462,463,465,466,468,472],alexandru:472,alexei:[462,468,469,472],alg_:[339,470],alg_bit:343,algebra:[260,450,462],algorithm:[30,38,62,84,90,91,93,106,108,109,121,135,143,144,147,151,153,159,161,174,175,183,184,187,189,193,203,209,232,238,249,253,257,258,265,268,275,278,282,304,310,312,320,339,343,346,355,361,365,368,387,392,404,419,420,421,422,426,436,456,458,459,461,463,465,466,467,470,472],algorithms_avail:[236,463,466],algorithms_guarante:[236,463,466],alia:[22,28,36,54,65,74,91,93,104,105,123,124,135,138,144,155,159,177,179,196,198,206,212,214,219,227,230,232,244,254,257,284,287,292,293,299,316,320,324,329,330,334,339,343,346,350,360,373,380,382,385,400,402,403,416,419,425,436,464,468,470,471,472],alias:[22,62,65,93,96,122,159,188,196,212,214,232,265,299,305,339,373,380,384,431,436,457,459,462,466,467,468,470,472],alias_for_squar:212,aliaslist:339,aliasmbc:472,alic:236,alien:366,align:[57,62,120,146,155,222,347,373,380,405,442,462,463,472],aliquam:151,alist:[190,306,424],aliv:[57,91,177,228,284,307,346,363,366,399,423,424,448,451,457,463,464,466,468,472],all:[1,2,4,5,7,9,13,16,21,22,26,28,30,31,34,35,38,41,43,47,50,52,53,54,55,56,57,58,62,63,66,67,68,69,70,71,72,74,75,77,78,79,81,82,83,86,87,90,92,93,94,95,97,98,99,101,103,104,105,106,107,108,109,110,111,112,113,118,119,120,122,123,124,125,127,128,129,130,132,135,136,137,138,139,140,141,142,143,144,145,146,147,149,150,151,152,153,155,157,158,159,160,161,162,163,164,165,167,168,169,170,171,174,176,177,178,179,182,184,185,187,188,189,190,191,192,193,195,197,198,199,200,201,202,203,204,205,206,207,208,209,210,211,212,213,214,215,216,217,219,221,222,223,224,225,227,228,229,230,232,233,234,235,236,237,238,239,241,243,244,245,246,248,249,251,252,253,254,255,256,257,258,260,261,262,264,265,266,267,268,269,271,272,274,275,276,277,279,282,286,287,288,289,291,293,294,295,296,297,298,299,301,302,304,305,307,310,311,312,313,314,315,316,318,320,324,326,327,329,331,332,333,334,335,336,337,339,340,341,342,343,344,345,346,347,348,349,350,351,352,355,356,357,358,359,360,361,362,363,364,365,366,367,370,372,373,375,376,377,378,380,381,382,384,385,386,391,392,395,396,397,398,399,400,402,403,404,405,406,407,408,409,410,411,412,413,414,416,417,418,419,421,422,423,424,425,426,427,428,430,431,432,433,434,435,436,437,438,439,440,441,442,444,445,446,447,448,449,451,453,454,455,456,457,458,459,460,461,462,464,465,466,467,468,471,472,473],all_complet:[140,167],all_equ:260,all_error:225,all_featur:412,all_fram:378,all_polls_clos:466,all_properti:412,all_recipi:210,all_suffix:[252,254],all_task:[127,140,471,472],all_thread:215,allen:[343,466,472],allevi:[252,456],alli:457,alliancefranais:[159,459],allison:472,alloc:[5,7,22,26,28,29,31,41,46,51,54,56,57,58,60,62,78,79,80,82,84,91,93,107,117,132,135,170,177,186,215,229,253,257,258,284,293,316,318,324,339,355,366,373,402,413,451,456,457,458,461,463,466,467,469,470,471,472,473],allocate_lock:117,allocationgranular:279,allocfunc:[57,81],allow:[1,3,5,7,9,15,22,25,30,31,37,39,41,45,54,56,57,58,62,64,65,66,69,70,74,77,78,79,81,82,85,87,90,91,92,93,94,95,96,97,99,101,103,104,105,106,107,108,109,110,112,113,115,117,118,122,124,125,129,131,134,135,136,137,138,139,140,144,148,152,153,155,156,158,159,161,162,164,167,168,170,174,176,177,178,181,182,183,184,186,187,189,190,193,195,196,197,203,204,206,209,211,214,215,219,222,225,227,228,229,230,232,235,236,243,244,245,246,248,249,252,254,257,260,261,262,264,265,266,267,268,271,275,276,279,280,284,286,287,288,292,293,295,297,298,299,301,304,307,309,310,313,315,316,320,321,322,323,326,327,329,330,331,332,333,334,337,339,340,342,343,346,347,348,350,351,353,355,357,359,361,363,365,366,367,369,370,371,372,373,374,376,380,381,382,385,386,387,391,392,393,394,396,397,398,399,400,402,403,404,406,407,408,412,413,416,417,418,420,421,423,424,425,426,428,431,432,435,436,437,438,439,442,445,446,447,448,451,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],allow_abbrev:[62,120,469,472],allow_broadcast:129,allow_dotted_nam:417,allow_exit_without_flush:284,allow_foo:267,allow_frag:391,allow_nan:261,allow_no_valu:[168,463],allow_non:[284,416,417,459],allow_reuse_address:[104,340,417,462],allowed_domain:244,allowpathinfo:404,allowpathinfoforscriptmap:404,allowunassign:159,allowzip64:[419,468,472],almost:[17,30,31,58,68,72,78,81,82,84,90,91,93,94,95,97,104,106,107,109,111,113,120,122,128,130,141,156,158,178,187,237,257,265,267,272,284,288,292,320,321,342,343,346,350,370,382,385,386,404,421,424,428,430,440,447,455,457,459,462,464,467,472],alo:189,alon:[7,58,81,87,104,106,111,252,299,321,326,332,417,422,430,458,461,468,472],along:[7,31,32,65,74,84,95,99,103,104,111,122,129,141,142,143,151,156,164,170,177,187,193,204,206,219,232,235,236,249,252,266,268,279,293,298,301,310,330,337,339,343,346,347,350,358,373,376,382,385,386,404,411,418,447,456,457,458,459,460,462,463,465,466,468,469,472],alongsid:[65,68,69,237,372,418,455],alpha:[4,62,65,74,86,93,114,288,309,320,355,356,456,457,462,465,473],alphabet:[58,91,94,144,174,179,187,197,200,222,227,261,266,271,305,310,328,335,346,459,460,461,462,463,468,469,470,471,472],alphanumer:[58,106,153,179,193,252,267,301,321,328,332,346,347,367,448,459],alpin:472,alpn:[343,469,472],alreadi:[1,5,7,9,22,23,28,30,34,45,49,55,58,60,62,64,65,66,72,79,81,82,83,84,86,90,91,92,93,94,97,99,102,105,106,107,108,109,111,112,113,122,124,129,130,131,135,141,147,149,153,161,164,167,168,170,172,177,182,184,185,189,197,200,201,206,209,211,212,213,214,219,222,225,227,229,237,243,244,248,249,251,252,254,257,260,266,267,269,271,276,282,283,284,292,293,298,301,304,307,309,310,321,322,323,329,330,333,334,339,342,343,345,346,350,355,357,359,360,363,366,370,373,380,385,386,387,391,392,394,396,397,400,402,407,408,414,418,423,424,426,428,432,436,437,438,442,446,449,450,455,456,458,459,460,461,462,463,465,466,467,468,469,470,471,472,473],already_report:242,also:[1,3,5,7,10,11,22,25,26,28,30,31,36,38,47,49,50,53,54,55,57,58,60,61,64,65,66,68,69,74,77,78,79,80,81,82,83,84,85,86,87,89,90,92,93,94,95,96,97,98,99,101,102,103,104,105,106,107,108,109,110,111,112,113,114,117,118,121,122,123,124,127,128,129,131,132,133,134,135,136,137,138,140,142,143,145,146,147,148,150,151,152,153,154,155,156,157,158,159,161,162,164,167,168,169,170,171,173,174,175,176,177,178,182,183,184,185,187,188,189,190,191,193,195,196,197,198,199,200,201,202,203,204,206,207,208,209,212,214,215,216,217,219,223,225,227,228,229,230,232,234,235,236,237,238,239,240,241,242,243,244,245,246,248,249,252,253,254,256,257,258,260,261,265,266,267,268,269,271,274,276,279,280,282,284,288,289,291,292,293,294,295,296,297,298,299,301,304,305,307,308,309,310,311,313,315,316,320,321,323,324,326,327,329,331,332,333,334,335,337,339,340,342,343,344,345,346,347,348,349,350,353,354,355,359,362,363,364,365,366,367,368,369,370,372,373,374,375,376,377,378,380,381,382,384,385,386,387,390,391,392,394,395,396,397,399,400,402,403,404,405,406,407,408,409,410,411,412,413,414,416,417,418,419,420,422,423,424,425,426,427,428,430,431,432,433,434,435,436,437,438,439,440,441,442,443,444,445,446,447,448,449,450,451,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],alt:[178,179,241,248,373,456,472],alt_digit:265,altchar:144,alter:[7,21,65,93,129,132,155,161,187,209,244,248,249,261,267,272,301,326,346,347,380,422,424,428,448,456,460,466,468,472],alter_si:326,altern:[0,17,22,41,45,62,64,65,66,71,79,84,90,91,93,95,98,99,106,109,110,112,113,118,122,124,129,131,134,138,144,148,150,156,159,161,162,168,176,177,178,179,182,183,187,192,193,197,200,201,206,211,212,215,216,219,225,227,230,232,243,246,249,253,254,260,266,267,268,275,284,290,292,293,295,297,299,301,305,307,308,316,318,333,337,339,340,342,343,346,347,349,350,355,359,360,369,372,373,377,380,382,385,386,387,391,396,397,399,402,404,422,426,428,429,441,442,444,446,448,449,451,452,456,457,458,459,460,461,462,463,465,466,468,469,470,471,472],although:[22,31,52,57,65,69,72,74,78,84,86,91,94,95,96,103,104,111,125,136,140,141,152,159,177,182,184,189,193,197,198,201,206,207,212,233,249,254,257,260,261,266,271,274,282,284,292,293,295,298,301,309,321,342,343,345,346,347,355,356,367,369,372,385,404,409,411,412,413,418,422,423,424,426,428,430,432,436,437,438,439,440,444,446,451,455,456,468,469,470,472],alti:459,altinstal:[211,454,463,466,468],altogeth:[103,104,153,419,424,466],altsep:293,altzon:[184,367],alum:422,alumni:422,alwai:[0,5,7,8,9,13,16,17,22,28,30,31,36,38,40,41,43,44,45,49,51,53,55,57,58,61,65,66,68,72,74,75,79,81,82,84,85,86,91,93,94,95,96,97,98,99,103,104,105,106,107,110,111,113,116,117,122,129,135,136,137,140,143,144,145,147,153,156,158,159,161,164,167,168,176,177,178,180,182,184,185,187,189,190,193,194,196,197,204,206,207,208,209,211,212,214,225,227,228,232,235,236,237,238,241,243,245,246,248,249,251,254,257,258,261,265,266,268,269,271,275,284,292,293,294,295,297,298,301,305,308,309,311,318,319,321,326,331,333,334,335,336,339,340,342,343,345,346,347,349,355,361,363,365,366,367,368,370,373,374,377,382,385,386,391,392,397,399,402,404,406,407,410,412,414,419,421,423,424,425,426,428,431,432,436,437,438,439,442,445,446,448,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],always_typed_act:292,am_ait:57,am_anext:57,am_await:57,amauri:[462,463,465,466,472],amaz:[193,458],amber:472,ambigu:[10,31,62,84,93,95,99,106,122,184,248,253,258,263,292,299,321,346,423,426,427,430,431,437,456,462,468,470,471,472],ambiti:460,ambv:466,amd64:[66,349,356],amd:[469,470],amdk6:305,ame:445,amend:467,america:[184,422,463],american:[97,184],amessag:202,amet:151,amit:[470,472],amk:[106,321,459,462,463],ammar:[470,471,472],amoeba:86,among:[57,108,143,177,182,189,193,229,271,284,302,329,349,355,367,370,372,385,424,431,446,453,455,466,472],amongst:[127,274,343],amort:[260,297],amount:[30,31,41,79,82,84,90,91,95,99,107,125,135,137,178,187,225,233,236,237,257,258,269,284,288,292,295,298,307,309,324,331,333,334,339,344,346,365,366,367,373,380,390,392,406,408,421,436,437,439,445,457,460,462,466,468,469,470,471,472],amp:[414,466],amper:374,amperequ:374,ampersand:463,amplifi:187,amplitud:462,amsterdam:[30,86,367,422],amt:243,an_error:377,an_int:168,an_item_is_avail:366,anaconda:455,analog:[26,34,58,65,66,81,91,104,187,254,266,267,275,284,301,365,380,424,426,428,444,458,460,461,463,466,468],analogu:[65,91,284],analys:190,analysi:[7,30,62,65,93,106,125,154,156,189,224,238,253,263,280,310,320,426,429,430,432,440,450,455,461,467,469,472],analyz:[105,114,176,186,280,301,302,321,332,378,422,431,461,462,463,466,472],anand:[463,466],anatoli:463,ancbufs:339,ancdata:339,ancestor:[65,103,104,178,266,267,284,298,343,373,386,387,410,424,459,472],ancestri:457,anchor:[252,298,370,373,463,468],anchorag:99,ancient:[359,461],ancillari:[339,467,472],and_:[99,291],and_expr:[426,427],and_test:[426,427],anded:179,ander:[463,471],andersen:472,anderson:470,andi:[462,465,472],andra:472,andrad:472,andrea:472,andress:466,andrew:[108,109,178,422,456,458,459,460,461,466,467,468,470,471,472],andrich:456,android:[54,58,87,265,355,363,470,471,472],android_api_level:472,anech:[469,472],anew:[428,472],angelico:[469,470,472],angl:[106,145,156,159,210,227,275,320,380,462,463],angular:[62,290,430],ani:[1,5,6,7,8,9,10,11,12,17,19,21,22,23,25,26,28,30,31,33,34,35,38,39,40,41,42,47,50,51,52,53,54,56,57,58,60,62,66,67,68,69,70,71,72,74,75,78,79,81,82,83,84,91,92,93,94,95,97,98,99,102,103,104,105,106,107,108,109,111,117,118,119,122,125,129,131,135,137,140,141,142,143,144,148,149,151,152,153,154,156,157,158,159,160,161,167,168,171,172,174,176,177,178,179,180,182,184,185,187,188,189,190,191,193,195,197,198,201,202,203,204,205,206,207,208,209,210,211,212,214,215,219,221,222,223,225,227,228,229,232,233,235,236,237,238,243,244,245,246,248,249,251,252,254,256,257,258,260,261,262,264,265,266,267,268,269,270,271,275,276,279,284,286,288,289,291,292,293,294,295,297,298,299,301,304,307,310,311,315,316,317,318,320,321,322,324,325,326,327,328,329,330,331,332,333,334,335,337,339,340,342,343,345,346,347,349,350,351,355,359,360,361,363,365,366,367,370,372,373,375,376,378,380,381,385,387,391,392,395,396,397,398,399,402,403,404,405,406,407,408,409,410,412,413,414,416,418,419,420,421,422,423,424,425,426,428,430,431,432,436,437,438,439,440,442,444,445,446,449,451,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],anim:[62,212,224,232,373,442,462,469],anint:306,anish:472,annassign:[124,427],annex:[275,384,431,462],anno:254,annoi:[97,153,176,237,266,386,456,462,472],annot:[25,62,84,91,93,95,114,124,182,190,228,249,254,265,302,363,376,382,399,423,424,426,427,441,464,466,467,469,472],annotate_field:124,annotated_assignment_stmt:432,announc:[65,86,109,222,293,450,467],annoy:[109,458,459,464,467],annual:260,anod:213,anomal:363,anomali:[84,187],anonym:[1,93,99,177,225,267,279,380,423,426,437,456,466,472],anoth:[7,22,28,30,31,38,53,57,58,62,65,66,68,69,74,79,80,81,82,83,84,85,86,89,90,92,93,94,95,97,99,103,104,105,106,107,108,109,110,111,113,116,117,122,123,127,128,129,134,135,139,140,141,145,153,157,159,161,164,167,168,170,174,177,178,184,187,193,194,195,197,204,212,214,223,225,228,232,236,237,244,246,251,252,254,257,260,261,266,267,269,271,284,287,288,291,292,293,297,298,299,303,305,310,311,313,316,318,321,329,333,334,340,342,343,346,347,350,355,366,368,372,373,375,376,380,382,385,386,387,390,391,392,399,402,404,405,406,407,408,410,411,419,422,423,424,426,428,432,436,437,438,439,440,442,443,446,448,449,453,455,456,457,458,459,460,461,462,463,464,465,466,467,469,470,472],another_extens:168,another_funct:377,another_year:184,anotherkei:168,anotherstr:306,anothertyp:382,anothervalu:407,anq:[],ans:201,ansi:[38,62,146,177,265,355,367,456,467,470,472],answer:[1,64,65,84,91,94,112,135,156,193,267,271,310,347,370,393,436,438,440,442,447,450,456,460,464,472],answer_challeng:284,ant:[151,212],anthon:472,anthoni:[71,91,458,460,461,472],anti:[373,387,472],anticip:[470,472],anticipate_failur:363,antigrav:472,antilink:225,antiviru:248,antoin:[298,462,463,465,466,467,468,469,471,472],anton:472,antoni:472,antonio:466,antti:461,any_ord:[386,387],anycast:258,anydbm:[463,464],anymor:[7,28,30,44,91,93,95,107,135,227,229,261,293,339,355,380,463,464,466,467,472],anyon:[82,105,111,343,363,422,457,463,468,473],anyset:50,anystr:382,anyth:[5,31,37,57,62,65,67,68,70,74,75,78,79,82,84,86,89,91,94,97,99,103,104,106,107,109,111,122,138,141,153,161,177,178,179,182,184,187,193,197,204,212,249,252,257,268,284,292,299,303,312,321,325,331,335,337,342,343,347,350,351,355,361,366,373,382,386,398,402,404,410,418,424,426,428,434,436,437,439,442,445,453,455,457,458,461,462,467,468,472],anytim:[153,343,370],anywai:[57,74,82,84,94,111,177,184,227,244,248,258,385,386,438,457,458,472],anywher:[7,67,75,91,106,145,153,161,187,189,260,267,292,298,321,355,375,425,426,428,464,472],aodlambelk:321,aon:380,apach:[284,343,416,449,456,470,472],apache2:298,apart:[65,72,82,99,103,106,124,168,189,275,284,292,304,345,351,426,431,459,463,465],ape:189,aperiod:380,apf:472,api:[7,10,14,15,16,19,22,23,31,34,35,41,42,44,50,52,53,54,56,57,59,62,71,74,78,80,81,82,85,90,92,93,97,103,104,105,107,109,110,113,122,123,126,128,130,131,134,135,137,138,140,142,160,162,165,170,171,176,177,178,183,186,188,190,191,192,195,196,198,199,202,203,204,206,207,209,210,218,225,230,236,237,247,252,253,254,257,258,260,261,266,267,268,271,273,282,283,284,285,293,295,300,301,304,306,320,321,322,336,339,343,344,346,347,355,358,363,366,382,385,386,387,397,402,403,404,406,408,411,412,416,417,425,426,428,429,431,432,436,441,451,455,456,457,458,473],api_vers:[355,446,459],apl:[260,465,466],apolici:209,apop:307,apostroph:[93,346,465],app:[92,107,248,268,355,370,396,404,422,455,462,463,466,472],appar:[79,89,92,97,153,334,405,437,456,460],appdata:[335,462],appear:[30,41,53,54,60,62,65,81,82,84,90,92,93,94,95,97,99,102,103,104,105,106,111,113,122,124,135,153,159,164,168,176,177,178,182,187,189,193,197,200,203,204,206,212,224,227,229,232,236,248,249,252,254,258,265,267,268,271,282,284,299,310,316,319,321,332,337,339,346,347,359,365,370,373,385,386,387,392,397,399,404,405,407,410,413,417,422,423,424,426,427,428,430,431,432,434,437,438,444,445,451,455,457,459,461,462,463,465,466,468,469,470,471,472],appel:189,append:[8,9,34,54,58,65,82,84,85,86,90,91,95,103,104,107,111,113,122,123,125,136,151,153,158,159,161,162,177,182,184,185,187,190,197,201,203,204,206,209,227,228,229,235,249,250,251,252,254,257,260,266,267,268,269,271,282,284,288,292,293,298,301,303,304,311,318,320,322,323,331,333,335,339,342,344,346,355,359,363,375,385,392,397,404,405,408,410,418,419,423,424,431,436,437,438,442,445,446,448,451,456,457,459,460,461,462,463,464,466,467,469,470,472],append_const:[122,292],append_histori:322,append_history_fil:[322,469,472],append_nul:[268,467],appendchild:[407,408,456],appendix:[62,441,444],appendleft:[161,460],appetit:[62,441,458],appl:[189,212,248,291,306,438,447,453,459,462,463,470,472],applesingl:462,applet:453,appletrawmain:462,appletrunn:462,appli:[2,6,17,31,47,57,58,62,65,66,72,74,75,79,81,84,86,87,93,99,103,104,111,113,118,122,123,124,143,156,159,161,170,176,177,178,179,182,184,187,188,189,190,193,199,206,209,210,212,214,221,225,227,228,232,236,244,245,246,248,251,254,258,260,266,267,269,271,272,276,284,292,293,299,301,310,316,321,323,324,326,329,333,339,343,345,346,347,350,355,366,367,368,370,373,375,378,382,384,385,386,391,393,397,406,408,410,416,422,423,424,426,428,432,434,436,438,442,445,446,450,451,455,456,457,458,459,460,461,462,463,464,466,467,468,470,471,472],applic:[28,29,30,31,57,58,62,65,79,81,83,84,85,86,89,91,93,98,99,103,105,106,107,109,110,111,112,113,122,124,128,129,135,138,140,141,142,144,146,150,153,158,168,170,176,178,184,187,189,191,192,193,195,196,197,198,201,202,203,204,206,207,209,214,215,222,227,228,229,236,237,243,246,247,253,256,257,261,265,266,267,268,271,272,273,276,278,282,283,284,291,292,293,294,296,297,298,301,307,310,316,320,321,327,328,332,333,334,339,342,343,346,348,349,350,361,363,365,366,367,369,370,372,373,378,380,384,385,391,392,397,399,402,404,407,408,410,411,412,413,414,419,420,421,422,426,430,432,435,438,439,440,441,442,443,446,447,448,449,451,452,456,457,458,459,460,462,463,464,465,466,467,468,470,471,472,473],application_uri:404,applicationwid:187,apploc:455,apply_async:[284,462],apply_default:[254,469,472],applyresult:284,appnam:268,apport:215,appreci:[98,419,422,436],approach:[31,62,70,74,79,80,82,84,85,90,91,93,94,95,98,99,103,104,108,109,110,117,149,153,159,161,170,187,189,193,211,238,251,275,284,293,298,334,340,342,346,350,361,366,368,385,387,392,410,416,418,424,426,428,436,441,447,448,455,456,457,461,462,463,465,466,467,469,470,471,472,473],appropri:[1,5,9,14,17,22,23,28,37,38,45,49,56,57,58,62,65,69,72,74,77,79,81,82,84,87,95,97,99,103,104,105,106,107,110,111,112,113,118,122,123,129,137,138,141,153,158,159,165,169,178,184,185,187,193,196,197,199,202,203,206,207,208,209,212,225,227,228,232,236,237,238,243,244,246,249,252,257,258,265,266,267,268,271,275,284,289,292,293,297,298,301,309,310,316,318,321,326,329,334,336,337,339,340,343,345,346,347,349,350,355,359,361,366,367,372,377,380,381,382,386,390,391,392,396,399,400,405,407,408,410,412,418,419,425,426,428,432,438,448,451,454,455,456,457,458,459,460,462,465,466,467,468,469,470,471,472],approv:[74,244,288,309,392,455,456,463,472],approx:472,approxim:[43,58,62,84,85,91,156,159,161,167,178,187,189,193,203,214,223,228,248,275,281,284,318,328,346,349,350,363,377,380,385,424,426,428,440,442,455,462,463,471],appspot:[463,465,466],apr:[99,458,461],aprano:[468,470],april:[184,431,456,457],apropo:472,apt:[85,101,470,472],aqua:[453,472],aquamac:453,aquatk:466,arab:[109,159,187,222,346,456,463,466],arahesi:[463,466,472],aranguren:462,araujo:[109,467,468,472],arbcd:460,arbitrari:[5,22,30,31,33,35,41,44,47,50,54,57,62,72,78,80,82,84,90,91,93,94,95,99,104,106,107,109,110,111,117,122,125,135,144,153,159,160,161,170,176,177,180,184,187,204,209,212,222,227,232,233,234,235,241,246,251,252,254,257,258,261,266,267,271,284,287,290,293,294,295,297,298,299,301,309,312,315,321,324,329,331,334,335,336,339,340,341,345,346,347,352,363,366,367,370,380,385,386,387,394,407,410,416,417,418,424,436,438,441,442,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],arbitrarili:[60,72,93,124,161,168,170,190,267,320,346,385,392,426,442,460],arc:[156,275,380,462,463,465,466,472],arch:462,archi:410,architectur:[65,123,133,214,272,274,280,305,356,407,418,424,446,454,455,459,460,462,467,469,472],archiv:[62,66,71,72,73,75,111,191,220,236,253,271,281,344,363,396,447,450,456,461,462,463,465,466,468,471,472,473],archive_nam:333,archive_util:71,archivepath:420,arcnam:[359,419],ardelean:472,arduou:456,area1:104,area2:104,area:[5,38,41,71,86,97,103,104,109,178,197,206,227,248,256,257,279,324,339,343,361,373,430,441,456,461,462,468,471],aregtyp:359,aren:[47,82,84,86,90,91,97,99,102,106,107,109,112,113,140,156,168,177,202,218,229,254,258,267,268,292,298,340,343,355,370,374,386,387,416,418,456,457,458,459,460,461,462,463,467,468,472],arena:[31,62,451,461],arepr:323,arflag:356,arfrev:[463,466,472],arg0:[101,293],arg1:[45,81,91,99,101,122,227,292,293,424,458,459,461],arg1typ:382,arg2:[45,81,91,99,101,227,292,386,424,458,459,461],arg2typ:382,arg3:[81,91,101],arg4:101,arg:[5,19,26,30,31,45,53,54,56,57,58,60,65,78,79,81,82,84,90,91,93,94,95,96,98,103,104,108,111,113,117,122,124,128,129,134,138,142,145,157,161,167,170,171,176,177,184,190,198,201,204,206,212,213,214,216,222,227,228,230,248,249,254,260,266,267,271,284,291,292,293,299,301,302,305,310,313,318,333,337,342,346,347,350,355,356,360,363,366,370,373,376,380,382,385,386,387,392,396,399,423,424,432,437,439,444,451,456,459,460,461,462,463,464,466,467,469,470,472],arg_format:85,arg_lin:122,arg_nam:347,argc:[30,31,60,78,79,85,190],argcount:[12,60],arginfo:254,arglist:[79,427],argpars:[62,100,120,161,189,201,230,253,292,311,396,447,472,473],argrepr:190,args_from_interpreter_flag:363,argspec:254,argtyp:177,argu:[456,458,463],arguabl:[91,343],argument:[7,9,10,13,14,17,18,19,21,22,23,24,25,26,27,28,29,30,31,33,35,38,43,44,45,47,51,53,54,55,57,58,59,60,62,65,66,72,74,77,78,79,81,82,84,85,90,92,93,97,98,99,100,101,103,104,105,106,107,108,109,110,111,113,114,117,119,120,123,124,129,131,135,137,138,139,140,141,142,143,144,145,147,148,149,151,153,154,155,156,157,158,159,160,161,162,164,165,167,168,169,170,171,172,173,174,176,178,179,182,184,185,187,188,189,190,193,196,197,198,199,201,202,203,204,206,207,208,209,210,212,213,214,215,216,219,222,223,225,227,228,229,230,231,232,234,235,236,237,238,241,243,244,246,248,249,250,251,252,253,254,257,258,260,261,265,266,267,268,269,271,274,275,276,279,280,282,284,286,287,288,289,291,294,295,297,298,299,301,302,303,304,305,306,309,310,313,315,316,319,320,321,322,324,326,327,328,329,332,333,334,335,336,337,339,342,343,344,345,346,347,349,352,354,355,356,357,359,360,361,362,363,365,366,367,368,370,373,375,376,377,380,381,382,385,386,391,392,393,394,395,396,397,399,400,402,403,404,405,407,408,410,411,413,414,416,417,418,419,420,421,422,423,424,425,426,427,428,432,433,435,436,438,439,441,442,445,446,448,451,452,456,457,458,459,460,461,462,463,464,465,466,467,469,471,472],argument_default:[62,120],argument_list:[145,423,426],argumentclin:472,argumentdefaultshelpformatt:122,argumenterror:[122,177],argumentpars:[62,94,120,161,189,201,230,311,396,463,466,469,471,472],argumenttypeerror:122,argv:[30,31,60,62,65,66,78,79,85,104,120,129,137,193,219,230,248,292,293,299,311,326,340,344,355,357,385,439,444,446,447,451,459,463,464,466,472],argval:190,argvemul:462,arial:380,ariel:468,aris:[31,72,93,108,187,257,266,267,274,301,381,422,426,448,458,460,466,472],arith_expr:427,arithmet:[62,169,184,214,223,227,253,255,275,290,291,320,321,345,346,355,416,424,429,436,437,441,447,459,460,461,466,467,469],arithmeticerror:[22,187,214,446],arizona:[458,459],arm:[349,469],armin:[460,461,462,463,465,466,467,468,472],armor:[197,206],armstrong:472,armv7:472,arnaud:[460,467],arnon:[469,472],aros:99,around:[7,22,24,28,30,39,44,54,64,71,78,79,82,84,85,86,96,99,101,104,105,107,112,133,140,141,143,150,154,157,161,168,178,184,187,190,193,207,216,219,227,237,248,251,252,254,264,268,274,275,282,284,287,292,296,299,304,306,321,339,343,345,355,359,361,363,373,377,380,385,399,423,424,435,436,437,438,439,443,450,456,457,458,459,460,461,462,463,464,465,466,467,468,469,471,472],arp:[339,472],arpa:[258,360,469],arr1:284,arr2:284,arr:[177,284],arrai:[2,3,5,9,15,28,35,41,49,53,55,57,58,60,62,78,79,81,82,84,90,93,95,104,119,120,152,159,172,179,183,216,227,237,253,280,284,285,287,293,301,339,346,349,362,381,399,405,416,424,435,438,448,450,459,460,461,462,463,464,466,469,471,472],arrang:[74,90,92,99,103,104,129,134,135,140,193,227,237,254,267,284,343,366,370,372,373,472],array_buffer_getbuf:472,arraydesc:177,arrayobject:74,arrays:342,arriv:[22,117,193,244,246,284,320,334,340,343,367,438,456],arrow:[178,248,299,372,373,380,439],art:[74,155,156,161,193,237],art_num:288,arthur:[168,472],articl:[1,99,109,228,236,271,288,343,380,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471],article_numb:288,artifact:[252,295,467,472],artifici:[177,446,468],arvin:462,as_byt:[197,201,202,206,209,468],as_complet:[127,131,140,167,472],as_complex:261,as_data:58,as_i:222,as_integer_ratio:[187,346,440,462,470,472],as_posix:298,as_str:[197,202,203,206,468],as_tupl:[187,462],as_uri:298,ascend:[62,310,346],ascher:457,ascii85:[144,468,472],ascii:[15,22,28,45,54,62,77,97,104,106,107,109,110,120,135,138,141,144,146,148,153,159,177,178,190,196,197,198,201,202,203,204,206,207,208,209,210,215,225,227,232,238,249,253,255,261,265,283,285,286,288,301,316,319,321,332,337,340,342,343,346,347,348,351,355,359,360,363,392,394,410,416,422,430,431,437,442,444,446,451,456,458,459,460,461,462,464,466,467,469,470,471,472],ascii_lett:[245,328,347,458,464],ascii_lowercas:[321,342,347,458],ascii_uppercas:[347,458],ascrib:103,asctim:[103,104,266,267,311,367,457,463,466],asdict:[182,472],asdl:[124,461,472],asend:[162,426],ashlei:470,ashley_0:448,ashley_1:448,ashley_2:448,ashley_:448,asian:[159,384,460],asid:[1,107,184,227,248,310,359,387,424,426,466,471],asimov:321,asin:[156,275],asinh:[156,275,462],ask:[62,65,84,91,92,93,95,97,104,106,141,162,195,225,234,236,244,248,257,268,292,299,307,312,321,333,341,343,346,392,409,410,411,426,428,432,439,450,455,460,461,462,463,464,472],ask_exit:129,ask_ok:437,askar:[470,471,472],asn:343,asnam:124,asnebc:321,asparagu:201,asparagus_cid:201,aspect:[38,78,79,86,95,104,106,110,184,193,212,237,267,293,297,320,337,424,466,470],asperg:201,aspinal:471,aspn:[110,275],aspx:455,assch:470,assembl:[84,91,99,109,342,350,424,430,461],assert:[31,45,60,62,104,108,113,118,124,140,169,182,184,185,188,193,214,227,230,254,284,292,299,321,342,363,382,385,386,397,399,408,427,429,431,446,451,459,460,462,465,466,468,469,472],assert_:[113,385,466],assert_any_cal:386,assert_cal:[386,470,472],assert_called_onc:[386,470,472],assert_called_once_with:[386,387],assert_called_with:[386,387],assert_has_cal:[386,387],assert_line_data:222,assert_not_cal:[386,469,472],assert_python:363,assert_python_failur:363,assert_python_ok:363,assert_stmt:[427,432],assertalmostequ:[113,385,463,466,472],assertcountequ:[385,466],assertdictcontainssubset:[463,465,466],assertdictequ:[385,463,465],assertequ:[113,363,385,387,447,463,466,468],assertfals:[113,385,463],assertgreat:[385,463],assertgreaterequ:[385,463],asserti:[385,387,463],assertin:[385,463],assertionerror:[22,214,284,363,385,386,387,404,432,446,472],assertisinst:[385,463],assertisnon:[385,463,465],assertisnot:[385,463],assertisnotnon:[385,463,465],assertitemsequ:463,assertless:[385,463],assertlessequ:[385,463],assertlistequ:[385,463,465,472],assertlog:[385,468],assertmultilineequ:[385,463],assertnotalmostequ:[113,385,463,466,472],assertnotequ:[113,385,466],assertnotin:[385,463],assertnotisinst:[385,463],assertnotregex:385,assertnotregexpmatch:[385,463],assertrais:[113,385,447,463,465,467,472],assertraisesregex:[385,467,472],assertraisesregexp:[385,463,465],assertregex:[385,466,472],assertregexpmatch:[385,463,466],assertsameel:467,assertsequenceequ:[385,463,465,472],assertsetequ:[385,463,465],asserttru:[113,385,463,466],asserttupleequ:[385,463,465,472],assertwarn:[385,466,467,472],assertwarnsregex:[385,466,467,472],assertxyi:385,assign:[1,31,34,49,57,62,65,79,82,85,86,91,93,94,95,98,99,109,113,122,123,124,159,161,168,169,172,177,178,182,187,190,193,197,203,204,206,209,212,213,214,227,228,237,244,252,266,271,279,284,291,292,293,299,301,308,316,321,331,332,339,343,346,349,354,355,361,363,365,373,382,384,385,386,397,408,410,419,423,424,425,426,427,428,429,431,436,437,438,444,445,446,457,458,459,460,461,462,463,464,467,469,470,471,472,473],assignment_stmt:432,assist:[80,99,109,263,279,381,396,424,458,459,460,461,462,463,471,472],assoc:329,associ:[5,22,23,25,30,40,53,57,60,62,64,65,72,79,81,82,90,92,93,97,102,103,104,106,107,110,112,122,125,129,145,153,159,167,176,178,180,187,190,193,195,197,202,204,214,222,232,242,243,246,248,251,252,254,266,276,284,286,292,293,295,297,299,301,316,329,330,339,346,348,350,359,363,366,368,370,372,373,385,399,400,402,403,404,407,410,412,413,416,417,419,420,422,425,428,432,434,436,438,439,450,452,463,466,467,468,471,472],associatefil:455,assoclen:339,assort:[62,65,80,193,372,472],assret:[386,472],assret_called_once_with:386,assret_called_with:386,assum:[5,7,30,31,37,41,49,51,55,57,64,65,74,75,78,79,80,82,84,85,90,91,93,99,101,102,103,104,105,106,107,108,109,111,112,122,129,149,152,153,155,156,159,161,162,167,168,170,176,177,184,197,200,202,203,204,210,211,222,225,227,232,237,243,244,248,249,250,252,256,265,266,267,284,288,292,293,297,298,299,304,313,315,335,339,342,343,345,346,347,349,350,359,361,365,367,373,382,385,387,392,396,405,413,418,424,426,428,432,434,436,438,440,442,446,455,456,457,458,461,462,464,467,468,469,470,471,472],assumpt:[30,57,79,82,93,142,162,184,252,426,458,462,466,470,471,472],assur:[35,82,93,156,228,275,375,424,463,465,466],ast:[62,185,227,253,263,297,354,427,461,467,471,472],ast_unpars:472,astamp:380,asterisk:[124,249,312,346,403,410,426,432,438,471],astimezon:[184,189,467,470,472],astr:306,astral:472,astronomi:449,astroob:449,astupl:[182,472],astz:184,asymmetr:159,asymmetri:424,async:[18,29,46,62,93,126,127,128,129,131,135,136,137,138,139,140,170,171,254,343,355,374,381,382,424,426,427,431,470,471,472],async_chat:[125,141,468,472],async_for_stmt:423,async_funcdef:[423,427],async_queri:382,async_stmt:427,async_with_stmt:423,asynccontextmanag:[170,382,424,471,472],asyncexitstack:[170,471,472],asyncfor:[124,472],asyncfunctiondef:[124,472],asyncgen_hook:355,asyncgener:[162,382,470,472],asyncgeneratortyp:381,asynchat:[62,141,253,259,422,462,468,472],asynchron:[29,57,62,90,93,128,129,131,132,135,138,140,162,167,170,171,190,214,253,254,255,259,266,284,339,343,350,355,381,403,423,432,463,466,467,468,469,471,472],asyncio:[62,125,127,129,130,131,132,133,134,135,136,137,138,139,141,162,253,259,336,343,350,355,424,426,451,472],asynciomodul:472,asynciter:[162,382,469,472],asyncor:[62,90,125,253,259,336,340,422,460,462,472],asyncresult:284,asyncwith:[124,472],asynczip:448,at_end_lin:280,at_eof:137,atan2:[156,275],atan:[156,275,462],atanh:[156,275,462],atequ:374,atexit:[62,84,90,113,253,317,322,399,456,460,472],atheo:[459,472],athirdstr:306,athrow:[162,426,472],athukorala:472,atim:293,atime_n:293,atle:461,atof:[265,460,461],atoi:[78,265],atom:[26,62,90,229,284,293,318,321,339,346,366,427,429,463,464,467,472],atom_expr:427,atop:[343,461,462],atruevalu:306,atsuo:468,attach:[30,41,62,78,103,104,129,134,161,167,184,188,193,195,197,198,200,204,206,207,208,213,248,266,267,329,330,342,355,372,385,387,404,423,424,432,436,447,457,459,463,464,467,470,472],attach_loop:134,attach_mock:[386,387],attack:[84,109,129,174,236,238,267,328,333,342,406,442,461,463,467,468,469,472],attain:227,attempt:[5,10,28,30,31,43,54,57,91,92,93,95,97,100,101,102,104,106,109,110,112,118,122,135,151,157,161,167,168,169,170,174,176,178,184,185,187,189,193,195,197,200,204,206,208,210,212,213,214,225,227,228,237,243,244,248,252,254,257,261,264,265,267,268,269,271,283,284,293,295,301,307,313,315,316,321,322,324,327,329,333,334,335,337,338,339,340,342,343,345,346,349,355,360,361,363,365,366,367,385,386,391,392,395,396,398,404,407,410,412,413,414,419,420,421,424,426,428,429,432,436,437,439,441,442,445,446,451,456,457,458,459,460,461,462,463,464,465,467,469,470,471,472],atten:446,attent:[7,106,178,380,446,459,466,468],attim:[268,468],attitud:193,attlistdeclhandl:316,attnam:316,attr:[62,85,95,97,124,178,241,245,254,273,282,291,292,301,316,363,370,385,386,410,412,413,414,424,432,456,457,460,467],attr_nam:[45,57,363,458],attract:[84,271,370,462,464],attrdict:266,attrgett:[93,99,108,291,460,461,462,466,469,472],attrib:[410,461,472],attribut:[10,20,21,22,23,25,28,30,31,41,45,51,53,55,56,57,62,65,80,85,93,95,98,99,103,104,106,108,110,113,114,118,120,122,123,124,125,128,129,131,135,137,138,145,150,151,152,153,157,159,160,161,168,169,173,176,177,178,182,183,184,187,188,189,190,193,196,197,198,201,204,206,208,209,214,216,217,222,225,227,228,230,234,235,236,238,239,241,243,244,245,246,248,249,252,253,255,257,258,261,267,268,269,271,273,282,284,286,291,295,301,304,305,306,307,312,314,315,316,317,321,323,327,329,332,333,334,335,336,337,338,339,340,341,342,343,344,347,349,350,352,355,359,361,362,363,365,366,367,368,371,377,378,380,381,382,385,388,390,391,392,395,396,397,399,402,404,405,407,408,410,411,412,414,416,417,419,420,421,422,423,425,431,432,436,437,438,439,443,446,447,448,451,455,456,459,460,461,462,463,464,465,466,467,468,469,472,473],attribute1:386,attribute2:386,attribute_nam:347,attribute_nod:407,attributeerror:[22,45,53,98,153,177,214,227,228,252,254,267,284,301,321,334,346,363,368,381,385,386,387,407,408,424,426,432,446,456,458,463,466,467,468,469,471,472],attributenam:[10,79],attributeref:[426,432],attributesimpl:413,attributesn:[62,273,411,412],attributesnsimpl:413,attrnam:[85,266,407],attroff:178,attron:178,attrs_dict:410,attrset:178,atyp:428,au_read:[62,278],au_writ:[62,278,468],audibl:[104,178],audienc:[71,74,103,309,397,430,459,464],audio:[62,119,155,207,253,278,351,363,398,403,456,472],audio_file_encoding_adpcm_g721:351,audio_file_encoding_adpcm_g722:351,audio_file_encoding_adpcm_g723_3:351,audio_file_encoding_adpcm_g723_5:351,audio_file_encoding_alaw_8:351,audio_file_encoding_doubl:351,audio_file_encoding_float:351,audio_file_encoding_linear_16:351,audio_file_encoding_linear_24:351,audio_file_encoding_linear_32:351,audio_file_encoding_linear_8:351,audio_file_encoding_mulaw_8:351,audio_file_mag:351,audio_mac:462,audiodev:[295,462],audioop:[62,253,278,461,472],audit:459,aug:[30,99,111,184,420,458,459],augassign:[124,427],augload:124,augment:[57,62,65,81,91,193,267,276,332,372,424,431,451,466,472,473],augmented_assignment_stmt:432,augop:432,augstor:124,augtarget:432,augu:151,auguri:459,august:461,augustu:431,aumasson:[236,422],auread:446,austin:462,australia:[367,450],australianphilosoph:424,austria:[342,410],auth:[225,249,268,337,343,459,469,472],auth_cram_md5:337,auth_handl:392,auth_login:337,auth_plain:337,auth_siz:236,authent:[62,165,175,225,236,242,249,253,266,268,286,288,307,328,337,343,390,392,416,421,458,463,466,467,468,469,470,471,472],authenticationerror:284,authinfo:288,authkei:284,authobject:[249,337],author:[28,64,65,66,69,71,74,77,79,83,93,94,95,96,97,98,99,101,102,103,104,105,106,107,108,110,111,112,129,159,161,192,193,214,236,268,289,293,309,342,343,370,385,392,404,416,422,446,449,453,456,457,458,459,460,461,462,463,464,465,466,468,469,472],author_email:[65,66,69,74,77,309],authoris:249,authorit:[28,110,421],authorized_kei:333,authorizer_callback:342,authpriv:268,authreq:392,authuri:392,auto:[30,62,66,68,86,110,183,184,248,322,332,339,343,380,386,387,445,456,463,466,470,471,472],autocommit:342,autocomplet:[470,471,472],autocompletewindow:248,autoconf:[65,72,472],autodetect:[65,109,306,359,392,457,461],autoexec:106,autoexpand:472,autogil:462,autoincr:373,autojunk:189,autom:[31,62,82,90,93,95,105,188,225,253,288,366,385,435,457,463,464,468],automat:[7,11,22,30,31,41,50,54,57,62,64,66,68,69,74,75,77,79,81,82,90,91,92,93,95,96,97,98,99,102,105,106,107,109,111,112,113,122,129,134,135,137,139,140,141,142,153,157,159,161,162,168,169,170,176,177,178,182,183,185,187,188,189,190,192,193,197,202,206,207,209,210,214,227,228,229,235,241,243,244,249,252,266,267,269,271,272,279,282,284,288,292,293,294,299,301,308,310,315,322,325,329,331,333,335,337,339,340,342,343,345,346,347,349,350,351,355,359,361,363,366,367,368,369,370,373,380,385,386,387,391,392,396,398,399,402,404,408,412,416,420,421,422,424,425,426,428,432,434,436,437,442,443,445,446,447,448,450,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],automata:106,automatrix:422,automount:30,autonam:212,autonom:[340,422],autonumb:212,autorais:[400,461],autorang:[368,470,472],autosav:248,autospec:[62,188,387,472],autotool:[463,469,470],auwrit:446,auxiliari:[104,145,260,466],auxiliary_modul:104,avail:[5,6,7,10,22,30,31,38,40,41,50,52,54,58,60,62,64,65,66,68,70,71,72,75,77,78,79,80,81,83,84,86,87,90,91,92,93,95,97,103,104,105,106,107,109,110,111,112,113,117,118,120,122,123,125,129,130,131,132,133,134,135,136,137,138,140,141,150,157,159,161,164,167,168,171,174,175,177,178,183,185,187,190,192,196,208,211,212,213,214,215,216,219,222,224,225,227,232,234,236,237,242,243,246,248,252,253,254,257,258,261,265,266,267,268,270,271,275,276,277,278,279,283,284,286,287,288,292,293,294,295,296,297,299,301,304,305,306,308,310,312,315,316,317,318,319,320,321,323,324,325,327,329,330,331,332,333,334,335,336,337,339,340,341,342,343,344,346,347,348,349,350,355,357,359,360,361,362,363,366,367,369,370,371,372,373,375,377,381,382,385,386,387,392,395,396,399,400,401,402,404,405,406,407,408,410,411,412,413,416,417,418,419,420,421,422,423,424,425,426,428,429,430,431,432,433,435,437,441,443,444,446,449,450,451,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],availmask:178,avenu:[321,422,458],averag:[62,84,98,143,237,290,293,310,320,328,350,373,378,430,447,464,468,472],average_arrival_interv:320,average_service_tim:320,averi:471,avg:143,avgpp:143,aviv:[470,472],avoid:[17,30,38,40,57,58,64,74,78,79,81,82,84,91,93,95,97,99,103,104,105,106,107,108,109,114,118,122,123,128,129,134,135,138,140,159,167,168,170,172,177,184,187,211,216,227,229,232,237,238,243,246,249,254,258,264,267,271,275,279,284,289,292,293,301,316,320,321,323,333,334,336,339,342,344,345,346,350,355,359,365,366,368,372,381,385,387,399,403,406,407,408,414,423,424,426,427,428,431,432,436,437,438,439,445,448,455,456,458,459,460,461,462,463,464,466,467,468,469,470,471,472],avoids_symlink_attack:333,avraham:472,awai:[22,30,31,74,82,91,95,99,103,107,122,178,184,187,193,214,248,253,254,292,293,294,310,342,392,435,436,448,458,459,464,468,469,472],await:[57,62,93,124,126,127,129,130,131,132,135,136,137,138,139,162,170,171,190,254,355,374,381,382,423,427,429,431,456,459,470,471,472],await_expr:426,awaken:[139,366],awar:[58,62,64,83,86,89,93,102,106,107,108,112,168,180,184,195,197,201,203,204,206,207,210,227,228,232,249,265,272,293,297,343,347,355,367,368,397,413,440,447,451,453,455,456,458,459,460,464,465,466,467,470,471,472],awk:[435,456],awkward:149,awkwardli:463,awoken:366,awri:366,aws:140,ax_check_openssl:472,axi:[91,156,275,373],aycock:457,ayon:201,ayt:360,ayz:346,azur:472,b10:98,b16decod:144,b16encod:144,b1o:391,b2a_base64:[147,470,472],b2a_hex:[147,159],b2a_hqx:147,b2a_qp:[147,472],b2a_uu:[147,471,472],b2j:189,b32:468,b32decod:[144,468,472],b32encod:144,b64decod:[144,236,467],b64encod:[144,236,472],b85decod:[144,468],b85encod:[144,468],b_c:464,babel:232,babyl:[62,285],babylmessag:[62,285],bac:122,bacd:161,bach:161,back:[1,7,21,26,31,35,37,38,54,57,58,62,64,65,69,80,82,84,90,91,92,94,95,99,101,104,105,106,107,109,113,122,123,135,144,147,153,156,157,159,161,168,170,178,182,184,187,189,190,193,195,197,206,209,216,222,225,227,229,231,232,244,246,252,256,257,261,267,268,274,279,283,284,289,291,292,293,294,295,299,301,314,316,321,331,339,340,342,343,344,346,347,353,355,363,367,370,374,375,380,387,391,392,410,414,415,416,417,419,421,423,424,428,432,436,442,456,457,458,459,460,461,462,463,464,465,466,467,468,470,472],backend:[87,159,178,342,363,387],backendprovid:387,background:[30,62,66,83,97,101,107,129,141,168,170,178,247,248,268,284,293,350,352,363,370,372,373,380,423,424,448,460,468,472],backgroundbrows:400,backgroundcolor:380,backgroundimag:380,backlog:[129,137,141,284,339,469,472],backport:[62,105,252,386,462,469,470,471,472],backquot:[62,165],backrefer:[106,321,472],backslash:[13,62,65,67,111,159,160,193,210,227,257,284,293,298,321,350,431,442,445,459,460,464,470,471,472],backslashreplac:[30,109,159,215,227,257,346,355,451,459,469,471,472],backslashreplace_error:159,backspac:[97,106,178,179,248,321,431,444,472],backtick:[113,147,394,464,471],backtrack:[106,472],backup:[104,113,219,342,359,462,466,471,472],backupcount:[104,267,268,463],backward:[23,30,58,60,74,86,93,95,103,104,122,123,125,141,145,153,161,168,178,184,193,195,197,206,208,209,214,230,237,242,246,248,249,252,257,266,267,271,274,291,293,294,295,297,301,304,310,316,320,321,324,333,339,343,346,350,351,352,358,361,363,367,380,382,385,391,392,394,398,406,410,416,428,431,432,436,455,456,458,459,461,462,464,466,467,468,469,470,471,472],bacon:[122,161,189,252,280,346,377,392],baconhamegg:280,bad:[17,65,68,78,79,92,94,96,103,105,107,110,122,176,189,193,202,213,248,265,271,284,292,310,380,419,432,446,458,462,464,470,472],bad_gatewai:242,bad_request:242,badger:122,badli:[394,468,472],badmodul:280,badstatuslin:243,badzipfil:419,baffl:311,bag:[161,201,436],baggag:81,bail:31,bailei:462,baiter:[469,472],baji:472,bak:219,bake:[176,321],baker:466,bakker:[471,472],bal:260,balanc:[86,106,161,237,343,468],balcerzak:470,balling:472,balloon:372,ballot:466,balogh:[470,472],baltic:159,bam:[103,266],banana:[291,438,447],band:[141,222,329],bandwidth:[104,109,463],bang:386,bank:462,banner:[141,157,158],banquet:462,bar:[26,65,68,69,74,91,92,93,95,103,104,106,122,157,168,177,178,201,212,230,244,248,251,252,261,266,267,284,288,291,292,293,294,298,299,304,310,313,315,321,335,342,359,363,370,371,373,382,385,386,387,404,419,420,428,430,432,456,462,472],bar_const:363,bar_pars:122,bar_test:[385,471],bar_var:91,bare:[65,74,93,95,103,104,168,204,214,292,337,453,455,461,464,472],barebon:453,barfoo:342,barker:[469,472],barn:[462,471,472],barnert:[470,472],barnett:[468,472],barran:462,barri:[232,456,457,458,460,461,462,466,467,468,469,470,471,472],barrier:[62,165,284,466],bartelt:91,barton:472,base16:[62,253,285,460],base1:436,base2:436,base32:[62,253,285,460,472],base3:436,base64:[62,147,159,196,197,198,199,200,203,204,207,209,236,249,253,285,319,328,337,343,378,392,416,458,460,472],base64_codec:159,base64seto:58,base64whitespac:58,base85:[62,253,285,468,472],base:[5,13,18,22,24,27,28,30,31,35,39,41,43,44,45,56,57,58,62,66,69,71,72,74,75,79,81,82,84,89,90,92,93,94,95,97,98,99,101,102,103,105,106,110,111,112,120,122,124,126,129,131,132,134,144,145,146,147,149,152,156,161,164,165,168,170,174,177,181,182,183,184,187,188,192,193,196,198,199,200,201,202,203,204,206,207,209,212,222,223,227,228,235,236,237,238,241,242,243,244,246,247,249,253,254,255,260,261,264,265,266,267,268,269,271,273,275,276,281,282,283,288,290,292,293,294,296,300,301,304,307,310,314,316,317,321,322,323,326,330,331,333,335,336,337,338,339,340,342,343,346,347,349,350,355,356,359,363,367,370,372,373,378,381,382,384,385,386,387,390,391,392,395,396,397,399,400,405,406,407,408,410,411,413,414,416,417,418,419,421,422,423,424,425,426,429,431,436,438,439,440,446,447,448,451,453,455,456,457,458,459,460,461,464,465,467,468,469,470,472,473],base_64:159,base_class:204,base_dir:[65,333],base_environ:404,base_ev:[355,426],base_exec_prefix:[335,355,396,418,446],base_nam:[65,333],base_prefix:[335,355,396,446],basealia:91,basecgihandl:404,baseclass:84,baseclassnam:436,baseconfigur:267,basecooki:245,basedir:[65,282],baseeventloop:472,baseexcept:[22,167,214,355,428,432,446,461,462,464,471,472],basehandl:[62,255,386,404,472],basehead:[204,206],basehttp:246,basehttprequesthandl:[110,246,390,404,466,467,472],basehttpserv:464,baselin:[161,368],basemanag:284,basenam:[65,66,95,101,185,193,292,294,298,370,372,419],basename_extens:95,basename_root:95,baseprotocol:135,baseproxi:284,baserequesthandl:340,baserotatinghandl:[62,103,120,460],baseselector:[330,472],baseserv:[340,467,472],basestr:[113,459,464,468],basetestsuit:385,basetransport:[135,137],basetwo:228,baseus:382,bash:[157,298,332,396,443,449,472],bashdb:91,basi:[65,91,93,103,104,135,140,159,177,192,241,244,261,266,271,310,355,359,382,422,428,432,435,458,459,471],basic:[22,30,31,53,57,58,62,65,68,69,71,72,79,80,81,83,86,90,91,93,97,99,102,104,105,111,113,122,123,139,145,146,149,157,159,161,168,170,178,183,185,186,188,189,191,220,232,235,241,242,246,248,252,253,254,255,257,266,267,268,284,285,292,306,309,310,320,324,328,339,340,343,346,349,350,359,363,366,369,371,373,377,386,387,392,393,403,409,410,411,412,416,421,426,432,436,438,440,441,442,445,447,456,458,459,461,462,463,465,466,467,468,469,472],basicauth:392,basicconfig:[103,104,128,170,266,460,466,467,472],basiccontext:[187,467],basicinterpol:168,basictestrunn:363,basicus:382,basket:438,bass:250,bastien:468,bastin:[109,460],bastion:459,bat:[95,106,298,363,396,449,472],batch:[92,103,106,129,301,350,435,448,455,469,472],batcheld:[109,472],batchmod:168,batchrenam:448,batista:[460,462],batteri:[62,441],batuhan:472,baud:97,baudrat:178,bauer:459,baxter:[71,458,460,461],bayard:472,bayer:472,bayl:471,baz:[103,104,122,168,248,251,252,261,266,267,284,293,313,321,363,385,386,387,404,428,432],bbb:260,bbbb:106,bbc:[86,167,435,469],bbdehiioqssuvvwx:451,bbedit:[178,453],bbhhiillqq:463,bbox:373,bcc:337,bcd:106,bcde:[189,463],bce:346,bcj:269,bck:342,bclass:106,bcm:339,bcpp:111,bcppcompil:71,bd1a:[395,461],bdaddr:339,bdaddr_ani:339,bdaddr_loc:339,bdb:[62,168,186,253,299,463,472],bdbquit:145,bdfl:93,bdist:[66,71,72,469],bdist_:[66,457],bdist_dumb:[66,71,77],bdist_msi:[66,71,282,472],bdist_openpkg:70,bdist_packag:71,bdist_pkgtool:72,bdist_rpm:[66,68,71,72,77,456],bdist_sdux:72,bdist_wheel:64,bdist_wininst:[66,71,72,77,456,472],bean:[176,321],bear:[58,111,184,244,252,284,346,355],beast:107,beaten:361,beauti:189,beazlei:[109,458,466],becam:[84,99,114,161,227,293,337,367,456,462,463,469,472],becaus:[5,22,30,31,38,41,43,47,49,52,53,55,57,58,65,66,74,75,77,78,79,81,82,84,89,90,91,92,93,94,95,97,99,102,103,104,105,106,107,108,109,110,111,113,114,122,124,129,130,131,135,137,138,140,149,151,152,153,158,159,161,162,164,167,168,170,172,177,182,184,185,187,189,193,197,202,204,206,209,212,213,214,215,216,227,229,232,236,237,244,245,246,248,252,254,257,260,266,267,268,269,271,274,282,284,287,289,292,293,294,295,297,298,299,301,302,303,311,320,321,329,331,332,333,335,337,339,340,342,343,346,347,350,351,355,359,360,361,363,366,367,368,372,379,380,382,385,386,387,392,397,398,399,403,404,406,407,410,412,416,421,423,424,425,426,427,428,431,432,435,436,437,438,439,440,445,446,447,449,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,471,472],beck:[363,385,457],becker:467,becom:[26,30,31,52,57,60,65,79,84,86,90,91,92,93,96,97,98,99,101,104,105,106,107,108,109,113,114,135,139,141,143,159,161,176,178,193,197,203,206,212,222,227,237,248,254,257,260,284,292,293,294,299,301,310,313,321,329,330,332,334,343,346,347,350,355,366,370,373,386,387,392,399,419,423,424,425,426,432,437,440,442,448,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],beda:463,bednarski:472,bee:[65,212],beef:466,been:[1,2,5,7,12,17,21,22,28,30,31,38,39,41,52,53,54,55,57,58,65,66,67,70,74,75,77,79,81,84,85,87,89,90,91,92,93,94,95,97,98,99,102,103,104,105,106,107,109,110,111,112,113,117,119,122,123,125,129,130,131,135,136,140,141,143,145,151,153,155,157,159,161,167,170,177,178,180,184,185,187,189,193,197,200,202,203,205,208,213,214,219,222,225,227,228,229,232,236,237,241,243,244,245,248,251,252,254,257,258,260,265,266,267,268,269,271,276,282,283,284,288,292,293,294,295,297,298,299,301,304,310,311,316,318,320,321,322,324,329,330,332,334,335,337,339,340,342,343,346,349,350,352,355,357,359,361,362,363,365,366,367,369,370,372,373,378,380,382,383,384,385,386,387,390,391,392,396,397,398,399,400,402,405,408,409,410,413,416,417,418,419,421,422,423,424,425,426,428,431,432,433,438,439,440,442,443,446,447,448,449,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],beep:[178,403,444,470],beer:[177,472],befor:[5,7,16,19,22,26,28,29,31,34,38,41,47,50,51,53,54,55,57,58,60,62,65,66,68,70,74,78,79,81,82,83,84,85,91,93,94,95,97,98,99,101,103,104,106,107,108,109,110,111,117,119,122,123,129,130,131,134,136,137,138,139,140,142,143,144,149,151,152,153,155,157,158,159,160,161,167,168,170,171,176,177,178,184,185,187,189,190,193,196,197,202,204,206,212,214,219,222,225,227,228,229,235,243,244,246,248,249,251,252,257,258,260,265,266,267,268,269,271,276,279,284,288,289,292,293,295,298,299,301,302,307,309,310,311,315,316,320,321,322,326,327,329,330,331,332,333,334,335,337,339,340,341,342,343,346,347,348,349,350,354,355,359,360,363,365,366,367,372,373,378,380,385,386,387,391,392,396,397,398,399,402,404,407,408,409,410,411,412,413,417,419,422,423,424,425,426,428,431,432,434,436,437,438,439,442,444,445,446,450,451,455,456,457,458,459,460,461,462,463,466,467,468,469,470,471,472],before_async_with:190,beforehand:[41,428],beg:178,began:[86,244,252,266,363,456,457],beget:440,begidx:157,begin:[7,17,22,31,53,65,70,79,81,82,84,85,90,91,92,93,95,99,104,105,106,107,111,119,122,152,153,157,161,168,178,179,184,187,189,193,197,202,210,216,222,225,233,248,251,252,254,256,261,269,271,279,284,288,293,294,299,303,304,316,321,322,326,335,337,342,343,346,347,349,351,359,360,361,363,365,368,370,373,375,385,398,410,412,413,423,424,425,426,428,430,431,432,434,435,436,437,438,439,442,445,446,450,451,455,458,461,462,463,470,471,472],begin_fil:380,begin_i:[97,178],begin_poli:380,begin_x:[97,178],beginn:[86,89,332],begun:[101,366,459,460],behalf:[30,334],behav:[22,30,41,57,58,82,84,91,94,95,96,104,106,109,123,164,168,170,177,185,187,212,227,228,245,257,271,279,288,293,337,339,340,343,346,350,355,357,361,365,370,382,385,387,408,424,426,431,434,436,437,455,456,457,458,459,460,461,462,463,464,467,468,471,472],behavior:[1,5,17,21,22,30,31,38,62,79,84,85,91,93,95,96,97,98,103,104,107,118,122,129,132,134,140,151,158,161,167,168,174,176,177,178,182,183,187,189,193,195,197,202,204,206,207,209,212,214,219,227,235,237,241,243,248,254,260,261,265,266,268,269,271,275,276,284,286,288,292,293,298,301,304,311,316,329,332,333,334,335,337,339,340,343,345,346,347,349,350,355,361,363,366,367,368,370,371,373,377,382,385,391,392,397,404,407,410,424,426,428,431,432,436,445,451,455,459,460,461,462,463,464,465,466,467,472,473],behaviour:[28,30,31,35,62,74,75,90,91,93,94,99,103,104,106,111,129,167,170,192,214,216,218,227,238,244,254,257,265,266,267,268,284,292,298,301,321,322,329,332,334,336,339,340,345,346,350,355,365,367,380,386,387,391,392,397,413,416,418,424,426,428,442,451,455,456,457,458,459,460,461,462,463,467,468,470,471,472],behind:[65,87,96,98,111,141,177,193,311,327,392,424,436,442,457,460,472],behnel:[468,469,471,472],being:[5,7,15,26,30,31,34,40,52,57,58,60,64,65,66,74,79,80,81,82,84,86,90,91,93,97,98,99,102,103,104,105,106,107,108,109,110,111,112,116,122,123,125,129,135,137,140,151,152,153,159,161,162,164,167,168,169,170,171,176,177,178,182,184,185,190,193,194,196,197,203,206,209,212,214,217,219,222,227,228,229,232,235,237,248,249,251,252,254,257,258,260,261,265,266,267,268,269,271,276,279,284,292,293,295,297,299,301,304,305,309,310,311,314,316,320,321,322,326,329,330,331,333,334,337,339,340,342,343,346,347,349,350,355,356,358,361,363,365,366,367,368,370,373,377,382,385,386,387,390,391,392,396,397,399,404,407,410,411,412,414,418,422,423,424,426,428,430,432,435,436,439,440,442,445,446,448,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],bel:[179,431],belchenko:463,believ:[84,93,99,107,237,292,328,459],bell:[178,179,431,461],belmont:460,belong:[30,38,57,69,72,79,91,111,145,167,193,212,244,252,257,258,272,282,292,293,316,340,346,373,381,397,407,413,423,424,436,437,463,467,472],belopolski:[109,462,463,465,466,469,470,471,472],below:[7,22,23,28,30,31,41,50,54,55,57,58,60,74,77,79,82,91,95,98,99,103,104,110,111,117,119,122,123,124,125,132,135,136,137,139,145,151,156,159,168,172,173,176,178,180,182,184,187,190,193,196,204,209,212,214,222,223,225,227,229,232,234,236,237,241,243,244,246,248,249,250,251,252,253,257,265,266,267,268,274,276,283,284,288,291,292,293,295,297,298,299,312,316,318,320,321,322,323,324,326,329,330,332,333,334,335,336,337,340,341,343,344,346,347,348,350,355,357,358,359,360,361,363,365,366,367,370,373,376,377,380,382,385,386,387,392,397,403,410,411,416,417,421,422,423,424,426,427,428,431,436,437,440,455,456,457,459,461,462,463,464,468,469],below_normal_priority_class:350,ben:[457,461,469,472],benc:472,benchmark:[91,228,310,451,456,457,459,460,461,463,464,465,467,468,469,472],bend:460,benderski:468,beneath:[113,410],benefici:[91,104,469],benefit:[64,84,91,99,104,105,108,112,187,192,266,267,301,346,355,363,373,382,399,404,436,455,458,459,460,463,466,467,471,472],benesch:470,benevol:[93,456],bengt:462,beni:460,benign:244,benjamin:[96,109,462,463,465,466,467,468,469,470,471,472],bennett:466,benno:[469,472],bent:106,beo:464,beopen:[62,63],bepoint:346,bereft:437,berkelei:[107,185,370,464],berkeleydb:[459,462,463],berkelydb:472,berker:[468,469,470,471,472],berman:468,bernard:472,bernat:343,bernhard:471,bernstein:[236,422,462],bertogli:462,bertoni:470,besid:[82,95,161,212,257,334,373,399,431,432,437,445,455,472],bessel:345,best:[5,28,31,50,58,62,66,74,84,86,90,93,95,96,97,99,103,105,133,143,175,184,187,189,193,195,196,206,225,227,228,232,237,243,249,251,266,269,284,288,292,293,305,307,309,310,332,337,339,342,355,359,368,370,372,380,386,400,416,428,435,437,438,440,447,453,455,456,460,461,464,466,468,469,470,472],bet:79,beta:[4,62,74,114,320,355,456,462,469,473],betavari:320,bethard:[461,463,466,469,472],better:[31,62,65,66,74,77,78,79,81,82,84,86,90,91,95,99,105,106,107,112,116,122,129,143,149,160,161,177,189,193,216,225,228,230,232,236,237,254,260,265,271,284,292,293,297,307,310,329,342,343,345,366,367,373,380,385,386,387,394,410,421,436,437,439,440,442,446,456,458,459,460,461,462,463,464,465,466,467,468,470,471,472],betti:416,between:[14,30,31,34,35,38,41,49,51,57,58,62,65,66,68,71,78,79,80,81,82,84,85,86,90,93,94,95,96,97,99,101,102,103,104,106,107,108,111,122,124,127,129,135,136,139,143,151,152,156,159,161,165,168,172,174,178,184,187,190,193,196,197,198,202,206,212,217,219,222,227,232,236,237,241,248,252,253,254,257,258,260,261,265,266,267,269,274,275,276,278,279,285,289,291,293,295,297,298,299,301,302,310,318,320,321,322,335,336,339,340,341,342,343,346,349,350,351,352,353,355,360,361,363,365,366,367,368,370,372,373,374,375,378,380,382,385,386,387,391,392,397,398,402,404,407,408,410,414,416,421,422,424,426,428,430,432,436,437,438,439,442,445,446,447,451,455,456,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472,473],beverag:103,bewar:[159,214,223,261,284,331,343,428,447,464],beyond:[1,30,62,74,80,93,94,97,102,103,106,120,161,187,198,204,254,261,267,271,283,293,321,339,343,346,382,383,402,430,437,457,467,472],bf_getbuff:57,bf_releasebuff:[5,57],bfd:466,bfoo:321,bgcolor:380,bgenloc:462,bgpic:380,bhi:189,bia:[143,310,466],bias:[197,206,320,345,459],bibbl:386,bick:[99,404],bidirect:[109,129,135,163,257,284,346,348,384,456],bierenfeld:468,big5:[159,460],big5hksc:[159,460],big:[4,31,58,74,79,84,90,95,99,104,109,134,135,143,155,159,168,177,178,190,232,237,258,268,295,346,349,351,355,363,386,395,402,430,448,458,459,460,463,465,466,468,472],bigaddrspacetest:363,bigcharset:458,bigdecim:416,bigendian:155,bigendianstructur:[177,346,472],bigendianunion:177,bigger:[58,346,359,455],biggest:[86,97,105,378,464,466,467],biginteg:416,bigmem:363,bigmemtest:363,bignum:467,bigobject:261,biject:[30,109],bill:[346,442,456,462],billah:472,billi:457,billion:406,bin:[30,31,62,74,78,84,85,90,99,104,109,110,111,153,165,168,189,201,227,246,292,293,298,303,346,347,356,392,393,396,418,424,434,444,446,447,449,453,454,455,459,460,461,462,463,464,465,472],bin_path:396,binari:[5,7,29,37,38,43,57,60,62,66,69,71,72,74,77,80,81,84,86,87,93,96,101,104,109,111,117,120,123,129,143,144,148,151,169,177,183,187,190,195,197,198,199,201,202,204,206,208,209,216,223,225,227,232,235,236,237,238,246,249,251,252,253,254,255,258,260,261,265,267,268,269,271,274,275,282,283,284,285,288,292,293,298,301,304,305,306,319,339,347,350,355,356,359,361,364,370,392,394,396,399,402,410,413,417,418,419,422,424,429,432,435,440,441,442,447,451,453,454,455,456,459,460,461,462,463,464,465,466,467,468,469,470,471,472],binary16:349,binary32:349,binary64:349,binary_add:[190,466,468],binary_and:190,binary_floor_divid:[190,466],binary_form:343,binary_lshift:190,binary_matrix_multipli:190,binary_modulo:[190,466],binary_multipli:[190,466],binary_or:190,binary_pow:190,binary_rshift:190,binary_subscr:190,binary_subtract:190,binary_true_divid:190,binary_xor:190,binaryfunc:57,binaryio:[252,382],binascii:[62,144,148,159,236,253,285,394,422,463,468,472],binbytes8:472,bind:[12,40,53,62,84,91,93,98,104,107,129,141,170,172,178,193,225,227,232,242,246,254,265,267,294,296,322,330,336,337,339,340,343,354,355,363,369,372,373,380,406,423,424,426,428,429,430,432,436,453,456,457,458,460,461,462,467,468,469,471,472],bind_and_activ:[340,417,462],bind_parti:254,bind_port:363,bind_textdomain_codeset:[232,265,460],bind_unix_socket:363,bindigit:431,bindir:466,bindsocket:343,bindtag:373,bindtextdomain:[232,265],binhex4:[62,147,253,285],binhex:[62,147,253,285],binint1:302,bininteg:431,binlibdest:466,binop:[124,462],binpath:396,binput:[302,472],binunicode8:472,binutil:111,bio:[62,288,472],biondi:461,biopython:288,bioreason:422,birthdai:447,bisect:[62,183,253,448,460,472],bisect_cmd:472,bisect_left:149,bisect_right:149,bit:[4,5,7,31,37,53,56,57,58,60,62,65,66,74,79,81,82,84,87,91,92,94,95,96,97,99,102,104,106,107,109,119,120,123,135,143,147,154,155,156,159,168,170,178,179,187,190,193,196,201,202,203,206,209,212,216,217,227,229,232,236,244,245,258,265,269,274,275,287,289,292,293,295,301,305,308,317,320,321,324,328,329,333,338,339,343,344,346,349,350,351,355,357,359,361,367,368,370,373,387,394,395,401,407,418,419,421,424,426,431,436,437,440,442,455,456,457,458,459,460,461,462,463,465,466,467,468,469,470,471,472],bit_length:[275,346,463,465],bitand:124,bitbucket:[64,112,168,396],bitdanc:468,bite:[91,106,292,387],bitfield:[53,114,227],bitmap:[66,74,250,254,282,329,370,372,373],bitmapimag:370,bitmask:[57,129,193,295,329,330],bitor:124,bits_per_digit:[355,463,465],bits_per_sampl:338,bitstr:101,bitter:472,bitwis:[43,62,81,95,97,99,106,178,179,193,212,216,227,283,291,293,321,330,339,403,424,429,459,462,463,470],bitxor:124,bjoern:472,bjorn:461,bjunk:[189,468],bkfile:472,bkgd:178,bkgdset:178,black:[95,97,109,149,161,178,212,248,320,373,380,448,459,460,468],blackbox:363,blacklist:[244,363,471,472],blah:[69,109,269,292,370],blahai:472,blai:461,blake2:[62,175,470,472],blake2b:[236,470,472],blake:[99,236],blanch:[467,472],bland:[292,461,462],blank:[62,65,68,90,91,95,99,122,125,153,157,168,176,178,187,189,193,197,206,208,209,222,243,246,248,267,299,302,335,342,343,346,380,391,404,410,432,433,437,442,445,455,460,469,471,472],blanklin:[193,222,460],bleed:171,bleedin:437,bletch:335,blib:111,blindli:[105,346,468],blink:[97,178],blip:387,blksize:[257,404],blktype:359,blo:189,bloat:106,blob:[342,343,387],block2:423,block:[5,7,10,22,30,31,38,41,50,57,62,72,79,81,83,84,93,95,96,97,106,110,113,116,119,129,130,132,135,136,137,138,139,140,141,145,147,151,170,177,178,179,186,187,189,190,193,194,200,208,209,213,214,216,225,227,236,238,243,244,248,251,254,257,260,268,273,283,284,293,295,298,315,318,324,327,329,330,331,333,334,337,339,342,344,350,354,355,359,360,363,366,385,386,392,398,400,402,403,408,413,423,424,425,426,427,428,432,437,442,445,447,451,457,458,459,461,462,463,466,467,468,469,470,471,472,473],block_hash_person:236,block_on_clos:[340,471,472],block_siz:[236,238,468],blocked_domain:244,blocking_io:129,blockingioerror:[22,141,214,257,293,343,446,467,472],blocksiz:[225,243,293,359,471,472],blog:[387,461],blogbench:225,blondon:472,blow:[65,104,153,292,466,472],blowfish:[174,471,472],blown:[84,458],blowup:406,blue:[79,97,106,108,149,157,161,163,178,212,345,346,370,373,380,399,437,438,448,459,460,465,466,470,472],blueish:472,bluetooth:339,blum:472,blur:193,blurri:[93,472],bm_regex_compil:472,bmp:[66,248,250,370,467,468,471,472],bnf:[426,430,457],boa:91,board:[99,178,458,459],bob:[236,284,453,461,462,463,465,467],bobrov:472,bobsavag:453,boddi:[90,455],bodi:[62,65,84,90,91,93,95,110,113,124,137,144,170,184,190,196,197,198,200,201,202,206,208,209,227,241,243,246,249,254,271,272,288,319,334,336,337,346,363,382,385,386,387,392,399,404,410,423,425,426,432,437,445,460,461,462,466,467,468,469,470,471,472],body_enc:196,body_encod:196,body_line_iter:205,boehm:84,boer:86,bogildea:472,bogoychev:[470,472],bogu:[419,463,472],bohuslav:472,boilerpl:[79,82,95,289,363,386,428,469,472],bold:[97,152,178,222,370],boldfac:[97,462],bolen:[456,458],bolton:[463,466],bom:[58,62,109,146,261,375,472],bom_b:159,bom_l:159,bom_utf16:159,bom_utf16_b:159,bom_utf16_l:159,bom_utf32:159,bom_utf32_b:159,bom_utf32_l:159,bom_utf8:159,bomb:[406,472],bone:453,bonu:[386,457],bonz:467,bonzo:467,book:[85,99,105,106,152,156,161,184,271,321,342,363,369,370,441,450,466],bookkeep:[30,62,178,290],bookmark:460,bookstor:86,bool:[5,95,97,129,168,169,177,182,212,227,228,260,261,289,291,346,349,378,385,407,416,424,436,446,459,462,471,472],boolean_st:168,booleanvar:[370,472],boolop:124,boom:[332,386,387],boon:95,boost:[51,85,228,460,472],bootstrap:[62,112,191,253,320,335,396,472],boquien:472,border:[97,178,370,373,391],bore:[256,437,463],borland:[71,83,92,458,472],borlandccompil:65,born:[104,346],borrow:[3,5,11,21,22,25,28,30,31,34,40,41,48,49,54,55,61,79,84,99,213,437,458,459,460,472],borzenkov:462,bosamiya:472,bosch:456,boss:342,boswel:467,botfram:145,both:[5,7,14,17,22,23,30,31,41,45,50,57,58,64,65,66,72,74,78,79,80,81,82,83,84,87,90,91,93,94,95,96,97,98,99,101,102,103,104,105,106,107,108,109,111,112,114,122,129,134,135,138,140,141,143,144,152,153,156,159,160,161,162,167,168,170,176,177,178,182,184,187,189,192,193,195,196,197,201,202,203,204,206,207,208,211,212,216,217,220,221,223,227,228,232,234,236,238,239,244,245,246,248,251,252,254,257,258,265,266,269,275,279,282,283,284,287,289,292,293,294,295,296,297,298,299,301,304,305,306,307,310,311,320,321,322,324,326,330,331,333,334,335,336,337,339,340,342,343,346,347,349,350,355,356,362,363,365,367,368,370,373,375,376,380,382,385,386,387,391,392,397,399,402,404,408,410,414,416,418,422,423,424,425,426,428,431,432,436,437,438,440,442,445,446,447,448,451,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],bother:[91,97,104,105,109,284,457,458],bottl:[177,462],bottleneck:[186,228,465],bottom:[74,79,84,90,95,99,177,178,180,190,257,266,293,299,343,370,373,380,386,387,424,431,435,455,456,458,459,472],bottom_panel:180,bottommost:436,bounc:[271,456],bound:[7,12,34,38,40,49,51,55,58,84,87,91,93,98,103,104,106,107,126,127,128,129,131,132,139,141,159,161,165,170,189,190,212,214,227,228,249,251,252,254,267,268,284,320,321,332,339,343,346,354,363,366,368,370,372,373,381,382,386,387,392,399,417,422,423,424,425,426,428,432,436,439,445,446,456,458,459,461,462,463,467,468,471,472],boundargu:[254,467,469,472],boundari:[30,106,149,155,184,193,197,200,206,207,214,284,301,321,346,349,363,382,431,437,462],boundaryerror:200,boundedsemaphor:[62,127,284,366,467,472],boundless:424,bourn:[86,303],box:[1,86,95,97,104,178,248,271,370,372,373,426,470,471,472],boxcar:416,bpbynumb:145,bpformat:145,bpl:85,bplist:145,bpnumber:299,bpo:[16,96,184,228,268,284,293,355,461,462,463,465,466,467,468,469,470,471,472],bpopular:[189,468],bpprint:145,bpython:443,brace:[30,84,93,95,282,346,347,395,426,431,438,448,470,471,472],braceidpattern:[347,472],bracemessag:104,bracket:[5,30,84,93,99,104,106,109,145,210,221,227,233,241,271,299,346,384,391,407,410,424,426,430,431,432,435,436,437,438,442,445,461,462,463,472],brad:472,brai:[471,472],brain:[107,460],bram:[431,458],branch:[62,140,156,190,269,305,321,363,372,376,436,456,461,462,472],brand:[9,50,55,79,307,472],brandl:[109,461,462,463,465,466,467,469,470,472],brandt:472,brave:438,brazil:472,breach:422,breadth:[346,380,448],breadth_first_search:448,break_anywher:145,break_her:145,break_long_word:365,break_loop:190,break_on_hyphen:365,break_stmt:[427,432],breakag:[431,456,457,459,471,472],breakdown:[186,187],breaker:237,breakout:178,breakpoint:[62,85,125,145,149,186,227,248,299,355,451,461,466,472],breakpointhook:[227,355,451,471,472],brecht:[468,469,470,472],brees:472,bremmer:458,brendan:472,brent:370,brethren:104,brett:[105,310,459,460,461,462,463,465,467,468,469,470,471],breviti:[31,81,292,437],brew:106,brian:[430,456,459,460,462,463,466,467,468,471,472],brian_1979:[359,419],bridg:[87,126,131,466],brief:[62,86,110,111,122,193,206,227,228,267,292,304,310,321,324,350,376,422,438,441,456,458,460,461,464,466],briefli:[83,109,187,461],brigg:458,bright:97,bright_side_of_death:377,bring:[161,184,248,260,347,372,386,468,469],british:97,brittl:105,brk:360,broad:[99,130,292,391,458,461,467],broadcast:[129,258,339,472],broadcast_address:258,broadcast_messag:382,broader:468,broadli:[184,463],broccoli:342,broke:472,broken:[30,69,74,104,107,109,113,130,167,189,208,213,222,233,254,265,284,293,294,298,307,334,343,346,355,365,366,385,386,387,391,431,451,461,465,467,468,472],brokenbarriererror:[366,466],brokenexecutor:167,brokenpipeerror:[22,138,214,334,446,467,472],brokenprocesspool:167,brokenthreadpool:167,bronson:472,brought:[94,107,227,301,459,472],brouwer:462,brown:[380,462,472],brows:[97,110,256,315,373,437,449,450,462,472],browser:[62,91,99,107,109,110,125,153,154,189,222,245,246,248,253,255,263,272,310,315,391,392,436,448,449,456,457,459,460,461,462,466,467,470,471,472],browsercontrol:456,broytman:472,broytmann:461,bruce:424,brun:459,bruno:[468,469,472],brute:[236,328],bruynoogh:462,bryan:472,bryant:468,bryce:472,bsd:[90,97,107,135,178,216,324,329,334,339,344,367,422,434,456,458,462,468,472],bsdcam:225,bsddb185:459,bsddb3:[459,464],bsddb:[331,459,462,463],bsddbshelf:331,bstate:178,btn:[373,380],btoa:144,btopen:331,btproto_hci:339,btproto_l2cap:339,btproto_rfcomm:339,btproto_sco:339,bubbl:472,bucher:472,bucket:424,bucklei:472,bud:[197,206,404],buddi:436,buf1:38,buf2:38,buf3:38,buf:[5,7,38,129,216,236,343,346,359,461],buf_len:460,buff:241,buffer:[2,8,9,17,23,29,30,37,38,39,46,58,59,60,62,65,66,81,93,95,97,103,107,113,120,122,123,125,129,130,132,137,138,141,147,151,153,158,159,177,178,213,214,215,216,222,227,235,236,241,243,246,268,269,274,279,283,284,293,295,298,316,324,329,332,333,334,339,342,343,346,349,350,355,359,360,361,363,364,366,385,392,404,405,410,411,421,436,451,458,459,460,461,463,464,466,468,469,470,471,472,473],buffer_info:123,buffer_len:44,buffer_length:5,buffer_s:[141,257,316,462],buffer_text:[316,459],buffer_upd:[132,135],buffer_us:316,bufferediobas:[151,227,235,243,246,257,269,340,370,404,462,463,466,467,469,470,472],bufferedprotocol:[135,471,472],bufferedrandom:[227,257,462],bufferedread:[227,257,359,462,463,466,472],bufferedrwpair:[257,462,472],bufferedwrit:[227,257,462,466,472],buffererror:[22,214,446,472],bufferingformatt:103,bufferinghandl:[268,363],buffertooshort:284,buffertyp:39,buflen:[58,339],bufsiz:[38,79,122,129,219,295,305,339,350,359,408,409,421,460,472],bug:[0,31,38,54,62,74,78,79,84,85,90,92,94,99,104,105,109,128,153,209,227,243,244,271,293,298,301,305,310,311,343,363,366,369,386,404,423,436,440,449,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],bugfix:[86,94,105,406,456,457,458,459,461,462,463,465,466,467,468,469,470,471,472],buggi:[97,107,456,458,467,468,472],bugtrack_url:309,bui:[87,342,343,461],build:[9,29,30,38,41,53,58,59,62,64,66,67,68,69,71,72,74,75,80,81,82,84,85,87,90,91,92,93,95,98,101,104,107,108,110,112,123,125,141,143,149,157,158,159,161,177,185,187,189,190,191,204,207,209,227,236,237,246,253,256,257,260,273,275,283,292,297,298,305,309,313,316,320,329,335,339,340,342,343,346,355,356,363,370,378,385,387,391,392,396,397,406,407,421,422,424,438,447,451,452,453,455,456,458,473],build_can_fram:339,build_clib:71,build_const_key_map:[190,470,472],build_ext:[68,71,74,111,469,472],build_list:190,build_list_unpack:190,build_map:[190,472],build_map_unpack:190,build_map_unpack_with_cal:[190,470,472],build_open:[110,244,392],build_pgo:472,build_pi:[68,70,71],build_py_2to3:65,build_requir:66,build_script:71,build_set:190,build_set_unpack:190,build_slic:190,build_ssl:472,build_str:[190,470,472],build_temp:65,build_tupl:190,build_tuple_unpack:190,build_tuple_unpack_with_cal:[190,470,472],buildbot:[363,385,472],buildcmd:70,builddat:305,builder:[70,91,111,396,407,408,410],buildno:305,buildout:[168,466],buildrequir:66,buildscript:466,buildtool:462,built:[7,15,20,22,23,28,30,31,33,43,45,52,53,56,57,62,64,65,68,71,72,74,77,79,80,81,82,83,84,85,86,90,91,93,95,98,101,103,104,105,108,109,110,111,112,113,114,117,118,122,123,124,127,134,146,153,156,159,160,161,162,164,179,182,183,187,189,190,196,200,203,207,220,229,232,237,248,251,252,253,254,256,257,260,265,275,276,284,289,292,293,294,296,297,298,299,301,304,313,315,317,322,323,329,330,336,339,342,343,347,349,350,355,356,363,364,370,373,380,385,386,397,399,402,407,408,410,412,416,420,422,423,424,425,426,428,429,430,431,432,433,435,436,437,438,439,440,442,445,446,447,448,451,453,455,457,458,459,461,462,463,464,465,466,467,468,469,470,472,473],builtin:[30,31,48,62,91,93,95,98,108,124,130,159,161,188,190,227,232,245,248,251,252,253,254,257,258,260,267,301,310,317,325,335,355,381,382,387,426,428,431,433,436,446,462,465,466,468,469,470,471,473],builtin_function_or_method:472,builtin_module_nam:[90,252,355,446],builtin_open:227,builtinfunctiontyp:381,builtinimport:[252,470],builtinmethodtyp:381,builtout:465,bulgarian:159,bulk:[79,111,187,256,468],bull:472,bullet:[178,222],bump:[468,472],bumsik:472,bunch:[65,74,104,201,208,292,435,456,457,458,459,462,472],bundl:[62,66,91,112,170,202,208,211,225,249,307,343,369,392,418,436,452,453,459,463,466,468,469,471,472],bundlebuild:[462,472],bupjo:466,burden:[79,463,464,467,469],bureaucraci:65,burger:321,burgess:472,bus:402,busi:[30,74,91,107,138,213,268,340,350,370,403,412,422,437],businesscategori:343,bussonni:[471,472],butter:342,button:[92,97,153,178,248,282,370,372,373,380,422,455,470,471,472],button_alt:178,button_ctrl:178,button_shift:178,buttonbox:372,buttonn_click:178,buttonn_double_click:178,buttonn_press:178,buttonn_releas:178,buttonn_triple_click:178,buyst:472,bword:106,by_handle_file_inform:[293,469],bye:[157,171,249,288,380,467],byelorussian:159,bypass:[159,227,228,293,347,386,424,428,472],byref:[177,462],byrn:472,byte_compil:65,byte_length:346,byte_stream:466,bytearrai:[5,7,8,30,58,62,84,91,93,95,135,146,147,214,216,227,236,238,253,257,261,274,279,301,320,339,343,349,382,391,397,416,421,424,426,446,451,462,463,464,465,466,467,468,470,471,472],bytearray_getbuff:472,bytebong:168,bytecod:[12,28,30,31,60,62,65,66,90,91,92,93,99,101,106,164,227,251,252,253,254,263,297,302,313,326,334,354,355,378,424,451,455,456,457,458,459,460,461,462,463,465,466,467,468,469,472],bytecode_suffix:252,bytedesign:380,bytefil:413,byteord:[58,346,349,355,446],bytereef:467,bytes_l:395,bytes_object:301,bytes_recd:107,bytes_warn:[355,466],bytesarrai:306,bytesescapeseq:431,bytesfeedpars:[208,466],bytesgener:[197,198,202,206,209,337,466],bytesheaderpars:[208,467],bytesio:[93,197,208,235,257,271,301,346,361,375,418,462,464,466,469,472],bytesiobuf_getbuff:472,bytesliter:426,bytesobject:[96,472],bytespars:[201,202,208,466,472],bytesprefix:431,bytestr:[97,147,162,293,339,342,346,382,404,410,421,462,472],bytestream:109,byteswap:[123,143,468],byteswarn:[22,214,397,446,471,472],bz2:[62,65,66,75,121,159,177,219,253,269,298,333,359,363,419,447,459,463,465,468,472],bz2_codec:[159,468],bz2_encod:468,bz2compressor:151,bz2decompressor:[151,469,472],bz2file:[151,269,463,465,467,468,472],bzip2:[62,65,75,121,219,253,333,359,419,466,467],bzip:[66,466],bzr:75,bztar:[65,66,75,333,466],c0a80001:347,c11:[467,472],c89:[184,462],c99:[82,177,275,346,349,355,440,462,466,470],c__builtin__:465,c_api_object:79,c_basenam:95,c_bool:[177,462],c_buffer:177,c_builtin:251,c_byte:177,c_byte_array_4:177,c_call:[145,355],c_char:[177,284],c_char_p:[177,461],c_contigu:346,c_default:95,c_doubl:[177,284,461],c_except:[145,355],c_extens:251,c_float:[177,461],c_ignored_default:95,c_int16:177,c_int32:177,c_int64:177,c_int8:177,c_int:[177,284,461],c_long:[177,346],c_long_array_10:177,c_longdoubl:177,c_longlong:177,c_return:[145,355],c_s:177,c_short:[177,284],c_size_t:177,c_ssize_t:[177,466],c_string:177,c_ubyt:177,c_uint16:177,c_uint32:177,c_uint64:177,c_uint8:177,c_uint:177,c_ulong:177,c_ulonglong:177,c_ushort:177,c_void_p:177,c_warn:363,c_wchar:177,c_wchar_p:177,ca_cert:343,caaat:106,cab:[62,401,461],cabinet:[282,472],cabl:185,cabnam:282,cabundl:343,cacert:343,cach:[28,38,56,57,58,62,79,81,90,91,93,103,106,110,118,159,161,164,177,185,189,217,228,232,251,252,264,266,284,288,293,304,313,321,326,331,342,343,349,355,361,363,378,382,385,392,399,446,448,449,451,455,457,459,461,462,463,466,467,468,469,470,471,472],cache_clear:[228,466],cache_from_sourc:[251,252,466,468,469,470],cache_info:[228,466],cache_tag:[28,251,252,355,467],cached_stat:342,cacheftphandl:[62,255],cacheinfo:[228,466],cad:347,cadata:[343,468],cadefault:392,caesar:159,cafe:466,cafil:[343,392,463,468],caissuer:343,cake:107,cal:[113,152,392,393],calc_item:459,calcobjs:363,calcsiz:[7,227,339,346,349,363],calcul:[9,28,30,31,54,57,58,62,79,86,91,92,94,95,98,99,122,128,152,161,178,182,184,187,207,228,236,252,268,275,284,295,324,334,339,345,346,347,349,354,357,367,368,375,380,381,387,392,398,424,426,428,431,435,438,440,441,446,447,448,458,461,462,465,468,472],calculate_someth:187,calculatestar:284,calcvobjs:363,caldera:472,calderon:[463,467],calendar:[62,183,184,253,367,447,456,459,470,472],calendr:[152,184],calibr:[62,186],california:[343,422],calissu:468,call:[3,5,7,9,10,12,13,14,16,17,21,22,23,24,26,27,28,30,31,33,35,36,38,40,41,43,44,45,47,49,51,52,53,54,55,56,57,58,60,61,62,64,65,66,69,72,74,75,77,78,80,81,82,83,87,90,92,93,94,96,97,98,101,102,103,104,106,107,108,109,110,111,113,117,118,119,120,122,123,124,125,128,129,131,132,134,135,136,137,138,139,140,141,142,143,145,149,151,153,155,157,158,159,161,162,164,167,168,169,170,171,172,173,174,176,178,180,182,184,185,187,188,189,190,193,196,197,198,199,200,202,203,204,206,207,208,209,210,212,213,214,215,217,219,222,225,227,228,229,231,232,235,236,237,238,241,243,244,245,246,248,249,250,251,252,253,254,257,258,260,261,264,265,266,267,268,269,271,274,275,276,279,282,283,284,288,289,291,293,294,295,297,298,299,301,304,306,307,309,310,311,312,316,318,320,321,322,323,324,325,327,329,330,331,332,333,334,335,337,339,340,342,343,344,345,346,347,349,350,351,352,355,356,357,358,359,360,361,362,363,365,366,367,368,370,372,373,375,376,377,378,380,381,382,384,385,388,391,392,394,395,396,397,398,399,400,402,403,404,405,407,408,409,410,411,412,413,415,416,417,418,419,421,423,424,425,428,431,432,435,436,437,438,439,442,444,445,446,447,448,449,450,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,470,471,472],call_arg:[386,387,472],call_args_list:[386,387],call_at:[128,129,132,471],call_count:[386,387],call_exception_handl:[129,132],call_funct:[190,470,472],call_function_ex:[190,470,472],call_function_kw:[190,470],call_function_var:470,call_function_var_kw:470,call_lat:[62,132,471],call_list:[386,387],call_method:[190,471,472],call_profil:472,call_soon:[62,128,131,132,135,137,471,472],call_soon_threadsaf:[128,129,132,471],call_stack:101,call_trac:[355,446],call_tzinfo_method:472,callabl:[30,33,40,45,53,57,61,62,78,79,91,93,97,99,104,113,118,122,129,134,137,139,162,167,168,171,173,177,178,182,188,189,190,207,208,209,212,225,226,227,249,252,253,257,266,267,268,271,284,291,292,293,300,301,315,316,317,327,333,334,337,350,355,361,366,368,373,375,385,386,387,392,396,397,399,404,410,418,423,426,428,441,446,451,457,458,459,460,461,462,463,464,466,467,468,469,471,472],callable_iter:106,callableproxytyp:399,callback:[5,10,13,26,30,57,61,62,79,87,93,120,122,126,128,131,132,134,135,137,140,170,225,229,254,282,284,310,311,316,318,322,330,333,342,343,344,352,360,368,370,373,381,382,399,409,410,412,418,448,461,462,466,467,468,470,471,472,473],callback_:122,callback_arg:292,callback_kwarg:292,callbyref:91,calle:[91,376,437],calledprocess:472,calledprocesserror:[350,463,469,472],caller:[5,9,17,22,28,30,31,32,41,56,58,79,91,93,98,99,140,145,158,159,170,177,190,225,227,243,251,254,257,266,291,293,297,310,334,337,339,342,343,355,366,373,376,377,385,392,394,397,398,400,402,416,418,424,425,426,436,437,439,457,458,459,460,461,462,463,470,472],calloc:[38,469,472],callsomefunct:30,callstat:[446,471,472],calltip:[62,369,472],calltip_w:472,calltipwindow:472,calmett:467,caltech:422,calvin:342,cambridgeincolour:163,came:[89,95,99,103,105,193,203,252,284,434,439,457,458,459,460,461],camel:[462,466],camelcas:366,camelot:465,cameron:90,cammin:461,campbel:472,can0:339,can:[1,4,5,7,10,12,13,15,17,22,23,25,26,28,30,31,33,35,37,38,39,41,43,44,45,47,49,50,52,53,54,55,57,58,60,61,62,64,65,66,68,69,70,72,73,74,75,76,77,78,79,80,81,82,83,93,94,95,96,97,98,99,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115,117,118,119,122,123,124,125,127,128,129,130,131,132,133,134,135,136,137,138,139,140,141,142,143,144,145,147,148,149,150,151,152,153,154,155,156,158,159,160,161,162,163,164,167,168,169,170,171,172,173,174,176,177,178,179,180,182,184,185,187,188,189,190,191,192,193,195,196,197,200,201,202,203,204,206,207,208,209,210,211,212,213,214,215,216,219,221,222,223,225,227,228,229,230,232,233,235,236,237,238,241,243,244,245,246,248,249,250,251,254,256,257,258,259,260,261,265,266,267,268,269,270,271,272,274,275,276,279,280,281,282,283,284,288,289,291,292,293,294,295,297,298,299,300,302,303,304,306,307,309,310,311,313,314,315,316,318,320,321,322,323,324,325,327,328,329,330,331,332,333,334,335,336,337,339,340,342,343,344,345,346,347,348,349,350,351,354,355,356,357,359,360,361,362,363,365,366,367,368,370,372,373,375,376,377,378,380,381,382,384,385,386,387,390,391,392,393,394,395,396,397,398,399,400,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,419,420,421,422,423,424,425,426,428,430,431,432,433,434,435,436,437,438,439,440,441,442,443,444,445,446,447,448,449,450,451,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],can_:339,can_bcm:[339,468],can_bcm_:339,can_change_color:[97,178],can_dlc:339,can_fetch:[393,472],can_fram:339,can_frame_fmt:339,can_frame_s:339,can_id:339,can_isotp:339,can_raw:339,can_raw_fd_fram:[339,469,472],can_symlink:363,can_values_be_as_wel:168,can_write_eof:[132,135,137],can_xattr:363,canadian:[97,159],cancel:[31,62,66,127,128,129,130,131,136,143,153,167,170,178,179,215,282,316,327,334,366,372,373,380,423,434,466,471,472],cancel_dump_traceback_lat:215,cancel_join_thread:284,cancel_m:140,cancellederror:[127,130,131,140,167],cancelsynchronousio:472,candid:[4,62,86,98,114,206,232,355,424,461,462,463,468,473],canin:436,caniusepython3:105,cannon:[105,459,460,461,462,463,465,467,468,469,470,471],cannot:[7,9,30,31,34,35,45,49,57,58,60,61,66,74,78,79,82,84,91,93,94,95,97,99,102,103,104,105,108,110,113,117,118,131,133,140,153,159,161,167,168,169,170,177,178,182,184,187,193,198,202,203,204,209,212,213,214,215,216,219,225,227,229,232,234,237,246,248,252,254,257,265,266,267,268,269,271,274,275,276,279,283,284,293,294,295,297,298,299,301,304,305,306,309,310,312,316,321,324,329,330,331,332,333,336,338,339,340,341,342,343,346,347,350,355,359,361,363,366,367,370,382,392,396,399,402,403,407,410,412,413,416,418,419,421,422,423,424,425,426,428,431,432,436,437,438,439,440,442,445,448,451,455,458,459,461,462,463,464,465,466,467,468,470,471,472],cannotsendhead:243,cannotsendrequest:243,canon:[58,65,91,93,145,168,184,187,196,236,238,292,294,298,339,348,384,426,463,469,472],canonnam:339,canopi:455,canva:[380,462,472],canvas:380,canvasheight:380,canvaswidth:380,canvheight:380,canvwidth:380,cap:[272,472],cap_sys_resourc:324,capa:[307,468],capabl:[58,66,82,93,97,99,104,106,110,111,112,124,129,133,141,161,170,178,187,193,237,249,254,257,258,272,283,284,288,292,307,308,309,322,342,372,387,391,410,412,419,426,447,451,455,458,459,460,461,466,467,468,469],capac:[104,178,268,293,366,461,463],capath:[343,392,468],capi:463,capit:[106,109,111,187,321,346,347,384,426,436,437,456,471,472],capnam:178,capsul:[15,62,79,99,464],capsulethunk:96,captain:[291,470],caption:177,captur:[62,97,99,170,184,193,264,266,293,320,321,343,347,350,355,358,363,377,397,460,467,468,469,471,472],capture_loc:377,capture_output:[350,471,472],captured_stderr:363,captured_stdin:363,captured_stdout:363,capturestderr:350,capturewarn:[266,397],capword:347,car:91,carbon:[462,466],card:[233,295,320,321,432],cardin:346,care:[30,31,57,60,62,65,72,74,75,79,81,82,90,91,95,98,103,104,105,106,109,110,116,122,124,140,145,161,170,177,184,187,193,194,197,209,212,222,227,229,232,252,255,257,266,267,271,284,289,292,301,310,316,334,336,350,355,359,385,386,387,397,405,408,410,418,426,436,442,444,455,456,460,461,462,463,464,466,468,472],carefulli:[15,22,47,60,82,91,153,182,301,310,321,331,424,451,460,461,462,463,468],carel:[458,472],caret:[106,178,179,193,321,377,472],carl:[462,463,466,467],carlson:[462,467],carmen:161,carneiro:460,carri:[65,97,103,159,185,187,190,264,266,275,284,292,297,320,346,385,406,407,425,431,432,438,461,462,463,469,472],carriag:[106,148,179,208,209,257,321,332,346,365,404,416,431,459,461],carrol:472,cartesian:[84,156,260,462,465,469],cascad:[152,472],casefold:[109,144,161,346,467,469,472],caseless:[109,346,467],cashflow:260,cast:[7,30,31,38,41,53,56,58,79,82,84,95,177,187,260,346,377,382,467,471,472],casual:440,cat:[91,104,106,161,212,232,287,350,437,447,449,466,469],catalin:467,catalog:[62,74,247,456,457,459,472],catalogu:457,catastroph:[215,466,472],catch_warn:[363,397,462,472],catchbreak:385,categor:[292,321,397,426],categori:[29,62,65,72,74,90,93,103,106,109,135,214,257,265,268,291,317,321,346,363,384,391,431,451,456,457,461,462,464,466,471,472],cater:[104,193,267,268],cathedr:422,cathi:471,catstr:363,catucci:[466,468],cauet:[469,472],caught:[22,117,130,154,158,214,293,304,307,325,333,339,342,355,363,367,370,385,386,411,420,424,457,462,464,468,472],caus:[5,9,15,17,22,30,31,38,43,47,57,58,60,70,74,79,81,82,83,84,87,91,92,95,99,103,104,106,110,113,117,122,124,125,129,135,140,145,153,154,157,159,160,161,164,168,170,172,176,177,178,185,187,189,190,193,206,209,210,213,214,227,229,230,241,243,246,248,249,252,254,257,261,265,266,268,271,275,276,283,284,293,297,299,301,304,305,309,310,315,316,321,329,331,334,335,339,342,343,346,347,355,357,361,363,365,366,368,373,375,385,386,387,390,392,397,399,402,404,407,412,416,419,422,423,424,425,426,428,432,434,436,437,439,442,444,446,448,451,455,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],causal:472,caution:[79,91,292,293,350,399,410,439,461],cautionari:460,cautiou:[122,271],caveat:[62,117,139,191,247,251,252,254,310,313,386,424,432,454],caviti:373,cazabon:463,cb_type:343,cba:321,cbc:[168,339],cbreak:[97,178,379],cbresult:81,cbs:346,cbuiltin:[301,465],cc0:236,cc4a5ce1b3df48aec5d22d1f16b894a0b894eccc:236,cc754250:455,cc755104:455,ccbench:463,ccc:[225,373,467],ccitt:[147,351],ccompil:[71,418],cconvert:95,ccp:461,ccs:210,cdata:[316,407,413],cdata_section_nod:407,cdatasect:[62,273],cddb:462,cdecl:177,cdefg:291,cdf246:462,cdio:[470,472],cdll:[177,461,472],cdplayer:462,cdr:91,cdrom:[470,472],cdt:184,ce46195b56a9:468,cea:[462,463,467,470,471],cedilla:[384,426],ceil:[223,275,289,324,346,424,462],cela:201,celebr:275,celementtre:[410,461,466,467],celeri:342,cell:[15,25,60,62,91,97,98,120,177,190,228,237,253,254,373,424,462,472],cell_cont:424,cellvar:[12,472],celtic:159,cent:448,center:[152,157,178,187,222,248,249,254,346,347,370,373,380,422,442,460,462,467],centimetr:370,cento:[225,466,471],centr:74,central:[62,159,184,195,206,227,287,290,456,457,458,459,461,466,472],centrum:[30,63,422],centuri:[152,184,367,466,472],cepl:[469,472],cern:392,cert:[343,463,468,472],cert_:343,cert_byt:343,cert_fil:[243,392,472],cert_non:[343,472],cert_opt:[343,472],cert_req:343,cert_requir:[343,472],cert_store_stat:[343,468],cert_tim:343,cert_time_to_second:[343,469,472],certain:[7,15,22,37,38,45,57,60,65,68,79,83,84,86,93,97,99,103,104,106,107,122,123,135,141,145,159,184,189,193,196,197,200,204,206,207,209,210,212,214,248,254,265,266,267,268,269,271,284,292,293,295,299,308,309,310,339,343,348,350,359,366,367,368,370,384,385,386,391,404,407,416,418,424,426,428,431,437,438,446,454,455,456,457,458,459,460,462,463,465,467,468,471,472],certainli:[84,91,97,106,107,177,272,284,456,457,458,459,463],certainti:[79,402],certchain:343,certfil:[225,249,307,337,343,456,470,472],certif:[62,129,135,225,243,249,268,307,337,363,392,416,462,471,472],certifi:472,certificate_verify_fail:343,certificateerror:343,certificaterequest:343,cervant:472,cf68fb5761b9c44e7878bfb2c4c9aea52264a80b75005e65619778de59f383a3:236,cf9:90,cf_flag:60,cffi:[79,80,187],cfg:[66,68,74,75,91,111,168,267,335,380,396,455,462,467,469,470,472],cfgparser:168,cfile:[91,313],cflag:[78,111,308,362,459,472],cflags_nodist:472,cfmfile:462,cfoo:230,cftuvsux:94,cfuhash:62,cfunctyp:177,cfutur:472,cget:373,cgi:[62,86,110,246,253,255,329,392,393,404,417,447,450,456,462,466,468,470,472],cgi_data:125,cgi_directori:246,cgihandl:404,cgihttprequesthandl:246,cgihttpserv:[464,472],cgirequesthandl:472,cgitb:[62,153,253,255,472],cgixmlrpcrequesthandl:[62,255,460],chacha20:[343,470,472],chacha:236,chad:[109,459,461,462,472],chain:[7,57,62,98,99,104,110,121,158,161,168,177,188,214,215,225,227,237,249,254,260,266,307,337,346,355,377,386,392,424,426,432,436,438,462,464,467,468,469,472],chainmap:[62,183,382,467,468,471,472],challeng:[237,284,337,448,466,471],chambon:463,chanc:[5,31,54,81,103,104,105,107,140,142,184,289,336,366,436,437,461,472],chandra:[471,472],chang:[5,9,12,16,21,22,23,28,30,31,35,36,38,41,45,49,50,51,52,54,56,57,58,60,62,65,66,68,69,72,74,75,78,79,81,82,83,84,85,92,93,94,97,98,99,101,104,105,106,109,110,111,112,113,114,117,118,119,122,123,124,129,131,134,135,137,140,141,142,143,144,147,151,152,153,157,158,159,161,162,164,167,168,170,171,172,174,176,177,178,180,182,184,185,187,189,190,193,195,197,198,202,203,206,207,208,209,210,212,213,214,215,216,217,219,222,223,224,225,227,228,229,233,235,236,237,238,241,242,243,244,245,246,247,248,249,250,251,252,254,257,258,260,261,264,265,266,267,268,269,271,274,276,279,282,283,284,286,288,293,294,295,298,299,301,304,305,306,307,308,309,310,311,313,315,316,320,321,322,323,324,326,327,328,329,330,331,332,333,334,335,336,337,338,339,340,341,342,343,344,345,346,347,348,349,350,351,353,355,357,358,359,360,361,362,363,365,366,367,368,370,372,373,374,375,377,378,379,381,382,384,385,386,387,390,391,392,394,395,396,397,398,399,400,402,404,407,408,409,410,411,413,416,417,418,419,420,421,422,423,424,425,426,428,430,431,432,434,435,436,437,438,442,445,446,447,449,451,453,455,472,473],change_cwd:363,change_loc:466,change_root:65,changeabl:91,changelist:329,changelog:[62,309,463,467,468,469,470,471,473],changes_class_v4:472,changeset:[466,468,472],changestest:472,channel:[109,119,125,135,141,143,177,202,213,225,267,284,295,336,338,339,343,351,398,458,467,472],channel_binding_typ:343,channel_class:336,chao:380,chaotic:260,chapman:[90,460],chappel:469,chapter:[2,15,22,31,38,46,59,60,69,72,78,79,81,82,83,84,90,99,120,121,146,165,175,181,183,188,218,220,224,226,247,248,255,256,259,277,278,281,285,290,300,317,352,355,364,368,370,383,388,401,426,430,431,433,435,438,439,442,472],chaput:[469,472],char_data:316,char_gener:342,char_max:265,charact:[5,9,13,15,17,30,31,35,44,45,54,62,65,67,68,74,79,84,90,91,92,93,95,97,104,107,109,112,120,122,123,125,129,133,138,144,146,147,152,153,157,159,168,174,176,177,184,185,187,189,193,195,197,198,199,200,201,202,203,204,206,207,209,210,214,215,221,222,225,227,230,233,236,239,240,241,245,248,249,252,253,257,264,265,267,271,283,284,285,286,288,293,294,298,301,309,316,319,321,322,323,325,328,332,333,337,339,340,342,343,344,346,347,348,350,355,359,360,361,362,363,365,367,370,372,373,384,385,391,395,402,405,407,408,409,410,411,412,413,414,416,417,418,419,426,430,431,432,434,437,438,442,444,445,448,451,455,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],character:93,characterdatahandl:316,characterist:[7,91,301,348,355,461,462],characters_written:214,charat:472,charfil:413,charg:[110,252,422,448],charjunk:189,charl:[456,463,467,468,469,470,471,472],charmap:159,charref:106,charset:[62,184,189,195,197,198,203,206,207,209,210,232,249,285,343,392,404,466,469,472],chart:[98,109,446],chartreus:212,chassi:466,chat:107,chaudhari:468,chcp:[467,472],chdir:[65,293,333,447,466,467,472],che:461,cheap:[68,84,91,177,436,472],cheaper:[377,471],cheat:105,cheatsheet:466,check:[5,7,9,11,15,16,19,20,22,24,28,30,31,32,34,38,39,40,45,49,50,53,54,55,56,57,58,61,62,64,66,71,78,79,81,82,84,86,87,90,94,95,96,97,99,101,103,106,107,109,111,115,118,122,128,129,131,140,144,145,151,153,157,161,162,164,168,170,177,178,179,182,184,187,188,190,198,201,206,209,212,214,215,216,225,227,228,231,234,241,243,244,246,248,249,253,254,258,261,264,266,267,268,269,272,275,281,284,286,287,288,289,293,294,295,297,298,304,305,307,322,324,329,332,333,334,335,337,339,342,343,344,345,346,347,349,350,352,355,358,363,364,366,372,373,375,378,381,382,385,386,388,392,393,397,399,404,410,413,416,419,421,426,428,432,435,436,438,443,444,446,450,451,454,455,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],check__all__:[363,472],check_cal:350,check_choic:292,check_circular:261,check_complex:292,check_crc32:269,check_crc64:269,check_environ:[65,472],check_free_after_iter:363,check_hostnam:[225,243,249,288,307,337,343,392,470,472],check_impl_detail:363,check_interrupted_writ:472,check_moon:292,check_mytyp:292,check_no_resource_warn:[363,472],check_non:269,check_ord:292,check_output:[193,350,463,468],check_resource_ok:170,check_returncod:350,check_same_thread:342,check_sha256:269,check_syntax_error:363,check_unknown:269,check_unused_arg:347,check_warn:[363,462],checkbox:[97,153,282,455],checkbutton:[372,373],checkcach:264,checked_hash:313,checker:[62,91,105,122,178,193,255,292,382,460,461,469,470],checkfuncnam:145,checkin:456,checklist:372,checkout:[95,122,455,463,472],checkpoint:[249,355],checksizeof:363,checksum:[95,147,359,421],chees:[342,437,450],cheeseshop:437,chem:455,chen:472,chenet:[463,466],chermsid:459,cherniavski:460,cherri:472,cheryl:[470,471,472],chess:[99,109,458,459],chessboard:[99,458,459],chestnykh:[236,470],chflag:[293,333,344,462,467],chgat:[178,462],chi:[471,472],chief:[369,440],chiefli:84,child1:[316,386],child2:[316,386],child:[30,54,91,103,104,122,124,132,133,134,135,138,161,213,214,229,249,279,284,293,297,298,311,316,324,329,339,340,350,361,373,386,387,407,408,410,424,456,460,461,462,463,466,467,468,470,471,472],child_conn:284,child_error:472,child_nam:252,child_stderr:350,child_stdin:350,child_stdout:350,child_stdout_and_stderr:350,childless:463,childnod:[407,408,456],childprocesserror:[22,214,446,467],children:[91,103,124,134,237,266,284,293,314,316,324,363,370,373,385,386,387,407,408,409,410,456,463,471,472],children_system:293,children_us:293,chines:[159,460,472],chip:[107,245,463],chiu:472,chjvymzdqg1ligrlig1hdhjpy2u:288,chm:472,chmod:[90,104,153,293,298,333,344,434,454,467,472],cho:[470,472],chocol:212,choic:[7,62,65,79,84,90,91,92,94,104,105,107,110,120,153,156,165,193,227,232,248,254,260,266,267,271,284,292,310,316,320,326,328,330,331,343,345,346,349,372,430,442,444,447,453,454,458,461,466,469,470,471,472],choos:[62,65,79,81,84,90,94,95,99,104,105,106,107,109,111,122,159,193,206,212,228,252,256,266,292,295,301,310,320,342,343,349,355,366,370,372,386,395,410,428,440,453,455,458,459,463,466,467,468,471,472],chop:[167,284,294,456,460,464],chore:[95,456],choru:168,chose:[106,246,251,252,430,461],chosen:[41,79,93,95,98,103,106,111,167,187,212,225,227,236,256,267,284,292,301,320,328,339,343,349,355,361,372,395,412,424,447,451,455,459,460,464,472],chowdhuri:472,chown:[104,293,333,467,472],chowntest:104,chr:[91,109,227,241,316,342,384,424,446,461,463],chri:[459,461,462,467,469,470,472],christi:472,christian:[236,422,456,460,462,467,468,470,471,472],christien:468,christma:86,christo:466,christoph:[459,469,472],chrome:[400,467,472],chromium:[400,467],chronic:470,chronolog:[109,129,470],chroot:293,chrtype:359,chtype:472,chu:[462,465],chuck:472,chunk:[5,12,39,62,91,95,104,107,109,125,135,151,167,181,225,227,236,241,243,253,257,260,261,269,278,284,293,305,316,333,339,349,392,404,412,413,456,459,461,463,470,472],chunksiz:[151,167,284,305,469,472],churn:470,cid:[198,201,339],cipher:[62,135,168,174,236,463,466,467,469,470,471,472],circl:[157,212,275,380,462],circu:[187,227,435],circuit:[238,346,438],circular:[26,30,31,79,82,84,91,251,261,380,387,424,457,469,471,472],circumfer:275,circumflex:[109,374],circumflexequ:374,circumst:[22,38,84,97,103,104,153,168,212,222,244,266,269,292,293,324,333,345,392,396,400,424,432,436,439,446,460,468,472],circumv:406,cisco:[258,472],citat:355,cite:86,citi:[343,393,422],city_list:99,city_st:99,civil:184,cjk:[467,472],cjkcodec:460,claim:[31,79,105,189,200,256,343,349,422,472],claird:90,clamp:[187,466,467],clang:[468,470,472],clara:422,clarendon:156,clarif:[58,428,472],clarifi:[105,106,346,386,416,436,445,461,462,466,468,472],clariti:[84,95,107,123,291,292,361,367,423,466,472],clark:[422,467],clarkson:370,clash:[79,177,248,266,267,271,426,431,436,446,462,469,472],class1:[91,386,387,458],class2:[91,386,387,458],class_:232,class_definit:378,class_method:386,class_or_inst:182,classcommand:370,classdef:[124,423,427,472],classic:[43,91,99,128,168,185,204,232,271,304,380,387,445,458,459,461,463,464,466,472],classif:[62,265,290,292,431],classifi:[65,74,105,229,309,459,463,472],classify_class_attr:472,classinfo:227,classinst:299,classmethod:[53,93,98,118,140,161,162,177,184,187,190,193,204,212,227,228,252,254,260,284,298,346,359,377,378,385,419,424,446,458,460,463,466,467,470,471,472],classmethoddescr_cal:472,classmethoddescriptortyp:[381,471,472],classnam:[22,91,124,162,370,372,386,387,423,436],classname1:[386,387],classname2:[386,387],classroom:[380,472],classvar:[182,382,470,472],claud:[469,472],claudiu:[456,468,469,472],claus:[31,62,93,99,104,117,140,170,190,214,254,284,299,316,346,355,361,363,423,424,425,426,427,432,434,438,439,441,456,461,462,466,468,471,472],cld_continu:293,cld_dump:293,cld_exit:293,cld_trap:293,clean:[22,31,62,71,79,81,84,93,107,122,124,134,140,142,159,167,190,193,202,206,209,213,214,248,252,254,271,283,284,287,317,340,361,363,392,396,399,413,424,426,441,442,456,457,458,460,461,462,463,464,466,467,472],cleanbyt:[38,472],cleandoc:[124,254],cleaner:[93,105,456,465,467,469,472],cleanest:310,cleanfutur:458,cleanimport:363,cleanli:[96,101,106,336,343,472],cleans:65,cleantest:472,cleanup:[30,31,54,62,95,99,104,117,142,165,170,215,293,340,350,352,355,361,363,385,387,399,402,408,423,425,451,456,458,461,463,464,466,467,472],cleanup_need:170,cleanup_resourc:170,clear:[16,21,24,29,30,31,34,40,41,43,50,55,56,57,58,62,75,79,81,82,84,85,86,91,93,95,97,101,106,107,109,110,129,139,157,161,162,168,170,178,187,193,206,217,225,228,229,244,248,252,254,264,266,268,271,276,292,293,299,304,321,322,333,334,339,342,343,346,355,363,366,373,377,378,380,386,387,396,397,410,423,424,436,438,445,455,456,458,459,461,462,463,466,467,468,470,471,472],clear_all_break:145,clear_all_file_break:145,clear_bpbynumb:145,clear_break:145,clear_cach:[217,468],clear_cont:[198,206],clear_flag:187,clear_fram:[377,468],clear_glob:193,clear_histori:322,clear_session_cooki:244,clear_trac:378,clear_trap:187,clearcach:264,cleardata:282,clearer:[95,99,105,193,292,346,456,457,458,459,460,462,471,472],clearest:[91,459],clearli:[99,105,106,122,237,254,385,448,456,458,461,467,471],clearok:178,clearscreen:380,clearstamp:380,cleartext:[174,268],clees:[176,410,437],clegg:[471,472],clement:[410,470,472],clen:125,clerk:450,clever:[74,84,95,109,153,237,301,347,458],cleverli:237,cli:[363,418,451,468,471,472],click:[87,107,153,178,248,293,370,380,396,422,434,453,455,467,470,471,472],client:[55,62,79,90,98,103,104,107,110,125,127,129,132,145,153,159,165,168,171,195,197,242,245,246,253,255,257,258,266,268,286,293,301,329,330,336,339,340,342,366,380,392,404,407,414,417,422,436,437,447,458,460,462,467,472],client_addr:171,client_addr_var:171,client_address:[246,340,404],client_auth:[343,468],client_connect:129,client_connected_cb:137,client_context:343,client_thread:107,clienthello:343,clientip:266,clientmodul:79,clientsocket:107,cliff:[459,463],clinic:[62,100,470,472],clinton:463,clip:[43,51,95,178,432],clipboard:[248,296,470,471],clk_id:367,clobber:[65,244,292,472],clock:[62,91,120,129,133,184,310,324,380,462,467,469,470,471,472],clock_boottim:[367,471,472],clock_getr:[367,467],clock_gettim:[367,467,472],clock_gettime_n:[367,471,472],clock_highr:367,clock_monoton:[367,471],clock_monotonic_raw:367,clock_process_cputime_id:367,clock_prof:[367,471,472],clock_realtim:[367,472],clock_seq:395,clock_seq_hi_vari:395,clock_seq_low:395,clock_settim:[367,467],clock_settime_n:[367,471,472],clock_thread_cputime_id:367,clock_uptim:[367,471,472],clock_xxx:467,clockspe:225,clockwis:380,clone:[54,62,202,206,209,232,236,238,284,293,303,337,373,380,407,430,454,467],clonenod:[407,472],close:[30,60,65,74,82,84,85,91,92,93,95,99,103,104,107,109,119,125,127,129,132,134,135,137,140,141,148,153,155,156,157,158,159,162,168,170,171,178,185,189,200,208,209,214,215,219,222,225,227,235,241,243,244,248,249,251,257,266,268,269,271,275,279,282,284,288,292,293,295,298,303,310,316,322,329,330,331,332,334,336,337,339,340,342,343,345,346,350,351,359,360,361,363,366,367,372,373,375,386,387,392,396,398,402,404,410,413,414,416,417,418,419,424,426,431,437,439,440,442,448,456,460,461,462,463,465,466,467,468,469,470,471,472],close_connect:246,close_fd:[293,350,460,466,471,472],close_fil:170,close_when_don:[125,472],closeboundarynotfounddefect:200,closeconnect:385,closefd:[23,227,257,284,464,472],closeit:60,closekei:402,closelog:357,closer:[31,212,332,387,397,436,440,463,464,469,472],closerang:[293,462],closest:[187,223,227,275,346,440,462,463],closur:[25,53,60,82,170,171,190,252,254,292,346,424,467,470,472],closurevar:254,cloth:208,clr:110,clrtobot:178,clrtoeol:178,cls:[45,91,118,162,204,212,227,254,261,298,301,363,378,385,424,439,458,460,466,470,471,472],cls_name:182,clue:292,clumsi:[84,93,467],clumsier:[457,458],cluster:[189,227,339,345,451,462],clutter:[91,104,466],cmath:[62,93,253,275,290,346,460,462,468,472],cmd1:122,cmd2:122,cmd:[62,70,71,92,104,122,129,138,145,178,216,224,225,253,293,299,303,305,310,333,337,350,376,396,451,466],cmd_name:363,cmdclass:[65,70],cmdloop:157,cmdqueue:157,cmode:380,cmowz:346,cmp:[62,217,227,346,456,457,460,464],cmp_func:177,cmp_op:190,cmp_to_kei:[108,227,228,346,463,466],cmpcach:456,cmpfile:217,cmpfunc:177,cmpop:124,cmsg_data:339,cmsg_len:[339,472],cmsg_level:339,cmsg_space:[339,472],cmsg_type:339,cnf:372,cnn:[167,185],cnri:[62,456],cnt:161,co_:254,co_argcount:[254,424],co_async_gener:254,co_cellvar:[190,254,424],co_cod:[254,424],co_const:[190,254,424],co_coroutin:254,co_extra_freefunc:472,co_filenam:[28,254,424,463],co_firstlineno:[190,254,424,472],co_flag:[254,424,472],co_freevar:[190,254,424],co_future_divis:60,co_gener:[254,472],co_iterable_coroutin:[190,254],co_kwonlyargcount:254,co_lnotab:[190,254,424,470,472],co_nam:[190,254,424,469,472],co_nest:254,co_newloc:254,co_nloc:[254,424],co_nofre:[254,472],co_optim:254,co_stacks:[254,424],co_vararg:254,co_varkeyword:254,co_varnam:[190,254,424],coalesc:310,coars:[65,471],coarser:355,cobalt:472,cobject:[62,463],coccioli:472,cocoa:[87,453,466,472],code:[5,7,9,10,11,15,17,22,23,25,28,29,32,34,37,38,41,44,47,50,51,54,55,57,58,59,60,62,65,66,72,74,78,79,81,82,83,85,86,87,90,92,93,94,96,97,98,99,100,101,102,103,104,106,107,108,111,114,115,116,118,119,120,123,124,125,126,127,131,132,134,135,136,138,140,141,143,144,145,147,148,149,151,152,153,154,155,157,159,161,162,163,164,165,167,168,169,170,171,172,173,174,176,177,178,181,182,184,185,186,187,188,189,190,192,193,194,195,196,197,198,199,200,202,203,204,205,206,207,208,209,210,212,213,214,215,216,217,219,221,223,225,227,228,230,231,232,233,235,236,237,238,239,240,241,243,244,245,246,249,250,251,253,255,256,257,258,260,261,262,264,265,266,267,268,269,270,271,272,274,276,279,280,281,282,284,286,287,288,289,291,292,293,294,295,297,298,299,301,302,303,304,305,306,307,309,310,311,313,314,315,316,317,318,319,320,321,322,323,325,326,327,328,330,331,332,333,334,335,336,337,338,339,340,342,343,344,345,347,348,349,350,351,353,354,355,356,358,359,360,361,363,365,366,367,369,370,371,372,373,374,375,376,377,378,379,380,381,382,386,387,389,390,391,392,393,394,395,396,398,399,400,404,405,406,407,408,409,410,411,412,413,414,416,417,418,419,420,422,423,424,425,426,428,430,431,432,434,435,436,438,439,440,441,442,443,445,446,447,448,450,451,455,456,457,458,460,461,462,463,464,465,470,471,472,473],code_context:254,code_info:[190,466],code_pag:[58,467],codebas:[431,468,469],codec:[15,29,59,62,93,105,109,146,196,202,203,214,227,253,257,337,346,364,444,447,451,456,458,460,461,464,469,470,472,473],codecinfo:[159,461],codecnam:196,codecontext:472,coded_valu:[245,469,471,472],codenam:305,codeobj:190,codeobject:472,codeop:[62,85,181,253],codepag:[62,146,355,472],codepoint2nam:240,codepoint:248,coder:[143,148],codereview:463,codeset:[54,159,232,265,458],codetool:161,codetyp:381,codewarrior:462,coeffici:[187,346,459,468],coerc:[58,102,168,187,196,197,206,261,345,451,456,464,471,472],coercion:[62,93,227,347,424,451,461,463,472,473],coexist:[164,446],coff2omf:[92,111],coff:111,cog:466,coghlan:[99,102,105,109,326,460,461,462,463,465,466,467,468,469,470,471,472],coher:[193,424],coin:[93,320],col:[97,178,248,342,347,469],col_info:[297,472],col_offset:[22,124,472],cole:[459,460,466,472],coleman:472,colin:[467,472],collabor:[62,112,459],collaps:[197,222,258,294,298,365,468,472],collapse_address:[258,469,472],collapse_join:65,collapse_rfc2231_valu:[197,210],collat:[93,265,342],collate_revers:342,colleagu:86,collect:[28,29,38,41,46,47,57,61,62,65,69,72,79,80,81,90,91,93,95,97,99,100,101,103,104,105,106,107,113,118,122,124,125,128,135,141,149,153,159,167,168,170,171,172,177,180,182,183,185,192,193,195,214,227,229,242,243,244,253,254,256,260,263,284,293,301,307,310,316,318,320,321,331,333,339,340,343,346,349,355,360,361,363,368,373,378,380,381,382,385,389,392,398,399,402,408,410,415,423,424,426,432,435,438,446,448,449,450,455,458,459,460,461,462,464,465,472,473],collect_incoming_data:125,collector:[26,57,62,79,82,84,91,93,99,253,292,317,355,363,399,408,424,442,456,458,461,462,463,465,467,468,471,472],colleg:89,collid:[95,284,321,392,432],collin:[99,462,463,469,472],collis:[106,236,289,331,455,468,472],colm:472,colno:[261,321,469],colombia:410,colon:[5,62,67,93,95,106,184,193,197,200,206,209,230,232,243,254,258,266,271,294,299,321,337,347,374,375,392,397,404,407,423,426,431,437,439,451,455,462,463,470,472],color:[62,91,93,157,161,178,212,224,241,253,278,332,369,370,372,373,375,402,424,438,466,470,471,472],color_black:[97,178],color_blu:178,color_cont:178,color_cyan:178,color_green:178,color_magenta:178,color_numb:178,color_pair:[97,178],color_r:[97,178],color_whit:[97,178],color_yellow:178,colorchoos:370,colordeleg:472,colored_btn:373,colorfaq:163,colormap:460,colormix:380,colormod:380,colorpick:462,colorsi:[62,253,278],colorstr:380,colorstring1:380,colorstring2:380,colour:[90,97,106,456,472],column:[62,91,95,101,109,124,152,153,176,178,189,190,193,222,248,261,282,293,300,302,310,316,321,333,346,349,365,369,375,385,410,413,438,442,456,463,469,472],com:[62,63,69,79,81,86,90,91,98,103,104,105,106,109,110,137,163,167,168,177,184,185,201,244,288,299,309,320,321,328,342,343,346,392,393,396,402,410,416,449,450,453,455,458,460,461,462,463,466,467,468,469,472],comb:438,combin:[7,22,30,45,51,53,57,58,62,65,74,78,81,82,86,91,93,95,97,99,104,106,107,109,110,112,118,119,122,139,140,159,161,170,177,178,182,183,184,187,193,204,206,209,222,229,237,244,245,246,248,251,252,257,260,265,266,284,292,293,294,295,298,310,320,321,324,329,330,335,337,339,340,342,346,347,348,349,350,357,359,361,370,373,380,382,384,385,391,402,403,420,422,424,426,427,428,431,432,436,437,438,442,456,460,461,462,463,468,469,470,471,472],combinations_with_replac:[99,161,260,463,465],combinator:[62,260,465],combo:[372,373],combobox:[62,369,372],comboboxselect:373,comboboxtest:472,come:[64,65,68,75,81,84,86,87,90,91,93,94,95,97,98,101,103,105,107,109,110,111,149,152,153,159,161,170,178,187,193,210,228,236,245,251,252,292,295,296,302,321,322,335,340,343,346,369,370,373,382,392,396,407,412,421,424,428,430,435,436,437,439,442,446,449,450,453,454,456,457,458,459,460,462,468,471,472],comedi:86,comfort:[109,193],comma:[5,62,65,70,74,95,113,153,161,176,187,193,212,243,249,265,266,267,271,292,321,346,347,363,374,376,392,397,424,426,432,437,438,445,447,451,460,461,462,463,464,468,471,472,473],command:[22,30,31,60,62,64,66,68,69,71,72,74,75,77,78,79,83,84,85,87,91,92,94,95,103,104,105,106,109,111,112,113,120,121,127,128,129,132,137,138,153,158,161,169,178,186,188,190,191,192,193,207,215,224,225,232,246,249,253,259,263,267,272,282,284,285,288,295,298,303,305,307,308,310,311,312,313,315,317,326,332,333,335,336,337,342,343,346,350,352,355,360,361,364,369,370,373,378,380,396,397,400,404,410,417,424,425,427,432,433,434,435,441,443,444,445,446,449,450,452,453,454,456,457,458,459,460,461,462,464,465,469,471,472,473],command_lin:350,command_line_arg:161,command_nam:65,command_packag:70,command_templ:65,commandcompil:160,commandlin:[65,74],comment:[1,9,58,62,65,68,75,79,95,99,104,106,109,113,168,177,193,204,241,244,245,248,254,273,286,293,301,302,312,315,316,321,332,363,374,375,391,409,410,412,419,420,422,432,434,437,444,445,456,458,459,461,463,464,466,472],comment_nod:407,comment_prefix:168,comment_str:346,comment_url:244,commenthandl:316,commerci:[86,87,91,97,295,422,462],commit:[122,282,288,307,342,449,461,462,463,468,470,472],committ:[288,467],committe:462,common:[7,22,29,30,31,45,46,62,64,65,70,72,77,79,82,84,86,87,91,93,94,97,98,99,103,104,107,108,109,110,115,117,122,128,140,149,159,161,168,170,176,177,182,184,189,193,196,201,202,204,206,208,209,212,217,220,223,225,227,236,237,238,244,246,248,253,255,257,258,260,261,264,266,271,272,275,284,292,293,295,300,301,305,320,332,333,334,337,340,343,345,349,350,362,363,364,365,366,367,368,370,372,380,385,386,387,388,392,396,405,416,418,419,421,423,424,426,428,437,438,439,440,445,446,447,449,451,455,456,457,458,459,460,461,462,463,466,467,468,469,471,472,473],common_dir:217,common_fil:217,common_funni:217,common_typ:276,commondialog:370,commonli:[30,65,79,90,91,93,97,99,102,106,109,122,168,189,227,253,256,276,284,285,297,340,345,346,348,350,359,367,370,372,385,391,392,397,414,416,424,437,441,442,447,455,458,460,461,462,469,471,472],commonnam:343,commonpath:[294,469,472],commonplac:[105,466],commonprefix:[294,469],commonwealth:422,commun:[0,62,64,74,86,87,91,93,104,107,112,129,132,135,138,141,193,213,243,248,253,268,284,293,307,311,334,336,339,340,343,350,363,366,373,404,416,442,448,453,456,457,460,461,462,466,469,471,472],commut:209,comp:[86,90,91,103,151,288,450,457,458,461,467,468],comp_for:[426,427],comp_if:[426,427],comp_it:[426,427],comp_op:427,comp_oper:426,comp_siz:448,compact:[38,91,93,106,109,124,153,189,198,199,261,301,309,319,349,426,436,467,468,470,472],compactli:[123,435,448,459],compani:[86,87,343,345,455,461,462],companion:[29,141,459],companydata:161,compaq:89,compar:[10,22,30,45,57,58,62,75,81,84,85,90,93,94,97,102,103,104,105,106,107,108,111,112,124,167,177,182,183,184,187,189,190,193,196,197,198,203,212,215,217,227,228,237,238,258,261,265,266,268,271,274,284,292,296,297,298,310,313,316,318,320,329,342,343,346,348,355,363,368,382,384,385,386,387,395,402,410,424,426,428,431,436,440,441,443,448,451,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],comparand:184,compare_caseless:109,compare_digest:[174,236,238,328,463,467],compare_hash:174,compare_network:258,compare_op:[190,466],compare_sign:187,compare_str:109,compare_to:378,compare_tot:187,compare_total_mag:187,comparison:[17,22,45,57,58,62,74,80,84,99,105,108,109,113,149,156,161,162,174,177,182,183,184,187,189,193,220,221,227,228,237,253,255,265,275,284,291,294,297,300,342,347,348,355,382,385,386,387,395,402,416,424,427,429,431,438,445,451,456,458,459,460,461,462,463,466,467,468,469,470,471,472,473],comparison_flag:193,compass:370,compat32:[62,195,196,199,202,203,206,207,208,209,210,285,467,469,470,472],compat:[5,22,23,30,38,44,52,57,60,62,65,74,81,82,85,87,89,90,93,95,96,97,101,103,104,106,109,110,111,121,122,123,125,129,131,140,141,145,146,153,159,161,162,168,172,177,185,187,193,195,197,202,204,206,208,209,214,215,224,230,232,242,244,246,248,249,251,252,253,254,257,258,265,266,267,271,278,284,288,291,293,297,298,301,303,304,305,310,314,316,318,320,321,324,327,333,339,342,343,346,350,351,352,355,358,359,361,363,367,369,380,382,384,385,391,392,394,395,396,398,404,406,408,410,416,418,419,420,422,423,424,428,431,432,439,455,456,457,458,459,461,462,463,464,465,466,467,468,469,470,471,472],compat_smtp:209,compat_strict:209,compat_strict_smtp:209,compatbl:472,compel:[267,463],compens:[90,310,470,472],compet:[318,466],competit:107,compil:[5,28,30,31,38,41,53,54,57,60,62,68,71,72,74,77,80,82,83,86,90,91,92,93,95,99,109,112,113,114,123,124,158,168,177,181,185,187,190,193,215,221,227,232,243,248,249,251,252,253,254,256,263,267,269,274,305,308,310,316,321,322,326,332,342,343,346,347,349,355,356,360,363,368,370,373,377,381,382,384,385,397,407,418,419,424,425,426,427,428,430,431,432,435,436,441,451,452,454,456,457,458,459,461,462,463,465,466,467,468,469,470,471,472],compile_:472,compile_command:[158,160],compile_dir:[164,469,471,472],compile_fil:[164,469],compile_path:[164,469],compile_sourc:472,compile_typ:354,compileal:[62,91,253,263,313,446,455,466,470,472],compileerror:65,compileflag:193,compiler_flag:[114,227],compilerflag:114,compilest:297,complain:[57,82,84,94,95,104,170,248,457,472],complaint:[86,87,94,95,439,457],complement:[93,106,321,346,380,424,467,471],complementari:[227,275,320,405,463,466],complet:[22,30,31,38,54,57,58,60,62,63,65,75,79,81,82,83,84,85,86,92,93,95,96,97,99,100,104,106,107,111,119,122,127,129,130,132,135,136,137,138,140,142,147,152,153,156,157,158,159,160,164,167,168,170,178,184,187,189,193,195,197,203,204,206,207,208,209,212,214,216,225,227,232,234,236,237,241,246,251,253,254,258,259,261,267,268,271,272,276,282,284,292,293,295,296,299,301,310,318,320,321,324,332,333,335,339,340,342,343,344,346,350,359,361,362,363,364,366,369,370,372,373,375,376,377,380,385,387,391,392,398,404,405,407,408,410,413,424,425,426,428,429,430,436,437,438,440,441,442,444,445,446,447,449,450,451,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],complete_:157,complete_foo:157,complete_stat:342,completedefault:157,completedprocess:[350,469],completekei:[157,299],complex:[2,5,15,31,62,64,66,77,78,79,81,84,86,90,91,92,93,94,104,106,107,110,111,112,122,124,125,129,141,168,171,176,184,185,187,188,189,195,201,204,227,228,253,260,261,267,274,275,289,290,292,297,301,321,347,350,355,380,382,386,392,416,424,426,431,432,435,436,437,438,442,445,446,447,451,458,460,461,462,463,465,466,468,470,471,472],complexencod:261,compli:[161,187,261,271,316,422,462],complianc:[62,187,195,204,209,285,288,404,407,467,468,472],compliant:[104,113,129,147,184,195,196,197,199,202,203,204,208,209,210,216,236,246,261,271,304,313,342,367,404,406,422,426,458,461,463,467,470,471,472],complic:[30,57,74,79,84,93,95,97,99,105,106,107,109,110,111,143,159,170,177,182,189,193,216,228,244,292,301,321,367,370,424,426,435,439,442,445,456,458,459,460,461,462,463,465,466,472],compnam:[119,351,398],compon:[1,30,31,38,62,65,79,84,86,91,103,104,106,109,110,112,118,159,161,172,178,184,187,195,209,211,232,233,244,252,253,254,255,256,282,289,293,294,297,298,321,332,346,347,355,356,357,361,367,368,373,380,381,385,392,402,407,412,417,419,424,428,429,431,451,455,459,460,463,464,466,468,469,470,471,472],componentflag:282,compos:[57,62,93,118,174,201,202,203,204,209,272,293,337,356,357,372,384,431,467],composit:[271,355,373,384,428,438],compound:[2,31,62,172,224,291,347,365,372,373,429,431,433,445,462,467,472],compound_stmt:[423,427,433],comprehend:252,comprehens:[23,62,90,91,93,95,110,113,124,151,190,227,236,254,301,346,425,426,436,441,447,454,455,460,461,463,464,467,468,469,471,472,473],compress:[30,62,65,66,75,93,99,102,104,119,135,147,159,168,201,219,235,236,253,258,260,276,282,295,301,333,343,344,351,359,398,406,418,419,441,450,458,459,461,463,465,466,467,468,469,470,471,472],compress_s:419,compress_typ:[419,463],compressionerror:359,compressionlevel:168,compresslevel:[151,235,359,419,471],compressobj:421,compressor:[151,269,421,472],compris:[288,304,350,426,431,432,462],compromis:[367,395,421,437],comptyp:[119,351,398],compulsori:[457,458,459],comput:[30,31,45,57,58,62,65,77,78,81,82,84,86,87,88,91,92,93,95,97,98,99,101,102,103,106,109,111,123,135,140,143,147,152,156,161,162,163,167,179,182,184,186,187,190,193,217,222,225,227,228,236,237,238,253,254,258,260,266,268,275,284,291,293,294,298,305,309,310,313,320,328,335,339,340,343,345,346,355,364,366,380,385,392,395,402,421,423,424,426,431,432,434,435,436,438,440,442,447,448,450,451,453,456,457,458,459,461,462,463,465,466,468,471,472],computation:93,computer_nam:402,computernam:402,computerphil:109,comspec:[293,350,467,468],con:[91,342,472],concat:[8,58,99,291,382,437],concaten:[22,48,49,62,65,82,106,122,123,151,153,158,159,190,227,236,238,269,271,291,293,294,298,316,321,337,339,343,346,347,359,377,421,424,426,442,445,455,459,460,472],conceal:469,conceiv:[31,68,301,359,436],concentr:[66,72,79,86,106,110,236,320,448,462],concept:[62,71,86,93,97,99,102,103,105,109,111,118,140,168,187,195,245,252,257,284,303,311,320,346,359,366,382,385,387,409,410,423,428,435,441,458,459,464,467,468,469,472],conceptu:[98,99,103,122,143,195,197,201,206,252,347,397,428,471],concern:[72,84,102,103,111,135,159,168,268,301,316,343,363,387,422,457,458,463,472],concert:[233,466],concis:[86,93,99,102,168,292,342,424,436,437,438,456,460,466,470],conclud:[94,99,103,106],conclus:62,concret:[22,29,62,65,81,82,106,118,124,167,177,184,198,209,212,220,232,252,253,257,267,292,320,330,340,355,366,385,391,407,414,428,458,459,462,467,468,471,472],concurr:[30,62,90,93,104,126,127,129,131,132,135,136,138,171,253,271,284,301,313,322,331,342,343,350,355,366,463,472,473],cond:[139,145,355,461],conda:455,condcom:241,condens:[141,236,267,461,472],condit:[30,54,57,62,79,81,84,93,99,104,110,111,125,127,135,138,140,145,149,165,182,187,189,200,212,214,227,230,237,241,249,252,257,266,267,271,272,282,284,297,299,311,316,320,321,329,339,342,343,346,352,355,361,363,385,397,399,409,411,413,416,423,424,425,429,437,439,441,445,448,451,456,457,458,460,462,463,466,467,468,469,470,472,473],condition1:99,condition2:99,condition3:99,condition:[62,115,266,363,472],conditional_express:[426,431],conditionn:99,conduc:208,conduct:251,conduct_elect:466,coneybear:472,conf:[103,104,106,298,448,459,466,472],confer:[86,342,373,450,457,461],confid:[91,105,153,320],config:[62,68,71,74,75,78,85,91,103,104,120,168,248,253,265,266,268,292,333,355,356,370,386,387,404,448,459,463,466,468,470,471,472],config_dict:267,config_initi:104,config_kei:472,config_listen:104,config_work:104,configchang:472,configdialog:472,configdialog_tests_v1:472,configdict:463,configfil:168,confighandl:472,confighelpsourceedit:472,configpars:[62,218,253,267,332,456,460,463,464,465,468,471,472],configur:[29,31,38,58,62,66,70,71,72,74,78,79,91,92,95,97,99,101,106,117,120,128,129,133,134,137,171,173,177,185,192,218,224,225,236,246,248,249,252,253,256,266,268,271,272,292,293,307,308,309,316,317,322,325,332,336,337,339,342,343,355,362,363,366,370,371,372,373,385,386,387,392,396,397,402,404,406,408,409,414,416,422,443,446,448,451,452,454,456,457,458,459,460,461,462,465,467,468,469,470,471,472,473],configure_log:104,configure_mock:[386,387,472],confin:[178,193],confirm:[103,294,299,392,397,472],conflict:[62,66,79,84,93,106,108,110,118,122,161,232,242,352,355,382,402,410,422,431,436,444,449,451,455,466,468,471,472],conflict_handl:[62,120,292],confluenc:105,conform:[26,62,103,129,147,153,168,184,187,202,204,209,210,227,248,251,252,255,266,273,297,301,316,355,391,408,410,416,422,424,460,464,465,467,468,472],confound:465,confront:[31,411,459],confstr:[293,472],confstr_nam:293,confus:[31,57,74,78,84,90,91,97,104,105,106,108,110,114,118,140,158,177,187,189,193,268,292,293,301,305,321,334,386,392,396,424,426,432,436,437,456,457,458,459,460,461,463,465,466,468,470,471,472],confusingli:[106,110,431,456],congratul:95,conin:350,conio:455,conjug:[187,289,346,462],conjunct:[28,169,189,191,193,227,251,254,332,343,431,468],conn1:284,conn2:284,conn:[129,141,161,167,170,243,284,301,330,336,339,342,343,366,461,466,469],connect:[62,92,97,102,104,107,110,120,125,126,127,132,137,141,153,161,165,170,208,213,214,225,243,244,246,248,249,257,266,268,288,292,293,300,301,307,311,329,333,334,336,337,340,343,349,350,355,360,363,366,370,372,380,387,392,394,402,404,406,408,411,413,416,422,426,439,442,444,445,451,455,456,460,461,462,463,466,467,468,469,470,471,472],connect_accepted_socket:[129,132,135,470,472],connect_ex:[90,339,456],connect_read_pip:[129,132,133,135,138],connect_write_pip:[129,132,133,135,138],connectdb:366,connection_lost:[132,135],connection_mad:[129,132,135,472],connectionabortederror:[22,214,446,467],connectionerror:[22,214,243,446,467,469],connectionopt:382,connectionrefusederror:[22,214,446,467],connectionreseterror:[22,138,214,243,446,467],connector:431,connectregistri:402,connid:104,connor:[459,468,470,472],connstream:343,conout:350,consectetur:151,consecut:[5,21,58,65,99,144,159,260,275,346,347,367,380,431,451,460,468,472],consensu:[84,93,456],consequ:[38,52,68,79,84,91,162,168,237,254,284,334,339,346,424,426,430,431,436,440,451,461,463,464,466,467,468,469,471,472],consequenti:422,conserv:[105,125,297,457,460],consid:[30,45,50,51,57,58,62,64,65,66,78,79,81,82,84,91,93,94,95,96,97,98,99,102,104,106,111,113,118,122,128,129,145,149,153,156,164,168,169,177,178,182,184,185,187,189,190,193,197,205,206,209,222,227,228,230,232,233,236,237,246,251,252,256,257,258,261,265,266,267,269,271,275,284,288,289,292,297,298,299,301,310,316,321,322,328,329,332,336,342,343,346,347,355,359,363,365,366,367,370,381,385,386,392,399,404,407,408,409,417,418,424,425,426,428,432,436,438,440,446,455,456,457,458,459,460,461,463,464,466,468,469,470,471,472],consider:[31,62,79,84,91,103,129,165,178,182,193,225,243,249,271,288,307,337,342,392,407,429,435,456,459,460,461,463,467,471],consist:[5,7,9,14,17,22,30,31,47,51,60,64,65,74,79,86,91,93,95,97,99,103,105,111,119,124,143,147,152,153,155,159,161,168,178,179,184,189,190,192,193,197,204,206,208,209,210,212,227,230,241,243,244,248,249,252,256,258,261,265,267,268,269,275,284,293,303,310,320,321,327,332,337,340,345,346,348,350,351,355,361,365,372,373,380,382,385,392,407,423,424,426,428,431,437,438,445,453,454,456,457,458,459,462,463,466,467,468,469,470,471,472],consol:[30,60,62,74,91,92,97,103,104,177,179,181,193,202,227,248,267,293,299,315,322,350,355,401,418,434,451,455,458,462,466,467,471,472],console1:104,console2:104,console_prior:466,consolehandl:103,consolelib:90,consolid:[459,467,470,472],consortium:[109,407],const_on:31,constant:[7,30,41,53,57,58,62,81,82,84,90,91,93,95,97,104,117,120,122,124,129,140,150,159,161,162,165,167,174,175,176,179,184,185,190,193,212,216,227,228,229,237,242,243,245,251,253,254,257,260,263,265,266,269,273,274,279,282,283,284,290,292,293,295,297,300,301,302,306,310,321,324,329,330,334,344,346,355,357,359,360,362,363,364,366,370,372,375,378,382,384,395,401,403,407,409,410,412,416,419,421,424,426,431,451,456,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],constant_factori:161,constant_nam:316,constantli:[442,469],consti:190,constitu:[210,407],constitut:[189,258,332,472],constrain:[60,102,123,124,209,309,382,426,428,458,461,466],constraint:[99,187,256,266,309,346,428,461,462,464,472],construct:[3,22,49,53,59,60,66,74,78,79,81,84,91,93,98,99,102,103,104,108,122,129,135,138,151,159,162,170,172,177,184,187,190,193,195,198,202,204,209,210,212,214,217,222,223,227,229,235,236,244,246,251,252,258,260,266,267,269,274,282,284,292,293,297,298,301,309,310,316,321,322,332,335,337,342,343,346,349,350,366,377,380,382,385,386,387,391,399,406,408,409,410,411,416,417,419,423,424,425,426,431,432,436,437,438,444,447,451,455,456,457,458,460,461,463,466,467,469,470,471,472],constructor:[5,17,22,26,48,50,57,58,62,65,74,79,81,85,93,98,99,102,103,104,105,113,122,124,129,141,151,152,158,159,161,162,165,168,173,176,177,182,184,187,189,193,199,202,203,204,207,208,209,214,219,223,227,228,235,236,238,243,244,247,249,257,258,260,261,266,267,269,271,279,284,291,292,301,307,309,310,318,327,329,331,332,336,337,339,340,343,346,347,354,359,360,361,363,365,366,368,370,371,380,381,382,385,386,387,392,399,400,404,410,417,419,420,424,438,439,459,460,461,462,463,464,466,467,468,469,470,471,472],constuctor:472,consult:[65,66,86,90,91,93,97,99,103,106,111,156,161,168,177,184,190,232,266,267,271,293,295,321,324,337,339,342,344,355,367,369,404,421,428,442,449,455,456,458,459,460,461,462,463,464,472],consum:[7,57,58,90,91,99,106,107,122,125,128,130,136,137,153,159,170,176,190,195,208,233,257,260,261,284,288,292,293,298,310,318,321,324,331,349,363,366,386,391,406,410,421,424,444,451,456,460,461,462,463,466,467,468,470,472],consumpt:[81,254,297,324,333,355,442,466,467,472],cont:193,contact:[86,98,392,404,422],contain:[5,7,9,11,13,21,22,24,25,26,28,29,30,31,34,36,37,38,44,45,49,50,53,54,55,56,57,58,62,65,66,70,72,74,77,78,79,81,82,83,85,86,90,91,92,93,95,97,98,99,101,102,103,104,105,106,107,108,109,110,111,113,119,120,124,125,129,135,137,140,143,144,145,147,148,151,152,153,154,158,159,160,164,167,168,169,170,171,172,173,176,177,178,179,182,183,184,185,188,189,190,193,195,196,197,198,199,200,201,202,203,204,206,207,208,209,210,212,214,215,217,222,225,227,228,229,232,233,235,236,237,238,239,241,242,243,244,245,246,248,249,250,251,252,253,254,255,256,257,261,262,265,266,267,268,269,271,272,274,276,279,280,282,284,286,287,288,290,291,292,293,294,295,297,299,301,302,304,305,306,307,309,310,312,313,314,315,316,320,321,324,326,328,329,331,333,334,335,336,337,338,339,340,342,343,346,347,349,350,354,355,356,358,359,361,362,363,365,367,368,370,372,373,375,376,377,378,380,382,384,385,386,387,389,391,392,393,394,395,396,397,399,400,402,403,404,405,406,407,408,409,410,411,412,413,414,416,417,418,419,420,421,422,423,425,426,428,430,431,432,434,436,437,438,439,440,441,442,444,445,446,448,449,450,451,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472,473],content:[0,5,7,8,9,11,24,30,34,38,41,49,53,56,58,60,65,68,77,78,94,95,97,99,103,104,106,109,110,111,114,115,123,125,129,135,144,151,153,155,158,159,161,164,167,177,178,180,183,185,188,190,193,195,196,197,199,200,201,202,204,205,206,207,208,209,210,216,217,218,225,227,228,229,232,235,236,238,241,242,243,246,248,252,253,254,256,257,261,267,271,273,276,279,280,282,285,293,298,301,302,304,309,313,317,319,322,333,336,342,343,346,347,349,351,355,359,361,363,364,365,370,375,381,383,388,390,391,392,393,396,399,404,406,408,410,412,413,414,416,417,418,419,421,425,426,428,431,436,437,439,442,445,446,451,455,456,457,458,459,460,461,462,463,466,467,468,469,470,471,472,473],content_manag:[198,206,209,468],content_typ:[201,204],contentdispositionhead:204,contenthandl:[62,273,409,411,413,414,456],contentmanag:[62,195,207,285,468],contenttooshorterror:[390,392],contenttransferencod:204,contenttypehead:204,context:[10,15,22,30,38,41,45,49,58,60,62,64,66,72,79,85,91,93,95,96,99,107,109,122,124,125,129,131,134,140,153,154,161,165,167,168,184,185,188,189,190,214,219,225,227,237,243,252,253,254,257,261,266,267,268,269,271,279,288,290,293,295,296,299,300,307,309,316,317,318,321,323,324,329,330,331,337,339,340,347,350,353,355,359,360,361,363,366,369,372,374,385,386,387,392,396,399,402,407,409,411,412,416,419,423,425,426,431,432,434,438,439,456,463,464,465,466,468,469,470,471,472,473],context_diff:189,context_expr:124,context_use_ps1:472,contextbaseclass:170,contextdecor:[170,466],contextfilt:104,contextlib:[62,253,317,346,378,382,463,464,465,472],contextmanag:[170,346,382,461,462,466,470,472],contextu:[62,189,266],contextvar:[16,62,93,129,131,140,253,472],conti:463,contig:7,contigu:[2,5,39,62,84,93,189,249,271,346,412,462,467,472],continu:[5,22,31,32,54,58,62,68,79,85,86,91,93,98,99,103,109,110,114,117,118,120,124,125,129,140,141,156,157,159,161,170,178,182,190,193,197,200,201,203,208,242,243,246,248,249,251,252,260,266,271,283,292,293,294,299,316,320,321,333,339,340,343,345,346,374,375,385,387,392,397,412,421,422,423,424,425,426,427,428,429,430,431,436,439,441,443,444,445,448,451,455,456,458,459,460,461,462,463,465,466,467,468,469,471,472],continuation_w:203,continue_loop:190,continue_stmt:[427,432],contort:464,contract:[248,346,422],contractu:456,contradictori:292,contrari:[7,84,189,442],contrarili:446,contrast:[58,93,108,161,187,248,310,343,346,370,382,409,424,426,428,447,458,467,470,471],contravari:382,contravariantli:382,contravent:197,contrib:[370,396],contribut:[0,31,62,64,72,84,86,93,112,182,232,236,252,296,310,321,383,394,422,428,450,454,456,457,458,459,460,461,462,463,465,466,467,468,469,470,471,472],contributor:[62,64,112,422,464,472],contriv:193,control:[5,7,29,30,31,38,44,53,59,62,65,68,69,71,79,80,81,83,85,89,90,91,93,97,103,104,106,108,111,117,122,126,129,132,134,135,137,138,140,141,144,145,153,154,157,159,161,164,167,172,176,177,178,179,184,185,187,189,192,193,195,197,198,202,203,206,208,209,211,214,216,219,222,224,225,227,229,231,235,248,249,252,253,255,257,258,261,266,267,268,271,276,282,283,284,288,292,293,295,299,300,301,307,309,310,311,313,316,317,319,323,324,329,330,332,339,340,343,346,348,349,350,355,359,361,365,366,368,370,371,372,373,376,377,381,385,386,387,388,391,392,399,402,403,410,412,414,416,417,419,421,423,424,425,426,428,430,432,434,436,439,440,441,442,444,448,449,451,453,455,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],control_next:282,controlcondit:282,controlev:282,controlnam:179,controlpanel:370,controversi:[292,458],conttyp:359,conv:[448,469],conveni:[5,7,19,22,23,26,28,30,38,41,57,62,66,70,79,81,84,90,91,92,95,96,103,104,108,109,110,111,122,129,147,152,153,158,159,161,168,177,182,184,187,190,196,197,199,202,203,204,206,207,208,209,210,227,228,232,235,236,244,248,251,253,254,255,257,266,267,269,271,276,284,292,295,297,301,310,328,332,337,342,343,345,346,350,351,359,362,363,365,367,368,370,372,385,386,387,396,398,404,406,407,410,411,413,418,423,424,428,431,432,436,437,439,446,455,456,458,459,460,461,462,463,464,465,466,468,469,470,472],convent:[31,53,57,65,69,72,74,79,91,93,95,97,98,103,104,109,111,148,152,168,177,178,179,184,210,222,227,230,232,244,247,265,271,292,294,295,346,347,355,363,365,367,385,392,418,424,426,430,431,436,437,439,444,446,447,448,449,454,456,457,458,459,460,461,462,463,464,466,468,469,471,472],convention:[10,79,244,292,293],converg:[109,345],convers:[5,9,29,30,31,57,58,59,62,65,78,86,93,95,97,98,101,107,120,122,124,135,141,144,147,148,159,168,176,184,187,196,227,253,255,257,261,265,271,276,278,289,290,292,293,301,339,343,346,347,349,350,355,359,375,381,386,391,394,422,429,431,446,455,461,462,463,464,465,466,468,469,471,472,473],conversionerror:[405,472],conversionsyntax:462,convert:[5,13,14,17,24,30,31,35,43,50,51,53,54,58,60,62,65,74,75,78,79,81,82,84,90,92,93,97,98,99,103,104,106,107,108,111,113,119,122,123,143,145,148,150,153,156,157,159,161,163,165,168,176,177,179,182,184,185,187,189,190,193,195,196,197,198,201,202,203,204,206,207,209,210,214,216,221,225,227,228,232,239,241,245,249,253,258,260,261,263,265,266,267,268,269,271,274,275,276,284,285,289,291,292,293,294,300,301,303,304,306,309,320,321,328,337,339,344,346,347,349,351,355,359,367,370,373,375,385,391,392,395,397,402,404,408,410,412,416,424,426,431,432,439,440,442,445,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],convert_arg_line_to_arg:122,convert_charref:[241,468,469,472],convert_field:347,convert_path:65,convert_point:342,convert_to_error:472,converter_init:95,convinc:[103,265],conwai:[370,472],coodin:469,cook:[106,178,360,472],cookbook:[31,62,69,80,91,100,103,110,266,267,268,275,368,450,466],cooki:[62,110,117,212,236,242,253,255,343,366,375,392,460,462,463,464,469,471,472],cookie2:244,cookie3:244,cookie_spec:244,cookieerror:245,cookiejar:[62,242,245,253,255,392,472],cookielib:[62,463,464],cookiepolici:[62,255],cool:[66,91],coomb:468,cooper:[30,93,118,140,165,204,227,343,355,422,436,471,472],coord:347,coordin:[62,64,84,95,97,104,112,139,163,177,178,180,184,271,282,290,342,347,367,370,373,375,380,448,456,462],cope:[62,86,188,460,472],copi:[5,7,9,16,30,39,47,50,57,58,62,64,65,66,69,70,72,74,79,83,84,94,95,96,99,104,111,112,113,122,124,129,135,140,153,159,161,167,168,171,173,177,178,182,183,184,187,193,201,202,204,209,216,222,227,228,229,232,236,238,245,248,249,253,254,257,260,268,271,276,279,284,292,293,301,303,304,321,331,333,342,346,347,349,350,355,356,363,370,378,380,381,385,386,387,392,396,397,404,412,413,418,421,422,423,424,428,436,437,438,445,446,449,455,457,458,459,460,461,462,463,466,467,468,469,470,471,472],copied_list:172,coprim:346,copy2:[333,466,467,469],copy_ab:187,copy_call_arg:387,copy_context:171,copy_decim:187,copy_fil:65,copy_funct:[333,466,469],copy_loc:124,copy_neg:187,copy_nul:58,copy_reg:464,copy_sign:187,copy_str:472,copy_tre:65,copyfil:[90,333,447,463,468],copyfileobj:[110,235,333,472],copyingmock:387,copyinstr:101,copymod:333,copyreg:[62,172,253,280,300,301,464,472],copyright:[30,62,64,66,79,92,111,169,236,248,355,422,444,446,451,466],copysign:[275,462],copystat:[333,467,472],copytre:[62,90,220,462,463,466,472],corba:407,corchero:[471,472],corderoi:462,core:[1,22,26,47,54,62,64,69,70,71,72,74,77,79,82,93,103,105,106,120,129,168,206,236,252,253,256,260,265,268,291,292,293,302,310,315,320,324,334,346,363,366,381,382,386,407,422,424,429,432,446,455,457,458,459,460,461,462,463,464,465,466,467,468,469,470,473],coredump:363,corner:[17,97,178,380,404,458,461,462,472],coro:[128,129,140,355,469,472],coro_clos:254,coro_cr:254,coro_func:128,coro_run:254,coro_suspend:254,corollari:464,coroutin:[15,62,93,99,126,127,129,131,132,135,136,137,138,139,162,170,183,190,214,317,355,382,426,429,461,470,471,472],coroutinetyp:[381,469,472],corowrapp:472,corp:458,corpor:[63,64,112,422],correct:[1,7,30,57,58,66,77,79,83,91,95,99,102,109,110,113,135,170,177,193,197,198,200,209,212,217,241,244,248,249,252,275,279,284,289,292,293,295,297,301,316,333,339,342,343,345,346,347,350,351,355,367,370,380,385,386,387,392,396,398,404,412,418,421,424,426,436,437,439,451,455,456,458,459,460,461,462,463,464,466,467,468,470,471,472],correctli:[7,41,53,57,60,82,84,95,96,102,118,119,122,153,159,170,176,184,187,193,197,198,204,209,210,227,233,248,254,258,265,293,297,326,346,359,363,386,387,402,404,424,428,431,438,439,455,458,460,462,463,466,467,468,469,470,471,472],correl:252,correspond:[5,9,11,14,17,18,21,22,27,28,30,31,36,41,44,45,51,53,57,58,62,65,66,69,74,75,77,79,81,82,85,91,92,93,96,97,99,102,103,104,106,107,109,110,111,114,119,122,123,125,129,135,138,140,147,152,157,159,161,168,171,176,177,178,179,184,185,187,190,193,200,209,210,213,214,219,220,222,224,225,227,228,232,234,236,239,241,244,246,248,249,251,252,254,258,260,261,265,266,267,268,271,284,291,292,293,295,309,310,312,316,319,320,321,330,332,333,334,337,339,341,343,346,347,349,350,354,355,356,365,366,367,370,372,373,377,382,384,385,386,390,391,392,394,396,399,400,403,407,408,412,414,416,419,420,421,423,424,425,426,428,431,432,436,437,438,439,445,451,455,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],correspondingli:[271,456,472],correspondintli:472,corrupt:[38,54,109,147,178,213,216,244,269,271,284,301,318,342,346,442,455,471,472],cos:[156,187,223,275,301,447,459],cosbuc:472,cosh:[156,275],cosin:[156,187,275],cost:[78,84,91,95,161,184,189,228,236,244,252,297,346,368,377,382,387,424,456,459,462,463,468],costa:410,costli:472,costlier:93,could:[7,22,24,28,30,31,51,57,65,66,69,70,77,79,82,83,84,89,91,93,95,96,97,98,99,103,104,105,107,108,109,110,111,113,118,122,124,129,131,135,143,153,157,161,168,177,178,184,193,201,202,207,209,214,217,225,229,230,232,237,238,248,251,254,257,258,260,261,266,267,268,271,284,292,293,295,298,299,301,305,310,313,316,320,321,323,330,332,339,342,350,355,359,363,366,369,382,385,386,387,391,392,394,395,399,404,407,424,426,428,430,431,432,435,436,437,439,440,442,445,446,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],couldn:[79,106,110,257,293,334,342,387,420,457,458,461,463,470,472],count0:229,count1:229,count2:229,count:[3,5,6,7,9,11,22,29,30,41,42,45,49,51,53,54,57,58,62,80,81,82,84,86,90,91,93,94,95,99,106,122,123,129,136,141,145,147,150,153,161,162,177,178,184,189,190,193,197,209,212,219,227,229,237,248,249,251,252,254,257,260,266,271,279,282,284,288,292,293,299,301,307,310,318,320,321,329,332,339,342,343,346,347,349,355,363,365,366,367,368,370,376,378,385,392,410,424,426,431,432,438,445,448,451,456,458,459,460,461,462,463,464,465,466,467,468,470,472],count_alloc:[57,451,463,470,472],count_diff:378,count_word:382,countcal:376,counter:[57,62,79,82,91,93,99,139,142,183,189,190,201,222,237,284,292,320,346,366,367,382,385,423,426,436,458,460,461,462,463,465,466,467,472],counterclockwis:[156,380],counterfil:142,counterintuit:168,countermeasur:406,counterpart:[79,104,178,227,257,260,266,270,288,321,339,346,362,463,465,466,471,472],countfunc:376,countless:456,countof:291,countri:[244,265,343,346,410,460],country_data:410,country_data_as_str:410,countrydata:410,countrynam:343,counttestcas:385,coupl:[62,69,74,75,81,91,95,104,105,107,122,129,206,209,210,266,284,292,334,369,386,387,392,406,455,468,470,471,472],courier:[271,370,472],cournapeau:463,cours:[65,66,69,72,74,75,79,82,84,86,92,95,99,103,104,107,111,118,177,187,193,201,203,208,236,256,266,267,284,289,292,293,332,340,343,370,380,386,387,407,416,424,436,437,445,451,456,457,459,464,466,467,468],courtesi:472,cout:91,couzo:472,covari:382,covariantli:382,cover:[31,64,71,72,74,80,82,85,86,91,97,100,103,104,106,107,109,111,112,135,170,193,195,209,212,244,267,284,292,320,321,337,346,350,370,376,385,391,407,421,422,430,441,448,451,456,457,458,461,464,467,468,472],coverag:[30,62,91,355,370,376,464,468,472],coverageresult:376,coverdir:376,cow:468,cowl:201,cowlishaw:460,coyot:244,cp037:159,cp1006:159,cp1026:159,cp1125:[159,468],cp1140:159,cp1250:[159,168],cp1251:159,cp1252:[159,444],cp1253:159,cp1254:159,cp1255:159,cp1256:159,cp1257:159,cp1258:159,cp1361:159,cp154:159,cp273:[159,468],cp35:472,cp424:159,cp437:159,cp500:159,cp65001:[159,467,472],cp720:[159,463,466],cp737:159,cp775:159,cp819:159,cp850:159,cp852:159,cp855:159,cp856:159,cp857:159,cp858:[159,463],cp860:159,cp861:159,cp862:159,cp863:159,cp864:159,cp865:159,cp866:159,cp866u:159,cp869:159,cp874:159,cp875:159,cp932:[159,460],cp936:159,cp949:[159,460],cp950:[159,460],cp_acp:[58,159,467,470],cp_oemcp:[159,470],cp_utf7:472,cp_utf8:[159,467,472],cpanel:110,cpathnam:28,cpickl:[459,461,463,464],cplx:462,cpp:[74,459,472],cpparg:111,cppflag:[459,472],cprofil:[62,186,461,472],cpu:[90,107,109,128,129,132,159,165,167,236,237,269,284,293,324,367,368,378,406,453,459,467,468,469,471,472],cpu_bound:129,cpu_count:[164,284,293,468,472],cpython:[12,30,31,54,62,77,79,81,82,86,91,93,94,95,100,159,162,187,190,193,211,215,227,236,238,251,252,254,275,298,305,313,318,322,326,345,346,355,363,366,381,399,404,424,425,426,430,432,446,451,454,455,457,458,459,461,462,463,466,467,469,472,473],cpython_onli:363,cr_await:[254,472],cr_code:254,cr_frame:254,cr_origin:[254,355,472],cr_run:254,crabgrass:438,crack:174,craft:[202,301,428,442,466],craig:[459,472],cram:[249,337],crash:[31,39,79,81,96,124,153,177,185,215,227,248,271,284,292,299,301,355,363,451,456,461,462,467,468,470,472],crawl:[393,470,472],crawl_delai:[393,472],crazi:107,crc32:[147,236,421,447,448],crc:[147,419,421,472],crc_hqx:[147,472],creat:[0,1,2,3,5,7,8,9,10,11,12,14,15,16,18,19,21,22,23,24,26,27,28,31,35,36,38,39,41,45,50,53,55,56,57,60,61,62,68,69,70,71,72,74,77,79,81,82,83,84,87,92,93,95,96,97,98,103,104,105,106,108,109,110,111,112,116,117,118,119,120,123,124,125,126,127,128,131,132,134,135,136,137,139,141,145,151,152,153,155,158,159,161,162,164,167,168,170,171,172,175,176,177,178,182,183,184,185,187,188,189,190,191,193,194,195,199,200,201,202,203,204,206,208,209,211,214,216,219,220,222,225,226,227,228,229,232,235,237,241,242,243,246,248,249,251,252,253,254,257,258,263,266,267,268,269,271,272,279,282,283,284,285,288,293,294,298,299,301,302,304,307,309,310,314,316,321,324,325,329,331,333,335,336,337,340,342,343,344,346,347,349,350,352,354,355,359,361,363,365,366,368,370,372,373,375,376,377,378,380,381,382,385,386,392,394,395,399,400,402,404,407,408,410,411,412,413,414,416,417,419,420,422,423,425,426,428,430,431,432,434,436,437,438,439,441,442,445,446,447,448,450,451,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,469,470,471,472],create_accepted_socket:471,create_aggreg:[342,472],create_arch:[418,471,472],create_autospec:[62,188,472],create_breakaway_from_job:350,create_cal:387,create_col:[342,472],create_configur:396,create_connect:[129,132,135,137,339,343,462,463,466,469,471,472],create_datagram_endpoint:[129,132,133,135,471,472],create_decim:[187,462,467],create_decimal_from_float:187,create_default_context:[129,225,243,249,307,337,343,392,463,468,472],create_default_error_mod:350,create_dynam:472,create_empty_fil:363,create_font_tab:472,create_funct:[342,472],create_futur:[129,131,132,135,469,470,472],create_lin:456,create_method:284,create_modul:[41,252,428,469,470],create_new_consol:350,create_new_process_group:[138,350],create_no_window:350,create_pars:[411,413],create_patch:387,create_polygon:456,create_serv:[129,132,135,137,469,470,471,472],create_shortcut:66,create_socket:141,create_stat:310,create_static_lib:65,create_string_buff:[177,461],create_subprocess_exec:[127,129,134,138,350],create_subprocess_shel:[127,129,138],create_system:419,create_task:[127,128,129,131,132,136,139,140,469,471,472],create_tre:65,create_unicode_buff:[177,472],create_unix_connect:[129,132,133,135,137,472],create_unix_serv:[129,132,133,135,137,471,472],create_vers:419,create_widget:370,createattribut:407,createattributen:407,createcom:407,createconnect:385,createdocu:[407,408],createdocumenttyp:407,createel:407,createelementn:407,createexpensiveconnectionobject:385,createfilehandl:[370,472],createkei:402,createkeyex:[402,463],createlock:[266,268],createprocess:350,createprocessinginstruct:407,createprocessw:472,createrecord:282,createsocket:268,createtextnod:[407,408],creation:[6,15,30,31,54,57,62,77,79,80,82,84,91,93,99,103,104,112,120,121,122,123,135,138,141,151,161,182,183,187,191,198,212,227,232,236,249,252,253,254,255,257,266,269,271,282,284,292,294,297,313,323,324,333,344,346,347,350,355,359,361,363,370,372,386,399,407,418,422,423,428,436,459,467,468,469,471,472],creationflag:[138,350,460],creativ:[90,236],creativecommon:236,creator:[0,65,80,93,104,284,293,333,396,408,419,420,424,430],credenti:[268,288,392,455,469,472],credit:[62,92,111,169,175,248,260,355,370,444,446,472],creturnconvert:95,crew:[458,459,461],crit:268,criteria:[103,249,266,310],criterion:[84,249,424,456],critic:[81,86,93,103,104,129,251,252,266,267,268,292,403,428,435,447,448,459,461,462,465,466,469],crl3:343,crl4:343,crl:[343,468,472],crldistributionpoint:[343,468],crle:472,crlf:[58,225,245,246,471,472],crncystr:265,cro:106,crompton:[470,472],cron:268,crop:363,cross:[62,64,65,71,78,82,86,87,107,111,120,143,184,192,213,245,248,293,296,301,320,339,407,431,453,456,457,458,459,462,463,465,466,467,468,469,470,472],crossov:178,crow:106,crt:[38,343,463,468,472],crt_assembly_vers:463,crtassem:463,crucial:[428,456],crude:178,cruft:464,crumb:193,crunch:457,crutch:464,crux:385,crw:[350,469],crypt:[62,175,253,312,388,422,470,472],crypt_r:472,cryptedpasswd:174,cryptgenrandom:293,cryptic:[84,153,472],crypto:[470,472],crypto_auth:422,cryptoapi:460,cryptograph:[30,62,236,253,293,320,328,343,421,422,467,470],cryptographi:[236,238,328,339],cryptographic_hash_algorithm:236,cryptographic_hash_funct:236,cryptsoft:422,cs_path:472,csbig5:159,csd:305,cserna:463,csh:[396,449,468],cshrc:[294,453],csi:213,csibm273:159,csidl_appdata:66,csidl_common_desktopdirectori:66,csidl_common_program:66,csidl_common_startmenu:66,csidl_common_startup:66,csidl_desktopdirectori:66,csidl_font:66,csidl_local_appdata:455,csidl_program:66,csidl_startmenu:66,csidl_startup:66,csidl_str:66,csiphash:422,csiso2022jp:159,csiso2022kr:159,csiso58gb231280:159,csprng:[343,472],csptcp154:159,csrc:236,css:[152,241,466,471],cssclass:152,cssclass_month:152,cssclass_month_head:152,cssclass_nodai:152,cssclass_year:152,cssclass_year_head:152,cssclasses_weekday_head:152,csshiftji:159,cst:184,cstringio:[462,464],csv:[62,161,218,253,363,447,459,461,465,470,472],csvfile:176,csvreader:176,csvwriter:176,ct_co:382,cte:[197,198,199,204,206,209,472],cte_typ:[202,204,209,467],ctermid:293,ctime:[78,184,293,294,344,367,459],ctrl:[85,92,97,104,129,169,179,284,299,334,340,437,451,456,461,466,472],ctrl_break_ev:[138,293,334,350,463],ctrl_c_event:[138,293,334,350,463],ctx:[16,22,38,104,124,171,187,284,343,462],ctype:[30,62,79,120,165,197,201,206,215,253,304,346,463,467,470,472],ctypes_configur:94,ctypes_pass_by_ref_hack:472,cube:[442,445],cubic:189,cucci:470,cud1:178,cud:178,cufr:472,cull:310,culprit:104,cultur:[106,232,265,321,448],cum_weight:320,cumbersom:[78,187,370],cumtim:310,cumul:[99,219,228,275,310,320,376,378,451,461,466,468,469],cuni:466,cup:178,cur:[271,342],cur_thread:340,curabitur:151,curdir:[217,293,294,333],curiou:[95,153,472],curl:[244,455],curli:[93,95,109,282,347,384,395,426,431,438,462,463,470],curr:187,currenc:[187,265,461],currency_symbol:[265,448],current:[5,10,11,16,17,22,28,30,31,35,37,39,41,45,48,54,56,57,58,60,62,64,65,66,69,72,74,75,79,81,82,84,85,86,87,90,93,94,95,96,97,99,100,102,103,104,106,109,110,111,117,118,119,122,123,124,125,127,131,132,134,135,136,137,138,140,145,152,153,154,155,156,157,159,161,164,166,167,168,170,171,172,174,176,177,178,180,184,187,190,192,193,197,198,201,203,204,206,209,210,211,213,214,215,216,219,221,222,224,225,227,229,232,235,236,237,241,243,245,246,248,249,251,252,255,257,258,265,266,268,271,274,275,276,279,282,283,284,288,292,293,294,295,298,299,301,304,305,309,310,311,313,315,316,317,318,320,321,322,324,325,326,327,330,332,333,334,336,339,342,343,345,346,347,350,351,355,356,357,359,361,363,365,366,367,368,370,372,373,376,377,378,380,383,385,391,392,393,395,396,397,398,399,402,403,404,405,407,408,409,410,412,413,416,418,419,420,421,422,423,424,425,426,428,431,432,434,436,437,442,443,444,446,447,448,451,453,455,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472,473],current_d:342,current_offset:[190,468],current_process:[104,284],current_stack:472,current_task:[127,140,471,472],current_thread:[284,340,366,472],current_timestamp:342,currentbyteindex:316,currentcolumnnumb:316,currentcontrolset:455,currentfram:254,currentlinenumb:316,currentthem:472,currentthread:[90,189],currenttim:417,curri:99,currkei:260,currsiz:[228,466],currvalu:260,curs:[62,95,100,120,253,455,456,457,460,462,472],curs_set:[97,178],cursor:[62,97,157,161,176,178,248,293,300,301,322,370,372,373,387,461,462,465,466,470,472],cursorfont:370,cursu:151,cursyncup:178,curtin:[463,466,467,468,471],curv:[156,343,380,467,472],curve_nam:343,custom2:82,custom3:82,custom4:82,custom:[29,31,54,57,62,65,77,79,82,85,91,93,98,110,113,118,120,121,124,129,130,131,152,157,159,161,162,165,182,183,184,186,193,195,208,209,218,227,243,246,248,252,253,254,255,257,261,266,268,271,281,285,292,300,301,322,325,333,334,335,336,343,346,355,364,366,373,385,386,392,396,397,399,404,407,409,410,416,423,426,428,432,435,436,438,441,443,448,450,452,456,459,460,461,462,463,464,466,467,469,472],custom_attribut:[104,266],custom_clear:82,custom_dealloc:82,custom_getfirst:82,custom_getlast:82,custom_getsett:82,custom_init:82,custom_memb:82,custom_method:82,custom_nam:82,custom_new:82,custom_setfirst:82,custom_setlast:82,custom_travers:82,customadapt:104,customari:[187,365,446,451],customerror:193,customformatterfactori:267,customhtmlc:152,customis:424,customiz:[66,184,441,463,472],customize_compil:[65,472],custommodul:82,customobject:82,customtyp:82,cut:[65,95,106,156,248,297,367,447,460,462,472],cutoff:189,cuu1:178,cuu:178,cve:[30,463,472],cwd:[225,298,350,363,396,460,472],cwi:[62,86,241,339,391],cx_freez:[62,91,92,284,452],cxx:[85,356],cyan:[97,178,212,448],cycl:[22,26,56,57,62,79,82,84,91,93,99,101,104,140,161,211,229,248,254,260,373,399,423,424,432,435,448,457,459,461,462,463,466,468,472,473],cyclic:[3,29,46,57,62,80,91,93,269,292,408,421,424,466,468,472],cygwin1:111,cygwin:[71,293,355,455,457,459,472],cygwinccompil:65,cygwincompil:71,cynthia:380,cypher:159,cyril:159,cyru:249,cython:[80,84,85,87,91,96,468,472],cython_coroutin:472,czotter:310,d24f26cf8de66472d58d4e1b1774b4c9158b1f4c:236,d25if65hy903weo:249,d380000000000p:346,d48eceb:92,d800:159,d_file_offset_bit:308,d_first_inn:284,d_fmt:265,d_largefile64_sourc:308,d_t_fmt:265,d_type:293,da39a3ee5e6b4b0d3255bfef95601890afd80709:95,da39a3ee5e6b4b0d:95,dad:459,daemen:470,daemon:[103,104,268,284,318,337,339,340,343,366,367,399,459,462,467,471,472],daemon_thread:340,daft:104,dai:[19,79,86,90,106,107,129,152,168,184,212,228,245,261,265,268,275,288,293,341,343,367,381,419,428,431,447,450,456,459,461,462,463,468,470,472],daili:[99,447,458,472],daisi:437,dalcrin:465,dale:[459,467],dalk:[108,422,458,459,461],damag:[28,301,359,382,422],damien:[462,468],dan:[422,460,461,466,467,468,469,472],danc:[380,438],dandi:386,danger:[28,31,54,91,284,292,293,343,386,430,457,460,461],dangl:[30,79,83,333,346,347,363,423,472],daniel:[236,459,462,463,466,468,469,470,472],danish:159,daod:466,dare:339,dark:[458,472],darken:472,darl:472,darren:467,dart:380,dartiailh:472,darwin:[30,355,367,456,462,469],dash:[153,159,178,197,206,332,404],dashrepl:321,dat:[74,122,185],data1:243,data2:243,data:[5,7,9,20,23,29,30,31,38,44,45,47,50,51,53,55,57,58,59,62,67,69,71,75,78,79,80,81,83,85,86,92,93,94,95,96,97,98,101,104,106,108,111,117,119,120,122,123,124,125,127,129,132,135,136,138,141,145,147,148,149,151,152,153,158,159,161,165,167,168,169,170,172,176,178,179,180,184,185,187,189,196,197,198,199,202,204,207,208,209,212,213,214,216,218,222,225,227,232,235,236,237,241,243,244,245,246,248,249,250,252,253,254,256,257,260,261,265,266,268,271,272,273,274,276,278,279,282,284,286,288,290,292,293,295,297,298,302,304,306,308,310,311,316,317,318,320,321,328,329,330,331,333,334,335,336,337,338,339,340,342,343,344,345,346,347,348,350,351,353,355,356,359,360,361,362,363,364,367,369,372,373,376,377,378,380,381,382,384,385,386,390,391,392,394,398,399,402,403,404,406,407,408,409,410,411,412,413,414,415,416,417,418,419,420,421,422,426,428,429,435,436,439,440,441,445,446,450,451,455,456,457,458,459,461,462,463,465,466,467,468,469,470,471,472,473],data_encod:159,data_fil:[65,74,75],data_in:269,data_open:392,data_out:269,data_receiv:[132,135,472],data_size_limit:336,data_struct:462,data_to_send:104,databas:[1,58,62,78,106,109,126,176,178,182,184,210,227,231,244,253,260,265,276,298,300,301,310,331,346,348,364,366,367,370,372,373,385,388,392,401,428,431,435,447,448,457,458,459,461,462,463,466,467,468,469,470,471,472],databaseconnect:[461,462],databaseerror:342,databaseprogram:90,databasetyp:182,dataclass:[62,161,237,253,317,318,472],datafil:[367,459],datagram:[62,129,132,340,343,448,472],datagram_receiv:[132,135],datagramhandl:[62,103,120,267,468],datagramprotocol:135,datagramrequesthandl:340,datagramtransport:135,datahandl:[62,110,255,468],datalen:268,dataset:[98,108,168,237,460,472],datasourc:408,datastream:93,datatyp:[62,81,91,177,183,187,218,253,261,448,460,462,463,465,466,473],date1:184,date2:184,date:[19,30,62,65,71,73,76,78,111,135,138,140,152,164,183,193,204,209,210,244,246,253,265,266,267,268,271,288,291,293,301,305,313,341,342,343,359,367,387,416,417,419,420,428,431,441,446,448,455,456,460,461,462,464,466,467,468,469,470,471,472,473],date_str:184,date_tim:[249,419],date_time_str:246,datefmt:[103,104,266,267],datehead:204,dateprotocol:135,datestr:249,datetim:[15,62,91,129,135,138,140,152,183,189,204,210,212,249,253,255,268,288,301,306,342,343,347,367,381,387,417,424,431,447,451,459,460,461,462,463,469,472],datetime1:184,datetime2:184,dateutil:184,datum:[426,432],dave:[108,459,460,463,466,472],davi:[469,470,472],david:[99,101,109,232,422,455,456,457,458,459,460,462,463,465,466,467,468,469,470,472],davin:[470,472],dawan:471,day_0:212,day_1:[212,265],day_365:212,day_366:212,day_7:265,day_:212,day_abbr:152,day_nam:152,daylight:[184,210,367],days_to_go:184,db00:258,db2pickl:459,db77e160355:[395,461],db8:[102,258],db_connect:[461,462],db_row:342,db_transact:[461,462],dbc:[58,159],dbfilenameshelf:331,dbhash:464,dbl_dig:355,dbl_epsilon:355,dbl_mant_dig:355,dbl_max:[24,355],dbl_max_10_exp:355,dbl_max_exp:355,dbl_min:[24,355],dbl_min_10_exp:355,dbl_min_exp:355,dbm:[62,90,253,300,301,331,424,463,464,472],dbmlibord:463,dbpickler:301,dbshelv:462,dbunpickl:301,dc1:179,dc2:179,dc3:179,dc4:179,dc80:[54,109,159,227],dcab:442,dcba:459,dcff:[54,109,159,227],dcgettext:[232,265],dcl:431,dcmp:217,dct:261,dcxx:293,ddd:91,ddir:164,ddl:[342,470,472],ddthh:184,de_d:[184,265,469],deactiv:[16,95,370,396,455],dead:[107,309,399,436,437,459,464,466,472],deadbyt:38,deaddyt:472,deadlin:[130,327],deadlock:[30,116,138,167,194,213,215,251,284,318,350,355,366,424,462,466,467,472],deaf:[340,466],deal:[0,14,15,31,38,57,58,62,74,78,93,105,106,107,109,122,158,159,195,197,198,206,220,241,257,265,283,284,292,301,320,327,339,367,370,380,387,391,422,436,442,456,458,459,460,461,464,467,469,472],deal_with_cli:343,dealloc:[9,26,30,31,41,47,57,58,79,81,82,84,93,229,363,399,432,457,458,463,466,472],dealt:[81,107,158,292],death:467,deb:460,debian:[66,85,111,225,305,454,456,457,471,472],debnath:[471,472],debug:[16,29,30,38,45,57,60,62,71,81,82,84,91,93,97,101,103,104,105,106,111,124,132,140,145,154,167,171,177,187,188,197,205,206,214,222,225,229,243,249,253,255,266,267,268,280,288,292,299,303,305,307,321,332,336,337,342,346,355,359,360,363,369,372,378,385,386,397,410,416,419,424,425,431,432,442,447,448,452,454,455,456,457,458,459,461,462,465,466,467,468,469,470,471,472],debug_bytecode_suffix:252,debug_collect:229,debug_leak:229,debug_overrid:[251,252,469],debug_print:65,debug_saveal:229,debug_src:193,debug_stat:229,debug_uncollect:[229,466],debugg:[29,62,79,186,193,214,227,248,253,323,355,385,424,436,455,458,459,461,462,463,466,470,471,472],debuggingserv:[62,255],debuglevel:[243,337,360,392,469,472],debugrunn:193,dec:[91,92,99,107,184,223,225,447,458,459,472],decatur:99,decemb:[86,184,431,447,458,459,470],decent:[107,445],decept:[293,459],decid:[82,84,86,91,95,99,103,105,107,145,158,170,178,184,193,229,244,268,339,340,342,366,428,432,446,449,461,463,472],decim:[35,54,58,62,84,91,106,109,156,161,168,179,184,223,227,228,241,253,258,260,261,265,267,275,290,292,310,320,321,345,346,347,355,366,367,375,384,385,416,426,431,440,441,442,445,451,456,461,462,463,465,472,473],decimal_point:[265,346,472],decimalexcept:187,decimaltupl:187,decinteg:431,decis:[93,104,105,107,158,254,355,373,432,446,456,460,461,463,466,467,472],decistmt:375,deck:[161,320],decl:241,declar:[5,18,30,31,52,53,57,62,64,65,74,79,81,82,84,90,91,92,93,95,99,104,109,118,140,168,170,171,173,177,182,192,227,241,252,254,257,267,292,301,316,332,340,342,346,354,382,385,400,406,407,408,410,412,413,423,424,425,432,435,436,444,459,461,462,463,466,467,468,469,470,471,472],declassifi:106,declhandl:412,declin:468,deco:460,decod:[13,22,30,54,58,60,62,78,79,104,105,109,123,129,135,137,138,143,144,146,147,176,177,190,197,198,200,201,202,203,204,205,207,209,210,214,218,227,236,245,252,253,257,269,285,288,293,298,301,302,336,338,339,342,343,346,350,355,359,360,363,374,375,391,392,396,404,416,424,428,431,442,447,451,456,458,460,461,462,463,464,465,466,467,468,469,470,472],decode_data:[336,469,470,472],decode_func:456,decode_head:[203,288,467],decode_param:210,decode_rfc2231:210,decode_sourc:[252,468],decodebyt:[144,159],decoded_seq:203,decoded_str:203,decodedgener:[202,470,472],decodefsdefault:95,decodestr:[144,319],decompos:[5,86,99,384,391,472],decomposit:[86,384],decompress:[62,121,147,151,159,219,235,398,406,421,447,461,466,467,469,470,472],decompressobj:421,decompressor:[151,269,421,472],deconfigur:103,deconstruct:5,decor:[62,93,104,118,140,142,161,162,177,188,212,227,228,252,254,317,323,346,355,363,385,417,423,424,426,427,461,463,464,466,467,468,471,472,473],decorated_foo:104,decorator_list:124,decoupl:[448,469,471],decreas:[3,7,184,190,237,258,367,456,460,463,467,470,472],decref:[31,57,58,472],decrement:[5,7,9,31,47,57,58,79,82,84,91,139,284,299,334,366,373,424,472],decrib:472,decrypt:[267,343,419],dedent:[122,248,365,374,375,423,427,431,472],dedic:[30,62,81,104,168,193,236,343,346,363,472],deduc:[57,176,193,284,310,455,466],deed:106,deem:[54,93,96,208,232,266,268,346,382,404,422,456,457,461,463,466,467,468],deep:[62,66,74,93,104,161,183,252,253,301,309,332,355,407,447,472],deepchainmap:161,deepcopi:[91,161,172,321,387,463,470,471,472],deeper:[98,110,161,168,184,192,193,309,347,355],deepli:[103,172,363,386,406,431,448,456,462,472],def:[7,16,21,31,41,60,62,77,78,79,82,85,90,91,93,95,97,98,99,103,104,106,107,108,109,111,113,118,122,124,125,126,128,129,131,134,135,136,137,138,139,140,141,142,143,149,150,151,157,161,162,167,168,170,171,173,174,177,182,184,187,189,190,193,201,204,212,217,227,228,230,232,236,237,241,244,246,248,251,252,254,258,260,261,266,267,275,284,289,291,292,297,301,311,314,316,318,320,321,322,323,327,330,332,333,334,337,339,340,342,343,344,346,347,354,355,359,362,363,365,366,368,370,375,377,378,380,381,382,385,386,387,396,397,399,404,408,410,416,417,418,419,423,424,425,426,427,431,432,436,437,439,446,447,448,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],def_buf_s:421,def_mem_level:421,def_prog_mod:178,def_shell_mod:178,default_account:161,default_buffer_s:[227,257,350],default_bufs:409,default_charset:196,default_class:204,default_domain:287,default_exception_handl:[129,132],default_factori:[161,182,472],default_format:[359,470],default_ignor:[217,468],default_logging_config_port:267,default_mod:177,default_msec_format:266,default_nam:[268,424],default_namespac:[410,463],default_open:392,default_pip:211,default_protocol:301,default_sect:168,default_tcp_logging_port:[104,267],default_tim:368,default_time_format:266,default_udp_logging_port:267,default_valu:[16,95,96],defaultact:472,defaultalluserstargetdir:455,defaultcontext:[187,467],defaultcookiepolici:[62,255,472],defaultcustomtargetdir:455,defaultdict:[62,93,183,346,382,461,466,472],defaultdir:282,defaulteventlooppolici:134,defaulthandl:316,defaulthandlerexpand:316,defaultjustformetargetdir:455,defaultobj:21,defaultsect:168,defaultselector:330,defaulttest:[385,468],defaulttestload:385,defaulttestresult:385,defaultverifypath:343,defaultwidgetsizetestcas:385,defcount:60,defeat:[91,106,397,424,472],defect:[62,195,197,204,206,208,209,285,460,467,471,472],defend:472,defenestr:437,defer:[57,62,79,103,129,193,247,257,268,279,342,343,370,457,462,472],defghi:162,defi:459,defici:[1,351,398],defin:[3,4,5,7,10,13,14,22,23,26,28,30,31,38,39,40,41,46,52,53,54,57,58,62,64,65,68,69,74,77,78,79,80,83,84,85,86,90,92,93,95,96,97,98,99,103,104,105,106,108,109,110,111,117,118,119,120,122,123,124,125,128,129,134,135,142,143,144,145,147,148,152,153,155,156,157,159,161,162,163,167,168,169,170,172,173,174,176,177,178,180,182,184,185,187,188,190,193,195,197,200,204,206,209,212,213,214,216,217,222,225,227,228,229,232,234,235,236,237,239,240,241,242,243,244,245,246,248,249,250,251,252,254,256,257,258,260,261,262,264,265,266,268,271,274,275,276,284,287,288,289,290,291,293,295,297,299,301,303,304,305,306,307,308,309,311,312,314,316,318,319,320,321,322,324,325,326,327,329,330,332,333,334,336,337,339,340,341,342,343,344,345,346,347,348,349,350,351,352,353,355,356,357,359,361,362,363,366,367,368,370,372,373,374,376,377,379,380,381,384,385,386,387,390,391,392,394,395,396,397,398,399,400,402,404,405,407,408,410,411,412,416,418,419,420,423,424,425,426,428,430,431,432,434,435,436,441,443,445,446,448,451,456,457,458,459,460,461,462,463,464,465,467,468,469,470,471,472,473],define_macro:[65,74,77,418,456],definit:[12,28,30,31,35,41,52,53,54,57,62,65,67,74,79,80,81,82,91,93,95,97,102,106,118,122,144,145,152,159,162,170,177,178,182,184,212,222,227,228,232,239,248,251,252,253,254,255,266,268,273,282,284,289,292,301,310,314,315,317,326,337,346,347,353,355,360,365,367,374,380,381,382,384,385,392,395,399,405,406,407,408,411,422,424,425,426,428,429,430,431,432,437,441,446,457,458,459,460,461,462,463,464,466,467,468,469,471,472],deflat:[418,421,472],defmacro:99,defparamet:423,defpath:[293,333,472],defragresult:[391,466,472],defragresultbyt:[391,472],defstat:458,defunct:30,defusedexpat:[62,273],defusedxml:[62,273],deg:459,dega:305,degener:346,degrad:[178,466,472],degre:[79,157,178,275,345,346,380,424,459],deiconifi:248,deili:[463,466,468],deiniti:178,del:[36,45,49,53,62,79,82,91,98,124,161,179,190,197,206,227,232,237,248,254,271,284,291,292,293,297,301,331,346,386,399,423,424,425,426,427,428,429,431,436,441,448,456,457,459,461,462,463,466,472],del_param:[197,206],del_stmt:[427,432],delai:[22,62,90,97,104,128,131,140,178,246,248,254,268,284,288,327,334,339,343,380,387,392,393,424,446,462,466,470,471,472],delattr:[227,436,446],delawar:343,delay_output:178,delayfunc:327,delayfunct:467,delayload:244,delch:178,dele:307,deleg:[38,62,103,104,141,190,227,228,266,267,268,275,289,301,326,385,387,424,426,428,464,466,470,472,473],delet:[6,34,45,47,49,53,54,57,58,62,79,81,82,84,93,95,98,101,104,106,110,114,118,124,141,145,161,168,176,178,179,180,182,185,188,189,190,197,201,206,207,214,219,225,227,237,248,249,252,268,271,284,291,293,299,307,331,333,335,342,344,346,351,355,361,363,366,370,373,380,392,396,397,399,402,404,418,421,423,424,428,431,432,434,436,438,453,455,458,459,461,462,463,464,465,466,468,471,472,473],delete_attr:190,delete_deref:190,delete_fast:190,delete_glob:190,delete_nam:190,delete_nth:161,delete_subscr:190,deleteacl:[249,460],deletefilehandl:370,deletekei:402,deletekeyex:[402,463],deleteln:178,deletem:145,deletesomethingdb:385,deletevalu:402,delfino:472,delhallt:472,deliber:[89,91,93,95,122,292,307,346,381,385,451,468],delic:[30,57],delici:212,delight:90,delimit:[30,54,62,65,84,91,93,95,106,107,153,168,176,193,202,239,248,249,271,288,292,301,321,322,346,347,350,370,375,391,429,448,455,459,466,472],delin:467,delitem:291,deliv:[103,110,135,184,227,329,334,337,373,387,392,426,437,462,472],deliver_challeng:284,deliveri:[197,201,206,208,271,293,320,334,339,472],deloc:[265,469,472],delphi:84,delta:[19,62,109,143,184,190,242,253,269,364,385,458,460,463,470,472],delx:[98,227],demain:462,demand:[38,58,168,284,292,386,455,469,472],demey:[470,472],demian:[469,470,472],demis:437,demo:[62,77,94,104,106,178,224,248,404,408,417,447,459,462,466],demo_app:404,demonstr:[72,77,79,81,94,96,97,104,106,107,118,122,142,151,177,187,212,222,243,245,248,279,284,292,309,321,322,333,342,370,376,377,380,385,393,410,426,436,437,438,445,447,455,457,466,472],demot:472,demur:[470,472],den:472,dengler:472,deni:[140,213,340,424,459,472],denial:[406,424,451,472],denmark:456,denni:320,denomin:[187,223,289,346,440,462,470],denorm:472,denot:[5,42,56,62,86,91,106,168,190,245,246,254,258,293,324,343,346,370,382,392,424,426,428,431,436,437,438,456,462,471],denver:472,dep_util:71,depart:[161,227,346],depend:[5,6,13,17,30,31,41,48,57,58,62,64,66,71,74,77,78,79,81,83,84,85,87,89,90,91,92,93,95,97,98,99,103,104,106,107,108,109,111,112,117,123,129,133,135,140,141,145,152,153,157,159,165,168,169,174,177,178,182,184,187,189,190,192,193,196,206,209,211,212,214,216,222,225,227,229,232,235,236,243,244,245,248,252,254,255,257,258,260,265,266,267,268,269,271,275,280,282,284,288,293,301,310,311,312,317,318,320,321,324,329,330,331,333,334,337,339,340,342,343,344,345,346,347,348,349,350,351,355,356,357,359,360,361,362,363,365,367,368,370,373,380,385,386,387,392,395,396,398,399,402,403,404,410,412,416,418,421,424,425,426,428,431,432,436,439,442,446,448,450,451,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,471,472],deplet:386,deploi:[203,241,370,404,453,466],deploy:[90,103,293],deposit:466,deprec:[5,15,26,28,30,35,38,41,44,45,49,51,52,54,57,62,74,75,94,96,112,113,116,118,123,125,129,139,140,141,144,151,153,159,168,177,185,188,194,199,200,206,208,214,219,220,222,223,225,227,232,234,238,243,244,248,249,251,252,254,258,261,265,266,270,288,292,301,304,305,306,307,316,324,329,333,336,337,339,343,346,348,351,352,355,363,367,370,372,373,380,392,394,396,397,398,410,419,426,428,455,457,458,461,464,472,473],deprecationwarn:[22,62,106,214,349,363,385,397,424,426,428,431,446,457,459,463,466,468,469,470,472],dept:[436,465,466],depth:[22,103,124,164,168,178,180,185,190,197,206,214,227,236,269,301,309,323,346,355,359,363,372,385,409,410,436,437,441,456,457,458,469,470,471,472],dequ:[62,183,260,318,382,399,426,438,448,460,461,462,463,466,469,470,472],deque_clear:472,dequeu:[104,268,472],der:[343,395,462,468,472],der_cert_byt:343,der_cert_to_pem_cert:343,deref:472,derefer:[284,359,472],dereferenc:[14,177,229,399,467,472],deregist:284,derek:[463,465],deriv:[22,30,45,56,62,66,70,82,84,93,98,111,118,122,124,145,158,159,161,167,175,177,178,179,182,183,184,198,200,202,203,204,214,222,227,228,232,241,245,249,251,252,254,257,261,266,267,272,288,292,293,294,310,312,314,315,316,329,340,343,347,380,382,385,390,392,395,397,404,405,408,413,416,417,422,424,431,436,439,456,459,460,461,462,463,464,467,468,470,471,472],derivedclassnam:436,derivednumerictyp:346,dershowitz:[152,184],derwin:178,desc:[55,69,282,288,465],descend:[62,103,118,124,164,197,206,254,266,284,310,344,358,373,407,408,410,436,461,463],descr:[20,96,98,177],descrgetfunc:[57,81],describ:[1,5,7,12,15,20,22,23,28,29,31,38,41,45,46,53,54,55,56,57,58,60,62,65,66,69,71,73,75,78,79,80,81,82,83,84,86,91,93,97,99,101,102,103,104,109,110,111,112,113,117,119,120,121,122,125,129,138,144,145,146,152,153,154,159,161,165,167,168,170,175,176,177,178,181,182,183,185,187,188,189,190,193,195,196,197,203,204,209,212,214,217,218,220,222,224,225,226,227,232,236,238,243,245,246,247,248,249,250,251,252,253,254,255,256,257,258,259,265,266,267,268,271,276,277,278,281,282,285,288,289,290,292,293,295,297,300,301,308,310,314,316,317,318,319,321,323,324,326,329,333,336,337,338,339,342,343,344,346,347,349,350,352,355,358,361,364,366,370,372,373,380,382,385,386,388,391,392,394,396,401,402,403,404,405,407,411,413,416,418,419,420,421,423,424,426,427,428,429,430,431,432,433,436,437,438,441,442,444,445,446,451,455,456,457,458,459,460,461,462,463,465,466,467,468,469,470,471,472],descript:[1,5,22,23,31,48,53,58,62,65,66,67,69,74,75,77,79,80,94,97,98,101,103,111,114,119,120,125,140,141,143,161,167,172,176,177,178,183,189,190,193,197,201,202,203,206,213,216,232,242,246,251,252,254,258,265,266,267,269,273,279,288,292,293,295,297,299,302,306,309,315,324,333,334,339,342,343,346,349,351,357,360,361,362,363,367,370,372,373,378,380,385,396,397,398,405,411,412,416,417,424,425,426,430,432,437,441,451,455,456,457,458,459,460,461,463,464,465,466,468,469,471,472],description_content_typ:309,description_unit:472,descriptor:[15,22,23,28,30,45,57,62,81,84,87,90,93,100,101,118,120,132,133,135,137,141,177,178,186,188,212,213,216,219,227,228,249,254,257,267,279,283,284,294,295,311,314,324,329,330,334,339,340,343,346,350,359,360,361,362,363,370,379,381,423,426,432,460,461,462,463,466,467,469,471,472],descriptor_typ:254,descriptortyp:472,descrobject:98,descrsetfunc:[57,81],deseri:[261,301,442,463,468,470,472],deserv:[271,446,456],design:[7,31,62,64,65,66,82,86,88,90,91,93,95,98,99,103,104,105,107,109,110,111,112,131,133,136,138,139,140,147,149,154,159,161,168,170,178,184,187,190,191,193,195,202,211,212,227,228,230,232,236,238,248,251,252,253,271,274,292,293,296,301,310,318,319,325,328,339,342,343,359,363,366,370,372,380,382,386,391,404,414,416,421,428,435,436,438,446,448,456,457,458,459,460,461,462,463,464,466,467,468,471,472],desir:[7,9,22,30,31,38,79,80,84,91,97,99,103,104,106,109,111,122,138,140,159,161,168,170,177,178,189,190,209,212,213,222,225,227,236,237,241,251,252,257,258,265,266,271,272,276,279,292,294,299,309,313,320,321,322,336,340,343,346,347,363,365,366,370,372,373,380,399,402,409,413,424,426,428,437,438,439,446,451,455,456,458,459,460,461,462,463,468,469,470],desk:[103,435,445],desktop:[66,74,87,92,109,400],despit:[78,91,93,107,236,261,343,428,447,462,472],dest1:[167,466],dest2:[167,466],dest3:[167,466],dest4:[167,466],dest:[62,94,104,120,201,230,268,279,292,311,333,342,396,459,461,462,463],dest_nam:65,destdir:164,destin:[62,65,95,103,109,178,209,213,266,267,268,271,279,292,293,333,339,346,357,396,460,462,467,468,472],destroi:[5,10,30,55,57,61,84,99,107,248,257,279,292,347,361,366,370,385,397,399,402,424,428,442,456,458,459,461,466,470,471,472],destruct:[30,79,81,157,178,254,257,346,361,424,457,466],destructor:[10,30,57,81,82,84,90,93,96,117,293,318,350,424,432,465,466,470,472],destwin:178,detach:[134,151,257,269,293,339,343,373,399,402,466,467,472],detached_process:350,detail:[1,12,16,17,29,30,41,50,52,57,58,60,62,64,65,66,70,74,77,78,79,80,82,83,84,85,86,90,91,92,93,94,97,98,99,100,101,103,104,106,109,110,111,113,120,122,124,128,129,131,132,135,137,138,140,143,145,148,150,153,154,159,169,170,171,173,174,176,177,178,184,186,187,189,190,192,193,195,197,202,206,208,212,214,216,227,232,235,238,242,246,247,248,251,252,254,257,258,261,264,266,268,269,271,272,274,275,282,284,290,292,293,297,301,302,318,320,321,322,324,326,328,332,337,339,340,342,344,346,347,349,350,355,357,359,360,363,365,366,370,377,381,382,385,386,391,392,393,396,397,399,402,404,407,410,412,416,418,419,423,424,425,426,428,429,430,431,432,434,435,436,438,439,440,442,445,446,448,450,451,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],detect:[22,26,31,38,54,57,62,65,69,79,81,82,84,91,93,95,99,106,107,110,113,118,135,141,142,159,162,176,177,178,182,184,187,190,195,204,214,227,248,252,253,263,271,275,292,293,294,295,298,301,309,316,322,323,332,337,339,342,346,355,363,365,366,375,378,385,390,392,400,404,424,425,426,431,433,439,451,455,456,457,458,459,462,463,466,468,469,470,471,472],detect_api_mismatch:363,detect_encod:[264,375],detect_languag:65,detect_modul:472,detect_typ:342,detector:[3,56,79,254,463],determin:[1,3,5,7,10,21,22,31,36,45,49,55,57,62,65,74,79,81,82,91,93,97,102,103,104,105,106,107,108,109,111,122,123,129,135,137,141,145,153,156,158,159,160,161,162,176,177,178,180,182,184,185,187,189,190,193,198,204,209,212,214,216,227,232,243,248,249,252,253,254,258,262,265,266,267,268,269,271,272,275,278,280,284,286,292,293,294,295,297,298,299,301,305,309,310,313,316,320,321,322,323,329,331,332,333,334,336,339,342,346,347,348,349,350,355,356,357,359,362,367,368,370,373,375,380,385,392,395,397,402,407,412,418,421,423,425,426,428,430,431,432,436,437,438,439,446,455,458,459,461,462,463,465,466,467,468,469,471,472],determinist:[62,106,186,252,254,320,339,360,466,471,472],detlef:[456,459],detract:469,detriment:91,dev:[62,85,86,101,104,128,129,188,228,231,268,271,272,293,295,309,334,350,355,356,434,451,453,456,457,458,459,460,461,462,463,466,467,469,472],dev_mod:[355,451,472],dev_stag:305,dev_t:472,dev_team:267,devel:[85,101,288],develop:[0,1,30,62,64,66,71,72,74,81,83,84,87,89,91,92,93,95,97,101,103,104,105,106,109,111,112,126,129,153,162,165,170,177,186,187,214,236,253,263,266,267,268,292,296,309,315,342,350,363,369,370,372,380,382,397,416,419,422,435,437,441,447,451,453,454,455,457,458,459,460,461,463,464,466,467,468,469,472,473],developerwork:99,devguid:[94,427,468],deviat:[58,105,320,345,368,391,466,467,468,472],devic:[60,62,65,87,93,102,133,159,178,179,213,222,227,237,248,253,257,268,278,293,294,296,298,329,330,333,334,339,344,350,355,359,402,410,433,444,451,456,462,472],device_encod:293,device_id:339,devin:[469,472],devis:320,devnul:[138,284,293,334,350,467],devop:472,devot:[91,106,428,452],devpol:[329,330,467,468,469,472],devpollselector:[330,469,471],dez:184,dezemb:184,df924a2b08a7e89f6e11251d4602022977af2670:101,dfa:472,dfballer:197,dfff:159,dfile:313,dfoo:65,dfunc:189,dgettext:[232,265],dhfile:343,dhiru:468,diaeresi:159,diagnos:[84,91,103,297,385,387],diagnosi:472,diagnost:[30,62,81,103,286,358,386,404,416,418,452,466,470],diagon:109,diagram:[69,103,193,227,237,340,428,458],dialect:[62,218,342,459,461,466],dialog:[83,97,248,282,292,363,370,372,380,455,468,469,470,471,472],diamant:472,diamet:380,diamond:[62,178,212,227,424,436],dice:207,dichotomi:105,dickinson:[462,463,465,466,467,468,469,470,471,472],dict1:462,dict2:462,dict:[5,21,22,28,31,49,54,57,62,79,84,85,90,91,93,95,98,99,113,122,124,129,161,168,172,176,182,183,184,185,188,189,190,193,206,227,228,229,245,252,253,254,260,261,266,267,268,284,288,291,301,306,328,331,343,347,363,366,373,381,382,385,399,410,416,424,426,437,438,442,446,448,451,456,458,459,460,461,462,463,464,465,466,467,468,469,471,472],dict_comprehens:426,dict_displai:426,dict_factori:[182,342],dict_fromkei:98,dict_kei:[228,463],dict_siz:269,dict_typ:[168,306],dictat:[7,93,168,224,227,301,436,455,456,462],dictcomp:124,dictconfig:[62,103,267,463,466,472],dictconfigclass:267,dictconfigur:267,dictionari:[5,15,20,22,25,28,30,31,38,41,45,48,53,54,57,58,60,62,65,74,79,81,82,90,91,93,98,99,103,108,110,113,117,120,122,141,153,158,159,161,168,172,174,176,177,182,184,185,187,188,190,193,196,197,201,202,203,204,206,207,208,212,213,214,217,225,227,228,229,232,237,240,243,245,246,251,252,254,258,261,265,266,268,269,271,272,274,276,280,284,286,287,288,291,292,293,299,301,302,306,307,308,309,310,314,316,321,326,327,328,331,336,337,342,343,347,348,350,353,355,356,359,363,366,370,372,373,374,376,377,380,382,385,386,390,391,392,397,399,404,410,413,414,421,423,424,425,432,435,436,437,441,442,448,451,456,457,458,459,460,461,462,464,468,469,470,471,472,473],dictitems_contain:472,dictmixin:459,dictobject:[98,461,472],dictoffset:57,dictorsetmak:427,dictproxi:472,dictread:[176,470,472],dictview:[93,346],dictwrit:[176,466,472],did:[1,82,90,94,95,104,105,106,107,110,130,140,167,168,193,203,244,284,286,292,293,316,321,330,342,343,350,355,361,378,382,385,392,412,438,445,456,457,458,466,467,468,471,472],didn:[82,85,91,94,95,96,105,106,109,141,170,292,321,337,342,387,436,456,457,458,460,461,462,463,468,471,472],die:[62,329],died:472,diederich:[461,465],diego:461,dierk:343,dies:[97,399,472],dietmar:457,diff:[105,113,144,189,193,385,457,460,463,466,472],diff_byt:[189,469,472],diff_fil:217,differ:[9,14,30,31,38,41,53,57,58,60,62,65,66,70,72,74,77,78,79,80,81,82,84,85,86,89,90,92,93,94,95,96,97,98,99,102,103,104,106,107,108,109,110,111,113,122,123,124,125,128,129,130,131,133,134,135,138,139,140,141,143,153,156,157,158,159,160,161,162,167,168,170,172,174,175,176,177,178,183,184,186,187,193,196,197,203,204,206,209,215,217,224,225,227,228,232,237,238,243,244,246,248,251,252,254,256,257,258,260,261,265,266,267,268,269,271,272,274,275,276,279,282,284,289,291,292,293,294,295,296,297,298,299,301,304,305,310,315,316,318,320,321,322,323,324,329,331,332,334,337,339,340,342,343,345,346,347,349,350,355,356,359,361,363,364,365,366,367,368,370,372,373,377,381,382,385,386,387,391,392,398,402,404,407,408,417,419,421,423,424,425,426,428,430,431,432,436,437,438,439,440,442,445,446,447,448,449,451,452,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],differen:472,differenc:[466,472],difference_upd:[346,462],differenti:[187,322,392,466,467,470],diffi:[343,467],difficult:[64,70,74,82,86,90,97,99,103,105,106,109,122,141,237,267,301,338,392,399,448,456,457,458,459,460,463,466,472],difficulti:[84,105,284,456,459],difflib:[62,146,193,217,253,364,457,458,460,461,462,463,468,472],dig:355,digest:[62,94,175,197,205,206,238,253,284,307,343,392,461,463,464,466,467,468,471,472],digest_s:[236,238,468],digestmod:[236,238,468],digicert:343,digicertsha2extendedvalidationserverca:343,digit:[31,35,54,58,69,84,91,106,107,109,119,143,144,147,156,159,161,174,179,184,187,193,223,225,227,236,238,245,258,265,267,275,288,293,321,323,328,343,346,347,355,367,368,370,375,384,385,391,392,395,421,422,431,440,456,460,461,462,463,464,465,466,468,470,472],digitpart:431,digits_r:321,dijkstra:366,dim:[124,178],dima:460,dimens:[7,177,178,333,346,462,467],dimension:[7,93,204,320,346,372,380,467,469,472],diminish:112,dimitri:472,ding:292,dingyuan:472,dino:470,dionn:460,dir1:217,dir2:217,dir:[45,62,65,66,67,68,74,84,86,91,111,113,164,185,211,212,225,227,265,292,293,294,325,346,350,359,361,376,386,396,419,424,441,447,459,462,466,467,472],dir_fd:[227,293,467],dir_util:71,dircach:[460,462],dircmp:[62,220,456,461,468],direct:[15,30,31,45,58,62,64,65,78,79,84,95,98,102,104,111,112,113,117,124,150,152,159,161,170,177,184,187,188,206,219,222,227,248,252,292,293,308,309,310,316,343,346,355,361,365,366,367,368,373,380,392,407,410,414,422,424,426,428,432,438,442,447,448,455,456,458,459,461,462,463,466,467,468,469,470,471,472,473],directive_opt:193,directive_option_nam:193,directli:[7,12,26,28,30,38,41,42,53,54,57,58,61,62,65,66,70,74,78,79,81,82,86,89,90,91,92,93,95,98,101,102,103,104,105,108,110,112,118,122,128,134,135,137,140,147,150,151,153,159,160,161,164,167,168,170,172,176,177,182,184,187,189,190,192,193,195,197,202,206,207,210,211,212,213,214,222,223,227,228,229,236,237,243,246,248,251,254,257,258,261,265,266,267,269,271,279,281,292,293,294,295,301,304,308,310,320,321,322,326,331,337,339,340,342,343,346,347,350,355,359,361,363,366,370,371,372,373,376,377,381,382,385,386,387,392,397,399,404,407,410,411,414,418,424,425,426,428,430,432,434,436,437,438,439,446,447,448,451,455,456,458,459,461,462,463,464,465,466,467,468,469,470,471,472],director:392,directori:[30,31,62,66,68,69,70,71,72,74,75,77,79,81,82,84,85,90,91,92,93,94,95,99,101,109,111,113,120,138,153,154,164,168,178,185,189,193,201,211,213,214,221,225,227,232,233,246,248,249,251,252,253,271,280,284,286,288,292,294,298,299,304,308,312,313,314,315,322,326,332,335,342,343,344,350,355,356,358,359,363,370,372,376,380,385,392,396,399,400,401,418,419,420,422,428,434,441,443,444,447,449,451,454,455,456,457,459,460,461,463,464,465,467,468,470,471,472,473],directory_cr:66,directorytestcas:472,dirent:293,direntri:[293,469,470,472],dirfd:293,diritta:461,dirk:342,dirlist:372,dirnam:[95,225,271,293,294,298,304,363,385,471],dirpath:293,dirselectbox:372,dirselectdialog:372,dirsonsyspath:363,dirti:106,dirtre:372,dirtyp:359,dis:[62,93,253,263,302,355,470,472],disabl:[22,30,31,65,66,75,79,103,104,106,111,113,122,129,132,145,153,168,176,178,187,189,193,212,215,219,225,227,228,229,243,248,254,257,266,267,268,284,288,292,293,299,301,310,321,322,329,332,334,335,337,339,341,342,343,346,350,355,363,370,373,380,385,386,392,397,402,424,428,434,451,455,456,457,458,459,460,461,462,463,465,466,467,468,469,470,471,472],disable_existing_logg:[103,104,267],disable_faulthandl:363,disable_gc:363,disable_interspersed_arg:[122,292],disable_nagle_algorithm:463,disabled_by_com:168,disablereflectionkei:[402,462,463],disablesev:329,disadvantag:[79,82,90,91,106,159,187,343,368,458,465],disagr:84,disagre:[99,375,392,456],disallow:[5,84,122,168,212,293,339,342,346,420,455,462,468,471,472],disambigu:[10,35,62,184,426,431,472],disappear:[79,81,92,103,107,458,460,472],disassembl:[62,253,263,302,468,471,472],disc:380,discard:[9,31,34,45,50,58,60,79,95,99,107,125,129,144,153,158,159,161,162,184,187,244,257,266,267,271,284,286,292,298,336,339,346,362,373,385,397,399,408,410,413,423,424,445,451,458,461,462,463,468,470,472],discard_buff:125,discern:235,disciplin:[84,209],disclaim:[225,288,351,398,422],disco:190,disconnect:[62,307,337,342,402,472],discontinu:[367,392],discourag:[74,99,106,140,159,182,195,227,252,288,321,343,361,363,424,458,461],discov:[105,107,115,184,197,206,245,363,385,412,457,458,459,463,466,468,472],discover:[314,468,472],discoveri:[62,188,193,337,416,466,468,469,472],discret:[39,175,222,278,340,345],discuss:[15,30,31,78,79,80,86,91,99,106,109,110,111,172,182,189,204,209,232,257,266,267,275,288,293,321,331,343,345,373,385,387,392,407,416,421,426,428,431,436,438,442,456,457,458,461,462,463,465,468,470],disentangl:99,disguis:[308,321,424],dish:346,disjoint:346,disjunct:343,disk0s2:463,disk:[90,93,99,103,109,170,185,195,201,209,214,220,227,237,244,248,257,264,268,271,279,282,288,293,295,300,301,324,331,333,342,350,355,361,378,402,419,459,461,462,464,467,472],disk_usag:[333,467],dislik:[110,386],dismiss:248,disobei:464,dispar:209,dispatch:[62,84,90,91,93,103,104,107,122,125,141,145,157,178,198,228,246,300,310,323,336,385,416,465,466,468,472],dispatch_:145,dispatch_cal:145,dispatch_except:145,dispatch_lin:145,dispatch_return:145,dispatch_t:[173,301,467],dispatcher_with_send:141,dispers:345,displai:[30,38,62,66,69,86,91,94,101,104,106,109,120,122,124,128,140,153,154,157,158,161,169,180,186,187,190,193,201,204,214,215,222,239,248,253,254,258,265,266,271,282,288,293,299,309,315,321,322,344,346,347,348,350,355,359,365,368,370,372,373,375,376,377,380,385,392,396,397,400,418,422,424,432,437,439,440,442,444,445,448,449,451,455,456,458,459,460,461,462,463,465,466,467,468,469,470,471,472,473],display_d:[129,140],display_failur:378,display_nam:[201,204,467],display_top:378,displaycolumn:373,displayhook:[355,446,457],displaymatch:321,displaystyl:472,dispos:[31,79,385],disposit:[197,198,204,206,249,293,334,397,404,469],disqualifi:466,disregard:[7,30,346],disrupt:[86,134],dissect:[106,256,457,458],dissect_can_fram:339,dissent:[93,456],dist:[66,69,70,71,269,298,305,380,418,461,466,469,472],dist_fil:70,distanc:[156,157,269,370,380],distant:[93,442],distb:[190,468],distclass:65,distclean:472,distcmd:70,distinct:[14,30,31,38,41,65,84,93,97,105,106,107,109,143,161,170,184,187,193,228,260,267,269,275,292,297,310,335,343,346,355,370,382,404,426,428,439,442,456,458,462,466,467,470,471,472],distinguish:[35,57,62,65,72,74,79,93,96,124,156,178,188,193,198,227,244,254,267,275,316,343,356,373,397,421,424,426,428,439,445,455,457,458,463,467,468,472],distnam:[111,305],distort:380,distpath:396,distract:[97,292,472],distribut:[0,28,30,31,60,62,68,72,73,79,80,81,83,86,87,89,90,91,92,93,96,106,111,112,126,127,136,178,187,189,192,210,232,236,253,271,275,284,290,297,304,305,342,345,353,356,359,374,380,385,411,418,422,441,446,449,450,452,454,455,456,457,459,461,462,463,464,466,468,469,470,471,472],distribution_nam:66,distributionmetadata:69,distributor:[72,343,470],distro:[305,454,472],disturb:[301,472],distutil:[62,64,66,68,69,71,73,74,75,80,82,83,92,112,191,253,282,335,356,396,418,451,453,455,457,461,462,463,466,472,473],distutils2:463,distutils_debug:[74,472],distutils_use_sdk:65,distutilsexecerror:65,distutilsfileerror:65,distutilsplatformerror:472,ditch:448,ditto:472,div:[124,187,241,409],dive:[91,95],diverg:[343,458],divid:[43,90,97,106,143,168,184,187,190,193,195,223,227,248,275,298,310,320,345,372,416,431,439,440,462,466,467,468,472],divide_int:187,dividend:[14,187],divin:210,divis:[43,58,60,62,91,93,104,114,147,184,187,214,227,291,346,424,425,426,432,439,445,459,460,462,463,466,472,473],division_warn:[355,466,467],divisionbyzero:[187,460],divisor:[14,187,223,275,445],divmod:[43,184,187,227,289,346,424,426,440,446,472],dixon:201,django:[104,161,299,386,463,467],djb:422,djbdn:225,djgpp:472,dklen:236,dl_export:459,dl_import:459,dle:179,dlfcn:[467,470,472],dlg:282,dlgclass:372,dll:[30,52,62,72,80,90,111,120,268,355,370,418,455,456,461,462,468,472],dllcanunloadnow:177,dllexport:[83,92],dllgetclassobject:177,dllhandl:355,dllname:[111,268],dlltool:111,dlltype:177,dlopen:[177,293,355,458,461,472],dmajor_vers:77,dmaxcol:178,dmaxrow:178,dmesg:350,dmincol:178,dminor_vers:77,dminrow:178,dmitri:[236,460,469,470,472],dmitrii:472,dml:[342,472],dname:65,dnd:370,dndebug:[77,78],dngettext:232,do_:[91,157,246],do_bar:[91,157],do_by:157,do_circl:157,do_clear:145,do_color:157,do_command:178,do_encod:96,do_foo:[91,157],do_forward:157,do_get:246,do_glob:436,do_goto:157,do_handshak:[343,468,469],do_handshake_on_connect:343,do_head:[157,246],do_help:157,do_hom:157,do_left:157,do_loc:436,do_my_adding_stuff:289,do_my_other_adding_stuff:289,do_nonloc:436,do_playback:157,do_posit:157,do_post:246,do_record:157,do_reset:157,do_right:157,do_setlocal:[265,451],do_shel:157,do_someth:[103,104,153,343,385],do_something_us:399,do_spam:246,do_stuff:423,do_undo:157,do_work:318,dobb:189,doc:[1,22,53,55,68,77,81,82,85,86,91,94,96,98,105,106,110,177,195,206,225,227,243,248,254,257,261,293,298,315,343,355,368,370,381,383,391,400,402,409,410,448,450,454,456,458,459,461,462,463,466,470,471,472],doc_fil:68,doc_head:157,doccgixmlrpcrequesthandl:[62,255],docfilecas:193,docfilesuit:[193,461],docfiletest:472,dock:[248,472],docleanup:[385,463],docmd:337,docs_url:309,docserv:472,docstr:[22,25,41,53,55,57,60,62,81,90,93,95,104,124,157,161,188,224,227,228,248,254,299,315,333,363,375,381,382,385,404,423,431,432,436,437,447,451,456,457,458,459,460,461,462,463,466,468,469,470,471,472],docstring_definit:95,docstring_prototyp:95,docstringdict:380,doctest:[62,84,90,91,99,108,113,161,173,177,184,188,225,227,253,258,288,343,363,367,375,377,378,385,391,399,447,457,459,461,463,465,466,467,472],doctestcas:193,doctestfailur:193,doctestfind:[62,188,460],doctestpars:[62,188],doctestrunn:[62,188,460],doctestsuit:[193,385,459,469,472],doctyp:[110,241,243,316,392,407,410,466,472],doctypenam:316,document:[17,19,22,23,26,29,31,38,41,50,52,53,57,58,63,64,65,66,71,72,73,74,76,77,78,79,80,81,82,83,85,87,91,93,94,95,96,97,98,100,102,103,104,105,106,108,109,110,111,112,113,114,117,122,123,124,127,129,132,135,137,138,140,141,145,146,150,153,157,161,168,170,177,178,182,183,184,188,189,192,193,195,196,197,199,203,204,206,208,209,214,221,223,226,227,228,232,236,242,244,248,249,251,252,253,254,255,257,258,261,265,266,267,268,271,272,273,282,283,284,285,290,292,293,295,296,299,306,308,311,316,324,331,332,337,339,340,342,343,344,346,350,355,359,362,363,364,365,366,367,369,370,372,373,380,383,385,391,392,397,400,402,406,408,409,411,412,413,414,416,419,420,421,422,424,426,428,430,431,432,434,435,439,441,443,446,447,449,450,452,453,454,455,456,457,458,459,460,461,464,465,469,470,473],document_nod:407,document_type_nod:407,documentel:[407,408,456],documentfactori:409,documenthandl:[412,413],documenttyp:[62,273],docutil:[0,69,74,462],docxmlrpcrequesthandl:417,docxmlrpcserv:[62,255,459,461,462,464],dodg:460,doe:[3,5,9,21,22,28,29,30,31,34,38,41,45,47,49,50,52,53,54,55,57,58,60,61,62,64,65,66,69,75,78,79,81,82,83,90,93,94,95,97,98,99,102,103,104,105,106,107,108,110,111,112,117,118,122,125,129,133,135,138,140,142,144,149,151,153,155,158,159,161,162,164,168,170,172,176,177,178,180,182,184,185,187,189,190,193,195,196,197,198,199,201,202,203,204,206,208,209,211,212,214,221,222,223,225,227,228,229,230,232,235,237,241,243,244,245,246,248,251,252,254,256,257,258,260,261,265,266,267,268,269,271,274,276,279,284,288,291,292,293,294,295,297,298,299,301,302,303,304,305,308,310,311,313,316,320,321,324,329,331,332,334,337,339,340,342,343,344,345,346,347,349,350,351,354,355,357,359,361,363,365,366,367,370,373,376,377,378,381,382,385,386,387,391,392,395,396,397,398,399,400,402,403,404,407,408,409,410,411,412,414,416,417,418,419,420,422,423,424,425,426,428,431,432,433,436,437,438,439,441,444,445,446,448,451,453,455,456,457,458,460,461,462,463,464,465,466,467,468,469,470,471,472],doerwald:462,does_esmtp:337,does_that_mean_anything_speci:168,doesn:[5,7,17,21,22,28,30,31,39,44,51,57,62,65,66,72,74,75,78,79,82,83,85,87,91,95,97,99,102,103,104,105,106,107,109,110,111,113,122,124,135,145,152,153,159,170,174,176,177,184,185,193,197,199,201,206,212,214,215,227,228,236,237,244,245,248,257,258,261,265,266,289,292,293,298,299,301,304,307,316,318,320,321,324,325,329,331,333,334,335,336,337,339,341,342,343,345,346,347,350,355,363,366,367,368,370,380,381,384,385,386,387,393,397,402,404,406,416,420,421,422,424,426,428,437,442,444,445,446,449,454,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],dog:[106,161,212,321,436,466,469],doggi:321,dogwood:321,doing:[1,30,32,57,65,74,80,84,85,90,91,93,94,97,99,101,102,103,104,105,106,107,108,109,111,128,135,141,147,153,160,170,177,187,195,217,227,236,244,252,257,264,279,280,284,292,293,295,301,307,321,329,340,342,343,344,347,350,361,363,366,380,385,386,387,392,410,418,424,438,446,458,461,462,463,464,466,468,469,470,471,472],doit:122,dollarmessag:104,dolor:151,dom1:408,dom2:408,dom3:408,dom:[62,253,273,406,412,447,457,459,461,471,472],domain:[38,62,72,101,103,129,146,167,204,209,210,213,232,236,244,245,249,256,265,267,268,284,287,336,337,339,340,343,348,355,378,395,435,451,459,461,467,468,469,470,471,472],domain_initial_dot:244,domain_return_ok:244,domain_specifi:244,domainfilt:[62,186,470],domainliber:244,domainrfc2965match:244,domainstrict:244,domainstrictnodot:244,domainstrictnondomain:244,dombrova:472,domeventstream:[62,273],domexcept:[407,408],domimplement:[62,273],domin:[149,244],domreg:472,domstr:[407,408],domstring_size_err:407,domstringsizeerr:407,domtimestamp:408,don:[1,5,6,8,9,17,22,26,30,31,44,45,53,54,57,65,66,68,69,72,74,75,77,79,81,82,84,85,86,87,89,93,94,95,96,97,99,103,104,105,106,107,108,109,111,112,122,124,129,135,136,138,145,153,154,155,156,160,164,168,170,172,177,180,184,189,190,193,201,210,212,217,222,227,229,232,243,244,248,252,256,257,258,261,266,267,268,275,284,288,292,293,295,298,299,301,309,310,320,321,329,331,333,337,339,342,343,345,346,351,366,368,369,370,373,382,385,386,387,392,396,398,399,402,404,410,418,421,422,424,426,428,435,436,437,439,440,442,445,446,449,451,455,456,457,458,459,460,461,462,463,464,467,468,469,470,472],donald:[161,343,463,468],donat:[86,460],done:[1,5,7,13,28,30,31,32,43,45,49,50,53,57,58,60,65,66,74,75,77,78,79,81,82,85,90,91,92,94,95,97,99,101,102,103,104,105,106,107,109,110,111,112,122,128,129,131,135,137,140,143,153,157,159,160,167,168,174,176,177,178,184,185,187,190,193,197,201,205,206,209,210,217,227,231,233,235,236,237,246,248,251,252,257,265,266,267,268,279,284,288,292,293,295,298,301,310,311,316,318,321,340,342,343,346,347,350,355,359,360,361,362,363,367,368,372,373,380,381,382,386,387,392,396,397,399,405,408,409,410,411,418,424,426,428,432,435,436,437,442,444,448,455,456,457,458,459,461,462,466,467,468,469,470,472],done_queu:284,donec:151,donegan:472,dong:[292,472],donnel:458,donnellan:472,donni:142,donotsepar:332,dont:360,dont_accept_blanklin:193,dont_accept_true_for_1:193,dont_inherit:[227,468],dont_write_bytecod:[355,446,462,466],doodah:306,doom:[284,461],door:[110,122,344],dorais:313,dorfman:460,dorian:472,dormant:104,dorollov:268,dos:84,dose:109,doseq:391,dot:[22,28,57,65,82,93,95,96,98,101,103,104,106,111,193,227,233,244,248,251,252,258,260,265,266,267,271,276,288,291,298,315,321,325,339,346,355,359,361,370,374,380,385,386,387,417,419,420,424,428,430,432,436,443,444,446,451,462,465,469,472],dotal:[106,321],dotless:[106,321],dotproduct:260,dotted_as_nam:427,dotted_nam:[423,427],dotterbart:291,dotview:94,doubl:[5,14,17,24,31,35,53,57,58,65,81,82,84,85,91,93,95,104,106,112,123,153,159,161,176,177,193,210,236,248,249,261,268,275,284,291,293,298,321,332,346,347,349,350,360,386,396,405,414,416,422,424,426,431,434,438,440,445,453,455,459,460,461,462,466,467,470,471,472],double_revers:108,doublequot:176,doubleslash:374,doubleslashequ:374,doublestar:374,doublestarequ:374,doublestuff:245,doublevar:370,doubli:[31,57,91,463],doubt:[57,90,97,168,184,461],doubtless:[99,457,458,459],doug:[422,472],dougla:342,doupdat:[97,178,180],dove:[103,104],dower:[469,470,471],down:[31,68,74,78,82,91,92,93,99,103,105,107,111,129,136,137,142,153,161,178,180,190,193,213,237,246,248,266,284,293,299,310,318,321,329,339,340,343,355,370,373,380,385,391,436,440,448,451,456,458,459,463,469,470,471,472],downcast:[5,31],downgrad:244,download:[62,65,66,69,72,74,81,86,91,111,298,309,372,390,392,396,422,424,436,449,450,452,453,454,461,462,463,466,467,471,472],download_url:[65,74,309,461],downright:168,downsid:[258,455,467,471],downstream:472,downward:93,dozen:[74,447,462,466],dpi:[470,471,472],dpkg:460,dpy_build_cor:472,draft:[99,109,153,271,355,407,435,456,457,458,459,460,461,462,463,470,471,472],drag:[296,370,372,373,380,453,472],dragonfli:472,dragonflybsd:339,drain:[132,135,137,343,466,472],drake:[0,456,457,458,459,461,462],drallensmith:472,draoui:[469,472],drastic:[7,113],draw:[62,97,157,178,224,248,296,320,370,373,462,472],draw_doubl:462,drawabl:462,drawback:[199,292,471],drawn:[157,178,293,380],drbg_nopr_ctr_aes256:339,drive:[65,107,111,233,237,292,294,298,359,363,370,385,419,422,455,467,468,469,472],driven:[65,66,91,165,170,276,363,380,385,407,409,456,466,472],driver:[77,178,193,213,232,293,295,339,363,402,403,413,459,472],drmhze6epcv0fn_81bj:328,drop:[5,26,57,62,64,65,82,90,91,93,103,109,114,135,136,161,165,193,213,227,251,252,253,254,260,268,284,296,307,318,323,327,343,355,365,370,373,391,456,457,458,460,461,462,464,466,468,469,472],drop_whitespac:[365,462],dropdown:373,dropwhil:[99,260],drug:320,drum:106,drummer:106,drwx:333,drwxr:[94,225],dry:[65,70,292],dry_run:[65,333,363],dsa:466,dsaencrypt:466,dsawithsha:466,dsl:468,dsn:337,dsp:295,dst:[65,177,184,293,333,367,467],dst_diff:184,dst_dir_fd:293,dst_time:184,dstdiff:184,dstend:184,dstend_1967_1986:184,dstend_1987_2006:184,dstend_2007:184,dstname:[184,333],dstoff:184,dstoffset:184,dston:184,dststart:184,dststart_1967_1986:184,dststart_1987_2006:184,dststart_2007:184,dsu:108,dt1:184,dt2:184,dt3:184,dt_unknown:293,dtd:[110,241,316,392,406,411,412,413,471,472],dtdhandler:[62,273,413],dtdst:184,dtl:343,dtoa:[62,463],dtoff:184,dtor:96,dtrace:[62,100,472],dtrace_function_entri:101,dtrace_function_return:101,dual:[339,343,422,431,472],duan:472,dubiou:[214,397],duck:[93,462,468],due:[5,22,30,41,57,58,60,81,82,84,90,91,103,105,110,124,133,138,140,170,178,185,189,190,209,222,223,227,229,232,243,248,252,257,266,267,271,284,293,297,301,305,316,327,342,343,346,350,366,385,386,423,424,426,428,437,455,456,457,460,462,463,464,466,467,469,470,471,472],duid:472,dum:85,dumb:[62,66,71,107,300,360,469,470,471,472],dumbdbm:[185,464],dumbwrit:222,dummi:[12,62,79,165,177,189,232,270,293,343,359,363,366,380,404,470,472],dummy_thread:[62,165,253,459,471],dump:[62,74,79,95,103,104,124,153,173,176,186,212,253,261,265,268,274,286,293,301,306,310,334,342,344,378,404,410,416,442,451,456,457,458,459,462,463,465,467,468,469,470,472],dump_stat:310,dump_traceback:[215,469,472],dump_traceback_lat:[215,469,472],duncan:462,dunder:[182,472],dup2:[215,293,334,469,471,472],dup3:472,dup:[141,161,293,339,472],dup_top:190,dup_top_two:190,duplex:[284,295],duplic:[21,62,65,99,113,116,141,161,167,168,170,183,187,189,190,194,197,206,209,254,258,266,271,293,304,339,346,347,363,380,385,404,419,424,426,437,438,443,458,460,461,462,466,469,471,472],duplicatefreeenum:[62,183],duplicateoptionerror:[168,466],duplicatesectionerror:[168,466],dupui:[468,472],durat:[30,31,65,93,104,128,184,271,284,310,339,340,343,346,355,362,363,366,367,403,463,466,467,469,472],dure:[16,17,21,22,30,41,47,57,58,62,65,83,86,91,93,95,98,105,124,135,140,141,142,149,153,159,168,169,172,177,178,182,184,187,193,199,202,203,204,209,212,214,219,227,228,229,236,238,252,257,261,266,267,268,269,271,282,288,293,297,301,310,315,316,321,322,325,328,333,335,336,337,342,343,346,355,362,363,367,368,373,376,381,385,386,387,397,399,410,411,412,413,423,424,426,428,431,432,435,436,439,440,443,447,451,455,456,459,460,461,462,463,465,467,468,469,470,471,472],dusti:[470,472],dustin:462,dutch:[366,431],duti:466,dvd:295,dvi:143,dwarf:424,dwayn:462,dwell:79,dwfileattribut:[293,469],dwflag:350,dword:177,dxob:347,dyck:460,dyer:463,dylan:459,dyld:[456,472],dylib:177,dynam:[10,21,28,38,41,47,57,60,62,65,72,74,78,79,80,83,84,85,86,90,91,93,103,104,107,114,118,120,143,183,189,204,227,228,248,251,252,253,254,293,323,337,339,346,347,355,370,373,380,382,386,387,404,420,424,426,428,432,436,441,449,456,458,459,461,462,466,467,468,471,472],dynamicclassattribut:[381,468],dynload:[111,355],dynload_:456,dysfunct:466,e000000000000p:462,e2big:213,e3c8102868d28b5ff85fc35dda07329970d1a01e273c37481326fe0c861c8142:236,e52df05b496a:468,e9buter_en_python:288,e_eof:85,eacc:[213,214,216,252,467,472],eacceler:225,eaccess:472,each:[1,5,7,11,12,21,22,26,28,30,31,33,36,38,41,54,57,58,65,66,68,72,74,75,77,79,81,82,83,84,85,86,90,92,93,94,95,97,98,99,101,103,104,105,106,107,108,109,110,111,113,114,119,122,124,125,129,134,135,136,139,140,141,143,144,149,151,152,153,154,155,156,159,160,161,164,167,168,170,176,177,178,180,182,184,185,187,189,190,193,196,197,198,201,203,204,205,206,209,212,213,215,217,219,222,225,227,228,229,230,232,236,237,243,244,245,246,248,249,250,251,252,254,257,258,260,261,265,266,267,268,269,271,272,275,276,282,284,288,292,293,294,295,296,297,298,299,301,302,307,309,310,311,314,315,316,318,320,321,322,324,327,328,330,332,333,335,337,339,340,342,343,344,345,346,347,348,349,355,356,357,359,360,362,363,365,366,368,370,372,373,375,376,377,380,381,382,384,385,386,387,391,392,396,397,399,402,404,405,406,407,408,410,412,414,416,417,419,423,424,425,426,428,430,431,432,433,436,438,442,445,446,447,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,471,472],eaddrinus:213,eaddrnotavail:213,eadv:213,eafnosupport:213,eafp:[93,293],eagain:[213,214,216,293],eager:[360,423,450],eagerli:[396,471],eai:422,eai_:339,ealreadi:[213,214],ear:299,earli:[5,31,81,86,254,268,292,334,343,366,370,378,408,422,428,456,460,462,466,472],earlier:[30,58,65,78,90,91,93,95,96,97,99,103,105,106,110,111,112,117,129,177,178,184,193,211,232,248,266,268,270,275,292,293,301,321,332,343,350,355,376,385,386,392,396,397,399,408,412,421,424,426,428,431,438,443,445,449,451,455,456,457,458,459,460,461,462,463,467,468,469,470,471,472],earliest:[140,152,184,189,367,439],earliest_result:140,earn:345,earth:[86,212,437],eas:[44,57,62,84,122,128,297,331,346,366,385,432,456,467,469,471],easi:[57,62,64,66,68,72,79,84,89,90,91,92,94,95,97,102,104,106,107,108,110,111,112,122,138,153,161,168,170,176,184,187,190,193,195,205,209,212,228,230,267,292,293,320,332,339,343,346,365,385,386,387,404,408,418,424,426,435,436,437,438,439,440,441,457,458,460,461,462,463,466,467,468,469,470,471,472,473],easier:[66,68,69,71,74,82,84,90,93,95,97,99,101,105,106,108,111,112,117,125,141,161,162,167,170,176,193,207,214,252,258,268,293,309,310,315,321,346,347,363,371,385,386,387,391,404,430,436,437,438,440,445,446,447,448,452,456,457,458,459,460,461,462,463,464,466,467,468,469,470,472],easiest:[81,82,85,87,90,91,96,107,122,193,244,248,257,292,293,386],easili:[7,22,66,68,69,71,78,79,82,84,86,90,91,92,94,95,102,103,104,105,106,128,153,159,168,170,176,177,201,212,227,232,237,254,299,321,332,342,346,361,380,385,399,431,441,442,447,454,455,456,459,461,465,466,467,469,470,472],east:[184,212,367,373,380,384,460],east_asian_width:384,eastern:[159,184,367,447,470],eastlak:343,easy_instal:396,easydialog:462,eat:[104,275],eax:101,eb6ec15daf9546254f0809:236,ebad:213,ebadf:[213,470],ebadfd:213,ebadmsg:213,ebadr:213,ebadrqc:213,ebadslt:213,ebcdic:[159,468],ebfont:213,ebi:[461,462,465,466],ebk:472,ebusi:213,ebx:101,ecdh:[343,472],ecdsa:[343,466,472],echild:[213,214],echo:[62,92,94,97,129,132,138,143,171,178,231,248,261,283,293,301,330,339,350,362,385,426,444,446,462],echo_round:382,echocancel:143,echochar:178,echoclientprotocol:135,echofilt:446,echohandl:141,echoserv:141,echoserverprotocol:135,echrng:213,eckhardt:466,ecma:261,ecmascript:[261,407],ecol:375,ecomm:213,econnabort:[213,214],econnrefus:[213,214],econnreset:[213,214,472],econom:320,economi:346,ecosystem:301,edeadlk:213,edeadlock:213,edestaddrreq:213,edet:472,edg:[62,105,177,178,193,202,363,365,380,445,467,468,472],edison:472,edit:[60,62,65,68,86,95,97,99,106,109,111,113,157,168,178,189,227,251,252,261,271,272,293,297,321,345,359,369,370,373,441,444,448,451,455,456,457,459,460,462,464,466,467,470,471,472],editlin:[322,472],editor:[62,78,84,93,95,106,109,251,252,369,431,444,445,446,452,453,455,456,462,468,469,470,471,472],editori:456,editorwindow:472,editrc:[322,472],editwin:97,edness:208,edom:[14,213],edotdot:213,edquot:213,eds:156,edsger:366,edt:[184,367,447,467,470],edu:[86,99,249,392,422,458,459],eduardo:472,educ:[86,252],edward:[457,458,460,461],ee8a:[395,461],ee8v4:458,eel:442,eest:367,eet:367,eexist:[213,214,293,472],efault:213,efbig:213,eff:343,effbot:[370,410,461,463],effect:[1,9,13,22,28,30,41,47,54,57,58,62,64,69,79,81,84,90,91,93,97,99,102,103,104,105,106,107,108,110,111,112,114,115,117,122,123,129,134,145,160,167,168,170,177,178,184,187,188,190,193,204,209,210,211,214,216,219,227,228,237,244,248,257,260,262,265,266,267,268,284,292,293,295,298,299,304,310,313,316,320,321,324,325,326,327,329,331,332,333,335,342,343,344,346,347,349,355,359,363,365,367,373,378,380,381,382,385,386,397,399,402,409,417,418,419,423,424,426,428,431,432,436,437,438,441,446,451,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],effective_id:[293,467],effici:[3,55,58,60,62,64,84,93,97,99,102,107,108,109,126,129,135,153,159,161,176,183,184,187,217,221,226,227,228,236,237,238,253,284,291,293,300,301,302,309,320,321,329,330,343,345,346,349,365,366,402,404,406,410,421,424,437,438,441,442,446,447,458,460,462,464,466,467,468,469,472],efford:99,effort:[0,85,93,95,100,104,106,108,228,275,309,436,442,456,458,459,460,462,463,465,466,471],effortless:447,effron:472,egd:343,egg:[69,104,161,176,189,219,227,228,257,298,309,321,331,346,350,359,377,386,387,392,410,419,428,437,439,442,445,456],eggi:189,egid:293,egypt:367,ehlo:[336,337,467],ehlo_or_helo_if_need:337,ehlo_resp:337,ehopp:392,ehostdown:213,ehostunreach:213,ehresman:[461,472],eidrm:213,eiffel:458,eiffelmethod:458,eight:[84,109,178,258,328,346,356,370,431,456,459,460],eik:472,eilseq:213,einat:[469,470,471,472],einprogress:[90,213,214],eintr:[22,62,213,214,284,463,472],einval:[213,293,472],eio:213,eisconn:[90,213],eisdir:[213,214],eisnam:213,either:[5,7,10,13,21,22,30,31,39,41,45,50,53,54,56,57,58,61,65,66,68,69,74,75,77,78,79,82,84,86,87,90,91,92,93,94,95,97,98,99,101,103,104,105,106,107,109,110,111,112,119,122,124,128,129,131,135,138,140,141,143,144,145,146,148,150,151,153,156,158,159,161,170,173,174,176,177,178,179,182,184,187,189,190,192,193,195,196,197,198,199,200,203,206,207,208,209,210,212,214,216,222,223,225,227,233,238,243,244,246,248,249,252,254,257,258,260,261,266,267,268,269,271,275,279,282,284,288,289,292,293,294,295,297,298,299,301,303,304,306,310,311,313,316,321,324,326,327,329,330,332,333,335,336,338,339,342,343,346,347,349,350,355,359,360,361,363,366,367,370,372,373,375,380,382,385,386,391,392,395,396,397,398,399,400,402,404,407,408,409,410,411,412,413,414,416,417,418,419,421,423,424,425,426,428,431,432,435,436,438,439,440,442,446,449,451,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],el2hlt:213,el2nsync:213,el3hlt:213,el3rst:213,elabor:[62,84,95,106,111,227,370,431,456,459],eland:460,elaps:[178,268,284,293,310,330,339,366,367,466,472],eldon:463,elect:[448,466],electron:[155,343],eleg:[84,93,98,161,168,441,449,466],elegantli:460,elem1:[316,461],elem2:[316,461],elem:[99,161,227,228,260,346,410,438,461,463,466],element:[5,7,30,36,38,45,49,50,52,58,62,64,84,90,91,93,106,108,109,119,123,125,135,141,143,153,157,161,162,173,176,177,179,182,187,189,190,193,196,197,204,206,208,210,214,222,225,227,228,230,237,241,243,246,251,254,260,261,266,272,273,284,292,293,294,297,298,306,316,318,320,321,324,328,333,336,337,339,345,346,347,350,355,367,370,372,373,375,377,380,381,382,385,391,399,405,408,409,412,413,414,416,417,423,424,426,436,437,438,445,448,451,455,456,457,458,459,460,461,462,463,464,466,467,468,469,470,472],element_cr:373,element_factori:410,element_index:347,element_nam:373,element_nod:407,element_opt:373,elementari:[156,178,380],elementdeclhandl:316,elementinclud:461,elementnam:373,elementpath:[461,471],elementtre:[62,253,273,406,408,447,468,470,472],elementum:151,elementwis:[456,457],eleph:161,elev:[66,455],elf:472,elho:467,eli:[468,470,472],elibacc:213,elibbad:213,elibexec:213,elibmax:213,elibscn:213,elicit:363,elid:288,elif:[84,91,94,97,99,104,110,125,184,189,201,230,289,321,333,342,344,346,355,359,396,423,427,428,431,437,461,467],elig:466,elimin:[62,93,103,105,108,161,187,189,252,260,261,271,294,298,302,380,436,438,448,460,467,472],elink:[400,461],elisa:466,elli:472,ellinghous:[394,422],ellington:472,elliot:[471,472],ellipsi:[15,57,62,99,124,169,193,274,309,374,375,382,399,424,427,431,446,460,464,472],ellipt:[343,467,472],elm:321,elnam:316,elnrng:213,eloop:213,elp:299,els:[7,21,31,32,37,38,48,57,58,62,65,74,78,79,81,82,84,85,90,91,92,94,95,96,99,104,105,106,107,110,111,114,123,124,125,129,136,137,140,153,167,170,174,177,184,187,189,190,193,197,201,208,222,228,230,232,237,241,243,248,249,251,252,260,261,266,268,271,276,284,289,291,292,293,301,311,318,320,321,330,333,339,342,343,344,346,350,355,359,361,363,366,370,375,380,381,382,386,396,397,399,404,407,418,419,423,424,426,427,428,430,431,432,439,441,448,451,455,456,459,460,461,462,463,466,467,468,469,472],elsewher:[11,65,106,158,168,284,326,407,428,431,468],elsiz:38,elson:472,elt:124,elvi:[469,470,471],elzen:472,em64t:356,emac:[86,92,97,109,157,178,248,271,332,431,453,462],email6:468,email:[1,62,64,65,71,72,74,93,103,104,105,112,144,147,236,238,243,244,246,253,267,268,271,272,285,293,321,336,337,343,367,383,392,422,428,447,448,449,458,460,461,462,463,472],email_address:210,emailaddress:343,emailmessag:[195,197,198,201,202,203,206,208,209,468,470,472],emailpolici:[195,198,204,209,467,469],emanuel:[470,472],emax:[187,467],emb:[28,29,30,31,60,62,78,80,91,164,193,247,252,368,406,410,458,463,471,472],emb_numarg:78,embed:[3,5,7,9,29,30,41,47,58,62,65,66,79,84,88,92,95,97,98,101,106,107,109,164,176,200,203,222,227,258,265,282,293,310,319,321,346,350,363,367,372,397,417,418,429,431,441,443,445,447,452,454,457,458,461,463,466,468,471,472,473],embedd:[31,62,245,284,452,472],embmethod:78,embmodul:78,embodi:[65,91,208,407],emerg:[125,268,437,456],emfil:213,emin:[187,467],emiss:[266,363,472],emit:[30,41,65,82,93,103,104,128,178,184,190,214,229,246,260,266,268,293,301,350,355,363,373,377,385,397,408,410,414,426,432,447,451,459,462,465,466,468,470,471,472],emlink:213,emoji:[109,466],emp:161,emperor:265,emphas:[93,99,193,472],emphasis:346,emploi:[93,153,284,409,428,467],employe:[93,161,382,436,472],employeerecord:161,empt:246,empti:[5,12,16,21,23,28,30,34,41,45,50,54,65,66,69,70,74,79,82,85,90,91,93,95,99,106,107,111,122,123,125,129,135,136,137,140,141,144,145,151,152,153,155,157,158,159,161,168,171,176,182,184,185,189,190,193,197,198,204,206,208,209,210,213,214,219,225,227,228,229,230,231,232,233,234,235,237,241,243,246,248,251,252,254,257,258,260,265,266,267,268,269,271,272,276,279,284,288,292,293,294,298,301,305,311,316,318,320,321,327,328,329,330,331,332,333,334,335,336,339,342,343,345,346,347,349,350,355,359,360,363,365,366,370,372,373,376,378,380,381,384,385,386,391,392,396,397,402,404,405,407,408,410,416,417,419,420,421,423,424,426,428,431,432,436,438,442,444,445,446,451,455,459,460,461,462,463,464,466,467,468,469,470,471,472],emptiv:141,empty_lines_in_valu:168,empty_namespac:407,emptylin:157,emsgsiz:213,emt19937ar:422,emt:422,emu:189,emul:[23,30,62,82,85,91,98,111,141,158,160,178,182,193,216,251,260,263,265,271,284,292,304,311,322,333,334,355,360,423,436,458,459,462,466,467,470,472],emultihop:213,emx:459,en_u:[184,469],enabl:[10,30,31,45,54,57,62,66,81,82,86,87,93,97,106,110,111,113,114,116,127,128,131,132,135,140,145,153,154,157,168,170,177,178,186,187,193,194,198,212,214,215,225,227,228,229,232,243,246,248,249,252,254,257,265,267,268,284,288,298,299,301,307,308,310,313,316,320,321,322,334,335,336,339,342,343,347,350,355,359,363,368,373,376,380,385,387,397,404,409,411,412,417,419,423,424,432,435,443,448,451,455,457,458,459,460,461,462,464,465,466,467,469,470,471,472],enable_callback_traceback:342,enable_interspersed_arg:292,enable_load_extens:[342,463,466],enable_smtputf8:[336,472],enable_travers:373,enable_user_sit:335,enabled_extens:168,enablereflectionkei:[402,462,463],enametoolong:213,enavail:213,enc:[123,343],enc_kei:236,encapsul:[10,86,90,91,113,157,167,203,209,222,249,257,286,307,337,355,407,411,413,416,423,428,432,460,461,462,463,468],enclos:[79,93,95,106,112,161,178,227,243,249,254,261,288,299,321,332,347,363,366,368,382,385,407,425,426,430,431,432,436,437,438,445,457,458,461,466,472],enclosur:426,encod:[4,5,15,22,23,28,30,35,41,54,59,60,62,65,68,74,77,83,90,93,95,96,97,101,103,104,105,106,110,122,123,129,135,137,143,146,147,151,152,153,155,168,171,176,178,179,184,185,187,189,190,193,195,196,197,198,200,201,202,203,204,206,207,208,209,210,214,215,218,219,227,232,235,236,242,243,245,249,252,253,254,255,257,264,265,268,269,276,285,293,294,295,298,301,309,311,316,328,331,337,339,342,343,346,349,350,351,355,357,359,360,361,363,374,375,382,392,404,408,410,413,414,416,417,418,419,424,428,437,441,442,446,447,451,456,457,458,460,461,462,463,464,466,467,468,469,471,472,473],encode_7or8bit:199,encode_base64:[199,207],encode_basestring_ascii:472,encode_chunk:243,encode_func:456,encode_noop:199,encode_object:96,encode_quopri:199,encode_rfc2231:210,encode_threshold:463,encodebyt:[144,159],encodedfil:159,encodeprior:268,encodestr:[144,319],encoding_decl:427,encoding_typ:343,encodingdecl:[316,408,410],encodingnam:451,encodings_map:276,encount:[5,9,13,31,50,84,93,106,109,110,122,153,155,161,176,187,193,200,206,209,213,214,227,230,241,245,254,261,266,267,272,286,292,294,298,299,301,313,316,332,340,343,360,373,385,397,410,412,428,436,438,439,442,446,456,459,460,461,462,466,467,472],encourag:[79,83,105,214,253,292,294,329,330,332,402,408,412,430,435,456,457,464],encrypt:[125,159,174,234,249,267,288,307,312,328,337,341,343,419,456,458,459,463,466,467,468,472],encycloped:370,end:[5,7,9,22,23,26,28,30,31,33,34,38,51,55,57,58,60,62,65,68,72,74,77,78,79,81,85,86,90,91,92,93,94,95,99,101,103,104,106,107,109,111,112,118,119,122,123,125,129,130,132,135,137,140,141,144,147,148,151,152,153,155,157,159,160,161,164,168,170,176,177,178,179,184,187,189,193,195,197,206,208,209,210,211,212,214,216,222,227,228,229,235,236,241,243,244,246,248,249,252,254,257,260,261,266,267,268,269,271,279,280,283,284,288,292,293,294,295,297,299,303,304,307,310,311,313,316,319,320,321,322,329,331,332,333,336,337,339,342,343,346,347,349,350,355,359,360,361,363,365,367,373,374,375,376,377,385,386,387,392,397,404,405,407,408,410,412,413,414,418,419,421,423,424,426,428,430,431,432,433,434,435,437,438,439,440,441,442,444,445,446,448,451,455,456,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],end_docu:409,end_el:[316,409],end_fil:380,end_fin:190,end_head:[246,467],end_paragraph:222,end_poli:380,end_tim:[129,140],endcdatasectionhandl:316,enddoctypedeclhandl:316,enddocu:412,endeavor:96,endel:[412,456],endelementhandl:316,endelementn:412,endhead:[243,470],endian:[4,28,58,90,109,143,155,159,177,232,258,295,349,351,355,395,402,448,468,472],endidx:157,endif:[79,95,96,241,321,418],endless:[456,458,461],endlessli:[99,260,460,472],endmark:[374,375,427],endnamespacedeclhandl:316,endors:[31,422,472],endpo:321,endpoint:[107,125,129,135,141,161,213,243,257,339,380,466],endprefixmap:412,endptr:17,endswith:[301,346,396,456,459,461,462,469,472],endtim:[468,472],endwin:[97,178],energet:143,energi:143,enetdown:213,enetreset:213,enetunreach:[213,472],enfil:213,enforc:[21,62,93,127,140,187,197,206,212,244,293,324,344,347,349,370,380,382,407,408,426,427,432,436,451,457,458,461,464,466,467,472],engag:[30,355],engin:[84,86,90,93,99,102,106,187,265,321,342,373,410,412,456,458,460,462,463,469,472],english:[84,104,106,109,159,242,292,365,367,380,430,431,463,464,469],english_unit:448,enhanc:[62,84,86,93,97,99,104,107,176,192,228,253,267,336,343,350,363,373,380,426,431,443,456,457,458,460,461,464,465,466,467,468,469,472,473],enjoi:[256,410],enlarg:[177,472],enlighten:156,enoano:213,enobuf:[135,213],enocsi:213,enodata:[213,293],enodev:213,enoent:[213,214,329,467],enoexec:213,enokei:472,enolck:213,enolink:213,enomem:[213,472],enomsg:213,enonet:213,enopkg:213,enoprotoopt:213,enorm:[99,443],enosi:213,enospc:213,enosr:213,enostr:213,enotblk:213,enotconn:[213,468],enotdir:[213,214],enotempti:213,enotnam:213,enotsock:213,enotti:[213,472],enotuniq:213,enough:[5,38,41,54,58,69,74,75,84,90,91,92,95,97,98,102,103,104,105,107,110,159,176,177,184,189,200,202,248,252,257,264,269,292,293,298,310,339,341,343,346,350,363,365,368,381,386,399,438,453,456,457,458,459,464,467,472],enq:179,enqueu:[104,136,268,284,318,472],enqueue_sentinel:268,enquiri:179,enrich:78,enriqu:472,ensu:[30,466],ensur:[5,17,30,38,41,45,57,58,60,62,65,67,68,79,82,85,90,92,95,97,102,103,104,106,111,114,122,125,129,134,135,138,144,159,167,170,182,183,184,187,193,197,206,211,237,251,254,261,266,269,279,284,292,293,301,326,339,343,345,350,355,362,363,365,373,385,386,387,392,395,396,397,399,402,404,416,418,419,424,426,439,446,451,455,456,459,461,462,463,466,467,468,469,470,471,472],ensure_ascii:[261,469,472],ensure_directori:396,ensure_dis:472,ensure_futur:[131,140,469,470,472],ensure_valu:292,ensurepip:[62,112,191,253,396,472],ent:241,entail:[30,451],enter:[1,30,31,84,85,86,90,91,92,93,95,97,99,101,106,107,109,141,145,153,157,158,160,170,178,190,227,248,257,283,292,293,299,314,327,337,342,343,346,355,360,366,370,372,380,397,423,424,425,433,436,437,439,440,444,445,446,448,450,451,458,459,461,466,467,468,471,472],enter_async_context:170,enter_context:170,enter_result:170,enterab:[327,467],enterpris:472,enterprise_d:382,entertain:153,enthought:161,entir:[0,5,31,57,65,68,74,75,79,81,90,91,93,95,97,102,105,106,107,108,109,111,113,149,152,153,161,167,170,172,178,185,197,201,206,208,217,222,232,236,237,241,243,248,253,257,258,260,265,266,268,269,271,288,292,293,295,321,324,333,342,343,345,346,347,359,365,366,368,373,380,384,385,397,402,405,407,410,413,422,423,425,428,431,432,437,438,442,445,451,455,457,459,460,461,462,463,465,467,468,471,472],entireti:444,entiti:[62,93,106,110,239,241,243,253,267,273,316,392,406,407,408,409,411,412,413,414,459,467,471,472],entity_nod:407,entitydeclhandl:316,entitydef:240,entitynam:316,entityrefer:408,entityresolv:[62,273,413],entranc:84,entrant:266,entri:[5,21,28,30,31,41,45,57,62,69,74,79,81,84,92,93,94,98,99,101,104,109,110,111,122,136,140,145,149,152,159,161,168,170,177,178,185,187,190,192,193,196,217,227,228,232,234,237,244,248,249,252,254,260,264,267,268,269,271,272,282,284,286,292,293,294,297,301,304,305,308,309,310,312,316,318,321,323,326,331,332,334,337,341,342,343,346,354,355,359,361,363,366,370,372,373,375,377,380,381,386,387,393,397,399,400,402,418,419,426,438,448,451,455,457,458,459,460,461,462,463,464,465,466,467,469,470,471,472],entropi:[293,343,470,472],entry_find:237,entry_func:322,entryconfig:370,entryconfigur:472,entrythingi:370,enum_certif:[343,468,472],enum_crl:[343,468,472],enumclass:212,enumer:[22,62,84,99,108,109,161,183,227,228,253,260,284,313,342,346,366,378,395,402,437,438,446,448,455,468,470,473],enumkei:402,enummeta:212,enumnam:212,enumvalu:402,env:[74,90,104,109,168,189,201,293,298,343,350,392,396,418,434,444,449,454,455,459,460,472],env_dir:396,env_ex:396,env_var:363,envbuild:[62,191,468,472],envdir:377,envelop:[197,202,206,208,249,271,336,337,472],environ:[28,30,31,38,57,58,60,62,64,65,66,74,86,87,90,91,92,93,98,103,109,110,111,112,120,128,129,153,159,161,164,177,178,187,188,191,211,215,227,228,230,231,232,236,238,248,251,253,255,265,267,292,294,295,297,299,301,308,310,311,313,315,317,326,327,333,339,340,343,346,350,355,359,361,363,367,370,376,378,385,386,392,397,400,402,407,417,424,425,428,433,434,437,441,443,446,452,453,454,456,457,458,459,460,462,464,465,466,468,471,472,473],environb:[293,466],environment:[293,392,451,472],environmenterror:[214,446,467],environmentvarguard:[363,462],envvar:[265,363],enxio:213,eof:[60,85,107,129,132,135,137,138,151,157,158,169,193,214,225,227,257,269,293,311,329,332,339,343,360,421,451,461,467,472],eof_receiv:[132,135],eoferror:[22,23,37,123,130,151,155,158,214,227,269,274,284,301,337,360,446,464],eopnotsupp:213,eot:[107,179],eoverflow:213,eperm:[213,214,467,472],epfnosupport:213,ephemer:[363,399],ephemeri:449,epicuri:201,epilog:[62,120,206,292,461,466],epilogu:[197,206],epip:[213,214,334],epiphani:400,epler:457,epoch:[152,177,210,244,249,271,288,294,343,367,416,457],epol:[62,330,462,468,469,472],epoll_cloexec:329,epoll_create1:329,epollerr:329,epollet:329,epollexclus:[329,472],epollhup:329,epollin:329,epollmsg:329,epolloneshot:329,epollout:329,epollpri:329,epollrdband:329,epollrdhup:[329,472],epollrdnorm:329,epollselecrtor:472,epollselector:[330,471],epollwrband:329,epollwrnorm:329,eproto:213,eprotonosupport:213,eprototyp:213,eprt:225,epsilon:[355,462],epsv:225,epydoc:90,eqequ:374,equal:[5,7,30,31,33,38,49,54,57,58,60,62,81,84,85,91,93,94,96,99,104,108,113,115,118,122,134,135,136,143,149,151,156,161,167,171,177,178,182,184,187,189,193,196,197,203,209,212,217,223,227,228,229,230,237,242,244,257,258,260,261,265,272,275,279,289,291,293,295,297,299,310,318,320,321,328,332,335,342,343,345,346,348,349,363,365,366,373,374,375,378,380,382,384,385,386,387,399,405,407,409,410,420,424,426,428,431,432,437,438,440,445,446,448,456,457,458,459,460,461,462,463,464,466,467,470,472],equat:320,equidistribut:320,equiv:392,equival:[5,7,9,21,22,23,30,31,34,36,38,41,43,45,49,50,53,55,57,58,65,74,79,82,84,87,92,93,94,95,96,98,99,101,105,106,111,113,117,118,119,122,123,124,135,138,139,140,149,151,156,159,161,164,167,168,170,177,178,179,182,184,187,189,197,205,206,208,212,214,222,227,228,230,232,235,236,237,238,240,241,244,245,246,248,252,254,258,260,261,265,267,268,269,271,275,284,286,291,292,293,294,295,297,298,301,302,303,304,308,310,318,320,321,323,326,329,330,339,340,342,345,346,347,350,351,355,356,359,363,366,367,370,380,381,382,384,385,391,398,400,402,407,421,423,424,426,431,432,435,436,437,438,442,445,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],era:[265,461],era_d_fmt:265,era_d_t_fmt:265,era_t_fmt:265,erang:213,eras:[91,97,104,178,360,442],erasechar:178,ered:241,eremchg:213,eremot:213,eremoteio:213,erestart:213,erf:[98,275,463,466,471,472],erfc:[275,463,466,471,472],erhard:460,eric:[91,97,176,178,298,326,410,422,438,456,457,460,462,463,465,466,467,468,469,470,471,472],erick:472,erik:[462,471,472],eriksson:[469,472],erof:213,erow:375,err:[97,178,214,230,268,316,333,350,385,416,422,439,467],err_traceback:81,err_typ:81,err_valu:81,errata:[244,261,416],errcheck:177,errcod:[60,85,416],errmsg:416,errno:[14,22,31,62,79,90,120,135,177,214,216,252,253,293,316,329,334,339,343,363,462,467,469,471,472],erron:[177,274,292,301,380,406,456,468,469,471,472],error:[5,7,9,16,17,20,21,23,24,28,29,30,31,32,34,35,36,37,38,40,41,44,45,49,50,51,54,55,56,57,58,59,60,61,62,66,71,74,78,80,81,82,84,85,86,90,93,94,95,96,99,102,103,104,105,106,107,109,117,122,123,130,131,132,135,138,139,142,143,144,145,146,147,148,151,153,156,157,158,160,164,167,168,169,170,172,176,177,178,182,184,185,193,195,197,198,202,203,204,206,208,209,210,212,213,214,215,217,219,225,227,228,230,231,235,238,245,246,248,249,252,253,255,257,258,261,263,264,265,266,267,268,269,271,273,275,279,284,285,286,287,288,290,293,295,298,301,304,307,308,310,311,313,318,320,321,324,329,332,333,334,335,337,339,340,342,343,346,347,349,350,351,352,355,357,359,360,363,366,370,373,375,377,380,382,385,386,387,389,391,392,394,396,397,398,399,400,401,402,403,404,405,407,409,410,411,412,413,416,417,418,419,421,423,424,425,426,431,432,435,438,441,445,446,448,451,455,456,457,458,460,461,462,463,464,466,467,468,469,470,471,472,473],error_access_deni:472,error_bodi:404,error_callback:284,error_cod:385,error_content_typ:246,error_handl:[159,411],error_head:404,error_invalid_paramet:350,error_lead:332,error_message_format:[246,468],error_no_more_item:472,error_out:96,error_output:404,error_perm:225,error_po:54,error_proto:[225,307,467],error_receiv:[132,135],error_repli:225,error_statu:404,error_temp:225,error_traceback:57,error_typ:57,error_valu:57,errorbyteindex:316,errorcod:[213,316],errorcolumnnumb:316,errorhandl:[62,273,411,413,451,462],errorlevel:359,errorlinenumb:316,errorn:472,errorstr:316,errortoken:[374,375],errtext:363,erupt:458,ervo:106,eryk:[109,472],eryksun:472,esc:179,escal:293,escap:[13,15,38,45,54,62,65,79,84,97,106,109,122,129,138,153,159,168,176,178,179,209,227,233,239,248,252,257,261,288,297,321,323,332,346,347,350,367,380,382,391,414,416,424,431,445,448,456,457,460,462,463,464,466,467,468,469,470,471,472],escape_decod:472,escape_encod:472,escapechar:176,escapedquot:332,eshutdown:[213,214],esmtp:337,esmtp_featur:337,esocktnosupport:213,esoter:[458,461],espeak:104,especi:[30,64,66,69,74,78,79,82,90,91,93,102,105,109,111,129,141,161,168,170,184,187,193,199,206,237,254,257,261,267,288,293,299,305,310,313,315,316,318,320,343,344,350,355,363,370,399,407,423,428,430,437,448,456,458,459,462,463,464,466,467,468,469,470,472],esperanto:159,espip:213,esrch:[213,214],esrmnt:213,essai:473,essenc:[99,139],essenti:[30,79,91,106,107,135,168,216,227,252,256,267,268,275,288,292,293,326,331,340,346,355,380,382,385,408,419,429,435,456,458,463,464,467,468],est:[184,367,447,466,470],establish:[1,95,103,127,129,137,141,193,225,237,248,249,268,284,301,304,307,329,337,343,360,370,392,402,424,425,463,466,472],estal:213,estim:[45,288,291,320,345,363,424,472],estonian:472,estrpip:213,esx:339,etb:179,etc:[5,58,64,65,66,74,77,85,87,93,99,103,104,107,109,110,111,122,124,126,132,135,143,153,157,169,186,207,212,227,241,244,245,248,254,258,265,266,268,272,276,282,284,292,293,298,304,305,309,312,313,321,330,333,335,339,342,343,345,359,366,367,370,372,380,382,385,391,404,407,422,424,427,432,433,436,437,438,443,446,447,449,455,456,458,459,460,461,462,463,464,465,466,467,468,469,470,472],etern:[106,140],ethan:[467,468,469,470,471,472],ethernet:339,ethnomathemat:380,etim:213,etimedout:[213,214,462],etini:187,etiquett:107,etoomanyref:213,etop:187,etr:65,etre:[62,253,273,406,408,447,461,463,466,470,472],etter:384,eturn:299,etx:179,etxtbsi:213,etyp:[373,377],euc:[159,196,460],euc_jis_2004:159,euc_jisx0213:159,euc_jp:159,euc_kr:159,euccn:159,eucgb2312:159,eucjis2004:159,eucjisx0213:159,eucjp:[159,184],euckr:159,euclean:213,euclidean:275,eudora:307,eugen:[471,472],euid:293,euismod:151,eunatch:213,euro:[159,227,463,464],europ:[159,167,367,450,463],european:[152,159,463],europython:109,euser:213,eval:[12,57,85,91,113,123,145,158,160,214,227,267,297,299,301,309,346,372,377,425,427,431,432,433,436,440,446,456,460,462,464,465,466,472],eval_input:427,evalu:[3,21,30,51,60,62,74,79,84,91,92,93,95,99,114,124,212,227,232,260,266,284,299,325,326,346,355,366,382,385,391,399,423,424,429,431,432,437,438,443,445,455,456,459,460,461,462,463,465,466,468,472],evan:461,even:[5,9,17,22,28,30,31,38,53,54,57,58,64,65,66,69,74,79,82,84,85,86,87,90,91,92,93,94,95,99,104,105,106,107,109,111,112,113,118,122,125,128,129,140,141,142,147,153,156,159,162,164,167,168,169,170,177,178,182,184,187,192,193,195,197,199,200,206,207,208,209,212,214,215,216,219,223,227,228,236,237,240,244,248,251,254,257,264,265,266,267,268,269,271,275,284,292,293,294,299,301,309,310,320,321,332,333,334,335,337,339,342,343,345,346,347,349,355,363,365,366,367,373,382,384,385,386,387,392,396,397,399,400,402,404,408,412,414,416,419,422,423,424,426,427,428,430,431,432,435,436,437,438,439,440,441,442,443,445,446,447,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,470,471,472],evenli:[99,260],event:[28,30,38,60,62,65,79,86,97,103,125,126,127,128,131,133,134,135,137,138,140,141,145,165,178,184,222,224,237,253,259,266,268,282,284,310,316,329,330,336,342,343,344,355,359,369,399,407,408,409,410,411,412,413,414,422,424,426,439,442,448,454,455,456,461,462,463,466,467,468,469,470,471,472],event_read:330,event_writ:330,eventcod:79,eventlist:329,eventloop:[134,472],eventmap:282,eventmask:[329,462],eventu:[5,30,31,79,82,85,90,95,106,107,131,135,139,140,193,214,243,248,284,311,368,392,408,416,428,435,442,457,458,460,461,462,463,464,468,470,472],ever:[65,79,91,107,114,124,178,200,202,212,252,257,260,283,284,296,343,386,458,459,461,462,463,464,468,472],everi:[30,31,38,45,52,53,62,65,66,68,72,74,79,81,83,84,86,91,93,95,98,99,103,104,106,109,110,111,113,118,124,129,134,136,140,144,147,159,168,177,178,184,185,187,188,189,190,193,195,197,206,215,225,227,232,237,244,246,248,258,260,261,266,268,284,292,293,295,304,316,318,321,333,334,340,342,346,347,350,351,354,355,356,357,365,366,373,380,382,385,386,392,397,404,405,407,410,416,424,428,430,434,437,440,441,446,449,451,455,456,457,458,459,460,461,462,463,464,466,468,469,470,472],everybodi:[153,245],everydai:[98,227,253,385],everyon:[70,72,370,468],everyth:[3,57,65,68,75,79,82,91,92,95,97,104,105,107,110,111,122,140,172,193,209,221,267,292,293,294,301,321,333,336,339,342,360,370,386,397,416,430,445,462,464,467,472],everywher:[91,107,363,472],evict:161,evid:469,evil:[168,463,472],evilzero:472,evolut:[52,64,112,456,457],evolv:[93,95,267,428,436,438],ewert:467,ewouldblock:[213,214],ewt:461,ex_cantcreat:293,ex_config:293,ex_dataerr:293,ex_ioerr:293,ex_nohost:293,ex_noinput:293,ex_noperm:293,ex_notfound:293,ex_nous:293,ex_ok:293,ex_oserr:293,ex_osfil:293,ex_protocol:293,ex_softwar:293,ex_tempfail:293,ex_unavail:293,ex_usag:293,exact:[7,17,31,65,66,74,75,86,90,95,99,106,107,109,112,113,129,135,151,177,178,184,187,190,193,202,212,214,223,227,252,253,269,271,275,290,292,293,339,346,355,356,370,375,377,385,387,396,410,418,426,428,429,432,440,448,455,456,457,461,462,463,464,465,467,468,472],exact_typ:375,exactli:[5,7,9,10,23,26,31,58,60,64,65,69,79,81,82,84,90,91,93,95,97,102,104,106,108,113,122,123,129,135,137,149,154,170,177,184,187,193,197,199,204,206,208,223,227,230,237,244,246,254,265,266,267,268,275,284,292,293,294,295,316,321,324,329,337,339,340,342,343,345,346,348,349,350,361,362,365,366,377,382,385,386,387,395,399,421,423,426,431,432,436,440,448,451,456,458,459,460,461,462,463,465,467,472],exam:149,examin:[57,62,78,91,98,103,109,111,114,182,188,229,254,263,293,299,302,310,332,333,334,337,346,355,363,407,435,457,459,461,462,467,472],exampl:[4,5,7,15,17,21,22,29,30,31,41,47,53,57,60,62,65,66,68,70,71,74,75,77,78,80,81,83,84,85,86,90,91,92,93,94,95,96,97,99,102,105,106,107,108,109,110,111,112,113,118,119,120,121,123,124,127,128,131,132,133,139,140,143,144,145,146,148,150,152,153,156,159,160,162,163,165,169,171,172,175,177,178,182,183,184,185,186,187,188,190,191,195,196,197,198,200,202,203,204,205,206,207,208,209,210,214,216,217,218,219,220,221,222,223,224,227,228,229,230,232,233,246,248,250,253,254,255,257,258,260,261,263,264,265,266,267,268,272,273,275,276,279,281,283,285,288,289,290,291,293,295,298,299,300,302,303,304,305,308,310,313,315,317,318,323,325,327,332,335,336,342,344,345,346,348,350,352,354,355,356,363,364,365,367,370,372,373,376,380,381,382,384,386,388,391,393,397,400,403,405,406,407,409,412,419,422,423,424,428,430,431,432,435,437,438,439,440,441,442,444,445,446,447,448,449,450,451,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],example_nt:472,examplescreen:380,exampleservic:417,exampleturtl:380,examplexml:410,exc:[13,22,30,43,85,113,124,135,140,167,170,363,377,385,424,432,462,464,467,472],exc_clear:[459,464],exc_detail:170,exc_info:[22,30,31,79,103,104,113,145,154,190,193,214,266,333,355,377,381,385,402,404,423,424,439,446,459,461,462,464,469,472],exc_msg:193,exc_tb:[170,346],exc_text:[104,266,472],exc_traceback:[113,377,464,472],exc_typ:[113,170,346,377,424,464],exc_val:346,exc_valu:[113,377,424,463,464],exce:[5,17,54,129,137,140,167,168,187,229,257,293,301,324,361,366,407,419,437,463,471],exceed:[130,187,213,214,268,309,324,365,421,459,460,462,470],excel:[91,109,176,193,201,370,453,459,460,464],excel_tab:176,except:[2,5,7,9,10,13,17,21,23,28,29,30,32,34,35,36,37,43,44,45,47,49,51,52,53,54,55,56,57,58,60,61,62,67,69,71,72,74,75,77,80,81,82,85,86,90,93,94,95,96,97,98,99,101,102,105,106,107,109,111,113,114,117,119,122,123,125,126,129,131,132,135,137,138,140,141,142,143,144,145,146,147,148,151,153,154,155,156,158,159,160,161,165,169,171,172,174,176,177,178,179,184,185,187,188,189,190,195,196,197,201,202,206,207,208,209,211,212,213,215,216,218,219,225,227,228,229,230,231,232,235,236,238,241,243,244,245,246,248,249,251,252,253,254,255,256,257,260,263,264,265,266,267,268,269,273,274,275,279,280,282,285,286,287,288,289,290,292,293,294,295,298,299,300,301,304,306,307,308,310,313,317,318,319,321,322,324,325,327,329,330,332,333,334,335,336,337,340,346,347,351,355,358,359,361,362,363,365,366,367,368,370,372,375,377,378,382,385,386,389,391,392,394,396,397,398,399,400,402,404,408,411,412,413,416,417,419,420,421,422,423,424,426,427,428,429,430,431,432,433,434,435,436,437,438,441,442,444,446,448,451,455,456,457,458,459,460,465,466,468,469,470,471,472,473],except_claus:427,excepthandl:124,excepthook:[154,355,446,457,472],exception1:461,exception2:461,exception:310,exception_hierarchi:462,excerpt:[154,187],excess:[91,111,113,135,177,187,243,323,367,423,426,437,472],exchang:[62,78,107,165,177,213,236,237,238,279,293,318,343,359,440,442,462,463,466,467,472],excinfo:333,excit:[98,435,456,458],exclam:[271,299,347,373,403,431],exclud:[5,17,54,58,67,75,93,98,106,161,164,182,184,193,229,236,260,271,275,280,282,293,298,310,316,320,343,346,359,366,367,368,373,378,386,418,419,422,424,426,432,438,445,451,462,463,466,467,468,469,471,472],exclude_empti:193,excludevers:455,exclus:[38,43,62,72,91,106,107,111,120,139,151,152,178,187,216,222,227,249,257,268,269,271,291,292,293,321,342,346,359,376,378,400,419,422,424,426,436,455,462,467,468,469,472],excursu:[62,444,452],exdev:213,exe:[65,66,72,92,106,248,268,284,293,321,333,335,396,418,419,434,444,455,463,466,470,471,472],exec:[12,30,65,79,90,111,113,124,145,193,213,214,227,252,293,297,299,310,346,350,354,355,363,375,376,377,378,424,425,432,433,434,436,446,456,457,458,460,461,464,468,469,472],exec_bodi:381,exec_builtin_or_dynam:472,exec_modul:[41,252,428,468,469,470],exec_prefix:[30,31,65,111,284,335,355,376,396,446,451,454,466],execfil:[113,459,460,464,472],execl:[292,293],execlp:293,execut:[12,22,30,31,41,45,47,48,54,60,62,65,66,72,74,77,78,79,81,82,83,84,91,93,94,95,99,101,105,106,109,111,114,115,117,122,126,127,128,135,138,140,142,145,153,157,158,159,161,164,167,170,171,177,186,188,191,192,202,214,227,228,237,246,249,251,252,253,254,257,265,266,267,268,272,281,282,284,292,293,294,297,299,301,302,303,305,310,311,315,322,324,327,329,331,332,333,335,339,342,344,346,348,350,355,361,366,367,369,370,372,375,385,386,387,392,396,397,400,402,404,417,423,426,428,429,432,433,436,437,439,441,442,443,444,445,447,451,452,453,454,456,457,458,459,460,462,463,464,465,466,467,468,469,470,471,472,473],executable_filenam:65,executemani:342,executescript:342,executexx:342,executionload:252,executor:[62,128,129,132,165,466,469,472],execv:[292,293,308,467,472],execvp:[293,350],exemplar:91,exemplari:422,exemplifi:[267,437],exempt:[86,463],exercis:[79,84,90,103,107,161,188,266,292,310,363,462],exfileselectbox:372,exful:213,exhaust:[5,57,84,93,99,125,159,161,190,227,243,260,293,363,370,386,423,426,437,438,458,460,461,462,464,469,470,472],exhibit:[90,248,257,346,436,451],exif:250,exist:[5,9,21,23,28,30,31,35,44,50,52,53,54,57,58,60,61,62,65,66,70,72,74,75,78,79,80,82,84,85,86,90,91,93,98,99,102,103,104,105,106,109,110,111,112,113,114,117,119,122,123,124,125,129,132,141,145,149,151,153,157,159,161,164,168,170,172,176,177,182,184,185,188,193,195,197,201,206,207,209,211,212,213,214,217,219,222,227,228,232,235,236,237,244,245,248,249,251,252,254,256,257,258,260,266,267,268,269,270,271,272,274,276,279,282,284,287,288,292,293,294,295,297,298,299,301,304,310,315,320,321,322,326,331,333,334,335,339,342,343,344,345,346,347,350,355,356,359,361,363,367,370,372,373,380,382,384,385,386,391,392,394,396,397,399,400,402,404,407,410,416,418,419,420,423,424,425,426,428,429,431,432,436,438,440,442,449,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],exist_ok:[293,298,469,472],existing_db:342,existing_fil:99,existing_funct:95,exists_ok:472,exit:[22,30,31,54,60,62,66,78,79,85,90,92,93,94,96,97,99,104,117,120,129,132,134,135,138,153,157,158,167,169,170,176,178,187,190,193,201,214,215,219,230,248,249,251,252,253,260,266,268,284,292,293,299,310,311,313,317,329,334,335,337,339,340,342,346,350,355,360,363,366,368,375,376,381,385,386,387,396,397,399,400,403,404,408,417,418,419,423,424,426,434,444,446,447,451,455,456,457,458,459,460,461,462,463,466,469,470,471,472],exit_futur:135,exitcod:[284,350,472],exitfunc:[113,456,460,464],exitmsg:158,exitonclick:380,exitstack:[170,467,471,472],exot:[261,390,458],exp:[14,156,187,275,320,347,462,463,467,472],expand:[30,53,57,81,92,93,94,106,109,111,168,187,193,232,248,254,258,267,284,292,294,298,316,321,346,356,365,367,370,373,386,391,402,406,407,409,410,412,417,426,428,455,458,459,462,466,467,468,469,470,471,472],expand_tab:365,expandenvironmentstr:[402,462],expandnod:409,expandtab:[346,365],expandus:[111,168,233,244,286,294,298,322,333,350,469,472],expandvar:[233,294,350,462,472],expans:[53,62,220,221,248,253,294,310,316,350,365,406,419,437,460,467,468],expat:[62,74,253,273,306,406,410,412,456,457,459,461,463,466,472],expat_extens:456,expaterror:[62,273,466],expect:[1,5,9,22,26,31,41,53,57,60,62,68,69,70,72,74,79,81,82,83,84,90,91,93,94,97,99,102,103,104,105,106,107,109,110,111,112,114,122,124,129,130,135,136,140,141,153,155,159,161,168,170,173,177,178,182,187,188,189,193,198,204,212,214,222,223,225,227,232,236,243,244,246,252,254,257,261,265,266,268,271,279,284,291,292,293,311,314,328,329,331,332,334,339,343,349,350,355,360,363,367,370,373,380,382,386,387,390,392,394,396,404,405,410,412,413,416,421,424,426,428,436,437,440,448,449,456,457,458,459,460,461,462,463,465,466,467,468,469,470,471,472],expectation_fail:242,expected_cal:387,expectedfailur:[363,385,465,472],expectedfailuretestcas:385,expens:[57,72,82,84,91,93,103,149,182,187,189,228,257,265,289,310,333,340,343,355,421,428,448,451,460,467,468,470,471],expensive_func1:103,expensive_func2:103,expensive_mod:382,experi:[86,90,95,99,103,106,177,232,310,342,380,385,407,435,441,455,456,457,458,462,463,465,469],experienc:84,experiment:[74,84,95,98,135,242,248,271,342,343,370,407,430,459,464,465,466,471,472],expert:[30,292,446,451],expir:[129,213,244,245,284,327,330,334,337,339,341,343,350,366,367,392,467],expiri:[244,472],explain:[31,38,41,57,74,77,79,81,82,83,85,91,93,94,97,99,102,103,104,105,106,109,110,111,128,153,172,177,193,214,227,244,246,248,260,292,299,346,373,385,386,390,421,426,435,436,440,450,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],explan:[62,74,84,86,106,110,168,184,189,246,265,271,284,286,299,303,306,321,339,342,346,355,367,370,380,392,428,438,439,442,450,456,457,458,459,460,461,462,466],explanatori:[83,193,297,316,385],explicit:[22,26,28,31,60,62,64,65,74,75,79,82,84,91,95,103,106,107,113,135,142,168,170,182,184,187,189,206,211,214,227,232,244,252,254,268,284,292,299,301,316,326,332,333,339,340,346,347,363,382,386,399,408,411,418,424,426,428,434,436,438,446,455,456,457,461,463,464,466,471,472,473],explicitli:[7,27,30,31,45,57,62,64,65,66,68,69,74,79,82,91,93,95,97,99,101,103,104,105,106,111,112,113,134,140,150,153,158,167,170,171,177,180,182,184,187,197,199,203,206,207,209,211,212,214,215,219,225,227,228,232,234,244,246,251,253,254,261,265,266,267,269,271,275,282,284,292,293,294,295,309,313,328,329,331,334,335,337,339,340,342,343,345,346,349,350,355,357,361,366,370,380,382,385,386,392,396,397,399,402,404,407,408,409,418,420,423,424,425,426,427,428,431,432,434,436,437,442,445,446,451,455,458,459,461,462,463,464,466,467,468,469,470,471,472],explod:[102,258,456,458],exploit:[153,269,293,406,424,451,468],explor:[94,103,108,110,111,168,190,241,248,293,385,396,410,424,443,455,462,466],explos:102,expm1:[275,463,466],expn:336,expon:[94,187,275,346,347,349,355,375,431,460,462,467,472],exponentfloat:431,exponenti:[14,91,187,268,291,320,346,406,426,459,460,462],export_symbol:[65,74],exportselect:373,expos:[7,14,25,34,39,40,41,42,44,50,53,57,58,65,78,79,82,93,94,103,110,131,140,177,182,187,211,251,252,254,258,261,265,266,282,284,293,309,331,332,337,346,347,348,350,355,376,381,384,399,402,404,417,424,428,459,462,463,466,467,468,469,470,471,472],expositori:193,exposur:[174,467],expovari:320,expr1:[99,426,456],expr2:[99,426,456],expr3:[99,426],expr4:426,expr5:426,expr:[99,124,145,297,385,423,426,427,432,456,460,464],expr_context:124,expr_stmt:427,express:[5,21,36,43,45,49,60,62,74,79,86,91,92,93,100,104,122,124,128,140,145,156,160,162,163,168,184,187,189,190,193,214,221,227,232,233,248,253,254,258,260,265,267,275,284,291,293,297,299,310,320,325,334,339,343,346,347,349,355,360,363,364,367,368,370,375,376,381,382,384,385,387,395,397,399,410,422,423,424,425,428,429,431,435,438,439,440,441,442,443,445,446,447,456,457,458,459,462,463,464,465,466,467,468,469,470,471,472,473],expression1:432,expression2:432,expression_list:[423,426,432,433],expression_nocond:426,expression_stmt:432,exprlist:427,exprn:[99,456],expung:249,exr:250,ext:[68,103,104,159,190,201,267,276,294,299,448,459,460,466],ext_modul:[65,69,74,75,77,82,456],ext_packag:74,ext_suffix:[466,468],extant:[197,206],extend:[5,28,29,30,31,38,41,52,57,62,69,71,77,81,82,84,86,88,90,91,93,97,104,106,110,111,120,122,123,135,141,152,156,157,159,161,162,168,169,170,177,178,184,189,191,193,197,206,208,212,227,228,232,246,248,250,251,257,260,261,271,275,276,279,283,301,304,310,316,322,329,333,336,337,339,343,346,352,355,359,367,373,375,380,382,385,392,406,407,410,417,424,425,426,428,429,432,436,438,441,445,446,455,457,460,462,463,464,466,467,468,469,470,471,472,473],extend_path:304,extended_arg:190,extendedcontext:[187,467],extendedenvbuild:396,extendedinterpol:[168,466],extendedref:399,extendleft:161,extens:[1,3,5,7,10,22,26,29,31,38,41,52,53,57,58,60,62,66,68,70,71,72,78,84,86,87,88,91,92,93,95,97,100,105,106,120,123,144,154,168,174,177,178,182,184,185,189,192,193,195,201,204,209,212,219,221,227,229,236,237,242,246,247,249,251,252,253,254,255,257,261,268,271,273,276,281,288,289,292,293,296,298,299,301,307,310,314,316,319,320,321,331,332,333,336,337,339,342,343,346,355,356,359,363,366,369,370,378,380,381,385,399,402,407,408,411,412,416,418,419,422,424,426,428,429,434,435,436,441,446,447,451,453,454,455,456,457,458,459,460,461,462,463,464,465,466,468,470,471,472],extension_nam:65,extension_suffix:252,extensionclass:456,extensionfileload:[252,467,468,470],extensions_map:246,extent:[31,135,157,172,236,257,279,373,380,422,465],extern:[31,62,65,66,74,75,79,84,85,90,91,95,104,108,120,123,124,153,159,168,177,185,198,217,238,248,251,252,254,266,272,274,293,300,313,316,340,342,346,361,363,366,370,385,404,405,406,407,409,410,411,412,413,419,424,426,439,455,462,464,465,466,469,470,471,472],external_attr:419,external_resource_avail:385,externalclasherror:271,externalentityparsercr:316,externalentityrefhandl:316,extra:[8,9,17,31,57,58,65,82,84,91,93,95,97,104,110,111,113,122,161,171,176,187,193,197,203,204,206,209,212,243,252,266,271,274,284,292,333,343,346,359,360,363,368,373,382,386,410,419,424,427,438,442,448,456,459,462,463,466,467,470,471,472],extra_arg:[333,466],extra_compile_arg:[65,74],extra_link_arg:[65,74],extra_object:[65,74],extra_path:[470,472],extra_postarg:65,extra_prearg:65,extra_s:448,extract:[13,19,31,51,62,66,78,80,81,99,102,178,184,189,193,198,199,201,227,232,237,243,244,252,254,260,293,297,314,315,321,331,333,337,346,355,359,377,419,424,437,438,439,447,455,459,460,461,462,463,466,468,469,470,472],extract_cooki:244,extract_dir:333,extract_stack:[377,472],extract_tb:377,extract_vers:419,extractal:[359,419,461,462,469,472],extracted_list:377,extracterror:359,extractfil:359,extractor:[291,460],extraglob:193,extralargefil:472,extran:[125,190,261,310,370,472],extrasact:176,extrem:[84,99,104,109,208,261,293,301,320,386,407,419,426,439,472],extsep:293,extslic:124,eye:[84,144,187,189,437,461,469],ez_setup:396,ezio:[109,463,466,467,468,469],f0f1f2:346,f100:437,f1f2:346,f3nde:466,f5d:458,f5r8f:458,f5r:458,f6stal:203,f86e:[395,461],f9bf78b9a18ce6d46a0cd2b0b86df9da:328,f_back:[254,377,424],f_bavail:293,f_bfree:293,f_block:293,f_bsize:293,f_builtin:[254,424],f_code:[254,424,459],f_contigu:346,f_express:431,f_favail:293,f_ffree:293,f_file:293,f_flag:293,f_frsize:293,f_fsid:[293,472],f_getfd:472,f_global:[254,424],f_in:235,f_lasti:[254,424,459],f_lineno:[254,424,459,470,472],f_local:[254,381,424,472],f_lock:[293,472],f_namemax:293,f_ok:[293,333],f_out:235,f_restrict:472,f_setfd:472,f_setfl:216,f_setlkw:216,f_test:293,f_tlock:293,f_trace:[254,424,472],f_trace_lin:[30,355,424,471,472],f_trace_opcod:[30,355,424,471,472],f_tstate:468,f_ulock:293,f_wrlck:216,fab:275,fabian:462,fabrett:201,fabric:[469,472],face:[30,109,131,248,268,298,304,380,456,462,464,467,468,469,472],facil:[7,30,62,95,97,103,120,145,157,158,178,248,253,257,263,268,271,293,301,339,343,347,357,359,380,424,443,445,446,455,459,472],facilit:[22,222,227,248,267,321,322,337,397,468,471,472],facioni:472,fact:[28,31,58,66,68,69,72,74,79,84,86,91,92,96,99,103,106,107,110,111,129,152,168,172,177,187,193,207,211,225,227,252,266,280,292,301,310,346,359,367,370,380,382,392,404,418,424,426,428,430,436,437,440,445,446,455,456,457,462,467,468,469,472],facto:[144,178,244,359,391,416],factor:[91,109,143,162,193,236,292,346,385,426,427,437,458,463,467,471,472],factori:[13,57,62,65,93,102,122,129,132,135,140,159,170,173,177,183,193,204,208,209,228,252,255,266,267,268,271,275,284,292,317,333,342,366,370,382,387,399,404,407,410,416,417,424,458,461,462,465,466,467,469,471,472],facundo:[460,462],fail:[5,7,9,10,17,22,28,30,31,38,43,51,52,58,62,74,78,79,82,84,90,91,92,93,94,95,96,104,105,106,110,114,141,153,155,156,167,170,177,184,193,210,212,214,216,227,245,246,248,250,251,252,254,257,260,261,265,267,269,271,272,279,284,292,293,294,295,297,298,299,305,321,324,329,331,333,334,335,337,339,342,343,346,347,350,355,359,363,366,378,382,385,386,387,392,395,402,405,410,413,416,419,424,425,428,432,437,439,442,446,451,456,458,459,460,461,462,463,464,465,466,467,468,470,471,472],fail_fast:[193,468],failed_depend:242,failfast:[385,463,472],failif:[113,385],failifalmostequ:[113,385],failifequ:[113,385],failobj:[197,206],failunless:[113,385],failunlessalmostequ:[113,385],failunlessequ:[113,385],failunlessrais:[113,385],failur:[5,7,8,9,10,14,17,21,22,23,24,25,26,28,30,31,34,35,36,38,43,45,49,50,53,54,55,58,60,62,65,74,79,95,96,105,106,135,177,178,184,188,193,214,244,252,268,279,283,293,297,298,304,318,324,333,335,339,343,346,363,369,386,387,426,432,457,460,462,463,465,466,467,468,469,470,471,472],failure_count:[193,363],failureexcept:[193,385],fair:[139,343,385,391,458,470],fairli:[57,68,75,90,93,97,100,104,107,109,193,205,209,282,305,310,331,407,408,442,456,458,459,461,462],faithfulli:[209,297,355],fake:[66,90,292,404,424,472],fakepath:363,fakeseq:459,fall:[21,38,57,58,72,90,99,103,178,182,184,187,197,206,214,227,231,267,289,291,293,295,327,343,345,346,347,391,392,424,431,437,444,456,458,459,461,462,463,464,466,468,470,471,472],fallback:[31,62,129,164,169,185,218,232,333,355,359,363,373,403,424,428,466,472],fallback_charset:210,fallback_oper:289,fals:[5,6,7,10,20,21,30,31,43,45,56,57,58,60,65,79,90,91,93,94,95,97,99,102,103,104,105,109,110,117,118,122,124,125,129,131,134,135,136,137,139,140,141,144,147,151,152,153,155,156,157,158,159,161,162,164,167,168,169,170,171,176,177,178,180,182,184,187,189,190,193,197,200,201,202,204,205,206,208,209,210,211,212,214,215,216,217,219,221,222,227,228,229,230,232,233,236,237,243,244,246,249,251,252,254,257,258,260,261,265,266,267,268,269,271,275,276,284,288,291,292,293,294,295,297,298,299,301,306,309,313,316,318,319,322,326,327,328,330,331,332,333,334,335,336,337,339,340,342,343,346,349,350,355,356,359,361,363,365,366,367,373,376,377,378,380,381,382,385,386,387,391,392,393,394,396,397,399,400,404,410,412,414,416,417,418,419,423,424,426,427,431,432,436,437,438,440,445,446,448,459,460,461,462,463,464,465,466,467,468,469,470,471,472],false_v:461,false_valu:461,falsi:472,famili:[5,15,30,38,44,58,62,65,66,71,99,109,129,133,137,141,165,201,213,236,271,284,293,300,340,357,363,407,451,455,459,460,461,463,467,470,471,472],familiar:[31,82,92,93,94,97,99,102,106,158,195,230,256,261,385,428,440,442,453,457,458,459,462,472],famou:369,fan:79,fanci:[91,97,437,442,459,463,472],fancier:[62,90,122,189,441,460,461,463],fanciest:459,fancy_getopt:71,fancygetopt:65,fancyurlopen:[392,472],fanout:236,faq:[62,65,88,93,97,227,236,254,290,307,346,391,450,455,461,463,468,472],far:[66,74,79,82,84,86,91,94,95,106,107,109,170,184,189,236,237,238,244,257,275,284,292,298,310,321,332,333,360,367,372,385,392,430,442,456,457,458,459,460,462,472],farber:85,farg:228,farrugia:455,farther:95,fasaraki:472,fashion:[167,169,261,284,310,321,339,377,410,423,424,426,437,460,463,467,468],fast:[53,58,62,93,107,108,143,161,171,185,187,212,227,236,251,252,253,254,257,260,268,273,291,301,310,318,320,368,369,380,382,410,424,438,442,450,456,460,461,463,466,467,468,469,470,471,472],fastcal:472,fastcgi:404,fastchildwatch:134,faster:[1,45,49,57,62,90,91,93,95,106,107,108,129,140,161,177,178,208,236,238,260,284,293,297,310,320,343,346,380,386,421,422,446,448,450,456,457,458,459,460,461,462,463,465,466,467,468,470,471,472],fastest:[93,95,235,284,380,421,447,462,466],fastpath:472,fat32:293,fat3:65,fat64:65,fat:[65,293,356,402],fatal:[22,30,38,54,78,79,142,215,343,359,385,434,439,463,464,467,470,472],fatalerror:412,fault:[28,62,65,103,177,186,255,292,324,367,461,463,467,472],faultcod:416,faulthandl:[62,177,186,253,334,451,472],faulthandler_suppress_crash_report:472,faulti:13,faultstr:416,favicon:225,favor:[58,95,162,225,227,243,249,251,288,293,307,337,346,363,385,392,396,460,462,464,466,468,469,470,472],favorit:[79,86,109,438,446],favorite_mood:212,favour:[45,49,252,254,461,467,470,471,472],favourit:103,fbar:292,fbb:432,fblogg:266,fcc:468,fcf:472,fchdir:[293,469],fchmod:[293,462,469],fchown:[293,462,469],fci:472,fcicreat:[282,472],fcntl:[62,253,339,388,458,459,460,462,472],fd2:293,fd_count:363,fd_high:293,fd_low:293,fdatasync:[293,469],fdcba:149,fdel:[98,227,381],fdopen:[283,293,339,424],fds:[329,339,472],fds_to_pass:472,fdst:333,feanil:471,feasibl:[57,72,79,331,468],feat:339,featur:[22,30,45,49,56,57,60,62,65,70,74,77,80,81,84,85,86,87,90,91,92,93,95,97,98,99,103,106,109,111,114,120,122,144,149,153,154,156,159,161,167,168,177,178,180,181,182,193,195,209,211,214,222,227,228,237,244,248,251,252,261,266,269,284,292,293,299,301,304,321,326,336,337,339,342,343,346,349,350,355,363,366,370,376,380,382,385,386,388,392,397,399,401,404,406,407,408,411,412,413,422,424,426,428,430,431,432,434,435,436,437,441,443,444,445,446,447,448,449,450,451,453,454,455,456,457,458,459,460,462,464,465,466,472,473],feature_external_g:[409,411,412],feature_external_p:412,feature_namespac:412,feature_namespace_prefix:412,feature_string_intern:412,feature_valid:412,featurecompon:282,featureless:227,featurenam:[114,413],feb:[94,99,184,458],februar:184,februari:[86,184,367,431,466],fed:[208,236,241,284,316,410,461],feder:422,fedora:[225,454,466,472],fedora_draft_document:454,fedoraproject:454,fedoseev:472,fee:[84,422],feed:[86,159,178,179,208,209,236,241,260,284,346,386,393,404,410,413,421,448,461,466,472],feed_eof:137,feedback:[62,86,232,422,460],feeder:[284,382],feedpars:[62,195,200,285,460,472],feel:[84,87,94,96,105,292,296,369,373,383,387,458,459,462],feff:[58,104,109,159],feli:151,felip:472,felix:472,fell:[437,447,457,458,459],felling:458,fellow:288,felt:[468,472],femal:104,fenner:462,fermat:346,fetch:[28,62,90,99,100,136,168,176,209,249,260,282,284,291,293,301,309,317,318,334,339,342,343,386,387,392,393,411,416,448,460,466,467,472],fetch_respons:382,fetchabl:456,fetchal:[161,342,461],fetched_python_logo:416,fetchmail:307,fetchmani:342,fetchon:[301,342,461,466],feugiat:151,feurzeig:380,feurzig:[],few:[5,25,30,31,64,65,66,70,79,84,91,92,94,95,98,99,103,106,109,111,122,141,143,157,159,168,171,174,177,178,184,187,189,193,199,201,225,227,232,237,241,248,251,268,282,284,292,297,301,302,319,320,321,335,337,339,343,346,349,363,368,377,385,386,391,392,421,424,430,431,436,442,456,457,458,459,461,462,463,464,466,468,469,470,472],fewer:[106,176,248,257,321,342,345,373,428,437,459,461,464,468,470,471,472],ff00:258,fff:184,fffd:[13,109,159,456],fffe:159,ffff:[102,258,456,467],ffff_ffff:470,ffffff:[184,380],ffi:470,ffi_conveni:472,ffi_prep_arg:472,fflag:329,ffoo:292,fgbg:472,fget:[98,227,381],fib2:[437,446],fib:[228,437,446],fibo:446,fibonacci:[91,228,437,445,446],fichier:109,fiction:410,fiddl:342,fiddli:386,fiddlier:[386,387],fido:436,fie:84,fiefoo:84,fieka:472,field1:463,field2:463,field:[1,2,3,5,12,19,26,28,30,31,38,50,52,53,55,57,60,62,65,69,74,79,81,82,90,93,95,96,103,111,120,124,148,153,155,159,176,178,182,183,184,187,197,203,204,206,209,210,234,235,237,243,258,260,266,272,282,291,293,312,316,318,324,327,337,339,341,343,344,346,347,349,350,351,355,357,359,362,367,370,373,375,382,391,392,395,397,402,404,408,410,419,431,436,442,448,456,457,458,459,461,462,463,465,466,467,468,469,470,471,472],field_nam:[161,347],field_size_limit:[176,461],fieldbackground:373,fieldnam:[124,161,176,462,465],fieldstorag:[153,468,469,471,472],fieldtyp:212,fieldvalu:210,fifo:[125,127,136,161,260,284,293,298,318,330,344,359,470,471,472],fifotyp:359,fifth:[109,178,248,346,367],fifti:387,fig:245,fight:[301,466],figur:[28,65,69,79,82,86,89,94,97,99,105,106,109,122,187,193,201,212,292,310,339,359,456,457,458,459,460,461,462,463,467,472],file1:463,file2:463,file:[1,7,15,19,22,24,28,29,30,37,41,45,54,60,62,64,66,67,69,70,71,72,77,78,79,81,82,83,84,86,87,93,94,96,99,101,106,107,110,112,113,117,120,121,123,124,128,130,132,133,135,137,138,140,141,142,143,144,145,146,147,150,153,154,155,157,158,159,161,164,170,172,177,178,179,184,185,186,187,188,189,190,192,197,201,202,205,207,208,209,212,213,214,216,219,221,222,225,227,230,231,232,233,236,237,241,243,244,246,249,250,251,253,254,258,259,261,263,264,265,266,268,271,273,274,276,278,280,281,284,285,288,292,294,295,297,298,299,300,301,302,303,304,305,307,309,310,311,312,314,315,316,319,321,323,324,326,328,329,330,331,332,334,335,337,339,340,342,343,344,346,349,350,353,354,355,356,357,358,360,362,363,364,366,367,368,369,374,375,376,377,378,379,380,382,384,385,386,387,388,389,390,391,392,393,396,397,399,400,401,402,403,404,406,408,409,411,413,414,416,418,419,420,421,422,424,425,426,427,428,429,431,432,435,436,437,438,439,441,443,444,445,448,449,451,452,453,456,457,458,460,461,462,463,464,465,467,472,473],file_attribute_:293,file_attribute_arch:344,file_attribute_compress:344,file_attribute_devic:344,file_attribute_directori:344,file_attribute_encrypt:344,file_attribute_hidden:344,file_attribute_integrity_stream:344,file_attribute_no_scrub_data:344,file_attribute_norm:344,file_attribute_not_content_index:344,file_attribute_offlin:344,file_attribute_readonli:344,file_attribute_reparse_point:344,file_attribute_sparse_fil:344,file_attribute_system:344,file_attribute_temporari:344,file_attribute_virtu:344,file_cont:[235,269],file_cr:66,file_dispatch:141,file_encod:159,file_handl:387,file_input:427,file_list:99,file_mtim:189,file_nam:402,file_obj:[95,456,459],file_open:392,file_or_dir:358,file_or_path:170,file_path:[252,326],file_s:[419,458],file_templ:95,file_util:[71,463,472],file_wrapp:[141,404,472],fileblock:472,filecmp:[62,189,220,253,456],fileconfig:[103,104,267,463,468,471,472],filecont:243,filecookiejar:[62,255],filedescriptor:293,filedialog:370,fileencod:431,fileentri:372,fileexistserror:[22,201,214,227,257,293,298,313,359,419,446,467,468,472],filefind:[252,304,467,472],filehandl:[62,103,104,110,120,255,266,267,462],fileinput:[62,220,227,253,293,355,461,466,472],fileio:[30,122,227,257,463,468,472],fileitem:153,filelik:404,filelineno:219,filelist:71,fileload:[252,467,468],filemod:[103,104,266,344,359,467],filenam:[12,22,30,41,54,60,62,65,66,67,69,70,72,75,77,83,90,91,95,99,101,103,104,106,111,113,122,124,145,148,151,153,157,158,159,160,161,164,168,170,176,177,185,189,193,197,198,201,202,206,214,215,219,220,225,227,232,233,235,244,248,250,251,252,253,254,264,266,267,268,269,272,280,282,284,285,286,292,293,294,295,297,299,301,304,306,310,311,321,322,331,332,333,338,350,354,355,358,359,361,363,370,372,375,377,378,380,385,387,392,396,397,400,402,403,404,408,409,410,411,418,419,424,434,442,448,451,457,458,459,460,461,462,463,464,465,466,467,468,469,470,472],filename2:[22,214],filename_onli:358,filename_or_fil:408,filename_or_stream:411,filename_pattern:378,filenameobject2:22,filenameobject:22,filenames:448,fileno:[23,54,90,104,141,151,216,219,243,257,279,284,293,295,329,330,334,339,340,343,360,361,362,370,458,461,468,472],filenotfounderror:[22,142,170,214,252,286,293,298,322,446,467,469,472],fileobj:[235,330,359,467,472],fileobject:168,filepath:294,files_hash_person:236,fileselectbox:372,fileselectdialog:372,filesystem:[5,22,30,60,62,65,66,72,74,75,86,92,109,111,129,144,145,168,214,217,220,252,253,264,271,284,293,294,299,304,326,333,343,355,361,385,386,397,418,419,446,451,455,457,463,468,471,472],filetyp:[62,120,338,463,468],filewrapp:404,filip:[467,468,472],fill:[5,7,21,30,34,38,41,43,50,55,57,58,62,81,82,86,91,97,99,104,105,107,110,119,122,124,153,176,177,178,184,193,197,202,206,224,227,246,248,252,253,257,260,268,293,337,339,342,343,346,347,349,350,363,364,367,370,424,426,428,436,448,456,458,459,460,461,462,466,467,469,470,472],fill_char:58,fillbyt:346,fillchar:346,fillcolor:380,fillstat:380,fillvalu:[260,323,462],film:298,filter:[54,62,86,91,99,101,103,113,120,121,143,161,178,186,189,214,217,219,221,227,260,267,317,329,359,363,385,386,396,418,426,438,446,448,451,456,457,458,459,460,462,463,464,466,470,471,472],filter_arm:269,filter_armthumb:269,filter_delta:269,filter_dir:[62,188],filter_ia64:269,filter_lzma1:269,filter_lzma2:269,filter_powerpc:269,filter_sparc:269,filter_trac:378,filter_x86:269,filtered_data:438,filterfals:[99,113,227,260],filterfunc:[419,468],filterwarn:[397,457,459,472],finalbodi:124,finalist:236,finalize_opt:65,financi:448,find:[1,28,30,57,62,64,65,66,68,72,74,75,78,79,81,83,84,86,89,92,93,95,96,99,101,102,103,104,105,106,109,110,111,113,114,120,122,124,139,143,149,153,159,161,178,182,184,189,190,193,196,197,198,200,201,206,208,212,214,223,228,232,233,236,237,248,251,252,253,254,265,266,273,279,281,286,292,293,301,302,304,305,315,325,333,339,342,343,346,355,361,363,364,366,367,368,370,385,386,387,391,392,399,407,418,425,426,428,430,432,434,435,436,437,438,440,446,450,451,452,453,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],find_and_load:101,find_class:301,find_execut:[65,472],find_executable_lin:470,find_g:149,find_gt:149,find_l:149,find_librari:[177,470,472],find_library_fil:65,find_lin:470,find_lines_from_cod:470,find_load:[251,252,304,428,467,468,471],find_longest_match:189,find_lt:149,find_modul:[251,252,355,420,428,459,467,468,471,472],find_msvcrt:177,find_recursionlimit:456,find_spec:[251,252,304,355,428,468,469,471,472],find_str:470,find_unused_port:363,find_user_password:392,findal:[106,161,321,410,447,468,472],findcal:266,finder:[28,62,90,93,193,252,269,280,304,355,429,453,455,460,462,467,468],findertool:462,findfactor:143,findfil:[363,472],findfirstfil:469,findfirstfilew:293,findfit:143,findit:[106,280,321,458],findlabel:190,findleak:472,findlinestart:190,findmatch:272,findmax:143,findnextfil:469,findnextfilew:293,findtext:[410,472],fine:[69,79,84,85,90,91,92,104,107,109,110,168,177,178,193,202,227,244,292,293,321,343,370,386,392,424,442,447,448,453,455,456,457,459,461,472],finer:[62,80,93,103,129,183,266,293,440,471,472,473],finger:[245,464],finish:[5,56,66,69,78,85,90,91,93,95,101,103,104,128,129,139,140,145,151,157,167,170,229,243,257,269,284,316,334,340,342,343,346,350,359,363,385,400,408,409,410,413,416,419,421,423,424,439,442,448,451,461,462,466,467,469,470,472],finish_request:340,finit:[17,24,31,90,97,99,106,156,187,223,275,346,355,424,440],fink:472,finlei:321,fioasync:472,fioclex:472,fionbio:472,fionclex:472,fionread:472,fiori:462,fip:[236,472],fips180:236,fire:[82,101,104,122,141,334],firefox:[392,400,461,472],firewal:[102,225,248,284,406,457,467],first:[1,5,12,13,14,15,17,21,22,24,28,30,31,33,35,37,38,41,43,45,49,52,53,54,55,57,58,61,62,64,65,72,74,75,78,79,80,81,82,83,84,85,90,91,92,93,94,97,98,99,102,103,104,105,106,107,108,109,110,111,112,114,119,122,123,124,129,134,136,139,140,141,142,143,145,149,152,153,155,157,158,159,161,167,168,170,172,176,177,178,179,184,185,187,189,190,193,196,197,198,200,201,202,203,204,206,208,209,210,212,214,215,216,219,223,225,227,228,230,231,232,236,237,243,244,245,248,249,251,252,254,256,257,258,260,264,265,266,267,268,271,272,275,276,279,282,284,287,288,291,292,293,294,295,297,298,299,301,303,305,309,310,315,316,318,321,322,326,329,331,332,333,334,337,339,340,342,343,344,346,347,349,350,354,355,357,359,360,361,362,363,365,367,368,370,372,373,374,375,377,378,380,381,382,384,385,386,387,391,392,395,397,398,399,402,404,405,407,410,411,416,418,419,421,423,424,425,426,428,430,431,432,433,434,435,437,438,439,440,441,442,444,446,448,451,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],first_16:177,first_complet:[140,167],first_except:[140,167],first_lin:190,first_nam:[176,321],first_patch:386,first_sunday_on_or_aft:184,first_tru:260,first_us:382,firstchild:407,firstheaderlineiscontinuationdefect:200,firstit:355,firstkei:185,firstli:[104,326,346],firstlin:159,firstlineno:12,firstnam:[228,342,466],firstweekdai:152,fish:[110,301,386,387,396,449,468,472],fishi:386,fit:[31,65,74,79,84,96,102,107,122,126,148,177,178,179,187,190,193,196,216,225,237,238,252,258,292,309,310,320,339,349,365,380,385,392,407,418,421,422,448,459,460,463,466,467,468,472],fitzroi:459,five:[86,93,95,104,149,187,268,271,292,293,301,320,321,338,340,342,343,355,391,456,462,467],fix:[1,19,31,38,50,57,62,74,83,84,85,86,89,90,91,93,94,95,97,99,105,106,107,111,112,113,128,129,140,153,160,161,162,177,178,183,184,193,202,225,227,237,244,248,253,260,284,288,290,293,301,321,346,347,349,352,366,382,386,404,405,449,451,456,460,461,462,464,466,467,468,469,470,471,472,473],fix_import:[95,301,465],fix_missing_loc:124,fix_sentence_end:365,fixcid:472,fixer:[62,188,472],fixtur:[62,188,463],fkeyword:228,flag:[7,9,12,17,23,26,30,39,45,53,54,56,57,58,60,62,65,78,79,81,82,94,102,103,105,108,109,113,114,120,124,125,129,137,139,144,145,153,157,159,177,178,182,183,184,185,187,188,190,197,208,209,210,216,222,227,229,239,244,249,257,265,266,267,271,276,279,282,283,284,288,293,297,298,303,307,308,309,315,316,317,319,321,329,331,333,334,335,339,340,342,343,344,346,347,350,352,355,358,361,362,363,366,367,370,373,382,385,391,392,397,403,404,405,416,417,419,424,428,446,451,457,458,459,460,461,462,463,465,466,467,468,469,470,471,472],flag_bit:419,flag_list:249,flagstaff:99,flagstr:249,flake8:472,flaki:472,flanagan:472,flash:[97,178,472],flat:[189,202,205,370,373,409],flatten:[161,197,202,203,204,206,209,260,301,346,382,438,468,469,472],flavor:[65,81,93,107,193,225,236,293,344,346,385,426,441],flavour:[106,109,252,298,359,387,461],flaw:[90,93,386,458,466,472],flawlessli:[461,462],fledg:65,flew:439,flexibl:[62,74,79,90,93,94,95,98,102,103,104,106,113,135,153,161,170,177,189,193,197,206,209,232,266,267,284,292,295,346,350,359,367,386,397,408,410,424,435,436,447,448,456,457,459,461,463,464,466,469,473],flicker:[97,178],flip:472,flist:472,float_info:[93,346,355,446,462],float_repr_styl:[355,446,463],floatabl:292,floatingpointerror:[22,214,446],floatnumb:[227,426,431],floatoper:[187,467],flock:[216,271,472],flood:472,floor:[43,91,93,105,167,184,187,193,223,227,275,289,346,424,426,445,458,462,472],floordiv:[99,124,291],florent:[463,466],flori:462,florian:472,flour:342,flow:[31,62,79,99,132,135,137,178,179,187,222,339,350,360,423,425,426,438,441,446,456,458,459,461,462,469,472],flow_stmt:427,flowinfo:339,flp:462,flt:223,flt_radix:355,flt_round:355,flufl:347,fluri:472,flurri:[97,456],flush:[30,103,104,107,117,129,132,135,137,141,151,159,178,215,222,227,246,257,266,268,269,271,279,284,293,316,324,334,339,350,355,396,402,404,410,421,467,468,470,472],flush_head:[246,467],flush_level:104,flush_softspac:222,flusher:402,flushinp:178,flushkei:402,flushlevel:[104,268],flushonclos:268,fly:[31,62,81,84,187,227,247,435],fma:187,fmod:[275,426],fmt:[103,104,184,202,266,295,306,363,448,462,472],fmt_binari:[306,468],fmt_spec:190,fmt_xml:[306,468],fmtparam:176,fn_call:101,fname:[91,109,170,267,378,468],fnctl:472,fnmatch:[62,220,233,253,350,378,385,472],fnmatchcas:[221,385],fnum:104,fnv:468,fobj:434,focal:411,focu:[87,107,184,209,248,359,370,373,380,391,447,463,467,470,472],focus:[64,110,461,466,468],focuss:91,fogl:472,foil:337,fold:[19,184,203,204,209,252,298,348,422,460,461,470,471,472],fold_binari:209,folder:[66,249,271,396,453,455,472],foldspac:144,folk:448,follow:[4,5,6,7,9,13,17,19,22,26,30,31,35,37,38,41,45,47,50,53,57,58,60,65,66,69,72,74,75,77,78,79,81,82,83,84,85,86,90,91,92,93,94,95,96,97,98,99,101,102,103,104,105,106,107,108,109,110,111,112,113,114,117,118,119,122,123,124,125,128,129,130,132,133,134,135,137,138,139,140,141,142,143,145,147,148,149,151,152,153,155,156,157,158,159,160,161,162,163,165,167,168,170,171,174,176,177,178,179,180,182,183,184,185,187,189,190,193,195,196,197,198,200,202,203,204,205,206,208,209,210,212,213,214,216,217,219,222,223,225,226,227,228,229,230,232,233,234,235,236,237,238,241,242,243,244,245,246,248,249,250,251,252,254,257,258,260,261,264,265,266,267,268,269,270,271,274,275,279,284,286,287,288,289,290,292,293,294,295,297,298,299,301,303,304,306,307,308,309,310,311,312,314,316,318,320,321,322,324,325,327,329,330,332,333,334,335,336,337,339,340,341,342,343,344,345,346,347,349,350,351,355,356,357,359,360,361,362,363,365,366,367,368,370,371,372,373,374,375,376,377,378,379,380,381,382,384,385,386,387,390,391,392,393,394,395,396,397,398,399,400,402,403,404,405,406,407,408,409,410,411,412,413,416,417,418,419,420,421,422,423,424,425,426,427,428,430,431,432,433,436,437,438,439,442,444,445,446,447,448,449,451,454,455,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],follow_symlink:[293,333,467,472],follow_wrap:[254,469,472],followlink:[293,462],font:[109,168,213,222,248,365,370,372,373,380,444,470,471,472],fontnam:380,fontpag:472,fontset:372,fontsiz:380,fonttyp:380,fontxxx:472,foo1:[74,284,321],foo2:[74,284,321],foo3:321,foo:[26,65,66,68,69,72,74,84,85,91,92,93,94,95,103,104,106,110,111,118,122,124,140,153,157,168,177,193,197,201,212,230,244,248,251,252,254,261,265,266,267,272,284,288,291,292,293,294,298,301,304,310,313,321,335,342,346,355,359,363,382,385,386,387,402,404,408,409,410,419,420,423,426,428,431,432,456,458,459,462,463,464,465,466,467,468,469,471,472],foo_bar:[68,122,292,387],foo_bcpp:111,foo_const:363,foo_inst:91,foo_on:386,foo_pars:122,foo_test:[385,471],foo_two:386,foo_typ:57,foo_var:91,fooaction:122,foobar:[69,91,122,221,227,292,321,387],foobarbaz:386,foobl:[386,387],food:[79,93,301,442],foofil:104,fool:[84,91,456,460],foolish:86,foomodul:111,foon:122,foonlei:122,foopkg:69,foord:[110,463,466],foot:[107,447],footer:[343,472],footest:[385,471],footnot:[62,68,79,82,111,118,153,155,168,176,184,193,198,199,201,202,204,206,209,210,227,232,237,240,261,274,299,301,316,342,343,346,367,384,400,408,410,416,423,424,425,426,428,431,434,436,437,438,444,445,446,450],footprint:[38,97,229,467,470,472],fopen:[60,467],for_it:190,for_loop:461,for_stmt:[423,427],forai:111,forbid:[261,301,343,346,406,463],forbidden:[22,38,110,212,242,301,346,366,462,469,472],forbiddenbyt:[38,470,472],forc:[5,30,57,62,65,66,79,84,90,91,93,99,102,105,111,129,135,154,160,164,178,182,184,185,187,193,236,241,248,249,257,283,288,293,310,311,313,321,328,334,347,349,350,355,361,363,367,386,399,404,424,428,439,442,451,463,467,468,469,470,472],force_zip64:419,forcibl:[111,227,467,468],foreach:101,forego:[195,422],foreground:[97,178,248,373,448],foreign:[62,105,120,168,253,333,342],foreseen:111,forest:380,forev:[107,125,132,311,329,457,458,459,460,467],forewarn:182,forgeot:[462,463,465,466,472],forget:[30,31,65,68,78,79,95,187,342,363,373,426,436,460,461,462,466,472],forgiv:[93,456],forgot:84,forgotten:[79,109,128,438],fork:[30,54,74,79,90,104,148,214,229,279,284,293,311,329,333,340,343,459,463,468,471,472],forkingmixin:[340,467,471,472],forkingtcpserv:340,forkingudpserv:340,forkpti:293,forkserv:[62,165,468,472],form01:267,form02:267,form03:267,form04:267,form05:267,form06:267,form07:267,form08:267,form09:267,form:[1,5,7,9,22,28,30,33,34,49,50,57,58,62,65,66,70,74,78,79,84,85,86,87,91,93,94,95,97,99,102,103,104,106,107,109,110,111,114,122,129,136,145,153,159,162,168,170,176,177,178,179,184,187,189,190,193,197,198,199,201,204,206,207,209,210,214,222,223,227,228,230,232,241,242,243,245,246,249,251,254,256,258,260,265,266,267,268,271,273,274,276,284,288,293,294,297,298,300,304,306,307,309,318,321,335,339,342,343,344,346,347,348,349,351,355,359,363,365,366,367,368,369,370,373,380,384,385,386,387,391,392,395,397,402,404,405,407,410,416,418,421,422,423,424,425,428,431,432,433,435,436,437,439,440,441,442,446,448,451,455,456,457,458,460,461,462,463,464,465,466,467,468,469,470,471,472],formal:[62,65,80,95,193,236,292,297,321,346,347,391,411,418,424,425,426,430,432,437,441,456,458,465,468,469,472],format:[2,5,9,22,28,29,31,37,44,45,54,57,58,59,62,64,65,66,72,74,75,79,81,85,86,90,91,92,93,94,95,97,98,105,106,107,109,110,111,112,113,119,120,121,122,124,135,141,143,144,145,146,147,148,152,153,154,155,161,165,168,170,174,177,184,185,187,189,190,191,193,195,197,201,202,203,204,206,208,209,210,212,213,214,225,227,230,232,235,236,241,244,246,249,250,251,252,253,254,258,260,261,264,265,266,268,269,272,274,276,277,282,285,286,291,292,293,294,295,296,298,300,302,304,305,306,307,309,310,316,319,321,322,323,328,331,332,333,336,337,339,340,342,343,350,351,355,360,364,367,369,370,372,373,375,377,378,380,381,385,391,392,394,395,397,398,402,404,410,414,419,420,421,423,424,426,430,436,437,438,439,440,441,445,446,447,449,451,456,457,458,459,460,461,466,467,468,471,472,473],format_alon:269,format_auto:269,format_cod:17,format_datetim:[204,210,467],format_exc:377,format_except:377,format_exception_onli:[193,377],format_field:347,format_help:122,format_list:[377,472],format_map:[161,346,466,469,472],format_raw:269,format_spec:[124,227,347,424,431,462,472],format_stack:[377,472],format_stack_entri:145,format_str:[265,347,448,461,469,471,472],format_tb:[377,378],format_usag:122,format_valu:[190,470,472],format_xz:269,formataddr:[210,467],formatannot:254,formatarg:254,formatargspec:[254,469,472],formatargvalu:[254,469],formatd:[210,460,472],formaterror:[177,271],formatexcept:[104,266],formatmessag:[22,177,214],formatmonth:152,formatmonthnam:152,formatparagraph:472,formatreturn:254,formatstack:266,formatt:[58,62,120,122,253,267,268,277,292,347,459,463,466,468,469,471,472],formatted_err:385,formatted_lin:377,formattedvalu:124,formatter_class:[62,120],formatter_form01:267,formatter_simpleformatt:103,formattim:266,formatvalu:254,formatvararg:254,formatvarkw:254,formatwarn:[266,397,462,472],formatweekdai:152,formatyear:152,formatyearpag:152,formed:413,former:[22,28,40,65,66,122,145,160,172,177,178,184,187,251,252,254,266,288,310,324,333,370,372,373,380,395,424,426,428,466,467,470,471,472],formerli:[57,81,136,162,167,245,284,296,318,320,367,465,466,467,470,471],formfe:[347,365,431],formula:[84,184,232,346,472],forth:[22,66,72,74,91,97,106,107,111,161,293,321,329,424,456,458,459,461],fortran:[7,84,93,346,440,457,460,462],fortun:[79,82,84,97,153,464],forum:103,forward:[58,65,84,95,96,99,106,124,149,155,157,177,178,184,201,228,232,248,257,271,289,294,297,298,299,342,343,380,382,399,404,408,423,438,443,450,456,457,458,460,462,465,466,471,472],forwardref:[382,472],forwardx11:168,fos:472,foster:[100,472],found:[4,5,13,16,20,21,28,30,31,41,45,50,54,57,58,64,65,69,72,73,74,76,77,78,79,82,83,84,85,86,91,93,95,98,99,101,103,104,106,109,110,112,114,122,124,125,137,151,153,159,161,163,164,168,171,172,176,177,178,190,193,197,198,200,204,206,208,209,212,214,216,217,225,227,228,229,230,232,234,237,241,242,243,244,245,246,248,249,251,252,254,256,260,264,265,266,267,269,271,272,274,276,279,280,283,284,286,293,295,297,298,299,304,312,316,320,321,324,333,334,337,339,341,342,343,346,350,355,356,359,360,363,373,375,381,384,385,387,390,392,397,403,404,407,409,410,411,412,416,417,420,422,423,424,425,426,428,430,431,432,436,437,438,439,442,443,444,446,447,448,449,453,455,456,457,458,459,461,463,464,465,466,467,468,469,470,471,472],found_termin:125,foundat:[63,64,74,87,99,112,126,170,343,422,453,455,459,460,462,467],four:[28,38,53,58,84,86,94,97,106,107,109,122,159,178,189,190,208,212,225,240,243,248,254,258,267,271,279,282,292,316,320,335,339,340,346,347,351,370,373,380,386,412,431,437,448,455,462,465,466,472],fourfold:456,fourier:450,fourth:[53,95,99,114,178,190,195,294,309,367,416,458],fourthought:456,foutfil:292,foxnew:167,fp1:294,fp2:294,fpathconf:293,fpectl:[471,472],fpformat:462,fpic:77,fprintf:[78,79],fpu:472,fqdn:[336,337],frac_digit:[265,448],fractalcurv:380,fraction:[62,79,86,109,161,184,187,193,227,253,260,265,275,289,290,310,320,321,342,343,345,346,366,367,380,426,431,440,445,458,459,460,461,463,464,465,469,470,472],fragil:472,fragment1:143,fragment2:143,fragment:[60,84,85,99,143,147,297,316,343,346,391,392,409,410,461,463,466,467,472],frame:[11,12,18,22,27,30,31,45,48,60,62,84,90,91,101,119,140,143,144,145,172,178,186,190,212,215,248,254,261,266,299,334,338,339,343,346,351,355,370,371,372,373,377,381,398,404,423,424,425,451,457,459,460,461,463,467,468,469,471,472],frame_gen:377,frame_lineno:145,frameinfo:254,framemak:[178,370],frameptr:101,framer:[119,338,351,398],framesummari:[62,317,469,472],frametyp:381,framework:[62,65,84,90,118,125,126,129,135,157,168,171,177,186,188,193,195,242,248,253,255,296,335,337,343,355,382,386,392,404,417,424,453,458,459,462,463,464,466,468,469,471,472,473],franc:99,francesco:459,francisco:[343,393,472],francoi:463,francoton:225,frank:[321,472],frankenstein:365,franklin:463,franz:472,fraser:459,frechet:463,fred:[0,104,316,370,431,456,457,458,459,461,462,470],frederick:345,fredrik:[0,91,97,99,370,383,416,422,456,457,458,460,461,463,465,466],free:[5,7,10,12,16,17,21,24,30,31,34,38,40,47,50,54,55,57,58,64,79,81,82,84,85,86,87,90,91,93,94,96,99,105,107,111,136,159,167,177,189,190,227,229,231,232,254,284,292,293,305,318,333,346,354,355,363,378,383,385,396,399,407,416,417,422,423,424,425,426,428,432,441,442,455,457,458,459,461,462,464,466,467,468,472],free_list:462,freebsd8:355,freebsd:[62,97,135,293,295,324,329,339,355,363,367,452,461,468,471,472],freed:[7,16,21,24,30,34,38,40,41,50,55,58,62,79,81,167,229,237,284,330,424,448,457,459,461,470,472],freedbsd:472,freedesktop:467,freedom:[345,432],freefunc:[41,57,81],freeli:[64,86,105,125,141,193,346,422,441],freevar:[12,472],freewar:87,freez:[28,91,167,228,229,248,288,449,471,472],freeze_support:284,freht:[463,466,472],french:[106,109,110,367,469,471],frequenc:[104,119,229,351,398,403,462],frequent:[7,31,62,79,81,90,91,101,106,107,109,110,161,165,169,184,189,248,265,268,284,288,292,307,385,421,434,437,438,442,447,450,459,460,462,463],fresh:[57,93,95,99,159,170,284,309,326,363,428,454,455,458,459,472],freshfruit:438,freshli:[22,91,95,381],freshmeat:458,frexp:275,fri:[152,210,466,467,472],fridai:152,frie09:321,friedl:[106,321],friend:[31,57,79,111,346,387,460,464,472],friendli:[1,57,97,104,122,195,229,292,355,385,410,436,456,468,471,472],friendlier:[296,370],frob:[230,387],frobbl:122,frobnic:[385,399],from:[0,1,3,5,6,7,8,9,10,11,14,15,19,21,22,23,24,25,26,28,31,32,34,35,36,37,38,39,41,42,43,45,47,49,50,51,52,53,54,55,56,57,58,59,60,61,62,64,66,68,69,70,71,72,74,75,77,78,80,81,82,83,84,86,87,89,93,94,95,96,97,98,99,101,102,105,106,107,108,109,110,111,112,113,114,115,116,118,119,120,122,123,124,125,127,128,129,130,131,132,135,136,137,138,139,141,142,143,144,145,148,151,152,153,154,155,157,158,159,161,162,163,164,165,167,168,171,172,174,176,178,179,180,182,184,187,188,189,190,193,194,195,196,197,198,199,200,201,202,203,204,205,206,208,209,210,211,212,213,214,217,220,222,223,224,225,227,228,229,231,232,235,236,237,241,242,243,244,245,246,248,249,250,251,252,253,254,256,257,258,260,261,264,265,266,267,268,269,271,272,274,275,276,279,280,281,282,284,285,286,288,289,290,291,292,293,294,295,297,298,299,300,301,302,303,304,305,306,307,308,309,310,311,313,314,315,316,317,318,320,321,322,323,324,325,326,327,328,329,330,331,332,333,334,335,336,337,338,339,340,342,343,344,345,346,347,348,349,351,354,355,356,359,360,361,362,363,365,366,367,368,370,371,372,373,374,375,376,377,378,382,383,384,385,386,391,392,393,394,395,396,397,399,400,401,402,403,404,405,406,407,408,409,410,411,412,413,416,417,418,419,421,422,423,424,425,426,427,428,430,431,432,433,434,436,437,438,439,440,441,442,443,444,445,447,448,449,450,451,452,453,454,456,457,458,460,461,463,464,465,466,467,468,469,470,471,472,473],from_:[197,271,373],from_addr:[337,466],from_address:177,from_buff:[177,462,472],from_buffer_copi:[177,462,472],from_builtin:[95,469,472],from_byt:[346,472],from_cal:[254,469,472],from_celsiu:466,from_decim:[223,466],from_except:377,from_fahrenheit:466,from_fil:[419,470,472],from_float:[187,223,440,463,465,466,472],from_funct:[469,472],from_iter:[260,462,472],from_kal:472,from_list:377,from_param:177,from_start:58,from_str:471,from_traceback:[190,468],from_what:442,fromaddr:[90,267,268,337,343],fromag:106,frombuf:359,frombyt:[123,466],fromdat:189,fromdesc:189,fromfd:[329,339],fromfil:[123,189,464],fromfile_prefix_char:[62,120],fromfiled:189,fromhex:[147,346,440,462,470,471,472],fromisoformat:[184,471,472],fromkei:[98,161,346,381,459,466],fromlin:189,fromlist:[28,123,190,227,251,252,472],fromnam:225,fromordin:[184,471],fromshar:[339,471],fromstr:[123,339,410,466],fromstringlist:[410,466],fromtarfil:359,fromtimestamp:[19,184,189,306,471,472],fromunicod:123,fromutc:[184,472],front:[31,34,65,91,95,106,161,170,189,202,209,248,256,260,298,304,387,392,397,404,420,424,426,438,451,456,459,461,463,472],frontend:159,frontier:343,frown:[86,446],frozen:[28,62,86,177,227,251,252,284,304,317,355,378,424,428,455,459,468,471,472],frozenimport:[252,468],frozeninstanceerror:182,frozenmain:30,frozenset:[50,62,93,183,227,253,274,301,382,385,399,424,426,446,460,461,462,466,472],frozent:177,fruit:[212,309,424,438],fs_is_case_insensit:363,fs_nonascii:363,fsdecod:[22,60,93,293,355,451,466,470,472],fsencod:[93,293,298,355,363,451,466,470,472],fset:[98,227,381],fspath:[93,293,298,470,472],fsrc:333,fstat:[293,294,344,458,467,469,472],fstatvf:[293,458,469],fsum:[227,275,440,462],fsync:[293,469,472],ftp1:[225,466],ftp:[62,86,110,253,255,268,286,343,391,392,454,456,457,462,463,467,472],ftp_open:392,ftp_tl:[62,255,463,466,467],ftpd:225,ftphandler:[62,110,255],ftplib:[62,159,253,255,392,457,459,462,463,466,468,469,470,472],ftpmirror:458,ftpwrapper:[462,472],ftruncat:[90,293,469,472],fts3:342,fuch:467,fudg:245,fugu:225,fuhrer:472,fulfil:[94,110,242,246,343,370,457,459,466],full:[10,30,31,57,58,62,65,66,74,79,82,84,86,90,91,93,94,95,97,98,99,103,104,105,106,110,126,127,136,141,149,150,152,158,159,161,162,164,168,169,174,176,177,181,184,187,189,193,198,201,202,213,214,220,222,224,227,229,244,248,251,257,258,260,266,268,275,281,282,284,292,293,295,297,299,304,305,316,318,321,332,333,334,337,339,340,343,346,349,350,355,359,363,367,370,380,381,382,385,386,391,392,396,399,400,404,408,410,416,419,424,425,428,429,432,436,438,440,442,444,445,446,448,451,452,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],full_distribution_nam:305,full_url:[110,392,468],fullargspec:254,fullcircl:380,fuller:[84,457],fulli:[7,30,41,57,65,68,75,77,87,91,93,105,109,122,130,133,136,187,193,198,204,208,209,222,252,256,267,268,284,301,304,305,318,334,336,337,339,346,359,385,395,404,407,410,414,418,420,428,436,455,458,463,464,466,467,468,469,470,472],fullmatch:[321,468,472],fullmodnam:470,fullnam:[164,251,252,304,420,459],fulltext:[342,466],fullurl:392,fullwidth:187,fulton:[456,460,470,472],fum:84,fun:[90,168,228,380,382,385,470],fun_num:228,func1:91,func2:91,func3:91,func4:91,func:[30,31,40,48,54,60,65,84,91,93,99,122,124,129,140,142,145,167,177,178,213,228,254,260,266,284,292,310,316,333,342,346,355,363,366,368,370,376,385,399,417,423,460,462,464,466,467,470,472],func_closur:[113,464],func_cod:464,func_default:464,func_descr_get:98,func_dict:464,func_doc:464,func_glob:464,func_nam:[460,464],func_spec:177,func_x:464,funcattr:113,funcdef:[423,427],funcnam:[12,65,78,101,145,266,423,436],funcobject:98,function_1:[84,101],function_2:[84,101],function_3:101,function_4:101,function_5:101,function__entri:101,function__return:101,function_that_returns_a_future_object:140,functional_program:99,functiondef:[124,472],functionnam:95,functiontestcas:385,functiontyp:[25,381],functool:[62,91,93,108,113,129,131,161,226,227,253,254,260,346,424,461,462,463,464,465,472],fund:[448,456,461],fundament:[29,30,31,57,62,72,84,86,93,107,120,195,258,284,292,301,309,310,320,381,382,399,428,455,456,462,470],funk:[232,456],funki:[168,212],funni:[97,143],funny_fil:217,furman:[467,468,469,470,471,472],furnish:422,furrer:472,furrfu:458,further:[7,30,37,57,62,79,81,82,84,85,86,91,93,95,96,99,102,103,104,107,109,110,118,123,125,141,145,151,153,155,159,170,174,177,182,188,190,193,214,219,227,230,232,241,248,257,265,266,269,275,283,292,293,295,299,301,321,333,334,339,340,343,346,347,355,367,370,377,382,406,407,412,418,421,424,426,428,431,436,451,455,456,457,458,459,460,462,463,467,471,472],furthermor:[30,84,90,111,122,159,254,267,268,271,326,346,382,418,455,468],fusc:151,fuse:187,fut:[128,131],futur:[5,31,62,65,75,83,90,93,95,103,104,105,106,111,113,126,128,130,132,135,140,141,157,160,165,166,168,176,184,193,198,204,206,208,209,211,214,227,229,232,237,252,253,254,267,286,292,297,310,317,321,327,329,336,339,343,345,358,363,366,367,382,385,392,395,397,406,410,421,423,424,431,436,442,446,455,456,457,458,459,460,461,462,467,468,472,473],future_builtin:[62,113],future_stmt:432,future_to_url:167,futurewarn:[22,214,321,397,446,459,460,463,471,472],fuzz:472,fuzzili:237,fwalk:[293,467,471,472],fwrapv:78,fxn:397,g3805:466,g722:119,g9gthfe1yluxy1zwplyk1:236,gabriel:463,gadget:472,gaedk:462,gai:[422,463,465],gai_strerror:339,gaierror:339,gaifax:[471,472],gailli:422,gain:[86,90,104,145,161,187,257,301,355,392,428,430,459,460,461,462,463,465,466,467,468,469,470,471],galact:449,galeon:400,galindo:[471,472],gallagh:472,gallahad:[161,438,465],gallew:456,game:[107,122,380,435,461,462],gamma:[275,320,463,466],gamma_funct:466,gammavari:320,ganisin:472,ganssl:[471,472],gap:[184,268,271,370,466],gar:298,garbag:[3,29,38,41,46,47,57,61,62,79,80,81,90,91,93,99,101,104,107,128,141,153,160,170,171,177,180,193,214,253,274,284,292,293,317,339,342,355,361,363,368,385,399,408,423,424,426,442,448,458,459,460,461,462,463,465,466,467,468,470,471,472,473],gareth:472,gari:449,garlic:342,garshol:456,garvit:[471,472],gasc:472,gass:460,gatewai:[62,86,110,253,255,450,461,473],gateway_timeout:242,gather:[97,101,122,127,136,138,140,178,212,227,229,293,310,339,343,376,385,469,471,472],gather_t:467,gauss:320,gaussian:[90,320,466],gautier:472,gave:[91,109,385,463,466,472],gavin:469,gawain:[463,466],gay:[468,470,471,472],gaynor:[463,469,472],gb18030:[159,460,472],gb2312:[159,384,460,467],gbk:[159,460],gc__done:101,gc__start:101,gc_collect:363,gcc:[30,65,77,111,177,305,355,444,451,455,462,463,465,468,470,472],gcd:[223,275,469,472],gcm:343,gcov:468,gdb7:472,gdb:[85,463,472],gdbinit:[85,463,472],gdbm:[74,90,185,464,472],gdppc:410,ge29873:288,gecko:392,gedai:472,gedmina:109,geert:[459,469,472],gellekum:457,gen:[99,254,260,426,458,459,466,469,472],gen_clos:[254,466],gen_coro:254,gen_creat:[254,466],gen_data:151,gen_func:381,gen_lib_opt:65,gen_mov:448,gen_preprocess_opt:65,gen_rid:472,gen_run:254,gen_suspend:[254,466],gen_uuid:282,gencoro:162,genellina:463,gener:[0,1,5,7,11,13,15,22,28,29,30,31,33,36,45,49,53,56,57,60,62,65,66,68,69,71,74,75,77,78,79,82,83,84,85,88,92,93,98,101,102,103,104,106,107,109,111,113,114,118,122,124,125,129,132,135,136,138,143,144,145,147,153,154,157,159,161,162,164,167,168,170,172,174,175,176,177,178,182,183,184,185,187,188,189,190,192,193,195,197,201,204,206,209,210,214,218,220,225,226,227,228,229,231,232,236,237,241,243,244,245,246,248,249,251,252,253,257,260,263,265,266,267,268,269,271,273,274,275,277,282,284,285,288,289,290,291,293,296,297,301,307,309,311,313,316,317,321,322,323,325,327,331,332,336,337,339,342,344,347,348,350,352,353,355,358,359,363,365,366,367,372,373,374,375,376,377,380,381,384,385,386,391,392,395,399,402,404,405,406,407,408,409,410,411,412,414,416,417,418,421,422,423,425,427,428,430,431,432,435,437,438,439,440,441,442,446,450,452,455,456,457,462,463,464,465,466,467,468,472,473],general_quest:466,generalis:104,generate_help:65,generate_int:[99,458,459],generate_opcode_h:472,generate_token:464,generator:458,generator_express:426,generator_stop:[114,214,432,469,472],generatorexit:[22,99,214,424,426,446,461,462,472],generatorexp:124,generatorproxi:284,generatortyp:381,generic_visit:124,genericbrows:400,genexp:99,genop:302,genpag:472,gensuitemodul:462,gent0113:184,gentl:[82,94,102,122,458],gentler:[106,321],gentli:342,genuin:[79,193,216,463,466],geoff:[79,472],geograph:[184,450],geometri:[62,369,370,371,373,472],geometric_mean:472,georg:[109,260,442,461,462,463,465,466,467,469,470,472],georgiou:466,gerald:99,gerber:459,gerg:472,gerhard:[342,458,461,462,463],german:[109,159,265,346,380,468],gestalt:189,get:[5,7,13,16,21,22,28,30,31,35,36,38,41,44,45,49,52,53,57,58,60,62,65,68,69,74,77,78,79,81,82,83,85,92,93,95,97,98,99,101,103,104,105,106,107,108,109,110,111,112,119,122,128,129,131,132,135,136,138,139,140,141,143,145,152,153,159,161,162,168,170,171,177,178,184,185,186,187,188,189,193,197,201,206,207,209,210,212,214,217,227,229,230,232,234,236,237,243,244,246,248,249,253,254,256,257,260,261,264,265,266,267,268,271,280,282,284,288,289,292,293,295,299,301,304,305,307,310,311,315,318,320,322,324,328,331,332,333,334,335,337,339,340,342,343,344,345,346,347,350,351,355,356,359,360,361,363,367,370,372,373,377,380,381,382,385,386,391,392,395,396,397,398,399,400,404,407,408,410,411,412,413,415,416,417,421,423,424,428,433,434,435,436,439,440,444,445,446,448,449,452,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],get_ait:190,get_al:[197,206,210,404],get_algorithm_impl:472,get_all_break:145,get_all_link:460,get_all_start_method:[284,468],get_all_us:170,get_an_available_item:366,get_anext:190,get_app:404,get_archive_format:[333,466],get_asyncgen_hook:355,get_attribut:363,get_await:190,get_begidx:[322,472],get_block:[293,469,472],get_bodi:[201,206,208],get_body_encod:196,get_boundari:[197,206],get_bpbynumb:145,get_break:145,get_buff:[132,135,405],get_byt:[271,466],get_ca_cert:[343,468],get_cache_token:[118,468],get_channel_bind:[343,467],get_charset:[197,206],get_child_watch:[134,138],get_children:[354,373],get_ciph:[343,470,472],get_clock_info:[367,467,472],get_close_match:189,get_cod:[252,420,468],get_complet:322,get_completer_delim:322,get_completion_typ:322,get_config_h_filenam:[65,356],get_config_var:[65,78,293,356,463,466,468,472],get_connect:170,get_cont:[197,198,201,206,209],get_content_charset:[197,206],get_content_disposit:[197,206,469],get_content_maintyp:[197,201,206],get_content_subtyp:[197,206],get_content_typ:[197,201,206],get_context:[284,468],get_coroutine_origin_tracking_depth:[355,471],get_coroutine_wrapp:[355,469,471],get_count:[229,461],get_current_history_length:[322,459],get_dat:[135,138,271],get_data:[252,304,392,420,462,468,472],get_debug:[129,132,229,469],get_default:122,get_default_compil:65,get_default_domain:287,get_default_typ:[197,206],get_default_verify_path:[343,468],get_dialect:176,get_distutil_opt:459,get_docstr:[124,472],get_doctest:193,get_endidx:[322,472],get_endpoint:387,get_environ:404,get_errno:[177,462],get_event_loop:[129,132,134,140,469,470,471,472],get_event_loop_polici:[132,134],get_exampl:193,get_exception_handl:[129,132,469,470,472],get_exec_path:293,get_extra_info:[132,135,137,171,472],get_field:347,get_fil:[271,466],get_file_break:145,get_filenam:[197,201,206,252,420,468],get_flag:271,get_fold:271,get_fre:354,get_freeze_count:[229,471],get_from:271,get_full_url:[244,392],get_glob:354,get_grouped_opcod:189,get_handle_inherit:[293,468],get_head:[244,382,392],get_history_item:[322,459],get_history_length:[322,472],get_host:[244,392,468],get_id:[117,334,354,366,367,467],get_identifi:354,get_import:304,get_info:271,get_inherit:[293,339,468],get_input:91,get_instruct:[190,468],get_interpret:418,get_it:190,get_item_point:7,get_iter:118,get_kei:[330,472],get_label:271,get_last_error:[177,462],get_line_buff:[322,325],get_lineno:354,get_load:[304,472],get_loc:354,get_lock:284,get_logg:284,get_loop:[129,131,471,472],get_mag:[251,468],get_makefile_filenam:[65,78,356],get_map:330,get_matching_block:[189,461,472],get_messag:271,get_method:[354,392,467],get_mixed_type_kei:258,get_nam:354,get_namespac:354,get_next_item:382,get_nod:472,get_nonstandard_attr:244,get_nowait:[136,260,284,318],get_obj:284,get_object:[229,472],get_object_traceback:[378,472],get_opcod:189,get_operator_modul:284,get_opt:292,get_option_group:292,get_option_ord:65,get_origin_req_host:[244,392,468],get_original_stdout:363,get_osfhandl:283,get_output_charset:196,get_par:458,get_param:[197,210,472],get_paramet:354,get_path:[356,463,466],get_path_nam:356,get_payload:[197,201,205,207,466],get_pep:228,get_phone_numb:466,get_pid:[132,135],get_pipe_transport:[132,135],get_platform:[65,356,466],get_poli:380,get_posit:405,get_position_in_index:382,get_protocol:[132,135,472],get_python_inc:[65,74,418],get_python_lib:65,get_python_vers:[356,466],get_queu:284,get_recsrc:295,get_refer:[57,229,459],get_referr:[229,378],get_request:340,get_resource_load:[],get_resource_read:[252,471,472],get_returncod:[132,135],get_running_loop:[129,131,132,135,137,140,471,472],get_schem:404,get_scheme_nam:356,get_selector:[392,468],get_sequ:271,get_serv:284,get_server_certif:[343,467,472],get_shapepoli:380,get_siz:458,get_socket:360,get_sourc:[252,420,468,472],get_special_folder_path:66,get_stack:[140,145,472],get_start_method:[284,468],get_starttag_text:241,get_stat:[99,229,468],get_stderr:404,get_stdin:404,get_str:[271,466],get_subdir:271,get_suffix:251,get_symbol:354,get_tag:[251,252,466],get_task_factori:[129,132,469,472],get_temp_dir:472,get_termin:125,get_terminal_s:[293,333,467,472],get_threshold:229,get_token:332,get_traceback_limit:378,get_traced_memori:378,get_tracemalloc_memori:378,get_typ:[244,354,392,468],get_type_hint:[93,382,471,472],get_unixfrom:[197,206],get_unpack_format:333,get_usag:292,get_user_nam:382,get_valu:347,get_vers:292,get_vis:271,get_vot:466,get_wch:[178,467],get_write_buffer_limit:[135,469],get_write_buffer_s:[132,135],get_yield_from_it:[190,472],getacl:[249,458],getaddress:210,getaddrinfo:[110,129,132,339,422,469,470,471,472],getallocatedblock:[355,468],getandroidapilevel:[355,471,472],getannot:249,getarg:462,getargspec:[254,468,469,470,472],getargvalu:[254,469],getatim:294,getattr:[84,91,103,118,129,161,177,190,227,254,284,291,292,301,347,436,446,456,466,468,471,472],getattr_stat:[254,466],getattrfunc:[57,81],getattribut:[407,409,424],getattributen:407,getattributenod:407,getattributenoden:407,getattrofunc:[57,81],getbas:316,getbegyx:178,getbkgd:178,getblock:[339,471,472],getboolean:[168,472],getbuff:[257,466],getbufferproc:[7,57,467],getbytestream:413,getc:457,getcallarg:[254,463,469,472],getcanva:380,getcap:[272,288],getch:[92,97,178,283],getchannel:458,getcharacterstream:413,getcheckinterv:[355,446,459],getchild:[266,463],getchildren:[410,463,466],getclasstre:254,getclosurevar:[254,467],getcod:392,getcolumninfo:282,getcolumnnumb:413,getcom:[254,315],getcompnam:[119,351,398],getcomptyp:[119,351,398],getconf:308,getcontenthandl:413,getcontext:[187,448,460],getcoroutineloc:[254,469,472],getcoroutinest:[254,469,472],getcount:[91,291],getctim:294,getcurrenttim:417,getcwd:[113,293,294,298,363,447,471,472],getcwdb:[293,464],getcwdu:[113,459],getdata:417,getdecim:168,getdecod:[109,159],getdefaultencod:[355,446],getdefaultlocal:[265,451],getdefaulttimeout:339,getdlopenflag:[293,355,446,458],getdoc:[254,469,472],getdomimplement:[407,408],getdoubl:472,getdtdhandl:413,geteffectivelevel:266,getegid:293,getelementsbytagnam:[407,408,456],getelementsbytagnamen:407,getencod:[109,159,413],getentityresolv:413,getentropi:[293,469,472],getenv:[31,293,308],getenvb:[293,466],geterrorhandl:413,geteuid:293,getev:409,geteventcategori:268,geteventtyp:268,getexcept:411,getfamili:461,getfeatur:413,getfieldcount:282,getfil:[254,472],getfileinformationbyhandl:[293,469],getfilesystemencod:[60,109,293,355,359,363,418,446,451,470],getfilesystemencodeerror:[355,470],getfirst:153,getfloat:168,getfmt:295,getfqdn:[336,337,339],getframeinfo:[254,472],getframer:[119,351,398],getfullargspec:[254,315,468,469,470,472],getgeneratorloc:[254,467],getgeneratorst:[254,466],getgid:293,getgral:[234,472],getgrgid:[234,470,472],getgrnam:[234,459,472],getgroup:[293,472],getgrouplist:[293,467,472],gethead:[125,243],gethighlight:472,gethostbyaddr:[293,339,472],gethostbynam:339,gethostbyname_ex:[339,472],gethostnam:[107,293,339],getincrementaldecod:159,getincrementalencod:[159,467],getinfo:419,getinnerfram:[254,469],getinputcontext:316,getint:[168,472],getinteg:[282,462],getitem:[291,387,458],getiter:[410,463,466,472],getiterfunc:[57,81],getitim:[334,462],getkei:[97,178,472],getlasterror:[22,177,472],getlength:413,getlevelnam:[104,266],getlin:[264,378,469,472],getlinenumb:413,getlist:[153,469],getloadavg:293,getlocal:[184,265,472],getlogg:[103,104,128,266,385,459,463,465],getloggerclass:266,getlogin:[231,293],getlogrecordfactori:[104,266],getmandatoryreleas:114,getmark:[119,351,398],getmaxyx:178,getmemb:[254,359,469],getmessag:[104,266,411],getmessageid:268,getmodul:254,getmodulehandl:177,getmodulehandlea:177,getmodulehandlew:177,getmoduleinfo:[462,470,472],getmodulenam:[252,254,470],getmous:178,getmro:254,getmtim:294,getnam:[155,359,366,413],getnamebyqnam:413,getnameinfo:[129,132,339,422,471,472],getnchannel:[119,351,398],getnfram:[119,351,398],getnod:[395,471,472],getobject:446,getopt:[62,71,91,94,120,253,292,447,459,463],getopterror:230,getoptionalreleas:114,getouterfram:[254,469],getoutput:350,getpages:324,getparam:[119,351,398,468],getparyx:178,getpass:[62,120,174,249,253,283,293,307,360,362,462,472],getpasswarn:231,getpath:[31,472],getpathp:472,getpeerc:472,getpeercert:[135,343,462,468,472],getpeernam:[135,171,336,339,343],getpen:380,getpgid:[293,459],getpgrp:[216,293],getpid:[129,284,293],getpo:241,getppid:[284,293],getpreferredencod:[97,176,178,227,257,265,350,355,451,471,472],getprior:[293,467],getprocaddress:92,getprofil:[355,446,462],getproperti:[282,413,472],getpropertycount:282,getproto:461,getprotobynam:339,getproxi:[110,392],getpublicid:413,getpwal:312,getpwnam:[174,312,472],getpwuid:[111,293,312,472],getqnam:413,getqnamebynam:413,getquota:249,getquotaroot:249,getrandbit:[320,460,468,472],getrandom:[293,469,470,472],getread:[109,159],getrecursionlimit:[214,248,355,446,456,472],getrefcount:[93,355,446],getresgid:[293,463],getrespons:[243,469,472],getresuid:[293,463],getrlimit:[324,472],getroot:[410,461],getrusag:[293,324,461],getsampl:143,getsampwidth:[119,351,398],getscreen:380,getservbynam:[339,472],getservbyport:[339,460,472],getset:[20,57,254],getset_descriptor:254,getsetdescriptortyp:381,getshap:380,getsid:[293,460],getsign:334,getsitepackag:[335,463,466],getsiz:[155,293,294,472],getsizeof:[355,363,378,446,462,472],getsocknam:[135,137,339,343,472],getsockopt:[135,339,343,463,470],getsourc:[254,472],getsourcefil:254,getsourcelin:[254,472],getspal:341,getspnam:[341,470,472],getstat:[96,159,320],getstatenam:416,getstatu:468,getstatusoutput:[350,468],getstr:[97,178,282,462,472],getsubject:268,getsummaryinform:282,getswitchinterv:[355,446],getsystemid:413,getsyx:178,gettarinfo:359,gettempdir:[361,472],gettempdirb:361,gettempprefix:361,gettempprefixb:361,getter:[45,53,82,98,118,168,227,366,392,462,468,469,472],gettestcasenam:385,gettext:[62,104,247,253,265,408,431,447,456,460,472],gettimeofdai:[184,367],gettimeout:[339,343],gettotalrefcount:[363,446,472],gettrac:[355,446,462],getturtl:380,gettyp:[413,461],getuid:293,geturl:[62,391,392],getus:[231,249,293,307],getuserbas:[335,463,466],getusercfgdir:472,getusersitepackag:[335,434,463,466],getvalu:[84,85,91,98,153,170,197,235,257,261,310,363,386,413,418,466,469],getvaluebyqnam:413,getversionex:355,getvolumepathnam:294,getwch:[283,462],getweakref:399,getweakrefcount:399,getwelcom:[225,288,307],getwin:178,getwindowrect:177,getwindowsvers:[355,463,470],getwrit:[109,159],getx:[98,227],getxattr:[293,467],getyx:178,ghaer:342,ghi:[161,177,266,332,460],ghost:472,gi_:472,gi_cod:[254,462,469,472],gi_fram:[254,461],gi_run:254,gi_yieldfrom:[254,469,472],giampaolo:[463,466,467,469,471,472],giant:193,gib:[109,269,308,359,363,419,456,459,461,472],gid:[234,293,298,312,359,462,463,467,469,472],gif87a:466,gif:[74,197,206,207,233,250,370,380,404,461],gigabyt:[109,406],gil:[38,57,62,82,90,93,177,236,462,463,466,468,470,472],gilfix:459,gill:470,gilstat:30,gindi:[469,472],girdhar:[469,470,472],git:[75,86,144,468,472],github:[64,81,86,112,309,342,396,422,453,470,471,472],giuca:463,give:[5,7,13,22,28,31,44,57,58,65,66,74,78,79,80,81,83,84,85,86,90,91,92,94,95,97,98,99,105,106,107,108,109,119,122,123,124,139,143,153,155,156,157,159,161,177,178,182,184,186,187,189,190,193,209,212,214,217,225,227,230,232,238,252,257,267,268,275,276,279,280,284,286,287,292,293,294,298,299,301,309,316,320,321,328,334,340,342,343,345,346,347,350,351,355,366,367,368,370,373,380,382,385,387,391,396,400,402,404,406,407,408,412,419,423,424,427,430,433,434,437,440,441,442,445,447,448,449,450,451,455,456,458,459,461,462,463,464,465,466,467,472],given:[3,4,5,7,9,13,19,22,23,28,30,31,38,39,41,45,51,53,56,57,58,60,65,66,69,70,72,74,78,79,84,87,90,93,94,95,97,99,101,102,103,104,106,107,108,110,111,113,118,119,122,123,124,129,130,132,135,139,140,145,151,152,155,156,157,158,159,161,164,167,168,169,170,171,174,176,177,178,179,180,182,184,185,187,189,190,193,196,197,201,203,204,206,207,209,210,211,212,214,217,219,223,225,227,228,230,232,234,235,236,238,243,244,245,246,248,249,251,252,254,257,258,261,265,266,267,268,269,271,272,275,276,279,282,284,286,288,289,291,292,293,295,297,298,299,301,302,303,304,305,308,310,312,314,315,316,320,321,324,326,329,330,332,333,334,335,336,337,338,339,340,341,342,343,345,346,347,348,349,350,355,357,359,360,363,365,366,367,368,370,372,373,376,377,380,381,382,384,385,386,390,391,392,395,396,397,400,404,405,407,408,409,410,411,414,417,418,419,420,421,422,423,424,425,426,428,430,431,432,434,436,437,438,440,442,444,445,446,448,451,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],gla:455,glanc:[104,436,459],glare:471,glb:85,gleen:472,glenn:469,glib:460,glibc:[293,324,468,472],glingl:380,glitch:248,glob:[62,67,74,104,145,193,220,221,253,282,294,298,299,333,350,447,462,463,466,470,472],global:[22,25,28,29,31,41,47,48,54,57,60,62,67,70,79,82,84,85,93,96,99,101,110,111,117,122,124,134,141,142,145,150,161,167,170,177,178,190,193,196,211,212,214,219,225,227,232,243,248,251,252,254,260,264,268,276,284,292,293,298,299,300,307,310,322,326,335,336,337,339,346,347,354,355,359,360,361,366,368,376,380,382,385,387,392,395,397,399,410,417,423,424,425,427,428,429,431,433,434,436,437,446,451,453,455,460,461,462,463,464,466,467,468,469,470,471,472],global_stmt:[427,432],globaln:472,globalnam:280,globe:184,glori:31,glossari:[62,72,109,441,472],glow:380,glu:445,glue:[78,95,458,460],glw:462,glyph:[109,209,248],gmail:[249,472],gmane:[288,467],gmt1:[],gmt2:[],gmt:[62,103,184,210,246,266,343,367],gmtime:[103,104,152,184,210,266,271,306,367,458,466,467,472],gname:359,gnome:[232,296,345,460,467],gnosi:99,gnu32:469,gnu:[62,65,85,91,101,230,235,247,253,265,292,293,300,331,333,359,364,422,424,431,434,443,451,454,456,459,460,462,463,469,471,472],gnu_format:359,gnu_getopt:[230,459],gnumer:345,gnutransl:[62,247],gnutype_spars:359,goal:[57,62,74,81,99,202,212,227,236,322,363,410,430,457,459,461,462,466,468,469,470],gobject:[87,296],god:310,goderbau:467,goe:[1,31,74,83,93,94,95,105,106,132,135,136,168,170,178,179,193,232,244,267,284,292,316,318,355,377,423,446,458,466,467],gogh:161,gohlk:472,going:[65,81,82,85,90,94,95,99,101,105,106,107,111,119,129,138,145,153,184,187,197,201,237,280,292,293,310,343,350,359,366,386,387,404,410,416,424,436,441,449,455,456,458,462,472],golden:[455,468],golf:436,gollahon:472,gon:380,gone:[91,93,94,102,110,242,346,386,456,457,459,462,464,466],gonzalez:[470,471],good:[0,1,15,31,47,57,62,69,72,81,84,85,90,91,92,93,94,98,103,104,106,107,109,110,111,122,124,140,153,156,157,161,168,171,177,178,184,189,193,199,208,212,227,236,237,284,292,293,295,297,301,309,321,336,342,343,363,365,368,369,370,380,385,387,408,416,422,424,436,437,441,442,453,454,456,457,459,460,462,463,472],good_sig:236,goodby:[104,142,301,439],goodger:[457,458,460],goodi:[111,153],goofi:459,googl:[86,89,90,103,110,400,416,461,462,463,467],googlegroup:309,gopher:391,gopherlib:[462,464],gordon:[91,107,456,459],gorokhovski:[471,472],gosub:321,got:[0,79,94,110,114,129,137,139,193,266,284,337,380,392,426,437,451,461,465,472],gotcha:168,gotten:[22,49,89,153,184,187,284,318,456,472],gov:[236,244,459],govern:[93,104,182,187,195,391,416,422,466],gpa:436,gpf:456,gpg:461,gpl:[271,422,458],gpled:458,gprof:460,gr_gid:[234,459],gr_mem:234,gr_name:[234,459],gr_passwd:234,grab:[31,66,91,103,104,366,454,455,472],grace:[471,472],gracefulli:[321,366,426,445,463,466,472],grad:380,grade:[108,149,212,227,346,380,459],gradelevel:349,gradian:380,gradual:[86,93,457,458],graduat:[436,469],graem:457,graft:67,graham:[109,438,462,472],grai:472,grail:[261,400,438],grain:[62,90,103,178,193,266,293,392,424,473],gram:321,graminit:297,grammar:[60,62,85,99,113,158,227,263,297,347,353,374,423,429,430,431,433,456,457,461,464,472],grand:[320,410],grandchildren:[410,472],granni:212,grant:[64,98,106,293,294,422,456,457,461],granular:[65,93,104,252,293,355,447],grape:438,graph:[267,292,380,458,468],graphic:[62,66,88,91,97,109,111,159,174,178,224,250,253,319,370,372,385,400,435,462],grasp:408,gratuit:93,grave:457,gravett:345,gravi:295,gravida:151,gravit:[212,380,449],gray25:370,gray50:370,graymap:250,grayson:370,great:[30,74,78,103,237,244,321,370,386,438,461,472],greater:[23,30,34,35,51,57,58,82,96,97,103,104,108,109,117,135,136,139,145,147,149,156,161,178,184,187,189,197,209,222,228,232,243,249,258,268,275,293,297,299,320,324,335,337,346,355,366,373,374,378,380,385,404,407,421,424,431,432,436,437,442,444,445,456,458,459,460,461,469,470,471,472],greaterequ:374,greatest:[223,275,346],greatli:[92,161,399,447,456,457,458,459,462,463,464,467,469],greedi:[62,159,321,360],greek8:159,greek:[109,159],green2:373,green3:373,green4:373,green:[97,124,161,163,178,212,241,320,345,380,399,448,459,460,465,466,470,472],greenish:178,greenwich:[210,367],greet:[113,307,336,337,382,469],greg:[68,71,74,90,111,456,458,459,460,461,467,469,472],gregg:456,gregor:462,gregori:[461,462,463,465,468,470,471,472],gregorian:[152,184],grei:370,grene:212,grep:[95,101,248,350,456,472],grew:[465,466],grid:[371,373],griffin:472,grin:109,grip:[266,373],gripe:86,grisbi:462,grisel:472,grnd_nonblock:[293,472],grnd_random:293,grob:387,grok_environment_error:472,groner:472,groov:370,gross:461,ground:[68,178],group1:[122,321],group2:122,group:[62,64,65,66,75,86,90,93,94,102,103,104,109,111,112,120,153,159,161,170,176,179,187,188,189,193,204,212,227,249,253,256,258,260,265,271,282,284,288,293,298,301,312,316,321,333,335,339,341,343,344,345,346,347,350,352,359,366,372,373,378,388,397,402,406,412,416,423,424,426,430,431,435,445,448,450,455,456,460,461,462,463,464,466,467,468,469,470,471,472],group_:95,group_mask:461,group_pattern:288,groupbi:[93,99,228,260,291,460,465,472],groupdict:321,grouper:260,groupindex:[321,472],groupinfo:288,grouping_opt:347,groupn:321,grouppattern:288,groupref_exist:472,grow:[50,55,69,94,104,107,161,193,228,237,253,268,296,320,322,373,422,446,456,460,462,463,466,472],grown:[84,193,329],growth:[467,472],grp:[62,253,312,341,388,459,472],grumbl:438,grungi:92,grunt:458,grzegorz:472,grzybowski:472,grzywacz:472,gstate:30,gte:124,gtk:[296,460,462],guarante:[7,9,10,17,30,31,49,52,56,57,58,61,65,78,79,82,86,91,93,95,97,99,101,108,117,123,129,139,140,142,161,177,184,187,190,193,197,206,225,227,236,244,252,254,257,261,274,275,276,279,284,288,292,293,301,310,318,320,326,329,346,350,355,361,363,365,366,375,395,397,399,402,404,405,410,412,423,424,428,437,455,460,461,463,465,466,467,470,471,472],guard:[57,315,363,366,428,472],guess:[31,90,94,159,168,185,193,201,207,210,246,252,254,265,276,310,328,370,392,404,430,436,445,459,466,472],guess_all_extens:276,guess_extens:[201,276],guess_schem:404,guess_typ:[201,246,276],guesswork:466,guest:[161,339],gui:[62,66,89,90,91,92,99,109,248,292,296,342,344,355,369,370,385,401,418,435,452,462,467,472],guid:[1,62,71,73,76,80,82,86,89,92,97,100,105,109,111,112,126,187,188,189,192,211,227,295,352,370,372,387,396,437,442,449,450,454,462,463,466,468,472],guidanc:[92,381,463],guidelin:[1,31,62,81,165,248,363,456,457,461],guido:[84,86,91,93,98,189,280,346,370,382,422,438,446,456,457,458,459,461,462,463,464,468,469,470,471,472],guil:462,guilherm:[462,463,465,468,470,471,472],gullibl:153,gumbi:370,gunk:306,gunther:410,gunzip:[111,235],guo:472,guru:444,gusi:456,gustavo:[232,458,459,460,461,472],gut:[74,109,153,472],gutteridg:472,gvf:467,gvim:453,gvr:[456,458,459,460,463,470],gward:[68,74],gxx:260,gzip:[62,65,66,75,86,93,104,121,159,201,219,253,276,333,359,363,406,422,447,456,459,463,465,468,470,472],gzip_decod:472,gzipfil:[93,235,359,463,465,466,469,472],gztar:[65,66,75,333,466,470,472],h00:236,h01:236,h10:236,h2py:[470,472],h_errno:339,h_len:322,haag:471,habit:[107,232,271,437],hack:[84,90,99,193,332,392,451,456,457,458,472],hacker:[153,320],hackeri:85,hackish:461,hackman:[470,472],had:[5,30,38,65,66,78,82,86,91,94,95,99,104,107,113,122,123,136,142,157,159,170,171,178,184,187,190,200,237,244,254,284,293,299,316,318,329,339,342,343,347,370,376,378,385,386,391,392,407,428,432,437,440,444,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],hadn:472,hagemeist:472,hagen:[463,472],hagino:458,hairi:292,halanta:109,half:[97,135,178,184,223,228,275,295,329,346,349,370,431,440,463,470,472],halfdelai:[97,178],halfwai:[275,464],hall:472,halt:[187,213,292,298,385,437,468],halv:[149,339,460,463],ham:[104,161,171,189,227,254,280,426,428,437,469],hamcrest:387,hamish:460,hamlet:[161,456],hammer:[438,456],hammond:[87,268,305,455,456,458,459,467,472],hamper:95,hamster:189,hamt:472,han:[459,472],hand01:267,hand02:267,hand03:267,hand04:267,hand05:267,hand06:267,hand07:267,hand08:267,hand09:267,hand2:370,hand:[57,74,79,81,84,86,90,91,95,99,105,106,107,111,124,131,177,178,187,197,202,207,212,227,232,248,256,257,268,301,307,321,340,367,370,380,382,386,426,430,432,435,436,438,441,442,445,446,447,448,456,457,458,459,461,462,464,465,467],handdraw:380,handi:[62,65,91,97,98,105,106,107,111,152,168,177,189,212,292,346,369,386,434,435,437,441,446,456,460],handier:331,handl:[7,13,28,29,30,31,38,42,45,51,53,57,58,60,62,65,66,72,74,79,81,82,84,85,86,90,91,92,93,94,95,97,99,102,103,104,105,106,107,108,109,111,113,114,117,120,122,125,126,127,128,132,133,134,141,142,145,147,148,151,154,156,158,159,161,168,170,171,176,177,182,184,187,188,189,190,193,197,201,202,203,204,208,209,213,214,216,222,225,227,228,232,235,241,243,245,246,249,251,252,253,254,255,257,258,261,263,266,267,268,269,271,275,279,283,284,289,291,293,294,295,298,299,300,310,311,318,320,321,323,329,331,332,333,334,336,337,339,340,344,346,347,349,350,352,355,358,359,361,363,367,370,372,375,382,386,387,390,392,397,399,400,401,404,406,410,412,416,417,418,419,422,423,424,425,426,428,431,432,436,437,441,442,444,445,446,447,448,451,453,455,456,457,458,460,461,464,465,466,467,470,471,472,473],handle_accept:[141,466],handle_charref:241,handle_clos:141,handle_com:241,handle_connect:141,handle_data:241,handle_decl:241,handle_defect:209,handle_echo:137,handle_endtag:241,handle_entityref:241,handle_error:[141,340,470,472],handle_expect_100:246,handle_expt:141,handle_list:350,handle_one_request:246,handle_pi:241,handle_read:[141,472],handle_request:[104,125,171,340,404,417,463],handle_stackframe_without_leak:254,handle_startendtag:241,handle_starttag:241,handle_timeout:[340,462,463],handle_writ:[125,141],handleerror:[103,266,268],handlelogrecord:104,handlepoint:408,handler:[3,22,26,30,54,56,57,58,59,62,79,81,82,87,109,120,124,132,134,146,153,154,168,178,186,190,197,198,202,203,214,227,231,241,246,253,255,257,259,267,273,284,292,293,299,310,316,317,329,330,333,339,342,346,355,357,359,363,367,369,385,390,392,400,408,409,411,413,414,417,423,424,425,432,439,451,456,459,460,461,462,463,464,465,466,467,468,469,470,471,472],handler_class:[246,404],handler_consolehandl:103,handler_hand01:267,handler_hand02:267,handler_hand03:267,handler_hand04:267,handler_hand05:267,handler_hand06:267,handler_hand07:267,handler_hand08:267,handler_hand09:267,handler_ord:392,handlernam:316,handleslid:408,handleslideshow:408,handleslideshowtitl:408,handleslidetitl:408,handletoc:408,handshak:[129,343,468,469,470,471,472],hang:[104,107,110,284,305,329,334,363,459,466,472],hangul:472,hangup:334,hanoi:380,hansen:458,hao:468,happen:[1,17,22,30,31,54,58,62,66,79,82,84,90,92,94,95,96,97,99,104,105,107,110,111,117,139,140,141,158,177,178,182,184,189,208,225,228,237,248,252,254,257,265,267,268,292,293,295,301,316,329,332,339,343,346,347,355,360,362,363,366,377,385,386,387,392,404,423,424,425,426,428,431,432,436,437,439,444,446,456,458,460,461,462,463,464,468,469,472],happi:[85,86,212,459],har:[157,385,466,468],harbor:[458,459],hard:[62,65,70,78,79,82,84,95,97,99,104,105,106,107,111,168,176,178,189,193,203,222,266,267,292,293,299,310,321,324,328,343,350,359,363,372,387,436,455,456,466,468,471,472],hardcod:[74,177,266,268,454,468,472],hardcov:161,harden:472,harder:[84,91,193,292,346,387,472],hardlink:359,hardwar:[1,30,65,84,109,111,133,143,156,178,187,256,293,295,324,339,350,367,395,402,440,463,469,472],hardwir:[170,310],harel:472,harm:[168,292,418,466],harmless:[79,95,193,373],harmon:345,harmonic_mean:[345,470,472],harold:[99,347],harradin:472,harri:[193,461],hart:275,harvei:472,has:[0,1,2,5,6,7,8,9,10,14,15,16,21,22,24,25,28,30,31,36,38,39,40,41,42,43,45,47,51,52,53,54,57,58,64,65,66,68,69,72,74,75,77,78,79,81,82,83,84,85,86,87,90,92,93,94,95,96,97,98,99,101,102,103,104,105,106,107,108,109,110,111,112,113,114,116,117,118,119,122,123,124,125,128,129,130,131,132,133,134,135,136,138,139,140,141,143,145,151,152,153,155,156,157,158,159,160,161,167,168,170,171,176,177,178,179,182,184,185,187,189,190,193,194,195,197,200,201,202,203,204,205,206,208,209,210,211,212,213,214,215,217,219,222,223,225,227,229,230,232,235,236,237,238,242,243,244,245,246,248,249,251,252,254,257,258,260,261,265,266,267,268,269,271,274,275,276,282,284,286,288,292,293,294,295,297,298,299,301,305,306,307,310,314,315,316,318,320,321,322,324,326,328,329,330,331,332,333,334,335,336,337,339,340,342,343,344,345,346,347,349,350,351,354,355,356,357,359,360,361,362,363,365,366,367,368,369,370,371,372,373,375,377,378,380,381,382,384,385,386,387,390,391,392,393,396,397,398,399,400,402,404,405,406,407,410,412,413,416,418,419,420,421,423,424,425,426,428,431,432,433,435,436,437,438,439,440,441,442,443,445,446,447,448,449,450,451,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],has_alpn:[343,469],has_been_cal:387,has_children:354,has_color:[97,178],has_data:[386,392,468],has_ecdh:343,has_exec:354,has_extn:337,has_funct:65,has_head:[176,244,392],has_ic:178,has_il:178,has_internal_subset:316,has_ipv6:339,has_kei:[113,178,456,457,458,459,464,472],has_loc:[252,428],has_never_check_common_nam:343,has_nonstandard_attr:244,has_npn:343,has_opt:[168,292],has_sect:168,has_sni:[225,243,249,288,307,337,343,392],has_sslv2:343,has_sslv3:343,has_ticket:343,has_tlsv1:343,has_tlsv1_1:[343,471],has_tlsv1_2:343,has_tlsv1_3:343,hasattr:[45,93,98,110,227,228,254,284,322,355,368,385,386,396,428,446,459,462,466,468,471,472],hasattribut:407,hasattributen:407,haschildnod:407,hascompar:190,hasconst:190,hasfeatur:407,hasfre:190,hash:[21,30,45,57,58,62,81,84,90,93,147,162,164,168,175,182,184,185,225,227,252,253,269,289,300,313,328,339,355,386,388,392,395,399,421,422,424,426,428,431,434,445,446,451,458,459,461,462,463,466,467,470,472],hash_a:382,hash_b:382,hash_bit:355,hash_complex:346,hash_float:346,hash_fract:346,hash_info:[346,355,424,446,466,468],hash_nam:236,hash_random:[355,472],hash_valu:346,hashabl:[21,45,57,91,93,118,161,162,184,189,212,223,228,254,258,291,298,320,346,382,399,424,426,459,460,462,463,467,469,472],hashandl:266,hashcollis:453,hashfunc:[57,81],hashlib:[30,62,90,175,238,253,342,422,462,463,464,472],hashopen:331,hashtable_s:472,hasjab:190,hasjrel:190,haskel:[99,260,456,459],hasloc:190,hasn:[12,31,65,85,86,90,95,111,135,167,189,299,311,316,335,343,350,357,386,387,456,457,461,462,464,469,471,472],hasnam:190,hast:[95,463,465,467,468],hat:[66,72,85,86,111,422,447],hatch:[65,382,463],hatyp:339,haubenwalln:472,haunt:346,hauser:456,have:[0,1,2,5,7,10,17,21,22,23,26,28,30,31,38,45,53,54,55,57,58,62,64,65,66,67,68,69,70,72,74,75,77,78,79,81,82,83,85,89,90,92,93,94,95,96,97,98,99,102,103,104,106,107,108,109,110,111,112,113,114,117,118,119,122,123,124,125,126,129,131,133,134,136,138,139,140,141,142,143,144,145,147,149,150,151,152,153,155,156,157,158,159,160,161,162,164,167,168,169,170,171,176,177,178,179,180,182,184,185,187,189,190,193,195,196,197,198,200,202,203,204,206,207,208,209,212,214,216,219,222,223,225,227,228,229,232,233,236,237,238,241,243,244,245,248,249,251,252,254,256,257,258,260,261,264,265,266,267,268,269,271,275,276,279,282,283,284,286,288,291,292,293,294,295,296,297,298,299,301,304,307,309,310,313,314,316,318,320,321,324,325,326,327,328,329,331,332,333,334,336,337,339,340,341,342,343,344,345,346,347,348,349,350,351,352,355,356,357,359,360,361,362,363,365,366,367,369,370,372,373,377,378,380,381,382,383,385,386,387,391,392,394,395,396,397,398,399,402,404,405,406,407,408,409,410,411,412,416,417,418,419,421,422,423,424,425,426,427,428,430,431,432,433,434,435,436,437,438,439,440,441,442,444,445,446,448,449,451,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],have_argu:190,have_bar:74,have_docstr:363,have_foo:74,have_functionnam:95,have_linux_vm_sockets_h:472,have_long_long:472,have_round:472,have_sockaddr_alg:472,have_strftim:74,have_thread:[187,467],haven:[30,75,87,94,106,109,153,187,386,439,462,463,472],haxx:244,hci_data_dir:339,hci_filt:339,hci_time_stamp:339,hcom:338,hda:350,hdl:[391,422],hdlr:266,hdr:[90,288,392],head:[30,57,84,106,137,152,153,157,179,201,241,243,246,288,294,310,320,334,335,340,343,373,380,392,410,456,458,467,472],headach:436,header:[3,19,24,31,57,62,68,71,74,79,81,90,96,103,106,111,119,125,147,152,153,155,157,168,170,176,177,185,189,193,195,196,197,198,199,200,201,202,205,206,207,208,209,210,216,232,235,243,244,245,246,248,249,252,255,266,268,271,276,285,288,293,297,299,307,313,319,337,338,339,343,351,355,356,359,363,374,377,381,390,392,394,398,408,416,419,421,423,425,436,447,448,455,457,459,461,462,463,465,466,468,469,470,471,472],header_enc:196,header_encod:196,header_encode_lin:196,header_exist:472,header_factori:[204,209,467],header_fetch_pars:209,header_item:[244,392],header_max_count:209,header_nam:[203,392,404],header_offset:419,header_source_pars:209,header_store_pars:209,header_str:288,header_valu:392,headerdefect:204,headererror:359,headernam:198,headerpars:[208,467],headerparseerror:[197,200,206],headerregistri:[62,195,200,201,206,209,285,472],headersonli:208,headervalu:198,headlin:458,healthi:107,heanei:[468,469],heap:[29,31,38,46,56,57,62,79,82,183,215,253,283,324,380,448,459,460,462,463,472],heapifi:[237,448,472],heapmin:283,heappop:[237,260,448,459,462],heappush:[237,448,459,462],heappushpop:[237,462],heapq:[62,93,183,227,228,253,318,448,459,460,461,462,472],heapreplac:237,heapsort:237,heaqp:472,heard:[87,436],hearn:236,heart:[84,459],heather:321,heathmor:321,heavi:[79,110,168,440,450,463,467,471],heavili:[65,111,112,185,252,337,423,457,470,471],heblikar:472,hebrew:[109,159],heck:99,hector:460,hedstrom:462,hee:472,hei:363,height:[97,178,248,282,293,370,373,380,445,461,472],heiko:467,heim:[236,422,462,467,468,470,471,472],hel:299,held:[28,30,38,90,125,168,248,251,257,267,268,284,346,355,366,385,399,422,424,456,461,462,463,470],hell:79,heller:[91,461,462,463],hellman:[343,467],hello:[62,79,81,85,91,92,96,104,113,123,131,135,137,138,140,147,153,177,185,228,232,236,241,279,284,288,291,301,303,306,339,340,343,346,361,363,365,366,369,375,382,385,386,404,431,436,438,439,442,455,466,468,469],hello_world:129,hello_world_app:404,hellohellohello:92,hellorequest:343,helloworld:431,helm:466,helo:[336,337],helo_resp:337,help:[22,41,45,53,59,60,62,65,68,69,72,74,81,84,86,92,93,94,95,98,103,104,105,106,107,109,110,111,112,120,124,153,154,157,159,161,170,177,178,186,188,189,191,193,201,212,224,225,227,228,230,232,236,239,247,251,252,253,254,256,257,260,261,282,288,293,296,298,299,310,336,337,339,343,346,352,355,363,367,368,369,370,372,375,376,382,386,387,391,392,396,402,410,418,420,424,428,431,433,435,436,437,440,441,444,446,447,448,451,453,455,456,457,458,459,460,461,462,463,465,466,467,468,469,470,471,472],help_:157,help_bar:157,help_str:65,helpdialog:472,helper:[5,30,62,92,118,165,170,177,188,197,206,212,219,238,252,253,257,263,289,301,321,333,343,364,368,377,380,382,385,387,392,461,462,467,469,470,472],helpformatt:[122,292],helpfulli:94,helpsourc:472,helt:472,henc:[30,65,68,79,84,94,104,170,173,193,229,248,252,268,284,292,294,298,303,310,324,332,346,349,350,366,397,423,424,426,460,468,471,472],henri:472,henstridg:[87,232,456,463],henzen:236,herald:458,herath:467,here:[5,7,22,26,30,31,38,57,64,65,67,68,72,74,78,79,81,82,84,85,86,90,91,94,95,96,97,98,99,101,103,104,106,107,108,110,111,113,118,120,122,124,131,137,138,140,141,143,145,152,153,155,157,159,161,165,168,170,171,175,176,177,178,182,184,187,189,190,193,197,199,200,201,203,206,207,208,209,210,212,217,223,224,225,227,232,235,236,243,248,249,254,255,256,266,267,268,269,275,277,278,284,288,292,293,299,301,307,309,316,317,321,324,330,332,334,337,339,340,342,343,344,346,347,355,359,361,362,363,366,367,368,370,373,380,381,382,383,385,386,387,388,392,395,397,400,404,405,407,408,410,420,422,424,426,427,428,430,431,432,436,437,438,439,442,443,445,446,450,451,453,454,456,457,458,459,460,461,462,463,464,466,467,469,470,471,472],hereaft:[103,111,310,438,446],herebi:422,herein:422,hergenroed:472,hermion:193,herror:339,hertz:403,heterogen:[104,123,346,438,464,472],hetland:[458,459],hetting:[98,99,108,459,460,461,462,463,465,466,467,468,469,470,471,472],heurist:[189,198,204,227,465,466,472],hewlett:[89,456],hex:[9,58,91,93,106,107,109,147,159,177,227,236,328,343,346,347,355,370,395,424,431,440,446,448,456,457,459,461,462,464,465,468,469,472],hex_codec:[159,468],hex_decod:468,hexadecim:[106,147,159,179,227,236,238,241,258,292,321,328,346,347,355,395,431,440,456,460,462,466,467,468,472],hexbin4:147,hexbin:148,hexdigest:[236,238,342,461,472],hexdigit:[179,282,347,431],hexinteg:431,hexlifi:[147,236],hexrepl:106,hexstr:147,hexvers:[4,86,355,446,467],hhhh:[349,456],hhl:[90,349],hhllhh:216,hhmm:[184,249,367],hi_ther:370,hidden:[30,52,84,91,92,180,248,299,310,320,340,373,380,467,471,472],hide:[97,101,109,176,180,193,195,212,217,248,257,292,297,350,363,368,373,380,382,397,423,436,446,455,459,463,466,472],hide_cookie2:244,hideturtl:380,hidpi:472,hiem:468,hierarch:[62,103,246,251,266,267,369,373,391,409,410,417,428,446],hierarchi:[31,41,62,72,74,91,101,103,104,118,120,145,187,227,252,253,254,261,266,267,289,290,301,330,334,346,355,370,372,373,382,385,407,410,423,426,428,429,432,436,442,459,461,464,472,473],hierarchy_request_err:407,hierarchyrequesterr:407,high:[29,34,55,58,62,79,80,84,85,86,89,90,92,103,104,107,110,120,126,129,131,132,135,137,138,140,141,151,165,167,178,187,190,195,202,220,233,242,253,258,259,260,265,269,284,289,293,294,295,301,310,320,329,339,343,345,347,355,357,361,367,396,400,429,432,435,440,441,447,448,458,460,461,462,466,467,468,469,471,472],high_priority_class:350,higher:[28,30,51,62,90,99,101,103,104,107,117,129,141,142,145,147,167,170,178,187,190,203,205,225,226,232,243,253,255,257,260,266,267,268,269,280,282,283,288,293,296,301,307,327,333,339,342,343,346,355,359,360,366,368,385,392,410,421,445,447,451,457,458,461,462,466,467,468,471,472],highest:[54,85,103,135,229,266,279,301,302,328,329,334,343,346,355,367,426,438,462,467,472],highest_protocol:[301,459],highli:[30,38,91,92,105,106,190,249,256,301,311,321,342,343,364,459,460,472],highlight:[62,84,86,97,178,189,248,385,454,456,463,466,472,473],highpag:472,hilbert:380,hill:472,hilliard:472,him:456,himanshu:472,hindl:459,hindranc:90,hinstanc:418,hint:[62,85,91,93,95,105,107,159,161,168,188,203,227,232,244,247,248,253,257,261,302,305,370,380,416,423,424,432,470,471,472],hirokazu:[463,467,472],hiroshima:422,his:[0,79,90,232,422,431,456,458,462,463,468,470],hisao:459,histfil:322,histor:[37,57,79,81,99,168,178,184,214,249,271,274,295,361,367,385,410,411,422,432,440,455,463,468,470],histori:[62,63,86,88,104,109,142,157,184,227,237,248,271,299,335,364,366,421,441,444,451,468,469,470,472],history_get:322,history_truncate_fil:322,historyconsol:322,hit:[58,92,97,145,155,177,214,228,248,299,343,360,370,376,386,398,461,466,472],hither:439,hive:455,hkcu:455,hkei:402,hkey_:[62,401],hkey_classes_root:402,hkey_current_config:402,hkey_current_us:[402,455],hkey_dyn_data:402,hkey_local_machin:[402,455],hkey_performance_data:402,hkey_us:402,hklm:455,hkn:453,hks:79,hksc:159,hline:178,hlinuxtnam:456,hlist:[372,472],hls_to_rgb:163,hmac:[62,174,175,236,253,268,284,328,339,458,463,472],hmodul:177,hodgson:459,hog:363,hohe:472,hoho:472,hold:[7,9,13,22,30,31,41,50,53,57,58,60,69,72,79,84,86,91,92,93,103,107,111,122,123,125,168,170,171,177,183,187,190,204,216,237,243,246,251,254,267,268,271,284,293,297,304,321,324,327,331,336,339,343,346,350,355,363,366,370,385,399,402,408,410,412,418,421,424,428,432,440,446,456,457,461,462,463,464,466,467,468,469,470,471,472],holden:[470,472],holder:[396,422,437,463],hole:[153,293,332,361,463,472],holger:461,holi:[261,347,438],holidai:86,holist:342,holmquist:472,holtermann:472,home:[30,65,74,86,87,91,92,97,106,153,157,168,178,215,235,248,271,272,286,293,294,298,299,308,312,316,322,332,335,343,350,356,363,370,372,380,396,419,421,430,431,434,449,455,462,466,467,469,472],home_dir:168,home_pag:309,homebrew:106,homedir:472,homedr:[111,294],homepag:[65,309,372],homepath:[111,294],homogen:[90,346,349,382,405,438,448],honor:[86,117,299,355,417,453,462,463,470,472],honour:[386,472],hood:[41,103,104,106,363,386,387,461,462,466],hook:[28,38,60,62,93,101,157,177,184,209,217,219,227,243,251,253,281,304,309,310,317,332,355,364,378,381,386,396,397,420,424,432,434,435,451,456,458,461,463,467,469,470,471,472,473],hook_compress:219,hook_encod:[219,470,472],hop:404,hope:[72,107,214,330,446,455,456,457,467,470],hopefulli:[82,102,103,104,468],horban:470,horch:178,horcicka:462,horev:468,horizont:[109,178,179,222,372,373,380,431],horler:462,horribl:442,hors:463,horsen:463,hosmer:472,host4:102,host6:102,host:[30,62,64,90,104,107,129,137,141,159,178,179,210,213,225,227,243,244,246,249,255,268,271,284,286,287,288,293,294,297,298,307,315,321,336,337,339,340,343,346,348,349,360,363,386,391,392,395,404,416,450,455,456,459,461,462,463,466,467,468,469,470,471,472],host_flag:472,hostmask:[102,258],hostmast:343,hostnam:[110,129,137,153,159,185,210,225,243,249,258,284,288,293,307,315,337,339,343,391,392,416,445,456,459,463,466,467,468,471,472],hostname_checks_common_nam:[343,471,472],hostv4:472,hostv6:472,hot:[91,310],hotshot:461,hotspot:459,houglum:472,hour:[19,91,106,129,135,140,184,268,271,367,419,431,459,470],hourglass:370,hous:[321,470],housekeep:366,houston:267,hovercraft:442,how:[0,1,5,7,10,30,31,53,57,58,62,65,66,69,70,71,74,75,78,79,80,81,82,83,93,94,96,97,98,99,100,101,102,103,104,105,106,107,109,110,113,114,119,122,125,128,129,134,135,138,140,142,143,145,149,152,153,157,159,161,164,168,173,175,176,177,178,182,183,184,185,187,188,189,190,195,196,201,202,203,208,219,224,225,227,228,229,232,233,235,236,237,243,244,245,248,252,254,257,258,260,261,266,267,268,272,275,279,284,288,291,293,298,301,305,310,313,318,320,321,322,323,324,332,333,334,339,340,342,343,345,346,347,348,350,351,352,355,359,365,367,368,369,373,376,378,382,385,386,387,391,392,396,399,404,405,407,416,418,423,424,425,426,428,429,431,432,433,434,435,436,438,439,440,442,445,448,450,451,452,455,456,457,458,459,460,461,462,463,465,466,467,468,469,470,471,472],how_mani:58,howev:[5,6,22,23,30,31,38,41,45,49,57,65,69,70,74,77,78,79,82,84,85,90,91,93,94,95,96,97,98,99,102,103,104,106,107,109,110,111,113,122,129,135,141,153,159,161,162,168,170,171,177,178,182,184,187,189,193,195,197,200,202,204,206,207,209,210,212,214,225,227,229,232,236,237,240,244,246,248,249,251,252,254,256,257,258,266,267,268,269,271,272,282,284,286,288,292,293,294,297,298,301,302,312,313,318,320,321,329,332,333,334,335,339,342,343,345,346,347,350,355,358,359,363,365,366,368,373,377,381,382,384,385,386,387,394,396,399,400,402,404,407,408,412,413,416,419,422,424,426,428,436,437,438,439,443,445,446,448,451,453,454,456,458,459,460,461,462,463,464,466,467,468,469,470,471,472],howmuch:307,howto:[62,90,91,97,105,108,321,339,392,416,456,458,463,464,466,472],hoyt:[462,469,472],hpet:133,hpi:431,hprevinst:418,href:[153,201,239,241,243,410,463],hreftyp:177,hresult:177,hsiang:472,hstderror:350,hstdinput:350,hstdoutput:350,hstrerror:339,hsu:472,hsuan:[471,472],hsv:163,hsv_to_rgb:163,htbin:246,htest:472,htm:[163,184,246,320,410,458,459,460,461,462,463,464],html2fo:458,html4:241,html5:[240,467,468],html:[62,74,84,85,86,91,99,103,106,110,137,152,153,154,163,189,201,206,243,244,246,248,253,273,293,296,315,343,370,376,391,392,393,408,409,410,414,416,417,421,422,424,431,448,451,453,454,455,456,457,458,459,460,461,462,463,464,469,471,472,473],htmlcalendar:[152,471],htmldiff:[189,460,469,472],htmlentitydef:464,htmlparseerror:467,htmlparser:[62,273,464,467,468,469,472],htmlparsererror:[469,472],hton:[107,339,471,472],htonl:[107,339],http2time:472,http:[1,62,69,74,77,81,84,85,86,87,90,91,99,103,104,105,107,109,110,111,123,125,135,144,153,159,161,163,167,170,184,201,209,210,228,236,240,241,249,253,255,260,268,309,315,316,320,328,329,339,340,342,343,346,355,363,378,384,390,391,392,393,396,400,406,408,410,412,415,416,417,421,422,424,427,428,431,436,440,441,447,448,449,450,451,453,454,455,456,457,458,459,460,461,462,464,472],http_cooki:245,http_error_301:392,http_error_302:392,http_error_303:392,http_error_307:392,http_error_30:392,http_error_401:392,http_error_404:392,http_error_407:392,http_error_:392,http_error_auth_req:392,http_error_default:392,http_get:469,http_host:404,http_open:392,http_port:243,http_proxi:[110,392,472],http_request_handl:125,http_respons:392,http_version:404,http_version_not_support:242,httpbasicauthhandl:[62,110,255],httpbasicpriorauthhandl:472,httpclient:141,httpconnect:[62,255,416,462,463,466,468,469,470,471,472],httpcookieprocessor:[62,244,255,460],httpd:[246,276,404,461],httpdefaulterrorhandl:[110,392],httpdigestauthhandl:[62,255],httperror:[62,228,390,392,468,472],httperrorprocessor:[62,110,255],httpexcept:243,httphandler:[62,103,104,110,120,255,267,469,472],httplib:[456,459,460,462,463,464,472],httpmessag:[62,110,246,255],httponli:[245,462,472],httpoxi:472,httppasswordmgr:[62,110,255],httppasswordmgrwithdefaultrealm:[110,392],httppasswordmgrwithpriorauth:[62,255,469],httpredirecthandl:[62,110,255],httprespons:[62,255,392,463,467,472],https_open:392,https_port:243,https_respons:392,httpsconnect:[243,392,462,463,466,468,471,472],httpserver:[246,404],httpshandler:[62,255,466],httpstatu:[242,469,472],huang:472,hudson:[385,422,457,458,459,461],hue:163,huge:[159,257,456,468,472],hugh:463,hugo:[342,468],hugunin:430,human:[81,84,103,104,109,119,189,190,199,212,232,244,246,266,288,301,305,334,337,343,344,351,353,355,374,384,398,411,426,442,449,458,465,467,468,472],humbl:292,humor:342,hundr:[54,86,104,193,450],hundredweight:110,hung:329,hunt:[30,292,472],huntrleak:472,huntsvil:99,hurd:[459,472],hurt:[89,460],hwnd:177,hybrid:[102,184,468],hye:[460,461],hygien:95,hylton:[456,457,458,459,460,461,462,463],hynek:[467,468],hyperbol:[62,189,290,462],hyperbola:275,hyperlink:189,hyperpars:472,hypertext:[62,110,241,242,253,273,407],hyphen:[69,77,159,230,292,321,365,370,395,451,459],hypot:[161,275],hypothesi:320,hypothet:[292,339,456],hzgb:159,i18n:[232,347,456,463],i386:[65,305,356,454,469],i586:[65,356,466],i686:[77,392],iOS:87,i_dont_want_to_store_this_cooki:244,iac:360,iacob:467,iadd:291,iain:461,ian:[99,404],iana:[184,242,258,276,316,343,408,410],iand:291,ib3x8:339,ibm037:159,ibm039:159,ibm1026:159,ibm1125:159,ibm1140:159,ibm273:159,ibm424:159,ibm437:159,ibm500:159,ibm775:159,ibm850:159,ibm852:159,ibm855:159,ibm857:159,ibm858:159,ibm860:159,ibm861:159,ibm862:159,ibm863:159,ibm864:159,ibm865:159,ibm866:159,ibm869:159,ibm:[99,159,178,187,342,459,461,467],ibuff:125,icc:[463,465,472],iceboi:472,iceland:[159,461],icglu:462,ichiro:458,icmp:339,ico:225,icon:[66,89,370,455,458,459,472],iconcat:291,iconindex:66,iconpath:66,icopen:462,icursor:373,id2obj:399,id_continu:431,id_dsa:333,id_rsa:333,id_start:431,idcok:178,idea:[0,15,31,47,65,68,72,74,84,85,86,90,91,92,93,94,95,97,103,104,107,111,122,141,184,189,193,212,265,295,309,373,380,383,424,437,441,450,456,458,459,460,463,464,465,466,470,472],ideal:[30,57,68,84,99,105,109,140,152,184,355,397,404,441,446,460,466],idempot:[129,135,168,471,472],ident:[5,9,17,42,45,58,62,74,79,90,91,92,98,99,102,103,104,107,141,156,160,182,184,187,189,193,197,202,206,208,212,216,217,227,232,246,260,266,268,271,282,284,291,293,297,307,310,321,329,333,334,339,343,345,346,349,355,357,366,367,372,375,381,382,386,387,396,407,410,424,433,436,440,458,459,461,462,466,470,471,472],identchar:157,identif:[78,138,284,348,366],identifi:[22,30,38,62,65,74,75,79,81,82,83,91,93,95,102,109,110,111,117,118,120,122,124,145,150,155,161,176,177,186,190,193,195,197,206,213,229,232,248,249,253,254,267,268,271,282,284,288,293,297,299,310,316,321,322,325,329,336,337,339,343,346,347,348,354,355,356,363,366,369,370,384,385,387,391,392,395,402,404,407,410,412,413,417,422,423,424,425,428,429,432,436,437,439,444,447,448,451,455,459,460,461,462,463,464,466,468,469,470,471,472],identify_column:373,identify_el:373,identify_region:373,identify_row:373,idiom:[30,31,79,84,91,93,105,108,113,115,122,193,227,284,332,343,355,399,459,464,466,467],idiomat:[105,113],idiosyncrasi:459,idiosyncrat:370,idir:65,idl:[60,62,85,86,91,93,176,177,179,231,253,335,350,369,380,407,408,410,453,455,458,459,473],idle_intro:453,idle_priority_class:350,idle_test:472,idleconf:472,idlefork:459,idleib:472,idlelib:[62,248,459,472],idlerc:[248,472],idlestartup:[248,472],idlev:472,idlok:178,idn:[159,343,471,472],idna:[62,146,204,384,391,459,472],idpattern:[347,472],idref:316,ids:[91,232,267,288,293,467],idstr:210,idtyp:293,idx:342,ie9:241,iec:355,ieee754:346,ieee:[156,187,261,275,349,363,426,440,460,462,465,466,470,471,472],ierr:22,ietf:[236,258,343],if_index:339,if_indextonam:339,if_nam:339,if_nameindex:[339,472],if_nametoindex:339,if_stmt:[297,423,427],ifconfig:[350,472],ifdef:[62,79,418,456,472],ifexp:124,iff:[62,193,253,278],ific:347,ified_newdatatyp:81,ifilt:[113,459],ifilterfals:113,iflag:362,ifloordiv:291,ifnam:339,ifndef:[79,95,96,472],ifs:124,iglob:[233,469,470,472],ignacio:472,ignor:[5,13,17,23,30,31,35,43,54,57,58,60,65,68,79,82,83,85,93,95,96,103,106,109,110,111,125,135,137,138,140,141,144,145,151,153,157,159,160,161,167,168,170,176,177,178,182,184,187,189,190,193,197,200,201,209,214,216,217,219,222,225,227,228,229,231,232,237,243,244,248,250,251,252,254,257,261,265,266,267,268,269,271,274,276,284,288,293,294,298,299,301,304,306,310,316,318,320,321,322,329,332,333,334,335,337,339,340,342,343,346,347,349,350,355,357,359,363,365,366,367,373,375,376,377,378,382,385,386,391,392,395,396,397,404,407,412,413,418,419,420,423,424,428,431,433,436,437,451,455,456,457,458,459,460,461,462,463,466,467,468,469,470,471,472],ignorable_whitespac:409,ignorablewhitespac:412,ignore_dangling_symlink:[333,466],ignore_discard:244,ignore_environ:[355,466,472],ignore_error:[159,333],ignore_except:170,ignore_exception_detail:[193,463],ignore_expir:244,ignore_pattern:[333,462],ignore_zero:[359,472],ignorecas:[106,321,347],ignorechar:144,ignoredir:376,ignoremod:376,ih3:461,ihav:288,ihook:[456,459,462,463],iid:[177,373,472],iii:79,iiihh:448,iinput:459,iis7:404,iis:31,iiscgihandl:404,ik1hcnrpbib2libmw7z3axmi:288,ilia:472,ill:[187,306,466,471],illeg:[12,22,43,94,99,109,159,169,197,206,213,214,293,316,343,346,367,373,404,407,419,423,424,427,431,432,457,458,460,461,463,466],illumo:472,illus:[424,440,466],illustr:[31,91,95,103,104,110,122,140,174,193,209,241,244,252,267,332,342,346,360,392,396,426,460,467],ilsch:472,ilshift:291,ilya:[466,471,472],im_func:[113,462],im_self:462,im_us:242,ima:143,imag:[7,14,38,62,91,93,153,156,178,199,201,207,227,228,244,253,261,278,289,324,346,347,355,369,373,380,392,399,403,416,424,448,466,471,472],imagenam:373,imageop:462,imagespec:373,imagin:[79,106,301,380,386,387,442],imaginari:[14,62,93,156,184,201,289,346,347,355,424,426,445,462,463,466],imagnumb:426,imagpart:436,imap4:[62,253,255,307,466,469,470,472],imap4_port:249,imap4_ssl:[249,467,472],imap4_ssl_port:249,imap4_stream:249,imap4rev1:249,imap:[86,113,195,249,284,307,343,391,459,460,472],imap_it:284,imap_unord:[284,472],imap_unordered_it:284,imapiter:284,imaplib:[62,106,195,253,255,307,458,459,460,463,465,470,472],imatmul:[291,469],imax:7,img:[201,241],img_1074:448,img_1076:448,img_1077:448,img_data:201,imgfil:462,imghdr:[62,201,207,253,278,472],imglib:250,imin:7,imit:[310,462],immateri:[111,428],immedi:[15,23,26,28,30,31,57,60,79,85,90,91,93,95,97,98,99,105,106,117,129,131,132,135,136,137,139,140,143,155,157,167,170,176,177,178,185,187,193,206,214,215,217,219,237,243,248,254,257,265,271,283,284,293,295,299,314,318,321,332,334,339,342,343,346,347,350,355,360,361,362,366,367,373,382,385,387,392,403,407,410,412,413,416,417,423,424,426,428,439,442,447,451,455,458,459,460,462,463,467,468,470,471,472],immedok:178,immin:257,immisch:461,immort:[355,459],immun:472,immut:[9,26,31,55,57,58,62,91,93,162,176,177,182,184,187,209,223,227,254,291,293,298,320,395,424,426,436,438,445,456,459,460,461,462,463,464,472],immutableset:[459,460],imod:291,imp:[28,62,253,352,355,428,464,466,467,468,470,472],impact:[81,168,293,349,363,472],impart:[62,266],impati:463,imperfect:365,impimport:304,impl:[95,408,472],impl_by_refer:95,impl_definit:95,impl_detail:363,impl_prototyp:95,implement:[3,5,6,7,8,9,11,12,14,19,22,26,27,28,29,30,31,35,38,41,45,51,53,54,57,58,60,61,62,65,66,70,72,74,78,79,81,82,86,87,91,92,93,95,97,98,99,101,103,106,109,110,118,122,123,124,125,126,127,131,132,133,134,135,138,139,141,144,145,150,153,157,158,159,161,162,167,168,169,171,172,174,175,176,177,183,184,187,190,193,197,204,206,208,209,212,213,214,215,219,221,223,225,227,228,229,232,235,236,238,241,242,243,244,245,246,249,251,253,254,255,257,258,260,265,266,267,268,270,271,273,275,277,278,281,282,283,284,285,286,288,290,292,293,294,298,300,301,302,304,305,307,308,309,310,311,314,316,317,318,320,321,322,326,327,329,330,331,332,333,334,336,337,339,340,342,343,344,345,346,347,349,350,351,355,359,360,361,363,366,367,369,370,371,373,375,377,380,381,382,383,385,386,387,391,392,396,397,398,399,400,402,406,407,410,411,412,413,414,415,416,419,420,422,423,425,426,428,429,431,432,435,436,437,438,440,441,442,443,446,447,448,451,455,456,457,458,459,460,461,462,463,464,465,466,469,472,473],implementor:[62,290,458,463,470],impli:[7,28,31,38,53,57,65,74,75,94,104,109,111,113,141,164,182,212,225,227,237,257,292,316,320,322,343,346,382,412,422,424,426,432,451,462,468,471,472],implic:[111,252,284,301,406,426,472],implicit0:[254,470,472],implicit:[54,62,79,93,104,113,122,182,189,214,227,238,252,254,257,316,321,339,342,346,349,361,370,387,399,424,428,451,463,464,466,468,469,470,471,472,473],implicitli:[22,74,91,93,95,129,135,140,144,168,170,182,185,190,214,225,241,249,252,257,267,282,295,326,334,337,339,342,346,347,350,382,386,397,409,424,426,428,431,432,436,437,439,463,466,467,469,470,471,472],implictli:426,impload:304,import__find__load__don:[101,471],import__find__load__start:[101,471],import_as_nam:427,import_fresh_modul:363,import_from:[190,427],import_machineri:428,import_modul:[62,91,227,251,267,281,326,363,424,428,432,463,467,472],import_nam:[190,427],import_spam:79,import_star:190,import_stmt:[427,432],importantli:[86,297,387,428],importbench:472,importdl:456,importerror:[22,65,105,214,251,252,267,280,284,301,304,335,343,355,363,385,407,420,428,432,446,457,459,462,467,468,470,471,472],importfrom:124,importlib2:105,importlib:[62,91,93,101,105,113,227,248,251,253,254,267,281,304,313,326,355,363,378,381,424,429,432,446,455,465,466,472,473],importlib_resourc:[471,472],imports2:113,importtim:[451,471,472],importwarn:[22,214,385,397,446,461,470,472],impos:[196,261,293,294,301,323,324,346,430,451],imposs:[22,36,49,57,84,86,91,96,124,159,267,284,293,298,314,345,351,363,366,385,398,407,432,456,457,458,459,460,462,463,469],impract:99,improb:159,improp:[363,424],improperconnectionst:243,improperli:[391,424,456,468],improv:[1,3,22,62,79,84,86,91,93,94,98,104,106,122,125,135,149,159,167,168,224,249,301,316,343,369,373,407,422,424,447,448,464,472,473],impur:228,imputil:[456,459,463],imreh:472,imsx:321,imul:[113,291],in6_addr:339,in_addr:339,in_dict:386,in_dll:177,in_error:107,in_fil:394,in_json:462,in_table_a1:348,in_table_b1:348,in_table_c11:348,in_table_c11_c12:348,in_table_c12:348,in_table_c21:348,in_table_c21_c22:348,in_table_c22:348,in_table_c3:348,in_table_c4:348,in_table_c5:348,in_table_c6:348,in_table_c7:348,in_table_c8:348,in_table_c9:348,in_table_d1:348,in_table_d2:348,in_test:143,in_transact:342,in_transit:466,inabl:[267,293],inaccess:[84,253,293,294,392,424,456,459,468,472],inaccur:[62,227,458,460],inaccuraci:[460,463],inact:[462,472],inada:[469,470,471,472],inaddr_:339,inaddr_ani:339,inaddr_broadcast:339,inadequ:459,inadvert:[111,170,254,396,462,468,469,472],inappropri:[111,214,252,340,348,424,472],inbox:[249,271],inc:[91,343,405,422,456,462],incarn:423,incas:472,incdir:74,incept:236,inch:[178,370],incident:[31,91,111,214,381,422,436],inclhead:155,includ:[1,4,5,7,9,17,19,26,28,29,30,45,48,50,51,53,56,57,58,60,62,64,65,66,67,68,70,74,75,77,78,79,81,82,83,84,85,86,87,89,90,91,92,93,94,95,96,97,98,99,102,103,104,106,108,109,110,111,112,115,119,122,124,131,135,137,138,141,144,147,152,154,155,156,157,158,159,160,161,164,168,174,177,178,179,182,184,187,189,190,192,193,197,201,203,204,206,207,208,209,211,212,213,214,220,222,225,227,229,230,232,233,235,236,237,238,240,241,243,244,245,246,248,249,251,252,253,254,257,258,260,261,262,263,264,265,266,267,269,271,273,275,276,282,284,286,288,289,291,292,293,294,296,297,299,301,305,307,308,309,310,313,314,316,320,321,324,325,328,331,332,333,334,335,336,337,339,342,343,344,345,346,347,349,350,351,355,356,357,359,360,361,363,365,366,367,369,370,372,373,375,376,377,378,380,381,382,385,386,387,391,392,394,396,397,399,402,403,404,406,407,408,410,412,413,416,417,418,419,421,422,423,424,425,426,427,428,430,431,432,436,437,438,440,441,442,444,445,446,448,450,451,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],include_attribut:124,include_debug:455,include_default:205,include_dev:455,include_dir:[65,74,77,456],include_doc:455,include_ex:455,include_fil:472,include_launch:455,include_lib:455,include_pip:455,include_queri:404,include_symbol:455,include_tcltk:455,include_test:455,include_tool:455,includepi:466,includesubdomain:343,inclus:[31,35,65,70,86,93,95,122,153,167,184,213,239,258,264,266,269,293,310,320,321,332,378,426,430,432,463,466,471],incom:[125,129,135,141,214,237,246,261,284,340,343,409,466,472],incompar:464,incompat:[60,74,93,95,96,105,114,177,185,254,258,266,271,274,288,421,432,456,459,461,464,466,467,469,471,472],incomplet:[28,58,62,84,120,147,158,159,181,184,227,241,248,251,267,316,329,421,422,448,459,460,463,464,467,468,472],incompleteread:243,incompletereaderror:[130,137,472],inconsist:[189,214,339,386,431,434,457,470,472],inconveni:[91,95,96,244,254,387,410],incorpor:[62,79,86,103,106,161,187,266,343,410,459,461,462,463,466,472],incorrect:[104,106,113,158,185,193,214,227,245,271,292,293,367,385,387,394,408,457,458,459,461,464,467,468,472],incorrectli:[101,104,144,169,254,271,292,293,350,386,424,466,467,468,472],incr_item:31,incrcount:142,increas:[5,62,82,84,86,93,94,95,102,103,109,122,139,159,189,190,212,222,254,258,266,269,290,293,328,329,343,355,368,373,378,385,397,409,411,421,431,436,456,458,459,463,467,470,471,472],increasingli:[84,380,440,462,463],incref:[31,57,472],increment:[5,6,22,30,31,42,45,47,54,57,58,62,74,79,82,86,91,95,99,104,111,120,121,124,139,146,161,190,208,269,284,292,293,346,358,366,370,373,382,408,410,423,437,456,458,459,460,461,463,466,467,472],increment_lineno:124,incrementaldecod:[13,62,146,257,461],incrementalencod:[13,62,146,461],incrementalnewlinedecod:[257,472],incrementalpars:[62,273],incremented_item:31,incur:[81,161,187,260,466],inde:[38,82,84,92,107,138,196,343],indefinit:[107,152,178,184,246,260,264,268,271,334,360,463,468,469,472],indent:[62,68,86,92,93,95,101,106,113,122,124,168,170,193,205,214,222,253,254,261,263,302,309,365,368,369,372,374,375,386,387,408,423,427,435,437,443,445,448,456,466,467,468,472],indentationerror:[22,92,214,446,456],indentedhelpformatt:292,indentlevel:302,independ:[2,17,21,30,31,41,62,65,66,69,74,79,81,84,86,90,92,97,99,104,141,161,184,193,202,211,212,227,228,247,257,260,265,266,271,274,345,346,349,355,367,368,369,370,373,375,385,396,407,419,426,440,445,446,456,463,467,472,473],indetermin:[187,373,397,405,439],index:[7,31,34,43,49,54,55,57,58,62,64,66,71,85,86,90,93,99,102,105,106,108,112,117,118,123,124,126,143,145,149,153,157,161,162,177,190,191,197,206,210,214,227,232,234,237,243,246,253,254,256,260,261,267,279,282,284,291,293,298,300,301,312,315,316,321,322,324,339,341,344,346,347,355,360,362,366,367,369,373,377,378,391,402,407,410,419,423,424,426,432,436,438,445,446,449,450,453,456,458,460,462,463,464,466,467,469,470,471,472,473],index_size_err:407,index_str:347,indexbyt:105,indexerror:[22,33,34,43,55,159,161,177,197,214,237,260,284,301,320,321,347,377,386,424,426,432,445,446,456,466,472],indexof:291,indexsizeerr:407,indian:380,indic:[3,5,7,29,30,31,34,37,45,49,51,53,54,56,57,58,62,65,74,75,79,81,82,86,90,91,93,95,101,102,103,104,106,107,108,109,110,118,119,122,124,125,136,138,140,141,145,147,157,158,159,167,168,169,170,174,176,177,178,184,187,190,197,203,204,206,209,210,211,214,222,225,227,228,230,236,243,244,246,248,249,251,252,253,254,257,260,265,266,267,269,271,274,276,279,284,288,292,293,295,297,299,302,305,307,309,310,313,316,318,321,329,330,333,334,337,338,339,340,342,343,344,345,346,347,349,350,351,355,358,361,362,363,366,367,370,373,374,377,382,385,386,391,392,395,396,397,402,403,404,405,407,410,416,421,422,424,426,428,431,432,436,437,439,445,446,448,455,457,458,459,460,461,462,463,464,465,466,468,469,470,471,472],indiffer:456,indifferenti:236,indirect:[45,65,79,91,227,309,422,424,426,428,472],indirectli:[53,58,65,70,105,172,177,214,252,293,294,316,350,355,399,424,425,426,428,438,439,464,468,471,472],indistinguish:[107,284,310],individu:[5,38,41,53,56,57,62,66,69,71,97,98,102,103,104,106,111,113,119,159,176,185,187,189,190,193,197,199,204,207,212,220,232,249,250,253,254,260,266,271,282,283,284,293,294,315,321,333,346,347,357,360,363,365,367,368,373,380,385,386,387,391,395,397,405,410,416,417,419,422,424,428,430,432,436,438,445,446,451,457,460,461,463,465,467,468,472],induc:310,industri:422,ineffect:468,ineffici:[58,91,149,257,293,343,469],inequ:[109,187,196,203,385,426,462,466],inet:[107,339],inet_aton:[339,472],inet_ntoa:339,inet_ntop:[339,468],inet_pton:[129,339,468,472],inevit:105,inexact:[187,293,440,467],inf:[156,187,227,261,275,346,347,355,462,463,466,469,470,472],infer:[65,95,122,193,228,267,284,367,377,382,448,470],inferior:111,infil:[122,142,261,303,332,376,448,465,466],infin:[106,156,187,227,261,275,320,346,347,355,460,462,466,472],infinit:[17,41,62,84,91,99,106,136,187,237,249,260,275,284,285,293,298,301,318,321,322,346,355,385,424,437,440,456,460,462,467,472],infinite_stream:382,infinitesim:284,infix:[62,84],infj:[156,470,472],inflex:[468,469],influenc:[7,65,301,339,451,462],info:[22,62,65,69,74,79,86,87,90,94,103,104,128,154,159,170,184,190,227,229,232,244,254,266,267,268,271,284,288,304,309,333,339,351,370,380,382,385,392,418,419,426,428,448,451,453,457,459,461,462,463,466,468,472],infolist:419,inform:[0,1,3,4,5,7,10,13,22,24,30,31,38,41,53,55,57,60,62,63,64,66,68,69,70,71,72,74,77,78,79,80,81,83,91,92,93,94,95,99,101,102,103,106,109,110,111,112,113,117,120,122,123,129,132,135,137,141,142,145,153,154,156,159,161,163,164,170,172,173,176,177,178,182,184,187,189,190,192,193,196,197,198,202,204,206,208,210,212,214,216,217,222,225,227,229,230,234,236,238,241,243,244,246,248,249,252,253,254,258,260,265,266,267,268,269,271,272,276,279,284,286,288,291,292,297,298,301,304,305,307,309,310,313,314,315,316,317,318,321,322,329,332,333,334,336,337,339,340,342,343,344,346,349,350,355,359,362,363,366,367,369,370,372,373,376,377,378,380,382,385,386,388,391,392,395,396,399,401,402,404,406,407,408,409,410,411,412,413,419,421,423,424,425,428,429,430,431,432,435,437,439,441,442,444,446,448,449,451,452,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],infozip:65,infrastructur:[64,86,104,112,118,125,141,159,343,397,462,463,468,471],infrequ:340,infring:422,ing:[31,58,85,106,107,193,204,244,463,467,471,472],ingebretson:472,inglesbi:472,ingredi:342,ingrid:472,inher:[122,123,232,366,410],inherit:[5,56,57,62,70,81,82,84,91,93,95,98,118,120,124,140,157,159,161,162,170,177,178,184,200,214,222,223,224,225,227,236,248,252,254,257,258,268,271,284,292,298,301,317,329,336,339,340,343,344,350,354,361,363,366,370,373,375,382,407,411,412,413,423,424,426,440,441,455,456,459,461,462,464,467,469,471,472],inhibit:[252,316],ini:[62,218,332,452,466],init:[30,62,65,79,92,204,251,252,276,293,298,310,317,336,364,372,461,462,472],init_by_arrai:422,init_color:178,init_databas:282,init_frozen:472,init_genrand:422,init_glob:326,init_histori:322,init_kei:422,init_lett:461,init_or_s:177,init_pair:[97,178],init_sourc:363,initarg:[167,284,471],initerror:96,initfp:472,initfunc:28,initfunc_nam:77,initgroup:[293,463],initi:[2,3,5,15,17,21,22,26,28,29,31,38,45,53,54,55,56,57,58,62,63,65,74,75,77,78,80,82,85,91,92,95,97,99,103,104,108,109,117,122,123,125,129,136,139,141,142,143,147,157,159,161,167,168,176,177,178,182,187,189,193,196,203,204,207,210,214,222,225,227,228,229,232,235,236,237,238,248,249,251,252,257,260,261,265,266,267,268,269,271,276,279,282,284,286,288,292,293,294,297,301,303,307,310,316,320,322,332,335,336,337,339,340,342,343,346,350,355,357,360,361,366,367,368,370,373,380,381,385,392,396,397,410,416,421,422,423,424,428,432,433,436,438,445,446,451,455,456,459,460,461,462,463,464,465,466,467,468,470,471,472],initial_byt:257,initial_ind:365,initial_response_ok:337,initial_valu:[99,257],initialdata:161,initialis:[19,104,244,268,326,386,424,451,468,470],initialize_opt:65,initleo:92,initleoc:92,initlog:437,initmodul:[30,74],initmyappc:92,initmyextens:96,initproc:[57,81,82],initscr:[97,178],initsig:30,initspam:83,initv:98,initvar:[182,472],inject:[104,129,131,138,266,342,350,392,406,451,461,469,472],inlin:[93,95,168,189,197,198,204,206,236,238,310,321,385,459,461,466,470,472],inline_comment_prefix:168,inner:[161,170,190,236,254,321,342,346,380,410,423,460,463,466,467,472],inner_s:236,inner_stack:170,inner_word:321,innermost:[93,118,170,193,316,426,436,437,468,472],innoc:31,innocu:459,innodb:168,inod:[268,293,344,472],inoffens:301,inord:[99,458,459],inordin:[233,298],inplac:[68,219,472],inplace_add:190,inplace_and:190,inplace_floor_divid:190,inplace_lshift:190,inplace_matrix_multipli:190,inplace_modulo:190,inplace_multipli:190,inplace_or:190,inplace_pow:190,inplace_rshift:190,inplace_subtract:190,inplace_true_divid:190,inplace_xor:190,inproduct:382,input:[0,5,9,13,14,31,44,57,58,60,62,65,79,81,84,91,93,94,95,99,102,103,108,109,110,111,113,115,120,122,125,129,135,138,143,144,145,147,148,151,153,157,158,159,160,161,168,170,174,176,177,184,187,189,190,193,195,196,197,198,201,202,204,208,209,210,214,220,223,224,227,236,237,241,245,246,248,253,257,260,261,263,266,268,269,271,274,275,284,291,292,293,294,295,297,299,303,304,309,311,313,316,319,321,322,324,329,332,337,339,342,343,345,350,355,360,362,363,365,367,372,373,374,377,385,386,391,392,394,398,404,405,408,409,410,411,412,413,414,418,421,424,425,426,427,428,429,430,431,434,437,438,439,440,441,444,445,446,448,451,456,459,460,461,462,463,464,465,466,467,468,469,470,471,472],input_charset:[196,197],input_codec:196,input_data:345,inputdata:143,inputerror:439,inputonli:372,inputrc:322,inputsourc:[62,273,411,412,414,469,472],inquir:[373,469],inquiri:[26,41,57,81,82,257,385],inrat:143,ins:[57,91,99,212,456,458,459,460],insch:178,inscrib:380,insdelln:178,insec:365,insecur:[286,331,342,343,442,461,466],insensit:[13,17,62,93,106,108,109,145,159,161,168,197,206,245,246,252,276,321,335,342,347,348,363,392,397,404,455,460,462,471,472,473],insert:[21,28,30,31,34,55,62,65,78,79,84,86,95,99,109,113,122,123,144,149,153,161,162,172,178,182,189,193,209,222,227,228,237,248,251,252,257,261,266,269,282,292,299,301,309,318,322,336,342,346,347,355,373,381,397,399,404,407,410,420,423,424,426,428,432,436,437,438,445,451,454,456,459,461,462,463,465,467,468,469,470,471,472],insert_mod:462,insert_text:[322,325],insertbefor:[407,456],insertln:178,insid:[5,10,30,38,62,65,74,79,80,82,84,87,91,92,93,95,97,99,106,107,114,145,170,176,178,187,197,200,206,211,227,229,241,252,256,257,261,282,284,298,299,318,321,333,334,339,343,347,370,372,373,380,385,386,387,417,420,423,424,426,432,436,437,438,439,442,445,449,455,457,458,459,460,461,462,464,466,468,470,471,472],insignific:347,insist:[90,311,370],insnstr:178,insofar:[241,271,432],insort:[149,448],insort_left:149,insort_right:149,inspect:[62,79,82,93,95,101,105,114,122,124,131,140,162,182,193,227,229,236,252,253,258,266,271,297,299,309,315,317,334,335,343,346,355,359,378,385,392,419,423,424,451,456,457,458,462,463,472],inspectload:[252,468,469,472],inspector:[91,372],inspir:[85,109,168,201,260,261,385,422,456,457,459,462,466,467],insstr:178,inst:[45,432,439],inst_nam:462,instabl:464,instal:[28,30,31,38,62,68,69,70,71,72,75,77,78,82,85,86,87,88,90,91,92,93,97,101,105,110,113,134,145,164,175,185,191,213,215,232,248,252,253,255,256,266,268,276,278,305,313,317,322,334,335,342,343,355,362,370,372,373,378,380,385,392,396,397,401,402,404,418,422,428,434,444,446,449,450,451,452,457,458,459,461,462,463,466,467,469,470,471,472,473],install_data:71,install_head:[71,74],install_lib:[67,71],install_misc:[471,472],install_open:[110,392],install_pip:396,install_script:[71,396],install_setuptool:396,installallus:455,installdir:447,installermast:458,installexecutesequ:282,installhandl:385,installlauncherallus:455,installuisequ:282,instanc:[8,9,12,13,14,15,19,21,22,24,25,26,28,30,31,34,35,39,41,45,47,48,50,53,55,56,57,58,62,65,66,72,74,77,79,81,82,84,93,94,95,97,98,99,103,104,105,106,108,110,114,118,119,122,124,125,129,131,132,134,135,137,138,140,141,142,145,151,152,153,155,157,158,159,160,161,162,167,168,170,172,173,176,177,178,183,184,187,189,190,193,195,196,197,200,202,203,204,206,207,208,209,210,213,214,219,222,223,225,227,228,229,232,235,241,243,244,245,246,248,249,251,252,254,257,260,261,266,267,268,269,271,274,282,284,285,286,288,289,291,292,293,298,299,300,302,306,307,309,310,314,316,317,320,321,323,325,327,330,331,332,333,336,337,339,340,342,343,347,349,350,351,354,355,356,359,360,363,365,366,368,370,376,378,380,381,382,385,386,387,390,391,392,395,397,398,399,400,403,404,405,407,408,409,410,411,412,413,416,417,418,419,420,423,425,426,428,431,432,437,438,439,441,442,445,446,447,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],instani:199,instant:[62,186],instanti:[22,65,69,82,90,103,104,110,118,129,135,137,138,140,153,155,157,161,177,178,182,184,189,195,197,204,212,222,232,241,243,246,249,251,252,266,267,268,271,284,289,292,298,299,320,329,330,332,336,337,339,340,346,370,373,382,385,386,387,396,400,405,407,408,411,413,424,432,436,439,461,462,466,469,471,472],instantli:[97,293,380],instat:373,instead:[5,7,11,12,15,16,21,22,23,28,30,36,38,41,44,45,53,54,57,60,62,65,74,78,79,80,81,82,83,85,90,91,92,93,94,96,97,98,99,101,102,103,104,106,108,109,110,111,116,122,125,128,129,130,131,133,135,137,139,140,141,144,147,149,151,153,154,158,159,160,161,167,168,170,171,176,177,178,182,184,185,187,189,190,192,193,194,197,198,199,201,202,203,204,206,208,209,210,211,212,214,223,225,227,228,230,232,237,238,243,244,245,246,248,249,251,252,254,257,260,261,265,266,268,269,271,274,275,284,288,292,293,297,298,299,300,301,302,306,307,308,309,310,313,314,315,316,320,321,322,323,328,329,330,331,332,333,334,337,339,340,341,343,345,346,347,349,350,355,356,357,359,360,361,366,367,368,370,372,373,377,378,381,384,385,386,387,390,391,392,394,396,397,399,402,404,406,407,408,409,410,412,420,423,424,426,427,428,431,432,435,436,437,438,440,441,442,445,446,447,448,449,451,453,454,455,456,457,458,459,460,461,462,463,465,466,467,468,469,470,471,472],institut:[64,112],instr:[178,190,468,472],instream:332,instruct:[7,62,64,65,74,75,83,84,90,92,93,99,101,111,153,176,187,193,241,254,263,292,310,316,334,342,343,355,385,407,410,412,424,426,451,456,461,463,466,468,472],instrument:[62,100,129,228,310,466,470,472],insuffici:[28,187,193,284,293,386,470],insufficient_storag:242,insul:30,insuper:106,int2ap:249,int_curr_symbol:265,int_field:470,int_frac_digit:265,int_info:[355,446,465],int_max:472,intabl:472,intact:[96,104,168,184,204,206,209,219,268,347,404,460],intargfunc:57,intarray5:177,integ:[4,5,6,7,9,13,15,17,22,23,31,37,38,41,43,45,51,57,58,60,62,65,78,79,81,82,84,90,93,94,95,96,97,99,102,104,105,106,107,109,110,117,119,122,123,125,129,135,136,141,143,151,152,156,159,161,167,168,174,177,178,179,184,187,193,204,212,213,214,216,219,222,223,225,227,229,234,235,244,246,249,251,252,255,257,260,261,265,266,267,268,269,274,275,279,282,284,288,289,290,291,292,293,294,297,301,306,307,310,312,316,318,321,322,323,324,329,330,333,339,340,341,342,343,347,349,350,351,355,362,366,367,370,373,380,384,386,391,395,397,398,402,405,407,408,410,416,419,421,423,424,426,432,436,437,439,440,442,445,447,451,456,457,459,461,463,465,466,467,468,469,470,471,472,473],integr:[60,62,71,79,87,91,92,93,101,107,120,187,192,193,248,269,275,289,321,340,342,346,349,369,385,386,387,398,424,426,453,454,455,456,459,460,462,464,466,467,471,472],integrityerror:342,intel64:356,intel:[30,65,92,107,143,295,310,349,453,461,463,469,470,472],intellectu:422,intellig:[289,292,294,295,299],intend:[22,28,30,58,65,70,74,78,79,80,81,84,90,93,94,95,99,103,104,106,110,111,117,129,153,159,161,170,172,184,185,190,193,202,209,214,227,228,241,245,246,248,254,257,258,266,268,269,271,274,288,293,301,304,305,309,332,335,339,343,346,347,349,350,355,358,366,370,373,376,380,382,385,386,391,392,397,404,408,416,419,423,424,426,430,431,432,437,438,439,440,446,451,455,456,457,458,459,460,461,462,463,468,469,470,471,472],intens:[93,128,178,269,293,467],intent:[22,28,78,79,95,104,182,184,197,206,275,293,385,404,424,459,460,462,464,467,468],intention:[248,288,382,404,416,464],intenum:[62,183,242,339,343,470,472],inter:[189,259,334,448,466],interact:[2,22,30,31,38,54,57,60,62,65,78,85,86,90,91,92,93,104,106,111,115,117,122,124,129,137,145,157,167,169,178,181,187,188,190,195,208,214,219,222,227,244,248,251,253,254,257,284,292,293,295,299,309,310,315,317,322,325,335,336,343,350,355,359,360,369,370,372,373,377,380,385,392,397,410,417,419,424,427,428,429,430,431,432,435,436,437,441,445,446,447,451,455,458,459,460,463,464,465,466,467,468,469,470,471,472,473],interactiveconsol:[158,322],interactiveinterpret:[158,469,472],intercept:[140,355,470],interchang:[62,96,104,119,155,169,184,187,214,236,261,266,346,382,387,424,431,442,447,456,462,466,467],interdum:151,interest:[21,57,62,66,70,74,78,79,81,83,84,86,90,91,95,99,101,103,104,106,107,109,111,139,141,153,155,156,161,168,183,184,189,193,195,201,208,216,217,227,237,248,260,266,271,273,276,286,292,299,310,316,329,351,366,368,369,385,386,387,392,397,398,412,424,430,432,447,450,456,457,458,459,461,463],interestingli:[108,321,440],interf:[93,187,284,368,426,468],interfac:[5,7,28,29,30,31,39,44,54,57,58,60,62,65,66,69,72,74,78,79,81,86,88,91,93,97,98,99,103,105,106,109,110,111,116,118,120,121,122,123,129,134,135,144,148,151,152,155,157,159,161,162,167,168,170,171,172,173,174,176,177,178,181,186,188,191,193,194,195,197,198,204,205,206,207,208,216,219,220,224,227,230,232,234,235,236,243,244,246,248,251,252,253,255,256,259,260,263,265,266,269,271,273,276,277,278,282,285,292,294,295,297,298,299,300,304,305,306,307,308,310,312,316,317,326,327,329,331,334,337,340,341,343,346,350,351,354,355,357,361,362,364,366,367,372,375,377,379,380,388,391,394,395,397,398,399,400,401,404,406,407,408,410,411,412,414,422,424,428,429,435,441,446,449,452,455,456,458,459,460,461,462,463,465,467,468,469,470,471,472,473],interfer:[103,112,168,265,472],interior:[373,380,457,458],interleav:[193,284,463,466,471],interlin:189,intermedi:[7,85,90,93,99,187,190,207,252,260,275,292,293,297,343,386,428,461,465,466,471,472],intermediari:[65,66,72],intermezzo:[62,80,441],intermitt:469,intermix:[62,120,230,471,472],intern:[7,8,9,10,21,22,23,28,30,31,37,38,50,54,56,57,58,62,65,79,81,82,84,86,90,93,95,97,98,99,103,104,105,106,109,110,113,120,122,123,124,129,130,137,139,142,151,156,157,158,159,161,162,168,177,182,184,185,187,193,200,205,208,209,211,214,236,238,244,246,248,252,253,254,257,260,264,265,266,268,269,275,276,279,293,297,299,300,301,304,309,310,316,318,320,324,329,332,336,339,342,343,348,350,352,353,355,359,360,363,366,367,369,370,372,373,377,380,382,385,392,395,397,399,407,408,410,412,416,419,421,423,424,426,434,437,446,455,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],internal_attr:419,internal_server_error:242,internald:[106,249],internaldate2tupl:249,internalsubset:407,internation:[62,109,146,195,253,283,285,337,343,347,348,367,431,447,456,459,460,469,471,472],internet:[62,86,100,102,105,107,144,195,211,225,236,241,244,248,253,272,319,337,339,340,343,363,364,367,391,392,422,441,455,456,459,466,468,472],interoper:[62,104,118,129,131,143,209,212,246,258,285,301,320,343,346,424,442,465,466,468],interp:30,interpol:[62,65,218,345,346,426,466,469,470,472],interpolationdeptherror:168,interpolationerror:168,interpolationmissingoptionerror:[168,472],interpolationsyntaxerror:168,interpret:[5,7,15,17,22,23,28,29,31,35,38,41,43,45,47,48,52,53,54,57,58,60,62,65,74,78,79,81,82,85,86,91,92,93,95,96,98,99,101,103,104,105,106,109,111,112,113,117,122,123,124,129,139,142,146,152,153,154,164,167,168,169,176,177,178,183,184,185,187,190,191,193,198,204,208,210,211,214,220,222,224,227,229,236,246,248,249,251,252,253,256,257,258,260,261,262,266,267,279,282,284,291,292,293,297,299,301,305,308,309,310,311,312,313,315,316,317,321,322,326,329,331,332,334,335,337,339,342,343,346,347,350,351,355,356,361,362,363,366,367,370,372,373,377,382,385,386,392,396,397,399,400,403,407,410,421,422,424,425,426,427,428,429,430,431,432,433,434,435,436,437,438,441,442,445,446,448,449,451,452,454,455,456,457,459,460,464,465,466,467,468,469,470,471,472,473],interpreter_requires_environ:363,interprocess:[62,135,253,284,339],interpt:252,interrog:[104,206,387],interrupt:[22,30,117,129,153,178,179,187,213,214,227,248,271,284,293,318,329,330,334,339,340,342,350,360,366,367,385,392,403,417,422,424,434,437,439,462,463,466,469,472],interrupt_main:[117,472],interruptederror:[22,213,214,227,293,329,334,339,446,467,469,472],intersect:[161,346,424,438,459,460,462,463],intersection_upd:[346,459,462],interspers:[95,104,292],interstiti:468,interv:[84,99,103,178,184,268,293,310,320,334,345,355,363,366,367,373,380,460,462,466,470,472],interven:[79,104,189,193,205,448,467],intervent:[98,370],intfield:470,intflag:[62,183,321,343,470,472],intim:[302,305],intintargfunc:57,intintobjargproc:57,intobjargproc:57,intoler:109,intr:178,intr_flag:472,intra:[62,189,441],intraclass:436,intralin:189,intransact:472,intric:380,intricaci:292,intrins:[15,168,291,424,465],intro:[157,343,453,463],introduc:[22,30,62,79,84,86,91,92,93,95,96,98,99,103,104,105,106,114,129,214,222,236,244,246,252,271,275,284,292,293,301,307,310,343,347,349,354,355,361,372,373,380,381,382,391,411,423,424,425,426,428,430,431,432,435,436,437,441,445,446,451,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],introduct:[29,62,71,80,82,94,97,100,112,114,122,135,165,186,193,224,253,255,258,281,300,320,339,343,368,370,382,387,429,441,444,453,460,468,470,472,473],introductori:[86,89,94,106,109,339,370,461],introspect:[16,62,81,87,91,93,95,98,161,171,190,214,228,296,301,317,382,386,416,417,424,428,464,466,467,468,469,472],intrud:417,inttyp:[280,472],intuit:[84,102,103,106,153,187,189,372,426,456,457,458,468],intvar:[370,472],inu:299,inuse_attribute_err:407,inuseattributeerr:407,inv:[291,469],invalid:[22,26,31,54,56,62,79,84,86,93,94,102,103,106,109,110,117,120,129,130,158,160,161,164,177,184,185,187,193,197,200,202,204,206,209,212,213,214,217,227,228,229,232,239,241,243,245,248,251,252,261,267,271,275,284,292,293,294,295,301,311,313,321,324,329,330,334,339,343,345,346,347,350,351,359,363,366,367,373,382,385,391,393,397,398,399,402,407,416,432,437,438,439,445,451,456,462,463,464,465,467,468,469,470,471,472],invalid_access_err:407,invalid_character_err:407,invalid_modification_err:407,invalid_state_err:407,invalidaccesserr:407,invalidate_cach:[252,467,471,472],invalidation_mod:[164,313,471,472],invalidbase64charactersdefect:[197,200],invalidbase64lengthdefect:200,invalidbase64paddingdefect:[197,200],invalidcharactererr:407,invalidfileexcept:[306,472],invalidmodificationerr:407,invalidoper:[187,460,462,463,467],invalidstateerr:407,invalidstateerror:[130,131,140],invalidurl:[243,472],invalu:[141,193,321],invari:[84,99,187,197,212,237,260,301,382,426,428,436,440,472],invariantli:382,invent:[84,107,159,271,366,430,459,463],inventor:[271,370],inventori:[161,182,291],inventoryitem:182,invers:[147,152,156,184,187,202,210,227,245,258,275,291,301,346,367,426,462,472],invert:[99,124,159,187,291,346,424,426,472],invest:[103,345],investig:[103,346,472],investor:345,invis:[97,159,178,180,380,463,465,472],invit:[435,453,468],invmod:346,invoc:[22,51,62,65,77,79,93,95,98,101,165,170,177,211,246,274,284,310,366,377,385,396,404,412,423,424,434,436,451,452,453,454,460,466,468,472],invoic:462,invok:[5,19,22,28,31,47,53,54,57,58,62,64,65,81,90,91,99,101,102,104,106,109,111,122,129,132,139,145,153,157,168,170,182,184,193,211,227,228,229,233,244,246,254,265,266,284,292,293,294,297,299,301,302,304,310,313,315,321,322,326,333,336,337,340,342,343,346,350,355,360,363,366,368,370,373,376,385,391,396,399,404,410,411,412,413,416,417,423,425,428,431,433,436,441,443,445,447,451,455,457,458,459,460,461,462,463,464,467,468,469,471,472],involuntari:324,involv:[1,26,38,64,65,74,79,80,82,84,93,95,124,156,168,170,178,187,193,214,228,229,244,284,289,292,310,342,343,346,349,363,385,387,392,409,424,426,428,432,436,446,456,463,468,469,471,472],inward:187,iobas:[189,214,216,257,375,472],iobench:463,iobind:472,iocp:129,iocpproactor:472,ioctl:[62,123,253,295,339,388,460,462,470,472],ioctl_vm_sockets_get_local_cid:339,ioerror:[155,214,216,219,227,232,244,254,257,283,284,295,333,334,390,420,446,462,463,464,467],ior:291,ip6:[258,469],ip_:339,ip_address:[102,258,339],ip_hdrincl:339,ip_interfac:[102,258,472],ip_network:[102,258],ip_str:339,ipaddr:258,ipaddress:[62,100,253,255,472],ipaddrlist:339,ipadi:370,ipadx:370,ipc:[62,126,132,135],ipconfig:472,ipd266:[458,459],ipo:143,ipow:291,ippolito:[461,462,463,465],ipport_:339,ipproto_:339,ipproto_ip:339,ipproto_tcp:339,ipv4:[62,102,107,129,253,255,339,343,462,467,472],ipv4_map:258,ipv4address:[102,258,469,472],ipv4interfac:[102,258,472],ipv4network:[102,258,469,471,472],ipv6:[62,102,129,253,255,336,339,343,363,391,458,462,463,465,466,467,469,472],ipv6_:339,ipv6_en:363,ipv6address:[102,258,469,472],ipv6interfac:[102,258,472],ipv6network:[102,258,469,471,472],ipv:[102,472],ipython:[443,462],ipz:346,irepeat:113,irix:[62,308,464,472],irmen:471,ironpython:[93,212,305,430,462],irregular:458,irrelev:[193,292,463,472],irrespect:386,irrevers:[129,328],irrit:459,irshift:291,irv:438,is_64bit:305,is_:[99,291],is_absolut:298,is_al:[284,366,462,472],is_android:[363,472],is_assign:354,is_async:124,is_attach:[206,472],is_authent:392,is_block:244,is_block_devic:298,is_canon:[187,463],is_char_devic:298,is_character_junk:189,is_check_support:269,is_clos:[129,132,135,137,469,470,471,472],is_cryptograph:343,is_dataclass:[182,472],is_dataclass_inst:182,is_declared_glob:[354,463],is_dir:[293,298,419,470,472],is_en:215,is_even:[99,416],is_expir:244,is_fifo:298,is_fil:[293,298,469,472],is_fin:[30,355,469,472],is_finit:187,is_fre:354,is_frozen:468,is_glob:[258,354,468,472],is_goal:448,is_hop_by_hop:404,is_image_fil:461,is_import:354,is_infinit:187,is_integ:346,is_jump_target:190,is_jython:363,is_line_junk:189,is_linetouch:178,is_link_loc:258,is_loc:354,is_loopback:258,is_moon_ful:292,is_mount:[298,471,472],is_multicast:[258,472],is_multipart:[197,200,206,208,472],is_namespac:354,is_nan:187,is_nest:354,is_norm:187,is_not:[99,291],is_not_allow:244,is_odd:260,is_optim:354,is_packag:[252,420],is_paramet:354,is_parameter_ent:316,is_prim:167,is_priv:[258,472],is_py3k:96,is_python_build:[356,463],is_qnan:187,is_read:[132,135,471,472],is_referenc:354,is_reserv:[258,298],is_resourc:252,is_resource_en:363,is_run:[129,132],is_saf:[395,471,472],is_serv:[129,471,472],is_set:[139,366],is_sign:187,is_site_loc:258,is_snan:187,is_socket:298,is_subnorm:187,is_symlink:[293,298],is_tarfil:359,is_term_res:178,is_trac:378,is_track:[229,463],is_unspecifi:258,is_unverifi:[392,468],is_verbos:463,is_wintouch:178,is_zero:187,is_zipfil:[419,463],isaac:321,isab:[270,294,298],isabstract:[254,462,472],isadirectoryerror:[22,214,293,446,467],isal:472,isalnum:[179,346],isalpha:[179,346],isascii:[179,346,471,472],isasyncgen:254,isasyncgenfunct:254,isatti:[54,155,227,257,293,355,442],isawait:[131,162,254,469,472],isbadstringptr:472,isbjunk:468,isblank:[179,472],isblk:359,isbn:[161,370,450],isbpopular:468,isbuiltin:254,iscal:[113,463,464,472],ischr:359,isclass:254,isclos:[156,275,469,472],iscntrl:[179,472],iscod:254,iscoroutin:[131,140,254,469,472],iscoroutinefunct:[140,254,469,472],isctrl:179,isdaemon:[366,462],isdatadescriptor:254,isdecim:[105,346],isdev:359,isdigit:[179,328,346],isdir:[270,294,298,304,333,359],isdisjoint:[162,346],isdown:380,isdst:210,isel:410,isen:229,isenabledfor:[103,104,266,463],isendwin:178,iseof:374,iserl:156,isexpr:297,isfifo:359,isfil:[201,270,294,298,359,434,466],isfin:316,isfinit:[156,275,466],isfirstlin:219,isfram:254,isfunct:254,isfutur:[131,472],isgener:[254,462],isgeneratorfunct:[254,462],isgetsetdescriptor:254,isgraph:179,ish:[65,434],ishelllink:66,ishimoto:468,isidentifi:346,isindex:153,isinf:[156,275,346,462],isinst:[57,84,91,93,103,104,113,118,153,162,170,182,184,212,227,254,261,289,291,301,381,382,385,386,387,424,436,446,456,459,460,462,464,466,470,471,472],isjunk:189,iskeyword:[262,346],isleap:152,islic:[93,99,161,227,260,461,471,472],islink:[293,294,298,333],islnk:359,islow:[179,328,346],ismappingtyp:113,ismemberdescriptor:254,ismeta:179,ismethod:254,ismethoddescriptor:254,ismo:472,ismodul:254,ismount:[294,468,472],isn:[7,21,22,28,30,47,57,62,64,65,66,72,79,82,85,90,91,93,94,95,97,102,104,105,106,107,109,111,117,131,135,140,158,159,167,170,176,184,190,193,197,203,205,206,212,229,235,237,244,249,254,257,268,293,298,316,321,339,340,343,344,355,356,375,385,386,387,391,400,402,403,404,406,416,424,427,436,437,444,445,454,456,457,458,459,460,461,462,463,466,472],isnan:[156,275,346,438,462],isnontermin:374,isnot:124,isnumbertyp:113,isnumer:[105,346],iso2022_jp:159,iso2022_jp_1:159,iso2022_jp_2004:159,iso2022_jp_2:159,iso2022_jp_3:159,iso2022_jp_ext:159,iso2022_kr:159,iso2022jp:159,iso2022kr:159,iso8601:[103,416],iso8859:159,iso8859_10:159,iso8859_11:159,iso8859_13:159,iso8859_14:159,iso8859_15:159,iso8859_16:159,iso8859_2:159,iso8859_3:159,iso8859_4:159,iso8859_5:159,iso8859_6:159,iso8859_7:159,iso8859_8:159,iso8859_9:159,iso:[54,58,152,159,184,189,196,197,203,206,240,243,265,288,316,339,342,355,367,395,404,414,416,456,460,466,469,470,472],iso_8859:460,iso_8859_1:109,isocalendar:184,isoformat:[184,189,459,470,471,472],isol:[30,57,60,84,93,99,112,193,248,342,355,363,385,386,396,451,455,468,470,472],isolation_level:[342,472],isomorph:456,isort:91,isoweekdai:184,ispe:362,ispkg:304,isprint:[161,179,346,469,472],ispunct:[179,472],isread:309,isrecurs:309,isreg:359,isreservedkei:245,isroutin:254,issamenod:407,issequencetyp:113,isspac:[179,346],isstdin:219,isstr:280,issu:[7,23,29,30,60,62,64,74,82,86,93,103,104,105,109,121,122,129,141,157,159,178,182,186,187,204,214,222,223,225,227,231,236,243,248,249,257,261,265,266,271,274,284,292,293,300,301,311,313,337,339,343,346,363,367,380,385,386,387,397,399,406,409,410,418,422,429,439,441,448,451,452,456,457,458,460,461,463,464,465,466,467,468,469,470,471,472],issubclass:[56,84,93,118,227,381,382,397,424,436,446,456,462,471,472],issubset:[346,459],issue12524:243,issue22118:472,issue25782:472,issue3664:95,issue3770:104,issuer:343,issuit:297,issuperset:[346,459],issym:359,ist:299,istermin:374,istext:147,istitl:346,istraceback:254,isub:291,isupp:[179,328,346,385],isvis:380,isxdigit:179,isxyztk:472,it1:260,it2:260,ital:[152,178,222],itali:99,italian:[301,380],itamar:458,itanium:[349,456,469],item1:464,item2:464,item:[2,5,7,13,16,21,22,24,28,30,31,32,33,34,36,40,49,50,55,57,58,62,79,82,84,85,90,93,95,99,104,105,108,113,122,123,124,136,141,143,149,152,153,158,159,161,162,168,171,172,177,182,185,189,190,193,197,198,201,206,210,212,214,225,227,228,229,234,235,236,237,245,248,249,251,252,260,261,266,267,268,271,276,280,284,288,291,293,301,304,305,306,308,309,310,312,315,318,321,322,326,333,335,338,339,341,342,343,346,347,349,350,351,355,360,361,362,363,366,369,370,372,375,377,380,381,382,386,391,399,402,404,405,407,409,410,413,416,419,420,423,424,426,428,430,432,436,437,438,442,445,446,448,457,458,459,460,461,462,463,464,465,466,467,468,469,471,472],item_path:461,item_separ:261,itemconfigur:472,itemgett:[93,108,260,291,460,461,469,472],itemlist:34,itemnam:446,items:[7,123,284,339,346],items_list:436,itemsview:[162,382],iter1:462,iter2:462,iter:[2,15,21,27,29,30,45,49,50,57,58,62,81,84,93,98,102,106,108,113,118,123,124,129,135,137,140,145,151,152,153,159,161,162,167,168,170,171,176,177,182,183,188,190,195,196,197,198,206,214,220,226,227,228,232,233,235,236,237,243,244,252,253,254,255,257,261,265,266,269,271,275,284,285,288,293,299,301,302,306,310,321,329,339,342,345,347,349,355,363,375,381,382,386,391,392,399,404,407,410,412,416,423,427,428,432,437,438,441,446,456,457,459,461,462,463,465,466,467,468,470,471,472,473],iter_attach:[201,206,472],iter_child_nod:124,iter_except:260,iter_field:124,iter_import:[304,467],iter_modul:[304,467,470],iter_part:[197,206,208],iter_unpack:[349,468],itera:99,iterable1:462,iterb:99,iterchar:342,iterdecod:159,iterdir:298,iterdump:342,iterencod:[159,261],iterfind:[410,466],iteritem:[113,271,458,459,460,464,472],iterkei:[113,271,458,459,460,462,464,472],iterkeyref:461,itermonthd:[152,471,472],itermonthdai:[152,472],itermonthdays2:[152,472],itermonthdays3:[152,471,472],itermonthdays4:[152,471,472],iternextfunc:[57,81],iterpars:[410,468,472],itertext:[410,463,466,472],itertool:[62,93,113,161,226,227,228,237,248,252,253,280,291,320,459,460,461,462,463,464,465,472],itertools_import:113,itervalu:[113,271,458,459,460,464,472],itervalueref:461,iterweekdai:152,itimer_prof:334,itimer_r:334,itimer_virtu:334,itimererror:334,itn:[260,472],ito:472,itojun:458,itruediv:291,its:[0,3,5,6,7,8,9,10,14,22,23,24,25,26,28,30,31,35,38,39,41,43,45,47,50,54,55,56,57,58,60,64,65,69,74,75,78,79,80,81,82,84,85,86,90,91,93,94,95,96,97,98,99,103,104,105,106,107,108,109,110,111,112,113,114,115,117,118,122,123,124,125,128,129,131,132,135,136,138,139,140,141,144,145,149,151,153,154,156,157,159,161,164,167,168,170,171,172,176,177,178,179,182,184,185,187,189,190,193,195,196,197,198,199,200,203,204,206,208,209,210,211,212,214,215,219,222,225,227,228,230,232,236,237,241,243,244,246,248,249,251,252,254,256,257,261,264,266,267,268,271,275,276,279,280,284,291,292,293,295,296,298,299,301,303,304,306,307,309,310,311,313,315,316,317,320,321,322,324,325,329,330,332,333,334,335,336,337,339,340,342,343,346,347,349,350,354,355,356,359,361,363,365,366,368,369,370,372,373,375,376,380,381,382,384,385,386,387,391,392,395,396,397,398,399,400,402,404,407,408,409,410,412,413,414,416,417,418,419,421,422,423,424,425,426,428,430,431,432,433,435,436,437,438,439,441,442,443,444,445,446,447,448,449,451,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],itself:[0,1,11,30,38,41,45,56,57,58,61,62,65,66,70,74,77,78,79,81,82,84,91,93,95,98,99,103,104,106,110,111,117,118,122,124,129,135,140,145,152,153,157,161,164,177,178,179,182,184,192,193,196,198,204,206,212,214,216,222,227,228,231,244,246,248,249,251,252,254,258,260,261,267,268,271,282,283,284,288,292,293,297,298,300,301,310,316,321,332,333,336,339,343,346,347,348,350,355,356,359,360,362,363,366,370,373,377,380,381,382,385,386,391,392,394,396,397,411,412,413,416,420,424,425,426,428,430,431,432,436,445,450,451,455,456,458,459,460,461,462,463,464,465,466,467,468,471,472],itw:472,ium:445,ivan:[470,471,472],ixor:291,izbyshev:472,ized:472,izip:[113,460],izip_longest:462,ja_jp:184,jacek:[467,470,472],jachim:472,jack:[320,321,346,394,422,438,442,458,459,461,465,472],jackdaw:104,jackson:[168,468],jacob:462,jacqu:463,jai:[99,457,466,472],jail:104,jairo:472,jaiswal:472,jake:[320,463,465,472],jakub:[470,472],jam:292,jame:[87,232,420,422,456,459,461,463,471,472],jami:472,jan:[99,184,343,350,402,458,463,466,469,470,471,472],jane:[108,161],janech:472,janes_account:161,jansen:[394,422,458,459,469,472],janssen:462,januar:184,januari:[86,152,155,184,320,367,431,457],japan:[265,450],japanes:[109,159,265,460,471],jar:460,jason:[457,459,462,468,472],jauhiainen:467,java:[57,62,72,84,86,90,91,99,106,107,118,120,227,293,346,366,407,411,412,424,430,435,440,456,460,461,462,464,466],java_v:305,javascript:[62,168,241,245,261,301,442,472],jcaesar:447,jcea:[462,463,464],jdoe:66,jean:[236,422,462,463,467],jeanpierr:[469,472],jedi:225,jeff:[457,459,468,470,472],jeffrei:[106,321,343,462,463,466,472],jelk:86,jell:[470,471,472],jen:[458,472],jenkin:[225,385],jenvei:[463,466],jeopard:31,jeremi:[456,457,458,459,460,461,462,463,472],jeremiah:472,jeroen:[470,472],jerri:155,jess:[462,465,469,470,471,472],jessi:471,jessica:469,jetbrain:91,jevnik:[469,472],jewett:[99,460,462],jfif:250,jiajun:472,jim:[91,99,104,310,430,456,460,462,466,470,472],jira:462,jiryu:[469,470,472],jis:[159,460],jisx0213:[159,460],jit:470,jiwon:[460,467],jkl:161,jloup:422,joan:470,job:[65,90,95,97,103,106,109,122,152,160,167,202,208,225,232,284,293,301,347,350,372,392,428,435,438,456,462,466,472],joe:[110,153,235,342,380,392,469,472],joel:[109,470,472],joffrei:472,jog:466,johab:[159,460],johann:[469,472],johansson:[463,465],john:[66,108,110,161,176,189,342,370,410,436,437,438,457,460,461,462,463,467,470,472],johns_account:161,johnson:[109,461,462],joi:287,join:[58,62,65,74,83,85,86,91,99,104,107,122,125,136,153,156,159,161,176,187,189,190,201,203,204,209,227,243,244,245,258,267,269,270,280,284,293,294,298,304,318,321,322,323,328,333,337,340,344,346,347,363,365,366,368,378,381,391,396,407,408,410,418,437,445,448,456,460,461,462,466,467,468,469,470,471,472],join_lin:65,join_thread:[284,363,472],joinablequeu:[284,469,472],joinedstr:124,joiner:[159,469,472],joinpath:298,joint:422,joke:456,jon:472,jona:[468,471,472],jonathan:[467,469,472],jone:[93,459,461,468,469],jong:471,joona:458,joseph:[467,470,472],josephin:90,josh:[461,462,469,470,472],joshua:[469,472],josiah:[462,467],journal:189,jpeg:[201,250,370,442,462],jpg:[201,257,416,448,461],jpython:456,js_output:245,json:[62,103,104,168,253,267,268,285,300,309,441,447,463,465,466,467,468,472],jsondecod:[261,463,470,472],jsondecodeerror:[261,469,472],jsonencod:[104,261,470,472],jtc1:355,juan:[232,463],judg:111,judici:[90,182,462],juggl:141,juhana:467,juic:346,jukka:[109,469],jul:[99,225,458,466],juli:[99,189,422,431,458,459,463,472],julian:[367,468,469,472],julien:471,juliett:472,jump:[84,104,190,193,248,269,299,380,424,437,459,461,464,470,471,472],jump_absolut:190,jump_forward:[190,472],jump_if_false_or_pop:190,jump_if_true_or_pop:190,jumpahead:464,jun:[99,225,367,458],junction:472,june:[99,405,471],juni:431,junit:[385,457,472],junk:[95,189,284,288,350],jupit:212,jure:472,jussi:99,just:[0,1,6,9,26,31,35,42,51,57,58,60,62,65,66,69,72,74,75,77,78,79,81,82,83,84,85,86,90,91,92,93,94,95,96,97,98,99,102,103,104,105,106,107,108,109,110,111,122,124,131,140,141,152,153,157,158,159,160,161,168,170,177,178,180,182,184,187,189,193,195,201,202,212,214,219,225,227,228,232,235,236,244,248,251,252,260,265,266,267,268,271,282,284,289,292,293,298,299,301,310,315,316,320,321,322,329,331,332,339,340,342,343,346,347,350,354,355,356,361,363,365,366,370,372,373,377,380,382,385,386,387,392,396,399,404,406,407,412,417,418,419,420,422,423,424,426,428,430,432,435,436,437,438,439,440,442,445,446,448,451,454,455,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],justifi:[222,346,370,373,442,462],justin:[467,472],justo:151,jvm:462,jwzthread:[420,459],jyrki:468,jython:[72,84,90,93,124,212,305,363,404,430,445,451,457,460,462,466,468],kaarl:472,kaartic:472,kabrda:472,kabul:184,kabultz:184,kachayev:[468,469,472],kadidd:392,kahan:156,kai:472,kaiser:[461,472],kaliszewski:463,kall:[386,460,472],kamp:456,kang:468,kani:472,kanji:159,kannada:466,kappa:320,kaptur:472,karaok:446,karatsuba:[187,459],karl:468,karlsen:467,karthikeyan:472,kasia:472,kasun:467,kati:468,kato:472,katz:[419,420],kaushik:472,kazakh:[159,469],kazakov:[469,472],kbhit:[92,283],kde:[87,400],kdedir:400,kea:343,keccak:[236,470],kee:472,keebler:245,keep:[28,30,31,35,57,62,74,79,84,85,86,91,93,94,95,104,105,106,109,111,122,124,127,141,149,153,159,161,170,172,177,178,180,182,187,193,197,212,215,229,237,244,248,252,254,257,266,271,279,292,293,301,307,309,321,340,346,350,355,363,370,380,385,386,392,399,404,407,412,423,424,428,432,436,437,440,446,447,448,457,459,460,461,462,463,466,468,471,472],keep_blank_valu:[153,391],keep_posit:382,keepend:[58,159,189,201,346],keer:470,kei:[5,21,30,31,36,45,49,50,57,62,65,74,90,91,92,93,97,98,99,103,104,105,113,124,129,131,149,153,157,158,161,162,165,168,171,175,176,178,182,184,185,187,190,193,197,198,202,204,206,207,212,213,214,225,227,228,229,232,237,245,246,249,252,253,254,258,260,261,265,266,267,269,271,272,280,283,287,288,291,293,295,299,301,306,307,308,309,310,314,321,322,330,331,335,336,337,342,346,347,348,355,359,363,369,370,373,380,381,382,386,387,391,392,396,399,402,404,410,413,414,416,418,423,424,426,428,432,436,437,438,442,443,444,448,455,456,457,458,459,460,461,462,463,464,465,466,468,469,470,471,472,473],keith:458,kelli:[459,467,468],kelsei:456,kelvin:[106,321],ken:[109,370],kencrypt:236,kenneth:449,kennethreitz:449,kenni:[399,468],kent:[109,343,363,385,457,461,462],kept:[23,41,95,104,161,168,177,185,187,196,200,209,214,215,227,244,245,248,251,257,260,268,271,291,313,318,340,343,352,382,386,399,421,432,439,448,456,458,463,464,466,467,468,472],kerl:472,kern:268,kernel32:[177,472],kernel:[65,97,129,293,329,334,339,356,361,456,461,467,468,470,472],kevent:62,kevin:[459,460,462,463,466,472],key1:168,key2:168,key3:168,key_:178,key_a1:178,key_a3:178,key_all_access:402,key_b2:178,key_backspac:178,key_beg:178,key_break:178,key_btab:178,key_c1:178,key_c3:178,key_cancel:178,key_catab:178,key_clear:178,key_clos:178,key_command:178,key_copi:178,key_creat:178,key_create_link:402,key_create_sub_kei:402,key_ctab:178,key_datum:426,key_datum_list:426,key_dc:178,key_dl:178,key_down:178,key_eic:178,key_end:178,key_ent:178,key_enumerate_sub_kei:402,key_eo:178,key_eol:178,key_execut:402,key_exit:178,key_f0:178,key_f1:178,key_f2:178,key_f3:178,key_f4:178,key_fil:[243,392],key_find:178,key_fn:178,key_func:99,key_help:178,key_hom:[97,178],key_ic:178,key_id:301,key_il:178,key_left:[97,178],key_length:422,key_ll:178,key_mark:178,key_max:178,key_messag:178,key_min:178,key_mous:178,key_mov:178,key_next:178,key_notifi:402,key_npag:178,key_open:178,key_opt:178,key_ppag:[97,178],key_previ:178,key_print:178,key_query_valu:402,key_read:402,key_redo:178,key_refer:178,key_refresh:178,key_replac:178,key_res:178,key_reset:178,key_restart:178,key_resum:178,key_right:178,key_sav:178,key_sbeg:178,key_scancel:178,key_scommand:178,key_scopi:178,key_screat:178,key_sdc:178,key_sdl:178,key_select:178,key_send:178,key_seol:178,key_separ:261,key_set_valu:402,key_sexit:178,key_sf:178,key_sfind:178,key_shelp:178,key_shom:178,key_sic:178,key_sleft:178,key_smessag:178,key_smov:178,key_snext:178,key_sopt:178,key_sprevi:178,key_sprint:178,key_sr:178,key_sredo:178,key_sreplac:178,key_sreset:178,key_sright:178,key_srsum:178,key_ssav:178,key_ssuspend:178,key_stab:178,key_sundo:178,key_suspend:178,key_typ:378,key_undo:178,key_up:[97,178],key_val:460,key_without_valu:168,key_wow64_32kei:402,key_wow64_64kei:402,key_writ:402,keya:168,keyb:168,keybind:[97,178,248,322],keyboard:[87,92,97,178,248,350,370,373,380,385,437,462],keyboardinterrupt:[22,103,104,117,158,214,284,318,334,385,417,434,439,446,461,462,463,464,470,471,472],keyc:168,keycap:178,keycod:[283,370],keyencod:331,keyerror:[13,22,31,50,84,161,168,171,185,197,198,206,214,234,237,244,251,252,260,271,298,312,329,330,331,341,346,347,356,359,381,382,384,386,387,419,424,428,446,448,459,460,463,467,470,472],keyfil:[225,249,268,282,307,337,343,456,470,472],keyfunc:[227,260],keylist:[459,460],keynam:178,keyout:343,keypad:[97,178],keypath:282,keypress:[62,97,283,462],keyref:[399,461],keyreleas:380,keyset:472,keyspag:472,keystrok:[106,157,178,334,456,463],keysview:[162,382],keysym:370,keysym_num:370,keywd:79,keywdarg:79,keywdarg_method:79,keywdarg_parrot:79,keywdargmodul:79,keyword:[5,18,53,57,60,62,65,72,74,77,80,81,82,84,90,93,94,95,99,103,104,108,117,118,122,124,129,131,142,153,159,161,168,171,176,177,178,184,189,190,193,197,202,206,207,208,209,210,214,219,222,227,228,237,241,244,246,248,253,254,257,260,261,263,265,266,267,271,279,284,288,291,292,293,297,299,301,306,309,315,320,321,325,327,332,333,336,337,339,342,346,347,350,355,357,359,361,363,365,366,370,373,380,381,382,385,386,387,392,396,400,404,408,410,417,421,423,424,426,427,429,438,439,441,442,445,448,456,458,459,460,461,462,463,464,465,466,467,468,471,472],keyword_item:426,keyword_onli:254,keywords_argu:426,kfm:400,kfmclient:400,kfreebsd:472,kharosthi:346,khatri:[471,472],kholia:468,khurana:[469,471,472],khy6h21km:236,kib:[38,117,137,265,269,293,366,378,472],kid:[91,380],kiendl:461,kilburn:472,kill:[54,90,107,117,132,135,138,142,167,178,248,284,293,334,350,399,404,462,463,464,466,471,472],kill_python:363,killchar:178,killpg:[293,459],kilogram:212,kim:472,kimbrel:472,kind:[1,15,31,57,58,79,82,84,85,93,95,102,104,105,107,109,111,122,135,153,177,184,193,214,227,251,252,254,256,257,282,284,289,293,298,301,303,321,329,342,343,346,348,355,366,370,382,385,392,397,406,410,411,412,422,423,424,426,428,436,437,439,440,455,458,459,464,466,467,468,469,470,471,472],kindahl:463,kindli:[460,462],king:[320,321,456],kintscher:472,kite:380,kiwi:438,klass:[98,266],kleckner:466,klein:342,klem:392,klist:331,klose:[463,467,470],kloth:472,kluyver:[468,469,470,472],kmac:236,knew:[110,289,464],knight:[99,109,309,422,438,442,458,459],know:[1,28,30,31,57,58,61,65,68,74,79,81,82,83,84,86,91,92,93,94,95,99,102,103,104,105,106,107,109,110,111,119,122,134,141,153,156,176,177,179,182,189,193,196,201,202,209,225,237,244,252,258,265,267,268,271,272,284,292,293,331,333,336,339,342,343,345,346,355,370,373,380,386,392,397,402,404,413,416,418,428,430,432,435,436,437,439,440,443,445,446,447,455,456,457,458,461,462,463,467,468,470,472],knowledg:[30,80,97,184,195,265,266,289,305,331,436,447,462],known:[5,9,22,30,31,55,57,62,72,74,81,86,87,91,92,94,99,101,106,107,110,111,122,136,153,156,159,168,170,177,184,190,197,198,210,212,236,237,243,248,252,265,267,275,276,291,293,297,301,329,339,342,343,345,346,350,351,355,367,370,372,373,375,380,384,386,387,397,406,407,412,413,419,421,422,424,426,430,432,436,437,439,444,446,452,459,461,463,464,465,466,468,470,471,472],known_host:333,known_path:335,knownfil:276,knuth:[161,187],koch:380,koep:472,koi8_r:159,koi8_t:[159,469,472],koi8_u:159,kok:[468,469,472],kolam:380,komodo:91,komodoid:91,konieczni:467,konqueror:[400,461],koo:470,korai:460,korean:[159,460,471,472],koren:472,korenberg:[469,470],korn:443,korpela:109,kosata:463,koshiba:472,kq_ev_add:329,kq_ev_clear:329,kq_ev_delet:329,kq_ev_dis:329,kq_ev_en:329,kq_ev_eof:329,kq_ev_error:329,kq_ev_flag1:329,kq_ev_oneshot:329,kq_ev_sysflag:329,kq_filter_aio:329,kq_filter_netdev:329,kq_filter_proc:329,kq_filter_read:329,kq_filter_sign:329,kq_filter_tim:329,kq_filter_vnod:329,kq_filter_writ:329,kq_note_attrib:329,kq_note_child:329,kq_note_delet:329,kq_note_exec:329,kq_note_exit:329,kq_note_extend:329,kq_note_fork:329,kq_note_link:329,kq_note_linkdown:329,kq_note_linkinv:329,kq_note_linkup:329,kq_note_lowat:329,kq_note_pctrlmask:329,kq_note_pdatamask:329,kq_note_renam:329,kq_note_revok:329,kq_note_track:329,kq_note_trackerr:329,kq_note_writ:329,kqueue:[62,330,462,469,472],kqueue_ev:472,kqueueselector:[133,330,472],krah:[422,463,467,470,472],krahl:470,krasnikov:472,krebber:[471,472],krekel:461,krell:99,kreutz:462,krier:[469,472],kristol:244,krugler:109,ks_c:159,ks_x:159,ksc5601:159,ksx1001:159,kt_co:382,kuba:463,kuchl:[97,99,106,109,178,456,457,458,459,460,461,462,463,468],kuhn:467,kulakov:[471,472],kuma:472,kumaran:[463,466,468,469],kumaripaba:472,kung:347,kunstlev:461,kuratomi:468,kurenkov:472,kurt:461,kushal:[469,470,472],kuska:472,kva:343,kw_default:124,kw_only1:93,kw_only2:93,kwarg1:[99,461],kwarg2:[99,461],kwarg:[45,53,91,93,95,103,104,113,117,122,124,129,142,159,161,167,168,171,227,254,261,266,267,284,291,292,293,301,310,327,336,346,347,359,363,365,366,381,385,386,387,396,399,424,437,462,467,469,470,472],kwcount:60,kwd:[56,57,81,82,138,145,161,170,176,204,228,254,260,284,299,347,376,381,385,424,461,472],kwdef:60,kwdict:79,kwlist:[79,82,189,262],kwonlyarg:[124,254],kwonlyargcount:[12,472],kwonlydefault:254,kws:[60,227,355],kyle:463,kz1048:[159,469,472],kz_1048:159,l10:159,l10n:[232,456],l6988:466,l6hk:467,l_outer:284,laan:462,lab:[422,436,456,458,459],laban:[463,465],label:[38,62,84,86,87,93,99,159,190,222,248,271,282,292,320,332,343,347,369,370,372,424,445,455,458,459,466,468,471,472],labeledscal:472,labelentri:372,labelfram:[372,373],laboratori:422,lacinia:151,lack:[41,42,84,86,91,102,161,176,214,217,222,252,284,293,294,318,337,343,425,426,436,455,456,457,462,464,467,468,469,471,472],lacu:151,lag:[87,310],lagerwal:467,lahei:460,lai:[74,216,442],laid:[64,65,93,112],laird:90,lakhara:472,lalo:459,lamb:[339,437],lambach:462,lambd:320,lambda:[62,93,98,108,124,129,135,145,149,161,168,182,189,228,254,260,284,301,320,342,346,365,368,381,385,386,387,396,417,423,424,427,429,431,438,441,456,457,458,460,461,462,464,468,469,472],lambda_expr:426,lambda_expr_nocond:426,lambdatyp:381,lambdef:427,lambdef_nocond:427,lambert:[459,468],lameiro:99,lanc:[394,422],lancelot:[410,438],land:[178,289,472],landau:469,lander:[468,471],landmark:[455,470],landri:472,landscap:[380,462],landschoff:[466,467,472],lang1:232,lang2:232,lang3:232,lang:[86,90,91,103,109,232,265,392,450,457,458,459,461,464],langa:[101,288,466,468,469,470,471,472],langinfo:472,langner:470,languag:[0,1,15,31,62,65,72,74,75,78,79,80,87,89,90,93,94,96,99,101,105,106,108,109,110,111,114,124,159,161,168,177,181,197,203,206,210,218,224,227,241,247,248,252,253,256,265,273,282,297,301,309,321,342,346,353,355,364,365,374,381,385,399,407,408,416,422,424,426,430,431,432,433,435,436,437,438,440,441,442,444,445,446,450,454,455,457,458,464,472,473],language1:232,language_map:65,language_ord:65,lannert:[456,459],lantern:178,laoreet:151,lapeyr:472,laptop:459,lar:[456,459,460,461,462,463,466,467],larch:168,larg:[5,7,17,31,50,53,54,57,62,64,65,66,78,84,86,90,93,97,99,102,104,105,106,107,109,110,124,138,141,167,177,178,184,185,187,189,193,213,214,224,227,233,249,257,258,261,275,284,288,292,293,295,298,301,320,334,345,346,347,348,350,359,370,385,388,399,406,407,408,410,419,435,436,437,442,445,447,448,455,456,457,458,459,460,461,462,463,464,466,467,468,469,472],largefil:[363,472],larger:[31,38,51,62,72,82,91,97,98,108,119,135,141,156,177,178,184,187,216,236,237,257,258,275,279,308,320,321,324,342,345,346,355,363,366,368,419,421,424,426,431,435,437,438,439,440,447,450,455,456,458,459,461,463,464,466,469,470,471,472],largest:[99,168,184,187,223,225,227,237,275,320,324,346,355,421,456,457,458,459,460,461,462,467,472],largezipfil:419,larri:[95,345,463,465,467,468],larson:472,last:[9,21,22,30,31,54,57,65,66,69,79,82,84,90,91,93,94,95,97,99,102,103,104,106,107,109,118,122,123,128,136,141,142,145,147,152,153,157,159,161,168,170,177,178,184,185,187,189,190,193,197,201,204,206,210,212,214,215,216,219,222,223,225,229,235,236,237,246,248,249,251,254,258,260,261,265,266,268,269,271,284,288,291,292,293,294,298,299,301,303,310,316,321,322,325,329,331,332,333,338,339,341,342,343,344,346,347,350,359,361,366,367,370,373,375,377,378,380,384,385,386,387,391,392,393,395,399,402,403,407,410,412,419,421,423,424,426,427,428,431,432,436,437,438,439,442,445,446,448,451,455,456,458,459,460,461,462,463,464,466,467,468,469,470,471,472],last_accept:284,last_dai:309,last_login:462,last_month:309,last_nam:[168,176,321],last_nod:236,last_traceback:[22,299,355,377,424],last_typ:[22,355,377,464],last_valu:[22,212,355,377],last_week:309,lastaccess:462,lastchild:407,lastcmd:157,lasterror:[177,462],lastgroup:321,lasti:190,lastindex:321,lastli:[426,432],lastnam:[228,342,466],lastresort:[103,266,466],lastrowid:[342,470,472],lastupdatedordereddict:161,late:[65,97,105,189,456,472],latenc:[257,293,463,470],latent:471,later:[22,30,31,41,58,65,74,75,78,79,81,82,85,86,90,95,96,97,99,103,104,106,107,108,110,111,122,128,129,139,140,142,143,151,153,154,157,159,168,170,177,178,184,190,193,197,203,206,232,236,244,248,252,254,257,260,264,265,269,280,284,292,301,305,321,324,327,329,332,334,339,342,343,346,351,355,361,363,367,377,385,386,387,392,396,397,398,399,418,421,423,424,426,428,432,435,436,437,438,445,446,451,455,456,457,458,459,462,463,464,466,468,469,471,472],latest:[62,86,112,153,184,211,248,449,452,453,455,463,465,466,467,468,470,472],latex:[106,370,462],latin10:159,latin1:[137,159,301,316,461,467,470,472],latin2:159,latin3:159,latin4:159,latin5:159,latin6:159,latin7:159,latin8:159,latin9:159,latin:[15,62,106,109,137,159,196,240,321,332,359,384,426,458,459,462,465,466,469,470,471,472],latin_1:[159,196],latitud:347,latter:[5,7,22,38,57,66,79,93,105,106,107,110,122,135,139,145,168,172,184,185,197,202,206,210,216,227,237,248,252,254,257,258,266,267,276,292,293,298,310,333,346,349,370,372,373,380,382,385,395,397,398,423,424,425,426,428,432,433,436,438,447,455,459,464,466,467,468,471,472],lauder:[458,459],laugh:[406,467],launch:[62,65,93,165,166,187,231,253,284,293,350,355,363,395,400,444,453,455,456,466,467,468,472],launcher:[62,112,396,418,444,452,463,468,470,471,472,473],launcheronli:455,launchpad:462,laura:472,laurent:472,lavi:472,law:[143,236,338,351,367,422,461,472],lawrenc:472,lawrenz:472,lawson:460,lax:[461,472],layer:[8,9,14,21,23,24,29,34,35,51,55,56,62,81,90,104,107,307,337,339,343,369,416,451,455,456,459,462,472],layout:[57,62,69,74,82,103,111,159,266,343,349,369,370,395,424,428,441,442,455,462,467,468,472],layoutspec:373,layzel:472,lazar:472,lazi:[84,99,111,252,343,346,355,360,402,461,469,471,472],lazier:284,lazili:[167,217,244,260,385,386,426,468,472],lazy_load:252,lazycach:[264,469],lazyload:[252,469,470,472],lbrace:374,lbyl:93,lc_:265,lc_all:[178,232,265,363,448,451,471,472],lc_collat:265,lc_ctype:[54,109,265,346,451,470,471,472],lc_letter:430,lc_messag:[232,265],lc_monetari:[265,472],lc_numer:[265,346,469,470,471,472],lc_time:265,lc_type:[469,472],lcd:466,lchflag:[293,462],lchmod:[293,298,462,472],lchown:[293,459],lcov:468,lcy1134:343,lcy:343,ld_library_path:[177,470,472],ld_so_aix:472,ldconfig:177,ldcxxshare:463,ldexp:[275,472],ldflag:[78,459,472],ldgettext:232,ldir:65,ldj:249,ldl:78,ldngettext:232,ldversion:472,leach:410,lead:[7,17,35,58,65,79,81,84,91,92,102,103,105,106,118,140,149,152,153,157,168,184,187,189,193,197,200,206,209,212,223,227,230,233,244,246,248,251,252,254,257,258,266,268,271,275,276,293,294,298,299,301,310,316,320,339,343,345,346,347,349,355,357,360,363,365,367,368,377,385,386,391,392,397,407,419,423,424,425,426,428,431,432,433,436,437,442,446,451,455,456,459,460,461,462,464,467,468,470,471,472],leader:332,leaf:[236,293,297,374],leaf_siz:[236,472],leak:[7,30,34,79,227,229,284,293,350,355,378,426,456,457,463,464,466,468,469,472],leakag:472,leander:463,leandro:99,leap:[93,103,106,152,184,367],leapdai:152,learn:[1,62,77,79,81,83,84,85,86,89,90,94,95,97,98,99,106,109,153,177,187,193,248,256,275,301,332,342,380,408,435,436,438,439,441,450,458,459,461,462,463,466,470,471,472],least:[5,31,37,45,57,60,65,69,72,78,79,82,84,87,90,91,95,102,104,105,106,107,109,111,112,114,117,122,141,144,145,151,155,156,159,161,177,178,184,187,189,193,195,201,204,209,211,216,222,223,227,228,235,236,243,249,257,266,268,269,275,292,293,308,310,311,320,328,329,333,334,337,339,343,345,346,347,349,355,360,363,366,367,368,375,376,378,382,385,386,392,395,403,406,419,421,424,426,430,432,435,436,437,438,439,444,455,459,462,463,464,467,470,471,472],leav:[5,22,28,31,55,58,60,64,65,79,81,82,84,86,95,96,97,99,104,109,122,129,142,161,168,170,178,185,187,190,193,197,206,214,227,236,237,244,248,251,252,268,271,284,292,293,319,320,332,342,343,363,366,370,380,385,402,418,423,428,430,432,436,438,439,440,448,449,456,458,459,460,461,463,467,470,472],leaveok:[97,178],led:[168,457,467,468,470],lee:[110,460,461,463,466,471,472],leffler:339,left:[5,14,30,43,57,58,65,78,79,93,95,97,99,104,106,107,109,111,124,129,137,143,149,151,156,157,158,161,168,177,178,182,184,187,189,190,193,197,213,217,222,227,228,230,236,248,252,257,266,267,268,271,282,284,291,292,293,294,295,299,316,321,326,332,339,343,346,347,350,365,366,370,372,373,380,384,385,387,392,397,408,422,423,424,426,428,431,432,436,437,438,439,442,443,444,445,448,455,456,457,458,459,460,462,463,464,465,466,469,471,472],left_list:217,left_onli:217,left_volum:295,leftarrow:248,leftmost:[106,149,161,189,193,228,236,321,343,426,460,471],leftov:[190,292],leftright:380,leftshift:374,leftshiftequ:374,legaci:[58,62,72,77,83,118,140,144,164,165,192,195,196,197,199,203,206,207,210,218,225,249,252,254,255,269,288,307,337,343,355,363,385,428,431,451,453,463,466,467,468,470,472],legacy_funct:[385,466],legacy_pars:382,legal:[10,83,95,97,109,222,227,248,251,257,297,299,363,367,370,373,382,417,426,431,437,438,448,457,458,459,461,462,463,472],legal_char:321,legalchar:469,legend:38,legibl:91,legitim:436,lehmann:460,lehtinen:467,lehtosalo:469,leif:462,leitch:472,lekhonkhob:94,lekma:463,lele:[471,472],lemburg:[109,232,342,456,457,458,459,461],len:[7,8,9,21,34,36,37,45,49,50,55,58,62,82,91,93,104,106,107,109,141,143,149,151,153,161,162,167,171,177,189,190,193,212,216,227,228,232,236,237,243,248,260,268,279,284,288,291,292,293,307,320,322,337,339,342,343,346,349,363,378,381,382,386,397,404,405,407,410,424,431,436,437,438,439,445,446,447,456,459,460,461,462,463,464,466,467,468,469,472],lend:[102,458],lenfunc:57,length:[3,5,7,8,9,21,22,23,31,34,35,44,45,49,50,51,53,54,55,57,58,62,79,81,84,91,93,95,97,99,101,104,107,109,110,119,122,123,125,143,144,147,152,155,159,161,175,177,178,185,187,189,190,196,197,202,203,206,208,209,212,216,227,238,243,246,249,257,258,260,261,267,268,269,271,275,279,284,291,292,293,297,310,316,320,321,322,328,329,333,337,339,343,346,347,349,359,362,365,366,367,373,382,385,386,390,392,397,402,404,405,407,412,416,420,421,423,424,426,431,432,437,438,444,445,448,455,456,458,459,460,461,462,463,464,466,467,468,469,470,471,472],length_hint:[45,291,424,468],length_in_bit:236,length_requir:242,lengthi:[97,99,106,260,302,456,457,458,459,460,466,472],lengthier:[456,457],lenient:239,lennart:[463,472],lenton:462,leo:[92,151],leon:[469,472],lesher:[463,472],lesli:[469,472],less:[1,23,31,35,51,54,57,58,62,65,79,82,84,86,91,93,95,106,108,109,111,114,123,135,136,139,140,149,151,153,155,159,161,178,184,187,188,190,193,197,216,227,228,230,235,236,237,245,248,257,258,266,269,275,279,284,293,299,301,302,309,310,318,321,339,345,346,347,350,355,363,366,367,370,372,373,374,377,385,390,392,397,407,423,424,426,432,436,437,438,442,445,457,458,459,460,461,462,465,466,468,469,470,472],less_than_10:99,lessequ:374,lesser:438,let:[22,60,62,65,66,68,69,74,75,78,79,82,84,85,86,90,91,92,94,95,97,99,103,104,105,106,107,108,109,110,111,122,129,140,141,157,161,168,170,172,177,189,201,212,225,228,232,237,243,249,251,256,261,265,266,267,268,292,299,300,307,309,321,331,332,337,343,370,373,382,386,387,392,410,418,422,428,434,436,437,442,445,455,456,458,459,460,461,462,463,465,466,468,471,472],letter:[65,69,90,92,97,106,109,144,149,159,161,178,179,187,189,193,230,265,266,292,294,298,299,303,312,321,343,346,347,365,373,384,385,391,392,419,426,431,437,438,445,448,456,458,460,461,462,463,464,467,469,470,471,472],lev:472,level:[7,12,15,21,22,23,28,29,31,38,39,54,57,62,65,72,79,80,81,84,85,86,90,92,93,94,96,99,101,104,105,107,108,109,110,111,120,122,123,124,126,128,129,131,135,137,138,140,141,142,147,151,152,154,156,159,161,164,165,167,168,170,171,178,181,184,189,190,193,195,203,205,208,211,212,213,214,220,222,225,227,228,229,232,233,235,237,242,243,244,246,248,249,251,252,253,254,255,259,260,267,268,269,271,280,282,283,284,285,288,293,294,295,296,298,299,301,302,304,305,306,307,309,310,313,314,315,316,317,318,321,323,324,326,328,331,332,334,335,337,342,343,349,355,357,359,360,361,363,365,366,370,372,373,379,381,385,386,392,396,397,399,400,404,406,407,408,410,412,416,419,421,423,424,425,426,428,429,431,432,435,436,437,441,446,447,448,451,455,456,457,458,459,460,461,462,463,464,466,467,468,470,471,472,473],levelnam:[103,104,266,267,268,284,460,463,466],levelno:266,leverag:[252,284,468],levinson:462,levitt:468,levkivskyi:[470,471,472],lexer:332,lexic:[62,224,241,253,254,298,358,375,412,424,426,429,430,471,472],lexicalhandl:[412,460],lexicograph:[108,260,346,426,438,461],lexist:[294,460],lfactor:143,lflag:362,lfs_cflag:308,lgamma:[275,463,466],lgettext:[232,472],lgpl:87,lhash:422,liabil:[153,422],liabl:[284,399,422],lib2to3:[62,93,188,472],lib64:[298,472],lib:[31,65,66,68,74,77,78,83,85,90,92,94,95,99,101,111,113,114,116,118,119,122,124,125,141,144,145,148,149,151,152,153,154,155,157,158,159,160,161,162,163,164,167,168,170,172,173,174,176,177,182,184,185,187,189,190,193,194,195,196,198,199,200,202,203,204,205,206,207,208,209,210,212,213,215,217,219,221,223,225,228,230,231,232,233,235,236,237,238,239,240,241,242,243,244,245,246,248,249,250,251,252,254,257,258,261,262,264,265,266,267,268,269,270,271,272,276,280,282,284,286,288,289,291,292,293,294,298,299,301,302,303,304,305,306,307,309,310,311,313,314,315,318,319,320,321,323,325,326,327,328,330,331,332,333,335,336,337,338,339,340,342,343,344,345,346,347,348,349,350,351,353,354,355,356,358,359,360,361,365,366,368,370,371,372,373,374,375,376,377,378,379,380,381,382,385,386,389,390,391,392,393,394,395,396,397,398,399,400,405,406,407,408,409,410,411,412,413,414,416,417,418,419,420,426,434,446,448,449,451,454,455,456,457,458,459,461,462,463,466,467,468,469,470,472],lib_pypi:94,lib_typ:65,libbz2:177,libc:[177,305,461,472],libc_ver:[305,472],libcrypt:472,libdest:466,libdir:356,libdl:472,libedit:322,liber:[147,193,370],liberror:65,libexpat:[406,472],libffi:[62,463,471,472],libfoo:65,liblibnam:65,liblzma:269,libm:[111,177,472],libmpdec:[62,187,467],libnam:65,libnsl:472,libpl:472,libpuzzl:225,libpython25:111,libpython2:459,libpython3:101,libpython:101,librai:472,librari:[0,7,17,22,23,30,31,38,41,54,57,60,62,64,66,68,71,72,75,77,78,79,80,82,83,84,85,86,87,88,91,93,94,95,97,99,100,101,104,105,106,107,108,109,110,111,112,120,122,126,129,135,136,140,141,146,167,168,170,178,179,184,185,186,187,188,191,193,195,204,209,213,220,230,232,236,244,248,251,255,256,257,261,263,265,266,268,275,284,287,292,293,294,296,298,301,305,310,315,316,321,322,329,331,332,334,335,339,342,343,346,347,350,355,356,363,366,367,369,370,372,375,382,385,387,388,396,397,404,406,407,419,421,422,424,426,428,429,430,431,432,435,438,441,442,443,444,446,449,450,451,453,455,456,457,458,459,460,461,463,465,466,467,468,469,470,471,473],libraries_assembly_name_prefix:463,library_dir:[65,74,77,168],library_dir_opt:65,library_filenam:65,library_opt:65,libraryload:177,libressl:[62,471,472],librt:472,libssl:471,libtclsam:87,libtirpc:472,libtksam:87,libwww:[244,460],libxcrypt:472,libz:472,licenc:[74,87,422],licens:[62,63,65,66,74,86,87,92,111,112,169,248,271,296,309,355,444,446,449,458],license:422,licht:472,lie:[19,284,373,432,458,459],liechtenstein:410,lies:[156,184,243,346,424],lieu:[279,422],life:[62,66,93,95,168,301,359,369,407,419,437,456,462],lifecycl:[132,399,463,468],lifespan:254,lifetim:[5,31,38,44,79,91,93,159,227,293,402,436,457,467,470,471],lifo:[62,127,161,318,346,385],lifoqueu:[127,136,318,462,472],lift:[110,190,423,470],ligatur:159,light:[117,163,177,178,462,463,465,472],lighter:385,lightweight:[90,161,217,261,342,377,396,406,455,456,461,462,469,470],ligocki:462,like:[0,1,3,5,6,7,11,15,17,22,26,28,30,31,32,38,39,41,42,45,50,51,53,55,57,58,60,62,64,65,66,69,70,74,75,77,79,80,81,82,83,84,85,90,91,92,93,94,95,96,97,98,99,101,102,103,104,105,106,107,109,110,111,113,119,122,123,124,125,127,129,130,131,132,135,137,139,140,143,144,145,147,148,151,152,153,154,155,157,159,160,161,162,164,168,169,170,172,173,176,177,178,182,184,185,187,189,190,193,197,200,201,202,203,204,205,206,208,209,210,212,214,215,216,219,225,227,228,230,231,232,233,234,235,236,237,238,243,244,245,246,248,249,250,252,253,254,256,257,260,261,265,266,267,268,269,271,272,274,275,279,284,292,293,294,295,296,297,298,299,301,302,303,305,306,308,310,311,312,313,315,316,318,319,320,321,326,329,331,332,333,334,337,339,340,341,342,343,344,345,346,347,349,350,351,354,355,356,358,359,360,361,362,363,366,367,370,372,373,377,380,381,385,386,387,390,391,392,394,397,398,399,402,403,404,405,406,407,408,409,410,411,412,413,414,418,419,423,424,426,428,430,431,432,434,435,436,437,438,439,440,442,444,445,446,447,448,450,451,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],likelihood:236,likewis:[31,50,93,98,113,122,187,189,209,210,271,340,380,412,423,430,431,436,437,466,467],lima:472,limburg:437,limit:[7,22,31,52,53,54,56,57,58,62,72,81,91,95,97,99,101,104,106,113,124,129,130,133,135,137,138,140,151,159,161,164,167,170,174,176,185,186,187,190,202,208,209,215,216,223,225,227,228,232,236,248,249,260,267,269,276,283,284,285,286,292,293,294,295,301,309,314,316,318,321,323,326,331,334,336,339,342,343,346,347,350,355,359,363,366,372,377,378,386,388,402,404,407,410,418,421,422,424,425,426,428,430,431,436,438,441,449,451,452,456,457,458,459,460,461,462,464,465,466,467,468,469,470,471,472],limit_denomin:223,limitoverrunerror:[130,137,472],lin2adpcm:[143,472],lin2alaw:143,lin2lin:143,lin2ulaw:143,lin:472,lindblad:462,lindenmay:380,line:[12,22,23,30,31,48,58,60,62,64,65,66,68,69,70,72,74,75,77,78,79,82,84,85,86,90,91,92,93,94,95,97,99,101,103,104,105,106,109,110,111,112,113,114,118,120,121,124,125,128,129,137,138,144,145,147,148,151,152,153,154,156,158,159,160,161,168,169,170,171,176,177,178,179,184,186,187,188,190,191,192,193,196,197,200,201,202,203,205,206,208,209,212,214,215,220,222,224,225,227,232,235,241,243,246,249,252,253,257,258,260,263,266,267,268,269,271,272,279,282,283,284,285,286,288,297,298,299,301,303,304,307,309,310,313,314,315,316,317,319,320,321,326,332,333,335,336,337,342,343,346,347,350,352,354,355,360,364,365,369,370,372,374,377,378,380,384,386,387,393,396,397,400,404,408,410,413,417,422,423,424,425,426,428,429,430,432,433,434,436,437,438,439,441,442,443,444,445,446,448,449,450,452,453,454,456,457,458,459,461,462,464,465,468,469,470,471,472,473],line_buff:257,line_info:[297,472],line_list:99,line_num:[176,321,461],line_prefix:95,line_start:321,line_suffix:95,linear:[91,143,162,189,237,346,351,380,436,450,459,468,472],linear_prob:468,linearli:[143,329],linebreak:58,linecach:[62,220,253,378,472],linecount:153,linefe:[147,209,332,347,431,459],linejunk:189,linend:176,lineno:[22,101,124,145,168,190,193,214,219,254,261,264,266,286,299,301,310,314,316,321,332,363,377,378,385,397,469,470,472],linesep:[202,203,204,209,227,257,293,337,350,467,472],lineterm:189,linetermin:176,linetoolong:243,lingard:463,lingl:462,link:[1,31,52,57,60,62,64,65,74,77,79,80,83,84,85,86,87,90,91,92,93,104,107,111,112,120,161,162,179,184,213,241,244,258,260,265,266,293,294,296,298,305,329,333,343,344,358,359,363,370,372,373,396,399,400,402,404,410,411,424,428,435,450,454,456,459,460,462,463,466,467,468,469,471,472],link_execut:[65,418],link_shared_lib:65,link_shared_object:65,linkag:[62,65,80,92,305],linkcc:85,linkcheck:472,linkedlist:382,linker:[65,74,78,83,92,177,472],linker_ex:65,linker_so:65,linkerror:65,linkforshar:[78,472],linknam:359,linkto:333,linspac:346,lint:[105,404],linter:91,linux2:[111,355,467],linux3:[355,467],linux:[30,62,64,65,66,72,77,86,87,89,90,97,100,101,111,120,177,178,213,215,232,248,257,268,295,305,308,311,324,328,329,333,339,344,355,356,359,361,363,367,370,392,444,452,455,456,457,459,460,461,462,466,467,468,469,470,471,472],linux_distribut:[305,469,472],linuxaudiodev:[295,456,459,462],linuxfr:343,linuxjourn:461,lion:161,lisa:[470,472],lisandro:465,lisp:[84,91,99,458],lisp_list:91,list1:91,list2:91,list:[0,1,2,5,7,13,15,16,17,21,22,24,28,30,31,36,38,40,45,47,49,50,53,54,55,57,58,60,62,64,65,66,67,68,69,70,71,72,75,77,79,81,82,83,85,87,90,92,93,94,95,97,98,101,103,105,106,107,108,109,110,111,112,113,117,118,119,122,123,124,127,128,129,131,132,135,137,140,141,142,145,152,153,157,159,161,162,164,168,170,171,172,174,176,177,178,181,182,183,184,185,187,188,189,190,193,197,198,200,201,203,204,206,207,208,209,210,212,213,214,217,219,220,221,222,224,225,227,228,229,230,232,233,234,236,237,239,241,242,243,244,245,246,247,248,249,250,251,252,253,254,256,257,258,259,260,261,265,266,267,268,271,272,274,276,280,281,282,283,284,286,287,288,291,292,293,294,295,296,297,298,299,300,301,304,305,306,307,309,310,311,312,313,314,316,318,320,321,323,324,326,327,328,329,330,331,332,333,334,335,336,337,339,341,342,343,347,348,350,354,355,356,359,360,361,362,363,364,365,366,367,368,370,372,373,375,376,377,378,380,382,383,385,386,387,391,392,397,399,400,402,404,405,407,408,410,411,412,413,416,417,418,419,420,422,423,424,425,427,428,429,431,432,436,439,441,442,444,446,447,449,450,451,453,454,455,457,458,459,460,461,463,465,466,467,468,469,470,471,472,473],list_all_object:[99,460],list_append:[190,460],list_attribut:[457,458],list_dialect:176,list_directori:246,list_displai:426,list_fold:271,list_id:271,list_nam:271,list_new:472,list_of_data:135,list_of_item:301,list_of_pair:161,list_opt:299,listbasedset:162,listbox:[62,369,373,472],listcomp:[99,124,438],listdir:[74,84,109,201,214,221,232,246,293,333,344,396,459,460,463,464,467,471,472],listen:[62,90,104,107,129,141,165,246,267,268,288,315,330,337,339,340,343,380,404,416,459,462,463,468,469,472],listener_configur:104,listener_process:104,listfunc:376,listiter:381,listmethod:[416,417],listnotebook:372,listobject:456,listoflist:260,listproxi:284,listwrapp:84,listxattr:[293,467],lita:[470,472],liter:[9,35,58,60,62,84,91,93,95,105,106,113,114,122,124,158,159,160,169,184,187,190,193,212,221,227,232,233,249,256,261,266,267,269,309,321,332,342,346,347,350,367,368,370,373,375,382,385,391,400,410,412,423,424,428,429,430,437,441,444,445,456,458,459,461,463,464,466,468,471,472,473],literal_char:431,literal_ev:[124,227,462,466,471,472],literal_text:347,littl:[28,58,62,71,72,84,92,95,99,103,104,106,107,109,111,143,147,155,159,177,178,179,187,189,193,232,244,267,284,292,295,309,321,334,339,346,349,355,368,370,378,383,387,395,402,422,436,437,439,440,448,456,457,458,462,466,467,468,472],little2:422,littleendianstructur:[177,472],littleendianunion:177,liu:472,live:[31,57,61,62,64,65,69,74,79,84,90,95,104,111,112,153,169,208,225,229,248,249,251,252,253,284,289,293,301,307,317,343,399,407,424,436,444,455,456,457,458,464,466,472],ljust:[339,346,442,460,467],lk_:283,lk_lock:283,lk_nblck:283,lk_nbrlck:283,lk_rlck:283,lk_unlck:283,llc:461,lld:[58,463],llength:459,llh0l:349,lli:58,llib:65,lll:[461,472],lloyd:430,lls:79,llu:[58,463],llvm:[470,472],llx:380,lly:380,lmtp:[337,462,467],lmtp_port:337,lname:231,lngettext:232,lnktype:359,lno:266,lnotab:12,lnotab_not:[190,355,470],load:[10,13,28,30,31,37,41,52,53,54,62,65,69,74,78,79,80,83,85,90,91,92,93,95,101,103,104,107,110,120,124,153,157,167,168,185,188,190,193,212,214,225,227,244,245,248,251,252,260,261,266,267,274,276,280,293,299,301,304,306,309,310,313,316,322,331,342,343,346,355,363,367,378,380,381,402,407,410,411,416,417,418,420,421,423,424,429,432,442,446,448,451,455,456,458,459,461,462,463,464,465,466,467,468,469,470,471,472],load_attr:190,load_build_class:190,load_cert_chain:[225,243,249,307,337,343,392,467],load_classderef:[190,468],load_closur:190,load_const:[190,466,468],load_default_cert:[343,468,472],load_deref:190,load_dh_param:[343,467],load_dynam:472,load_express:297,load_extens:[342,463,466],load_fast:[190,468],load_glob:190,load_grammar:472,load_method:[190,471,472],load_modul:[93,251,252,420,428,459,468,470,472],load_nam:[190,466],load_packag:472,load_package_test:[363,472],load_suit:297,load_test:[62,188,193,363,469,472],load_url:167,load_verify_loc:[343,392,468],load_widget:[170,466],loadabl:[30,57,72,251,252,309,342,455],loadavg:459,loader:[28,62,93,170,177,193,251,252,304,363,378,381,385,418,459,465,466,467,468,469,470,471,472],loader_detail:252,loader_st:252,loaderror:244,loadkei:402,loadlibrari:177,loadlibraryex:92,loadtestsfrom:385,loadtestsfrommodul:[363,385,469,472],loadtestsfromnam:[385,463],loadtestsfromtestcas:385,loadtk:370,loan:260,lobbi:70,loc:[85,265],loc_len:466,loc_start:466,local0:268,local1:268,local2:268,local3:268,local4:268,local5:268,local6:268,local7:268,local:[5,11,15,17,28,29,31,45,48,54,60,62,64,65,74,77,79,84,85,90,93,95,96,97,99,103,104,106,108,109,111,112,129,141,142,145,152,153,154,158,161,165,168,171,176,177,178,184,187,189,190,191,193,201,210,214,227,228,243,246,247,248,249,251,252,253,254,257,258,260,266,268,272,279,284,288,293,294,298,299,301,310,315,316,321,322,333,335,336,337,339,343,346,347,350,354,355,356,363,367,376,377,382,385,387,392,395,402,406,410,411,412,413,416,423,424,425,426,428,432,433,434,436,437,442,443,444,445,446,447,448,449,451,453,454,455,456,457,458,459,461,462,463,464,465,466,467,468,472,473],local_addr:[129,135,137],local_clear:57,local_fil:472,local_filenam:392,local_fin:57,local_host:129,local_hostnam:337,local_port:129,local_travers:57,local_var:[65,382],localaddr:336,localappdata:455,localcontext:[187,346,461,462],localeconv:[265,346,448,470,471,472],localedir:232,localehtmlcalendar:152,localenam:265,localetextcalendar:152,localhost:[90,104,107,110,141,201,243,246,267,268,284,307,315,330,337,340,343,360,392,416,417,447,472],localitynam:343,localnam:[407,412,413],localobject:57,localtim:[93,103,184,204,210,249,266,367,457,458,467,472],localtime_r:472,localtimezon:184,locat:[5,7,30,31,44,53,58,62,65,66,74,78,83,84,90,91,92,93,97,101,103,106,110,113,124,143,149,159,164,168,177,178,184,185,193,211,212,214,227,229,244,248,252,253,257,265,267,268,273,276,281,284,286,290,293,294,299,301,302,304,313,314,315,316,321,322,333,343,356,361,363,367,370,372,380,385,391,392,397,404,406,407,410,411,412,422,423,424,428,432,434,444,446,449,450,451,453,454,455,456,458,459,460,461,462,463,466,468,470,472],lock:[5,28,29,57,62,79,82,93,104,107,117,127,165,167,168,170,177,185,213,216,242,251,257,266,268,269,271,283,284,293,307,318,324,326,331,340,342,344,355,399,424,448,456,458,460,461,462,463,464,466,469,471,472,473],lock_ex:216,lock_held:251,lock_nb:216,lock_sh:216,lock_un:216,lockablefil:458,lockbox:466,lockdata:216,lockf:[216,271,293,458,462,467,472],lockstep:456,locktyp:117,loewi:[77,288,431],log01:267,log02:267,log03:267,log04:267,log05:267,log06:267,log07:267,log10:[156,187,275,462],log1:466,log1p:[275,462],log2:[275,466,467],log:[1,62,71,86,93,98,99,100,109,120,125,129,130,149,153,154,156,165,167,170,193,215,225,232,237,246,253,257,275,288,293,307,320,333,337,346,350,355,357,363,382,385,397,404,417,424,441,447,455,456,457,458,460,461,462,465,472,473],log_:268,log_alert:[268,357],log_auth:[268,357],log_authpriv:[268,357],log_con:357,log_crit:[268,357],log_cron:[268,357],log_daemon:[268,357],log_date_time_str:246,log_debug:[268,357],log_emerg:[268,357],log_err:[268,357],log_error:246,log_except:404,log_filenam:104,log_ftp:268,log_if_error:104,log_info:[268,357],log_kern:[268,357],log_local0:[268,357],log_local1:268,log_local2:268,log_local3:268,log_local4:268,log_local5:268,log_local6:268,log_local7:[268,357],log_lpr:[268,357],log_mail:[268,357],log_mask:357,log_messag:246,log_ndelai:357,log_new:[268,357],log_notic:[268,357],log_nowait:357,log_odelai:357,log_perror:357,log_pid:357,log_request:246,log_syslog:[268,357],log_to_stderr:284,log_upto:357,log_us:[267,268,357],log_uucp:[268,357],log_warn:[268,357],loganberri:438,logarithm:[62,187,237,290,295,320,346,421,459,462,465,466,467],logb:187,logconfig:267,logctx:104,logdir:[153,154],logfil:[104,153],loggedvar:382,logger1:104,logger2:104,logger:[62,104,120,128,170,267,268,284,333,357,382,385,459,463,465,466,467,468,469,471,472],logger_log01:267,logger_pars:267,logger_root:[103,267],logger_simpleexampl:103,logger_thread:104,loggeradapt:[62,120,463,472],logging_rotatingfile_exampl:104,loggingcontext:104,logic:[7,62,65,74,84,90,91,99,104,170,178,182,193,208,222,223,255,266,268,269,271,282,290,291,298,304,321,346,347,355,357,363,374,375,382,385,432,448,456,459,460,462,463,467,471,472],logical_and:187,logical_invert:187,logical_or:187,logical_xor:187,login:[174,225,231,249,286,288,293,312,337,341,360,392,466,472],login_cram_md5:249,logistic_map:260,loglevel:103,lognam:[104,231,293],lognorm:320,lognormvari:320,logo:[1,66,86,241,380,422],logopt:357,logout:[249,469],logprocess:103,logrecord:[62,103,120,268,385,459,468,472],logrecordsocketreceiv:104,logrecordstreamhandl:104,logrequest:417,logrot:268,logtest7:104,logthread:103,logtyp:268,lollipop:470,lone:[310,337,426],long_add:472,long_descript:[65,66,69,74,77],long_info:463,long_invert:472,long_max:[5,35,472],long_min:35,long_opt:65,long_rshift:472,longbyt:431,longbyteschar:431,longbytesitem:431,longer:[3,5,7,22,28,31,40,54,57,58,61,62,65,74,79,84,89,91,95,96,97,99,103,105,110,114,119,122,128,129,143,159,177,178,189,190,200,202,209,212,227,228,236,243,248,251,252,254,258,260,264,267,271,284,292,293,297,304,306,311,313,321,327,339,342,343,346,349,355,359,363,365,366,367,373,378,380,385,386,387,396,397,399,406,407,408,409,411,419,421,426,428,437,439,446,448,451,455,456,457,458,459,460,461,462,463,464,465,466,467,469,470,471,472],longest:[189,237,248,258,260,294,382,431,458,461,469],longest_match_length:322,longhand:258,longitud:347,longlink:359,longlist:299,longmessag:[110,246,385,463,472],longnam:[178,359],longobject:472,longopt:230,longpathsen:455,longstand:467,longstr:431,longstringchar:431,longstringitem:431,longval:456,look:[0,13,17,26,30,31,32,41,45,57,58,62,65,69,72,74,75,77,78,79,81,82,83,84,85,86,87,90,91,92,93,94,95,97,98,99,101,103,104,105,106,107,109,110,111,113,118,122,124,129,130,143,144,149,153,159,161,168,170,177,178,181,182,184,187,189,193,197,198,200,204,206,212,214,227,228,232,235,244,246,248,251,252,256,264,266,267,271,292,293,294,295,296,298,304,305,309,310,315,321,326,333,340,342,343,346,347,350,355,356,363,367,368,369,373,375,377,381,384,385,386,387,392,399,404,407,410,420,424,425,426,428,431,432,437,439,440,441,442,443,444,445,446,447,454,455,456,457,458,459,460,461,462,463,465,466,467,468,470,472],lookahead:[62,65,321,460],lookalik:459,lookbehind:[321,469,472],lookup:[15,16,21,28,56,59,62,83,84,91,93,98,124,149,159,161,182,196,204,212,214,227,232,246,254,258,260,268,287,291,293,305,346,347,354,355,370,373,377,384,386,428,448,456,458,460,461,462,466,467,468,470,472],lookup_error:[159,459],lookup_lin:377,lookup_nam:382,lookuperror:[13,22,58,159,171,214,346,446,468],loop:[31,32,41,58,60,62,79,84,86,93,97,99,103,104,106,107,125,126,127,128,131,133,134,136,137,138,139,140,141,158,160,172,177,178,185,187,190,197,206,219,226,253,268,284,298,299,310,311,321,333,334,336,339,340,342,343,346,347,350,355,363,366,368,377,380,386,409,410,417,423,424,425,426,431,432,436,441,442,445,448,456,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],loop_detect:242,loopback:[248,258],loos:[244,366],lope:468,loper:460,lord:106,lordthorsen:[470,472],lorem:151,lorentsen:471,lorenz:[462,472],lorenzo:[466,468],lose:[31,38,106,168,184,187,212,214,241,244,268,271,320,321,350,456,463,466,472],loser:237,loss:[31,143,187,227,244,257,271,275,392,418,422,426,440,458,460,462,466,470,471,472],lossless:375,losslessli:[187,189,424,440,466],lost:[79,94,95,103,109,132,135,178,184,187,202,212,228,248,266,268,284,310,333,334,337,340,342,423,440,446,456,458,466,467,468,472],lot:[58,65,68,79,81,83,84,85,86,90,91,94,95,103,106,107,109,110,111,153,170,171,177,185,193,201,235,246,248,258,266,284,292,306,310,331,340,350,371,386,406,435,436,450,456,457,458,459,460,462,463,464,468,472],loudli:464,loui:455,louie:[470,471,472],louko:461,loup:422,love:[79,84,104,176,245,437,465,468],lovett:463,low:[12,15,23,31,34,55,57,58,62,65,72,81,86,90,101,103,106,107,109,123,126,128,129,131,135,137,138,140,141,147,152,161,165,168,170,178,179,190,214,225,242,253,257,259,282,293,296,298,310,318,320,321,329,330,331,334,337,343,345,355,357,370,379,397,399,410,421,458,459,461,462,463,467,469,470,472],low_card:320,lower:[13,30,58,65,78,90,91,93,97,101,104,105,106,108,124,129,135,142,145,147,157,159,161,164,167,168,178,179,181,187,196,197,201,203,204,206,220,222,227,228,237,241,246,249,260,271,274,284,288,293,307,310,321,324,327,339,342,343,346,347,353,355,361,366,367,368,372,380,391,392,424,426,432,438,451,457,459,460,461,462,463,465,466,468,472],lower_bound:426,lower_cas:472,lower_case_with_underscor:[],lowercas:[58,106,109,144,157,168,187,197,206,227,236,238,294,321,328,346,347,355,365,392,431,464,472],lowercase_with_underscor:437,lowercaseddict:466,lowerright:177,lowest:[38,54,98,103,136,187,190,223,237,279,289,318,343,346,350,366,368,426,438,448,456,461,470],lowin:472,lownd:462,loys:472,lp1:465,lp64_wp:461,lp_c_long:177,lpadesc:177,lpar:[374,375],lpattributelist:[350,471],lpcaption:177,lpcmdline:418,lpcstr:177,lpcwstr:177,lpmodulenam:177,lpr:268,lprect:177,lprefix:145,lproxi:284,lptdesc:177,lptext:177,lpthread:78,lpwstr:418,lpython3:78,lru:[161,228,472],lru_cach:[161,228,466,467,469,472],lrx:178,lry:178,lsampl:143,lseek:[293,461,467],lshift:[124,291],lsprof:310,lsqb:374,lst:162,lstat:[293,294,298,344,363,467,472],lstrip:[342,346,459],lstrip_w:65,lsub:249,ltcl83:77,ltd:[86,89,343,422],lte:124,lto:472,lua:448,luca:[236,468,469,472],lucasfilm:[86,89],lucent:422,luciano:472,luck:[95,407],lucki:[97,177],luckili:[79,95,105,385,404],luctu:151,ludov:472,lue:466,luethi:472,lumberjack:[168,309,377],lumberstack:377,lumholt:370,lundh:[0,91,97,99,370,383,416,422,456,457,458,460,461,463,466],lutil:78,lutz:370,lvalu:[9,292,346],lvl:[104,266],lvlname:104,lwn:467,lwpcookiejar:244,lx11:79,lyapun:468,lying:[268,442],lynn:461,lynx:[244,400,460],lysandro:472,lzc:269,lzf:269,lzma:[62,121,253,333,359,363,406,419,447,468,472],lzmacompressor:269,lzmadecompressor:[269,469,472],lzmaerror:269,lzmafil:[269,468,472],m10:367,m68k:472,m_base:41,m_clear:41,m_doc:[41,82],m_expr:426,m_free:41,m_method:[41,472],m_name:[41,82],m_reload:41,m_size:[41,82],m_slot:41,m_state:472,m_travers:[41,472],ma_version_tag:472,maart:431,mac:[30,62,64,65,79,86,87,89,111,112,120,177,218,220,227,236,253,256,279,284,293,296,310,329,333,335,342,343,344,355,356,363,373,392,395,400,422,435,451,452,464,466,468,470,471,472],mac_cyril:159,mac_greek:159,mac_iceland:159,mac_kei:236,mac_latin2:159,mac_roman:159,mac_turkish:159,mac_ver:305,maccentraleurop:159,maccyril:159,macedonian:159,macerror:462,macf:462,macgreek:159,machdep:472,machin:[30,31,58,62,72,79,90,92,93,101,103,104,107,123,135,159,167,178,179,201,213,227,232,244,254,257,259,267,268,269,272,274,284,288,293,298,305,310,315,334,337,339,342,343,346,349,366,368,395,406,417,418,424,430,440,442,444,453,455,456,457,458,461,462,463,465,466,467,471,472],machineri:[22,41,62,74,79,93,98,104,118,159,187,210,251,254,281,304,343,355,399,403,421,424,428,451,455,457,458,460,463,466,467,468,469,470,471,472],macholib:472,maciceland:159,maciej:469,macintosh:[62,93,147,148,159,270,294,335,431,452,456,459],macintyr:[459,461],maclatin2:159,macmillan:456,maco:[54,62,74,87,90,101,109,135,293,294,322,339,367,369,373,449,456,457,458,459,461,462,463,470,471],macostool:462,macosx:[65,356,400,453,466,472],macosx_deployment_target:[65,293],macpath:[62,220,253,294,472],macports_dir:168,macpython:[62,452,458],macresourc:462,macro:[3,4,5,6,7,9,15,16,19,22,26,29,30,34,38,39,40,41,46,47,49,50,51,53,55,57,58,61,62,65,68,74,79,82,92,95,177,286,355,459,460,461,462,463,466,467,468,469,470,471,472],macrom:453,macroman:159,macturkish:159,macurl2path:472,macvim:453,made:[10,11,28,30,31,39,57,60,64,65,70,74,78,84,86,91,92,93,95,96,101,103,104,105,106,111,112,113,114,122,132,135,141,150,159,167,168,170,172,177,178,184,187,190,193,197,200,201,206,209,212,214,225,232,238,243,244,251,252,254,257,260,266,267,268,275,279,282,284,293,299,301,309,310,316,320,322,323,324,326,329,335,337,339,343,346,350,359,361,366,370,378,382,386,387,390,391,395,397,399,404,407,410,416,417,418,422,423,424,432,434,436,439,440,446,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],madison:472,madler:422,maecena:151,magenta:[97,178,212,448],magic:[28,62,65,91,93,94,95,108,117,168,177,188,193,232,251,252,310,343,351,363,366,367,382,387,399,419,445,456,457,459,468,469,470,471,472],magic_html_pars:201,magic_numb:[251,252,468],magickmock:472,magicmock:[62,188,469,472],magicproxi:472,magna:151,magnifi:460,magnitud:[92,184,187,227,261,275,346,347,406,456,467],magnu:[458,459],mahler:392,mahn:466,mahon:472,mai:[1,5,7,9,10,11,13,16,21,22,23,26,28,30,31,34,38,39,41,47,49,50,51,53,54,55,57,58,60,61,65,66,68,70,72,74,75,77,78,79,80,81,82,83,84,85,86,90,91,92,93,95,96,97,98,99,102,103,104,105,106,107,109,110,111,112,113,114,117,118,119,122,123,124,125,129,134,135,137,140,141,142,143,145,147,148,149,150,151,153,157,158,159,160,161,164,167,168,169,170,172,173,174,175,176,177,178,182,184,185,187,189,190,192,193,195,196,197,198,200,201,202,203,204,206,207,208,209,210,211,212,214,216,217,219,222,223,225,227,228,229,230,231,232,233,234,235,236,237,238,241,243,244,246,248,249,251,252,253,254,257,258,260,261,264,265,266,267,268,269,271,274,275,276,279,280,282,283,284,286,287,288,289,291,292,293,294,295,297,298,299,301,302,303,304,305,306,307,308,309,313,314,315,316,320,321,322,323,324,326,327,328,329,330,331,332,333,334,336,337,339,340,342,343,344,345,346,347,348,349,350,353,354,355,356,358,359,360,361,363,365,366,367,368,370,372,373,374,375,376,377,378,380,381,382,384,385,386,387,391,392,394,395,396,397,398,399,400,402,403,404,406,407,408,409,410,411,412,413,416,417,418,419,420,421,422,423,424,425,426,427,428,430,431,432,433,434,435,436,437,438,439,440,441,442,443,445,446,447,448,449,450,451,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],maier:472,mail:[1,64,84,99,104,105,106,112,144,195,196,197,199,201,203,206,218,249,268,271,272,288,293,319,336,337,343,357,385,404,447,448,450,453,456,457,458,459,460,461,462,466,469],mail_admin:104,mail_opt:[336,337,469,472],mailbox:[62,91,195,202,249,253,285,307,450,461,463,470,472],mailcap:[62,253,285,472],maildir:[62,285,461,463],maildirmailbox:91,maildirmessag:[62,285],mailer:210,mailfrom:336,mailhost:[267,268],mailman:[86,336,458,460],mailmanproxi:[62,255],mailserv:[307,447],mailto:[391,422],main:[22,30,31,57,60,62,69,74,78,79,80,81,82,84,85,90,91,93,94,95,97,103,104,115,117,122,126,127,128,129,131,132,135,136,137,138,139,140,142,153,158,167,168,171,178,186,189,193,195,197,200,201,202,205,206,207,209,228,230,232,237,241,248,252,254,257,266,267,271,284,288,292,293,298,301,313,324,326,334,335,340,342,355,359,363,366,368,370,372,373,378,380,385,392,396,399,408,412,417,418,425,428,438,446,447,448,450,451,455,458,459,461,463,464,465,466,467,468,469,470,472,473],main_in_temp_cwd:378,main_log:90,main_thread:[366,468],mainfn:418,mainli:[30,65,74,103,124,157,168,254,274,278,292,306,355,356,382,404,416,424,455],mainloop:[87,107,248,370,373,380,472],mainmenu:472,mainprocess:284,mainstream:66,maint:454,maintain:[1,30,31,64,65,66,69,74,77,79,82,86,90,93,95,97,104,108,111,112,122,123,149,153,159,161,168,170,177,187,192,197,208,209,212,214,222,227,229,237,251,252,254,265,274,292,297,309,310,327,340,349,351,355,361,370,372,385,397,398,399,400,404,409,428,430,436,437,446,447,455,456,458,459,460,461,462,463,464,467,468,469,471,472],maintainer_email:[65,66,69,74,309],mainten:[62,64,112,211,328,431,446,455,466,467,468,471,472,473],mainthread:104,maintyp:[197,198,201,202,204,205,206],majek:422,majewski:457,majkowski:422,major:[30,69,72,74,83,86,93,95,105,107,109,110,111,168,184,195,204,207,209,212,232,236,244,292,293,296,305,307,315,346,355,356,385,391,418,441,450,455,456,459,461,462,463,464,465,466,467,469,470,472,473],major_vers:77,make:[5,10,13,22,30,31,41,54,57,58,62,64,65,66,71,72,74,78,79,81,82,84,86,93,94,95,97,98,99,101,102,103,104,106,107,108,109,110,111,112,113,114,118,122,123,124,125,129,135,139,141,142,143,149,153,157,158,159,161,162,164,168,170,171,172,176,177,178,180,182,184,187,189,190,191,193,197,198,201,206,207,210,212,213,219,222,223,227,228,229,232,235,236,237,238,243,248,252,254,256,257,258,260,265,266,267,268,269,271,275,280,282,284,288,289,291,292,293,295,297,298,301,309,310,314,318,320,324,328,329,330,331,332,334,336,339,340,342,343,346,347,349,351,355,356,359,361,363,364,365,366,368,370,373,375,376,377,380,381,382,385,386,387,391,392,395,396,397,398,399,400,404,408,409,410,413,419,421,422,423,424,426,427,428,430,431,432,435,436,437,438,440,441,442,444,445,446,447,448,449,452,453,454,455,457,458,459,460,461,462,464,465,466,467,468,471,472,473],make_:197,make_altern:206,make_an_item_avail:366,make_arch:[65,333,463,466,469,472],make_bad_fd:363,make_closur:[470,472],make_connect:[366,416],make_cooki:244,make_dataclass:[182,472],make_encod:472,make_fil:[189,469,472],make_funct:[190,470,472],make_head:[203,467],make_incrementor:437,make_legacy_pyc:363,make_mix:206,make_msgid:[201,210,472],make_new_us:382,make_opt:292,make_pars:[409,411,413,456],make_pkg:363,make_rel:206,make_script:363,make_serv:[404,461],make_t:189,make_tarbal:65,make_zip:472,make_zip_pkg:363,make_zip_script:363,make_zipfil:65,makedev:[293,459,472],makedict:280,makedir:[90,293,333,469,471,472],makeel:410,makefil:[30,65,78,79,85,233,257,298,339,343,356,424,456,457,462,463,467,468,469,470,472],makelocalealia:472,makelogrecord:[104,266,268],makepickl:[104,268],makerecord:[104,266],makesocket:268,makesometh:385,makesomethingdb:385,maketran:[161,346,465,466,469,472],makoto:[422,472],malaysia:410,malcolm:[101,321,463,466,470,472],malform:[159,187,200,227,243,257,271,294,347,460,462,466,472],malformedheaderdefect:200,malici:[30,109,267,274,301,316,406,408,409,410,411,416,417,451,462,472],mallard:468,mallei:[422,459],malloc:[5,7,38,79,84,214,283,421,451,456,457,459,461,468,469,470,472],malloc_debug:[38,451],malt:468,maltes:159,man1:472,man3:370,man:[17,97,129,174,271,293,315,324,329,334,339,344,367,370,372,463,472],manag:[3,5,16,29,30,47,62,80,82,86,93,98,107,110,111,112,120,126,129,134,138,139,140,145,153,159,165,175,177,185,187,190,191,195,204,214,219,222,227,242,244,246,248,252,253,255,257,271,279,285,295,300,301,317,329,330,331,336,339,340,343,355,359,360,361,363,366,369,371,373,385,386,387,392,399,400,416,419,423,430,440,441,443,447,448,453,454,455,456,459,460,463,464,465,466,467,468,469,470,471,472],manage_cloud:466,managed_resourc:170,manda:320,mandat:[95,197,206,249,261,321,367,470],mandatori:[82,90,114,249,252,267,293,342,343,344,437,459,467],mandatoryreleas:114,mandeep:[471,472],mandelbrot:91,mandrak:[66,72,111,305],manfr:442,mangl:[91,197,323,426,431,432,436,468,472],mangle_from:472,mangle_from_:[197,202,209,469],manheaderlen:202,manheim:370,mani:[0,7,15,17,30,31,53,58,60,62,64,65,66,70,72,75,77,78,79,81,82,84,85,89,90,92,93,95,96,97,99,102,103,104,106,107,108,109,110,111,112,119,122,124,128,135,138,140,141,144,156,159,161,164,168,170,175,176,177,178,179,182,184,187,189,190,193,195,204,209,212,213,222,225,227,229,232,236,237,243,244,245,248,251,252,253,254,256,257,258,260,261,264,266,275,279,284,288,291,292,293,295,296,297,298,300,301,305,307,308,309,310,316,319,320,321,327,329,331,333,334,337,339,340,342,343,345,346,347,349,350,355,359,360,363,365,366,367,368,369,370,372,376,377,380,381,382,385,386,387,388,392,399,400,402,403,404,407,421,422,423,424,428,430,432,435,436,437,438,439,440,441,442,445,446,447,448,449,450,451,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],manifest:[67,71,74,77,363,463,472],manipul:[7,30,31,38,41,50,62,65,79,82,91,99,102,104,111,145,146,161,170,176,177,178,184,187,195,196,206,208,220,222,232,239,253,255,257,268,278,284,285,293,297,298,310,326,332,333,335,339,344,346,352,355,364,370,372,373,391,404,407,410,417,428,445,447,448,450,451,456,459,462,467,468,470,472],mann:370,manner:[4,51,79,93,95,97,104,168,246,267,269,292,297,313,315,321,323,342,350,361,382,385,397,424,428,459,461,462],manpag:[177,293,470,472],manquant:110,mant_dig:[355,462],mantissa:[275,460,462],manual:[30,56,62,65,68,78,79,80,83,85,90,91,97,99,105,109,111,113,129,133,134,135,140,177,178,186,193,198,207,216,227,253,256,257,266,271,292,293,304,306,315,322,329,339,342,346,355,357,359,361,362,367,370,372,386,407,410,418,421,428,429,430,441,445,447,450,454,455,456,457,458,459,460,462,463,464,467,468,469,471,472],manuel:[110,471,472],manufactur:282,map01:144,map:[2,15,21,29,30,38,45,46,54,60,62,65,74,81,84,85,90,91,93,95,96,99,109,110,113,118,125,141,144,157,159,161,162,167,170,171,176,178,182,184,185,187,189,190,193,196,197,204,206,212,213,214,217,218,226,227,232,237,240,243,246,253,254,258,259,260,266,268,269,271,272,273,280,282,284,285,286,287,288,292,293,295,298,300,301,314,316,321,323,324,330,336,342,343,345,347,348,350,353,355,366,367,368,369,373,374,380,381,382,384,386,391,392,399,404,408,410,412,413,423,424,426,428,432,436,437,438,440,446,448,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],map_add:190,map_async:[284,462,467],map_priv:279,map_shar:279,map_table_b2:348,map_table_b3:348,map_to_typ:204,maplogrecord:268,mapnam:287,mappingproxytyp:[21,182,227,346,381,467,472],mappingsubclass:436,mappingview:[162,382,472],mapprior:268,mapresult:472,mar:[99,184,212,430,437,458,462],marangozov:[456,457,459],marat:[471,472],marc:[109,232,342,456,457,458,459,461,467],march:[184,367,380,422,447,456,460,468],marcin:466,marco:472,marek:422,margin:[95,222],mari:[339,437],marian:[470,472],mariatta:[470,472],mario:[471,472],mariu:[109,456],mark:[22,52,58,81,84,87,90,93,95,101,104,105,106,109,118,119,122,124,131,132,135,140,141,145,153,159,167,168,178,182,189,193,206,232,237,241,248,254,261,268,271,299,302,305,307,316,329,339,342,346,350,360,363,370,376,382,385,399,407,422,424,426,431,442,455,456,457,458,459,460,461,462,463,465,466,467,468,469,470,471,472],marker:[43,62,109,119,151,159,171,190,193,227,254,257,269,299,301,343,374,397,467,470,471,472],market:[305,461],marketplac:320,markovitch:456,markthisstringfortransl:232,marku:[469,472],markup:[62,218,241,253,316,407,416,462,466,467,472],markupbas:464,marshal:[29,59,62,91,125,159,253,261,268,300,416,459,460,463,469,472],martelli:[459,462],martijn:472,martin:[77,109,232,288,456,458,459,460,461,462,463,466,467,468,469,470,472],maru:463,maruch:456,masayuki:[471,472],mask:[57,62,177,178,255,293,324,330,333,334,339,344,357,370,373,402,424,439,445,460,462,466,467,472],maskpri:357,masquerad:[386,454],mass:[72,90,184,212,456],massiv:[460,461,469,472],master:[86,106,109,193,229,284,292,293,295,301,311,321,370,373,380,396,462,472],master_doc:472,master_read:311,mat:[422,463],match:[5,10,21,22,30,41,57,58,62,67,74,75,79,91,93,94,97,99,103,107,109,110,120,125,129,140,143,145,152,153,157,161,164,168,178,184,187,188,189,193,197,198,204,205,206,209,212,217,220,228,230,233,241,243,244,247,248,249,251,253,254,267,269,272,284,286,287,288,293,298,299,304,310,313,316,320,322,325,333,334,339,342,343,346,347,349,350,360,363,364,367,370,372,373,375,378,382,385,386,391,392,396,397,398,400,407,408,410,412,417,423,424,426,427,431,437,439,441,443,448,451,456,457,458,460,461,462,463,465,466,467,468,469,470,471,472],match_equ:387,match_foo:387,match_hostnam:[343,466,468,469,471,472],match_test:[363,378],match_valu:363,match_wrong:387,matcher:[363,387],matchfil:472,matchobj:321,matej:[469,472],materi:[83,99,106,178,189,235,256,339,369,370,372,422,450,460,463,472],math:[62,93,95,99,111,122,156,167,187,193,213,223,227,253,284,289,290,320,346,349,380,422,424,426,436,438,440,442,447,459,460,462,463,465,472],mathemat:[43,62,84,93,99,106,161,187,253,291,320,346,424,426,438,440,441,448,460,462,469,472],mathematician:84,mathematisch:[30,63,422],mathewson:458,mathia:468,mathieu:472,mathmodul:90,mathsclass:284,matmul:[291,469,472],matmult:124,matplotlib:472,matric:[288,457],matrix:[43,62,91,152,291,380,422,426,438,457,472],matsumoto:[320,422],matt:[370,463,468,469,472],matter:[65,75,84,91,94,104,109,111,164,193,209,248,252,265,284,292,293,340,342,346,355,362,373,385,386,387,397,424,436,438,440,446,455,456,458,460,461,462,463,468,472],matthew:[201,468,472],matthia:[91,463,467,470,471,472],matthieu:472,mattia:[465,466],mattip:472,matur:[1,87],matusiak:472,matveev:472,maupin:462,mauro:472,max:[5,93,99,107,122,143,156,161,184,187,227,228,237,244,245,260,275,320,343,346,355,426,436,446,461,463,466,468,472],max_10_exp:355,max_count:[204,209],max_denomin:223,max_digest_s:236,max_emax:[187,467],max_ev:329,max_exp:355,max_interpolation_depth:168,max_key_s:236,max_length:[151,269,421,469,472],max_lin:[365,468],max_line_length:[197,206,209,467,472],max_mag:187,max_memus:363,max_num_field:[391,472],max_path:[62,452,470,472],max_prec:[187,467],max_prefixlen:258,max_py_ssize_t:363,max_siz:361,max_wbit:421,max_widget:95,max_work:[129,167,466,472],maxarrai:323,maxbyt:[104,267,268,463],maxbytecount:370,maxchar:58,maxcol:222,maxconnect:366,maxcount:58,maxdepth:410,maxdequ:323,maxdict:323,maxdiff:[385,466],maxev:329,maxfd:339,maxfrozenset:323,maxheaderlen:[197,202,206,468],maxim:[143,189,190,197,227,236,248,355,363,436,472],maximov:472,maximum:[7,24,31,54,57,58,91,99,103,104,106,117,129,140,141,143,156,159,161,164,167,168,176,177,178,187,189,196,203,204,209,214,225,236,248,260,261,268,269,275,279,282,284,288,293,301,307,309,321,322,323,324,330,336,339,341,343,347,355,359,365,366,373,375,378,380,385,391,392,404,410,431,435,451,456,458,459,461,462,463,466,467,469,470,471,472],maximum_support:343,maximum_vers:[343,471,472],maxint:[113,464],maxlen:[161,260,462,463],maxlength:[196,284],maxlevel:[164,309,323],maxlin:[470,471,472],maxlinelen:203,maxlist:323,maxlong:323,maxmem:236,maxoth:323,maxpp:143,maxset:323,maxsiz:[95,113,136,161,228,260,284,305,318,346,355,363,370,424,446,464,466,472],maxsplit:[58,106,321,346],maxstr:323,maxtasksperchild:[284,463],maxtri:392,maxtupl:323,maxunicod:[355,446,467],maxval:380,maxwel:472,maxyear:[184,472],mayank:[469,472],mayb:[57,79,95,99,107,271,339,397,430,435],maybe_dtrace_lin:101,mayfield:472,maystr:468,maze:97,mazin:460,mb_iconasterisk:403,mb_iconexclam:403,mb_iconhand:403,mb_iconquest:403,mb_ok:403,mbc:[15,30,62,146,294,355,451,458,459,466,467,470,472],mbox:[62,197,202,285,461],mboxmailbox:91,mboxmessag:[62,206,285],mboxo:271,mbstowc:54,mbtn:373,mbuf:324,mca:472,mcafe:92,mcclure:468,mccracken:472,mcculli:472,mcet:472,mcfluff:321,mcguir:[463,465],mcintyr:[461,462],mckellar:469,mcl:378,mclai:458,mcmillan:[91,107,459],mcnamara:[459,461],md2:466,md4:466,md5:[174,236,238,249,337,342,343,395,461,462,463,464,466,468,472],md5sum:[342,472],mdc2:466,mdiff:472,mdt:184,meador:[463,467,472],mean:[4,5,7,17,22,28,30,31,38,41,47,53,54,55,56,57,58,60,61,64,65,66,74,75,79,81,82,84,85,90,92,93,94,95,98,99,102,103,104,105,106,107,108,109,110,111,112,113,114,117,118,119,122,124,129,135,136,140,141,143,145,153,156,157,159,161,164,167,168,170,176,177,178,179,182,184,185,187,189,190,193,197,203,204,206,207,208,209,210,214,215,216,217,219,221,222,225,227,228,230,234,235,236,237,238,243,244,245,248,252,254,256,257,258,260,261,265,266,267,268,269,271,274,276,279,282,284,288,289,292,293,294,297,298,299,301,303,305,310,312,313,316,318,320,321,323,324,327,329,330,331,332,333,334,335,336,337,339,340,341,342,343,344,345,346,347,349,350,355,361,362,363,366,367,368,370,373,377,380,381,382,385,386,387,391,392,394,395,396,397,398,399,402,404,407,410,416,417,418,420,421,422,423,424,425,426,428,430,431,432,436,437,439,440,442,444,445,446,447,449,451,454,455,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],meaning:[57,106,125,193,199,236,254,258,267,271,316,321,339,343,355,381,392,395,424,430,432,464,466,468,469,472],meaningless:[30,109,293,457,458,468],meant:[23,31,45,56,72,84,103,104,105,116,124,135,140,143,159,167,194,214,232,237,241,252,310,339,342,363,370,382,392,419,437,442,455,461,462,463,466,467,468,469,471,472],meantim:30,measur:[62,97,105,135,141,143,156,186,187,189,224,228,253,290,301,310,324,340,367,370,378,437,441,442,456,459,460,461,462,463,467,468,471,472],mechan:[7,10,13,28,30,31,56,57,71,79,81,84,85,90,93,97,98,103,106,107,111,114,118,129,132,133,140,144,170,177,182,192,193,198,204,222,227,244,245,246,247,249,251,258,259,265,266,267,268,271,272,292,301,304,319,321,324,326,334,337,339,340,343,346,349,366,369,370,372,373,385,392,396,397,420,424,428,431,432,435,436,437,443,456,457,458,459,460,461,463,465,466,467,468,469,472],media:[110,155,236,282,321,422],median:[98,320,345,447,468,472],median_group:345,median_high:345,median_low:345,mediat:93,medium:[50,179,187,460,461],meerkat:458,meet:[69,84,99,104,142,170,187,189,193,301,346,385,392,424,448,449,450,456,460],mega:372,megabyt:153,mei:431,meier:236,melbourn:367,melero:472,melin:468,melotti:[109,463,466,467,468,469],melt:237,mem:[7,39],member:[5,28,30,31,41,49,51,53,56,57,62,75,81,82,84,93,95,113,151,164,168,177,178,182,183,234,245,246,249,257,260,261,269,293,294,301,312,313,315,317,320,339,341,342,343,344,345,346,349,359,367,375,381,386,419,422,424,426,436,438,447,459,460,461,462,466,467,469,470,471,472],member_nam:212,memberdescriptortyp:[381,472],membership:[62,97,102,153,161,179,212,234,346,386,424,438,460,466,472],memberst_mtim:458,memcpi:[58,96,418,472],memlen:7,memlevel:421,memlimit:269,memmov:[177,462],memo:[172,301,302,470,472],memoiz:[91,228,457,470,472],memorandum:271,memorecord:301,memori:[3,5,7,15,17,22,26,28,29,30,31,37,39,41,43,44,50,53,54,56,57,58,60,62,78,79,81,82,83,85,91,93,99,103,104,106,107,109,117,120,121,123,125,138,153,159,161,177,185,186,208,213,214,215,227,235,236,237,238,248,253,254,259,260,268,271,284,293,297,301,316,318,324,331,333,339,340,342,349,350,355,361,363,366,386,399,402,403,406,408,410,418,421,424,431,434,436,438,442,448,451,456,457,459,460,461,462,463,464,465,466,467,470,471,472],memorybio:[343,469,472],memoryerror:[9,22,50,55,58,214,297,392,446,468,472],memoryhandl:[62,103,104,120,267],memoryobject:[467,469],memoryview:[7,15,62,93,113,146,227,253,339,355,382,446,464,466,468,469,472,473],memset:[177,472],memus:363,mend:472,mental:111,mention:[31,65,74,75,79,81,82,83,99,102,104,105,106,109,111,168,177,178,193,214,216,227,261,266,267,271,284,292,293,332,335,340,363,382,383,422,423,424,428,430,431,432,439,456,464,467,468,471,472],mentorship:1,menu:[62,66,92,93,97,369,370,372,380,453,455,461,465,466,470,471,472],menubutton:373,menudef:472,merchant:422,merci:424,mercuri:[212,466,468,472],mere:[91,92,93,170,184,193,227,292,350,380,423,464],merejkowski:472,merg:[21,91,93,96,97,98,99,103,104,178,190,193,214,237,266,268,283,292,376,382,422,448,456,459,462,463,469,472],meridian:367,merit:380,mersenn:[62,320,459],mersennetwist:320,mertz:99,mesg_num:307,mesgnum:307,mess:[97,122,292,436,442,458],messag:[5,22,30,49,54,60,62,65,74,78,79,81,82,85,90,91,94,97,98,99,102,106,107,109,110,122,125,128,129,135,137,144,145,147,157,158,159,164,169,175,178,193,195,196,198,199,200,201,202,203,204,205,207,209,210,213,214,225,230,231,242,243,244,246,247,248,249,252,253,254,258,261,266,267,268,272,280,284,285,288,292,293,299,307,313,316,319,321,324,332,334,336,337,339,340,343,344,355,357,358,359,360,363,368,372,375,377,382,385,386,387,390,392,396,397,404,410,411,412,416,418,422,425,432,434,439,444,445,447,448,450,451,455,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],message_bodi:243,message_factori:[208,209,470],message_from_binary_fil:[201,208,209,466],message_from_byt:[208,466],message_from_fil:[205,208],message_from_str:[208,392,467],message_id:288,message_num:249,message_part:249,message_set:249,message_spec:288,messagebeep:[403,470,472],messagebox:[177,370,472],messageboxw:177,messageclass:246,messagedefect:200,messageerror:200,messagefil:201,messageparseerror:[200,271],messi:[99,459,463],messier:[99,106,458,459,463],met:[30,57,81,99,103,189,305,343,422,448,461],meta:[55,62,69,71,77,93,95,98,113,153,178,179,221,233,252,292,355,392,424,458,467,468,470,472],meta_path:[93,252,304,355,428,446,455,459,467,470,472],metabas:404,metacharact:[62,321,350,460],metaclass:[62,93,95,98,113,118,177,212,227,254,346,381,382,423,462,464,466,468,469,470,471,472],metadata:[62,64,66,71,72,73,74,75,101,110,112,182,228,232,252,254,288,293,294,313,333,344,359,416,418,424,428,437,449,466,468,469,470,471,472,473],metalog:225,metapathfind:[93,252,355,467,468,471,472],metaphor:[79,252,372],metaslash:288,metatyp:[57,254],metavar:[62,120,201,292,396,463,466,472],metavartypehelpformatt:122,meter:[212,372],meth:[20,40,84,91,93,113,346,457,460,467],meth_class:[53,459],meth_coexist:[53,460],meth_fastcal:[53,471,472],meth_keyword:[53,79],meth_noarg:[53,62,82,96,458,459],meth_o:[53,62,458],meth_o_sampl:95,meth_oldarg:[5,458,464],meth_stat:[53,459],meth_vararg:[5,53,78,79,458,472],method:[5,6,7,13,14,15,20,21,22,23,24,26,31,33,35,36,41,42,45,47,48,49,50,51,53,57,60,62,65,69,78,80,81,86,87,92,93,94,95,97,99,103,104,105,108,109,110,113,114,117,118,119,120,123,124,125,128,131,133,134,135,136,137,138,139,140,141,145,147,148,149,151,152,153,155,156,157,158,159,160,161,162,164,165,167,168,169,171,172,176,177,178,180,182,183,184,185,187,188,189,190,193,196,197,198,199,200,202,203,204,205,206,207,208,209,210,214,216,217,219,220,222,223,224,225,227,228,229,232,235,236,237,238,243,244,245,246,248,249,251,252,254,255,257,258,261,266,267,268,269,271,273,276,279,280,282,286,289,291,293,295,297,299,300,301,303,304,307,309,310,313,314,315,316,317,318,320,321,323,325,327,329,330,331,332,336,337,340,343,345,347,349,350,351,352,354,355,359,360,361,363,365,366,368,370,371,372,373,375,377,378,381,382,384,385,388,391,392,393,394,395,396,398,400,402,404,405,408,409,410,411,412,413,414,415,416,417,418,419,421,423,425,428,429,431,432,437,438,440,441,443,445,447,448,451,453,455,457,458,459,462,463,465,466,468,472,473],method_1:84,method_:174,method_blowfish:174,method_cal:[386,387],method_crypt:[174,470,472],method_descriptor:460,method_md5:174,method_nam:[84,85],method_not_allow:242,method_sha256:174,method_sha512:174,method_to_typeid:284,methodattr:113,methodcal:[93,108,291,462,469,472],methoddef:[95,472],methoddef_defin:95,methoddescriptortyp:[381,471,472],methodhelp:[416,417],methodnam:[84,284,385,416,436,437],methodrespons:416,methodsignatur:[416,417],methodtyp:[40,98,381],methodwrappertyp:[381,471,472],metr:184,metric:[91,472],metzen:189,mexico:472,meyer:467,mezzo:461,mf_bt2:269,mf_bt3:269,mf_bt4:269,mf_hc3:269,mf_hc4:269,mfc:[87,455],mgr1:[461,462],mgr2:[461,462],mgr:[423,462],mh_profil:271,mh_sequenc:271,mhlib:462,mhmessag:[62,285],mib:[236,269,284],michael:[110,437,438,457,458,459,460,461,462,463,466,467,468,469,472],michel:[458,459,467,468,469,470,471,472],michlmayr:462,mick:[380,456,459,461],micro:[82,86,91,355,456,463,465,471,472],microbenchmark:472,microphon:295,microsecond:[19,101,184,324,342,367,462,472],microsoft:[54,62,66,71,74,83,87,159,168,253,293,355,395,401,404,431,444,452,458,459,461,462,469,472],microsystem:405,middl:[68,84,91,95,97,129,161,170,200,299,320,323,345,365,380,413,436,448,461,463,470,472],middleton:457,middlewar:404,midi:237,midnight:[184,268,462,466,469],midpoint:[320,345],midst:360,midwai:[82,421],might:[7,22,30,31,47,52,57,58,65,66,69,74,75,79,81,82,84,87,89,91,92,95,96,97,99,103,104,105,106,107,109,110,111,116,124,125,134,135,138,141,143,145,147,153,159,177,180,182,184,193,194,197,206,208,210,223,225,235,236,237,239,241,244,248,257,265,266,267,268,271,272,284,288,292,293,295,297,301,307,308,310,321,337,339,342,343,346,355,363,366,368,370,382,385,386,387,392,397,399,405,428,430,436,437,438,443,445,446,451,454,455,456,458,459,460,461,462,463,466,467,468,470,471,472],migrat:[5,35,58,62,96,252,254,297,407,432,461,462,465,467,468,472],mijmeoh9lt4:109,mike:[99,370,458,460,461,462,472],miki:[463,466],mil:447,milan:[469,471,472],mile:184,mileag:[5,337],mileston:74,miller:[462,468],millimetr:370,million:[86,109,368,437],millisecond:[103,178,184,248,266,267,329,373,380,403,466,470],milman:[471,472],mime:[62,93,106,144,147,153,159,197,201,203,204,205,206,208,209,246,253,272,285,404,428,447,458,460,463,466,468,469,470,471,472],mimeappl:207,mimeaudio:[199,207],mimebas:207,mimeimag:[199,200,207],mimelib:463,mimemessag:207,mimemultipart:207,mimenonmultipart:[200,207],mimepart:[198,206,468],mimetext:[199,207,469,472],mimetool:462,mimetyp:[62,198,201,253,272,285,378,458,462,470,472],mimeversionhead:204,mimewrit:462,mimic:[131,184,254,266,342,377,380,463,465,472],mimick:298,mimifi:462,min:[5,93,99,106,107,161,184,187,227,228,237,254,260,346,355,368,426,436,446,461,463,468,472],min_10_exp:355,min_emin:[187,467],min_etini:187,min_exp:355,min_mag:187,min_vers:363,mind:[28,74,84,91,95,97,104,105,106,122,124,127,149,177,187,201,252,268,284,292,345,392,410,428,440,458,460,466],mindom:472,minequ:374,mingw32:[65,111],mingw32ccompil:65,mingw:[455,472],mini:[62,75,168,227,364,424,431,442,463,465],miniaefram:462,minidentd:225,minidom:[62,253,273,406,407,409,456,457,459,471,472],minifieldstorag:[153,472],minilanguag:332,minim:[23,41,62,65,69,75,79,82,86,90,95,97,143,153,187,189,193,215,227,236,241,249,252,253,258,273,292,307,321,326,334,336,339,341,342,350,363,365,382,392,406,433,436,437,455,456,461,470,472],minimal_hanoi:380,minimalist:380,minimum:[24,31,38,52,69,82,95,104,105,112,117,123,128,135,143,156,161,177,178,187,198,260,275,293,305,329,343,346,347,355,363,366,373,380,385,386,436,442,458,459,462,466,467,468,470,471,472],minimum_support:343,minimum_vers:[343,471,472],minmax:143,minor:[30,62,69,74,83,84,85,86,90,97,105,110,161,204,207,293,305,315,355,356,382,412,448,455,457,458,459,460,461,463,465,466,468,469,470,471,472],minor_vers:77,mint:212,minu:[65,161,178,187,227,229,275,333,346,347,349,366,374,426,432,442,471,472],minut:[19,107,109,184,268,293,367,419,431,459,471,472],minval:380,minwidth:373,minyear:184,mip:472,mircea:472,miro:472,mirror:[22,110,225,267,268,297,374,384,412,450,460,472],mis:[248,472],misbehav:84,misc:[0,31,86,225,373,456,459,460,461,462,463,464,466,468,473],misc_head:157,miscalcul:359,miscellan:[62,71,120,121,157,165,190,195,218,253,285,369,404,452,472,473],misconfigur:[92,103,248],misctestcas:363,misdirect:472,misdirected_request:242,mise:320,misform:472,mishandl:472,misimpl:466,misinterpret:143,mislead:[81,109,154,169,392,408,458,466,472],mismatch:[96,193,214,217,321,335,343,457,459,461,463,469,472],misnam:[460,466],misnom:28,misord:472,misplac:472,misplacedenvelopeheaderdefect:200,misrepres:422,miss:[50,52,62,65,69,84,93,105,106,161,171,176,177,182,187,197,200,206,228,236,252,254,260,266,276,280,289,292,298,321,333,343,345,347,363,367,368,372,376,386,391,392,424,426,428,437,439,448,450,456,459,460,461,462,463,466,467,468,469,470,471,472],missil:466,missing_c_docstr:363,missing_compiler_execut:363,missingheaderbodyseparatordefect:200,missingsectionheadererror:168,mission:[86,292],mississ:346,mississippi:[161,346],misspel:[97,168,386,472],mist:459,mistak:[79,105,106,107,122,128,212,214,266,271,292,367,370,460,461,463,465,472],mistaken:[436,456,466],mistakenli:[91,468,472],mistyp:431,misunderstand:472,misunderstood:107,misus:[30,105,458,472],mit:[87,99,309,422],mitar:472,mitch:90,mitchel:[462,472],mitig:[62,128,245,290,440,465,471,472],mitpress:99,mix:[23,30,38,92,94,104,105,111,118,125,141,184,187,205,206,207,208,212,219,227,230,258,284,289,295,321,340,343,345,346,382,391,424,431,438,445,446,458,459,461,462,463,464,465,466,467,468,472],mixabl:295,mixed_cas:472,mixer:[62,278],mixerdev:295,mixin:[62,162,170,212,255,257,363,392,472],mixtur:[57,204,431,436,469],miyurusara:472,mjs:472,mkd:225,mkdir:[65,90,201,293,298,447,467,469,472],mkdtemp:[293,361,363,399,472],mkfifo:[293,467,469],mknod:[293,459,467,469],mkpath:65,mksalt:[174,467,471,472],mkstemp:[284,361,472],mkstringprep:[348,459],mktemp:[361,392,472],mktime:[184,210,306,342,367,466,472],mktime_tz:210,ml_doc:[53,81],ml_flag:[53,81],ml_meth:[53,81],ml_name:[53,81],mlsd:[225,467],mmap:[38,62,214,253,259,456,462,466,469,470,472],mmask_t:472,mmdf:[62,285],mmdfmessag:[62,285],mmm:[122,249],mms:391,mnemon:[179,267,343,373,458],mnt:111,mobil:[87,466],mock1:386,mock2:386,mock:[62,188,253,378,385,467,468,472],mock_add_spec:386,mock_backend:387,mock_bar:387,mock_cal:[386,387,472],mock_class:386,mock_dat:387,mock_exit:386,mock_foo:[386,387],mock_frob:387,mock_funct:386,mock_method:[386,387],mock_open:[62,188,468,472],mock_ord:386,mock_request:386,mock_respons:387,mock_spam:387,mock_stdout:386,mock_th:386,mockclass1:[386,387],mockclass2:[386,387],mockclass:386,mockiti:386,mocksomeclass:387,mod1:[68,74],mod2:[68,74],mod:[91,124,252,280,291,376,418,432,462],mod_nam:326,mod_spec:472,mod_wsgi:284,mode:[5,23,30,31,37,38,54,58,60,62,66,70,71,79,81,86,90,91,92,93,97,103,104,105,106,109,111,113,119,122,124,132,140,151,153,159,164,168,175,177,178,179,185,188,189,190,193,201,208,219,225,227,230,235,239,246,248,251,252,257,265,266,268,269,271,275,283,288,289,290,292,293,295,298,301,303,305,307,308,311,313,320,321,322,324,325,332,333,335,336,337,339,342,343,344,345,349,350,351,354,355,359,361,363,373,375,378,379,380,385,394,398,400,412,418,419,421,424,431,432,433,440,441,442,445,446,452,453,455,457,458,459,460,461,462,464,466,467,468,469,470,472],mode_fast:269,mode_norm:269,model:[38,55,62,90,91,93,100,120,129,170,184,187,195,197,206,253,260,273,284,293,308,320,328,337,343,366,380,392,408,409,412,428,429,455,456,458,459,460,461,466,468,469,470,471,472,473],moder:[86,91,99,106,225,288,292,307,321,458,459],modern:[64,74,79,101,105,129,133,144,178,179,195,236,257,296,312,339,343,370,403,442,453,456,460,462,463,466,467,470,471,472],modest:[187,447],modf:275,modif:[21,56,58,60,65,70,75,79,104,113,124,170,189,222,227,235,246,249,252,265,268,271,279,284,292,293,294,298,308,326,333,335,340,342,344,359,363,373,406,407,419,422,442,446,455,461,463,466,467,468,469,470,472],modifi:[5,9,21,22,30,57,58,60,62,64,65,66,70,74,75,79,81,82,83,84,85,86,93,94,95,96,99,103,104,108,109,110,113,118,122,124,125,138,140,143,159,161,168,174,177,178,185,186,187,190,193,197,198,199,202,204,206,209,212,217,227,246,248,254,265,266,267,268,271,273,274,282,284,292,293,297,301,304,308,309,310,316,321,323,326,329,330,331,333,337,339,340,342,343,346,347,350,355,359,363,366,372,373,375,380,381,385,386,387,391,392,393,394,397,402,404,406,407,413,414,417,418,420,421,422,423,424,425,428,430,431,432,436,437,438,442,446,449,451,452,453,456,457,459,461,462,463,464,465,466,467,468,470,471,472],modnam:[91,436,446,461,470],modul:[1,3,5,7,10,15,16,19,22,23,25,26,29,30,31,37,38,52,53,54,57,58,59,60,62,66,68,70,72,75,78,80,81,82,83,84,86,87,92,93,94,95,100,101,105,109,110,113,114,115,117,118,119,120,121,122,123,124,125,128,129,131,133,136,139,140,141,142,143,144,145,146,147,148,149,150,151,152,154,155,156,157,158,159,160,161,162,163,164,165,166,168,170,171,172,173,175,177,178,179,180,181,183,184,185,186,187,188,189,190,191,193,195,196,198,199,200,201,202,203,204,205,206,207,208,209,210,213,214,215,216,217,218,219,220,221,222,223,224,225,227,228,229,230,231,233,234,235,236,237,238,239,240,241,243,244,245,246,247,248,249,250,251,253,254,255,256,259,260,261,262,263,264,265,267,268,269,270,271,273,274,275,276,277,278,279,282,283,285,287,288,289,291,292,293,294,295,296,297,299,300,302,303,304,305,306,307,309,311,312,313,314,315,316,317,318,319,320,322,323,324,325,327,328,329,330,331,332,333,336,337,340,341,343,344,345,347,348,349,351,353,354,355,356,357,358,359,360,361,362,363,364,365,366,367,368,369,371,372,373,374,375,376,377,378,379,380,381,382,384,386,387,388,390,391,392,393,394,395,396,397,398,399,400,401,402,403,404,405,408,409,410,411,412,413,414,416,417,418,419,421,422,423,425,426,427,429,430,431,432,433,435,436,437,438,439,440,441,442,443,444,445,447,448,449,450,451,452,454,464,472,473],modula:[84,86,274,436],modular:[62,90,93,103,174,467],module1:[77,456],module2:456,module_api_vers:41,module_cleanup:472,module_find:304,module_for_load:[252,468],module_from_spec:[251,252,381,469,472],module_functionnam:95,module_functionname_methoddef:95,module_glob:[264,397,472],module_logg:104,module_nam:[252,363,471,472],module_or_nam:304,module_rel:193,module_repr:[252,428,468],module_st:96,module_to_load:468,modulea:428,moduledef:96,modulefind:[62,253,281,472],modulei:428,moduleinfo:[304,470],modulenam:[10,77,79,85,91,101,446,472],modulenotfounderror:[22,214,252,428,470,471,472],modules_cleanup:363,modules_setup:363,modulespec:[41,62,93,252,304,326,355,428],moduletyp:[41,252,381,424,428,459,469],modulex:428,modulez:428,modulo:[35,104,187,214,227,291,346,373,424,426,448,459,463,466,472],modulu:[156,346,355,462,466],mohd:472,mohr:[471,472],moin:[86,90,453,460],mojam:422,mojibak:472,molesti:151,mollusk:232,momemtarili:472,moment:[31,84,91,95,105,109,184,214,257,284,293,345,398,428,436,470],momentarili:[248,271],mon:[106,152,184,210,459],mon_12:265,mon_1:265,mon_decimal_point:265,mon_group:265,mon_thousands_sep:265,mondai:[152,184,265,268,367],monei:[187,350],monetari:[187,265,461,471,472],moneyfmt:187,monitor:[30,92,98,101,103,104,127,129,133,134,138,163,187,268,310,330,340,396,460,462,470,471,472],monkei:[122,386,387,472],mono:[119,143,295,351,398],monochrom:372,monograph:373,monolingu:232,monomorphic_oper:289,monophon:295,monospac:[248,365],monoton:[95,129,133,136,189,327,367,436,459,467,469,472],monotonic_n:[367,471,472],monsel:472,monster:[168,365],montag:184,montagn:468,montanaro:[422,456,459,460,461,462],month:[19,86,152,184,265,367,419,431,456,457,459,463,472],month_abbr:152,month_nam:[152,431],monthcalendar:152,monthdatescalendar:152,monthdays2calendar:152,monthdayscalendar:152,monthrang:152,monti:[79,168,193,227,261,298,359,419,435,450,460,462,466],moo:193,mood:212,moodi:[102,467,468,469],moolenaar:431,moon:292,moor:[458,459,462,468,469,471,472],more:[1,5,10,16,17,22,23,30,31,38,41,51,53,55,57,58,59,60,62,64,65,66,68,69,71,72,74,77,78,79,80,82,83,85,86,87,89,90,91,92,93,95,96,98,99,100,101,103,105,107,108,109,110,111,112,113,117,118,122,123,124,125,128,129,131,132,135,136,138,139,140,141,142,143,144,145,147,148,149,151,152,153,155,157,158,159,161,162,163,164,167,168,170,171,173,176,177,178,182,184,185,187,188,189,190,192,193,195,196,197,198,199,200,201,202,204,206,207,208,209,212,214,216,219,221,224,225,227,228,229,230,232,233,235,236,237,241,243,244,246,248,249,251,252,254,257,258,259,260,266,267,268,269,271,275,276,282,284,288,290,291,292,293,294,295,296,297,299,301,302,303,304,305,307,309,310,313,314,316,318,319,320,321,326,327,328,329,330,331,332,333,334,335,336,337,339,340,342,343,344,345,346,347,349,350,351,353,354,355,356,359,360,362,363,365,366,367,368,369,370,371,372,373,374,377,378,382,385,386,391,392,393,396,397,399,402,403,404,406,407,408,409,410,412,419,421,422,423,424,426,428,430,431,432,434,435,436,439,440,441,442,444,445,447,448,449,450,451,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],moreau:471,morecolor:212,moreov:[30,31,237,271,380,438,463,464,472],morph:293,morr:[463,465],morrison:[155,468],morsel:[62,255,462,469,471,472],mortem:[193,299,355,436],mosaic:400,mosh:[456,457,458,460],most:[5,7,14,22,28,30,31,35,38,41,52,53,54,57,58,62,64,65,66,70,72,74,77,78,79,81,82,83,84,85,86,87,90,92,93,94,95,97,98,99,101,102,103,104,105,106,107,108,109,110,111,113,117,120,122,128,129,135,136,139,140,141,143,144,145,147,149,150,151,153,155,156,159,161,167,168,170,176,177,178,184,185,187,189,190,192,193,195,197,198,199,201,202,203,204,206,208,211,212,214,215,216,222,223,225,227,228,229,232,234,235,236,237,241,244,248,249,251,252,253,254,255,257,258,260,261,265,266,268,269,272,275,279,284,288,289,291,292,293,294,295,297,298,299,301,304,305,307,309,310,312,316,318,320,321,323,328,329,330,331,334,337,339,340,342,343,344,345,346,347,349,350,351,353,355,359,361,363,365,366,367,368,370,371,372,377,378,380,382,384,385,386,387,388,392,397,398,399,400,403,404,405,407,408,410,411,412,413,418,419,421,422,424,426,428,430,432,436,437,438,439,440,441,442,444,445,446,447,448,449,451,453,454,455,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472,473],most_common:[161,463],most_recent_first:[378,471,472],mostli:[9,22,23,57,58,60,65,84,86,87,92,105,107,129,169,193,214,248,254,266,275,284,343,372,380,391,392,410,423,428,432,436,456,457,458,459,461,463,464,465,466,468,469,470,471,472],motejlek:472,motif:372,motion:[62,178,224],motiv:[74,95,424,426,457,459,460,467],motorola:[107,349],mount:[30,293,294,298,463,468,471,472],mountain:184,mous:[90,97,178,248,350,373,380,456,462,472],mouseinterv:178,mousemask:178,mousewheel:[248,472],mouzo:463,move:[65,69,82,84,90,91,95,97,102,107,110,113,122,124,157,161,177,178,180,184,190,197,206,207,219,229,237,248,268,271,279,293,299,313,320,333,363,367,372,373,380,385,387,391,392,410,422,435,447,456,457,458,459,461,462,463,464,465,466,467,468,469,470,471,472],move_fil:[65,472],move_to_end:[161,466,472],moved_perman:[242,460],movement:[161,178,237,380,462,466,472],moving_averag:161,mozilla:[1,110,244,343,392,400,460,472],mozillacookiejar:244,mp4:462,mp_ass_subscript:57,mp_context:[167,471],mp_film:261,mp_length:57,mp_subscript:57,mpdecim:467,mpeg:272,mpf:428,mplog:104,mptest:104,mpz:460,mro:[45,62,93,118,182,198,346,381,436,471,472],ms1361:159,ms932:159,ms936:159,ms949:159,ms950:159,ms_window:22,msbuild:[455,472],msc:[92,472],msd:187,msdn:[129,293],msec:[133,178,266,368,469],msft:342,msg297804:472,msg:[22,65,85,90,104,107,122,124,170,177,197,198,199,201,202,203,204,205,206,208,209,210,230,236,238,243,252,261,265,266,268,271,284,286,321,337,339,360,363,377,385,390,392,405,411,459,460,461,466,467,468,469,470,472],msg_:339,msg_flag:339,msgfile:201,msgfmt:[232,463],msgid:[201,210],msglen:[107,339],msgnum:249,msi:[65,66,282,455,461,469,471,472],msiclosehandl:282,msicolinfo_nam:282,msicolinfo_typ:282,msicreaterecord:282,msidatabasecommit:282,msidatabaseopenview:282,msidbopen_cr:282,msidbopen_createdirect:282,msidbopen_direct:282,msidbopen_patchfil:282,msidbopen_readonli:282,msidbopen_transact:282,msie:[110,245],msierror:[282,472],msigetsummaryinform:282,msilib:[62,253,401,461,462,472],msimodify_assign:282,msimodify_delet:282,msimodify_insert:282,msimodify_insert_temporari:282,msimodify_merg:282,msimodify_refresh:282,msimodify_replac:282,msimodify_seek:282,msimodify_upd:282,msimodify_valid:282,msimodify_validate_delet:282,msimodify_validate_field:282,msimodify_validate_new:282,msiopendatabas:282,msirecordcleardata:282,msirecordgetfieldcount:282,msirecordsetinteg:282,msirecordsetstr:282,msirecordsetstream:282,msisummaryinfogetproperti:282,msisummaryinfogetpropertycount:282,msisummaryinfopersist:282,msisummaryinfosetproperti:282,msiviewclos:282,msiviewexecut:282,msiviewfetch:282,msiviewgetcolumninfo:282,msiviewmodifi:282,mskanji:159,msoft:461,mss:472,mssdk:65,mst:184,msvc:[83,92,177,418,460,472],msvccompil:71,msvcrt:[62,92,177,253,401,462,463,472],msvcrtxx:83,mszip:282,mt19937:422,mt2002:422,mt_interact:360,mtime:[217,235,252,293,359,393],mtime_n:293,mtimeit:451,mua:[271,343,471],much:[0,17,22,31,50,57,61,66,74,79,81,82,84,90,91,93,95,97,99,104,105,106,107,109,110,122,123,129,138,153,156,159,161,168,172,177,187,190,193,195,204,208,222,227,232,236,237,248,254,257,260,268,269,271,275,284,292,293,295,296,297,301,305,310,321,328,331,339,345,356,370,373,378,385,386,387,407,408,416,421,428,435,436,442,447,448,456,457,458,459,460,461,462,463,464,466,467,468,469,470,472],mul:[99,113,143,187,260,284,291,417],mul_stereo:143,mulitprocess:472,mullend:[456,462],muller:463,mult:[92,124],multi:[7,15,30,31,62,77,79,90,91,92,93,99,104,106,109,114,120,141,151,152,187,189,190,193,227,228,248,252,260,266,267,269,284,305,318,321,324,327,332,333,346,366,368,404,417,419,431,437,441,444,445,446,451,455,456,461,463,467,468,472,473],multi_statu:242,multiarch:472,multibyt:[97,178,209,346,467,472],multical:[62,255,417],multicast:[258,339,363,395,472],multichannel:271,multicharact:95,multicontext:161,multidimension:[93,346],multifil:462,multihop:213,multilevel:[164,472],multilin:[106,159,168,248,321,337,385,466,472],multiline_valu:168,multilingu:[62,247,248,253,472],multimedia:[62,253,272,295],multipart:[153,195,197,198,199,200,201,205,206,207,208,472],multipartconversionerror:[200,207],multipartinvariantviolationdefect:[200,208],multipl:[11,30,41,43,57,58,62,64,65,66,68,69,70,72,74,77,79,81,82,84,90,91,93,94,95,97,99,105,106,107,108,109,110,111,117,118,122,123,126,127,129,138,139,141,144,151,153,159,161,164,168,170,176,178,182,184,187,188,190,193,200,206,210,212,220,222,223,225,227,230,232,236,237,246,248,252,253,254,257,260,261,266,267,269,271,275,276,279,283,284,291,292,293,299,301,302,304,305,309,316,318,320,321,322,330,331,332,337,339,340,342,343,344,346,349,354,355,363,366,368,370,372,373,374,376,380,382,385,395,396,397,404,406,410,412,416,423,424,425,426,427,428,431,432,437,438,439,441,445,448,449,451,455,456,459,460,461,462,463,465,466,467,468,470,471,472],multiple_char:109,multiple_choic:242,multiple_result:284,multiplex:[62,107,253,259,329,343,468],multipli:[43,78,82,143,167,177,184,187,200,268,310,320,346,347,355,416,426,440,456,459,460,462,466],multiplicand:[187,448],multiprocess:[62,90,103,107,165,167,248,253,268,318,343,366,395,404,418,463,464,472,473],multiprocessor:[90,305],multipurpos:[144,319],multiset:[161,466],multitask:165,multithread:[62,129,138,140,236,265,284,300,350,360,404,459,472],multitud:72,multiwai:99,mundan:435,mung:[62,364],munmap:38,murrai:[463,466,468,469,470,472],musi:[392,393],music:161,musl:472,must:[5,7,9,10,11,13,15,16,17,18,19,20,21,22,23,25,26,27,28,30,31,32,34,35,37,38,39,40,41,43,44,45,47,51,53,54,55,56,57,58,60,62,65,66,69,70,74,75,77,79,81,82,83,85,86,87,90,91,92,93,94,95,97,99,101,102,105,106,107,110,111,112,113,117,118,119,122,123,124,125,128,129,130,134,135,138,139,140,141,142,144,145,147,151,152,153,156,157,159,161,162,167,168,170,174,176,177,178,182,184,185,187,189,190,193,196,197,198,199,201,202,203,204,205,206,207,208,209,212,214,215,219,222,223,227,228,229,230,232,233,235,236,237,238,241,243,244,246,248,249,251,252,254,257,258,261,265,266,267,268,269,271,272,274,275,276,279,280,282,283,284,288,291,292,293,295,298,299,301,303,304,310,316,318,319,320,321,322,324,329,330,331,332,333,334,337,339,340,341,342,343,346,347,348,349,350,355,356,359,360,361,362,363,366,367,370,372,373,375,376,378,380,382,385,386,387,391,392,394,395,396,397,398,399,402,403,404,407,408,409,410,411,412,413,414,416,417,418,419,420,421,422,423,424,425,426,428,431,432,433,434,436,437,438,439,444,445,446,451,453,455,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472,473],mustard:65,mutabl:[5,25,26,31,57,62,84,91,93,99,161,162,172,177,188,204,216,227,228,254,284,291,293,301,317,331,399,410,421,423,424,426,432,436,437,438,445,456,459,461,462,463,464,470,472],mutablemap:[84,93,162,168,185,331,382,424,462,464,467],mutablesequ:[162,346,382,464,467,469,472],mutableset:[162,382],mutant:292,mutat:[21,57,91,161,168,182,197,227,229,252,257,284,331,346,382,387,397,438,458,460,468,472],mutate_flag:216,mutex:[90,117,127,139,355,472],mutual:[5,62,105,111,120,249,267,271,292,321,370,376,400],mvaddstr:97,mvderwin:178,mview:39,mvwaddstr:97,mvwin:178,mxbase:72,my_abstract_classmethod:118,my_abstract_method:118,my_abstract_properti:118,my_abstract_staticmethod:118,my_app:267,my_binary_fil:298,my_birthdai:184,my_bytes_object:91,my_callback:[79,81,292],my_databas:182,my_dealloc:81,my_decor:[228,461],my_dict:387,my_dir:168,my_filt:269,my_flag:193,my_funct:[113,437],my_logg:104,my_mock:386,my_modul:193,my_module_with_doctest:193,my_nam:386,my_pictur:168,my_proj_dir:466,my_python_lib:455,my_set_callback:79,my_str:91,my_text_fil:298,my_travers:26,myabc:118,myaddr:343,myapp:[92,103,104,168,236,370,418,469],myapplic:232,myarchiv:[333,448,466],myarg:350,myargumentpars:122,myargv:418,myattr:204,mybyt:208,mycertfil:343,myclass:[98,424,436],mycmd:350,mycmp:108,mycod:113,mycontext:170,mycookiepolici:244,mycustom:82,mydata:[227,366,408,448,466],mydequ:260,mydict:[84,91,382,460],mydir:[74,84],mydomain:[328,343],myemptyclass:437,myenv:396,myeventlooppolici:134,myextens:96,myextension_clear:96,myextension_method:96,myextension_travers:96,myextensionclass:456,myfavouriteshap:380,myfil:[151,257,293,385,419,436,439,448],myfilt:[104,466],myfoo:289,myfunc:[91,104,190,321,417],myfunct:[79,85,170],mygroup:343,myhandl:[103,104,267],myhtmlpars:241,myintegr:289,myiter:[118,382],mykei:267,mykeyfil:343,mylib:[103,385],mylink:298,mylist:[91,182,323,466],mylog:[232,465,466],mylogg:[104,266],mymanag:284,mymessag:[197,206],mymock:387,mymodul:[74,85,103,232,299,386,387,397,463,466],mymsg:[209,468],myobj:96,myobject:81,myoption:292,myorgan:343,myothercontext:187,myownfunct:177,mypackag:103,mypi:[91,105,469,470,472],mypickl:301,mypkg:[74,292],mypolici:467,myprog:419,myprogram:122,myproject:[104,385],myprotocol:135,myreadlin:85,myrec:107,myrepr:323,myright:[249,460],myscript:[85,299,310,434,451],myself:456,mysend:107,myserv:343,myshap:380,mysignatur:254,myskippedtestcas:385,mysocket:[107,261],mysql:[168,225,463],mysqld:[168,463],mystat:343,mysteri:[22,79,86,107,153,298,335,468],mystruct:[177,284],mysubclass:424,mysum:342,mysuperwhammyfunct:363,mytag:410,mytcphandl:340,mytest:[386,387],mytestcas:385,mytestcase1:363,mytestcase2:363,myth:81,myturtl:380,mytyp:[81,292,342],myudphandl:340,myvar:162,myxml:408,myzip:419,n1256:355,n42:292,n_cs_preced:265,n_in_sequ:55,n_sep_by_spac:265,n_sign_posn:265,n_token:374,n_wait:366,nada:95,nadeem:[467,468],nadikud:472,nagl:[463,472],naiv:[30,106,184,204,210,236,467,472],nak:179,nal2l:465,nal3l:465,nam:151,name1:461,name2:461,name2codepoint:[240,241],name:[5,10,12,13,16,18,19,22,23,25,26,27,28,30,31,38,41,45,48,51,53,54,55,57,58,60,62,65,66,69,70,72,75,77,78,79,81,82,83,84,85,86,90,92,93,94,95,96,97,98,99,101,103,104,105,108,109,110,112,113,114,115,119,120,124,129,135,136,137,140,142,145,146,148,150,151,152,153,154,155,157,158,164,167,168,169,170,171,176,177,178,179,182,183,184,185,187,188,189,190,193,195,196,197,198,201,203,204,206,209,210,213,214,215,216,217,219,221,222,225,227,228,230,231,232,233,234,236,238,239,240,241,242,243,244,245,246,248,249,250,251,252,253,254,257,258,260,264,265,266,267,268,269,271,272,274,275,276,279,280,282,284,285,286,287,288,291,292,294,295,297,298,299,300,301,302,304,305,306,307,309,310,312,313,314,315,316,320,321,322,323,324,325,326,327,329,332,333,334,335,336,337,338,339,340,341,343,344,346,347,348,349,350,351,353,354,355,356,357,358,359,360,361,362,363,366,367,370,371,372,373,374,375,376,377,378,380,382,384,385,391,392,393,394,395,396,397,398,399,400,402,403,404,407,408,409,410,411,412,413,415,416,417,418,419,420,422,423,427,428,429,430,431,432,434,435,437,438,439,441,442,443,444,445,446,447,448,449,451,455,456,457,458,460,461,462,463,464,465,466,468,469,470,471,472,473],name_dup:96,name_in_zip:363,name_last:342,name_length:96,name_of_c_funct:95,name_of_encod:95,name_of_modul:363,name_of_paramet:95,name_or_ordin:177,namealias:[384,431],nameconst:124,namednodemap:[62,273],namedsequ:384,namedtemporaryfil:[110,201,361,462,472],namedtupl:[55,62,93,119,183,212,288,301,304,305,321,330,338,346,349,351,355,378,381,382,398,438,462,463,465,468,469,470,471,472],nameerror:[22,104,177,214,251,252,299,425,426,432,439,445,446,456,457,458,461,472],namei:190,namelen:472,namelist:419,nameprep:[159,348],namer:[62,268],namereplac:[109,159,227,257,469,472],namereplace_error:159,namesak:465,namespac:[30,41,62,74,79,84,85,91,93,95,99,103,120,158,161,169,182,190,193,208,227,232,248,249,251,252,254,266,267,273,284,299,301,304,316,326,332,339,346,347,354,367,368,370,378,381,382,385,386,387,395,397,407,408,409,412,413,423,425,432,433,434,441,446,451,456,457,458,459,461,463,464,466,468,469,470,471,472,473],namespace_dn:[395,461],namespace_err:407,namespace_oid:395,namespace_separ:316,namespace_url:395,namespace_x500:395,namespaceerr:407,namespaceload:468,namespaceuri:[407,413],nan:[62,156,187,227,275,285,346,347,355,426,438,460,462,463,466,467,469,470,472],nand:458,nanj:[156,470,472],nannynag:358,nanosecond:[62,293,367,402,461,467,472],naoki:[469,470,471,472],napm:178,narg:[62,120,292,311,396,463,466],narr:193,narrow:[31,58,320,321,339,346,458,466,467],nasa:89,nasm:472,nasti:[107,423],nat:[225,467],natali:[463,467,468,469],nate:472,nathaniel:[469,471,472],nation:[63,422],nativ:[7,30,37,58,65,87,92,95,109,156,159,170,171,177,184,185,209,214,236,257,293,296,298,331,339,342,346,349,355,380,419,428,453,455,458,463,464,466,467,468,470,471,472],natp2:465,natur:[31,66,72,84,91,106,109,129,156,159,175,177,187,193,195,232,275,279,294,310,320,331,339,345,373,399,400,410,426,431,436,440,441,456,460,462,463,464,465,466,470,471,472],nav:462,naval:449,navarret:[469,472],navi:447,navig:[7,62,97,178,298,315,369,372],nb_absolut:57,nb_add:57,nb_and:57,nb_bool:[57,464],nb_divmod:57,nb_float:57,nb_floor_divid:57,nb_index:[43,57,461],nb_inplace_add:57,nb_inplace_and:57,nb_inplace_floor_divid:57,nb_inplace_lshift:57,nb_inplace_matrix_multipli:57,nb_inplace_multipli:57,nb_inplace_or:57,nb_inplace_pow:57,nb_inplace_remaind:57,nb_inplace_rshift:57,nb_inplace_subtract:57,nb_inplace_true_divid:57,nb_inplace_xor:57,nb_int:57,nb_invert:57,nb_long:57,nb_lshift:57,nb_matrix_multipli:57,nb_multipli:57,nb_neg:57,nb_nonzero:464,nb_or:57,nb_posit:57,nb_power:57,nb_remaind:57,nb_reserv:57,nb_rshift:57,nb_subtract:57,nb_true_divid:57,nb_xor:57,nbar:122,nbit:258,nbyte:[129,135,283,316,328,339,346],ncall:310,nchannel:[119,143,295,338,351,398],ncmdshow:[350,418],ncol:178,ncsa:392,ncurs:[90,97,178,456,457,460,472],ncurses6:472,ncursesw:[467,472],ncycl:260,ndata:[316,412],ndbm:[62,300,331,424,472],nde:346,ndebug:74,ndetail:193,ndiff:[189,193,457,458],ndigit:[223,227,424,472],ndim:[7,346],ndk:[470,472],neal:[288,459,461,462],nearest:[58,93,184,187,223,227,275,289,398,425,432,436,440,448,464,465,472],nearli:[103,105,107,141,168,185,187,268,299,380,424,458,459,462,463,464,466,469],neat:[436,458],neaten:472,neatli:[106,170,463],nec:151,necess:202,necessari:[30,31,45,57,58,65,74,78,79,82,83,84,85,86,90,91,93,99,102,103,104,105,106,108,111,113,117,122,135,141,144,145,156,159,162,168,170,178,185,187,193,195,196,197,206,207,208,209,210,212,214,227,229,243,244,248,249,252,253,257,260,265,266,269,271,272,275,279,284,288,291,292,293,301,304,308,310,318,333,337,339,342,343,346,348,349,350,356,357,363,365,366,368,371,373,380,382,385,392,396,399,402,404,405,407,409,412,416,419,424,426,427,432,435,436,438,449,455,458,459,461,462,463,465,467,468,469,470,472],necessarili:[22,31,65,66,77,78,82,86,91,92,107,111,117,178,187,193,197,206,227,271,275,284,293,301,321,328,339,342,343,345,346,355,367,381,386,404,407,412,432,455,459,461,462,463,472],ned:[109,463,466,468,472],need:[1,5,6,7,10,12,17,22,26,28,30,31,38,41,42,45,51,52,53,54,57,58,60,62,64,65,66,68,69,70,72,74,77,78,79,81,82,83,84,85,86,87,90,91,92,93,94,95,96,97,98,99,101,102,103,104,105,106,107,108,109,110,111,112,113,114,118,119,122,124,125,128,129,134,138,140,141,143,145,150,151,153,155,156,157,158,159,161,162,168,170,172,174,177,178,180,182,184,187,192,193,195,197,198,199,201,202,203,204,206,207,208,209,210,211,212,213,214,222,225,227,228,231,232,235,236,237,239,241,244,246,248,249,251,252,254,256,257,258,260,264,265,266,267,268,269,271,274,279,282,284,288,292,293,294,295,297,298,301,304,305,307,308,309,310,313,316,320,322,323,324,327,328,331,332,336,337,339,340,342,343,346,347,349,350,355,359,361,362,363,365,366,367,369,370,372,374,375,380,382,383,385,386,387,391,392,393,396,397,399,400,402,404,406,407,408,409,410,411,412,413,416,417,418,419,420,421,424,426,427,428,430,431,432,433,434,436,437,439,440,442,444,445,446,447,448,449,453,454,455,456,457,458,459,461,462,463,464,465,466,467,468,469,470,471,472],need_special_resourc:170,needforspe:461,needn:[30,321,349,471],needs_input:[151,269],neg:[7,17,22,28,34,35,41,43,49,57,58,60,65,95,99,106,108,117,122,123,135,138,151,152,155,156,159,161,163,177,178,179,184,187,210,223,227,228,257,258,260,261,265,269,275,279,284,291,293,301,310,320,321,322,329,333,334,342,343,346,347,350,366,367,370,377,380,407,424,426,432,437,438,442,445,456,459,460,461,462,463,465,466,467,468,469,470,471,472],negat:[14,43,187,291,293,346,426,438,472],negative_opt:65,negative_sign:265,neglect:[107,402],neglig:[346,422],negoti:[62,141,242,343,462,467,472],neighbor:[236,410,458,459],neighbour:91,neil:[456,457,458,459,461,463,466,469,470,471,472],neither:[30,65,75,82,95,102,106,131,135,144,159,182,187,193,197,206,210,227,243,261,266,269,271,275,286,292,293,297,301,320,340,343,346,373,376,385,392,400,422,424,426,451,468,470,471,472],nel:461,nelem:38,nelement:322,nelson:468,nemec:471,nemu:189,neophyt:91,nephew:456,neptun:212,nest:[5,62,79,84,91,93,99,103,106,114,140,161,170,177,188,189,190,193,200,212,254,260,261,271,284,297,299,309,314,316,321,346,347,354,366,373,385,406,410,412,423,424,426,431,432,436,437,441,442,445,448,451,456,461,462,463,465,466,467,468,469,470,471,472,473],nested_scop:[114,432,457,458],nester:472,net4:102,net6:102,net:[62,65,68,74,87,90,91,110,111,184,195,236,244,255,321,329,343,421,422,430,455,456,457,458,459,460,461,462,464,467,472],netbsd:[305,339,367,471,472],netherland:422,netlib:422,netlink:461,netloc:[391,463,466],netlog:463,netlogg:463,netmask:[102,258,469,472],netmaskvalueerror:[102,258],netrc:[62,218,225,253,288,458,468,469,472],netrcparseerror:286,netscap:[178,244,271,400,422,457,460,462,472],netstat:472,network:[62,89,103,107,109,110,111,125,126,127,132,135,137,141,143,146,185,213,248,250,253,255,268,284,288,293,301,305,324,329,337,343,349,359,363,391,392,395,402,406,411,417,428,439,442,457,458,459,462,467,469,471,472],network_address:258,network_authentication_requir:242,netzer:459,neufeld:472,neumann:424,neut:472,neutral:[58,74,79,102,253,468],neval:301,neve:[236,422,470],never:[5,17,26,30,31,38,54,55,57,62,70,79,81,82,91,93,94,95,97,99,103,105,106,110,111,122,129,131,134,135,136,139,140,141,143,145,153,159,164,167,168,170,171,176,177,178,182,184,187,189,197,200,206,212,214,227,232,237,241,243,244,246,248,252,254,257,258,261,264,265,266,268,274,279,284,292,293,294,298,299,301,311,316,318,320,321,324,326,329,333,335,340,342,343,346,349,350,359,360,363,366,370,381,382,386,391,392,397,399,400,404,407,410,412,419,424,428,431,432,436,437,440,446,451,453,456,457,458,459,460,461,462,464,466,468,469,470,471,472],nevertheless:[72,82,159,198,214,257,292,359,369,410,446,464],new_align:222,new_arch:418,new_attr:458,new_attribut:386,new_cal:386,new_child:[161,468],new_class:[381,467],new_compil:[65,418],new_diff:320,new_event_loop:[129,132,134],new_exc:214,new_f:109,new_featur:113,new_font:222,new_fram:143,new_funct:95,new_h_len:322,new_i:178,new_items:346,new_l:91,new_limit:[176,461],new_mailbox:249,new_margin:222,new_mock:[386,387],new_modul:251,new_nod:124,new_non_team_us:382,new_panel:180,new_path:90,new_prefix:258,new_rank:410,new_read:301,new_root:65,new_sig:254,new_siz:38,new_spac:222,new_str:321,new_struct:462,new_styl:222,new_target:170,new_val:363,new_valu:363,new_vector:382,new_x:178,newattr:[407,458],newbi:[92,461,463],newchild:407,newchildren:373,newcom:84,newdatatyp:81,newdatatype_cal:81,newdatatype_dealloc:81,newdatatype_getattr:81,newdatatype_hash:81,newdatatype_repr:81,newdatatype_richcmp:81,newdatatype_setattr:81,newdatatype_str:81,newdatatypeobject:81,newdict:91,newdoc:408,newenumnam:212,newer:[52,65,81,82,86,93,96,103,105,119,193,244,248,252,267,268,288,293,296,299,301,314,316,329,343,346,367,405,453,455,468,469,470,471,472],newer_group:65,newer_pairwis:65,newest:140,newfil:332,newfontset:372,newfrag:143,newfunc:[57,81,98,228],newgrad:108,newgroup:288,newindex:373,newkei:[386,387],newkeyword:228,newl:408,newli:[3,5,30,31,38,54,62,79,91,103,158,182,199,227,244,257,284,293,304,333,335,339,361,372,373,380,407,423,424,436,460,462,467,470,471,472],newlin:[23,62,65,85,93,106,122,144,147,148,151,158,160,176,178,189,193,197,208,219,222,227,235,248,252,257,261,264,266,268,269,271,279,288,298,301,309,321,332,339,340,346,350,357,361,365,367,368,374,375,377,378,397,408,416,418,419,423,427,431,433,442,445,448,451,457,460,461,462,463,464,468,470,471,472,473],newloc:466,newmailbox:249,newnam:[280,448],newnew:288,newobj:[399,472],newobj_ex:472,newpad:[97,178],newpart:9,newpath:280,newpathnam:370,newpric:161,newschem:372,newscmprio:372,newsgroup:[288,450,460],newsiz:[9,26,55,279],newsocket:343,newsread:271,newstat:143,newstream:332,newsyslog:268,newtab:28,newterm:178,newton:[245,321],newtyp:[62,188,470,472],newurl:392,newval:260,newvalu:[386,387],newwidth:143,newwin:[97,178],next:[1,7,22,30,32,33,38,57,62,74,78,79,81,82,84,86,91,93,95,97,99,102,104,105,106,109,111,113,119,125,128,129,140,143,145,151,153,155,157,158,160,161,168,176,177,178,187,189,190,193,195,196,197,198,206,212,214,219,222,223,227,228,229,232,237,243,244,248,252,254,256,260,266,268,269,271,279,283,284,288,292,293,299,309,310,316,320,321,322,327,331,332,334,339,340,342,343,346,347,350,359,372,373,386,387,392,395,397,410,423,424,425,426,428,430,432,433,435,436,437,438,439,443,444,445,446,448,455,456,457,458,459,461,462,463,464,465,466,467,469,473],next_control:282,next_minu:187,next_plu:187,next_toward:187,nextfil:219,nexti:260,nextkei:185,nextsibl:407,nfc:[109,384],nfd:[109,384],nfkc:[109,348,384,391,431,472],nfkd:[109,384],nfl:310,nfoo2:321,nframe:[119,338,351,378,398,451],nfs:65,ngettext:232,nginx:343,ngot:392,ngroups_max:472,nhost:[141,343],ni_:339,nibh:151,nice:[66,84,92,94,95,107,142,145,153,170,177,193,237,269,293,324,337,340,346,361,387,400,424,428,436,437,442,443,445,456,466,467],nice_len:269,nicer:[321,387],niceti:462,nich:97,nichola:[109,459],nick:[99,102,105,109,326,424,458,460,461,462,463,465,466,467,468,469,470,471,472],nicknam:[93,168,450],nicola:472,niehof:467,niemey:[232,458,459,460,461],nifti:459,nigetspamdata:83,night:168,nikhil:470,nikla:472,nikola:472,nikolai:[470,472],nikolau:[469,472],nil:[416,459],nim:380,nimstick:380,nine:[109,187,468],nine_year:184,ninth:457,nir:[463,466,467,471,472],nirina:463,nis:[62,253,388,461,472],nishimura:[320,422],nist:[236,459],nitem:[56,57],nitish:[471,472],nix:[451,471],nkeyboard:417,nl1l:465,nl_langinfo:[54,178,265,458],nlargest:[93,227,228,237,460,461,472],nline:178,nlocal:12,nlst:[225,467],nmh:271,nmsmallest:472,nnn:[227,241,392],nnnn:[469,472],nntp:[62,195,253,255,391,460,467,472],nntp_implement:288,nntp_ssl:[288,466],nntp_version:288,nntpdataerror:288,nntperror:[288,472],nntplib:[62,195,202,253,255,456,460,463,465,466,472],nntppermanenterror:288,nntpprotocolerror:288,nntpreplyerror:288,nntptemporaryerror:288,no_block:[10,96],no_bug:79,no_cont:242,no_data_allowed_err:407,no_modification_allowed_err:407,no_proxi:[392,472],no_sit:[355,466],no_strict_list_append:456,no_trac:363,no_type_check:382,no_type_check_decor:382,no_user_sit:[355,466],no_vot:442,noarch:72,nobodi:[79,153,236,246,337],noboundaryinmultipartdefect:200,nocbreak:[97,178],nodataallowederr:407,noddi:26,node:[62,85,236,237,241,263,273,293,294,297,298,305,339,343,353,373,374,395,408,409,410,412,427,448,456,459,461,462,463,466,470,471,472],node_depth:236,node_offset:[236,472],node_or_str:124,nodefaultroot:472,nodelai:[97,178],nodelist:[62,273,408,424],nodenam:[293,305,407],nodetransform:[124,462],nodetyp:[407,408],nodevalu:407,nodevisitor:[124,462],nodist:396,noecho:[97,178],noexpr:265,nofar:472,nofre:466,nois:[189,292,293],noisi:[96,292],nokia:296,noller:[462,465],nome:99,nomenclatur:[212,355],nomin:345,nomodificationallowederr:407,non:[2,5,7,9,10,11,17,21,22,26,28,31,34,35,38,41,45,55,57,58,62,65,66,68,72,74,77,79,81,82,85,86,90,91,93,95,97,98,99,101,103,109,110,118,128,129,135,141,144,145,148,151,153,157,159,167,168,176,177,178,179,184,185,187,189,190,193,195,197,198,199,200,201,202,203,204,206,207,208,209,210,212,213,214,222,225,227,228,229,230,231,232,234,235,236,237,238,243,244,246,248,249,251,252,257,258,260,264,265,266,267,268,273,275,276,279,284,285,286,288,292,293,294,295,296,297,298,299,301,304,305,308,310,313,316,318,319,320,321,322,328,329,332,334,335,337,339,340,342,344,345,346,347,348,349,350,355,356,359,360,363,365,366,367,374,382,385,386,387,390,391,392,395,396,397,398,400,412,416,421,422,424,426,428,429,431,432,433,436,437,438,445,446,450,451,453,455,456,457,458,459,460,461,462,463,464,465,466,467,469,470,471,472],non_authoritative_inform:242,non_exist:386,non_existent_fil:350,non_existing_attribut:386,non_nul:438,non_release_vers:305,nonadjust:367,nonam:[193,419],nonblock:[295,472],noncallablemagicmock:386,noncallablemock:386,noncod:103,noncompli:307,nonconform:404,nondeterminist:339,none:[3,5,15,22,28,30,41,50,51,52,53,57,58,61,62,65,66,74,79,86,91,93,94,95,98,99,103,104,106,107,108,110,113,114,118,119,122,124,125,129,131,134,135,136,137,138,139,140,141,143,144,145,148,151,152,153,154,157,158,159,160,161,162,164,167,168,169,170,171,173,174,176,177,178,182,184,185,187,189,190,193,196,197,198,201,202,203,204,205,206,207,208,209,210,211,214,217,219,222,225,227,228,230,231,232,235,236,237,238,243,244,245,246,248,249,250,251,252,254,257,258,260,261,264,265,266,267,268,269,271,272,274,276,279,280,282,284,286,287,288,289,291,292,293,298,299,301,302,304,306,307,309,310,313,314,316,318,320,321,322,325,326,328,329,330,331,332,333,334,335,336,337,338,339,340,342,343,345,346,347,349,350,351,355,356,359,360,361,363,365,366,367,368,370,372,373,376,377,378,380,381,382,385,386,387,391,392,393,394,395,396,397,398,399,400,402,403,404,407,408,409,410,411,412,413,414,416,417,418,419,420,423,424,426,427,428,431,432,433,437,438,446,449,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],nonempti:[157,321,346,380,400,424],nonetheless:[182,249],nonetyp:[94,95,169,228,321,342],nonexclus:422,nonexist:[404,472],nonexistentfil:298,noninfring:422,nonl:178,nonloc:[62,91,93,124,161,254,425,427,429,431,436,437,464,470,472],nonlocal_stmt:[427,432],nonmultipart:207,nonneg:[5,151,187,269,339,346,380,426,432],nonnorm:472,nonprint:[58,319,346],nonrandom:151,nonsens:[451,468],nonspac:[109,431],nonstandard:[342,447,461],nontrivi:[472,473],nonzero:[10,22,30,54,58,79,84,106,113,117,187,223,266,268,275,279,284,302,313,320,321,346,355,362,366,367,424,431,434,462],nonzerodigit:431,noop:[249,284,307,336,337],nooptionerror:[168,463],nop:[190,360,437],nope:[95,168,437],nopic:380,nopip:396,noqiflush:178,nor:[22,30,75,81,82,93,94,102,110,118,135,144,159,212,222,243,244,266,269,275,286,292,293,299,301,304,318,320,321,331,340,343,346,355,373,376,385,392,400,422,424,426,451,466,468,470,471,472],noraw:178,nordic:159,nores:380,noreturn:[382,472],norm:[275,431],normal:[3,5,6,19,21,22,24,25,27,28,30,31,34,41,45,51,53,57,60,65,66,74,75,77,78,79,81,82,90,91,93,95,97,98,103,104,106,107,109,110,111,112,114,118,122,140,141,142,144,145,147,150,152,157,159,161,168,170,177,178,182,184,187,189,193,196,197,199,201,203,206,209,210,212,214,215,219,221,227,228,232,236,241,243,248,249,252,253,256,257,265,267,268,275,276,283,284,288,292,293,294,297,299,301,304,306,310,313,316,320,321,322,323,326,332,334,336,337,339,341,342,343,344,346,347,348,350,355,361,363,365,366,367,371,373,377,380,381,382,384,385,386,387,391,392,397,399,404,407,408,411,412,413,416,418,419,423,424,425,426,427,428,430,431,432,434,436,437,442,451,455,457,462,466,467,468,469,470,471,472],normal_argu:386,normal_priority_class:350,normalize_whitespac:[99,193,258,367,391,466],normalizestr:472,normalvari:[90,320],normcas:[221,270,294],normpath:[65,270,293,294,463],north:[184,212,373,380,463,465,472],northampton:110,norvig:320,norwegian:[79,159,437],norwitz:[288,459,461,462],nos:459,nose:[385,463],nosectionerror:168,noshow:104,nosigint:[299,466],nostra:461,nosuchmailboxerror:271,not_:[99,291],not_a_child:386,not_a_test:387,not_accept:242,not_don:167,not_extend:242,not_found:[242,243,472],not_found_err:407,not_impl:242,not_modifi:242,not_submock:386,not_supported_err:407,not_test:[426,427],notabl:[31,62,64,86,93,138,190,284,342,388,397,450,457,458,459,460,461,462,463,465,473],notadirectoryerror:[22,214,293,446,467,472],notaft:343,notat:[62,84,93,99,102,104,106,109,161,168,187,258,261,279,293,301,316,339,346,347,350,364,370,386,407,412,423,424,426,429,431,436,437,438,440,442,446,451,459,460,461,464,466,472],notation_nod:407,notationdecl:412,notationdeclhandl:316,notationnam:316,notbefor:343,notconnect:243,note:[5,7,14,19,21,22,26,28,30,31,36,38,41,42,44,45,49,54,57,58,60,62,65,66,68,69,72,74,75,78,79,81,82,84,85,90,91,92,93,94,95,96,97,99,101,103,104,105,106,107,109,110,111,113,117,118,122,123,124,125,129,134,136,138,140,141,142,143,144,152,153,156,158,159,161,162,164,165,168,170,173,176,177,178,179,182,183,184,185,189,190,193,195,197,199,200,201,202,205,206,209,210,212,214,215,216,217,221,222,223,225,227,228,229,230,232,233,234,235,236,240,241,243,244,245,246,248,249,252,253,254,255,257,258,260,261,265,266,267,268,269,271,275,279,284,285,286,287,288,290,291,292,293,294,295,297,298,299,301,302,303,304,305,307,308,309,310,311,318,319,321,323,324,326,329,332,333,335,336,337,342,345,346,347,349,351,354,355,359,360,362,363,365,366,367,368,369,370,375,377,382,385,386,387,391,392,395,396,397,398,399,400,402,404,406,407,410,411,412,413,416,417,418,419,420,422,423,426,427,428,430,431,432,433,434,436,437,438,439,440,442,443,445,446,447,451,455,456,458,459,460,461,462,463,464,467,468,469,470,471,472],note_track:329,notebook:[62,369,372,472],notebooktabchang:373,notemptyerror:271,notepad:[159,431],noteq:124,notequ:374,notest:419,noteworthi:[271,441,456,457],notfounderr:407,noth:[22,30,31,53,65,74,78,79,81,84,85,94,95,103,104,106,107,110,111,117,125,134,137,140,142,156,170,178,182,184,189,190,193,199,211,214,222,225,228,241,248,249,251,252,257,265,266,268,271,283,284,292,297,301,307,333,334,336,340,343,346,348,351,360,366,370,385,396,404,414,422,424,426,431,432,435,436,437,444,446,449,451,458,459,462,463,468,469,472],notic:[1,31,69,74,75,79,82,84,94,95,103,104,106,107,108,110,111,113,125,134,135,159,168,174,185,187,203,219,229,233,252,257,268,284,333,339,355,356,363,370,382,422,424,426,436,438,444,449,455,457,459,463,466,467,471,472],notif:[29,61,62,330,397,402,412,456,463],notifi:[103,105,136,139,140,248,249,284,366,399,472],notify_al:[139,366],notify_by_email:382,notimeout:178,notimpl:[45,62,118,169,184,212,214,228,252,289,386,402,424,446,463,464,468,472],notimplementederror:[22,125,135,169,184,214,244,251,252,266,284,293,298,320,336,343,382,402,419,446,468,470,472],notin:124,notion:[53,65,92,111,134,184,187,189,193,227,301,346,373,407,411,426,430,433,434,466],notori:399,notset:[103,266,267,284],notstandalonehandl:316,notsupportederr:407,notsupportederror:[342,472],nottingham:448,nottinghamfolk:448,notwithstand:[74,422,456],noun:[347,436],noutrefresh:[97,178],nov:[99,184,210,225,246,343,367,447,458,470],nova:449,novalu:212,novel:[256,458,459,461],novemb:[84,184,431,440,472],novic:[292,370],now:[1,22,30,31,35,38,45,54,56,57,58,60,62,65,66,74,75,78,79,81,82,84,86,90,91,92,93,94,95,97,98,103,104,105,106,107,108,109,110,111,112,116,117,118,119,122,124,129,135,137,138,139,140,142,143,144,147,151,153,155,159,161,167,168,170,171,176,177,184,185,187,190,193,194,201,203,206,213,214,216,219,223,225,227,228,235,236,241,243,244,245,246,249,252,254,257,261,265,266,267,268,269,271,279,283,284,288,292,293,294,295,299,301,304,306,307,310,311,313,315,321,329,330,333,334,336,337,339,340,342,343,346,347,349,350,351,355,360,361,366,367,368,370,374,377,378,380,381,385,386,387,391,392,396,397,398,402,408,410,416,417,418,419,421,422,424,428,431,432,434,435,436,437,438,439,440,441,442,445,446,447,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],nowadai:[237,359],nowak:459,nowrap:152,np0:465,npb:[159,459],npj:467,npn:[343,363,472],npy_:321,npy_myfunc:321,npy_relaxed_strides_check:472,npython:462,nrp3:465,nsec:368,nsecond:[257,445],nset:465,nsig:334,nsmallest:[93,227,228,237,460,461],nsmallposint:472,nswe:373,nsystem:301,nt4:462,nt_gnu_abi_tag:101,nt_gnu_build_id:101,nt_offset:374,nt_stapsdt:101,nt_user:[356,466],nteventloghandl:[62,103,120,267],nth:[7,260,373],nth_combin:260,nthree:189,nto:337,ntoh:[107,339,471,472],ntohl:[107,339],ntp:367,ntpath:[294,383,471,472],ntr:301,ntransfercmd:225,ntree:189,ntsc:468,ntwo:189,nubi:462,nuget:[62,452,471,472],nugetclidl:455,nuisanc:387,nuitka:84,nul:[5,7,57,95,177,178,179,238,268,293,298,316,355,416,466,467],null_ptr:177,nullcontext:[170,471,472],nullformatt:222,nullhandl:[62,103,104,120,465],nullimport:[251,355,428,467],nulltransl:[62,247],nullwrit:222,nulti:472,num:[14,104,124,178,187,228,232,241,249,284,292,302,343,347,382,437,438,462,463],num_act:260,num_address:[102,258],num_param:342,num_str:261,num_wait:320,num_worker_thread:318,numarg:78,numarrai:461,numba:80,number:[1,2,3,4,7,9,12,15,16,17,19,21,22,24,26,28,29,30,31,34,35,36,37,40,45,46,48,49,50,52,53,54,55,58,59,60,62,66,68,69,70,71,72,74,77,78,79,81,82,83,84,85,87,92,93,94,95,97,99,101,102,103,104,105,106,107,108,109,111,112,113,118,119,120,122,123,124,125,127,129,130,131,134,135,136,138,140,141,143,145,147,151,152,153,154,157,159,161,167,168,169,171,174,175,176,177,178,184,187,189,190,193,196,197,200,203,204,206,209,212,213,214,215,216,217,219,222,225,227,228,229,232,235,236,237,241,242,243,245,246,248,249,251,252,253,254,256,257,258,260,263,265,266,268,269,271,272,274,276,279,282,284,285,286,288,290,291,292,294,295,297,299,301,302,305,306,307,309,310,314,315,316,317,318,321,322,323,324,326,327,329,332,333,334,336,337,338,339,340,341,342,343,344,345,346,347,349,350,351,354,355,356,359,360,363,365,366,367,368,370,373,374,375,376,377,378,380,381,382,385,386,391,392,395,397,398,399,400,402,403,404,405,407,410,411,413,414,416,419,424,426,427,428,430,431,432,433,435,436,437,438,439,440,441,442,444,446,447,448,449,450,451,453,454,455,456,457,458,459,460,461,463,464,465,466,467,468,469,470,471,472,473],number_class:187,number_of_process:284,number_of_subs_mad:321,numberstest:[385,468],numer:[2,7,29,37,43,57,58,62,74,86,91,93,95,99,103,106,107,109,110,125,145,147,149,156,176,178,183,187,190,210,213,214,222,223,227,234,235,239,241,243,246,253,261,265,266,284,291,293,297,310,312,316,320,321,327,332,337,339,343,345,347,353,355,370,373,374,380,384,385,386,390,392,410,416,419,421,426,438,440,442,445,447,457,459,460,461,462,463,464,466,467,468,469,472],numeric_compar:108,numeric_level:103,numeric_own:[359,469,472],numeric_typ:346,numeric_valu:227,numfre:462,numinput:380,numlin:189,numliter:113,nummessag:307,numpi:[2,62,72,91,123,301,446,449,455,461,462,466,467,469,472],nunc:151,nurpmeso:466,nut:107,nutshel:95,nwfu0wseb0krcjhdep:236,nworld:365,nxn:[99,458,459],nyberg:472,nyman:459,nzerodivisionerror:104,o32:111,o_append:[283,293],o_async:293,o_binari:[30,283,293],o_cloexec:[293,467],o_creat:293,o_direct:293,o_directori:293,o_dsync:293,o_excl:[293,361],o_exlock:[216,293,461,472],o_ndelai:[107,216,293],o_noatim:293,o_noctti:293,o_nofollow:293,o_noinherit:293,o_nonblock:[107,293,467,469,472],o_path:[293,468],o_random:293,o_rdonli:[227,283,284,293],o_rdwr:[293,334],o_rsync:293,o_sequenti:293,o_shlock:[216,293,461,472],o_short_liv:293,o_sync:293,o_temporari:293,o_text:[30,283,293],o_tmpfil:[293,361,468,472],o_trunc:293,o_wronli:[293,334],ob_bas:[53,82],ob_fval:82,ob_refcnt:[53,57],ob_siz:[53,57,472],ob_typ:[45,53,57,82,472],obei:[84,110,332,346,350,366,424,462],oberkirch:[469,471,472],obershelp:189,obj1:[81,460],obj2:[81,460],obj:[7,9,22,23,30,32,35,39,44,45,57,58,81,83,84,85,90,91,93,95,98,99,104,108,113,131,140,159,162,177,180,182,193,198,209,212,227,229,254,258,261,279,284,291,301,323,346,347,363,378,382,385,386,399,418,424,436,437,456,457,458,459,460,461,462,469,471,472],obj_or_typ:177,obj_tot:99,obj_underlyingdatatypeptr:81,objc:65,objdump:177,object2:96,object:[7,10,13,17,26,28,29,30,32,36,37,43,44,47,48,49,54,59,60,62,65,72,74,78,79,80,82,83,84,86,87,92,93,95,97,98,99,101,105,106,108,109,110,111,117,118,119,120,121,123,124,125,127,128,130,132,135,137,138,139,141,143,144,145,146,147,148,151,152,153,154,155,156,160,162,164,165,169,170,171,172,173,174,175,177,181,182,183,185,188,190,195,196,197,198,199,200,202,203,205,206,208,210,213,214,216,217,218,219,220,221,222,224,226,227,229,231,232,233,234,235,238,248,250,251,252,253,255,256,257,259,260,263,268,269,273,278,279,281,283,285,290,291,292,294,296,299,300,302,304,306,310,312,315,317,319,320,324,326,330,333,334,341,347,349,353,354,355,356,361,362,363,364,365,367,368,369,370,371,375,376,378,380,381,382,384,385,388,391,394,396,397,401,403,404,414,418,421,423,425,426,428,429,432,434,437,438,439,441,443,445,446,447,448,451,453,455,456,457,458,461,464,465,466,469,470,471,472,473],object_filenam:65,object_hook:261,object_list:284,object_pairs_hook:[261,463,465],object_to_patch:363,objectwis:456,objimpl:456,objn:460,objobjargproc:57,objobjproc:57,objtyp:98,oblig:456,obmalloc:[457,459,461,468,472],obscur:[184,193,386,462,468,469,471,472],observ:[3,72,101,104,209,298,320,380,391,432,449,458,467,472],observatori:449,observed_diff:320,obsolesc:307,obsolet:[66,74,79,97,123,153,159,214,244,261,266,305,308,316,346,355,367,386,397,405,416,449,456,457,458,461,463,466,468,469,470,472],obtain:[7,28,31,58,62,84,92,97,102,103,106,112,123,129,138,151,153,154,155,178,184,187,189,197,198,204,206,209,227,236,249,253,257,258,260,265,266,267,269,279,284,292,293,294,310,315,320,321,339,343,346,350,354,361,367,392,395,396,399,404,410,411,422,423,426,432,436,437,440,445,456,458,459,461,462,466,467,468,469,470,471,472],obtrus:472,obufcount:295,obuff:125,obuffre:295,obviou:[31,57,74,84,92,95,96,99,103,104,106,111,178,187,237,295,301,310,325,349,363,387,410,455,456,460,461,470,472],obvious:[57,65,66,79,91,95,104,106,111,168,266,292,305,386,436,456],ocaml:99,occas:[65,109,110,299,315,349,363,440,461,468],occasion:[72,78,84,90,91,92,95,122,123,170,178,187,189,202,206,232,248,271,275,292,293,366,369,432,436,448,456,461,462,466,472],occupi:[79,109,119,324,373,468],occur:[5,7,16,17,21,22,28,31,32,35,36,38,41,44,45,54,57,58,60,65,74,79,81,85,86,91,93,95,98,99,102,103,104,105,109,114,116,122,124,129,130,138,140,141,145,152,153,154,156,158,159,167,168,170,171,176,178,182,184,187,189,193,194,204,213,214,219,227,230,232,238,248,251,252,253,254,257,266,268,269,271,275,288,292,293,297,299,301,304,313,316,318,321,329,333,334,337,339,342,343,346,347,350,355,359,363,365,366,367,370,373,377,380,385,392,397,399,400,404,406,407,409,410,412,416,419,421,423,424,425,426,428,431,432,434,436,437,438,439,446,448,451,459,461,462,463,464,466,467,468,471,472],occurr:[49,58,65,84,91,94,103,106,123,124,161,168,178,187,197,206,230,271,291,292,320,321,329,346,359,397,410,424,425,426,430,431,432,442,458,460,461,464,466],ocert:[424,451],ochoa:472,ocsp:[343,468],oct:[91,99,104,111,184,225,227,343,347,355,368,424,446,458,462,464],octagon:380,octal:[106,113,153,185,227,258,292,293,321,346,347,431,456,457,459,460,462,464,466,472],octdigit:[347,431],octet:[102,201,207,246,258,307,347,391,395],octinteg:431,octob:[184,422,456,458,459,462],od1:[161,463],od2:[161,463],odd:[58,62,84,97,99,155,187,236,309,310,345,350,361,431,441,456,459,460,461,463,472],oddbal:292,odict:472,odomet:260,oem:[159,470,472],off:[62,65,84,90,93,95,97,98,99,103,105,106,110,111,113,125,157,168,177,178,184,189,190,201,209,210,217,227,237,244,248,266,267,268,275,290,292,294,303,307,310,320,332,337,342,346,355,362,363,367,368,373,380,385,386,392,417,424,428,431,432,436,437,441,444,446,448,456,457,458,459,460,461,462,464,466,468,469,470,472],off_t:308,offend:[92,425,439,457],offer:[1,30,57,64,71,72,79,80,87,90,91,94,97,98,99,102,103,104,109,110,111,158,161,162,173,187,217,225,233,236,237,253,257,260,268,271,284,294,298,299,318,320,321,322,326,333,336,339,346,350,367,386,392,402,405,413,422,435,439,442,447,448,455,456,457,458,459,460,461,462,463,466,468],offic:[74,195,422],offici:[30,87,159,196,210,236,276,295,343,408,416,424,453,455,456,457,458,461,463,466,467,469,471,472],offlin:[288,378,455],offload:284,offscreen:373,offset:[7,13,19,21,22,53,57,81,82,90,101,124,129,143,155,177,184,187,190,204,210,214,216,225,236,241,257,271,279,284,293,308,316,339,349,363,367,377,412,419,424,442,456,461,462,466,467,471,472],offsetof:[81,82],offvalu:370,oflag:362,ofs:177,often:[10,12,30,31,53,58,68,70,72,74,79,81,82,84,86,87,90,91,93,95,97,99,102,106,108,109,110,111,112,116,122,126,141,147,153,157,161,167,172,176,177,184,185,187,189,193,194,195,199,214,227,229,232,234,237,253,254,260,282,292,301,310,311,313,332,339,342,343,345,346,348,350,355,357,363,366,367,370,382,386,387,392,411,418,421,424,430,431,432,436,438,439,440,442,444,446,447,449,451,455,456,457,458,459,460,461,462,463,464,466,469,472],ogr:321,ohioe:90,oid:[343,395,399,472],okai:[30,122,168,265,404,446],okbutton:370,oktob:431,old:[2,5,9,29,35,38,41,54,55,58,62,79,84,91,93,95,96,103,106,113,118,122,124,148,153,161,178,188,197,206,214,227,228,244,249,251,252,261,267,268,270,271,276,284,292,293,294,301,306,310,331,334,343,346,347,359,362,363,366,377,378,380,386,392,404,407,412,422,423,424,426,431,432,438,441,445,454,456,457,459,460,461,462,463,464,465,466,467,468,469,470,471,472],old_arch:418,old_factori:[104,266],old_level:104,old_method:387,old_nod:124,old_password:168,old_path:90,old_snapshot:378,old_style_coroutin:140,old_valu:171,old_width:143,oldattr:407,oldchild:407,olddict:91,older:[52,62,64,65,79,81,86,87,97,122,133,165,178,187,189,203,229,232,236,248,267,288,293,295,296,297,299,301,305,316,320,329,342,343,355,363,392,412,419,428,440,453,456,459,462,463,466,467,468,469,470,471,472],oldest:[105,140,161,229,268,366,378,399,463,466,471,472],oldmailbox:249,oldmask:178,oldmodul:363,oldnam:280,oldpackag:461,oldpath:280,oledl:[177,462],oleg:[461,472],oliph:[461,462,463],oliv:[456,472],oliva:472,olivedrab1:373,olivedrab2:373,oliveira:472,olivi:472,olsen:[90,462,463],olson:[184,472],omar:[470,471,472],omf:[92,111],omg:[407,408],omiss:[254,316,339,472],omit:[22,53,55,62,65,81,84,93,95,104,106,119,122,123,129,141,155,161,168,176,178,183,184,189,193,202,203,205,222,225,227,232,235,246,249,251,257,258,264,265,271,276,279,284,288,292,297,299,301,307,316,320,321,322,329,332,333,335,337,339,346,347,349,359,373,377,379,380,385,386,397,398,406,410,411,418,422,423,424,426,431,432,439,442,445,455,459,460,461,463,464,467,468,470,471,472],omit_suffix:363,on_con_lost:135,on_error:382,on_fals:91,on_or_off:193,on_success:382,on_tru:91,onc:[5,7,21,22,26,30,31,51,54,57,58,75,78,79,81,82,84,90,91,92,95,97,99,103,104,105,106,108,109,111,118,119,122,125,129,131,135,139,140,141,142,151,153,157,159,160,161,164,167,168,170,187,189,193,197,206,212,219,222,225,232,237,241,246,248,251,252,254,257,260,266,267,268,269,271,284,288,292,293,295,301,308,310,316,318,321,322,329,330,333,334,335,339,340,342,343,346,349,359,366,368,370,378,385,386,387,392,396,397,399,400,404,407,408,410,412,413,421,423,424,426,428,432,435,436,437,446,449,450,451,455,456,457,459,460,461,462,463,464,466,467,469,471,472],onceregistri:472,onclick:380,ondrag:380,ondrej:459,one:[1,3,5,7,9,10,12,14,17,22,23,24,28,30,31,33,38,39,41,43,45,51,52,53,54,55,57,58,65,66,68,69,72,74,75,77,78,79,81,82,83,84,85,86,90,92,93,94,95,96,97,98,99,102,103,104,105,106,107,109,110,111,113,117,118,119,122,123,124,125,129,132,135,136,137,138,139,140,141,143,144,145,147,151,152,153,155,156,157,158,159,161,166,167,168,169,170,171,172,174,176,177,178,182,184,185,187,189,190,193,195,196,197,198,199,201,202,203,204,206,207,208,209,210,211,212,214,216,217,219,222,223,225,227,228,229,230,231,232,235,236,237,243,244,246,248,249,251,252,254,257,258,260,261,264,265,266,267,268,269,271,272,274,275,276,279,282,283,284,288,289,291,292,293,294,295,296,297,298,299,301,302,303,304,306,309,310,313,316,318,320,321,322,324,327,328,329,330,331,332,333,334,335,336,337,338,339,340,342,343,344,345,346,347,349,350,353,354,355,356,359,360,361,362,363,365,366,367,368,370,372,373,375,376,378,380,381,382,384,385,386,387,391,392,395,396,397,399,402,404,405,406,407,408,409,410,412,416,419,421,423,424,425,426,428,430,431,432,433,436,437,438,439,440,442,444,445,446,447,448,449,450,451,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],onecmd:157,onelineexceptionformatt:104,onerror:[293,304,333,471],ones:[58,64,65,79,81,91,93,94,96,104,106,111,113,159,161,168,189,201,212,232,241,244,276,292,321,331,339,342,346,350,355,363,367,373,386,392,397,404,428,445,455,456,457,458,459,460,463,465,467,468,469,470,472],oneself:124,ongo:[455,471],onion:342,onkei:380,onkeypress:380,onkeyreleas:380,onli:[0,3,5,6,7,9,21,22,23,26,28,30,31,34,35,37,38,39,41,44,45,47,49,52,53,54,55,56,57,58,60,62,64,65,66,69,70,71,72,74,75,77,78,79,80,81,82,83,84,85,86,90,91,93,94,95,96,97,98,99,101,102,103,104,105,106,107,108,109,110,111,112,113,115,117,118,119,122,123,124,125,129,131,133,138,139,140,141,142,143,144,145,147,148,153,155,156,157,159,161,162,164,166,167,168,170,171,172,176,177,178,180,184,185,187,189,190,192,193,195,196,197,198,201,202,203,204,205,206,207,208,209,210,212,213,214,215,216,217,219,222,225,227,228,229,230,232,233,235,236,237,238,243,244,245,246,249,251,252,254,256,257,258,259,260,261,262,265,266,267,268,269,271,274,275,276,279,282,283,284,287,288,291,292,293,294,295,297,298,299,301,303,304,305,306,307,309,310,311,312,313,315,316,317,318,320,321,322,324,327,329,331,332,333,334,337,339,340,342,343,344,345,346,347,348,349,350,351,352,355,358,359,361,362,363,365,366,367,368,369,370,372,373,375,376,377,378,379,380,381,382,385,386,387,391,392,394,395,396,397,398,399,400,401,402,404,407,408,409,410,411,412,413,416,417,418,419,420,421,422,423,424,425,426,428,430,431,432,434,435,436,437,438,439,440,442,444,445,446,447,448,451,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,472,473],onlin:[62,86,105,188,253,296,370,380,396,411,422,437,458,462],onreleas:380,onscreenclick:380,ont:299,ontim:380,onto:[65,107,111,170,176,178,190,222,237,249,301,309,332,348,380,385,387,418,428,440,456,462],ontosi:416,onvalu:370,onward:[99,104,187,223,254,297,334,346],oob:141,ooi:82,ooo:431,oop:[193,439],oor:177,op1:426,op2:426,op_:343,op_al:343,op_cipher_server_prefer:[343,467,472],op_enable_middlebox_compat:[343,472],op_no_compress:[343,467,472],op_no_renegoti:[343,472],op_no_sslv2:[343,466,472],op_no_sslv3:[343,472],op_no_ticket:343,op_no_tlsv1:343,op_no_tlsv1_1:343,op_no_tlsv1_2:343,op_no_tlsv1_3:[343,472],op_single_dh_us:[343,472],op_single_ecdh_us:[343,472],opaqu:[10,30,31,68,118,257,316,330,344,405,410,442,457,466,468,471],oparg:190,opcod:[30,62,189,263,301,302,355,424,459,460,462,463,468,470,471,472],opcodeinfo:302,open:[1,23,30,37,60,62,65,66,69,72,79,84,86,87,90,92,93,95,97,99,103,104,105,106,109,111,112,113,119,122,132,135,141,142,150,151,153,157,159,161,168,170,176,178,184,185,189,201,208,209,213,214,215,216,219,220,222,225,227,232,235,241,242,243,244,246,248,249,250,251,252,253,254,255,257,264,265,266,267,268,269,271,274,276,279,282,284,288,293,294,295,296,298,301,303,304,306,307,311,315,316,320,322,324,328,329,331,332,334,336,337,339,342,343,344,346,350,351,355,357,359,360,361,363,366,370,372,373,375,377,380,382,386,387,389,394,398,400,402,408,410,411,413,416,418,419,422,424,429,431,434,436,437,439,442,446,447,448,451,453,455,456,457,459,460,461,462,463,464,465,466,467,468,469,470,471,472],open_binari:252,open_connect:[127,129,135,137,469,471,472],open_flag:185,open_func:461,open_item:461,open_new:[400,461],open_new_tab:[400,461],open_osfhandl:283,open_resourc:252,open_text:252,open_unix_connect:[127,137],open_unknown:392,open_urlresourc:363,openbsd:[62,225,293,367,452,469,471,472],opencsw:454,opendatabas:[282,472],opendir:293,openerdirector:[62,110,255,468],openexr:[250,469,472],openfp:[351,398,471,472],openhook:[219,461],openid:1,openkei:402,openkeyex:402,openlinux:472,openlog:357,openmix:295,openmp:472,openpti:[293,311],opensolari:[62,452],opensourc:422,openssl:[62,236,238,343,363,456,461,462,463,466,468,469,470,471,472],openssl_add_all_algorithms_noconf:472,openssl_cafil:343,openssl_cafile_env:343,openssl_capath:343,openssl_capath_env:343,openssl_no_ssl2:343,openssl_no_sslv3:343,openssl_no_tlsext:343,openssl_vers:[343,463,466],openssl_version_info:[343,463,466],openssl_version_numb:[343,463,466],opensus:454,openview:282,openvm:[279,459],oper:[5,7,15,22,23,29,30,31,33,37,38,43,45,49,57,58,59,60,62,66,70,71,72,74,75,78,79,80,81,82,83,86,87,89,90,93,95,97,103,104,105,106,107,109,110,111,112,113,114,121,122,123,124,128,129,130,131,132,135,136,137,139,140,141,143,145,146,149,153,156,161,162,167,168,169,170,174,176,177,178,183,184,185,187,190,195,196,197,201,202,203,206,208,209,211,212,213,214,216,217,220,221,222,223,225,226,227,229,232,237,238,243,246,248,252,253,255,256,257,260,265,266,268,269,271,274,275,276,284,290,294,295,297,301,308,310,311,315,316,318,320,322,324,328,329,331,332,334,336,337,339,342,344,345,349,350,355,359,360,361,362,363,364,366,373,375,381,382,387,388,391,392,396,397,400,401,402,404,406,407,408,410,413,416,419,422,423,424,425,427,428,429,430,432,435,436,437,438,439,440,441,442,444,445,446,451,455,456,457,459,460,461,462,463,466,470,471,472,473],opera:[161,400,461,472],operand:[57,62,94,124,159,184,214,227,266,290,291,346,424,426,432,439,445,458,463,464,466,467],operation:466,operationalerror:342,opid:45,opinion:[93,456,461],opmap:190,opn:426,opnam:[91,190,468],oppon:237,opportun:[135,159,327,387,455,472],oppos:[31,65,82,93,95,97,106,129,158,202,209,225,339,392,428,462,469],opposit:[94,99,106,109,161,210,321,380,424,456,462,464,472],ops:[30,103,124,343],opt:[68,74,78,111,168,230,252,292,308,340,370,428,446,451,459,462,463,466,468,469,471,472],opt_flag:177,opt_str:292,optcr:168,optic:466,optik:[459,460,461],optim:[31,38,53,60,62,65,66,82,91,95,106,131,135,143,159,161,164,178,190,227,229,236,238,244,251,252,254,260,264,293,301,302,310,313,342,354,355,363,366,367,419,424,432,446,447,455,456,458,472,473],optim_args_from_interpreter_flag:363,optimi:472,optimis:424,optimized_bytecode_suffix:252,option:[5,16,22,30,43,45,53,54,57,60,62,64,65,66,68,69,70,71,72,78,79,81,84,87,92,93,97,99,103,104,106,107,108,109,110,111,112,113,114,117,120,121,123,124,128,129,131,137,138,139,140,141,142,143,144,147,152,153,154,155,157,158,159,161,164,167,168,169,170,171,173,174,176,177,178,182,184,185,186,187,188,189,190,196,197,198,201,202,203,205,206,207,208,210,211,212,214,215,217,219,222,223,225,227,228,229,232,235,236,237,239,243,246,249,250,252,253,254,256,257,258,260,263,265,266,267,268,269,271,272,276,279,282,284,285,288,293,294,295,298,299,301,307,309,310,311,312,313,314,315,316,318,319,320,321,324,325,326,327,329,330,331,332,333,334,335,336,337,339,342,343,345,346,347,348,350,352,355,356,357,358,360,363,365,366,367,368,369,372,375,377,378,380,381,382,386,387,391,392,395,396,397,400,404,408,410,411,412,414,416,417,418,420,421,423,424,425,426,428,430,431,432,433,434,437,438,439,442,444,445,446,448,449,450,452,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,471,472],option_class:292,option_list:292,option_str:122,option_t:65,optional_var:124,optionalreleas:114,optionconflicterror:292,optioncontain:292,optiondummi:65,optionerror:[122,292],optionflag:[193,363],optiongroup:292,optionmenu:[372,472],optionpars:[122,292,459,461],optionvalu:292,optionvalueerror:[122,292],optionxform:168,optlen:[339,470],optlist:230,optnam:[339,470],optpars:[62,94,120,253,352,460,461,463,466,470,472],optparse_pars:292,optval:339,or_:[99,291],or_expr:[426,431],or_test:[426,427],oracl:[185,342,461,467],oran:472,orang:[161,291,380,438,472],orchestr:[104,385],ord:[97,109,177,179,227,342,346,386,424,426,431,446,456,462],order:[1,4,7,23,26,28,30,39,41,54,57,58,62,65,68,70,74,75,78,79,81,82,84,92,93,94,95,97,99,101,102,103,104,106,107,108,109,110,111,113,118,120,122,123,124,128,129,135,136,140,142,146,149,151,153,155,157,159,161,167,168,170,172,176,178,179,180,182,184,185,187,188,190,193,197,201,203,204,206,209,212,215,219,222,226,227,229,230,231,232,233,234,237,242,246,248,249,251,252,253,254,256,257,258,260,261,265,266,267,268,271,282,284,288,291,293,295,297,298,301,304,306,310,311,312,315,316,318,320,321,327,332,334,335,337,339,340,341,342,343,345,346,347,350,351,352,355,359,361,363,365,366,367,370,373,378,380,381,382,385,386,391,392,395,397,399,404,407,408,410,412,418,419,421,423,424,425,427,428,429,431,436,437,438,439,440,448,451,455,456,457,458,459,460,461,462,466,467,468,469,471,472,473],ordered_attribut:316,ordereddict:[62,93,168,176,183,212,254,382,463,465,466,469,470,472],orderedenum:[62,183],orderedset:162,orderli:266,ordin:[58,109,159,177,178,179,184,212,345,346,467,469],ordinari:[97,103,106,123,153,170,193,227,235,302,321,331,334,358,359,386,399,410,428,431,432,436,456,467],ordinarili:[207,332],ore:189,ored:179,oreillynet:458,orels:[124,462],oren:[459,467,471,472],orendorff:[459,462],oreo:245,org:[1,62,64,66,69,71,74,77,81,84,85,87,90,91,93,99,104,107,109,110,111,112,123,141,161,168,170,185,225,228,236,240,241,243,244,248,249,260,284,288,309,315,316,329,337,339,342,343,346,355,356,370,383,384,391,392,393,395,396,400,408,410,412,416,422,424,427,431,436,440,441,447,449,450,451,452,453,454,456,457,458,459,460,461,462,463,466,467,469,471,472],organ:[62,86,90,99,103,104,106,188,193,256,257,343,370,422,428,459,472],organis:[64,103,112,237,266],organiz:[93,343,424],organizationalunitnam:343,organizationnam:343,orgnam:103,orient:[7,38,62,82,86,87,91,93,98,99,109,135,152,202,220,224,253,284,296,310,339,346,366,367,369,370,373,380,385,436,441,457,462,466,468],orig:[204,393],orig_kei:236,origin:[0,5,7,9,13,38,39,55,57,61,64,65,66,79,86,91,95,97,103,106,108,109,112,113,122,124,141,143,145,151,154,156,159,161,167,168,170,172,174,176,177,178,182,187,189,190,193,196,197,198,199,201,202,203,204,206,209,211,214,227,228,232,235,237,244,248,251,252,254,260,261,265,266,268,271,275,284,292,293,298,299,301,310,320,321,326,329,332,333,336,339,342,343,346,347,350,351,355,359,363,367,377,380,382,383,385,386,387,391,392,396,397,399,404,405,412,413,414,418,420,421,422,423,424,426,428,430,432,436,440,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,470,471,472],origin_req_host:[244,392],origin_serv:404,original_exc:214,original_list:172,original_valu:363,origni:472,ornar:151,orphan:[147,284,472],orr:472,orthogon:104,ortran:39,os2:466,os2_hom:466,os_arch:305,os_environ:404,os_nam:305,os_vers:305,osa:458,osaterminolog:462,osborn:468,oscon2001:90,oscura:461,oserror:[22,65,66,109,132,135,155,177,184,214,216,219,225,227,232,244,246,252,254,257,283,284,288,293,294,295,298,308,311,324,329,333,334,337,339,343,350,359,360,390,392,402,420,439,446,463,467,468,472],osf:467,oshmyan:472,osi:[74,309],osinfo:305,osnam:65,ospe:362,oss:[62,253,278,350,459,467,472],oss_audio_devic:295,oss_mixer_devic:295,ossaudiodev:[62,253,278,459,469,472],ossaudioerror:295,oststrom:472,osversioninfoex:355,osx:[177,339,392,468,471,472],other:[3,6,7,9,10,14,17,22,25,26,29,30,31,35,38,39,41,42,50,51,53,54,55,56,57,58,59,60,62,64,66,68,69,71,72,73,75,78,79,80,81,83,86,87,92,93,94,95,97,98,99,101,103,105,106,107,108,109,110,111,112,113,117,118,120,123,128,129,132,134,135,138,141,143,145,146,147,152,153,154,155,156,159,160,161,162,163,164,168,169,170,171,172,175,176,177,178,180,182,183,184,185,187,189,190,193,195,196,197,198,202,203,204,206,207,208,210,211,214,217,222,225,227,228,229,232,235,236,237,238,241,243,244,245,246,248,249,251,252,253,254,255,256,257,259,260,261,263,264,265,266,267,268,269,270,271,272,274,275,279,281,284,286,287,288,289,291,293,294,297,298,299,300,304,305,309,310,311,312,315,316,317,320,321,323,326,327,329,330,331,332,333,334,335,336,337,340,341,342,343,344,345,347,348,349,350,352,354,355,357,359,360,361,363,364,366,367,368,369,370,373,375,376,378,380,381,382,384,385,386,387,392,395,396,397,399,401,402,404,406,407,408,409,410,411,412,413,414,416,417,418,419,422,423,424,425,426,428,429,430,432,435,436,437,439,440,441,442,443,444,445,446,447,448,450,451,452,454,472,473],other_api:363,other_fract:223,other_fun:382,other_id_continu:431,other_id_start:431,other_path:298,otherexcept:214,othernam:[426,456],othertestcas:363,othertypeiknowabout:289,otherwis:[5,7,10,17,21,22,28,30,31,35,36,38,39,41,43,44,45,47,49,54,57,58,60,62,65,74,79,82,84,85,92,94,95,99,103,104,105,106,107,110,113,118,119,122,123,124,129,131,135,136,137,139,141,143,147,151,152,156,157,158,159,161,164,167,168,170,171,177,178,180,182,184,185,187,189,190,193,196,197,198,200,201,203,206,207,209,210,211,212,215,217,219,223,225,227,229,231,232,235,243,244,245,246,248,251,252,253,254,257,258,260,261,266,267,268,271,275,276,279,284,286,291,292,293,294,297,298,299,301,303,304,305,306,307,309,313,316,318,321,323,326,328,329,332,333,334,335,336,337,338,339,342,343,345,346,347,350,351,355,356,359,360,361,363,365,366,367,373,375,377,378,380,384,385,387,391,392,395,396,397,398,399,400,403,404,408,410,412,416,417,418,419,421,423,424,426,428,431,432,433,434,436,438,442,445,451,455,457,461,462,463,465,466,467,468,469,470,471,472],otkidach:459,otten:472,ouch:470,oudkerk:[462,467,468,472],ought:467,ouput:472,our:[28,31,75,79,82,91,94,95,104,106,107,109,110,136,168,170,177,197,201,206,237,258,292,301,321,337,340,343,363,386,387,399,404,410,419,427,436,458,461,462,472],ourselv:[82,472],oussoren:[461,462,463,466,468],ousterhout:370,out1:269,out2:269,out3:269,out4:269,out:[17,22,28,31,34,35,51,54,55,58,64,65,66,68,69,72,74,75,78,79,82,84,85,86,87,89,91,93,94,95,97,99,102,103,104,105,106,107,109,110,111,112,122,124,125,135,136,141,142,143,145,151,159,162,164,168,176,177,178,179,184,185,187,189,193,196,197,201,204,206,212,213,214,216,222,232,236,241,244,248,251,252,256,257,258,261,265,266,275,284,292,293,295,299,302,306,310,313,315,316,321,324,329,332,334,339,340,342,343,345,346,347,349,350,355,363,366,367,370,377,385,386,387,391,397,404,406,407,414,416,421,422,423,424,425,432,434,435,437,438,439,440,442,444,445,446,453,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],out_fil:394,out_test:143,outbound:107,outcom:[65,160,168,291,382,385,438],outdat:[86,105,177,252,369,462,466,471,472],outdent:95,outer:[11,91,93,170,187,190,208,241,254,355,423,424,425,431,432,436,439,464,466,467,472],outer_stack:170,outermost:[254,342,346,366,436,472],outfil:[91,122,142,261,292,303,376,448,465,466],outfp:202,outgo:[135,201,343,466,467],outlier:345,outlin:[45,65,103,118,140,168,245,343,380,472],outlinewidth:380,outliv:10,outlookmailbox:91,output:[5,9,14,17,30,54,57,58,60,62,65,66,79,81,82,84,93,94,97,99,101,103,106,107,109,111,113,119,122,125,128,129,135,138,140,141,143,144,145,147,148,150,151,152,153,154,157,158,159,161,164,168,170,176,177,178,184,188,189,190,193,196,201,202,203,205,209,210,211,219,220,225,227,230,236,237,238,241,243,245,246,247,249,253,254,257,260,261,266,268,269,275,277,280,284,288,292,293,295,297,301,302,303,304,305,307,309,310,311,315,316,319,321,324,327,329,332,334,335,337,339,340,343,346,347,350,351,355,356,358,359,360,362,363,365,367,368,369,375,376,377,378,382,385,392,394,395,396,397,398,399,404,408,410,414,418,419,421,424,431,432,434,436,438,440,441,445,446,449,451,455,456,457,458,459,460,461,462,463,465,466,467,468,469,470,471,472],output_charset:[196,197,232,463],output_codec:196,output_differ:193,output_dir:[65,359,419],output_fil:[65,310],output_filenam:65,output_libnam:65,output_prognam:65,outputcheck:[62,188,460],outputdata:143,outputdirectori:455,outputstr:245,outrat:143,outright:196,outset:462,outsid:[54,65,68,91,95,99,103,104,106,107,111,128,129,152,159,167,171,177,178,184,187,197,200,206,209,214,227,261,301,315,316,321,327,339,343,346,347,349,359,363,366,367,368,373,380,396,410,419,422,423,424,431,432,436,459,460,463,466,470,471,472],outsiz:472,outstand:284,outward:187,outweigh:91,outwin:472,over:[7,21,22,23,27,30,31,32,38,44,45,53,58,62,64,69,79,80,81,84,86,90,93,95,97,98,99,103,104,105,106,107,109,112,122,123,125,126,129,132,135,143,145,149,153,154,161,162,167,168,171,176,177,178,184,185,187,189,190,193,197,202,203,205,206,212,220,225,227,231,232,237,244,248,249,252,253,257,258,260,266,267,268,271,276,284,288,293,301,302,307,308,310,320,321,324,329,330,333,337,339,342,343,345,346,347,350,355,359,361,363,368,370,372,373,374,375,376,381,385,386,387,394,395,397,399,404,406,407,409,410,416,421,423,424,426,428,431,435,436,437,438,442,448,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],overal:[105,176,184,195,237,267,292,310,321,347,368,440,463,468,469],overalloc:346,overcom:[93,366,466],overcommit:324,overfil:472,overflow:[5,22,31,35,38,84,143,177,184,187,213,215,275,284,346,355,424,460,462,463,470,471,472],overflow_except:17,overflowerror:[22,35,43,117,158,160,184,187,193,214,227,261,275,297,306,339,346,366,367,424,446,458,459,462,463,465,467,468,472],overflowwarn:460,overhaul:472,overhead:[30,31,71,81,92,104,107,134,252,260,269,293,310,342,344,346,355,368,378,382,399,424,428,456,457,458,459,461,465,466,467,470,471,472],overkil:292,overlai:178,overlap:[58,97,106,162,167,178,189,227,258,283,292,298,321,346,432,436,457,458,472],overli:[99,130,458,472],overload:[57,129,228,382,392,416,424,426,457,458,468,472],overread:472,overrid:[21,30,31,45,57,60,62,65,68,74,95,98,103,104,110,111,118,122,129,134,145,152,157,158,161,162,168,172,176,177,182,184,193,197,203,204,206,209,210,214,219,227,228,232,241,244,245,246,249,251,252,254,257,261,266,268,272,284,287,292,301,313,316,317,320,321,332,335,336,339,340,346,347,355,361,363,366,373,380,382,385,386,387,392,395,399,404,410,414,419,424,425,426,428,436,451,455,456,459,462,463,464,465,467,468,470,471,472],overridden:[65,70,74,84,91,98,104,111,118,122,125,141,145,157,161,162,168,184,209,212,227,232,241,244,245,246,252,254,266,268,292,299,315,326,336,340,343,346,350,355,359,366,373,385,392,396,397,404,424,428,439,451,462,463,467,468,472],overriden:472,overrod:456,overrul:339,overrun:[458,463,472],oversight:[463,467,469,471,472],overview:[29,62,80,84,107,109,120,165,175,224,227,255,256,258,277,278,288,292,309,310,317,388,406,442,455,456,457,458,459,461,462,463,466,469,471,473],overwhelm:[94,292],overwrit:[31,79,84,95,103,104,113,151,161,164,178,197,201,206,266,269,293,322,331,346,359,392,418,423,424,437,438,454,455,459,462,463,465,466,467,468,472],overwritten:[75,95,104,111,244,271,298,310,333,355,382,423,463,467],owen:422,own:[5,7,9,22,23,26,30,31,54,57,58,62,64,65,66,68,72,74,75,78,79,80,82,83,84,86,90,91,93,94,95,97,99,103,104,105,109,110,111,112,113,115,120,122,125,129,131,135,141,153,161,168,170,172,176,182,187,193,197,201,204,206,208,211,212,227,229,232,244,248,252,257,266,267,268,271,284,286,292,293,298,299,310,320,321,328,332,333,339,342,343,346,347,350,355,363,365,366,370,380,385,391,392,396,399,400,404,407,410,412,416,417,421,422,424,426,428,431,432,436,437,439,443,446,449,451,453,454,455,456,457,458,459,460,461,462,463,465,466,467,469,471,472],owned_file_handl:104,owner:[31,75,79,101,104,161,284,293,298,333,344,359,422,424,448,470,472],ownership:[31,62,104,284,286,366,462,467],p_all:293,p_cs_preced:265,p_detach:293,p_nowait:[293,350],p_nowaito:293,p_overlai:293,p_pgid:293,p_pid:293,p_sep_by_spac:265,p_sign_posn:265,p_wait:[293,350],paalasma:458,pablo:[463,469,471,472],pace:[86,457,462],pach:472,pacif:184,pack:[62,104,123,143,146,177,190,216,227,235,248,253,258,267,268,271,305,339,346,370,371,373,405,418,424,436,438,447,448,461,463,466],pack_arrai:405,pack_bool:405,pack_byt:405,pack_doubl:405,pack_enum:405,pack_farrai:405,pack_float:405,pack_fopaqu:405,pack_fstr:405,pack_hyp:405,pack_int:405,pack_into:[227,349,461,472],pack_item:405,pack_list:405,pack_opaqu:405,pack_str:405,pack_typ:405,pack_uhyp:405,pack_uint:405,packag:[13,28,30,57,58,62,68,70,71,72,75,77,80,82,83,85,86,91,93,98,100,103,104,111,113,115,144,161,165,177,188,192,193,196,197,198,199,200,201,203,204,205,206,207,208,209,211,213,227,232,239,242,243,251,252,253,254,266,267,268,273,276,280,281,282,284,285,297,305,309,314,315,326,331,335,336,337,339,343,347,355,356,369,370,372,376,380,381,385,386,387,389,392,396,397,408,411,415,418,419,420,422,429,432,434,440,441,447,450,451,452,454,456,458,460,463,464,465,466,468,469,470,471,472,473],package_data:[74,75],package_dir:[65,69,74],package_test:385,package_url:309,packagenam:77,packard:[89,456],packed_ip:339,packer:[62,218,369],packet:[135,143,258,268,339,340,416,463,472],packet_:339,packet_broadcast:339,packet_host:339,packet_multihost:339,packet_otherhost:339,packet_outgo:339,packmail:456,pad:[62,90,144,155,178,184,187,197,200,235,236,339,346,347,349,351,370,373,392,405,442,456,459,462,463,466,470,472],padi:370,padnon:260,padx:370,pag:185,page:[0,1,17,58,62,65,74,86,87,90,91,97,99,104,107,110,111,117,122,127,128,129,132,135,137,152,159,167,170,174,178,189,216,227,229,248,253,256,257,266,267,268,271,279,293,296,306,315,316,324,329,334,339,342,344,349,357,362,366,367,370,372,388,392,400,404,410,417,419,421,422,428,430,436,447,449,450,451,455,456,458,460,461,462,463,466,467,470,471,472],pager:[169,315,472],pages:279,pagin:315,pai:[104,106,193,455,468],paid:456,pain:[106,265,456,461],painless:111,paint:[97,178,380,458],painter:178,pair:[5,7,21,26,30,36,58,62,65,70,74,79,81,91,93,97,99,102,106,109,122,129,132,135,137,141,143,145,153,156,161,168,178,182,185,187,189,190,193,197,198,203,210,212,223,227,230,232,237,241,245,254,258,261,271,275,284,288,293,294,299,301,311,324,333,339,340,343,346,350,356,359,360,363,364,366,370,372,373,380,381,382,386,391,392,399,404,407,410,413,414,424,426,431,432,437,438,457,458,459,460,462,463,464,465,466,467,468,470,472],pair_cont:178,pair_numb:178,pairwis:[260,380],pal:467,palard:471,palat:104,palin:437,palivoda:[470,472],palkovski:459,palmo:159,palomar:232,palumbo:472,pam:472,pan:[241,472],panama:410,panda:455,pane:[248,372,373,472],paneconfigur:472,panedwindow:[372,373,472],panel:[62,66,89,120,178,253,370,403,457,472],panelpars:462,panic:[268,459],panter:[469,470,472],pao:347,paolini:472,paper:[109,122,339,385,459],papert:380,paradigm:[83,99],paradox:[91,459],paragraph:[95,103,198,222,248,261,292,293,343,346,365,410,417,422,424,437,448,456,459,472],parallel:[62,65,90,93,99,127,131,136,138,161,164,165,166,208,227,236,253,260,380,385,398,400,410,448,456,463,466,467,468,469,472],param1:423,param2:423,param:[104,124,197,198,204,206,210,243,254,282,293,307,385,391,392,396,416,417,463,466,472],paramet:[5,7,9,10,11,13,14,16,21,22,25,26,29,31,33,40,41,45,51,53,56,57,58,60,61,62,65,80,81,84,85,93,96,99,103,104,106,109,113,117,119,120,122,129,131,136,137,138,141,143,145,147,148,149,151,152,153,158,159,161,164,168,170,171,173,174,178,182,184,187,189,190,193,197,198,199,200,202,204,206,207,209,210,212,214,215,216,217,218,219,221,225,227,228,230,232,235,236,237,238,241,243,244,246,248,249,251,252,253,254,257,258,260,261,265,266,267,268,269,271,272,275,276,279,282,283,284,288,292,294,295,297,298,299,305,307,309,313,314,316,317,319,320,321,322,324,327,329,331,332,333,334,336,337,339,340,342,343,345,346,347,348,350,351,354,357,359,360,361,363,366,367,368,369,372,376,378,380,382,385,386,387,391,392,393,394,396,397,398,399,400,402,403,404,407,408,409,410,411,412,414,415,416,417,419,421,423,424,425,426,427,428,432,437,438,451,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],parameter:[178,193,342,382],parameter_list:[423,426],parameter_list_stararg:423,parameter_nam:95,parameteris:104,parameterizedmimehead:204,parameterless:[329,436],paramflag:177,paramount:[95,187],paranoid:82,parcel:[370,373],pardir:[217,293],paren:[91,113,124,176,248,461,472],parenmatch:472,parent:[31,54,57,62,65,91,93,102,103,104,120,124,135,161,178,227,237,249,252,254,257,266,279,282,284,293,294,297,298,304,307,311,314,316,333,334,340,343,350,355,373,386,387,392,396,407,410,418,424,428,436,446,458,459,460,461,462,467,468,470,471,472],parent_conn:284,parent_modul:252,parent_nam:252,parent_pars:122,parentclass:424,parenth_form:426,parenthes:[5,62,74,79,85,93,95,99,104,106,158,190,249,251,252,265,305,310,321,346,396,424,430,431,432,436,437,438,439,443,445,456,460,461,462,463,469,471,472],parenthesi:[106,113,248,321,460,472],parenthesis:346,parentnod:407,pareto:320,paretovari:320,parg:78,pari:[99,106],pariti:105,park:321,parnassu:457,paroz:[469,472],parrot:[79,227,243,309,437,462],pars:[29,31,54,58,59,60,62,65,69,79,84,85,86,90,91,93,94,95,102,104,106,110,111,113,120,124,125,135,137,153,157,158,160,168,176,184,193,195,197,200,201,202,204,206,207,209,210,218,224,227,230,232,239,241,243,244,245,246,249,252,253,255,261,263,267,268,271,273,276,285,286,293,342,347,350,352,356,367,370,378,389,392,393,396,397,404,406,407,408,409,411,412,413,414,416,417,426,427,431,432,433,439,442,446,447,450,451,456,457,458,459,460,461,462,467,468,469,470,472,473],parsabl:467,parse_and_bind:[322,325],parse_arg:[62,94,120,161,189,201,230,292,311,396,459,463,466],parse_by_refer:95,parse_colnam:342,parse_config_h:356,parse_const:261,parse_decltyp:342,parse_envlist:472,parse_float:261,parse_head:[125,153,246],parse_int:261,parse_intermixed_arg:[122,471,472],parse_known_arg:122,parse_known_intermixed_arg:122,parse_multipart:[153,471,472],parse_q:[153,391,462],parse_qsl:[153,391,462],parseabl:[104,305,332],parseaddr:210,parsebyt:208,parsed:210,parsedate_to_datetim:[210,467],parsedate_tz:210,parseerror:[410,463,466],parsefil:316,parseflag:249,parser:[30,31,62,65,69,74,79,84,85,94,99,106,109,120,124,158,160,161,176,189,193,195,197,200,201,202,204,206,207,209,214,218,225,227,239,253,255,261,263,267,273,285,299,306,311,321,332,346,352,392,396,406,407,408,409,410,412,414,427,431,432,433,437,439,443,445,451,456,457,459,460,461,463,466,467,468,469,470,471,472],parser_a:122,parser_b:122,parser_bar:122,parser_class:122,parser_definit:95,parser_foo:122,parser_inst:168,parser_l:466,parser_list:411,parser_m:466,parser_prototyp:95,parsercr:316,parsererror:[297,406,472],parseresult:[391,463,466,472],parseresultbyt:[391,466,472],parsermodul:472,parsestr:[201,208,408,409,411,456,469,472],parsetok:[85,472],parsetupl:58,parsingerror:168,part:[5,7,9,14,19,22,30,35,44,52,53,55,56,57,58,60,62,64,65,66,71,74,75,78,79,80,81,84,86,87,91,93,97,99,102,103,104,105,106,107,108,109,110,111,112,114,118,124,125,144,145,150,153,156,158,159,160,162,168,170,177,178,184,187,193,195,196,197,198,199,201,202,203,204,205,206,207,209,210,211,212,220,227,232,236,248,249,251,252,256,257,258,260,265,266,267,268,269,275,276,282,283,284,293,294,297,301,304,309,310,316,319,320,321,325,332,335,339,340,342,343,346,347,348,355,363,366,367,369,370,372,377,380,381,382,385,386,387,391,396,399,400,407,408,410,416,421,422,423,424,425,426,428,431,432,436,437,438,439,440,441,443,445,446,449,450,451,452,453,455,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],part_info:202,part_numb:161,partak:436,partfil:201,parti:[7,23,28,30,31,62,65,70,71,72,84,86,89,90,91,93,104,111,112,129,134,135,177,182,185,227,236,266,284,293,301,321,331,343,355,356,366,376,382,385,392,396,397,399,422,441,453,455,456,457,459,460,462,463,465,466,467,468,470,472],partial:[0,23,62,95,99,109,110,120,125,129,130,131,137,161,178,182,188,198,207,208,226,227,249,252,253,254,260,268,269,273,275,324,326,339,340,343,346,350,406,456,459,460,462,463,464,465,467,468,469,470,471,472,473],partial_cont:242,partialmethod:[228,468,472],particip:[3,57,81,82,184,237,244,252,266,321,456,458,461,463,465],particular:[30,31,41,54,57,58,60,62,65,68,69,70,72,79,81,84,91,92,93,98,99,102,103,109,110,111,112,117,118,122,139,153,159,162,168,170,176,178,183,184,192,193,204,209,214,229,241,244,248,249,251,254,256,258,261,262,266,267,268,271,274,275,276,284,288,292,293,304,318,321,324,329,333,334,337,339,343,344,346,347,349,350,355,363,365,366,370,372,373,382,385,386,387,391,392,393,396,397,399,407,408,410,417,421,422,423,424,426,428,430,432,436,438,442,446,449,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],particularli:[64,65,78,84,102,106,110,111,122,284,292,293,299,310,328,340,350,356,385,386,391,442,445,450,456,457,459,460,463,464,466,468,469,471],partit:[149,260,320,346,461,469,472],partli:[236,258,466,470,471,472],partner:141,partnership:422,partnum:161,pascal:[84,86,91,99,349,423,436,437,438,445,459,463],pasechnik:472,pass:[5,7,9,10,13,15,16,19,22,26,30,31,32,38,39,41,43,45,47,53,56,57,58,60,62,65,66,74,77,78,79,81,82,83,84,85,90,93,95,96,97,102,103,105,106,107,109,110,111,112,113,114,118,120,122,123,124,128,129,131,135,137,138,140,141,142,143,145,147,151,152,153,156,157,158,159,161,164,167,168,169,170,171,172,174,176,178,179,182,184,189,190,193,197,198,199,201,202,203,204,205,206,207,208,209,210,211,212,214,215,216,219,222,225,227,228,232,235,236,237,238,243,244,245,246,248,249,251,252,254,257,258,260,261,265,266,267,268,269,271,272,275,279,280,282,284,286,288,292,293,294,295,297,298,299,301,307,308,309,310,311,313,316,320,321,322,323,324,327,331,332,333,334,336,337,339,340,342,343,345,346,347,348,349,350,354,355,356,359,360,361,363,365,366,367,368,370,372,373,375,376,379,380,381,382,385,386,387,391,392,396,397,398,399,400,402,404,407,408,409,410,411,412,413,414,415,416,417,418,419,421,423,424,425,426,427,428,429,431,433,436,439,441,442,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],pass_:307,pass_fd:[350,472],pass_stmt:[427,432],passag:370,passion:438,passiv:[141,225,254,455,457],passphras:328,passwd:[176,225,298,312,362,385,392,460,461,462],passwd_mgr:392,password:[62,86,110,120,234,236,249,253,268,284,286,288,293,294,307,328,337,343,360,362,388,391,392,416,419,461,462,463,467,468,469,470,472],password_mgr:[110,392],past:[86,93,95,104,111,122,184,193,217,248,293,298,301,316,347,350,367,404,421,447,455,466,468,469,472],pasv:225,pat1:67,pat2:67,pat:[106,469],patch:[1,62,74,84,90,94,97,101,106,122,188,243,288,363,406,454,456,457,458,459,460,461,462,463,465,466,467,469,470,472],patchcheck:[462,472],patcher1:386,patcher2:386,patcher:[62,188,387],patchlevel:[4,305],patel:471,path1:294,path2:294,path:[5,22,28,30,31,54,58,62,64,65,66,69,70,72,74,78,79,82,86,90,91,92,93,95,99,101,103,104,109,112,122,129,137,141,145,150,151,153,164,168,177,189,193,201,211,214,220,221,225,227,232,233,235,244,245,246,248,250,251,253,254,257,264,265,267,268,269,271,280,281,282,284,286,288,292,293,299,304,310,313,314,315,317,322,326,332,333,335,337,339,342,343,344,350,355,357,359,361,363,367,370,378,380,382,383,385,386,391,392,396,400,402,404,410,416,417,418,419,420,424,429,434,436,441,444,448,449,451,452,453,455,456,458,459,460,461,462,463,465,466,467,468,469,471,472],path_convert:472,path_hook:[28,93,252,304,355,428,446,459,467,468,472],path_importer_cach:[28,251,252,304,355,428,446,459,467,468,469,471,472],path_info:404,path_item:304,path_max:472,path_mtim:[252,467],path_return_ok:244,path_stat:[252,467],path_str:251,path_transl:404,pathbrows:472,pathconf:[293,467],pathconf_nam:293,pathentryfind:[93,252,428,467,468,471],pathext:[92,333,396,455,468],pathfind:[252,428,468,471,472],pathfix:472,pathlib:[62,164,220,233,252,253,293,294,418,472],pathlik:[54,58,93,227,252,293,294,298,470,472],pathnam:[28,62,65,74,84,90,153,177,220,221,225,227,251,253,266,268,270,280,282,293,308,332,342,343,344,355,359,361,370,372,392,394,419,420,424,451,466,469,472],pathname2url:392,patholog:[91,440],pathorfil:306,pathseg:298,pathsep:[293,335,376,400,451],pathwai:[466,472],patienc:284,patrascu:[470,472],patrick:462,pattern:[31,38,62,67,74,82,91,98,103,104,108,109,127,130,145,161,170,179,189,220,228,249,253,260,266,275,282,284,288,292,293,298,299,310,318,320,321,333,346,347,363,370,378,380,382,385,386,387,399,423,431,441,446,457,459,460,461,462,463,464,466,467,468,469,470,471,472],paugh:[469,472],paul:[90,316,455,456,457,458,459,461,462,463,467,468,469,471,472],pauliu:472,paulo:[467,472],paus:[97,99,132,135,138,178,295,299,334,426,460,461,472],pause_read:[132,135,471,472],pause_writ:[132,135],pawn:109,pax:[359,462],pax_format:[359,462],pax_head:359,paygrad:161,payload:[159,195,197,198,199,200,201,202,205,206,207,208,463,472],payment:[110,260],payment_requir:242,pbkdf2_hmac:[236,463,468],pbm:250,pbzip2:467,pcall:310,pcbuild:[66,363,455,462,472],pcm:295,pctp:460,pdb:[62,91,145,186,193,227,253,355,378,451,455,459,461,462,465,472],pdbrc:[299,466,470,472],pdf:[86,103,109,236,320,355,472],pdict:153,pdq:392,pdt:184,peac:380,peach:189,peak:[143,378,461],pear:[291,438,447],peculiar:[38,68,91,254,293,436],pedant:472,pedro:462,pedroni:[459,461],peek:[151,161,235,257,269,399,466,472],peeknamedpip:472,peel:201,peel_banana:65,peephol:[460,461,466,471,472],peer:[107,132,135,213,214,288,329,336,343,472],peercert:135,peernam:[135,137],peeter:470,peksag:[468,469,470,471,472],pellentesqu:151,pelleti:458,pem:[225,249,307,337,343,468,472],pem_cert_str:343,pem_cert_to_der_cert:343,pen:[62,224],penalti:[104,182,217,308,456,466],pencolor:380,pend:[30,35,75,81,93,129,135,140,167,222,237,251,257,271,282,307,329,334,343,421,426,466,467,468,470,472],pendict:380,pendingdeprecationwarn:[22,214,385,397,446,459,462,463,469,470,471,472],pendown:380,penelop:201,penguin:[232,423],penros:[380,472],pensiz:380,penstat:380,penteado:472,pentium:460,penultim:91,penup:380,peopl:[0,1,31,84,92,93,95,99,102,105,109,111,178,187,189,193,232,236,292,342,410,437,440,455,456,457,458,459,460,461,462,463,465,467,470],pep495:184,pep8:472,pep:[22,28,30,31,41,45,52,57,58,60,62,64,71,77,79,81,84,86,91,92,93,95,96,99,109,114,118,129,131,156,159,161,162,164,167,170,171,176,182,211,214,227,228,229,251,252,254,264,266,275,289,293,298,301,304,313,324,326,328,329,330,333,334,335,339,342,346,347,350,355,363,367,375,381,382,396,399,404,420,423,424,426,427,428,431,432,437,446,451,454,455,456,472,473],pepe:201,pepper:342,per:[7,22,28,30,31,41,58,62,65,75,79,84,86,90,91,95,104,111,112,119,122,129,134,135,143,144,145,147,152,159,161,178,182,184,190,197,198,204,206,209,210,225,229,251,261,266,271,282,284,288,293,295,307,310,319,321,330,335,336,339,340,342,343,346,355,363,366,367,368,370,373,376,378,385,416,424,428,432,440,446,448,451,455,459,460,461,463,464,465,467,468,469,471,472,473],percal:310,perceiv:[84,271],percent:[62,90,347,374,391,392,448,455,462,464,466,472],percentag:[310,347,442,462],percentequ:374,percentil:345,percol:[237,472],pereira:[471,472],perez:472,perf_count:[310,367,368,467,472],perf_counter_n:[367,471,472],perfect:[30,122,126,244,343,472],perfect_squar:122,perfectli:[65,95,99,107,153,197,292,426,455],perform:[15,19,22,30,31,38,54,55,57,58,59,62,70,71,77,78,81,84,87,93,94,95,96,97,99,103,104,107,109,111,113,120,122,125,126,128,129,130,135,139,140,141,147,159,161,162,164,167,168,170,176,178,182,184,187,190,193,200,207,210,214,216,221,222,225,227,228,236,237,243,244,246,249,250,252,258,260,261,265,266,267,268,272,274,284,288,291,293,297,300,302,307,308,310,316,319,320,321,323,332,334,335,339,340,342,343,346,347,349,350,355,366,367,368,370,375,380,382,385,386,391,392,396,399,402,412,416,417,422,424,426,428,431,432,435,436,438,440,441,442,446,448,451,455,456,457,458,459,460,461,462,463,465,466,468,469,470,471,472,473],perform_oper:170,perhap:[30,57,78,79,82,85,86,89,90,95,103,104,106,107,110,111,153,156,178,182,193,219,244,257,265,267,284,293,301,305,320,335,339,408,424,426,428,435,436,437,439,444,456,457,458,460,461,462],peril:440,perimet:227,period:[30,66,84,93,95,103,153,178,184,187,212,221,228,266,268,284,294,320,325,328,339,340,343,355,365,370,373,393,417,426,431,437,455,456,459,460,461,462,463,466],perl:[65,84,87,93,99,106,108,244,321,435,440,448,456,460,461,472],perm:[212,225,431,471],perman:[79,110,111,225,229,242,249,392,448,455,469,472],permanent_redirect:242,permiss:[57,63,64,65,74,86,87,91,93,103,104,110,111,164,213,214,217,225,249,286,293,294,298,313,333,334,339,344,359,361,392,394,402,422,434,463,471,472],permissionerror:[22,214,252,293,324,341,363,446,467,470,472],permit:[10,54,79,95,96,102,187,211,213,227,246,254,258,261,264,271,284,293,301,310,321,346,350,386,407,416,422,426,432,451,455,461,462,467,468,469,472],permitscontrol:329,permut:[90,99,260,320,421,431,456,462,465,472],pernici:469,perpendicular:380,perpetu:468,perrdetail:85,perrin:460,perror:214,persist:[62,185,242,246,248,253,267,274,282,322,342,387,422,447,466,468,472],persistent_id:[301,472],persistent_load:[301,472],perslist:456,person:[62,66,99,111,175,248,342,343,422,455,456,458,462],person_s:236,persona:456,perspect:[95,252,404],pertain:[1,30,31,57,79,293,355,372,422,464,472],pertin:[1,266,327],perturb:174,pervad:436,pessimist:472,pet:380,petazzoni:472,peter:[102,232,320,368,456,457,458,459,460,461,462,467,468,469,470,472],peterson:[96,109,462,463,465,466,467,468,469,470,471],petr:[469,471,472],petri:[467,472],petrosyan:462,petrov:472,petter:472,pew:201,pexport:111,pf_can:[339,467],pf_packet:339,pf_rd:[339,467],pf_system:[339,467],pformat:[309,468],pfunc:78,pgen2:472,pgen3:472,pgen:472,pgid:293,pgm:[250,370],pgo:[363,462,470,472],pgrp:293,pha:343,phan:236,pharetra:151,phase:[15,62,64,77,79,93,112,156,229,252,343,373,428,432,462,466,467,472],phaseit:90,phenomenon:84,phi:[156,275],phil:[419,420,462,472],philbrick:79,philip:[463,466,470],philipp:[236,422,461,472],phillip:[461,462,465,466,470,472],philosoph:424,philosophi:[93,197,447,464],phoenix:99,phone:[442,448,466],phonebook:[62,364],phonelist:466,phonenumb:466,photo:[435,448],photofil:448,photoimag:370,php:[225,416,456,458],phpaudit:225,phpbench:225,phrase:[242,243,249,272,292,392,426,430,431,459,462,467,469],physic:[7,62,65,93,97,178,193,222,248,252,279,282,294,339,351,374,402,428,445,461,471],physicist:321,pick:[82,91,93,110,111,143,161,246,275,292,378,385,418,456,461],pickl:[57,62,82,90,95,103,104,159,161,172,177,183,184,187,228,253,261,263,266,267,268,274,284,297,300,331,386,442,460,461,462,463,464,465,466,471,472,473],picklabl:[167,212,254,284,301,469,472],pickle2db:459,pickle_c:173,pickleabl:472,pickleerror:301,pickler:[95,173,301,302,465,467,472],pickler_dump:95,pickler_dumper_impl:95,pickler_method:95,pickler_typ:95,picklerobject:95,picklerobject_convert:95,picklestr:[301,302],pickletool:[62,253,263,301,378,462,472],picklingerror:[95,301],picnam:380,pictur:[79,168,201,380,429,458,460],pid:[101,129,134,138,168,279,284,293,301,311,324,339,350,461,463,472],pid_appnam:282,pid_author:282,pid_charcount:282,pid_codepag:282,pid_com:282,pid_create_dtm:282,pid_keyword:282,pid_lastauthor:282,pid_lastprint:282,pid_lastsave_dtm:282,pid_pagecount:282,pid_revnumb:282,pid_secur:282,pid_subject:282,pid_templ:282,pid_titl:282,pid_wordcount:282,pie:[275,342],piec:[65,78,86,93,99,106,107,135,143,147,153,170,180,189,190,193,203,244,269,292,343,411,425,431,436,437,458,461,468,472],pier:[458,459],pierci:472,pierr:[471,472],pieter:472,pietraszek:463,pietri:472,pil:[2,62,91,346],pillai:[463,466],pillow:[72,370,446],pimp:462,pinard:232,pincast:225,pineappl:189,ping:[225,456,457,458,461],pink:[212,380],piotr:463,pip3:468,pip:[62,64,105,191,192,253,396,418,441,453,455,472],pipe2:[293,467],pipe:[62,93,104,106,107,132,133,135,138,165,209,213,214,253,257,293,329,330,333,334,344,350,355,363,388,396,451,460,462,463,466,467,468,469,470,471,472],pipe_buf:[329,466],pipe_connection_lost:[132,135],pipe_data_receiv:[132,135],pipe_max_s:363,pipefil:303,pipelin:[62,165,253,388,456,472],pipenam:284,pipepag:472,piper:106,pipermail:[84,450,457,459],pipx:[211,463,468],piraeu:468,pitch:472,pitfal:[31,106,128,428],piti:84,pitrou:[462,463,465,466,467,468,469,471,472],pixel:[161,370,373,380,472],pixmap:[250,372],pixmapwrapp:462,pkc:[236,343,468],pkcs_7_asn:343,pkei:21,pkg:[28,65,68,69,74,252,304,418,432,451,454,456,457,461,463,472],pkg_add:454,pkg_dir:363,pkg_directori:251,pkg_info_path:69,pkg_name:[280,363,378],pkg_prog_pkg_config:472,pkg_resourc:252,pkgtool:[66,72],pkgutil:[62,253,281,428,454,461,462,467,470,471,472],pkttype:339,pkunzip:111,pkzip:[419,420,456],place:[1,22,30,31,34,41,43,49,53,55,57,58,62,65,66,68,79,80,81,82,83,84,85,89,90,93,95,96,99,101,103,104,108,110,111,113,122,124,136,140,141,153,154,159,161,168,169,170,177,178,182,184,187,189,190,193,197,206,209,212,219,222,226,227,228,229,232,236,237,244,248,251,252,256,257,261,266,267,268,271,275,279,284,293,297,299,301,304,310,313,316,318,320,321,326,340,343,346,347,350,356,365,370,372,373,376,380,381,382,385,386,387,392,394,396,404,418,423,424,426,428,432,436,437,438,442,444,445,446,448,449,450,451,453,456,457,458,459,460,461,462,463,464,465,466,467,469,470,471,472],placebo:320,placehold:[98,104,111,190,232,237,266,268,323,342,347,365,391,396,402,432,442,448,461,466,468,471,472],placeholderdict:466,placement:[79,304,370],placer:370,placerat:151,plagu:[62,468],plai:[28,31,62,82,93,94,107,177,187,253,295,320,343,380,385,401,424,435,436,464],plain:[5,74,77,79,86,91,104,110,129,137,152,153,154,161,174,184,197,198,201,205,206,207,214,243,254,266,328,337,342,343,344,348,382,392,404,418,419,431,437,448,458,464,466,468,469,470,472],plainli:422,plaintext:[174,225,249,467],plan:[74,95,105,107,114,135,301,400,449,456,460,461,462,463,464,466,468,472],plane:[248,275,380,472],planet:[62,183,461],planet_and_moon:380,plase:321,plast:260,plat:[30,65,66,111,455,470,472],plat_specif:[65,74],platbas:[111,466],platform:[1,5,9,17,30,31,54,58,59,62,64,65,66,67,70,72,74,75,77,78,79,81,82,84,86,90,91,95,104,107,116,117,120,123,126,129,134,135,138,147,148,152,156,159,164,174,176,177,184,193,194,209,213,214,227,236,248,251,252,253,255,257,265,268,270,271,275,283,284,293,294,296,298,309,310,311,324,325,328,329,330,333,339,340,342,343,344,349,350,355,356,361,363,366,367,368,369,370,375,385,395,396,400,401,403,404,421,426,431,434,440,441,442,446,451,452,453,456,458,459,460,461,462,463,464,465,466,467,468,469,470,472,473],platform_triplet:472,platform_vers:[355,470],platinclud:[356,466],platlib:[111,356,466],platstdlib:[356,466],playback:[157,295],player:[295,321,347,380],playground:380,playsound:[403,470,472],pleas:[0,1,5,23,30,31,35,58,64,77,84,86,95,96,103,105,106,107,110,112,116,122,125,138,141,153,161,168,177,185,194,225,232,243,249,252,265,266,267,268,288,293,307,321,324,333,336,337,339,342,343,355,359,362,380,382,386,392,404,422,426,430,437,439,454,455,456,457,459,461,464,467,468,469,471,472],pleasant:[90,440,456,457,461],plenti:[79,107],plist:[62,218,253,272,453,462,468,471,472],plist_str:462,plistlib:[62,218,253,470,471,472],plmrptoi:321,plock:293,plone:466,plot:460,plu:[3,54,57,65,81,90,111,122,161,177,178,179,187,189,195,209,248,284,292,293,304,307,332,336,344,355,363,365,366,370,374,386,387,391,404,408,426,430,431,442,449,450,458,459,460,461,467,468],plug:[91,332,342,472],pluggabl:[466,468,470],plugin1:470,plugin2:470,plugin:[192,470],pluginbas:470,plumag:[31,79,437],plummer:472,plural:[232,463,471,472],plusequ:374,pmincol:178,pminrow:178,pmodul:78,pmt:260,pname:78,pnext:177,png:[241,250,370],pngfile:201,poefsrosr:321,pofsros:321,point3d:161,point:[5,7,15,16,17,21,22,28,30,31,34,35,37,38,39,41,43,50,53,55,57,58,60,62,71,72,79,83,85,87,90,91,93,95,97,98,99,101,103,104,105,106,107,109,111,112,117,118,123,125,129,135,138,140,141,143,145,149,155,156,159,161,163,168,170,171,177,178,182,183,184,189,190,192,193,197,201,203,204,206,207,210,214,223,225,227,236,237,240,248,249,251,252,253,260,261,265,266,268,271,274,275,279,282,284,290,292,293,294,297,298,299,301,305,307,310,320,321,324,329,332,333,334,337,339,342,343,345,346,347,348,349,355,356,361,366,367,370,373,375,377,380,385,386,387,392,396,400,405,406,408,409,410,411,418,420,421,423,424,425,426,428,437,438,439,441,442,445,447,453,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],point_arrai:177,pointel:472,pointer:[3,5,7,8,9,10,14,16,17,19,22,28,30,31,35,38,39,41,44,45,49,50,53,54,55,56,57,58,62,78,81,82,84,85,87,91,92,95,96,119,120,178,180,279,284,301,305,310,351,355,398,418,426,436,441,450,458,460,461,462,463,466,468,470,471,472],pointfloat:431,pointless:472,poke:[65,292],poker:[321,380],polaco:472,polar:[62,290,462,472],poli:[380,456],poliak:468,polic:321,polici:[38,62,64,65,86,104,112,126,129,133,195,197,201,202,204,206,207,208,227,244,285,293,337,340,343,455,457,460,463,468,469,470,472],policy100:209,policy80:209,polish:459,polit:[184,225,456],poll:[62,90,125,129,134,138,141,284,293,330,334,340,343,344,350,460,462,466,467,469,472],poll_interv:340,poller:472,pollerr:329,pollhup:329,pollin:329,pollnval:329,pollobj:462,pollout:329,pollpri:329,pollrdhup:[329,472],pollselector:[133,330,471],pollut:472,polo:[462,463,465,468,470,471,472],poly1305:[343,470,472],poly1:380,poly2:380,polygon:380,polymorph:[82,93,95,414],polynomi:147,polzin:456,pomran:462,pool:[62,64,79,90,112,127,132,161,165,167,225,260,293,457,459,462,463,466,467,468,470,472],pool_sema:366,poolexecutor:472,poolwork:284,poor:[289,307,310,321,349,457,458,472],poorli:[104,151,307,446,472],pop3:[62,253,255,467,468,469],pop3_port:307,pop3_ssl:[307,466],pop3_ssl_port:307,pop:[30,86,90,95,104,123,125,161,162,187,190,195,204,222,237,248,260,271,293,307,332,343,346,372,373,380,385,396,424,431,438,448,458,459,460,461,462,466,468,469,472],pop_al:170,pop_align:222,pop_block:190,pop_except:190,pop_font:222,pop_jump_if_fals:[190,466],pop_jump_if_tru:190,pop_margin:222,pop_properti:222,pop_sourc:332,pop_styl:222,pop_task:237,pop_top:190,popa:[468,469,472],popcount:422,popen2:[62,165,460,462],popen3:[62,165],popen4:350,popen:[62,104,129,135,138,153,165,209,249,293,303,305,308,329,339,361,363,396,424,460,462,467,468,470,471,472],popitem:[161,162,168,260,271,288,346,424,457,459,463],popleft:[161,260,318,438,448,460],poplib:[62,195,253,255,447,460,467,470,472],popul:[31,41,62,65,103,104,122,124,208,237,266,301,320,326,345,352,381,397,404,408,410,424,428,455,459,470,472],popular:[64,66,72,79,84,90,91,92,93,107,108,112,141,189,193,228,249,255,271,296,376,380,430,442,444,447,453,455,466,467],popup:[248,363,380,472],popup_menu:461,popupmenu:372,poq:468,porch:91,port:[44,58,62,65,84,87,95,97,100,104,107,108,110,129,137,141,168,225,243,244,246,248,249,256,267,268,284,288,307,315,336,337,339,340,342,343,344,360,363,391,392,404,416,417,428,440,457,458,472,473],port_specifi:244,portabl:[31,59,62,65,74,75,79,84,86,87,104,107,109,120,133,178,216,217,220,250,252,253,265,275,279,293,300,301,305,308,339,344,359,367,400,418,444,455,456,459,465,467,471,472],portal:454,portfolio:345,portion:[14,65,74,93,95,97,99,102,106,137,143,147,180,184,187,204,210,228,236,252,266,267,268,297,336,339,344,373,385,391,404,407,413,416,417,422,428,456,466,467,469,472],portugues:159,pos:[21,55,119,143,155,187,254,261,279,291,293,302,321,322,351,373,380,398,459,463,469],pose:[105,456,460],posit:[5,7,14,19,22,24,34,43,53,55,57,58,62,79,82,90,91,93,95,97,99,101,104,106,107,108,109,117,119,122,123,124,129,135,142,145,151,155,156,157,159,161,163,164,167,177,178,182,184,187,189,190,193,210,214,216,227,228,235,236,237,251,252,254,257,260,261,265,266,269,275,279,283,284,291,293,301,302,316,318,320,322,327,329,333,339,343,346,347,349,350,351,352,355,359,363,364,366,367,370,373,375,377,378,380,382,385,386,387,392,395,396,398,405,407,410,412,418,423,424,426,436,437,438,442,445,448,456,459,460,462,463,465,466,467,468,469,470,471,472],position:[93,386,468],positional_argu:426,positional_onli:254,positional_or_keyword:254,positive_sign:265,posix:[22,62,64,65,74,90,104,107,111,112,117,135,138,152,177,184,210,214,229,253,265,286,292,293,294,298,303,318,324,329,332,333,339,340,350,355,356,359,361,366,367,383,388,396,418,422,451,456,459,460,461,462,463,466,467,468,469,471,472],posix_fadv_dontne:293,posix_fadv_noreus:293,posix_fadv_norm:293,posix_fadv_random:293,posix_fadv_sequenti:293,posix_fadv_willne:293,posix_fadvis:[293,467,469,472],posix_falloc:[293,467,469,472],posix_hom:[356,466],posix_prefix:[356,466],posix_spawn:472,posix_us:[356,466],posixfil:[458,462],posixly_correct:230,posixmodul:[95,472],posixpath:[294,298,383,472],posixuidgidtest:472,possess:[346,402],possibl:[1,2,5,7,17,22,28,30,31,35,38,43,45,52,53,57,58,60,65,66,68,70,72,74,77,78,79,82,84,85,86,87,89,92,93,94,95,97,98,99,102,103,104,105,106,107,109,111,112,113,117,118,119,122,124,125,129,134,139,142,143,145,147,151,153,159,160,167,168,170,171,172,174,176,177,178,181,182,184,185,187,189,190,193,195,197,198,202,203,204,206,207,209,211,212,214,219,222,227,228,232,233,236,237,243,246,248,252,254,257,260,261,265,266,267,268,269,271,272,275,276,282,283,284,288,289,292,293,295,296,297,298,299,301,305,306,310,311,313,314,316,320,321,322,329,332,333,334,339,342,343,345,346,347,348,350,354,355,357,358,359,360,361,363,365,366,367,368,370,372,373,378,380,382,385,386,387,391,392,395,397,399,400,402,403,404,410,412,413,416,418,419,420,421,422,423,424,426,428,430,431,432,433,436,437,438,439,440,442,444,445,446,448,449,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],post:[62,86,99,103,110,125,144,153,177,193,195,212,243,246,268,288,295,299,317,343,355,383,391,392,396,417,436,440,450,455,456,458,462,466,467,471,472],post_f:458,post_handshake_auth:[243,343,471,472],post_mortem:[193,299,462],post_setup:396,postalcod:343,postcmd:157,postcommand:373,postcondit:458,poster:288,postfil:143,postfix:84,postgresql:[342,461],postloop:157,posto:225,postpon:[62,114,178,252,423,424,472],pot:[469,472],potenti:[30,31,64,65,91,99,103,104,105,112,129,168,184,225,227,249,252,254,260,266,267,268,284,294,301,307,318,340,343,363,365,385,391,396,406,418,424,428,455,457,458,462,466,467,468,469,471,472],potential_err:107,potential_read:107,potential_writ:107,potlmrpi:321,potsdam:431,pott:[470,472],pound:[178,189,434],pour:201,pow3:284,pow:[43,91,94,124,167,170,227,260,275,284,291,346,417,424,426,446,458,466,472],powel:[156,472],power8:472,power:[62,66,86,87,91,93,94,98,143,148,168,174,177,187,212,227,228,236,290,292,293,299,301,321,328,339,346,368,386,387,410,423,427,429,436,440,441,445,447,448,459,460,462,463,464,466,467,472],powerpc:[295,349,460,461,462,472],powerset:260,powershel:[396,455],poynton:163,pp165:156,ppc64:[356,472],ppc64le:472,ppc:[65,356,453,462,466],ppercas:384,ppm:[250,370,372],ppo:21,pprint:[62,183,189,253,299,301,343,448,457,465,466,472],ppt:[197,206],pr1:74,pr2:74,practic:[1,31,62,66,80,82,86,90,96,97,98,99,102,103,104,105,110,122,125,141,175,178,179,187,193,195,200,225,227,236,243,249,254,284,288,307,320,337,343,346,367,370,391,408,416,426,436,437,439,442,445,446,457,458,459,464,466,468,471],pragma:177,pragmat:109,pragu:[],pranskevichu:[469,470,471],prc:460,prcal:152,pre6:472,pre:[31,65,72,74,77,79,93,103,104,106,112,141,187,190,204,209,228,237,246,252,257,260,266,267,292,298,326,332,340,377,384,386,392,396,423,432,440,451,453,455,456,459,460,463,466,468,469,470,471,472],pre_f:458,pread:[293,467,469,471],preadv:[293,471,472],prealloc:38,preambl:[66,197,201,206,302,472],prebuild:192,prebuilt:455,prec:[187,448,460,461,462],precari:424,precaut:[104,118],preced:[17,62,65,86,93,98,103,104,106,107,108,155,161,168,176,179,184,189,193,195,203,208,222,227,254,265,266,267,276,310,321,335,339,346,347,349,350,367,370,373,380,397,407,410,416,417,421,423,424,425,427,429,430,431,432,436,439,445,451,455,457,458,467,471,472],precis:[9,12,17,24,58,62,78,84,103,176,184,214,227,232,258,261,267,268,275,284,290,293,310,315,320,329,330,339,342,346,347,349,355,367,368,373,382,392,396,405,424,426,430,431,437,440,448,456,460,461,462,463,466,467,468,470,471,472],preclud:[53,161,289,346],precmd:157,precompil:[60,326,451,472],precompos:426,precomput:[62,149,401,472],precondit:[110,343,458,466],precondition_fail:242,precondition_requir:242,preconfigur:386,precursor:268,pred:[260,396],predat:[105,140,179,189],predecessor:[65,112,459,466],predeclar:79,predefin:[62,79,91,103,106,113,157,159,177,178,248,266,282,347,370,400,402,421,424,441,472],predetermin:268,predic:[65,99,139,254,260,365,366,410,459,462,466,471,472],predict:[114,143,227,257,355,424,451,455,466,472],predictor:228,preemptiv:165,preexec_fn:[350,460,472],preexist:129,prefabr:177,prefac:[129,135,445],prefer:[5,28,31,39,45,62,74,75,84,91,95,96,99,104,110,111,112,122,129,131,132,139,140,141,165,168,176,178,187,203,206,214,222,227,231,232,236,252,257,260,265,271,275,291,292,293,301,305,315,328,343,345,350,355,363,365,366,367,369,373,380,382,392,395,400,402,413,418,428,438,447,448,453,455,461,463,466,467,469,470,471,472],preferencelist:[201,206],preferenti:472,prefil:143,prefix:[30,31,43,58,62,65,66,74,79,84,93,95,102,105,106,107,120,157,160,168,174,176,177,178,187,189,190,204,227,230,232,236,244,246,248,255,267,268,294,299,304,316,321,333,335,346,347,355,356,361,363,365,370,372,373,376,385,386,395,396,407,410,412,416,420,421,431,432,436,442,445,446,451,454,455,459,462,463,466,467,469,470,472],prefix_char:[62,120],prefixlen:258,prefixlen_diff:258,pregener:[463,469,470],preinstal:454,prejudic:187,preliminari:[457,471,472],preload:[95,472],preloop:157,prematur:[79,103,243,271,431,464,472],premium:161,prepar:[22,54,60,62,84,109,110,111,152,158,184,232,236,245,253,257,268,301,339,350,355,363,364,380,381,385,392,410,411,414,418,419,422,445,446,462,464,468,469,471,472],preparatori:266,prepare_class:[381,467],prepare_input_sourc:414,prepare_ssl:472,prepareprotocol:342,prepend:[30,58,65,93,95,98,104,159,164,179,203,228,260,268,271,288,292,303,314,332,333,357,365,396,410,418,472],prependpath:455,preprocess:[65,95,168,176,391],preprocesserror:65,preprocessor:[22,38,65,68,77,95,111,332,418,456,463,472],prerequisit:464,prerog:103,prescod:[456,457,458,461],prescrib:[152,433],presenc:[30,31,57,72,79,81,93,113,159,187,219,227,244,251,252,255,286,292,310,343,345,350,355,363,375,385,423,424,426,428,439,445,458,459,464,470,472],present:[7,21,28,35,41,45,57,62,68,74,79,80,83,85,86,90,91,92,96,97,99,101,103,104,105,106,107,108,109,110,111,117,122,124,125,144,147,149,153,154,155,157,159,161,168,177,178,182,185,187,189,193,197,198,206,211,214,216,223,227,228,229,236,237,238,240,242,244,248,261,266,267,268,271,276,286,288,292,293,297,299,301,305,309,310,315,316,319,321,324,332,336,337,339,343,346,347,355,359,360,363,365,366,367,368,372,373,375,380,385,391,392,404,407,410,412,416,418,420,421,423,424,426,428,431,432,437,439,442,446,456,457,458,459,460,461,462,463,466,467,468,469,470,471,472,473],preserv:[31,38,62,74,79,86,95,99,104,107,108,113,122,168,176,184,187,189,193,197,202,204,206,209,222,227,233,241,242,254,260,267,268,292,293,299,302,332,333,346,359,363,369,381,385,386,399,421,423,426,436,440,455,456,457,458,459,461,462,463,466,467,468,469,471,472],preserve_mod:65,preserve_symlink:65,preserve_tim:65,preset:[95,269,305],preset_default:269,preset_extrem:269,press:[85,87,97,104,129,156,178,248,283,299,325,372,373,380,385,463,466],preston:[422,471],presum:[57,103,162,176,184,210,271,284,349,391,426,458,463,464,472],pretend:[65,79,105,107,178,386,424,436,458],pretend_serv:110,pretium:151,pretti:[62,82,94,97,109,111,168,183,186,189,213,253,254,261,268,292,299,310,375,386,408,416,426,448,456,457,458,461,462,464],prettyprint:[62,183,468],prev:[178,373],prev_h_len:322,prevail:[185,426],prevent:[21,22,30,31,38,62,79,82,90,93,97,98,103,109,110,111,140,159,161,168,170,171,177,187,189,190,193,207,214,227,238,248,251,252,261,267,271,276,284,292,313,339,343,355,363,377,380,382,385,386,387,396,397,399,406,419,421,424,428,434,445,446,451,455,458,459,461,462,463,466,467,468,469,470,472],preview:201,previou:[7,10,15,16,22,30,34,38,58,65,74,75,78,79,81,82,84,85,90,93,94,95,97,99,103,104,106,109,122,132,134,135,145,149,151,152,153,159,168,171,174,177,178,182,184,187,189,190,193,209,214,215,222,227,232,243,246,248,260,268,269,284,292,293,294,298,299,313,316,320,321,331,332,334,337,339,342,343,346,355,357,363,365,367,372,373,376,378,380,382,385,386,391,392,397,407,410,417,418,423,424,428,432,436,438,439,442,446,451,455,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],previous:[5,9,22,30,36,57,58,65,75,86,91,95,122,134,140,142,159,167,168,170,178,190,208,214,227,228,243,246,251,252,254,264,266,268,271,276,283,292,293,299,301,321,330,331,334,339,342,343,350,366,373,378,381,385,387,391,392,397,398,402,419,422,425,428,432,450,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],previouss:407,pri:357,price:[161,321,342,345,409,445,460,461,469,472],primari:[62,82,84,91,93,95,108,158,170,193,195,197,206,207,219,229,266,276,282,297,301,310,339,342,343,347,355,375,399,416,428,429,432,434,444,445,446,448,456,457,459,460,462,463,464,466,467,468,472],primarili:[52,56,80,84,91,102,103,111,143,159,161,176,184,195,207,227,228,254,266,301,350,382,385,397,404,408,424,455,457,458,460,462,463,467,469,471,472],primary_except:464,prime256v1:[343,472],prime:[91,167,193,209,284,346,355,367,437,447,466,470],primit:[62,81,90,91,117,126,127,137,165,177,178,257,291,301,310,321,329,330,334,343,366,380,446,448,467,468,471,472],princip:[244,343,346,422,448,465,466],principl:[29,31,79,91,93,187,385,386,404,438,453,467],print:[29,30,31,38,45,54,57,62,65,74,78,79,81,82,84,90,91,92,93,94,95,98,99,101,102,103,104,106,109,110,111,113,114,117,120,123,126,128,129,131,135,136,137,138,139,140,141,142,145,147,152,153,157,158,160,161,164,167,168,169,170,171,173,176,177,178,184,185,187,189,190,193,197,201,202,205,206,212,214,217,221,222,225,227,228,229,230,231,232,236,241,243,245,246,248,249,252,253,254,256,257,261,266,268,271,279,280,283,284,288,293,296,299,301,302,303,306,307,309,310,311,315,316,317,320,321,322,323,327,330,332,334,335,336,337,339,340,342,343,344,346,347,350,352,355,356,358,359,360,361,363,365,366,368,370,372,373,375,376,378,380,385,386,392,394,396,397,399,402,404,405,408,409,410,413,414,416,417,418,419,423,424,425,426,431,432,434,436,437,438,439,440,442,444,445,446,447,448,451,455,456,457,458,459,460,461,463,466,467,468,469,470,471,472,473],print_assign:99,print_cal:310,print_calle:310,print_cont:370,print_diff_fil:217,print_directori:153,print_environ:153,print_environ_usag:153,print_error:[85,466],print_exc:[104,368,377],print_except:[266,268,377,472],print_expr:190,print_form:153,print_funct:[105,113,114,432,462],print_help:[122,292],print_http_head:137,print_it:370,print_last:377,print_some_tim:327,print_stack:[140,266,377,469,472],print_stat:310,print_tb:[377,469],print_tim:327,print_usag:[122,292],print_vers:292,printabl:[58,62,144,147,159,178,179,196,197,198,199,203,204,209,225,227,253,283,285,286,346,347,348,424,457,464,466],printabletyp:462,printdir:419,printdocu:97,printer:[62,106,183,248,253,370,375,402,448],printf:[9,58,62,78,79,101,177,246,266,426,442,445,461,472],printfunc:[57,81],printnameoffset:472,printout:[310,472],prio_pgrp:293,prio_process:293,prio_us:293,prion:466,prior:[21,30,41,54,62,84,91,93,103,104,108,114,129,140,144,176,187,193,227,246,254,266,318,330,339,343,346,350,355,357,359,361,366,385,419,422,424,426,428,468,469,470,471,472],priori:[68,252],priorit:472,prioriti:[54,62,98,127,183,252,256,260,261,268,293,318,324,327,329,343,346,350,357,366,372,424,426,438,448,458,459,462,466,467,468,470,472],prioritizeditem:[237,318],priority_numb:[136,318],priorityqu:459,priorityqueu:[127,136,318,462,472],pristin:111,privaci:[91,343,395],privat:[30,38,39,62,91,99,177,182,189,225,227,248,249,258,279,284,301,307,337,343,348,363,382,386,426,431,432,441,446,455,457,458,459,462,466,467,468,469,470,472],privileg:[111,153,288,293,339,341,344,367,402,436,467,470,472],prize:320,prlimit:[324,468,472],prmonth:[152,472],prn:74,prng:343,prngd:343,pro:321,proactor:[469,472],proactoreventloop:[129,133,134,138,472],proactorsockettransport:472,prob_dist:466,probabilist:310,probabl:[28,30,31,51,65,66,68,69,72,74,79,81,84,85,86,87,91,94,95,97,102,104,105,106,107,111,141,144,159,160,177,184,193,201,214,232,237,284,293,299,302,305,310,311,320,337,339,340,342,343,355,368,386,392,395,402,403,404,412,430,436,439,450,456,457,458,459,461,462,464,466,467],probe:[62,468,472],probenam:101,probepoint:101,problem:[1,22,30,31,54,57,62,64,74,79,82,84,86,90,91,92,93,95,96,97,99,103,104,105,107,109,112,128,129,141,143,154,159,160,168,170,172,176,184,187,193,197,200,204,206,208,225,232,237,246,248,251,252,253,255,261,265,266,267,284,292,293,297,301,310,316,334,339,342,343,358,359,363,365,386,387,390,399,404,407,423,434,435,438,439,440,442,447,448,449,450,455,456,457,458,459,460,461,462,463,464,465,466,467,471,472],problemat:[13,93,96,168,267,284,460,465,466,471,472],proc:[138,241,350,470,472],proce:[68,78,139,161,187,196,206,260,271,284,310,343,361,366,423,426,436],procedur:[38,62,65,78,86,99,123,153,159,177,227,310,337,348,363,380,415,416,432,437,447,457,458,461,466],proceed:[82,86,94,110,293],process:[1,5,7,22,29,31,41,53,57,59,60,62,64,66,68,69,71,74,75,78,79,81,83,84,85,86,90,92,93,95,97,99,101,102,103,106,107,109,110,111,112,113,117,120,122,124,125,128,132,133,135,136,137,138,141,146,151,152,153,157,159,165,167,170,176,177,178,184,193,201,204,211,213,214,215,218,219,227,228,229,230,232,236,241,242,246,248,249,252,253,254,259,260,265,266,267,268,269,271,274,279,281,292,295,297,298,301,310,311,316,317,318,321,324,326,329,330,332,333,334,335,337,339,340,342,344,346,348,350,355,357,358,359,360,361,363,365,367,368,375,376,377,380,381,382,385,391,392,395,396,397,399,400,402,404,407,408,409,410,411,412,413,416,417,418,419,421,423,424,426,428,431,432,437,439,442,444,446,447,451,454,455,457,458,459,460,461,463,465,466,467,468,469,470,471,472,473],process_block:227,process_client_connect:366,process_exit:[132,135],process_fil:170,process_id:339,process_messag:[336,469,470],process_request:340,process_server_connect:366,process_tim:[310,367,368,467],process_time_n:[367,471,472],process_token:358,processerror:284,processing_instruct:409,processing_instruction_nod:[407,408],processinginstruct:[62,273,410,412,461],processinginstructionhandl:316,processlookuperror:[22,214,324,446,467],processnam:[104,266,284],processor:[0,31,65,74,79,84,93,109,141,167,284,288,292,295,305,316,324,367,392,406,412,424,456,460,461,472],processpoolexecutor:[62,90,129,165,366,466,469,471,472],procur:422,prod:260,produc:[5,7,21,22,23,31,35,45,54,64,77,82,83,86,90,91,93,95,97,99,103,104,106,107,109,111,122,125,140,151,153,159,161,162,164,168,176,177,178,184,187,188,189,193,195,197,198,202,203,204,206,209,214,215,222,225,227,230,232,233,235,236,237,249,257,260,261,266,269,276,284,288,293,297,301,304,307,310,315,318,320,321,323,342,343,346,347,349,350,355,359,366,370,375,376,380,385,391,392,394,403,404,408,409,411,412,413,418,421,424,426,428,431,437,440,442,445,448,449,451,456,457,458,459,460,461,462,463,464,465,466,467,468,469,471,472],product:[7,14,68,86,87,90,96,99,103,124,128,187,193,237,246,248,260,268,297,346,355,380,385,386,418,422,426,431,436,446,453,456,457,461,462,463,465,467,470,472],product_typ:[355,463],productcod:282,productionclass:[386,387],productnam:282,productvers:282,profdata:472,profession:[89,435,448,455,465],professor:321,profici:408,profil:[29,31,62,86,91,101,159,253,334,343,348,355,366,402,434,447,453,457,458,460,461,462,464,470,472],profilefunc:355,profit:[86,422],proftpd:[225,466],prog:[62,94,120,292,321,396,466],program:[1,5,14,15,28,30,40,41,60,62,65,66,74,75,78,79,83,84,87,88,89,93,94,98,100,103,104,105,106,110,111,112,113,120,122,127,128,129,135,138,141,142,144,147,152,153,157,158,159,160,161,165,167,168,169,170,176,177,184,186,187,193,201,202,204,209,212,214,217,225,227,228,229,230,235,247,248,249,252,253,254,262,268,271,272,276,283,286,292,293,294,296,298,299,301,308,309,310,311,315,316,318,321,324,329,331,334,339,340,342,343,346,349,350,355,357,361,363,366,368,369,372,373,376,377,380,385,391,392,395,397,399,400,402,404,407,408,416,418,419,422,423,424,426,429,430,431,432,434,435,436,437,438,439,441,442,446,448,449,450,451,452,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,471,472],programacion:[462,464],programfil:455,programm:[7,25,29,31,57,74,79,83,84,91,92,93,97,98,103,107,108,111,118,125,176,178,182,184,187,193,195,214,253,265,271,275,284,292,293,295,339,342,346,355,369,370,372,380,387,397,399,402,423,429,432,436,438,439,442,446,457,458,460,461,462,466],programmat:[62,78,84,114,124,168,170,183,186,209,211,263,265,267,281,292,297,311,322,355,392,463,467,468,472],programmingerror:342,progress:[90,106,153,193,213,225,237,284,289,332,342,343,372,373,396,397,437,455,456,458,463,472],progressbar:[62,369],prohibit:[134,193,257,261,404,426,471,472],project:[0,1,62,65,66,69,72,74,81,83,87,90,91,92,100,104,105,111,112,113,168,184,192,193,211,225,232,236,252,292,309,316,385,386,396,418,419,422,430,437,440,447,450,453,455,456,459,462,463,464,466,467,468,470,472],project_bas:472,project_directori:385,project_info:309,project_nam:466,project_url:309,projectbas:466,prolept:[152,184],promin:[111,464],promis:[74,79,212,254,466],promiscu:339,promot:[195,237,422,437,462],prompt:[60,66,72,85,91,92,93,111,113,115,122,157,158,174,177,190,193,201,208,225,227,231,248,249,299,315,322,337,343,346,350,355,362,366,377,380,392,396,428,432,434,437,440,444,445,446,449,451,455,459,462,466,468,470,471,472],prompt_last_lin:472,prompt_user_passwd:392,promptli:[167,284,321,439],prone:[66,82,84,153,184,193,301,310,346,469],pronounc:[105,161,466],proof:[91,99,204,284,456,472],prop:455,propag:[22,30,31,32,47,95,99,103,104,128,140,158,161,171,214,227,252,266,267,284,298,299,304,327,333,346,355,367,385,386,387,392,399,423,424,426,428,459,461,470,472],proper:[5,62,78,81,84,91,95,111,156,178,190,214,236,246,248,252,333,339,343,346,349,355,363,385,392,407,410,423,424,426,427,443,456,469,470,471,472],proper_slic:426,properli:[2,6,22,30,31,41,42,45,57,79,82,84,95,104,106,107,129,138,148,170,171,203,204,208,210,214,232,252,265,274,293,310,316,337,343,349,350,359,361,363,366,370,373,385,386,391,412,421,442,444,455,457,458,459,463,464,467,468,470,472],properti:[15,53,57,62,84,93,99,102,103,106,108,118,152,161,171,176,177,178,182,187,193,196,197,204,206,209,212,220,222,223,227,228,232,236,237,254,256,257,258,261,265,271,282,284,289,306,337,342,343,346,348,355,361,366,375,378,380,381,382,384,385,386,392,399,402,407,408,411,412,413,422,423,424,431,432,436,438,446,447,455,456,458,459,460,461,463,466,467,468,469,470,471,472],property_declaration_handl:412,property_dom_nod:412,property_lexical_handl:412,property_xml_str:412,propertymock:386,propertynam:413,proplist:431,proport:[143,168,320,472],propos:[1,31,84,91,93,155,167,176,228,266,343,350,399,407,423,426,428,431,432,456,457,459,460,461,462,463,466,470],proposit:95,proprietari:[87,97],prose:193,prospero:391,prot:279,prot_c:225,prot_p:225,prot_read:279,prot_writ:279,protect:[22,30,79,81,82,140,168,177,178,182,225,232,236,237,249,257,269,279,284,309,326,332,340,343,344,386,397,418,424,439,451,458,461,469,472],proto:[129,137,302,339,392],protocol:[2,8,9,29,50,53,57,60,62,80,84,85,86,90,93,95,99,102,107,109,110,118,123,125,126,129,131,137,138,141,143,146,147,153,159,162,170,176,177,184,185,188,195,204,210,212,213,218,227,236,242,244,246,252,253,254,257,259,261,266,267,268,271,284,293,295,301,302,309,329,330,331,339,340,342,346,348,349,359,360,363,366,370,386,387,392,402,404,413,416,417,420,424,426,431,436,442,447,456,458,459,461,463,464,465,466,468,471,472,473],protocol_:343,protocol_factori:[129,135],protocol_sslv23:[225,343,472],protocol_sslv2:343,protocol_sslv3:[343,472],protocol_tl:[343,472],protocol_tls_cli:[343,472],protocol_tls_serv:[343,472],protocol_tlsv1:343,protocol_tlsv1_1:[343,468],protocol_tlsv1_2:[343,468,472],protocol_vers:[246,249],protocolerror:[62,255],protocolnam:339,prototyp:[60,62,77,78,84,95,120,157,161,187,342,456,461,463,472],prouser:382,prouserid:382,provabl:62,prove:[57,93,99,177,343,459,464,465],proven:[99,193,459],provid:[1,5,7,10,14,17,22,26,28,30,31,33,36,38,39,41,43,45,49,53,57,58,60,62,64,65,66,67,68,69,70,71,74,78,80,81,84,85,86,87,90,91,93,94,95,96,97,98,99,101,102,104,105,106,108,109,110,111,112,116,117,118,119,120,121,122,124,125,126,129,131,135,137,138,140,141,143,144,146,149,150,151,152,153,154,155,156,157,158,159,160,161,162,164,165,167,168,170,171,172,173,174,176,177,178,182,183,184,185,187,189,190,192,193,194,195,196,197,198,199,202,203,204,205,206,207,208,209,210,211,212,213,214,216,217,219,221,222,223,225,226,227,228,229,230,231,232,234,235,236,237,238,242,243,244,245,246,247,248,249,250,251,252,253,254,256,257,258,259,260,261,263,265,266,267,268,269,271,275,276,277,279,280,281,282,283,284,286,288,289,290,291,292,293,295,296,297,298,301,302,304,305,306,307,308,309,310,312,313,314,316,317,318,320,321,322,323,324,326,328,329,332,333,334,335,336,337,338,339,340,341,342,343,344,345,346,347,348,349,350,351,353,354,355,357,358,359,360,361,362,363,364,365,366,367,368,369,370,371,372,373,374,375,376,377,378,380,381,382,384,385,386,387,388,391,392,393,395,396,397,398,399,400,402,403,404,405,406,407,408,409,410,411,412,413,414,416,417,418,419,420,421,422,423,424,426,428,432,433,434,435,436,437,438,439,440,442,446,447,448,449,451,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],provinc:343,provis:[103,343,422,426],provision:[62,93,135,140,198,204,206,209,343,355,382,468,469,470,471,472],proxi:[61,62,165,168,171,188,214,227,243,249,336,381,385,392,399,407,416,422,424,457,462,466,467,469,470,472],proxiedtransport:416,proxy_auth_handl:392,proxy_authentication_requir:242,proxy_handl:392,proxy_head:416,proxy_support:110,proxyauth:249,proxybasicauthhandl:[62,255],proxydigestauthhandl:[62,255],proxyhandl:[62,110,255],proxytyp:[284,399],prune:[67,75,293,472],prweek:472,pryear:[152,472],pryor:461,ps1:[60,85,158,339,355,396,434,446,451,472],ps2:[60,85,158,355,434,446,451,472],pseudo:[60,62,93,95,122,182,197,253,274,286,290,293,324,328,343,346,355,388,428,458,459,462,467,470,472],pseudorandom:[236,320,343],pseudorandomli:236,pseudotermin:311,psf:[62,86,298],pslaee:321,psm:339,pst:184,pstat:[310,447,457,461,472],pstdev:345,psycopg:467,pt154:159,ptcp154:159,pth:[111,304,335,355,455,456,470,472],pthon:343,pthread:[30,355,466,472],pthread_:472,pthread_atfork:30,pthread_getcpuclockid:[367,471,472],pthread_kil:[293,334,467],pthread_mutex_lock:472,pthread_sigmask:[334,467],ptr:[7,38,258,460,469],ptrace:472,ptraceback:22,pty:[62,253,293,343,388,472],ptype:[17,22,305],pub:[104,127,225,333,454],pubid:410,public_kei:225,publicdomain:236,publicid:[316,407,412],publicli:[86,422,456,472],publish:[64,73,74,79,104,106,112,187,189,191,342,363,368,370,393,417,422,455,457,463,466],pula:472,pull:[62,79,184,187,237,273,329,380,386,409,456,460,463,468,471,472],pulldom:[62,253,273,406],pulliainen:468,puls:104,pulvinar:151,pumpkin:342,pun:437,punch:[361,472],punctuat:[58,106,109,286,332,347,431,470],punctuation_char:[332,470],punycod:[77,159,459],puppi:189,purcel:457,purchas:[342,345],pure:[62,66,68,71,72,74,80,87,90,91,98,99,101,104,105,111,161,177,184,187,192,220,225,227,232,248,260,310,334,336,357,363,406,424,436,438,451,458,459,460,461,462,463,464,465,466,467,468,472],pureftpd:225,purelib:[111,356,466],purepath:[293,298,472],pureposixpath:298,pureproxi:[62,255],purewindowspath:298,purg:321,purifi:84,puriti:99,purpl:97,purplish:178,purpos:[5,7,16,17,28,30,31,33,38,57,65,74,77,78,79,81,84,86,94,95,98,103,104,106,108,110,114,124,144,156,159,161,168,169,171,174,176,177,178,182,184,187,189,193,197,203,206,207,214,228,229,232,236,237,246,252,254,267,274,284,292,293,295,297,301,309,310,320,321,325,327,339,343,349,355,359,366,370,373,381,385,386,391,397,404,407,410,411,418,422,424,425,426,428,431,436,437,438,442,446,451,455,456,462,463,464,465,466,468,469,470,471,472],purposefulli:129,puru:151,push:[65,84,95,104,125,158,161,170,178,180,187,190,222,237,283,332,410,431,432,437,456,462,467,472],push_align:222,push_async_callback:170,push_async_exit:170,push_font:222,push_margin:222,push_properti:222,push_sourc:332,push_styl:222,push_token:332,push_with_produc:125,pushback:332,pushbutton:282,pussycat:201,put:[19,31,45,62,65,66,68,69,72,74,75,79,81,82,84,85,90,92,93,95,97,99,104,106,107,111,136,159,167,168,176,177,190,193,202,204,209,212,216,229,232,243,248,252,267,282,284,291,295,301,302,318,337,339,342,343,352,356,361,365,366,370,379,386,387,392,422,428,434,437,444,445,446,449,454,455,457,458,459,460,461,462,463,466,469,472],put_nowait:[104,136,268,284,318],putch:283,putchar:178,putenv:[293,308,472],puthead:243,putlin:472,putp:178,putrequest:243,putwch:[283,462],putwin:178,puzzl:[92,461],pvalu:[21,22,78],pvarianc:[345,472],pvm:90,pw_dir:312,pw_geco:312,pw_gid:312,pw_name:312,pw_passwd:312,pw_shell:312,pw_uid:312,pwd:[62,111,174,225,231,234,253,293,294,341,388,419,459,472],pwrite:[293,467,469,471],pwritev:[293,471,472],py2:[66,69,108,321,449,466,472],py2app:453,py2ex:[91,92,284,472],py32:466,py3:[108,113,321,449,465,466,472],py3k:[30,93,105,343,355,356,464],py3kwarn:462,py_:455,py_ab:31,py_addpendingcal:[30,463,472],py_address_in_rang:472,py_atexit:54,py_begin_allow_thread:[5,30,79],py_block_thread:30,py_buff:[5,7,39,57,62,462,467],py_buildvalu:[5,31,45,55,62,79,92,461,472],py_byteswarningflag:[30,471],py_charmask:31,py_cleanup_support:5,py_clear:[47,57,82,96,460],py_cmp_func:177,py_compil:[62,65,91,164,251,253,263,463,466,468,472],py_compilestr:[60,85],py_compilestringexflag:60,py_compilestringflag:60,py_compilestringobject:60,py_complex:[5,14,79,95],py_create_mod:472,py_debug:[31,472],py_debugflag:30,py_decodelocal:[30,54,58,78,79,469,471,472],py_decref:[21,22,26,31,32,47,57,78,79,81,82,85,96,472],py_default:95,py_dontwritebytecodeflag:30,py_dtsf_add_dot_0:17,py_dtsf_alt:17,py_dtsf_sign:17,py_dtst_finit:17,py_dtst_infinit:17,py_dtst_nan:17,py_ellipsi:51,py_enable_shar:356,py_encodelocal:[30,54,58,469,471,472],py_end_allow_thread:[30,79],py_endinterpret:30,py_enterrecursivecal:22,py_eq:[45,57,58,81],py_eval_input:[60,85],py_exit:[54,470],py_fals:[6,57,58,81],py_fatalerror:[17,30,54],py_fdisinteract:54,py_fil:[65,359],py_file_input:[60,85],py_filesystemdefaultencod:58,py_filesystemdefaultencodeerror:58,py_fin:[30,85,463],py_finalizeex:[30,31,54,78,470,472],py_frozen:251,py_frozenflag:30,py_g:[45,57,58,81],py_getbuildinfo:[30,461],py_getcompil:30,py_getcopyright:30,py_getenv:31,py_getexecprefix:[30,31],py_getpath:[30,31,472],py_getplatform:30,py_getprefix:[30,31],py_getprogramfullpath:[30,31],py_getprogramnam:30,py_getpythonhom:30,py_getvers:30,py_gt:[45,57,58,81],py_hash_t:[45,57,81,466],py_hashrandomizationflag:30,py_have_native_tl:472,py_huge_v:17,py_ignoreenvironmentflag:[30,31,471],py_incref:[31,47,61,79,81,82,92],py_initi:[28,30,31,54,78,79,85,92,455,466,471,472],py_initializeex:30,py_initmodul:96,py_inspectflag:[30,60],py_int64_t:30,py_interactiveflag:[30,54],py_is_nan:460,py_isalnum:463,py_isalpha:463,py_isdigit:463,py_isiniti:[30,31],py_islow:463,py_isolatedflag:30,py_isspac:463,py_isupp:463,py_isxdigit:463,py_l:[45,57,58,81],py_leaverecursivecal:22,py_legacywindowsfsencodingflag:30,py_legacywindowsstdioflag:30,py_limited_api:[30,51,52,56,418,466,471,472],py_llong_max:35,py_llong_min:35,py_loc:461,py_local_aggress:461,py_local_inlin:461,py_long_long:470,py_lt:[45,57,58,81],py_main:[60,418,455,471,472],py_major_vers:[4,96,114],py_marshal_vers:37,py_max:31,py_member_s:31,py_memcpi:472,py_micro_vers:[4,114],py_min:31,py_minor_vers:[4,114],py_mod_cr:41,py_mod_exec:41,py_modul:[65,69,72,74,75,456],py_n:[45,57,58,81],py_newinterpret:30,py_non:[3,22,25,30,42,43,51,61,79,92,95],py_nositeflag:30,py_notimpl:[45,57,58,81,457],py_nousersitedirectori:30,py_object:[177,461],py_optimizeflag:[30,177],py_print_raw:[23,45],py_py3kwarningflag:462,py_python3:455,py_python:455,py_quietflag:30,py_refcnt:[53,82,462],py_release_level:[4,114],py_release_seri:[4,114],py_reprent:22,py_reprleav:22,py_return_fals:[6,460],py_return_non:[31,42,79,460],py_return_notimpl:45,py_return_richcompar:[57,471,472],py_return_tru:[6,460],py_setpath:[30,455,472],py_setprogramnam:[30,31,78,79,455,472],py_setpythonhom:[30,472],py_setref:472,py_setstandardstreamencod:[30,468],py_single_input:[60,85],py_siz:[53,462],py_size_max:472,py_sourc:251,py_spammodule_h:79,py_ssize_t:[3,5,7,8,9,17,21,22,26,31,34,35,36,37,39,41,43,44,45,49,50,51,53,55,56,57,58,79,81,95,177,355,424,461,462,472],py_ssize_t_clean:[5,31,78,79,82,85,461,472],py_ssize_t_max:[43,51,95,472],py_ssize_t_min:[43,51],py_stringifi:31,py_todo:466,py_tolow:463,py_toupp:463,py_tp_fin:472,py_tpflags_base_exc_subclass:57,py_tpflags_basetyp:[57,82],py_tpflags_bytes_subclass:57,py_tpflags_checktyp:457,py_tpflags_default:[57,82],py_tpflags_dict_subclass:57,py_tpflags_gc:458,py_tpflags_have_fin:57,py_tpflags_have_gc:[26,56,57,82],py_tpflags_have_stackless_extens:57,py_tpflags_have_version_tag:[57,462],py_tpflags_heaptyp:57,py_tpflags_list_subclass:57,py_tpflags_long_subclass:57,py_tpflags_readi:57,py_tpflags_tuple_subclass:57,py_tpflags_type_subclass:57,py_tpflags_unicode_subclass:57,py_trace_ref:[31,57],py_tracefunc:30,py_tru:[6,57,58,81],py_tss_needs_init:30,py_tss_t:[30,471],py_typ:[53,81,82,95,462],py_ucs1:[58,467],py_ucs2:[58,467],py_ucs4:[58,467],py_ullong_max:35,py_unblock_thread:30,py_unbufferedstdioflag:30,py_unicod:[5,15,22,35,62,95,123,467,472],py_unicode_copi:467,py_unicode_fil:467,py_unicode_is_high_surrog:58,py_unicode_is_low_surrog:58,py_unicode_is_surrog:58,py_unicode_isalnum:58,py_unicode_isalpha:58,py_unicode_isdecim:[58,466],py_unicode_isdigit:58,py_unicode_islinebreak:58,py_unicode_islow:58,py_unicode_isnumer:58,py_unicode_isprint:58,py_unicode_isspac:58,py_unicode_istitl:58,py_unicode_isupp:58,py_unicode_join_surrog:58,py_unicode_match:467,py_unicode_strcat:467,py_unicode_strchr:467,py_unicode_strcmp:467,py_unicode_strcpi:467,py_unicode_strlen:467,py_unicode_strncmp:467,py_unicode_strncpi:467,py_unicode_strrchr:467,py_unicode_todecim:58,py_unicode_todigit:58,py_unicode_tolow:[58,466],py_unicode_tonumer:58,py_unicode_totitl:58,py_unicode_toupp:58,py_unicode_wid:58,py_unreach:[31,471,472],py_unus:[31,82],py_useclassexceptionsflag:472,py_va_copi:466,py_vabuildvalu:5,py_verboseflag:30,py_vers:466,py_version_hex:[4,52,96,472],py_version_nodot:466,py_version_short:466,py_visit:[26,57,82,96],py_warn:363,py_xdecref:[31,47,57,78,79,82,85,96],py_xincref:[47,79],pyanyset_check:50,pyanyset_checkexact:50,pyapi_data:459,pyapi_func:459,pyarg_:22,pyarg_noarg:459,pyarg_pars:[5,95,463,466,472],pyarg_parsetupl:[5,7,44,53,78,79,81,83,85,95,96,426,456,458,459,461,462,467,472],pyarg_parsetupleandkeyword:[5,53,79,81,82,95,460,470,472],pyarg_unpacktupl:[5,53,62,458,472],pyarg_validatekeywordargu:[5,472],pyarg_vapars:[5,472],pyarg_vaparsetupleandkeyword:[5,460,472],pyasciiobject:[58,467],pyast_compil:461,pyastronomi:449,pyasyncmethod:[57,81],pyatom:472,pybabel:232,pybaseobject_typ:57,pybench:[461,472],pyblake2:236,pybool_check:6,pybool_fromlong:6,pybool_typ:6,pybsddb:[331,459,462,463,464],pybuf_any_contigu:7,pybuf_c_contigu:[7,462],pybuf_contig:7,pybuf_contig_ro:7,pybuf_f_contigu:[7,462],pybuf_format:7,pybuf_ful:7,pybuf_full_ro:7,pybuf_indirect:7,pybuf_lock:462,pybuf_max_ndim:7,pybuf_nd:7,pybuf_read:39,pybuf_record:7,pybuf_records_ro:7,pybuf_simpl:7,pybuf_strid:7,pybuf_strided_ro:7,pybuf_writ:[7,39,462],pybuffer_fillcontiguousstrid:7,pybuffer_fillinfo:[7,57,472],pybuffer_iscontigu:[7,472],pybuffer_releas:[5,7,44,57,95,462],pybuffer_sizefromformat:7,pybuffer_tocontigu:[7,472],pybufferproc:[5,57,81],pybuild:111,pybuilddir:472,pybyt:96,pybytearray_as_str:8,pybytearray_asstr:8,pybytearray_check:8,pybytearray_checkexact:8,pybytearray_concat:8,pybytearray_fromobject:[8,462],pybytearray_fromstringands:[8,462],pybytearray_get_s:8,pybytearray_res:8,pybytearray_s:8,pybytearray_typ:8,pybytearrayobject:[5,8,95],pybytes_:96,pybytes_as_str:9,pybytes_asstr:9,pybytes_asstringands:[9,85],pybytes_check:[9,85,462],pybytes_checkexact:9,pybytes_concat:[9,472],pybytes_concatanddel:9,pybytes_decodeescap:472,pybytes_fromformat:[9,472],pybytes_fromformatv:9,pybytes_fromobject:9,pybytes_fromstr:[9,38,96],pybytes_fromstringands:[9,462],pybytes_get_s:9,pybytes_repr:472,pybytes_s:[9,85],pybytes_typ:9,pybytesobject:[5,9,58,95,462],pyc:[28,30,62,71,72,92,93,164,251,252,274,282,301,313,333,346,355,363,378,419,420,428,446,451,455,457,459,460,462,463,468,469,472,473],pyc_compil:472,pycallable_check:[45,78,79],pycalliter_check:33,pycalliter_new:33,pycalliter_typ:33,pycapsul:[10,79,463,465,466],pycapsule_checkexact:[10,96],pycapsule_destructor:10,pycapsule_get:10,pycapsule_getcontext:[10,96],pycapsule_getdestructor:[10,96],pycapsule_getnam:[10,96],pycapsule_getpoint:[10,96,463],pycapsule_import:[10,79,96],pycapsule_isvalid:[10,96,463],pycapsule_new:[10,79,96],pycapsule_setcontext:[10,96],pycapsule_setdestructor:[10,96],pycapsule_setnam:[10,96],pycapsule_setpoint:[10,96],pycapsule_typ:96,pycarraytype_new:472,pycell_check:11,pycell_get:11,pycell_new:11,pycell_set:11,pycell_typ:11,pycellobject:11,pycf_only_ast:[124,461],pycfunct:[40,53,79,81,82,95,96,460,472],pycfunction_cal:472,pycfunction_new:472,pycfunctionwithkeyword:53,pycharm:[91,470],pycheck:[84,91,461],pycinvalidationmod:[164,313],pyclassmethod_typ:98,pyclbr:[62,253,263,472],pycobject:[96,463,465,466],pycobject_asvoidptr:[96,463],pycobject_check:96,pycobject_fromvoidptr:96,pycobject_setpoint:96,pycobject_typ:96,pycode_addr2lin:[459,470],pycode_check:12,pycode_getnumfre:12,pycode_new:[12,463],pycode_newempti:[12,463],pycode_typ:12,pycodec_backslashreplaceerror:13,pycodec_decod:13,pycodec_encod:13,pycodec_ignoreerror:13,pycodec_incrementaldecod:13,pycodec_incrementalencod:13,pycodec_knownencod:13,pycodec_lookuperror:13,pycodec_namereplaceerror:[13,469],pycodec_regist:13,pycodec_registererror:13,pycodec_replaceerror:13,pycodec_streamread:13,pycodec_streamwrit:13,pycodec_stricterror:13,pycodec_xmlcharrefreplaceerror:13,pycodeobject:12,pycompactunicodeobject:[58,467],pycompileerror:[313,472],pycompilerflag:60,pycomplex_asccomplex:[14,462],pycomplex_check:14,pycomplex_checkexact:14,pycomplex_fromccomplex:14,pycomplex_fromdoubl:14,pycomplex_imagasdoubl:14,pycomplex_realasdoubl:14,pycomplex_typ:14,pycomplexobject:14,pycon:[97,109,343,461],pyconfig:[65,355,356,463,472],pycontext:16,pycontext_checkexact:16,pycontext_clearfreelist:16,pycontext_copi:16,pycontext_copycurr:16,pycontext_ent:16,pycontext_exit:16,pycontext_new:16,pycontext_typ:16,pycontexttoken:16,pycontexttoken_checkexact:16,pycontexttoken_typ:16,pycontextvar:16,pycontextvar_checkexact:16,pycontextvar_get:16,pycontextvar_new:16,pycontextvar_reset:16,pycontextvar_set:16,pycontextvar_typ:16,pycoro_checkexact:18,pycoro_new:18,pycoro_typ:18,pycoroobject:18,pyd:[62,72,77,90,268,420,461,466,469,472],pydate_check:19,pydate_checkexact:19,pydate_fromd:19,pydate_fromtimestamp:19,pydatetime_check:19,pydatetime_checkexact:19,pydatetime_d:19,pydatetime_date_get_hour:19,pydatetime_date_get_microsecond:19,pydatetime_date_get_minut:19,pydatetime_date_get_second:19,pydatetime_datetim:19,pydatetime_datetimetyp:19,pydatetime_datetyp:19,pydatetime_delta:19,pydatetime_delta_get_dai:19,pydatetime_delta_get_microsecond:19,pydatetime_delta_get_second:19,pydatetime_deltatyp:19,pydatetime_fromdateandtim:19,pydatetime_fromdateandtimeandfold:[19,472],pydatetime_fromtimestamp:19,pydatetime_get_dai:19,pydatetime_get_month:19,pydatetime_get_year:19,pydatetime_import:19,pydatetime_tim:19,pydatetime_time_get_hour:19,pydatetime_time_get_microsecond:19,pydatetime_time_get_minut:19,pydatetime_time_get_second:19,pydatetime_timetyp:19,pydatetime_timezone_utc:[19,471],pydatetime_tzinfotyp:19,pydatetimeapi:19,pydb:91,pydebug:[31,355,451,459,468,472],pydelta_check:19,pydelta_checkexact:19,pydelta_fromdsu:19,pydescr_isdata:20,pydescr_newclassmethod:20,pydescr_newgetset:20,pydescr_newmemb:20,pydescr_newmethod:20,pydescr_newwrapp:20,pydict_check:[15,21],pydict_checkexact:21,pydict_clear:21,pydict_clearfreelist:21,pydict_contain:[21,460],pydict_copi:21,pydict_delitem:21,pydict_delitemstr:21,pydict_getitem:[21,79],pydict_getitemstr:[21,79],pydict_getitemwitherror:[21,472],pydict_item:21,pydict_kei:21,pydict_merg:21,pydict_mergefromseq2:21,pydict_new:[21,85],pydict_next:21,pydict_s:21,pydict_setdefault:[21,472],pydict_setitem:[21,57,79],pydict_setitemstr:[21,85],pydict_typ:21,pydict_upd:21,pydict_valu:21,pydictobject:[21,50],pydictproxy_new:21,pydistutil:[66,111],pydll:177,pydoc3:466,pydoc:[57,62,82,90,188,227,253,417,457,458,459,460,463,465,469,472],pydoc_str:82,pydoc_strvar:[41,95],pyerr_:79,pyerr_badargu:22,pyerr_badinternalcal:22,pyerr_checksign:22,pyerr_clear:[22,31,79,468],pyerr_displai:472,pyerr_exceptionmatch:[22,31,85],pyerr_fetch:[22,57,81,85,468],pyerr_format:[22,81,95,96,463,469,472],pyerr_formatv:[22,469,472],pyerr_getexcinfo:22,pyerr_givenexceptionmatch:22,pyerr_newexcept:[22,79,96,461,463,466],pyerr_newexceptionwithdoc:[22,463,466],pyerr_nomemori:[22,38,79],pyerr_normalizeexcept:[22,472],pyerr_occur:[10,21,22,24,31,32,35,45,58,78,79,85,95],pyerr_print:[22,62,78,472],pyerr_printex:[22,472],pyerr_resourcewarn:[22,470,472],pyerr_restor:[22,57,81,85],pyerr_set:22,pyerr_setexcfromwindowserr:22,pyerr_setexcfromwindowserrwithfilenam:22,pyerr_setexcfromwindowserrwithfilenameobject:22,pyerr_setexcinfo:22,pyerr_setfromerrno:[22,79],pyerr_setfromerrnowithfilenam:22,pyerr_setfromerrnowithfilenameobject:22,pyerr_setfromwindowserr:22,pyerr_setfromwindowserrwithfilenam:22,pyerr_setfromwindowserrwithfilenameobject:22,pyerr_setimporterror:[22,468,470],pyerr_setimporterrorsubclass:[22,470],pyerr_setinterrupt:22,pyerr_setnon:22,pyerr_setobject:[22,79],pyerr_setstr:[22,31,79,81,82,96,463],pyerr_syntaxloc:22,pyerr_syntaxlocationex:[22,472],pyerr_syntaxlocationobject:[22,472],pyerr_warn:461,pyerr_warnex:[22,397,461],pyerr_warnexplicit:22,pyerr_warnexplicitobject:22,pyerr_warnformat:22,pyerr_writeunrais:[22,81,472],pyeval_acquirelock:[30,466],pyeval_acquirethread:30,pyeval_callobject:[463,466],pyeval_callobjectwithkeyword:472,pyeval_evalcod:[60,85,472],pyeval_evalcodeex:60,pyeval_evalfram:60,pyeval_evalframeex:[60,468,472],pyeval_getbuiltin:[48,85],pyeval_getcallstat:472,pyeval_getfram:48,pyeval_getfuncdesc:48,pyeval_getfuncnam:48,pyeval_getglob:48,pyeval_getloc:48,pyeval_initthread:[30,466,472],pyeval_mergecompilerflag:60,pyeval_reinitthread:30,pyeval_releaselock:[30,466],pyeval_releasethread:30,pyeval_restorethread:[30,466],pyeval_savethread:[30,466],pyeval_setprofil:[30,458],pyeval_settrac:[30,458],pyeval_threadsiniti:[30,460],pyexc_:22,pyexc_arithmeticerror:22,pyexc_assertionerror:22,pyexc_attributeerror:[22,81,82,96],pyexc_baseexcept:22,pyexc_blockingioerror:22,pyexc_brokenpipeerror:22,pyexc_buffererror:[7,22,57],pyexc_byteswarn:22,pyexc_childprocesserror:22,pyexc_connectionabortederror:22,pyexc_connectionerror:22,pyexc_connectionrefusederror:22,pyexc_connectionreseterror:22,pyexc_deprecationwarn:22,pyexc_environmenterror:22,pyexc_eoferror:22,pyexc_except:22,pyexc_fileexistserror:22,pyexc_filenotfounderror:22,pyexc_floatingpointerror:22,pyexc_futurewarn:22,pyexc_generatorexit:22,pyexc_importerror:[22,96],pyexc_importwarn:22,pyexc_indentationerror:22,pyexc_indexerror:22,pyexc_interruptederror:22,pyexc_ioerror:[22,79],pyexc_isadirectoryerror:22,pyexc_keyboardinterrupt:22,pyexc_keyerror:[22,31],pyexc_lookuperror:22,pyexc_memoryerror:22,pyexc_modulenotfounderror:22,pyexc_nameerror:22,pyexc_notadirectoryerror:22,pyexc_notimplementederror:[22,96],pyexc_oserror:22,pyexc_overflowerror:22,pyexc_pendingdeprecationwarn:22,pyexc_permissionerror:22,pyexc_processlookuperror:22,pyexc_recursionerror:[22,469],pyexc_recursionerrorinst:[470,471,472],pyexc_referenceerror:22,pyexc_resourcewarn:22,pyexc_runtimeerror:[22,81],pyexc_runtimewarn:22,pyexc_stopasynciter:22,pyexc_stopiter:22,pyexc_syntaxerror:[22,85],pyexc_syntaxwarn:22,pyexc_systemerror:[22,50],pyexc_systemexit:22,pyexc_taberror:22,pyexc_timeouterror:22,pyexc_typeerror:[22,79,81,82],pyexc_unboundlocalerror:22,pyexc_unicodedecodeerror:22,pyexc_unicodeencodeerror:22,pyexc_unicodeerror:22,pyexc_unicodetranslateerror:22,pyexc_unicodewarn:22,pyexc_userwarn:22,pyexc_valueerror:[22,79,463],pyexc_warn:22,pyexc_windowserror:22,pyexc_zerodivisionerror:[22,79],pyexception_getcaus:22,pyexception_getcontext:22,pyexception_gettraceback:22,pyexception_setcaus:22,pyexception_setcontext:22,pyexception_settraceback:22,pyexpat:[316,406,422,456,459,461,462,463,472],pyexpatn:472,pyfailmalloc:468,pyfile_decusecount:462,pyfile_fromfd:23,pyfile_getlin:23,pyfile_incusecount:462,pyfile_writeobject:23,pyfile_writestr:23,pyflak:472,pyfloat:24,pyfloat_as_doubl:24,pyfloat_asdoubl:24,pyfloat_check:24,pyfloat_checkexact:24,pyfloat_clearfreelist:24,pyfloat_fromdoubl:24,pyfloat_fromstr:24,pyfloat_getinfo:[24,462],pyfloat_getmax:[24,462],pyfloat_getmin:[24,462],pyfloat_typ:24,pyfloatobject:[24,82],pyfltk:87,pyformat_fromstr:463,pyformat_fromstringv:463,pyframe_getlinenumb:[48,463,470],pyframeobject:[18,27,30,48,60,468],pyfrozenset_check:50,pyfrozenset_checkexact:50,pyfrozenset_new:[50,461],pyfrozenset_typ:50,pyfunction_check:25,pyfunction_getannot:25,pyfunction_getclosur:25,pyfunction_getcod:25,pyfunction_getdefault:25,pyfunction_getglob:25,pyfunction_getmodul:25,pyfunction_new:25,pyfunction_newwithqualnam:25,pyfunction_setannot:25,pyfunction_setclosur:25,pyfunction_setdefault:25,pyfunction_typ:25,pyfunctionobject:25,pyfunctyp:177,pygam:86,pygc_collect:472,pygc_head:472,pygc_head_s:458,pygen_check:27,pygen_checkexact:27,pygen_new:27,pygen_newwithqualnam:27,pygen_typ:27,pygenobject:27,pygetopt:472,pygetsetdef:[20,53,57,81,82,254,381,471,472],pygettext:[232,469,472],pygilst:30,pygilstate_:30,pygilstate_check:30,pygilstate_ensur:[30,472],pygilstate_getthisthreadst:30,pygilstate_releas:30,pygilstate_st:30,pygobject:296,pygtk:[87,296,461],pyhamcrest:387,pyhash:[422,472],pyhkei:402,pyimport_addmodul:[28,79],pyimport_addmoduleobject:28,pyimport_appendinittab:[28,30,41,78,79],pyimport_cleanup:28,pyimport_execcodemodul:28,pyimport_execcodemoduleex:28,pyimport_execcodemoduleobject:[28,472],pyimport_execcodemodulewithpathnam:28,pyimport_extendinittab:[28,30],pyimport_frozenmodul:[28,177],pyimport_getimport:28,pyimport_getmagicnumb:[28,467],pyimport_getmagictag:28,pyimport_getmodul:[28,471,472],pyimport_getmoduledict:[28,472],pyimport_import:[28,78,462],pyimport_importfrozenmodul:28,pyimport_importfrozenmoduleobject:[28,472],pyimport_importmodul:[10,28,79,85,96,457,462,464],pyimport_importmoduleex:[28,467],pyimport_importmodulelevel:[28,467],pyimport_importmodulelevelobject:28,pyimport_importmodulenoblock:[10,28,96,462,464,467],pyimport_inittab:79,pyimport_reinitlock:472,pyimport_reloadmodul:28,pyindex_check:43,pyinit:77,pyinit_:77,pyinit_cli:79,pyinit_custom2:82,pyinit_custom3:82,pyinit_custom4:82,pyinit_custom:82,pyinit_emb:78,pyinit_foo:92,pyinit_keywdarg:79,pyinit_modulenam:[41,77],pyinit_myextens:96,pyinit_nam:79,pyinit_spam:79,pyinit_sublist:82,pyinitfrozenextens:30,pyinitu_:77,pyinstal:284,pyinstancemethod_check:40,pyinstancemethod_funct:40,pyinstancemethod_get_funct:40,pyinstancemethod_new:40,pyinstancemethod_typ:40,pyint_:96,pyinterpreterst:[30,472],pyinterpreterstate_clear:30,pyinterpreterstate_delet:30,pyinterpreterstate_getid:[30,471],pyinterpreterstate_head:[30,458],pyinterpreterstate_main:[30,472],pyinterpreterstate_new:[30,472],pyinterpreterstate_next:[30,458],pyinterpreterstate_threadhead:[30,458],pyiter_check:[32,57],pyiter_next:[32,57],pykde4:87,pylaunch_debug:455,pylib:461,pylifecycl:472,pylint:[91,105],pylist_append:34,pylist_astupl:34,pylist_check:[31,34,85],pylist_checkexact:34,pylist_clearfreelist:34,pylist_get_item:34,pylist_get_s:34,pylist_getitem:[31,34,79,85,472],pylist_getslic:34,pylist_insert:34,pylist_new:[2,31,34],pylist_revers:34,pylist_s:[31,34,461],pylist_set_item:34,pylist_setitem:[31,34,79],pylist_setslic:34,pylist_sort:34,pylist_typ:[34,82],pylistobject:[21,34,82],pylists:85,pyload:[466,468],pylong:[35,465],pylong_:96,pylong_a:35,pylong_asdoubl:[35,472],pylong_aslong:[21,31,35,78],pylong_aslongandoverflow:[35,463,466],pylong_aslonglong:35,pylong_aslonglongandoverflow:[35,463,466],pylong_assize_t:35,pylong_asssize_t:35,pylong_asunsignedlong:35,pylong_asunsignedlonglong:[35,465],pylong_asunsignedlonglongmask:[35,472],pylong_asunsignedlongmask:35,pylong_asvoidptr:35,pylong_check:[31,35,57],pylong_checkexact:35,pylong_fromdoubl:35,pylong_fromlong:[21,31,35,78,79,81,82,472],pylong_fromlonglong:35,pylong_fromsize_t:35,pylong_fromssize_t:[31,35],pylong_fromstr:35,pylong_fromunicod:35,pylong_fromunicodeobject:35,pylong_fromunsignedlong:35,pylong_fromunsignedlonglong:35,pylong_fromvoidptr:35,pylong_typ:35,pylongobject:35,pylookup:161,pymain_parse_cmdline_impl:472,pymalloc:[29,62,451,457,462,463,466,468,470,472,473],pymalloc_debug:[38,451],pymap:85,pymapping_:31,pymapping_check:[36,57],pymapping_delitem:36,pymapping_delitemstr:36,pymapping_getitemstr:36,pymapping_haskei:36,pymapping_haskeystr:36,pymapping_item:[36,471,472],pymapping_kei:[21,36,471,472],pymapping_length:36,pymapping_s:[36,57,472],pymapping_setitemstr:36,pymapping_valu:[36,471,472],pymappingmethod:[57,81],pymarshal_readlastobjectfromfil:37,pymarshal_readlongfromfil:37,pymarshal_readobjectfromfil:37,pymarshal_readobjectfromstr:37,pymarshal_readshortfromfil:37,pymarshal_writelongtofil:37,pymarshal_writeobjecttofil:37,pymarshal_writeobjecttostr:37,pymem:[456,461],pymem_:461,pymem_alloc:58,pymem_buffer_overflow:472,pymem_calloc:[38,469,472],pymem_del:[38,457],pymem_domain_mem:[38,451,470,472],pymem_domain_obj:[38,451,470],pymem_domain_raw:[38,451],pymem_fre:[5,17,38,54,58,96,459,461,472],pymem_getalloc:[30,38],pymem_malloc:[38,58,60,96,459,461,468,470,472],pymem_new:[38,457],pymem_rawcalloc:[30,38,469,472],pymem_rawfre:[30,38,54,78,79],pymem_rawmalloc:[30,38,60,468,472],pymem_rawrealloc:[30,38,60,468],pymem_realloc:[38,60,459,461,468],pymem_res:38,pymem_setalloc:[30,38],pymem_setupdebughook:[30,38,451,470,472],pymemalloc:[38,469],pymemallocatordomain:38,pymemallocatorex:[38,469],pymember_get:464,pymember_set:464,pymemberdef:[20,53,57,81,82,254,381,463,471,472],pymemcompat:459,pymemoryview_check:39,pymemoryview_frombuff:[7,39],pymemoryview_frommemori:[39,467],pymemoryview_fromobject:39,pymemoryview_get_bas:39,pymemoryview_get_buff:39,pymemoryview_getcontigu:39,pymemoryviewobject:[467,469],pymethod_check:40,pymethod_clearfreelist:40,pymethod_funct:40,pymethod_get_funct:40,pymethod_get_self:40,pymethod_new:40,pymethod_self:40,pymethod_typ:40,pymethoddef:[20,41,53,57,78,79,81,82,95,96,459],pymodinit_func:[79,82,96,459],pymodule_:41,pymodule_addfunct:41,pymodule_addintconst:[41,456],pymodule_addintmacro:[41,462],pymodule_addobject:[41,79,82,456],pymodule_addstringconst:[41,456],pymodule_addstringmacro:[41,462],pymodule_check:41,pymodule_checkexact:41,pymodule_cr:[3,41,78,79,82,96],pymodule_create2:41,pymodule_execdef:[41,469],pymodule_fromdefandspec2:[41,469],pymodule_fromdefandspec:[41,469],pymodule_getdef:41,pymodule_getdict:41,pymodule_getfilenam:41,pymodule_getfilenameobject:41,pymodule_getnam:41,pymodule_getnameobject:41,pymodule_getst:[41,96],pymodule_new:41,pymodule_newobject:41,pymodule_setdocstr:41,pymodule_typ:41,pymoduledef:[41,77,78,79,82,95,96],pymoduledef_bas:41,pymoduledef_head_init:[41,78,79,82,96],pymoduledef_init:41,pymoduledef_slot:41,pymp:284,pynode_fre:85,pynone_check:42,pynumber_:31,pynumber_absolut:43,pynumber_add:[31,43],pynumber_and:[43,50],pynumber_asssize_t:43,pynumber_check:43,pynumber_coerc:464,pynumber_coerceex:464,pynumber_divmod:43,pynumber_float:43,pynumber_floordivid:43,pynumber_index:[43,85,461],pynumber_inplaceadd:43,pynumber_inplaceand:[43,50],pynumber_inplacefloordivid:43,pynumber_inplacelshift:43,pynumber_inplacematrixmultipli:[43,469],pynumber_inplacemultipli:43,pynumber_inplaceor:[43,50],pynumber_inplacepow:43,pynumber_inplaceremaind:43,pynumber_inplacershift:43,pynumber_inplacesubtract:[43,50],pynumber_inplacetruedivid:43,pynumber_inplacexor:[43,50],pynumber_int:465,pynumber_invert:43,pynumber_long:[43,465],pynumber_lshift:43,pynumber_matrixmultipli:[43,469],pynumber_multipli:43,pynumber_neg:43,pynumber_or:[43,50],pynumber_posit:43,pynumber_pow:43,pynumber_remaind:43,pynumber_rshift:43,pynumber_subtract:[43,50],pynumber_tobas:43,pynumber_truedivid:43,pynumber_xor:[43,50],pynumbermethod:[57,81,458,461],pyo:[62,164,251,252,378,459,462,463,468,472],pyobjc:[87,453],pyobject:[3,5,6,7,8,9,10,11,12,13,14,16,17,18,19,20,21,22,23,24,25,26,27,28,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,47,48,49,50,51,53,54,55,56,57,58,60,61,77,78,79,81,82,83,85,95,96,124,177,321,458,461,462,471,472],pyobject_:[31,41,57,461],pyobject_as_gc:458,pyobject_ascharbuff:[44,472],pyobject_ascii:45,pyobject_asfiledescriptor:23,pyobject_asreadbuff:[44,472],pyobject_aswritebuff:[44,472],pyobject_byt:45,pyobject_cal:[45,57,79,472],pyobject_callfunct:[45,461],pyobject_callfunctionobjarg:45,pyobject_callmethod:[45,50,85],pyobject_callmethodobjarg:45,pyobject_callobject:[45,78,79,81,85],pyobject_calloc:[38,469,472],pyobject_checkbuff:7,pyobject_checkreadbuff:44,pyobject_clearweakref:[57,81],pyobject_del:[3,38,57,459],pyobject_delattr:45,pyobject_delattrstr:45,pyobject_delitem:[36,45,57,459],pyobject_delitemstr:459,pyobject_delslic:57,pyobject_dir:45,pyobject_format:190,pyobject_fre:[38,57,459,461,470,472],pyobject_from_gc:458,pyobject_gc_del:[26,57,458],pyobject_gc_fini:458,pyobject_gc_init:458,pyobject_gc_new:[26,57,458],pyobject_gc_newvar:[26,57,458],pyobject_gc_res:26,pyobject_gc_track:[26,458,472],pyobject_gc_untrack:[26,82,458,472],pyobject_genericgetattr:[45,57,98],pyobject_genericgetdict:45,pyobject_genericsetattr:[45,57],pyobject_genericsetdict:45,pyobject_getarenaalloc:[30,38],pyobject_getattr:[45,57],pyobject_getattrstr:[45,78,79,85,96],pyobject_getbuff:[7,44,57,462],pyobject_getit:[32,45,50,57],pyobject_getitem:[21,31,36,45,57],pyobject_hasattr:45,pyobject_hasattrstr:45,pyobject_hash:[45,50,57],pyobject_hashnotimpl:[45,57,462],pyobject_head:[53,57,81,82,464],pyobject_head_init:[53,57],pyobject_init:3,pyobject_initvar:3,pyobject_is_gc:[57,81],pyobject_isinst:[45,57,469,472],pyobject_issubclass:[45,56,469,472],pyobject_istru:[45,50,472],pyobject_length:[31,45],pyobject_lengthhint:[45,468],pyobject_malloc:[38,459,461,468,470,472],pyobject_new:[3,26,38,57,459],pyobject_newvar:[3,26,38,459],pyobject_not:[45,472],pyobject_print:[45,50,79,472],pyobject_realloc:[38,459,461,472],pyobject_repr:[45,50,57,58,468,469,472],pyobject_richcompar:[45,57,81],pyobject_richcomparebool:[45,50,81,472],pyobject_s:[45,57,472],pyobject_setarenaalloc:[30,38],pyobject_setattr:[45,57],pyobject_setattrstr:[45,85],pyobject_setitem:[31,36,45,57,461],pyobject_setslic:57,pyobject_str:[45,57,58,468],pyobject_typ:45,pyobject_typecheck:[45,81],pyobject_var_head:[53,57,81],pyobject_varnew:57,pyobjectarenaalloc:38,pyopengl:87,pyos_afterfork:[54,471,472],pyos_afterfork_child:[30,54,293,471,472],pyos_afterfork_par:[54,293,471,472],pyos_ascii_atof:[460,463,465],pyos_ascii_formatd:460,pyos_ascii_strtod:[460,463,465],pyos_beforefork:[54,293,471,472],pyos_checkstack:[22,54],pyos_double_to_str:17,pyos_fspath:[54,470,472],pyos_getsig:[54,456],pyos_inputhook:[60,472],pyos_readlinefunctionpoint:[60,85,468],pyos_setsig:[54,456],pyos_sighandler_t:54,pyos_snprintf:[17,458],pyos_stricmp:[17,462],pyos_string_to_doubl:[17,463,465],pyos_strnicmp:[17,462],pyos_vsnprintf:[17,458],pypa:[309,396,453],pypackag:461,pypars:472,pyparser_astfromfil:461,pyparser_astfromstr:461,pyparser_parsestr:85,pyparser_simpleparsefil:60,pyparser_simpleparsefileflag:60,pyparser_simpleparsestr:60,pyparser_simpleparsestringflag:60,pyparser_simpleparsestringflagsfilenam:60,pypi:[65,70,74,76,84,94,103,105,305,309,343,355,386,406,430,445,449,450,453,459,461,463,466,468,469,470,471,472],pypirc:472,pyport:456,pyproperty_typ:[20,98],pypy3:187,pypycload:[466,468],pyqt:[87,91,296,453],pyrange_new:[458,461],pyrange_typ:461,pyre:91,pyrex:85,pyrun_anyfil:60,pyrun_anyfileex:60,pyrun_anyfileexflag:60,pyrun_anyfileflag:60,pyrun_fil:60,pyrun_fileex:60,pyrun_fileexflag:60,pyrun_fileflag:60,pyrun_interactiveloop:[60,85],pyrun_interactiveloopflag:60,pyrun_interactiveon:60,pyrun_interactiveoneflag:60,pyrun_simplefil:[60,78],pyrun_simplefileex:60,pyrun_simplefileexflag:[60,472],pyrun_simplestr:[30,60,78,85,92],pyrun_simplestringflag:60,pyrun_str:[60,85],pyrun_stringflag:60,pyseqiter_check:33,pyseqiter_new:33,pyseqiter_typ:33,pysequence_:31,pysequence_check:[49,57],pysequence_concat:[49,57],pysequence_contain:[49,57],pysequence_count:49,pysequence_delitem:49,pysequence_delslic:49,pysequence_fast:49,pysequence_fast_get_item:49,pysequence_fast_get_s:49,pysequence_fast_item:49,pysequence_getitem:[31,49,57,85],pysequence_getslic:[49,57],pysequence_index:49,pysequence_inplaceconcat:[49,57],pysequence_inplacerepeat:[49,57],pysequence_item:49,pysequence_length:[31,49,85],pysequence_list:49,pysequence_repeat:[49,57],pysequence_s:[49,57,472],pysequence_setitem:[31,34,49,57],pysequence_setslic:49,pysequence_tupl:[49,472],pysequencemethod:[57,81],pyseri:90,pyset_add:[50,461],pyset_check:50,pyset_clear:50,pyset_clearfreelist:50,pyset_contain:[50,461],pyset_discard:[50,461],pyset_get_s:50,pyset_new:[50,461],pyset_pop:50,pyset_s:[50,461],pyset_typ:50,pysetobject:50,pyshar:466,pyshel:[161,187,248,321,470,471,472],pyshellext:472,pysid:[87,296],pysignal_setwakeupfd:[22,462],pyslice_adjustindic:[51,471,472],pyslice_check:51,pyslice_getindic:51,pyslice_getindicesex:[51,471,472],pyslice_new:51,pyslice_typ:51,pyslice_unpack:[51,471,472],pysliceobject:51,pysomething_typ:95,pyspam_api:79,pyspam_api_point:79,pyspam_system:79,pyspam_system_num:79,pyspam_system_proto:79,pyspam_system_return:79,pysqlit:[342,461,463,466],pystack:472,pystackv:472,pystate_addmodul:41,pystate_findmodul:41,pystate_removemodul:41,pystaticmethod_typ:98,pyston:[459,460,461,464,472],pystr:96,pystring_new:459,pystringobject:462,pystructsequence_desc:[55,471,472],pystructsequence_field:[55,471,472],pystructsequence_get_item:55,pystructsequence_getitem:55,pystructsequence_inittyp:[55,468],pystructsequence_inittype2:[55,468],pystructsequence_new:55,pystructsequence_newtyp:55,pystructsequence_set_item:55,pystructsequence_setitem:55,pystructsequence_unnamedfield:55,pysys_addwarnopt:[30,54,471,472],pysys_addwarnoptionunicod:[54,471],pysys_addxopt:[30,54,472],pysys_formatstderr:54,pysys_formatstdout:54,pysys_getobject:54,pysys_getxopt:54,pysys_resetwarnopt:[30,54,472],pysys_setargv:[30,463],pysys_setargvex:[30,31,463,466],pysys_setobject:54,pysys_setpath:54,pysys_writestderr:54,pysys_writestdout:54,pytest:385,pythn:[343,471],python18035:101,python1:[74,111],python25:111,python25_bcpp:111,python26:462,python27:454,python2:[77,85,111,112,113,346,418,455,457,462,468],python32:[111,466],python33:333,python35:[396,449],python36:470,python37:[447,448,455],python3:[78,94,95,101,104,109,111,112,113,189,201,209,215,298,299,335,356,368,378,396,418,434,444,449,451,454,455,463,466,468,470,472],python:[2,3,4,5,6,7,8,9,10,12,15,16,17,19,21,22,23,24,25,26,27,28,33,34,35,36,37,38,39,40,41,42,43,44,45,47,49,50,51,52,53,54,55,56,57,58,59,60,61,63,66,67,68,70,74,75,76,77,81,82,83,93,94,98,101,103,104,106,107,108,110,114,115,116,117,118,120,122,123,124,126,128,129,135,137,140,141,142,145,146,147,150,153,154,155,156,158,161,167,168,169,170,172,174,176,178,180,182,183,184,185,186,187,188,189,191,194,196,197,199,200,203,205,206,207,208,209,210,211,212,214,216,220,223,224,225,227,228,229,232,233,234,236,237,238,241,243,244,246,247,249,251,252,254,255,256,257,260,261,264,267,268,271,273,275,277,279,280,281,282,284,288,289,291,292,293,294,295,296,298,300,302,304,305,306,307,308,309,315,316,318,320,321,322,323,325,329,332,333,335,337,339,340,343,346,347,349,350,354,355,357,358,359,361,364,366,367,369,373,377,378,381,382,383,385,386,387,391,392,394,395,396,397,399,400,402,404,406,407,408,410,411,412,413,416,417,419,420,421,423,424,425,426,427,428,430,431,432,435,437,438,439,440,442,443,447,448,449,450,451],python_api_vers:[41,459],python_branch:[305,472],python_build:[305,472],python_compil:305,python_coroutin:472,python_dir:168,python_dom:407,python_for_gen:472,python_histori:[322,335,443],python_implement:305,python_is_optim:363,python_logo:416,python_revis:[305,472],python_vers:305,python_version_tupl:305,pythonapi:[177,461],pythonasynciodebug:[128,129,451],pythonbook:86,pythonbreakpoint:[355,451,471],pythonc:456,pythoncaseok:[451,457,472],pythoncoerceclocal:[451,471,472],pythoncor:[66,455,472],pythoncraft:90,pythondebug:[30,451],pythondecoratorlibrari:460,pythondevmod:[188,451,471],pythondoc:[315,472],pythondontwritebytecod:[30,91,355,451,462],pythondotorg:472,pythondumpref:[57,451],pythonexecut:451,pythonfaulthandl:[215,451,467],pythonfil:78,pythonhashse:[30,424,451,467,472],pythonhom:[30,31,111,363,451,455,470],pythonhost:343,pythonhttpsverifi:463,pythoninspect:[30,451,459],pythonioencod:[30,355,451,462,468,472],pythonlab:[422,456,458],pythonlaunch:453,pythonlegacywindowsfsencod:[30,355,451,470],pythonlegacywindowsstdio:[30,355,451,470],pythonmac:453,pythonmalloc:[38,62,451,472],pythonmallocstat:[38,451,472],pythonnn:92,pythonnousersit:[30,335,451,462],pythonoptim:[30,451,472],pythonpath:[30,31,77,92,111,153,355,363,428,446,451,453,455,468,472],pythonprofileimporttim:[451,471,472],pythonrc:434,pythonrun:[85,461,472],pythonshowalloccount:463,pythonshowrefcount:463,pythonstartup:[248,322,335,355,434,451,468,472],pythontest:472,pythonthreaddebug:451,pythontracemalloc:[378,451],pythonunbuff:[30,451],pythonuserbas:[335,451,462],pythonusersit:363,pythonutf8:[355,451,471,472],pythonverbos:[30,451],pythonvers:31,pythonw:[248,284,335,355,453,455,458,470,471,472],pythonwarn:[397,451,463,466,471,472],pythonwin:[86,87,91,177,455,456],pythonx86:455,pythonx:[31,78,111,335,346,396],pythonxi:[52,83,455],pythonxx:455,pythread:30,pythread_acquire_lock:472,pythread_acquire_lock_tim:472,pythread_create_kei:[30,472],pythread_delete_kei:30,pythread_delete_key_valu:30,pythread_get_key_valu:30,pythread_get_thread_id:[471,472],pythread_reinittl:30,pythread_release_lock:472,pythread_set_key_valu:[30,468],pythread_start_new_thread:[471,472],pythread_tss_alloc:30,pythread_tss_cr:30,pythread_tss_delet:30,pythread_tss_fre:30,pythread_tss_get:30,pythread_tss_is_cr:30,pythread_tss_set:30,pythreadst:[30,468],pythreadstate_clear:30,pythreadstate_delet:30,pythreadstate_get:[30,472],pythreadstate_getdict:30,pythreadstate_new:[30,472],pythreadstate_next:[30,458],pythreadstate_setasyncexc:[30,471,472],pythreadstate_swap:30,pytime_check:19,pytime_checkexact:19,pytime_fromtim:19,pytime_fromtimeandfold:19,pytimezone_fromoffset:[19,471],pytimezone_fromoffsetandnam:[19,471],pytpflags_have_gc:458,pytrace_c_cal:30,pytrace_c_except:30,pytrace_c_return:30,pytrace_cal:30,pytrace_except:30,pytrace_lin:30,pytrace_opcod:30,pytrace_return:30,pytraceback_her:472,pytraceback_print:[470,472],pytracebackobject:460,pytracemalloc_track:471,pytracemalloc_untrack:471,pytuple_check:[55,85],pytuple_checkexact:55,pytuple_clearfreelist:55,pytuple_get_item:55,pytuple_get_s:55,pytuple_getitem:[55,79,85],pytuple_getslic:55,pytuple_new:[31,55,78],pytuple_pack:[55,85,460],pytuple_s:[55,85],pytuple_set_item:55,pytuple_setitem:[31,50,55,78,79],pytuple_typ:55,pytupleobject:55,pytyp:[91,105,470],pytype_:57,pytype_check:[56,79],pytype_checkexact:56,pytype_clearcach:56,pytype_fromspec:[41,56,82,472],pytype_fromspecwithbas:56,pytype_genericalloc:[56,57],pytype_genericnew:[56,82],pytype_getflag:56,pytype_getslot:[56,468],pytype_hasfeatur:[56,57],pytype_is_gc:56,pytype_issubtyp:56,pytype_modifi:56,pytype_readi:[56,57,81,82,472],pytype_spec:56,pytype_typ:[56,57,472],pytypeobject:[3,8,9,11,12,14,16,18,20,21,24,25,26,27,31,33,34,35,40,41,42,45,50,51,53,55,56,57,58,81,82,95,457,469,472],pytz:184,pytzinfo_check:19,pytzinfo_checkexact:19,pyunicod:[19,58,96],pyunicode_1byte_data:[58,467],pyunicode_1byte_kind:[58,467],pyunicode_2byte_data:[58,467],pyunicode_2byte_kind:[58,467],pyunicode_4byte_data:[58,467],pyunicode_4byte_kind:[58,467],pyunicode_:96,pyunicode_as_data:[58,467],pyunicode_as_unicod:[58,467],pyunicode_asasciistr:[58,467],pyunicode_ascharmapstr:58,pyunicode_asdecodedobject:[470,472],pyunicode_asdecodedunicod:[470,472],pyunicode_asencodedobject:[467,470,472],pyunicode_asencodedstr:[58,472],pyunicode_asencodedunicod:[470,472],pyunicode_aslatin1str:[58,467],pyunicode_asmbcsstr:[58,467],pyunicode_asrawunicodeescapestr:[58,467],pyunicode_asucs4:[58,467],pyunicode_asucs4copi:[58,467],pyunicode_asunicod:[58,467],pyunicode_asunicodeands:[58,467],pyunicode_asunicodecopi:[58,467],pyunicode_asunicodeescapestr:[58,467],pyunicode_asutf16str:58,pyunicode_asutf32str:58,pyunicode_asutf8:[58,467,471,472],pyunicode_asutf8ands:[58,471,472],pyunicode_asutf8str:[58,467],pyunicode_aswidechar:58,pyunicode_aswidecharstr:[5,58,467,471,472],pyunicode_check:[58,82],pyunicode_checkexact:58,pyunicode_clearfreelist:58,pyunicode_compar:[58,467],pyunicode_comparewithasciistr:[58,466,472],pyunicode_concat:[58,467],pyunicode_contain:58,pyunicode_copycharact:[58,467,472],pyunicode_count:58,pyunicode_data:[58,467,472],pyunicode_decod:58,pyunicode_decodeascii:58,pyunicode_decodecharmap:58,pyunicode_decodefsdefault:[58,78],pyunicode_decodefsdefaultands:[54,58],pyunicode_decodelatin1:58,pyunicode_decodelocal:58,pyunicode_decodelocaleands:[54,58,471],pyunicode_decodembc:58,pyunicode_decodembcsst:58,pyunicode_decoderawunicodeescap:58,pyunicode_decodeunicodeescap:58,pyunicode_decodeutf16:58,pyunicode_decodeutf16st:58,pyunicode_decodeutf32:58,pyunicode_decodeutf32st:58,pyunicode_decodeutf7:58,pyunicode_decodeutf7st:58,pyunicode_decodeutf8:58,pyunicode_decodeutf8st:58,pyunicode_encod:[58,467],pyunicode_encodeascii:[58,467],pyunicode_encodecharmap:[58,467],pyunicode_encodecodepag:[58,467,472],pyunicode_encodedecim:[35,467],pyunicode_encodefsdefault:[54,58,472],pyunicode_encodelatin1:[58,467],pyunicode_encodelocal:[54,58,471,472],pyunicode_encodembc:[58,467,472],pyunicode_encoderawunicodeescap:[58,467],pyunicode_encodeunicodeescap:[58,467],pyunicode_encodeutf16:[58,467],pyunicode_encodeutf32:[58,467],pyunicode_encodeutf7:[58,467],pyunicode_encodeutf8:[58,467],pyunicode_fil:[58,467],pyunicode_find:58,pyunicode_findchar:[58,467,471,472],pyunicode_format:58,pyunicode_fromencodedobject:58,pyunicode_fromformat:[22,58,81,82,96,467,468,469,472],pyunicode_fromformatv:[54,58],pyunicode_fromkindanddata:[58,467],pyunicode_fromobject:58,pyunicode_fromstr:[21,31,58,78,82],pyunicode_fromstringands:58,pyunicode_fromunicod:[58,467],pyunicode_fromwidechar:[58,467],pyunicode_fsconvert:[5,58,470,472],pyunicode_fsdecod:[58,470,472],pyunicode_get_data_s:[58,467],pyunicode_get_length:[58,467],pyunicode_get_s:[58,467],pyunicode_getlength:[58,467],pyunicode_getmax:467,pyunicode_gets:[58,467],pyunicode_internfromstr:58,pyunicode_interninplac:58,pyunicode_join:[58,467],pyunicode_kind:[58,467],pyunicode_max_char_valu:[58,467],pyunicode_nbyte_data:58,pyunicode_new:[58,467],pyunicode_read:[58,467],pyunicode_read_char:[58,467],pyunicode_readchar:[58,467],pyunicode_readi:[58,467],pyunicode_replac:58,pyunicode_richcompar:58,pyunicode_split:58,pyunicode_splitlin:58,pyunicode_substr:[58,467],pyunicode_tailmatch:[58,467],pyunicode_transformdecimaltoascii:[58,467],pyunicode_transl:58,pyunicode_translatecharmap:[58,467],pyunicode_typ:[58,95],pyunicode_wchar_kind:[58,467],pyunicode_writ:[58,467],pyunicode_writechar:[58,467],pyunicodedecodeerror_cr:22,pyunicodedecodeerror_getencod:22,pyunicodedecodeerror_getend:22,pyunicodedecodeerror_getobject:22,pyunicodedecodeerror_getreason:22,pyunicodedecodeerror_getstart:22,pyunicodedecodeerror_setend:22,pyunicodedecodeerror_setreason:22,pyunicodedecodeerror_setstart:22,pyunicodeencodeerror_cr:22,pyunicodeencodeerror_getencod:22,pyunicodeencodeerror_getend:22,pyunicodeencodeerror_getobject:22,pyunicodeencodeerror_getreason:22,pyunicodeencodeerror_getstart:22,pyunicodeencodeerror_setend:22,pyunicodeencodeerror_setreason:22,pyunicodeencodeerror_setstart:22,pyunicodeobject:[58,95],pyunicodetranslateerror_cr:22,pyunicodetranslateerror_getend:22,pyunicodetranslateerror_getobject:22,pyunicodetranslateerror_getreason:22,pyunicodetranslateerror_getstart:22,pyunicodetranslateerror_setend:22,pyunicodetranslateerror_setreason:22,pyunicodetranslateerror_setstart:22,pyunit:[363,457],pyvarobject:[3,26,53,57],pyvarobject_head_init:[53,81,82,472],pyvenv:[112,335,396,455,467,468,470,472],pyvideo:450,pyw:[434,455,458],pyweakref_:57,pyweakref_check:61,pyweakref_checkproxi:61,pyweakref_checkref:61,pyweakref_get_object:61,pyweakref_getobject:61,pyweakref_newproxi:61,pyweakref_newref:[5,61],pywin32:[62,452,472],pywrapper_new:20,pyx:69,pyxml:[62,74,457],pyyaml:[463,465],pyz:[418,469,472],pyzipfil:[62,121,468],pyzmq:104,pyzw:[418,472],qa1067:453,qabxcd:189,qemu:[339,472],qfoutfil:292,qiflush:178,qmail:271,qmark:342,qname:[62,273,407,412,413],qnan:187,qpop:307,qscan:225,qsize:[136,284,318],qsort:177,qtc:225,qty:[342,461],quack:[93,104,462],quad:[339,458,472],quadrant:275,quadrat:[91,162,189,346,406,463,472],quadro:119,qualif:[434,451,468],qualifi:[62,74,93,106,190,198,251,252,254,267,268,301,305,321,336,337,339,346,382,385,395,413,420,424,428,432,455,461,469,472,473],qualifiednam:407,qualit:370,qualiti:[62,119,193,293,295,307,328,424,441,466,472],qualnam:[18,25,27,103,198,212,267],quantifi:[260,316],quantiti:[187,275,293,321,343,345,442,445,448,459,463,466],quantity_on_hand:182,quantiz:[187,467,472],quantum:293,quarterli:86,quartil:320,quartz:104,que:104,queen:[99,320,321,458,459],quentel:[471,472],quentin:471,queri:[29,62,69,90,95,99,104,106,109,120,135,137,153,159,170,206,220,232,252,254,263,282,298,305,307,329,342,352,359,363,370,372,373,382,391,392,402,404,407,416,428,451,461,462,463,465,466,467,468,469,472],query_field:465,query_opt:373,query_str:404,queryinfokei:402,queryperformancecount:367,queryreflectionkei:[402,462,463],queryvalu:402,queryvalueex:[402,472],quest:[347,438],questhead:370,question:[1,62,65,79,84,85,86,92,93,99,103,105,106,109,114,124,143,149,159,193,195,265,266,292,307,342,370,393,403,404,438,447,450,456,458,459,461,471,472],queu:[30,129,141,157,178,268,295,339,362,462],queue:[62,90,103,104,107,125,126,129,161,165,178,183,253,260,268,293,320,324,327,329,340,360,362,366,410,441,448,456,459,460,461,462,464,466,469,472],queue_handl:104,queueempti:136,queueful:136,queuehandl:[62,103,120,472],queuelisten:[62,120,469,472],queuemanag:284,qui:151,quick:[30,62,64,71,81,99,104,106,110,111,112,188,218,290,355,369,383,387,392,442,458,459,460,461,462,464,466],quick_ratio:189,quickest:444,quickli:[57,86,90,91,92,99,104,105,106,107,111,161,189,217,219,227,268,320,321,334,372,385,421,435,447,457,461,465,468],quickstart:467,quicktim:458,quiet:[65,94,164,187,275,292,355,363,394,455,463,466,469,472],quietli:[111,460,472],quinlan:[459,460,463,466],quirk:[97,346,428,430,436,438,453,468],quirki:342,quit:[7,64,72,74,78,79,82,86,90,91,94,95,97,99,103,104,106,107,122,145,169,170,177,178,185,201,225,237,248,257,268,275,284,288,292,299,307,311,336,337,343,370,395,426,428,430,436,437,443,444,446,447,456,457,458,459,461,467,468,472],quixot:459,quo:233,quopri:[62,147,159,253,285],quopri_codec:159,quot:[5,62,65,84,85,90,93,95,106,109,112,129,138,147,153,159,176,177,196,197,198,199,203,204,206,209,210,236,239,241,249,253,255,261,285,299,321,332,346,347,350,361,365,368,370,375,380,382,392,410,414,422,430,431,437,442,443,444,445,447,456,459,461,466,467,471,472],quota:[104,213,249],quotat:[93,153,159,350,442,462,472],quote_:176,quote_al:176,quote_from_byt:391,quote_minim:176,quote_non:176,quote_nonnumer:176,quote_plu:[391,466],quote_via:[391,469,472],quoteattr:414,quotechar:176,quoted_print:159,quotedprint:159,quotetab:[147,159,319],quotient:[14,184,187,227,275,310,346,426,440],quux:359,qwarn:463,r12:101,r13:472,r14:472,r5r:462,r_ok:293,rabic:384,race:[93,187,252,339,361,399,466,467,472],rad:[109,459],radian:[156,187,275,320,380,459],radic:460,radio:[92,282,372],radiobutton:[282,372,373,472],radiobuttongroup:282,radiogroup:282,radiu:[157,212,275,380],radix:[35,187,227,265,355,431],radixchar:265,radu:472,raffl:320,rafik:[469,472],rai:[466,468,472],rais:[2,5,7,9,13,17,21,23,25,29,30,31,33,35,41,43,45,49,50,53,54,55,57,58,60,61,62,65,66,79,81,82,84,92,93,96,97,98,99,102,104,105,107,109,110,113,117,122,123,124,125,127,128,129,130,131,132,135,136,137,138,139,140,141,142,143,144,145,147,148,149,151,153,155,156,158,159,160,161,164,167,168,169,170,171,172,173,174,176,177,178,182,184,185,187,188,190,193,195,197,198,199,200,203,204,206,207,209,212,214,216,219,223,225,227,228,229,230,231,232,234,237,243,244,245,246,248,249,251,252,253,254,255,257,258,260,261,264,265,266,267,268,269,271,274,275,279,282,283,284,286,287,288,291,293,294,295,297,298,299,301,304,306,307,308,312,313,316,318,320,321,324,325,327,329,330,331,333,334,336,337,339,340,341,342,343,345,346,347,349,350,351,352,354,355,356,358,359,360,363,366,367,370,375,378,380,381,382,384,385,386,389,391,392,394,395,396,397,398,399,400,402,403,404,405,406,407,410,411,412,413,416,419,420,421,423,424,425,426,427,428,429,431,434,436,437,438,441,442,446,448,451,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],raise_on_defect:[209,467],raise_on_error:193,raise_stmt:[427,432],raise_vararg:190,raiseexcept:[103,266,268,466],raison:65,raj:[469,472],ralf:[461,462],ralph:462,ram:[109,342,461,472],ramalho:472,rambl:99,ramchandra:[470,472],ramnani:468,ran:[161,193,214,350,385,462,463,472],rand:343,rand_add:[343,472],rand_byt:[343,467],rand_egd:[343,472],rand_list:99,rand_pseudo_byt:[343,467],rand_statu:343,randal:[91,108],randbelow:[328,472],randbit:328,randel:472,randint:[320,466],random:[30,62,79,84,91,93,97,99,104,109,120,136,151,159,161,174,175,193,219,220,228,237,248,253,256,257,260,284,290,292,310,321,329,359,361,380,385,395,407,421,424,441,447,450,451,456,457,458,459,460,461,462,463,464,467,468,469,472],random_combin:260,random_combination_with_replac:260,random_permut:260,random_product:260,randomli:[90,104,174,284,310,320,328,458,461,468],randrang:[90,260,320,447,460,466],randse:463,rang:[5,7,19,31,35,54,58,59,62,64,65,67,78,79,80,82,84,87,90,91,93,95,97,99,102,104,106,109,110,113,122,129,136,140,143,145,151,152,156,159,161,167,168,170,177,178,179,184,187,189,193,212,213,214,225,227,228,233,236,237,242,245,249,253,254,258,260,261,274,279,284,288,293,295,299,301,305,307,310,317,318,320,321,328,334,337,339,343,347,349,355,364,366,367,368,370,372,375,377,380,385,391,403,407,416,421,423,424,425,426,428,430,431,432,436,438,441,442,445,446,447,448,451,456,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],range_iter:472,rank:[291,410],ranlib:[65,472],raphael:236,rapid:[161,441],rapidli:[193,310],rare:[31,57,64,84,93,112,129,135,141,178,182,193,200,214,225,236,244,248,257,266,274,292,331,334,339,359,382,387,404,407,436,440,448,457,458,461,462,467,472],rarer:461,rarg:292,rarrow:374,raseliarison:463,rast:250,raster:250,rat:232,ratcliff:189,rate:[90,119,143,237,289,295,310,345,351,393,398,470,472],ratecv:[143,472],rath:[469,472],rather:[5,7,14,21,22,27,28,30,37,41,50,52,53,56,58,65,69,74,78,79,80,81,82,89,90,92,93,95,103,104,111,112,122,124,129,138,151,153,156,157,159,161,164,167,170,178,182,184,187,192,209,210,211,214,227,228,229,231,236,244,248,249,254,257,260,266,267,268,269,271,275,284,291,292,293,295,297,298,302,304,305,314,315,316,318,321,326,333,335,337,339,342,343,345,346,347,350,355,363,367,368,370,372,373,385,386,387,391,392,396,397,399,404,407,410,416,419,420,424,426,428,430,432,435,436,437,438,442,448,451,455,457,458,459,460,462,463,464,466,467,468,469,470,471,472],ratio:[151,189,275,345,346,380,440,467],ration:[62,184,187,253,289,290,346,424,440,462,463,464,466],rational:[86,93,96,211,214,227,293,329,330,334,339,367,399,424,456,457,458,459,460,461,462,463,464,466,468,469,470,472],ratnadeep:[471,472],raw:[5,7,15,29,30,62,93,103,106,120,122,124,153,168,177,178,190,193,197,198,206,207,208,227,232,253,254,269,278,284,288,293,298,330,332,339,340,343,346,364,367,368,370,377,379,392,395,396,399,412,421,431,445,457,459,461,462,464,467,469,472],raw_data:438,raw_data_manag:[198,209],raw_decod:[261,472],raw_input:[113,158,464],raw_unicode_escap:159,rawarrai:284,rawconfigpars:[62,218,267,463,468,472],rawdata:245,rawdescriptionhelpformatt:122,rawiobas:[227,257,462,467,469,472],rawparam:197,rawpen:380,rawtexthelpformatt:122,rawturtl:[62,224],rawvalu:284,rax:101,raymond:[97,98,99,108,178,349,456,457,459,460,461,462,463,465,466,467,468,469,470,471,472],raymondhetting:466,raynor:460,rbp:101,rbpb15:236,rbrace:374,rc4:[343,422,472],rcn:98,rcomplet:472,rcpt:[336,337],rcpt_option:[336,337],rcptto:336,rcvall_:339,rcvall_off:339,rcvall_on:339,rdivmod:472,rdmurrai:468,rdn:343,rds:467,rds_:339,rdstest:472,reach:[22,23,31,47,60,79,81,86,90,91,99,104,106,110,129,130,136,137,138,145,151,155,160,227,243,257,260,266,269,293,299,315,316,318,329,332,339,340,346,350,377,392,410,412,421,423,424,426,428,432,436,442,456,457,458,459,461,462,463,466,468,469,471,472],reachabl:[47,84,107,193,229,292,293,424],reacquir:[30,177,366],react:[57,97,272,456,462],reaction:[456,457],read1:[151,235,257,472],read:[5,7,21,22,23,28,30,37,39,44,53,57,58,60,62,65,71,72,73,74,75,76,78,79,81,82,84,85,86,91,92,93,94,95,96,97,98,99,101,103,104,105,106,107,110,111,113,115,118,121,122,123,125,130,132,137,138,141,142,144,147,148,150,151,153,157,158,159,160,161,162,164,167,168,171,177,178,182,184,185,189,193,195,201,204,205,208,209,212,213,214,216,217,218,219,220,225,227,228,229,231,232,235,237,241,243,244,245,246,248,249,252,253,254,256,257,261,264,266,267,271,274,276,278,279,283,284,286,288,292,293,294,295,298,299,301,303,304,305,306,307,310,311,314,315,316,321,322,327,329,330,331,332,333,334,337,339,340,342,343,344,345,346,347,349,350,355,356,360,361,366,367,370,373,375,376,377,378,380,381,386,387,389,391,392,393,394,395,396,397,399,401,404,407,410,411,412,413,414,416,418,419,421,422,424,427,428,431,433,434,435,436,437,439,441,444,445,446,447,448,450,451,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472,473],read_:360,read_al:360,read_binari:252,read_byt:[279,298,469,472],read_data:[386,442,472],read_dict:[168,466,471,472],read_eag:360,read_environ:[404,466],read_ev:410,read_fil:[168,267],read_histori:322,read_history_fil:322,read_init_fil:[322,325],read_lazi:360,read_mime_typ:276,read_multi:472,read_pkg_fil:69,read_restrict:81,read_sb_data:360,read_som:360,read_str:[168,466,469],read_text:[252,298,469,472],read_token:332,read_until:360,read_var:472,read_very_eag:360,read_very_lazi:360,read_windows_registri:276,readabl:[5,44,68,81,84,91,93,95,97,103,104,106,107,119,122,135,140,141,151,153,161,168,177,189,190,199,206,212,232,244,246,257,266,267,274,284,288,293,301,305,306,309,312,321,334,340,343,344,346,349,350,351,353,361,370,374,386,398,411,431,435,436,437,438,442,445,446,448,451,457,458,460,462,463,464,465,466,468,469,470,471,472],readal:[257,468,472],readcd:462,readconsol:472,readdir:[293,469],readelf:101,reader:[31,62,84,86,102,106,107,109,129,137,159,161,171,197,201,203,206,218,227,243,252,257,271,272,284,288,292,301,339,343,384,396,407,410,411,412,413,414,424,430,436,441,451,459,461,464,469,472],readermod:288,readerror:[359,472],readexactli:[137,470,472],readfil:472,readfp:[168,276,463],readfram:[119,351,398],readfunc:158,readi:[30,58,86,97,103,105,135,137,141,145,152,171,177,187,189,243,246,268,284,329,330,339,343,377,386,413,414,441,456,459,466,467,469,472],readili:[104,257,297,360,468,472],reading_head:125,readinto1:[257,469],readinto:[7,151,243,257,462,467,469],readlin:[23,60,62,65,74,84,85,90,99,109,129,137,138,142,144,153,157,159,168,171,189,205,208,214,219,225,227,249,253,257,267,279,293,298,299,301,317,332,340,364,370,375,378,386,392,396,418,419,424,434,436,439,442,443,444,451,456,457,458,459,461,462,463,466,468,471,472],readline_gener:168,readlink:[293,333,467,472],readm:[68,75,111,225,298,454,455,456,466,470,471,472],readmodul:[314,472],readmodule_ex:[314,472],readonli:[2,53,62,81,249,333,346,373,407,408,462,472],readplist:[306,462,468,471,472],readplistfrombyt:[306,468,471,472],readplistfromstr:462,readrc:[299,470,472],readthedoc:[404,461],readtransport:[129,135,471,472],readuntil:[137,469,470,472],readv:[293,467,469,471,472],ready_to_read:107,ready_to_writ:107,reak:299,real:[14,31,34,43,54,57,62,65,78,82,91,93,96,104,110,111,114,123,155,156,158,161,170,177,193,201,206,214,227,228,237,249,261,275,288,289,290,293,305,310,321,324,326,332,334,335,342,343,345,346,347,355,367,370,385,386,387,392,410,424,431,435,436,438,439,440,450,461,462,463,466,467,470,472],real_max_memus:363,real_person:410,real_quick_ratio:189,real_valu:245,realis:456,realist:[86,90,99,350,386,408,421,460,461],realiti:[65,79,184,292,339,392],realiz:[31,85,86,92,105,107,187,209,436,440,461,462],realli:[45,58,70,72,77,78,81,83,84,86,91,95,97,99,106,107,109,111,124,141,184,190,201,204,206,271,284,288,293,329,342,346,355,366,367,370,380,384,410,424,427,428,431,432,435,437,438,440,442,456,457,458,459,460,461,464,470,472],realloc:[9,38,49,79,85,91,178,460,470,472],realm:[110,209,392],realnam:210,realpart:436,realpath:294,realtim:350,realtime_priority_class:350,ream:462,reap:[134,472],reap_children:363,reap_thread:363,rearrang:[95,161,346,435,448,456,459,461,463,472],reason:[22,30,31,38,42,43,45,52,57,64,66,70,79,80,82,84,90,91,92,93,94,95,97,99,103,104,105,106,107,109,110,111,117,143,153,156,157,167,168,178,182,184,187,193,195,197,212,214,217,225,232,237,242,243,246,248,249,252,256,257,266,268,269,271,275,292,297,298,301,305,307,310,316,328,333,335,339,343,355,359,360,363,365,367,370,380,385,386,387,390,392,404,423,424,427,428,435,436,440,446,458,459,461,464,466,467,468,469,472],reassembl:135,reassign:[38,82,169,309],reassur:83,reattach:373,reattempt:333,rebas:472,rebind:[91,229,432,436,460],reboot:[284,298,468],rebound:[251,252,432,436],rebuild:[65,74,79,111,164,466,472],rebuilt:[276,467,469],rec:[316,408,410],rec_len:466,recal:[104,190,248,382,440],recalc:98,recalcul:[98,266,345],recap:98,recast:[260,466],reccontrol:295,receiv:[1,5,15,22,30,31,41,45,61,62,78,79,82,85,86,90,95,99,103,105,107,110,117,125,127,129,132,134,135,136,137,141,153,157,159,168,177,189,214,222,225,227,236,241,243,244,245,246,248,249,258,266,267,268,274,275,284,288,295,301,307,316,318,324,330,333,334,336,337,339,340,343,350,360,366,373,377,382,385,392,397,399,404,407,408,410,411,412,417,423,425,426,437,447,456,459,460,461,462,463,464,466,467,468,469,470,471,472],received_data:336,received_lin:336,recent:[64,65,79,82,90,91,92,94,99,102,104,109,122,128,136,153,161,168,170,177,187,193,211,212,215,228,235,241,248,249,254,258,266,268,284,293,295,297,298,299,301,308,309,316,318,321,337,339,343,346,347,349,350,355,363,370,372,377,378,380,384,385,386,387,391,397,399,424,426,432,436,437,438,439,442,445,448,449,451,453,455,456,457,458,459,460,461,462,463,466,467,468,469,470,471,472],recept:[129,135,137,336],recip:[62,69,91,104,110,149,162,175,183,189,201,212,226,251,252,275,290,293,317,331,342,346,355,450,466,472],recipi:[135,201,209,210,336,337,340],reciproc:345,recit:106,reclaim:[79,81,251,252,399],reclam:57,recod:5,recogn:[62,65,74,79,84,91,92,93,102,106,122,125,157,159,168,178,188,190,197,204,219,222,225,230,236,250,251,252,257,261,265,276,283,292,297,299,301,321,332,342,347,363,367,391,392,413,431,432,437,444,446,455,456,464,466,467,468,469,472],recognis:[92,176,267,332,386,418],recognit:276,recogniz:[84,187,227,472],recombin:[143,467],recommend:[5,30,31,38,41,44,57,58,62,64,65,71,72,74,77,78,79,81,82,86,89,91,92,94,95,96,99,103,105,109,111,112,122,125,131,134,135,137,140,141,159,168,174,177,182,184,187,192,193,197,212,227,232,236,238,243,246,248,249,252,254,261,266,275,288,295,298,301,308,310,316,321,326,336,339,340,343,346,350,355,359,361,367,382,385,392,395,396,404,406,407,408,412,413,421,424,428,431,437,446,454,455,456,458,460,461,462,463,464,466,467,468,469,470,471,472],recompil:[52,65,78,85,93,164,251,252,446,456,459,463,466,469,470],recomput:[103,329,330,334,468,472],reconfigur:[95,257,471,472],reconnect:[243,469,472],reconstitut:[266,301],reconstruct:[173,257,301,309,375,404,440,442],record:[28,62,81,84,97,99,103,104,108,109,111,114,124,145,149,157,161,176,177,178,179,185,187,198,204,212,213,237,254,258,260,266,268,271,280,291,292,293,295,301,310,311,342,344,346,349,363,380,381,385,386,387,397,401,419,428,436,441,456,459,460,461,462,463,466,467,468,469,472],record_attr_dict:268,record_factori:[104,266],record_foo_seen:292,record_numb:466,record_original_stdout:363,recount:187,recov:[159,214,223,355,394,412,463,466],recover:[328,412],recoveri:[202,249,328,392],recreat:[159,300,339,391,399,424,440,467,471,472],rect:[156,177,462],rectangl:[79,97,178],rectangular:[97,156,380],recur:373,recurr:260,recurs:[29,30,62,65,67,74,75,79,91,93,99,113,124,153,164,168,171,172,182,189,190,193,197,201,206,214,217,227,233,251,252,261,274,284,293,298,299,301,304,309,310,315,323,331,333,344,355,358,359,366,380,382,385,386,392,409,410,419,424,428,432,436,438,456,457,458,459,460,462,466,468,469,470,471,472],recursionerror:[22,214,301,355,469,470,472],recursive_repr:[22,323,466,472],recv:[104,107,129,141,284,330,339,340,343,370,463,469,472],recv_byt:284,recv_bytes_into:284,recv_fd:339,recv_into:[129,339,343,461,463],recv_json:104,recvfd:472,recvfrom:[339,370,469,472],recvfrom_into:[339,461,463],recvmsg:[339,467,469],recvmsg_into:[339,467],recycl:[107,117,366],red:[66,72,85,86,97,103,104,106,108,111,149,152,161,163,178,212,241,320,345,346,370,373,380,399,422,448,459,460,465,470,472],redact:466,reddi:471,redefin:[65,91,111,145,162,241,251,252,340,424,436,459,462],redefinit:[65,251,252,424,472],redemo:[106,472],redesign:[84,462,463,468],redhat:[71,232,305],redic:5,redirect:[7,57,62,66,92,103,110,135,138,170,242,243,244,246,252,266,334,350,355,392,441,451,456,468,469,470,471,472],redirect_request:392,redirect_stderr:[170,469,472],redirect_stdout:[170,468,469],redirector:[396,471,472],redisplai:[178,322,459],redistribut:[64,422],redistributor:463,redo:[178,248,472],redraw:97,redrawln:178,redrawn:[97,178,380],redrawwin:178,reduc:[31,38,51,81,91,99,113,135,178,187,228,236,238,248,257,260,293,297,301,310,320,328,329,343,346,366,386,399,406,418,431,440,446,455,456,458,459,461,462,463,464,465,466,467,468,469,470,471,472],reduce_someclass:301,reduct:[35,84,91,173,301,346,467,472],reductionist:106,redund:[75,79,95,118,269,294,321,382,421,432,458,463,472],ree:472,reedi:[109,459,469,470,471,472],reenabl:[363,463],reentranc:[62,120,170,318,472],reentrant:[62,257,317,318,366,468,472],reexecut:[66,251],ref:[5,61,84,178,399,457,463,468,472],ref_api:363,refactor:[93,99,113,385,386,387,460,468,469,470,471,472],refchild:407,refcount:[9,30,57,58,363,461,472],refcount_test:363,refer:[0,3,5,6,7,8,9,10,11,12,13,14,15,16,18,19,20,21,22,23,24,25,26,27,28,30,32,33,34,35,36,37,38,39,40,41,42,43,45,48,49,50,51,53,54,55,56,57,58,60,62,64,66,69,71,72,73,74,75,76,77,78,80,82,83,84,90,92,93,95,98,100,102,103,104,106,110,111,112,117,120,122,126,129,131,135,137,138,141,143,145,156,159,161,165,168,171,172,178,183,184,186,190,192,206,211,213,214,216,227,228,229,230,232,234,236,239,240,241,244,246,248,251,252,253,254,255,257,258,261,266,267,268,271,273,279,288,289,293,294,297,299,301,304,305,308,309,315,316,321,326,330,333,335,339,342,343,345,346,347,349,352,353,355,357,362,363,366,367,369,372,373,374,377,380,381,382,385,386,387,391,392,393,396,397,402,406,407,408,412,414,418,419,423,424,425,430,431,432,435,436,437,438,439,440,441,442,450,451,455,456,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472,473],referenc:[5,7,11,31,55,57,61,79,81,84,91,93,103,106,122,168,180,190,228,248,254,284,293,301,321,346,354,399,407,424,436,437,438,442,446,455,457,458,459,462,463,464,467,472],referenceerror:[22,214,399,446,457,458],referencetyp:399,referendum:442,referenti:[84,301],referr:229,refin:[91,471,472],refleak:[363,472],reflect:[29,59,62,65,66,91,93,94,101,104,119,122,161,169,176,178,184,193,211,216,228,248,252,254,292,293,310,322,339,343,346,349,355,370,380,381,398,402,408,418,424,451,462,466,467,469,472],reflex:426,reflow:222,refold:[202,209,467],refold_head:209,refold_sourc:[202,209,467],reformat:[248,271,292,459,472],refresh:[97,178,288,373,461],refus:[31,107,213,214,288,331,337,339,343,419,472],reg_binari:[402,472],reg_dword:402,reg_dword_big_endian:402,reg_dword_little_endian:402,reg_expand_sz:402,reg_full_resource_descriptor:402,reg_link:402,reg_multi_sz:402,reg_non:402,reg_qword:[402,470,472],reg_qword_little_endian:402,reg_resource_list:402,reg_resource_requirements_list:402,reg_sz:402,regard:[31,95,96,103,112,118,170,206,236,293,346,350,361,407,422,428,436,455,472],regardless:[2,9,23,30,31,37,54,58,64,65,66,74,84,105,111,122,140,167,170,176,178,184,187,193,209,221,227,248,252,256,257,260,261,297,298,304,316,334,337,339,343,346,347,349,350,355,361,373,380,385,386,387,396,397,399,400,409,426,428,431,439,451,455,466,467,468,469,471,472],regdeletekeyex:402,regebro:[463,472],regen:[62,472],regener:[75,202,313,428,463,469,470,472],regex:[106,164,221,265,321,360,385,457,461,462,466,468,471,472],regexflag:[321,471,472],regexp:[363,466,472],region:[178,248,283,293,321,370,373,436,462,465,472],regist:[1,13,30,54,62,66,71,79,82,87,90,93,95,109,110,118,122,129,131,134,135,142,159,162,168,170,172,176,193,198,204,209,215,227,228,242,252,253,257,266,276,284,289,293,300,304,322,329,330,333,339,343,346,355,363,370,373,380,385,392,397,399,400,403,407,410,412,417,418,424,426,428,450,456,457,459,460,462,463,466,467,468,469,471,472],register_adapt:342,register_archive_format:[333,466],register_at_fork:[54,293,471,472],register_convert:342,register_defect:209,register_dialect:176,register_error:[159,227,257,346,459],register_funct:[416,417,471,472],register_inst:417,register_introspection_funct:417,register_multicall_funct:[416,417],register_namespac:[410,463,466],register_optionflag:193,register_shap:380,register_unpack_format:333,registerdomimplement:407,registerresult:385,registr:[30,54,159,170,293,301,330,392,402,417,418,462,472],registri:[22,29,58,59,62,146,168,176,196,198,204,228,251,252,253,258,268,276,301,305,343,355,392,397,401,403,410,455,456,462,463,470,472],regloadkei:402,regress:[62,84,91,95,188,193,253,261,463,468,469,472],regroup:298,regrtest:[363,378,459,463,472],regsub:461,regtyp:359,regular:[7,10,57,62,65,67,72,75,82,84,86,90,91,93,98,99,100,104,111,118,122,129,135,161,168,170,176,187,193,201,211,221,227,235,237,244,253,254,260,265,267,293,294,298,301,310,313,329,334,337,339,343,344,346,347,355,359,360,363,364,380,382,385,392,397,399,424,431,432,436,447,448,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],regularli:[30,38,64,105,112,214,380,455],regulatori:448,rei:460,reid:[463,466],reifschneid:[457,459,460,461,463],reign:265,reilli:[106,321,368,450,458,469,472],reimplement:[82,380,385,458,468,469,470,471,472],reimport:472,reinforc:450,reingold:[152,184],reinhardt:458,reiniti:[57,472],reinitialis:428,reinsert:[363,373,463,465],reinstal:[38,89,111,455],reinstat:[266,436],reinterpret:[62,300],reintroduc:431,reiter:95,reitz:449,rejeb:460,reject:[7,102,106,168,244,320,382,431,432,456,463,468,470,472],rejoin:209,rekei:343,rel:[30,31,62,64,65,66,74,85,92,95,103,106,111,113,114,123,129,155,156,159,170,178,184,189,190,193,210,211,216,222,227,233,246,252,257,265,266,269,275,279,282,293,294,298,301,304,310,316,319,320,321,326,327,332,333,339,342,343,346,350,363,367,370,372,373,376,385,386,391,396,402,404,410,412,418,419,429,432,438,442,446,447,451,455,456,457,458,460,463,464,467,468,469,470,472,473],rel_tol:[156,275,469],relai:[336,395,471,472],relat:[1,2,30,38,41,57,62,71,74,84,86,90,91,93,98,99,104,109,111,135,140,146,155,161,168,178,183,184,193,195,197,201,206,208,209,214,218,225,230,232,236,237,251,253,255,256,258,260,271,281,284,290,297,300,302,316,317,322,328,334,339,342,343,345,346,347,358,367,369,373,381,397,399,409,412,422,424,426,431,436,448,449,450,452,455,456,457,459,460,461,462,463,464,466,467,468,470,471,472],relationship:[62,71,135,184,193,237,300,346,355,370,376,399,407,422,424,436,461,472],relative_modul:432,relative_to:298,relativecr:[104,266],relax:[95,99,184,245,466,472],relay:336,releas:[1,3,4,5,7,11,26,31,32,38,44,52,53,56,57,58,62,66,68,71,72,74,78,79,81,82,83,86,87,90,93,97,99,105,108,109,110,111,114,117,124,129,139,170,177,178,190,192,193,211,227,236,237,251,254,257,266,271,284,293,301,305,328,339,342,346,355,358,363,366,378,380,382,397,406,419,422,424,432,436,439,446,450,451,454,455,456,457,458,459,460,461,462,464,466,473],release_db_connect:170,release_lock:[251,464],release_resourc:170,release_special_resourc:170,release_url:309,releasebufferproc:57,releaselevel:[355,463,465],relev:[57,65,79,81,90,94,95,97,99,102,103,104,125,146,168,172,187,193,195,209,216,225,227,243,246,261,267,268,288,292,293,302,304,308,343,346,350,356,363,364,385,404,411,455,456,458,460,467,468,469,470,472],reli:[23,62,79,82,91,93,96,104,105,107,112,135,142,153,161,176,177,182,184,212,222,251,252,254,266,276,292,293,301,304,305,320,331,333,361,363,365,366,367,385,387,418,424,425,436,446,456,459,460,461,463,465,466,467,468,469,470,471,472],reliabl:[54,107,129,135,159,162,187,284,294,305,400,412,421,423,428,436,440,448,455,459,463,466,467,468,469,470,471,472],reliable_datagram_socket:467,relicens:460,relief:[370,373],relink:85,relinquish:[293,366],reload:[28,91,113,159,244,248,251,252,355,363,378,428,446,459,464,468,471,472],reloc:[49,462],relpath:[294,298,462,472],remahl:462,remain:[5,32,38,57,64,65,69,79,82,84,86,99,104,106,112,122,129,140,147,155,161,162,170,176,177,178,184,187,189,190,192,193,195,196,199,203,204,206,209,210,212,219,229,237,248,249,251,252,267,271,275,284,292,293,295,299,301,314,324,326,334,336,339,342,346,347,355,363,365,366,373,380,381,385,391,399,404,410,421,422,424,428,431,432,437,438,445,447,451,458,459,460,462,463,464,465,466,467,468,469,470,471,472],remaind:[31,43,81,101,106,122,157,184,187,209,227,256,267,275,292,298,321,346,385,426,440,445,462,471,472],remainder_near:187,remap:465,remark:[62,86,271,380,387,441,456,460],rembrandt:161,remedi:86,rememb:[68,79,84,86,89,91,93,94,95,96,97,98,99,103,104,106,111,149,160,161,193,227,248,252,260,284,321,349,363,373,392,399,407,409,432,436,437,440,445,446,453,455,456,457,461,462,463,465,466,467],remi:472,remind:[31,84,91,346,437,464,472],remot:[62,86,103,104,111,123,125,129,132,135,141,165,171,213,243,249,266,267,268,336,339,343,360,372,392,400,402,406,411,415,416,447,458,466,469,472],remote_addr:[129,135],remote_command:332,remote_host:129,remote_port:129,remoteaddr:336,remotedisconnect:[243,469,472],remoteerror:284,remov:[5,21,26,28,31,35,36,41,45,50,52,58,60,62,65,66,75,79,81,82,84,86,89,90,93,95,96,99,103,104,106,108,110,111,113,122,123,124,125,129,131,132,134,135,136,137,140,142,144,145,153,157,158,161,162,168,170,176,177,178,180,184,185,187,190,193,195,197,201,204,206,208,209,211,212,213,214,219,225,227,237,238,241,243,244,248,249,252,254,258,260,261,265,266,268,270,271,282,284,286,291,292,293,298,299,301,305,307,310,315,316,318,321,322,327,329,330,332,333,334,335,342,343,346,347,351,355,360,361,363,365,367,373,374,380,381,382,385,386,391,392,397,398,399,402,407,410,418,419,422,423,424,426,428,432,436,438,444,445,446,448,449,451,452,453,456,457,458,459,460,466,467,472,473],remove_child_handl:134,remove_done_callback:[131,140,472],remove_expon:187,remove_flag:271,remove_fold:271,remove_gray_shad:93,remove_head:[392,468],remove_histori:322,remove_history_item:322,remove_label:271,remove_mem_hook:472,remove_opt:[168,292],remove_pyc:282,remove_read:[129,132],remove_readonli:333,remove_sect:168,remove_sequ:271,remove_signal_handl:[129,132,133],remove_task:237,remove_thi:321,remove_tre:65,remove_var_callback:472,remove_writ:[129,132],removeattribut:407,removeattributen:407,removeattributenod:407,removechild:[407,456],removedir:[90,293],removefilt:[103,266],removehandl:[103,104,266,385,463],removenameditem:407,removeresult:385,removexattr:[293,467],renam:[38,57,62,65,74,82,90,104,111,113,123,161,168,214,225,248,249,268,271,293,298,313,329,333,344,385,386,418,435,436,437,448,456,458,459,460,462,463,464,465,466,467,469,470,472],renaud:[467,472],render:[104,109,129,199,202,225,308,340,370,373,377,408,424,459,462,463,472],render_goodby:171,rendezv:[293,466],rendit:178,renegoti:[343,463],renew:466,renumb:[212,249,424],reobj:221,reopen:[95,103,225,268,301,360,463,470,472],reopenifneed:[268,470],reoprt:321,reorder:[84,91,161,212,286,305,472],reorgan:[185,195,457,462,465,470,472],reorganis:456,reorpt:321,repack:347,repaint:178,repair:[425,455],repars:472,reparse_data_buff:472,repeat:[49,53,57,62,85,93,95,99,107,113,122,147,157,161,162,177,178,184,198,215,227,236,237,238,248,260,285,292,295,299,310,320,321,339,340,343,346,347,349,368,376,377,380,382,385,386,392,406,423,424,439,440,445,451,458,459,460,462,463,466,467,468,469,470,472],repeat_on:280,repeatedli:[30,84,106,110,157,177,189,260,265,276,366,368,380,385,402,403,404,423,448,458,466,470],repeatfunc:260,repertoir:[316,337,372,462],repetit:[106,122,151,236,260,269,321,346,368,377,385,387,397,424,426,430,458,472],repl:[321,472],replac:[13,21,31,34,38,40,51,55,57,58,62,64,65,70,74,77,79,84,90,91,92,94,95,97,99,104,109,110,111,113,122,124,134,152,153,158,159,161,165,168,177,178,180,182,184,189,190,193,197,198,203,206,207,210,212,214,215,219,227,231,236,237,240,241,248,251,252,253,254,257,260,265,266,267,271,272,276,280,284,292,293,294,298,299,305,309,310,317,320,321,322,323,332,333,334,336,342,343,346,347,355,359,361,363,365,367,370,372,373,375,378,380,381,382,384,385,386,387,391,392,396,397,399,404,406,407,410,412,414,418,419,424,426,429,431,432,435,436,442,445,446,447,451,455,456,459,460,461,462,463,464,465,466,467,468,469,470,471,472],replace_error:159,replace_head:[197,206],replace_history_entri:322,replace_history_item:322,replace_path:280,replace_paths_in_cod:472,replace_whitespac:365,replacechild:407,replacement_field:431,replacepackag:280,replai:386,repli:[107,184,204,225,246,271,284,288,337,392,472],replic:[91,99,209,284,455,460,463],replstr:58,repo:472,report:[1,7,21,23,30,31,36,41,44,45,65,78,79,91,92,101,102,103,106,109,122,135,141,153,154,167,176,177,178,190,193,197,204,206,214,217,227,234,254,258,260,280,284,292,293,297,305,308,310,312,316,321,329,330,334,336,341,343,344,346,355,363,368,376,382,385,392,397,410,412,439,448,450,451,456,458,459,460,461,462,463,466,467,468,470,472],report_:193,report_cdiff:[193,460],report_failur:193,report_full_closur:217,report_ndiff:[193,460],report_only_first_failur:193,report_partial_closur:217,report_start:193,report_success:193,report_udiff:[193,460],report_unexpected_except:193,reporthook:392,reporting_flag:193,reposit:[159,161],repositori:[62,64,86,112,252,454,456,457,461,463,473],repr1:323,repr:[17,22,23,45,57,58,62,81,104,108,109,113,141,177,182,183,184,190,193,212,227,248,252,253,284,316,330,339,346,347,355,363,365,375,377,381,382,386,387,424,431,432,440,442,446,448,456,457,459,462,463,464,465,466,467,468,469,470,471,472],repr_textiowrapp:323,repr_typ:323,repres:[5,7,8,9,10,12,14,16,17,19,21,24,25,30,31,34,35,40,41,43,50,53,55,57,58,60,62,65,70,74,79,83,84,90,91,93,95,97,99,102,104,105,106,107,109,110,111,122,123,124,129,131,135,137,140,145,147,152,153,155,156,159,161,167,168,169,177,178,184,187,190,195,198,200,202,204,207,209,210,214,216,222,223,225,227,243,244,245,249,252,254,257,258,261,265,266,267,269,271,272,275,276,282,283,284,285,286,288,292,293,294,297,298,301,306,307,308,309,310,316,321,323,324,327,329,333,334,337,339,340,342,343,345,346,347,348,349,350,353,354,355,359,360,363,366,367,370,372,373,374,377,380,382,385,386,387,394,395,397,399,402,407,408,409,410,413,416,417,418,419,421,424,426,428,431,436,440,442,448,456,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],represent:[7,9,14,17,24,35,37,45,53,54,57,58,62,65,74,75,81,82,91,93,95,103,105,107,109,122,123,147,148,156,159,161,168,177,178,179,184,187,197,198,202,205,206,208,212,213,214,222,227,237,243,245,246,249,252,258,261,265,266,271,272,282,284,290,293,294,297,298,301,309,316,323,331,339,342,346,347,348,349,353,355,367,374,377,380,382,385,405,407,410,422,424,428,441,442,448,456,460,461,462,463,465,466,468,469,470,472,473],reprfunc:[57,81],reprlib:[22,62,183,253,448,464,472],reprnam:184,reproduc:[62,91,110,124,202,290,363,392,414,422,448,466,471,472],reptil:435,republ:422,reput:1,req:[90,110,343,386,392,466],request:[1,2,28,30,38,41,57,62,82,90,91,99,102,104,107,109,110,112,122,125,127,130,132,135,140,144,153,159,161,167,170,177,178,187,198,209,211,212,213,214,216,225,228,232,235,242,243,244,245,246,248,249,251,252,253,255,257,271,284,288,291,292,293,294,295,297,301,307,309,316,324,329,332,334,335,336,343,346,350,355,363,367,373,380,386,389,391,393,396,402,404,407,413,414,416,417,424,428,432,436,445,447,448,449,455,456,457,459,460,461,462,463,466,467,468,469,471,472],request_entity_too_larg:242,request_header_fields_too_larg:242,request_host:392,request_method:[110,392,404,472],request_queue_s:340,request_r:[393,472],request_text:417,request_timeout:242,request_uri:404,request_uri_too_long:242,request_vers:246,requestb:392,requested_range_not_satisfi:242,requestedexecutionlevel:472,requesthandl:417,requesthandlerclass:[246,340,404],requestlin:246,requestr:393,requir:[5,7,11,17,22,26,30,31,38,41,53,57,58,62,64,65,66,68,69,70,74,75,77,78,79,81,82,85,86,89,90,91,92,93,94,95,97,98,99,101,103,104,105,106,109,110,111,112,113,117,118,120,123,129,140,151,152,158,159,161,162,168,170,171,176,178,182,184,185,187,190,193,195,196,197,201,202,203,204,208,209,211,212,213,214,222,223,225,227,229,230,235,236,237,241,244,246,248,249,251,252,254,255,256,257,260,261,264,265,266,267,268,269,271,275,282,284,288,292,293,295,297,301,302,303,307,309,310,312,316,318,321,324,329,331,333,337,339,340,342,343,345,346,347,349,350,355,357,359,361,363,366,367,370,372,373,375,379,381,382,384,385,386,391,392,394,396,399,402,404,406,407,410,411,412,413,414,416,418,419,421,422,423,424,426,428,431,432,436,437,438,440,442,443,446,448,449,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],require_int:460,required_on:363,requires_android_level:472,requires_bz2:363,requires_dist:309,requires_docstr:363,requires_freebsd_vers:363,requires_gzip:363,requires_ieee_754:363,requires_linux_vers:363,requires_lzma:363,requires_mac_vers:363,requires_multiprocessing_queu:472,requires_python:309,requires_resourc:363,requires_zlib:363,requot:[197,206],rerais:[170,284,346,423,424,472],rerun:[95,428,464],res:[38,74,85,140,243,284,339,472],resampl:320,rescan:[159,304],reschedul:129,rescu:214,research:[63,99,422,472],resembl:[82,111,178,212,227,244,299,332,451,458,462,463],resent:[204,210,271,337],resent_cc:210,resent_to:210,resequenc:466,reserv:[31,57,62,63,93,98,107,212,254,258,274,298,301,320,321,324,341,346,366,391,395,402,407,416,419,422,423,424,432,439,451,457,462,464,466,471],reserved_futur:395,reserved_microsoft:395,reserved_nc:395,reset:[16,30,54,86,91,99,110,137,139,145,157,158,159,161,171,178,187,189,199,207,213,214,215,219,241,246,248,252,266,284,293,294,295,303,328,329,334,336,339,343,346,355,357,359,363,366,367,372,376,380,385,386,397,405,409,410,413,431,458,462,466,467,468,469,472],reset_cont:242,reset_mock:[386,470,472],reset_prog_mod:178,reset_shell_mod:178,resetbuff:158,resetlocal:265,resetopt:372,resetscreen:380,resetti:178,resetwarn:[397,466],reshuffl:320,resid:[84,104,111,201,232,271,293,315,324,342,344,428,455,456],resign:97,resist:[106,236,333,457,463,467],resiz:[5,8,9,26,38,49,51,55,58,84,177,178,257,279,346,370,372,373,380,385,469,471,472],resize_term:178,resizemod:380,resizeterm:178,resolut:[57,62,81,82,84,93,118,120,129,133,184,215,217,227,228,246,254,293,295,298,301,310,339,346,367,424,436,459,461,467,468,469,470,472],resolv:[62,81,84,91,93,103,104,122,129,140,168,184,190,193,222,252,254,258,267,292,293,298,310,316,339,343,355,381,385,386,396,408,409,412,413,414,425,436,449,451,455,458,467,468,469,470,471,472],resolve_attr:291,resolve_bas:[381,471],resolve_dotted_attribut:460,resolve_nam:[252,472],resolveent:[412,413],resort:[93,103,185,265,266,361,370,458],resourc:[7,22,30,44,57,62,65,72,74,86,90,91,93,100,104,107,108,112,124,134,135,139,167,170,193,213,214,228,243,249,253,266,273,281,284,293,296,304,330,333,339,343,346,355,363,366,370,373,378,385,388,391,392,395,397,402,404,406,413,416,424,428,439,442,448,450,451,452,459,461,462,463,466,470,472],resource_nam:363,resource_path:252,resourcedeni:363,resourceload:[252,471,472],resourcemanag:170,resourceread:[252,471,472],resourcewarn:[22,128,214,229,293,350,363,385,397,446,466,470,472],resp:[159,265,288,309,469],respect:[5,6,7,17,21,22,28,30,35,42,43,45,47,51,58,65,74,78,79,81,82,84,90,91,92,93,98,103,104,106,113,122,143,151,152,153,156,159,162,168,169,177,178,184,187,190,193,195,197,209,210,212,214,222,225,227,232,244,246,251,252,254,257,261,266,267,268,269,275,279,284,293,298,301,307,310,311,324,333,335,337,339,340,342,343,346,347,349,350,351,355,359,366,367,372,373,380,385,394,408,422,424,426,428,432,436,445,448,451,453,456,458,460,462,464,466,467,468,470,471,472],respect_handler_level:[104,268,469,472],respond:[110,225,243,246,248,268,315,336,339,343,370,386,404,416,417,463,472],respons:[5,17,22,31,41,56,57,58,62,64,72,79,82,84,85,93,95,99,103,107,109,110,111,112,129,135,138,157,170,176,178,180,184,190,197,212,222,225,243,244,246,249,251,252,253,255,259,265,266,288,307,316,327,336,337,339,340,342,343,350,354,355,361,382,385,387,390,398,409,416,417,418,424,426,428,437,447,448,455,456,459,462,463,466,467,468,469,471,472],responseerror:472,responsenotreadi:243,ressembl:201,rest:[9,17,58,83,85,86,91,94,95,99,103,106,107,113,122,123,137,178,187,193,225,228,251,266,276,292,293,321,325,346,363,373,375,416,423,424,431,432,435,437,439,442,456,458,459,461,462,463,464,467,468,471,472],restart:[30,178,213,225,248,267,299,334,362,446,462,463,469,472],restat:310,restkei:176,reston:422,restor:[16,22,30,31,57,81,95,97,104,134,159,171,172,178,187,189,190,222,244,248,254,265,292,301,303,320,321,322,326,342,350,355,359,362,363,366,373,380,385,386,387,397,402,423,424,456,458,459,461,462,468,471,472],restore_sign:350,restrict:[7,62,79,81,82,84,94,95,106,117,122,123,152,159,161,177,178,183,184,187,189,206,222,225,227,248,255,261,284,293,297,300,310,314,321,339,343,346,347,348,366,386,407,416,417,422,423,426,427,431,432,436,437,451,455,457,459,460,461,462,463,464,466,467,468,469,470,471,472],restricted_load:301,restrictedunpickl:301,restructur:[87,91,107,309,456,457,462],restructuredtext:[0,62,69,74,86,193,472],restval:176,restyp:[177,461],result:[5,7,8,9,12,14,19,22,28,30,31,35,38,41,43,45,48,49,55,56,57,58,60,62,65,66,72,74,77,78,79,81,82,90,92,93,94,95,96,97,98,99,102,103,104,105,106,109,111,119,124,128,129,130,131,135,138,139,140,141,143,144,145,147,148,153,154,156,159,160,161,164,167,169,170,171,174,177,178,179,182,184,187,189,190,193,197,198,200,202,204,206,207,208,209,210,212,213,214,216,217,220,222,225,227,228,229,232,233,235,236,238,243,244,245,246,248,249,251,252,253,254,255,257,258,260,261,266,267,268,269,271,272,275,276,279,282,283,284,288,291,292,293,294,295,297,298,299,301,305,306,307,309,310,311,313,319,320,321,323,324,326,328,329,332,333,334,337,338,339,342,343,345,346,347,348,349,350,354,355,356,359,360,361,363,365,366,367,368,373,375,376,377,378,380,381,382,385,386,387,392,394,395,397,399,400,402,404,406,407,408,410,413,414,416,417,418,421,422,423,424,426,427,428,431,432,437,438,439,440,442,443,445,446,447,448,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],resultclass:385,resum:[13,93,99,132,135,136,137,140,170,178,179,190,254,284,293,299,301,316,318,362,366,404,423,424,426,436,458,459,460,461,472],resume_read:[132,135,471,472],resume_writ:[132,135],resumpt:[293,470,472],resurrect:[424,466],resynchron:[109,467],ret:404,retain:[65,79,108,122,161,170,178,197,206,209,214,248,251,252,254,260,266,271,297,332,342,343,350,380,391,416,422,424,426,431,467,468,470,472],retarget:404,retcod:350,retr:[225,307],retrain:464,retrbinari:225,retri:[62,95,106,110,214,227,268,293,329,330,334,339,343,350,392,425,437,458,459,463,472],retriev:[5,10,22,25,30,32,35,41,45,51,62,66,78,79,81,84,90,91,93,97,98,99,106,110,136,140,153,161,167,168,172,177,178,185,197,204,208,209,225,227,228,235,244,248,249,253,257,264,265,267,271,284,289,291,293,297,301,304,306,307,317,318,321,324,329,331,342,343,346,347,355,361,378,386,392,399,402,406,410,422,424,426,432,438,447,450,451,457,458,459,460,461,462,463,467,468,469,470,471,472],retrlin:225,retryabl:293,retryfactor:268,retrymax:268,retrystart:268,return_annot:254,return_except:[136,140,472],return_ok:244,return_stmt:[427,432],return_typ:95,return_valu:[96,145,190,386,387,466,468,470,472],return_when:[140,167],returncod:[134,135,138,350,469,472],returnfram:145,returntyp:382,retval:[190,457],reunion:201,reus:[79,82,86,95,107,129,159,170,177,185,193,212,215,228,237,252,293,321,339,340,343,349,363,365,366,386,399,423,428,435,461,466,472],reusabl:[62,72,317,404,468],reuse_address:[129,137],reuse_port:[129,137],reuseaddr:472,reuseport:472,rev:436,revamp:[96,463,466],reveal:[86,184,238,448,462,466,472],revealaccess:98,revers:[34,62,79,86,97,99,107,108,109,123,142,143,149,159,161,162,170,176,178,182,184,187,215,222,227,237,254,258,260,274,284,289,291,293,298,310,316,321,332,342,346,375,378,382,385,391,399,424,436,437,438,439,446,456,459,461,462,463,464,465,466,467,468,469,470,471,472,473],reverse_numer:108,reverse_ord:310,reverse_point:[258,469,472],revert:[98,104,171,225,243,244,326,363,451,463,467,470,472],review:[110,170,236,459,464,466,470,472],revis:[30,62,109,110,222,237,297,305,349,370,382,383,405,456,461,464,465,467,470,471,472,473],revisit:472,revoc:[343,468,472],revok:329,revolv:[193,237],rewind:[119,237,351,398],rework:[62,214,288,457,458,459,461,463,466,470,472,473],rewound:386,rewrap:[202,228],rewrit:[84,95,105,124,201,219,293,375,440,456,459,461,463,464,469,472],rewritenam:124,rewritten:[38,95,193,195,236,284,355,432,456,457,458,459,462,463,465,466,467,468,470,471,472],rewrot:[456,459],rexec:459,rexx:460,reykjavik:461,reynold:321,rezinski:90,rfactor:143,rfc2047:472,rfc2087:249,rfc2109:244,rfc2109_as_netscap:244,rfc2231:472,rfc2822:458,rfc2898:236,rfc2965:244,rfc4122:472,rfc822:[197,198,205,206,207,208,249,458,460],rfc822_escap:65,rfc:[62,65,103,104,106,110,144,147,159,176,195,196,197,198,200,201,202,203,204,206,208,209,210,225,232,236,238,242,243,244,245,246,249,253,255,258,261,265,268,271,272,288,307,319,336,337,339,343,348,360,367,390,391,392,404,405,416,447,456,458,459,460,461,462,463,466,467,469,471,472],rfc_4122:395,rfile:[246,340],rfind:[279,346,462,466,467,469,472],rgb:[97,163,178,250,292,370,380,468],rgb_to_hl:163,rgb_to_hsv:163,rgb_to_yiq:163,rgbimg:462,rgid:293,rglob:298,rgs:299,rhat:[342,461],rhel8:472,rhel:[471,472],rhoncu:151,rhythm:458,rica:410,riccardo:472,ricciardi:459,rich:[57,58,62,81,90,108,113,198,228,291,370,372,385,416,424,426,428,464,466,471,472,473],richard:[459,461,462,467,468,472],richcmpfunc:[57,81],richer:[93,470],richest:201,richi:459,richter:462,rid:[83,107,457,472],riddanc:107,ridg:370,ridicul:193,right:[7,14,15,38,43,58,62,63,65,66,68,69,74,77,78,79,84,91,93,95,97,99,104,106,107,109,111,113,123,124,125,143,145,149,153,156,157,159,161,170,177,178,184,187,189,190,193,197,214,217,222,227,228,236,248,249,254,266,274,288,289,291,292,295,298,301,310,321,331,339,343,346,347,356,365,370,371,372,373,380,385,386,387,392,397,400,401,408,421,422,423,424,426,431,432,436,438,442,445,448,455,456,457,458,459,460,461,462,463,464,468,470,471,472],right_list:217,right_onli:217,right_volum:295,rightarrow:248,righter:107,rightli:292,rightmost:[149,159,161,178,187,260,293,346,426,460],rightshift:374,rightshiftequ:374,rigo:[460,461,462,472],rigor:[99,227],rigour:472,riku:462,rindex:[346,463,466,467],rip:459,ripemd160:[236,466],risc:472,risco:[457,464],riscv:472,risk:[5,38,39,79,84,91,93,99,129,214,267,271,284,292,301,328,418,442,462,466,471,472],riski:[82,193,472],risu:151,riti:468,ritrovai:461,ritual:456,ritvanen:472,riverbank:87,riverbankcomput:453,rizvi:472,rjust:[346,442,460,467],rk1048:159,rkl:346,rl_attempted_completion_funct:322,rl_complet:322,rl_completer_word_break_charact:322,rl_completion_display_matches_hook:322,rl_completion_match:322,rl_completion_typ:322,rl_insert_text:322,rl_line_buff:322,rl_parse_and_bind:322,rl_pre_input_hook:322,rl_read_init_fil:322,rl_redisplai:322,rl_startup_hook:322,rlcomplet:[62,253,322,335,364,461,462,472],rle:147,rlecode_hqx:147,rledecode_hqx:147,rlim_cur:324,rlim_infin:324,rlimit_a:324,rlimit_cor:[324,363],rlimit_cpu:324,rlimit_data:324,rlimit_fs:324,rlimit_memlock:324,rlimit_msgqueu:[324,468],rlimit_nic:[324,468],rlimit_nofil:324,rlimit_nproc:324,rlimit_npt:[324,468],rlimit_ofil:324,rlimit_rss:324,rlimit_rtprio:[324,468],rlimit_rttim:[324,468],rlimit_sbs:[324,468],rlimit_sigpend:[324,468],rlimit_stack:324,rlimit_swap:[324,468],rlimit_vmem:324,rlist:329,rlock:[62,165,170,284,462,466,469,472],rm5epjai72qck3rgbpw3vpnfzy5ozothi:236,rmail:271,rmd:225,rmdir:[90,293,298,363,467],rmff:155,rmode:380,rms:143,rmtree:[62,90,220,293,363,399,467,471,472],rng:339,rnopen:331,roach:[470,472],road:245,roast:201,robert:[459,461,462,463,469,471,472],robin:[161,293,410,438,472],robla:472,robot:[62,253,255,380,389,456,472],robotfilepars:[393,470,472],robotpars:[62,253,255,389,456,464,472],robotstxt:393,robuff:95,robust:[82,84,153,185,254,310,345,369,399,447,453,463,466,468,469,472],robustli:463,roc:460,rocco:472,rock:[109,122],rocket_launch:244,rocki:[245,462],roddi:463,rodman:472,rodola:[463,466,469,471,472],rodolpho:466,rodrigu:472,roger:[465,472],roi:[463,472],role:[31,72,93,159,343,370,410,464,466,472],rolf:[470,472],roll:[75,161,184,268,342,361,363,385,436,461,462],rollback:[342,461,462],rollov:[268,361,468],roman8:460,roman:[109,222,384,459],romberg:458,rome:99,ron:466,ronach:[462,463,465,466,467,468],ronald:[321,461,462,463,466,468],ronni:470,roolz:[197,206],room:[38,50,386,430,464,472],root:[57,65,66,69,72,74,75,93,103,104,111,112,113,143,156,161,177,187,202,206,207,208,211,236,237,248,249,266,267,275,284,289,293,294,298,304,306,316,333,341,343,344,345,350,359,363,367,370,372,373,382,385,407,410,412,418,419,420,424,448,454,456,459,460,461,462,463,464,466,467,468,469,472],root_dir:[65,333],rootfd:293,rootlogg:104,rootobject:306,rose:[157,470,472],roseman:[370,472],rosemari:212,rosen:310,rosenberg:[469,472],rosett:472,roskind:[91,310],ross:[321,463,465,467],rossi:472,rossum:[84,86,91,93,370,420,422,456,457,458,459,461,462,463,464,468,469,470,471],rot13:[159,468,472],rot:[161,458],rot_13:159,rot_thre:190,rot_two:190,rotat:[62,103,161,187,268,380,460,462,463],rotatingfilehandl:[62,103,104,120,267,460,462,463],rotation_filenam:268,rotor:[459,460],rouault:[470,472],rough:[203,304,456],roughli:[86,91,107,109,228,244,252,260,282,284,292,293,346,366,370,381,423,424,456,462,463,471],rouin:422,roulett:320,roumen:472,round:[5,57,58,62,93,151,161,174,184,189,193,223,227,244,275,289,290,293,320,345,346,347,355,375,380,382,385,398,424,426,438,440,442,445,446,447,448,456,458,460,461,462,463,464,465,467,468,471,472],round_05up:187,round_ceil:[187,460],round_danc:380,round_down:[187,460],round_floor:[187,472],round_half_down:187,round_half_even:[187,460,472],round_half_up:187,round_up:187,round_up_to_power_2:472,roundoff:426,roundrobin:[161,260],roundtrip:342,roundup:[62,86],rout:[99,107,110,213,381,404,448,458,459,463,468],routeabl:468,router:[102,258],routin:[30,37,57,62,78,79,81,92,98,108,109,143,147,174,178,185,196,216,238,253,257,265,282,293,310,342,343,367,388,401,404,459,460,471,472],rovner:461,row:[62,79,91,152,176,248,300,373,375,380,431,438,445,461,465,466,469,470,472],row_factori:342,rowcount:342,rowid:342,royalti:422,rozerman:[],rpar:[374,375],rpartit:[252,346,461,463,466,472],rpath:111,rpc2:[417,461],rpc:[62,86,248,253,255,261,274,415,422,458,459,460,461,462,463,470,472],rpc_path:[417,461],rpm:[68,71,72,85,111,454,456,459],rpm_guid:454,rpop:307,rrate:393,rrggbb:370,rrrgggbbb:370,rrrrggggbbbb:370,rsa:[236,343,422,472],rsampl:143,rset:[307,336,337,472],rshift:[124,291],rsock:[129,135,137],rsplit:[346,460,463,466],rsqb:374,rss10:461,rss:[86,458],rst:[75,298,428,454,471,472],rstrip:[91,135,137,138,248,346,459,472],rstrip_w:65,rstripextens:472,rsync:391,rsyslog:268,rtld_:472,rtld_deepbind:[293,467],rtld_global:[177,293,355,467],rtld_lazi:[293,355,467],rtld_local:[177,293,467],rtld_nodelet:[293,467],rtld_noload:[293,467],rtld_now:[177,293,467],rtld_xxx:355,rtsp:391,rtspu:391,ru_idrss:324,ru_inblock:324,ru_isrss:324,ru_ixrss:324,ru_majflt:324,ru_maxrss:324,ru_minflt:324,ru_msgrcv:324,ru_msgsnd:324,ru_nivcsw:324,ru_nsign:324,ru_nswap:324,ru_nvcsw:324,ru_oublock:324,ru_stim:324,ru_utim:324,rubi:[87,99,448],rudiment:109,rudimentari:469,ruid:293,rule:[17,22,26,30,31,57,62,65,69,84,86,93,95,98,99,104,105,106,107,109,122,124,131,153,156,177,179,182,184,187,189,195,197,203,204,206,208,209,210,212,222,224,227,229,233,237,239,241,244,245,258,265,275,292,321,343,346,347,349,350,361,366,367,372,386,387,391,393,397,408,412,423,424,425,426,427,428,430,431,432,436,444,456,457,459,461,462,463,464,466,467,472],ruler:157,rume:[470,472],run:[1,22,26,30,31,41,54,57,58,62,65,66,67,68,69,70,72,74,77,78,79,80,82,83,84,85,86,87,89,91,93,94,95,97,98,99,101,103,104,105,106,107,109,111,112,113,114,115,117,122,126,127,131,132,133,135,136,137,138,139,142,145,153,154,158,161,167,168,171,174,177,178,182,186,187,188,192,193,201,204,209,214,215,228,229,230,232,236,237,243,244,245,246,252,254,260,265,267,268,271,280,284,286,288,292,293,294,298,299,305,310,313,315,320,322,324,325,326,327,332,333,334,335,336,339,340,342,343,346,347,350,355,356,365,366,367,368,369,370,373,376,378,380,386,387,390,392,393,395,396,397,399,400,402,404,417,418,421,423,424,425,426,428,431,434,436,437,439,440,444,446,447,448,449,451,452,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],run_coroutine_threadsaf:[127,128,140,469,470,472],run_docstring_exampl:193,run_doctest:[363,378],run_forev:[129,132,472],run_glob:378,run_in_executor:[128,129,132,140,472],run_in_subinterp:363,run_modul:[326,451,472],run_nam:326,run_onc:404,run_path:[326,451,463],run_python_until_end:363,run_script:280,run_setup:[65,472],run_test:472,run_unittest:[363,472],run_until_complet:[129,132,469,470,472],run_user_cod:377,run_with_local:363,run_with_tz:363,runawai:456,runcal:[145,299,310,472],runcod:158,runctx:[145,310,376],runev:[145,299],runfunc:376,runmainfromimport:472,runnabl:[129,396,472],runner:[193,385,397,460,463,472],runni:437,runpi:[62,253,281,378,428,451,461,462,463,465,468,472],runsourc:158,runtest:[193,385],runtim:[30,31,38,47,54,60,62,65,79,81,82,83,84,91,93,95,103,109,111,114,164,168,177,214,227,252,253,267,268,292,294,297,313,342,346,350,370,378,382,386,397,401,408,418,421,423,424,425,428,432,436,451,455,457,459,463,464,467,468,469,470,472],runtime_library_dir:[65,74],runtime_library_dir_opt:65,runtimeerror:[22,65,99,107,117,123,129,130,139,140,167,170,171,214,219,257,284,298,321,337,346,355,366,382,403,419,424,426,432,439,446,459,460,461,463,467,469,470,471,472],runtimewarn:[22,41,128,214,339,355,385,397,446,466],rupprecht:472,rusage_:324,rusage_both:324,rusage_children:324,rusage_self:324,rusage_thread:324,ruscii:159,rush:[422,456],russ:456,russel:460,russian:[109,159],ruthlessli:65,rutrum:151,rvalu:346,rwbuffer:95,rwf_dsync:293,rwf_hipri:293,rwf_nowait:293,rwf_sync:293,rwx:[212,333],rwxr:[94,333],rwxrwxrwx:[344,467],rx_addr:339,ryan:[463,467,468,470,471,472],ryosuk:472,s150:104,s390x:472,s92p:458,s_enfmt:[293,344],s_i:[143,344],s_iexec:[293,344],s_ifblk:[293,344],s_ifchr:[293,344],s_ifdir:344,s_ifdoor:[344,468],s_ififo:[293,344],s_iflnk:344,s_ifmt:344,s_ifport:[344,468],s_ifreg:[293,344],s_ifsock:344,s_ifwht:[344,468],s_imod:344,s_in:235,s_iread:[293,344],s_irgrp:[293,344],s_iroth:[293,344],s_irusr:[293,344],s_irwxg:[293,344],s_irwxo:[293,344],s_irwxu:[293,344],s_isblk:344,s_ischr:344,s_isdir:[293,344],s_isdoor:344,s_isfifo:344,s_isgid:[293,344],s_islnk:344,s_isport:344,s_isreg:344,s_issock:344,s_isuid:[293,344],s_isvtx:[293,344],s_iswht:344,s_iwgrp:[293,344],s_iwoth:[293,344],s_iwrit:[293,333,344],s_iwusr:[293,344],s_ixgrp:[293,344],s_ixoth:[293,344],s_ixusr:[293,344],s_ji:159,s_jisx0213:159,s_out:235,s_server:363,sabella:[470,471,472],sad:[212,464],sadli:[84,94],sadruddin:460,safari:400,safe:[21,22,30,31,38,41,51,57,58,62,65,66,78,79,81,82,91,93,104,124,128,129,131,132,134,135,136,138,139,140,144,151,152,153,161,170,176,177,178,182,193,201,215,227,236,238,239,248,252,257,265,266,267,269,271,284,293,297,301,314,318,326,327,328,329,331,332,335,339,343,347,350,363,366,386,387,391,395,397,399,406,412,436,455,456,457,459,462,463,466,467,471,472],safe_builtin:301,safe_substitut:[347,448,460],safechildwatch:134,safeconfigpars:466,safeguard:458,safer:[193,302,438,459,460,472],saferepr:309,safest:[97,271],safethread:90,safeti:[8,11,62,79,93,120,201,251,284,292,326,395,463,465,466,472],safetransport:416,safeuuid:[395,472],saha:[470,472],sai:[68,69,72,74,78,79,81,83,84,91,92,94,102,104,106,107,109,111,118,135,140,149,176,184,193,203,228,232,237,244,248,265,266,267,268,271,284,291,350,370,392,410,418,424,428,430,437,440,442,450,457,458,459,461,462,463,466,468,472],said:[31,84,91,93,97,98,168,284,423,424,431,444,445,457,458,470],saihadhav:472,saimadhav:472,sajip:[103,104,459,460,462,463,465,466,467,468,469,470,471],sake:[65,94,95,97,104,206,237,293,332,427,428,459],sakki:[260,463],salad:346,salari:[227,346,436],sale:[86,465,466],sales_item:409,salesl:466,salgado:[469,472],salient:466,salli:467,salmela:99,salt1:236,salt2:236,salt:[174,236,328,424,451,466,467,472],salt_siz:236,salut:201,sam:[87,422,456,472],same:[3,5,7,8,9,14,19,21,22,24,25,30,31,34,35,37,38,41,42,45,47,49,51,53,55,56,57,58,60,62,64,65,66,68,69,70,72,74,78,79,81,82,84,85,86,90,93,94,95,97,98,99,101,103,104,105,106,107,108,109,110,111,113,114,115,117,118,122,123,124,125,128,129,134,135,138,140,141,142,143,144,145,147,150,152,153,156,158,159,161,164,167,168,169,170,171,172,174,176,177,178,179,182,184,185,187,188,189,190,193,195,196,197,202,203,204,206,208,209,210,212,214,216,217,219,221,223,225,227,228,230,232,233,235,236,237,238,243,244,245,246,248,249,251,252,254,257,258,259,260,261,265,266,267,268,269,271,275,276,279,282,283,284,288,289,292,293,294,295,297,298,299,301,302,305,307,309,310,311,314,315,316,318,320,321,322,323,324,327,329,331,332,333,334,335,336,337,339,340,342,343,344,346,347,349,350,351,355,356,359,360,361,362,363,365,366,367,368,371,372,373,375,377,380,381,382,384,385,386,390,391,392,395,396,397,398,399,400,402,404,407,410,412,416,417,418,419,421,422,423,424,425,426,428,430,431,432,433,434,436,437,438,439,440,441,442,445,446,447,451,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],same_fil:217,same_quantum:187,samefil:[294,298,468,469,472],samefileerror:[333,468,472],sameopenfil:294,sameorigin:343,samestat:[294,298,468],samp:459,sampl:[65,75,79,81,85,90,95,98,99,104,106,111,113,119,143,157,176,177,193,212,225,248,260,280,295,301,309,310,320,321,338,345,351,359,368,373,392,398,410,447,455,457,458,459,462,463,466,468,470,471,472],sample_config:[168,463],sample_nam:386,sampleproject:309,sampler:295,samples:119,sampletest:385,sampletestcas:385,sampling_r:338,sampmodul:459,sampwidth:[119,338,351,398],samson:472,samstag:184,samuel:[236,339,422,459,461,470],samwys:469,san:[343,393],sanad:472,sand:321,sandbox:326,sandler:466,sandov:[470,471,472],sandro:467,sane:[57,178,184,321,406],saner:31,sanit:[201,472],saniti:[31,58,468,472],sanjai:472,santa:422,santoso:472,sanyam:[471,472],sape:438,sapien:151,sapin:472,saratoga:422,sarcast:458,sarnowski:472,sat:[104,152,184,343],satisfact:[86,343],satisfactorili:79,satisfi:[79,91,110,182,235,257,275,349,366,424,428,438,466],satur:[163,466],saturdai:[152,184],saturn:212,sau:227,sausag:[161,227,346],sauvag:455,savag:453,save:[1,22,30,31,38,57,58,62,78,79,81,84,85,91,93,95,99,103,104,106,111,122,142,149,151,153,154,157,168,170,178,184,201,210,228,229,244,248,260,265,268,269,271,292,293,301,310,315,320,321,322,335,342,355,363,367,370,380,397,402,416,421,423,424,435,436,437,441,443,446,458,460,461,462,463,464,465,466,468,471,472],save_histori:322,savecount:142,savedcwd:363,savekei:402,savepoint:342,savesign:363,savetti:178,saw:[74,79,438],saw_foo:292,sawyer:472,sax2:[62,253,273,406,408],sax2dom:409,sax2lib:412,sax:[62,253,273,406,407,408,409,447,456,457,471,472],saxexcept:[62,273],saxnotrecognizedexcept:[411,413],saxnotsupportedexcept:[411,413],saxparseexcept:[411,412],saxutil:[62,253,273,411],say_aft:140,say_hello:[96,375],say_hi:370,sayan:472,sbardella:472,sbin:[90,177,321],sc22:355,sc_iov_max:[293,339],scalabl:[329,456],scalar:[7,143,197,200,380,382,472],scale:[320,329,373,382,456,459,462,470,471,472],scaleb:187,scalet:472,scan:[69,74,91,92,95,99,101,103,106,107,159,161,178,230,232,246,293,305,321,329,363,370,392,425,447,451,458,459,461,463,466,469,472],scandir:[62,233,293,470,471,472],scandir_path:293,scanf:[62,364],scanner:[92,321,358,375,468,472],scardin:467,scari:472,scatter:[339,458,459,463],scelerisqu:151,scenario:[95,103,104,266,267,385,386,387,392,428,468,470],scene:[177,436,442],scgi:404,schaaf:[466,467],sched:[62,165,253,462,472],sched_:472,sched_batch:293,sched_fifo:293,sched_get_priority_max:[293,467],sched_get_priority_min:[293,467],sched_getaffin:[284,293,467],sched_getparam:[293,467],sched_getschedul:[293,467],sched_idl:293,sched_oth:293,sched_param:293,sched_prior:293,sched_reset_on_fork:293,sched_rr:293,sched_rr_get_interv:[293,467],sched_setaffin:[293,467,472],sched_setparam:[293,467],sched_setschedul:[293,467],sched_sporad:293,sched_yield:[293,467],schedul:[30,62,86,90,120,127,128,131,132,137,141,161,165,167,237,253,254,324,334,355,367,373,426,458,461,462,464,466,467,468,469,470,471,472],schema:[62,120,282,463,472],scheme:[7,28,57,62,81,99,104,107,110,125,137,143,159,177,184,211,248,251,271,296,319,320,335,343,346,355,356,359,372,391,392,404,424,451,456,457,459,462,463,466,467,468,469,472],schemenau:[456,457,458,459,461,463,466,469],schiller:343,schlawack:[467,468],schmidt:456,schmitt:462,schneider:456,schnell:462,schnider:472,schoentgen:472,school:[89,187,345,349,459],schoolbook:187,schouten:472,schroeder:461,schuppeni:462,schwab:472,schwartz:[91,108,462],schwartzian:108,schwertberg:457,sci:422,scienc:[99,106,184,345,366,469],scientif:[62,187,347,450,455,462],scientist:366,scintilla:91,scipi:[72,440,447,450,455],scissor:122,scm:305,scm_:339,scm_right:339,scol:375,scoop:[437,464],scope:[11,31,62,82,84,91,93,95,102,103,104,114,115,145,161,190,212,227,254,299,309,316,322,332,339,343,354,355,386,387,408,410,412,423,424,425,426,428,432,437,441,456,462,464,466,467,470,471,472,473],scope_test:436,scopeid:[339,472],score:[149,189,448],scott:[109,459,461],scram:467,scraper:456,scratch:[62,94,195,199,202,208,285,343,407,467,468],screen:[62,84,91,97,99,101,109,157,169,178,180,224,248,322,350,370,372,373,375,439,448,456,458,459,462,466,469,472],screennam:[370,372],screenshot:463,screensiz:380,screw:107,script:[30,31,60,62,67,68,69,70,71,72,75,77,78,79,81,84,85,86,87,89,93,94,95,101,103,104,110,111,113,122,164,170,185,189,192,193,211,214,224,230,232,241,245,246,252,253,255,281,292,299,310,311,313,315,317,326,331,335,342,355,358,363,370,373,375,385,392,396,400,404,417,418,425,428,430,431,432,433,435,436,439,441,444,447,448,449,450,451,452,454,456,457,458,459,460,462,463,466,467,468,469,470,471,472,473],script_arg:65,script_basenam:363,script_dir:363,script_from_exampl:193,script_help:[62,188,253,472],script_nam:[65,363,404],scriptfil:90,scroll:[62,97,157,178,248,253,369,370,373,472],scrollabl:[62,248,369,372],scrollbar:[248,370,371,373,380,472],scrollcommand:[370,373],scrolledcanva:380,scrolledlist:472,scrolledtext:[62,253,369,370],scroller:472,scrollok:178,scrypt:[236,470,472],sdeedfish:106,sdev:90,sdist:[66,71,72,75,77,456,457,461,463,470,471,472],sdk:[65,472],sdt:101,sdux:66,se_restore_privileg:402,sea_green:212,seabra:472,seal:[62,188,466,471,472],seal_ballot:466,seamlessli:98,sean:[457,459,460,461,463,472],search:[1,13,22,28,30,31,54,58,62,64,65,68,70,74,81,84,86,90,91,92,93,98,103,109,143,153,159,161,164,177,183,193,197,212,217,227,232,248,249,251,252,264,265,266,267,269,279,280,288,293,299,301,304,310,313,314,315,332,333,335,342,346,355,361,364,372,380,385,392,393,400,407,409,410,412,417,419,420,423,424,425,429,432,435,436,437,438,441,444,445,447,448,449,451,453,454,455,456,457,458,459,460,461,462,463,465,466,467,469,470,471,472],search_criterion:249,search_funct:[13,159],searchabl:[361,428],searchdialogbas:472,season:227,sebackupprivileg:402,sebastian:472,sec:[106,284,367,368,469],seccomp:472,sechrest:339,secker:463,second:[5,19,21,22,30,31,33,53,58,61,74,75,79,81,82,83,84,90,91,92,93,94,95,97,99,101,103,104,105,106,107,108,109,110,111,113,117,119,127,128,129,131,136,137,139,140,141,143,153,159,167,168,170,172,177,178,184,187,189,190,193,196,201,204,209,210,212,214,215,216,219,223,225,227,230,232,236,237,243,244,248,249,251,252,254,257,266,267,268,271,272,275,276,283,284,291,292,293,294,295,299,303,307,309,310,318,320,321,324,329,330,332,333,334,336,337,339,340,342,343,345,346,347,350,355,356,359,360,361,362,363,366,367,368,370,373,375,380,382,385,386,391,392,393,395,404,410,416,419,424,426,428,431,432,437,438,440,442,444,445,446,447,448,456,457,458,459,460,461,462,463,466,467,469,470,471,472],second_16:177,second_patch:386,secondari:[108,161,248,310,355,434,444,445,446,463,464,472],secondaryexcept:464,secondli:104,secp:472,secreatesymboliclinkprivileg:293,secreci:[343,472],secret:[30,62,135,175,236,238,253,284,292,293,307,320,343,422,436,451,456,472],secret_kei:236,sectcr:168,section1:168,section2:168,section3:168,section:[7,15,16,31,38,47,50,53,57,58,62,65,66,68,69,70,71,72,74,75,77,78,79,80,81,82,83,86,91,93,95,97,99,101,102,103,104,106,109,110,111,122,129,132,134,135,136,137,138,140,144,146,153,157,159,161,168,170,176,177,182,185,187,193,195,196,199,203,204,212,213,227,232,236,242,243,244,248,249,251,256,257,260,261,266,267,271,292,293,301,305,307,309,310,316,321,328,329,339,342,343,346,347,349,350,355,359,366,368,369,380,385,386,387,391,392,404,406,407,408,410,412,413,416,419,422,423,424,425,426,428,431,432,433,436,437,438,440,442,446,447,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],section_nam:168,section_proxi:168,sectionnam:472,sector:142,secur:[62,71,91,104,111,129,144,165,175,225,238,243,244,245,246,249,253,255,267,268,269,274,284,286,288,293,301,307,316,320,332,335,337,339,361,392,402,404,406,408,409,410,411,416,417,421,456,457,458,459,461,462,466,467,469,470,471],security_attribut:402,see:[0,5,7,10,13,16,17,22,28,30,31,36,41,43,52,53,54,57,58,60,63,64,65,66,72,74,75,77,78,79,80,81,82,83,84,85,86,87,90,91,92,93,94,95,96,97,98,99,101,103,104,105,106,109,110,111,118,121,122,123,127,128,129,131,132,134,135,136,137,138,140,143,145,146,148,150,152,153,157,159,161,162,164,168,169,170,171,172,173,174,176,177,178,182,184,187,188,189,190,193,196,197,198,201,202,203,204,206,207,208,209,212,214,215,216,217,219,221,223,225,227,228,229,232,234,235,236,237,240,243,244,246,248,249,251,252,254,256,257,258,260,261,265,266,267,268,269,272,274,275,279,280,282,284,288,291,292,293,294,295,296,297,299,301,302,303,304,305,306,307,310,312,313,315,316,318,320,321,322,324,325,326,327,328,329,330,331,332,333,334,335,337,339,340,341,342,343,344,345,346,347,349,350,355,356,357,359,360,361,362,363,364,365,366,367,368,369,370,372,373,376,377,378,380,381,382,385,386,387,391,392,393,396,397,399,402,404,406,407,408,409,410,411,412,413,416,417,418,419,421,422,423,424,425,426,428,429,430,431,432,434,436,437,438,439,440,441,442,444,445,446,451,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],see_oth:242,seed:[30,84,93,293,320,343,355,422,451,463,466,472],seed_bit:355,seeder:320,seek:[85,90,91,109,119,155,176,192,213,216,219,227,237,257,279,301,359,361,363,419,421,442,456,462,465,472],seek_:257,seek_cur:[216,257,279,293,461,465],seek_data:[257,293,467],seek_end:[216,257,279,293,461,465],seek_hol:[257,293,467],seek_set:[216,257,279,293,461,465],seekabl:[119,151,257,351,398,419,462,472],seem:[74,79,82,83,84,85,86,92,95,99,103,106,122,141,217,271,280,293,310,428,438,456,457,458,459,461],seemingli:[79,193,426,456],seen:[79,81,90,93,94,95,99,104,157,232,236,254,260,268,271,292,307,320,332,363,397,399,410,412,421,436,437,439,447,451,459,462,465,468,471,472],seen_add:260,seen_greet:336,segev:[471,472],segfault:[95,460,461,470,471,472],segment:[17,38,44,156,177,193,215,216,221,293,298,343,367,391,396,404,461,463,466,467,472],segreg:467,segv:472,sehensw:466,seifert:472,seilnacht:463,sekera:472,sektion:329,sel:330,seldom:350,select:[1,7,58,60,62,64,65,66,74,90,92,93,103,106,107,109,112,122,125,141,143,156,161,170,177,178,211,212,214,225,227,232,243,247,248,249,252,253,257,259,260,261,265,267,269,282,284,288,301,307,310,311,313,315,320,330,334,337,339,340,342,346,347,349,361,365,366,367,368,372,373,380,387,392,400,404,410,414,421,423,424,425,426,428,437,439,442,447,448,449,453,455,458,459,460,461,462,463,464,465,469,470,471,472],selected_alpn_protocol:[343,469],selected_npn_protocol:343,selection_add:[373,472],selection_el:472,selection_get:373,selection_remov:[373,472],selection_set:[373,472],selection_toggl:[373,472],selectmod:373,selector:[62,99,128,129,133,243,253,259,260,329,340,343,362,369,392,463,465,471,472],selectoreventloop:[129,133,134,472],selectorkei:330,selectorloop:472,selectselector:[129,133,330],self:[5,21,26,40,53,57,62,65,66,70,78,79,81,82,85,90,93,96,98,99,101,104,107,108,118,122,124,125,134,135,141,145,150,157,161,162,170,173,177,182,184,187,190,204,206,212,223,227,228,232,241,244,252,254,258,260,261,274,284,289,292,298,299,301,322,323,340,342,346,347,363,370,372,378,380,381,382,385,386,387,392,396,399,407,410,414,416,417,418,423,424,428,436,437,439,441,447,448,449,451,456,457,458,459,461,462,463,465,466,467,468,469,470,471,472],self_convert:95,self_test:90,selfsigned_pythontestdotnet:472,selftest:451,selik:472,selinux:472,selivanov:[466,467,468,469,470,471,472],sell:[86,342,422,461],selm:90,selma:99,selop:373,selva:461,sem:139,sem_getvalu:[284,472],sem_open:472,sem_timedwait:[284,472],semant:[5,7,10,31,57,58,65,86,93,95,103,104,105,135,162,185,187,193,197,203,206,208,209,212,227,249,251,252,253,256,266,267,268,271,284,292,293,295,298,301,313,318,321,331,332,333,339,344,366,367,382,391,402,421,423,424,425,426,428,429,432,436,437,450,451,456,458,459,461,462,464,466,467,468,469,470,471,472],semaphor:[62,90,101,117,127,165,213,284,355,448,462,466,467,472],semaphore_not:466,semi:[95,112,284,292,320,374,472],semicircl:380,semicolon:[5,30,82,106,240,342,423,432,451,455],seminumer:187,semper:151,send:[7,62,85,86,93,97,99,103,105,106,107,110,125,127,129,132,135,137,138,141,143,153,154,159,162,170,178,195,201,202,213,222,225,232,243,246,248,249,266,267,268,284,288,293,301,307,319,330,334,336,337,339,340,342,343,350,357,362,382,383,392,404,424,426,447,448,450,456,459,460,461,463,466,467,469,470,471,472],send_byt:284,send_error:[246,468,472],send_ev:370,send_fd:339,send_flowing_data:222,send_formatted_data:222,send_head:246,send_hor_rul:222,send_json:104,send_label_data:222,send_line_break:222,send_literal_data:222,send_messag:[201,209,337,466,469,472],send_paragraph:222,send_respons:246,send_response_onli:246,send_sign:[132,135,138,350,462,472],sendal:[129,339,340,343,469,472],sendcmd:225,sender:[90,201,204,209,271,337],sendfil:[129,130,132,135,293,339,343,404,467,469,471,472],sendfilenotavailableerror:[129,130],sendmail:[90,106,202,209,321,337,447,466,469],sendmsg:[339,467,469],sendmsg_afalg:[339,470],sendto:[132,135,339,340,469,472],sendtyp:382,sens:[57,65,81,84,91,94,95,102,103,111,113,122,123,125,149,184,187,189,206,207,212,228,258,271,292,310,334,340,342,343,346,347,355,368,370,380,400,422,424,428,436,440,464,466,468,469,471],sensibl:[74,107,110,168,184,236,254,292,366,386,387,426,460,463,470,471,472],sensit:[30,58,161,168,221,249,268,276,296,298,385,397,457,459,460,461,462,468,472],sent:[1,22,62,95,97,99,103,107,109,110,125,129,135,138,141,144,170,178,201,225,236,241,243,245,246,248,249,258,266,267,268,284,288,293,299,307,324,334,336,337,339,340,342,343,350,367,368,382,392,404,416,417,442,448,455,456,459,460,461,462,463,466,467,468,469,470,472],sentenc:[99,106,321,365,458,459,462,472],senthil:[463,466,468,469],sentinel:[28,33,62,79,81,82,95,104,182,188,227,260,268,284,387,458,467,471,472],seo:[460,467],sep:[58,91,99,184,187,227,233,245,248,293,294,343,346,347,378,437,444,451,458,461,462,463,464],separ:[22,30,50,54,57,58,62,65,66,68,70,74,75,80,83,85,90,91,95,96,97,103,104,105,106,108,109,111,113,118,122,130,134,137,152,153,156,157,159,161,167,168,170,176,177,179,184,187,189,193,197,202,203,206,209,212,221,222,227,228,232,237,246,248,249,252,256,257,258,261,265,266,267,268,269,271,276,284,288,291,292,293,294,299,304,309,315,316,321,326,332,335,337,339,340,342,343,346,347,350,362,363,365,366,368,369,370,376,385,387,391,392,395,396,397,399,400,404,419,422,423,424,426,428,430,431,432,437,438,442,445,446,447,448,451,455,456,458,460,461,462,464,466,467,468,469,470,471,472,473],septemb:[431,456,467,469],seq1:[99,291,456],seq2:[21,99,291,456],seq:[33,58,91,161,221,227,260,291,320,346,456,460,466],seq_of_paramet:342,seq_typ:385,seqdict:459,seqnum:448,sequenc:[2,5,7,13,21,29,30,31,33,35,38,45,46,51,54,58,60,62,65,67,74,81,84,85,90,93,95,97,99,104,106,109,113,123,124,129,137,140,144,146,153,158,159,161,162,165,176,177,178,189,190,193,197,203,206,207,210,212,213,214,219,222,227,228,232,237,239,244,252,253,254,257,258,260,261,262,265,267,269,271,276,282,284,290,291,292,293,294,297,298,301,302,303,304,309,314,316,321,323,327,328,329,333,339,342,343,345,347,355,359,360,364,367,368,370,373,375,377,378,380,382,384,385,386,387,391,392,395,397,399,402,407,410,411,421,423,424,426,427,428,430,431,432,436,437,441,445,448,456,457,458,459,460,462,463,464,465,466,467,468,469,470,471,472],sequence1:[99,456],sequence2:[99,456],sequence2st:297,sequence3:99,sequenceinclud:[113,463,464],sequencemanag:472,sequencematch:[62,364,457,461,462,468],sequencen:[99,456],sequenti:[90,107,128,164,219,236,257,284,310,346,363,386,448,472],serbian:159,sergei:472,serhii:[109,467,468,469,470,471,472],seri:[7,30,86,93,99,106,108,113,122,157,161,176,177,187,190,227,292,316,339,346,356,366,372,382,386,387,391,404,426,437,445,446,458,460,461,462,463,468,471,473],serial:[30,37,62,104,168,195,197,198,202,204,206,207,208,209,253,261,266,268,300,306,331,334,337,342,355,410,442,456,462,463,465,466,467,468,472],serialis:[104,159,326],serializ:[245,261],serialnum:349,serialnumb:343,seriou:[84,93,103,129,193,214,284,386],serious:236,serna:467,serra:472,serv:[5,79,82,84,86,93,103,104,114,129,135,137,187,193,203,204,227,228,237,241,246,267,284,297,301,315,342,343,380,382,404,410,417,428,431,436,437,439,460,464,466,467,469,471],serve_forev:[129,135,137,171,246,284,340,404,416,417,461,462,467,471,472],serve_until_quit:472,serve_until_stop:104,server:[62,86,89,90,91,97,99,103,107,110,111,125,126,127,132,153,168,171,177,191,195,199,201,209,225,228,236,242,243,244,245,248,249,253,255,258,266,267,268,284,288,293,307,315,320,329,330,337,339,342,355,357,360,363,366,370,378,382,385,390,392,406,422,447,448,457,458,459,460,461,462,463,467,468,469,470,472,473],server_activ:[340,417,462],server_address:[246,340,404],server_auth:[343,468],server_bind:[340,417,462],server_class:[246,404],server_clos:[340,471,472],server_document:417,server_hostnam:[129,137,343,466,471,472],server_log:[99,461],server_nam:[246,404,417],server_name_callback:343,server_port:[246,404],server_sid:[129,343],server_softwar:404,server_thread:340,server_titl:417,server_vers:246,serveraliveinterv:168,serverhandl:472,servernam:284,serverproxi:[62,255,417,469,472],serversocket:107,serverthread:472,servic:[62,104,107,110,141,165,247,253,254,266,268,283,284,293,305,320,323,329,337,339,340,343,346,367,406,416,424,433,451,455,456,460,463,467,472],service_act:[340,467],service_end:320,service_pack:[355,463],service_pack_major:[355,463],service_pack_minor:[355,463],service_start:320,service_tim:320,service_unavail:242,servicenam:339,servo:106,serwi:[465,472],session:[62,91,92,103,104,125,157,193,214,225,243,244,284,307,311,322,330,337,342,355,392,432,434,443,446,451,455,460,467,468,470,472],session_reus:343,session_stat:343,set:[2,3,4,5,7,9,10,11,13,14,15,16,17,18,21,22,23,25,26,27,28,30,31,32,34,35,37,38,41,44,45,47,51,52,53,54,55,56,57,58,60,62,65,66,68,70,74,75,78,79,81,82,83,84,85,87,90,91,92,93,94,95,97,98,99,102,103,104,105,106,107,109,110,111,113,115,117,119,122,124,125,126,128,130,131,132,135,137,138,139,140,141,145,149,151,152,153,154,155,156,157,158,159,161,162,164,167,168,170,171,172,174,176,177,178,179,180,182,183,184,186,187,188,189,190,193,195,197,198,199,202,203,204,206,207,208,209,210,211,212,214,215,216,222,224,225,227,228,229,230,231,232,236,237,241,242,243,244,245,246,249,251,253,254,257,258,259,260,261,265,266,267,268,269,271,272,274,275,276,279,280,281,282,283,284,285,286,288,291,292,293,294,295,296,298,299,301,303,305,307,309,310,313,315,316,318,320,321,322,324,325,326,329,331,332,333,335,336,337,339,340,342,344,345,347,348,350,351,355,356,357,358,359,360,361,362,363,365,366,367,369,371,372,373,376,378,381,382,384,385,386,391,392,393,394,395,396,397,398,399,400,402,404,405,407,408,409,410,411,412,413,414,416,417,418,419,420,421,423,424,425,428,431,432,434,436,441,442,444,446,447,448,450,451,452,453,456,457,458,461,462,463,464,465,466,467,468,469,470,471,472,473],set_add:190,set_aft:131,set_al:[31,228],set_allowed_domain:244,set_alpn_protocol:[343,469],set_app:404,set_asyncgen_hook:[355,426],set_attr:359,set_author:[342,472],set_auto_histori:[322,470,472],set_block:[293,469,472],set_blocked_domain:244,set_boundari:[197,200,206],set_break:145,set_callback:79,set_charset:197,set_child_watch:[133,134],set_children:373,set_ciph:343,set_complet:[322,325],set_completer_delim:[322,472],set_completion_display_matches_hook:322,set_conflict_handl:292,set_cont:[197,198,199,201,206,208,209],set_continu:145,set_cooki:244,set_cookie_if_ok:244,set_coroutine_origin_tracking_depth:[254,355,471,472],set_coroutine_wrapp:[355,469,471,472],set_curr:282,set_dat:271,set_data:252,set_dead:228,set_debug:[128,129,132,229,469],set_debuglevel:[225,243,288,307,337,360,469],set_default:[122,292,472],set_default_executor:[129,132],set_default_typ:[197,206],set_default_verify_path:[343,468],set_displai:426,set_ecdh_curv:[343,467],set_errno:[177,462],set_event_loop:[129,132,133,134],set_event_loop_polici:[132,133,134,135,138],set_except:[128,131,140,167,470,472],set_exception_handl:[129,132],set_execut:[65,284,418],set_flag:271,set_forkserver_preload:472,set_from:271,set_handle_inherit:[293,350,468],set_history_length:322,set_include_dir:65,set_info:271,set_inherit:[293,329,339,468,472],set_label:271,set_last_error:[177,462],set_librari:65,set_library_dir:65,set_lineno:459,set_link_object:65,set_liter:113,set_load:[252,468],set_loc:331,set_match_test:363,set_memlimit:363,set_merg:472,set_next:145,set_nomemori:472,set_nonstandard_attr:244,set_npn_protocol:[343,467],set_ok:244,set_option_negotiation_callback:360,set_output_charset:232,set_packag:[252,468],set_param:[197,206,468],set_pasv:[225,457],set_payload:[197,207,472],set_polici:244,set_posit:405,set_pre_input_hook:322,set_progress_handl:[342,472],set_protocol:[132,135,472],set_proxi:[392,416,468],set_python_build:65,set_quit:145,set_recsrc:295,set_result:[131,135,140,167,472],set_return:145,set_reuse_addr:141,set_running_or_notify_cancel:167,set_runtime_library_dir:65,set_sampl:472,set_seq1:189,set_seq2:189,set_seq:189,set_sequ:271,set_server_document:417,set_server_nam:417,set_server_titl:417,set_servername_callback:[343,468],set_siz:458,set_spac:222,set_start_method:[284,468],set_startup_hook:322,set_stat:228,set_step:145,set_subdir:271,set_symmetric_differ:472,set_sys_last_var:22,set_task_factori:[129,132,469,472],set_termin:[125,472],set_threshold:229,set_trac:[145,193,227,299,355,451,471,472],set_trace_callback:[342,467],set_tunnel:[243,416,466,472],set_typ:197,set_unittest_reportflag:193,set_unixfrom:[197,206],set_until:145,set_url:393,set_usag:292,set_userptr:180,set_valu:104,set_vis:271,set_wakeup_fd:[22,334,462,469,471,472],set_write_buffer_limit:[132,135],setacl:[249,458],setannot:249,setattr:[91,122,227,252,292,399,436,446,456,472],setattrfunc:[57,81],setattribut:407,setattributen:407,setattributenod:407,setattributenoden:407,setattrofunc:[57,81],setbas:316,setbg:380,setblock:[107,293,330,339,343,472],setbytestream:413,setcbreak:379,setcharacterstream:413,setcheckinterv:[355,446,459],setcomp:124,setcomptyp:[119,351,398],setcontenthandl:[413,456],setcontext:187,setdaemon:[366,462],setdefault:[21,84,161,162,185,245,346,404,424,456,459,466,467,472],setdefaultencod:456,setdefaulttimeout:[110,339],setdlopenflag:[293,355,446,458,467],setdocumentloc:412,setdtdhandl:413,setegid:293,setencod:413,setentityresolv:413,setenv:65,seterrorhandl:413,seterrormod:363,seteuid:293,setfeatur:[409,411,413],setfilesystemencod:466,setfirstweekdai:152,setfmt:295,setformatt:[103,104,266,268],setframer:[119,351,398],setgid:293,setgroup:293,seth:[380,472],sethead:380,sethostnam:[339,467],seti:380,setinteg:282,setitem:[190,291,387],setitim:[334,462,472],setlasterror:177,setlevel:[103,104,128,266,284,459],setlocal:[58,178,257,265,413,448,469],setloggerclass:[104,266],setlogmask:357,setlogrecordfactori:[104,266],setmark:119,setmaxconn:392,setmod:283,setnam:366,setnchannel:[119,351,398],setnfram:[119,351,398],setparam:[119,351,398],setparamentitypars:316,setparamet:295,setpassword:419,setpgid:293,setpgrp:293,setpo:[119,351,380,398],setposit:380,setprior:[293,467],setprofil:[284,355,366,446,458,472],setproperti:[282,413],setpublicid:413,setquota:249,setraw:379,setrecsrc:295,setrecursionlimit:[248,301,355,446,456,472],setregid:293,setresgid:[293,463],setresuid:[293,463],setreuid:293,setrlimit:[324,363,472],setsampwidth:[119,351,398,468],setscrreg:178,setsid:[293,350,472],setsockopt:[339,343,463,470],setsockopt_str:104,setstat:[159,320,472],setstr:282,setstream:[268,282,471,472],setswitchinterv:[30,90,355,363,446,466,472],setsystemid:413,setsyx:178,settabl:[209,248,397,456,458,472],settarget:268,setter:[45,53,82,98,118,227,366,386,392,462,468],settiltangl:380,settimeofdai:367,settimeout:[339,343,392,459,472],settl:[320,462],settrac:[145,284,355,366,446,458,472],setuid:293,setundobuff:380,setup:[38,62,65,66,69,70,71,72,75,77,79,82,97,104,110,111,170,192,193,298,340,343,363,368,380,385,386,387,449,451,453,455,456,457,458,459,461,462,463,466,467,470,472],setup_annot:[190,470],setup_async_with:190,setup_environ:404,setup_except:190,setup_fin:190,setup_keyword:459,setup_loop:190,setup_python:396,setup_script:396,setup_testing_default:404,setup_with:190,setupclass:[62,188,463],setupmodul:[62,188,463],setupterm:178,setuptool:[64,82,192,309,396,449,453,455,463,470,472],setvalu:402,setvalueex:[402,472],setworldcoordin:380,setx:[98,227,380,455],setxattr:[293,467,472],seven:[95,152,187,245,254,356,387,466],seventh:359,sever:[7,23,26,30,31,38,60,65,66,68,74,75,78,79,80,81,83,84,86,87,89,90,91,93,95,98,99,103,104,106,107,109,110,111,113,122,127,128,129,136,138,152,158,159,161,162,167,169,177,178,184,185,187,190,193,196,200,212,213,214,222,225,237,242,252,253,254,256,258,266,267,268,271,273,282,284,287,292,293,294,295,298,301,308,309,310,313,321,323,330,336,337,339,340,343,344,346,349,350,359,366,372,373,375,376,377,380,384,385,386,387,389,392,397,399,402,403,406,412,416,421,422,424,428,430,432,435,437,439,441,442,445,446,453,456,458,459,460,461,462,463,464,465,466,467,468,470,471,472],sewel:472,seymour:380,sf_append:[293,344],sf_archiv:[293,344],sf_immut:[293,344],sf_mnowait:293,sf_nodiskio:293,sf_nounlink:[293,344],sf_snapshot:[293,344],sf_sync:293,sftp:391,sgi:250,sgid:293,sgml:[241,273,414,462],sgmlop:456,sha1:[236,461,463,466,472],sha224:[236,461,463,466],sha256:[236,339,343,461,463,466,472],sha2:343,sha384:[236,343,461,463,466],sha3:236,sha3_224:[236,470],sha3_256:[236,470],sha3_384:[236,470],sha3_512:[236,470],sha512:[236,461,463,466,472],sha:[174,236,395,461,462,466,467,470,472],shachnev:472,shadow:[62,91,92,174,234,253,254,312,388,447,461,468,472],shah:472,shahaf:[469,472],shake:[62,175,212,470,472],shake_128:[236,470],shake_256:[236,470],shall:[53,301,330,412,422,455,466],shallow:[16,30,62,161,171,183,193,217,245,253,254,301,346,381,438,445,472],shalt:[347,466],shane:472,shannon:[467,471],shape:[2,57,62,212,224,227,320,346,462,467,472],shapelist:380,shapenam:380,shapes:380,shapetransform:380,sharafutdinov:[471,472],share:[5,7,30,31,37,38,41,53,58,62,64,65,70,72,74,77,79,82,83,85,90,93,101,104,107,111,112,117,120,122,135,138,139,165,172,182,187,212,213,216,232,236,238,251,258,260,265,266,274,279,289,292,293,294,298,301,313,320,324,328,331,339,340,342,343,344,345,347,355,361,366,367,370,372,385,386,404,421,423,424,426,428,431,436,437,440,446,448,451,455,459,460,461,462,463,464,465,466,468,470,471,472,473],shareabl:472,shared:225,shared_ciph:[343,469,472],shared_object_filenam:65,sharedctyp:[62,165,469,472],sharedmemorymanag:472,sharepoint:[233,294,419],sharewar:87,sharma:472,sharp:90,sharper:[470,471,472],shasha:320,shashwat:466,shatter:86,shaulov:472,shawn:462,she:168,shear:380,shearfactor:380,shebang:[62,168,396,418,444,452,454,467,470],shed:168,sheesh:458,sheet:[105,152,472],sheila:104,shelf:[331,466,468],shell:[31,62,65,79,82,85,86,91,92,93,97,99,111,112,127,129,132,138,153,157,165,168,169,178,193,221,224,233,253,254,261,288,292,293,294,311,315,333,342,355,363,369,370,385,388,396,397,402,434,435,443,444,446,447,449,451,453,454,456,458,460,463,466,467,468,469,470,471,472],shellexecut:[293,472],shelv:[62,90,185,253,274,300,301,456,459,466],shepherd:[456,459],shgetfolderpath:455,shgetspecialfolderpath:66,shield:[62,127,472],shift:[43,62,178,179,187,248,284,291,293,346,373,404,424,429,438,456,458,460,462,463,467,472],shift_expr:[426,427],shift_ji:159,shift_jis_2004:159,shift_jisx0213:159,shift_path_info:404,shiftji:159,shiftjis2004:159,shiftjisx0213:159,shik:[460,461],shim:472,shimizukawa:472,ship:[87,93,95,129,134,252,274,385,406,418,449,453,455,456,459,463,465,466,468,469,472],shipman:472,shkop:472,shl:466,shlex:[62,129,138,168,224,253,299,350,472],shlib_suffix:468,shoe:106,shop:[437,450],shopkeep:437,short_arrai:177,short_empty_el:[410,414,468],short_opt:65,shortbyt:431,shortbyteschar:431,shortbytesitem:431,shortcom:[266,271,459],shortcut:[62,66,75,107,161,193,236,248,300,309,321,346,359,381,385,424,455,460,462,471,472],shortdescript:385,shorten:[94,185,323,365,466,467,468],shorter:[93,106,203,236,292,302,328,342,349,426,435,438,442,456,457,460,462,463,466,472],shortest:[99,196,227,260,440,456,461,463,464,465,466],shorthand:[22,84,91,102,122,144,190,193,258,339,365,370,377,382,397,423,424,436,439,459,460,468],shortli:[79,81,139,448],shortmessag:[110,246],shortopt:230,shortstr:431,shortstringchar:431,shortstringitem:431,shot:[62,121,170,329,471],should:[1,3,5,7,10,13,17,21,22,24,25,26,28,30,31,32,33,35,38,40,41,45,47,50,51,53,54,55,56,57,58,60,61,62,65,66,69,70,72,74,75,77,78,79,81,82,83,84,85,89,91,92,93,94,95,96,97,99,101,103,104,105,106,107,108,109,110,111,112,113,114,117,118,119,122,123,125,127,128,129,130,133,134,135,137,138,139,140,141,143,144,145,147,149,151,152,153,154,155,156,157,158,159,160,161,164,167,168,169,170,171,172,173,174,175,176,177,178,181,182,184,185,187,189,190,193,195,196,197,199,201,202,203,204,205,206,207,208,209,210,211,212,213,214,216,222,223,225,227,228,229,230,231,232,235,236,241,243,244,245,246,248,249,250,251,252,254,257,258,260,261,265,266,267,268,269,271,274,275,276,279,282,283,284,287,288,289,292,293,294,295,297,298,299,301,302,304,305,306,307,309,310,311,312,313,316,320,321,322,323,324,326,327,330,331,332,333,334,336,337,339,340,342,343,344,345,346,347,348,349,350,351,355,359,360,361,363,365,366,367,368,370,371,372,373,375,376,377,378,380,381,382,383,385,386,391,392,395,396,397,398,399,402,403,404,405,407,408,410,411,412,413,414,416,417,418,419,421,422,423,424,425,426,427,428,430,431,432,436,437,438,439,440,442,444,445,446,449,450,451,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],shouldflush:268,shouldn:[58,62,82,95,106,135,211,266,272,342,343,347,355,385,392,445,452,457,458,460,461,462,465,470,472],shouldstop:385,show:[30,31,62,65,69,78,79,80,82,93,94,95,96,97,98,99,101,103,104,107,109,110,118,122,124,125,129,140,149,153,154,157,159,161,170,173,177,180,187,189,193,203,212,214,217,227,228,236,243,244,248,249,252,256,260,261,266,279,284,291,292,293,301,309,310,320,323,328,333,335,339,342,343,345,346,347,368,370,372,373,375,376,377,380,385,386,387,396,397,399,416,417,418,431,435,436,438,439,440,448,449,451,456,457,458,459,460,461,462,463,465,466,468,469,470,472],show_alloc_count:[470,472],show_cod:[190,466,468],show_compil:65,show_miss:376,show_track_count:[470,472],showalloccount:[451,470,472],showcas:[82,129,135],shown:[22,31,38,74,75,79,83,94,95,97,103,104,105,108,110,111,112,118,161,170,182,187,189,193,204,214,215,248,266,267,292,299,310,315,321,327,347,350,367,372,373,377,380,385,386,387,391,397,399,435,437,439,455,462,469,470,471,472],showparti:272,showrefcount:[451,468],showroom:466,showsyntaxerror:158,showtop:472,showtraceback:[158,469,472],showturtl:380,showwarn:[397,462,472],showwindow:350,shrink:[55,185,460,472],shrt:346,shrug:107,shrunk:[457,472],shtml:463,shttp:391,shtull:458,shuffl:[90,320,321,466],shut:[78,93,107,129,142,246,329,339,340,355,380,448,451,459,463,469,472],shut_rd:339,shut_rdwr:[339,343,472],shut_wr:339,shutdown:[38,93,107,142,167,213,214,229,249,266,284,334,339,340,343,366,385,399,402,424,451,462,466,468,469,471,472],shutdown_asyncgen:[129,132,355,426,470],shutil:[62,90,104,110,121,167,220,227,235,253,293,350,359,363,399,447,459,462,463,471,472],si_band:[334,472],si_cod:[293,334],si_errno:334,si_pid:[293,334],si_signo:[293,334],si_statu:[293,334],si_uid:[293,334],sibl:[7,91,113,122,227,373,407,446],sicp:99,siddharth:472,side:[7,13,28,30,55,62,79,81,84,90,91,95,99,104,106,107,109,110,124,129,135,149,153,156,161,167,170,178,188,189,197,211,225,228,243,244,252,265,284,288,304,313,320,325,326,331,339,340,346,350,363,370,373,385,386,399,404,410,426,428,432,437,438,445,446,448,455,456,457,458,459,460,461,463,464,465,466,467,468,469,470,471,472],side_effect:[386,387,470,472],sidebar:[1,472],sidestep:460,sidh:461,sig:[64,71,74,86,109,112,129,159,236,254,293,334,375,453,456,457,459,463,469],sig_block:334,sig_dfl:[22,117,334,350,472],sig_ign:[22,117,334,350],sig_setmask:334,sig_unblock:334,sigabrt:[215,293,334,451,467,472],sigact:54,sigalrm:[334,472],sigaltstack:[215,472],sigbreak:334,sigbu:[215,451,467],sigchld:[134,334],sigfp:[215,334,451,467,472],sight:[79,143],sighup:334,sigil:[215,334,451,467],siginfo_t:[293,334,472],sigint:[22,62,85,117,284,299,318,334,385,466,472],siginterrupt:[334,462,467],sigiot:472,sigkil:[135,138,284,293,350,460,471,472],sigma:320,sigmask:334,sign:[17,45,57,62,81,91,106,123,143,156,159,161,177,178,184,187,197,210,223,227,230,236,265,267,268,272,275,284,292,293,295,299,321,346,347,349,366,367,391,424,426,431,438,442,444,445,448,455,457,458,460,461,462,463,466,468,470,472],signal:[29,30,45,54,57,62,97,99,104,106,117,126,128,132,134,135,138,142,143,167,177,178,186,188,193,214,227,243,253,257,259,266,267,275,284,290,292,293,299,311,321,324,329,330,332,339,343,347,350,355,363,366,367,382,392,410,412,416,426,428,439,451,456,457,458,459,460,461,462,463,466,470,472],signalnum:334,signam:129,signatur:[16,41,53,57,62,77,91,95,98,103,104,129,146,160,161,162,170,182,212,217,227,228,236,248,252,257,266,267,292,301,315,317,333,336,343,350,355,380,382,386,387,391,412,416,421,436,438,462,465,466,468,469,470,472,473],signer:236,signifi:[17,105,212,225,246,252,342,343,424,431],signific:[5,31,37,62,99,104,106,109,134,159,179,187,193,198,227,258,260,268,275,301,310,320,346,347,355,366,385,395,424,428,430,431,440,448,451,456,457,458,460,461,462,463,465,466,467,469,470,471,472],significand:[347,355],significantli:[91,102,135,167,257,293,297,343,408,424,457,459,460,462,463,466,467,468,469,470,471,472],signoff:307,signon:107,signum:[90,129,215,334],sigpend:[334,467],sigpip:[62,350],sigprocmask:334,sigprof:334,sigquit:334,sigsegv:[215,334,451,467,472],sigset:[334,472],sigsgv:472,sigterm:[62,135,138,284,334,350,462],sigtimedwait:[334,467,469,472],sigvtalrm:334,sigwait:[334,467],sigwaitinfo:[334,467,469,472],sigwinch:[178,472],sigxcpu:324,sigxfsz:350,sigxfz:350,sijin:467,sila:472,silenc:[31,122,325,333,394,463,466,468,472],silent:[5,45,51,60,65,96,103,104,109,117,135,142,170,187,214,219,229,249,251,266,268,271,293,295,298,299,310,333,335,339,347,350,386,391,432,437,451,455,456,460,461,463,464,466,468,469,471,472],silentghost:[469,470,472],silli:[177,292,387],sillier:292,similar:[5,7,21,22,26,28,30,41,45,53,54,57,58,60,61,65,66,74,78,79,81,84,85,90,91,92,93,94,95,96,98,99,103,104,105,106,109,110,111,113,118,129,135,136,137,138,139,140,147,149,152,153,156,158,159,161,167,168,169,170,172,176,177,178,181,182,184,185,187,189,190,196,197,206,208,212,214,227,230,232,234,236,237,241,243,244,246,248,252,254,257,258,260,265,267,269,276,283,284,289,292,293,298,299,301,304,307,310,312,315,321,323,328,332,337,339,340,341,343,346,347,355,356,359,361,365,367,372,377,378,380,382,385,387,391,399,404,406,407,408,410,411,414,416,421,424,426,428,431,432,434,436,438,439,442,443,446,449,451,453,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],similarli:[26,54,65,84,91,95,99,106,109,111,113,122,129,138,153,159,182,184,193,221,229,243,267,271,284,293,298,301,303,310,318,321,338,339,343,346,349,350,355,368,372,378,385,405,419,432,438,456,460,461,462,463,466,468,469,471,472],simionato:459,simon04:472,simon:[459,472],simpkin:467,simpl:[7,30,31,39,57,58,61,62,66,68,69,71,74,75,77,80,81,86,87,90,91,92,94,95,96,97,98,99,102,104,108,109,110,111,114,117,122,124,137,141,142,143,152,153,157,159,168,170,171,174,175,177,182,184,185,188,189,195,197,201,206,208,209,210,212,222,224,225,229,232,235,243,245,249,253,255,261,267,268,271,273,279,284,289,292,293,295,297,299,301,306,309,310,318,320,321,326,330,334,337,339,346,347,359,360,363,366,368,369,375,376,377,380,381,385,387,388,391,392,396,397,399,400,403,405,406,407,408,410,411,416,417,418,419,423,426,429,435,436,437,438,439,441,442,445,447,451,455,456,457,460,461,462,463,465,466,467,468,469,472,473],simple_app:404,simple_exampl:[103,104],simple_logging_config:103,simple_logging_modul:103,simple_serv:[62,255,461,470,472],simple_stmt:[423,427],simplecooki:[245,472],simpledialog:370,simpleexampl:[103,104],simplefilt:[363,397,462,463,472],simpleformatt:103,simplehandl:[404,456],simplehttp:246,simplehttprequesthandl:[246,471,472],simplehttpserv:[464,472],simpleinstal:455,simpleinstalldescript:455,simplejson:[462,463],simplenamespac:[62,161,381,472],simplequeu:[62,165,268,284,471,472],simpler:[5,62,66,80,84,94,95,97,104,106,108,111,122,153,161,227,236,284,321,346,347,386,399,408,410,412,428,435,438,439,455,456,457,458,459,461,463,467,468,471,472,473],simplest:[30,69,74,75,78,79,82,95,99,102,103,106,107,110,122,141,159,170,176,187,193,201,211,237,297,301,321,343,366,385,386,418,424,426,436,446,447,448,451,456,458,459],simplexmlrpcdispatch:[471,472],simplexmlrpcrequesthandl:[417,460,463],simplexmlrpcserv:[62,255,416,458,460,461,462,463,464],simpli:[7,31,47,57,65,68,69,70,74,78,79,81,82,84,85,90,91,93,94,95,96,99,102,104,105,106,109,111,118,122,140,141,152,154,157,159,161,168,177,178,184,187,193,222,225,227,232,241,248,252,254,261,267,268,272,284,292,293,298,299,301,305,306,316,321,326,327,334,337,340,342,344,347,350,355,366,385,386,387,392,397,399,400,404,406,407,408,416,418,422,428,436,440,442,445,453,455,456,457,458,459,460,461,462,463,466,469,472],simplic:[58,81,261,346,456,458],simplif:[216,472],simplifi:[26,28,30,60,80,84,92,93,98,99,106,108,110,125,159,161,170,184,185,198,202,217,228,252,254,284,321,339,340,372,373,375,382,399,407,423,431,447,448,455,458,459,460,461,462,463,464,466,467,468,469,470,471,472],simplist:[104,386],simsalabim:466,simul:[22,62,95,96,97,98,108,117,129,135,137,161,178,235,237,297,320,328,334,349,364,380,399,457,458,468],simultan:[30,57,104,105,138,233,248,257,271,282,331,340,363,366,372,432,444,445,455,462,469,472],sin6_flowinfo:339,sin6_scope_id:339,sin:[156,187,275,424,436,459],sinc:[5,7,12,21,22,23,26,30,31,35,36,41,42,44,49,51,52,53,54,57,58,62,65,66,68,69,72,74,75,77,78,79,81,82,84,85,86,87,90,91,93,95,96,97,98,101,102,103,104,105,106,109,110,111,112,113,114,116,118,123,125,129,135,139,141,144,145,147,150,153,158,159,161,162,168,170,174,176,177,178,182,184,185,187,189,193,194,195,197,199,200,202,204,206,208,209,210,212,214,219,222,223,224,225,227,228,229,232,234,235,236,237,238,243,244,245,246,248,249,251,252,254,257,258,261,265,267,268,270,271,272,275,279,284,288,292,293,294,295,297,298,299,304,305,306,307,309,310,316,321,329,331,332,333,336,337,339,340,341,342,343,346,347,349,351,355,361,363,365,366,367,370,372,373,375,376,378,382,385,386,392,395,396,397,398,399,402,404,406,407,408,409,410,411,412,416,418,419,421,423,424,425,426,428,430,431,435,436,437,438,439,440,442,444,445,446,451,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],sinclair:469,sine:[156,187,275],sine_t:436,sinfo:266,singapor:410,singaravelan:472,singh:[471,472],singl:[4,5,7,9,13,15,22,28,30,31,35,44,53,56,57,58,60,61,62,67,71,72,74,77,79,82,84,85,86,92,93,95,97,99,100,102,105,106,108,109,110,111,122,123,124,129,141,145,147,152,153,158,159,160,161,164,167,168,176,177,178,179,182,184,187,189,190,193,196,197,203,204,208,209,212,214,219,221,222,225,227,228,232,235,236,237,238,243,244,248,249,254,257,258,260,264,266,267,268,269,271,275,279,282,284,288,292,293,297,298,299,301,304,305,307,309,310,316,317,320,321,332,333,334,336,337,339,340,342,343,345,346,347,349,350,354,355,356,363,365,370,373,375,376,377,382,385,386,387,391,392,393,395,397,399,404,405,407,410,412,414,416,418,419,424,426,427,428,430,431,432,435,436,437,438,441,442,444,445,448,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,470,471,472],single_char:109,single_input:427,singleaddresshead:204,singledispatch:[93,228,468,471,472],singleton:[15,19,41,42,45,51,57,79,91,93,124,212,274,301,346,380,386,416,424,426,438,457,470,471,472],singleus:170,singular:[152,232],sinh:[156,275],sinpi:472,sio:91,sio_keepalive_v:339,sio_loopback_fast_path:[339,470,472],sio_rcval:339,sionneau:[469,470],sip:[85,296,391],siphash24:[62,472],siphash:[422,468,472],sir:[410,437,465],sit:[151,372,414],site:[30,62,64,74,86,91,99,109,110,111,168,211,227,244,245,252,253,258,266,293,304,317,337,355,356,392,393,396,411,426,428,434,441,449,450,451,455,456,461,463,464,467,468,469,472,473],sitecustom:[111,335,434,463,468,472],sitedir:335,situat:[7,31,38,57,58,64,65,69,79,81,84,91,95,99,103,104,105,107,108,110,111,122,130,153,159,170,208,212,214,232,236,248,252,257,266,271,284,292,337,363,366,387,394,397,407,424,433,436,437,438,458,463,464,468,469,470,472],sivaraam:472,six:[105,184,228,254,305,320,321,342,373,391,395,419,462,466,468,471],sixth:[305,458],sixtofour:258,sizabl:[450,457,458],size1:81,size2:81,size:[3,5,7,8,9,17,26,28,31,35,37,38,39,45,49,50,53,54,55,57,58,62,79,81,82,84,92,97,101,103,104,107,109,117,119,120,122,123,125,130,135,136,137,138,143,145,146,155,159,161,162,164,167,174,175,176,178,187,189,190,212,220,222,225,227,228,237,238,243,246,248,249,252,257,261,265,268,269,279,284,294,295,301,305,307,308,310,313,316,318,320,322,323,324,336,337,338,339,340,342,344,346,347,350,351,355,359,361,363,365,366,370,372,373,378,380,382,385,392,399,405,407,418,419,421,424,428,442,445,446,448,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],size_diff:378,size_or_initi:284,size_t:[9,17,35,38,54,58,95,96,177,349,467],sizeabl:472,sizegrip:[62,369],sizehint:[135,159,329,472],sizeof:[31,38,57,82,96,177,305,349,355,386,418,472],sizeof_digit:[355,463,465],sji:[159,184],sjis2004:159,sjis_2004:159,sjisx0213:159,sjoerd:[346,442,456,462],skcipher:339,skein:[225,236],sketch:[193,244,437,450,461,462],skill:[86,91,442],skim:450,skimp:193,skip:[7,13,30,31,53,62,65,90,91,95,99,105,106,107,108,109,145,155,159,161,164,168,170,173,184,188,193,205,206,211,219,225,227,251,252,254,256,260,261,271,272,288,299,306,321,332,335,343,344,346,349,359,363,373,382,396,410,412,422,423,432,439,448,451,455,456,458,459,460,461,462,463,465,466,468,472],skip_accept_encod:243,skip_blank:65,skip_curdir:164,skip_host:243,skip_unless_bind_unix_socket:[363,472],skip_unless_symlink:363,skip_unless_xattr:363,skipif:[363,385],skipinitialspac:176,skipkei:[261,306],skippedent:412,skipston:400,skiptest:[363,385,463,468],skipunless:[385,465],skipunlesshasattr:385,skit:[79,193,435],skrobov:472,skycach:225,skycaptain:466,skyfield:449,slackbook:454,slackwar:454,slant:456,slash:[65,67,74,75,84,106,111,227,254,258,292,293,294,298,315,374,391,404,419,420,472],slashequ:374,slate:[193,468,469],slave:[288,293,311,370],sle257ohy9fvq07z:343,sle:471,sleep:[62,90,99,104,126,127,128,129,131,135,136,138,139,167,168,178,284,327,334,342,350,367,462,467,469,470,471,472],sleep_for:136,sleeper:472,sleepi:466,slen:104,slept:136,slew:203,slice:[7,15,34,36,49,55,62,91,93,99,105,123,124,143,161,169,172,177,190,207,214,227,230,260,279,284,291,293,301,320,321,342,346,412,423,424,432,437,438,442,445,446,456,458,460,461,462,463,464,466,467,468,469,471,472,473],slice_item:426,slice_list:426,slice_richcompar:472,slicelength:51,sliceop:427,slide:[90,109,408],slider:472,slideshow:408,slight:[65,94,104,216,244,456,459,466],slightest:437,slightli:[31,74,81,84,85,86,87,91,95,96,99,103,104,108,110,111,170,176,197,232,237,257,292,293,296,299,309,310,320,343,346,380,387,391,392,428,432,436,447,456,458,459,460,461,462,463,466,468,469,471,472],slimmer:268,sln:66,sloppi:84,slot:[15,41,43,45,53,56,57,62,81,82,136,190,213,229,252,254,282,284,318,346,424,426,456,457,458,460,461,462,464,467,468,469,472],slot_descriptor:254,slotdef:472,slow:[86,97,104,107,128,149,161,185,236,248,257,268,284,331,340,380,395,419,420,435,438,456,457,459,460,462,472],slow_callback_dur:128,slower:[90,91,106,159,228,236,257,269,284,331,380,448,459,460,462,464,471,472],slowest:[235,380,421,472],slowli:[79,93,104],sluggish:104,small:[5,30,38,50,53,57,62,72,74,79,84,86,90,91,95,97,102,104,106,107,109,159,169,170,177,186,187,189,193,244,248,253,257,260,271,275,284,288,293,310,320,321,331,334,339,345,346,363,366,372,385,404,406,410,421,435,436,437,438,448,453,455,456,457,458,459,460,461,462,463,464,466,467,468,470,472],small_stmt:427,smaller:[38,58,97,106,107,135,177,184,187,189,190,237,258,269,293,310,318,345,349,356,373,380,391,408,421,426,431,438,440,446,457,459,460,461,462,463,465,466,467,468,469,470,472],smallest:[99,109,123,184,187,227,237,275,346,378,448,459,460,461,462,472],smalltabl:467,smalltalk:[90,99,161,385,436,457],smarrita:461,smart:[66,95,248,458,472],smarter:[387,465,466,472],smaxcol:178,smaxrow:178,smincol:178,sminrow:178,smith:[212,460,461,462,463,465,466,467,468,469,470,471,472],sml:260,smtp:[62,86,90,103,195,201,202,204,209,253,255,268,343,447,456,458,462,466,467,468,469,472],smtp_:336,smtp_code:337,smtp_error:337,smtp_server:336,smtp_ssl:[337,462,467],smtp_state:336,smtpauthenticationerror:337,smtpchannel:[62,255,468,469,470,472],smtpconnecterror:337,smtpd:[62,195,253,255,470,472],smtpdataerror:337,smtpexcept:[337,468],smtphandler:[62,103,104,120,267,472],smtpheloerror:337,smtplib:[62,90,195,201,202,209,253,255,268,343,447,458,462,466,470,472],smtpnotsupport:337,smtpnotsupportederror:337,smtprecipientsrefus:337,smtpresponseexcept:337,smtpsenderrefus:337,smtpserver:[62,255,468,469,470,472],smtpserverdisconnect:[337,472],smtputf8:[209,336,337,469,472],smtputf8simtest:472,snake:[124,161],snan:[187,463],snap:141,snapshot1:378,snapshot2:378,snapshot:[62,186,344,468,472],snd:351,snd_alia:403,snd_async:403,snd_filenam:403,snd_loop:403,snd_memori:[403,472],snd_nodefault:403,snd_nostop:403,snd_nowait:403,snd_purg:403,sndctl_dsp_setfmt:295,sndctl_dsp_sync:295,sndhdr:[62,207,253,278,472],sndr:338,sndt:338,sneakili:458,sneezi:466,snew:391,sni:[343,468,471,472],sni_callback:343,snider:[470,472],snif:110,sniff:[176,472],sniffer:[176,339,472],snippet:[22,62,68,84,94,104,128,140,171,186,245,253,267,332,343,366,438,455,458,459,461,469,472],snmp:107,snow:[326,467,468,469,470,471],snowman:104,snprintf:[17,458],so_:339,so_domain:[339,470],so_exclusiveaddrus:363,so_passsec:[339,470],so_peersec:[339,470],so_protocol:[339,470],so_reuseaddr:[141,339,363],so_reuseport:[129,363,472],so_setfib:463,so_vm:339,soabi:466,soapbox:[62,188],soar:472,sock:[104,106,107,125,129,135,137,141,243,310,330,339,340,343,363,466,469,471,472],sock_:[339,468],sock_accept:[129,132,471,472],sock_cloexec:[339,471,472],sock_connect:[129,132,469,472],sock_dgram:[129,268,339,340,463],sock_max_s:363,sock_nonblock:[339,471,472],sock_raw:339,sock_rdm:339,sock_recv:[129,132,471,472],sock_recv_into:[129,132,471,472],sock_sendal:[129,132,471,472],sock_sendfil:[129,132,471,472],sock_seqpacket:339,sock_stream:[104,107,129,141,268,339,340,343,363,463,471],sockaddr:[129,339],sockaddr_in6:339,socket:[22,62,86,93,99,100,102,103,104,106,109,127,130,132,133,159,171,172,208,213,214,225,243,246,248,249,253,255,257,258,259,266,267,268,284,288,293,298,307,309,324,329,330,333,334,336,337,340,344,359,360,363,370,399,404,410,424,435,448,456,457,458,459,460,461,462,463,472],socket_typ:340,socketcan:467,sockethandl:[62,103,104,120,267,468],socketkind:339,socketmodul:472,socketpair:[129,135,137,339,460,471,472],socketserv:[62,104,242,246,253,255,339,417,462,463,464,472],sockettyp:339,socknam:[135,472],socktyp:[104,268,339,363,463],soffer:[471,472],soft:[178,324,363,472],softspac:464,softwar:[1,30,62,63,64,65,66,74,83,87,89,91,92,93,99,103,109,111,112,153,159,178,188,193,195,211,213,230,236,246,247,248,253,265,288,293,309,320,343,402,404,416,435,447,453,454,455,456,457,459,460,462,463,472,473],soh:179,sokolovskii:236,sol_:339,sol_alg:[339,470],sol_can_:339,sol_rd:339,sol_socket:339,solari:[30,62,65,66,72,247,293,305,308,329,355,356,367,456,463,466,467,469,471,472],soldier:291,sole:[31,65,69,84,91,94,95,105,169,187,254,284,346,365,381,399,424,426,439,463,467,468,469,471],solicit:[68,157],solid:[72,178,467,468],solidu:384,solitari:284,solomon:380,solut:[31,62,64,66,79,84,85,87,90,91,93,95,98,99,104,105,106,107,109,111,112,134,182,187,212,237,248,253,255,301,321,334,340,342,361,387,422,428,446,447,449,450,455,456,458,459,460,461,462,463,465,466,472],solv:[30,84,90,91,93,95,96,99,106,141,248,284,331,359,386,387,423,450,458,459,461,465,466,468],solver:450,somaxconn:[339,469],some:[1,2,5,7,20,22,30,31,38,52,53,54,55,57,58,62,64,65,66,68,69,72,74,77,78,79,80,81,82,86,87,89,90,91,92,93,94,95,96,97,99,101,102,103,104,105,106,107,108,109,110,111,112,113,117,118,122,123,129,132,133,135,138,139,140,143,146,151,153,156,157,158,159,161,162,164,165,167,168,169,170,176,177,178,181,182,183,184,185,187,189,193,195,196,197,199,200,204,205,206,207,208,209,210,212,214,216,217,219,220,222,223,227,228,229,232,235,236,237,240,241,244,245,248,249,251,252,253,254,256,257,258,259,260,261,265,266,267,268,269,271,272,274,275,276,283,284,288,291,292,293,294,295,297,298,301,302,305,308,310,313,316,320,321,324,329,330,332,333,334,335,337,339,340,342,343,344,345,346,347,349,350,355,356,357,359,360,361,363,365,366,367,370,373,374,377,378,380,381,382,385,386,387,388,392,395,396,397,399,400,404,406,407,408,409,410,411,412,413,416,418,419,421,423,424,425,426,428,430,431,432,434,435,436,437,438,439,440,442,443,444,445,446,447,450,451,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],some_attribut:[82,386],some_behavior:212,some_conn_id:104,some_coroutin:423,some_enum_var:212,some_fil:470,some_func:354,some_funct:[104,386,387],some_handler_inst:110,some_id:[382,470],some_int:91,some_iter:113,some_lock:366,some_method:[387,416],some_mock:386,some_numb:81,some_obj:387,some_object:[81,91,254,386],some_python_coroutin:140,some_s:81,some_sequ:464,some_tag:408,some_tupl:91,some_typ:177,some_valu:382,some_vari:299,some_xml_docu:316,someact:370,somebodi:110,someclass:[113,301,382,386,387,456],somedata:[212,306],somedir:227,someexcept:[214,385,464],somefil:[170,205,232,293,332,376],somehow:[79,84,284,345,359,446,462,463],someiter:176,somelogg:104,somemoredata:306,somenam:346,somenamedtupl:161,someon:[66,79,89,91,95,107,111,337,361,392,410,463],someone_els:201,someopt:370,someotherfil:170,somepackag:112,somepolici:209,someserv:110,somestr:350,sometag:410,sometest:[385,471],sometext:410,someth:[17,21,30,32,65,69,72,79,81,84,86,90,91,92,93,94,95,96,97,99,102,103,104,105,106,107,111,123,134,140,145,148,153,170,176,177,190,202,212,214,227,230,237,248,252,254,260,261,266,267,284,292,293,301,308,310,316,324,336,340,342,343,351,359,363,366,382,385,386,387,392,398,399,404,407,416,428,432,436,437,445,448,456,457,458,459,460,461,462,463,466],somethingfortest:386,sometim:[1,31,62,64,72,74,75,79,80,84,85,90,91,93,97,99,102,104,105,106,107,109,110,111,112,113,118,122,125,140,153,159,170,172,177,178,187,189,193,204,212,214,225,236,241,248,254,258,260,267,271,288,292,308,310,320,321,343,344,345,367,380,386,387,392,410,424,426,430,432,436,437,438,444,445,448,449,456,459,460,461,463,464,465,466,467,468,469,470,472],sometyp:[382,469],someurl:110,somevalu:407,somevar:91,somewarn:385,somewhat:[10,22,65,93,95,177,184,205,248,265,292,293,297,339,361,444,445,446,456,461,464,471,472],somewher:[66,79,90,91,95,104,145,246,292,316,343,345,346,407,462],somewidget:373,son:456,sonntag:184,soon:[31,90,95,97,105,106,107,109,110,132,140,193,230,284,293,299,346,361,363,408,424,438,439,459,461,468,472],sooner:[177,408,462],soonest:[327,467],soothsay:447,sophist:[80,91,95,135,141,157,170,266,320,343,410,447,448,458,461],sornai:472,sorri:[95,96,437],sort:[34,62,74,82,83,86,90,92,93,94,99,100,110,113,122,153,161,168,174,177,183,185,187,189,193,209,222,227,228,237,249,254,258,260,261,265,271,284,291,292,298,306,309,310,318,320,321,329,337,342,345,346,359,363,378,380,381,385,392,404,407,419,424,426,436,437,438,446,448,458,459,460,461,462,463,464,466,468,469,471,472],sort_criteria:249,sort_kei:[261,306,466],sort_ord:310,sort_stat:310,sortabl:258,sortbi:310,sortdict:363,sortedcollect:149,sorting_anim:380,sortkei:310,sorttestmethodsus:385,sottil:472,soul:349,soumya:472,sound:[62,78,90,111,119,143,178,225,253,278,295,351,398,401,446,459,462],sound_mixer_:295,sound_mixer_m:295,sound_mixer_pcm:295,sound_mixer_synth:295,sound_mixer_volum:295,soundcard:295,soup:241,sourc:[0,5,19,22,28,30,31,52,60,62,66,68,69,70,71,72,77,78,79,81,82,84,85,87,93,94,95,96,97,99,104,105,111,112,113,114,116,118,119,122,124,125,141,144,145,148,149,151,152,153,154,155,157,158,159,160,161,162,163,164,167,168,170,172,173,174,176,177,178,182,184,185,187,188,189,190,192,193,194,195,196,198,199,200,202,203,204,205,206,207,208,209,210,212,214,215,217,219,221,223,225,227,228,230,231,232,233,235,236,237,238,239,240,241,242,243,244,245,246,249,250,251,253,256,257,258,260,261,262,263,264,265,266,267,268,269,270,271,272,274,276,280,281,282,284,286,288,289,291,292,293,294,295,296,297,298,299,301,302,303,304,305,306,307,309,310,311,314,315,317,318,319,320,321,323,325,326,327,328,330,331,332,333,335,336,337,338,339,340,342,343,344,345,346,347,348,349,350,351,353,354,355,356,358,359,360,361,363,365,366,367,368,369,370,371,372,373,374,376,377,378,379,380,381,382,385,386,389,390,391,392,393,394,395,396,397,398,399,400,402,404,405,406,407,408,409,410,411,412,413,414,416,417,418,419,420,422,423,424,427,428,430,431,432,433,434,438,439,441,442,446,449,451,453,454,455,456,457,458,460,461,462,463,464,465,466,467,468,469,470,471,472,473],source1:[359,419],source_address:[225,243,337,339,463,466,467],source_byt:252,source_date_epoch:[164,313,471,472],source_filenam:65,source_from_cach:[28,251,252,466,468,470],source_hash:[252,471],source_str:297,source_suffix:252,source_to_cod:[252,468,469,472],source_traceback:128,sourcecod:380,sourcefil:111,sourcefileload:[28,252,467,470],sourceforg:[74,86,87,90,91,111,184,343,456,457,459,462,472],sourcehook:332,sourceless:[252,467,469],sourcelessfileload:[252,467,470],sourcelin:209,sourceload:[252,467,468],sourcen:[359,419],sourcewar:111,south:[159,212,321,373,380,462,465],southeast:373,sovers:472,sp3:471,sp4:462,sp_expir:341,sp_flag:341,sp_inact:341,sp_lstchg:341,sp_max:341,sp_min:341,sp_namp:341,sp_pwdp:341,sp_warn:341,space:[5,30,35,38,54,57,58,65,78,79,84,91,92,93,97,99,103,106,107,109,117,122,144,147,152,159,161,162,163,168,179,185,187,189,193,199,200,202,203,213,214,222,227,243,248,249,254,258,260,261,265,267,284,292,293,297,299,302,316,319,320,321,324,332,333,334,335,337,339,346,347,348,350,363,365,366,368,370,372,373,375,378,380,391,392,394,396,404,407,421,422,424,428,430,431,437,442,444,445,448,456,460,461,462,463,464,465,467,468,470,471,472],space_around_delimit:168,spaciou:346,spam42:469,spam:[79,83,104,106,110,122,171,176,177,219,227,228,232,243,244,246,252,254,257,267,298,299,309,315,321,331,335,346,350,359,377,386,387,392,410,419,426,428,436,437,439,442,445,446,456,462,469],spam_appl:104,spam_doc:79,spam_modul:79,spam_system:79,spamerror:79,spammer:337,spammetapathfind:252,spammethod:79,spammifi:79,spammish:236,spammodul:79,spampathentryfind:252,spamread:176,spamspam:227,spamwrit:176,span:[65,93,106,152,168,176,190,193,221,222,241,321,346,347,423,445,461,462,467,469,470,472],sparc:[30,295],spare:457,sparingli:84,spark:[457,472],sparrow:459,spars:[21,359,472],spawn:[62,71,104,127,132,134,138,139,165,293,311,336,340,366,468,472],spawn_python:363,spawnl:293,spawnlp:[293,350],spawnv:[293,472],spawnvp:[293,350],spdy:343,speak:[30,62,79,91,107,111,123,184,227,274,343,346,357,436,437],speaker:403,spec:[28,41,56,62,66,68,93,237,245,252,254,261,326,342,343,351,355,373,386,387,416,459,468,469,470,471,472],spec_from_file_loc:[251,252,470],spec_from_load:252,spec_set:[386,387],speci:66,special:[7,13,22,28,30,31,45,55,57,58,62,65,66,70,74,79,81,84,90,91,93,95,97,99,103,104,105,106,109,111,112,118,122,124,129,138,140,144,145,153,154,156,157,161,168,169,170,172,176,177,178,181,182,183,184,190,193,197,204,206,209,212,214,221,224,230,232,233,246,248,251,253,254,258,260,261,265,266,267,271,282,283,284,290,291,292,293,297,298,301,304,321,323,326,330,332,333,334,339,342,343,344,349,350,355,359,362,366,370,372,382,385,386,391,392,399,404,407,410,412,416,422,425,426,429,431,432,435,436,438,444,445,446,453,455,456,457,458,460,461,462,463,466,467,468,469,470,471,472,473],specialbuild:31,specialfileerror:463,specialfilt:104,specialis:[104,110,346],specialti:66,specif:[0,1,15,22,25,31,32,38,41,52,53,55,57,60,61,62,64,65,66,67,70,71,74,77,79,82,83,86,91,92,93,94,95,96,100,101,102,103,104,105,106,109,110,111,112,113,117,120,122,124,127,133,134,135,136,146,153,155,156,157,168,170,172,173,176,177,178,182,184,185,187,193,195,196,197,201,203,204,206,207,209,211,212,213,214,216,222,224,225,227,228,229,230,232,233,236,241,243,244,245,246,248,251,252,253,254,256,257,258,261,265,266,267,268,271,274,275,282,284,288,291,293,294,295,296,297,299,301,310,316,317,318,320,323,324,329,330,332,333,336,337,339,340,342,343,344,346,353,356,360,361,363,364,365,366,367,369,370,371,374,381,382,384,385,386,387,391,392,395,396,397,398,399,404,407,408,410,414,416,419,420,421,422,423,424,428,429,430,431,432,433,435,436,439,442,448,449,451,454,455,456,457,458,464,465,466,467,468,470,471,472],specifi:[3,5,7,9,10,12,13,16,17,19,21,22,28,30,31,35,38,41,45,51,57,58,60,62,65,66,68,69,70,71,72,74,77,79,81,82,83,85,93,94,97,99,103,104,106,107,108,109,110,111,112,113,117,119,120,121,122,123,124,129,131,134,135,140,141,143,144,145,147,149,151,152,153,156,157,158,159,161,164,167,168,169,170,174,176,178,182,184,185,187,189,190,191,193,195,196,197,198,201,202,203,204,205,206,207,208,209,210,211,212,214,219,222,225,227,228,229,230,232,233,235,236,237,243,244,245,246,249,252,254,257,258,260,261,265,266,267,268,271,272,276,279,280,282,283,284,286,288,291,292,293,294,295,297,298,299,301,302,304,306,307,309,310,313,315,316,319,320,321,322,324,326,328,329,330,331,332,333,334,336,337,339,342,343,346,347,349,350,351,355,359,360,361,362,363,366,367,368,370,372,373,375,376,377,380,381,382,385,386,387,391,392,393,394,395,396,397,398,402,403,404,407,408,410,412,413,419,420,421,423,424,425,426,428,431,432,436,437,438,439,440,442,446,448,449,451,455,456,457,458,459,460,461,462,464,466,467,468,469,470,471,472,473],specific_submodul:446,specified_attribut:316,specifii:455,spectacular:237,sped:[466,469,472],speech:[104,295],speed:[8,38,58,79,84,95,103,106,111,147,161,162,178,185,187,189,217,228,229,237,252,257,260,295,299,301,320,331,343,345,355,362,368,380,421,424,435,446,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],speedi:237,speedstr:380,speedup:[95,422,457,461,462,463,465,466,467,468,472],speedvalu:380,speleotrov:460,spell:[68,74,84,97,159,184,204,227,256,310,373,431,432,444,459,464,467,472],spend:[64,324,456,472],spent:[79,310,324,334,461,462],spew:472,sphinx:[0,62,86,90,104,472],spider:[393,456],spil:472,spill:184,spin:320,spinbox:[62,369,372,471,472],spiral:157,spirit:[74,94],spit:404,splice:213,split:[41,58,62,65,68,74,84,90,91,108,122,143,157,159,168,187,189,197,201,203,209,230,232,249,260,270,282,291,292,293,294,299,309,320,321,323,332,337,342,343,346,347,350,365,375,378,385,391,396,412,431,435,436,442,446,458,459,460,461,462,463,465,466,467,468,469,471,472],split_quot:65,splitchar:203,splitdriv:[294,471],splitext:[95,201,294,298,359,448,462,470],splithost:472,splitlin:[93,157,189,201,209,346,365,377,462,466,468,472],splitlist:472,splitresult:[391,472],splitresultbyt:[391,472],splitunc:[471,472],spoerri:461,spoken:[66,104],spolski:109,sponsor:422,spoof:392,spool:361,spooledtemporaryfil:[361,462,467],spoon:74,sporad:293,sport:237,spot:[91,295,309,365],spread:[62,84,107,290,462],spreadsheet:[98,176,345,447,459],spring:[66,106,184,227,436],sprinkl:[91,430],sprint:[461,462],sprintf:[346,442,456,458],sprocket:466,spuriou:[187,298,334,465,472],spwd:[62,234,253,312,388,461,470,472],spytz:472,sq_ass_item:57,sq_concat:57,sq_contain:[53,57],sq_inplace_concat:57,sq_inplace_repeat:57,sq_item:57,sq_length:57,sq_repeat:57,sql:[99,109,176,260,282,292,342,447,461,465,467,472],sql_script:342,sqlite3:[62,90,161,253,300,301,447,462,463,472],sqlite3_get_autocommit:472,sqlite3_prepare_v2:472,sqlite:[62,253,300,447,461,463,466,467,468,471,472],sqlite_deni:342,sqlite_ignor:342,sqlite_ok:342,sqlite_vers:342,sqlite_version_info:342,sqrt:[122,143,156,167,187,275,460,461,462,466],sqrt_n:167,squar:[5,30,91,93,94,99,109,122,143,156,178,187,212,275,299,310,345,346,380,391,410,424,426,430,431,432,436,438,442,445,458,459,462,472],squeez:[248,470,471,472],squeezer:472,squirrel:[30,310],src1:[167,466],src2:[167,466],src3:[167,466],src4:167,src:[7,65,69,74,85,94,177,193,201,233,241,279,282,293,333,418,459,461],src_dir_fd:293,srcdir:466,srcname:333,sre:[456,458],sre_compil:[280,310],sre_const:[280,469],sre_flag_unicod:280,sre_match:469,sre_pars:280,sre_pattern:472,sriniva:471,srmount:213,srow:375,srpm:[66,71],srv:[129,171,471],sscanf:177,sse2:472,sse4:472,ssh:[288,332,333,391,472],ssize_t:[62,95,177,349,466,467,473],ssize_t_convert:95,ssizeargfunc:57,ssizeobjargproc:57,ssl3:343,ssl:[62,110,129,135,137,225,243,249,253,259,268,288,293,307,337,339,392,404,416,422,456,459,460,463,472],ssl_cert_dir:472,ssl_cert_fil:[343,472],ssl_cert_path:343,ssl_context:[249,288],ssl_ctx_set_min_proto_vers:472,ssl_error_:343,ssl_handshake_timeout:[129,137,471],ssl_mode_auto_retri:463,ssl_mode_release_buff:472,ssl_object:135,ssl_op_al:343,ssl_sock:343,ssl_verify_post_handshak:472,ssl_version:[225,343],sslcertverificationerror:[343,471,472],sslcontext:[129,135,225,243,249,268,288,307,337,343,392,416,463,466,467,468,469,470,471,472],ssleai:422,ssleoferror:343,sslerror:[343,466],sslerrornumb:343,sslfakefil:467,sslobject:[135,343,469,471,472],sslobject_class:343,sslproto:472,sslprotocol:472,sslsession:[343,470],sslsocket:[135,343,463,468,469,471,472],sslsocket_class:343,sslsyscallerror:343,ssltransport:472,sslv23:343,sslv23_method:472,sslv2:[343,466],sslv3:[343,467,469,472],sslwantreaderror:[343,469,472],sslwantwriteerror:[343,469,472],sslzeroreturnerror:343,ssmedian:345,ssnd:472,ssock:343,sss:[79,81,184],ssse3:472,st2list:297,st2tupl:297,st_append:293,st_atim:[293,344],st_atime_n:293,st_birthtim:[293,461],st_blksize:293,st_block:[293,472],st_creator:293,st_ctime:[293,344],st_ctime_n:293,st_dev:[293,344],st_file_attribut:[293,344,469,472],st_flag:[293,461],st_fstype:[293,471,472],st_gen:[293,461],st_gid:[293,344],st_immut:293,st_ino:[268,293,344,472],st_mandlock:293,st_mode:[293,298,344,468],st_mtime:[189,235,293,298,344,459],st_mtime_n:293,st_nlink:[293,344],st_noatim:293,st_nodev:293,st_nodiratim:293,st_noexec:293,st_nosuid:293,st_rdev:293,st_rdonli:293,st_relatim:293,st_rsize:293,st_size:[293,298,344,458],st_synchron:293,st_type:293,st_uid:[293,344],st_write:293,stab:292,stabil:[1,62,86,227,237,472],stabl:[29,56,62,87,93,108,211,227,237,252,276,292,346,455,459,460,463,468,469,470,472,473],stack:[11,22,30,31,54,62,79,81,84,95,103,117,120,124,140,145,158,161,170,172,178,185,186,190,193,212,214,215,222,227,228,248,253,256,266,299,317,318,324,332,334,339,343,344,346,355,366,372,385,386,387,423,424,425,426,431,432,434,439,441,451,456,457,460,461,462,463,466,467,468,469,471,472],stack_effect:[190,468,472],stack_glob:472,stack_info:266,stack_level:22,stack_siz:[117,366,461,472],stack_t:472,stackbrows:472,stackless:[84,430],stacklevel:[397,461,472],stacksiz:12,stacksummari:[62,317,469,472],stackview:472,staff:[103,184,333],stage:[65,106,297,366,370,392,397,407,456],stai:[58,62,355,422,442,466,467,470,473],stake:380,stale:[213,252,468,472],stall:472,stamp:[184,380,436,459,460,472],stamp_id:380,stampid:380,stand:[7,69,74,87,109,111,170,187,211,292,321,417,418,431,456,461,462,463,466,468,471],standalon:[62,65,72,84,93,170,191,193,252,316,380,385,423,453,462,472],standard:[0,5,7,17,23,28,29,30,38,54,56,57,58,60,62,64,66,68,71,72,74,75,79,80,81,82,83,84,85,86,87,90,92,93,94,99,103,104,105,106,108,109,110,112,113,115,117,118,120,122,129,135,136,138,143,144,145,146,147,149,152,153,155,158,161,164,167,176,177,178,179,183,184,187,193,195,196,197,198,200,202,203,204,206,207,208,209,210,212,214,219,220,221,222,225,226,227,232,236,239,240,244,246,248,249,251,252,254,257,260,265,266,267,268,271,272,273,275,276,279,280,282,284,285,288,293,294,295,297,301,303,304,307,308,310,311,313,314,316,320,321,326,328,329,332,334,335,337,339,340,345,346,347,349,350,352,355,356,358,359,360,361,363,366,367,368,369,370,372,377,380,382,384,385,386,387,391,392,394,395,397,399,404,405,407,410,416,418,419,422,423,425,426,429,430,431,432,433,434,435,436,438,439,441,442,444,445,449,450,451,453,454,455,456,457,458,460,461,462,463,464,465,466,467,468,469,470,471,472,473],standard_b64decod:144,standard_b64encod:144,standard_lib:65,standard_option_list:292,standard_rights_read:402,standard_rights_requir:402,standard_rights_writ:402,standard_test:[363,385],standard_wai:108,standarderror:[113,462,464],standend:178,standout:178,standpoint:92,stap:101,stapsdt:101,star:[124,190,374,430,432,472],star_expr:427,stararg:462,stare:84,starequ:374,starmap:[99,227,260,284,467],starmap_async:[284,467],starostin:472,starred_and_keyword:426,starred_express:[426,432],starred_item:426,starred_list:426,starship:[382,461,470],start:[7,9,10,21,22,30,31,38,51,57,58,60,62,65,66,69,72,74,75,78,81,82,84,85,86,89,90,91,93,94,95,98,99,101,103,104,105,106,107,109,110,111,112,117,119,122,124,125,127,129,132,135,137,138,139,140,143,145,147,152,153,155,158,159,161,162,165,167,169,170,177,178,179,182,184,185,188,189,190,193,195,200,202,204,206,209,212,214,216,218,221,225,227,229,232,233,234,237,241,244,246,248,249,251,252,253,254,256,257,258,260,261,265,266,267,268,271,272,275,279,282,288,290,292,293,294,298,299,302,304,307,308,310,311,314,315,316,318,320,321,322,333,335,337,339,340,343,346,347,349,350,355,357,359,363,366,367,370,373,375,376,377,378,380,382,385,391,392,396,397,399,400,407,408,410,412,414,418,419,421,423,424,426,427,428,431,432,434,435,436,437,438,440,444,445,447,448,451,452,453,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],start_cal:387,start_color:[97,178],start_compon:[282,472],start_dir:[385,472],start_docu:409,start_el:[316,409],start_method:167,start_new_sess:[350,472],start_new_thread:117,start_offset:269,start_respons:[404,466,472],start_serv:[127,129,135,137,171,366,471,472],start_thread:[363,472],start_tl:[129,132,471,472],start_unix_serv:[127,129,137],startboundarynotfounddefect:200,startcdatasectionhandl:316,startcom:343,startdoctypedeclhandl:316,startdocu:412,startdtd:460,started_at:136,startel:[412,413,456],startelementhandl:316,startelementn:[412,413],startf_useshowwindow:350,startf_usestdhandl:350,startfil:[293,472],starti:380,starting_nod:448,startnamespacedeclhandl:316,startprefixmap:412,starts_lin:190,startswith:[241,293,342,346,355,385,396,419,456,459,461,462,465,467,469,472],starttest:385,starttestrun:[385,463],starttl:[249,268,288,337,343,462,466,467,472],startup:[30,58,62,92,128,169,177,215,252,265,267,293,355,364,369,378,422,428,441,443,451,453,461,462,467,468,469,471,472],startup_fil:434,startupinfo:[350,460,471,472],startupinfoex:350,startx:380,stash:111,stasiak:[470,472],stat1:294,stat2:294,stat:[62,65,93,109,186,189,217,220,235,252,253,257,268,288,293,294,298,307,333,343,359,378,382,428,458,459,461,462,466,469,470,471,472],stat_float_tim:[459,461,467,471,472],stat_result:[293,459,469,472],statcach:461,state:[5,16,22,28,29,31,41,47,48,54,57,58,62,79,81,82,90,91,93,95,97,99,101,103,105,106,110,129,130,131,135,139,141,143,145,153,156,158,159,161,165,167,168,170,171,172,178,186,190,213,219,224,228,229,242,244,252,253,255,257,258,267,269,271,293,295,299,300,303,305,310,316,317,318,320,322,325,327,329,336,339,340,342,343,346,350,355,363,366,367,369,370,372,377,385,386,387,391,392,397,399,402,409,418,421,422,424,426,428,436,437,439,444,448,449,456,458,459,461,466,467,468,471,472],stateless:[62,143,146],statement:[22,31,36,43,45,49,53,57,60,62,78,79,86,91,92,93,94,95,99,104,111,113,117,119,124,129,139,140,145,151,153,160,165,167,169,172,177,185,186,187,190,193,202,214,219,225,227,235,243,248,249,251,252,253,256,257,262,269,271,279,282,284,288,291,292,293,295,297,299,308,314,317,321,329,337,339,340,342,343,346,350,354,355,359,360,361,362,363,368,370,375,380,382,385,386,387,398,402,407,408,409,419,425,426,427,428,429,431,433,434,435,436,439,441,442,443,444,445,446,451,455,456,457,458,459,460,463,464,465,466,467,468,469,470,472,473],stateorprovincenam:343,statespec:373,static_method:[386,387],staticmethod:[53,91,93,98,118,193,227,228,267,417,424,446,458,460,463,466,467,472],statinfo:293,statist:[38,62,84,86,98,186,229,253,275,288,290,310,320,333,343,368,376,440,447,450,451,456,457,461,463,466,467,472],statisticdiff:[62,186],statisticserror:345,statu:[5,30,45,54,57,62,65,74,79,84,90,97,103,104,110,117,118,122,178,197,206,208,214,215,243,246,248,249,255,271,288,292,293,307,309,311,313,335,340,342,343,350,355,373,390,392,404,434,444,456,460,461,463,464,466,468,469,470,471,472],status:466,status_control_c_exit:472,statvf:[293,458,462,467,472],std66:391,std:[355,367,461],std_error_handl:350,std_input_handl:350,std_output_handl:350,std_time:184,stdatom:472,stdbuttonbox:372,stdcall:177,stderr:[22,30,54,58,62,65,66,78,79,91,103,104,129,132,135,138,140,153,158,170,193,215,229,231,246,248,257,266,267,268,284,292,293,313,323,334,342,346,350,355,359,363,368,377,385,396,397,404,424,446,447,448,451,455,456,460,462,463,464,466,468,469,470,471,472],stderr_data:[138,350,460],stderrprint:472,stdev:[320,345],stdev_service_tim:320,stdin:[30,54,60,82,84,85,91,93,99,122,129,132,135,138,153,157,158,164,177,187,193,209,212,215,216,219,231,248,249,257,258,261,284,293,298,299,323,329,332,343,346,350,355,359,362,363,375,384,392,404,417,424,426,428,432,436,437,438,439,442,445,446,447,448,451,457,458,459,460,462,463,464,467,468,469,470,471,472],stdin_read:311,stdint:472,stdio:[31,78,79,85,293,462],stdlib:[31,62,79,96,104,236,248,356,406,466,467,469,472],stdname:[184,310],stdoffset:184,stdout:[30,54,58,60,62,65,66,79,93,94,95,103,104,122,129,132,135,138,153,157,170,177,178,189,190,193,211,217,225,227,243,248,249,257,261,267,268,284,292,293,299,302,309,310,323,334,336,346,350,355,359,360,363,375,376,377,385,386,396,397,404,410,414,419,424,442,446,447,451,455,456,460,461,462,463,464,466,467,468,469,470,471,472],stdout_data:[138,350,460],stdout_fileno:293,stdoutcatch:85,stdprinter:472,stdscr:[97,178,462],stdsuit:462,stdtype:472,stdwin:456,stdxxx:472,steadi:456,steal:[22,30,31,34,41,49,55],steel:[90,472],steen:370,steer:[31,457,460,466],stefan:[422,463,467,468,469,470,471,472],steffen:466,stein:[90,456],stellenbosch:462,stem:[274,298,418,463],step:[1,51,57,62,64,65,66,75,78,83,90,92,95,99,105,106,107,108,110,111,113,122,124,143,145,149,153,157,159,161,167,170,177,186,187,193,227,232,237,243,248,252,260,266,282,284,291,292,293,299,320,321,340,342,346,361,373,380,387,396,411,418,423,424,426,427,432,437,441,443,452,456,457,458,459,460,461,462,463,464,465,466,467,468,469,472],stephan:472,stephen:[458,472],stereo:[119,143,295,351,398,446],stereocontrol:295,stereophon:295,sterl:178,steve:[343,457,462,469,470,471,472],steven:[457,461,463,466,468,469,470,472],stew:342,sticht:[30,63,422],stick:[69,97,109,269,284,363,373,380,458,459,462],sticki:[187,344,373],stiff:[79,437],still:[7,9,22,26,28,30,31,44,57,61,64,65,69,70,74,78,79,81,82,83,84,86,87,90,91,93,95,97,99,102,103,104,105,106,107,108,110,111,112,118,122,123,135,140,144,148,153,159,161,164,168,170,171,176,177,178,182,187,190,193,195,203,207,209,212,214,222,227,228,229,232,244,248,252,254,257,267,268,271,275,279,284,292,293,295,297,301,310,316,321,324,325,326,329,331,334,335,339,340,342,343,346,347,350,355,361,363,365,366,373,381,382,385,386,387,392,399,404,406,407,410,413,422,424,426,428,432,436,438,439,440,442,446,448,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],stinner:[463,465,466,467,468,469,470,471,472],stippl:178,stitch:208,stl:[307,468],stmt:[124,368,427,462,472],stmt_list:[423,433],stock:[111,342,461,466],stoke:[470,472],stolen:[9,18,27,31,78,472],stolk:458,stone:468,stop:[22,51,62,65,85,91,99,101,103,104,105,132,135,138,145,157,160,161,162,184,188,189,193,198,208,212,214,227,229,230,236,248,254,260,266,267,268,271,284,292,293,295,299,302,310,316,318,320,340,346,350,366,370,373,378,380,382,385,387,403,424,426,437,438,439,440,456,457,458,459,461,462,463,464,466,469,470,471,472],stop_aft:65,stop_ev:104,stop_her:145,stop_serv:472,stopal:[386,472],stopasynciter:[22,93,214,423,424,426,432,472],stopfram:145,stopiter:[22,57,62,81,93,99,114,161,214,227,260,274,284,342,346,386,423,424,426,432,436,446,458,459,461,462,470,471,472],stoplisten:[104,267],stoptest:385,stoptestrun:[385,463],stor:225,storag:[5,29,31,38,50,62,84,93,109,159,168,178,190,252,257,260,293,302,331,342,346,349,361,410,458,461,462,463,467,468,472],storbinari:[225,462,463],storchacha:468,storchaka:[109,467,468,469,470,471,472],store:[5,7,10,11,17,26,30,37,38,45,51,53,56,57,58,62,65,73,79,81,82,84,85,90,91,93,94,95,96,98,99,103,104,106,108,109,110,111,114,119,122,123,124,135,136,143,156,159,161,168,171,174,176,177,178,182,184,185,187,190,193,197,198,201,202,204,206,209,225,233,237,244,246,248,249,252,254,257,260,266,269,271,272,276,279,284,288,293,297,300,301,302,306,312,316,328,329,330,331,336,337,338,339,340,343,344,346,349,351,352,355,356,359,361,363,366,372,373,376,377,378,380,385,386,387,390,392,399,402,404,407,410,416,418,419,421,423,424,426,428,431,432,436,437,438,439,440,442,444,446,447,448,451,452,456,457,458,459,460,461,462,463,464,465,466,467,468,470,471,472],store_act:292,store_annot:[470,471,472],store_attr:190,store_const:[122,292],store_deref:[190,472],store_fals:[122,292],store_fast:190,store_glob:190,store_nam:[190,343],store_subscr:190,store_tru:[94,122,189,230,292,311,396,463,466],store_valu:292,storeroom:466,stori:[30,79,86,237,442],storlin:[225,462],storm:458,stormi:456,stp:101,str:[5,17,23,24,30,35,45,54,57,58,60,62,81,82,84,90,91,93,94,95,97,99,101,102,103,104,105,106,108,109,113,122,124,129,151,157,159,161,168,170,176,178,182,183,184,187,189,190,196,197,198,202,203,204,206,209,210,212,214,227,235,237,238,241,243,245,248,252,253,254,257,258,260,261,265,266,267,269,284,288,291,292,293,294,298,301,308,320,321,332,333,337,340,342,343,347,349,350,355,361,363,364,365,368,378,381,382,385,386,391,395,397,402,407,410,411,416,418,419,424,426,431,437,438,439,440,442,445,446,448,451,456,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],str_:472,straddl:184,straight:[149,203,207,227,284,355,370,385,399,408,456,464],straightforward:[22,31,64,79,90,91,92,104,109,110,159,161,168,177,258,267,292,329,336,339,386,387,436,445,458,459,462,466,467],strandmark:472,strang:[62,91,95,117,141,237,365,424,437,455,457,461,462],strangepair:382,strateg:101,strategi:[30,57,79,82,85,122,141,159,268,336,385,400,421,428,459,464,466,471,472],strchr:[96,177],strcmp:[10,17,81,85],strcoll:[108,228,265,466],strcpy:109,stream:[13,23,30,37,62,93,99,103,104,107,109,120,125,126,129,130,132,138,140,146,147,151,158,170,178,195,201,202,207,208,213,214,220,227,231,235,237,243,246,248,250,252,253,260,261,266,267,268,269,276,282,293,300,302,309,310,316,329,330,332,333,334,335,339,340,350,351,355,359,363,375,382,385,392,396,398,404,405,406,409,410,413,414,416,419,421,424,430,431,434,446,451,456,460,461,462,463,464,466,467,468,469,470,471,472],stream_or_str:409,stream_read:456,stream_writ:456,streamerror:359,streamhandl:[62,103,104,120,266,267,466,471,472],streamlin:[1,469],streamread:[13,62,127,129,138,146,460,461,469,470,472],streamreaderwrit:[62,146],streamrecod:[62,109,146,472],streamrequesthandl:[104,340,470,472],streamwrit:[13,62,127,129,138,146,461,471,472],street:[109,321],streetaddress:343,strength:228,strength_bit:343,strengthen:[210,472],strenum:212,strerror:[22,213,214,265,293,462,472],stretch:[236,248,373,380,407,471],stretch_len:380,stretch_wid:380,stretchfactor:380,strfry:461,strftime:[62,103,140,183,265,266,267,268,271,367,416,447,448,459,461,462,466,467,470,472],strict:[13,58,99,102,109,159,168,176,177,187,203,208,209,227,241,243,244,245,249,252,254,257,258,261,276,293,295,298,301,343,346,355,363,367,391,407,422,426,451,456,457,459,462,463,466,467,468,469,471,472],strict_domain:244,strict_error:159,strict_ns_domain:244,strict_ns_set_initial_dollar:244,strict_ns_set_path:244,strict_ns_unverifi:244,strict_pars:[153,391],strict_rfc2965_unverifi:244,stricter:[187,386,456,457,461,467,469,471,472],strictli:[57,79,104,107,108,109,111,123,135,182,184,187,212,219,245,261,274,346,392,424,425,426,428,431,436,461],stride:[2,57,62,346,424,426,459,467],strigl:472,string1:[265,342,438],string2:[265,342,438],string3:438,string:[7,8,9,10,13,15,21,22,23,24,25,26,28,29,30,31,35,36,37,38,41,43,45,48,54,57,59,60,62,65,66,68,69,70,74,78,79,81,82,85,86,93,94,95,96,97,99,102,103,104,105,107,108,110,111,113,114,119,122,123,124,125,129,130,135,138,143,144,145,146,147,151,152,153,154,155,157,158,159,160,161,165,168,170,173,174,176,177,178,179,182,183,184,185,187,189,190,193,196,197,198,201,202,203,204,205,206,207,208,209,210,211,213,214,215,221,222,223,225,227,228,230,231,232,233,234,235,236,238,239,243,244,245,246,248,249,250,251,252,253,254,255,257,261,262,265,266,267,268,271,272,274,276,279,282,283,284,286,287,288,289,291,293,294,295,297,298,299,300,301,302,304,305,306,307,308,309,310,311,312,313,314,315,316,320,322,323,328,331,332,333,335,336,337,338,339,340,341,342,343,344,351,352,353,354,355,356,357,359,360,361,362,363,364,365,366,367,368,370,372,373,374,375,376,377,378,380,382,384,385,386,387,390,391,392,394,395,396,397,398,400,402,404,405,406,407,408,409,410,411,412,413,414,416,417,419,420,421,422,423,424,425,426,427,428,430,432,433,436,438,439,440,441,443,444,446,448,451,455,457,458,461,463,465,466,468,469,472,473],string_at:[177,215,467],stringent:468,stringescapeseq:431,stringifi:[176,377,472],stringified_newdatatyp:81,stringio:[85,91,93,170,197,208,257,261,310,346,355,361,363,386,404,408,462,463,464,466,468,469],stringlib:466,stringliter:426,stringprefix:431,stringprep:[62,159,253,364,459],stringtranslatepseudomap:472,stringtyp:472,stringvar:[370,373],strip:[65,91,95,99,106,122,145,159,168,171,178,179,184,187,189,193,201,209,210,225,227,230,246,248,267,268,294,310,328,332,337,340,342,346,350,357,363,377,378,397,404,419,436,437,438,439,456,459,464,465,466,469,472],strip_blank:65,strip_com:65,strip_dir:[65,310],strip_python_strerr:363,stripped_it:99,stripped_lin:99,stripped_list:99,stripspac:178,strive:[440,463],strk1048_2002:159,strlen:[58,85,96,107,109],strncat:85,strncmp:17,stroke:[86,109,458],strong:[84,111,171,184,241,328,343,399,421,457,462,467,470,472],stronger:[387,472],strongest:[92,174,463],strongli:[79,103,212,227,345,355,370,412,424,457,458,461],strop:456,stropt:[470,472],strptime:[62,183,266,343,367,416,458,459,461,466,472],strtobool:65,strtod:62,struck:97,struct:[7,14,15,20,28,41,52,53,57,60,62,79,81,82,84,90,92,93,95,96,104,123,143,146,177,216,227,253,267,268,339,346,355,363,367,416,436,448,458,461,462,463,466,471,472],struct_frozen:177,struct_tim:[93,184,249,271,367,470],structmemb:[81,82],structseq:[24,463],structsequ:466,structur:[2,3,5,11,12,15,16,18,19,21,25,27,28,29,30,31,38,39,41,43,46,47,50,54,56,60,62,64,77,79,81,82,84,85,91,92,93,95,96,97,99,103,106,111,120,124,126,145,155,159,178,195,197,202,204,205,206,207,208,213,216,218,222,224,225,232,234,237,241,246,248,249,253,254,255,257,260,261,271,276,282,284,293,294,297,301,307,309,312,313,321,334,339,341,343,346,348,349,350,363,367,372,380,381,385,386,393,399,407,410,411,415,416,419,420,424,428,429,435,441,446,447,448,456,457,458,459,460,461,462,463,466,467,468,469,470,471,472],structuredmessag:104,strxfrm:[93,108,265],sts:[79,90,350,460],sttype:297,stuart:339,stub:[84,157,257,382,386,472],student:[86,108,228,349,380,436,455,466],student_object:108,student_tupl:108,studi:[83,91,99,193,237,380,459,462],studio:[65,66,83,455,462,469,472],stuf:158,stuff:[57,65,81,85,95,170,177,193,309,386,464],stufft:[463,468],stumbl:[62,107,473],stupid:368,stutzbach:[462,463,466],stx:179,style1:463,style:[2,5,9,35,45,58,62,67,71,72,79,82,84,92,93,98,99,103,106,118,120,122,135,144,145,147,152,161,165,168,189,197,206,208,212,220,221,222,226,227,228,232,241,243,246,253,260,266,270,271,275,276,292,294,298,299,301,310,315,320,321,328,331,333,334,339,342,356,363,366,369,370,372,377,385,388,404,417,422,426,430,431,434,436,441,442,443,445,447,448,456,457,458,459,460,462,463,464,466,467,468,471,472,473],styleadapt:104,stylesheet:463,stype:209,sub:[29,41,62,66,69,71,74,75,95,99,103,104,106,120,124,127,135,176,177,178,179,184,189,195,197,202,206,208,215,233,249,252,253,260,267,271,279,291,294,310,316,320,321,331,346,363,372,385,387,402,410,438,445,446,447,455,456,458,462,463,465,466,467,468,469,470,471,472],sub_command:65,sub_dcmp:217,sub_kei:402,subcal:310,subcategori:109,subclass:[6,19,22,39,45,49,57,62,65,70,80,81,84,93,95,102,103,106,110,118,122,124,125,129,130,134,135,141,145,152,157,158,159,161,167,168,173,176,177,183,184,187,188,193,200,204,206,207,209,214,219,222,225,227,231,241,242,243,246,249,252,254,255,257,258,261,266,267,268,271,284,286,289,292,293,298,301,307,309,320,321,331,332,333,335,336,337,339,340,342,343,345,346,347,350,355,363,366,370,372,373,380,381,382,385,386,390,391,392,394,396,397,399,404,406,407,409,410,411,412,414,416,420,423,425,426,432,436,439,448,456,458,459,460,461,462,463,466,467,468,469,470,471,472],subclass_of:95,subclaus:99,subcommand:[65,67,95,122,449,463,466],subcompon:195,subcontext:161,subcontrari:345,subdir:[74,122,217,271,363],subdirectori:[65,69,74,75,77,79,82,90,91,111,164,201,217,233,252,271,293,298,304,335,376,385,396,418,419,420,446,455,456,457,459,462,463,469,471,472],subel:[410,466],subexpress:106,subfoo:69,subfunct:[310,467],subgener:[62,426,473],subgroup:[106,321,466],subinterpret:[142,363,472],subitem:446,subiter:[190,426,467],subject:[12,41,50,60,81,90,99,103,110,137,168,184,193,197,201,203,204,206,244,256,261,267,268,271,288,310,320,328,331,339,343,363,367,422,424,431,436,454,461,468,472],subjectaltnam:343,subkei:[402,455],sublayout:373,sublicens:422,sublist:[82,372,456,466],sublist_incr:82,sublist_init:82,sublist_method:82,sublistmodul:82,sublistobject:82,sublisttyp:82,submiss:[1,110,153,316,456],submit:[1,97,110,140,153,167,284,456,463,466,467,469,470,471,472],submitt:456,submock:386,submodul:[28,57,62,93,118,159,185,193,227,239,251,252,304,326,343,376,406,419,432,446,451,461,464,465,468,471,472],submodule_search_loc:[252,428],subn:[106,321,463,465,469,472],subnegoti:360,subnet:[258,467,469,472],subnet_of:[258,471,472],subnod:408,subnorm:[187,472],subobj:323,subobject:[82,91],suboffset:[2,57,62,346,467],subopt:360,suboptim:469,subordin:[402,463],subpackag:[28,57,77,93,252,282,355,385,397,419,428,446,456],subpackage1:428,subpackage2:428,subpad:178,subpars:[122,466,472],subparser1:122,subparser2:122,subparser_nam:122,subpart:[197,199,200,202,205,206,207,208],subpath:420,subpkg1:432,subpkg2:432,subpkg:[74,252],subproces:133,subprocess:[62,104,126,128,132,134,165,167,170,209,211,249,253,284,293,305,339,340,363,369,378,380,396,397,418,451,454,459,462,463,466,472,473],subprocess_exec:[62,129,132,133,134,138,472],subprocess_shel:[129,132,133,135,138],subprocesserror:[350,472],subprocessprotocol:[62,129],subprocessstreamprotocol:472,subprocesstransport:[129,135],subrang:346,subroutin:[65,78,93,99,461],subscrib:[86,104,249,382],subscript:[33,57,62,93,124,161,177,214,248,382,424,427,432,436,445,451,459,462,472],subscriptlist:427,subsect:[95,97,106,111,129,138,248,346,426,437,472],subsequ:[5,22,30,52,55,58,65,91,98,103,106,117,136,160,161,178,189,190,203,207,209,225,244,252,254,257,260,267,268,271,279,284,291,292,293,318,321,333,339,342,343,346,347,357,359,361,366,370,372,380,386,392,421,423,426,428,430,437,438,459,460,461,462,463,465,469,472],subsequent_ind:365,subsequenti:472,subset:[52,77,86,99,105,107,149,159,168,178,221,236,248,249,261,268,271,286,295,297,301,308,316,329,333,339,346,359,366,385,407,410,412,419,426,459,461,463,469,471,472],subshel:[233,293],subslic:320,subst_var:65,substanti:[79,244,274,316,383,407,422,458,460,465,466,467,468,470,472],substitut:[62,65,84,93,103,104,106,113,144,159,161,168,179,184,187,193,252,260,267,272,274,292,310,321,322,323,342,346,347,360,375,382,400,422,423,426,432,437,441,442,444,448,455,459,461,462,463,466,468,469,472,473],substr:[58,84,95,99,106,109,168,193,236,238,292,294,321,346,385,426,445,456,458,459,460,461,462,467,469,471,472],subsubdirectori:335,subsubitem:446,subsubsect:472,subsystem:[22,99,104,252,370,459,461,463,472],subtest:[62,188,468,472],subtl:[22,57,79,84,133,176,193,216,289,292,295,310,424,425,468,472],subtlest:456,subtleti:[106,184,244,423],subtli:[93,97,107,197,206,428],subtract:[43,143,161,184,187,258,269,275,291,310,346,380,416,426,456,459,462,463,466,471,472],subtre:[30,456],subtupl:22,subtyp:[8,9,10,14,19,21,24,34,35,41,45,50,55,56,57,58,197,198,201,202,204,205,206,207,248,276,289,292,334,343,346,382,413,424,426,458,472],subvers:[461,462,463,466,471,472],subview:346,subwidget:372,subwin:178,subwindow:178,succe:[5,7,10,13,16,17,36,43,44,45,49,91,106,141,193,210,227,288,293,297,298,318,333,338,339,343,363,385,386,387,392,402,407,451,458,459,472],succeed:[177,250,339,385,439,460,472],success:[5,7,9,10,11,13,16,17,21,22,23,28,30,31,34,36,41,43,44,45,49,50,51,53,54,55,56,58,60,65,79,81,82,85,86,91,93,95,97,99,103,106,110,129,135,137,140,141,149,160,161,177,178,210,216,222,225,243,246,249,251,260,265,279,284,293,295,298,301,302,307,316,321,337,338,339,342,343,349,350,355,368,372,373,385,392,407,424,437,439,456,459,460,463,466,468,470,472],successfulli:[30,60,77,80,83,95,101,106,107,117,129,134,140,164,167,168,170,193,229,249,251,252,284,288,292,293,333,339,343,346,350,366,385,404,428,432,449,460,466,469,470,472],successor:422,succinct:[98,447],succinctli:[260,436],suck:107,suddenli:92,sudo:[101,104],suexec:153,suffer:[93,385,386,440,457,458,459],suffic:[295,342,385,440],suffici:[42,57,74,79,85,101,102,103,117,124,141,159,184,185,187,193,222,227,275,293,314,328,343,346,366,385,387,400,412,428,432,438,455,466,467,470,471],suffix:[58,77,86,93,95,104,111,113,177,201,246,249,251,252,266,267,268,276,298,321,331,337,346,361,392,426,445,446,455,456,458,466,467,472],suffix_map:276,sugalski:461,sugar:[93,104,170,245,252,342,437,464],suggest:[1,62,65,80,84,86,90,91,99,104,106,109,117,135,187,227,232,236,252,301,309,322,366,367,370,418,443,450,455,456,457,458,459,460,461,462,463,465,466,468,470,472],suid:293,suit:[0,57,62,81,84,90,91,93,95,99,103,105,124,162,188,193,227,232,253,257,284,292,297,343,345,378,385,386,397,419,423,427,435,442,446,448,455,461,462,463,464,466,468,470,471,472],suitabl:[19,30,57,58,65,79,95,99,103,104,109,112,144,147,149,159,161,170,174,176,184,189,197,205,209,210,222,236,237,238,245,258,260,265,266,267,268,271,276,284,288,293,294,301,310,320,325,326,328,334,336,337,339,340,343,346,359,363,366,367,368,376,385,397,404,407,410,418,421,423,424,437,440,441,448,451,455,458,459,460,462,463,466,470,471,472],suite_mask:[355,463],suiteclass:[385,463],sum:[7,14,31,93,99,122,124,129,143,161,184,187,193,209,227,260,269,275,293,310,320,324,328,339,342,345,346,367,373,378,382,426,436,437,440,445,446,447,448,459,460,462,465,467,472],sum_list:31,sum_sequ:31,sum_two_numb:93,summar:[92,98,105,109,187,193,257,258,331,346,385,422,423,426,428,460,466],summari:[62,65,66,74,86,90,95,172,193,292,304,309,324,376,377,401,404,422,437,449,455,457,458,459,460,466,472,473],summarili:236,summarize_address_rang:[258,469,472],summaryinfo:472,summaryinform:[282,472],summat:[275,440],summer:[210,227,367,461,462],sun4u:[65,356],sun:[62,66,109,143,152,184,246,250,253,274,278,295,367,388,405,472],sunau:[62,253,278,472],sunaudiodev:[456,462],suncc:463,sundai:[152,184,265,268,367,463],sundaresan:472,sundri:459,sunken:370,suno:[30,305,359,472],sunos5:[30,355],sunpro:465,super_getattro:98,supercalifragilisticexpialidoci:[445,448],superclass:[157,182,227,261,267,314,340,382,424,458,459,461],supercop:422,superfici:91,superflu:[301,339,342,472],superimpos:343,superior:260,supernet:[258,469],supernet_of:[258,471],superscript:346,supersed:[30,54,62,253,288,295,456,463,467,471,472],superset:[103,308,346,426,456,459,472],superset_of:472,superstit:106,superus:293,supervis:461,supplant:[161,428],supplement:[204,214,229,293,462,468,472],supplementari:[110,339],suppli:[5,17,19,30,57,65,66,68,69,72,74,75,81,91,93,95,97,99,106,108,109,110,111,122,124,153,154,161,162,177,178,179,182,184,187,190,193,212,216,225,227,228,236,238,244,248,249,254,258,260,266,268,284,288,292,293,295,297,299,304,310,316,320,326,328,329,336,339,342,343,346,350,356,361,363,366,373,377,380,382,385,391,392,396,397,399,404,412,416,418,422,423,424,426,428,432,437,440,447,448,449,451,456,457,458,459,460,461,462,463,465,466,467,468,470,472],support:[5,7,11,15,21,22,23,29,31,32,33,34,36,39,43,44,45,49,52,53,54,56,57,59,61,62,64,65,66,68,70,74,75,77,79,80,84,85,86,87,90,91,92,93,94,95,96,97,98,101,102,103,104,106,108,110,111,112,113,117,118,119,121,122,123,124,126,129,131,132,134,135,137,138,140,141,143,144,147,148,149,155,156,159,161,162,164,165,172,174,176,177,178,181,183,184,185,187,188,189,190,192,193,195,196,197,202,203,204,205,208,209,211,213,214,215,216,218,221,222,223,224,225,226,227,228,229,230,231,233,234,236,238,242,243,244,245,246,247,249,252,253,254,256,257,258,259,260,261,263,265,266,267,268,269,271,272,273,274,275,276,282,284,285,288,290,291,292,293,294,295,297,298,299,300,301,304,305,306,307,309,313,316,317,318,321,322,323,324,329,330,331,333,334,335,336,337,339,340,342,344,345,346,347,349,350,351,355,356,360,361,362,366,367,370,373,375,377,378,380,381,384,385,388,391,392,394,395,396,397,398,399,400,402,403,404,405,406,407,408,412,413,416,417,418,419,420,421,422,423,424,426,428,430,431,432,435,436,438,439,440,443,444,445,446,447,448,449,451,453,454,455,457,458,460,461,463,464,465,466,467,472,473],support_team:267,supported_dist:305,supports_bytes_environ:[293,466],supports_dir_fd:[293,467],supports_effective_id:[293,467],supports_fd:[293,467],supports_follow_symlink:[293,333],supports_follows_symlink:467,supports_unicode_filenam:[294,459],supportsab:382,supportsbyt:382,supportscomplex:382,supportsfloat:382,supportsint:382,supportsround:382,suppos:[22,55,57,58,74,79,83,91,102,107,111,182,187,193,197,200,249,311,321,335,342,343,345,347,359,373,387,399,446,461,462,463,466,471,472],supposedli:[390,472],suppress:[21,30,36,44,45,62,95,97,103,111,122,130,140,154,158,164,170,193,229,288,292,317,335,337,346,350,355,363,404,423,424,432,434,437,448,455,457,459,461,462,463,464,465,468,469,472,473],suppress_help:292,suppress_ragged_eof:343,suppress_usag:292,suppresscrashreport:363,sure:[1,13,15,22,41,47,58,62,72,74,78,81,82,84,85,90,91,92,95,97,99,103,104,106,111,122,153,157,159,168,177,187,214,227,229,236,252,265,284,292,293,298,330,342,343,351,363,366,392,394,397,398,410,418,424,427,436,445,447,450,453,458,459,461,462,464,466,467,472],surfac:94,surface_grav:212,surpris:[62,84,90,91,95,104,107,120,184,187,193,227,237,248,266,275,284,310,370,426,428,436,440,457,458,461,465,469,471],surprisingli:90,surrog:[54,58,159,261,348,359,407,467,468,472],surrogateescap:[54,58,109,159,202,209,219,227,293,339,355,359,451,466,469,470,471,472],surrogatepass:[159,451,468,470,472],surround:[38,85,99,106,145,168,176,189,227,245,248,265,347,350,371,396,423,425,431,438,446,448,456,461,462,463,464,465,470],surviv:[117,177,229,399],survivor:463,susan:466,suscept:[333,455,472],suse:[66,72,111,305,472],susp:178,suspect:[35,153,456],suspend:[93,99,128,140,178,254,316,334,362,366,367,423,424,426,458,459,461,469,471,472],suspens:[367,424,426],suspici:472,sussman:99,susumu:472,suzi:459,suzuki:459,sv1:110,svensson:460,svetlov:[468,471],svg:461,svn:[75,122,164,356,391,459,461,462,463,466,472],svneol:472,svr4:216,sw_hide:350,sw_showdefault:350,swallow:[103,104,448,456,463,466,472],swamp:104,swap:[30,78,107,159,161,177,190,284,324,339,349,363,424,432,447,471,472],swap_attr:[363,472],swap_item:[363,472],swapcas:[346,472],swart:468,swati:472,swear:97,sweep:[229,461],sweet32:472,sweet:106,sweigart:472,swiegart:470,swig:[65,68,74,80,85,92,455],swig_opt:74,swinstal:[66,72],switchabl:349,switchboard:107,switcher:472,switching_protocol:242,switzerland:410,swordfish:106,syllabl:109,sym:65,sym_nam:353,symbol:[52,60,62,65,74,77,79,83,91,92,97,109,111,120,124,158,160,177,178,187,190,193,212,227,253,263,265,268,291,293,294,297,298,302,305,321,324,333,334,339,342,344,346,355,358,359,360,362,363,373,380,384,402,407,412,418,424,427,430,432,437,443,446,455,456,458,460,461,463,465,466,470,472],symbolt:354,symlink:[41,65,75,233,292,293,298,313,333,396,446,453,460,462,466,467,468,472],symlink_to:298,symmetr:[236,320,343,346,424,426,438,456,458,459,460,467],symmetri:[350,456],symmetric_differ:[346,459],symmetric_difference_upd:[346,459],symtabl:[62,253,263,463],symtyp:359,syn:179,sync:[178,185,212,284,293,295,331,467,472],sync_comp_for:427,syncdown:178,synch:189,synchron:[62,117,126,165,170,179,183,185,187,213,252,253,257,279,293,331,334,340,366,395,424,448,462,466,469,471,472],synchronis:[346,467],syncmanag:[284,472],syncok:178,syncup:178,synonym:[93,97,104,109,117,178,227,292,301,321,344,351,370,382,398,407,431,462,472],synopsi:[129,315,343,472],syntact:[84,91,93,170,203,241,252,256,286,297,316,342,346,386,391,397,411,423,426,430,431,432,436,437,439,460,461,464],syntax:[5,7,62,65,68,69,79,84,85,86,91,93,95,99,102,103,104,106,109,110,113,120,126,129,140,153,158,160,168,169,177,182,187,190,193,204,212,214,227,232,240,248,253,254,261,263,265,267,273,284,291,292,295,297,299,316,332,336,342,346,355,363,364,373,377,378,382,385,391,392,393,414,416,423,424,426,428,429,430,431,432,433,438,440,441,442,444,445,446,447,448,450,451,454,456,457,458,459,460,461,463,465,466,468,471,472,473],syntax_err:407,syntaxerr:407,syntaxerror:[22,60,85,106,158,160,169,193,214,227,248,297,363,375,377,423,425,426,431,432,438,439,442,445,446,456,457,458,466,468,469,470,471,472],syntaxwarn:[22,214,363,397,446,459,470,472],synthes:[99,193],synthet:385,sys:[22,28,30,31,41,54,58,60,62,65,66,72,74,79,84,85,86,91,93,95,103,104,105,109,111,113,114,117,120,129,135,137,138,140,142,145,153,154,157,158,164,170,176,177,178,189,190,193,201,211,214,215,216,217,219,225,227,229,230,231,232,246,248,251,252,253,254,257,260,261,264,266,267,268,280,284,292,293,295,299,301,302,304,305,309,310,311,313,314,315,317,323,326,329,332,333,334,335,339,340,342,344,346,349,350,356,357,359,360,362,363,366,368,376,377,378,381,385,386,387,392,396,397,399,404,410,414,417,418,419,420,423,424,426,428,433,434,439,442,444,446,447,448,449,451,455,456,457,458,459,460,461,462,463,464,465,466,472,473],sys_exc:113,sys_vers:246,syscal:[129,130,214,293,324,469,470,472],sysconf:[293,339],sysconf_nam:293,sysconfig:[62,71,74,78,253,293,317,378,418,468,472],sysctl:324,syslog:[62,103,104,253,268,388,463,467],syslog_udp_port:[267,268],sysloghandl:[62,103,120,267,357,463,467,472],sysmacro:472,sysmodul:462,sysnam:[293,305],sysproto_control:339,sysroot:472,system32:455,system:[7,15,22,23,29,30,31,38,57,59,62,64,66,68,70,71,72,74,75,77,79,80,83,84,86,87,89,90,91,92,93,96,97,99,101,103,104,105,106,109,110,111,117,123,129,135,138,141,145,152,156,157,165,168,170,174,175,176,177,178,184,187,188,192,208,209,210,211,212,214,215,220,221,225,227,230,231,232,243,246,248,249,251,252,253,255,256,257,265,266,267,268,269,271,272,276,278,279,283,284,286,287,294,295,296,298,301,303,304,305,307,310,311,312,313,316,317,318,320,324,326,328,329,333,334,335,337,339,340,342,343,344,346,349,356,357,359,361,362,363,366,367,370,372,378,380,385,386,387,388,392,396,400,402,403,404,407,410,411,412,413,416,417,418,419,422,424,429,431,432,433,434,435,439,440,441,442,444,446,448,449,451,453,454,455,456,458,459,460,461,462,463,464,465,466,471,472,473],system_alia:305,system_dir:168,system_id:413,system_must_validate_cert:363,system_sit:396,system_site_packag:396,systemasterisk:403,systemat:193,systemconfigur:472,systemdefault:403,systemerror:[5,22,25,41,45,50,55,58,214,297,446,470,472],systemev:462,systemexclam:403,systemexit:[22,60,65,103,117,142,158,169,214,248,355,403,425,446,461,462,464,470,472],systemhand:403,systemid:[316,407,412],systemquest:403,systemrandom:[293,320,328],systemroot:350,systemtap:[62,100,472],sysv:[90,456,457],szakmeist:472,szmek:[467,472],szulik:469,t01234:346,t0123:346,t012:346,t11:380,t12:380,t21:380,t22:380,t_bool:53,t_byte:53,t_char:53,t_co:382,t_contra:382,t_doubl:53,t_float:53,t_fmt:265,t_fmt_ampm:265,t_int:[53,82],t_long:53,t_longlong:53,t_object:53,t_object_ex:[53,82],t_pyssizet:53,t_short:53,t_string:53,t_string_inplac:463,t_ubyt:53,t_uint:53,t_ulong:53,t_ulonglong:53,t_ushort:53,tab:[5,60,62,83,147,157,176,178,179,189,193,199,203,214,222,243,248,254,261,299,319,321,322,325,332,335,346,347,350,365,369,372,400,416,431,437,441,445,451,456,461,463,467,468,470,471,472],tab_id:373,tabbedpag:472,tabbedpageset:472,taberror:[22,92,214,431,446,456],tabifi:248,tabl:[5,7,28,30,31,41,53,58,62,65,74,80,81,83,84,86,95,99,103,105,106,109,110,149,152,159,177,178,187,189,196,204,213,227,236,248,251,252,253,256,257,260,261,263,265,266,276,284,291,298,300,321,329,340,342,343,346,348,349,355,359,367,370,385,400,401,402,406,407,419,422,426,431,437,442,443,446,448,458,459,460,461,462,463,465,466,467,468,472],tablea:348,tableb:348,tablec:348,tabnanni:[62,92,253,263,456],tabpag:472,tabsiz:[189,346,365],tabul:[260,346,408],tabular:[62,176,369],tac:438,tack:[103,418],tackl:[301,456],tad:5,taddei:[470,472],tadek:463,tag1:456,tag:[28,56,57,62,65,81,101,106,153,189,222,241,249,251,252,268,279,301,316,348,355,357,369,370,392,407,410,414,416,446,456,461,463,468,469,472,473],tag_bind:373,tag_configur:373,tag_ha:[373,472],tagbanwa:109,tagnam:[279,373,407,408,409],tai:466,taifersar:[463,466,472],tail:[58,153,161,189,260,294,335,410,461,467,470,472],tailor:[78,95,247,346,363],tajik:[159,469],takayuki:472,take:[0,1,5,9,22,30,31,45,53,55,57,58,60,62,64,65,68,69,70,72,74,75,77,79,81,82,84,85,90,91,93,95,97,98,99,103,104,105,106,107,108,109,112,122,124,125,128,129,140,141,143,145,152,153,154,159,161,168,170,176,177,178,179,187,188,189,190,193,195,199,202,203,204,207,208,209,210,216,219,223,225,227,229,232,236,244,245,246,248,250,252,257,260,261,265,266,267,269,271,275,276,284,288,292,293,297,298,301,302,309,310,320,321,326,327,329,331,332,333,334,336,337,339,340,342,343,345,346,347,349,350,355,359,361,362,365,368,370,372,373,378,380,381,382,385,386,387,391,392,396,397,404,405,407,408,409,410,412,414,416,418,419,421,424,426,428,432,435,437,440,442,444,445,446,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,471,472,473],take_act:292,take_snapshot:378,takefocu:[87,373],taken:[1,5,41,50,57,60,66,72,79,81,99,104,122,141,143,145,161,164,168,184,187,190,193,197,203,206,207,212,217,222,227,229,232,249,265,267,276,279,284,293,294,298,305,310,313,316,324,328,332,336,343,345,346,349,355,359,363,365,366,368,370,377,378,383,394,397,423,424,428,432,436,446,456,458,459,461,466,467,468,472],takeuchi:472,takewhil:[99,260],takuji:422,tal:[469,470,471,472],talbot:466,talent:97,talin:462,talk:[58,86,91,97,107,109,343,350,424,436,437,453,461,469],talli:[161,463,466,467],talo:472,tamil:109,tamper:236,tan:[156,275,472],tangent:[156,275,380],tangerin:438,tanh:[156,275],tape:[237,359],tapset:62,tar:[62,65,66,72,75,86,111,121,253,276,292,298,333,396,449,456,459,460,461,462,463,466,472],tara:468,tarbal:[65,66,72,75,456],tarek:[69,333,356,462,463,466,469,472],tarerror:359,tarfil:[62,121,253,333,447,459,460,461,462,463,470,471,472],target:[7,30,31,58,62,65,66,68,74,87,90,101,103,104,105,111,124,129,135,161,170,172,184,187,190,243,252,254,267,268,284,291,292,293,297,298,316,318,321,333,334,339,340,342,354,359,361,363,366,370,386,396,404,407,410,412,416,418,419,423,424,425,426,428,432,437,451,455,459,461,462,464,466,467,468,471,472],target_desc:65,target_handl:104,target_is_directori:[293,298,467],target_lang:65,target_list:[423,426,432],targetdir:[455,472],tarinfo:[62,121,463,466],tashrif:472,task1:[140,448],task2:[140,448],task3:448,task4:448,task:[31,59,62,64,72,79,91,93,94,99,103,106,109,111,112,117,126,128,130,131,132,136,137,139,141,149,165,166,168,170,171,202,208,237,248,251,253,258,268,271,284,293,298,301,310,318,340,350,355,366,391,417,435,440,445,447,448,450,456,458,462,463,465,466,469,470,471,472],task_don:[136,284,318,461,469,472],task_queu:284,taskaya:472,tasks1:284,tasks2:284,tast:91,tau:[156,275,470,472],taught:[248,345],tautolog:472,tavar:468,tax:[86,91,321,445,448,459],taxonomi:385,taylor:[187,462,472],tb_frame:[254,381,424],tb_lasti:[254,381,424],tb_lineno:[254,377,381,424],tb_local:385,tb_next:[254,377,381,424,471,472],tbreak:299,tbs:472,tbutton:373,tcdrain:362,tcflow:362,tcflush:362,tcgetattr:362,tcgetpgrp:293,tciflush:362,tcioff:362,tcioflush:362,tcion:362,tck:463,tcl83:77,tcl8:463,tcl:[62,87,248,253,369,372,373,448,453,455,456,459,462,463,466,469,470,472],tcl_librari:87,tcl_obj:[459,472],tclerror:472,tclsam_init:87,tcltk:466,tcoflush:362,tcombobox:373,tcooff:362,tcoon:362,tcp:[62,86,90,103,104,107,127,129,132,268,284,337,339,340,343,363,462,463,470,471,472],tcp_:339,tcp_congest:[339,470,471,472],tcp_echo_cli:137,tcp_fastopen:[339,472],tcp_keepcnt:[339,472],tcp_keepidl:[339,472],tcp_keepintvl:[339,472],tcp_nodelai:[107,129,463,470,471,472],tcp_notsent_lowat:[339,471,472],tcp_user_timeout:[339,470,471,472],tcpclient:340,tcpserver:[62,104,246,255,266,417,463,472],tcsadrain:362,tcsaflush:[362,379],tcsanow:362,tcsendbreak:362,tcsetattr:[362,379],tcsetpgrp:293,tcsh:[396,460],tda:343,tdemo_nim:380,tdemo_round_d:380,tea:447,teach:[86,232,458],team:[64,86,422,455,456,457,458,463,466,468,472],teamus:382,tear:[193,385],teardown:[193,363,385,386,387,463,472],teardownclass:[62,188,463],teardownmodul:[62,188,463],tearoff:472,tebeka:[463,466],tech:472,technet:455,technic:[86,93,99,110,113,168,184,214,227,261,292,321,346,397,428,453,456,463,471],techniqu:[31,62,84,91,93,99,104,108,109,141,153,161,193,202,228,293,310,321,362,372,386,387,428,437,441,442,448,466],technolog:[86,90,97,107,255,422],techtonik:463,ted:310,tediou:[66,68,74,109,111,124,153,386,435,456,461],tee:[99,178,260,460],teichmann:[470,472],tel:438,telco:467,telenovela:466,telephon:321,teleprint:179,telescop:449,teletyp:222,tell:[5,28,30,62,65,69,74,79,81,84,86,91,94,95,97,99,104,105,106,107,111,113,119,122,129,136,141,153,155,160,193,209,224,225,236,257,266,268,279,284,292,295,301,318,333,334,339,340,343,346,351,370,376,386,392,398,404,419,436,442,456,458,459,460,462,469,470,471,472],tellabl:472,telnet:[62,171,253,255,391,462,470,472],telnetlib:[62,253,255,462,472],telopt_:360,temp0:177,temp1:177,temp:[68,77,79,104,111,122,284,331,342,361,408,418,455,472],temp_cwd:363,temp_dir:363,temp_umask:363,tempcwd:363,tempdir:[361,399,472],temperatur:466,tempfil:[62,110,201,220,227,253,284,293,363,392,399,462,464,472],templ:472,templat:[62,65,67,74,75,79,91,93,95,103,104,161,202,266,321,346,364,368,380,388,441,442,458,460,462,463,466,467,470,471,472],tempnam:464,tempo:106,temporari:[7,21,36,45,47,50,62,65,66,68,93,104,110,111,113,145,177,193,220,225,248,252,253,257,260,265,271,272,284,293,299,326,328,342,346,355,363,385,392,399,423,431,458,460,462,466,467,468,472],temporarili:[22,31,62,66,79,93,95,104,110,111,152,170,187,193,229,232,265,266,317,318,346,350,363,368,373,385,386,387,423,455,462,470,471,472],temporary_redirect:242,temporarydirectori:[361,466,472],temporaryfil:[361,472],tempt:[31,82,104,105,106,368,438,447],temptat:[106,385,457],ten:[1,86,104,161,178,187,310,320,328,459],ten_year:184,tend:[31,84,91,151,189,228,307,310,345,436,465],tenfold:460,teninteg:177,tenpointsarraytyp:177,tenth:[97,143,178,210],tenuous:141,teo:472,tep:299,teredo:258,term:[31,62,66,72,79,86,93,94,95,98,99,105,111,118,125,140,178,187,210,214,223,236,244,252,256,257,261,266,274,289,292,301,310,347,351,363,367,381,396,398,399,404,411,427,428,436,446,460,462,463,465,467,468,470,472],termattr:178,termin:[5,7,9,15,28,30,33,41,55,57,58,60,62,65,72,74,79,90,91,92,97,99,103,104,109,111,117,120,122,125,132,134,135,138,140,141,142,157,167,176,177,179,189,190,193,208,209,215,220,227,231,243,246,248,253,254,257,260,264,265,268,271,284,286,288,292,297,299,304,310,321,324,336,337,340,342,343,346,347,350,355,362,366,367,374,388,392,397,402,404,408,410,412,422,423,425,428,431,432,436,437,441,451,453,455,456,460,461,462,464,466,467,469,471,472],terminal_s:[293,333],terminalcommand:462,terminateprocess:[135,138,284,293,350,462,463],terminfo:178,terminolog:[62,71,95,102,202,274,352,367,373,407,436,457,458,461,462],termio:[62,216,253,379,388,472],termnam:178,ternari:[57,424,426],ternaryfunc:[57,81],terrenc:466,terri:[109,438,469,470,471,472],terribl:[106,237],terron:472,ters:[90,305,429,450,455],test1:[347,423],test2:[299,347,423],test:[5,22,31,42,56,57,62,65,72,74,75,79,84,85,91,93,94,95,97,101,102,103,104,106,108,109,110,111,118,122,124,128,131,156,157,159,161,162,167,171,177,178,179,182,187,188,195,201,212,214,221,227,228,230,237,241,246,248,249,250,251,252,253,254,255,258,261,263,265,268,272,275,284,291,293,297,299,307,311,317,320,321,337,342,344,355,359,365,366,368,372,373,378,386,392,399,404,410,416,419,422,423,424,427,430,435,436,437,438,442,445,446,447,448,455,456,457,458,459,460,461,462,463,464,465,466,467,468,470,471],test_:[363,419,472],test__all__:363,test_anagram:466,test_api:472,test_argpars:472,test_ast:472,test_asyncio:472,test_asyncor:472,test_autocomplet:472,test_averag:447,test_bdb:472,test_both:472,test_brows:472,test_bufio:459,test_byt:470,test_c_api:31,test_capi:472,test_cas:[363,385],test_chown:472,test_chown_gid:472,test_class:385,test_cmath:472,test_cmd_lin:472,test_cod:472,test_code_modul:472,test_codec:472,test_collect:472,test_compileal:472,test_config:472,test_configdialog:472,test_count:[193,363],test_ctyp:472,test_curs:472,test_data_dir:363,test_datetim:472,test_dbm_gnu:472,test_default_widget_s:385,test_deleg:472,test_division_by_zero:465,test_doctest:193,test_eintr:472,test_email:472,test_emb:472,test_enum:212,test_epol:62,test_ev:472,test_even:[385,468],test_fail:385,test_faulthandl:472,test_feature_on:363,test_feature_two:363,test_file_button:472,test_find:193,test_font_set:472,test_foo:[385,387,471],test_format:385,test_func:363,test_funct:386,test_functool:472,test_future4:472,test_gdb:472,test_gener:[99,458,459],test_get_event_loop_new_process:472,test_getallocatedblock:472,test_gimzo_without_required_librari:465,test_gizmo_on_window:465,test_hashlib:472,test_help:472,test_help_about:472,test_hex:470,test_home_dir:363,test_http_url:[363,472],test_httpserv:472,test_idl:472,test_imap4_host_default_valu:472,test_imaplib:472,test_import:472,test_importlib:472,test_indent_scal:472,test_inst:363,test_io:472,test_isupp:385,test_json:472,test_locale_flag:472,test_localtime_daylight_false_dst_tru:472,test_localtime_daylight_true_dst_tru:472,test_log:472,test_macholib:472,test_main:[363,472],test_math:472,test_maybe_skip:385,test_method:385,test_min_max_vers:472,test_modul:[385,387],test_module1:385,test_module2:385,test_monoton:472,test_multiprocessing_fork:472,test_multiprocessing_main_handl:472,test_mutiprocess:472,test_namespace_pkg:472,test_nocond:427,test_not_run:385,test_noth:385,test_o:472,test_on:[385,387],test_ordered_dict:472,test_pass_by_valu:472,test_pathlib:298,test_pdb:472,test_pickletool:378,test_pkg:472,test_pkgutil:472,test_posix:472,test_posix_falloc:472,test_pre_initialization_sys_opt:472,test_prefix:[62,188],test_pyexpat:472,test_python_:472,test_r:472,test_runn:378,test_sha256:472,test_shutil:472,test_si:472,test_signal_handl:385,test_sit:472,test_smtplib:472,test_socket:472,test_someth:[385,386,387,471],test_spam:363,test_split:385,test_ssl:472,test_start_tls_server_1:472,test_startup_import:472,test_str:472,test_strptim:472,test_subprocess:472,test_support:[462,464],test_support_dir:363,test_tarfil:472,test_tcl:472,test_thre:385,test_thread:472,test_tim:472,test_timestamp_overflow:472,test_tool:472,test_ttk_guionli:472,test_two:[385,387],test_undecodable_env:472,test_undecodable_fil:472,test_unittest:472,test_unpars:472,test_upp:385,test_urllib2net:472,test_utf8_mod:472,test_util:472,test_venv:472,test_widget:385,test_widget_res:385,test_windows_support:385,test_wsgiref:472,test_xmlrpc:472,test_zipfil:472,test_zipfile64:472,testabl:387,testal:[419,462],testcas:[193,363,385,386,387,447,463,465,466,467,468,472],testcase1:385,testcase2:385,testcase3:385,testcaseclass:385,testclass:385,testcomplet:85,testcongest:472,testdidnotrun:472,testdir:472,testenviron:472,testfail:363,testfil:[193,461,472],testfn:363,testfn_encod:363,testfn_nonascii:363,testfn_undecod:363,testfn_unencod:363,testfn_unicod:363,testfunc:385,testfuncacceptssequencesmixin:363,testgizmo:465,testhandl:363,testlist:427,testlist_comp:427,testlist_star_expr:427,testload:[363,385,386,463,469,472],testmethod:378,testmethodprefix:385,testmod:[193,363,447,460,465],testnamepattern:385,testprogram:385,testpypi:343,testresult:[193,385,463,465,467],testrunn:[193,385],testsometh:385,testsourc:193,testsrun:385,teststatisticalfunct:447,teststringmethod:385,testsuit:[193,363,385,459,468,469,472],testzip:419,tetxtwrap:472,tex:106,text1:189,text2:189,text:[5,49,54,58,62,65,66,74,78,81,84,86,90,91,93,94,95,96,99,103,104,106,107,109,110,120,122,124,146,147,151,152,153,154,157,158,160,168,169,174,176,177,179,188,189,190,195,196,197,198,199,201,202,203,204,205,206,207,208,213,214,219,220,225,227,228,232,235,237,239,240,241,243,246,249,251,252,253,254,261,265,266,267,268,269,271,273,282,283,286,288,292,293,297,298,301,307,309,310,315,316,319,320,322,325,328,332,334,342,343,347,348,350,355,359,361,363,368,369,370,372,373,374,377,380,382,384,385,391,392,395,396,397,400,404,406,408,409,410,412,413,419,422,424,425,426,428,430,431,435,442,445,446,447,448,451,455,456,457,458,459,460,461,462,463,465,466,467,468,469,470,471,472],text_factori:342,text_fil:71,text_nod:[407,408],text_or_uri:410,text_textview:472,textbook:[99,106,237,321,461,462],textbox:[62,97,120,462,472],textcalendar:[152,472],textdomain:[232,265],textfil:[71,148,201],textinput:380,textio:[252,382],textiobas:[85,227,243,257,370,424,462,463,464],textiowrapp:[122,151,227,235,257,269,350,419,462,467,468,470,471,472],textmat:[453,468],textnod:461,textpad:[62,97,120,253,462,472],textread:301,texttestresult:385,texttestrunn:[385,472],textual:[81,82,91,96,105,109,122,177,202,266,286,288,316,321,346,359,373,385,407,408,422,426,432,436,458,470,472],textvari:[370,373],textview:472,textwrangl:453,textwrap:[62,122,253,364,448,459,462,472],textwrapp:[365,459,468,472],tfpdef:427,tgot:284,tgtkei:260,tgz:[276,454],thai:[109,159,422],than:[1,5,14,17,21,22,23,27,28,30,31,34,35,37,38,41,50,51,52,53,56,57,58,62,65,66,69,74,78,79,80,81,82,84,86,87,89,90,91,92,93,94,95,96,97,99,100,103,105,106,107,108,109,110,111,112,114,117,119,122,123,124,128,129,131,135,136,138,139,140,141,142,145,147,149,151,153,156,159,161,164,167,168,170,171,176,177,178,182,184,187,189,190,192,193,196,197,198,199,200,202,204,206,208,209,210,211,214,216,219,220,222,227,228,229,231,232,235,236,237,241,243,244,248,249,251,252,254,257,258,260,261,266,267,268,269,271,274,275,276,279,284,286,288,291,292,293,294,295,296,297,298,299,301,302,304,305,308,309,310,314,315,316,318,320,321,324,326,327,331,332,333,334,335,337,339,340,342,343,344,345,346,347,349,350,354,355,359,360,361,363,365,366,367,368,370,371,372,373,377,378,380,382,385,386,387,390,391,392,396,397,399,402,404,406,407,408,410,412,416,419,421,423,424,426,428,430,431,432,435,436,437,438,439,440,442,444,445,446,448,450,451,455,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],thank:[0,83,99,105,106,109,157,201,236,284,363,422,456,457,458,459,460,461,462,463,466,467,470,471,472],thankfulli:386,thatiparthi:471,the_answ:436,the_except:385,the_list:84,the_pag:110,the_world_is_flat:444,thei:[2,5,7,8,17,20,22,26,27,30,31,38,41,44,47,49,50,52,53,54,57,58,60,64,65,66,69,70,72,74,75,77,79,80,81,82,84,86,90,91,92,93,94,95,96,97,98,99,101,102,103,104,105,106,107,108,109,110,111,112,113,114,117,120,122,124,128,129,131,135,136,139,140,141,142,143,145,148,152,153,155,156,157,159,161,162,167,168,169,170,171,172,175,176,177,178,179,180,182,184,185,187,189,190,191,193,195,196,197,198,199,203,206,208,209,210,212,214,216,217,225,227,228,229,230,232,233,234,236,237,241,244,248,249,251,252,254,255,257,258,260,261,266,267,268,269,271,275,276,278,282,283,284,288,291,292,293,294,295,298,301,304,306,307,309,310,311,314,316,318,320,321,324,327,328,329,330,331,332,333,334,335,337,338,339,340,342,343,344,346,347,348,349,350,351,352,355,359,360,361,363,365,366,367,368,370,372,373,375,376,377,380,382,384,385,386,387,390,391,392,396,397,399,402,404,405,406,407,408,410,411,412,413,414,416,418,419,423,424,425,426,428,430,431,432,436,437,438,439,440,442,445,446,447,448,451,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472,473],theiter:342,theller:461,thello:365,them:[1,5,7,14,15,21,23,30,31,41,53,54,57,58,60,62,65,66,69,70,72,74,75,77,79,82,83,84,86,87,89,90,91,92,93,94,95,97,99,101,102,103,106,107,109,110,111,112,113,122,123,124,128,129,136,141,149,153,157,159,160,161,162,164,167,168,169,170,171,176,177,178,184,185,187,190,192,193,196,197,202,207,209,212,215,217,227,228,229,232,233,236,237,241,244,245,248,249,252,254,256,257,265,266,267,268,271,284,288,289,291,292,293,295,297,298,301,305,309,310,319,320,321,324,326,329,331,336,337,339,342,343,344,345,346,348,349,350,351,355,360,363,365,366,368,370,372,373,378,380,382,383,385,386,387,392,397,398,402,406,407,408,409,410,418,419,423,424,426,428,430,432,438,439,440,442,445,446,447,448,450,451,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],theme:[62,248,253,369,459,462,465,470,471,472],theme_cr:373,theme_nam:373,theme_set:373,theme_us:373,themechang:[373,472],themenam:373,themonth:152,themselv:[30,57,73,74,79,81,84,92,93,95,102,103,106,112,143,153,156,159,168,172,176,177,195,209,232,260,261,274,275,284,299,301,321,333,346,363,365,382,385,386,387,408,416,424,426,428,436,438,458,461,462,463,466,468,469,471,472],theorem:346,theoret:[62,95,99,187,238,290],theori:[31,62,90,183,320,321,422,468,469],thereaft:[248,265,392,444],therebi:[79,91,198,204,380,455,468,472],therefor:[5,22,30,31,38,44,45,57,58,72,74,79,81,82,84,90,91,93,94,95,97,99,103,105,106,109,118,122,139,140,147,153,159,174,177,184,209,215,216,225,227,229,244,257,261,265,274,282,284,293,294,301,315,321,331,334,339,343,346,355,366,372,386,397,411,418,419,421,423,424,426,430,431,436,439,440,445,446,454,455,456,457,458,459,460,461,462,463,465,467,470,471,472],therein:[274,301],thereof:[95,141,207,227,268,293,363,366,422,425,439],theth:321,theun:[471,472],theyear:152,thi:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,21,22,23,24,25,26,27,28,29,30,31,32,34,35,36,37,38,39,40,41,42,43,44,45,46,47,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,74,75,77,78,79,80,81,82,83,84,85,86,87,89,90,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,116,117,118,119,120,121,122,123,124,125,127,128,129,130,131,132,134,135,136,137,138,139,140,141,142,143,144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159,160,161,162,164,165,166,167,168,169,170,171,172,174,175,176,177,178,179,180,181,182,183,184,185,187,188,189,190,192,193,194,195,196,197,198,199,200,201,202,203,204,205,206,207,208,209,210,211,212,213,214,215,216,217,218,219,220,221,222,223,224,225,226,227,228,229,230,231,232,233,234,235,236,237,238,239,240,241,243,244,245,246,247,248,249,250,251,252,253,254,255,256,257,258,259,260,261,262,264,265,266,267,268,269,270,271,272,273,274,275,276,277,278,279,280,281,282,283,284,285,286,287,288,289,290,291,292,293,294,295,297,298,299,300,301,302,304,305,306,307,308,309,310,311,312,313,314,315,316,317,318,319,320,321,322,323,324,325,326,327,328,329,330,331,332,333,334,335,336,337,338,339,340,341,342,343,344,345,346,347,348,349,350,351,352,353,354,355,356,357,358,359,360,361,362,363,364,365,366,367,368,369,371,372,373,374,375,376,377,378,380,381,382,383,384,385,386,387,388,390,391,392,393,394,395,396,397,398,399,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,416,417,418,419,420,421,422,423,424,425,426,427,428,429,430,431,432,433,434,435,436,437,438,439,440,441,442,443,444,445,446,447,448,449,450,451,452,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],thick:380,thiel:472,thin:[24,54,62,141,275,287,369],thing1:386,thing2:386,thing:[30,57,62,65,72,74,78,79,81,82,83,84,89,90,91,92,95,97,99,102,103,104,105,107,109,110,111,122,127,135,141,158,160,168,170,177,182,193,201,207,212,216,225,227,245,252,257,266,267,275,284,292,297,301,321,335,343,346,348,355,366,368,370,371,373,384,385,386,387,390,392,397,400,426,430,435,436,437,438,440,445,446,450,452,453,454,455,456,457,458,459,460,461,464,467,468,472],thingi:445,think:[22,55,58,65,66,74,81,84,86,91,95,99,104,106,107,109,111,193,202,237,266,292,301,386,387,424,426,428,436,437,438,445,458,461,462],thinli:308,third:[5,7,22,23,26,28,30,31,53,57,62,65,70,71,72,79,81,82,84,86,89,90,91,93,94,95,99,103,104,106,109,111,112,119,129,134,135,168,177,178,182,185,187,190,227,230,260,266,267,293,297,301,309,321,331,333,339,342,343,346,355,356,376,377,382,385,387,392,396,397,399,416,422,424,428,441,442,445,453,455,456,457,458,459,460,461,462,463,465,466,467,468,469,470,472],thirti:179,this_dir:385,this_fail:439,this_foo:386,tho:445,thoma:[91,456,457,460,461,462,463,468,469,470,471,472],thomassen:472,thon:445,thorn:468,thorough:[94,321,339,466,472],thoroughli:[443,472],those:[5,7,22,30,31,54,57,58,60,64,65,69,72,74,75,78,79,80,82,83,84,86,90,91,93,95,97,98,99,102,103,104,105,106,107,108,109,110,111,118,122,129,135,139,140,153,159,161,168,170,173,176,177,178,179,184,187,189,190,193,195,197,203,204,205,206,209,211,212,214,217,222,225,227,229,230,235,243,245,248,252,254,257,258,260,261,265,266,267,268,271,275,276,284,289,291,292,293,295,297,298,299,301,304,310,312,313,316,318,320,321,324,326,327,328,330,331,332,334,337,339,343,346,349,355,359,361,362,363,367,372,373,377,380,381,382,385,386,387,391,392,396,397,399,402,407,409,410,412,413,419,421,423,424,425,426,428,431,432,435,436,437,438,440,442,444,445,446,447,448,451,455,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],thou:[347,466],though:[1,9,10,28,30,31,53,57,58,66,68,69,72,74,79,81,82,83,86,90,91,92,93,95,97,99,104,105,106,109,110,118,122,129,135,141,157,159,161,162,169,174,178,187,193,197,200,206,207,209,212,214,227,232,236,244,248,251,252,254,257,261,266,268,271,275,284,288,292,293,307,313,316,321,329,332,343,346,349,363,366,367,382,385,386,387,390,392,404,407,408,412,422,424,425,426,427,428,430,431,432,436,438,440,445,450,451,455,456,457,458,459,460,461,462,464,465,466,467,472],thought:[84,86,95,99,284,456,458,459,464,469],thousand:[62,86,109,253,265,310,321,347,406,437,470,471,473],thousands_sep:[265,346,472],thousep:265,thread:[16,22,28,29,31,38,48,54,57,62,79,82,85,87,91,93,103,107,116,120,127,128,131,132,134,135,136,139,141,151,152,161,165,167,170,171,177,189,215,228,236,246,248,249,251,253,265,267,268,269,271,284,290,293,318,320,323,324,326,327,340,342,343,346,350,355,363,367,392,396,397,399,424,441,451,456,458,459,460,461,462,463,464,470,472,473],thread_foobar:472,thread_id:[334,367],thread_ind:101,thread_info:[355,446,467],thread_name_prefix:[167,470,472],thread_pthread:472,thread_task:90,thread_tim:[367,471,472],thread_time_n:[367,471,472],threadedhttpserv:472,threadedtcprequesthandl:340,threadedtcpserv:340,threadgroup:366,threading_algorithm:249,threading_cleanup:[363,472],threading_setup:[363,472],threadinghttpserv:[246,471],threadingmixin:[246,340,471,472],threadingtcpserv:[104,340],threadingudpserv:340,threadloc:104,threadnam:[104,266],threadpool:472,threadpoolexecutor:[62,90,128,129,165,466,469,470,471,472],threadsaf:[128,266,320,369,472],threat:293,threaten:[99,458,459],three:[5,7,22,28,30,31,38,53,57,66,72,74,77,79,81,82,83,84,90,91,93,95,103,104,106,107,108,109,111,114,119,125,135,136,140,159,161,162,163,173,176,177,178,182,187,189,190,193,195,197,201,206,208,212,214,217,222,227,228,229,236,237,244,246,249,257,265,266,267,268,271,279,284,286,288,292,295,297,298,301,309,310,311,316,318,320,321,328,329,333,335,339,342,343,345,346,347,349,350,355,359,360,367,368,370,373,380,381,385,386,387,392,396,400,406,407,411,412,416,423,424,426,428,430,431,432,433,436,437,440,442,444,446,447,448,453,455,456,457,458,459,460,461,462,463,465,466,467,468,471,472],three_year:184,threefold:103,threshold0:229,threshold1:229,threshold2:229,threshold:[103,104,229,266,461],throttl:266,through:[5,7,9,10,13,14,19,21,22,30,38,41,50,55,57,58,62,65,66,69,74,77,79,82,83,84,86,91,94,98,99,102,103,104,105,106,109,110,111,112,118,122,123,129,145,153,159,161,167,168,176,177,178,179,182,184,186,187,193,195,197,198,199,203,205,206,207,209,211,217,223,227,228,232,242,243,245,246,248,252,266,267,268,271,274,275,279,282,284,292,293,294,299,303,308,314,316,321,337,339,343,344,346,347,350,355,356,363,365,366,368,370,372,373,381,385,386,387,391,392,395,399,403,407,408,410,414,416,419,421,423,424,428,430,431,432,435,436,437,438,441,446,447,448,450,451,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472,473],throughout:[14,62,79,86,91,98,103,113,187,252,266,386,430,456,458,459,461,462,463,466,469,472],throughput:[463,471,472],throwflag:[60,472],thrown:[60,95,99,140,184,187,294,311,458,459,467],thru:422,ths:346,thu:[4,5,7,31,34,38,65,66,69,72,74,79,84,90,91,95,103,104,105,106,111,119,122,141,142,152,168,170,177,178,193,202,205,206,209,212,214,227,230,236,244,252,258,261,265,266,267,268,275,284,292,293,301,315,321,332,333,339,342,343,346,350,355,361,363,367,370,380,382,385,391,392,396,402,404,418,423,426,428,431,432,436,437,445,446,455,456,464,466,467,468,469,470,472],thumb:[57,105,131,189,373],thunderbird:106,thursdai:[152,184],thusli:380,tiago:467,tibetan:109,tic:438,tick:[310,324,367],tick_count:468,ticker:470,ticket:343,ticket_lifetime_hint:343,ticklish:95,tide:372,tidi:[266,385,459,461,462],tidier:461,tidili:442,tie:237,tiebreak:184,tied:[30,65,343],tiedemann:456,ties:[187,310,472],tiff:[250,370,461],tiger:321,tigetflag:178,tigetnum:178,tigetstr:178,tight:103,tighten:[244,456,463,466],tighter:[423,460,467],tightli:[91,426,430],tikhonov:472,tild:[111,233,294,374],tile:[373,380,463],till:[227,284,310,343,360],tilleniu:461,tilt:380,tiltangl:380,tim:[347,368,422,455,456,457,458,459,460,461,463,468,469,470,472],time2internald:249,time2netscap:472,time:[1,3,5,12,19,22,26,30,37,38,41,49,57,58,60,62,64,65,66,72,74,75,78,79,80,81,82,83,84,85,86,87,91,92,93,94,95,97,99,101,105,106,107,110,111,112,117,119,120,122,123,128,129,132,134,135,136,140,141,142,143,145,147,152,153,158,161,164,167,168,169,170,173,174,176,177,178,183,186,187,189,192,193,203,204,209,210,212,213,214,215,217,219,227,228,229,232,233,235,236,237,238,241,244,246,248,249,251,252,253,254,256,258,260,265,266,267,268,271,276,282,283,284,288,292,293,294,295,298,299,301,302,306,308,310,311,316,318,320,321,322,324,327,328,329,330,331,332,333,334,336,339,340,342,343,344,346,350,355,358,359,360,361,363,365,366,370,372,373,376,380,385,386,387,392,393,395,396,397,399,402,404,405,406,407,412,413,416,417,419,420,422,423,424,425,426,428,430,431,432,433,434,435,436,437,438,439,441,442,443,445,446,448,451,455,456,457,458,460,461,462,463,464,465,468,472],time_:271,time_fromtimeandfold:472,time_hi_vers:395,time_low:395,time_mid:395,time_n:[367,471,472],time_str:184,time_strftim:472,time_taken:368,time_to_birthdai:184,time_wait:[129,339],timedelta:[19,62,183,212,288,381,459,463,466,467,471,472],timedrotatingfilehandl:[62,103,120,460,462,468],timefunc:[327,467],timegm:[152,367],timeit:[62,91,186,253,310,447,451,459,460,462,472],timemodul:472,timeout:[62,104,107,110,117,127,129,131,136,138,139,141,167,170,178,186,225,243,267,268,284,288,307,318,329,330,334,337,340,342,343,350,360,363,366,392,459,462,463,466,467,469,472],timeout_max:[117,366],timeouterror:[22,127,130,140,167,214,284,446,467,472],timeoutexpir:350,timeperiod:[62,183],timer1:459,timer2:459,timer:[62,97,101,165,186,213,215,284,329,334,367,368,373,380,447,458,459,462,467,469,470,471,472],timerhandl:[129,472],timeslic:355,timespec:[184,470,472],timestamp:[65,101,104,129,152,161,164,184,204,210,235,237,246,266,293,313,337,342,343,359,367,376,395,419,428,451,459,463,467,469,471,472],timetupl:[184,342],timetz:184,timeunit:310,timev:210,timezon:[19,62,120,183,189,204,210,343,363,447,466,467,469,470,471,472],timo:[422,472],timothi:422,timsort:[108,466],timzon:472,tin:[110,271],tincidunt:151,tini:[5,90,91,94,106,182,456,462,463,472],tino:459,tiocgpgrp:216,tip:[62,64,91,247,248,446,456,463,472],tipc:[339,462],tipc_:339,tipc_addr_id:339,tipc_addr_nam:339,tipc_addr_nameseq:339,tipc_cluster_scop:339,tipc_node_scop:339,tipc_zone_scop:339,tiram:471,tiremove_thisg:321,tirosh:[459,467],tis:459,tishler:[457,459,472],tismer:[456,468],titl:[1,58,66,69,86,90,93,99,106,109,110,122,153,161,185,241,248,261,282,284,292,339,342,346,347,370,380,392,408,409,410,417,450,456,458,460,466,472],titlebar:380,titlecas:[58,346,431],titledhelpformatt:292,titlestr:380,tix:[62,87,253,369,370,459,470,472],tix_addbitmapdir:372,tix_cget:372,tix_config:372,tix_configur:372,tix_filedialog:372,tix_getbitmap:372,tix_getimag:372,tix_librari:372,tix_option_get:372,tix_resetopt:372,tixcommand:372,tixexfileselectdialog:372,tixinspect:372,tixnotebook:372,tjh:422,tk_bindfortravers:[470,472],tk_librari:87,tk_menubar:[470,472],tk_popup:372,tkapp:[459,472],tkappinit:87,tkcmd:463,tkdoc:370,tkfixedfont:472,tkfont:470,tkinter:[62,86,106,253,296,369,380,453,456,459,462,464,465,472],tlabel:373,tld:267,tlist:372,tls1:463,tls:343,tlsv1:[343,468,472],tlsv1_1:343,tlsv1_2:343,tlsv1_3:343,tlsversion:[343,472],tm_gmtoff:[367,470,472],tm_hour:367,tm_isdst:[184,367],tm_mdai:367,tm_min:367,tm_mon:367,tm_sec:367,tm_wdai:367,tm_ydai:367,tm_year:[93,367,458],tm_zone:[367,470,472],tmenubutton:373,tmp1223:272,tmp:[82,109,111,170,225,246,271,333,361,428,456,459,460,461,462,463,466],tmp_file:110,tmpdir:361,tmpdirnam:[361,466],tmpf:472,tmpfile:464,tmpnam:464,tmptjujjt:361,to_addr:[337,466],to_angl:380,to_byt:346,to_eng_str:[187,460],to_integr:187,to_integral_exact:187,to_integral_valu:187,to_sci_str:[187,460],to_start:58,toaddr:[90,267,268,337],toaiff:462,toascii:159,tobi:[456,472],tobia:456,tobuf:359,tobyt:[123,346,463,466],toc:[248,472],tocknel:[471,472],todai:[31,78,105,109,168,184,288,295,342,359,387,416,431,440,447,457,459,460,462],todat:189,toder:[471,472],todesc:189,toe:438,tofil:[123,189,464],tofiled:189,togeth:[17,31,57,62,65,66,72,78,84,95,96,97,99,102,103,104,105,106,122,123,129,135,159,161,176,177,193,203,208,209,219,227,236,244,245,258,260,266,271,293,343,346,352,371,380,385,386,387,392,396,409,411,422,424,426,436,438,441,445,447,460,466,467,472],toggl:[248,339,373,472],tohexstr:346,toi:81,toijala:472,tok_nam:[374,472],tok_nextc:472,tok_regex:321,token:[16,60,62,90,118,124,171,175,252,253,263,264,282,286,297,316,332,350,358,364,370,392,427,429,430,439,443,463,464,466,470,471,472],token_:328,token_byt:328,token_hex:328,token_specif:321,token_urlsaf:328,tokenerror:375,toknum:375,tokval:375,told:[103,396,424,459],toler:[143,156,258,275,469,471,472],tolin:189,tolist:[123,297,346,458,463,466],tom:[109,458,461,466,468,472],tomato:[212,342],tomono:143,ton:347,tonam:225,toni:[321,462,472],too:[5,17,31,57,60,69,81,84,90,95,97,99,103,104,106,109,110,111,118,128,135,140,148,153,156,159,168,170,172,177,185,187,190,193,195,205,212,213,214,227,229,232,244,257,258,284,291,292,307,309,333,334,339,340,343,345,346,347,349,350,355,360,366,380,385,386,387,406,410,419,420,421,422,424,427,428,430,435,436,437,442,445,447,451,456,457,458,459,460,462,463,464,467,469,471,472],too_many_request:242,toogl:248,took:[108,140,456,472],tool:[28,30,31,62,65,66,71,73,78,84,85,86,87,89,92,93,95,97,98,99,101,102,103,105,106,109,111,112,113,114,120,138,157,161,165,170,178,189,192,193,195,205,220,225,227,228,232,233,253,254,255,260,261,263,291,296,301,309,320,323,332,334,355,375,376,378,380,382,385,396,410,418,419,432,436,440,441,447,449,453,454,455,456,457,458,459,461,462,464,465,466,467,468,469,470],toolbox:[111,457,458,459],toolchain:[0,462,470,472],toolkit:[62,109,248,260,296,369,370,422,435,453,456],toolset:[0,98,260,292,447,462],tooltip:[380,472],toordin:184,top:[1,28,30,31,38,62,65,72,74,79,84,90,91,93,95,97,99,101,103,104,105,106,110,111,117,122,137,140,153,154,159,168,171,177,178,180,186,189,190,193,208,212,227,232,237,244,248,249,252,253,254,257,265,276,285,293,301,304,306,307,310,314,315,316,317,326,343,344,354,355,363,366,369,370,372,373,380,381,385,386,399,410,416,417,419,425,428,429,431,432,436,438,446,451,454,456,457,458,459,461,462,463,464,466,467,468,470,471,472],top_el:408,top_level_dir:385,top_level_url:110,top_panel:180,top_stat:378,topbottom:380,topdown:293,topic:[62,64,74,78,80,82,85,86,90,94,97,100,106,157,193,227,266,292,309,315,339,370,456,459,465,472],toplevel:[79,161,187,227,354,370,372,373,410],topmost:[161,355,461,472],topolog:459,toprettyxml:[408,459],topsecret:168,tor:288,torgb:462,torhamo:472,torpedo:466,torr:[469,472],torsten:[466,467,472],tort:422,tortiou:422,tos1:190,tos2:190,tos3:190,tos:210,toshio:468,tosi:467,toss:459,tostereo:143,tostr:[123,410,463,466,468],tostringlist:[410,466,468],total:[16,21,30,31,34,40,50,53,54,55,58,79,84,91,94,95,99,119,129,130,135,136,140,161,184,187,189,190,193,197,206,227,228,229,232,237,257,258,260,272,293,310,320,321,333,339,342,343,346,347,367,368,373,378,385,392,398,424,426,431,440,451,463,466,467,468,469,470,472],total_chang:342,total_cost:182,total_ord:[228,424,426,463,466,468,472],total_second:[184,463],total_sleep_tim:136,total_slept_for:136,totals:107,tottim:310,totupl:297,touch:[5,62,91,94,178,248,298,299,425,435,446,462,472],touchlin:178,touchwin:178,tough:91,tounicod:[91,123,159],tour:[62,99,441,458,459,473],tournament:237,toward:[62,91,147,187,193,197,206,219,223,224,227,266,346,365,367,380,424,436,441,457,459,461,462,468,472],tower:[62,223,290,345,380,462,464],town:107,townshend:467,tox:105,toxml:[408,409,456,459],tp_:81,tp_alloc:[56,57,81,82],tp_as_async:[57,81,469],tp_as_buff:[57,81],tp_as_map:[57,81],tp_as_numb:[43,57,81],tp_as_sequ:[57,81],tp_base:[57,81,82],tp_basics:[3,57,81,82],tp_cach:[57,81],tp_call:[57,81],tp_clear:[26,57,81,82],tp_compar:[57,81],tp_dealloc:[3,26,57,81,82,472],tp_del:[57,81,229],tp_descr_get:[57,81],tp_descr_set:[57,81],tp_dict:[57,81,462],tp_dictoffset:[57,81],tp_doc:[57,81,82],tp_final:[57,81,469,472],tp_flag:[26,56,57,81,82,462],tp_free:[57,81,82],tp_getattr:[57,81],tp_getattro:[45,57,81],tp_getset:[53,57,81,82],tp_hash:[45,57,81,462],tp_init:[57,62,81,82],tp_is_gc:[57,81],tp_items:[3,57,81,82],tp_iter:[57,81,346,458],tp_iternext:[57,81,346,458],tp_maxalloc:57,tp_member:[57,81,82],tp_method:[57,81,82],tp_mro:[57,81],tp_name:[57,81,82,95,472],tp_new:[56,57,62,81,82],tp_next:57,tp_print:[57,81],tp_repr:[22,57,81],tp_reserv:[57,81,469],tp_richcmp:457,tp_richcompar:[57,81,472],tp_setattr:[57,81],tp_setattro:[45,57,81],tp_str:[57,81],tp_subclass:[57,81],tp_travers:[26,57,81,82,229,472],tp_version_tag:[57,81],tp_weaklist:[57,81],tp_weaklistoffset:[57,81],tparm:178,tpip:99,tput:178,trac:462,trace:[29,31,38,62,75,79,96,101,103,117,145,158,172,186,228,237,249,253,254,256,299,342,355,363,366,377,380,424,432,434,436,451,457,458,459,463,467,468,469,470,471,472],trace_add:[470,472],trace_callback:342,trace_dispatch:145,trace_info:[470,472],trace_remov:[470,472],trace_vari:[470,472],trace_vdelet:[470,472],trace_vinfo:[470,472],traceback:[22,31,38,60,62,74,79,82,85,91,94,97,99,102,103,104,109,122,128,140,141,142,153,158,161,164,168,170,177,178,186,187,190,193,212,214,248,253,254,255,258,264,266,267,268,284,298,299,301,317,321,340,342,343,346,347,350,355,368,380,381,384,385,386,387,404,423,424,425,426,432,436,437,438,439,442,445,448,451,457,458,459,460,461,462,463,464,466,467,471,472],traceback_limit:[378,404],tracebackexcept:[62,317,469],tracebacklimit:[355,472],tracebackobj:432,tracebackobject:460,tracebacktyp:[381,424,471,472],tracefunc:355,tracemalloc:[29,62,186,253,363,422,451,472],tracer:[376,380,462,472],track:[22,26,31,57,62,65,74,84,91,93,103,105,106,129,153,159,161,168,170,182,186,187,188,193,222,229,237,253,268,275,284,292,293,301,318,329,355,366,370,385,386,392,407,423,440,448,456,457,460,463,465,466,468,469,470,471,472],track_entry_and_exit:[170,466],trackcal:376,tracker:[62,64,112,284,363,461,463,472],tractabl:90,trad:472,trade:[8,217,292,346,422,448],trademark:[86,422],tradeoff:38,tradit:[62,65,79,82,93,111,159,174,265,271,275,292,293,312,363,423,428,447,462,466],tradition:[52,111,310,360,459,471],traffic:[86,209,339,458,466,472],trail:[5,17,30,58,65,74,84,95,97,99,106,144,147,158,159,160,168,178,187,189,197,206,209,223,225,227,230,240,241,248,271,294,316,339,346,347,350,357,367,370,377,386,392,404,407,421,426,431,432,436,438,448,456,460,462,463,464,465,466,468,469,470,471,472],trailer:[103,293,421,427,472],trailneg:187,tran:[342,461],transact:[62,99,161,243,244,282,300,320,336,366,392,459,461,462,466,469,470,472],transaction_count:161,transcod:[159,404,466],transcript:193,transfer:[30,31,62,78,79,97,107,110,144,170,196,197,198,199,202,203,204,207,208,209,225,236,242,243,245,271,274,276,284,288,293,337,392,394,416,426,428,462,463,466,467,470,472],transfer_encod:202,transfercmd:225,transform:[62,65,93,98,99,104,105,107,108,109,113,124,146,149,168,176,184,187,193,197,198,202,206,209,212,214,222,227,228,237,254,265,266,271,301,346,375,380,381,382,423,424,426,445,450,456,457,462,464,468,469,471,472],transient_internet:363,transientresourc:[363,462],transit:[58,62,102,110,184,212,228,267,331,340,392,426,439,458,460,461,463,467],transitionerror:439,translat:[58,62,65,79,93,96,105,106,109,110,147,153,159,177,178,188,213,214,221,224,227,239,241,246,247,252,253,257,261,283,293,334,336,339,346,347,350,384,410,416,423,424,456,459,460,462,463,464,465,466,469,472],transliter:339,transmiss:[109,125,179,209,268,302,404],transmit:[110,125,129,135,143,288,337,339,362,404,406,416,460],transpar:[84,92,109,122,151,159,177,178,203,204,219,242,248,257,269,301,359,373,380,418,455,457,459,460,467,468,470,471,472],transport:[62,126,129,131,137,138,171,195,199,202,207,213,274,297,319,337,343,415,416,458,469,470,471,472],transpos:[438,460],transposed_row:438,trap:[128,170,187,368,458,460,467,472],trash:[57,271,472],trashcan:456,traur:458,travers:[26,28,41,47,57,82,93,99,113,124,164,185,197,206,266,346,373,385,386,404,409,428,432,456,458,459,461,462,463,469,472],traverseproc:[26,41,57,81,82],travi:[461,462,463,472],trb:85,treat:[4,6,31,42,51,53,58,60,65,90,94,99,102,105,106,114,122,123,140,141,143,159,161,168,172,178,182,184,187,189,193,195,204,206,212,223,228,233,244,246,258,260,266,267,275,292,321,332,336,337,342,346,347,350,351,359,363,365,368,370,373,382,385,391,392,397,398,404,409,423,425,426,431,432,436,444,445,446,455,456,458,461,462,463,464,467,470,472],treatment:[45,65,104,195,222,284,297,345,391,456,464],tree:[15,30,57,62,66,67,69,71,72,74,75,84,90,91,92,93,95,99,111,113,153,164,175,189,195,197,205,206,208,217,233,237,248,253,263,273,293,298,313,314,333,344,346,358,372,373,380,396,406,407,408,424,448,449,454,455,456,457,458,459,460,461,462,463,464,467,469,470,472,473],treebuild:[62,273,466,472],treesync:472,treeview:[62,369,472],treeviewclos:373,treeviewopen:373,treeviewselect:373,tremend:[90,437],trent:[456,459,461,468],trevino:467,trevor:460,tri:[13,30,44,79,81,82,84,91,93,99,102,106,111,113,143,160,177,190,193,204,210,227,251,257,265,268,276,283,284,289,293,305,315,321,324,337,342,347,363,366,380,392,424,426,428,430,439,456,457,458,459,460,461,462,463,464,471,472],trial:[193,320,368,459],triangl:380,triangular:[320,462],trick:[28,62,84,91,177,355,387,436,458],tricki:[65,93,95,96,149,158,212,292,456,457,464],trickier:[91,292],trifl:111,trigger:[30,38,57,62,82,93,95,98,99,101,105,129,170,187,197,206,211,214,228,252,254,284,292,293,318,334,335,342,346,370,385,386,391,397,406,416,424,439,448,451,457,458,459,460,461,462,463,466,467,468,469,470,471,472],trigonometr:[62,290,460],trip:[104,151,244,375,462,464,465,472],tripathi:[469,472],tripl:[85,93,106,109,189,251,288,293,302,321,329,339,346,365,380,431,442,445],triplet:472,tristan:472,tristiqu:151,trivia:461,trivial:[57,62,66,74,78,79,81,84,90,99,110,138,153,195,209,235,284,321,350,352,387,404,436,447,459,467,468],trivial_dealloc:81,trivialobject:81,trivialtyp:81,troeger:472,trojan:463,trondheim:438,troubl:[78,102,107,110,214,455,460],trove:[74,105,459],tru64:464,true_v:461,true_valu:461,truediv:291,truli:[79,87,90,91,182,271,365,392,463,464,472],trunc:[275,289,346,424,462],truncat:[5,17,54,58,90,91,143,151,178,184,187,214,227,235,249,257,260,269,275,293,322,339,342,346,349,361,363,365,390,394,419,421,424,426,442,456,458,462,463,464,466,467,468,469,471,472],trunk:[95,461,462],trust:[77,153,225,243,249,267,284,304,307,337,343,350,392,462,463,468],trusti:471,trustworthi:343,truth:[5,6,62,65,94,99,107,169,177,227,253,291,349,424,426,459,472],try1_stmt:423,try2_stmt:423,try_stmt:[423,427],tsc:460,tshepang:94,tss:[62,471,472],tstate:30,ttk:[62,253,369,370,372,465,470,471,472],ttk_intro:463,ttkstyle:373,ttshandler:104,tty:[62,178,231,253,257,293,388,433,434,444,451,462],ttynam:293,ttys0:334,tucson:99,tue:[152,184],tuesdai:[152,184,268,447],tuininga:[91,472],tunabl:[236,293,466],tune:[84,228,229,244,292,321,324,343,421,456,459],tunnel:[243,466],tup:[309,380],tupl:[3,5,13,15,19,22,25,31,34,36,38,45,49,50,53,56,57,60,62,65,74,78,79,81,82,93,95,99,103,104,106,108,110,113,114,117,118,119,122,123,124,129,135,136,138,141,143,145,152,154,157,159,167,171,173,177,178,182,183,184,185,187,189,190,193,197,204,206,209,210,212,214,222,225,227,228,229,234,237,243,244,245,246,249,251,252,253,254,257,258,260,261,265,266,268,271,272,274,276,280,282,284,286,288,289,291,292,293,294,295,297,298,301,302,305,306,307,310,312,316,318,321,324,327,329,330,332,333,334,336,337,338,339,340,341,342,343,344,347,349,350,351,354,355,356,360,361,363,366,367,370,373,375,377,378,380,381,382,385,386,391,392,393,395,397,398,399,402,404,409,410,412,413,416,417,419,423,424,426,428,432,436,437,439,441,442,446,447,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],tuple2:302,tuple2st:297,tuple_factori:182,tuple_param:113,turbo:455,turkish:159,turn:[5,22,30,31,53,57,66,75,79,84,91,94,95,97,98,99,103,105,106,109,110,111,113,122,157,159,161,168,177,178,189,193,195,209,210,227,237,244,246,248,254,265,266,284,292,298,300,303,313,322,329,334,337,339,342,355,362,363,366,368,380,382,385,387,392,397,417,421,423,428,430,431,438,444,451,456,457,458,459,460,461,462,463,464,465,466,467,468,470,472],turn_r:370,turnbul:472,turner:472,turtl:[62,157,224,248,253,370,462,464,466,472],turtle_docstringdict:380,turtle_docstringdict_german:380,turtle_docstringdict_italian:380,turtledemo:[62,224,248,472],turtlegraph:380,turtlegraphicserror:380,turtles:380,turtlescreen:[62,224],turtleshap:380,turtleshel:157,tutor:99,tutori:[62,80,84,87,90,97,98,100,104,106,107,110,120,126,161,163,178,193,214,227,228,248,266,267,268,273,290,296,297,320,339,342,352,369,370,404,429,430,435,445,449,450,453,458,460,461,462,466,472],tutt:456,tuur:472,tweak:[292,387,457,460,470,472],twelv:[178,373],twice:[30,83,91,99,104,105,108,109,111,147,164,168,184,215,237,238,275,321,342,355,375,397,436,442,451,456,458,459,460,462,463,470,472],twin:456,twine:64,twinsun:184,twist:[90,387,422,437,472],twister:[62,320,459],twisti:97,twix:245,two:[5,6,7,9,13,14,22,26,30,31,32,33,37,38,41,43,53,57,58,61,62,65,66,69,72,74,75,78,79,81,82,83,84,86,90,91,92,93,94,95,97,98,99,102,103,104,105,106,107,108,109,110,111,114,119,122,125,129,134,135,137,139,140,141,143,144,145,147,149,152,153,156,158,159,160,161,168,172,173,174,176,177,178,179,182,184,187,189,190,193,195,196,197,201,203,208,209,210,211,212,214,217,219,222,223,225,227,228,229,230,231,232,236,237,244,246,248,249,250,252,254,256,257,258,259,260,265,266,267,271,275,276,279,282,284,288,289,291,292,293,295,297,299,301,303,305,307,310,314,316,318,319,320,321,324,326,327,328,331,333,334,335,336,339,340,342,343,344,345,346,347,348,349,351,355,359,361,363,365,366,367,368,370,372,373,375,378,380,382,384,385,386,387,391,392,395,396,397,398,399,402,404,405,407,410,413,418,419,421,423,424,426,428,429,430,431,432,434,436,437,438,439,440,442,445,446,447,448,453,455,456,457,458,459,460,461,462,464,465,466,467,468,469,470,471,472],two_canvas:380,twoplac:187,twosh:168,tx_addr:339,txt:[31,62,68,75,84,99,104,109,111,122,161,167,170,190,193,209,219,221,227,232,233,235,236,244,253,255,257,279,288,292,293,298,301,346,350,355,359,370,384,389,418,419,431,436,439,448,449,455,456,462,463,465,466,467,468,469,470,472],tycho:[447,472],tyler:[470,472],typ:[198,249,382],type2:227,type:[1,2,3,5,6,9,10,11,12,14,15,16,18,19,20,21,22,24,25,26,27,28,29,30,33,34,35,36,37,38,39,40,41,43,45,46,47,48,49,50,51,52,53,55,60,61,62,65,66,71,72,79,80,83,85,86,90,91,92,93,94,95,96,97,98,102,103,104,107,110,111,113,117,118,119,120,123,124,125,129,130,140,141,145,146,153,154,155,157,159,161,162,168,169,170,172,173,174,176,178,179,182,185,187,188,189,190,193,195,196,197,198,199,200,201,202,204,205,206,207,208,209,210,213,214,217,225,227,228,229,232,236,237,238,241,243,245,246,248,249,251,252,253,256,257,260,261,265,266,267,268,269,272,273,274,275,278,279,280,282,284,285,290,291,293,294,297,299,300,301,305,306,308,309,315,316,317,318,320,321,322,323,326,327,329,330,331,332,333,334,339,340,343,344,345,347,349,350,351,352,354,355,359,361,363,364,367,369,373,374,375,377,378,380,385,386,387,391,392,396,397,398,399,400,401,403,404,405,406,408,409,410,412,413,416,417,419,423,425,426,428,429,431,432,433,434,435,436,437,439,441,442,444,445,446,448,450,451,455,456,457,463,464,465,466,472,473],type_:380,type_check:[292,382,470,472],type_check_onli:[382,472],type_getattro:[98,472],type_int64:[468,472],type_new:57,type_tag:301,typeahead:178,typecheck:[177,382],typecod:[123,284,381,448,464,472],typecode_or_typ:284,typed_act:292,typed_subpart_iter:205,typedargslist:427,typedef:[10,14,53,54,57,58,81,82,95,472],typedesc:177,typeerror:[5,9,21,22,35,37,43,44,45,49,50,54,57,58,61,79,81,82,91,93,94,99,102,109,110,123,131,168,173,177,182,184,185,187,193,197,198,199,200,206,207,212,214,227,252,254,257,258,261,267,274,279,291,292,293,294,298,306,320,346,355,367,382,385,386,391,395,399,408,410,416,424,426,432,437,438,439,445,446,447,456,457,458,459,460,461,462,463,464,465,467,468,469,470,471,472],typeid:284,typekei:198,typemap:[92,268],typenam:[161,309,342,462,472],typeobj:385,typeobject:[5,98,458],types_map:[276,462,472],types_map_inv:276,typesaf:382,typescript:311,typesystem:124,typetyp:280,typevar:382,typewrit:213,typic:[22,30,31,41,52,53,56,57,58,65,66,69,72,75,77,79,83,84,91,92,93,95,98,103,104,105,110,111,112,122,125,128,129,131,136,151,153,159,168,174,187,189,193,197,204,206,212,219,222,225,227,228,230,232,246,252,254,257,265,266,267,268,271,275,276,282,284,292,293,297,299,301,308,309,310,318,320,322,326,328,333,335,343,345,346,347,349,350,355,356,359,360,361,363,366,367,368,370,373,381,382,385,386,392,395,397,402,404,407,408,411,412,413,418,420,424,426,428,434,435,439,447,448,451,455,459,460,463,464,466,468,469,471,472],typifi:267,typist:111,typo:[84,99,153,386,426,458,472],typographi:321,tz1:184,tzdata:[184,472],tzfile:367,tzinfo:[62,183,210,459,466,467,470,471,472],tzinfo_exampl:184,tzname:[19,184,367,470,472],tzpars:461,tzset:[367,472],tzvf:333,u00000394:109,u00008000:109,u0010ffff:467,u0043:426,u00c7:426,u0327:426,u0394:109,u0660:[384,456],u07b4:109,u0e55:109,u0e57:109,u1176:472,u11a7:472,u11c3:472,u1234:[109,159,261],u16:159,u2000ab:456,u2028:346,u2029:346,u20ac:[109,464,469],u21ef:462,u2603:104,u2641:123,u2713:382,u3000:462,u3002:467,u304:462,u3054:462,u305f:462,u307:462,u3080:462,u3081:462,u31ef:462,u3244:462,u32:159,u4000:459,u4001abc:459,u4500:109,u4500abc:109,u4eba:467,u52ff:467,u65bc:467,u65bd:467,u751f:462,u_expr:426,ua000:109,ua000abcd:109,uac:[71,472],uadd:124,uall:[363,459],uapi:468,uat:267,uax:431,ubsan:472,ubuntu:[471,472],ucarp:225,ucd:[346,384,431,467,468],ucd_3_2_0:[384,461],ucnhash_capi:463,ucrt:472,ucrtbas:[455,472],ucs1:[58,472],ucs2:[58,472],ucs4:[58,458,472],udata:329,udbff:467,udf:225,udfff:467,udp:[62,103,129,132,268,339,340,363,463,472],udpserv:[62,255],ue000:109,uf_append:[293,344,462],uf_compress:[293,344],uf_hidden:[293,344],uf_immut:[293,344,462],uf_nodump:[293,344],uf_nounlink:[293,344],uf_opaqu:[293,344],ufeff:58,ufeffunicod:104,uff10:187,uff19:187,ufff:58,ufffd:159,ufffdabc:109,ufs:446,ugli:[84,85,189,438,456,459],uhc:159,uhhhh:456,uid:[153,246,249,293,298,307,312,324,333,344,359,462,463,467,469,472],uidl:307,uint:177,uint_max:472,uit:299,uitext:282,uiuc:392,uji:159,ukrainian:[159,468,471],ulaw2lin:143,ulaw:[119,351],ulf:91,uli:178,ullamcorp:151,ulong_max:35,ulp:[462,472],ulrich:472,ultim:[53,72,93,193,236,292,355,424,428,432,458,460],ultrasound:295,ultric:151,ulx:178,umask:[185,293,298,363,471,472],umber:384,umer:472,umlaut:265,ump:299,una:461,unabl:[65,97,99,103,110,254,271,329,355,365,392,449,461,472],unaccept:[84,301,339,410,432],unadorn:346,unaffect:[65,187,333,424,432,451,459,462,470],unalia:299,unalign:472,unalt:[75,438],unam:[65,293,305,355,356,359,466,467],unambigu:[7,84,122,184,267,310,337,424,432,442,462,466],unari:[62,161,187,190,346,386,424,429,431,467],unary_invert:190,unary_neg:190,unary_not:190,unary_posit:190,unaryfunc:57,unaryop:124,unassign:[30,348],unattend:455,unauthent:[274,301,316,343,406,408,409,410,411,416,417],unauthor:[110,242],unavail:[84,90,96,110,193,231,254,269,284,293,333,382,424,472],unavoid:[99,184,460,463,465],unawar:460,unbalanc:472,unbeliev:107,unbias:345,unbidden:248,unbind:[425,472],unblock:[136,284,318,334],unbound:[40,62,91,104,117,161,187,188,190,227,254,318,363,366,380,381,424,425,428,432,458,460,464,469,471,472],unboundlocalerror:[22,214,425,446,456,472],unbrac:347,unbreak:472,unbuff:[23,30,257,350,451,472],unc:[233,293,294,298,419,472],uncach:[293,466,472],uncas:346,uncatch:129,uncaught:[97,154,355,426,457,472],unchain:472,unchang:[38,84,95,98,104,106,113,123,153,157,161,168,172,177,178,187,209,222,232,260,265,268,271,293,294,304,320,321,339,346,347,380,381,382,391,418,424,426,431,436,442,448,455,458,460,461,462,463,464,465,466,467,470,471,472],uncheck:[164,428,451,471,472],unchecked_hash:313,unclean:[461,472],unclear:106,unclos:[248,342,375,466,470,472],uncollect:[229,466,472],uncolor:248,uncom:[201,248,458],uncomfort:84,uncommit:[342,466],uncommon:[201,461,472],uncomp_s:448,uncompil:360,uncomplet:[],uncompress:[119,151,235,269,333,359,418,419,421,466],uncondit:[299,387,431,472],uncondition:[117,248,252,284,288,293,298,335,385,424,434,439,451,463,464,466,467,468,469,471,472],unconnect:[339,462],unconstrain:382,unconsum:421,unconsumed_tail:421,uncontrol:333,uncontroversi:407,unconvert:17,uncov:[93,471],unctrl:[178,179],uncustom:267,undeclar:316,undecod:[13,54,109,159,197,293,466,472],undecor:[62,104,228,346],undef:[68,74],undef_macro:[65,74],undefin:[7,17,30,35,38,57,58,62,65,68,74,91,95,96,129,159,167,197,206,208,214,227,257,275,292,329,345,346,355,367,378,397,410,413,424,426,431,442,445,453,469,471,472],undefine_macro:65,undefinit:65,undeliver:135,under:[13,22,31,38,41,60,62,64,65,66,67,69,74,75,80,84,87,91,97,99,103,104,105,106,111,112,114,122,146,153,157,159,177,178,184,189,193,197,200,204,209,212,214,216,227,229,232,236,248,257,261,266,267,268,271,282,284,292,293,298,299,310,324,332,339,342,344,345,346,355,356,361,363,364,370,372,373,376,377,380,385,386,387,391,392,394,397,400,402,416,417,418,419,422,424,425,432,439,446,451,455,456,457,458,459,460,461,462,463,464,466,467,469,471,472],underdevelop:355,underestim:[457,458,459,460,461,462],underflow:[38,187,470,472],undergo:462,undergon:466,underli:[4,5,7,17,30,39,49,62,74,80,84,90,91,93,97,98,99,103,104,106,118,120,129,133,134,135,137,139,151,155,159,161,162,170,176,177,178,189,213,214,216,217,227,228,235,243,248,253,254,256,257,260,266,267,268,269,271,275,279,284,293,294,295,299,301,307,310,316,318,320,322,324,329,330,331,333,334,339,340,342,343,344,346,350,355,361,363,366,367,380,381,385,387,395,399,402,403,404,407,416,417,424,426,446,447,456,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],underlin:[69,97,178,373],underneath:65,underscor:[35,62,65,69,77,91,93,95,104,147,153,159,161,177,187,197,206,212,227,271,291,319,321,332,347,355,370,386,404,419,424,425,426,430,431,432,436,446,448,455,462,464,465,472],understand:[22,38,62,79,81,82,90,93,95,98,103,105,106,107,109,110,122,141,156,184,192,193,208,232,243,244,261,275,288,297,309,310,321,347,350,352,373,387,404,413,419,423,430,436,440,442,456,457,458,459,461,462,463,464,470,472],understood:[31,74,78,107,153,176,244,267,274,293,299,332,368,394,418,422,424,436],undertaken:439,underw:[459,460,461,462],underwai:465,undesir:[457,461],undetect:[79,271,366],undetermin:293,undisplai:[299,466],undistinguish:459,undo:[30,157,178,248,266,380,386,462,472],undobuff:380,undobufferentri:380,undobuffers:380,undoc_head:157,undocu:[62,92,157,253,266,274,299,363,385,467,468,469,470,471,472],undon:[248,380,386,387],unduli:440,uneasi:84,unencod:[13,41,109,159,319,459,464,466],unencrypt:343,unequ:[93,187,227,298,346,424,426,460,461,464,467],unescap:[93,106,239,240,288,321,391,414,431,468],uneven:[260,320],unexcit:98,unexist:472,unexpand:406,unexpect:[23,26,85,86,103,193,206,209,225,232,266,275,288,320,321,337,339,342,343,363,385,387,392,397,423,424,431,439,455,463,467,471,472],unexpectedexcept:193,unexpectedli:[112,171,324,334,337,385,436,458,469,472],unexpectedsuccess:385,unfamiliar:[93,230,266,292,461,462],unfil:[81,426],unfinish:[136,244,284,318,472],unfold:209,unformat:[104,261,321],unfortun:[28,52,84,90,97,99,104,105,106,110,153,159,284,294,307,310,328,331,339,343,359,361,370,387,440,448,457,460,462,465,470],unfreez:[229,471],ungainli:459,unget_wch:[178,467],ungetch:[178,283],ungetmous:[178,472],ungetwch:283,unglow:380,unguard:469,unhandl:[31,60,117,128,153,158,170,193,230,248,355,366,377,392,424,439,464,472],unhash:[50,84,182,346,385,424,426,472],unhelp:[456,472],unhexlifi:147,uni:[58,431],unic:[79,295,312,454],unichr:[456,458,461],unicod:[5,15,25,28,29,35,41,54,57,59,62,86,91,93,95,97,100,104,105,106,113,121,123,124,144,146,147,152,168,176,177,178,183,184,187,193,195,196,197,198,201,202,203,204,209,210,214,223,227,232,239,240,241,248,253,257,261,265,283,293,294,298,301,304,321,336,342,346,347,348,355,364,382,391,397,402,404,408,409,410,424,426,431,438,451,457,461,462,463,465,468,469,470,471,472,473],unicode_char:283,unicode_escap:[104,159],unicode_intern:[159,467],unicode_liter:[104,114,432,462],unicodedata:[62,106,109,253,364,426,431,456,461,462,463,466,467,472],unicodedecodeerror:[13,22,109,159,214,293,391,446,461,464,466,468,472],unicodeencodeerror:[13,22,41,77,109,159,214,355,391,446,466,472],unicodeerror:[5,22,159,184,203,214,293,346,446,459,464],unicodestr:123,unicodetranslateerror:[13,22,159,214,446,472],unicodewarn:[22,214,397,446,461,466],unicurs:97,unidata_vers:384,unidirect:[135,257,284],unif:[62,460],unifi:[62,108,159,189,193,301,384,436,468,472,473],unified_diff:189,uniform:[90,110,136,320,391,395,416,446,466,472],uniformli:[189,254,320,472],unihan:463,unilater:225,unimpl:[232,244],unimplementedfilemod:243,unimport:212,uninform:472,uniniti:[9,30,31,79,91,95,301,472],uninstal:[66,69,89,211,215,282,378,449,453,455,468,472],unintend:[79,91,187,284,298,472],unintent:[350,472],unintention:[104,266,446,466,472],uninterest:[82,189],uninterrupt:[318,334],union:[62,120,161,252,334,344,346,348,382,424,438,459,460,462,463,469,472],union_upd:459,uniprocessor:305,uniq:[260,460],uniqu:[30,62,64,79,81,86,98,99,101,105,109,122,161,177,183,184,185,189,204,206,210,213,227,230,237,254,258,260,261,271,282,293,301,307,316,320,342,343,345,346,356,366,370,373,385,386,388,391,395,422,423,424,428,436,438,455,460,461,463,465,466,471,472],unique_everseen:260,unique_justseen:260,unique_word:436,uniqueaddresshead:204,uniquedatehead:204,uniquekei:260,uniquesingleaddresshead:204,uniqueunstructuredhead:204,unistr:[384,456],unit:[5,58,62,72,79,86,91,93,95,99,102,103,109,159,161,167,179,184,188,193,228,253,310,327,339,343,346,347,367,368,370,373,380,386,404,422,424,425,449,457,462,467,469,472],unit_pric:182,unittest2:463,unittest:[62,84,90,113,188,253,363,378,397,447,459,465,472],unittestgui:385,univers:[62,65,68,93,176,184,212,227,236,249,252,257,305,346,359,367,370,385,395,419,436,453,460,461,462,468,470,471,472,473],universal_newlin:[129,138,350,460,471],universalsdk:461,unix:[17,22,30,31,52,54,60,62,66,67,68,71,72,74,75,77,79,80,86,87,89,93,97,99,103,107,109,120,122,127,132,133,134,135,137,141,147,152,161,168,175,176,177,178,197,200,202,209,216,220,227,230,231,232,234,244,248,253,255,256,257,260,268,271,272,279,284,286,287,288,292,293,294,295,296,298,300,307,308,311,312,315,324,325,329,330,331,332,333,334,335,337,339,340,341,342,343,344,355,359,361,362,363,367,370,372,379,385,400,404,418,419,431,434,435,442,444,447,449,450,451,452,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],unix_dialect:[176,466],unix_shel:[363,472],unixccompil:71,unixdatagramserv:340,unixfrom:[197,202,206,468],unixi:464,unixpwd:176,unixstreamserv:340,unixwar:457,unknow:[457,458],unknown:[28,30,58,62,106,124,143,189,193,197,200,202,203,209,227,246,276,288,292,293,306,309,321,338,344,355,366,367,378,392,395,413,437,446,458,459,463,466,470,471,472],unknown_decl:241,unknown_open:392,unknownhandl:[62,110,255],unknownprotocol:243,unknowntransferencod:243,unladen10:466,unladen:[448,466],unless:[5,7,9,22,28,30,31,38,49,51,54,57,65,79,82,84,91,92,94,95,99,103,105,106,107,111,113,118,119,124,128,129,131,142,143,147,148,151,152,168,176,182,184,187,190,193,197,201,206,207,210,212,227,241,243,244,245,248,251,252,254,257,258,260,266,267,269,271,275,282,284,288,292,293,294,299,311,316,321,325,329,330,335,336,337,339,340,342,343,345,346,347,350,355,359,360,365,366,385,386,391,392,396,397,399,403,404,409,412,422,423,424,425,426,431,434,436,437,446,451,455,456,457,458,459,460,461,462,463,464,467,468,470,472],unlik:[5,30,34,37,41,45,50,72,74,79,82,84,90,91,98,99,103,104,109,118,125,129,131,136,138,139,140,149,151,164,170,176,178,184,185,187,206,212,222,227,230,233,237,244,249,257,260,261,269,271,275,293,294,295,299,301,305,307,326,339,343,346,347,350,353,361,363,367,381,382,385,386,399,402,404,410,422,424,426,428,430,431,432,436,438,445,447,455,457,458,459,461,462,463,466,467,468,469,470,471,472],unlimit:[138,203,204,209,236,248,284,322,324,346,350,366,424,431,472],unlink:[90,214,284,293,298,329,361,363,373,396,407,408,467,472],unlist:424,unload:[30,363,399,472],unloading_modul:399,unlock:[117,139,216,271,283,284,307,363,366,424,461,472],unlucki:[460,472],unmaintain:[372,466,468,470],unmanag:373,unmap:[58,373],unmarsh:274,unmarshal:[37,274,416,459,461,470,472],unmatch:[84,227,321,347,391,469,472],unmodifi:[5,7,64,86,95,117,209,210,309,346,366,391,414,472],unnam:[19,55,79,93,177,380,402,426,468],unnatur:86,unnecessari:[79,86,91,103,122,135,149,271,284,288,346,355,387,391,407,432,457,458,460,463,469,472],unnecessarili:[161,293,472],unneed:[82,408,463,468,472],unnnn:109,unnorm:[22,472],unnormalis:472,unnot:463,unobtain:293,unoffici:[385,416,469],unoptim:[257,469],unord:[284,346,424,438],unown:[284,472],unpack:[62,66,72,79,90,95,99,104,111,113,123,161,190,201,216,218,227,284,306,333,339,347,349,381,386,426,427,432,438,439,441,447,448,456,460,461,462,464,466,468,472],unpack_arch:[333,466,472],unpack_arrai:405,unpack_byt:405,unpack_doubl:405,unpack_ex:190,unpack_farrai:405,unpack_float:405,unpack_fopaqu:405,unpack_from:[227,349,461],unpack_fstr:405,unpack_item:405,unpack_list:405,unpack_opaqu:405,unpack_sequ:190,unpack_str:405,unpack_typ:405,unpair:[84,261],unparenthes:426,unpars:[122,316,412,472],unparsedentitydecl:412,unparsedentitydeclhandl:316,unpatch:386,unpickl:[62,82,104,184,212,266,268,284,300,302,459,462,463,465,472],unpicklingerror:[301,472],unpredict:[271,293,343,410,413,424,451,458],unprint:199,unprivileg:293,unprocess:241,unprocessable_ent:242,unqualifi:[84,214,436,468],unquot:[176,197,206,210,241,391,392,472],unquote_plu:391,unquote_to_byt:[391,472],unrais:22,unravel:468,unreach:[213,229,424,471,472],unread:[65,98,185,301,392,465,469,472],unreadlin:65,unreason:[95,461],unrecogn:[9,58,94,122,230,241,411,419,431,469,470],unrecognis:[228,267,467],unrecover:412,unredirect:392,unregist:[129,142,215,293,329,330,333,370,399],unregister_archive_format:333,unregister_dialect:176,unregister_unpack_format:333,unregistr:330,unrel:[57,79,91,118,127,152,212,271,339,472],unreleas:86,unreli:[106,178,321,472],unresolv:472,unrespons:472,unrestrict:54,unround:187,unruli:322,unsaf:[81,91,123,153,168,332,385,386,395,459,469,471,472],unsafe_hash:[182,472],unsav:248,unscath:472,unsearch:448,unseek:[235,398,419,466,468,469,472],unseen:271,unseri:466,unset:[54,139,271,293,295,355,363,395,428,462,463,471,472],unsetenv:[293,462],unshar:324,unsign:[5,7,9,28,30,31,35,53,56,57,58,81,95,123,143,147,177,295,339,346,349,351,405,407,408,421,448,458,459,461,467,471,472],unsigned_char:95,unsigned_int:95,unsigned_long:95,unsigned_long_long:95,unsigned_short:95,unsort:84,unspecifi:[95,99,105,151,177,193,227,252,257,258,269,275,287,293,301,316,339,367,373],unsqueez:472,unstabl:[81,113,187,455,472],unstructur:204,unstructuredhead:204,unsubscrib:[249,472],unsuccess:[30,34,251],unsuit:[168,320,410,448,457,463],unsupport:[30,62,94,95,110,117,122,129,168,227,232,257,274,284,293,295,301,306,339,343,345,366,386,391,392,402,428,439,455,456,460,462,466,470,472],unsupported_media_typ:242,unsupportedoper:257,unt:299,untabifi:248,untermin:84,untest:[85,472],unthread:[31,456],until:[28,30,31,54,57,60,68,78,79,82,85,90,93,95,97,99,103,104,106,107,117,129,131,132,135,136,137,138,139,140,141,144,153,155,161,167,178,184,187,208,215,219,225,227,232,236,237,241,243,244,248,251,252,257,260,264,266,268,269,284,292,293,295,299,301,307,310,318,322,327,329,330,332,334,336,339,340,341,342,343,346,349,350,355,360,361,362,363,366,368,370,377,386,392,397,399,400,402,404,405,409,412,413,421,423,424,432,436,437,438,439,448,451,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],untitl:472,untoken:[375,472],untouch:[5,58,65,182],untouchwin:178,untrack:[82,465],untrain:460,untransl:[227,257],untrust:[84,109,124,267,274,284,301,302,314,316,331,343,359,406,408,409,410,411,416,417,419,442,459,462],untyp:458,unununium:445,unus:[31,57,82,94,95,96,151,178,232,257,258,283,284,302,315,333,340,342,347,351,363,398,458,462,468,471,472],unused_data:[151,269,421],unusu:[79,97,104,111,184,214,295,310,324,426,472],unvarnish:60,unverifi:[243,244,392],unvers:468,unwant:[30,31,91,446,471,472],unwieldi:104,unwind:[30,81,170,424],unwis:[346,431],unwound:[81,266,424],unwrap:[254,343,468,472],unwrit:472,unwritten:185,unzip:[111,227,418,420,459,472],upadhyai:471,upcom:[214,228,327,472],updat:[1,21,30,47,54,62,64,65,81,82,86,90,91,95,97,98,99,109,118,119,122,129,132,135,142,161,162,170,178,180,184,185,193,197,206,208,227,228,236,237,238,245,248,249,251,252,254,257,264,271,279,282,284,288,291,292,293,298,301,304,308,317,320,326,331,339,342,343,346,350,356,367,370,373,376,380,381,391,392,398,404,410,418,424,428,432,436,447,451,455,456,457,458,459,460,461,462,464,466,467,468,469,470,471,472],update_authent:392,update_idletask:472,update_lines_col:[178,469,472],update_panel:180,update_vis:271,update_wrapp:[228,461,468],updatepath:[30,31,463],updateprocthreadattribut:350,upendra:472,upfront:462,upgrad:[62,69,86,93,110,111,112,120,132,211,396,449,455,458,459,463,466,468,470,471,472],upgrade_requir:242,upload:[64,70,110,153,457,461,463,469,471,472],uploadreleas:472,upon:[14,17,24,28,30,31,37,58,60,78,79,86,91,93,98,103,142,153,157,159,160,170,174,176,177,178,187,193,236,243,245,248,249,252,271,299,301,329,330,334,336,343,351,355,356,363,376,397,398,407,422,424,426,428,435,436,446,449,457,462,467,468,470,472],upper:[58,65,91,97,99,103,104,106,124,125,147,150,153,161,178,189,222,249,282,284,321,339,340,342,343,346,347,372,380,382,385,424,426,432,459,466,472],upper_bound:426,upper_cas:472,upperbound:318,uppercamelcas:437,uppercas:[58,91,95,109,122,150,179,212,227,292,328,336,346,347,392,431,456,463,464,468,470,472],upperleft:177,upperout:91,ups:[466,472],upstream:[236,336,472],uptim:[367,471],upward:[87,106,178,298,301,380,386],urandom:[129,236,284,293,320,343,460,463,468,469,470,472],uranu:212,urban:[466,468,472],urdu:159,urgent:329,uri:[104,110,244,298,316,342,343,380,391,392,404,407,410,412,413,415,416,467,468,472],url2pathnam:392,url:[62,65,66,69,72,74,77,137,144,153,167,168,225,242,243,244,246,248,253,255,268,276,315,328,363,393,395,396,400,404,413,414,416,417,422,428,447,456,459,460,461,462,463,466,468,469,472],url_schem:404,url_valu:110,urlcleanup:392,urldefrag:[391,466],urlencod:[90,110,153,243,268,391,392,466,469,472],urlerror:[62,390,392,462],urlich:91,urljoin:[391,469,472],urllib2:[110,113,392,460,462,463,464],urllib:[62,90,100,113,137,153,167,170,225,228,242,243,244,253,255,268,309,378,386,396,447,456,459,461,462,464,472],urlopen:[90,110,167,170,228,244,309,390,391,392,447,461,462,463,466,467,468,469,472],urlpars:[391,396,462,463,464,466,470],urlretriev:[390,392,396],urlsafe_b64decod:144,urlsafe_b64encod:144,urlsplit:[137,391,463,470,472],urlstr:391,urlunpars:391,urlunsplit:391,urn:[391,395],urtubia:460,urwid:97,urx:380,us_dst_rang:184,usabl:[31,35,44,51,54,57,58,82,84,86,91,93,102,105,107,129,141,153,159,177,178,184,210,227,246,252,258,267,276,284,293,294,305,339,343,346,347,350,407,424,426,428,436,446,458,459,460,461,466,470,471],usag:[5,30,58,62,65,68,74,78,79,82,84,86,90,91,93,94,99,103,104,105,106,109,113,118,120,121,137,140,141,142,144,155,170,176,179,184,186,188,195,214,219,222,230,232,237,242,244,246,249,251,252,253,255,257,258,263,266,268,272,276,281,284,285,292,293,299,301,307,309,321,333,346,347,356,361,363,368,369,370,372,378,382,385,388,392,395,396,397,400,404,407,408,418,421,423,424,442,445,451,453,455,458,459,460,461,462,463,466,469,470,472],usb:472,use:[1,2,5,7,9,10,11,12,13,14,15,16,21,22,23,26,28,30,31,34,36,37,38,41,44,45,47,49,51,52,53,54,55,56,57,58,60,62,64,65,66,68,69,70,71,72,74,75,77,78,79,80,81,82,83,87,89,92,93,94,95,96,97,98,99,101,102,104,105,106,107,108,109,110,111,112,113,114,116,117,118,119,122,123,124,125,129,133,134,135,136,137,138,139,140,141,142,143,145,147,148,149,151,152,153,155,156,157,158,159,160,161,167,168,169,171,172,173,174,175,176,177,178,182,184,187,189,190,192,193,194,195,196,197,198,199,201,202,203,204,206,207,208,209,210,211,212,213,214,215,216,219,220,222,224,225,227,228,229,232,233,235,236,237,238,242,243,244,245,246,248,249,251,252,253,254,257,258,259,260,261,263,265,266,267,268,269,271,272,274,275,276,279,282,283,284,286,288,289,292,293,294,295,297,299,301,302,304,305,306,307,309,310,312,313,314,315,316,317,318,320,321,322,323,324,325,326,329,330,331,332,333,334,335,336,337,339,340,342,343,344,345,346,347,348,349,350,353,355,356,358,359,360,361,363,365,366,367,368,369,370,372,373,376,378,381,382,385,386,387,391,392,393,395,396,397,399,400,402,403,404,407,408,409,410,411,412,413,414,416,417,418,419,420,421,422,423,424,425,426,428,430,431,432,434,435,436,437,438,439,440,442,443,444,445,446,447,448,449,452,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],use_builtin_typ:[306,416,417],use_datetim:[416,461],use_default_color:[178,460],use_default_map:204,use_env:178,use_errno:[177,462],use_last_error:[177,462],use_load_test:[385,469,472],use_pol:141,use_proxi:242,use_python:311,use_rawinput:157,use_stackcheck:[22,54,472],use_symlink:396,use_xattr:472,usec:[368,469],usecond:19,used:[2,5,7,10,11,12,16,18,19,21,22,23,25,26,27,28,29,30,31,34,37,38,41,45,46,47,50,51,52,53,54,55,56,57,58,60,62,64,65,66,69,70,74,75,77,78,79,81,82,83,85,86,89,90,91,92,93,94,95,96,97,98,99,101,102,103,104,105,106,107,108,109,110,111,112,117,118,119,122,123,124,125,126,127,128,129,130,131,132,133,134,135,136,137,138,139,140,141,142,143,144,147,149,150,151,152,153,154,155,156,157,158,159,161,162,163,164,167,168,169,170,171,172,173,174,176,177,178,180,181,182,183,184,185,187,189,190,191,192,193,195,196,197,198,199,200,201,202,203,204,205,206,207,208,209,210,211,212,213,214,215,216,217,219,221,222,225,227,228,229,230,232,233,235,236,237,238,241,243,244,245,246,247,248,249,251,252,253,254,255,256,257,258,260,261,263,264,265,266,267,268,269,270,271,272,274,275,276,279,281,282,283,284,285,286,287,288,291,292,293,294,295,297,298,299,301,302,304,305,306,307,309,310,311,312,313,314,316,318,319,320,321,322,323,324,325,326,327,328,329,330,331,332,333,334,335,336,337,339,340,342,343,344,345,346,347,348,349,350,351,354,355,356,357,358,359,360,361,363,365,366,367,368,370,371,372,373,375,376,377,378,380,381,382,383,384,385,386,387,391,394,395,396,397,398,399,400,402,403,404,405,407,408,410,411,412,413,414,416,417,418,419,420,421,422,423,424,425,426,427,428,430,431,432,433,434,435,436,437,438,439,440,441,442,444,445,446,448,449,451,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],used_arg:347,used_kei:347,useforeigndtd:316,useful:[1,3,5,7,10,11,30,31,32,50,57,60,65,66,68,72,74,78,79,83,84,85,86,90,91,93,94,95,96,97,98,99,102,103,104,106,110,111,113,118,122,123,124,141,143,149,150,152,153,156,157,158,159,161,162,169,170,177,178,184,187,189,190,193,195,197,203,204,205,206,207,208,210,212,217,219,223,225,227,228,229,232,233,236,237,241,244,246,248,251,252,254,257,260,261,265,266,267,268,271,275,276,278,279,283,287,289,291,292,293,294,295,297,298,299,301,302,304,305,307,310,312,313,315,316,318,320,321,323,324,332,334,336,337,339,340,342,343,344,346,350,355,359,363,366,368,370,372,373,375,376,377,378,380,381,382,385,386,387,390,391,392,393,397,399,400,404,405,407,410,411,412,413,414,424,426,431,432,433,436,437,438,439,440,442,443,444,445,447,448,450,451,453,455,456,457,458,459,460,461,462,463,465,466,467,468,469,470,471,472],usefulli:[346,463],usefulness:[91,94,143,464],usegmt:210,useless:[201,225,386,408,472],usenet:[86,90,103],usenetrc:288,user1:267,user2:267,user32:177,user:[22,26,30,31,38,40,58,60,62,65,68,71,72,73,74,76,77,78,79,80,82,84,85,86,88,89,90,91,92,93,94,95,98,101,102,103,104,105,106,108,109,110,120,122,128,129,131,135,145,153,156,157,158,159,160,161,164,167,168,169,170,172,174,176,178,180,182,184,186,187,188,192,193,201,211,212,213,214,217,225,229,230,231,232,234,236,241,243,244,246,249,252,253,254,257,261,265,266,268,271,272,275,282,284,286,288,292,293,294,295,297,298,299,301,302,307,312,313,314,321,322,324,329,330,332,333,334,335,337,340,341,342,343,344,346,350,355,356,359,360,361,363,366,367,370,372,373,376,377,380,381,385,387,391,392,393,396,397,400,402,404,408,409,410,411,412,416,418,419,422,423,424,425,426,428,432,434,435,436,437,440,441,442,443,445,446,447,448,449,450,451,453,454,455,456,457,458,459,460,461,463,464,465,466,467,468,469,470,471,472,473],user_a:382,user_ag:110,user_b:382,user_bas:[74,111,335,463],user_cal:145,user_class:382,user_except:145,user_id:382,user_lin:145,user_n:397,user_request:466,user_return:145,user_sit:[111,335],user_str:101,userag:393,userbas:[111,466],usercustom:[335,434,468,472],userdict:[62,183,457,459,462,472],userfil:153,userid:[153,268,382,470],userinfo:[110,392],userland:416,userlist:[62,183,458,472],usernam:[104,110,153,174,201,204,231,249,268,293,307,337,391,392,466,467,469,472],userprofil:[111,294],userptr:[180,472],userqueri:465,userspac:467,userstr:[62,183,456,469,472],userwarn:[22,214,231,363,397,446],uses:[5,7,10,22,26,27,28,30,37,38,41,47,53,54,57,58,60,65,66,72,77,79,81,82,83,84,85,90,91,92,93,94,95,97,98,99,101,103,104,105,106,107,109,110,111,112,118,119,122,124,125,128,129,132,133,134,135,137,141,143,144,147,149,151,153,157,158,159,167,170,171,172,174,177,178,182,184,185,187,189,190,193,203,204,206,209,210,211,215,217,221,227,230,232,236,237,238,239,241,243,244,246,248,252,254,257,258,260,264,265,266,267,268,269,271,274,275,276,282,283,284,289,292,293,294,295,299,301,303,304,305,307,309,315,316,320,321,322,323,332,333,334,335,339,340,342,343,344,346,347,348,349,350,354,355,356,359,361,363,365,366,367,370,373,375,377,378,380,382,384,385,386,387,391,392,396,397,399,404,406,407,408,410,411,415,416,418,419,420,422,423,424,425,426,428,430,431,432,436,437,438,442,444,445,446,448,449,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],usestd3asciirul:159,usetk:370,using:[1,3,5,9,10,13,14,17,19,21,22,26,28,30,31,35,37,38,39,41,42,45,49,50,51,53,54,56,57,58,59,60,61,62,64,65,66,68,69,72,74,75,77,78,79,81,82,83,84,87,89,92,93,94,96,97,98,99,101,102,103,106,107,108,109,110,111,112,113,114,117,118,121,122,123,124,125,126,128,129,131,134,135,138,139,141,143,144,147,148,151,152,153,154,155,156,157,158,159,161,162,164,167,168,170,172,174,176,177,178,179,182,184,185,187,188,189,190,193,195,196,198,199,200,201,202,203,204,205,206,207,208,209,210,211,212,214,215,216,217,219,221,225,227,228,229,230,231,232,233,235,236,237,241,243,244,246,248,249,251,252,253,254,257,258,260,261,264,265,266,267,268,271,273,275,276,279,282,284,285,288,290,291,292,293,294,295,296,297,299,301,304,305,306,307,308,309,310,311,313,318,320,321,322,324,326,327,328,330,331,332,333,335,336,337,338,339,340,342,343,345,346,347,348,349,350,355,356,357,358,359,360,361,362,365,366,367,368,369,370,372,373,375,376,378,380,381,382,386,387,391,392,395,396,397,398,399,400,402,404,405,407,408,410,412,413,414,416,417,418,419,421,423,425,426,427,428,430,431,432,433,434,435,436,437,438,439,440,442,443,444,445,446,447,448,449,450,451,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],using_idl:380,usno:447,usr:[30,31,74,77,85,90,99,101,104,109,111,153,168,177,189,201,232,233,272,292,294,298,321,328,335,346,350,355,356,361,367,370,378,392,418,434,444,449,451,453,454,455,457,459,461,466,468,469,472],ustar:[359,462,472],ustar_format:359,ustimezon:184,ustr:456,usuabl:472,usual:[5,7,19,22,26,30,31,35,41,43,57,58,65,66,72,74,75,79,81,84,86,87,90,91,92,93,95,97,98,99,102,104,105,106,107,108,109,110,111,113,117,118,122,124,128,129,131,133,135,141,147,151,153,155,161,174,176,177,187,189,193,195,197,199,203,206,212,214,223,225,227,232,237,244,246,248,249,251,252,253,254,257,258,260,266,268,272,275,284,288,291,292,293,295,299,301,305,306,308,312,321,323,329,333,334,335,339,340,341,342,343,345,346,347,350,355,359,363,367,369,370,372,373,377,382,385,386,387,390,392,398,399,410,418,419,420,423,424,426,432,434,435,436,437,438,439,440,442,444,445,446,448,449,451,454,455,456,457,458,459,460,461,462,463,464,466,468,469,470,472],usub:124,utc:[19,62,184,189,204,210,268,343,367,462,466,469,470,471,472],utc_move_d:184,utcformatt:104,utcfromtimestamp:[184,343,472],utcnow:[184,472],utcoffset:[184,472],utctimetupl:184,utf16:159,utf32:159,utf8:[124,159,204,206,208,209,249,265,307,316,337,355,408,410,451,469,471,472],utf8_decod:456,utf8_en:[249,469],utf8_encod:456,utf8_mod:355,utf8_streamread:456,utf8_streamwrit:456,utf:[5,15,22,28,30,41,53,54,62,104,109,122,124,146,153,168,176,184,189,197,198,206,207,209,210,219,227,236,249,252,257,261,264,265,288,301,307,309,316,331,336,339,340,342,343,346,355,359,375,391,392,396,404,408,410,416,418,419,428,431,437,444,447,451,456,458,459,460,461,462,463,464,465,466,467,468,469,472],utf_16:159,utf_16_b:159,utf_16_l:159,utf_32:159,utf_32_b:159,utf_32_l:159,utf_7:159,utf_8:159,utf_8_sig:[62,146],util:[22,28,29,30,31,62,66,71,74,75,91,99,104,111,120,124,127,135,153,157,159,160,164,178,183,187,188,189,193,195,197,201,204,206,208,209,212,232,239,242,249,251,253,255,269,273,281,285,292,313,317,324,333,338,344,346,348,350,366,370,380,385,388,396,408,447,448,455,456,458,460,461,463,466,467,468,469,470,472],utilis:446,utim:[293,333,467,472],utkarsh:471,utterli:[193,464],utyp:177,uu_codec:[159,472],uucp:268,uudecod:62,uuencod:[62,144,147,159,253,285],uui:82,uuid1:[395,461,471,472],uuid3:[395,461],uuid4:[395,461,472],uuid5:[395,461],uuid:[62,253,255,282,461,472],uuid_creat:472,uuid_enc_b:472,uuidcreat:282,uuidtostr:282,uuu:266,uuuuuu:184,uvloop:[469,470],uxxxx:[159,431],uxxxxxxxx:[159,431],v140:472,v141:472,v142:472,v39:472,v4_int_to_pack:258,v6_int_to_pack:258,v_co:382,va_copi:466,va_list:[5,9,17,22,58,460,469,472],vadi:233,vagu:462,vajda:465,vajraski:[468,469,472],val:[17,21,22,65,79,85,98,99,118,149,168,197,206,225,245,265,346,370,382,387,392,424,461,472],val_a:57,val_b:57,valedictorian:436,valeri:468,valgrind:[463,466,470,472],valid:[3,5,7,10,15,17,22,26,38,57,60,62,65,66,74,78,79,91,93,95,96,97,102,106,109,111,113,122,123,124,140,144,153,158,159,160,161,164,168,170,173,174,176,177,178,182,184,185,187,188,195,196,198,204,208,210,227,239,245,246,252,254,255,257,258,261,264,265,267,269,274,279,282,284,287,288,293,294,297,303,306,310,313,316,320,321,324,325,326,332,336,337,339,343,346,347,349,350,351,355,359,363,367,373,380,382,384,385,386,392,398,402,408,410,412,413,417,419,420,421,423,424,427,428,431,432,436,437,439,442,444,446,447,448,451,456,462,463,464,466,467,468,469,470,471,472],validate_b:471,validate_ucrtbas:472,validator_app:404,validhandl:177,valu:[2,3,6,7,8,9,10,11,12,13,14,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,45,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,65,66,68,69,74,78,80,81,82,84,93,94,96,97,98,102,103,104,105,106,107,108,109,110,111,113,117,119,120,124,125,129,130,131,135,138,139,140,141,142,143,145,147,149,150,151,152,153,154,155,156,157,158,159,160,161,162,163,164,167,169,170,171,174,176,178,179,183,184,185,188,189,190,193,196,197,198,199,201,202,203,204,206,207,209,210,213,214,216,217,218,222,223,225,227,228,229,230,231,232,233,235,236,237,238,239,241,242,243,244,245,246,248,249,250,251,252,253,254,257,258,260,265,266,267,268,269,271,272,274,275,276,279,280,282,283,284,285,287,288,289,290,291,293,294,295,297,298,299,300,301,302,304,305,306,307,308,309,310,311,313,314,315,316,317,318,319,321,322,323,324,326,327,329,330,331,332,333,334,335,336,337,338,339,340,343,345,347,348,349,350,351,352,353,354,355,356,357,359,360,361,363,365,366,367,368,370,372,373,374,375,377,378,380,381,382,384,385,386,390,391,392,393,394,395,396,397,398,399,400,401,403,404,405,407,408,409,410,411,412,413,414,416,417,418,419,420,421,423,425,428,429,431,432,436,438,439,440,441,442,445,446,447,448,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],valuabl:[70,84,97,232,339,377,467],value1:[99,168,461],value2:[99,168,461],value3:168,value_decod:245,value_encod:245,value_nam:402,valuea:168,valueb:168,valuec:168,valueerror:[5,9,17,22,35,37,58,65,91,102,103,110,117,122,123,129,136,139,145,149,158,159,160,161,164,167,168,174,176,177,182,184,187,193,197,198,204,206,209,211,212,214,227,229,244,249,251,252,254,257,258,260,261,266,267,274,275,279,284,292,293,294,298,316,318,320,324,327,330,331,333,334,337,339,343,345,346,347,350,354,355,366,367,384,385,386,391,392,396,405,407,419,426,437,438,439,442,446,458,459,460,461,462,463,464,466,467,468,469,470,471,472],valuelist:459,valueref:[399,461],valuesview:[162,382,472],valur:[463,466,468],valv:292,van:[84,86,91,93,161,370,420,422,456,457,458,459,461,462,463,464,468,469,470,471,472],vandenberg:472,vander:[471,472],vanderbeek:463,vanderpla:320,vanilla:[212,456],vanish:[91,159,237,382,399],vant:466,var_changed_font:472,var_keyword:254,var_num:190,var_posit:254,var_typ:462,vararg:[124,254],vararg_attr:292,vararg_callback:292,varargslist:427,varchar:342,varg:[5,9,22,58],vari:[5,7,53,65,81,84,90,91,93,99,105,106,109,111,143,153,159,176,184,190,193,227,248,251,254,257,265,271,280,297,307,337,340,343,344,346,355,361,363,366,367,386,387,397,424,430,456,457,458,460,462,463,466,467,468],variabl:[3,5,9,11,12,15,17,19,21,22,25,28,29,31,38,41,45,47,48,50,57,58,60,62,64,65,74,77,78,79,81,82,84,85,87,90,92,93,94,97,98,99,104,106,109,110,111,112,113,120,125,128,129,143,153,154,156,157,161,164,175,178,188,190,193,210,212,214,215,216,220,225,227,229,230,231,232,233,246,248,249,250,251,252,253,254,260,265,266,282,284,286,291,294,295,297,299,301,303,308,313,315,317,320,321,322,326,332,333,334,336,339,340,342,344,345,346,347,349,350,352,354,355,359,363,366,367,368,369,373,377,378,380,382,385,386,391,392,396,397,400,402,404,405,407,408,409,417,423,424,425,426,428,431,432,434,435,437,438,439,441,442,443,444,445,446,448,452,453,456,457,458,459,460,461,462,464,466,467,468,469,471,472],variable_nam:93,variad:437,varianc:[345,382,447,468,470,472],variant:[5,21,28,37,43,57,79,86,90,98,99,104,106,109,122,129,132,136,159,161,168,178,184,185,187,204,227,228,246,249,283,284,291,293,294,298,342,343,359,385,386,387,388,392,395,413,424,428,442,446,461,462,463,464,468,471,472],variant_also_negoti:242,variat:[98,106,161,184,193,212,271,293,307,343,424,446,455,461],varieti:[31,58,64,79,81,84,86,99,109,110,112,122,159,183,187,195,225,227,232,273,292,310,346,350,404,428,460,461,462,463,468],variou:[7,19,23,31,38,53,57,59,62,64,65,66,70,74,79,80,81,85,86,91,93,95,97,99,105,106,107,108,109,111,113,119,122,135,147,153,159,161,170,175,177,179,182,187,189,193,195,198,204,209,212,214,217,218,222,229,232,237,243,244,251,252,253,257,258,263,267,273,278,282,285,290,292,293,297,298,300,302,305,310,316,320,328,332,337,339,340,341,343,346,347,349,355,363,367,370,381,384,385,387,392,394,404,406,410,422,424,426,428,431,432,433,435,441,443,446,449,450,451,453,454,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],various:92,variu:151,varkw:254,varnam:[12,472],varnish:343,vartrac:472,vartyp:177,vasiliev:460,vassalotti:[463,465,466,468,472],vast:[72,212,331],vastli:369,vault:457,vaultah:472,vawda:[467,468],vbar:[371,374],vbarequ:374,vc_assembly_publickeytoken:463,vcan0:339,vcruntime140:472,vcvarsal:472,vcxproj:472,vec1:260,vec2:[260,382],vec2d:380,vec:[382,438],vector1:260,vector2:260,vector:[260,275,350,368,380,382,406,472],vectorcal:53,vehicula:151,vel:151,velankar:472,ven:104,vendor:[66,97,236,305,435,455,472],ventur:422,venu:[212,437],venv:[62,93,112,191,253,449,455,467,471,472],ver:111,ver_nt_domain_control:355,ver_nt_serv:355,ver_nt_workst:355,ver_platform_win32_nt:355,verb:[99,107,293,436,437],verbatim:[193,406,422],verbos:[62,65,94,102,103,104,111,122,161,178,188,193,211,228,230,267,292,303,321,332,333,347,355,358,359,363,368,378,385,396,416,424,451,455,458,459,460,462,463,466,468,470,471,472],verbosemodul:424,verdon:462,verhulst:380,veri:[1,7,29,30,31,54,57,62,68,71,74,79,80,81,84,86,90,91,92,93,94,95,97,99,103,104,106,107,108,109,110,111,123,141,151,153,159,161,167,168,170,178,184,187,189,193,197,203,204,207,208,212,227,232,237,243,246,251,252,253,254,265,269,271,284,288,289,292,293,301,310,321,329,331,336,337,339,340,343,348,350,360,367,368,369,372,385,386,387,422,424,426,428,432,435,437,438,440,442,453,455,456,457,458,459,460,461,463,464,466,467,468,469,470,472],verif:[62,238,267,343,466],verifi:[7,62,65,69,81,91,99,101,105,188,193,236,244,252,267,268,337,342,345,363,385,397,404,455,462,463,466,467,468,472],verify_:343,verify_client_post_handshak:[343,471,472],verify_cod:343,verify_crl_check_chain:[343,468],verify_crl_check_leaf:[343,468],verify_default:[343,468],verify_flag:[343,468],verify_messag:343,verify_mod:[343,472],verify_request:[340,472],verify_structur:7,verify_x509_strict:[343,468],verify_x509_trusted_first:343,verifyflag:343,verifymod:343,verisign:343,versa:[66,78,90,143,177,293,294,298,321,346,373,376,410,445,462,468,472],versatil:[93,436,445,448],version2:461,version:[1,5,8,9,10,12,13,16,17,18,19,21,22,23,25,26,28,29,30,31,34,35,36,37,38,39,40,41,43,44,45,47,50,51,52,53,54,55,56,57,58,60,62,64,66,69,70,72,74,75,77,79,80,81,82,83,84,85,91,92,93,94,95,96,97,98,99,101,103,104,106,107,108,109,110,113,116,117,118,119,122,123,124,125,129,131,132,133,134,135,137,139,140,141,142,143,144,145,147,151,152,153,156,158,159,161,162,164,167,168,170,171,174,176,177,178,182,184,185,187,189,190,192,193,194,195,197,198,200,201,202,203,204,206,207,208,209,210,211,212,214,215,216,217,219,222,223,225,227,228,229,232,233,234,235,236,237,238,239,240,241,242,243,244,245,246,248,249,250,251,252,254,256,257,258,260,261,264,265,266,267,268,269,270,271,274,275,276,277,279,282,283,284,286,288,291,293,294,295,296,297,298,299,301,302,304,305,306,307,308,309,310,311,312,313,314,315,316,317,318,320,321,322,323,324,326,327,328,329,330,331,332,333,334,335,336,337,338,339,340,341,342,344,345,346,347,349,350,351,352,353,355,356,357,359,360,361,362,363,365,366,367,368,370,372,373,374,375,376,377,378,380,381,382,384,385,386,387,390,391,392,393,394,395,396,398,399,400,402,404,407,408,409,410,411,413,414,416,417,418,419,420,421,422,423,424,425,426,428,431,432,440,443,444,446,448,449,451,452,453,456,457,458,459,460,461,462,463,464,465,467,468,469,470,471,472,473],version_info:[31,86,105,114,342,355,356,396,446,456,463,465,466,467],version_str:246,versionad:472,versionhelp:472,versioninfo:305,versu:[62,84,184,193,252,320,466],vertch:178,vertex:380,vertic:[178,179,222,299,346,347,365,370,371,372,373,380,430,431],very_long_list_of_fil:84,vessel:466,vestibulum:151,vestigi:[457,472],vewwi:292,vex:[104,457],vfat:472,vformat:347,vfpdef:427,vhost:404,via:[1,7,38,41,57,58,62,65,79,82,86,87,90,91,93,94,99,101,103,110,113,114,117,118,122,125,126,128,132,142,145,153,161,168,171,184,189,193,197,201,202,203,206,207,208,209,214,217,219,222,230,234,237,243,248,251,254,260,264,265,266,267,268,279,284,292,293,297,299,301,304,307,310,316,319,321,322,325,336,337,339,340,342,343,346,347,350,355,356,361,363,380,383,385,386,392,397,402,404,407,410,415,416,423,424,426,436,438,439,450,451,452,453,456,461,462,463,465,467,468,469,470,471,472],vice:[66,78,90,143,177,293,294,298,321,346,373,376,410,445,462,468,472],victim:267,victor:[463,465,466,467,468,469,470,471,472],victorin:471,video:[97,178,272,275,320,450,462],videoread:462,viehland:470,vienna:245,vietnames:159,view:[7,14,21,39,44,57,62,71,90,91,93,97,101,111,122,135,140,161,162,184,187,190,197,201,206,209,227,237,248,257,272,296,310,315,342,344,349,355,370,372,373,380,381,401,402,407,442,456,461,462,466,467,469,472,473],viewabl:373,viewer:[97,248,268,380,472],viewitem:[113,463],viewkei:[113,463],viewvalu:[113,463],vignali:469,vike:350,viktorin:[469,472],vill:472,villag:448,vim:[431,453,468],vinai:[103,104,459,460,462,463,465,466,467,468,469,470,471],vinay_sajip:[103,104],vincent:[343,469,470,472],vindic:464,violat:[15,22,38,57,177,184,204,209,212,216,249,301,307,343,346,382,398,424,436,470,472],violet:380,virginia:[370,422],virtu:[369,418],virtual:[31,62,64,79,91,93,111,112,118,177,178,180,191,211,227,243,253,254,334,339,342,343,355,359,369,381,392,404,424,428,436,441,452,456,462,466,468,470,471,472,473],virtual_env:[396,469],virtualalloc:[38,468],virtualbox:472,virtualenv:[112,455,467],virtualfre:38,viru:92,visibl:[3,31,55,62,79,91,93,95,97,99,104,107,159,161,168,178,180,189,197,206,224,248,254,260,271,339,342,361,373,386,392,397,425,447,455,457,460,461,466,471,472],visit:[26,57,82,93,96,99,124,184,229,293,315,333,344,412,455,456,458,459,462,467],visit_:[84,124],visit_a:84,visit_nam:124,visitfil:344,visitor:[26,124],visitproc:[26,57,82,96],vista:[71,293,373,455,472],visual:[54,65,66,74,83,84,91,97,105,111,321,343,372,380,437,455,456,459,462,469,472],visualstudio:472,vita:461,vitor:[471,472],vixen:104,vlad:472,vladimir:[456,457,459,472],vline:178,vm_name:305,vm_releas:305,vm_vendor:305,vmaddr:339,vmin:362,vminfo:305,voc:[84,338],vocod:446,vogt:[469,472],voic:[104,458],voicila:472,voidcmd:225,voidspac:[110,463],vol:320,volatil:189,volt:[79,437],voltag:[79,227,437],volum:[84,86,161,260,295,419,460,468],volumin:466,volunt:[0,1,66,422,430,462],voluntari:324,voluntarili:[261,293],von:[109,232,320,424,456,458,459,460,461,462,463,466,467,468],vonmisesvari:320,voom:[79,437],vooooom:437,vote:[442,456,461,466],voter:461,vpa:178,vranken:472,vret:82,vrfy:[336,337],vsapi:373,vsnprintf:[17,458],vsprintf:458,vswhere:472,vt100:[97,178],vt_co:382,vt_empti:472,vt_ptr:177,vtabl:463,vtbl_index:177,vtime:362,vulgar:346,vulner:[62,109,129,138,193,238,273,316,342,350,408,409,410,411,416,417,421,461,472],vvv:[94,122,392],vvvv:94,vwait:472,w00t:386,w3c:[110,241,243,392,407,408,412,424,457,472],w3m:400,w3school:342,w_char:30,w_ok:293,wabbit:292,waddstr:[97,467],waddwstr:467,wafer:245,wagner:472,wai:[5,7,9,22,28,30,31,38,40,41,53,57,58,60,62,64,65,66,68,69,70,72,74,75,77,78,79,80,81,82,84,85,86,89,90,92,93,94,95,96,97,98,99,101,102,103,104,105,106,107,109,110,111,112,114,122,123,125,128,129,131,135,139,140,141,143,145,153,156,158,159,160,161,162,164,168,170,172,173,174,176,177,178,182,184,187,189,193,195,196,197,201,202,206,208,209,210,212,220,225,227,230,232,236,237,244,249,251,252,254,256,257,258,265,266,267,268,269,271,274,275,279,281,284,286,291,292,293,295,297,298,299,301,309,310,320,321,326,328,331,332,334,335,337,339,340,342,343,346,349,355,358,359,361,363,366,368,370,372,375,377,380,382,384,385,386,387,391,392,395,397,399,400,404,407,410,412,416,417,418,422,423,424,426,428,430,431,432,434,435,436,437,438,439,440,442,444,445,446,447,448,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],wait3:[293,461,469],wait4:[293,461,469],wait:[60,62,70,79,85,91,92,97,104,107,110,116,117,127,128,129,131,133,134,135,136,138,139,167,178,194,208,209,246,253,254,259,268,283,284,293,295,318,320,324,327,330,334,337,339,340,342,343,344,350,362,363,366,385,392,396,400,437,445,448,459,460,461,462,463,466,467,468,469,470,471,472],wait_clos:[129,137,471,472],wait_for:[127,136,138,139,140,284,366,472],wait_for_data:137,wait_on_a:167,wait_on_b:167,wait_on_futur:167,wait_threads_exit:363,waitabl:[284,293,329],waiter:[139,366,472],waiter_task:139,waitflag:117,waitformultipleobject:[284,472],waitforsingleobject:284,waitid:[293,467,469],waitpid:[134,293,311,461,468,469,472],wake:[139,248,329,334,366,462,472],wakeup:[334,467,471,472],walczak:472,waldman:456,walk:[65,122,124,197,201,205,206,208,270,292,293,298,350,377,405,458,462,464,467,469,472],walk_packag:[304,467,470,471,472],walk_stack:[377,469],walk_tb:[377,469],walker:463,walkthrough:95,walktre:344,wall:[77,78,184,310,367,462],wallclock:368,walli:380,wallnau:345,walter:[459,460,461,462],walwai:[451,459],walzer:[463,466,472],wang:[471,472],want:[0,5,7,22,29,30,31,51,52,57,62,65,66,68,69,70,72,74,75,77,78,79,81,82,83,84,86,87,89,90,92,94,95,96,97,98,99,102,103,104,105,106,107,109,110,111,118,122,124,129,134,137,143,144,145,150,153,154,157,158,160,168,170,177,178,181,184,189,192,193,197,201,202,203,206,209,212,216,219,227,228,230,232,233,236,243,244,246,248,249,251,252,254,265,266,267,268,272,275,276,279,284,289,292,293,294,298,299,301,302,304,310,315,320,321,328,329,330,333,337,339,340,342,343,346,347,350,355,359,361,365,366,370,377,380,382,385,386,387,391,392,395,397,399,404,410,418,419,422,424,425,428,434,435,436,437,438,440,442,445,446,448,449,451,453,454,455,456,457,458,459,460,461,462,463,464,466,467,468,470,472],wantobject:[459,472],ward:[68,71,74,111,456,458,459,460,461,469,472],wardil:468,ware:[463,468,469,471,472],warehous:466,warhawk:470,wari:[82,440],warkentin:467,warm:472,warmup:472,warn:[29,30,31,47,54,62,65,69,74,82,84,91,93,95,101,103,104,105,107,113,120,128,129,182,188,231,232,252,253,267,268,284,310,313,317,321,334,341,342,350,355,359,363,370,385,394,404,411,412,413,424,425,428,431,437,446,447,448,451,456,458,459,460,461,462,464,465,466,468,469,472,473],warn_explicit:[22,397,470,472],warn_on_full_buff:[334,471,472],warner:462,warningcategori:363,warningmessag:[22,470,472],warningrecord:363,warningsrecord:363,warnopt:[54,355,363,397,446,471,472],warrant:[298,397,464],warranti:[236,422],warsaw:[232,456,457,458,460,461,462,466,467,468,469,471,472],wart:[456,464],washington:[99,249],wasn:[21,28,41,65,82,84,86,122,227,268,292,385,420,439,456,458,459,461,462,470,472],wassuccess:385,wast:[84,104,109,464,472],watch:[54,62,103,105,109,132,133,135,137,138,141,187,237,268,329,370,447],watchdog:215,watchedfilehandl:[62,103,120,462,470],watcher:[62,138,472],watchexp:[467,472],water:[132,329,469,472],watermark:[135,137],watson:467,wav:[62,143,253,278,338,403,446],wave:[62,155,253,278,351,456,470,472],wave_read:[62,278],wave_writ:[62,278],waveform:403,wavread:446,wavwrit:446,wbit:421,wchar:[30,472],wchar_:30,wchar_t:[5,15,30,54,60,62,78,79,123,177,418,471,472],wconio:[62,452],wcontinu:293,wcoredump:293,wcslen:58,wcstomb:54,wctype:466,wdefault:[451,463,466,472],wdsi:455,wdv4758h:472,weak:[5,15,57,62,79,80,91,183,214,228,236,253,343,346,369,385,424,441,458,461,463,468,472,473],weaken:472,weaker:[187,457],weakest:174,weakkeydictionari:[399,461,472],weakli:[57,61,81,399],weaklink:459,weakmethod:[399,468],weakref:[22,57,62,81,91,93,183,214,253,284,318,363,448,457,458,460,461,463,472],weakref_ref:5,weakreflist:81,weakset:[399,463],weakvaluedictionari:[399,448,461,472],wealth:464,weapon:438,weav:85,web:[1,62,64,74,90,91,99,104,105,107,109,110,111,125,126,153,222,228,236,245,246,248,253,255,256,268,272,315,342,343,392,393,404,407,417,422,428,441,448,449,450,455,456,457,458,459,460,461,462,468,472,473],web_python:90,webbrows:[62,201,253,255,456,461,472],webdav:[225,242],weber:[459,469,472],webm:472,webp:[250,370,469,472],webpag:309,webprogram:90,webserv:246,websit:[110,185,236,392,430,453,466],websocket:472,webster:472,wed:[152,184],wednesdai:[152,184],weed:75,week:[152,184,265,367,456,472],weekdai:[152,184,268,367,472],weekhead:152,weel:[471,472],wei:[469,472],weibul:320,weibullvari:320,weight:[117,161,177,203,320,347,385,470,472],weighta:143,weightb:[143,472],weikart:461,weinberg:468,weird:[95,122],weird_json:261,welborn:469,welbourn:458,welch:370,welcom:[0,1,78,95,97,141,157,225,284,288,380,422,444,461,466,472],well:[1,5,31,45,47,58,64,65,72,73,74,79,81,82,83,84,85,86,87,90,91,92,93,94,95,99,103,104,105,106,107,109,110,111,112,120,135,138,143,144,145,147,153,154,158,159,161,167,168,170,176,177,178,185,187,193,195,196,198,201,204,205,209,212,216,219,222,225,227,228,229,230,232,235,236,244,248,251,253,257,258,260,262,266,267,268,269,271,274,276,280,288,289,291,292,293,301,309,321,323,326,330,333,337,342,343,346,347,350,355,359,362,363,365,367,368,370,372,375,377,380,381,382,385,386,387,391,399,407,410,411,413,416,424,426,427,428,432,435,436,437,438,439,441,446,448,451,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],wellner:472,welter:459,wena:94,went:[79,94,145,214,295,337,456,458,461,462],were:[1,5,7,9,15,16,17,22,30,31,44,45,57,58,60,65,75,79,81,82,84,89,93,95,96,98,99,103,104,106,107,111,113,114,122,123,124,128,129,135,136,142,145,151,153,159,161,167,168,170,177,178,182,184,187,189,190,193,197,200,201,202,204,206,208,209,212,214,225,227,229,230,236,237,241,243,248,250,252,254,261,266,267,275,276,279,284,289,293,295,297,301,310,316,318,321,331,334,336,337,339,342,346,347,350,355,357,360,363,373,376,378,380,382,383,385,386,387,391,392,396,397,404,409,423,424,426,428,430,432,436,437,439,440,443,446,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],weren:[99,106,236,457,458,459,460,461,463],werneck:462,werror:[105,451,472],weslei:370,west:[159,184,212,367,373,380,465],western:[159,367],westlei:472,weston:472,wexit:293,wexitstatu:293,wfile:[246,340,470,472],wg14:355,wgh:472,what:[1,5,9,18,22,27,28,30,31,36,45,49,53,57,58,62,64,65,66,68,70,72,74,75,78,81,82,84,85,92,93,94,95,99,101,104,105,106,107,109,110,111,113,122,124,135,140,141,153,156,164,168,171,176,177,178,184,186,187,188,200,201,202,204,208,209,212,214,216,225,227,232,236,237,244,245,248,249,250,251,252,260,265,266,267,268,269,272,280,289,293,295,298,300,309,313,316,320,321,322,328,329,333,338,339,340,342,343,345,346,347,348,349,350,352,355,362,363,367,370,372,373,376,380,385,386,387,391,397,407,408,410,418,421,423,425,426,428,430,431,432,436,437,438,439,440,441,446,449,453,455,472],whatev:[5,28,65,70,74,75,79,84,89,90,91,103,104,106,111,122,153,161,177,196,201,209,212,227,252,266,267,292,293,299,313,321,336,346,355,360,366,382,386,387,392,404,426,428,439,446,450,456,457,458,459,460,463,472],whathdr:[338,469,472],whati:299,whats_on_the_telli:423,whatsnew:461,whatsoev:[292,327,422],whatsound:456,wheeeeee:386,wheel:[64,74,112,189,248,320,472],when:[2,5,7,9,10,11,13,14,17,22,28,30,31,32,33,34,35,38,40,41,43,44,45,46,47,49,52,53,54,57,58,60,61,62,64,65,66,69,70,74,75,77,78,79,81,82,83,85,86,87,90,92,93,94,95,96,97,98,99,101,104,105,106,108,109,110,111,112,113,114,115,116,117,118,119,122,123,124,125,127,128,129,130,131,132,134,135,136,137,138,139,140,141,142,143,144,145,148,151,153,154,155,156,157,158,159,161,167,168,169,170,171,173,174,176,177,178,179,182,184,185,187,189,190,193,194,195,196,197,198,199,200,202,203,204,206,207,208,209,210,211,212,214,215,216,219,222,225,227,228,229,230,231,232,235,236,237,238,241,243,244,245,246,248,249,250,251,252,254,256,257,258,260,261,262,265,266,267,268,269,271,275,276,279,282,284,286,287,288,291,292,293,294,295,297,298,299,301,302,303,304,305,306,307,308,310,311,313,315,316,318,319,320,321,322,323,324,325,326,329,330,331,332,333,334,335,336,337,338,339,340,341,342,343,344,345,346,347,348,349,350,351,355,356,357,359,360,361,362,363,366,367,368,370,372,373,374,375,376,377,378,379,380,381,382,385,386,387,390,391,392,394,395,396,397,398,399,400,402,404,406,407,408,410,411,412,413,414,416,417,418,419,420,421,423,424,425,426,428,430,431,432,433,434,436,437,438,439,440,442,444,445,446,447,448,449,451,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],whenc:[155,216,257,279,458],whenev:[22,47,60,79,84,91,98,99,103,104,111,122,135,136,137,178,187,189,208,227,229,248,254,257,266,268,271,284,292,301,316,318,329,334,342,346,355,363,370,373,380,385,386,410,424,428,436,458,459,461,462,463,466,467,468,469,470,471,472],where:[5,22,30,31,34,36,38,41,43,45,49,51,52,53,54,57,58,60,62,65,68,69,72,74,75,79,81,82,83,84,85,89,91,93,94,95,97,98,99,101,102,103,104,106,107,109,110,111,113,114,116,122,124,128,129,135,137,140,141,143,152,153,154,155,156,159,161,164,168,170,177,178,182,184,187,188,189,190,193,194,197,200,202,203,204,206,209,211,212,214,216,222,223,225,227,228,232,236,237,241,243,244,246,248,249,251,252,254,257,258,260,261,264,265,266,267,268,269,271,274,275,276,279,282,283,284,288,289,291,292,293,294,295,296,297,298,299,301,302,304,305,308,310,312,314,315,316,319,321,326,329,332,333,336,337,339,340,342,343,346,347,355,360,362,363,366,367,368,370,373,375,376,377,378,380,381,382,385,387,391,392,395,396,397,399,404,407,408,409,410,412,413,416,418,419,420,422,423,424,425,426,428,430,431,432,434,436,437,438,439,440,442,444,446,448,449,450,451,455,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],wherea:[79,91,92,104,124,138,168,241,261,266,284,297,321,330,355,386,392,396,399,428,437,455,464,472],wherebi:[143,153,267,301,426],wherev:[79,85,95,97,104,106,109,123,161,178,212,342,370,382,394,437,458,461],whet:[62,441,458],whether:[1,7,9,10,13,16,22,31,53,54,57,58,64,65,66,68,79,84,85,91,92,95,97,98,99,102,103,105,106,107,109,111,115,117,118,122,135,140,141,144,145,153,154,156,157,158,159,160,161,162,168,170,177,178,184,187,190,193,197,203,208,209,210,211,221,222,227,232,235,236,244,245,248,252,254,257,258,265,267,268,271,272,275,276,284,292,293,294,295,297,298,299,301,304,309,310,312,313,316,318,319,321,326,328,329,333,334,335,336,337,339,340,343,345,346,348,349,350,355,358,359,361,363,366,367,370,373,376,382,385,386,387,391,392,393,395,396,397,399,402,404,406,407,412,417,418,419,421,422,424,425,426,428,432,436,437,438,439,444,446,451,455,458,459,460,461,462,463,466,467,468,469,470,471,472],which:[0,1,2,3,5,7,9,11,13,14,15,17,21,22,23,24,26,28,29,30,31,32,35,36,38,39,40,41,44,45,47,48,49,51,53,54,55,56,57,58,60,61,62,65,66,68,69,70,72,74,75,77,78,79,81,82,83,84,85,86,87,90,91,92,93,94,95,96,97,98,99,101,102,103,104,106,107,108,109,110,111,112,113,114,115,117,119,122,123,124,125,126,128,129,131,133,134,135,138,139,140,141,142,143,144,145,147,148,149,150,151,152,153,155,156,157,158,159,160,161,162,164,167,168,169,170,171,172,173,174,176,177,178,179,180,182,184,185,187,188,189,190,192,195,196,197,198,201,202,203,204,206,207,208,209,210,212,213,214,215,216,217,219,221,222,223,225,227,228,229,230,231,232,233,235,236,237,238,241,243,244,245,246,248,249,251,252,254,255,256,257,258,260,261,265,266,267,268,269,271,272,275,276,279,280,282,283,284,285,286,288,289,291,292,293,294,295,297,298,299,301,302,303,304,305,306,307,308,309,310,311,312,313,314,315,316,318,319,320,321,322,323,324,327,328,329,330,331,332,333,334,335,336,337,338,339,340,342,343,345,346,347,348,349,350,351,353,355,357,359,360,361,362,363,365,366,367,368,369,370,371,372,373,374,375,376,377,380,381,382,384,385,386,387,391,392,393,395,396,397,398,399,400,402,403,404,405,407,408,409,410,411,413,414,416,417,418,419,420,421,422,423,424,425,426,427,428,430,431,432,434,435,436,437,438,439,440,442,443,444,445,446,447,448,450,451,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472,473],whichdb:[185,464],whichev:[57,79,81,111,184,212,266,349,385,449,467,469],whichmodul:472,whichsid:373,whielacronx:422,while_stmt:[423,427],whilst:387,whit:459,whitacr:109,white:[84,97,106,178,179,200,212,248,350,373,380,392,422,430,448,468,472],whitebox:363,whitelist:[244,391,471,472],whiteout:344,whitespac:[17,58,62,65,68,74,91,92,99,106,109,113,122,129,138,144,147,157,161,168,176,179,187,189,193,200,203,204,209,212,222,223,227,241,246,248,254,261,265,286,299,316,319,321,332,346,347,349,350,358,365,367,377,407,412,433,437,445,451,456,459,462,463,465,466,467,468,471,472],whitespace_split:332,whittl:292,whl:449,who:[1,10,29,66,74,79,84,86,89,102,103,104,108,109,111,129,164,230,232,249,266,274,293,302,324,328,342,343,347,349,359,380,408,418,420,422,442,455,456,458,459,460,461,463,467,470],whoami:346,whoever:84,whole:[17,38,65,69,71,80,85,86,89,95,101,102,106,107,143,152,159,168,170,178,184,208,209,236,243,258,260,265,266,279,292,293,298,307,309,321,329,339,342,346,365,372,385,407,410,421,423,431,435,454,456,463,468,472],wholesal:472,wholli:[258,410],whom:422,whoop:[79,104],whose:[2,5,22,28,30,31,38,41,55,57,65,79,84,91,92,93,94,95,98,104,122,123,124,125,141,161,170,176,177,178,182,184,187,193,199,201,204,206,209,216,217,227,230,234,237,243,244,245,254,257,265,266,267,268,271,274,284,289,292,293,299,301,310,312,314,318,321,324,333,334,335,339,341,346,347,355,361,363,366,367,370,373,376,377,385,387,392,397,399,402,410,412,424,426,428,431,436,438,456,457,458,460,461,462,463,467,468,469,471,472],whrandom:461,why:[1,31,62,79,80,81,88,95,97,99,102,103,105,109,111,118,153,168,177,190,193,202,252,260,271,275,284,292,297,301,333,342,347,385,386,387,404,424,436,439,440,455,458,461,463,471,472],why_:190,why_return:472,why_silenc:190,why_yield:472,wide:[2,29,31,54,58,62,64,65,80,84,86,95,97,99,103,109,111,112,122,132,134,143,152,168,177,178,184,187,193,195,222,244,248,253,254,256,265,271,283,295,301,307,317,331,343,349,350,359,364,367,372,407,422,442,455,458,461,462,463,466,467,468,472],wideman:109,widen:[346,472],wider:[71,95,159,184,274,460,468],widespread:[105,203,430,457,466],widget:[62,87,97,111,120,170,182,248,253,292,296,369,380,385,456,459,460,465,466,470,472],widgetredirector:472,widgettestcas:385,widgit:343,width:[5,58,65,81,91,97,106,119,122,143,152,159,161,177,178,184,187,227,248,282,292,293,309,346,347,351,355,365,367,370,373,380,384,398,424,431,442,445,448,456,459,461,462,463,466,468,470,472],widthxheight:370,wieczorek:463,wiedemann:471,wielgosik:[471,472],wifcontinu:293,wifexit:293,wifsign:293,wifstop:293,wignor:451,wijaya:472,wiki:[86,90,91,99,161,236,260,296,342,343,453,460,461,463,466,467],wikipedia:[99,109,161,236,260,271,343,349,380,461,466,467,472],wilcox:236,wild:[204,432,472],wildcard:[62,221,233,288,332,343,350,385,439,441,471,472],wildfir:107,wildli:456,wildmat:288,willi:236,william:[468,472],willing:[94,292,343,440],wilson:[320,459,460,469,472],win32:[22,58,66,72,90,92,129,135,138,177,268,284,293,305,339,350,355,356,367,383,402,403,455,456,462,464,466,469,472],win32_lean_and_mean:418,win32_ver:[305,472],win32al:305,win32pip:305,win32servic:268,win64:[65,110,383,456,469,472],win95:[62,120],win:[21,30,66,97,104,178,180,237,292,320,356,385,455,465,466],win_amd64:469,win_arm:469,win_ia64:469,winapi:[177,418],wincrypt:472,wind:[66,111,292],windir:402,windll:[177,462],window:[15,22,30,31,38,52,54,57,60,62,64,67,71,72,74,75,77,79,80,84,86,87,88,89,90,91,93,95,103,104,105,107,109,110,112,117,120,123,129,134,135,138,146,153,157,165,167,168,172,177,180,191,192,214,215,224,227,231,233,244,251,252,253,257,268,272,275,276,279,282,283,284,292,293,294,296,298,308,318,329,330,332,333,334,335,337,339,343,344,349,355,356,359,361,363,366,367,369,372,373,375,385,392,394,396,400,404,419,421,422,424,431,434,435,437,442,444,446,449,451,452,453,456,457,458,460,461,464,465,466,468,469,473],window_height:380,window_width:380,windows_util:[471,472],windowsconsoleio:[30,472],windowsdefault:400,windowserror:[22,177,214,402,467],windowspath:298,windowsproactoreventlooppolici:[133,134,135,138,471,472],windowsregistryfind:[252,455,470,472],windowsselectoreventlooppolici:[471,472],wine:[462,472],winerror:[177,214,333,472],winfo_class:373,winfunctyp:177,wing:91,wingwar:91,wininst:66,wink:109,winner:[237,320],winnerlein:236,winpython:455,winreg:[62,253,401,446,464,472],winsock:[329,339,472],winsound:[62,83,253,401,472],winston:467,winter:[99,227,462,463],winton:99,wintyp:177,winuserapi:177,winver:355,winzip:111,wipe:244,wire:[97,103,159,178,266,267,268,343,348,386,416,469],wirtel:[470,471,472],wirtz:472,wisdom:367,wise:[79,182,187,212,436,458,471],wish:[52,65,66,72,79,81,89,95,97,99,103,106,110,111,122,159,161,168,184,193,204,209,235,252,258,261,266,271,279,292,321,337,343,344,350,373,381,396,397,399,404,424,435,440,443,453,457,460,461,462,463,468,472,473],wit:[84,464],witch:447,with_cleanup:190,with_cleanup_finish:190,with_cleanup_start:190,with_cycle_gc:464,with_doc_str:363,with_hostmask:258,with_item:[423,427],with_nam:[298,472],with_netmask:258,with_pip:[396,468],with_prefixlen:258,with_pymalloc:363,with_stat:[114,432,461,462],with_stmt:[423,427],with_suffix:[298,472],with_traceback:[113,214,432],within:[5,7,21,30,38,42,45,47,49,62,64,65,70,79,82,91,93,96,97,99,101,102,104,106,107,112,122,140,156,158,159,164,168,177,178,184,187,189,190,193,196,204,212,217,219,222,227,231,232,248,249,252,254,266,269,271,275,284,285,294,297,299,309,310,314,315,318,320,321,323,326,332,333,339,340,342,346,347,350,354,363,365,368,370,373,380,382,385,386,392,397,407,408,410,417,419,420,423,424,425,426,428,431,432,436,437,438,442,445,446,451,455,456,457,458,459,460,461,462,463,466,467,468,470,471,472],withitem:124,without:[5,7,9,10,11,21,22,24,30,31,34,38,49,50,52,53,54,57,60,62,64,65,70,72,74,75,78,79,81,82,84,85,89,91,93,94,95,97,98,99,101,103,104,106,107,108,111,112,117,118,122,124,128,129,135,136,137,141,142,147,149,151,153,157,159,161,167,168,170,171,172,174,176,177,178,182,184,185,187,189,191,193,195,197,198,203,206,209,210,212,214,215,219,222,225,227,228,230,231,232,233,235,236,237,240,241,244,245,249,251,252,254,256,257,258,260,264,265,266,269,271,279,283,284,288,289,291,292,293,295,297,298,299,301,307,310,311,316,318,320,321,324,325,326,327,329,331,333,335,339,342,343,346,349,350,351,355,359,360,361,363,365,366,367,368,369,370,380,382,385,386,387,392,396,397,398,399,400,404,407,408,410,413,418,419,420,422,423,424,425,426,428,431,432,434,436,437,438,439,442,445,446,447,448,451,452,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],withyear:152,wizard:[104,458],wladmir:462,wlist:329,wmain:418,wmodul:451,wno:472,wnohang:293,wnowait:293,woellert:472,wohlgang:[470,471,472],wojciech:472,wojdyr:466,woken:[167,462],wolfeboro:343,wolfgang:[470,472],wolfson:457,won:[5,30,37,68,79,81,82,84,91,95,97,99,102,103,104,106,109,118,123,124,135,140,153,168,184,185,187,193,207,212,232,233,244,266,268,292,301,302,330,335,339,355,370,386,413,418,421,440,443,451,457,458,460,461,462,463,464,465,466,469,471],wonc:451,wonder:[0,84,91,95,108,153,176,310,342,430,456,459,466],wont:360,wood:122,word:[1,5,10,30,57,62,64,65,66,69,74,79,84,86,91,92,93,95,97,101,106,107,109,122,156,159,161,168,174,177,184,189,193,202,204,209,212,222,237,248,292,298,299,320,321,322,328,332,342,346,347,351,365,366,370,382,396,409,410,414,422,426,428,430,431,432,437,438,441,445,446,453,456,458,460,461,462,464,469,470,471,472],word_list:382,wordchar:332,wordcod:[470,472],work:[5,14,17,22,30,31,32,33,37,38,41,50,52,54,57,58,62,64,65,66,69,74,78,79,82,83,84,85,89,92,93,94,95,96,97,98,99,101,102,103,104,105,106,107,108,109,110,117,120,121,122,123,124,127,128,135,136,137,138,139,140,141,142,146,149,152,153,157,159,161,164,167,168,170,171,177,178,182,184,185,188,189,190,191,198,201,206,208,209,212,216,220,222,225,227,228,230,232,236,241,242,244,246,248,249,251,252,253,254,259,260,263,265,266,268,273,275,284,289,290,291,292,293,294,301,302,304,305,306,307,308,310,311,318,320,321,326,329,331,333,339,340,342,343,346,347,349,350,355,359,361,362,363,365,366,370,372,373,377,379,380,382,385,386,387,389,392,396,397,399,400,402,404,407,408,410,411,416,418,420,422,424,426,427,428,430,432,434,435,436,437,438,439,441,442,444,445,446,447,451,452,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],workaround:[91,193,343,346,387,431,467,472],workdir:66,worker:[62,65,104,136,164,165,167,318,366,461,462,463,469,472],worker_configur:104,worker_process:104,workfil:442,workflow:466,workhors:456,workitem:472,workload:[127,136],workstat:[339,355],world:[62,64,65,66,79,82,85,91,97,102,104,107,131,135,137,140,147,153,170,177,184,222,228,232,236,249,256,279,284,291,292,301,303,312,327,339,340,343,346,361,363,365,366,369,375,380,385,392,404,407,422,431,436,438,439,442,444,450,464,469,470,472],worldwid:[203,236],worri:[31,69,79,81,95,97,103,105,109,111,153,184,195,292,321,349,385,446,458,463,467],wors:[91,106,107,184,212,261,467,468,472],worst:[105,106,107,177,189,237,424,428,451,460,470,471,472],worth:[85,95,119,193,225,267,284,430,431,441,453,456,457,458,461,469],worthi:436,worthwhil:[301,461,467],would:[1,7,17,28,30,31,43,53,54,56,58,65,66,68,69,70,72,74,78,79,81,82,83,84,85,86,89,90,91,92,93,95,97,98,99,103,104,105,106,107,109,111,113,118,123,128,129,131,140,149,153,156,159,161,162,167,168,170,171,173,177,178,182,184,185,187,189,193,197,200,201,203,204,206,208,209,212,213,214,227,228,230,232,235,236,237,241,243,244,246,248,251,252,253,254,256,257,261,266,267,268,272,274,275,276,284,289,292,293,297,298,305,307,309,310,315,320,321,322,324,331,332,333,334,339,340,342,343,344,345,346,347,348,350,355,357,361,363,366,370,373,377,380,384,385,386,387,391,392,396,397,399,400,402,405,407,409,410,418,419,420,422,423,424,426,428,430,431,432,436,437,438,439,440,442,443,445,446,451,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,471,472],wouldn:[65,79,84,90,95,105,106,251,333,363,385,386,423,437,456,457,458,459,460,462],wouter:[456,457,460,461,462,463,469],wow:386,wozniak:468,wparam:177,wrap:[7,17,20,30,39,53,57,62,65,84,85,95,98,101,108,109,113,122,129,131,132,138,140,141,143,150,151,157,159,170,177,178,182,189,190,193,202,203,208,209,221,222,227,228,232,233,235,243,248,252,253,254,257,260,266,267,269,282,284,292,293,296,304,318,334,342,343,346,349,355,357,363,364,370,373,381,382,385,386,387,392,402,404,410,414,423,424,437,448,455,458,459,460,461,462,463,464,466,468,469,470,472],wrap_bio:[343,469,471,472],wrap_futur:131,wrap_lenfunc:472,wrap_socket:[343,462,463,466,471,472],wrap_text:65,wrapcol:144,wrapcolumn:189,wrappabl:472,wrapper:[7,17,20,22,23,24,28,38,40,44,53,54,62,71,84,92,93,97,104,108,129,138,141,147,150,161,168,177,178,190,193,216,228,237,252,253,254,259,275,282,284,287,293,297,304,306,329,339,347,355,363,365,369,377,397,404,407,410,416,423,424,436,447,453,455,456,457,458,460,461,462,463,466,468,469,472],wrapper_assign:228,wrapper_descriptor:[254,460],wrapper_upd:228,wrapperbas:[20,471,472],wrapperdescriptortyp:[381,471,472],wrapperobject:472,wrec:462,wrefresh:178,wrist:447,writabl:[7,39,44,53,81,90,107,122,135,141,151,153,161,249,257,279,284,293,295,306,333,339,340,343,346,349,361,370,399,419,424,428,432,436,460,462,467,469,470,471,472],write:[1,5,7,17,22,23,26,29,30,31,32,37,38,39,53,54,57,58,62,65,66,71,72,75,78,80,81,82,84,86,87,89,92,93,96,97,99,101,102,103,104,105,106,107,111,113,118,121,122,123,125,126,129,132,137,138,140,141,142,144,148,151,153,157,158,159,161,162,164,168,170,171,177,178,181,185,188,193,197,201,202,206,209,212,214,216,218,219,220,222,224,225,227,229,230,232,235,237,244,246,247,248,249,252,253,257,258,261,266,267,268,271,274,278,279,284,286,288,292,293,294,295,298,301,303,306,307,309,310,311,313,319,320,322,329,330,331,332,333,334,339,340,342,343,344,346,349,350,355,357,360,361,364,366,369,373,375,376,378,380,382,385,386,387,394,396,397,401,402,404,407,408,410,412,414,416,418,419,421,424,428,429,432,435,436,437,439,440,441,445,446,447,448,450,451,455,456,457,458,459,460,463,464,465,466,467,468,469,470,471,472],write_byt:[279,298,469,472],write_docstringdict:380,write_eof:[132,135,137,343,472],write_fil:65,write_histori:322,write_history_fil:322,write_lin:104,write_multiple_item:437,write_restrict:81,write_result:376,write_text:[298,469,472],write_through:[257,467,472],write_to_stream:170,writeabl:[161,177,227,257,274,343,350,472],writeal:295,writeback:331,writedoc:472,writefram:[119,351,398,468],writeframesraw:[119,351,398,468],writehead:[176,466],writelin:[132,135,137,159,189,257,456,472],writepi:[419,468],writeplist:[306,462,468],writeplisttobyt:[306,468],writeplisttostr:462,writer:[0,31,38,62,79,82,109,129,137,159,171,193,218,247,257,277,321,370,408,413,451,459,469,471,472],writerow:[176,466,469,472],writestr:[419,463],writetransport:[129,135],writev:[293,467,469,471,472],writexml:408,written:[0,7,9,17,22,23,31,38,45,54,58,62,65,66,69,70,72,74,75,78,79,80,82,84,86,87,89,90,91,93,94,95,97,98,99,104,105,106,107,109,111,113,119,123,129,135,137,138,140,141,147,148,153,154,158,159,164,168,170,176,177,178,185,190,192,193,197,201,203,206,214,215,227,229,231,232,235,236,242,246,248,253,254,256,257,260,268,271,274,279,282,284,288,292,293,295,301,302,303,306,309,310,313,315,322,326,329,331,334,339,340,342,343,346,351,358,359,361,362,363,370,376,378,380,381,385,387,397,398,399,402,404,405,407,410,416,417,418,419,420,422,424,430,431,432,434,435,436,437,438,440,442,445,446,449,450,451,455,456,457,458,459,460,461,462,463,465,466,467,468,469,470,471,472],wrong:[5,15,30,38,74,79,90,91,93,105,106,110,111,122,128,145,177,184,193,213,214,249,275,292,293,295,298,337,342,349,355,367,385,386,392,404,424,445,446,457,459,460,461,462,466,468,472],wrong_document_err:407,wrongdocumenterr:407,wrongli:[99,472],wrote:[91,95,99,340,422,456,458,460,468],ws_comma:113,wsaeinval:472,wsaioctl:[339,462],wsasend:472,wsgi:[62,253,255,461,466,472],wsgi_app:461,wsgi_file_wrapp:404,wsgi_multiprocess:404,wsgi_multithread:404,wsgi_run_onc:404,wsgiref:[62,253,255,466,470,472],wsgirequesthandl:[404,472],wsgiserv:404,wshowwindow:350,wsj:167,wsock:[129,135,137],wss:391,wstop:293,wstopsig:293,wstrict:[77,78,472],wstring_at:177,wtermsig:293,wundram:467,wuntrac:293,wwinmain:418,www:[74,81,85,87,91,99,107,109,110,111,123,141,153,159,163,167,170,184,185,201,228,236,240,241,243,244,249,316,329,342,343,346,355,370,384,391,392,393,400,408,410,421,422,424,431,436,441,450,451,453,454,455,456,457,458,459,460,461,462,463,464,466,467,469,471,472],wxpython:[87,296,453],wxpythonwindow:92,wxwidget:[91,296],wxwindow:296,wxy:460,x00:[105,177,236,257,258,339,346,349,395,472],x00lo:177,x00o:236,x01:[257,258,339,349,395],x02:[248,258,339,349,395],x03:[236,339,346,349,395],x04:[346,395,458],x05:395,x06:[236,395],x07:[248,395],x08:[106,349,395],x08ar:261,x08c:248,x08class:106,x0b:[346,395],x0c:[236,346,395],x0e:395,x0f:395,x0fk:236,x10:[346,458],x11:[74,87,106,373,392,400,472],x11r6:74,x123456:456,x12:[349,395],x13:349,x14:349,x15:[236,349],x17d:328,x1a:472,x1c:346,x1d:346,x1e:[236,346],x32:349,x34:395,x3e:[239,241],x509:[343,392],x509_asn:343,x509_ca:343,x509_v_flag_trusted_first:472,x509_verify_param_set1_host:472,x509_verify_param_set1_ip:472,x509v3:[343,468],x56:[395,456],x64:[66,110,462],x7899:466,x78:395,x7b:472,x7d:472,x80:[109,302,458],x80abc:109,x80abcd:109,x84:[236,462],x85:346,x86:[177,302,349,455,462,471,472],x86_64:[65,356,469,472],x87:462,x87_double_round:463,x89:462,x8b:328,x93:236,x94:[109,236],x95:236,x9c:458,x_ok:[293,333],x_root:370,xa5u:236,xa6:236,xa8:258,xac:109,xae:328,xaf:[236,462],xatom:249,xattr:363,xattr_creat:293,xattr_replac:293,xattr_size_max:293,xavier:[468,470,471,472],xb4:109,xb6:328,xbar:345,xbb:[104,431],xbcn:236,xbcrdigkeiten:466,xbf:[104,431],xbm:[250,370,372],xc0:[258,458],xc1:458,xc3:466,xc5:236,xc9:458,xc_:370,xc_hand2:370,xcode:472,xcompil:111,xcor:380,xd4:328,xd6sterreich:342,xdd:236,xde:109,xdf:[236,306],xdg:467,xdr:[62,123,218,253,301,349],xdrlib:[62,123,218,253,349,472],xdummi:380,xe0:283,xe2:[328,462],xe3:[328,462],xe4:109,xe4n:265,xe4ssig:306,xe8:346,xea:109,xebp1:328,xebr:328,xef:[104,391,431],xenial:471,xenix:213,xf0:346,xf1:346,xf2:346,xf6stal:203,xf7:236,xfc:346,xfd:236,xfe:236,xff:[346,467],xgettext:232,xhdr:288,xhh:431,xhhhh:456,xhtm:392,xhtml1:[110,392],xhtml:[62,110,239,240,253,273,316,392,407,408,410,466],xhtml_namespac:407,xiang:[470,471,472],xiao:[471,472],xicluna:[463,466],xid_continu:431,xid_start:431,xkcd:[328,342],xlib:[74,370],xlinker:[78,111],xlinux:459,xlist:329,xml11:[316,408,410],xml:[13,62,74,86,99,106,109,159,227,253,255,257,273,296,306,392,415,447,448,455,457,458,459,460,461,462,463,466,470,472,473],xml_cquant_non:316,xml_cquant_opt:316,xml_cquant_plu:316,xml_cquant_rep:316,xml_ctype_ani:316,xml_ctype_choic:316,xml_ctype_empti:316,xml_ctype_mix:316,xml_ctype_nam:316,xml_ctype_seq:316,xml_declar:[410,463],xml_error_:316,xml_error_abort:316,xml_error_async_ent:316,xml_error_attribute_external_entity_ref:316,xml_error_bad_char_ref:316,xml_error_binary_entity_ref:316,xml_error_cant_change_feature_once_pars:316,xml_error_duplicate_attribut:316,xml_error_entity_declared_in_p:316,xml_error_external_entity_handl:316,xml_error_feature_requires_xml_dtd:316,xml_error_finish:316,xml_error_incomplete_p:316,xml_error_incorrect_encod:316,xml_error_invalid_token:316,xml_error_junk_after_doc_el:316,xml_error_misplaced_xml_pi:316,xml_error_no_el:316,xml_error_no_memori:316,xml_error_not_standalon:316,xml_error_not_suspend:316,xml_error_param_entity_ref:316,xml_error_partial_char:316,xml_error_publicid:316,xml_error_recursive_entity_ref:316,xml_error_suspend:316,xml_error_suspend_p:316,xml_error_syntax:316,xml_error_tag_mismatch:316,xml_error_text_decl:316,xml_error_unbound_prefix:316,xml_error_unclosed_cdata_sect:316,xml_error_unclosed_token:316,xml_error_undeclaring_prefix:316,xml_error_undefined_ent:316,xml_error_unexpected_st:316,xml_error_unknown_encod:316,xml_error_xml_decl:316,xml_n:456,xml_namespac:407,xml_param_entity_parsing_alwai:316,xml_param_entity_parsing_nev:316,xml_param_entity_parsing_unless_standalon:316,xml_sethashsalt:472,xml_text:410,xmlcharrefreplac:[109,159,227,257,346,459,472],xmlcharrefreplace_error:159,xmldeclhandl:316,xmlfilterbas:414,xmlgener:414,xmlid:410,xmllib:456,xmln:[316,392,410,463,472],xmlns_namespac:407,xmlpars:456,xmlparser:[62,273,463,468,472],xmlparsertyp:316,xmlproc:456,xmlproc_pars:74,xmlproc_val:74,xmlpullpars:[62,273,468,472],xmlreader:[62,253,273,409,411,412,414,469],xmlrole:456,xmlrpc:[62,253,255,301,406,422,447,458,464,468,472],xmlrpclib:[406,458,459,460,461,462,463,464,472],xmltok:456,xmpeg:272,xnn:109,xnnn:241,xoff:179,xon:179,xor:[187,291,426],xor_expr:[426,427],xover:288,xpath:[62,273,288,406],xpm:372,xpot:232,xrang:[113,457,458,459,460,464],xrbl82xr:392,xreadlin:[113,457,459,460],xref:288,xscrollcommand:373,xsl:458,xtaddinput:87,xterm:[97,178,472],xvec:436,xview:373,xxlimit:472,xxmodul:79,xxx:[103,122,124,333,428,463,465,467,472],xxxloader:468,xxxmessag:104,xxxmodul:467,xxxx:[431,472],xxxxxxxx:431,xyz:[91,122,266,267,346,385,466],xyzyx:122,xyzz:122,xzip:66,xztar:[65,66,75,333,469,472],y2038:472,y2k:367,y_n:472,y_root:370,yaari:[469,472],yahoo:[86,185,461,462],yai:140,yakov:456,yamamoto:[463,467,471,472],yaml:[103,261,267,463,466],yann:[469,470],yapaxi:177,yasskin:[462,463,466],ycor:380,ydai:184,ydummi:380,year:[19,86,93,106,152,176,184,193,261,367,410,419,422,431,442,455,457,459,461,462,463,464,465,466,467,472],yeardatescalendar:152,yeardays2calendar:152,yeardayscalendar:152,yee:[456,457,458,461],yello:91,yellow:[62,97,149,161,178,212,253,380,388,448,460],yeltsin:342,yen:[471,472],yeo:472,yep:95,yes:[7,65,87,101,168,193,265,266,316,321,343,370,404,410,422,437,455,466],yes_vot:442,yesexpr:265,yesterdai:472,yet:[2,5,7,12,13,22,26,28,30,41,57,58,65,79,84,85,86,87,90,91,92,94,95,97,105,106,112,114,129,131,135,138,140,153,167,170,177,178,187,193,197,198,206,214,229,237,256,284,293,295,299,310,311,335,337,343,350,366,377,386,407,410,421,425,432,435,436,442,446,456,458,459,461,463,468,470,471,472],yet_another_extens:168,yield:[9,27,58,62,81,84,91,93,99,114,118,124,135,139,140,145,151,153,161,167,168,170,184,189,190,198,208,225,227,233,236,243,251,254,257,260,261,271,284,293,298,301,304,321,332,342,346,349,359,363,377,382,386,387,391,395,404,407,410,416,423,424,427,429,431,436,440,458,459,461,462,463,466,467,468,469,470,471,472],yield_arg:427,yield_atom:426,yield_expr:427,yield_express:[426,431,432],yield_from:[190,426,472],yield_stmt:[427,432],yield_valu:190,yieldfrom:124,yieldtyp:382,ying:472,yinyang:380,yiq:[163,468],yiq_to_rgb:163,yogesh:468,yolanda:472,yongzhi:472,yoni:472,york:184,you:[0,1,5,12,15,21,22,28,30,31,34,35,37,39,41,44,45,47,51,54,55,57,58,60,61,62,64,65,66,68,69,72,74,75,78,79,81,82,83,85,86,87,89,92,93,94,95,96,97,99,101,102,103,104,106,107,108,109,110,111,113,117,118,119,122,124,125,129,135,141,142,143,144,147,148,151,152,153,154,155,156,157,159,160,161,162,167,168,170,171,174,176,177,178,179,180,181,182,184,185,186,187,188,189,191,193,196,197,199,201,202,203,206,207,208,209,212,214,215,216,219,223,225,227,228,229,231,232,233,235,236,237,239,243,244,245,246,247,248,249,250,251,252,254,256,257,258,261,264,265,266,267,268,269,271,272,274,275,279,284,288,289,292,293,294,295,298,299,301,302,306,307,308,309,310,315,316,320,321,322,328,329,330,331,332,333,334,336,337,339,340,341,342,343,344,345,346,347,349,350,355,356,359,360,361,363,365,366,368,369,370,372,373,376,377,380,381,382,385,386,387,391,392,395,396,397,398,399,400,402,404,405,406,407,408,409,410,411,412,414,416,417,418,419,421,422,424,426,427,428,430,432,434,435,436,437,438,439,440,441,442,444,445,446,449,450,452,453,454,455,456,457,458,459,460,461,462,463,464,466,467,468,469,470,471,472],young:422,youngest:229,your:[1,5,19,30,31,54,57,62,64,65,66,68,69,70,72,74,75,78,79,80,81,82,83,84,85,86,87,89,90,91,92,93,94,96,97,99,103,106,107,109,110,111,112,113,120,122,125,135,141,143,154,160,161,168,178,182,184,186,188,193,197,199,201,202,203,206,208,212,214,224,225,227,228,229,235,236,243,244,245,246,247,248,252,254,255,257,261,265,266,267,268,271,279,284,293,298,299,300,301,307,308,310,311,315,320,321,322,328,329,330,332,333,334,335,336,337,339,340,343,344,345,346,347,349,350,352,360,361,362,363,365,366,367,368,370,372,378,380,382,385,386,392,396,397,399,404,407,408,410,412,416,417,418,419,422,430,432,434,436,437,438,440,441,442,443,444,446,449,450,451,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472],your_cod:133,your_computed_bia:310,your_dict:193,your_function_impl:95,your_integer_time_func:310,your_time_func:310,yourhostnam:153,yournam:92,yourscript:292,yourself:[5,30,31,39,57,62,78,84,91,93,95,97,106,107,109,111,124,157,178,180,193,202,252,261,265,266,292,299,329,337,342,343,355,385,386,387,407,440,442,454,455,461,464,466],yourtransform:124,youtub:109,yscrollcommand:373,ysj:[468,472],ython:470,yuan:472,yuck:[107,446],yum:101,yummli:201,yuor:321,yuri:[466,467,468,469,470,471,472],yve:460,yvec:436,yview:373,ywjj:467,yyi:[122,428],yyyi:[184,249],z123fg:346,z1spam:346,z9t:236,z_0:321,z_best_compress:421,z_best_spe:421,z_block:421,z_default_compress:421,z_default_strategi:421,z_filter:421,z_finish:421,z_fix:421,z_full_flush:421,z_huffman_onli:421,z_no_compress:421,z_no_flush:421,z_partial_flush:421,z_rle:421,z_sync_flush:421,zach:[468,472],zachari:[463,468,469,471,472],zack:468,zackeri:472,zadka:[456,457,458,460],zaki:472,zane:472,zap:[190,268],zastub:418,zbcefg:346,zbigniew:[467,472],zdict:[421,472],zebra:[104,161,301],zeitouni:472,zekun:471,zen:93,zephyr:104,zero:[4,5,7,14,17,22,26,28,30,31,34,35,38,41,45,47,57,58,72,79,81,82,90,91,93,95,102,103,104,106,108,109,117,122,124,129,135,136,139,143,144,147,152,156,157,159,161,177,178,182,184,187,189,193,197,210,214,222,227,228,229,233,235,236,237,243,248,249,251,252,257,258,260,266,268,271,275,279,284,292,293,299,316,318,320,321,322,329,334,337,339,342,343,344,345,346,347,349,350,355,359,362,365,366,367,373,380,385,394,402,407,410,419,421,424,425,426,430,431,432,437,438,439,442,444,445,448,451,456,459,460,461,462,463,464,466,467,468,469,470,471,472],zero_all_var:382,zerodict:461,zerodivisionerror:[22,97,104,184,187,214,223,284,426,432,439,446,447,459,465,466,469],zeromq:62,zeromqsockethandl:[104,472],zeromqsocketlisten:[104,472],zesti:104,zevenhoven:470,zfill:[346,442,459],zgf0ysb0bybizsblbmnvzgvk:144,zhang:[470,471,472],zhime:471,ziad:69,ziegler:463,ziga:463,zijlstra:[470,471,472],zinfo_or_arcnam:419,zip64:[419,461,472],zip:[62,65,66,72,75,91,93,99,111,113,121,147,159,167,191,227,252,253,260,281,320,333,346,347,359,363,406,428,436,438,446,448,449,455,456,460,461,462,463,464,465,466,469,470,471,472,473],zip_basenam:363,zip_bzip2:419,zip_defl:[419,448],zip_dir:363,zip_longest:[227,260,464],zip_lzma:419,zip_stor:[419,472],zipapp:[62,191,253,472],zipextfil:[419,466,472],zipfil:[62,65,66,75,121,253,264,326,333,359,397,418,428,447,448,451,456,461,462,463,465,472],zipimport:[62,253,281,304,428,459,461,465,472],zipimporter2:472,zipimporterror:420,zipinfo:[62,121,462,470,472],zlib:[30,62,90,104,106,111,121,159,235,236,253,333,363,419,447,458,459,461,472],zlib_codec:159,zlib_runtime_vers:[421,467],zlib_vers:421,zlibmodul:95,zmod:456,zmq:104,zodb:[91,458],zombi:[248,284,340,363,461,467,472],zone:[19,184,210,339,367,410,422,459,461,463,472],zoneh:106,zoneinfo:[184,367],zonem:106,zonen:106,zongker:472,zoo:[380,423],zooko:[236,422],zoom:[248,472],zoot:346,zope9:466,zope9inst:466,zope9instal:466,zope:[86,91,422,457,458,466],zsh:396,zsolt:463,ztar:[65,66,75],zvi:472,zyz:346,zzdummi:[248,472],zzz:[138,428]},titles:["About these documents","Dealing with Bugs","Abstract Objects Layer","Allocating Objects on the Heap","API and ABI Versioning","Parsing arguments and building values","Boolean Objects","Buffer Protocol","Byte Array Objects","Bytes Objects","Capsules","Cell Objects","Code Objects","Codec registry and support functions","Complex Number Objects","Concrete Objects Layer","Context Variables Objects","String conversion and formatting","Coroutine Objects","DateTime Objects","Descriptor Objects","Dictionary Objects","Exception Handling","File Objects","Floating Point Objects","Function Objects","Supporting Cyclic Garbage Collection","Generator Objects","Importing Modules","Python/C API Reference Manual","Initialization, Finalization, and Threads","Introduction","Iterator Protocol","Iterator Objects","List Objects","Integer Objects","Mapping Protocol","Data marshalling support","Memory Management","MemoryView objects","Instance Method Objects","Module Objects","The None Object","Number Protocol","Old Buffer Protocol","Object Protocol","Object Implementation Support","Reference Counting","Reflection","Sequence Protocol","Set Objects","Slice Objects","Stable Application Binary Interface","Common Object Structures","Operating System Utilities","Tuple Objects","Type Objects","Type Objects","Unicode Objects and Codecs","Utilities","The Very High Level Layer","Weak Reference Objects","Python Documentation contents","Copyright","Distributing Python Modules","9. API Reference","5. Creating Built Distributions","8. Command Reference","3. Writing the Setup Configuration File","6. Examples","7. Extending Distutils","Distributing Python Modules (Legacy version)","1. An Introduction to Distutils","The Python Package Index (PyPI)","2. Writing the Setup Script","4. Creating a Source Distribution","Uploading Packages to the Package Index","4. Building C and C++ Extensions","1. Embedding Python in Another Application","1. Extending Python with C or C++","Extending and Embedding the Python Interpreter","3. Defining Extension Types: Assorted Topics","2. Defining Extension Types: Tutorial","5. Building C and C++ Extensions on Windows","Design and History FAQ","Extending/Embedding FAQ","General Python FAQ","Graphic User Interface FAQ","Python Frequently Asked Questions","\u201cWhy is Python Installed on my Computer?\u201d FAQ","Library and Extension FAQ","Programming FAQ","Python on Windows FAQ","Glossary","Argparse Tutorial","Argument Clinic How-To","Porting Extension Modules to Python 3","Curses Programming with Python","Descriptor HowTo Guide","Functional Programming HOWTO","Python HOWTOs","Instrumenting CPython with DTrace and SystemTap","An introduction to the ipaddress module","Logging HOWTO","Logging Cookbook","Porting Python 2 Code to Python 3","Regular Expression HOWTO","Socket Programming HOWTO","Sorting HOW TO","Unicode HOWTO","HOWTO Fetch Internet Resources Using The urllib Package","Installing Python Modules (Legacy version)","Installing Python Modules","2to3 - Automated Python 2 to 3 code translation","__future__ \u2014 Future statement definitions","__main__ \u2014 Top-level script environment","_dummy_thread \u2014 Drop-in replacement for the _thread module","_thread \u2014 Low-level threading API","abc \u2014 Abstract Base Classes","aifc \u2014 Read and write AIFF and AIFC files","Generic Operating System Services","Data Compression and Archiving","argparse \u2014 Parser for command-line options, arguments and sub-commands","array \u2014 Efficient arrays of numeric values","ast \u2014 Abstract Syntax Trees","asynchat \u2014 Asynchronous socket command/response handler","asyncio \u2014 Asynchronous I/O","High-level API Index","Developing with asyncio","Event Loop","Exceptions","Futures","Low-level API Index","Platform Support","Policies","Transports and Protocols","Queues","Streams","Subprocesses","Synchronization Primitives","Coroutines and Tasks","asyncore \u2014 Asynchronous socket handler","atexit \u2014 Exit handlers","audioop \u2014 Manipulate raw audio data","base64 \u2014 Base16, Base32, Base64, Base85 Data Encodings","bdb \u2014 Debugger framework","Binary Data Services","binascii \u2014 Convert between binary and ASCII","binhex \u2014 Encode and decode binhex4 files","bisect \u2014 Array bisection algorithm","builtins \u2014 Built-in objects","bz2 \u2014 Support for bzip2 compression","calendar \u2014 General calendar-related functions","cgi \u2014 Common Gateway Interface support","cgitb \u2014 Traceback manager for CGI scripts","chunk \u2014 Read IFF chunked data","cmath \u2014 Mathematical functions for complex numbers","cmd \u2014 Support for line-oriented command interpreters","code \u2014 Interpreter base classes","codecs \u2014 Codec registry and base classes","codeop \u2014 Compile Python code","collections \u2014 Container datatypes","collections.abc \u2014 Abstract Base Classes for Containers","colorsys \u2014 Conversions between color systems","compileall \u2014 Byte-compile Python libraries","Concurrent Execution","The concurrent package","concurrent.futures \u2014 Launching parallel tasks","configparser \u2014 Configuration file parser","Built-in Constants","contextlib \u2014 Utilities for with-statement contexts","contextvars \u2014 Context Variables","copy \u2014 Shallow and deep copy operations","copyreg \u2014 Register pickle support functions","crypt \u2014 Function to check Unix passwords","Cryptographic Services","csv \u2014 CSV File Reading and Writing","ctypes \u2014 A foreign function library for Python","curses \u2014 Terminal handling for character-cell displays","curses.ascii \u2014 Utilities for ASCII characters","curses.panel \u2014 A panel stack extension for curses","Custom Python Interpreters","dataclasses \u2014 Data Classes","Data Types","datetime \u2014 Basic date and time types","dbm \u2014 Interfaces to Unix \u201cdatabases\u201d","Debugging and Profiling","decimal \u2014 Decimal fixed point and floating point arithmetic","Development Tools","difflib \u2014 Helpers for computing deltas","dis \u2014 Disassembler for Python bytecode","Software Packaging and Distribution","distutils \u2014 Building and installing Python modules","doctest \u2014 Test interactive Python examples","dummy_threading \u2014 Drop-in replacement for the threading module","email \u2014 An email and MIME handling package","email.charset: Representing character sets","email.message.Message: Representing an email message using the compat32 API","email.contentmanager: Managing MIME Content","email.encoders: Encoders","email.errors: Exception and Defect classes","email: Examples","email.generator: Generating MIME documents","email.header: Internationalized headers","email.headerregistry: Custom Header Objects","email.iterators: Iterators","email.message: Representing an email message","email.mime: Creating email and MIME objects from scratch","email.parser: Parsing email messages","email.policy: Policy Objects","email.utils: Miscellaneous utilities","ensurepip \u2014 Bootstrapping the pip installer","enum \u2014 Support for enumerations","errno \u2014 Standard errno system symbols","Built-in Exceptions","faulthandler \u2014 Dump the Python traceback","fcntl \u2014 The fcntl and ioctl system calls","filecmp \u2014 File and Directory Comparisons","File Formats","fileinput \u2014 Iterate over lines from multiple input streams","File and Directory Access","fnmatch \u2014 Unix filename pattern matching","formatter \u2014 Generic output formatting","fractions \u2014 Rational numbers","Program Frameworks","ftplib \u2014 FTP protocol client","Functional Programming Modules","Built-in Functions","functools \u2014 Higher-order functions and operations on callable objects","gc \u2014 Garbage Collector interface","getopt \u2014 C-style parser for command line options","getpass \u2014 Portable password input","gettext \u2014 Multilingual internationalization services","glob \u2014 Unix style pathname pattern expansion","grp \u2014 The group database","gzip \u2014 Support for gzip files","hashlib \u2014 Secure hashes and message digests","heapq \u2014 Heap queue algorithm","hmac \u2014 Keyed-Hashing for Message Authentication","html \u2014 HyperText Markup Language support","html.entities \u2014 Definitions of HTML general entities","html.parser \u2014 Simple HTML and XHTML parser","http \u2014 HTTP modules","http.client \u2014 HTTP protocol client","http.cookiejar \u2014 Cookie handling for HTTP clients","http.cookies \u2014 HTTP state management","http.server \u2014 HTTP servers","Internationalization","IDLE","imaplib \u2014 IMAP4 protocol client","imghdr \u2014 Determine the type of an image","imp \u2014 Access the import internals","importlib \u2014 The implementation of import","The Python Standard Library","inspect \u2014 Inspect live objects","Internet Protocols and Support","Introduction","io \u2014 Core tools for working with streams","ipaddress \u2014 IPv4/IPv6 manipulation library","Networking and Interprocess Communication","itertools \u2014 Functions creating iterators for efficient looping","json \u2014 JSON encoder and decoder","keyword \u2014 Testing for Python keywords","Python Language Services","linecache \u2014 Random access to text lines","locale \u2014 Internationalization services","logging \u2014 Logging facility for Python","logging.config \u2014 Logging configuration","logging.handlers \u2014 Logging handlers","lzma \u2014 Compression using the LZMA algorithm","macpath \u2014 Mac OS 9 path manipulation functions","mailbox \u2014 Manipulate mailboxes in various formats","mailcap \u2014 Mailcap file handling","Structured Markup Processing Tools","marshal \u2014 Internal Python object serialization","math \u2014 Mathematical functions","mimetypes \u2014 Map filenames to MIME types","Miscellaneous Services","Multimedia Services","mmap \u2014 Memory-mapped file support","modulefinder \u2014 Find modules used by a script","Importing Modules","msilib \u2014 Read and write Microsoft Installer files","msvcrt \u2014 Useful routines from the MS VC++ runtime","multiprocessing \u2014 Process-based parallelism","Internet Data Handling","netrc \u2014 netrc file processing","nis \u2014 Interface to Sun\u2019s NIS (Yellow Pages)","nntplib \u2014 NNTP protocol client","numbers \u2014 Numeric abstract base classes","Numeric and Mathematical Modules","operator \u2014 Standard operators as functions","optparse \u2014 Parser for command line options","os \u2014 Miscellaneous operating system interfaces","os.path \u2014 Common pathname manipulations","ossaudiodev \u2014 Access to OSS-compatible audio devices","Other Graphical User Interface Packages","parser \u2014 Access Python parse trees","pathlib \u2014 Object-oriented filesystem paths","pdb \u2014 The Python Debugger","Data Persistence","pickle \u2014 Python object serialization","pickletools \u2014 Tools for pickle developers","pipes \u2014 Interface to shell pipelines","pkgutil \u2014 Package extension utility","platform \u2014 Access to underlying platform\u2019s identifying data","plistlib \u2014 Generate and parse Mac OS X .plist files","poplib \u2014 POP3 protocol client","posix \u2014 The most common POSIX system calls","pprint \u2014 Data pretty printer","The Python Profilers","pty \u2014 Pseudo-terminal utilities","pwd \u2014 The password database","py_compile \u2014 Compile Python source files","pyclbr \u2014 Python class browser support","pydoc \u2014 Documentation generator and online help system","xml.parsers.expat \u2014 Fast XML parsing using Expat","Python Runtime Services","queue \u2014 A synchronized queue class","quopri \u2014 Encode and decode MIME quoted-printable data","random \u2014 Generate pseudo-random numbers","re \u2014 Regular expression operations","readline \u2014 GNU readline interface","reprlib \u2014 Alternate repr() implementation","resource \u2014 Resource usage information","rlcompleter \u2014 Completion function for GNU readline","runpy \u2014 Locating and executing Python modules","sched \u2014 Event scheduler","secrets \u2014 Generate secure random numbers for managing secrets","select \u2014 Waiting for I/O completion","selectors \u2014 High-level I/O multiplexing","shelve \u2014 Python object persistence","shlex \u2014 Simple lexical analysis","shutil \u2014 High-level file operations","signal \u2014 Set handlers for asynchronous events","site \u2014 Site-specific configuration hook","smtpd \u2014 SMTP Server","smtplib \u2014 SMTP protocol client","sndhdr \u2014 Determine type of sound file","socket \u2014 Low-level networking interface","socketserver \u2014 A framework for network servers","spwd \u2014 The shadow password database","sqlite3 \u2014 DB-API 2.0 interface for SQLite databases","ssl \u2014 TLS/SSL wrapper for socket objects","stat \u2014 Interpreting stat() results","statistics \u2014 Mathematical statistics functions","Built-in Types","string \u2014 Common string operations","stringprep \u2014 Internet String Preparation","struct \u2014 Interpret bytes as packed binary data","subprocess \u2014 Subprocess management","sunau \u2014 Read and write Sun AU files","Superseded Modules","symbol \u2014 Constants used with Python parse trees","symtable \u2014 Access to the compiler\u2019s symbol tables","sys \u2014 System-specific parameters and functions","sysconfig \u2014 Provide access to Python\u2019s configuration information","syslog \u2014 Unix syslog library routines","tabnanny \u2014 Detection of ambiguous indentation","tarfile \u2014 Read and write tar archive files","telnetlib \u2014 Telnet client","tempfile \u2014 Generate temporary files and directories","termios \u2014 POSIX style tty control","test \u2014 Regression tests package for Python","Text Processing Services","textwrap \u2014 Text wrapping and filling","threading \u2014 Thread-based parallelism","time \u2014 Time access and conversions","timeit \u2014 Measure execution time of small code snippets","Graphical User Interfaces with Tk","tkinter \u2014 Python interface to Tcl/Tk","tkinter.scrolledtext \u2014 Scrolled Text Widget","tkinter.tix \u2014 Extension widgets for Tk","tkinter.ttk \u2014 Tk themed widgets","token \u2014 Constants used with Python parse trees","tokenize \u2014 Tokenizer for Python source","trace \u2014 Trace or track Python statement execution","traceback \u2014 Print or retrieve a stack traceback","tracemalloc \u2014 Trace memory allocations","tty \u2014 Terminal control functions","turtle \u2014 Turtle graphics","types \u2014 Dynamic type creation and names for built-in types","typing \u2014 Support for type hints","Undocumented Modules","unicodedata \u2014 Unicode Database","unittest \u2014 Unit testing framework","unittest.mock \u2014 mock object library","unittest.mock \u2014 getting started","Unix Specific Services","urllib \u2014 URL handling modules","urllib.error \u2014 Exception classes raised by urllib.request","urllib.parse \u2014 Parse URLs into components","urllib.request \u2014 Extensible library for opening URLs","urllib.robotparser \u2014 Parser for robots.txt","uu \u2014 Encode and decode uuencode files","uuid \u2014 UUID objects according to RFC 4122","venv \u2014 Creation of virtual environments","warnings \u2014 Warning control","wave \u2014 Read and write WAV files","weakref \u2014 Weak references","webbrowser \u2014 Convenient Web-browser controller","MS Windows Specific Services","winreg \u2014 Windows registry access","winsound \u2014 Sound-playing interface for Windows","wsgiref \u2014 WSGI Utilities and Reference Implementation","xdrlib \u2014 Encode and decode XDR data","XML Processing Modules","xml.dom \u2014 The Document Object Model API","xml.dom.minidom \u2014 Minimal DOM implementation","xml.dom.pulldom \u2014 Support for building partial DOM trees","xml.etree.ElementTree \u2014 The ElementTree XML API","xml.sax \u2014 Support for SAX2 parsers","xml.sax.handler \u2014 Base classes for SAX handlers","xml.sax.xmlreader \u2014 Interface for XML parsers","xml.sax.saxutils \u2014 SAX Utilities","xmlrpc \u2014 XMLRPC server and client modules","xmlrpc.client \u2014 XML-RPC client access","xmlrpc.server \u2014 Basic XML-RPC servers","zipapp \u2014 Manage executable Python zip archives","zipfile \u2014 Work with ZIP archives","zipimport \u2014 Import modules from Zip archives","zlib \u2014 Compression compatible with gzip","History and License","8. Compound statements","3. Data model","4. Execution model","6. Expressions","10. Full Grammar specification","5. The import system","The Python Language Reference","1. Introduction","2. Lexical analysis","7. Simple statements","9. Top-level components","16. Appendix","1. Whetting Your Appetite","9. Classes","4. More Control Flow Tools","5. Data Structures","8. Errors and Exceptions","15. Floating Point Arithmetic: Issues and Limitations","The Python Tutorial","7. Input and Output","14. Interactive Input Editing and History Substitution","2. Using the Python Interpreter","3. An Informal Introduction to Python","6. Modules","10. Brief Tour of the Standard Library","11. Brief Tour of the Standard Library \u2014 Part II","12. Virtual Environments and Packages","13. What Now?","1. Command line and environment","Python Setup and Usage","4. Using Python on a Macintosh","2. Using Python on Unix platforms","3. Using Python on Windows","What\u2019s New in Python 2.0","What\u2019s New in Python 2.1","What\u2019s New in Python 2.2","What\u2019s New in Python 2.3","What\u2019s New in Python 2.4","What\u2019s New in Python 2.5","What\u2019s New in Python 2.6","What\u2019s New in Python 2.7","What\u2019s New In Python 3.0","What\u2019s New In Python 3.1","What\u2019s New In Python 3.2","What\u2019s New In Python 3.3","What\u2019s New In Python 3.4","What\u2019s New In Python 3.5","What\u2019s New In Python 3.6","What\u2019s New In Python 3.7","Changelog","What\u2019s New in Python"],titleterms:{"2to3":113,"4rc1":[],"4rc2":[],"abstract":[2,65,81,95,96,97,98,105,106,107,118,124,162,252,289,462],"boolean":[6,212,292,346,426,459],"break":[432,437],"byte":[8,9,109,164,177,328,346,349,391,431,462,469],"case":[84,111,385,457],"catch":[85,170],"class":[22,65,84,85,91,98,118,122,124,158,159,162,167,182,200,212,214,217,232,252,254,257,282,284,289,301,310,314,318,330,346,349,380,381,382,385,386,387,390,392,404,412,423,424,431,436,458,461,462,467,470],"const":122,"default":[38,91,95,122,182,292,342,343,386,397,437,455,463,468],"enum":[212,468,469,470,471],"export":177,"final":[30,81,170,399,461,468,472],"float":[24,84,187,346,431,440,448,460],"function":[5,7,8,13,15,25,41,54,58,65,79,84,85,91,95,98,99,106,108,131,152,153,156,161,164,167,170,173,174,177,178,180,182,190,212,226,227,228,252,254,258,260,266,267,270,275,283,288,291,314,320,325,328,339,342,343,345,346,347,349,350,355,356,361,367,378,379,380,381,382,385,387,397,402,410,416,422,423,426,437,446,456,457,460,461,462,464,467,469,470,471],"goto":84,"import":[28,91,251,252,266,267,268,281,387,420,428,432,446,457,459,460,461,462,467,468],"int":[96,346],"long":[92,96,458,460],"new":[65,70,86,99,111,292,397,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,473],"null":[79,95,346],"public":[164,380],"return":[84,91,95,177,387,432],"short":[94,105],"static":[91,98,101,105,254],"switch":[84,467],"try":[91,170,423,461],"while":[84,87,423],Added:463,Adding:[70,82,104,122,289,292,463,467,470],And:[90,95,464],Are:[86,90,91,193,468],DNS:129,FOR:422,For:[97,265,397,463],IDE:453,IDEs:454,Ice:79,Its:444,NIS:287,One:151,TLS:[30,129,343],That:99,The:[38,42,60,65,66,73,79,82,94,95,97,99,105,106,108,109,110,111,122,166,216,217,222,232,234,252,253,254,284,289,292,299,308,310,312,341,346,370,382,386,397,406,407,410,413,418,423,424,426,428,429,432,434,437,438,441,442,444,446,453,455,458,459,460,461,462,463,466],Use:[104,105,106,370],Used:350,Useful:[31,103,283],Uses:424,Using:[1,83,95,102,103,104,106,107,108,110,111,113,153,170,212,236,284,310,342,350,356,366,372,373,380,387,438,444,445,453,454,455,461,462,467],With:[424,471],__builtin_new:85,__del__:[91,399],__dunder__:212,__enter__:170,__future__:[114,457],__import__:91,__index__:461,__main__:[115,428,471],__new__:212,__path__:428,__pure_virtu:85,__slots__:424,__spam:91,__spec__:428,_dummy_thread:116,_someclassname__spam:91,_sunder_:212,_thread:[116,117],a_tupl:91,abbrevi:122,abc:[118,162,252,289,466,467,468,469],abi:[4,466],about:[0,86,91,153,193,436,456],absolut:461,abstractbasicauthhandl:392,abstractdigestauthhandl:392,accept:339,access:[58,66,85,90,168,177,212,220,251,264,265,267,295,297,298,305,342,354,356,367,402,416,422,424,447,458,471],accessor:407,accord:395,acknowledg:[99,109,232,422,456,457,458,459,460,461,462,463],across:[91,104],action:[122,292,439],adapt:342,add_argu:122,add_help:122,added:[85,169],addit:[74,91,208,342,346,381,410,453,455,469],address:[102,258,284],advanc:[30,94,95,103,193,462],adverb:321,after:215,agreement:422,aifc:[119,468,471],aiff:119,aka:212,algorithm:[149,236,237,269,468],alias:[382,385],align:[177,349],all:[65,84,91,133,284,292,321,387,463,469,470],alloc:[3,30,38,81,378,459,468],allow:[84,212],allow_abbrev:122,alon:91,alpha:472,alreadi:464,also:91,altern:[85,104,111,320,323,430,443,455],ambigu:358,among:90,analysi:[91,190,332,431],angular:275,ani:[65,85,86,90,170,382,386],anim:380,annot:[432,437,470,471],anoth:[78,91],ansi:159,anyth:85,api:[4,5,8,13,29,30,38,58,65,79,96,117,127,129,132,168,193,197,208,211,212,232,342,350,378,396,407,410,418,459,460,461,462,463,464,465,466,467,468,469,470,471,472],appear:[91,380],appendix:434,appetit:435,appli:[91,387],applic:[52,78,80,87,90,92,97,104,159,232,241,248,418,453,455,461,469],approach:[83,464],appropri:424,approxim:[252,469],arbitrari:[79,85,103,292,437],archiv:[65,121,333,359,418,419,420,459],archive_util:65,area:65,arena:38,argpars:[94,122,463,466,468,469,471],argument:[5,91,94,95,122,177,292,293,350,387,437,444,447,455,468,470],argument_default:122,argumentpars:122,argv:122,arithmet:[84,187,258,289,426,440,448],around:65,arrai:[7,8,91,123,149,177,261,467,470],articl:[86,110],ascend:108,ascii:[58,147,179,391],ask:88,assert:[106,387,432],assign:[84,432,456],associ:455,assort:81,ast:[124,462,466,470],async:[57,423,469],asynchat:[125,470],asynchron:[30,125,126,141,334,340,422,424,426,470],asyncio:[126,128,140,171,468,469,470,471],asyncor:[141,466,470],atexit:142,atom:426,attach:386,attr:407,attribut:[81,82,84,91,97,174,212,254,266,288,292,293,346,386,387,413,424,426,428,457,458,470,471],attributesn:413,au_read:351,au_writ:351,audio:[143,295],audioop:[143,468],augment:[432,456],authent:[110,238,284],auto:212,autom:113,automat:[212,248],autospec:386,avail:[101,184,256,380,397],averag:345,avoid:90,await:[128,140,424,426,469],awar:[109,469],babyl:271,babylmessag:271,back:79,background:[265,292],backport:463,backquot:350,backslash:[84,106],barrier:366,base16:144,base32:144,base64:[144,467,468],base85:144,base:[65,91,104,118,135,140,158,159,162,185,214,232,252,257,284,289,366,404,412,428,462,463,466,471],basehandl:392,baserotatinghandl:268,basic:[82,94,95,103,108,110,112,141,184,193,237,261,298,368,370,372,385,417,418,424],batteri:447,bcppcompil:65,bdb:145,bdist:65,bdist_dumb:65,bdist_msi:65,bdist_packag:65,bdist_rpm:65,bdist_wininst:65,been:86,befor:[30,86],begin:86,behavior:[184,468,469,470,471],behaviour:168,beopen:422,best:[91,111,328,343],beta:[86,472],better:469,between:[74,83,91,105,109,147,163,284,292,431],beyond:[78,122],bin:350,binari:[52,64,65,90,91,105,107,112,146,147,159,257,346,349,416,426,448],binascii:[147,467,470,471],bind:[87,248,370,425],binhex4:148,binhex:148,bio:[343,469],bisect:149,bit:[177,254,402,464],bitwis:[346,426],blake2:236,blank:431,block:[90,92,104,105,107,128,343,378,410,464],bodi:424,bom:[104,159],book:86,bookkeep:320,bootstrap:[211,463,468],borland:[65,111],boundedsemaphor:139,branch:463,breakpoint:[91,471],brief:[447,448],browser:[244,314,400],buffer:[5,7,44,57,104,135,257,322,462,467],bug:[1,30,86,91,373],build:[5,31,65,77,79,83,111,192,409,410,454,457,459,460,461,462,463,464,465,466,467,468,469,470,471,472],build_clib:65,build_ext:65,build_pi:65,build_script:65,built:[58,66,99,150,169,214,227,346,381,456,460,471],builtin:[150,386,425,464,467,472],bunch:90,bundl:455,bytearrai:[346,469],bytecod:[190,428,470,471],bz2:[151,467,469],bzip2:151,cab:282,cach:428,cacheftphandl:392,calcul:[84,445],calendar:[152,471],calibr:310,call:[79,84,85,86,91,95,99,177,216,292,308,386,387,422,426,469],call_lat:129,call_soon:129,callabl:[228,254,342,382,424],callback:[129,177,292,459],calltip:248,can:[84,85,86,87,89,90,91,92,252,301],cancel:140,candid:472,capsul:[10,96,463],captur:106,care:153,catalog:[232,265],categori:[22,397],caveat:[30,265,418],ccompil:65,cdatasect:407,cell:[11,178],central:345,certif:[343,463,466,468],cfuhash:422,cgi:[90,153,154,469],cgitb:154,cgixmlrpcrequesthandl:417,chain:[269,343,387],chainmap:161,chang:[86,91,95,96,103,232,380,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471],changelog:472,charact:[58,106,178,179,196,261,349],charset:196,check:[8,65,69,91,92,105,174,193,252,292,321,387,424],checker:404,choic:122,chomp:91,choos:64,chunk:155,cipher:343,circu:86,classif:156,claus:437,clean:[65,170,439],cleanup:[284,292,468],clear:22,client:[135,137,141,225,243,244,249,284,288,307,337,343,360,415,416,463,466,468,469,470,471],clinic:[95,468],clock:367,clone:95,close:90,cmath:[156,469,470],cmd:[65,157],cmp:108,cnri:422,cobject:96,code:[12,30,31,84,91,95,105,109,110,113,122,128,129,158,160,242,248,252,254,346,368,385,397,437,444,459,466,467,468,469],codec:[13,58,159,459,466,467,468],codegear:111,codeop:160,codepag:159,coercion:[457,471],collabor:64,collect:[26,82,84,161,162,190,456,463,466,467,468,469,470,471],collector:229,colon:84,color:[97,163,248,380],colorsi:[163,468],column:[342,373],com:422,combin:[94,212,343],combinator:99,combobox:373,comma:[84,91,459],command:[65,67,70,122,125,157,164,189,211,230,248,254,261,292,293,299,302,359,363,368,372,375,376,385,418,419,447,451,455,463,466,467,468,470],comment:[407,431],common:[53,90,106,112,153,294,308,342,346,347,464],commun:259,compar:[109,399,438],comparison:[81,102,212,217,258,301,346,426,457,464],compat32:197,compat:[105,295,332,373,421],compil:[65,66,78,79,84,85,96,106,111,160,164,297,313,354,446,455],compileal:[164,469,471],complet:[248,322,325,329,433,443],complex:[7,14,108,156,346,387],complianc:261,complic:91,compon:[90,391,433],compos:99,compound:[7,380,423],comprehens:[99,438,456,470],compress:[121,151,269,421,447],comput:[89,189,378],concaten:[91,431],concept:[72,94,95],conclus:94,concret:[15,214,298],concurr:[128,140,165,166,167,466,469,470,471],condit:[96,139,292,366,422,426,438,461],condition:104,config:[65,111,267],configpars:[168,466,469],configur:[30,65,68,103,104,111,168,267,335,356,380,453,455,463,466],conflict:[94,292],conflict_handl:122,conform:[404,407],connect:[90,129,135,267,284,339,342],consid:105,consider:[343,350,428],consol:[158,283,470],constant:[138,156,169,178,187,236,275,316,339,342,343,347,350,353,367,374,402],constructor:[91,232,350],contain:[15,84,122,161,162,258,424],content:[62,84,85,86,87,90,91,92,98,176,198,212,308,316,321,334,335,339,407],contenthandl:412,contentmanag:198,context:[16,104,170,171,187,193,248,284,342,343,346,397,424,460,461,462,467],contextlib:[170,461,462,466,467,468,469,470,471],contextu:104,contextvar:[171,471],contigu:7,continu:[105,177,432,437],contribut:1,contributor:0,control:[22,54,66,82,342,362,379,380,397,400,437,447],conveni:[258,400,416],convers:[17,156,163,177,258,275,367,426,460],convert:[91,95,109,147,297,342,350],cookbook:[83,104],cooki:[244,245,422],cookiejar:244,cookielib:460,cookiepolici:244,coordin:156,cope:387,copi:[86,90,91,172],copyreg:173,copyright:[63,86],copytre:333,core:[65,91,257,456,471,472],coroutin:[18,128,140,254,381,423,424,469],correspond:[298,380],count:[31,47,79],counter:161,coupl:370,coverag:105,cprofil:[310,471],cpython:[80,84,101,468,470,471],creat:[30,58,64,65,66,67,75,80,85,86,90,91,99,102,107,122,129,138,140,207,212,236,260,292,297,339,387,396,418,424,449,468],create_autospec:386,creation:[41,102,293,340,343,381,396,424,470],credit:236,cross:[66,305],crypt:[174,467,471],cryptograph:175,csv:[176,466,469],ctype:[177,284,461,462,466],current:[91,112,129,254],curs:[90,97,178,179,180,467,469],cursor:342,custom:[38,95,103,104,111,122,134,168,177,181,204,212,258,267,269,284,310,342,347,424,434,455,468,470,471],cwi:422,cx_freez:455,cycl:456,cyclic:[26,82],cygwin:[65,111],cygwincompil:65,data:[37,65,74,82,84,90,91,99,103,105,107,109,110,121,137,143,144,146,155,177,182,183,269,285,300,301,305,309,319,349,366,370,405,424,438,442,447,448,460,464],databas:[90,185,234,282,312,341,342,384],dataclass:[182,471],datagram:135,datagramhandl:268,datahandl:392,datatyp:[161,168,459],date:[103,129,184,447,459],datetim:[19,184,416,466,467,470,471],dbm:[185,466,468,469,470,471],deal:[1,104],debug:[31,65,74,85,99,128,129,153,186,193,248,451,463],debugg:[30,91,145,299],debuggingserv:336,decim:[187,448,460,466,467,470,471],declar:431,decod:[148,159,261,319,394,405],decompress:269,decor:[108,170,182,382,386,387,460,462],dedic:469,deep:172,def:84,defaultcookiepolici:244,defaultdict:161,defect:200,defer:232,defin:[81,82,91,102,267,292,382,437,439,466],definit:[84,98,109,114,240,258,423,436,470],defusedexpat:406,defusedxml:406,del:[432,438],delai:129,deleg:[91,467],delet:[89,90,91,386,456],delimit:431,delta:189,demo:[380,472],denot:105,dep_util:65,depend:[65,105,397],deprec:[58,361,385,456,459,460,462,463,465,466,467,468,469,470,471],deprecationwarn:471,dequ:161,deriv:[91,212,236],descend:108,describ:[74,397],descript:[122,212,316],descriptor:[20,98,129,215,293,386,424,458,468,470],design:84,dest:122,destin:104,detail:[31,102,105,265,267,345],detect:[105,128,358],determin:[250,338,424],determinist:310,dev:[329,471],develop:[86,128,188,248,302,456,462,471],devic:295,devot:86,diagnost:455,dialect:176,diamond:458,dict:[104,346,386,387,470],dictconfig:104,dictionari:[21,84,104,267,346,387,426,438,463,465,466,467],did:91,die:107,differ:[83,91,105,189,212,236,378,380],difflib:[189,469],digest:236,dir:446,dir_util:65,dircmp:217,direct:[8,193,457],directli:[129,252],directori:[65,217,220,282,293,333,361,446,462,466,469],dis:[190,466,468,471],disambigu:470,disassembl:190,disconnect:107,discov:91,discoveri:385,dispatch:301,displai:[97,103,129,178,378,426,457],dist:65,distinguish:385,distribut:[64,65,66,67,69,70,71,74,75,77,191,320,453],distutil:[65,70,72,77,111,192,456,459,469,470,471],divis:[105,458],dll:[83,92,177],doc:90,doccgixmlrpcrequesthandl:417,docstr:[193,380],doctest:[193,460,468,469],doctestfind:193,doctestpars:193,doctestrunn:193,document:[0,1,62,86,90,99,202,315,407,410,417,437,462,463,466,467,468,471,472],documenttyp:407,docxmlrpcserv:417,doe:[84,86,91,92],doesn:[84,90],dom:[407,408,409,456],domain:159,domainfilt:378,domeventstream:409,domimplement:407,don:[90,91],done:86,download:455,draw:380,drop:[105,116,194],dtdhandler:412,dtoa:422,dtrace:[101,470],dumb:[65,185],dummi:284,dummy_thread:194,dump:215,duplic:[91,212],duplicatefreeenum:212,dure:103,dynam:[30,177,381,425],each:91,eas:99,easi:456,easier:91,echo:[135,137,141],edg:329,edit:[91,248,443],editor:[92,248,454],effect:387,effici:[91,123,260,342],eintr:469,elabor:104,element:[99,407,410],elementtre:[410,461,463,466,467],elimin:469,ellipsi:[51,346],els:437,email:[195,196,197,198,199,200,201,202,203,204,205,206,207,208,209,210,466,467,468,469,470],emb:[92,265],embed:[31,78,80,85,455,456],embedd:455,emul:[84,297,424],enabl:[101,129,463,468],encod:[13,58,109,144,148,159,199,261,319,391,394,405,431,444,459,470],end:[84,97,108,436],enforc:84,enhanc:[459,462,463,470],ensur:212,ensurepip:[211,463,468],entiti:240,entityresolv:412,entri:[424,428],enumer:[212,459],envbuild:396,environ:[115,293,396,404,444,449,451,455,463,467,469,470],epilog:122,epol:329,equal:469,equival:[90,91],errno:213,error:[13,22,65,79,91,110,129,159,187,200,282,292,297,316,390,434,439,440,447,459],errorhandl:412,escap:58,etc:[90,91],etre:[410,467,468,471],evalu:[85,426,470,471],event:[87,104,129,132,139,327,334,366,370,373,380],everi:387,examin:[193,354],exampl:[38,69,72,79,82,98,101,103,104,122,125,129,135,136,137,138,141,142,149,151,157,161,167,168,170,173,174,176,189,193,201,212,215,235,236,237,241,243,244,245,249,251,252,269,271,280,284,292,297,301,306,307,309,311,316,320,321,322,330,331,333,334,337,339,340,343,347,349,357,359,360,361,362,366,368,375,377,378,385,387,392,395,396,399,404,408,410,416,417,418,420,426,436],except:[22,31,65,79,84,91,103,104,110,127,128,130,136,167,168,170,182,193,200,214,258,261,271,284,297,316,339,342,343,345,349,350,387,390,405,407,410,425,439,461,462,463,464,467],exchang:284,exclus:122,excursu:455,execut:[85,90,92,129,165,193,248,326,334,363,368,376,418,422,424,425,434,446,455,461],executor:167,exist:[87,95,135,387],exit:[84,122,142],expans:233,expat:[316,422],expaterror:316,expect:[86,385],explan:105,explicit:[431,462,467,468],explicitli:84,express:[84,85,95,99,106,109,321,426,432,433,436,437,460,461],extend:[70,78,79,80,85,292,293,396,456,459],extens:[30,64,65,69,74,77,79,80,81,82,83,85,90,96,111,112,180,248,265,304,372,392,467,469],extern:[267,301],extract:[79,85],facil:266,factori:[104,161,182,258],fail:[85,102,469],failur:[248,385],fallback:168,famili:[67,339,350],fancier:442,fancy_getopt:65,faq:[84,85,86,87,89,90,91,92,187],fast:[84,316],faster:469,fault:[215,416],faulthandl:[215,467,469,470],fcntl:216,featur:[105,282,425,461,463,467,468,469,470,471],feedback:106,feedpars:208,fetch:[110,254],field:[7,161,177],file:[23,31,58,65,68,74,75,85,90,91,92,95,103,104,105,109,111,119,122,129,148,151,168,176,193,215,217,218,220,235,248,252,257,267,269,272,279,282,283,286,293,306,308,313,322,333,338,351,359,361,370,372,394,398,410,433,434,442,446,447,454,455,459,466,468,469,470,471],file_util:65,filecmp:[217,468],filecookiejar:244,filehandl:[268,392],fileinput:[219,470],filelist:65,filenam:[109,221,276],filesystem:[298,470],filetyp:122,fill:[365,380],filter:[104,266,269,376,378,397],filter_dir:386,find:[85,90,91,177,280,321,410,455],finder:428,finer:[82,212,467],first:[86,95,436,445],fix:[187,292,457,458,459,463],fixer:113,fixtur:385,flag:[106,111,122,170,193,212,254,292],flexibl:467,flow:[103,437],fltk:87,fly:[86,232],fnmatch:221,footnot:110,forc:471,foreign:177,forkserv:284,form:[90,372,426],formal:99,format:[7,17,103,104,176,218,222,248,267,271,284,301,346,347,349,359,418,431,442,448,462,463,464,465,469,470],formatt:[103,104,222,266],formatter_class:122,foundat:86,fraction:[223,462,466],frame:[378,470],framesummari:377,framework:[145,224,340,385,457,467],freebsd:[454,463],freed:84,freez:87,frequent:[88,350],from:[30,65,79,85,90,91,92,103,104,140,156,170,177,207,219,283,350,380,387,420,446,455,459,462],fromfile_prefix_char:122,frozen:182,frozenset:346,ftp:[225,466],ftp_tl:225,ftphandler:392,ftplib:[225,467],full:[427,455],functool:[99,228,466,467,468,469,471],fundament:[15,177],further:387,futur:[86,114,129,131,167,432,463,466,469,470,471],future_builtin:462,garbag:[26,82,84,229,456],gatewai:[153,404,466],gener:[27,58,72,81,86,87,90,91,95,99,120,140,152,202,222,240,254,292,298,306,315,320,328,334,343,346,354,361,382,387,424,426,436,451,458,459,460,461,469,470,471],geometri:372,get:[1,84,86,87,90,91,94,102,134,137,378,387,453,454,455],getopt:[65,230],getpass:231,gettext:[232,471],geturl:110,gil:30,given:91,glob:[233,468,469],global:[30,90,91,301,432],glossari:93,gmt:104,gnu:[111,185,232,322,325],gnutransl:232,goal:95,good:[86,105],grain:467,grammar:[124,427],graphic:[87,296,369,380],greedi:106,group:[84,95,99,106,122,234,292,385],grp:[234,470],gtk:87,gui:[87,282,453],guid:[64,91,98,292,386],guidelin:284,gzip:[235,421,466,469],handi:370,handl:[22,87,110,129,178,195,244,272,285,292,297,301,343,385,389,402,434,439,459,462,463,468,469],handler:[13,90,103,104,110,125,129,141,142,159,215,266,268,334,340,370,404,412],happen:[91,103],hard:85,has:91,hash:[174,236,238,346,468,471],hashlib:[236,461,466,468,470],have:[84,86,87,91,105],header:[65,110,137,203,204,404,467],headerregistri:204,heap:[3,237],heapq:[237,469],hello:[126,129,370],help:[90,91,122,248,292,315,380],helper:[124,189,347,350,386],hexadecim:91,hierarch:372,hierarchi:[135,214,257,424,462,467],high:[30,60,78,127,257,330,333,350],higher:[91,153,228],highlight:[467,468,469,470,471],hint:[265,382,469],histori:[84,99,107,322,422,443],hkey_:402,hmac:[238,467,468,471],home:111,hook:[252,322,335,428,457,459],host:[102,258],how:[64,84,85,86,87,90,91,92,95,108,111,112,193,212,292,328,370,380,453],howto:[98,99,100,103,106,107,109,110],html:[90,239,240,241,466,467,468],htmlparser:241,http:[137,141,242,243,244,245,246,404,463,466,467,468,469,470,471],httpbasicauthhandl:392,httpconnect:243,httpcookieprocessor:392,httpdigestauthhandl:392,httperror:110,httperrorprocessor:392,httphandler:[268,392],httpmessag:243,httppasswordmgr:392,httppasswordmgrwithpriorauth:392,httpredirecthandl:392,httprespons:243,httpshandler:392,hyperbol:[156,275],hypertext:239,ident:426,identifi:[305,373,426,431],idl:[248,456,463,465,466,468,469,470,471,472],idlelib:[468,469,470,471],idna:159,ifdef:95,iff:155,imag:[250,370,372],imaginari:431,imap4:249,imaplib:[249,466,467,469],imghdr:[250,469],immut:[84,346],imp:251,impart:104,implement:[46,84,85,90,104,129,170,185,222,237,252,261,289,323,404,408,424,430,467,468,470,471],implementor:289,implicit:[431,467],import_modul:252,importlib:[252,428,463,467,468,469,470,471],improv:[332,456,457,458,459,460,461,462,463,465,466,467,468,469,470,471],inaccur:84,includ:[31,447],incompat:86,incomplet:[85,177],incorpor:422,increas:187,increment:[151,159,267],incrementaldecod:159,incrementalencod:159,incrementalpars:413,indent:[84,248,358,431],independ:[7,87,460],index:[65,73,76,84,91,127,132,342,370,459,461],indic:22,individu:[65,74,298],infinit:261,infix:469,info:110,inform:[65,86,97,104,282,293,324,356,445],inherit:[85,182,293,380,436,458,468],ini:[168,455],init:[182,322],initi:[30,41,79,96,469],input:[85,90,97,178,219,231,375,380,433,442,443],inputsourc:413,insensit:457,insert:[92,104],insid:469,inspect:[102,254,466,467,468,469,470],instal:[64,65,66,67,74,89,111,112,153,192,211,282,356,453,454,455,456,468],install_data:[65,67],install_head:65,install_lib:65,install_script:[65,67],instanc:[40,91,102,182,198,212,301,346,424,436],instant:310,instead:[84,95,105,342,464],instruct:190,instrument:101,integ:[35,91,258,320,346,431,458,460,462,464],integr:[70,105,266],intenum:212,interact:[138,158,193,425,433,434,443,444,457,461],interchang:468,interest:[212,410],interfac:[38,52,84,85,87,90,102,153,185,189,211,222,229,254,257,258,261,287,293,296,301,302,303,322,339,342,359,363,368,369,370,376,385,392,403,413,418,419,447,451,466],intermezzo:[79,437],intermix:122,intern:[251,267,274,346],internation:[159,203,232,247,265],internet:[90,110,255,285,348,447],interoper:261,interpol:168,interpret:[30,80,84,90,157,158,181,254,344,349,381,418,443,444,458,461,462,463],interprocess:259,intflag:212,intra:446,introduc:94,introduct:[31,72,98,99,102,106,109,110,111,153,252,256,284,310,330,342,380,430,445,449,456,457,458],introspect:[140,254],invalid:[85,122,428],invoc:350,invok:[98,424,444],ioctl:216,ipaddress:[102,258,467,468,469,471],ipc:107,ipv4:258,ipv6:258,irix:462,isn:84,issu:[1,22,112,215,342,359,428,440,455,462],item:[91,373],iter:[32,33,91,99,205,212,219,258,260,346,385,387,424,426,436,458,460,464,469],itertool:[99,260,466,467,471],itself:342,java:305,javascript:462,job:111,join:[84,431],json:[261,301,442,462,469,470],just:112,keep:92,kei:[64,84,87,108,112,236,238,248,284,343,467],kevent:329,keypress:[90,92],keyword:[79,91,262,431,437,469,470],kind:90,kivi:87,known:455,kqueue:[329,422],label:373,lambda:[84,91,99,426,437],languag:[84,86,91,232,239,263,347,380,429,456,459,460,461,462,463,465,466,467,468,469,470,471],larg:308,larger:80,latest:454,latin:58,launch:167,launcher:[455,467,469],layer:[2,15,60,110,469],layout:[373,448],learn:105,legaci:[71,95,111,168,350,392,471],len:84,length:[85,236],less:387,let:342,level:[30,41,60,78,91,103,106,115,117,127,132,153,182,257,258,261,266,329,330,333,339,350,433,469],lexic:[332,431],lib2to3:113,libffi:422,libmpdec:422,librari:[65,74,90,103,113,164,177,253,258,357,386,392,447,448,462,464,472],libressl:343,licens:[64,422],life:370,lifo:136,like:[78,86],limit:[261,310,324,440,455],line:[122,157,164,189,211,219,230,248,254,261,264,292,293,302,322,359,363,368,375,376,385,418,419,431,447,451,455,460,463,466,467],linecach:[264,469],liner:91,link:[78,177,458],linkag:79,linker:111,linux:[85,112,293,454],list:[34,74,84,86,91,99,102,149,322,346,426,437,438,445,448,456,462,464],listbox:372,listen:284,liter:[109,426,431,442,462,467,470],littl:94,live:254,load:[177,385,428],load_test:385,loader:428,local:[30,58,91,232,265,366,460,469,470,471],locat:[86,111,326,345,413],lock:[30,90,139,366,467],log:[65,103,104,128,266,267,268,284,448,459,463,466,467,468,469,470,471],logarithm:[156,275],logger:[103,266],loggeradapt:[104,266],logic:[187,258,431],logrecord:[104,266],longer:468,look:[370,436],lookahead:106,lookup:[13,41,424],loop:[91,129,132,135,260,437,438],low:[30,41,117,132,339],lzma:[269,467,469],mac:[270,305,306,453,462,463],machin:[84,89],machineri:252,macintosh:453,maco:[133,248,472],macpath:[270,471],macpython:453,macro:[8,31],magic:386,magicmock:[386,387],mail:[86,90],mailbox:[271,466],mailcap:272,maildir:271,maildirmessag:271,mailmanproxi:336,main:[376,462],mainten:463,make:[85,90,91,92,105,321,418,456,463,469,470],manag:[38,81,84,104,154,170,171,198,245,284,293,328,342,346,350,370,372,397,418,422,424,449,461,462],mani:[86,91,328],manifest:75,manipul:[143,258,270,271,292,294],manual:[29,171,310,343,442],map:[36,57,58,168,276,279,291,346,370,407],marker:101,markup:[239,273],marshal:[37,274,301,468],mask:258,match:[106,122,221,321,387,447],math:[90,275,466,467,469,470,471],mathemat:[90,156,275,290,345,447],matrix:469,max_path:455,mbc:[58,159],mbox:271,mboxmessag:271,mean:91,measur:[345,368,380,447],member:[212,254],membership:426,memori:[38,84,257,269,279,343,346,378,468,469],memoryhandl:268,memoryview:[39,346,463,467],menu:248,mersenn:422,messag:[103,104,197,206,208,232,236,238,265,271],meta:[65,74,428],metacharact:106,metaclass:424,metadata:[69,457,459,461],metavar:122,meth_noarg:95,meth_o:95,method:[30,40,58,79,82,84,85,90,91,98,106,122,129,132,170,174,212,241,284,288,292,298,339,342,346,380,386,387,399,407,424,426,436,442,456,460,461,464,467,469,470,471],mhmessag:271,microsoft:[65,111,282,455],migrat:463,mime:[195,198,202,207,276,319],mimetyp:[276,471],mimic:90,mingw:111,mini:347,minidom:408,minim:408,minor:456,miscellan:[65,210,269,277,284,293,372,451,454,464],miss:85,mitig:187,mixer:295,mixin:340,mmap:[279,467,468],mmdf:271,mmdfmessag:271,mock:[386,387,469,470,471],mock_open:386,mode:[65,128,129,187,236,434,444,451,463,471],model:[316,407,424,425,457],modifi:[91,106,111,376,410,455],modul:[28,41,64,65,67,69,71,74,77,79,85,90,91,96,97,99,102,103,104,106,108,111,112,116,153,167,169,174,176,182,192,194,211,212,226,232,242,252,257,258,266,280,281,284,290,298,301,308,310,321,326,334,335,339,342,346,350,352,370,383,385,389,406,407,415,420,424,428,434,446,455,456,457,458,459,460,461,462,463,465,466,467,468,469,470,471],modular:99,modulefind:280,modulespec:468,monti:86,more:[81,84,94,97,102,104,106,289,380,387,437,438,446],morsel:245,most:[91,308],motion:380,mro:424,msilib:[282,471],msvccompil:65,msvcrt:283,multi:[41,257,343,448,460,466,469],multical:416,multidimension:91,multilingu:232,multimedia:278,multipl:[103,104,112,219,386,387,436,446,458,469],multiplex:330,multiprocess:[104,284,462,467,468,469,470,471],multithread:[128,342],mung:321,must:84,mutabl:[182,346,387],mutat:90,mutual:[91,122],name:[64,74,91,106,111,122,159,161,212,261,293,342,381,386,387,424,425,426,436,459,467],namednodemap:407,namedtupl:161,namer:104,namespac:[122,410,424,428,436,467],nan:261,nanosecond:471,narg:122,navig:248,ndbm:185,need:460,neg:91,negoti:469,nest:[386,387,438,457,458],net:258,netrc:286,network:[90,102,104,129,258,259,339,340,463],never:[86,128],newli:468,newlin:[91,459],newsgroup:86,newtyp:382,next:[103,472],nis:287,nntp:[288,466],nntplib:[288,467],node:[124,407],nodelist:407,non:[30,106,107,111,261,343,410,468],none:[42,90],nonloc:432,notabl:[308,469,470,471],notat:[321,430,462],note:[102,148,187,208,237,256,289,320,334,339,340,343,350,373,424],notebook:373,notif:30,notimpl:346,now:450,nteventloghandl:268,nuget:455,nullhandl:268,nulltransl:232,number:[5,14,43,57,65,86,90,91,110,156,170,223,261,275,289,293,320,328,445,462],numer:[15,90,123,289,290,346,424,431,470],numpi:7,obfusc:91,object:[2,3,5,6,8,9,11,12,14,15,16,18,19,20,21,22,23,24,25,27,31,33,34,35,38,39,40,41,42,45,46,50,51,53,55,56,57,58,61,81,85,90,91,96,102,103,104,122,129,131,134,140,150,157,158,159,161,167,168,176,178,180,184,187,189,193,204,207,209,212,225,228,236,243,244,245,249,254,258,261,266,267,271,274,276,282,284,286,288,293,295,297,298,301,303,307,309,314,316,318,321,323,325,327,329,331,332,336,337,339,340,342,343,346,350,351,359,360,366,377,386,387,392,395,398,399,400,402,405,407,408,409,410,411,412,413,416,417,419,420,424,436,442,459,460,462,463,467,468],obtain:[86,132],octal:91,odd:[108,436],off:187,old:[44,108,385,442,458],older:[105,111,350],omit:212,one:91,onexit:90,onli:[135,182,248,471],onlin:315,opcod:190,open:[64,110,129,137,392,428],openbsd:454,openerdirector:392,opengl:87,opensolari:454,openssl:422,oper:[54,65,84,91,99,108,120,172,228,244,258,283,289,291,293,298,321,333,343,346,347,426,431,447,458,464,467,468,469],operand:187,optim:[103,459,460,461,462,463,465,466,467,468,469,470,471],option:[74,75,91,94,95,96,105,122,193,230,248,261,292,302,359,370,373,376,385,419,451,470],optpars:[122,292,459],order:[91,177,228,292,349,387,426,463,464,465,470],ordereddict:161,orderedenum:212,org:[86,455],organ:[91,385],orient:[157,298],oss:295,ossaudiodev:295,other:[5,15,65,74,82,84,85,90,91,96,102,104,122,140,149,212,258,283,292,296,301,328,339,346,356,431,438,453,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471],otherwis:422,out:90,output:[85,90,91,95,104,222,248,333,442,447,448],outputcheck:193,over:[82,91,219],overload:91,overrid:[91,397],overview:[38,78,102,257,380,464],own:[85,177],ownership:79,pack:349,packag:[64,65,66,69,73,74,76,90,110,112,166,191,195,296,304,363,406,428,446,449,453,455,457,459,461,462,467],packer:[370,405],pad:97,page:287,pair:321,panel:180,parallel:[112,167,284,366],paramet:[30,79,91,95,108,176,177,293,355,370],parcel:90,parent:122,parenthes:426,pars:[5,122,208,292,297,306,316,332,353,374,391,410,463,466,471],parse_arg:122,parser:[122,168,208,230,241,292,297,316,393,411,413,462],part:[298,448],parti:80,partial:[122,228,387,409,461],particular:104,pass:[91,99,104,177,432,437,444],password:[174,231,312,341],patch:[86,386,387],patcher:386,path:[111,252,270,294,298,356,428,446,454,470],pathlib:[298,468,469,470,471],pathnam:[233,294],pattern:[106,221,233,447],pdb:[299,466,467,468,470,471],pen:380,peopl:86,pep:[65,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471],per:462,percent:469,perform:[65,90,91,106,257,301,447,464,467],perl:91,persist:[90,300,301,331],person:236,phase:[41,469],phonebook:321,physic:431,pickl:[173,212,301,302,459,467,468,469,470],pickletool:[302,470],pil:7,pip:[112,211,449,463,468],pipe:[90,129,284,303],pipelin:[303,350],pkgutil:304,place:[86,91,291],plagu:106,plai:403,planet:212,platform:[87,111,133,305,373,383,454,455,457,471],plist:306,plistlib:[306,462,468],point:[24,84,187,212,431,440,448],pointer:[79,177],polar:156,polici:[132,134,209,467],poll:329,pool:[129,284],pop3:307,popen2:350,popen3:350,popen:[90,350,466],poplib:[307,466,468,469],popul:292,port:[90,96,105,456,459,460,461,462,463,464,465,466,467,468,469,470,471],portabl:[185,231],posit:[94,292,321],posix:[308,362],possibl:91,post:[90,182],postinstal:66,postpon:471,power:[106,156,275,426],pprint:[309,468],practic:[83,91,328],preced:[91,426],precis:187,precomput:282,predefin:439,prefer:248,prefix:[111,122,258],prefix_char:122,prepar:[348,424],preprocessor:74,present:[81,464],preserv:[370,470],pretti:[309,378],prettyprint:309,prevent:105,primari:426,primit:[139,140,284],print:[22,85,122,292,377,462,464],printabl:319,printer:309,printf:346,prior:112,prioriti:[136,237],privat:436,probe:[101,470],problem:[106,153],procedur:422,process:[30,54,65,104,129,134,182,273,284,286,293,343,364,406,456,462],processinginstruct:407,processpoolexecutor:167,profil:[30,186,310],prog:122,program:[86,90,91,92,97,99,107,109,140,178,224,226,232,265,284,370,425,433,445,447,453],programm:86,programmat:[212,252,302,376],progressbar:373,project:[64,86],proper:105,properti:[58,98,109,298,462],propos:86,protocol:[7,32,36,43,44,45,49,81,98,132,135,168,225,243,249,255,288,307,337,343,385,428,462,467,469,470],protocolerror:416,prototyp:177,provabl:99,provid:[79,82,103,356],provision:467,proxi:[110,284,386],proxybasicauthhandl:392,proxydigestauthhandl:392,proxyhandl:392,pseudo:[311,320],psf:422,pty:[311,468],publish:86,pull:410,pulldom:409,pure:[69,78,298],pureproxi:336,put:292,pwd:312,py_buff:95,py_buildvalu:85,py_compil:[313,471],py_unicod:58,pyarg_unpacktupl:95,pyc:[65,91,466,471],pyclbr:314,pyd:92,pydoc:[315,466,467,468,470,471],pyerr_print:85,pymalloc:[38,459],pyo:469,pypi:73,python:[0,1,14,29,30,31,62,64,65,69,71,72,73,78,79,80,84,85,86,87,88,89,90,91,92,95,96,97,99,100,105,109,111,112,113,159,160,164,177,181,190,192,193,215,248,253,262,263,265,266,274,297,299,301,310,313,314,317,326,331,334,342,353,356,363,368,370,374,375,376,380,418,422,429,433,434,436,441,444,445,446,452,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472,473],pythonmalloc:470,pywin32:455,pyxml:456,pyzipfil:419,qname:410,qualifi:467,qualiti:447,queri:[22,292,293,297,333],question:[87,88,90,91],queue:[127,136,237,284,318,438,471],queuehandl:[104,268],queuelisten:[104,268],quick:[168,187,370,386],quopri:319,quot:[319,391],rais:[22,91,103,292,387,390,432,439],random:[90,236,264,293,320,328,343,436,466,470],rang:[346,437],ration:223,raw:[38,58,84,143,257,321],rawconfigpars:168,rawturtl:380,read:[64,69,90,109,119,129,135,155,176,269,282,351,359,398,442],reader:176,readlin:[322,325,335,469,470],readonli:7,real:[86,95,320],realli:90,reason:86,receiv:104,recip:[161,170,187,260,320,328],recogn:193,recommend:80,record:[282,448],recurs:22,redhat:65,redirect:[95,447],reentranc:257,reentrant:170,refer:[29,31,47,61,65,67,79,81,86,91,99,109,177,284,292,310,370,399,404,410,426,428,429,446,448,457],reflect:48,regen:[463,469,470],regex:90,regist:[65,137,173,342],registri:[13,159,402],regress:[105,363],regular:[106,109,321,428],reimport:91,reinterpret:185,rel:[428,461,462],relat:[7,75,110,152,252,370,428,454,458],relationship:[74,301,456],releas:[30,463,467,468,469,470,471,472],reli:84,remark:436,remot:[284,422],remov:[91,455,461,462,463,464,468,469,470,471],renam:95,repeat:[106,261],replac:[96,106,116,170,194,350,428],report:86,repositori:466,repr:[323,428],repres:[196,197,206],represent:[275,440,467],reprlib:[323,466],reproduc:320,request:[7,340,390,392,470],requir:[84,122,177],reserv:431,resolut:[267,425,471],resolv:424,resourc:[110,252,324,410,453,467,468,471],respons:[125,392,404],restrict:[86,212,301,331,392,425],restructuredtext:462,result:[84,91,344,391],retri:469,retriev:[128,254,377],reusabl:170,revers:[91,460],revis:[99,462],rework:467,rfc:395,rich:457,rid:90,right:402,rlcomplet:[325,470],rlock:366,rmtree:333,robot:393,robotpars:[393,470],rotat:104,rotatingfilehandl:268,round:187,roundup:462,routin:[283,357],row:342,rpc:[416,417],rpm:[65,66],rs232:90,rule:[79,91,332,334,458],run:[90,92,128,129,140,248,363,385,453],runpi:326,runtim:[80,283,317,471],safe:[90,468],safeti:266,same:[91,92,387],save:442,sax2:[411,456],sax:[411,412,413,414,469],saxexcept:411,saxutil:414,scandir:469,scanf:[91,321],sched:[327,467],schedul:[129,140,293,327],schema:267,scheme:[84,86,111],schwartzian:91,scientif:112,scope:[436,457,458],scratch:207,screen:380,script:[65,66,74,90,91,92,115,153,154,280,356,380,434,446,453,455,461],script_help:363,scroll:371,scrollabl:373,scrolledtext:371,sdist:[65,67],seal:386,search:[106,111,149,321,428,446],secret:[328,470],section:370,secur:[153,236,328,343,350,463,468,472],seem:90,select:[99,104,329,343,422,466,467,468],selector:[330,372,468,469],self:[84,91,95,343],semaphor:[139,366],send:[90,104],sent:104,sentinel:386,separ:[84,373,459,463,465],sequenc:[15,49,55,57,91,320,346,350,438],sequencematch:189,serial:[90,274,301],server:[104,129,135,137,141,246,336,340,343,404,415,416,417,466,471],serverproxi:416,servic:[120,146,175,232,263,265,277,278,317,364,388,401,422],session:343,set:[50,129,134,196,248,252,334,343,346,370,380,387,426,438,455,459,460],setup:[68,74,85,105,452],setupclass:385,setupmodul:385,shadow:341,shake:236,shallow:172,shape:[7,380],share:[91,177,284,467],sharedctyp:284,shebang:455,shell:[248,303,332,350],shelv:[331,468],shield:140,shift:426,shlex:[332,467,470],shortcut:342,shot:151,should:[90,328],shouldn:451,show:[91,471],shutil:[333,466,467,468,469],side:[343,387],sigint:129,sign:343,signal:[22,90,129,187,215,334,385,467,469,471],signatur:[159,254,467],signific:[86,468],sigpip:334,sigterm:129,simpl:[65,72,79,84,103,106,193,236,241,332,357,370,404,432,458,459],simple_serv:404,simplenamespac:467,simplequeu:318,simpler:[460,470],simplexmlrpcserv:417,simul:321,sinc:380,singl:[41,65,69,90,91,104,170],siphash24:422,site:[169,335,462,466,470],size:[177,236,293,333,349],sizegrip:373,skip:385,slash:91,sleep:140,slice:[51,426,459],slot:58,slow:91,small:[99,368],smtp:[336,337],smtpchannel:336,smtpd:[336,467,468,469],smtphandler:268,smtplib:[337,467,468,469],smtpserver:336,snapshot:378,sndhdr:[338,469],snippet:368,soapbox:193,socket:[90,107,110,125,129,135,137,141,339,343,422,466,467,468,469,470,471],sockethandl:268,socketserv:[340,467,470,471],softwar:[86,191,422,461],solari:232,solut:153,some:[84,85],sometim:92,sort:[84,91,108,149],sound:[338,403],sourc:[64,65,67,74,75,86,90,91,92,109,248,252,254,313,375,444,459],spawn:[65,284,350],speak:104,spec:[84,428],special:[187,275,346,380,424,428,459,464],specif:[30,72,81,84,87,99,159,305,335,347,355,373,380,383,388,401,402,427,459,460,461,462,463],specifi:[75,84,91,95,105,177,269,418,463,465],speed:91,sphinx:462,spinbox:373,split:[106,111],spread:345,spwd:341,sqlite3:[342,461,466,467,468,469,470,471],sqlite:342,srpm:65,sscanf:91,ssize_t:461,ssl:[343,462,466,467,468,469,470,471],stabil:108,stabl:[52,86,466],stack:[180,254,377,438],stacksummari:377,stai:105,stand:91,standalon:418,standard:[22,31,65,91,111,159,213,253,261,291,292,373,381,408,424,428,446,447,448,459],star:380,start:[1,92,97,168,187,284,386,387,455],startup:[248,322,434],stat:[310,344,467,468],state:[30,96,215,245,254,284,301,373,380],stateless:159,statement:[84,85,114,170,366,376,423,424,432,437,438,461,462],statist:[345,378,468,470],statisticdiff:378,statu:242,stderr:[85,90],stdin:90,stdlib:[463,468],stdout:[85,90],step:[91,103,445,455],stop:[129,386],stopiter:469,storag:[30,471],store:[292,342,455],str:[96,346],strang:84,stream:[127,135,137,159,219,257,301],streamhandl:268,streamread:[137,159],streamreaderwrit:159,streamrecod:159,streamwrit:[137,159],strftime:184,stride:7,string:[5,17,58,84,90,91,106,109,212,258,292,321,346,347,348,349,350,431,437,442,445,447,456,459,460,462,464,467,470,471],stringprep:348,strptime:184,strtod:422,struct:[55,349,467,468,470],structur:[7,14,53,57,104,168,177,273,391,425,431,438,442],stumbl:464,style:[7,65,91,104,230,233,346,362,373,437,461],sub:[30,65,122],subclass:[82,91,104,212,244,323,387,424],subgener:467,submiss:90,submit:86,submodul:428,suboffset:7,subprocess:[127,129,133,135,138,248,350,460,467,468,469,470,471],subprocess_exec:135,subprocessprotocol:135,subscript:426,substitut:[443,460],subtest:385,suggest:81,suit:363,summari:[282,467,468,469,470,471],sun:[287,351],sunau:[351,468,471],supersed:352,support:[13,26,30,37,41,46,58,81,82,99,105,109,133,151,153,157,168,170,171,173,212,232,235,239,255,279,308,314,343,359,363,382,386,409,410,411,456,459,462,468,469,470,471],suppress:[397,467],sure:105,surpris:177,symbol:[85,95,213,353,354],symtabl:354,synchron:[127,139,284,318],syntax:[111,122,124,321,347,410,436,439,462,464,467,469,470],sys:[90,122,355,467,468,469,470,471],sysconfig:[65,356,463,466,469],syslog:357,sysloghandl:[104,268],system:[54,58,65,78,85,112,120,153,163,213,216,293,308,315,350,355,428,447,457,467,468,469,470],systemtap:[101,470],tab:[92,373,443],tabl:[79,282,301,354],tabnanni:358,tabular:372,tag:[373,466],take:92,tapset:101,tar:359,tarfil:[359,466,467,468,469],target:[463,469,470],tarinfo:359,task:[90,127,129,140,167],tcl:370,tcp:[135,137],tcpserver:340,teardownclass:385,teardownmodul:385,techniqu:438,tell:[85,380],telnet:360,telnetlib:[360,470],tempfil:[361,466,467],templat:[303,347,448],temporari:361,temporarili:397,term:[64,112,422],termcap:90,termin:[178,293,311,333,379,447],terminolog:[72,292],termio:362,ternari:91,test:[86,90,99,105,153,193,262,343,346,363,385,387,397,426,469,472],test_epol:422,test_prefix:386,text:[97,105,159,178,193,248,257,264,321,346,364,365,371,407,464],text_fil:65,textbox:178,textfil:65,textpad:178,textwrap:[365,467,468],than:104,them:104,theme:[373,463],theoret:275,theori:237,thi:[91,370],thin:79,thing:106,third:80,thousand:[463,465],thread:[30,84,90,104,117,129,138,140,187,194,257,266,334,366,448,466,467,468,469,471],threadpoolexecutor:167,through:[85,422],throughout:104,time:[90,103,104,184,367,368,447,459,466,467,469,470,471],timedelta:184,timedrotatingfilehandl:268,timeit:[368,469,470],timeout:[140,215,339],timeperiod:212,timer:[310,366],timezon:[184,367],tip:[109,111,265],tix:372,tkinter:[87,248,370,371,372,373,469,470,471],togeth:[91,292],token:[321,328,374,375,431],too:91,tool:[64,80,90,91,188,257,273,298,302,404,437,448,463,472],toolkit:87,top:[115,261,378,433],topic:[81,95],touch:[463,469,470],tour:[447,448],toward:445,tower:289,tp_init:95,tp_new:95,trace:[30,376,378,422],traceback:[154,215,377,378,468,469,470],tracebackexcept:377,tracemalloc:[38,378,468,470,471],track:[376,387],tracker:[1,462],tradit:84,trail:91,transact:342,transfer:129,transform:[91,159],transit:105,translat:[113,232,380,471],transport:[132,135],tree:[65,124,236,297,353,374,409,410],treebuild:410,treeview:373,trick:[95,111],trigger:329,trigonometr:[156,275],trivial:[111,292],truth:346,tss:30,ttk:[373,463],tty:[362,379],tupl:[55,84,85,91,161,346,438],turtl:380,turtledemo:[380,466],turtlescreen:380,tutori:[82,86,94,103,122,177,187,292,410,441],tweak:111,twister:422,two:463,txt:393,type:[7,8,31,56,57,58,70,81,82,84,99,105,109,122,177,183,184,212,250,254,276,289,292,338,342,346,370,372,381,382,402,407,424,438,458,459,460,461,462,467,468,469,470,471],tzinfo:184,uac:66,udp:135,udpserv:340,unari:426,unbound:387,unboundlocalerror:91,undecor:108,undefin:85,under:[78,92],underli:305,underscor:470,understand:292,undocu:383,unicod:[13,22,58,96,109,159,359,384,456,458,459,464,466,467],unicodedata:[384,469,470,471],unicodedecodeerror:91,unicodeencodeerror:91,unif:96,unifi:[458,460,461],union:177,uniqu:[91,212],unit:[363,385],unittest:[193,385,386,387,463,466,467,468,469,470,471],univers:459,unix:[65,78,83,90,111,129,153,174,185,221,233,305,357,388,454],unixccompil:65,unknown:109,unknownhandl:392,unpack:[405,437,469],unpickl:301,unsupport:[467,469],updat:[105,397,463],upgrad:[122,129],upload:76,url:[110,389,391,392],urlerror:110,urllib:[110,389,390,391,392,393,466,467,468,469,470,471],usag:[95,112,122,151,193,235,248,261,280,302,324,375,376,416,452,467],use:[84,85,86,90,91,103,164,170,298,328,380,451],used:[84,280,353,374,392],user:[64,66,87,97,111,112,215,248,267,296,310,369,382,439,462],userdict:161,userlist:161,userstr:161,using:[85,86,90,91,95,104,105,137,197,269,316,363,385,422,424],utc:104,utf:[58,159,470,471],utf_8_sig:159,util:[54,59,65,122,170,177,179,210,252,288,304,311,363,381,404,414],uudecod:422,uuencod:[394,422],uuid:[395,471],valid:404,valu:[5,79,85,90,91,95,99,122,123,168,177,182,187,212,261,292,320,342,346,387,402,424,426,437],variabl:[16,30,91,95,103,170,171,177,182,236,292,293,356,361,370,436,451,455,463,470],variat:111,variou:271,venv:[396,468,470],verbos:[106,387],veri:[60,78,370],verif:[463,468],verifi:343,version:[4,65,71,86,102,105,111,112,292,343,397,454,455,466],versu:[105,106],via:[104,455],view:[282,346,463,464],virtual:[373,396,449,455,467,469],visibl:[380,467],vista:66,vulner:406,wai:[91,108],wait:[87,137,140,329],want:[85,91],warn:[22,193,214,266,397,457,463,470,471],watch:129,watchedfilehandl:268,watcher:134,wav:398,wave:[398,468,471],wave_read:398,wave_writ:398,wchar_t:58,wconio:455,weak:[61,81,399,448,457],weakref:[399,468],web:[244,400,466],webbrows:[400,467],what:[86,87,89,90,91,97,103,193,292,301,310,450,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,473],when:[84,91,102,103,107],where:[86,90,386],whet:435,which:[105,193],whitespac:431,whole:74,why:[84,85,86,87,89,90,91,92,460],wide:30,widget:[178,370,371,372,373,463],wildcard:447,win95:305,window:[58,65,66,83,92,97,111,133,159,178,248,305,350,370,380,401,402,403,418,455,459,462,463,467,470,471,472],winreg:[402,470],winsound:[403,470],within:261,without:[80,92,248,455],word:436,work:[86,87,90,91,111,112,129,187,193,257,419,448],worker:[90,284],world:[86,126,129,370],wrap:[110,365],wrapper:[65,343],write:[68,74,79,85,90,91,95,109,119,135,176,269,282,321,351,359,363,398,442,461,462],writer:[176,222,265],written:85,wsgi:404,wsgiref:[404,461,469],www:[86,90],wxwidget:87,xdr:405,xdrlib:405,xhtml:241,xml:[316,406,407,408,409,410,411,412,413,414,416,417,422,456,467,468,469,471],xmlparser:[316,410],xmlpullpars:410,xmlreader:413,xmlrpc:[415,416,417,469,470,471],xpath:410,yellow:287,yield:[426,432],you:[84,90,91,105,451],your:[77,95,104,105,153,177,232,292,342,387,435],yourself:1,zeromq:104,zip:[418,419,420,459],zipapp:[418,469,471],zipfil:[419,466,468,469,470,471],zipimport:420,zipinfo:419,zlib:[421,422,467,470]}}) \ No newline at end of file diff --git a/python-3.7.4-docs-html/tutorial/appendix.html b/python-3.7.4-docs-html/tutorial/appendix.html new file mode 100644 index 0000000..bb6c8b6 --- /dev/null +++ b/python-3.7.4-docs-html/tutorial/appendix.html @@ -0,0 +1,291 @@ + + + + + + + 16. Appendix — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    16. Appendix

    +
    +

    16.1. Interactive Mode

    +
    +

    16.1.1. Error Handling

    +

    When an error occurs, the interpreter prints an error message and a stack trace. +In interactive mode, it then returns to the primary prompt; when input came from +a file, it exits with a nonzero exit status after printing the stack trace. +(Exceptions handled by an except clause in a try statement +are not errors in this context.) Some errors are unconditionally fatal and +cause an exit with a nonzero exit; this applies to internal inconsistencies and +some cases of running out of memory. All error messages are written to the +standard error stream; normal output from executed commands is written to +standard output.

    +

    Typing the interrupt character (usually Control-C or Delete) to the primary or +secondary prompt cancels the input and returns to the primary prompt. 1 +Typing an interrupt while a command is executing raises the +KeyboardInterrupt exception, which may be handled by a try +statement.

    +
    +
    +

    16.1.2. Executable Python Scripts

    +

    On BSD’ish Unix systems, Python scripts can be made directly executable, like +shell scripts, by putting the line

    +
    #!/usr/bin/env python3.5
    +
    +
    +

    (assuming that the interpreter is on the user’s PATH) at the beginning +of the script and giving the file an executable mode. The #! must be the +first two characters of the file. On some platforms, this first line must end +with a Unix-style line ending ('\n'), not a Windows ('\r\n') line +ending. Note that the hash, or pound, character, '#', is used to start a +comment in Python.

    +

    The script can be given an executable mode, or permission, using the +chmod command.

    +
    $ chmod +x myscript.py
    +
    +
    +

    On Windows systems, there is no notion of an “executable mode”. The Python +installer automatically associates .py files with python.exe so that +a double-click on a Python file will run it as a script. The extension can +also be .pyw, in that case, the console window that normally appears is +suppressed.

    +
    +
    +

    16.1.3. The Interactive Startup File

    +

    When you use Python interactively, it is frequently handy to have some standard +commands executed every time the interpreter is started. You can do this by +setting an environment variable named PYTHONSTARTUP to the name of a +file containing your start-up commands. This is similar to the .profile +feature of the Unix shells.

    +

    This file is only read in interactive sessions, not when Python reads commands +from a script, and not when /dev/tty is given as the explicit source of +commands (which otherwise behaves like an interactive session). It is executed +in the same namespace where interactive commands are executed, so that objects +that it defines or imports can be used without qualification in the interactive +session. You can also change the prompts sys.ps1 and sys.ps2 in this +file.

    +

    If you want to read an additional start-up file from the current directory, you +can program this in the global start-up file using code like if +os.path.isfile('.pythonrc.py'): exec(open('.pythonrc.py').read()). +If you want to use the startup file in a script, you must do this explicitly +in the script:

    +
    import os
    +filename = os.environ.get('PYTHONSTARTUP')
    +if filename and os.path.isfile(filename):
    +    with open(filename) as fobj:
    +        startup_file = fobj.read()
    +    exec(startup_file)
    +
    +
    +
    +
    +

    16.1.4. The Customization Modules

    +

    Python provides two hooks to let you customize it: sitecustomize and +usercustomize. To see how it works, you need first to find the location +of your user site-packages directory. Start Python and run this code:

    +
    >>> import site
    +>>> site.getusersitepackages()
    +'/home/user/.local/lib/python3.5/site-packages'
    +
    +
    +

    Now you can create a file named usercustomize.py in that directory and +put anything you want in it. It will affect every invocation of Python, unless +it is started with the -s option to disable the automatic import.

    +

    sitecustomize works in the same way, but is typically created by an +administrator of the computer in the global site-packages directory, and is +imported before usercustomize. See the documentation of the site +module for more details.

    +

    Footnotes

    +
    +
    1
    +

    A problem with the GNU Readline package may prevent this.

    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/tutorial/appetite.html b/python-3.7.4-docs-html/tutorial/appetite.html new file mode 100644 index 0000000..2e0e373 --- /dev/null +++ b/python-3.7.4-docs-html/tutorial/appetite.html @@ -0,0 +1,247 @@ + + + + + + + 1. Whetting Your Appetite — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    1. Whetting Your Appetite

    +

    If you do much work on computers, eventually you find that there’s some task +you’d like to automate. For example, you may wish to perform a +search-and-replace over a large number of text files, or rename and rearrange a +bunch of photo files in a complicated way. Perhaps you’d like to write a small +custom database, or a specialized GUI application, or a simple game.

    +

    If you’re a professional software developer, you may have to work with several +C/C++/Java libraries but find the usual write/compile/test/re-compile cycle is +too slow. Perhaps you’re writing a test suite for such a library and find +writing the testing code a tedious task. Or maybe you’ve written a program that +could use an extension language, and you don’t want to design and implement a +whole new language for your application.

    +

    Python is just the language for you.

    +

    You could write a Unix shell script or Windows batch files for some of these +tasks, but shell scripts are best at moving around files and changing text data, +not well-suited for GUI applications or games. You could write a C/C++/Java +program, but it can take a lot of development time to get even a first-draft +program. Python is simpler to use, available on Windows, Mac OS X, and Unix +operating systems, and will help you get the job done more quickly.

    +

    Python is simple to use, but it is a real programming language, offering much +more structure and support for large programs than shell scripts or batch files +can offer. On the other hand, Python also offers much more error checking than +C, and, being a very-high-level language, it has high-level data types built +in, such as flexible arrays and dictionaries. Because of its more general data +types Python is applicable to a much larger problem domain than Awk or even +Perl, yet many things are at least as easy in Python as in those languages.

    +

    Python allows you to split your program into modules that can be reused in other +Python programs. It comes with a large collection of standard modules that you +can use as the basis of your programs — or as examples to start learning to +program in Python. Some of these modules provide things like file I/O, system +calls, sockets, and even interfaces to graphical user interface toolkits like +Tk.

    +

    Python is an interpreted language, which can save you considerable time during +program development because no compilation and linking is necessary. The +interpreter can be used interactively, which makes it easy to experiment with +features of the language, to write throw-away programs, or to test functions +during bottom-up program development. It is also a handy desk calculator.

    +

    Python enables programs to be written compactly and readably. Programs written +in Python are typically much shorter than equivalent C, C++, or Java programs, +for several reasons:

    +
      +
    • the high-level data types allow you to express complex operations in a single +statement;

    • +
    • statement grouping is done by indentation instead of beginning and ending +brackets;

    • +
    • no variable or argument declarations are necessary.

    • +
    +

    Python is extensible: if you know how to program in C it is easy to add a new +built-in function or module to the interpreter, either to perform critical +operations at maximum speed, or to link Python programs to libraries that may +only be available in binary form (such as a vendor-specific graphics library). +Once you are really hooked, you can link the Python interpreter into an +application written in C and use it as an extension or command language for that +application.

    +

    By the way, the language is named after the BBC show “Monty Python’s Flying +Circus” and has nothing to do with reptiles. Making references to Monty +Python skits in documentation is not only allowed, it is encouraged!

    +

    Now that you are all excited about Python, you’ll want to examine it in some +more detail. Since the best way to learn a language is to use it, the tutorial +invites you to play with the Python interpreter as you read.

    +

    In the next chapter, the mechanics of using the interpreter are explained. This +is rather mundane information, but essential for trying out the examples shown +later.

    +

    The rest of the tutorial introduces various features of the Python language and +system through examples, beginning with simple expressions, statements and data +types, through functions and modules, and finally touching upon advanced +concepts like exceptions and user-defined classes.

    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/tutorial/classes.html b/python-3.7.4-docs-html/tutorial/classes.html new file mode 100644 index 0000000..5bd1dba --- /dev/null +++ b/python-3.7.4-docs-html/tutorial/classes.html @@ -0,0 +1,999 @@ + + + + + + + 9. Classes — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    9. Classes

    +

    Classes provide a means of bundling data and functionality together. Creating +a new class creates a new type of object, allowing new instances of that +type to be made. Each class instance can have attributes attached to it for +maintaining its state. Class instances can also have methods (defined by its +class) for modifying its state.

    +

    Compared with other programming languages, Python’s class mechanism adds classes +with a minimum of new syntax and semantics. It is a mixture of the class +mechanisms found in C++ and Modula-3. Python classes provide all the standard +features of Object Oriented Programming: the class inheritance mechanism allows +multiple base classes, a derived class can override any methods of its base +class or classes, and a method can call the method of a base class with the same +name. Objects can contain arbitrary amounts and kinds of data. As is true for +modules, classes partake of the dynamic nature of Python: they are created at +runtime, and can be modified further after creation.

    +

    In C++ terminology, normally class members (including the data members) are +public (except see below Private Variables), and all member functions are +virtual. As in Modula-3, there are no shorthands for referencing the object’s +members from its methods: the method function is declared with an explicit first +argument representing the object, which is provided implicitly by the call. As +in Smalltalk, classes themselves are objects. This provides semantics for +importing and renaming. Unlike C++ and Modula-3, built-in types can be used as +base classes for extension by the user. Also, like in C++, most built-in +operators with special syntax (arithmetic operators, subscripting etc.) can be +redefined for class instances.

    +

    (Lacking universally accepted terminology to talk about classes, I will make +occasional use of Smalltalk and C++ terms. I would use Modula-3 terms, since +its object-oriented semantics are closer to those of Python than C++, but I +expect that few readers have heard of it.)

    +
    +

    9.1. A Word About Names and Objects

    +

    Objects have individuality, and multiple names (in multiple scopes) can be bound +to the same object. This is known as aliasing in other languages. This is +usually not appreciated on a first glance at Python, and can be safely ignored +when dealing with immutable basic types (numbers, strings, tuples). However, +aliasing has a possibly surprising effect on the semantics of Python code +involving mutable objects such as lists, dictionaries, and most other types. +This is usually used to the benefit of the program, since aliases behave like +pointers in some respects. For example, passing an object is cheap since only a +pointer is passed by the implementation; and if a function modifies an object +passed as an argument, the caller will see the change — this eliminates the +need for two different argument passing mechanisms as in Pascal.

    +
    +
    +

    9.2. Python Scopes and Namespaces

    +

    Before introducing classes, I first have to tell you something about Python’s +scope rules. Class definitions play some neat tricks with namespaces, and you +need to know how scopes and namespaces work to fully understand what’s going on. +Incidentally, knowledge about this subject is useful for any advanced Python +programmer.

    +

    Let’s begin with some definitions.

    +

    A namespace is a mapping from names to objects. Most namespaces are currently +implemented as Python dictionaries, but that’s normally not noticeable in any +way (except for performance), and it may change in the future. Examples of +namespaces are: the set of built-in names (containing functions such as abs(), and +built-in exception names); the global names in a module; and the local names in +a function invocation. In a sense the set of attributes of an object also form +a namespace. The important thing to know about namespaces is that there is +absolutely no relation between names in different namespaces; for instance, two +different modules may both define a function maximize without confusion — +users of the modules must prefix it with the module name.

    +

    By the way, I use the word attribute for any name following a dot — for +example, in the expression z.real, real is an attribute of the object +z. Strictly speaking, references to names in modules are attribute +references: in the expression modname.funcname, modname is a module +object and funcname is an attribute of it. In this case there happens to be +a straightforward mapping between the module’s attributes and the global names +defined in the module: they share the same namespace! 1

    +

    Attributes may be read-only or writable. In the latter case, assignment to +attributes is possible. Module attributes are writable: you can write +modname.the_answer = 42. Writable attributes may also be deleted with the +del statement. For example, del modname.the_answer will remove +the attribute the_answer from the object named by modname.

    +

    Namespaces are created at different moments and have different lifetimes. The +namespace containing the built-in names is created when the Python interpreter +starts up, and is never deleted. The global namespace for a module is created +when the module definition is read in; normally, module namespaces also last +until the interpreter quits. The statements executed by the top-level +invocation of the interpreter, either read from a script file or interactively, +are considered part of a module called __main__, so they have their own +global namespace. (The built-in names actually also live in a module; this is +called builtins.)

    +

    The local namespace for a function is created when the function is called, and +deleted when the function returns or raises an exception that is not handled +within the function. (Actually, forgetting would be a better way to describe +what actually happens.) Of course, recursive invocations each have their own +local namespace.

    +

    A scope is a textual region of a Python program where a namespace is directly +accessible. “Directly accessible” here means that an unqualified reference to a +name attempts to find the name in the namespace.

    +

    Although scopes are determined statically, they are used dynamically. At any +time during execution, there are at least three nested scopes whose namespaces +are directly accessible:

    +
      +
    • the innermost scope, which is searched first, contains the local names

    • +
    • the scopes of any enclosing functions, which are searched starting with the +nearest enclosing scope, contains non-local, but also non-global names

    • +
    • the next-to-last scope contains the current module’s global names

    • +
    • the outermost scope (searched last) is the namespace containing built-in names

    • +
    +

    If a name is declared global, then all references and assignments go directly to +the middle scope containing the module’s global names. To rebind variables +found outside of the innermost scope, the nonlocal statement can be +used; if not declared nonlocal, those variables are read-only (an attempt to +write to such a variable will simply create a new local variable in the +innermost scope, leaving the identically named outer variable unchanged).

    +

    Usually, the local scope references the local names of the (textually) current +function. Outside functions, the local scope references the same namespace as +the global scope: the module’s namespace. Class definitions place yet another +namespace in the local scope.

    +

    It is important to realize that scopes are determined textually: the global +scope of a function defined in a module is that module’s namespace, no matter +from where or by what alias the function is called. On the other hand, the +actual search for names is done dynamically, at run time — however, the +language definition is evolving towards static name resolution, at “compile” +time, so don’t rely on dynamic name resolution! (In fact, local variables are +already determined statically.)

    +

    A special quirk of Python is that – if no global statement is in +effect – assignments to names always go into the innermost scope. Assignments +do not copy data — they just bind names to objects. The same is true for +deletions: the statement del x removes the binding of x from the +namespace referenced by the local scope. In fact, all operations that introduce +new names use the local scope: in particular, import statements and +function definitions bind the module or function name in the local scope.

    +

    The global statement can be used to indicate that particular +variables live in the global scope and should be rebound there; the +nonlocal statement indicates that particular variables live in +an enclosing scope and should be rebound there.

    +
    +

    9.2.1. Scopes and Namespaces Example

    +

    This is an example demonstrating how to reference the different scopes and +namespaces, and how global and nonlocal affect variable +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)
    +    do_nonlocal()
    +    print("After nonlocal assignment:", spam)
    +    do_global()
    +    print("After global assignment:", spam)
    +
    +scope_test()
    +print("In global scope:", spam)
    +
    +
    +

    The output of the example code is:

    +
    After local assignment: test spam
    +After nonlocal assignment: nonlocal spam
    +After global assignment: nonlocal spam
    +In global scope: global spam
    +
    +
    +

    Note how the local assignment (which is default) didn’t change scope_test’s +binding of spam. The nonlocal assignment changed scope_test’s +binding of spam, and the global assignment changed the module-level +binding.

    +

    You can also see that there was no previous binding for spam before the +global assignment.

    +
    +
    +
    +

    9.3. A First Look at Classes

    +

    Classes introduce a little bit of new syntax, three new object types, and some +new semantics.

    +
    +

    9.3.1. Class Definition Syntax

    +

    The simplest form of class definition looks like this:

    +
    class ClassName:
    +    <statement-1>
    +    .
    +    .
    +    .
    +    <statement-N>
    +
    +
    +

    Class definitions, like function definitions (def statements) must be +executed before they have any effect. (You could conceivably place a class +definition in a branch of an if statement, or inside a function.)

    +

    In practice, the statements inside a class definition will usually be function +definitions, but other statements are allowed, and sometimes useful — we’ll +come back to this later. The function definitions inside a class normally have +a peculiar form of argument list, dictated by the calling conventions for +methods — again, this is explained later.

    +

    When a class definition is entered, a new namespace is created, and used as the +local scope — thus, all assignments to local variables go into this new +namespace. In particular, function definitions bind the name of the new +function here.

    +

    When a class definition is left normally (via the end), a class object is +created. This is basically a wrapper around the contents of the namespace +created by the class definition; we’ll learn more about class objects in the +next section. The original local scope (the one in effect just before the class +definition was entered) is reinstated, and the class object is bound here to the +class name given in the class definition header (ClassName in the +example).

    +
    +
    +

    9.3.2. Class Objects

    +

    Class objects support two kinds of operations: attribute references and +instantiation.

    +

    Attribute references use the standard syntax used for all attribute references +in Python: obj.name. Valid attribute names are all the names that were in +the class’s namespace when the class object was created. So, if the class +definition looked like this:

    +
    class MyClass:
    +    """A simple example class"""
    +    i = 12345
    +
    +    def f(self):
    +        return 'hello world'
    +
    +
    +

    then MyClass.i and MyClass.f are valid attribute references, returning +an integer and a function object, respectively. Class attributes can also be +assigned to, so you can change the value of MyClass.i by assignment. +__doc__ is also a valid attribute, returning the docstring belonging to +the class: "A simple example class".

    +

    Class instantiation uses function notation. Just pretend that the class +object is a parameterless function that returns a new instance of the class. +For example (assuming the above class):

    +
    x = MyClass()
    +
    +
    +

    creates a new instance of the class and assigns this object to the local +variable x.

    +

    The instantiation operation (“calling” a class object) creates an empty object. +Many classes like to create objects with instances customized to a specific +initial state. Therefore a class may define a special method named +__init__(), like this:

    +
    def __init__(self):
    +    self.data = []
    +
    +
    +

    When a class defines an __init__() method, class instantiation +automatically invokes __init__() for the newly-created class instance. So +in this example, a new, initialized instance can be obtained by:

    +
    x = MyClass()
    +
    +
    +

    Of course, the __init__() method may have arguments for greater +flexibility. In that case, arguments given to the class instantiation operator +are passed on to __init__(). For example,

    +
    >>> class Complex:
    +...     def __init__(self, realpart, imagpart):
    +...         self.r = realpart
    +...         self.i = imagpart
    +...
    +>>> x = Complex(3.0, -4.5)
    +>>> x.r, x.i
    +(3.0, -4.5)
    +
    +
    +
    +
    +

    9.3.3. Instance Objects

    +

    Now what can we do with instance objects? The only operations understood by +instance objects are attribute references. There are two kinds of valid +attribute names, data attributes and methods.

    +

    data attributes correspond to “instance variables” in Smalltalk, and to “data +members” in C++. Data attributes need not be declared; like local variables, +they spring into existence when they are first assigned to. For example, if +x is the instance of MyClass created above, the following piece of +code will print the value 16, without leaving a trace:

    +
    x.counter = 1
    +while x.counter < 10:
    +    x.counter = x.counter * 2
    +print(x.counter)
    +del x.counter
    +
    +
    +

    The other kind of instance attribute reference is a method. A method is a +function that “belongs to” an object. (In Python, the term method is not unique +to class instances: other object types can have methods as well. For example, +list objects have methods called append, insert, remove, sort, and so on. +However, in the following discussion, we’ll use the term method exclusively to +mean methods of class instance objects, unless explicitly stated otherwise.)

    +

    Valid method names of an instance object depend on its class. By definition, +all attributes of a class that are function objects define corresponding +methods of its instances. So in our example, x.f is a valid method +reference, since MyClass.f is a function, but x.i is not, since +MyClass.i is not. But x.f is not the same thing as MyClass.f — it +is a method object, not a function object.

    +
    +
    +

    9.3.4. Method Objects

    +

    Usually, a method is called right after it is bound:

    +
    x.f()
    +
    +
    +

    In the MyClass example, this will return the string 'hello world'. +However, it is not necessary to call a method right away: x.f is a method +object, and can be stored away and called at a later time. For example:

    +
    xf = x.f
    +while True:
    +    print(xf())
    +
    +
    +

    will continue to print hello world until the end of time.

    +

    What exactly happens when a method is called? You may have noticed that +x.f() was called without an argument above, even though the function +definition for f() specified an argument. What happened to the argument? +Surely Python raises an exception when a function that requires an argument is +called without any — even if the argument isn’t actually used…

    +

    Actually, you may have guessed the answer: the special thing about methods is +that the instance object is passed as the first argument of the function. In our +example, the call x.f() is exactly equivalent to MyClass.f(x). In +general, calling a method with a list of n arguments is equivalent to calling +the corresponding function with an argument list that is created by inserting +the method’s instance object before the first argument.

    +

    If you still don’t understand how methods work, a look at the implementation can +perhaps clarify matters. When a non-data attribute of an instance is +referenced, the instance’s class is searched. If the name denotes a valid class +attribute that is a function object, a method object is created by packing +(pointers to) the instance object and the function object just found together in +an abstract object: this is the method object. When the method object is called +with an argument list, a new argument list is constructed from the instance +object and the argument list, and the function object is called with this new +argument list.

    +
    +
    +

    9.3.5. Class and Instance Variables

    +

    Generally speaking, instance variables are for data unique to each instance +and class variables are for attributes and methods shared by all instances +of the class:

    +
    class Dog:
    +
    +    kind = 'canine'         # class variable shared by all instances
    +
    +    def __init__(self, name):
    +        self.name = name    # instance variable unique to each instance
    +
    +>>> d = Dog('Fido')
    +>>> e = Dog('Buddy')
    +>>> d.kind                  # shared by all dogs
    +'canine'
    +>>> e.kind                  # shared by all dogs
    +'canine'
    +>>> d.name                  # unique to d
    +'Fido'
    +>>> e.name                  # unique to e
    +'Buddy'
    +
    +
    +

    As discussed in A Word About Names and Objects, shared data can have possibly surprising +effects with involving mutable objects such as lists and dictionaries. +For example, the tricks list in the following code should not be used as a +class variable because just a single list would be shared by all Dog +instances:

    +
    class Dog:
    +
    +    tricks = []             # mistaken use of a class variable
    +
    +    def __init__(self, name):
    +        self.name = name
    +
    +    def add_trick(self, trick):
    +        self.tricks.append(trick)
    +
    +>>> d = Dog('Fido')
    +>>> e = Dog('Buddy')
    +>>> d.add_trick('roll over')
    +>>> e.add_trick('play dead')
    +>>> d.tricks                # unexpectedly shared by all dogs
    +['roll over', 'play dead']
    +
    +
    +

    Correct design of the class should use an instance variable instead:

    +
    class Dog:
    +
    +    def __init__(self, name):
    +        self.name = name
    +        self.tricks = []    # creates a new empty list for each dog
    +
    +    def add_trick(self, trick):
    +        self.tricks.append(trick)
    +
    +>>> d = Dog('Fido')
    +>>> e = Dog('Buddy')
    +>>> d.add_trick('roll over')
    +>>> e.add_trick('play dead')
    +>>> d.tricks
    +['roll over']
    +>>> e.tricks
    +['play dead']
    +
    +
    +
    +
    +
    +

    9.4. Random Remarks

    +

    Data attributes override method attributes with the same name; to avoid +accidental name conflicts, which may cause hard-to-find bugs in large programs, +it is wise to use some kind of convention that minimizes the chance of +conflicts. Possible conventions include capitalizing method names, prefixing +data attribute names with a small unique string (perhaps just an underscore), or +using verbs for methods and nouns for data attributes.

    +

    Data attributes may be referenced by methods as well as by ordinary users +(“clients”) of an object. In other words, classes are not usable to implement +pure abstract data types. In fact, nothing in Python makes it possible to +enforce data hiding — it is all based upon convention. (On the other hand, +the Python implementation, written in C, can completely hide implementation +details and control access to an object if necessary; this can be used by +extensions to Python written in C.)

    +

    Clients should use data attributes with care — clients may mess up invariants +maintained by the methods by stamping on their data attributes. Note that +clients may add data attributes of their own to an instance object without +affecting the validity of the methods, as long as name conflicts are avoided — +again, a naming convention can save a lot of headaches here.

    +

    There is no shorthand for referencing data attributes (or other methods!) from +within methods. I find that this actually increases the readability of methods: +there is no chance of confusing local variables and instance variables when +glancing through a method.

    +

    Often, the first argument of a method is called self. This is nothing more +than a convention: the name self has absolutely no special meaning to +Python. Note, however, that by not following the convention your code may be +less readable to other Python programmers, and it is also conceivable that a +class browser program might be written that relies upon such a convention.

    +

    Any function object that is a class attribute defines a method for instances of +that class. It is not necessary that the function definition is textually +enclosed in the class definition: assigning a function object to a local +variable in the class is also ok. For example:

    +
    # Function defined outside the class
    +def f1(self, x, y):
    +    return min(x, x+y)
    +
    +class C:
    +    f = f1
    +
    +    def g(self):
    +        return 'hello world'
    +
    +    h = g
    +
    +
    +

    Now f, g and h are all attributes of class C that refer to +function objects, and consequently they are all methods of instances of +Ch being exactly equivalent to g. Note that this practice +usually only serves to confuse the reader of a program.

    +

    Methods may call other methods by using method attributes of the self +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)
    +
    +
    +

    Methods may reference global names in the same way as ordinary functions. The +global scope associated with a method is the module containing its +definition. (A class is never used as a global scope.) While one +rarely encounters a good reason for using global data in a method, there are +many legitimate uses of the global scope: for one thing, functions and modules +imported into the global scope can be used by methods, as well as functions and +classes defined in it. Usually, the class containing the method is itself +defined in this global scope, and in the next section we’ll find some good +reasons why a method would want to reference its own class.

    +

    Each value is an object, and therefore has a class (also called its type). +It is stored as object.__class__.

    +
    +
    +

    9.5. Inheritance

    +

    Of course, a language feature would not be worthy of the name “class” without +supporting inheritance. The syntax for a derived class definition looks like +this:

    +
    class DerivedClassName(BaseClassName):
    +    <statement-1>
    +    .
    +    .
    +    .
    +    <statement-N>
    +
    +
    +

    The name BaseClassName must be defined in a scope containing the +derived class definition. In place of a base class name, other arbitrary +expressions are also allowed. This can be useful, for example, when the base +class is defined in another module:

    +
    class DerivedClassName(modname.BaseClassName):
    +
    +
    +

    Execution of a derived class definition proceeds the same as for a base class. +When the class object is constructed, the base class is remembered. This is +used for resolving attribute references: if a requested attribute is not found +in the class, the search proceeds to look in the base class. This rule is +applied recursively if the base class itself is derived from some other class.

    +

    There’s nothing special about instantiation of derived classes: +DerivedClassName() creates a new instance of the class. Method references +are resolved as follows: the corresponding class attribute is searched, +descending down the chain of base classes if necessary, and the method reference +is valid if this yields a function object.

    +

    Derived classes may override methods of their base classes. Because methods +have no special privileges when calling other methods of the same object, a +method of a base class that calls another method defined in the same base class +may end up calling a method of a derived class that overrides it. (For C++ +programmers: all methods in Python are effectively virtual.)

    +

    An overriding method in a derived class may in fact want to extend rather than +simply replace the base class method of the same name. There is a simple way to +call the base class method directly: just call BaseClassName.methodname(self, +arguments). This is occasionally useful to clients as well. (Note that this +only works if the base class is accessible as BaseClassName in the global +scope.)

    +

    Python has two built-in functions that work with inheritance:

    +
      +
    • Use isinstance() to check an instance’s type: isinstance(obj, int) +will be True only if obj.__class__ is int or some class +derived from int.

    • +
    • Use issubclass() to check class inheritance: issubclass(bool, int) +is True since bool is a subclass of int. However, +issubclass(float, int) is False since float is not a +subclass of int.

    • +
    +
    +

    9.5.1. Multiple Inheritance

    +

    Python supports a form of multiple inheritance as well. A class definition with +multiple base classes looks like this:

    +
    class DerivedClassName(Base1, Base2, Base3):
    +    <statement-1>
    +    .
    +    .
    +    .
    +    <statement-N>
    +
    +
    +

    For most purposes, in the simplest cases, you can think of the search for +attributes inherited from a parent class as depth-first, left-to-right, not +searching twice in the same class where there is an overlap in the hierarchy. +Thus, if an attribute is not found in DerivedClassName, it is searched +for in Base1, then (recursively) in the base classes of Base1, +and if it was not found there, it was searched for in Base2, and so on.

    +

    In fact, it is slightly more complex than that; the method resolution order +changes dynamically to support cooperative calls to super(). This +approach is known in some other multiple-inheritance languages as +call-next-method and is more powerful than the super call found in +single-inheritance languages.

    +

    Dynamic ordering is necessary because all cases of multiple inheritance exhibit +one or more diamond relationships (where at least one of the parent classes +can be accessed through multiple paths from the bottommost class). For example, +all classes inherit from object, so any case of multiple inheritance +provides more than one path to reach object. To keep the base classes +from being accessed more than once, the dynamic algorithm linearizes the search +order in a way that preserves the left-to-right ordering specified in each +class, that calls each parent only once, and that is monotonic (meaning that a +class can be subclassed without affecting the precedence order of its parents). +Taken together, these properties make it possible to design reliable and +extensible classes with multiple inheritance. For more detail, see +https://www.python.org/download/releases/2.3/mro/.

    +
    +
    +
    +

    9.6. Private Variables

    +

    “Private” instance variables that cannot be accessed except from inside an +object don’t exist in Python. However, there is a convention that is followed +by most Python code: a name prefixed with an underscore (e.g. _spam) should +be treated as a non-public part of the API (whether it is a function, a method +or a data member). It should be considered an implementation detail and subject +to change without notice.

    +

    Since there is a valid use-case for class-private members (namely to avoid name +clashes of names with names defined by subclasses), there is limited support for +such a mechanism, called name mangling. Any identifier of the form +__spam (at least two leading underscores, at most one trailing underscore) +is textually replaced with _classname__spam, where classname is the +current class name with leading underscore(s) stripped. This mangling is done +without regard to the syntactic position of the identifier, as long as it +occurs within the definition of a class.

    +

    Name mangling is helpful for letting subclasses override methods without +breaking intraclass method calls. For example:

    +
    class Mapping:
    +    def __init__(self, iterable):
    +        self.items_list = []
    +        self.__update(iterable)
    +
    +    def update(self, iterable):
    +        for item in iterable:
    +            self.items_list.append(item)
    +
    +    __update = update   # private copy of original update() method
    +
    +class MappingSubclass(Mapping):
    +
    +    def update(self, keys, values):
    +        # provides new signature for update()
    +        # but does not break __init__()
    +        for item in zip(keys, values):
    +            self.items_list.append(item)
    +
    +
    +

    The above example would work even if MappingSubclass were to introduce a +__update identifier since it is replaced with _Mapping__update in the +Mapping class and _MappingSubclass__update in the MappingSubclass +class respectively.

    +

    Note that the mangling rules are designed mostly to avoid accidents; it still is +possible to access or modify a variable that is considered private. This can +even be useful in special circumstances, such as in the debugger.

    +

    Notice that code passed to exec() or eval() does not consider the +classname of the invoking class to be the current class; this is similar to the +effect of the global statement, the effect of which is likewise restricted +to code that is byte-compiled together. The same restriction applies to +getattr(), setattr() and delattr(), as well as when referencing +__dict__ directly.

    +
    +
    +

    9.7. Odds and Ends

    +

    Sometimes it is useful to have a data type similar to the Pascal “record” or C +“struct”, bundling together a few named data items. An empty class definition +will do nicely:

    +
    class Employee:
    +    pass
    +
    +john = Employee()  # Create an empty employee record
    +
    +# Fill the fields of the record
    +john.name = 'John Doe'
    +john.dept = 'computer lab'
    +john.salary = 1000
    +
    +
    +

    A piece of Python code that expects a particular abstract data type can often be +passed a class that emulates the methods of that data type instead. For +instance, if you have a function that formats some data from a file object, you +can define a class with methods read() and readline() that get the +data from a string buffer instead, and pass it as an argument.

    +

    Instance method objects have attributes, too: m.__self__ is the instance +object with the method m(), and m.__func__ is the function object +corresponding to the method.

    +
    +
    +

    9.8. Iterators

    +

    By now you have probably noticed that most container objects can be looped over +using a for statement:

    +
    for element in [1, 2, 3]:
    +    print(element)
    +for element in (1, 2, 3):
    +    print(element)
    +for key in {'one':1, 'two':2}:
    +    print(key)
    +for char in "123":
    +    print(char)
    +for line in open("myfile.txt"):
    +    print(line, end='')
    +
    +
    +

    This style of access is clear, concise, and convenient. The use of iterators +pervades and unifies Python. Behind the scenes, the for statement +calls iter() on the container object. The function returns an iterator +object that defines the method __next__() which accesses +elements in the container one at a time. When there are no more elements, +__next__() raises a StopIteration exception which tells the +for loop to terminate. You can call the __next__() method +using the next() built-in function; this example shows how it all works:

    +
    >>> s = 'abc'
    +>>> it = iter(s)
    +>>> it
    +<iterator object at 0x00A1DB50>
    +>>> next(it)
    +'a'
    +>>> next(it)
    +'b'
    +>>> next(it)
    +'c'
    +>>> next(it)
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +    next(it)
    +StopIteration
    +
    +
    +

    Having seen the mechanics behind the iterator protocol, it is easy to add +iterator behavior to your classes. Define an __iter__() method which +returns an object with a __next__() method. If the class +defines __next__(), then __iter__() can just return self:

    +
    class Reverse:
    +    """Iterator for looping over a sequence backwards."""
    +    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
    +        self.index = self.index - 1
    +        return self.data[self.index]
    +
    +
    +
    >>> rev = Reverse('spam')
    +>>> iter(rev)
    +<__main__.Reverse object at 0x00A1DB50>
    +>>> for char in rev:
    +...     print(char)
    +...
    +m
    +a
    +p
    +s
    +
    +
    +
    +
    +

    9.9. Generators

    +

    Generators are a simple and powerful tool for creating iterators. They +are written like regular functions but use the yield statement +whenever they want to return data. Each time next() is called on it, the +generator resumes where it left off (it remembers all the data values and which +statement was last executed). An example shows that generators can be trivially +easy to create:

    +
    def reverse(data):
    +    for index in range(len(data)-1, -1, -1):
    +        yield data[index]
    +
    +
    +
    >>> for char in reverse('golf'):
    +...     print(char)
    +...
    +f
    +l
    +o
    +g
    +
    +
    +

    Anything that can be done with generators can also be done with class-based +iterators as described in the previous section. What makes generators so +compact is that the __iter__() and __next__() methods +are created automatically.

    +

    Another key feature is that the local variables and execution state are +automatically saved between calls. This made the function easier to write and +much more clear than an approach using instance variables like self.index +and self.data.

    +

    In addition to automatic method creation and saving program state, when +generators terminate, they automatically raise StopIteration. In +combination, these features make it easy to create iterators with no more effort +than writing a regular function.

    +
    +
    +

    9.10. Generator Expressions

    +

    Some simple generators can be coded succinctly as expressions using a syntax +similar to list comprehensions but with parentheses instead of square brackets. +These expressions are designed for situations where the generator is used right +away by an enclosing function. Generator expressions are more compact but less +versatile than full generator definitions and tend to be more memory friendly +than equivalent list comprehensions.

    +

    Examples:

    +
    >>> sum(i*i for i in range(10))                 # sum of squares
    +285
    +
    +>>> xvec = [10, 20, 30]
    +>>> yvec = [7, 5, 3]
    +>>> sum(x*y for x,y in zip(xvec, yvec))         # dot product
    +260
    +
    +>>> from math import pi, sin
    +>>> sine_table = {x: sin(x*pi/180) for x in range(0, 91)}
    +
    +>>> unique_words = set(word  for line in page  for word in line.split())
    +
    +>>> valedictorian = max((student.gpa, student.name) for student in graduates)
    +
    +>>> data = 'golf'
    +>>> list(data[i] for i in range(len(data)-1, -1, -1))
    +['f', 'l', 'o', 'g']
    +
    +
    +

    Footnotes

    +
    +
    1
    +

    Except for one thing. Module objects have a secret read-only attribute called +__dict__ which returns the dictionary used to implement the module’s +namespace; the name __dict__ is an attribute but not a global name. +Obviously, using this violates the abstraction of namespace implementation, and +should be restricted to things like post-mortem debuggers.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/tutorial/controlflow.html b/python-3.7.4-docs-html/tutorial/controlflow.html new file mode 100644 index 0000000..a75c073 --- /dev/null +++ b/python-3.7.4-docs-html/tutorial/controlflow.html @@ -0,0 +1,855 @@ + + + + + + + 4. More Control Flow Tools — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    4. More Control Flow Tools

    +

    Besides the while statement just introduced, Python knows the usual +control flow statements known from other languages, with some twists.

    +
    +

    4.1. if Statements

    +

    Perhaps the most well-known statement type is the if statement. For +example:

    +
    >>> x = int(input("Please enter an integer: "))
    +Please enter an integer: 42
    +>>> if x < 0:
    +...     x = 0
    +...     print('Negative changed to zero')
    +... elif x == 0:
    +...     print('Zero')
    +... elif x == 1:
    +...     print('Single')
    +... else:
    +...     print('More')
    +...
    +More
    +
    +
    +

    There can be zero or more elif parts, and the else part is +optional. The keyword ‘elif’ is short for ‘else if’, and is useful +to avoid excessive indentation. An ifelif … +elif … sequence is a substitute for the switch or +case statements found in other languages.

    +
    +
    +

    4.2. for Statements

    +

    The for statement in Python differs a bit from what you may be used +to in C or Pascal. Rather than always iterating over an arithmetic progression +of numbers (like in Pascal), or giving the user the ability to define both the +iteration step and halting condition (as C), Python’s for statement +iterates over the items of any sequence (a list or a string), in the order that +they appear in the sequence. For example (no pun intended):

    +
    >>> # Measure some strings:
    +... words = ['cat', 'window', 'defenestrate']
    +>>> for w in words:
    +...     print(w, len(w))
    +...
    +cat 3
    +window 6
    +defenestrate 12
    +
    +
    +

    If you need to modify the sequence you are iterating over while inside the loop +(for example to duplicate selected items), it is recommended that you first +make a copy. Iterating over a sequence does not implicitly make a copy. The +slice notation makes this especially convenient:

    +
    >>> for w in words[:]:  # Loop over a slice copy of the entire list.
    +...     if len(w) > 6:
    +...         words.insert(0, w)
    +...
    +>>> words
    +['defenestrate', 'cat', 'window', 'defenestrate']
    +
    +
    +

    With for w in words:, the example would attempt to create an infinite list, +inserting defenestrate over and over again.

    +
    +
    +

    4.3. The range() Function

    +

    If you do need to iterate over a sequence of numbers, the built-in function +range() comes in handy. It generates arithmetic progressions:

    +
    >>> for i in range(5):
    +...     print(i)
    +...
    +0
    +1
    +2
    +3
    +4
    +
    +
    +

    The given end point is never part of the generated sequence; range(10) generates +10 values, the legal indices for items of a sequence of length 10. It +is possible to let the range start at another number, or to specify a different +increment (even negative; sometimes this is called the ‘step’):

    +
    range(5, 10)
    +   5, 6, 7, 8, 9
    +
    +range(0, 10, 3)
    +   0, 3, 6, 9
    +
    +range(-10, -100, -30)
    +  -10, -40, -70
    +
    +
    +

    To iterate over the indices of a sequence, you can combine range() and +len() as follows:

    +
    >>> a = ['Mary', 'had', 'a', 'little', 'lamb']
    +>>> for i in range(len(a)):
    +...     print(i, a[i])
    +...
    +0 Mary
    +1 had
    +2 a
    +3 little
    +4 lamb
    +
    +
    +

    In most such cases, however, it is convenient to use the enumerate() +function, see Looping Techniques.

    +

    A strange thing happens if you just print a range:

    +
    >>> print(range(10))
    +range(0, 10)
    +
    +
    +

    In many ways the object returned by range() behaves as if it is a list, +but in fact it isn’t. It is an object which returns the successive items of +the desired sequence when you iterate over it, but it doesn’t really make +the list, thus saving space.

    +

    We say such an object is iterable, that is, suitable as a target for +functions and constructs that expect something from which they can +obtain successive items until the supply is exhausted. We have seen that +the for statement is such an iterator. The function list() +is another; it creates lists from iterables:

    +
    >>> list(range(5))
    +[0, 1, 2, 3, 4]
    +
    +
    +

    Later we will see more functions that return iterables and take iterables as argument.

    +
    +
    +

    4.4. break and continue Statements, and else Clauses on Loops

    +

    The break statement, like in C, breaks out of the innermost enclosing +for or while loop.

    +

    Loop statements may have an else clause; it is executed when the loop +terminates through exhaustion of the list (with for) or when the +condition becomes false (with while), but not when the loop is +terminated by a break statement. This is exemplified by the +following loop, which searches for prime numbers:

    +
    >>> for n in range(2, 10):
    +...     for x in range(2, n):
    +...         if n % x == 0:
    +...             print(n, 'equals', x, '*', n//x)
    +...             break
    +...     else:
    +...         # loop fell through without finding a factor
    +...         print(n, 'is a prime number')
    +...
    +2 is a prime number
    +3 is a prime number
    +4 equals 2 * 2
    +5 is a prime number
    +6 equals 2 * 3
    +7 is a prime number
    +8 equals 2 * 4
    +9 equals 3 * 3
    +
    +
    +

    (Yes, this is the correct code. Look closely: the else clause belongs to +the for loop, not the if statement.)

    +

    When used with a loop, the else clause has more in common with the +else clause of a try statement than it does that of +if statements: a try statement’s else clause runs +when no exception occurs, and a loop’s else clause runs when no break +occurs. For more on the try statement and exceptions, see +Handling Exceptions.

    +

    The continue statement, also borrowed from C, continues with the next +iteration of the loop:

    +
    >>> for num in range(2, 10):
    +...     if num % 2 == 0:
    +...         print("Found an even number", num)
    +...         continue
    +...     print("Found a number", num)
    +Found an even number 2
    +Found a number 3
    +Found an even number 4
    +Found a number 5
    +Found an even number 6
    +Found a number 7
    +Found an even number 8
    +Found a number 9
    +
    +
    +
    +
    +

    4.5. pass Statements

    +

    The pass statement does nothing. It can be used when a statement is +required syntactically but the program requires no action. For example:

    +
    >>> while True:
    +...     pass  # Busy-wait for keyboard interrupt (Ctrl+C)
    +...
    +
    +
    +

    This is commonly used for creating minimal classes:

    +
    >>> class MyEmptyClass:
    +...     pass
    +...
    +
    +
    +

    Another place pass can be used is as a place-holder for a function or +conditional body when you are working on new code, allowing you to keep thinking +at a more abstract level. The pass is silently ignored:

    +
    >>> def initlog(*args):
    +...     pass   # Remember to implement this!
    +...
    +
    +
    +
    +
    +

    4.6. Defining Functions

    +

    We can create a function that writes the Fibonacci series to an arbitrary +boundary:

    +
    >>> def fib(n):    # write Fibonacci series up to n
    +...     """Print a Fibonacci series up to n."""
    +...     a, b = 0, 1
    +...     while a < n:
    +...         print(a, end=' ')
    +...         a, b = b, a+b
    +...     print()
    +...
    +>>> # Now call the function we just defined:
    +... fib(2000)
    +0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987 1597
    +
    +
    +

    The keyword def introduces a function definition. It must be +followed by the function name and the parenthesized list of formal parameters. +The statements that form the body of the function start at the next line, and +must be indented.

    +

    The first statement of the function body can optionally be a string literal; +this string literal is the function’s documentation string, or docstring. +(More about docstrings can be found in the section Documentation Strings.) +There are tools which use docstrings to automatically produce online or printed +documentation, or to let the user interactively browse through code; it’s good +practice to include docstrings in code that you write, so make a habit of it.

    +

    The execution of a function introduces a new symbol table used for the local +variables of the function. More precisely, all variable assignments in a +function store the value in the local symbol table; whereas variable references +first look in the local symbol table, then in the local symbol tables of +enclosing functions, then in the global symbol table, and finally in the table +of built-in names. Thus, global variables and variables of enclosing functions +cannot be directly assigned a value within a function (unless, for global +variables, named in a global statement, or, for variables of enclosing +functions, named in a nonlocal statement), although they may be +referenced.

    +

    The actual parameters (arguments) to a function call are introduced in the local +symbol table of the called function when it is called; thus, arguments are +passed using call by value (where the value is always an object reference, +not the value of the object). 1 When a function calls another function, a new +local symbol table is created for that call.

    +

    A function definition introduces the function name in the current symbol table. +The value of the function name has a type that is recognized by the interpreter +as a user-defined function. This value can be assigned to another name which +can then also be used as a function. This serves as a general renaming +mechanism:

    +
    >>> fib
    +<function fib at 10042ed0>
    +>>> f = fib
    +>>> f(100)
    +0 1 1 2 3 5 8 13 21 34 55 89
    +
    +
    +

    Coming from other languages, you might object that fib is not a function but +a procedure since it doesn’t return a value. In fact, even functions without a +return statement do return a value, albeit a rather boring one. This +value is called None (it’s a built-in name). Writing the value None is +normally suppressed by the interpreter if it would be the only value written. +You can see it if you really want to using print():

    +
    >>> fib(0)
    +>>> print(fib(0))
    +None
    +
    +
    +

    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
    +...     """Return a list containing the Fibonacci series up to n."""
    +...     result = []
    +...     a, b = 0, 1
    +...     while a < n:
    +...         result.append(a)    # see below
    +...         a, b = b, a+b
    +...     return result
    +...
    +>>> f100 = fib2(100)    # call it
    +>>> f100                # write the result
    +[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]
    +
    +
    +

    This example, as usual, demonstrates some new Python features:

    +
      +
    • The return statement returns with a value from a function. +return without an expression argument returns None. Falling off +the end of a function also returns None.

    • +
    • The statement result.append(a) calls a method of the list object +result. A method is a function that ‘belongs’ to an object and is named +obj.methodname, where obj is some object (this may be an expression), +and methodname is the name of a method that is defined by the object’s type. +Different types define different methods. Methods of different types may have +the same name without causing ambiguity. (It is possible to define your own +object types and methods, using classes, see Classes) +The method append() shown in the example is defined for list objects; it +adds a new element at the end of the list. In this example it is equivalent to +result = result + [a], but more efficient.

    • +
    +
    +
    +

    4.7. More on Defining Functions

    +

    It is also possible to define functions with a variable number of arguments. +There are three forms, which can be combined.

    +
    +

    4.7.1. Default Argument Values

    +

    The most useful form is to specify a default value for one or more arguments. +This creates a function that can be called with fewer arguments than it is +defined to allow. For example:

    +
    def ask_ok(prompt, retries=4, reminder='Please try again!'):
    +    while True:
    +        ok = input(prompt)
    +        if ok in ('y', 'ye', 'yes'):
    +            return True
    +        if ok in ('n', 'no', 'nop', 'nope'):
    +            return False
    +        retries = retries - 1
    +        if retries < 0:
    +            raise ValueError('invalid user response')
    +        print(reminder)
    +
    +
    +

    This function can be called in several ways:

    +
      +
    • giving only the mandatory argument: +ask_ok('Do you really want to quit?')

    • +
    • giving one of the optional arguments: +ask_ok('OK to overwrite the file?', 2)

    • +
    • or even giving all arguments: +ask_ok('OK to overwrite the file?', 2, 'Come on, only yes or no!')

    • +
    +

    This example also introduces the in keyword. This tests whether or +not a sequence contains a certain value.

    +

    The default values are evaluated at the point of function definition in the +defining scope, so that

    +
    i = 5
    +
    +def f(arg=i):
    +    print(arg)
    +
    +i = 6
    +f()
    +
    +
    +

    will print 5.

    +

    Important warning: The default value is evaluated only once. This makes a +difference when the default is a mutable object such as a list, dictionary, or +instances of most classes. For example, the following function accumulates the +arguments passed to it on subsequent calls:

    +
    def f(a, L=[]):
    +    L.append(a)
    +    return L
    +
    +print(f(1))
    +print(f(2))
    +print(f(3))
    +
    +
    +

    This will print

    +
    [1]
    +[1, 2]
    +[1, 2, 3]
    +
    +
    +

    If you don’t want the default to be shared between subsequent calls, you can +write the function like this instead:

    +
    def f(a, L=None):
    +    if L is None:
    +        L = []
    +    L.append(a)
    +    return L
    +
    +
    +
    +
    +

    4.7.2. Keyword Arguments

    +

    Functions can also be called using keyword arguments +of the form kwarg=value. For instance, the following function:

    +
    def parrot(voltage, state='a stiff', action='voom', type='Norwegian Blue'):
    +    print("-- This parrot wouldn't", action, end=' ')
    +    print("if you put", voltage, "volts through it.")
    +    print("-- Lovely plumage, the", type)
    +    print("-- It's", state, "!")
    +
    +
    +

    accepts one required argument (voltage) and three optional arguments +(state, action, and type). This function can be called in any +of the following ways:

    +
    parrot(1000)                                          # 1 positional argument
    +parrot(voltage=1000)                                  # 1 keyword argument
    +parrot(voltage=1000000, action='VOOOOOM')             # 2 keyword arguments
    +parrot(action='VOOOOOM', voltage=1000000)             # 2 keyword arguments
    +parrot('a million', 'bereft of life', 'jump')         # 3 positional arguments
    +parrot('a thousand', state='pushing up the daisies')  # 1 positional, 1 keyword
    +
    +
    +

    but all the following calls would be invalid:

    +
    parrot()                     # required argument missing
    +parrot(voltage=5.0, 'dead')  # non-keyword argument after a keyword argument
    +parrot(110, voltage=220)     # duplicate value for the same argument
    +parrot(actor='John Cleese')  # unknown keyword argument
    +
    +
    +

    In a function call, keyword arguments must follow positional arguments. +All the keyword arguments passed must match one of the arguments +accepted by the function (e.g. actor is not a valid argument for the +parrot function), and their order is not important. This also includes +non-optional arguments (e.g. parrot(voltage=1000) is valid too). +No argument may receive a value more than once. +Here’s an example that fails due to this restriction:

    +
    >>> def function(a):
    +...     pass
    +...
    +>>> function(0, a=0)
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +TypeError: function() got multiple values for keyword argument 'a'
    +
    +
    +

    When a final formal parameter of the form **name is present, it receives a +dictionary (see Mapping Types — dict) containing all keyword arguments except for +those corresponding to a formal parameter. This may be combined with a formal +parameter of the form *name (described in the next subsection) which +receives a tuple containing the positional +arguments beyond the formal parameter list. (*name must occur +before **name.) For example, if we define a function like this:

    +
    def cheeseshop(kind, *arguments, **keywords):
    +    print("-- Do you have any", kind, "?")
    +    print("-- I'm sorry, we're all out of", kind)
    +    for arg in arguments:
    +        print(arg)
    +    print("-" * 40)
    +    for kw in keywords:
    +        print(kw, ":", keywords[kw])
    +
    +
    +

    It could be called like this:

    +
    cheeseshop("Limburger", "It's very runny, sir.",
    +           "It's really very, VERY runny, sir.",
    +           shopkeeper="Michael Palin",
    +           client="John Cleese",
    +           sketch="Cheese Shop Sketch")
    +
    +
    +

    and of course it would print:

    +
    -- Do you have any Limburger ?
    +-- I'm sorry, we're all out of Limburger
    +It's very runny, sir.
    +It's really very, VERY runny, sir.
    +----------------------------------------
    +shopkeeper : Michael Palin
    +client : John Cleese
    +sketch : Cheese Shop Sketch
    +
    +
    +

    Note that the order in which the keyword arguments are printed is guaranteed +to match the order in which they were provided in the function call.

    +
    +
    +

    4.7.3. Arbitrary Argument Lists

    +

    Finally, the least frequently used option is to specify that a function can be +called with an arbitrary number of arguments. These arguments will be wrapped +up in a tuple (see Tuples and Sequences). Before the variable number of arguments, +zero or more normal arguments may occur.

    +
    def write_multiple_items(file, separator, *args):
    +    file.write(separator.join(args))
    +
    +
    +

    Normally, these variadic arguments will be last in the list of formal +parameters, because they scoop up all remaining input arguments that are +passed to the function. Any formal parameters which occur after the *args +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)
    +...
    +>>> concat("earth", "mars", "venus")
    +'earth/mars/venus'
    +>>> concat("earth", "mars", "venus", sep=".")
    +'earth.mars.venus'
    +
    +
    +
    +
    +

    4.7.4. Unpacking Argument Lists

    +

    The reverse situation occurs when the arguments are already in a list or tuple +but need to be unpacked for a function call requiring separate positional +arguments. For instance, the built-in range() function expects separate +start and stop arguments. If they are not available separately, write the +function call with the * operator to unpack the arguments out of a list +or tuple:

    +
    >>> list(range(3, 6))            # normal call with separate arguments
    +[3, 4, 5]
    +>>> args = [3, 6]
    +>>> list(range(*args))            # call with arguments unpacked from a list
    +[3, 4, 5]
    +
    +
    +

    In the same fashion, dictionaries can deliver keyword arguments with the +** operator:

    +
    >>> def parrot(voltage, state='a stiff', action='voom'):
    +...     print("-- This parrot wouldn't", action, end=' ')
    +...     print("if you put", voltage, "volts through it.", end=' ')
    +...     print("E's", state, "!")
    +...
    +>>> d = {"voltage": "four million", "state": "bleedin' demised", "action": "VOOM"}
    +>>> parrot(**d)
    +-- This parrot wouldn't VOOM if you put four million volts through it. E's bleedin' demised !
    +
    +
    +
    +
    +

    4.7.5. Lambda Expressions

    +

    Small anonymous functions can be created with the lambda keyword. +This function returns the sum of its two arguments: lambda a, b: a+b. +Lambda functions can be used wherever function objects are required. They are +syntactically restricted to a single expression. Semantically, they are just +syntactic sugar for a normal function definition. Like nested function +definitions, lambda functions can reference variables from the containing +scope:

    +
    >>> def make_incrementor(n):
    +...     return lambda x: x + n
    +...
    +>>> f = make_incrementor(42)
    +>>> f(0)
    +42
    +>>> f(1)
    +43
    +
    +
    +

    The above example uses a lambda expression to return a function. Another use +is to pass a small function as an argument:

    +
    >>> pairs = [(1, 'one'), (2, 'two'), (3, 'three'), (4, 'four')]
    +>>> pairs.sort(key=lambda pair: pair[1])
    +>>> pairs
    +[(4, 'four'), (1, 'one'), (3, 'three'), (2, 'two')]
    +
    +
    +
    +
    +

    4.7.6. Documentation Strings

    +

    Here are some conventions about the content and formatting of documentation +strings.

    +

    The first line should always be a short, concise summary of the object’s +purpose. For brevity, it should not explicitly state the object’s name or type, +since these are available by other means (except if the name happens to be a +verb describing a function’s operation). This line should begin with a capital +letter and end with a period.

    +

    If there are more lines in the documentation string, the second line should be +blank, visually separating the summary from the rest of the description. The +following lines should be one or more paragraphs describing the object’s calling +conventions, its side effects, etc.

    +

    The Python parser does not strip indentation from multi-line string literals in +Python, so tools that process documentation have to strip indentation if +desired. This is done using the following convention. The first non-blank line +after the first line of the string determines the amount of indentation for +the entire documentation string. (We can’t use the first line since it is +generally adjacent to the string’s opening quotes so its indentation is not +apparent in the string literal.) Whitespace “equivalent” to this indentation is +then stripped from the start of all lines of the string. Lines that are +indented less should not occur, but if they occur all their leading whitespace +should be stripped. Equivalence of whitespace should be tested after expansion +of tabs (to 8 spaces, normally).

    +

    Here is an example of a multi-line docstring:

    +
    >>> def my_function():
    +...     """Do nothing, but document it.
    +...
    +...     No, really, it doesn't do anything.
    +...     """
    +...     pass
    +...
    +>>> print(my_function.__doc__)
    +Do nothing, but document it.
    +
    +    No, really, it doesn't do anything.
    +
    +
    +
    +
    +

    4.7.7. Function Annotations

    +

    Function annotations are completely optional metadata +information about the types used by user-defined functions (see PEP 3107 and +PEP 484 for more information).

    +

    Annotations are stored in the __annotations__ +attribute of the function as a dictionary and have no effect on any other part of the +function. Parameter annotations are defined by a colon after the parameter name, followed +by an expression evaluating to the value of the annotation. Return annotations are +defined by a literal ->, followed by an expression, between the parameter +list and the colon denoting the end of the def statement. The +following example has a positional argument, a keyword argument, and the return +value annotated:

    +
    >>> def f(ham: str, eggs: str = 'eggs') -> str:
    +...     print("Annotations:", f.__annotations__)
    +...     print("Arguments:", ham, eggs)
    +...     return ham + ' and ' + eggs
    +...
    +>>> f('spam')
    +Annotations: {'ham': <class 'str'>, 'return': <class 'str'>, 'eggs': <class 'str'>}
    +Arguments: spam eggs
    +'spam and eggs'
    +
    +
    +
    +
    +
    +

    4.8. Intermezzo: Coding Style

    +

    Now that you are about to write longer, more complex pieces of Python, it is a +good time to talk about coding style. Most languages can be written (or more +concise, formatted) in different styles; some are more readable than others. +Making it easy for others to read your code is always a good idea, and adopting +a nice coding style helps tremendously for that.

    +

    For Python, PEP 8 has emerged as the style guide that most projects adhere to; +it promotes a very readable and eye-pleasing coding style. Every Python +developer should read it at some point; here are the most important points +extracted for you:

    +
      +
    • Use 4-space indentation, and no tabs.

      +

      4 spaces are a good compromise between small indentation (allows greater +nesting depth) and large indentation (easier to read). Tabs introduce +confusion, and are best left out.

      +
    • +
    • Wrap lines so that they don’t exceed 79 characters.

      +

      This helps users with small displays and makes it possible to have several +code files side-by-side on larger displays.

      +
    • +
    • Use blank lines to separate functions and classes, and larger blocks of +code inside functions.

    • +
    • When possible, put comments on a line of their own.

    • +
    • Use docstrings.

    • +
    • Use spaces around operators and after commas, but not directly inside +bracketing constructs: a = f(1, 2) + g(3, 4).

    • +
    • Name your classes and functions consistently; the convention is to use +UpperCamelCase for classes and lowercase_with_underscores for functions +and methods. Always use self as the name for the first method argument +(see A First Look at Classes for more on classes and methods).

    • +
    • Don’t use fancy encodings if your code is meant to be used in international +environments. Python’s default, UTF-8, or even plain ASCII work best in any +case.

    • +
    • Likewise, don’t use non-ASCII characters in identifiers if there is only the +slightest chance people speaking a different language will read or maintain +the code.

    • +
    +

    Footnotes

    +
    +
    1
    +

    Actually, call by object reference would be a better description, +since if a mutable object is passed, the caller will see any changes the +callee makes to it (items inserted into a list).

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/tutorial/datastructures.html b/python-3.7.4-docs-html/tutorial/datastructures.html new file mode 100644 index 0000000..26bbfc8 --- /dev/null +++ b/python-3.7.4-docs-html/tutorial/datastructures.html @@ -0,0 +1,844 @@ + + + + + + + 5. Data Structures — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    5. Data Structures

    +

    This chapter describes some things you’ve learned about already in more detail, +and adds some new things as well.

    +
    +

    5.1. More on Lists

    +

    The list data type has some more methods. Here are all of the methods of list +objects:

    +
    +
    +list.append(x)
    +

    Add an item to the end of the list. Equivalent to a[len(a):] = [x].

    +
    + +
    +
    +list.extend(iterable)
    +

    Extend the list by appending all the items from the iterable. Equivalent to +a[len(a):] = iterable.

    +
    + +
    +
    +list.insert(i, x)
    +

    Insert an item at a given position. The first argument is the index of the +element before which to insert, so a.insert(0, x) inserts at the front of +the list, and a.insert(len(a), x) is equivalent to a.append(x).

    +
    + +
    +
    +list.remove(x)
    +

    Remove the first item from the list whose value is equal to x. It raises a +ValueError if there is no such item.

    +
    + +
    +
    +list.pop([i])
    +

    Remove the item at the given position in the list, and return it. If no index +is specified, a.pop() removes and returns the last item in the list. (The +square brackets around the i in the method signature denote that the parameter +is optional, not that you should type square brackets at that position. You +will see this notation frequently in the Python Library Reference.)

    +
    + +
    +
    +list.clear()
    +

    Remove all items from the list. Equivalent to del a[:].

    +
    + +
    +
    +list.index(x[, start[, end]])
    +

    Return zero-based index in the list of the first item whose value is equal to x. +Raises a ValueError if there is no such item.

    +

    The optional arguments start and end are interpreted as in the slice +notation and are used to limit the search to a particular subsequence of +the list. The returned index is computed relative to the beginning of the full +sequence rather than the start argument.

    +
    + +
    +
    +list.count(x)
    +

    Return the number of times x appears in the list.

    +
    + +
    +
    +list.sort(key=None, reverse=False)
    +

    Sort the items of the list in place (the arguments can be used for sort +customization, see sorted() for their explanation).

    +
    + +
    +
    +list.reverse()
    +

    Reverse the elements of the list in place.

    +
    + +
    +
    +list.copy()
    +

    Return a shallow copy of the list. Equivalent to a[:].

    +
    + +

    An example that uses most of the list methods:

    +
    >>> fruits = ['orange', 'apple', 'pear', 'banana', 'kiwi', 'apple', 'banana']
    +>>> fruits.count('apple')
    +2
    +>>> fruits.count('tangerine')
    +0
    +>>> fruits.index('banana')
    +3
    +>>> fruits.index('banana', 4)  # Find next banana starting a position 4
    +6
    +>>> fruits.reverse()
    +>>> fruits
    +['banana', 'apple', 'kiwi', 'banana', 'pear', 'apple', 'orange']
    +>>> fruits.append('grape')
    +>>> fruits
    +['banana', 'apple', 'kiwi', 'banana', 'pear', 'apple', 'orange', 'grape']
    +>>> fruits.sort()
    +>>> fruits
    +['apple', 'apple', 'banana', 'banana', 'grape', 'kiwi', 'orange', 'pear']
    +>>> fruits.pop()
    +'pear'
    +
    +
    +

    You might have noticed that methods like insert, remove or sort that +only modify the list have no return value printed – they return the default +None. 1 This is a design principle for all mutable data structures in +Python.

    +
    +

    5.1.1. Using Lists as Stacks

    +

    The list methods make it very easy to use a list as a stack, where the last +element added is the first element retrieved (“last-in, first-out”). To add an +item to the top of the stack, use append(). To retrieve an item from the +top of the stack, use pop() without an explicit index. For example:

    +
    >>> stack = [3, 4, 5]
    +>>> stack.append(6)
    +>>> stack.append(7)
    +>>> stack
    +[3, 4, 5, 6, 7]
    +>>> stack.pop()
    +7
    +>>> stack
    +[3, 4, 5, 6]
    +>>> stack.pop()
    +6
    +>>> stack.pop()
    +5
    +>>> stack
    +[3, 4]
    +
    +
    +
    +
    +

    5.1.2. Using Lists as Queues

    +

    It is also possible to use a list as a queue, where the first element added is +the first element retrieved (“first-in, first-out”); however, lists are not +efficient for this purpose. While appends and pops from the end of list are +fast, doing inserts or pops from the beginning of a list is slow (because all +of the other elements have to be shifted by one).

    +

    To implement a queue, use collections.deque which was designed to +have fast appends and pops from both ends. For example:

    +
    >>> from collections import deque
    +>>> queue = deque(["Eric", "John", "Michael"])
    +>>> queue.append("Terry")           # Terry arrives
    +>>> queue.append("Graham")          # Graham arrives
    +>>> queue.popleft()                 # The first to arrive now leaves
    +'Eric'
    +>>> queue.popleft()                 # The second to arrive now leaves
    +'John'
    +>>> queue                           # Remaining queue in order of arrival
    +deque(['Michael', 'Terry', 'Graham'])
    +
    +
    +
    +
    +

    5.1.3. List Comprehensions

    +

    List comprehensions provide a concise way to create lists. +Common applications are to make new lists where each element is the result of +some operations applied to each member of another sequence or iterable, or to +create a subsequence of those elements that satisfy a certain condition.

    +

    For example, assume we want to create a list of squares, like:

    +
    >>> squares = []
    +>>> for x in range(10):
    +...     squares.append(x**2)
    +...
    +>>> squares
    +[0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
    +
    +
    +

    Note that this creates (or overwrites) a variable named x that still exists +after the loop completes. We can calculate the list of squares without any +side effects using:

    +
    squares = list(map(lambda x: x**2, range(10)))
    +
    +
    +

    or, equivalently:

    +
    squares = [x**2 for x in range(10)]
    +
    +
    +

    which is more concise and readable.

    +

    A list comprehension consists of brackets containing an expression followed +by a for clause, then zero or more for or if +clauses. The result will be a new list resulting from evaluating the expression +in the context of the for and if clauses which follow it. +For example, this listcomp combines the elements of two lists if they are not +equal:

    +
    >>> [(x, y) for x in [1,2,3] for y in [3,1,4] if x != y]
    +[(1, 3), (1, 4), (2, 3), (2, 1), (2, 4), (3, 1), (3, 4)]
    +
    +
    +

    and it’s equivalent to:

    +
    >>> combs = []
    +>>> for x in [1,2,3]:
    +...     for y in [3,1,4]:
    +...         if x != y:
    +...             combs.append((x, y))
    +...
    +>>> combs
    +[(1, 3), (1, 4), (2, 3), (2, 1), (2, 4), (3, 1), (3, 4)]
    +
    +
    +

    Note how the order of the for and if statements is the +same in both these snippets.

    +

    If the expression is a tuple (e.g. the (x, y) in the previous example), +it must be parenthesized.

    +
    >>> vec = [-4, -2, 0, 2, 4]
    +>>> # create a new list with the values doubled
    +>>> [x*2 for x in vec]
    +[-8, -4, 0, 4, 8]
    +>>> # filter the list to exclude negative numbers
    +>>> [x for x in vec if x >= 0]
    +[0, 2, 4]
    +>>> # apply a function to all the elements
    +>>> [abs(x) for x in vec]
    +[4, 2, 0, 2, 4]
    +>>> # call a method on each element
    +>>> freshfruit = ['  banana', '  loganberry ', 'passion fruit  ']
    +>>> [weapon.strip() for weapon in freshfruit]
    +['banana', 'loganberry', 'passion fruit']
    +>>> # create a list of 2-tuples like (number, square)
    +>>> [(x, x**2) for x in range(6)]
    +[(0, 0), (1, 1), (2, 4), (3, 9), (4, 16), (5, 25)]
    +>>> # the tuple must be parenthesized, otherwise an error is raised
    +>>> [x, x**2 for x in range(6)]
    +  File "<stdin>", line 1, in <module>
    +    [x, x**2 for x in range(6)]
    +               ^
    +SyntaxError: invalid syntax
    +>>> # flatten a list using a listcomp with two 'for'
    +>>> vec = [[1,2,3], [4,5,6], [7,8,9]]
    +>>> [num for elem in vec for num in elem]
    +[1, 2, 3, 4, 5, 6, 7, 8, 9]
    +
    +
    +

    List comprehensions can contain complex expressions and nested functions:

    +
    >>> from math import pi
    +>>> [str(round(pi, i)) for i in range(1, 6)]
    +['3.1', '3.14', '3.142', '3.1416', '3.14159']
    +
    +
    +
    +
    +

    5.1.4. Nested List Comprehensions

    +

    The initial expression in a list comprehension can be any arbitrary expression, +including another list comprehension.

    +

    Consider the following example of a 3x4 matrix implemented as a list of +3 lists of length 4:

    +
    >>> matrix = [
    +...     [1, 2, 3, 4],
    +...     [5, 6, 7, 8],
    +...     [9, 10, 11, 12],
    +... ]
    +
    +
    +

    The following list comprehension will transpose rows and columns:

    +
    >>> [[row[i] for row in matrix] for i in range(4)]
    +[[1, 5, 9], [2, 6, 10], [3, 7, 11], [4, 8, 12]]
    +
    +
    +

    As we saw in the previous section, the nested listcomp is evaluated in +the context of the for that follows it, so this example is +equivalent to:

    +
    >>> transposed = []
    +>>> for i in range(4):
    +...     transposed.append([row[i] for row in matrix])
    +...
    +>>> transposed
    +[[1, 5, 9], [2, 6, 10], [3, 7, 11], [4, 8, 12]]
    +
    +
    +

    which, in turn, is the same as:

    +
    >>> transposed = []
    +>>> for i in range(4):
    +...     # the following 3 lines implement the nested listcomp
    +...     transposed_row = []
    +...     for row in matrix:
    +...         transposed_row.append(row[i])
    +...     transposed.append(transposed_row)
    +...
    +>>> transposed
    +[[1, 5, 9], [2, 6, 10], [3, 7, 11], [4, 8, 12]]
    +
    +
    +

    In the real world, you should prefer built-in functions to complex flow statements. +The zip() function would do a great job for this use case:

    +
    >>> list(zip(*matrix))
    +[(1, 5, 9), (2, 6, 10), (3, 7, 11), (4, 8, 12)]
    +
    +
    +

    See Unpacking Argument Lists for details on the asterisk in this line.

    +
    +
    +
    +

    5.2. The del statement

    +

    There is a way to remove an item from a list given its index instead of its +value: the del statement. This differs from the pop() method +which returns a value. The del statement can also be used to remove +slices from a list or clear the entire list (which we did earlier by assignment +of an empty list to the slice). For example:

    +
    >>> a = [-1, 1, 66.25, 333, 333, 1234.5]
    +>>> del a[0]
    +>>> a
    +[1, 66.25, 333, 333, 1234.5]
    +>>> del a[2:4]
    +>>> a
    +[1, 66.25, 1234.5]
    +>>> del a[:]
    +>>> a
    +[]
    +
    +
    +

    del can also be used to delete entire variables:

    +
    >>> del a
    +
    +
    +

    Referencing the name a hereafter is an error (at least until another value +is assigned to it). We’ll find other uses for del later.

    +
    +
    +

    5.3. Tuples and Sequences

    +

    We saw that lists and strings have many common properties, such as indexing and +slicing operations. They are two examples of sequence data types (see +Sequence Types — list, tuple, range). Since Python is an evolving language, other sequence data +types may be added. There is also another standard sequence data type: the +tuple.

    +

    A tuple consists of a number of values separated by commas, for instance:

    +
    >>> t = 12345, 54321, 'hello!'
    +>>> t[0]
    +12345
    +>>> t
    +(12345, 54321, 'hello!')
    +>>> # Tuples may be nested:
    +... u = t, (1, 2, 3, 4, 5)
    +>>> u
    +((12345, 54321, 'hello!'), (1, 2, 3, 4, 5))
    +>>> # Tuples are immutable:
    +... t[0] = 88888
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +TypeError: 'tuple' object does not support item assignment
    +>>> # but they can contain mutable objects:
    +... v = ([1, 2, 3], [3, 2, 1])
    +>>> v
    +([1, 2, 3], [3, 2, 1])
    +
    +
    +

    As you see, on output tuples are always enclosed in parentheses, so that nested +tuples are interpreted correctly; they may be input with or without surrounding +parentheses, although often parentheses are necessary anyway (if the tuple is +part of a larger expression). It is not possible to assign to the individual +items of a tuple, however it is possible to create tuples which contain mutable +objects, such as lists.

    +

    Though tuples may seem similar to lists, they are often used in different +situations and for different purposes. +Tuples are immutable, and usually contain a heterogeneous sequence of +elements that are accessed via unpacking (see later in this section) or indexing +(or even by attribute in the case of namedtuples). +Lists are mutable, and their elements are usually homogeneous and are +accessed by iterating over the list.

    +

    A special problem is the construction of tuples containing 0 or 1 items: the +syntax has some extra quirks to accommodate these. Empty tuples are constructed +by an empty pair of parentheses; a tuple with one item is constructed by +following a value with a comma (it is not sufficient to enclose a single value +in parentheses). Ugly, but effective. For example:

    +
    >>> empty = ()
    +>>> singleton = 'hello',    # <-- note trailing comma
    +>>> len(empty)
    +0
    +>>> len(singleton)
    +1
    +>>> singleton
    +('hello',)
    +
    +
    +

    The statement t = 12345, 54321, 'hello!' is an example of tuple packing: +the values 12345, 54321 and 'hello!' are packed together in a tuple. +The reverse operation is also possible:

    +
    >>> x, y, z = t
    +
    +
    +

    This is called, appropriately enough, sequence unpacking and works for any +sequence on the right-hand side. Sequence unpacking requires that there are as +many variables on the left side of the equals sign as there are elements in the +sequence. Note that multiple assignment is really just a combination of tuple +packing and sequence unpacking.

    +
    +
    +

    5.4. Sets

    +

    Python also includes a data type for sets. A set is an unordered collection +with no duplicate elements. Basic uses include membership testing and +eliminating duplicate entries. Set objects also support mathematical operations +like union, intersection, difference, and symmetric difference.

    +

    Curly braces or the set() function can be used to create sets. Note: to +create an empty set you have to use set(), not {}; the latter creates an +empty dictionary, a data structure that we discuss in the next section.

    +

    Here is a brief demonstration:

    +
    >>> basket = {'apple', 'orange', 'apple', 'pear', 'orange', 'banana'}
    +>>> print(basket)                      # show that duplicates have been removed
    +{'orange', 'banana', 'pear', 'apple'}
    +>>> 'orange' in basket                 # fast membership testing
    +True
    +>>> 'crabgrass' in basket
    +False
    +
    +>>> # Demonstrate set operations on unique letters from two words
    +...
    +>>> a = set('abracadabra')
    +>>> b = set('alacazam')
    +>>> a                                  # unique letters in a
    +{'a', 'r', 'b', 'c', 'd'}
    +>>> a - b                              # letters in a but not in b
    +{'r', 'd', 'b'}
    +>>> a | b                              # letters in a or b or both
    +{'a', 'c', 'r', 'd', 'b', 'm', 'z', 'l'}
    +>>> a & b                              # letters in both a and b
    +{'a', 'c'}
    +>>> a ^ b                              # letters in a or b but not both
    +{'r', 'd', 'b', 'm', 'z', 'l'}
    +
    +
    +

    Similarly to list comprehensions, set comprehensions +are also supported:

    +
    >>> a = {x for x in 'abracadabra' if x not in 'abc'}
    +>>> a
    +{'r', 'd'}
    +
    +
    +
    +
    +

    5.5. Dictionaries

    +

    Another useful data type built into Python is the dictionary (see +Mapping Types — dict). Dictionaries are sometimes found in other languages as +“associative memories” or “associative arrays”. Unlike sequences, which are +indexed by a range of numbers, dictionaries are indexed by keys, which can be +any immutable type; strings and numbers can always be keys. Tuples can be used +as keys if they contain only strings, numbers, or tuples; if a tuple contains +any mutable object either directly or indirectly, it cannot be used as a key. +You can’t use lists as keys, since lists can be modified in place using index +assignments, slice assignments, or methods like append() and +extend().

    +

    It is best to think of a dictionary as a set of key: value pairs, +with the requirement that the keys are unique (within one dictionary). A pair of +braces creates an empty dictionary: {}. Placing a comma-separated list of +key:value pairs within the braces adds initial key:value pairs to the +dictionary; this is also the way dictionaries are written on output.

    +

    The main operations on a dictionary are storing a value with some key and +extracting the value given the key. It is also possible to delete a key:value +pair with del. If you store using a key that is already in use, the old +value associated with that key is forgotten. It is an error to extract a value +using a non-existent key.

    +

    Performing list(d) on a dictionary returns a list of all the keys +used in the dictionary, in insertion order (if you want it sorted, just use +sorted(d) instead). To check whether a single key is in the +dictionary, use the in keyword.

    +

    Here is a small example using a dictionary:

    +
    >>> tel = {'jack': 4098, 'sape': 4139}
    +>>> tel['guido'] = 4127
    +>>> tel
    +{'jack': 4098, 'sape': 4139, 'guido': 4127}
    +>>> tel['jack']
    +4098
    +>>> del tel['sape']
    +>>> tel['irv'] = 4127
    +>>> tel
    +{'jack': 4098, 'guido': 4127, 'irv': 4127}
    +>>> list(tel)
    +['jack', 'guido', 'irv']
    +>>> sorted(tel)
    +['guido', 'irv', 'jack']
    +>>> 'guido' in tel
    +True
    +>>> 'jack' not in tel
    +False
    +
    +
    +

    The dict() constructor builds dictionaries directly from sequences of +key-value pairs:

    +
    >>> dict([('sape', 4139), ('guido', 4127), ('jack', 4098)])
    +{'sape': 4139, 'guido': 4127, 'jack': 4098}
    +
    +
    +

    In addition, dict comprehensions can be used to create dictionaries from +arbitrary key and value expressions:

    +
    >>> {x: x**2 for x in (2, 4, 6)}
    +{2: 4, 4: 16, 6: 36}
    +
    +
    +

    When the keys are simple strings, it is sometimes easier to specify pairs using +keyword arguments:

    +
    >>> dict(sape=4139, guido=4127, jack=4098)
    +{'sape': 4139, 'guido': 4127, 'jack': 4098}
    +
    +
    +
    +
    +

    5.6. Looping Techniques

    +

    When looping through dictionaries, the key and corresponding value can be +retrieved at the same time using the items() method.

    +
    >>> knights = {'gallahad': 'the pure', 'robin': 'the brave'}
    +>>> for k, v in knights.items():
    +...     print(k, v)
    +...
    +gallahad the pure
    +robin the brave
    +
    +
    +

    When looping through a sequence, the position index and corresponding value can +be retrieved at the same time using the enumerate() function.

    +
    >>> for i, v in enumerate(['tic', 'tac', 'toe']):
    +...     print(i, v)
    +...
    +0 tic
    +1 tac
    +2 toe
    +
    +
    +

    To loop over two or more sequences at the same time, the entries can be paired +with the zip() function.

    +
    >>> questions = ['name', 'quest', 'favorite color']
    +>>> answers = ['lancelot', 'the holy grail', 'blue']
    +>>> for q, a in zip(questions, answers):
    +...     print('What is your {0}?  It is {1}.'.format(q, a))
    +...
    +What is your name?  It is lancelot.
    +What is your quest?  It is the holy grail.
    +What is your favorite color?  It is blue.
    +
    +
    +

    To loop over a sequence in reverse, first specify the sequence in a forward +direction and then call the reversed() function.

    +
    >>> for i in reversed(range(1, 10, 2)):
    +...     print(i)
    +...
    +9
    +7
    +5
    +3
    +1
    +
    +
    +

    To loop over a sequence in sorted order, use the sorted() function which +returns a new sorted list while leaving the source unaltered.

    +
    >>> basket = ['apple', 'orange', 'apple', 'pear', 'orange', 'banana']
    +>>> for f in sorted(set(basket)):
    +...     print(f)
    +...
    +apple
    +banana
    +orange
    +pear
    +
    +
    +

    It is sometimes tempting to change a list while you are looping over it; +however, it is often simpler and safer to create a new list instead.

    +
    >>> import math
    +>>> raw_data = [56.2, float('NaN'), 51.7, 55.3, 52.5, float('NaN'), 47.8]
    +>>> filtered_data = []
    +>>> for value in raw_data:
    +...     if not math.isnan(value):
    +...         filtered_data.append(value)
    +...
    +>>> filtered_data
    +[56.2, 51.7, 55.3, 52.5, 47.8]
    +
    +
    +
    +
    +

    5.7. More on Conditions

    +

    The conditions used in while and if statements can contain any +operators, not just comparisons.

    +

    The comparison operators in and not in check whether a value occurs +(does not occur) in a sequence. The operators is and is not compare +whether two objects are really the same object; this only matters for mutable +objects like lists. All comparison operators have the same priority, which is +lower than that of all numerical operators.

    +

    Comparisons can be chained. For example, a < b == c tests whether a is +less than b and moreover b equals c.

    +

    Comparisons may be combined using the Boolean operators and and or, and +the outcome of a comparison (or of any other Boolean expression) may be negated +with not. These have lower priorities than comparison operators; between +them, not has the highest priority and or the lowest, so that A and +not B or C is equivalent to (A and (not B)) or C. As always, parentheses +can be used to express the desired composition.

    +

    The Boolean operators and and or are so-called short-circuit +operators: their arguments are evaluated from left to right, and evaluation +stops as soon as the outcome is determined. For example, if A and C are +true but B is false, A and B and C does not evaluate the expression +C. When used as a general value and not as a Boolean, the return value of a +short-circuit operator is the last evaluated argument.

    +

    It is possible to assign the result of a comparison or other Boolean expression +to a variable. For example,

    +
    >>> string1, string2, string3 = '', 'Trondheim', 'Hammer Dance'
    +>>> non_null = string1 or string2 or string3
    +>>> non_null
    +'Trondheim'
    +
    +
    +

    Note that in Python, unlike C, assignment cannot occur inside expressions. C +programmers may grumble about this, but it avoids a common class of problems +encountered in C programs: typing = in an expression when == was +intended.

    +
    +
    +

    5.8. Comparing Sequences and Other Types

    +

    Sequence objects may be compared to other objects with the same sequence type. +The comparison uses lexicographical ordering: first the first two items are +compared, and if they differ this determines the outcome of the comparison; if +they are equal, the next two items are compared, and so on, until either +sequence is exhausted. If two items to be compared are themselves sequences of +the same type, the lexicographical comparison is carried out recursively. If +all items of two sequences compare equal, the sequences are considered equal. +If one sequence is an initial sub-sequence of the other, the shorter sequence is +the smaller (lesser) one. Lexicographical ordering for strings uses the Unicode +code point number to order individual characters. Some examples of comparisons +between sequences of the same type:

    +
    (1, 2, 3)              < (1, 2, 4)
    +[1, 2, 3]              < [1, 2, 4]
    +'ABC' < 'C' < 'Pascal' < 'Python'
    +(1, 2, 3, 4)           < (1, 2, 4)
    +(1, 2)                 < (1, 2, -1)
    +(1, 2, 3)             == (1.0, 2.0, 3.0)
    +(1, 2, ('aa', 'ab'))   < (1, 2, ('abc', 'a'), 4)
    +
    +
    +

    Note that comparing objects of different types with < or > is legal +provided that the objects have appropriate comparison methods. For example, +mixed numeric types are compared according to their numeric value, so 0 equals +0.0, etc. Otherwise, rather than providing an arbitrary ordering, the +interpreter will raise a TypeError exception.

    +

    Footnotes

    +
    +
    1
    +

    Other languages may return the mutated object, which allows method +chaining, such as d->insert("a")->remove("b")->sort();.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/tutorial/errors.html b/python-3.7.4-docs-html/tutorial/errors.html new file mode 100644 index 0000000..e285005 --- /dev/null +++ b/python-3.7.4-docs-html/tutorial/errors.html @@ -0,0 +1,562 @@ + + + + + + + 8. Errors and Exceptions — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    8. Errors and Exceptions

    +

    Until now error messages haven’t been more than mentioned, but if you have tried +out the examples you have probably seen some. There are (at least) two +distinguishable kinds of errors: syntax errors and exceptions.

    +
    +

    8.1. Syntax Errors

    +

    Syntax errors, also known as parsing errors, are perhaps the most common kind of +complaint you get while you are still learning Python:

    +
    >>> while True print('Hello world')
    +  File "<stdin>", line 1
    +    while True print('Hello world')
    +                   ^
    +SyntaxError: invalid syntax
    +
    +
    +

    The parser repeats the offending line and displays a little ‘arrow’ pointing at +the earliest point in the line where the error was detected. The error is +caused by (or at least detected at) the token preceding the arrow: in the +example, the error is detected at the function print(), since a colon +(':') is missing before it. File name and line number are printed so you +know where to look in case the input came from a script.

    +
    +
    +

    8.2. Exceptions

    +

    Even if a statement or expression is syntactically correct, it may cause an +error when an attempt is made to execute it. Errors detected during execution +are called exceptions and are not unconditionally fatal: you will soon learn +how to handle them in Python programs. Most exceptions are not handled by +programs, however, and result in error messages as shown here:

    +
    >>> 10 * (1/0)
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +ZeroDivisionError: division by zero
    +>>> 4 + spam*3
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +NameError: name 'spam' is not defined
    +>>> '2' + 2
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +TypeError: Can't convert 'int' object to str implicitly
    +
    +
    +

    The last line of the error message indicates what happened. Exceptions come in +different types, and the type is printed as part of the message: the types in +the example are ZeroDivisionError, NameError and TypeError. +The string printed as the exception type is the name of the built-in exception +that occurred. This is true for all built-in exceptions, but need not be true +for user-defined exceptions (although it is a useful convention). Standard +exception names are built-in identifiers (not reserved keywords).

    +

    The rest of the line provides detail based on the type of exception and what +caused it.

    +

    The preceding part of the error message shows the context where the exception +happened, in the form of a stack traceback. In general it contains a stack +traceback listing source lines; however, it will not display lines read from +standard input.

    +

    Built-in Exceptions lists the built-in exceptions and their meanings.

    +
    +
    +

    8.3. Handling Exceptions

    +

    It is possible to write programs that handle selected exceptions. Look at the +following example, which asks the user for input until a valid integer has been +entered, but allows the user to interrupt the program (using Control-C or +whatever the operating system supports); note that a user-generated interruption +is signalled by raising the KeyboardInterrupt exception.

    +
    >>> while True:
    +...     try:
    +...         x = int(input("Please enter a number: "))
    +...         break
    +...     except ValueError:
    +...         print("Oops!  That was no valid number.  Try again...")
    +...
    +
    +
    +

    The try statement works as follows.

    +
      +
    • First, the try clause (the statement(s) between the try and +except keywords) is executed.

    • +
    • If no exception occurs, the except clause is skipped and execution of the +try statement is finished.

    • +
    • If an exception occurs during execution of the try clause, the rest of the +clause is skipped. Then if its type matches the exception named after the +except keyword, the except clause is executed, and then execution +continues after the try statement.

    • +
    • If an exception occurs which does not match the exception named in the except +clause, it is passed on to outer try statements; if no handler is +found, it is an unhandled exception and execution stops with a message as +shown above.

    • +
    +

    A try statement may have more than one except clause, to specify +handlers for different exceptions. At most one handler will be executed. +Handlers only handle exceptions that occur in the corresponding try clause, not +in other handlers of the same try statement. An except clause may +name multiple exceptions as a parenthesized tuple, for example:

    +
    ... except (RuntimeError, TypeError, NameError):
    +...     pass
    +
    +
    +

    A class in an except clause is compatible with an exception if it is +the same class or a base class thereof (but not the other way around — an +except clause listing a derived class is not compatible with a base class). For +example, the following code will print B, C, D in that order:

    +
    class B(Exception):
    +    pass
    +
    +class C(B):
    +    pass
    +
    +class D(C):
    +    pass
    +
    +for cls in [B, C, D]:
    +    try:
    +        raise cls()
    +    except D:
    +        print("D")
    +    except C:
    +        print("C")
    +    except B:
    +        print("B")
    +
    +
    +

    Note that if the except clauses were reversed (with except B first), it +would have printed B, B, B — the first matching except clause is triggered.

    +

    The last except clause may omit the exception name(s), to serve as a wildcard. +Use this with extreme caution, since it is easy to mask a real programming error +in this way! It can also be used to print an error message and then re-raise +the exception (allowing a caller to handle the exception as well):

    +
    import sys
    +
    +try:
    +    f = open('myfile.txt')
    +    s = f.readline()
    +    i = int(s.strip())
    +except OSError as err:
    +    print("OS error: {0}".format(err))
    +except ValueError:
    +    print("Could not convert data to an integer.")
    +except:
    +    print("Unexpected error:", sys.exc_info()[0])
    +    raise
    +
    +
    +

    The tryexcept statement has an optional else +clause, which, when present, must follow all except clauses. It is useful for +code that must be executed if the try clause does not raise an exception. For +example:

    +
    for arg in sys.argv[1:]:
    +    try:
    +        f = open(arg, 'r')
    +    except OSError:
    +        print('cannot open', arg)
    +    else:
    +        print(arg, 'has', len(f.readlines()), 'lines')
    +        f.close()
    +
    +
    +

    The use of the else clause is better than adding additional code to +the try clause because it avoids accidentally catching an exception +that wasn’t raised by the code being protected by the try … +except statement.

    +

    When an exception occurs, it may have an associated value, also known as the +exception’s argument. The presence and type of the argument depend on the +exception type.

    +

    The except clause may specify a variable after the exception name. The +variable is bound to an exception instance with the arguments stored in +instance.args. For convenience, the exception instance defines +__str__() so the arguments can be printed directly without having to +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')
    +... 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)
    +...
    +<class 'Exception'>
    +('spam', 'eggs')
    +('spam', 'eggs')
    +x = spam
    +y = eggs
    +
    +
    +

    If an exception has arguments, they are printed as the last part (‘detail’) of +the message for unhandled exceptions.

    +

    Exception handlers don’t just handle exceptions if they occur immediately in the +try clause, but also if they occur inside functions that are called (even +indirectly) in the try clause. For example:

    +
    >>> def this_fails():
    +...     x = 1/0
    +...
    +>>> try:
    +...     this_fails()
    +... except ZeroDivisionError as err:
    +...     print('Handling run-time error:', err)
    +...
    +Handling run-time error: division by zero
    +
    +
    +
    +
    +

    8.4. Raising Exceptions

    +

    The raise statement allows the programmer to force a specified +exception to occur. For example:

    +
    >>> raise NameError('HiThere')
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +NameError: HiThere
    +
    +
    +

    The sole argument to raise indicates the exception to be raised. +This must be either an exception instance or an exception class (a class that +derives from Exception). If an exception class is passed, it will +be implicitly instantiated by calling its constructor with no arguments:

    +
    raise ValueError  # shorthand for 'raise ValueError()'
    +
    +
    +

    If you need to determine whether an exception was raised but don’t intend to +handle it, a simpler form of the raise statement allows you to +re-raise the exception:

    +
    >>> try:
    +...     raise NameError('HiThere')
    +... except NameError:
    +...     print('An exception flew by!')
    +...     raise
    +...
    +An exception flew by!
    +Traceback (most recent call last):
    +  File "<stdin>", line 2, in <module>
    +NameError: HiThere
    +
    +
    +
    +
    +

    8.5. User-defined Exceptions

    +

    Programs may name their own exceptions by creating a new exception class (see +Classes for more about Python classes). Exceptions should typically +be derived from the Exception class, either directly or indirectly.

    +

    Exception classes can be defined which do anything any other class can do, but +are usually kept simple, often only offering a number of attributes that allow +information about the error to be extracted by handlers for the exception. When +creating a module that can raise several distinct errors, a common practice is +to create a base class for exceptions defined by that module, and subclass that +to create specific exception classes for different error conditions:

    +
    class Error(Exception):
    +    """Base class for exceptions in this module."""
    +    pass
    +
    +class InputError(Error):
    +    """Exception raised for errors in the input.
    +
    +    Attributes:
    +        expression -- input expression in which the error occurred
    +        message -- explanation of the error
    +    """
    +
    +    def __init__(self, expression, message):
    +        self.expression = expression
    +        self.message = message
    +
    +class TransitionError(Error):
    +    """Raised when an operation attempts a state transition that's not
    +    allowed.
    +
    +    Attributes:
    +        previous -- state at beginning of transition
    +        next -- attempted new state
    +        message -- explanation of why the specific transition is not allowed
    +    """
    +
    +    def __init__(self, previous, next, message):
    +        self.previous = previous
    +        self.next = next
    +        self.message = message
    +
    +
    +

    Most exceptions are defined with names that end in “Error”, similar to the +naming of the standard exceptions.

    +

    Many standard modules define their own exceptions to report errors that may +occur in functions they define. More information on classes is presented in +chapter Classes.

    +
    +
    +

    8.6. Defining Clean-up Actions

    +

    The try statement has another optional clause which is intended to +define clean-up actions that must be executed under all circumstances. For +example:

    +
    >>> try:
    +...     raise KeyboardInterrupt
    +... finally:
    +...     print('Goodbye, world!')
    +...
    +Goodbye, world!
    +KeyboardInterrupt
    +Traceback (most recent call last):
    +  File "<stdin>", line 2, in <module>
    +
    +
    +

    A finally clause is always executed before leaving the try +statement, whether an exception has occurred or not. When an exception has +occurred in the try clause and has not been handled by an +except clause (or it has occurred in an except or +else clause), it is re-raised after the finally clause has +been executed. The finally clause is also executed “on the way out” +when any other clause of the try statement is left via a +break, continue or return statement. A more +complicated example:

    +
    >>> def divide(x, y):
    +...     try:
    +...         result = x / y
    +...     except ZeroDivisionError:
    +...         print("division by zero!")
    +...     else:
    +...         print("result is", result)
    +...     finally:
    +...         print("executing finally clause")
    +...
    +>>> divide(2, 1)
    +result is 2.0
    +executing finally clause
    +>>> divide(2, 0)
    +division by zero!
    +executing finally clause
    +>>> divide("2", "1")
    +executing finally clause
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +  File "<stdin>", line 3, in divide
    +TypeError: unsupported operand type(s) for /: 'str' and 'str'
    +
    +
    +

    As you can see, the finally clause is executed in any event. The +TypeError raised by dividing two strings is not handled by the +except clause and therefore re-raised after the finally +clause has been executed.

    +

    In real world applications, the finally clause is useful for +releasing external resources (such as files or network connections), regardless +of whether the use of the resource was successful.

    +
    +
    +

    8.7. Predefined Clean-up Actions

    +

    Some objects define standard clean-up actions to be undertaken when the object +is no longer needed, regardless of whether or not the operation using the object +succeeded or failed. Look at the following example, which tries to open a file +and print its contents to the screen.

    +
    for line in open("myfile.txt"):
    +    print(line, end="")
    +
    +
    +

    The problem with this code is that it leaves the file open for an indeterminate +amount of time after this part of the code has finished executing. +This is not an issue in simple scripts, but can be a problem for larger +applications. The with statement allows objects like files to be +used in a way that ensures they are always cleaned up promptly and correctly.

    +
    with open("myfile.txt") as f:
    +    for line in f:
    +        print(line, end="")
    +
    +
    +

    After the statement is executed, the file f is always closed, even if a +problem was encountered while processing the lines. Objects which, like files, +provide predefined clean-up actions will indicate this in their documentation.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/tutorial/floatingpoint.html b/python-3.7.4-docs-html/tutorial/floatingpoint.html new file mode 100644 index 0000000..ccefe37 --- /dev/null +++ b/python-3.7.4-docs-html/tutorial/floatingpoint.html @@ -0,0 +1,455 @@ + + + + + + + 15. Floating Point Arithmetic: Issues and Limitations — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    15. Floating Point Arithmetic: Issues and Limitations

    +

    Floating-point numbers are represented in computer hardware as base 2 (binary) +fractions. For example, the decimal fraction

    +
    0.125
    +
    +
    +

    has value 1/10 + 2/100 + 5/1000, and in the same way the binary fraction

    +
    0.001
    +
    +
    +

    has value 0/2 + 0/4 + 1/8. These two fractions have identical values, the only +real difference being that the first is written in base 10 fractional notation, +and the second in base 2.

    +

    Unfortunately, most decimal fractions cannot be represented exactly as binary +fractions. A consequence is that, in general, the decimal floating-point +numbers you enter are only approximated by the binary floating-point numbers +actually stored in the machine.

    +

    The problem is easier to understand at first in base 10. Consider the fraction +1/3. You can approximate that as a base 10 fraction:

    +
    0.3
    +
    +
    +

    or, better,

    +
    0.33
    +
    +
    +

    or, better,

    +
    0.333
    +
    +
    +

    and so on. No matter how many digits you’re willing to write down, the result +will never be exactly 1/3, but will be an increasingly better approximation of +1/3.

    +

    In the same way, no matter how many base 2 digits you’re willing to use, the +decimal value 0.1 cannot be represented exactly as a base 2 fraction. In base +2, 1/10 is the infinitely repeating fraction

    +
    0.0001100110011001100110011001100110011001100110011...
    +
    +
    +

    Stop at any finite number of bits, and you get an approximation. On most +machines today, floats are approximated using a binary fraction with +the numerator using the first 53 bits starting with the most significant bit and +with the denominator as a power of two. In the case of 1/10, the binary fraction +is 3602879701896397 / 2 ** 55 which is close to but not exactly +equal to the true value of 1/10.

    +

    Many users are not aware of the approximation because of the way values are +displayed. Python only prints a decimal approximation to the true decimal +value of the binary approximation stored by the machine. On most machines, if +Python were to print the true decimal value of the binary approximation stored +for 0.1, it would have to display

    +
    >>> 0.1
    +0.1000000000000000055511151231257827021181583404541015625
    +
    +
    +

    That is more digits than most people find useful, so Python keeps the number +of digits manageable by displaying a rounded value instead

    +
    >>> 1 / 10
    +0.1
    +
    +
    +

    Just remember, even though the printed result looks like the exact value +of 1/10, the actual stored value is the nearest representable binary fraction.

    +

    Interestingly, there are many different decimal numbers that share the same +nearest approximate binary fraction. For example, the numbers 0.1 and +0.10000000000000001 and +0.1000000000000000055511151231257827021181583404541015625 are all +approximated by 3602879701896397 / 2 ** 55. Since all of these decimal +values share the same approximation, any one of them could be displayed +while still preserving the invariant eval(repr(x)) == x.

    +

    Historically, the Python prompt and built-in repr() function would choose +the one with 17 significant digits, 0.10000000000000001. Starting with +Python 3.1, Python (on most systems) is now able to choose the shortest of +these and simply display 0.1.

    +

    Note that this is in the very nature of binary floating-point: this is not a bug +in Python, and it is not a bug in your code either. You’ll see the same kind of +thing in all languages that support your hardware’s floating-point arithmetic +(although some languages may not display the difference by default, or in all +output modes).

    +

    For more pleasant output, you may wish to use string formatting to produce a limited number of significant digits:

    +
    >>> format(math.pi, '.12g')  # give 12 significant digits
    +'3.14159265359'
    +
    +>>> format(math.pi, '.2f')   # give 2 digits after the point
    +'3.14'
    +
    +>>> repr(math.pi)
    +'3.141592653589793'
    +
    +
    +

    It’s important to realize that this is, in a real sense, an illusion: you’re +simply rounding the display of the true machine value.

    +

    One illusion may beget another. For example, since 0.1 is not exactly 1/10, +summing three values of 0.1 may not yield exactly 0.3, either:

    +
    >>> .1 + .1 + .1 == .3
    +False
    +
    +
    +

    Also, since the 0.1 cannot get any closer to the exact value of 1/10 and +0.3 cannot get any closer to the exact value of 3/10, then pre-rounding with +round() function cannot help:

    +
    >>> round(.1, 1) + round(.1, 1) + round(.1, 1) == round(.3, 1)
    +False
    +
    +
    +

    Though the numbers cannot be made closer to their intended exact values, +the round() function can be useful for post-rounding so that results +with inexact values become comparable to one another:

    +
    >>> round(.1 + .1 + .1, 10) == round(.3, 10)
    +True
    +
    +
    +

    Binary floating-point arithmetic holds many surprises like this. The problem +with “0.1” is explained in precise detail below, in the “Representation Error” +section. See The Perils of Floating Point +for a more complete account of other common surprises.

    +

    As that says near the end, “there are no easy answers.” Still, don’t be unduly +wary of floating-point! The errors in Python float operations are inherited +from the floating-point hardware, and on most machines are on the order of no +more than 1 part in 2**53 per operation. That’s more than adequate for most +tasks, but you do need to keep in mind that it’s not decimal arithmetic and +that every float operation can suffer a new rounding error.

    +

    While pathological cases do exist, for most casual use of floating-point +arithmetic you’ll see the result you expect in the end if you simply round the +display of your final results to the number of decimal digits you expect. +str() usually suffices, and for finer control see the str.format() +method’s format specifiers in Format String Syntax.

    +

    For use cases which require exact decimal representation, try using the +decimal module which implements decimal arithmetic suitable for +accounting applications and high-precision applications.

    +

    Another form of exact arithmetic is supported by the fractions module +which implements arithmetic based on rational numbers (so the numbers like +1/3 can be represented exactly).

    +

    If you are a heavy user of floating point operations you should take a look +at the Numerical Python package and many other packages for mathematical and +statistical operations supplied by the SciPy project. See <https://scipy.org>.

    +

    Python provides tools that may help on those rare occasions when you really +do want to know the exact value of a float. The +float.as_integer_ratio() method expresses the value of a float as a +fraction:

    +
    >>> x = 3.14159
    +>>> x.as_integer_ratio()
    +(3537115888337719, 1125899906842624)
    +
    +
    +

    Since the ratio is exact, it can be used to losslessly recreate the +original value:

    +
    >>> x == 3537115888337719 / 1125899906842624
    +True
    +
    +
    +

    The float.hex() method expresses a float in hexadecimal (base +16), again giving the exact value stored by your computer:

    +
    >>> x.hex()
    +'0x1.921f9f01b866ep+1'
    +
    +
    +

    This precise hexadecimal representation can be used to reconstruct +the float value exactly:

    +
    >>> x == float.fromhex('0x1.921f9f01b866ep+1')
    +True
    +
    +
    +

    Since the representation is exact, it is useful for reliably porting values +across different versions of Python (platform independence) and exchanging +data with other languages that support the same format (such as Java and C99).

    +

    Another helpful tool is the math.fsum() function which helps mitigate +loss-of-precision during summation. It tracks “lost digits” as values are +added onto a running total. That can make a difference in overall accuracy +so that the errors do not accumulate to the point where they affect the +final total:

    +
    >>> sum([0.1] * 10) == 1.0
    +False
    +>>> math.fsum([0.1] * 10) == 1.0
    +True
    +
    +
    +
    +

    15.1. Representation Error

    +

    This section explains the “0.1” example in detail, and shows how you can perform +an exact analysis of cases like this yourself. Basic familiarity with binary +floating-point representation is assumed.

    +

    Representation error refers to the fact that some (most, actually) +decimal fractions cannot be represented exactly as binary (base 2) fractions. +This is the chief reason why Python (or Perl, C, C++, Java, Fortran, and many +others) often won’t display the exact decimal number you expect.

    +

    Why is that? 1/10 is not exactly representable as a binary fraction. Almost all +machines today (November 2000) use IEEE-754 floating point arithmetic, and +almost all platforms map Python floats to IEEE-754 “double precision”. 754 +doubles contain 53 bits of precision, so on input the computer strives to +convert 0.1 to the closest fraction it can of the form J/2**N where J is +an integer containing exactly 53 bits. Rewriting

    +
    1 / 10 ~= J / (2**N)
    +
    +
    +

    as

    +
    J ~= 2**N / 10
    +
    +
    +

    and recalling that J has exactly 53 bits (is >= 2**52 but < 2**53), +the best value for N is 56:

    +
    >>> 2**52 <=  2**56 // 10  < 2**53
    +True
    +
    +
    +

    That is, 56 is the only value for N that leaves J with exactly 53 bits. The +best possible value for J is then that quotient rounded:

    +
    >>> q, r = divmod(2**56, 10)
    +>>> r
    +6
    +
    +
    +

    Since the remainder is more than half of 10, the best approximation is obtained +by rounding up:

    +
    >>> q+1
    +7205759403792794
    +
    +
    +

    Therefore the best possible approximation to 1/10 in 754 double precision is:

    +
    7205759403792794 / 2 ** 56
    +
    +
    +

    Dividing both the numerator and denominator by two reduces the fraction to:

    +
    3602879701896397 / 2 ** 55
    +
    +
    +

    Note that since we rounded up, this is actually a little bit larger than 1/10; +if we had not rounded up, the quotient would have been a little bit smaller than +1/10. But in no case can it be exactly 1/10!

    +

    So the computer never “sees” 1/10: what it sees is the exact fraction given +above, the best 754 double approximation it can get:

    +
    >>> 0.1 * 2 ** 55
    +3602879701896397.0
    +
    +
    +

    If we multiply that fraction by 10**55, we can see the value out to +55 decimal digits:

    +
    >>> 3602879701896397 * 10 ** 55 // 2 ** 55
    +1000000000000000055511151231257827021181583404541015625
    +
    +
    +

    meaning that the exact number stored in the computer is equal to +the decimal value 0.1000000000000000055511151231257827021181583404541015625. +Instead of displaying the full decimal value, many languages (including +older versions of Python), round the result to 17 significant digits:

    +
    >>> format(0.1, '.17f')
    +'0.10000000000000001'
    +
    +
    +

    The fractions and decimal modules make these calculations +easy:

    +
    >>> from decimal import Decimal
    +>>> from fractions import Fraction
    +
    +>>> Fraction.from_float(0.1)
    +Fraction(3602879701896397, 36028797018963968)
    +
    +>>> (0.1).as_integer_ratio()
    +(3602879701896397, 36028797018963968)
    +
    +>>> Decimal.from_float(0.1)
    +Decimal('0.1000000000000000055511151231257827021181583404541015625')
    +
    +>>> format(Decimal.from_float(0.1), '.17')
    +'0.10000000000000001'
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/tutorial/index.html b/python-3.7.4-docs-html/tutorial/index.html new file mode 100644 index 0000000..1945df5 --- /dev/null +++ b/python-3.7.4-docs-html/tutorial/index.html @@ -0,0 +1,391 @@ + + + + + + + The Python Tutorial — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    The Python Tutorial

    +

    Python is an easy to learn, powerful programming language. It has efficient +high-level data structures and a simple but effective approach to +object-oriented programming. Python’s elegant syntax and dynamic typing, +together with its interpreted nature, make it an ideal language for scripting +and rapid application development in many areas on most platforms.

    +

    The Python interpreter and the extensive standard library are freely available +in source or binary form for all major platforms from the Python Web site, +https://www.python.org/, and may be freely distributed. The same site also +contains distributions of and pointers to many free third party Python modules, +programs and tools, and additional documentation.

    +

    The Python interpreter is easily extended with new functions and data types +implemented in C or C++ (or other languages callable from C). Python is also +suitable as an extension language for customizable applications.

    +

    This tutorial introduces the reader informally to the basic concepts and +features of the Python language and system. It helps to have a Python +interpreter handy for hands-on experience, but all examples are self-contained, +so the tutorial can be read off-line as well.

    +

    For a description of standard objects and modules, see The Python Standard Library. +The Python Language Reference gives a more formal definition of the language. To write +extensions in C or C++, read Extending and Embedding the Python Interpreter and +Python/C API Reference Manual. There are also several books covering Python in depth.

    +

    This tutorial does not attempt to be comprehensive and cover every single +feature, or even every commonly used feature. Instead, it introduces many of +Python’s most noteworthy features, and will give you a good idea of the +language’s flavor and style. After reading it, you will be able to read and +write Python modules and programs, and you will be ready to learn more about the +various Python library modules described in The Python Standard Library.

    +

    The Glossary is also worth going through.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/tutorial/inputoutput.html b/python-3.7.4-docs-html/tutorial/inputoutput.html new file mode 100644 index 0000000..dc621c6 --- /dev/null +++ b/python-3.7.4-docs-html/tutorial/inputoutput.html @@ -0,0 +1,639 @@ + + + + + + + 7. Input and Output — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    7. Input and Output

    +

    There are several ways to present the output of a program; data can be printed +in a human-readable form, or written to a file for future use. This chapter will +discuss some of the possibilities.

    +
    +

    7.1. Fancier Output Formatting

    +

    So far we’ve encountered two ways of writing values: expression statements and +the print() function. (A third way is using the write() method +of file objects; the standard output file can be referenced as sys.stdout. +See the Library Reference for more information on this.)

    +

    Often you’ll want more control over the formatting of your output than simply +printing space-separated values. There are several ways to format output.

    +
      +
    • To use formatted string literals, begin a string +with f or F before the opening quotation mark or triple quotation mark. +Inside this string, you can write a Python expression between { and } +characters that can refer to variables or literal values.

      +
      >>> year = 2016
      +>>> event = 'Referendum'
      +>>> f'Results of the {year} {event}'
      +'Results of the 2016 Referendum'
      +
      +
      +
    • +
    • The str.format() method of strings requires more manual +effort. You’ll still use { and } to mark where a variable +will be substituted and can provide detailed formatting directives, +but you’ll also need to provide the information to be formatted.

      +
      >>> yes_votes = 42_572_654
      +>>> no_votes = 43_132_495
      +>>> percentage = yes_votes / (yes_votes + no_votes)
      +>>> '{:-9} YES votes  {:2.2%}'.format(yes_votes, percentage)
      +' 42572654 YES votes  49.67%'
      +
      +
      +
    • +
    • Finally, you can do all the string handling yourself by using string slicing and +concatenation operations to create any layout you can imagine. The +string type has some methods that perform useful operations for padding +strings to a given column width.

    • +
    +

    When you don’t need fancy output but just want a quick display of some +variables for debugging purposes, you can convert any value to a string with +the repr() or str() functions.

    +

    The str() function is meant to return representations of values which are +fairly human-readable, while repr() is meant to generate representations +which can be read by the interpreter (or will force a SyntaxError if +there is no equivalent syntax). For objects which don’t have a particular +representation for human consumption, str() will return the same value as +repr(). Many values, such as numbers or structures like lists and +dictionaries, have the same representation using either function. Strings, in +particular, have two distinct representations.

    +

    Some examples:

    +
    >>> s = 'Hello, world.'
    +>>> str(s)
    +'Hello, world.'
    +>>> repr(s)
    +"'Hello, world.'"
    +>>> str(1/7)
    +'0.14285714285714285'
    +>>> x = 10 * 3.25
    +>>> y = 200 * 200
    +>>> s = 'The value of x is ' + repr(x) + ', and y is ' + repr(y) + '...'
    +>>> print(s)
    +The value of x is 32.5, and y is 40000...
    +>>> # The repr() of a string adds string quotes and backslashes:
    +... hello = 'hello, world\n'
    +>>> hellos = repr(hello)
    +>>> print(hellos)
    +'hello, world\n'
    +>>> # The argument to repr() may be any Python object:
    +... repr((x, y, ('spam', 'eggs')))
    +"(32.5, 40000, ('spam', 'eggs'))"
    +
    +
    +

    The string module contains a Template class that offers +yet another way to substitute values into strings, using placeholders like +$x and replacing them with values from a dictionary, but offers much less +control of the formatting.

    +
    +

    7.1.1. Formatted String Literals

    +

    Formatted string literals (also called f-strings for +short) let you include the value of Python expressions inside a string by +prefixing the string with f or F and writing expressions as +{expression}.

    +

    An optional format specifier can follow the expression. This allows greater +control over how the value is formatted. The following example rounds pi to +three places after the decimal:

    +
    >>> import math
    +>>> print(f'The value of pi is approximately {math.pi:.3f}.')
    +The value of pi is approximately 3.142.
    +
    +
    +

    Passing an integer after the ':' will cause that field to be a minimum +number of characters wide. This is useful for making columns line up.

    +
    >>> table = {'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 7678}
    +>>> for name, phone in table.items():
    +...     print(f'{name:10} ==> {phone:10d}')
    +...
    +Sjoerd     ==>       4127
    +Jack       ==>       4098
    +Dcab       ==>       7678
    +
    +
    +

    Other modifiers can be used to convert the value before it is formatted. +'!a' applies ascii(), '!s' applies str(), and '!r' +applies repr():

    +
    >>> animals = 'eels'
    +>>> print(f'My hovercraft is full of {animals}.')
    +My hovercraft is full of eels.
    +>>> print(f'My hovercraft is full of {animals!r}.')
    +My hovercraft is full of 'eels'.
    +
    +
    +

    For a reference on these format specifications, see +the reference guide for the Format Specification Mini-Language.

    +
    +
    +

    7.1.2. The String format() Method

    +

    Basic usage of the str.format() method looks like this:

    +
    >>> print('We are the {} who say "{}!"'.format('knights', 'Ni'))
    +We are the knights who say "Ni!"
    +
    +
    +

    The brackets and characters within them (called format fields) are replaced with +the objects passed into the str.format() method. A number in the +brackets can be used to refer to the position of the object passed into the +str.format() method.

    +
    >>> print('{0} and {1}'.format('spam', 'eggs'))
    +spam and eggs
    +>>> print('{1} and {0}'.format('spam', 'eggs'))
    +eggs and spam
    +
    +
    +

    If keyword arguments are used in the str.format() method, their values +are referred to by using the name of the argument.

    +
    >>> print('This {food} is {adjective}.'.format(
    +...       food='spam', adjective='absolutely horrible'))
    +This spam is absolutely horrible.
    +
    +
    +

    Positional and keyword arguments can be arbitrarily combined:

    +
    >>> print('The story of {0}, {1}, and {other}.'.format('Bill', 'Manfred',
    +                                                       other='Georg'))
    +The story of Bill, Manfred, and Georg.
    +
    +
    +

    If you have a really long format string that you don’t want to split up, it +would be nice if you could reference the variables to be formatted by name +instead of by position. This can be done by simply passing the dict and using +square brackets '[]' to access the keys

    +
    >>> table = {'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 8637678}
    +>>> print('Jack: {0[Jack]:d}; Sjoerd: {0[Sjoerd]:d}; '
    +...       'Dcab: {0[Dcab]:d}'.format(table))
    +Jack: 4098; Sjoerd: 4127; Dcab: 8637678
    +
    +
    +

    This could also be done by passing the table as keyword arguments with the ‘**’ +notation.

    +
    >>> table = {'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 8637678}
    +>>> print('Jack: {Jack:d}; Sjoerd: {Sjoerd:d}; Dcab: {Dcab:d}'.format(**table))
    +Jack: 4098; Sjoerd: 4127; Dcab: 8637678
    +
    +
    +

    This is particularly useful in combination with the built-in function +vars(), which returns a dictionary containing all local variables.

    +

    As an example, the following lines produce a tidily-aligned +set of columns giving integers and their squares and cubes:

    +
    >>> for x in range(1, 11):
    +...     print('{0:2d} {1:3d} {2:4d}'.format(x, x*x, x*x*x))
    +...
    + 1   1    1
    + 2   4    8
    + 3   9   27
    + 4  16   64
    + 5  25  125
    + 6  36  216
    + 7  49  343
    + 8  64  512
    + 9  81  729
    +10 100 1000
    +
    +
    +

    For a complete overview of string formatting with str.format(), see +Format String Syntax.

    +
    +
    +

    7.1.3. Manual String Formatting

    +

    Here’s the same table of squares and cubes, formatted manually:

    +
    >>> for x in range(1, 11):
    +...     print(repr(x).rjust(2), repr(x*x).rjust(3), end=' ')
    +...     # Note use of 'end' on previous line
    +...     print(repr(x*x*x).rjust(4))
    +...
    + 1   1    1
    + 2   4    8
    + 3   9   27
    + 4  16   64
    + 5  25  125
    + 6  36  216
    + 7  49  343
    + 8  64  512
    + 9  81  729
    +10 100 1000
    +
    +
    +

    (Note that the one space between each column was added by the +way print() works: it always adds spaces between its arguments.)

    +

    The str.rjust() method of string objects right-justifies a string in a +field of a given width by padding it with spaces on the left. There are +similar methods str.ljust() and str.center(). These methods do +not write anything, they just return a new string. If the input string is too +long, they don’t truncate it, but return it unchanged; this will mess up your +column lay-out but that’s usually better than the alternative, which would be +lying about a value. (If you really want truncation you can always add a +slice operation, as in x.ljust(n)[:n].)

    +

    There is another method, str.zfill(), which pads a numeric string on the +left with zeros. It understands about plus and minus signs:

    +
    >>> '12'.zfill(5)
    +'00012'
    +>>> '-3.14'.zfill(7)
    +'-003.14'
    +>>> '3.14159265359'.zfill(5)
    +'3.14159265359'
    +
    +
    +
    +
    +

    7.1.4. Old string formatting

    +

    The % operator can also be used for string formatting. It interprets the +left argument much like a sprintf()-style format string to be applied +to the right argument, and returns the string resulting from this formatting +operation. For example:

    +
    >>> import math
    +>>> print('The value of pi is approximately %5.3f.' % math.pi)
    +The value of pi is approximately 3.142.
    +
    +
    +

    More information can be found in the printf-style String Formatting section.

    +
    +
    +
    +

    7.2. Reading and Writing Files

    +

    open() returns a file object, and is most commonly used with +two arguments: open(filename, mode).

    +
    >>> f = open('workfile', 'w')
    +
    +
    +

    The first argument is a string containing the filename. The second argument is +another string containing a few characters describing the way in which the file +will be used. mode can be 'r' when the file will only be read, 'w' +for only writing (an existing file with the same name will be erased), and +'a' opens the file for appending; any data written to the file is +automatically added to the end. 'r+' opens the file for both reading and +writing. The mode argument is optional; 'r' will be assumed if it’s +omitted.

    +

    Normally, files are opened in text mode, that means, you read and write +strings from and to the file, which are encoded in a specific encoding. If +encoding is not specified, the default is platform dependent (see +open()). 'b' appended to the mode opens the file in +binary mode: now the data is read and written in the form of bytes +objects. This mode should be used for all files that don’t contain text.

    +

    In text mode, the default when reading is to convert platform-specific line +endings (\n on Unix, \r\n on Windows) to just \n. When writing in +text mode, the default is to convert occurrences of \n back to +platform-specific line endings. This behind-the-scenes modification +to file data is fine for text files, but will corrupt binary data like that in +JPEG or EXE files. Be very careful to use binary mode when +reading and writing such files.

    +

    It is good practice to use the with keyword when dealing +with file objects. The advantage is that the file is properly closed +after its suite finishes, even if an exception is raised at some +point. Using with is also much shorter than writing +equivalent try-finally blocks:

    +
    >>> with open('workfile') as f:
    +...     read_data = f.read()
    +>>> f.closed
    +True
    +
    +
    +

    If you’re not using the with keyword, then you should call +f.close() to close the file and immediately free up any system +resources used by it. If you don’t explicitly close a file, Python’s +garbage collector will eventually destroy the object and close the +open file for you, but the file may stay open for a while. Another +risk is that different Python implementations will do this clean-up at +different times.

    +

    After a file object is closed, either by a with statement +or by calling f.close(), attempts to use the file object will +automatically fail.

    +
    >>> f.close()
    +>>> f.read()
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +ValueError: I/O operation on closed file.
    +
    +
    +
    +

    7.2.1. Methods of File Objects

    +

    The rest of the examples in this section will assume that a file object called +f has already been created.

    +

    To read a file’s contents, call f.read(size), which reads some quantity of +data and returns it as a string (in text mode) or bytes object (in binary mode). +size is an optional numeric argument. When size is omitted or negative, the +entire contents of the file will be read and returned; it’s your problem if the +file is twice as large as your machine’s memory. Otherwise, at most size bytes +are read and returned. +If the end of the file has been reached, f.read() will return an empty +string ('').

    +
    >>> f.read()
    +'This is the entire file.\n'
    +>>> f.read()
    +''
    +
    +
    +

    f.readline() reads a single line from the file; a newline character (\n) +is left at the end of the string, and is only omitted on the last line of the +file if the file doesn’t end in a newline. This makes the return value +unambiguous; if f.readline() returns an empty string, the end of the file +has been reached, while a blank line is represented by '\n', a string +containing only a single newline.

    +
    >>> f.readline()
    +'This is the first line of the file.\n'
    +>>> f.readline()
    +'Second line of the file\n'
    +>>> f.readline()
    +''
    +
    +
    +

    For reading lines from a file, you can loop over the file object. This is memory +efficient, fast, and leads to simple code:

    +
    >>> for line in f:
    +...     print(line, end='')
    +...
    +This is the first line of the file.
    +Second line of the file
    +
    +
    +

    If you want to read all the lines of a file in a list you can also use +list(f) or f.readlines().

    +

    f.write(string) writes the contents of string to the file, returning +the number of characters written.

    +
    >>> f.write('This is a test\n')
    +15
    +
    +
    +

    Other types of objects need to be converted – either to a string (in text mode) +or a bytes object (in binary mode) – before writing them:

    +
    >>> value = ('the answer', 42)
    +>>> s = str(value)  # convert the tuple to string
    +>>> f.write(s)
    +18
    +
    +
    +

    f.tell() returns an integer giving the file object’s current position in the file +represented as number of bytes from the beginning of the file when in binary mode and +an opaque number when in text mode.

    +

    To change the file object’s position, use f.seek(offset, from_what). The position is computed +from adding offset to a reference point; the reference point is selected by +the from_what argument. A from_what value of 0 measures from the beginning +of the file, 1 uses the current file position, and 2 uses the end of the file as +the reference point. from_what can be omitted and defaults to 0, using the +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
    +5
    +>>> f.read(1)
    +b'5'
    +>>> f.seek(-3, 2)  # Go to the 3rd byte before the end
    +13
    +>>> f.read(1)
    +b'd'
    +
    +
    +

    In text files (those opened without a b in the mode string), only seeks +relative to the beginning of the file are allowed (the exception being seeking +to the very file end with seek(0, 2)) and the only valid offset values are +those returned from the f.tell(), or zero. Any other offset value produces +undefined behaviour.

    +

    File objects have some additional methods, such as isatty() and +truncate() which are less frequently used; consult the Library +Reference for a complete guide to file objects.

    +
    +
    +

    7.2.2. Saving structured data with json

    +

    Strings can easily be written to and read from a file. Numbers take a bit more +effort, since the read() method only returns strings, which will have to +be passed to a function like int(), which takes a string like '123' +and returns its numeric value 123. When you want to save more complex data +types like nested lists and dictionaries, parsing and serializing by hand +becomes complicated.

    +

    Rather than having users constantly writing and debugging code to save +complicated data types to files, Python allows you to use the popular data +interchange format called JSON (JavaScript Object Notation). The standard module called json can take Python +data hierarchies, and convert them to string representations; this process is +called serializing. Reconstructing the data from the string representation +is called deserializing. Between serializing and deserializing, the +string representing the object may have been stored in a file or data, or +sent over a network connection to some distant machine.

    +
    +

    Note

    +

    The JSON format is commonly used by modern applications to allow for data +exchange. Many programmers are already familiar with it, which makes +it a good choice for interoperability.

    +
    +

    If you have an object x, you can view its JSON string representation with a +simple line of code:

    +
    >>> import json
    +>>> json.dumps([1, 'simple', 'list'])
    +'[1, "simple", "list"]'
    +
    +
    +

    Another variant of the dumps() function, called dump(), +simply serializes the object to a text file. So if f is a +text file object opened for writing, we can do this:

    +
    json.dump(x, f)
    +
    +
    +

    To decode the object again, if f is a text file object which has +been opened for reading:

    +
    x = json.load(f)
    +
    +
    +

    This simple serialization technique can handle lists and dictionaries, but +serializing arbitrary class instances in JSON requires a bit of extra effort. +The reference for the json module contains an explanation of this.

    +
    +

    See also

    +

    pickle - the pickle module

    +

    Contrary to JSON, pickle is a protocol which allows +the serialization of arbitrarily complex Python objects. As such, it is +specific to Python and cannot be used to communicate with applications +written in other languages. It is also insecure by default: +deserializing pickle data coming from an untrusted source can execute +arbitrary code, if the data was crafted by a skilled attacker.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/tutorial/interactive.html b/python-3.7.4-docs-html/tutorial/interactive.html new file mode 100644 index 0000000..ecafbed --- /dev/null +++ b/python-3.7.4-docs-html/tutorial/interactive.html @@ -0,0 +1,224 @@ + + + + + + + 14. Interactive Input Editing and History Substitution — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    14. Interactive Input Editing and History Substitution

    +

    Some versions of the Python interpreter support editing of the current input +line and history substitution, similar to facilities found in the Korn shell and +the GNU Bash shell. This is implemented using the GNU Readline library, +which supports various styles of editing. This library has its own +documentation which we won’t duplicate here.

    +
    +

    14.1. Tab Completion and History Editing

    +

    Completion of variable and module names is +automatically enabled at interpreter startup so +that the Tab key invokes the completion function; it looks at +Python statement names, the current local variables, and the available +module names. For dotted expressions such as string.a, it will evaluate +the expression up to the final '.' and then suggest completions from +the attributes of the resulting object. Note that this may execute +application-defined code if an object with a __getattr__() method +is part of the expression. The default configuration also saves your +history into a file named .python_history in your user directory. +The history will be available again during the next interactive interpreter +session.

    +
    +
    +

    14.2. Alternatives to the Interactive Interpreter

    +

    This facility is an enormous step forward compared to earlier versions of the +interpreter; however, some wishes are left: It would be nice if the proper +indentation were suggested on continuation lines (the parser knows if an indent +token is required next). The completion mechanism might use the interpreter’s +symbol table. A command to check (or even suggest) matching parentheses, +quotes, etc., would also be useful.

    +

    One alternative enhanced interactive interpreter that has been around for quite +some time is IPython, which features tab completion, object exploration and +advanced history management. It can also be thoroughly customized and embedded +into other applications. Another similar enhanced interactive environment is +bpython.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/tutorial/interpreter.html b/python-3.7.4-docs-html/tutorial/interpreter.html new file mode 100644 index 0000000..8da415f --- /dev/null +++ b/python-3.7.4-docs-html/tutorial/interpreter.html @@ -0,0 +1,320 @@ + + + + + + + 2. Using the Python Interpreter — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    2. Using the Python Interpreter

    +
    +

    2.1. Invoking the Interpreter

    +

    The Python interpreter is usually installed as /usr/local/bin/python3.7 +on those machines where it is available; putting /usr/local/bin in your +Unix shell’s search path makes it possible to start it by typing the command:

    +
    python3.7
    +
    +
    +

    to the shell. 1 Since the choice of the directory where the interpreter lives +is an installation option, other places are possible; check with your local +Python guru or system administrator. (E.g., /usr/local/python is a +popular alternative location.)

    +

    On Windows machines where you have installed from the Microsoft Store, the python3.7 command will be available. If you have +the py.exe launcher installed, you can use the py +command. See Excursus: Setting environment variables for other ways to launch Python.

    +

    Typing an end-of-file character (Control-D on Unix, Control-Z on +Windows) at the primary prompt causes the interpreter to exit with a zero exit +status. If that doesn’t work, you can exit the interpreter by typing the +following command: quit().

    +

    The interpreter’s line-editing features include interactive editing, history +substitution and code completion on systems that support readline. Perhaps the +quickest check to see whether command line editing is supported is typing +Control-P to the first Python prompt you get. If it beeps, you have command +line editing; see Appendix Interactive Input Editing and History Substitution for an introduction to the +keys. If nothing appears to happen, or if ^P is echoed, command line +editing isn’t available; you’ll only be able to use backspace to remove +characters from the current line.

    +

    The interpreter operates somewhat like the Unix shell: when called with standard +input connected to a tty device, it reads and executes commands interactively; +when called with a file name argument or with a file as standard input, it reads +and executes a script from that file.

    +

    A second way of starting the interpreter is python -c command [arg] ..., +which executes the statement(s) in command, analogous to the shell’s +-c option. Since Python statements often contain spaces or other +characters that are special to the shell, it is usually advised to quote +command in its entirety with single quotes.

    +

    Some Python modules are also useful as scripts. These can be invoked using +python -m module [arg] ..., which executes the source file for module as +if you had spelled out its full name on the command line.

    +

    When a script file is used, it is sometimes useful to be able to run the script +and enter interactive mode afterwards. This can be done by passing -i +before the script.

    +

    All command line options are described in Command line and environment.

    +
    +

    2.1.1. Argument Passing

    +

    When known to the interpreter, the script name and additional arguments +thereafter are turned into a list of strings and assigned to the argv +variable in the sys module. You can access this list by executing import +sys. The length of the list is at least one; when no script and no arguments +are given, sys.argv[0] is an empty string. When the script name is given as +'-' (meaning standard input), sys.argv[0] is set to '-'. When +-c command is used, sys.argv[0] is set to '-c'. When +-m module is used, sys.argv[0] is set to the full name of the +located module. Options found after -c command or -m +module are not consumed by the Python interpreter’s option processing but +left in sys.argv for the command or module to handle.

    +
    +
    +

    2.1.2. Interactive Mode

    +

    When commands are read from a tty, the interpreter is said to be in interactive +mode. In this mode it prompts for the next command with the primary prompt, +usually three greater-than signs (>>>); for continuation lines it prompts +with the secondary prompt, by default three dots (...). The interpreter +prints a welcome message stating its version number and a copyright notice +before printing the first prompt:

    +
    $ python3.7
    +Python 3.7 (default, Sep 16 2015, 09:25:04)
    +[GCC 4.8.2] on linux
    +Type "help", "copyright", "credits" or "license" for more information.
    +>>>
    +
    +
    +

    Continuation lines are needed when entering a multi-line construct. As an +example, take a look at this if statement:

    +
    >>> the_world_is_flat = True
    +>>> if the_world_is_flat:
    +...     print("Be careful not to fall off!")
    +...
    +Be careful not to fall off!
    +
    +
    +

    For more on interactive mode, see Interactive Mode.

    +
    +
    +
    +

    2.2. The Interpreter and Its Environment

    +
    +

    2.2.1. Source Code Encoding

    +

    By default, Python source files are treated as encoded in UTF-8. In that +encoding, characters of most languages in the world can be used simultaneously +in string literals, identifiers and comments — although the standard library +only uses ASCII characters for identifiers, a convention that any portable code +should follow. To display all these characters properly, your editor must +recognize that the file is UTF-8, and it must use a font that supports all the +characters in the file.

    +

    To declare an encoding other than the default one, a special comment line +should be added as the first line of the file. The syntax is as follows:

    +
    # -*- coding: encoding -*-
    +
    +
    +

    where encoding is one of the valid codecs supported by Python.

    +

    For example, to declare that Windows-1252 encoding is to be used, the first +line of your source code file should be:

    +
    # -*- coding: cp1252 -*-
    +
    +
    +

    One exception to the first line rule is when the source code starts with a +UNIX “shebang” line. In this case, the encoding +declaration should be added as the second line of the file. For example:

    +
    #!/usr/bin/env python3
    +# -*- coding: cp1252 -*-
    +
    +
    +

    Footnotes

    +
    +
    1
    +

    On Unix, the Python 3.x interpreter is by default not installed with the +executable named python, so that it does not conflict with a +simultaneously installed Python 2.x executable.

    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/tutorial/introduction.html b/python-3.7.4-docs-html/tutorial/introduction.html new file mode 100644 index 0000000..26a7984 --- /dev/null +++ b/python-3.7.4-docs-html/tutorial/introduction.html @@ -0,0 +1,706 @@ + + + + + + + 3. An Informal Introduction to Python — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    3. An Informal Introduction to Python

    +

    In the following examples, input and output are distinguished by the presence or +absence of prompts (>>> and ): to repeat the example, you must type +everything after the prompt, when the prompt appears; lines that do not begin +with a prompt are output from the interpreter. Note that a secondary prompt on a +line by itself in an example means you must type a blank line; this is used to +end a multi-line command.

    +

    Many of the examples in this manual, even those entered at the interactive +prompt, include comments. Comments in Python start with the hash character, +#, and extend to the end of the physical line. A comment may appear at the +start of a line or following whitespace or code, but not within a string +literal. A hash character within a string literal is just a hash character. +Since comments are to clarify code and are not interpreted by Python, they may +be omitted when typing in examples.

    +

    Some examples:

    +
    # this is the first comment
    +spam = 1  # and this is the second comment
    +          # ... and now a third!
    +text = "# This is not a comment because it's inside quotes."
    +
    +
    +
    +

    3.1. Using Python as a Calculator

    +

    Let’s try some simple Python commands. Start the interpreter and wait for the +primary prompt, >>>. (It shouldn’t take long.)

    +
    +

    3.1.1. Numbers

    +

    The interpreter acts as a simple calculator: you can type an expression at it +and it will write the value. Expression syntax is straightforward: the +operators +, -, * and / work just like in most other languages +(for example, Pascal or C); parentheses (()) can be used for grouping. +For example:

    +
    >>> 2 + 2
    +4
    +>>> 50 - 5*6
    +20
    +>>> (50 - 5*6) / 4
    +5.0
    +>>> 8 / 5  # division always returns a floating point number
    +1.6
    +
    +
    +

    The integer numbers (e.g. 2, 4, 20) have type int, +the ones with a fractional part (e.g. 5.0, 1.6) have type +float. We will see more about numeric types later in the tutorial.

    +

    Division (/) always returns a float. To do floor division and +get an integer result (discarding any fractional result) you can use the // +operator; to calculate the remainder you can use %:

    +
    >>> 17 / 3  # classic division returns a float
    +5.666666666666667
    +>>>
    +>>> 17 // 3  # floor division discards the fractional part
    +5
    +>>> 17 % 3  # the % operator returns the remainder of the division
    +2
    +>>> 5 * 3 + 2  # result * divisor + remainder
    +17
    +
    +
    +

    With Python, it is possible to use the ** operator to calculate powers 1:

    +
    >>> 5 ** 2  # 5 squared
    +25
    +>>> 2 ** 7  # 2 to the power of 7
    +128
    +
    +
    +

    The equal sign (=) is used to assign a value to a variable. Afterwards, no +result is displayed before the next interactive prompt:

    +
    >>> width = 20
    +>>> height = 5 * 9
    +>>> width * height
    +900
    +
    +
    +

    If a variable is not “defined” (assigned a value), trying to use it will +give you an error:

    +
    >>> n  # try to access an undefined variable
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +NameError: name 'n' is not defined
    +
    +
    +

    There is full support for floating point; operators with mixed type operands +convert the integer operand to floating point:

    +
    >>> 4 * 3.75 - 1
    +14.0
    +
    +
    +

    In interactive mode, the last printed expression is assigned to the variable +_. This means that when you are using Python as a desk calculator, it is +somewhat easier to continue calculations, for example:

    +
    >>> tax = 12.5 / 100
    +>>> price = 100.50
    +>>> price * tax
    +12.5625
    +>>> price + _
    +113.0625
    +>>> round(_, 2)
    +113.06
    +
    +
    +

    This variable should be treated as read-only by the user. Don’t explicitly +assign a value to it — you would create an independent local variable with the +same name masking the built-in variable with its magic behavior.

    +

    In addition to int and float, Python supports other types of +numbers, such as Decimal and Fraction. +Python also has built-in support for complex numbers, +and uses the j or J suffix to indicate the imaginary part +(e.g. 3+5j).

    +
    +
    +

    3.1.2. Strings

    +

    Besides numbers, Python can also manipulate strings, which can be expressed +in several ways. They can be enclosed in single quotes ('...') or +double quotes ("...") with the same result 2. \ can be used +to escape quotes:

    +
    >>> 'spam eggs'  # single quotes
    +'spam eggs'
    +>>> 'doesn\'t'  # use \' to escape the single quote...
    +"doesn't"
    +>>> "doesn't"  # ...or use double quotes instead
    +"doesn't"
    +>>> '"Yes," they said.'
    +'"Yes," they said.'
    +>>> "\"Yes,\" they said."
    +'"Yes," they said.'
    +>>> '"Isn\'t," they said.'
    +'"Isn\'t," they said.'
    +
    +
    +

    In the interactive interpreter, the output string is enclosed in quotes and +special characters are escaped with backslashes. While this might sometimes +look different from the input (the enclosing quotes could change), the two +strings are equivalent. The string is enclosed in double quotes if +the string contains a single quote and no double quotes, otherwise it is +enclosed in single quotes. The print() function produces a more +readable output, by omitting the enclosing quotes and by printing escaped +and special characters:

    +
    >>> '"Isn\'t," they said.'
    +'"Isn\'t," they said.'
    +>>> print('"Isn\'t," they said.')
    +"Isn't," they said.
    +>>> s = 'First line.\nSecond line.'  # \n means newline
    +>>> s  # without print(), \n is included in the output
    +'First line.\nSecond line.'
    +>>> print(s)  # with print(), \n produces a new line
    +First line.
    +Second line.
    +
    +
    +

    If you don’t want characters prefaced by \ to be interpreted as +special characters, you can use raw strings by adding an r before +the first quote:

    +
    >>> print('C:\some\name')  # here \n means newline!
    +C:\some
    +ame
    +>>> print(r'C:\some\name')  # note the r before the quote
    +C:\some\name
    +
    +
    +

    String literals can span multiple lines. One way is using triple-quotes: +"""...""" or '''...'''. End of lines are automatically +included in the string, but it’s possible to prevent this by adding a \ at +the end of the line. The following example:

    +
    print("""\
    +Usage: thingy [OPTIONS]
    +     -h                        Display this usage message
    +     -H hostname               Hostname to connect to
    +""")
    +
    +
    +

    produces the following output (note that the initial newline is not included):

    +
    Usage: thingy [OPTIONS]
    +     -h                        Display this usage message
    +     -H hostname               Hostname to connect to
    +
    +
    +

    Strings can be concatenated (glued together) with the + operator, and +repeated with *:

    +
    >>> # 3 times 'un', followed by 'ium'
    +>>> 3 * 'un' + 'ium'
    +'unununium'
    +
    +
    +

    Two or more string literals (i.e. the ones enclosed between quotes) next +to each other are automatically concatenated.

    +
    >>> 'Py' 'thon'
    +'Python'
    +
    +
    +

    This feature is particularly useful when you want to break long strings:

    +
    >>> text = ('Put several strings within parentheses '
    +...         'to have them joined together.')
    +>>> text
    +'Put several strings within parentheses to have them joined together.'
    +
    +
    +

    This only works with two literals though, not with variables or expressions:

    +
    >>> prefix = 'Py'
    +>>> prefix 'thon'  # can't concatenate a variable and a string literal
    +  File "<stdin>", line 1
    +    prefix 'thon'
    +                ^
    +SyntaxError: invalid syntax
    +>>> ('un' * 3) 'ium'
    +  File "<stdin>", line 1
    +    ('un' * 3) 'ium'
    +                   ^
    +SyntaxError: invalid syntax
    +
    +
    +

    If you want to concatenate variables or a variable and a literal, use +:

    +
    >>> prefix + 'thon'
    +'Python'
    +
    +
    +

    Strings can be indexed (subscripted), with the first character having index 0. +There is no separate character type; a character is simply a string of size +one:

    +
    >>> word = 'Python'
    +>>> word[0]  # character in position 0
    +'P'
    +>>> word[5]  # character in position 5
    +'n'
    +
    +
    +

    Indices may also be negative numbers, to start counting from the right:

    +
    >>> word[-1]  # last character
    +'n'
    +>>> word[-2]  # second-last character
    +'o'
    +>>> word[-6]
    +'P'
    +
    +
    +

    Note that since -0 is the same as 0, negative indices start from -1.

    +

    In addition to indexing, slicing is also supported. While indexing is used +to obtain individual characters, slicing allows you to obtain substring:

    +
    >>> word[0:2]  # characters from position 0 (included) to 2 (excluded)
    +'Py'
    +>>> word[2:5]  # characters from position 2 (included) to 5 (excluded)
    +'tho'
    +
    +
    +

    Note how the start is always included, and the end always excluded. This +makes sure that s[:i] + s[i:] is always equal to s:

    +
    >>> word[:2] + word[2:]
    +'Python'
    +>>> word[:4] + word[4:]
    +'Python'
    +
    +
    +

    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)
    +'Py'
    +>>> word[4:]   # characters from position 4 (included) to the end
    +'on'
    +>>> 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 +between characters, with the left edge of the first character numbered 0. +Then the right edge of the last character of a string of n characters has +index n, for example:

    +
     +---+---+---+---+---+---+
    + | P | y | t | h | o | n |
    + +---+---+---+---+---+---+
    + 0   1   2   3   4   5   6
    +-6  -5  -4  -3  -2  -1
    +
    +
    +

    The first row of numbers gives the position of the indices 0…6 in the string; +the second row gives the corresponding negative indices. The slice from i to +j consists of all characters between the edges labeled i and j, +respectively.

    +

    For non-negative indices, the length of a slice is the difference of the +indices, if both are within bounds. For example, the length of word[1:3] is +2.

    +

    Attempting to use an index that is too large will result in an error:

    +
    >>> word[42]  # the word only has 6 characters
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +IndexError: string index out of range
    +
    +
    +

    However, out of range slice indexes are handled gracefully when used for +slicing:

    +
    >>> word[4:42]
    +'on'
    +>>> word[42:]
    +''
    +
    +
    +

    Python strings cannot be changed — they are immutable. +Therefore, assigning to an indexed position in the string results in an error:

    +
    >>> word[0] = 'J'
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +TypeError: 'str' object does not support item assignment
    +>>> word[2:] = 'py'
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +TypeError: 'str' object does not support item assignment
    +
    +
    +

    If you need a different string, you should create a new one:

    +
    >>> 'J' + word[1:]
    +'Jython'
    +>>> word[:2] + 'py'
    +'Pypy'
    +
    +
    +

    The built-in function len() returns the length of a string:

    +
    >>> s = 'supercalifragilisticexpialidocious'
    +>>> len(s)
    +34
    +
    +
    +
    +

    See also

    +
    +
    Text Sequence Type — str

    Strings are examples of sequence types, and support the common +operations supported by such types.

    +
    +
    String Methods

    Strings support a large number of methods for +basic transformations and searching.

    +
    +
    Formatted string literals

    String literals that have embedded expressions.

    +
    +
    Format String Syntax

    Information about string formatting with str.format().

    +
    +
    printf-style String Formatting

    The old formatting operations invoked when strings are +the left operand of the % operator are described in more detail here.

    +
    +
    +
    +
    +
    +

    3.1.3. Lists

    +

    Python knows a number of compound data types, used to group together other +values. The most versatile is the list, which can be written as a list of +comma-separated values (items) between square brackets. Lists might contain +items of different types, but usually the items all have the same type.

    +
    >>> squares = [1, 4, 9, 16, 25]
    +>>> squares
    +[1, 4, 9, 16, 25]
    +
    +
    +

    Like strings (and all other built-in sequence types), lists can be +indexed and sliced:

    +
    >>> squares[0]  # indexing returns the item
    +1
    +>>> squares[-1]
    +25
    +>>> squares[-3:]  # slicing returns a new list
    +[9, 16, 25]
    +
    +
    +

    All slice operations return a new list containing the requested elements. This +means that the following slice returns a new (shallow) copy of the list:

    +
    >>> squares[:]
    +[1, 4, 9, 16, 25]
    +
    +
    +

    Lists also support operations like concatenation:

    +
    >>> squares + [36, 49, 64, 81, 100]
    +[1, 4, 9, 16, 25, 36, 49, 64, 81, 100]
    +
    +
    +

    Unlike strings, which are immutable, lists are a mutable +type, i.e. it is possible to change their content:

    +
    >>> cubes = [1, 8, 27, 65, 125]  # something's wrong here
    +>>> 4 ** 3  # the cube of 4 is 64, not 65!
    +64
    +>>> cubes[3] = 64  # replace the wrong value
    +>>> cubes
    +[1, 8, 27, 64, 125]
    +
    +
    +

    You can also add new items at the end of the list, by using +the append() method (we will see more about methods later):

    +
    >>> cubes.append(216)  # add the cube of 6
    +>>> cubes.append(7 ** 3)  # and the cube of 7
    +>>> cubes
    +[1, 8, 27, 64, 125, 216, 343]
    +
    +
    +

    Assignment to slices is also possible, and this can even change the size of the +list or clear it entirely:

    +
    >>> letters = ['a', 'b', 'c', 'd', 'e', 'f', 'g']
    +>>> letters
    +['a', 'b', 'c', 'd', 'e', 'f', 'g']
    +>>> # replace some values
    +>>> letters[2:5] = ['C', 'D', 'E']
    +>>> letters
    +['a', 'b', 'C', 'D', 'E', 'f', 'g']
    +>>> # now remove them
    +>>> letters[2:5] = []
    +>>> letters
    +['a', 'b', 'f', 'g']
    +>>> # clear the list by replacing all the elements with an empty list
    +>>> letters[:] = []
    +>>> letters
    +[]
    +
    +
    +

    The built-in function len() also applies to lists:

    +
    >>> letters = ['a', 'b', 'c', 'd']
    +>>> len(letters)
    +4
    +
    +
    +

    It is possible to nest lists (create lists containing other lists), for +example:

    +
    >>> a = ['a', 'b', 'c']
    +>>> n = [1, 2, 3]
    +>>> x = [a, n]
    +>>> x
    +[['a', 'b', 'c'], [1, 2, 3]]
    +>>> x[0]
    +['a', 'b', 'c']
    +>>> x[0][1]
    +'b'
    +
    +
    +
    +
    +
    +

    3.2. First Steps Towards Programming

    +

    Of course, we can use Python for more complicated tasks than adding two and two +together. For instance, we can write an initial sub-sequence of the +Fibonacci series +as follows:

    +
    >>> # Fibonacci series:
    +... # the sum of two elements defines the next
    +... a, b = 0, 1
    +>>> while a < 10:
    +...     print(a)
    +...     a, b = b, a+b
    +...
    +0
    +1
    +1
    +2
    +3
    +5
    +8
    +
    +
    +

    This example introduces several new features.

    +
      +
    • The first line contains a multiple assignment: the variables a and b +simultaneously get the new values 0 and 1. On the last line this is used again, +demonstrating that the expressions on the right-hand side are all evaluated +first before any of the assignments take place. The right-hand side expressions +are evaluated from the left to the right.

    • +
    • The while loop executes as long as the condition (here: a < 10) +remains true. In Python, like in C, any non-zero integer value is true; zero is +false. The condition may also be a string or list value, in fact any sequence; +anything with a non-zero length is true, empty sequences are false. The test +used in the example is a simple comparison. The standard comparison operators +are written the same as in C: < (less than), > (greater than), == +(equal to), <= (less than or equal to), >= (greater than or equal to) +and != (not equal to).

    • +
    • The body of the loop is indented: indentation is Python’s way of grouping +statements. At the interactive prompt, you have to type a tab or space(s) for +each indented line. In practice you will prepare more complicated input +for Python with a text editor; all decent text editors have an auto-indent +facility. When a compound statement is entered interactively, it must be +followed by a blank line to indicate completion (since the parser cannot +guess when you have typed the last line). Note that each line within a basic +block must be indented by the same amount.

    • +
    • The print() function writes the value of the argument(s) it is given. +It differs from just writing the expression you want to write (as we did +earlier in the calculator examples) in the way it handles multiple arguments, +floating point quantities, and strings. Strings are printed without quotes, +and a space is inserted between items, so you can format things nicely, like +this:

      +
      >>> i = 256*256
      +>>> print('The value of i is', i)
      +The value of i is 65536
      +
      +
      +

      The keyword argument end can be used to avoid the newline after the output, +or end the output with a different string:

      +
      >>> a, b = 0, 1
      +>>> while a < 1000:
      +...     print(a, end=',')
      +...     a, b = b, a+b
      +...
      +0,1,1,2,3,5,8,13,21,34,55,89,144,233,377,610,987,
      +
      +
      +
    • +
    +

    Footnotes

    +
    +
    1
    +

    Since ** has higher precedence than -, -3**2 will be +interpreted as -(3**2) and thus result in -9. To avoid this +and get 9, you can use (-3)**2.

    +
    +
    2
    +

    Unlike other languages, special characters such as \n have the +same meaning with both single ('...') and double ("...") quotes. +The only difference between the two is that within single quotes you don’t +need to escape " (but you have to escape \') and vice versa.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/tutorial/modules.html b/python-3.7.4-docs-html/tutorial/modules.html new file mode 100644 index 0000000..91504da --- /dev/null +++ b/python-3.7.4-docs-html/tutorial/modules.html @@ -0,0 +1,697 @@ + + + + + + + 6. Modules — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    6. Modules

    +

    If you quit from the Python interpreter and enter it again, the definitions you +have made (functions and variables) are lost. Therefore, if you want to write a +somewhat longer program, you are better off using a text editor to prepare the +input for the interpreter and running it with that file as input instead. This +is known as creating a script. As your program gets longer, you may want to +split it into several files for easier maintenance. You may also want to use a +handy function that you’ve written in several programs without copying its +definition into each program.

    +

    To support this, Python has a way to put definitions in a file and use them in a +script or in an interactive instance of the interpreter. Such a file is called a +module; definitions from a module can be imported into other modules or into +the main module (the collection of variables that you have access to in a +script executed at the top level and in calculator mode).

    +

    A module is a file containing Python definitions and statements. The file name +is the module name with the suffix .py appended. Within a module, the +module’s name (as a string) is available as the value of the global variable +__name__. For instance, use your favorite text editor to create a file +called fibo.py in the current directory with the following contents:

    +
    # Fibonacci numbers module
    +
    +def fib(n):    # write Fibonacci series up to n
    +    a, b = 0, 1
    +    while a < n:
    +        print(a, end=' ')
    +        a, b = b, a+b
    +    print()
    +
    +def fib2(n):   # return Fibonacci series up to n
    +    result = []
    +    a, b = 0, 1
    +    while a < n:
    +        result.append(a)
    +        a, b = b, a+b
    +    return result
    +
    +
    +

    Now enter the Python interpreter and import this module with the following +command:

    +
    >>> import fibo
    +
    +
    +

    This does not enter the names of the functions defined in fibo directly in +the current symbol table; it only enters the module name fibo there. Using +the module name you can access the functions:

    +
    >>> fibo.fib(1000)
    +0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987
    +>>> fibo.fib2(100)
    +[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]
    +>>> fibo.__name__
    +'fibo'
    +
    +
    +

    If you intend to use a function often you can assign it to a local name:

    +
    >>> fib = fibo.fib
    +>>> fib(500)
    +0 1 1 2 3 5 8 13 21 34 55 89 144 233 377
    +
    +
    +
    +

    6.1. More on Modules

    +

    A module can contain executable statements as well as function definitions. +These statements are intended to initialize the module. They are executed only +the first time the module name is encountered in an import statement. 1 +(They are also run if the file is executed as a script.)

    +

    Each module has its own private symbol table, which is used as the global symbol +table by all functions defined in the module. Thus, the author of a module can +use global variables in the module without worrying about accidental clashes +with a user’s global variables. On the other hand, if you know what you are +doing you can touch a module’s global variables with the same notation used to +refer to its functions, modname.itemname.

    +

    Modules can import other modules. It is customary but not required to place all +import statements at the beginning of a module (or script, for that +matter). The imported module names are placed in the importing module’s global +symbol table.

    +

    There is a variant of the import statement that imports names from a +module directly into the importing module’s symbol table. For example:

    +
    >>> from fibo import fib, fib2
    +>>> fib(500)
    +0 1 1 2 3 5 8 13 21 34 55 89 144 233 377
    +
    +
    +

    This does not introduce the module name from which the imports are taken in the +local symbol table (so in the example, fibo is not defined).

    +

    There is even a variant to import all names that a module defines:

    +
    >>> from fibo import *
    +>>> fib(500)
    +0 1 1 2 3 5 8 13 21 34 55 89 144 233 377
    +
    +
    +

    This imports all names except those beginning with an underscore (_). +In most cases Python programmers do not use this facility since it introduces +an unknown set of names into the interpreter, possibly hiding some things +you have already defined.

    +

    Note that in general the practice of importing * from a module or package is +frowned upon, since it often causes poorly readable code. However, it is okay to +use it to save typing in interactive sessions.

    +

    If the module name is followed by as, then the name +following as is bound directly to the imported module.

    +
    >>> import fibo as fib
    +>>> fib.fib(500)
    +0 1 1 2 3 5 8 13 21 34 55 89 144 233 377
    +
    +
    +

    This is effectively importing the module in the same way that import fibo +will do, with the only difference of it being available as fib.

    +

    It can also be used when utilising from with similar effects:

    +
    >>> from fibo import fib as fibonacci
    +>>> fibonacci(500)
    +0 1 1 2 3 5 8 13 21 34 55 89 144 233 377
    +
    +
    +
    +

    Note

    +

    For efficiency reasons, each module is only imported once per interpreter +session. Therefore, if you change your modules, you must restart the +interpreter – or, if it’s just one module you want to test interactively, +use importlib.reload(), e.g. import importlib; +importlib.reload(modulename).

    +
    +
    +

    6.1.1. Executing modules as scripts

    +

    When you run a Python module with

    +
    python fibo.py <arguments>
    +
    +
    +

    the code in the module will be executed, just as if you imported it, but with +the __name__ set to "__main__". That means that by adding this code at +the end of your module:

    +
    if __name__ == "__main__":
    +    import sys
    +    fib(int(sys.argv[1]))
    +
    +
    +

    you can make the file usable as a script as well as an importable module, +because the code that parses the command line only runs if the module is +executed as the “main” file:

    +
    $ python fibo.py 50
    +0 1 1 2 3 5 8 13 21 34
    +
    +
    +

    If the module is imported, the code is not run:

    +
    >>> import fibo
    +>>>
    +
    +
    +

    This is often used either to provide a convenient user interface to a module, or +for testing purposes (running the module as a script executes a test suite).

    +
    +
    +

    6.1.2. The Module Search Path

    +

    When a module named spam is imported, the interpreter first searches for +a built-in module with that name. If not found, it then searches for a file +named spam.py in a list of directories given by the variable +sys.path. sys.path is initialized from these locations:

    +
      +
    • The directory containing the input script (or the current directory when no +file is specified).

    • +
    • PYTHONPATH (a list of directory names, with the same syntax as the +shell variable PATH).

    • +
    • The installation-dependent default.

    • +
    +
    +

    Note

    +

    On file systems which support symlinks, the directory containing the input +script is calculated after the symlink is followed. In other words the +directory containing the symlink is not added to the module search path.

    +
    +

    After initialization, Python programs can modify sys.path. The +directory containing the script being run is placed at the beginning of the +search path, ahead of the standard library path. This means that scripts in that +directory will be loaded instead of modules of the same name in the library +directory. This is an error unless the replacement is intended. See section +Standard Modules for more information.

    +
    +
    +

    6.1.3. “Compiled” Python files

    +

    To speed up loading modules, Python caches the compiled version of each module +in the __pycache__ directory under the name module.version.pyc, +where the version encodes the format of the compiled file; it generally contains +the Python version number. For example, in CPython release 3.3 the compiled +version of spam.py would be cached as __pycache__/spam.cpython-33.pyc. This +naming convention allows compiled modules from different releases and different +versions of Python to coexist.

    +

    Python checks the modification date of the source against the compiled version +to see if it’s out of date and needs to be recompiled. This is a completely +automatic process. Also, the compiled modules are platform-independent, so the +same library can be shared among systems with different architectures.

    +

    Python does not check the cache in two circumstances. First, it always +recompiles and does not store the result for the module that’s loaded directly +from the command line. Second, it does not check the cache if there is no +source module. To support a non-source (compiled only) distribution, the +compiled module must be in the source directory, and there must not be a source +module.

    +

    Some tips for experts:

    +
      +
    • You can use the -O or -OO switches on the Python command +to reduce the size of a compiled module. The -O switch removes assert +statements, the -OO switch removes both assert statements and __doc__ +strings. Since some programs may rely on having these available, you should +only use this option if you know what you’re doing. “Optimized” modules have +an opt- tag and are usually smaller. Future releases may +change the effects of optimization.

    • +
    • A program doesn’t run any faster when it is read from a .pyc +file than when it is read from a .py file; the only thing that’s faster +about .pyc files is the speed with which they are loaded.

    • +
    • The module compileall can create .pyc files for all modules in a +directory.

    • +
    • There is more detail on this process, including a flow chart of the +decisions, in PEP 3147.

    • +
    +
    +
    +
    +

    6.2. Standard Modules

    +

    Python comes with a library of standard modules, described in a separate +document, the Python Library Reference (“Library Reference” hereafter). Some +modules are built into the interpreter; these provide access to operations that +are not part of the core of the language but are nevertheless built in, either +for efficiency or to provide access to operating system primitives such as +system calls. The set of such modules is a configuration option which also +depends on the underlying platform. For example, the winreg module is only +provided on Windows systems. One particular module deserves some attention: +sys, which is built into every Python interpreter. The variables +sys.ps1 and sys.ps2 define the strings used as primary and secondary +prompts:

    +
    >>> import sys
    +>>> sys.ps1
    +'>>> '
    +>>> sys.ps2
    +'... '
    +>>> sys.ps1 = 'C> '
    +C> print('Yuck!')
    +Yuck!
    +C>
    +
    +
    +

    These two variables are only defined if the interpreter is in interactive mode.

    +

    The variable sys.path is a list of strings that determines the interpreter’s +search path for modules. It is initialized to a default path taken from the +environment variable PYTHONPATH, or from a built-in default if +PYTHONPATH is not set. You can modify it using standard list +operations:

    +
    >>> import sys
    +>>> sys.path.append('/ufs/guido/lib/python')
    +
    +
    +
    +
    +

    6.3. The dir() Function

    +

    The built-in function dir() is used to find out which names a module +defines. It returns a sorted list of strings:

    +
    >>> import fibo, sys
    +>>> dir(fibo)
    +['__name__', 'fib', 'fib2']
    +>>> dir(sys)  
    +['__displayhook__', '__doc__', '__excepthook__', '__loader__', '__name__',
    + '__package__', '__stderr__', '__stdin__', '__stdout__',
    + '_clear_type_cache', '_current_frames', '_debugmallocstats', '_getframe',
    + '_home', '_mercurial', '_xoptions', 'abiflags', 'api_version', 'argv',
    + 'base_exec_prefix', 'base_prefix', 'builtin_module_names', 'byteorder',
    + 'call_tracing', 'callstats', 'copyright', 'displayhook',
    + 'dont_write_bytecode', 'exc_info', 'excepthook', 'exec_prefix',
    + 'executable', 'exit', 'flags', 'float_info', 'float_repr_style',
    + 'getcheckinterval', 'getdefaultencoding', 'getdlopenflags',
    + 'getfilesystemencoding', 'getobjects', 'getprofile', 'getrecursionlimit',
    + 'getrefcount', 'getsizeof', 'getswitchinterval', 'gettotalrefcount',
    + 'gettrace', 'hash_info', 'hexversion', 'implementation', 'int_info',
    + 'intern', 'maxsize', 'maxunicode', 'meta_path', 'modules', 'path',
    + 'path_hooks', 'path_importer_cache', 'platform', 'prefix', 'ps1',
    + 'setcheckinterval', 'setdlopenflags', 'setprofile', 'setrecursionlimit',
    + 'setswitchinterval', 'settrace', 'stderr', 'stdin', 'stdout',
    + 'thread_info', 'version', 'version_info', 'warnoptions']
    +
    +
    +

    Without arguments, dir() lists the names you have defined currently:

    +
    >>> a = [1, 2, 3, 4, 5]
    +>>> import fibo
    +>>> fib = fibo.fib
    +>>> dir()
    +['__builtins__', '__name__', 'a', 'fib', 'fibo', 'sys']
    +
    +
    +

    Note that it lists all types of names: variables, modules, functions, etc.

    +

    dir() does not list the names of built-in functions and variables. If you +want a list of those, they are defined in the standard module +builtins:

    +
    >>> import builtins
    +>>> dir(builtins)  
    +['ArithmeticError', 'AssertionError', 'AttributeError', 'BaseException',
    + 'BlockingIOError', 'BrokenPipeError', 'BufferError', 'BytesWarning',
    + 'ChildProcessError', 'ConnectionAbortedError', 'ConnectionError',
    + 'ConnectionRefusedError', 'ConnectionResetError', 'DeprecationWarning',
    + 'EOFError', 'Ellipsis', 'EnvironmentError', 'Exception', 'False',
    + 'FileExistsError', 'FileNotFoundError', 'FloatingPointError',
    + 'FutureWarning', 'GeneratorExit', 'IOError', 'ImportError',
    + 'ImportWarning', 'IndentationError', 'IndexError', 'InterruptedError',
    + 'IsADirectoryError', 'KeyError', 'KeyboardInterrupt', 'LookupError',
    + 'MemoryError', 'NameError', 'None', 'NotADirectoryError', 'NotImplemented',
    + 'NotImplementedError', 'OSError', 'OverflowError',
    + 'PendingDeprecationWarning', 'PermissionError', 'ProcessLookupError',
    + 'ReferenceError', 'ResourceWarning', 'RuntimeError', 'RuntimeWarning',
    + 'StopIteration', 'SyntaxError', 'SyntaxWarning', 'SystemError',
    + 'SystemExit', 'TabError', 'TimeoutError', 'True', 'TypeError',
    + 'UnboundLocalError', 'UnicodeDecodeError', 'UnicodeEncodeError',
    + 'UnicodeError', 'UnicodeTranslateError', 'UnicodeWarning', 'UserWarning',
    + 'ValueError', 'Warning', 'ZeroDivisionError', '_', '__build_class__',
    + '__debug__', '__doc__', '__import__', '__name__', '__package__', 'abs',
    + 'all', 'any', 'ascii', 'bin', 'bool', 'bytearray', 'bytes', 'callable',
    + 'chr', 'classmethod', 'compile', 'complex', 'copyright', 'credits',
    + 'delattr', 'dict', 'dir', 'divmod', 'enumerate', 'eval', 'exec', 'exit',
    + 'filter', 'float', 'format', 'frozenset', 'getattr', 'globals', 'hasattr',
    + 'hash', 'help', 'hex', 'id', 'input', 'int', 'isinstance', 'issubclass',
    + 'iter', 'len', 'license', 'list', 'locals', 'map', 'max', 'memoryview',
    + 'min', 'next', 'object', 'oct', 'open', 'ord', 'pow', 'print', 'property',
    + 'quit', 'range', 'repr', 'reversed', 'round', 'set', 'setattr', 'slice',
    + 'sorted', 'staticmethod', 'str', 'sum', 'super', 'tuple', 'type', 'vars',
    + 'zip']
    +
    +
    +
    +
    +

    6.4. Packages

    +

    Packages are a way of structuring Python’s module namespace by using “dotted +module names”. For example, the module name A.B designates a submodule +named B in a package named A. Just like the use of modules saves the +authors of different modules from having to worry about each other’s global +variable names, the use of dotted module names saves the authors of multi-module +packages like NumPy or Pillow from having to worry about +each other’s module names.

    +

    Suppose you want to design a collection of modules (a “package”) for the uniform +handling of sound files and sound data. There are many different sound file +formats (usually recognized by their extension, for example: .wav, +.aiff, .au), so you may need to create and maintain a growing +collection of modules for the conversion between the various file formats. +There are also many different operations you might want to perform on sound data +(such as mixing, adding echo, applying an equalizer function, creating an +artificial stereo effect), so in addition you will be writing a never-ending +stream of modules to perform these operations. Here’s a possible structure for +your package (expressed in terms of a hierarchical filesystem):

    +
    sound/                          Top-level package
    +      __init__.py               Initialize the sound package
    +      formats/                  Subpackage for file format conversions
    +              __init__.py
    +              wavread.py
    +              wavwrite.py
    +              aiffread.py
    +              aiffwrite.py
    +              auread.py
    +              auwrite.py
    +              ...
    +      effects/                  Subpackage for sound effects
    +              __init__.py
    +              echo.py
    +              surround.py
    +              reverse.py
    +              ...
    +      filters/                  Subpackage for filters
    +              __init__.py
    +              equalizer.py
    +              vocoder.py
    +              karaoke.py
    +              ...
    +
    +
    +

    When importing the package, Python searches through the directories on +sys.path looking for the package subdirectory.

    +

    The __init__.py files are required to make Python treat directories +containing the file as packages. This prevents directories with a common name, +such as string, unintentionally hiding valid modules that occur later +on the module search path. In the simplest case, __init__.py can just be +an empty file, but it can also execute initialization code for the package or +set the __all__ variable, described later.

    +

    Users of the package can import individual modules from the package, for +example:

    +
    import sound.effects.echo
    +
    +
    +

    This loads the submodule sound.effects.echo. It must be referenced with +its full name.

    +
    sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)
    +
    +
    +

    An alternative way of importing the submodule is:

    +
    from sound.effects import echo
    +
    +
    +

    This also loads the submodule echo, and makes it available without its +package prefix, so it can be used as follows:

    +
    echo.echofilter(input, output, delay=0.7, atten=4)
    +
    +
    +

    Yet another variation is to import the desired function or variable directly:

    +
    from sound.effects.echo import echofilter
    +
    +
    +

    Again, this loads the submodule echo, but this makes its function +echofilter() directly available:

    +
    echofilter(input, output, delay=0.7, atten=4)
    +
    +
    +

    Note that when using from package import item, the item can be either a +submodule (or subpackage) of the package, or some other name defined in the +package, like a function, class or variable. The import statement first +tests whether the item is defined in the package; if not, it assumes it is a +module and attempts to load it. If it fails to find it, an ImportError +exception is raised.

    +

    Contrarily, when using syntax like import item.subitem.subsubitem, each item +except for the last must be a package; the last item can be a module or a +package but can’t be a class or function or variable defined in the previous +item.

    +
    +

    6.4.1. Importing * From a Package

    +

    Now what happens when the user writes from sound.effects import *? Ideally, +one would hope that this somehow goes out to the filesystem, finds which +submodules are present in the package, and imports them all. This could take a +long time and importing sub-modules might have unwanted side-effects that should +only happen when the sub-module is explicitly imported.

    +

    The only solution is for the package author to provide an explicit index of the +package. The import statement uses the following convention: if a package’s +__init__.py code defines a list named __all__, it is taken to be the +list of module names that should be imported when from package import * is +encountered. It is up to the package author to keep this list up-to-date when a +new version of the package is released. Package authors may also decide not to +support it, if they don’t see a use for importing * from their package. For +example, the file sound/effects/__init__.py could contain the following +code:

    +
    __all__ = ["echo", "surround", "reverse"]
    +
    +
    +

    This would mean that from sound.effects import * would import the three +named submodules of the sound package.

    +

    If __all__ is not defined, the statement from sound.effects import * +does not import all submodules from the package sound.effects into the +current namespace; it only ensures that the package sound.effects has +been imported (possibly running any initialization code in __init__.py) +and then imports whatever names are defined in the package. This includes any +names defined (and submodules explicitly loaded) by __init__.py. It +also includes any submodules of the package that were explicitly loaded by +previous import statements. Consider this code:

    +
    import sound.effects.echo
    +import sound.effects.surround
    +from sound.effects import *
    +
    +
    +

    In this example, the echo and surround modules are imported in the +current namespace because they are defined in the sound.effects package +when the from...import statement is executed. (This also works when +__all__ is defined.)

    +

    Although certain modules are designed to export only names that follow certain +patterns when you use import *, it is still considered bad practice in +production code.

    +

    Remember, there is nothing wrong with using from package import +specific_submodule! In fact, this is the recommended notation unless the +importing module needs to use submodules with the same name from different +packages.

    +
    +
    +

    6.4.2. Intra-package References

    +

    When packages are structured into subpackages (as with the sound package +in the example), you can use absolute imports to refer to submodules of siblings +packages. For example, if the module sound.filters.vocoder needs to use +the echo module in the sound.effects package, it can use from +sound.effects import echo.

    +

    You can also write relative imports, with the from module import name form +of import statement. These imports use leading dots to indicate the current and +parent packages involved in the relative import. From the surround +module for example, you might use:

    +
    from . import echo
    +from .. import formats
    +from ..filters import equalizer
    +
    +
    +

    Note that relative imports are based on the name of the current module. Since +the name of the main module is always "__main__", modules intended for use +as the main module of a Python application must always use absolute imports.

    +
    +
    +

    6.4.3. Packages in Multiple Directories

    +

    Packages support one more special attribute, __path__. This is +initialized to be a list containing the name of the directory holding the +package’s __init__.py before the code in that file is executed. This +variable can be modified; doing so affects future searches for modules and +subpackages contained in the package.

    +

    While this feature is not often needed, it can be used to extend the set of +modules found in a package.

    +

    Footnotes

    +
    +
    1
    +

    In fact function definitions are also ‘statements’ that are ‘executed’; the +execution of a module-level function definition enters the function name in +the module’s global symbol table.

    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/tutorial/stdlib.html b/python-3.7.4-docs-html/tutorial/stdlib.html new file mode 100644 index 0000000..bf1396a --- /dev/null +++ b/python-3.7.4-docs-html/tutorial/stdlib.html @@ -0,0 +1,486 @@ + + + + + + + 10. Brief Tour of the Standard Library — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    10. Brief Tour of the Standard Library

    +
    +

    10.1. Operating System Interface

    +

    The os module provides dozens of functions for interacting with the +operating system:

    +
    >>> import os
    +>>> os.getcwd()      # Return the current working directory
    +'C:\\Python37'
    +>>> os.chdir('/server/accesslogs')   # Change current working directory
    +>>> os.system('mkdir today')   # Run the command mkdir in the system shell
    +0
    +
    +
    +

    Be sure to use the import os style instead of from os import *. This +will keep os.open() from shadowing the built-in open() function which +operates much differently.

    +

    The built-in dir() and help() functions are useful as interactive +aids for working with large modules like os:

    +
    >>> import os
    +>>> dir(os)
    +<returns a list of all module functions>
    +>>> help(os)
    +<returns an extensive manual page created from the module's docstrings>
    +
    +
    +

    For daily file and directory management tasks, the shutil module provides +a higher level interface that is easier to use:

    +
    >>> import shutil
    +>>> shutil.copyfile('data.db', 'archive.db')
    +'archive.db'
    +>>> shutil.move('/build/executables', 'installdir')
    +'installdir'
    +
    +
    +
    +
    +

    10.2. File Wildcards

    +

    The glob module provides a function for making file lists from directory +wildcard searches:

    +
    >>> import glob
    +>>> glob.glob('*.py')
    +['primes.py', 'random.py', 'quote.py']
    +
    +
    +
    +
    +

    10.3. Command Line Arguments

    +

    Common utility scripts often need to process command line arguments. These +arguments are stored in the sys module’s argv attribute as a list. For +instance the following output results from running python demo.py one two +three at the command line:

    +
    >>> import sys
    +>>> print(sys.argv)
    +['demo.py', 'one', 'two', 'three']
    +
    +
    +

    The getopt module processes sys.argv using the conventions of the Unix +getopt() function. More powerful and flexible command line processing is +provided by the argparse module.

    +
    +
    +

    10.4. Error Output Redirection and Program Termination

    +

    The sys module also has attributes for stdin, stdout, and stderr. +The latter is useful for emitting warnings and error messages to make them +visible even when stdout has been redirected:

    +
    >>> sys.stderr.write('Warning, log file not found starting a new one\n')
    +Warning, log file not found starting a new one
    +
    +
    +

    The most direct way to terminate a script is to use sys.exit().

    +
    +
    +

    10.5. String Pattern Matching

    +

    The re module provides regular expression tools for advanced string +processing. For complex matching and manipulation, regular expressions offer +succinct, optimized solutions:

    +
    >>> import re
    +>>> re.findall(r'\bf[a-z]*', 'which foot or hand fell fastest')
    +['foot', 'fell', 'fastest']
    +>>> re.sub(r'(\b[a-z]+) \1', r'\1', 'cat in the the hat')
    +'cat in the hat'
    +
    +
    +

    When only simple capabilities are needed, string methods are preferred because +they are easier to read and debug:

    +
    >>> 'tea for too'.replace('too', 'two')
    +'tea for two'
    +
    +
    +
    +
    +

    10.6. Mathematics

    +

    The math module gives access to the underlying C library functions for +floating point math:

    +
    >>> import math
    +>>> math.cos(math.pi / 4)
    +0.70710678118654757
    +>>> math.log(1024, 2)
    +10.0
    +
    +
    +

    The random module provides tools for making random selections:

    +
    >>> import random
    +>>> random.choice(['apple', 'pear', 'banana'])
    +'apple'
    +>>> random.sample(range(100), 10)   # sampling without replacement
    +[30, 83, 16, 4, 8, 81, 41, 50, 18, 33]
    +>>> random.random()    # random float
    +0.17970987693706186
    +>>> random.randrange(6)    # random integer chosen from range(6)
    +4
    +
    +
    +

    The statistics module calculates basic statistical properties +(the mean, median, variance, etc.) of numeric data:

    +
    >>> import statistics
    +>>> data = [2.75, 1.75, 1.25, 0.25, 0.5, 1.25, 3.5]
    +>>> statistics.mean(data)
    +1.6071428571428572
    +>>> statistics.median(data)
    +1.25
    +>>> statistics.variance(data)
    +1.3720238095238095
    +
    +
    +

    The SciPy project <https://scipy.org> has many other modules for numerical +computations.

    +
    +
    +

    10.7. Internet Access

    +

    There are a number of modules for accessing the internet and processing internet +protocols. Two of the simplest are urllib.request for retrieving data +from URLs and smtplib for sending mail:

    +
    >>> from urllib.request import urlopen
    +>>> with urlopen('http://tycho.usno.navy.mil/cgi-bin/timer.pl') as response:
    +...     for line in response:
    +...         line = line.decode('utf-8')  # Decoding the binary data to text.
    +...         if 'EST' in line or 'EDT' in line:  # look for Eastern Time
    +...             print(line)
    +
    +<BR>Nov. 25, 09:43:32 PM EST
    +
    +>>> import smtplib
    +>>> server = smtplib.SMTP('localhost')
    +>>> server.sendmail('soothsayer@example.org', 'jcaesar@example.org',
    +... """To: jcaesar@example.org
    +... From: soothsayer@example.org
    +...
    +... Beware the Ides of March.
    +... """)
    +>>> server.quit()
    +
    +
    +

    (Note that the second example needs a mailserver running on localhost.)

    +
    +
    +

    10.8. Dates and Times

    +

    The datetime module supplies classes for manipulating dates and times in +both simple and complex ways. While date and time arithmetic is supported, the +focus of the implementation is on efficient member extraction for output +formatting and manipulation. The module also supports objects that are timezone +aware.

    +
    >>> # dates are easily constructed and formatted
    +>>> from datetime import date
    +>>> now = date.today()
    +>>> now
    +datetime.date(2003, 12, 2)
    +>>> now.strftime("%m-%d-%y. %d %b %Y is a %A on the %d day of %B.")
    +'12-02-03. 02 Dec 2003 is a Tuesday on the 02 day of December.'
    +
    +>>> # dates support calendar arithmetic
    +>>> birthday = date(1964, 7, 31)
    +>>> age = now - birthday
    +>>> age.days
    +14368
    +
    +
    +
    +
    +

    10.9. Data Compression

    +

    Common data archiving and compression formats are directly supported by modules +including: zlib, gzip, bz2, lzma, zipfile and +tarfile.

    +
    >>> import zlib
    +>>> s = b'witch which has which witches wrist watch'
    +>>> len(s)
    +41
    +>>> t = zlib.compress(s)
    +>>> len(t)
    +37
    +>>> zlib.decompress(t)
    +b'witch which has which witches wrist watch'
    +>>> zlib.crc32(s)
    +226805979
    +
    +
    +
    +
    +

    10.10. Performance Measurement

    +

    Some Python users develop a deep interest in knowing the relative performance of +different approaches to the same problem. Python provides a measurement tool +that answers those questions immediately.

    +

    For example, it may be tempting to use the tuple packing and unpacking feature +instead of the traditional approach to swapping arguments. The timeit +module quickly demonstrates a modest performance advantage:

    +
    >>> from timeit import Timer
    +>>> Timer('t=a; a=b; b=t', 'a=1; b=2').timeit()
    +0.57535828626024577
    +>>> Timer('a,b = b,a', 'a=1; b=2').timeit()
    +0.54962537085770791
    +
    +
    +

    In contrast to timeit’s fine level of granularity, the profile and +pstats modules provide tools for identifying time critical sections in +larger blocks of code.

    +
    +
    +

    10.11. Quality Control

    +

    One approach for developing high quality software is to write tests for each +function as it is developed and to run those tests frequently during the +development process.

    +

    The doctest module provides a tool for scanning a module and validating +tests embedded in a program’s docstrings. Test construction is as simple as +cutting-and-pasting a typical call along with its results into the docstring. +This improves the documentation by providing the user with an example and it +allows the doctest module to make sure the code remains true to the +documentation:

    +
    def average(values):
    +    """Computes the arithmetic mean of a list of numbers.
    +
    +    >>> print(average([20, 30, 70]))
    +    40.0
    +    """
    +    return sum(values) / len(values)
    +
    +import doctest
    +doctest.testmod()   # automatically validate the embedded tests
    +
    +
    +

    The unittest module is not as effortless as the doctest module, +but it allows a more comprehensive set of tests to be maintained in a separate +file:

    +
    import unittest
    +
    +class TestStatisticalFunctions(unittest.TestCase):
    +
    +    def test_average(self):
    +        self.assertEqual(average([20, 30, 70]), 40.0)
    +        self.assertEqual(round(average([1, 5, 7]), 1), 4.3)
    +        with self.assertRaises(ZeroDivisionError):
    +            average([])
    +        with self.assertRaises(TypeError):
    +            average(20, 30, 70)
    +
    +unittest.main()  # Calling from the command line invokes all tests
    +
    +
    +
    +
    +

    10.12. Batteries Included

    +

    Python has a “batteries included” philosophy. This is best seen through the +sophisticated and robust capabilities of its larger packages. For example:

    +
      +
    • The xmlrpc.client and xmlrpc.server modules make implementing +remote procedure calls into an almost trivial task. Despite the modules +names, no direct knowledge or handling of XML is needed.

    • +
    • The email package is a library for managing email messages, including +MIME and other RFC 2822-based message documents. Unlike smtplib and +poplib which actually send and receive messages, the email package has +a complete toolset for building or decoding complex message structures +(including attachments) and for implementing internet encoding and header +protocols.

    • +
    • The json package provides robust support for parsing this +popular data interchange format. The csv module supports +direct reading and writing of files in Comma-Separated Value format, +commonly supported by databases and spreadsheets. XML processing is +supported by the xml.etree.ElementTree, xml.dom and +xml.sax packages. Together, these modules and packages +greatly simplify data interchange between Python applications and +other tools.

    • +
    • The sqlite3 module is a wrapper for the SQLite database +library, providing a persistent database that can be updated and +accessed using slightly nonstandard SQL syntax.

    • +
    • Internationalization is supported by a number of modules including +gettext, locale, and the codecs package.

    • +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/tutorial/stdlib2.html b/python-3.7.4-docs-html/tutorial/stdlib2.html new file mode 100644 index 0000000..26fc50a --- /dev/null +++ b/python-3.7.4-docs-html/tutorial/stdlib2.html @@ -0,0 +1,556 @@ + + + + + + + 11. Brief Tour of the Standard Library — Part II — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    11. Brief Tour of the Standard Library — Part II

    +

    This second tour covers more advanced modules that support professional +programming needs. These modules rarely occur in small scripts.

    +
    +

    11.1. Output Formatting

    +

    The reprlib module provides a version of repr() customized for +abbreviated displays of large or deeply nested containers:

    +
    >>> import reprlib
    +>>> reprlib.repr(set('supercalifragilisticexpialidocious'))
    +"{'a', 'c', 'd', 'e', 'f', 'g', ...}"
    +
    +
    +

    The pprint module offers more sophisticated control over printing both +built-in and user defined objects in a way that is readable by the interpreter. +When the result is longer than one line, the “pretty printer” adds line breaks +and indentation to more clearly reveal data structure:

    +
    >>> import pprint
    +>>> t = [[[['black', 'cyan'], 'white', ['green', 'red']], [['magenta',
    +...     'yellow'], 'blue']]]
    +...
    +>>> pprint.pprint(t, width=30)
    +[[[['black', 'cyan'],
    +   'white',
    +   ['green', 'red']],
    +  [['magenta', 'yellow'],
    +   'blue']]]
    +
    +
    +

    The textwrap module formats paragraphs of text to fit a given screen +width:

    +
    >>> import textwrap
    +>>> doc = """The wrap() method is just like fill() except that it returns
    +... a list of strings instead of one big string with newlines to separate
    +... the wrapped lines."""
    +...
    +>>> print(textwrap.fill(doc, width=40))
    +The wrap() method is just like fill()
    +except that it returns a list of strings
    +instead of one big string with newlines
    +to separate the wrapped lines.
    +
    +
    +

    The locale module accesses a database of culture specific data formats. +The grouping attribute of locale’s format function provides a direct way of +formatting numbers with group separators:

    +
    >>> import locale
    +>>> locale.setlocale(locale.LC_ALL, 'English_United States.1252')
    +'English_United States.1252'
    +>>> conv = locale.localeconv()          # get a mapping of conventions
    +>>> x = 1234567.8
    +>>> locale.format("%d", x, grouping=True)
    +'1,234,567'
    +>>> locale.format_string("%s%.*f", (conv['currency_symbol'],
    +...                      conv['frac_digits'], x), grouping=True)
    +'$1,234,567.80'
    +
    +
    +
    +
    +

    11.2. Templating

    +

    The string module includes a versatile Template class +with a simplified syntax suitable for editing by end-users. This allows users +to customize their applications without having to alter the application.

    +

    The format uses placeholder names formed by $ with valid Python identifiers +(alphanumeric characters and underscores). Surrounding the placeholder with +braces allows it to be followed by more alphanumeric letters with no intervening +spaces. Writing $$ creates a single escaped $:

    +
    >>> from string import Template
    +>>> t = Template('${village}folk send $$10 to $cause.')
    +>>> t.substitute(village='Nottingham', cause='the ditch fund')
    +'Nottinghamfolk send $10 to the ditch fund.'
    +
    +
    +

    The substitute() method raises a KeyError when a +placeholder is not supplied in a dictionary or a keyword argument. For +mail-merge style applications, user supplied data may be incomplete and the +safe_substitute() method may be more appropriate — +it will leave placeholders unchanged if data is missing:

    +
    >>> t = Template('Return the $item to $owner.')
    +>>> d = dict(item='unladen swallow')
    +>>> t.substitute(d)
    +Traceback (most recent call last):
    +  ...
    +KeyError: 'owner'
    +>>> t.safe_substitute(d)
    +'Return the unladen swallow to $owner.'
    +
    +
    +

    Template subclasses can specify a custom delimiter. For example, a batch +renaming utility for a photo browser may elect to use percent signs for +placeholders such as the current date, image sequence number, or file format:

    +
    >>> import time, os.path
    +>>> photofiles = ['img_1074.jpg', 'img_1076.jpg', 'img_1077.jpg']
    +>>> class BatchRename(Template):
    +...     delimiter = '%'
    +>>> fmt = input('Enter rename style (%d-date %n-seqnum %f-format):  ')
    +Enter rename style (%d-date %n-seqnum %f-format):  Ashley_%n%f
    +
    +>>> t = BatchRename(fmt)
    +>>> date = time.strftime('%d%b%y')
    +>>> for i, filename in enumerate(photofiles):
    +...     base, ext = os.path.splitext(filename)
    +...     newname = t.substitute(d=date, n=i, f=ext)
    +...     print('{0} --> {1}'.format(filename, newname))
    +
    +img_1074.jpg --> Ashley_0.jpg
    +img_1076.jpg --> Ashley_1.jpg
    +img_1077.jpg --> Ashley_2.jpg
    +
    +
    +

    Another application for templating is separating program logic from the details +of multiple output formats. This makes it possible to substitute custom +templates for XML files, plain text reports, and HTML web reports.

    +
    +
    +

    11.3. Working with Binary Data Record Layouts

    +

    The struct module provides pack() and +unpack() functions for working with variable length binary +record formats. The following example shows +how to loop through header information in a ZIP file without using the +zipfile module. Pack codes "H" and "I" represent two and four +byte unsigned numbers respectively. The "<" indicates that they are +standard size and in little-endian byte order:

    +
    import struct
    +
    +with open('myfile.zip', 'rb') as f:
    +    data = f.read()
    +
    +start = 0
    +for i in range(3):                      # show the first 3 file headers
    +    start += 14
    +    fields = struct.unpack('<IIIHH', data[start:start+16])
    +    crc32, comp_size, uncomp_size, filenamesize, extra_size = fields
    +
    +    start += 16
    +    filename = data[start:start+filenamesize]
    +    start += filenamesize
    +    extra = data[start:start+extra_size]
    +    print(filename, hex(crc32), comp_size, uncomp_size)
    +
    +    start += extra_size + comp_size     # skip to the next header
    +
    +
    +
    +
    +

    11.4. Multi-threading

    +

    Threading is a technique for decoupling tasks which are not sequentially +dependent. Threads can be used to improve the responsiveness of applications +that accept user input while other tasks run in the background. A related use +case is running I/O in parallel with computations in another thread.

    +

    The following code shows how the high level threading module can run +tasks in background while the main program continues to run:

    +
    import threading, zipfile
    +
    +class AsyncZip(threading.Thread):
    +    def __init__(self, infile, outfile):
    +        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)
    +        f.close()
    +        print('Finished background zip of:', self.infile)
    +
    +background = AsyncZip('mydata.txt', 'myarchive.zip')
    +background.start()
    +print('The main program continues to run in foreground.')
    +
    +background.join()    # Wait for the background task to finish
    +print('Main program waited until background was done.')
    +
    +
    +

    The principal challenge of multi-threaded applications is coordinating threads +that share data or other resources. To that end, the threading module provides +a number of synchronization primitives including locks, events, condition +variables, and semaphores.

    +

    While those tools are powerful, minor design errors can result in problems that +are difficult to reproduce. So, the preferred approach to task coordination is +to concentrate all access to a resource in a single thread and then use the +queue module to feed that thread with requests from other threads. +Applications using Queue objects for inter-thread communication and +coordination are easier to design, more readable, and more reliable.

    +
    +
    +

    11.5. Logging

    +

    The logging module offers a full featured and flexible logging system. +At its simplest, log messages are sent to a file or to sys.stderr:

    +
    import logging
    +logging.debug('Debugging information')
    +logging.info('Informational message')
    +logging.warning('Warning:config file %s not found', 'server.conf')
    +logging.error('Error occurred')
    +logging.critical('Critical error -- shutting down')
    +
    +
    +

    This produces the following output:

    +
    WARNING:root:Warning:config file server.conf not found
    +ERROR:root:Error occurred
    +CRITICAL:root:Critical error -- shutting down
    +
    +
    +

    By default, informational and debugging messages are suppressed and the output +is sent to standard error. Other output options include routing messages +through email, datagrams, sockets, or to an HTTP Server. New filters can select +different routing based on message priority: DEBUG, +INFO, WARNING, ERROR, +and CRITICAL.

    +

    The logging system can be configured directly from Python or can be loaded from +a user editable configuration file for customized logging without altering the +application.

    +
    +
    +

    11.6. Weak References

    +

    Python does automatic memory management (reference counting for most objects and +garbage collection to eliminate cycles). The memory is freed shortly +after the last reference to it has been eliminated.

    +

    This approach works fine for most applications but occasionally there is a need +to track objects only as long as they are being used by something else. +Unfortunately, just tracking them creates a reference that makes them permanent. +The weakref module provides tools for tracking objects without creating a +reference. When the object is no longer needed, it is automatically removed +from a weakref table and a callback is triggered for weakref objects. Typical +applications include caching objects that are expensive to create:

    +
    >>> import weakref, gc
    +>>> class A:
    +...     def __init__(self, value):
    +...         self.value = value
    +...     def __repr__(self):
    +...         return str(self.value)
    +...
    +>>> a = A(10)                   # create a reference
    +>>> d = weakref.WeakValueDictionary()
    +>>> d['primary'] = a            # does not create a reference
    +>>> d['primary']                # fetch the object if it is still alive
    +10
    +>>> del a                       # remove the one reference
    +>>> gc.collect()                # run garbage collection right away
    +0
    +>>> d['primary']                # entry was automatically removed
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +    d['primary']                # entry was automatically removed
    +  File "C:/python37/lib/weakref.py", line 46, in __getitem__
    +    o = self.data[key]()
    +KeyError: 'primary'
    +
    +
    +
    +
    +

    11.7. Tools for Working with Lists

    +

    Many data structure needs can be met with the built-in list type. However, +sometimes there is a need for alternative implementations with different +performance trade-offs.

    +

    The array module provides an array() object that is like +a list that stores only homogeneous data and stores it more compactly. The +following example shows an array of numbers stored as two byte unsigned binary +numbers (typecode "H") rather than the usual 16 bytes per entry for regular +lists of Python int objects:

    +
    >>> from array import array
    +>>> a = array('H', [4000, 10, 700, 22222])
    +>>> sum(a)
    +26932
    +>>> a[1:3]
    +array('H', [10, 700])
    +
    +
    +

    The collections module provides a deque() object +that is like a list with faster appends and pops from the left side but slower +lookups in the middle. These objects are well suited for implementing queues +and breadth first tree searches:

    +
    >>> from collections import deque
    +>>> d = deque(["task1", "task2", "task3"])
    +>>> d.append("task4")
    +>>> print("Handling", d.popleft())
    +Handling task1
    +
    +
    +
    unsearched = deque([starting_node])
    +def breadth_first_search(unsearched):
    +    node = unsearched.popleft()
    +    for m in gen_moves(node):
    +        if is_goal(m):
    +            return m
    +        unsearched.append(m)
    +
    +
    +

    In addition to alternative list implementations, the library also offers other +tools such as the bisect module with functions for manipulating sorted +lists:

    +
    >>> import bisect
    +>>> scores = [(100, 'perl'), (200, 'tcl'), (400, 'lua'), (500, 'python')]
    +>>> bisect.insort(scores, (300, 'ruby'))
    +>>> scores
    +[(100, 'perl'), (200, 'tcl'), (300, 'ruby'), (400, 'lua'), (500, 'python')]
    +
    +
    +

    The heapq module provides functions for implementing heaps based on +regular lists. The lowest valued entry is always kept at position zero. This +is useful for applications which repeatedly access the smallest element but do +not want to run a full list sort:

    +
    >>> from heapq import heapify, heappop, heappush
    +>>> data = [1, 3, 5, 7, 9, 2, 4, 6, 8, 0]
    +>>> heapify(data)                      # rearrange the list into heap order
    +>>> heappush(data, -5)                 # add a new entry
    +>>> [heappop(data) for i in range(3)]  # fetch the three smallest entries
    +[-5, 0, 1]
    +
    +
    +
    +
    +

    11.8. Decimal Floating Point Arithmetic

    +

    The decimal module offers a Decimal datatype for +decimal floating point arithmetic. Compared to the built-in float +implementation of binary floating point, the class is especially helpful for

    +
      +
    • financial applications and other uses which require exact decimal +representation,

    • +
    • control over precision,

    • +
    • control over rounding to meet legal or regulatory requirements,

    • +
    • tracking of significant decimal places, or

    • +
    • applications where the user expects the results to match calculations done by +hand.

    • +
    +

    For example, calculating a 5% tax on a 70 cent phone charge gives different +results in decimal floating point and binary floating point. The difference +becomes significant if the results are rounded to the nearest cent:

    +
    >>> from decimal import *
    +>>> round(Decimal('0.70') * Decimal('1.05'), 2)
    +Decimal('0.74')
    +>>> round(.70 * 1.05, 2)
    +0.73
    +
    +
    +

    The Decimal result keeps a trailing zero, automatically +inferring four place significance from multiplicands with two place +significance. Decimal reproduces mathematics as done by hand and avoids +issues that can arise when binary floating point cannot exactly represent +decimal quantities.

    +

    Exact representation enables the Decimal class to perform +modulo calculations and equality tests that are unsuitable for binary floating +point:

    +
    >>> Decimal('1.00') % Decimal('.10')
    +Decimal('0.00')
    +>>> 1.00 % 0.10
    +0.09999999999999995
    +
    +>>> sum([Decimal('0.1')]*10) == Decimal('1.0')
    +True
    +>>> sum([0.1]*10) == 1.0
    +False
    +
    +
    +

    The decimal module provides arithmetic with as much precision as needed:

    +
    >>> getcontext().prec = 36
    +>>> Decimal(1) / Decimal(7)
    +Decimal('0.142857142857142857142857142857142857')
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/tutorial/venv.html b/python-3.7.4-docs-html/tutorial/venv.html new file mode 100644 index 0000000..af53f43 --- /dev/null +++ b/python-3.7.4-docs-html/tutorial/venv.html @@ -0,0 +1,364 @@ + + + + + + + 12. Virtual Environments and Packages — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    12. Virtual Environments and Packages

    +
    +

    12.1. Introduction

    +

    Python applications will often use packages and modules that don’t +come as part of the standard library. Applications will sometimes +need a specific version of a library, because the application may +require that a particular bug has been fixed or the application may be +written using an obsolete version of the library’s interface.

    +

    This means it may not be possible for one Python installation to meet +the requirements of every application. If application A needs version +1.0 of a particular module but application B needs version 2.0, then +the requirements are in conflict and installing either version 1.0 or 2.0 +will leave one application unable to run.

    +

    The solution for this problem is to create a virtual environment, a +self-contained directory tree that contains a Python installation for a +particular version of Python, plus a number of additional packages.

    +

    Different applications can then use different virtual environments. +To resolve the earlier example of conflicting requirements, +application A can have its own virtual environment with version 1.0 +installed while application B has another virtual environment with version 2.0. +If application B requires a library be upgraded to version 3.0, this will +not affect application A’s environment.

    +
    +
    +

    12.2. Creating Virtual Environments

    +

    The module used to create and manage virtual environments is called +venv. venv will usually install the most recent version of +Python that you have available. If you have multiple versions of Python on your +system, you can select a specific Python version by running python3 or +whichever version you want.

    +

    To create a virtual environment, decide upon a directory where you want to +place it, and run the venv module as a script with the directory path:

    +
    python3 -m venv tutorial-env
    +
    +
    +

    This will create the tutorial-env directory if it doesn’t exist, +and also create directories inside it containing a copy of the Python +interpreter, the standard library, and various supporting files.

    +

    Once you’ve created a virtual environment, you may activate it.

    +

    On Windows, run:

    +
    tutorial-env\Scripts\activate.bat
    +
    +
    +

    On Unix or MacOS, run:

    +
    source tutorial-env/bin/activate
    +
    +
    +

    (This script is written for the bash shell. If you use the +csh or fish shells, there are alternate +activate.csh and activate.fish scripts you should use +instead.)

    +

    Activating the virtual environment will change your shell’s prompt to show what +virtual environment you’re using, and modify the environment so that running +python will get you that particular version and installation of Python. +For example:

    +
    $ source ~/envs/tutorial-env/bin/activate
    +(tutorial-env) $ python
    +Python 3.5.1 (default, May  6 2016, 10:59:36)
    +  ...
    +>>> import sys
    +>>> sys.path
    +['', '/usr/local/lib/python35.zip', ...,
    +'~/envs/tutorial-env/lib/python3.5/site-packages']
    +>>>
    +
    +
    +
    +
    +

    12.3. Managing Packages with pip

    +

    You can install, upgrade, and remove packages using a program called +pip. By default pip will install packages from the Python +Package Index, <https://pypi.org>. You can browse the Python +Package Index by going to it in your web browser, or you can use pip’s +limited search feature:

    +
    (tutorial-env) $ pip search astronomy
    +skyfield               - Elegant astronomy for Python
    +gary                   - Galactic astronomy and gravitational dynamics.
    +novas                  - The United States Naval Observatory NOVAS astronomy library
    +astroobs               - Provides astronomy ephemeris to plan telescope observations
    +PyAstronomy            - A collection of astronomy related tools for Python.
    +...
    +
    +
    +

    pip has a number of subcommands: “search”, “install”, “uninstall”, +“freeze”, etc. (Consult the Installing Python Modules guide for +complete documentation for pip.)

    +

    You can install the latest version of a package by specifying a package’s name:

    +
    (tutorial-env) $ pip install novas
    +Collecting novas
    +  Downloading novas-3.1.1.3.tar.gz (136kB)
    +Installing collected packages: novas
    +  Running setup.py install for novas
    +Successfully installed novas-3.1.1.3
    +
    +
    +

    You can also install a specific version of a package by giving the +package name followed by == and the version number:

    +
    (tutorial-env) $ pip install requests==2.6.0
    +Collecting requests==2.6.0
    +  Using cached requests-2.6.0-py2.py3-none-any.whl
    +Installing collected packages: requests
    +Successfully installed requests-2.6.0
    +
    +
    +

    If you re-run this command, pip will notice that the requested +version is already installed and do nothing. You can supply a +different version number to get that version, or you can run pip +install --upgrade to upgrade the package to the latest version:

    +
    (tutorial-env) $ pip install --upgrade requests
    +Collecting requests
    +Installing collected packages: requests
    +  Found existing installation: requests 2.6.0
    +    Uninstalling requests-2.6.0:
    +      Successfully uninstalled requests-2.6.0
    +Successfully installed requests-2.7.0
    +
    +
    +

    pip uninstall followed by one or more package names will remove the +packages from the virtual environment.

    +

    pip show will display information about a particular package:

    +
    (tutorial-env) $ pip show requests
    +---
    +Metadata-Version: 2.0
    +Name: requests
    +Version: 2.7.0
    +Summary: Python HTTP for Humans.
    +Home-page: http://python-requests.org
    +Author: Kenneth Reitz
    +Author-email: me@kennethreitz.com
    +License: Apache 2.0
    +Location: /Users/akuchling/envs/tutorial-env/lib/python3.4/site-packages
    +Requires:
    +
    +
    +

    pip list will display all of the packages installed in the virtual +environment:

    +
    (tutorial-env) $ pip list
    +novas (3.1.1.3)
    +numpy (1.9.2)
    +pip (7.0.3)
    +requests (2.7.0)
    +setuptools (16.0)
    +
    +
    +

    pip freeze will produce a similar list of the installed packages, +but the output uses the format that pip install expects. +A common convention is to put this list in a requirements.txt file:

    +
    (tutorial-env) $ pip freeze > requirements.txt
    +(tutorial-env) $ cat requirements.txt
    +novas==3.1.1.3
    +numpy==1.9.2
    +requests==2.7.0
    +
    +
    +

    The requirements.txt can then be committed to version control and +shipped as part of an application. Users can then install all the +necessary packages with install -r:

    +
    (tutorial-env) $ pip install -r requirements.txt
    +Collecting novas==3.1.1.3 (from -r requirements.txt (line 1))
    +  ...
    +Collecting numpy==1.9.2 (from -r requirements.txt (line 2))
    +  ...
    +Collecting requests==2.7.0 (from -r requirements.txt (line 3))
    +  ...
    +Installing collected packages: novas, numpy, requests
    +  Running setup.py install for novas
    +Successfully installed novas-3.1.1.3 numpy-1.9.2 requests-2.7.0
    +
    +
    +

    pip has many more options. Consult the Installing Python Modules +guide for complete documentation for pip. When you’ve written +a package and want to make it available on the Python Package Index, +consult the Distributing Python Modules guide.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/tutorial/whatnow.html b/python-3.7.4-docs-html/tutorial/whatnow.html new file mode 100644 index 0000000..cf5cde5 --- /dev/null +++ b/python-3.7.4-docs-html/tutorial/whatnow.html @@ -0,0 +1,243 @@ + + + + + + + 13. What Now? — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    13. What Now?

    +

    Reading this tutorial has probably reinforced your interest in using Python — +you should be eager to apply Python to solving your real-world problems. Where +should you go to learn more?

    +

    This tutorial is part of Python’s documentation set. Some other documents in +the set are:

    +
      +
    • The Python Standard Library:

      +

      You should browse through this manual, which gives complete (though terse) +reference material about types, functions, and the modules in the standard +library. The standard Python distribution includes a lot of additional code. +There are modules to read Unix mailboxes, retrieve documents via HTTP, generate +random numbers, parse command-line options, write CGI programs, compress data, +and many other tasks. Skimming through the Library Reference will give you an +idea of what’s available.

      +
    • +
    • Installing Python Modules explains how to install additional modules written +by other Python users.

    • +
    • The Python Language Reference: A detailed explanation of Python’s syntax and +semantics. It’s heavy reading, but is useful as a complete guide to the +language itself.

    • +
    +

    More Python resources:

    +
      +
    • https://www.python.org: The major Python Web site. It contains code, +documentation, and pointers to Python-related pages around the Web. This Web +site is mirrored in various places around the world, such as Europe, Japan, and +Australia; a mirror may be faster than the main site, depending on your +geographical location.

    • +
    • https://docs.python.org: Fast access to Python’s documentation.

    • +
    • https://pypi.org: The Python Package Index, previously also nicknamed +the Cheese Shop 1, is an index of user-created Python modules that are available +for download. Once you begin releasing code, you can register it here so that +others can find it.

    • +
    • https://code.activestate.com/recipes/langs/python/: The Python Cookbook is a +sizable collection of code examples, larger modules, and useful scripts. +Particularly notable contributions are collected in a book also titled Python +Cookbook (O’Reilly & Associates, ISBN 0-596-00797-3.)

    • +
    • http://www.pyvideo.org collects links to Python-related videos from +conferences and user-group meetings.

    • +
    • https://scipy.org: The Scientific Python project includes modules for fast +array computations and manipulations plus a host of packages for such +things as linear algebra, Fourier transforms, non-linear solvers, +random number distributions, statistical analysis and the like.

    • +
    +

    For Python-related questions and problem reports, you can post to the newsgroup +comp.lang.python, or send them to the mailing list at +python-list@python.org. The newsgroup and mailing list are gatewayed, so +messages posted to one will automatically be forwarded to the other. There are +hundreds of postings a day, asking (and +answering) questions, suggesting new features, and announcing new modules. +Mailing list archives are available at https://mail.python.org/pipermail/.

    +

    Before posting, be sure to check the list of +Frequently Asked Questions (also called the FAQ). The +FAQ answers many of the questions that come up again and again, and may +already contain the solution for your problem.

    +

    Footnotes

    +
    +
    1
    +

    “Cheese Shop” is a Monty Python’s sketch: a customer enters a cheese shop, +but whatever cheese he asks for, the clerk says it’s missing.

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/using/cmdline.html b/python-3.7.4-docs-html/using/cmdline.html new file mode 100644 index 0000000..0d59067 --- /dev/null +++ b/python-3.7.4-docs-html/using/cmdline.html @@ -0,0 +1,1124 @@ + + + + + + + 1. Command line and environment — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    1. Command line and environment

    +

    The CPython interpreter scans the command line and the environment for various +settings.

    +
    +

    CPython implementation detail: Other implementations’ command line schemes may differ. See +Alternate Implementations for further resources.

    +
    +
    +

    1.1. Command line

    +

    When invoking Python, you may specify any of these options:

    +
    python [-bBdEhiIOqsSuvVWx?] [-c command | -m module-name | script | - ] [args]
    +
    +
    +

    The most common use case is, of course, a simple invocation of a script:

    +
    python myscript.py
    +
    +
    +
    +

    1.1.1. Interface options

    +

    The interpreter interface resembles that of the UNIX shell, but provides some +additional methods of invocation:

    +
      +
    • When called with standard input connected to a tty device, it prompts for +commands and executes them until an EOF (an end-of-file character, you can +produce that with Ctrl-D on UNIX or Ctrl-Z, Enter on Windows) is read.

    • +
    • When called with a file name argument or with a file as standard input, it +reads and executes a script from that file.

    • +
    • When called with a directory name argument, it reads and executes an +appropriately named script from that directory.

    • +
    • When called with -c command, it executes the Python statement(s) given as +command. Here command may contain multiple statements separated by +newlines. Leading whitespace is significant in Python statements!

    • +
    • When called with -m module-name, the given module is located on the +Python module path and executed as a script.

    • +
    +

    In non-interactive mode, the entire input is parsed before it is executed.

    +

    An interface option terminates the list of options consumed by the interpreter, +all consecutive arguments will end up in sys.argv – note that the first +element, subscript zero (sys.argv[0]), is a string reflecting the program’s +source.

    +
    +
    +-c <command>
    +

    Execute the Python code in command. command can be one or more +statements separated by newlines, with significant leading whitespace as in +normal module code.

    +

    If this option is given, the first element of sys.argv will be +"-c" and the current directory will be added to the start of +sys.path (allowing modules in that directory to be imported as top +level modules).

    +
    + +
    +
    +-m <module-name>
    +

    Search sys.path for the named module and execute its contents as +the __main__ module.

    +

    Since the argument is a module name, you must not give a file extension +(.py). The module name should be a valid absolute Python module name, but +the implementation may not always enforce this (e.g. it may allow you to +use a name that includes a hyphen).

    +

    Package names (including namespace packages) are also permitted. When a +package name is supplied instead +of a normal module, the interpreter will execute <pkg>.__main__ as +the main module. This behaviour is deliberately similar to the handling +of directories and zipfiles that are passed to the interpreter as the +script argument.

    +
    +

    Note

    +

    This option cannot be used with built-in modules and extension modules +written in C, since they do not have Python module files. However, it +can still be used for precompiled modules, even if the original source +file is not available.

    +
    +

    If this option is given, the first element of sys.argv will be the +full path to the module file (while the module file is being located, the +first element will be set to "-m"). As with the -c option, +the current directory will be added to the start of sys.path.

    +

    Many standard library modules contain code that is invoked on their execution +as a script. An example is the timeit module:

    +
    python -mtimeit -s 'setup here' 'benchmarked code here'
    +python -mtimeit -h # for details
    +
    +
    +
    +

    See also

    +
    +
    runpy.run_module()

    Equivalent functionality directly available to Python code

    +
    +
    +

    PEP 338 – Executing modules as scripts

    +
    +
    +

    Changed in version 3.1: Supply the package name to run a __main__ submodule.

    +
    +
    +

    Changed in version 3.4: namespace packages are also supported

    +
    +
    + +
    +
    +-
    +

    Read commands from standard input (sys.stdin). If standard input is +a terminal, -i is implied.

    +

    If this option is given, the first element of sys.argv will be +"-" and the current directory will be added to the start of +sys.path.

    +
    + +
    +
    +<script>
    +

    Execute the Python code contained in script, which must be a filesystem +path (absolute or relative) referring to either a Python file, a directory +containing a __main__.py file, or a zipfile containing a +__main__.py file.

    +

    If this option is given, the first element of sys.argv will be the +script name as given on the command line.

    +

    If the script name refers directly to a Python file, the directory +containing that file is added to the start of sys.path, and the +file is executed as the __main__ module.

    +

    If the script name refers to a directory or zipfile, the script name is +added to the start of sys.path and the __main__.py file in +that location is executed as the __main__ module.

    +
    +

    See also

    +
    +
    runpy.run_path()

    Equivalent functionality directly available to Python code

    +
    +
    +
    +
    + +

    If no interface option is given, -i is implied, sys.argv[0] is +an empty string ("") and the current directory will be added to the +start of sys.path. Also, tab-completion and history editing is +automatically enabled, if available on your platform (see +Readline configuration).

    + +
    +

    Changed in version 3.4: Automatic enabling of tab-completion and history editing.

    +
    +
    +
    +

    1.1.2. Generic options

    +
    +
    +-?
    +
    +-h
    +
    +--help
    +

    Print a short description of all command line options.

    +
    + +
    +
    +-V
    +
    +--version
    +

    Print the Python version number and exit. Example output could be:

    +
    Python 3.7.0b2+
    +
    +
    +

    When given twice, print more information about the build, like:

    +
    Python 3.7.0b2+ (3.7:0c076caaa8, Sep 22 2018, 12:04:24)
    +[GCC 6.2.0 20161005]
    +
    +
    +
    +

    New in version 3.6: The -VV option.

    +
    +
    + +
    +
    +

    1.1.3. Miscellaneous options

    +
    +
    +-b
    +

    Issue a warning when comparing bytes or bytearray with +str or bytes with int. Issue an error when the +option is given twice (-bb).

    +
    +

    Changed in version 3.5: Affects comparisons of bytes with int.

    +
    +
    + +
    +
    +-B
    +

    If given, Python won’t try to write .pyc files on the +import of source modules. See also PYTHONDONTWRITEBYTECODE.

    +
    + +
    +
    +--check-hash-based-pycs default|always|never
    +

    Control the validation behavior of hash-based .pyc files. See +Cached bytecode invalidation. When set to default, checked and unchecked +hash-based bytecode cache files are validated according to their default +semantics. When set to always, all hash-based .pyc files, whether +checked or unchecked, are validated against their corresponding source +file. When set to never, hash-based .pyc files are not validated +against their corresponding source files.

    +

    The semantics of timestamp-based .pyc files are unaffected by this +option.

    +
    + +
    +
    +-d
    +

    Turn on parser debugging output (for expert only, depending on compilation +options). See also PYTHONDEBUG.

    +
    + +
    +
    +-E
    +

    Ignore all PYTHON* environment variables, e.g. +PYTHONPATH and PYTHONHOME, that might be set.

    +
    + +
    +
    +-i
    +

    When a script is passed as first argument or the -c option is used, +enter interactive mode after executing the script or the command, even when +sys.stdin does not appear to be a terminal. The +PYTHONSTARTUP file is not read.

    +

    This can be useful to inspect global variables or a stack trace when a script +raises an exception. See also PYTHONINSPECT.

    +
    + +
    +
    +-I
    +

    Run Python in isolated mode. This also implies -E and -s. +In isolated mode sys.path contains neither the script’s directory nor +the user’s site-packages directory. All PYTHON* environment +variables are ignored, too. Further restrictions may be imposed to prevent +the user from injecting malicious code.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +-O
    +

    Remove assert statements and any code conditional on the value of +__debug__. Augment the filename for compiled +(bytecode) files by adding .opt-1 before the .pyc +extension (see PEP 488). See also PYTHONOPTIMIZE.

    +
    +

    Changed in version 3.5: Modify .pyc filenames according to PEP 488.

    +
    +
    + +
    +
    +-OO
    +

    Do -O and also discard docstrings. Augment the filename +for compiled (bytecode) files by adding .opt-2 before the +.pyc extension (see PEP 488).

    +
    +

    Changed in version 3.5: Modify .pyc filenames according to PEP 488.

    +
    +
    + +
    +
    +-q
    +

    Don’t display the copyright and version messages even in interactive mode.

    +
    +

    New in version 3.2.

    +
    +
    + +
    +
    +-R
    +

    Turn on hash randomization. This option only has an effect if the +PYTHONHASHSEED environment variable is set to 0, since hash +randomization is enabled by default.

    +

    On previous versions of Python, this option turns on hash randomization, +so that the __hash__() values of str, bytes and datetime +are “salted” with an unpredictable random value. Although they remain +constant within an individual Python process, they are not predictable +between repeated invocations of Python.

    +

    Hash randomization is intended to provide protection against a +denial-of-service caused by carefully-chosen inputs that exploit the worst +case performance of a dict construction, O(n^2) complexity. See +http://www.ocert.org/advisories/ocert-2011-003.html for details.

    +

    PYTHONHASHSEED allows you to set a fixed value for the hash +seed secret.

    +
    +

    Changed in version 3.7: The option is no longer ignored.

    +
    +
    +

    New in version 3.2.3.

    +
    +
    + +
    +
    +-s
    +

    Don’t add the user site-packages directory to +sys.path.

    +
    +

    See also

    +

    PEP 370 – Per user site-packages directory

    +
    +
    + +
    +
    +-S
    +

    Disable the import of the module site and the site-dependent +manipulations of sys.path that it entails. Also disable these +manipulations if site is explicitly imported later (call +site.main() if you want them to be triggered).

    +
    + +
    +
    +-u
    +

    Force the stdout and stderr streams to be unbuffered. This option has no +effect on the stdin stream.

    +

    See also PYTHONUNBUFFERED.

    +
    +

    Changed in version 3.7: The text layer of the stdout and stderr streams now is unbuffered.

    +
    +
    + +
    +
    +-v
    +

    Print a message each time a module is initialized, showing the place +(filename or built-in module) from which it is loaded. When given twice +(-vv), print a message for each file that is checked for when +searching for a module. Also provides information on module cleanup at exit. +See also PYTHONVERBOSE.

    +
    + +
    +
    +-W arg
    +

    Warning control. Python’s warning machinery by default prints warning +messages to sys.stderr. A typical warning message has the following +form:

    +
    file:line: category: message
    +
    +
    +

    By default, each warning is printed once for each source line where it +occurs. This option controls how often warnings are printed.

    +

    Multiple -W options may be given; when a warning matches more than +one option, the action for the last matching option is performed. Invalid +-W options are ignored (though, a warning message is printed about +invalid options when the first warning is issued).

    +

    Warnings can also be controlled using the PYTHONWARNINGS +environment variable and from within a Python program using the +warnings module.

    +

    The simplest settings apply a particular action unconditionally to all +warnings emitted by a process (even those that are otherwise ignored by +default):

    +
    -Wdefault  # Warn once per call location
    +-Werror    # Convert to exceptions
    +-Walways   # Warn every time
    +-Wmodule   # Warn once per calling module
    +-Wonce     # Warn once per Python process
    +-Wignore   # Never warn
    +
    +
    +

    The action names can be abbreviated as desired (e.g. -Wi, -Wd, +-Wa, -We) and the interpreter will resolve them to the appropriate +action name.

    +

    See The Warnings Filter and Describing Warning Filters for more +details.

    +
    + +
    +
    +-x
    +

    Skip the first line of the source, allowing use of non-Unix forms of +#!cmd. This is intended for a DOS specific hack only.

    +
    + +
    +
    +-X
    +

    Reserved for various implementation-specific options. CPython currently +defines the following possible values:

    +
      +
    • -X faulthandler to enable faulthandler;

    • +
    • -X showrefcount to output the total reference count and number of used +memory blocks when the program finishes or after each statement in the +interactive interpreter. This only works on debug builds.

    • +
    • -X tracemalloc to start tracing Python memory allocations using the +tracemalloc module. By default, only the most recent frame is +stored in a traceback of a trace. Use -X tracemalloc=NFRAME to start +tracing with a traceback limit of NFRAME frames. See the +tracemalloc.start() for more information.

    • +
    • -X showalloccount to output the total count of allocated objects for +each type when the program finishes. This only works when Python was built with +COUNT_ALLOCS defined.

    • +
    • -X importtime to show how long each import takes. It shows module +name, cumulative time (including nested imports) and self time (excluding +nested imports). Note that its output may be broken in multi-threaded +application. Typical usage is python3 -X importtime -c 'import +asyncio'. See also PYTHONPROFILEIMPORTTIME.

    • +
    • -X dev: enable CPython’s “development mode”, introducing additional +runtime checks which are too expensive to be enabled by default. It should +not be more verbose than the default if the code is correct: new warnings +are only emitted when an issue is detected. Effect of the developer mode:

      + +
    • +
    • -X utf8 enables UTF-8 mode for operating system interfaces, overriding +the default locale-aware mode. -X utf8=0 explicitly disables UTF-8 +mode (even when it would otherwise activate automatically). +See PYTHONUTF8 for more details.

    • +
    +

    It also allows passing arbitrary values and retrieving them through the +sys._xoptions dictionary.

    +
    +

    Changed in version 3.2: The -X option was added.

    +
    +
    +

    New in version 3.3: The -X faulthandler option.

    +
    +
    +

    New in version 3.4: The -X showrefcount and -X tracemalloc options.

    +
    +
    +

    New in version 3.6: The -X showalloccount option.

    +
    +
    +

    New in version 3.7: The -X importtime, -X dev and -X utf8 options.

    +
    +
    + +
    +
    +

    1.1.4. Options you shouldn’t use

    +
    +
    +-J
    +

    Reserved for use by Jython.

    +
    + +
    +
    +
    +

    1.2. Environment variables

    +

    These environment variables influence Python’s behavior, they are processed +before the command-line switches other than -E or -I. It is customary that +command-line switches override environmental variables where there is a +conflict.

    +
    +
    +PYTHONHOME
    +

    Change the location of the standard Python libraries. By default, the +libraries are searched in prefix/lib/pythonversion and +exec_prefix/lib/pythonversion, where prefix and +exec_prefix are installation-dependent directories, both defaulting +to /usr/local.

    +

    When PYTHONHOME is set to a single directory, its value replaces +both prefix and exec_prefix. To specify different values +for these, set PYTHONHOME to prefix:exec_prefix.

    +
    + +
    +
    +PYTHONPATH
    +

    Augment the default search path for module files. The format is the same as +the shell’s PATH: one or more directory pathnames separated by +os.pathsep (e.g. colons on Unix or semicolons on Windows). +Non-existent directories are silently ignored.

    +

    In addition to normal directories, individual PYTHONPATH entries +may refer to zipfiles containing pure Python modules (in either source or +compiled form). Extension modules cannot be imported from zipfiles.

    +

    The default search path is installation dependent, but generally begins with +prefix/lib/pythonversion (see PYTHONHOME above). It +is always appended to PYTHONPATH.

    +

    An additional directory will be inserted in the search path in front of +PYTHONPATH as described above under +Interface options. The search path can be manipulated from +within a Python program as the variable sys.path.

    +
    + +
    +
    +PYTHONSTARTUP
    +

    If this is the name of a readable file, the Python commands in that file are +executed before the first prompt is displayed in interactive mode. The file +is executed in the same namespace where interactive commands are executed so +that objects defined or imported in it can be used without qualification in +the interactive session. You can also change the prompts sys.ps1 and +sys.ps2 and the hook sys.__interactivehook__ in this file.

    +
    + +
    +
    +PYTHONOPTIMIZE
    +

    If this is set to a non-empty string it is equivalent to specifying the +-O option. If set to an integer, it is equivalent to specifying +-O multiple times.

    +
    + +
    +
    +PYTHONBREAKPOINT
    +

    If this is set, it names a callable using dotted-path notation. The module +containing the callable will be imported and then the callable will be run +by the default implementation of sys.breakpointhook() which itself is +called by built-in breakpoint(). If not set, or set to the empty +string, it is equivalent to the value “pdb.set_trace”. Setting this to the +string “0” causes the default implementation of sys.breakpointhook() +to do nothing but return immediately.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +PYTHONDEBUG
    +

    If this is set to a non-empty string it is equivalent to specifying the +-d option. If set to an integer, it is equivalent to specifying +-d multiple times.

    +
    + +
    +
    +PYTHONINSPECT
    +

    If this is set to a non-empty string it is equivalent to specifying the +-i option.

    +

    This variable can also be modified by Python code using os.environ +to force inspect mode on program termination.

    +
    + +
    +
    +PYTHONUNBUFFERED
    +

    If this is set to a non-empty string it is equivalent to specifying the +-u option.

    +
    + +
    +
    +PYTHONVERBOSE
    +

    If this is set to a non-empty string it is equivalent to specifying the +-v option. If set to an integer, it is equivalent to specifying +-v multiple times.

    +
    + +
    +
    +PYTHONCASEOK
    +

    If this is set, Python ignores case in import statements. This +only works on Windows and OS X.

    +
    + +
    +
    +PYTHONDONTWRITEBYTECODE
    +

    If this is set to a non-empty string, Python won’t try to write .pyc +files on the import of source modules. This is equivalent to +specifying the -B option.

    +
    + +
    +
    +PYTHONHASHSEED
    +

    If this variable is not set or set to random, a random value is used +to seed the hashes of str, bytes and datetime objects.

    +

    If PYTHONHASHSEED is set to an integer value, it is used as a fixed +seed for generating the hash() of the types covered by the hash +randomization.

    +

    Its purpose is to allow repeatable hashing, such as for selftests for the +interpreter itself, or to allow a cluster of python processes to share hash +values.

    +

    The integer must be a decimal number in the range [0,4294967295]. Specifying +the value 0 will disable hash randomization.

    +
    +

    New in version 3.2.3.

    +
    +
    + +
    +
    +PYTHONIOENCODING
    +

    If this is set before running the interpreter, it overrides the encoding used +for stdin/stdout/stderr, in the syntax encodingname:errorhandler. Both +the encodingname and the :errorhandler parts are optional and have +the same meaning as in str.encode().

    +

    For stderr, the :errorhandler part is ignored; the handler will always be +'backslashreplace'.

    +
    +

    Changed in version 3.4: The encodingname part is now optional.

    +
    +
    +

    Changed in version 3.6: On Windows, the encoding specified by this variable is ignored for interactive +console buffers unless PYTHONLEGACYWINDOWSSTDIO is also specified. +Files and pipes redirected through the standard streams are not affected.

    +
    +
    + +
    +
    +PYTHONNOUSERSITE
    +

    If this is set, Python won’t add the user site-packages directory to sys.path.

    +
    +

    See also

    +

    PEP 370 – Per user site-packages directory

    +
    +
    + +
    +
    +PYTHONUSERBASE
    +

    Defines the user base directory, which is used to +compute the path of the user site-packages directory +and Distutils installation paths for +python setup.py install --user.

    +
    +

    See also

    +

    PEP 370 – Per user site-packages directory

    +
    +
    + +
    +
    +PYTHONEXECUTABLE
    +

    If this environment variable is set, sys.argv[0] will be set to its +value instead of the value got through the C runtime. Only works on +Mac OS X.

    +
    + +
    +
    +PYTHONWARNINGS
    +

    This is equivalent to the -W option. If set to a comma +separated string, it is equivalent to specifying -W multiple +times, with filters later in the list taking precedence over those earlier +in the list.

    +

    The simplest settings apply a particular action unconditionally to all +warnings emitted by a process (even those that are otherwise ignored by +default):

    +
    PYTHONWARNINGS=default  # Warn once per call location
    +PYTHONWARNINGS=error    # Convert to exceptions
    +PYTHONWARNINGS=always   # Warn every time
    +PYTHONWARNINGS=module   # Warn once per calling module
    +PYTHONWARNINGS=once     # Warn once per Python process
    +PYTHONWARNINGS=ignore   # Never warn
    +
    +
    +

    See The Warnings Filter and Describing Warning Filters for more +details.

    +
    + +
    +
    +PYTHONFAULTHANDLER
    +

    If this environment variable is set to a non-empty string, +faulthandler.enable() is called at startup: install a handler for +SIGSEGV, SIGFPE, SIGABRT, SIGBUS and +SIGILL signals to dump the Python traceback. This is equivalent to +-X faulthandler option.

    +
    +

    New in version 3.3.

    +
    +
    + +
    +
    +PYTHONTRACEMALLOC
    +

    If this environment variable is set to a non-empty string, start tracing +Python memory allocations using the tracemalloc module. The value of +the variable is the maximum number of frames stored in a traceback of a +trace. For example, PYTHONTRACEMALLOC=1 stores only the most recent +frame. See the tracemalloc.start() for more information.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +PYTHONPROFILEIMPORTTIME
    +

    If this environment variable is set to a non-empty string, Python will +show how long each import takes. This is exactly equivalent to setting +-X importtime on the command line.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +PYTHONASYNCIODEBUG
    +

    If this environment variable is set to a non-empty string, enable the +debug mode of the asyncio module.

    +
    +

    New in version 3.4.

    +
    +
    + +
    +
    +PYTHONMALLOC
    +

    Set the Python memory allocators and/or install debug hooks.

    +

    Set the family of memory allocators used by Python:

    + +

    Install debug hooks:

    +
      +
    • debug: install debug hooks on top of the default memory +allocators.

    • +
    • malloc_debug: same as malloc but also install debug hooks

    • +
    • pymalloc_debug: same as pymalloc but also install debug hooks

    • +
    +

    See the default memory allocators and the +PyMem_SetupDebugHooks() function (install debug hooks on Python +memory allocators).

    +
    +

    Changed in version 3.7: Added the "default" allocator.

    +
    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +PYTHONMALLOCSTATS
    +

    If set to a non-empty string, Python will print statistics of the +pymalloc memory allocator every time a new pymalloc object +arena is created, and on shutdown.

    +

    This variable is ignored if the PYTHONMALLOC environment variable +is used to force the malloc() allocator of the C library, or if +Python is configured without pymalloc support.

    +
    +

    Changed in version 3.6: This variable can now also be used on Python compiled in release mode. +It now has no effect if set to an empty string.

    +
    +
    + +
    +
    +PYTHONLEGACYWINDOWSFSENCODING
    +

    If set to a non-empty string, the default filesystem encoding and errors mode +will revert to their pre-3.6 values of ‘mbcs’ and ‘replace’, respectively. +Otherwise, the new defaults ‘utf-8’ and ‘surrogatepass’ are used.

    +

    This may also be enabled at runtime with +sys._enablelegacywindowsfsencoding().

    +

    Availability: Windows.

    +
    +

    New in version 3.6: See PEP 529 for more details.

    +
    +
    + +
    +
    +PYTHONLEGACYWINDOWSSTDIO
    +

    If set to a non-empty string, does not use the new console reader and +writer. This means that Unicode characters will be encoded according to +the active console code page, rather than using utf-8.

    +

    This variable is ignored if the standard streams are redirected (to files +or pipes) rather than referring to console buffers.

    +

    Availability: Windows.

    +
    +

    New in version 3.6.

    +
    +
    + +
    +
    +PYTHONCOERCECLOCALE
    +

    If set to the value 0, causes the main Python command line application +to skip coercing the legacy ASCII-based C and POSIX locales to a more +capable UTF-8 based alternative.

    +

    If this variable is not set (or is set to a value other than 0), the +LC_ALL locale override environment variable is also not set, and the +current locale reported for the LC_CTYPE category is either the default +C locale, or else the explicitly ASCII-based POSIX locale, then the +Python CLI will attempt to configure the following locales for the +LC_CTYPE category in the order listed before loading the interpreter +runtime:

    +
      +
    • C.UTF-8

    • +
    • C.utf8

    • +
    • UTF-8

    • +
    +

    If setting one of these locale categories succeeds, then the LC_CTYPE +environment variable will also be set accordingly in the current process +environment before the Python runtime is initialized. This ensures that in +addition to being seen by both the interpreter itself and other locale-aware +components running in the same process (such as the GNU readline +library), the updated setting is also seen in subprocesses (regardless of +whether or not those processes are running a Python interpreter), as well as +in operations that query the environment rather than the current C locale +(such as Python’s own locale.getdefaultlocale()).

    +

    Configuring one of these locales (either explicitly or via the above +implicit locale coercion) automatically enables the surrogateescape +error handler for sys.stdin and +sys.stdout (sys.stderr continues to use backslashreplace +as it does in any other locale). This stream handling behavior can be +overridden using PYTHONIOENCODING as usual.

    +

    For debugging purposes, setting PYTHONCOERCECLOCALE=warn will cause +Python to emit warning messages on stderr if either the locale coercion +activates, or else if a locale that would have triggered coercion is +still active when the Python runtime is initialized.

    +

    Also note that even when locale coercion is disabled, or when it fails to +find a suitable target locale, PYTHONUTF8 will still activate by +default in legacy ASCII-based locales. Both features must be disabled in +order to force the interpreter to use ASCII instead of UTF-8 for +system interfaces.

    +

    Availability: *nix.

    +
    +

    New in version 3.7: See PEP 538 for more details.

    +
    +
    + +
    +
    +PYTHONDEVMODE
    +

    If this environment variable is set to a non-empty string, enable the +CPython “development mode”. See the -X dev option.

    +
    +

    New in version 3.7.

    +
    +
    + +
    +
    +PYTHONUTF8
    +

    If set to 1, enables the interpreter’s UTF-8 mode, where UTF-8 is +used as the text encoding for system interfaces, regardless of the +current locale setting.

    +

    This means that:

    +
    +
    +
    +

    As a consequence of the changes in those lower level APIs, other higher +level APIs also exhibit different default behaviours:

    +
    +
      +
    • Command line arguments, environment variables and filenames are decoded +to text using the UTF-8 encoding.

    • +
    • os.fsdecode() and os.fsencode() use the UTF-8 encoding.

    • +
    • open(), io.open(), and codecs.open() use the UTF-8 +encoding by default. However, they still use the strict error handler by +default so that attempting to open a binary file in text mode is likely +to raise an exception rather than producing nonsense data.

    • +
    +
    +

    Note that the standard stream settings in UTF-8 mode can be overridden by +PYTHONIOENCODING (just as they can be in the default locale-aware +mode).

    +

    If set to 0, the interpreter runs in its default locale-aware mode.

    +

    Setting any other non-empty string causes an error during interpreter +initialisation.

    +

    If this environment variable is not set at all, then the interpreter defaults +to using the current locale settings, unless the current locale is +identified as a legacy ASCII-based locale +(as described for PYTHONCOERCECLOCALE), and locale coercion is +either disabled or fails. In such legacy locales, the interpreter will +default to enabling UTF-8 mode unless explicitly instructed not to do so.

    +

    Also available as the -X utf8 option.

    +

    Availability: *nix.

    +
    +

    New in version 3.7: See PEP 540 for more details.

    +
    +
    + +
    +

    1.2.1. Debug-mode variables

    +

    Setting these variables only has an effect in a debug build of Python, that is, +if Python was configured with the --with-pydebug build option.

    +
    +
    +PYTHONTHREADDEBUG
    +

    If set, Python will print threading debug info.

    +
    + +
    +
    +PYTHONDUMPREFS
    +

    If set, Python will dump objects and reference counts still alive after +shutting down the interpreter.

    +
    + +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/using/index.html b/python-3.7.4-docs-html/using/index.html new file mode 100644 index 0000000..846cce6 --- /dev/null +++ b/python-3.7.4-docs-html/using/index.html @@ -0,0 +1,281 @@ + + + + + + + Python Setup and Usage — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Python Setup and Usage

    +

    This part of the documentation is devoted to general information on the setup +of the Python environment on different platforms, the invocation of the +interpreter and things that make working with Python easier.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/using/mac.html b/python-3.7.4-docs-html/using/mac.html new file mode 100644 index 0000000..cbf0392 --- /dev/null +++ b/python-3.7.4-docs-html/using/mac.html @@ -0,0 +1,334 @@ + + + + + + + 4. Using Python on a Macintosh — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    4. Using Python on a Macintosh

    +
    +
    Author
    +

    Bob Savage <bobsavage@mac.com>

    +
    +
    +

    Python on a Macintosh running Mac OS X is in principle very similar to Python on +any other Unix platform, but there are a number of additional features such as +the IDE and the Package Manager that are worth pointing out.

    +
    +

    4.1. Getting and Installing MacPython

    +

    Mac OS X 10.8 comes with Python 2.7 pre-installed by Apple. If you wish, you +are invited to install the most recent version of Python 3 from the Python +website (https://www.python.org). A current “universal binary” build of Python, +which runs natively on the Mac’s new Intel and legacy PPC CPU’s, is available +there.

    +

    What you get after installing is a number of things:

    +
      +
    • A Python 3.7 folder in your Applications folder. In here +you find IDLE, the development environment that is a standard part of official +Python distributions; PythonLauncher, which handles double-clicking Python +scripts from the Finder; and the “Build Applet” tool, which allows you to +package Python scripts as standalone applications on your system.

    • +
    • A framework /Library/Frameworks/Python.framework, which includes the +Python executable and libraries. The installer adds this location to your shell +path. To uninstall MacPython, you can simply remove these three things. A +symlink to the Python executable is placed in /usr/local/bin/.

    • +
    +

    The Apple-provided build of Python is installed in +/System/Library/Frameworks/Python.framework and /usr/bin/python, +respectively. You should never modify or delete these, as they are +Apple-controlled and are used by Apple- or third-party software. Remember that +if you choose to install a newer Python version from python.org, you will have +two different but functional Python installations on your computer, so it will +be important that your paths and usages are consistent with what you want to do.

    +

    IDLE includes a help menu that allows you to access Python documentation. If you +are completely new to Python you should start reading the tutorial introduction +in that document.

    +

    If you are familiar with Python on other Unix platforms you should read the +section on running Python scripts from the Unix shell.

    +
    +

    4.1.1. How to run a Python script

    +

    Your best way to get started with Python on Mac OS X is through the IDLE +integrated development environment, see section The IDE and use the Help menu +when the IDE is running.

    +

    If you want to run Python scripts from the Terminal window command line or from +the Finder you first need an editor to create your script. Mac OS X comes with a +number of standard Unix command line editors, vim and +emacs among them. If you want a more Mac-like editor, +BBEdit or TextWrangler from Bare Bones Software (see +http://www.barebones.com/products/bbedit/index.html) are good choices, as is +TextMate (see https://macromates.com/). Other editors include +Gvim (http://macvim-dev.github.io/macvim/) and Aquamacs +(http://aquamacs.org/).

    +

    To run your script from the Terminal window you must make sure that +/usr/local/bin is in your shell search path.

    +

    To run your script from the Finder you have two options:

    +
      +
    • Drag it to PythonLauncher

    • +
    • Select PythonLauncher as the default application to open your +script (or any .py script) through the finder Info window and double-click it. +PythonLauncher has various preferences to control how your script is +launched. Option-dragging allows you to change these for one invocation, or use +its Preferences menu to change things globally.

    • +
    +
    +
    +

    4.1.2. Running scripts with a GUI

    +

    With older versions of Python, there is one Mac OS X quirk that you need to be +aware of: programs that talk to the Aqua window manager (in other words, +anything that has a GUI) need to be run in a special way. Use pythonw +instead of python to start such scripts.

    +

    With Python 3.7, you can use either python or pythonw.

    +
    +
    +

    4.1.3. Configuration

    +

    Python on OS X honors all standard Unix environment variables such as +PYTHONPATH, but setting these variables for programs started from the +Finder is non-standard as the Finder does not read your .profile or +.cshrc at startup. You need to create a file +~/.MacOSX/environment.plist. See Apple’s Technical Document QA1067 for +details.

    +

    For more information on installation Python packages in MacPython, see section +Installing Additional Python Packages.

    +
    +
    +
    +

    4.2. The IDE

    +

    MacPython ships with the standard IDLE development environment. A good +introduction to using IDLE can be found at +http://www.hashcollision.org/hkn/python/idle_intro/index.html.

    +
    +
    +

    4.3. Installing Additional Python Packages

    +

    There are several methods to install additional Python packages:

    +
      +
    • Packages can be installed via the standard Python distutils mode (python +setup.py install).

    • +
    • Many packages can also be installed via the setuptools extension +or pip wrapper, see https://pip.pypa.io/.

    • +
    +
    +
    +

    4.4. GUI Programming on the Mac

    +

    There are several options for building GUI applications on the Mac with Python.

    +

    PyObjC is a Python binding to Apple’s Objective-C/Cocoa framework, which is +the foundation of most modern Mac development. Information on PyObjC is +available from https://pypi.org/project/pyobjc/.

    +

    The standard Python GUI toolkit is tkinter, based on the cross-platform +Tk toolkit (https://www.tcl.tk). An Aqua-native version of Tk is bundled with OS +X by Apple, and the latest version can be downloaded and installed from +https://www.activestate.com; it can also be built from source.

    +

    wxPython is another popular cross-platform GUI toolkit that runs natively on +Mac OS X. Packages and documentation are available from https://www.wxpython.org.

    +

    PyQt is another popular cross-platform GUI toolkit that runs natively on Mac +OS X. More information can be found at +https://riverbankcomputing.com/software/pyqt/intro.

    +
    +
    +

    4.5. Distributing Python Applications on the Mac

    +

    The “Build Applet” tool that is placed in the MacPython 3.6 folder is fine for +packaging small Python scripts on your own machine to run as a standard Mac +application. This tool, however, is not robust enough to distribute Python +applications to other users.

    +

    The standard tool for deploying standalone Python applications on the Mac is +py2app. More information on installing and using py2app can be found +at http://undefined.org/python/#py2app.

    +
    +
    +

    4.6. Other Resources

    +

    The MacPython mailing list is an excellent support resource for Python users and +developers on the Mac:

    +

    https://www.python.org/community/sigs/current/pythonmac-sig/

    +

    Another useful resource is the MacPython wiki:

    +

    https://wiki.python.org/moin/MacPython

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/using/unix.html b/python-3.7.4-docs-html/using/unix.html new file mode 100644 index 0000000..933c678 --- /dev/null +++ b/python-3.7.4-docs-html/using/unix.html @@ -0,0 +1,333 @@ + + + + + + + 2. Using Python on Unix platforms — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    2. Using Python on Unix platforms

    +
    +

    2.1. Getting and installing the latest version of Python

    +
    +

    2.1.1. On Linux

    +

    Python comes preinstalled on most Linux distributions, and is available as a +package on all others. However there are certain features you might want to use +that are not available on your distro’s package. You can easily compile the +latest version of Python from source.

    +

    In the event that Python doesn’t come preinstalled and isn’t in the repositories as +well, you can easily make packages for your own distro. Have a look at the +following links:

    + +
    +
    +

    2.1.2. On FreeBSD and OpenBSD

    +
      +
    • FreeBSD users, to add the package use:

      +
      pkg install python3
      +
      +
      +
    • +
    • OpenBSD users, to add the package use:

      +
      pkg_add -r python
      +
      +pkg_add ftp://ftp.openbsd.org/pub/OpenBSD/4.2/packages/<insert your architecture here>/python-<version>.tgz
      +
      +
      +

      For example i386 users get the 2.5.1 version of Python using:

      +
      pkg_add ftp://ftp.openbsd.org/pub/OpenBSD/4.2/packages/i386/python-2.5.1p2.tgz
      +
      +
      +
    • +
    +
    +
    +

    2.1.3. On OpenSolaris

    +

    You can get Python from OpenCSW. Various versions +of Python are available and can be installed with e.g. pkgutil -i python27.

    +
    +
    +
    +

    2.2. Building Python

    +

    If you want to compile CPython yourself, first thing you should do is get the +source. You can download either the +latest release’s source or just grab a fresh clone. (If you want +to contribute patches, you will need a clone.)

    +

    The build process consists in the usual

    +
    ./configure
    +make
    +make install
    +
    +
    +

    invocations. Configuration options and caveats for specific Unix platforms are +extensively documented in the README.rst file in the root of the Python +source tree.

    +
    +

    Warning

    +

    make install can overwrite or masquerade the python3 binary. +make altinstall is therefore recommended instead of make install +since it only installs exec_prefix/bin/pythonversion.

    +
    +
    + +
    +

    2.4. Miscellaneous

    +

    To easily use Python scripts on Unix, you need to make them executable, +e.g. with

    +
    $ chmod +x script
    +
    +
    +

    and put an appropriate Shebang line at the top of the script. A good choice is +usually

    +
    #!/usr/bin/env python3
    +
    +
    +

    which searches for the Python interpreter in the whole PATH. However, +some Unices may not have the env command, so you may need to hardcode +/usr/bin/python3 as the interpreter path.

    +

    To use shell commands in your Python scripts, look at the subprocess module.

    +
    +
    +

    2.5. Editors and IDEs

    +

    There are a number of IDEs that support Python programming language. +Many editors and IDEs provide syntax highlighting, debugging tools, and PEP 8 checks.

    +

    Please go to Python Editors and +Integrated Development Environments +for a comprehensive list.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/using/windows.html b/python-3.7.4-docs-html/using/windows.html new file mode 100644 index 0000000..bf1520e --- /dev/null +++ b/python-3.7.4-docs-html/using/windows.html @@ -0,0 +1,1237 @@ + + + + + + + 3. Using Python on Windows — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    3. Using Python on Windows

    +

    This document aims to give an overview of Windows-specific behaviour you should +know about when using Python on Microsoft Windows.

    +

    Unlike most Unix systems and services, Windows does not include a system +supported installation of Python. To make Python available, the CPython team +has compiled Windows installers (MSI packages) with every release for many years. These installers +are primarily intended to add a per-user installation of Python, with the +core interpreter and library being used by a single user. The installer is also +able to install for all users of a single machine, and a separate ZIP file is +available for application-local distributions.

    +

    As specified in PEP 11, a Python release only supports a Windows platform +while Microsoft considers the platform under extended support. This means that +Python 3.7 supports Windows Vista and newer. If you require Windows XP +support then please install Python 3.4.

    +

    There are a number of different installers available for Windows, each with +certain benefits and downsides.

    +

    The full installer contains all components and is the best option for +developers using Python for any kind of project.

    +

    The Microsoft Store package is a simple installation of Python that is suitable for +running scripts and packages, and using IDLE or other development environments. +It requires Windows 10, but can be safely installed without corrupting other +programs. It also provides many convenient commands for launching Python and +its tools.

    +

    The nuget.org packages are lightweight installations intended for continuous +integration systems. It can be used to build Python packages or run scripts, +but is not updateable and has no user interface tools.

    +

    The embeddable package is a minimal package of Python suitable for +embedding into a larger application.

    +
    +

    3.1. The full installer

    +
    +

    3.1.1. Installation steps

    +

    Four Python 3.7 installers are available for download - two each for the +32-bit and 64-bit versions of the interpreter. The web installer is a small +initial download, and it will automatically download the required components as +necessary. The offline installer includes the components necessary for a +default installation and only requires an internet connection for optional +features. See Installing Without Downloading for other ways to avoid downloading +during installation.

    +

    After starting the installer, one of two options may be selected:

    +../_images/win_installer.png +

    If you select “Install Now”:

    +
      +
    • You will not need to be an administrator (unless a system update for the +C Runtime Library is required or you install the Python Launcher for Windows for all +users)

    • +
    • Python will be installed into your user directory

    • +
    • The Python Launcher for Windows will be installed according to the option at the bottom +of the first page

    • +
    • The standard library, test suite, launcher and pip will be installed

    • +
    • If selected, the install directory will be added to your PATH

    • +
    • Shortcuts will only be visible for the current user

    • +
    +

    Selecting “Customize installation” will allow you to select the features to +install, the installation location and other options or post-install actions. +To install debugging symbols or binaries, you will need to use this option.

    +

    To perform an all-users installation, you should select “Customize +installation”. In this case:

    +
      +
    • You may be required to provide administrative credentials or approval

    • +
    • Python will be installed into the Program Files directory

    • +
    • The Python Launcher for Windows will be installed into the Windows directory

    • +
    • Optional features may be selected during installation

    • +
    • The standard library can be pre-compiled to bytecode

    • +
    • If selected, the install directory will be added to the system PATH

    • +
    • Shortcuts are available for all users

    • +
    +
    +
    +

    3.1.2. Removing the MAX_PATH Limitation

    +

    Windows historically has limited path lengths to 260 characters. This meant that +paths longer than this would not resolve and errors would result.

    +

    In the latest versions of Windows, this limitation can be expanded to +approximately 32,000 characters. Your administrator will need to activate the +“Enable Win32 long paths” group policy, or set the registry value +HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem@LongPathsEnabled +to 1.

    +

    This allows the open() function, the os module and most other +path functionality to accept and return paths longer than 260 characters when +using strings. (Use of bytes as paths is deprecated on Windows, and this feature +is not available when using bytes.)

    +

    After changing the above option, no further configuration is required.

    +
    +

    Changed in version 3.6: Support for long paths was enabled in Python.

    +
    +
    +
    +

    3.1.3. Installing Without UI

    +

    All of the options available in the installer UI can also be specified from the +command line, allowing scripted installers to replicate an installation on many +machines without user interaction. These options may also be set without +suppressing the UI in order to change some of the defaults.

    +

    To completely hide the installer UI and install Python silently, pass the +/quiet option. To skip past the user interaction but still display +progress and errors, pass the /passive option. The /uninstall +option may be passed to immediately begin removing Python - no prompt will be +displayed.

    +

    All other options are passed as name=value, where the value is usually +0 to disable a feature, 1 to enable a feature, or a path. The full list +of available options is shown below.

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Name

    Description

    Default

    InstallAllUsers

    Perform a system-wide installation.

    0

    TargetDir

    The installation directory

    Selected based on +InstallAllUsers

    DefaultAllUsersTargetDir

    The default installation directory +for all-user installs

    %ProgramFiles%\Python X.Y or %ProgramFiles(x86)%\Python X.Y

    DefaultJustForMeTargetDir

    The default install directory for +just-for-me installs

    %LocalAppData%\Programs\PythonXY or +%LocalAppData%\Programs\PythonXY-32 or +%LocalAppData%\Programs\PythonXY-64

    DefaultCustomTargetDir

    The default custom install directory +displayed in the UI

    (empty)

    AssociateFiles

    Create file associations if the +launcher is also installed.

    1

    CompileAll

    Compile all .py files to +.pyc.

    0

    PrependPath

    Add install and Scripts directories +to PATH and .PY to +PATHEXT

    0

    Shortcuts

    Create shortcuts for the interpreter, +documentation and IDLE if installed.

    1

    Include_doc

    Install Python manual

    1

    Include_debug

    Install debug binaries

    0

    Include_dev

    Install developer headers and +libraries

    1

    Include_exe

    Install python.exe and +related files

    1

    Include_launcher

    Install Python Launcher for Windows.

    1

    InstallLauncherAllUsers

    Installs Python Launcher for Windows for all +users.

    1

    Include_lib

    Install standard library and +extension modules

    1

    Include_pip

    Install bundled pip and setuptools

    1

    Include_symbols

    Install debugging symbols (*.pdb)

    0

    Include_tcltk

    Install Tcl/Tk support and IDLE

    1

    Include_test

    Install standard library test suite

    1

    Include_tools

    Install utility scripts

    1

    LauncherOnly

    Only installs the launcher. This +will override most other options.

    0

    SimpleInstall

    Disable most install UI

    0

    SimpleInstallDescription

    A custom message to display when the +simplified install UI is used.

    (empty)

    +

    For example, to silently install a default, system-wide Python installation, +you could use the following command (from an elevated command prompt):

    +
    python-3.7.0.exe /quiet InstallAllUsers=1 PrependPath=1 Include_test=0
    +
    +
    +

    To allow users to easily install a personal copy of Python without the test +suite, you could provide a shortcut with the following command. This will +display a simplified initial page and disallow customization:

    +
    python-3.7.0.exe InstallAllUsers=0 Include_launcher=0 Include_test=0
    +    SimpleInstall=1 SimpleInstallDescription="Just for me, no test suite."
    +
    +
    +

    (Note that omitting the launcher also omits file associations, and is only +recommended for per-user installs when there is also a system-wide installation +that included the launcher.)

    +

    The options listed above can also be provided in a file named unattend.xml +alongside the executable. This file specifies a list of options and values. +When a value is provided as an attribute, it will be converted to a number if +possible. Values provided as element text are always left as strings. This +example file sets the same options as the previous example:

    +
    <Options>
    +    <Option Name="InstallAllUsers" Value="no" />
    +    <Option Name="Include_launcher" Value="0" />
    +    <Option Name="Include_test" Value="no" />
    +    <Option Name="SimpleInstall" Value="yes" />
    +    <Option Name="SimpleInstallDescription">Just for me, no test suite</Option>
    +</Options>
    +
    +
    +
    +
    +

    3.1.4. Installing Without Downloading

    +

    As some features of Python are not included in the initial installer download, +selecting those features may require an internet connection. To avoid this +need, all possible components may be downloaded on-demand to create a complete +layout that will no longer require an internet connection regardless of the +selected features. Note that this download may be bigger than required, but +where a large number of installations are going to be performed it is very +useful to have a locally cached copy.

    +

    Execute the following command from Command Prompt to download all possible +required files. Remember to substitute python-3.7.0.exe for the actual +name of your installer, and to create layouts in their own directories to +avoid collisions between files with the same name.

    +
    python-3.7.0.exe /layout [optional target directory]
    +
    +
    +

    You may also specify the /quiet option to hide the progress display.

    +
    +
    +

    3.1.5. Modifying an install

    +

    Once Python has been installed, you can add or remove features through the +Programs and Features tool that is part of Windows. Select the Python entry and +choose “Uninstall/Change” to open the installer in maintenance mode.

    +

    “Modify” allows you to add or remove features by modifying the checkboxes - +unchanged checkboxes will not install or remove anything. Some options cannot be +changed in this mode, such as the install directory; to modify these, you will +need to remove and then reinstall Python completely.

    +

    “Repair” will verify all the files that should be installed using the current +settings and replace any that have been removed or modified.

    +

    “Uninstall” will remove Python entirely, with the exception of the +Python Launcher for Windows, which has its own entry in Programs and Features.

    +
    +
    +
    +

    3.2. The Microsoft Store package

    +
    +

    New in version 3.7.2.

    +
    +
    +

    Note

    +

    The Microsoft Store package is currently considered unstable while its +interactions with other tools and other copies of Python are evaluated. +While Python itself is stable, this installation method may change its +behavior and capabilities during Python 3.7 releases.

    +
    +

    The Microsoft Store package is an easily installable Python interpreter that +is intended mainly for interactive use, for example, by students.

    +

    To install the package, ensure you have the latest Windows 10 updates and +search the Microsoft Store app for “Python 3.7”. Ensure that the app +you select is published by the Python Software Foundation, and install it.

    +
    +

    Warning

    +

    Python will always be available for free on the Microsoft Store. If you +are asked to pay for it, you have not selected the correct package.

    +
    +

    After installation, Python may be launched by finding it in Start. +Alternatively, it will be available from any Command Prompt or PowerShell +session by typing python. Further, pip and IDLE may be used by typing +pip or idle. IDLE can also be found in Start.

    +

    All three commands are also available with version number suffixes, for +example, as python3.exe and python3.x.exe as well as +python.exe (where 3.x is the specific version you want to launch, +such as 3.7).

    +

    Virtual environments can be created with python -m venv and activated +and used as normal.

    +

    If you have installed another version of Python and added it to your +PATH variable, it will be available as python.exe rather than the +one from the Microsoft Store. To access the new installation, use +python3.exe or python3.x.exe.

    +

    To remove Python, open Settings and use Apps and Features, or else find +Python in Start and right-click to select Uninstall. Uninstalling will +remove all packages you installed directly into this Python installation, but +will not remove any virtual environments

    +
    +

    3.2.1. Known Issues

    +

    Currently, the py.exe launcher cannot be used to start Python when it +has been installed from the Microsoft Store.

    +

    Because of restrictions on Microsoft Store apps, Python scripts may not have +full write access to shared locations such as TEMP and the registry. +Instead, it will write to a private copy. If your scripts must modify the +shared locations, you will need to install the full installer.

    +
    +
    +
    +

    3.3. The nuget.org packages

    +
    +

    New in version 3.5.2.

    +
    +

    The nuget.org package is a reduced size Python environment intended for use on +continuous integration and build systems that do not have a system-wide +install of Python. While nuget is “the package manager for .NET”, it also works +perfectly fine for packages containing build-time tools.

    +

    Visit nuget.org for the most up-to-date information +on using nuget. What follows is a summary that is sufficient for Python +developers.

    +

    The nuget.exe command line tool may be downloaded directly from +https://aka.ms/nugetclidl, for example, using curl or PowerShell. With the +tool, the latest version of Python for 64-bit or 32-bit machines is installed +using:

    +
    nuget.exe install python -ExcludeVersion -OutputDirectory .
    +nuget.exe install pythonx86 -ExcludeVersion -OutputDirectory .
    +
    +
    +

    To select a particular version, add a -Version 3.x.y. The output directory +may be changed from ., and the package will be installed into a +subdirectory. By default, the subdirectory is named the same as the package, +and without the -ExcludeVersion option this name will include the specific +version installed. Inside the subdirectory is a tools directory that +contains the Python installation:

    +
    # Without -ExcludeVersion
    +> .\python.3.5.2\tools\python.exe -V
    +Python 3.5.2
    +
    +# With -ExcludeVersion
    +> .\python\tools\python.exe -V
    +Python 3.5.2
    +
    +
    +

    In general, nuget packages are not upgradeable, and newer versions should be +installed side-by-side and referenced using the full path. Alternatively, +delete the package directory manually and install it again. Many CI systems +will do this automatically if they do not preserve files between builds.

    +

    Alongside the tools directory is a build\native directory. This +contains a MSBuild properties file python.props that can be used in a +C++ project to reference the Python install. Including the settings will +automatically use the headers and import libraries in your build.

    +

    The package information pages on nuget.org are +www.nuget.org/packages/python +for the 64-bit version and www.nuget.org/packages/pythonx86 for the 32-bit version.

    +
    +
    +

    3.4. The embeddable package

    +
    +

    New in version 3.5.

    +
    +

    The embedded distribution is a ZIP file containing a minimal Python environment. +It is intended for acting as part of another application, rather than being +directly accessed by end-users.

    +

    When extracted, the embedded distribution is (almost) fully isolated from the +user’s system, including environment variables, system registry settings, and +installed packages. The standard library is included as pre-compiled and +optimized .pyc files in a ZIP, and python3.dll, python37.dll, +python.exe and pythonw.exe are all provided. Tcl/tk (including all +dependants, such as Idle), pip and the Python documentation are not included.

    +
    +

    Note

    +

    The embedded distribution does not include the Microsoft C Runtime and it is +the responsibility of the application installer to provide this. The +runtime may have already been installed on a user’s system previously or +automatically via Windows Update, and can be detected by finding +ucrtbase.dll in the system directory.

    +
    +

    Third-party packages should be installed by the application installer alongside +the embedded distribution. Using pip to manage dependencies as for a regular +Python installation is not supported with this distribution, though with some +care it may be possible to include and use pip for automatic updates. In +general, third-party packages should be treated as part of the application +(“vendoring”) so that the developer can ensure compatibility with newer +versions before providing updates to users.

    +

    The two recommended use cases for this distribution are described below.

    +
    +

    3.4.1. Python Application

    +

    An application written in Python does not necessarily require users to be aware +of that fact. The embedded distribution may be used in this case to include a +private version of Python in an install package. Depending on how transparent it +should be (or conversely, how professional it should appear), there are two +options.

    +

    Using a specialized executable as a launcher requires some coding, but provides +the most transparent experience for users. With a customized launcher, there are +no obvious indications that the program is running on Python: icons can be +customized, company and version information can be specified, and file +associations behave properly. In most cases, a custom launcher should simply be +able to call Py_Main with a hard-coded command line.

    +

    The simpler approach is to provide a batch file or generated shortcut that +directly calls the python.exe or pythonw.exe with the required +command-line arguments. In this case, the application will appear to be Python +and not its actual name, and users may have trouble distinguishing it from other +running Python processes or file associations.

    +

    With the latter approach, packages should be installed as directories alongside +the Python executable to ensure they are available on the path. With the +specialized launcher, packages can be located in other locations as there is an +opportunity to specify the search path before launching the application.

    +
    +
    +

    3.4.2. Embedding Python

    +

    Applications written in native code often require some form of scripting +language, and the embedded Python distribution can be used for this purpose. In +general, the majority of the application is in native code, and some part will +either invoke python.exe or directly use python3.dll. For either case, +extracting the embedded distribution to a subdirectory of the application +installation is sufficient to provide a loadable Python interpreter.

    +

    As with the application use, packages can be installed to any location as there +is an opportunity to specify search paths before initializing the interpreter. +Otherwise, there is no fundamental differences between using the embedded +distribution and a regular installation.

    +
    +
    +
    +

    3.5. Alternative bundles

    +

    Besides the standard CPython distribution, there are modified packages including +additional functionality. The following is a list of popular versions and their +key features:

    +
    +
    ActivePython

    Installer with multi-platform compatibility, documentation, PyWin32

    +
    +
    Anaconda

    Popular scientific modules (such as numpy, scipy and pandas) and the +conda package manager.

    +
    +
    Canopy

    A “comprehensive Python analysis environment” with editors and other +development tools.

    +
    +
    WinPython

    Windows-specific distribution with prebuilt scientific packages and +tools for building packages.

    +
    +
    +

    Note that these packages may not include the latest versions of Python or +other libraries, and are not maintained or supported by the core Python team.

    +
    +
    +

    3.6. Configuring Python

    +

    To run Python conveniently from a command prompt, you might consider changing +some default environment variables in Windows. While the installer provides an +option to configure the PATH and PATHEXT variables for you, this is only +reliable for a single, system-wide installation. If you regularly use multiple +versions of Python, consider using the Python Launcher for Windows.

    +
    +

    3.6.1. Excursus: Setting environment variables

    +

    Windows allows environment variables to be configured permanently at both the +User level and the System level, or temporarily in a command prompt.

    +

    To temporarily set environment variables, open Command Prompt and use the +set command:

    +
    C:\>set PATH=C:\Program Files\Python 3.7;%PATH%
    +C:\>set PYTHONPATH=%PYTHONPATH%;C:\My_python_lib
    +C:\>python
    +
    +
    +

    These changes will apply to any further commands executed in that console, and +will be inherited by any applications started from the console.

    +

    Including the variable name within percent signs will expand to the existing +value, allowing you to add your new value at either the start or the end. +Modifying PATH by adding the directory containing +python.exe to the start is a common way to ensure the correct version +of Python is launched.

    +

    To permanently modify the default environment variables, click Start and search +for ‘edit environment variables’, or open System properties, Advanced +system settings and click the Environment Variables button. +In this dialog, you can add or modify User and System variables. To change +System variables, you need non-restricted access to your machine +(i.e. Administrator rights).

    +
    +

    Note

    +

    Windows will concatenate User variables after System variables, which may +cause unexpected results when modifying PATH.

    +

    The PYTHONPATH variable is used by all versions of Python 2 and +Python 3, so you should not permanently configure this variable unless it +only includes code that is compatible with all of your installed Python +versions.

    +
    +
    +

    See also

    +
    +
    https://www.microsoft.com/en-us/wdsi/help/folder-variables

    Environment variables in Windows NT

    +
    +
    https://technet.microsoft.com/en-us/library/cc754250.aspx

    The SET command, for temporarily modifying environment variables

    +
    +
    https://technet.microsoft.com/en-us/library/cc755104.aspx

    The SETX command, for permanently modifying environment variables

    +
    +
    https://support.microsoft.com/en-us/help/310519/how-to-manage-environment-variables-in-windows-xp

    How To Manage Environment Variables in Windows XP

    +
    +
    https://www.chem.gla.ac.uk/~louis/software/faq/q1.html

    Setting Environment variables, Louis J. Farrugia

    +
    +
    +
    +
    +
    +

    3.6.2. Finding the Python executable

    +
    +

    Changed in version 3.5.

    +
    +

    Besides using the automatically created start menu entry for the Python +interpreter, you might want to start Python in the command prompt. The +installer has an option to set that up for you.

    +

    On the first page of the installer, an option labelled “Add Python to PATH” +may be selected to have the installer add the install location into the +PATH. The location of the Scripts\ folder is also added. +This allows you to type python to run the interpreter, and +pip for the package installer. Thus, you can also execute your +scripts with command line options, see Command line documentation.

    +

    If you don’t enable this option at install time, you can always re-run the +installer, select Modify, and enable it. Alternatively, you can manually +modify the PATH using the directions in Excursus: Setting environment variables. You +need to set your PATH environment variable to include the directory +of your Python installation, delimited by a semicolon from other entries. An +example variable could look like this (assuming the first two entries already +existed):

    +
    C:\WINDOWS\system32;C:\WINDOWS;C:\Program Files\Python 3.7
    +
    +
    +
    +
    +
    +

    3.7. Python Launcher for Windows

    +
    +

    New in version 3.3.

    +
    +

    The Python launcher for Windows is a utility which aids in locating and +executing of different Python versions. It allows scripts (or the +command-line) to indicate a preference for a specific Python version, and +will locate and execute that version.

    +

    Unlike the PATH variable, the launcher will correctly select the most +appropriate version of Python. It will prefer per-user installations over +system-wide ones, and orders by language version rather than using the most +recently installed version.

    +

    The launcher was originally specified in PEP 397.

    +
    +

    3.7.1. Getting started

    +
    +

    3.7.1.1. From the command-line

    +
    +

    Changed in version 3.6.

    +
    +

    System-wide installations of Python 3.3 and later will put the launcher on your +PATH. The launcher is compatible with all available versions of +Python, so it does not matter which version is installed. To check that the +launcher is available, execute the following command in Command Prompt:

    +
    py
    +
    +
    +

    You should find that the latest version of Python you have installed is +started - it can be exited as normal, and any additional command-line +arguments specified will be sent directly to Python.

    +

    If you have multiple versions of Python installed (e.g., 2.7 and 3.7) you +will have noticed that Python 3.7 was started - to launch Python 2.7, try +the command:

    +
    py -2.7
    +
    +
    +

    If you want the latest version of Python 2.x you have installed, try the +command:

    +
    py -2
    +
    +
    +

    You should find the latest version of Python 2.x starts.

    +

    If you see the following error, you do not have the launcher installed:

    +
    'py' is not recognized as an internal or external command,
    +operable program or batch file.
    +
    +
    +

    Per-user installations of Python do not add the launcher to PATH +unless the option was selected on installation.

    +
    +
    +

    3.7.1.2. Virtual environments

    +
    +

    New in version 3.5.

    +
    +

    If the launcher is run with no explicit Python version specification, and a +virtual environment (created with the standard library venv module or +the external virtualenv tool) active, the launcher will run the virtual +environment’s interpreter rather than the global one. To run the global +interpreter, either deactivate the virtual environment, or explicitly specify +the global Python version.

    +
    +
    +

    3.7.1.3. From a script

    +

    Let’s create a test Python script - create a file called hello.py with the +following contents

    +
    #! python
    +import sys
    +sys.stdout.write("hello from Python %s\n" % (sys.version,))
    +
    +
    +

    From the directory in which hello.py lives, execute the command:

    +
    py hello.py
    +
    +
    +

    You should notice the version number of your latest Python 2.x installation +is printed. Now try changing the first line to be:

    +
    #! python3
    +
    +
    +

    Re-executing the command should now print the latest Python 3.x information. +As with the above command-line examples, you can specify a more explicit +version qualifier. Assuming you have Python 2.6 installed, try changing the +first line to #! python2.6 and you should find the 2.6 version +information printed.

    +

    Note that unlike interactive use, a bare “python” will use the latest +version of Python 2.x that you have installed. This is for backward +compatibility and for compatibility with Unix, where the command python +typically refers to Python 2.

    +
    +
    +

    3.7.1.4. From file associations

    +

    The launcher should have been associated with Python files (i.e. .py, +.pyw, .pyc files) when it was installed. This means that +when you double-click on one of these files from Windows explorer the launcher +will be used, and therefore you can use the same facilities described above to +have the script specify the version which should be used.

    +

    The key benefit of this is that a single launcher can support multiple Python +versions at the same time depending on the contents of the first line.

    +
    +
    +
    +

    3.7.2. Shebang Lines

    +

    If the first line of a script file starts with #!, it is known as a +“shebang” line. Linux and other Unix like operating systems have native +support for such lines and they are commonly used on such systems to indicate +how a script should be executed. This launcher allows the same facilities to +be used with Python scripts on Windows and the examples above demonstrate their +use.

    +

    To allow shebang lines in Python scripts to be portable between Unix and +Windows, this launcher supports a number of ‘virtual’ commands to specify +which interpreter to use. The supported virtual commands are:

    +
      +
    • /usr/bin/env python

    • +
    • /usr/bin/python

    • +
    • /usr/local/bin/python

    • +
    • python

    • +
    +

    For example, if the first line of your script starts with

    +
    #! /usr/bin/python
    +
    +
    +

    The default Python will be located and used. As many Python scripts written +to work on Unix will already have this line, you should find these scripts can +be used by the launcher without modification. If you are writing a new script +on Windows which you hope will be useful on Unix, you should use one of the +shebang lines starting with /usr.

    +

    Any of the above virtual commands can be suffixed with an explicit version +(either just the major version, or the major and minor version). +Furthermore the 32-bit version can be requested by adding “-32” after the +minor version. I.e. /usr/bin/python2.7-32 will request usage of the +32-bit python 2.7.

    +
    +

    New in version 3.7: Beginning with python launcher 3.7 it is possible to request 64-bit version +by the “-64” suffix. Furthermore it is possible to specify a major and +architecture without minor (i.e. /usr/bin/python3-64).

    +
    +

    The /usr/bin/env form of shebang line has one further special property. +Before looking for installed Python interpreters, this form will search the +executable PATH for a Python executable. This corresponds to the +behaviour of the Unix env program, which performs a PATH search.

    +
    +
    +

    3.7.3. Arguments in shebang lines

    +

    The shebang lines can also specify additional options to be passed to the +Python interpreter. For example, if you have a shebang line:

    +
    #! /usr/bin/python -v
    +
    +
    +

    Then Python will be started with the -v option

    +
    +
    +

    3.7.4. Customization

    +
    +

    3.7.4.1. Customization via INI files

    +

    Two .ini files will be searched by the launcher - py.ini in the current +user’s “application data” directory (i.e. the directory returned by calling the +Windows function SHGetFolderPath with CSIDL_LOCAL_APPDATA) and py.ini in the +same directory as the launcher. The same .ini files are used for both the +‘console’ version of the launcher (i.e. py.exe) and for the ‘windows’ version +(i.e. pyw.exe).

    +

    Customization specified in the “application directory” will have precedence over +the one next to the executable, so a user, who may not have write access to the +.ini file next to the launcher, can override commands in that global .ini file.

    +
    +
    +

    3.7.4.2. Customizing default Python versions

    +

    In some cases, a version qualifier can be included in a command to dictate +which version of Python will be used by the command. A version qualifier +starts with a major version number and can optionally be followed by a period +(‘.’) and a minor version specifier. Furthermore it is possible to specifiy +if a 32 or 64 bit implementation shall be requested by adding “-32” or “-64”.

    +

    For example, a shebang line of #!python has no version qualifier, while +#!python3 has a version qualifier which specifies only a major version.

    +

    If no version qualifiers are found in a command, the environment +variable PY_PYTHON can be set to specify the default version +qualifier. If it is not set, the default is “3”. The variable can +specify any value that may be passed on the command line, such as “3”, +“3.7”, “3.7-32” or “3.7-64”. (Note that the “-64” option is only +available with the launcher included with Python 3.7 or newer.)

    +

    If no minor version qualifiers are found, the environment variable +PY_PYTHON{major} (where {major} is the current major version qualifier +as determined above) can be set to specify the full version. If no such option +is found, the launcher will enumerate the installed Python versions and use +the latest minor release found for the major version, which is likely, +although not guaranteed, to be the most recently installed version in that +family.

    +

    On 64-bit Windows with both 32-bit and 64-bit implementations of the same +(major.minor) Python version installed, the 64-bit version will always be +preferred. This will be true for both 32-bit and 64-bit implementations of the +launcher - a 32-bit launcher will prefer to execute a 64-bit Python installation +of the specified version if available. This is so the behavior of the launcher +can be predicted knowing only what versions are installed on the PC and +without regard to the order in which they were installed (i.e., without knowing +whether a 32 or 64-bit version of Python and corresponding launcher was +installed last). As noted above, an optional “-32” or “-64” suffix can be +used on a version specifier to change this behaviour.

    +

    Examples:

    +
      +
    • If no relevant options are set, the commands python and +python2 will use the latest Python 2.x version installed and +the command python3 will use the latest Python 3.x installed.

    • +
    • The commands python3.1 and python2.7 will not consult any +options at all as the versions are fully specified.

    • +
    • If PY_PYTHON=3, the commands python and python3 will both use +the latest installed Python 3 version.

    • +
    • If PY_PYTHON=3.1-32, the command python will use the 32-bit +implementation of 3.1 whereas the command python3 will use the latest +installed Python (PY_PYTHON was not considered at all as a major +version was specified.)

    • +
    • If PY_PYTHON=3 and PY_PYTHON3=3.1, the commands +python and python3 will both use specifically 3.1

    • +
    +

    In addition to environment variables, the same settings can be configured +in the .INI file used by the launcher. The section in the INI file is +called [defaults] and the key name will be the same as the +environment variables without the leading PY_ prefix (and note that +the key names in the INI file are case insensitive.) The contents of +an environment variable will override things specified in the INI file.

    +

    For example:

    +
      +
    • Setting PY_PYTHON=3.1 is equivalent to the INI file containing:

    • +
    +
    [defaults]
    +python=3.1
    +
    +
    +
      +
    • Setting PY_PYTHON=3 and PY_PYTHON3=3.1 is equivalent to the INI file +containing:

    • +
    +
    [defaults]
    +python=3
    +python3=3.1
    +
    +
    +
    +
    +
    +

    3.7.5. Diagnostics

    +

    If an environment variable PYLAUNCH_DEBUG is set (to any value), the +launcher will print diagnostic information to stderr (i.e. to the console). +While this information manages to be simultaneously verbose and terse, it +should allow you to see what versions of Python were located, why a +particular version was chosen and the exact command-line used to execute the +target Python.

    +
    +
    +
    +

    3.8. Finding modules

    +

    Python usually stores its library (and thereby your site-packages folder) in the +installation directory. So, if you had installed Python to +C:\Python\, the default library would reside in +C:\Python\Lib\ and third-party modules should be stored in +C:\Python\Lib\site-packages\.

    +

    To completely override sys.path, create a ._pth file with the same +name as the DLL (python37._pth) or the executable (python._pth) and +specify one line for each path to add to sys.path. The file based on the +DLL name overrides the one based on the executable, which allows paths to be +restricted for any program loading the runtime if desired.

    +

    When the file exists, all registry and environment variables are ignored, +isolated mode is enabled, and site is not imported unless one line in the +file specifies import site. Blank paths and lines starting with # are +ignored. Each path may be absolute or relative to the location of the file. +Import statements other than to site are not permitted, and arbitrary code +cannot be specified.

    +

    Note that .pth files (without leading underscore) will be processed normally +by the site module when import site has been specified.

    +

    When no ._pth file is found, this is how sys.path is populated on +Windows:

    +
      +
    • An empty entry is added at the start, which corresponds to the current +directory.

    • +
    • If the environment variable PYTHONPATH exists, as described in +Environment variables, its entries are added next. Note that on Windows, +paths in this variable must be separated by semicolons, to distinguish them +from the colon used in drive identifiers (C:\ etc.).

    • +
    • Additional “application paths” can be added in the registry as subkeys of +\SOFTWARE\Python\PythonCore{version}\PythonPath under both the +HKEY_CURRENT_USER and HKEY_LOCAL_MACHINE hives. Subkeys which have +semicolon-delimited path strings as their default value will cause each path +to be added to sys.path. (Note that all known installers only use +HKLM, so HKCU is typically empty.)

    • +
    • If the environment variable PYTHONHOME is set, it is assumed as +“Python Home”. Otherwise, the path of the main Python executable is used to +locate a “landmark file” (either Lib\os.py or pythonXY.zip) to deduce +the “Python Home”. If a Python home is found, the relevant sub-directories +added to sys.path (Lib, plat-win, etc) are based on that +folder. Otherwise, the core Python path is constructed from the PythonPath +stored in the registry.

    • +
    • If the Python Home cannot be located, no PYTHONPATH is specified in +the environment, and no registry entries can be found, a default path with +relative entries is used (e.g. .\Lib;.\plat-win, etc).

    • +
    +

    If a pyvenv.cfg file is found alongside the main executable or in the +directory one level above the executable, the following variations apply:

    +
      +
    • If home is an absolute path and PYTHONHOME is not set, this +path is used instead of the path to the main executable when deducing the +home location.

    • +
    +

    The end result of all this is:

    +
      +
    • When running python.exe, or any other .exe in the main Python +directory (either an installed version, or directly from the PCbuild +directory), the core path is deduced, and the core paths in the registry are +ignored. Other “application paths” in the registry are always read.

    • +
    • When Python is hosted in another .exe (different directory, embedded via COM, +etc), the “Python Home” will not be deduced, so the core path from the +registry is used. Other “application paths” in the registry are always read.

    • +
    • If Python can’t find its home and there are no registry value (frozen .exe, +some very strange installation setup) you get a path with some default, but +relative, paths.

    • +
    +

    For those who want to bundle Python into their application or distribution, the +following advice will prevent conflicts with other installations:

    +
      +
    • Include a ._pth file alongside your executable containing the +directories to include. This will ignore paths listed in the registry and +environment variables, and also ignore site unless import site is +listed.

    • +
    • If you are loading python3.dll or python37.dll in your own +executable, explicitly call Py_SetPath() or (at least) +Py_SetProgramName() before Py_Initialize().

    • +
    • Clear and/or overwrite PYTHONPATH and set PYTHONHOME +before launching python.exe from your application.

    • +
    • If you cannot use the previous suggestions (for example, you are a +distribution that allows people to run python.exe directly), ensure +that the landmark file (Lib\os.py) exists in your install directory. +(Note that it will not be detected inside a ZIP file, but a correctly named +ZIP file will be detected instead.)

    • +
    +

    These will ensure that the files in a system-wide installation will not take +precedence over the copy of the standard library bundled with your application. +Otherwise, your users may experience problems using your application. Note that +the first suggestion is the best, as the others may still be susceptible to +non-standard paths in the registry and user site-packages.

    +
    +
    +
    Changed in version 3.6:
      +
    • Adds ._pth file support and removes applocal option from +pyvenv.cfg.

    • +
    • Adds pythonXX.zip as a potential landmark when directly adjacent +to the executable.

    • +
    +
    +
    +
    +
    +
    Deprecated since version 3.6:

    Modules specified in the registry under Modules (not PythonPath) +may be imported by importlib.machinery.WindowsRegistryFinder. +This finder is enabled on Windows in 3.6.0 and earlier, but may need to +be explicitly added to sys.meta_path in the future.

    +
    +
    +
    +
    +

    3.9. Additional modules

    +

    Even though Python aims to be portable among all platforms, there are features +that are unique to Windows. A couple of modules, both in the standard library +and external, and snippets exist to use these features.

    +

    The Windows-specific standard modules are documented in +MS Windows Specific Services.

    +
    +

    3.9.1. PyWin32

    +

    The PyWin32 module by Mark Hammond +is a collection of modules for advanced Windows-specific support. This includes +utilities for:

    + +

    PythonWin is a sample MFC application +shipped with PyWin32. It is an embeddable IDE with a built-in debugger.

    +
    +

    See also

    +
    +
    Win32 How Do I…?

    by Tim Golden

    +
    +
    Python and COM

    by David and Paul Boddie

    +
    +
    +
    +
    +
    +

    3.9.2. cx_Freeze

    +

    cx_Freeze is a distutils +extension (see Extending Distutils) which wraps Python scripts into +executable Windows programs (*.exe files). When you have done this, +you can distribute your application without requiring your users to install +Python.

    +
    +
    +

    3.9.3. WConio

    +

    Since Python’s advanced terminal handling layer, curses, is restricted to +Unix-like systems, there is a library exclusive to Windows as well: Windows +Console I/O for Python.

    +

    WConio is a wrapper for +Turbo-C’s CONIO.H, used to create text user interfaces.

    +
    +
    +
    +

    3.10. Compiling Python on Windows

    +

    If you want to compile CPython yourself, first thing you should do is get the +source. You can download either the +latest release’s source or just grab a fresh checkout.

    +

    The source tree contains a build solution and project files for Microsoft +Visual Studio 2015, which is the compiler used to build the official Python +releases. These files are in the PCbuild directory.

    +

    Check PCbuild/readme.txt for general information on the build process.

    +

    For extension modules, consult Building C and C++ Extensions on Windows.

    +
    +

    See also

    +
    +
    Python + Windows + distutils + SWIG + gcc MinGW

    or “Creating Python extensions in C/C++ with SWIG and compiling them with +MinGW gcc under Windows” or “Installing Python extension with distutils +and without Microsoft Visual C++” by Sébastien Sauvage, 2003

    +
    +
    +

    MingW – Python extensions

    +
    +
    +
    +

    3.11. Other Platforms

    +

    With ongoing development of Python, some platforms that used to be supported +earlier are no longer supported (due to the lack of users or developers). +Check PEP 11 for details on all unsupported platforms.

    + +

    See Python for Windows +for detailed information about platforms with pre-compiled installers.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/whatsnew/2.0.html b/python-3.7.4-docs-html/whatsnew/2.0.html new file mode 100644 index 0000000..8400fa9 --- /dev/null +++ b/python-3.7.4-docs-html/whatsnew/2.0.html @@ -0,0 +1,1224 @@ + + + + + + + What’s New in Python 2.0 — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    What’s New in Python 2.0

    +
    +
    Author
    +

    A.M. Kuchling and Moshe Zadka

    +
    +
    +
    +

    Introduction

    +

    A new release of Python, version 2.0, was released on October 16, 2000. This +article covers the exciting new features in 2.0, highlights some other useful +changes, and points out a few incompatible changes that may require rewriting +code.

    +

    Python’s development never completely stops between releases, and a steady flow +of bug fixes and improvements are always being submitted. A host of minor fixes, +a few optimizations, additional docstrings, and better error messages went into +2.0; to list them all would be impossible, but they’re certainly significant. +Consult the publicly-available CVS logs if you want to see the full list. This +progress is due to the five developers working for PythonLabs are now getting +paid to spend their days fixing bugs, and also due to the improved communication +resulting from moving to SourceForge.

    +
    +
    +

    What About Python 1.6?

    +

    Python 1.6 can be thought of as the Contractual Obligations Python release. +After the core development team left CNRI in May 2000, CNRI requested that a 1.6 +release be created, containing all the work on Python that had been performed at +CNRI. Python 1.6 therefore represents the state of the CVS tree as of May 2000, +with the most significant new feature being Unicode support. Development +continued after May, of course, so the 1.6 tree received a few fixes to ensure +that it’s forward-compatible with Python 2.0. 1.6 is therefore part of Python’s +evolution, and not a side branch.

    +

    So, should you take much interest in Python 1.6? Probably not. The 1.6final +and 2.0beta1 releases were made on the same day (September 5, 2000), the plan +being to finalize Python 2.0 within a month or so. If you have applications to +maintain, there seems little point in breaking things by moving to 1.6, fixing +them, and then having another round of breakage within a month by moving to 2.0; +you’re better off just going straight to 2.0. Most of the really interesting +features described in this document are only in 2.0, because a lot of work was +done between May and September.

    +
    +
    +

    New Development Process

    +

    The most important change in Python 2.0 may not be to the code at all, but to +how Python is developed: in May 2000 the Python developers began using the tools +made available by SourceForge for storing source code, tracking bug reports, +and managing the queue of patch submissions. To report bugs or submit patches +for Python 2.0, use the bug tracking and patch manager tools available from +Python’s project page, located at https://sourceforge.net/projects/python/.

    +

    The most important of the services now hosted at SourceForge is the Python CVS +tree, the version-controlled repository containing the source code for Python. +Previously, there were roughly 7 or so people who had write access to the CVS +tree, and all patches had to be inspected and checked in by one of the people on +this short list. Obviously, this wasn’t very scalable. By moving the CVS tree +to SourceForge, it became possible to grant write access to more people; as of +September 2000 there were 27 people able to check in changes, a fourfold +increase. This makes possible large-scale changes that wouldn’t be attempted if +they’d have to be filtered through the small group of core developers. For +example, one day Peter Schneider-Kamp took it into his head to drop K&R C +compatibility and convert the C source for Python to ANSI C. After getting +approval on the python-dev mailing list, he launched into a flurry of checkins +that lasted about a week, other developers joined in to help, and the job was +done. If there were only 5 people with write access, probably that task would +have been viewed as “nice, but not worth the time and effort needed” and it +would never have gotten done.

    +

    The shift to using SourceForge’s services has resulted in a remarkable increase +in the speed of development. Patches now get submitted, commented on, revised +by people other than the original submitter, and bounced back and forth between +people until the patch is deemed worth checking in. Bugs are tracked in one +central location and can be assigned to a specific person for fixing, and we can +count the number of open bugs to measure progress. This didn’t come without a +cost: developers now have more e-mail to deal with, more mailing lists to +follow, and special tools had to be written for the new environment. For +example, SourceForge sends default patch and bug notification e-mail messages +that are completely unhelpful, so Ka-Ping Yee wrote an HTML screen-scraper that +sends more useful messages.

    +

    The ease of adding code caused a few initial growing pains, such as code was +checked in before it was ready or without getting clear agreement from the +developer group. The approval process that has emerged is somewhat similar to +that used by the Apache group. Developers can vote +1, +0, -0, or -1 on a patch; ++1 and -1 denote acceptance or rejection, while +0 and -0 mean the developer is +mostly indifferent to the change, though with a slight positive or negative +slant. The most significant change from the Apache model is that the voting is +essentially advisory, letting Guido van Rossum, who has Benevolent Dictator For +Life status, know what the general opinion is. He can still ignore the result of +a vote, and approve or reject a change even if the community disagrees with him.

    +

    Producing an actual patch is the last step in adding a new feature, and is +usually easy compared to the earlier task of coming up with a good design. +Discussions of new features can often explode into lengthy mailing list threads, +making the discussion hard to follow, and no one can read every posting to +python-dev. Therefore, a relatively formal process has been set up to write +Python Enhancement Proposals (PEPs), modelled on the Internet RFC process. PEPs +are draft documents that describe a proposed new feature, and are continually +revised until the community reaches a consensus, either accepting or rejecting +the proposal. Quoting from the introduction to PEP 1, “PEP Purpose and +Guidelines”:

    +
    +

    PEP stands for Python Enhancement Proposal. A PEP is a design document +providing information to the Python community, or describing a new feature for +Python. The PEP should provide a concise technical specification of the feature +and a rationale for the feature.

    +

    We intend PEPs to be the primary mechanisms for proposing new features, for +collecting community input on an issue, and for documenting the design decisions +that have gone into Python. The PEP author is responsible for building +consensus within the community and documenting dissenting opinions.

    +
    +

    Read the rest of PEP 1 for the details of the PEP editorial process, style, and +format. PEPs are kept in the Python CVS tree on SourceForge, though they’re not +part of the Python 2.0 distribution, and are also available in HTML form from +https://www.python.org/dev/peps/. As of September 2000, there are 25 PEPS, ranging +from PEP 201, “Lockstep Iteration”, to PEP 225, “Elementwise/Objectwise +Operators”.

    +
    +
    +

    Unicode

    +

    The largest new feature in Python 2.0 is a new fundamental data type: Unicode +strings. Unicode uses 16-bit numbers to represent characters instead of the +8-bit number used by ASCII, meaning that 65,536 distinct characters can be +supported.

    +

    The final interface for Unicode support was arrived at through countless +often-stormy discussions on the python-dev mailing list, and mostly implemented by +Marc-André Lemburg, based on a Unicode string type implementation by Fredrik +Lundh. A detailed explanation of the interface was written up as PEP 100, +“Python Unicode Integration”. This article will simply cover the most +significant points about the Unicode interfaces.

    +

    In Python source code, Unicode strings are written as u"string". Arbitrary +Unicode characters can be written using a new escape sequence, \uHHHH, where +HHHH is a 4-digit hexadecimal number from 0000 to FFFF. The existing +\xHHHH escape sequence can also be used, and octal escapes can be used for +characters up to U+01FF, which is represented by \777.

    +

    Unicode strings, just like regular strings, are an immutable sequence type. +They can be indexed and sliced, but not modified in place. Unicode strings have +an encode( [encoding] ) method that returns an 8-bit string in the desired +encoding. Encodings are named by strings, such as 'ascii', 'utf-8', +'iso-8859-1', or whatever. A codec API is defined for implementing and +registering new encodings that are then available throughout a Python program. +If an encoding isn’t specified, the default encoding is usually 7-bit ASCII, +though it can be changed for your Python installation by calling the +sys.setdefaultencoding(encoding) function in a customized version of +site.py.

    +

    Combining 8-bit and Unicode strings always coerces to Unicode, using the default +ASCII encoding; the result of 'a' + u'bc' is u'abc'.

    +

    New built-in functions have been added, and existing built-ins modified to +support Unicode:

    +
      +
    • unichr(ch) returns a Unicode string 1 character long, containing the +character ch.

    • +
    • ord(u), where u is a 1-character regular or Unicode string, returns the +number of the character as an integer.

    • +
    • unicode(string [, encoding]  [, errors] ) creates a Unicode string +from an 8-bit string. encoding is a string naming the encoding to use. The +errors parameter specifies the treatment of characters that are invalid for +the current encoding; passing 'strict' as the value causes an exception to +be raised on any encoding error, while 'ignore' causes errors to be silently +ignored and 'replace' uses U+FFFD, the official replacement character, in +case of any problems.

    • +
    • The exec statement, and various built-ins such as eval(), +getattr(), and setattr() will also accept Unicode strings as well as +regular strings. (It’s possible that the process of fixing this missed some +built-ins; if you find a built-in function that accepts strings but doesn’t +accept Unicode strings at all, please report it as a bug.)

    • +
    +

    A new module, unicodedata, provides an interface to Unicode character +properties. For example, unicodedata.category(u'A') returns the 2-character +string ‘Lu’, the ‘L’ denoting it’s a letter, and ‘u’ meaning that it’s +uppercase. unicodedata.bidirectional(u'\u0660') returns ‘AN’, meaning that +U+0660 is an Arabic number.

    +

    The codecs module contains functions to look up existing encodings and +register new ones. Unless you want to implement a new encoding, you’ll most +often use the codecs.lookup(encoding) function, which returns a +4-element tuple: (encode_func, decode_func, stream_reader, stream_writer).

    +
      +
    • encode_func is a function that takes a Unicode string, and returns a 2-tuple +(string, length). string is an 8-bit string containing a portion (perhaps +all) of the Unicode string converted into the given encoding, and length tells +you how much of the Unicode string was converted.

    • +
    • decode_func is the opposite of encode_func, taking an 8-bit string and +returning a 2-tuple (ustring, length), consisting of the resulting Unicode +string ustring and the integer length telling how much of the 8-bit string +was consumed.

    • +
    • stream_reader is a class that supports decoding input from a stream. +stream_reader(file_obj) returns an object that supports the read(), +readline(), and readlines() methods. These methods will all +translate from the given encoding and return Unicode strings.

    • +
    • stream_writer, similarly, is a class that supports encoding output to a +stream. stream_writer(file_obj) returns an object that supports the +write() and writelines() methods. These methods expect Unicode +strings, translating them to the given encoding on output.

    • +
    +

    For example, the following code writes a Unicode string into a file, encoding +it as UTF-8:

    +
    import codecs
    +
    +unistr = u'\u0660\u2000ab ...'
    +
    +(UTF8_encode, UTF8_decode,
    + UTF8_streamreader, UTF8_streamwriter) = codecs.lookup('UTF-8')
    +
    +output = UTF8_streamwriter( open( '/tmp/output', 'wb') )
    +output.write( unistr )
    +output.close()
    +
    +
    +

    The following code would then read UTF-8 input from the file:

    +
    input = UTF8_streamreader( open( '/tmp/output', 'rb') )
    +print repr(input.read())
    +input.close()
    +
    +
    +

    Unicode-aware regular expressions are available through the re module, +which has a new underlying implementation called SRE written by Fredrik Lundh of +Secret Labs AB.

    +

    A -U command line option was added which causes the Python compiler to +interpret all string literals as Unicode string literals. This is intended to be +used in testing and future-proofing your Python code, since some future version +of Python may drop support for 8-bit strings and provide only Unicode strings.

    +
    +
    +

    List Comprehensions

    +

    Lists are a workhorse data type in Python, and many programs manipulate a list +at some point. Two common operations on lists are to loop over them, and either +pick out the elements that meet a certain criterion, or apply some function to +each element. For example, given a list of strings, you might want to pull out +all the strings containing a given substring, or strip off trailing whitespace +from each line.

    +

    The existing map() and filter() functions can be used for this +purpose, but they require a function as one of their arguments. This is fine if +there’s an existing built-in function that can be passed directly, but if there +isn’t, you have to create a little function to do the required work, and +Python’s scoping rules make the result ugly if the little function needs +additional information. Take the first example in the previous paragraph, +finding all the strings in the list containing a given substring. You could +write the following to do it:

    +
    # Given the list L, make a list of all strings
    +# containing the substring S.
    +sublist = filter( lambda s, substring=S:
    +                     string.find(s, substring) != -1,
    +                  L)
    +
    +
    +

    Because of Python’s scoping rules, a default argument is used so that the +anonymous function created by the lambda expression knows what +substring is being searched for. List comprehensions make this cleaner:

    +
    sublist = [ s for s in L if string.find(s, S) != -1 ]
    +
    +
    +

    List comprehensions have the form:

    +
    [ expression for expr in sequence1
    +             for expr2 in sequence2 ...
    +             for exprN in sequenceN
    +             if condition ]
    +
    +
    +

    The forin clauses contain the sequences to be +iterated over. The sequences do not have to be the same length, because they +are not iterated over in parallel, but from left to right; this is explained +more clearly in the following paragraphs. The elements of the generated list +will be the successive values of expression. The final if clause +is optional; if present, expression is only evaluated and added to the result +if condition is true.

    +

    To make the semantics very clear, a list comprehension is equivalent to the +following Python code:

    +
    for expr1 in sequence1:
    +    for expr2 in sequence2:
    +    ...
    +        for exprN in sequenceN:
    +             if (condition):
    +                  # Append the value of
    +                  # the expression to the
    +                  # resulting list.
    +
    +
    +

    This means that when there are multiple forin +clauses, the resulting list will be equal to the product of the lengths of all +the sequences. If you have two lists of length 3, the output list is 9 elements +long:

    +
    seq1 = 'abc'
    +seq2 = (1,2,3)
    +>>> [ (x,y) for x in seq1 for y in seq2]
    +[('a', 1), ('a', 2), ('a', 3), ('b', 1), ('b', 2), ('b', 3), ('c', 1),
    +('c', 2), ('c', 3)]
    +
    +
    +

    To avoid introducing an ambiguity into Python’s grammar, if expression is +creating a tuple, it must be surrounded with parentheses. The first list +comprehension below is a syntax error, while the second one is correct:

    +
    # Syntax error
    +[ x,y for x in seq1 for y in seq2]
    +# Correct
    +[ (x,y) for x in seq1 for y in seq2]
    +
    +
    +

    The idea of list comprehensions originally comes from the functional programming +language Haskell (https://www.haskell.org). Greg Ewing argued most effectively +for adding them to Python and wrote the initial list comprehension patch, which +was then discussed for a seemingly endless time on the python-dev mailing list +and kept up-to-date by Skip Montanaro.

    +
    +
    +

    Augmented Assignment

    +

    Augmented assignment operators, another long-requested feature, have been added +to Python 2.0. Augmented assignment operators include +=, -=, *=, +and so forth. For example, the statement a += 2 increments the value of the +variable a by 2, equivalent to the slightly lengthier a = a + 2.

    +

    The full list of supported assignment operators is +=, -=, *=, +/=, %=, **=, &=, |=, ^=, >>=, and <<=. Python +classes can override the augmented assignment operators by defining methods +named __iadd__(), __isub__(), etc. For example, the following +Number class stores a number and supports using += to create a new +instance with an incremented value.

    +
    class Number:
    +    def __init__(self, value):
    +        self.value = value
    +    def __iadd__(self, increment):
    +        return Number( self.value + increment)
    +
    +n = Number(5)
    +n += 3
    +print n.value
    +
    +
    +

    The __iadd__() special method is called with the value of the increment, +and should return a new instance with an appropriately modified value; this +return value is bound as the new value of the variable on the left-hand side.

    +

    Augmented assignment operators were first introduced in the C programming +language, and most C-derived languages, such as awk, C++, Java, Perl, +and PHP also support them. The augmented assignment patch was implemented by +Thomas Wouters.

    +
    +
    +

    String Methods

    +

    Until now string-manipulation functionality was in the string module, +which was usually a front-end for the strop module written in C. The +addition of Unicode posed a difficulty for the strop module, because the +functions would all need to be rewritten in order to accept either 8-bit or +Unicode strings. For functions such as string.replace(), which takes 3 +string arguments, that means eight possible permutations, and correspondingly +complicated code.

    +

    Instead, Python 2.0 pushes the problem onto the string type, making string +manipulation functionality available through methods on both 8-bit strings and +Unicode strings.

    +
    >>> 'andrew'.capitalize()
    +'Andrew'
    +>>> 'hostname'.replace('os', 'linux')
    +'hlinuxtname'
    +>>> 'moshe'.find('sh')
    +2
    +
    +
    +

    One thing that hasn’t changed, a noteworthy April Fools’ joke notwithstanding, +is that Python strings are immutable. Thus, the string methods return new +strings, and do not modify the string on which they operate.

    +

    The old string module is still around for backwards compatibility, but it +mostly acts as a front-end to the new string methods.

    +

    Two methods which have no parallel in pre-2.0 versions, although they did exist +in JPython for quite some time, are startswith() and endswith(). +s.startswith(t) is equivalent to s[:len(t)] == t, while +s.endswith(t) is equivalent to s[-len(t):] == t.

    +

    One other method which deserves special mention is join(). The +join() method of a string receives one parameter, a sequence of strings, +and is equivalent to the string.join() function from the old string +module, with the arguments reversed. In other words, s.join(seq) is +equivalent to the old string.join(seq, s).

    +
    +
    +

    Garbage Collection of Cycles

    +

    The C implementation of Python uses reference counting to implement garbage +collection. Every Python object maintains a count of the number of references +pointing to itself, and adjusts the count as references are created or +destroyed. Once the reference count reaches zero, the object is no longer +accessible, since you need to have a reference to an object to access it, and if +the count is zero, no references exist any longer.

    +

    Reference counting has some pleasant properties: it’s easy to understand and +implement, and the resulting implementation is portable, fairly fast, and reacts +well with other libraries that implement their own memory handling schemes. The +major problem with reference counting is that it sometimes doesn’t realise that +objects are no longer accessible, resulting in a memory leak. This happens when +there are cycles of references.

    +

    Consider the simplest possible cycle, a class instance which has a reference to +itself:

    +
    instance = SomeClass()
    +instance.myself = instance
    +
    +
    +

    After the above two lines of code have been executed, the reference count of +instance is 2; one reference is from the variable named 'instance', and +the other is from the myself attribute of the instance.

    +

    If the next line of code is del instance, what happens? The reference count +of instance is decreased by 1, so it has a reference count of 1; the +reference in the myself attribute still exists. Yet the instance is no +longer accessible through Python code, and it could be deleted. Several objects +can participate in a cycle if they have references to each other, causing all of +the objects to be leaked.

    +

    Python 2.0 fixes this problem by periodically executing a cycle detection +algorithm which looks for inaccessible cycles and deletes the objects involved. +A new gc module provides functions to perform a garbage collection, +obtain debugging statistics, and tuning the collector’s parameters.

    +

    Running the cycle detection algorithm takes some time, and therefore will result +in some additional overhead. It is hoped that after we’ve gotten experience +with the cycle collection from using 2.0, Python 2.1 will be able to minimize +the overhead with careful tuning. It’s not yet obvious how much performance is +lost, because benchmarking this is tricky and depends crucially on how often the +program creates and destroys objects. The detection of cycles can be disabled +when Python is compiled, if you can’t afford even a tiny speed penalty or +suspect that the cycle collection is buggy, by specifying the +--without-cycle-gc switch when running the configure +script.

    +

    Several people tackled this problem and contributed to a solution. An early +implementation of the cycle detection approach was written by Toby Kelsey. The +current algorithm was suggested by Eric Tiedemann during a visit to CNRI, and +Guido van Rossum and Neil Schemenauer wrote two different implementations, which +were later integrated by Neil. Lots of other people offered suggestions along +the way; the March 2000 archives of the python-dev mailing list contain most of +the relevant discussion, especially in the threads titled “Reference cycle +collection for Python” and “Finalization again”.

    +
    +
    +

    Other Core Changes

    +

    Various minor changes have been made to Python’s syntax and built-in functions. +None of the changes are very far-reaching, but they’re handy conveniences.

    +
    +

    Minor Language Changes

    +

    A new syntax makes it more convenient to call a given function with a tuple of +arguments and/or a dictionary of keyword arguments. In Python 1.5 and earlier, +you’d use the apply() built-in function: apply(f, args, kw) calls the +function f() with the argument tuple args and the keyword arguments in +the dictionary kw. apply() is the same in 2.0, but thanks to a patch +from Greg Ewing, f(*args, **kw) is a shorter and clearer way to achieve the +same effect. This syntax is symmetrical with the syntax for defining +functions:

    +
    def f(*args, **kw):
    +    # args is a tuple of positional args,
    +    # kw is a dictionary of keyword args
    +    ...
    +
    +
    +

    The print statement can now have its output directed to a file-like +object by following the print with >> file, similar to the +redirection operator in Unix shells. Previously you’d either have to use the +write() method of the file-like object, which lacks the convenience and +simplicity of print, or you could assign a new value to +sys.stdout and then restore the old value. For sending output to standard +error, it’s much easier to write this:

    +
    print >> sys.stderr, "Warning: action field not supplied"
    +
    +
    +

    Modules can now be renamed on importing them, using the syntax import module +as name or from module import name as othername. The patch was submitted +by Thomas Wouters.

    +

    A new format style is available when using the % operator; ‘%r’ will insert +the repr() of its argument. This was also added from symmetry +considerations, this time for symmetry with the existing ‘%s’ format style, +which inserts the str() of its argument. For example, '%r %s' % ('abc', +'abc') returns a string containing 'abc' abc.

    +

    Previously there was no way to implement a class that overrode Python’s built-in +in operator and implemented a custom version. obj in seq returns +true if obj is present in the sequence seq; Python computes this by simply +trying every index of the sequence until either obj is found or an +IndexError is encountered. Moshe Zadka contributed a patch which adds a +__contains__() magic method for providing a custom implementation for +in. Additionally, new built-in objects written in C can define what +in means for them via a new slot in the sequence protocol.

    +

    Earlier versions of Python used a recursive algorithm for deleting objects. +Deeply nested data structures could cause the interpreter to fill up the C stack +and crash; Christian Tismer rewrote the deletion logic to fix this problem. On +a related note, comparing recursive objects recursed infinitely and crashed; +Jeremy Hylton rewrote the code to no longer crash, producing a useful result +instead. For example, after this code:

    +
    a = []
    +b = []
    +a.append(a)
    +b.append(b)
    +
    +
    +

    The comparison a==b returns true, because the two recursive data structures +are isomorphic. See the thread “trashcan and PR#7” in the April 2000 archives of +the python-dev mailing list for the discussion leading up to this +implementation, and some useful relevant links. Note that comparisons can now +also raise exceptions. In earlier versions of Python, a comparison operation +such as cmp(a,b) would always produce an answer, even if a user-defined +__cmp__() method encountered an error, since the resulting exception would +simply be silently swallowed.

    +

    Work has been done on porting Python to 64-bit Windows on the Itanium processor, +mostly by Trent Mick of ActiveState. (Confusingly, sys.platform is still +'win32' on Win64 because it seems that for ease of porting, MS Visual C++ +treats code as 32 bit on Itanium.) PythonWin also supports Windows CE; see the +Python CE page at http://pythonce.sourceforge.net/ for more information.

    +

    Another new platform is Darwin/MacOS X; initial support for it is in Python 2.0. +Dynamic loading works, if you specify “configure –with-dyld –with-suffix=.x”. +Consult the README in the Python source distribution for more instructions.

    +

    An attempt has been made to alleviate one of Python’s warts, the often-confusing +NameError exception when code refers to a local variable before the +variable has been assigned a value. For example, the following code raises an +exception on the print statement in both 1.5.2 and 2.0; in 1.5.2 a +NameError exception is raised, while 2.0 raises a new +UnboundLocalError exception. UnboundLocalError is a subclass of +NameError, so any existing code that expects NameError to be +raised should still work.

    +
    def f():
    +    print "i=",i
    +    i = i + 1
    +f()
    +
    +
    +

    Two new exceptions, TabError and IndentationError, have been +introduced. They’re both subclasses of SyntaxError, and are raised when +Python code is found to be improperly indented.

    +
    +
    +

    Changes to Built-in Functions

    +

    A new built-in, zip(seq1, seq2, ...), has been added. zip() +returns a list of tuples where each tuple contains the i-th element from each of +the argument sequences. The difference between zip() and map(None, +seq1, seq2) is that map() pads the sequences with None if the +sequences aren’t all of the same length, while zip() truncates the +returned list to the length of the shortest argument sequence.

    +

    The int() and long() functions now accept an optional “base” +parameter when the first argument is a string. int('123', 10) returns 123, +while int('123', 16) returns 291. int(123, 16) raises a +TypeError exception with the message “can’t convert non-string with +explicit base”.

    +

    A new variable holding more detailed version information has been added to the +sys module. sys.version_info is a tuple (major, minor, micro, +level, serial) For example, in a hypothetical 2.0.1beta1, sys.version_info +would be (2, 0, 1, 'beta', 1). level is a string such as "alpha", +"beta", or "final" for a final release.

    +

    Dictionaries have an odd new method, setdefault(key, default), which +behaves similarly to the existing get() method. However, if the key is +missing, setdefault() both returns the value of default as get() +would do, and also inserts it into the dictionary as the value for key. Thus, +the following lines of code:

    +
    if dict.has_key( key ): return dict[key]
    +else:
    +    dict[key] = []
    +    return dict[key]
    +
    +
    +

    can be reduced to a single return dict.setdefault(key, []) statement.

    +

    The interpreter sets a maximum recursion depth in order to catch runaway +recursion before filling the C stack and causing a core dump or GPF.. +Previously this limit was fixed when you compiled Python, but in 2.0 the maximum +recursion depth can be read and modified using sys.getrecursionlimit() and +sys.setrecursionlimit(). The default value is 1000, and a rough maximum +value for a given platform can be found by running a new script, +Misc/find_recursionlimit.py.

    +
    +
    +
    +

    Porting to 2.0

    +

    New Python releases try hard to be compatible with previous releases, and the +record has been pretty good. However, some changes are considered useful +enough, usually because they fix initial design decisions that turned out to be +actively mistaken, that breaking backward compatibility can’t always be avoided. +This section lists the changes in Python 2.0 that may cause old Python code to +break.

    +

    The change which will probably break the most code is tightening up the +arguments accepted by some methods. Some methods would take multiple arguments +and treat them as a tuple, particularly various list methods such as +append() and insert(). In earlier versions of Python, if L is +a list, L.append( 1,2 ) appends the tuple (1,2) to the list. In Python +2.0 this causes a TypeError exception to be raised, with the message: +‘append requires exactly 1 argument; 2 given’. The fix is to simply add an +extra set of parentheses to pass both values as a tuple: L.append( (1,2) ).

    +

    The earlier versions of these methods were more forgiving because they used an +old function in Python’s C interface to parse their arguments; 2.0 modernizes +them to use PyArg_ParseTuple(), the current argument parsing function, +which provides more helpful error messages and treats multi-argument calls as +errors. If you absolutely must use 2.0 but can’t fix your code, you can edit +Objects/listobject.c and define the preprocessor symbol +NO_STRICT_LIST_APPEND to preserve the old behaviour; this isn’t recommended.

    +

    Some of the functions in the socket module are still forgiving in this +way. For example, socket.connect( ('hostname', 25) )() is the correct +form, passing a tuple representing an IP address, but socket.connect( +'hostname', 25 )() also works. socket.connect_ex() and socket.bind() +are similarly easy-going. 2.0alpha1 tightened these functions up, but because +the documentation actually used the erroneous multiple argument form, many +people wrote code which would break with the stricter checking. GvR backed out +the changes in the face of public reaction, so for the socket module, the +documentation was fixed and the multiple argument form is simply marked as +deprecated; it will be tightened up again in a future Python version.

    +

    The \x escape in string literals now takes exactly 2 hex digits. Previously +it would consume all the hex digits following the ‘x’ and take the lowest 8 bits +of the result, so \x123456 was equivalent to \x56.

    +

    The AttributeError and NameError exceptions have a more friendly +error message, whose text will be something like 'Spam' instance has no +attribute 'eggs' or name 'eggs' is not defined. Previously the error +message was just the missing attribute name eggs, and code written to take +advantage of this fact will break in 2.0.

    +

    Some work has been done to make integers and long integers a bit more +interchangeable. In 1.5.2, large-file support was added for Solaris, to allow +reading files larger than 2 GiB; this made the tell() method of file +objects return a long integer instead of a regular integer. Some code would +subtract two file offsets and attempt to use the result to multiply a sequence +or slice a string, but this raised a TypeError. In 2.0, long integers +can be used to multiply or slice a sequence, and it’ll behave as you’d +intuitively expect it to; 3L * 'abc' produces ‘abcabcabc’, and +(0,1,2,3)[2L:4L] produces (2,3). Long integers can also be used in various +contexts where previously only integers were accepted, such as in the +seek() method of file objects, and in the formats supported by the % +operator (%d, %i, %x, etc.). For example, "%d" % 2L**64 will +produce the string 18446744073709551616.

    +

    The subtlest long integer change of all is that the str() of a long +integer no longer has a trailing ‘L’ character, though repr() still +includes it. The ‘L’ annoyed many people who wanted to print long integers that +looked just like regular integers, since they had to go out of their way to chop +off the character. This is no longer a problem in 2.0, but code which does +str(longval)[:-1] and assumes the ‘L’ is there, will now lose the final +digit.

    +

    Taking the repr() of a float now uses a different formatting precision +than str(). repr() uses %.17g format string for C’s +sprintf(), while str() uses %.12g as before. The effect is that +repr() may occasionally show more decimal places than str(), for +certain numbers. For example, the number 8.1 can’t be represented exactly in +binary, so repr(8.1) is '8.0999999999999996', while str(8.1) is +'8.1'.

    +

    The -X command-line option, which turned all standard exceptions into +strings instead of classes, has been removed; the standard exceptions will now +always be classes. The exceptions module containing the standard +exceptions was translated from Python to a built-in C module, written by Barry +Warsaw and Fredrik Lundh.

    +
    +
    +

    Extending/Embedding Changes

    +

    Some of the changes are under the covers, and will only be apparent to people +writing C extension modules or embedding a Python interpreter in a larger +application. If you aren’t dealing with Python’s C API, you can safely skip +this section.

    +

    The version number of the Python C API was incremented, so C extensions compiled +for 1.5.2 must be recompiled in order to work with 2.0. On Windows, it’s not +possible for Python 2.0 to import a third party extension built for Python 1.5.x +due to how Windows DLLs work, so Python will raise an exception and the import +will fail.

    +

    Users of Jim Fulton’s ExtensionClass module will be pleased to find out that +hooks have been added so that ExtensionClasses are now supported by +isinstance() and issubclass(). This means you no longer have to +remember to write code such as if type(obj) == myExtensionClass, but can use +the more natural if isinstance(obj, myExtensionClass).

    +

    The Python/importdl.c file, which was a mass of #ifdefs to support +dynamic loading on many different platforms, was cleaned up and reorganised by +Greg Stein. importdl.c is now quite small, and platform-specific code +has been moved into a bunch of Python/dynload_*.c files. Another +cleanup: there were also a number of my*.h files in the Include/ +directory that held various portability hacks; they’ve been merged into a single +file, Include/pyport.h.

    +

    Vladimir Marangozov’s long-awaited malloc restructuring was completed, to make +it easy to have the Python interpreter use a custom allocator instead of C’s +standard malloc(). For documentation, read the comments in +Include/pymem.h and Include/objimpl.h. For the lengthy +discussions during which the interface was hammered out, see the Web archives of +the ‘patches’ and ‘python-dev’ lists at python.org.

    +

    Recent versions of the GUSI development environment for MacOS support POSIX +threads. Therefore, Python’s POSIX threading support now works on the +Macintosh. Threading support using the user-space GNU pth library was also +contributed.

    +

    Threading support on Windows was enhanced, too. Windows supports thread locks +that use kernel objects only in case of contention; in the common case when +there’s no contention, they use simpler functions which are an order of +magnitude faster. A threaded version of Python 1.5.2 on NT is twice as slow as +an unthreaded version; with the 2.0 changes, the difference is only 10%. These +improvements were contributed by Yakov Markovitch.

    +

    Python 2.0’s source now uses only ANSI C prototypes, so compiling Python now +requires an ANSI C compiler, and can no longer be done using a compiler that +only supports K&R C.

    +

    Previously the Python virtual machine used 16-bit numbers in its bytecode, +limiting the size of source files. In particular, this affected the maximum +size of literal lists and dictionaries in Python source; occasionally people who +are generating Python code would run into this limit. A patch by Charles G. +Waldman raises the limit from 2^16 to 2^{32}.

    +

    Three new convenience functions intended for adding constants to a module’s +dictionary at module initialization time were added: PyModule_AddObject(), +PyModule_AddIntConstant(), and PyModule_AddStringConstant(). Each +of these functions takes a module object, a null-terminated C string containing +the name to be added, and a third argument for the value to be assigned to the +name. This third argument is, respectively, a Python object, a C long, or a C +string.

    +

    A wrapper API was added for Unix-style signal handlers. PyOS_getsig() gets +a signal handler and PyOS_setsig() will set a new handler.

    +
    +
    +

    Distutils: Making Modules Easy to Install

    +

    Before Python 2.0, installing modules was a tedious affair – there was no way +to figure out automatically where Python is installed, or what compiler options +to use for extension modules. Software authors had to go through an arduous +ritual of editing Makefiles and configuration files, which only really work on +Unix and leave Windows and MacOS unsupported. Python users faced wildly +differing installation instructions which varied between different extension +packages, which made administering a Python installation something of a chore.

    +

    The SIG for distribution utilities, shepherded by Greg Ward, has created the +Distutils, a system to make package installation much easier. They form the +distutils package, a new part of Python’s standard library. In the best +case, installing a Python module from source will require the same steps: first +you simply mean unpack the tarball or zip archive, and the run “python +setup.py install”. The platform will be automatically detected, the compiler +will be recognized, C extension modules will be compiled, and the distribution +installed into the proper directory. Optional command-line arguments provide +more control over the installation process, the distutils package offers many +places to override defaults – separating the build from the install, building +or installing in non-default directories, and more.

    +

    In order to use the Distutils, you need to write a setup.py script. For +the simple case, when the software contains only .py files, a minimal +setup.py can be just a few lines long:

    +
    from distutils.core import setup
    +setup (name = "foo", version = "1.0",
    +       py_modules = ["module1", "module2"])
    +
    +
    +

    The setup.py file isn’t much more complicated if the software consists +of a few packages:

    +
    from distutils.core import setup
    +setup (name = "foo", version = "1.0",
    +       packages = ["package", "package.subpackage"])
    +
    +
    +

    A C extension can be the most complicated case; here’s an example taken from +the PyXML package:

    +
    from distutils.core import setup, Extension
    +
    +expat_extension = Extension('xml.parsers.pyexpat',
    +     define_macros = [('XML_NS', None)],
    +     include_dirs = [ 'extensions/expat/xmltok',
    +                      'extensions/expat/xmlparse' ],
    +     sources = [ 'extensions/pyexpat.c',
    +                 'extensions/expat/xmltok/xmltok.c',
    +                 'extensions/expat/xmltok/xmlrole.c', ]
    +       )
    +setup (name = "PyXML", version = "0.5.4",
    +       ext_modules =[ expat_extension ] )
    +
    +
    +

    The Distutils can also take care of creating source and binary distributions. +The “sdist” command, run by “python setup.py sdist’, builds a source +distribution such as foo-1.0.tar.gz. Adding new commands isn’t +difficult, “bdist_rpm” and “bdist_wininst” commands have already been +contributed to create an RPM distribution and a Windows installer for the +software, respectively. Commands to create other distribution formats such as +Debian packages and Solaris .pkg files are in various stages of +development.

    +

    All this is documented in a new manual, Distributing Python Modules, that +joins the basic set of Python documentation.

    +
    +
    +

    XML Modules

    +

    Python 1.5.2 included a simple XML parser in the form of the xmllib +module, contributed by Sjoerd Mullender. Since 1.5.2’s release, two different +interfaces for processing XML have become common: SAX2 (version 2 of the Simple +API for XML) provides an event-driven interface with some similarities to +xmllib, and the DOM (Document Object Model) provides a tree-based +interface, transforming an XML document into a tree of nodes that can be +traversed and modified. Python 2.0 includes a SAX2 interface and a stripped-down +DOM interface as part of the xml package. Here we will give a brief +overview of these new interfaces; consult the Python documentation or the source +code for complete details. The Python XML SIG is also working on improved +documentation.

    +
    +

    SAX2 Support

    +

    SAX defines an event-driven interface for parsing XML. To use SAX, you must +write a SAX handler class. Handler classes inherit from various classes +provided by SAX, and override various methods that will then be called by the +XML parser. For example, the startElement() and endElement() +methods are called for every starting and end tag encountered by the parser, the +characters() method is called for every chunk of character data, and so +forth.

    +

    The advantage of the event-driven approach is that the whole document doesn’t +have to be resident in memory at any one time, which matters if you are +processing really huge documents. However, writing the SAX handler class can +get very complicated if you’re trying to modify the document structure in some +elaborate way.

    +

    For example, this little example program defines a handler that prints a message +for every starting and ending tag, and then parses the file hamlet.xml +using it:

    +
    from xml import sax
    +
    +class SimpleHandler(sax.ContentHandler):
    +    def startElement(self, name, attrs):
    +        print 'Start of element:', name, attrs.keys()
    +
    +    def endElement(self, name):
    +        print 'End of element:', name
    +
    +# Create a parser object
    +parser = sax.make_parser()
    +
    +# Tell it what handler to use
    +handler = SimpleHandler()
    +parser.setContentHandler( handler )
    +
    +# Parse a file!
    +parser.parse( 'hamlet.xml' )
    +
    +
    +

    For more information, consult the Python documentation, or the XML HOWTO at +http://pyxml.sourceforge.net/topics/howto/xml-howto.html.

    +
    +
    +

    DOM Support

    +

    The Document Object Model is a tree-based representation for an XML document. A +top-level Document instance is the root of the tree, and has a single +child which is the top-level Element instance. This Element +has children nodes representing character data and any sub-elements, which may +have further children of their own, and so forth. Using the DOM you can +traverse the resulting tree any way you like, access element and attribute +values, insert and delete nodes, and convert the tree back into XML.

    +

    The DOM is useful for modifying XML documents, because you can create a DOM +tree, modify it by adding new nodes or rearranging subtrees, and then produce a +new XML document as output. You can also construct a DOM tree manually and +convert it to XML, which can be a more flexible way of producing XML output than +simply writing <tag1></tag1> to a file.

    +

    The DOM implementation included with Python lives in the xml.dom.minidom +module. It’s a lightweight implementation of the Level 1 DOM with support for +XML namespaces. The parse() and parseString() convenience +functions are provided for generating a DOM tree:

    +
    from xml.dom import minidom
    +doc = minidom.parse('hamlet.xml')
    +
    +
    +

    doc is a Document instance. Document, like all the other +DOM classes such as Element and Text, is a subclass of the +Node base class. All the nodes in a DOM tree therefore support certain +common methods, such as toxml() which returns a string containing the XML +representation of the node and its children. Each class also has special +methods of its own; for example, Element and Document +instances have a method to find all child elements with a given tag name. +Continuing from the previous 2-line example:

    +
    perslist = doc.getElementsByTagName( 'PERSONA' )
    +print perslist[0].toxml()
    +print perslist[1].toxml()
    +
    +
    +

    For the Hamlet XML file, the above few lines output:

    +
    <PERSONA>CLAUDIUS, king of Denmark. </PERSONA>
    +<PERSONA>HAMLET, son to the late, and nephew to the present king.</PERSONA>
    +
    +
    +

    The root element of the document is available as doc.documentElement, and +its children can be easily modified by deleting, adding, or removing nodes:

    +
    root = doc.documentElement
    +
    +# Remove the first child
    +root.removeChild( root.childNodes[0] )
    +
    +# Move the new first child to the end
    +root.appendChild( root.childNodes[0] )
    +
    +# Insert the new first child (originally,
    +# the third child) before the 20th child.
    +root.insertBefore( root.childNodes[0], root.childNodes[20] )
    +
    +
    +

    Again, I will refer you to the Python documentation for a complete listing of +the different Node classes and their various methods.

    +
    +
    +

    Relationship to PyXML

    +

    The XML Special Interest Group has been working on XML-related Python code for a +while. Its code distribution, called PyXML, is available from the SIG’s Web +pages at https://www.python.org/community/sigs/current/xml-sig. The PyXML distribution also used +the package name xml. If you’ve written programs that used PyXML, you’re +probably wondering about its compatibility with the 2.0 xml package.

    +

    The answer is that Python 2.0’s xml package isn’t compatible with PyXML, +but can be made compatible by installing a recent version PyXML. Many +applications can get by with the XML support that is included with Python 2.0, +but more complicated applications will require that the full PyXML package will +be installed. When installed, PyXML versions 0.6.0 or greater will replace the +xml package shipped with Python, and will be a strict superset of the +standard package, adding a bunch of additional features. Some of the additional +features in PyXML include:

    +
      +
    • 4DOM, a full DOM implementation from FourThought, Inc.

    • +
    • The xmlproc validating parser, written by Lars Marius Garshol.

    • +
    • The sgmlop parser accelerator module, written by Fredrik Lundh.

    • +
    +
    +
    +
    +

    Module changes

    +

    Lots of improvements and bugfixes were made to Python’s extensive standard +library; some of the affected modules include readline, +ConfigParser, cgi, calendar, posix, readline, +xmllib, aifc, chunk, wave, random, shelve, +and nntplib. Consult the CVS logs for the exact patch-by-patch details.

    +

    Brian Gallew contributed OpenSSL support for the socket module. OpenSSL +is an implementation of the Secure Socket Layer, which encrypts the data being +sent over a socket. When compiling Python, you can edit Modules/Setup +to include SSL support, which adds an additional function to the socket +module: socket.ssl(socket, keyfile, certfile), which takes a socket +object and returns an SSL socket. The httplib and urllib modules +were also changed to support https:// URLs, though no one has implemented +FTP or SMTP over SSL.

    +

    The httplib module has been rewritten by Greg Stein to support HTTP/1.1. +Backward compatibility with the 1.5 version of httplib is provided, +though using HTTP/1.1 features such as pipelining will require rewriting code to +use a different set of interfaces.

    +

    The Tkinter module now supports Tcl/Tk version 8.1, 8.2, or 8.3, and +support for the older 7.x versions has been dropped. The Tkinter module now +supports displaying Unicode strings in Tk widgets. Also, Fredrik Lundh +contributed an optimization which makes operations like create_line and +create_polygon much faster, especially when using lots of coordinates.

    +

    The curses module has been greatly extended, starting from Oliver +Andrich’s enhanced version, to provide many additional functions from ncurses +and SYSV curses, such as colour, alternative character set support, pads, and +mouse support. This means the module is no longer compatible with operating +systems that only have BSD curses, but there don’t seem to be any currently +maintained OSes that fall into this category.

    +

    As mentioned in the earlier discussion of 2.0’s Unicode support, the underlying +implementation of the regular expressions provided by the re module has +been changed. SRE, a new regular expression engine written by Fredrik Lundh and +partially funded by Hewlett Packard, supports matching against both 8-bit +strings and Unicode strings.

    +
    +
    +

    New modules

    +

    A number of new modules were added. We’ll simply list them with brief +descriptions; consult the 2.0 documentation for the details of a particular +module.

    +
      +
    • atexit: For registering functions to be called before the Python +interpreter exits. Code that currently sets sys.exitfunc directly should be +changed to use the atexit module instead, importing atexit and +calling atexit.register() with the function to be called on exit. +(Contributed by Skip Montanaro.)

    • +
    • codecs, encodings, unicodedata: Added as part of the new +Unicode support.

    • +
    • filecmp: Supersedes the old cmp, cmpcache and +dircmp modules, which have now become deprecated. (Contributed by Gordon +MacMillan and Moshe Zadka.)

    • +
    • gettext: This module provides internationalization (I18N) and +localization (L10N) support for Python programs by providing an interface to the +GNU gettext message catalog library. (Integrated by Barry Warsaw, from separate +contributions by Martin von Löwis, Peter Funk, and James Henstridge.)

    • +
    • linuxaudiodev: Support for the /dev/audio device on Linux, a +twin to the existing sunaudiodev module. (Contributed by Peter Bosch, +with fixes by Jeremy Hylton.)

    • +
    • mmap: An interface to memory-mapped files on both Windows and Unix. A +file’s contents can be mapped directly into memory, at which point it behaves +like a mutable string, so its contents can be read and modified. They can even +be passed to functions that expect ordinary strings, such as the re +module. (Contributed by Sam Rushing, with some extensions by A.M. Kuchling.)

    • +
    • pyexpat: An interface to the Expat XML parser. (Contributed by Paul +Prescod.)

    • +
    • robotparser: Parse a robots.txt file, which is used for writing +Web spiders that politely avoid certain areas of a Web site. The parser accepts +the contents of a robots.txt file, builds a set of rules from it, and +can then answer questions about the fetchability of a given URL. (Contributed +by Skip Montanaro.)

    • +
    • tabnanny: A module/script to check Python source code for ambiguous +indentation. (Contributed by Tim Peters.)

    • +
    • UserString: A base class useful for deriving objects that behave like +strings.

    • +
    • webbrowser: A module that provides a platform independent way to launch +a web browser on a specific URL. For each platform, various browsers are tried +in a specific order. The user can alter which browser is launched by setting the +BROWSER environment variable. (Originally inspired by Eric S. Raymond’s patch +to urllib which added similar functionality, but the final module comes +from code originally implemented by Fred Drake as +Tools/idle/BrowserControl.py, and adapted for the standard library by +Fred.)

    • +
    • _winreg: An interface to the Windows registry. _winreg is an +adaptation of functions that have been part of PythonWin since 1995, but has now +been added to the core distribution, and enhanced to support Unicode. +_winreg was written by Bill Tutt and Mark Hammond.

    • +
    • zipfile: A module for reading and writing ZIP-format archives. These +are archives produced by PKZIP on DOS/Windows or zip on +Unix, not to be confused with gzip-format files (which are +supported by the gzip module) (Contributed by James C. Ahlstrom.)

    • +
    • imputil: A module that provides a simpler way for writing customized +import hooks, in comparison to the existing ihooks module. (Implemented +by Greg Stein, with much discussion on python-dev along the way.)

    • +
    +
    +
    +

    IDLE Improvements

    +

    IDLE is the official Python cross-platform IDE, written using Tkinter. Python +2.0 includes IDLE 0.6, which adds a number of new features and improvements. A +partial list:

    +
      +
    • UI improvements and optimizations, especially in the area of syntax +highlighting and auto-indentation.

    • +
    • The class browser now shows more information, such as the top level functions +in a module.

    • +
    • Tab width is now a user settable option. When opening an existing Python file, +IDLE automatically detects the indentation conventions, and adapts.

    • +
    • There is now support for calling browsers on various platforms, used to open +the Python documentation in a browser.

    • +
    • IDLE now has a command line, which is largely similar to the vanilla Python +interpreter.

    • +
    • Call tips were added in many places.

    • +
    • IDLE can now be installed as a package.

    • +
    • In the editor window, there is now a line/column bar at the bottom.

    • +
    • Three new keystroke commands: Check module (Alt-F5), Import module (F5) and +Run script (Ctrl-F5).

    • +
    +
    +
    +

    Deleted and Deprecated Modules

    +

    A few modules have been dropped because they’re obsolete, or because there are +now better ways to do the same thing. The stdwin module is gone; it was +for a platform-independent windowing toolkit that’s no longer developed.

    +

    A number of modules have been moved to the lib-old subdirectory: +cmp, cmpcache, dircmp, dump, find, +grep, packmail, poly, util, whatsound, +zmod. If you have code which relies on a module that’s been moved to +lib-old, you can simply add that directory to sys.path to get them +back, but you’re encouraged to update any code that uses these modules.

    +
    +
    +

    Acknowledgements

    +

    The authors would like to thank the following people for offering suggestions on +various drafts of this article: David Bolen, Mark Hammond, Gregg Hauser, Jeremy +Hylton, Fredrik Lundh, Detlef Lannert, Aahz Maruch, Skip Montanaro, Vladimir +Marangozov, Tobias Polzin, Guido van Rossum, Neil Schemenauer, and Russ Schmidt.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/whatsnew/2.1.html b/python-3.7.4-docs-html/whatsnew/2.1.html new file mode 100644 index 0000000..5f964c6 --- /dev/null +++ b/python-3.7.4-docs-html/whatsnew/2.1.html @@ -0,0 +1,913 @@ + + + + + + + What’s New in Python 2.1 — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    What’s New in Python 2.1

    +
    +
    Author
    +

    A.M. Kuchling

    +
    +
    +
    +

    Introduction

    +

    This article explains the new features in Python 2.1. While there aren’t as +many changes in 2.1 as there were in Python 2.0, there are still some pleasant +surprises in store. 2.1 is the first release to be steered through the use of +Python Enhancement Proposals, or PEPs, so most of the sizable changes have +accompanying PEPs that provide more complete documentation and a design +rationale for the change. This article doesn’t attempt to document the new +features completely, but simply provides an overview of the new features for +Python programmers. Refer to the Python 2.1 documentation, or to the specific +PEP, for more details about any new feature that particularly interests you.

    +

    One recent goal of the Python development team has been to accelerate the pace +of new releases, with a new release coming every 6 to 9 months. 2.1 is the first +release to come out at this faster pace, with the first alpha appearing in +January, 3 months after the final version of 2.0 was released.

    +

    The final release of Python 2.1 was made on April 17, 2001.

    +
    +
    +

    PEP 227: Nested Scopes

    +

    The largest change in Python 2.1 is to Python’s scoping rules. In Python 2.0, +at any given time there are at most three namespaces used to look up variable +names: local, module-level, and the built-in namespace. This often surprised +people because it didn’t match their intuitive expectations. For example, a +nested recursive function definition doesn’t work:

    +
    def f():
    +    ...
    +    def g(value):
    +        ...
    +        return g(value-1) + 1
    +    ...
    +
    +
    +

    The function g() will always raise a NameError exception, because +the binding of the name g isn’t in either its local namespace or in the +module-level namespace. This isn’t much of a problem in practice (how often do +you recursively define interior functions like this?), but this also made using +the lambda expression clumsier, and this was a problem in practice. +In code which uses lambda you can often find local variables being +copied by passing them as the default values of arguments.

    +
    def find(self, name):
    +    "Return list of any entries equal to 'name'"
    +    L = filter(lambda x, name=name: x == name,
    +               self.list_attribute)
    +    return L
    +
    +
    +

    The readability of Python code written in a strongly functional style suffers +greatly as a result.

    +

    The most significant change to Python 2.1 is that static scoping has been added +to the language to fix this problem. As a first effect, the name=name +default argument is now unnecessary in the above example. Put simply, when a +given variable name is not assigned a value within a function (by an assignment, +or the def, class, or import statements), +references to the variable will be looked up in the local namespace of the +enclosing scope. A more detailed explanation of the rules, and a dissection of +the implementation, can be found in the PEP.

    +

    This change may cause some compatibility problems for code where the same +variable name is used both at the module level and as a local variable within a +function that contains further function definitions. This seems rather unlikely +though, since such code would have been pretty confusing to read in the first +place.

    +

    One side effect of the change is that the from module import * and +exec statements have been made illegal inside a function scope under +certain conditions. The Python reference manual has said all along that from +module import * is only legal at the top level of a module, but the CPython +interpreter has never enforced this before. As part of the implementation of +nested scopes, the compiler which turns Python source into bytecodes has to +generate different code to access variables in a containing scope. from +module import * and exec make it impossible for the compiler to +figure this out, because they add names to the local namespace that are +unknowable at compile time. Therefore, if a function contains function +definitions or lambda expressions with free variables, the compiler +will flag this by raising a SyntaxError exception.

    +

    To make the preceding explanation a bit clearer, here’s an example:

    +
    x = 1
    +def f():
    +    # The next line is a syntax error
    +    exec 'x=2'
    +    def g():
    +        return x
    +
    +
    +

    Line 4 containing the exec statement is a syntax error, since +exec would define a new local variable named x whose value should +be accessed by g().

    +

    This shouldn’t be much of a limitation, since exec is rarely used in +most Python code (and when it is used, it’s often a sign of a poor design +anyway).

    +

    Compatibility concerns have led to nested scopes being introduced gradually; in +Python 2.1, they aren’t enabled by default, but can be turned on within a module +by using a future statement as described in PEP 236. (See the following section +for further discussion of PEP 236.) In Python 2.2, nested scopes will become +the default and there will be no way to turn them off, but users will have had +all of 2.1’s lifetime to fix any breakage resulting from their introduction.

    +
    +

    See also

    +
    +
    PEP 227 - Statically Nested Scopes

    Written and implemented by Jeremy Hylton.

    +
    +
    +
    +
    +
    +

    PEP 236: __future__ Directives

    +

    The reaction to nested scopes was widespread concern about the dangers of +breaking code with the 2.1 release, and it was strong enough to make the +Pythoneers take a more conservative approach. This approach consists of +introducing a convention for enabling optional functionality in release N that +will become compulsory in release N+1.

    +

    The syntax uses a from...import statement using the reserved module name +__future__. Nested scopes can be enabled by the following statement:

    +
    from __future__ import nested_scopes
    +
    +
    +

    While it looks like a normal import statement, it’s not; there are +strict rules on where such a future statement can be put. They can only be at +the top of a module, and must precede any Python code or regular +import statements. This is because such statements can affect how +the Python bytecode compiler parses code and generates bytecode, so they must +precede any statement that will result in bytecodes being produced.

    +
    +

    See also

    +
    +
    PEP 236 - Back to the __future__

    Written by Tim Peters, and primarily implemented by Jeremy Hylton.

    +
    +
    +
    +
    +
    +

    PEP 207: Rich Comparisons

    +

    In earlier versions, Python’s support for implementing comparisons on user-defined +classes and extension types was quite simple. Classes could implement a +__cmp__() method that was given two instances of a class, and could only +return 0 if they were equal or +1 or -1 if they weren’t; the method couldn’t +raise an exception or return anything other than a Boolean value. Users of +Numeric Python often found this model too weak and restrictive, because in the +number-crunching programs that numeric Python is used for, it would be more +useful to be able to perform elementwise comparisons of two matrices, returning +a matrix containing the results of a given comparison for each element. If the +two matrices are of different sizes, then the compare has to be able to raise an +exception to signal the error.

    +

    In Python 2.1, rich comparisons were added in order to support this need. +Python classes can now individually overload each of the <, <=, >, +>=, ==, and != operations. The new magic method names are:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + +

    Operation

    Method name

    <

    __lt__()

    <=

    __le__()

    >

    __gt__()

    >=

    __ge__()

    ==

    __eq__()

    !=

    __ne__()

    +

    (The magic methods are named after the corresponding Fortran operators .LT.. +.LE., &c. Numeric programmers are almost certainly quite familiar with +these names and will find them easy to remember.)

    +

    Each of these magic methods is of the form method(self, other), where +self will be the object on the left-hand side of the operator, while +other will be the object on the right-hand side. For example, the +expression A < B will cause A.__lt__(B) to be called.

    +

    Each of these magic methods can return anything at all: a Boolean, a matrix, a +list, or any other Python object. Alternatively they can raise an exception if +the comparison is impossible, inconsistent, or otherwise meaningless.

    +

    The built-in cmp(A,B) function can use the rich comparison machinery, +and now accepts an optional argument specifying which comparison operation to +use; this is given as one of the strings "<", "<=", ">", ">=", +"==", or "!=". If called without the optional third argument, +cmp() will only return -1, 0, or +1 as in previous versions of Python; +otherwise it will call the appropriate method and can return any Python object.

    +

    There are also corresponding changes of interest to C programmers; there’s a new +slot tp_richcmp in type objects and an API for performing a given rich +comparison. I won’t cover the C API here, but will refer you to PEP 207, or to +2.1’s C API documentation, for the full list of related functions.

    +
    +

    See also

    +
    +
    PEP 207 - Rich Comparisons

    Written by Guido van Rossum, heavily based on earlier work by David Ascher, and +implemented by Guido van Rossum.

    +
    +
    +
    +
    +
    +

    PEP 230: Warning Framework

    +

    Over its 10 years of existence, Python has accumulated a certain number of +obsolete modules and features along the way. It’s difficult to know when a +feature is safe to remove, since there’s no way of knowing how much code uses it +— perhaps no programs depend on the feature, or perhaps many do. To enable +removing old features in a more structured way, a warning framework was added. +When the Python developers want to get rid of a feature, it will first trigger a +warning in the next version of Python. The following Python version can then +drop the feature, and users will have had a full release cycle to remove uses of +the old feature.

    +

    Python 2.1 adds the warning framework to be used in this scheme. It adds a +warnings module that provide functions to issue warnings, and to filter +out warnings that you don’t want to be displayed. Third-party modules can also +use this framework to deprecate old features that they no longer wish to +support.

    +

    For example, in Python 2.1 the regex module is deprecated, so importing +it causes a warning to be printed:

    +
    >>> import regex
    +__main__:1: DeprecationWarning: the regex module
    +         is deprecated; please use the re module
    +>>>
    +
    +
    +

    Warnings can be issued by calling the warnings.warn() function:

    +
    warnings.warn("feature X no longer supported")
    +
    +
    +

    The first parameter is the warning message; an additional optional parameters +can be used to specify a particular warning category.

    +

    Filters can be added to disable certain warnings; a regular expression pattern +can be applied to the message or to the module name in order to suppress a +warning. For example, you may have a program that uses the regex module +and not want to spare the time to convert it to use the re module right +now. The warning can be suppressed by calling

    +
    import warnings
    +warnings.filterwarnings(action = 'ignore',
    +                        message='.*regex module is deprecated',
    +                        category=DeprecationWarning,
    +                        module = '__main__')
    +
    +
    +

    This adds a filter that will apply only to warnings of the class +DeprecationWarning triggered in the __main__ module, and applies +a regular expression to only match the message about the regex module +being deprecated, and will cause such warnings to be ignored. Warnings can also +be printed only once, printed every time the offending code is executed, or +turned into exceptions that will cause the program to stop (unless the +exceptions are caught in the usual way, of course).

    +

    Functions were also added to Python’s C API for issuing warnings; refer to PEP +230 or to Python’s API documentation for the details.

    +
    +

    See also

    +
    +
    PEP 5 - Guidelines for Language Evolution

    Written by Paul Prescod, to specify procedures to be followed when removing old +features from Python. The policy described in this PEP hasn’t been officially +adopted, but the eventual policy probably won’t be too different from Prescod’s +proposal.

    +
    +
    PEP 230 - Warning Framework

    Written and implemented by Guido van Rossum.

    +
    +
    +
    +
    +
    +

    PEP 229: New Build System

    +

    When compiling Python, the user had to go in and edit the Modules/Setup +file in order to enable various additional modules; the default set is +relatively small and limited to modules that compile on most Unix platforms. +This means that on Unix platforms with many more features, most notably Linux, +Python installations often don’t contain all useful modules they could.

    +

    Python 2.0 added the Distutils, a set of modules for distributing and installing +extensions. In Python 2.1, the Distutils are used to compile much of the +standard library of extension modules, autodetecting which ones are supported on +the current machine. It’s hoped that this will make Python installations easier +and more featureful.

    +

    Instead of having to edit the Modules/Setup file in order to enable +modules, a setup.py script in the top directory of the Python source +distribution is run at build time, and attempts to discover which modules can be +enabled by examining the modules and header files on the system. If a module is +configured in Modules/Setup, the setup.py script won’t attempt +to compile that module and will defer to the Modules/Setup file’s +contents. This provides a way to specific any strange command-line flags or +libraries that are required for a specific platform.

    +

    In another far-reaching change to the build mechanism, Neil Schemenauer +restructured things so Python now uses a single makefile that isn’t recursive, +instead of makefiles in the top directory and in each of the Python/, +Parser/, Objects/, and Modules/ subdirectories. This +makes building Python faster and also makes hacking the Makefiles clearer and +simpler.

    +
    +

    See also

    +
    +
    PEP 229 - Using Distutils to Build Python

    Written and implemented by A.M. Kuchling.

    +
    +
    +
    +
    +
    +

    PEP 205: Weak References

    +

    Weak references, available through the weakref module, are a minor but +useful new data type in the Python programmer’s toolbox.

    +

    Storing a reference to an object (say, in a dictionary or a list) has the side +effect of keeping that object alive forever. There are a few specific cases +where this behaviour is undesirable, object caches being the most common one, +and another being circular references in data structures such as trees.

    +

    For example, consider a memoizing function that caches the results of another +function f(x) by storing the function’s argument and its result in a +dictionary:

    +
    _cache = {}
    +def memoize(x):
    +    if _cache.has_key(x):
    +        return _cache[x]
    +
    +    retval = f(x)
    +
    +    # Cache the returned object
    +    _cache[x] = retval
    +
    +    return retval
    +
    +
    +

    This version works for simple things such as integers, but it has a side effect; +the _cache dictionary holds a reference to the return values, so they’ll +never be deallocated until the Python process exits and cleans up. This isn’t +very noticeable for integers, but if f() returns an object, or a data +structure that takes up a lot of memory, this can be a problem.

    +

    Weak references provide a way to implement a cache that won’t keep objects alive +beyond their time. If an object is only accessible through weak references, the +object will be deallocated and the weak references will now indicate that the +object it referred to no longer exists. A weak reference to an object obj is +created by calling wr = weakref.ref(obj). The object being referred to is +returned by calling the weak reference as if it were a function: wr(). It +will return the referenced object, or None if the object no longer exists.

    +

    This makes it possible to write a memoize() function whose cache doesn’t +keep objects alive, by storing weak references in the cache.

    +
    _cache = {}
    +def memoize(x):
    +    if _cache.has_key(x):
    +        obj = _cache[x]()
    +        # If weak reference object still exists,
    +        # return it
    +        if obj is not None: return obj
    +
    +    retval = f(x)
    +
    +    # Cache a weak reference
    +    _cache[x] = weakref.ref(retval)
    +
    +    return retval
    +
    +
    +

    The weakref module also allows creating proxy objects which behave like +weak references — an object referenced only by proxy objects is deallocated – +but instead of requiring an explicit call to retrieve the object, the proxy +transparently forwards all operations to the object as long as the object still +exists. If the object is deallocated, attempting to use a proxy will cause a +weakref.ReferenceError exception to be raised.

    +
    proxy = weakref.proxy(obj)
    +proxy.attr   # Equivalent to obj.attr
    +proxy.meth() # Equivalent to obj.meth()
    +del obj
    +proxy.attr   # raises weakref.ReferenceError
    +
    +
    +
    +

    See also

    +
    +
    PEP 205 - Weak References

    Written and implemented by Fred L. Drake, Jr.

    +
    +
    +
    +
    +
    +

    PEP 232: Function Attributes

    +

    In Python 2.1, functions can now have arbitrary information attached to them. +People were often using docstrings to hold information about functions and +methods, because the __doc__ attribute was the only way of attaching any +information to a function. For example, in the Zope Web application server, +functions are marked as safe for public access by having a docstring, and in +John Aycock’s SPARK parsing framework, docstrings hold parts of the BNF grammar +to be parsed. This overloading is unfortunate, since docstrings are really +intended to hold a function’s documentation; for example, it means you can’t +properly document functions intended for private use in Zope.

    +

    Arbitrary attributes can now be set and retrieved on functions using the regular +Python syntax:

    +
    def f(): pass
    +
    +f.publish = 1
    +f.secure = 1
    +f.grammar = "A ::= B (C D)*"
    +
    +
    +

    The dictionary containing attributes can be accessed as the function’s +__dict__. Unlike the __dict__ attribute of class instances, in +functions you can actually assign a new dictionary to __dict__, though +the new value is restricted to a regular Python dictionary; you can’t be +tricky and set it to a UserDict instance, or any other random object +that behaves like a mapping.

    +
    +

    See also

    +
    +
    PEP 232 - Function Attributes

    Written and implemented by Barry Warsaw.

    +
    +
    +
    +
    +
    +

    PEP 235: Importing Modules on Case-Insensitive Platforms

    +

    Some operating systems have filesystems that are case-insensitive, MacOS and +Windows being the primary examples; on these systems, it’s impossible to +distinguish the filenames FILE.PY and file.py, even though they do store +the file’s name in its original case (they’re case-preserving, too).

    +

    In Python 2.1, the import statement will work to simulate case-sensitivity +on case-insensitive platforms. Python will now search for the first +case-sensitive match by default, raising an ImportError if no such file +is found, so import file will not import a module named FILE.PY. +Case-insensitive matching can be requested by setting the PYTHONCASEOK +environment variable before starting the Python interpreter.

    +
    +
    +

    PEP 217: Interactive Display Hook

    +

    When using the Python interpreter interactively, the output of commands is +displayed using the built-in repr() function. In Python 2.1, the variable +sys.displayhook() can be set to a callable object which will be called +instead of repr(). For example, you can set it to a special +pretty-printing function:

    +
    >>> # Create a recursive data structure
    +... L = [1,2,3]
    +>>> L.append(L)
    +>>> L # Show Python's default output
    +[1, 2, 3, [...]]
    +>>> # Use pprint.pprint() as the display function
    +... import sys, pprint
    +>>> sys.displayhook = pprint.pprint
    +>>> L
    +[1, 2, 3,  <Recursion on list with id=135143996>]
    +>>>
    +
    +
    +
    +

    See also

    +
    +
    PEP 217 - Display Hook for Interactive Use

    Written and implemented by Moshe Zadka.

    +
    +
    +
    +
    +
    +

    PEP 208: New Coercion Model

    +

    How numeric coercion is done at the C level was significantly modified. This +will only affect the authors of C extensions to Python, allowing them more +flexibility in writing extension types that support numeric operations.

    +

    Extension types can now set the type flag Py_TPFLAGS_CHECKTYPES in their +PyTypeObject structure to indicate that they support the new coercion model. +In such extension types, the numeric slot functions can no longer assume that +they’ll be passed two arguments of the same type; instead they may be passed two +arguments of differing types, and can then perform their own internal coercion. +If the slot function is passed a type it can’t handle, it can indicate the +failure by returning a reference to the Py_NotImplemented singleton value. +The numeric functions of the other type will then be tried, and perhaps they can +handle the operation; if the other type also returns Py_NotImplemented, then +a TypeError will be raised. Numeric methods written in Python can also +return Py_NotImplemented, causing the interpreter to act as if the method +did not exist (perhaps raising a TypeError, perhaps trying another +object’s numeric methods).

    +
    +

    See also

    +
    +
    PEP 208 - Reworking the Coercion Model

    Written and implemented by Neil Schemenauer, heavily based upon earlier work by +Marc-André Lemburg. Read this to understand the fine points of how numeric +operations will now be processed at the C level.

    +
    +
    +
    +
    +
    +

    PEP 241: Metadata in Python Packages

    +

    A common complaint from Python users is that there’s no single catalog of all +the Python modules in existence. T. Middleton’s Vaults of Parnassus at +http://www.vex.net/parnassus/ are the largest catalog of Python modules, but +registering software at the Vaults is optional, and many people don’t bother.

    +

    As a first small step toward fixing the problem, Python software packaged using +the Distutils sdist command will include a file named +PKG-INFO containing information about the package such as its name, +version, and author (metadata, in cataloguing terminology). PEP 241 contains +the full list of fields that can be present in the PKG-INFO file. As +people began to package their software using Python 2.1, more and more packages +will include metadata, making it possible to build automated cataloguing systems +and experiment with them. With the result experience, perhaps it’ll be possible +to design a really good catalog and then build support for it into Python 2.2. +For example, the Distutils sdist and bdist_* commands +could support an upload option that would automatically upload your +package to a catalog server.

    +

    You can start creating packages containing PKG-INFO even if you’re not +using Python 2.1, since a new release of the Distutils will be made for users of +earlier Python versions. Version 1.0.2 of the Distutils includes the changes +described in PEP 241, as well as various bugfixes and enhancements. It will be +available from the Distutils SIG at https://www.python.org/community/sigs/current/distutils-sig/.

    +
    +

    See also

    +
    +
    PEP 241 - Metadata for Python Software Packages

    Written and implemented by A.M. Kuchling.

    +
    +
    PEP 243 - Module Repository Upload Mechanism

    Written by Sean Reifschneider, this draft PEP describes a proposed mechanism for +uploading Python packages to a central server.

    +
    +
    +
    +
    +
    +

    New and Improved Modules

    +
      +
    • Ka-Ping Yee contributed two new modules: inspect.py, a module for +getting information about live Python code, and pydoc.py, a module for +interactively converting docstrings to HTML or text. As a bonus, +Tools/scripts/pydoc, which is now automatically installed, uses +pydoc.py to display documentation given a Python module, package, or +class name. For example, pydoc xml.dom displays the following:

      +
      Python Library Documentation: package xml.dom in xml
      +
      +NAME
      +    xml.dom - W3C Document Object Model implementation for Python.
      +
      +FILE
      +    /usr/local/lib/python2.1/xml/dom/__init__.pyc
      +
      +DESCRIPTION
      +    The Python mapping of the Document Object Model is documented in the
      +    Python Library Reference in the section on the xml.dom package.
      +
      +    This package contains the following modules:
      +      ...
      +
      +
      +

      pydoc also includes a Tk-based interactive help browser. pydoc +quickly becomes addictive; try it out!

      +
    • +
    • Two different modules for unit testing were added to the standard library. +The doctest module, contributed by Tim Peters, provides a testing +framework based on running embedded examples in docstrings and comparing the +results against the expected output. PyUnit, contributed by Steve Purcell, is a +unit testing framework inspired by JUnit, which was in turn an adaptation of +Kent Beck’s Smalltalk testing framework. See http://pyunit.sourceforge.net/ for +more information about PyUnit.

    • +
    • The difflib module contains a class, SequenceMatcher, which +compares two sequences and computes the changes required to transform one +sequence into the other. For example, this module can be used to write a tool +similar to the Unix diff program, and in fact the sample program +Tools/scripts/ndiff.py demonstrates how to write such a script.

    • +
    • curses.panel, a wrapper for the panel library, part of ncurses and of +SYSV curses, was contributed by Thomas Gellekum. The panel library provides +windows with the additional feature of depth. Windows can be moved higher or +lower in the depth ordering, and the panel library figures out where panels +overlap and which sections are visible.

    • +
    • The PyXML package has gone through a few releases since Python 2.0, and Python +2.1 includes an updated version of the xml package. Some of the +noteworthy changes include support for Expat 1.2 and later versions, the ability +for Expat parsers to handle files in any encoding supported by Python, and +various bugfixes for SAX, DOM, and the minidom module.

    • +
    • Ping also contributed another hook for handling uncaught exceptions. +sys.excepthook() can be set to a callable object. When an exception isn’t +caught by any tryexcept blocks, the exception will be +passed to sys.excepthook(), which can then do whatever it likes. At the +Ninth Python Conference, Ping demonstrated an application for this hook: +printing an extended traceback that not only lists the stack frames, but also +lists the function arguments and the local variables for each frame.

    • +
    • Various functions in the time module, such as asctime() and +localtime(), require a floating point argument containing the time in +seconds since the epoch. The most common use of these functions is to work with +the current time, so the floating point argument has been made optional; when a +value isn’t provided, the current time will be used. For example, log file +entries usually need a string containing the current time; in Python 2.1, +time.asctime() can be used, instead of the lengthier +time.asctime(time.localtime(time.time())) that was previously required.

      +

      This change was proposed and implemented by Thomas Wouters.

      +
    • +
    • The ftplib module now defaults to retrieving files in passive mode, +because passive mode is more likely to work from behind a firewall. This +request came from the Debian bug tracking system, since other Debian packages +use ftplib to retrieve files and then don’t work from behind a firewall. +It’s deemed unlikely that this will cause problems for anyone, because Netscape +defaults to passive mode and few people complain, but if passive mode is +unsuitable for your application or network setup, call set_pasv(0) on +FTP objects to disable passive mode.

    • +
    • Support for raw socket access has been added to the socket module, +contributed by Grant Edwards.

    • +
    • The pstats module now contains a simple interactive statistics browser +for displaying timing profiles for Python programs, invoked when the module is +run as a script. Contributed by Eric S. Raymond.

    • +
    • A new implementation-dependent function, sys._getframe([depth]), has +been added to return a given frame object from the current call stack. +sys._getframe() returns the frame at the top of the call stack; if the +optional integer argument depth is supplied, the function returns the frame +that is depth calls below the top of the stack. For example, +sys._getframe(1) returns the caller’s frame object.

      +

      This function is only present in CPython, not in Jython or the .NET +implementation. Use it for debugging, and resist the temptation to put it into +production code.

      +
    • +
    +
    +
    +

    Other Changes and Fixes

    +

    There were relatively few smaller changes made in Python 2.1 due to the shorter +release cycle. A search through the CVS change logs turns up 117 patches +applied, and 136 bugs fixed; both figures are likely to be underestimates. Some +of the more notable changes are:

    +
      +
    • A specialized object allocator is now optionally available, that should be +faster than the system malloc() and have less memory overhead. The +allocator uses C’s malloc() function to get large pools of memory, and +then fulfills smaller memory requests from these pools. It can be enabled by +providing the --with-pymalloc option to the configure +script; see Objects/obmalloc.c for the implementation details.

      +

      Authors of C extension modules should test their code with the object allocator +enabled, because some incorrect code may break, causing core dumps at runtime. +There are a bunch of memory allocation functions in Python’s C API that have +previously been just aliases for the C library’s malloc() and +free(), meaning that if you accidentally called mismatched functions, the +error wouldn’t be noticeable. When the object allocator is enabled, these +functions aren’t aliases of malloc() and free() any more, and +calling the wrong function to free memory will get you a core dump. For +example, if memory was allocated using PyMem_New(), it has to be freed +using PyMem_Del(), not free(). A few modules included with Python +fell afoul of this and had to be fixed; doubtless there are more third-party +modules that will have the same problem.

      +

      The object allocator was contributed by Vladimir Marangozov.

      +
    • +
    • The speed of line-oriented file I/O has been improved because people often +complain about its lack of speed, and because it’s often been used as a naïve +benchmark. The readline() method of file objects has therefore been +rewritten to be much faster. The exact amount of the speedup will vary from +platform to platform depending on how slow the C library’s getc() was, but +is around 66%, and potentially much faster on some particular operating systems. +Tim Peters did much of the benchmarking and coding for this change, motivated by +a discussion in comp.lang.python.

      +

      A new module and method for file objects was also added, contributed by Jeff +Epler. The new method, xreadlines(), is similar to the existing +xrange() built-in. xreadlines() returns an opaque sequence object +that only supports being iterated over, reading a line on every iteration but +not reading the entire file into memory as the existing readlines() method +does. You’d use it like this:

      +
      for line in sys.stdin.xreadlines():
      +    # ... do something for each line ...
      +    ...
      +
      +
      +

      For a fuller discussion of the line I/O changes, see the python-dev summary for +January 1–15, 2001 at https://mail.python.org/pipermail/python-dev/2001-January/.

      +
    • +
    • A new method, popitem(), was added to dictionaries to enable +destructively iterating through the contents of a dictionary; this can be faster +for large dictionaries because there’s no need to construct a list containing +all the keys or values. D.popitem() removes a random (key, value) pair +from the dictionary D and returns it as a 2-tuple. This was implemented +mostly by Tim Peters and Guido van Rossum, after a suggestion and preliminary +patch by Moshe Zadka.

    • +
    • Modules can now control which names are imported when from module import * +is used, by defining an __all__ attribute containing a list of names that +will be imported. One common complaint is that if the module imports other +modules such as sys or string, from module import * will add +them to the importing module’s namespace. To fix this, simply list the public +names in __all__:

      +
      # List public names
      +__all__ = ['Database', 'open']
      +
      +
      +

      A stricter version of this patch was first suggested and implemented by Ben +Wolfson, but after some python-dev discussion, a weaker final version was +checked in.

      +
    • +
    • Applying repr() to strings previously used octal escapes for +non-printable characters; for example, a newline was '\012'. This was a +vestigial trace of Python’s C ancestry, but today octal is of very little +practical use. Ka-Ping Yee suggested using hex escapes instead of octal ones, +and using the \n, \t, \r escapes for the appropriate characters, +and implemented this new formatting.

    • +
    • Syntax errors detected at compile-time can now raise exceptions containing the +filename and line number of the error, a pleasant side effect of the compiler +reorganization done by Jeremy Hylton.

    • +
    • C extensions which import other modules have been changed to use +PyImport_ImportModule(), which means that they will use any import hooks +that have been installed. This is also encouraged for third-party extensions +that need to import some other module from C code.

    • +
    • The size of the Unicode character database was shrunk by another 340K thanks +to Fredrik Lundh.

    • +
    • Some new ports were contributed: MacOS X (by Steven Majewski), Cygwin (by +Jason Tishler); RISCOS (by Dietmar Schwertberger); Unixware 7 (by Billy G. +Allie).

    • +
    +

    And there’s the usual list of minor bugfixes, minor memory leaks, docstring +edits, and other tweaks, too lengthy to be worth itemizing; see the CVS logs for +the full details if you want them.

    +
    +
    +

    Acknowledgements

    +

    The author would like to thank the following people for offering suggestions on +various drafts of this article: Graeme Cross, David Goodger, Jay Graves, Michael +Hudson, Marc-André Lemburg, Fredrik Lundh, Neil Schemenauer, Thomas Wouters.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/whatsnew/2.2.html b/python-3.7.4-docs-html/whatsnew/2.2.html new file mode 100644 index 0000000..20129bf --- /dev/null +++ b/python-3.7.4-docs-html/whatsnew/2.2.html @@ -0,0 +1,1303 @@ + + + + + + + What’s New in Python 2.2 — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    What’s New in Python 2.2

    +
    +
    Author
    +

    A.M. Kuchling

    +
    +
    +
    +

    Introduction

    +

    This article explains the new features in Python 2.2.2, released on October 14, +2002. Python 2.2.2 is a bugfix release of Python 2.2, originally released on +December 21, 2001.

    +

    Python 2.2 can be thought of as the “cleanup release”. There are some features +such as generators and iterators that are completely new, but most of the +changes, significant and far-reaching though they may be, are aimed at cleaning +up irregularities and dark corners of the language design.

    +

    This article doesn’t attempt to provide a complete specification of the new +features, but instead provides a convenient overview. For full details, you +should refer to the documentation for Python 2.2, such as the Python Library +Reference and the Python +Reference Manual. If you want to +understand the complete implementation and design rationale for a change, refer +to the PEP for a particular new feature.

    +
    +
    +

    PEPs 252 and 253: Type and Class Changes

    +

    The largest and most far-reaching changes in Python 2.2 are to Python’s model of +objects and classes. The changes should be backward compatible, so it’s likely +that your code will continue to run unchanged, but the changes provide some +amazing new capabilities. Before beginning this, the longest and most +complicated section of this article, I’ll provide an overview of the changes and +offer some comments.

    +

    A long time ago I wrote a Web page listing flaws in Python’s design. One of the +most significant flaws was that it’s impossible to subclass Python types +implemented in C. In particular, it’s not possible to subclass built-in types, +so you can’t just subclass, say, lists in order to add a single useful method to +them. The UserList module provides a class that supports all of the +methods of lists and that can be subclassed further, but there’s lots of C code +that expects a regular Python list and won’t accept a UserList +instance.

    +

    Python 2.2 fixes this, and in the process adds some exciting new capabilities. +A brief summary:

    +
      +
    • You can subclass built-in types such as lists and even integers, and your +subclasses should work in every place that requires the original type.

    • +
    • It’s now possible to define static and class methods, in addition to the +instance methods available in previous versions of Python.

    • +
    • It’s also possible to automatically call methods on accessing or setting an +instance attribute by using a new mechanism called properties. Many uses +of __getattr__() can be rewritten to use properties instead, making the +resulting code simpler and faster. As a small side benefit, attributes can now +have docstrings, too.

    • +
    • The list of legal attributes for an instance can be limited to a particular +set using slots, making it possible to safeguard against typos and +perhaps make more optimizations possible in future versions of Python.

    • +
    +

    Some users have voiced concern about all these changes. Sure, they say, the new +features are neat and lend themselves to all sorts of tricks that weren’t +possible in previous versions of Python, but they also make the language more +complicated. Some people have said that they’ve always recommended Python for +its simplicity, and feel that its simplicity is being lost.

    +

    Personally, I think there’s no need to worry. Many of the new features are +quite esoteric, and you can write a lot of Python code without ever needed to be +aware of them. Writing a simple class is no more difficult than it ever was, so +you don’t need to bother learning or teaching them unless they’re actually +needed. Some very complicated tasks that were previously only possible from C +will now be possible in pure Python, and to my mind that’s all for the better.

    +

    I’m not going to attempt to cover every single corner case and small change that +were required to make the new features work. Instead this section will paint +only the broad strokes. See section Related Links, “Related Links”, for +further sources of information about Python 2.2’s new object model.

    +
    +

    Old and New Classes

    +

    First, you should know that Python 2.2 really has two kinds of classes: classic +or old-style classes, and new-style classes. The old-style class model is +exactly the same as the class model in earlier versions of Python. All the new +features described in this section apply only to new-style classes. This +divergence isn’t intended to last forever; eventually old-style classes will be +dropped, possibly in Python 3.0.

    +

    So how do you define a new-style class? You do it by subclassing an existing +new-style class. Most of Python’s built-in types, such as integers, lists, +dictionaries, and even files, are new-style classes now. A new-style class +named object, the base class for all built-in types, has also been +added so if no built-in type is suitable, you can just subclass +object:

    +
    class C(object):
    +    def __init__ (self):
    +        ...
    +    ...
    +
    +
    +

    This means that class statements that don’t have any base classes are +always classic classes in Python 2.2. (Actually you can also change this by +setting a module-level variable named __metaclass__ — see PEP 253 +for the details — but it’s easier to just subclass object.)

    +

    The type objects for the built-in types are available as built-ins, named using +a clever trick. Python has always had built-in functions named int(), +float(), and str(). In 2.2, they aren’t functions any more, but +type objects that behave as factories when called.

    +
    >>> int
    +<type 'int'>
    +>>> int('123')
    +123
    +
    +
    +

    To make the set of types complete, new type objects such as dict() and +file() have been added. Here’s a more interesting example, adding a +lock() method to file objects:

    +
    class LockableFile(file):
    +    def lock (self, operation, length=0, start=0, whence=0):
    +        import fcntl
    +        return fcntl.lockf(self.fileno(), operation,
    +                           length, start, whence)
    +
    +
    +

    The now-obsolete posixfile module contained a class that emulated all of +a file object’s methods and also added a lock() method, but this class +couldn’t be passed to internal functions that expected a built-in file, +something which is possible with our new LockableFile.

    +
    +
    +

    Descriptors

    +

    In previous versions of Python, there was no consistent way to discover what +attributes and methods were supported by an object. There were some informal +conventions, such as defining __members__ and __methods__ +attributes that were lists of names, but often the author of an extension type +or a class wouldn’t bother to define them. You could fall back on inspecting +the __dict__ of an object, but when class inheritance or an arbitrary +__getattr__() hook were in use this could still be inaccurate.

    +

    The one big idea underlying the new class model is that an API for describing +the attributes of an object using descriptors has been formalized. +Descriptors specify the value of an attribute, stating whether it’s a method or +a field. With the descriptor API, static methods and class methods become +possible, as well as more exotic constructs.

    +

    Attribute descriptors are objects that live inside class objects, and have a few +attributes of their own:

    +
      +
    • __name__ is the attribute’s name.

    • +
    • __doc__ is the attribute’s docstring.

    • +
    • __get__(object) is a method that retrieves the attribute value from +object.

    • +
    • __set__(object, value) sets the attribute on object to value.

    • +
    • __delete__(object, value) deletes the value attribute of object.

    • +
    +

    For example, when you write obj.x, the steps that Python actually performs +are:

    +
    descriptor = obj.__class__.x
    +descriptor.__get__(obj)
    +
    +
    +

    For methods, descriptor.__get__() returns a temporary object that’s +callable, and wraps up the instance and the method to be called on it. This is +also why static methods and class methods are now possible; they have +descriptors that wrap up just the method, or the method and the class. As a +brief explanation of these new kinds of methods, static methods aren’t passed +the instance, and therefore resemble regular functions. Class methods are +passed the class of the object, but not the object itself. Static and class +methods are defined like this:

    +
    class C(object):
    +    def f(arg1, arg2):
    +        ...
    +    f = staticmethod(f)
    +
    +    def g(cls, arg1, arg2):
    +        ...
    +    g = classmethod(g)
    +
    +
    +

    The staticmethod() function takes the function f(), and returns it +wrapped up in a descriptor so it can be stored in the class object. You might +expect there to be special syntax for creating such methods (def static f, +defstatic f(), or something like that) but no such syntax has been defined +yet; that’s been left for future versions of Python.

    +

    More new features, such as slots and properties, are also implemented as new +kinds of descriptors, and it’s not difficult to write a descriptor class that +does something novel. For example, it would be possible to write a descriptor +class that made it possible to write Eiffel-style preconditions and +postconditions for a method. A class that used this feature might be defined +like this:

    +
    from eiffel import eiffelmethod
    +
    +class C(object):
    +    def f(self, arg1, arg2):
    +        # The actual function
    +        ...
    +    def pre_f(self):
    +        # Check preconditions
    +        ...
    +    def post_f(self):
    +        # Check postconditions
    +        ...
    +
    +    f = eiffelmethod(f, pre_f, post_f)
    +
    +
    +

    Note that a person using the new eiffelmethod() doesn’t have to understand +anything about descriptors. This is why I think the new features don’t increase +the basic complexity of the language. There will be a few wizards who need to +know about it in order to write eiffelmethod() or the ZODB or whatever, +but most users will just write code on top of the resulting libraries and ignore +the implementation details.

    +
    +
    +

    Multiple Inheritance: The Diamond Rule

    +

    Multiple inheritance has also been made more useful through changing the rules +under which names are resolved. Consider this set of classes (diagram taken +from PEP 253 by Guido van Rossum):

    +
          class A:
    +        ^ ^  def save(self): ...
    +       /   \
    +      /     \
    +     /       \
    +    /         \
    +class B     class C:
    +    ^         ^  def save(self): ...
    +     \       /
    +      \     /
    +       \   /
    +        \ /
    +      class D
    +
    +
    +

    The lookup rule for classic classes is simple but not very smart; the base +classes are searched depth-first, going from left to right. A reference to +D.save() will search the classes D, B, and then +A, where save() would be found and returned. C.save() +would never be found at all. This is bad, because if C’s save() +method is saving some internal state specific to C, not calling it will +result in that state never getting saved.

    +

    New-style classes follow a different algorithm that’s a bit more complicated to +explain, but does the right thing in this situation. (Note that Python 2.3 +changes this algorithm to one that produces the same results in most cases, but +produces more useful results for really complicated inheritance graphs.)

    +
      +
    1. List all the base classes, following the classic lookup rule and include a +class multiple times if it’s visited repeatedly. In the above example, the list +of visited classes is [D, B, A, C, +A].

    2. +
    3. Scan the list for duplicated classes. If any are found, remove all but one +occurrence, leaving the last one in the list. In the above example, the list +becomes [D, B, C, A] after dropping +duplicates.

    4. +
    +

    Following this rule, referring to D.save() will return C.save(), +which is the behaviour we’re after. This lookup rule is the same as the one +followed by Common Lisp. A new built-in function, super(), provides a way +to get at a class’s superclasses without having to reimplement Python’s +algorithm. The most commonly used form will be super(class, obj), which +returns a bound superclass object (not the actual class object). This form +will be used in methods to call a method in the superclass; for example, +D’s save() method would look like this:

    +
    class D (B,C):
    +    def save (self):
    +        # Call superclass .save()
    +        super(D, self).save()
    +        # Save D's private information here
    +        ...
    +
    +
    +

    super() can also return unbound superclass objects when called as +super(class) or super(class1, class2), but this probably won’t +often be useful.

    +
    +
    +

    Attribute Access

    +

    A fair number of sophisticated Python classes define hooks for attribute access +using __getattr__(); most commonly this is done for convenience, to make +code more readable by automatically mapping an attribute access such as +obj.parent into a method call such as obj.get_parent. Python 2.2 adds +some new ways of controlling attribute access.

    +

    First, __getattr__(attr_name) is still supported by new-style classes, +and nothing about it has changed. As before, it will be called when an attempt +is made to access obj.foo and no attribute named foo is found in the +instance’s dictionary.

    +

    New-style classes also support a new method, +__getattribute__(attr_name). The difference between the two methods is +that __getattribute__() is always called whenever any attribute is +accessed, while the old __getattr__() is only called if foo isn’t +found in the instance’s dictionary.

    +

    However, Python 2.2’s support for properties will often be a simpler way +to trap attribute references. Writing a __getattr__() method is +complicated because to avoid recursion you can’t use regular attribute accesses +inside them, and instead have to mess around with the contents of +__dict__. __getattr__() methods also end up being called by Python +when it checks for other methods such as __repr__() or __coerce__(), +and so have to be written with this in mind. Finally, calling a function on +every attribute access results in a sizable performance loss.

    +

    property is a new built-in type that packages up three functions that +get, set, or delete an attribute, and a docstring. For example, if you want to +define a size attribute that’s computed, but also settable, you could +write:

    +
    class C(object):
    +    def get_size (self):
    +        result = ... computation ...
    +        return result
    +    def set_size (self, size):
    +        ... compute something based on the size
    +        and set internal state appropriately ...
    +
    +    # Define a property.  The 'delete this attribute'
    +    # method is defined as None, so the attribute
    +    # can't be deleted.
    +    size = property(get_size, set_size,
    +                    None,
    +                    "Storage size of this instance")
    +
    +
    +

    That is certainly clearer and easier to write than a pair of +__getattr__()/__setattr__() methods that check for the size +attribute and handle it specially while retrieving all other attributes from the +instance’s __dict__. Accesses to size are also the only ones +which have to perform the work of calling a function, so references to other +attributes run at their usual speed.

    +

    Finally, it’s possible to constrain the list of attributes that can be +referenced on an object using the new __slots__ class attribute. Python +objects are usually very dynamic; at any time it’s possible to define a new +attribute on an instance by just doing obj.new_attr=1. A new-style class +can define a class attribute named __slots__ to limit the legal +attributes to a particular set of names. An example will make this clear:

    +
    >>> class C(object):
    +...     __slots__ = ('template', 'name')
    +...
    +>>> obj = C()
    +>>> print obj.template
    +None
    +>>> obj.template = 'Test'
    +>>> print obj.template
    +Test
    +>>> obj.newattr = None
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in ?
    +AttributeError: 'C' object has no attribute 'newattr'
    +
    +
    +

    Note how you get an AttributeError on the attempt to assign to an +attribute not listed in __slots__.

    +
    + +
    +
    +

    PEP 234: Iterators

    +

    Another significant addition to 2.2 is an iteration interface at both the C and +Python levels. Objects can define how they can be looped over by callers.

    +

    In Python versions up to 2.1, the usual way to make for item in obj work is +to define a __getitem__() method that looks something like this:

    +
    def __getitem__(self, index):
    +    return <next item>
    +
    +
    +

    __getitem__() is more properly used to define an indexing operation on an +object so that you can write obj[5] to retrieve the sixth element. It’s a +bit misleading when you’re using this only to support for loops. +Consider some file-like object that wants to be looped over; the index +parameter is essentially meaningless, as the class probably assumes that a +series of __getitem__() calls will be made with index incrementing by +one each time. In other words, the presence of the __getitem__() method +doesn’t mean that using file[5] to randomly access the sixth element will +work, though it really should.

    +

    In Python 2.2, iteration can be implemented separately, and __getitem__() +methods can be limited to classes that really do support random access. The +basic idea of iterators is simple. A new built-in function, iter(obj) +or iter(C, sentinel), is used to get an iterator. iter(obj) returns +an iterator for the object obj, while iter(C, sentinel) returns an +iterator that will invoke the callable object C until it returns sentinel to +signal that the iterator is done.

    +

    Python classes can define an __iter__() method, which should create and +return a new iterator for the object; if the object is its own iterator, this +method can just return self. In particular, iterators will usually be their +own iterators. Extension types implemented in C can implement a tp_iter +function in order to return an iterator, and extension types that want to behave +as iterators can define a tp_iternext function.

    +

    So, after all this, what do iterators actually do? They have one required +method, next(), which takes no arguments and returns the next value. When +there are no more values to be returned, calling next() should raise the +StopIteration exception.

    +
    >>> L = [1,2,3]
    +>>> i = iter(L)
    +>>> print i
    +<iterator object at 0x8116870>
    +>>> i.next()
    +1
    +>>> i.next()
    +2
    +>>> i.next()
    +3
    +>>> i.next()
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in ?
    +StopIteration
    +>>>
    +
    +
    +

    In 2.2, Python’s for statement no longer expects a sequence; it +expects something for which iter() will return an iterator. For backward +compatibility and convenience, an iterator is automatically constructed for +sequences that don’t implement __iter__() or a tp_iter slot, so +for i in [1,2,3] will still work. Wherever the Python interpreter loops +over a sequence, it’s been changed to use the iterator protocol. This means you +can do things like this:

    +
    >>> L = [1,2,3]
    +>>> i = iter(L)
    +>>> a,b,c = i
    +>>> a,b,c
    +(1, 2, 3)
    +
    +
    +

    Iterator support has been added to some of Python’s basic types. Calling +iter() on a dictionary will return an iterator which loops over its keys:

    +
    >>> m = {'Jan': 1, 'Feb': 2, 'Mar': 3, 'Apr': 4, 'May': 5, 'Jun': 6,
    +...      'Jul': 7, 'Aug': 8, 'Sep': 9, 'Oct': 10, 'Nov': 11, 'Dec': 12}
    +>>> for key in m: print key, m[key]
    +...
    +Mar 3
    +Feb 2
    +Aug 8
    +Sep 9
    +May 5
    +Jun 6
    +Jul 7
    +Jan 1
    +Apr 4
    +Nov 11
    +Dec 12
    +Oct 10
    +
    +
    +

    That’s just the default behaviour. If you want to iterate over keys, values, or +key/value pairs, you can explicitly call the iterkeys(), +itervalues(), or iteritems() methods to get an appropriate iterator. +In a minor related change, the in operator now works on dictionaries, +so key in dict is now equivalent to dict.has_key(key).

    +

    Files also provide an iterator, which calls the readline() method until +there are no more lines in the file. This means you can now read each line of a +file using code like this:

    +
    for line in file:
    +    # do something for each line
    +    ...
    +
    +
    +

    Note that you can only go forward in an iterator; there’s no way to get the +previous element, reset the iterator, or make a copy of it. An iterator object +could provide such additional capabilities, but the iterator protocol only +requires a next() method.

    +
    +

    See also

    +
    +
    PEP 234 - Iterators

    Written by Ka-Ping Yee and GvR; implemented by the Python Labs crew, mostly by +GvR and Tim Peters.

    +
    +
    +
    +
    +
    +

    PEP 255: Simple Generators

    +

    Generators are another new feature, one that interacts with the introduction of +iterators.

    +

    You’re doubtless familiar with how function calls work in Python or C. When you +call a function, it gets a private namespace where its local variables are +created. When the function reaches a return statement, the local +variables are destroyed and the resulting value is returned to the caller. A +later call to the same function will get a fresh new set of local variables. +But, what if the local variables weren’t thrown away on exiting a function? +What if you could later resume the function where it left off? This is what +generators provide; they can be thought of as resumable functions.

    +

    Here’s the simplest example of a generator function:

    +
    def generate_ints(N):
    +    for i in range(N):
    +        yield i
    +
    +
    +

    A new keyword, yield, was introduced for generators. Any function +containing a yield statement is a generator function; this is +detected by Python’s bytecode compiler which compiles the function specially as +a result. Because a new keyword was introduced, generators must be explicitly +enabled in a module by including a from __future__ import generators +statement near the top of the module’s source code. In Python 2.3 this +statement will become unnecessary.

    +

    When you call a generator function, it doesn’t return a single value; instead it +returns a generator object that supports the iterator protocol. On executing +the yield statement, the generator outputs the value of i, +similar to a return statement. The big difference between +yield and a return statement is that on reaching a +yield the generator’s state of execution is suspended and local +variables are preserved. On the next call to the generator’s next() method, +the function will resume executing immediately after the yield +statement. (For complicated reasons, the yield statement isn’t +allowed inside the try block of a +tryfinally statement; read PEP 255 for a full +explanation of the interaction between yield and exceptions.)

    +

    Here’s a sample usage of the generate_ints() generator:

    +
    >>> gen = generate_ints(3)
    +>>> gen
    +<generator object at 0x8117f90>
    +>>> gen.next()
    +0
    +>>> gen.next()
    +1
    +>>> gen.next()
    +2
    +>>> gen.next()
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in ?
    +  File "<stdin>", line 2, in generate_ints
    +StopIteration
    +
    +
    +

    You could equally write for i in generate_ints(5), or a,b,c = +generate_ints(3).

    +

    Inside a generator function, the return statement can only be used +without a value, and signals the end of the procession of values; afterwards the +generator cannot return any further values. return with a value, such +as return 5, is a syntax error inside a generator function. The end of the +generator’s results can also be indicated by raising StopIteration +manually, or by just letting the flow of execution fall off the bottom of the +function.

    +

    You could achieve the effect of generators manually by writing your own class +and storing all the local variables of the generator as instance variables. For +example, returning a list of integers could be done by setting self.count to +0, and having the next() method increment self.count and return it. +However, for a moderately complicated generator, writing a corresponding class +would be much messier. Lib/test/test_generators.py contains a number of +more interesting examples. The simplest one implements an in-order traversal of +a tree using generators recursively.

    +
    # A recursive generator that generates Tree leaves in in-order.
    +def inorder(t):
    +    if t:
    +        for x in inorder(t.left):
    +            yield x
    +        yield t.label
    +        for x in inorder(t.right):
    +            yield x
    +
    +
    +

    Two other examples in Lib/test/test_generators.py produce solutions for +the N-Queens problem (placing $N$ queens on an $NxN$ chess board so that no +queen threatens another) and the Knight’s Tour (a route that takes a knight to +every square of an $NxN$ chessboard without visiting any square twice).

    +

    The idea of generators comes from other programming languages, especially Icon +(https://www.cs.arizona.edu/icon/), where the idea of generators is central. In +Icon, every expression and function call behaves like a generator. One example +from “An Overview of the Icon Programming Language” at +https://www.cs.arizona.edu/icon/docs/ipd266.htm gives an idea of what this looks +like:

    +
    sentence := "Store it in the neighboring harbor"
    +if (i := find("or", sentence)) > 5 then write(i)
    +
    +
    +

    In Icon the find() function returns the indexes at which the substring +“or” is found: 3, 23, 33. In the if statement, i is first +assigned a value of 3, but 3 is less than 5, so the comparison fails, and Icon +retries it with the second value of 23. 23 is greater than 5, so the comparison +now succeeds, and the code prints the value 23 to the screen.

    +

    Python doesn’t go nearly as far as Icon in adopting generators as a central +concept. Generators are considered a new part of the core Python language, but +learning or using them isn’t compulsory; if they don’t solve any problems that +you have, feel free to ignore them. One novel feature of Python’s interface as +compared to Icon’s is that a generator’s state is represented as a concrete +object (the iterator) that can be passed around to other functions or stored in +a data structure.

    +
    +

    See also

    +
    +
    PEP 255 - Simple Generators

    Written by Neil Schemenauer, Tim Peters, Magnus Lie Hetland. Implemented mostly +by Neil Schemenauer and Tim Peters, with other fixes from the Python Labs crew.

    +
    +
    +
    +
    +
    +

    PEP 237: Unifying Long Integers and Integers

    +

    In recent versions, the distinction between regular integers, which are 32-bit +values on most machines, and long integers, which can be of arbitrary size, was +becoming an annoyance. For example, on platforms that support files larger than +2**32 bytes, the tell() method of file objects has to return a long +integer. However, there were various bits of Python that expected plain integers +and would raise an error if a long integer was provided instead. For example, +in Python 1.5, only regular integers could be used as a slice index, and +'abc'[1L:] would raise a TypeError exception with the message ‘slice +index must be int’.

    +

    Python 2.2 will shift values from short to long integers as required. The ‘L’ +suffix is no longer needed to indicate a long integer literal, as now the +compiler will choose the appropriate type. (Using the ‘L’ suffix will be +discouraged in future 2.x versions of Python, triggering a warning in Python +2.4, and probably dropped in Python 3.0.) Many operations that used to raise an +OverflowError will now return a long integer as their result. For +example:

    +
    >>> 1234567890123
    +1234567890123L
    +>>> 2 ** 64
    +18446744073709551616L
    +
    +
    +

    In most cases, integers and long integers will now be treated identically. You +can still distinguish them with the type() built-in function, but that’s +rarely needed.

    +
    +

    See also

    +
    +
    PEP 237 - Unifying Long Integers and Integers

    Written by Moshe Zadka and Guido van Rossum. Implemented mostly by Guido van +Rossum.

    +
    +
    +
    +
    +
    +

    PEP 238: Changing the Division Operator

    +

    The most controversial change in Python 2.2 heralds the start of an effort to +fix an old design flaw that’s been in Python from the beginning. Currently +Python’s division operator, /, behaves like C’s division operator when +presented with two integer arguments: it returns an integer result that’s +truncated down when there would be a fractional part. For example, 3/2 is +1, not 1.5, and (-1)/2 is -1, not -0.5. This means that the results of +division can vary unexpectedly depending on the type of the two operands and +because Python is dynamically typed, it can be difficult to determine the +possible types of the operands.

    +

    (The controversy is over whether this is really a design flaw, and whether +it’s worth breaking existing code to fix this. It’s caused endless discussions +on python-dev, and in July 2001 erupted into a storm of acidly sarcastic +postings on comp.lang.python. I won’t argue for either side here +and will stick to describing what’s implemented in 2.2. Read PEP 238 for a +summary of arguments and counter-arguments.)

    +

    Because this change might break code, it’s being introduced very gradually. +Python 2.2 begins the transition, but the switch won’t be complete until Python +3.0.

    +

    First, I’ll borrow some terminology from PEP 238. “True division” is the +division that most non-programmers are familiar with: 3/2 is 1.5, 1/4 is 0.25, +and so forth. “Floor division” is what Python’s / operator currently does +when given integer operands; the result is the floor of the value returned by +true division. “Classic division” is the current mixed behaviour of /; it +returns the result of floor division when the operands are integers, and returns +the result of true division when one of the operands is a floating-point number.

    +

    Here are the changes 2.2 introduces:

    +
      +
    • A new operator, //, is the floor division operator. (Yes, we know it looks +like C++’s comment symbol.) // always performs floor division no matter +what the types of its operands are, so 1 // 2 is 0 and 1.0 // 2.0 is +also 0.0.

      +

      // is always available in Python 2.2; you don’t need to enable it using a +__future__ statement.

      +
    • +
    • By including a from __future__ import division in a module, the / +operator will be changed to return the result of true division, so 1/2 is +0.5. Without the __future__ statement, / still means classic division. +The default meaning of / will not change until Python 3.0.

    • +
    • Classes can define methods called __truediv__() and __floordiv__() +to overload the two division operators. At the C level, there are also slots in +the PyNumberMethods structure so extension types can define the two +operators.

    • +
    • Python 2.2 supports some command-line arguments for testing whether code will +work with the changed division semantics. Running python with -Q +warn will cause a warning to be issued whenever division is applied to two +integers. You can use this to find code that’s affected by the change and fix +it. By default, Python 2.2 will simply perform classic division without a +warning; the warning will be turned on by default in Python 2.3.

    • +
    +
    +

    See also

    +
    +
    PEP 238 - Changing the Division Operator

    Written by Moshe Zadka and Guido van Rossum. Implemented by Guido van Rossum..

    +
    +
    +
    +
    +
    +

    Unicode Changes

    +

    Python’s Unicode support has been enhanced a bit in 2.2. Unicode strings are +usually stored as UCS-2, as 16-bit unsigned integers. Python 2.2 can also be +compiled to use UCS-4, 32-bit unsigned integers, as its internal encoding by +supplying --enable-unicode=ucs4 to the configure script. (It’s also +possible to specify --disable-unicode to completely disable Unicode +support.)

    +

    When built to use UCS-4 (a “wide Python”), the interpreter can natively handle +Unicode characters from U+000000 to U+110000, so the range of legal values for +the unichr() function is expanded accordingly. Using an interpreter +compiled to use UCS-2 (a “narrow Python”), values greater than 65535 will still +cause unichr() to raise a ValueError exception. This is all +described in PEP 261, “Support for ‘wide’ Unicode characters”; consult it for +further details.

    +

    Another change is simpler to explain. Since their introduction, Unicode strings +have supported an encode() method to convert the string to a selected +encoding such as UTF-8 or Latin-1. A symmetric decode([*encoding*]) +method has been added to 8-bit strings (though not to Unicode strings) in 2.2. +decode() assumes that the string is in the specified encoding and decodes +it, returning whatever is returned by the codec.

    +

    Using this new feature, codecs have been added for tasks not directly related to +Unicode. For example, codecs have been added for uu-encoding, MIME’s base64 +encoding, and compression with the zlib module:

    +
    >>> s = """Here is a lengthy piece of redundant, overly verbose,
    +... and repetitive text.
    +... """
    +>>> data = s.encode('zlib')
    +>>> data
    +'x\x9c\r\xc9\xc1\r\x80 \x10\x04\xc0?Ul...'
    +>>> data.decode('zlib')
    +'Here is a lengthy piece of redundant, overly verbose,\nand repetitive text.\n'
    +>>> print s.encode('uu')
    +begin 666 <data>
    +M2&5R92!I<R!A(&QE;F=T:'D@<&EE8V4@;V8@<F5D=6YD86YT+"!O=F5R;'D@
    +>=F5R8F]S92P*86YD(')E<&5T:71I=F4@=&5X="X*
    +
    +end
    +>>> "sheesh".encode('rot-13')
    +'furrfu'
    +
    +
    +

    To convert a class instance to Unicode, a __unicode__() method can be +defined by a class, analogous to __str__().

    +

    encode(), decode(), and __unicode__() were implemented by +Marc-André Lemburg. The changes to support using UCS-4 internally were +implemented by Fredrik Lundh and Martin von Löwis.

    +
    +

    See also

    +
    +
    PEP 261 - Support for ‘wide’ Unicode characters

    Written by Paul Prescod.

    +
    +
    +
    +
    +
    +

    PEP 227: Nested Scopes

    +

    In Python 2.1, statically nested scopes were added as an optional feature, to be +enabled by a from __future__ import nested_scopes directive. In 2.2 nested +scopes no longer need to be specially enabled, and are now always present. The +rest of this section is a copy of the description of nested scopes from my +“What’s New in Python 2.1” document; if you read it when 2.1 came out, you can +skip the rest of this section.

    +

    The largest change introduced in Python 2.1, and made complete in 2.2, is to +Python’s scoping rules. In Python 2.0, at any given time there are at most +three namespaces used to look up variable names: local, module-level, and the +built-in namespace. This often surprised people because it didn’t match their +intuitive expectations. For example, a nested recursive function definition +doesn’t work:

    +
    def f():
    +    ...
    +    def g(value):
    +        ...
    +        return g(value-1) + 1
    +    ...
    +
    +
    +

    The function g() will always raise a NameError exception, because +the binding of the name g isn’t in either its local namespace or in the +module-level namespace. This isn’t much of a problem in practice (how often do +you recursively define interior functions like this?), but this also made using +the lambda expression clumsier, and this was a problem in practice. +In code which uses lambda you can often find local variables being +copied by passing them as the default values of arguments.

    +
    def find(self, name):
    +    "Return list of any entries equal to 'name'"
    +    L = filter(lambda x, name=name: x == name,
    +               self.list_attribute)
    +    return L
    +
    +
    +

    The readability of Python code written in a strongly functional style suffers +greatly as a result.

    +

    The most significant change to Python 2.2 is that static scoping has been added +to the language to fix this problem. As a first effect, the name=name +default argument is now unnecessary in the above example. Put simply, when a +given variable name is not assigned a value within a function (by an assignment, +or the def, class, or import statements), +references to the variable will be looked up in the local namespace of the +enclosing scope. A more detailed explanation of the rules, and a dissection of +the implementation, can be found in the PEP.

    +

    This change may cause some compatibility problems for code where the same +variable name is used both at the module level and as a local variable within a +function that contains further function definitions. This seems rather unlikely +though, since such code would have been pretty confusing to read in the first +place.

    +

    One side effect of the change is that the from module import * and +exec statements have been made illegal inside a function scope under +certain conditions. The Python reference manual has said all along that from +module import * is only legal at the top level of a module, but the CPython +interpreter has never enforced this before. As part of the implementation of +nested scopes, the compiler which turns Python source into bytecodes has to +generate different code to access variables in a containing scope. from +module import * and exec make it impossible for the compiler to +figure this out, because they add names to the local namespace that are +unknowable at compile time. Therefore, if a function contains function +definitions or lambda expressions with free variables, the compiler +will flag this by raising a SyntaxError exception.

    +

    To make the preceding explanation a bit clearer, here’s an example:

    +
    x = 1
    +def f():
    +    # The next line is a syntax error
    +    exec 'x=2'
    +    def g():
    +        return x
    +
    +
    +

    Line 4 containing the exec statement is a syntax error, since +exec would define a new local variable named x whose value should +be accessed by g().

    +

    This shouldn’t be much of a limitation, since exec is rarely used in +most Python code (and when it is used, it’s often a sign of a poor design +anyway).

    +
    +

    See also

    +
    +
    PEP 227 - Statically Nested Scopes

    Written and implemented by Jeremy Hylton.

    +
    +
    +
    +
    +
    +

    New and Improved Modules

    +
      +
    • The xmlrpclib module was contributed to the standard library by Fredrik +Lundh, providing support for writing XML-RPC clients. XML-RPC is a simple +remote procedure call protocol built on top of HTTP and XML. For example, the +following snippet retrieves a list of RSS channels from the O’Reilly Network, +and then lists the recent headlines for one channel:

      +
      import xmlrpclib
      +s = xmlrpclib.Server(
      +      'http://www.oreillynet.com/meerkat/xml-rpc/server.php')
      +channels = s.meerkat.getChannels()
      +# channels is a list of dictionaries, like this:
      +# [{'id': 4, 'title': 'Freshmeat Daily News'}
      +#  {'id': 190, 'title': '32Bits Online'},
      +#  {'id': 4549, 'title': '3DGamers'}, ... ]
      +
      +# Get the items for one channel
      +items = s.meerkat.getItems( {'channel': 4} )
      +
      +# 'items' is another list of dictionaries, like this:
      +# [{'link': 'http://freshmeat.net/releases/52719/',
      +#   'description': 'A utility which converts HTML to XSL FO.',
      +#   'title': 'html2fo 0.3 (Default)'}, ... ]
      +
      +
      +

      The SimpleXMLRPCServer module makes it easy to create straightforward +XML-RPC servers. See http://xmlrpc.scripting.com/ for more information about XML-RPC.

      +
    • +
    • The new hmac module implements the HMAC algorithm described by +RFC 2104. (Contributed by Gerhard Häring.)

    • +
    • Several functions that originally returned lengthy tuples now return +pseudo-sequences that still behave like tuples but also have mnemonic attributes such +as memberst_mtime or tm_year. The enhanced functions include +stat(), fstat(), statvfs(), and fstatvfs() in the +os module, and localtime(), gmtime(), and strptime() in +the time module.

      +

      For example, to obtain a file’s size using the old tuples, you’d end up writing +something like file_size = os.stat(filename)[stat.ST_SIZE], but now this can +be written more clearly as file_size = os.stat(filename).st_size.

      +

      The original patch for this feature was contributed by Nick Mathewson.

      +
    • +
    • The Python profiler has been extensively reworked and various errors in its +output have been corrected. (Contributed by Fred L. Drake, Jr. and Tim Peters.)

    • +
    • The socket module can be compiled to support IPv6; specify the +--enable-ipv6 option to Python’s configure script. (Contributed by +Jun-ichiro “itojun” Hagino.)

    • +
    • Two new format characters were added to the struct module for 64-bit +integers on platforms that support the C long long type. q is for +a signed 64-bit integer, and Q is for an unsigned one. The value is +returned in Python’s long integer type. (Contributed by Tim Peters.)

    • +
    • In the interpreter’s interactive mode, there’s a new built-in function +help() that uses the pydoc module introduced in Python 2.1 to +provide interactive help. help(object) displays any available help text +about object. help() with no argument puts you in an online help +utility, where you can enter the names of functions, classes, or modules to read +their help text. (Contributed by Guido van Rossum, using Ka-Ping Yee’s +pydoc module.)

    • +
    • Various bugfixes and performance improvements have been made to the SRE engine +underlying the re module. For example, the re.sub() and +re.split() functions have been rewritten in C. Another contributed patch +speeds up certain Unicode character ranges by a factor of two, and a new +finditer() method that returns an iterator over all the non-overlapping +matches in a given string. (SRE is maintained by Fredrik Lundh. The +BIGCHARSET patch was contributed by Martin von Löwis.)

    • +
    • The smtplib module now supports RFC 2487, “Secure SMTP over TLS”, so +it’s now possible to encrypt the SMTP traffic between a Python program and the +mail transport agent being handed a message. smtplib also supports SMTP +authentication. (Contributed by Gerhard Häring.)

    • +
    • The imaplib module, maintained by Piers Lauder, has support for several +new extensions: the NAMESPACE extension defined in RFC 2342, SORT, GETACL and +SETACL. (Contributed by Anthony Baxter and Michel Pelletier.)

    • +
    • The rfc822 module’s parsing of email addresses is now compliant with +RFC 2822, an update to RFC 822. (The module’s name is not going to be +changed to rfc2822.) A new package, email, has also been added for +parsing and generating e-mail messages. (Contributed by Barry Warsaw, and +arising out of his work on Mailman.)

    • +
    • The difflib module now contains a new Differ class for +producing human-readable lists of changes (a “delta”) between two sequences of +lines of text. There are also two generator functions, ndiff() and +restore(), which respectively return a delta from two sequences, or one of +the original sequences from a delta. (Grunt work contributed by David Goodger, +from ndiff.py code by Tim Peters who then did the generatorization.)

    • +
    • New constants ascii_letters, ascii_lowercase, and +ascii_uppercase were added to the string module. There were +several modules in the standard library that used string.letters to +mean the ranges A-Za-z, but that assumption is incorrect when locales are in +use, because string.letters varies depending on the set of legal +characters defined by the current locale. The buggy modules have all been fixed +to use ascii_letters instead. (Reported by an unknown person; fixed by +Fred L. Drake, Jr.)

    • +
    • The mimetypes module now makes it easier to use alternative MIME-type +databases by the addition of a MimeTypes class, which takes a list of +filenames to be parsed. (Contributed by Fred L. Drake, Jr.)

    • +
    • A Timer class was added to the threading module that allows +scheduling an activity to happen at some future time. (Contributed by Itamar +Shtull-Trauring.)

    • +
    +
    +
    +

    Interpreter Changes and Fixes

    +

    Some of the changes only affect people who deal with the Python interpreter at +the C level because they’re writing Python extension modules, embedding the +interpreter, or just hacking on the interpreter itself. If you only write Python +code, none of the changes described here will affect you very much.

    +
      +
    • Profiling and tracing functions can now be implemented in C, which can operate +at much higher speeds than Python-based functions and should reduce the overhead +of profiling and tracing. This will be of interest to authors of development +environments for Python. Two new C functions were added to Python’s API, +PyEval_SetProfile() and PyEval_SetTrace(). The existing +sys.setprofile() and sys.settrace() functions still exist, and have +simply been changed to use the new C-level interface. (Contributed by Fred L. +Drake, Jr.)

    • +
    • Another low-level API, primarily of interest to implementors of Python +debuggers and development tools, was added. PyInterpreterState_Head() and +PyInterpreterState_Next() let a caller walk through all the existing +interpreter objects; PyInterpreterState_ThreadHead() and +PyThreadState_Next() allow looping over all the thread states for a given +interpreter. (Contributed by David Beazley.)

    • +
    • The C-level interface to the garbage collector has been changed to make it +easier to write extension types that support garbage collection and to debug +misuses of the functions. Various functions have slightly different semantics, +so a bunch of functions had to be renamed. Extensions that use the old API will +still compile but will not participate in garbage collection, so updating them +for 2.2 should be considered fairly high priority.

      +

      To upgrade an extension module to the new API, perform the following steps:

      +
    • +
    • Rename Py_TPFLAGS_GC() to PyTPFLAGS_HAVE_GC().

    • +
    • +
      Use PyObject_GC_New() or PyObject_GC_NewVar() to allocate

      objects, and PyObject_GC_Del() to deallocate them.

      +
      +
      +
    • +
    • +
      Rename PyObject_GC_Init() to PyObject_GC_Track() and

      PyObject_GC_Fini() to PyObject_GC_UnTrack().

      +
      +
      +
    • +
    • Remove PyGC_HEAD_SIZE() from object size calculations.

    • +
    • Remove calls to PyObject_AS_GC() and PyObject_FROM_GC().

    • +
    • A new et format sequence was added to PyArg_ParseTuple(); et +takes both a parameter and an encoding name, and converts the parameter to the +given encoding if the parameter turns out to be a Unicode string, or leaves it +alone if it’s an 8-bit string, assuming it to already be in the desired +encoding. This differs from the es format character, which assumes that +8-bit strings are in Python’s default ASCII encoding and converts them to the +specified new encoding. (Contributed by M.-A. Lemburg, and used for the MBCS +support on Windows described in the following section.)

    • +
    • A different argument parsing function, PyArg_UnpackTuple(), has been +added that’s simpler and presumably faster. Instead of specifying a format +string, the caller simply gives the minimum and maximum number of arguments +expected, and a set of pointers to PyObject* variables that will be +filled in with argument values.

    • +
    • Two new flags METH_NOARGS and METH_O are available in method +definition tables to simplify implementation of methods with no arguments or a +single untyped argument. Calling such methods is more efficient than calling a +corresponding method that uses METH_VARARGS. Also, the old +METH_OLDARGS style of writing C methods is now officially deprecated.

    • +
    • Two new wrapper functions, PyOS_snprintf() and PyOS_vsnprintf() +were added to provide cross-platform implementations for the relatively new +snprintf() and vsnprintf() C lib APIs. In contrast to the standard +sprintf() and vsprintf() functions, the Python versions check the +bounds of the buffer used to protect against buffer overruns. (Contributed by +M.-A. Lemburg.)

    • +
    • The _PyTuple_Resize() function has lost an unused parameter, so now it +takes 2 parameters instead of 3. The third argument was never used, and can +simply be discarded when porting code from earlier versions to Python 2.2.

    • +
    +
    +
    +

    Other Changes and Fixes

    +

    As usual there were a bunch of other improvements and bugfixes scattered +throughout the source tree. A search through the CVS change logs finds there +were 527 patches applied and 683 bugs fixed between Python 2.1 and 2.2; 2.2.1 +applied 139 patches and fixed 143 bugs; 2.2.2 applied 106 patches and fixed 82 +bugs. These figures are likely to be underestimates.

    +

    Some of the more notable changes are:

    +
      +
    • The code for the MacOS port for Python, maintained by Jack Jansen, is now kept +in the main Python CVS tree, and many changes have been made to support MacOS X.

      +

      The most significant change is the ability to build Python as a framework, +enabled by supplying the --enable-framework option to the configure +script when compiling Python. According to Jack Jansen, “This installs a +self-contained Python installation plus the OS X framework “glue” into +/Library/Frameworks/Python.framework (or another location of choice). +For now there is little immediate added benefit to this (actually, there is the +disadvantage that you have to change your PATH to be able to find Python), but +it is the basis for creating a full-blown Python application, porting the +MacPython IDE, possibly using Python as a standard OSA scripting language and +much more.”

      +

      Most of the MacPython toolbox modules, which interface to MacOS APIs such as +windowing, QuickTime, scripting, etc. have been ported to OS X, but they’ve been +left commented out in setup.py. People who want to experiment with +these modules can uncomment them manually.

      +
    • +
    • Keyword arguments passed to built-in functions that don’t take them now cause a +TypeError exception to be raised, with the message “function takes no +keyword arguments”.

    • +
    • Weak references, added in Python 2.1 as an extension module, are now part of +the core because they’re used in the implementation of new-style classes. The +ReferenceError exception has therefore moved from the weakref +module to become a built-in exception.

    • +
    • A new script, Tools/scripts/cleanfuture.py by Tim Peters, +automatically removes obsolete __future__ statements from Python source +code.

    • +
    • An additional flags argument has been added to the built-in function +compile(), so the behaviour of __future__ statements can now be +correctly observed in simulated shells, such as those presented by IDLE and +other development environments. This is described in PEP 264. (Contributed +by Michael Hudson.)

    • +
    • The new license introduced with Python 1.6 wasn’t GPL-compatible. This is +fixed by some minor textual changes to the 2.2 license, so it’s now legal to +embed Python inside a GPLed program again. Note that Python itself is not +GPLed, but instead is under a license that’s essentially equivalent to the BSD +license, same as it always was. The license changes were also applied to the +Python 2.0.1 and 2.1.1 releases.

    • +
    • When presented with a Unicode filename on Windows, Python will now convert it +to an MBCS encoded string, as used by the Microsoft file APIs. As MBCS is +explicitly used by the file APIs, Python’s choice of ASCII as the default +encoding turns out to be an annoyance. On Unix, the locale’s character set is +used if locale.nl_langinfo(CODESET) is available. (Windows support was +contributed by Mark Hammond with assistance from Marc-André Lemburg. Unix +support was added by Martin von Löwis.)

    • +
    • Large file support is now enabled on Windows. (Contributed by Tim Peters.)

    • +
    • The Tools/scripts/ftpmirror.py script now parses a .netrc +file, if you have one. (Contributed by Mike Romberg.)

    • +
    • Some features of the object returned by the xrange() function are now +deprecated, and trigger warnings when they’re accessed; they’ll disappear in +Python 2.3. xrange objects tried to pretend they were full sequence +types by supporting slicing, sequence multiplication, and the in +operator, but these features were rarely used and therefore buggy. The +tolist() method and the start, stop, and step +attributes are also being deprecated. At the C level, the fourth argument to +the PyRange_New() function, repeat, has also been deprecated.

    • +
    • There were a bunch of patches to the dictionary implementation, mostly to fix +potential core dumps if a dictionary contains objects that sneakily changed +their hash value, or mutated the dictionary they were contained in. For a while +python-dev fell into a gentle rhythm of Michael Hudson finding a case that +dumped core, Tim Peters fixing the bug, Michael finding another case, and round +and round it went.

    • +
    • On Windows, Python can now be compiled with Borland C thanks to a number of +patches contributed by Stephen Hansen, though the result isn’t fully functional +yet. (But this is progress…)

    • +
    • Another Windows enhancement: Wise Solutions generously offered PythonLabs use +of their InstallerMaster 8.1 system. Earlier PythonLabs Windows installers used +Wise 5.0a, which was beginning to show its age. (Packaged up by Tim Peters.)

    • +
    • Files ending in .pyw can now be imported on Windows. .pyw is a +Windows-only thing, used to indicate that a script needs to be run using +PYTHONW.EXE instead of PYTHON.EXE in order to prevent a DOS console from popping +up to display the output. This patch makes it possible to import such scripts, +in case they’re also usable as modules. (Implemented by David Bolen.)

    • +
    • On platforms where Python uses the C dlopen() function to load +extension modules, it’s now possible to set the flags used by dlopen() +using the sys.getdlopenflags() and sys.setdlopenflags() functions. +(Contributed by Bram Stolk.)

    • +
    • The pow() built-in function no longer supports 3 arguments when +floating-point numbers are supplied. pow(x, y, z) returns (x**y) % z, +but this is never useful for floating point numbers, and the final result varies +unpredictably depending on the platform. A call such as pow(2.0, 8.0, 7.0) +will now raise a TypeError exception.

    • +
    +
    +
    +

    Acknowledgements

    +

    The author would like to thank the following people for offering suggestions, +corrections and assistance with various drafts of this article: Fred Bremmer, +Keith Briggs, Andrew Dalke, Fred L. Drake, Jr., Carel Fellinger, David Goodger, +Mark Hammond, Stephen Hansen, Michael Hudson, Jack Jansen, Marc-André Lemburg, +Martin von Löwis, Fredrik Lundh, Michael McLay, Nick Mathewson, Paul Moore, +Gustavo Niemeyer, Don O’Donnell, Joonas Paalasma, Tim Peters, Jens Quade, Tom +Reinhardt, Neil Schemenauer, Guido van Rossum, Greg Ward, Edward Welbourne.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/whatsnew/2.3.html b/python-3.7.4-docs-html/whatsnew/2.3.html new file mode 100644 index 0000000..998f7f5 --- /dev/null +++ b/python-3.7.4-docs-html/whatsnew/2.3.html @@ -0,0 +1,2038 @@ + + + + + + + What’s New in Python 2.3 — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    What’s New in Python 2.3

    +
    +
    Author
    +

    A.M. Kuchling

    +
    +
    +

    This article explains the new features in Python 2.3. Python 2.3 was released +on July 29, 2003.

    +

    The main themes for Python 2.3 are polishing some of the features added in 2.2, +adding various small but useful enhancements to the core language, and expanding +the standard library. The new object model introduced in the previous version +has benefited from 18 months of bugfixes and from optimization efforts that have +improved the performance of new-style classes. A few new built-in functions +have been added such as sum() and enumerate(). The in +operator can now be used for substring searches (e.g. "ab" in "abc" returns +True).

    +

    Some of the many new library features include Boolean, set, heap, and date/time +data types, the ability to import modules from ZIP-format archives, metadata +support for the long-awaited Python catalog, an updated version of IDLE, and +modules for logging messages, wrapping text, parsing CSV files, processing +command-line options, using BerkeleyDB databases… the list of new and +enhanced modules is lengthy.

    +

    This article doesn’t attempt to provide a complete specification of the new +features, but instead provides a convenient overview. For full details, you +should refer to the documentation for Python 2.3, such as the Python Library +Reference and the Python Reference Manual. If you want to understand the +complete implementation and design rationale, refer to the PEP for a particular +new feature.

    +
    +

    PEP 218: A Standard Set Datatype

    +

    The new sets module contains an implementation of a set datatype. The +Set class is for mutable sets, sets that can have members added and +removed. The ImmutableSet class is for sets that can’t be modified, +and instances of ImmutableSet can therefore be used as dictionary keys. +Sets are built on top of dictionaries, so the elements within a set must be +hashable.

    +

    Here’s a simple example:

    +
    >>> import sets
    +>>> S = sets.Set([1,2,3])
    +>>> S
    +Set([1, 2, 3])
    +>>> 1 in S
    +True
    +>>> 0 in S
    +False
    +>>> S.add(5)
    +>>> S.remove(3)
    +>>> S
    +Set([1, 2, 5])
    +>>>
    +
    +
    +

    The union and intersection of sets can be computed with the union() and +intersection() methods; an alternative notation uses the bitwise operators +& and |. Mutable sets also have in-place versions of these methods, +union_update() and intersection_update().

    +
    >>> S1 = sets.Set([1,2,3])
    +>>> S2 = sets.Set([4,5,6])
    +>>> S1.union(S2)
    +Set([1, 2, 3, 4, 5, 6])
    +>>> S1 | S2                  # Alternative notation
    +Set([1, 2, 3, 4, 5, 6])
    +>>> S1.intersection(S2)
    +Set([])
    +>>> S1 & S2                  # Alternative notation
    +Set([])
    +>>> S1.union_update(S2)
    +>>> S1
    +Set([1, 2, 3, 4, 5, 6])
    +>>>
    +
    +
    +

    It’s also possible to take the symmetric difference of two sets. This is the +set of all elements in the union that aren’t in the intersection. Another way +of putting it is that the symmetric difference contains all elements that are in +exactly one set. Again, there’s an alternative notation (^), and an +in-place version with the ungainly name symmetric_difference_update().

    +
    >>> S1 = sets.Set([1,2,3,4])
    +>>> S2 = sets.Set([3,4,5,6])
    +>>> S1.symmetric_difference(S2)
    +Set([1, 2, 5, 6])
    +>>> S1 ^ S2
    +Set([1, 2, 5, 6])
    +>>>
    +
    +
    +

    There are also issubset() and issuperset() methods for checking +whether one set is a subset or superset of another:

    +
    >>> S1 = sets.Set([1,2,3])
    +>>> S2 = sets.Set([2,3])
    +>>> S2.issubset(S1)
    +True
    +>>> S1.issubset(S2)
    +False
    +>>> S1.issuperset(S2)
    +True
    +>>>
    +
    +
    +
    +

    See also

    +
    +
    PEP 218 - Adding a Built-In Set Object Type

    PEP written by Greg V. Wilson. Implemented by Greg V. Wilson, Alex Martelli, and +GvR.

    +
    +
    +
    +
    +
    +

    PEP 255: Simple Generators

    +

    In Python 2.2, generators were added as an optional feature, to be enabled by a +from __future__ import generators directive. In 2.3 generators no longer +need to be specially enabled, and are now always present; this means that +yield is now always a keyword. The rest of this section is a copy of +the description of generators from the “What’s New in Python 2.2” document; if +you read it back when Python 2.2 came out, you can skip the rest of this +section.

    +

    You’re doubtless familiar with how function calls work in Python or C. When you +call a function, it gets a private namespace where its local variables are +created. When the function reaches a return statement, the local +variables are destroyed and the resulting value is returned to the caller. A +later call to the same function will get a fresh new set of local variables. +But, what if the local variables weren’t thrown away on exiting a function? +What if you could later resume the function where it left off? This is what +generators provide; they can be thought of as resumable functions.

    +

    Here’s the simplest example of a generator function:

    +
    def generate_ints(N):
    +    for i in range(N):
    +        yield i
    +
    +
    +

    A new keyword, yield, was introduced for generators. Any function +containing a yield statement is a generator function; this is +detected by Python’s bytecode compiler which compiles the function specially as +a result.

    +

    When you call a generator function, it doesn’t return a single value; instead it +returns a generator object that supports the iterator protocol. On executing +the yield statement, the generator outputs the value of i, +similar to a return statement. The big difference between +yield and a return statement is that on reaching a +yield the generator’s state of execution is suspended and local +variables are preserved. On the next call to the generator’s .next() +method, the function will resume executing immediately after the +yield statement. (For complicated reasons, the yield +statement isn’t allowed inside the try block of a +tryfinally statement; read PEP 255 for a full +explanation of the interaction between yield and exceptions.)

    +

    Here’s a sample usage of the generate_ints() generator:

    +
    >>> gen = generate_ints(3)
    +>>> gen
    +<generator object at 0x8117f90>
    +>>> gen.next()
    +0
    +>>> gen.next()
    +1
    +>>> gen.next()
    +2
    +>>> gen.next()
    +Traceback (most recent call last):
    +  File "stdin", line 1, in ?
    +  File "stdin", line 2, in generate_ints
    +StopIteration
    +
    +
    +

    You could equally write for i in generate_ints(5), or a,b,c = +generate_ints(3).

    +

    Inside a generator function, the return statement can only be used +without a value, and signals the end of the procession of values; afterwards the +generator cannot return any further values. return with a value, such +as return 5, is a syntax error inside a generator function. The end of the +generator’s results can also be indicated by raising StopIteration +manually, or by just letting the flow of execution fall off the bottom of the +function.

    +

    You could achieve the effect of generators manually by writing your own class +and storing all the local variables of the generator as instance variables. For +example, returning a list of integers could be done by setting self.count to +0, and having the next() method increment self.count and return it. +However, for a moderately complicated generator, writing a corresponding class +would be much messier. Lib/test/test_generators.py contains a number of +more interesting examples. The simplest one implements an in-order traversal of +a tree using generators recursively.

    +
    # A recursive generator that generates Tree leaves in in-order.
    +def inorder(t):
    +    if t:
    +        for x in inorder(t.left):
    +            yield x
    +        yield t.label
    +        for x in inorder(t.right):
    +            yield x
    +
    +
    +

    Two other examples in Lib/test/test_generators.py produce solutions for +the N-Queens problem (placing $N$ queens on an $NxN$ chess board so that no +queen threatens another) and the Knight’s Tour (a route that takes a knight to +every square of an $NxN$ chessboard without visiting any square twice).

    +

    The idea of generators comes from other programming languages, especially Icon +(https://www.cs.arizona.edu/icon/), where the idea of generators is central. In +Icon, every expression and function call behaves like a generator. One example +from “An Overview of the Icon Programming Language” at +https://www.cs.arizona.edu/icon/docs/ipd266.htm gives an idea of what this looks +like:

    +
    sentence := "Store it in the neighboring harbor"
    +if (i := find("or", sentence)) > 5 then write(i)
    +
    +
    +

    In Icon the find() function returns the indexes at which the substring +“or” is found: 3, 23, 33. In the if statement, i is first +assigned a value of 3, but 3 is less than 5, so the comparison fails, and Icon +retries it with the second value of 23. 23 is greater than 5, so the comparison +now succeeds, and the code prints the value 23 to the screen.

    +

    Python doesn’t go nearly as far as Icon in adopting generators as a central +concept. Generators are considered part of the core Python language, but +learning or using them isn’t compulsory; if they don’t solve any problems that +you have, feel free to ignore them. One novel feature of Python’s interface as +compared to Icon’s is that a generator’s state is represented as a concrete +object (the iterator) that can be passed around to other functions or stored in +a data structure.

    +
    +

    See also

    +
    +
    PEP 255 - Simple Generators

    Written by Neil Schemenauer, Tim Peters, Magnus Lie Hetland. Implemented mostly +by Neil Schemenauer and Tim Peters, with other fixes from the Python Labs crew.

    +
    +
    +
    +
    +
    +

    PEP 263: Source Code Encodings

    +

    Python source files can now be declared as being in different character set +encodings. Encodings are declared by including a specially formatted comment in +the first or second line of the source file. For example, a UTF-8 file can be +declared with:

    +
    #!/usr/bin/env python
    +# -*- coding: UTF-8 -*-
    +
    +
    +

    Without such an encoding declaration, the default encoding used is 7-bit ASCII. +Executing or importing modules that contain string literals with 8-bit +characters and have no encoding declaration will result in a +DeprecationWarning being signalled by Python 2.3; in 2.4 this will be a +syntax error.

    +

    The encoding declaration only affects Unicode string literals, which will be +converted to Unicode using the specified encoding. Note that Python identifiers +are still restricted to ASCII characters, so you can’t have variable names that +use characters outside of the usual alphanumerics.

    +
    +

    See also

    +
    +
    PEP 263 - Defining Python Source Code Encodings

    Written by Marc-André Lemburg and Martin von Löwis; implemented by Suzuki Hisao +and Martin von Löwis.

    +
    +
    +
    +
    +
    +

    PEP 273: Importing Modules from ZIP Archives

    +

    The new zipimport module adds support for importing modules from a +ZIP-format archive. You don’t need to import the module explicitly; it will be +automatically imported if a ZIP archive’s filename is added to sys.path. +For example:

    +
    amk@nyman:~/src/python$ unzip -l /tmp/example.zip
    +Archive:  /tmp/example.zip
    +  Length     Date   Time    Name
    + --------    ----   ----    ----
    +     8467  11-26-02 22:30   jwzthreading.py
    + --------                   -------
    +     8467                   1 file
    +amk@nyman:~/src/python$ ./python
    +Python 2.3 (#1, Aug 1 2003, 19:54:32)
    +>>> import sys
    +>>> sys.path.insert(0, '/tmp/example.zip')  # Add .zip file to front of path
    +>>> import jwzthreading
    +>>> jwzthreading.__file__
    +'/tmp/example.zip/jwzthreading.py'
    +>>>
    +
    +
    +

    An entry in sys.path can now be the filename of a ZIP archive. The ZIP +archive can contain any kind of files, but only files named *.py, +*.pyc, or *.pyo can be imported. If an archive only contains +*.py files, Python will not attempt to modify the archive by adding the +corresponding *.pyc file, meaning that if a ZIP archive doesn’t contain +*.pyc files, importing may be rather slow.

    +

    A path within the archive can also be specified to only import from a +subdirectory; for example, the path /tmp/example.zip/lib/ would only +import from the lib/ subdirectory within the archive.

    +
    +

    See also

    +
    +
    PEP 273 - Import Modules from Zip Archives

    Written by James C. Ahlstrom, who also provided an implementation. Python 2.3 +follows the specification in PEP 273, but uses an implementation written by +Just van Rossum that uses the import hooks described in PEP 302. See section +PEP 302: New Import Hooks for a description of the new import hooks.

    +
    +
    +
    +
    +
    +

    PEP 277: Unicode file name support for Windows NT

    +

    On Windows NT, 2000, and XP, the system stores file names as Unicode strings. +Traditionally, Python has represented file names as byte strings, which is +inadequate because it renders some file names inaccessible.

    +

    Python now allows using arbitrary Unicode strings (within the limitations of the +file system) for all functions that expect file names, most notably the +open() built-in function. If a Unicode string is passed to +os.listdir(), Python now returns a list of Unicode strings. A new +function, os.getcwdu(), returns the current directory as a Unicode string.

    +

    Byte strings still work as file names, and on Windows Python will transparently +convert them to Unicode using the mbcs encoding.

    +

    Other systems also allow Unicode strings as file names but convert them to byte +strings before passing them to the system, which can cause a UnicodeError +to be raised. Applications can test whether arbitrary Unicode strings are +supported as file names by checking os.path.supports_unicode_filenames, +a Boolean value.

    +

    Under MacOS, os.listdir() may now return Unicode filenames.

    +
    +

    See also

    +
    +
    PEP 277 - Unicode file name support for Windows NT

    Written by Neil Hodgson; implemented by Neil Hodgson, Martin von Löwis, and Mark +Hammond.

    +
    +
    +
    +
    +
    +

    PEP 278: Universal Newline Support

    +

    The three major operating systems used today are Microsoft Windows, Apple’s +Macintosh OS, and the various Unix derivatives. A minor irritation of +cross-platform work is that these three platforms all use different characters to +mark the ends of lines in text files. Unix uses the linefeed (ASCII character +10), MacOS uses the carriage return (ASCII character 13), and Windows uses a +two-character sequence of a carriage return plus a newline.

    +

    Python’s file objects can now support end of line conventions other than the +one followed by the platform on which Python is running. Opening a file with +the mode 'U' or 'rU' will open a file for reading in universal +newlines mode. All three line ending conventions will be translated to a +'\n' in the strings returned by the various file methods such as +read() and readline().

    +

    Universal newline support is also used when importing modules and when executing +a file with the execfile() function. This means that Python modules can +be shared between all three operating systems without needing to convert the +line-endings.

    +

    This feature can be disabled when compiling Python by specifying the +--without-universal-newlines switch when running Python’s +configure script.

    +
    +

    See also

    +
    +
    PEP 278 - Universal Newline Support

    Written and implemented by Jack Jansen.

    +
    +
    +
    +
    +
    +

    PEP 279: enumerate()

    +

    A new built-in function, enumerate(), will make certain loops a bit +clearer. enumerate(thing), where thing is either an iterator or a +sequence, returns an iterator that will return (0, thing[0]), (1, +thing[1]), (2, thing[2]), and so forth.

    +

    A common idiom to change every element of a list looks like this:

    +
    for i in range(len(L)):
    +    item = L[i]
    +    # ... compute some result based on item ...
    +    L[i] = result
    +
    +
    +

    This can be rewritten using enumerate() as:

    +
    for i, item in enumerate(L):
    +    # ... compute some result based on item ...
    +    L[i] = result
    +
    +
    +
    +

    See also

    +
    +
    PEP 279 - The enumerate() built-in function

    Written and implemented by Raymond D. Hettinger.

    +
    +
    +
    +
    +
    +

    PEP 282: The logging Package

    +

    A standard package for writing logs, logging, has been added to Python +2.3. It provides a powerful and flexible mechanism for generating logging +output which can then be filtered and processed in various ways. A +configuration file written in a standard format can be used to control the +logging behavior of a program. Python includes handlers that will write log +records to standard error or to a file or socket, send them to the system log, +or even e-mail them to a particular address; of course, it’s also possible to +write your own handler classes.

    +

    The Logger class is the primary class. Most application code will deal +with one or more Logger objects, each one used by a particular +subsystem of the application. Each Logger is identified by a name, and +names are organized into a hierarchy using . as the component separator. +For example, you might have Logger instances named server, +server.auth and server.network. The latter two instances are below +server in the hierarchy. This means that if you turn up the verbosity for +server or direct server messages to a different handler, the changes +will also apply to records logged to server.auth and server.network. +There’s also a root Logger that’s the parent of all other loggers.

    +

    For simple uses, the logging package contains some convenience functions +that always use the root log:

    +
    import logging
    +
    +logging.debug('Debugging information')
    +logging.info('Informational message')
    +logging.warning('Warning:config file %s not found', 'server.conf')
    +logging.error('Error occurred')
    +logging.critical('Critical error -- shutting down')
    +
    +
    +

    This produces the following output:

    +
    WARNING:root:Warning:config file server.conf not found
    +ERROR:root:Error occurred
    +CRITICAL:root:Critical error -- shutting down
    +
    +
    +

    In the default configuration, informational and debugging messages are +suppressed and the output is sent to standard error. You can enable the display +of informational and debugging messages by calling the setLevel() method +on the root logger.

    +

    Notice the warning() call’s use of string formatting operators; all of the +functions for logging messages take the arguments (msg, arg1, arg2, ...) and +log the string resulting from msg % (arg1, arg2, ...).

    +

    There’s also an exception() function that records the most recent +traceback. Any of the other functions will also record the traceback if you +specify a true value for the keyword argument exc_info.

    +
    def f():
    +    try:    1/0
    +    except: logging.exception('Problem recorded')
    +
    +f()
    +
    +
    +

    This produces the following output:

    +
    ERROR:root:Problem recorded
    +Traceback (most recent call last):
    +  File "t.py", line 6, in f
    +    1/0
    +ZeroDivisionError: integer division or modulo by zero
    +
    +
    +

    Slightly more advanced programs will use a logger other than the root logger. +The getLogger(name) function is used to get a particular log, creating +it if it doesn’t exist yet. getLogger(None) returns the root logger.

    +
    log = logging.getLogger('server')
    + ...
    +log.info('Listening on port %i', port)
    + ...
    +log.critical('Disk full')
    + ...
    +
    +
    +

    Log records are usually propagated up the hierarchy, so a message logged to +server.auth is also seen by server and root, but a Logger +can prevent this by setting its propagate attribute to False.

    +

    There are more classes provided by the logging package that can be +customized. When a Logger instance is told to log a message, it +creates a LogRecord instance that is sent to any number of different +Handler instances. Loggers and handlers can also have an attached list +of filters, and each filter can cause the LogRecord to be ignored or +can modify the record before passing it along. When they’re finally output, +LogRecord instances are converted to text by a Formatter +class. All of these classes can be replaced by your own specially-written +classes.

    +

    With all of these features the logging package should provide enough +flexibility for even the most complicated applications. This is only an +incomplete overview of its features, so please see the package’s reference +documentation for all of the details. Reading PEP 282 will also be helpful.

    +
    +

    See also

    +
    +
    PEP 282 - A Logging System

    Written by Vinay Sajip and Trent Mick; implemented by Vinay Sajip.

    +
    +
    +
    +
    +
    +

    PEP 285: A Boolean Type

    +

    A Boolean type was added to Python 2.3. Two new constants were added to the +__builtin__ module, True and False. (True and +False constants were added to the built-ins in Python 2.2.1, but the +2.2.1 versions are simply set to integer values of 1 and 0 and aren’t a +different type.)

    +

    The type object for this new type is named bool; the constructor for it +takes any Python value and converts it to True or False.

    +
    >>> bool(1)
    +True
    +>>> bool(0)
    +False
    +>>> bool([])
    +False
    +>>> bool( (1,) )
    +True
    +
    +
    +

    Most of the standard library modules and built-in functions have been changed to +return Booleans.

    +
    >>> obj = []
    +>>> hasattr(obj, 'append')
    +True
    +>>> isinstance(obj, list)
    +True
    +>>> isinstance(obj, tuple)
    +False
    +
    +
    +

    Python’s Booleans were added with the primary goal of making code clearer. For +example, if you’re reading a function and encounter the statement return 1, +you might wonder whether the 1 represents a Boolean truth value, an index, +or a coefficient that multiplies some other quantity. If the statement is +return True, however, the meaning of the return value is quite clear.

    +

    Python’s Booleans were not added for the sake of strict type-checking. A very +strict language such as Pascal would also prevent you performing arithmetic with +Booleans, and would require that the expression in an if statement +always evaluate to a Boolean result. Python is not this strict and never will +be, as PEP 285 explicitly says. This means you can still use any expression +in an if statement, even ones that evaluate to a list or tuple or +some random object. The Boolean type is a subclass of the int class so +that arithmetic using a Boolean still works.

    +
    >>> True + 1
    +2
    +>>> False + 1
    +1
    +>>> False * 75
    +0
    +>>> True * 75
    +75
    +
    +
    +

    To sum up True and False in a sentence: they’re alternative +ways to spell the integer values 1 and 0, with the single difference that +str() and repr() return the strings 'True' and 'False' +instead of '1' and '0'.

    +
    +

    See also

    +
    +
    PEP 285 - Adding a bool type

    Written and implemented by GvR.

    +
    +
    +
    +
    +
    +

    PEP 293: Codec Error Handling Callbacks

    +

    When encoding a Unicode string into a byte string, unencodable characters may be +encountered. So far, Python has allowed specifying the error processing as +either “strict” (raising UnicodeError), “ignore” (skipping the +character), or “replace” (using a question mark in the output string), with +“strict” being the default behavior. It may be desirable to specify alternative +processing of such errors, such as inserting an XML character reference or HTML +entity reference into the converted string.

    +

    Python now has a flexible framework to add different processing strategies. New +error handlers can be added with codecs.register_error(), and codecs then +can access the error handler with codecs.lookup_error(). An equivalent C +API has been added for codecs written in C. The error handler gets the necessary +state information such as the string being converted, the position in the string +where the error was detected, and the target encoding. The handler can then +either raise an exception or return a replacement string.

    +

    Two additional error handlers have been implemented using this framework: +“backslashreplace” uses Python backslash quoting to represent unencodable +characters and “xmlcharrefreplace” emits XML character references.

    +
    +

    See also

    +
    +
    PEP 293 - Codec Error Handling Callbacks

    Written and implemented by Walter Dörwald.

    +
    +
    +
    +
    +
    +

    PEP 301: Package Index and Metadata for Distutils

    +

    Support for the long-requested Python catalog makes its first appearance in 2.3.

    +

    The heart of the catalog is the new Distutils register command. +Running python setup.py register will collect the metadata describing a +package, such as its name, version, maintainer, description, &c., and send it to +a central catalog server. The resulting catalog is available from +https://pypi.org.

    +

    To make the catalog a bit more useful, a new optional classifiers keyword +argument has been added to the Distutils setup() function. A list of +Trove-style strings can be supplied to help +classify the software.

    +

    Here’s an example setup.py with classifiers, written to be compatible +with older versions of the Distutils:

    +
    from distutils import core
    +kw = {'name': "Quixote",
    +      'version': "0.5.1",
    +      'description': "A highly Pythonic Web application framework",
    +      # ...
    +      }
    +
    +if (hasattr(core, 'setup_keywords') and
    +    'classifiers' in core.setup_keywords):
    +    kw['classifiers'] = \
    +        ['Topic :: Internet :: WWW/HTTP :: Dynamic Content',
    +         'Environment :: No Input/Output (Daemon)',
    +         'Intended Audience :: Developers'],
    +
    +core.setup(**kw)
    +
    +
    +

    The full list of classifiers can be obtained by running python setup.py +register --list-classifiers.

    +
    +

    See also

    +
    +
    PEP 301 - Package Index and Metadata for Distutils

    Written and implemented by Richard Jones.

    +
    +
    +
    +
    +
    +

    PEP 302: New Import Hooks

    +

    While it’s been possible to write custom import hooks ever since the +ihooks module was introduced in Python 1.3, no one has ever been really +happy with it because writing new import hooks is difficult and messy. There +have been various proposed alternatives such as the imputil and iu +modules, but none of them has ever gained much acceptance, and none of them were +easily usable from C code.

    +

    PEP 302 borrows ideas from its predecessors, especially from Gordon +McMillan’s iu module. Three new items are added to the sys +module:

    +
      +
    • sys.path_hooks is a list of callable objects; most often they’ll be +classes. Each callable takes a string containing a path and either returns an +importer object that will handle imports from this path or raises an +ImportError exception if it can’t handle this path.

    • +
    • sys.path_importer_cache caches importer objects for each path, so +sys.path_hooks will only need to be traversed once for each path.

    • +
    • sys.meta_path is a list of importer objects that will be traversed before +sys.path is checked. This list is initially empty, but user code can add +objects to it. Additional built-in and frozen modules can be imported by an +object added to this list.

    • +
    +

    Importer objects must have a single method, find_module(fullname, +path=None). fullname will be a module or package name, e.g. string or +distutils.core. find_module() must return a loader object that has a +single method, load_module(fullname), that creates and returns the +corresponding module object.

    +

    Pseudo-code for Python’s new import logic, therefore, looks something like this +(simplified a bit; see PEP 302 for the full details):

    +
    for mp in sys.meta_path:
    +    loader = mp(fullname)
    +    if loader is not None:
    +        <module> = loader.load_module(fullname)
    +
    +for path in sys.path:
    +    for hook in sys.path_hooks:
    +        try:
    +            importer = hook(path)
    +        except ImportError:
    +            # ImportError, so try the other path hooks
    +            pass
    +        else:
    +            loader = importer.find_module(fullname)
    +            <module> = loader.load_module(fullname)
    +
    +# Not found!
    +raise ImportError
    +
    +
    +
    +

    See also

    +
    +
    PEP 302 - New Import Hooks

    Written by Just van Rossum and Paul Moore. Implemented by Just van Rossum.

    +
    +
    +
    +
    +
    +

    PEP 305: Comma-separated Files

    +

    Comma-separated files are a format frequently used for exporting data from +databases and spreadsheets. Python 2.3 adds a parser for comma-separated files.

    +

    Comma-separated format is deceptively simple at first glance:

    +
    Costs,150,200,3.95
    +
    +
    +

    Read a line and call line.split(','): what could be simpler? But toss in +string data that can contain commas, and things get more complicated:

    +
    "Costs",150,200,3.95,"Includes taxes, shipping, and sundry items"
    +
    +
    +

    A big ugly regular expression can parse this, but using the new csv +package is much simpler:

    +
    import csv
    +
    +input = open('datafile', 'rb')
    +reader = csv.reader(input)
    +for line in reader:
    +    print line
    +
    +
    +

    The reader() function takes a number of different options. The field +separator isn’t limited to the comma and can be changed to any character, and so +can the quoting and line-ending characters.

    +

    Different dialects of comma-separated files can be defined and registered; +currently there are two dialects, both used by Microsoft Excel. A separate +csv.writer class will generate comma-separated files from a succession +of tuples or lists, quoting strings that contain the delimiter.

    +
    +

    See also

    +
    +
    PEP 305 - CSV File API

    Written and implemented by Kevin Altis, Dave Cole, Andrew McNamara, Skip +Montanaro, Cliff Wells.

    +
    +
    +
    +
    +
    +

    PEP 307: Pickle Enhancements

    +

    The pickle and cPickle modules received some attention during the +2.3 development cycle. In 2.2, new-style classes could be pickled without +difficulty, but they weren’t pickled very compactly; PEP 307 quotes a trivial +example where a new-style class results in a pickled string three times longer +than that for a classic class.

    +

    The solution was to invent a new pickle protocol. The pickle.dumps() +function has supported a text-or-binary flag for a long time. In 2.3, this +flag is redefined from a Boolean to an integer: 0 is the old text-mode pickle +format, 1 is the old binary format, and now 2 is a new 2.3-specific format. A +new constant, pickle.HIGHEST_PROTOCOL, can be used to select the +fanciest protocol available.

    +

    Unpickling is no longer considered a safe operation. 2.2’s pickle +provided hooks for trying to prevent unsafe classes from being unpickled +(specifically, a __safe_for_unpickling__ attribute), but none of this +code was ever audited and therefore it’s all been ripped out in 2.3. You should +not unpickle untrusted data in any version of Python.

    +

    To reduce the pickling overhead for new-style classes, a new interface for +customizing pickling was added using three special methods: +__getstate__(), __setstate__(), and __getnewargs__(). Consult +PEP 307 for the full semantics of these methods.

    +

    As a way to compress pickles yet further, it’s now possible to use integer codes +instead of long strings to identify pickled classes. The Python Software +Foundation will maintain a list of standardized codes; there’s also a range of +codes for private use. Currently no codes have been specified.

    +
    +

    See also

    +
    +
    PEP 307 - Extensions to the pickle protocol

    Written and implemented by Guido van Rossum and Tim Peters.

    +
    +
    +
    +
    +
    +

    Extended Slices

    +

    Ever since Python 1.4, the slicing syntax has supported an optional third “step” +or “stride” argument. For example, these are all legal Python syntax: +L[1:10:2], L[:-1:1], L[::-1]. This was added to Python at the +request of the developers of Numerical Python, which uses the third argument +extensively. However, Python’s built-in list, tuple, and string sequence types +have never supported this feature, raising a TypeError if you tried it. +Michael Hudson contributed a patch to fix this shortcoming.

    +

    For example, you can now easily extract the elements of a list that have even +indexes:

    +
    >>> L = range(10)
    +>>> L[::2]
    +[0, 2, 4, 6, 8]
    +
    +
    +

    Negative values also work to make a copy of the same list in reverse order:

    +
    >>> L[::-1]
    +[9, 8, 7, 6, 5, 4, 3, 2, 1, 0]
    +
    +
    +

    This also works for tuples, arrays, and strings:

    +
    >>> s='abcd'
    +>>> s[::2]
    +'ac'
    +>>> s[::-1]
    +'dcba'
    +
    +
    +

    If you have a mutable sequence such as a list or an array you can assign to or +delete an extended slice, but there are some differences between assignment to +extended and regular slices. Assignment to a regular slice can be used to +change the length of the sequence:

    +
    >>> a = range(3)
    +>>> a
    +[0, 1, 2]
    +>>> a[1:3] = [4, 5, 6]
    +>>> a
    +[0, 4, 5, 6]
    +
    +
    +

    Extended slices aren’t this flexible. When assigning to an extended slice, the +list on the right hand side of the statement must contain the same number of +items as the slice it is replacing:

    +
    >>> a = range(4)
    +>>> a
    +[0, 1, 2, 3]
    +>>> a[::2]
    +[0, 2]
    +>>> a[::2] = [0, -1]
    +>>> a
    +[0, 1, -1, 3]
    +>>> a[::2] = [0,1,2]
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in ?
    +ValueError: attempt to assign sequence of size 3 to extended slice of size 2
    +
    +
    +

    Deletion is more straightforward:

    +
    >>> a = range(4)
    +>>> a
    +[0, 1, 2, 3]
    +>>> a[::2]
    +[0, 2]
    +>>> del a[::2]
    +>>> a
    +[1, 3]
    +
    +
    +

    One can also now pass slice objects to the __getitem__() methods of the +built-in sequences:

    +
    >>> range(10).__getitem__(slice(0, 5, 2))
    +[0, 2, 4]
    +
    +
    +

    Or use slice objects directly in subscripts:

    +
    >>> range(10)[slice(0, 5, 2)]
    +[0, 2, 4]
    +
    +
    +

    To simplify implementing sequences that support extended slicing, slice objects +now have a method indices(length) which, given the length of a sequence, +returns a (start, stop, step) tuple that can be passed directly to +range(). indices() handles omitted and out-of-bounds indices in a +manner consistent with regular slices (and this innocuous phrase hides a welter +of confusing details!). The method is intended to be used like this:

    +
    class FakeSeq:
    +    ...
    +    def calc_item(self, i):
    +        ...
    +    def __getitem__(self, item):
    +        if isinstance(item, slice):
    +            indices = item.indices(len(self))
    +            return FakeSeq([self.calc_item(i) for i in range(*indices)])
    +        else:
    +            return self.calc_item(i)
    +
    +
    +

    From this example you can also see that the built-in slice object is +now the type object for the slice type, and is no longer a function. This is +consistent with Python 2.2, where int, str, etc., underwent +the same change.

    +
    +
    +

    Other Language Changes

    +

    Here are all of the changes that Python 2.3 makes to the core Python language.

    +
      +
    • The yield statement is now always a keyword, as described in +section PEP 255: Simple Generators of this document.

    • +
    • A new built-in function enumerate() was added, as described in section +PEP 279: enumerate() of this document.

    • +
    • Two new constants, True and False were added along with the +built-in bool type, as described in section PEP 285: A Boolean Type of this +document.

    • +
    • The int() type constructor will now return a long integer instead of +raising an OverflowError when a string or floating-point number is too +large to fit into an integer. This can lead to the paradoxical result that +isinstance(int(expression), int) is false, but that seems unlikely to cause +problems in practice.

    • +
    • Built-in types now support the extended slicing syntax, as described in +section Extended Slices of this document.

    • +
    • A new built-in function, sum(iterable, start=0), adds up the numeric +items in the iterable object and returns their sum. sum() only accepts +numbers, meaning that you can’t use it to concatenate a bunch of strings. +(Contributed by Alex Martelli.)

    • +
    • list.insert(pos, value) used to insert value at the front of the list +when pos was negative. The behaviour has now been changed to be consistent +with slice indexing, so when pos is -1 the value will be inserted before the +last element, and so forth.

    • +
    • list.index(value), which searches for value within the list and returns +its index, now takes optional start and stop arguments to limit the search +to only part of the list.

    • +
    • Dictionaries have a new method, pop(key[, *default*]), that returns +the value corresponding to key and removes that key/value pair from the +dictionary. If the requested key isn’t present in the dictionary, default is +returned if it’s specified and KeyError raised if it isn’t.

      +
      >>> d = {1:2}
      +>>> d
      +{1: 2}
      +>>> d.pop(4)
      +Traceback (most recent call last):
      +  File "stdin", line 1, in ?
      +KeyError: 4
      +>>> d.pop(1)
      +2
      +>>> d.pop(1)
      +Traceback (most recent call last):
      +  File "stdin", line 1, in ?
      +KeyError: 'pop(): dictionary is empty'
      +>>> d
      +{}
      +>>>
      +
      +
      +

      There’s also a new class method, dict.fromkeys(iterable, value), that +creates a dictionary with keys taken from the supplied iterator iterable and +all values set to value, defaulting to None.

      +

      (Patches contributed by Raymond Hettinger.)

      +

      Also, the dict() constructor now accepts keyword arguments to simplify +creating small dictionaries:

      +
      >>> dict(red=1, blue=2, green=3, black=4)
      +{'blue': 2, 'black': 4, 'green': 3, 'red': 1}
      +
      +
      +

      (Contributed by Just van Rossum.)

      +
    • +
    • The assert statement no longer checks the __debug__ flag, so +you can no longer disable assertions by assigning to __debug__. Running +Python with the -O switch will still generate code that doesn’t +execute any assertions.

    • +
    • Most type objects are now callable, so you can use them to create new objects +such as functions, classes, and modules. (This means that the new module +can be deprecated in a future Python version, because you can now use the type +objects available in the types module.) For example, you can create a new +module object with the following code:

      +
      >>> import types
      +>>> m = types.ModuleType('abc','docstring')
      +>>> m
      +<module 'abc' (built-in)>
      +>>> m.__doc__
      +'docstring'
      +
      +
      +
    • +
    • A new warning, PendingDeprecationWarning was added to indicate features +which are in the process of being deprecated. The warning will not be printed +by default. To check for use of features that will be deprecated in the future, +supply -Walways::PendingDeprecationWarning:: on the command line or +use warnings.filterwarnings().

    • +
    • The process of deprecating string-based exceptions, as in raise "Error +occurred", has begun. Raising a string will now trigger +PendingDeprecationWarning.

    • +
    • Using None as a variable name will now result in a SyntaxWarning +warning. In a future version of Python, None may finally become a keyword.

    • +
    • The xreadlines() method of file objects, introduced in Python 2.1, is no +longer necessary because files now behave as their own iterator. +xreadlines() was originally introduced as a faster way to loop over all +the lines in a file, but now you can simply write for line in file_obj. +File objects also have a new read-only encoding attribute that gives the +encoding used by the file; Unicode strings written to the file will be +automatically converted to bytes using the given encoding.

    • +
    • The method resolution order used by new-style classes has changed, though +you’ll only notice the difference if you have a really complicated inheritance +hierarchy. Classic classes are unaffected by this change. Python 2.2 +originally used a topological sort of a class’s ancestors, but 2.3 now uses the +C3 algorithm as described in the paper “A Monotonic Superclass Linearization +for Dylan”. To +understand the motivation for this change, read Michele Simionato’s article +“Python 2.3 Method Resolution Order”, or +read the thread on python-dev starting with the message at +https://mail.python.org/pipermail/python-dev/2002-October/029035.html. Samuele +Pedroni first pointed out the problem and also implemented the fix by coding the +C3 algorithm.

    • +
    • Python runs multithreaded programs by switching between threads after +executing N bytecodes. The default value for N has been increased from 10 to +100 bytecodes, speeding up single-threaded applications by reducing the +switching overhead. Some multithreaded applications may suffer slower response +time, but that’s easily fixed by setting the limit back to a lower number using +sys.setcheckinterval(N). The limit can be retrieved with the new +sys.getcheckinterval() function.

    • +
    • One minor but far-reaching change is that the names of extension types defined +by the modules included with Python now contain the module and a '.' in +front of the type name. For example, in Python 2.2, if you created a socket and +printed its __class__, you’d get this output:

      +
      >>> s = socket.socket()
      +>>> s.__class__
      +<type 'socket'>
      +
      +
      +

      In 2.3, you get this:

      +
      >>> s.__class__
      +<type '_socket.socket'>
      +
      +
      +
    • +
    • One of the noted incompatibilities between old- and new-style classes has been +removed: you can now assign to the __name__ and __bases__ +attributes of new-style classes. There are some restrictions on what can be +assigned to __bases__ along the lines of those relating to assigning to +an instance’s __class__ attribute.

    • +
    +
    +

    String Changes

    +
      +
    • The in operator now works differently for strings. Previously, when +evaluating X in Y where X and Y are strings, X could only be a single +character. That’s now changed; X can be a string of any length, and X in Y +will return True if X is a substring of Y. If X is the empty +string, the result is always True.

      +
      >>> 'ab' in 'abcd'
      +True
      +>>> 'ad' in 'abcd'
      +False
      +>>> '' in 'abcd'
      +True
      +
      +
      +

      Note that this doesn’t tell you where the substring starts; if you need that +information, use the find() string method.

      +
    • +
    • The strip(), lstrip(), and rstrip() string methods now have +an optional argument for specifying the characters to strip. The default is +still to remove all whitespace characters:

      +
      >>> '   abc '.strip()
      +'abc'
      +>>> '><><abc<><><>'.strip('<>')
      +'abc'
      +>>> '><><abc<><><>\n'.strip('<>')
      +'abc<><><>\n'
      +>>> u'\u4000\u4001abc\u4000'.strip(u'\u4000')
      +u'\u4001abc'
      +>>>
      +
      +
      +

      (Suggested by Simon Brunning and implemented by Walter Dörwald.)

      +
    • +
    • The startswith() and endswith() string methods now accept negative +numbers for the start and end parameters.

    • +
    • Another new string method is zfill(), originally a function in the +string module. zfill() pads a numeric string with zeros on the +left until it’s the specified width. Note that the % operator is still more +flexible and powerful than zfill().

      +
      >>> '45'.zfill(4)
      +'0045'
      +>>> '12345'.zfill(4)
      +'12345'
      +>>> 'goofy'.zfill(6)
      +'0goofy'
      +
      +
      +

      (Contributed by Walter Dörwald.)

      +
    • +
    • A new type object, basestring, has been added. Both 8-bit strings and +Unicode strings inherit from this type, so isinstance(obj, basestring) will +return True for either kind of string. It’s a completely abstract +type, so you can’t create basestring instances.

    • +
    • Interned strings are no longer immortal and will now be garbage-collected in +the usual way when the only reference to them is from the internal dictionary of +interned strings. (Implemented by Oren Tirosh.)

    • +
    +
    +
    +

    Optimizations

    +
      +
    • The creation of new-style class instances has been made much faster; they’re +now faster than classic classes!

    • +
    • The sort() method of list objects has been extensively rewritten by Tim +Peters, and the implementation is significantly faster.

    • +
    • Multiplication of large long integers is now much faster thanks to an +implementation of Karatsuba multiplication, an algorithm that scales better than +the O(n*n) required for the grade-school multiplication algorithm. (Original +patch by Christopher A. Craig, and significantly reworked by Tim Peters.)

    • +
    • The SET_LINENO opcode is now gone. This may provide a small speed +increase, depending on your compiler’s idiosyncrasies. See section +Other Changes and Fixes for a longer explanation. (Removed by Michael Hudson.)

    • +
    • xrange() objects now have their own iterator, making for i in +xrange(n) slightly faster than for i in range(n). (Patch by Raymond +Hettinger.)

    • +
    • A number of small rearrangements have been made in various hotspots to improve +performance, such as inlining a function or removing some code. (Implemented +mostly by GvR, but lots of people have contributed single changes.)

    • +
    +

    The net result of the 2.3 optimizations is that Python 2.3 runs the pystone +benchmark around 25% faster than Python 2.2.

    +
    +
    +
    +

    New, Improved, and Deprecated Modules

    +

    As usual, Python’s standard library received a number of enhancements and bug +fixes. Here’s a partial list of the most notable changes, sorted alphabetically +by module name. Consult the Misc/NEWS file in the source tree for a more +complete list of changes, or look through the CVS logs for all the details.

    +
      +
    • The array module now supports arrays of Unicode characters using the +'u' format character. Arrays also now support using the += assignment +operator to add another array’s contents, and the *= assignment operator to +repeat an array. (Contributed by Jason Orendorff.)

    • +
    • The bsddb module has been replaced by version 4.1.6 of the PyBSDDB package, providing a more complete interface +to the transactional features of the BerkeleyDB library.

      +

      The old version of the module has been renamed to bsddb185 and is no +longer built automatically; you’ll have to edit Modules/Setup to enable +it. Note that the new bsddb package is intended to be compatible with +the old module, so be sure to file bugs if you discover any incompatibilities. +When upgrading to Python 2.3, if the new interpreter is compiled with a new +version of the underlying BerkeleyDB library, you will almost certainly have to +convert your database files to the new version. You can do this fairly easily +with the new scripts db2pickle.py and pickle2db.py which you +will find in the distribution’s Tools/scripts directory. If you’ve +already been using the PyBSDDB package and importing it as bsddb3, you +will have to change your import statements to import it as bsddb.

      +
    • +
    • The new bz2 module is an interface to the bz2 data compression library. +bz2-compressed data is usually smaller than corresponding +zlib-compressed data. (Contributed by Gustavo Niemeyer.)

    • +
    • A set of standard date/time types has been added in the new datetime +module. See the following section for more details.

    • +
    • The Distutils Extension class now supports an extra constructor +argument named depends for listing additional source files that an extension +depends on. This lets Distutils recompile the module if any of the dependency +files are modified. For example, if sampmodule.c includes the header +file sample.h, you would create the Extension object like +this:

      +
      ext = Extension("samp",
      +                sources=["sampmodule.c"],
      +                depends=["sample.h"])
      +
      +
      +

      Modifying sample.h would then cause the module to be recompiled. +(Contributed by Jeremy Hylton.)

      +
    • +
    • Other minor changes to Distutils: it now checks for the CC, +CFLAGS, CPP, LDFLAGS, and CPPFLAGS +environment variables, using them to override the settings in Python’s +configuration (contributed by Robert Weber).

    • +
    • Previously the doctest module would only search the docstrings of +public methods and functions for test cases, but it now also examines private +ones as well. The DocTestSuite() function creates a +unittest.TestSuite object from a set of doctest tests.

    • +
    • The new gc.get_referents(object) function returns a list of all the +objects referenced by object.

    • +
    • The getopt module gained a new function, gnu_getopt(), that +supports the same arguments as the existing getopt() function but uses +GNU-style scanning mode. The existing getopt() stops processing options as +soon as a non-option argument is encountered, but in GNU-style mode processing +continues, meaning that options and arguments can be mixed. For example:

      +
      >>> getopt.getopt(['-f', 'filename', 'output', '-v'], 'f:v')
      +([('-f', 'filename')], ['output', '-v'])
      +>>> getopt.gnu_getopt(['-f', 'filename', 'output', '-v'], 'f:v')
      +([('-f', 'filename'), ('-v', '')], ['output'])
      +
      +
      +

      (Contributed by Peter Åstrand.)

      +
    • +
    • The grp, pwd, and resource modules now return enhanced +tuples:

      +
      >>> import grp
      +>>> g = grp.getgrnam('amk')
      +>>> g.gr_name, g.gr_gid
      +('amk', 500)
      +
      +
      +
    • +
    • The gzip module can now handle files exceeding 2 GiB.

    • +
    • The new heapq module contains an implementation of a heap queue +algorithm. A heap is an array-like data structure that keeps items in a +partially sorted order such that, for every index k, heap[k] <= +heap[2*k+1] and heap[k] <= heap[2*k+2]. This makes it quick to remove the +smallest item, and inserting a new item while maintaining the heap property is +O(lg n). (See https://xlinux.nist.gov/dads//HTML/priorityque.html for more +information about the priority queue data structure.)

      +

      The heapq module provides heappush() and heappop() functions +for adding and removing items while maintaining the heap property on top of some +other mutable Python sequence type. Here’s an example that uses a Python list:

      +
      >>> import heapq
      +>>> heap = []
      +>>> for item in [3, 7, 5, 11, 1]:
      +...    heapq.heappush(heap, item)
      +...
      +>>> heap
      +[1, 3, 5, 11, 7]
      +>>> heapq.heappop(heap)
      +1
      +>>> heapq.heappop(heap)
      +3
      +>>> heap
      +[5, 7, 11]
      +
      +
      +

      (Contributed by Kevin O’Connor.)

      +
    • +
    • The IDLE integrated development environment has been updated using the code +from the IDLEfork project (http://idlefork.sourceforge.net). The most notable feature is +that the code being developed is now executed in a subprocess, meaning that +there’s no longer any need for manual reload() operations. IDLE’s core code +has been incorporated into the standard library as the idlelib package.

    • +
    • The imaplib module now supports IMAP over SSL. (Contributed by Piers +Lauder and Tino Lange.)

    • +
    • The itertools contains a number of useful functions for use with +iterators, inspired by various functions provided by the ML and Haskell +languages. For example, itertools.ifilter(predicate, iterator) returns all +elements in the iterator for which the function predicate() returns +True, and itertools.repeat(obj, N) returns obj N times. +There are a number of other functions in the module; see the package’s reference +documentation for details. +(Contributed by Raymond Hettinger.)

    • +
    • Two new functions in the math module, degrees(rads) and +radians(degs), convert between radians and degrees. Other functions in +the math module such as math.sin() and math.cos() have always +required input values measured in radians. Also, an optional base argument +was added to math.log() to make it easier to compute logarithms for bases +other than e and 10. (Contributed by Raymond Hettinger.)

    • +
    • Several new POSIX functions (getpgid(), killpg(), lchown(), +loadavg(), major(), makedev(), minor(), and +mknod()) were added to the posix module that underlies the +os module. (Contributed by Gustavo Niemeyer, Geert Jansen, and Denis S. +Otkidach.)

    • +
    • In the os module, the *stat() family of functions can now report +fractions of a second in a timestamp. Such time stamps are represented as +floats, similar to the value returned by time.time().

      +

      During testing, it was found that some applications will break if time stamps +are floats. For compatibility, when using the tuple interface of the +stat_result time stamps will be represented as integers. When using +named fields (a feature first introduced in Python 2.2), time stamps are still +represented as integers, unless os.stat_float_times() is invoked to enable +float return values:

      +
      >>> os.stat("/tmp").st_mtime
      +1034791200
      +>>> os.stat_float_times(True)
      +>>> os.stat("/tmp").st_mtime
      +1034791200.6335014
      +
      +
      +

      In Python 2.4, the default will change to always returning floats.

      +

      Application developers should enable this feature only if all their libraries +work properly when confronted with floating point time stamps, or if they use +the tuple API. If used, the feature should be activated on an application level +instead of trying to enable it on a per-use basis.

      +
    • +
    • The optparse module contains a new parser for command-line arguments +that can convert option values to a particular Python type and will +automatically generate a usage message. See the following section for more +details.

    • +
    • The old and never-documented linuxaudiodev module has been deprecated, +and a new version named ossaudiodev has been added. The module was +renamed because the OSS sound drivers can be used on platforms other than Linux, +and the interface has also been tidied and brought up to date in various ways. +(Contributed by Greg Ward and Nicholas FitzRoy-Dale.)

    • +
    • The new platform module contains a number of functions that try to +determine various properties of the platform you’re running on. There are +functions for getting the architecture, CPU type, the Windows OS version, and +even the Linux distribution version. (Contributed by Marc-André Lemburg.)

    • +
    • The parser objects provided by the pyexpat module can now optionally +buffer character data, resulting in fewer calls to your character data handler +and therefore faster performance. Setting the parser object’s +buffer_text attribute to True will enable buffering.

    • +
    • The sample(population, k) function was added to the random +module. population is a sequence or xrange object containing the +elements of a population, and sample() chooses k elements from the +population without replacing chosen elements. k can be any value up to +len(population). For example:

      +
      >>> days = ['Mo', 'Tu', 'We', 'Th', 'Fr', 'St', 'Sn']
      +>>> random.sample(days, 3)      # Choose 3 elements
      +['St', 'Sn', 'Th']
      +>>> random.sample(days, 7)      # Choose 7 elements
      +['Tu', 'Th', 'Mo', 'We', 'St', 'Fr', 'Sn']
      +>>> random.sample(days, 7)      # Choose 7 again
      +['We', 'Mo', 'Sn', 'Fr', 'Tu', 'St', 'Th']
      +>>> random.sample(days, 8)      # Can't choose eight
      +Traceback (most recent call last):
      +  File "<stdin>", line 1, in ?
      +  File "random.py", line 414, in sample
      +      raise ValueError, "sample larger than population"
      +ValueError: sample larger than population
      +>>> random.sample(xrange(1,10000,2), 10)   # Choose ten odd nos. under 10000
      +[3407, 3805, 1505, 7023, 2401, 2267, 9733, 3151, 8083, 9195]
      +
      +
      +

      The random module now uses a new algorithm, the Mersenne Twister, +implemented in C. It’s faster and more extensively studied than the previous +algorithm.

      +

      (All changes contributed by Raymond Hettinger.)

      +
    • +
    • The readline module also gained a number of new functions: +get_history_item(), get_current_history_length(), and +redisplay().

    • +
    • The rexec and Bastion modules have been declared dead, and +attempts to import them will fail with a RuntimeError. New-style classes +provide new ways to break out of the restricted execution environment provided +by rexec, and no one has interest in fixing them or time to do so. If +you have applications using rexec, rewrite them to use something else.

      +

      (Sticking with Python 2.2 or 2.1 will not make your applications any safer +because there are known bugs in the rexec module in those versions. To +repeat: if you’re using rexec, stop using it immediately.)

      +
    • +
    • The rotor module has been deprecated because the algorithm it uses for +encryption is not believed to be secure. If you need encryption, use one of the +several AES Python modules that are available separately.

    • +
    • The shutil module gained a move(src, dest) function that +recursively moves a file or directory to a new location.

    • +
    • Support for more advanced POSIX signal handling was added to the signal +but then removed again as it proved impossible to make it work reliably across +platforms.

    • +
    • The socket module now supports timeouts. You can call the +settimeout(t) method on a socket object to set a timeout of t seconds. +Subsequent socket operations that take longer than t seconds to complete will +abort and raise a socket.timeout exception.

      +

      The original timeout implementation was by Tim O’Malley. Michael Gilfix +integrated it into the Python socket module and shepherded it through a +lengthy review. After the code was checked in, Guido van Rossum rewrote parts +of it. (This is a good example of a collaborative development process in +action.)

      +
    • +
    • On Windows, the socket module now ships with Secure Sockets Layer +(SSL) support.

    • +
    • The value of the C PYTHON_API_VERSION macro is now exposed at the +Python level as sys.api_version. The current exception can be cleared by +calling the new sys.exc_clear() function.

    • +
    • The new tarfile module allows reading from and writing to +tar-format archive files. (Contributed by Lars Gustäbel.)

    • +
    • The new textwrap module contains functions for wrapping strings +containing paragraphs of text. The wrap(text, width) function takes a +string and returns a list containing the text split into lines of no more than +the chosen width. The fill(text, width) function returns a single +string, reformatted to fit into lines no longer than the chosen width. (As you +can guess, fill() is built on top of wrap(). For example:

      +
      >>> import textwrap
      +>>> paragraph = "Not a whit, we defy augury: ... more text ..."
      +>>> textwrap.wrap(paragraph, 60)
      +["Not a whit, we defy augury: there's a special providence in",
      + "the fall of a sparrow. If it be now, 'tis not to come; if it",
      + ...]
      +>>> print textwrap.fill(paragraph, 35)
      +Not a whit, we defy augury: there's
      +a special providence in the fall of
      +a sparrow. If it be now, 'tis not
      +to come; if it be not to come, it
      +will be now; if it be not now, yet
      +it will come: the readiness is all.
      +>>>
      +
      +
      +

      The module also contains a TextWrapper class that actually implements +the text wrapping strategy. Both the TextWrapper class and the +wrap() and fill() functions support a number of additional keyword +arguments for fine-tuning the formatting; consult the module’s documentation +for details. (Contributed by Greg Ward.)

      +
    • +
    • The thread and threading modules now have companion modules, +dummy_thread and dummy_threading, that provide a do-nothing +implementation of the thread module’s interface for platforms where +threads are not supported. The intention is to simplify thread-aware modules +(ones that don’t rely on threads to run) by putting the following code at the +top:

      +
      try:
      +    import threading as _threading
      +except ImportError:
      +    import dummy_threading as _threading
      +
      +
      +

      In this example, _threading is used as the module name to make it clear +that the module being used is not necessarily the actual threading +module. Code can call functions and use classes in _threading whether or +not threads are supported, avoiding an if statement and making the +code slightly clearer. This module will not magically make multithreaded code +run without threads; code that waits for another thread to return or to do +something will simply hang forever.

      +
    • +
    • The time module’s strptime() function has long been an annoyance +because it uses the platform C library’s strptime() implementation, and +different platforms sometimes have odd bugs. Brett Cannon contributed a +portable implementation that’s written in pure Python and should behave +identically on all platforms.

    • +
    • The new timeit module helps measure how long snippets of Python code +take to execute. The timeit.py file can be run directly from the +command line, or the module’s Timer class can be imported and used +directly. Here’s a short example that figures out whether it’s faster to +convert an 8-bit string to Unicode by appending an empty Unicode string to it or +by using the unicode() function:

      +
      import timeit
      +
      +timer1 = timeit.Timer('unicode("abc")')
      +timer2 = timeit.Timer('"abc" + u""')
      +
      +# Run three trials
      +print timer1.repeat(repeat=3, number=100000)
      +print timer2.repeat(repeat=3, number=100000)
      +
      +# On my laptop this outputs:
      +# [0.36831796169281006, 0.37441694736480713, 0.35304892063140869]
      +# [0.17574405670166016, 0.18193507194519043, 0.17565798759460449]
      +
      +
      +
    • +
    • The Tix module has received various bug fixes and updates for the +current version of the Tix package.

    • +
    • The Tkinter module now works with a thread-enabled version of Tcl. +Tcl’s threading model requires that widgets only be accessed from the thread in +which they’re created; accesses from another thread can cause Tcl to panic. For +certain Tcl interfaces, Tkinter will now automatically avoid this when a +widget is accessed from a different thread by marshalling a command, passing it +to the correct thread, and waiting for the results. Other interfaces can’t be +handled automatically but Tkinter will now raise an exception on such an +access so that you can at least find out about the problem. See +https://mail.python.org/pipermail/python-dev/2002-December/031107.html for a more +detailed explanation of this change. (Implemented by Martin von Löwis.)

    • +
    • Calling Tcl methods through _tkinter no longer returns only strings. +Instead, if Tcl returns other objects those objects are converted to their +Python equivalent, if one exists, or wrapped with a _tkinter.Tcl_Obj +object if no Python equivalent exists. This behavior can be controlled through +the wantobjects() method of tkapp objects.

      +

      When using _tkinter through the Tkinter module (as most Tkinter +applications will), this feature is always activated. It should not cause +compatibility problems, since Tkinter would always convert string results to +Python types where possible.

      +

      If any incompatibilities are found, the old behavior can be restored by setting +the wantobjects variable in the Tkinter module to false before +creating the first tkapp object.

      +
      import Tkinter
      +Tkinter.wantobjects = 0
      +
      +
      +

      Any breakage caused by this change should be reported as a bug.

      +
    • +
    • The UserDict module has a new DictMixin class which defines +all dictionary methods for classes that already have a minimum mapping +interface. This greatly simplifies writing classes that need to be +substitutable for dictionaries, such as the classes in the shelve +module.

      +

      Adding the mix-in as a superclass provides the full dictionary interface +whenever the class defines __getitem__(), __setitem__(), +__delitem__(), and keys(). For example:

      +
      >>> import UserDict
      +>>> class SeqDict(UserDict.DictMixin):
      +...     """Dictionary lookalike implemented with lists."""
      +...     def __init__(self):
      +...         self.keylist = []
      +...         self.valuelist = []
      +...     def __getitem__(self, key):
      +...         try:
      +...             i = self.keylist.index(key)
      +...         except ValueError:
      +...             raise KeyError
      +...         return self.valuelist[i]
      +...     def __setitem__(self, key, value):
      +...         try:
      +...             i = self.keylist.index(key)
      +...             self.valuelist[i] = value
      +...         except ValueError:
      +...             self.keylist.append(key)
      +...             self.valuelist.append(value)
      +...     def __delitem__(self, key):
      +...         try:
      +...             i = self.keylist.index(key)
      +...         except ValueError:
      +...             raise KeyError
      +...         self.keylist.pop(i)
      +...         self.valuelist.pop(i)
      +...     def keys(self):
      +...         return list(self.keylist)
      +...
      +>>> s = SeqDict()
      +>>> dir(s)      # See that other dictionary methods are implemented
      +['__cmp__', '__contains__', '__delitem__', '__doc__', '__getitem__',
      + '__init__', '__iter__', '__len__', '__module__', '__repr__',
      + '__setitem__', 'clear', 'get', 'has_key', 'items', 'iteritems',
      + 'iterkeys', 'itervalues', 'keylist', 'keys', 'pop', 'popitem',
      + 'setdefault', 'update', 'valuelist', 'values']
      +
      +
      +

      (Contributed by Raymond Hettinger.)

      +
    • +
    • The DOM implementation in xml.dom.minidom can now generate XML output +in a particular encoding by providing an optional encoding argument to the +toxml() and toprettyxml() methods of DOM nodes.

    • +
    • The xmlrpclib module now supports an XML-RPC extension for handling nil +data values such as Python’s None. Nil values are always supported on +unmarshalling an XML-RPC response. To generate requests containing None, +you must supply a true value for the allow_none parameter when creating a +Marshaller instance.

    • +
    • The new DocXMLRPCServer module allows writing self-documenting XML-RPC +servers. Run it in demo mode (as a program) to see it in action. Pointing the +Web browser to the RPC server produces pydoc-style documentation; pointing +xmlrpclib to the server allows invoking the actual methods. (Contributed by +Brian Quinlan.)

    • +
    • Support for internationalized domain names (RFCs 3454, 3490, 3491, and 3492) +has been added. The “idna” encoding can be used to convert between a Unicode +domain name and the ASCII-compatible encoding (ACE) of that name.

      +
      >{}>{}> u"www.Alliancefrançaise.nu".encode("idna")
      +'www.xn--alliancefranaise-npb.nu'
      +
      +
      +

      The socket module has also been extended to transparently convert +Unicode hostnames to the ACE version before passing them to the C library. +Modules that deal with hostnames such as httplib and ftplib) +also support Unicode host names; httplib also sends HTTP Host +headers using the ACE version of the domain name. urllib supports +Unicode URLs with non-ASCII host names as long as the path part of the URL +is ASCII only.

      +

      To implement this change, the stringprep module, the mkstringprep +tool and the punycode encoding have been added.

      +
    • +
    +
    +

    Date/Time Type

    +

    Date and time types suitable for expressing timestamps were added as the +datetime module. The types don’t support different calendars or many +fancy features, and just stick to the basics of representing time.

    +

    The three primary types are: date, representing a day, month, and year; +time, consisting of hour, minute, and second; and datetime, +which contains all the attributes of both date and time. +There’s also a timedelta class representing differences between two +points in time, and time zone logic is implemented by classes inheriting from +the abstract tzinfo class.

    +

    You can create instances of date and time by either supplying +keyword arguments to the appropriate constructor, e.g. +datetime.date(year=1972, month=10, day=15), or by using one of a number of +class methods. For example, the date.today() class method returns the +current local date.

    +

    Once created, instances of the date/time classes are all immutable. There are a +number of methods for producing formatted strings from objects:

    +
    >>> import datetime
    +>>> now = datetime.datetime.now()
    +>>> now.isoformat()
    +'2002-12-30T21:27:03.994956'
    +>>> now.ctime()  # Only available on date, datetime
    +'Mon Dec 30 21:27:03 2002'
    +>>> now.strftime('%Y %d %b')
    +'2002 30 Dec'
    +
    +
    +

    The replace() method allows modifying one or more fields of a +date or datetime instance, returning a new instance:

    +
    >>> d = datetime.datetime.now()
    +>>> d
    +datetime.datetime(2002, 12, 30, 22, 15, 38, 827738)
    +>>> d.replace(year=2001, hour = 12)
    +datetime.datetime(2001, 12, 30, 12, 15, 38, 827738)
    +>>>
    +
    +
    +

    Instances can be compared, hashed, and converted to strings (the result is the +same as that of isoformat()). date and datetime +instances can be subtracted from each other, and added to timedelta +instances. The largest missing feature is that there’s no standard library +support for parsing strings and getting back a date or +datetime.

    +

    For more information, refer to the module’s reference documentation. +(Contributed by Tim Peters.)

    +
    +
    +

    The optparse Module

    +

    The getopt module provides simple parsing of command-line arguments. The +new optparse module (originally named Optik) provides more elaborate +command-line parsing that follows the Unix conventions, automatically creates +the output for --help, and can perform different actions for different +options.

    +

    You start by creating an instance of OptionParser and telling it what +your program’s options are.

    +
    import sys
    +from optparse import OptionParser
    +
    +op = OptionParser()
    +op.add_option('-i', '--input',
    +              action='store', type='string', dest='input',
    +              help='set input filename')
    +op.add_option('-l', '--length',
    +              action='store', type='int', dest='length',
    +              help='set maximum length of output')
    +
    +
    +

    Parsing a command line is then done by calling the parse_args() method.

    +
    options, args = op.parse_args(sys.argv[1:])
    +print options
    +print args
    +
    +
    +

    This returns an object containing all of the option values, and a list of +strings containing the remaining arguments.

    +

    Invoking the script with the various arguments now works as you’d expect it to. +Note that the length argument is automatically converted to an integer.

    +
    $ ./python opt.py -i data arg1
    +<Values at 0x400cad4c: {'input': 'data', 'length': None}>
    +['arg1']
    +$ ./python opt.py --input=data --length=4
    +<Values at 0x400cad2c: {'input': 'data', 'length': 4}>
    +[]
    +$
    +
    +
    +

    The help message is automatically generated for you:

    +
    $ ./python opt.py --help
    +usage: opt.py [options]
    +
    +options:
    +  -h, --help            show this help message and exit
    +  -iINPUT, --input=INPUT
    +                        set input filename
    +  -lLENGTH, --length=LENGTH
    +                        set maximum length of output
    +$
    +
    +
    +

    See the module’s documentation for more details.

    +

    Optik was written by Greg Ward, with suggestions from the readers of the Getopt +SIG.

    +
    +
    +
    +

    Pymalloc: A Specialized Object Allocator

    +

    Pymalloc, a specialized object allocator written by Vladimir Marangozov, was a +feature added to Python 2.1. Pymalloc is intended to be faster than the system +malloc() and to have less memory overhead for allocation patterns typical +of Python programs. The allocator uses C’s malloc() function to get large +pools of memory and then fulfills smaller memory requests from these pools.

    +

    In 2.1 and 2.2, pymalloc was an experimental feature and wasn’t enabled by +default; you had to explicitly enable it when compiling Python by providing the +--with-pymalloc option to the configure script. In 2.3, +pymalloc has had further enhancements and is now enabled by default; you’ll have +to supply --without-pymalloc to disable it.

    +

    This change is transparent to code written in Python; however, pymalloc may +expose bugs in C extensions. Authors of C extension modules should test their +code with pymalloc enabled, because some incorrect code may cause core dumps at +runtime.

    +

    There’s one particularly common error that causes problems. There are a number +of memory allocation functions in Python’s C API that have previously just been +aliases for the C library’s malloc() and free(), meaning that if +you accidentally called mismatched functions the error wouldn’t be noticeable. +When the object allocator is enabled, these functions aren’t aliases of +malloc() and free() any more, and calling the wrong function to +free memory may get you a core dump. For example, if memory was allocated using +PyObject_Malloc(), it has to be freed using PyObject_Free(), not +free(). A few modules included with Python fell afoul of this and had to +be fixed; doubtless there are more third-party modules that will have the same +problem.

    +

    As part of this change, the confusing multiple interfaces for allocating memory +have been consolidated down into two API families. Memory allocated with one +family must not be manipulated with functions from the other family. There is +one family for allocating chunks of memory and another family of functions +specifically for allocating Python objects.

    + +

    Thanks to lots of work by Tim Peters, pymalloc in 2.3 also provides debugging +features to catch memory overwrites and doubled frees in both extension modules +and in the interpreter itself. To enable this support, compile a debugging +version of the Python interpreter by running configure with +--with-pydebug.

    +

    To aid extension writers, a header file Misc/pymemcompat.h is +distributed with the source to Python 2.3 that allows Python extensions to use +the 2.3 interfaces to memory allocation while compiling against any version of +Python since 1.5.2. You would copy the file from Python’s source distribution +and bundle it with the source of your extension.

    +
    +

    See also

    +
    +
    https://hg.python.org/cpython/file/default/Objects/obmalloc.c

    For the full details of the pymalloc implementation, see the comments at +the top of the file Objects/obmalloc.c in the Python source code. +The above link points to the file within the python.org SVN browser.

    +
    +
    +
    +
    +
    +

    Build and C API Changes

    +

    Changes to Python’s build process and to the C API include:

    +
      +
    • The cycle detection implementation used by the garbage collection has proven +to be stable, so it’s now been made mandatory. You can no longer compile Python +without it, and the --with-cycle-gc switch to configure has +been removed.

    • +
    • Python can now optionally be built as a shared library +(libpython2.3.so) by supplying --enable-shared when running +Python’s configure script. (Contributed by Ondrej Palkovsky.)

    • +
    • The DL_EXPORT and DL_IMPORT macros are now deprecated. +Initialization functions for Python extension modules should now be declared +using the new macro PyMODINIT_FUNC, while the Python core will +generally use the PyAPI_FUNC and PyAPI_DATA macros.

    • +
    • The interpreter can be compiled without any docstrings for the built-in +functions and modules by supplying --without-doc-strings to the +configure script. This makes the Python executable about 10% smaller, +but will also mean that you can’t get help for Python’s built-ins. (Contributed +by Gustavo Niemeyer.)

    • +
    • The PyArg_NoArgs() macro is now deprecated, and code that uses it +should be changed. For Python 2.2 and later, the method definition table can +specify the METH_NOARGS flag, signalling that there are no arguments, +and the argument checking can then be removed. If compatibility with pre-2.2 +versions of Python is important, the code could use PyArg_ParseTuple(args, +"") instead, but this will be slower than using METH_NOARGS.

    • +
    • PyArg_ParseTuple() accepts new format characters for various sizes of +unsigned integers: B for unsigned char, H for unsigned +short int, I for unsigned int, and K for unsigned +long long.

    • +
    • A new function, PyObject_DelItemString(mapping, char *key) was added +as shorthand for PyObject_DelItem(mapping, PyString_New(key)).

    • +
    • File objects now manage their internal string buffer differently, increasing +it exponentially when needed. This results in the benchmark tests in +Lib/test/test_bufio.py speeding up considerably (from 57 seconds to 1.7 +seconds, according to one measurement).

    • +
    • It’s now possible to define class and static methods for a C extension type by +setting either the METH_CLASS or METH_STATIC flags in a +method’s PyMethodDef structure.

    • +
    • Python now includes a copy of the Expat XML parser’s source code, removing any +dependence on a system version or local installation of Expat.

    • +
    • If you dynamically allocate type objects in your extension, you should be +aware of a change in the rules relating to the __module__ and +__name__ attributes. In summary, you will want to ensure the type’s +dictionary contains a '__module__' key; making the module name the part of +the type name leading up to the final period will no longer have the desired +effect. For more detail, read the API reference documentation or the source.

    • +
    +
    +

    Port-Specific Changes

    +

    Support for a port to IBM’s OS/2 using the EMX runtime environment was merged +into the main Python source tree. EMX is a POSIX emulation layer over the OS/2 +system APIs. The Python port for EMX tries to support all the POSIX-like +capability exposed by the EMX runtime, and mostly succeeds; fork() and +fcntl() are restricted by the limitations of the underlying emulation +layer. The standard OS/2 port, which uses IBM’s Visual Age compiler, also +gained support for case-sensitive import semantics as part of the integration of +the EMX port into CVS. (Contributed by Andrew MacIntyre.)

    +

    On MacOS, most toolbox modules have been weaklinked to improve backward +compatibility. This means that modules will no longer fail to load if a single +routine is missing on the current OS version. Instead calling the missing +routine will raise an exception. (Contributed by Jack Jansen.)

    +

    The RPM spec files, found in the Misc/RPM/ directory in the Python +source distribution, were updated for 2.3. (Contributed by Sean Reifschneider.)

    +

    Other new platforms now supported by Python include AtheOS +(http://www.atheos.cx/), GNU/Hurd, and OpenVMS.

    +
    +
    +
    +

    Other Changes and Fixes

    +

    As usual, there were a bunch of other improvements and bugfixes scattered +throughout the source tree. A search through the CVS change logs finds there +were 523 patches applied and 514 bugs fixed between Python 2.2 and 2.3. Both +figures are likely to be underestimates.

    +

    Some of the more notable changes are:

    +
      +
    • If the PYTHONINSPECT environment variable is set, the Python +interpreter will enter the interactive prompt after running a Python program, as +if Python had been invoked with the -i option. The environment +variable can be set before running the Python interpreter, or it can be set by +the Python program as part of its execution.

    • +
    • The regrtest.py script now provides a way to allow “all resources +except foo.” A resource name passed to the -u option can now be +prefixed with a hyphen ('-') to mean “remove this resource.” For example, +the option ‘-uall,-bsddb’ could be used to enable the use of all resources +except bsddb.

    • +
    • The tools used to build the documentation now work under Cygwin as well as +Unix.

    • +
    • The SET_LINENO opcode has been removed. Back in the mists of time, this +opcode was needed to produce line numbers in tracebacks and support trace +functions (for, e.g., pdb). Since Python 1.5, the line numbers in +tracebacks have been computed using a different mechanism that works with +“python -O”. For Python 2.3 Michael Hudson implemented a similar scheme to +determine when to call the trace function, removing the need for SET_LINENO +entirely.

      +

      It would be difficult to detect any resulting difference from Python code, apart +from a slight speed up when Python is run without -O.

      +

      C extensions that access the f_lineno field of frame objects should +instead call PyCode_Addr2Line(f->f_code, f->f_lasti). This will have the +added effect of making the code work as desired under “python -O” in earlier +versions of Python.

      +

      A nifty new feature is that trace functions can now assign to the +f_lineno attribute of frame objects, changing the line that will be +executed next. A jump command has been added to the pdb debugger +taking advantage of this new feature. (Implemented by Richie Hindle.)

      +
    • +
    +
    +
    +

    Porting to Python 2.3

    +

    This section lists previously described changes that may require changes to your +code:

    +
      +
    • yield is now always a keyword; if it’s used as a variable name in +your code, a different name must be chosen.

    • +
    • For strings X and Y, X in Y now works if X is more than one +character long.

    • +
    • The int() type constructor will now return a long integer instead of +raising an OverflowError when a string or floating-point number is too +large to fit into an integer.

    • +
    • If you have Unicode strings that contain 8-bit characters, you must declare +the file’s encoding (UTF-8, Latin-1, or whatever) by adding a comment to the top +of the file. See section PEP 263: Source Code Encodings for more information.

    • +
    • Calling Tcl methods through _tkinter no longer returns only strings. +Instead, if Tcl returns other objects those objects are converted to their +Python equivalent, if one exists, or wrapped with a _tkinter.Tcl_Obj +object if no Python equivalent exists.

    • +
    • Large octal and hex literals such as 0xffffffff now trigger a +FutureWarning. Currently they’re stored as 32-bit numbers and result in a +negative value, but in Python 2.4 they’ll become positive long integers.

      +

      There are a few ways to fix this warning. If you really need a positive number, +just add an L to the end of the literal. If you’re trying to get a 32-bit +integer with low bits set and have previously used an expression such as ~(1 +<< 31), it’s probably clearest to start with all bits set and clear the +desired upper bits. For example, to clear just the top bit (bit 31), you could +write 0xffffffffL &~(1L<<31).

      +
    • +
    • You can no longer disable assertions by assigning to __debug__.

    • +
    • The Distutils setup() function has gained various new keyword arguments +such as depends. Old versions of the Distutils will abort if passed unknown +keywords. A solution is to check for the presence of the new +get_distutil_options() function in your setup.py and only uses the +new keywords with a version of the Distutils that supports them:

      +
      from distutils import core
      +
      +kw = {'sources': 'foo.c', ...}
      +if hasattr(core, 'get_distutil_options'):
      +    kw['depends'] = ['foo.h']
      +ext = Extension(**kw)
      +
      +
      +
    • +
    • Using None as a variable name will now result in a SyntaxWarning +warning.

    • +
    • Names of extension types defined by the modules included with Python now +contain the module and a '.' in front of the type name.

    • +
    +
    +
    +

    Acknowledgements

    +

    The author would like to thank the following people for offering suggestions, +corrections and assistance with various drafts of this article: Jeff Bauer, +Simon Brunning, Brett Cannon, Michael Chermside, Andrew Dalke, Scott David +Daniels, Fred L. Drake, Jr., David Fraser, Kelly Gerber, Raymond Hettinger, +Michael Hudson, Chris Lambert, Detlef Lannert, Martin von Löwis, Andrew +MacIntyre, Lalo Martins, Chad Netzer, Gustavo Niemeyer, Neal Norwitz, Hans +Nowak, Chris Reedy, Francesco Ricciardi, Vinay Sajip, Neil Schemenauer, Roman +Suzi, Jason Tishler, Just van Rossum.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/whatsnew/2.4.html b/python-3.7.4-docs-html/whatsnew/2.4.html new file mode 100644 index 0000000..9d167c8 --- /dev/null +++ b/python-3.7.4-docs-html/whatsnew/2.4.html @@ -0,0 +1,1570 @@ + + + + + + + What’s New in Python 2.4 — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    What’s New in Python 2.4

    +
    +
    Author
    +

    A.M. Kuchling

    +
    +
    +

    This article explains the new features in Python 2.4.1, released on March 30, +2005.

    +

    Python 2.4 is a medium-sized release. It doesn’t introduce as many changes as +the radical Python 2.2, but introduces more features than the conservative 2.3 +release. The most significant new language features are function decorators and +generator expressions; most other changes are to the standard library.

    +

    According to the CVS change logs, there were 481 patches applied and 502 bugs +fixed between Python 2.3 and 2.4. Both figures are likely to be underestimates.

    +

    This article doesn’t attempt to provide a complete specification of every single +new feature, but instead provides a brief introduction to each feature. For +full details, you should refer to the documentation for Python 2.4, such as the +Python Library Reference and the Python Reference Manual. Often you will be +referred to the PEP for a particular new feature for explanations of the +implementation and design rationale.

    +
    +

    PEP 218: Built-In Set Objects

    +

    Python 2.3 introduced the sets module. C implementations of set data +types have now been added to the Python core as two new built-in types, +set(iterable) and frozenset(iterable). They provide high speed +operations for membership testing, for eliminating duplicates from sequences, +and for mathematical operations like unions, intersections, differences, and +symmetric differences.

    +
    >>> a = set('abracadabra')              # form a set from a string
    +>>> 'z' in a                            # fast membership testing
    +False
    +>>> a                                   # unique letters in a
    +set(['a', 'r', 'b', 'c', 'd'])
    +>>> ''.join(a)                          # convert back into a string
    +'arbcd'
    +
    +>>> b = set('alacazam')                 # form a second set
    +>>> a - b                               # letters in a but not in b
    +set(['r', 'd', 'b'])
    +>>> a | b                               # letters in either a or b
    +set(['a', 'c', 'r', 'd', 'b', 'm', 'z', 'l'])
    +>>> a & b                               # letters in both a and b
    +set(['a', 'c'])
    +>>> a ^ b                               # letters in a or b but not both
    +set(['r', 'd', 'b', 'm', 'z', 'l'])
    +
    +>>> a.add('z')                          # add a new element
    +>>> a.update('wxy')                     # add multiple new elements
    +>>> a
    +set(['a', 'c', 'b', 'd', 'r', 'w', 'y', 'x', 'z'])
    +>>> a.remove('x')                       # take one element out
    +>>> a
    +set(['a', 'c', 'b', 'd', 'r', 'w', 'y', 'z'])
    +
    +
    +

    The frozenset() type is an immutable version of set(). Since it is +immutable and hashable, it may be used as a dictionary key or as a member of +another set.

    +

    The sets module remains in the standard library, and may be useful if you +wish to subclass the Set or ImmutableSet classes. There are +currently no plans to deprecate the module.

    +
    +

    See also

    +
    +
    PEP 218 - Adding a Built-In Set Object Type

    Originally proposed by Greg Wilson and ultimately implemented by Raymond +Hettinger.

    +
    +
    +
    +
    +
    +

    PEP 237: Unifying Long Integers and Integers

    +

    The lengthy transition process for this PEP, begun in Python 2.2, takes another +step forward in Python 2.4. In 2.3, certain integer operations that would +behave differently after int/long unification triggered FutureWarning +warnings and returned values limited to 32 or 64 bits (depending on your +platform). In 2.4, these expressions no longer produce a warning and instead +produce a different result that’s usually a long integer.

    +

    The problematic expressions are primarily left shifts and lengthy hexadecimal +and octal constants. For example, 2 << 32 results in a warning in 2.3, +evaluating to 0 on 32-bit platforms. In Python 2.4, this expression now returns +the correct answer, 8589934592.

    +
    +

    See also

    +
    +
    PEP 237 - Unifying Long Integers and Integers

    Original PEP written by Moshe Zadka and GvR. The changes for 2.4 were +implemented by Kalle Svensson.

    +
    +
    +
    +
    +
    +

    PEP 289: Generator Expressions

    +

    The iterator feature introduced in Python 2.2 and the itertools module +make it easier to write programs that loop through large data sets without +having the entire data set in memory at one time. List comprehensions don’t fit +into this picture very well because they produce a Python list object containing +all of the items. This unavoidably pulls all of the objects into memory, which +can be a problem if your data set is very large. When trying to write a +functionally-styled program, it would be natural to write something like:

    +
    links = [link for link in get_all_links() if not link.followed]
    +for link in links:
    +    ...
    +
    +
    +

    instead of

    +
    for link in get_all_links():
    +    if link.followed:
    +        continue
    +    ...
    +
    +
    +

    The first form is more concise and perhaps more readable, but if you’re dealing +with a large number of link objects you’d have to write the second form to avoid +having all link objects in memory at the same time.

    +

    Generator expressions work similarly to list comprehensions but don’t +materialize the entire list; instead they create a generator that will return +elements one by one. The above example could be written as:

    +
    links = (link for link in get_all_links() if not link.followed)
    +for link in links:
    +    ...
    +
    +
    +

    Generator expressions always have to be written inside parentheses, as in the +above example. The parentheses signalling a function call also count, so if you +want to create an iterator that will be immediately passed to a function you +could write:

    +
    print sum(obj.count for obj in list_all_objects())
    +
    +
    +

    Generator expressions differ from list comprehensions in various small ways. +Most notably, the loop variable (obj in the above example) is not accessible +outside of the generator expression. List comprehensions leave the variable +assigned to its last value; future versions of Python will change this, making +list comprehensions match generator expressions in this respect.

    +
    +

    See also

    +
    +
    PEP 289 - Generator Expressions

    Proposed by Raymond Hettinger and implemented by Jiwon Seo with early efforts +steered by Hye-Shik Chang.

    +
    +
    +
    +
    +
    +

    PEP 292: Simpler String Substitutions

    +

    Some new classes in the standard library provide an alternative mechanism for +substituting variables into strings; this style of substitution may be better +for applications where untrained users need to edit templates.

    +

    The usual way of substituting variables by name is the % operator:

    +
    >>> '%(page)i: %(title)s' % {'page':2, 'title': 'The Best of Times'}
    +'2: The Best of Times'
    +
    +
    +

    When writing the template string, it can be easy to forget the i or s +after the closing parenthesis. This isn’t a big problem if the template is in a +Python module, because you run the code, get an “Unsupported format character” +ValueError, and fix the problem. However, consider an application such +as Mailman where template strings or translations are being edited by users who +aren’t aware of the Python language. The format string’s syntax is complicated +to explain to such users, and if they make a mistake, it’s difficult to provide +helpful feedback to them.

    +

    PEP 292 adds a Template class to the string module that uses +$ to indicate a substitution:

    +
    >>> import string
    +>>> t = string.Template('$page: $title')
    +>>> t.substitute({'page':2, 'title': 'The Best of Times'})
    +'2: The Best of Times'
    +
    +
    +

    If a key is missing from the dictionary, the substitute() method will +raise a KeyError. There’s also a safe_substitute() method that +ignores missing keys:

    +
    >>> t = string.Template('$page: $title')
    +>>> t.safe_substitute({'page':3})
    +'3: $title'
    +
    +
    +
    +

    See also

    +
    +
    PEP 292 - Simpler String Substitutions

    Written and implemented by Barry Warsaw.

    +
    +
    +
    +
    +
    +

    PEP 318: Decorators for Functions and Methods

    +

    Python 2.2 extended Python’s object model by adding static methods and class +methods, but it didn’t extend Python’s syntax to provide any new way of defining +static or class methods. Instead, you had to write a def statement +in the usual way, and pass the resulting method to a staticmethod() or +classmethod() function that would wrap up the function as a method of the +new type. Your code would look like this:

    +
    class C:
    +   def meth (cls):
    +       ...
    +
    +   meth = classmethod(meth)   # Rebind name to wrapped-up class method
    +
    +
    +

    If the method was very long, it would be easy to miss or forget the +classmethod() invocation after the function body.

    +

    The intention was always to add some syntax to make such definitions more +readable, but at the time of 2.2’s release a good syntax was not obvious. Today +a good syntax still isn’t obvious but users are asking for easier access to +the feature; a new syntactic feature has been added to meet this need.

    +

    The new feature is called “function decorators”. The name comes from the idea +that classmethod(), staticmethod(), and friends are storing +additional information on a function object; they’re decorating functions with +more details.

    +

    The notation borrows from Java and uses the '@' character as an indicator. +Using the new syntax, the example above would be written:

    +
    class C:
    +
    +   @classmethod
    +   def meth (cls):
    +       ...
    +
    +
    +

    The @classmethod is shorthand for the meth=classmethod(meth) assignment. +More generally, if you have the following:

    +
    @A
    +@B
    +@C
    +def f ():
    +    ...
    +
    +
    +

    It’s equivalent to the following pre-decorator code:

    +
    def f(): ...
    +f = A(B(C(f)))
    +
    +
    +

    Decorators must come on the line before a function definition, one decorator per +line, and can’t be on the same line as the def statement, meaning that @A def +f(): ... is illegal. You can only decorate function definitions, either at +the module level or inside a class; you can’t decorate class definitions.

    +

    A decorator is just a function that takes the function to be decorated as an +argument and returns either the same function or some new object. The return +value of the decorator need not be callable (though it typically is), unless +further decorators will be applied to the result. It’s easy to write your own +decorators. The following simple example just sets an attribute on the function +object:

    +
    >>> def deco(func):
    +...    func.attr = 'decorated'
    +...    return func
    +...
    +>>> @deco
    +... def f(): pass
    +...
    +>>> f
    +<function f at 0x402ef0d4>
    +>>> f.attr
    +'decorated'
    +>>>
    +
    +
    +

    As a slightly more realistic example, the following decorator checks that the +supplied argument is an integer:

    +
    def require_int (func):
    +    def wrapper (arg):
    +        assert isinstance(arg, int)
    +        return func(arg)
    +
    +    return wrapper
    +
    +@require_int
    +def p1 (arg):
    +    print arg
    +
    +@require_int
    +def p2(arg):
    +    print arg*2
    +
    +
    +

    An example in PEP 318 contains a fancier version of this idea that lets you +both specify the required type and check the returned type.

    +

    Decorator functions can take arguments. If arguments are supplied, your +decorator function is called with only those arguments and must return a new +decorator function; this function must take a single function and return a +function, as previously described. In other words, @A @B @C(args) becomes:

    +
    def f(): ...
    +_deco = C(args)
    +f = A(B(_deco(f)))
    +
    +
    +

    Getting this right can be slightly brain-bending, but it’s not too difficult.

    +

    A small related change makes the func_name attribute of functions +writable. This attribute is used to display function names in tracebacks, so +decorators should change the name of any new function that’s constructed and +returned.

    +
    +

    See also

    +
    +
    PEP 318 - Decorators for Functions, Methods and Classes

    Written by Kevin D. Smith, Jim Jewett, and Skip Montanaro. Several people +wrote patches implementing function decorators, but the one that was actually +checked in was patch #979728, written by Mark Russell.

    +
    +
    https://wiki.python.org/moin/PythonDecoratorLibrary

    This Wiki page contains several examples of decorators.

    +
    +
    +
    +
    +
    +

    PEP 322: Reverse Iteration

    +

    A new built-in function, reversed(seq), takes a sequence and returns an +iterator that loops over the elements of the sequence in reverse order.

    +
    >>> for i in reversed(xrange(1,4)):
    +...    print i
    +...
    +3
    +2
    +1
    +
    +
    +

    Compared to extended slicing, such as range(1,4)[::-1], reversed() is +easier to read, runs faster, and uses substantially less memory.

    +

    Note that reversed() only accepts sequences, not arbitrary iterators. If +you want to reverse an iterator, first convert it to a list with list().

    +
    >>> input = open('/etc/passwd', 'r')
    +>>> for line in reversed(list(input)):
    +...   print line
    +...
    +root:*:0:0:System Administrator:/var/root:/bin/tcsh
    +  ...
    +
    +
    +
    +

    See also

    +
    +
    PEP 322 - Reverse Iteration

    Written and implemented by Raymond Hettinger.

    +
    +
    +
    +
    +
    +

    PEP 324: New subprocess Module

    +

    The standard library provides a number of ways to execute a subprocess, offering +different features and different levels of complexity. +os.system(command) is easy to use, but slow (it runs a shell process +which executes the command) and dangerous (you have to be careful about escaping +the shell’s metacharacters). The popen2 module offers classes that can +capture standard output and standard error from the subprocess, but the naming +is confusing. The subprocess module cleans this up, providing a unified +interface that offers all the features you might need.

    +

    Instead of popen2’s collection of classes, subprocess contains a +single class called Popen whose constructor supports a number of +different keyword arguments.

    +
    class Popen(args, bufsize=0, executable=None,
    +            stdin=None, stdout=None, stderr=None,
    +            preexec_fn=None, close_fds=False, shell=False,
    +            cwd=None, env=None, universal_newlines=False,
    +            startupinfo=None, creationflags=0):
    +
    +
    +

    args is commonly a sequence of strings that will be the arguments to the +program executed as the subprocess. (If the shell argument is true, args +can be a string which will then be passed on to the shell for interpretation, +just as os.system() does.)

    +

    stdin, stdout, and stderr specify what the subprocess’s input, output, and +error streams will be. You can provide a file object or a file descriptor, or +you can use the constant subprocess.PIPE to create a pipe between the +subprocess and the parent.

    +

    The constructor has a number of handy options:

    +
      +
    • close_fds requests that all file descriptors be closed before running the +subprocess.

    • +
    • cwd specifies the working directory in which the subprocess will be executed +(defaulting to whatever the parent’s working directory is).

    • +
    • env is a dictionary specifying environment variables.

    • +
    • preexec_fn is a function that gets called before the child is started.

    • +
    • universal_newlines opens the child’s input and output using Python’s +universal newlines feature.

    • +
    +

    Once you’ve created the Popen instance, you can call its wait() +method to pause until the subprocess has exited, poll() to check if it’s +exited without pausing, or communicate(data) to send the string data +to the subprocess’s standard input. communicate(data) then reads any +data that the subprocess has sent to its standard output or standard error, +returning a tuple (stdout_data, stderr_data).

    +

    call() is a shortcut that passes its arguments along to the Popen +constructor, waits for the command to complete, and returns the status code of +the subprocess. It can serve as a safer analog to os.system():

    +
    sts = subprocess.call(['dpkg', '-i', '/tmp/new-package.deb'])
    +if sts == 0:
    +    # Success
    +    ...
    +else:
    +    # dpkg returned an error
    +    ...
    +
    +
    +

    The command is invoked without use of the shell. If you really do want to use +the shell, you can add shell=True as a keyword argument and provide a string +instead of a sequence:

    +
    sts = subprocess.call('dpkg -i /tmp/new-package.deb', shell=True)
    +
    +
    +

    The PEP takes various examples of shell and Python code and shows how they’d be +translated into Python code that uses subprocess. Reading this section +of the PEP is highly recommended.

    +
    +

    See also

    +
    +
    PEP 324 - subprocess - New process module

    Written and implemented by Peter Åstrand, with assistance from Fredrik Lundh and +others.

    +
    +
    +
    +
    +
    +

    PEP 327: Decimal Data Type

    +

    Python has always supported floating-point (FP) numbers, based on the underlying +C double type, as a data type. However, while most programming +languages provide a floating-point type, many people (even programmers) are +unaware that floating-point numbers don’t represent certain decimal fractions +accurately. The new Decimal type can represent these fractions +accurately, up to a user-specified precision limit.

    +
    +

    Why is Decimal needed?

    +

    The limitations arise from the representation used for floating-point numbers. +FP numbers are made up of three components:

    +
      +
    • The sign, which is positive or negative.

    • +
    • The mantissa, which is a single-digit binary number followed by a fractional +part. For example, 1.01 in base-2 notation is 1 + 0/2 + 1/4, or 1.25 in +decimal notation.

    • +
    • The exponent, which tells where the decimal point is located in the number +represented.

    • +
    +

    For example, the number 1.25 has positive sign, a mantissa value of 1.01 (in +binary), and an exponent of 0 (the decimal point doesn’t need to be shifted). +The number 5 has the same sign and mantissa, but the exponent is 2 because the +mantissa is multiplied by 4 (2 to the power of the exponent 2); 1.25 * 4 equals +5.

    +

    Modern systems usually provide floating-point support that conforms to a +standard called IEEE 754. C’s double type is usually implemented as a +64-bit IEEE 754 number, which uses 52 bits of space for the mantissa. This +means that numbers can only be specified to 52 bits of precision. If you’re +trying to represent numbers whose expansion repeats endlessly, the expansion is +cut off after 52 bits. Unfortunately, most software needs to produce output in +base 10, and common fractions in base 10 are often repeating decimals in binary. +For example, 1.1 decimal is binary 1.0001100110011 ...; .1 = 1/16 + 1/32 + +1/256 plus an infinite number of additional terms. IEEE 754 has to chop off +that infinitely repeated decimal after 52 digits, so the representation is +slightly inaccurate.

    +

    Sometimes you can see this inaccuracy when the number is printed:

    +
    >>> 1.1
    +1.1000000000000001
    +
    +
    +

    The inaccuracy isn’t always visible when you print the number because the +FP-to-decimal-string conversion is provided by the C library, and most C libraries try +to produce sensible output. Even if it’s not displayed, however, the inaccuracy +is still there and subsequent operations can magnify the error.

    +

    For many applications this doesn’t matter. If I’m plotting points and +displaying them on my monitor, the difference between 1.1 and 1.1000000000000001 +is too small to be visible. Reports often limit output to a certain number of +decimal places, and if you round the number to two or three or even eight +decimal places, the error is never apparent. However, for applications where it +does matter, it’s a lot of work to implement your own custom arithmetic +routines.

    +

    Hence, the Decimal type was created.

    +
    +
    +

    The Decimal type

    +

    A new module, decimal, was added to Python’s standard library. It +contains two classes, Decimal and Context. Decimal +instances represent numbers, and Context instances are used to wrap up +various settings such as the precision and default rounding mode.

    +

    Decimal instances are immutable, like regular Python integers and FP +numbers; once it’s been created, you can’t change the value an instance +represents. Decimal instances can be created from integers or +strings:

    +
    >>> import decimal
    +>>> decimal.Decimal(1972)
    +Decimal("1972")
    +>>> decimal.Decimal("1.1")
    +Decimal("1.1")
    +
    +
    +

    You can also provide tuples containing the sign, the mantissa represented as a +tuple of decimal digits, and the exponent:

    +
    >>> decimal.Decimal((1, (1, 4, 7, 5), -2))
    +Decimal("-14.75")
    +
    +
    +

    Cautionary note: the sign bit is a Boolean value, so 0 is positive and 1 is +negative.

    +

    Converting from floating-point numbers poses a bit of a problem: should the FP +number representing 1.1 turn into the decimal number for exactly 1.1, or for 1.1 +plus whatever inaccuracies are introduced? The decision was to dodge the issue +and leave such a conversion out of the API. Instead, you should convert the +floating-point number into a string using the desired precision and pass the +string to the Decimal constructor:

    +
    >>> f = 1.1
    +>>> decimal.Decimal(str(f))
    +Decimal("1.1")
    +>>> decimal.Decimal('%.12f' % f)
    +Decimal("1.100000000000")
    +
    +
    +

    Once you have Decimal instances, you can perform the usual mathematical +operations on them. One limitation: exponentiation requires an integer +exponent:

    +
    >>> a = decimal.Decimal('35.72')
    +>>> b = decimal.Decimal('1.73')
    +>>> a+b
    +Decimal("37.45")
    +>>> a-b
    +Decimal("33.99")
    +>>> a*b
    +Decimal("61.7956")
    +>>> a/b
    +Decimal("20.64739884393063583815028902")
    +>>> a ** 2
    +Decimal("1275.9184")
    +>>> a**b
    +Traceback (most recent call last):
    +  ...
    +decimal.InvalidOperation: x ** (non-integer)
    +
    +
    +

    You can combine Decimal instances with integers, but not with +floating-point numbers:

    +
    >>> a + 4
    +Decimal("39.72")
    +>>> a + 4.5
    +Traceback (most recent call last):
    +  ...
    +TypeError: You can interact Decimal only with int, long or Decimal data types.
    +>>>
    +
    +
    +

    Decimal numbers can be used with the math and cmath +modules, but note that they’ll be immediately converted to floating-point +numbers before the operation is performed, resulting in a possible loss of +precision and accuracy. You’ll also get back a regular floating-point number +and not a Decimal.

    +
    >>> import math, cmath
    +>>> d = decimal.Decimal('123456789012.345')
    +>>> math.sqrt(d)
    +351364.18288201344
    +>>> cmath.sqrt(-d)
    +351364.18288201344j
    +
    +
    +

    Decimal instances have a sqrt() method that returns a +Decimal, but if you need other things such as trigonometric functions +you’ll have to implement them.

    +
    >>> d.sqrt()
    +Decimal("351364.1828820134592177245001")
    +
    +
    +
    +
    +

    The Context type

    +

    Instances of the Context class encapsulate several settings for +decimal operations:

    +
      +
    • prec is the precision, the number of decimal places.

    • +
    • rounding specifies the rounding mode. The decimal module has +constants for the various possibilities: ROUND_DOWN, +ROUND_CEILING, ROUND_HALF_EVEN, and various others.

    • +
    • traps is a dictionary specifying what happens on encountering certain +error conditions: either an exception is raised or a value is returned. Some +examples of error conditions are division by zero, loss of precision, and +overflow.

    • +
    +

    There’s a thread-local default context available by calling getcontext(); +you can change the properties of this context to alter the default precision, +rounding, or trap handling. The following example shows the effect of changing +the precision of the default context:

    +
    >>> decimal.getcontext().prec
    +28
    +>>> decimal.Decimal(1) / decimal.Decimal(7)
    +Decimal("0.1428571428571428571428571429")
    +>>> decimal.getcontext().prec = 9
    +>>> decimal.Decimal(1) / decimal.Decimal(7)
    +Decimal("0.142857143")
    +
    +
    +

    The default action for error conditions is selectable; the module can either +return a special value such as infinity or not-a-number, or exceptions can be +raised:

    +
    >>> decimal.Decimal(1) / decimal.Decimal(0)
    +Traceback (most recent call last):
    +  ...
    +decimal.DivisionByZero: x / 0
    +>>> decimal.getcontext().traps[decimal.DivisionByZero] = False
    +>>> decimal.Decimal(1) / decimal.Decimal(0)
    +Decimal("Infinity")
    +>>>
    +
    +
    +

    The Context instance also has various methods for formatting numbers +such as to_eng_string() and to_sci_string().

    +

    For more information, see the documentation for the decimal module, which +includes a quick-start tutorial and a reference.

    +
    +

    See also

    +
    +
    PEP 327 - Decimal Data Type

    Written by Facundo Batista and implemented by Facundo Batista, Eric Price, +Raymond Hettinger, Aahz, and Tim Peters.

    +
    +
    http://www.lahey.com/float.htm

    The article uses Fortran code to illustrate many of the problems that +floating-point inaccuracy can cause.

    +
    +
    http://speleotrove.com/decimal/

    A description of a decimal-based representation. This representation is being +proposed as a standard, and underlies the new Python decimal type. Much of this +material was written by Mike Cowlishaw, designer of the Rexx language.

    +
    +
    +
    +
    +
    +
    +

    PEP 328: Multi-line Imports

    +

    One language change is a small syntactic tweak aimed at making it easier to +import many names from a module. In a from module import names statement, +names is a sequence of names separated by commas. If the sequence is very +long, you can either write multiple imports from the same module, or you can use +backslashes to escape the line endings like this:

    +
    from SimpleXMLRPCServer import SimpleXMLRPCServer,\
    +            SimpleXMLRPCRequestHandler,\
    +            CGIXMLRPCRequestHandler,\
    +            resolve_dotted_attribute
    +
    +
    +

    The syntactic change in Python 2.4 simply allows putting the names within +parentheses. Python ignores newlines within a parenthesized expression, so the +backslashes are no longer needed:

    +
    from SimpleXMLRPCServer import (SimpleXMLRPCServer,
    +                                SimpleXMLRPCRequestHandler,
    +                                CGIXMLRPCRequestHandler,
    +                                resolve_dotted_attribute)
    +
    +
    +

    The PEP also proposes that all import statements be absolute imports, +with a leading . character to indicate a relative import. This part of the +PEP was not implemented for Python 2.4, but was completed for Python 2.5.

    +
    +

    See also

    +
    +
    PEP 328 - Imports: Multi-Line and Absolute/Relative

    Written by Aahz. Multi-line imports were implemented by Dima Dorfman.

    +
    +
    +
    +
    +
    +

    PEP 331: Locale-Independent Float/String Conversions

    +

    The locale modules lets Python software select various conversions and +display conventions that are localized to a particular country or language. +However, the module was careful to not change the numeric locale because various +functions in Python’s implementation required that the numeric locale remain set +to the 'C' locale. Often this was because the code was using the C +library’s atof() function.

    +

    Not setting the numeric locale caused trouble for extensions that used third-party +C libraries, however, because they wouldn’t have the correct locale set. +The motivating example was GTK+, whose user interface widgets weren’t displaying +numbers in the current locale.

    +

    The solution described in the PEP is to add three new functions to the Python +API that perform ASCII-only conversions, ignoring the locale setting:

    +
      +
    • PyOS_ascii_strtod(str, ptr) and PyOS_ascii_atof(str, ptr) +both convert a string to a C double.

    • +
    • PyOS_ascii_formatd(buffer, buf_len, format, d) converts a +double to an ASCII string.

    • +
    +

    The code for these functions came from the GLib library +(https://developer.gnome.org/glib/stable/), whose developers kindly +relicensed the relevant functions and donated them to the Python Software +Foundation. The locale module can now change the numeric locale, +letting extensions such as GTK+ produce the correct results.

    +
    +

    See also

    +
    +
    PEP 331 - Locale-Independent Float/String Conversions

    Written by Christian R. Reis, and implemented by Gustavo Carneiro.

    +
    +
    +
    +
    +
    +

    Other Language Changes

    +

    Here are all of the changes that Python 2.4 makes to the core Python language.

    +
      +
    • Decorators for functions and methods were added (PEP 318).

    • +
    • Built-in set() and frozenset() types were added (PEP 218). +Other new built-ins include the reversed(seq) function (PEP 322).

    • +
    • Generator expressions were added (PEP 289).

    • +
    • Certain numeric expressions no longer return values restricted to 32 or 64 +bits (PEP 237).

    • +
    • You can now put parentheses around the list of names in a from module import +names statement (PEP 328).

    • +
    • The dict.update() method now accepts the same argument forms as the +dict constructor. This includes any mapping, any iterable of key/value +pairs, and keyword arguments. (Contributed by Raymond Hettinger.)

    • +
    • The string methods ljust(), rjust(), and center() now take +an optional argument for specifying a fill character other than a space. +(Contributed by Raymond Hettinger.)

    • +
    • Strings also gained an rsplit() method that works like the split() +method but splits from the end of the string. (Contributed by Sean +Reifschneider.)

      +
      >>> 'www.python.org'.split('.', 1)
      +['www', 'python.org']
      +'www.python.org'.rsplit('.', 1)
      +['www.python', 'org']
      +
      +
      +
    • +
    • Three keyword parameters, cmp, key, and reverse, were added to the +sort() method of lists. These parameters make some common usages of +sort() simpler. All of these parameters are optional.

      +

      For the cmp parameter, the value should be a comparison function that takes +two parameters and returns -1, 0, or +1 depending on how the parameters compare. +This function will then be used to sort the list. Previously this was the only +parameter that could be provided to sort().

      +

      key should be a single-parameter function that takes a list element and +returns a comparison key for the element. The list is then sorted using the +comparison keys. The following example sorts a list case-insensitively:

      +
      >>> L = ['A', 'b', 'c', 'D']
      +>>> L.sort()                 # Case-sensitive sort
      +>>> L
      +['A', 'D', 'b', 'c']
      +>>> # Using 'key' parameter to sort list
      +>>> L.sort(key=lambda x: x.lower())
      +>>> L
      +['A', 'b', 'c', 'D']
      +>>> # Old-fashioned way
      +>>> L.sort(cmp=lambda x,y: cmp(x.lower(), y.lower()))
      +>>> L
      +['A', 'b', 'c', 'D']
      +
      +
      +

      The last example, which uses the cmp parameter, is the old way to perform a +case-insensitive sort. It works but is slower than using a key parameter. +Using key calls lower() method once for each element in the list while +using cmp will call it twice for each comparison, so using key saves on +invocations of the lower() method.

      +

      For simple key functions and comparison functions, it is often possible to avoid +a lambda expression by using an unbound method instead. For example, +the above case-insensitive sort is best written as:

      +
      >>> L.sort(key=str.lower)
      +>>> L
      +['A', 'b', 'c', 'D']
      +
      +
      +

      Finally, the reverse parameter takes a Boolean value. If the value is true, +the list will be sorted into reverse order. Instead of L.sort(); +L.reverse(), you can now write L.sort(reverse=True).

      +

      The results of sorting are now guaranteed to be stable. This means that two +entries with equal keys will be returned in the same order as they were input. +For example, you can sort a list of people by name, and then sort the list by +age, resulting in a list sorted by age where people with the same age are in +name-sorted order.

      +

      (All changes to sort() contributed by Raymond Hettinger.)

      +
    • +
    • There is a new built-in function sorted(iterable) that works like the +in-place list.sort() method but can be used in expressions. The +differences are:

    • +
    • the input may be any iterable;

    • +
    • a newly formed copy is sorted, leaving the original intact; and

    • +
    • the expression returns the new sorted copy

      +
      >>> L = [9,7,8,3,2,4,1,6,5]
      +>>> [10+i for i in sorted(L)]       # usable in a list comprehension
      +[11, 12, 13, 14, 15, 16, 17, 18, 19]
      +>>> L                               # original is left unchanged
      +[9,7,8,3,2,4,1,6,5]
      +>>> sorted('Monty Python')          # any iterable may be an input
      +[' ', 'M', 'P', 'h', 'n', 'n', 'o', 'o', 't', 't', 'y', 'y']
      +
      +>>> # List the contents of a dict sorted by key values
      +>>> colormap = dict(red=1, blue=2, green=3, black=4, yellow=5)
      +>>> for k, v in sorted(colormap.iteritems()):
      +...     print k, v
      +...
      +black 4
      +blue 2
      +green 3
      +red 1
      +yellow 5
      +
      +
      +

      (Contributed by Raymond Hettinger.)

      +
    • +
    • Integer operations will no longer trigger an OverflowWarning. The +OverflowWarning warning will disappear in Python 2.5.

    • +
    • The interpreter gained a new switch, -m, that takes a name, searches +for the corresponding module on sys.path, and runs the module as a script. +For example, you can now run the Python profiler with python -m profile. +(Contributed by Nick Coghlan.)

    • +
    • The eval(expr, globals, locals) and execfile(filename, globals, +locals) functions and the exec statement now accept any mapping type +for the locals parameter. Previously this had to be a regular Python +dictionary. (Contributed by Raymond Hettinger.)

    • +
    • The zip() built-in function and itertools.izip() now return an +empty list if called with no arguments. Previously they raised a +TypeError exception. This makes them more suitable for use with variable +length argument lists:

      +
      >>> def transpose(array):
      +...    return zip(*array)
      +...
      +>>> transpose([(1,2,3), (4,5,6)])
      +[(1, 4), (2, 5), (3, 6)]
      +>>> transpose([])
      +[]
      +
      +
      +

      (Contributed by Raymond Hettinger.)

      +
    • +
    • Encountering a failure while importing a module no longer leaves a partially-initialized +module object in sys.modules. The incomplete module object left +behind would fool further imports of the same module into succeeding, leading to +confusing errors. (Fixed by Tim Peters.)

    • +
    • None is now a constant; code that binds a new value to the name +None is now a syntax error. (Contributed by Raymond Hettinger.)

    • +
    +
    +

    Optimizations

    +
      +
    • The inner loops for list and tuple slicing were optimized and now run about +one-third faster. The inner loops for dictionaries were also optimized, +resulting in performance boosts for keys(), values(), items(), +iterkeys(), itervalues(), and iteritems(). (Contributed by +Raymond Hettinger.)

    • +
    • The machinery for growing and shrinking lists was optimized for speed and for +space efficiency. Appending and popping from lists now runs faster due to more +efficient code paths and less frequent use of the underlying system +realloc(). List comprehensions also benefit. list.extend() was +also optimized and no longer converts its argument into a temporary list before +extending the base list. (Contributed by Raymond Hettinger.)

    • +
    • list(), tuple(), map(), filter(), and zip() now +run several times faster with non-sequence arguments that supply a +__len__() method. (Contributed by Raymond Hettinger.)

    • +
    • The methods list.__getitem__(), dict.__getitem__(), and +dict.__contains__() are now implemented as method_descriptor +objects rather than wrapper_descriptor objects. This form of access +doubles their performance and makes them more suitable for use as arguments to +functionals: map(mydict.__getitem__, keylist). (Contributed by Raymond +Hettinger.)

    • +
    • Added a new opcode, LIST_APPEND, that simplifies the generated bytecode +for list comprehensions and speeds them up by about a third. (Contributed by +Raymond Hettinger.)

    • +
    • The peephole bytecode optimizer has been improved to produce shorter, faster +bytecode; remarkably, the resulting bytecode is more readable. (Enhanced by +Raymond Hettinger.)

    • +
    • String concatenations in statements of the form s = s + "abc" and s += +"abc" are now performed more efficiently in certain circumstances. This +optimization won’t be present in other Python implementations such as Jython, so +you shouldn’t rely on it; using the join() method of strings is still +recommended when you want to efficiently glue a large number of strings +together. (Contributed by Armin Rigo.)

    • +
    +

    The net result of the 2.4 optimizations is that Python 2.4 runs the pystone +benchmark around 5% faster than Python 2.3 and 35% faster than Python 2.2. +(pystone is not a particularly good benchmark, but it’s the most commonly used +measurement of Python’s performance. Your own applications may show greater or +smaller benefits from Python 2.4.)

    +
    +
    +
    +

    New, Improved, and Deprecated Modules

    +

    As usual, Python’s standard library received a number of enhancements and bug +fixes. Here’s a partial list of the most notable changes, sorted alphabetically +by module name. Consult the Misc/NEWS file in the source tree for a more +complete list of changes, or look through the CVS logs for all the details.

    +
      +
    • The asyncore module’s loop() function now has a count parameter +that lets you perform a limited number of passes through the polling loop. The +default is still to loop forever.

    • +
    • The base64 module now has more complete RFC 3548 support for Base64, +Base32, and Base16 encoding and decoding, including optional case folding and +optional alternative alphabets. (Contributed by Barry Warsaw.)

    • +
    • The bisect module now has an underlying C implementation for improved +performance. (Contributed by Dmitry Vasiliev.)

    • +
    • The CJKCodecs collections of East Asian codecs, maintained by Hye-Shik Chang, +was integrated into 2.4. The new encodings are:

    • +
    • Chinese (PRC): gb2312, gbk, gb18030, big5hkscs, hz

    • +
    • Chinese (ROC): big5, cp950

    • +
    • +
      Japanese: cp932, euc-jis-2004, euc-jp, euc-jisx0213, iso-2022-jp,

      iso-2022-jp-1, iso-2022-jp-2, iso-2022-jp-3, iso-2022-jp-ext, iso-2022-jp-2004, +shift-jis, shift-jisx0213, shift-jis-2004

      +
      +
      +
    • +
    • Korean: cp949, euc-kr, johab, iso-2022-kr

    • +
    • Some other new encodings were added: HP Roman8, ISO_8859-11, ISO_8859-16, +PCTP-154, and TIS-620.

    • +
    • The UTF-8 and UTF-16 codecs now cope better with receiving partial input. +Previously the StreamReader class would try to read more data, making +it impossible to resume decoding from the stream. The read() method will +now return as much data as it can and future calls will resume decoding where +previous ones left off. (Implemented by Walter Dörwald.)

    • +
    • There is a new collections module for various specialized collection +datatypes. Currently it contains just one type, deque, a double-ended +queue that supports efficiently adding and removing elements from either +end:

      +
      >>> from collections import deque
      +>>> d = deque('ghi')        # make a new deque with three items
      +>>> d.append('j')           # add a new entry to the right side
      +>>> d.appendleft('f')       # add a new entry to the left side
      +>>> d                       # show the representation of the deque
      +deque(['f', 'g', 'h', 'i', 'j'])
      +>>> d.pop()                 # return and remove the rightmost item
      +'j'
      +>>> d.popleft()             # return and remove the leftmost item
      +'f'
      +>>> list(d)                 # list the contents of the deque
      +['g', 'h', 'i']
      +>>> 'h' in d                # search the deque
      +True
      +
      +
      +

      Several modules, such as the Queue and threading modules, now take +advantage of collections.deque for improved performance. (Contributed +by Raymond Hettinger.)

      +
    • +
    • The ConfigParser classes have been enhanced slightly. The read() +method now returns a list of the files that were successfully parsed, and the +set() method raises TypeError if passed a value argument that +isn’t a string. (Contributed by John Belmonte and David Goodger.)

    • +
    • The curses module now supports the ncurses extension +use_default_colors(). On platforms where the terminal supports +transparency, this makes it possible to use a transparent background. +(Contributed by Jörg Lehmann.)

    • +
    • The difflib module now includes an HtmlDiff class that creates +an HTML table showing a side by side comparison of two versions of a text. +(Contributed by Dan Gass.)

    • +
    • The email package was updated to version 3.0, which dropped various +deprecated APIs and removes support for Python versions earlier than 2.3. The +3.0 version of the package uses a new incremental parser for MIME messages, +available in the email.FeedParser module. The new parser doesn’t require +reading the entire message into memory, and doesn’t raise exceptions if a +message is malformed; instead it records any problems in the defect +attribute of the message. (Developed by Anthony Baxter, Barry Warsaw, Thomas +Wouters, and others.)

    • +
    • The heapq module has been converted to C. The resulting tenfold +improvement in speed makes the module suitable for handling high volumes of +data. In addition, the module has two new functions nlargest() and +nsmallest() that use heaps to find the N largest or smallest values in a +dataset without the expense of a full sort. (Contributed by Raymond Hettinger.)

    • +
    • The httplib module now contains constants for HTTP status codes defined +in various HTTP-related RFC documents. Constants have names such as +OK, CREATED, CONTINUE, and +MOVED_PERMANENTLY; use pydoc to get a full list. (Contributed by +Andrew Eland.)

    • +
    • The imaplib module now supports IMAP’s THREAD command (contributed by +Yves Dionne) and new deleteacl() and myrights() methods (contributed +by Arnaud Mazin).

    • +
    • The itertools module gained a groupby(iterable[, *func*]) +function. iterable is something that can be iterated over to return a stream +of elements, and the optional func parameter is a function that takes an +element and returns a key value; if omitted, the key is simply the element +itself. groupby() then groups the elements into subsequences which have +matching values of the key, and returns a series of 2-tuples containing the key +value and an iterator over the subsequence.

      +

      Here’s an example to make this clearer. The key function simply returns +whether a number is even or odd, so the result of groupby() is to return +consecutive runs of odd or even numbers.

      +
      >>> import itertools
      +>>> L = [2, 4, 6, 7, 8, 9, 11, 12, 14]
      +>>> for key_val, it in itertools.groupby(L, lambda x: x % 2):
      +...    print key_val, list(it)
      +...
      +0 [2, 4, 6]
      +1 [7]
      +0 [8]
      +1 [9, 11]
      +0 [12, 14]
      +>>>
      +
      +
      +

      groupby() is typically used with sorted input. The logic for +groupby() is similar to the Unix uniq filter which makes it handy for +eliminating, counting, or identifying duplicate elements:

      +
      >>> word = 'abracadabra'
      +>>> letters = sorted(word)   # Turn string into a sorted list of letters
      +>>> letters
      +['a', 'a', 'a', 'a', 'a', 'b', 'b', 'c', 'd', 'r', 'r']
      +>>> for k, g in itertools.groupby(letters):
      +...    print k, list(g)
      +...
      +a ['a', 'a', 'a', 'a', 'a']
      +b ['b', 'b']
      +c ['c']
      +d ['d']
      +r ['r', 'r']
      +>>> # List unique letters
      +>>> [k for k, g in groupby(letters)]
      +['a', 'b', 'c', 'd', 'r']
      +>>> # Count letter occurrences
      +>>> [(k, len(list(g))) for k, g in groupby(letters)]
      +[('a', 5), ('b', 2), ('c', 1), ('d', 1), ('r', 2)]
      +
      +
      +

      (Contributed by Hye-Shik Chang.)

      +
    • +
    • itertools also gained a function named tee(iterator, N) that +returns N independent iterators that replicate iterator. If N is omitted, +the default is 2.

      +
      >>> L = [1,2,3]
      +>>> i1, i2 = itertools.tee(L)
      +>>> i1,i2
      +(<itertools.tee object at 0x402c2080>, <itertools.tee object at 0x402c2090>)
      +>>> list(i1)               # Run the first iterator to exhaustion
      +[1, 2, 3]
      +>>> list(i2)               # Run the second iterator to exhaustion
      +[1, 2, 3]
      +
      +
      +

      Note that tee() has to keep copies of the values returned by the +iterator; in the worst case, it may need to keep all of them. This should +therefore be used carefully if the leading iterator can run far ahead of the +trailing iterator in a long stream of inputs. If the separation is large, then +you might as well use list() instead. When the iterators track closely +with one another, tee() is ideal. Possible applications include +bookmarking, windowing, or lookahead iterators. (Contributed by Raymond +Hettinger.)

      +
    • +
    • A number of functions were added to the locale module, such as +bind_textdomain_codeset() to specify a particular encoding and a family of +l*gettext() functions that return messages in the chosen encoding. +(Contributed by Gustavo Niemeyer.)

    • +
    • Some keyword arguments were added to the logging package’s +basicConfig() function to simplify log configuration. The default +behavior is to log messages to standard error, but various keyword arguments can +be specified to log to a particular file, change the logging format, or set the +logging level. For example:

      +
      import logging
      +logging.basicConfig(filename='/var/log/application.log',
      +    level=0,  # Log all messages
      +    format='%(levelname):%(process):%(thread):%(message)')
      +
      +
      +

      Other additions to the logging package include a log(level, msg) +convenience method, as well as a TimedRotatingFileHandler class that +rotates its log files at a timed interval. The module already had +RotatingFileHandler, which rotated logs once the file exceeded a +certain size. Both classes derive from a new BaseRotatingHandler class +that can be used to implement other rotating handlers.

      +

      (Changes implemented by Vinay Sajip.)

      +
    • +
    • The marshal module now shares interned strings on unpacking a data +structure. This may shrink the size of certain pickle strings, but the primary +effect is to make .pyc files significantly smaller. (Contributed by +Martin von Löwis.)

    • +
    • The nntplib module’s NNTP class gained description() and +descriptions() methods to retrieve newsgroup descriptions for a single +group or for a range of groups. (Contributed by Jürgen A. Erhard.)

    • +
    • Two new functions were added to the operator module, +attrgetter(attr) and itemgetter(index). Both functions return +callables that take a single argument and return the corresponding attribute or +item; these callables make excellent data extractors when used with map() +or sorted(). For example:

      +
      >>> L = [('c', 2), ('d', 1), ('a', 4), ('b', 3)]
      +>>> map(operator.itemgetter(0), L)
      +['c', 'd', 'a', 'b']
      +>>> map(operator.itemgetter(1), L)
      +[2, 1, 4, 3]
      +>>> sorted(L, key=operator.itemgetter(1)) # Sort list by second tuple item
      +[('d', 1), ('c', 2), ('b', 3), ('a', 4)]
      +
      +
      +

      (Contributed by Raymond Hettinger.)

      +
    • +
    • The optparse module was updated in various ways. The module now passes +its messages through gettext.gettext(), making it possible to +internationalize Optik’s help and error messages. Help messages for options can +now include the string '%default', which will be replaced by the option’s +default value. (Contributed by Greg Ward.)

    • +
    • The long-term plan is to deprecate the rfc822 module in some future +Python release in favor of the email package. To this end, the +email.Utils.formatdate() function has been changed to make it usable as a +replacement for rfc822.formatdate(). You may want to write new e-mail +processing code with this in mind. (Change implemented by Anthony Baxter.)

    • +
    • A new urandom(n) function was added to the os module, returning +a string containing n bytes of random data. This function provides access to +platform-specific sources of randomness such as /dev/urandom on Linux or +the Windows CryptoAPI. (Contributed by Trevor Perrin.)

    • +
    • Another new function: os.path.lexists(path) returns true if the file +specified by path exists, whether or not it’s a symbolic link. This differs +from the existing os.path.exists(path) function, which returns false if +path is a symlink that points to a destination that doesn’t exist. +(Contributed by Beni Cherniavsky.)

    • +
    • A new getsid() function was added to the posix module that +underlies the os module. (Contributed by J. Raynor.)

    • +
    • The poplib module now supports POP over SSL. (Contributed by Hector +Urtubia.)

    • +
    • The profile module can now profile C extension functions. (Contributed +by Nick Bastin.)

    • +
    • The random module has a new method called getrandbits(N) that +returns a long integer N bits in length. The existing randrange() +method now uses getrandbits() where appropriate, making generation of +arbitrarily large random numbers more efficient. (Contributed by Raymond +Hettinger.)

    • +
    • The regular expression language accepted by the re module was extended +with simple conditional expressions, written as (?(group)A|B). group is +either a numeric group ID or a group name defined with (?P<group>...) +earlier in the expression. If the specified group matched, the regular +expression pattern A will be tested against the string; if the group didn’t +match, the pattern B will be used instead. (Contributed by Gustavo Niemeyer.)

    • +
    • The re module is also no longer recursive, thanks to a massive amount +of work by Gustavo Niemeyer. In a recursive regular expression engine, certain +patterns result in a large amount of C stack space being consumed, and it was +possible to overflow the stack. For example, if you matched a 30000-byte string +of a characters against the expression (a|b)+, one stack frame was +consumed per character. Python 2.3 tried to check for stack overflow and raise +a RuntimeError exception, but certain patterns could sidestep the +checking and if you were unlucky Python could segfault. Python 2.4’s regular +expression engine can match this pattern without problems.

    • +
    • The signal module now performs tighter error-checking on the parameters +to the signal.signal() function. For example, you can’t set a handler on +the SIGKILL signal; previous versions of Python would quietly accept +this, but 2.4 will raise a RuntimeError exception.

    • +
    • Two new functions were added to the socket module. socketpair() +returns a pair of connected sockets and getservbyport(port) looks up the +service name for a given port number. (Contributed by Dave Cole and Barry +Warsaw.)

    • +
    • The sys.exitfunc() function has been deprecated. Code should be using +the existing atexit module, which correctly handles calling multiple exit +functions. Eventually sys.exitfunc() will become a purely internal +interface, accessed only by atexit.

    • +
    • The tarfile module now generates GNU-format tar files by default. +(Contributed by Lars Gustäbel.)

    • +
    • The threading module now has an elegantly simple way to support +thread-local data. The module contains a local class whose attribute +values are local to different threads.

      +
      import threading
      +
      +data = threading.local()
      +data.number = 42
      +data.url = ('www.python.org', 80)
      +
      +
      +

      Other threads can assign and retrieve their own values for the number +and url attributes. You can subclass local to initialize +attributes or to add methods. (Contributed by Jim Fulton.)

      +
    • +
    • The timeit module now automatically disables periodic garbage +collection during the timing loop. This change makes consecutive timings more +comparable. (Contributed by Raymond Hettinger.)

    • +
    • The weakref module now supports a wider variety of objects including +Python functions, class instances, sets, frozensets, deques, arrays, files, +sockets, and regular expression pattern objects. (Contributed by Raymond +Hettinger.)

    • +
    • The xmlrpclib module now supports a multi-call extension for +transmitting multiple XML-RPC calls in a single HTTP operation. (Contributed by +Brian Quinlan.)

    • +
    • The mpz, rotor, and xreadlines modules have been +removed.

    • +
    +
    +

    cookielib

    +

    The cookielib library supports client-side handling for HTTP cookies, +mirroring the Cookie module’s server-side cookie support. Cookies are +stored in cookie jars; the library transparently stores cookies offered by the +web server in the cookie jar, and fetches the cookie from the jar when +connecting to the server. As in web browsers, policy objects control whether +cookies are accepted or not.

    +

    In order to store cookies across sessions, two implementations of cookie jars +are provided: one that stores cookies in the Netscape format so applications can +use the Mozilla or Lynx cookie files, and one that stores cookies in the same +format as the Perl libwww library.

    +

    urllib2 has been changed to interact with cookielib: +HTTPCookieProcessor manages a cookie jar that is used when accessing +URLs.

    +

    This module was contributed by John J. Lee.

    +
    +
    +

    doctest

    +

    The doctest module underwent considerable refactoring thanks to Edward +Loper and Tim Peters. Testing can still be as simple as running +doctest.testmod(), but the refactorings allow customizing the module’s +operation in various ways

    +

    The new DocTestFinder class extracts the tests from a given object’s +docstrings:

    +
    def f (x, y):
    +    """>>> f(2,2)
    +4
    +>>> f(3,2)
    +6
    +    """
    +    return x*y
    +
    +finder = doctest.DocTestFinder()
    +
    +# Get list of DocTest instances
    +tests = finder.find(f)
    +
    +
    +

    The new DocTestRunner class then runs individual tests and can produce +a summary of the results:

    +
    runner = doctest.DocTestRunner()
    +for t in tests:
    +    tried, failed = runner.run(t)
    +
    +runner.summarize(verbose=1)
    +
    +
    +

    The above example produces the following output:

    +
    1 items passed all tests:
    +   2 tests in f
    +2 tests in 1 items.
    +2 passed and 0 failed.
    +Test passed.
    +
    +
    +

    DocTestRunner uses an instance of the OutputChecker class to +compare the expected output with the actual output. This class takes a number +of different flags that customize its behaviour; ambitious users can also write +a completely new subclass of OutputChecker.

    +

    The default output checker provides a number of handy features. For example, +with the doctest.ELLIPSIS option flag, an ellipsis (...) in the +expected output matches any substring, making it easier to accommodate outputs +that vary in minor ways:

    +
    def o (n):
    +    """>>> o(1)
    +<__main__.C instance at 0x...>
    +>>>
    +"""
    +
    +
    +

    Another special string, <BLANKLINE>, matches a blank line:

    +
    def p (n):
    +    """>>> p(1)
    +<BLANKLINE>
    +>>>
    +"""
    +
    +
    +

    Another new capability is producing a diff-style display of the output by +specifying the doctest.REPORT_UDIFF (unified diffs), +doctest.REPORT_CDIFF (context diffs), or doctest.REPORT_NDIFF +(delta-style) option flags. For example:

    +
    def g (n):
    +    """>>> g(4)
    +here
    +is
    +a
    +lengthy
    +>>>"""
    +    L = 'here is a rather lengthy list of words'.split()
    +    for word in L[:n]:
    +        print word
    +
    +
    +

    Running the above function’s tests with doctest.REPORT_UDIFF specified, +you get the following output:

    +
    **********************************************************************
    +File "t.py", line 15, in g
    +Failed example:
    +    g(4)
    +Differences (unified diff with -expected +actual):
    +    @@ -2,3 +2,3 @@
    +     is
    +     a
    +    -lengthy
    +    +rather
    +**********************************************************************
    +
    +
    +
    +
    +
    +

    Build and C API Changes

    +

    Some of the changes to Python’s build process and to the C API are:

    +
      +
    • Three new convenience macros were added for common return values from +extension functions: Py_RETURN_NONE, Py_RETURN_TRUE, and +Py_RETURN_FALSE. (Contributed by Brett Cannon.)

    • +
    • Another new macro, Py_CLEAR(obj), decreases the reference count of +obj and sets obj to the null pointer. (Contributed by Jim Fulton.)

    • +
    • A new function, PyTuple_Pack(N, obj1, obj2, ..., objN), constructs +tuples from a variable length argument list of Python objects. (Contributed by +Raymond Hettinger.)

    • +
    • A new function, PyDict_Contains(d, k), implements fast dictionary +lookups without masking exceptions raised during the look-up process. +(Contributed by Raymond Hettinger.)

    • +
    • The Py_IS_NAN(X) macro returns 1 if its float or double argument +X is a NaN. (Contributed by Tim Peters.)

    • +
    • C code can avoid unnecessary locking by using the new +PyEval_ThreadsInitialized() function to tell if any thread operations +have been performed. If this function returns false, no lock operations are +needed. (Contributed by Nick Coghlan.)

    • +
    • A new function, PyArg_VaParseTupleAndKeywords(), is the same as +PyArg_ParseTupleAndKeywords() but takes a va_list instead of a +number of arguments. (Contributed by Greg Chapman.)

    • +
    • A new method flag, METH_COEXISTS, allows a function defined in slots +to co-exist with a PyCFunction having the same name. This can halve +the access time for a method such as set.__contains__(). (Contributed by +Raymond Hettinger.)

    • +
    • Python can now be built with additional profiling for the interpreter itself, +intended as an aid to people developing the Python core. Providing +--enable-profiling to the configure script will let you +profile the interpreter with gprof, and providing the +--with-tsc switch enables profiling using the Pentium’s +Time-Stamp-Counter register. Note that the --with-tsc switch is slightly +misnamed, because the profiling feature also works on the PowerPC platform, +though that processor architecture doesn’t call that register “the TSC +register”. (Contributed by Jeremy Hylton.)

    • +
    • The tracebackobject type has been renamed to +PyTracebackObject.

    • +
    +
    +

    Port-Specific Changes

    +
      +
    • The Windows port now builds under MSVC++ 7.1 as well as version 6. +(Contributed by Martin von Löwis.)

    • +
    +
    +
    +
    +

    Porting to Python 2.4

    +

    This section lists previously described changes that may require changes to your +code:

    +
      +
    • Left shifts and hexadecimal/octal constants that are too large no longer +trigger a FutureWarning and return a value limited to 32 or 64 bits; +instead they return a long integer.

    • +
    • Integer operations will no longer trigger an OverflowWarning. The +OverflowWarning warning will disappear in Python 2.5.

    • +
    • The zip() built-in function and itertools.izip() now return an +empty list instead of raising a TypeError exception if called with no +arguments.

    • +
    • You can no longer compare the date and datetime instances +provided by the datetime module. Two instances of different classes +will now always be unequal, and relative comparisons (<, >) will raise +a TypeError.

    • +
    • dircache.listdir() now passes exceptions to the caller instead of +returning empty lists.

    • +
    • LexicalHandler.startDTD() used to receive the public and system IDs in +the wrong order. This has been corrected; applications relying on the wrong +order need to be fixed.

    • +
    • fcntl.ioctl() now warns if the mutate argument is omitted and +relevant.

    • +
    • The tarfile module now generates GNU-format tar files by default.

    • +
    • Encountering a failure while importing a module no longer leaves a +partially-initialized module object in sys.modules.

    • +
    • None is now a constant; code that binds a new value to the name +None is now a syntax error.

    • +
    • The signals.signal() function now raises a RuntimeError exception +for certain illegal values; previously these errors would pass silently. For +example, you can no longer set a handler on the SIGKILL signal.

    • +
    +
    +
    +

    Acknowledgements

    +

    The author would like to thank the following people for offering suggestions, +corrections and assistance with various drafts of this article: Koray Can, +Hye-Shik Chang, Michael Dyck, Raymond Hettinger, Brian Hurt, Hamish Lawson, +Fredrik Lundh, Sean Reifschneider, Sadruddin Rejeb.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/whatsnew/2.5.html b/python-3.7.4-docs-html/whatsnew/2.5.html new file mode 100644 index 0000000..c63a09b --- /dev/null +++ b/python-3.7.4-docs-html/whatsnew/2.5.html @@ -0,0 +1,2192 @@ + + + + + + + What’s New in Python 2.5 — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    What’s New in Python 2.5

    +
    +
    Author
    +

    A.M. Kuchling

    +
    +
    +

    This article explains the new features in Python 2.5. The final release of +Python 2.5 is scheduled for August 2006; PEP 356 describes the planned +release schedule.

    +

    The changes in Python 2.5 are an interesting mix of language and library +improvements. The library enhancements will be more important to Python’s user +community, I think, because several widely-useful packages were added. New +modules include ElementTree for XML processing (xml.etree), +the SQLite database module (sqlite), and the ctypes +module for calling C functions.

    +

    The language changes are of middling significance. Some pleasant new features +were added, but most of them aren’t features that you’ll use every day. +Conditional expressions were finally added to the language using a novel syntax; +see section PEP 308: Conditional Expressions. The new ‘with’ statement will make +writing cleanup code easier (section PEP 343: The ‘with’ statement). Values can now be passed +into generators (section PEP 342: New Generator Features). Imports are now visible as either +absolute or relative (section PEP 328: Absolute and Relative Imports). Some corner cases of exception +handling are handled better (section PEP 341: Unified try/except/finally). All these improvements +are worthwhile, but they’re improvements to one specific language feature or +another; none of them are broad modifications to Python’s semantics.

    +

    As well as the language and library additions, other improvements and bugfixes +were made throughout the source tree. A search through the SVN change logs +finds there were 353 patches applied and 458 bugs fixed between Python 2.4 and +2.5. (Both figures are likely to be underestimates.)

    +

    This article doesn’t try to be a complete specification of the new features; +instead changes are briefly introduced using helpful examples. For full +details, you should always refer to the documentation for Python 2.5 at +https://docs.python.org. If you want to understand the complete implementation +and design rationale, refer to the PEP for a particular new feature.

    +

    Comments, suggestions, and error reports for this document are welcome; please +e-mail them to the author or open a bug in the Python bug tracker.

    +
    +

    PEP 308: Conditional Expressions

    +

    For a long time, people have been requesting a way to write conditional +expressions, which are expressions that return value A or value B depending on +whether a Boolean value is true or false. A conditional expression lets you +write a single assignment statement that has the same effect as the following:

    +
    if condition:
    +    x = true_value
    +else:
    +    x = false_value
    +
    +
    +

    There have been endless tedious discussions of syntax on both python-dev and +comp.lang.python. A vote was even held that found the majority of voters wanted +conditional expressions in some form, but there was no syntax that was preferred +by a clear majority. Candidates included C’s cond ? true_v : false_v, if +cond then true_v else false_v, and 16 other variations.

    +

    Guido van Rossum eventually chose a surprising syntax:

    +
    x = true_value if condition else false_value
    +
    +
    +

    Evaluation is still lazy as in existing Boolean expressions, so the order of +evaluation jumps around a bit. The condition expression in the middle is +evaluated first, and the true_value expression is evaluated only if the +condition was true. Similarly, the false_value expression is only evaluated +when the condition is false.

    +

    This syntax may seem strange and backwards; why does the condition go in the +middle of the expression, and not in the front as in C’s c ? x : y? The +decision was checked by applying the new syntax to the modules in the standard +library and seeing how the resulting code read. In many cases where a +conditional expression is used, one value seems to be the ‘common case’ and one +value is an ‘exceptional case’, used only on rarer occasions when the condition +isn’t met. The conditional syntax makes this pattern a bit more obvious:

    +
    contents = ((doc + '\n') if doc else '')
    +
    +
    +

    I read the above statement as meaning “here contents is usually assigned a +value of doc+'\n'; sometimes doc is empty, in which special case an empty +string is returned.” I doubt I will use conditional expressions very often +where there isn’t a clear common and uncommon case.

    +

    There was some discussion of whether the language should require surrounding +conditional expressions with parentheses. The decision was made to not +require parentheses in the Python language’s grammar, but as a matter of style I +think you should always use them. Consider these two statements:

    +
    # First version -- no parens
    +level = 1 if logging else 0
    +
    +# Second version -- with parens
    +level = (1 if logging else 0)
    +
    +
    +

    In the first version, I think a reader’s eye might group the statement into +‘level = 1’, ‘if logging’, ‘else 0’, and think that the condition decides +whether the assignment to level is performed. The second version reads +better, in my opinion, because it makes it clear that the assignment is always +performed and the choice is being made between two values.

    +

    Another reason for including the brackets: a few odd combinations of list +comprehensions and lambdas could look like incorrect conditional expressions. +See PEP 308 for some examples. If you put parentheses around your +conditional expressions, you won’t run into this case.

    +
    +

    See also

    +
    +
    PEP 308 - Conditional Expressions

    PEP written by Guido van Rossum and Raymond D. Hettinger; implemented by Thomas +Wouters.

    +
    +
    +
    +
    +
    +

    PEP 309: Partial Function Application

    +

    The functools module is intended to contain tools for functional-style +programming.

    +

    One useful tool in this module is the partial() function. For programs +written in a functional style, you’ll sometimes want to construct variants of +existing functions that have some of the parameters filled in. Consider a +Python function f(a, b, c); you could create a new function g(b, c) that +was equivalent to f(1, b, c). This is called “partial function +application”.

    +

    partial() takes the arguments (function, arg1, arg2, ... kwarg1=value1, +kwarg2=value2). The resulting object is callable, so you can just call it to +invoke function with the filled-in arguments.

    +

    Here’s a small but realistic example:

    +
    import functools
    +
    +def log (message, subsystem):
    +    "Write the contents of 'message' to the specified subsystem."
    +    print '%s: %s' % (subsystem, message)
    +    ...
    +
    +server_log = functools.partial(log, subsystem='server')
    +server_log('Unable to open socket')
    +
    +
    +

    Here’s another example, from a program that uses PyGTK. Here a context-sensitive +pop-up menu is being constructed dynamically. The callback provided +for the menu option is a partially applied version of the open_item() +method, where the first argument has been provided.

    +
    ...
    +class Application:
    +    def open_item(self, path):
    +       ...
    +    def init (self):
    +        open_func = functools.partial(self.open_item, item_path)
    +        popup_menu.append( ("Open", open_func, 1) )
    +
    +
    +

    Another function in the functools module is the +update_wrapper(wrapper, wrapped) function that helps you write +well-behaved decorators. update_wrapper() copies the name, module, and +docstring attribute to a wrapper function so that tracebacks inside the wrapped +function are easier to understand. For example, you might write:

    +
    def my_decorator(f):
    +    def wrapper(*args, **kwds):
    +        print 'Calling decorated function'
    +        return f(*args, **kwds)
    +    functools.update_wrapper(wrapper, f)
    +    return wrapper
    +
    +
    +

    wraps() is a decorator that can be used inside your own decorators to copy +the wrapped function’s information. An alternate version of the previous +example would be:

    +
    def my_decorator(f):
    +    @functools.wraps(f)
    +    def wrapper(*args, **kwds):
    +        print 'Calling decorated function'
    +        return f(*args, **kwds)
    +    return wrapper
    +
    +
    +
    +

    See also

    +
    +
    PEP 309 - Partial Function Application

    PEP proposed and written by Peter Harris; implemented by Hye-Shik Chang and Nick +Coghlan, with adaptations by Raymond Hettinger.

    +
    +
    +
    +
    +
    +

    PEP 314: Metadata for Python Software Packages v1.1

    +

    Some simple dependency support was added to Distutils. The setup() +function now has requires, provides, and obsoletes keyword +parameters. When you build a source distribution using the sdist command, +the dependency information will be recorded in the PKG-INFO file.

    +

    Another new keyword parameter is download_url, which should be set to a URL +for the package’s source code. This means it’s now possible to look up an entry +in the package index, determine the dependencies for a package, and download the +required packages.

    +
    VERSION = '1.0'
    +setup(name='PyPackage',
    +      version=VERSION,
    +      requires=['numarray', 'zlib (>=1.1.4)'],
    +      obsoletes=['OldPackage']
    +      download_url=('http://www.example.com/pypackage/dist/pkg-%s.tar.gz'
    +                    % VERSION),
    +     )
    +
    +
    +

    Another new enhancement to the Python package index at +https://pypi.org is storing source and binary archives for a +package. The new upload Distutils command will upload a package to +the repository.

    +

    Before a package can be uploaded, you must be able to build a distribution using +the sdist Distutils command. Once that works, you can run python +setup.py upload to add your package to the PyPI archive. Optionally you can +GPG-sign the package by supplying the --sign and --identity +options.

    +

    Package uploading was implemented by Martin von Löwis and Richard Jones.

    +
    +

    See also

    +
    +
    PEP 314 - Metadata for Python Software Packages v1.1

    PEP proposed and written by A.M. Kuchling, Richard Jones, and Fred Drake; +implemented by Richard Jones and Fred Drake.

    +
    +
    +
    +
    +
    +

    PEP 328: Absolute and Relative Imports

    +

    The simpler part of PEP 328 was implemented in Python 2.4: parentheses could now +be used to enclose the names imported from a module using the from ... import +... statement, making it easier to import many different names.

    +

    The more complicated part has been implemented in Python 2.5: importing a module +can be specified to use absolute or package-relative imports. The plan is to +move toward making absolute imports the default in future versions of Python.

    +

    Let’s say you have a package directory like this:

    +
    pkg/
    +pkg/__init__.py
    +pkg/main.py
    +pkg/string.py
    +
    +
    +

    This defines a package named pkg containing the pkg.main and +pkg.string submodules.

    +

    Consider the code in the main.py module. What happens if it executes +the statement import string? In Python 2.4 and earlier, it will first look +in the package’s directory to perform a relative import, finds +pkg/string.py, imports the contents of that file as the +pkg.string module, and that module is bound to the name string in the +pkg.main module’s namespace.

    +

    That’s fine if pkg.string was what you wanted. But what if you wanted +Python’s standard string module? There’s no clean way to ignore +pkg.string and look for the standard module; generally you had to look at +the contents of sys.modules, which is slightly unclean. Holger Krekel’s +py.std package provides a tidier way to perform imports from the standard +library, import py; py.std.string.join(), but that package isn’t available +on all Python installations.

    +

    Reading code which relies on relative imports is also less clear, because a +reader may be confused about which module, string or pkg.string, +is intended to be used. Python users soon learned not to duplicate the names of +standard library modules in the names of their packages’ submodules, but you +can’t protect against having your submodule’s name being used for a new module +added in a future version of Python.

    +

    In Python 2.5, you can switch import’s behaviour to absolute imports +using a from __future__ import absolute_import directive. This absolute-import +behaviour will become the default in a future version (probably Python +2.7). Once absolute imports are the default, import string will always +find the standard library’s version. It’s suggested that users should begin +using absolute imports as much as possible, so it’s preferable to begin writing +from pkg import string in your code.

    +

    Relative imports are still possible by adding a leading period to the module +name when using the from ... import form:

    +
    # Import names from pkg.string
    +from .string import name1, name2
    +# Import pkg.string
    +from . import string
    +
    +
    +

    This imports the string module relative to the current package, so in +pkg.main this will import name1 and name2 from pkg.string. +Additional leading periods perform the relative import starting from the parent +of the current package. For example, code in the A.B.C module can do:

    +
    from . import D                 # Imports A.B.D
    +from .. import E                # Imports A.E
    +from ..F import G               # Imports A.F.G
    +
    +
    +

    Leading periods cannot be used with the import modname form of the import +statement, only the from ... import form.

    +
    +

    See also

    +
    +
    PEP 328 - Imports: Multi-Line and Absolute/Relative

    PEP written by Aahz; implemented by Thomas Wouters.

    +
    +
    https://pylib.readthedocs.io/

    The py library by Holger Krekel, which contains the py.std package.

    +
    +
    +
    +
    +
    +

    PEP 338: Executing Modules as Scripts

    +

    The -m switch added in Python 2.4 to execute a module as a script +gained a few more abilities. Instead of being implemented in C code inside the +Python interpreter, the switch now uses an implementation in a new module, +runpy.

    +

    The runpy module implements a more sophisticated import mechanism so that +it’s now possible to run modules in a package such as pychecker.checker. +The module also supports alternative import mechanisms such as the +zipimport module. This means you can add a .zip archive’s path to +sys.path and then use the -m switch to execute code from the +archive.

    +
    +

    See also

    +
    +
    PEP 338 - Executing modules as scripts

    PEP written and implemented by Nick Coghlan.

    +
    +
    +
    +
    +
    +

    PEP 341: Unified try/except/finally

    +

    Until Python 2.5, the try statement came in two flavours. You could +use a finally block to ensure that code is always executed, or one or +more except blocks to catch specific exceptions. You couldn’t +combine both except blocks and a finally block, because +generating the right bytecode for the combined version was complicated and it +wasn’t clear what the semantics of the combined statement should be.

    +

    Guido van Rossum spent some time working with Java, which does support the +equivalent of combining except blocks and a finally block, +and this clarified what the statement should mean. In Python 2.5, you can now +write:

    +
    try:
    +    block-1 ...
    +except Exception1:
    +    handler-1 ...
    +except Exception2:
    +    handler-2 ...
    +else:
    +    else-block
    +finally:
    +    final-block
    +
    +
    +

    The code in block-1 is executed. If the code raises an exception, the various +except blocks are tested: if the exception is of class +Exception1, handler-1 is executed; otherwise if it’s of class +Exception2, handler-2 is executed, and so forth. If no exception is +raised, the else-block is executed.

    +

    No matter what happened previously, the final-block is executed once the code +block is complete and any raised exceptions handled. Even if there’s an error in +an exception handler or the else-block and a new exception is raised, the code +in the final-block is still run.

    +
    +

    See also

    +
    +
    PEP 341 - Unifying try-except and try-finally

    PEP written by Georg Brandl; implementation by Thomas Lee.

    +
    +
    +
    +
    +
    +

    PEP 342: New Generator Features

    +

    Python 2.5 adds a simple way to pass values into a generator. As introduced in +Python 2.3, generators only produce output; once a generator’s code was invoked +to create an iterator, there was no way to pass any new information into the +function when its execution is resumed. Sometimes the ability to pass in some +information would be useful. Hackish solutions to this include making the +generator’s code look at a global variable and then changing the global +variable’s value, or passing in some mutable object that callers then modify.

    +

    To refresh your memory of basic generators, here’s a simple example:

    +
    def counter (maximum):
    +    i = 0
    +    while i < maximum:
    +        yield i
    +        i += 1
    +
    +
    +

    When you call counter(10), the result is an iterator that returns the values +from 0 up to 9. On encountering the yield statement, the iterator +returns the provided value and suspends the function’s execution, preserving the +local variables. Execution resumes on the following call to the iterator’s +next() method, picking up after the yield statement.

    +

    In Python 2.3, yield was a statement; it didn’t return any value. In +2.5, yield is now an expression, returning a value that can be +assigned to a variable or otherwise operated on:

    +
    val = (yield i)
    +
    +
    +

    I recommend that you always put parentheses around a yield expression +when you’re doing something with the returned value, as in the above example. +The parentheses aren’t always necessary, but it’s easier to always add them +instead of having to remember when they’re needed.

    +

    (PEP 342 explains the exact rules, which are that a +yield-expression must always be parenthesized except when it +occurs at the top-level +expression on the right-hand side of an assignment. This means you can write +val = yield i but have to use parentheses when there’s an operation, as in +val = (yield i) + 12.)

    +

    Values are sent into a generator by calling its send(value) method. The +generator’s code is then resumed and the yield expression returns the +specified value. If the regular next() method is called, the +yield returns None.

    +

    Here’s the previous example, modified to allow changing the value of the +internal counter.

    +
    def counter (maximum):
    +    i = 0
    +    while i < maximum:
    +        val = (yield i)
    +        # If value provided, change counter
    +        if val is not None:
    +            i = val
    +        else:
    +            i += 1
    +
    +
    +

    And here’s an example of changing the counter:

    +
    >>> it = counter(10)
    +>>> print it.next()
    +0
    +>>> print it.next()
    +1
    +>>> print it.send(8)
    +8
    +>>> print it.next()
    +9
    +>>> print it.next()
    +Traceback (most recent call last):
    +  File "t.py", line 15, in ?
    +    print it.next()
    +StopIteration
    +
    +
    +

    yield will usually return None, so you should always check +for this case. Don’t just use its value in expressions unless you’re sure that +the send() method will be the only method used to resume your generator +function.

    +

    In addition to send(), there are two other new methods on generators:

    +
      +
    • throw(type, value=None, traceback=None) is used to raise an exception +inside the generator; the exception is raised by the yield expression +where the generator’s execution is paused.

    • +
    • close() raises a new GeneratorExit exception inside the generator +to terminate the iteration. On receiving this exception, the generator’s code +must either raise GeneratorExit or StopIteration. Catching the +GeneratorExit exception and returning a value is illegal and will trigger +a RuntimeError; if the function raises some other exception, that +exception is propagated to the caller. close() will also be called by +Python’s garbage collector when the generator is garbage-collected.

      +

      If you need to run cleanup code when a GeneratorExit occurs, I suggest +using a try: ... finally: suite instead of catching GeneratorExit.

      +
    • +
    +

    The cumulative effect of these changes is to turn generators from one-way +producers of information into both producers and consumers.

    +

    Generators also become coroutines, a more generalized form of subroutines. +Subroutines are entered at one point and exited at another point (the top of the +function, and a return statement), but coroutines can be entered, +exited, and resumed at many different points (the yield statements). +We’ll have to figure out patterns for using coroutines effectively in Python.

    +

    The addition of the close() method has one side effect that isn’t obvious. +close() is called when a generator is garbage-collected, so this means the +generator’s code gets one last chance to run before the generator is destroyed. +This last chance means that try...finally statements in generators can now +be guaranteed to work; the finally clause will now always get a +chance to run. The syntactic restriction that you couldn’t mix yield +statements with a try...finally suite has therefore been removed. This +seems like a minor bit of language trivia, but using generators and +try...finally is actually necessary in order to implement the +with statement described by PEP 343. I’ll look at this new statement +in the following section.

    +

    Another even more esoteric effect of this change: previously, the +gi_frame attribute of a generator was always a frame object. It’s now +possible for gi_frame to be None once the generator has been +exhausted.

    +
    +

    See also

    +
    +
    PEP 342 - Coroutines via Enhanced Generators

    PEP written by Guido van Rossum and Phillip J. Eby; implemented by Phillip J. +Eby. Includes examples of some fancier uses of generators as coroutines.

    +

    Earlier versions of these features were proposed in PEP 288 by Raymond +Hettinger and PEP 325 by Samuele Pedroni.

    +
    +
    https://en.wikipedia.org/wiki/Coroutine

    The Wikipedia entry for coroutines.

    +
    +
    http://www.sidhe.org/~dan/blog/archives/000178.html

    An explanation of coroutines from a Perl point of view, written by Dan Sugalski.

    +
    +
    +
    +
    +
    +

    PEP 343: The ‘with’ statement

    +

    The ‘with’ statement clarifies code that previously would use +try...finally blocks to ensure that clean-up code is executed. In this +section, I’ll discuss the statement as it will commonly be used. In the next +section, I’ll examine the implementation details and show how to write objects +for use with this statement.

    +

    The ‘with’ statement is a new control-flow structure whose basic +structure is:

    +
    with expression [as variable]:
    +    with-block
    +
    +
    +

    The expression is evaluated, and it should result in an object that supports the +context management protocol (that is, has __enter__() and __exit__() +methods.

    +

    The object’s __enter__() is called before with-block is executed and +therefore can run set-up code. It also may return a value that is bound to the +name variable, if given. (Note carefully that variable is not assigned +the result of expression.)

    +

    After execution of the with-block is finished, the object’s __exit__() +method is called, even if the block raised an exception, and can therefore run +clean-up code.

    +

    To enable the statement in Python 2.5, you need to add the following directive +to your module:

    +
    from __future__ import with_statement
    +
    +
    +

    The statement will always be enabled in Python 2.6.

    +

    Some standard Python objects now support the context management protocol and can +be used with the ‘with’ statement. File objects are one example:

    +
    with open('/etc/passwd', 'r') as f:
    +    for line in f:
    +        print line
    +        ... more processing code ...
    +
    +
    +

    After this statement has executed, the file object in f will have been +automatically closed, even if the for loop raised an exception +part-way through the block.

    +
    +

    Note

    +

    In this case, f is the same object created by open(), because +file.__enter__() returns self.

    +
    +

    The threading module’s locks and condition variables also support the +‘with’ statement:

    +
    lock = threading.Lock()
    +with lock:
    +    # Critical section of code
    +    ...
    +
    +
    +

    The lock is acquired before the block is executed and always released once the +block is complete.

    +

    The new localcontext() function in the decimal module makes it easy +to save and restore the current decimal context, which encapsulates the desired +precision and rounding characteristics for computations:

    +
    from decimal import Decimal, Context, localcontext
    +
    +# Displays with default precision of 28 digits
    +v = Decimal('578')
    +print v.sqrt()
    +
    +with localcontext(Context(prec=16)):
    +    # All code in this block uses a precision of 16 digits.
    +    # The original context is restored on exiting the block.
    +    print v.sqrt()
    +
    +
    +
    +

    Writing Context Managers

    +

    Under the hood, the ‘with’ statement is fairly complicated. Most +people will only use ‘with’ in company with existing objects and +don’t need to know these details, so you can skip the rest of this section if +you like. Authors of new objects will need to understand the details of the +underlying implementation and should keep reading.

    +

    A high-level explanation of the context management protocol is:

    +
      +
    • The expression is evaluated and should result in an object called a “context +manager”. The context manager must have __enter__() and __exit__() +methods.

    • +
    • The context manager’s __enter__() method is called. The value returned +is assigned to VAR. If no 'as VAR' clause is present, the value is simply +discarded.

    • +
    • The code in BLOCK is executed.

    • +
    • If BLOCK raises an exception, the __exit__(type, value, traceback) +is called with the exception details, the same values returned by +sys.exc_info(). The method’s return value controls whether the exception +is re-raised: any false value re-raises the exception, and True will result +in suppressing it. You’ll only rarely want to suppress the exception, because +if you do the author of the code containing the ‘with’ statement will +never realize anything went wrong.

    • +
    • If BLOCK didn’t raise an exception, the __exit__() method is still +called, but type, value, and traceback are all None.

    • +
    +

    Let’s think through an example. I won’t present detailed code but will only +sketch the methods necessary for a database that supports transactions.

    +

    (For people unfamiliar with database terminology: a set of changes to the +database are grouped into a transaction. Transactions can be either committed, +meaning that all the changes are written into the database, or rolled back, +meaning that the changes are all discarded and the database is unchanged. See +any database textbook for more information.)

    +

    Let’s assume there’s an object representing a database connection. Our goal will +be to let the user write code like this:

    +
    db_connection = DatabaseConnection()
    +with db_connection as cursor:
    +    cursor.execute('insert into ...')
    +    cursor.execute('delete from ...')
    +    # ... more operations ...
    +
    +
    +

    The transaction should be committed if the code in the block runs flawlessly or +rolled back if there’s an exception. Here’s the basic interface for +DatabaseConnection that I’ll assume:

    +
    class DatabaseConnection:
    +    # Database interface
    +    def cursor (self):
    +        "Returns a cursor object and starts a new transaction"
    +    def commit (self):
    +        "Commits current transaction"
    +    def rollback (self):
    +        "Rolls back current transaction"
    +
    +
    +

    The __enter__() method is pretty easy, having only to start a new +transaction. For this application the resulting cursor object would be a useful +result, so the method will return it. The user can then add as cursor to +their ‘with’ statement to bind the cursor to a variable name.

    +
    class DatabaseConnection:
    +    ...
    +    def __enter__ (self):
    +        # Code to start a new transaction
    +        cursor = self.cursor()
    +        return cursor
    +
    +
    +

    The __exit__() method is the most complicated because it’s where most of +the work has to be done. The method has to check if an exception occurred. If +there was no exception, the transaction is committed. The transaction is rolled +back if there was an exception.

    +

    In the code below, execution will just fall off the end of the function, +returning the default value of None. None is false, so the exception +will be re-raised automatically. If you wished, you could be more explicit and +add a return statement at the marked location.

    +
    class DatabaseConnection:
    +    ...
    +    def __exit__ (self, type, value, tb):
    +        if tb is None:
    +            # No exception, so commit
    +            self.commit()
    +        else:
    +            # Exception occurred, so rollback.
    +            self.rollback()
    +            # return False
    +
    +
    +
    +
    +

    The contextlib module

    +

    The new contextlib module provides some functions and a decorator that +are useful for writing objects for use with the ‘with’ statement.

    +

    The decorator is called contextmanager(), and lets you write a single +generator function instead of defining a new class. The generator should yield +exactly one value. The code up to the yield will be executed as the +__enter__() method, and the value yielded will be the method’s return +value that will get bound to the variable in the ‘with’ statement’s +as clause, if any. The code after the yield will be +executed in the __exit__() method. Any exception raised in the block will +be raised by the yield statement.

    +

    Our database example from the previous section could be written using this +decorator as:

    +
    from contextlib import contextmanager
    +
    +@contextmanager
    +def db_transaction (connection):
    +    cursor = connection.cursor()
    +    try:
    +        yield cursor
    +    except:
    +        connection.rollback()
    +        raise
    +    else:
    +        connection.commit()
    +
    +db = DatabaseConnection()
    +with db_transaction(db) as cursor:
    +    ...
    +
    +
    +

    The contextlib module also has a nested(mgr1, mgr2, ...) function +that combines a number of context managers so you don’t need to write nested +‘with’ statements. In this example, the single ‘with’ +statement both starts a database transaction and acquires a thread lock:

    +
    lock = threading.Lock()
    +with nested (db_transaction(db), lock) as (cursor, locked):
    +    ...
    +
    +
    +

    Finally, the closing(object) function returns object so that it can be +bound to a variable, and calls object.close at the end of the block.

    +
    import urllib, sys
    +from contextlib import closing
    +
    +with closing(urllib.urlopen('http://www.yahoo.com')) as f:
    +    for line in f:
    +        sys.stdout.write(line)
    +
    +
    +
    +

    See also

    +
    +
    PEP 343 - The “with” statement

    PEP written by Guido van Rossum and Nick Coghlan; implemented by Mike Bland, +Guido van Rossum, and Neal Norwitz. The PEP shows the code generated for a +‘with’ statement, which can be helpful in learning how the statement +works.

    +
    +
    +

    The documentation for the contextlib module.

    +
    +
    +
    +
    +

    PEP 352: Exceptions as New-Style Classes

    +

    Exception classes can now be new-style classes, not just classic classes, and +the built-in Exception class and all the standard built-in exceptions +(NameError, ValueError, etc.) are now new-style classes.

    +

    The inheritance hierarchy for exceptions has been rearranged a bit. In 2.5, the +inheritance relationships are:

    +
    BaseException       # New in Python 2.5
    +|- KeyboardInterrupt
    +|- SystemExit
    +|- Exception
    +   |- (all other current built-in exceptions)
    +
    +
    +

    This rearrangement was done because people often want to catch all exceptions +that indicate program errors. KeyboardInterrupt and SystemExit +aren’t errors, though, and usually represent an explicit action such as the user +hitting Control-C or code calling sys.exit(). A bare except: will +catch all exceptions, so you commonly need to list KeyboardInterrupt and +SystemExit in order to re-raise them. The usual pattern is:

    +
    try:
    +    ...
    +except (KeyboardInterrupt, SystemExit):
    +    raise
    +except:
    +    # Log error...
    +    # Continue running program...
    +
    +
    +

    In Python 2.5, you can now write except Exception to achieve the same +result, catching all the exceptions that usually indicate errors but leaving +KeyboardInterrupt and SystemExit alone. As in previous versions, +a bare except: still catches all exceptions.

    +

    The goal for Python 3.0 is to require any class raised as an exception to derive +from BaseException or some descendant of BaseException, and future +releases in the Python 2.x series may begin to enforce this constraint. +Therefore, I suggest you begin making all your exception classes derive from +Exception now. It’s been suggested that the bare except: form should +be removed in Python 3.0, but Guido van Rossum hasn’t decided whether to do this +or not.

    +

    Raising of strings as exceptions, as in the statement raise "Error +occurred", is deprecated in Python 2.5 and will trigger a warning. The aim is +to be able to remove the string-exception feature in a few releases.

    +
    +

    See also

    +
    +
    PEP 352 - Required Superclass for Exceptions

    PEP written by Brett Cannon and Guido van Rossum; implemented by Brett Cannon.

    +
    +
    +
    +
    +
    +

    PEP 353: Using ssize_t as the index type

    +

    A wide-ranging change to Python’s C API, using a new Py_ssize_t type +definition instead of int, will permit the interpreter to handle more +data on 64-bit platforms. This change doesn’t affect Python’s capacity on 32-bit +platforms.

    +

    Various pieces of the Python interpreter used C’s int type to store +sizes or counts; for example, the number of items in a list or tuple were stored +in an int. The C compilers for most 64-bit platforms still define +int as a 32-bit type, so that meant that lists could only hold up to +2**31 - 1 = 2147483647 items. (There are actually a few different +programming models that 64-bit C compilers can use – see +http://www.unix.org/version2/whatsnew/lp64_wp.html for a discussion – but the +most commonly available model leaves int as 32 bits.)

    +

    A limit of 2147483647 items doesn’t really matter on a 32-bit platform because +you’ll run out of memory before hitting the length limit. Each list item +requires space for a pointer, which is 4 bytes, plus space for a +PyObject representing the item. 2147483647*4 is already more bytes +than a 32-bit address space can contain.

    +

    It’s possible to address that much memory on a 64-bit platform, however. The +pointers for a list that size would only require 16 GiB of space, so it’s not +unreasonable that Python programmers might construct lists that large. +Therefore, the Python interpreter had to be changed to use some type other than +int, and this will be a 64-bit type on 64-bit platforms. The change +will cause incompatibilities on 64-bit machines, so it was deemed worth making +the transition now, while the number of 64-bit users is still relatively small. +(In 5 or 10 years, we may all be on 64-bit machines, and the transition would +be more painful then.)

    +

    This change most strongly affects authors of C extension modules. Python +strings and container types such as lists and tuples now use +Py_ssize_t to store their size. Functions such as +PyList_Size() now return Py_ssize_t. Code in extension modules +may therefore need to have some variables changed to Py_ssize_t.

    +

    The PyArg_ParseTuple() and Py_BuildValue() functions have a new +conversion code, n, for Py_ssize_t. PyArg_ParseTuple()’s +s# and t# still output int by default, but you can define the +macro PY_SSIZE_T_CLEAN before including Python.h to make +them return Py_ssize_t.

    +

    PEP 353 has a section on conversion guidelines that extension authors should +read to learn about supporting 64-bit platforms.

    +
    +

    See also

    +
    +
    PEP 353 - Using ssize_t as the index type

    PEP written and implemented by Martin von Löwis.

    +
    +
    +
    +
    +
    +

    PEP 357: The ‘__index__’ method

    +

    The NumPy developers had a problem that could only be solved by adding a new +special method, __index__(). When using slice notation, as in +[start:stop:step], the values of the start, stop, and step indexes +must all be either integers or long integers. NumPy defines a variety of +specialized integer types corresponding to unsigned and signed integers of 8, +16, 32, and 64 bits, but there was no way to signal that these types could be +used as slice indexes.

    +

    Slicing can’t just use the existing __int__() method because that method +is also used to implement coercion to integers. If slicing used +__int__(), floating-point numbers would also become legal slice indexes +and that’s clearly an undesirable behaviour.

    +

    Instead, a new special method called __index__() was added. It takes no +arguments and returns an integer giving the slice index to use. For example:

    +
    class C:
    +    def __index__ (self):
    +        return self.value
    +
    +
    +

    The return value must be either a Python integer or long integer. The +interpreter will check that the type returned is correct, and raises a +TypeError if this requirement isn’t met.

    +

    A corresponding nb_index slot was added to the C-level +PyNumberMethods structure to let C extensions implement this protocol. +PyNumber_Index(obj) can be used in extension code to call the +__index__() function and retrieve its result.

    +
    +

    See also

    +
    +
    PEP 357 - Allowing Any Object to be Used for Slicing

    PEP written and implemented by Travis Oliphant.

    +
    +
    +
    +
    +
    +

    Other Language Changes

    +

    Here are all of the changes that Python 2.5 makes to the core Python language.

    +
      +
    • The dict type has a new hook for letting subclasses provide a default +value when a key isn’t contained in the dictionary. When a key isn’t found, the +dictionary’s __missing__(key) method will be called. This hook is used +to implement the new defaultdict class in the collections +module. The following example defines a dictionary that returns zero for any +missing key:

      +
      class zerodict (dict):
      +    def __missing__ (self, key):
      +        return 0
      +
      +d = zerodict({1:1, 2:2})
      +print d[1], d[2]   # Prints 1, 2
      +print d[3], d[4]   # Prints 0, 0
      +
      +
      +
    • +
    • Both 8-bit and Unicode strings have new partition(sep) and +rpartition(sep) methods that simplify a common use case.

      +

      The find(S) method is often used to get an index which is then used to +slice the string and obtain the pieces that are before and after the separator. +partition(sep) condenses this pattern into a single method call that +returns a 3-tuple containing the substring before the separator, the separator +itself, and the substring after the separator. If the separator isn’t found, +the first element of the tuple is the entire string and the other two elements +are empty. rpartition(sep) also returns a 3-tuple but starts searching +from the end of the string; the r stands for ‘reverse’.

      +

      Some examples:

      +
      >>> ('http://www.python.org').partition('://')
      +('http', '://', 'www.python.org')
      +>>> ('file:/usr/share/doc/index.html').partition('://')
      +('file:/usr/share/doc/index.html', '', '')
      +>>> (u'Subject: a quick question').partition(':')
      +(u'Subject', u':', u' a quick question')
      +>>> 'www.python.org'.rpartition('.')
      +('www.python', '.', 'org')
      +>>> 'www.python.org'.rpartition(':')
      +('', '', 'www.python.org')
      +
      +
      +

      (Implemented by Fredrik Lundh following a suggestion by Raymond Hettinger.)

      +
    • +
    • The startswith() and endswith() methods of string types now accept +tuples of strings to check for.

      +
      def is_image_file (filename):
      +    return filename.endswith(('.gif', '.jpg', '.tiff'))
      +
      +
      +

      (Implemented by Georg Brandl following a suggestion by Tom Lynn.)

      +
    • +
    • The min() and max() built-in functions gained a key keyword +parameter analogous to the key argument for sort(). This parameter +supplies a function that takes a single argument and is called for every value +in the list; min()/max() will return the element with the +smallest/largest return value from this function. For example, to find the +longest string in a list, you can do:

      +
      L = ['medium', 'longest', 'short']
      +# Prints 'longest'
      +print max(L, key=len)
      +# Prints 'short', because lexicographically 'short' has the largest value
      +print max(L)
      +
      +
      +

      (Contributed by Steven Bethard and Raymond Hettinger.)

      +
    • +
    • Two new built-in functions, any() and all(), evaluate whether an +iterator contains any true or false values. any() returns True +if any value returned by the iterator is true; otherwise it will return +False. all() returns True only if all of the values +returned by the iterator evaluate as true. (Suggested by Guido van Rossum, and +implemented by Raymond Hettinger.)

    • +
    • The result of a class’s __hash__() method can now be either a long +integer or a regular integer. If a long integer is returned, the hash of that +value is taken. In earlier versions the hash value was required to be a +regular integer, but in 2.5 the id() built-in was changed to always +return non-negative numbers, and users often seem to use id(self) in +__hash__() methods (though this is discouraged).

      +
    • +
    • ASCII is now the default encoding for modules. It’s now a syntax error if a +module contains string literals with 8-bit characters but doesn’t have an +encoding declaration. In Python 2.4 this triggered a warning, not a syntax +error. See PEP 263 for how to declare a module’s encoding; for example, you +might add a line like this near the top of the source file:

      +
      # -*- coding: latin1 -*-
      +
      +
      +
    • +
    • A new warning, UnicodeWarning, is triggered when you attempt to +compare a Unicode string and an 8-bit string that can’t be converted to Unicode +using the default ASCII encoding. The result of the comparison is false:

      +
      >>> chr(128) == unichr(128)   # Can't convert chr(128) to Unicode
      +__main__:1: UnicodeWarning: Unicode equal comparison failed
      +  to convert both arguments to Unicode - interpreting them
      +  as being unequal
      +False
      +>>> chr(127) == unichr(127)   # chr(127) can be converted
      +True
      +
      +
      +

      Previously this would raise a UnicodeDecodeError exception, but in 2.5 +this could result in puzzling problems when accessing a dictionary. If you +looked up unichr(128) and chr(128) was being used as a key, you’d get a +UnicodeDecodeError exception. Other changes in 2.5 resulted in this +exception being raised instead of suppressed by the code in dictobject.c +that implements dictionaries.

      +

      Raising an exception for such a comparison is strictly correct, but the change +might have broken code, so instead UnicodeWarning was introduced.

      +

      (Implemented by Marc-André Lemburg.)

      +
    • +
    • One error that Python programmers sometimes make is forgetting to include an +__init__.py module in a package directory. Debugging this mistake can be +confusing, and usually requires running Python with the -v switch to +log all the paths searched. In Python 2.5, a new ImportWarning warning is +triggered when an import would have picked up a directory as a package but no +__init__.py was found. This warning is silently ignored by default; +provide the -Wd option when running the Python executable to display +the warning message. (Implemented by Thomas Wouters.)

    • +
    • The list of base classes in a class definition can now be empty. As an +example, this is now legal:

      +
      class C():
      +    pass
      +
      +
      +

      (Implemented by Brett Cannon.)

      +
    • +
    +
    +

    Interactive Interpreter Changes

    +

    In the interactive interpreter, quit and exit have long been strings so +that new users get a somewhat helpful message when they try to quit:

    +
    >>> quit
    +'Use Ctrl-D (i.e. EOF) to exit.'
    +
    +
    +

    In Python 2.5, quit and exit are now objects that still produce string +representations of themselves, but are also callable. Newbies who try quit() +or exit() will now exit the interpreter as they expect. (Implemented by +Georg Brandl.)

    +

    The Python executable now accepts the standard long options --help +and --version; on Windows, it also accepts the /? option +for displaying a help message. (Implemented by Georg Brandl.)

    +
    +
    +

    Optimizations

    +

    Several of the optimizations were developed at the NeedForSpeed sprint, an event +held in Reykjavik, Iceland, from May 21–28 2006. The sprint focused on speed +enhancements to the CPython implementation and was funded by EWT LLC with local +support from CCP Games. Those optimizations added at this sprint are specially +marked in the following list.

    +
      +
    • When they were introduced in Python 2.4, the built-in set and +frozenset types were built on top of Python’s dictionary type. In 2.5 +the internal data structure has been customized for implementing sets, and as a +result sets will use a third less memory and are somewhat faster. (Implemented +by Raymond Hettinger.)

    • +
    • The speed of some Unicode operations, such as finding substrings, string +splitting, and character map encoding and decoding, has been improved. +(Substring search and splitting improvements were added by Fredrik Lundh and +Andrew Dalke at the NeedForSpeed sprint. Character maps were improved by Walter +Dörwald and Martin von Löwis.)

      +
    • +
    • The long(str, base) function is now faster on long digit strings +because fewer intermediate results are calculated. The peak is for strings of +around 800–1000 digits where the function is 6 times faster. (Contributed by +Alan McIntyre and committed at the NeedForSpeed sprint.)

      +
    • +
    • It’s now illegal to mix iterating over a file with for line in file and +calling the file object’s read()/readline()/readlines() +methods. Iteration uses an internal buffer and the read*() methods +don’t use that buffer. Instead they would return the data following the +buffer, causing the data to appear out of order. Mixing iteration and these +methods will now trigger a ValueError from the read*() method. +(Implemented by Thomas Wouters.)

      +
    • +
    • The struct module now compiles structure format strings into an +internal representation and caches this representation, yielding a 20% speedup. +(Contributed by Bob Ippolito at the NeedForSpeed sprint.)

    • +
    • The re module got a 1 or 2% speedup by switching to Python’s allocator +functions instead of the system’s malloc() and free(). +(Contributed by Jack Diederich at the NeedForSpeed sprint.)

    • +
    • The code generator’s peephole optimizer now performs simple constant folding +in expressions. If you write something like a = 2+3, the code generator +will do the arithmetic and produce code corresponding to a = 5. (Proposed +and implemented by Raymond Hettinger.)

    • +
    • Function calls are now faster because code objects now keep the most recently +finished frame (a “zombie frame”) in an internal field of the code object, +reusing it the next time the code object is invoked. (Original patch by Michael +Hudson, modified by Armin Rigo and Richard Jones; committed at the NeedForSpeed +sprint.) Frame objects are also slightly smaller, which may improve cache +locality and reduce memory usage a bit. (Contributed by Neal Norwitz.)

      +
    • +
    • Python’s built-in exceptions are now new-style classes, a change that speeds +up instantiation considerably. Exception handling in Python 2.5 is therefore +about 30% faster than in 2.4. (Contributed by Richard Jones, Georg Brandl and +Sean Reifschneider at the NeedForSpeed sprint.)

    • +
    • Importing now caches the paths tried, recording whether they exist or not so +that the interpreter makes fewer open() and stat() calls on +startup. (Contributed by Martin von Löwis and Georg Brandl.)

      +
    • +
    +
    +
    +
    +

    New, Improved, and Removed Modules

    +

    The standard library received many enhancements and bug fixes in Python 2.5. +Here’s a partial list of the most notable changes, sorted alphabetically by +module name. Consult the Misc/NEWS file in the source tree for a more +complete list of changes, or look through the SVN logs for all the details.

    +
      +
    • The audioop module now supports the a-LAW encoding, and the code for +u-LAW encoding has been improved. (Contributed by Lars Immisch.)

    • +
    • The codecs module gained support for incremental codecs. The +codec.lookup() function now returns a CodecInfo instance instead +of a tuple. CodecInfo instances behave like a 4-tuple to preserve +backward compatibility but also have the attributes encode, +decode, incrementalencoder, incrementaldecoder, +streamwriter, and streamreader. Incremental codecs can receive +input and produce output in multiple chunks; the output is the same as if the +entire input was fed to the non-incremental codec. See the codecs module +documentation for details. (Designed and implemented by Walter Dörwald.)

      +
    • +
    • The collections module gained a new type, defaultdict, that +subclasses the standard dict type. The new type mostly behaves like a +dictionary but constructs a default value when a key isn’t present, +automatically adding it to the dictionary for the requested key value.

      +

      The first argument to defaultdict’s constructor is a factory function +that gets called whenever a key is requested but not found. This factory +function receives no arguments, so you can use built-in type constructors such +as list() or int(). For example, you can make an index of words +based on their initial letter like this:

      +
      words = """Nel mezzo del cammin di nostra vita
      +mi ritrovai per una selva oscura
      +che la diritta via era smarrita""".lower().split()
      +
      +index = defaultdict(list)
      +
      +for w in words:
      +    init_letter = w[0]
      +    index[init_letter].append(w)
      +
      +
      +

      Printing index results in the following output:

      +
      defaultdict(<type 'list'>, {'c': ['cammin', 'che'], 'e': ['era'],
      +        'd': ['del', 'di', 'diritta'], 'm': ['mezzo', 'mi'],
      +        'l': ['la'], 'o': ['oscura'], 'n': ['nel', 'nostra'],
      +        'p': ['per'], 's': ['selva', 'smarrita'],
      +        'r': ['ritrovai'], 'u': ['una'], 'v': ['vita', 'via']}
      +
      +
      +

      (Contributed by Guido van Rossum.)

      +
    • +
    • The deque double-ended queue type supplied by the collections +module now has a remove(value) method that removes the first occurrence +of value in the queue, raising ValueError if the value isn’t found. +(Contributed by Raymond Hettinger.)

    • +
    • New module: The contextlib module contains helper functions for use +with the new ‘with’ statement. See section The contextlib module +for more about this module.

    • +
    • New module: The cProfile module is a C implementation of the existing +profile module that has much lower overhead. The module’s interface is +the same as profile: you run cProfile.run('main()') to profile a +function, can save profile data to a file, etc. It’s not yet known if the +Hotshot profiler, which is also written in C but doesn’t match the +profile module’s interface, will continue to be maintained in future +versions of Python. (Contributed by Armin Rigo.)

      +

      Also, the pstats module for analyzing the data measured by the profiler +now supports directing the output to any file object by supplying a stream +argument to the Stats constructor. (Contributed by Skip Montanaro.)

      +
    • +
    • The csv module, which parses files in comma-separated value format, +received several enhancements and a number of bugfixes. You can now set the +maximum size in bytes of a field by calling the +csv.field_size_limit(new_limit) function; omitting the new_limit +argument will return the currently-set limit. The reader class now has +a line_num attribute that counts the number of physical lines read from +the source; records can span multiple physical lines, so line_num is not +the same as the number of records read.

      +

      The CSV parser is now stricter about multi-line quoted fields. Previously, if a +line ended within a quoted field without a terminating newline character, a +newline would be inserted into the returned field. This behavior caused problems +when reading files that contained carriage return characters within fields, so +the code was changed to return the field without inserting newlines. As a +consequence, if newlines embedded within fields are important, the input should +be split into lines in a manner that preserves the newline characters.

      +

      (Contributed by Skip Montanaro and Andrew McNamara.)

      +
    • +
    • The datetime class in the datetime module now has a +strptime(string, format) method for parsing date strings, contributed +by Josh Spoerri. It uses the same format characters as time.strptime() and +time.strftime():

      +
      from datetime import datetime
      +
      +ts = datetime.strptime('10:13:15 2006-03-07',
      +                       '%H:%M:%S %Y-%m-%d')
      +
      +
      +
    • +
    • The SequenceMatcher.get_matching_blocks() method in the difflib +module now guarantees to return a minimal list of blocks describing matching +subsequences. Previously, the algorithm would occasionally break a block of +matching elements into two list entries. (Enhancement by Tim Peters.)

    • +
    • The doctest module gained a SKIP option that keeps an example from +being executed at all. This is intended for code snippets that are usage +examples intended for the reader and aren’t actually test cases.

      +

      An encoding parameter was added to the testfile() function and the +DocFileSuite class to specify the file’s encoding. This makes it +easier to use non-ASCII characters in tests contained within a docstring. +(Contributed by Bjorn Tillenius.)

      +
    • +
    • The email package has been updated to version 4.0. (Contributed by +Barry Warsaw.)

      +
    • +
    • The fileinput module was made more flexible. Unicode filenames are now +supported, and a mode parameter that defaults to "r" was added to the +input() function to allow opening files in binary or universal +newlines mode. Another new parameter, openhook, lets you use a function +other than open() to open the input files. Once you’re iterating over +the set of files, the FileInput object’s new fileno() returns +the file descriptor for the currently opened file. (Contributed by Georg +Brandl.)

    • +
    • In the gc module, the new get_count() function returns a 3-tuple +containing the current collection counts for the three GC generations. This is +accounting information for the garbage collector; when these counts reach a +specified threshold, a garbage collection sweep will be made. The existing +gc.collect() function now takes an optional generation argument of 0, 1, +or 2 to specify which generation to collect. (Contributed by Barry Warsaw.)

    • +
    • The nsmallest() and nlargest() functions in the heapq +module now support a key keyword parameter similar to the one provided by +the min()/max() functions and the sort() methods. For +example:

      +
      >>> import heapq
      +>>> L = ["short", 'medium', 'longest', 'longer still']
      +>>> heapq.nsmallest(2, L)  # Return two lowest elements, lexicographically
      +['longer still', 'longest']
      +>>> heapq.nsmallest(2, L, key=len)   # Return two shortest elements
      +['short', 'medium']
      +
      +
      +

      (Contributed by Raymond Hettinger.)

      +
    • +
    • The itertools.islice() function now accepts None for the start and +step arguments. This makes it more compatible with the attributes of slice +objects, so that you can now write the following:

      +
      s = slice(5)     # Create slice object
      +itertools.islice(iterable, s.start, s.stop, s.step)
      +
      +
      +

      (Contributed by Raymond Hettinger.)

      +
    • +
    • The format() function in the locale module has been modified and +two new functions were added, format_string() and currency().

      +

      The format() function’s val parameter could previously be a string as +long as no more than one %char specifier appeared; now the parameter must be +exactly one %char specifier with no surrounding text. An optional monetary +parameter was also added which, if True, will use the locale’s rules for +formatting currency in placing a separator between groups of three digits.

      +

      To format strings with multiple %char specifiers, use the new +format_string() function that works like format() but also supports +mixing %char specifiers with arbitrary text.

      +

      A new currency() function was also added that formats a number according +to the current locale’s settings.

      +

      (Contributed by Georg Brandl.)

      +
    • +
    • The mailbox module underwent a massive rewrite to add the capability to +modify mailboxes in addition to reading them. A new set of classes that include +mbox, MH, and Maildir are used to read mailboxes, and +have an add(message) method to add messages, remove(key) to +remove messages, and lock()/unlock() to lock/unlock the mailbox. +The following example converts a maildir-format mailbox into an mbox-format +one:

      +
      import mailbox
      +
      +# 'factory=None' uses email.Message.Message as the class representing
      +# individual messages.
      +src = mailbox.Maildir('maildir', factory=None)
      +dest = mailbox.mbox('/tmp/mbox')
      +
      +for msg in src:
      +    dest.add(msg)
      +
      +
      +

      (Contributed by Gregory K. Johnson. Funding was provided by Google’s 2005 +Summer of Code.)

      +
    • +
    • New module: the msilib module allows creating Microsoft Installer +.msi files and CAB files. Some support for reading the .msi +database is also included. (Contributed by Martin von Löwis.)

    • +
    • The nis module now supports accessing domains other than the system +default domain by supplying a domain argument to the nis.match() and +nis.maps() functions. (Contributed by Ben Bell.)

    • +
    • The operator module’s itemgetter() and attrgetter() +functions now support multiple fields. A call such as +operator.attrgetter('a', 'b') will return a function that retrieves the +a and b attributes. Combining this new feature with the +sort() method’s key parameter lets you easily sort lists using +multiple fields. (Contributed by Raymond Hettinger.)

    • +
    • The optparse module was updated to version 1.5.1 of the Optik library. +The OptionParser class gained an epilog attribute, a string +that will be printed after the help message, and a destroy() method to +break reference cycles created by the object. (Contributed by Greg Ward.)

    • +
    • The os module underwent several changes. The stat_float_times +variable now defaults to true, meaning that os.stat() will now return time +values as floats. (This doesn’t necessarily mean that os.stat() will +return times that are precise to fractions of a second; not all systems support +such precision.)

      +

      Constants named os.SEEK_SET, os.SEEK_CUR, and +os.SEEK_END have been added; these are the parameters to the +os.lseek() function. Two new constants for locking are +os.O_SHLOCK and os.O_EXLOCK.

      +

      Two new functions, wait3() and wait4(), were added. They’re similar +the waitpid() function which waits for a child process to exit and returns +a tuple of the process ID and its exit status, but wait3() and +wait4() return additional information. wait3() doesn’t take a +process ID as input, so it waits for any child process to exit and returns a +3-tuple of process-id, exit-status, resource-usage as returned from the +resource.getrusage() function. wait4(pid) does take a process ID. +(Contributed by Chad J. Schroeder.)

      +

      On FreeBSD, the os.stat() function now returns times with nanosecond +resolution, and the returned object now has st_gen and +st_birthtime. The st_flags attribute is also available, if the +platform supports it. (Contributed by Antti Louko and Diego Pettenò.)

      +
    • +
    • The Python debugger provided by the pdb module can now store lists of +commands to execute when a breakpoint is reached and execution stops. Once +breakpoint #1 has been created, enter commands 1 and enter a series of +commands to be executed, finishing the list with end. The command list can +include commands that resume execution, such as continue or next. +(Contributed by Grégoire Dooms.)

      +
    • +
    • The pickle and cPickle modules no longer accept a return value +of None from the __reduce__() method; the method must return a tuple +of arguments instead. The ability to return None was deprecated in Python +2.4, so this completes the removal of the feature.

    • +
    • The pkgutil module, containing various utility functions for finding +packages, was enhanced to support PEP 302’s import hooks and now also works for +packages stored in ZIP-format archives. (Contributed by Phillip J. Eby.)

    • +
    • The pybench benchmark suite by Marc-André Lemburg is now included in the +Tools/pybench directory. The pybench suite is an improvement on the +commonly used pystone.py program because pybench provides a more +detailed measurement of the interpreter’s speed. It times particular operations +such as function calls, tuple slicing, method lookups, and numeric operations, +instead of performing many different operations and reducing the result to a +single number as pystone.py does.

    • +
    • The pyexpat module now uses version 2.0 of the Expat parser. +(Contributed by Trent Mick.)

    • +
    • The Queue class provided by the Queue module gained two new +methods. join() blocks until all items in the queue have been retrieved +and all processing work on the items have been completed. Worker threads call +the other new method, task_done(), to signal that processing for an item +has been completed. (Contributed by Raymond Hettinger.)

    • +
    • The old regex and regsub modules, which have been deprecated +ever since Python 2.0, have finally been deleted. Other deleted modules: +statcache, tzparse, whrandom.

    • +
    • Also deleted: the lib-old directory, which includes ancient modules +such as dircmp and ni, was removed. lib-old wasn’t on the +default sys.path, so unless your programs explicitly added the directory to +sys.path, this removal shouldn’t affect your code.

    • +
    • The rlcompleter module is no longer dependent on importing the +readline module and therefore now works on non-Unix platforms. (Patch +from Robert Kiendl.)

      +
    • +
    • The SimpleXMLRPCServer and DocXMLRPCServer classes now have a +rpc_paths attribute that constrains XML-RPC operations to a limited set +of URL paths; the default is to allow only '/' and '/RPC2'. Setting +rpc_paths to None or an empty tuple disables this path checking.

      +
    • +
    • The socket module now supports AF_NETLINK sockets on Linux, +thanks to a patch from Philippe Biondi. Netlink sockets are a Linux-specific +mechanism for communications between a user-space process and kernel code; an +introductory article about them is at https://www.linuxjournal.com/article/7356. +In Python code, netlink addresses are represented as a tuple of 2 integers, +(pid, group_mask).

      +

      Two new methods on socket objects, recv_into(buffer) and +recvfrom_into(buffer), store the received data in an object that +supports the buffer protocol instead of returning the data as a string. This +means you can put the data directly into an array or a memory-mapped file.

      +

      Socket objects also gained getfamily(), gettype(), and +getproto() accessor methods to retrieve the family, type, and protocol +values for the socket.

      +
    • +
    • New module: the spwd module provides functions for accessing the shadow +password database on systems that support shadow passwords.

    • +
    • The struct is now faster because it compiles format strings into +Struct objects with pack() and unpack() methods. This is +similar to how the re module lets you create compiled regular expression +objects. You can still use the module-level pack() and unpack() +functions; they’ll create Struct objects and cache them. Or you can +use Struct instances directly:

      +
      s = struct.Struct('ih3s')
      +
      +data = s.pack(1972, 187, 'abc')
      +year, number, name = s.unpack(data)
      +
      +
      +

      You can also pack and unpack data to and from buffer objects directly using the +pack_into(buffer, offset, v1, v2, ...) and unpack_from(buffer, +offset) methods. This lets you store data directly into an array or a +memory-mapped file.

      +

      (Struct objects were implemented by Bob Ippolito at the NeedForSpeed +sprint. Support for buffer objects was added by Martin Blais, also at the +NeedForSpeed sprint.)

      +
    • +
    • The Python developers switched from CVS to Subversion during the 2.5 +development process. Information about the exact build version is available as +the sys.subversion variable, a 3-tuple of (interpreter-name, branch-name, +revision-range). For example, at the time of writing my copy of 2.5 was +reporting ('CPython', 'trunk', '45313:45315').

      +

      This information is also available to C extensions via the +Py_GetBuildInfo() function that returns a string of build information +like this: "trunk:45355:45356M, Apr 13 2006, 07:42:19". (Contributed by +Barry Warsaw.)

      +
    • +
    • Another new function, sys._current_frames(), returns the current stack +frames for all running threads as a dictionary mapping thread identifiers to the +topmost stack frame currently active in that thread at the time the function is +called. (Contributed by Tim Peters.)

    • +
    • The TarFile class in the tarfile module now has an +extractall() method that extracts all members from the archive into the +current working directory. It’s also possible to set a different directory as +the extraction target, and to unpack only a subset of the archive’s members.

      +

      The compression used for a tarfile opened in stream mode can now be autodetected +using the mode 'r|*'. (Contributed by Lars Gustäbel.)

      +
    • +
    • The threading module now lets you set the stack size used when new +threads are created. The stack_size([*size*]) function returns the +currently configured stack size, and supplying the optional size parameter +sets a new value. Not all platforms support changing the stack size, but +Windows, POSIX threading, and OS/2 all do. (Contributed by Andrew MacIntyre.)

      +
    • +
    • The unicodedata module has been updated to use version 4.1.0 of the +Unicode character database. Version 3.2.0 is required by some specifications, +so it’s still available as unicodedata.ucd_3_2_0.

    • +
    • New module: the uuid module generates universally unique identifiers +(UUIDs) according to RFC 4122. The RFC defines several different UUID +versions that are generated from a starting string, from system properties, or +purely randomly. This module contains a UUID class and functions +named uuid1(), uuid3(), uuid4(), and uuid5() to +generate different versions of UUID. (Version 2 UUIDs are not specified in +RFC 4122 and are not supported by this module.)

      +
      >>> import uuid
      +>>> # make a UUID based on the host ID and current time
      +>>> uuid.uuid1()
      +UUID('a8098c1a-f86e-11da-bd1a-00112444be1e')
      +
      +>>> # make a UUID using an MD5 hash of a namespace UUID and a name
      +>>> uuid.uuid3(uuid.NAMESPACE_DNS, 'python.org')
      +UUID('6fa459ea-ee8a-3ca4-894e-db77e160355e')
      +
      +>>> # make a random UUID
      +>>> uuid.uuid4()
      +UUID('16fd2706-8baf-433b-82eb-8c7fada847da')
      +
      +>>> # make a UUID using a SHA-1 hash of a namespace UUID and a name
      +>>> uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org')
      +UUID('886313e1-3b8a-5372-9b90-0c9aee199e5d')
      +
      +
      +

      (Contributed by Ka-Ping Yee.)

      +
    • +
    • The weakref module’s WeakKeyDictionary and +WeakValueDictionary types gained new methods for iterating over the +weak references contained in the dictionary. iterkeyrefs() and +keyrefs() methods were added to WeakKeyDictionary, and +itervaluerefs() and valuerefs() were added to +WeakValueDictionary. (Contributed by Fred L. Drake, Jr.)

    • +
    • The webbrowser module received a number of enhancements. It’s now +usable as a script with python -m webbrowser, taking a URL as the argument; +there are a number of switches to control the behaviour (-n for a new +browser window, -t for a new tab). New module-level functions, +open_new() and open_new_tab(), were added to support this. The +module’s open() function supports an additional feature, an autoraise +parameter that signals whether to raise the open window when possible. A number +of additional browsers were added to the supported list such as Firefox, Opera, +Konqueror, and elinks. (Contributed by Oleg Broytmann and Georg Brandl.)

      +
    • +
    • The xmlrpclib module now supports returning datetime objects +for the XML-RPC date type. Supply use_datetime=True to the loads() +function or the Unmarshaller class to enable this feature. (Contributed +by Skip Montanaro.)

      +
    • +
    • The zipfile module now supports the ZIP64 version of the format, +meaning that a .zip archive can now be larger than 4 GiB and can contain +individual files larger than 4 GiB. (Contributed by Ronald Oussoren.)

      +
    • +
    • The zlib module’s Compress and Decompress objects now +support a copy() method that makes a copy of the object’s internal state +and returns a new Compress or Decompress object. +(Contributed by Chris AtLee.)

      +
    • +
    +
    +

    The ctypes package

    +

    The ctypes package, written by Thomas Heller, has been added to the +standard library. ctypes lets you call arbitrary functions in shared +libraries or DLLs. Long-time users may remember the dl module, which +provides functions for loading shared libraries and calling functions in them. +The ctypes package is much fancier.

    +

    To load a shared library or DLL, you must create an instance of the +CDLL class and provide the name or path of the shared library or DLL. +Once that’s done, you can call arbitrary functions by accessing them as +attributes of the CDLL object.

    +
    import ctypes
    +
    +libc = ctypes.CDLL('libc.so.6')
    +result = libc.printf("Line of output\n")
    +
    +
    +

    Type constructors for the various C types are provided: c_int(), +c_float(), c_double(), c_char_p() (equivalent to char +*), and so forth. Unlike Python’s types, the C versions are all mutable; you +can assign to their value attribute to change the wrapped value. Python +integers and strings will be automatically converted to the corresponding C +types, but for other types you must call the correct type constructor. (And I +mean must; getting it wrong will often result in the interpreter crashing +with a segmentation fault.)

    +

    You shouldn’t use c_char_p() with a Python string when the C function will +be modifying the memory area, because Python strings are supposed to be +immutable; breaking this rule will cause puzzling bugs. When you need a +modifiable memory area, use create_string_buffer():

    +
    s = "this is a string"
    +buf = ctypes.create_string_buffer(s)
    +libc.strfry(buf)
    +
    +
    +

    C functions are assumed to return integers, but you can set the restype +attribute of the function object to change this:

    +
    >>> libc.atof('2.71828')
    +-1783957616
    +>>> libc.atof.restype = ctypes.c_double
    +>>> libc.atof('2.71828')
    +2.71828
    +
    +
    +

    ctypes also provides a wrapper for Python’s C API as the +ctypes.pythonapi object. This object does not release the global +interpreter lock before calling a function, because the lock must be held when +calling into the interpreter’s code. There’s a py_object() type +constructor that will create a PyObject * pointer. A simple usage:

    +
    import ctypes
    +
    +d = {}
    +ctypes.pythonapi.PyObject_SetItem(ctypes.py_object(d),
    +          ctypes.py_object("abc"),  ctypes.py_object(1))
    +# d is now {'abc', 1}.
    +
    +
    +

    Don’t forget to use py_object(); if it’s omitted you end up with a +segmentation fault.

    +

    ctypes has been around for a while, but people still write and +distribution hand-coded extension modules because you can’t rely on +ctypes being present. Perhaps developers will begin to write Python +wrappers atop a library accessed through ctypes instead of extension +modules, now that ctypes is included with core Python.

    +
    +

    See also

    +
    +
    http://starship.python.net/crew/theller/ctypes/

    The ctypes web page, with a tutorial, reference, and FAQ.

    +
    +
    +

    The documentation for the ctypes module.

    +
    +
    +
    +

    The ElementTree package

    +

    A subset of Fredrik Lundh’s ElementTree library for processing XML has been +added to the standard library as xml.etree. The available modules are +ElementTree, ElementPath, and ElementInclude from +ElementTree 1.2.6. The cElementTree accelerator module is also +included.

    +

    The rest of this section will provide a brief overview of using ElementTree. +Full documentation for ElementTree is available at +http://effbot.org/zone/element-index.htm.

    +

    ElementTree represents an XML document as a tree of element nodes. The text +content of the document is stored as the text and tail +attributes of (This is one of the major differences between ElementTree and +the Document Object Model; in the DOM there are many different types of node, +including TextNode.)

    +

    The most commonly used parsing function is parse(), that takes either a +string (assumed to contain a filename) or a file-like object and returns an +ElementTree instance:

    +
    from xml.etree import ElementTree as ET
    +
    +tree = ET.parse('ex-1.xml')
    +
    +feed = urllib.urlopen(
    +          'http://planet.python.org/rss10.xml')
    +tree = ET.parse(feed)
    +
    +
    +

    Once you have an ElementTree instance, you can call its getroot() +method to get the root Element node.

    +

    There’s also an XML() function that takes a string literal and returns an +Element node (not an ElementTree). This function provides a +tidy way to incorporate XML fragments, approaching the convenience of an XML +literal:

    +
    svg = ET.XML("""<svg width="10px" version="1.0">
    +             </svg>""")
    +svg.set('height', '320px')
    +svg.append(elem1)
    +
    +
    +

    Each XML element supports some dictionary-like and some list-like access +methods. Dictionary-like operations are used to access attribute values, and +list-like operations are used to access child nodes.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Operation

    Result

    elem[n]

    Returns n’th child element.

    elem[m:n]

    Returns list of m’th through n’th child +elements.

    len(elem)

    Returns number of child elements.

    list(elem)

    Returns list of child elements.

    elem.append(elem2)

    Adds elem2 as a child.

    elem.insert(index, elem2)

    Inserts elem2 at the specified location.

    del elem[n]

    Deletes n’th child element.

    elem.keys()

    Returns list of attribute names.

    elem.get(name)

    Returns value of attribute name.

    elem.set(name, value)

    Sets new value for attribute name.

    elem.attrib

    Retrieves the dictionary containing +attributes.

    del elem.attrib[name]

    Deletes attribute name.

    +

    Comments and processing instructions are also represented as Element +nodes. To check if a node is a comment or processing instructions:

    +
    if elem.tag is ET.Comment:
    +    ...
    +elif elem.tag is ET.ProcessingInstruction:
    +    ...
    +
    +
    +

    To generate XML output, you should call the ElementTree.write() method. +Like parse(), it can take either a string or a file-like object:

    +
    # Encoding is US-ASCII
    +tree.write('output.xml')
    +
    +# Encoding is UTF-8
    +f = open('output.xml', 'w')
    +tree.write(f, encoding='utf-8')
    +
    +
    +

    (Caution: the default encoding used for output is ASCII. For general XML work, +where an element’s name may contain arbitrary Unicode characters, ASCII isn’t a +very useful encoding because it will raise an exception if an element’s name +contains any characters with values greater than 127. Therefore, it’s best to +specify a different encoding such as UTF-8 that can handle any Unicode +character.)

    +

    This section is only a partial description of the ElementTree interfaces. Please +read the package’s official documentation for more details.

    +
    +

    See also

    +
    +
    http://effbot.org/zone/element-index.htm

    Official documentation for ElementTree.

    +
    +
    +
    +
    +
    +

    The hashlib package

    +

    A new hashlib module, written by Gregory P. Smith, has been added to +replace the md5 and sha modules. hashlib adds support for +additional secure hashes (SHA-224, SHA-256, SHA-384, and SHA-512). When +available, the module uses OpenSSL for fast platform optimized implementations +of algorithms.

    +

    The old md5 and sha modules still exist as wrappers around hashlib +to preserve backwards compatibility. The new module’s interface is very close +to that of the old modules, but not identical. The most significant difference +is that the constructor functions for creating new hashing objects are named +differently.

    +
    # Old versions
    +h = md5.md5()
    +h = md5.new()
    +
    +# New version
    +h = hashlib.md5()
    +
    +# Old versions
    +h = sha.sha()
    +h = sha.new()
    +
    +# New version
    +h = hashlib.sha1()
    +
    +# Hash that weren't previously available
    +h = hashlib.sha224()
    +h = hashlib.sha256()
    +h = hashlib.sha384()
    +h = hashlib.sha512()
    +
    +# Alternative form
    +h = hashlib.new('md5')          # Provide algorithm as a string
    +
    +
    +

    Once a hash object has been created, its methods are the same as before: +update(string) hashes the specified string into the current digest +state, digest() and hexdigest() return the digest value as a binary +string or a string of hex digits, and copy() returns a new hashing object +with the same digest state.

    +
    +

    See also

    +

    The documentation for the hashlib module.

    +
    +
    +
    +

    The sqlite3 package

    +

    The pysqlite module (http://www.pysqlite.org), a wrapper for the SQLite embedded +database, has been added to the standard library under the package name +sqlite3.

    +

    SQLite is a C library that provides a lightweight disk-based database that +doesn’t require a separate server process and allows accessing the database +using a nonstandard variant of the SQL query language. Some applications can use +SQLite for internal data storage. It’s also possible to prototype an +application using SQLite and then port the code to a larger database such as +PostgreSQL or Oracle.

    +

    pysqlite was written by Gerhard Häring and provides a SQL interface compliant +with the DB-API 2.0 specification described by PEP 249.

    +

    If you’re compiling the Python source yourself, note that the source tree +doesn’t include the SQLite code, only the wrapper module. You’ll need to have +the SQLite libraries and headers installed before compiling Python, and the +build process will compile the module when the necessary headers are available.

    +

    To use the module, you must first create a Connection object that +represents the database. Here the data will be stored in the +/tmp/example file:

    +
    conn = sqlite3.connect('/tmp/example')
    +
    +
    +

    You can also supply the special name :memory: to create a database in RAM.

    +

    Once you have a Connection, you can create a Cursor object +and call its execute() method to perform SQL commands:

    +
    c = conn.cursor()
    +
    +# Create table
    +c.execute('''create table stocks
    +(date text, trans text, symbol text,
    + qty real, price real)''')
    +
    +# Insert a row of data
    +c.execute("""insert into stocks
    +          values ('2006-01-05','BUY','RHAT',100,35.14)""")
    +
    +
    +

    Usually your SQL operations will need to use values from Python variables. You +shouldn’t assemble your query using Python’s string operations because doing so +is insecure; it makes your program vulnerable to an SQL injection attack.

    +

    Instead, use the DB-API’s parameter substitution. Put ? as a placeholder +wherever you want to use a value, and then provide a tuple of values as the +second argument to the cursor’s execute() method. (Other database modules +may use a different placeholder, such as %s or :1.) For example:

    +
    # Never do this -- insecure!
    +symbol = 'IBM'
    +c.execute("... where symbol = '%s'" % symbol)
    +
    +# Do this instead
    +t = (symbol,)
    +c.execute('select * from stocks where symbol=?', t)
    +
    +# Larger example
    +for t in (('2006-03-28', 'BUY', 'IBM', 1000, 45.00),
    +          ('2006-04-05', 'BUY', 'MSOFT', 1000, 72.00),
    +          ('2006-04-06', 'SELL', 'IBM', 500, 53.00),
    +         ):
    +    c.execute('insert into stocks values (?,?,?,?,?)', t)
    +
    +
    +

    To retrieve data after executing a SELECT statement, you can either treat the +cursor as an iterator, call the cursor’s fetchone() method to retrieve a +single matching row, or call fetchall() to get a list of the matching +rows.

    +

    This example uses the iterator form:

    +
    >>> c = conn.cursor()
    +>>> c.execute('select * from stocks order by price')
    +>>> for row in c:
    +...    print row
    +...
    +(u'2006-01-05', u'BUY', u'RHAT', 100, 35.140000000000001)
    +(u'2006-03-28', u'BUY', u'IBM', 1000, 45.0)
    +(u'2006-04-06', u'SELL', u'IBM', 500, 53.0)
    +(u'2006-04-05', u'BUY', u'MSOFT', 1000, 72.0)
    +>>>
    +
    +
    +

    For more information about the SQL dialect supported by SQLite, see +https://www.sqlite.org.

    +
    +

    See also

    +
    +
    http://www.pysqlite.org

    The pysqlite web page.

    +
    +
    https://www.sqlite.org

    The SQLite web page; the documentation describes the syntax and the available +data types for the supported SQL dialect.

    +
    +
    +

    The documentation for the sqlite3 module.

    +
    +
    PEP 249 - Database API Specification 2.0

    PEP written by Marc-André Lemburg.

    +
    +
    +
    +
    +
    +

    The wsgiref package

    +

    The Web Server Gateway Interface (WSGI) v1.0 defines a standard interface +between web servers and Python web applications and is described in PEP 333. +The wsgiref package is a reference implementation of the WSGI +specification.

    +

    The package includes a basic HTTP server that will run a WSGI application; this +server is useful for debugging but isn’t intended for production use. Setting +up a server takes only a few lines of code:

    +
    from wsgiref import simple_server
    +
    +wsgi_app = ...
    +
    +host = ''
    +port = 8000
    +httpd = simple_server.make_server(host, port, wsgi_app)
    +httpd.serve_forever()
    +
    +
    +
    +

    See also

    +
    +
    http://www.wsgi.org

    A central web site for WSGI-related resources.

    +
    +
    PEP 333 - Python Web Server Gateway Interface v1.0

    PEP written by Phillip J. Eby.

    +
    +
    +
    +
    +
    +
    +

    Build and C API Changes

    +

    Changes to Python’s build process and to the C API include:

    +
      +
    • The Python source tree was converted from CVS to Subversion, in a complex +migration procedure that was supervised and flawlessly carried out by Martin von +Löwis. The procedure was developed as PEP 347.

    • +
    • Coverity, a company that markets a source code analysis tool called Prevent, +provided the results of their examination of the Python source code. The +analysis found about 60 bugs that were quickly fixed. Many of the bugs were +refcounting problems, often occurring in error-handling code. See +https://scan.coverity.com for the statistics.

    • +
    • The largest change to the C API came from PEP 353, which modifies the +interpreter to use a Py_ssize_t type definition instead of +int. See the earlier section PEP 353: Using ssize_t as the index type for a discussion of this +change.

    • +
    • The design of the bytecode compiler has changed a great deal, no longer +generating bytecode by traversing the parse tree. Instead the parse tree is +converted to an abstract syntax tree (or AST), and it is the abstract syntax +tree that’s traversed to produce the bytecode.

      +

      It’s possible for Python code to obtain AST objects by using the +compile() built-in and specifying _ast.PyCF_ONLY_AST as the value of +the flags parameter:

      +
      from _ast import PyCF_ONLY_AST
      +ast = compile("""a=0
      +for i in range(10):
      +    a += i
      +""", "<string>", 'exec', PyCF_ONLY_AST)
      +
      +assignment = ast.body[0]
      +for_loop = ast.body[1]
      +
      +
      +

      No official documentation has been written for the AST code yet, but PEP 339 +discusses the design. To start learning about the code, read the definition of +the various AST nodes in Parser/Python.asdl. A Python script reads this +file and generates a set of C structure definitions in +Include/Python-ast.h. The PyParser_ASTFromString() and +PyParser_ASTFromFile(), defined in Include/pythonrun.h, take +Python source as input and return the root of an AST representing the contents. +This AST can then be turned into a code object by PyAST_Compile(). For +more information, read the source code, and then ask questions on python-dev.

      +

      The AST code was developed under Jeremy Hylton’s management, and implemented by +(in alphabetical order) Brett Cannon, Nick Coghlan, Grant Edwards, John +Ehresman, Kurt Kaiser, Neal Norwitz, Tim Peters, Armin Rigo, and Neil +Schemenauer, plus the participants in a number of AST sprints at conferences +such as PyCon.

      +
    • +
    • Evan Jones’s patch to obmalloc, first described in a talk at PyCon DC 2005, +was applied. Python 2.4 allocated small objects in 256K-sized arenas, but never +freed arenas. With this patch, Python will free arenas when they’re empty. The +net effect is that on some platforms, when you allocate many objects, Python’s +memory usage may actually drop when you delete them and the memory may be +returned to the operating system. (Implemented by Evan Jones, and reworked by +Tim Peters.)

      +

      Note that this change means extension modules must be more careful when +allocating memory. Python’s API has many different functions for allocating +memory that are grouped into families. For example, PyMem_Malloc(), +PyMem_Realloc(), and PyMem_Free() are one family that allocates +raw memory, while PyObject_Malloc(), PyObject_Realloc(), and +PyObject_Free() are another family that’s supposed to be used for +creating Python objects.

      +

      Previously these different families all reduced to the platform’s +malloc() and free() functions. This meant it didn’t matter if +you got things wrong and allocated memory with the PyMem() function but +freed it with the PyObject() function. With 2.5’s changes to obmalloc, +these families now do different things and mismatches will probably result in a +segfault. You should carefully test your C extension modules with Python 2.5.

      +
    • +
    • The built-in set types now have an official C API. Call PySet_New() +and PyFrozenSet_New() to create a new set, PySet_Add() and +PySet_Discard() to add and remove elements, and PySet_Contains() +and PySet_Size() to examine the set’s state. (Contributed by Raymond +Hettinger.)

    • +
    • C code can now obtain information about the exact revision of the Python +interpreter by calling the Py_GetBuildInfo() function that returns a +string of build information like this: "trunk:45355:45356M, Apr 13 2006, +07:42:19". (Contributed by Barry Warsaw.)

    • +
    • Two new macros can be used to indicate C functions that are local to the +current file so that a faster calling convention can be used. +Py_LOCAL(type) declares the function as returning a value of the +specified type and uses a fast-calling qualifier. +Py_LOCAL_INLINE(type) does the same thing and also requests the +function be inlined. If PY_LOCAL_AGGRESSIVE() is defined before +python.h is included, a set of more aggressive optimizations are enabled +for the module; you should benchmark the results to find out if these +optimizations actually make the code faster. (Contributed by Fredrik Lundh at +the NeedForSpeed sprint.)

    • +
    • PyErr_NewException(name, base, dict) can now accept a tuple of base +classes as its base argument. (Contributed by Georg Brandl.)

    • +
    • The PyErr_Warn() function for issuing warnings is now deprecated in +favour of PyErr_WarnEx(category, message, stacklevel) which lets you +specify the number of stack frames separating this function and the caller. A +stacklevel of 1 is the function calling PyErr_WarnEx(), 2 is the +function above that, and so forth. (Added by Neal Norwitz.)

    • +
    • The CPython interpreter is still written in C, but the code can now be +compiled with a C++ compiler without errors. (Implemented by Anthony Baxter, +Martin von Löwis, Skip Montanaro.)

    • +
    • The PyRange_New() function was removed. It was never documented, never +used in the core code, and had dangerously lax error checking. In the unlikely +case that your extensions were using it, you can replace it by something like +the following:

      +
      range = PyObject_CallFunction((PyObject*) &PyRange_Type, "lll",
      +                              start, stop, step);
      +
      +
      +
    • +
    +
    +

    Port-Specific Changes

    +
      +
    • MacOS X (10.3 and higher): dynamic loading of modules now uses the +dlopen() function instead of MacOS-specific functions.

    • +
    • MacOS X: an --enable-universalsdk switch was added to the +configure script that compiles the interpreter as a universal binary +able to run on both PowerPC and Intel processors. (Contributed by Ronald +Oussoren; bpo-2573.)

    • +
    • Windows: .dll is no longer supported as a filename extension for +extension modules. .pyd is now the only filename extension that will be +searched for.

    • +
    +
    +
    +
    +

    Porting to Python 2.5

    +

    This section lists previously described changes that may require changes to your +code:

    +
      +
    • ASCII is now the default encoding for modules. It’s now a syntax error if a +module contains string literals with 8-bit characters but doesn’t have an +encoding declaration. In Python 2.4 this triggered a warning, not a syntax +error.

    • +
    • Previously, the gi_frame attribute of a generator was always a frame +object. Because of the PEP 342 changes described in section PEP 342: New Generator Features, +it’s now possible for gi_frame to be None.

    • +
    • A new warning, UnicodeWarning, is triggered when you attempt to +compare a Unicode string and an 8-bit string that can’t be converted to Unicode +using the default ASCII encoding. Previously such comparisons would raise a +UnicodeDecodeError exception.

    • +
    • Library: the csv module is now stricter about multi-line quoted fields. +If your files contain newlines embedded within fields, the input should be split +into lines in a manner which preserves the newline characters.

    • +
    • Library: the locale module’s format() function’s would +previously accept any string as long as no more than one %char specifier +appeared. In Python 2.5, the argument must be exactly one %char specifier with +no surrounding text.

    • +
    • Library: The pickle and cPickle modules no longer accept a +return value of None from the __reduce__() method; the method must +return a tuple of arguments instead. The modules also no longer accept the +deprecated bin keyword parameter.

    • +
    • Library: The SimpleXMLRPCServer and DocXMLRPCServer classes now +have a rpc_paths attribute that constrains XML-RPC operations to a +limited set of URL paths; the default is to allow only '/' and '/RPC2'. +Setting rpc_paths to None or an empty tuple disables this path +checking.

    • +
    • C API: Many functions now use Py_ssize_t instead of int to +allow processing more data on 64-bit machines. Extension code may need to make +the same change to avoid warnings and to support 64-bit machines. See the +earlier section PEP 353: Using ssize_t as the index type for a discussion of this change.

    • +
    • C API: The obmalloc changes mean that you must be careful to not mix usage +of the PyMem_*() and PyObject_*() families of functions. Memory +allocated with one family’s *_Malloc() must be freed with the +corresponding family’s *_Free() function.

    • +
    +
    +
    +

    Acknowledgements

    +

    The author would like to thank the following people for offering suggestions, +corrections and assistance with various drafts of this article: Georg Brandl, +Nick Coghlan, Phillip J. Eby, Lars Gustäbel, Raymond Hettinger, Ralf W. +Grosse-Kunstleve, Kent Johnson, Iain Lowe, Martin von Löwis, Fredrik Lundh, Andrew +McNamara, Skip Montanaro, Gustavo Niemeyer, Paul Prescod, James Pryor, Mike +Rovner, Scott Weikart, Barry Warsaw, Thomas Wouters.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/whatsnew/2.6.html b/python-3.7.4-docs-html/whatsnew/2.6.html new file mode 100644 index 0000000..57a1c83 --- /dev/null +++ b/python-3.7.4-docs-html/whatsnew/2.6.html @@ -0,0 +1,3171 @@ + + + + + + + What’s New in Python 2.6 — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    What’s New in Python 2.6

    +
    +
    Author
    +

    A.M. Kuchling (amk at amk.ca)

    +
    +
    +

    This article explains the new features in Python 2.6, released on October 1 +2008. The release schedule is described in PEP 361.

    +

    The major theme of Python 2.6 is preparing the migration path to +Python 3.0, a major redesign of the language. Whenever possible, +Python 2.6 incorporates new features and syntax from 3.0 while +remaining compatible with existing code by not removing older features +or syntax. When it’s not possible to do that, Python 2.6 tries to do +what it can, adding compatibility functions in a +future_builtins module and a -3 switch to warn about +usages that will become unsupported in 3.0.

    +

    Some significant new packages have been added to the standard library, +such as the multiprocessing and json modules, but +there aren’t many new features that aren’t related to Python 3.0 in +some way.

    +

    Python 2.6 also sees a number of improvements and bugfixes throughout +the source. A search through the change logs finds there were 259 +patches applied and 612 bugs fixed between Python 2.5 and 2.6. Both +figures are likely to be underestimates.

    +

    This article doesn’t attempt to provide a complete specification of +the new features, but instead provides a convenient overview. For +full details, you should refer to the documentation for Python 2.6. If +you want to understand the rationale for the design and +implementation, refer to the PEP for a particular new feature. +Whenever possible, “What’s New in Python” links to the bug/patch item +for each change.

    +
    +

    Python 3.0

    +

    The development cycle for Python versions 2.6 and 3.0 was +synchronized, with the alpha and beta releases for both versions being +made on the same days. The development of 3.0 has influenced many +features in 2.6.

    +

    Python 3.0 is a far-ranging redesign of Python that breaks +compatibility with the 2.x series. This means that existing Python +code will need some conversion in order to run on +Python 3.0. However, not all the changes in 3.0 necessarily break +compatibility. In cases where new features won’t cause existing code +to break, they’ve been backported to 2.6 and are described in this +document in the appropriate place. Some of the 3.0-derived features +are:

    +
      +
    • A __complex__() method for converting objects to a complex number.

    • +
    • Alternate syntax for catching exceptions: except TypeError as exc.

    • +
    • The addition of functools.reduce() as a synonym for the built-in +reduce() function.

    • +
    +

    Python 3.0 adds several new built-in functions and changes the +semantics of some existing builtins. Functions that are new in 3.0 +such as bin() have simply been added to Python 2.6, but existing +builtins haven’t been changed; instead, the future_builtins +module has versions with the new 3.0 semantics. Code written to be +compatible with 3.0 can do from future_builtins import hex, map as +necessary.

    +

    A new command-line switch, -3, enables warnings +about features that will be removed in Python 3.0. You can run code +with this switch to see how much work will be necessary to port +code to 3.0. The value of this switch is available +to Python code as the boolean variable sys.py3kwarning, +and to C extension code as Py_Py3kWarningFlag.

    +
    +

    See also

    +

    The 3xxx series of PEPs, which contains proposals for Python 3.0. +PEP 3000 describes the development process for Python 3.0. +Start with PEP 3100 that describes the general goals for Python +3.0, and then explore the higher-numbered PEPS that propose +specific features.

    +
    +
    +
    +

    Changes to the Development Process

    +

    While 2.6 was being developed, the Python development process +underwent two significant changes: we switched from SourceForge’s +issue tracker to a customized Roundup installation, and the +documentation was converted from LaTeX to reStructuredText.

    +
    +

    New Issue Tracker: Roundup

    +

    For a long time, the Python developers had been growing increasingly +annoyed by SourceForge’s bug tracker. SourceForge’s hosted solution +doesn’t permit much customization; for example, it wasn’t possible to +customize the life cycle of issues.

    +

    The infrastructure committee of the Python Software Foundation +therefore posted a call for issue trackers, asking volunteers to set +up different products and import some of the bugs and patches from +SourceForge. Four different trackers were examined: Jira, +Launchpad, +Roundup, and +Trac. +The committee eventually settled on Jira +and Roundup as the two candidates. Jira is a commercial product that +offers no-cost hosted instances to free-software projects; Roundup +is an open-source project that requires volunteers +to administer it and a server to host it.

    +

    After posting a call for volunteers, a new Roundup installation was +set up at https://bugs.python.org. One installation of Roundup can +host multiple trackers, and this server now also hosts issue trackers +for Jython and for the Python web site. It will surely find +other uses in the future. Where possible, +this edition of “What’s New in Python” links to the bug/patch +item for each change.

    +

    Hosting of the Python bug tracker is kindly provided by +Upfront Systems +of Stellenbosch, South Africa. Martin von Löwis put a +lot of effort into importing existing bugs and patches from +SourceForge; his scripts for this import operation are at +http://svn.python.org/view/tracker/importer/ and may be useful to +other projects wishing to move from SourceForge to Roundup.

    +
    +

    See also

    +
    +
    https://bugs.python.org

    The Python bug tracker.

    +
    +
    http://bugs.jython.org:

    The Jython bug tracker.

    +
    +
    http://roundup.sourceforge.net/

    Roundup downloads and documentation.

    +
    +
    http://svn.python.org/view/tracker/importer/

    Martin von Löwis’s conversion scripts.

    +
    +
    +
    +
    +
    +

    New Documentation Format: reStructuredText Using Sphinx

    +

    The Python documentation was written using LaTeX since the project +started around 1989. In the 1980s and early 1990s, most documentation +was printed out for later study, not viewed online. LaTeX was widely +used because it provided attractive printed output while remaining +straightforward to write once the basic rules of the markup were +learned.

    +

    Today LaTeX is still used for writing publications destined for +printing, but the landscape for programming tools has shifted. We no +longer print out reams of documentation; instead, we browse through it +online and HTML has become the most important format to support. +Unfortunately, converting LaTeX to HTML is fairly complicated and Fred +L. Drake Jr., the long-time Python documentation editor, spent a lot +of time maintaining the conversion process. Occasionally people would +suggest converting the documentation into SGML and later XML, but +performing a good conversion is a major task and no one ever committed +the time required to finish the job.

    +

    During the 2.6 development cycle, Georg Brandl put a lot of effort +into building a new toolchain for processing the documentation. The +resulting package is called Sphinx, and is available from +http://sphinx-doc.org/.

    +

    Sphinx concentrates on HTML output, producing attractively styled and +modern HTML; printed output is still supported through conversion to +LaTeX. The input format is reStructuredText, a markup syntax +supporting custom extensions and directives that is commonly used in +the Python community.

    +

    Sphinx is a standalone package that can be used for writing, and +almost two dozen other projects +(listed on the Sphinx web site) +have adopted Sphinx as their documentation tool.

    +
    +

    See also

    +
    +
    Documenting Python

    Describes how to write for Python’s documentation.

    +
    +
    Sphinx

    Documentation and code for the Sphinx toolchain.

    +
    +
    Docutils

    The underlying reStructuredText parser and toolset.

    +
    +
    +
    +
    +
    +
    +

    PEP 343: The ‘with’ statement

    +

    The previous version, Python 2.5, added the ‘with’ +statement as an optional feature, to be enabled by a from __future__ +import with_statement directive. In 2.6 the statement no longer needs to +be specially enabled; this means that with is now always a +keyword. The rest of this section is a copy of the corresponding +section from the “What’s New in Python 2.5” document; if you’re +familiar with the ‘with’ statement +from Python 2.5, you can skip this section.

    +

    The ‘with’ statement clarifies code that previously would use +try...finally blocks to ensure that clean-up code is executed. In this +section, I’ll discuss the statement as it will commonly be used. In the next +section, I’ll examine the implementation details and show how to write objects +for use with this statement.

    +

    The ‘with’ statement is a control-flow structure whose basic +structure is:

    +
    with expression [as variable]:
    +    with-block
    +
    +
    +

    The expression is evaluated, and it should result in an object that supports the +context management protocol (that is, has __enter__() and __exit__() +methods).

    +

    The object’s __enter__() is called before with-block is executed and +therefore can run set-up code. It also may return a value that is bound to the +name variable, if given. (Note carefully that variable is not assigned +the result of expression.)

    +

    After execution of the with-block is finished, the object’s __exit__() +method is called, even if the block raised an exception, and can therefore run +clean-up code.

    +

    Some standard Python objects now support the context management protocol and can +be used with the ‘with’ statement. File objects are one example:

    +
    with open('/etc/passwd', 'r') as f:
    +    for line in f:
    +        print line
    +        ... more processing code ...
    +
    +
    +

    After this statement has executed, the file object in f will have been +automatically closed, even if the for loop raised an exception +part-way through the block.

    +
    +

    Note

    +

    In this case, f is the same object created by open(), because +file.__enter__() returns self.

    +
    +

    The threading module’s locks and condition variables also support the +‘with’ statement:

    +
    lock = threading.Lock()
    +with lock:
    +    # Critical section of code
    +    ...
    +
    +
    +

    The lock is acquired before the block is executed and always released once the +block is complete.

    +

    The localcontext() function in the decimal module makes it easy +to save and restore the current decimal context, which encapsulates the desired +precision and rounding characteristics for computations:

    +
    from decimal import Decimal, Context, localcontext
    +
    +# Displays with default precision of 28 digits
    +v = Decimal('578')
    +print v.sqrt()
    +
    +with localcontext(Context(prec=16)):
    +    # All code in this block uses a precision of 16 digits.
    +    # The original context is restored on exiting the block.
    +    print v.sqrt()
    +
    +
    +
    +

    Writing Context Managers

    +

    Under the hood, the ‘with’ statement is fairly complicated. Most +people will only use ‘with’ in company with existing objects and +don’t need to know these details, so you can skip the rest of this section if +you like. Authors of new objects will need to understand the details of the +underlying implementation and should keep reading.

    +

    A high-level explanation of the context management protocol is:

    +
      +
    • The expression is evaluated and should result in an object called a “context +manager”. The context manager must have __enter__() and __exit__() +methods.

    • +
    • The context manager’s __enter__() method is called. The value returned +is assigned to VAR. If no as VAR clause is present, the value is simply +discarded.

    • +
    • The code in BLOCK is executed.

    • +
    • If BLOCK raises an exception, the context manager’s __exit__() method +is called with three arguments, the exception details (type, value, traceback, +the same values returned by sys.exc_info(), which can also be None +if no exception occurred). The method’s return value controls whether an exception +is re-raised: any false value re-raises the exception, and True will result +in suppressing it. You’ll only rarely want to suppress the exception, because +if you do the author of the code containing the ‘with’ statement will +never realize anything went wrong.

    • +
    • If BLOCK didn’t raise an exception, the __exit__() method is still +called, but type, value, and traceback are all None.

    • +
    +

    Let’s think through an example. I won’t present detailed code but will only +sketch the methods necessary for a database that supports transactions.

    +

    (For people unfamiliar with database terminology: a set of changes to the +database are grouped into a transaction. Transactions can be either committed, +meaning that all the changes are written into the database, or rolled back, +meaning that the changes are all discarded and the database is unchanged. See +any database textbook for more information.)

    +

    Let’s assume there’s an object representing a database connection. Our goal will +be to let the user write code like this:

    +
    db_connection = DatabaseConnection()
    +with db_connection as cursor:
    +    cursor.execute('insert into ...')
    +    cursor.execute('delete from ...')
    +    # ... more operations ...
    +
    +
    +

    The transaction should be committed if the code in the block runs flawlessly or +rolled back if there’s an exception. Here’s the basic interface for +DatabaseConnection that I’ll assume:

    +
    class DatabaseConnection:
    +    # Database interface
    +    def cursor(self):
    +        "Returns a cursor object and starts a new transaction"
    +    def commit(self):
    +        "Commits current transaction"
    +    def rollback(self):
    +        "Rolls back current transaction"
    +
    +
    +

    The __enter__() method is pretty easy, having only to start a new +transaction. For this application the resulting cursor object would be a useful +result, so the method will return it. The user can then add as cursor to +their ‘with’ statement to bind the cursor to a variable name.

    +
    class DatabaseConnection:
    +    ...
    +    def __enter__(self):
    +        # Code to start a new transaction
    +        cursor = self.cursor()
    +        return cursor
    +
    +
    +

    The __exit__() method is the most complicated because it’s where most of +the work has to be done. The method has to check if an exception occurred. If +there was no exception, the transaction is committed. The transaction is rolled +back if there was an exception.

    +

    In the code below, execution will just fall off the end of the function, +returning the default value of None. None is false, so the exception +will be re-raised automatically. If you wished, you could be more explicit and +add a return statement at the marked location.

    +
    class DatabaseConnection:
    +    ...
    +    def __exit__(self, type, value, tb):
    +        if tb is None:
    +            # No exception, so commit
    +            self.commit()
    +        else:
    +            # Exception occurred, so rollback.
    +            self.rollback()
    +            # return False
    +
    +
    +
    +
    +

    The contextlib module

    +

    The contextlib module provides some functions and a decorator that +are useful when writing objects for use with the ‘with’ statement.

    +

    The decorator is called contextmanager(), and lets you write a single +generator function instead of defining a new class. The generator should yield +exactly one value. The code up to the yield will be executed as the +__enter__() method, and the value yielded will be the method’s return +value that will get bound to the variable in the ‘with’ statement’s +as clause, if any. The code after the yield will be +executed in the __exit__() method. Any exception raised in the block will +be raised by the yield statement.

    +

    Using this decorator, our database example from the previous section +could be written as:

    +
    from contextlib import contextmanager
    +
    +@contextmanager
    +def db_transaction(connection):
    +    cursor = connection.cursor()
    +    try:
    +        yield cursor
    +    except:
    +        connection.rollback()
    +        raise
    +    else:
    +        connection.commit()
    +
    +db = DatabaseConnection()
    +with db_transaction(db) as cursor:
    +    ...
    +
    +
    +

    The contextlib module also has a nested(mgr1, mgr2, ...) function +that combines a number of context managers so you don’t need to write nested +‘with’ statements. In this example, the single ‘with’ +statement both starts a database transaction and acquires a thread lock:

    +
    lock = threading.Lock()
    +with nested (db_transaction(db), lock) as (cursor, locked):
    +    ...
    +
    +
    +

    Finally, the closing() function returns its argument so that it can be +bound to a variable, and calls the argument’s .close() method at the end +of the block.

    +
    import urllib, sys
    +from contextlib import closing
    +
    +with closing(urllib.urlopen('http://www.yahoo.com')) as f:
    +    for line in f:
    +        sys.stdout.write(line)
    +
    +
    +
    +

    See also

    +
    +
    PEP 343 - The “with” statement

    PEP written by Guido van Rossum and Nick Coghlan; implemented by Mike Bland, +Guido van Rossum, and Neal Norwitz. The PEP shows the code generated for a +‘with’ statement, which can be helpful in learning how the statement +works.

    +
    +
    +

    The documentation for the contextlib module.

    +
    +
    +
    +
    +

    PEP 366: Explicit Relative Imports From a Main Module

    +

    Python’s -m switch allows running a module as a script. +When you ran a module that was located inside a package, relative +imports didn’t work correctly.

    +

    The fix for Python 2.6 adds a __package__ attribute to +modules. When this attribute is present, relative imports will be +relative to the value of this attribute instead of the +__name__ attribute.

    +

    PEP 302-style importers can then set __package__ as necessary. +The runpy module that implements the -m switch now +does this, so relative imports will now work correctly in scripts +running from inside a package.

    +
    +
    +

    PEP 370: Per-user site-packages Directory

    +

    When you run Python, the module search path sys.path usually +includes a directory whose path ends in "site-packages". This +directory is intended to hold locally-installed packages available to +all users using a machine or a particular site installation.

    +

    Python 2.6 introduces a convention for user-specific site directories. +The directory varies depending on the platform:

    +
      +
    • Unix and Mac OS X: ~/.local/

    • +
    • Windows: %APPDATA%/Python

    • +
    +

    Within this directory, there will be version-specific subdirectories, +such as lib/python2.6/site-packages on Unix/Mac OS and +Python26/site-packages on Windows.

    +

    If you don’t like the default directory, it can be overridden by an +environment variable. PYTHONUSERBASE sets the root +directory used for all Python versions supporting this feature. On +Windows, the directory for application-specific data can be changed by +setting the APPDATA environment variable. You can also +modify the site.py file for your Python installation.

    +

    The feature can be disabled entirely by running Python with the +-s option or setting the PYTHONNOUSERSITE +environment variable.

    +
    +

    See also

    +
    +
    PEP 370 - Per-user site-packages Directory

    PEP written and implemented by Christian Heimes.

    +
    +
    +
    +
    +
    +

    PEP 371: The multiprocessing Package

    +

    The new multiprocessing package lets Python programs create new +processes that will perform a computation and return a result to the +parent. The parent and child processes can communicate using queues +and pipes, synchronize their operations using locks and semaphores, +and can share simple arrays of data.

    +

    The multiprocessing module started out as an exact emulation of +the threading module using processes instead of threads. That +goal was discarded along the path to Python 2.6, but the general +approach of the module is still similar. The fundamental class +is the Process, which is passed a callable object and +a collection of arguments. The start() method +sets the callable running in a subprocess, after which you can call +the is_alive() method to check whether the subprocess is still running +and the join() method to wait for the process to exit.

    +

    Here’s a simple example where the subprocess will calculate a +factorial. The function doing the calculation is written strangely so +that it takes significantly longer when the input argument is a +multiple of 4.

    +
    import time
    +from multiprocessing import Process, Queue
    +
    +
    +def factorial(queue, N):
    +    "Compute a factorial."
    +    # If N is a multiple of 4, this function will take much longer.
    +    if (N % 4) == 0:
    +        time.sleep(.05 * N/4)
    +
    +    # Calculate the result
    +    fact = 1L
    +    for i in range(1, N+1):
    +        fact = fact * i
    +
    +    # Put the result on the queue
    +    queue.put(fact)
    +
    +if __name__ == '__main__':
    +    queue = Queue()
    +
    +    N = 5
    +
    +    p = Process(target=factorial, args=(queue, N))
    +    p.start()
    +    p.join()
    +
    +    result = queue.get()
    +    print 'Factorial', N, '=', result
    +
    +
    +

    A Queue is used to communicate the result of the factorial. +The Queue object is stored in a global variable. +The child process will use the value of the variable when the child +was created; because it’s a Queue, parent and child can use +the object to communicate. (If the parent were to change the value of +the global variable, the child’s value would be unaffected, and vice +versa.)

    +

    Two other classes, Pool and Manager, provide +higher-level interfaces. Pool will create a fixed number of +worker processes, and requests can then be distributed to the workers +by calling apply() or apply_async() to add a single request, +and map() or map_async() to add a number of +requests. The following code uses a Pool to spread requests +across 5 worker processes and retrieve a list of results:

    +
    from multiprocessing import Pool
    +
    +def factorial(N, dictionary):
    +    "Compute a factorial."
    +    ...
    +p = Pool(5)
    +result = p.map(factorial, range(1, 1000, 10))
    +for v in result:
    +    print v
    +
    +
    +

    This produces the following output:

    +
    1
    +39916800
    +51090942171709440000
    +8222838654177922817725562880000000
    +33452526613163807108170062053440751665152000000000
    +...
    +
    +
    +

    The other high-level interface, the Manager class, creates a +separate server process that can hold master copies of Python data +structures. Other processes can then access and modify these data +structures using proxy objects. The following example creates a +shared dictionary by calling the dict() method; the worker +processes then insert values into the dictionary. (Locking is not +done for you automatically, which doesn’t matter in this example. +Manager’s methods also include Lock(), RLock(), +and Semaphore() to create shared locks.)

    +
    import time
    +from multiprocessing import Pool, Manager
    +
    +def factorial(N, dictionary):
    +    "Compute a factorial."
    +    # Calculate the result
    +    fact = 1L
    +    for i in range(1, N+1):
    +        fact = fact * i
    +
    +    # Store result in dictionary
    +    dictionary[N] = fact
    +
    +if __name__ == '__main__':
    +    p = Pool(5)
    +    mgr = Manager()
    +    d = mgr.dict()         # Create shared dictionary
    +
    +    # Run tasks using the pool
    +    for N in range(1, 1000, 10):
    +        p.apply_async(factorial, (N, d))
    +
    +    # Mark pool as closed -- no more tasks can be added.
    +    p.close()
    +
    +    # Wait for tasks to exit
    +    p.join()
    +
    +    # Output results
    +    for k, v in sorted(d.items()):
    +        print k, v
    +
    +
    +

    This will produce the output:

    +
    1 1
    +11 39916800
    +21 51090942171709440000
    +31 8222838654177922817725562880000000
    +41 33452526613163807108170062053440751665152000000000
    +51 15511187532873822802242430164693032110632597200169861120000...
    +
    +
    +
    +

    See also

    +

    The documentation for the multiprocessing module.

    +
    +
    PEP 371 - Addition of the multiprocessing package

    PEP written by Jesse Noller and Richard Oudkerk; +implemented by Richard Oudkerk and Jesse Noller.

    +
    +
    +
    +
    +
    +

    PEP 3101: Advanced String Formatting

    +

    In Python 3.0, the % operator is supplemented by a more powerful string +formatting method, format(). Support for the str.format() method +has been backported to Python 2.6.

    +

    In 2.6, both 8-bit and Unicode strings have a .format() method that +treats the string as a template and takes the arguments to be formatted. +The formatting template uses curly brackets ({, }) as special characters:

    +
    >>> # Substitute positional argument 0 into the string.
    +>>> "User ID: {0}".format("root")
    +'User ID: root'
    +>>> # Use the named keyword arguments
    +>>> "User ID: {uid}   Last seen: {last_login}".format(
    +...    uid="root",
    +...    last_login = "5 Mar 2008 07:20")
    +'User ID: root   Last seen: 5 Mar 2008 07:20'
    +
    +
    +

    Curly brackets can be escaped by doubling them:

    +
    >>> "Empty dict: {{}}".format()
    +"Empty dict: {}"
    +
    +
    +

    Field names can be integers indicating positional arguments, such as +{0}, {1}, etc. or names of keyword arguments. You can also +supply compound field names that read attributes or access dictionary keys:

    +
    >>> import sys
    +>>> print 'Platform: {0.platform}\nPython version: {0.version}'.format(sys)
    +Platform: darwin
    +Python version: 2.6a1+ (trunk:61261M, Mar  5 2008, 20:29:41)
    +[GCC 4.0.1 (Apple Computer, Inc. build 5367)]'
    +
    +>>> import mimetypes
    +>>> 'Content-type: {0[.mp4]}'.format(mimetypes.types_map)
    +'Content-type: video/mp4'
    +
    +
    +

    Note that when using dictionary-style notation such as [.mp4], you +don’t need to put any quotation marks around the string; it will look +up the value using .mp4 as the key. Strings beginning with a +number will be converted to an integer. You can’t write more +complicated expressions inside a format string.

    +

    So far we’ve shown how to specify which field to substitute into the +resulting string. The precise formatting used is also controllable by +adding a colon followed by a format specifier. For example:

    +
    >>> # Field 0: left justify, pad to 15 characters
    +>>> # Field 1: right justify, pad to 6 characters
    +>>> fmt = '{0:15} ${1:>6}'
    +>>> fmt.format('Registration', 35)
    +'Registration    $    35'
    +>>> fmt.format('Tutorial', 50)
    +'Tutorial        $    50'
    +>>> fmt.format('Banquet', 125)
    +'Banquet         $   125'
    +
    +
    +

    Format specifiers can reference other fields through nesting:

    +
    >>> fmt = '{0:{1}}'
    +>>> width = 15
    +>>> fmt.format('Invoice #1234', width)
    +'Invoice #1234  '
    +>>> width = 35
    +>>> fmt.format('Invoice #1234', width)
    +'Invoice #1234                      '
    +
    +
    +

    The alignment of a field within the desired width can be specified:

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Character

    Effect

    < (default)

    Left-align

    >

    Right-align

    ^

    Center

    =

    (For numeric types only) Pad after the sign.

    +

    Format specifiers can also include a presentation type, which +controls how the value is formatted. For example, floating-point numbers +can be formatted as a general number or in exponential notation:

    +
    >>> '{0:g}'.format(3.75)
    +'3.75'
    +>>> '{0:e}'.format(3.75)
    +'3.750000e+00'
    +
    +
    +

    A variety of presentation types are available. Consult the 2.6 +documentation for a complete list; here’s a sample:

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    b

    Binary. Outputs the number in base 2.

    c

    Character. Converts the integer to the corresponding Unicode character +before printing.

    d

    Decimal Integer. Outputs the number in base 10.

    o

    Octal format. Outputs the number in base 8.

    x

    Hex format. Outputs the number in base 16, using lower-case letters for +the digits above 9.

    e

    Exponent notation. Prints the number in scientific notation using the +letter ‘e’ to indicate the exponent.

    g

    General format. This prints the number as a fixed-point number, unless +the number is too large, in which case it switches to ‘e’ exponent +notation.

    n

    Number. This is the same as ‘g’ (for floats) or ‘d’ (for integers), +except that it uses the current locale setting to insert the appropriate +number separator characters.

    %

    Percentage. Multiplies the number by 100 and displays in fixed (‘f’) +format, followed by a percent sign.

    +

    Classes and types can define a __format__() method to control how they’re +formatted. It receives a single argument, the format specifier:

    +
    def __format__(self, format_spec):
    +    if isinstance(format_spec, unicode):
    +        return unicode(str(self))
    +    else:
    +        return str(self)
    +
    +
    +

    There’s also a format() builtin that will format a single +value. It calls the type’s __format__() method with the +provided specifier:

    +
    >>> format(75.6564, '.2f')
    +'75.66'
    +
    +
    +
    +

    See also

    +
    +
    Format String Syntax

    The reference documentation for format fields.

    +
    +
    PEP 3101 - Advanced String Formatting

    PEP written by Talin. Implemented by Eric Smith.

    +
    +
    +
    +
    +
    +

    PEP 3105: print As a Function

    +

    The print statement becomes the print() function in Python 3.0. +Making print() a function makes it possible to replace the function +by doing def print(...) or importing a new function from somewhere else.

    +

    Python 2.6 has a __future__ import that removes print as language +syntax, letting you use the functional form instead. For example:

    +
    >>> from __future__ import print_function
    +>>> print('# of entries', len(dictionary), file=sys.stderr)
    +
    +
    +

    The signature of the new function is:

    +
    def print(*args, sep=' ', end='\n', file=None)
    +
    +
    +

    The parameters are:

    +
    +
      +
    • args: positional arguments whose values will be printed out.

    • +
    • sep: the separator, which will be printed between arguments.

    • +
    • end: the ending text, which will be printed after all of the +arguments have been output.

    • +
    • file: the file object to which the output will be sent.

    • +
    +
    +
    +

    See also

    +
    +
    PEP 3105 - Make print a function

    PEP written by Georg Brandl.

    +
    +
    +
    +
    +
    +

    PEP 3110: Exception-Handling Changes

    +

    One error that Python programmers occasionally make +is writing the following code:

    +
    try:
    +    ...
    +except TypeError, ValueError:  # Wrong!
    +    ...
    +
    +
    +

    The author is probably trying to catch both TypeError and +ValueError exceptions, but this code actually does something +different: it will catch TypeError and bind the resulting +exception object to the local name "ValueError". The +ValueError exception will not be caught at all. The correct +code specifies a tuple of exceptions:

    +
    try:
    +    ...
    +except (TypeError, ValueError):
    +    ...
    +
    +
    +

    This error happens because the use of the comma here is ambiguous: +does it indicate two different nodes in the parse tree, or a single +node that’s a tuple?

    +

    Python 3.0 makes this unambiguous by replacing the comma with the word +“as”. To catch an exception and store the exception object in the +variable exc, you must write:

    +
    try:
    +    ...
    +except TypeError as exc:
    +    ...
    +
    +
    +

    Python 3.0 will only support the use of “as”, and therefore interprets +the first example as catching two different exceptions. Python 2.6 +supports both the comma and “as”, so existing code will continue to +work. We therefore suggest using “as” when writing new Python code +that will only be executed with 2.6.

    +
    +

    See also

    +
    +
    PEP 3110 - Catching Exceptions in Python 3000

    PEP written and implemented by Collin Winter.

    +
    +
    +
    +
    +
    +

    PEP 3112: Byte Literals

    +

    Python 3.0 adopts Unicode as the language’s fundamental string type and +denotes 8-bit literals differently, either as b'string' +or using a bytes constructor. For future compatibility, +Python 2.6 adds bytes as a synonym for the str type, +and it also supports the b'' notation.

    +

    The 2.6 str differs from 3.0’s bytes type in various +ways; most notably, the constructor is completely different. In 3.0, +bytes([65, 66, 67]) is 3 elements long, containing the bytes +representing ABC; in 2.6, bytes([65, 66, 67]) returns the +12-byte string representing the str() of the list.

    +

    The primary use of bytes in 2.6 will be to write tests of +object type such as isinstance(x, bytes). This will help the 2to3 +converter, which can’t tell whether 2.x code intends strings to +contain either characters or 8-bit bytes; you can now +use either bytes or str to represent your intention +exactly, and the resulting code will also be correct in Python 3.0.

    +

    There’s also a __future__ import that causes all string literals +to become Unicode strings. This means that \u escape sequences +can be used to include Unicode characters:

    +
    from __future__ import unicode_literals
    +
    +s = ('\u751f\u3080\u304e\u3000\u751f\u3054'
    +     '\u3081\u3000\u751f\u305f\u307e\u3054')
    +
    +print len(s)               # 12 Unicode characters
    +
    +
    +

    At the C level, Python 3.0 will rename the existing 8-bit +string type, called PyStringObject in Python 2.x, +to PyBytesObject. Python 2.6 uses #define +to support using the names PyBytesObject(), +PyBytes_Check(), PyBytes_FromStringAndSize(), +and all the other functions and macros used with strings.

    +

    Instances of the bytes type are immutable just +as strings are. A new bytearray type stores a mutable +sequence of bytes:

    +
    >>> bytearray([65, 66, 67])
    +bytearray(b'ABC')
    +>>> b = bytearray(u'\u21ef\u3244', 'utf-8')
    +>>> b
    +bytearray(b'\xe2\x87\xaf\xe3\x89\x84')
    +>>> b[0] = '\xe3'
    +>>> b
    +bytearray(b'\xe3\x87\xaf\xe3\x89\x84')
    +>>> unicode(str(b), 'utf-8')
    +u'\u31ef \u3244'
    +
    +
    +

    Byte arrays support most of the methods of string types, such as +startswith()/endswith(), find()/rfind(), +and some of the methods of lists, such as append(), +pop(), and reverse().

    +
    >>> b = bytearray('ABC')
    +>>> b.append('d')
    +>>> b.append(ord('e'))
    +>>> b
    +bytearray(b'ABCde')
    +
    +
    +

    There’s also a corresponding C API, with +PyByteArray_FromObject(), +PyByteArray_FromStringAndSize(), +and various other functions.

    +
    +

    See also

    +
    +
    PEP 3112 - Bytes literals in Python 3000

    PEP written by Jason Orendorff; backported to 2.6 by Christian Heimes.

    +
    +
    +
    +
    +
    +

    PEP 3116: New I/O Library

    +

    Python’s built-in file objects support a number of methods, but +file-like objects don’t necessarily support all of them. Objects that +imitate files usually support read() and write(), but they +may not support readline(), for example. Python 3.0 introduces +a layered I/O library in the io module that separates buffering +and text-handling features from the fundamental read and write +operations.

    +

    There are three levels of abstract base classes provided by +the io module:

    +
      +
    • RawIOBase defines raw I/O operations: read(), +readinto(), +write(), seek(), tell(), truncate(), +and close(). +Most of the methods of this class will often map to a single system call. +There are also readable(), writable(), and seekable() +methods for determining what operations a given object will allow.

      +

      Python 3.0 has concrete implementations of this class for files and +sockets, but Python 2.6 hasn’t restructured its file and socket objects +in this way.

      +
    • +
    • BufferedIOBase is an abstract base class that +buffers data in memory to reduce the number of +system calls used, making I/O processing more efficient. +It supports all of the methods of RawIOBase, +and adds a raw attribute holding the underlying raw object.

      +

      There are five concrete classes implementing this ABC. +BufferedWriter and BufferedReader are for objects +that support write-only or read-only usage that have a seek() +method for random access. BufferedRandom objects support +read and write access upon the same underlying stream, and +BufferedRWPair is for objects such as TTYs that have both +read and write operations acting upon unconnected streams of data. +The BytesIO class supports reading, writing, and seeking +over an in-memory buffer.

      +
    • +
    • TextIOBase: Provides functions for reading and writing +strings (remember, strings will be Unicode in Python 3.0), +and supporting universal newlines. TextIOBase defines +the readline() method and supports iteration upon +objects.

      +

      There are two concrete implementations. TextIOWrapper +wraps a buffered I/O object, supporting all of the methods for +text I/O and adding a buffer attribute for access +to the underlying object. StringIO simply buffers +everything in memory without ever writing anything to disk.

      +

      (In Python 2.6, io.StringIO is implemented in +pure Python, so it’s pretty slow. You should therefore stick with the +existing StringIO module or cStringIO for now. At some +point Python 3.0’s io module will be rewritten into C for speed, +and perhaps the C implementation will be backported to the 2.x releases.)

      +
    • +
    +

    In Python 2.6, the underlying implementations haven’t been +restructured to build on top of the io module’s classes. The +module is being provided to make it easier to write code that’s +forward-compatible with 3.0, and to save developers the effort of writing +their own implementations of buffering and text I/O.

    +
    +

    See also

    +
    +
    PEP 3116 - New I/O

    PEP written by Daniel Stutzbach, Mike Verdone, and Guido van Rossum. +Code by Guido van Rossum, Georg Brandl, Walter Doerwald, +Jeremy Hylton, Martin von Löwis, Tony Lownds, and others.

    +
    +
    +
    +
    +
    +

    PEP 3118: Revised Buffer Protocol

    +

    The buffer protocol is a C-level API that lets Python types +exchange pointers into their internal representations. A +memory-mapped file can be viewed as a buffer of characters, for +example, and this lets another module such as re +treat memory-mapped files as a string of characters to be searched.

    +

    The primary users of the buffer protocol are numeric-processing +packages such as NumPy, which expose the internal representation +of arrays so that callers can write data directly into an array instead +of going through a slower API. This PEP updates the buffer protocol in light of experience +from NumPy development, adding a number of new features +such as indicating the shape of an array or locking a memory region.

    +

    The most important new C API function is +PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags), which +takes an object and a set of flags, and fills in the +Py_buffer structure with information +about the object’s memory representation. Objects +can use this operation to lock memory in place +while an external caller could be modifying the contents, +so there’s a corresponding PyBuffer_Release(Py_buffer *view) to +indicate that the external caller is done.

    +

    The flags argument to PyObject_GetBuffer() specifies +constraints upon the memory returned. Some examples are:

    +
    +
      +
    • PyBUF_WRITABLE indicates that the memory must be writable.

    • +
    • PyBUF_LOCK requests a read-only or exclusive lock on the memory.

    • +
    • PyBUF_C_CONTIGUOUS and PyBUF_F_CONTIGUOUS +requests a C-contiguous (last dimension varies the fastest) or +Fortran-contiguous (first dimension varies the fastest) array layout.

    • +
    +
    +

    Two new argument codes for PyArg_ParseTuple(), +s* and z*, return locked buffer objects for a parameter.

    +
    +

    See also

    +
    +
    PEP 3118 - Revising the buffer protocol

    PEP written by Travis Oliphant and Carl Banks; implemented by +Travis Oliphant.

    +
    +
    +
    +
    +
    +

    PEP 3119: Abstract Base Classes

    +

    Some object-oriented languages such as Java support interfaces, +declaring that a class has a given set of methods or supports a given +access protocol. Abstract Base Classes (or ABCs) are an equivalent +feature for Python. The ABC support consists of an abc module +containing a metaclass called ABCMeta, special handling of +this metaclass by the isinstance() and issubclass() +builtins, and a collection of basic ABCs that the Python developers +think will be widely useful. Future versions of Python will probably +add more ABCs.

    +

    Let’s say you have a particular class and wish to know whether it supports +dictionary-style access. The phrase “dictionary-style” is vague, however. +It probably means that accessing items with obj[1] works. +Does it imply that setting items with obj[2] = value works? +Or that the object will have keys(), values(), and items() +methods? What about the iterative variants such as iterkeys()? copy() +and update()? Iterating over the object with iter()?

    +

    The Python 2.6 collections module includes a number of +different ABCs that represent these distinctions. Iterable +indicates that a class defines __iter__(), and +Container means the class defines a __contains__() +method and therefore supports x in y expressions. The basic +dictionary interface of getting items, setting items, and +keys(), values(), and items(), is defined by the +MutableMapping ABC.

    +

    You can derive your own classes from a particular ABC +to indicate they support that ABC’s interface:

    +
    import collections
    +
    +class Storage(collections.MutableMapping):
    +    ...
    +
    +
    +

    Alternatively, you could write the class without deriving from +the desired ABC and instead register the class by +calling the ABC’s register() method:

    +
    import collections
    +
    +class Storage:
    +    ...
    +
    +collections.MutableMapping.register(Storage)
    +
    +
    +

    For classes that you write, deriving from the ABC is probably clearer. +The register() method is useful when you’ve written a new +ABC that can describe an existing type or class, or if you want +to declare that some third-party class implements an ABC. +For example, if you defined a PrintableType ABC, +it’s legal to do:

    +
    # Register Python's types
    +PrintableType.register(int)
    +PrintableType.register(float)
    +PrintableType.register(str)
    +
    +
    +

    Classes should obey the semantics specified by an ABC, but +Python can’t check this; it’s up to the class author to +understand the ABC’s requirements and to implement the code accordingly.

    +

    To check whether an object supports a particular interface, you can +now write:

    +
    def func(d):
    +    if not isinstance(d, collections.MutableMapping):
    +        raise ValueError("Mapping object expected, not %r" % d)
    +
    +
    +

    Don’t feel that you must now begin writing lots of checks as in the +above example. Python has a strong tradition of duck-typing, where +explicit type-checking is never done and code simply calls methods on +an object, trusting that those methods will be there and raising an +exception if they aren’t. Be judicious in checking for ABCs and only +do it where it’s absolutely necessary.

    +

    You can write your own ABCs by using abc.ABCMeta as the +metaclass in a class definition:

    +
    from abc import ABCMeta, abstractmethod
    +
    +class Drawable():
    +    __metaclass__ = ABCMeta
    +
    +    @abstractmethod
    +    def draw(self, x, y, scale=1.0):
    +        pass
    +
    +    def draw_doubled(self, x, y):
    +        self.draw(x, y, scale=2.0)
    +
    +
    +class Square(Drawable):
    +    def draw(self, x, y, scale):
    +        ...
    +
    +
    +

    In the Drawable ABC above, the draw_doubled() method +renders the object at twice its size and can be implemented in terms +of other methods described in Drawable. Classes implementing +this ABC therefore don’t need to provide their own implementation +of draw_doubled(), though they can do so. An implementation +of draw() is necessary, though; the ABC can’t provide +a useful generic implementation.

    +

    You can apply the @abstractmethod decorator to methods such as +draw() that must be implemented; Python will then raise an +exception for classes that don’t define the method. +Note that the exception is only raised when you actually +try to create an instance of a subclass lacking the method:

    +
    >>> class Circle(Drawable):
    +...     pass
    +...
    +>>> c = Circle()
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +TypeError: Can't instantiate abstract class Circle with abstract methods draw
    +>>>
    +
    +
    +

    Abstract data attributes can be declared using the +@abstractproperty decorator:

    +
    from abc import abstractproperty
    +...
    +
    +@abstractproperty
    +def readonly(self):
    +   return self._x
    +
    +
    +

    Subclasses must then define a readonly() property.

    +
    +

    See also

    +
    +
    PEP 3119 - Introducing Abstract Base Classes

    PEP written by Guido van Rossum and Talin. +Implemented by Guido van Rossum. +Backported to 2.6 by Benjamin Aranguren, with Alex Martelli.

    +
    +
    +
    +
    +
    +

    PEP 3127: Integer Literal Support and Syntax

    +

    Python 3.0 changes the syntax for octal (base-8) integer literals, +prefixing them with “0o” or “0O” instead of a leading zero, and adds +support for binary (base-2) integer literals, signalled by a “0b” or +“0B” prefix.

    +

    Python 2.6 doesn’t drop support for a leading 0 signalling +an octal number, but it does add support for “0o” and “0b”:

    +
    >>> 0o21, 2*8 + 1
    +(17, 17)
    +>>> 0b101111
    +47
    +
    +
    +

    The oct() builtin still returns numbers +prefixed with a leading zero, and a new bin() +builtin returns the binary representation for a number:

    +
    >>> oct(42)
    +'052'
    +>>> future_builtins.oct(42)
    +'0o52'
    +>>> bin(173)
    +'0b10101101'
    +
    +
    +

    The int() and long() builtins will now accept the “0o” +and “0b” prefixes when base-8 or base-2 are requested, or when the +base argument is zero (signalling that the base used should be +determined from the string):

    +
    >>> int ('0o52', 0)
    +42
    +>>> int('1101', 2)
    +13
    +>>> int('0b1101', 2)
    +13
    +>>> int('0b1101', 0)
    +13
    +
    +
    +
    +

    See also

    +
    +
    PEP 3127 - Integer Literal Support and Syntax

    PEP written by Patrick Maupin; backported to 2.6 by +Eric Smith.

    +
    +
    +
    +
    +
    +

    PEP 3129: Class Decorators

    +

    Decorators have been extended from functions to classes. It’s now legal to +write:

    +
    @foo
    +@bar
    +class A:
    +  pass
    +
    +
    +

    This is equivalent to:

    +
    class A:
    +  pass
    +
    +A = foo(bar(A))
    +
    +
    +
    +

    See also

    +
    +
    PEP 3129 - Class Decorators

    PEP written by Collin Winter.

    +
    +
    +
    +
    +
    +

    PEP 3141: A Type Hierarchy for Numbers

    +

    Python 3.0 adds several abstract base classes for numeric types +inspired by Scheme’s numeric tower. These classes were backported to +2.6 as the numbers module.

    +

    The most general ABC is Number. It defines no operations at +all, and only exists to allow checking if an object is a number by +doing isinstance(obj, Number).

    +

    Complex is a subclass of Number. Complex numbers +can undergo the basic operations of addition, subtraction, +multiplication, division, and exponentiation, and you can retrieve the +real and imaginary parts and obtain a number’s conjugate. Python’s built-in +complex type is an implementation of Complex.

    +

    Real further derives from Complex, and adds +operations that only work on real numbers: floor(), trunc(), +rounding, taking the remainder mod N, floor division, +and comparisons.

    +

    Rational numbers derive from Real, have +numerator and denominator properties, and can be +converted to floats. Python 2.6 adds a simple rational-number class, +Fraction, in the fractions module. (It’s called +Fraction instead of Rational to avoid +a name clash with numbers.Rational.)

    +

    Integral numbers derive from Rational, and +can be shifted left and right with << and >>, +combined using bitwise operations such as & and |, +and can be used as array indexes and slice boundaries.

    +

    In Python 3.0, the PEP slightly redefines the existing builtins +round(), math.floor(), math.ceil(), and adds a new +one, math.trunc(), that’s been backported to Python 2.6. +math.trunc() rounds toward zero, returning the closest +Integral that’s between the function’s argument and zero.

    +
    +

    See also

    +
    +
    PEP 3141 - A Type Hierarchy for Numbers

    PEP written by Jeffrey Yasskin.

    +
    +
    +

    Scheme’s numerical tower, from the Guile manual.

    +

    Scheme’s number datatypes from the R5RS Scheme specification.

    +
    +
    +

    The fractions Module

    +

    To fill out the hierarchy of numeric types, the fractions +module provides a rational-number class. Rational numbers store their +values as a numerator and denominator forming a fraction, and can +exactly represent numbers such as 2/3 that floating-point numbers +can only approximate.

    +

    The Fraction constructor takes two Integral values +that will be the numerator and denominator of the resulting fraction.

    +
    >>> from fractions import Fraction
    +>>> a = Fraction(2, 3)
    +>>> b = Fraction(2, 5)
    +>>> float(a), float(b)
    +(0.66666666666666663, 0.40000000000000002)
    +>>> a+b
    +Fraction(16, 15)
    +>>> a/b
    +Fraction(5, 3)
    +
    +
    +

    For converting floating-point numbers to rationals, +the float type now has an as_integer_ratio() method that returns +the numerator and denominator for a fraction that evaluates to the same +floating-point value:

    +
    >>> (2.5) .as_integer_ratio()
    +(5, 2)
    +>>> (3.1415) .as_integer_ratio()
    +(7074029114692207L, 2251799813685248L)
    +>>> (1./3) .as_integer_ratio()
    +(6004799503160661L, 18014398509481984L)
    +
    +
    +

    Note that values that can only be approximated by floating-point +numbers, such as 1./3, are not simplified to the number being +approximated; the fraction attempts to match the floating-point value +exactly.

    +

    The fractions module is based upon an implementation by Sjoerd +Mullender that was in Python’s Demo/classes/ directory for a +long time. This implementation was significantly updated by Jeffrey +Yasskin.

    +
    +
    +
    +

    Other Language Changes

    +

    Some smaller changes made to the core Python language are:

    +
      +
    • Directories and zip archives containing a __main__.py file +can now be executed directly by passing their name to the +interpreter. The directory or zip archive is automatically inserted +as the first entry in sys.path. (Suggestion and initial patch by +Andy Chu, subsequently revised by Phillip J. Eby and Nick Coghlan; +bpo-1739468.)

    • +
    • The hasattr() function was catching and ignoring all errors, +under the assumption that they meant a __getattr__() method +was failing somehow and the return value of hasattr() would +therefore be False. This logic shouldn’t be applied to +KeyboardInterrupt and SystemExit, however; Python 2.6 +will no longer discard such exceptions when hasattr() +encounters them. (Fixed by Benjamin Peterson; bpo-2196.)

    • +
    • When calling a function using the ** syntax to provide keyword +arguments, you are no longer required to use a Python dictionary; +any mapping will now work:

      +
      >>> def f(**kw):
      +...    print sorted(kw)
      +...
      +>>> ud=UserDict.UserDict()
      +>>> ud['a'] = 1
      +>>> ud['b'] = 'string'
      +>>> f(**ud)
      +['a', 'b']
      +
      +
      +

      (Contributed by Alexander Belopolsky; bpo-1686487.)

      +

      It’s also become legal to provide keyword arguments after a *args argument +to a function call.

      +
      >>> def f(*args, **kw):
      +...     print args, kw
      +...
      +>>> f(1,2,3, *(4,5,6), keyword=13)
      +(1, 2, 3, 4, 5, 6) {'keyword': 13}
      +
      +
      +

      Previously this would have been a syntax error. +(Contributed by Amaury Forgeot d’Arc; bpo-3473.)

      +
    • +
    • A new builtin, next(iterator, [default]) returns the next item +from the specified iterator. If the default argument is supplied, +it will be returned if iterator has been exhausted; otherwise, +the StopIteration exception will be raised. (Backported +in bpo-2719.)

    • +
    • Tuples now have index() and count() methods matching the +list type’s index() and count() methods:

      +
      >>> t = (0,1,2,3,4,0,1,2)
      +>>> t.index(3)
      +3
      +>>> t.count(0)
      +2
      +
      +
      +

      (Contributed by Raymond Hettinger)

      +
    • +
    • The built-in types now have improved support for extended slicing syntax, +accepting various combinations of (start, stop, step). +Previously, the support was partial and certain corner cases wouldn’t work. +(Implemented by Thomas Wouters.)

      +
    • +
    • Properties now have three attributes, getter, setter +and deleter, that are decorators providing useful shortcuts +for adding a getter, setter or deleter function to an existing +property. You would use them like this:

      +
      class C(object):
      +    @property
      +    def x(self):
      +        return self._x
      +
      +    @x.setter
      +    def x(self, value):
      +        self._x = value
      +
      +    @x.deleter
      +    def x(self):
      +        del self._x
      +
      +class D(C):
      +    @C.x.getter
      +    def x(self):
      +        return self._x * 2
      +
      +    @x.setter
      +    def x(self, value):
      +        self._x = value / 2
      +
      +
      +
    • +
    • Several methods of the built-in set types now accept multiple iterables: +intersection(), +intersection_update(), +union(), update(), +difference() and difference_update().

      +
      >>> s=set('1234567890')
      +>>> s.intersection('abc123', 'cdf246')  # Intersection between all inputs
      +set(['2'])
      +>>> s.difference('246', '789')
      +set(['1', '0', '3', '5'])
      +
      +
      +

      (Contributed by Raymond Hettinger.)

      +
    • +
    • Many floating-point features were added. The float() function +will now turn the string nan into an +IEEE 754 Not A Number value, and +inf and -inf into +positive or negative infinity. This works on any platform with +IEEE 754 semantics. (Contributed by Christian Heimes; bpo-1635.)

      +

      Other functions in the math module, isinf() and +isnan(), return true if their floating-point argument is +infinite or Not A Number. (bpo-1640)

      +

      Conversion functions were added to convert floating-point numbers +into hexadecimal strings (bpo-3008). These functions +convert floats to and from a string representation without +introducing rounding errors from the conversion between decimal and +binary. Floats have a hex() method that returns a string +representation, and the float.fromhex() method converts a string +back into a number:

      +
      >>> a = 3.75
      +>>> a.hex()
      +'0x1.e000000000000p+1'
      +>>> float.fromhex('0x1.e000000000000p+1')
      +3.75
      +>>> b=1./3
      +>>> b.hex()
      +'0x1.5555555555555p-2'
      +
      +
      +
    • +
    • A numerical nicety: when creating a complex number from two floats +on systems that support signed zeros (-0 and +0), the +complex() constructor will now preserve the sign +of the zero. (Fixed by Mark T. Dickinson; bpo-1507.)

    • +
    • Classes that inherit a __hash__() method from a parent class +can set __hash__ = None to indicate that the class isn’t +hashable. This will make hash(obj) raise a TypeError +and the class will not be indicated as implementing the +Hashable ABC.

      +

      You should do this when you’ve defined a __cmp__() or +__eq__() method that compares objects by their value rather +than by identity. All objects have a default hash method that uses +id(obj) as the hash value. There’s no tidy way to remove the +__hash__() method inherited from a parent class, so +assigning None was implemented as an override. At the +C level, extensions can set tp_hash to +PyObject_HashNotImplemented(). +(Fixed by Nick Coghlan and Amaury Forgeot d’Arc; bpo-2235.)

      +
    • +
    • The GeneratorExit exception now subclasses +BaseException instead of Exception. This means +that an exception handler that does except Exception: +will not inadvertently catch GeneratorExit. +(Contributed by Chad Austin; bpo-1537.)

    • +
    • Generator objects now have a gi_code attribute that refers to +the original code object backing the generator. +(Contributed by Collin Winter; bpo-1473257.)

    • +
    • The compile() built-in function now accepts keyword arguments +as well as positional parameters. (Contributed by Thomas Wouters; +bpo-1444529.)

    • +
    • The complex() constructor now accepts strings containing +parenthesized complex numbers, meaning that complex(repr(cplx)) +will now round-trip values. For example, complex('(3+4j)') +now returns the value (3+4j). (bpo-1491866)

    • +
    • The string translate() method now accepts None as the +translation table parameter, which is treated as the identity +transformation. This makes it easier to carry out operations +that only delete characters. (Contributed by Bengt Richter and +implemented by Raymond Hettinger; bpo-1193128.)

    • +
    • The built-in dir() function now checks for a __dir__() +method on the objects it receives. This method must return a list +of strings containing the names of valid attributes for the object, +and lets the object control the value that dir() produces. +Objects that have __getattr__() or __getattribute__() +methods can use this to advertise pseudo-attributes they will honor. +(bpo-1591665)

    • +
    • Instance method objects have new attributes for the object and function +comprising the method; the new synonym for im_self is +__self__, and im_func is also available as __func__. +The old names are still supported in Python 2.6, but are gone in 3.0.

    • +
    • An obscure change: when you use the locals() function inside a +class statement, the resulting dictionary no longer returns free +variables. (Free variables, in this case, are variables referenced in the +class statement that aren’t attributes of the class.)

    • +
    +
    +

    Optimizations

    +
      +
    • The warnings module has been rewritten in C. This makes +it possible to invoke warnings from the parser, and may also +make the interpreter’s startup faster. +(Contributed by Neal Norwitz and Brett Cannon; bpo-1631171.)

    • +
    • Type objects now have a cache of methods that can reduce +the work required to find the correct method implementation +for a particular class; once cached, the interpreter doesn’t need to +traverse base classes to figure out the right method to call. +The cache is cleared if a base class or the class itself is modified, +so the cache should remain correct even in the face of Python’s dynamic +nature. +(Original optimization implemented by Armin Rigo, updated for +Python 2.6 by Kevin Jacobs; bpo-1700288.)

      +

      By default, this change is only applied to types that are included with +the Python core. Extension modules may not necessarily be compatible with +this cache, +so they must explicitly add Py_TPFLAGS_HAVE_VERSION_TAG +to the module’s tp_flags field to enable the method cache. +(To be compatible with the method cache, the extension module’s code +must not directly access and modify the tp_dict member of +any of the types it implements. Most modules don’t do this, +but it’s impossible for the Python interpreter to determine that. +See bpo-1878 for some discussion.)

      +
    • +
    • Function calls that use keyword arguments are significantly faster +by doing a quick pointer comparison, usually saving the time of a +full string comparison. (Contributed by Raymond Hettinger, after an +initial implementation by Antoine Pitrou; bpo-1819.)

    • +
    • All of the functions in the struct module have been rewritten in +C, thanks to work at the Need For Speed sprint. +(Contributed by Raymond Hettinger.)

    • +
    • Some of the standard built-in types now set a bit in their type +objects. This speeds up checking whether an object is a subclass of +one of these types. (Contributed by Neal Norwitz.)

    • +
    • Unicode strings now use faster code for detecting +whitespace and line breaks; this speeds up the split() method +by about 25% and splitlines() by 35%. +(Contributed by Antoine Pitrou.) Memory usage is reduced +by using pymalloc for the Unicode string’s data.

    • +
    • The with statement now stores the __exit__() method on the stack, +producing a small speedup. (Implemented by Jeffrey Yasskin.)

    • +
    • To reduce memory usage, the garbage collector will now clear internal +free lists when garbage-collecting the highest generation of objects. +This may return memory to the operating system sooner.

    • +
    +
    +
    +

    Interpreter Changes

    +

    Two command-line options have been reserved for use by other Python +implementations. The -J switch has been reserved for use by +Jython for Jython-specific options, such as switches that are passed to +the underlying JVM. -X has been reserved for options +specific to a particular implementation of Python such as CPython, +Jython, or IronPython. If either option is used with Python 2.6, the +interpreter will report that the option isn’t currently used.

    +

    Python can now be prevented from writing .pyc or .pyo +files by supplying the -B switch to the Python interpreter, +or by setting the PYTHONDONTWRITEBYTECODE environment +variable before running the interpreter. This setting is available to +Python programs as the sys.dont_write_bytecode variable, and +Python code can change the value to modify the interpreter’s +behaviour. (Contributed by Neal Norwitz and Georg Brandl.)

    +

    The encoding used for standard input, output, and standard error can +be specified by setting the PYTHONIOENCODING environment +variable before running the interpreter. The value should be a string +in the form <encoding> or <encoding>:<errorhandler>. +The encoding part specifies the encoding’s name, e.g. utf-8 or +latin-1; the optional errorhandler part specifies +what to do with characters that can’t be handled by the encoding, +and should be one of “error”, “ignore”, or “replace”. (Contributed +by Martin von Löwis.)

    +
    +
    +
    +

    New and Improved Modules

    +

    As in every release, Python’s standard library received a number of +enhancements and bug fixes. Here’s a partial list of the most notable +changes, sorted alphabetically by module name. Consult the +Misc/NEWS file in the source tree for a more complete list of +changes, or look through the Subversion logs for all the details.

    +
      +
    • The asyncore and asynchat modules are +being actively maintained again, and a number of patches and bugfixes +were applied. (Maintained by Josiah Carlson; see bpo-1736190 for +one patch.)

    • +
    • The bsddb module also has a new maintainer, Jesús Cea Avión, and the package +is now available as a standalone package. The web page for the package is +www.jcea.es/programacion/pybsddb.htm. +The plan is to remove the package from the standard library +in Python 3.0, because its pace of releases is much more frequent than +Python’s.

      +

      The bsddb.dbshelve module now uses the highest pickling protocol +available, instead of restricting itself to protocol 1. +(Contributed by W. Barnes.)

      +
    • +
    • The cgi module will now read variables from the query string +of an HTTP POST request. This makes it possible to use form actions +with URLs that include query strings such as +“/cgi-bin/add.py?category=1”. (Contributed by Alexandre Fiori and +Nubis; bpo-1817.)

      +

      The parse_qs() and parse_qsl() functions have been +relocated from the cgi module to the urlparse module. +The versions still available in the cgi module will +trigger PendingDeprecationWarning messages in 2.6 +(bpo-600362).

      +
    • +
    • The cmath module underwent extensive revision, +contributed by Mark Dickinson and Christian Heimes. +Five new functions were added:

      +
        +
      • polar() converts a complex number to polar form, returning +the modulus and argument of the complex number.

      • +
      • rect() does the opposite, turning a modulus, argument pair +back into the corresponding complex number.

      • +
      • phase() returns the argument (also called the angle) of a complex +number.

      • +
      • isnan() returns True if either +the real or imaginary part of its argument is a NaN.

      • +
      • isinf() returns True if either the real or imaginary part of +its argument is infinite.

      • +
      +

      The revisions also improved the numerical soundness of the +cmath module. For all functions, the real and imaginary +parts of the results are accurate to within a few units of least +precision (ulps) whenever possible. See bpo-1381 for the +details. The branch cuts for asinh(), atanh(): and +atan() have also been corrected.

      +

      The tests for the module have been greatly expanded; nearly 2000 new +test cases exercise the algebraic functions.

      +

      On IEEE 754 platforms, the cmath module now handles IEEE 754 +special values and floating-point exceptions in a manner consistent +with Annex ‘G’ of the C99 standard.

      +
    • +
    • A new data type in the collections module: namedtuple(typename, +fieldnames) is a factory function that creates subclasses of the standard tuple +whose fields are accessible by name as well as index. For example:

      +
      >>> var_type = collections.namedtuple('variable',
      +...             'id name type size')
      +>>> # Names are separated by spaces or commas.
      +>>> # 'id, name, type, size' would also work.
      +>>> var_type._fields
      +('id', 'name', 'type', 'size')
      +
      +>>> var = var_type(1, 'frequency', 'int', 4)
      +>>> print var[0], var.id    # Equivalent
      +1 1
      +>>> print var[2], var.type  # Equivalent
      +int int
      +>>> var._asdict()
      +{'size': 4, 'type': 'int', 'id': 1, 'name': 'frequency'}
      +>>> v2 = var._replace(name='amplitude')
      +>>> v2
      +variable(id=1, name='amplitude', type='int', size=4)
      +
      +
      +

      Several places in the standard library that returned tuples have +been modified to return namedtuple instances. For example, +the Decimal.as_tuple() method now returns a named tuple with +sign, digits, and exponent fields.

      +

      (Contributed by Raymond Hettinger.)

      +
    • +
    • Another change to the collections module is that the +deque type now supports an optional maxlen parameter; +if supplied, the deque’s size will be restricted to no more +than maxlen items. Adding more items to a full deque causes +old items to be discarded.

      +
      >>> from collections import deque
      +>>> dq=deque(maxlen=3)
      +>>> dq
      +deque([], maxlen=3)
      +>>> dq.append(1); dq.append(2); dq.append(3)
      +>>> dq
      +deque([1, 2, 3], maxlen=3)
      +>>> dq.append(4)
      +>>> dq
      +deque([2, 3, 4], maxlen=3)
      +
      +
      +

      (Contributed by Raymond Hettinger.)

      +
    • +
    • The Cookie module’s Morsel objects now support an +httponly attribute. In some browsers. cookies with this attribute +set cannot be accessed or manipulated by JavaScript code. +(Contributed by Arvin Schnell; bpo-1638033.)

    • +
    • A new window method in the curses module, +chgat(), changes the display attributes for a certain number of +characters on a single line. (Contributed by Fabian Kreutz.)

      +
      # Boldface text starting at y=0,x=21
      +# and affecting the rest of the line.
      +stdscr.chgat(0, 21, curses.A_BOLD)
      +
      +
      +

      The Textbox class in the curses.textpad module +now supports editing in insert mode as well as overwrite mode. +Insert mode is enabled by supplying a true value for the insert_mode +parameter when creating the Textbox instance.

      +
    • +
    • The datetime module’s strftime() methods now support a +%f format code that expands to the number of microseconds in the +object, zero-padded on +the left to six places. (Contributed by Skip Montanaro; bpo-1158.)

    • +
    • The decimal module was updated to version 1.66 of +the General Decimal Specification. New features +include some methods for some basic mathematical functions such as +exp() and log10():

      +
      >>> Decimal(1).exp()
      +Decimal("2.718281828459045235360287471")
      +>>> Decimal("2.7182818").ln()
      +Decimal("0.9999999895305022877376682436")
      +>>> Decimal(1000).log10()
      +Decimal("3")
      +
      +
      +

      The as_tuple() method of Decimal objects now returns a +named tuple with sign, digits, and exponent fields.

      +

      (Implemented by Facundo Batista and Mark Dickinson. Named tuple +support added by Raymond Hettinger.)

      +
    • +
    • The difflib module’s SequenceMatcher class +now returns named tuples representing matches, +with a, b, and size attributes. +(Contributed by Raymond Hettinger.)

    • +
    • An optional timeout parameter, specifying a timeout measured in +seconds, was added to the ftplib.FTP class constructor as +well as the connect() method. (Added by Facundo Batista.) +Also, the FTP class’s storbinary() and +storlines() now take an optional callback parameter that +will be called with each block of data after the data has been sent. +(Contributed by Phil Schwartz; bpo-1221598.)

    • +
    • The reduce() built-in function is also available in the +functools module. In Python 3.0, the builtin has been +dropped and reduce() is only available from functools; +currently there are no plans to drop the builtin in the 2.x series. +(Patched by Christian Heimes; bpo-1739906.)

    • +
    • When possible, the getpass module will now use +/dev/tty to print a prompt message and read the password, +falling back to standard error and standard input. If the +password may be echoed to the terminal, a warning is printed before +the prompt is displayed. (Contributed by Gregory P. Smith.)

    • +
    • The glob.glob() function can now return Unicode filenames if +a Unicode path was used and Unicode filenames are matched within the +directory. (bpo-1001604)

    • +
    • A new function in the heapq module, merge(iter1, iter2, ...), +takes any number of iterables returning data in sorted +order, and returns a new generator that returns the contents of all +the iterators, also in sorted order. For example:

      +
      >>> list(heapq.merge([1, 3, 5, 9], [2, 8, 16]))
      +[1, 2, 3, 5, 8, 9, 16]
      +
      +
      +

      Another new function, heappushpop(heap, item), +pushes item onto heap, then pops off and returns the smallest item. +This is more efficient than making a call to heappush() and then +heappop().

      +

      heapq is now implemented to only use less-than comparison, +instead of the less-than-or-equal comparison it previously used. +This makes heapq’s usage of a type match the +list.sort() method. +(Contributed by Raymond Hettinger.)

      +
    • +
    • An optional timeout parameter, specifying a timeout measured in +seconds, was added to the httplib.HTTPConnection and +HTTPSConnection class constructors. (Added by Facundo +Batista.)

    • +
    • Most of the inspect module’s functions, such as +getmoduleinfo() and getargs(), now return named tuples. +In addition to behaving like tuples, the elements of the return value +can also be accessed as attributes. +(Contributed by Raymond Hettinger.)

      +

      Some new functions in the module include +isgenerator(), isgeneratorfunction(), +and isabstract().

      +
    • +
    • The itertools module gained several new functions.

      +

      izip_longest(iter1, iter2, ...[, fillvalue]) makes tuples from +each of the elements; if some of the iterables are shorter than +others, the missing values are set to fillvalue. For example:

      +
      >>> tuple(itertools.izip_longest([1,2,3], [1,2,3,4,5]))
      +((1, 1), (2, 2), (3, 3), (None, 4), (None, 5))
      +
      +
      +

      product(iter1, iter2, ..., [repeat=N]) returns the Cartesian product +of the supplied iterables, a set of tuples containing +every possible combination of the elements returned from each iterable.

      +
      >>> list(itertools.product([1,2,3], [4,5,6]))
      +[(1, 4), (1, 5), (1, 6),
      + (2, 4), (2, 5), (2, 6),
      + (3, 4), (3, 5), (3, 6)]
      +
      +
      +

      The optional repeat keyword argument is used for taking the +product of an iterable or a set of iterables with themselves, +repeated N times. With a single iterable argument, N-tuples +are returned:

      +
      >>> list(itertools.product([1,2], repeat=3))
      +[(1, 1, 1), (1, 1, 2), (1, 2, 1), (1, 2, 2),
      + (2, 1, 1), (2, 1, 2), (2, 2, 1), (2, 2, 2)]
      +
      +
      +

      With two iterables, 2N-tuples are returned.

      +
      >>> list(itertools.product([1,2], [3,4], repeat=2))
      +[(1, 3, 1, 3), (1, 3, 1, 4), (1, 3, 2, 3), (1, 3, 2, 4),
      + (1, 4, 1, 3), (1, 4, 1, 4), (1, 4, 2, 3), (1, 4, 2, 4),
      + (2, 3, 1, 3), (2, 3, 1, 4), (2, 3, 2, 3), (2, 3, 2, 4),
      + (2, 4, 1, 3), (2, 4, 1, 4), (2, 4, 2, 3), (2, 4, 2, 4)]
      +
      +
      +

      combinations(iterable, r) returns sub-sequences of length r from +the elements of iterable.

      +
      >>> list(itertools.combinations('123', 2))
      +[('1', '2'), ('1', '3'), ('2', '3')]
      +>>> list(itertools.combinations('123', 3))
      +[('1', '2', '3')]
      +>>> list(itertools.combinations('1234', 3))
      +[('1', '2', '3'), ('1', '2', '4'),
      + ('1', '3', '4'), ('2', '3', '4')]
      +
      +
      +

      permutations(iter[, r]) returns all the permutations of length r of +the iterable’s elements. If r is not specified, it will default to the +number of elements produced by the iterable.

      +
      >>> list(itertools.permutations([1,2,3,4], 2))
      +[(1, 2), (1, 3), (1, 4),
      + (2, 1), (2, 3), (2, 4),
      + (3, 1), (3, 2), (3, 4),
      + (4, 1), (4, 2), (4, 3)]
      +
      +
      +

      itertools.chain(*iterables) is an existing function in +itertools that gained a new constructor in Python 2.6. +itertools.chain.from_iterable(iterable) takes a single +iterable that should return other iterables. chain() will +then return all the elements of the first iterable, then +all the elements of the second, and so on.

      +
      >>> list(itertools.chain.from_iterable([[1,2,3], [4,5,6]]))
      +[1, 2, 3, 4, 5, 6]
      +
      +
      +

      (All contributed by Raymond Hettinger.)

      +
    • +
    • The logging module’s FileHandler class +and its subclasses WatchedFileHandler, RotatingFileHandler, +and TimedRotatingFileHandler now +have an optional delay parameter to their constructors. If delay +is true, opening of the log file is deferred until the first +emit() call is made. (Contributed by Vinay Sajip.)

      +

      TimedRotatingFileHandler also has a utc constructor +parameter. If the argument is true, UTC time will be used +in determining when midnight occurs and in generating filenames; +otherwise local time will be used.

      +
    • +
    • Several new functions were added to the math module:

      +
        +
      • isinf() and isnan() determine whether a given float +is a (positive or negative) infinity or a NaN (Not a Number), respectively.

      • +
      • copysign() copies the sign bit of an IEEE 754 number, +returning the absolute value of x combined with the sign bit of +y. For example, math.copysign(1, -0.0) returns -1.0. +(Contributed by Christian Heimes.)

      • +
      • factorial() computes the factorial of a number. +(Contributed by Raymond Hettinger; bpo-2138.)

      • +
      • fsum() adds up the stream of numbers from an iterable, +and is careful to avoid loss of precision through using partial sums. +(Contributed by Jean Brouwers, Raymond Hettinger, and Mark Dickinson; +bpo-2819.)

      • +
      • acosh(), asinh() +and atanh() compute the inverse hyperbolic functions.

      • +
      • log1p() returns the natural logarithm of 1+x +(base e).

      • +
      • trunc() rounds a number toward zero, returning the closest +Integral that’s between the function’s argument and zero. +Added as part of the backport of +PEP 3141’s type hierarchy for numbers.

      • +
      +
    • +
    • The math module has been improved to give more consistent +behaviour across platforms, especially with respect to handling of +floating-point exceptions and IEEE 754 special values.

      +

      Whenever possible, the module follows the recommendations of the C99 +standard about 754’s special values. For example, sqrt(-1.) +should now give a ValueError across almost all platforms, +while sqrt(float('NaN')) should return a NaN on all IEEE 754 +platforms. Where Annex ‘F’ of the C99 standard recommends signaling +‘divide-by-zero’ or ‘invalid’, Python will raise ValueError. +Where Annex ‘F’ of the C99 standard recommends signaling ‘overflow’, +Python will raise OverflowError. (See bpo-711019 and +bpo-1640.)

      +

      (Contributed by Christian Heimes and Mark Dickinson.)

      +
    • +
    • mmap objects now have a rfind() method that searches for a +substring beginning at the end of the string and searching +backwards. The find() method also gained an end parameter +giving an index at which to stop searching. +(Contributed by John Lenton.)

    • +
    • The operator module gained a +methodcaller() function that takes a name and an optional +set of arguments, returning a callable that will call +the named function on any arguments passed to it. For example:

      +
      >>> # Equivalent to lambda s: s.replace('old', 'new')
      +>>> replacer = operator.methodcaller('replace', 'old', 'new')
      +>>> replacer('old wine in old bottles')
      +'new wine in new bottles'
      +
      +
      +

      (Contributed by Georg Brandl, after a suggestion by Gregory Petrosyan.)

      +

      The attrgetter() function now accepts dotted names and performs +the corresponding attribute lookups:

      +
      >>> inst_name = operator.attrgetter(
      +...        '__class__.__name__')
      +>>> inst_name('')
      +'str'
      +>>> inst_name(help)
      +'_Helper'
      +
      +
      +

      (Contributed by Georg Brandl, after a suggestion by Barry Warsaw.)

      +
    • +
    • The os module now wraps several new system calls. +fchmod(fd, mode) and fchown(fd, uid, gid) change the mode +and ownership of an opened file, and lchmod(path, mode) changes +the mode of a symlink. (Contributed by Georg Brandl and Christian +Heimes.)

      +

      chflags() and lchflags() are wrappers for the +corresponding system calls (where they’re available), changing the +flags set on a file. Constants for the flag values are defined in +the stat module; some possible values include +UF_IMMUTABLE to signal the file may not be changed and +UF_APPEND to indicate that data can only be appended to the +file. (Contributed by M. Levinson.)

      +

      os.closerange(low, high) efficiently closes all file descriptors +from low to high, ignoring any errors and not including high itself. +This function is now used by the subprocess module to make starting +processes faster. (Contributed by Georg Brandl; bpo-1663329.)

      +
    • +
    • The os.environ object’s clear() method will now unset the +environment variables using os.unsetenv() in addition to clearing +the object’s keys. (Contributed by Martin Horcicka; bpo-1181.)

    • +
    • The os.walk() function now has a followlinks parameter. If +set to True, it will follow symlinks pointing to directories and +visit the directory’s contents. For backward compatibility, the +parameter’s default value is false. Note that the function can fall +into an infinite recursion if there’s a symlink that points to a +parent directory. (bpo-1273829)

    • +
    • In the os.path module, the splitext() function +has been changed to not split on leading period characters. +This produces better results when operating on Unix’s dot-files. +For example, os.path.splitext('.ipython') +now returns ('.ipython', '') instead of ('', '.ipython'). +(bpo-1115886)

      +

      A new function, os.path.relpath(path, start='.'), returns a relative path +from the start path, if it’s supplied, or from the current +working directory to the destination path. (Contributed by +Richard Barran; bpo-1339796.)

      +

      On Windows, os.path.expandvars() will now expand environment variables +given in the form “%var%”, and “~user” will be expanded into the +user’s home directory path. (Contributed by Josiah Carlson; +bpo-957650.)

      +
    • +
    • The Python debugger provided by the pdb module +gained a new command: “run” restarts the Python program being debugged +and can optionally take new command-line arguments for the program. +(Contributed by Rocky Bernstein; bpo-1393667.)

    • +
    • The pdb.post_mortem() function, used to begin debugging a +traceback, will now use the traceback returned by sys.exc_info() +if no traceback is supplied. (Contributed by Facundo Batista; +bpo-1106316.)

    • +
    • The pickletools module now has an optimize() function +that takes a string containing a pickle and removes some unused +opcodes, returning a shorter pickle that contains the same data structure. +(Contributed by Raymond Hettinger.)

    • +
    • A get_data() function was added to the pkgutil +module that returns the contents of resource files included +with an installed Python package. For example:

      +
      >>> import pkgutil
      +>>> print pkgutil.get_data('test', 'exception_hierarchy.txt')
      +BaseException
      + +-- SystemExit
      + +-- KeyboardInterrupt
      + +-- GeneratorExit
      + +-- Exception
      +      +-- StopIteration
      +      +-- StandardError
      + ...
      +
      +
      +

      (Contributed by Paul Moore; bpo-2439.)

      +
    • +
    • The pyexpat module’s Parser objects now allow setting +their buffer_size attribute to change the size of the buffer +used to hold character data. +(Contributed by Achim Gaedke; bpo-1137.)

    • +
    • The Queue module now provides queue variants that retrieve entries +in different orders. The PriorityQueue class stores +queued items in a heap and retrieves them in priority order, +and LifoQueue retrieves the most recently added entries first, +meaning that it behaves like a stack. +(Contributed by Raymond Hettinger.)

    • +
    • The random module’s Random objects can +now be pickled on a 32-bit system and unpickled on a 64-bit +system, and vice versa. Unfortunately, this change also means +that Python 2.6’s Random objects can’t be unpickled correctly +on earlier versions of Python. +(Contributed by Shawn Ligocki; bpo-1727780.)

      +

      The new triangular(low, high, mode) function returns random +numbers following a triangular distribution. The returned values +are between low and high, not including high itself, and +with mode as the most frequently occurring value +in the distribution. (Contributed by Wladmir van der Laan and +Raymond Hettinger; bpo-1681432.)

      +
    • +
    • Long regular expression searches carried out by the re +module will check for signals being delivered, so +time-consuming searches can now be interrupted. +(Contributed by Josh Hoyt and Ralf Schmitt; bpo-846388.)

      +

      The regular expression module is implemented by compiling bytecodes +for a tiny regex-specific virtual machine. Untrusted code +could create malicious strings of bytecode directly and cause crashes, +so Python 2.6 includes a verifier for the regex bytecode. +(Contributed by Guido van Rossum from work for Google App Engine; +bpo-3487.)

      +
    • +
    • The rlcompleter module’s Completer.complete() method +will now ignore exceptions triggered while evaluating a name. +(Fixed by Lorenz Quack; bpo-2250.)

    • +
    • The sched module’s scheduler instances now +have a read-only queue attribute that returns the +contents of the scheduler’s queue, represented as a list of +named tuples with the fields (time, priority, action, argument). +(Contributed by Raymond Hettinger; bpo-1861.)

    • +
    • The select module now has wrapper functions +for the Linux epoll() and BSD kqueue() system calls. +modify() method was added to the existing poll +objects; pollobj.modify(fd, eventmask) takes a file descriptor +or file object and an event mask, modifying the recorded event mask +for that file. +(Contributed by Christian Heimes; bpo-1657.)

    • +
    • The shutil.copytree() function now has an optional ignore argument +that takes a callable object. This callable will receive each directory path +and a list of the directory’s contents, and returns a list of names that +will be ignored, not copied.

      +

      The shutil module also provides an ignore_patterns() +function for use with this new parameter. ignore_patterns() +takes an arbitrary number of glob-style patterns and returns a +callable that will ignore any files and directories that match any +of these patterns. The following example copies a directory tree, +but skips both .svn directories and Emacs backup files, +which have names ending with ‘~’:

      +
      shutil.copytree('Doc/library', '/tmp/library',
      +                ignore=shutil.ignore_patterns('*~', '.svn'))
      +
      +
      +

      (Contributed by Tarek Ziadé; bpo-2663.)

      +
    • +
    • Integrating signal handling with GUI handling event loops +like those used by Tkinter or GTk+ has long been a problem; most +software ends up polling, waking up every fraction of a second to check +if any GUI events have occurred. +The signal module can now make this more efficient. +Calling signal.set_wakeup_fd(fd) sets a file descriptor +to be used; when a signal is received, a byte is written to that +file descriptor. There’s also a C-level function, +PySignal_SetWakeupFd(), for setting the descriptor.

      +

      Event loops will use this by opening a pipe to create two descriptors, +one for reading and one for writing. The writable descriptor +will be passed to set_wakeup_fd(), and the readable descriptor +will be added to the list of descriptors monitored by the event loop via +select() or poll(). +On receiving a signal, a byte will be written and the main event loop +will be woken up, avoiding the need to poll.

      +

      (Contributed by Adam Olsen; bpo-1583.)

      +

      The siginterrupt() function is now available from Python code, +and allows changing whether signals can interrupt system calls or not. +(Contributed by Ralf Schmitt.)

      +

      The setitimer() and getitimer() functions have also been +added (where they’re available). setitimer() +allows setting interval timers that will cause a signal to be +delivered to the process after a specified time, measured in +wall-clock time, consumed process time, or combined process+system +time. (Contributed by Guilherme Polo; bpo-2240.)

      +
    • +
    • The smtplib module now supports SMTP over SSL thanks to the +addition of the SMTP_SSL class. This class supports an +interface identical to the existing SMTP class. +(Contributed by Monty Taylor.) Both class constructors also have an +optional timeout parameter that specifies a timeout for the +initial connection attempt, measured in seconds. (Contributed by +Facundo Batista.)

      +

      An implementation of the LMTP protocol (RFC 2033) was also added +to the module. LMTP is used in place of SMTP when transferring +e-mail between agents that don’t manage a mail queue. (LMTP +implemented by Leif Hedstrom; bpo-957003.)

      +

      SMTP.starttls() now complies with RFC 3207 and forgets any +knowledge obtained from the server not obtained from the TLS +negotiation itself. (Patch contributed by Bill Fenner; +bpo-829951.)

      +
    • +
    • The socket module now supports TIPC (http://tipc.sourceforge.net/), +a high-performance non-IP-based protocol designed for use in clustered +environments. TIPC addresses are 4- or 5-tuples. +(Contributed by Alberto Bertogli; bpo-1646.)

      +

      A new function, create_connection(), takes an address and +connects to it using an optional timeout value, returning the +connected socket object. This function also looks up the address’s +type and connects to it using IPv4 or IPv6 as appropriate. Changing +your code to use create_connection() instead of +socket(socket.AF_INET, ...) may be all that’s required to make +your code work with IPv6.

      +
    • +
    • The base classes in the SocketServer module now support +calling a handle_timeout() method after a span of inactivity +specified by the server’s timeout attribute. (Contributed +by Michael Pomraning.) The serve_forever() method +now takes an optional poll interval measured in seconds, +controlling how often the server will check for a shutdown request. +(Contributed by Pedro Werneck and Jeffrey Yasskin; +bpo-742598, bpo-1193577.)

    • +
    • The sqlite3 module, maintained by Gerhard Häring, +has been updated from version 2.3.2 in Python 2.5 to +version 2.4.1.

    • +
    • The struct module now supports the C99 _Bool type, +using the format character '?'. +(Contributed by David Remahl.)

    • +
    • The Popen objects provided by the subprocess module +now have terminate(), kill(), and send_signal() methods. +On Windows, send_signal() only supports the SIGTERM +signal, and all these methods are aliases for the Win32 API function +TerminateProcess(). +(Contributed by Christian Heimes.)

    • +
    • A new variable in the sys module, float_info, is an +object containing information derived from the float.h file +about the platform’s floating-point support. Attributes of this +object include mant_dig (number of digits in the mantissa), +epsilon (smallest difference between 1.0 and the next +largest value representable), and several others. (Contributed by +Christian Heimes; bpo-1534.)

      +

      Another new variable, dont_write_bytecode, controls whether Python +writes any .pyc or .pyo files on importing a module. +If this variable is true, the compiled files are not written. The +variable is initially set on start-up by supplying the -B +switch to the Python interpreter, or by setting the +PYTHONDONTWRITEBYTECODE environment variable before +running the interpreter. Python code can subsequently +change the value of this variable to control whether bytecode files +are written or not. +(Contributed by Neal Norwitz and Georg Brandl.)

      +

      Information about the command-line arguments supplied to the Python +interpreter is available by reading attributes of a named +tuple available as sys.flags. For example, the verbose +attribute is true if Python +was executed in verbose mode, debug is true in debugging mode, etc. +These attributes are all read-only. +(Contributed by Christian Heimes.)

      +

      A new function, getsizeof(), takes a Python object and returns +the amount of memory used by the object, measured in bytes. Built-in +objects return correct results; third-party extensions may not, +but can define a __sizeof__() method to return the +object’s size. +(Contributed by Robert Schuppenies; bpo-2898.)

      +

      It’s now possible to determine the current profiler and tracer functions +by calling sys.getprofile() and sys.gettrace(). +(Contributed by Georg Brandl; bpo-1648.)

      +
    • +
    • The tarfile module now supports POSIX.1-2001 (pax) tarfiles in +addition to the POSIX.1-1988 (ustar) and GNU tar formats that were +already supported. The default format is GNU tar; specify the +format parameter to open a file using a different format:

      +
      tar = tarfile.open("output.tar", "w",
      +                   format=tarfile.PAX_FORMAT)
      +
      +
      +

      The new encoding and errors parameters specify an encoding and +an error handling scheme for character conversions. 'strict', +'ignore', and 'replace' are the three standard ways Python can +handle errors,; +'utf-8' is a special value that replaces bad characters with +their UTF-8 representation. (Character conversions occur because the +PAX format supports Unicode filenames, defaulting to UTF-8 encoding.)

      +

      The TarFile.add() method now accepts an exclude argument that’s +a function that can be used to exclude certain filenames from +an archive. +The function must take a filename and return true if the file +should be excluded or false if it should be archived. +The function is applied to both the name initially passed to add() +and to the names of files in recursively-added directories.

      +

      (All changes contributed by Lars Gustäbel).

      +
    • +
    • An optional timeout parameter was added to the +telnetlib.Telnet class constructor, specifying a timeout +measured in seconds. (Added by Facundo Batista.)

    • +
    • The tempfile.NamedTemporaryFile class usually deletes +the temporary file it created when the file is closed. This +behaviour can now be changed by passing delete=False to the +constructor. (Contributed by Damien Miller; bpo-1537850.)

      +

      A new class, SpooledTemporaryFile, behaves like +a temporary file but stores its data in memory until a maximum size is +exceeded. On reaching that limit, the contents will be written to +an on-disk temporary file. (Contributed by Dustin J. Mitchell.)

      +

      The NamedTemporaryFile and SpooledTemporaryFile classes +both work as context managers, so you can write +with tempfile.NamedTemporaryFile() as tmp: .... +(Contributed by Alexander Belopolsky; bpo-2021.)

      +
    • +
    • The test.test_support module gained a number +of context managers useful for writing tests. +EnvironmentVarGuard() is a +context manager that temporarily changes environment variables and +automatically restores them to their old values.

      +

      Another context manager, TransientResource, can surround calls +to resources that may or may not be available; it will catch and +ignore a specified list of exceptions. For example, +a network test may ignore certain failures when connecting to an +external web site:

      +
      with test_support.TransientResource(IOError,
      +                                errno=errno.ETIMEDOUT):
      +    f = urllib.urlopen('https://sf.net')
      +    ...
      +
      +
      +

      Finally, check_warnings() resets the warning module’s +warning filters and returns an object that will record all warning +messages triggered (bpo-3781):

      +
      with test_support.check_warnings() as wrec:
      +    warnings.simplefilter("always")
      +    # ... code that triggers a warning ...
      +    assert str(wrec.message) == "function is outdated"
      +    assert len(wrec.warnings) == 1, "Multiple warnings raised"
      +
      +
      +

      (Contributed by Brett Cannon.)

      +
    • +
    • The textwrap module can now preserve existing whitespace +at the beginnings and ends of the newly-created lines +by specifying drop_whitespace=False +as an argument:

      +
      >>> S = """This  sentence  has a bunch   of
      +...   extra   whitespace."""
      +>>> print textwrap.fill(S, width=15)
      +This  sentence
      +has a bunch
      +of    extra
      +whitespace.
      +>>> print textwrap.fill(S, drop_whitespace=False, width=15)
      +This  sentence
      +  has a bunch
      +   of    extra
      +   whitespace.
      +>>>
      +
      +
      +

      (Contributed by Dwayne Bailey; bpo-1581073.)

      +
    • +
    • The threading module API is being changed to use properties +such as daemon instead of setDaemon() and +isDaemon() methods, and some methods have been renamed to use +underscores instead of camel-case; for example, the +activeCount() method is renamed to active_count(). Both +the 2.6 and 3.0 versions of the module support the same properties +and renamed methods, but don’t remove the old methods. No date has been set +for the deprecation of the old APIs in Python 3.x; the old APIs won’t +be removed in any 2.x version. +(Carried out by several people, most notably Benjamin Peterson.)

      +

      The threading module’s Thread objects +gained an ident property that returns the thread’s +identifier, a nonzero integer. (Contributed by Gregory P. Smith; +bpo-2871.)

      +
    • +
    • The timeit module now accepts callables as well as strings +for the statement being timed and for the setup code. +Two convenience functions were added for creating +Timer instances: +repeat(stmt, setup, time, repeat, number) and +timeit(stmt, setup, time, number) create an instance and call +the corresponding method. (Contributed by Erik Demaine; +bpo-1533909.)

    • +
    • The Tkinter module now accepts lists and tuples for options, +separating the elements by spaces before passing the resulting value to +Tcl/Tk. +(Contributed by Guilherme Polo; bpo-2906.)

    • +
    • The turtle module for turtle graphics was greatly enhanced by +Gregor Lingl. New features in the module include:

      +
        +
      • Better animation of turtle movement and rotation.

      • +
      • Control over turtle movement using the new delay(), +tracer(), and speed() methods.

      • +
      • The ability to set new shapes for the turtle, and to +define a new coordinate system.

      • +
      • Turtles now have an undo() method that can roll back actions.

      • +
      • Simple support for reacting to input events such as mouse and keyboard +activity, making it possible to write simple games.

      • +
      • A turtle.cfg file can be used to customize the starting appearance +of the turtle’s screen.

      • +
      • The module’s docstrings can be replaced by new docstrings that have been +translated into another language.

      • +
      +

      (bpo-1513695)

      +
    • +
    • An optional timeout parameter was added to the +urllib.urlopen() function and the +urllib.ftpwrapper class constructor, as well as the +urllib2.urlopen() function. The parameter specifies a timeout +measured in seconds. For example:

      +
      >>> u = urllib2.urlopen("http://slow.example.com",
      +                        timeout=3)
      +Traceback (most recent call last):
      +  ...
      +urllib2.URLError: <urlopen error timed out>
      +>>>
      +
      +
      +

      (Added by Facundo Batista.)

      +
    • +
    • The Unicode database provided by the unicodedata module +has been updated to version 5.1.0. (Updated by +Martin von Löwis; bpo-3811.)

    • +
    • The warnings module’s formatwarning() and showwarning() +gained an optional line argument that can be used to supply the +line of source code. (Added as part of bpo-1631171, which re-implemented +part of the warnings module in C code.)

      +

      A new function, catch_warnings(), is a context manager +intended for testing purposes that lets you temporarily modify the +warning filters and then restore their original values (bpo-3781).

      +
    • +
    • The XML-RPC SimpleXMLRPCServer and DocXMLRPCServer +classes can now be prevented from immediately opening and binding to +their socket by passing False as the bind_and_activate +constructor parameter. This can be used to modify the instance’s +allow_reuse_address attribute before calling the +server_bind() and server_activate() methods to +open the socket and begin listening for connections. +(Contributed by Peter Parente; bpo-1599845.)

      +

      SimpleXMLRPCServer also has a _send_traceback_header +attribute; if true, the exception and formatted traceback are returned +as HTTP headers “X-Exception” and “X-Traceback”. This feature is +for debugging purposes only and should not be used on production servers +because the tracebacks might reveal passwords or other sensitive +information. (Contributed by Alan McIntyre as part of his +project for Google’s Summer of Code 2007.)

      +
    • +
    • The xmlrpclib module no longer automatically converts +datetime.date and datetime.time to the +xmlrpclib.DateTime type; the conversion semantics were +not necessarily correct for all applications. Code using +xmlrpclib should convert date and time +instances. (bpo-1330538) The code can also handle +dates before 1900 (contributed by Ralf Schmitt; bpo-2014) +and 64-bit integers represented by using <i8> in XML-RPC responses +(contributed by Riku Lindblad; bpo-2985).

    • +
    • The zipfile module’s ZipFile class now has +extract() and extractall() methods that will unpack +a single file or all the files in the archive to the current directory, or +to a specified directory:

      +
      z = zipfile.ZipFile('python-251.zip')
      +
      +# Unpack a single file, writing it relative
      +# to the /tmp directory.
      +z.extract('Python/sysmodule.c', '/tmp')
      +
      +# Unpack all the files in the archive.
      +z.extractall()
      +
      +
      +

      (Contributed by Alan McIntyre; bpo-467924.)

      +

      The open(), read() and extract() methods can now +take either a filename or a ZipInfo object. This is useful when an +archive accidentally contains a duplicated filename. +(Contributed by Graham Horler; bpo-1775025.)

      +

      Finally, zipfile now supports using Unicode filenames +for archived files. (Contributed by Alexey Borzenkov; bpo-1734346.)

      +
    • +
    +
    +

    The ast module

    +

    The ast module provides an Abstract Syntax Tree +representation of Python code, and Armin Ronacher +contributed a set of helper functions that perform a variety of +common tasks. These will be useful for HTML templating +packages, code analyzers, and similar tools that process +Python code.

    +

    The parse() function takes an expression and returns an AST. +The dump() function outputs a representation of a tree, suitable +for debugging:

    +
    import ast
    +
    +t = ast.parse("""
    +d = {}
    +for i in 'abcdefghijklm':
    +    d[i + i] = ord(i) - ord('a') + 1
    +print d
    +""")
    +print ast.dump(t)
    +
    +
    +

    This outputs a deeply nested tree:

    +
    Module(body=[
    +  Assign(targets=[
    +    Name(id='d', ctx=Store())
    +   ], value=Dict(keys=[], values=[]))
    +  For(target=Name(id='i', ctx=Store()),
    +      iter=Str(s='abcdefghijklm'), body=[
    +    Assign(targets=[
    +      Subscript(value=
    +        Name(id='d', ctx=Load()),
    +          slice=
    +          Index(value=
    +            BinOp(left=Name(id='i', ctx=Load()), op=Add(),
    +             right=Name(id='i', ctx=Load()))), ctx=Store())
    +     ], value=
    +     BinOp(left=
    +      BinOp(left=
    +       Call(func=
    +        Name(id='ord', ctx=Load()), args=[
    +          Name(id='i', ctx=Load())
    +         ], keywords=[], starargs=None, kwargs=None),
    +       op=Sub(), right=Call(func=
    +        Name(id='ord', ctx=Load()), args=[
    +          Str(s='a')
    +         ], keywords=[], starargs=None, kwargs=None)),
    +       op=Add(), right=Num(n=1)))
    +    ], orelse=[])
    +   Print(dest=None, values=[
    +     Name(id='d', ctx=Load())
    +   ], nl=True)
    + ])
    +
    +
    +

    The literal_eval() method takes a string or an AST +representing a literal expression, parses and evaluates it, and +returns the resulting value. A literal expression is a Python +expression containing only strings, numbers, dictionaries, +etc. but no statements or function calls. If you need to +evaluate an expression but cannot accept the security risk of using an +eval() call, literal_eval() will handle it safely:

    +
    >>> literal = '("a", "b", {2:4, 3:8, 1:2})'
    +>>> print ast.literal_eval(literal)
    +('a', 'b', {1: 2, 2: 4, 3: 8})
    +>>> print ast.literal_eval('"a" + "b"')
    +Traceback (most recent call last):
    +  ...
    +ValueError: malformed string
    +
    +
    +

    The module also includes NodeVisitor and +NodeTransformer classes for traversing and modifying an AST, +and functions for common transformations such as changing line +numbers.

    +
    +
    +

    The future_builtins module

    +

    Python 3.0 makes many changes to the repertoire of built-in +functions, and most of the changes can’t be introduced in the Python +2.x series because they would break compatibility. +The future_builtins module provides versions +of these built-in functions that can be imported when writing +3.0-compatible code.

    +

    The functions in this module currently include:

    +
      +
    • ascii(obj): equivalent to repr(). In Python 3.0, +repr() will return a Unicode string, while ascii() will +return a pure ASCII bytestring.

    • +
    • filter(predicate, iterable), +map(func, iterable1, ...): the 3.0 versions +return iterators, unlike the 2.x builtins which return lists.

    • +
    • hex(value), oct(value): instead of calling the +__hex__() or __oct__() methods, these versions will +call the __index__() method and convert the result to hexadecimal +or octal. oct() will use the new 0o notation for its +result.

    • +
    +
    +
    +

    The json module: JavaScript Object Notation

    +

    The new json module supports the encoding and decoding of Python types in +JSON (Javascript Object Notation). JSON is a lightweight interchange format +often used in web applications. For more information about JSON, see +http://www.json.org.

    +

    json comes with support for decoding and encoding most built-in Python +types. The following example encodes and decodes a dictionary:

    +
    >>> import json
    +>>> data = {"spam": "foo", "parrot": 42}
    +>>> in_json = json.dumps(data) # Encode the data
    +>>> in_json
    +'{"parrot": 42, "spam": "foo"}'
    +>>> json.loads(in_json) # Decode into a Python object
    +{"spam": "foo", "parrot": 42}
    +
    +
    +

    It’s also possible to write your own decoders and encoders to support +more types. Pretty-printing of the JSON strings is also supported.

    +

    json (originally called simplejson) was written by Bob +Ippolito.

    +
    +
    +

    The plistlib module: A Property-List Parser

    +

    The .plist format is commonly used on Mac OS X to +store basic data types (numbers, strings, lists, +and dictionaries) by serializing them into an XML-based format. +It resembles the XML-RPC serialization of data types.

    +

    Despite being primarily used on Mac OS X, the format +has nothing Mac-specific about it and the Python implementation works +on any platform that Python supports, so the plistlib module +has been promoted to the standard library.

    +

    Using the module is simple:

    +
    import sys
    +import plistlib
    +import datetime
    +
    +# Create data structure
    +data_struct = dict(lastAccessed=datetime.datetime.now(),
    +                   version=1,
    +                   categories=('Personal','Shared','Private'))
    +
    +# Create string containing XML.
    +plist_str = plistlib.writePlistToString(data_struct)
    +new_struct = plistlib.readPlistFromString(plist_str)
    +print data_struct
    +print new_struct
    +
    +# Write data structure to a file and read it back.
    +plistlib.writePlist(data_struct, '/tmp/customizations.plist')
    +new_struct = plistlib.readPlist('/tmp/customizations.plist')
    +
    +# read/writePlist accepts file-like objects as well as paths.
    +plistlib.writePlist(data_struct, sys.stdout)
    +
    +
    +
    +
    +

    ctypes Enhancements

    +

    Thomas Heller continued to maintain and enhance the +ctypes module.

    +

    ctypes now supports a c_bool datatype +that represents the C99 bool type. (Contributed by David Remahl; +bpo-1649190.)

    +

    The ctypes string, buffer and array types have improved +support for extended slicing syntax, +where various combinations of (start, stop, step) are supplied. +(Implemented by Thomas Wouters.)

    +

    All ctypes data types now support +from_buffer() and from_buffer_copy() +methods that create a ctypes instance based on a +provided buffer object. from_buffer_copy() copies +the contents of the object, +while from_buffer() will share the same memory area.

    +

    A new calling convention tells ctypes to clear the errno or +Win32 LastError variables at the outset of each wrapped call. +(Implemented by Thomas Heller; bpo-1798.)

    +

    You can now retrieve the Unix errno variable after a function +call. When creating a wrapped function, you can supply +use_errno=True as a keyword parameter to the DLL() function +and then call the module-level methods set_errno() and +get_errno() to set and retrieve the error value.

    +

    The Win32 LastError variable is similarly supported by +the DLL(), OleDLL(), and WinDLL() functions. +You supply use_last_error=True as a keyword parameter +and then call the module-level methods set_last_error() +and get_last_error().

    +

    The byref() function, used to retrieve a pointer to a ctypes +instance, now has an optional offset parameter that is a byte +count that will be added to the returned pointer.

    +
    +
    +

    Improved SSL Support

    +

    Bill Janssen made extensive improvements to Python 2.6’s support for +the Secure Sockets Layer by adding a new module, ssl, that’s +built atop the OpenSSL library. +This new module provides more control over the protocol negotiated, +the X.509 certificates used, and has better support for writing SSL +servers (as opposed to clients) in Python. The existing SSL support +in the socket module hasn’t been removed and continues to work, +though it will be removed in Python 3.0.

    +

    To use the new module, you must first create a TCP connection in the +usual way and then pass it to the ssl.wrap_socket() function. +It’s possible to specify whether a certificate is required, and to +obtain certificate info by calling the getpeercert() method.

    +
    +

    See also

    +

    The documentation for the ssl module.

    +
    +
    +
    +
    +

    Deprecations and Removals

    +
      +
    • String exceptions have been removed. Attempting to use them raises a +TypeError.

    • +
    • Changes to the Exception interface +as dictated by PEP 352 continue to be made. For 2.6, +the message attribute is being deprecated in favor of the +args attribute.

    • +
    • (3.0-warning mode) Python 3.0 will feature a reorganized standard +library that will drop many outdated modules and rename others. +Python 2.6 running in 3.0-warning mode will warn about these modules +when they are imported.

      +

      The list of deprecated modules is: +audiodev, +bgenlocations, +buildtools, +bundlebuilder, +Canvas, +compiler, +dircache, +dl, +fpformat, +gensuitemodule, +ihooks, +imageop, +imgfile, +linuxaudiodev, +mhlib, +mimetools, +multifile, +new, +pure, +statvfs, +sunaudiodev, +test.testall, and +toaiff.

      +
    • +
    • The gopherlib module has been removed.

    • +
    • The MimeWriter module and mimify module +have been deprecated; use the email +package instead.

    • +
    • The md5 module has been deprecated; use the hashlib module +instead.

    • +
    • The posixfile module has been deprecated; fcntl.lockf() +provides better locking.

    • +
    • The popen2 module has been deprecated; use the subprocess +module.

    • +
    • The rgbimg module has been removed.

    • +
    • The sets module has been deprecated; it’s better to +use the built-in set and frozenset types.

    • +
    • The sha module has been deprecated; use the hashlib module +instead.

    • +
    +
    +
    +

    Build and C API Changes

    +

    Changes to Python’s build process and to the C API include:

    +
      +
    • Python now must be compiled with C89 compilers (after 19 +years!). This means that the Python source tree has dropped its +own implementations of memmove() and strerror(), which +are in the C89 standard library.

    • +
    • Python 2.6 can be built with Microsoft Visual Studio 2008 (version +9.0), and this is the new default compiler. See the +PCbuild directory for the build files. (Implemented by +Christian Heimes.)

    • +
    • On Mac OS X, Python 2.6 can be compiled as a 4-way universal build. +The configure script +can take a --with-universal-archs=[32-bit|64-bit|all] +switch, controlling whether the binaries are built for 32-bit +architectures (x86, PowerPC), 64-bit (x86-64 and PPC-64), or both. +(Contributed by Ronald Oussoren.)

    • +
    • The BerkeleyDB module now has a C API object, available as +bsddb.db.api. This object can be used by other C extensions +that wish to use the bsddb module for their own purposes. +(Contributed by Duncan Grisby.)

    • +
    • The new buffer interface, previously described in +the PEP 3118 section, +adds PyObject_GetBuffer() and PyBuffer_Release(), +as well as a few other functions.

    • +
    • Python’s use of the C stdio library is now thread-safe, or at least +as thread-safe as the underlying library is. A long-standing potential +bug occurred if one thread closed a file object while another thread +was reading from or writing to the object. In 2.6 file objects +have a reference count, manipulated by the +PyFile_IncUseCount() and PyFile_DecUseCount() +functions. File objects can’t be closed unless the reference count +is zero. PyFile_IncUseCount() should be called while the GIL +is still held, before carrying out an I/O operation using the +FILE * pointer, and PyFile_DecUseCount() should be called +immediately after the GIL is re-acquired. +(Contributed by Antoine Pitrou and Gregory P. Smith.)

    • +
    • Importing modules simultaneously in two different threads no longer +deadlocks; it will now raise an ImportError. A new API +function, PyImport_ImportModuleNoBlock(), will look for a +module in sys.modules first, then try to import it after +acquiring an import lock. If the import lock is held by another +thread, an ImportError is raised. +(Contributed by Christian Heimes.)

    • +
    • Several functions return information about the platform’s +floating-point support. PyFloat_GetMax() returns +the maximum representable floating point value, +and PyFloat_GetMin() returns the minimum +positive value. PyFloat_GetInfo() returns an object +containing more information from the float.h file, such as +"mant_dig" (number of digits in the mantissa), "epsilon" +(smallest difference between 1.0 and the next largest value +representable), and several others. +(Contributed by Christian Heimes; bpo-1534.)

    • +
    • C functions and methods that use +PyComplex_AsCComplex() will now accept arguments that +have a __complex__() method. In particular, the functions in the +cmath module will now accept objects with this method. +This is a backport of a Python 3.0 change. +(Contributed by Mark Dickinson; bpo-1675423.)

    • +
    • Python’s C API now includes two functions for case-insensitive string +comparisons, PyOS_stricmp(char*, char*) +and PyOS_strnicmp(char*, char*, Py_ssize_t). +(Contributed by Christian Heimes; bpo-1635.)

    • +
    • Many C extensions define their own little macro for adding +integers and strings to the module’s dictionary in the +init* function. Python 2.6 finally defines standard macros +for adding values to a module, PyModule_AddStringMacro +and PyModule_AddIntMacro(). (Contributed by +Christian Heimes.)

    • +
    • Some macros were renamed in both 3.0 and 2.6 to make it clearer that +they are macros, +not functions. Py_Size() became Py_SIZE(), +Py_Type() became Py_TYPE(), and +Py_Refcnt() became Py_REFCNT(). +The mixed-case macros are still available +in Python 2.6 for backward compatibility. +(bpo-1629)

    • +
    • Distutils now places C extensions it builds in a +different directory when running on a debug version of Python. +(Contributed by Collin Winter; bpo-1530959.)

    • +
    • Several basic data types, such as integers and strings, maintain +internal free lists of objects that can be re-used. The data +structures for these free lists now follow a naming convention: the +variable is always named free_list, the counter is always named +numfree, and a macro Py<typename>_MAXFREELIST is +always defined.

    • +
    • A new Makefile target, “make patchcheck”, prepares the Python source tree +for making a patch: it fixes trailing whitespace in all modified +.py files, checks whether the documentation has been changed, +and reports whether the Misc/ACKS and Misc/NEWS files +have been updated. +(Contributed by Brett Cannon.)

      +

      Another new target, “make profile-opt”, compiles a Python binary +using GCC’s profile-guided optimization. It compiles Python with +profiling enabled, runs the test suite to obtain a set of profiling +results, and then compiles using these results for optimization. +(Contributed by Gregory P. Smith.)

      +
    • +
    +
    +

    Port-Specific Changes: Windows

    +
      +
    • The support for Windows 95, 98, ME and NT4 has been dropped. +Python 2.6 requires at least Windows 2000 SP4.

    • +
    • The new default compiler on Windows is Visual Studio 2008 (version +9.0). The build directories for Visual Studio 2003 (version 7.1) and +2005 (version 8.0) were moved into the PC/ directory. The new +PCbuild directory supports cross compilation for X64, debug +builds and Profile Guided Optimization (PGO). PGO builds are roughly +10% faster than normal builds. (Contributed by Christian Heimes +with help from Amaury Forgeot d’Arc and Martin von Löwis.)

    • +
    • The msvcrt module now supports +both the normal and wide char variants of the console I/O +API. The getwch() function reads a keypress and returns a Unicode +value, as does the getwche() function. The putwch() function +takes a Unicode character and writes it to the console. +(Contributed by Christian Heimes.)

    • +
    • os.path.expandvars() will now expand environment variables in +the form “%var%”, and “~user” will be expanded into the user’s home +directory path. (Contributed by Josiah Carlson; bpo-957650.)

    • +
    • The socket module’s socket objects now have an +ioctl() method that provides a limited interface to the +WSAIoctl() system interface.

    • +
    • The _winreg module now has a function, +ExpandEnvironmentStrings(), +that expands environment variable references such as %NAME% +in an input string. The handle objects provided by this +module now support the context protocol, so they can be used +in with statements. (Contributed by Christian Heimes.)

      +

      _winreg also has better support for x64 systems, +exposing the DisableReflectionKey(), EnableReflectionKey(), +and QueryReflectionKey() functions, which enable and disable +registry reflection for 32-bit processes running on 64-bit systems. +(bpo-1753245)

      +
    • +
    • The msilib module’s Record object +gained GetInteger() and GetString() methods that +return field values as an integer or a string. +(Contributed by Floris Bruynooghe; bpo-2125.)

    • +
    +
    +
    +

    Port-Specific Changes: Mac OS X

    +
      +
    • When compiling a framework build of Python, you can now specify the +framework name to be used by providing the +--with-framework-name= option to the +configure script.

    • +
    • The macfs module has been removed. This in turn required the +macostools.touched() function to be removed because it depended on the +macfs module. (bpo-1490190)

    • +
    • Many other Mac OS modules have been deprecated and will be removed in +Python 3.0: +_builtinSuites, +aepack, +aetools, +aetypes, +applesingle, +appletrawmain, +appletrunner, +argvemulator, +Audio_mac, +autoGIL, +Carbon, +cfmfile, +CodeWarrior, +ColorPicker, +EasyDialogs, +Explorer, +Finder, +FrameWork, +findertools, +ic, +icglue, +icopen, +macerrors, +MacOS, +macfs, +macostools, +macresource, +MiniAEFrame, +Nav, +Netscape, +OSATerminology, +pimp, +PixMapWrapper, +StdSuites, +SystemEvents, +Terminal, and +terminalcommand.

    • +
    +
    +
    +

    Port-Specific Changes: IRIX

    +

    A number of old IRIX-specific modules were deprecated and will +be removed in Python 3.0: +al and AL, +cd, +cddb, +cdplayer, +CL and cl, +DEVICE, +ERRNO, +FILE, +FL and fl, +flp, +fm, +GET, +GLWS, +GL and gl, +IN, +IOCTL, +jpeg, +panelparser, +readcd, +SV and sv, +torgb, +videoreader, and +WAIT.

    +
    +
    +
    +

    Porting to Python 2.6

    +

    This section lists previously described changes and other bugfixes +that may require changes to your code:

    +
      +
    • Classes that aren’t supposed to be hashable should +set __hash__ = None in their definitions to indicate +the fact.

    • +
    • String exceptions have been removed. Attempting to use them raises a +TypeError.

    • +
    • The __init__() method of collections.deque +now clears any existing contents of the deque +before adding elements from the iterable. This change makes the +behavior match list.__init__().

    • +
    • object.__init__() previously accepted arbitrary arguments and +keyword arguments, ignoring them. In Python 2.6, this is no longer +allowed and will result in a TypeError. This will affect +__init__() methods that end up calling the corresponding +method on object (perhaps through using super()). +See bpo-1683368 for discussion.

    • +
    • The Decimal constructor now accepts leading and trailing +whitespace when passed a string. Previously it would raise an +InvalidOperation exception. On the other hand, the +create_decimal() method of Context objects now +explicitly disallows extra whitespace, raising a +ConversionSyntax exception.

    • +
    • Due to an implementation accident, if you passed a file path to +the built-in __import__() function, it would actually import +the specified file. This was never intended to work, however, and +the implementation now explicitly checks for this case and raises +an ImportError.

    • +
    • C API: the PyImport_Import() and PyImport_ImportModule() +functions now default to absolute imports, not relative imports. +This will affect C extensions that import other modules.

    • +
    • C API: extension data types that shouldn’t be hashable +should define their tp_hash slot to +PyObject_HashNotImplemented().

    • +
    • The socket module exception socket.error now inherits +from IOError. Previously it wasn’t a subclass of +StandardError but now it is, through IOError. +(Implemented by Gregory P. Smith; bpo-1706815.)

    • +
    • The xmlrpclib module no longer automatically converts +datetime.date and datetime.time to the +xmlrpclib.DateTime type; the conversion semantics were +not necessarily correct for all applications. Code using +xmlrpclib should convert date and time +instances. (bpo-1330538)

    • +
    • (3.0-warning mode) The Exception class now warns +when accessed using slicing or index access; having +Exception behave like a tuple is being phased out.

    • +
    • (3.0-warning mode) inequality comparisons between two dictionaries +or two objects that don’t implement comparison methods are reported +as warnings. dict1 == dict2 still works, but dict1 < dict2 +is being phased out.

      +

      Comparisons between cells, which are an implementation detail of Python’s +scoping rules, also cause warnings because such comparisons are forbidden +entirely in 3.0.

      +
    • +
    +
    +
    +

    Acknowledgements

    +

    The author would like to thank the following people for offering +suggestions, corrections and assistance with various drafts of this +article: Georg Brandl, Steve Brown, Nick Coghlan, Ralph Corderoy, +Jim Jewett, Kent Johnson, Chris Lambacher, Martin Michlmayr, +Antoine Pitrou, Brian Warner.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/whatsnew/2.7.html b/python-3.7.4-docs-html/whatsnew/2.7.html new file mode 100644 index 0000000..27acfd3 --- /dev/null +++ b/python-3.7.4-docs-html/whatsnew/2.7.html @@ -0,0 +1,2622 @@ + + + + + + + What’s New in Python 2.7 — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    What’s New in Python 2.7

    +
    +
    Author
    +

    A.M. Kuchling (amk at amk.ca)

    +
    +
    +

    This article explains the new features in Python 2.7. Python 2.7 was released +on July 3, 2010.

    +

    Numeric handling has been improved in many ways, for both +floating-point numbers and for the Decimal class. +There are some useful additions to the standard library, such as a +greatly enhanced unittest module, the argparse module +for parsing command-line options, convenient OrderedDict +and Counter classes in the collections module, +and many other improvements.

    +

    Python 2.7 is planned to be the last of the 2.x releases, so we worked +on making it a good release for the long term. To help with porting +to Python 3, several new features from the Python 3.x series have been +included in 2.7.

    +

    This article doesn’t attempt to provide a complete specification of +the new features, but instead provides a convenient overview. For +full details, you should refer to the documentation for Python 2.7 at +https://docs.python.org. If you want to understand the rationale for +the design and implementation, refer to the PEP for a particular new +feature or the issue on https://bugs.python.org in which a change was +discussed. Whenever possible, “What’s New in Python” links to the +bug/patch item for each change.

    +
    +

    The Future for Python 2.x

    +

    Python 2.7 is the last major release in the 2.x series, as the Python +maintainers have shifted the focus of their new feature development efforts +to the Python 3.x series. This means that while Python 2 continues to +receive bug fixes, and to be updated to build correctly on new hardware and +versions of supported operated systems, there will be no new full feature +releases for the language or standard library.

    +

    However, while there is a large common subset between Python 2.7 and Python +3, and many of the changes involved in migrating to that common subset, or +directly to Python 3, can be safely automated, some other changes (notably +those associated with Unicode handling) may require careful consideration, +and preferably robust automated regression test suites, to migrate +effectively.

    +

    This means that Python 2.7 will remain in place for a long time, providing a +stable and supported base platform for production systems that have not yet +been ported to Python 3. The full expected lifecycle of the Python 2.7 +series is detailed in PEP 373.

    +

    Some key consequences of the long-term significance of 2.7 are:

    +
      +
    • As noted above, the 2.7 release has a much longer period of maintenance +when compared to earlier 2.x versions. Python 2.7 is currently expected to +remain supported by the core development team (receiving security updates +and other bug fixes) until at least 2020 (10 years after its initial +release, compared to the more typical support period of 18–24 months).

    • +
    • As the Python 2.7 standard library ages, making effective use of the +Python Package Index (either directly or via a redistributor) becomes +more important for Python 2 users. In addition to a wide variety of third +party packages for various tasks, the available packages include backports +of new modules and features from the Python 3 standard library that are +compatible with Python 2, as well as various tools and libraries that can +make it easier to migrate to Python 3. The Python Packaging User Guide provides guidance on downloading and +installing software from the Python Package Index.

    • +
    • While the preferred approach to enhancing Python 2 is now the publication +of new packages on the Python Package Index, this approach doesn’t +necessarily work in all cases, especially those related to network +security. In exceptional cases that cannot be handled adequately by +publishing new or updated packages on PyPI, the Python Enhancement +Proposal process may be used to make the case for adding new features +directly to the Python 2 standard library. Any such additions, and the +maintenance releases where they were added, will be noted in the +New Features Added to Python 2.7 Maintenance Releases section below.

    • +
    +

    For projects wishing to migrate from Python 2 to Python 3, or for library +and framework developers wishing to support users on both Python 2 and +Python 3, there are a variety of tools and guides available to help decide +on a suitable approach and manage some of the technical details involved. +The recommended starting point is the Porting Python 2 Code to Python 3 HOWTO guide.

    +
    +
    +

    Changes to the Handling of Deprecation Warnings

    +

    For Python 2.7, a policy decision was made to silence warnings only of +interest to developers by default. DeprecationWarning and its +descendants are now ignored unless otherwise requested, preventing +users from seeing warnings triggered by an application. This change +was also made in the branch that became Python 3.2. (Discussed +on stdlib-sig and carried out in bpo-7319.)

    +

    In previous releases, DeprecationWarning messages were +enabled by default, providing Python developers with a clear +indication of where their code may break in a future major version +of Python.

    +

    However, there are increasingly many users of Python-based +applications who are not directly involved in the development of +those applications. DeprecationWarning messages are +irrelevant to such users, making them worry about an application +that’s actually working correctly and burdening application developers +with responding to these concerns.

    +

    You can re-enable display of DeprecationWarning messages by +running Python with the -Wdefault (short form: +-Wd) switch, or by setting the PYTHONWARNINGS +environment variable to "default" (or "d") before running +Python. Python code can also re-enable them +by calling warnings.simplefilter('default').

    +

    The unittest module also automatically reenables deprecation warnings +when running tests.

    +
    +
    +

    Python 3.1 Features

    +

    Much as Python 2.6 incorporated features from Python 3.0, +version 2.7 incorporates some of the new features +in Python 3.1. The 2.x series continues to provide tools +for migrating to the 3.x series.

    +

    A partial list of 3.1 features that were backported to 2.7:

    +
      +
    • The syntax for set literals ({1,2,3} is a mutable set).

    • +
    • Dictionary and set comprehensions ({i: i*2 for i in range(3)}).

    • +
    • Multiple context managers in a single with statement.

    • +
    • A new version of the io library, rewritten in C for performance.

    • +
    • The ordered-dictionary type described in PEP 372: Adding an Ordered Dictionary to collections.

    • +
    • The new "," format specifier described in PEP 378: Format Specifier for Thousands Separator.

    • +
    • The memoryview object.

    • +
    • A small subset of the importlib module, +described below.

    • +
    • The repr() of a float x is shorter in many cases: it’s now +based on the shortest decimal string that’s guaranteed to round back +to x. As in previous versions of Python, it’s guaranteed that +float(repr(x)) recovers x.

    • +
    • Float-to-string and string-to-float conversions are correctly rounded. +The round() function is also now correctly rounded.

    • +
    • The PyCapsule type, used to provide a C API for extension modules.

    • +
    • The PyLong_AsLongAndOverflow() C API function.

    • +
    +

    Other new Python3-mode warnings include:

    +
      +
    • operator.isCallable() and operator.sequenceIncludes(), +which are not supported in 3.x, now trigger warnings.

    • +
    • The -3 switch now automatically +enables the -Qwarn switch that causes warnings +about using classic division with integers and long integers.

    • +
    +
    +
    +

    PEP 372: Adding an Ordered Dictionary to collections

    +

    Regular Python dictionaries iterate over key/value pairs in arbitrary order. +Over the years, a number of authors have written alternative implementations +that remember the order that the keys were originally inserted. Based on +the experiences from those implementations, 2.7 introduces a new +OrderedDict class in the collections module.

    +

    The OrderedDict API provides the same interface as regular +dictionaries but iterates over keys and values in a guaranteed order +depending on when a key was first inserted:

    +
    >>> from collections import OrderedDict
    +>>> d = OrderedDict([('first', 1),
    +...                  ('second', 2),
    +...                  ('third', 3)])
    +>>> d.items()
    +[('first', 1), ('second', 2), ('third', 3)]
    +
    +
    +

    If a new entry overwrites an existing entry, the original insertion +position is left unchanged:

    +
    >>> d['second'] = 4
    +>>> d.items()
    +[('first', 1), ('second', 4), ('third', 3)]
    +
    +
    +

    Deleting an entry and reinserting it will move it to the end:

    +
    >>> del d['second']
    +>>> d['second'] = 5
    +>>> d.items()
    +[('first', 1), ('third', 3), ('second', 5)]
    +
    +
    +

    The popitem() method has an optional last +argument that defaults to True. If last is true, the most recently +added key is returned and removed; if it’s false, the +oldest key is selected:

    +
    >>> od = OrderedDict([(x,0) for x in range(20)])
    +>>> od.popitem()
    +(19, 0)
    +>>> od.popitem()
    +(18, 0)
    +>>> od.popitem(last=False)
    +(0, 0)
    +>>> od.popitem(last=False)
    +(1, 0)
    +
    +
    +

    Comparing two ordered dictionaries checks both the keys and values, +and requires that the insertion order was the same:

    +
    >>> od1 = OrderedDict([('first', 1),
    +...                    ('second', 2),
    +...                    ('third', 3)])
    +>>> od2 = OrderedDict([('third', 3),
    +...                    ('first', 1),
    +...                    ('second', 2)])
    +>>> od1 == od2
    +False
    +>>> # Move 'third' key to the end
    +>>> del od2['third']; od2['third'] = 3
    +>>> od1 == od2
    +True
    +
    +
    +

    Comparing an OrderedDict with a regular dictionary +ignores the insertion order and just compares the keys and values.

    +

    How does the OrderedDict work? It maintains a +doubly-linked list of keys, appending new keys to the list as they’re inserted. +A secondary dictionary maps keys to their corresponding list node, so +deletion doesn’t have to traverse the entire linked list and therefore +remains O(1).

    +

    The standard library now supports use of ordered dictionaries in several +modules.

    +
      +
    • The ConfigParser module uses them by default, meaning that +configuration files can now be read, modified, and then written back +in their original order.

    • +
    • The _asdict() method for +collections.namedtuple() now returns an ordered dictionary with the +values appearing in the same order as the underlying tuple indices.

    • +
    • The json module’s JSONDecoder class +constructor was extended with an object_pairs_hook parameter to +allow OrderedDict instances to be built by the decoder. +Support was also added for third-party tools like +PyYAML.

    • +
    +
    +

    See also

    +
    +
    PEP 372 - Adding an ordered dictionary to collections

    PEP written by Armin Ronacher and Raymond Hettinger; +implemented by Raymond Hettinger.

    +
    +
    +
    +
    +
    +

    PEP 378: Format Specifier for Thousands Separator

    +

    To make program output more readable, it can be useful to add +separators to large numbers, rendering them as +18,446,744,073,709,551,616 instead of 18446744073709551616.

    +

    The fully general solution for doing this is the locale module, +which can use different separators (“,” in North America, “.” in +Europe) and different grouping sizes, but locale is complicated +to use and unsuitable for multi-threaded applications where different +threads are producing output for different locales.

    +

    Therefore, a simple comma-grouping mechanism has been added to the +mini-language used by the str.format() method. When +formatting a floating-point number, simply include a comma between the +width and the precision:

    +
    >>> '{:20,.2f}'.format(18446744073709551616.0)
    +'18,446,744,073,709,551,616.00'
    +
    +
    +

    When formatting an integer, include the comma after the width:

    +
    >>> '{:20,d}'.format(18446744073709551616)
    +'18,446,744,073,709,551,616'
    +
    +
    +

    This mechanism is not adaptable at all; commas are always used as the +separator and the grouping is always into three-digit groups. The +comma-formatting mechanism isn’t as general as the locale +module, but it’s easier to use.

    +
    +

    See also

    +
    +
    PEP 378 - Format Specifier for Thousands Separator

    PEP written by Raymond Hettinger; implemented by Eric Smith.

    +
    +
    +
    +
    +
    +

    PEP 389: The argparse Module for Parsing Command Lines

    +

    The argparse module for parsing command-line arguments was +added as a more powerful replacement for the +optparse module.

    +

    This means Python now supports three different modules for parsing +command-line arguments: getopt, optparse, and +argparse. The getopt module closely resembles the C +library’s getopt() function, so it remains useful if you’re writing a +Python prototype that will eventually be rewritten in C. +optparse becomes redundant, but there are no plans to remove it +because there are many scripts still using it, and there’s no +automated way to update these scripts. (Making the argparse +API consistent with optparse’s interface was discussed but +rejected as too messy and difficult.)

    +

    In short, if you’re writing a new script and don’t need to worry +about compatibility with earlier versions of Python, use +argparse instead of optparse.

    +

    Here’s an example:

    +
    import argparse
    +
    +parser = argparse.ArgumentParser(description='Command-line example.')
    +
    +# Add optional switches
    +parser.add_argument('-v', action='store_true', dest='is_verbose',
    +                    help='produce verbose output')
    +parser.add_argument('-o', action='store', dest='output',
    +                    metavar='FILE',
    +                    help='direct output to FILE instead of stdout')
    +parser.add_argument('-C', action='store', type=int, dest='context',
    +                    metavar='NUM', default=0,
    +                    help='display NUM lines of added context')
    +
    +# Allow any number of additional arguments.
    +parser.add_argument(nargs='*', action='store', dest='inputs',
    +                    help='input filenames (default is stdin)')
    +
    +args = parser.parse_args()
    +print args.__dict__
    +
    +
    +

    Unless you override it, -h and --help switches +are automatically added, and produce neatly formatted output:

    +
    -> ./python.exe argparse-example.py --help
    +usage: argparse-example.py [-h] [-v] [-o FILE] [-C NUM] [inputs [inputs ...]]
    +
    +Command-line example.
    +
    +positional arguments:
    +  inputs      input filenames (default is stdin)
    +
    +optional arguments:
    +  -h, --help  show this help message and exit
    +  -v          produce verbose output
    +  -o FILE     direct output to FILE instead of stdout
    +  -C NUM      display NUM lines of added context
    +
    +
    +

    As with optparse, the command-line switches and arguments +are returned as an object with attributes named by the dest parameters:

    +
    -> ./python.exe argparse-example.py -v
    +{'output': None,
    + 'is_verbose': True,
    + 'context': 0,
    + 'inputs': []}
    +
    +-> ./python.exe argparse-example.py -v -o /tmp/output -C 4 file1 file2
    +{'output': '/tmp/output',
    + 'is_verbose': True,
    + 'context': 4,
    + 'inputs': ['file1', 'file2']}
    +
    +
    +

    argparse has much fancier validation than optparse; you +can specify an exact number of arguments as an integer, 0 or more +arguments by passing '*', 1 or more by passing '+', or an +optional argument with '?'. A top-level parser can contain +sub-parsers to define subcommands that have different sets of +switches, as in svn commit, svn checkout, etc. You can +specify an argument’s type as FileType, which will +automatically open files for you and understands that '-' means +standard input or output.

    +
    +

    See also

    +
    +
    argparse documentation

    The documentation page of the argparse module.

    +
    +
    Upgrading optparse code

    Part of the Python documentation, describing how to convert +code that uses optparse.

    +
    +
    PEP 389 - argparse - New Command Line Parsing Module

    PEP written and implemented by Steven Bethard.

    +
    +
    +
    +
    +
    +

    PEP 391: Dictionary-Based Configuration For Logging

    +

    The logging module is very flexible; applications can define +a tree of logging subsystems, and each logger in this tree can filter +out certain messages, format them differently, and direct messages to +a varying number of handlers.

    +

    All this flexibility can require a lot of configuration. You can +write Python statements to create objects and set their properties, +but a complex set-up requires verbose but boring code. +logging also supports a fileConfig() +function that parses a file, but the file format doesn’t support +configuring filters, and it’s messier to generate programmatically.

    +

    Python 2.7 adds a dictConfig() function that +uses a dictionary to configure logging. There are many ways to +produce a dictionary from different sources: construct one with code; +parse a file containing JSON; or use a YAML parsing library if one is +installed. For more information see Configuration functions.

    +

    The following example configures two loggers, the root logger and a +logger named “network”. Messages sent to the root logger will be +sent to the system log using the syslog protocol, and messages +to the “network” logger will be written to a network.log file +that will be rotated once the log reaches 1MB.

    +
    import logging
    +import logging.config
    +
    +configdict = {
    + 'version': 1,    # Configuration schema in use; must be 1 for now
    + 'formatters': {
    +     'standard': {
    +         'format': ('%(asctime)s %(name)-15s '
    +                    '%(levelname)-8s %(message)s')}},
    +
    + 'handlers': {'netlog': {'backupCount': 10,
    +                     'class': 'logging.handlers.RotatingFileHandler',
    +                     'filename': '/logs/network.log',
    +                     'formatter': 'standard',
    +                     'level': 'INFO',
    +                     'maxBytes': 1000000},
    +              'syslog': {'class': 'logging.handlers.SysLogHandler',
    +                         'formatter': 'standard',
    +                         'level': 'ERROR'}},
    +
    + # Specify all the subordinate loggers
    + 'loggers': {
    +             'network': {
    +                         'handlers': ['netlog']
    +             }
    + },
    + # Specify properties of the root logger
    + 'root': {
    +          'handlers': ['syslog']
    + },
    +}
    +
    +# Set up configuration
    +logging.config.dictConfig(configdict)
    +
    +# As an example, log two error messages
    +logger = logging.getLogger('/')
    +logger.error('Database not found')
    +
    +netlogger = logging.getLogger('network')
    +netlogger.error('Connection failed')
    +
    +
    +

    Three smaller enhancements to the logging module, all +implemented by Vinay Sajip, are:

    +
      +
    • The SysLogHandler class now supports +syslogging over TCP. The constructor has a socktype parameter +giving the type of socket to use, either socket.SOCK_DGRAM +for UDP or socket.SOCK_STREAM for TCP. The default +protocol remains UDP.

    • +
    • Logger instances gained a getChild() +method that retrieves a descendant logger using a relative path. +For example, once you retrieve a logger by doing log = getLogger('app'), +calling log.getChild('network.listen') is equivalent to +getLogger('app.network.listen').

    • +
    • The LoggerAdapter class gained an +isEnabledFor() method that takes a +level and returns whether the underlying logger would +process a message of that level of importance.

    • +
    +
    +

    See also

    +
    +
    PEP 391 - Dictionary-Based Configuration For Logging

    PEP written and implemented by Vinay Sajip.

    +
    +
    +
    +
    +
    +

    PEP 3106: Dictionary Views

    +

    The dictionary methods keys(), values(), and +items() are different in Python 3.x. They return an object +called a view instead of a fully materialized list.

    +

    It’s not possible to change the return values of keys(), +values(), and items() in Python 2.7 because +too much code would break. Instead the 3.x versions were added +under the new names viewkeys(), viewvalues(), +and viewitems().

    +
    >>> d = dict((i*10, chr(65+i)) for i in range(26))
    +>>> d
    +{0: 'A', 130: 'N', 10: 'B', 140: 'O', 20: ..., 250: 'Z'}
    +>>> d.viewkeys()
    +dict_keys([0, 130, 10, 140, 20, 150, 30, ..., 250])
    +
    +
    +

    Views can be iterated over, but the key and item views also behave +like sets. The & operator performs intersection, and | +performs a union:

    +
    >>> d1 = dict((i*10, chr(65+i)) for i in range(26))
    +>>> d2 = dict((i**.5, i) for i in range(1000))
    +>>> d1.viewkeys() & d2.viewkeys()
    +set([0.0, 10.0, 20.0, 30.0])
    +>>> d1.viewkeys() | range(0, 30)
    +set([0, 1, 130, 3, 4, 5, 6, ..., 120, 250])
    +
    +
    +

    The view keeps track of the dictionary and its contents change as the +dictionary is modified:

    +
    >>> vk = d.viewkeys()
    +>>> vk
    +dict_keys([0, 130, 10, ..., 250])
    +>>> d[260] = '&'
    +>>> vk
    +dict_keys([0, 130, 260, 10, ..., 250])
    +
    +
    +

    However, note that you can’t add or remove keys while you’re iterating +over the view:

    +
    >>> for k in vk:
    +...     d[k*2] = k
    +...
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +RuntimeError: dictionary changed size during iteration
    +
    +
    +

    You can use the view methods in Python 2.x code, and the 2to3 +converter will change them to the standard keys(), +values(), and items() methods.

    +
    +

    See also

    +
    +
    PEP 3106 - Revamping dict.keys(), .values() and .items()

    PEP written by Guido van Rossum. +Backported to 2.7 by Alexandre Vassalotti; bpo-1967.

    +
    +
    +
    +
    +
    +

    PEP 3137: The memoryview Object

    +

    The memoryview object provides a view of another object’s +memory content that matches the bytes type’s interface.

    +
    >>> import string
    +>>> m = memoryview(string.letters)
    +>>> m
    +<memory at 0x37f850>
    +>>> len(m)           # Returns length of underlying object
    +52
    +>>> m[0], m[25], m[26]   # Indexing returns one byte
    +('a', 'z', 'A')
    +>>> m2 = m[0:26]         # Slicing returns another memoryview
    +>>> m2
    +<memory at 0x37f080>
    +
    +
    +

    The content of the view can be converted to a string of bytes or +a list of integers:

    +
    >>> m2.tobytes()
    +'abcdefghijklmnopqrstuvwxyz'
    +>>> m2.tolist()
    +[97, 98, 99, 100, 101, 102, 103, ... 121, 122]
    +>>>
    +
    +
    +

    memoryview objects allow modifying the underlying object if +it’s a mutable object.

    +
    >>> m2[0] = 75
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +TypeError: cannot modify read-only memory
    +>>> b = bytearray(string.letters)  # Creating a mutable object
    +>>> b
    +bytearray(b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ')
    +>>> mb = memoryview(b)
    +>>> mb[0] = '*'         # Assign to view, changing the bytearray.
    +>>> b[0:5]              # The bytearray has been changed.
    +bytearray(b'*bcde')
    +>>>
    +
    +
    +
    +

    See also

    +
    +
    PEP 3137 - Immutable Bytes and Mutable Buffer

    PEP written by Guido van Rossum. +Implemented by Travis Oliphant, Antoine Pitrou and others. +Backported to 2.7 by Antoine Pitrou; bpo-2396.

    +
    +
    +
    +
    +
    +

    Other Language Changes

    +

    Some smaller changes made to the core Python language are:

    +
      +
    • The syntax for set literals has been backported from Python 3.x. +Curly brackets are used to surround the contents of the resulting +mutable set; set literals are +distinguished from dictionaries by not containing colons and values. +{} continues to represent an empty dictionary; use +set() for an empty set.

      +
      >>> {1, 2, 3, 4, 5}
      +set([1, 2, 3, 4, 5])
      +>>> set() # empty set
      +set([])
      +>>> {}    # empty dict
      +{}
      +
      +
      +

      Backported by Alexandre Vassalotti; bpo-2335.

      +
    • +
    • Dictionary and set comprehensions are another feature backported from +3.x, generalizing list/generator comprehensions to use +the literal syntax for sets and dictionaries.

      +
      >>> {x: x*x for x in range(6)}
      +{0: 0, 1: 1, 2: 4, 3: 9, 4: 16, 5: 25}
      +>>> {('a'*x) for x in range(6)}
      +set(['', 'a', 'aa', 'aaa', 'aaaa', 'aaaaa'])
      +
      +
      +

      Backported by Alexandre Vassalotti; bpo-2333.

      +
    • +
    • The with statement can now use multiple context managers +in one statement. Context managers are processed from left to right +and each one is treated as beginning a new with statement. +This means that:

      +
      with A() as a, B() as b:
      +    ... suite of statements ...
      +
      +
      +

      is equivalent to:

      +
      with A() as a:
      +    with B() as b:
      +        ... suite of statements ...
      +
      +
      +

      The contextlib.nested() function provides a very similar +function, so it’s no longer necessary and has been deprecated.

      +

      (Proposed in https://codereview.appspot.com/53094; implemented by +Georg Brandl.)

      +
    • +
    • Conversions between floating-point numbers and strings are +now correctly rounded on most platforms. These conversions occur +in many different places: str() on +floats and complex numbers; the float and complex +constructors; +numeric formatting; serializing and +deserializing floats and complex numbers using the +marshal, pickle +and json modules; +parsing of float and imaginary literals in Python code; +and Decimal-to-float conversion.

      +

      Related to this, the repr() of a floating-point number x +now returns a result based on the shortest decimal string that’s +guaranteed to round back to x under correct rounding (with +round-half-to-even rounding mode). Previously it gave a string +based on rounding x to 17 decimal digits.

      +

      The rounding library responsible for this improvement works on +Windows and on Unix platforms using the gcc, icc, or suncc +compilers. There may be a small number of platforms where correct +operation of this code cannot be guaranteed, so the code is not +used on such systems. You can find out which code is being used +by checking sys.float_repr_style, which will be short +if the new code is in use and legacy if it isn’t.

      +

      Implemented by Eric Smith and Mark Dickinson, using David Gay’s +dtoa.c library; bpo-7117.

      +
    • +
    • Conversions from long integers and regular integers to floating +point now round differently, returning the floating-point number +closest to the number. This doesn’t matter for small integers that +can be converted exactly, but for large numbers that will +unavoidably lose precision, Python 2.7 now approximates more +closely. For example, Python 2.6 computed the following:

      +
      >>> n = 295147905179352891391
      +>>> float(n)
      +2.9514790517935283e+20
      +>>> n - long(float(n))
      +65535L
      +
      +
      +

      Python 2.7’s floating-point result is larger, but much closer to the +true value:

      +
      >>> n = 295147905179352891391
      +>>> float(n)
      +2.9514790517935289e+20
      +>>> n - long(float(n))
      +-1L
      +
      +
      +

      (Implemented by Mark Dickinson; bpo-3166.)

      +

      Integer division is also more accurate in its rounding behaviours. (Also +implemented by Mark Dickinson; bpo-1811.)

      +
    • +
    • Implicit coercion for complex numbers has been removed; the interpreter +will no longer ever attempt to call a __coerce__() method on complex +objects. (Removed by Meador Inge and Mark Dickinson; bpo-5211.)

    • +
    • The str.format() method now supports automatic numbering of the replacement +fields. This makes using str.format() more closely resemble using +%s formatting:

      +
      >>> '{}:{}:{}'.format(2009, 04, 'Sunday')
      +'2009:4:Sunday'
      +>>> '{}:{}:{day}'.format(2009, 4, day='Sunday')
      +'2009:4:Sunday'
      +
      +
      +

      The auto-numbering takes the fields from left to right, so the first {...} +specifier will use the first argument to str.format(), the next +specifier will use the next argument, and so on. You can’t mix auto-numbering +and explicit numbering – either number all of your specifier fields or none +of them – but you can mix auto-numbering and named fields, as in the second +example above. (Contributed by Eric Smith; bpo-5237.)

      +

      Complex numbers now correctly support usage with format(), +and default to being right-aligned. +Specifying a precision or comma-separation applies to both the real +and imaginary parts of the number, but a specified field width and +alignment is applied to the whole of the resulting 1.5+3j +output. (Contributed by Eric Smith; bpo-1588 and bpo-7988.)

      +

      The ‘F’ format code now always formats its output using uppercase characters, +so it will now produce ‘INF’ and ‘NAN’. +(Contributed by Eric Smith; bpo-3382.)

      +

      A low-level change: the object.__format__() method now triggers +a PendingDeprecationWarning if it’s passed a format string, +because the __format__() method for object converts +the object to a string representation and formats that. Previously +the method silently applied the format string to the string +representation, but that could hide mistakes in Python code. If +you’re supplying formatting information such as an alignment or +precision, presumably you’re expecting the formatting to be applied +in some object-specific way. (Fixed by Eric Smith; bpo-7994.)

      +
    • +
    • The int() and long() types gained a bit_length +method that returns the number of bits necessary to represent +its argument in binary:

      +
      >>> n = 37
      +>>> bin(n)
      +'0b100101'
      +>>> n.bit_length()
      +6
      +>>> n = 2**123-1
      +>>> n.bit_length()
      +123
      +>>> (n+1).bit_length()
      +124
      +
      +
      +

      (Contributed by Fredrik Johansson and Victor Stinner; bpo-3439.)

      +
    • +
    • The import statement will no longer try an absolute import +if a relative import (e.g. from .os import sep) fails. This +fixes a bug, but could possibly break certain import +statements that were only working by accident. (Fixed by Meador Inge; +bpo-7902.)

    • +
    • It’s now possible for a subclass of the built-in unicode type +to override the __unicode__() method. (Implemented by +Victor Stinner; bpo-1583863.)

    • +
    • The bytearray type’s translate() method now accepts +None as its first argument. (Fixed by Georg Brandl; +bpo-4759.)

      +
    • +
    • When using @classmethod and @staticmethod to wrap +methods as class or static methods, the wrapper object now +exposes the wrapped function as their __func__ attribute. +(Contributed by Amaury Forgeot d’Arc, after a suggestion by +George Sakkis; bpo-5982.)

    • +
    • When a restricted set of attributes were set using __slots__, +deleting an unset attribute would not raise AttributeError +as you would expect. Fixed by Benjamin Peterson; bpo-7604.)

    • +
    • Two new encodings are now supported: “cp720”, used primarily for +Arabic text; and “cp858”, a variant of CP 850 that adds the euro +symbol. (CP720 contributed by Alexander Belchenko and Amaury +Forgeot d’Arc in bpo-1616979; CP858 contributed by Tim Hatch in +bpo-8016.)

    • +
    • The file object will now set the filename attribute +on the IOError exception when trying to open a directory +on POSIX platforms (noted by Jan Kaliszewski; bpo-4764), and +now explicitly checks for and forbids writing to read-only file objects +instead of trusting the C library to catch and report the error +(fixed by Stefan Krah; bpo-5677).

    • +
    • The Python tokenizer now translates line endings itself, so the +compile() built-in function now accepts code using any +line-ending convention. Additionally, it no longer requires that the +code end in a newline.

    • +
    • Extra parentheses in function definitions are illegal in Python 3.x, +meaning that you get a syntax error from def f((x)): pass. In +Python3-warning mode, Python 2.7 will now warn about this odd usage. +(Noted by James Lingard; bpo-7362.)

    • +
    • It’s now possible to create weak references to old-style class +objects. New-style classes were always weak-referenceable. (Fixed +by Antoine Pitrou; bpo-8268.)

    • +
    • When a module object is garbage-collected, the module’s dictionary is +now only cleared if no one else is holding a reference to the +dictionary (bpo-7140).

    • +
    +
    +

    Interpreter Changes

    +

    A new environment variable, PYTHONWARNINGS, +allows controlling warnings. It should be set to a string +containing warning settings, equivalent to those +used with the -W switch, separated by commas. +(Contributed by Brian Curtin; bpo-7301.)

    +

    For example, the following setting will print warnings every time +they occur, but turn warnings from the Cookie module into an +error. (The exact syntax for setting an environment variable varies +across operating systems and shells.)

    +
    export PYTHONWARNINGS=all,error:::Cookie:0
    +
    +
    +
    +
    +

    Optimizations

    +

    Several performance enhancements have been added:

    +
      +
    • A new opcode was added to perform the initial setup for +with statements, looking up the __enter__() and +__exit__() methods. (Contributed by Benjamin Peterson.)

    • +
    • The garbage collector now performs better for one common usage +pattern: when many objects are being allocated without deallocating +any of them. This would previously take quadratic +time for garbage collection, but now the number of full garbage collections +is reduced as the number of objects on the heap grows. +The new logic only performs a full garbage collection pass when +the middle generation has been collected 10 times and when the +number of survivor objects from the middle generation exceeds 10% of +the number of objects in the oldest generation. (Suggested by Martin +von Löwis and implemented by Antoine Pitrou; bpo-4074.)

    • +
    • The garbage collector tries to avoid tracking simple containers +which can’t be part of a cycle. In Python 2.7, this is now true for +tuples and dicts containing atomic types (such as ints, strings, +etc.). Transitively, a dict containing tuples of atomic types won’t +be tracked either. This helps reduce the cost of each +garbage collection by decreasing the number of objects to be +considered and traversed by the collector. +(Contributed by Antoine Pitrou; bpo-4688.)

    • +
    • Long integers are now stored internally either in base 2**15 or in base +2**30, the base being determined at build time. Previously, they +were always stored in base 2**15. Using base 2**30 gives +significant performance improvements on 64-bit machines, but +benchmark results on 32-bit machines have been mixed. Therefore, +the default is to use base 2**30 on 64-bit machines and base 2**15 +on 32-bit machines; on Unix, there’s a new configure option +--enable-big-digits that can be used to override this default.

      +

      Apart from the performance improvements this change should be +invisible to end users, with one exception: for testing and +debugging purposes there’s a new structseq sys.long_info that +provides information about the internal format, giving the number of +bits per digit and the size in bytes of the C type used to store +each digit:

      +
      >>> import sys
      +>>> sys.long_info
      +sys.long_info(bits_per_digit=30, sizeof_digit=4)
      +
      +
      +

      (Contributed by Mark Dickinson; bpo-4258.)

      +

      Another set of changes made long objects a few bytes smaller: 2 bytes +smaller on 32-bit systems and 6 bytes on 64-bit. +(Contributed by Mark Dickinson; bpo-5260.)

      +
    • +
    • The division algorithm for long integers has been made faster +by tightening the inner loop, doing shifts instead of multiplications, +and fixing an unnecessary extra iteration. +Various benchmarks show speedups of between 50% and 150% for long +integer divisions and modulo operations. +(Contributed by Mark Dickinson; bpo-5512.) +Bitwise operations are also significantly faster (initial patch by +Gregory Smith; bpo-1087418).

    • +
    • The implementation of % checks for the left-side operand being +a Python string and special-cases it; this results in a 1–3% +performance increase for applications that frequently use % +with strings, such as templating libraries. +(Implemented by Collin Winter; bpo-5176.)

    • +
    • List comprehensions with an if condition are compiled into +faster bytecode. (Patch by Antoine Pitrou, back-ported to 2.7 +by Jeffrey Yasskin; bpo-4715.)

    • +
    • Converting an integer or long integer to a decimal string was made +faster by special-casing base 10 instead of using a generalized +conversion function that supports arbitrary bases. +(Patch by Gawain Bolton; bpo-6713.)

    • +
    • The split(), replace(), rindex(), +rpartition(), and rsplit() methods of string-like types +(strings, Unicode strings, and bytearray objects) now use a +fast reverse-search algorithm instead of a character-by-character +scan. This is sometimes faster by a factor of 10. (Added by +Florent Xicluna; bpo-7462 and bpo-7622.)

    • +
    • The pickle and cPickle modules now automatically +intern the strings used for attribute names, reducing memory usage +of the objects resulting from unpickling. (Contributed by Jake +McGuire; bpo-5084.)

    • +
    • The cPickle module now special-cases dictionaries, +nearly halving the time required to pickle them. +(Contributed by Collin Winter; bpo-5670.)

    • +
    +
    +
    +
    +

    New and Improved Modules

    +

    As in every release, Python’s standard library received a number of +enhancements and bug fixes. Here’s a partial list of the most notable +changes, sorted alphabetically by module name. Consult the +Misc/NEWS file in the source tree for a more complete list of +changes, or look through the Subversion logs for all the details.

    +
      +
    • The bdb module’s base debugging class Bdb +gained a feature for skipping modules. The constructor +now takes an iterable containing glob-style patterns such as +django.*; the debugger will not step into stack frames +from a module that matches one of these patterns. +(Contributed by Maru Newby after a suggestion by +Senthil Kumaran; bpo-5142.)

    • +
    • The binascii module now supports the buffer API, so it can be +used with memoryview instances and other similar buffer objects. +(Backported from 3.x by Florent Xicluna; bpo-7703.)

    • +
    • Updated module: the bsddb module has been updated from 4.7.2devel9 +to version 4.8.4 of +the pybsddb package. +The new version features better Python 3.x compatibility, various bug fixes, +and adds several new BerkeleyDB flags and methods. +(Updated by Jesús Cea Avión; bpo-8156. The pybsddb +changelog can be read at http://hg.jcea.es/pybsddb/file/tip/ChangeLog.)

    • +
    • The bz2 module’s BZ2File now supports the context +management protocol, so you can write with bz2.BZ2File(...) as f:. +(Contributed by Hagen Fürstenau; bpo-3860.)

    • +
    • New class: the Counter class in the collections +module is useful for tallying data. Counter instances +behave mostly like dictionaries but return zero for missing keys instead of +raising a KeyError:

      +
      >>> from collections import Counter
      +>>> c = Counter()
      +>>> for letter in 'here is a sample of english text':
      +...   c[letter] += 1
      +...
      +>>> c 
      +Counter({' ': 6, 'e': 5, 's': 3, 'a': 2, 'i': 2, 'h': 2,
      +'l': 2, 't': 2, 'g': 1, 'f': 1, 'm': 1, 'o': 1, 'n': 1,
      +'p': 1, 'r': 1, 'x': 1})
      +>>> c['e']
      +5
      +>>> c['z']
      +0
      +
      +
      +

      There are three additional Counter methods. +most_common() returns the N most common +elements and their counts. elements() +returns an iterator over the contained elements, repeating each +element as many times as its count. +subtract() takes an iterable and +subtracts one for each element instead of adding; if the argument is +a dictionary or another Counter, the counts are +subtracted.

      +
      >>> c.most_common(5)
      +[(' ', 6), ('e', 5), ('s', 3), ('a', 2), ('i', 2)]
      +>>> c.elements() ->
      +   'a', 'a', ' ', ' ', ' ', ' ', ' ', ' ',
      +   'e', 'e', 'e', 'e', 'e', 'g', 'f', 'i', 'i',
      +   'h', 'h', 'm', 'l', 'l', 'o', 'n', 'p', 's',
      +   's', 's', 'r', 't', 't', 'x'
      +>>> c['e']
      +5
      +>>> c.subtract('very heavy on the letter e')
      +>>> c['e']    # Count is now lower
      +-1
      +
      +
      +

      Contributed by Raymond Hettinger; bpo-1696199.

      +

      New class: OrderedDict is described in the earlier +section PEP 372: Adding an Ordered Dictionary to collections.

      +

      New method: The deque data type now has a +count() method that returns the number of +contained elements equal to the supplied argument x, and a +reverse() method that reverses the elements +of the deque in-place. deque also exposes its maximum +length as the read-only maxlen attribute. +(Both features added by Raymond Hettinger.)

      +

      The namedtuple class now has an optional rename parameter. +If rename is true, field names that are invalid because they’ve +been repeated or aren’t legal Python identifiers will be +renamed to legal names that are derived from the field’s +position within the list of fields:

      +
      >>> from collections import namedtuple
      +>>> T = namedtuple('T', ['field1', '$illegal', 'for', 'field2'], rename=True)
      +>>> T._fields
      +('field1', '_1', '_2', 'field2')
      +
      +
      +

      (Added by Raymond Hettinger; bpo-1818.)

      +

      Finally, the Mapping abstract base class now +returns NotImplemented if a mapping is compared to +another type that isn’t a Mapping. +(Fixed by Daniel Stutzbach; bpo-8729.)

      +
    • +
    • Constructors for the parsing classes in the ConfigParser module now +take an allow_no_value parameter, defaulting to false; if true, +options without values will be allowed. For example:

      +
      >>> import ConfigParser, StringIO
      +>>> sample_config = """
      +... [mysqld]
      +... user = mysql
      +... pid-file = /var/run/mysqld/mysqld.pid
      +... skip-bdb
      +... """
      +>>> config = ConfigParser.RawConfigParser(allow_no_value=True)
      +>>> config.readfp(StringIO.StringIO(sample_config))
      +>>> config.get('mysqld', 'user')
      +'mysql'
      +>>> print config.get('mysqld', 'skip-bdb')
      +None
      +>>> print config.get('mysqld', 'unknown')
      +Traceback (most recent call last):
      +  ...
      +NoOptionError: No option 'unknown' in section: 'mysqld'
      +
      +
      +

      (Contributed by Mats Kindahl; bpo-7005.)

      +
    • +
    • Deprecated function: contextlib.nested(), which allows +handling more than one context manager with a single with +statement, has been deprecated, because the with statement +now supports multiple context managers.

    • +
    • The cookielib module now ignores cookies that have an invalid +version field, one that doesn’t contain an integer value. (Fixed by +John J. Lee; bpo-3924.)

    • +
    • The copy module’s deepcopy() function will now +correctly copy bound instance methods. (Implemented by +Robert Collins; bpo-1515.)

    • +
    • The ctypes module now always converts None to a C NULL +pointer for arguments declared as pointers. (Changed by Thomas +Heller; bpo-4606.) The underlying libffi library has been updated to version +3.0.9, containing various fixes for different platforms. (Updated +by Matthias Klose; bpo-8142.)

    • +
    • New method: the datetime module’s timedelta class +gained a total_seconds() method that returns the +number of seconds in the duration. (Contributed by Brian Quinlan; bpo-5788.)

    • +
    • New method: the Decimal class gained a +from_float() class method that performs an exact +conversion of a floating-point number to a Decimal. +This exact conversion strives for the +closest decimal approximation to the floating-point representation’s value; +the resulting decimal value will therefore still include the inaccuracy, +if any. +For example, Decimal.from_float(0.1) returns +Decimal('0.1000000000000000055511151231257827021181583404541015625'). +(Implemented by Raymond Hettinger; bpo-4796.)

      +

      Comparing instances of Decimal with floating-point +numbers now produces sensible results based on the numeric values +of the operands. Previously such comparisons would fall back to +Python’s default rules for comparing objects, which produced arbitrary +results based on their type. Note that you still cannot combine +Decimal and floating-point in other operations such as addition, +since you should be explicitly choosing how to convert between float and +Decimal. (Fixed by Mark Dickinson; bpo-2531.)

      +

      The constructor for Decimal now accepts +floating-point numbers (added by Raymond Hettinger; bpo-8257) +and non-European Unicode characters such as Arabic-Indic digits +(contributed by Mark Dickinson; bpo-6595).

      +

      Most of the methods of the Context class now accept integers +as well as Decimal instances; the only exceptions are the +canonical() and is_canonical() +methods. (Patch by Juan José Conti; bpo-7633.)

      +

      When using Decimal instances with a string’s +format() method, the default alignment was previously +left-alignment. This has been changed to right-alignment, which is +more sensible for numeric types. (Changed by Mark Dickinson; bpo-6857.)

      +

      Comparisons involving a signaling NaN value (or sNAN) now signal +InvalidOperation instead of silently returning a true or +false value depending on the comparison operator. Quiet NaN values +(or NaN) are now hashable. (Fixed by Mark Dickinson; +bpo-7279.)

      +
    • +
    • The difflib module now produces output that is more +compatible with modern diff/patch tools +through one small change, using a tab character instead of spaces as +a separator in the header giving the filename. (Fixed by Anatoly +Techtonik; bpo-7585.)

    • +
    • The Distutils sdist command now always regenerates the +MANIFEST file, since even if the MANIFEST.in or +setup.py files haven’t been modified, the user might have +created some new files that should be included. +(Fixed by Tarek Ziadé; bpo-8688.)

    • +
    • The doctest module’s IGNORE_EXCEPTION_DETAIL flag +will now ignore the name of the module containing the exception +being tested. (Patch by Lennart Regebro; bpo-7490.)

    • +
    • The email module’s Message class will +now accept a Unicode-valued payload, automatically converting the +payload to the encoding specified by output_charset. +(Added by R. David Murray; bpo-1368247.)

    • +
    • The Fraction class now accepts a single float or +Decimal instance, or two rational numbers, as +arguments to its constructor. (Implemented by Mark Dickinson; +rationals added in bpo-5812, and float/decimal in +bpo-8294.)

      +

      Ordering comparisons (<, <=, >, >=) between +fractions and complex numbers now raise a TypeError. +This fixes an oversight, making the Fraction +match the other numeric types.

      +
    • +
    • New class: FTP_TLS in +the ftplib module provides secure FTP +connections using TLS encapsulation of authentication as well as +subsequent control and data transfers. +(Contributed by Giampaolo Rodola; bpo-2054.)

      +

      The storbinary() method for binary uploads can now restart +uploads thanks to an added rest parameter (patch by Pablo Mouzo; +bpo-6845.)

      +
    • +
    • New class decorator: total_ordering() in the functools +module takes a class that defines an __eq__() method and one of +__lt__(), __le__(), __gt__(), or __ge__(), +and generates the missing comparison methods. Since the +__cmp__() method is being deprecated in Python 3.x, +this decorator makes it easier to define ordered classes. +(Added by Raymond Hettinger; bpo-5479.)

      +

      New function: cmp_to_key() will take an old-style comparison +function that expects two arguments and return a new callable that +can be used as the key parameter to functions such as +sorted(), min() and max(), etc. The primary +intended use is to help with making code compatible with Python 3.x. +(Added by Raymond Hettinger.)

      +
    • +
    • New function: the gc module’s is_tracked() returns +true if a given instance is tracked by the garbage collector, false +otherwise. (Contributed by Antoine Pitrou; bpo-4688.)

    • +
    • The gzip module’s GzipFile now supports the context +management protocol, so you can write with gzip.GzipFile(...) as f: +(contributed by Hagen Fürstenau; bpo-3860), and it now implements +the io.BufferedIOBase ABC, so you can wrap it with +io.BufferedReader for faster processing +(contributed by Nir Aides; bpo-7471). +It’s also now possible to override the modification time +recorded in a gzipped file by providing an optional timestamp to +the constructor. (Contributed by Jacques Frechet; bpo-4272.)

      +

      Files in gzip format can be padded with trailing zero bytes; the +gzip module will now consume these trailing bytes. (Fixed by +Tadek Pietraszek and Brian Curtin; bpo-2846.)

      +
    • +
    • New attribute: the hashlib module now has an algorithms +attribute containing a tuple naming the supported algorithms. +In Python 2.7, hashlib.algorithms contains +('md5', 'sha1', 'sha224', 'sha256', 'sha384', 'sha512'). +(Contributed by Carl Chenet; bpo-7418.)

    • +
    • The default HTTPResponse class used by the httplib module now +supports buffering, resulting in much faster reading of HTTP responses. +(Contributed by Kristján Valur Jónsson; bpo-4879.)

      +

      The HTTPConnection and HTTPSConnection classes +now support a source_address parameter, a (host, port) 2-tuple +giving the source address that will be used for the connection. +(Contributed by Eldon Ziegler; bpo-3972.)

      +
    • +
    • The ihooks module now supports relative imports. Note that +ihooks is an older module for customizing imports, +superseded by the imputil module added in Python 2.0. +(Relative import support added by Neil Schemenauer.)

      +
    • +
    • The imaplib module now supports IPv6 addresses. +(Contributed by Derek Morr; bpo-1655.)

    • +
    • New function: the inspect module’s getcallargs() +takes a callable and its positional and keyword arguments, +and figures out which of the callable’s parameters will receive each argument, +returning a dictionary mapping argument names to their values. For example:

      +
      >>> from inspect import getcallargs
      +>>> def f(a, b=1, *pos, **named):
      +...     pass
      +>>> getcallargs(f, 1, 2, 3)
      +{'a': 1, 'b': 2, 'pos': (3,), 'named': {}}
      +>>> getcallargs(f, a=2, x=4)
      +{'a': 2, 'b': 1, 'pos': (), 'named': {'x': 4}}
      +>>> getcallargs(f)
      +Traceback (most recent call last):
      +...
      +TypeError: f() takes at least 1 argument (0 given)
      +
      +
      +

      Contributed by George Sakkis; bpo-3135.

      +
    • +
    • Updated module: The io library has been upgraded to the version shipped with +Python 3.1. For 3.1, the I/O library was entirely rewritten in C +and is 2 to 20 times faster depending on the task being performed. The +original Python version was renamed to the _pyio module.

      +

      One minor resulting change: the io.TextIOBase class now +has an errors attribute giving the error setting +used for encoding and decoding errors (one of 'strict', 'replace', +'ignore').

      +

      The io.FileIO class now raises an OSError when passed +an invalid file descriptor. (Implemented by Benjamin Peterson; +bpo-4991.) The truncate() method now preserves the +file position; previously it would change the file position to the +end of the new file. (Fixed by Pascal Chambon; bpo-6939.)

      +
    • +
    • New function: itertools.compress(data, selectors) takes two +iterators. Elements of data are returned if the corresponding +value in selectors is true:

      +
      itertools.compress('ABCDEF', [1,0,1,0,1,1]) =>
      +  A, C, E, F
      +
      +
      +

      New function: itertools.combinations_with_replacement(iter, r) +returns all the possible r-length combinations of elements from the +iterable iter. Unlike combinations(), individual elements +can be repeated in the generated combinations:

      +
      itertools.combinations_with_replacement('abc', 2) =>
      +  ('a', 'a'), ('a', 'b'), ('a', 'c'),
      +  ('b', 'b'), ('b', 'c'), ('c', 'c')
      +
      +
      +

      Note that elements are treated as unique depending on their position +in the input, not their actual values.

      +

      The itertools.count() function now has a step argument that +allows incrementing by values other than 1. count() also +now allows keyword arguments, and using non-integer values such as +floats or Decimal instances. (Implemented by Raymond +Hettinger; bpo-5032.)

      +

      itertools.combinations() and itertools.product() +previously raised ValueError for values of r larger than +the input iterable. This was deemed a specification error, so they +now return an empty iterator. (Fixed by Raymond Hettinger; bpo-4816.)

      +
    • +
    • Updated module: The json module was upgraded to version 2.0.9 of the +simplejson package, which includes a C extension that makes +encoding and decoding faster. +(Contributed by Bob Ippolito; bpo-4136.)

      +

      To support the new collections.OrderedDict type, json.load() +now has an optional object_pairs_hook parameter that will be called +with any object literal that decodes to a list of pairs. +(Contributed by Raymond Hettinger; bpo-5381.)

      +
    • +
    • The mailbox module’s Maildir class now records the +timestamp on the directories it reads, and only re-reads them if the +modification time has subsequently changed. This improves +performance by avoiding unneeded directory scans. (Fixed by +A.M. Kuchling and Antoine Pitrou; bpo-1607951, bpo-6896.)

    • +
    • New functions: the math module gained +erf() and erfc() for the error function and the complementary error function, +expm1() which computes e**x - 1 with more precision than +using exp() and subtracting 1, +gamma() for the Gamma function, and +lgamma() for the natural log of the Gamma function. +(Contributed by Mark Dickinson and nirinA raseliarison; bpo-3366.)

    • +
    • The multiprocessing module’s Manager* classes +can now be passed a callable that will be called whenever +a subprocess is started, along with a set of arguments that will be +passed to the callable. +(Contributed by lekma; bpo-5585.)

      +

      The Pool class, which controls a pool of worker processes, +now has an optional maxtasksperchild parameter. Worker processes +will perform the specified number of tasks and then exit, causing the +Pool to start a new worker. This is useful if tasks may leak +memory or other resources, or if some tasks will cause the worker to +become very large. +(Contributed by Charles Cazabon; bpo-6963.)

      +
    • +
    • The nntplib module now supports IPv6 addresses. +(Contributed by Derek Morr; bpo-1664.)

    • +
    • New functions: the os module wraps the following POSIX system +calls: getresgid() and getresuid(), which return the +real, effective, and saved GIDs and UIDs; +setresgid() and setresuid(), which set +real, effective, and saved GIDs and UIDs to new values; +initgroups(), which initialize the group access list +for the current process. (GID/UID functions +contributed by Travis H.; bpo-6508. Support for initgroups added +by Jean-Paul Calderone; bpo-7333.)

      +

      The os.fork() function now re-initializes the import lock in +the child process; this fixes problems on Solaris when fork() +is called from a thread. (Fixed by Zsolt Cserna; bpo-7242.)

      +
    • +
    • In the os.path module, the normpath() and +abspath() functions now preserve Unicode; if their input path +is a Unicode string, the return value is also a Unicode string. +(normpath() fixed by Matt Giuca in bpo-5827; +abspath() fixed by Ezio Melotti in bpo-3426.)

    • +
    • The pydoc module now has help for the various symbols that Python +uses. You can now do help('<<') or help('@'), for example. +(Contributed by David Laban; bpo-4739.)

    • +
    • The re module’s split(), sub(), and subn() +now accept an optional flags argument, for consistency with the +other functions in the module. (Added by Gregory P. Smith.)

    • +
    • New function: run_path() in the runpy module +will execute the code at a provided path argument. path can be +the path of a Python source file (example.py), a compiled +bytecode file (example.pyc), a directory +(./package/), or a zip archive (example.zip). If a +directory or zip path is provided, it will be added to the front of +sys.path and the module __main__ will be imported. It’s +expected that the directory or zip contains a __main__.py; +if it doesn’t, some other __main__.py might be imported from +a location later in sys.path. This makes more of the machinery +of runpy available to scripts that want to mimic the way +Python’s command line processes an explicit path name. +(Added by Nick Coghlan; bpo-6816.)

    • +
    • New function: in the shutil module, make_archive() +takes a filename, archive type (zip or tar-format), and a directory +path, and creates an archive containing the directory’s contents. +(Added by Tarek Ziadé.)

      +

      shutil’s copyfile() and copytree() +functions now raise a SpecialFileError exception when +asked to copy a named pipe. Previously the code would treat +named pipes like a regular file by opening them for reading, and +this would block indefinitely. (Fixed by Antoine Pitrou; bpo-3002.)

      +
    • +
    • The signal module no longer re-installs the signal handler +unless this is truly necessary, which fixes a bug that could make it +impossible to catch the EINTR signal robustly. (Fixed by +Charles-Francois Natali; bpo-8354.)

    • +
    • New functions: in the site module, three new functions +return various site- and user-specific paths. +getsitepackages() returns a list containing all +global site-packages directories, +getusersitepackages() returns the path of the user’s +site-packages directory, and +getuserbase() returns the value of the USER_BASE +environment variable, giving the path to a directory that can be used +to store data. +(Contributed by Tarek Ziadé; bpo-6693.)

      +

      The site module now reports exceptions occurring +when the sitecustomize module is imported, and will no longer +catch and swallow the KeyboardInterrupt exception. (Fixed by +Victor Stinner; bpo-3137.)

      +
    • +
    • The create_connection() function +gained a source_address parameter, a (host, port) 2-tuple +giving the source address that will be used for the connection. +(Contributed by Eldon Ziegler; bpo-3972.)

      +

      The recv_into() and recvfrom_into() +methods will now write into objects that support the buffer API, most usefully +the bytearray and memoryview objects. (Implemented by +Antoine Pitrou; bpo-8104.)

      +
    • +
    • The SocketServer module’s TCPServer class now +supports socket timeouts and disabling the Nagle algorithm. +The disable_nagle_algorithm class attribute +defaults to False; if overridden to be true, +new request connections will have the TCP_NODELAY option set to +prevent buffering many small sends into a single TCP packet. +The timeout class attribute can hold +a timeout in seconds that will be applied to the request socket; if +no request is received within that time, handle_timeout() +will be called and handle_request() will return. +(Contributed by Kristján Valur Jónsson; bpo-6192 and bpo-6267.)

    • +
    • Updated module: the sqlite3 module has been updated to +version 2.6.0 of the pysqlite package. Version 2.6.0 includes a number of bugfixes, and adds +the ability to load SQLite extensions from shared libraries. +Call the enable_load_extension(True) method to enable extensions, +and then call load_extension() to load a particular shared library. +(Updated by Gerhard Häring.)

    • +
    • The ssl module’s SSLSocket objects now support the +buffer API, which fixed a test suite failure (fix by Antoine Pitrou; +bpo-7133) and automatically set +OpenSSL’s SSL_MODE_AUTO_RETRY, which will prevent an error +code being returned from recv() operations that trigger an SSL +renegotiation (fix by Antoine Pitrou; bpo-8222).

      +

      The ssl.wrap_socket() constructor function now takes a +ciphers argument that’s a string listing the encryption algorithms +to be allowed; the format of the string is described +in the OpenSSL documentation. +(Added by Antoine Pitrou; bpo-8322.)

      +

      Another change makes the extension load all of OpenSSL’s ciphers and +digest algorithms so that they’re all available. Some SSL +certificates couldn’t be verified, reporting an “unknown algorithm” +error. (Reported by Beda Kosata, and fixed by Antoine Pitrou; +bpo-8484.)

      +

      The version of OpenSSL being used is now available as the module +attributes ssl.OPENSSL_VERSION (a string), +ssl.OPENSSL_VERSION_INFO (a 5-tuple), and +ssl.OPENSSL_VERSION_NUMBER (an integer). (Added by Antoine +Pitrou; bpo-8321.)

      +
    • +
    • The struct module will no longer silently ignore overflow +errors when a value is too large for a particular integer format +code (one of bBhHiIlLqQ); it now always raises a +struct.error exception. (Changed by Mark Dickinson; +bpo-1523.) The pack() function will also +attempt to use __index__() to convert and pack non-integers +before trying the __int__() method or reporting an error. +(Changed by Mark Dickinson; bpo-8300.)

    • +
    • New function: the subprocess module’s +check_output() runs a command with a specified set of arguments +and returns the command’s output as a string when the command runs without +error, or raises a CalledProcessError exception otherwise.

      +
      >>> subprocess.check_output(['df', '-h', '.'])
      +'Filesystem     Size   Used  Avail Capacity  Mounted on\n
      +/dev/disk0s2    52G    49G   3.0G    94%    /\n'
      +
      +>>> subprocess.check_output(['df', '-h', '/bogus'])
      +  ...
      +subprocess.CalledProcessError: Command '['df', '-h', '/bogus']' returned non-zero exit status 1
      +
      +
      +

      (Contributed by Gregory P. Smith.)

      +

      The subprocess module will now retry its internal system calls +on receiving an EINTR signal. (Reported by several people; final +patch by Gregory P. Smith in bpo-1068268.)

      +
    • +
    • New function: is_declared_global() in the symtable module +returns true for variables that are explicitly declared to be global, +false for ones that are implicitly global. +(Contributed by Jeremy Hylton.)

    • +
    • The syslog module will now use the value of sys.argv[0] as the +identifier instead of the previous default value of 'python'. +(Changed by Sean Reifschneider; bpo-8451.)

    • +
    • The sys.version_info value is now a named tuple, with attributes +named major, minor, micro, +releaselevel, and serial. (Contributed by Ross +Light; bpo-4285.)

      +

      sys.getwindowsversion() also returns a named tuple, +with attributes named major, minor, build, +platform, service_pack, service_pack_major, +service_pack_minor, suite_mask, and +product_type. (Contributed by Brian Curtin; bpo-7766.)

      +
    • +
    • The tarfile module’s default error handling has changed, to +no longer suppress fatal errors. The default error level was previously 0, +which meant that errors would only result in a message being written to the +debug log, but because the debug log is not activated by default, +these errors go unnoticed. The default error level is now 1, +which raises an exception if there’s an error. +(Changed by Lars Gustäbel; bpo-7357.)

      +

      tarfile now supports filtering the TarInfo +objects being added to a tar file. When you call add(), +you may supply an optional filter argument +that’s a callable. The filter callable will be passed the +TarInfo for every file being added, and can modify and return it. +If the callable returns None, the file will be excluded from the +resulting archive. This is more powerful than the existing +exclude argument, which has therefore been deprecated. +(Added by Lars Gustäbel; bpo-6856.) +The TarFile class also now supports the context management protocol. +(Added by Lars Gustäbel; bpo-7232.)

      +
    • +
    • The wait() method of the threading.Event class +now returns the internal flag on exit. This means the method will usually +return true because wait() is supposed to block until the +internal flag becomes true. The return value will only be false if +a timeout was provided and the operation timed out. +(Contributed by Tim Lesher; bpo-1674032.)

    • +
    • The Unicode database provided by the unicodedata module is +now used internally to determine which characters are numeric, +whitespace, or represent line breaks. The database also +includes information from the Unihan.txt data file (patch +by Anders Chrigström and Amaury Forgeot d’Arc; bpo-1571184) +and has been updated to version 5.2.0 (updated by +Florent Xicluna; bpo-8024).

    • +
    • The urlparse module’s urlsplit() now handles +unknown URL schemes in a fashion compliant with RFC 3986: if the +URL is of the form "<something>://...", the text before the +:// is treated as the scheme, even if it’s a made-up scheme that +the module doesn’t know about. This change may break code that +worked around the old behaviour. For example, Python 2.6.4 or 2.5 +will return the following:

      +
      >>> import urlparse
      +>>> urlparse.urlsplit('invented://host/filename?query')
      +('invented', '', '//host/filename?query', '', '')
      +
      +
      +

      Python 2.7 (and Python 2.6.5) will return:

      +
      >>> import urlparse
      +>>> urlparse.urlsplit('invented://host/filename?query')
      +('invented', 'host', '/filename?query', '', '')
      +
      +
      +

      (Python 2.7 actually produces slightly different output, since it +returns a named tuple instead of a standard tuple.)

      +

      The urlparse module also supports IPv6 literal addresses as defined by +RFC 2732 (contributed by Senthil Kumaran; bpo-2987).

      +
      >>> urlparse.urlparse('http://[1080::8:800:200C:417A]/foo')
      +ParseResult(scheme='http', netloc='[1080::8:800:200C:417A]',
      +            path='/foo', params='', query='', fragment='')
      +
      +
      +
    • +
    • New class: the WeakSet class in the weakref +module is a set that only holds weak references to its elements; elements +will be removed once there are no references pointing to them. +(Originally implemented in Python 3.x by Raymond Hettinger, and backported +to 2.7 by Michael Foord.)

    • +
    • The ElementTree library, xml.etree, no longer escapes +ampersands and angle brackets when outputting an XML processing +instruction (which looks like <?xml-stylesheet href="#style1"?>) +or comment (which looks like <!-- comment -->). +(Patch by Neil Muller; bpo-2746.)

    • +
    • The XML-RPC client and server, provided by the xmlrpclib and +SimpleXMLRPCServer modules, have improved performance by +supporting HTTP/1.1 keep-alive and by optionally using gzip encoding +to compress the XML being exchanged. The gzip compression is +controlled by the encode_threshold attribute of +SimpleXMLRPCRequestHandler, which contains a size in bytes; +responses larger than this will be compressed. +(Contributed by Kristján Valur Jónsson; bpo-6267.)

    • +
    • The zipfile module’s ZipFile now supports the context +management protocol, so you can write with zipfile.ZipFile(...) as f:. +(Contributed by Brian Curtin; bpo-5511.)

      +

      zipfile now also supports archiving empty directories and +extracts them correctly. (Fixed by Kuba Wieczorek; bpo-4710.) +Reading files out of an archive is faster, and interleaving +read() and readline() now works correctly. +(Contributed by Nir Aides; bpo-7610.)

      +

      The is_zipfile() function now +accepts a file object, in addition to the path names accepted in earlier +versions. (Contributed by Gabriel Genellina; bpo-4756.)

      +

      The writestr() method now has an optional compress_type parameter +that lets you override the default compression method specified in the +ZipFile constructor. (Contributed by Ronald Oussoren; +bpo-6003.)

      +
    • +
    +
    +

    New module: importlib

    +

    Python 3.1 includes the importlib package, a re-implementation +of the logic underlying Python’s import statement. +importlib is useful for implementors of Python interpreters and +to users who wish to write new importers that can participate in the +import process. Python 2.7 doesn’t contain the complete +importlib package, but instead has a tiny subset that contains +a single function, import_module().

    +

    import_module(name, package=None) imports a module. name is +a string containing the module or package’s name. It’s possible to do +relative imports by providing a string that begins with a . +character, such as ..utils.errors. For relative imports, the +package argument must be provided and is the name of the package that +will be used as the anchor for +the relative import. import_module() both inserts the imported +module into sys.modules and returns the module object.

    +

    Here are some examples:

    +
    >>> from importlib import import_module
    +>>> anydbm = import_module('anydbm')  # Standard absolute import
    +>>> anydbm
    +<module 'anydbm' from '/p/python/Lib/anydbm.py'>
    +>>> # Relative import
    +>>> file_util = import_module('..file_util', 'distutils.command')
    +>>> file_util
    +<module 'distutils.file_util' from '/python/Lib/distutils/file_util.pyc'>
    +
    +
    +

    importlib was implemented by Brett Cannon and introduced in +Python 3.1.

    +
    +
    +

    New module: sysconfig

    +

    The sysconfig module has been pulled out of the Distutils +package, becoming a new top-level module in its own right. +sysconfig provides functions for getting information about +Python’s build process: compiler switches, installation paths, the +platform name, and whether Python is running from its source +directory.

    +

    Some of the functions in the module are:

    +
      +
    • get_config_var() returns variables from Python’s +Makefile and the pyconfig.h file.

    • +
    • get_config_vars() returns a dictionary containing +all of the configuration variables.

    • +
    • get_path() returns the configured path for +a particular type of module: the standard library, +site-specific modules, platform-specific modules, etc.

    • +
    • is_python_build() returns true if you’re running a +binary from a Python source tree, and false otherwise.

    • +
    +

    Consult the sysconfig documentation for more details and for +a complete list of functions.

    +

    The Distutils package and sysconfig are now maintained by Tarek +Ziadé, who has also started a Distutils2 package (source repository at +https://hg.python.org/distutils2/) for developing a next-generation +version of Distutils.

    +
    +
    +

    ttk: Themed Widgets for Tk

    +

    Tcl/Tk 8.5 includes a set of themed widgets that re-implement basic Tk +widgets but have a more customizable appearance and can therefore more +closely resemble the native platform’s widgets. This widget +set was originally called Tile, but was renamed to Ttk (for “themed Tk”) +on being added to Tcl/Tck release 8.5.

    +

    To learn more, read the ttk module documentation. You may also +wish to read the Tcl/Tk manual page describing the +Ttk theme engine, available at +https://www.tcl.tk/man/tcl8.5/TkCmd/ttk_intro.htm. Some +screenshots of the Python/Ttk code in use are at +https://code.google.com/archive/p/python-ttk/wikis/Screenshots.wiki.

    +

    The ttk module was written by Guilherme Polo and added in +bpo-2983. An alternate version called Tile.py, written by +Martin Franklin and maintained by Kevin Walzer, was proposed for +inclusion in bpo-2618, but the authors argued that Guilherme +Polo’s work was more comprehensive.

    +
    +
    +

    Updated module: unittest

    +

    The unittest module was greatly enhanced; many +new features were added. Most of these features were implemented +by Michael Foord, unless otherwise noted. The enhanced version of +the module is downloadable separately for use with Python versions 2.4 to 2.6, +packaged as the unittest2 package, from +https://pypi.org/project/unittest2.

    +

    When used from the command line, the module can automatically discover +tests. It’s not as fancy as py.test or +nose, but provides a +simple way to run tests kept within a set of package directories. For example, +the following command will search the test/ subdirectory for +any importable test files named test*.py:

    +
    python -m unittest discover -s test
    +
    +
    +

    Consult the unittest module documentation for more details. +(Developed in bpo-6001.)

    +

    The main() function supports some other new options:

    +
      +
    • -b or --buffer will buffer the standard output +and standard error streams during each test. If the test passes, +any resulting output will be discarded; on failure, the buffered +output will be displayed.

    • +
    • -c or --catch will cause the control-C interrupt +to be handled more gracefully. Instead of interrupting the test +process immediately, the currently running test will be completed +and then the partial results up to the interruption will be reported. +If you’re impatient, a second press of control-C will cause an immediate +interruption.

      +

      This control-C handler tries to avoid causing problems when the code +being tested or the tests being run have defined a signal handler of +their own, by noticing that a signal handler was already set and +calling it. If this doesn’t work for you, there’s a +removeHandler() decorator that can be used to mark tests that +should have the control-C handling disabled.

      +
    • +
    • -f or --failfast makes +test execution stop immediately when a test fails instead of +continuing to execute further tests. (Suggested by Cliff Dyer and +implemented by Michael Foord; bpo-8074.)

    • +
    +

    The progress messages now show ‘x’ for expected failures +and ‘u’ for unexpected successes when run in verbose mode. +(Contributed by Benjamin Peterson.)

    +

    Test cases can raise the SkipTest exception to skip a +test (bpo-1034053).

    +

    The error messages for assertEqual(), +assertTrue(), and assertFalse() +failures now provide more information. If you set the +longMessage attribute of your TestCase classes to +true, both the standard error message and any additional message you +provide will be printed for failures. (Added by Michael Foord; bpo-5663.)

    +

    The assertRaises() method now +returns a context handler when called without providing a callable +object to run. For example, you can write this:

    +
    with self.assertRaises(KeyError):
    +    {}['foo']
    +
    +
    +

    (Implemented by Antoine Pitrou; bpo-4444.)

    +

    Module- and class-level setup and teardown fixtures are now supported. +Modules can contain setUpModule() and tearDownModule() +functions. Classes can have setUpClass() and +tearDownClass() methods that must be defined as class methods +(using @classmethod or equivalent). These functions and +methods are invoked when the test runner switches to a test case in a +different module or class.

    +

    The methods addCleanup() and +doCleanups() were added. +addCleanup() lets you add cleanup functions that +will be called unconditionally (after setUp() if +setUp() fails, otherwise after tearDown()). This allows +for much simpler resource allocation and deallocation during tests +(bpo-5679).

    +

    A number of new methods were added that provide more specialized +tests. Many of these methods were written by Google engineers +for use in their test suites; Gregory P. Smith, Michael Foord, and +GvR worked on merging them into Python’s version of unittest.

    +
      +
    • assertIsNone() and assertIsNotNone() take one +expression and verify that the result is or is not None.

    • +
    • assertIs() and assertIsNot() +take two values and check whether the two values evaluate to the same object or not. +(Added by Michael Foord; bpo-2578.)

    • +
    • assertIsInstance() and +assertNotIsInstance() check whether +the resulting object is an instance of a particular class, or of +one of a tuple of classes. (Added by Georg Brandl; bpo-7031.)

    • +
    • assertGreater(), assertGreaterEqual(), +assertLess(), and assertLessEqual() compare +two quantities.

    • +
    • assertMultiLineEqual() compares two strings, and if they’re +not equal, displays a helpful comparison that highlights the +differences in the two strings. This comparison is now used by +default when Unicode strings are compared with assertEqual().

    • +
    • assertRegexpMatches() and +assertNotRegexpMatches() checks whether the +first argument is a string matching or not matching the regular +expression provided as the second argument (bpo-8038).

    • +
    • assertRaisesRegexp() checks whether a particular exception +is raised, and then also checks that the string representation of +the exception matches the provided regular expression.

    • +
    • assertIn() and assertNotIn() +tests whether first is or is not in second.

    • +
    • assertItemsEqual() tests whether two provided sequences +contain the same elements.

    • +
    • assertSetEqual() compares whether two sets are equal, and +only reports the differences between the sets in case of error.

    • +
    • Similarly, assertListEqual() and assertTupleEqual() +compare the specified types and explain any differences without necessarily +printing their full values; these methods are now used by default +when comparing lists and tuples using assertEqual(). +More generally, assertSequenceEqual() compares two sequences +and can optionally check whether both sequences are of a +particular type.

    • +
    • assertDictEqual() compares two dictionaries and reports the +differences; it’s now used by default when you compare two dictionaries +using assertEqual(). assertDictContainsSubset() checks whether +all of the key/value pairs in first are found in second.

    • +
    • assertAlmostEqual() and assertNotAlmostEqual() test +whether first and second are approximately equal. This method +can either round their difference to an optionally-specified number +of places (the default is 7) and compare it to zero, or require +the difference to be smaller than a supplied delta value.

    • +
    • loadTestsFromName() properly honors the +suiteClass attribute of +the TestLoader. (Fixed by Mark Roddy; bpo-6866.)

    • +
    • A new hook lets you extend the assertEqual() method to handle +new data types. The addTypeEqualityFunc() method takes a type +object and a function. The function will be used when both of the +objects being compared are of the specified type. This function +should compare the two objects and raise an exception if they don’t +match; it’s a good idea for the function to provide additional +information about why the two objects aren’t matching, much as the new +sequence comparison methods do.

    • +
    +

    unittest.main() now takes an optional exit argument. If +false, main() doesn’t call sys.exit(), allowing +main() to be used from the interactive interpreter. +(Contributed by J. Pablo Fernández; bpo-3379.)

    +

    TestResult has new startTestRun() and +stopTestRun() methods that are called immediately before +and after a test run. (Contributed by Robert Collins; bpo-5728.)

    +

    With all these changes, the unittest.py was becoming awkwardly +large, so the module was turned into a package and the code split into +several files (by Benjamin Peterson). This doesn’t affect how the +module is imported or used.

    +
    +

    See also

    +
    +
    http://www.voidspace.org.uk/python/articles/unittest2.shtml

    Describes the new features, how to use them, and the +rationale for various design decisions. (By Michael Foord.)

    +
    +
    +
    +
    +
    +

    Updated module: ElementTree 1.3

    +

    The version of the ElementTree library included with Python was updated to +version 1.3. Some of the new features are:

    +
      +
    • The various parsing functions now take a parser keyword argument +giving an XMLParser instance that will +be used. This makes it possible to override the file’s internal encoding:

      +
      p = ET.XMLParser(encoding='utf-8')
      +t = ET.XML("""<root/>""", parser=p)
      +
      +
      +

      Errors in parsing XML now raise a ParseError exception, whose +instances have a position attribute +containing a (line, column) tuple giving the location of the problem.

      +
    • +
    • ElementTree’s code for converting trees to a string has been +significantly reworked, making it roughly twice as fast in many +cases. The ElementTree.write() +and Element.write() methods now have a method parameter that can be +“xml” (the default), “html”, or “text”. HTML mode will output empty +elements as <empty></empty> instead of <empty/>, and text +mode will skip over elements and only output the text chunks. If +you set the tag attribute of an element to None but +leave its children in place, the element will be omitted when the +tree is written out, so you don’t need to do more extensive rearrangement +to remove a single element.

      +

      Namespace handling has also been improved. All xmlns:<whatever> +declarations are now output on the root element, not scattered throughout +the resulting XML. You can set the default namespace for a tree +by setting the default_namespace attribute and can +register new prefixes with register_namespace(). In XML mode, +you can use the true/false xml_declaration parameter to suppress the +XML declaration.

      +
    • +
    • New Element method: +extend() appends the items from a +sequence to the element’s children. Elements themselves behave like +sequences, so it’s easy to move children from one element to +another:

      +
      from xml.etree import ElementTree as ET
      +
      +t = ET.XML("""<list>
      +  <item>1</item> <item>2</item>  <item>3</item>
      +</list>""")
      +new = ET.XML('<root/>')
      +new.extend(t)
      +
      +# Outputs <root><item>1</item>...</root>
      +print ET.tostring(new)
      +
      +
      +
    • +
    • New Element method: +iter() yields the children of the +element as a generator. It’s also possible to write for child in +elem: to loop over an element’s children. The existing method +getiterator() is now deprecated, as is getchildren() +which constructs and returns a list of children.

    • +
    • New Element method: +itertext() yields all chunks of +text that are descendants of the element. For example:

      +
      t = ET.XML("""<list>
      +  <item>1</item> <item>2</item>  <item>3</item>
      +</list>""")
      +
      +# Outputs ['\n  ', '1', ' ', '2', '  ', '3', '\n']
      +print list(t.itertext())
      +
      +
      +
    • +
    • Deprecated: using an element as a Boolean (i.e., if elem:) would +return true if the element had any children, or false if there were +no children. This behaviour is confusing – None is false, but +so is a childless element? – so it will now trigger a +FutureWarning. In your code, you should be explicit: write +len(elem) != 0 if you’re interested in the number of children, +or elem is not None.

    • +
    +

    Fredrik Lundh develops ElementTree and produced the 1.3 version; +you can read his article describing 1.3 at +http://effbot.org/zone/elementtree-13-intro.htm. +Florent Xicluna updated the version included with +Python, after discussions on python-dev and in bpo-6472.)

    +
    +
    +
    +

    Build and C API Changes

    +

    Changes to Python’s build process and to the C API include:

    +
      +
    • The latest release of the GNU Debugger, GDB 7, can be scripted +using Python. +When you begin debugging an executable program P, GDB will look for +a file named P-gdb.py and automatically read it. Dave Malcolm +contributed a python-gdb.py that adds a number of +commands useful when debugging Python itself. For example, +py-up and py-down go up or down one Python stack frame, +which usually corresponds to several C stack frames. py-print +prints the value of a Python variable, and py-bt prints the +Python stack trace. (Added as a result of bpo-8032.)

    • +
    • If you use the .gdbinit file provided with Python, +the “pyo” macro in the 2.7 version now works correctly when the thread being +debugged doesn’t hold the GIL; the macro now acquires it before printing. +(Contributed by Victor Stinner; bpo-3632.)

    • +
    • Py_AddPendingCall() is now thread-safe, letting any +worker thread submit notifications to the main Python thread. This +is particularly useful for asynchronous IO operations. +(Contributed by Kristján Valur Jónsson; bpo-4293.)

    • +
    • New function: PyCode_NewEmpty() creates an empty code object; +only the filename, function name, and first line number are required. +This is useful for extension modules that are attempting to +construct a more useful traceback stack. Previously such +extensions needed to call PyCode_New(), which had many +more arguments. (Added by Jeffrey Yasskin.)

    • +
    • New function: PyErr_NewExceptionWithDoc() creates a new +exception class, just as the existing PyErr_NewException() does, +but takes an extra char * argument containing the docstring for the +new exception class. (Added by ‘lekma’ on the Python bug tracker; +bpo-7033.)

    • +
    • New function: PyFrame_GetLineNumber() takes a frame object +and returns the line number that the frame is currently executing. +Previously code would need to get the index of the bytecode +instruction currently executing, and then look up the line number +corresponding to that address. (Added by Jeffrey Yasskin.)

    • +
    • New functions: PyLong_AsLongAndOverflow() and +PyLong_AsLongLongAndOverflow() approximates a Python long +integer as a C long or long long. +If the number is too large to fit into +the output type, an overflow flag is set and returned to the caller. +(Contributed by Case Van Horsen; bpo-7528 and bpo-7767.)

    • +
    • New function: stemming from the rewrite of string-to-float conversion, +a new PyOS_string_to_double() function was added. The old +PyOS_ascii_strtod() and PyOS_ascii_atof() functions +are now deprecated.

    • +
    • New function: PySys_SetArgvEx() sets the value of +sys.argv and can optionally update sys.path to include the +directory containing the script named by sys.argv[0] depending +on the value of an updatepath parameter.

      +

      This function was added to close a security hole for applications +that embed Python. The old function, PySys_SetArgv(), would +always update sys.path, and sometimes it would add the current +directory. This meant that, if you ran an application embedding +Python in a directory controlled by someone else, attackers could +put a Trojan-horse module in the directory (say, a file named +os.py) that your application would then import and run.

      +

      If you maintain a C/C++ application that embeds Python, check +whether you’re calling PySys_SetArgv() and carefully consider +whether the application should be using PySys_SetArgvEx() +with updatepath set to false.

      +

      Security issue reported as CVE-2008-5983; +discussed in bpo-5753, and fixed by Antoine Pitrou.

      +
    • +
    • New macros: the Python header files now define the following macros: +Py_ISALNUM, +Py_ISALPHA, +Py_ISDIGIT, +Py_ISLOWER, +Py_ISSPACE, +Py_ISUPPER, +Py_ISXDIGIT, +Py_TOLOWER, and Py_TOUPPER. +All of these functions are analogous to the C +standard macros for classifying characters, but ignore the current +locale setting, because in +several places Python needs to analyze characters in a +locale-independent way. (Added by Eric Smith; +bpo-5793.)

      +
    • +
    • Removed function: PyEval_CallObject is now only available +as a macro. A function version was being kept around to preserve +ABI linking compatibility, but that was in 1997; it can certainly be +deleted by now. (Removed by Antoine Pitrou; bpo-8276.)

    • +
    • New format codes: the PyFormat_FromString(), +PyFormat_FromStringV(), and PyErr_Format() functions now +accept %lld and %llu format codes for displaying +C’s long long types. +(Contributed by Mark Dickinson; bpo-7228.)

    • +
    • The complicated interaction between threads and process forking has +been changed. Previously, the child process created by +os.fork() might fail because the child is created with only a +single thread running, the thread performing the os.fork(). +If other threads were holding a lock, such as Python’s import lock, +when the fork was performed, the lock would still be marked as +“held” in the new process. But in the child process nothing would +ever release the lock, since the other threads weren’t replicated, +and the child process would no longer be able to perform imports.

      +

      Python 2.7 acquires the import lock before performing an +os.fork(), and will also clean up any locks created using the +threading module. C extension modules that have internal +locks, or that call fork() themselves, will not benefit +from this clean-up.

      +

      (Fixed by Thomas Wouters; bpo-1590864.)

      +
    • +
    • The Py_Finalize() function now calls the internal +threading._shutdown() function; this prevents some exceptions from +being raised when an interpreter shuts down. +(Patch by Adam Olsen; bpo-1722344.)

    • +
    • When using the PyMemberDef structure to define attributes +of a type, Python will no longer let you try to delete or set a +T_STRING_INPLACE attribute.

      +
    • +
    • Global symbols defined by the ctypes module are now prefixed +with Py, or with _ctypes. (Implemented by Thomas +Heller; bpo-3102.)

    • +
    • New configure option: the --with-system-expat switch allows +building the pyexpat module to use the system Expat library. +(Contributed by Arfrever Frehtes Taifersar Arahesis; bpo-7609.)

    • +
    • New configure option: the +--with-valgrind option will now disable the pymalloc +allocator, which is difficult for the Valgrind memory-error detector +to analyze correctly. +Valgrind will therefore be better at detecting memory leaks and +overruns. (Contributed by James Henstridge; bpo-2422.)

    • +
    • New configure option: you can now supply an empty string to +--with-dbmliborder= in order to disable all of the various +DBM modules. (Added by Arfrever Frehtes Taifersar Arahesis; +bpo-6491.)

    • +
    • The configure script now checks for floating-point rounding bugs +on certain 32-bit Intel chips and defines a X87_DOUBLE_ROUNDING +preprocessor definition. No code currently uses this definition, +but it’s available if anyone wishes to use it. +(Added by Mark Dickinson; bpo-2937.)

      +

      configure also now sets a LDCXXSHARED Makefile +variable for supporting C++ linking. (Contributed by Arfrever +Frehtes Taifersar Arahesis; bpo-1222585.)

      +
    • +
    • The build process now creates the necessary files for pkg-config +support. (Contributed by Clinton Roy; bpo-3585.)

    • +
    • The build process now supports Subversion 1.7. (Contributed by +Arfrever Frehtes Taifersar Arahesis; bpo-6094.)

    • +
    +
    +

    Capsules

    +

    Python 3.1 adds a new C datatype, PyCapsule, for providing a +C API to an extension module. A capsule is essentially the holder of +a C void * pointer, and is made available as a module attribute; for +example, the socket module’s API is exposed as socket.CAPI, +and unicodedata exposes ucnhash_CAPI. Other extensions +can import the module, access its dictionary to get the capsule +object, and then get the void * pointer, which will usually point +to an array of pointers to the module’s various API functions.

    +

    There is an existing data type already used for this, +PyCObject, but it doesn’t provide type safety. Evil code +written in pure Python could cause a segmentation fault by taking a +PyCObject from module A and somehow substituting it for the +PyCObject in module B. Capsules know their own name, +and getting the pointer requires providing the name:

    +
    void *vtable;
    +
    +if (!PyCapsule_IsValid(capsule, "mymodule.CAPI") {
    +        PyErr_SetString(PyExc_ValueError, "argument type invalid");
    +        return NULL;
    +}
    +
    +vtable = PyCapsule_GetPointer(capsule, "mymodule.CAPI");
    +
    +
    +

    You are assured that vtable points to whatever you’re expecting. +If a different capsule was passed in, PyCapsule_IsValid() would +detect the mismatched name and return false. Refer to +Providing a C API for an Extension Module for more information on using these objects.

    +

    Python 2.7 now uses capsules internally to provide various +extension-module APIs, but the PyCObject_AsVoidPtr() was +modified to handle capsules, preserving compile-time compatibility +with the CObject interface. Use of +PyCObject_AsVoidPtr() will signal a +PendingDeprecationWarning, which is silent by default.

    +

    Implemented in Python 3.1 and backported to 2.7 by Larry Hastings; +discussed in bpo-5630.

    +
    +
    +

    Port-Specific Changes: Windows

    +
      +
    • The msvcrt module now contains some constants from +the crtassem.h header file: +CRT_ASSEMBLY_VERSION, +VC_ASSEMBLY_PUBLICKEYTOKEN, +and LIBRARIES_ASSEMBLY_NAME_PREFIX. +(Contributed by David Cournapeau; bpo-4365.)

    • +
    • The _winreg module for accessing the registry now implements +the CreateKeyEx() and DeleteKeyEx() +functions, extended versions of previously-supported functions that +take several extra arguments. The DisableReflectionKey(), +EnableReflectionKey(), and QueryReflectionKey() +were also tested and documented. +(Implemented by Brian Curtin: bpo-7347.)

    • +
    • The new _beginthreadex() API is used to start threads, and +the native thread-local storage functions are now used. +(Contributed by Kristján Valur Jónsson; bpo-3582.)

    • +
    • The os.kill() function now works on Windows. The signal value +can be the constants CTRL_C_EVENT, +CTRL_BREAK_EVENT, or any integer. The first two constants +will send Control-C and Control-Break keystroke events to +subprocesses; any other value will use the TerminateProcess() +API. (Contributed by Miki Tebeka; bpo-1220212.)

    • +
    • The os.listdir() function now correctly fails +for an empty path. (Fixed by Hirokazu Yamamoto; bpo-5913.)

    • +
    • The mimelib module will now read the MIME database from +the Windows registry when initializing. +(Patch by Gabriel Genellina; bpo-4969.)

    • +
    +
    +
    +

    Port-Specific Changes: Mac OS X

    +
      +
    • The path /Library/Python/2.7/site-packages is now appended to +sys.path, in order to share added packages between the system +installation and a user-installed copy of the same version. +(Changed by Ronald Oussoren; bpo-4865.)

      +
      +
      +

      Changed in version 2.7.13: As of 2.7.13, this change was removed. +/Library/Python/2.7/site-packages, the site-packages directory +used by the Apple-supplied system Python 2.7 is no longer appended to +sys.path for user-installed Pythons such as from the python.org +installers. As of macOS 10.12, Apple changed how the system +site-packages directory is configured, which could cause installation +of pip components, like setuptools, to fail. Packages installed for +the system Python will no longer be shared with user-installed +Pythons. (bpo-28440)

      +
      +
      +
    • +
    +
    +
    +

    Port-Specific Changes: FreeBSD

    +
      +
    • FreeBSD 7.1’s SO_SETFIB constant, used with +getsockopt()/setsockopt() to select an +alternate routing table, is now available in the socket +module. (Added by Kyle VanderBeek; bpo-8235.)

    • +
    +
    +
    +
    +

    Other Changes and Fixes

    +
      +
    • Two benchmark scripts, iobench and ccbench, were +added to the Tools directory. iobench measures the +speed of the built-in file I/O objects returned by open() +while performing various operations, and ccbench is a +concurrency benchmark that tries to measure computing throughput, +thread switching latency, and IO processing bandwidth when +performing several tasks using a varying number of threads.

    • +
    • The Tools/i18n/msgfmt.py script now understands plural +forms in .po files. (Fixed by Martin von Löwis; +bpo-5464.)

    • +
    • When importing a module from a .pyc or .pyo file +with an existing .py counterpart, the co_filename +attributes of the resulting code objects are overwritten when the +original filename is obsolete. This can happen if the file has been +renamed, moved, or is accessed through different paths. (Patch by +Ziga Seilnacht and Jean-Paul Calderone; bpo-1180193.)

    • +
    • The regrtest.py script now takes a --randseed= +switch that takes an integer that will be used as the random seed +for the -r option that executes tests in random order. +The -r option also reports the seed that was used +(Added by Collin Winter.)

    • +
    • Another regrtest.py switch is -j, which +takes an integer specifying how many tests run in parallel. This +allows reducing the total runtime on multi-core machines. +This option is compatible with several other options, including the +-R switch which is known to produce long runtimes. +(Added by Antoine Pitrou, bpo-6152.) This can also be used +with a new -F switch that runs selected tests in a loop +until they fail. (Added by Antoine Pitrou; bpo-7312.)

    • +
    • When executed as a script, the py_compile.py module now +accepts '-' as an argument, which will read standard input for +the list of filenames to be compiled. (Contributed by Piotr +Ożarowski; bpo-8233.)

    • +
    +
    +
    +

    Porting to Python 2.7

    +

    This section lists previously described changes and other bugfixes +that may require changes to your code:

    +
      +
    • The range() function processes its arguments more +consistently; it will now call __int__() on non-float, +non-integer arguments that are supplied to it. (Fixed by Alexander +Belopolsky; bpo-1533.)

    • +
    • The string format() method changed the default precision used +for floating-point and complex numbers from 6 decimal +places to 12, which matches the precision used by str(). +(Changed by Eric Smith; bpo-5920.)

    • +
    • Because of an optimization for the with statement, the special +methods __enter__() and __exit__() must belong to the object’s +type, and cannot be directly attached to the object’s instance. This +affects new-style classes (derived from object) and C extension +types. (bpo-6101.)

    • +
    • Due to a bug in Python 2.6, the exc_value parameter to +__exit__() methods was often the string representation of the +exception, not an instance. This was fixed in 2.7, so exc_value +will be an instance as expected. (Fixed by Florent Xicluna; +bpo-7853.)

    • +
    • When a restricted set of attributes were set using __slots__, +deleting an unset attribute would not raise AttributeError +as you would expect. Fixed by Benjamin Peterson; bpo-7604.)

    • +
    +

    In the standard library:

    +
      +
    • Operations with datetime instances that resulted in a year +falling outside the supported range didn’t always raise +OverflowError. Such errors are now checked more carefully +and will now raise the exception. (Reported by Mark Leander, patch +by Anand B. Pillai and Alexander Belopolsky; bpo-7150.)

    • +
    • When using Decimal instances with a string’s +format() method, the default alignment was previously +left-alignment. This has been changed to right-alignment, which might +change the output of your programs. +(Changed by Mark Dickinson; bpo-6857.)

      +

      Comparisons involving a signaling NaN value (or sNAN) now signal +InvalidOperation instead of silently returning a true or +false value depending on the comparison operator. Quiet NaN values +(or NaN) are now hashable. (Fixed by Mark Dickinson; +bpo-7279.)

      +
    • +
    • The ElementTree library, xml.etree, no longer escapes +ampersands and angle brackets when outputting an XML processing +instruction (which looks like <?xml-stylesheet href=”#style1”?>) +or comment (which looks like <!– comment –>). +(Patch by Neil Muller; bpo-2746.)

    • +
    • The readline() method of StringIO objects now does +nothing when a negative length is requested, as other file-like +objects do. (bpo-7348).

    • +
    • The syslog module will now use the value of sys.argv[0] as the +identifier instead of the previous default value of 'python'. +(Changed by Sean Reifschneider; bpo-8451.)

    • +
    • The tarfile module’s default error handling has changed, to +no longer suppress fatal errors. The default error level was previously 0, +which meant that errors would only result in a message being written to the +debug log, but because the debug log is not activated by default, +these errors go unnoticed. The default error level is now 1, +which raises an exception if there’s an error. +(Changed by Lars Gustäbel; bpo-7357.)

    • +
    • The urlparse module’s urlsplit() now handles +unknown URL schemes in a fashion compliant with RFC 3986: if the +URL is of the form "<something>://...", the text before the +:// is treated as the scheme, even if it’s a made-up scheme that +the module doesn’t know about. This change may break code that +worked around the old behaviour. For example, Python 2.6.4 or 2.5 +will return the following:

      +
      >>> import urlparse
      +>>> urlparse.urlsplit('invented://host/filename?query')
      +('invented', '', '//host/filename?query', '', '')
      +
      +
      +

      Python 2.7 (and Python 2.6.5) will return:

      +
      >>> import urlparse
      +>>> urlparse.urlsplit('invented://host/filename?query')
      +('invented', 'host', '/filename?query', '', '')
      +
      +
      +

      (Python 2.7 actually produces slightly different output, since it +returns a named tuple instead of a standard tuple.)

      +
    • +
    +

    For C extensions:

    +
      +
    • C extensions that use integer format codes with the PyArg_Parse* +family of functions will now raise a TypeError exception +instead of triggering a DeprecationWarning (bpo-5080).

    • +
    • Use the new PyOS_string_to_double() function instead of the old +PyOS_ascii_strtod() and PyOS_ascii_atof() functions, +which are now deprecated.

    • +
    +

    For applications that embed Python:

    + +
    +
    +

    New Features Added to Python 2.7 Maintenance Releases

    +

    New features may be added to Python 2.7 maintenance releases when the +situation genuinely calls for it. Any such additions must go through +the Python Enhancement Proposal process, and make a compelling case for why +they can’t be adequately addressed by either adding the new feature solely to +Python 3, or else by publishing it on the Python Package Index.

    +

    In addition to the specific proposals listed below, there is a general +exemption allowing new -3 warnings to be added in any Python 2.7 +maintenance release.

    +
    +

    Two new environment variables for debug mode

    +

    In debug mode, the [xxx refs] statistic is not written by default, the +PYTHONSHOWREFCOUNT environment variable now must also be set. +(Contributed by Victor Stinner; bpo-31733.)

    +

    When Python is compiled with COUNT_ALLOC defined, allocation counts are no +longer dumped by default anymore: the PYTHONSHOWALLOCCOUNT environment +variable must now also be set. Moreover, allocation counts are now dumped into +stderr, rather than stdout. (Contributed by Victor Stinner; bpo-31692.)

    +
    +

    New in version 2.7.15.

    +
    +
    +
    +

    PEP 434: IDLE Enhancement Exception for All Branches

    +

    PEP 434 describes a general exemption for changes made to the IDLE +development environment shipped along with Python. This exemption makes it +possible for the IDLE developers to provide a more consistent user +experience across all supported versions of Python 2 and 3.

    +

    For details of any IDLE changes, refer to the NEWS file for the specific +release.

    +
    +
    +

    PEP 466: Network Security Enhancements for Python 2.7

    +

    PEP 466 describes a number of network security enhancement proposals +that have been approved for inclusion in Python 2.7 maintenance releases, +with the first of those changes appearing in the Python 2.7.7 release.

    +

    PEP 466 related features added in Python 2.7.7:

    +
      +
    • hmac.compare_digest() was backported from Python 3 to make a timing +attack resistant comparison operation available to Python 2 applications. +(Contributed by Alex Gaynor; bpo-21306.)

    • +
    • OpenSSL 1.0.1g was upgraded in the official Windows installers published on +python.org. (Contributed by Zachary Ware; bpo-21462.)

    • +
    +

    PEP 466 related features added in Python 2.7.8:

    +
      +
    • hashlib.pbkdf2_hmac() was backported from Python 3 to make a hashing +algorithm suitable for secure password storage broadly available to Python +2 applications. (Contributed by Alex Gaynor; bpo-21304.)

    • +
    • OpenSSL 1.0.1h was upgraded for the official Windows installers published on +python.org. (contributed by Zachary Ware in bpo-21671 for CVE-2014-0224)

    • +
    +

    PEP 466 related features added in Python 2.7.9:

    +
      +
    • Most of Python 3.4’s ssl module was backported. This means ssl +now supports Server Name Indication, TLS1.x settings, access to the platform +certificate store, the SSLContext class, and other +features. (Contributed by Alex Gaynor and David Reid; bpo-21308.)

      +

      Refer to the “Version added: 2.7.9” notes in the module documentation for +specific details.

      +
    • +
    • os.urandom() was changed to cache a file descriptor to /dev/urandom +instead of reopening /dev/urandom on every call. (Contributed by Alex +Gaynor; bpo-21305.)

    • +
    • hashlib.algorithms_guaranteed and +hashlib.algorithms_available were backported from Python 3 to make +it easier for Python 2 applications to select the strongest available hash +algorithm. (Contributed by Alex Gaynor in bpo-21307)

    • +
    +
    +
    +

    PEP 477: Backport ensurepip (PEP 453) to Python 2.7

    +

    PEP 477 approves the inclusion of the PEP 453 ensurepip module and the +improved documentation that was enabled by it in the Python 2.7 maintenance +releases, appearing first in the Python 2.7.9 release.

    +
    +

    Bootstrapping pip By Default

    +

    The new ensurepip module (defined in PEP 453) provides a standard +cross-platform mechanism to bootstrap the pip installer into Python +installations. The version of pip included with Python 2.7.9 is pip +1.5.6, and future 2.7.x maintenance releases will update the bundled version to +the latest version of pip that is available at the time of creating the +release candidate.

    +

    By default, the commands pip, pipX and pipX.Y will be installed on +all platforms (where X.Y stands for the version of the Python installation), +along with the pip Python package and its dependencies.

    +

    For CPython source builds on POSIX systems, +the make install and make altinstall commands do not bootstrap pip +by default. This behaviour can be controlled through configure options, and +overridden through Makefile options.

    +

    On Windows and Mac OS X, the CPython installers now default to installing +pip along with CPython itself (users may opt out of installing it +during the installation process). Window users will need to opt in to the +automatic PATH modifications to have pip available from the command +line by default, otherwise it can still be accessed through the Python +launcher for Windows as py -m pip.

    +

    As discussed in the PEP, platform packagers may choose not to install +these commands by default, as long as, when invoked, they provide clear and +simple directions on how to install them on that platform (usually using +the system package manager).

    +
    +
    +

    Documentation Changes

    +

    As part of this change, the Installing Python Modules and +Distributing Python Modules sections of the documentation have been +completely redesigned as short getting started and FAQ documents. Most +packaging documentation has now been moved out to the Python Packaging +Authority maintained Python Packaging User Guide and the documentation of the individual +projects.

    +

    However, as this migration is currently still incomplete, the legacy +versions of those guides remaining available as Installing Python Modules (Legacy version) +and Distributing Python Modules (Legacy version).

    +
    +

    See also

    +
    +
    PEP 453 – Explicit bootstrapping of pip in Python installations

    PEP written by Donald Stufft and Nick Coghlan, implemented by +Donald Stufft, Nick Coghlan, Martin von Löwis and Ned Deily.

    +
    +
    +
    +
    +
    +
    +

    PEP 476: Enabling certificate verification by default for stdlib http clients

    +

    PEP 476 updated httplib and modules which use it, such as +urllib2 and xmlrpclib, to now verify that the server +presents a certificate which is signed by a Certificate Authority in the +platform trust store and whose hostname matches the hostname being requested +by default, significantly improving security for many applications. This +change was made in the Python 2.7.9 release.

    +

    For applications which require the old previous behavior, they can pass an +alternate context:

    +
    import urllib2
    +import ssl
    +
    +# This disables all verification
    +context = ssl._create_unverified_context()
    +
    +# This allows using a specific certificate for the host, which doesn't need
    +# to be in the trust store
    +context = ssl.create_default_context(cafile="/path/to/file.crt")
    +
    +urllib2.urlopen("https://invalid-cert", context=context)
    +
    +
    +
    +
    +

    PEP 493: HTTPS verification migration tools for Python 2.7

    +

    PEP 493 provides additional migration tools to support a more incremental +infrastructure upgrade process for environments containing applications and +services relying on the historically permissive processing of server +certificates when establishing client HTTPS connections. These additions were +made in the Python 2.7.12 release.

    +

    These tools are intended for use in cases where affected applications and +services can’t be modified to explicitly pass a more permissive SSL context +when establishing the connection.

    +

    For applications and services which can’t be modified at all, the new +PYTHONHTTPSVERIFY environment variable may be set to 0 to revert an +entire Python process back to the default permissive behaviour of Python 2.7.8 +and earlier.

    +

    For cases where the connection establishment code can’t be modified, but the +overall application can be, the new ssl._https_verify_certificates() +function can be used to adjust the default behaviour at runtime.

    +
    +
    +

    New make regen-all build target

    +

    To simplify cross-compilation, and to ensure that CPython can reliably be +compiled without requiring an existing version of Python to already be +available, the autotools-based build system no longer attempts to implicitly +recompile generated files based on file modification times.

    +

    Instead, a new make regen-all command has been added to force regeneration +of these files when desired (e.g. after an initial version of Python has +already been built based on the pregenerated versions).

    +

    More selective regeneration targets are also defined - see +Makefile.pre.in for details.

    +

    (Contributed by Victor Stinner in bpo-23404.)

    +
    +

    New in version 2.7.14.

    +
    +
    +
    +

    Removal of make touch build target

    +

    The make touch build target previously used to request implicit regeneration +of generated files by updating their modification times has been removed.

    +

    It has been replaced by the new make regen-all target.

    +

    (Contributed by Victor Stinner in bpo-23404.)

    +
    +

    Changed in version 2.7.14.

    +
    +
    +
    +
    +

    Acknowledgements

    +

    The author would like to thank the following people for offering +suggestions, corrections and assistance with various drafts of this +article: Nick Coghlan, Philip Jenvey, Ryan Lovett, R. David Murray, +Hugh Secker-Walker.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/whatsnew/3.0.html b/python-3.7.4-docs-html/whatsnew/3.0.html new file mode 100644 index 0000000..8590b00 --- /dev/null +++ b/python-3.7.4-docs-html/whatsnew/3.0.html @@ -0,0 +1,975 @@ + + + + + + + What’s New In Python 3.0 — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    What’s New In Python 3.0

    +
    +
    Author
    +

    Guido van Rossum

    +
    +
    +

    This article explains the new features in Python 3.0, compared to 2.6. +Python 3.0, also known as “Python 3000” or “Py3K”, is the first ever +intentionally backwards incompatible Python release. There are more +changes than in a typical release, and more that are important for all +Python users. Nevertheless, after digesting the changes, you’ll find +that Python really hasn’t changed all that much – by and large, we’re +mostly fixing well-known annoyances and warts, and removing a lot of +old cruft.

    +

    This article doesn’t attempt to provide a complete specification of +all new features, but instead tries to give a convenient overview. +For full details, you should refer to the documentation for Python +3.0, and/or the many PEPs referenced in the text. If you want to +understand the complete implementation and design rationale for a +particular feature, PEPs usually have more details than the regular +documentation; but note that PEPs usually are not kept up-to-date once +a feature has been fully implemented.

    +

    Due to time constraints this document is not as complete as it should +have been. As always for a new release, the Misc/NEWS file in the +source distribution contains a wealth of detailed information about +every small thing that was changed.

    +
    +

    Common Stumbling Blocks

    +

    This section lists those few changes that are most likely to trip you +up if you’re used to Python 2.5.

    + +
    +

    Views And Iterators Instead Of Lists

    +

    Some well-known APIs no longer return lists:

    +
      +
    • dict methods dict.keys(), dict.items() and +dict.values() return “views” instead of lists. For example, +this no longer works: k = d.keys(); k.sort(). Use k = +sorted(d) instead (this works in Python 2.5 too and is just +as efficient).

    • +
    • Also, the dict.iterkeys(), dict.iteritems() and +dict.itervalues() methods are no longer supported.

    • +
    • map() and filter() return iterators. If you really need +a list and the input sequences are all of equal length, a quick +fix is to wrap map() in list(), e.g. list(map(...)), +but a better fix is +often to use a list comprehension (especially when the original code +uses lambda), or rewriting the code so it doesn’t need a +list at all. Particularly tricky is map() invoked for the +side effects of the function; the correct transformation is to use a +regular for loop (since creating a list would just be +wasteful).

      +

      If the input sequences are not of equal length, map() will +stop at the termination of the shortest of the sequences. For full +compatibility with map() from Python 2.x, also wrap the sequences in +itertools.zip_longest(), e.g. map(func, *sequences) becomes +list(map(func, itertools.zip_longest(*sequences))).

      +
    • +
    • range() now behaves like xrange() used to behave, except +it works with values of arbitrary size. The latter no longer +exists.

    • +
    • zip() now returns an iterator.

    • +
    +
    +
    +

    Ordering Comparisons

    +

    Python 3.0 has simplified the rules for ordering comparisons:

    +
      +
    • The ordering comparison operators (<, <=, >=, >) +raise a TypeError exception when the operands don’t have a +meaningful natural ordering. Thus, expressions like 1 < '', 0 +> None or len <= len are no longer valid, and e.g. None < +None raises TypeError instead of returning +False. A corollary is that sorting a heterogeneous list +no longer makes sense – all the elements must be comparable to each +other. Note that this does not apply to the == and != +operators: objects of different incomparable types always compare +unequal to each other.

    • +
    • builtin.sorted() and list.sort() no longer accept the +cmp argument providing a comparison function. Use the key +argument instead. N.B. the key and reverse arguments are now +“keyword-only”.

    • +
    • The cmp() function should be treated as gone, and the __cmp__() +special method is no longer supported. Use __lt__() for sorting, +__eq__() with __hash__(), and other rich comparisons as needed. +(If you really need the cmp() functionality, you could use the +expression (a > b) - (a < b) as the equivalent for cmp(a, b).)

    • +
    +
    +
    +

    Integers

    +
      +
    • PEP 237: Essentially, long renamed to int. +That is, there is only one built-in integral type, named +int; but it behaves mostly like the old long type.

    • +
    • PEP 238: An expression like 1/2 returns a float. Use +1//2 to get the truncating behavior. (The latter syntax has +existed for years, at least since Python 2.2.)

    • +
    • The sys.maxint constant was removed, since there is no +longer a limit to the value of integers. However, sys.maxsize +can be used as an integer larger than any practical list or string +index. It conforms to the implementation’s “natural” integer size +and is typically the same as sys.maxint in previous releases +on the same platform (assuming the same build options).

    • +
    • The repr() of a long integer doesn’t include the trailing L +anymore, so code that unconditionally strips that character will +chop off the last digit instead. (Use str() instead.)

    • +
    • Octal literals are no longer of the form 0720; use 0o720 +instead.

    • +
    +
    +
    +

    Text Vs. Data Instead Of Unicode Vs. 8-bit

    +

    Everything you thought you knew about binary data and Unicode has +changed.

    +
      +
    • Python 3.0 uses the concepts of text and (binary) data instead +of Unicode strings and 8-bit strings. All text is Unicode; however +encoded Unicode is represented as binary data. The type used to +hold text is str, the type used to hold data is +bytes. The biggest difference with the 2.x situation is +that any attempt to mix text and data in Python 3.0 raises +TypeError, whereas if you were to mix Unicode and 8-bit +strings in Python 2.x, it would work if the 8-bit string happened to +contain only 7-bit (ASCII) bytes, but you would get +UnicodeDecodeError if it contained non-ASCII values. This +value-specific behavior has caused numerous sad faces over the +years.

    • +
    • As a consequence of this change in philosophy, pretty much all code +that uses Unicode, encodings or binary data most likely has to +change. The change is for the better, as in the 2.x world there +were numerous bugs having to do with mixing encoded and unencoded +text. To be prepared in Python 2.x, start using unicode +for all unencoded text, and str for binary or encoded data +only. Then the 2to3 tool will do most of the work for you.

    • +
    • You can no longer use u"..." literals for Unicode text. +However, you must use b"..." literals for binary data.

    • +
    • As the str and bytes types cannot be mixed, you +must always explicitly convert between them. Use str.encode() +to go from str to bytes, and bytes.decode() +to go from bytes to str. You can also use +bytes(s, encoding=...) and str(b, encoding=...), +respectively.

    • +
    • Like str, the bytes type is immutable. There is a +separate mutable type to hold buffered binary data, +bytearray. Nearly all APIs that accept bytes also +accept bytearray. The mutable API is based on +collections.MutableSequence.

    • +
    • All backslashes in raw string literals are interpreted literally. +This means that '\U' and '\u' escapes in raw strings are not +treated specially. For example, r'\u20ac' is a string of 6 +characters in Python 3.0, whereas in 2.6, ur'\u20ac' was the +single “euro” character. (Of course, this change only affects raw +string literals; the euro character is '\u20ac' in Python 3.0.)

    • +
    • The built-in basestring abstract type was removed. Use +str instead. The str and bytes types +don’t have functionality enough in common to warrant a shared base +class. The 2to3 tool (see below) replaces every occurrence of +basestring with str.

    • +
    • Files opened as text files (still the default mode for open()) +always use an encoding to map between strings (in memory) and bytes +(on disk). Binary files (opened with a b in the mode argument) +always use bytes in memory. This means that if a file is opened +using an incorrect mode or encoding, I/O will likely fail loudly, +instead of silently producing incorrect data. It also means that +even Unix users will have to specify the correct mode (text or +binary) when opening a file. There is a platform-dependent default +encoding, which on Unixy platforms can be set with the LANG +environment variable (and sometimes also with some other +platform-specific locale-related environment variables). In many +cases, but not all, the system default is UTF-8; you should never +count on this default. Any application reading or writing more than +pure ASCII text should probably have a way to override the encoding. +There is no longer any need for using the encoding-aware streams +in the codecs module.

    • +
    • The initial values of sys.stdin, sys.stdout and +sys.stderr are now unicode-only text files (i.e., they are +instances of io.TextIOBase). To read and write bytes data +with these streams, you need to use their io.TextIOBase.buffer +attribute.

    • +
    • Filenames are passed to and returned from APIs as (Unicode) strings. +This can present platform-specific problems because on some +platforms filenames are arbitrary byte strings. (On the other hand, +on Windows filenames are natively stored as Unicode.) As a +work-around, most APIs (e.g. open() and many functions in the +os module) that take filenames accept bytes objects +as well as strings, and a few APIs have a way to ask for a +bytes return value. Thus, os.listdir() returns a +list of bytes instances if the argument is a bytes +instance, and os.getcwdb() returns the current working +directory as a bytes instance. Note that when +os.listdir() returns a list of strings, filenames that +cannot be decoded properly are omitted rather than raising +UnicodeError.

    • +
    • Some system APIs like os.environ and sys.argv can +also present problems when the bytes made available by the system is +not interpretable using the default encoding. Setting the LANG +variable and rerunning the program is probably the best approach.

    • +
    • PEP 3138: The repr() of a string no longer escapes +non-ASCII characters. It still escapes control characters and code +points with non-printable status in the Unicode standard, however.

    • +
    • PEP 3120: The default source encoding is now UTF-8.

    • +
    • PEP 3131: Non-ASCII letters are now allowed in identifiers. +(However, the standard library remains ASCII-only with the exception +of contributor names in comments.)

    • +
    • The StringIO and cStringIO modules are gone. Instead, +import the io module and use io.StringIO or +io.BytesIO for text and data respectively.

    • +
    • See also the Unicode HOWTO, which was updated for Python 3.0.

    • +
    +
    +
    +
    +

    Overview Of Syntax Changes

    +

    This section gives a brief overview of every syntactic change in +Python 3.0.

    +
    +

    New Syntax

    +
      +
    • PEP 3107: Function argument and return value annotations. This +provides a standardized way of annotating a function’s parameters +and return value. There are no semantics attached to such +annotations except that they can be introspected at runtime using +the __annotations__ attribute. The intent is to encourage +experimentation through metaclasses, decorators or frameworks.

    • +
    • PEP 3102: Keyword-only arguments. Named parameters occurring +after *args in the parameter list must be specified using +keyword syntax in the call. You can also use a bare * in the +parameter list to indicate that you don’t accept a variable-length +argument list, but you do have keyword-only arguments.

    • +
    • Keyword arguments are allowed after the list of base classes in a +class definition. This is used by the new convention for specifying +a metaclass (see next section), but can be used for other purposes +as well, as long as the metaclass supports it.

    • +
    • PEP 3104: nonlocal statement. Using nonlocal x +you can now assign directly to a variable in an outer (but +non-global) scope. nonlocal is a new reserved word.

    • +
    • PEP 3132: Extended Iterable Unpacking. You can now write things +like a, b, *rest = some_sequence. And even *rest, a = +stuff. The rest object is always a (possibly empty) list; the +right-hand side may be any iterable. Example:

      +
      (a, *rest, b) = range(5)
      +
      +
      +

      This sets a to 0, b to 4, and rest to [1, 2, 3].

      +
    • +
    • Dictionary comprehensions: {k: v for k, v in stuff} means the +same thing as dict(stuff) but is more flexible. (This is +PEP 274 vindicated. :-)

    • +
    • Set literals, e.g. {1, 2}. Note that {} is an empty +dictionary; use set() for an empty set. Set comprehensions are +also supported; e.g., {x for x in stuff} means the same thing as +set(stuff) but is more flexible.

    • +
    • New octal literals, e.g. 0o720 (already in 2.6). The old octal +literals (0720) are gone.

    • +
    • New binary literals, e.g. 0b1010 (already in 2.6), and +there is a new corresponding built-in function, bin().

    • +
    • Bytes literals are introduced with a leading b or B, and +there is a new corresponding built-in function, bytes().

    • +
    +
    +
    +

    Changed Syntax

    +
      +
    • PEP 3109 and PEP 3134: new raise statement syntax: +raise [expr [from expr]]. See below.

    • +
    • as and with are now reserved words. (Since +2.6, actually.)

    • +
    • True, False, and None are reserved words. (2.6 partially enforced +the restrictions on None already.)

    • +
    • Change from except exc, var to +except exc as var. See PEP 3110.

    • +
    • PEP 3115: New Metaclass Syntax. Instead of:

      +
      class C:
      +    __metaclass__ = M
      +    ...
      +
      +
      +

      you must now use:

      +
      class C(metaclass=M):
      +    ...
      +
      +
      +

      The module-global __metaclass__ variable is no longer +supported. (It was a crutch to make it easier to default to +new-style classes without deriving every class from +object.)

      +
    • +
    • List comprehensions no longer support the syntactic form +[... for var in item1, item2, ...]. Use +[... for var in (item1, item2, ...)] instead. +Also note that list comprehensions have different semantics: they +are closer to syntactic sugar for a generator expression inside a +list() constructor, and in particular the loop control +variables are no longer leaked into the surrounding scope.

    • +
    • The ellipsis (...) can be used as an atomic expression +anywhere. (Previously it was only allowed in slices.) Also, it +must now be spelled as .... (Previously it could also be +spelled as . . ., by a mere accident of the grammar.)

    • +
    +
    +
    +

    Removed Syntax

    +
      +
    • PEP 3113: Tuple parameter unpacking removed. You can no longer +write def foo(a, (b, c)): .... +Use def foo(a, b_c): b, c = b_c instead.

    • +
    • Removed backticks (use repr() instead).

    • +
    • Removed <> (use != instead).

    • +
    • Removed keyword: exec() is no longer a keyword; it remains as +a function. (Fortunately the function syntax was also accepted in +2.x.) Also note that exec() no longer takes a stream argument; +instead of exec(f) you can use exec(f.read()).

    • +
    • Integer literals no longer support a trailing l or L.

    • +
    • String literals no longer support a leading u or U.

    • +
    • The from module import * syntax is only +allowed at the module level, no longer inside functions.

    • +
    • The only acceptable syntax for relative imports is from .[module] +import name. All import forms not starting with . are +interpreted as absolute imports. (PEP 328)

    • +
    • Classic classes are gone.

    • +
    +
    +
    +
    +

    Changes Already Present In Python 2.6

    +

    Since many users presumably make the jump straight from Python 2.5 to +Python 3.0, this section reminds the reader of new features that were +originally designed for Python 3.0 but that were back-ported to Python +2.6. The corresponding sections in What’s New in Python 2.6 should be +consulted for longer descriptions.

    + +
    +
    +

    Library Changes

    +

    Due to time constraints, this document does not exhaustively cover the +very extensive changes to the standard library. PEP 3108 is the +reference for the major changes to the library. Here’s a capsule +review:

    +
      +
    • Many old modules were removed. Some, like gopherlib (no +longer used) and md5 (replaced by hashlib), were +already deprecated by PEP 4. Others were removed as a result +of the removal of support for various platforms such as Irix, BeOS +and Mac OS 9 (see PEP 11). Some modules were also selected for +removal in Python 3.0 due to lack of use or because a better +replacement exists. See PEP 3108 for an exhaustive list.

    • +
    • The bsddb3 package was removed because its presence in the +core standard library has proved over time to be a particular burden +for the core developers due to testing instability and Berkeley DB’s +release schedule. However, the package is alive and well, +externally maintained at https://www.jcea.es/programacion/pybsddb.htm.

    • +
    • Some modules were renamed because their old name disobeyed +PEP 8, or for various other reasons. Here’s the list:

      + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      Old Name

      New Name

      _winreg

      winreg

      ConfigParser

      configparser

      copy_reg

      copyreg

      Queue

      queue

      SocketServer

      socketserver

      markupbase

      _markupbase

      repr

      reprlib

      test.test_support

      test.support

      +
    • +
    • A common pattern in Python 2.x is to have one version of a module +implemented in pure Python, with an optional accelerated version +implemented as a C extension; for example, pickle and +cPickle. This places the burden of importing the accelerated +version and falling back on the pure Python version on each user of +these modules. In Python 3.0, the accelerated versions are +considered implementation details of the pure Python versions. +Users should always import the standard version, which attempts to +import the accelerated version and falls back to the pure Python +version. The pickle / cPickle pair received this +treatment. The profile module is on the list for 3.1. The +StringIO module has been turned into a class in the io +module.

    • +
    • Some related modules have been grouped into packages, and usually +the submodule names have been simplified. The resulting new +packages are:

      +
        +
      • dbm (anydbm, dbhash, dbm, +dumbdbm, gdbm, whichdb).

      • +
      • html (HTMLParser, htmlentitydefs).

      • +
      • http (httplib, BaseHTTPServer, +CGIHTTPServer, SimpleHTTPServer, Cookie, +cookielib).

      • +
      • tkinter (all Tkinter-related modules except +turtle). The target audience of turtle doesn’t +really care about tkinter. Also note that as of Python +2.6, the functionality of turtle has been greatly enhanced.

      • +
      • urllib (urllib, urllib2, urlparse, +robotparse).

      • +
      • xmlrpc (xmlrpclib, DocXMLRPCServer, +SimpleXMLRPCServer).

      • +
      +
    • +
    +

    Some other changes to standard library modules, not covered by +PEP 3108:

    +
      +
    • Killed sets. Use the built-in set() class.

    • +
    • Cleanup of the sys module: removed sys.exitfunc(), +sys.exc_clear(), sys.exc_type, sys.exc_value, +sys.exc_traceback. (Note that sys.last_type +etc. remain.)

    • +
    • Cleanup of the array.array type: the read() and +write() methods are gone; use fromfile() and +tofile() instead. Also, the 'c' typecode for array is +gone – use either 'b' for bytes or 'u' for Unicode +characters.

    • +
    • Cleanup of the operator module: removed +sequenceIncludes() and isCallable().

    • +
    • Cleanup of the thread module: acquire_lock() and +release_lock() are gone; use acquire() and +release() instead.

    • +
    • Cleanup of the random module: removed the jumpahead() API.

    • +
    • The new module is gone.

    • +
    • The functions os.tmpnam(), os.tempnam() and +os.tmpfile() have been removed in favor of the tempfile +module.

    • +
    • The tokenize module has been changed to work with bytes. The +main entry point is now tokenize.tokenize(), instead of +generate_tokens.

    • +
    • string.letters and its friends (string.lowercase and +string.uppercase) are gone. Use +string.ascii_letters etc. instead. (The reason for the +removal is that string.letters and friends had +locale-specific behavior, which is a bad idea for such +attractively-named global “constants”.)

    • +
    • Renamed module __builtin__ to builtins (removing the +underscores, adding an ‘s’). The __builtins__ variable +found in most global namespaces is unchanged. To modify a builtin, +you should use builtins, not __builtins__!

    • +
    +
    +
    +

    PEP 3101: A New Approach To String Formatting

    +
      +
    • A new system for built-in string formatting operations replaces the +% string formatting operator. (However, the % operator is +still supported; it will be deprecated in Python 3.1 and removed +from the language at some later time.) Read PEP 3101 for the full +scoop.

    • +
    +
    +
    +

    Changes To Exceptions

    +

    The APIs for raising and catching exception have been cleaned up and +new powerful features added:

    +
      +
    • PEP 352: All exceptions must be derived (directly or indirectly) +from BaseException. This is the root of the exception +hierarchy. This is not new as a recommendation, but the +requirement to inherit from BaseException is new. (Python +2.6 still allowed classic classes to be raised, and placed no +restriction on what you can catch.) As a consequence, string +exceptions are finally truly and utterly dead.

    • +
    • Almost all exceptions should actually derive from Exception; +BaseException should only be used as a base class for +exceptions that should only be handled at the top level, such as +SystemExit or KeyboardInterrupt. The recommended +idiom for handling all exceptions except for this latter category is +to use except Exception.

    • +
    • StandardError was removed.

    • +
    • Exceptions no longer behave as sequences. Use the args +attribute instead.

    • +
    • PEP 3109: Raising exceptions. You must now use raise +Exception(args) instead of raise Exception, args. +Additionally, you can no longer explicitly specify a traceback; +instead, if you have to do this, you can assign directly to the +__traceback__ attribute (see below).

    • +
    • PEP 3110: Catching exceptions. You must now use +except SomeException as variable instead +of except SomeException, variable. Moreover, the +variable is explicitly deleted when the except block +is left.

    • +
    • PEP 3134: Exception chaining. There are two cases: implicit +chaining and explicit chaining. Implicit chaining happens when an +exception is raised in an except or finally +handler block. This usually happens due to a bug in the handler +block; we call this a secondary exception. In this case, the +original exception (that was being handled) is saved as the +__context__ attribute of the secondary exception. +Explicit chaining is invoked with this syntax:

      +
      raise SecondaryException() from primary_exception
      +
      +
      +

      (where primary_exception is any expression that produces an +exception object, probably an exception that was previously caught). +In this case, the primary exception is stored on the +__cause__ attribute of the secondary exception. The +traceback printed when an unhandled exception occurs walks the chain +of __cause__ and __context__ attributes and prints a +separate traceback for each component of the chain, with the primary +exception at the top. (Java users may recognize this behavior.)

      +
    • +
    • PEP 3134: Exception objects now store their traceback as the +__traceback__ attribute. This means that an exception +object now contains all the information pertaining to an exception, +and there are fewer reasons to use sys.exc_info() (though the +latter is not removed).

    • +
    • A few exception messages are improved when Windows fails to load an +extension module. For example, error code 193 is now %1 is +not a valid Win32 application. Strings now deal with non-English +locales.

    • +
    +
    +
    +

    Miscellaneous Other Changes

    +
    +

    Operators And Special Methods

    +
      +
    • != now returns the opposite of ==, unless == returns +NotImplemented.

    • +
    • The concept of “unbound methods” has been removed from the language. +When referencing a method as a class attribute, you now get a plain +function object.

    • +
    • __getslice__(), __setslice__() and __delslice__() +were killed. The syntax a[i:j] now translates to +a.__getitem__(slice(i, j)) (or __setitem__() or +__delitem__(), when used as an assignment or deletion target, +respectively).

    • +
    • PEP 3114: the standard next() method has been renamed to +__next__().

    • +
    • The __oct__() and __hex__() special methods are removed +– oct() and hex() use __index__() now to convert +the argument to an integer.

    • +
    • Removed support for __members__ and __methods__.

    • +
    • The function attributes named func_X have been renamed to +use the __X__ form, freeing up these names in the function +attribute namespace for user-defined attributes. To wit, +func_closure, func_code, func_defaults, +func_dict, func_doc, func_globals, +func_name were renamed to __closure__, +__code__, __defaults__, __dict__, +__doc__, __globals__, __name__, +respectively.

    • +
    • __nonzero__() is now __bool__().

    • +
    +
    +
    +

    Builtins

    +
      +
    • PEP 3135: New super(). You can now invoke super() +without arguments and (assuming this is in a regular instance method +defined inside a class statement) the right class and +instance will automatically be chosen. With arguments, the behavior +of super() is unchanged.

    • +
    • PEP 3111: raw_input() was renamed to input(). That +is, the new input() function reads a line from +sys.stdin and returns it with the trailing newline stripped. +It raises EOFError if the input is terminated prematurely. +To get the old behavior of input(), use eval(input()).

    • +
    • A new built-in function next() was added to call the +__next__() method on an object.

    • +
    • The round() function rounding strategy and return type have +changed. Exact halfway cases are now rounded to the nearest even +result instead of away from zero. (For example, round(2.5) now +returns 2 rather than 3.) round(x[, n]) now +delegates to x.__round__([n]) instead of always returning a +float. It generally returns an integer when called with a single +argument and a value of the same type as x when called with two +arguments.

    • +
    • Moved intern() to sys.intern().

    • +
    • Removed: apply(). Instead of apply(f, args) use +f(*args).

    • +
    • Removed callable(). Instead of callable(f) you can use +isinstance(f, collections.Callable). The operator.isCallable() +function is also gone.

    • +
    • Removed coerce(). This function no longer serves a purpose +now that classic classes are gone.

    • +
    • Removed execfile(). Instead of execfile(fn) use +exec(open(fn).read()).

    • +
    • Removed the file type. Use open(). There are now several +different kinds of streams that open can return in the io module.

    • +
    • Removed reduce(). Use functools.reduce() if you really +need it; however, 99 percent of the time an explicit for +loop is more readable.

    • +
    • Removed reload(). Use imp.reload().

    • +
    • Removed. dict.has_key() – use the in operator +instead.

    • +
    +
    +
    +
    +

    Build and C API Changes

    +

    Due to time constraints, here is a very incomplete list of changes +to the C API.

    +
      +
    • Support for several platforms was dropped, including but not limited +to Mac OS 9, BeOS, RISCOS, Irix, and Tru64.

    • +
    • PEP 3118: New Buffer API.

    • +
    • PEP 3121: Extension Module Initialization & Finalization.

    • +
    • PEP 3123: Making PyObject_HEAD conform to standard C.

    • +
    • No more C API support for restricted execution.

    • +
    • PyNumber_Coerce(), PyNumber_CoerceEx(), +PyMember_Get(), and PyMember_Set() C APIs are removed.

    • +
    • New C API PyImport_ImportModuleNoBlock(), works like +PyImport_ImportModule() but won’t block on the import lock +(returning an error instead).

    • +
    • Renamed the boolean conversion C-level slot and method: +nb_nonzero is now nb_bool.

    • +
    • Removed METH_OLDARGS and WITH_CYCLE_GC from the C API.

    • +
    +
    +
    +

    Performance

    +

    The net result of the 3.0 generalizations is that Python 3.0 runs the +pystone benchmark around 10% slower than Python 2.5. Most likely the +biggest cause is the removal of special-casing for small integers. +There’s room for improvement, but it will happen after 3.0 is +released!

    +
    +
    +

    Porting To Python 3.0

    +

    For porting existing Python 2.5 or 2.6 source code to Python 3.0, the +best strategy is the following:

    +
      +
    1. (Prerequisite:) Start with excellent test coverage.

    2. +
    3. Port to Python 2.6. This should be no more work than the average +port from Python 2.x to Python 2.(x+1). Make sure all your tests +pass.

    4. +
    5. (Still using 2.6:) Turn on the -3 command line switch. +This enables warnings about features that will be removed (or +change) in 3.0. Run your test suite again, and fix code that you +get warnings about until there are no warnings left, and all your +tests still pass.

    6. +
    7. Run the 2to3 source-to-source translator over your source code +tree. (See 2to3 - Automated Python 2 to 3 code translation for more on this tool.) Run the +result of the translation under Python 3.0. Manually fix up any +remaining issues, fixing problems until all tests pass again.

    8. +
    +

    It is not recommended to try to write source code that runs unchanged +under both Python 2.6 and 3.0; you’d have to use a very contorted +coding style, e.g. avoiding print statements, metaclasses, +and much more. If you are maintaining a library that needs to support +both Python 2.6 and Python 3.0, the best approach is to modify step 3 +above by editing the 2.6 version of the source code and running the +2to3 translator again, rather than editing the 3.0 version of the +source code.

    +

    For porting C extensions to Python 3.0, please see Porting Extension Modules to Python 3.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/whatsnew/3.1.html b/python-3.7.4-docs-html/whatsnew/3.1.html new file mode 100644 index 0000000..8fd83ec --- /dev/null +++ b/python-3.7.4-docs-html/whatsnew/3.1.html @@ -0,0 +1,678 @@ + + + + + + + What’s New In Python 3.1 — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    What’s New In Python 3.1

    +
    +
    Author
    +

    Raymond Hettinger

    +
    +
    +

    This article explains the new features in Python 3.1, compared to 3.0.

    +
    +

    PEP 372: Ordered Dictionaries

    +

    Regular Python dictionaries iterate over key/value pairs in arbitrary order. +Over the years, a number of authors have written alternative implementations +that remember the order that the keys were originally inserted. Based on +the experiences from those implementations, a new +collections.OrderedDict class has been introduced.

    +

    The OrderedDict API is substantially the same as regular dictionaries +but will iterate over keys and values in a guaranteed order depending on +when a key was first inserted. If a new entry overwrites an existing entry, +the original insertion position is left unchanged. Deleting an entry and +reinserting it will move it to the end.

    +

    The standard library now supports use of ordered dictionaries in several +modules. The configparser module uses them by default. This lets +configuration files be read, modified, and then written back in their original +order. The _asdict() method for collections.namedtuple() now +returns an ordered dictionary with the values appearing in the same order as +the underlying tuple indices. The json module is being built-out with +an object_pairs_hook to allow OrderedDicts to be built by the decoder. +Support was also added for third-party tools like PyYAML.

    +
    +

    See also

    +
    +
    PEP 372 - Ordered Dictionaries

    PEP written by Armin Ronacher and Raymond Hettinger. Implementation +written by Raymond Hettinger.

    +
    +
    +
    +
    +
    +

    PEP 378: Format Specifier for Thousands Separator

    +

    The built-in format() function and the str.format() method use +a mini-language that now includes a simple, non-locale aware way to format +a number with a thousands separator. That provides a way to humanize a +program’s output, improving its professional appearance and readability:

    +
    >>> format(1234567, ',d')
    +'1,234,567'
    +>>> format(1234567.89, ',.2f')
    +'1,234,567.89'
    +>>> format(12345.6 + 8901234.12j, ',f')
    +'12,345.600000+8,901,234.120000j'
    +>>> format(Decimal('1234567.89'), ',f')
    +'1,234,567.89'
    +
    +
    +

    The supported types are int, float, complex +and decimal.Decimal.

    +

    Discussions are underway about how to specify alternative separators +like dots, spaces, apostrophes, or underscores. Locale-aware applications +should use the existing n format specifier which already has some support +for thousands separators.

    +
    +

    See also

    +
    +
    PEP 378 - Format Specifier for Thousands Separator

    PEP written by Raymond Hettinger and implemented by Eric Smith and +Mark Dickinson.

    +
    +
    +
    +
    +
    +

    Other Language Changes

    +

    Some smaller changes made to the core Python language are:

    +
      +
    • Directories and zip archives containing a __main__.py +file can now be executed directly by passing their name to the +interpreter. The directory/zipfile is automatically inserted as the +first entry in sys.path. (Suggestion and initial patch by Andy Chu; +revised patch by Phillip J. Eby and Nick Coghlan; bpo-1739468.)

    • +
    • The int() type gained a bit_length method that returns the +number of bits necessary to represent its argument in binary:

      +
      >>> n = 37
      +>>> bin(37)
      +'0b100101'
      +>>> n.bit_length()
      +6
      +>>> n = 2**123-1
      +>>> n.bit_length()
      +123
      +>>> (n+1).bit_length()
      +124
      +
      +
      +

      (Contributed by Fredrik Johansson, Victor Stinner, Raymond Hettinger, +and Mark Dickinson; bpo-3439.)

      +
    • +
    • The fields in format() strings can now be automatically +numbered:

      +
      >>> 'Sir {} of {}'.format('Gallahad', 'Camelot')
      +'Sir Gallahad of Camelot'
      +
      +
      +

      Formerly, the string would have required numbered fields such as: +'Sir {0} of {1}'.

      +

      (Contributed by Eric Smith; bpo-5237.)

      +
    • +
    • The string.maketrans() function is deprecated and is replaced by new +static methods, bytes.maketrans() and bytearray.maketrans(). +This change solves the confusion around which types were supported by the +string module. Now, str, bytes, and +bytearray each have their own maketrans and translate +methods with intermediate translation tables of the appropriate type.

      +

      (Contributed by Georg Brandl; bpo-5675.)

      +
    • +
    • The syntax of the with statement now allows multiple context +managers in a single statement:

      +
      >>> with open('mylog.txt') as infile, open('a.out', 'w') as outfile:
      +...     for line in infile:
      +...         if '<critical>' in line:
      +...             outfile.write(line)
      +
      +
      +

      With the new syntax, the contextlib.nested() function is no longer +needed and is now deprecated.

      +

      (Contributed by Georg Brandl and Mattias Brändström; +appspot issue 53094.)

      +
    • +
    • round(x, n) now returns an integer if x is an integer. +Previously it returned a float:

      +
      >>> round(1123, -2)
      +1100
      +
      +
      +

      (Contributed by Mark Dickinson; bpo-4707.)

      +
    • +
    • Python now uses David Gay’s algorithm for finding the shortest floating +point representation that doesn’t change its value. This should help +mitigate some of the confusion surrounding binary floating point +numbers.

      +

      The significance is easily seen with a number like 1.1 which does not +have an exact equivalent in binary floating point. Since there is no exact +equivalent, an expression like float('1.1') evaluates to the nearest +representable value which is 0x1.199999999999ap+0 in hex or +1.100000000000000088817841970012523233890533447265625 in decimal. That +nearest value was and still is used in subsequent floating point +calculations.

      +

      What is new is how the number gets displayed. Formerly, Python used a +simple approach. The value of repr(1.1) was computed as format(1.1, +'.17g') which evaluated to '1.1000000000000001'. The advantage of +using 17 digits was that it relied on IEEE-754 guarantees to assure that +eval(repr(1.1)) would round-trip exactly to its original value. The +disadvantage is that many people found the output to be confusing (mistaking +intrinsic limitations of binary floating point representation as being a +problem with Python itself).

      +

      The new algorithm for repr(1.1) is smarter and returns '1.1'. +Effectively, it searches all equivalent string representations (ones that +get stored with the same underlying float value) and returns the shortest +representation.

      +

      The new algorithm tends to emit cleaner representations when possible, but +it does not change the underlying values. So, it is still the case that +1.1 + 2.2 != 3.3 even though the representations may suggest otherwise.

      +

      The new algorithm depends on certain features in the underlying floating +point implementation. If the required features are not found, the old +algorithm will continue to be used. Also, the text pickle protocols +assure cross-platform portability by using the old algorithm.

      +

      (Contributed by Eric Smith and Mark Dickinson; bpo-1580)

      +
    • +
    +
    +
    +

    New, Improved, and Deprecated Modules

    +
      +
    • Added a collections.Counter class to support convenient +counting of unique items in a sequence or iterable:

      +
      >>> Counter(['red', 'blue', 'red', 'green', 'blue', 'blue'])
      +Counter({'blue': 3, 'red': 2, 'green': 1})
      +
      +
      +

      (Contributed by Raymond Hettinger; bpo-1696199.)

      +
    • +
    • Added a new module, tkinter.ttk for access to the Tk themed widget set. +The basic idea of ttk is to separate, to the extent possible, the code +implementing a widget’s behavior from the code implementing its appearance.

      +

      (Contributed by Guilherme Polo; bpo-2983.)

      +
    • +
    • The gzip.GzipFile and bz2.BZ2File classes now support +the context management protocol:

      +
      >>> # Automatically close file after writing
      +>>> with gzip.GzipFile(filename, "wb") as f:
      +...     f.write(b"xxx")
      +
      +
      +

      (Contributed by Antoine Pitrou.)

      +
    • +
    • The decimal module now supports methods for creating a +decimal object from a binary float. The conversion is +exact but can sometimes be surprising:

      +
      >>> Decimal.from_float(1.1)
      +Decimal('1.100000000000000088817841970012523233890533447265625')
      +
      +
      +

      The long decimal result shows the actual binary fraction being +stored for 1.1. The fraction has many digits because 1.1 cannot +be exactly represented in binary.

      +

      (Contributed by Raymond Hettinger and Mark Dickinson.)

      +
    • +
    • The itertools module grew two new functions. The +itertools.combinations_with_replacement() function is one of +four for generating combinatorics including permutations and Cartesian +products. The itertools.compress() function mimics its namesake +from APL. Also, the existing itertools.count() function now has +an optional step argument and can accept any type of counting +sequence including fractions.Fraction and +decimal.Decimal:

      +
      >>> [p+q for p,q in combinations_with_replacement('LOVE', 2)]
      +['LL', 'LO', 'LV', 'LE', 'OO', 'OV', 'OE', 'VV', 'VE', 'EE']
      +
      +>>> list(compress(data=range(10), selectors=[0,0,1,1,0,1,0,1,0,0]))
      +[2, 3, 5, 7]
      +
      +>>> c = count(start=Fraction(1,2), step=Fraction(1,6))
      +>>> [next(c), next(c), next(c), next(c)]
      +[Fraction(1, 2), Fraction(2, 3), Fraction(5, 6), Fraction(1, 1)]
      +
      +
      +

      (Contributed by Raymond Hettinger.)

      +
    • +
    • collections.namedtuple() now supports a keyword argument +rename which lets invalid fieldnames be automatically converted to +positional names in the form _0, _1, etc. This is useful when +the field names are being created by an external source such as a +CSV header, SQL field list, or user input:

      +
      >>> query = input()
      +SELECT region, dept, count(*) FROM main GROUPBY region, dept
      +
      +>>> cursor.execute(query)
      +>>> query_fields = [desc[0] for desc in cursor.description]
      +>>> UserQuery = namedtuple('UserQuery', query_fields, rename=True)
      +>>> pprint.pprint([UserQuery(*row) for row in cursor])
      +[UserQuery(region='South', dept='Shipping', _2=185),
      + UserQuery(region='North', dept='Accounting', _2=37),
      + UserQuery(region='West', dept='Sales', _2=419)]
      +
      +
      +

      (Contributed by Raymond Hettinger; bpo-1818.)

      +
    • +
    • The re.sub(), re.subn() and re.split() functions now +accept a flags parameter.

      +

      (Contributed by Gregory Smith.)

      +
    • +
    • The logging module now implements a simple logging.NullHandler +class for applications that are not using logging but are calling +library code that does. Setting-up a null handler will suppress +spurious warnings such as “No handlers could be found for logger foo”:

      +
      >>> h = logging.NullHandler()
      +>>> logging.getLogger("foo").addHandler(h)
      +
      +
      +

      (Contributed by Vinay Sajip; bpo-4384).

      +
    • +
    • The runpy module which supports the -m command line switch +now supports the execution of packages by looking for and executing +a __main__ submodule when a package name is supplied.

      +

      (Contributed by Andi Vajda; bpo-4195.)

      +
    • +
    • The pdb module can now access and display source code loaded via +zipimport (or any other conformant PEP 302 loader).

      +

      (Contributed by Alexander Belopolsky; bpo-4201.)

      +
    • +
    • functools.partial objects can now be pickled.

    • +
    +
    +

    (Suggested by Antoine Pitrou and Jesse Noller. Implemented by +Jack Diederich; bpo-5228.)

    +
    +
      +
    • Add pydoc help topics for symbols so that help('@') +works as expected in the interactive environment.

      +

      (Contributed by David Laban; bpo-4739.)

      +
    • +
    • The unittest module now supports skipping individual tests or classes +of tests. And it supports marking a test as an expected failure, a test that +is known to be broken, but shouldn’t be counted as a failure on a +TestResult:

      +
      class TestGizmo(unittest.TestCase):
      +
      +    @unittest.skipUnless(sys.platform.startswith("win"), "requires Windows")
      +    def test_gizmo_on_windows(self):
      +        ...
      +
      +    @unittest.expectedFailure
      +    def test_gimzo_without_required_library(self):
      +        ...
      +
      +
      +

      Also, tests for exceptions have been builtout to work with context managers +using the with statement:

      +
      def test_division_by_zero(self):
      +    with self.assertRaises(ZeroDivisionError):
      +        x / 0
      +
      +
      +

      In addition, several new assertion methods were added including +assertSetEqual(), assertDictEqual(), +assertDictContainsSubset(), assertListEqual(), +assertTupleEqual(), assertSequenceEqual(), +assertRaisesRegexp(), assertIsNone(), +and assertIsNotNone().

      +

      (Contributed by Benjamin Peterson and Antoine Pitrou.)

      +
    • +
    • The io module has three new constants for the seek() +method SEEK_SET, SEEK_CUR, and SEEK_END.

    • +
    • The sys.version_info tuple is now a named tuple:

      +
      >>> sys.version_info
      +sys.version_info(major=3, minor=1, micro=0, releaselevel='alpha', serial=2)
      +
      +
      +

      (Contributed by Ross Light; bpo-4285.)

      +
    • +
    • The nntplib and imaplib modules now support IPv6.

      +

      (Contributed by Derek Morr; bpo-1655 and bpo-1664.)

      +
    • +
    • The pickle module has been adapted for better interoperability with +Python 2.x when used with protocol 2 or lower. The reorganization of the +standard library changed the formal reference for many objects. For +example, __builtin__.set in Python 2 is called builtins.set in Python +3. This change confounded efforts to share data between different versions of +Python. But now when protocol 2 or lower is selected, the pickler will +automatically use the old Python 2 names for both loading and dumping. This +remapping is turned-on by default but can be disabled with the fix_imports +option:

      +
      >>> s = {1, 2, 3}
      +>>> pickle.dumps(s, protocol=0)
      +b'c__builtin__\nset\np0\n((lp1\nL1L\naL2L\naL3L\natp2\nRp3\n.'
      +>>> pickle.dumps(s, protocol=0, fix_imports=False)
      +b'cbuiltins\nset\np0\n((lp1\nL1L\naL2L\naL3L\natp2\nRp3\n.'
      +
      +
      +

      An unfortunate but unavoidable side-effect of this change is that protocol 2 +pickles produced by Python 3.1 won’t be readable with Python 3.0. The latest +pickle protocol, protocol 3, should be used when migrating data between +Python 3.x implementations, as it doesn’t attempt to remain compatible with +Python 2.x.

      +

      (Contributed by Alexandre Vassalotti and Antoine Pitrou, bpo-6137.)

      +
    • +
    • A new module, importlib was added. It provides a complete, portable, +pure Python reference implementation of the import statement and its +counterpart, the __import__() function. It represents a substantial +step forward in documenting and defining the actions that take place during +imports.

      +

      (Contributed by Brett Cannon.)

      +
    • +
    +
    +
    +

    Optimizations

    +

    Major performance enhancements have been added:

    +
      +
    • The new I/O library (as defined in PEP 3116) was mostly written in +Python and quickly proved to be a problematic bottleneck in Python 3.0. +In Python 3.1, the I/O library has been entirely rewritten in C and is +2 to 20 times faster depending on the task at hand. The pure Python +version is still available for experimentation purposes through +the _pyio module.

      +

      (Contributed by Amaury Forgeot d’Arc and Antoine Pitrou.)

      +
    • +
    • Added a heuristic so that tuples and dicts containing only untrackable objects +are not tracked by the garbage collector. This can reduce the size of +collections and therefore the garbage collection overhead on long-running +programs, depending on their particular use of datatypes.

      +

      (Contributed by Antoine Pitrou, bpo-4688.)

      +
    • +
    • Enabling a configure option named --with-computed-gotos +on compilers that support it (notably: gcc, SunPro, icc), the bytecode +evaluation loop is compiled with a new dispatch mechanism which gives +speedups of up to 20%, depending on the system, the compiler, and +the benchmark.

      +

      (Contributed by Antoine Pitrou along with a number of other participants, +bpo-4753).

      +
    • +
    • The decoding of UTF-8, UTF-16 and LATIN-1 is now two to four times +faster.

      +

      (Contributed by Antoine Pitrou and Amaury Forgeot d’Arc, bpo-4868.)

      +
    • +
    • The json module now has a C extension to substantially improve +its performance. In addition, the API was modified so that json works +only with str, not with bytes. That change makes the +module closely match the JSON specification +which is defined in terms of Unicode.

      +

      (Contributed by Bob Ippolito and converted to Py3.1 by Antoine Pitrou +and Benjamin Peterson; bpo-4136.)

      +
    • +
    • Unpickling now interns the attribute names of pickled objects. This saves +memory and allows pickles to be smaller.

      +

      (Contributed by Jake McGuire and Antoine Pitrou; bpo-5084.)

      +
    • +
    +
    +
    +

    IDLE

    +
      +
    • IDLE’s format menu now provides an option to strip trailing whitespace +from a source file.

      +

      (Contributed by Roger D. Serwy; bpo-5150.)

      +
    • +
    +
    +
    +

    Build and C API Changes

    +

    Changes to Python’s build process and to the C API include:

    +
      +
    • Integers are now stored internally either in base 2**15 or in base +2**30, the base being determined at build time. Previously, they +were always stored in base 2**15. Using base 2**30 gives +significant performance improvements on 64-bit machines, but +benchmark results on 32-bit machines have been mixed. Therefore, +the default is to use base 2**30 on 64-bit machines and base 2**15 +on 32-bit machines; on Unix, there’s a new configure option +--enable-big-digits that can be used to override this default.

      +

      Apart from the performance improvements this change should be invisible to +end users, with one exception: for testing and debugging purposes there’s a +new sys.int_info that provides information about the +internal format, giving the number of bits per digit and the size in bytes +of the C type used to store each digit:

      +
      >>> import sys
      +>>> sys.int_info
      +sys.int_info(bits_per_digit=30, sizeof_digit=4)
      +
      +
      +

      (Contributed by Mark Dickinson; bpo-4258.)

      +
    • +
    • The PyLong_AsUnsignedLongLong() function now handles a negative +pylong by raising OverflowError instead of TypeError.

      +

      (Contributed by Mark Dickinson and Lisandro Dalcrin; bpo-5175.)

      +
    • +
    • Deprecated PyNumber_Int(). Use PyNumber_Long() instead.

      +

      (Contributed by Mark Dickinson; bpo-4910.)

      +
    • +
    • Added a new PyOS_string_to_double() function to replace the +deprecated functions PyOS_ascii_strtod() and PyOS_ascii_atof().

      +

      (Contributed by Mark Dickinson; bpo-5914.)

      +
    • +
    • Added PyCapsule as a replacement for the PyCObject API. +The principal difference is that the new type has a well defined interface +for passing typing safety information and a less complicated signature +for calling a destructor. The old type had a problematic API and is now +deprecated.

      +

      (Contributed by Larry Hastings; bpo-5630.)

      +
    • +
    +
    +
    +

    Porting to Python 3.1

    +

    This section lists previously described changes and other bugfixes +that may require changes to your code:

    +
      +
    • The new floating point string representations can break existing doctests. +For example:

      +
      def e():
      +    '''Compute the base of natural logarithms.
      +
      +    >>> e()
      +    2.7182818284590451
      +
      +    '''
      +    return sum(1/math.factorial(x) for x in reversed(range(30)))
      +
      +doctest.testmod()
      +
      +**********************************************************************
      +Failed example:
      +    e()
      +Expected:
      +    2.7182818284590451
      +Got:
      +    2.718281828459045
      +**********************************************************************
      +
      +
      +
    • +
    • The automatic name remapping in the pickle module for protocol 2 or lower can +make Python 3.1 pickles unreadable in Python 3.0. One solution is to use +protocol 3. Another solution is to set the fix_imports option to False. +See the discussion above for more details.

    • +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/whatsnew/3.2.html b/python-3.7.4-docs-html/whatsnew/3.2.html new file mode 100644 index 0000000..386da44 --- /dev/null +++ b/python-3.7.4-docs-html/whatsnew/3.2.html @@ -0,0 +1,2724 @@ + + + + + + + What’s New In Python 3.2 — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    What’s New In Python 3.2

    +
    +
    Author
    +

    Raymond Hettinger

    +
    +
    +

    This article explains the new features in Python 3.2 as compared to 3.1. It +focuses on a few highlights and gives a few examples. For full details, see the +Misc/NEWS +file.

    +
    +

    See also

    +

    PEP 392 - Python 3.2 Release Schedule

    +
    +
    +

    PEP 384: Defining a Stable ABI

    +

    In the past, extension modules built for one Python version were often +not usable with other Python versions. Particularly on Windows, every +feature release of Python required rebuilding all extension modules that +one wanted to use. This requirement was the result of the free access to +Python interpreter internals that extension modules could use.

    +

    With Python 3.2, an alternative approach becomes available: extension +modules which restrict themselves to a limited API (by defining +Py_LIMITED_API) cannot use many of the internals, but are constrained +to a set of API functions that are promised to be stable for several +releases. As a consequence, extension modules built for 3.2 in that +mode will also work with 3.3, 3.4, and so on. Extension modules that +make use of details of memory structures can still be built, but will +need to be recompiled for every feature release.

    +
    +

    See also

    +
    +
    PEP 384 - Defining a Stable ABI

    PEP written by Martin von Löwis.

    +
    +
    +
    +
    +
    +

    PEP 389: Argparse Command Line Parsing Module

    +

    A new module for command line parsing, argparse, was introduced to +overcome the limitations of optparse which did not provide support for +positional arguments (not just options), subcommands, required options and other +common patterns of specifying and validating options.

    +

    This module has already had widespread success in the community as a +third-party module. Being more fully featured than its predecessor, the +argparse module is now the preferred module for command-line processing. +The older module is still being kept available because of the substantial amount +of legacy code that depends on it.

    +

    Here’s an annotated example parser showing features like limiting results to a +set of choices, specifying a metavar in the help screen, validating that one +or more positional arguments is present, and making a required option:

    +
    import argparse
    +parser = argparse.ArgumentParser(
    +            description = 'Manage servers',         # main description for help
    +            epilog = 'Tested on Solaris and Linux') # displayed after help
    +parser.add_argument('action',                       # argument name
    +            choices = ['deploy', 'start', 'stop'],  # three allowed values
    +            help = 'action on each target')         # help msg
    +parser.add_argument('targets',
    +            metavar = 'HOSTNAME',                   # var name used in help msg
    +            nargs = '+',                            # require one or more targets
    +            help = 'url for target machines')       # help msg explanation
    +parser.add_argument('-u', '--user',                 # -u or --user option
    +            required = True,                        # make it a required argument
    +            help = 'login as user')
    +
    +
    +

    Example of calling the parser on a command string:

    +
    >>> cmd = 'deploy sneezy.example.com sleepy.example.com -u skycaptain'
    +>>> result = parser.parse_args(cmd.split())
    +>>> result.action
    +'deploy'
    +>>> result.targets
    +['sneezy.example.com', 'sleepy.example.com']
    +>>> result.user
    +'skycaptain'
    +
    +
    +

    Example of the parser’s automatically generated help:

    +
    >>> parser.parse_args('-h'.split())
    +
    +usage: manage_cloud.py [-h] -u USER
    +                       {deploy,start,stop} HOSTNAME [HOSTNAME ...]
    +
    +Manage servers
    +
    +positional arguments:
    +  {deploy,start,stop}   action on each target
    +  HOSTNAME              url for target machines
    +
    +optional arguments:
    +  -h, --help            show this help message and exit
    +  -u USER, --user USER  login as user
    +
    +Tested on Solaris and Linux
    +
    +
    +

    An especially nice argparse feature is the ability to define subparsers, +each with their own argument patterns and help displays:

    +
    import argparse
    +parser = argparse.ArgumentParser(prog='HELM')
    +subparsers = parser.add_subparsers()
    +
    +parser_l = subparsers.add_parser('launch', help='Launch Control')   # first subgroup
    +parser_l.add_argument('-m', '--missiles', action='store_true')
    +parser_l.add_argument('-t', '--torpedos', action='store_true')
    +
    +parser_m = subparsers.add_parser('move', help='Move Vessel',        # second subgroup
    +                                 aliases=('steer', 'turn'))         # equivalent names
    +parser_m.add_argument('-c', '--course', type=int, required=True)
    +parser_m.add_argument('-s', '--speed', type=int, default=0)
    +
    +
    +
    $ ./helm.py --help                         # top level help (launch and move)
    +$ ./helm.py launch --help                  # help for launch options
    +$ ./helm.py launch --missiles              # set missiles=True and torpedos=False
    +$ ./helm.py steer --course 180 --speed 5   # set movement parameters
    +
    +
    +
    +

    See also

    +
    +
    PEP 389 - New Command Line Parsing Module

    PEP written by Steven Bethard.

    +
    +
    +

    Upgrading optparse code for details on the differences from optparse.

    +
    +
    +
    +

    PEP 391: Dictionary Based Configuration for Logging

    +

    The logging module provided two kinds of configuration, one style with +function calls for each option or another style driven by an external file saved +in a ConfigParser format. Those options did not provide the flexibility +to create configurations from JSON or YAML files, nor did they support +incremental configuration, which is needed for specifying logger options from a +command line.

    +

    To support a more flexible style, the module now offers +logging.config.dictConfig() for specifying logging configuration with +plain Python dictionaries. The configuration options include formatters, +handlers, filters, and loggers. Here’s a working example of a configuration +dictionary:

    +
    {"version": 1,
    + "formatters": {"brief": {"format": "%(levelname)-8s: %(name)-15s: %(message)s"},
    +                "full": {"format": "%(asctime)s %(name)-15s %(levelname)-8s %(message)s"}
    +                },
    + "handlers": {"console": {
    +                   "class": "logging.StreamHandler",
    +                   "formatter": "brief",
    +                   "level": "INFO",
    +                   "stream": "ext://sys.stdout"},
    +              "console_priority": {
    +                   "class": "logging.StreamHandler",
    +                   "formatter": "full",
    +                   "level": "ERROR",
    +                   "stream": "ext://sys.stderr"}
    +              },
    + "root": {"level": "DEBUG", "handlers": ["console", "console_priority"]}}
    +
    +
    +

    If that dictionary is stored in a file called conf.json, it can be +loaded and called with code like this:

    +
    >>> import json, logging.config
    +>>> with open('conf.json') as f:
    +...     conf = json.load(f)
    +...
    +>>> logging.config.dictConfig(conf)
    +>>> logging.info("Transaction completed normally")
    +INFO    : root           : Transaction completed normally
    +>>> logging.critical("Abnormal termination")
    +2011-02-17 11:14:36,694 root            CRITICAL Abnormal termination
    +
    +
    +
    +

    See also

    +
    +
    PEP 391 - Dictionary Based Configuration for Logging

    PEP written by Vinay Sajip.

    +
    +
    +
    +
    +
    +

    PEP 3148: The concurrent.futures module

    +

    Code for creating and managing concurrency is being collected in a new top-level +namespace, concurrent. Its first member is a futures package which provides +a uniform high-level interface for managing threads and processes.

    +

    The design for concurrent.futures was inspired by the +java.util.concurrent package. In that model, a running call and its result +are represented by a Future object that abstracts +features common to threads, processes, and remote procedure calls. That object +supports status checks (running or done), timeouts, cancellations, adding +callbacks, and access to results or exceptions.

    +

    The primary offering of the new module is a pair of executor classes for +launching and managing calls. The goal of the executors is to make it easier to +use existing tools for making parallel calls. They save the effort needed to +setup a pool of resources, launch the calls, create a results queue, add +time-out handling, and limit the total number of threads, processes, or remote +procedure calls.

    +

    Ideally, each application should share a single executor across multiple +components so that process and thread limits can be centrally managed. This +solves the design challenge that arises when each component has its own +competing strategy for resource management.

    +

    Both classes share a common interface with three methods: +submit() for scheduling a callable and +returning a Future object; +map() for scheduling many asynchronous calls +at a time, and shutdown() for freeing +resources. The class is a context manager and can be used in a +with statement to assure that resources are automatically released +when currently pending futures are done executing.

    +

    A simple of example of ThreadPoolExecutor is a +launch of four parallel threads for copying files:

    +
    import concurrent.futures, shutil
    +with concurrent.futures.ThreadPoolExecutor(max_workers=4) as e:
    +    e.submit(shutil.copy, 'src1.txt', 'dest1.txt')
    +    e.submit(shutil.copy, 'src2.txt', 'dest2.txt')
    +    e.submit(shutil.copy, 'src3.txt', 'dest3.txt')
    +    e.submit(shutil.copy, 'src3.txt', 'dest4.txt')
    +
    +
    +
    +

    See also

    +
    +
    PEP 3148 - Futures – Execute Computations Asynchronously

    PEP written by Brian Quinlan.

    +
    +
    +

    Code for Threaded Parallel URL reads, an +example using threads to fetch multiple web pages in parallel.

    +

    Code for computing prime numbers in +parallel, an example demonstrating +ProcessPoolExecutor.

    +
    +
    +
    +

    PEP 3147: PYC Repository Directories

    +

    Python’s scheme for caching bytecode in .pyc files did not work well in +environments with multiple Python interpreters. If one interpreter encountered +a cached file created by another interpreter, it would recompile the source and +overwrite the cached file, thus losing the benefits of caching.

    +

    The issue of “pyc fights” has become more pronounced as it has become +commonplace for Linux distributions to ship with multiple versions of Python. +These conflicts also arise with CPython alternatives such as Unladen Swallow.

    +

    To solve this problem, Python’s import machinery has been extended to use +distinct filenames for each interpreter. Instead of Python 3.2 and Python 3.3 and +Unladen Swallow each competing for a file called “mymodule.pyc”, they will now +look for “mymodule.cpython-32.pyc”, “mymodule.cpython-33.pyc”, and +“mymodule.unladen10.pyc”. And to prevent all of these new files from +cluttering source directories, the pyc files are now collected in a +“__pycache__” directory stored under the package directory.

    +

    Aside from the filenames and target directories, the new scheme has a few +aspects that are visible to the programmer:

    +
      +
    • Imported modules now have a __cached__ attribute which stores the name +of the actual file that was imported:

      +
      >>> import collections
      +>>> collections.__cached__ # doctest: +SKIP
      +'c:/py32/lib/__pycache__/collections.cpython-32.pyc'
      +
      +
      +
    • +
    • The tag that is unique to each interpreter is accessible from the imp +module:

      +
      >>> import imp
      +>>> imp.get_tag() # doctest: +SKIP
      +'cpython-32'
      +
      +
      +
    • +
    • Scripts that try to deduce source filename from the imported file now need to +be smarter. It is no longer sufficient to simply strip the “c” from a “.pyc” +filename. Instead, use the new functions in the imp module:

      +
      >>> imp.source_from_cache('c:/py32/lib/__pycache__/collections.cpython-32.pyc')
      +'c:/py32/lib/collections.py'
      +>>> imp.cache_from_source('c:/py32/lib/collections.py') # doctest: +SKIP
      +'c:/py32/lib/__pycache__/collections.cpython-32.pyc'
      +
      +
      +
    • +
    • The py_compile and compileall modules have been updated to +reflect the new naming convention and target directory. The command-line +invocation of compileall has new options: -i for +specifying a list of files and directories to compile and -b which causes +bytecode files to be written to their legacy location rather than +__pycache__.

    • +
    • The importlib.abc module has been updated with new abstract base +classes for loading bytecode files. The obsolete +ABCs, PyLoader and +PyPycLoader, have been deprecated (instructions on how +to stay Python 3.1 compatible are included with the documentation).

    • +
    +
    +

    See also

    +
    +
    PEP 3147 - PYC Repository Directories

    PEP written by Barry Warsaw.

    +
    +
    +
    +
    +
    +

    PEP 3149: ABI Version Tagged .so Files

    +

    The PYC repository directory allows multiple bytecode cache files to be +co-located. This PEP implements a similar mechanism for shared object files by +giving them a common directory and distinct names for each version.

    +

    The common directory is “pyshared” and the file names are made distinct by +identifying the Python implementation (such as CPython, PyPy, Jython, etc.), the +major and minor version numbers, and optional build flags (such as “d” for +debug, “m” for pymalloc, “u” for wide-unicode). For an arbitrary package “foo”, +you may see these files when the distribution package is installed:

    +
    /usr/share/pyshared/foo.cpython-32m.so
    +/usr/share/pyshared/foo.cpython-33md.so
    +
    +
    +

    In Python itself, the tags are accessible from functions in the sysconfig +module:

    +
    >>> import sysconfig
    +>>> sysconfig.get_config_var('SOABI')       # find the version tag
    +'cpython-32mu'
    +>>> sysconfig.get_config_var('EXT_SUFFIX')  # find the full filename extension
    +'.cpython-32mu.so'
    +
    +
    +
    +

    See also

    +
    +
    PEP 3149 - ABI Version Tagged .so Files

    PEP written by Barry Warsaw.

    +
    +
    +
    +
    +
    +

    PEP 3333: Python Web Server Gateway Interface v1.0.1

    +

    This informational PEP clarifies how bytes/text issues are to be handled by the +WSGI protocol. The challenge is that string handling in Python 3 is most +conveniently handled with the str type even though the HTTP protocol +is itself bytes oriented.

    +

    The PEP differentiates so-called native strings that are used for +request/response headers and metadata versus byte strings which are used for +the bodies of requests and responses.

    +

    The native strings are always of type str but are restricted to code +points between U+0000 through U+00FF which are translatable to bytes using +Latin-1 encoding. These strings are used for the keys and values in the +environment dictionary and for response headers and statuses in the +start_response() function. They must follow RFC 2616 with respect to +encoding. That is, they must either be ISO-8859-1 characters or use +RFC 2047 MIME encoding.

    +

    For developers porting WSGI applications from Python 2, here are the salient +points:

    +
      +
    • If the app already used strings for headers in Python 2, no change is needed.

    • +
    • If instead, the app encoded output headers or decoded input headers, then the +headers will need to be re-encoded to Latin-1. For example, an output header +encoded in utf-8 was using h.encode('utf-8') now needs to convert from +bytes to native strings using h.encode('utf-8').decode('latin-1').

    • +
    • Values yielded by an application or sent using the write() method +must be byte strings. The start_response() function and environ +must use native strings. The two cannot be mixed.

    • +
    +

    For server implementers writing CGI-to-WSGI pathways or other CGI-style +protocols, the users must to be able access the environment using native strings +even though the underlying platform may have a different convention. To bridge +this gap, the wsgiref module has a new function, +wsgiref.handlers.read_environ() for transcoding CGI variables from +os.environ into native strings and returning a new dictionary.

    +
    +

    See also

    +
    +
    PEP 3333 - Python Web Server Gateway Interface v1.0.1

    PEP written by Phillip Eby.

    +
    +
    +
    +
    +
    +

    Other Language Changes

    +

    Some smaller changes made to the core Python language are:

    +
      +
    • String formatting for format() and str.format() gained new +capabilities for the format character #. Previously, for integers in +binary, octal, or hexadecimal, it caused the output to be prefixed with ‘0b’, +‘0o’, or ‘0x’ respectively. Now it can also handle floats, complex, and +Decimal, causing the output to always have a decimal point even when no digits +follow it.

      +
      >>> format(20, '#o')
      +'0o24'
      +>>> format(12.34, '#5.0f')
      +'  12.'
      +
      +
      +

      (Suggested by Mark Dickinson and implemented by Eric Smith in bpo-7094.)

      +
    • +
    • There is also a new str.format_map() method that extends the +capabilities of the existing str.format() method by accepting arbitrary +mapping objects. This new method makes it possible to use string +formatting with any of Python’s many dictionary-like objects such as +defaultdict, Shelf, +ConfigParser, or dbm. It is also useful with +custom dict subclasses that normalize keys before look-up or that +supply a __missing__() method for unknown keys:

      +
      >>> import shelve
      +>>> d = shelve.open('tmp.shl')
      +>>> 'The {project_name} status is {status} as of {date}'.format_map(d)
      +'The testing project status is green as of February 15, 2011'
      +
      +>>> class LowerCasedDict(dict):
      +...     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)
      +>>> 'Hello {name}, welcome to {location}'.format_map(PlaceholderDict())
      +'Hello <name>, welcome to <location>'
      +
      +
      +
    • +
    +
    +

    (Suggested by Raymond Hettinger and implemented by Eric Smith in +bpo-6081.)

    +
    +
      +
    • The interpreter can now be started with a quiet option, -q, to prevent +the copyright and version information from being displayed in the interactive +mode. The option can be introspected using the sys.flags attribute:

      +
      $ python -q
      +>>> sys.flags
      +sys.flags(debug=0, division_warning=0, inspect=0, interactive=0,
      +optimize=0, dont_write_bytecode=0, no_user_site=0, no_site=0,
      +ignore_environment=0, verbose=0, bytes_warning=0, quiet=1)
      +
      +
      +

      (Contributed by Marcin Wojdyr in bpo-1772833).

      +
    • +
    • The hasattr() function works by calling getattr() and detecting +whether an exception is raised. This technique allows it to detect methods +created dynamically by __getattr__() or __getattribute__() which +would otherwise be absent from the class dictionary. Formerly, hasattr +would catch any exception, possibly masking genuine errors. Now, hasattr +has been tightened to only catch AttributeError and let other +exceptions pass through:

      +
      >>> class A:
      +...     @property
      +...     def f(self):
      +...         return 1 // 0
      +...
      +>>> a = A()
      +>>> hasattr(a, 'f')
      +Traceback (most recent call last):
      +  ...
      +ZeroDivisionError: integer division or modulo by zero
      +
      +
      +

      (Discovered by Yury Selivanov and fixed by Benjamin Peterson; bpo-9666.)

      +
    • +
    • The str() of a float or complex number is now the same as its +repr(). Previously, the str() form was shorter but that just +caused confusion and is no longer needed now that the shortest possible +repr() is displayed by default:

      +
      >>> import math
      +>>> repr(math.pi)
      +'3.141592653589793'
      +>>> str(math.pi)
      +'3.141592653589793'
      +
      +
      +

      (Proposed and implemented by Mark Dickinson; bpo-9337.)

      +
    • +
    • memoryview objects now have a release() method +and they also now support the context management protocol. This allows timely +release of any resources that were acquired when requesting a buffer from the +original object.

      +
      >>> with memoryview(b'abcdefgh') as v:
      +...     print(v.tolist())
      +[97, 98, 99, 100, 101, 102, 103, 104]
      +
      +
      +

      (Added by Antoine Pitrou; bpo-9757.)

      +
    • +
    • Previously it was illegal to delete a name from the local namespace if it +occurs as a free variable in a nested block:

      +
      def outer(x):
      +    def inner():
      +        return x
      +    inner()
      +    del x
      +
      +
      +

      This is now allowed. Remember that the target of an except clause +is cleared, so this code which used to work with Python 2.6, raised a +SyntaxError with Python 3.1 and now works again:

      +
      def f():
      +    def print_error():
      +        print(e)
      +    try:
      +        something
      +    except Exception as e:
      +        print_error()
      +        # implicit "del e" here
      +
      +
      +

      (See bpo-4617.)

      +
    • +
    • The internal structsequence tool now creates subclasses of tuple. +This means that C structures like those returned by os.stat(), +time.gmtime(), and sys.version_info now work like a +named tuple and now work with functions and methods that +expect a tuple as an argument. This is a big step forward in making the C +structures as flexible as their pure Python counterparts:

      +
      >>> import sys
      +>>> isinstance(sys.version_info, tuple)
      +True
      +>>> 'Version %d.%d.%d %s(%d)' % sys.version_info # doctest: +SKIP
      +'Version 3.2.0 final(0)'
      +
      +
      +

      (Suggested by Arfrever Frehtes Taifersar Arahesis and implemented +by Benjamin Peterson in bpo-8413.)

      +
    • +
    • Warnings are now easier to control using the PYTHONWARNINGS +environment variable as an alternative to using -W at the command line:

      +
      $ export PYTHONWARNINGS='ignore::RuntimeWarning::,once::UnicodeWarning::'
      +
      +
      +

      (Suggested by Barry Warsaw and implemented by Philip Jenvey in bpo-7301.)

      +
    • +
    • A new warning category, ResourceWarning, has been added. It is +emitted when potential issues with resource consumption or cleanup +are detected. It is silenced by default in normal release builds but +can be enabled through the means provided by the warnings +module, or on the command line.

      +

      A ResourceWarning is issued at interpreter shutdown if the +gc.garbage list isn’t empty, and if gc.DEBUG_UNCOLLECTABLE is +set, all uncollectable objects are printed. This is meant to make the +programmer aware that their code contains object finalization issues.

      +

      A ResourceWarning is also issued when a file object is destroyed +without having been explicitly closed. While the deallocator for such +object ensures it closes the underlying operating system resource +(usually, a file descriptor), the delay in deallocating the object could +produce various issues, especially under Windows. Here is an example +of enabling the warning from the command line:

      +
      $ python -q -Wdefault
      +>>> f = open("foo", "wb")
      +>>> del f
      +__main__:1: ResourceWarning: unclosed file <_io.BufferedWriter name='foo'>
      +
      +
      +

      (Added by Antoine Pitrou and Georg Brandl in bpo-10093 and bpo-477863.)

      +
    • +
    • range objects now support index and count methods. This is part +of an effort to make more objects fully implement the +collections.Sequence abstract base class. As a result, the +language will have a more uniform API. In addition, range objects +now support slicing and negative indices, even with values larger than +sys.maxsize. This makes range more interoperable with lists:

      +
      >>> range(0, 100, 2).count(10)
      +1
      +>>> range(0, 100, 2).index(10)
      +5
      +>>> range(0, 100, 2)[5]
      +10
      +>>> range(0, 100, 2)[0:5]
      +range(0, 10, 2)
      +
      +
      +

      (Contributed by Daniel Stutzbach in bpo-9213, by Alexander Belopolsky +in bpo-2690, and by Nick Coghlan in bpo-10889.)

      +
    • +
    • The callable() builtin function from Py2.x was resurrected. It provides +a concise, readable alternative to using an abstract base class in an +expression like isinstance(x, collections.Callable):

      +
      >>> callable(max)
      +True
      +>>> callable(20)
      +False
      +
      +
      +

      (See bpo-10518.)

      +
    • +
    • Python’s import mechanism can now load modules installed in directories with +non-ASCII characters in the path name. This solved an aggravating problem +with home directories for users with non-ASCII characters in their usernames.

    • +
    +
    +

    (Required extensive work by Victor Stinner in bpo-9425.)

    +
    +
    +
    +

    New, Improved, and Deprecated Modules

    +

    Python’s standard library has undergone significant maintenance efforts and +quality improvements.

    +

    The biggest news for Python 3.2 is that the email package, mailbox +module, and nntplib modules now work correctly with the bytes/text model +in Python 3. For the first time, there is correct handling of messages with +mixed encodings.

    +

    Throughout the standard library, there has been more careful attention to +encodings and text versus bytes issues. In particular, interactions with the +operating system are now better able to exchange non-ASCII data using the +Windows MBCS encoding, locale-aware encodings, or UTF-8.

    +

    Another significant win is the addition of substantially better support for +SSL connections and security certificates.

    +

    In addition, more classes now implement a context manager to support +convenient and reliable resource clean-up using a with statement.

    +
    +

    email

    +

    The usability of the email package in Python 3 has been mostly fixed by +the extensive efforts of R. David Murray. The problem was that emails are +typically read and stored in the form of bytes rather than str +text, and they may contain multiple encodings within a single email. So, the +email package had to be extended to parse and generate email messages in bytes +format.

    +
      +
    • New functions message_from_bytes() and +message_from_binary_file(), and new classes +BytesFeedParser and BytesParser +allow binary message data to be parsed into model objects.

    • +
    • Given bytes input to the model, get_payload() +will by default decode a message body that has a +Content-Transfer-Encoding of 8bit using the charset +specified in the MIME headers and return the resulting string.

    • +
    • Given bytes input to the model, Generator will +convert message bodies that have a Content-Transfer-Encoding of +8bit to instead have a 7bit Content-Transfer-Encoding.

      +

      Headers with unencoded non-ASCII bytes are deemed to be RFC 2047-encoded +using the unknown-8bit character set.

      +
    • +
    • A new class BytesGenerator produces bytes as output, +preserving any unchanged non-ASCII data that was present in the input used to +build the model, including message bodies with a +Content-Transfer-Encoding of 8bit.

    • +
    • The smtplib SMTP class now accepts a byte string +for the msg argument to the sendmail() method, +and a new method, send_message() accepts a +Message object and can optionally obtain the +from_addr and to_addrs addresses directly from the object.

    • +
    +

    (Proposed and implemented by R. David Murray, bpo-4661 and bpo-10321.)

    +
    +
    +

    elementtree

    +

    The xml.etree.ElementTree package and its xml.etree.cElementTree +counterpart have been updated to version 1.3.

    +

    Several new and useful functions and methods have been added:

    + +

    Two methods have been deprecated:

    +
      +
    • xml.etree.ElementTree.getchildren() use list(elem) instead.

    • +
    • xml.etree.ElementTree.getiterator() use Element.iter instead.

    • +
    +

    For details of the update, see Introducing ElementTree on Fredrik Lundh’s website.

    +

    (Contributed by Florent Xicluna and Fredrik Lundh, bpo-6472.)

    +
    +
    +

    functools

    +
      +
    • The functools module includes a new decorator for caching function +calls. functools.lru_cache() can save repeated queries to an external +resource whenever the results are expected to be the same.

      +

      For example, adding a caching decorator to a database query function can save +database accesses for popular searches:

      +
      >>> import functools
      +>>> @functools.lru_cache(maxsize=300)
      +... def get_phone_number(name):
      +...     c = conn.cursor()
      +...     c.execute('SELECT phonenumber FROM phonelist WHERE name=?', (name,))
      +...     return c.fetchone()[0]
      +
      +
      +
      >>> for name in user_requests:        # doctest: +SKIP
      +...     get_phone_number(name)        # cached lookup
      +
      +
      +

      To help with choosing an effective cache size, the wrapped function is +instrumented for tracking cache statistics:

      +
      >>> get_phone_number.cache_info()     # doctest: +SKIP
      +CacheInfo(hits=4805, misses=980, maxsize=300, currsize=300)
      +
      +
      +

      If the phonelist table gets updated, the outdated contents of the cache can be +cleared with:

      +
      >>> get_phone_number.cache_clear()
      +
      +
      +

      (Contributed by Raymond Hettinger and incorporating design ideas from Jim +Baker, Miki Tebeka, and Nick Coghlan; see recipe 498245, recipe 577479, bpo-10586, and +bpo-10593.)

      +
    • +
    • The functools.wraps() decorator now adds a __wrapped__ attribute +pointing to the original callable function. This allows wrapped functions to +be introspected. It also copies __annotations__ if defined. And now +it also gracefully skips over missing attributes such as __doc__ which +might not be defined for the wrapped callable.

      +

      In the above example, the cache can be removed by recovering the original +function:

      +
      >>> get_phone_number = get_phone_number.__wrapped__    # uncached function
      +
      +
      +

      (By Nick Coghlan and Terrence Cole; bpo-9567, bpo-3445, and +bpo-8814.)

      +
    • +
    • To help write classes with rich comparison methods, a new decorator +functools.total_ordering() will use existing equality and inequality +methods to fill in the remaining methods.

      +

      For example, supplying __eq__ and __lt__ will enable +total_ordering() to fill-in __le__, __gt__ and __ge__:

      +
      @total_ordering
      +class Student:
      +    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()))
      +
      +
      +

      With the total_ordering decorator, the remaining comparison methods +are filled in automatically.

      +

      (Contributed by Raymond Hettinger.)

      +
    • +
    • To aid in porting programs from Python 2, the functools.cmp_to_key() +function converts an old-style comparison function to +modern key function:

      +
      >>> # locale-aware sort order
      +>>> sorted(iterable, key=cmp_to_key(locale.strcoll)) # doctest: +SKIP
      +
      +
      +

      For sorting examples and a brief sorting tutorial, see the Sorting HowTo tutorial.

      +

      (Contributed by Raymond Hettinger.)

      +
    • +
    +
    +
    +

    itertools

    +
      +
    • The itertools module has a new accumulate() function +modeled on APL’s scan operator and Numpy’s accumulate function:

      +
      >>> from itertools import accumulate
      +>>> list(accumulate([8, 2, 50]))
      +[8, 10, 60]
      +
      +
      +
      >>> prob_dist = [0.1, 0.4, 0.2, 0.3]
      +>>> list(accumulate(prob_dist))      # cumulative probability distribution
      +[0.1, 0.5, 0.7, 1.0]
      +
      +
      +

      For an example using accumulate(), see the examples for +the random module.

      +

      (Contributed by Raymond Hettinger and incorporating design suggestions +from Mark Dickinson.)

      +
    • +
    +
    +
    +

    collections

    +
      +
    • The collections.Counter class now has two forms of in-place +subtraction, the existing -= operator for saturating subtraction and the new +subtract() method for regular subtraction. The +former is suitable for multisets +which only have positive counts, and the latter is more suitable for use cases +that allow negative counts:

      +
      >>> from collections import Counter
      +>>> tally = Counter(dogs=5, cats=3)
      +>>> tally -= Counter(dogs=2, cats=8)    # saturating subtraction
      +>>> tally
      +Counter({'dogs': 3})
      +
      +
      +
      >>> tally = Counter(dogs=5, cats=3)
      +>>> tally.subtract(dogs=2, cats=8)      # regular subtraction
      +>>> tally
      +Counter({'dogs': 3, 'cats': -5})
      +
      +
      +

      (Contributed by Raymond Hettinger.)

      +
    • +
    • The collections.OrderedDict class has a new method +move_to_end() which takes an existing key and +moves it to either the first or last position in the ordered sequence.

      +

      The default is to move an item to the last position. This is equivalent of +renewing an entry with od[k] = od.pop(k).

      +

      A fast move-to-end operation is useful for resequencing entries. For example, +an ordered dictionary can be used to track order of access by aging entries +from the oldest to the most recently accessed.

      +
      >>> from collections import OrderedDict
      +>>> d = OrderedDict.fromkeys(['a', 'b', 'X', 'd', 'e'])
      +>>> list(d)
      +['a', 'b', 'X', 'd', 'e']
      +>>> d.move_to_end('X')
      +>>> list(d)
      +['a', 'b', 'd', 'e', 'X']
      +
      +
      +

      (Contributed by Raymond Hettinger.)

      +
    • +
    • The collections.deque class grew two new methods +count() and reverse() that +make them more substitutable for list objects:

      +
      >>> from collections import deque
      +>>> d = deque('simsalabim')
      +>>> d.count('s')
      +2
      +>>> d.reverse()
      +>>> d
      +deque(['m', 'i', 'b', 'a', 'l', 'a', 's', 'm', 'i', 's'])
      +
      +
      +

      (Contributed by Raymond Hettinger.)

      +
    • +
    +
    +
    +

    threading

    +

    The threading module has a new Barrier +synchronization class for making multiple threads wait until all of them have +reached a common barrier point. Barriers are useful for making sure that a task +with multiple preconditions does not run until all of the predecessor tasks are +complete.

    +

    Barriers can work with an arbitrary number of threads. This is a generalization +of a Rendezvous which +is defined for only two threads.

    +

    Implemented as a two-phase cyclic barrier, Barrier objects +are suitable for use in loops. The separate filling and draining phases +assure that all threads get released (drained) before any one of them can loop +back and re-enter the barrier. The barrier fully resets after each cycle.

    +

    Example of using barriers:

    +
    from threading import Barrier, Thread
    +
    +def get_votes(site):
    +    ballots = conduct_election(site)
    +    all_polls_closed.wait()        # do not count until all polls are closed
    +    totals = summarize(ballots)
    +    publish(site, totals)
    +
    +all_polls_closed = Barrier(len(sites))
    +for site in sites:
    +    Thread(target=get_votes, args=(site,)).start()
    +
    +
    +

    In this example, the barrier enforces a rule that votes cannot be counted at any +polling site until all polls are closed. Notice how a solution with a barrier +is similar to one with threading.Thread.join(), but the threads stay alive +and continue to do work (summarizing ballots) after the barrier point is +crossed.

    +

    If any of the predecessor tasks can hang or be delayed, a barrier can be created +with an optional timeout parameter. Then if the timeout period elapses before +all the predecessor tasks reach the barrier point, all waiting threads are +released and a BrokenBarrierError exception is raised:

    +
    def get_votes(site):
    +    ballots = conduct_election(site)
    +    try:
    +        all_polls_closed.wait(timeout=midnight - time.now())
    +    except BrokenBarrierError:
    +        lockbox = seal_ballots(ballots)
    +        queue.put(lockbox)
    +    else:
    +        totals = summarize(ballots)
    +        publish(site, totals)
    +
    +
    +

    In this example, the barrier enforces a more robust rule. If some election +sites do not finish before midnight, the barrier times-out and the ballots are +sealed and deposited in a queue for later handling.

    +

    See Barrier Synchronization Patterns +for more examples of how barriers can be used in parallel computing. Also, there is +a simple but thorough explanation of barriers in The Little Book of Semaphores, section 3.6.

    +

    (Contributed by Kristján Valur Jónsson with an API review by Jeffrey Yasskin in +bpo-8777.)

    +
    +
    +

    datetime and time

    +
      +
    • The datetime module has a new type timezone that +implements the tzinfo interface by returning a fixed UTC +offset and timezone name. This makes it easier to create timezone-aware +datetime objects:

      +
      >>> from datetime import datetime, timezone
      +
      +>>> datetime.now(timezone.utc)
      +datetime.datetime(2010, 12, 8, 21, 4, 2, 923754, tzinfo=datetime.timezone.utc)
      +
      +>>> datetime.strptime("01/01/2000 12:00 +0000", "%m/%d/%Y %H:%M %z")
      +datetime.datetime(2000, 1, 1, 12, 0, tzinfo=datetime.timezone.utc)
      +
      +
      +
    • +
    • Also, timedelta objects can now be multiplied by +float and divided by float and int objects. +And timedelta objects can now divide one another.

    • +
    • The datetime.date.strftime() method is no longer restricted to years +after 1900. The new supported year range is from 1000 to 9999 inclusive.

    • +
    • Whenever a two-digit year is used in a time tuple, the interpretation has been +governed by time.accept2dyear. The default is True which means that +for a two-digit year, the century is guessed according to the POSIX rules +governing the %y strptime format.

      +

      Starting with Py3.2, use of the century guessing heuristic will emit a +DeprecationWarning. Instead, it is recommended that +time.accept2dyear be set to False so that large date ranges +can be used without guesswork:

      +
      >>> import time, warnings
      +>>> warnings.resetwarnings()      # remove the default warning filters
      +
      +>>> time.accept2dyear = True      # guess whether 11 means 11 or 2011
      +>>> time.asctime((11, 1, 1, 12, 34, 56, 4, 1, 0))
      +Warning (from warnings module):
      +  ...
      +DeprecationWarning: Century info guessed for a 2-digit year.
      +'Fri Jan  1 12:34:56 2011'
      +
      +>>> time.accept2dyear = False     # use the full range of allowable dates
      +>>> time.asctime((11, 1, 1, 12, 34, 56, 4, 1, 0))
      +'Fri Jan  1 12:34:56 11'
      +
      +
      +

      Several functions now have significantly expanded date ranges. When +time.accept2dyear is false, the time.asctime() function will +accept any year that fits in a C int, while the time.mktime() and +time.strftime() functions will accept the full range supported by the +corresponding operating system functions.

      +
    • +
    +

    (Contributed by Alexander Belopolsky and Victor Stinner in bpo-1289118, +bpo-5094, bpo-6641, bpo-2706, bpo-1777412, bpo-8013, +and bpo-10827.)

    +
    +
    +

    math

    +

    The math module has been updated with six new functions inspired by the +C99 standard.

    +

    The isfinite() function provides a reliable and fast way to detect +special values. It returns True for regular numbers and False for Nan or +Infinity:

    +
    >>> from math import isfinite
    +>>> [isfinite(x) for x in (123, 4.56, float('Nan'), float('Inf'))]
    +[True, True, False, False]
    +
    +
    +

    The expm1() function computes e**x-1 for small values of x +without incurring the loss of precision that usually accompanies the subtraction +of nearly equal quantities:

    +
    >>> from math import expm1
    +>>> expm1(0.013671875)   # more accurate way to compute e**x-1 for a small x
    +0.013765762467652909
    +
    +
    +

    The erf() function computes a probability integral or Gaussian +error function. The +complementary error function, erfc(), is 1 - erf(x):

    +
    >>> from math import erf, erfc, sqrt
    +>>> erf(1.0/sqrt(2.0))   # portion of normal distribution within 1 standard deviation
    +0.682689492137086
    +>>> erfc(1.0/sqrt(2.0))  # portion of normal distribution outside 1 standard deviation
    +0.31731050786291404
    +>>> erf(1.0/sqrt(2.0)) + erfc(1.0/sqrt(2.0))
    +1.0
    +
    +
    +

    The gamma() function is a continuous extension of the factorial +function. See https://en.wikipedia.org/wiki/Gamma_function for details. Because +the function is related to factorials, it grows large even for small values of +x, so there is also a lgamma() function for computing the natural +logarithm of the gamma function:

    +
    >>> from math import gamma, lgamma
    +>>> gamma(7.0)           # six factorial
    +720.0
    +>>> lgamma(801.0)        # log(800 factorial)
    +4551.950730698041
    +
    +
    +

    (Contributed by Mark Dickinson.)

    +
    +
    +

    abc

    +

    The abc module now supports abstractclassmethod() and +abstractstaticmethod().

    +

    These tools make it possible to define an abstract base class that +requires a particular classmethod() or staticmethod() to be +implemented:

    +
    class Temperature(metaclass=abc.ABCMeta):
    +    @abc.abstractclassmethod
    +    def from_fahrenheit(cls, t):
    +        ...
    +    @abc.abstractclassmethod
    +    def from_celsius(cls, t):
    +        ...
    +
    +
    +

    (Patch submitted by Daniel Urban; bpo-5867.)

    +
    +
    +

    io

    +

    The io.BytesIO has a new method, getbuffer(), which +provides functionality similar to memoryview(). It creates an editable +view of the data without making a copy. The buffer’s random access and support +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
    +
    +>>> import io
    +
    +>>> byte_stream = io.BytesIO(
    +...     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   ')
    +>>> print(byte_stream.getvalue())
    +b'G3805  showroom   Main chassis    '
    +b'X7899  warehouse  Reserve cog     '
    +b'L6988  receiving  Primary sprocket'
    +
    +
    +

    (Contributed by Antoine Pitrou in bpo-5506.)

    +
    +
    +

    reprlib

    +

    When writing a __repr__() method for a custom container, it is easy to +forget to handle the case where a member refers back to the container itself. +Python’s builtin objects such as list and set handle +self-reference by displaying “…” in the recursive part of the representation +string.

    +

    To help write such __repr__() methods, the reprlib module has a new +decorator, recursive_repr(), for detecting recursive calls to +__repr__() and substituting a placeholder string instead:

    +
    >>> class MyList(list):
    +...     @recursive_repr()
    +...     def __repr__(self):
    +...         return '<' + '|'.join(map(repr, self)) + '>'
    +...
    +>>> m = MyList('abc')
    +>>> m.append(m)
    +>>> m.append('x')
    +>>> print(m)
    +<'a'|'b'|'c'|...|'x'>
    +
    +
    +

    (Contributed by Raymond Hettinger in bpo-9826 and bpo-9840.)

    +
    +
    +

    logging

    +

    In addition to dictionary-based configuration described above, the +logging package has many other improvements.

    +

    The logging documentation has been augmented by a basic tutorial, an advanced tutorial, and a cookbook of +logging recipes. These documents are the fastest way to learn about logging.

    +

    The logging.basicConfig() set-up function gained a style argument to +support three different types of string formatting. It defaults to “%” for +traditional %-formatting, can be set to “{” for the new str.format() style, or +can be set to “$” for the shell-style formatting provided by +string.Template. The following three configurations are equivalent:

    +
    >>> from logging import basicConfig
    +>>> basicConfig(style='%', format="%(name)s -> %(levelname)s: %(message)s")
    +>>> basicConfig(style='{', format="{name} -> {levelname} {message}")
    +>>> basicConfig(style='$', format="$name -> $levelname: $message")
    +
    +
    +

    If no configuration is set-up before a logging event occurs, there is now a +default configuration using a StreamHandler directed to +sys.stderr for events of WARNING level or higher. Formerly, an +event occurring before a configuration was set-up would either raise an +exception or silently drop the event depending on the value of +logging.raiseExceptions. The new default handler is stored in +logging.lastResort.

    +

    The use of filters has been simplified. Instead of creating a +Filter object, the predicate can be any Python callable that +returns True or False.

    +

    There were a number of other improvements that add flexibility and simplify +configuration. See the module documentation for a full listing of changes in +Python 3.2.

    +
    +
    +

    csv

    +

    The csv module now supports a new dialect, unix_dialect, +which applies quoting for all fields and a traditional Unix style with '\n' as +the line terminator. The registered dialect name is unix.

    +

    The csv.DictWriter has a new method, +writeheader() for writing-out an initial row to document +the field names:

    +
    >>> import csv, sys
    +>>> w = csv.DictWriter(sys.stdout, ['name', 'dept'], dialect='unix')
    +>>> w.writeheader()
    +"name","dept"
    +>>> w.writerows([
    +...     {'name': 'tom', 'dept': 'accounting'},
    +...     {'name': 'susan', 'dept': 'Salesl'}])
    +"tom","accounting"
    +"susan","sales"
    +
    +
    +

    (New dialect suggested by Jay Talbot in bpo-5975, and the new method +suggested by Ed Abraham in bpo-1537721.)

    +
    +
    +

    contextlib

    +

    There is a new and slightly mind-blowing tool +ContextDecorator that is helpful for creating a +context manager that does double duty as a function decorator.

    +

    As a convenience, this new functionality is used by +contextmanager() so that no extra effort is needed to support +both roles.

    +

    The basic idea is that both context managers and function decorators can be used +for pre-action and post-action wrappers. Context managers wrap a group of +statements using a with statement, and function decorators wrap a +group of statements enclosed in a function. So, occasionally there is a need to +write a pre-action or post-action wrapper that can be used in either role.

    +

    For example, it is sometimes useful to wrap functions or groups of statements +with a logger that can track the time of entry and time of exit. Rather than +writing both a function decorator and a context manager for the task, the +contextmanager() provides both capabilities in a single +definition:

    +
    from contextlib import contextmanager
    +import logging
    +
    +logging.basicConfig(level=logging.INFO)
    +
    +@contextmanager
    +def track_entry_and_exit(name):
    +    logging.info('Entering: %s', name)
    +    yield
    +    logging.info('Exiting: %s', name)
    +
    +
    +

    Formerly, this would have only been usable as a context manager:

    +
    with track_entry_and_exit('widget loader'):
    +    print('Some time consuming activity goes here')
    +    load_widget()
    +
    +
    +

    Now, it can be used as a decorator as well:

    +
    @track_entry_and_exit('widget loader')
    +def activity():
    +    print('Some time consuming activity goes here')
    +    load_widget()
    +
    +
    +

    Trying to fulfill two roles at once places some limitations on the technique. +Context managers normally have the flexibility to return an argument usable by +a with statement, but there is no parallel for function decorators.

    +

    In the above example, there is not a clean way for the track_entry_and_exit +context manager to return a logging instance for use in the body of enclosed +statements.

    +

    (Contributed by Michael Foord in bpo-9110.)

    +
    +
    +

    decimal and fractions

    +

    Mark Dickinson crafted an elegant and efficient scheme for assuring that +different numeric datatypes will have the same hash value whenever their actual +values are equal (bpo-8188):

    +
    assert hash(Fraction(3, 2)) == hash(1.5) == \
    +       hash(Decimal("1.5")) == hash(complex(1.5, 0))
    +
    +
    +

    Some of the hashing details are exposed through a new attribute, +sys.hash_info, which describes the bit width of the hash value, the +prime modulus, the hash values for infinity and nan, and the multiplier +used for the imaginary part of a number:

    +
    >>> sys.hash_info # doctest: +SKIP
    +sys.hash_info(width=64, modulus=2305843009213693951, inf=314159, nan=0, imag=1000003)
    +
    +
    +

    An early decision to limit the inter-operability of various numeric types has +been relaxed. It is still unsupported (and ill-advised) to have implicit +mixing in arithmetic expressions such as Decimal('1.1') + float('1.1') +because the latter loses information in the process of constructing the binary +float. However, since existing floating point value can be converted losslessly +to either a decimal or rational representation, it makes sense to add them to +the constructor and to support mixed-type comparisons.

    + +

    Similar changes were made to fractions.Fraction so that the +from_float() and from_decimal() +methods are no longer needed (bpo-8294):

    +
    >>> from decimal import Decimal
    +>>> from fractions import Fraction
    +>>> Decimal(1.1)
    +Decimal('1.100000000000000088817841970012523233890533447265625')
    +>>> Fraction(1.1)
    +Fraction(2476979795053773, 2251799813685248)
    +
    +
    +

    Another useful change for the decimal module is that the +Context.clamp attribute is now public. This is useful in creating +contexts that correspond to the decimal interchange formats specified in IEEE +754 (see bpo-8540).

    +

    (Contributed by Mark Dickinson and Raymond Hettinger.)

    +
    +
    +

    ftp

    +

    The ftplib.FTP class now supports the context management protocol to +unconditionally consume socket.error exceptions and to close the FTP +connection when done:

    +
    >>> from ftplib import FTP
    +>>> with FTP("ftp1.at.proftpd.org") as ftp:
    +        ftp.login()
    +        ftp.dir()
    +
    +'230 Anonymous login ok, restrictions apply.'
    +dr-xr-xr-x   9 ftp      ftp           154 May  6 10:43 .
    +dr-xr-xr-x   9 ftp      ftp           154 May  6 10:43 ..
    +dr-xr-xr-x   5 ftp      ftp          4096 May  6 10:43 CentOS
    +dr-xr-xr-x   3 ftp      ftp            18 Jul 10  2008 Fedora
    +
    +
    +

    Other file-like objects such as mmap.mmap and fileinput.input() +also grew auto-closing context managers:

    +
    with fileinput.input(files=('log1.txt', 'log2.txt')) as f:
    +    for line in f:
    +        process(line)
    +
    +
    +

    (Contributed by Tarek Ziadé and Giampaolo Rodolà in bpo-4972, and +by Georg Brandl in bpo-8046 and bpo-1286.)

    +

    The FTP_TLS class now accepts a context parameter, which is a +ssl.SSLContext object allowing bundling SSL configuration options, +certificates and private keys into a single (potentially long-lived) structure.

    +

    (Contributed by Giampaolo Rodolà; bpo-8806.)

    +
    +
    +

    popen

    +

    The os.popen() and subprocess.Popen() functions now support +with statements for auto-closing of the file descriptors.

    +

    (Contributed by Antoine Pitrou and Brian Curtin in bpo-7461 and +bpo-10554.)

    +
    +
    +

    select

    +

    The select module now exposes a new, constant attribute, +PIPE_BUF, which gives the minimum number of bytes which are +guaranteed not to block when select.select() says a pipe is ready +for writing.

    +
    >>> import select
    +>>> select.PIPE_BUF  # doctest: +SKIP
    +512
    +
    +
    +

    (Available on Unix systems. Patch by Sébastien Sablé in bpo-9862)

    +
    +
    +

    gzip and zipfile

    +

    gzip.GzipFile now implements the io.BufferedIOBase +abstract base class (except for truncate()). It also has a +peek() method and supports unseekable as well as +zero-padded file objects.

    +

    The gzip module also gains the compress() and +decompress() functions for easier in-memory compression and +decompression. Keep in mind that text needs to be encoded as bytes +before compressing and decompressing:

    +
    >>> import gzip
    +>>> s = 'Three shall be the number thou shalt count, '
    +>>> s += 'and the number of the counting shall be three'
    +>>> b = s.encode()                        # convert to utf-8
    +>>> len(b)
    +89
    +>>> c = gzip.compress(b)
    +>>> len(c)
    +77
    +>>> gzip.decompress(c).decode()[:42]      # decompress and convert to text
    +'Three shall be the number thou shalt count'
    +
    +
    +

    (Contributed by Anand B. Pillai in bpo-3488; and by Antoine Pitrou, Nir +Aides and Brian Curtin in bpo-9962, bpo-1675951, bpo-7471 and +bpo-2846.)

    +

    Also, the zipfile.ZipExtFile class was reworked internally to represent +files stored inside an archive. The new implementation is significantly faster +and can be wrapped in an io.BufferedReader object for more speedups. It +also solves an issue where interleaved calls to read and readline gave the +wrong results.

    +

    (Patch submitted by Nir Aides in bpo-7610.)

    +
    +
    +

    tarfile

    +

    The TarFile class can now be used as a context manager. In +addition, its add() method has a new option, filter, +that controls which files are added to the archive and allows the file metadata +to be edited.

    +

    The new filter option replaces the older, less flexible exclude parameter +which is now deprecated. If specified, the optional filter parameter needs to +be a keyword argument. The user-supplied filter function accepts a +TarInfo object and returns an updated +TarInfo object, or if it wants the file to be excluded, the +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
    +
    +>>> 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()
    +-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
    +-rw-r--r-- monty/501        124 2011-01-26 17:59:11 py_todo.txt
    +-rw-r--r-- monty/501       1399 2011-01-26 17:59:11 semaphore_notes.txt
    +
    +
    +

    (Proposed by Tarek Ziadé and implemented by Lars Gustäbel in bpo-6856.)

    +
    +
    +

    hashlib

    +

    The hashlib module has two new constant attributes listing the hashing +algorithms guaranteed to be present in all implementations and those available +on the current implementation:

    +
    >>> import hashlib
    +
    +>>> hashlib.algorithms_guaranteed
    +{'sha1', 'sha224', 'sha384', 'sha256', 'sha512', 'md5'}
    +
    +>>> hashlib.algorithms_available
    +{'md2', 'SHA256', 'SHA512', 'dsaWithSHA', 'mdc2', 'SHA224', 'MD4', 'sha256',
    +'sha512', 'ripemd160', 'SHA1', 'MDC2', 'SHA', 'SHA384', 'MD2',
    +'ecdsa-with-SHA1','md4', 'md5', 'sha1', 'DSA-SHA', 'sha224',
    +'dsaEncryption', 'DSA', 'RIPEMD160', 'sha', 'MD5', 'sha384'}
    +
    +
    +

    (Suggested by Carl Chenet in bpo-7418.)

    +
    +
    +

    ast

    +

    The ast module has a wonderful a general-purpose tool for safely +evaluating expression strings using the Python literal +syntax. The ast.literal_eval() function serves as a secure alternative to +the builtin eval() function which is easily abused. Python 3.2 adds +bytes and set literals to the list of supported types: +strings, bytes, numbers, tuples, lists, dicts, sets, booleans, and None.

    +
    >>> from ast import literal_eval
    +
    +>>> request = "{'req': 3, 'func': 'pow', 'args': (2, 0.5)}"
    +>>> literal_eval(request)
    +{'args': (2, 0.5), 'req': 3, 'func': 'pow'}
    +
    +>>> request = "os.system('do something harmful')"
    +>>> literal_eval(request)
    +Traceback (most recent call last):
    +  ...
    +ValueError: malformed node or string: <_ast.Call object at 0x101739a10>
    +
    +
    +

    (Implemented by Benjamin Peterson and Georg Brandl.)

    +
    +
    +

    os

    +

    Different operating systems use various encodings for filenames and environment +variables. The os module provides two new functions, +fsencode() and fsdecode(), for encoding and decoding +filenames:

    +
    >>> import os
    +>>> filename = 'Sehenswürdigkeiten'
    +>>> os.fsencode(filename)
    +b'Sehensw\xc3\xbcrdigkeiten'
    +
    +
    +

    Some operating systems allow direct access to encoded bytes in the +environment. If so, the os.supports_bytes_environ constant will be +true.

    +

    For direct access to encoded environment variables (if available), +use the new os.getenvb() function or use os.environb +which is a bytes version of os.environ.

    +

    (Contributed by Victor Stinner.)

    +
    +
    +

    shutil

    +

    The shutil.copytree() function has two new options:

    +
      +
    • ignore_dangling_symlinks: when symlinks=False so that the function +copies a file pointed to by a symlink, not the symlink itself. This option +will silence the error raised if the file doesn’t exist.

    • +
    • copy_function: is a callable that will be used to copy files. +shutil.copy2() is used by default.

    • +
    +

    (Contributed by Tarek Ziadé.)

    +

    In addition, the shutil module now supports archiving operations for zipfiles, uncompressed tarfiles, gzipped tarfiles, +and bzipped tarfiles. And there are functions for registering additional +archiving file formats (such as xz compressed tarfiles or custom formats).

    +

    The principal functions are make_archive() and +unpack_archive(). By default, both operate on the current +directory (which can be set by os.chdir()) and on any sub-directories. +The archive filename needs to be specified with a full pathname. The archiving +step is non-destructive (the original files are left unchanged).

    +
    >>> import shutil, pprint
    +
    +>>> 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
    +'/var/backup/mydata.zip'
    +>>> 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
    +[('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'
    +... )
    +
    +
    +

    (Contributed by Tarek Ziadé.)

    +
    +
    +

    sqlite3

    +

    The sqlite3 module was updated to pysqlite version 2.6.0. It has two new capabilities.

    + +

    (Contributed by R. David Murray and Shashwat Anand; bpo-8845.)

    +
    +
    +

    html

    +

    A new html module was introduced with only a single function, +escape(), which is used for escaping reserved characters from HTML +markup:

    +
    >>> import html
    +>>> html.escape('x > 2 && x < 7')
    +'x &gt; 2 &amp;&amp; x &lt; 7'
    +
    +
    +
    +
    +

    socket

    +

    The socket module has two new improvements.

    +
      +
    • Socket objects now have a detach() method which puts +the socket into closed state without actually closing the underlying file +descriptor. The latter can then be reused for other purposes. +(Added by Antoine Pitrou; bpo-8524.)

    • +
    • socket.create_connection() now supports the context management protocol +to unconditionally consume socket.error exceptions and to close the +socket when done. +(Contributed by Giampaolo Rodolà; bpo-9794.)

    • +
    +
    +
    +

    ssl

    +

    The ssl module added a number of features to satisfy common requirements +for secure (encrypted, authenticated) internet connections:

    +
      +
    • A new class, SSLContext, serves as a container for persistent +SSL data, such as protocol settings, certificates, private keys, and various +other options. It includes a wrap_socket() for creating +an SSL socket from an SSL context.

    • +
    • A new function, ssl.match_hostname(), supports server identity +verification for higher-level protocols by implementing the rules of HTTPS +(from RFC 2818) which are also suitable for other protocols.

    • +
    • The ssl.wrap_socket() constructor function now takes a ciphers +argument. The ciphers string lists the allowed encryption algorithms using +the format described in the OpenSSL documentation.

    • +
    • When linked against recent versions of OpenSSL, the ssl module now +supports the Server Name Indication extension to the TLS protocol, allowing +multiple “virtual hosts” using different certificates on a single IP port. +This extension is only supported in client mode, and is activated by passing +the server_hostname argument to ssl.SSLContext.wrap_socket().

    • +
    • Various options have been added to the ssl module, such as +OP_NO_SSLv2 which disables the insecure and obsolete SSLv2 +protocol.

    • +
    • The extension now loads all the OpenSSL ciphers and digest algorithms. If +some SSL certificates cannot be verified, they are reported as an “unknown +algorithm” error.

    • +
    • The version of OpenSSL being used is now accessible using the module +attributes ssl.OPENSSL_VERSION (a string), +ssl.OPENSSL_VERSION_INFO (a 5-tuple), and +ssl.OPENSSL_VERSION_NUMBER (an integer).

    • +
    +

    (Contributed by Antoine Pitrou in bpo-8850, bpo-1589, bpo-8322, +bpo-5639, bpo-4870, bpo-8484, and bpo-8321.)

    +
    +
    +

    nntp

    +

    The nntplib module has a revamped implementation with better bytes and +text semantics as well as more practical APIs. These improvements break +compatibility with the nntplib version in Python 3.1, which was partly +dysfunctional in itself.

    +

    Support for secure connections through both implicit (using +nntplib.NNTP_SSL) and explicit (using nntplib.NNTP.starttls()) +TLS has also been added.

    +

    (Contributed by Antoine Pitrou in bpo-9360 and Andrew Vant in bpo-1926.)

    +
    +
    +

    certificates

    +

    http.client.HTTPSConnection, urllib.request.HTTPSHandler +and urllib.request.urlopen() now take optional arguments to allow for +server certificate checking against a set of Certificate Authorities, +as recommended in public uses of HTTPS.

    +

    (Added by Antoine Pitrou, bpo-9003.)

    +
    +
    +

    imaplib

    +

    Support for explicit TLS on standard IMAP4 connections has been added through +the new imaplib.IMAP4.starttls method.

    +

    (Contributed by Lorenzo M. Catucci and Antoine Pitrou, bpo-4471.)

    +
    +
    +

    http.client

    +

    There were a number of small API improvements in the http.client module. +The old-style HTTP 0.9 simple responses are no longer supported and the strict +parameter is deprecated in all classes.

    +

    The HTTPConnection and +HTTPSConnection classes now have a source_address +parameter for a (host, port) tuple indicating where the HTTP connection is made +from.

    +

    Support for certificate checking and HTTPS virtual hosts were added to +HTTPSConnection.

    +

    The request() method on connection objects +allowed an optional body argument so that a file object could be used +to supply the content of the request. Conveniently, the body argument now +also accepts an iterable object so long as it includes an explicit +Content-Length header. This extended interface is much more flexible than +before.

    +

    To establish an HTTPS connection through a proxy server, there is a new +set_tunnel() method that sets the host and +port for HTTP Connect tunneling.

    +

    To match the behavior of http.server, the HTTP client library now also +encodes headers with ISO-8859-1 (Latin-1) encoding. It was already doing that +for incoming headers, so now the behavior is consistent for both incoming and +outgoing traffic. (See work by Armin Ronacher in bpo-10980.)

    +
    +
    +

    unittest

    +

    The unittest module has a number of improvements supporting test discovery for +packages, easier experimentation at the interactive prompt, new testcase +methods, improved diagnostic messages for test failures, and better method +names.

    +
      +
    • The command-line call python -m unittest can now accept file paths +instead of module names for running specific tests (bpo-10620). The new +test discovery can find tests within packages, locating any test importable +from the top-level directory. The top-level directory can be specified with +the -t option, a pattern for matching files with -p, and a directory to +start discovery with -s:

      +
      $ python -m unittest discover -s my_proj_dir -p _test.py
      +
      +
      +

      (Contributed by Michael Foord.)

      +
    • +
    • Experimentation at the interactive prompt is now easier because the +unittest.case.TestCase class can now be instantiated without +arguments:

      +
      >>> from unittest import TestCase
      +>>> TestCase().assertEqual(pow(2, 3), 8)
      +
      +
      +

      (Contributed by Michael Foord.)

      +
    • +
    • The unittest module has two new methods, +assertWarns() and +assertWarnsRegex() to verify that a given warning type +is triggered by the code under test:

      +
      with self.assertWarns(DeprecationWarning):
      +    legacy_function('XYZ')
      +
      +
      +

      (Contributed by Antoine Pitrou, bpo-9754.)

      +

      Another new method, assertCountEqual() is used to +compare two iterables to determine if their element counts are equal (whether +the same elements are present with the same number of occurrences regardless +of order):

      +
      def test_anagram(self):
      +    self.assertCountEqual('algorithm', 'logarithm')
      +
      +
      +

      (Contributed by Raymond Hettinger.)

      +
    • +
    • A principal feature of the unittest module is an effort to produce meaningful +diagnostics when a test fails. When possible, the failure is recorded along +with a diff of the output. This is especially helpful for analyzing log files +of failed test runs. However, since diffs can sometime be voluminous, there is +a new maxDiff attribute that sets maximum length of +diffs displayed.

    • +
    • In addition, the method names in the module have undergone a number of clean-ups.

      +

      For example, assertRegex() is the new name for +assertRegexpMatches() which was misnamed because the +test uses re.search(), not re.match(). Other methods using +regular expressions are now named using short form “Regex” in preference to +“Regexp” – this matches the names used in other unittest implementations, +matches Python’s old name for the re module, and it has unambiguous +camel-casing.

      +

      (Contributed by Raymond Hettinger and implemented by Ezio Melotti.)

      +
    • +
    • To improve consistency, some long-standing method aliases are being +deprecated in favor of the preferred names:

      +
      +
      ++++ + + + + + + + + + + + + + + + + + + + + + + +

      Old Name

      Preferred Name

      assert_()

      assertTrue()

      assertEquals()

      assertEqual()

      assertNotEquals()

      assertNotEqual()

      assertAlmostEquals()

      assertAlmostEqual()

      assertNotAlmostEquals()

      assertNotAlmostEqual()

      +
      +

      Likewise, the TestCase.fail* methods deprecated in Python 3.1 are expected +to be removed in Python 3.3. Also see the Deprecated aliases section in +the unittest documentation.

      +

      (Contributed by Ezio Melotti; bpo-9424.)

      +
    • +
    • The assertDictContainsSubset() method was deprecated +because it was misimplemented with the arguments in the wrong order. This +created hard-to-debug optical illusions where tests like +TestCase().assertDictContainsSubset({'a':1, 'b':2}, {'a':1}) would fail.

      +

      (Contributed by Raymond Hettinger.)

      +
    • +
    +
    +
    +

    random

    +

    The integer methods in the random module now do a better job of producing +uniform distributions. Previously, they computed selections with +int(n*random()) which had a slight bias whenever n was not a power of two. +Now, multiple selections are made from a range up to the next power of two and a +selection is kept only when it falls within the range 0 <= x < n. The +functions and methods affected are randrange(), +randint(), choice(), shuffle() and +sample().

    +

    (Contributed by Raymond Hettinger; bpo-9025.)

    +
    +
    +

    poplib

    +

    POP3_SSL class now accepts a context parameter, which is a +ssl.SSLContext object allowing bundling SSL configuration options, +certificates and private keys into a single (potentially long-lived) +structure.

    +

    (Contributed by Giampaolo Rodolà; bpo-8807.)

    +
    +
    +

    asyncore

    +

    asyncore.dispatcher now provides a +handle_accepted() method +returning a (sock, addr) pair which is called when a connection has actually +been established with a new remote endpoint. This is supposed to be used as a +replacement for old handle_accept() and avoids +the user to call accept() directly.

    +

    (Contributed by Giampaolo Rodolà; bpo-6706.)

    +
    +
    +

    tempfile

    +

    The tempfile module has a new context manager, +TemporaryDirectory which provides easy deterministic +cleanup of temporary directories:

    +
    with tempfile.TemporaryDirectory() as tmpdirname:
    +    print('created temporary dir:', tmpdirname)
    +
    +
    +

    (Contributed by Neil Schemenauer and Nick Coghlan; bpo-5178.)

    +
    +
    +

    inspect

    +
      +
    • The inspect module has a new function +getgeneratorstate() to easily identify the current state of a +generator-iterator:

      +
      >>> from inspect import getgeneratorstate
      +>>> def gen():
      +...     yield 'demo'
      +>>> g = gen()
      +>>> getgeneratorstate(g)
      +'GEN_CREATED'
      +>>> next(g)
      +'demo'
      +>>> getgeneratorstate(g)
      +'GEN_SUSPENDED'
      +>>> next(g, None)
      +>>> getgeneratorstate(g)
      +'GEN_CLOSED'
      +
      +
      +

      (Contributed by Rodolpho Eckhardt and Nick Coghlan, bpo-10220.)

      +
    • +
    • To support lookups without the possibility of activating a dynamic attribute, +the inspect module has a new function, getattr_static(). +Unlike hasattr(), this is a true read-only search, guaranteed not to +change state while it is searching:

      +
      >>> class A:
      +...     @property
      +...     def f(self):
      +...         print('Running')
      +...         return 10
      +...
      +>>> a = A()
      +>>> getattr(a, 'f')
      +Running
      +10
      +>>> inspect.getattr_static(a, 'f')
      +<property object at 0x1022bd788>
      +
      +
      +
    • +
    +
    +

    (Contributed by Michael Foord.)

    +
    +
    +
    +

    pydoc

    +

    The pydoc module now provides a much-improved Web server interface, as +well as a new command-line option -b to automatically open a browser window +to display that server:

    +
    $ pydoc3.2 -b
    +
    +
    +

    (Contributed by Ron Adam; bpo-2001.)

    +
    +
    +

    dis

    +

    The dis module gained two new functions for inspecting code, +code_info() and show_code(). Both provide detailed code +object information for the supplied function, method, source code string or code +object. The former returns a string and the latter prints it:

    +
    >>> import dis, random
    +>>> dis.show_code(random.choice)
    +Name:              choice
    +Filename:          /Library/Frameworks/Python.framework/Versions/3.2/lib/python3.2/random.py
    +Argument count:    2
    +Kw-only arguments: 0
    +Number of locals:  3
    +Stack size:        11
    +Flags:             OPTIMIZED, NEWLOCALS, NOFREE
    +Constants:
    +   0: 'Choose a random element from a non-empty sequence.'
    +   1: 'Cannot choose from an empty sequence'
    +Names:
    +   0: _randbelow
    +   1: len
    +   2: ValueError
    +   3: IndexError
    +Variable names:
    +   0: self
    +   1: seq
    +   2: i
    +
    +
    +

    In addition, the dis() function now accepts string arguments +so that the common idiom dis(compile(s, '', 'eval')) can be shortened +to dis(s):

    +
    >>> dis('3*x+1 if x%2==1 else x//2')
    +  1           0 LOAD_NAME                0 (x)
    +              3 LOAD_CONST               0 (2)
    +              6 BINARY_MODULO
    +              7 LOAD_CONST               1 (1)
    +             10 COMPARE_OP               2 (==)
    +             13 POP_JUMP_IF_FALSE       28
    +             16 LOAD_CONST               2 (3)
    +             19 LOAD_NAME                0 (x)
    +             22 BINARY_MULTIPLY
    +             23 LOAD_CONST               1 (1)
    +             26 BINARY_ADD
    +             27 RETURN_VALUE
    +        >>   28 LOAD_NAME                0 (x)
    +             31 LOAD_CONST               0 (2)
    +             34 BINARY_FLOOR_DIVIDE
    +             35 RETURN_VALUE
    +
    +
    +

    Taken together, these improvements make it easier to explore how CPython is +implemented and to see for yourself what the language syntax does +under-the-hood.

    +

    (Contributed by Nick Coghlan in bpo-9147.)

    +
    +
    +

    dbm

    +

    All database modules now support the get() and setdefault() methods.

    +

    (Suggested by Ray Allen in bpo-9523.)

    +
    +
    +

    ctypes

    +

    A new type, ctypes.c_ssize_t represents the C ssize_t datatype.

    +
    +
    +

    site

    +

    The site module has three new functions useful for reporting on the +details of a given Python installation.

    + +
    >>> import site
    +>>> site.getsitepackages()
    +['/Library/Frameworks/Python.framework/Versions/3.2/lib/python3.2/site-packages',
    + '/Library/Frameworks/Python.framework/Versions/3.2/lib/site-python',
    + '/Library/Python/3.2/site-packages']
    +>>> site.getuserbase()
    +'/Users/raymondhettinger/Library/Python/3.2'
    +>>> site.getusersitepackages()
    +'/Users/raymondhettinger/Library/Python/3.2/lib/python/site-packages'
    +
    +
    +

    Conveniently, some of site’s functionality is accessible directly from the +command-line:

    +
    $ python -m site --user-base
    +/Users/raymondhettinger/.local
    +$ python -m site --user-site
    +/Users/raymondhettinger/.local/lib/python3.2/site-packages
    +
    +
    +

    (Contributed by Tarek Ziadé in bpo-6693.)

    +
    +
    +

    sysconfig

    +

    The new sysconfig module makes it straightforward to discover +installation paths and configuration variables that vary across platforms and +installations.

    +

    The module offers access simple access functions for platform and version +information:

    + +

    It also provides access to the paths and variables corresponding to one of +seven named schemes used by distutils. Those include posix_prefix, +posix_home, posix_user, nt, nt_user, os2, os2_home:

    +
      +
    • get_paths() makes a dictionary containing installation paths +for the current installation scheme.

    • +
    • get_config_vars() returns a dictionary of platform specific +variables.

    • +
    +

    There is also a convenient command-line interface:

    +
    C:\Python32>python -m sysconfig
    +Platform: "win32"
    +Python version: "3.2"
    +Current installation scheme: "nt"
    +
    +Paths:
    +        data = "C:\Python32"
    +        include = "C:\Python32\Include"
    +        platinclude = "C:\Python32\Include"
    +        platlib = "C:\Python32\Lib\site-packages"
    +        platstdlib = "C:\Python32\Lib"
    +        purelib = "C:\Python32\Lib\site-packages"
    +        scripts = "C:\Python32\Scripts"
    +        stdlib = "C:\Python32\Lib"
    +
    +Variables:
    +        BINDIR = "C:\Python32"
    +        BINLIBDEST = "C:\Python32\Lib"
    +        EXE = ".exe"
    +        INCLUDEPY = "C:\Python32\Include"
    +        LIBDEST = "C:\Python32\Lib"
    +        SO = ".pyd"
    +        VERSION = "32"
    +        abiflags = ""
    +        base = "C:\Python32"
    +        exec_prefix = "C:\Python32"
    +        platbase = "C:\Python32"
    +        prefix = "C:\Python32"
    +        projectbase = "C:\Python32"
    +        py_version = "3.2"
    +        py_version_nodot = "32"
    +        py_version_short = "3.2"
    +        srcdir = "C:\Python32"
    +        userbase = "C:\Documents and Settings\Raymond\Application Data\Python"
    +
    +
    +

    (Moved out of Distutils by Tarek Ziadé.)

    +
    +
    +

    pdb

    +

    The pdb debugger module gained a number of usability improvements:

    +
      +
    • pdb.py now has a -c option that executes commands as given in a +.pdbrc script file.

    • +
    • A .pdbrc script file can contain continue and next commands +that continue debugging.

    • +
    • The Pdb class constructor now accepts a nosigint argument.

    • +
    • New commands: l(list), ll(long list) and source for +listing source code.

    • +
    • New commands: display and undisplay for showing or hiding +the value of an expression if it has changed.

    • +
    • New command: interact for starting an interactive interpreter containing +the global and local names found in the current scope.

    • +
    • Breakpoints can be cleared by breakpoint number.

    • +
    +

    (Contributed by Georg Brandl, Antonio Cuni and Ilya Sandler.)

    +
    +
    +

    configparser

    +

    The configparser module was modified to improve usability and +predictability of the default parser and its supported INI syntax. The old +ConfigParser class was removed in favor of SafeConfigParser +which has in turn been renamed to ConfigParser. Support +for inline comments is now turned off by default and section or option +duplicates are not allowed in a single configuration source.

    +

    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
    +... """)
    +>>> parser['main']['color']
    +'green'
    +>>> parser['main']['editable']
    +'no'
    +>>> section = parser['options']
    +>>> section['title']
    +'Options'
    +>>> section['title'] = 'Options (editable: %(editable)s)'
    +>>> section['title']
    +'Options (editable: no)'
    +
    +
    +

    The new API is implemented on top of the classical API, so custom parser +subclasses should be able to use it without modifications.

    +

    The INI file structure accepted by config parsers can now be customized. Users +can specify alternative option/value delimiters and comment prefixes, change the +name of the DEFAULT section or switch the interpolation syntax.

    +

    There is support for pluggable interpolation including an additional interpolation +handler ExtendedInterpolation:

    +
    >>> parser = ConfigParser(interpolation=ExtendedInterpolation())
    +>>> parser.read_dict({'buildout': {'directory': '/home/ambv/zope9'},
    +...                   '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
    +... """)
    +>>> parser['buildout']['find-links']
    +'\n/home/ambv/zope9/downloads/dist'
    +>>> parser['instance']['zope-conf']
    +'/usr/local/etc/zope.conf'
    +>>> instance = parser['instance']
    +>>> instance['zope-conf']
    +'/usr/local/etc/zope.conf'
    +>>> instance['zope9-location']
    +'/opt/zope'
    +
    +
    +

    A number of smaller features were also introduced, like support for specifying +encoding in read operations, specifying fallback values for get-functions, or +reading directly from dictionaries and strings.

    +

    (All changes contributed by Łukasz Langa.)

    +
    +
    +

    urllib.parse

    +

    A number of usability improvements were made for the urllib.parse module.

    +

    The urlparse() function now supports IPv6 addresses as described in RFC 2732:

    +
    >>> import urllib.parse
    +>>> urllib.parse.urlparse('http://[dead:beef:cafe:5417:affe:8FA3:deaf:feed]/foo/') # doctest: +NORMALIZE_WHITESPACE
    +ParseResult(scheme='http',
    +            netloc='[dead:beef:cafe:5417:affe:8FA3:deaf:feed]',
    +            path='/foo/',
    +            params='',
    +            query='',
    +            fragment='')
    +
    +
    +

    The urldefrag() function now returns a named tuple:

    +
    >>> r = urllib.parse.urldefrag('http://python.org/about/#target')
    +>>> r
    +DefragResult(url='http://python.org/about/', fragment='target')
    +>>> r[0]
    +'http://python.org/about/'
    +>>> r.fragment
    +'target'
    +
    +
    +

    And, the urlencode() function is now much more flexible, +accepting either a string or bytes type for the query argument. If it is a +string, then the safe, encoding, and error parameters are sent to +quote_plus() for encoding:

    +
    >>> urllib.parse.urlencode([
    +...      ('type', 'telenovela'),
    +...      ('name', '¿Dónde Está Elisa?')],
    +...      encoding='latin-1')
    +'type=telenovela&name=%BFD%F3nde+Est%E1+Elisa%3F'
    +
    +
    +

    As detailed in Parsing ASCII Encoded Bytes, all the urllib.parse +functions now accept ASCII-encoded byte strings as input, so long as they are +not mixed with regular strings. If ASCII-encoded byte strings are given as +parameters, the return types will also be an ASCII-encoded byte strings:

    +
    >>> urllib.parse.urlparse(b'http://www.python.org:80/about/') # doctest: +NORMALIZE_WHITESPACE
    +ParseResultBytes(scheme=b'http', netloc=b'www.python.org:80',
    +                 path=b'/about/', params=b'', query=b'', fragment=b'')
    +
    +
    +

    (Work by Nick Coghlan, Dan Mahn, and Senthil Kumaran in bpo-2987, +bpo-5468, and bpo-9873.)

    +
    +
    +

    mailbox

    +

    Thanks to a concerted effort by R. David Murray, the mailbox module has +been fixed for Python 3.2. The challenge was that mailbox had been originally +designed with a text interface, but email messages are best represented with +bytes because various parts of a message may have different encodings.

    +

    The solution harnessed the email package’s binary support for parsing +arbitrary email messages. In addition, the solution required a number of API +changes.

    +

    As expected, the add() method for +mailbox.Mailbox objects now accepts binary input.

    +

    StringIO and text file input are deprecated. Also, string input +will fail early if non-ASCII characters are used. Previously it would fail when +the email was processed in a later step.

    +

    There is also support for binary output. The get_file() +method now returns a file in the binary mode (where it used to incorrectly set +the file to text-mode). There is also a new get_bytes() +method that returns a bytes representation of a message corresponding +to a given key.

    +

    It is still possible to get non-binary output using the old API’s +get_string() method, but that approach +is not very useful. Instead, it is best to extract messages from +a Message object or to load them from binary input.

    +

    (Contributed by R. David Murray, with efforts from Steffen Daode Nurpmeso and an +initial patch by Victor Stinner in bpo-9124.)

    +
    +
    +

    turtledemo

    +

    The demonstration code for the turtle module was moved from the Demo +directory to main library. It includes over a dozen sample scripts with +lively displays. Being on sys.path, it can now be run directly +from the command-line:

    +
    $ python -m turtledemo
    +
    +
    +

    (Moved from the Demo directory by Alexander Belopolsky in bpo-10199.)

    +
    +
    +
    +

    Multi-threading

    +
      +
    • The mechanism for serializing execution of concurrently running Python threads +(generally known as the GIL or Global Interpreter Lock) has +been rewritten. Among the objectives were more predictable switching +intervals and reduced overhead due to lock contention and the number of +ensuing system calls. The notion of a “check interval” to allow thread +switches has been abandoned and replaced by an absolute duration expressed in +seconds. This parameter is tunable through sys.setswitchinterval(). +It currently defaults to 5 milliseconds.

      +

      Additional details about the implementation can be read from a python-dev +mailing-list message +(however, “priority requests” as exposed in this message have not been kept +for inclusion).

      +

      (Contributed by Antoine Pitrou.)

      +
    • +
    • Regular and recursive locks now accept an optional timeout argument to their +acquire() method. (Contributed by Antoine Pitrou; +bpo-7316.)

    • +
    • Similarly, threading.Semaphore.acquire() also gained a timeout +argument. (Contributed by Torsten Landschoff; bpo-850728.)

    • +
    • Regular and recursive lock acquisitions can now be interrupted by signals on +platforms using Pthreads. This means that Python programs that deadlock while +acquiring locks can be successfully killed by repeatedly sending SIGINT to the +process (by pressing Ctrl+C in most shells). +(Contributed by Reid Kleckner; bpo-8844.)

    • +
    +
    +
    +

    Optimizations

    +

    A number of small performance enhancements have been added:

    +
      +
    • Python’s peephole optimizer now recognizes patterns such x in {1, 2, 3} as +being a test for membership in a set of constants. The optimizer recasts the +set as a frozenset and stores the pre-built constant.

      +

      Now that the speed penalty is gone, it is practical to start writing +membership tests using set-notation. This style is both semantically clear +and operationally fast:

      +
      extension = name.rpartition('.')[2]
      +if extension in {'xml', 'html', 'xhtml', 'css'}:
      +    handle(name)
      +
      +
      +

      (Patch and additional tests contributed by Dave Malcolm; bpo-6690).

      +
    • +
    • Serializing and unserializing data using the pickle module is now +several times faster.

      +

      (Contributed by Alexandre Vassalotti, Antoine Pitrou +and the Unladen Swallow team in bpo-9410 and bpo-3873.)

      +
    • +
    • The Timsort algorithm used in +list.sort() and sorted() now runs faster and uses less memory +when called with a key function. Previously, every element of +a list was wrapped with a temporary object that remembered the key value +associated with each element. Now, two arrays of keys and values are +sorted in parallel. This saves the memory consumed by the sort wrappers, +and it saves time lost to delegating comparisons.

      +

      (Patch by Daniel Stutzbach in bpo-9915.)

      +
    • +
    • JSON decoding performance is improved and memory consumption is reduced +whenever the same string is repeated for multiple keys. Also, JSON encoding +now uses the C speedups when the sort_keys argument is true.

      +

      (Contributed by Antoine Pitrou in bpo-7451 and by Raymond Hettinger and +Antoine Pitrou in bpo-10314.)

      +
    • +
    • Recursive locks (created with the threading.RLock() API) now benefit +from a C implementation which makes them as fast as regular locks, and between +10x and 15x faster than their previous pure Python implementation.

      +

      (Contributed by Antoine Pitrou; bpo-3001.)

      +
    • +
    • The fast-search algorithm in stringlib is now used by the split(), +rsplit(), splitlines() and replace() methods on +bytes, bytearray and str objects. Likewise, the +algorithm is also used by rfind(), rindex(), rsplit() and +rpartition().

      +

      (Patch by Florent Xicluna in bpo-7622 and bpo-7462.)

      +
    • +
    • Integer to string conversions now work two “digits” at a time, reducing the +number of division and modulo operations.

      +

      (bpo-6713 by Gawain Bolton, Mark Dickinson, and Victor Stinner.)

      +
    • +
    +

    There were several other minor optimizations. Set differencing now runs faster +when one operand is much larger than the other (patch by Andress Bennetts in +bpo-8685). The array.repeat() method has a faster implementation +(bpo-1569291 by Alexander Belopolsky). The BaseHTTPRequestHandler +has more efficient buffering (bpo-3709 by Andrew Schaaf). The +operator.attrgetter() function has been sped-up (bpo-10160 by +Christos Georgiou). And ConfigParser loads multi-line arguments a bit +faster (bpo-7113 by Łukasz Langa).

    +
    +
    +

    Unicode

    +

    Python has been updated to Unicode 6.0.0. The update to the standard adds +over 2,000 new characters including emoji +symbols which are important for mobile phones.

    +

    In addition, the updated standard has altered the character properties for two +Kannada characters (U+0CF1, U+0CF2) and one New Tai Lue numeric character +(U+19DA), making the former eligible for use in identifiers while disqualifying +the latter. For more information, see Unicode Character Database Changes.

    +
    +
    +

    Codecs

    +

    Support was added for cp720 Arabic DOS encoding (bpo-1616979).

    +

    MBCS encoding no longer ignores the error handler argument. In the default +strict mode, it raises an UnicodeDecodeError when it encounters an +undecodable byte sequence and an UnicodeEncodeError for an unencodable +character.

    +

    The MBCS codec supports 'strict' and 'ignore' error handlers for +decoding, and 'strict' and 'replace' for encoding.

    +

    To emulate Python3.1 MBCS encoding, select the 'ignore' handler for decoding +and the 'replace' handler for encoding.

    +

    On Mac OS X, Python decodes command line arguments with 'utf-8' rather than +the locale encoding.

    +

    By default, tarfile uses 'utf-8' encoding on Windows (instead of +'mbcs') and the 'surrogateescape' error handler on all operating +systems.

    +
    +
    +

    Documentation

    +

    The documentation continues to be improved.

    +
      +
    • A table of quick links has been added to the top of lengthy sections such as +Built-in Functions. In the case of itertools, the links are +accompanied by tables of cheatsheet-style summaries to provide an overview and +memory jog without having to read all of the docs.

    • +
    • In some cases, the pure Python source code can be a helpful adjunct to the +documentation, so now many modules now feature quick links to the latest +version of the source code. For example, the functools module +documentation has a quick link at the top labeled:

      +
      +

      Source code Lib/functools.py.

      +
      +

      (Contributed by Raymond Hettinger; see +rationale.)

      +
    • +
    • The docs now contain more examples and recipes. In particular, re +module has an extensive section, Regular Expression Examples. Likewise, the +itertools module continues to be updated with new +Itertools Recipes.

    • +
    • The datetime module now has an auxiliary implementation in pure Python. +No functionality was changed. This just provides an easier-to-read alternate +implementation.

      +

      (Contributed by Alexander Belopolsky in bpo-9528.)

      +
    • +
    • The unmaintained Demo directory has been removed. Some demos were +integrated into the documentation, some were moved to the Tools/demo +directory, and others were removed altogether.

      +

      (Contributed by Georg Brandl in bpo-7962.)

      +
    • +
    +
    +
    +

    IDLE

    +
      +
    • The format menu now has an option to clean source files by stripping +trailing whitespace.

      +

      (Contributed by Raymond Hettinger; bpo-5150.)

      +
    • +
    • IDLE on Mac OS X now works with both Carbon AquaTk and Cocoa AquaTk.

      +

      (Contributed by Kevin Walzer, Ned Deily, and Ronald Oussoren; bpo-6075.)

      +
    • +
    +
    +
    +

    Code Repository

    +

    In addition to the existing Subversion code repository at http://svn.python.org +there is now a Mercurial repository at +https://hg.python.org/.

    +

    After the 3.2 release, there are plans to switch to Mercurial as the primary +repository. This distributed version control system should make it easier for +members of the community to create and share external changesets. See +PEP 385 for details.

    +

    To learn to use the new version control system, see the Quick Start or the Guide to +Mercurial Workflows.

    +
    +
    +

    Build and C API Changes

    +

    Changes to Python’s build process and to the C API include:

    +
      +
    • The idle, pydoc and 2to3 scripts are now installed with a +version-specific suffix on make altinstall (bpo-10679).

    • +
    • The C functions that access the Unicode Database now accept and return +characters from the full Unicode range, even on narrow unicode builds +(Py_UNICODE_TOLOWER, Py_UNICODE_ISDECIMAL, and others). A visible difference +in Python is that unicodedata.numeric() now returns the correct value +for large code points, and repr() may consider more characters as +printable.

      +

      (Reported by Bupjoe Lee and fixed by Amaury Forgeot D’Arc; bpo-5127.)

      +
    • +
    • Computed gotos are now enabled by default on supported compilers (which are +detected by the configure script). They can still be disabled selectively by +specifying --without-computed-gotos.

      +

      (Contributed by Antoine Pitrou; bpo-9203.)

      +
    • +
    • The option --with-wctype-functions was removed. The built-in unicode +database is now used for all functions.

      +

      (Contributed by Amaury Forgeot D’Arc; bpo-9210.)

      +
    • +
    • Hash values are now values of a new type, Py_hash_t, which is +defined to be the same size as a pointer. Previously they were of type long, +which on some 64-bit operating systems is still only 32 bits long. As a +result of this fix, set and dict can now hold more than +2**32 entries on builds with 64-bit pointers (previously, they could grow +to that size but their performance degraded catastrophically).

      +

      (Suggested by Raymond Hettinger and implemented by Benjamin Peterson; +bpo-9778.)

      +
    • +
    • A new macro Py_VA_COPY copies the state of the variable argument +list. It is equivalent to C99 va_copy but available on all Python platforms +(bpo-2443).

    • +
    • A new C API function PySys_SetArgvEx() allows an embedded interpreter +to set sys.argv without also modifying sys.path +(bpo-5753).

    • +
    • PyEval_CallObject is now only available in macro form. The +function declaration, which was kept for backwards compatibility reasons, is +now removed – the macro was introduced in 1997 (bpo-8276).

    • +
    • There is a new function PyLong_AsLongLongAndOverflow() which +is analogous to PyLong_AsLongAndOverflow(). They both serve to +convert Python int into a native fixed-width type while providing +detection of cases where the conversion won’t fit (bpo-7767).

    • +
    • The PyUnicode_CompareWithASCIIString() function now returns not +equal if the Python string is NUL terminated.

    • +
    • There is a new function PyErr_NewExceptionWithDoc() that is +like PyErr_NewException() but allows a docstring to be specified. +This lets C exceptions have the same self-documenting capabilities as +their pure Python counterparts (bpo-7033).

    • +
    • When compiled with the --with-valgrind option, the pymalloc +allocator will be automatically disabled when running under Valgrind. This +gives improved memory leak detection when running under Valgrind, while taking +advantage of pymalloc at other times (bpo-2422).

    • +
    • Removed the O? format from the PyArg_Parse functions. The format is no +longer used and it had never been documented (bpo-8837).

    • +
    +

    There were a number of other small changes to the C-API. See the +Misc/NEWS file for a complete list.

    +

    Also, there were a number of updates to the Mac OS X build, see +Mac/BuildScript/README.txt for details. For users running a 32/64-bit +build, there is a known problem with the default Tcl/Tk on Mac OS X 10.6. +Accordingly, we recommend installing an updated alternative such as +ActiveState Tcl/Tk 8.5.9. +See https://www.python.org/download/mac/tcltk/ for additional details.

    +
    +
    +

    Porting to Python 3.2

    +

    This section lists previously described changes and other bugfixes that may +require changes to your code:

    +
      +
    • The configparser module has a number of clean-ups. The major change is +to replace the old ConfigParser class with long-standing preferred +alternative SafeConfigParser. In addition there are a number of +smaller incompatibilities:

      +
        +
      • The interpolation syntax is now validated on +get() and +set() operations. In the default +interpolation scheme, only two tokens with percent signs are valid: %(name)s +and %%, the latter being an escaped percent sign.

      • +
      • The set() and +add_section() methods now verify that +values are actual strings. Formerly, unsupported types could be introduced +unintentionally.

      • +
      • Duplicate sections or options from a single source now raise either +DuplicateSectionError or +DuplicateOptionError. Formerly, duplicates would +silently overwrite a previous entry.

      • +
      • Inline comments are now disabled by default so now the ; character +can be safely used in values.

      • +
      • Comments now can be indented. Consequently, for ; or # to appear at +the start of a line in multiline values, it has to be interpolated. This +keeps comment prefix characters in values from being mistaken as comments.

      • +
      • "" is now a valid value and is no longer automatically converted to an +empty string. For empty strings, use "option =" in a line.

      • +
      +
    • +
    • The nntplib module was reworked extensively, meaning that its APIs +are often incompatible with the 3.1 APIs.

    • +
    • bytearray objects can no longer be used as filenames; instead, +they should be converted to bytes.

    • +
    • The array.tostring() and array.fromstring() have been renamed to +array.tobytes() and array.frombytes() for clarity. The old names +have been deprecated. (See bpo-8990.)

    • +
    • PyArg_Parse*() functions:

      +
        +
      • “t#” format has been removed: use “s#” or “s*” instead

      • +
      • “w” and “w#” formats has been removed: use “w*” instead

      • +
      +
    • +
    • The PyCObject type, deprecated in 3.1, has been removed. To wrap +opaque C pointers in Python objects, the PyCapsule API should be used +instead; the new type has a well-defined interface for passing typing safety +information and a less complicated signature for calling a destructor.

    • +
    • The sys.setfilesystemencoding() function was removed because +it had a flawed design.

    • +
    • The random.seed() function and method now salt string seeds with an +sha512 hash function. To access the previous version of seed in order to +reproduce Python 3.1 sequences, set the version argument to 1, +random.seed(s, version=1).

    • +
    • The previously deprecated string.maketrans() function has been removed +in favor of the static methods bytes.maketrans() and +bytearray.maketrans(). This change solves the confusion around which +types were supported by the string module. Now, str, +bytes, and bytearray each have their own maketrans and +translate methods with intermediate translation tables of the appropriate +type.

      +

      (Contributed by Georg Brandl; bpo-5675.)

      +
    • +
    • The previously deprecated contextlib.nested() function has been removed +in favor of a plain with statement which can accept multiple +context managers. The latter technique is faster (because it is built-in), +and it does a better job finalizing multiple context managers when one of them +raises an exception:

      +
      with open('mylog.txt') as infile, open('a.out', 'w') as outfile:
      +    for line in infile:
      +        if '<critical>' in line:
      +            outfile.write(line)
      +
      +
      +

      (Contributed by Georg Brandl and Mattias Brändström; +appspot issue 53094.)

      +
    • +
    • struct.pack() now only allows bytes for the s string pack code. +Formerly, it would accept text arguments and implicitly encode them to bytes +using UTF-8. This was problematic because it made assumptions about the +correct encoding and because a variable-length encoding can fail when writing +to fixed length segment of a structure.

      +

      Code such as struct.pack('<6sHHBBB', 'GIF87a', x, y) should be rewritten +with to use bytes instead of text, struct.pack('<6sHHBBB', b'GIF87a', x, y).

      +

      (Discovered by David Beazley and fixed by Victor Stinner; bpo-10783.)

      +
    • +
    • The xml.etree.ElementTree class now raises an +xml.etree.ElementTree.ParseError when a parse fails. Previously it +raised an xml.parsers.expat.ExpatError.

    • +
    • The new, longer str() value on floats may break doctests which rely on +the old output format.

    • +
    • In subprocess.Popen, the default value for close_fds is now +True under Unix; under Windows, it is True if the three standard +streams are set to None, False otherwise. Previously, close_fds +was always False by default, which produced difficult to solve bugs +or race conditions when open file descriptors would leak into the child +process.

    • +
    • Support for legacy HTTP 0.9 has been removed from urllib.request +and http.client. Such support is still present on the server side +(in http.server).

      +

      (Contributed by Antoine Pitrou, bpo-10711.)

      +
    • +
    • SSL sockets in timeout mode now raise socket.timeout when a timeout +occurs, rather than a generic SSLError.

      +

      (Contributed by Antoine Pitrou, bpo-10272.)

      +
    • +
    • The misleading functions PyEval_AcquireLock() and +PyEval_ReleaseLock() have been officially deprecated. The +thread-state aware APIs (such as PyEval_SaveThread() +and PyEval_RestoreThread()) should be used instead.

    • +
    • Due to security risks, asyncore.handle_accept() has been deprecated, and +a new function, asyncore.handle_accepted(), was added to replace it.

      +

      (Contributed by Giampaolo Rodola in bpo-6706.)

      +
    • +
    • Due to the new GIL implementation, PyEval_InitThreads() +cannot be called before Py_Initialize() anymore.

    • +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/whatsnew/3.3.html b/python-3.7.4-docs-html/whatsnew/3.3.html new file mode 100644 index 0000000..995c3a9 --- /dev/null +++ b/python-3.7.4-docs-html/whatsnew/3.3.html @@ -0,0 +1,2527 @@ + + + + + + + What’s New In Python 3.3 — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    What’s New In Python 3.3

    +

    This article explains the new features in Python 3.3, compared to 3.2. +Python 3.3 was released on September 29, 2012. For full details, +see the changelog.

    +
    +

    See also

    +

    PEP 398 - Python 3.3 Release Schedule

    +
    +
    +

    Summary – Release highlights

    +

    New syntax features:

    + +

    New library modules:

    +
      +
    • faulthandler (helps debugging low-level crashes)

    • +
    • ipaddress (high-level objects representing IP addresses and masks)

    • +
    • lzma (compress data using the XZ / LZMA algorithm)

    • +
    • unittest.mock (replace parts of your system under test with mock objects)

    • +
    • venv (Python virtual environments, as in the +popular virtualenv package)

    • +
    +

    New built-in features:

    + +

    Implementation improvements:

    + +

    Significantly Improved Library Modules:

    + +

    Security improvements:

    +
      +
    • Hash randomization is switched on by default.

    • +
    +

    Please read on for a comprehensive list of user-facing changes.

    +
    +
    +

    PEP 405: Virtual Environments

    +

    Virtual environments help create separate Python setups while sharing a +system-wide base install, for ease of maintenance. Virtual environments +have their own set of private site packages (i.e. locally-installed +libraries), and are optionally segregated from the system-wide site +packages. Their concept and implementation are inspired by the popular +virtualenv third-party package, but benefit from tighter integration +with the interpreter core.

    +

    This PEP adds the venv module for programmatic access, and the +pyvenv script for command-line access and +administration. The Python interpreter checks for a pyvenv.cfg, +file whose existence signals the base of a virtual environment’s directory +tree.

    +
    +

    See also

    +
    +
    PEP 405 - Python Virtual Environments

    PEP written by Carl Meyer; implementation by Carl Meyer and Vinay Sajip

    +
    +
    +
    +
    +
    +

    PEP 420: Implicit Namespace Packages

    +

    Native support for package directories that don’t require __init__.py +marker files and can automatically span multiple path segments (inspired by +various third party approaches to namespace packages, as described in +PEP 420)

    +
    +

    See also

    +
    +
    PEP 420 - Implicit Namespace Packages

    PEP written by Eric V. Smith; implementation by Eric V. Smith +and Barry Warsaw

    +
    +
    +
    +
    +
    +

    PEP 3118: New memoryview implementation and buffer protocol documentation

    +

    The implementation of PEP 3118 has been significantly improved.

    +

    The new memoryview implementation comprehensively fixes all ownership and +lifetime issues of dynamically allocated fields in the Py_buffer struct +that led to multiple crash reports. Additionally, several functions that +crashed or returned incorrect results for non-contiguous or multi-dimensional +input have been fixed.

    +

    The memoryview object now has a PEP-3118 compliant getbufferproc() +that checks the consumer’s request type. Many new features have been +added, most of them work in full generality for non-contiguous arrays +and arrays with suboffsets.

    +

    The documentation has been updated, clearly spelling out responsibilities +for both exporters and consumers. Buffer request flags are grouped into +basic and compound flags. The memory layout of non-contiguous and +multi-dimensional NumPy-style arrays is explained.

    +
    +

    Features

    +
      +
    • All native single character format specifiers in struct module syntax +(optionally prefixed with ‘@’) are now supported.

    • +
    • With some restrictions, the cast() method allows changing of format and +shape of C-contiguous arrays.

    • +
    • Multi-dimensional list representations are supported for any array type.

    • +
    • Multi-dimensional comparisons are supported for any array type.

    • +
    • One-dimensional memoryviews of hashable (read-only) types with formats B, +b or c are now hashable. (Contributed by Antoine Pitrou in bpo-13411.)

    • +
    • Arbitrary slicing of any 1-D arrays type is supported. For example, it +is now possible to reverse a memoryview in O(1) by using a negative step.

    • +
    +
    +
    +

    API changes

    +
      +
    • The maximum number of dimensions is officially limited to 64.

    • +
    • The representation of empty shape, strides and suboffsets is now +an empty tuple instead of None.

    • +
    • Accessing a memoryview element with format ‘B’ (unsigned bytes) +now returns an integer (in accordance with the struct module syntax). +For returning a bytes object the view must be cast to ‘c’ first.

    • +
    • memoryview comparisons now use the logical structure of the operands +and compare all array elements by value. All format strings in struct +module syntax are supported. Views with unrecognised format strings +are still permitted, but will always compare as unequal, regardless +of view contents.

    • +
    • For further changes see Build and C API Changes and Porting C code.

    • +
    +

    (Contributed by Stefan Krah in bpo-10181.)

    +
    +

    See also

    +

    PEP 3118 - Revising the Buffer Protocol

    +
    +
    +
    +
    +

    PEP 393: Flexible String Representation

    +

    The Unicode string type is changed to support multiple internal +representations, depending on the character with the largest Unicode ordinal +(1, 2, or 4 bytes) in the represented string. This allows a space-efficient +representation in common cases, but gives access to full UCS-4 on all +systems. For compatibility with existing APIs, several representations may +exist in parallel; over time, this compatibility should be phased out.

    +

    On the Python side, there should be no downside to this change.

    +

    On the C API side, PEP 393 is fully backward compatible. The legacy API +should remain available at least five years. Applications using the legacy +API will not fully benefit of the memory reduction, or - worse - may use +a bit more memory, because Python may have to maintain two versions of each +string (in the legacy format and in the new efficient storage).

    +
    +

    Functionality

    +

    Changes introduced by PEP 393 are the following:

    +
      +
    • Python now always supports the full range of Unicode code points, including +non-BMP ones (i.e. from U+0000 to U+10FFFF). The distinction between +narrow and wide builds no longer exists and Python now behaves like a wide +build, even under Windows.

    • +
    • With the death of narrow builds, the problems specific to narrow builds have +also been fixed, for example:

      +
        +
      • len() now always returns 1 for non-BMP characters, +so len('\U0010FFFF') == 1;

      • +
      • surrogate pairs are not recombined in string literals, +so '\uDBFF\uDFFF' != '\U0010FFFF';

      • +
      • indexing or slicing non-BMP characters returns the expected value, +so '\U0010FFFF'[0] now returns '\U0010FFFF' and not '\uDBFF';

      • +
      • all other functions in the standard library now correctly handle +non-BMP code points.

      • +
      +
    • +
    • The value of sys.maxunicode is now always 1114111 (0x10FFFF +in hexadecimal). The PyUnicode_GetMax() function still returns +either 0xFFFF or 0x10FFFF for backward compatibility, and it should +not be used with the new Unicode API (see bpo-13054).

    • +
    • The ./configure flag --with-wide-unicode has been removed.

    • +
    +
    +
    +

    Performance and resource usage

    +

    The storage of Unicode strings now depends on the highest code point in the string:

    +
      +
    • pure ASCII and Latin1 strings (U+0000-U+00FF) use 1 byte per code point;

    • +
    • BMP strings (U+0000-U+FFFF) use 2 bytes per code point;

    • +
    • non-BMP strings (U+10000-U+10FFFF) use 4 bytes per code point.

    • +
    +

    The net effect is that for most applications, memory usage of string +storage should decrease significantly - especially compared to former +wide unicode builds - as, in many cases, strings will be pure ASCII +even in international contexts (because many strings store non-human +language data, such as XML fragments, HTTP headers, JSON-encoded data, +etc.). We also hope that it will, for the same reasons, increase CPU +cache efficiency on non-trivial applications. The memory usage of +Python 3.3 is two to three times smaller than Python 3.2, and a little +bit better than Python 2.7, on a Django benchmark (see the PEP for +details).

    +
    +

    See also

    +
    +
    PEP 393 - Flexible String Representation

    PEP written by Martin von Löwis; implementation by Torsten Becker +and Martin von Löwis.

    +
    +
    +
    +
    +
    +
    +

    PEP 397: Python Launcher for Windows

    +

    The Python 3.3 Windows installer now includes a py launcher application +that can be used to launch Python applications in a version independent +fashion.

    +

    This launcher is invoked implicitly when double-clicking *.py files. +If only a single Python version is installed on the system, that version +will be used to run the file. If multiple versions are installed, the most +recent version is used by default, but this can be overridden by including +a Unix-style “shebang line” in the Python script.

    +

    The launcher can also be used explicitly from the command line as the py +application. Running py follows the same version selection rules as +implicitly launching scripts, but a more specific version can be selected +by passing appropriate arguments (such as -3 to request Python 3 when +Python 2 is also installed, or -2.6 to specifically request an earlier +Python version when a more recent version is installed).

    +

    In addition to the launcher, the Windows installer now includes an +option to add the newly installed Python to the system PATH. (Contributed +by Brian Curtin in bpo-3561.)

    +
    +

    See also

    +
    +
    PEP 397 - Python Launcher for Windows

    PEP written by Mark Hammond and Martin v. Löwis; implementation by +Vinay Sajip.

    +
    +
    +

    Launcher documentation: Python Launcher for Windows

    +

    Installer PATH modification: Finding the Python executable

    +
    +
    +
    +

    PEP 3151: Reworking the OS and IO exception hierarchy

    +

    The hierarchy of exceptions raised by operating system errors is now both +simplified and finer-grained.

    +

    You don’t have to worry anymore about choosing the appropriate exception +type between OSError, IOError, EnvironmentError, +WindowsError, mmap.error, socket.error or +select.error. All these exception types are now only one: +OSError. The other names are kept as aliases for compatibility +reasons.

    +

    Also, it is now easier to catch a specific error condition. Instead of +inspecting the errno attribute (or args[0]) for a particular +constant from the errno module, you can catch the adequate +OSError subclass. The available subclasses are the following:

    + +

    And the ConnectionError itself has finer-grained subclasses:

    + +

    Thanks to the new exceptions, common usages of the errno can now be +avoided. For example, the following code written for Python 3.2:

    +
    from errno import ENOENT, EACCES, EPERM
    +
    +try:
    +    with open("document.txt") as f:
    +        content = f.read()
    +except IOError as err:
    +    if err.errno == ENOENT:
    +        print("document.txt file is missing")
    +    elif err.errno in (EACCES, EPERM):
    +        print("You are not allowed to read document.txt")
    +    else:
    +        raise
    +
    +
    +

    can now be written without the errno import and without manual +inspection of exception attributes:

    +
    try:
    +    with open("document.txt") as f:
    +        content = f.read()
    +except FileNotFoundError:
    +    print("document.txt file is missing")
    +except PermissionError:
    +    print("You are not allowed to read document.txt")
    +
    +
    +
    +

    See also

    +
    +
    PEP 3151 - Reworking the OS and IO Exception Hierarchy

    PEP written and implemented by Antoine Pitrou

    +
    +
    +
    +
    +
    +

    PEP 380: Syntax for Delegating to a Subgenerator

    +

    PEP 380 adds the yield from expression, allowing a generator to +delegate +part of its operations to another generator. This allows a section of code +containing yield to be factored out and placed in another generator. +Additionally, the subgenerator is allowed to return with a value, and the +value is made available to the delegating generator.

    +

    While designed primarily for use in delegating to a subgenerator, the yield +from expression actually allows delegation to arbitrary subiterators.

    +

    For simple iterators, yield from iterable is essentially just a shortened +form of for item in iterable: yield item:

    +
    >>> def g(x):
    +...     yield from range(x, 0, -1)
    +...     yield from range(x)
    +...
    +>>> list(g(5))
    +[5, 4, 3, 2, 1, 0, 1, 2, 3, 4]
    +
    +
    +

    However, unlike an ordinary loop, yield from allows subgenerators to +receive sent and thrown values directly from the calling scope, and +return a final value to the outer generator:

    +
    >>> def accumulate():
    +...     tally = 0
    +...     while 1:
    +...         next = yield
    +...         if next is None:
    +...             return tally
    +...         tally += next
    +...
    +>>> def gather_tallies(tallies):
    +...     while 1:
    +...         tally = yield from accumulate()
    +...         tallies.append(tally)
    +...
    +>>> tallies = []
    +>>> acc = gather_tallies(tallies)
    +>>> 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
    +>>> for i in range(5):
    +...     acc.send(i)
    +...
    +>>> acc.send(None)  # Finish the second tally
    +>>> tallies
    +[6, 10]
    +
    +
    +

    The main principle driving this change is to allow even generators that are +designed to be used with the send and throw methods to be split into +multiple subgenerators as easily as a single large function can be split into +multiple subfunctions.

    +
    +

    See also

    +
    +
    PEP 380 - Syntax for Delegating to a Subgenerator

    PEP written by Greg Ewing; implementation by Greg Ewing, integrated into +3.3 by Renaud Blanch, Ryan Kelly and Nick Coghlan; documentation by +Zbigniew Jędrzejewski-Szmek and Nick Coghlan

    +
    +
    +
    +
    +
    +

    PEP 409: Suppressing exception context

    +

    PEP 409 introduces new syntax that allows the display of the chained +exception context to be disabled. This allows cleaner error messages in +applications that convert between exception types:

    +
    >>> class D:
    +...     def __init__(self, extra):
    +...         self._extra_attributes = extra
    +...     def __getattr__(self, attr):
    +...         try:
    +...             return self._extra_attributes[attr]
    +...         except KeyError:
    +...             raise AttributeError(attr) from None
    +...
    +>>> D({}).x
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +  File "<stdin>", line 8, in __getattr__
    +AttributeError: x
    +
    +
    +

    Without the from None suffix to suppress the cause, the original +exception would be displayed by default:

    +
    >>> class C:
    +...     def __init__(self, extra):
    +...         self._extra_attributes = extra
    +...     def __getattr__(self, attr):
    +...         try:
    +...             return self._extra_attributes[attr]
    +...         except KeyError:
    +...             raise AttributeError(attr)
    +...
    +>>> C({}).x
    +Traceback (most recent call last):
    +  File "<stdin>", line 6, in __getattr__
    +KeyError: 'x'
    +
    +During handling of the above exception, another exception occurred:
    +
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +  File "<stdin>", line 8, in __getattr__
    +AttributeError: x
    +
    +
    +

    No debugging capability is lost, as the original exception context remains +available if needed (for example, if an intervening library has incorrectly +suppressed valuable underlying details):

    +
    >>> try:
    +...     D({}).x
    +... except AttributeError as exc:
    +...     print(repr(exc.__context__))
    +...
    +KeyError('x',)
    +
    +
    +
    +

    See also

    +
    +
    PEP 409 - Suppressing exception context

    PEP written by Ethan Furman; implemented by Ethan Furman and Nick +Coghlan.

    +
    +
    +
    +
    +
    +

    PEP 414: Explicit Unicode literals

    +

    To ease the transition from Python 2 for Unicode aware Python applications +that make heavy use of Unicode literals, Python 3.3 once again supports the +“u” prefix for string literals. This prefix has no semantic significance +in Python 3, it is provided solely to reduce the number of purely mechanical +changes in migrating to Python 3, making it easier for developers to focus on +the more significant semantic changes (such as the stricter default +separation of binary and text data).

    +
    +

    See also

    +
    +
    PEP 414 - Explicit Unicode literals

    PEP written by Armin Ronacher.

    +
    +
    +
    +
    +
    +

    PEP 3155: Qualified name for classes and functions

    +

    Functions and class objects have a new __qualname__ attribute representing +the “path” from the module top-level to their definition. For global functions +and classes, this is the same as __name__. For other functions and classes, +it provides better information about where they were actually defined, and +how they might be accessible from the global scope.

    +

    Example with (non-bound) methods:

    +
    >>> class C:
    +...     def meth(self):
    +...         pass
    +>>> C.meth.__name__
    +'meth'
    +>>> C.meth.__qualname__
    +'C.meth'
    +
    +
    +

    Example with nested classes:

    +
    >>> class C:
    +...     class D:
    +...         def meth(self):
    +...             pass
    +...
    +>>> C.D.__name__
    +'D'
    +>>> C.D.__qualname__
    +'C.D'
    +>>> C.D.meth.__name__
    +'meth'
    +>>> C.D.meth.__qualname__
    +'C.D.meth'
    +
    +
    +

    Example with nested functions:

    +
    >>> def outer():
    +...     def inner():
    +...         pass
    +...     return inner
    +...
    +>>> outer().__name__
    +'inner'
    +>>> outer().__qualname__
    +'outer.<locals>.inner'
    +
    +
    +

    The string representation of those objects is also changed to include the +new, more precise information:

    +
    >>> str(C.D)
    +"<class '__main__.C.D'>"
    +>>> str(C.D.meth)
    +'<function C.D.meth at 0x7f46b9fe31e0>'
    +
    +
    +
    +

    See also

    +
    +
    PEP 3155 - Qualified name for classes and functions

    PEP written and implemented by Antoine Pitrou.

    +
    +
    +
    +
    +
    +

    PEP 412: Key-Sharing Dictionary

    +

    Dictionaries used for the storage of objects’ attributes are now able to +share part of their internal storage between each other (namely, the part +which stores the keys and their respective hashes). This reduces the memory +consumption of programs creating many instances of non-builtin types.

    +
    +

    See also

    +
    +
    PEP 412 - Key-Sharing Dictionary

    PEP written and implemented by Mark Shannon.

    +
    +
    +
    +
    +
    +

    PEP 362: Function Signature Object

    +

    A new function inspect.signature() makes introspection of python +callables easy and straightforward. A broad range of callables is supported: +python functions, decorated or not, classes, and functools.partial() +objects. New classes inspect.Signature, inspect.Parameter +and inspect.BoundArguments hold information about the call signatures, +such as, annotations, default values, parameters kinds, and bound arguments, +which considerably simplifies writing decorators and any code that validates +or amends calling signatures or arguments.

    +
    +

    See also

    +
    +
    PEP 362: - Function Signature Object

    PEP written by Brett Cannon, Yury Selivanov, Larry Hastings, Jiwon Seo; +implemented by Yury Selivanov.

    +
    +
    +
    +
    +
    +

    PEP 421: Adding sys.implementation

    +

    A new attribute on the sys module exposes details specific to the +implementation of the currently running interpreter. The initial set of +attributes on sys.implementation are name, version, +hexversion, and cache_tag.

    +

    The intention of sys.implementation is to consolidate into one namespace +the implementation-specific data used by the standard library. This allows +different Python implementations to share a single standard library code base +much more easily. In its initial state, sys.implementation holds only a +small portion of the implementation-specific data. Over time that ratio will +shift in order to make the standard library more portable.

    +

    One example of improved standard library portability is cache_tag. As of +Python 3.3, sys.implementation.cache_tag is used by importlib to +support PEP 3147 compliance. Any Python implementation that uses +importlib for its built-in import system may use cache_tag to control +the caching behavior for modules.

    +
    +

    SimpleNamespace

    +

    The implementation of sys.implementation also introduces a new type to +Python: types.SimpleNamespace. In contrast to a mapping-based +namespace, like dict, SimpleNamespace is attribute-based, like +object. However, unlike object, SimpleNamespace instances +are writable. This means that you can add, remove, and modify the namespace +through normal attribute access.

    +
    +

    See also

    +
    +
    PEP 421 - Adding sys.implementation

    PEP written and implemented by Eric Snow.

    +
    +
    +
    +
    +
    +
    +

    Using importlib as the Implementation of Import

    +

    bpo-2377 - Replace __import__ w/ importlib.__import__ +bpo-13959 - Re-implement parts of imp in pure Python +bpo-14605 - Make import machinery explicit +bpo-14646 - Require loaders set __loader__ and __package__

    +

    The __import__() function is now powered by importlib.__import__(). +This work leads to the completion of “phase 2” of PEP 302. There are +multiple benefits to this change. First, it has allowed for more of the +machinery powering import to be exposed instead of being implicit and hidden +within the C code. It also provides a single implementation for all Python VMs +supporting Python 3.3 to use, helping to end any VM-specific deviations in +import semantics. And finally it eases the maintenance of import, allowing for +future growth to occur.

    +

    For the common user, there should be no visible change in semantics. For +those whose code currently manipulates import or calls import +programmatically, the code changes that might possibly be required are covered +in the Porting Python code section of this document.

    +
    +

    New APIs

    +

    One of the large benefits of this work is the exposure of what goes into +making the import statement work. That means the various importers that were +once implicit are now fully exposed as part of the importlib package.

    +

    The abstract base classes defined in importlib.abc have been expanded +to properly delineate between meta path finders +and path entry finders by introducing +importlib.abc.MetaPathFinder and +importlib.abc.PathEntryFinder, respectively. The old ABC of +importlib.abc.Finder is now only provided for backwards-compatibility +and does not enforce any method requirements.

    +

    In terms of finders, importlib.machinery.FileFinder exposes the +mechanism used to search for source and bytecode files of a module. Previously +this class was an implicit member of sys.path_hooks.

    +

    For loaders, the new abstract base class importlib.abc.FileLoader helps +write a loader that uses the file system as the storage mechanism for a module’s +code. The loader for source files +(importlib.machinery.SourceFileLoader), sourceless bytecode files +(importlib.machinery.SourcelessFileLoader), and extension modules +(importlib.machinery.ExtensionFileLoader) are now available for +direct use.

    +

    ImportError now has name and path attributes which are set when +there is relevant data to provide. The message for failed imports will also +provide the full name of the module now instead of just the tail end of the +module’s name.

    +

    The importlib.invalidate_caches() function will now call the method with +the same name on all finders cached in sys.path_importer_cache to help +clean up any stored state as necessary.

    +
    +
    +

    Visible Changes

    +

    For potential required changes to code, see the Porting Python code +section.

    +

    Beyond the expanse of what importlib now exposes, there are other +visible changes to import. The biggest is that sys.meta_path and +sys.path_hooks now store all of the meta path finders and path entry +hooks used by import. Previously the finders were implicit and hidden within +the C code of import instead of being directly exposed. This means that one can +now easily remove or change the order of the various finders to fit one’s needs.

    +

    Another change is that all modules have a __loader__ attribute, storing the +loader used to create the module. PEP 302 has been updated to make this +attribute mandatory for loaders to implement, so in the future once 3rd-party +loaders have been updated people will be able to rely on the existence of the +attribute. Until such time, though, import is setting the module post-load.

    +

    Loaders are also now expected to set the __package__ attribute from +PEP 366. Once again, import itself is already setting this on all loaders +from importlib and import itself is setting the attribute post-load.

    +

    None is now inserted into sys.path_importer_cache when no finder +can be found on sys.path_hooks. Since imp.NullImporter is not +directly exposed on sys.path_hooks it could no longer be relied upon to +always be available to use as a value representing no finder found.

    +

    All other changes relate to semantic changes which should be taken into +consideration when updating code for Python 3.3, and thus should be read about +in the Porting Python code section of this document.

    +

    (Implementation by Brett Cannon)

    +
    +
    +
    +

    Other Language Changes

    +

    Some smaller changes made to the core Python language are:

    +
      +
    • Added support for Unicode name aliases and named sequences. +Both unicodedata.lookup() and '\N{...}' now resolve name aliases, +and unicodedata.lookup() resolves named sequences too.

      +

      (Contributed by Ezio Melotti in bpo-12753.)

      +
    • +
    • Unicode database updated to UCD version 6.1.0

    • +
    • Equality comparisons on range() objects now return a result reflecting +the equality of the underlying sequences generated by those range objects. +(bpo-13201)

    • +
    • The count(), find(), rfind(), index() and rindex() +methods of bytes and bytearray objects now accept an +integer between 0 and 255 as their first argument.

      +

      (Contributed by Petri Lehtinen in bpo-12170.)

      +
    • +
    • The rjust(), ljust(), and center() methods of bytes +and bytearray now accept a bytearray for the fill +argument. (Contributed by Petri Lehtinen in bpo-12380.)

    • +
    • New methods have been added to list and bytearray: +copy() and clear() (bpo-10516). Consequently, +MutableSequence now also defines a +clear() method (bpo-11388).

    • +
    • Raw bytes literals can now be written rb"..." as well as br"...".

      +

      (Contributed by Antoine Pitrou in bpo-13748.)

      +
    • +
    • dict.setdefault() now does only one lookup for the given key, making +it atomic when used with built-in types.

      +

      (Contributed by Filip Gruszczyński in bpo-13521.)

      +
    • +
    • The error messages produced when a function call does not match the function +signature have been significantly improved.

      +

      (Contributed by Benjamin Peterson.)

      +
    • +
    +
    +
    +

    A Finer-Grained Import Lock

    +

    Previous versions of CPython have always relied on a global import lock. +This led to unexpected annoyances, such as deadlocks when importing a module +would trigger code execution in a different thread as a side-effect. +Clumsy workarounds were sometimes employed, such as the +PyImport_ImportModuleNoBlock() C API function.

    +

    In Python 3.3, importing a module takes a per-module lock. This correctly +serializes importation of a given module from multiple threads (preventing +the exposure of incompletely initialized modules), while eliminating the +aforementioned annoyances.

    +

    (Contributed by Antoine Pitrou in bpo-9260.)

    +
    +
    +

    Builtin functions and types

    +
      +
    • open() gets a new opener parameter: the underlying file descriptor +for the file object is then obtained by calling opener with (file, +flags). It can be used to use custom flags like os.O_CLOEXEC for +example. The 'x' mode was added: open for exclusive creation, failing if +the file already exists.

    • +
    • print(): added the flush keyword argument. If the flush keyword +argument is true, the stream is forcibly flushed.

    • +
    • hash(): hash randomization is enabled by default, see +object.__hash__() and PYTHONHASHSEED.

    • +
    • The str type gets a new casefold() method: return a +casefolded copy of the string, casefolded strings may be used for caseless +matching. For example, 'ß'.casefold() returns 'ss'.

    • +
    • The sequence documentation has been substantially rewritten to better +explain the binary/text sequence distinction and to provide specific +documentation sections for the individual builtin sequence types +(bpo-4966).

    • +
    +
    +
    +

    New Modules

    +
    +

    faulthandler

    +

    This new debug module faulthandler contains functions to dump Python tracebacks explicitly, +on a fault (a crash like a segmentation fault), after a timeout, or on a user +signal. Call faulthandler.enable() to install fault handlers for the +SIGSEGV, SIGFPE, SIGABRT, SIGBUS, and +SIGILL signals. You can also enable them at startup by setting the +PYTHONFAULTHANDLER environment variable or by using -X +faulthandler command line option.

    +

    Example of a segmentation fault on Linux:

    +
    $ python -q -X faulthandler
    +>>> import ctypes
    +>>> ctypes.string_at(0)
    +Fatal Python error: Segmentation fault
    +
    +Current thread 0x00007fb899f39700:
    +  File "/home/python/cpython/Lib/ctypes/__init__.py", line 486 in string_at
    +  File "<stdin>", line 1 in <module>
    +Segmentation fault
    +
    +
    +
    +
    +

    ipaddress

    +

    The new ipaddress module provides tools for creating and manipulating +objects representing IPv4 and IPv6 addresses, networks and interfaces (i.e. +an IP address associated with a specific IP subnet).

    +

    (Contributed by Google and Peter Moody in PEP 3144.)

    +
    +
    +

    lzma

    +

    The newly-added lzma module provides data compression and decompression +using the LZMA algorithm, including support for the .xz and .lzma +file formats.

    +

    (Contributed by Nadeem Vawda and Per Øyvind Karlsen in bpo-6715.)

    +
    +
    +
    +

    Improved Modules

    +
    +

    abc

    +

    Improved support for abstract base classes containing descriptors composed with +abstract methods. The recommended approach to declaring abstract descriptors is +now to provide __isabstractmethod__ as a dynamically updated +property. The built-in descriptors have been updated accordingly.

    +
    +
    +
    +

    (Contributed by Darren Dale in bpo-11610.)

    +

    abc.ABCMeta.register() now returns the registered subclass, which means +it can now be used as a class decorator (bpo-10868).

    +
    +
    +

    array

    +

    The array module supports the long long type using q and +Q type codes.

    +

    (Contributed by Oren Tirosh and Hirokazu Yamamoto in bpo-1172711.)

    +
    +
    +

    base64

    +

    ASCII-only Unicode strings are now accepted by the decoding functions of the +base64 modern interface. For example, base64.b64decode('YWJj') +returns b'abc'. (Contributed by Catalin Iacob in bpo-13641.)

    +
    +
    +

    binascii

    +

    In addition to the binary objects they normally accept, the a2b_ functions +now all also accept ASCII-only strings as input. (Contributed by Antoine +Pitrou in bpo-13637.)

    +
    +
    +

    bz2

    +

    The bz2 module has been rewritten from scratch. In the process, several +new features have been added:

    +
      +
    • New bz2.open() function: open a bzip2-compressed file in binary or +text mode.

    • +
    • bz2.BZ2File can now read from and write to arbitrary file-like +objects, by means of its constructor’s fileobj argument.

      +

      (Contributed by Nadeem Vawda in bpo-5863.)

      +
    • +
    • bz2.BZ2File and bz2.decompress() can now decompress +multi-stream inputs (such as those produced by the pbzip2 tool). +bz2.BZ2File can now also be used to create this type of file, using +the 'a' (append) mode.

      +

      (Contributed by Nir Aides in bpo-1625.)

      +
    • +
    • bz2.BZ2File now implements all of the io.BufferedIOBase API, +except for the detach() and truncate() methods.

    • +
    +
    +
    +

    codecs

    +

    The mbcs codec has been rewritten to handle correctly +replace and ignore error handlers on all Windows versions. The +mbcs codec now supports all error handlers, instead of only +replace to encode and ignore to decode.

    +

    A new Windows-only codec has been added: cp65001 (bpo-13216). It is the +Windows code page 65001 (Windows UTF-8, CP_UTF8). For example, it is used +by sys.stdout if the console output code page is set to cp65001 (e.g., using +chcp 65001 command).

    +

    Multibyte CJK decoders now resynchronize faster. They only ignore the first +byte of an invalid byte sequence. For example, b'\xff\n'.decode('gb2312', +'replace') now returns a \n after the replacement character.

    +

    (bpo-12016)

    +

    Incremental CJK codec encoders are no longer reset at each call to their +encode() methods. For example:

    +
    >>> import codecs
    +>>> encoder = codecs.getincrementalencoder('hz')('strict')
    +>>> b''.join(encoder.encode(x) for x in '\u52ff\u65bd\u65bc\u4eba\u3002 Bye.')
    +b'~{NpJ)l6HK!#~} Bye.'
    +
    +
    +

    This example gives b'~{Np~}~{J)~}~{l6~}~{HK~}~{!#~} Bye.' with older Python +versions.

    +

    (bpo-12100)

    +

    The unicode_internal codec has been deprecated.

    +
    +
    +

    collections

    +

    Addition of a new ChainMap class to allow treating a +number of mappings as a single unit. (Written by Raymond Hettinger for +bpo-11089, made public in bpo-11297.)

    +

    The abstract base classes have been moved in a new collections.abc +module, to better differentiate between the abstract and the concrete +collections classes. Aliases for ABCs are still present in the +collections module to preserve existing imports. (bpo-11085)

    +

    The Counter class now supports the unary + and - +operators, as well as the in-place operators +=, -=, |=, and +&=. (Contributed by Raymond Hettinger in bpo-13121.)

    +
    +
    +

    contextlib

    +

    ExitStack now provides a solid foundation for +programmatic manipulation of context managers and similar cleanup +functionality. Unlike the previous contextlib.nested API (which was +deprecated and removed), the new API is designed to work correctly +regardless of whether context managers acquire their resources in +their __init__ method (for example, file objects) or in their +__enter__ method (for example, synchronisation objects from the +threading module).

    +

    (bpo-13585)

    +
    +
    +

    crypt

    +

    Addition of salt and modular crypt format (hashing method) and the mksalt() +function to the crypt module.

    +

    (bpo-10924)

    +
    +
    +

    curses

    +
    +
      +
    • If the curses module is linked to the ncursesw library, use Unicode +functions when Unicode strings or characters are passed (e.g. +waddwstr()), and bytes functions otherwise (e.g. waddstr()).

    • +
    • Use the locale encoding instead of utf-8 to encode Unicode strings.

    • +
    • curses.window has a new curses.window.encoding attribute.

    • +
    • The curses.window class has a new get_wch() +method to get a wide character

    • +
    • The curses module has a new unget_wch() function to +push a wide character so the next get_wch() will return +it

    • +
    +
    +

    (Contributed by Iñigo Serna in bpo-6755.)

    +
    +
    +

    datetime

    +
    +
    +
    +
    +
    +

    decimal

    +
    +
    bpo-7652 - integrate fast native decimal arithmetic.

    C-module and libmpdec written by Stefan Krah.

    +
    +
    +

    The new C version of the decimal module integrates the high speed libmpdec +library for arbitrary precision correctly-rounded decimal floating point +arithmetic. libmpdec conforms to IBM’s General Decimal Arithmetic Specification.

    +

    Performance gains range from 10x for database applications to 100x for +numerically intensive applications. These numbers are expected gains +for standard precisions used in decimal floating point arithmetic. Since +the precision is user configurable, the exact figures may vary. For example, +in integer bignum arithmetic the differences can be significantly higher.

    +

    The following table is meant as an illustration. Benchmarks are available +at http://www.bytereef.org/mpdecimal/quickstart.html.

    +
    +
    ++++++ + + + + + + + + + + + + + + + + + + + + + + + + +

    decimal.py

    _decimal

    speedup

    pi

    42.02s

    0.345s

    120x

    telco

    172.19s

    5.68s

    30x

    psycopg

    3.57s

    0.29s

    12x

    +
    +
    +

    Features

    +
      +
    • The FloatOperation signal optionally enables stricter +semantics for mixing floats and Decimals.

    • +
    • If Python is compiled without threads, the C version automatically +disables the expensive thread local context machinery. In this case, +the variable HAVE_THREADS is set to False.

    • +
    +
    +
    +

    API changes

    +
      +
    • The C module has the following context limits, depending on the machine +architecture:

      +
      +
      +++++ + + + + + + + + + + + + + + + + + + + + +

      32-bit

      64-bit

      MAX_PREC

      425000000

      999999999999999999

      MAX_EMAX

      425000000

      999999999999999999

      MIN_EMIN

      -425000000

      -999999999999999999

      +
      +
    • +
    • In the context templates (DefaultContext, +BasicContext and ExtendedContext) +the magnitude of Emax and +Emin has changed to 999999.

    • +
    • The Decimal constructor in decimal.py does not observe +the context limits and converts values with arbitrary exponents or precision +exactly. Since the C version has internal limits, the following scheme is +used: If possible, values are converted exactly, otherwise +InvalidOperation is raised and the result is NaN. In the +latter case it is always possible to use create_decimal() +in order to obtain a rounded or inexact value.

    • +
    • The power function in decimal.py is always correctly-rounded. In the +C version, it is defined in terms of the correctly-rounded +exp() and ln() functions, +but the final result is only “almost always correctly rounded”.

    • +
    • In the C version, the context dictionary containing the signals is a +MutableMapping. For speed reasons, +flags and traps always +refer to the same MutableMapping that the context +was initialized with. If a new signal dictionary is assigned, +flags and traps +are updated with the new values, but they do not reference the RHS +dictionary.

    • +
    • Pickling a Context produces a different output in order +to have a common interchange format for the Python and C versions.

    • +
    • The order of arguments in the Context constructor has been +changed to match the order displayed by repr().

    • +
    • The watchexp parameter in the quantize() method +is deprecated.

    • +
    +
    +
    +
    +

    email

    +
    +

    Policy Framework

    +

    The email package now has a policy framework. A +Policy is an object with several methods and properties +that control how the email package behaves. The primary policy for Python 3.3 +is the Compat32 policy, which provides backward +compatibility with the email package in Python 3.2. A policy can be +specified when an email message is parsed by a parser, or when a +Message object is created, or when an email is +serialized using a generator. Unless overridden, a policy passed +to a parser is inherited by all the Message object and sub-objects +created by the parser. By default a generator will use the policy of +the Message object it is serializing. The default policy is +compat32.

    +

    The minimum set of controls implemented by all policy objects are:

    +
    +
    ++++ + + + + + + + + + + + + + + +

    max_line_length

    The maximum length, excluding the linesep character(s), +individual lines may have when a Message is +serialized. Defaults to 78.

    linesep

    The character used to separate individual lines when a +Message is serialized. Defaults to \n.

    cte_type

    7bit or 8bit. 8bit applies only to a +Bytes generator, and means that non-ASCII may +be used where allowed by the protocol (or where it +exists in the original input).

    raise_on_defect

    Causes a parser to raise error when defects are +encountered instead of adding them to the Message +object’s defects list.

    +
    +

    A new policy instance, with new settings, is created using the +clone() method of policy objects. clone takes +any of the above controls as keyword arguments. Any control not specified in +the call retains its default value. Thus you can create a policy that uses +\r\n linesep characters like this:

    +
    mypolicy = compat32.clone(linesep='\r\n')
    +
    +
    +

    Policies can be used to make the generation of messages in the format needed by +your application simpler. Instead of having to remember to specify +linesep='\r\n' in all the places you call a generator, you can specify +it once, when you set the policy used by the parser or the Message, +whichever your program uses to create Message objects. On the other hand, +if you need to generate messages in multiple forms, you can still specify the +parameters in the appropriate generator call. Or you can have custom +policy instances for your different cases, and pass those in when you create +the generator.

    +
    +
    +

    Provisional Policy with New Header API

    +

    While the policy framework is worthwhile all by itself, the main motivation for +introducing it is to allow the creation of new policies that implement new +features for the email package in a way that maintains backward compatibility +for those who do not use the new policies. Because the new policies introduce a +new API, we are releasing them in Python 3.3 as a provisional policy. Backwards incompatible changes (up to and including +removal of the code) may occur if deemed necessary by the core developers.

    +

    The new policies are instances of EmailPolicy, +and add the following additional controls:

    +
    +
    ++++ + + + + + + + + +

    refold_source

    Controls whether or not headers parsed by a +parser are refolded by the +generator. It can be none, long, +or all. The default is long, which means that +source headers with a line longer than +max_line_length get refolded. none means no +line get refolded, and all means that all lines +get refolded.

    header_factory

    A callable that take a name and value and +produces a custom header object.

    +
    +

    The header_factory is the key to the new features provided by the new +policies. When one of the new policies is used, any header retrieved from +a Message object is an object produced by the header_factory, and any +time you set a header on a Message it becomes an object produced by +header_factory. All such header objects have a name attribute equal +to the header name. Address and Date headers have additional attributes +that give you access to the parsed data of the header. This means you can now +do things like this:

    +
    >>> m = Message(policy=SMTP)
    +>>> m['To'] = 'Éric <foo@example.com>'
    +>>> m['to']
    +'Éric <foo@example.com>'
    +>>> m['to'].addresses
    +(Address(display_name='Éric', username='foo', domain='example.com'),)
    +>>> m['to'].addresses[0].username
    +'foo'
    +>>> m['to'].addresses[0].display_name
    +'Éric'
    +>>> m['Date'] = email.utils.localtime()
    +>>> m['Date'].datetime
    +datetime.datetime(2012, 5, 25, 21, 39, 24, 465484, tzinfo=datetime.timezone(datetime.timedelta(-1, 72000), 'EDT'))
    +>>> m['Date']
    +'Fri, 25 May 2012 21:44:27 -0400'
    +>>> print(m)
    +To: =?utf-8?q?=C3=89ric?= <foo@example.com>
    +Date: Fri, 25 May 2012 21:44:27 -0400
    +
    +
    +

    You will note that the unicode display name is automatically encoded as +utf-8 when the message is serialized, but that when the header is accessed +directly, you get the unicode version. This eliminates any need to deal with +the email.header decode_header() or +make_header() functions.

    +

    You can also create addresses from parts:

    +
    >>> m['cc'] = [Group('pals', [Address('Bob', 'bob', 'example.com'),
    +...                           Address('Sally', 'sally', 'example.com')]),
    +...            Address('Bonzo', addr_spec='bonz@laugh.com')]
    +>>> print(m)
    +To: =?utf-8?q?=C3=89ric?= <foo@example.com>
    +Date: Fri, 25 May 2012 21:44:27 -0400
    +cc: pals: Bob <bob@example.com>, Sally <sally@example.com>;, Bonzo <bonz@laugh.com>
    +
    +
    +

    Decoding to unicode is done automatically:

    +
    >>> m2 = message_from_string(str(m))
    +>>> m2['to']
    +'Éric <foo@example.com>'
    +
    +
    +

    When you parse a message, you can use the addresses and groups +attributes of the header objects to access the groups and individual +addresses:

    +
    >>> m2['cc'].addresses
    +(Address(display_name='Bob', username='bob', domain='example.com'), Address(display_name='Sally', username='sally', domain='example.com'), Address(display_name='Bonzo', username='bonz', domain='laugh.com'))
    +>>> m2['cc'].groups
    +(Group(display_name='pals', addresses=(Address(display_name='Bob', username='bob', domain='example.com'), Address(display_name='Sally', username='sally', domain='example.com')), Group(display_name=None, addresses=(Address(display_name='Bonzo', username='bonz', domain='laugh.com'),))
    +
    +
    +

    In summary, if you use one of the new policies, header manipulation works the +way it ought to: your application works with unicode strings, and the email +package transparently encodes and decodes the unicode to and from the RFC +standard Content Transfer Encodings.

    +
    +
    +

    Other API Changes

    +

    New BytesHeaderParser, added to the parser +module to complement HeaderParser and complete the Bytes +API.

    +

    New utility functions:

    +
    +
    +
    +
    +
    +
    +

    ftplib

    +
      +
    • ftplib.FTP now accepts a source_address keyword argument to +specify the (host, port) to use as the source address in the bind call +when creating the outgoing socket. (Contributed by Giampaolo Rodolà +in bpo-8594.)

    • +
    • The FTP_TLS class now provides a new +ccc() function to revert control channel back to +plaintext. This can be useful to take advantage of firewalls that know how +to handle NAT with non-secure FTP without opening fixed ports. (Contributed +by Giampaolo Rodolà in bpo-12139.)

    • +
    • Added ftplib.FTP.mlsd() method which provides a parsable directory +listing format and deprecates ftplib.FTP.nlst() and +ftplib.FTP.dir(). (Contributed by Giampaolo Rodolà in bpo-11072.)

    • +
    +
    +
    +

    functools

    +

    The functools.lru_cache() decorator now accepts a typed keyword +argument (that defaults to False to ensure that it caches values of +different types that compare equal in separate cache slots. (Contributed +by Raymond Hettinger in bpo-13227.)

    +
    +
    +

    gc

    +

    It is now possible to register callbacks invoked by the garbage collector +before and after collection using the new callbacks list.

    +
    +
    +

    hmac

    +

    A new compare_digest() function has been added to prevent side +channel attacks on digests through timing analysis. (Contributed by Nick +Coghlan and Christian Heimes in bpo-15061.)

    +
    +
    +

    http

    +

    http.server.BaseHTTPRequestHandler now buffers the headers and writes +them all at once when end_headers() is +called. A new method flush_headers() +can be used to directly manage when the accumulated headers are sent. +(Contributed by Andrew Schaaf in bpo-3709.)

    +

    http.server now produces valid HTML 4.01 strict output. +(Contributed by Ezio Melotti in bpo-13295.)

    +

    http.client.HTTPResponse now has a +readinto() method, which means it can be used +as an io.RawIOBase class. (Contributed by John Kuhn in +bpo-13464.)

    +
    +
    +

    html

    +

    html.parser.HTMLParser is now able to parse broken markup without +raising errors, therefore the strict argument of the constructor and the +HTMLParseError exception are now deprecated. +The ability to parse broken markup is the result of a number of bug fixes that +are also available on the latest bug fix releases of Python 2.7/3.2. +(Contributed by Ezio Melotti in bpo-15114, and bpo-14538, +bpo-13993, bpo-13960, bpo-13358, bpo-1745761, +bpo-755670, bpo-13357, bpo-12629, bpo-1200313, +bpo-670664, bpo-13273, bpo-12888, bpo-7311.)

    +

    A new html5 dictionary that maps HTML5 named character +references to the equivalent Unicode character(s) (e.g. html5['gt;'] == +'>') has been added to the html.entities module. The dictionary is +now also used by HTMLParser. (Contributed by Ezio +Melotti in bpo-11113 and bpo-15156.)

    +
    +
    +

    imaplib

    +

    The IMAP4_SSL constructor now accepts an SSLContext +parameter to control parameters of the secure channel.

    +

    (Contributed by Sijin Joseph in bpo-8808.)

    +
    +
    +

    inspect

    +

    A new getclosurevars() function has been added. This function +reports the current binding of all names referenced from the function body and +where those names were resolved, making it easier to verify correct internal +state when testing code that relies on stateful closures.

    +

    (Contributed by Meador Inge and Nick Coghlan in bpo-13062.)

    +

    A new getgeneratorlocals() function has been added. This +function reports the current binding of local variables in the generator’s +stack frame, making it easier to verify correct internal state when testing +generators.

    +

    (Contributed by Meador Inge in bpo-15153.)

    +
    +
    +

    io

    +

    The open() function has a new 'x' mode that can be used to +exclusively create a new file, and raise a FileExistsError if the file +already exists. It is based on the C11 ‘x’ mode to fopen().

    +

    (Contributed by David Townshend in bpo-12760.)

    +

    The constructor of the TextIOWrapper class has a new +write_through optional argument. If write_through is True, calls to +write() are guaranteed not to be buffered: any data +written on the TextIOWrapper object is immediately handled to its +underlying binary buffer.

    +
    +
    +

    itertools

    +

    accumulate() now takes an optional func argument for +providing a user-supplied binary function.

    +
    +
    +

    logging

    +

    The basicConfig() function now supports an optional handlers +argument taking an iterable of handlers to be added to the root logger.

    +

    A class level attribute append_nul has +been added to SysLogHandler to allow control of the +appending of the NUL (\000) byte to syslog records, since for some +daemons it is required while for others it is passed through to the log.

    +
    +
    +

    math

    +

    The math module has a new function, log2(), which returns +the base-2 logarithm of x.

    +

    (Written by Mark Dickinson in bpo-11888.)

    +
    +
    +

    mmap

    +

    The read() method is now more compatible with other file-like +objects: if the argument is omitted or specified as None, it returns the +bytes from the current file position to the end of the mapping. (Contributed +by Petri Lehtinen in bpo-12021.)

    +
    +
    +

    multiprocessing

    +

    The new multiprocessing.connection.wait() function allows polling +multiple objects (such as connections, sockets and pipes) with a timeout. +(Contributed by Richard Oudkerk in bpo-12328.)

    +

    multiprocessing.Connection objects can now be transferred over +multiprocessing connections. +(Contributed by Richard Oudkerk in bpo-4892.)

    +

    multiprocessing.Process now accepts a daemon keyword argument +to override the default behavior of inheriting the daemon flag from +the parent process (bpo-6064).

    +

    New attribute multiprocessing.Process.sentinel allows a +program to wait on multiple Process objects at one +time using the appropriate OS primitives (for example, select on +posix systems).

    +

    New methods multiprocessing.pool.Pool.starmap() and +starmap_async() provide +itertools.starmap() equivalents to the existing +multiprocessing.pool.Pool.map() and +map_async() functions. (Contributed by Hynek +Schlawack in bpo-12708.)

    +
    +
    +

    nntplib

    +

    The nntplib.NNTP class now supports the context management protocol to +unconditionally consume socket.error exceptions and to close the NNTP +connection when done:

    +
    >>> from nntplib import NNTP
    +>>> with NNTP('news.gmane.org') as n:
    +...     n.group('gmane.comp.python.committers')
    +...
    +('211 1755 1 1755 gmane.comp.python.committers', 1755, 1, 1755, 'gmane.comp.python.committers')
    +>>>
    +
    +
    +

    (Contributed by Giampaolo Rodolà in bpo-9795.)

    +
    +
    +

    os

    +
      +
    • The os module has a new pipe2() function that makes it +possible to create a pipe with O_CLOEXEC or +O_NONBLOCK flags set atomically. This is especially useful to +avoid race conditions in multi-threaded programs.

    • +
    • The os module has a new sendfile() function which provides +an efficient “zero-copy” way for copying data from one file (or socket) +descriptor to another. The phrase “zero-copy” refers to the fact that all of +the copying of data between the two descriptors is done entirely by the +kernel, with no copying of data into userspace buffers. sendfile() +can be used to efficiently copy data from a file on disk to a network socket, +e.g. for downloading a file.

      +

      (Patch submitted by Ross Lagerwall and Giampaolo Rodolà in bpo-10882.)

      +
    • +
    • To avoid race conditions like symlink attacks and issues with temporary +files and directories, it is more reliable (and also faster) to manipulate +file descriptors instead of file names. Python 3.3 enhances existing functions +and introduces new functions to work on file descriptors (bpo-4761, +bpo-10755 and bpo-14626).

      + +
    • +
    • access() accepts an effective_ids keyword argument to turn on +using the effective uid/gid rather than the real uid/gid in the access check. +Platform support for this can be checked via the +supports_effective_ids set.

    • +
    • The os module has two new functions: getpriority() and +setpriority(). They can be used to get or set process +niceness/priority in a fashion similar to os.nice() but extended to all +processes instead of just the current one.

      +

      (Patch submitted by Giampaolo Rodolà in bpo-10784.)

      +
    • +
    • The new os.replace() function allows cross-platform renaming of a +file with overwriting the destination. With os.rename(), an existing +destination file is overwritten under POSIX, but raises an error under +Windows. +(Contributed by Antoine Pitrou in bpo-8828.)

    • +
    • The stat family of functions (stat(), fstat(), +and lstat()) now support reading a file’s timestamps +with nanosecond precision. Symmetrically, utime() +can now write file timestamps with nanosecond precision. (Contributed by +Larry Hastings in bpo-14127.)

    • +
    • The new os.get_terminal_size() function queries the size of the +terminal attached to a file descriptor. See also +shutil.get_terminal_size(). +(Contributed by Zbigniew Jędrzejewski-Szmek in bpo-13609.)

    • +
    + +
    +
    +

    pdb

    +

    Tab-completion is now available not only for command names, but also their +arguments. For example, for the break command, function and file names +are completed.

    +

    (Contributed by Georg Brandl in bpo-14210)

    +
    +
    +

    pickle

    +

    pickle.Pickler objects now have an optional +dispatch_table attribute allowing per-pickler +reduction functions to be set.

    +

    (Contributed by Richard Oudkerk in bpo-14166.)

    +
    +
    +

    pydoc

    +

    The Tk GUI and the serve() function have been removed from the +pydoc module: pydoc -g and serve() have been deprecated +in Python 3.2.

    +
    +
    +

    re

    +

    str regular expressions now support \u and \U escapes.

    +

    (Contributed by Serhiy Storchaka in bpo-3665.)

    +
    +
    +

    sched

    +
      +
    • run() now accepts a blocking parameter which when +set to false makes the method execute the scheduled events due to expire +soonest (if any) and then return immediately. +This is useful in case you want to use the scheduler in +non-blocking applications. (Contributed by Giampaolo Rodolà in bpo-13449.)

    • +
    • scheduler class can now be safely used in multi-threaded +environments. (Contributed by Josiah Carlson and Giampaolo Rodolà in +bpo-8684.)

    • +
    • timefunc and delayfunct parameters of scheduler class +constructor are now optional and defaults to time.time() and +time.sleep() respectively. (Contributed by Chris Clark in +bpo-13245.)

    • +
    • enter() and enterabs() +argument parameter is now optional. (Contributed by Chris Clark in +bpo-13245.)

    • +
    • enter() and enterabs() +now accept a kwargs parameter. (Contributed by Chris Clark in +bpo-13245.)

    • +
    +
    +
    +

    select

    +

    Solaris and derivative platforms have a new class select.devpoll +for high performance asynchronous sockets via /dev/poll. +(Contributed by Jesús Cea Avión in bpo-6397.)

    +
    +
    +

    shlex

    +

    The previously undocumented helper function quote from the +pipes modules has been moved to the shlex module and +documented. quote() properly escapes all characters in a string +that might be otherwise given special meaning by the shell.

    +
    +
    +

    shutil

    +
      +
    • New functions:

      +
        +
      • disk_usage(): provides total, used and free disk space +statistics. (Contributed by Giampaolo Rodolà in bpo-12442.)

      • +
      • chown(): allows one to change user and/or group of the given +path also specifying the user/group names and not only their numeric +ids. (Contributed by Sandro Tosi in bpo-12191.)

      • +
      • shutil.get_terminal_size(): returns the size of the terminal window +to which the interpreter is attached. (Contributed by Zbigniew +Jędrzejewski-Szmek in bpo-13609.)

      • +
      +
    • +
    • copy2() and copystat() now preserve file +timestamps with nanosecond precision on platforms that support it. +They also preserve file “extended attributes” on Linux. (Contributed +by Larry Hastings in bpo-14127 and bpo-15238.)

    • +
    • Several functions now take an optional symlinks argument: when that +parameter is true, symlinks aren’t dereferenced and the operation instead +acts on the symlink itself (or creates one, if relevant). +(Contributed by Hynek Schlawack in bpo-12715.)

    • +
    • When copying files to a different file system, move() now +handles symlinks the way the posix mv command does, recreating the +symlink rather than copying the target file contents. (Contributed by +Jonathan Niehof in bpo-9993.) move() now also returns +the dst argument as its result.

    • +
    • rmtree() is now resistant to symlink attacks on platforms +which support the new dir_fd parameter in os.open() and +os.unlink(). (Contributed by Martin von Löwis and Hynek Schlawack +in bpo-4489.)

    • +
    +
    +
    +

    signal

    +
      +
    • The signal module has new functions:

      + +
    • +
    • The signal handler writes the signal number as a single byte instead of +a nul byte into the wakeup file descriptor. So it is possible to wait more +than one signal and know which signals were raised.

    • +
    • signal.signal() and signal.siginterrupt() raise an OSError, +instead of a RuntimeError: OSError has an errno attribute.

    • +
    +
    +
    +

    smtpd

    +

    The smtpd module now supports RFC 5321 (extended SMTP) and RFC 1870 +(size extension). Per the standard, these extensions are enabled if and only +if the client initiates the session with an EHLO command.

    +

    (Initial ELHO support by Alberto Trevino. Size extension by Juhana +Jauhiainen. Substantial additional work on the patch contributed by Michele +Orrù and Dan Boswell. bpo-8739)

    +
    +
    +

    smtplib

    +

    The SMTP, SMTP_SSL, and +LMTP classes now accept a source_address keyword argument +to specify the (host, port) to use as the source address in the bind call +when creating the outgoing socket. (Contributed by Paulo Scardine in +bpo-11281.)

    +

    SMTP now supports the context management protocol, allowing an +SMTP instance to be used in a with statement. (Contributed +by Giampaolo Rodolà in bpo-11289.)

    +

    The SMTP_SSL constructor and the starttls() +method now accept an SSLContext parameter to control parameters of the secure +channel. (Contributed by Kasun Herath in bpo-8809.)

    +
    +
    +

    socket

    + +
    +
    +

    socketserver

    +

    BaseServer now has an overridable method +service_actions() that is called by the +serve_forever() method in the service loop. +ForkingMixIn now uses this to clean up zombie +child processes. (Contributed by Justin Warkentin in bpo-11109.)

    +
    +
    +

    sqlite3

    +

    New sqlite3.Connection method +set_trace_callback() can be used to capture a trace of +all sql commands processed by sqlite. (Contributed by Torsten Landschoff +in bpo-11688.)

    +
    +
    +

    ssl

    +
      +
    • The ssl module has two new random generation functions:

      + +

      (Contributed by Victor Stinner in bpo-12049.)

      +
    • +
    • The ssl module now exposes a finer-grained exception hierarchy +in order to make it easier to inspect the various kinds of errors. +(Contributed by Antoine Pitrou in bpo-11183.)

    • +
    • load_cert_chain() now accepts a password argument +to be used if the private key is encrypted. +(Contributed by Adam Simpkins in bpo-12803.)

    • +
    • Diffie-Hellman key exchange, both regular and Elliptic Curve-based, is +now supported through the load_dh_params() and +set_ecdh_curve() methods. +(Contributed by Antoine Pitrou in bpo-13626 and bpo-13627.)

    • +
    • SSL sockets have a new get_channel_binding() method +allowing the implementation of certain authentication mechanisms such as +SCRAM-SHA-1-PLUS. (Contributed by Jacek Konieczny in bpo-12551.)

    • +
    • You can query the SSL compression algorithm used by an SSL socket, thanks +to its new compression() method. The new attribute +OP_NO_COMPRESSION can be used to disable compression. +(Contributed by Antoine Pitrou in bpo-13634.)

    • +
    • Support has been added for the Next Protocol Negotiation extension using +the ssl.SSLContext.set_npn_protocols() method. +(Contributed by Colin Marc in bpo-14204.)

    • +
    • SSL errors can now be introspected more easily thanks to +library and reason attributes. +(Contributed by Antoine Pitrou in bpo-14837.)

    • +
    • The get_server_certificate() function now supports IPv6. +(Contributed by Charles-François Natali in bpo-11811.)

    • +
    • New attribute OP_CIPHER_SERVER_PREFERENCE allows setting +SSLv3 server sockets to use the server’s cipher ordering preference rather +than the client’s (bpo-13635).

    • +
    +
    +
    +

    stat

    +

    The undocumented tarfile.filemode function has been moved to +stat.filemode(). It can be used to convert a file’s mode to a string of +the form ‘-rwxrwxrwx’.

    +

    (Contributed by Giampaolo Rodolà in bpo-14807.)

    +
    +
    +

    struct

    +

    The struct module now supports ssize_t and size_t via the +new codes n and N, respectively. (Contributed by Antoine Pitrou +in bpo-3163.)

    +
    +
    +

    subprocess

    +

    Command strings can now be bytes objects on posix platforms. (Contributed by +Victor Stinner in bpo-8513.)

    +

    A new constant DEVNULL allows suppressing output in a +platform-independent fashion. (Contributed by Ross Lagerwall in +bpo-5870.)

    +
    +
    +

    sys

    +

    The sys module has a new thread_info struct +sequence holding information about the thread implementation +(bpo-11223).

    +
    +
    +

    tarfile

    +

    tarfile now supports lzma encoding via the lzma module. +(Contributed by Lars Gustäbel in bpo-5689.)

    +
    +
    +

    tempfile

    +

    tempfile.SpooledTemporaryFile’s +truncate() method now accepts +a size parameter. (Contributed by Ryan Kelly in bpo-9957.)

    +
    +
    +

    textwrap

    +

    The textwrap module has a new indent() that makes +it straightforward to add a common prefix to selected lines in a block +of text (bpo-13857).

    +
    +
    +

    threading

    +

    threading.Condition, threading.Semaphore, +threading.BoundedSemaphore, threading.Event, and +threading.Timer, all of which used to be factory functions returning a +class instance, are now classes and may be subclassed. (Contributed by Éric +Araujo in bpo-10968.)

    +

    The threading.Thread constructor now accepts a daemon keyword +argument to override the default behavior of inheriting the daemon flag +value from the parent thread (bpo-6064).

    +

    The formerly private function _thread.get_ident is now available as the +public function threading.get_ident(). This eliminates several cases of +direct access to the _thread module in the stdlib. Third party code that +used _thread.get_ident should likewise be changed to use the new public +interface.

    +
    +
    +

    time

    +

    The PEP 418 added new functions to the time module:

    +
      +
    • get_clock_info(): Get information on a clock.

    • +
    • monotonic(): Monotonic clock (cannot go backward), not affected +by system clock updates.

    • +
    • perf_counter(): Performance counter with the highest available +resolution to measure a short duration.

    • +
    • process_time(): Sum of the system and user CPU time of the +current process.

    • +
    +

    Other new functions:

    + +

    To improve cross platform consistency, sleep() now raises a +ValueError when passed a negative sleep value. Previously this was an +error on posix, but produced an infinite sleep on Windows.

    +
    +
    +

    types

    +

    Add a new types.MappingProxyType class: Read-only proxy of a mapping. +(bpo-14386)

    +

    The new functions types.new_class() and types.prepare_class() provide support +for PEP 3115 compliant dynamic type creation. (bpo-14588)

    +
    +
    +

    unittest

    +

    assertRaises(), assertRaisesRegex(), assertWarns(), and +assertWarnsRegex() now accept a keyword argument msg when used as +context managers. (Contributed by Ezio Melotti and Winston Ewert in +bpo-10775.)

    +

    unittest.TestCase.run() now returns the TestResult +object.

    +
    +
    +

    urllib

    +

    The Request class, now accepts a method argument +used by get_method() to determine what HTTP method +should be used. For example, this will send a 'HEAD' request:

    +
    >>> urlopen(Request('https://www.python.org', method='HEAD'))
    +
    +
    +

    (bpo-1673007)

    +
    +
    +

    webbrowser

    +

    The webbrowser module supports more “browsers”: Google Chrome (named +chrome, chromium, chrome-browser or +chromium-browser depending on the version and operating system), +and the generic launchers xdg-open, from the FreeDesktop.org +project, and gvfs-open, which is the default URI handler for GNOME +3. (The former contributed by Arnaud Calmettes in bpo-13620, the latter +by Matthias Klose in bpo-14493.)

    +
    +
    +

    xml.etree.ElementTree

    +

    The xml.etree.ElementTree module now imports its C accelerator by +default; there is no longer a need to explicitly import +xml.etree.cElementTree (this module stays for backwards compatibility, +but is now deprecated). In addition, the iter family of methods of +Element has been optimized (rewritten in C). +The module’s documentation has also been greatly improved with added examples +and a more detailed reference.

    +
    +
    +

    zlib

    +

    New attribute zlib.Decompress.eof makes it possible to distinguish +between a properly-formed compressed stream and an incomplete or truncated one. +(Contributed by Nadeem Vawda in bpo-12646.)

    +

    New attribute zlib.ZLIB_RUNTIME_VERSION reports the version string of +the underlying zlib library that is loaded at runtime. (Contributed by +Torsten Landschoff in bpo-12306.)

    +
    +
    +
    +

    Optimizations

    +

    Major performance enhancements have been added:

    +
      +
    • Thanks to PEP 393, some operations on Unicode strings have been optimized:

      +
        +
      • the memory footprint is divided by 2 to 4 depending on the text

      • +
      • encode an ASCII string to UTF-8 doesn’t need to encode characters anymore, +the UTF-8 representation is shared with the ASCII representation

      • +
      • the UTF-8 encoder has been optimized

      • +
      • repeating a single ASCII letter and getting a substring of an ASCII string +is 4 times faster

      • +
      +
    • +
    • UTF-8 is now 2x to 4x faster. UTF-16 encoding is now up to 10x faster.

      +

      (Contributed by Serhiy Storchaka, bpo-14624, bpo-14738 and +bpo-15026.)

      +
    • +
    +
    + +
    +

    Deprecated

    +
    +

    Unsupported Operating Systems

    +

    OS/2 and VMS are no longer supported due to the lack of a maintainer.

    +

    Windows 2000 and Windows platforms which set COMSPEC to command.com +are no longer supported due to maintenance burden.

    +

    OSF support, which was deprecated in 3.2, has been completely removed.

    +
    +
    +

    Deprecated Python modules, functions and methods

    + +
    +
    +

    Deprecated functions and types of the C API

    +

    The Py_UNICODE has been deprecated by PEP 393 and will be +removed in Python 4. All functions using this type are deprecated:

    +

    Unicode functions and methods using Py_UNICODE and +Py_UNICODE* types:

    + +

    Functions and macros manipulating Py_UNICODE* strings:

    + +

    Encoders:

    + +
    +
    +

    Deprecated features

    +

    The array module’s 'u' format code is now deprecated and will be +removed in Python 4 together with the rest of the (Py_UNICODE) API.

    +
    +
    +
    +

    Porting to Python 3.3

    +

    This section lists previously described changes and other bugfixes +that may require changes to your code.

    +
    +

    Porting Python code

    +
      +
    • Hash randomization is enabled by default. Set the PYTHONHASHSEED +environment variable to 0 to disable hash randomization. See also the +object.__hash__() method.

    • +
    • bpo-12326: On Linux, sys.platform doesn’t contain the major version +anymore. It is now always ‘linux’, instead of ‘linux2’ or ‘linux3’ depending +on the Linux version used to build Python. Replace sys.platform == ‘linux2’ +with sys.platform.startswith(‘linux’), or directly sys.platform == ‘linux’ if +you don’t need to support older Python versions.

    • +
    • bpo-13847, bpo-14180: time and datetime: +OverflowError is now raised instead of ValueError if a +timestamp is out of range. OSError is now raised if C functions +gmtime() or localtime() failed.

    • +
    • The default finders used by import now utilize a cache of what is contained +within a specific directory. If you create a Python source file or sourceless +bytecode file, make sure to call importlib.invalidate_caches() to clear +out the cache for the finders to notice the new file.

    • +
    • ImportError now uses the full name of the module that was attempted to +be imported. Doctests that check ImportErrors’ message will need to be +updated to use the full name of the module instead of just the tail of the +name.

    • +
    • The index argument to __import__() now defaults to 0 instead of -1 +and no longer support negative values. It was an oversight when PEP 328 was +implemented that the default value remained -1. If you need to continue to +perform a relative import followed by an absolute import, then perform the +relative import using an index of 1, followed by another import using an +index of 0. It is preferred, though, that you use +importlib.import_module() rather than call __import__() directly.

    • +
    • __import__() no longer allows one to use an index value other than 0 +for top-level modules. E.g. __import__('sys', level=1) is now an error.

    • +
    • Because sys.meta_path and sys.path_hooks now have finders on +them by default, you will most likely want to use list.insert() instead +of list.append() to add to those lists.

    • +
    • Because None is now inserted into sys.path_importer_cache, if you +are clearing out entries in the dictionary of paths that do not have a +finder, you will need to remove keys paired with values of None and +imp.NullImporter to be backwards-compatible. This will lead to extra +overhead on older versions of Python that re-insert None into +sys.path_importer_cache where it represents the use of implicit +finders, but semantically it should not change anything.

    • +
    • importlib.abc.Finder no longer specifies a find_module() abstract +method that must be implemented. If you were relying on subclasses to +implement that method, make sure to check for the method’s existence first. +You will probably want to check for find_loader() first, though, in the +case of working with path entry finders.

    • +
    • pkgutil has been converted to use importlib internally. This +eliminates many edge cases where the old behaviour of the PEP 302 import +emulation failed to match the behaviour of the real import system. The +import emulation itself is still present, but is now deprecated. The +pkgutil.iter_importers() and pkgutil.walk_packages() functions +special case the standard import hooks so they are still supported even +though they do not provide the non-standard iter_modules() method.

    • +
    • A longstanding RFC-compliance bug (bpo-1079) in the parsing done by +email.header.decode_header() has been fixed. Code that uses the +standard idiom to convert encoded headers into unicode +(str(make_header(decode_header(h))) will see no change, but code that +looks at the individual tuples returned by decode_header will see that +whitespace that precedes or follows ASCII sections is now included in the +ASCII section. Code that builds headers using make_header should +also continue to work without change, since make_header continues to add +whitespace between ASCII and non-ASCII sections if it is not already +present in the input strings.

    • +
    • email.utils.formataddr() now does the correct content transfer +encoding when passed non-ASCII display names. Any code that depended on +the previous buggy behavior that preserved the non-ASCII unicode in the +formatted output string will need to be changed (bpo-1690608).

    • +
    • poplib.POP3.quit() may now raise protocol errors like all other +poplib methods. Code that assumes quit does not raise +poplib.error_proto errors may need to be changed if errors on quit +are encountered by a particular application (bpo-11291).

    • +
    • The strict argument to email.parser.Parser, deprecated since +Python 2.4, has finally been removed.

    • +
    • The deprecated method unittest.TestCase.assertSameElements has been +removed.

    • +
    • The deprecated variable time.accept2dyear has been removed.

    • +
    • The deprecated Context._clamp attribute has been removed from the +decimal module. It was previously replaced by the public attribute +clamp. (See bpo-8540.)

    • +
    • The undocumented internal helper class SSLFakeFile has been removed +from smtplib, since its functionality has long been provided directly +by socket.socket.makefile().

    • +
    • Passing a negative value to time.sleep() on Windows now raises an +error instead of sleeping forever. It has always raised an error on posix.

    • +
    • The ast.__version__ constant has been removed. If you need to +make decisions affected by the AST version, use sys.version_info +to make the decision.

    • +
    • Code that used to work around the fact that the threading module used +factory functions by subclassing the private classes will need to change to +subclass the now-public classes.

    • +
    • The undocumented debugging machinery in the threading module has been +removed, simplifying the code. This should have no effect on production +code, but is mentioned here in case any application debug frameworks were +interacting with it (bpo-13550).

    • +
    +
    +
    +

    Porting C code

    +
      +
    • In the course of changes to the buffer API the undocumented +smalltable member of the +Py_buffer structure has been removed and the +layout of the PyMemoryViewObject has changed.

      +

      All extensions relying on the relevant parts in memoryobject.h +or object.h must be rebuilt.

      +
    • +
    • Due to PEP 393, the Py_UNICODE type and all +functions using this type are deprecated (but will stay available for +at least five years). If you were using low-level Unicode APIs to +construct and access unicode objects and you want to benefit of the +memory footprint reduction provided by PEP 393, you have to convert +your code to the new Unicode API.

      +

      However, if you only have been using high-level functions such as +PyUnicode_Concat(), PyUnicode_Join() or +PyUnicode_FromFormat(), your code will automatically take +advantage of the new unicode representations.

      +
    • +
    • PyImport_GetMagicNumber() now returns -1 upon failure.

    • +
    • As a negative value for the level argument to __import__() is no +longer valid, the same now holds for PyImport_ImportModuleLevel(). +This also means that the value of level used by +PyImport_ImportModuleEx() is now 0 instead of -1.

    • +
    +
    +
    +

    Building C extensions

    +
      +
    • The range of possible file names for C extensions has been narrowed. +Very rarely used spellings have been suppressed: under POSIX, files +named xxxmodule.so, xxxmodule.abi3.so and +xxxmodule.cpython-*.so are no longer recognized as implementing +the xxx module. If you had been generating such files, you have +to switch to the other spellings (i.e., remove the module string +from the file names).

      +

      (implemented in bpo-14040.)

      +
    • +
    +
    +
    +

    Command Line Switch Changes

    +
      +
    • The -Q command-line flag and related artifacts have been removed. Code +checking sys.flags.division_warning will need updating.

      +

      (bpo-10998, contributed by Éric Araujo.)

      +
    • +
    • When python is started with -S, import site +will no longer add site-specific paths to the module search paths. In +previous versions, it did.

      +

      (bpo-11591, contributed by Carl Meyer with editions by Éric Araujo.)

      +
    • +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/whatsnew/3.4.html b/python-3.7.4-docs-html/whatsnew/3.4.html new file mode 100644 index 0000000..2a129ac --- /dev/null +++ b/python-3.7.4-docs-html/whatsnew/3.4.html @@ -0,0 +1,2332 @@ + + + + + + + What’s New In Python 3.4 — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    What’s New In Python 3.4

    +
    +
    Author
    +

    R. David Murray <rdmurray@bitdance.com> (Editor)

    +
    +
    +

    This article explains the new features in Python 3.4, compared to 3.3. +Python 3.4 was released on March 16, 2014. For full details, see the +changelog.

    +
    +

    See also

    +

    PEP 429 – Python 3.4 Release Schedule

    +
    +
    +

    Summary – Release Highlights

    +

    New syntax features:

    +
      +
    • No new syntax features were added in Python 3.4.

    • +
    +

    Other new features:

    + +

    New library modules:

    + +

    Significantly improved library modules:

    + +

    Security improvements:

    + +

    CPython implementation improvements:

    + +

    Please read on for a comprehensive list of user-facing changes, including many +other smaller improvements, CPython optimizations, deprecations, and potential +porting issues.

    +
    +
    +

    New Features

    +
    +

    PEP 453: Explicit Bootstrapping of PIP in Python Installations

    +
    +

    Bootstrapping pip By Default

    +

    The new ensurepip module (defined in PEP 453) provides a standard +cross-platform mechanism to bootstrap the pip installer into Python +installations and virtual environments. The version of pip included +with Python 3.4.0 is pip 1.5.4, and future 3.4.x maintenance releases +will update the bundled version to the latest version of pip that is +available at the time of creating the release candidate.

    +

    By default, the commands pipX and pipX.Y will be installed on all +platforms (where X.Y stands for the version of the Python installation), +along with the pip Python package and its dependencies. On Windows and +in virtual environments on all platforms, the unversioned pip command +will also be installed. On other platforms, the system wide unversioned +pip command typically refers to the separately installed Python 2 +version.

    +

    The pyvenv command line utility and the venv +module make use of the ensurepip module to make pip readily +available in virtual environments. When using the command line utility, +pip is installed by default, while when using the venv module +API installation of pip must be requested explicitly.

    +

    For CPython source builds on POSIX systems, +the make install and make altinstall commands bootstrap pip by +default. This behaviour can be controlled through configure options, and +overridden through Makefile options.

    +

    On Windows and Mac OS X, the CPython installers now default to installing +pip along with CPython itself (users may opt out of installing it +during the installation process). Window users will need to opt in to the +automatic PATH modifications to have pip available from the command +line by default, otherwise it can still be accessed through the Python +launcher for Windows as py -m pip.

    +

    As discussed in the PEP, platform packagers may choose not to install +these commands by default, as long as, when invoked, they provide clear and +simple directions on how to install them on that platform (usually using +the system package manager).

    +
    +

    Note

    +

    To avoid conflicts between parallel Python 2 and Python 3 installations, +only the versioned pip3 and pip3.4 commands are bootstrapped by +default when ensurepip is invoked directly - the --default-pip +option is needed to also request the unversioned pip command. +pyvenv and the Windows installer ensure that the unqualified pip +command is made available in those environments, and pip can always be +invoked via the -m switch rather than directly to avoid ambiguity on +systems with multiple Python installations.

    +
    +
    +
    +

    Documentation Changes

    +

    As part of this change, the Installing Python Modules and +Distributing Python Modules sections of the documentation have been +completely redesigned as short getting started and FAQ documents. Most +packaging documentation has now been moved out to the Python Packaging +Authority maintained Python Packaging User Guide and the documentation of the individual +projects.

    +

    However, as this migration is currently still incomplete, the legacy +versions of those guides remaining available as Installing Python Modules (Legacy version) +and Distributing Python Modules (Legacy version).

    +
    +

    See also

    +
    +
    PEP 453 – Explicit bootstrapping of pip in Python installations

    PEP written by Donald Stufft and Nick Coghlan, implemented by +Donald Stufft, Nick Coghlan, Martin von Löwis and Ned Deily.

    +
    +
    +
    +
    +
    +
    +

    PEP 446: Newly Created File Descriptors Are Non-Inheritable

    +

    PEP 446 makes newly created file descriptors non-inheritable. In general, this is the behavior an application will +want: when launching a new process, having currently open files also +open in the new process can lead to all sorts of hard to find bugs, +and potentially to security issues.

    +

    However, there are occasions when inheritance is desired. To support +these cases, the following new functions and methods are available:

    + +
    +

    See also

    +
    +
    PEP 446 – Make newly created file descriptors non-inheritable

    PEP written and implemented by Victor Stinner.

    +
    +
    +
    +
    +
    +

    Improvements to Codec Handling

    +

    Since it was first introduced, the codecs module has always been +intended to operate as a type-neutral dynamic encoding and decoding +system. However, its close coupling with the Python text model, especially +the type restricted convenience methods on the builtin str, +bytes and bytearray types, has historically obscured that +fact.

    +

    As a key step in clarifying the situation, the codecs.encode() and +codecs.decode() convenience functions are now properly documented in +Python 2.7, 3.3 and 3.4. These functions have existed in the codecs +module (and have been covered by the regression test suite) since Python 2.4, +but were previously only discoverable through runtime introspection.

    +

    Unlike the convenience methods on str, bytes and +bytearray, the codecs convenience functions support arbitrary +codecs in both Python 2 and Python 3, rather than being limited to Unicode text +encodings (in Python 3) or basestring <-> basestring conversions (in +Python 2).

    +

    In Python 3.4, the interpreter is able to identify the known non-text +encodings provided in the standard library and direct users towards these +general purpose convenience functions when appropriate:

    +
    >>> b"abcdef".decode("hex")
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +LookupError: 'hex' is not a text encoding; use codecs.decode() to handle arbitrary codecs
    +
    +>>> "hello".encode("rot13")
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +LookupError: 'rot13' is not a text encoding; use codecs.encode() to handle arbitrary codecs
    +
    +>>> open("foo.txt", encoding="hex")
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +LookupError: 'hex' is not a text encoding; use codecs.open() to handle arbitrary codecs
    +
    +
    +

    In a related change, whenever it is feasible without breaking backwards +compatibility, exceptions raised during encoding and decoding operations +are wrapped in a chained exception of the same type that mentions the +name of the codec responsible for producing the error:

    +
    >>> import codecs
    +
    +>>> codecs.decode(b"abcdefgh", "hex")
    +Traceback (most recent call last):
    +  File "/usr/lib/python3.4/encodings/hex_codec.py", line 20, in hex_decode
    +    return (binascii.a2b_hex(input), len(input))
    +binascii.Error: Non-hexadecimal digit found
    +
    +The above exception was the direct cause of the following exception:
    +
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +binascii.Error: decoding with 'hex' codec failed (Error: Non-hexadecimal digit found)
    +
    +>>> codecs.encode("hello", "bz2")
    +Traceback (most recent call last):
    +  File "/usr/lib/python3.4/encodings/bz2_codec.py", line 17, in bz2_encode
    +    return (bz2.compress(input), len(input))
    +  File "/usr/lib/python3.4/bz2.py", line 498, in compress
    +    return comp.compress(data) + comp.flush()
    +TypeError: 'str' does not support the buffer interface
    +
    +The above exception was the direct cause of the following exception:
    +
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +TypeError: encoding with 'bz2' codec failed (TypeError: 'str' does not support the buffer interface)
    +
    +
    +

    Finally, as the examples above show, these improvements have permitted +the restoration of the convenience aliases for the non-Unicode codecs that +were themselves restored in Python 3.2. This means that encoding binary data +to and from its hexadecimal representation (for example) can now be written +as:

    +
    >>> from codecs import encode, decode
    +>>> encode(b"hello", "hex")
    +b'68656c6c6f'
    +>>> decode(b"68656c6c6f", "hex")
    +b'hello'
    +
    +
    +

    The binary and text transforms provided in the standard library are detailed +in Binary Transforms and Text Transforms.

    +

    (Contributed by Nick Coghlan in bpo-7475, bpo-17827, +bpo-17828 and bpo-19619.)

    +
    +
    +

    PEP 451: A ModuleSpec Type for the Import System

    +

    PEP 451 provides an encapsulation of the information about a module that the +import machinery will use to load it (that is, a module specification). This +helps simplify both the import implementation and several import-related APIs. +The change is also a stepping stone for several future import-related +improvements.

    +

    The public-facing changes from the PEP are entirely backward-compatible. +Furthermore, they should be transparent to everyone but importer authors. Key +finder and loader methods have been deprecated, but they will continue working. +New importers should use the new methods described in the PEP. Existing +importers should be updated to implement the new methods. See the +Deprecated section for a list of methods that should be replaced and +their replacements.

    +
    +
    +

    Other Language Changes

    +

    Some smaller changes made to the core Python language are:

    +
      +
    • Unicode database updated to UCD version 6.3.

    • +
    • min() and max() now accept a default keyword-only argument that +can be used to specify the value they return if the iterable they are +evaluating has no elements. (Contributed by Julian Berman in +bpo-18111.)

    • +
    • Module objects are now weakref’able.

    • +
    • Module __file__ attributes (and related values) should now always +contain absolute paths by default, with the sole exception of +__main__.__file__ when a script has been executed directly using +a relative path. (Contributed by Brett Cannon in bpo-18416.)

    • +
    • All the UTF-* codecs (except UTF-7) now reject surrogates during both +encoding and decoding unless the surrogatepass error handler is used, +with the exception of the UTF-16 decoder (which accepts valid surrogate pairs) +and the UTF-16 encoder (which produces them while encoding non-BMP characters). +(Contributed by Victor Stinner, Kang-Hao (Kenny) Lu and Serhiy Storchaka in +bpo-12892.)

    • +
    • New German EBCDIC codec cp273. (Contributed +by Michael Bierenfeld and Andrew Kuchling in bpo-1097797.)

    • +
    • New Ukrainian codec cp1125. (Contributed by +Serhiy Storchaka in bpo-19668.)

    • +
    • bytes.join() and bytearray.join() now accept arbitrary +buffer objects as arguments. (Contributed by Antoine Pitrou in +bpo-15958.)

    • +
    • The int constructor now accepts any object that has an __index__ +method for its base argument. (Contributed by Mark Dickinson in +bpo-16772.)

    • +
    • Frame objects now have a clear() method that clears all +references to local variables from the frame. (Contributed by Antoine Pitrou +in bpo-17934.)

    • +
    • memoryview is now registered as a Sequence, +and supports the reversed() builtin. (Contributed by Nick Coghlan +and Claudiu Popa in bpo-18690 and bpo-19078.)

    • +
    • Signatures reported by help() have been modified and improved in +several cases as a result of the introduction of Argument Clinic and other +changes to the inspect and pydoc modules.

    • +
    • __length_hint__() is now part of the formal language +specification (see PEP 424). (Contributed by Armin Ronacher in +bpo-16148.)

    • +
    +
    +
    +
    +

    New Modules

    +
    +

    asyncio

    +

    The new asyncio module (defined in PEP 3156) provides a standard +pluggable event loop model for Python, providing solid asynchronous IO +support in the standard library, and making it easier for other event loop +implementations to interoperate with the standard library and each other.

    +

    For Python 3.4, this module is considered a provisional API.

    +
    +

    See also

    +
    +
    PEP 3156 – Asynchronous IO Support Rebooted: the “asyncio” Module

    PEP written and implementation led by Guido van Rossum.

    +
    +
    +
    +
    +
    +

    ensurepip

    +

    The new ensurepip module is the primary infrastructure for the +PEP 453 implementation. In the normal course of events end users will not +need to interact with this module, but it can be used to manually bootstrap +pip if the automated bootstrapping into an installation or virtual +environment was declined.

    +

    ensurepip includes a bundled copy of pip, up-to-date as of the first +release candidate of the release of CPython with which it ships (this applies +to both maintenance releases and feature releases). ensurepip does not +access the internet. If the installation has Internet access, after +ensurepip is run the bundled pip can be used to upgrade pip to a +more recent release than the bundled one. (Note that such an upgraded version +of pip is considered to be a separately installed package and will not be +removed if Python is uninstalled.)

    +

    The module is named ensurepip because if called when pip is already +installed, it does nothing. It also has an --upgrade option that will +cause it to install the bundled copy of pip if the existing installed +version of pip is older than the bundled copy.

    +
    +
    +

    enum

    +

    The new enum module (defined in PEP 435) provides a standard +implementation of enumeration types, allowing other modules (such as +socket) to provide more informative error messages and better +debugging support by replacing opaque integer constants with backwards +compatible enumeration values.

    +
    +

    See also

    +
    +
    PEP 435 – Adding an Enum type to the Python standard library

    PEP written by Barry Warsaw, Eli Bendersky and Ethan Furman, +implemented by Ethan Furman.

    +
    +
    +
    +
    +
    +

    pathlib

    +

    The new pathlib module offers classes representing filesystem paths +with semantics appropriate for different operating systems. Path classes are +divided between pure paths, which provide purely computational operations +without I/O, and concrete paths, which inherit from pure paths but also +provide I/O operations.

    +

    For Python 3.4, this module is considered a provisional API.

    +
    +

    See also

    +
    +
    PEP 428 – The pathlib module – object-oriented filesystem paths

    PEP written and implemented by Antoine Pitrou.

    +
    +
    +
    +
    +
    +

    selectors

    +

    The new selectors module (created as part of implementing PEP 3156) +allows high-level and efficient I/O multiplexing, built upon the +select module primitives.

    +
    +
    +

    statistics

    +

    The new statistics module (defined in PEP 450) offers some core +statistics functionality directly in the standard library. This module +supports calculation of the mean, median, mode, variance and standard +deviation of a data series.

    +
    +

    See also

    +
    +
    PEP 450 – Adding A Statistics Module To The Standard Library

    PEP written and implemented by Steven D’Aprano

    +
    +
    +
    +
    +
    +

    tracemalloc

    +

    The new tracemalloc module (defined in PEP 454) is a debug tool to +trace memory blocks allocated by Python. It provides the following information:

    +
      +
    • Trace where an object was allocated

    • +
    • Statistics on allocated memory blocks per filename and per line number: +total size, number and average size of allocated memory blocks

    • +
    • Compute the differences between two snapshots to detect memory leaks

    • +
    +
    +

    See also

    +
    +
    PEP 454 – Add a new tracemalloc module to trace Python memory allocations

    PEP written and implemented by Victor Stinner

    +
    +
    +
    +
    +
    +
    +

    Improved Modules

    +
    +

    abc

    +

    New function abc.get_cache_token() can be used to know when to invalidate +caches that are affected by changes in the object graph. (Contributed +by Łukasz Langa in bpo-16832.)

    +

    New class ABC has ABCMeta as its meta class. +Using ABC as a base class has essentially the same effect as specifying +metaclass=abc.ABCMeta, but is simpler to type and easier to read. +(Contributed by Bruno Dupuis in bpo-16049.)

    +
    +
    +

    aifc

    +

    The getparams() method now returns a namedtuple rather than a +plain tuple. (Contributed by Claudiu Popa in bpo-17818.)

    +

    aifc.open() now supports the context management protocol: when used in a +with block, the close() method of the returned +object will be called automatically at the end of the block. (Contributed by +Serhiy Storchacha in bpo-16486.)

    +

    The writeframesraw() and writeframes() +methods now accept any bytes-like object. (Contributed by Serhiy +Storchaka in bpo-8311.)

    +
    +
    +

    argparse

    +

    The FileType class now accepts encoding and +errors arguments, which are passed through to open(). (Contributed +by Lucas Maystre in bpo-11175.)

    +
    +
    +

    audioop

    +

    audioop now supports 24-bit samples. (Contributed by Serhiy Storchaka +in bpo-12866.)

    +

    New byteswap() function converts big-endian samples to +little-endian and vice versa. (Contributed by Serhiy Storchaka in +bpo-19641.)

    +

    All audioop functions now accept any bytes-like object. Strings +are not accepted: they didn’t work before, now they raise an error right away. +(Contributed by Serhiy Storchaka in bpo-16685.)

    +
    +
    +

    base64

    +

    The encoding and decoding functions in base64 now accept any +bytes-like object in cases where it previously required a +bytes or bytearray instance. (Contributed by Nick Coghlan in +bpo-17839.)

    +

    New functions a85encode(), a85decode(), +b85encode(), and b85decode() provide the ability to +encode and decode binary data from and to Ascii85 and the git/mercurial +Base85 formats, respectively. The a85 functions have options that can +be used to make them compatible with the variants of the Ascii85 encoding, +including the Adobe variant. (Contributed by Martin Morrison, the Mercurial +project, Serhiy Storchaka, and Antoine Pitrou in bpo-17618.)

    +
    +
    +

    collections

    +

    The ChainMap.new_child() method now accepts an m argument specifying +the child map to add to the chain. This allows an existing mapping and/or a +custom mapping type to be used for the child. (Contributed by Vinay Sajip in +bpo-16613.)

    +
    +
    +

    colorsys

    +

    The number of digits in the coefficients for the RGB — YIQ conversions have +been expanded so that they match the FCC NTSC versions. The change in +results should be less than 1% and may better match results found elsewhere. +(Contributed by Brian Landers and Serhiy Storchaka in bpo-14323.)

    +
    +
    +

    contextlib

    +

    The new contextlib.suppress context manager helps to clarify the +intent of code that deliberately suppresses exceptions from a single +statement. (Contributed by Raymond Hettinger in bpo-15806 and +Zero Piraeus in bpo-19266.)

    +

    The new contextlib.redirect_stdout() context manager makes it easier +for utility scripts to handle inflexible APIs that write their output to +sys.stdout and don’t provide any options to redirect it. Using the +context manager, the sys.stdout output can be redirected to any +other stream or, in conjunction with io.StringIO, to a string. +The latter can be especially useful, for example, to capture output +from a function that was written to implement a command line interface. +It is recommended only for utility scripts because it affects the +global state of sys.stdout. (Contributed by Raymond Hettinger +in bpo-15805.)

    +

    The contextlib documentation has also been updated to include a +discussion of the +differences between single use, reusable and reentrant context managers.

    +
    +
    +

    dbm

    +

    dbm.open() objects now support the context management protocol. When +used in a with statement, the close method of the database +object will be called automatically at the end of the block. (Contributed by +Claudiu Popa and Nick Coghlan in bpo-19282.)

    +
    +
    +

    dis

    +

    Functions show_code(), dis(), distb(), and +disassemble() now accept a keyword-only file argument that +controls where they write their output.

    +

    The dis module is now built around an Instruction class +that provides object oriented access to the details of each individual bytecode +operation.

    +

    A new method, get_instructions(), provides an iterator that emits +the Instruction stream for a given piece of Python code. Thus it is now +possible to write a program that inspects and manipulates a bytecode +object in ways different from those provided by the dis module +itself. For example:

    +
    >>> import dis
    +>>> for instr in dis.get_instructions(lambda x: x + 1):
    +...     print(instr.opname)
    +LOAD_FAST
    +LOAD_CONST
    +BINARY_ADD
    +RETURN_VALUE
    +
    +
    +

    The various display tools in the dis module have been rewritten to use +these new components.

    +

    In addition, a new application-friendly class Bytecode provides +an object-oriented API for inspecting bytecode in both in human-readable form +and for iterating over instructions. The Bytecode constructor +takes the same arguments that get_instruction() does (plus an +optional current_offset), and the resulting object can be iterated to produce +Instruction objects. But it also has a dis +method, equivalent to calling dis on the constructor argument, but +returned as a multi-line string:

    +
    >>> bytecode = dis.Bytecode(lambda x: x + 1, current_offset=3)
    +>>> for instr in bytecode:
    +...     print('{} ({})'.format(instr.opname, instr.opcode))
    +LOAD_FAST (124)
    +LOAD_CONST (100)
    +BINARY_ADD (23)
    +RETURN_VALUE (83)
    +>>> bytecode.dis().splitlines()       
    +['  1           0 LOAD_FAST                0 (x)',
    + '      -->     3 LOAD_CONST               1 (1)',
    + '              6 BINARY_ADD',
    + '              7 RETURN_VALUE']
    +
    +
    +

    Bytecode also has a class method, +from_traceback(), that provides the ability to manipulate a +traceback (that is, print(Bytecode.from_traceback(tb).dis()) is equivalent +to distb(tb)).

    +

    (Contributed by Nick Coghlan, Ryan Kelly and Thomas Kluyver in bpo-11816 +and Claudiu Popa in bpo-17916.)

    +

    New function stack_effect() computes the effect on the Python stack +of a given opcode and argument, information that is not otherwise available. +(Contributed by Larry Hastings in bpo-19722.)

    +
    +
    +

    doctest

    +

    A new option flag, FAIL_FAST, halts +test running as soon as the first failure is detected. (Contributed by R. +David Murray and Daniel Urban in bpo-16522.)

    +

    The doctest command line interface now uses argparse, and has two +new options, -o and -f. -o allows doctest options to be specified on the command line, and -f is a +shorthand for -o FAIL_FAST (to parallel the similar option supported by the +unittest CLI). (Contributed by R. David Murray in bpo-11390.)

    +

    doctest will now find doctests in extension module __doc__ strings. +(Contributed by Zachary Ware in bpo-3158.)

    +
    +
    +

    email

    +

    as_string() now accepts a policy argument to +override the default policy of the message when generating a string +representation of it. This means that as_string can now be used in more +circumstances, instead of having to create and use a generator in +order to pass formatting parameters to its flatten method. (Contributed by +R. David Murray in bpo-18600.)

    +

    New method as_bytes() added to produce a bytes +representation of the message in a fashion similar to how as_string +produces a string representation. It does not accept the maxheaderlen +argument, but does accept the unixfrom and policy arguments. The +Message __bytes__() method +calls it, meaning that bytes(mymsg) will now produce the intuitive +result: a bytes object containing the fully formatted message. (Contributed +by R. David Murray in bpo-18600.)

    +

    The Message.set_param() message now accepts a replace keyword argument. +When specified, the associated header will be updated without changing +its location in the list of headers. For backward compatibility, the default +is False. (Contributed by R. David Murray in bpo-18891.)

    +

    A pair of new subclasses of Message have been added +(EmailMessage and MIMEPart), along with a new sub-module, +contentmanager and a new policy attribute +content_manager. All documentation is +currently in the new module, which is being added as part of email’s new +provisional API. These classes provide a number of new methods that +make extracting content from and inserting content into email messages much +easier. For details, see the contentmanager documentation and +the email: Examples. These API additions complete the +bulk of the work that was planned as part of the email6 project. The currently +provisional API is scheduled to become final in Python 3.5 (possibly with a few +minor additions in the area of error handling). (Contributed by R. David +Murray in bpo-18891.)

    +
    +
    +

    filecmp

    +

    A new clear_cache() function provides the ability to clear the +filecmp comparison cache, which uses os.stat() information to +determine if the file has changed since the last compare. This can be used, +for example, if the file might have been changed and re-checked in less time +than the resolution of a particular filesystem’s file modification time field. +(Contributed by Mark Levitt in bpo-18149.)

    +

    New module attribute DEFAULT_IGNORES provides the list of +directories that are used as the default value for the ignore parameter of +the dircmp() function. (Contributed by Eli Bendersky in +bpo-15442.)

    +
    +
    +

    functools

    +

    The new partialmethod() descriptor brings partial argument +application to descriptors, just as partial() provides +for normal callables. The new descriptor also makes it easier to get +arbitrary callables (including partial() instances) +to behave like normal instance methods when included in a class definition. +(Contributed by Alon Horev and Nick Coghlan in bpo-4331.)

    +

    The new singledispatch() decorator brings support for +single-dispatch generic functions to the Python standard library. Where +object oriented programming focuses on grouping multiple operations on a +common set of data into a class, a generic function focuses on grouping +multiple implementations of an operation that allows it to work with +different kinds of data.

    +
    +

    See also

    +
    +
    PEP 443 – Single-dispatch generic functions

    PEP written and implemented by Łukasz Langa.

    +
    +
    +
    +

    total_ordering() now supports a return value of +NotImplemented from the underlying comparison function. (Contributed +by Katie Miller in bpo-10042.)

    +

    A pure-python version of the partial() function is now in the +stdlib; in CPython it is overridden by the C accelerated version, but it is +available for other implementations to use. (Contributed by Brian Thorne in +bpo-12428.)

    +
    +
    +

    gc

    +

    New function get_stats() returns a list of three per-generation +dictionaries containing the collections statistics since interpreter startup. +(Contributed by Antoine Pitrou in bpo-16351.)

    +
    +
    +

    glob

    +

    A new function escape() provides a way to escape special characters +in a filename so that they do not become part of the globbing expansion but are +instead matched literally. (Contributed by Serhiy Storchaka in bpo-8402.)

    +
    +
    +

    hashlib

    +

    A new hashlib.pbkdf2_hmac() function provides +the PKCS#5 password-based key derivation function 2. (Contributed by Christian +Heimes in bpo-18582.)

    +

    The name attribute of hashlib hash objects is now +a formally supported interface. It has always existed in CPython’s +hashlib (although it did not return lower case names for all supported +hashes), but it was not a public interface and so some other Python +implementations have not previously supported it. (Contributed by Jason R. +Coombs in bpo-18532.)

    +
    +
    +

    hmac

    +

    hmac now accepts bytearray as well as bytes for the key +argument to the new() function, and the msg parameter to both the +new() function and the update() method now +accepts any type supported by the hashlib module. (Contributed +by Jonas Borgström in bpo-18240.)

    +

    The digestmod argument to the hmac.new() function may now be any hash +digest name recognized by hashlib. In addition, the current behavior in +which the value of digestmod defaults to MD5 is deprecated: in a +future version of Python there will be no default value. (Contributed by +Christian Heimes in bpo-17276.)

    +

    With the addition of block_size and name +attributes (and the formal documentation of the digest_size +attribute), the hmac module now conforms fully to the PEP 247 API. +(Contributed by Christian Heimes in bpo-18775.)

    +
    +
    +

    html

    +

    New function unescape() function converts HTML5 character references to +the corresponding Unicode characters. (Contributed by Ezio Melotti in +bpo-2927.)

    +

    HTMLParser accepts a new keyword argument +convert_charrefs that, when True, automatically converts all character +references. For backward-compatibility, its value defaults to False, but +it will change to True in a future version of Python, so you are invited to +set it explicitly and update your code to use this new feature. (Contributed +by Ezio Melotti in bpo-13633.)

    +

    The strict argument of HTMLParser is now deprecated. +(Contributed by Ezio Melotti in bpo-15114.)

    +
    +
    +

    http

    +

    send_error() now accepts an +optional additional explain parameter which can be used to provide an +extended error description, overriding the hardcoded default if there is one. +This extended error description will be formatted using the +error_message_format attribute and sent as the body +of the error response. (Contributed by Karl Cow in bpo-12921.)

    +

    The http.server command line interface now has +a -b/--bind option that causes the server to listen on a specific address. +(Contributed by Malte Swart in bpo-17764.)

    +
    +
    +

    idlelib and IDLE

    +

    Since idlelib implements the IDLE shell and editor and is not intended for +import by other programs, it gets improvements with every release. See +Lib/idlelib/NEWS.txt for a cumulative list of changes since 3.3.0, +as well as changes made in future 3.4.x releases. This file is also available +from the IDLE Help ‣ About IDLE dialog.

    +
    +
    +

    importlib

    +

    The InspectLoader ABC defines a new method, +source_to_code() that accepts source +data and a path and returns a code object. The default implementation +is equivalent to compile(data, path, 'exec', dont_inherit=True). +(Contributed by Eric Snow and Brett Cannon in bpo-15627.)

    +

    InspectLoader also now has a default implementation +for the get_code() method. However, +it will normally be desirable to override the default implementation +for performance reasons. (Contributed by Brett Cannon in bpo-18072.)

    +

    The reload() function has been moved from imp to +importlib as part of the imp module deprecation. (Contributed by +Berker Peksag in bpo-18193.)

    +

    importlib.util now has a MAGIC_NUMBER attribute +providing access to the bytecode version number. This replaces the +get_magic() function in the deprecated imp module. +(Contributed by Brett Cannon in bpo-18192.)

    +

    New importlib.util functions cache_from_source() +and source_from_cache() replace the same-named functions +in the deprecated imp module. (Contributed by Brett Cannon in +bpo-18194.)

    +

    The importlib bootstrap NamespaceLoader now conforms to +the InspectLoader ABC, which means that runpy and +python -m can now be used with namespace packages. (Contributed +by Brett Cannon in bpo-18058.)

    +

    importlib.util has a new function decode_source() +that decodes source from bytes using universal newline processing. This is +useful for implementing InspectLoader.get_source() methods.

    +

    importlib.machinery.ExtensionFileLoader now has a +get_filename() method. This was +inadvertently omitted in the original implementation. (Contributed by Eric +Snow in bpo-19152.)

    +
    +
    +

    inspect

    +

    The inspect module now offers a basic command line interface to quickly display source code and other +information for modules, classes and functions. (Contributed by Claudiu Popa +and Nick Coghlan in bpo-18626.)

    +

    unwrap() makes it easy to unravel wrapper function chains +created by functools.wraps() (and any other API that sets the +__wrapped__ attribute on a wrapper function). (Contributed by +Daniel Urban, Aaron Iles and Nick Coghlan in bpo-13266.)

    +

    As part of the implementation of the new enum module, the +inspect module now has substantially better support for custom +__dir__ methods and dynamic class attributes provided through +metaclasses. (Contributed by Ethan Furman in bpo-18929 and +bpo-19030.)

    +

    getfullargspec() and getargspec() +now use the signature() API. This allows them to +support a much broader range of callables, including those with +__signature__ attributes, those with metadata provided by argument +clinic, functools.partial() objects and more. Note that, unlike +signature(), these functions still ignore __wrapped__ +attributes, and report the already bound first argument for bound methods, +so it is still necessary to update your code to use +signature() directly if those features are desired. +(Contributed by Yury Selivanov in bpo-17481.)

    +

    signature() now supports duck types of CPython functions, +which adds support for functions compiled with Cython. (Contributed +by Stefan Behnel and Yury Selivanov in bpo-17159.)

    +
    +
    +

    ipaddress

    +

    ipaddress was added to the standard library in Python 3.3 as a +provisional API. With the release of Python 3.4, this qualification +has been removed: ipaddress is now considered a stable API, covered +by the normal standard library requirements to maintain backwards +compatibility.

    +

    A new is_global property is True if +an address is globally routeable. (Contributed by Peter Moody in +bpo-17400.)

    +
    +
    +

    logging

    +

    The TimedRotatingFileHandler has a new atTime +parameter that can be used to specify the time of day when rollover should +happen. (Contributed by Ronald Oussoren in bpo-9556.)

    +

    SocketHandler and +DatagramHandler now support Unix domain sockets (by +setting port to None). (Contributed by Vinay Sajip in commit +ce46195b56a9.)

    +

    fileConfig() now accepts a +configparser.RawConfigParser subclass instance for the fname +parameter. This facilitates using a configuration file when logging +configuration is just a part of the overall application configuration, or where +the application modifies the configuration before passing it to +fileConfig(). (Contributed by Vinay Sajip in +bpo-16110.)

    +

    Logging configuration data received from a socket via the +logging.config.listen() function can now be validated before being +processed by supplying a verification function as the argument to the new +verify keyword argument. (Contributed by Vinay Sajip in bpo-15452.)

    +
    +
    +

    marshal

    +

    The default marshal version has been bumped to 3. The code implementing +the new version restores the Python2 behavior of recording only one copy of +interned strings and preserving the interning on deserialization, and extends +this “one copy” ability to any object type (including handling recursive +references). This reduces both the size of .pyc files and the amount of +memory a module occupies in memory when it is loaded from a .pyc (or +.pyo) file. (Contributed by Kristján Valur Jónsson in bpo-16475, +with additional speedups by Antoine Pitrou in bpo-19219.)

    +
    +
    +

    mmap

    +

    mmap objects can now be weakrefed. (Contributed by Valerie Lambert in +bpo-4885.)

    +
    +
    +

    multiprocessing

    +

    On Unix two new start methods, +spawn and forkserver, have been added for starting processes using +multiprocessing. These make the mixing of processes with threads more +robust, and the spawn method matches the semantics that multiprocessing has +always used on Windows. New function +get_all_start_methods() reports all start methods +available on the platform, get_start_method() reports +the current start method, and set_start_method() sets +the start method. (Contributed by Richard Oudkerk in bpo-8713.)

    +

    multiprocessing also now has the concept of a context, which +determines how child processes are created. New function +get_context() returns a context that uses a specified +start method. It has the same API as the multiprocessing module itself, +so you can use it to create Pools and other +objects that will operate within that context. This allows a framework and an +application or different parts of the same application to use multiprocessing +without interfering with each other. (Contributed by Richard Oudkerk in +bpo-18999.)

    +

    Except when using the old fork start method, child processes no longer +inherit unneeded handles/file descriptors from their parents (part of +bpo-8713).

    +

    multiprocessing now relies on runpy (which implements the +-m switch) to initialise __main__ appropriately in child processes +when using the spawn or forkserver start methods. This resolves some +edge cases where combining multiprocessing, the -m command line switch, +and explicit relative imports could cause obscure failures in child +processes. (Contributed by Nick Coghlan in bpo-19946.)

    +
    +
    +

    operator

    +

    New function length_hint() provides an implementation of the +specification for how the __length_hint__() special method should +be used, as part of the PEP 424 formal specification of this language +feature. (Contributed by Armin Ronacher in bpo-16148.)

    +

    There is now a pure-python version of the operator module available for +reference and for use by alternate implementations of Python. (Contributed by +Zachary Ware in bpo-16694.)

    +
    +
    +

    os

    +

    There are new functions to get and set the inheritable flag of a file descriptor (os.get_inheritable(), +os.set_inheritable()) or a Windows handle +(os.get_handle_inheritable(), os.set_handle_inheritable()).

    +

    New function cpu_count() reports the number of CPUs available on the +platform on which Python is running (or None if the count can’t be +determined). The multiprocessing.cpu_count() function is now implemented +in terms of this function). (Contributed by Trent Nelson, Yogesh Chaudhari, +Victor Stinner, and Charles-François Natali in bpo-17914.)

    +

    os.path.samestat() is now available on the Windows platform (and the +os.path.samefile() implementation is now shared between Unix and +Windows). (Contributed by Brian Curtin in bpo-11939.)

    +

    os.path.ismount() now recognizes volumes mounted below a drive +root on Windows. (Contributed by Tim Golden in bpo-9035.)

    +

    os.open() supports two new flags on platforms that provide them, +O_PATH (un-opened file descriptor), and O_TMPFILE +(unnamed temporary file; as of 3.4.0 release available only on Linux systems +with a kernel version of 3.11 or newer that have uapi headers). (Contributed +by Christian Heimes in bpo-18673 and Benjamin Peterson, respectively.)

    +
    +
    +

    pdb

    +

    pdb has been enhanced to handle generators, yield, and +yield from in a more useful fashion. This is especially helpful when +debugging asyncio based programs. (Contributed by Andrew Svetlov and +Xavier de Gaye in bpo-16596.)

    +

    The print command has been removed from pdb, restoring access to the +Python print() function from the pdb command line. Python2’s pdb did +not have a print command; instead, entering print executed the +print statement. In Python3 print was mistakenly made an alias for the +pdb p command. p, however, prints the repr of its argument, +not the str like the Python2 print command did. Worse, the Python3 +pdb print command shadowed the Python3 print function, making it +inaccessible at the pdb prompt. (Contributed by Connor Osborn in +bpo-18764.)

    +
    +
    +

    pickle

    +

    pickle now supports (but does not use by default) a new pickle protocol, +protocol 4. This new protocol addresses a number of issues that were present +in previous protocols, such as the serialization of nested classes, very large +strings and containers, and classes whose __new__() method takes +keyword-only arguments. It also provides some efficiency improvements.

    +
    +

    See also

    +
    +
    PEP 3154 – Pickle protocol 4

    PEP written by Antoine Pitrou and implemented by Alexandre Vassalotti.

    +
    +
    +
    +
    +
    +

    plistlib

    +

    plistlib now has an API that is similar to the standard pattern for +stdlib serialization protocols, with new load(), +dump(), loads(), and dumps() +functions. (The older API is now deprecated.) In addition to the already +supported XML plist format (FMT_XML), it also now supports +the binary plist format (FMT_BINARY). (Contributed by Ronald +Oussoren and others in bpo-14455.)

    +
    +
    +

    poplib

    +

    Two new methods have been added to poplib: capa(), +which returns the list of capabilities advertised by the POP server, and +stls(), which switches a clear-text POP3 session into an +encrypted POP3 session if the POP server supports it. (Contributed by Lorenzo +Catucci in bpo-4473.)

    +
    +
    +

    pprint

    +

    The pprint module’s PrettyPrinter class and its +pformat(), and pprint() functions have a new +option, compact, that controls how the output is formatted. Currently +setting compact to True means that sequences will be printed with as many +sequence elements as will fit within width on each (indented) line. +(Contributed by Serhiy Storchaka in bpo-19132.)

    +

    Long strings are now wrapped using Python’s normal line continuation +syntax. (Contributed by Antoine Pitrou in bpo-17150.)

    +
    +
    +

    pty

    +

    pty.spawn() now returns the status value from os.waitpid() on +the child process, instead of None. (Contributed by Gregory P. Smith.)

    +
    +
    +

    pydoc

    +

    The pydoc module is now based directly on the inspect.signature() +introspection API, allowing it to provide signature information for a wider +variety of callable objects. This change also means that __wrapped__ +attributes are now taken into account when displaying help information. +(Contributed by Larry Hastings in bpo-19674.)

    +

    The pydoc module no longer displays the self parameter for +already bound methods. Instead, it aims to always display the exact current +signature of the supplied callable. (Contributed by Larry Hastings in +bpo-20710.)

    +

    In addition to the changes that have been made to pydoc directly, +its handling of custom __dir__ methods and various descriptor +behaviours has also been improved substantially by the underlying changes in +the inspect module.

    +

    As the help() builtin is based on pydoc, the above changes also +affect the behaviour of help().

    +
    +
    +

    re

    +

    New fullmatch() function and regex.fullmatch() method anchor +the pattern at both ends of the string to match. This provides a way to be +explicit about the goal of the match, which avoids a class of subtle bugs where +$ characters get lost during code changes or the addition of alternatives +to an existing regular expression. (Contributed by Matthew Barnett in +bpo-16203.)

    +

    The repr of regex objects now includes the pattern +and the flags; the repr of match objects now +includes the start, end, and the part of the string that matched. (Contributed +by Hugo Lopes Tavares and Serhiy Storchaka in bpo-13592 and +bpo-17087.)

    +
    +
    +

    resource

    +

    New prlimit() function, available on Linux platforms with a +kernel version of 2.6.36 or later and glibc of 2.13 or later, provides the +ability to query or set the resource limits for processes other than the one +making the call. (Contributed by Christian Heimes in bpo-16595.)

    +

    On Linux kernel version 2.6.36 or later, there are also some new +Linux specific constants: RLIMIT_MSGQUEUE, +RLIMIT_NICE, RLIMIT_RTPRIO, +RLIMIT_RTTIME, and RLIMIT_SIGPENDING. +(Contributed by Christian Heimes in bpo-19324.)

    +

    On FreeBSD version 9 and later, there some new FreeBSD specific constants: +RLIMIT_SBSIZE, RLIMIT_SWAP, and +RLIMIT_NPTS. (Contributed by Claudiu Popa in +bpo-19343.)

    +
    +
    +

    select

    +

    epoll objects now support the context management protocol. +When used in a with statement, the close() +method will be called automatically at the end of the block. (Contributed +by Serhiy Storchaka in bpo-16488.)

    +

    devpoll objects now have fileno() and +close() methods, as well as a new attribute +closed. (Contributed by Victor Stinner in +bpo-18794.)

    +
    +
    +

    shelve

    +

    Shelf instances may now be used in with statements, +and will be automatically closed at the end of the with block. +(Contributed by Filip Gruszczyński in bpo-13896.)

    +
    +
    +

    shutil

    +

    copyfile() now raises a specific Error subclass, +SameFileError, when the source and destination are the same +file, which allows an application to take appropriate action on this specific +error. (Contributed by Atsuo Ishimoto and Hynek Schlawack in +bpo-1492704.)

    +
    +
    +

    smtpd

    +

    The SMTPServer and SMTPChannel classes now +accept a map keyword argument which, if specified, is passed in to +asynchat.async_chat as its map argument. This allows an application +to avoid affecting the global socket map. (Contributed by Vinay Sajip in +bpo-11959.)

    +
    +
    +

    smtplib

    +

    SMTPException is now a subclass of OSError, which allows +both socket level errors and SMTP protocol level errors to be caught in one +try/except statement by code that only cares whether or not an error occurred. +(Contributed by Ned Jackson Lovely in bpo-2118.)

    +
    +
    +

    socket

    +

    The socket module now supports the CAN_BCM protocol on +platforms that support it. (Contributed by Brian Thorne in bpo-15359.)

    +

    Socket objects have new methods to get or set their inheritable flag, get_inheritable() and +set_inheritable().

    +

    The socket.AF_* and socket.SOCK_* constants are now enumeration values +using the new enum module. This allows meaningful names to be printed +during debugging, instead of integer “magic numbers”.

    +

    The AF_LINK constant is now available on BSD and OSX.

    +

    inet_pton() and inet_ntop() are now supported +on Windows. (Contributed by Atsuo Ishimoto in bpo-7171.)

    +
    +
    +

    sqlite3

    +

    A new boolean parameter to the connect() function, uri, can be +used to indicate that the database parameter is a uri (see the SQLite +URI documentation). (Contributed by poq in +bpo-13773.)

    +
    +
    +

    ssl

    +

    PROTOCOL_TLSv1_1 and PROTOCOL_TLSv1_2 (TLSv1.1 and +TLSv1.2 support) have been added; support for these protocols is only available if +Python is linked with OpenSSL 1.0.1 or later. (Contributed by Michele Orrù and +Antoine Pitrou in bpo-16692.)

    +

    New function create_default_context() provides a standard way to +obtain an SSLContext whose settings are intended to be a +reasonable balance between compatibility and security. These settings are +more stringent than the defaults provided by the SSLContext +constructor, and may be adjusted in the future, without prior deprecation, if +best-practice security requirements change. The new recommended best +practice for using stdlib libraries that support SSL is to use +create_default_context() to obtain an SSLContext +object, modify it if needed, and then pass it as the context argument +of the appropriate stdlib API. (Contributed by Christian Heimes +in bpo-19689.)

    +

    SSLContext method load_verify_locations() +accepts a new optional argument cadata, which can be used to provide PEM or +DER encoded certificates directly via strings or bytes, respectively. +(Contributed by Christian Heimes in bpo-18138.)

    +

    New function get_default_verify_paths() returns +a named tuple of the paths and environment variables that the +set_default_verify_paths() method uses to set +OpenSSL’s default cafile and capath. This can be an aid in +debugging default verification issues. (Contributed by Christian Heimes +in bpo-18143.)

    +

    SSLContext has a new method, +cert_store_stats(), that reports the number of loaded +X.509 certs, X.509 CA certs, and certificate revocation lists +(crls), as well as a get_ca_certs() method that +returns a list of the loaded CA certificates. (Contributed by Christian +Heimes in bpo-18147.)

    +

    If OpenSSL 0.9.8 or later is available, SSLContext has a new +attribute verify_flags that can be used to control the +certificate verification process by setting it to some combination of the new +constants VERIFY_DEFAULT, VERIFY_CRL_CHECK_LEAF, +VERIFY_CRL_CHECK_CHAIN, or VERIFY_X509_STRICT. +OpenSSL does not do any CRL verification by default. (Contributed by +Christien Heimes in bpo-8813.)

    +

    New SSLContext method load_default_certs() +loads a set of default “certificate authority” (CA) certificates from default +locations, which vary according to the platform. It can be used to load both +TLS web server authentication certificates +(purpose=SERVER_AUTH) for a client to use to verify a +server, and certificates for a server to use in verifying client certificates +(purpose=CLIENT_AUTH). (Contributed by Christian +Heimes in bpo-19292.)

    +

    Two new windows-only functions, enum_certificates() and +enum_crls() provide the ability to retrieve certificates, +certificate information, and CRLs from the Windows cert store. (Contributed +by Christian Heimes in bpo-17134.)

    +

    Support for server-side SNI (Server Name Indication) using the new +ssl.SSLContext.set_servername_callback() method. +(Contributed by Daniel Black in bpo-8109.)

    +

    The dictionary returned by SSLSocket.getpeercert() contains additional +X509v3 extension items: crlDistributionPoints, calIssuers, and +OCSP URIs. (Contributed by Christian Heimes in bpo-18379.)

    +
    +
    +

    stat

    +

    The stat module is now backed by a C implementation in _stat. A C +implementation is required as most of the values aren’t standardized and +are platform-dependent. (Contributed by Christian Heimes in bpo-11016.)

    +

    The module supports new ST_MODE flags, S_IFDOOR, +S_IFPORT, and S_IFWHT. (Contributed by +Christian Hiemes in bpo-11016.)

    +
    +
    +

    struct

    +

    New function iter_unpack and a new +struct.Struct.iter_unpack() method on compiled formats provide streamed +unpacking of a buffer containing repeated instances of a given format of data. +(Contributed by Antoine Pitrou in bpo-17804.)

    +
    +
    +

    subprocess

    +

    check_output() now accepts an input argument that can +be used to provide the contents of stdin for the command that is run. +(Contributed by Zack Weinberg in bpo-16624.)

    +

    getstatus() and getstatusoutput() now +work on Windows. This change was actually inadvertently made in 3.3.4. +(Contributed by Tim Golden in bpo-10197.)

    +
    +
    +

    sunau

    +

    The getparams() method now returns a namedtuple rather than a +plain tuple. (Contributed by Claudiu Popa in bpo-18901.)

    +

    sunau.open() now supports the context management protocol: when used in a +with block, the close method of the returned object will be +called automatically at the end of the block. (Contributed by Serhiy Storchaka +in bpo-18878.)

    +

    AU_write.setsampwidth() now supports 24 bit samples, thus adding +support for writing 24 sample using the module. (Contributed by +Serhiy Storchaka in bpo-19261.)

    +

    The writeframesraw() and +writeframes() methods now accept any bytes-like +object. (Contributed by Serhiy Storchaka in bpo-8311.)

    +
    +
    +

    sys

    +

    New function sys.getallocatedblocks() returns the current number of +blocks allocated by the interpreter. (In CPython with the default +--with-pymalloc setting, this is allocations made through the +PyObject_Malloc() API.) This can be useful for tracking memory leaks, +especially if automated via a test suite. (Contributed by Antoine Pitrou +in bpo-13390.)

    +

    When the Python interpreter starts in interactive mode, it checks for an __interactivehook__ attribute +on the sys module. If the attribute exists, its value is called with no +arguments just before interactive mode is started. The check is made after the +PYTHONSTARTUP file is read, so it can be set there. The site +module sets it to a function that enables tab +completion and history saving (in ~/.python-history) if the platform +supports readline. If you do not want this (new) behavior, you can +override it in PYTHONSTARTUP, sitecustomize, or +usercustomize by deleting this attribute from sys (or setting it +to some other callable). (Contributed by Éric Araujo and Antoine Pitrou in +bpo-5845.)

    +
    +
    +

    tarfile

    +

    The tarfile module now supports a simple Command-Line Interface when +called as a script directly or via -m. This can be used to create and +extract tarfile archives. (Contributed by Berker Peksag in bpo-13477.)

    +
    +
    +

    textwrap

    +

    The TextWrapper class has two new attributes/constructor +arguments: max_lines, which limits the number of +lines in the output, and placeholder, which is a +string that will appear at the end of the output if it has been truncated +because of max_lines. Building on these capabilities, a new convenience +function shorten() collapses all of the whitespace in the input +to single spaces and produces a single line of a given width that ends with +the placeholder (by default, [...]). (Contributed by Antoine Pitrou and +Serhiy Storchaka in bpo-18585 and bpo-18725.)

    +
    +
    +

    threading

    +

    The Thread object representing the main thread can be +obtained from the new main_thread() function. In normal +conditions this will be the thread from which the Python interpreter was +started. (Contributed by Andrew Svetlov in bpo-18882.)

    +
    +
    +

    traceback

    +

    A new traceback.clear_frames() function takes a traceback object +and clears the local variables in all of the frames it references, +reducing the amount of memory consumed. (Contributed by Andrew Kuchling in +bpo-1565525.)

    +
    +
    +

    types

    +

    A new DynamicClassAttribute() descriptor provides a way to define +an attribute that acts normally when looked up through an instance object, but +which is routed to the class __getattr__ when looked up through the +class. This allows one to have properties active on a class, and have virtual +attributes on the class with the same name (see Enum for an example). +(Contributed by Ethan Furman in bpo-19030.)

    +
    +
    +

    urllib

    +

    urllib.request now supports data: URLs via the +DataHandler class. (Contributed by Mathias Panzenböck +in bpo-16423.)

    +

    The http method that will be used by a Request class +can now be specified by setting a method +class attribute on the subclass. (Contributed by Jason R Coombs in +bpo-18978.)

    +

    Request objects are now reusable: if the +full_url or data +attributes are modified, all relevant internal properties are updated. This +means, for example, that it is now possible to use the same +Request object in more than one +OpenerDirector.open() call with different data arguments, or to +modify a Request’s url rather than recomputing it +from scratch. There is also a new +remove_header() method that can be used to remove +headers from a Request. (Contributed by Alexey +Kachayev in bpo-16464, Daniel Wozniak in bpo-17485, and Damien Brecht +and Senthil Kumaran in bpo-17272.)

    +

    HTTPError objects now have a +headers attribute that provides access to the +HTTP response headers associated with the error. (Contributed by +Berker Peksag in bpo-15701.)

    +
    +
    +

    unittest

    +

    The TestCase class has a new method, +subTest(), that produces a context manager whose +with block becomes a “sub-test”. This context manager allows a test +method to dynamically generate subtests by, say, calling the subTest +context manager inside a loop. A single test method can thereby produce an +indefinite number of separately-identified and separately-counted tests, all of +which will run even if one or more of them fail. For example:

    +
    class NumbersTest(unittest.TestCase):
    +    def test_even(self):
    +        for i in range(6):
    +            with self.subTest(i=i):
    +                self.assertEqual(i % 2, 0)
    +
    +
    +

    will result in six subtests, each identified in the unittest verbose output +with a label consisting of the variable name i and a particular value for +that variable (i=0, i=1, etc). See Distinguishing test iterations using subtests for the full +version of this example. (Contributed by Antoine Pitrou in bpo-16997.)

    +

    unittest.main() now accepts an iterable of test names for +defaultTest, where previously it only accepted a single test name as a +string. (Contributed by Jyrki Pulliainen in bpo-15132.)

    +

    If SkipTest is raised during test discovery (that is, at the +module level in the test file), it is now reported as a skip instead of an +error. (Contributed by Zach Ware in bpo-16935.)

    +

    discover() now sorts the discovered files to provide +consistent test ordering. (Contributed by Martin Melin and Jeff Ramnani in +bpo-16709.)

    +

    TestSuite now drops references to tests as soon as the test +has been run, if the test is successful. On Python interpreters that do +garbage collection, this allows the tests to be garbage collected if nothing +else is holding a reference to the test. It is possible to override this +behavior by creating a TestSuite subclass that defines a +custom _removeTestAtIndex method. (Contributed by Tom Wardill, Matt +McClure, and Andrew Svetlov in bpo-11798.)

    +

    A new test assertion context-manager, assertLogs(), +will ensure that a given block of code emits a log message using the +logging module. By default the message can come from any logger and +have a priority of INFO or higher, but both the logger name and an +alternative minimum logging level may be specified. The object returned by the +context manager can be queried for the LogRecords and/or +formatted messages that were logged. (Contributed by Antoine Pitrou in +bpo-18937.)

    +

    Test discovery now works with namespace packages (Contributed by Claudiu Popa +in bpo-17457.)

    +

    unittest.mock objects now inspect their specification signatures when +matching calls, which means an argument can now be matched by either position +or name, instead of only by position. (Contributed by Antoine Pitrou in +bpo-17015.)

    +

    mock_open() objects now have readline and readlines +methods. (Contributed by Toshio Kuratomi in bpo-17467.)

    +
    +
    +

    venv

    +

    venv now includes activation scripts for the csh and fish +shells. (Contributed by Andrew Svetlov in bpo-15417.)

    +

    EnvBuilder and the create() convenience function +take a new keyword argument with_pip, which defaults to False, that +controls whether or not EnvBuilder ensures that pip is +installed in the virtual environment. (Contributed by Nick Coghlan in +bpo-19552 as part of the PEP 453 implementation.)

    +
    +
    +

    wave

    +

    The getparams() method now returns a namedtuple rather than a +plain tuple. (Contributed by Claudiu Popa in bpo-17487.)

    +

    wave.open() now supports the context management protocol. (Contributed +by Claudiu Popa in bpo-17616.)

    +

    wave can now write output to unseekable files. (Contributed by David Jones, Guilherme Polo, and Serhiy +Storchaka in bpo-5202.)

    +

    The writeframesraw() and +writeframes() methods now accept any bytes-like +object. (Contributed by Serhiy Storchaka in bpo-8311.)

    +
    +
    +

    weakref

    +

    New WeakMethod class simulates weak references to bound +methods. (Contributed by Antoine Pitrou in bpo-14631.)

    +

    New finalize class makes it possible to register a callback +to be invoked when an object is garbage collected, without needing to +carefully manage the lifecycle of the weak reference itself. (Contributed by +Richard Oudkerk in bpo-15528.)

    +

    The callback, if any, associated with a ref is now +exposed via the __callback__ attribute. (Contributed +by Mark Dickinson in bpo-17643.)

    +
    +
    +

    xml.etree

    +

    A new parser, XMLPullParser, allows a +non-blocking applications to parse XML documents. An example can be +seen at Pull API for non-blocking parsing. (Contributed by Antoine +Pitrou in bpo-17741.)

    +

    The xml.etree.ElementTree tostring() and +tostringlist() functions, and the +ElementTree +write() method, now have a +short_empty_elements keyword-only parameter +providing control over whether elements with no content are written in +abbreviated (<tag />) or expanded (<tag></tag>) form. (Contributed by +Ariel Poliak and Serhiy Storchaka in bpo-14377.)

    +
    +
    +

    zipfile

    +

    The writepy() method of the +PyZipFile class has a new filterfunc option that can be +used to control which directories and files are added to the archive. For +example, this could be used to exclude test files from the archive. +(Contributed by Christian Tismer in bpo-19274.)

    +

    The allowZip64 parameter to ZipFile and +PyZipfile is now True by default. (Contributed by +William Mallard in bpo-17201.)

    +
    +
    +
    +

    CPython Implementation Changes

    +
    +

    PEP 445: Customization of CPython Memory Allocators

    +

    PEP 445 adds new C level interfaces to customize memory allocation in +the CPython interpreter.

    +
    +

    See also

    +
    +
    PEP 445 – Add new APIs to customize Python memory allocators

    PEP written and implemented by Victor Stinner.

    +
    +
    +
    +
    +
    +

    PEP 442: Safe Object Finalization

    +

    PEP 442 removes the current limitations and quirks of object finalization +in CPython. With it, objects with __del__() methods, as well as +generators with finally clauses, can be finalized when they are +part of a reference cycle.

    +

    As part of this change, module globals are no longer forcibly set to +None during interpreter shutdown in most cases, instead relying +on the normal operation of the cyclic garbage collector. This avoids a +whole class of interpreter-shutdown-time errors, usually involving +__del__ methods, that have plagued Python since the cyclic GC +was first introduced.

    +
    +

    See also

    +
    +
    PEP 442 – Safe object finalization

    PEP written and implemented by Antoine Pitrou.

    +
    +
    +
    +
    +
    +

    PEP 456: Secure and Interchangeable Hash Algorithm

    +

    PEP 456 follows up on earlier security fix work done on Python’s hash +algorithm to address certain DOS attacks to which public facing APIs backed by +dictionary lookups may be subject. (See bpo-14621 for the start of the +current round of improvements.) The PEP unifies CPython’s hash code to make it +easier for a packager to substitute a different hash algorithm, and switches +Python’s default implementation to a SipHash implementation on platforms that +have a 64 bit data type. Any performance differences in comparison with the +older FNV algorithm are trivial.

    +

    The PEP adds additional fields to the sys.hash_info struct sequence to +describe the hash algorithm in use by the currently executing binary. Otherwise, +the PEP does not alter any existing CPython APIs.

    +
    +
    +

    PEP 436: Argument Clinic

    +

    “Argument Clinic” (PEP 436) is now part of the CPython build process +and can be used to simplify the process of defining and maintaining +accurate signatures for builtins and standard library extension modules +implemented in C.

    +

    Some standard library extension modules have been converted to use Argument +Clinic in Python 3.4, and pydoc and inspect have been updated +accordingly.

    +

    It is expected that signature metadata for programmatic introspection will +be added to additional callables implemented in C as part of Python 3.4 +maintenance releases.

    +
    +

    Note

    +

    The Argument Clinic PEP is not fully up to date with the state of the +implementation. This has been deemed acceptable by the release manager +and core development team in this case, as Argument Clinic will not +be made available as a public API for third party use in Python 3.4.

    +
    +
    +

    See also

    +
    +
    PEP 436 – The Argument Clinic DSL

    PEP written and implemented by Larry Hastings.

    +
    +
    +
    +
    +
    +

    Other Build and C API Changes

    +
      +
    • The new PyType_GetSlot() function has been added to the stable ABI, +allowing retrieval of function pointers from named type slots when using +the limited API. (Contributed by Martin von Löwis in bpo-17162.)

    • +
    • The new Py_SetStandardStreamEncoding() pre-initialization API +allows applications embedding the CPython interpreter to reliably force +a particular encoding and error handler for the standard streams. +(Contributed by Bastien Montagne and Nick Coghlan in bpo-16129.)

    • +
    • Most Python C APIs that don’t mutate string arguments are now correctly +marked as accepting const char * rather than char *. (Contributed +by Serhiy Storchaka in bpo-1772673.)

    • +
    • A new shell version of python-config can be used even when a python +interpreter is not available (for example, in cross compilation scenarios).

    • +
    • PyUnicode_FromFormat() now supports width and precision +specifications for %s, %A, %U, %V, %S, and %R. +(Contributed by Ysj Ray and Victor Stinner in bpo-7330.)

    • +
    • New function PyStructSequence_InitType2() supplements the +existing PyStructSequence_InitType() function. The difference +is that it returns 0 on success and -1 on failure.

    • +
    • The CPython source can now be compiled using the address sanity checking +features of recent versions of GCC and clang: the false alarms in the small +object allocator have been silenced. (Contributed by Dhiru Kholia in +bpo-18596.)

    • +
    • The Windows build now uses Address Space Layout Randomization and Data Execution Prevention. (Contributed by +Christian Heimes in bpo-16632.)

    • +
    • New function PyObject_LengthHint() is the C API equivalent +of operator.length_hint(). (Contributed by Armin Ronacher in +bpo-16148.)

    • +
    +
    +
    +

    Other Improvements

    +
      +
    • The python command has a new option, -I, which causes it to run in “isolated mode”, +which means that sys.path contains neither the script’s directory nor +the user’s site-packages directory, and all PYTHON* environment +variables are ignored (it implies both -s and -E). Other +restrictions may also be applied in the future, with the goal being to +isolate the execution of a script from the user’s environment. This is +appropriate, for example, when Python is used to run a system script. On +most POSIX systems it can and should be used in the #! line of system +scripts. (Contributed by Christian Heimes in bpo-16499.)

    • +
    • Tab-completion is now enabled by default in the interactive interpreter +on systems that support readline. History is also enabled by default, +and is written to (and read from) the file ~/.python-history. +(Contributed by Antoine Pitrou and Éric Araujo in bpo-5845.)

    • +
    • Invoking the Python interpreter with --version now outputs the version to +standard output instead of standard error (bpo-18338). Similar changes +were made to argparse (bpo-18920) and other modules that have +script-like invocation capabilities (bpo-18922).

    • +
    • The CPython Windows installer now adds .py to the PATHEXT +variable when extensions are registered, allowing users to run a python +script at the windows command prompt by just typing its name without the +.py extension. (Contributed by Paul Moore in bpo-18569.)

    • +
    • A new make target coverage-report +will build python, run the test suite, and generate an HTML coverage report +for the C codebase using gcov and lcov.

    • +
    • The -R option to the python regression test suite now +also checks for memory allocation leaks, using +sys.getallocatedblocks(). (Contributed by Antoine Pitrou in +bpo-13390.)

    • +
    • python -m now works with namespace packages.

    • +
    • The stat module is now implemented in C, which means it gets the +values for its constants from the C header files, instead of having the +values hard-coded in the python module as was previously the case.

    • +
    • Loading multiple python modules from a single OS module (.so, .dll) +now works correctly (previously it silently returned the first python +module in the file). (Contributed by Václav Šmilauer in bpo-16421.)

    • +
    • A new opcode, LOAD_CLASSDEREF, has been added to fix a bug in the +loading of free variables in class bodies that could be triggered by certain +uses of __prepare__. (Contributed by Benjamin Peterson in +bpo-17853.)

    • +
    • A number of MemoryError-related crashes were identified and fixed by Victor +Stinner using his PEP 445-based pyfailmalloc tool (bpo-18408, +bpo-18520).

    • +
    • The pyvenv command now accepts a --copies option +to use copies rather than symlinks even on systems where symlinks are the +default. (Contributed by Vinay Sajip in bpo-18807.)

    • +
    • The pyvenv command also accepts a --without-pip +option to suppress the otherwise-automatic bootstrapping of pip into +the virtual environment. (Contributed by Nick Coghlan in bpo-19552 +as part of the PEP 453 implementation.)

    • +
    • The encoding name is now optional in the value set for the +PYTHONIOENCODING environment variable. This makes it possible to +set just the error handler, without changing the default encoding. +(Contributed by Serhiy Storchaka in bpo-18818.)

    • +
    • The bz2, lzma, and gzip module open functions now +support x (exclusive creation) mode. (Contributed by Tim Heaney and +Vajrasky Kok in bpo-19201, bpo-19222, and bpo-19223.)

    • +
    +
    +
    +

    Significant Optimizations

    +
      +
    • The UTF-32 decoder is now 3x to 4x faster. (Contributed by Serhiy Storchaka +in bpo-14625.)

    • +
    • The cost of hash collisions for sets is now reduced. Each hash table +probe now checks a series of consecutive, adjacent key/hash pairs before +continuing to make random probes through the hash table. This exploits +cache locality to make collision resolution less expensive. +The collision resolution scheme can be described as a hybrid of linear +probing and open addressing. The number of additional linear probes +defaults to nine. This can be changed at compile-time by defining +LINEAR_PROBES to be any value. Set LINEAR_PROBES=0 to turn-off +linear probing entirely. (Contributed by Raymond Hettinger in +bpo-18771.)

    • +
    • The interpreter starts about 30% faster. A couple of measures lead to the +speedup. The interpreter loads fewer modules on startup, e.g. the re, +collections and locale modules and their dependencies are no +longer imported by default. The marshal module has been improved to load +compiled Python code faster. (Contributed by Antoine Pitrou, Christian +Heimes and Victor Stinner in bpo-19219, bpo-19218, bpo-19209, +bpo-19205 and bpo-9548.)

    • +
    • bz2.BZ2File is now as fast or faster than the Python2 version for +most cases. lzma.LZMAFile has also been optimized. (Contributed by +Serhiy Storchaka and Nadeem Vawda in bpo-16034.)

    • +
    • random.getrandbits() is 20%-40% faster for small integers (the most +common use case). (Contributed by Serhiy Storchaka in bpo-16674.)

    • +
    • By taking advantage of the new storage format for strings, pickling of +strings is now significantly faster. (Contributed by Victor Stinner and +Antoine Pitrou in bpo-15596.)

    • +
    • A performance issue in io.FileIO.readall() has been solved. This +particularly affects Windows, and significantly speeds up the case of piping +significant amounts of data through subprocess. (Contributed +by Richard Oudkerk in bpo-15758.)

    • +
    • html.escape() is now 10x faster. (Contributed by Matt Bryant in +bpo-18020.)

    • +
    • On Windows, the native VirtualAlloc is now used instead of the CRT +malloc in obmalloc. Artificial benchmarks show about a 3% memory +savings.

    • +
    • os.urandom() now uses a lazily-opened persistent file descriptor +so as to avoid using many file descriptors when run in parallel from +multiple threads. (Contributed by Antoine Pitrou in bpo-18756.)

    • +
    +
    +
    +
    +

    Deprecated

    +

    This section covers various APIs and other features that have been deprecated +in Python 3.4, and will be removed in Python 3.5 or later. In most (but not +all) cases, using the deprecated APIs will produce a DeprecationWarning +when the interpreter is run with deprecation warnings enabled (for example, by +using -Wd).

    +
    +

    Deprecations in the Python API

    + +
    +
    +

    Deprecated Features

    +
      +
    • Running IDLE with the -n flag (no subprocess) is deprecated. +However, the feature will not be removed until bpo-18823 is resolved.

    • +
    • The site module adding a “site-python” directory to sys.path, if it +exists, is deprecated (bpo-19375).

    • +
    +
    +
    +
    +

    Removed

    +
    +

    Operating Systems No Longer Supported

    +

    Support for the following operating systems has been removed from the source +and build tools:

    +
      +
    • OS/2 (bpo-16135).

    • +
    • Windows 2000 (changeset e52df05b496a).

    • +
    • Windows systems where COMSPEC points to command.com (bpo-14470).

    • +
    • VMS (bpo-16136).

    • +
    +
    +
    +

    API and Feature Removals

    +

    The following obsolete and previously deprecated APIs and features have been +removed:

    +
      +
    • The unmaintained Misc/TextMate and Misc/vim directories have been +removed (see the devguide +for suggestions on what to use instead).

    • +
    • The SO makefile macro is removed (it was replaced by the +SHLIB_SUFFIX and EXT_SUFFIX macros) (bpo-16754).

    • +
    • The PyThreadState.tick_counter field has been removed; its value has +been meaningless since Python 3.2, when the “new GIL” was introduced +(bpo-19199).

    • +
    • PyLoader and PyPycLoader have been removed from importlib. +(Contributed by Taras Lyapun in bpo-15641.)

    • +
    • The strict argument to HTTPConnection and +HTTPSConnection has been removed. HTTP 0.9-style +“Simple Responses” are no longer supported.

    • +
    • The deprecated urllib.request.Request getter and setter methods +add_data, has_data, get_data, get_type, get_host, +get_selector, set_proxy, get_origin_req_host, and +is_unverifiable have been removed (use direct attribute access instead).

    • +
    • Support for loading the deprecated TYPE_INT64 has been removed from +marshal. (Contributed by Dan Riti in bpo-15480.)

    • +
    • inspect.Signature: positional-only parameters are now required +to have a valid name.

    • +
    • object.__format__() no longer accepts non-empty format strings, it now +raises a TypeError instead. Using a non-empty string has been +deprecated since Python 3.2. This change has been made to prevent a +situation where previously working (but incorrect) code would start failing +if an object gained a __format__ method, which means that your code may now +raise a TypeError if you are using an 's' format code with objects +that do not have a __format__ method that handles it. See bpo-7994 for +background.

    • +
    • difflib.SequenceMatcher.isbjunk() and +difflib.SequenceMatcher.isbpopular() were deprecated in 3.2, and have +now been removed: use x in sm.bjunk and +x in sm.bpopular, where sm is a SequenceMatcher object +(bpo-13248).

    • +
    +
    +
    +

    Code Cleanups

    +
      +
    • The unused and undocumented internal Scanner class has been removed from +the pydoc module.

    • +
    • The private and effectively unused _gestalt module has been removed, +along with the private platform functions _mac_ver_lookup, +_mac_ver_gstalt, and _bcd2str, which would only have ever been called +on badly broken OSX systems (see bpo-18393).

    • +
    • The hardcoded copies of certain stat constants that were included in +the tarfile module namespace have been removed.

    • +
    +
    +
    +
    +

    Porting to Python 3.4

    +

    This section lists previously described changes and other bugfixes +that may require changes to your code.

    +
    +

    Changes in ‘python’ Command Behavior

    +
      +
    • In a posix shell, setting the PATH environment variable to +an empty value is equivalent to not setting it at all. However, setting +PYTHONPATH to an empty value was not equivalent to not setting it +at all: setting PYTHONPATH to an empty value was equivalent to +setting it to ., which leads to confusion when reasoning by analogy to +how PATH works. The behavior now conforms to the posix convention +for PATH.

    • +
    • The [X refs, Y blocks] output of a debug (--with-pydebug) build of the +CPython interpreter is now off by default. It can be re-enabled using the +-X showrefcount option. (Contributed by Ezio Melotti in bpo-17323.)

    • +
    • The python command and most stdlib scripts (as well as argparse) now +output --version information to stdout instead of stderr (for +issue list see Other Improvements above).

    • +
    +
    +
    +

    Changes in the Python API

    +
      +
    • The ABCs defined in importlib.abc now either raise the appropriate +exception or return a default value instead of raising +NotImplementedError blindly. This will only affect code calling +super() and falling through all the way to the ABCs. For compatibility, +catch both NotImplementedError or the appropriate exception as needed.

    • +
    • The module type now initializes the __package__ and __loader__ +attributes to None by default. To determine if these attributes were set +in a backwards-compatible fashion, use e.g. +getattr(module, '__loader__', None) is not None. (bpo-17115.)

    • +
    • importlib.util.module_for_loader() now sets __loader__ and +__package__ unconditionally to properly support reloading. If this is not +desired then you will need to set these attributes manually. You can use +importlib.util.module_to_load() for module management.

    • +
    • Import now resets relevant attributes (e.g. __name__, __loader__, +__package__, __file__, __cached__) unconditionally when reloading. +Note that this restores a pre-3.3 behavior in that it means a module is +re-found when re-loaded (bpo-19413).

    • +
    • Frozen packages no longer set __path__ to a list containing the package +name, they now set it to an empty list. The previous behavior could cause +the import system to do the wrong thing on submodule imports if there was +also a directory with the same name as the frozen package. The correct way +to determine if a module is a package or not is to use hasattr(module, +'__path__') (bpo-18065).

    • +
    • Frozen modules no longer define a __file__ attribute. It’s semantically +incorrect for frozen modules to set the attribute as they are not loaded from +any explicit location. If you must know that a module comes from frozen code +then you can see if the module’s __spec__.location is set to 'frozen', +check if the loader is a subclass of +importlib.machinery.FrozenImporter, +or if Python 2 compatibility is necessary you can use imp.is_frozen().

    • +
    • py_compile.compile() now raises FileExistsError if the file path +it would write to is a symlink or a non-regular file. This is to act as a +warning that import will overwrite those files with a regular file regardless +of what type of file path they were originally.

    • +
    • importlib.abc.SourceLoader.get_source() no longer raises +ImportError when the source code being loaded triggers a +SyntaxError or UnicodeDecodeError. As ImportError is +meant to be raised only when source code cannot be found but it should, it was +felt to be over-reaching/overloading of that meaning when the source code is +found but improperly structured. If you were catching ImportError before and +wish to continue to ignore syntax or decoding issues, catch all three +exceptions now.

    • +
    • functools.update_wrapper() and functools.wraps() now correctly +set the __wrapped__ attribute to the function being wrapped, even if +that function also had its __wrapped__ attribute set. This means +__wrapped__ attributes now correctly link a stack of decorated +functions rather than every __wrapped__ attribute in the chain +referring to the innermost function. Introspection libraries that +assumed the previous behaviour was intentional can use +inspect.unwrap() to access the first function in the chain that has +no __wrapped__ attribute.

    • +
    • inspect.getfullargspec() has been reimplemented on top of +inspect.signature() and hence handles a much wider variety of callable +objects than it did in the past. It is expected that additional builtin and +extension module callables will gain signature metadata over the course of +the Python 3.4 series. Code that assumes that +inspect.getfullargspec() will fail on non-Python callables may need +to be adjusted accordingly.

    • +
    • importlib.machinery.PathFinder now passes on the current working +directory to objects in sys.path_hooks for the empty string. This +results in sys.path_importer_cache never containing '', thus +iterating through sys.path_importer_cache based on sys.path +will not find all keys. A module’s __file__ when imported in the current +working directory will also now have an absolute path, including when using +-m with the interpreter (except for __main__.__file__ when a script +has been executed directly using a relative path) (Contributed by Brett +Cannon in bpo-18416). is specified on the command-line) +(bpo-18416).

    • +
    • The removal of the strict argument to HTTPConnection +and HTTPSConnection changes the meaning of the +remaining arguments if you are specifying them positionally rather than by +keyword. If you’ve been paying attention to deprecation warnings your code +should already be specifying any additional arguments via keywords.

    • +
    • Strings between from __future__ import ... statements now always raise +a SyntaxError. Previously if there was no leading docstring, an +interstitial string would sometimes be ignored. This brings CPython into +compliance with the language spec; Jython and PyPy already were. +(bpo-17434).

    • +
    • ssl.SSLSocket.getpeercert() and ssl.SSLSocket.do_handshake() +now raise an OSError with ENOTCONN when the SSLSocket is not +connected, instead of the previous behavior of raising an +AttributeError. In addition, getpeercert() +will raise a ValueError if the handshake has not yet been done.

    • +
    • base64.b32decode() now raises a binascii.Error when the +input string contains non-b32-alphabet characters, instead of a +TypeError. This particular TypeError was missed when the other +TypeErrors were converted. (Contributed by Serhiy Storchaka in +bpo-18011.) Note: this change was also inadvertently applied in Python +3.3.3.

    • +
    • The file attribute is now automatically closed when +the creating cgi.FieldStorage instance is garbage collected. If you +were pulling the file object out separately from the cgi.FieldStorage +instance and not keeping the instance alive, then you should either store the +entire cgi.FieldStorage instance or read the contents of the file +before the cgi.FieldStorage instance is garbage collected.

    • +
    • Calling read or write on a closed SSL socket now raises an +informative ValueError rather than the previous more mysterious +AttributeError (bpo-9177).

    • +
    • slice.indices() no longer produces an OverflowError for huge +values. As a consequence of this fix, slice.indices() now raises a +ValueError if given a negative length; previously it returned nonsense +values (bpo-14794).

    • +
    • The complex constructor, unlike the cmath functions, was +incorrectly accepting float values if an object’s __complex__ +special method returned one. This now raises a TypeError. +(bpo-16290.)

    • +
    • The int constructor in 3.2 and 3.3 erroneously accepts float +values for the base parameter. It is unlikely anyone was doing this, but +if so, it will now raise a TypeError (bpo-16772).

    • +
    • Defaults for keyword-only arguments are now evaluated after defaults for +regular keyword arguments, instead of before. Hopefully no one wrote any +code that depends on the previous buggy behavior (bpo-16967).

    • +
    • Stale thread states are now cleared after fork(). This may cause +some system resources to be released that previously were incorrectly kept +perpetually alive (for example, database connections kept in thread-local +storage). (bpo-17094.)

    • +
    • Parameter names in __annotations__ dicts are now mangled properly, +similarly to __kwdefaults__. (Contributed by Yury Selivanov in +bpo-20625.)

    • +
    • hashlib.hash.name now always returns the identifier in lower case. +Previously some builtin hashes had uppercase names, but now that it is a +formal public interface the naming has been made consistent (bpo-18532).

    • +
    • Because unittest.TestSuite now drops references to tests after they +are run, test harnesses that re-use a TestSuite to re-run +a set of tests may fail. Test suites should not be re-used in this fashion +since it means state is retained between test runs, breaking the test +isolation that unittest is designed to provide. However, if the lack +of isolation is considered acceptable, the old behavior can be restored by +creating a TestSuite subclass that defines a +_removeTestAtIndex method that does nothing (see +TestSuite.__iter__()) (bpo-11798).

    • +
    • unittest now uses argparse for command line parsing. There are +certain invalid command forms that used to work that are no longer allowed; +in theory this should not cause backward compatibility issues since the +disallowed command forms didn’t make any sense and are unlikely to be in use.

    • +
    • The re.split(), re.findall(), and re.sub() functions, and +the group() and groups() methods of +match objects now always return a bytes object when the string +to be matched is a bytes-like object. Previously the return type +matched the input type, so if your code was depending on the return value +being, say, a bytearray, you will need to change your code.

    • +
    • audioop functions now raise an error immediately if passed string +input, instead of failing randomly later on (bpo-16685).

    • +
    • The new convert_charrefs argument to HTMLParser +currently defaults to False for backward compatibility, but will +eventually be changed to default to True. It is recommended that you add +this keyword, with the appropriate value, to any +HTMLParser calls in your code (bpo-13633).

    • +
    • Since the digestmod argument to the hmac.new() function will in the +future have no default, all calls to hmac.new() should be changed to +explicitly specify a digestmod (bpo-17276).

    • +
    • Calling sysconfig.get_config_var() with the SO key, or looking +SO up in the results of a call to sysconfig.get_config_vars() +is deprecated. This key should be replaced by EXT_SUFFIX or +SHLIB_SUFFIX, depending on the context (bpo-19555).

    • +
    • Any calls to open functions that specify U should be modified. +U is ineffective in Python3 and will eventually raise an error if used. +Depending on the function, the equivalent of its old Python2 behavior can be +achieved using either a newline argument, or if necessary by wrapping the +stream in TextIOWrapper to use its newline argument +(bpo-15204).

    • +
    • If you use pyvenv in a script and desire that pip +not be installed, you must add --without-pip to your command +invocation.

    • +
    • The default behavior of json.dump() and json.dumps() when +an indent is specified has changed: it no longer produces trailing +spaces after the item separating commas at the ends of lines. This +will matter only if you have tests that are doing white-space-sensitive +comparisons of such output (bpo-16333).

    • +
    • doctest now looks for doctests in extension module __doc__ +strings, so if your doctest test discovery includes extension modules that +have things that look like doctests in them you may see test failures you’ve +never seen before when running your tests (bpo-3158).

    • +
    • The collections.abc module has been slightly refactored as +part of the Python startup improvements. As a consequence of this, it is no +longer the case that importing collections automatically imports +collections.abc. If your program depended on the (undocumented) +implicit import, you will need to add an explicit import collections.abc +(bpo-20784).

    • +
    +
    +
    +

    Changes in the C API

    +
      +
    • PyEval_EvalFrameEx(), PyObject_Repr(), and +PyObject_Str(), along with some other internal C APIs, now include +a debugging assertion that ensures they are not used in situations where +they may silently discard a currently active exception. In cases where +discarding the active exception is expected and desired (for example, +because it has already been saved locally with PyErr_Fetch() or +is being deliberately replaced with a different exception), an explicit +PyErr_Clear() call will be needed to avoid triggering the +assertion when invoking these operations (directly or indirectly) and +running against a version of Python that is compiled with assertions +enabled.

    • +
    • PyErr_SetImportError() now sets TypeError when its msg +argument is not set. Previously only NULL was returned with no exception +set.

    • +
    • The result of the PyOS_ReadlineFunctionPointer callback must +now be a string allocated by PyMem_RawMalloc() or +PyMem_RawRealloc(), or NULL if an error occurred, instead of a +string allocated by PyMem_Malloc() or PyMem_Realloc() +(bpo-16742)

    • +
    • PyThread_set_key_value() now always set the value. In Python +3.3, the function did nothing if the key already exists (if the current +value is a non-NULL pointer).

    • +
    • The f_tstate (thread state) field of the PyFrameObject +structure has been removed to fix a bug: see bpo-14432 for the +rationale.

    • +
    +
    +
    +
    +

    Changed in 3.4.3

    +
    +

    PEP 476: Enabling certificate verification by default for stdlib http clients

    +

    http.client and modules which use it, such as urllib.request and +xmlrpc.client, will now verify that the server presents a certificate +which is signed by a CA in the platform trust store and whose hostname matches +the hostname being requested by default, significantly improving security for +many applications.

    +

    For applications which require the old previous behavior, they can pass an +alternate context:

    +
    import urllib.request
    +import ssl
    +
    +# This disables all verification
    +context = ssl._create_unverified_context()
    +
    +# This allows using a specific certificate for the host, which doesn't need
    +# to be in the trust store
    +context = ssl.create_default_context(cafile="/path/to/file.crt")
    +
    +urllib.request.urlopen("https://invalid-cert", context=context)
    +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/whatsnew/3.5.html b/python-3.7.4-docs-html/whatsnew/3.5.html new file mode 100644 index 0000000..4b90a70 --- /dev/null +++ b/python-3.7.4-docs-html/whatsnew/3.5.html @@ -0,0 +1,2421 @@ + + + + + + + What’s New In Python 3.5 — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    What’s New In Python 3.5

    +
    +
    Editors
    +

    Elvis Pranskevichus <elvis@magic.io>, Yury Selivanov <yury@magic.io>

    +
    +
    +

    This article explains the new features in Python 3.5, compared to 3.4. +Python 3.5 was released on September 13, 2015.  See the +changelog for a full +list of changes.

    +
    +

    See also

    +

    PEP 478 - Python 3.5 Release Schedule

    +
    +
    +

    Summary – Release highlights

    +

    New syntax features:

    +
      +
    • PEP 492, coroutines with async and await syntax.

    • +
    • PEP 465, a new matrix multiplication operator: a @ b.

    • +
    • PEP 448, additional unpacking generalizations.

    • +
    +

    New library modules:

    + +

    New built-in features:

    +
      +
    • bytes % args, bytearray % args: PEP 461 – +Adding % formatting to bytes and bytearray.

    • +
    • New bytes.hex(), bytearray.hex() and memoryview.hex() +methods. (Contributed by Arnon Yaari in bpo-9951.)

    • +
    • memoryview now supports tuple indexing (including multi-dimensional). +(Contributed by Antoine Pitrou in bpo-23632.)

    • +
    • Generators have a new gi_yieldfrom attribute, which returns the +object being iterated by yield from expressions. (Contributed +by Benno Leslie and Yury Selivanov in bpo-24450.)

    • +
    • A new RecursionError exception is now raised when maximum +recursion depth is reached. (Contributed by Georg Brandl +in bpo-19235.)

    • +
    +

    CPython implementation improvements:

    +
      +
    • When the LC_TYPE locale is the POSIX locale (C locale), +sys.stdin and sys.stdout now use the +surrogateescape error handler, instead of the strict error handler. +(Contributed by Victor Stinner in bpo-19977.)

    • +
    • .pyo files are no longer used and have been replaced by a more flexible +scheme that includes the optimization level explicitly in .pyc name. +(See PEP 488 overview.)

    • +
    • Builtin and extension modules are now initialized in a multi-phase process, +which is similar to how Python modules are loaded. +(See PEP 489 overview.)

    • +
    +

    Significant improvements in the standard library:

    + +

    Security improvements:

    +
      +
    • SSLv3 is now disabled throughout the standard library. +It can still be enabled by instantiating a ssl.SSLContext +manually. (See bpo-22638 for more details; this change was +backported to CPython 3.4 and 2.7.)

    • +
    • HTTP cookie parsing is now stricter, in order to protect +against potential injection attacks. (Contributed by Antoine Pitrou +in bpo-22796.)

    • +
    +

    Windows improvements:

    +
      +
    • A new installer for Windows has replaced the old MSI. +See Using Python on Windows for more information.

    • +
    • Windows builds now use Microsoft Visual C++ 14.0, and extension modules +should use the same.

    • +
    +

    Please read on for a comprehensive list of user-facing changes, including many +other smaller improvements, CPython optimizations, deprecations, and potential +porting issues.

    +
    +
    +

    New Features

    +
    +

    PEP 492 - Coroutines with async and await syntax

    +

    PEP 492 greatly improves support for asynchronous programming in Python +by adding awaitable objects, +coroutine functions, +asynchronous iteration, +and asynchronous context managers.

    +

    Coroutine functions are declared using the new async def syntax:

    +
    >>> async def coro():
    +...     return 'spam'
    +
    +
    +

    Inside a coroutine function, the new await expression can be used +to suspend coroutine execution until the result is available. Any object +can be awaited, as long as it implements the awaitable protocol by +defining the __await__() method.

    +

    PEP 492 also adds async for statement for convenient iteration +over asynchronous iterables.

    +

    An example of a rudimentary HTTP client written using the new syntax:

    +
    import asyncio
    +
    +async def http_get(domain):
    +    reader, writer = await asyncio.open_connection(domain, 80)
    +
    +    writer.write(b'\r\n'.join([
    +        b'GET / HTTP/1.1',
    +        b'Host: %b' % domain.encode('latin-1'),
    +        b'Connection: close',
    +        b'', b''
    +    ]))
    +
    +    async for line in reader:
    +        print('>>>', line)
    +
    +    writer.close()
    +
    +loop = asyncio.get_event_loop()
    +try:
    +    loop.run_until_complete(http_get('example.com'))
    +finally:
    +    loop.close()
    +
    +
    +

    Similarly to asynchronous iteration, there is a new syntax for asynchronous +context managers. The following script:

    +
    import asyncio
    +
    +async def coro(name, lock):
    +    print('coro {}: waiting for lock'.format(name))
    +    async with lock:
    +        print('coro {}: holding the lock'.format(name))
    +        await asyncio.sleep(1)
    +        print('coro {}: releasing the lock'.format(name))
    +
    +loop = asyncio.get_event_loop()
    +lock = asyncio.Lock()
    +coros = asyncio.gather(coro(1, lock), coro(2, lock))
    +try:
    +    loop.run_until_complete(coros)
    +finally:
    +    loop.close()
    +
    +
    +

    will output:

    +
    coro 2: waiting for lock
    +coro 2: holding the lock
    +coro 1: waiting for lock
    +coro 2: releasing the lock
    +coro 1: holding the lock
    +coro 1: releasing the lock
    +
    +
    +

    Note that both async for and async with can only +be used inside a coroutine function declared with async def.

    +

    Coroutine functions are intended to be run inside a compatible event loop, +such as the asyncio loop.

    +
    +

    Note

    +
    +

    Changed in version 3.5.2: Starting with CPython 3.5.2, __aiter__ can directly return +asynchronous iterators. Returning +an awaitable object will result in a +PendingDeprecationWarning.

    +

    See more details in the Asynchronous Iterators documentation +section.

    +
    +
    +
    +

    See also

    +
    +
    PEP 492 – Coroutines with async and await syntax

    PEP written and implemented by Yury Selivanov.

    +
    +
    +
    +
    +
    +

    PEP 465 - A dedicated infix operator for matrix multiplication

    +

    PEP 465 adds the @ infix operator for matrix multiplication. +Currently, no builtin Python types implement the new operator, however, it +can be implemented by defining __matmul__(), __rmatmul__(), +and __imatmul__() for regular, reflected, and in-place matrix +multiplication. The semantics of these methods is similar to that of +methods defining other infix arithmetic operators.

    +

    Matrix multiplication is a notably common operation in many fields of +mathematics, science, engineering, and the addition of @ allows writing +cleaner code:

    +
    S = (H @ beta - r).T @ inv(H @ V @ H.T) @ (H @ beta - r)
    +
    +
    +

    instead of:

    +
    S = dot((dot(H, beta) - r).T,
    +        dot(inv(dot(dot(H, V), H.T)), dot(H, beta) - r))
    +
    +
    +

    NumPy 1.10 has support for the new operator:

    +
    >>> import numpy
    +
    +>>> x = numpy.ones(3)
    +>>> x
    +array([ 1., 1., 1.])
    +
    +>>> m = numpy.eye(3)
    +>>> m
    +array([[ 1., 0., 0.],
    +       [ 0., 1., 0.],
    +       [ 0., 0., 1.]])
    +
    +>>> x @ m
    +array([ 1., 1., 1.])
    +
    +
    +
    +

    See also

    +
    +
    PEP 465 – A dedicated infix operator for matrix multiplication

    PEP written by Nathaniel J. Smith; implemented by Benjamin Peterson.

    +
    +
    +
    +
    +
    +

    PEP 448 - Additional Unpacking Generalizations

    +

    PEP 448 extends the allowed uses of the * iterable unpacking +operator and ** dictionary unpacking operator. It is now possible +to use an arbitrary number of unpackings in function calls:

    +
    >>> print(*[1], *[2], 3, *[4, 5])
    +1 2 3 4 5
    +
    +>>> def fn(a, b, c, d):
    +...     print(a, b, c, d)
    +...
    +
    +>>> fn(**{'a': 1, 'c': 3}, **{'b': 2, 'd': 4})
    +1 2 3 4
    +
    +
    +

    Similarly, tuple, list, set, and dictionary displays allow multiple +unpackings (see Expression lists and Dictionary displays):

    +
    >>> *range(4), 4
    +(0, 1, 2, 3, 4)
    +
    +>>> [*range(4), 4]
    +[0, 1, 2, 3, 4]
    +
    +>>> {*range(4), 4, *(5, 6, 7)}
    +{0, 1, 2, 3, 4, 5, 6, 7}
    +
    +>>> {'x': 1, **{'y': 2}}
    +{'x': 1, 'y': 2}
    +
    +
    +
    +

    See also

    +
    +
    PEP 448 – Additional Unpacking Generalizations

    PEP written by Joshua Landau; implemented by Neil Girdhar, +Thomas Wouters, and Joshua Landau.

    +
    +
    +
    +
    +
    +

    PEP 461 - percent formatting support for bytes and bytearray

    +

    PEP 461 adds support for the % +interpolation operator to bytes +and bytearray.

    +

    While interpolation is usually thought of as a string operation, there are +cases where interpolation on bytes or bytearrays makes sense, and the +work needed to make up for this missing functionality detracts from the +overall readability of the code. This issue is particularly important when +dealing with wire format protocols, which are often a mixture of binary +and ASCII compatible text.

    +

    Examples:

    +
    >>> b'Hello %b!' % b'World'
    +b'Hello World!'
    +
    +>>> b'x=%i y=%f' % (1, 2.5)
    +b'x=1 y=2.500000'
    +
    +
    +

    Unicode is not allowed for %b, but it is accepted by %a (equivalent of +repr(obj).encode('ascii', 'backslashreplace')):

    +
    >>> b'Hello %b!' % 'World'
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +TypeError: %b requires bytes, or an object that implements __bytes__, not 'str'
    +
    +>>> b'price: %a' % '10€'
    +b"price: '10\\u20ac'"
    +
    +
    +

    Note that %s and %r conversion types, although supported, should +only be used in codebases that need compatibility with Python 2.

    +
    +

    See also

    +
    +
    PEP 461 – Adding % formatting to bytes and bytearray

    PEP written by Ethan Furman; implemented by Neil Schemenauer and +Ethan Furman.

    +
    +
    +
    +
    +
    +

    PEP 484 - Type Hints

    +

    Function annotation syntax has been a Python feature since version 3.0 +(PEP 3107), however the semantics of annotations has been left undefined.

    +

    Experience has shown that the majority of function annotation +uses were to provide type hints to function parameters and return values. It +became evident that it would be beneficial for Python users, if the +standard library included the base definitions and tools for type annotations.

    +

    PEP 484 introduces a provisional module to +provide these standard definitions and tools, along with some conventions +for situations where annotations are not available.

    +

    For example, here is a simple function whose argument and return type +are declared in the annotations:

    +
    def greeting(name: str) -> str:
    +    return 'Hello ' + name
    +
    +
    +

    While these annotations are available at runtime through the usual +__annotations__ attribute, no automatic type checking happens at +runtime. Instead, it is assumed that a separate off-line type checker +(e.g. mypy) will be used for on-demand +source code analysis.

    +

    The type system supports unions, generic types, and a special type +named Any which is consistent with (i.e. assignable to +and from) all types.

    +
    +

    See also

    +
      +
    • typing module documentation

    • +
    • +
      PEP 484 – Type Hints

      PEP written by Guido van Rossum, Jukka Lehtosalo, and Łukasz Langa; +implemented by Guido van Rossum.

      +
      +
      +
    • +
    • +
      PEP 483 – The Theory of Type Hints

      PEP written by Guido van Rossum

      +
      +
      +
    • +
    +
    +
    +
    +

    PEP 471 - os.scandir() function – a better and faster directory iterator

    +

    PEP 471 adds a new directory iteration function, os.scandir(), +to the standard library. Additionally, os.walk() is now +implemented using scandir, which makes it 3 to 5 times faster +on POSIX systems and 7 to 20 times faster on Windows systems. This is +largely achieved by greatly reducing the number of calls to os.stat() +required to walk a directory tree.

    +

    Additionally, scandir returns an iterator, as opposed to returning +a list of file names, which improves memory efficiency when iterating +over very large directories.

    +

    The following example shows a simple use of os.scandir() to display all +the files (excluding directories) in the given path that don’t start with +'.'. The entry.is_file() call will generally +not make an additional system call:

    +
    for entry in os.scandir(path):
    +    if not entry.name.startswith('.') and entry.is_file():
    +        print(entry.name)
    +
    +
    +
    +

    See also

    +
    +
    PEP 471 – os.scandir() function – a better and faster directory iterator

    PEP written and implemented by Ben Hoyt with the help of Victor Stinner.

    +
    +
    +
    +
    +
    +

    PEP 475: Retry system calls failing with EINTR

    +

    An errno.EINTR error code is returned whenever a system call, that +is waiting for I/O, is interrupted by a signal. Previously, Python would +raise InterruptedError in such cases. This meant that, when writing a +Python application, the developer had two choices:

    +
      +
    1. Ignore the InterruptedError.

    2. +
    3. Handle the InterruptedError and attempt to restart the interrupted +system call at every call site.

    4. +
    +

    The first option makes an application fail intermittently. +The second option adds a large amount of boilerplate that makes the +code nearly unreadable. Compare:

    +
    print("Hello World")
    +
    +
    +

    and:

    +
    while True:
    +    try:
    +        print("Hello World")
    +        break
    +    except InterruptedError:
    +        continue
    +
    +
    +

    PEP 475 implements automatic retry of system calls on +EINTR. This removes the burden of dealing with EINTR +or InterruptedError in user code in most situations and makes +Python programs, including the standard library, more robust. Note that +the system call is only retried if the signal handler does not raise an +exception.

    +

    Below is a list of functions which are now retried when interrupted +by a signal:

    + +
    +

    See also

    +
    +
    PEP 475 – Retry system calls failing with EINTR

    PEP and implementation written by Charles-François Natali and +Victor Stinner, with the help of Antoine Pitrou (the French connection).

    +
    +
    +
    +
    +
    +

    PEP 479: Change StopIteration handling inside generators

    +

    The interaction of generators and StopIteration in Python 3.4 and +earlier was sometimes surprising, and could conceal obscure bugs. Previously, +StopIteration raised accidentally inside a generator function was +interpreted as the end of the iteration by the loop construct driving the +generator.

    +

    PEP 479 changes the behavior of generators: when a StopIteration +exception is raised inside a generator, it is replaced with a +RuntimeError before it exits the generator frame. The main goal of +this change is to ease debugging in the situation where an unguarded +next() call raises StopIteration and causes the iteration controlled +by the generator to terminate silently. This is particularly pernicious in +combination with the yield from construct.

    +

    This is a backwards incompatible change, so to enable the new behavior, +a __future__ import is necessary:

    +
    >>> from __future__ import generator_stop
    +
    +>>> def gen():
    +...     next(iter([]))
    +...     yield
    +...
    +>>> next(gen())
    +Traceback (most recent call last):
    +  File "<stdin>", line 2, in gen
    +StopIteration
    +
    +The above exception was the direct cause of the following exception:
    +
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +RuntimeError: generator raised StopIteration
    +
    +
    +

    Without a __future__ import, a PendingDeprecationWarning will be +raised whenever a StopIteration exception is raised inside a generator.

    +
    +

    See also

    +
    +
    PEP 479 – Change StopIteration handling inside generators

    PEP written by Chris Angelico and Guido van Rossum. Implemented by +Chris Angelico, Yury Selivanov and Nick Coghlan.

    +
    +
    +
    +
    +
    +

    PEP 485: A function for testing approximate equality

    +

    PEP 485 adds the math.isclose() and cmath.isclose() +functions which tell whether two values are approximately equal or +“close” to each other. Whether or not two values are considered +close is determined according to given absolute and relative tolerances. +Relative tolerance is the maximum allowed difference between isclose +arguments, relative to the larger absolute value:

    +
    >>> import math
    +>>> a = 5.0
    +>>> b = 4.99998
    +>>> math.isclose(a, b, rel_tol=1e-5)
    +True
    +>>> math.isclose(a, b, rel_tol=1e-6)
    +False
    +
    +
    +

    It is also possible to compare two values using absolute tolerance, which +must be a non-negative value:

    +
    >>> import math
    +>>> a = 5.0
    +>>> b = 4.99998
    +>>> math.isclose(a, b, abs_tol=0.00003)
    +True
    +>>> math.isclose(a, b, abs_tol=0.00001)
    +False
    +
    +
    +
    +

    See also

    +
    +
    PEP 485 – A function for testing approximate equality

    PEP written by Christopher Barker; implemented by Chris Barker and +Tal Einat.

    +
    +
    +
    +
    +
    +

    PEP 486: Make the Python Launcher aware of virtual environments

    +

    PEP 486 makes the Windows launcher (see PEP 397) aware of an active +virtual environment. When the default interpreter would be used and the +VIRTUAL_ENV environment variable is set, the interpreter in the virtual +environment will be used.

    +
    +

    See also

    +
    +
    PEP 486 – Make the Python Launcher aware of virtual environments

    PEP written and implemented by Paul Moore.

    +
    +
    +
    +
    +
    +

    PEP 488: Elimination of PYO files

    +

    PEP 488 does away with the concept of .pyo files. This means that +.pyc files represent both unoptimized and optimized bytecode. To prevent the +need to constantly regenerate bytecode files, .pyc files now have an +optional opt- tag in their name when the bytecode is optimized. This has the +side-effect of no more bytecode file name clashes when running under either +-O or -OO. Consequently, bytecode files generated from +-O, and -OO may now exist simultaneously. +importlib.util.cache_from_source() has an updated API to help with +this change.

    +
    +

    See also

    +
    +
    PEP 488 – Elimination of PYO files

    PEP written and implemented by Brett Cannon.

    +
    +
    +
    +
    +
    +

    PEP 489: Multi-phase extension module initialization

    +

    PEP 489 updates extension module initialization to take advantage of the +two step module loading mechanism introduced by PEP 451 in Python 3.4.

    +

    This change brings the import semantics of extension modules that opt-in to +using the new mechanism much closer to those of Python source and bytecode +modules, including the ability to use any valid identifier as a module name, +rather than being restricted to ASCII.

    +
    +

    See also

    +
    +
    PEP 489 – Multi-phase extension module initialization

    PEP written by Petr Viktorin, Stefan Behnel, and Nick Coghlan; +implemented by Petr Viktorin.

    +
    +
    +
    +
    +
    +
    +

    Other Language Changes

    +

    Some smaller changes made to the core Python language are:

    +
      +
    • Added the "namereplace" error handlers. The "backslashreplace" +error handlers now work with decoding and translating. +(Contributed by Serhiy Storchaka in bpo-19676 and bpo-22286.)

    • +
    • The -b option now affects comparisons of bytes with +int. (Contributed by Serhiy Storchaka in bpo-23681.)

    • +
    • New Kazakh kz1048 and Tajik koi8_t codecs. +(Contributed by Serhiy Storchaka in bpo-22682 and bpo-22681.)

    • +
    • Property docstrings are now writable. This is especially useful for +collections.namedtuple() docstrings. +(Contributed by Berker Peksag in bpo-24064.)

    • +
    • Circular imports involving relative imports are now supported. +(Contributed by Brett Cannon and Antoine Pitrou in bpo-17636.)

    • +
    +
    +
    +

    New Modules

    +
    +

    typing

    +

    The new typing provisional module +provides standard definitions and tools for function type annotations. +See Type Hints for more information.

    +
    +
    +

    zipapp

    +

    The new zipapp module (specified in PEP 441) provides an API and +command line tool for creating executable Python Zip Applications, which +were introduced in Python 2.6 in bpo-1739468, but which were not well +publicized, either at the time or since.

    +

    With the new module, bundling your application is as simple as putting all +the files, including a __main__.py file, into a directory myapp +and running:

    +
    $ python -m zipapp myapp
    +$ python myapp.pyz
    +
    +
    +

    The module implementation has been contributed by Paul Moore in +bpo-23491.

    +
    +

    See also

    +

    PEP 441 – Improving Python ZIP Application Support

    +
    +
    +
    +
    +

    Improved Modules

    +
    +

    argparse

    +

    The ArgumentParser class now allows disabling +abbreviated usage of long options by setting +allow_abbrev to False. (Contributed by Jonathan Paugh, +Steven Bethard, paul j3 and Daniel Eriksson in bpo-14910.)

    +
    +
    +

    asyncio

    +

    Since the asyncio module is provisional, +all changes introduced in Python 3.5 have also been backported to Python 3.4.x.

    +

    Notable changes in the asyncio module since Python 3.4.0:

    + +

    Updates in 3.5.1:

    + +

    Updates in 3.5.2:

    + +
    +
    +

    bz2

    +

    The BZ2Decompressor.decompress +method now accepts an optional max_length argument to limit the maximum +size of decompressed data. (Contributed by Nikolaus Rath in bpo-15955.)

    +
    +
    +

    cgi

    +

    The FieldStorage class now supports the context manager +protocol. (Contributed by Berker Peksag in bpo-20289.)

    +
    +
    +

    cmath

    +

    A new function isclose() provides a way to test for approximate +equality. (Contributed by Chris Barker and Tal Einat in bpo-24270.)

    +
    +
    +

    code

    +

    The InteractiveInterpreter.showtraceback() +method now prints the full chained traceback, just like the interactive +interpreter. (Contributed by Claudiu Popa in bpo-17442.)

    +
    +
    +

    collections

    +

    The OrderedDict class is now implemented in C, which +makes it 4 to 100 times faster. (Contributed by Eric Snow in bpo-16991.)

    +

    OrderedDict.items(), +OrderedDict.keys(), +OrderedDict.values() views now support +reversed() iteration. +(Contributed by Serhiy Storchaka in bpo-19505.)

    +

    The deque class now defines +index(), insert(), and +copy(), and supports the + and * operators. +This allows deques to be recognized as a MutableSequence +and improves their substitutability for lists. +(Contributed by Raymond Hettinger in bpo-23704.)

    +

    Docstrings produced by namedtuple() can now be updated:

    +
    Point = namedtuple('Point', ['x', 'y'])
    +Point.__doc__ += ': Cartesian coodinate'
    +Point.x.__doc__ = 'abscissa'
    +Point.y.__doc__ = 'ordinate'
    +
    +
    +

    (Contributed by Berker Peksag in bpo-24064.)

    +

    The UserString class now implements the +__getnewargs__(), __rmod__(), casefold(), +format_map(), isprintable(), and maketrans() +methods to match the corresponding methods of str. +(Contributed by Joe Jevnik in bpo-22189.)

    +
    +
    +

    collections.abc

    +

    The Sequence.index() method now +accepts start and stop arguments to match the corresponding methods +of tuple, list, etc. +(Contributed by Devin Jeanpierre in bpo-23086.)

    +

    A new Generator abstract base class. (Contributed +by Stefan Behnel in bpo-24018.)

    +

    New Awaitable, Coroutine, +AsyncIterator, and +AsyncIterable abstract base classes. +(Contributed by Yury Selivanov in bpo-24184.)

    +

    For earlier Python versions, a backport of the new ABCs is available in an +external PyPI package.

    +
    +
    +

    compileall

    +

    A new compileall option, -j N, allows running N workers +simultaneously to perform parallel bytecode compilation. +The compile_dir() function has a corresponding workers +parameter. (Contributed by Claudiu Popa in bpo-16104.)

    +

    Another new option, -r, allows controlling the maximum recursion +level for subdirectories. (Contributed by Claudiu Popa in bpo-19628.)

    +

    The -q command line option can now be specified more than once, in +which case all output, including errors, will be suppressed. The corresponding +quiet parameter in compile_dir(), +compile_file(), and compile_path() can now +accept an integer value indicating the level of output suppression. +(Contributed by Thomas Kluyver in bpo-21338.)

    +
    +
    +

    concurrent.futures

    +

    The Executor.map() method now accepts a +chunksize argument to allow batching of tasks to improve performance when +ProcessPoolExecutor() is used. +(Contributed by Dan O’Reilly in bpo-11271.)

    +

    The number of workers in the ThreadPoolExecutor +constructor is optional now. The default value is 5 times the number of CPUs. +(Contributed by Claudiu Popa in bpo-21527.)

    +
    +
    +

    configparser

    +

    configparser now provides a way to customize the conversion +of values by specifying a dictionary of converters in the +ConfigParser constructor, or by defining them +as methods in ConfigParser subclasses. Converters defined in +a parser instance are inherited by its section proxies.

    +

    Example:

    +
    >>> import configparser
    +>>> conv = {}
    +>>> conv['list'] = lambda v: [e.strip() for e in v.split() if e.strip()]
    +>>> cfg = configparser.ConfigParser(converters=conv)
    +>>> cfg.read_string("""
    +... [s]
    +... list = a b c d e f g
    +... """)
    +>>> cfg.get('s', 'list')
    +'a b c d e f g'
    +>>> cfg.getlist('s', 'list')
    +['a', 'b', 'c', 'd', 'e', 'f', 'g']
    +>>> section = cfg['s']
    +>>> section.getlist('list')
    +['a', 'b', 'c', 'd', 'e', 'f', 'g']
    +
    +
    +

    (Contributed by Łukasz Langa in bpo-18159.)

    +
    +
    +

    contextlib

    +

    The new redirect_stderr() context manager (similar to +redirect_stdout()) makes it easier for utility scripts to +handle inflexible APIs that write their output to sys.stderr and +don’t provide any options to redirect it:

    +
    >>> import contextlib, io, logging
    +>>> f = io.StringIO()
    +>>> with contextlib.redirect_stderr(f):
    +...     logging.warning('warning')
    +...
    +>>> f.getvalue()
    +'WARNING:root:warning\n'
    +
    +
    +

    (Contributed by Berker Peksag in bpo-22389.)

    +
    +
    +

    csv

    +

    The writerow() method now supports arbitrary iterables, +not just sequences. (Contributed by Serhiy Storchaka in bpo-23171.)

    +
    +
    +

    curses

    +

    The new update_lines_cols() function updates the LINES +and COLS environment variables. This is useful for detecting +manual screen resizing. (Contributed by Arnon Yaari in bpo-4254.)

    +
    +
    +

    dbm

    +

    dumb.open always creates a new database when the flag +has the value "n". (Contributed by Claudiu Popa in bpo-18039.)

    +
    +
    +

    difflib

    +

    The charset of HTML documents generated by +HtmlDiff.make_file() +can now be customized by using a new charset keyword-only argument. +The default charset of HTML document changed from "ISO-8859-1" +to "utf-8". +(Contributed by Berker Peksag in bpo-2052.)

    +

    The diff_bytes() function can now compare lists of byte +strings. This fixes a regression from Python 2. +(Contributed by Terry J. Reedy and Greg Ward in bpo-17445.)

    +
    +
    +

    distutils

    +

    Both the build and build_ext commands now accept a -j option to +enable parallel building of extension modules. +(Contributed by Antoine Pitrou in bpo-5309.)

    +

    The distutils module now supports xz compression, and can be +enabled by passing xztar as an argument to bdist --format. +(Contributed by Serhiy Storchaka in bpo-16314.)

    +
    +
    +

    doctest

    +

    The DocTestSuite() function returns an empty +unittest.TestSuite if module contains no docstrings, instead of +raising ValueError. (Contributed by Glenn Jones in bpo-15916.)

    +
    +
    +

    email

    +

    A new policy option Policy.mangle_from_ +controls whether or not lines that start with "From " in email bodies are +prefixed with a ">" character by generators. The default is True for +compat32 and False for all other policies. +(Contributed by Milan Oberkirch in bpo-20098.)

    +

    A new +Message.get_content_disposition() +method provides easy access to a canonical value for the +Content-Disposition header. +(Contributed by Abhilash Raj in bpo-21083.)

    +

    A new policy option EmailPolicy.utf8 +can be set to True to encode email headers using the UTF-8 charset instead +of using encoded words. This allows Messages to be formatted according to +RFC 6532 and used with an SMTP server that supports the RFC 6531 +SMTPUTF8 extension. (Contributed by R. David Murray in +bpo-24211.)

    +

    The mime.text.MIMEText constructor now +accepts a charset.Charset instance. +(Contributed by Claude Paroz and Berker Peksag in bpo-16324.)

    +
    +
    +

    enum

    +

    The Enum callable has a new parameter start to +specify the initial number of enum values if only names are provided:

    +
    >>> Animal = enum.Enum('Animal', 'cat dog', start=10)
    +>>> Animal.cat
    +<Animal.cat: 10>
    +>>> Animal.dog
    +<Animal.dog: 11>
    +
    +
    +

    (Contributed by Ethan Furman in bpo-21706.)

    +
    +
    +

    faulthandler

    +

    The enable(), register(), +dump_traceback() and +dump_traceback_later() functions now accept file +descriptors in addition to file-like objects. +(Contributed by Wei Wu in bpo-23566.)

    +
    +
    +

    functools

    +

    Most of the lru_cache() machinery is now implemented in C, making +it significantly faster. (Contributed by Matt Joiner, Alexey Kachayev, and +Serhiy Storchaka in bpo-14373.)

    +
    +
    +

    glob

    +

    The iglob() and glob() functions now support recursive +search in subdirectories, using the "**" pattern. +(Contributed by Serhiy Storchaka in bpo-13968.)

    +
    +
    +

    gzip

    +

    The mode argument of the GzipFile constructor now +accepts "x" to request exclusive creation. +(Contributed by Tim Heaney in bpo-19222.)

    +
    +
    +

    heapq

    +

    Element comparison in merge() can now be customized by +passing a key function in a new optional key keyword argument, +and a new optional reverse keyword argument can be used to reverse element +comparison:

    +
    >>> import heapq
    +>>> a = ['9', '777', '55555']
    +>>> b = ['88', '6666']
    +>>> list(heapq.merge(a, b, key=len))
    +['9', '88', '777', '6666', '55555']
    +>>> list(heapq.merge(reversed(a), reversed(b), key=len, reverse=True))
    +['55555', '6666', '777', '88', '9']
    +
    +
    +

    (Contributed by Raymond Hettinger in bpo-13742.)

    +
    +
    +

    http

    +

    A new HTTPStatus enum that defines a set of +HTTP status codes, reason phrases and long descriptions written in English. +(Contributed by Demian Brecht in bpo-21793.)

    +
    +
    +

    http.client

    +

    HTTPConnection.getresponse() +now raises a RemoteDisconnected exception when a +remote server connection is closed unexpectedly. Additionally, if a +ConnectionError (of which RemoteDisconnected +is a subclass) is raised, the client socket is now closed automatically, +and will reconnect on the next request:

    +
    import http.client
    +conn = http.client.HTTPConnection('www.python.org')
    +for retries in range(3):
    +    try:
    +        conn.request('GET', '/')
    +        resp = conn.getresponse()
    +    except http.client.RemoteDisconnected:
    +        pass
    +
    +
    +

    (Contributed by Martin Panter in bpo-3566.)

    +
    +
    +

    idlelib and IDLE

    +

    Since idlelib implements the IDLE shell and editor and is not intended for +import by other programs, it gets improvements with every release. See +Lib/idlelib/NEWS.txt for a cumulative list of changes since 3.4.0, +as well as changes made in future 3.5.x releases. This file is also available +from the IDLE Help ‣ About IDLE dialog.

    +
    +
    +

    imaplib

    +

    The IMAP4 class now supports the context manager protocol. +When used in a with statement, the IMAP4 LOGOUT +command will be called automatically at the end of the block. +(Contributed by Tarek Ziadé and Serhiy Storchaka in bpo-4972.)

    +

    The imaplib module now supports RFC 5161 (ENABLE Extension) +and RFC 6855 (UTF-8 Support) via the IMAP4.enable() +method. A new IMAP4.utf8_enabled +attribute tracks whether or not RFC 6855 support is enabled. +(Contributed by Milan Oberkirch, R. David Murray, and Maciej Szulik in +bpo-21800.)

    +

    The imaplib module now automatically encodes non-ASCII string usernames +and passwords using UTF-8, as recommended by the RFCs. (Contributed by Milan +Oberkirch in bpo-21800.)

    +
    +
    +

    imghdr

    +

    The what() function now recognizes the +OpenEXR format +(contributed by Martin Vignali and Claudiu Popa in bpo-20295), +and the WebP format +(contributed by Fabrice Aneche and Claudiu Popa in bpo-20197.)

    +
    +
    +

    importlib

    +

    The util.LazyLoader class allows for +lazy loading of modules in applications where startup time is important. +(Contributed by Brett Cannon in bpo-17621.)

    +

    The abc.InspectLoader.source_to_code() +method is now a static method. This makes it easier to initialize a module +object with code compiled from a string by running +exec(code, module.__dict__). +(Contributed by Brett Cannon in bpo-21156.)

    +

    The new util.module_from_spec() +function is now the preferred way to create a new module. As opposed to +creating a types.ModuleType instance directly, this new function +will set the various import-controlled attributes based on the passed-in +spec object. (Contributed by Brett Cannon in bpo-20383.)

    +
    +
    +

    inspect

    +

    Both the Signature and Parameter classes are +now picklable and hashable. (Contributed by Yury Selivanov in bpo-20726 +and bpo-20334.)

    +

    A new +BoundArguments.apply_defaults() +method provides a way to set default values for missing arguments:

    +
    >>> def foo(a, b='ham', *args): pass
    +>>> ba = inspect.signature(foo).bind('spam')
    +>>> ba.apply_defaults()
    +>>> ba.arguments
    +OrderedDict([('a', 'spam'), ('b', 'ham'), ('args', ())])
    +
    +
    +

    (Contributed by Yury Selivanov in bpo-24190.)

    +

    A new class method +Signature.from_callable() makes +subclassing of Signature easier. (Contributed +by Yury Selivanov and Eric Snow in bpo-17373.)

    +

    The signature() function now accepts a follow_wrapped +optional keyword argument, which, when set to False, disables automatic +following of __wrapped__ links. +(Contributed by Yury Selivanov in bpo-20691.)

    +

    A set of new functions to inspect +coroutine functions and +coroutine objects has been added: +iscoroutine(), iscoroutinefunction(), +isawaitable(), getcoroutinelocals(), +and getcoroutinestate(). +(Contributed by Yury Selivanov in bpo-24017 and bpo-24400.)

    +

    The stack(), trace(), +getouterframes(), and getinnerframes() +functions now return a list of named tuples. +(Contributed by Daniel Shahaf in bpo-16808.)

    +
    +
    +

    io

    +

    A new BufferedIOBase.readinto1() +method, that uses at most one call to the underlying raw stream’s +RawIOBase.read() or +RawIOBase.readinto() methods. +(Contributed by Nikolaus Rath in bpo-20578.)

    +
    +
    +

    ipaddress

    +

    Both the IPv4Network and IPv6Network classes +now accept an (address, netmask) tuple argument, so as to easily construct +network objects from existing addresses:

    +
    >>> import ipaddress
    +>>> ipaddress.IPv4Network(('127.0.0.0', 8))
    +IPv4Network('127.0.0.0/8')
    +>>> ipaddress.IPv4Network(('127.0.0.0', '255.0.0.0'))
    +IPv4Network('127.0.0.0/8')
    +
    +
    +

    (Contributed by Peter Moody and Antoine Pitrou in bpo-16531.)

    +

    A new reverse_pointer attribute for the +IPv4Network and IPv6Network classes +returns the name of the reverse DNS PTR record:

    +
    >>> import ipaddress
    +>>> addr = ipaddress.IPv4Address('127.0.0.1')
    +>>> addr.reverse_pointer
    +'1.0.0.127.in-addr.arpa'
    +>>> addr6 = ipaddress.IPv6Address('::1')
    +>>> addr6.reverse_pointer
    +'1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa'
    +
    +
    +

    (Contributed by Leon Weber in bpo-20480.)

    +
    +
    +

    json

    +

    The json.tool command line interface now preserves the order of keys in +JSON objects passed in input. The new --sort-keys option can be used +to sort the keys alphabetically. (Contributed by Berker Peksag +in bpo-21650.)

    +

    JSON decoder now raises JSONDecodeError instead of +ValueError to provide better context information about the error. +(Contributed by Serhiy Storchaka in bpo-19361.)

    +
    +
    +

    linecache

    +

    A new lazycache() function can be used to capture information +about a non-file-based module to permit getting its lines later via +getline(). This avoids doing I/O until a line is actually +needed, without having to carry the module globals around indefinitely. +(Contributed by Robert Collins in bpo-17911.)

    +
    +
    +

    locale

    +

    A new delocalize() function can be used to convert a string into +a normalized number string, taking the LC_NUMERIC settings into account:

    +
    >>> import locale
    +>>> locale.setlocale(locale.LC_NUMERIC, 'de_DE.UTF-8')
    +'de_DE.UTF-8'
    +>>> locale.delocalize('1.234,56')
    +'1234.56'
    +>>> locale.setlocale(locale.LC_NUMERIC, 'en_US.UTF-8')
    +'en_US.UTF-8'
    +>>> locale.delocalize('1,234.56')
    +'1234.56'
    +
    +
    +

    (Contributed by Cédric Krier in bpo-13918.)

    +
    +
    +

    logging

    +

    All logging methods (Logger log(), +exception(), critical(), +debug(), etc.), now accept exception instances +as an exc_info argument, in addition to boolean values and exception +tuples:

    +
    >>> import logging
    +>>> try:
    +...     1/0
    +... except ZeroDivisionError as ex:
    +...     logging.error('exception', exc_info=ex)
    +ERROR:root:exception
    +
    +
    +

    (Contributed by Yury Selivanov in bpo-20537.)

    +

    The handlers.HTTPHandler class now +accepts an optional ssl.SSLContext instance to configure SSL +settings used in an HTTP connection. +(Contributed by Alex Gaynor in bpo-22788.)

    +

    The handlers.QueueListener class now +takes a respect_handler_level keyword argument which, if set to True, +will pass messages to handlers taking handler levels into account. +(Contributed by Vinay Sajip.)

    +
    +
    +

    lzma

    +

    The LZMADecompressor.decompress() +method now accepts an optional max_length argument to limit the maximum +size of decompressed data. +(Contributed by Martin Panter in bpo-15955.)

    +
    +
    +

    math

    +

    Two new constants have been added to the math module: inf +and nan. (Contributed by Mark Dickinson in bpo-23185.)

    +

    A new function isclose() provides a way to test for approximate +equality. (Contributed by Chris Barker and Tal Einat in bpo-24270.)

    +

    A new gcd() function has been added. The fractions.gcd() +function is now deprecated. (Contributed by Mark Dickinson and Serhiy +Storchaka in bpo-22486.)

    +
    +
    +

    multiprocessing

    +

    sharedctypes.synchronized() +objects now support the context manager protocol. +(Contributed by Charles-François Natali in bpo-21565.)

    +
    +
    +

    operator

    +

    attrgetter(), itemgetter(), +and methodcaller() objects now support pickling. +(Contributed by Josh Rosenberg and Serhiy Storchaka in bpo-22955.)

    +

    New matmul() and imatmul() functions +to perform matrix multiplication. +(Contributed by Benjamin Peterson in bpo-21176.)

    +
    +
    +

    os

    +

    The new scandir() function returning an iterator of +DirEntry objects has been added. If possible, scandir() +extracts file attributes while scanning a directory, removing the need to +perform subsequent system calls to determine file type or attributes, which may +significantly improve performance. (Contributed by Ben Hoyt with the help +of Victor Stinner in bpo-22524.)

    +

    On Windows, a new +stat_result.st_file_attributes +attribute is now available. It corresponds to the dwFileAttributes member +of the BY_HANDLE_FILE_INFORMATION structure returned by +GetFileInformationByHandle(). (Contributed by Ben Hoyt in bpo-21719.)

    +

    The urandom() function now uses the getrandom() syscall on Linux 3.17 +or newer, and getentropy() on OpenBSD 5.6 and newer, removing the need to +use /dev/urandom and avoiding failures due to potential file descriptor +exhaustion. (Contributed by Victor Stinner in bpo-22181.)

    +

    New get_blocking() and set_blocking() functions allow +getting and setting a file descriptor’s blocking mode (O_NONBLOCK.) +(Contributed by Victor Stinner in bpo-22054.)

    +

    The truncate() and ftruncate() functions are now supported +on Windows. (Contributed by Steve Dower in bpo-23668.)

    +

    There is a new os.path.commonpath() function returning the longest +common sub-path of each passed pathname. Unlike the +os.path.commonprefix() function, it always returns a valid +path:

    +
    >>> os.path.commonprefix(['/usr/lib', '/usr/local/lib'])
    +'/usr/l'
    +
    +>>> os.path.commonpath(['/usr/lib', '/usr/local/lib'])
    +'/usr'
    +
    +
    +

    (Contributed by Rafik Draoui and Serhiy Storchaka in bpo-10395.)

    +
    +
    +

    pathlib

    +

    The new Path.samefile() method can be used +to check whether the path points to the same file as another path, which can +be either another Path object, or a string:

    +
    >>> import pathlib
    +>>> p1 = pathlib.Path('/etc/hosts')
    +>>> p2 = pathlib.Path('/etc/../etc/hosts')
    +>>> p1.samefile(p2)
    +True
    +
    +
    +

    (Contributed by Vajrasky Kok and Antoine Pitrou in bpo-19775.)

    +

    The Path.mkdir() method now accepts a new optional +exist_ok argument to match mkdir -p and os.makedirs() +functionality. (Contributed by Berker Peksag in bpo-21539.)

    +

    There is a new Path.expanduser() method to +expand ~ and ~user prefixes. (Contributed by Serhiy Storchaka and +Claudiu Popa in bpo-19776.)

    +

    A new Path.home() class method can be used to get +a Path instance representing the user’s home +directory. +(Contributed by Victor Salgado and Mayank Tripathi in bpo-19777.)

    +

    New Path.write_text(), +Path.read_text(), +Path.write_bytes(), +Path.read_bytes() methods to simplify +read/write operations on files.

    +

    The following code snippet will create or rewrite existing file +~/spam42:

    +
    >>> import pathlib
    +>>> p = pathlib.Path('~/spam42')
    +>>> p.expanduser().write_text('ham')
    +3
    +
    +
    +

    (Contributed by Christopher Welborn in bpo-20218.)

    +
    +
    +

    pickle

    +

    Nested objects, such as unbound methods or nested classes, can now be pickled +using pickle protocols older than protocol version 4. +Protocol version 4 already supports these cases. (Contributed by Serhiy +Storchaka in bpo-23611.)

    +
    +
    +

    poplib

    +

    A new POP3.utf8() command enables RFC 6856 +(Internationalized Email) support, if a POP server supports it. +(Contributed by Milan OberKirch in bpo-21804.)

    +
    +
    +

    re

    +

    References and conditional references to groups with fixed length are now +allowed in lookbehind assertions:

    +
    >>> import re
    +>>> pat = re.compile(r'(a|b).(?<=\1)c')
    +>>> pat.match('aac')
    +<_sre.SRE_Match object; span=(0, 3), match='aac'>
    +>>> pat.match('bbc')
    +<_sre.SRE_Match object; span=(0, 3), match='bbc'>
    +
    +
    +

    (Contributed by Serhiy Storchaka in bpo-9179.)

    +

    The number of capturing groups in regular expressions is no longer limited to +100. (Contributed by Serhiy Storchaka in bpo-22437.)

    +

    The sub() and subn() functions now replace unmatched +groups with empty strings instead of raising an exception. +(Contributed by Serhiy Storchaka in bpo-1519638.)

    +

    The re.error exceptions have new attributes, +msg, pattern, +pos, lineno, +and colno, that provide better context +information about the error:

    +
    >>> re.compile("""
    +...     (?x)
    +...     .++
    +... """)
    +Traceback (most recent call last):
    +   ...
    +sre_constants.error: multiple repeat at position 16 (line 3, column 7)
    +
    +
    +

    (Contributed by Serhiy Storchaka in bpo-22578.)

    +
    +
    +

    readline

    +

    A new append_history_file() function can be used to append +the specified number of trailing elements in history to the given file. +(Contributed by Bruno Cauet in bpo-22940.)

    +
    +
    +

    selectors

    +

    The new DevpollSelector supports efficient +/dev/poll polling on Solaris. +(Contributed by Giampaolo Rodola’ in bpo-18931.)

    +
    +
    +

    shutil

    +

    The move() function now accepts a copy_function argument, +allowing, for example, the copy() function to be used instead of +the default copy2() if there is a need to ignore file metadata +when moving. +(Contributed by Claudiu Popa in bpo-19840.)

    +

    The make_archive() function now supports the xztar format. +(Contributed by Serhiy Storchaka in bpo-5411.)

    +
    +
    +

    signal

    +

    On Windows, the set_wakeup_fd() function now also supports +socket handles. (Contributed by Victor Stinner in bpo-22018.)

    +

    Various SIG* constants in the signal module have been converted into +Enums. This allows meaningful names to be printed +during debugging, instead of integer “magic numbers”. +(Contributed by Giampaolo Rodola’ in bpo-21076.)

    +
    +
    +

    smtpd

    +

    Both the SMTPServer and SMTPChannel classes now +accept a decode_data keyword argument to determine if the DATA portion of +the SMTP transaction is decoded using the "utf-8" codec or is instead +provided to the +SMTPServer.process_message() +method as a byte string. The default is True for backward compatibility +reasons, but will change to False in Python 3.6. If decode_data is set +to False, the process_message method must be prepared to accept keyword +arguments. +(Contributed by Maciej Szulik in bpo-19662.)

    +

    The SMTPServer class now advertises the 8BITMIME extension +(RFC 6152) if decode_data has been set True. If the client +specifies BODY=8BITMIME on the MAIL command, it is passed to +SMTPServer.process_message() +via the mail_options keyword. +(Contributed by Milan Oberkirch and R. David Murray in bpo-21795.)

    +

    The SMTPServer class now also supports the SMTPUTF8 +extension (RFC 6531: Internationalized Email). If the client specified +SMTPUTF8 BODY=8BITMIME on the MAIL command, they are passed to +SMTPServer.process_message() +via the mail_options keyword. It is the responsibility of the +process_message method to correctly handle the SMTPUTF8 data. +(Contributed by Milan Oberkirch in bpo-21725.)

    +

    It is now possible to provide, directly or via name resolution, IPv6 +addresses in the SMTPServer constructor, and have it +successfully connect. (Contributed by Milan Oberkirch in bpo-14758.)

    +
    +
    +

    smtplib

    +

    A new SMTP.auth() method provides a convenient way to +implement custom authentication mechanisms. (Contributed by Milan +Oberkirch in bpo-15014.)

    +

    The SMTP.set_debuglevel() method now +accepts an additional debuglevel (2), which enables timestamps in debug +messages. (Contributed by Gavin Chappell and Maciej Szulik in bpo-16914.)

    +

    Both the SMTP.sendmail() and +SMTP.send_message() methods now +support RFC 6531 (SMTPUTF8). +(Contributed by Milan Oberkirch and R. David Murray in bpo-22027.)

    +
    +
    +

    sndhdr

    +

    The what() and whathdr() functions now return +a namedtuple(). (Contributed by Claudiu Popa in +bpo-18615.)

    +
    +
    +

    socket

    +

    Functions with timeouts now use a monotonic clock, instead of a system clock. +(Contributed by Victor Stinner in bpo-22043.)

    +

    A new socket.sendfile() method allows +sending a file over a socket by using the high-performance os.sendfile() +function on UNIX, resulting in uploads being from 2 to 3 times faster than when +using plain socket.send(). +(Contributed by Giampaolo Rodola’ in bpo-17552.)

    +

    The socket.sendall() method no longer resets the +socket timeout every time bytes are received or sent. The socket timeout is +now the maximum total duration to send all data. +(Contributed by Victor Stinner in bpo-23853.)

    +

    The backlog argument of the socket.listen() +method is now optional. By default it is set to +SOMAXCONN or to 128, whichever is less. +(Contributed by Charles-François Natali in bpo-21455.)

    +
    +
    +

    ssl

    +
    +

    Memory BIO Support

    +

    (Contributed by Geert Jansen in bpo-21965.)

    +

    The new SSLObject class has been added to provide SSL protocol +support for cases when the network I/O capabilities of SSLSocket +are not necessary or are suboptimal. SSLObject represents +an SSL protocol instance, but does not implement any network I/O methods, and +instead provides a memory buffer interface. The new MemoryBIO +class can be used to pass data between Python and an SSL protocol instance.

    +

    The memory BIO SSL support is primarily intended to be used in frameworks +implementing asynchronous I/O for which SSLSocket’s readiness +model (“select/poll”) is inefficient.

    +

    A new SSLContext.wrap_bio() method can be used +to create a new SSLObject instance.

    +
    +
    +

    Application-Layer Protocol Negotiation Support

    +

    (Contributed by Benjamin Peterson in bpo-20188.)

    +

    Where OpenSSL support is present, the ssl module now implements +the Application-Layer Protocol Negotiation TLS extension as described +in RFC 7301.

    +

    The new SSLContext.set_alpn_protocols() +can be used to specify which protocols a socket should advertise during +the TLS handshake.

    +

    The new +SSLSocket.selected_alpn_protocol() +returns the protocol that was selected during the TLS handshake. +The HAS_ALPN flag indicates whether ALPN support is present.

    +
    +
    +

    Other Changes

    +

    There is a new SSLSocket.version() method to +query the actual protocol version in use. +(Contributed by Antoine Pitrou in bpo-20421.)

    +

    The SSLSocket class now implements +a SSLSocket.sendfile() method. +(Contributed by Giampaolo Rodola’ in bpo-17552.)

    +

    The SSLSocket.send() method now raises either +the ssl.SSLWantReadError or ssl.SSLWantWriteError exception on a +non-blocking socket if the operation would block. Previously, it would return +0. (Contributed by Nikolaus Rath in bpo-20951.)

    +

    The cert_time_to_seconds() function now interprets the input time +as UTC and not as local time, per RFC 5280. Additionally, the return +value is always an int. (Contributed by Akira Li in bpo-19940.)

    +

    New SSLObject.shared_ciphers() and +SSLSocket.shared_ciphers() methods return +the list of ciphers sent by the client during the handshake. +(Contributed by Benjamin Peterson in bpo-23186.)

    +

    The SSLSocket.do_handshake(), +SSLSocket.read(), +SSLSocket.shutdown(), and +SSLSocket.write() methods of the SSLSocket +class no longer reset the socket timeout every time bytes are received or sent. +The socket timeout is now the maximum total duration of the method. +(Contributed by Victor Stinner in bpo-23853.)

    +

    The match_hostname() function now supports matching of IP addresses. +(Contributed by Antoine Pitrou in bpo-23239.)

    +
    +
    +
    +

    sqlite3

    +

    The Row class now fully supports the sequence protocol, +in particular reversed() iteration and slice indexing. +(Contributed by Claudiu Popa in bpo-10203; by Lucas Sinclair, +Jessica McKellar, and Serhiy Storchaka in bpo-13583.)

    +
    +
    +

    subprocess

    +

    The new run() function has been added. +It runs the specified command and returns a +CompletedProcess object, which describes a finished +process. The new API is more consistent and is the recommended approach +to invoking subprocesses in Python code that does not need to maintain +compatibility with earlier Python versions. +(Contributed by Thomas Kluyver in bpo-23342.)

    +

    Examples:

    +
    >>> subprocess.run(["ls", "-l"])  # doesn't capture output
    +CompletedProcess(args=['ls', '-l'], returncode=0)
    +
    +>>> subprocess.run("exit 1", shell=True, check=True)
    +Traceback (most recent call last):
    +  ...
    +subprocess.CalledProcessError: Command 'exit 1' returned non-zero exit status 1
    +
    +>>> subprocess.run(["ls", "-l", "/dev/null"], stdout=subprocess.PIPE)
    +CompletedProcess(args=['ls', '-l', '/dev/null'], returncode=0,
    +stdout=b'crw-rw-rw- 1 root root 1, 3 Jan 23 16:23 /dev/null\n')
    +
    +
    +
    +
    +

    sys

    +

    A new set_coroutine_wrapper() function allows setting a global +hook that will be called whenever a coroutine object +is created by an async def function. A corresponding +get_coroutine_wrapper() can be used to obtain a currently set +wrapper. Both functions are provisional, +and are intended for debugging purposes only. (Contributed by Yury Selivanov +in bpo-24017.)

    +

    A new is_finalizing() function can be used to check if the Python +interpreter is shutting down. +(Contributed by Antoine Pitrou in bpo-22696.)

    +
    +
    +

    sysconfig

    +

    The name of the user scripts directory on Windows now includes the first +two components of the Python version. (Contributed by Paul Moore +in bpo-23437.)

    +
    +
    +

    tarfile

    +

    The mode argument of the open() function now accepts "x" +to request exclusive creation. (Contributed by Berker Peksag in bpo-21717.)

    +

    The TarFile.extractall() and +TarFile.extract() methods now take a keyword +argument numeric_owner. If set to True, the extracted files and +directories will be owned by the numeric uid and gid from the tarfile. +If set to False (the default, and the behavior in versions prior to 3.5), +they will be owned by the named user and group in the tarfile. +(Contributed by Michael Vogt and Eric Smith in bpo-23193.)

    +

    The TarFile.list() now accepts an optional +members keyword argument that can be set to a subset of the list returned +by TarFile.getmembers(). +(Contributed by Serhiy Storchaka in bpo-21549.)

    +
    +
    +

    threading

    +

    Both the Lock.acquire() and +RLock.acquire() methods +now use a monotonic clock for timeout management. +(Contributed by Victor Stinner in bpo-22043.)

    +
    +
    +

    time

    +

    The monotonic() function is now always available. +(Contributed by Victor Stinner in bpo-22043.)

    +
    +
    +

    timeit

    +

    A new command line option -u or --unit=U can be used to specify the time +unit for the timer output. Supported options are usec, msec, +or sec. (Contributed by Julian Gindi in bpo-18983.)

    +

    The timeit() function has a new globals parameter for +specifying the namespace in which the code will be running. +(Contributed by Ben Roberts in bpo-2527.)

    +
    +
    +

    tkinter

    +

    The tkinter._fix module used for setting up the Tcl/Tk environment +on Windows has been replaced by a private function in the _tkinter +module which makes no permanent changes to environment variables. +(Contributed by Zachary Ware in bpo-20035.)

    +
    +
    +

    traceback

    +

    New walk_stack() and walk_tb() +functions to conveniently traverse frame and traceback objects. +(Contributed by Robert Collins in bpo-17911.)

    +

    New lightweight classes: TracebackException, +StackSummary, and FrameSummary. +(Contributed by Robert Collins in bpo-17911.)

    +

    Both the print_tb() and print_stack() functions +now support negative values for the limit argument. +(Contributed by Dmitry Kazakov in bpo-22619.)

    +
    +
    +

    types

    +

    A new coroutine() function to transform +generator and +generator-like objects into +awaitables. +(Contributed by Yury Selivanov in bpo-24017.)

    +

    A new type called CoroutineType, which is used for +coroutine objects created by async def functions. +(Contributed by Yury Selivanov in bpo-24400.)

    +
    +
    +

    unicodedata

    +

    The unicodedata module now uses data from Unicode 8.0.0.

    +
    +
    +

    unittest

    +

    The TestLoader.loadTestsFromModule() +method now accepts a keyword-only argument pattern which is passed to +load_tests as the third argument. Found packages are now checked for +load_tests regardless of whether their path matches pattern, because it +is impossible for a package name to match the default pattern. +(Contributed by Robert Collins and Barry A. Warsaw in bpo-16662.)

    +

    Unittest discovery errors now are exposed in the +TestLoader.errors attribute of the +TestLoader instance. +(Contributed by Robert Collins in bpo-19746.)

    +

    A new command line option --locals to show local variables in +tracebacks. (Contributed by Robert Collins in bpo-22936.)

    +
    +
    +

    unittest.mock

    +

    The Mock class has the following improvements:

    +
      +
    • The class constructor has a new unsafe parameter, which causes mock +objects to raise AttributeError on attribute names starting +with "assert". +(Contributed by Kushal Das in bpo-21238.)

    • +
    • A new Mock.assert_not_called() +method to check if the mock object was called. +(Contributed by Kushal Das in bpo-21262.)

    • +
    +

    The MagicMock class now supports __truediv__(), +__divmod__() and __matmul__() operators. +(Contributed by Johannes Baiter in bpo-20968, and Håkan Lövdahl +in bpo-23581 and bpo-23568.)

    +

    It is no longer necessary to explicitly pass create=True to the +patch() function when patching builtin names. +(Contributed by Kushal Das in bpo-17660.)

    +
    +
    +

    urllib

    +

    A new +request.HTTPPasswordMgrWithPriorAuth +class allows HTTP Basic Authentication credentials to be managed so as to +eliminate unnecessary 401 response handling, or to unconditionally send +credentials on the first request in order to communicate with servers that +return a 404 response instead of a 401 if the Authorization header +is not sent. (Contributed by Matej Cepl in bpo-19494 and Akshit Khurana in +bpo-7159.)

    +

    A new quote_via argument for the +parse.urlencode() +function provides a way to control the encoding of query parts if needed. +(Contributed by Samwyse and Arnon Yaari in bpo-13866.)

    +

    The request.urlopen() function accepts an +ssl.SSLContext object as a context argument, which will be used for +the HTTPS connection. (Contributed by Alex Gaynor in bpo-22366.)

    +

    The parse.urljoin() was updated to use the +RFC 3986 semantics for the resolution of relative URLs, rather than +RFC 1808 and RFC 2396. +(Contributed by Demian Brecht and Senthil Kumaran in bpo-22118.)

    +
    +
    +

    wsgiref

    +

    The headers argument of the headers.Headers +class constructor is now optional. +(Contributed by Pablo Torres Navarrete and SilentGhost in bpo-5800.)

    +
    +
    +

    xmlrpc

    +

    The client.ServerProxy class now supports +the context manager protocol. +(Contributed by Claudiu Popa in bpo-20627.)

    +

    The client.ServerProxy constructor now accepts +an optional ssl.SSLContext instance. +(Contributed by Alex Gaynor in bpo-22960.)

    +
    +
    +

    xml.sax

    +

    SAX parsers now support a character stream of the +xmlreader.InputSource object. +(Contributed by Serhiy Storchaka in bpo-2175.)

    +

    parseString() now accepts a str instance. +(Contributed by Serhiy Storchaka in bpo-10590.)

    +
    +
    +

    zipfile

    +

    ZIP output can now be written to unseekable streams. +(Contributed by Serhiy Storchaka in bpo-23252.)

    +

    The mode argument of ZipFile.open() method now +accepts "x" to request exclusive creation. +(Contributed by Serhiy Storchaka in bpo-21717.)

    +
    +
    +
    +

    Other module-level changes

    +

    Many functions in the mmap, ossaudiodev, socket, +ssl, and codecs modules now accept writable +bytes-like objects. +(Contributed by Serhiy Storchaka in bpo-23001.)

    +
    +
    +

    Optimizations

    +

    The os.walk() function has been sped up by 3 to 5 times on POSIX systems, +and by 7 to 20 times on Windows. This was done using the new os.scandir() +function, which exposes file information from the underlying readdir or +FindFirstFile/FindNextFile system calls. (Contributed by +Ben Hoyt with help from Victor Stinner in bpo-23605.)

    +

    Construction of bytes(int) (filled by zero bytes) is faster and uses less +memory for large objects. calloc() is used instead of malloc() to +allocate memory for these objects. +(Contributed by Victor Stinner in bpo-21233.)

    +

    Some operations on ipaddress IPv4Network and +IPv6Network have been massively sped up, such as +subnets(), supernet(), +summarize_address_range(), collapse_addresses(). +The speed up can range from 3 to 15 times. +(Contributed by Antoine Pitrou, Michel Albert, and Markus in +bpo-21486, bpo-21487, bpo-20826, bpo-23266.)

    +

    Pickling of ipaddress objects was optimized to produce significantly +smaller output. (Contributed by Serhiy Storchaka in bpo-23133.)

    +

    Many operations on io.BytesIO are now 50% to 100% faster. +(Contributed by Serhiy Storchaka in bpo-15381 and David Wilson in +bpo-22003.)

    +

    The marshal.dumps() function is now faster: 65–85% with versions 3 +and 4, 20–25% with versions 0 to 2 on typical data, and up to 5 times in +best cases. +(Contributed by Serhiy Storchaka in bpo-20416 and bpo-23344.)

    +

    The UTF-32 encoder is now 3 to 7 times faster. +(Contributed by Serhiy Storchaka in bpo-15027.)

    +

    Regular expressions are now parsed up to 10% faster. +(Contributed by Serhiy Storchaka in bpo-19380.)

    +

    The json.dumps() function was optimized to run with +ensure_ascii=False as fast as with ensure_ascii=True. +(Contributed by Naoki Inada in bpo-23206.)

    +

    The PyObject_IsInstance() and PyObject_IsSubclass() +functions have been sped up in the common case that the second argument +has type as its metaclass. +(Contributed Georg Brandl by in bpo-22540.)

    +

    Method caching was slightly improved, yielding up to 5% performance +improvement in some benchmarks. +(Contributed by Antoine Pitrou in bpo-22847.)

    +

    Objects from the random module now use 50% less memory on 64-bit +builds. (Contributed by Serhiy Storchaka in bpo-23488.)

    +

    The property() getter calls are up to 25% faster. +(Contributed by Joe Jevnik in bpo-23910.)

    +

    Instantiation of fractions.Fraction is now up to 30% faster. +(Contributed by Stefan Behnel in bpo-22464.)

    +

    String methods find(), rfind(), split(), +partition() and the in string operator are now significantly +faster for searching 1-character substrings. +(Contributed by Serhiy Storchaka in bpo-23573.)

    +
    +
    +

    Build and C API Changes

    +

    New calloc functions were added:

    + +

    (Contributed by Victor Stinner in bpo-21233.)

    +

    New encoding/decoding helper functions:

    + +

    (Contributed by Victor Stinner in bpo-18395.)

    +

    A new PyCodec_NameReplaceErrors() function to replace the unicode +encode error with \N{...} escapes. +(Contributed by Serhiy Storchaka in bpo-19676.)

    +

    A new PyErr_FormatV() function similar to PyErr_Format(), +but accepts a va_list argument. +(Contributed by Antoine Pitrou in bpo-18711.)

    +

    A new PyExc_RecursionError exception. +(Contributed by Georg Brandl in bpo-19235.)

    +

    New PyModule_FromDefAndSpec(), PyModule_FromDefAndSpec2(), +and PyModule_ExecDef() functions introduced by PEP 489 – +multi-phase extension module initialization. +(Contributed by Petr Viktorin in bpo-24268.)

    +

    New PyNumber_MatrixMultiply() and +PyNumber_InPlaceMatrixMultiply() functions to perform matrix +multiplication. +(Contributed by Benjamin Peterson in bpo-21176. See also PEP 465 +for details.)

    +

    The PyTypeObject.tp_finalize slot is now part of the stable ABI.

    +

    Windows builds now require Microsoft Visual C++ 14.0, which +is available as part of Visual Studio 2015.

    +

    Extension modules now include a platform information tag in their filename on +some platforms (the tag is optional, and CPython will import extensions without +it, although if the tag is present and mismatched, the extension won’t be +loaded):

    +
      +
    • On Linux, extension module filenames end with +.cpython-<major><minor>m-<architecture>-<os>.pyd:

      +
        +
      • <major> is the major number of the Python version; +for Python 3.5 this is 3.

      • +
      • <minor> is the minor number of the Python version; +for Python 3.5 this is 5.

      • +
      • <architecture> is the hardware architecture the extension module +was built to run on. It’s most commonly either i386 for 32-bit Intel +platforms or x86_64 for 64-bit Intel (and AMD) platforms.

      • +
      • <os> is always linux-gnu, except for extensions built to +talk to the 32-bit ABI on 64-bit platforms, in which case it is +linux-gnu32 (and <architecture> will be x86_64).

      • +
      +
    • +
    • On Windows, extension module filenames end with +<debug>.cp<major><minor>-<platform>.pyd:

      +
        +
      • <major> is the major number of the Python version; +for Python 3.5 this is 3.

      • +
      • <minor> is the minor number of the Python version; +for Python 3.5 this is 5.

      • +
      • <platform> is the platform the extension module was built for, +either win32 for Win32, win_amd64 for Win64, win_ia64 for +Windows Itanium 64, and win_arm for Windows on ARM.

      • +
      • If built in debug mode, <debug> will be _d, +otherwise it will be blank.

      • +
      +
    • +
    • On OS X platforms, extension module filenames now end with -darwin.so.

    • +
    • On all other platforms, extension module filenames are the same as they were +with Python 3.4.

    • +
    +
    +
    +

    Deprecated

    +
    +

    New Keywords

    +

    async and await are not recommended to be used as variable, class, +function or module names. Introduced by PEP 492 in Python 3.5, they will +become proper keywords in Python 3.7.

    +
    +
    +

    Deprecated Python Behavior

    +

    Raising the StopIteration exception inside a generator will now generate a silent +PendingDeprecationWarning, which will become a non-silent deprecation +warning in Python 3.6 and will trigger a RuntimeError in Python 3.7. +See PEP 479: Change StopIteration handling inside generators +for details.

    +
    +
    +

    Unsupported Operating Systems

    +

    Windows XP is no longer supported by Microsoft, thus, per PEP 11, CPython +3.5 is no longer officially supported on this OS.

    +
    +
    +

    Deprecated Python modules, functions and methods

    +

    The formatter module has now graduated to full deprecation and is still +slated for removal in Python 3.6.

    +

    The asyncio.async() function is deprecated in favor of +ensure_future().

    +

    The smtpd module has in the past always decoded the DATA portion of +email messages using the utf-8 codec. This can now be controlled by the +new decode_data keyword to SMTPServer. The default value is +True, but this default is deprecated. Specify the decode_data keyword +with an appropriate value to avoid the deprecation warning.

    +

    Directly assigning values to the key, +value and +coded_value of http.cookies.Morsel +objects is deprecated. Use the set() method +instead. In addition, the undocumented LegalChars parameter of +set() is deprecated, and is now ignored.

    +

    Passing a format string as keyword argument format_string to the +format() method of the string.Formatter +class has been deprecated. +(Contributed by Serhiy Storchaka in bpo-23671.)

    +

    The platform.dist() and platform.linux_distribution() functions +are now deprecated. Linux distributions use too many different ways of +describing themselves, so the functionality is left to a package. +(Contributed by Vajrasky Kok and Berker Peksag in bpo-1322.)

    +

    The previously undocumented from_function and from_builtin methods of +inspect.Signature are deprecated. Use the new +Signature.from_callable() +method instead. (Contributed by Yury Selivanov in bpo-24248.)

    +

    The inspect.getargspec() function is deprecated and scheduled to be +removed in Python 3.6. (See bpo-20438 for details.)

    +

    The inspect getfullargspec(), +getcallargs(), and formatargspec() functions are +deprecated in favor of the inspect.signature() API. (Contributed by Yury +Selivanov in bpo-20438.)

    +

    getargvalues() and formatargvalues() functions +were inadvertently marked as deprecated with the release of Python 3.5.0.

    +

    Use of re.LOCALE flag with str patterns or re.ASCII is now +deprecated. (Contributed by Serhiy Storchaka in bpo-22407.)

    +

    Use of unrecognized special sequences consisting of '\' and an ASCII letter +in regular expression patterns and replacement patterns now raises a +deprecation warning and will be forbidden in Python 3.6. +(Contributed by Serhiy Storchaka in bpo-23622.)

    +

    The undocumented and unofficial use_load_tests default argument of the +unittest.TestLoader.loadTestsFromModule() method now is +deprecated and ignored. +(Contributed by Robert Collins and Barry A. Warsaw in bpo-16662.)

    +
    +
    +
    +

    Removed

    +
    +

    API and Feature Removals

    +

    The following obsolete and previously deprecated APIs and features have been +removed:

    +
      +
    • The __version__ attribute has been dropped from the email package. The +email code hasn’t been shipped separately from the stdlib for a long time, +and the __version__ string was not updated in the last few releases.

    • +
    • The internal Netrc class in the ftplib module was deprecated in +3.4, and has now been removed. +(Contributed by Matt Chaput in bpo-6623.)

    • +
    • The concept of .pyo files has been removed.

    • +
    • The JoinableQueue class in the provisional asyncio module was +deprecated in 3.4.4 and is now removed. +(Contributed by A. Jesse Jiryu Davis in bpo-23464.)

    • +
    +
    +
    +
    +

    Porting to Python 3.5

    +

    This section lists previously described changes and other bugfixes +that may require changes to your code.

    +
    +

    Changes in Python behavior

    +
      +
    • Due to an oversight, earlier Python versions erroneously accepted the +following syntax:

      +
      f(1 for x in [1], *args)
      +f(1 for x in [1], **kwargs)
      +
      +
      +

      Python 3.5 now correctly raises a SyntaxError, as generator +expressions must be put in parentheses if not a sole argument to a function.

      +
    • +
    +
    +
    +

    Changes in the Python API

    +
      +
    • PEP 475: System calls are now retried when interrupted by a signal instead +of raising InterruptedError if the Python signal handler does not +raise an exception.

    • +
    • Before Python 3.5, a datetime.time object was considered to be false +if it represented midnight in UTC. This behavior was considered obscure and +error-prone and has been removed in Python 3.5. See bpo-13936 for full +details.

    • +
    • The ssl.SSLSocket.send() method now raises either +ssl.SSLWantReadError or ssl.SSLWantWriteError +on a non-blocking socket if the operation would block. Previously, +it would return 0. (Contributed by Nikolaus Rath in bpo-20951.)

    • +
    • The __name__ attribute of generators is now set from the function name, +instead of being set from the code name. Use gen.gi_code.co_name to +retrieve the code name. Generators also have a new __qualname__ +attribute, the qualified name, which is now used for the representation +of a generator (repr(gen)). +(Contributed by Victor Stinner in bpo-21205.)

    • +
    • The deprecated “strict” mode and argument of HTMLParser, +HTMLParser.error(), and the HTMLParserError exception have been +removed. (Contributed by Ezio Melotti in bpo-15114.) +The convert_charrefs argument of HTMLParser is +now True by default. (Contributed by Berker Peksag in bpo-21047.)

    • +
    • Although it is not formally part of the API, it is worth noting for porting +purposes (ie: fixing tests) that error messages that were previously of the +form “‘sometype’ does not support the buffer protocol” are now of the form “a +bytes-like object is required, not ‘sometype’”. +(Contributed by Ezio Melotti in bpo-16518.)

    • +
    • If the current directory is set to a directory that no longer exists then +FileNotFoundError will no longer be raised and instead +find_spec() will return None +without caching None in sys.path_importer_cache, which is +different than the typical case (bpo-22834).

    • +
    • HTTP status code and messages from http.client and http.server +were refactored into a common HTTPStatus enum. The values in +http.client and http.server remain available for backwards +compatibility. (Contributed by Demian Brecht in bpo-21793.)

    • +
    • When an import loader defines importlib.machinery.Loader.exec_module() +it is now expected to also define +create_module() (raises a +DeprecationWarning now, will be an error in Python 3.6). If the loader +inherits from importlib.abc.Loader then there is nothing to do, else +simply define create_module() to return +None. (Contributed by Brett Cannon in bpo-23014.)

    • +
    • The re.split() function always ignored empty pattern matches, so the +"x*" pattern worked the same as "x+", and the "\b" pattern never +worked. Now re.split() raises a warning if the pattern could match +an empty string. For compatibility, use patterns that never match an empty +string (e.g. "x+" instead of "x*"). Patterns that could only match +an empty string (such as "\b") now raise an error. +(Contributed by Serhiy Storchaka in bpo-22818.)

    • +
    • The http.cookies.Morsel dict-like interface has been made self +consistent: morsel comparison now takes the key +and value into account, +copy() now results in a +Morsel instance rather than a dict, and +update() will now raise an exception if any of the +keys in the update dictionary are invalid. In addition, the undocumented +LegalChars parameter of set() is deprecated and +is now ignored. (Contributed by Demian Brecht in bpo-2211.)

    • +
    • PEP 488 has removed .pyo files from Python and introduced the optional +opt- tag in .pyc file names. The +importlib.util.cache_from_source() has gained an optimization +parameter to help control the opt- tag. Because of this, the +debug_override parameter of the function is now deprecated. .pyo files +are also no longer supported as a file argument to the Python interpreter and +thus serve no purpose when distributed on their own (i.e. sourceless code +distribution). Due to the fact that the magic number for bytecode has changed +in Python 3.5, all old .pyo files from previous versions of Python are +invalid regardless of this PEP.

    • +
    • The socket module now exports the CAN_RAW_FD_FRAMES +constant on linux 3.6 and greater.

    • +
    • The ssl.cert_time_to_seconds() function now interprets the input time +as UTC and not as local time, per RFC 5280. Additionally, the return +value is always an int. (Contributed by Akira Li in bpo-19940.)

    • +
    • The pygettext.py Tool now uses the standard +NNNN format for timezones in +the POT-Creation-Date header.

    • +
    • The smtplib module now uses sys.stderr instead of the previous +module-level stderr variable for debug output. If your (test) +program depends on patching the module-level variable to capture the debug +output, you will need to update it to capture sys.stderr instead.

    • +
    • The str.startswith() and str.endswith() methods no longer return +True when finding the empty string and the indexes are completely out of +range. (Contributed by Serhiy Storchaka in bpo-24284.)

    • +
    • The inspect.getdoc() function now returns documentation strings +inherited from base classes. Documentation strings no longer need to be +duplicated if the inherited documentation is appropriate. To suppress an +inherited string, an empty string must be specified (or the documentation +may be filled in). This change affects the output of the pydoc +module and the help() function. +(Contributed by Serhiy Storchaka in bpo-15582.)

    • +
    • Nested functools.partial() calls are now flattened. If you were +relying on the previous behavior, you can now either add an attribute to a +functools.partial() object or you can create a subclass of +functools.partial(). +(Contributed by Alexander Belopolsky in bpo-7830.)

    • +
    +
    +
    +

    Changes in the C API

    +
      +
    • The undocumented format member of the +(non-public) PyMemoryViewObject structure has been removed. +All extensions relying on the relevant parts in memoryobject.h +must be rebuilt.

    • +
    • The PyMemAllocator structure was renamed to +PyMemAllocatorEx and a new calloc field was added.

    • +
    • Removed non-documented macro PyObject_REPR which leaked references. +Use format character %R in PyUnicode_FromFormat()-like functions +to format the repr() of the object. +(Contributed by Serhiy Storchaka in bpo-22453.)

    • +
    • Because the lack of the __module__ attribute breaks pickling and +introspection, a deprecation warning is now raised for builtin types without +the __module__ attribute. This would be an AttributeError in +the future. +(Contributed by Serhiy Storchaka in bpo-20204.)

    • +
    • As part of the PEP 492 implementation, the tp_reserved slot of +PyTypeObject was replaced with a +tp_as_async slot. Refer to Coroutine Objects for +new types, structures and functions.

    • +
    +
    +
    +
    +

    Notable changes in Python 3.5.4

    +
    +

    New make regen-all build target

    +

    To simplify cross-compilation, and to ensure that CPython can reliably be +compiled without requiring an existing version of Python to already be +available, the autotools-based build system no longer attempts to implicitly +recompile generated files based on file modification times.

    +

    Instead, a new make regen-all command has been added to force regeneration +of these files when desired (e.g. after an initial version of Python has +already been built based on the pregenerated versions).

    +

    More selective regeneration targets are also defined - see +Makefile.pre.in for details.

    +

    (Contributed by Victor Stinner in bpo-23404.)

    +
    +

    New in version 3.5.4.

    +
    +
    +
    +

    Removal of make touch build target

    +

    The make touch build target previously used to request implicit regeneration +of generated files by updating their modification times has been removed.

    +

    It has been replaced by the new make regen-all target.

    +

    (Contributed by Victor Stinner in bpo-23404.)

    +
    +

    Changed in version 3.5.4.

    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/whatsnew/3.6.html b/python-3.7.4-docs-html/whatsnew/3.6.html new file mode 100644 index 0000000..b20bc6c --- /dev/null +++ b/python-3.7.4-docs-html/whatsnew/3.6.html @@ -0,0 +1,2265 @@ + + + + + + + What’s New In Python 3.6 — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    What’s New In Python 3.6

    +
    +
    Editors
    +

    Elvis Pranskevichus <elvis@magic.io>, Yury Selivanov <yury@magic.io>

    +
    +
    +

    This article explains the new features in Python 3.6, compared to 3.5. +Python 3.6 was released on December 23, 2016.  See the +changelog for a full +list of changes.

    +
    +

    See also

    +

    PEP 494 - Python 3.6 Release Schedule

    +
    +
    +

    Summary – Release highlights

    +

    New syntax features:

    +
      +
    • PEP 498, formatted string literals.

    • +
    • PEP 515, underscores in numeric literals.

    • +
    • PEP 526, syntax for variable annotations.

    • +
    • PEP 525, asynchronous generators.

    • +
    • PEP 530: asynchronous comprehensions.

    • +
    +

    New library modules:

    + +

    CPython implementation improvements:

    + +

    Significant improvements in the standard library:

    +
      +
    • The asyncio module has received new features, significant +usability and performance improvements, and a fair amount of bug fixes. +Starting with Python 3.6 the asyncio module is no longer provisional +and its API is considered stable.

    • +
    • A new file system path protocol has been +implemented to support path-like objects. +All standard library functions operating on paths have been updated to +work with the new protocol.

    • +
    • The datetime module has gained support for +Local Time Disambiguation.

    • +
    • The typing module received a number of +improvements.

    • +
    • The tracemalloc module has been significantly reworked +and is now used to provide better output for ResourceWarning +as well as provide better diagnostics for memory allocation errors. +See the PYTHONMALLOC section for more +information.

    • +
    +

    Security improvements:

    +
      +
    • The new secrets module has been added to simplify the generation of +cryptographically strong pseudo-random numbers suitable for +managing secrets such as account authentication, tokens, and similar.

    • +
    • On Linux, os.urandom() now blocks until the system urandom entropy +pool is initialized to increase the security. See the PEP 524 for the +rationale.

    • +
    • The hashlib and ssl modules now support OpenSSL 1.1.0.

    • +
    • The default settings and feature set of the ssl module have been +improved.

    • +
    • The hashlib module received support for the BLAKE2, SHA-3 and SHAKE +hash algorithms and the scrypt() key derivation function.

    • +
    +

    Windows improvements:

    +
      +
    • PEP 528 and PEP 529, +Windows filesystem and console encoding changed to UTF-8.

    • +
    • The py.exe launcher, when used interactively, no longer prefers +Python 2 over Python 3 when the user doesn’t specify a version (via +command line arguments or a config file). Handling of shebang lines +remains unchanged - “python” refers to Python 2 in that case.

    • +
    • python.exe and pythonw.exe have been marked as long-path aware, +which means that the 260 character path limit may no longer apply. +See removing the MAX_PATH limitation for details.

    • +
    • A ._pth file can be added to force isolated mode and fully specify +all search paths to avoid registry and environment lookup. See +the documentation for more information.

    • +
    • A python36.zip file now works as a landmark to infer +PYTHONHOME. See the documentation for +more information.

    • +
    +
    +
    +

    New Features

    +
    +

    PEP 498: Formatted string literals

    +

    PEP 498 introduces a new kind of string literals: f-strings, or +formatted string literals.

    +

    Formatted string literals are prefixed with 'f' and are similar to +the format strings accepted by str.format(). They contain replacement +fields surrounded by curly braces. The replacement fields are expressions, +which are evaluated at run time, and then formatted using the +format() protocol:

    +
    >>> name = "Fred"
    +>>> f"He said his name is {name}."
    +'He said his name is Fred.'
    +>>> width = 10
    +>>> precision = 4
    +>>> value = decimal.Decimal("12.34567")
    +>>> f"result: {value:{width}.{precision}}"  # nested fields
    +'result:      12.35'
    +
    +
    +
    +

    See also

    +
    +
    PEP 498 – Literal String Interpolation.

    PEP written and implemented by Eric V. Smith.

    +
    +
    +

    Feature documentation.

    +
    +
    +
    +

    PEP 526: Syntax for variable annotations

    +

    PEP 484 introduced the standard for type annotations of function +parameters, a.k.a. type hints. This PEP adds syntax to Python for annotating +the types of variables including class variables and instance variables:

    +
    primes: List[int] = []
    +
    +captain: str  # Note: no initial value!
    +
    +class Starship:
    +    stats: Dict[str, int] = {}
    +
    +
    +

    Just as for function annotations, the Python interpreter does not attach any +particular meaning to variable annotations and only stores them in the +__annotations__ attribute of a class or module.

    +

    In contrast to variable declarations in statically typed languages, +the goal of annotation syntax is to provide an easy way to specify structured +type metadata for third party tools and libraries via the abstract syntax tree +and the __annotations__ attribute.

    +
    +

    See also

    +
    +
    PEP 526 – Syntax for variable annotations.

    PEP written by Ryan Gonzalez, Philip House, Ivan Levkivskyi, Lisa Roach, +and Guido van Rossum. Implemented by Ivan Levkivskyi.

    +
    +
    +

    Tools that use or will use the new syntax: +mypy, +pytype, PyCharm, etc.

    +
    +
    +
    +

    PEP 515: Underscores in Numeric Literals

    +

    PEP 515 adds the ability to use underscores in numeric literals for +improved readability. For example:

    +
    >>> 1_000_000_000_000_000
    +1000000000000000
    +>>> 0x_FF_FF_FF_FF
    +4294967295
    +
    +
    +

    Single underscores are allowed between digits and after any base +specifier. Leading, trailing, or multiple underscores in a row are not +allowed.

    +

    The string formatting language also now has support +for the '_' option to signal the use of an underscore for a thousands +separator for floating point presentation types and for integer +presentation type 'd'. For integer presentation types 'b', +'o', 'x', and 'X', underscores will be inserted every 4 +digits:

    +
    >>> '{:_}'.format(1000000)
    +'1_000_000'
    +>>> '{:_x}'.format(0xFFFFFFFF)
    +'ffff_ffff'
    +
    +
    +
    +

    See also

    +
    +
    PEP 515 – Underscores in Numeric Literals

    PEP written by Georg Brandl and Serhiy Storchaka.

    +
    +
    +
    +
    +
    +

    PEP 525: Asynchronous Generators

    +

    PEP 492 introduced support for native coroutines and async / await +syntax to Python 3.5. A notable limitation of the Python 3.5 implementation +is that it was not possible to use await and yield in the same +function body. In Python 3.6 this restriction has been lifted, making it +possible to define asynchronous generators:

    +
    async def ticker(delay, to):
    +    """Yield numbers from 0 to *to* every *delay* seconds."""
    +    for i in range(to):
    +        yield i
    +        await asyncio.sleep(delay)
    +
    +
    +

    The new syntax allows for faster and more concise code.

    +
    +

    See also

    +
    +
    PEP 525 – Asynchronous Generators

    PEP written and implemented by Yury Selivanov.

    +
    +
    +
    +
    +
    +

    PEP 530: Asynchronous Comprehensions

    +

    PEP 530 adds support for using async for in list, set, dict +comprehensions and generator expressions:

    +
    result = [i async for i in aiter() if i % 2]
    +
    +
    +

    Additionally, await expressions are supported in all kinds +of comprehensions:

    +
    result = [await fun() for fun in funcs if await condition()]
    +
    +
    +
    +

    See also

    +
    +
    PEP 530 – Asynchronous Comprehensions

    PEP written and implemented by Yury Selivanov.

    +
    +
    +
    +
    +
    +

    PEP 487: Simpler customization of class creation

    +

    It is now possible to customize subclass creation without using a metaclass. +The new __init_subclass__ classmethod will be called on the base class +whenever a new subclass is created:

    +
    class PluginBase:
    +    subclasses = []
    +
    +    def __init_subclass__(cls, **kwargs):
    +        super().__init_subclass__(**kwargs)
    +        cls.subclasses.append(cls)
    +
    +class Plugin1(PluginBase):
    +    pass
    +
    +class Plugin2(PluginBase):
    +    pass
    +
    +
    +

    In order to allow zero-argument super() calls to work correctly from +__init_subclass__() implementations, custom metaclasses must +ensure that the new __classcell__ namespace entry is propagated to +type.__new__ (as described in Creating the class object).

    +
    +

    See also

    +
    +
    PEP 487 – Simpler customization of class creation

    PEP written and implemented by Martin Teichmann.

    +
    +
    +

    Feature documentation

    +
    +
    +
    +

    PEP 487: Descriptor Protocol Enhancements

    +

    PEP 487 extends the descriptor protocol to include the new optional +__set_name__() method. Whenever a new class is defined, the new +method will be called on all descriptors included in the definition, providing +them with a reference to the class being defined and the name given to the +descriptor within the class namespace. In other words, instances of +descriptors can now know the attribute name of the descriptor in the +owner class:

    +
    class IntField:
    +    def __get__(self, instance, owner):
    +        return instance.__dict__[self.name]
    +
    +    def __set__(self, instance, value):
    +        if not isinstance(value, int):
    +            raise ValueError(f'expecting integer in {self.name}')
    +        instance.__dict__[self.name] = value
    +
    +    # this is the new initializer:
    +    def __set_name__(self, owner, name):
    +        self.name = name
    +
    +class Model:
    +    int_field = IntField()
    +
    +
    +
    +

    See also

    +
    +
    PEP 487 – Simpler customization of class creation

    PEP written and implemented by Martin Teichmann.

    +
    +
    +

    Feature documentation

    +
    +
    +
    +

    PEP 519: Adding a file system path protocol

    +

    File system paths have historically been represented as str +or bytes objects. This has led to people who write code which +operate on file system paths to assume that such objects are only one +of those two types (an int representing a file descriptor +does not count as that is not a file path). Unfortunately that +assumption prevents alternative object representations of file system +paths like pathlib from working with pre-existing code, +including Python’s standard library.

    +

    To fix this situation, a new interface represented by +os.PathLike has been defined. By implementing the +__fspath__() method, an object signals that it +represents a path. An object can then provide a low-level +representation of a file system path as a str or +bytes object. This means an object is considered +path-like if it implements +os.PathLike or is a str or bytes object +which represents a file system path. Code can use os.fspath(), +os.fsdecode(), or os.fsencode() to explicitly get a +str and/or bytes representation of a path-like +object.

    +

    The built-in open() function has been updated to accept +os.PathLike objects, as have all relevant functions in the +os and os.path modules, and most other functions and +classes in the standard library. The os.DirEntry class +and relevant classes in pathlib have also been updated to +implement os.PathLike.

    +

    The hope is that updating the fundamental functions for operating +on file system paths will lead to third-party code to implicitly +support all path-like objects without any +code changes, or at least very minimal ones (e.g. calling +os.fspath() at the beginning of code before operating on a +path-like object).

    +

    Here are some examples of how the new interface allows for +pathlib.Path to be used more easily and transparently with +pre-existing code:

    +
    >>> import pathlib
    +>>> with open(pathlib.Path("README")) as f:
    +...     contents = f.read()
    +...
    +>>> import os.path
    +>>> os.path.splitext(pathlib.Path("some_file.txt"))
    +('some_file', '.txt')
    +>>> os.path.join("/a/b", pathlib.Path("c"))
    +'/a/b/c'
    +>>> import os
    +>>> os.fspath(pathlib.Path("some_file.txt"))
    +'some_file.txt'
    +
    +
    +

    (Implemented by Brett Cannon, Ethan Furman, Dusty Phillips, and Jelle Zijlstra.)

    +
    +

    See also

    +
    +
    PEP 519 – Adding a file system path protocol

    PEP written by Brett Cannon and Koos Zevenhoven.

    +
    +
    +
    +
    +
    +

    PEP 495: Local Time Disambiguation

    +

    In most world locations, there have been and will be times when local clocks +are moved back. In those times, intervals are introduced in which local +clocks show the same time twice in the same day. In these situations, the +information displayed on a local clock (or stored in a Python datetime +instance) is insufficient to identify a particular moment in time.

    +

    PEP 495 adds the new fold attribute to instances of +datetime.datetime and datetime.time classes to differentiate +between two moments in time for which local times are the same:

    +
    >>> u0 = datetime(2016, 11, 6, 4, tzinfo=timezone.utc)
    +>>> for i in range(4):
    +...     u = u0 + i*HOUR
    +...     t = u.astimezone(Eastern)
    +...     print(u.time(), 'UTC =', t.time(), t.tzname(), t.fold)
    +...
    +04:00:00 UTC = 00:00:00 EDT 0
    +05:00:00 UTC = 01:00:00 EDT 0
    +06:00:00 UTC = 01:00:00 EST 1
    +07:00:00 UTC = 02:00:00 EST 0
    +
    +
    +

    The values of the fold attribute have the +value 0 for all instances except those that represent the second +(chronologically) moment in time in an ambiguous case.

    +
    +

    See also

    +
    +
    PEP 495 – Local Time Disambiguation

    PEP written by Alexander Belopolsky and Tim Peters, implementation +by Alexander Belopolsky.

    +
    +
    +
    +
    +
    +

    PEP 529: Change Windows filesystem encoding to UTF-8

    +

    Representing filesystem paths is best performed with str (Unicode) rather than +bytes. However, there are some situations where using bytes is sufficient and +correct.

    +

    Prior to Python 3.6, data loss could result when using bytes paths on Windows. +With this change, using bytes to represent paths is now supported on Windows, +provided those bytes are encoded with the encoding returned by +sys.getfilesystemencoding(), which now defaults to 'utf-8'.

    +

    Applications that do not use str to represent paths should use +os.fsencode() and os.fsdecode() to ensure their bytes are +correctly encoded. To revert to the previous behaviour, set +PYTHONLEGACYWINDOWSFSENCODING or call +sys._enablelegacywindowsfsencoding().

    +

    See PEP 529 for more information and discussion of code modifications that +may be required.

    +
    +
    +

    PEP 528: Change Windows console encoding to UTF-8

    +

    The default console on Windows will now accept all Unicode characters and +provide correctly read str objects to Python code. sys.stdin, +sys.stdout and sys.stderr now default to utf-8 encoding.

    +

    This change only applies when using an interactive console, and not when +redirecting files or pipes. To revert to the previous behaviour for interactive +console use, set PYTHONLEGACYWINDOWSSTDIO.

    +
    +

    See also

    +
    +
    PEP 528 – Change Windows console encoding to UTF-8

    PEP written and implemented by Steve Dower.

    +
    +
    +
    +
    +
    +

    PEP 520: Preserving Class Attribute Definition Order

    +

    Attributes in a class definition body have a natural ordering: the same +order in which the names appear in the source. This order is now +preserved in the new class’s __dict__ attribute.

    +

    Also, the effective default class execution namespace (returned from +type.__prepare__()) is now an insertion-order-preserving +mapping.

    +
    +

    See also

    +
    +
    PEP 520 – Preserving Class Attribute Definition Order

    PEP written and implemented by Eric Snow.

    +
    +
    +
    +
    +
    +

    PEP 468: Preserving Keyword Argument Order

    +

    **kwargs in a function signature is now guaranteed to be an +insertion-order-preserving mapping.

    +
    +

    See also

    +
    +
    PEP 468 – Preserving Keyword Argument Order

    PEP written and implemented by Eric Snow.

    +
    +
    +
    +
    +
    +

    New dict implementation

    +

    The dict type now uses a “compact” representation +based on a proposal by Raymond Hettinger +which was first implemented by PyPy. +The memory usage of the new dict() is between 20% and 25% smaller +compared to Python 3.5.

    +

    The order-preserving aspect of this new implementation is considered an +implementation detail and should not be relied upon (this may change in +the future, but it is desired to have this new dict implementation in +the language for a few releases before changing the language spec to mandate +order-preserving semantics for all current and future Python +implementations; this also helps preserve backwards-compatibility +with older versions of the language where random iteration order is +still in effect, e.g. Python 3.5).

    +

    (Contributed by INADA Naoki in bpo-27350. Idea +originally suggested by Raymond Hettinger.)

    +
    +
    +

    PEP 523: Adding a frame evaluation API to CPython

    +

    While Python provides extensive support to customize how code +executes, one place it has not done so is in the evaluation of frame +objects. If you wanted some way to intercept frame evaluation in +Python there really wasn’t any way without directly manipulating +function pointers for defined functions.

    +

    PEP 523 changes this by providing an API to make frame +evaluation pluggable at the C level. This will allow for tools such +as debuggers and JITs to intercept frame evaluation before the +execution of Python code begins. This enables the use of alternative +evaluation implementations for Python code, tracking frame +evaluation, etc.

    +

    This API is not part of the limited C API and is marked as private to +signal that usage of this API is expected to be limited and only +applicable to very select, low-level use-cases. Semantics of the +API will change with Python as necessary.

    +
    +

    See also

    +
    +
    PEP 523 – Adding a frame evaluation API to CPython

    PEP written by Brett Cannon and Dino Viehland.

    +
    +
    +
    +
    +
    +

    PYTHONMALLOC environment variable

    +

    The new PYTHONMALLOC environment variable allows setting the Python +memory allocators and installing debug hooks.

    +

    It is now possible to install debug hooks on Python memory allocators on Python +compiled in release mode using PYTHONMALLOC=debug. Effects of debug hooks:

    +
      +
    • Newly allocated memory is filled with the byte 0xCB

    • +
    • Freed memory is filled with the byte 0xDB

    • +
    • Detect violations of the Python memory allocator API. For example, +PyObject_Free() called on a memory block allocated by +PyMem_Malloc().

    • +
    • Detect writes before the start of a buffer (buffer underflows)

    • +
    • Detect writes after the end of a buffer (buffer overflows)

    • +
    • Check that the GIL is held when allocator +functions of PYMEM_DOMAIN_OBJ (ex: PyObject_Malloc()) and +PYMEM_DOMAIN_MEM (ex: PyMem_Malloc()) domains are called.

    • +
    +

    Checking if the GIL is held is also a new feature of Python 3.6.

    +

    See the PyMem_SetupDebugHooks() function for debug hooks on Python +memory allocators.

    +

    It is now also possible to force the usage of the malloc() allocator of +the C library for all Python memory allocations using PYTHONMALLOC=malloc. +This is helpful when using external memory debuggers like Valgrind on +a Python compiled in release mode.

    +

    On error, the debug hooks on Python memory allocators now use the +tracemalloc module to get the traceback where a memory block was +allocated.

    +

    Example of fatal error on buffer overflow using +python3.6 -X tracemalloc=5 (store 5 frames in traces):

    +
    Debug memory block at address p=0x7fbcd41666f8: API 'o'
    +    4 bytes originally requested
    +    The 7 pad bytes at p-7 are FORBIDDENBYTE, as expected.
    +    The 8 pad bytes at tail=0x7fbcd41666fc are not all FORBIDDENBYTE (0xfb):
    +        at tail+0: 0x02 *** OUCH
    +        at tail+1: 0xfb
    +        at tail+2: 0xfb
    +        at tail+3: 0xfb
    +        at tail+4: 0xfb
    +        at tail+5: 0xfb
    +        at tail+6: 0xfb
    +        at tail+7: 0xfb
    +    The block was made by call #1233329 to debug malloc/realloc.
    +    Data at p: 1a 2b 30 00
    +
    +Memory block allocated at (most recent call first):
    +  File "test/test_bytes.py", line 323
    +  File "unittest/case.py", line 600
    +  File "unittest/case.py", line 648
    +  File "unittest/suite.py", line 122
    +  File "unittest/suite.py", line 84
    +
    +Fatal Python error: bad trailing pad byte
    +
    +Current thread 0x00007fbcdbd32700 (most recent call first):
    +  File "test/test_bytes.py", line 323 in test_hex
    +  File "unittest/case.py", line 600 in run
    +  File "unittest/case.py", line 648 in __call__
    +  File "unittest/suite.py", line 122 in run
    +  File "unittest/suite.py", line 84 in __call__
    +  File "unittest/suite.py", line 122 in run
    +  File "unittest/suite.py", line 84 in __call__
    +  ...
    +
    +
    +

    (Contributed by Victor Stinner in bpo-26516 and bpo-26564.)

    +
    +
    +

    DTrace and SystemTap probing support

    +

    Python can now be built --with-dtrace which enables static markers +for the following events in the interpreter:

    +
      +
    • function call/return

    • +
    • garbage collection started/finished

    • +
    • line of code executed.

    • +
    +

    This can be used to instrument running interpreters in production, +without the need to recompile specific debug builds or providing +application-specific profiling/debugging code.

    +

    More details in Instrumenting CPython with DTrace and SystemTap.

    +

    The current implementation is tested on Linux and macOS. Additional +markers may be added in the future.

    +

    (Contributed by Łukasz Langa in bpo-21590, based on patches by +Jesús Cea Avión, David Malcolm, and Nikhil Benesch.)

    +
    +
    +
    +

    Other Language Changes

    +

    Some smaller changes made to the core Python language are:

    +
      +
    • A global or nonlocal statement must now textually appear +before the first use of the affected name in the same scope. +Previously this was a SyntaxWarning.

    • +
    • It is now possible to set a special method to +None to indicate that the corresponding operation is not available. +For example, if a class sets __iter__() to None, the class +is not iterable. +(Contributed by Andrew Barnert and Ivan Levkivskyi in bpo-25958.)

    • +
    • Long sequences of repeated traceback lines are now abbreviated as +"[Previous line repeated {count} more times]" (see +traceback for an example). +(Contributed by Emanuel Barry in bpo-26823.)

    • +
    • Import now raises the new exception ModuleNotFoundError +(subclass of ImportError) when it cannot find a module. Code +that currently checks for ImportError (in try-except) will still work. +(Contributed by Eric Snow in bpo-15767.)

    • +
    • Class methods relying on zero-argument super() will now work correctly +when called from metaclass methods during class creation. +(Contributed by Martin Teichmann in bpo-23722.)

    • +
    +
    +
    +

    New Modules

    +
    +

    secrets

    +

    The main purpose of the new secrets module is to provide an obvious way +to reliably generate cryptographically strong pseudo-random values suitable +for managing secrets, such as account authentication, tokens, and similar.

    +
    +

    Warning

    +

    Note that the pseudo-random generators in the random module +should NOT be used for security purposes. Use secrets +on Python 3.6+ and os.urandom() on Python 3.5 and earlier.

    +
    +
    +

    See also

    +
    +
    PEP 506 – Adding A Secrets Module To The Standard Library

    PEP written and implemented by Steven D’Aprano.

    +
    +
    +
    +
    +
    +
    +

    Improved Modules

    +
    +

    array

    +

    Exhausted iterators of array.array will now stay exhausted even +if the iterated array is extended. This is consistent with the behavior +of other mutable sequences.

    +

    Contributed by Serhiy Storchaka in bpo-26492.

    +
    +
    +

    ast

    +

    The new ast.Constant AST node has been added. It can be used +by external AST optimizers for the purposes of constant folding.

    +

    Contributed by Victor Stinner in bpo-26146.

    +
    +
    +

    asyncio

    +

    Starting with Python 3.6 the asyncio module is no longer provisional and its +API is considered stable.

    +

    Notable changes in the asyncio module since Python 3.5.0 +(all backported to 3.5.x due to the provisional status):

    +
      +
    • The get_event_loop() function has been changed to +always return the currently running loop when called from coroutines +and callbacks. +(Contributed by Yury Selivanov in bpo-28613.)

    • +
    • The ensure_future() function and all functions that +use it, such as loop.run_until_complete(), +now accept all kinds of awaitable objects. +(Contributed by Yury Selivanov.)

    • +
    • New run_coroutine_threadsafe() function to submit +coroutines to event loops from other threads. +(Contributed by Vincent Michel.)

    • +
    • New Transport.is_closing() +method to check if the transport is closing or closed. +(Contributed by Yury Selivanov.)

    • +
    • The loop.create_server() +method can now accept a list of hosts. +(Contributed by Yann Sionneau.)

    • +
    • New loop.create_future() +method to create Future objects. This allows alternative event +loop implementations, such as +uvloop, to provide a faster +asyncio.Future implementation. +(Contributed by Yury Selivanov in bpo-27041.)

    • +
    • New loop.get_exception_handler() +method to get the current exception handler. +(Contributed by Yury Selivanov in bpo-27040.)

    • +
    • New StreamReader.readuntil() +method to read data from the stream until a separator bytes +sequence appears. +(Contributed by Mark Korenberg.)

    • +
    • The performance of StreamReader.readexactly() +has been improved. +(Contributed by Mark Korenberg in bpo-28370.)

    • +
    • The loop.getaddrinfo() +method is optimized to avoid calling the system getaddrinfo +function if the address is already resolved. +(Contributed by A. Jesse Jiryu Davis.)

    • +
    • The loop.stop() +method has been changed to stop the loop immediately after +the current iteration. Any new callbacks scheduled as a result +of the last iteration will be discarded. +(Contributed by Guido van Rossum in bpo-25593.)

    • +
    • Future.set_exception +will now raise TypeError when passed an instance of +the StopIteration exception. +(Contributed by Chris Angelico in bpo-26221.)

    • +
    • New loop.connect_accepted_socket() +method to be used by servers that accept connections outside of asyncio, +but that use asyncio to handle them. +(Contributed by Jim Fulton in bpo-27392.)

    • +
    • TCP_NODELAY flag is now set for all TCP transports by default. +(Contributed by Yury Selivanov in bpo-27456.)

    • +
    • New loop.shutdown_asyncgens() +to properly close pending asynchronous generators before closing the +loop. +(Contributed by Yury Selivanov in bpo-28003.)

    • +
    • Future and Task +classes now have an optimized C implementation which makes asyncio +code up to 30% faster. +(Contributed by Yury Selivanov and INADA Naoki in bpo-26081 +and bpo-28544.)

    • +
    +
    +
    +

    binascii

    +

    The b2a_base64() function now accepts an optional newline +keyword argument to control whether the newline character is appended to the +return value. +(Contributed by Victor Stinner in bpo-25357.)

    +
    +
    +

    cmath

    +

    The new cmath.tau (τ) constant has been added. +(Contributed by Lisa Roach in bpo-12345, see PEP 628 for details.)

    +

    New constants: cmath.inf and cmath.nan to +match math.inf and math.nan, and also cmath.infj +and cmath.nanj to match the format used by complex repr. +(Contributed by Mark Dickinson in bpo-23229.)

    +
    +
    +

    collections

    +

    The new Collection abstract base class has been +added to represent sized iterable container classes. +(Contributed by Ivan Levkivskyi, docs by Neil Girdhar in bpo-27598.)

    +

    The new Reversible abstract base class represents +iterable classes that also provide the __reversed__() method. +(Contributed by Ivan Levkivskyi in bpo-25987.)

    +

    The new AsyncGenerator abstract base class represents +asynchronous generators. +(Contributed by Yury Selivanov in bpo-28720.)

    +

    The namedtuple() function now accepts an optional +keyword argument module, which, when specified, is used for +the __module__ attribute of the returned named tuple class. +(Contributed by Raymond Hettinger in bpo-17941.)

    +

    The verbose and rename arguments for +namedtuple() are now keyword-only. +(Contributed by Raymond Hettinger in bpo-25628.)

    +

    Recursive collections.deque instances can now be pickled. +(Contributed by Serhiy Storchaka in bpo-26482.)

    +
    +
    +

    concurrent.futures

    +

    The ThreadPoolExecutor +class constructor now accepts an optional thread_name_prefix argument +to make it possible to customize the names of the threads created by the +pool. +(Contributed by Gregory P. Smith in bpo-27664.)

    +
    +
    +

    contextlib

    +

    The contextlib.AbstractContextManager class has been added to +provide an abstract base class for context managers. It provides a +sensible default implementation for __enter__() which returns +self and leaves __exit__() an abstract method. A matching +class has been added to the typing module as +typing.ContextManager. +(Contributed by Brett Cannon in bpo-25609.)

    +
    +
    +

    datetime

    +

    The datetime and time classes have +the new fold attribute used to disambiguate local time +when necessary. Many functions in the datetime have been +updated to support local time disambiguation. +See Local Time Disambiguation section for more +information. +(Contributed by Alexander Belopolsky in bpo-24773.)

    +

    The datetime.strftime() and +date.strftime() methods now support +ISO 8601 date directives %G, %u and %V. +(Contributed by Ashley Anderson in bpo-12006.)

    +

    The datetime.isoformat() function +now accepts an optional timespec argument that specifies the number +of additional components of the time value to include. +(Contributed by Alessandro Cucci and Alexander Belopolsky in bpo-19475.)

    +

    The datetime.combine() now +accepts an optional tzinfo argument. +(Contributed by Alexander Belopolsky in bpo-27661.)

    +
    +
    +

    decimal

    +

    New Decimal.as_integer_ratio() +method that returns a pair (n, d) of integers that represent the given +Decimal instance as a fraction, in lowest terms and +with a positive denominator:

    +
    >>> Decimal('-3.14').as_integer_ratio()
    +(-157, 50)
    +
    +
    +

    (Contributed by Stefan Krah amd Mark Dickinson in bpo-25928.)

    +
    +
    +

    distutils

    +

    The default_format attribute has been removed from +distutils.command.sdist.sdist and the formats +attribute defaults to ['gztar']. Although not anticipated, +any code relying on the presence of default_format may +need to be adapted. See bpo-27819 for more details.

    +
    +
    +

    email

    +

    The new email API, enabled via the policy keyword to various constructors, is +no longer provisional. The email documentation has been reorganized and +rewritten to focus on the new API, while retaining the old documentation for +the legacy API. (Contributed by R. David Murray in bpo-24277.)

    +

    The email.mime classes now all accept an optional policy keyword. +(Contributed by Berker Peksag in bpo-27331.)

    +

    The DecodedGenerator now supports the policy +keyword.

    +

    There is a new policy attribute, +message_factory, that controls what class is used +by default when the parser creates new message objects. For the +email.policy.compat32 policy this is Message, +for the new policies it is EmailMessage. +(Contributed by R. David Murray in bpo-20476.)

    +
    +
    +

    encodings

    +

    On Windows, added the 'oem' encoding to use CP_OEMCP, and the 'ansi' +alias for the existing 'mbcs' encoding, which uses the CP_ACP code page. +(Contributed by Steve Dower in bpo-27959.)

    +
    +
    +

    enum

    +

    Two new enumeration base classes have been added to the enum module: +Flag and IntFlags. Both are used to define +constants that can be combined using the bitwise operators. +(Contributed by Ethan Furman in bpo-23591.)

    +

    Many standard library modules have been updated to use the +IntFlags class for their constants.

    +

    The new enum.auto value can be used to assign values to enum +members automatically:

    +
    >>> from enum import Enum, auto
    +>>> class Color(Enum):
    +...     red = auto()
    +...     blue = auto()
    +...     green = auto()
    +...
    +>>> list(Color)
    +[<Color.red: 1>, <Color.blue: 2>, <Color.green: 3>]
    +
    +
    +
    +
    +

    faulthandler

    +

    On Windows, the faulthandler module now installs a handler for Windows +exceptions: see faulthandler.enable(). (Contributed by Victor Stinner in +bpo-23848.)

    +
    +
    +

    fileinput

    +

    hook_encoded() now supports the errors argument. +(Contributed by Joseph Hackman in bpo-25788.)

    +
    +
    +

    hashlib

    +

    hashlib supports OpenSSL 1.1.0. The minimum recommend version is 1.0.2. +(Contributed by Christian Heimes in bpo-26470.)

    +

    BLAKE2 hash functions were added to the module. blake2b() +and blake2s() are always available and support the full +feature set of BLAKE2. +(Contributed by Christian Heimes in bpo-26798 based on code by +Dmitry Chestnykh and Samuel Neves. Documentation written by Dmitry Chestnykh.)

    +

    The SHA-3 hash functions sha3_224(), sha3_256(), +sha3_384(), sha3_512(), and SHAKE hash functions +shake_128() and shake_256() were added. +(Contributed by Christian Heimes in bpo-16113. Keccak Code Package +by Guido Bertoni, Joan Daemen, Michaël Peeters, Gilles Van Assche, and +Ronny Van Keer.)

    +

    The password-based key derivation function scrypt() is now +available with OpenSSL 1.1.0 and newer. +(Contributed by Christian Heimes in bpo-27928.)

    +
    +
    +

    http.client

    +

    HTTPConnection.request() and +endheaders() both now support +chunked encoding request bodies. +(Contributed by Demian Brecht and Rolf Krahl in bpo-12319.)

    +
    +
    +

    idlelib and IDLE

    +

    The idlelib package is being modernized and refactored to make IDLE look and +work better and to make the code easier to understand, test, and improve. Part +of making IDLE look better, especially on Linux and Mac, is using ttk widgets, +mostly in the dialogs. As a result, IDLE no longer runs with tcl/tk 8.4. It +now requires tcl/tk 8.5 or 8.6. We recommend running the latest release of +either.

    +

    ‘Modernizing’ includes renaming and consolidation of idlelib modules. The +renaming of files with partial uppercase names is similar to the renaming of, +for instance, Tkinter and TkFont to tkinter and tkinter.font in 3.0. As a +result, imports of idlelib files that worked in 3.5 will usually not work in +3.6. At least a module name change will be needed (see idlelib/README.txt), +sometimes more. (Name changes contributed by Al Swiegart and Terry Reedy in +bpo-24225. Most idlelib patches since have been and will be part of the +process.)

    +

    In compensation, the eventual result with be that some idlelib classes will be +easier to use, with better APIs and docstrings explaining them. Additional +useful information will be added to idlelib when available.

    +

    New in 3.6.2:

    +

    Multiple fixes for autocompletion. (Contributed by Louie Lu in bpo-15786.)

    +

    New in 3.6.3:

    +

    Module Browser (on the File menu, formerly called Class Browser), +now displays nested functions and classes in addition to top-level +functions and classes. +(Contributed by Guilherme Polo, Cheryl Sabella, and Terry Jan Reedy +in bpo-1612262.)

    +

    The IDLE features formerly implemented as extensions have been reimplemented +as normal features. Their settings have been moved from the Extensions tab +to other dialog tabs. +(Contributed by Charles Wohlganger and Terry Jan Reedy in bpo-27099.)

    +

    The Settings dialog (Options, Configure IDLE) has been partly rewritten +to improve both appearance and function. +(Contributed by Cheryl Sabella and Terry Jan Reedy in multiple issues.)

    +

    New in 3.6.4:

    +

    The font sample now includes a selection of non-Latin characters so that +users can better see the effect of selecting a particular font. +(Contributed by Terry Jan Reedy in bpo-13802.) +The sample can be edited to include other characters. +(Contributed by Serhiy Storchaka in bpo-31860.)

    +

    New in 3.6.6:

    +

    Editor code context option revised. Box displays all context lines up to +maxlines. Clicking on a context line jumps the editor to that line. Context +colors for custom themes is added to Highlights tab of Settings dialog. +(Contributed by Cheryl Sabella and Terry Jan Reedy in bpo-33642, +bpo-33768, and bpo-33679.)

    +

    On Windows, a new API call tells Windows that tk scales for DPI. On Windows +8.1+ or 10, with DPI compatibility properties of the Python binary +unchanged, and a monitor resolution greater than 96 DPI, this should +make text and lines sharper. It should otherwise have no effect. +(Contributed by Terry Jan Reedy in bpo-33656.)

    +

    New in 3.6.7:

    +

    Output over N lines (50 by default) is squeezed down to a button. +N can be changed in the PyShell section of the General page of the +Settings dialog. Fewer, but possibly extra long, lines can be squeezed by +right clicking on the output. Squeezed output can be expanded in place +by double-clicking the button or into the clipboard or a separate window +by right-clicking the button. (Contributed by Tal Einat in bpo-1529353.)

    +
    +
    +

    importlib

    +

    Import now raises the new exception ModuleNotFoundError +(subclass of ImportError) when it cannot find a module. Code +that current checks for ImportError (in try-except) will still work. +(Contributed by Eric Snow in bpo-15767.)

    +

    importlib.util.LazyLoader now calls +create_module() on the wrapped loader, removing the +restriction that importlib.machinery.BuiltinImporter and +importlib.machinery.ExtensionFileLoader couldn’t be used with +importlib.util.LazyLoader.

    +

    importlib.util.cache_from_source(), +importlib.util.source_from_cache(), and +importlib.util.spec_from_file_location() now accept a +path-like object.

    +
    +
    +

    inspect

    +

    The inspect.signature() function now reports the +implicit .0 parameters generated by the compiler for comprehension and +generator expression scopes as if they were positional-only parameters called +implicit0. (Contributed by Jelle Zijlstra in bpo-19611.)

    +

    To reduce code churn when upgrading from Python 2.7 and the legacy +inspect.getargspec() API, the previously documented deprecation of +inspect.getfullargspec() has been reversed. While this function is +convenient for single/source Python 2/3 code bases, the richer +inspect.signature() interface remains the recommended approach for new +code. (Contributed by Nick Coghlan in bpo-27172)

    +
    +
    +

    json

    +

    json.load() and json.loads() now support binary input. Encoded +JSON should be represented using either UTF-8, UTF-16, or UTF-32. +(Contributed by Serhiy Storchaka in bpo-17909.)

    +
    +
    +

    logging

    +

    The new WatchedFileHandler.reopenIfNeeded() +method has been added to add the ability to check if the log file needs to +be reopened. +(Contributed by Marian Horban in bpo-24884.)

    +
    +
    +

    math

    +

    The tau (τ) constant has been added to the math and cmath +modules. +(Contributed by Lisa Roach in bpo-12345, see PEP 628 for details.)

    +
    +
    +

    multiprocessing

    +

    Proxy Objects returned by +multiprocessing.Manager() can now be nested. +(Contributed by Davin Potts in bpo-6766.)

    +
    +
    +

    os

    +

    See the summary of PEP 519 for details on how the +os and os.path modules now support +path-like objects.

    +

    scandir() now supports bytes paths on Windows.

    +

    A new close() method allows explicitly closing a +scandir() iterator. The scandir() iterator now +supports the context manager protocol. If a scandir() +iterator is neither exhausted nor explicitly closed a ResourceWarning +will be emitted in its destructor. +(Contributed by Serhiy Storchaka in bpo-25994.)

    +

    On Linux, os.urandom() now blocks until the system urandom entropy pool +is initialized to increase the security. See the PEP 524 for the rationale.

    +

    The Linux getrandom() syscall (get random bytes) is now exposed as the new +os.getrandom() function. +(Contributed by Victor Stinner, part of the PEP 524)

    +
    +
    +

    pathlib

    +

    pathlib now supports path-like objects. +(Contributed by Brett Cannon in bpo-27186.)

    +

    See the summary of PEP 519 for details.

    +
    +
    +

    pdb

    +

    The Pdb class constructor has a new optional readrc argument +to control whether .pdbrc files should be read.

    +
    +
    +

    pickle

    +

    Objects that need __new__ called with keyword arguments can now be pickled +using pickle protocols older than protocol version 4. +Protocol version 4 already supports this case. (Contributed by Serhiy +Storchaka in bpo-24164.)

    +
    +
    +

    pickletools

    +

    pickletools.dis() now outputs the implicit memo index for the +MEMOIZE opcode. +(Contributed by Serhiy Storchaka in bpo-25382.)

    +
    +
    +

    pydoc

    +

    The pydoc module has learned to respect the MANPAGER +environment variable. +(Contributed by Matthias Klose in bpo-8637.)

    +

    help() and pydoc can now list named tuple fields in the +order they were defined rather than alphabetically. +(Contributed by Raymond Hettinger in bpo-24879.)

    +
    +
    +

    random

    +

    The new choices() function returns a list of elements of +specified size from the given population with optional weights. +(Contributed by Raymond Hettinger in bpo-18844.)

    +
    +
    +

    re

    +

    Added support of modifier spans in regular expressions. Examples: +'(?i:p)ython' matches 'python' and 'Python', but not 'PYTHON'; +'(?i)g(?-i:v)r' matches 'GvR' and 'gvr', but not 'GVR'. +(Contributed by Serhiy Storchaka in bpo-433028.)

    +

    Match object groups can be accessed by __getitem__, which is +equivalent to group(). So mo['name'] is now equivalent to +mo.group('name'). (Contributed by Eric Smith in bpo-24454.)

    +

    Match objects now support +index-like objects as group +indices. +(Contributed by Jeroen Demeyer and Xiang Zhang in bpo-27177.)

    +
    +
    +

    readline

    +

    Added set_auto_history() to enable or disable +automatic addition of input to the history list. (Contributed by +Tyler Crompton in bpo-26870.)

    +
    +
    +

    rlcompleter

    +

    Private and special attribute names now are omitted unless the prefix starts +with underscores. A space or a colon is added after some completed keywords. +(Contributed by Serhiy Storchaka in bpo-25011 and bpo-25209.)

    +
    +
    +

    shlex

    +

    The shlex has much +improved shell compatibility +through the new punctuation_chars argument to control which characters +are treated as punctuation. +(Contributed by Vinay Sajip in bpo-1521950.)

    +
    +
    +

    site

    +

    When specifying paths to add to sys.path in a .pth file, +you may now specify file paths on top of directories (e.g. zip files). +(Contributed by Wolfgang Langner in bpo-26587).

    +
    +
    +

    sqlite3

    +

    sqlite3.Cursor.lastrowid now supports the REPLACE statement. +(Contributed by Alex LordThorsen in bpo-16864.)

    +
    +
    +

    socket

    +

    The ioctl() function now supports the +SIO_LOOPBACK_FAST_PATH control code. +(Contributed by Daniel Stokes in bpo-26536.)

    +

    The getsockopt() constants SO_DOMAIN, +SO_PROTOCOL, SO_PEERSEC, and SO_PASSSEC are now supported. +(Contributed by Christian Heimes in bpo-26907.)

    +

    The setsockopt() now supports the +setsockopt(level, optname, None, optlen: int) form. +(Contributed by Christian Heimes in bpo-27744.)

    +

    The socket module now supports the address family +AF_ALG to interface with Linux Kernel crypto API. ALG_*, +SOL_ALG and sendmsg_afalg() were added. +(Contributed by Christian Heimes in bpo-27744 with support from +Victor Stinner.)

    +

    New Linux constants TCP_USER_TIMEOUT and TCP_CONGESTION were added. +(Contributed by Omar Sandoval, issue:26273).

    +
    +
    +

    socketserver

    +

    Servers based on the socketserver module, including those +defined in http.server, xmlrpc.server and +wsgiref.simple_server, now support the context manager +protocol. +(Contributed by Aviv Palivoda in bpo-26404.)

    +

    The wfile attribute of +StreamRequestHandler classes now implements +the io.BufferedIOBase writable interface. In particular, +calling write() is now guaranteed to send the +data in full. (Contributed by Martin Panter in bpo-26721.)

    +
    +
    +

    ssl

    +

    ssl supports OpenSSL 1.1.0. The minimum recommend version is 1.0.2. +(Contributed by Christian Heimes in bpo-26470.)

    +

    3DES has been removed from the default cipher suites and ChaCha20 Poly1305 +cipher suites have been added. +(Contributed by Christian Heimes in bpo-27850 and bpo-27766.)

    +

    SSLContext has better default configuration for options +and ciphers. +(Contributed by Christian Heimes in bpo-28043.)

    +

    SSL session can be copied from one client-side connection to another +with the new SSLSession class. TLS session resumption can +speed up the initial handshake, reduce latency and improve performance +(Contributed by Christian Heimes in bpo-19500 based on a draft by +Alex Warhawk.)

    +

    The new get_ciphers() method can be used to +get a list of enabled ciphers in order of cipher priority.

    +

    All constants and flags have been converted to IntEnum and +IntFlags. +(Contributed by Christian Heimes in bpo-28025.)

    +

    Server and client-side specific TLS protocols for SSLContext +were added. +(Contributed by Christian Heimes in bpo-28085.)

    +
    +
    +

    statistics

    +

    A new harmonic_mean() function has been added. +(Contributed by Steven D’Aprano in bpo-27181.)

    +
    +
    +

    struct

    +

    struct now supports IEEE 754 half-precision floats via the 'e' +format specifier. +(Contributed by Eli Stevens, Mark Dickinson in bpo-11734.)

    +
    +
    +

    subprocess

    +

    subprocess.Popen destructor now emits a ResourceWarning warning +if the child process is still running. Use the context manager protocol (with +proc: ...) or explicitly call the wait() method to +read the exit status of the child process. (Contributed by Victor Stinner in +bpo-26741.)

    +

    The subprocess.Popen constructor and all functions that pass arguments +through to it now accept encoding and errors arguments. Specifying either +of these will enable text mode for the stdin, stdout and stderr streams. +(Contributed by Steve Dower in bpo-6135.)

    +
    +
    +

    sys

    +

    The new getfilesystemencodeerrors() function returns the name of +the error mode used to convert between Unicode filenames and bytes filenames. +(Contributed by Steve Dower in bpo-27781.)

    +

    On Windows the return value of the getwindowsversion() function +now includes the platform_version field which contains the accurate major +version, minor version and build number of the current operating system, +rather than the version that is being emulated for the process +(Contributed by Steve Dower in bpo-27932.)

    +
    +
    +

    telnetlib

    +

    Telnet is now a context manager (contributed by +Stéphane Wirtel in bpo-25485).

    +
    +
    +

    time

    +

    The struct_time attributes tm_gmtoff and +tm_zone are now available on all platforms.

    +
    +
    +

    timeit

    +

    The new Timer.autorange() convenience +method has been added to call Timer.timeit() +repeatedly so that the total run time is greater or equal to 200 milliseconds. +(Contributed by Steven D’Aprano in bpo-6422.)

    +

    timeit now warns when there is substantial (4x) variance +between best and worst times. +(Contributed by Serhiy Storchaka in bpo-23552.)

    +
    +
    +

    tkinter

    +

    Added methods trace_add(), +trace_remove() and trace_info() +in the tkinter.Variable class. They replace old methods +trace_variable(), trace(), +trace_vdelete() and +trace_vinfo() that use obsolete Tcl commands and might +not work in future versions of Tcl. +(Contributed by Serhiy Storchaka in bpo-22115).

    +
    +
    +

    traceback

    +

    Both the traceback module and the interpreter’s builtin exception display now +abbreviate long sequences of repeated lines in tracebacks as shown in the +following example:

    +
    >>> def f(): f()
    +...
    +>>> f()
    +Traceback (most recent call last):
    +  File "<stdin>", line 1, in <module>
    +  File "<stdin>", line 1, in f
    +  File "<stdin>", line 1, in f
    +  File "<stdin>", line 1, in f
    +  [Previous line repeated 995 more times]
    +RecursionError: maximum recursion depth exceeded
    +
    +
    +

    (Contributed by Emanuel Barry in bpo-26823.)

    +
    +
    +

    tracemalloc

    +

    The tracemalloc module now supports tracing memory allocations in +multiple different address spaces.

    +

    The new DomainFilter filter class has been added +to filter block traces by their address space (domain).

    +

    (Contributed by Victor Stinner in bpo-26588.)

    +
    +
    +

    typing

    +

    Since the typing module is provisional, +all changes introduced in Python 3.6 have also been +backported to Python 3.5.x.

    +

    The typing module has a much improved support for generic type +aliases. For example Dict[str, Tuple[S, T]] is now a valid +type annotation. +(Contributed by Guido van Rossum in Github #195.)

    +

    The typing.ContextManager class has been added for +representing contextlib.AbstractContextManager. +(Contributed by Brett Cannon in bpo-25609.)

    +

    The typing.Collection class has been added for +representing collections.abc.Collection. +(Contributed by Ivan Levkivskyi in bpo-27598.)

    +

    The typing.ClassVar type construct has been added to +mark class variables. As introduced in PEP 526, a variable annotation +wrapped in ClassVar indicates that a given attribute is intended to be used as +a class variable and should not be set on instances of that class. +(Contributed by Ivan Levkivskyi in Github #280.)

    +

    A new TYPE_CHECKING constant that is assumed to be +True by the static type checkers, but is False at runtime. +(Contributed by Guido van Rossum in Github #230.)

    +

    A new NewType() helper function has been added to create +lightweight distinct types for annotations:

    +
    from typing import NewType
    +
    +UserId = NewType('UserId', int)
    +some_id = UserId(524313)
    +
    +
    +

    The static type checker will treat the new type as if it were a subclass +of the original type. (Contributed by Ivan Levkivskyi in Github #189.)

    +
    +
    +

    unicodedata

    +

    The unicodedata module now uses data from Unicode 9.0.0. +(Contributed by Benjamin Peterson.)

    +
    +
    +

    unittest.mock

    +

    The Mock class has the following improvements:

    + +
    +
    +

    urllib.request

    +

    If a HTTP request has a file or iterable body (other than a +bytes object) but no Content-Length header, rather than +throwing an error, AbstractHTTPHandler now +falls back to use chunked transfer encoding. +(Contributed by Demian Brecht and Rolf Krahl in bpo-12319.)

    +
    +
    +

    urllib.robotparser

    +

    RobotFileParser now supports the Crawl-delay and +Request-rate extensions. +(Contributed by Nikolay Bogoychev in bpo-16099.)

    +
    +
    +

    venv

    +

    venv accepts a new parameter --prompt. This parameter provides an +alternative prefix for the virtual environment. (Proposed by Łukasz Balcerzak +and ported to 3.6 by Stéphane Wirtel in bpo-22829.)

    +
    +
    +

    warnings

    +

    A new optional source parameter has been added to the +warnings.warn_explicit() function: the destroyed object which emitted a +ResourceWarning. A source attribute has also been added to +warnings.WarningMessage (contributed by Victor Stinner in +bpo-26568 and bpo-26567).

    +

    When a ResourceWarning warning is logged, the tracemalloc module is now +used to try to retrieve the traceback where the destroyed object was allocated.

    +

    Example with the script example.py:

    +
    import warnings
    +
    +def func():
    +    return open(__file__)
    +
    +f = func()
    +f = None
    +
    +
    +

    Output of the command python3.6 -Wd -X tracemalloc=5 example.py:

    +
    example.py:7: ResourceWarning: unclosed file <_io.TextIOWrapper name='example.py' mode='r' encoding='UTF-8'>
    +  f = None
    +Object allocated at (most recent call first):
    +  File "example.py", lineno 4
    +    return open(__file__)
    +  File "example.py", lineno 6
    +    f = func()
    +
    +
    +

    The “Object allocated at” traceback is new and is only displayed if +tracemalloc is tracing Python memory allocations and if the +warnings module was already imported.

    +
    +
    +

    winreg

    +

    Added the 64-bit integer type REG_QWORD. +(Contributed by Clement Rouault in bpo-23026.)

    +
    +
    +

    winsound

    +

    Allowed keyword arguments to be passed to Beep, +MessageBeep, and PlaySound (bpo-27982).

    +
    +
    +

    xmlrpc.client

    +

    The xmlrpc.client module now supports unmarshalling +additional data types used by the Apache XML-RPC implementation +for numerics and None. +(Contributed by Serhiy Storchaka in bpo-26885.)

    +
    +
    +

    zipfile

    +

    A new ZipInfo.from_file() class method +allows making a ZipInfo instance from a filesystem file. +A new ZipInfo.is_dir() method can be used +to check if the ZipInfo instance represents a directory. +(Contributed by Thomas Kluyver in bpo-26039.)

    +

    The ZipFile.open() method can now be used to +write data into a ZIP file, as well as for extracting data. +(Contributed by Thomas Kluyver in bpo-26039.)

    +
    +
    +

    zlib

    +

    The compress() and decompress() functions now accept +keyword arguments. +(Contributed by Aviv Palivoda in bpo-26243 and +Xiang Zhang in bpo-16764 respectively.)

    +
    +
    +
    +

    Optimizations

    +
      +
    • The Python interpreter now uses a 16-bit wordcode instead of bytecode which +made a number of opcode optimizations possible. +(Contributed by Demur Rumed with input and reviews from +Serhiy Storchaka and Victor Stinner in bpo-26647 and bpo-28050.)

    • +
    • The asyncio.Future class now has an optimized C implementation. +(Contributed by Yury Selivanov and INADA Naoki in bpo-26081.)

    • +
    • The asyncio.Task class now has an optimized +C implementation. (Contributed by Yury Selivanov in bpo-28544.)

    • +
    • Various implementation improvements in the typing module +(such as caching of generic types) allow up to 30 times performance +improvements and reduced memory footprint.

    • +
    • The ASCII decoder is now up to 60 times as fast for error handlers +surrogateescape, ignore and replace (Contributed +by Victor Stinner in bpo-24870).

    • +
    • The ASCII and the Latin1 encoders are now up to 3 times as fast for the +error handler surrogateescape +(Contributed by Victor Stinner in bpo-25227).

    • +
    • The UTF-8 encoder is now up to 75 times as fast for error handlers +ignore, replace, surrogateescape, surrogatepass (Contributed +by Victor Stinner in bpo-25267).

    • +
    • The UTF-8 decoder is now up to 15 times as fast for error handlers +ignore, replace and surrogateescape (Contributed +by Victor Stinner in bpo-25301).

    • +
    • bytes % args is now up to 2 times faster. (Contributed by Victor Stinner +in bpo-25349).

    • +
    • bytearray % args is now between 2.5 and 5 times faster. (Contributed by +Victor Stinner in bpo-25399).

    • +
    • Optimize bytes.fromhex() and bytearray.fromhex(): they are now +between 2x and 3.5x faster. (Contributed by Victor Stinner in bpo-25401).

    • +
    • Optimize bytes.replace(b'', b'.') and bytearray.replace(b'', b'.'): +up to 80% faster. (Contributed by Josh Snider in bpo-26574).

    • +
    • Allocator functions of the PyMem_Malloc() domain +(PYMEM_DOMAIN_MEM) now use the pymalloc memory allocator instead of malloc() function of the C library. The +pymalloc allocator is optimized for objects smaller or equal to 512 bytes +with a short lifetime, and use malloc() for larger memory blocks. +(Contributed by Victor Stinner in bpo-26249).

    • +
    • pickle.load() and pickle.loads() are now up to 10% faster when +deserializing many small objects (Contributed by Victor Stinner in +bpo-27056).

    • +
    • Passing keyword arguments to a function has an +overhead in comparison with passing positional arguments. Now in extension functions implemented with using +Argument Clinic this overhead is significantly decreased. +(Contributed by Serhiy Storchaka in bpo-27574).

    • +
    • Optimized glob() and iglob() functions in the +glob module; they are now about 3–6 times faster. +(Contributed by Serhiy Storchaka in bpo-25596).

    • +
    • Optimized globbing in pathlib by using os.scandir(); +it is now about 1.5–4 times faster. +(Contributed by Serhiy Storchaka in bpo-26032).

    • +
    • xml.etree.ElementTree parsing, iteration and deepcopy performance +has been significantly improved. +(Contributed by Serhiy Storchaka in bpo-25638, bpo-25873, +and bpo-25869.)

    • +
    • Creation of fractions.Fraction instances from floats and +decimals is now 2 to 3 times faster. +(Contributed by Serhiy Storchaka in bpo-25971.)

    • +
    +
    +
    +

    Build and C API Changes

    + +
    +
    +

    Other Improvements

    +
      +
    • When --version (short form: -V) is supplied twice, +Python prints sys.version for detailed information.

      +
      $ ./python -VV
      +Python 3.6.0b4+ (3.6:223967b49e49+, Nov 21 2016, 20:55:04)
      +[GCC 4.2.1 Compatible Apple LLVM 8.0.0 (clang-800.0.42.1)]
      +
      +
      +
    • +
    +
    +
    +

    Deprecated

    +
    +

    New Keywords

    +

    async and await are not recommended to be used as variable, class, +function or module names. Introduced by PEP 492 in Python 3.5, they will +become proper keywords in Python 3.7. Starting in Python 3.6, the use of +async or await as names will generate a DeprecationWarning.

    +
    +
    +

    Deprecated Python behavior

    +

    Raising the StopIteration exception inside a generator will now +generate a DeprecationWarning, and will trigger a RuntimeError +in Python 3.7. See PEP 479: Change StopIteration handling inside generators for details.

    +

    The __aiter__() method is now expected to return an asynchronous +iterator directly instead of returning an awaitable as previously. +Doing the former will trigger a DeprecationWarning. Backward +compatibility will be removed in Python 3.7. +(Contributed by Yury Selivanov in bpo-27243.)

    +

    A backslash-character pair that is not a valid escape sequence now generates +a DeprecationWarning. Although this will eventually become a +SyntaxError, that will not be for several Python releases. +(Contributed by Emanuel Barry in bpo-27364.)

    +

    When performing a relative import, falling back on __name__ and +__path__ from the calling module when __spec__ or +__package__ are not defined now raises an ImportWarning. +(Contributed by Rose Ames in bpo-25791.)

    +
    +
    +

    Deprecated Python modules, functions and methods

    +
    +

    asynchat

    +

    The asynchat has been deprecated in favor of asyncio. +(Contributed by Mariatta in bpo-25002.)

    +
    +
    +

    asyncore

    +

    The asyncore has been deprecated in favor of asyncio. +(Contributed by Mariatta in bpo-25002.)

    +
    +
    +

    dbm

    +

    Unlike other dbm implementations, the dbm.dumb module +creates databases with the 'rw' mode and allows modifying the database +opened with the 'r' mode. This behavior is now deprecated and will +be removed in 3.8. +(Contributed by Serhiy Storchaka in bpo-21708.)

    +
    +
    +

    distutils

    +

    The undocumented extra_path argument to the +Distribution constructor is now considered deprecated +and will raise a warning if set. Support for this parameter will be +removed in a future Python release. See bpo-27919 for details.

    +
    +
    +

    grp

    +

    The support of non-integer arguments in getgrgid() has been +deprecated. +(Contributed by Serhiy Storchaka in bpo-26129.)

    +
    +
    +

    importlib

    +

    The importlib.machinery.SourceFileLoader.load_module() and +importlib.machinery.SourcelessFileLoader.load_module() methods +are now deprecated. They were the only remaining implementations of +importlib.abc.Loader.load_module() in importlib that had not +been deprecated in previous versions of Python in favour of +importlib.abc.Loader.exec_module().

    +

    The importlib.machinery.WindowsRegistryFinder class is now +deprecated. As of 3.6.0, it is still added to sys.meta_path by +default (on Windows), but this may change in future releases.

    +
    +
    +

    os

    +

    Undocumented support of general bytes-like objects +as paths in os functions, compile() and similar functions is +now deprecated. +(Contributed by Serhiy Storchaka in bpo-25791 and bpo-26754.)

    +
    +
    +

    re

    +

    Support for inline flags (?letters) in the middle of the regular +expression has been deprecated and will be removed in a future Python +version. Flags at the start of a regular expression are still allowed. +(Contributed by Serhiy Storchaka in bpo-22493.)

    +
    +
    +

    ssl

    +

    OpenSSL 0.9.8, 1.0.0 and 1.0.1 are deprecated and no longer supported. +In the future the ssl module will require at least OpenSSL 1.0.2 or +1.1.0.

    +

    SSL-related arguments like certfile, keyfile and check_hostname +in ftplib, http.client, imaplib, poplib, +and smtplib have been deprecated in favor of context. +(Contributed by Christian Heimes in bpo-28022.)

    +

    A couple of protocols and functions of the ssl module are now +deprecated. Some features will no longer be available in future versions +of OpenSSL. Other features are deprecated in favor of a different API. +(Contributed by Christian Heimes in bpo-28022 and bpo-26470.)

    +
    +
    +

    tkinter

    +

    The tkinter.tix module is now deprecated. tkinter users +should use tkinter.ttk instead.

    +
    +
    +

    venv

    +

    The pyvenv script has been deprecated in favour of python3 -m venv. +This prevents confusion as to what Python interpreter pyvenv is +connected to and thus what Python interpreter will be used by the virtual +environment. (Contributed by Brett Cannon in bpo-25154.)

    +
    +
    +
    +

    Deprecated functions and types of the C API

    +

    Undocumented functions PyUnicode_AsEncodedObject(), +PyUnicode_AsDecodedObject(), PyUnicode_AsEncodedUnicode() +and PyUnicode_AsDecodedUnicode() are deprecated now. +Use the generic codec based API instead.

    +
    +
    +

    Deprecated Build Options

    +

    The --with-system-ffi configure flag is now on by default on non-macOS +UNIX platforms. It may be disabled by using --without-system-ffi, but +using the flag is deprecated and will not be accepted in Python 3.7. +macOS is unaffected by this change. Note that many OS distributors already +use the --with-system-ffi flag when building their system Python.

    +
    +
    +
    +

    Removed

    +
    +

    API and Feature Removals

    +
      +
    • Unknown escapes consisting of '\' and an ASCII letter in +regular expressions will now cause an error. In replacement templates for +re.sub() they are still allowed, but deprecated. +The re.LOCALE flag can now only be used with binary patterns.

    • +
    • inspect.getmoduleinfo() was removed (was deprecated since CPython 3.3). +inspect.getmodulename() should be used for obtaining the module +name for a given path. +(Contributed by Yury Selivanov in bpo-13248.)

    • +
    • traceback.Ignore class and traceback.usage, traceback.modname, +traceback.fullmodname, traceback.find_lines_from_code, +traceback.find_lines, traceback.find_strings, +traceback.find_executable_lines methods were removed from the +traceback module. They were undocumented methods deprecated since +Python 3.2 and equivalent functionality is available from private methods.

    • +
    • The tk_menuBar() and tk_bindForTraversal() dummy methods in +tkinter widget classes were removed (corresponding Tk commands +were obsolete since Tk 4.0).

    • +
    • The open() method of the zipfile.ZipFile +class no longer supports the 'U' mode (was deprecated since Python 3.4). +Use io.TextIOWrapper for reading compressed text files in +universal newlines mode.

    • +
    • The undocumented IN, CDROM, DLFCN, TYPES, CDIO, and +STROPTS modules have been removed. They had been available in the +platform specific Lib/plat-*/ directories, but were chronically out of +date, inconsistently available across platforms, and unmaintained. The +script that created these modules is still available in the source +distribution at Tools/scripts/h2py.py.

    • +
    • The deprecated asynchat.fifo class has been removed.

    • +
    +
    +
    +
    +

    Porting to Python 3.6

    +

    This section lists previously described changes and other bugfixes +that may require changes to your code.

    +
    +

    Changes in ‘python’ Command Behavior

    +
      +
    • The output of a special Python build with defined COUNT_ALLOCS, +SHOW_ALLOC_COUNT or SHOW_TRACK_COUNT macros is now off by +default. It can be re-enabled using the -X showalloccount option. +It now outputs to stderr instead of stdout. +(Contributed by Serhiy Storchaka in bpo-23034.)

    • +
    +
    +
    +

    Changes in the Python API

    +
      +
    • open() will no longer allow combining the 'U' mode flag +with '+'. +(Contributed by Jeff Balogh and John O’Connor in bpo-2091.)

    • +
    • sqlite3 no longer implicitly commits an open transaction before DDL +statements.

    • +
    • On Linux, os.urandom() now blocks until the system urandom entropy pool +is initialized to increase the security.

    • +
    • When importlib.abc.Loader.exec_module() is defined, +importlib.abc.Loader.create_module() must also be defined.

    • +
    • PyErr_SetImportError() now sets TypeError when its msg +argument is not set. Previously only NULL was returned.

    • +
    • The format of the co_lnotab attribute of code objects changed to support +a negative line number delta. By default, Python does not emit bytecode with +a negative line number delta. Functions using frame.f_lineno, +PyFrame_GetLineNumber() or PyCode_Addr2Line() are not affected. +Functions directly decoding co_lnotab should be updated to use a signed +8-bit integer type for the line number delta, but this is only required to +support applications using a negative line number delta. See +Objects/lnotab_notes.txt for the co_lnotab format and how to decode +it, and see the PEP 511 for the rationale.

    • +
    • The functions in the compileall module now return booleans instead +of 1 or 0 to represent success or failure, respectively. Thanks to +booleans being a subclass of integers, this should only be an issue if you +were doing identity checks for 1 or 0. See bpo-25768.

    • +
    • Reading the port attribute of +urllib.parse.urlsplit() and urlparse() results +now raises ValueError for out-of-range values, rather than +returning None. See bpo-20059.

    • +
    • The imp module now raises a DeprecationWarning instead of +PendingDeprecationWarning.

    • +
    • The following modules have had missing APIs added to their __all__ +attributes to match the documented APIs: +calendar, cgi, csv, +ElementTree, enum, +fileinput, ftplib, logging, mailbox, +mimetypes, optparse, plistlib, smtpd, +subprocess, tarfile, threading and +wave. This means they will export new symbols when import * +is used. +(Contributed by Joel Taddei and Jacek Kołodziej in bpo-23883.)

    • +
    • When performing a relative import, if __package__ does not compare equal +to __spec__.parent then ImportWarning is raised. +(Contributed by Brett Cannon in bpo-25791.)

    • +
    • When a relative import is performed and no parent package is known, then +ImportError will be raised. Previously, SystemError could be +raised. (Contributed by Brett Cannon in bpo-18018.)

    • +
    • Servers based on the socketserver module, including those +defined in http.server, xmlrpc.server and +wsgiref.simple_server, now only catch exceptions derived +from Exception. Therefore if a request handler raises +an exception like SystemExit or KeyboardInterrupt, +handle_error() is no longer called, and +the exception will stop a single-threaded server. (Contributed by +Martin Panter in bpo-23430.)

    • +
    • spwd.getspnam() now raises a PermissionError instead of +KeyError if the user doesn’t have privileges.

    • +
    • The socket.socket.close() method now raises an exception if +an error (e.g. EBADF) was reported by the underlying system call. +(Contributed by Martin Panter in bpo-26685.)

    • +
    • The decode_data argument for the smtpd.SMTPChannel and +smtpd.SMTPServer constructors is now False by default. +This means that the argument passed to +process_message() is now a bytes object by +default, and process_message() will be passed keyword arguments. +Code that has already been updated in accordance with the deprecation +warning generated by 3.5 will not be affected.

    • +
    • All optional arguments of the dump(), dumps(), +load() and loads() functions and +JSONEncoder and JSONDecoder class +constructors in the json module are now keyword-only. +(Contributed by Serhiy Storchaka in bpo-18726.)

    • +
    • Subclasses of type which don’t override type.__new__ may no +longer use the one-argument form to get the type of an object.

    • +
    • As part of PEP 487, the handling of keyword arguments passed to +type (other than the metaclass hint, metaclass) is now +consistently delegated to object.__init_subclass__(). This means that +type.__new__() and type.__init__() both now accept arbitrary +keyword arguments, but object.__init_subclass__() (which is called from +type.__new__()) will reject them by default. Custom metaclasses +accepting additional keyword arguments will need to adjust their calls to +type.__new__() (whether direct or via super) accordingly.

    • +
    • In distutils.command.sdist.sdist, the default_format +attribute has been removed and is no longer honored. Instead, the +gzipped tarfile format is the default on all platforms and no +platform-specific selection is made. +In environments where distributions are +built on Windows and zip distributions are required, configure +the project with a setup.cfg file containing the following:

      +
      [sdist]
      +formats=zip
      +
      +
      +

      This behavior has also been backported to earlier Python versions +by Setuptools 26.0.0.

      +
    • +
    • In the urllib.request module and the +http.client.HTTPConnection.request() method, if no Content-Length +header field has been specified and the request body is a file object, +it is now sent with HTTP 1.1 chunked encoding. If a file object has to +be sent to a HTTP 1.0 server, the Content-Length value now has to be +specified by the caller. +(Contributed by Demian Brecht and Rolf Krahl with tweaks from +Martin Panter in bpo-12319.)

    • +
    • The DictReader now returns rows of type +OrderedDict. +(Contributed by Steve Holden in bpo-27842.)

    • +
    • The crypt.METHOD_CRYPT will no longer be added to crypt.methods +if unsupported by the platform. +(Contributed by Victor Stinner in bpo-25287.)

    • +
    • The verbose and rename arguments for +namedtuple() are now keyword-only. +(Contributed by Raymond Hettinger in bpo-25628.)

    • +
    • On Linux, ctypes.util.find_library() now looks in +LD_LIBRARY_PATH for shared libraries. +(Contributed by Vinay Sajip in bpo-9998.)

    • +
    • The imaplib.IMAP4 class now handles flags containing the +']' character in messages sent from the server to improve +real-world compatibility. +(Contributed by Lita Cho in bpo-21815.)

    • +
    • The mmap.write() function now returns the number +of bytes written like other write methods. +(Contributed by Jakub Stasiak in bpo-26335.)

    • +
    • The pkgutil.iter_modules() and pkgutil.walk_packages() +functions now return ModuleInfo named tuples. +(Contributed by Ramchandra Apte in bpo-17211.)

    • +
    • re.sub() now raises an error for invalid numerical group +references in replacement templates even if the pattern is not +found in the string. The error message for invalid group references +now includes the group index and the position of the reference. +(Contributed by SilentGhost, Serhiy Storchaka in bpo-25953.)

    • +
    • zipfile.ZipFile will now raise NotImplementedError for +unrecognized compression values. Previously a plain RuntimeError +was raised. Additionally, calling ZipFile methods +on a closed ZipFile or calling the write() method +on a ZipFile created with mode 'r' will raise a ValueError. +Previously, a RuntimeError was raised in those scenarios.

    • +
    • when custom metaclasses are combined with zero-argument super() or +direct references from methods to the implicit __class__ closure +variable, the implicit __classcell__ namespace entry must now be passed +up to type.__new__ for initialisation. Failing to do so will result in +a DeprecationWarning in Python 3.6 and a RuntimeError in +Python 3.8.

    • +
    • With the introduction of ModuleNotFoundError, import system consumers +may start expecting import system replacements to raise that more specific +exception when appropriate, rather than the less-specific ImportError. +To provide future compatibility with such consumers, implementors of +alternative import systems that completely replace __import__() will +need to update their implementations to raise the new subclass when a module +can’t be found at all. Implementors of compliant plugins to the default +import system shouldn’t need to make any changes, as the default import +system will raise the new subclass when appropriate.

    • +
    +
    +
    +

    Changes in the C API

    +
      +
    • The PyMem_Malloc() allocator family now uses the pymalloc allocator rather than the system malloc(). Applications calling +PyMem_Malloc() without holding the GIL can now crash. Set the +PYTHONMALLOC environment variable to debug to validate the +usage of memory allocators in your application. See bpo-26249.

    • +
    • Py_Exit() (and the main interpreter) now override the exit status +with 120 if flushing buffered data failed. See bpo-5319.

    • +
    +
    +
    +

    CPython bytecode changes

    +

    There have been several major changes to the bytecode in Python 3.6.

    + +
    +
    +
    +

    Notable changes in Python 3.6.2

    +
    +

    New make regen-all build target

    +

    To simplify cross-compilation, and to ensure that CPython can reliably be +compiled without requiring an existing version of Python to already be +available, the autotools-based build system no longer attempts to implicitly +recompile generated files based on file modification times.

    +

    Instead, a new make regen-all command has been added to force regeneration +of these files when desired (e.g. after an initial version of Python has +already been built based on the pregenerated versions).

    +

    More selective regeneration targets are also defined - see +Makefile.pre.in for details.

    +

    (Contributed by Victor Stinner in bpo-23404.)

    +
    +

    New in version 3.6.2.

    +
    +
    +
    +

    Removal of make touch build target

    +

    The make touch build target previously used to request implicit regeneration +of generated files by updating their modification times has been removed.

    +

    It has been replaced by the new make regen-all target.

    +

    (Contributed by Victor Stinner in bpo-23404.)

    +
    +

    Changed in version 3.6.2.

    +
    +
    +
    +
    +

    Notable changes in Python 3.6.4

    +

    The PyExc_RecursionErrorInst singleton that was part of the public API +has been removed as its members being never cleared may cause a segfault +during finalization of the interpreter. +(Contributed by Xavier de Gaye in bpo-22898 and bpo-30697.)

    +
    +
    +

    Notable changes in Python 3.6.5

    +

    The locale.localeconv() function now sets temporarily the LC_CTYPE +locale to the LC_NUMERIC locale in some cases. +(Contributed by Victor Stinner in bpo-31900.)

    +
    +
    +

    Notable changes in Python 3.6.7

    +

    In 3.6.7 the tokenize module now implicitly emits a NEWLINE token +when provided with input that does not have a trailing new line. This behavior +now matches what the C tokenizer does internally. +(Contributed by Ammar Askar in bpo-33899.)

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/whatsnew/3.7.html b/python-3.7.4-docs-html/whatsnew/3.7.html new file mode 100644 index 0000000..2df28ec --- /dev/null +++ b/python-3.7.4-docs-html/whatsnew/3.7.html @@ -0,0 +1,2356 @@ + + + + + + + What’s New In Python 3.7 — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    What’s New In Python 3.7

    +
    +
    Editor
    +

    Elvis Pranskevichus <elvis@magic.io>

    +
    +
    +

    This article explains the new features in Python 3.7, compared to 3.6. +Python 3.7 was released on June 27, 2018. +For full details, see the changelog.

    +
    +

    Summary – Release Highlights

    +

    New syntax features:

    +
      +
    • PEP 563, postponed evaluation of type annotations.

    • +
    +

    Backwards incompatible syntax changes:

    + +

    New library modules:

    + +

    New built-in features:

    + +

    Python data model improvements:

    +
      +
    • PEP 562, customization of access to +module attributes.

    • +
    • PEP 560, core support for typing module and +generic types.

    • +
    • the insertion-order preservation nature of dict +objects has been declared to be an official +part of the Python language spec.

    • +
    +

    Significant improvements in the standard library:

    + +

    CPython implementation improvements:

    + +

    C API improvements:

    +
      +
    • PEP 539, new C API for thread-local storage

    • +
    +

    Documentation improvements:

    + +

    This release features notable performance improvements in many areas. +The Optimizations section lists them in detail.

    +

    For a list of changes that may affect compatibility with previous Python +releases please refer to the Porting to Python 3.7 section.

    +
    +
    +

    New Features

    +
    +

    PEP 563: Postponed Evaluation of Annotations

    +

    The advent of type hints in Python uncovered two glaring usability issues +with the functionality of annotations added in PEP 3107 and refined +further in PEP 526:

    +
      +
    • annotations could only use names which were already available in the +current scope, in other words they didn’t support forward references +of any kind; and

    • +
    • annotating source code had adverse effects on startup time of Python +programs.

    • +
    +

    Both of these issues are fixed by postponing the evaluation of +annotations. Instead of compiling code which executes expressions in +annotations at their definition time, the compiler stores the annotation +in a string form equivalent to the AST of the expression in question. +If needed, annotations can be resolved at runtime using +typing.get_type_hints(). In the common case where this is not +required, the annotations are cheaper to store (since short strings +are interned by the interpreter) and make startup time faster.

    +

    Usability-wise, annotations now support forward references, making the +following syntax valid:

    +
    class C:
    +    @classmethod
    +    def from_string(cls, source: str) -> C:
    +        ...
    +
    +    def validate_b(self, obj: B) -> bool:
    +        ...
    +
    +class B:
    +    ...
    +
    +
    +

    Since this change breaks compatibility, the new behavior needs to be enabled +on a per-module basis in Python 3.7 using a __future__ import:

    +
    from __future__ import annotations
    +
    +
    +

    It will become the default in Python 4.0.

    +
    +

    See also

    +
    +
    PEP 563 – Postponed evaluation of annotations

    PEP written and implemented by Łukasz Langa.

    +
    +
    +
    +
    +
    +

    PEP 538: Legacy C Locale Coercion

    +

    An ongoing challenge within the Python 3 series has been determining a sensible +default strategy for handling the “7-bit ASCII” text encoding assumption +currently implied by the use of the default C or POSIX locale on non-Windows +platforms.

    +

    PEP 538 updates the default interpreter command line interface to +automatically coerce that locale to an available UTF-8 based locale as +described in the documentation of the new PYTHONCOERCECLOCALE +environment variable. Automatically setting LC_CTYPE this way means that +both the core interpreter and locale-aware C extensions (such as +readline) will assume the use of UTF-8 as the default text encoding, +rather than ASCII.

    +

    The platform support definition in PEP 11 has also been updated to limit +full text handling support to suitably configured non-ASCII based locales.

    +

    As part of this change, the default error handler for stdin and +stdout is now surrogateescape (rather than strict) when +using any of the defined coercion target locales (currently C.UTF-8, +C.utf8, and UTF-8). The default error handler for stderr +continues to be backslashreplace, regardless of locale.

    +

    Locale coercion is silent by default, but to assist in debugging potentially +locale related integration problems, explicit warnings (emitted directly on +stderr) can be requested by setting PYTHONCOERCECLOCALE=warn. +This setting will also cause the Python runtime to emit a warning if the +legacy C locale remains active when the core interpreter is initialized.

    +

    While PEP 538’s locale coercion has the benefit of also affecting extension +modules (such as GNU readline), as well as child processes (including those +running non-Python applications and older versions of Python), it has the +downside of requiring that a suitable target locale be present on the running +system. To better handle the case where no suitable target locale is available +(as occurs on RHEL/CentOS 7, for example), Python 3.7 also implements +PEP 540: Forced UTF-8 Runtime Mode.

    +
    +

    See also

    +
    +
    PEP 538 – Coercing the legacy C locale to a UTF-8 based locale

    PEP written and implemented by Nick Coghlan.

    +
    +
    +
    +
    +
    +

    PEP 540: Forced UTF-8 Runtime Mode

    +

    The new -X utf8 command line option and PYTHONUTF8 +environment variable can be used to enable the CPython UTF-8 mode.

    +

    When in UTF-8 mode, CPython ignores the locale settings, and uses the +UTF-8 encoding by default. The error handlers for sys.stdin and +sys.stdout streams are set to surrogateescape.

    +

    The forced UTF-8 mode can be used to change the text handling behavior in +an embedded Python interpreter without changing the locale settings of +an embedding application.

    +

    While PEP 540’s UTF-8 mode has the benefit of working regardless of which +locales are available on the running system, it has the downside of having no +effect on extension modules (such as GNU readline), child processes running +non-Python applications, and child processes running older versions of Python. +To reduce the risk of corrupting text data when communicating with such +components, Python 3.7 also implements PEP 540: Forced UTF-8 Runtime Mode).

    +

    The UTF-8 mode is enabled by default when the locale is C or POSIX, and +the PEP 538 locale coercion feature fails to change it to a UTF-8 based +alternative (whether that failure is due to PYTHONCOERCECLOCALE=0 being set, +LC_ALL being set, or the lack of a suitable target locale).

    +
    +

    See also

    +
    +
    PEP 540 – Add a new UTF-8 mode

    PEP written and implemented by Victor Stinner

    +
    +
    +
    +
    +
    +

    PEP 553: Built-in breakpoint()

    +

    Python 3.7 includes the new built-in breakpoint() function as +an easy and consistent way to enter the Python debugger.

    +

    Built-in breakpoint() calls sys.breakpointhook(). By default, the +latter imports pdb and then calls pdb.set_trace(), but by binding +sys.breakpointhook() to the function of your choosing, breakpoint() can +enter any debugger. Additionally, the environment variable +PYTHONBREAKPOINT can be set to the callable of your debugger of +choice. Set PYTHONBREAKPOINT=0 to completely disable built-in +breakpoint().

    +
    +

    See also

    +
    +
    PEP 553 – Built-in breakpoint()

    PEP written and implemented by Barry Warsaw

    +
    +
    +
    +
    +
    +

    PEP 539: New C API for Thread-Local Storage

    +

    While Python provides a C API for thread-local storage support; the existing +Thread Local Storage (TLS) API has used +int to represent TLS keys across all platforms. This has not +generally been a problem for officially-support platforms, but that is neither +POSIX-compliant, nor portable in any practical sense.

    +

    PEP 539 changes this by providing a new Thread Specific Storage (TSS) +API to CPython which supersedes use of the +existing TLS API within the CPython interpreter, while deprecating the existing +API. The TSS API uses a new type Py_tss_t instead of int +to represent TSS keys–an opaque type the definition of which may depend on +the underlying TLS implementation. Therefore, this will allow to build CPython +on platforms where the native TLS key is defined in a way that cannot be safely +cast to int.

    +

    Note that on platforms where the native TLS key is defined in a way that cannot +be safely cast to int, all functions of the existing TLS API will be +no-op and immediately return failure. This indicates clearly that the old API +is not supported on platforms where it cannot be used reliably, and that no +effort will be made to add such support.

    +
    +

    See also

    +
    +
    PEP 539 – A New C-API for Thread-Local Storage in CPython

    PEP written by Erik M. Bray; implementation by Masayuki Yamamoto.

    +
    +
    +
    +
    +
    +

    PEP 562: Customization of Access to Module Attributes

    +

    Python 3.7 allows defining __getattr__() on modules and will call +it whenever a module attribute is otherwise not found. Defining +__dir__() on modules is now also allowed.

    +

    A typical example of where this may be useful is module attribute deprecation +and lazy loading.

    +
    +

    See also

    +
    +
    PEP 562 – Module __getattr__ and __dir__

    PEP written and implemented by Ivan Levkivskyi

    +
    +
    +
    +
    +
    +

    PEP 564: New Time Functions With Nanosecond Resolution

    +

    The resolution of clocks in modern systems can exceed the limited precision +of a floating point number returned by the time.time() function +and its variants. To avoid loss of precision, PEP 564 adds six new +“nanosecond” variants of the existing timer functions to the time +module:

    + +

    The new functions return the number of nanoseconds as an integer value.

    +

    Measurements +show that on Linux and Windows the resolution of time.time_ns() is +approximately 3 times better than that of time.time().

    +
    +

    See also

    +
    +
    PEP 564 – Add new time functions with nanosecond resolution

    PEP written and implemented by Victor Stinner

    +
    +
    +
    +
    +
    +

    PEP 565: Show DeprecationWarning in __main__

    +

    The default handling of DeprecationWarning has been changed such that +these warnings are once more shown by default, but only when the code +triggering them is running directly in the __main__ module. As a result, +developers of single file scripts and those using Python interactively should +once again start seeing deprecation warnings for the APIs they use, but +deprecation warnings triggered by imported application, library and framework +modules will continue to be hidden by default.

    +

    As a result of this change, the standard library now allows developers to choose +between three different deprecation warning behaviours:

    +
      +
    • FutureWarning: always displayed by default, recommended for warnings +intended to be seen by application end users (e.g. for deprecated application +configuration settings).

    • +
    • DeprecationWarning: displayed by default only in __main__ and when +running tests, recommended for warnings intended to be seen by other Python +developers where a version upgrade may result in changed behaviour or an +error.

    • +
    • PendingDeprecationWarning: displayed by default only when running +tests, intended for cases where a future version upgrade will change the +warning category to DeprecationWarning or FutureWarning.

    • +
    +

    Previously both DeprecationWarning and PendingDeprecationWarning +were only visible when running tests, which meant that developers primarily +writing single file scripts or using Python interactively could be surprised +by breaking changes in the APIs they used.

    +
    +

    See also

    +
    +
    PEP 565 – Show DeprecationWarning in __main__

    PEP written and implemented by Nick Coghlan

    +
    +
    +
    +
    +
    +

    PEP 560: Core Support for typing module and Generic Types

    +

    Initially PEP 484 was designed in such way that it would not introduce any +changes to the core CPython interpreter. Now type hints and the typing +module are extensively used by the community, so this restriction is removed. +The PEP introduces two special methods __class_getitem__() and +__mro_entries__, these methods are now used by most classes and special +constructs in typing. As a result, the speed of various operations +with types increased up to 7 times, the generic types can be used without +metaclass conflicts, and several long standing bugs in typing module are +fixed.

    +
    +

    See also

    +
    +
    PEP 560 – Core support for typing module and generic types

    PEP written and implemented by Ivan Levkivskyi

    +
    +
    +
    +
    +
    +

    PEP 552: Hash-based .pyc Files

    +

    Python has traditionally checked the up-to-dateness of bytecode cache files +(i.e., .pyc files) by comparing the source metadata (last-modified timestamp +and size) with source metadata saved in the cache file header when it was +generated. While effective, this invalidation method has its drawbacks. When +filesystem timestamps are too coarse, Python can miss source updates, leading to +user confusion. Additionally, having a timestamp in the cache file is +problematic for build reproducibility and +content-based build systems.

    +

    PEP 552 extends the pyc format to allow the hash of the source file to be +used for invalidation instead of the source timestamp. Such .pyc files are +called “hash-based”. By default, Python still uses timestamp-based invalidation +and does not generate hash-based .pyc files at runtime. Hash-based .pyc +files may be generated with py_compile or compileall.

    +

    Hash-based .pyc files come in two variants: checked and unchecked. Python +validates checked hash-based .pyc files against the corresponding source +files at runtime but doesn’t do so for unchecked hash-based pycs. Unchecked +hash-based .pyc files are a useful performance optimization for environments +where a system external to Python (e.g., the build system) is responsible for +keeping .pyc files up-to-date.

    +

    See Cached bytecode invalidation for more information.

    +
    +

    See also

    +
    +
    PEP 552 – Deterministic pycs

    PEP written and implemented by Benjamin Peterson

    +
    +
    +
    +
    +
    +

    PEP 545: Python Documentation Translations

    +

    PEP 545 describes the process of creating and maintaining Python +documentation translations.

    +

    Three new translations have been added:

    + +
    +

    See also

    +
    +
    PEP 545 – Python Documentation Translations

    PEP written and implemented by Julien Palard, Inada Naoki, and +Victor Stinner.

    +
    +
    +
    +
    +
    +

    Development Runtime Mode: -X dev

    +

    The new -X dev command line option or the new +PYTHONDEVMODE environment variable can be used to enable +CPython’s development mode. When in development mode, CPython performs +additional runtime checks that are too expensive to be enabled by default. +See -X dev documentation for the full description of the effects +of this mode.

    +
    +
    +
    +

    Other Language Changes

    +
      +
    • More than 255 arguments can now be passed to a function, and a function can +now have more than 255 parameters. (Contributed by Serhiy Storchaka in +bpo-12844 and bpo-18896.)

    • +
    • bytes.fromhex() and bytearray.fromhex() now ignore all ASCII +whitespace, not only spaces. (Contributed by Robert Xiao in bpo-28927.)

    • +
    • str, bytes, and bytearray gained support for +the new isascii() method, which can be used to +test if a string or bytes contain only the ASCII characters. +(Contributed by INADA Naoki in bpo-32677.)

    • +
    • ImportError now displays module name and module __file__ path when +from ... import ... fails. (Contributed by Matthias Bussonnier in +bpo-29546.)

    • +
    • Circular imports involving absolute imports with binding a submodule to +a name are now supported. +(Contributed by Serhiy Storchaka in bpo-30024.)

    • +
    • object.__format__(x, '') is now equivalent to str(x) rather than +format(str(self), ''). +(Contributed by Serhiy Storchaka in bpo-28974.)

    • +
    • In order to better support dynamic creation of stack traces, +types.TracebackType can now be instantiated from Python code, and +the tb_next attribute on tracebacks is now +writable. +(Contributed by Nathaniel J. Smith in bpo-30579.)

    • +
    • When using the -m switch, sys.path[0] is now eagerly expanded +to the full starting directory path, rather than being left as the empty +directory (which allows imports from the current working directory at the +time when an import occurs) +(Contributed by Nick Coghlan in bpo-33053.)

    • +
    • The new -X importtime option or the +PYTHONPROFILEIMPORTTIME environment variable can be used to show +the timing of each module import. +(Contributed by Victor Stinner in bpo-31415.)

    • +
    +
    +
    +

    New Modules

    +
    +

    contextvars

    +

    The new contextvars module and a set of +new C APIs introduce +support for context variables. Context variables are conceptually +similar to thread-local variables. Unlike TLS, context variables +support asynchronous code correctly.

    +

    The asyncio and decimal modules have been updated to use +and support context variables out of the box. Particularly the active +decimal context is now stored in a context variable, which allows +decimal operations to work with the correct context in asynchronous code.

    +
    +

    See also

    +
    +
    PEP 567 – Context Variables

    PEP written and implemented by Yury Selivanov

    +
    +
    +
    +
    +
    +

    dataclasses

    +

    The new dataclass() decorator provides a way to declare +data classes. A data class describes its attributes using class variable +annotations. Its constructor and other magic methods, such as +__repr__(), __eq__(), and +__hash__() are generated automatically.

    +

    Example:

    +
    @dataclass
    +class Point:
    +    x: float
    +    y: float
    +    z: float = 0.0
    +
    +p = Point(1.5, 2.5)
    +print(p)   # produces "Point(x=1.5, y=2.5, z=0.0)"
    +
    +
    +
    +

    See also

    +
    +
    PEP 557 – Data Classes

    PEP written and implemented by Eric V. Smith

    +
    +
    +
    +
    +
    +

    importlib.resources

    +

    The new importlib.resources module provides several new APIs and one +new ABC for access to, opening, and reading resources inside packages. +Resources are roughly similar to files inside packages, but they needn’t +be actual files on the physical file system. Module loaders can provide a +get_resource_reader() function which returns +a importlib.abc.ResourceReader instance to support this +new API. Built-in file path loaders and zip file loaders both support this.

    +

    Contributed by Barry Warsaw and Brett Cannon in bpo-32248.

    +
    +

    See also

    +

    importlib_resources +– a PyPI backport for earlier Python versions.

    +
    +
    +
    +
    +

    Improved Modules

    +
    +

    argparse

    +

    The new ArgumentParser.parse_intermixed_args() +method allows intermixing options and positional arguments. +(Contributed by paul.j3 in bpo-14191.)

    +
    +
    +

    asyncio

    +

    The asyncio module has received many new features, usability and +performance improvements. Notable changes +include:

    + +

    Several asyncio APIs have been +deprecated.

    +
    +
    +

    binascii

    +

    The b2a_uu() function now accepts an optional backtick +keyword argument. When it’s true, zeros are represented by '`' +instead of spaces. (Contributed by Xiang Zhang in bpo-30103.)

    +
    +
    +

    calendar

    +

    The HTMLCalendar class has new class attributes which ease +the customization of CSS classes in the produced HTML calendar. +(Contributed by Oz Tiram in bpo-30095.)

    +
    +
    +

    collections

    +

    collections.namedtuple() now supports default values. +(Contributed by Raymond Hettinger in bpo-32320.)

    +
    +
    +

    compileall

    +

    compileall.compile_dir() learned the new invalidation_mode parameter, +which can be used to enable +hash-based .pyc invalidation. The invalidation +mode can also be specified on the command line using the new +--invalidation-mode argument. +(Contributed by Benjamin Peterson in bpo-31650.)

    +
    +
    +

    concurrent.futures

    +

    ProcessPoolExecutor and +ThreadPoolExecutor now +support the new initializer and initargs constructor arguments. +(Contributed by Antoine Pitrou in bpo-21423.)

    +

    The ProcessPoolExecutor +can now take the multiprocessing context via the new mp_context argument. +(Contributed by Thomas Moreau in bpo-31540.)

    +
    +
    +

    contextlib

    +

    The new nullcontext() is a simpler and faster no-op +context manager than ExitStack. +(Contributed by Jesse-Bakker in bpo-10049.)

    +

    The new asynccontextmanager(), +AbstractAsyncContextManager, and +AsyncExitStack have been added to +complement their synchronous counterparts. (Contributed +by Jelle Zijlstra in bpo-29679 and bpo-30241, +and by Alexander Mohr and Ilya Kulakov in bpo-29302.)

    +
    +
    +

    cProfile

    +

    The cProfile command line now accepts -m module_name as an +alternative to script path. (Contributed by Sanyam Khurana in bpo-21862.)

    +
    +
    +

    crypt

    +

    The crypt module now supports the Blowfish hashing method. +(Contributed by Serhiy Storchaka in bpo-31664.)

    +

    The mksalt() function now allows specifying the number of rounds +for hashing. (Contributed by Serhiy Storchaka in bpo-31702.)

    +
    +
    +

    datetime

    +

    The new datetime.fromisoformat() +method constructs a datetime object from a string +in one of the formats output by +datetime.isoformat(). +(Contributed by Paul Ganssle in bpo-15873.)

    +

    The tzinfo class now supports sub-minute offsets. +(Contributed by Alexander Belopolsky in bpo-5288.)

    +
    +
    +

    dbm

    +

    dbm.dumb now supports reading read-only files and no longer writes the +index file when it is not changed.

    +
    +
    +

    decimal

    +

    The decimal module now uses context variables +to store the decimal context. +(Contributed by Yury Selivanov in bpo-32630.)

    +
    +
    +

    dis

    +

    The dis() function is now able to +disassemble nested code objects (the code of comprehensions, generator +expressions and nested functions, and the code used for building nested +classes). The maximum depth of disassembly recursion is controlled by +the new depth parameter. +(Contributed by Serhiy Storchaka in bpo-11822.)

    +
    +
    +

    distutils

    +

    README.rst is now included in the list of distutils standard READMEs and +therefore included in source distributions. +(Contributed by Ryan Gonzalez in bpo-11913.)

    +
    +
    +

    enum

    +

    The Enum learned the new _ignore_ class property, +which allows listing the names of properties which should not become +enum members. +(Contributed by Ethan Furman in bpo-31801.)

    +

    In Python 3.8, attempting to check for non-Enum objects in Enum +classes will raise a TypeError (e.g. 1 in Color); similarly, +attempting to check for non-Flag objects in a Flag member will +raise TypeError (e.g. 1 in Perm.RW); currently, both operations +return False instead and are deprecated. +(Contributed by Ethan Furman in bpo-33217.)

    +
    +
    +

    functools

    +

    functools.singledispatch() now supports registering implementations +using type annotations. +(Contributed by Łukasz Langa in bpo-32227.)

    +
    +
    +

    gc

    +

    The new gc.freeze() function allows freezing all objects tracked +by the garbage collector and excluding them from future collections. +This can be used before a POSIX fork() call to make the GC copy-on-write +friendly or to speed up collection. The new gc.unfreeze() functions +reverses this operation. Additionally, gc.get_freeze_count() can +be used to obtain the number of frozen objects. +(Contributed by Li Zekun in bpo-31558.)

    +
    +
    +

    hmac

    +

    The hmac module now has an optimized one-shot digest() +function, which is up to three times faster than HMAC(). +(Contributed by Christian Heimes in bpo-32433.)

    +
    +
    +

    http.client

    +

    HTTPConnection and HTTPSConnection +now support the new blocksize argument for improved upload throughput. +(Contributed by Nir Soffer in bpo-31945.)

    +
    +
    +

    http.server

    +

    SimpleHTTPRequestHandler now supports the HTTP +If-Modified-Since header. The server returns the 304 response status if +the target file was not modified after the time specified in the header. +(Contributed by Pierre Quentel in bpo-29654.)

    +

    SimpleHTTPRequestHandler accepts the new directory +argument, in addition to the new --directory command line argument. +With this parameter, the server serves the specified directory, by default it +uses the current working directory. +(Contributed by Stéphane Wirtel and Julien Palard in bpo-28707.)

    +

    The new ThreadingHTTPServer class +uses threads to handle requests using ThreadingMixin. +It is used when http.server is run with -m. +(Contributed by Julien Palard in bpo-31639.)

    +
    +
    +

    idlelib and IDLE

    +

    Multiple fixes for autocompletion. (Contributed by Louie Lu in bpo-15786.)

    +

    Module Browser (on the File menu, formerly called Class Browser), +now displays nested functions and classes in addition to top-level +functions and classes. +(Contributed by Guilherme Polo, Cheryl Sabella, and Terry Jan Reedy +in bpo-1612262.)

    +

    The Settings dialog (Options, Configure IDLE) has been partly rewritten +to improve both appearance and function. +(Contributed by Cheryl Sabella and Terry Jan Reedy in multiple issues.)

    +

    The font sample now includes a selection of non-Latin characters so that +users can better see the effect of selecting a particular font. +(Contributed by Terry Jan Reedy in bpo-13802.) +The sample can be edited to include other characters. +(Contributed by Serhiy Storchaka in bpo-31860.)

    +

    The IDLE features formerly implemented as extensions have been reimplemented +as normal features. Their settings have been moved from the Extensions tab +to other dialog tabs. +(Contributed by Charles Wohlganger and Terry Jan Reedy in bpo-27099.)

    +

    Editor code context option revised. Box displays all context lines up to +maxlines. Clicking on a context line jumps the editor to that line. Context +colors for custom themes is added to Highlights tab of Settings dialog. +(Contributed by Cheryl Sabella and Terry Jan Reedy in bpo-33642, +bpo-33768, and bpo-33679.)

    +

    On Windows, a new API call tells Windows that tk scales for DPI. On Windows +8.1+ or 10, with DPI compatibility properties of the Python binary +unchanged, and a monitor resolution greater than 96 DPI, this should +make text and lines sharper. It should otherwise have no effect. +(Contributed by Terry Jan Reedy in bpo-33656.)

    +

    New in 3.7.1:

    +

    Output over N lines (50 by default) is squeezed down to a button. +N can be changed in the PyShell section of the General page of the +Settings dialog. Fewer, but possibly extra long, lines can be squeezed by +right clicking on the output. Squeezed output can be expanded in place +by double-clicking the button or into the clipboard or a separate window +by right-clicking the button. (Contributed by Tal Einat in bpo-1529353.)

    +

    The changes above have been backported to 3.6 maintenance releases.

    +
    +
    +

    importlib

    +

    The importlib.abc.ResourceReader ABC was introduced to +support the loading of resources from packages. See also +importlib.resources. +(Contributed by Barry Warsaw, Brett Cannon in bpo-32248.)

    +

    importlib.reload() now raises ModuleNotFoundError if the module +lacks a spec. +(Contributed by Garvit Khatri in bpo-29851.)

    +

    importlib.find_spec() now raises ModuleNotFoundError instead of +AttributeError if the specified parent module is not a package (i.e. +lacks a __path__ attribute). +(Contributed by Milan Oberkirch in bpo-30436.)

    +

    The new importlib.source_hash() can be used to compute the hash of +the passed source. A hash-based .pyc file +embeds the value returned by this function.

    +
    +
    +

    io

    +

    The new TextIOWrapper.reconfigure() +method can be used to reconfigure the text stream with the new settings. +(Contributed by Antoine Pitrou in bpo-30526 and +INADA Naoki in bpo-15216.)

    +
    +
    +

    ipaddress

    +

    The new subnet_of() and supernet_of() methods of +ipaddress.IPv6Network and ipaddress.IPv4Network can +be used for network containment tests. +(Contributed by Michel Albert and Cheryl Sabella in bpo-20825.)

    +
    +
    +

    itertools

    +

    itertools.islice() now accepts +integer-like objects as start, stop, +and slice arguments. +(Contributed by Will Roberts in bpo-30537.)

    +
    +
    +

    locale

    +

    The new monetary argument to locale.format_string() can be used +to make the conversion use monetary thousands separators and +grouping strings. (Contributed by Garvit in bpo-10379.)

    +

    The locale.getpreferredencoding() function now always returns 'UTF-8' +on Android or when in the forced UTF-8 mode.

    +
    +
    +

    logging

    +

    Logger instances can now be pickled. +(Contributed by Vinay Sajip in bpo-30520.)

    +

    The new StreamHandler.setStream() +method can be used to replace the logger stream after handler creation. +(Contributed by Vinay Sajip in bpo-30522.)

    +

    It is now possible to specify keyword arguments to handler constructors in +configuration passed to logging.config.fileConfig(). +(Contributed by Preston Landers in bpo-31080.)

    +
    +
    +

    math

    +

    The new math.remainder() function implements the IEEE 754-style remainder +operation. (Contributed by Mark Dickinson in bpo-29962.)

    +
    +
    +

    mimetypes

    +

    The MIME type of .bmp has been changed from 'image/x-ms-bmp' to +'image/bmp'. +(Contributed by Nitish Chandra in bpo-22589.)

    +
    +
    +

    msilib

    +

    The new Database.Close() method can be used +to close the MSI database. +(Contributed by Berker Peksag in bpo-20486.)

    +
    +
    +

    multiprocessing

    +

    The new Process.close() method +explicitly closes the process object and releases all resources associated +with it. ValueError is raised if the underlying process is still +running. +(Contributed by Antoine Pitrou in bpo-30596.)

    +

    The new Process.kill() method can +be used to terminate the process using the SIGKILL signal on Unix. +(Contributed by Vitor Pereira in bpo-30794.)

    +

    Non-daemonic threads created by Process are now +joined on process exit. +(Contributed by Antoine Pitrou in bpo-18966.)

    +
    +
    +

    os

    +

    os.fwalk() now accepts the path argument as bytes. +(Contributed by Serhiy Storchaka in bpo-28682.)

    +

    os.scandir() gained support for file descriptors. +(Contributed by Serhiy Storchaka in bpo-25996.)

    +

    The new register_at_fork() function allows registering Python +callbacks to be executed at process fork. +(Contributed by Antoine Pitrou in bpo-16500.)

    +

    Added os.preadv() (combine the functionality of os.readv() and +os.pread()) and os.pwritev() functions (combine the functionality +of os.writev() and os.pwrite()). (Contributed by Pablo Galindo in +bpo-31368.)

    +

    The mode argument of os.makedirs() no longer affects the file +permission bits of newly-created intermediate-level directories. +(Contributed by Serhiy Storchaka in bpo-19930.)

    +

    os.dup2() now returns the new file descriptor. Previously, None +was always returned. +(Contributed by Benjamin Peterson in bpo-32441.)

    +

    The structure returned by os.stat() now contains the +st_fstype attribute on Solaris and its derivatives. +(Contributed by Jesús Cea Avión in bpo-32659.)

    +
    +
    +

    pathlib

    +

    The new Path.is_mount() method is now available +on POSIX systems and can be used to determine whether a path is a mount point. +(Contributed by Cooper Ry Lees in bpo-30897.)

    +
    +
    +

    pdb

    +

    pdb.set_trace() now takes an optional header keyword-only +argument. If given, it is printed to the console just before debugging +begins. (Contributed by Barry Warsaw in bpo-31389.)

    +

    pdb command line now accepts -m module_name as an alternative to +script file. (Contributed by Mario Corchero in bpo-32206.)

    +
    +
    +

    py_compile

    +

    py_compile.compile() – and by extension, compileall – now +respects the SOURCE_DATE_EPOCH environment variable by +unconditionally creating .pyc files for hash-based validation. +This allows for guaranteeing +reproducible builds of .pyc +files when they are created eagerly. (Contributed by Bernhard M. Wiedemann +in bpo-29708.)

    +
    +
    +

    pydoc

    +

    The pydoc server can now bind to an arbitrary hostname specified by the +new -n command-line argument. +(Contributed by Feanil Patel in bpo-31128.)

    +
    +
    +

    queue

    +

    The new SimpleQueue class is an unbounded FIFO queue. +(Contributed by Antoine Pitrou in bpo-14976.)

    +
    +
    +

    re

    +

    The flags re.ASCII, re.LOCALE and re.UNICODE +can be set within the scope of a group. +(Contributed by Serhiy Storchaka in bpo-31690.)

    +

    re.split() now supports splitting on a pattern like r'\b', +'^$' or (?=-) that matches an empty string. +(Contributed by Serhiy Storchaka in bpo-25054.)

    +

    Regular expressions compiled with the re.LOCALE flag no longer +depend on the locale at compile time. Locale settings are applied only +when the compiled regular expression is used. +(Contributed by Serhiy Storchaka in bpo-30215.)

    +

    FutureWarning is now emitted if a regular expression contains +character set constructs that will change semantically in the future, +such as nested sets and set operations. +(Contributed by Serhiy Storchaka in bpo-30349.)

    +

    Compiled regular expression and match objects can now be copied +using copy.copy() and copy.deepcopy(). +(Contributed by Serhiy Storchaka in bpo-10076.)

    +
    +
    +

    signal

    +

    The new warn_on_full_buffer argument to the signal.set_wakeup_fd() +function makes it possible to specify whether Python prints a warning on +stderr when the wakeup buffer overflows. +(Contributed by Nathaniel J. Smith in bpo-30050.)

    +
    +
    +

    socket

    +

    The new socket.getblocking() method +returns True if the socket is in blocking mode and False otherwise. +(Contributed by Yury Selivanov in bpo-32373.)

    +

    The new socket.close() function closes the passed socket file descriptor. +This function should be used instead of os.close() for better +compatibility across platforms. +(Contributed by Christian Heimes in bpo-32454.)

    +

    The socket module now exposes the socket.TCP_CONGESTION +(Linux 2.6.13), socket.TCP_USER_TIMEOUT (Linux 2.6.37), and +socket.TCP_NOTSENT_LOWAT (Linux 3.12) constants. +(Contributed by Omar Sandoval in bpo-26273 and +Nathaniel J. Smith in bpo-29728.)

    +

    Support for socket.AF_VSOCK sockets has been added to allow +communication between virtual machines and their hosts. +(Contributed by Cathy Avery in bpo-27584.)

    +

    Sockets now auto-detect family, type and protocol from file descriptor +by default. +(Contributed by Christian Heimes in bpo-28134.)

    +
    +
    +

    socketserver

    +

    socketserver.ThreadingMixIn.server_close() now waits until all non-daemon +threads complete. socketserver.ForkingMixIn.server_close() now waits +until all child processes complete.

    +

    Add a new socketserver.ForkingMixIn.block_on_close class attribute to +socketserver.ForkingMixIn and socketserver.ThreadingMixIn +classes. Set the class attribute to False to get the pre-3.7 behaviour.

    +
    +
    +

    sqlite3

    +

    sqlite3.Connection now exposes the backup() +method when the underlying SQLite library is at version 3.6.11 or higher. +(Contributed by Lele Gaifax in bpo-27645.)

    +

    The database argument of sqlite3.connect() now accepts any +path-like object, instead of just a string. +(Contributed by Anders Lorentsen in bpo-31843.)

    +
    +
    +

    ssl

    +

    The ssl module now uses OpenSSL’s builtin API instead of +match_hostname() to check a host name or an IP address. Values +are validated during TLS handshake. Any certificate validation error +including failing the host name check now raises +SSLCertVerificationError and aborts the handshake with a proper +TLS Alert message. The new exception contains additional information. +Host name validation can be customized with +SSLContext.hostname_checks_common_name. +(Contributed by Christian Heimes in bpo-31399.)

    +
    +

    Note

    +

    The improved host name check requires a libssl implementation compatible +with OpenSSL 1.0.2 or 1.1. Consequently, OpenSSL 0.9.8 and 1.0.1 are no +longer supported (see Platform Support Removals for more details). +The ssl module is mostly compatible with LibreSSL 2.7.2 and newer.

    +
    +

    The ssl module no longer sends IP addresses in SNI TLS extension. +(Contributed by Christian Heimes in bpo-32185.)

    +

    match_hostname() no longer supports partial wildcards like +www*.example.org. +(Contributed by Mandeep Singh in bpo-23033 and Christian Heimes in +bpo-31399.)

    +

    The default cipher suite selection of the ssl module now uses a blacklist +approach rather than a hard-coded whitelist. Python no longer re-enables +ciphers that have been blocked by OpenSSL security updates. Default cipher +suite selection can be configured at compile time. +(Contributed by Christian Heimes in bpo-31429.)

    +

    Validation of server certificates containing internationalized domain names +(IDNs) is now supported. As part of this change, the +SSLSocket.server_hostname attribute +now stores the expected hostname in A-label form ("xn--pythn-mua.org"), +rather than the U-label form ("pythön.org"). (Contributed by +Nathaniel J. Smith and Christian Heimes in bpo-28414.)

    +

    The ssl module has preliminary and experimental support for TLS 1.3 and +OpenSSL 1.1.1. At the time of Python 3.7.0 release, OpenSSL 1.1.1 is still +under development and TLS 1.3 hasn’t been finalized yet. The TLS 1.3 +handshake and protocol behaves slightly differently than TLS 1.2 and earlier, +see TLS 1.3. +(Contributed by Christian Heimes in bpo-32947, bpo-20995, +bpo-29136, bpo-30622 and bpo-33618)

    +

    SSLSocket and SSLObject no longer have a public +constructor. Direct instantiation was never a documented and supported +feature. Instances must be created with SSLContext methods +wrap_socket() and wrap_bio(). +(Contributed by Christian Heimes in bpo-32951)

    +

    OpenSSL 1.1 APIs for setting the minimum and maximum TLS protocol version are +available as SSLContext.minimum_version +and SSLContext.maximum_version. +Supported protocols are indicated by several new flags, such as +HAS_TLSv1_1. +(Contributed by Christian Heimes in bpo-32609.)

    +

    Added SSLContext.post_handshake_auth to enable and +ssl.SSLSocket.verify_client_post_handshake() to initiate TLS 1.3 +post-handshake authentication. +(Contributed by Christian Heimes in bpo-34670.)

    +
    +
    +

    string

    +

    string.Template now lets you to optionally modify the regular +expression pattern for braced placeholders and non-braced placeholders +separately. (Contributed by Barry Warsaw in bpo-1198569.)

    +
    +
    +

    subprocess

    +

    The subprocess.run() function accepts the new capture_output +keyword argument. When true, stdout and stderr will be captured. +This is equivalent to passing subprocess.PIPE as stdout and +stderr arguments. +(Contributed by Bo Bayles in bpo-32102.)

    +

    The subprocess.run function and the subprocess.Popen constructor +now accept the text keyword argument as an alias +to universal_newlines. +(Contributed by Andrew Clegg in bpo-31756.)

    +

    On Windows the default for close_fds was changed from False to +True when redirecting the standard handles. It’s now possible to set +close_fds to true when redirecting the standard handles. See +subprocess.Popen. This means that close_fds now defaults to +True on all supported platforms. +(Contributed by Segev Finer in bpo-19764.)

    +

    The subprocess module is now more graceful when handling +KeyboardInterrupt during subprocess.call(), +subprocess.run(), or in a Popen +context manager. It now waits a short amount of time for the child +to exit, before continuing the handling of the KeyboardInterrupt +exception. +(Contributed by Gregory P. Smith in bpo-25942.)

    +
    +
    +

    sys

    +

    The new sys.breakpointhook() hook function is called by the +built-in breakpoint(). +(Contributed by Barry Warsaw in bpo-31353.)

    +

    On Android, the new sys.getandroidapilevel() returns the build-time +Android API version. +(Contributed by Victor Stinner in bpo-28740.)

    +

    The new sys.get_coroutine_origin_tracking_depth() function returns +the current coroutine origin tracking depth, as set by +the new sys.set_coroutine_origin_tracking_depth(). asyncio +has been converted to use this new API instead of +the deprecated sys.set_coroutine_wrapper(). +(Contributed by Nathaniel J. Smith in bpo-32591.)

    +
    +
    +

    time

    +

    PEP 564 adds six new functions with nanosecond resolution to the +time module:

    + +

    New clock identifiers have been added:

    +
      +
    • time.CLOCK_BOOTTIME (Linux): Identical to +time.CLOCK_MONOTONIC, except it also includes any time that the +system is suspended.

    • +
    • time.CLOCK_PROF (FreeBSD, NetBSD and OpenBSD): High-resolution +per-process CPU timer.

    • +
    • time.CLOCK_UPTIME (FreeBSD, OpenBSD): Time whose absolute value is +the time the system has been running and not suspended, providing accurate +uptime measurement.

    • +
    +

    The new time.thread_time() and time.thread_time_ns() functions +can be used to get per-thread CPU time measurements. +(Contributed by Antoine Pitrou in bpo-32025.)

    +

    The new time.pthread_getcpuclockid() function returns the clock ID +of the thread-specific CPU-time clock.

    +
    +
    +

    tkinter

    +

    The new tkinter.ttk.Spinbox class is now available. +(Contributed by Alan Moore in bpo-32585.)

    +
    +
    +

    tracemalloc

    +

    tracemalloc.Traceback behaves more like regular tracebacks, +sorting the frames from oldest to most recent. +Traceback.format() +now accepts negative limit, truncating the result to the +abs(limit) oldest frames. To get the old behaviour, use +the new most_recent_first argument to Traceback.format(). +(Contributed by Jesse Bakker in bpo-32121.)

    +
    +
    +

    types

    +

    The new WrapperDescriptorType, +MethodWrapperType, MethodDescriptorType, +and ClassMethodDescriptorType classes are now available. +(Contributed by Manuel Krebber and Guido van Rossum in bpo-29377, +and Serhiy Storchaka in bpo-32265.)

    +

    The new types.resolve_bases() function resolves MRO entries +dynamically as specified by PEP 560. +(Contributed by Ivan Levkivskyi in bpo-32717.)

    +
    +
    +

    unicodedata

    +

    The internal unicodedata database has been upgraded to use Unicode 11. (Contributed by Benjamin +Peterson.)

    +
    +
    +

    unittest

    +

    The new -k command-line option allows filtering tests by a name +substring or a Unix shell-like pattern. +For example, python -m unittest -k foo runs +foo_tests.SomeTest.test_something, bar_tests.SomeTest.test_foo, +but not bar_tests.FooTest.test_something. +(Contributed by Jonas Haag in bpo-32071.)

    +
    +
    +

    unittest.mock

    +

    The sentinel attributes now preserve their identity +when they are copied or pickled. (Contributed by +Serhiy Storchaka in bpo-20804.)

    +

    The new seal() function allows sealing +Mock instances, which will disallow further creation +of attribute mocks. The seal is applied recursively to all attributes that +are themselves mocks. +(Contributed by Mario Corchero in bpo-30541.)

    +
    +
    +

    urllib.parse

    +

    urllib.parse.quote() has been updated from RFC 2396 to RFC 3986, +adding ~ to the set of characters that are never quoted by default. +(Contributed by Christian Theune and Ratnadeep Debnath in bpo-16285.)

    +
    +
    +

    uu

    +

    The uu.encode() function now accepts an optional backtick +keyword argument. When it’s true, zeros are represented by '`' +instead of spaces. (Contributed by Xiang Zhang in bpo-30103.)

    +
    +
    +

    uuid

    +

    The new UUID.is_safe attribute relays information +from the platform about whether generated UUIDs are generated with a +multiprocessing-safe method. +(Contributed by Barry Warsaw in bpo-22807.)

    +

    uuid.getnode() now prefers universally administered +MAC addresses over locally administered MAC addresses. +This makes a better guarantee for global uniqueness of UUIDs returned +from uuid.uuid1(). If only locally administered MAC addresses are +available, the first such one found is returned. +(Contributed by Barry Warsaw in bpo-32107.)

    +
    +
    +

    warnings

    +

    The initialization of the default warnings filters has changed as follows:

    +
      +
    • warnings enabled via command line options (including those for -b +and the new CPython-specific -X dev option) are always passed +to the warnings machinery via the sys.warnoptions attribute.

    • +
    • warnings filters enabled via the command line or the environment now have the +following order of precedence:

      +
      +
        +
      • the BytesWarning filter for -b (or -bb)

      • +
      • any filters specified with the -W option

      • +
      • any filters specified with the PYTHONWARNINGS environment +variable

      • +
      • any other CPython specific filters (e.g. the default filter added +for the new -X dev mode)

      • +
      • any implicit filters defined directly by the warnings machinery

      • +
      +
      +
    • +
    • in CPython debug builds, all warnings are now displayed by default (the +implicit filter list is empty)

    • +
    +

    (Contributed by Nick Coghlan and Victor Stinner in bpo-20361, +bpo-32043, and bpo-32230.)

    +

    Deprecation warnings are once again shown by default in single-file scripts and +at the interactive prompt. See PEP 565: Show DeprecationWarning in __main__ for details. +(Contributed by Nick Coghlan in bpo-31975.)

    +
    +
    +

    xml

    +

    As mitigation against DTD and external entity retrieval, the +xml.dom.minidom and xml.sax modules no longer process +external entities by default. +(Contributed by Christian Heimes in bpo-17239.)

    +
    +
    +

    xml.etree

    +

    ElementPath predicates in the find() +methods can now compare text of the current node with [. = "text"], +not only text in children. Predicates also allow adding spaces for +better readability. (Contributed by Stefan Behnel in bpo-31648.)

    +
    +
    +

    xmlrpc.server

    +

    SimpleXMLRPCDispatcher.register_function +can now be used as a decorator. (Contributed by Xiang Zhang in +bpo-7769.)

    +
    +
    +

    zipapp

    +

    Function create_archive() now accepts an optional filter +argument to allow the user to select which files should be included in the +archive. (Contributed by Irmen de Jong in bpo-31072.)

    +

    Function create_archive() now accepts an optional compressed +argument to generate a compressed archive. A command line option +--compress has also been added to support compression. +(Contributed by Zhiming Wang in bpo-31638.)

    +
    +
    +

    zipfile

    +

    ZipFile now accepts the new compresslevel parameter to +control the compression level. +(Contributed by Bo Bayles in bpo-21417.)

    +

    Subdirectories in archives created by ZipFile are now stored in +alphabetical order. +(Contributed by Bernhard M. Wiedemann in bpo-30693.)

    +
    +
    +
    +

    C API Changes

    +

    A new API for thread-local storage has been implemented. See +PEP 539: New C API for Thread-Local Storage for an overview and +Thread Specific Storage (TSS) API for a complete reference. +(Contributed by Masayuki Yamamoto in bpo-25658.)

    +

    The new context variables functionality +exposes a number of new C APIs.

    +

    The new PyImport_GetModule() function returns the previously +imported module with the given name. +(Contributed by Eric Snow in bpo-28411.)

    +

    The new Py_RETURN_RICHCOMPARE macro eases writing rich +comparison functions. +(Contributed by Petr Victorin in bpo-23699.)

    +

    The new Py_UNREACHABLE macro can be used to mark unreachable +code paths. +(Contributed by Barry Warsaw in bpo-31338.)

    +

    The tracemalloc now exposes a C API through the new +PyTraceMalloc_Track() and PyTraceMalloc_Untrack() +functions. +(Contributed by Victor Stinner in bpo-30054.)

    +

    The new import__find__load__start() and +import__find__load__done() static markers can be used to trace +module imports. +(Contributed by Christian Heimes in bpo-31574.)

    +

    The fields name and doc of structures +PyMemberDef, PyGetSetDef, +PyStructSequence_Field, PyStructSequence_Desc, +and wrapperbase are now of type const char * rather of +char *. (Contributed by Serhiy Storchaka in bpo-28761.)

    +

    The result of PyUnicode_AsUTF8AndSize() and PyUnicode_AsUTF8() +is now of type const char * rather of char *. (Contributed by Serhiy +Storchaka in bpo-28769.)

    +

    The result of PyMapping_Keys(), PyMapping_Values() and +PyMapping_Items() is now always a list, rather than a list or a +tuple. (Contributed by Oren Milman in bpo-28280.)

    +

    Added functions PySlice_Unpack() and PySlice_AdjustIndices(). +(Contributed by Serhiy Storchaka in bpo-27867.)

    +

    PyOS_AfterFork() is deprecated in favour of the new functions +PyOS_BeforeFork(), PyOS_AfterFork_Parent() and +PyOS_AfterFork_Child(). (Contributed by Antoine Pitrou in +bpo-16500.)

    +

    The PyExc_RecursionErrorInst singleton that was part of the public API +has been removed as its members being never cleared may cause a segfault +during finalization of the interpreter. Contributed by Xavier de Gaye in +bpo-22898 and bpo-30697.

    +

    Added C API support for timezones with timezone constructors +PyTimeZone_FromOffset() and PyTimeZone_FromOffsetAndName(), +and access to the UTC singleton with PyDateTime_TimeZone_UTC. +Contributed by Paul Ganssle in bpo-10381.

    +

    The type of results of PyThread_start_new_thread() and +PyThread_get_thread_ident(), and the id parameter of +PyThreadState_SetAsyncExc() changed from long to +unsigned long. +(Contributed by Serhiy Storchaka in bpo-6532.)

    +

    PyUnicode_AsWideCharString() now raises a ValueError if the +second argument is NULL and the wchar_t* string contains null +characters. (Contributed by Serhiy Storchaka in bpo-30708.)

    +

    Changes to the startup sequence and the management of dynamic memory +allocators mean that the long documented requirement to call +Py_Initialize() before calling most C API functions is now +relied on more heavily, and failing to abide by it may lead to segfaults in +embedding applications. See the Porting to Python 3.7 section in this +document and the Before Python Initialization section in the C API documentation +for more details.

    +

    The new PyInterpreterState_GetID() returns the unique ID for a +given interpreter. +(Contributed by Eric Snow in bpo-29102.)

    +

    Py_DecodeLocale(), Py_EncodeLocale() now use the UTF-8 +encoding when the UTF-8 mode is enabled. +(Contributed by Victor Stinner in bpo-29240.)

    +

    PyUnicode_DecodeLocaleAndSize() and PyUnicode_EncodeLocale() +now use the current locale encoding for surrogateescape error handler. +(Contributed by Victor Stinner in bpo-29240.)

    +

    The start and end parameters of PyUnicode_FindChar() are +now adjusted to behave like string slices. +(Contributed by Xiang Zhang in bpo-28822.)

    +
    +
    +

    Build Changes

    +

    Support for building --without-threads has been removed. The +threading module is now always available. +(Contributed by Antoine Pitrou in bpo-31370.).

    +

    A full copy of libffi is no longer bundled for use when building the +_ctypes module on non-OSX UNIX platforms. An installed copy +of libffi is now required when building _ctypes on such platforms. +(Contributed by Zachary Ware in bpo-27979.)

    +

    The Windows build process no longer depends on Subversion to pull in external +sources, a Python script is used to download zipfiles from GitHub instead. +If Python 3.6 is not found on the system (via py -3.6), NuGet is used to +download a copy of 32-bit Python for this purpose. (Contributed by Zachary +Ware in bpo-30450.)

    +

    The ssl module requires OpenSSL 1.0.2 or 1.1 compatible libssl. +OpenSSL 1.0.1 has reached end of lifetime on 2016-12-31 and is no longer +supported. LibreSSL is temporarily not supported as well. LibreSSL releases +up to version 2.6.4 are missing required OpenSSL 1.0.2 APIs.

    +
    +
    +

    Optimizations

    +

    The overhead of calling many methods of various standard library classes +implemented in C has been significantly reduced by porting more code +to use the METH_FASTCALL convention. +(Contributed by Victor Stinner in bpo-29300, bpo-29507, +bpo-29452, and bpo-29286.)

    +

    Various optimizations have reduced Python startup time by 10% on Linux and +up to 30% on macOS. +(Contributed by Victor Stinner, INADA Naoki in bpo-29585, and +Ivan Levkivskyi in bpo-31333.)

    +

    Method calls are now up to 20% faster due to the bytecode changes which +avoid creating bound method instances. +(Contributed by Yury Selivanov and INADA Naoki in bpo-26110.)

    +

    The asyncio module received a number of notable optimizations for +commonly used functions:

    +
      +
    • The asyncio.get_event_loop() function has been reimplemented in C to +make it up to 15 times faster. +(Contributed by Yury Selivanov in bpo-32296.)

    • +
    • asyncio.Future callback management has been optimized. +(Contributed by Yury Selivanov in bpo-32348.)

    • +
    • asyncio.gather() is now up to 15% faster. +(Contributed by Yury Selivanov in bpo-32355.)

    • +
    • asyncio.sleep() is now up to 2 times faster when the delay +argument is zero or negative. +(Contributed by Andrew Svetlov in bpo-32351.)

    • +
    • The performance overhead of asyncio debug mode has been reduced. +(Contributed by Antoine Pitrou in bpo-31970.)

    • +
    +

    As a result of PEP 560 work, the import time +of typing has been reduced by a factor of 7, and many typing operations +are now faster. +(Contributed by Ivan Levkivskyi in bpo-32226.)

    +

    sorted() and list.sort() have been optimized for common cases +to be up to 40-75% faster. +(Contributed by Elliot Gorokhovsky in bpo-28685.)

    +

    dict.copy() is now up to 5.5 times faster. +(Contributed by Yury Selivanov in bpo-31179.)

    +

    hasattr() and getattr() are now about 4 times faster when +name is not found and obj does not override object.__getattr__() +or object.__getattribute__(). +(Contributed by INADA Naoki in bpo-32544.)

    +

    Searching for certain Unicode characters (like Ukrainian capital “Є”) +in a string was up to 25 times slower than searching for other characters. +It is now only 3 times slower in the worst case. +(Contributed by Serhiy Storchaka in bpo-24821.)

    +

    The collections.namedtuple() factory has been reimplemented to +make the creation of named tuples 4 to 6 times faster. +(Contributed by Jelle Zijlstra with further improvements by INADA Naoki, +Serhiy Storchaka, and Raymond Hettinger in bpo-28638.)

    +

    date.fromordinal() and date.fromtimestamp() are now up to +30% faster in the common case. +(Contributed by Paul Ganssle in bpo-32403.)

    +

    The os.fwalk() function is now up to 2 times faster thanks to +the use of os.scandir(). +(Contributed by Serhiy Storchaka in bpo-25996.)

    +

    The speed of the shutil.rmtree() function has been improved by +20–40% thanks to the use of the os.scandir() function. +(Contributed by Serhiy Storchaka in bpo-28564.)

    +

    Optimized case-insensitive matching and searching of regular +expressions. Searching some patterns can now be up to 20 times faster. +(Contributed by Serhiy Storchaka in bpo-30285.)

    +

    re.compile() now converts flags parameter to int object if +it is RegexFlag. It is now as fast as Python 3.5, and faster than +Python 3.6 by about 10% depending on the pattern. +(Contributed by INADA Naoki in bpo-31671.)

    +

    The modify() methods of classes +selectors.EpollSelector, selectors.PollSelector +and selectors.DevpollSelector may be around 10% faster under +heavy loads. (Contributed by Giampaolo Rodola’ in bpo-30014)

    +

    Constant folding has been moved from the peephole optimizer to the new AST +optimizer, which is able perform optimizations more consistently. +(Contributed by Eugene Toder and INADA Naoki in bpo-29469 and +bpo-11549.)

    +

    Most functions and methods in abc have been rewritten in C. +This makes creation of abstract base classes, and calling isinstance() +and issubclass() on them 1.5x faster. This also reduces Python +start-up time by up to 10%. (Contributed by Ivan Levkivskyi and INADA Naoki +in bpo-31333)

    +

    Significant speed improvements to alternate constructors for +datetime.date and datetime.datetime by using fast-path +constructors when not constructing subclasses. (Contributed by Paul Ganssle +in bpo-32403)

    +

    The speed of comparison of array.array instances has been +improved considerably in certain cases. It is now from 10x to 70x faster +when comparing arrays holding values of the same integer type. +(Contributed by Adrian Wielgosik in bpo-24700.)

    +

    The math.erf() and math.erfc() functions now use the (faster) +C library implementation on most platforms. +(Contributed by Serhiy Storchaka in bpo-26121.)

    +
    +
    +

    Other CPython Implementation Changes

    +
      +
    • Trace hooks may now opt out of receiving the line and opt into receiving +the opcode events from the interpreter by setting the corresponding new +f_trace_lines and f_trace_opcodes attributes on the +frame being traced. (Contributed by Nick Coghlan in bpo-31344.)

    • +
    • Fixed some consistency problems with namespace package module attributes. +Namespace module objects now have an __file__ that is set to None +(previously unset), and their __spec__.origin is also set to None +(previously the string "namespace"). See bpo-32305. Also, the +namespace module object’s __spec__.loader is set to the same value as +__loader__ (previously, the former was set to None). See +bpo-32303.

    • +
    • The locals() dictionary now displays in the lexical order that +variables were defined. Previously, the order was undefined. +(Contributed by Raymond Hettinger in bpo-32690.)

    • +
    • The distutils upload command no longer tries to change CR +end-of-line characters to CRLF. This fixes a corruption issue with sdists +that ended with a byte equivalent to CR. +(Contributed by Bo Bayles in bpo-32304.)

    • +
    +
    +
    +

    Deprecated Python Behavior

    +

    Yield expressions (both yield and yield from clauses) are now deprecated +in comprehensions and generator expressions (aside from the iterable expression +in the leftmost for clause). This ensures that comprehensions +always immediately return a container of the appropriate type (rather than +potentially returning a generator iterator object), while generator +expressions won’t attempt to interleave their implicit output with the output +from any explicit yield expressions. In Python 3.7, such expressions emit +DeprecationWarning when compiled, in Python 3.8 this will be a +SyntaxError. +(Contributed by Serhiy Storchaka in bpo-10544.)

    +

    Returning a subclass of complex from object.__complex__() is +deprecated and will be an error in future Python versions. This makes +__complex__() consistent with object.__int__() and +object.__float__(). +(Contributed by Serhiy Storchaka in bpo-28894.)

    +
    +
    +

    Deprecated Python modules, functions and methods

    +
    +

    aifc

    +

    aifc.openfp() has been deprecated and will be removed in Python 3.9. +Use aifc.open() instead. +(Contributed by Brian Curtin in bpo-31985.)

    +
    +
    +

    asyncio

    +

    Support for directly await-ing instances of asyncio.Lock and +other asyncio synchronization primitives has been deprecated. An +asynchronous context manager must be used in order to acquire and release +the synchronization resource. +(Contributed by Andrew Svetlov in bpo-32253.)

    +

    The asyncio.Task.current_task() and asyncio.Task.all_tasks() +methods have been deprecated. +(Contributed by Andrew Svetlov in bpo-32250.)

    +
    +
    +

    collections

    +

    In Python 3.8, the abstract base classes in collections.abc will no +longer be exposed in the regular collections module. This will help +create a clearer distinction between the concrete classes and the abstract +base classes. +(Contributed by Serhiy Storchaka in bpo-25988.)

    +
    +
    +

    dbm

    +

    dbm.dumb now supports reading read-only files and no longer writes the +index file when it is not changed. A deprecation warning is now emitted +if the index file is missing and recreated in the 'r' and 'w' +modes (this will be an error in future Python releases). +(Contributed by Serhiy Storchaka in bpo-28847.)

    +
    +
    +

    enum

    +

    In Python 3.8, attempting to check for non-Enum objects in Enum +classes will raise a TypeError (e.g. 1 in Color); similarly, +attempting to check for non-Flag objects in a Flag member will +raise TypeError (e.g. 1 in Perm.RW); currently, both operations +return False instead. +(Contributed by Ethan Furman in bpo-33217.)

    +
    +
    +

    gettext

    +

    Using non-integer value for selecting a plural form in gettext is +now deprecated. It never correctly worked. (Contributed by Serhiy Storchaka +in bpo-28692.)

    +
    +
    +

    importlib

    +

    Methods +MetaPathFinder.find_module() +(replaced by +MetaPathFinder.find_spec()) +and +PathEntryFinder.find_loader() +(replaced by +PathEntryFinder.find_spec()) +both deprecated in Python 3.4 now emit DeprecationWarning. +(Contributed by Matthias Bussonnier in bpo-29576)

    +

    The importlib.abc.ResourceLoader ABC has been deprecated in +favour of importlib.abc.ResourceReader.

    +
    +
    +

    locale

    +

    locale.format() has been deprecated, use locale.format_string() +instead. (Contributed by Garvit in bpo-10379.)

    +
    +
    +

    macpath

    +

    The macpath is now deprecated and will be removed in Python 3.8. +(Contributed by Chi Hsuan Yen in bpo-9850.)

    +
    +
    +

    threading

    +

    dummy_threading and _dummy_thread have been deprecated. It is +no longer possible to build Python with threading disabled. +Use threading instead. +(Contributed by Antoine Pitrou in bpo-31370.)

    +
    +
    +

    socket

    +

    The silent argument value truncation in socket.htons() and +socket.ntohs() has been deprecated. In future versions of Python, +if the passed argument is larger than 16 bits, an exception will be raised. +(Contributed by Oren Milman in bpo-28332.)

    +
    +
    +

    ssl

    +

    ssl.wrap_socket() is deprecated. Use +ssl.SSLContext.wrap_socket() instead. +(Contributed by Christian Heimes in bpo-28124.)

    +
    +
    +

    sunau

    +

    sunau.openfp() has been deprecated and will be removed in Python 3.9. +Use sunau.open() instead. +(Contributed by Brian Curtin in bpo-31985.)

    +
    +
    +

    sys

    +

    Deprecated sys.set_coroutine_wrapper() and +sys.get_coroutine_wrapper().

    +

    The undocumented sys.callstats() function has been deprecated and +will be removed in a future Python version. +(Contributed by Victor Stinner in bpo-28799.)

    +
    +
    +

    wave

    +

    wave.openfp() has been deprecated and will be removed in Python 3.9. +Use wave.open() instead. +(Contributed by Brian Curtin in bpo-31985.)

    +
    +
    +
    +

    Deprecated functions and types of the C API

    +

    Function PySlice_GetIndicesEx() is deprecated and replaced with +a macro if Py_LIMITED_API is not set or set to a value in the range +between 0x03050400 and 0x03060000 (not inclusive), or is 0x03060100 +or higher. (Contributed by Serhiy Storchaka in bpo-27867.)

    +

    PyOS_AfterFork() has been deprecated. Use PyOS_BeforeFork(), +PyOS_AfterFork_Parent() or PyOS_AfterFork_Child() instead. +(Contributed by Antoine Pitrou in bpo-16500.)

    +
    +
    +

    Platform Support Removals

    +
      +
    • FreeBSD 9 and older are no longer officially supported.

    • +
    • For full Unicode support, including within extension modules, *nix platforms +are now expected to provide at least one of C.UTF-8 (full locale), +C.utf8 (full locale) or UTF-8 (LC_CTYPE-only locale) as an +alternative to the legacy ASCII-based C locale.

    • +
    • OpenSSL 0.9.8 and 1.0.1 are no longer supported, which means building CPython +3.7 with SSL/TLS support on older platforms still using these versions +requires custom build options that link to a more recent version of OpenSSL.

      +

      Notably, this issue affects the Debian 8 (aka “jessie”) and Ubuntu 14.04 +(aka “Trusty”) LTS Linux distributions, as they still use OpenSSL 1.0.1 by +default.

      +

      Debian 9 (“stretch”) and Ubuntu 16.04 (“xenial”), as well as recent releases +of other LTS Linux releases (e.g. RHEL/CentOS 7.5, SLES 12-SP3), use OpenSSL +1.0.2 or later, and remain supported in the default build configuration.

      +

      CPython’s own CI configuration file provides an +example of using the SSL +compatibility testing infrastructure in +CPython’s test suite to build and link against OpenSSL 1.1.0 rather than an +outdated system provided OpenSSL.

      +
    • +
    +
    +
    +

    API and Feature Removals

    +

    The following features and APIs have been removed from Python 3.7:

    +
      +
    • The os.stat_float_times() function has been removed. It was introduced in +Python 2.3 for backward compatibility with Python 2.2, and was deprecated +since Python 3.1.

    • +
    • Unknown escapes consisting of '\' and an ASCII letter in replacement +templates for re.sub() were deprecated in Python 3.5, and will now +cause an error.

    • +
    • Removed support of the exclude argument in tarfile.TarFile.add(). +It was deprecated in Python 2.7 and 3.2. Use the filter argument instead.

    • +
    • The splitunc() function in the ntpath module was deprecated in +Python 3.1, and has now been removed. Use the splitdrive() +function instead.

    • +
    • collections.namedtuple() no longer supports the verbose parameter +or _source attribute which showed the generated source code for the +named tuple class. This was part of an optimization designed to speed-up +class creation. (Contributed by Jelle Zijlstra with further improvements +by INADA Naoki, Serhiy Storchaka, and Raymond Hettinger in bpo-28638.)

    • +
    • Functions bool(), float(), list() and tuple() no +longer take keyword arguments. The first argument of int() can now +be passed only as positional argument.

    • +
    • Removed previously deprecated in Python 2.4 classes Plist, Dict and +_InternalDict in the plistlib module. Dict values in the result +of functions readPlist() and +readPlistFromBytes() are now normal dicts. You no longer +can use attribute access to access items of these dictionaries.

    • +
    • The asyncio.windows_utils.socketpair() function has been +removed. Use the socket.socketpair() function instead, +it is available on all platforms since Python 3.5. +asyncio.windows_utils.socketpair was just an alias to +socket.socketpair on Python 3.5 and newer.

    • +
    • asyncio no longer exports the selectors and +_overlapped modules as asyncio.selectors and +asyncio._overlapped. Replace from asyncio import selectors with +import selectors.

    • +
    • Direct instantiation of ssl.SSLSocket and ssl.SSLObject +objects is now prohibited. The constructors were never documented, tested, +or designed as public constructors. Users were supposed to use +ssl.wrap_socket() or ssl.SSLContext. +(Contributed by Christian Heimes in bpo-32951.)

    • +
    • The unused distutils install_misc command has been removed. +(Contributed by Eric N. Vander Weele in bpo-29218.)

    • +
    +
    +
    +

    Module Removals

    +

    The fpectl module has been removed. It was never enabled by +default, never worked correctly on x86-64, and it changed the Python +ABI in ways that caused unexpected breakage of C extensions. +(Contributed by Nathaniel J. Smith in bpo-29137.)

    +
    +
    +

    Windows-only Changes

    +

    The python launcher, (py.exe), can accept 32 & 64 bit specifiers without +having to specify a minor version as well. So py -3-32 and py -3-64 +become valid as well as py -3.7-32, also the -m-64 and -m.n-64 forms +are now accepted to force 64 bit python even if 32 bit would have otherwise +been used. If the specified version is not available py.exe will error exit. +(Contributed by Steve Barnes in bpo-30291.)

    +

    The launcher can be run as py -0 to produce a list of the installed pythons, +with default marked with an asterisk. Running py -0p will include the paths. +If py is run with a version specifier that cannot be matched it will also print +the short form list of available specifiers. +(Contributed by Steve Barnes in bpo-30362.)

    +
    +
    +

    Porting to Python 3.7

    +

    This section lists previously described changes and other bugfixes +that may require changes to your code.

    +
    +

    Changes in Python Behavior

    +
      +
    • async and await names are now reserved keywords. +Code using these names as identifiers will now raise a SyntaxError. +(Contributed by Jelle Zijlstra in bpo-30406.)

    • +
    • PEP 479 is enabled for all code in Python 3.7, meaning that +StopIteration exceptions raised directly or indirectly in +coroutines and generators are transformed into RuntimeError +exceptions. +(Contributed by Yury Selivanov in bpo-32670.)

    • +
    • object.__aiter__() methods can no longer be declared as +asynchronous. (Contributed by Yury Selivanov in bpo-31709.)

    • +
    • Due to an oversight, earlier Python versions erroneously accepted the +following syntax:

      +
      f(1 for x in [1],)
      +
      +class C(1 for x in [1]):
      +    pass
      +
      +
      +

      Python 3.7 now correctly raises a SyntaxError, as a generator +expression always needs to be directly inside a set of parentheses +and cannot have a comma on either side, and the duplication of the +parentheses can be omitted only on calls. +(Contributed by Serhiy Storchaka in bpo-32012 and bpo-32023.)

      +
    • +
    • When using the -m switch, the initial working directory is now added +to sys.path, rather than an empty string (which dynamically denoted +the current working directory at the time of each import). Any programs that +are checking for the empty string, or otherwise relying on the previous +behaviour, will need to be updated accordingly (e.g. by also checking for +os.getcwd() or os.path.dirname(__main__.__file__), depending on why +the code was checking for the empty string in the first place).

    • +
    +
    +
    +

    Changes in the Python API

    +
      +
    • socketserver.ThreadingMixIn.server_close() now waits until all +non-daemon threads complete. Set the new +socketserver.ThreadingMixIn.block_on_close class attribute to +False to get the pre-3.7 behaviour. +(Contributed by Victor Stinner in bpo-31233 and bpo-33540.)

    • +
    • socketserver.ForkingMixIn.server_close() now waits until all +child processes complete. Set the new +socketserver.ForkingMixIn.block_on_close class attribute to False +to get the pre-3.7 behaviour. +(Contributed by Victor Stinner in bpo-31151 and bpo-33540.)

    • +
    • The locale.localeconv() function now temporarily sets the LC_CTYPE +locale to the value of LC_NUMERIC in some cases. +(Contributed by Victor Stinner in bpo-31900.)

    • +
    • pkgutil.walk_packages() now raises a ValueError if path is +a string. Previously an empty list was returned. +(Contributed by Sanyam Khurana in bpo-24744.)

    • +
    • A format string argument for string.Formatter.format() +is now positional-only. +Passing it as a keyword argument was deprecated in Python 3.5. (Contributed +by Serhiy Storchaka in bpo-29193.)

    • +
    • Attributes key, +value and +coded_value of class +http.cookies.Morsel are now read-only. +Assigning to them was deprecated in Python 3.5. +Use the set() method for setting them. +(Contributed by Serhiy Storchaka in bpo-29192.)

    • +
    • The mode argument of os.makedirs() no longer affects the file +permission bits of newly-created intermediate-level directories. +To set their file permission bits you can set the umask before invoking +makedirs(). +(Contributed by Serhiy Storchaka in bpo-19930.)

    • +
    • The struct.Struct.format type is now str instead of +bytes. (Contributed by Victor Stinner in bpo-21071.)

    • +
    • parse_multipart() now accepts the encoding and errors +arguments and returns the same results as +FieldStorage: for non-file fields, the value associated to a key +is a list of strings, not bytes. +(Contributed by Pierre Quentel in bpo-29979.)

    • +
    • Due to internal changes in socket, calling socket.fromshare() +on a socket created by socket.share in older +Python versions is not supported.

    • +
    • repr for BaseException has changed to not include the trailing +comma. Most exceptions are affected by this change. +(Contributed by Serhiy Storchaka in bpo-30399.)

    • +
    • repr for datetime.timedelta has changed to include the keyword +arguments in the output. (Contributed by Utkarsh Upadhyay in bpo-30302.)

    • +
    • Because shutil.rmtree() is now implemented using the os.scandir() +function, the user specified handler onerror is now called with the first +argument os.scandir instead of os.listdir when listing the directory +is failed.

    • +
    • Support for nested sets and set operations in regular expressions as in +Unicode Technical Standard #18 might be added in the future. This would +change the syntax. To facilitate this future change a FutureWarning +will be raised in ambiguous cases for the time being. +That include sets starting with a literal '[' or containing literal +character sequences '--', '&&', '~~', and '||'. To +avoid a warning, escape them with a backslash. +(Contributed by Serhiy Storchaka in bpo-30349.)

      +
    • +
    • The result of splitting a string on a regular expression +that could match an empty string has been changed. For example +splitting on r'\s*' will now split not only on whitespaces as it +did previously, but also on empty strings before all non-whitespace +characters and just before the end of the string. +The previous behavior can be restored by changing the pattern +to r'\s+'. A FutureWarning was emitted for such patterns since +Python 3.5.

      +

      For patterns that match both empty and non-empty strings, the result of +searching for all matches may also be changed in other cases. For example +in the string 'a\n\n', the pattern r'(?m)^\s*?$' will not only +match empty strings at positions 2 and 3, but also the string '\n' at +positions 2–3. To match only blank lines, the pattern should be rewritten +as r'(?m)^[^\S\n]*$'.

      +

      re.sub() now replaces empty matches adjacent to a previous +non-empty match. For example re.sub('x*', '-', 'abxd') returns now +'-a-b--d-' instead of '-a-b-d-' (the first minus between ‘b’ and +‘d’ replaces ‘x’, and the second minus replaces an empty string between +‘x’ and ‘d’).

      +

      (Contributed by Serhiy Storchaka in bpo-25054 and bpo-32308.)

      +
    • +
    • Change re.escape() to only escape regex special characters instead +of escaping all characters other than ASCII letters, numbers, and '_'. +(Contributed by Serhiy Storchaka in bpo-29995.)

    • +
    • tracemalloc.Traceback frames are now sorted from oldest to most +recent to be more consistent with traceback. +(Contributed by Jesse Bakker in bpo-32121.)

    • +
    • On OSes that support socket.SOCK_NONBLOCK or +socket.SOCK_CLOEXEC bit flags, the +socket.type no longer has them applied. +Therefore, checks like if sock.type == socket.SOCK_STREAM +work as expected on all platforms. +(Contributed by Yury Selivanov in bpo-32331.)

    • +
    • On Windows the default for the close_fds argument of +subprocess.Popen was changed from False to True +when redirecting the standard handles. If you previously depended on handles +being inherited when using subprocess.Popen with standard io +redirection, you will have to pass close_fds=False to preserve the +previous behaviour, or use +STARTUPINFO.lpAttributeList.

    • +
    • importlib.machinery.PathFinder.invalidate_caches() – which implicitly +affects importlib.invalidate_caches() – now deletes entries +in sys.path_importer_cache which are set to None. +(Contributed by Brett Cannon in bpo-33169.)

    • +
    • In asyncio, +loop.sock_recv(), +loop.sock_sendall(), +loop.sock_accept(), +loop.getaddrinfo(), +loop.getnameinfo() +have been changed to be proper coroutine methods to match their +documentation. Previously, these methods returned asyncio.Future +instances. +(Contributed by Yury Selivanov in bpo-32327.)

    • +
    • asyncio.Server.sockets now returns a copy of the internal list +of server sockets, instead of returning it directly. +(Contributed by Yury Selivanov in bpo-32662.)

    • +
    • Struct.format is now a str instance +instead of a bytes instance. +(Contributed by Victor Stinner in bpo-21071.)

    • +
    • ast.literal_eval() is now stricter. Addition and subtraction of +arbitrary numbers are no longer allowed. +(Contributed by Serhiy Storchaka in bpo-31778.)

    • +
    • Calendar.itermonthdates +will now consistently raise an exception when a date falls outside of the +0001-01-01 through 9999-12-31 range. To support applications that +cannot tolerate such exceptions, the new +Calendar.itermonthdays3 and +Calendar.itermonthdays4 can be used. +The new methods return tuples and are not restricted by the range supported by +datetime.date. +(Contributed by Alexander Belopolsky in bpo-28292.)

    • +
    • collections.ChainMap now preserves the order of the underlying +mappings. (Contributed by Raymond Hettinger in bpo-32792.)

    • +
    • The submit() method of concurrent.futures.ThreadPoolExecutor +and concurrent.futures.ProcessPoolExecutor now raises +a RuntimeError if called during interpreter shutdown. +(Contributed by Mark Nemec in bpo-33097.)

    • +
    • The configparser.ConfigParser constructor now uses read_dict() +to process the default values, making its behavior consistent with the +rest of the parser. Non-string keys and values in the defaults +dictionary are now being implicitly converted to strings. +(Contributed by James Tocknell in bpo-23835.)

    • +
    • Several undocumented internal imports were removed. +One example is that os.errno is no longer available; use import errno +directly instead. +Note that such undocumented internal imports may be removed any time without +notice, even in micro version releases.

    • +
    +
    +
    +

    Changes in the C API

    +

    The function PySlice_GetIndicesEx() is considered unsafe for +resizable sequences. If the slice indices are not instances of int, +but objects that implement the __index__() method, the sequence can be +resized after passing its length to PySlice_GetIndicesEx(). This +can lead to returning indices out of the length of the sequence. For +avoiding possible problems use new functions PySlice_Unpack() and +PySlice_AdjustIndices(). +(Contributed by Serhiy Storchaka in bpo-27867.)

    +
    +
    +

    CPython bytecode changes

    +

    There are two new opcodes: LOAD_METHOD and CALL_METHOD. +(Contributed by Yury Selivanov and INADA Naoki in bpo-26110.)

    +

    The STORE_ANNOTATION opcode has been removed. +(Contributed by Mark Shannon in bpo-32550.)

    +
    +
    +

    Windows-only Changes

    +

    The file used to override sys.path is now called +<python-executable>._pth instead of 'sys.path'. +See Finding modules for more information. +(Contributed by Steve Dower in bpo-28137.)

    +
    +
    +

    Other CPython implementation changes

    +

    In preparation for potential future changes to the public CPython runtime +initialization API (see PEP 432 for an initial, but somewhat outdated, +draft), CPython’s internal startup +and configuration management logic has been significantly refactored. While +these updates are intended to be entirely transparent to both embedding +applications and users of the regular CPython CLI, they’re being mentioned +here as the refactoring changes the internal order of various operations +during interpreter startup, and hence may uncover previously latent defects, +either in embedding applications, or in CPython itself. +(Initially contributed by Nick Coghlan and Eric Snow as part of +bpo-22257, and further updated by Nick, Eric, and Victor Stinner in a +number of other issues). Some known details affected:

    +
      +
    • PySys_AddWarnOptionUnicode() is not currently usable by embedding +applications due to the requirement to create a Unicode object prior to +calling Py_Initialize. Use PySys_AddWarnOption() instead.

    • +
    • warnings filters added by an embedding application with +PySys_AddWarnOption() should now more consistently take precedence +over the default filters set by the interpreter

    • +
    +

    Due to changes in the way the default warnings filters are configured, +setting Py_BytesWarningFlag to a value greater than one is no longer +sufficient to both emit BytesWarning messages and have them converted +to exceptions. Instead, the flag must be set (to cause the warnings to be +emitted in the first place), and an explicit error::BytesWarning +warnings filter added to convert them to exceptions.

    +

    Due to a change in the way docstrings are handled by the compiler, the +implicit return None in a function body consisting solely of a docstring +is now marked as occurring on the same line as the docstring, not on the +function’s header line.

    +

    The current exception state has been moved from the frame object to the co-routine. +This simplified the interpreter and fixed a couple of obscure bugs caused by +having swap exception state when entering or exiting a generator. +(Contributed by Mark Shannon in bpo-25612.)

    +
    +
    +
    +

    Notable changes in Python 3.7.1

    +

    Starting in 3.7.1, Py_Initialize() now consistently reads and respects +all of the same environment settings as Py_Main() (in earlier Python +versions, it respected an ill-defined subset of those environment variables, +while in Python 3.7.0 it didn’t read any of them due to bpo-34247). If +this behavior is unwanted, set Py_IgnoreEnvironmentFlag to 1 before +calling Py_Initialize().

    +

    In 3.7.1 the C API for Context Variables +was updated to use +PyObject pointers. See also bpo-34762.

    +

    xml.dom.minidom and xml.sax modules no longer process +external entities by default. See also bpo-17239.

    +

    In 3.7.1 the tokenize module now implicitly emits a NEWLINE token +when provided with input that does not have a trailing new line. This behavior +now matches what the C tokenizer does internally. +(Contributed by Ammar Askar in bpo-33899.)

    +
    +
    +

    Notable changes in Python 3.7.2

    +

    In 3.7.2, venv on Windows no longer copies the original binaries, but +creates redirector scripts named python.exe and pythonw.exe instead. +This resolves a long standing issue where all virtual environments would have +to be upgraded or recreated with each Python update. However, note that this +release will still require recreation of virtual environments in order to get +the new scripts.

    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/whatsnew/changelog.html b/python-3.7.4-docs-html/whatsnew/changelog.html new file mode 100644 index 0000000..7db11f3 --- /dev/null +++ b/python-3.7.4-docs-html/whatsnew/changelog.html @@ -0,0 +1,14343 @@ + + + + + + + Changelog — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Changelog

    +
    +

    Python next

    +

    Release date: XXXX-XX-XX

    +
    +

    Core and Builtins

    +
      +
    • bpo-37467: Fix sys.excepthook() and PyErr_Display() if a +filename is a bytes string. For example, for a SyntaxError exception where +the filename attribute is a bytes string.

    • +
    • bpo-37417: bytearray.extend() now correctly handles errors that +arise during iteration. Patch by Brandt Bucher.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-37421: Fix multiprocessing.util.get_temp_dir() finalizer: clear +also the ‘tempdir’ configuration of the current process, so next call to +get_temp_dir() will create a new temporary directory, rather than +reusing the removed temporary directory.

    • +
    • bpo-37420: os.sched_setaffinity() now correctly handles errors that +arise during iteration over its mask argument. Patch by Brandt Bucher.

    • +
    • bpo-29412: Fix IndexError in parsing a header value ending unexpectedly. +Patch by Abhilash Raj.

    • +
    • bpo-27860: Fix IPv4Interface and IPv6Interface didn’t accept +string mask when the argument is tuple.

    • +
    • bpo-33972: Email with single part but content-type set to multipart/* +doesn’t raise AttributeError anymore.

    • +
    • bpo-37163: dataclasses.replace() now supports the field named “obj”.

    • +
    • bpo-4963: Fixed non-deterministic behavior related to mimetypes extension +mapping and module reinitialization.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-37487: Fix PyList_GetItem index description to include 0.

    • +
    • bpo-37478: Added possible exceptions to the description of os.chdir().

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-37335: Improve locale coercion tests by using codec lookup instead of +more fragile replace().

    • +
    • bpo-37411: Fix test_wsgiref.testEnviron() to no longer depend on the +environment variables (don’t fail if “X” variable is set).

    • +
    • bpo-37400: Fix test_os.test_chown(): use os.getgroups() rather than +grp.getgrall() to get groups. Rename also the test to test_chown_gid().

    • +
    • bpo-37359: Add –cleanup option to python3 -m test to remove +test_python_* directories of previous failed jobs. Add “make +cleantest” to run python3 -m test --cleanup.

    • +
    • bpo-37362: test_gdb no longer fails if it gets an “unexpected” message on +stderr: it now ignores stderr. The purpose of test_gdb is to test that +python-gdb.py commands work as expected, not to test gdb.

    • +
    • bpo-34347: Fix test_utf8_mode.test_cmd_line for AIX. Patch by M. Felt

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-10945: Officially drop support for creating bdist_wininst installers +on non-Windows systems.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-37325: Fix tab focus traversal order for help source and custom run +dialogs.

    • +
    • bpo-26806: To compensate for stack frames added by IDLE and avoid possible +problems with low recursion limits, add 30 to limits in the user code +execution process. Subtract 30 when reporting recursion limits to make +this addition mostly transparent.

    • +
    +
    +
    +
    +

    Python 3.7.4 final

    +

    Release date: 2019-07-08

    +
    +

    Core and Builtins

    +
      +
    • bpo-37500: Due to unintended side effects, revert the change introduced by +bpo-1875 in 3.7.4rc1 to check for syntax errors in dead conditional +code blocks.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-37149: Replace the dead link to the Tkinter 8.5 reference by John +Shipman, New Mexico Tech, with a link to the archive.org copy.

    • +
    +
    +
    +
    +

    Python 3.7.4 release candidate 2

    +

    Release date: 2019-07-02

    +
    +

    Security

    +
      +
    • bpo-37463: ssl.match_hostname() no longer accepts IPv4 addresses with +additional text after the address and only quad-dotted notation without +trailing whitespaces. Some inet_aton() implementations ignore whitespace +and all data after whitespace, e.g. ‘127.0.0.1 whatever’.

    • +
    +
    +
    +

    Core and Builtins

    +
      +
    • bpo-24214: Improved support of the surrogatepass error handler in the +UTF-8 and UTF-16 incremental decoders.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-37440: http.client now enables TLS 1.3 post-handshake authentication +for default context or if a cert_file is passed to HTTPSConnection.

    • +
    • bpo-37437: Update vendorized expat version to 2.2.7.

    • +
    • bpo-37428: SSLContext.post_handshake_auth = True no longer sets +SSL_VERIFY_POST_HANDSHAKE verify flag for client connections. Although the +option is documented as ignored for clients, OpenSSL implicitly enables +cert chain validation when the flag is set.

    • +
    • bpo-32627: Fix compile error when _uuid headers conflicting included.

    • +
    +
    +
    +

    Windows

    + +
    +
    +

    macOS

    +
      +
    • bpo-34602: Avoid test suite failures on macOS by no longer calling +resource.setrlimit to increase the process stack size limit at runtime. +The runtime change is no longer needed since the interpreter is being +built with a larger default stack size.

    • +
    +
    +
    +
    +

    Python 3.7.4 release candidate 1

    +

    Release date: 2019-06-18

    +
    +

    Security

    +
      +
    • bpo-35907: CVE-2019-9948: Avoid file reading by disallowing +local-file:// and local_file:// URL schemes in +URLopener().open() and URLopener().retrieve() of +urllib.request.

    • +
    • bpo-36742: Fixes mishandling of pre-normalization characters in +urlsplit().

    • +
    • bpo-30458: Address CVE-2019-9740 by disallowing URL paths with embedded +whitespace or control characters through into the underlying http client +request. Such potentially malicious header injection URLs now cause an +http.client.InvalidURL exception to be raised.

    • +
    • bpo-33529: Prevent fold function used in email header encoding from +entering infinite loop when there are too many non-ASCII characters in a +header.

    • +
    • bpo-35755: shutil.which() now uses os.confstr("CS_PATH") if +available and if the PATH environment variable is not set. +Remove also the current directory from posixpath.defpath. On Unix, +shutil.which() and the subprocess module no longer search the +executable in the current directory if the PATH environment +variable is not set.

    • +
    +
    +
    +

    Core and Builtins

    +
      +
    • bpo-37269: Fix a bug in the peephole optimizer that was not treating +correctly constant conditions with binary operators. Patch by Pablo +Galindo.

    • +
    • bpo-37219: Remove errorneous optimization for empty set differences.

    • +
    • bpo-26423: Fix possible overflow in wrap_lenfunc() when sizeof(long) +< sizeof(Py_ssize_t) (e.g., 64-bit Windows).

    • +
    • bpo-36829: PyErr_WriteUnraisable() now displays the exception even +if displaying the traceback failed. Moreover, hold a strong reference to +sys.stderr while using it. Document that an exception must be set +when calling PyErr_WriteUnraisable().

    • +
    • bpo-36907: Fix a crash when calling a C function with a keyword dict +(f(**kwargs)) and changing the dict kwargs while that function is +running.

    • +
    • bpo-36946: Fix possible signed integer overflow when handling slices.

    • +
    • bpo-27987: PyGC_Head structure is aligned to long double. This is +needed to ensure GC-ed objects are aligned properly. Patch by Inada +Naoki.

    • +
    • bpo-1875: A SyntaxError is now raised if a code blocks that will be +optimized away (e.g. if conditions that are always false) contains syntax +errors. Patch by Pablo Galindo. (Reverted in 3.7.4 final by +bpo-37500.)

    • +
    • bpo-28866: Avoid caching attributes of classes which type defines mro() to +avoid a hard cache invalidation problem.

    • +
    • bpo-27639: Correct return type for UserList slicing operations. Patch by +Michael Blahay, Erick Cervantes, and vaultah

    • +
    • bpo-32849: Fix Python Initialization code on FreeBSD to detect properly +when stdin file descriptor (fd 0) is invalid.

    • +
    • bpo-27987: pymalloc returns memory blocks aligned by 16 bytes, instead of +8 bytes, on 64-bit platforms to conform x86-64 ABI. Recent compilers +assume this alignment more often. Patch by Inada Naoki.

    • +
    • bpo-36504: Fix signed integer overflow in _ctypes.c’s +PyCArrayType_new().

    • +
    • bpo-20844: Fix running script with encoding cookie and LF line ending may +fail on Windows.

    • +
    • bpo-24214: Fixed support of the surrogatepass error handler in the UTF-8 +incremental decoder.

    • +
    • bpo-36459: Fix a possible double PyMem_FREE() due to tokenizer.c’s +tok_nextc().

    • +
    • bpo-36433: Fixed TypeError message in classmethoddescr_call.

    • +
    • bpo-36430: Fix a possible reference leak in itertools.count().

    • +
    • bpo-36440: Include node names in ParserError messages, instead of +numeric IDs. Patch by A. Skrobov.

    • +
    • bpo-36421: Fix a possible double decref in _ctypes.c’s +PyCArrayType_new().

    • +
    • bpo-36256: Fix bug in parsermodule when parsing a state in a DFA that has +two or more arcs with labels of the same type. Patch by Pablo Galindo.

    • +
    • bpo-36236: At Python initialization, the current directory is no longer +prepended to sys.path if it has been removed.

    • +
    • bpo-36262: Fix an unlikely memory leak on conversion from string to float +in the function _Py_dg_strtod() used by float(str), +complex(str), pickle.load(), marshal.load(), etc.

    • +
    • bpo-36218: Fix a segfault occuring when sorting a list of heterogeneous +values. Patch contributed by Rémi Lapeyre and Elliot Gorokhovsky.

    • +
    • bpo-36035: Added fix for broken symlinks in combination with pathlib

    • +
    • bpo-18372: Add missing PyObject_GC_Track() calls in the +pickle module. Patch by Zackery Spytz.

    • +
    • bpo-34408: Prevent a null pointer dereference and resource leakage in +PyInterpreterState_New().

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-37280: Use threadpool for reading from file for sendfile fallback +mode.

    • +
    • bpo-37279: Fix asyncio sendfile support when sendfile sends extra data in +fallback mode.

    • +
    • bpo-19865: ctypes.create_unicode_buffer() now also supports +non-BMP characters on platforms with 16-bit wchar_t (for +example, Windows and AIX).

    • +
    • bpo-35922: Fix RobotFileParser.crawl_delay() and +RobotFileParser.request_rate() to return None rather than raise +AttributeError when no relevant rule is defined in the robots.txt +file. Patch by Rémi Lapeyre.

    • +
    • bpo-36607: Eliminate RuntimeError raised by +asyncio.all_tasks() if internal tasks weak set is changed by +another thread during iteration.

    • +
    • bpo-36402: Fix a race condition at Python shutdown when waiting for +threads. Wait until the Python thread state of all non-daemon threads get +deleted (join all non-daemon threads), rather than just wait until +non-daemon Python threads complete.

    • +
    • bpo-34886: Fix an unintended ValueError from subprocess.run() when +checking for conflicting input and stdin or capture_output and +stdout or stderr args when they were explicitly provided but with +None values within a passed in **kwargs dict rather than as passed +directly by name. Patch contributed by Rémi Lapeyre.

    • +
    • bpo-37173: The exception message for inspect.getfile() now correctly +reports the passed class rather than the builtins module.

    • +
    • bpo-12639: msilib.Directory.start_component() no longer fails if +keyfile is not None.

    • +
    • bpo-36520: Lengthy email headers with UTF-8 characters are now properly +encoded when they are folded. Patch by Jeffrey Kintscher.

    • +
    • bpo-37054: Fix destructor _pyio.BytesIO and +_pyio.TextIOWrapper: initialize their _buffer attribute as +soon as possible (in the class body), because it’s used by __del__() +which calls close().

    • +
    • bpo-30835: Fixed a bug in email parsing where a message with invalid bytes +in content-transfer-encoding of a multipart message can cause an +AttributeError. Patch by Andrew Donnellan.

    • +
    • bpo-37035: Don’t log OSError based exceptions if a fatal error has +occurred in asyncio transport. Peer can generate almost any OSError, user +cannot avoid these exceptions by fixing own code. Errors are still +propagated to user code, it’s just logging them is pointless and pollute +asyncio logs.

    • +
    • bpo-37008: Add support for calling next() with the mock resulting +from unittest.mock.mock_open()

    • +
    • bpo-27737: Allow whitespace only header encoding in email.header - by +Batuhan Taskaya

    • +
    • bpo-36969: PDB command args now display keyword only arguments. Patch +contributed by Rémi Lapeyre.

    • +
    • bpo-36983: Add missing names to typing.__all__: ChainMap, +ForwardRef, OrderedDict - by Anthony Sottile.

    • +
    • bpo-21315: Email headers containing RFC2047 encoded words are parsed +despite the missing whitespace, and a defect registered. Also missing +trailing whitespace after encoded words is now registered as a defect.

    • +
    • bpo-33524: Fix the folding of email header when the max_line_length is 0 +or None and the header contains non-ascii characters. Contributed by +Licht Takeuchi (@Licht-T).

    • +
    • bpo-24564: shutil.copystat() now ignores errno.EINVAL on +os.setxattr() which may occur when copying files on filesystems +without extended attributes support.

      +

      Original patch by Giampaolo Rodola, updated by Ying Wang.

      +
    • +
    • bpo-36845: Added validation of integer prefixes to the construction of IP +networks and interfaces in the ipaddress module.

    • +
    • bpo-35545: Fix asyncio discarding IPv6 scopes when ensuring hostname +resolutions internally

    • +
    • bpo-35070: posix.getgrouplist() now works correctly when the user belongs +to NGROUPS_MAX supplemental groups. Patch by Jeffrey Kintscher.

    • +
    • bpo-24538: In shutil.copystat(), first copy extended file attributes and +then file permissions, since extended attributes can only be set on the +destination while it is still writeable.

    • +
    • bpo-33110: Handle exceptions raised by functions added by +concurrent.futures add_done_callback correctly when the Future has already +completed.

    • +
    • bpo-26903: Limit max_workers in ProcessPoolExecutor to 61 to work +around a WaitForMultipleObjects limitation.

    • +
    • bpo-36813: Fix QueueListener to call +queue.task_done() upon stopping. Patch by Bar Harel.

    • +
    • bpo-36734: Fix compilation of faulthandler.c on HP-UX. Initialize +stack_t current_stack to zero using memset().

    • +
    • bpo-29183: Fix double exceptions in wsgiref.handlers.BaseHandler +by calling its close() method only +when no exception is raised.

    • +
    • bpo-36650: The C version of functools.lru_cache() was treating calls with +an empty **kwargs dictionary as being distinct from calls with no +keywords at all. This did not result in an incorrect answer, but it did +trigger an unexpected cache miss.

    • +
    • bpo-28552: Fix distutils.sysconfig if sys.executable is +None or an empty string: use os.getcwd() to initialize +project_base. Fix also the distutils build command: don’t use +sys.executable if it is None or an empty string.

    • +
    • bpo-35755: shutil.which() and +distutils.spawn.find_executable() now use os.confstr("CS_PATH") +if available instead of os.defpath, if the PATH environment +variable is not set. Moreover, don’t use os.confstr("CS_PATH") nor +os.defpath if the PATH environment variable is set to an empty +string.

    • +
    • bpo-36613: Fix asyncio wait() not removing callback if exception

    • +
    • bpo-36598: Fix isinstance check for Mock objects with spec when the +code is executed under tracing. Patch by Karthikeyan Singaravelan.

    • +
    • bpo-36533: Reinitialize logging.Handler locks in forked child processes +instead of attempting to acquire them all in the parent before forking +only to be released in the child process. The acquire/release pattern was +leading to deadlocks in code that has implemented any form of chained +logging handlers that depend upon one another as the lock acquision order +cannot be guaranteed.

    • +
    • bpo-36522: If debuglevel is set to >0 in http.client, print all +values for headers with multiple values for the same header name. Patch by +Matt Houglum.

    • +
    • bpo-36492: Arbitrary keyword arguments (even with names “self” and “func”) +can now be passed to some functions which should accept arbitrary keyword +arguments and pass them to other function (for example partialmethod(), +TestCase.addCleanup() and Profile.runcall()) if the required arguments are +passed as positional arguments.

    • +
    • bpo-36434: Errors during writing to a ZIP file no longer prevent to +properly close it.

    • +
    • bpo-34745: Fix asyncio ssl memory issues caused by circular +references

    • +
    • bpo-36321: collections.namedtuple() misspelled the name of an attribute. +To be consistent with typing.NamedTuple, the attribute name should have +been “_field_defaults” instead of “_fields_defaults”. For backwards +compatibility, both spellings are now created. The misspelled version may +be removed in the future.

    • +
    • bpo-36272: logging does not silently ignore RecursionError anymore. +Patch contributed by Rémi Lapeyre.

    • +
    • bpo-36235: Fix CFLAGS in customize_compiler() of +distutils.sysconfig: when the CFLAGS environment variable is +defined, don’t override CFLAGS variable with the OPT variable +anymore. Initial patch written by David Malcolm.

    • +
    • bpo-35125: Asyncio: Remove inner callback on outer cancellation in shield

    • +
    • bpo-35802: Clean up code which checked presence of os.stat / +os.lstat / os.chmod which are always present. Patch by Anthony +Sottile.

    • +
    • bpo-23078: Add support for classmethod() and staticmethod() to +unittest.mock.create_autospec(). Initial patch by Felipe Ochoa.

    • +
    • bpo-35721: Fix asyncio.SelectorEventLoop.subprocess_exec() leaks +file descriptors if Popen fails and called with +stdin=subprocess.PIPE. Patch by Niklas Fiekas.

    • +
    • bpo-35726: QueueHandler.prepare() now makes a copy of the record before +modifying and enqueueing it, to avoid affecting other handlers in the +chain.

    • +
    • bpo-31855: unittest.mock.mock_open() results now respects the +argument of read([size]). Patch contributed by Rémi Lapeyre.

    • +
    • bpo-35082: Don’t return deleted attributes when calling dir on a +unittest.mock.Mock.

    • +
    • bpo-34547: wsgiref.handlers.BaseHandler now handles abrupt client +connection terminations gracefully. Patch by Petter Strandmark.

    • +
    • bpo-34424: Fix serialization of messages containing encoded strings when +the policy.linesep is set to a multi-character string. Patch by Jens +Troeger.

    • +
    • bpo-33361: Fix a bug in codecs.StreamRecoder where seeking might +leave old data in a buffer and break subsequent read calls. Patch by Ammar +Askar.

    • +
    • bpo-31922: asyncio.AbstractEventLoop.create_datagram_endpoint(): Do +not connect UDP socket when broadcast is allowed. This allows to receive +replies after a UDP broadcast.

    • +
    • bpo-22102: Added support for ZIP files with disks set to 0. Such files are +commonly created by builtin tools on Windows when use ZIP64 extension. +Patch by Francisco Facioni.

    • +
    • bpo-27141: Added a __copy__() to collections.UserList and +collections.UserDict in order to correctly implement shallow copying +of the objects. Patch by Bar Harel.

    • +
    • bpo-31829: \r, \0 and \x1a (end-of-file on Windows) are now +escaped in protocol 0 pickles of Unicode strings. This allows to load them +without loss from files open in text mode in Python 2.

    • +
    • bpo-31292: Fix setup.py check --restructuredtext for files containing +include directives.

    • +
    • bpo-23395: _thread.interrupt_main() now avoids setting the Python +error status if the SIGINT signal is ignored or not handled by Python.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-34903: Documented that in datetime.datetime.strptime(), the +leading zero in some two-digit formats is optional. Patch by Mike Gleen.

    • +
    • bpo-36984: Improve version added references in typing module - by +Anthony Sottile.

    • +
    • bpo-36868: What’s new now mentions SSLContext.hostname_checks_common_name +instead of SSLContext.host_flags.

    • +
    • bpo-36783: Added C API Documentation for Time_FromTimeAndFold and +PyDateTime_FromDateAndTimeAndFold as per PEP 495. Patch by Edison +Abahurire.

    • +
    • bpo-30840: Document relative imports

    • +
    • bpo-36523: Add docstring for io.IOBase.writelines().

    • +
    • bpo-36425: New documentation translation: Simplified Chinese.

    • +
    • bpo-36157: Added Documention for PyInterpreterState_Main().

    • +
    • bpo-36138: Improve documentation about converting datetime.timedelta to +scalars.

    • +
    • bpo-22865: Add detail to the documentation on the pty.spawn function.

    • +
    • bpo-35581: @typing.type_check_only now allows type stubs to mark functions +and classes not available during runtime.

    • +
    • bpo-35564: Explicitly set master_doc variable in conf.py for compliance +with Sphinx 2.0

    • +
    • bpo-10536: Enhance the gettext docs. Patch by Éric Araujo

    • +
    • bpo-32995: Added the context variable in glossary.

    • +
    • bpo-33832: Add glossary entry for ‘magic method’.

    • +
    • bpo-33482: Make codecs.StreamRecoder.writelines take a list of bytes.

    • +
    • bpo-25735: Added documentation for func factorial to indicate that returns +integer values

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-35998: Avoid TimeoutError in test_asyncio: test_start_tls_server_1()

    • +
    • bpo-37153: test_venv.test_mutiprocessing() now explicitly calls +pool.terminate() to wait until the pool completes.

    • +
    • bpo-37081: Test with OpenSSL 1.1.1c

    • +
    • bpo-36915: The main regrtest process now always removes all temporary +directories of worker processes even if they crash or if they are killed +on KeyboardInterrupt (CTRL+c).

    • +
    • bpo-36719: “python3 -m test -jN …” now continues the execution of next +tests when a worker process crash (CHILD_ERROR state). Previously, the +test suite stopped immediately. Use –failfast to stop at the first error.

    • +
    • bpo-36816: Update Lib/test/selfsigned_pythontestdotnet.pem to match +self-signed.pythontest.net’s new TLS certificate.

    • +
    • bpo-35925: Skip httplib and nntplib networking tests when they would +otherwise fail due to a modern OS or distro with a default OpenSSL policy +of rejecting connections to servers with weak certificates.

    • +
    • bpo-36719: regrtest now always detects uncollectable objects. Previously, +the check was only enabled by --findleaks. The check now also works +with -jN/--multiprocess N. --findleaks becomes a deprecated alias +to --fail-env-changed.

    • +
    • bpo-36725: When using mulitprocessing mode (-jN), regrtest now better +reports errors if a worker process fails, and it exits immediately on a +worker thread failure or when interrupted.

    • +
    • bpo-36454: Change test_time.test_monotonic() to test only the lower bound +of elapsed time after a sleep command rather than the upper bound. This +prevents unnecessary test failures on slow buildbots. Patch by Victor +Stinner.

    • +
    • bpo-36629: Fix test_imap4_host_default_value() of test_imaplib: +catch also errno.ENETUNREACH error.

    • +
    • bpo-36611: Fix test_sys.test_getallocatedblocks() when +tracemalloc is enabled.

    • +
    • bpo-36560: Fix reference leak hunting in regrtest: compute also deltas (of +reference count, allocated memory blocks, file descriptor count) during +warmup, to ensure that everything is initialized before starting to hunt +reference leaks.

    • +
    • bpo-36565: Fix reference hunting (python3 -m test -R 3:3) when Python +has no built-in abc module.

    • +
    • bpo-36436: Fix _testcapi.pymem_buffer_overflow(): handle memory +allocation failure.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-36605: make tags and make TAGS now also parse +Modules/_io/*.c and Modules/_io/*.h.

    • +
    • bpo-36508: python-config --ldflags no longer includes flags of the +LINKFORSHARED variable. The LINKFORSHARED variable must only be +used to build executables.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-34631: Updated OpenSSL to 1.1.1c in Windows installer

    • +
    • bpo-37267: On Windows, os.dup() no longer creates an inheritable fd +when handling a character file.

    • +
    • bpo-36779: Ensure time.tzname is correct on Windows when the active +code page is set to CP_UTF7 or CP_UTF8.

    • +
    • bpo-36965: include of STATUS_CONTROL_C_EXIT without depending on MSC +compiler

    • +
    • bpo-36649: Remove trailing spaces for registry keys when installed via the +Store.

    • +
    • bpo-34144: Fixed activate.bat to correctly update codepage when chcp.com +returns dots in output. Patch by Lorenz Mende.

    • +
    • bpo-35941: enum_certificates function of the ssl module now returns +certificates from all available certificate stores inside windows in a +query instead of returning only certificates from the system wide +certificate store. This includes certificates from these certificate +stores: local machine, local machine enterprise, local machine group +policy, current user, current user group policy, services, users. +ssl.enum_crls() function is changed in the same way to return all +certificate revocation lists inside the windows certificate revocation +list stores.

    • +
    • bpo-36441: Fixes creating a venv when debug binaries are installed.

    • +
    • bpo-36312: Fixed decoders for the following code pages: 50220, 50221, +50222, 50225, 50227, 50229, 57002 through 57011, 65000 and 42.

    • +
    • bpo-36010: Add the venv standard library module to the nuget distribution +for Windows.

    • +
    • bpo-34060: Report system load when running test suite on Windows. Patch by +Ammar Askar. Based on prior work by Jeremy Kloth.

    • +
    +
    +
    +

    macOS

    +
      +
    • bpo-35360: Update macOS installer to use SQLite 3.28.0.

    • +
    • bpo-34631: Updated OpenSSL to 1.1.1c in macOS installer.

    • +
    • bpo-36231: Support building Python on macOS without /usr/include +installed. As of macOS 10.14, system header files are only available +within an SDK provided by either the Command Line Tools or the Xcode app.

    • +
    • bpo-34602: Avoid failures setting macOS stack resource limit with +resource.setrlimit. This reverts an earlier fix for bpo-18075 which forced +a non-default stack size when building the interpreter executable on +macOS.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-37321: Both subprocess connection error messages now refer to the +‘Startup failure’ section of the IDLE doc.

    • +
    • bpo-37177: Properly ‘attach’ search dialogs to their main window so that +they behave like other dialogs and do not get hidden behind their main +window.

    • +
    • bpo-37039: Adjust “Zoom Height” to individual screens by momemtarily +maximizing the window on first use with a particular screen. Changing +screen settings may invalidate the saved height. While a window is +maximized, “Zoom Height” has no effect.

    • +
    • bpo-35763: Make calltip reminder about ‘/’ meaning positional-only less +obtrusive by only adding it when there is room on the first line.

    • +
    • bpo-5680: Add ‘Run… Customized’ to the Run menu to run a module with +customized settings. Any ‘command line arguments’ entered are added to +sys.argv. One can suppress the normal Shell main module restart.

    • +
    • bpo-35610: Replace now redundant .context_use_ps1 with .prompt_last_line. +This finishes change started in bpo-31858.

    • +
    • bpo-37038: Make idlelib.run runnable; add test clause.

    • +
    • bpo-36958: Print any argument other than None or int passed to SystemExit +or sys.exit().

    • +
    • bpo-13102: When saving a file, call os.fsync() so bits are flushed to e.g. +USB drive.

    • +
    • bpo-36429: Fix starting IDLE with pyshell. Add idlelib.pyshell alias at +top; remove pyshell alias at bottom. Remove obsolete __name__==’__main__’ +command.

    • +
    • bpo-36405: Use dict unpacking in idlelib.

    • +
    • bpo-36396: Remove fgBg param of idlelib.config.GetHighlight(). This param +was only used twice and changed the return type.

    • +
    • bpo-23205: For the grep module, add tests for findfiles, refactor +findfiles to be a module-level function, and refactor findfiles to use +os.walk.

    • +
    • bpo-23216: Add docstrings to IDLE search modules.

    • +
    • bpo-30348: Increase test coverage of idlelib.autocomplete by 30%.

    • +
    • bpo-32411: In browser.py, remove extraneous sorting by line number since +dictionary was created in line number order.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-14546: Fix the argument handling in Tools/scripts/lll.py.

    • +
    • bpo-32217: Fix freeze script on Windows.

    • +
    +
    +
    +

    C API

    + +
    +
    +
    +

    Python 3.7.3 final

    +

    Release date: 2019-03-25

    +

    There were no new changes in version 3.7.3.

    +
    +
    +

    Python 3.7.3 release candidate 1

    +

    Release date: 2019-03-12

    +
    +

    Security

    +
      +
    • bpo-36216: Changes urlsplit() to raise ValueError when the URL contains +characters that decompose under IDNA encoding (NFKC-normalization) into +characters that affect how the URL is parsed.

    • +
    • bpo-35746: [CVE-2019-5010] Fix a NULL pointer deref in ssl module. The +cert parser did not handle CRL distribution points with empty DP or URI +correctly. A malicious or buggy certificate can result into segfault. +Vulnerability (TALOS-2018-0758) reported by Colin Read and Nicolas Edet of +Cisco.

    • +
    • bpo-35121: Don’t send cookies of domain A without Domain attribute to +domain B when domain A is a suffix match of domain B while using a +cookiejar with http.cookiejar.DefaultCookiePolicy policy. Patch +by Karthikeyan Singaravelan.

    • +
    +
    +
    +

    Core and Builtins

    +
      +
    • bpo-35942: The error message emitted when returning invalid types from +__fspath__ in interfaces that allow passing PathLike +objects has been improved and now it does explain the origin of the error.

    • +
    • bpo-35992: Fix __class_getitem__() not being called on a class with a +custom non-subscriptable metaclass.

    • +
    • bpo-35991: Fix a potential double free in Modules/_randommodule.c.

    • +
    • bpo-35961: Fix a crash in slice_richcompare(): use strong references +rather than stolen references for the two temporary internal tuples.

    • +
    • bpo-31506: Clarify the errors reported when object.__new__ and +object.__init__ receive more than one argument. Contributed by Sanyam +Khurana.

    • +
    • bpo-35720: Fixed a minor memory leak in pymain_parse_cmdline_impl function +in Modules/main.c

    • +
    • bpo-35623: Fix a crash when sorting very long lists. Patch by Stephan +Hohe.

    • +
    • bpo-35214: clang Memory Sanitizer build instrumentation was added to work +around false positives from posix, socket, time, test_io, and +test_faulthandler.

    • +
    • bpo-35560: Fix an assertion error in format() in debug build for +floating point formatting with “n” format, zero padding and small width. +Release build is not impacted. Patch by Karthikeyan Singaravelan.

    • +
    • bpo-35552: Format characters %s and %V in +PyUnicode_FromFormat() and %s in PyBytes_FromFormat() +no longer read memory past the limit if precision is specified.

    • +
    • bpo-35504: Fix segfaults and SystemErrors when deleting certain +attributes. Patch by Zackery Spytz.

    • +
    • bpo-33989: Fix a possible crash in list.sort() when sorting objects +with ob_type->tp_richcompare == NULL. Patch by Zackery Spytz.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-35931: The pdb debug command now gracefully handles all +exceptions.

    • +
    • bpo-36251: Fix format strings used for stderrprinter and re.Match reprs. +Patch by Stephan Hohe.

    • +
    • bpo-35807: Update ensurepip to install pip 19.0.3 and setuptools 40.8.0.

    • +
    • bpo-36179: Fix two unlikely reference leaks in _hashopenssl. The leaks +only occur in out-of-memory cases.

    • +
    • bpo-35178: Ensure custom warnings.formatwarning() function can +receive line as positional argument. Based on patch by Tashrif Billah.

    • +
    • bpo-36106: Resolve potential name clash with libm’s sinpi(). Patch by +Dmitrii Pasechnik.

    • +
    • bpo-35512: unittest.mock.patch.dict() used as a decorator with +string target resolves the target during function call instead of during +decorator construction. Patch by Karthikeyan Singaravelan.

    • +
    • bpo-36091: Clean up reference to async generator in Lib/types. Patch by +Henry Chen.

    • +
    • bpo-35899: Enum has been fixed to correctly handle empty strings and +strings with non-Latin characters (ie. ‘α’, ‘א’) without crashing. +Original patch contributed by Maxwell. Assisted by Stéphane Wirtel.

    • +
    • bpo-35918: Removed broken has_key method from +multiprocessing.managers.SyncManager.dict. Contributed by Rémi Lapeyre.

    • +
    • bpo-35960: Fix dataclasses.field() throwing away empty mapping +objects passed as metadata.

    • +
    • bpo-35847: RISC-V needed the CTYPES_PASS_BY_REF_HACK. Fixes ctypes +Structure test_pass_by_value.

    • +
    • bpo-35780: Fix lru_cache() errors arising in recursive, reentrant, or +multi-threaded code. These errors could result in orphan links and in the +cache being trapped in a state with fewer than the specified maximum +number of links. Fix handling of negative maxsize which should have been +treated as zero. Fix errors in toggling the “full” status flag. Fix +misordering of links when errors are encountered. Sync-up the C code and +pure Python code for the space saving path in functions with a single +positional argument. In this common case, the space overhead of an lru +cache entry is reduced by almost half. Fix counting of cache misses. In +error cases, the miss count was out of sync with the actual number of +times the underlying user function was called.

    • +
    • bpo-23846: asyncio.ProactorEventLoop now catches and logs send +errors when the self-pipe is full.

    • +
    • bpo-34323: asyncio: Enhance IocpProactor.close() log: wait 1 +second before the first log, then log every second. Log also the number of +seconds since close() was called.

    • +
    • bpo-34294: re module, fix wrong capturing groups in rare cases. +re.search(), re.findall(), re.sub() and other functions +that scan through string looking for a match, should reset capturing +groups between two match attempts. Patch by Ma Lin.

    • +
    • bpo-35717: Fix KeyError exception raised when using enums and compile. +Patch contributed by Rémi Lapeyre.

    • +
    • bpo-35699: Fixed detection of Visual Studio Build Tools 2017 in distutils

    • +
    • bpo-32710: Fix memory leaks in asyncio ProactorEventLoop on overlapped +operation failure.

    • +
    • bpo-32710: Fix a memory leak in asyncio in the ProactorEventLoop when +ReadFile() or WSASend() overlapped operation fail immediately: +release the internal buffer.

    • +
    • bpo-35682: Fix asyncio.ProactorEventLoop.sendfile(): don’t attempt to +set the result of an internal future if it’s already done.

    • +
    • bpo-35283: Add a pending deprecated warning for the +threading.Thread.isAlive() method. Patch by Dong-hee Na.

    • +
    • bpo-35643: Fixed a SyntaxWarning: invalid escape sequence in +Modules/_sha3/cleanup.py. Patch by Mickaël Schoentgen.

    • +
    • bpo-35615: weakref: Fix a RuntimeError when copying a +WeakKeyDictionary or a WeakValueDictionary, due to some keys or values +disappearing while iterating.

    • +
    • bpo-28503: The crypt module now internally uses the crypt_r() library +function instead of crypt() when available.

    • +
    • bpo-35121: Don’t set cookie for a request when the request path is a +prefix match of the cookie’s path attribute but doesn’t end with “/”. +Patch by Karthikeyan Singaravelan.

    • +
    • bpo-35585: Speed-up building enums by value, e.g. http.HTTPStatus(200).

    • +
    • bpo-21478: Calls to a child function created with +unittest.mock.create_autospec() should propagate to the parent. +Patch by Karthikeyan Singaravelan.

    • +
    • bpo-35513: TextTestRunner of +unittest.runner now uses time.perf_counter() rather than +time.time() to measure the execution time of a test: +time.time() can go backwards, whereas time.perf_counter() is +monotonic.

    • +
    • bpo-35502: Fixed reference leaks in +xml.etree.ElementTree.TreeBuilder in case of unfinished building +of the tree (in particular when an error was raised during parsing XML).

    • +
    • bpo-31446: Copy command line that was passed to CreateProcessW since this +function can change the content of the input buffer.

    • +
    • bpo-20239: Allow repeated assignment deletion of +unittest.mock.Mock attributes. Patch by Pablo Galindo.

    • +
    • bpo-17185: Set __signature__ on mock for inspect to get +signature. Patch by Karthikeyan Singaravelan.

    • +
    • bpo-10496: check_environ() of +distutils.utils now catches KeyError on calling +pwd.getpwuid(): don’t create the HOME environment variable in +this case.

    • +
    • bpo-35066: Previously, calling the strftime() method on a datetime object +with a trailing ‘%’ in the format string would result in an exception. +However, this only occured when the datetime C module was being used; the +python implementation did not match this behavior. Datetime is now PEP-399 +compliant, and will not throw an exception on a trailing ‘%’.

    • +
    • bpo-24746: Avoid stripping trailing whitespace in doctest fancy diff. +Orignial patch by R. David Murray & Jairo Trad. Enhanced by Sanyam +Khurana.

    • +
    • bpo-35198: Fix C++ extension compilation on AIX

    • +
    • bpo-28441: On Cygwin and MinGW, ensure that sys.executable always +includes the full filename in the path, including the .exe suffix +(unless it is a symbolic link).

    • +
    • bpo-34572: Fix C implementation of pickle.loads to use importlib’s locking +mechanisms, and thereby avoid using partially-loaded modules. Patch by Tim +Burgess.

    • +
    • bpo-33687: Fix the call to os.chmod() for uu.decode() if a mode is +given or decoded. Patch by Timo Furrer.

    • +
    • bpo-32146: Document the interaction between frozen executables and the +spawn and forkserver start methods in multiprocessing.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-36083: Fix formatting of –check-hash-based-pycs options in the +manpage Synopsis.

    • +
    • bpo-34764: Improve example of iter() with 2nd sentinel argument.

    • +
    • bpo-21314: A new entry was added to the Core Language Section of the +Programming FAQ, which explaines the usage of slash(/) in the signature of +a function. Patch by Lysandros Nikolaou

    • +
    • bpo-22062: Update documentation and docstrings for pathlib. Original patch +by Mike Short.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-36234: test_posix.PosixUidGidTests: add tests for invalid uid/gid type +(str). Initial patch written by David Malcolm.

    • +
    • bpo-29571: Fix test_re.test_locale_flag(): use +locale.getpreferredencoding() rather than locale.getlocale() to +get the locale encoding. With some locales, locale.getlocale() returns +the wrong encoding. On Windows, set temporarily the LC_CTYPE locale to +the user preferred encoding to ensure that it uses the ANSI code page, to +be consistent with locale.getpreferredencoding().

    • +
    • bpo-36123: Fix race condition in test_socket.

    • +
    • bpo-27313: Avoid test_ttk_guionly ComboboxTest failure with macOS Cocoa +Tk.

    • +
    • bpo-36019: Add test.support.TEST_HTTP_URL and replace references of +http://www.example.com by this new constant. Contributed by Stéphane +Wirtel.

    • +
    • bpo-36037: Fix test_ssl for strict OpenSSL configuration like RHEL8 strict +crypto policy. Use older TLS version for minimum TLS version of the server +SSL context if needed, to test TLS version older than default minimum TLS +version.

    • +
    • bpo-35505: Make test_imap4_host_default_value independent on whether the +local IMAP server is running.

    • +
    • bpo-35917: multiprocessing: provide unit tests for SyncManager and +SharedMemoryManager classes + all the shareable types which are supposed +to be supported by them. (patch by Giampaolo Rodola)

    • +
    • bpo-35772: Fix sparse file tests of test_tarfile on ppc64 with the tmpfs +filesystem. Fix the function testing if the filesystem supports sparse +files: create a file which contains data and “holes”, instead of creating +a file which contains no data. tmpfs effective block size is a page size +(tmpfs lives in the page cache). RHEL uses 64 KiB pages on aarch64, ppc64, +ppc64le, only s390x and x86_64 use 4 KiB pages, whereas the test punch +holes of 4 KiB.

    • +
    • bpo-35045: Make ssl tests less strict and also accept TLSv1 as system +default. The changes unbreaks test_min_max_version on Fedora 29.

    • +
    • bpo-31731: Fix a race condition in check_interrupted_write() of +test_io: create directly the thread with SIGALRM signal blocked, rather +than blocking the signal later from the thread. Previously, it was +possible that the thread gets the signal before the signal is blocked.

    • +
    • bpo-35424: Fix test_multiprocessing_main_handling: use +multiprocessing.Pool with a context manager and then explicitly +join the pool.

    • +
    • bpo-35519: Rename test.bisect module to test.bisect_cmd to +avoid conflict with bisect module when running directly a test like +./python Lib/test/test_xmlrpc.py.

    • +
    • bpo-35513: Replace time.time() with time.monotonic() in tests +to measure time delta.

    • +
    • bpo-34279: test.support.run_unittest() no longer raise +TestDidNotRun if the test result contains skipped tests. The +exception is now only raised if no test have been run and no test have +been skipped.

    • +
    • bpo-35412: Add testcase to test_future4: check unicode literal.

    • +
    • bpo-26704: Added test demonstrating double-patching of an instance method. +Patch by Anthony Sottile.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-34691: The _contextvars module is now built into the core Python +library on Windows.

    • +
    • bpo-35683: Improved Azure Pipelines build steps and now verifying layouts +correctly

    • +
    • bpo-35642: Remove asynciomodule.c from pythoncore.vcxproj

    • +
    • bpo-35550: Fix incorrect Solaris #ifdef checks to look for __sun && __SVR4 +instead of sun when compiling.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-24643: Fix name collisions due to #define timezone _timezone in +PC/pyconfig.h.

    • +
    • bpo-35692: pathlib no longer raises when checking file and directory +existence on drives that are not ready

    • +
    • bpo-35872: Uses the base Python executable when invoking venv in a virtual +environment

    • +
    • bpo-35873: Prevents venv paths being inherited by child processes

    • +
    • bpo-35299: Fix sysconfig detection of the source directory and distutils +handling of pyconfig.h during PGO profiling

    • +
    • bpo-32560: The py launcher now forwards its STARTUPINFO structure +to child processes.

    • +
    • bpo-35854: Fix EnvBuilder and –symlinks in venv on Windows

    • +
    • bpo-35811: Avoid propagating venv settings when launching via py.exe

    • +
    • bpo-35797: Fix default executable used by the multiprocessing module

    • +
    • bpo-29734: Fix handle leaks in os.stat on Windows.

    • +
    • bpo-35596: Use unchecked PYCs for the embeddable distro to avoid zipimport +restrictions.

    • +
    • bpo-35596: Fix vcruntime140.dll being added to embeddable distro multiple +times.

    • +
    • bpo-35402: Update Windows build to use Tcl and Tk 8.6.9

    • +
    • bpo-33316: PyThread_release_lock always fails

    • +
    • bpo-1104: Correctly handle string length in +msilib.SummaryInfo.GetProperty() to prevent it from truncating the +last character.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-36176: Fix IDLE autocomplete & calltip popup colors. Prevent conflicts +with Linux dark themes (and slightly darken calltip background).

    • +
    • bpo-36152: Remove colorizer.ColorDelegator.close_when_done and the +corresponding argument of .close(). In IDLE, both have always been None +or False since 2007.

    • +
    • bpo-32129: Avoid blurry IDLE application icon on macOS with Tk 8.6. Patch +by Kevin Walzer.

    • +
    • bpo-24310: IDLE – Document settings dialog font tab sample.

    • +
    • bpo-36096: Refactor class variables to instance variables in colorizer.

    • +
    • bpo-35833: Revise IDLE doc for control codes sent to Shell. Add a code +example block.

    • +
    • bpo-35770: IDLE macosx deletes Options => Configure IDLE. It previously +deleted Window => Zoom Height by mistake. (Zoom Height is now on the +Options menu). On Mac, the settings dialog is accessed via Preferences on +the IDLE menu.

    • +
    • bpo-35769: Change IDLE’s new file name from ‘Untitled’ to ‘untitled’

    • +
    • bpo-35689: Add docstrings and unittests for colorizer.py.

    • +
    • bpo-35660: Fix imports in idlelib.window.

    • +
    • bpo-35641: Proper format calltip when the function has no docstring.

    • +
    • bpo-33987: Use ttk Frame for ttk widgets.

    • +
    • bpo-34055: Fix erroneous ‘smart’ indents and newlines in IDLE Shell.

    • +
    • bpo-35591: Find Selection now works when selection not found.

    • +
    • bpo-35196: Speed up squeezer line counting.

    • +
    • bpo-35598: Update config_key: use PEP 8 names and ttk widgets, make some +objects global, and add tests.

    • +
    • bpo-28097: Add Previous/Next History entries to Shell menu.

    • +
    • bpo-35208: Squeezer now properly counts wrapped lines before newlines.

    • +
    • bpo-35555: Gray out Code Context menu entry when it’s not applicable.

    • +
    • bpo-35521: Document the IDLE editor code context feature. Add some +internal references within the IDLE doc.

    • +
    • bpo-22703: The Code Context menu label now toggles between Show/Hide Code +Context. The Zoom Height menu now toggles between Zoom/Restore Height. +Zoom Height has moved from the Window menu to the Options menu.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-35132: Fix py-list and py-bt commands of python-gdb.py on gdb7.

    • +
    +
    +
    +

    C API

    + +
    +
    +
    +

    Python 3.7.2 final

    +

    Release date: 2018-12-23

    +
    +

    Library

    +
      +
    • bpo-31715: Associate .mjs file extension with +application/javascript MIME Type.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-35499: make profile-opt no longer replaces CFLAGS_NODIST with +CFLAGS. It now adds profile-guided optimization (PGO) flags to +CFLAGS_NODIST: existing CFLAGS_NODIST flags are kept.

    • +
    • bpo-35257: Avoid leaking the linker flags from Link Time Optimizations +(LTO) into distutils when compiling C extensions.

    • +
    +
    +
    +

    C API

    + +
    +
    +
    +

    Python 3.7.2 release candidate 1

    +

    Release date: 2018-12-11

    +
    +

    Security

    +
      +
    • bpo-34812: The -I command line option (run Python in isolated +mode) is now also copied by the multiprocessing and +distutils modules when spawning child processes. Previously, only +-E and -s options (enabled by -I) were +copied.

    • +
    • bpo-34791: The xml.sax and xml.dom.domreg no longer use environment +variables to override parser implementations when +sys.flags.ignore_environment is set by -E or -I arguments.

    • +
    +
    +
    +

    Core and Builtins

    +
      +
    • bpo-35444: Fixed error handling in pickling methods when fail to look up +builtin “getattr”.

    • +
    • bpo-35436: Fix various issues with memory allocation error handling. +Patch by Zackery Spytz.

    • +
    • bpo-35357: Internal attributes’ names of unittest.mock._Call and +unittest.mock.MagicProxy (name, parent & from_kall) are now prefixed with +_mock_ in order to prevent clashes with widely used object attributes. +Fixed minor typo in test function name.

    • +
    • bpo-35372: Fixed the code page decoder for input longer than 2 GiB +containing undecodable bytes.

    • +
    • bpo-35336: Fix PYTHONCOERCECLOCALE=1 environment variable: only coerce the +C locale if the LC_CTYPE locale is “C”.

    • +
    • bpo-33954: For str.format(), float.__format__() and +complex.__format__() methods for non-ASCII decimal point when using +the “n” formatter.

    • +
    • bpo-35269: Fix a possible segfault involving a newly-created coroutine. +Patch by Zackery Spytz.

    • +
    • bpo-35214: Fixed an out of bounds memory access when parsing a truncated +unicode escape sequence at the end of a string such as '\N'. It would +read one byte beyond the end of the memory allocation.

    • +
    • bpo-35214: The interpreter and extension modules have had annotations +added so that they work properly under clang’s Memory Sanitizer. A new +configure flag –with-memory-sanitizer has been added to make test builds +of this nature easier to perform.

    • +
    • bpo-35193: Fix an off by one error in the bytecode peephole optimizer +where it could read bytes beyond the end of bounds of an array when +removing unreachable code. This bug was present in every release of Python +3.6 and 3.7 until now.

    • +
    • bpo-29341: Clarify in the docstrings of os methods that path-like +objects are also accepted as input parameters.

    • +
    • bpo-35050: socket: Fix off-by-one bug in length check for +AF_ALG name and type.

    • +
    • bpo-34974: bytes and bytearray constructors no longer +convert unexpected exceptions (e.g. MemoryError and +KeyboardInterrupt) to TypeError.

    • +
    • bpo-34973: Fixed crash in bytes() when the list argument is +mutated while it is iterated.

    • +
    • bpo-34824: Fix a possible null pointer dereference in Modules/_ssl.c. +Patch by Zackery Spytz.

    • +
    • bpo-1621: Do not assume signed integer overflow behavior (C undefined +behavior) when performing set hash table resizing.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-35052: Fix xml.dom.minidom cloneNode() on a document with an entity: +pass the correct arguments to the user data handler of an entity.

    • +
    • bpo-35330: When a Mock instance was used to wrap an object, if +side_effect is used in one of the mocks of it methods, don’t call the +original implementation and return the result of using the side effect the +same way that it is done with return_value.

    • +
    • bpo-34172: Revert the fix for this issue previously released in 3.7.1 +pending further investigation: Fix a reference issue inside +multiprocessing.Pool that caused the pool to remain alive if it was +deleted without being closed or terminated explicitly.

    • +
    • bpo-10496: posixpath.expanduser() now returns the input path +unchanged if the HOME environment variable is not set and the current +user has no home directory (if the current user identifier doesn’t exist +in the password database). This change fix the site module if the +current user doesn’t exist in the password database (if the user has no +home directory).

    • +
    • bpo-35310: Fix a bug in select.select() where, in some cases, the +file descriptor sequences were returned unmodified after a signal +interruption, even though the file descriptors might not be ready yet. +select.select() will now always return empty lists if a timeout has +occurred. Patch by Oran Avraham.

    • +
    • bpo-35380: Enable TCP_NODELAY on Windows for proactor asyncio event loop.

    • +
    • bpo-35341: Add generic version of collections.OrderedDict to the +typing module. Patch by Ismo Toijala.

    • +
    • bpo-35371: Fixed possible crash in os.utime() on Windows when pass +incorrect arguments.

    • +
    • bpo-27903: Fix ResourceWarning in platform.dist() on SuSE and +Caldera OpenLinux. Patch by Ville Skyttä.

    • +
    • bpo-35308: Fix regression in webbrowser where default browsers may be +preferred over browsers in the BROWSER environment variable.

    • +
    • bpo-28604: locale.localeconv() now sets temporarily the LC_CTYPE +locale to the LC_MONETARY locale if the two locales are different and +monetary strings are non-ASCII. This temporary change affects other +threads.

    • +
    • bpo-35277: Update ensurepip to install pip 18.1 and setuptools 40.6.2.

    • +
    • bpo-35226: Recursively check arguments when testing for equality of +unittest.mock.call objects and add note that tracking of +parameters used to create ancestors of mocks in mock_calls is not +possible.

    • +
    • bpo-29564: The warnings module now suggests to enable tracemalloc if the +source is specified, the tracemalloc module is available, but tracemalloc +is not tracing memory allocations.

    • +
    • bpo-35189: Modify the following fnctl function to retry if interrupted by +a signal (EINTR): flock, lockf, fnctl

    • +
    • bpo-35062: Fix incorrect parsing of +_io.IncrementalNewlineDecoder’s translate argument.

    • +
    • bpo-35079: Improve difflib.SequenceManager.get_matching_blocks doc by +adding ‘non-overlapping’ and changing ‘!=’ to ‘<’.

    • +
    • bpo-35017: socketserver.BaseServer.serve_forever() now exits +immediately if it’s shutdown() method is +called while it is polling for new events.

    • +
    • bpo-31047: Fix ntpath.abspath regression where it didn’t remove a +trailing separator on Windows. Patch by Tim Graham.

    • +
    • bpo-34794: Fixed a leak in Tkinter when pass the Python wrapper around +Tcl_Obj back to Tcl/Tk.

    • +
    • bpo-35008: Fixed references leaks when call the __setstate__() method +of xml.etree.ElementTree.Element in the C implementation for +already initialized element.

    • +
    • bpo-23420: Verify the value for the parameter ‘-s’ of the cProfile CLI. +Patch by Robert Kuska

    • +
    • bpo-33947: dataclasses now handle recursive reprs without raising +RecursionError.

    • +
    • bpo-16965: The 2to3 execfile fixer now opens the file +with mode 'rb'. Patch by Zackery Spytz.

    • +
    • bpo-34966: pydoc now supports aliases not only to methods defined +in the end class, but also to inherited methods. The docstring is not +duplicated for aliases.

    • +
    • bpo-34941: Methods find(), findtext() and findall() of the +Element class in the xml.etree.ElementTree module are now able +to find children which are instances of Element subclasses.

    • +
    • bpo-34936: Fix TclError in tkinter.Spinbox.selection_element(). +Patch by Juliette Monsel.

    • +
    • bpo-34866: Adding max_num_fields to cgi.FieldStorage to make DOS +attacks harder by limiting the number of MiniFieldStorage objects +created by FieldStorage.

    • +
    • bpo-34022: The SOURCE_DATE_EPOCH environment variable no longer +overrides the value of the invalidation_mode argument to +py_compile.compile(), and determines its default value instead.

    • +
    • bpo-34738: ZIP files created by distutils will now include entries +for directories.

    • +
    • bpo-31177: Fix bug that prevented using reset_mock on mock instances with deleted attributes

    • +
    • bpo-34536: Enum._missing_: raise ValueError if None returned and +TypeError if non-member is returned.

    • +
    • bpo-34604: Fix possible mojibake in the error message of pwd.getpwnam +and grp.getgrnam using string representation because of invisible +characters or trailing whitespaces. Patch by William Grzybowski.

    • +
    • bpo-34574: OrderedDict iterators are not exhausted during pickling +anymore. Patch by Sergey Fedoseev.

    • +
    • bpo-34052: sqlite3.Connection.create_aggregate(), +sqlite3.Connection.create_function(), +sqlite3.Connection.set_authorizer(), +sqlite3.Connection.set_progress_handler() methods raises TypeError +when unhashable objects are passed as callable. These methods now don’t +pass such objects to SQLite API. Previous behavior could lead to +segfaults. Patch by Sergey Fedoseev.

    • +
    • bpo-29877: compileall: import ProcessPoolExecutor only when needed, +preventing hangs on low resource platforms

    • +
    • bpo-22005: Implemented unpickling instances of +datetime, date and +time pickled by Python 2. encoding='latin1' should +be used for successful decoding.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-35089: Remove mention of typing.io and typing.re. Their types +should be imported from typing directly.

    • +
    • bpo-35038: Fix the documentation about an unexisting f_restricted +attribute in the frame object. Patch by Stéphane Wirtel

    • +
    • bpo-35044: Fix the documentation with the role exc for the +appropriated exception. Patch by Stéphane Wirtel

    • +
    • bpo-35035: Rename documentation for email.utils to +email.utils.rst.

    • +
    • bpo-34967: Use app.add_object_type() instead of the deprecated Sphinx +function app.description_unit()

    • +
    • bpo-11233: Create availability directive for documentation. Original +patch by Georg Brandl.

    • +
    • bpo-33594: Document getargspec, from_function and from_builtin +as deprecated in their respective docstring, and include version since +deprecation in DeprecationWarning message.

    • +
    • bpo-32613: Update the faq/windows.html to use the py command from PEP 397 +instead of python.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-33725: test_multiprocessing_fork may crash on recent versions of +macOS. Until the issue is resolved, skip the test on macOS.

    • +
    • bpo-35352: Modify test_asyncio to use the certificate set from the test +directory.

    • +
    • bpo-35317: Fix mktime() overflow error in test_email: run +test_localtime_daylight_true_dst_true() and +test_localtime_daylight_false_dst_true() with a specific timezone.

    • +
    • bpo-21263: After several reports that test_gdb does not work properly on +macOS and since gdb is not shipped by default anymore, test_gdb is now +skipped on macOS when LLVM Clang has been used to compile Python. Patch by +Lysandros Nikolaou

    • +
    • bpo-34279: regrtest issue a warning when no tests have been executed in a +particular test file. Also, a new final result state is issued if no test +have been executed across all test files. Patch by Pablo Galindo.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-35296: The Windows installer (MSI) now also install internal header +files (Include/internal/ subdirectory).

    • +
    • bpo-35351: When building Python with clang and LTO, LTO flags are no +longer passed into CFLAGS to build third-party C extensions through +distutils.

    • +
    • bpo-35139: Fix a compiler error when statically linking pyexpat in +Modules/Setup.

    • +
    • bpo-35011: Restores the use of pyexpatns.h to isolate our embedded copy of +the expat C library so that its symbols do not conflict at link or dynamic +loading time with an embedding application or other extension modules with +their own version of libexpat.

    • +
    • bpo-28015: Have –with-lto works correctly with clang.

    • +
    • bpo-33015: Fix an undefined behaviour in the pthread implementation of +PyThread_start_new_thread(): add a function wrapper to always +return NULL.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-35401: Updates Windows build to OpenSSL 1.1.0j

    • +
    • bpo-34977: venv on Windows will now use a python.exe redirector rather +than copying the actual binaries from the base environment.

    • +
    • bpo-34977: Adds support for building a Windows App Store package

    • +
    • bpo-35067: Remove _distutils_findvs module and use vswhere.exe instead.

    • +
    • bpo-34532: Fixes exit code of list version arguments for py.exe.

    • +
    • bpo-32890: Fix usage of GetLastError() instead of errno in os.execve() and +os.truncate().

    • +
    +
    +
    +

    macOS

    +
      +
    • bpo-35402: Update macOS installer to use Tcl/Tk 8.6.9.1. [NOTE: This +change was reverted for the released python.org 3.7.2 macOS installers due +to regressions found in Tk 8.6.9.1. For now, the installers provide +Tcl/Tk 8.6.8.]

    • +
    • bpo-35401: Update macOS installer to use OpenSSL 1.1.0j.

    • +
    • bpo-35025: Properly guard the use of the CLOCK_GETTIME et al. macros +in timemodule on macOS.

    • +
    • bpo-24658: On macOS, fix reading from and writing into a file with a size +larger than 2 GiB.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-35213: Where appropriate, use ‘macOS’ in idlelib.

    • +
    • bpo-34864: On macOS, warn if the system preference “Prefer tabs when +opening documents” is set to “Always”.

    • +
    • bpo-34864: Document two IDLE on MacOS issues. The System Preferences Dock +“prefer tabs always” setting disables some IDLE features. Menus are a bit +different than as described for Windows and Linux.

    • +
    • bpo-35202: Remove unused imports from lib/idlelib

    • +
    • bpo-33000: Document that IDLE’s shell has no line limit. A program that +runs indefinitely can overfill memory.

    • +
    • bpo-23220: Explain how IDLE’s Shell displays output.

    • +
    • bpo-35099: Improve the doc about IDLE running user code. The section is +renamed from “IDLE – console differences” is renamed “Running user code”. +It mostly covers the implications of using custom sys.stdxxx objects.

    • +
    • bpo-35097: Add IDLE doc subsection explaining editor windows. Topics +include opening, title and status bar, .py* extension, and running.

    • +
    • bpo-35093: Document the IDLE document viewer in the IDLE doc. Add a +paragraph in “Help and preferences”, “Help sources” subsection.

    • +
    • bpo-35088: Update idlelib.help.copy_string docstring. We now use git and +backporting instead of hg and forward merging.

    • +
    • bpo-35087: Update idlelib help files for the current doc build. The main +change is the elimination of chapter-section numbers.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-34989: python-gdb.py now handles errors on computing the line number +of a Python frame.

    • +
    +
    +
    +

    C API

    + +
    +
    +
    +

    Python 3.7.1 final

    +

    Release date: 2018-10-20

    +
    +

    Library

    +
      +
    • bpo-34970: Protect tasks weak set manipulation in asyncio.all_tasks()

    • +
    +
    +
    +
    +

    Python 3.7.1 release candidate 2

    +

    Release date: 2018-10-13

    +
    +

    Core and Builtins

    +
      +
    • bpo-34879: Fix a possible null pointer dereference in bytesobject.c. +Patch by Zackery Spytz.

    • +
    • bpo-34854: Fixed a crash in compiling string annotations containing a +lambda with a keyword-only argument that doesn’t have a default value.

    • +
    • bpo-34320: Fix dict(od) didn’t copy iteration order of OrderedDict.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-34769: Fix for async generators not finalizing when event loop is in +debug mode and garbage collector runs in another thread.

    • +
    • bpo-34922: Fixed integer overflow in the digest() +and hexdigest() methods for the SHAKE algorithm in +the hashlib module.

    • +
    • bpo-34909: Enum: fix grandchildren subclassing when parent mixed with +concrete data types.

    • +
    • bpo-34900: Fixed unittest.TestCase.debug() when used to call test +methods with subtests. Patch by Bruno Oliveira.

    • +
    • bpo-34871: Fix inspect module polluted sys.modules when parsing +__text_signature__ of callable.

    • +
    • bpo-34872: Fix self-cancellation in C implementation of asyncio.Task

    • +
    • bpo-34819: Use a monotonic clock to compute timeouts in +Executor.map() and as_completed(), in order to prevent +timeouts from deviating when the system clock is adjusted.

    • +
    • bpo-34521: Use socket.CMSG_SPACE() to calculate ancillary data size +instead of socket.CMSG_LEN() in +multiprocessing.reduction.recvfds() as RFC 3542 requires the use +of the former for portable applications.

    • +
    • bpo-34334: In QueueHandler, clear exc_text from +LogRecord to prevent traceback from being written twice.

    • +
    • bpo-6721: Acquire the logging module’s commonly used internal locks while +fork()ing to avoid deadlocks in the child process.

    • +
    • bpo-34172: Fix a reference issue inside multiprocessing.Pool that caused +the pool to remain alive if it was deleted without being closed or +terminated explicitly.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-32174: chm document displays non-ASCII charaters properly on some MBCS +Windows systems.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-32962: Fixed test_gdb when Python is compiled with flags -mcet +-fcf-protection -O0.

    • +
    +
    +
    +

    macOS

    +
      +
    • bpo-34370: Revert to using the released Tk 8.6.8 with macOS installers +instead of the Tk 8.6.x development snapshot used with 3.7.1rc1 and +3.6.7rc1. The snapshot introduced at least one significant regression +(bpo-34927).

    • +
    +
    +
    +

    C API

    + +
    +
    +
    +

    Python 3.7.1 release candidate 1

    +

    Release date: 2018-09-26

    +
    +

    Security

    +
      +
    • bpo-17239: The xml.sax and xml.dom.minidom parsers no longer processes +external entities by default. External DTD and ENTITY declarations no +longer load files or create network connections.

    • +
    • bpo-34623: CVE-2018-14647: The C accelerated _elementtree module now +initializes hash randomization salt from _Py_HashSecret instead of +libexpat’s default CSPRNG.

    • +
    • bpo-34405: Updated to OpenSSL 1.1.0i for Windows builds.

    • +
    • bpo-33871: Fixed sending the part of the file in os.sendfile() on +macOS. Using the trailers argument could cause sending more bytes from +the input file than was specified.

    • +
    • bpo-32533: Fixed thread-safety of error handling in _ssl.

    • +
    +
    +
    +

    Core and Builtins

    +
      +
    • bpo-34783: Fix a crash with musl libc (on Alpine Linux) when the script +filename specified on the command line doesn’t exist.

    • +
    • bpo-34762: Fix contextvars C API to use PyObject* pointer types.

    • +
    • bpo-34735: Fix a memory leak in Modules/timemodule.c. Patch by Zackery +Spytz.

    • +
    • bpo-34588: Fix an off-by-one in the recursive call pruning feature of +traceback formatting.

    • +
    • bpo-34485: Standard streams like sys.stdout now use the “surrogateescape” +error handler, instead of “strict”, on the POSIX locale (when the C locale +is not coerced and the UTF-8 Mode is disabled).

    • +
    • bpo-34485: Fix the error handler of standard streams like sys.stdout: +PYTHONIOENCODING=”:” is now ignored instead of setting the error handler +to “strict”.

    • +
    • bpo-34527: On FreeBSD, Py_DecodeLocale() and Py_EncodeLocale() now also +forces the ASCII encoding if the LC_CTYPE locale is “POSIX”, not only if +the LC_CTYPE locale is “C”.

    • +
    • bpo-34527: The UTF-8 Mode is now also enabled by the “POSIX” locale, not +only by the “C” locale.

    • +
    • bpo-34400: Fix undefined behavior in parsetok.c. Patch by Zackery Spytz.

    • +
    • bpo-34377: Update valgrind suppression list to use +_PyObject_Free/_PyObject_Realloc instead of +PyObject_Free/PyObject_Realloc.

    • +
    • bpo-34170: -X dev: it is now possible to override the memory allocator +using PYTHONMALLOC even if the developer mode is enabled.

    • +
    • bpo-34126: Fix crashes when profiling certain invalid calls of unbound +methods. Patch by Jeroen Demeyer.

    • +
    • bpo-24618: Fixed reading invalid memory when create the code object with +too small varnames tuple or too large argument counts.

    • +
    • bpo-34068: In io.IOBase.close(), ensure that the +closed attribute is not set with a live exception. +Patch by Zackery Spytz and Serhiy Storchaka.

    • +
    • bpo-34087: Fix buffer overflow while converting unicode to numeric values.

    • +
    • bpo-34080: Fixed a memory leak in the compiler when it raised some +uncommon errors during tokenizing.

    • +
    • bpo-34066: Disabled interruption by Ctrl-C between calling open() and +entering a with block in with open().

    • +
    • bpo-34042: Fix dict.copy() to maintain correct total refcount (as reported +by sys.gettotalrefcount()).

    • +
    • bpo-33985: Implement contextvars.ContextVar.name attribute.

    • +
    • bpo-33956: Update vendored Expat library copy to version 2.2.5.

    • +
    • bpo-24596: Decref the module object in PyRun_SimpleFileExFlags() +before calling PyErr_Print(). Patch by Zackery Spytz.

    • +
    • bpo-33451: Close directly executed pyc files before calling +PyEval_EvalCode().

    • +
    • bpo-33824: Fix “LC_ALL=C python3.7 -V”: reset properly the command line +parser when the encoding changes after reading the Python configuration.

    • +
    • bpo-25750: Fix rare Python crash due to bad refcounting in +type_getattro() if a descriptor deletes itself from the class. Patch +by Jeroen Demeyer.

    • +
    • bpo-31902: Fix the col_offset attribute for ast nodes +ast.AsyncFor, ast.AsyncFunctionDef, and ast.AsyncWith. +Previously, col_offset pointed to the keyword after async.

    • +
    • bpo-25862: Fix assertion failures in the tell() method of +io.TextIOWrapper. Patch by Zackery Spytz.

    • +
    • bpo-31577: Fix a crash in os.utime() in case of a bad ns argument. Patch +by Oren Milman.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-29577: Support multiple mixin classes when creating Enums.

    • +
    • bpo-34670: Add SSLContext.post_handshake_auth and +SSLSocket.verify_client_post_handshake for TLS 1.3’s post handshake +authentication feature.

    • +
    • bpo-34658: Fix a rare interpreter unhandled exception state SystemError +only seen when using subprocess with a preexec_fn while an after_parent +handler has been registered with os.register_at_fork and the fork system +call fails.

    • +
    • bpo-34652: Ensure os.lchmod() is never defined on Linux.

    • +
    • bpo-34363: dataclasses.asdict() and .astuple() now handle namedtuples +correctly.

    • +
    • bpo-34625: Update vendorized expat library version to 2.2.6.

    • +
    • bpo-34621: Fix un/pickling compatbility of uuid.UUID objects with older +versions of Python (<3.7).

    • +
    • bpo-32270: The subprocess module no longer mistakenly closes redirected +fds even when they were in pass_fds when outside of the default {0, 1, 2} +set.

    • +
    • bpo-34610: Fixed iterator of multiprocessing.managers.DictProxy.

    • +
    • bpo-34421: Fix distutils logging for non-ASCII strings. This caused +installation issues on Windows.

    • +
    • bpo-34604: Fix possible mojibake in the error message of pwd.getpwnam +and grp.getgrnam. Patch by William Grzybowski.

    • +
    • bpo-34530: distutils.spawn.find_executable() now falls back on +os.defpath if the PATH environment variable is not set.

    • +
    • bpo-34282: Fix enum members getting shadowed by parent attributes.

    • +
    • bpo-34563: On Windows, fix multiprocessing.Connection for very large read: +fix _winapi.PeekNamedPipe() and _winapi.ReadFile() for read larger than +INT_MAX (usually 2^31-1).

    • +
    • bpo-34558: Correct typo in Lib/ctypes/_aix.py

    • +
    • bpo-34515: Fix parsing non-ASCII identifiers in +lib2to3.pgen2.tokenize (PEP 3131).

    • +
    • bpo-13312: Avoids a possible integer underflow (undefined behavior) in the +time module’s year handling code when passed a very low negative year +value.

    • +
    • bpo-34472: Improved compatibility for streamed files in zipfile. +Previously an optional signature was not being written and certain ZIP +applications were not supported. Patch by Silas Sewell.

    • +
    • bpo-34454: Fix the .fromisoformat() methods of datetime types crashing +when given unicode with non-UTF-8-encodable code points. Specifically, +datetime.fromisoformat() now accepts surrogate unicode code points used as +the separator. Report and tests by Alexey Izbyshev, patch by Paul Ganssle.

    • +
    • bpo-6700: Fix inspect.getsourcelines for module level frames/tracebacks. +Patch by Vladimir Matveev.

    • +
    • bpo-34171: Running the trace module no longer creates the +trace.cover file.

    • +
    • bpo-34441: Fix crash when an ABC-derived class with invalid +__subclasses__ is passed as the second argument to +issubclass(). Patch by Alexey Izbyshev.

    • +
    • bpo-34341: Appending to the ZIP archive with the ZIP64 extension no longer +grows the size of extra fields of existing entries.

    • +
    • bpo-34333: Fix %-formatting in pathlib.PurePath.with_suffix() when +formatting an error message.

    • +
    • bpo-18540: The imaplib.IMAP4 and imaplib.IMAP4_SSL +classes now resolve to the local host IP correctly when the default value +of host parameter ('') is used.

    • +
    • bpo-34246: smtplib.SMTP.send_message() no longer modifies the +content of the mail_options argument. Patch by Pablo S. Blum de Aguiar.

    • +
    • bpo-31047: Fix ntpath.abspath for invalid paths on windows. Patch by +Franz Woellert.

    • +
    • bpo-34263: asyncio’s event loop will not pass timeouts longer than one day +to epoll/select etc.

    • +
    • bpo-34035: Fix several AttributeError in zipfile seek() methods. Patch by +Mickaël Schoentgen.

    • +
    • bpo-32215: Fix performance regression in sqlite3 when a DML +statement appeared in a different line than the rest of the SQL query.

    • +
    • bpo-34251: Restore msilib.Win64 to preserve backwards compatibility +since it’s already used by distutilsbdist_msi command.

    • +
    • bpo-19891: Ignore errors caused by missing / non-writable homedir while +writing history during exit of an interactive session. Patch by Anthony +Sottile.

    • +
    • bpo-34213: Allow frozen dataclasses to have a field named “object”. +Previously this conflicted with an internal use of “object”.

    • +
    • bpo-21446: The reload fixer now uses importlib.reload() +instead of deprecated imp.reload().

    • +
    • bpo-940286: pydoc’s Helper.showtopic() method now prints the cross +references of a topic correctly.

    • +
    • bpo-34164: base64.b32decode() could raise UnboundLocalError or +OverflowError for incorrect padding. Now it always raises +base64.Error in these cases.

    • +
    • bpo-33729: Fixed issues with arguments parsing in hashlib.

    • +
    • bpo-34108: Remove extraneous CR in 2to3 refactor.

    • +
    • bpo-27494: Reverted bpo-27494. 2to3 rejects now a trailing comma in +generator expressions.

    • +
    • bpo-33967: functools.singledispatch now raises TypeError instead of +IndexError when no positional arguments are passed.

    • +
    • bpo-34056: Ensure the loader shim created by imp.load_module always +returns bytes from its get_data() function. This fixes using +imp.load_module with PEP 552 hash-based pycs.

    • +
    • bpo-34054: The multiprocessing module now uses the monotonic clock +time.monotonic() instead of the system clock time.time() to +implement timeout.

    • +
    • bpo-34044: subprocess.Popen now copies the startupinfo argument to +leave it unchanged: it will modify the copy, so that the same +STARTUPINFO object can be used multiple times.

    • +
    • bpo-34010: Fixed a performance regression for reading streams with +tarfile. The buffered read should use a list, instead of appending to a +bytes object.

    • +
    • bpo-34019: webbrowser: Correct the arguments passed to Opera Browser when +opening a new URL using the webbrowser module. Patch by Bumsik Kim.

    • +
    • bpo-33978: Closed existing logging handlers before reconfiguration via +fileConfig and dictConfig. Patch by Karthikeyan Singaravelan.

    • +
    • bpo-14117: Make minor tweaks to turtledemo. The ‘wikipedia’ example is now +‘rosette’, decribing what it draws. The ‘penrose’ print output is +reduced. The‘1024’ output of ‘tree’ is eliminated.

    • +
    • bpo-33974: Fixed passing lists and tuples of strings containing special +characters ", \, {, } and \n as options to +ttk widgets.

    • +
    • bpo-27500: Fix getaddrinfo to resolve IPv6 addresses correctly.

    • +
    • bpo-24567: Improve random.choices() to handle subnormal input weights that +could occasionally trigger an IndexError.

    • +
    • bpo-33871: Fixed integer overflow in os.readv(), os.writev(), +os.preadv() and os.pwritev() and in os.sendfile() with +headers or trailers arguments (on BSD-based OSes and macOS).

    • +
    • bpo-33899: Tokenize module now implicitly emits a NEWLINE when provided +with input that does not have a trailing new line. This behavior now +matches what the C tokenizer does internally. Contributed by Ammar Askar.

    • +
    • bpo-33916: bz2 and lzma: When Decompressor.__init__() is called twice, +free the old lock to not leak memory.

    • +
    • bpo-32568: Make select.epoll() and its documentation consistent regarding +sizehint and flags.

    • +
    • bpo-33833: Fixed bug in asyncio where ProactorSocketTransport logs +AssertionError if force closed during write.

    • +
    • bpo-33663: Convert content length to string before putting to header.

    • +
    • bpo-26544: Fixed implementation of platform.libc_ver(). It almost +always returned version ‘2.9’ for glibc.

    • +
    • bpo-33805: Improve error message of dataclasses.replace() when an InitVar +is not specified

    • +
    • bpo-27397: Make email module properly handle invalid-length base64 +strings.

    • +
    • bpo-33476: Fix _header_value_parser.py when address group is missing final +‘;’. Contributed by Enrique Perez-Terron

    • +
    • bpo-31014: Fixed creating a controller for webbrowser when a user +specifies a path to an entry in the BROWSER environment variable. Based +on patch by John Still.

    • +
    • bpo-33365: Print the header values besides the header keys instead just +the header keys if debuglevel is set to >0 in http.client. Patch +by Marco Strigl.

    • +
    • bpo-32933: unittest.mock.mock_open() now supports iteration over the +file contents. Patch by Tony Flury.

    • +
    • bpo-33336: imaplib now allows MOVE command in IMAP4.uid() (RFC +6851: IMAP MOVE Extension) and potentially as a name of supported method +of IMAP4 object.

    • +
    • bpo-31608: Raise a TypeError instead of crashing if a +collections.deque subclass returns a non-deque from __new__. Patch +by Oren Milman.

    • +
    • bpo-29456: Fix bugs in hangul normalization: u1176, u11a7 and u11c3

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-34790: Document how passing coroutines to asyncio.wait() can be +confusing.

    • +
    • bpo-28617: Fixed info in the stdtypes docs concerning the types that +support membership tests.

    • +
    • bpo-34065: Fix wrongly written basicConfig documentation markup syntax

    • +
    • bpo-33460: replaced ellipsis with correct error codes in tutorial chapter +3.

    • +
    • bpo-33847: Add ‘@’ operator entry to index.

    • +
    • bpo-25041: Document AF_PACKET in the socket module.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-34537: Fix test_gdb.test_strings() when LC_ALL=C and GDB was +compiled with Python 3.6 or earlier.

    • +
    • bpo-34587: test_socket: Remove RDSTest.testCongestion(). The test tries to +fill the receiver’s socket buffer and expects an error. But the RDS +protocol doesn’t require that. Moreover, the Linux implementation of RDS +expects that the producer of the messages reduces its rate, it’s not the +role of the receiver to trigger an error. The test fails on Fedora 28 by +design, so just remove it.

    • +
    • bpo-34661: Fix test_shutil if unzip doesn’t support -t.

    • +
    • bpo-34200: Fixed non-deterministic flakiness of test_pkg by not using the +scary test.support.module_cleanup() logic to save and restore sys.modules +contents between test cases.

    • +
    • bpo-34594: Fix usage of hardcoded errno values in the tests.

    • +
    • bpo-34542: Use 3072 RSA keys and SHA-256 signature for test certs and +keys.

    • +
    • bpo-11193: Remove special condition for AIX in +test_subprocess.test_undecodable_env

    • +
    • bpo-34490: On AIX with AF_UNIX family sockets getsockname() does not +provide ‘sockname’, so skip calls to transport.get_extra_info(‘sockname’)

    • +
    • bpo-34391: Fix ftplib test for TLS 1.3 by reading from data socket.

    • +
    • bpo-34399: Update all RSA keys and DH params to use at least 2048 bits.

    • +
    • bpo-33746: Fix test_unittest when run in verbose mode.

    • +
    • bpo-33901: Fix test_dbm_gnu on macOS with gdbm 1.15: add a larger value to +make sure that the file size changes.

    • +
    • bpo-33873: Fix a bug in regrtest that caused an extra test to run if +–huntrleaks/-R was used. Exit with error in case that invalid parameters +are specified to –huntrleaks/-R (at least one warmup run and one +repetition must be used).

    • +
    • bpo-32663: Making sure the SMTPUTF8SimTests class of tests gets run in +test_smtplib.py.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-34710: Fixed SSL module build with OpenSSL & pedantic CFLAGS.

    • +
    • bpo-34582: Add JUnit XML output for regression tests and update Azure +DevOps builds.

    • +
    • bpo-34555: Fix for case where it was not possible to have both +HAVE_LINUX_VM_SOCKETS_H and HAVE_SOCKADDR_ALG be undefined.

    • +
    • bpo-34121: Fix detection of C11 atomic support on clang.

    • +
    • bpo-30345: Add -g to LDFLAGS when compiling with LTO to get debug symbols.

    • +
    • bpo-33648: The –with-c-locale-warning configuration flag has been +removed. It has had no effect for about a year.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-34770: Fix a possible null pointer dereference in pyshellext.cpp.

    • +
    • bpo-34603: Fix returning structs from functions produced by MSVC

    • +
    • bpo-34581: Guard MSVC-specific code in socketmodule.c with #ifdef +_MSC_VER.

    • +
    • bpo-34062: Fixed the ‘–list’ and ‘–list-paths’ arguments for the py.exe +launcher

    • +
    • bpo-34225: Ensure INCLUDE and LIB directories do not end with a backslash.

    • +
    • bpo-34006: Revert line length limit for Windows help docs. The line-length +limit is not needed because the pages appear in a separate app rather than +on a browser tab. It can also interact badly with the DPI setting.

    • +
    • bpo-31546: Restore running PyOS_InputHook while waiting for user input at +the prompt. The restores integration of interactive GUI windows (such as +Matplotlib figures) with the prompt on Windows.

    • +
    • bpo-30237: Output error when ReadConsole is canceled by +CancelSynchronousIo instead of crashing.

    • +
    • bpo-29097: Fix bug where datetime.fromtimestamp() erronously throws +an OSError on Windows for values between 0 and 86400. Patch by +Ammar Askar.

    • +
    +
    +
    +

    macOS

    +
      +
    • bpo-34370: Have macOS 10.9+ installer builds for 3.7.1rc and 3.6.7rc use a +development snapshot of Tk 8.6 (post-8.6.8) to mitigate certain scroller +issues seen with IDLE and tkinter apps.

    • +
    • bpo-34405: Update to OpenSSL 1.1.0i for macOS installer builds.

    • +
    • bpo-33635: In macOS stat on some file descriptors (/dev/fd/3 f.e) will +result in bad file descriptor OSError. Guard against this exception was +added in is_dir, is_file and similar methods. DirEntry.is_dir can also +throw this exception so _RecursiveWildcardSelector._iterate_directories +was also extended with the same error ignoring pattern.

    • +
    • bpo-31903: In _scproxy, drop the GIL when calling into +SystemConfiguration to avoid deadlocks.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-34548: Use configured color theme for read-only text views.

    • +
    • bpo-1529353: Enable “squeezing” of long outputs in the shell, to avoid +performance degradation and to clean up the history without losing it. +Squeezed outputs may be copied, viewed in a separate window, and +“unsqueezed”.

    • +
    • bpo-34047: Fixed mousewheel scrolling direction on macOS.

    • +
    • bpo-34275: Make IDLE calltips always visible on Mac. Some MacOS-tk +combinations need .update_idletasks(). Patch by Kevin Walzer.

    • +
    • bpo-34120: Fix unresponsiveness after closing certain windows and dialogs.

    • +
    • bpo-33975: Avoid small type when running htests. Since part of the purpose +of human-viewed tests is to determine that widgets look right, it is +important that they look the same for testing as when running IDLE.

    • +
    • bpo-33905: Add test for idlelib.stackview.StackBrowser.

    • +
    • bpo-33924: Change mainmenu.menudefs key ‘windows’ to ‘window’. Every other +menudef key is lowercase version of main menu entry.

    • +
    • bpo-33906: Rename idlelib.windows as window Match Window on the main menu +and remove last plural module name.

    • +
    • bpo-33917: Fix and document idlelib/idle_test/template.py. The revised +file compiles, runs, and tests OK. idle_test/README.txt explains how to +use it to create new IDLE test files.

    • +
    • bpo-33904: IDLE: In rstrip, rename class RstripExtension as Rstrip

    • +
    • bpo-33907: For consistency and clarity, rename an IDLE module and classes. +Module calltips and its class CallTips are now calltip and Calltip. In +module calltip_w, class CallTip is now CalltipWindow.

    • +
    • bpo-33856: Add “help” in the welcome message of IDLE

    • +
    • bpo-33839: IDLE: refactor ToolTip and CallTip and add documentation and +tests

    • +
    • bpo-33855: Minimally test all IDLE modules. Add missing files, import +module, instantiate classes, and check coverage. Check existing files.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-32962: python-gdb now catches UnicodeDecodeError exceptions when +calling string().

    • +
    • bpo-32962: python-gdb now catches ValueError on read_var(): when Python +has no debug symbols for example.

    • +
    +
    +
    +

    C API

    + +
    +
    +
    +

    Python 3.7.0 final

    +

    Release date: 2018-06-27

    +
    +

    Library

    + +
    +
    +

    C API

    +
      +
    • bpo-33932: Calling Py_Initialize() twice does nothing, instead of failing +with a fatal error: restore the Python 3.6 behaviour.

    • +
    +
    +
    +
    +

    Python 3.7.0 release candidate 1

    +

    Release date: 2018-06-12

    +
    +

    Core and Builtins

    +
      +
    • bpo-33803: Fix a crash in hamt.c caused by enabling GC tracking for an +object that hadn’t all of its fields set to NULL.

    • +
    • bpo-33706: Fix a crash in Python initialization when parsing the command +line options. Thanks Christoph Gohlke for the bug report and the fix!

    • +
    • bpo-30654: Fixed reset of the SIGINT handler to SIG_DFL on interpreter +shutdown even when there was a custom handler set previously. Patch by +Philipp Kerling.

    • +
    • bpo-31849: Fix signed/unsigned comparison warning in pyhash.c.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-30167: Prevent site.main() exception if PYTHONSTARTUP is set. Patch by +Steve Weber.

    • +
    • bpo-33812: Datetime instance d with non-None tzinfo, but with +d.tzinfo.utcoffset(d) returning None is now treated as naive by the +astimezone() method.

    • +
    • bpo-30805: Avoid race condition with debug logging

    • +
    • bpo-33694: asyncio: Fix a race condition causing data loss on +pause_reading()/resume_reading() when using the ProactorEventLoop.

    • +
    • bpo-32493: Correct test for uuid_enc_be availability in +configure.ac. Patch by Michael Felt.

    • +
    • bpo-33792: Add asyncio.WindowsSelectorEventLoopPolicy and +asyncio.WindowsProactorEventLoopPolicy.

    • +
    • bpo-33778: Update unicodedata’s database to Unicode version 11.0.0.

    • +
    • bpo-33770: improve base64 exception message for encoded inputs of invalid +length

    • +
    • bpo-33769: asyncio/start_tls: Fix error message; cancel callbacks in case +of an unhandled error; mark SSLTransport as closed if it is aborted.

    • +
    • bpo-33767: The concatenation (+) and repetition (*) sequence +operations now raise TypeError instead of SystemError when +performed on mmap.mmap objects. Patch by Zackery Spytz.

    • +
    • bpo-33734: asyncio/ssl: Fix AttributeError, increase default handshake +timeout

    • +
    • bpo-11874: Use a better regex when breaking usage into wrappable parts. +Avoids bogus assertion errors from custom metavar strings.

    • +
    • bpo-33582: Emit a deprecation warning for inspect.formatargspec

    • +
    +
    +
    +

    Documentation

    + +
    +
    +

    Build

    +
      +
    • bpo-5755: Move -Wstrict-prototypes option to CFLAGS_NODIST from +OPT. This option emitted annoying warnings when building extension +modules written in C++.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-33720: Reduces maximum marshal recursion depth on release builds.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-33656: On Windows, add API call saying that tk scales for DPI. On +Windows 8.1+ or 10, with DPI compatibility properties of the Python binary +unchanged, and a monitor resolution greater than 96 DPI, this should make +text and lines sharper. It should otherwise have no effect.

    • +
    • bpo-33768: Clicking on a context line moves that line to the top of the +editor window.

    • +
    • bpo-33763: IDLE: Use read-only text widget for code context instead of +label widget.

    • +
    • bpo-33664: Scroll IDLE editor text by lines. Previously, the mouse wheel +and scrollbar slider moved text by a fixed number of pixels, resulting in +partial lines at the top of the editor box. The change also applies to +the shell and grep output windows, but not to read-only text views.

    • +
    • bpo-33679: Enable theme-specific color configuration for Code Context. Use +the Highlights tab to see the setting for built-in themes or add settings +to custom themes.

    • +
    • bpo-33642: Display up to maxlines non-blank lines for Code Context. If +there is no current context, show a single blank line.

    • +
    +
    +
    +
    +

    Python 3.7.0 beta 5

    +

    Release date: 2018-05-30

    +
    +

    Core and Builtins

    +
      +
    • bpo-33622: Fixed a leak when the garbage collector fails to add an object +with the __del__ method or referenced by it into the +gc.garbage list. PyGC_Collect() can now be called when an +exception is set and preserves it.

    • +
    • bpo-33509: Fix module_globals parameter of warnings.warn_explicit(): don’t +crash if module_globals is not a dict.

    • +
    • bpo-20104: The new os.posix_spawn added in 3.7.0b1 was removed as we are +still working on what the API should look like. Expect this in 3.8 +instead.

    • +
    • bpo-33475: Fixed miscellaneous bugs in converting annotations to strings +and optimized parentheses in the string representation.

    • +
    • bpo-33391: Fix a leak in set_symmetric_difference().

    • +
    • bpo-28055: Fix unaligned accesses in siphash24(). Patch by Rolf Eike Beer.

    • +
    • bpo-32911: Due to unexpected compatibility issues discovered during +downstream beta testing, reverted bpo-29463. docstring field is +removed from Module, ClassDef, FunctionDef, and AsyncFunctionDef ast nodes +which was added in 3.7a1. Docstring expression is restored as a first +statement in their body. Based on patch by Inada Naoki.

    • +
    • bpo-21983: Fix a crash in ctypes.cast() in case the type argument is a +ctypes structured data type. Patch by Eryk Sun and Oren Milman.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-32751: When cancelling the task due to a timeout, +asyncio.wait_for() will now wait until the cancellation is complete.

    • +
    • bpo-32684: Fix gather to propagate cancellation of itself even with +return_exceptions.

    • +
    • bpo-33654: Support protocol type switching in SSLTransport.set_protocol().

    • +
    • bpo-33674: Pause the transport as early as possible to further reduce the +risk of data_received() being called before connection_made().

    • +
    • bpo-33674: Fix a race condition in SSLProtocol.connection_made() of +asyncio.sslproto: start immediately the handshake instead of using +call_soon(). Previously, data_received() could be called before the +handshake started, causing the handshake to hang or fail.

    • +
    • bpo-31647: Fixed bug where calling write_eof() on a +_SelectorSocketTransport after it’s already closed raises AttributeError.

    • +
    • bpo-32610: Make asyncio.all_tasks() return only pending tasks.

    • +
    • bpo-32410: Avoid blocking on file IO in sendfile fallback code

    • +
    • bpo-33469: Fix RuntimeError after closing loop that used run_in_executor

    • +
    • bpo-33672: Fix Task.__repr__ crash with Cython’s bogus coroutines

    • +
    • bpo-33654: Fix transport.set_protocol() to support switching between +asyncio.Protocol and asyncio.BufferedProtocol. Fix loop.start_tls() to +work with asyncio.BufferedProtocols.

    • +
    • bpo-33652: Pickles of type variables and subscripted generics are now +future-proof and compatible with older Python versions.

    • +
    • bpo-32493: Fixed uuid.uuid1() on FreeBSD.

    • +
    • bpo-33618: Finalize and document preliminary and experimental TLS 1.3 +support with OpenSSL 1.1.1

    • +
    • bpo-33623: Fix possible SIGSGV when asyncio.Future is created in __del__

    • +
    • bpo-30877: Fixed a bug in the Python implementation of the JSON decoder +that prevented the cache of parsed strings from clearing after finishing +the decoding. Based on patch by c-fos.

    • +
    • bpo-33570: Change TLS 1.3 cipher suite settings for compatibility with +OpenSSL 1.1.1-pre6 and newer. OpenSSL 1.1.1 will have TLS 1.3 ciphers +enabled by default.

    • +
    • bpo-28556: Do not simplify arguments to typing.Union. Now +Union[Manager, Employee] is not simplified to Employee at runtime. +Such simplification previously caused several bugs and limited +possibilities for introspection.

    • +
    • bpo-33540: Add a new block_on_close class attribute to +ForkingMixIn and ThreadingMixIn classes of socketserver.

    • +
    • bpo-33548: tempfile._candidate_tempdir_list should consider common TEMP +locations

    • +
    • bpo-33109: argparse subparsers are once again not required by default, +reverting the change in behavior introduced by bpo-26510 in 3.7.0a2.

    • +
    • bpo-33536: dataclasses.make_dataclass now checks for invalid field names +and duplicate fields. Also, added a check for invalid field +specifications.

    • +
    • bpo-33542: Prevent uuid.get_node from using a DUID instead of a MAC on +Windows. Patch by Zvi Effron

    • +
    • bpo-26819: Fix race condition with ReadTransport.resume_reading in +Windows proactor event loop.

    • +
    • Fix failure in typing.get_type_hints() when ClassVar was provided as a +string forward reference.

    • +
    • bpo-33505: Optimize asyncio.ensure_future() by reordering if checks: 1.17x +faster.

    • +
    • bpo-33497: Add errors param to cgi.parse_multipart and make an encoding in +FieldStorage use the given errors (needed for Twisted). Patch by Amber +Brown.

    • +
    • bpo-33495: Change dataclasses.Fields repr to use the repr of each of its +members, instead of str. This makes it more clear what each field +actually represents. This is especially true for the ‘type’ member.

    • +
    • bpo-33453: Fix dataclasses to work if using literal string type +annotations or if using PEP 563 “Postponed Evaluation of Annotations”. +Only specific string prefixes are detected for both ClassVar (“ClassVar” +and “typing.ClassVar”) and InitVar (“InitVar” and “dataclasses.InitVar”).

    • +
    • bpo-28556: Minor fixes in typing module: add annotations to +NamedTuple.__new__, pass *args and **kwds in +Generic.__new__. Original PRs by Paulius Šarka and Chad Dombrova.

    • +
    • bpo-20087: Updated alias mapping with glibc 2.27 supported locales.

    • +
    • bpo-33422: Fix trailing quotation marks getting deleted when looking up +byte/string literals on pydoc. Patch by Andrés Delfino.

    • +
    • bpo-28167: The function platform.linux_distribution and +platform.dist now trigger a DeprecationWarning and have been +marked for removal in Python 3.8

    • +
    • bpo-33197: Update error message when constructing invalid +inspect.Parameters Patch by Dong-hee Na.

    • +
    • bpo-33263: Fix FD leak in _SelectorSocketTransport Patch by Vlad +Starostin.

    • +
    • bpo-32861: The urllib.robotparser’s __str__ representation now +includes wildcard entries and the “Crawl-delay” and “Request-rate” fields. +Patch by Michael Lazar.

    • +
    • bpo-32257: The ssl module now contains OP_NO_RENEGOTIATION constant, +available with OpenSSL 1.1.0h or 1.1.1.

    • +
    • bpo-16865: Support arrays >=2GiB in ctypes. Patch by Segev Finer.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-23859: Document that asyncio.wait() does not cancel its futures on +timeout.

    • +
    • bpo-32436: Document PEP 567 changes to asyncio.

    • +
    • bpo-33604: Update HMAC md5 default to a DeprecationWarning, bump removal +to 3.8.

    • +
    • bpo-33503: Fix broken pypi link

    • +
    • bpo-33421: Add missing documentation for typing.AsyncContextManager.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-33655: Ignore test_posix_fallocate failures on BSD platforms that +might be due to running on ZFS.

    • +
    • bpo-32604: Remove the _xxsubinterpreters module (meant for testing) and +associated helpers. This module was originally added recently in 3.7b1.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-33614: Ensures module definition files for the stable ABI on Windows +are correctly regenerated.

    • +
    • bpo-33522: Enable CI builds on Visual Studio Team Services at +https://python.visualstudio.com/cpython

    • +
    • bpo-33012: Add -Wno-cast-function-type for gcc 8 for silencing +warnings about function casts like casting to PyCFunction in method +definition lists.

    • +
    +
    +
    +

    macOS

    +
      +
    • bpo-13631: The .editrc file in user’s home directory is now processed +correctly during the readline initialization through editline emulation on +macOS.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-33628: IDLE: Cleanup codecontext.py and its test.

    • +
    • bpo-33564: IDLE’s code context now recognizes async as a block opener.

    • +
    • bpo-32831: Add docstrings and tests for codecontext.

    • +
    +
    +
    +
    +

    Python 3.7.0 beta 4

    +

    Release date: 2018-05-02

    +
    +

    Core and Builtins

    +
      +
    • bpo-33363: Raise a SyntaxError for async with and async for +statements outside of async functions.

    • +
    • bpo-33128: Fix a bug that causes PathFinder to appear twice on +sys.meta_path. Patch by Pablo Galindo Salgado.

    • +
    • bpo-33312: Fixed clang ubsan (undefined behavior sanitizer) warnings in +dictobject.c by adjusting how the internal struct _dictkeysobject shared +keys structure is declared.

    • +
    • bpo-33231: Fix potential memory leak in normalizestring().

    • +
    • bpo-33205: Change dict growth function from +round_up_to_power_2(used*2+hashtable_size/2) to +round_up_to_power_2(used*3). Previously, dict is shrinked only when +used == 0. Now dict has more chance to be shrinked.

    • +
    • bpo-29922: Improved error messages in ‘async with’ when __aenter__() +or __aexit__() return non-awaitable object.

    • +
    • bpo-33199: Fix ma_version_tag in dict implementation is uninitialized +when copying from key-sharing dict.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-33281: Fix ctypes.util.find_library regression on macOS.

    • +
    • bpo-33383: Fixed crash in the get() method of the dbm.ndbm database +object when it is called with a single argument.

    • +
    • bpo-33329: Fix multiprocessing regression on newer glibcs

    • +
    • bpo-991266: Fix quoting of the Comment attribute of +http.cookies.SimpleCookie.

    • +
    • bpo-33131: Upgrade bundled version of pip to 10.0.1.

    • +
    • bpo-33308: Fixed a crash in the parser module when converting an ST +object to a tree of tuples or lists with line_info=False and +col_info=True.

    • +
    • bpo-33266: lib2to3 now recognizes rf'...' strings.

    • +
    • bpo-11594: Ensure line-endings are respected when using lib2to3.

    • +
    • bpo-33254: Have importlib.resources.contents() and +importlib.abc.ResourceReader.contents() return an iterable +instead of an iterator.

    • +
    • bpo-33256: Fix display of <module> call in the html produced by +cgitb.html(). Patch by Stéphane Blondon.

    • +
    • bpo-33185: Fixed regression when running pydoc with the -m +switch. (The regression was introduced in 3.7.0b3 by the resolution of +bpo-33053)

      +

      This fix also changed pydoc to add os.getcwd() to sys.path +when necessary, rather than adding ".".

      +
    • +
    • bpo-33169: Delete entries of None in sys.path_importer_cache +when importlib.machinery.invalidate_caches() is called.

    • +
    • bpo-33217: Deprecate looking up non-Enum objects in Enum classes and Enum +members (will raise TypeError in 3.8+).

    • +
    • bpo-33203: random.Random.choice() now raises IndexError for empty +sequences consistently even when called from subclasses without a +getrandbits() implementation.

    • +
    • bpo-33224: Update difflib.mdiff() for PEP 479. Convert an uncaught +StopIteration in a generator into a return-statement.

    • +
    • bpo-33209: End framing at the end of C implementation of +pickle.Pickler.dump().

    • +
    • bpo-20104: Improved error handling and fixed a reference leak in +os.posix_spawn().

    • +
    • bpo-33175: In dataclasses, Field.__set_name__ now looks up the +__set_name__ special method on the class, not the instance, of the default +value.

    • +
    • bpo-33097: Raise RuntimeError when executor.submit is called during +interpreter shutdown.

    • +
    • bpo-31908: Fix output of cover files for trace module command-line +tool. Previously emitted cover files only when --missing option was +used. Patch by Michael Selik.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-33378: Add Korean language switcher for https://docs.python.org/3/

    • +
    • bpo-33276: Clarify that the __path__ attribute on modules cannot be +just any value.

    • +
    • bpo-33201: Modernize documentation for writing C extension types.

    • +
    • bpo-33195: Deprecate Py_UNICODE usage in c-api/arg document. +Py_UNICODE related APIs are deprecated since Python 3.3, but it is +missed in the document.

    • +
    • bpo-8243: Add a note about curses.addch and curses.addstr exception +behavior when writing outside a window, or pad.

    • +
    • bpo-32337: Update documentation related with dict order.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-33358: Fix test_embed.test_pre_initialization_sys_options() when +the interpreter is built with --enable-shared.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-33394: Enable the verbose build for extension modules, when GNU make +is passed macros on the command line.

    • +
    • bpo-33393: Update config.guess and config.sub files.

    • +
    • bpo-33377: Add new triplets for mips r6 and riscv variants (used in +extension suffixes).

    • +
    • bpo-32232: By default, modules configured in Modules/Setup are no longer +built with -DPy_BUILD_CORE. Instead, modules that specifically need that +preprocessor definition include it in their individual entries.

    • +
    • bpo-33182: The embedding tests can once again be built with clang 6.0

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-33184: Update Windows installer to use OpenSSL 1.1.0h.

    • +
    +
    +
    +

    macOS

    +
      +
    • bpo-33184: Update macOS installer build to use OpenSSL 1.1.0h.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-21474: Update word/identifier definition from ascii to unicode. In +text and entry boxes, this affects selection by double-click, movement +left/right by control-left/right, and deletion left/right by +control-BACKSPACE/DEL.

    • +
    • bpo-33204: IDLE: consistently color invalid string prefixes. A ‘u’ string +prefix cannot be paired with either ‘r’ or ‘f’. Consistently color as much +of the prefix, starting at the right, as is valid. Revise and extend +colorizer test.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-33189: pygettext.py now recognizes only literal strings as +docstrings and translatable strings, and rejects bytes literals and +f-string expressions.

    • +
    • bpo-31920: Fixed handling directories as arguments in the pygettext +script. Based on patch by Oleg Krasnikov.

    • +
    • bpo-29673: Fix pystackv and pystack gdbinit macros.

    • +
    • bpo-31583: Fix 2to3 for using with –add-suffix option but without +–output-dir option for relative path to files in current directory.

    • +
    +
    +
    +
    +

    Python 3.7.0 beta 3

    +

    Release date: 2018-03-29

    +
    +

    Security

    +
      +
    • bpo-33136: Harden ssl module against LibreSSL CVE-2018-8970. +X509_VERIFY_PARAM_set1_host() is called with an explicit namelen. A new +test ensures that NULL bytes are not allowed.

    • +
    • bpo-33001: Minimal fix to prevent buffer overrun in os.symlink on Windows

    • +
    • bpo-32981: Regexes in difflib and poplib were vulnerable to catastrophic +backtracking. These regexes formed potential DOS vectors (REDOS). They +have been refactored. This resolves CVE-2018-1060 and CVE-2018-1061. Patch +by Jamie Davis.

    • +
    +
    +
    +

    Core and Builtins

    +
      +
    • bpo-33053: When using the -m switch, sys.path[0] is now explicitly +expanded as the starting working directory, rather than being left as +the empty path (which allows imports from the current working directory at +the time of the import)

    • +
    • bpo-33018: Improve consistency of errors raised by issubclass() when +called with a non-class and an abstract base class as the first and second +arguments, respectively. Patch by Josh Bronson.

    • +
    • bpo-33041: Fixed jumping when the function contains an async for loop.

    • +
    • bpo-33026: Fixed jumping out of “with” block by setting f_lineno.

    • +
    • bpo-33005: Fix a crash on fork when using a custom memory allocator (ex: +using PYTHONMALLOC env var). _PyGILState_Reinit() and +_PyInterpreterState_Enable() now use the default RAW memory allocator to +allocate a new interpreters mutex on fork.

    • +
    • bpo-17288: Prevent jumps from ‘return’ and ‘exception’ trace events.

    • +
    • bpo-32836: Don’t use temporary variables in cases of list/dict/set +comprehensions

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-33141: Have Field objects pass through __set_name__ to their default +values, if they have their own __set_name__.

    • +
    • bpo-33096: Allow ttk.Treeview.insert to insert iid that has a false +boolean value. Note iid=0 and iid=False would be same. Patch by Garvit +Khatri.

    • +
    • bpo-32873: Treat type variables and special typing forms as immutable by +copy and pickle. This fixes several minor issues and inconsistencies, and +improves backwards compatibility with Python 3.6.

    • +
    • bpo-33134: When computing dataclass’s __hash__, use the lookup table to +contain the function which returns the __hash__ value. This is an +improvement over looking up a string, and then testing that string to see +what to do.

    • +
    • bpo-33127: The ssl module now compiles with LibreSSL 2.7.1.

    • +
    • bpo-32505: Raise TypeError if a member variable of a dataclass is of type +Field, but doesn’t have a type annotation.

    • +
    • bpo-33078: Fix the failure on OSX caused by the tests relying on +sem_getvalue

    • +
    • bpo-33116: Add ‘Field’ to dataclasses.__all__.

    • +
    • bpo-32896: Fix an error where subclassing a dataclass with a field that +uses a default_factory would generate an incorrect class.

    • +
    • bpo-33100: Dataclasses: If a field has a default value that’s a +MemberDescriptorType, then it’s from that field being in __slots__, not an +actual default value.

    • +
    • bpo-32953: If a non-dataclass inherits from a frozen dataclass, allow +attributes to be added to the derived class. Only attributes from the +frozen dataclass cannot be assigned to. Require all dataclasses in a +hierarchy to be either all frozen or all non-frozen.

    • +
    • bpo-33061: Add missing NoReturn to __all__ in typing.py

    • +
    • bpo-33078: Fix the size handling in multiprocessing.Queue when a pickling +error occurs.

    • +
    • bpo-33064: lib2to3 now properly supports trailing commas after *args +and **kwargs in function signatures.

    • +
    • bpo-33056: FIX properly close leaking fds in +concurrent.futures.ProcessPoolExecutor.

    • +
    • bpo-33021: Release the GIL during fstat() calls, avoiding hang of all +threads when calling mmap.mmap(), os.urandom(), and random.seed(). Patch +by Nir Soffer.

    • +
    • bpo-31804: Avoid failing in multiprocessing.Process if the standard +streams are closed or None at exit.

    • +
    • bpo-33037: Skip sending/receiving data after SSL transport closing.

    • +
    • bpo-27683: Fix a regression in ipaddress that result of +hosts() is empty when the network is constructed by a tuple +containing an integer mask and only 1 bit left for addresses.

    • +
    • bpo-32999: Fix C implementation of ABC.__subclasscheck__(cls, +subclass) crashed when subclass is not a type object.

    • +
    • bpo-33009: Fix inspect.signature() for single-parameter partialmethods.

    • +
    • bpo-32969: Expose several missing constants in zlib and fix corresponding +documentation.

    • +
    • bpo-32056: Improved exceptions raised for invalid number of channels and +sample width when read an audio file in modules aifc, wave +and sunau.

    • +
    • bpo-32844: Fix wrong redirection of a low descriptor (0 or 1) to stderr in +subprocess if another low descriptor is closed.

    • +
    • bpo-32857: In tkinter, after_cancel(None) now raises a +ValueError instead of canceling the first scheduled function. +Patch by Cheryl Sabella.

    • +
    • bpo-31639: http.server now exposes a ThreadedHTTPServer class and uses it +when the module is run with -m to cope with web browsers pre-opening +sockets.

    • +
    • bpo-27645: sqlite3.Connection now exposes a +backup method, if the underlying SQLite +library is at version 3.6.11 or higher. Patch by Lele Gaifax.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-33126: Document PyBuffer_ToContiguous().

    • +
    • bpo-27212: Modify documentation for the islice() recipe to consume +initial values up to the start index.

    • +
    • bpo-28247: Update zipapp documentation to describe how to make +standalone applications.

    • +
    • bpo-18802: Documentation changes for ipaddress. Patch by Jon Foster and +Berker Peksag.

    • +
    • bpo-27428: Update documentation to clarify that WindowsRegistryFinder +implements MetaPathFinder. (Patch by Himanshu Lakhara)

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-32872: Avoid regrtest compatibility issue with namespace packages.

    • +
    • bpo-32517: Fix failing test_asyncio on macOS 10.12.2+ due to transport +of KqueueSelector loop was not being closed.

    • +
    • bpo-19417: Add test_bdb.py.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-33163: Upgrade pip to 9.0.3 and setuptools to v39.0.1.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-33016: Fix potential use of uninitialized memory in +nt._getfinalpathname

    • +
    • bpo-32903: Fix a memory leak in os.chdir() on Windows if the current +directory is set to a UNC path.

    • +
    +
    +
    +

    macOS

    +
      +
    • bpo-32726: Build and link with private copy of Tcl/Tk 8.6 for the macOS +10.6+ installer. The 10.9+ installer variant already does this. This +means that the Python 3.7 provided by the python.org macOS installers no +longer need or use any external versions of Tcl/Tk, either system-provided +or user-installed, such as ActiveTcl.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-32984: Set __file__ while running a startup file. Like Python, +IDLE optionally runs one startup file in the Shell window before +presenting the first interactive input prompt. For IDLE, -s runs a +file named in environmental variable IDLESTARTUP or +PYTHONSTARTUP; -r file runs file. Python sets +__file__ to the startup file name before running the file and unsets +it before the first prompt. IDLE now does the same when run normally, +without the -n option.

    • +
    • bpo-32940: Simplify and rename StringTranslatePseudoMapping in pyparse.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-32885: Add an -n flag for Tools/scripts/pathfix.py to disable +automatic backup creation (files with ~ suffix).

    • +
    +
    +
    +

    C API

    +
      +
    • bpo-33042: Embedding applications may once again call +PySys_ResetWarnOptions, PySys_AddWarnOption, and PySys_AddXOption prior to +calling Py_Initialize.

    • +
    • bpo-32374: Document that m_traverse for multi-phase initialized modules +can be called with m_state=NULL, and add a sanity check

    • +
    +
    +
    +
    +

    Python 3.7.0 beta 2

    +

    Release date: 2018-02-27

    +
    +

    Security

    +
      +
    • bpo-28414: The ssl module now allows users to perform their own IDN +en/decoding when using SNI.

    • +
    +
    +
    +

    Core and Builtins

    +
      +
    • bpo-32889: Update Valgrind suppression list to account for the rename of +Py_ADDRESS_IN_RANG to address_in_range.

    • +
    • bpo-31356: Remove the new API added in bpo-31356 (gc.ensure_disabled() +context manager).

    • +
    • bpo-32305: For namespace packages, ensure that both __file__ and +__spec__.origin are set to None.

    • +
    • bpo-32303: Make sure __spec__.loader matches __loader__ for +namespace packages.

    • +
    • bpo-32711: Fix the warning messages for Python/ast_unparse.c. Patch by +Stéphane Wirtel

    • +
    • bpo-32583: Fix possible crashing in builtin Unicode decoders caused by +write out-of-bound errors when using customized decode error handlers.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-32960: For dataclasses, disallow inheriting frozen from non-frozen +classes, and also disallow inheriting non-frozen from frozen classes. This +restriction will be relaxed at a future date.

    • +
    • bpo-32713: Fixed tarfile.itn handling of out-of-bounds float values. Patch +by Joffrey Fuhrer.

    • +
    • bpo-32951: Direct instantiation of SSLSocket and SSLObject objects is now +prohibited. The constructors were never documented, tested, or designed as +public constructors. Users were suppose to use ssl.wrap_socket() or +SSLContext.

    • +
    • bpo-32929: Remove the tri-state parameter “hash”, and add the boolean +“unsafe_hash”. If unsafe_hash is True, add a __hash__ function, but if a +__hash__ exists, raise TypeError. If unsafe_hash is False, add a __hash__ +based on the values of eq= and frozen=. The unsafe_hash=False behavior is +the same as the old hash=None behavior. unsafe_hash=False is the default, +just as hash=None used to be.

    • +
    • bpo-32947: Add OP_ENABLE_MIDDLEBOX_COMPAT and test workaround for TLSv1.3 +for future compatibility with OpenSSL 1.1.1.

    • +
    • bpo-30622: The ssl module now detects missing NPN support in LibreSSL.

    • +
    • bpo-32922: dbm.open() now encodes filename with the filesystem encoding +rather than default encoding.

    • +
    • bpo-32859: In os.dup2, don’t check every call whether the dup3 +syscall exists or not.

    • +
    • bpo-32556: nt._getfinalpathname, nt._getvolumepathname and +nt._getdiskusage now correctly convert from bytes.

    • +
    • bpo-25988: Emit a DeprecationWarning when using or importing an ABC +directly from collections rather than from collections.abc.

    • +
    • bpo-21060: Rewrite confusing message from setup.py upload from “No dist +file created in earlier command” to the more helpful “Must create and +upload files in one command”.

    • +
    • bpo-32852: Make sure sys.argv remains as a list when running trace.

    • +
    • bpo-31333: _abc module is added. It is a speedup module with C +implementations for various functions and methods in abc. Creating an +ABC subclass and calling isinstance or issubclass with an ABC +subclass are up to 1.5x faster. In addition, this makes Python start-up up +to 10% faster.

      +

      Note that the new implementation hides internal registry and caches, +previously accessible via private attributes _abc_registry, +_abc_cache, and _abc_negative_cache. There are three debugging +helper methods that can be used instead _dump_registry, +_abc_registry_clear, and _abc_caches_clear.

      +
    • +
    • bpo-32841: Fixed asyncio.Condition issue which silently ignored +cancellation after notifying and cancelling a conditional lock. Patch by +Bar Harel.

    • +
    • bpo-32819: ssl.match_hostname() has been simplified and no longer depends +on re and ipaddress module for wildcard and IP addresses. Error reporting +for invalid wildcards has been improved.

    • +
    • bpo-32394: socket: Remove +TCP_FASTOPEN,TCP_KEEPCNT,TCP_KEEPIDLE,TCP_KEEPINTVL flags on older version +Windows during run-time.

    • +
    • bpo-31787: Fixed refleaks of __init__() methods in various modules. +(Contributed by Oren Milman)

    • +
    • bpo-30157: Fixed guessing quote and delimiter in csv.Sniffer.sniff() when +only the last field is quoted. Patch by Jake Davis.

    • +
    • bpo-32792: collections.ChainMap() preserves the order of the underlying +mappings.

    • +
    • bpo-32775: fnmatch.translate() no longer produces patterns which +contain set operations. Sets starting with ‘[‘ or containing ‘–’, ‘&&’, +‘~~’ or ‘||’ will be interpreted differently in regular expressions in +future versions. Currently they emit warnings. fnmatch.translate() now +avoids producing patterns containing such sets by accident.

    • +
    • bpo-32622: Implement native fast sendfile for Windows proactor event loop.

    • +
    • bpo-32777: Fix a rare but potential pre-exec child process deadlock in +subprocess on POSIX systems when marking file descriptors inheritable on +exec in the child process. This bug appears to have been introduced in +3.4.

    • +
    • bpo-32647: The ctypes module used to depend on indirect linking for +dlopen. The shared extension is now explicitly linked against libdl on +platforms with dl.

    • +
    • bpo-32741: Implement asyncio.TimerHandle.when() method.

    • +
    • bpo-32691: Use mod_spec.parent when running modules with pdb

    • +
    • bpo-32734: Fixed asyncio.Lock() safety issue which allowed acquiring +and locking the same lock multiple times, without it being free. Patch by +Bar Harel.

    • +
    • bpo-32727: Do not include name field in SMTP envelope from address. Patch +by Stéphane Wirtel

    • +
    • bpo-31453: Add TLSVersion constants and SSLContext.maximum_version / +minimum_version attributes. The new API wraps OpenSSL 1.1 +https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_set_min_proto_version.html +feature.

    • +
    • bpo-24334: Internal implementation details of ssl module were cleaned up. +The SSLSocket has one less layer of indirection. Owner and session +information are now handled by the SSLSocket and SSLObject constructor. +Channel binding implementation has been simplified.

    • +
    • bpo-31848: Fix the error handling in Aifc_read.initfp() when the SSND +chunk is not found. Patch by Zackery Spytz.

    • +
    • bpo-32585: Add Ttk spinbox widget to tkinter.ttk. Patch by Alan D +Moore.

    • +
    • bpo-32221: Various functions returning tuple containing IPv6 addresses now +omit %scope part since the same information is already encoded in +scopeid tuple item. Especially this speeds up socket.recvfrom() +when it receives multicast packet since useless resolving of network +interface name is omitted.

    • +
    • bpo-30693: The TarFile class now recurses directories in a reproducible +way.

    • +
    • bpo-30693: The ZipFile class now recurses directories in a reproducible +way.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-28124: The ssl module function ssl.wrap_socket() has been +de-emphasized and deprecated in favor of the more secure and efficient +SSLContext.wrap_socket() method.

    • +
    • bpo-17232: Clarify docs for -O and -OO. Patch by Terry Reedy.

    • +
    • bpo-32436: Add documentation for the contextvars module (PEP 567).

    • +
    • bpo-32800: Update link to w3c doc for xml default namespaces.

    • +
    • bpo-11015: Update test.support documentation.

    • +
    • bpo-8722: Document __getattr__() behavior when property get() +method raises AttributeError.

    • +
    • bpo-32614: Modify RE examples in documentation to use raw strings to +prevent DeprecationWarning and add text to REGEX HOWTO to highlight +the deprecation.

    • +
    • bpo-31972: Improve docstrings for pathlib.PurePath subclasses.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-31809: Add tests to verify connection with secp ECDH curves.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-32898: Fix the python debug build when using COUNT_ALLOCS.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-32901: Update Tcl and Tk versions to 8.6.8

    • +
    • bpo-31966: Fixed WindowsConsoleIO.write() for writing empty data.

    • +
    • bpo-32409: Ensures activate.bat can handle Unicode contents.

    • +
    • bpo-32457: Improves handling of denormalized executable path when +launching Python.

    • +
    • bpo-32370: Use the correct encoding for ipconfig output in the uuid +module. Patch by Segev Finer.

    • +
    • bpo-29248: Fix os.readlink() on Windows, which was mistakenly +treating the PrintNameOffset field of the reparse data buffer as a +number of characters instead of bytes. Patch by Craig Holmquist and SSE4.

    • +
    +
    +
    +

    macOS

    +
      +
    • bpo-32901: Update macOS 10.9+ installer to Tcl/Tk 8.6.8.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-32916: Change str to code in pyparse.

    • +
    • bpo-32905: Remove unused code in pyparse module.

    • +
    • bpo-32874: Add tests for pyparse.

    • +
    • bpo-32837: Using the system and place-dependent default encoding for +open() is a bad idea for IDLE’s system and location-independent files.

    • +
    • bpo-32826: Add “encoding=utf-8” to open() in IDLE’s test_help_about. GUI +test test_file_buttons() only looks at initial ascii-only lines, but +failed on systems where open() defaults to ‘ascii’ because readline() +internally reads and decodes far enough ahead to encounter a non-ascii +character in CREDITS.txt.

    • +
    • bpo-32765: Update configdialog General tab docstring to add new widgets to +the widget list.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-32222: Fix pygettext not extracting docstrings for functions with type +annotated arguments. Patch by Toby Harradine.

    • +
    +
    +
    +
    +

    Python 3.7.0 beta 1

    +

    Release date: 2018-01-30

    +
    +

    Core and Builtins

    +
      +
    • bpo-32703: Fix coroutine’s ResourceWarning when there’s an active error +set when it’s being finalized.

    • +
    • bpo-32650: Pdb and other debuggers dependent on bdb.py will correctly step +over (next command) native coroutines. Patch by Pablo Galindo.

    • +
    • bpo-28685: Optimize list.sort() and sorted() by using type specialized +comparisons when possible.

    • +
    • bpo-32685: Improve suggestion when the Python 2 form of print statement is +either present on the same line as the header of a compound statement or +else terminated by a semi-colon instead of a newline. Patch by Nitish +Chandra.

    • +
    • bpo-32697: Python now explicitly preserves the definition order of +keyword-only parameters. It’s always preserved their order, but this +behavior was never guaranteed before; this behavior is now guaranteed and +tested.

    • +
    • bpo-32690: The locals() dictionary now displays in the lexical order that +variables were defined. Previously, the order was reversed.

    • +
    • bpo-32677: Add .isascii() method to str, bytes and +bytearray. It can be used to test that string contains only ASCII +characters.

    • +
    • bpo-32670: Enforce PEP 479 for all code.

      +

      This means that manually raising a StopIteration exception from a +generator is prohibited for all code, regardless of whether ‘from +__future__ import generator_stop’ was used or not.

      +
    • +
    • bpo-32591: Added built-in support for tracking the origin of coroutine +objects; see sys.set_coroutine_origin_tracking_depth and +CoroutineType.cr_origin. This replaces the asyncio debug mode’s use of +coroutine wrapping for native coroutine objects.

    • +
    • bpo-31368: Expose preadv and pwritev system calls in the os module. Patch +by Pablo Galindo

    • +
    • bpo-32544: hasattr(obj, name) and getattr(obj, name, default) are +about 4 times faster than before when name is not found and obj +doesn’t override __getattr__ or __getattribute__.

    • +
    • bpo-26163: Improved frozenset() hash to create more distinct hash values +when faced with datasets containing many similar values.

    • +
    • bpo-32550: Remove the STORE_ANNOTATION bytecode.

    • +
    • bpo-20104: Expose posix_spawn as a low level API in the os module. +(removed before 3.7.0rc1)

    • +
    • bpo-24340: Fixed estimation of the code stack size.

    • +
    • bpo-32436: Implement PEP 567 Context Variables.

    • +
    • bpo-18533: repr() on a dict containing its own values() or +items() no longer raises RecursionError; OrderedDict similarly. +Instead, use ..., as for other recursive structures. Patch by Ben +North.

    • +
    • bpo-20891: Py_Initialize() now creates the GIL. The GIL is no longer +created “on demand” to fix a race condition when PyGILState_Ensure() is +called in a non-Python thread.

    • +
    • bpo-32028: Leading whitespace is now correctly ignored when generating +suggestions for converting Py2 print statements to Py3 builtin print +function calls. Patch by Sanyam Khurana.

    • +
    • bpo-31179: Make dict.copy() up to 5.5 times faster.

    • +
    • bpo-31113: Get rid of recursion in the compiler for normal control flow.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-25988: Deprecate exposing the contents of collections.abc in the +regular collections module.

    • +
    • bpo-31429: The default cipher suite selection of the ssl module now uses a +blacklist approach rather than a hard-coded whitelist. Python no longer +re-enables ciphers that have been blocked by OpenSSL security update. +Default cipher suite selection can be configured on compile time.

    • +
    • bpo-30306: contextlib.contextmanager now releases the arguments passed to +the underlying generator as soon as the context manager is entered. +Previously it would keep them alive for as long as the context manager was +alive, even when not being used as a function decorator. Patch by Martin +Teichmann.

    • +
    • bpo-21417: Added support for setting the compression level for +zipfile.ZipFile.

    • +
    • bpo-32251: Implement asyncio.BufferedProtocol (provisional API).

    • +
    • bpo-32513: In dataclasses, allow easier overriding of dunder methods +without specifying decorator parameters.

    • +
    • bpo-32660: termios makes available FIONREAD, FIONCLEX, +FIOCLEX, FIOASYNC and FIONBIO also under Solaris/derivatives.

    • +
    • bpo-27931: Fix email address header parsing error when the username is an +empty quoted string. Patch by Xiang Zhang.

    • +
    • bpo-32659: Under Solaris and derivatives, os.stat_result provides +a st_fstype attribute.

    • +
    • bpo-32662: Implement Server.start_serving(), Server.serve_forever(), and +Server.is_serving() methods. Add ‘start_serving’ keyword parameter to +loop.create_server() and loop.create_unix_server().

    • +
    • bpo-32391: Implement asyncio.StreamWriter.wait_closed() and +asyncio.StreamWriter.is_closing() methods

    • +
    • bpo-32643: Make Task._step, Task._wakeup and Future._schedule_callbacks +methods private.

    • +
    • bpo-32630: Refactor decimal module to use contextvars to store decimal +context.

    • +
    • bpo-32622: Add asyncio.AbstractEventLoop.sendfile() method.

    • +
    • bpo-32304: distutils’ upload command no longer corrupts tar files ending +with a CR byte, and no longer tries to convert CR to CRLF in any of the +upload text fields.

    • +
    • bpo-32502: uuid.uuid1 no longer raises an exception if a 64-bit hardware +address is encountered.

    • +
    • bpo-32596: concurrent.futures imports ThreadPoolExecutor and +ProcessPoolExecutor lazily (using PEP 562). It makes import +asyncio about 15% faster because asyncio uses only +ThreadPoolExecutor by default.

    • +
    • bpo-31801: Add _ignore_ to Enum so temporary variables can be used +during class construction without being turned into members.

    • +
    • bpo-32576: Use queue.SimpleQueue() in places where it can be invoked from +a weakref callback.

    • +
    • bpo-32574: Fix memory leak in asyncio.Queue, when the queue has limited +size and it is full, the cancelation of queue.put() can cause a memory +leak. Patch by: José Melero.

    • +
    • bpo-32521: The nis module is now compatible with new libnsl and headers +location.

    • +
    • bpo-32467: collections.abc.ValuesView now inherits from +collections.abc.Collection.

    • +
    • bpo-32473: Improve ABCMeta._dump_registry() output readability

    • +
    • bpo-32102: New argument capture_output for subprocess.run

    • +
    • bpo-32521: glibc has removed Sun RPC. Use replacement libtirpc headers and +library in nis module.

    • +
    • bpo-32493: UUID module fixes build for FreeBSD/OpenBSD

    • +
    • bpo-32503: Pickling with protocol 4 no longer creates too small frames.

    • +
    • bpo-29237: Create enum for pstats sorting options

    • +
    • bpo-32454: Add close(fd) function to the socket module.

    • +
    • bpo-25942: The subprocess module is now more graceful when handling a +Ctrl-C KeyboardInterrupt during subprocess.call, subprocess.run, or a +Popen context manager. It now waits a short amount of time for the child +(presumed to have also gotten the SIGINT) to exit, before continuing the +KeyboardInterrupt exception handling. This still includes a SIGKILL in +the call() and run() APIs, but at least the child had a chance first.

    • +
    • bpo-32433: The hmac module now has hmac.digest(), which provides an +optimized HMAC digest.

    • +
    • bpo-28134: Sockets now auto-detect family, type and protocol from file +descriptor by default.

    • +
    • bpo-32404: Fix bug where datetime.datetime.fromtimestamp() did not +call __new__ in datetime.datetime subclasses.

    • +
    • bpo-32403: Improved speed of datetime.date and +datetime.datetime alternate constructors.

    • +
    • bpo-32228: Ensure that truncate() preserves the file position (as +reported by tell()) after writes longer than the buffer size.

    • +
    • bpo-32410: Implement loop.sock_sendfile for asyncio event loop.

    • +
    • bpo-22908: Added seek and tell to the ZipExtFile class. This only works if +the file object used to open the zipfile is seekable.

    • +
    • bpo-32373: Add socket.getblocking() method.

    • +
    • bpo-32248: Add importlib.resources and +importlib.abc.ResourceReader as the unified API for reading +resources contained within packages. Loaders wishing to support resource +reading must implement the get_resource_reader() method. +File-based and zipimport-based loaders both implement these APIs. +importlib.abc.ResourceLoader is deprecated in favor of these new +APIs.

    • +
    • bpo-32320: collections.namedtuple() now supports default values.

    • +
    • bpo-29302: Add contextlib.AsyncExitStack. Patch by Alexander Mohr and Ilya +Kulakov.

    • +
    • bpo-31961: Removed in Python 3.7.0b2. The args argument of +subprocess.Popen can now be a path-like object. If args is given +as a sequence, it’s first element can now be a path-like object as +well.

    • +
    • bpo-31900: The locale.localeconv() function now sets temporarily the +LC_CTYPE locale to the LC_NUMERIC locale to decode +decimal_point and thousands_sep byte strings if they are non-ASCII +or longer than 1 byte, and the LC_NUMERIC locale is different than the +LC_CTYPE locale. This temporary change affects other threads.

      +

      Same change for the str.format() method when formatting a number +(int, float, float and subclasses) with the +n type (ex: '{:n}'.format(1234)).

      +
    • +
    • bpo-31853: Use super().method instead of socket.method in SSLSocket. They +were there most likely for legacy reasons.

    • +
    • bpo-31399: The ssl module now uses OpenSSL’s X509_VERIFY_PARAM_set1_host() +and X509_VERIFY_PARAM_set1_ip() API to verify hostname and IP addresses. +Subject common name fallback can be disabled with +SSLContext.hostname_checks_common_name.

    • +
    • bpo-14976: Add a queue.SimpleQueue class, an unbounded FIFO queue with a +reentrant C implementation of put().

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-32724: Add references to some commands in the documentation of Pdb. +Patch by Stéphane Wirtel

    • +
    • bpo-32649: Complete the C API documentation, profiling and tracing part +with the newly added per-opcode events.

    • +
    • bpo-17799: Explain real behaviour of sys.settrace and sys.setprofile and +their C-API counterparts regarding which type of events are received in +each function. Patch by Pablo Galindo Salgado.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-32721: Fix test_hashlib to not fail if the _md5 module is not built.

    • +
    • bpo-28414: Add test cases for IDNA 2003 and 2008 host names. IDNA 2003 +internationalized host names are working since bpo-31399 has landed. IDNA +2008 are still broken.

    • +
    • bpo-32604: Add a new “_xxsubinterpreters” extension module that exposes +the existing subinterpreter C-API and a new cross-interpreter data sharing +mechanism. The module is primarily intended for more thorough testing of +the existing subinterpreter support.

      +

      Note that the _xxsubinterpreters module has been removed in 3.7.0rc1.

      +
    • +
    • bpo-32602: Add test certs and test for ECDSA cert and EC/RSA dual mode.

    • +
    • bpo-32549: On Travis CI, Python now Compiles and uses a local copy of +OpenSSL 1.1.0g for testing.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-32635: Fix segfault of the crypt module when libxcrypt is provided +instead of libcrypt at the system.

    • +
    • bpo-32598: Use autoconf to detect OpenSSL libs, headers and supported +features. The ax_check_openssl M4 macro uses pkg-config to locate OpenSSL +and falls back to manual search.

    • +
    • bpo-32593: Drop support of FreeBSD 9 and older.

    • +
    • bpo-29708: If the SOURCE_DATE_EPOCH environment variable is set, +py_compile will always create hash-based .pyc files.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-32588: Create standalone _distutils_findvs module and add missing +_queue module to installer.

    • +
    • bpo-29911: Ensure separate Modify and Uninstall buttons are displayed.

    • +
    • bpo-32507: Use app-local UCRT install rather than the proper update for +old versions of Windows.

    • +
    +
    +
    +

    macOS

    +
      +
    • bpo-32726: Provide an additional, more modern macOS installer variant that +supports macOS 10.9+ systems in 64-bit mode only. Upgrade the supplied +third-party libraries to OpenSSL 1.1.0g and to SQLite 3.22.0. The 10.9+ +installer now links with and supplies its own copy of Tcl/Tk 8.6.

    • +
    • bpo-28440: No longer add /Library/Python/3.x/site-packages to sys.path for +macOS framework builds to avoid future conflicts.

    • +
    +
    +
    +

    C API

    +
      +
    • bpo-32681: Fix uninitialized variable ‘res’ in the C implementation of +os.dup2. Patch by Stéphane Wirtel

    • +
    • bpo-10381: Add C API access to the datetime.timezone constructor and +datetime.timzone.UTC singleton.

    • +
    +
    +
    +
    +

    Python 3.7.0 alpha 4

    +

    Release date: 2018-01-08

    +
    +

    Core and Builtins

    +
      +
    • bpo-31975: The default warning filter list now starts with a +“default::DeprecationWarning:__main__” entry, so deprecation warnings are +once again shown by default in single-file scripts and at the interactive +prompt.

    • +
    • bpo-32226: __class_getitem__ is now an automatic class method.

    • +
    • bpo-32399: Add AIX uuid library support for RFC4122 using uuid_create() in +libc.a

    • +
    • bpo-32390: Fix the compilation failure on AIX after the f_fsid field has +been added to the object returned by os.statvfs() (bpo-32143). Original +patch by Michael Felt.

    • +
    • bpo-32379: Make MRO computation faster when a class inherits from a single +base.

    • +
    • bpo-32259: The error message of a TypeError raised when unpack +non-iterable is now more specific.

    • +
    • bpo-27169: The __debug__ constant is now optimized out at compile +time. This fixes also bpo-22091.

    • +
    • bpo-32329: The -R option now turns on hash randomization when +the PYTHONHASHSEED environment variable is set to 0. +Previously, the option was ignored. Moreover, +sys.flags.hash_randomization is now properly set to 0 when hash +randomization is turned off by PYTHONHASHSEED=0.

    • +
    • bpo-30416: The optimizer is now protected from spending much time doing +complex calculations and consuming much memory for creating large +constants in constant folding. Increased limits for constants that can be +produced in constant folding.

    • +
    • bpo-32282: Fix an unnecessary ifdef in the include of VersionHelpers.h in +socketmodule on Windows.

    • +
    • bpo-30579: Implement TracebackType.__new__ to allow Python-level creation +of traceback objects, and make TracebackType.tb_next mutable.

    • +
    • bpo-32260: Don’t byte swap the input keys to the SipHash algorithm on +big-endian platforms. This should ensure siphash gives consistent results +across platforms.

    • +
    • bpo-31506: Improve the error message logic for object.__new__ and +object.__init__. Patch by Sanyam Khurana.

    • +
    • bpo-20361: -b and -bb now inject 'default::BytesWarning' and +error::BytesWarning entries into sys.warnoptions, ensuring that +they take precedence over any other warning filters configured via the +-W option or the PYTHONWARNINGS environment variable.

    • +
    • bpo-32230: -X dev now injects a 'default' entry into +sys.warnoptions, ensuring that it behaves identically to actually passing +-Wdefault at the command line.

    • +
    • bpo-29240: Add a new UTF-8 mode: implementation of the PEP 540.

    • +
    • bpo-32226: PEP 560: Add support for __mro_entries__ and +__class_getitem__. Implemented by Ivan Levkivskyi.

    • +
    • bpo-32225: PEP 562: Add support for module __getattr__ and +__dir__. Implemented by Ivan Levkivskyi.

    • +
    • bpo-31901: The atexit module now has its callback stored per +interpreter.

    • +
    • bpo-31650: Implement PEP 552 (Deterministic pycs). Python now supports +invalidating bytecode cache files bashed on a source content hash rather +than source last-modified time.

    • +
    • bpo-29469: Move constant folding from bytecode layer to AST layer. +Original patch by Eugene Toder.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-32506: Now that dict is defined as keeping insertion order, drop +OrderedDict and just use plain dict.

    • +
    • bpo-32279: Add params to dataclasses.make_dataclasses(): init, repr, eq, +order, hash, and frozen. Pass them through to dataclass().

    • +
    • bpo-32278: Make type information optional on dataclasses.make_dataclass(). +If omitted, the string ‘typing.Any’ is used.

    • +
    • bpo-32499: Add dataclasses.is_dataclass(obj), which returns True if obj is +a dataclass or an instance of one.

    • +
    • bpo-32468: Improve frame repr() to mention filename, code name and current +line number.

    • +
    • bpo-23749: asyncio: Implement loop.start_tls()

    • +
    • bpo-32441: Return the new file descriptor (i.e., the second argument) from +os.dup2. Previously, None was always returned.

    • +
    • bpo-32422: functools.lru_cache uses less memory (3 words for each +cached key) and takes about 1/3 time for cyclic GC.

    • +
    • bpo-31721: Prevent Python crash from happening when Future._log_traceback +is set to True manually. Now it can only be set to False, or a ValueError +is raised.

    • +
    • bpo-32415: asyncio: Add Task.get_loop() and Future.get_loop()

    • +
    • bpo-26133: Don’t unsubscribe signals in asyncio UNIX event loop on +interpreter shutdown.

    • +
    • bpo-32363: Make asyncio.Task.set_exception() and set_result() raise +NotImplementedError. Task._step() and Future.__await__() raise proper +exceptions when they are in an invalid state, instead of raising an +AssertionError.

    • +
    • bpo-32357: Optimize asyncio.iscoroutine() and loop.create_task() for +non-native coroutines (e.g. async/await compiled with Cython).

      +

      ‘loop.create_task(python_coroutine)’ used to be 20% faster than +‘loop.create_task(cython_coroutine)’. Now, the latter is as fast.

      +
    • +
    • bpo-32356: asyncio.transport.resume_reading() and pause_reading() are now +idempotent. New transport.is_reading() method is added.

    • +
    • bpo-32355: Optimize asyncio.gather(); now up to 15% faster.

    • +
    • bpo-32351: Use fastpath in asyncio.sleep if delay<0 (2x boost)

    • +
    • bpo-32348: Optimize asyncio.Future schedule/add/remove callback. The +optimization shows 3-6% performance improvements of async/await code.

    • +
    • bpo-32331: Fix socket.settimeout() and socket.setblocking() to keep +socket.type as is. Fix socket.socket() constructor to reset any bit flags +applied to socket’s type. This change only affects OSes that have +SOCK_NONBLOCK and/or SOCK_CLOEXEC.

    • +
    • bpo-32248: Add importlib.abc.ResourceReader as an ABC for loaders +to provide a unified API for reading resources contained within packages. +Also add importlib.resources as the port of +importlib_resources.

    • +
    • bpo-32311: Implement asyncio.create_task(coro) shortcut

    • +
    • bpo-32327: Convert asyncio functions that were documented as coroutines to +coroutines. Affected functions: loop.sock_sendall, loop.sock_recv, +loop.sock_accept, loop.getaddrinfo, loop.getnameinfo.

    • +
    • bpo-32323: urllib.parse.urlsplit() does not convert zone-id +(scope) to lower case for scoped IPv6 addresses in hostnames now.

    • +
    • bpo-32302: Fix bdist_wininst of distutils for CRT v142: it binary +compatible with CRT v140.

    • +
    • bpo-29711: Fix stop_serving in asyncio proactor loop kill all +listening servers

    • +
    • bpo-32308: re.sub() now replaces empty matches adjacent to a +previous non-empty match.

    • +
    • bpo-29970: Abort asyncio SSLProtocol connection if handshake not complete +within 10s

    • +
    • bpo-32314: Implement asyncio.run().

    • +
    • bpo-17852: Revert incorrect fix based on misunderstanding of +_Py_PyAtExit() semantics.

    • +
    • bpo-32296: Implement asyncio._get_running_loop() and get_event_loop() in +C. This makes them 4x faster.

    • +
    • bpo-32250: Implement asyncio.current_task() and +asyncio.all_tasks(). Add helpers intended to be used by alternative +task implementations: asyncio._register_task, asyncio._enter_task, +asyncio._leave_task and asyncio._unregister_task. Deprecate +asyncio.Task.current_task() and asyncio.Task.all_tasks().

    • +
    • bpo-32255: A single empty field is now always quoted when written into a +CSV file. This allows to distinguish an empty row from a row consisting of +a single empty field. Patch by Licht Takeuchi.

    • +
    • bpo-32277: Raise NotImplementedError instead of SystemError on +platforms where chmod(..., follow_symlinks=False) is not supported. +Patch by Anthony Sottile.

    • +
    • bpo-30050: New argument warn_on_full_buffer to signal.set_wakeup_fd lets +you control whether Python prints a warning on stderr when the wakeup fd +buffer overflows.

    • +
    • bpo-29137: The fpectl library has been removed. It was never enabled +by default, never worked correctly on x86-64, and it changed the Python +ABI in ways that caused unexpected breakage of C extensions.

    • +
    • bpo-32273: Move asyncio.test_utils to test.test_asyncio.

    • +
    • bpo-32272: Remove asyncio.async() function.

    • +
    • bpo-32269: Add asyncio.get_running_loop() function.

    • +
    • bpo-32265: All class and static methods of builtin types now are correctly +classified by inspect.classify_class_attrs() and grouped in pydoc ouput. +Added types.ClassMethodDescriptorType for unbound class methods of builtin +types.

    • +
    • bpo-32253: Deprecate yield from lock, await lock, with (yield +from lock) and with await lock for asyncio synchronization +primitives.

    • +
    • bpo-22589: Changed MIME type of .bmp from ‘image/x-ms-bmp’ to ‘image/bmp’

    • +
    • bpo-32193: Convert asyncio to use async/await syntax. Old styled yield +from is still supported too.

    • +
    • bpo-32206: Add support to run modules with pdb

    • +
    • bpo-32227: functools.singledispatch now supports registering +implementations using type annotations.

    • +
    • bpo-15873: Added new alternate constructors +datetime.datetime.fromisoformat(), +datetime.time.fromisoformat() and +datetime.date.fromisoformat() as the inverse operation of each +classes’s respective isoformat methods.

    • +
    • bpo-32199: The getnode() ip getter now uses ‘ip link’ instead of ‘ip link +list’.

    • +
    • bpo-32143: os.statvfs() includes the f_fsid field from statvfs(2)

    • +
    • bpo-26439: Fix ctypes.util.find_library() for AIX by implementing +ctypes._aix.find_library() Patch by: Michael Felt

    • +
    • bpo-31993: The pickler now uses less memory when serializing large bytes +and str objects into a file. Pickles created with protocol 4 will require +less memory for unpickling large bytes and str objects.

    • +
    • bpo-27456: Ensure TCP_NODELAY is set on Linux. Tests by Victor Stinner.

    • +
    • bpo-31778: ast.literal_eval() is now more strict. Addition and subtraction +of arbitrary numbers no longer allowed.

    • +
    • bpo-31802: Importing native path module (posixpath, ntpath) now +works even if the os module still is not imported.

    • +
    • bpo-30241: Add contextlib.AbstractAsyncContextManager. Patch by Jelle +Zijlstra.

    • +
    • bpo-31699: Fix deadlocks in +concurrent.futures.ProcessPoolExecutor when task arguments or +results cause pickling or unpickling errors. This should make sure that +calls to the ProcessPoolExecutor API always eventually return.

    • +
    • bpo-15216: TextIOWrapper.reconfigure() supports changing encoding, +errors, and newline.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-32418: Add get_loop() method to Server and AbstractServer classes.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-32252: Fix faulthandler_suppress_crash_report() used to prevent core +dump files when testing crashes. getrlimit() returns zero on success.

    • +
    • bpo-32002: Adjust C locale coercion testing for the empty locale and POSIX +locale cases to more readily adjust to platform dependent behaviour.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-19764: Implement support for subprocess.Popen(close_fds=True) on +Windows. Patch by Segev Finer.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-24960: 2to3 and lib2to3 can now read pickled grammar files using +pkgutil.get_data() rather than probing the filesystem. This lets 2to3 and +lib2to3 work when run from a zipfile.

    • +
    +
    +
    +

    C API

    +
      +
    • bpo-32030: Py_Initialize() doesn’t reset the memory allocators to default +if the PYTHONMALLOC environment variable is not set.

    • +
    • bpo-29084: Undocumented C API for OrderedDict has been excluded from the +limited C API. It was added by mistake and actually never worked in the +limited C API.

    • +
    • bpo-32264: Moved the pygetopt.h header into internal/, since it has no +public APIs.

    • +
    • bpo-32241: Py_SetProgramName() and Py_SetPythonHome() now +take the const wchar * arguments instead of wchar *.

    • +
    +
    +
    +
    +

    Python 3.7.0 alpha 3

    +

    Release date: 2017-12-05

    +
    +

    Core and Builtins

    +
      +
    • bpo-32176: co_flags.CO_NOFREE is now always set correctly by the code +object constructor based on freevars and cellvars, rather than needing to +be set correctly by the caller. This ensures it will be cleared +automatically when additional cell references are injected into a modified +code object and function.

    • +
    • bpo-10544: Yield expressions are now deprecated in comprehensions and +generator expressions. They are still permitted in the definition of the +outermost iterable, as that is evaluated directly in the enclosing scope.

    • +
    • bpo-32137: The repr of deeply nested dict now raises a RecursionError +instead of crashing due to a stack overflow.

    • +
    • bpo-32096: Revert memory allocator changes in the C API: move structures +back from _PyRuntime to Objects/obmalloc.c. The memory allocators are once +again initialized statically, and so PyMem_RawMalloc() and +Py_DecodeLocale() can be called before _PyRuntime_Initialize().

    • +
    • bpo-32043: Add a new “developer mode”: new “-X dev” command line option to +enable debug checks at runtime.

    • +
    • bpo-32023: SyntaxError is now correctly raised when a generator expression +without parenthesis is used instead of an inheritance list in a class +definition. The duplication of the parentheses can be omitted only on +calls.

    • +
    • bpo-32012: SyntaxError is now correctly raised when a generator expression +without parenthesis is passed as an argument, but followed by a trailing +comma. A generator expression always needs to be directly inside a set of +parentheses and cannot have a comma on either side.

    • +
    • bpo-28180: A new internal _Py_SetLocaleFromEnv(category) helper +function has been added in order to improve the consistency of behaviour +across different libc implementations (e.g. Android doesn’t support +setting the locale from the environment by default).

    • +
    • bpo-31949: Fixed several issues in printing tracebacks +(PyTraceBack_Print()).

      +
        +
      • Setting sys.tracebacklimit to 0 or less now suppresses printing tracebacks.

      • +
      • Setting sys.tracebacklimit to None now causes using the default limit.

      • +
      • Setting sys.tracebacklimit to an integer larger than LONG_MAX now means using +the limit LONG_MAX rather than the default limit.

      • +
      • Fixed integer overflows in the case of more than 2**31 traceback items on +Windows.

      • +
      • Fixed output errors handling.

      • +
      +
    • +
    • bpo-30696: Fix the interactive interpreter looping endlessly when no +memory.

    • +
    • bpo-20047: Bytearray methods partition() and rpartition() now accept only +bytes-like objects as separator, as documented. In particular they now +raise TypeError rather of returning a bogus result when an integer is +passed as a separator.

    • +
    • bpo-21720: BytesWarning no longer emitted when the fromlist argument of +__import__() or the __all__ attribute of the module contain bytes +instances.

    • +
    • bpo-31845: Environment variables are once more read correctly at +interpreter startup.

    • +
    • bpo-28936: Ensure that lexically first syntax error involving a parameter +and global or nonlocal is detected first at a given scope. Patch +by Ivan Levkivskyi.

    • +
    • bpo-31825: Fixed OverflowError in the ‘unicode-escape’ codec and in +codecs.escape_decode() when decode an escaped non-ascii byte.

    • +
    • bpo-31618: The per-frame tracing logic added in 3.7a1 has been altered so +that frame->f_lineno is updated before either "line" or +"opcode" events are emitted. Previously, opcode events were emitted +first, and therefore would occasionally see stale line numbers on the +frame. The behavior of this feature has changed slightly as a result: when +both f_trace_lines and f_trace_opcodes are enabled, line events +now occur first.

    • +
    • bpo-28603: Print the full context/cause chain of exceptions on interpreter +exit, even if an exception in the chain is unhashable or compares equal to +later ones. Patch by Zane Bitter.

    • +
    • bpo-31786: Fix timeout rounding in the select module to round correctly +negative timeouts between -1.0 and 0.0. The functions now block waiting +for events as expected. Previously, the call was incorrectly non-blocking. +Patch by Pablo Galindo.

    • +
    • bpo-31781: Prevent crashes when calling methods of an uninitialized +zipimport.zipimporter object. Patch by Oren Milman.

    • +
    • bpo-30399: Standard repr() of BaseException with a single argument no +longer contains redundant trailing comma.

    • +
    • bpo-31626: Fixed a bug in debug memory allocator. There was a write to +freed memory after shrinking a memory block.

    • +
    • bpo-30817: PyErr_PrintEx() clears now the ignored exception that may be +raised by _PySys_SetObjectId(), for example when no memory.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-28556: Two minor fixes for typing module: allow shallow copying +instances of generic classes, improve interaction of __init_subclass__ +with generics. Original PRs by Ivan Levkivskyi.

    • +
    • bpo-32214: PEP 557, Data Classes. Provides a decorator which adds +boilerplate methods to classes which use type annotations so specify +fields.

    • +
    • bpo-27240: The header folding algorithm for the new email policies has +been rewritten, which also fixes bpo-30788, bpo-31831, and bpo-32182. In +particular, RFC2231 folding is now done correctly.

    • +
    • bpo-32186: io.FileIO.readall() and io.FileIO.read() now release the GIL +when getting the file size. Fixed hang of all threads with inaccessible +NFS server. Patch by Nir Soffer.

    • +
    • bpo-321010: Add sys.flags.dev_mode flag

    • +
    • bpo-32154: The asyncio.windows_utils.socketpair() function has been +removed: use directly socket.socketpair() which is available on all +platforms since Python 3.5 (before, it wasn’t available on Windows). +asyncio.windows_utils.socketpair() was just an alias to +socket.socketpair on Python 3.5 and newer.

    • +
    • bpo-32089: warnings: In development (-X dev) and debug mode (pydebug +build), use the “default” action for ResourceWarning, rather than the +“always” action, in the default warnings filters.

    • +
    • bpo-32107: uuid.getnode() now preferentially returns universally +administered MAC addresses if available, over locally administered MAC +addresses. This makes a better guarantee for global uniqueness of UUIDs +returned from uuid.uuid1(). If only locally administered MAC +addresses are available, the first such one found is returned.

    • +
    • bpo-23033: Wildcard is now supported in hostname when it is one and only +character in the left most segment of hostname in second argument of +ssl.match_hostname(). Patch by Mandeep Singh.

    • +
    • bpo-12239: Make msilib.SummaryInformation.GetProperty() return +None when the value of property is VT_EMPTY. Initial patch by +Mark Mc Mahon.

    • +
    • bpo-28334: Use os.path.expanduser() to find the ~/.netrc file in +netrc.netrc. If it does not exist, FileNotFoundError is +raised. Patch by Dimitri Merejkowsky.

    • +
    • bpo-32121: Made tracemalloc.Traceback behave more like the traceback +module, sorting the frames from oldest to most recent. +Traceback.format() now accepts negative limit, truncating the result +to the abs(limit) oldest frames. To get the old behaviour, one can use +the new most_recent_first argument to Traceback.format(). (Patch by +Jesse Bakker.)

    • +
    • bpo-31325: Fix wrong usage of collections.namedtuple() in the +RobotFileParser.parse() +method.

      +

      Initial patch by Robin Wellner.

      +
    • +
    • bpo-12382: msilib.OpenDatabase() now raises a better exception +message when it couldn’t open or create an MSI file. Initial patch by +William Tisäter.

    • +
    • bpo-19610: setup() now warns about invalid types for some fields.

      +

      The distutils.dist.Distribution class now warns when classifiers, +keywords and platforms fields are not specified as a list or a +string.

      +
    • +
    • bpo-32071: Added the -k command-line option to python -m unittest +to run only tests that match the given pattern(s).

    • +
    • bpo-10049: Added nullcontext no-op context manager to contextlib. This +provides a simpler and faster alternative to ExitStack() when handling +optional context managers.

    • +
    • bpo-28684: The new test.support.skip_unless_bind_unix_socket() decorator +is used here to skip asyncio tests that fail because the platform lacks a +functional bind() function for unix domain sockets (as it is the case for +non root users on the recent Android versions that run now SELinux in +enforcing mode).

    • +
    • bpo-32110: codecs.StreamReader.read(n) now returns not more than n +characters/bytes for non-negative n. This makes it compatible with +read() methods of other file-like objects.

    • +
    • bpo-27535: The warnings module doesn’t leak memory anymore in the hidden +warnings registry for the “ignore” action of warnings filters. +warn_explicit() function doesn’t add the warning key to the registry +anymore for the “ignore” action.

    • +
    • bpo-32088: warnings: When Python is build is debug mode (Py_DEBUG), +DeprecationWarning, PendingDeprecationWarning and +ImportWarning warnings are now displayed by default.

    • +
    • bpo-1647489: Fixed searching regular expression patterns that could match +an empty string. Non-empty string can now be correctly found after +matching an empty string.

    • +
    • bpo-25054: Added support of splitting on a pattern that could match an +empty string.

    • +
    • bpo-32072: Fixed issues with binary plists:

      +
        +
      • Fixed saving bytearrays.

      • +
      • Identical objects will be saved only once.

      • +
      • Equal references will be load as identical objects.

      • +
      • Added support for saving and loading recursive data structures.

      • +
      +
    • +
    • bpo-32069: Drop legacy SSL transport from asyncio, ssl.MemoryBIO is always +used anyway.

    • +
    • bpo-32066: asyncio: Support pathlib.Path in create_unix_connection; sock +arg should be optional

    • +
    • bpo-32046: Updates 2to3 to convert from operator.isCallable(obj) to +callable(obj). Patch by Dong-hee Na.

    • +
    • bpo-32018: inspect.signature should follow PEP 8, if the parameter has an +annotation and a default value. Patch by Dong-hee Na.

    • +
    • bpo-32025: Add time.thread_time() and time.thread_time_ns()

    • +
    • bpo-32037: Integers that fit in a signed 32-bit integer will be now +pickled with protocol 0 using the INT opcode. This will decrease the size +of a pickle, speed up pickling and unpickling, and make these integers be +unpickled as int instances in Python 2.

    • +
    • bpo-32034: Make asyncio.IncompleteReadError and LimitOverrunError +pickleable.

    • +
    • bpo-32015: Fixed the looping of asyncio in the case of reconnection the +socket during waiting async read/write from/to the socket.

    • +
    • bpo-32011: Restored support of loading marshal files with the TYPE_INT64 +code. These files can be produced in Python 2.7.

    • +
    • bpo-28369: Enhance add_reader/writer check that socket is not used by some +transport. Before, only cases when add_reader/writer were called with an +int FD were supported. Now the check is implemented correctly for all +file-like objects.

    • +
    • bpo-31976: Fix race condition when flushing a file is slow, which can +cause a segfault if closing the file from another thread.

    • +
    • bpo-31985: Formally deprecated aifc.openfp, sunau.openfp, and wave.openfp. +Since change 7bc817d5ba917528e8bd07ec461c635291e7b06a in 1993, openfp in +each of the three modules had been pointing to that module’s open function +as a matter of backwards compatibility, though it had been both untested +and undocumented.

    • +
    • bpo-21862: cProfile command line now accepts -m module_name as an +alternative to script path. Patch by Sanyam Khurana.

    • +
    • bpo-31970: Reduce performance overhead of asyncio debug mode.

    • +
    • bpo-31843: database argument of sqlite3.connect() now accepts a +path-like object, instead of just a string.

    • +
    • bpo-31945: Add Configurable blocksize to HTTPConnection and +HTTPSConnection for improved upload throughput. Patch by Nir Soffer.

    • +
    • bpo-31943: Add a cancelled() method to asyncio.Handle. Patch +by Marat Sharafutdinov.

    • +
    • bpo-9678: Fixed determining the MAC address in the uuid module:

      +
        +
      • Using ifconfig on NetBSD and OpenBSD.

      • +
      • Using arp on Linux, FreeBSD, NetBSD and OpenBSD.

      • +
      +

      Based on patch by Takayuki Shimizukawa.

      +
    • +
    • bpo-30057: Fix potential missed signal in signal.signal().

    • +
    • bpo-31933: Fix Blake2 params leaf_size and node_offset on big endian +platforms. Patch by Jack O’Connor.

    • +
    • bpo-21423: Add an initializer argument to {Process,Thread}PoolExecutor

    • +
    • bpo-31927: Fixed compilation of the socket module on NetBSD 8. Fixed +assertion failure or reading arbitrary data when parse a AF_BLUETOOTH +address on NetBSD and DragonFly BSD.

    • +
    • bpo-27666: Fixed stack corruption in curses.box() and curses.ungetmouse() +when the size of types chtype or mmask_t is less than the size of C long. +curses.box() now accepts characters as arguments. Based on patch by Steve +Fink.

    • +
    • bpo-31917: Add 3 new clock identifiers: time.CLOCK_BOOTTIME, +time.CLOCK_PROF and time.CLOCK_UPTIME.

    • +
    • bpo-31897: plistlib now catches more errors when read binary plists and +raises InvalidFileException instead of unexpected exceptions.

    • +
    • bpo-25720: Fix the method for checking pad state of curses WINDOW. Patch +by Masayuki Yamamoto.

    • +
    • bpo-31893: Fixed the layout of the kqueue_event structure on OpenBSD and +NetBSD. Fixed the comparison of the kqueue_event objects.

    • +
    • bpo-31891: Fixed building the curses module on NetBSD.

    • +
    • bpo-31884: added required constants to subprocess module for setting +priority on windows

    • +
    • bpo-28281: Remove year (1-9999) limits on the Calendar.weekday() function.

      +

      Patch by Mark Gollahon.

      +
    • +
    • bpo-31702: crypt.mksalt() now allows to specify the number of rounds for +SHA-256 and SHA-512 hashing.

    • +
    • bpo-30639: inspect.getfile() no longer computes the repr of unknown +objects to display in an error message, to protect against badly behaved +custom reprs.

    • +
    • bpo-30768: Fix the pthread+semaphore implementation of +PyThread_acquire_lock_timed() when called with timeout > 0 and +intr_flag=0: recompute the timeout if sem_timedwait() is interrupted by a +signal (EINTR). See also the PEP 475.

    • +
    • bpo-31854: Add mmap.ACCESS_DEFAULT constant.

    • +
    • bpo-31834: Use optimized code for BLAKE2 only with SSSE3+. The pure SSE2 +implementation is slower than the pure C reference implementation.

    • +
    • bpo-28292: Calendar.itermonthdates() will now consistently raise an +exception when a date falls outside of the 0001-01-01 through 9999-12-31 +range. To support applications that cannot tolerate such exceptions, the +new methods itermonthdays3() and itermonthdays4() are added. The new +methods return tuples and are not restricted by the range supported by +datetime.date.

    • +
    • bpo-28564: The shutil.rmtree() function has been sped up to 20–40%. This +was done using the os.scandir() function.

    • +
    • bpo-28416: Instances of pickle.Pickler subclass with the persistent_id() +method and pickle.Unpickler subclass with the persistent_load() method no +longer create reference cycles.

    • +
    • bpo-31653: Don’t release the GIL if we can acquire a multiprocessing +semaphore immediately.

    • +
    • bpo-28326: Fix multiprocessing.Process when stdout and/or stderr is closed +or None.

    • +
    • bpo-20825: Add subnet_of and superset_of containment tests to +ipaddress.IPv6Network and ipaddress.IPv4Network. Patch +by Michel Albert and Cheryl Sabella.

    • +
    • bpo-31827: Remove the os.stat_float_times() function. It was introduced in +Python 2.3 for backward compatibility with Python 2.2, and was deprecated +since Python 3.1.

    • +
    • bpo-31756: Add a subprocess.Popen(text=False) keyword argument to +subprocess functions to be more explicit about when the library should +attempt to decode outputs into text. Patch by Andrew Clegg.

    • +
    • bpo-31819: Add AbstractEventLoop.sock_recv_into().

    • +
    • bpo-31457: If nested log adapters are used, the inner process() +methods are no longer omitted.

    • +
    • bpo-31457: The manager property on LoggerAdapter objects is now +properly settable.

    • +
    • bpo-31806: Fix timeout rounding in time.sleep(), threading.Lock.acquire() +and socket.socket.settimeout() to round correctly negative timeouts +between -1.0 and 0.0. The functions now block waiting for events as +expected. Previously, the call was incorrectly non-blocking. Patch by +Pablo Galindo.

    • +
    • bpo-31803: time.clock() and time.get_clock_info(‘clock’) now emit a +DeprecationWarning warning.

    • +
    • bpo-31800: Extended support for parsing UTC offsets. strptime ‘%z’ can now +parse the output generated by datetime.isoformat, including seconds and +microseconds.

    • +
    • bpo-28603: traceback: Fix a TypeError that occurred during printing of +exception tracebacks when either the current exception or an exception in +its context/cause chain is unhashable. Patch by Zane Bitter.

    • +
    • bpo-30541: Add new function to seal a mock and prevent the automatically +creation of child mocks. Patch by Mario Corchero.

    • +
    • bpo-31784: Implement the PEP 564, add new 6 new functions with +nanosecond resolution to the time module: +clock_gettime_ns(), clock_settime_ns(), +monotonic_ns(), perf_counter_ns(), +process_time_ns(), time_ns().

    • +
    • bpo-30143: 2to3 now generates a code that uses abstract collection classes +from collections.abc rather than collections.

    • +
    • bpo-31770: Prevent a crash when calling the __init__() method of a +sqlite3.Cursor object more than once. Patch by Oren Milman.

    • +
    • bpo-31764: Prevent a crash in sqlite3.Cursor.close() in case the +Cursor object is uninitialized. Patch by Oren Milman.

    • +
    • bpo-31752: Fix possible crash in timedelta constructor called with custom +integers.

    • +
    • bpo-31620: an empty asyncio.Queue now doesn’t leak memory when queue.get +pollers timeout

    • +
    • bpo-31690: Allow the flags re.ASCII, re.LOCALE, and re.UNICODE to be used +as group flags for regular expressions.

    • +
    • bpo-30349: FutureWarning is now emitted if a regular expression contains +character set constructs that will change semantically in the future +(nested sets and set operations).

    • +
    • bpo-31664: Added support for the Blowfish hashing in the crypt module.

    • +
    • bpo-31632: Fix method set_protocol() of class _SSLProtocolTransport in +asyncio module. This method was previously modifying a wrong reference to +the protocol.

    • +
    • bpo-15037: Added a workaround for getkey() in curses for ncurses 5.7 and +earlier.

    • +
    • bpo-31307: Allow use of bytes objects for arguments to +configparser.ConfigParser.read(). Patch by Vincent Michel.

    • +
    • bpo-31334: Fix poll.poll([timeout]) in the select module for +arbitrary negative timeouts on all OSes where it can only be a +non-negative integer or -1. Patch by Riccardo Coccioli.

    • +
    • bpo-31310: multiprocessing’s semaphore tracker should be launched again if +crashed.

    • +
    • bpo-31308: Make multiprocessing’s forkserver process immune to Ctrl-C and +other user interruptions. If it crashes, restart it when necessary.

    • +
    • bpo-31245: Added support for AF_UNIX socket in asyncio +create_datagram_endpoint.

    • +
    • bpo-30553: Add HTTP/2 status code 421 (Misdirected Request) to +http.HTTPStatus. Patch by Vitor Pereira.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-32105: Added asyncio.BaseEventLoop.connect_accepted_socket +versionadded marker.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-31380: Skip test_httpservers test_undecodable_file on macOS: fails on +APFS.

    • +
    • bpo-31705: Skip test_socket.test_sha256() on Linux kernel older than 4.5. +The test fails with ENOKEY on kernel 3.10 (on ppc64le). A fix was merged +into the kernel 4.5.

    • +
    • bpo-32138: Skip on Android test_faulthandler tests that raise SIGSEGV and +remove the test.support.requires_android_level decorator.

    • +
    • bpo-32136: The runtime embedding tests have been split out from +Lib/test/test_capi.py into a new Lib/test/test_embed.py file.

    • +
    • bpo-28668: test.support.requires_multiprocessing_queue is removed. Skip +tests with test.support.import_module(‘multiprocessing.synchronize’) +instead when the semaphore implementation is broken or missing.

    • +
    • bpo-32126: Skip test_get_event_loop_new_process in +test.test_asyncio.test_events when sem_open() is not functional.

    • +
    • bpo-31174: Fix test_tools.test_unparse: DirectoryTestCase now stores the +names sample to always test the same files. It prevents false alarms when +hunting reference leaks.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-28538: Revert the previous changes, the if_nameindex structure is +defined by Unified Headers.

    • +
    • bpo-28762: Revert the last commit, the F_LOCK macro is defined by Android +Unified Headers.

    • +
    • bpo-29040: Support building Android with Unified Headers. The first NDK +release to support Unified Headers is android-ndk-r14.

    • +
    • bpo-32059: detect_modules() in setup.py now also searches the +sysroot paths when cross-compiling.

    • +
    • bpo-31957: Fixes Windows SDK version detection when building for Windows.

    • +
    • bpo-31609: Fixes quotes in PCbuild/clean.bat

    • +
    • bpo-31934: Abort the build when building out of a not clean source tree.

    • +
    • bpo-31926: Fixed Argument Clinic sometimes causing compilation errors when +there was more than one function and/or method in a .c file with the same +name.

    • +
    • bpo-28791: Update Windows builds to use SQLite 3.21.0.

    • +
    • bpo-28791: Update OS X installer to use SQLite 3.21.0.

    • +
    • bpo-28643: Record profile-opt build progress with stamp files.

    • +
    • bpo-31866: Finish removing support for AtheOS.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-1102: Return None when View.Fetch() returns +ERROR_NO_MORE_ITEMS instead of raising MSIError.

      +

      Initial patch by Anthony Tuininga.

      +
    • +
    • bpo-31944: Fixes Modify button in Apps and Features dialog.

    • +
    • bpo-20486: Implement the Database.Close() method to help closing MSI +database objects.

    • +
    • bpo-31857: Make the behavior of USE_STACKCHECK deterministic in a +multi-threaded environment.

    • +
    +
    +
    +

    macOS

    +
      +
    • bpo-31392: Update macOS installer to use OpenSSL 1.0.2m

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-32207: Improve tk event exception tracebacks in IDLE. When tk event +handling is driven by IDLE’s run loop, a confusing and distracting +queue.EMPTY traceback context is no longer added to tk event exception +tracebacks. The traceback is now the same as when event handling is +driven by user code. Patch based on a suggestion by Serhiy Storchaka.

    • +
    • bpo-32164: Delete unused file idlelib/tabbedpages.py. Use of TabbedPageSet +in configdialog was replaced by ttk.Notebook.

    • +
    • bpo-32100: IDLE: Fix old and new bugs in pathbrowser; improve tests. Patch +mostly by Cheryl Sabella.

    • +
    • bpo-31858: IDLE – Restrict shell prompt manipulation to the shell. Editor +and output windows only see an empty last prompt line. This simplifies +the code and fixes a minor bug when newline is inserted. Sys.ps1, if +present, is read on Shell start-up, but is not set or changed.

    • +
    • bpo-31860: The font sample in the IDLE configuration dialog is now +editable. Changes persist while IDLE remains open

    • +
    • bpo-31836: Test_code_module now passes if run after test_idle, which sets +ps1.

      +

      The code module uses sys.ps1 if present or sets it to ‘>>> ‘ if not. +Test_code_module now properly tests both behaviors. Ditto for ps2.

      +
    • +
    • bpo-28603: Fix a TypeError that caused a shell restart when printing a +traceback that includes an exception that is unhashable. Patch by Zane +Bitter.

    • +
    • bpo-13802: Use non-Latin characters in the IDLE’s Font settings sample. +Even if one selects a font that defines a limited subset of the unicode +Basic Multilingual Plane, tcl/tk will use other fonts that define a +character. The expanded example give users of non-Latin characters a +better idea of what they might see in IDLE’s shell and editors.

      +

      To make room for the expanded sample, frames on the Font tab are +re-arranged. The Font/Tabs help explains a bit about the additions.

      +
    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-32159: Remove CVS and Subversion tools: remove svneol.py and +treesync.py scripts. CPython migrated from CVS to Subversion, to +Mercurial, and then to Git. CVS and Subversion are no longer used to +develop CPython.

    • +
    • bpo-30722: Make redemo work with Python 3.6 and newer versions.

      +

      Also, remove the LOCALE option since it doesn’t work with string +patterns in Python 3.

      +

      Patch by Christoph Sarnowski.

      +
    • +
    +
    +
    +

    C API

    +
      +
    • bpo-20891: Fix PyGILState_Ensure(). When PyGILState_Ensure() is called in +a non-Python thread before PyEval_InitThreads(), only call +PyEval_InitThreads() after calling PyThreadState_New() to fix a crash.

    • +
    • bpo-32125: The Py_UseClassExceptionsFlag flag has been removed. It was +deprecated and wasn’t used anymore since Python 2.0.

    • +
    • bpo-25612: Move the current exception state from the frame object to the +co-routine. This simplifies the interpreter and fixes a couple of obscure +bugs caused by having swap exception state when entering or exiting a +generator.

    • +
    • bpo-23699: Add Py_RETURN_RICHCOMPARE macro to reduce boilerplate code in +rich comparison functions.

    • +
    • bpo-30697: The PyExc_RecursionErrorInst singleton is removed and +PyErr_NormalizeException() does not use it anymore. This singleton is +persistent and its members being never cleared may cause a segfault during +finalization of the interpreter. See also bpo-22898.

    • +
    +
    +
    +
    +

    Python 3.7.0 alpha 2

    +

    Release date: 2017-10-16

    +
    +

    Core and Builtins

    +
      +
    • bpo-31558: gc.freeze() is a new API that allows for moving all objects +currently tracked by the garbage collector to a permanent generation, +effectively removing them from future collection events. This can be used +to protect those objects from having their PyGC_Head mutated. In effect, +this enables great copy-on-write stability at fork().

    • +
    • bpo-31642: Restored blocking “from package import module” by setting +sys.modules[“package.module”] to None.

    • +
    • bpo-31708: Allow use of asynchronous generator expressions in synchronous +functions.

    • +
    • bpo-31709: Drop support of asynchronous __aiter__.

    • +
    • bpo-30404: The -u option now makes the stdout and stderr streams +unbuffered rather than line-buffered.

    • +
    • bpo-31619: Fixed a ValueError when convert a string with large number of +underscores to integer with binary base.

    • +
    • bpo-31602: Fix an assertion failure in zipimporter.get_source() in case +of a bad zlib.decompress(). Patch by Oren Milman.

    • +
    • bpo-31592: Fixed an assertion failure in Python parser in case of a bad +unicodedata.normalize(). Patch by Oren Milman.

    • +
    • bpo-31588: Raise a TypeError with a helpful error message when class +creation fails due to a metaclass with a bad __prepare__() method. +Patch by Oren Milman.

    • +
    • bpo-31574: Importlib was instrumented with two dtrace probes to profile +import timing.

    • +
    • bpo-31566: Fix an assertion failure in _warnings.warn() in case of a bad +__name__ global. Patch by Oren Milman.

    • +
    • bpo-31506: Improved the error message logic for object.__new__ and +object.__init__.

    • +
    • bpo-31505: Fix an assertion failure in json, in case +_json.make_encoder() received a bad encoder() argument. Patch by Oren +Milman.

    • +
    • bpo-31492: Fix assertion failures in case of failing to import from a +module with a bad __name__ attribute, and in case of failing to access +an attribute of such a module. Patch by Oren Milman.

    • +
    • bpo-31478: Fix an assertion failure in _random.Random.seed() in case the +argument has a bad __abs__() method. Patch by Oren Milman.

    • +
    • bpo-31336: Speed up class creation by 10-20% by reducing the overhead in +the necessary special method lookups. Patch by Stefan Behnel.

    • +
    • bpo-31415: Add -X importtime option to show how long each import +takes. It can be used to optimize application’s startup time. Support the +PYTHONPROFILEIMPORTTIME as an equivalent way to enable this.

    • +
    • bpo-31410: Optimized calling wrapper and classmethod descriptors.

    • +
    • bpo-31353: PEP 553 - Add a new built-in called breakpoint() which +calls sys.breakpointhook(). By default this imports pdb and calls +pdb.set_trace(), but users may override sys.breakpointhook() to +call whatever debugger they want. The original value of the hook is saved +in sys.__breakpointhook__.

    • +
    • bpo-17852: Maintain a list of open buffered files, flush them before +exiting the interpreter. Based on a patch from Armin Rigo.

    • +
    • bpo-31315: Fix an assertion failure in imp.create_dynamic(), when +spec.name is not a string. Patch by Oren Milman.

    • +
    • bpo-31311: Fix a crash in the __setstate__() method of +ctypes._CData, in case of a bad __dict__. Patch by Oren Milman.

    • +
    • bpo-31293: Fix crashes in true division and multiplication of a timedelta +object by a float with a bad as_integer_ratio() method. Patch by Oren +Milman.

    • +
    • bpo-31285: Fix an assertion failure in warnings.warn_explicit, when the +return value of the received loader’s get_source() has a bad splitlines() +method. Patch by Oren Milman.

    • +
    • bpo-30406: Make async and await proper keywords, as specified in +PEP 492.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-30058: Fixed buffer overflow in select.kqueue.control().

    • +
    • bpo-31672: idpattern in string.Template matched some non-ASCII +characters. Now it uses -i regular expression local flag to avoid +non-ASCII characters.

    • +
    • bpo-31701: On Windows, faulthandler.enable() now ignores MSC and COM +exceptions.

    • +
    • bpo-31728: Prevent crashes in _elementtree due to unsafe cleanup of +Element.text and Element.tail. Patch by Oren Milman.

    • +
    • bpo-31671: Now re.compile() converts passed RegexFlag to normal int +object before compiling. bm_regex_compile benchmark shows 14% performance +improvements.

    • +
    • bpo-30397: The types of compiled regular objects and match objects are now +exposed as re.Pattern and re.Match. This adds information in pydoc +output for the re module.

    • +
    • bpo-31675: Fixed memory leaks in Tkinter’s methods splitlist() and split() +when pass a string larger than 2 GiB.

    • +
    • bpo-31673: Fixed typo in the name of Tkinter’s method adderrorinfo().

    • +
    • bpo-31648: Improvements to path predicates in ElementTree:

      +
        +
      • Allow whitespace around predicate parts, i.e. “[a = ‘text’]” instead of requiring the less readable “[a=’text’]”.

      • +
      • Add support for text comparison of the current node, like “[.=’text’]”.

      • +
      +

      Patch by Stefan Behnel.

      +
    • +
    • bpo-30806: Fix the string representation of a netrc object.

    • +
    • bpo-31638: Add optional argument compressed to +zipapp.create_archive, and add option --compress to the command +line interface of zipapp.

    • +
    • bpo-25351: Avoid venv activate failures with undefined variables

    • +
    • bpo-20519: Avoid ctypes use (if possible) and improve import time for +uuid.

    • +
    • bpo-28293: The regular expression cache is no longer completely dumped +when it is full.

    • +
    • bpo-31596: Added pthread_getcpuclockid() to the time module

    • +
    • bpo-27494: Make 2to3 accept a trailing comma in generator expressions. For +example, set(x for x in [],) is now allowed.

    • +
    • bpo-30347: Stop crashes when concurrently iterate over itertools.groupby() +iterators.

    • +
    • bpo-30346: An iterator produced by itertools.groupby() iterator now +becomes exhausted after advancing the groupby iterator.

    • +
    • bpo-31556: Cancel asyncio.wait_for future faster if timeout <= 0

    • +
    • bpo-31540: Allow passing a context object in +concurrent.futures.ProcessPoolExecutor constructor. Also, free +job resources in concurrent.futures.ProcessPoolExecutor earlier +to improve memory usage when a worker waits for new jobs.

    • +
    • bpo-31516: threading.current_thread() should not return a dummy thread +at shutdown.

    • +
    • bpo-31525: In the sqlite module, require the sqlite3_prepare_v2 API. Thus, +the sqlite module now requires sqlite version at least 3.3.9.

    • +
    • bpo-26510: argparse subparsers are now required by default. This matches +behaviour in Python 2. For optional subparsers, use the new parameter +add_subparsers(required=False). Patch by Anthony Sottile. (As of +3.7.0rc1, the default was changed to not required as had been the case +since Python 3.3.)

    • +
    • bpo-27541: Reprs of subclasses of some collection and iterator classes +(bytearray, array.array, collections.deque, +collections.defaultdict, itertools.count, itertools.repeat) now +contain actual type name insteads of hardcoded name of the base class.

    • +
    • bpo-31351: python -m ensurepip now exits with non-zero exit code if pip +bootstrapping has failed.

    • +
    • bpo-31389: pdb.set_trace() now takes an optional keyword-only argument +header. If given, this is printed to the console just before debugging +begins.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-31537: Fix incorrect usage of get_history_length in readline +documentation example code. Patch by Brad Smith.

    • +
    • bpo-30085: The operator functions without double underscores are preferred +for clarity. The one with underscores are only kept for +back-compatibility.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-31696: Improve compiler version information in sys.version +when Python is built with Clang.

    • +
    • bpo-31625: Stop using ranlib on static libraries. Instead, we assume ar +supports the ‘s’ flag.

    • +
    • bpo-31624: Remove support for BSD/OS.

    • +
    • bpo-22140: Prevent double substitution of prefix in python-config.sh.

    • +
    • bpo-31569: Correct PCBuild/ case to PCbuild/ in build scripts and +documentation.

    • +
    • bpo-31536: Avoid wholesale rebuild after make regen-all if nothing +changed.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-31460: Simplify the API of IDLE’s Module Browser.

      +

      Passing a widget instead of an flist with a root widget opens the option +of creating a browser frame that is only part of a window. Passing a full +file name instead of pieces assumed to come from a .py file opens the +possibility of browsing python files that do not end in .py.

      +
    • +
    • bpo-31649: IDLE - Make _htest, _utest parameters keyword only.

    • +
    • bpo-31559: Remove test order dependence in idle_test.test_browser.

    • +
    • bpo-31459: Rename IDLE’s module browser from Class Browser to Module +Browser. The original module-level class and method browser became a +module browser, with the addition of module-level functions, years ago. +Nested classes and functions were added yesterday. For +back-compatibility, the virtual event <<open-class-browser>>, which +appears on the Keys tab of the Settings dialog, is not changed. Patch by +Cheryl Sabella.

    • +
    • bpo-31500: Default fonts now are scaled on HiDPI displays.

    • +
    • bpo-1612262: IDLE module browser now shows nested classes and functions. +Original patches for code and tests by Guilherme Polo and Cheryl Sabella, +respectively.

    • +
    +
    +
    +

    C API

    +
      +
    • bpo-28280: Make PyMapping_Keys(), PyMapping_Values() and +PyMapping_Items() always return a list (rather than a list or a +tuple). Patch by Oren Milman.

    • +
    • bpo-31532: Fix memory corruption due to allocator mix in getpath.c between +Py_GetPath() and Py_SetPath()

    • +
    • bpo-25658: Implement PEP 539 for Thread Specific Storage (TSS) API: it is +a new Thread Local Storage (TLS) API to CPython which would supersede use +of the existing TLS API within the CPython interpreter, while deprecating +the existing API. PEP written by Erik M. Bray, patch by Masayuki Yamamoto.

    • +
    +
    +
    +
    +

    Python 3.7.0 alpha 1

    +

    Release date: 2017-09-19

    +
    +

    Security

    +
      +
    • bpo-29781: SSLObject.version() now correctly returns None when handshake +over BIO has not been performed yet.

    • +
    • bpo-29505: Add fuzz tests for float(str), int(str), unicode(str); for +oss-fuzz.

    • +
    • bpo-30947: Upgrade libexpat embedded copy from version 2.2.1 to 2.2.3 to +get security fixes.

    • +
    • bpo-30730: Prevent environment variables injection in subprocess on +Windows. Prevent passing other environment variables and command +arguments.

    • +
    • bpo-30694: Upgrade expat copy from 2.2.0 to 2.2.1 to get fixes of multiple +security vulnerabilities including: CVE-2017-9233 (External entity +infinite loop DoS), CVE-2016-9063 (Integer overflow, re-fix), +CVE-2016-0718 (Fix regression bugs from 2.2.0’s fix to CVE-2016-0718) and +CVE-2012-0876 (Counter hash flooding with SipHash). Note: the +CVE-2016-5300 (Use os-specific entropy sources like getrandom) doesn’t +impact Python, since Python already gets entropy from the OS to set the +expat secret using XML_SetHashSalt().

    • +
    • bpo-30500: Fix urllib.parse.splithost() to correctly parse fragments. For +example, splithost('//127.0.0.1#@evil.com/') now correctly returns the +127.0.0.1 host, instead of treating @evil.com as the host in an +authentication (login@host).

    • +
    • bpo-29591: Update expat copy from 2.1.1 to 2.2.0 to get fixes of +CVE-2016-0718 and CVE-2016-4472. See +https://sourceforge.net/p/expat/bugs/537/ for more information.

    • +
    +
    +
    +

    Core and Builtins

    +
      +
    • bpo-31490: Fix an assertion failure in ctypes class definition, in case +the class has an attribute whose name is specified in _anonymous_ but +not in _fields_. Patch by Oren Milman.

    • +
    • bpo-31471: Fix an assertion failure in subprocess.Popen() on Windows, in +case the env argument has a bad keys() method. Patch by Oren Milman.

    • +
    • bpo-31418: Fix an assertion failure in PyErr_WriteUnraisable() in case +of an exception with a bad __module__ attribute. Patch by Oren Milman.

    • +
    • bpo-31416: Fix assertion failures in case of a bad warnings.filters or +warnings.defaultaction. Patch by Oren Milman.

    • +
    • bpo-28411: Change direct usage of PyInterpreterState.modules to +PyImport_GetModuleDict(). Also introduce more uniformity in other code +that deals with sys.modules. This helps reduce complications when working +on sys.modules.

    • +
    • bpo-28411: Switch to the abstract API when dealing with +PyInterpreterState.modules. This allows later support for all dict +subclasses and other Mapping implementations. Also add a +PyImport_GetModule() function to reduce a bunch of duplicated code.

    • +
    • bpo-31411: Raise a TypeError instead of SystemError in case +warnings.onceregistry is not a dictionary. Patch by Oren Milman.

    • +
    • bpo-31344: For finer control of tracing behaviour when testing the +interpreter, two new frame attributes have been added to control the +emission of particular trace events: f_trace_lines (True by +default) to turn off per-line trace events; and f_trace_opcodes +(False by default) to turn on per-opcode trace events.

    • +
    • bpo-31373: Fix several possible instances of undefined behavior due to +floating-point demotions.

    • +
    • bpo-30465: Location information (lineno and col_offset) in +f-strings is now (mostly) correct. This fixes tools like flake8 from +showing warnings on the wrong line (typically the first line of the file).

    • +
    • bpo-30860: Consolidate CPython’s global runtime state under a single +struct. This improves discoverability of the runtime state.

    • +
    • bpo-31347: Fix possible undefined behavior in _PyObject_FastCall_Prepend.

    • +
    • bpo-31343: Include sys/sysmacros.h for major(), minor(), and makedev(). +GNU C libray plans to remove the functions from sys/types.h.

    • +
    • bpo-31291: Fix an assertion failure in zipimport.zipimporter.get_data on +Windows, when the return value of pathname.replace('/','\\') isn’t a +string. Patch by Oren Milman.

    • +
    • bpo-31271: Fix an assertion failure in the write() method of +io.TextIOWrapper, when the encoder doesn’t return a bytes object. Patch +by Oren Milman.

    • +
    • bpo-31243: Fix a crash in some methods of io.TextIOWrapper, when the +decoder’s state is invalid. Patch by Oren Milman.

    • +
    • bpo-30721: print now shows correct usage hint for using Python 2 +redirection syntax. Patch by Sanyam Khurana.

    • +
    • bpo-31070: Fix a race condition in importlib _get_module_lock().

    • +
    • bpo-30747: Add a non-dummy implementation of _Py_atomic_store and +_Py_atomic_load on MSVC.

    • +
    • bpo-31095: Fix potential crash during GC caused by tp_dealloc which +doesn’t call PyObject_GC_UnTrack().

    • +
    • bpo-31071: Avoid masking original TypeError in call with * unpacking when +other arguments are passed.

    • +
    • bpo-30978: str.format_map() now passes key lookup exceptions through. +Previously any exception was replaced with a KeyError exception.

    • +
    • bpo-30808: Use _Py_atomic API for concurrency-sensitive signal state.

    • +
    • bpo-30876: Relative import from unloaded package now reimports the package +instead of failing with SystemError. Relative import from non-package now +fails with ImportError rather than SystemError.

    • +
    • bpo-30703: Improve signal delivery.

      +

      Avoid using Py_AddPendingCall from signal handler, to avoid calling +signal-unsafe functions. The tests I’m adding here fail without the rest +of the patch, on Linux and OS X. This means our signal delivery logic had +defects (some signals could be lost).

      +
    • +
    • bpo-30765: Avoid blocking in pthread_mutex_lock() when +PyThread_acquire_lock() is asked not to block.

    • +
    • bpo-31161: Make sure the ‘Missing parentheses’ syntax error message is +only applied to SyntaxError, not to subclasses. Patch by Martijn Pieters.

    • +
    • bpo-30814: Fixed a race condition when import a submodule from a package.

    • +
    • bpo-30736: The internal unicodedata database has been upgraded to Unicode +10.0.

    • +
    • bpo-30604: Move co_extra_freefuncs from per-thread to per-interpreter to +avoid crashes.

    • +
    • bpo-30597: print now shows expected input in custom error message when +used as a Python 2 statement. Patch by Sanyam Khurana.

    • +
    • bpo-30682: Removed a too-strict assertion that failed for certain +f-strings, such as eval(“f’\n’”) and eval(“f’\r’”).

    • +
    • bpo-30501: The compiler now produces more optimal code for complex +condition expressions in the “if”, “while” and “assert” statement, the +“if” expression, and generator expressions and comprehensions.

    • +
    • bpo-28180: Implement PEP 538 (legacy C locale coercion). This means that +when a suitable coercion target locale is available, both the core +interpreter and locale-aware C extensions will assume the use of UTF-8 as +the default text encoding, rather than ASCII.

    • +
    • bpo-30486: Allows setting cell values for __closure__. Patch by Lisa +Roach.

    • +
    • bpo-30537: itertools.islice now accepts integer-like objects (having an +__index__ method) as start, stop, and slice arguments

    • +
    • bpo-25324: Tokens needed for parsing in Python moved to C. COMMENT, +NL and ENCODING. This way the tokens and tok_names in the token +module don’t get changed when you import the tokenize module.

    • +
    • bpo-29104: Fixed parsing backslashes in f-strings.

    • +
    • bpo-27945: Fixed various segfaults with dict when input collections are +mutated during searching, inserting or comparing. Based on patches by +Duane Griffin and Tim Mitchell.

    • +
    • bpo-25794: Fixed type.__setattr__() and type.__delattr__() for +non-interned attribute names. Based on patch by Eryk Sun.

    • +
    • bpo-30039: If a KeyboardInterrupt happens when the interpreter is in the +middle of resuming a chain of nested ‘yield from’ or ‘await’ calls, it’s +now correctly delivered to the innermost frame.

    • +
    • bpo-28974: object.__format__(x, '') is now equivalent to str(x) +rather than format(str(self), '').

    • +
    • bpo-30024: Circular imports involving absolute imports with binding a +submodule to a name are now supported.

    • +
    • bpo-12414: sys.getsizeof() on a code object now returns the sizes which +includes the code struct and sizes of objects which it references. Patch +by Dong-hee Na.

    • +
    • bpo-29839: len() now raises ValueError rather than OverflowError if +__len__() returned a large negative integer.

    • +
    • bpo-11913: README.rst is now included in the list of distutils standard +READMEs and therefore included in source distributions.

    • +
    • bpo-29914: Fixed default implementations of __reduce__ and +__reduce_ex__(). object.__reduce__() no longer takes arguments, +object.__reduce_ex__() now requires one argument.

    • +
    • bpo-29949: Fix memory usage regression of set and frozenset object.

    • +
    • bpo-29935: Fixed error messages in the index() method of tuple, list and +deque when pass indices of wrong type.

    • +
    • bpo-29816: Shift operation now has less opportunity to raise +OverflowError. ValueError always is raised rather than OverflowError for +negative counts. Shifting zero with non-negative count always returns +zero.

    • +
    • bpo-24821: Fixed the slowing down to 25 times in the searching of some +unlucky Unicode characters.

    • +
    • bpo-29102: Add a unique ID to PyInterpreterState. This makes it easier to +identify each subinterpreter.

    • +
    • bpo-29894: The deprecation warning is emitted if __complex__ returns an +instance of a strict subclass of complex. In a future versions of Python +this can be an error.

    • +
    • bpo-29859: Show correct error messages when any of the pthread_* calls in +thread_pthread.h fails.

    • +
    • bpo-29849: Fix a memory leak when an ImportError is raised during from +import.

    • +
    • bpo-28856: Fix an oversight that %b format for bytes should support +objects follow the buffer protocol.

    • +
    • bpo-29723: The sys.path[0] initialization change for bpo-29139 caused +a regression by revealing an inconsistency in how sys.path is initialized +when executing __main__ from a zipfile, directory, or other import +location. The interpreter now consistently avoids ever adding the import +location’s parent directory to sys.path, and ensures no other +sys.path entries are inadvertently modified when inserting the import +location named on the command line.

    • +
    • bpo-29568: Escaped percent “%%” in the format string for classic string +formatting no longer allows any characters between two percents.

    • +
    • bpo-29714: Fix a regression that bytes format may fail when containing +zero bytes inside.

    • +
    • bpo-29695: bool(), float(), list() and tuple() no longer take keyword +arguments. The first argument of int() can now be passes only as +positional argument.

    • +
    • bpo-28893: Set correct __cause__ for errors about invalid awaitables +returned from __aiter__ and __anext__.

    • +
    • bpo-28876: bool(range) works even if len(range) raises +OverflowError.

    • +
    • bpo-29683: Fixes to memory allocation in _PyCode_SetExtra. Patch by Brian +Coleman.

    • +
    • bpo-29684: Fix minor regression of PyEval_CallObjectWithKeywords. It +should raise TypeError when kwargs is not a dict. But it might cause segv +when args=NULL and kwargs is not a dict.

    • +
    • bpo-28598: Support __rmod__ for subclasses of str being called before +str.__mod__. Patch by Martijn Pieters.

    • +
    • bpo-29607: Fix stack_effect computation for CALL_FUNCTION_EX. Patch by +Matthieu Dartiailh.

    • +
    • bpo-29602: Fix incorrect handling of signed zeros in complex constructor +for complex subclasses and for inputs having a __complex__ method. Patch +by Serhiy Storchaka.

    • +
    • bpo-29347: Fixed possibly dereferencing undefined pointers when creating +weakref objects.

    • +
    • bpo-29463: Add docstring field to Module, ClassDef, FunctionDef, and +AsyncFunctionDef ast nodes. docstring is not first stmt in their body +anymore. It affects co_firstlineno and co_lnotab of code object +for module and class. (Reverted in bpo-32911.)

    • +
    • bpo-29438: Fixed use-after-free problem in key sharing dict.

    • +
    • bpo-29546: Set the ‘path’ and ‘name’ attribute on ImportError for from +... import ....

    • +
    • bpo-29546: Improve from-import error message with location

    • +
    • bpo-29478: If max_line_length=None is specified while using the Compat32 +policy, it is no longer ignored. Patch by Mircea Cosbuc.

    • +
    • bpo-29319: Prevent RunMainFromImporter overwriting sys.path[0].

    • +
    • bpo-29337: Fixed possible BytesWarning when compare the code objects. +Warnings could be emitted at compile time.

    • +
    • bpo-29327: Fixed a crash when pass the iterable keyword argument to +sorted().

    • +
    • bpo-29034: Fix memory leak and use-after-free in os module +(path_converter).

    • +
    • bpo-29159: Fix regression in bytes(x) when x.__index__() raises Exception.

    • +
    • bpo-29049: Call _PyObject_GC_TRACK() lazily when calling Python function. +Calling function is up to 5% faster.

    • +
    • bpo-28927: bytes.fromhex() and bytearray.fromhex() now ignore all ASCII +whitespace, not only spaces. Patch by Robert Xiao.

    • +
    • bpo-28932: Do not include <sys/random.h> if it does not exist.

    • +
    • bpo-25677: Correct the positioning of the syntax error caret for indented +blocks. Based on patch by Michael Layzell.

    • +
    • bpo-29000: Fixed bytes formatting of octals with zero padding in alternate +form.

    • +
    • bpo-18896: Python function can now have more than 255 parameters. +collections.namedtuple() now supports tuples with more than 255 elements.

    • +
    • bpo-28596: The preferred encoding is UTF-8 on Android. Patch written by +Chi Hsuan Yen.

    • +
    • bpo-22257: Clean up interpreter startup (see PEP 432).

    • +
    • bpo-26919: On Android, operating system data is now always encoded/decoded +to/from UTF-8, instead of the locale encoding to avoid inconsistencies +with os.fsencode() and os.fsdecode() which are already using UTF-8.

    • +
    • bpo-28991: functools.lru_cache() was susceptible to an obscure reentrancy +bug triggerable by a monkey-patched len() function.

    • +
    • bpo-28147: Fix a memory leak in split-table dictionaries: setattr() must +not convert combined table into split table. Patch written by INADA Naoki.

    • +
    • bpo-28739: f-string expressions are no longer accepted as docstrings and +by ast.literal_eval() even if they do not include expressions.

    • +
    • bpo-28512: Fixed setting the offset attribute of SyntaxError by +PyErr_SyntaxLocationEx() and PyErr_SyntaxLocationObject().

    • +
    • bpo-28918: Fix the cross compilation of xxlimited when Python has been +built with Py_DEBUG defined.

    • +
    • bpo-23722: Rather than silently producing a class that doesn’t support +zero-argument super() in methods, failing to pass the new +__classcell__ namespace entry up to type.__new__ now results in a +DeprecationWarning and a class that supports zero-argument +super().

    • +
    • bpo-28797: Modifying the class __dict__ inside the __set_name__ method of +a descriptor that is used inside that class no longer prevents calling the +__set_name__ method of other descriptors.

    • +
    • bpo-28799: Remove the PyEval_GetCallStats() function and deprecate the +untested and undocumented sys.callstats() function. Remove the +CALL_PROFILE special build: use the sys.setprofile() function, +cProfile or profile to profile function calls.

    • +
    • bpo-12844: More than 255 arguments can now be passed to a function.

    • +
    • bpo-28782: Fix a bug in the implementation yield from when checking if +the next instruction is YIELD_FROM. Regression introduced by WORDCODE +(bpo-26647).

    • +
    • bpo-28774: Fix error position of the unicode error in ASCII and Latin1 +encoders when a string returned by the error handler contains multiple +non-encodable characters (non-ASCII for the ASCII codec, characters out of +the U+0000-U+00FF range for Latin1).

    • +
    • bpo-28731: Optimize _PyDict_NewPresized() to create correct size dict. +Improve speed of dict literal with constant keys up to 30%.

    • +
    • bpo-28532: Show sys.version when -V option is supplied twice.

    • +
    • bpo-27100: The with-statement now checks for __enter__ before it checks +for __exit__. This gives less confusing error messages when both methods +are missing. Patch by Jonathan Ellington.

    • +
    • bpo-28746: Fix the set_inheritable() file descriptor method on platforms +that do not have the ioctl FIOCLEX and FIONCLEX commands.

    • +
    • bpo-26920: Fix not getting the locale’s charset upon initializing the +interpreter, on platforms that do not have langinfo.

    • +
    • bpo-28648: Fixed crash in Py_DecodeLocale() in debug build on Mac OS X +when decode astral characters. Patch by Xiang Zhang.

    • +
    • bpo-28665: Improve speed of the STORE_DEREF opcode by 40%.

    • +
    • bpo-19398: Extra slash no longer added to sys.path components in case of +empty compile-time PYTHONPATH components.

    • +
    • bpo-28621: Sped up converting int to float by reusing faster bits counting +implementation. Patch by Adrian Wielgosik.

    • +
    • bpo-28580: Optimize iterating split table values. Patch by Xiang Zhang.

    • +
    • bpo-28583: PyDict_SetDefault didn’t combine split table when needed. Patch +by Xiang Zhang.

    • +
    • bpo-28128: Deprecation warning for invalid str and byte escape sequences +now prints better information about where the error occurs. Patch by +Serhiy Storchaka and Eric Smith.

    • +
    • bpo-28509: dict.update() no longer allocate unnecessary large memory.

    • +
    • bpo-28426: Fixed potential crash in PyUnicode_AsDecodedObject() in debug +build.

    • +
    • bpo-28517: Fixed of-by-one error in the peephole optimizer that caused +keeping unreachable code.

    • +
    • bpo-28214: Improved exception reporting for problematic __set_name__ +attributes.

    • +
    • bpo-23782: Fixed possible memory leak in _PyTraceback_Add() and exception +loss in PyTraceBack_Here().

    • +
    • bpo-28183: Optimize and cleanup dict iteration.

    • +
    • bpo-26081: Added C implementation of asyncio.Future. Original patch by +Yury Selivanov.

    • +
    • bpo-28379: Added sanity checks and tests for PyUnicode_CopyCharacters(). +Patch by Xiang Zhang.

    • +
    • bpo-28376: The type of long range iterator is now registered as Iterator. +Patch by Oren Milman.

    • +
    • bpo-28376: Creating instances of range_iterator by calling range_iterator +type now is disallowed. Calling iter() on range instance is the only way. +Patch by Oren Milman.

    • +
    • bpo-26906: Resolving special methods of uninitialized type now causes +implicit initialization of the type instead of a fail.

    • +
    • bpo-18287: PyType_Ready() now checks that tp_name is not NULL. Original +patch by Niklas Koep.

    • +
    • bpo-24098: Fixed possible crash when AST is changed in process of +compiling it.

    • +
    • bpo-28201: Dict reduces possibility of 2nd conflict in hash table when +hashes have same lower bits.

    • +
    • bpo-28350: String constants with null character no longer interned.

    • +
    • bpo-26617: Fix crash when GC runs during weakref callbacks.

    • +
    • bpo-27942: String constants now interned recursively in tuples and +frozensets.

    • +
    • bpo-28289: ImportError.__init__ now resets not specified attributes.

    • +
    • bpo-21578: Fixed misleading error message when ImportError called with +invalid keyword args.

    • +
    • bpo-28203: Fix incorrect type in complex(1.0, {2:3}) error message. Patch +by Soumya Sharma.

    • +
    • bpo-28086: Single var-positional argument of tuple subtype was passed +unscathed to the C-defined function. Now it is converted to exact tuple.

    • +
    • bpo-28214: Now __set_name__ is looked up on the class instead of the +instance.

    • +
    • bpo-27955: Fallback on reading /dev/urandom device when the getrandom() +syscall fails with EPERM, for example when blocked by SECCOMP.

    • +
    • bpo-28192: Don’t import readline in isolated mode.

    • +
    • bpo-27441: Remove some redundant assignments to ob_size in longobject.c. +Thanks Oren Milman.

    • +
    • bpo-27222: Clean up redundant code in long_rshift function. Thanks Oren +Milman.

    • +
    • Upgrade internal unicode databases to Unicode version 9.0.0.

    • +
    • bpo-28131: Fix a regression in zipimport’s compile_source(). zipimport +should use the same optimization level as the interpreter.

    • +
    • bpo-28126: Replace Py_MEMCPY with memcpy(). Visual Studio can properly +optimize memcpy().

    • +
    • bpo-28120: Fix dict.pop() for splitted dictionary when trying to remove a +“pending key” (Not yet inserted in split-table). Patch by Xiang Zhang.

    • +
    • bpo-26182: Raise DeprecationWarning when async and await keywords are used +as variable/attribute/class/function name.

    • +
    • bpo-26182: Fix a refleak in code that raises DeprecationWarning.

    • +
    • bpo-28721: Fix asynchronous generators aclose() and athrow() to handle +StopAsyncIteration propagation properly.

    • +
    • bpo-26110: Speed-up method calls: add LOAD_METHOD and CALL_METHOD opcodes.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-31499: xml.etree: Fix a crash when a parser is part of a reference +cycle.

    • +
    • bpo-31482: random.seed() now works with bytes in version=1

    • +
    • bpo-28556: typing.get_type_hints now finds the right globalns for classes +and modules by default (when no globalns was specified by the caller).

    • +
    • bpo-28556: Speed improvements to the typing module. Original PRs by +Ivan Levkivskyi and Mitar.

    • +
    • bpo-31544: The C accelerator module of ElementTree ignored exceptions +raised when looking up TreeBuilder target methods in XMLParser().

    • +
    • bpo-31234: socket.create_connection() now fixes manually a reference +cycle: clear the variable storing the last exception on success.

    • +
    • bpo-31457: LoggerAdapter objects can now be nested.

    • +
    • bpo-31431: SSLContext.check_hostname now automatically sets +SSLContext.verify_mode to ssl.CERT_REQUIRED instead of failing with a +ValueError.

    • +
    • bpo-31233: socketserver.ThreadingMixIn now keeps a list of non-daemonic +threads to wait until all these threads complete in server_close().

    • +
    • bpo-28638: Changed the implementation strategy for +collections.namedtuple() to substantially reduce the use of exec() in +favor of precomputed methods. As a result, the verbose parameter and +_source attribute are no longer supported. The benefits include 1) +having a smaller memory footprint for applications using multiple named +tuples, 2) faster creation of the named tuple class (approx 4x to 6x +depending on how it is measured), and 3) minor speed-ups for instance +creation using __new__, _make, and _replace. (The primary patch +contributor is Jelle Zijlstra with further improvements by INADA Naoki, +Serhiy Storchaka, and Raymond Hettinger.)

    • +
    • bpo-31400: Improves SSL error handling to avoid losing error numbers.

    • +
    • bpo-27629: Make return types of SSLContext.wrap_bio() and +SSLContext.wrap_socket() customizable.

    • +
    • bpo-28958: ssl.SSLContext() now uses OpenSSL error information when a +context cannot be instantiated.

    • +
    • bpo-28182: The SSL module now raises SSLCertVerificationError when OpenSSL +fails to verify the peer’s certificate. The exception contains more +information about the error.

    • +
    • bpo-27340: SSLSocket.sendall() now uses memoryview to create slices of +data. This fixes support for all bytes-like object. It is also more +efficient and avoids costly copies.

    • +
    • bpo-14191: A new function +argparse.ArgumentParser.parse_intermixed_args provides the ability to +parse command lines where there user intermixes options and positional +arguments.

    • +
    • bpo-31178: Fix string concatenation bug in rare error path in the +subprocess module

    • +
    • bpo-31350: Micro-optimize asyncio._get_running_loop() to become up +to 10% faster.

    • +
    • bpo-31170: expat: Update libexpat from 2.2.3 to 2.2.4. Fix copying of +partial characters for UTF-8 input (libexpat bug 115): +https://github.com/libexpat/libexpat/issues/115

    • +
    • bpo-29136: Add TLS 1.3 cipher suites and OP_NO_TLSv1_3.

    • +
    • bpo-1198569: string.Template subclasses can optionally define +braceidpattern if they want to specify different placeholder patterns +inside and outside the braces. If None (the default) it falls back to +idpattern.

    • +
    • bpo-31326: concurrent.futures.ProcessPoolExecutor.shutdown() now +explicitly closes the call queue. Moreover, shutdown(wait=True) now also +join the call queue thread, to prevent leaking a dangling thread.

    • +
    • bpo-27144: The map() and as_completed() iterators in +concurrent.futures now avoid keeping a reference to yielded objects.

    • +
    • bpo-31281: Fix fileinput.FileInput(files, inplace=True) when files +contain pathlib.Path objects.

    • +
    • bpo-10746: Fix ctypes producing wrong PEP 3118 type codes for integer +types.

    • +
    • bpo-27584: AF_VSOCK has been added to the socket interface which +allows communication between virtual machines and their host.

    • +
    • bpo-22536: The subprocess module now sets the filename when +FileNotFoundError is raised on POSIX systems due to the executable or cwd +not being found.

    • +
    • bpo-29741: Update some methods in the _pyio module to also accept integer +types. Patch by Oren Milman.

    • +
    • bpo-31249: concurrent.futures: WorkItem.run() used by ThreadPoolExecutor +now breaks a reference cycle between an exception object and the WorkItem +object.

    • +
    • bpo-31247: xmlrpc.server now explicitly breaks reference cycles when using +sys.exc_info() in code handling exceptions.

    • +
    • bpo-23835: configparser: reading defaults in the ConfigParser() +constructor is now using read_dict(), making its behavior consistent +with the rest of the parser. Non-string keys and values in the defaults +dictionary are now being implicitly converted to strings. Patch by James +Tocknell.

    • +
    • bpo-31238: pydoc: the stop() method of the private ServerThread class now +waits until DocServer.serve_until_quit() completes and then explicitly +sets its docserver attribute to None to break a reference cycle.

    • +
    • bpo-5001: Many asserts in multiprocessing are now more informative, and +some error types have been changed to more specific ones.

    • +
    • bpo-31109: Convert zipimport to use Argument Clinic.

    • +
    • bpo-30102: The ssl and hashlib modules now call +OPENSSL_add_all_algorithms_noconf() on OpenSSL < 1.1.0. The function +detects CPU features and enables optimizations on some CPU architectures +such as POWER8. Patch is based on research from Gustavo Serra Scalet.

    • +
    • bpo-18966: Non-daemonic threads created by a multiprocessing.Process are +now joined on child exit.

    • +
    • bpo-31183: dis now works with asynchronous generator and coroutine +objects. Patch by George Collins based on diagnosis by Luciano Ramalho.

    • +
    • bpo-5001: There are a number of uninformative asserts in the +multiprocessing module, as noted in issue 5001. This change fixes two of +the most potentially problematic ones, since they are in error-reporting +code, in the multiprocessing.managers.convert_to_error function. (It +also makes more informative a ValueError message.) The only potentially +problematic change is that the AssertionError is now a TypeError; however, +this should also help distinguish it from an AssertionError being +reported by the function/its caller (such as in issue 31169). - Patch by +Allen W. Smith (drallensmith on github).

    • +
    • bpo-31185: Fixed miscellaneous errors in asyncio speedup module.

    • +
    • bpo-31151: socketserver.ForkingMixIn.server_close() now waits until all +child processes completed to prevent leaking zombie processes.

    • +
    • bpo-31072: Add an include_file parameter to +zipapp.create_archive()

    • +
    • bpo-24700: Optimize array.array comparison. It is now from 10x up to 70x +faster when comparing arrays holding values of the same integer type.

    • +
    • bpo-31135: ttk: fix the destroy() method of LabeledScale and OptionMenu +classes. Call the parent destroy() method even if the used attribute +doesn’t exist. The LabeledScale.destroy() method now also explicitly +clears label and scale attributes to help the garbage collector to destroy +all widgets.

    • +
    • bpo-31107: Fix copyreg._slotnames() mangled attribute calculation for +classes whose name begins with an underscore. Patch by Shane Harvey.

    • +
    • bpo-31080: Allow logging.config.fileConfig to accept kwargs and/or args.

    • +
    • bpo-30897: pathlib.Path objects now include an is_mount() method +(only implemented on POSIX). This is similar to os.path.ismount(p). +Patch by Cooper Ry Lees.

    • +
    • bpo-31061: Fixed a crash when using asyncio and threads.

    • +
    • bpo-30987: Added support for CAN ISO-TP protocol in the socket module.

    • +
    • bpo-30522: Added a setStream method to logging.StreamHandler to +allow the stream to be set after creation.

    • +
    • bpo-30502: Fix handling of long oids in ssl. Based on patch by Christian +Heimes.

    • +
    • bpo-5288: Support tzinfo objects with sub-minute offsets.

    • +
    • bpo-30919: Fix shared memory performance regression in multiprocessing in +3.x.

      +

      Shared memory used anonymous memory mappings in 2.x, while 3.x mmaps +actual files. Try to be careful to do as little disk I/O as possible.

      +
    • +
    • bpo-26732: Fix too many fds in processes started with the “forkserver” +method.

      +

      A child process would inherit as many fds as the number of still-running +children.

      +
    • +
    • bpo-29403: Fix unittest.mock’s autospec to not fail on method-bound +builtin functions. Patch by Aaron Gallagher.

    • +
    • bpo-30961: Fix decrementing a borrowed reference in tracemalloc.

    • +
    • bpo-19896: Fix multiprocessing.sharedctypes to recognize typecodes 'q' +and 'Q'.

    • +
    • bpo-30946: Remove obsolete code in readline module for platforms where GNU +readline is older than 2.1 or where select() is not available.

    • +
    • bpo-25684: Change ttk.OptionMenu radiobuttons to be unique across +instances of OptionMenu.

    • +
    • bpo-30886: Fix multiprocessing.Queue.join_thread(): it now waits until the +thread completes, even if the thread was started by the same process which +created the queue.

    • +
    • bpo-29854: Fix segfault in readline when using readline’s history-size +option. Patch by Nir Soffer.

    • +
    • bpo-30794: Added multiprocessing.Process.kill method to terminate using +the SIGKILL signal on Unix.

    • +
    • bpo-30319: socket.close() now ignores ECONNRESET error.

    • +
    • bpo-30828: Fix out of bounds write in +asyncio.CFuture.remove_done_callback().

    • +
    • bpo-30302: Use keywords in the repr of datetime.timedelta.

    • +
    • bpo-30807: signal.setitimer() may disable the timer when passed a tiny +value.

      +

      Tiny values (such as 1e-6) are valid non-zero values for setitimer(), +which is specified as taking microsecond-resolution intervals. However, on +some platform, our conversion routine could convert 1e-6 into a zero +interval, therefore disabling the timer instead of (re-)scheduling it.

      +
    • +
    • bpo-30441: Fix bug when modifying os.environ while iterating over it

    • +
    • bpo-29585: Avoid importing sysconfig from site to improve startup +speed. Python startup is about 5% faster on Linux and 30% faster on macOS.

    • +
    • bpo-29293: Add missing parameter “n” on +multiprocessing.Condition.notify().

      +

      The doc claims multiprocessing.Condition behaves like threading.Condition, +but its notify() method lacked the optional “n” argument (to specify the +number of sleepers to wake up) that threading.Condition.notify() accepts.

      +
    • +
    • bpo-30532: Fix email header value parser dropping folding white space in +certain cases.

    • +
    • bpo-30596: Add a close() method to multiprocessing.Process.

    • +
    • bpo-9146: Fix a segmentation fault in _hashopenssl when standard hash +functions such as md5 are not available in the linked OpenSSL library. As +in some special FIPS-140 build environments.

    • +
    • bpo-29169: Update zlib to 1.2.11.

    • +
    • bpo-30119: ftplib.FTP.putline() now throws ValueError on commands that +contains CR or LF. Patch by Dong-hee Na.

    • +
    • bpo-30879: os.listdir() and os.scandir() now emit bytes names when called +with bytes-like argument.

    • +
    • bpo-30746: Prohibited the ‘=’ character in environment variable names in +os.putenv() and os.spawn*().

    • +
    • bpo-30664: The description of a unittest subtest now preserves the order +of keyword arguments of TestCase.subTest().

    • +
    • bpo-21071: struct.Struct.format type is now str instead of +bytes.

    • +
    • bpo-29212: Fix concurrent.futures.thread.ThreadPoolExecutor threads to +have a non repr() based thread name by default when no thread_name_prefix +is supplied. They will now identify themselves as +“ThreadPoolExecutor-y_n”.

    • +
    • bpo-29755: Fixed the lgettext() family of functions in the gettext module. +They now always return bytes.

    • +
    • bpo-30616: Functional API of enum allows to create empty enums. Patched by +Dong-hee Na

    • +
    • bpo-30038: Fix race condition between signal delivery and wakeup file +descriptor. Patch by Nathaniel Smith.

    • +
    • bpo-23894: lib2to3 now recognizes rb'...' and f'...' strings.

    • +
    • bpo-24744: pkgutil.walk_packages function now raises ValueError if path +is a string. Patch by Sanyam Khurana.

    • +
    • bpo-24484: Avoid race condition in multiprocessing cleanup.

    • +
    • bpo-30589: Fix multiprocessing.Process.exitcode to return the opposite of +the signal number when the process is killed by a signal (instead of 255) +when using the “forkserver” method.

    • +
    • bpo-28994: The traceback no longer displayed for SystemExit raised in a +callback registered by atexit.

    • +
    • bpo-30508: Don’t log exceptions if Task/Future “cancel()” method was +called.

    • +
    • bpo-30645: Fix path calculation in imp.load_package(), fixing it for +cases when a package is only shipped with bytecodes. Patch by Alexandru +Ardelean.

    • +
    • bpo-11822: The dis.dis() function now is able to disassemble nested code +objects.

    • +
    • bpo-30624: selectors does not take KeyboardInterrupt and SystemExit into +account, leaving a fd in a bad state in case of error. Patch by Giampaolo +Rodola’.

    • +
    • bpo-30595: multiprocessing.Queue.get() with a timeout now polls its reader +in non-blocking mode if it succeeded to acquire the lock but the acquire +took longer than the timeout.

    • +
    • bpo-28556: Updates to typing module: Add generic AsyncContextManager, add +support for ContextManager on all versions. Original PRs by Jelle Zijlstra +and Ivan Levkivskyi

    • +
    • bpo-30605: re.compile() no longer raises a BytesWarning when compiling a +bytes instance with misplaced inline modifier. Patch by Roy Williams.

    • +
    • bpo-29870: Fix ssl sockets leaks when connection is aborted in asyncio/ssl +implementation. Patch by Michaël Sghaïer.

    • +
    • bpo-29743: Closing transport during handshake process leaks open socket. +Patch by Nikolay Kim

    • +
    • bpo-27585: Fix waiter cancellation in asyncio.Lock. Patch by Mathieu +Sornay.

    • +
    • bpo-30014: modify() method of poll(), epoll() and devpoll() based classes +of selectors module is around 10% faster. Patch by Giampaolo Rodola’.

    • +
    • bpo-30418: On Windows, subprocess.Popen.communicate() now also ignore +EINVAL on stdin.write() if the child process is still running but closed +the pipe.

    • +
    • bpo-30463: Addded empty __slots__ to abc.ABC. This allows subclassers to +deny __dict__ and __weakref__ creation. Patch by Aaron Hall.

    • +
    • bpo-30520: Loggers are now pickleable.

    • +
    • bpo-30557: faulthandler now correctly filters and displays exception codes +on Windows

    • +
    • bpo-30526: Add TextIOWrapper.reconfigure() and a +TextIOWrapper.write_through attribute.

    • +
    • bpo-30245: Fix possible overflow when organize struct.pack_into error +message. Patch by Yuan Liu.

    • +
    • bpo-30378: Fix the problem that logging.handlers.SysLogHandler cannot +handle IPv6 addresses.

    • +
    • bpo-16500: Allow registering at-fork handlers.

    • +
    • bpo-30470: Deprecate invalid ctypes call protection on Windows. Patch by +Mariatta Wijaya.

    • +
    • bpo-30414: multiprocessing.Queue._feed background running thread do not +break from main loop on exception.

    • +
    • bpo-30003: Fix handling escape characters in HZ codec. Based on patch by +Ma Lin.

    • +
    • bpo-30149: inspect.signature() now supports callables with +variable-argument parameters wrapped with partialmethod. Patch by Dong-hee +Na.

    • +
    • bpo-30436: importlib.find_spec() raises ModuleNotFoundError instead of +AttributeError if the specified parent module is not a package (i.e. lacks +a __path__ attribute).

    • +
    • bpo-30301: Fix AttributeError when using SimpleQueue.empty() under spawn +and forkserver start methods.

    • +
    • bpo-30375: Warnings emitted when compile a regular expression now always +point to the line in the user code. Previously they could point into +inners of the re module if emitted from inside of groups or conditionals.

    • +
    • bpo-30329: imaplib and poplib now catch the Windows socket WSAEINVAL error +(code 10022) on shutdown(SHUT_RDWR): An invalid operation was attempted. +This error occurs sometimes on SSL connections.

    • +
    • bpo-29196: Removed previously deprecated in Python 2.4 classes Plist, Dict +and _InternalDict in the plistlib module. Dict values in the result of +functions readPlist() and readPlistFromBytes() are now normal dicts. You +no longer can use attribute access to access items of these dictionaries.

    • +
    • bpo-9850: The macpath is now deprecated and will be removed in +Python 3.8.

    • +
    • bpo-30299: Compiling regular expression in debug mode on CPython now +displays the compiled bytecode in human readable form.

    • +
    • bpo-30048: Fixed Task.cancel() can be ignored when the task is running +coroutine and the coroutine returned without any more await.

    • +
    • bpo-30266: contextlib.AbstractContextManager now supports +anti-registration by setting __enter__ = None or __exit__ = None, +following the pattern introduced in bpo-25958. Patch by Jelle Zijlstra.

    • +
    • bpo-30340: Enhanced regular expressions optimization. This increased the +performance of matching some patterns up to 25 times.

    • +
    • bpo-30298: Weaken the condition of deprecation warnings for inline +modifiers. Now allowed several subsequential inline modifiers at the start +of the pattern (e.g. '(?i)(?s)...'). In verbose mode whitespaces and +comments now are allowed before and between inline modifiers (e.g. '(?x) +(?i) (?s)...').

    • +
    • bpo-30285: Optimized case-insensitive matching and searching of regular +expressions.

    • +
    • bpo-29990: Fix range checking in GB18030 decoder. Original patch by Ma +Lin.

    • +
    • bpo-29979: rewrite cgi.parse_multipart, reusing the FieldStorage class and +making its results consistent with those of FieldStorage for +multipart/form-data requests. Patch by Pierre Quentel.

    • +
    • bpo-30243: Removed the __init__ methods of _json’s scanner and encoder. +Misusing them could cause memory leaks or crashes. Now scanner and +encoder objects are completely initialized in the __new__ methods.

    • +
    • bpo-30215: Compiled regular expression objects with the re.LOCALE flag no +longer depend on the locale at compile time. Only the locale at matching +time affects the result of matching.

    • +
    • bpo-30185: Avoid KeyboardInterrupt tracebacks in forkserver helper process +when Ctrl-C is received.

    • +
    • bpo-30103: binascii.b2a_uu() and uu.encode() now support using '`' as +zero instead of space.

    • +
    • bpo-28556: Various updates to typing module: add typing.NoReturn type, use +WrapperDescriptorType, minor bug-fixes. Original PRs by Jim +Fasarakis-Hilliard and Ivan Levkivskyi.

    • +
    • bpo-30205: Fix getsockname() for unbound AF_UNIX sockets on Linux.

    • +
    • bpo-30228: The seek() and tell() methods of io.FileIO now set the internal +seekable attribute to avoid one syscall on open() (in buffered or text +mode).

    • +
    • bpo-30190: unittest’s assertAlmostEqual and assertNotAlmostEqual provide a +better message in case of failure which includes the difference between +left and right arguments. (patch by Giampaolo Rodola’)

    • +
    • bpo-30101: Add support for curses.A_ITALIC.

    • +
    • bpo-29822: inspect.isabstract() now works during __init_subclass__. Patch +by Nate Soares.

    • +
    • bpo-29960: Preserve generator state when _random.Random.setstate() raises +an exception. Patch by Bryan Olson.

    • +
    • bpo-30070: Fixed leaks and crashes in errors handling in the parser +module.

    • +
    • bpo-22352: Column widths in the output of dis.dis() are now adjusted for +large line numbers and instruction offsets.

    • +
    • bpo-30061: Fixed crashes in IOBase methods __next__() and readlines() when +readline() or __next__() respectively return non-sizeable object. Fixed +possible other errors caused by not checking results of PyObject_Size(), +PySequence_Size(), or PyMapping_Size().

    • +
    • bpo-30218: Fix PathLike support for shutil.unpack_archive. Patch by Jelle +Zijlstra.

    • +
    • bpo-10076: Compiled regular expression and match objects in the re module +now support copy.copy() and copy.deepcopy() (they are considered atomic).

    • +
    • bpo-30068: _io._IOBase.readlines will check if it’s closed first when hint +is present.

    • +
    • bpo-29694: Fixed race condition in pathlib mkdir with flags parents=True. +Patch by Armin Rigo.

    • +
    • bpo-29692: Fixed arbitrary unchaining of RuntimeError exceptions in +contextlib.contextmanager. Patch by Siddharth Velankar.

    • +
    • bpo-26187: Test that sqlite3 trace callback is not called multiple times +when schema is changing. Indirectly fixed by switching to use +sqlite3_prepare_v2() in bpo-9303. Patch by Aviv Palivoda.

    • +
    • bpo-30017: Allowed calling the close() method of the zip entry writer +object multiple times. Writing to a closed writer now always produces a +ValueError.

    • +
    • bpo-29998: Pickling and copying ImportError now preserves name and path +attributes.

    • +
    • bpo-29995: re.escape() now escapes only regex special characters.

    • +
    • bpo-29962: Add math.remainder operation, implementing remainder as +specified in IEEE 754.

    • +
    • bpo-29649: Improve struct.pack_into() exception messages for problems with +the buffer size and offset. Patch by Andrew Nester.

    • +
    • bpo-29654: Support If-Modified-Since HTTP header (browser cache). Patch +by Pierre Quentel.

    • +
    • bpo-29931: Fixed comparison check for ipaddress.ip_interface objects. +Patch by Sanjay Sundaresan.

    • +
    • bpo-29953: Fixed memory leaks in the replace() method of datetime and time +objects when pass out of bound fold argument.

    • +
    • bpo-29942: Fix a crash in itertools.chain.from_iterable when encountering +long runs of empty iterables.

    • +
    • bpo-10030: Sped up reading encrypted ZIP files by 2 times.

    • +
    • bpo-29204: Element.getiterator() and the html parameter of XMLParser() +were deprecated only in the documentation (since Python 3.2 and 3.4 +correspondintly). Now using them emits a deprecation warning.

    • +
    • bpo-27863: Fixed multiple crashes in ElementTree caused by race conditions +and wrong types.

    • +
    • bpo-25996: Added support of file descriptors in os.scandir() on Unix. +os.fwalk() is sped up by 2 times by using os.scandir().

    • +
    • bpo-28699: Fixed a bug in pools in multiprocessing.pool that raising an +exception at the very first of an iterable may swallow the exception or +make the program hang. Patch by Davin Potts and Xiang Zhang.

    • +
    • bpo-23890: unittest.TestCase.assertRaises() now manually breaks a +reference cycle to not keep objects alive longer than expected.

    • +
    • bpo-29901: The zipapp module now supports general path-like objects, not +just pathlib.Path.

    • +
    • bpo-25803: Avoid incorrect errors raised by Path.mkdir(exist_ok=True) when +the OS gives priority to errors such as EACCES over EEXIST.

    • +
    • bpo-29861: Release references to tasks, their arguments and their results +as soon as they are finished in multiprocessing.Pool.

    • +
    • bpo-19930: The mode argument of os.makedirs() no longer affects the file +permission bits of newly-created intermediate-level directories.

    • +
    • bpo-29884: faulthandler: Restore the old sigaltstack during teardown. +Patch by Christophe Zeitouny.

    • +
    • bpo-25455: Fixed crashes in repr of recursive buffered file-like objects.

    • +
    • bpo-29800: Fix crashes in partial.__repr__ if the keys of partial.keywords +are not strings. Patch by Michael Seifert.

    • +
    • bpo-8256: Fixed possible failing or crashing input() if attributes +“encoding” or “errors” of sys.stdin or sys.stdout are not set or are not +strings.

    • +
    • bpo-28692: Using non-integer value for selecting a plural form in gettext +is now deprecated.

    • +
    • bpo-26121: Use C library implementation for math functions erf() and +erfc().

    • +
    • bpo-29619: os.stat() and os.DirEntry.inode() now convert inode (st_ino) +using unsigned integers.

    • +
    • bpo-28298: Fix a bug that prevented array ‘Q’, ‘L’ and ‘I’ from accepting +big intables (objects that have __int__) as elements.

    • +
    • bpo-29645: Speed up importing the webbrowser module. +webbrowser.register() is now thread-safe.

    • +
    • bpo-28231: The zipfile module now accepts path-like objects for external +paths.

    • +
    • bpo-26915: index() and count() methods of collections.abc.Sequence now +check identity before checking equality when do comparisons.

    • +
    • bpo-28682: Added support for bytes paths in os.fwalk().

    • +
    • bpo-29728: Add new socket.TCP_NOTSENT_LOWAT (Linux 3.12) constant. +Patch by Nathaniel J. Smith.

    • +
    • bpo-29623: Allow use of path-like object as a single argument in +ConfigParser.read(). Patch by David Ellis.

    • +
    • bpo-9303: Migrate sqlite3 module to _v2 API. Patch by Aviv Palivoda.

    • +
    • bpo-28963: Fix out of bound iteration in +asyncio.Future.remove_done_callback implemented in C.

    • +
    • bpo-29704: asyncio.subprocess.SubprocessStreamProtocol no longer closes +before all pipes are closed.

    • +
    • bpo-29271: Fix Task.current_task and Task.all_tasks implemented in C to +accept None argument as their pure Python implementation.

    • +
    • bpo-29703: Fix asyncio to support instantiation of new event loops in +child processes.

    • +
    • bpo-29615: SimpleXMLRPCDispatcher no longer chains KeyError (or any other +exception) to exception(s) raised in the dispatched methods. Patch by Petr +Motejlek.

    • +
    • bpo-7769: Method register_function() of +xmlrpc.server.SimpleXMLRPCDispatcher and its subclasses can now be used as +a decorator.

    • +
    • bpo-29376: Fix assertion error in threading._DummyThread.is_alive().

    • +
    • bpo-28624: Add a test that checks that cwd parameter of Popen() accepts +PathLike objects. Patch by Sayan Chowdhury.

    • +
    • bpo-28518: Start a transaction implicitly before a DML statement. Patch by +Aviv Palivoda.

    • +
    • bpo-29742: get_extra_info() raises exception if get called on closed ssl +transport. Patch by Nikolay Kim.

    • +
    • bpo-16285: urllib.parse.quote is now based on RFC 3986 and hence includes +‘~’ in the set of characters that is not quoted by default. Patch by +Christian Theune and Ratnadeep Debnath.

    • +
    • bpo-29532: Altering a kwarg dictionary passed to functools.partial() no +longer affects a partial object after creation.

    • +
    • bpo-29110: Fix file object leak in aifc.open() when file is given as a +filesystem path and is not in valid AIFF format. Patch by Anthony Zhang.

    • +
    • bpo-22807: Add uuid.SafeUUID and uuid.UUID.is_safe to relay information +from the platform about whether generated UUIDs are generated with a +multiprocessing safe method.

    • +
    • bpo-29576: Improve some deprecations in importlib. Some deprecated methods +now emit DeprecationWarnings and have better descriptive messages.

    • +
    • bpo-29534: Fixed different behaviour of Decimal.from_float() for _decimal +and _pydecimal. Thanks Andrew Nester.

    • +
    • bpo-10379: locale.format_string now supports the ‘monetary’ keyword +argument, and locale.format is deprecated.

    • +
    • bpo-29851: importlib.reload() now raises ModuleNotFoundError if the module +lacks a spec.

    • +
    • bpo-28556: Various updates to typing module: typing.Counter, +typing.ChainMap, improved ABC caching, etc. Original PRs by Jelle +Zijlstra, Ivan Levkivskyi, Manuel Krebber, and Łukasz Langa.

    • +
    • bpo-29100: Fix datetime.fromtimestamp() regression introduced in Python +3.6.0: check minimum and maximum years.

    • +
    • bpo-29416: Prevent infinite loop in pathlib.Path.mkdir

    • +
    • bpo-29444: Fixed out-of-bounds buffer access in the group() method of the +match object. Based on patch by WGH.

    • +
    • bpo-29377: Add WrapperDescriptorType, MethodWrapperType, and +MethodDescriptorType built-in types to types module. Original patch by +Manuel Krebber.

    • +
    • bpo-29218: Unused install_misc command is now removed. It has been +documented as unused since 2000. Patch by Eric N. Vander Weele.

    • +
    • bpo-29368: The extend() method is now called instead of the append() +method when unpickle collections.deque and other list-like objects. This +can speed up unpickling to 2 times.

    • +
    • bpo-29338: The help of a builtin or extension class now includes the +constructor signature if __text_signature__ is provided for the class.

    • +
    • bpo-29335: Fix subprocess.Popen.wait() when the child process has exited +to a stopped instead of terminated state (ex: when under ptrace).

    • +
    • bpo-29290: Fix a regression in argparse that help messages would wrap at +non-breaking spaces.

    • +
    • bpo-28735: Fixed the comparison of mock.MagickMock with mock.ANY.

    • +
    • bpo-29197: Removed deprecated function ntpath.splitunc().

    • +
    • bpo-29210: Removed support of deprecated argument “exclude” in +tarfile.TarFile.add().

    • +
    • bpo-29219: Fixed infinite recursion in the repr of uninitialized +ctypes.CDLL instances.

    • +
    • bpo-29192: Removed deprecated features in the http.cookies module.

    • +
    • bpo-29193: A format string argument for string.Formatter.format() is now +positional-only.

    • +
    • bpo-29195: Removed support of deprecated undocumented keyword arguments in +methods of regular expression objects.

    • +
    • bpo-28969: Fixed race condition in C implementation of +functools.lru_cache. KeyError could be raised when cached function with +full cache was simultaneously called from differen threads with the same +uncached arguments.

    • +
    • bpo-20804: The unittest.mock.sentinel attributes now preserve their +identity when they are copied or pickled.

    • +
    • bpo-29142: In urllib.request, suffixes in no_proxy environment variable +with leading dots could match related hostnames again (e.g. .b.c matches +a.b.c). Patch by Milan Oberkirch.

    • +
    • bpo-28961: Fix unittest.mock._Call helper: don’t ignore the name parameter +anymore. Patch written by Jiajun Huang.

    • +
    • bpo-15812: inspect.getframeinfo() now correctly shows the first line of a +context. Patch by Sam Breese.

    • +
    • bpo-28985: Update authorizer constants in sqlite3 module. Patch by +Dingyuan Wang.

    • +
    • bpo-29079: Prevent infinite loop in pathlib.resolve() on Windows

    • +
    • bpo-13051: Fixed recursion errors in large or resized +curses.textpad.Textbox. Based on patch by Tycho Andersen.

    • +
    • bpo-9770: curses.ascii predicates now work correctly with negative +integers.

    • +
    • bpo-28427: old keys should not remove new values from WeakValueDictionary +when collecting from another thread.

    • +
    • bpo-28923: Remove editor artifacts from Tix.py.

    • +
    • bpo-28871: Fixed a crash when deallocate deep ElementTree.

    • +
    • bpo-19542: Fix bugs in WeakValueDictionary.setdefault() and +WeakValueDictionary.pop() when a GC collection happens in another thread.

    • +
    • bpo-20191: Fixed a crash in resource.prlimit() when passing a sequence +that doesn’t own its elements as limits.

    • +
    • bpo-16255: subprocess.Popen uses /system/bin/sh on Android as the shell, +instead of /bin/sh.

    • +
    • bpo-28779: multiprocessing.set_forkserver_preload() would crash the +forkserver process if a preloaded module instantiated some multiprocessing +objects such as locks.

    • +
    • bpo-26937: The chown() method of the tarfile.TarFile class does not fail +now when the grp module cannot be imported, as for example on Android +platforms.

    • +
    • bpo-28847: dbm.dumb now supports reading read-only files and no longer +writes the index file when it is not changed. A deprecation warning is +now emitted if the index file is missed and recreated in the ‘r’ and ‘w’ +modes (will be an error in future Python releases).

    • +
    • bpo-27030: Unknown escapes consisting of '\' and an ASCII letter in +re.sub() replacement templates regular expressions now are errors.

    • +
    • bpo-28835: Fix a regression introduced in warnings.catch_warnings(): call +warnings.showwarning() if it was overridden inside the context manager.

    • +
    • bpo-27172: To assist with upgrades from 2.7, the previously documented +deprecation of inspect.getfullargspec() has been reversed. This +decision may be revisited again after the Python 2.7 branch is no longer +officially supported.

    • +
    • bpo-28740: Add sys.getandroidapilevel(): return the build time API version +of Android as an integer. Function only available on Android.

    • +
    • bpo-26273: Add new socket.TCP_CONGESTION (Linux 2.6.13) and +socket.TCP_USER_TIMEOUT (Linux 2.6.37) constants. Patch written by +Omar Sandoval.

    • +
    • bpo-28752: Restored the __reduce__() methods of datetime objects.

    • +
    • bpo-28727: Regular expression patterns, _sre.SRE_Pattern objects created +by re.compile(), become comparable (only x==y and x!=y operators). This +change should fix the bpo-18383: don’t duplicate warning filters when +the warnings module is reloaded (thing usually only done in unit tests).

    • +
    • bpo-20572: Remove the subprocess.Popen.wait endtime parameter. It was +deprecated in 3.4 and undocumented prior to that.

    • +
    • bpo-25659: In ctypes, prevent a crash calling the from_buffer() and +from_buffer_copy() methods on abstract classes like Array.

    • +
    • bpo-28548: In the “http.server” module, parse the protocol version if +possible, to avoid using HTTP 0.9 in some error responses.

    • +
    • bpo-19717: Makes Path.resolve() succeed on paths that do not exist. Patch +by Vajrasky Kok

    • +
    • bpo-28563: Fixed possible DoS and arbitrary code execution when handle +plural form selections in the gettext module. The expression parser now +supports exact syntax supported by GNU gettext.

    • +
    • bpo-28387: Fixed possible crash in _io.TextIOWrapper deallocator when the +garbage collector is invoked in other thread. Based on patch by Sebastian +Cufre.

    • +
    • bpo-27517: LZMA compressor and decompressor no longer raise exceptions if +given empty data twice. Patch by Benjamin Fogle.

    • +
    • bpo-28549: Fixed segfault in curses’s addch() with ncurses6.

    • +
    • bpo-28449: tarfile.open() with mode “r” or “r:” now tries to open a tar +file with compression before trying to open it without compression. +Otherwise it had 50% chance failed with ignore_zeros=True.

    • +
    • bpo-23262: The webbrowser module now supports Firefox 36+ and derived +browsers. Based on patch by Oleg Broytman.

    • +
    • bpo-24241: The webbrowser in an X environment now prefers using the +default browser directly. Also, the webbrowser register() function now has +a documented ‘preferred’ argument, to specify browsers to be returned by +get() with no arguments. Patch by David Steele

    • +
    • bpo-27939: Fixed bugs in tkinter.ttk.LabeledScale and tkinter.Scale caused +by representing the scale as float value internally in Tk. tkinter.IntVar +now works if float value is set to underlying Tk variable.

    • +
    • bpo-28255: calendar.TextCalendar.prweek() no longer prints a space after a +weeks’s calendar. calendar.TextCalendar.pryear() no longer prints +redundant newline after a year’s calendar. Based on patch by Xiang Zhang.

    • +
    • bpo-28255: calendar.TextCalendar.prmonth() no longer prints a space at the +start of new line after printing a month’s calendar. Patch by Xiang +Zhang.

    • +
    • bpo-20491: The textwrap.TextWrapper class now honors non-breaking spaces. +Based on patch by Kaarle Ritvanen.

    • +
    • bpo-28353: os.fwalk() no longer fails on broken links.

    • +
    • bpo-28430: Fix iterator of C implemented asyncio.Future doesn’t accept +non-None value is passed to it.send(val).

    • +
    • bpo-27025: Generated names for Tkinter widgets now start by the “!” prefix +for readability.

    • +
    • bpo-25464: Fixed HList.header_exists() in tkinter.tix module by addin a +workaround to Tix library bug.

    • +
    • bpo-28488: shutil.make_archive() no longer adds entry “./” to ZIP archive.

    • +
    • bpo-25953: re.sub() now raises an error for invalid numerical group +reference in replacement template even if the pattern is not found in the +string. Error message for invalid group reference now includes the group +index and the position of the reference. Based on patch by SilentGhost.

    • +
    • bpo-28469: timeit now uses the sequence 1, 2, 5, 10, 20, 50,… instead of +1, 10, 100,… for autoranging.

    • +
    • bpo-28115: Command-line interface of the zipfile module now uses argparse. +Added support of long options.

    • +
    • bpo-18219: Optimize csv.DictWriter for large number of columns. Patch by +Mariatta Wijaya.

    • +
    • bpo-28448: Fix C implemented asyncio.Future didn’t work on Windows.

    • +
    • bpo-23214: In the “io” module, the argument to BufferedReader and +BytesIO’s read1() methods is now optional and can be -1, matching the +BufferedIOBase specification.

    • +
    • bpo-28480: Fix error building socket module when multithreading is +disabled.

    • +
    • bpo-28240: timeit: remove -c/--clock and -t/--time command line +options which were deprecated since Python 3.3.

    • +
    • bpo-28240: timeit now repeats the benchmarks 5 times instead of only 3 to +make benchmarks more reliable.

    • +
    • bpo-28240: timeit autorange now uses a single loop iteration if the +benchmark takes less than 10 seconds, instead of 10 iterations. “python3 +-m timeit -s ‘import time’ ‘time.sleep(1)’” now takes 4 seconds instead of +40 seconds.

    • +
    • Distutils.sdist now looks for README and setup.py files with case +sensitivity. This behavior matches that found in Setuptools 6.0 and later. +See setuptools 100 for +rationale.

    • +
    • bpo-24452: Make webbrowser support Chrome on Mac OS X. Patch by Ned +Batchelder.

    • +
    • bpo-20766: Fix references leaked by pdb in the handling of SIGINT +handlers.

    • +
    • bpo-27998: Fixed bytes path support in os.scandir() on Windows. Patch by +Eryk Sun.

    • +
    • bpo-28317: The disassembler now decodes FORMAT_VALUE argument.

    • +
    • bpo-28380: unittest.mock Mock autospec functions now properly support +assert_called, assert_not_called, and assert_called_once.

    • +
    • bpo-28229: lzma module now supports pathlib.

    • +
    • bpo-28321: Fixed writing non-BMP characters with binary format in +plistlib.

    • +
    • bpo-28225: bz2 module now supports pathlib. Initial patch by Ethan +Furman.

    • +
    • bpo-28227: gzip now supports pathlib. Patch by Ethan Furman.

    • +
    • bpo-28332: Deprecated silent truncations in socket.htons and socket.ntohs. +Original patch by Oren Milman.

    • +
    • bpo-27358: Optimized merging var-keyword arguments and improved error +message when passing a non-mapping as a var-keyword argument.

    • +
    • bpo-28257: Improved error message when passing a non-iterable as a +var-positional argument. Added opcode BUILD_TUPLE_UNPACK_WITH_CALL.

    • +
    • bpo-28322: Fixed possible crashes when unpickle itertools objects from +incorrect pickle data. Based on patch by John Leitch.

    • +
    • bpo-28228: imghdr now supports pathlib.

    • +
    • bpo-28226: compileall now supports pathlib.

    • +
    • bpo-28314: Fix function declaration (C flags) for the getiterator() method +of xml.etree.ElementTree.Element.

    • +
    • bpo-28148: Stop using localtime() and gmtime() in the time module.

      +

      Introduced platform independent _PyTime_localtime API that is similar to +POSIX localtime_r, but available on all platforms. Patch by Ed Schouten.

      +
    • +
    • bpo-28253: Fixed calendar functions for extreme months: 0001-01 and +9999-12.

      +

      Methods itermonthdays() and itermonthdays2() are reimplemented so that +they don’t call itermonthdates() which can cause datetime.date +under/overflow.

      +
    • +
    • bpo-28275: Fixed possible use after free in the decompress() methods of +the LZMADecompressor and BZ2Decompressor classes. Original patch by John +Leitch.

    • +
    • bpo-27897: Fixed possible crash in sqlite3.Connection.create_collation() +if pass invalid string-like object as a name. Patch by Xiang Zhang.

    • +
    • bpo-18844: random.choices() now has k as a keyword-only argument to +improve the readability of common cases and come into line with the +signature used in other languages.

    • +
    • bpo-18893: Fix invalid exception handling in Lib/ctypes/macholib/dyld.py. +Patch by Madison May.

    • +
    • bpo-27611: Fixed support of default root window in the tkinter.tix module. +Added the master parameter in the DisplayStyle constructor.

    • +
    • bpo-27348: In the traceback module, restore the formatting of exception +messages like “Exception: None”. This fixes a regression introduced in +3.5a2.

    • +
    • bpo-25651: Allow falsy values to be used for msg parameter of subTest().

    • +
    • bpo-27778: Fix a memory leak in os.getrandom() when the getrandom() is +interrupted by a signal and a signal handler raises a Python exception.

    • +
    • bpo-28200: Fix memory leak on Windows in the os module (fix +path_converter() function).

    • +
    • bpo-25400: RobotFileParser now correctly returns default values for +crawl_delay and request_rate. Initial patch by Peter Wirtz.

    • +
    • bpo-27932: Prevent memory leak in win32_ver().

    • +
    • Fix UnboundLocalError in socket._sendfile_use_sendfile.

    • +
    • bpo-28075: Check for ERROR_ACCESS_DENIED in Windows implementation of +os.stat(). Patch by Eryk Sun.

    • +
    • bpo-22493: Warning message emitted by using inline flags in the middle of +regular expression now contains a (truncated) regex pattern. Patch by Tim +Graham.

    • +
    • bpo-25270: Prevent codecs.escape_encode() from raising SystemError when an +empty bytestring is passed.

    • +
    • bpo-28181: Get antigravity over HTTPS. Patch by Kaartic Sivaraam.

    • +
    • bpo-25895: Enable WebSocket URL schemes in urllib.parse.urljoin. Patch by +Gergely Imreh and Markus Holtermann.

    • +
    • bpo-28114: Fix a crash in parse_envlist() when env contains byte strings. +Patch by Eryk Sun.

    • +
    • bpo-27599: Fixed buffer overrun in binascii.b2a_qp() and +binascii.a2b_qp().

    • +
    • bpo-27906: Fix socket accept exhaustion during high TCP traffic. Patch by +Kevin Conway.

    • +
    • bpo-28174: Handle when SO_REUSEPORT isn’t properly supported. Patch by +Seth Michael Larson.

    • +
    • bpo-26654: Inspect functools.partial in asyncio.Handle.__repr__. Patch by +iceboy.

    • +
    • bpo-26909: Fix slow pipes IO in asyncio. Patch by INADA Naoki.

    • +
    • bpo-28176: Fix callbacks race in asyncio.SelectorLoop.sock_connect.

    • +
    • bpo-27759: Fix selectors incorrectly retain invalid file descriptors. +Patch by Mark Williams.

    • +
    • bpo-28325: Remove vestigial MacOS 9 macurl2path module and its tests.

    • +
    • bpo-28368: Refuse monitoring processes if the child watcher has no loop +attached. Patch by Vincent Michel.

    • +
    • bpo-28369: Raise RuntimeError when transport’s FD is used with add_reader, +add_writer, etc.

    • +
    • bpo-28370: Speedup asyncio.StreamReader.readexactly. Patch by Коренберг +Марк.

    • +
    • bpo-28371: Deprecate passing asyncio.Handles to run_in_executor.

    • +
    • bpo-28372: Fix asyncio to support formatting of non-python coroutines.

    • +
    • bpo-28399: Remove UNIX socket from FS before binding. Patch by Коренберг +Марк.

    • +
    • bpo-27972: Prohibit Tasks to await on themselves.

    • +
    • bpo-24142: Reading a corrupt config file left configparser in an invalid +state. Original patch by Florian Höch.

    • +
    • bpo-29581: ABCMeta.__new__ now accepts **kwargs, allowing abstract +base classes to use keyword parameters in __init_subclass__. Patch by Nate +Soares.

    • +
    • bpo-25532: inspect.unwrap() will now only try to unwrap an object +sys.getrecursionlimit() times, to protect against objects which create a +new object on every attribute access.

    • +
    • bpo-30177: path.resolve(strict=False) no longer cuts the path after the +first element not present in the filesystem. Patch by Antoine Pietri.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-31294: Fix incomplete code snippet in the ZeroMQSocketListener and +ZeroMQSocketHandler examples and adapt them to Python 3.

    • +
    • bpo-21649: Add RFC 7525 and Mozilla server side TLS links to SSL +documentation.

    • +
    • bpo-31128: Allow the pydoc server to bind to arbitrary hostnames.

    • +
    • bpo-30803: Clarify doc on truth value testing. Original patch by Peter +Thomassen.

    • +
    • bpo-30176: Add missing attribute related constants in curses +documentation.

    • +
    • bpo-30052: the link targets for bytes() and bytearray() are +now their respective type definitions, rather than the corresponding +builtin function entries. Use bytes and +bytearray to reference the latter.

      +

      In order to ensure this and future cross-reference updates are applied +automatically, the daily documentation builds now disable the default +output caching features in Sphinx.

      +
    • +
    • bpo-26985: Add missing info of code object in inspect documentation.

    • +
    • bpo-19824: Improve the documentation for, and links to, template strings +by emphasizing their utility for internationalization, and by clarifying +some usage constraints. (See also: bpo-20314, bpo-12518)

    • +
    • bpo-28929: Link the documentation to its source file on GitHub.

    • +
    • bpo-25008: Document smtpd.py as effectively deprecated and add a pointer +to aiosmtpd, a third-party asyncio-based replacement.

    • +
    • bpo-26355: Add canonical header link on each page to corresponding major +version of the documentation. Patch by Matthias Bussonnier.

    • +
    • bpo-29349: Fix Python 2 syntax in code for building the documentation.

    • +
    • bpo-23722: The data model reference and the porting section in the 3.6 +What’s New guide now cover the additional __classcell__ handling +needed for custom metaclasses to fully support PEP 487 and zero-argument +super().

    • +
    • bpo-28513: Documented command-line interface of zipfile.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-29639: test.support.HOST is now “localhost”, a new HOSTv4 constant has +been added for your 127.0.0.1 needs, similar to the existing HOSTv6 +constant.

    • +
    • bpo-31320: Silence traceback in test_ssl

    • +
    • bpo-31346: Prefer PROTOCOL_TLS_CLIENT and PROTOCOL_TLS_SERVER protocols +for SSLContext.

    • +
    • bpo-25674: Remove sha256.tbs-internet.com ssl test

    • +
    • bpo-30715: Address ALPN callback changes for OpenSSL 1.1.0f. The latest +version behaves like OpenSSL 1.0.2 and no longer aborts handshake.

    • +
    • bpo-30822: regrtest: Exclude tzdata from regrtest –all. When running the +test suite using –use=all / -u all, exclude tzdata since it makes +test_datetime too slow (15-20 min on some buildbots) which then times out +on some buildbots. Fix also regrtest command line parser to allow passing +-u extralargefile to run test_zipfile64.

    • +
    • bpo-30695: Add the set_nomemory(start, stop) and remove_mem_hooks() +functions to the _testcapi module.

    • +
    • bpo-30357: test_thread: setUp() now uses support.threading_setup() and +support.threading_cleanup() to wait until threads complete to avoid random +side effects on following tests. Initial patch written by Grzegorz +Grzywacz.

    • +
    • bpo-30197: Enhanced functions swap_attr() and swap_item() in the +test.support module. They now work when delete replaced attribute or item +inside the with statement. The old value of the attribute or item (or +None if it doesn’t exist) now will be assigned to the target of the “as” +clause, if there is one.

    • +
    • bpo-24932: Use proper command line parsing in _testembed

    • +
    • bpo-28950: Disallow -j0 to be combined with -T/-l in regrtest command line +arguments.

    • +
    • bpo-28683: Fix the tests that bind() a unix socket and raise +PermissionError on Android for a non-root user.

    • +
    • bpo-26936: Fix the test_socket failures on Android - getservbyname(), +getservbyport() and getaddrinfo() are broken on some Android API levels.

    • +
    • bpo-28666: Now test.support.rmtree is able to remove unwritable or +unreadable directories.

    • +
    • bpo-23839: Various caches now are cleared before running every test file.

    • +
    • bpo-26944: Fix test_posix for Android where ‘id -G’ is entirely wrong or +missing the effective gid.

    • +
    • bpo-28409: regrtest: fix the parser of command line arguments.

    • +
    • bpo-28217: Adds _testconsole module to test console input.

    • +
    • bpo-26939: Add the support.setswitchinterval() function to fix +test_functools hanging on the Android armv7 qemu emulator.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-31354: Allow –with-lto to be used on all builds, not just make +profile-opt.

    • +
    • bpo-31370: Remove support for building –without-threads.

      +

      This option is not really useful anymore in the 21st century. Removing +lots of conditional paths allows us to simplify the code base, including +in difficult to maintain low-level internal code.

      +
    • +
    • bpo-31341: Per PEP 11, support for the IRIX operating system was removed.

    • +
    • bpo-30854: Fix compile error when compiling –without-threads. Patch by +Masayuki Yamamoto.

    • +
    • bpo-30687: Locate msbuild.exe on Windows when building rather than +vcvarsall.bat

    • +
    • bpo-20210: Support the disabled marker in Setup files. Extension modules +listed after this marker are not built at all, neither by the Makefile nor +by setup.py.

    • +
    • bpo-29941: Add --with-assertions configure flag to explicitly enable C +assert() checks. Defaults to off. --with-pydebug implies +--with-assertions.

    • +
    • bpo-28787: Fix out-of-tree builds of Python when configured with +--with--dtrace.

    • +
    • bpo-29243: Prevent unnecessary rebuilding of Python during make test, +make install and some other make targets when configured with +--enable-optimizations.

    • +
    • bpo-23404: Don’t regenerate generated files based on file modification +time anymore: the action is now explicit. Replace make touch with +make regen-all.

    • +
    • bpo-29643: Fix --enable-optimization didn’t work.

    • +
    • bpo-27593: sys.version and the platform module python_build(), +python_branch(), and python_revision() functions now use git information +rather than hg when building from a repo.

    • +
    • bpo-29572: Update Windows build and OS X installers to use OpenSSL 1.0.2k.

    • +
    • bpo-27659: Prohibit implicit C function declarations: use +-Werror=implicit-function-declaration when possible (GCC and Clang, +but it depends on the compiler version). Patch written by Chi Hsuan Yen.

    • +
    • bpo-29384: Remove old Be OS helper scripts.

    • +
    • bpo-26851: Set Android compilation and link flags.

    • +
    • bpo-28768: Fix implicit declaration of function _setmode. Patch by +Masayuki Yamamoto

    • +
    • bpo-29080: Removes hard dependency on hg.exe from PCBuild/build.bat

    • +
    • bpo-23903: Added missed names to PC/python3.def.

    • +
    • bpo-28762: lockf() is available on Android API level 24, but the F_LOCK +macro is not defined in android-ndk-r13.

    • +
    • bpo-28538: Fix the compilation error that occurs because if_nameindex() is +available on Android API level 24, but the if_nameindex structure is not +defined.

    • +
    • bpo-20211: Do not add the directory for installing C header files and the +directory for installing object code libraries to the cross compilation +search paths. Original patch by Thomas Petazzoni.

    • +
    • bpo-28849: Do not define sys.implementation._multiarch on Android.

    • +
    • bpo-10656: Fix out-of-tree building on AIX. Patch by Tristan Carel and +Michael Haubenwallner.

    • +
    • bpo-26359: Rename –with-optimiations to –enable-optimizations.

    • +
    • bpo-28444: Fix missing extensions modules when cross compiling.

    • +
    • bpo-28208: Update Windows build and OS X installers to use SQLite 3.14.2.

    • +
    • bpo-28248: Update Windows build and OS X installers to use OpenSSL 1.0.2j.

    • +
    • bpo-21124: Fix building the _struct module on Cygwin by passing NULL +instead of &PyType_Type to PyVarObject_HEAD_INIT. Patch by Masayuki +Yamamoto.

    • +
    • bpo-13756: Fix building extensions modules on Cygwin. Patch by Roumen +Petrov, based on original patch by Jason Tishler.

    • +
    • bpo-21085: Add configure check for siginfo_t.si_band, which Cygwin does +not provide. Patch by Masayuki Yamamoto with review and rebase by Erik +Bray.

    • +
    • bpo-28258: Fixed build with Estonian locale (python-config and distclean +targets in Makefile). Patch by Arfrever Frehtes Taifersar Arahesis.

    • +
    • bpo-26661: setup.py now detects system libffi with multiarch wrapper.

    • +
    • bpo-27979: A full copy of libffi is no longer bundled for use when +building _ctypes on non-OSX UNIX platforms. An installed copy of libffi +is now required when building _ctypes on such platforms.

    • +
    • bpo-15819: Remove redundant include search directory option for building +outside the source tree.

    • +
    • bpo-28676: Prevent missing ‘getentropy’ declaration warning on macOS. +Patch by Gareth Rees.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-31392: Update Windows build to use OpenSSL 1.1.0f

    • +
    • bpo-30389: Adds detection of Visual Studio 2017 to distutils on Windows.

    • +
    • bpo-31358: zlib is no longer bundled in the CPython source, instead it is +downloaded on demand just like bz2, lzma, OpenSSL, Tcl/Tk, and SQLite.

    • +
    • bpo-31340: Change to building with MSVC v141 (included with Visual Studio +2017)

    • +
    • bpo-30581: os.cpu_count() now returns the correct number of processors on +Windows when the number of logical processors is greater than 64.

    • +
    • bpo-30916: Pre-build OpenSSL, Tcl and Tk and include the binaries in the +build.

    • +
    • bpo-30731: Add a missing xmlns to python.manifest so that it matches the +schema.

    • +
    • bpo-30291: Allow requiring 64-bit interpreters from py.exe using -64 +suffix. Contributed by Steve (Gadget) Barnes.

    • +
    • bpo-30362: Adds list options (-0, -0p) to py.exe launcher. Contributed by +Steve Barnes.

    • +
    • bpo-23451: Fix socket deprecation warnings in socketmodule.c. Patch by +Segev Finer.

    • +
    • bpo-30450: The build process on Windows no longer depends on Subversion, +instead pulling external code from GitHub via a Python script. If Python +3.6 is not found on the system (via py -3.6), NuGet is used to +download a copy of 32-bit Python.

    • +
    • bpo-29579: Removes readme.txt from the installer.

    • +
    • bpo-25778: winreg does not truncate string correctly (Patch by Eryk Sun)

    • +
    • bpo-28896: Deprecate WindowsRegistryFinder and disable it by default

    • +
    • bpo-28522: Fixes mishandled buffer reallocation in getpathp.c

    • +
    • bpo-28402: Adds signed catalog files for stdlib on Windows.

    • +
    • bpo-28333: Enables Unicode for ps1/ps2 and input() prompts. (Patch by Eryk +Sun)

    • +
    • bpo-28251: Improvements to help manuals on Windows.

    • +
    • bpo-28110: launcher.msi has different product codes between 32-bit and +64-bit

    • +
    • bpo-28161: Opening CON for write access fails

    • +
    • bpo-28162: WindowsConsoleIO readall() fails if first line starts with +Ctrl+Z

    • +
    • bpo-28163: WindowsConsoleIO fileno() passes wrong flags to _open_osfhandle

    • +
    • bpo-28164: _PyIO_get_console_type fails for various paths

    • +
    • bpo-28137: Renames Windows path file to ._pth

    • +
    • bpo-28138: Windows ._pth file should allow import site

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-31493: IDLE code context – fix code update and font update timers.

      +

      Canceling timers prevents a warning message when test_idle completes.

      +
    • +
    • bpo-31488: IDLE - Update non-key options in former extension classes. When +applying configdialog changes, call .reload for each feature class. Change +ParenMatch so updated options affect existing instances attached to +existing editor windows.

    • +
    • bpo-31477: IDLE - Improve rstrip entry in doc. Strip trailing whitespace +strips more than blank spaces. Multiline string literals are not skipped.

    • +
    • bpo-31480: IDLE - make tests pass with zzdummy extension disabled by +default.

    • +
    • bpo-31421: Document how IDLE runs tkinter programs. IDLE calls tcl/tk +update in the background in order to make live

      +

      interaction and experimentation with tkinter applications much easier.

      +
    • +
    • bpo-31414: IDLE – fix tk entry box tests by deleting first. Adding to an +int entry is not the same as deleting and inserting because int(‘’) will +fail.

    • +
    • bpo-31051: Rearrange IDLE configdialog GenPage into Window, Editor, and +Help sections.

    • +
    • bpo-30617: IDLE - Add docstrings and tests for outwin subclass of editor.

      +

      Move some data and functions from the class to module level. Patch by +Cheryl Sabella.

      +
    • +
    • bpo-31287: IDLE - Do not modify tkinter.message in test_configdialog.

    • +
    • bpo-27099: Convert IDLE’s built-in ‘extensions’ to regular features.

      +

      About 10 IDLE features were implemented as supposedly optional extensions. +Their different behavior could be confusing or worse for users and not +good for maintenance. Hence the conversion.

      +

      The main difference for users is that user configurable key bindings for +builtin features are now handled uniformly. Now, editing a binding in a +keyset only affects its value in the keyset. All bindings are defined +together in the system-specific default keysets in config-extensions.def. +All custom keysets are saved as a whole in config-extension.cfg. All take +effect as soon as one clicks Apply or Ok.

      +

      The affected events are ‘<<force-open-completions>>’, ‘<<expand-word>>’, +‘<<force-open-calltip>>’, ‘<<flash-paren>>’, ‘<<format-paragraph>>’, +‘<<run-module>>’, ‘<<check-module>>’, and ‘<<zoom-height>>’. Any (global) +customizations made before 3.6.3 will not affect their keyset-specific +customization after 3.6.3. and vice versa.

      +

      Initial patch by Charles Wohlganger.

      +
    • +
    • bpo-31206: IDLE: Factor HighPage(Frame) class from ConfigDialog. Patch by +Cheryl Sabella.

    • +
    • bpo-31001: Add tests for configdialog highlight tab. Patch by Cheryl +Sabella.

    • +
    • bpo-31205: IDLE: Factor KeysPage(Frame) class from ConfigDialog. The +slightly modified tests continue to pass. Patch by Cheryl Sabella.

    • +
    • bpo-31130: IDLE – stop leaks in test_configdialog. Initial patch by +Victor Stinner.

    • +
    • bpo-31002: Add tests for configdialog keys tab. Patch by Cheryl Sabella.

    • +
    • bpo-19903: IDLE: Calltips use inspect.signature instead of +inspect.getfullargspec. This improves calltips for builtins converted to +use Argument Clinic. Patch by Louie Lu.

    • +
    • bpo-31083: IDLE - Add an outline of a TabPage class in configdialog. +Update existing classes to match outline. Initial patch by Cheryl Sabella.

    • +
    • bpo-31050: Factor GenPage(Frame) class from ConfigDialog. The slightly +modified tests continue to pass. Patch by Cheryl Sabella.

    • +
    • bpo-31004: IDLE - Factor FontPage(Frame) class from ConfigDialog.

      +

      Slightly modified tests continue to pass. Fix General tests. Patch mostly +by Cheryl Sabella.

      +
    • +
    • bpo-30781: IDLE - Use ttk widgets in ConfigDialog. Patches by Terry Jan +Reedy and Cheryl Sabella.

    • +
    • bpo-31060: IDLE - Finish rearranging methods of ConfigDialog Grouping +methods pertaining to each tab and the buttons will aid writing tests and +improving the tabs and will enable splitting the groups into classes.

    • +
    • bpo-30853: IDLE – Factor a VarTrace class out of ConfigDialog.

      +

      Instance tracers manages pairs consisting of a tk variable and a callback +function. When tracing is turned on, setting the variable calls the +function. Test coverage for the new class is 100%.

      +
    • +
    • bpo-31003: IDLE: Add more tests for General tab.

    • +
    • bpo-30993: IDLE - Improve configdialog font page and tests.

      +

      In configdialog: Document causal pathways in create_font_tab docstring. +Simplify some attribute names. Move set_samples calls to var_changed_font +(idea from Cheryl Sabella). Move related functions to positions after the +create widgets function.

      +

      In test_configdialog: Fix test_font_set so not order dependent. Fix +renamed test_indent_scale so it tests the widget. Adjust tests for +movement of set_samples call. Add tests for load functions. Put all font +tests in one class and tab indent tests in another. Except for two lines, +these tests completely cover the related functions.

      +
    • +
    • bpo-30981: IDLE – Add more configdialog font page tests.

    • +
    • bpo-28523: IDLE: replace ‘colour’ with ‘color’ in configdialog.

    • +
    • bpo-30917: Add tests for idlelib.config.IdleConf. Increase coverage from +46% to 96%. Patch by Louie Lu.

    • +
    • bpo-30934: Document coverage details for idlelib tests.

      +
        +
      • Add section to idlelib/idle-test/README.txt.

      • +
      • Include check that branches are taken both ways.

      • +
      • Exclude IDLE-specific code that does not run during unit tests.

      • +
      +
    • +
    • bpo-30913: IDLE: Document ConfigDialog tk Vars, methods, and widgets in +docstrings This will facilitate improving the dialog and splitting up the +class. Original patch by Cheryl Sabella.

    • +
    • bpo-30899: IDLE: Add tests for ConfigParser subclasses in config. Patch by +Louie Lu.

    • +
    • bpo-30881: IDLE: Add docstrings to browser.py. Patch by Cheryl Sabella.

    • +
    • bpo-30851: IDLE: Remove unused variables in configdialog. One is a +duplicate, one is set but cannot be altered by users. Patch by Cheryl +Sabella.

    • +
    • bpo-30870: IDLE: In Settings dialog, select font with Up, Down keys as +well as mouse. Initial patch by Louie Lu.

    • +
    • bpo-8231: IDLE: call config.IdleConf.GetUserCfgDir only once.

    • +
    • bpo-30779: IDLE: Factor ConfigChanges class from configdialog, put in +config; test. * In config, put dump test code in a function; run it and +unittest in ‘if __name__ == ‘__main__’. * Add class config.ConfigChanges +based on changes_class_v4.py on bpo issue. * Add class +test_config.ChangesTest, partly using configdialog_tests_v1.py. * Revise +configdialog to use ConfigChanges; see tracker msg297804. * Revise +test_configdialog to match configdialog changes. * Remove configdialog +functions unused or moved to ConfigChanges. Cheryl Sabella contributed +parts of the patch.

    • +
    • bpo-30777: IDLE: configdialog - Add docstrings and fix comments. Patch by +Cheryl Sabella.

    • +
    • bpo-30495: IDLE: Improve textview with docstrings, PEP8 names, and more +tests. Patch by Cheryl Sabella.

    • +
    • bpo-30723: IDLE: Make several improvements to parenmatch. Add ‘parens’ +style to highlight both opener and closer. Make ‘default’ style, which is +not default, a synonym for ‘opener’. Make time-delay work the same with +all styles. Add help for config dialog extensions tab, including help for +parenmatch. Add new tests. Original patch by Charles Wohlganger.

    • +
    • bpo-30674: IDLE: add docstrings to grep module. Patch by Cheryl Sabella

    • +
    • bpo-21519: IDLE’s basic custom key entry dialog now detects duplicates +properly. Original patch by Saimadhav Heblikar.

    • +
    • bpo-29910: IDLE no longer deletes a character after commenting out a +region by a key shortcut. Add return 'break' for this and other +potential conflicts between IDLE and default key bindings.

    • +
    • bpo-30728: Review and change idlelib.configdialog names. Lowercase method +and attribute names. Replace ‘colour’ with ‘color’, expand overly cryptic +names, delete unneeded underscores. Replace import * with specific +imports. Patches by Cheryl Sabella.

    • +
    • bpo-6739: IDLE: Verify user-entered key sequences by trying to bind them +with tk. Add tests for all 3 validation functions. Original patch by G +Polo. Tests added by Cheryl Sabella.

    • +
    • bpo-15786: Fix several problems with IDLE’s autocompletion box. The +following should now work: clicking on selection box items; using the +scrollbar; selecting an item by hitting Return. Hangs on MacOSX should no +longer happen. Patch by Louie Lu.

    • +
    • bpo-25514: Add doc subsubsection about IDLE failure to start. Popup +no-connection message directs users to this section.

    • +
    • bpo-30642: Fix reference leaks in IDLE tests. Patches by Louie Lu and +Terry Jan Reedy.

    • +
    • bpo-30495: Add docstrings for textview.py and use PEP8 names. Patches by +Cheryl Sabella and Terry Jan Reedy.

    • +
    • bpo-30290: Help-about: use pep8 names and add tests. Increase coverage to +100%. Patches by Louie Lu, Cheryl Sabella, and Terry Jan Reedy.

    • +
    • bpo-30303: Add _utest option to textview; add new tests. Increase coverage +to 100%. Patches by Louie Lu and Terry Jan Reedy.

    • +
    • bpo-29071: IDLE colors f-string prefixes (but not invalid ur prefixes).

    • +
    • bpo-28572: Add 10% to coverage of IDLE’s test_configdialog. Update and +augment description of the configuration system.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-30983: gdb integration commands (py-bt, etc.) work on optimized shared +builds now, too. PEP 523 introduced _PyEval_EvalFrameDefault which +inlines PyEval_EvalFrameEx on non-debug shared builds. This broke the +ability to use py-bt, py-up, and a few other Python-specific gdb +integrations. The problem is fixed by only looking for +_PyEval_EvalFrameDefault frames in python-gdb.py. Original patch by Bruno +“Polaco” Penteado.

    • +
    • bpo-29748: Added the slice index converter in Argument Clinic.

    • +
    • bpo-24037: Argument Clinic now uses the converter bool(accept={int}) +rather than int for semantical booleans. This avoids repeating the +default value for Python and C and will help in converting to bool in +future.

    • +
    • bpo-29367: python-gdb.py now supports also method-wrapper +(wrapperobject) objects.

    • +
    • bpo-28023: Fix python-gdb.py didn’t support new dict implementation.

    • +
    • bpo-15369: The pybench and pystone microbenchmark have been removed from +Tools. Please use the new Python benchmark suite +https://github.com/python/performance which is more reliable and includes +a portable version of pybench working on Python 2 and Python 3.

    • +
    • bpo-28102: The zipfile module CLI now prints usage to stderr. Patch by +Stephen J. Turnbull.

    • +
    +
    +
    +

    C API

    +
      +
    • bpo-31338: Added the Py_UNREACHABLE() macro for code paths which are +never expected to be reached. This and a few other useful macros are now +documented in the C API manual.

    • +
    • bpo-30832: Remove own implementation for thread-local storage.

      +

      CPython has provided the own implementation for thread-local storage (TLS) +on Python/thread.c, it’s used in the case which a platform has not +supplied native TLS. However, currently all supported platforms (Windows +and pthreads) have provided native TLS and defined the Py_HAVE_NATIVE_TLS +macro with unconditional in any case.

      +
    • +
    • bpo-30708: PyUnicode_AsWideCharString() now raises a ValueError if the +second argument is NULL and the wchar_t* string contains null characters.

    • +
    • bpo-16500: Deprecate PyOS_AfterFork() and add PyOS_BeforeFork(), +PyOS_AfterFork_Parent() and PyOS_AfterFork_Child().

    • +
    • bpo-6532: The type of results of PyThread_start_new_thread() and +PyThread_get_thread_ident(), and the id parameter of +PyThreadState_SetAsyncExc() changed from “long” to “unsigned long”.

    • +
    • bpo-27867: Function PySlice_GetIndicesEx() is deprecated and replaced with +a macro if Py_LIMITED_API is not set or set to the value between +0x03050400 and 0x03060000 (not including) or 0x03060100 or higher. Added +functions PySlice_Unpack() and PySlice_AdjustIndices().

    • +
    • bpo-29083: Fixed the declaration of some public API functions. +PyArg_VaParse() and PyArg_VaParseTupleAndKeywords() were not available in +limited API. PyArg_ValidateKeywordArguments(), PyArg_UnpackTuple() and +Py_BuildValue() were not available in limited API of version < 3.3 when +PY_SSIZE_T_CLEAN is defined.

    • +
    • bpo-28769: The result of PyUnicode_AsUTF8AndSize() and PyUnicode_AsUTF8() +is now of type const char * rather of char *.

    • +
    • bpo-29058: All stable API extensions added after Python 3.2 are now +available only when Py_LIMITED_API is set to the PY_VERSION_HEX value of +the minimum Python version supporting this API.

    • +
    • bpo-28822: The index parameters start and end of PyUnicode_FindChar() +are now adjusted to behave like str[start:end].

    • +
    • bpo-28808: PyUnicode_CompareWithASCIIString() now never raises exceptions.

    • +
    • bpo-28761: The fields name and doc of structures PyMemberDef, PyGetSetDef, +PyStructSequence_Field, PyStructSequence_Desc, and wrapperbase are now of +type const char * rather of char *.

    • +
    • bpo-28748: Private variable _Py_PackageContext is now of type const char +* rather of char *.

    • +
    • bpo-19569: Compiler warnings are now emitted if use most of deprecated +functions.

    • +
    • bpo-28426: Deprecated undocumented functions PyUnicode_AsEncodedObject(), +PyUnicode_AsDecodedObject(), PyUnicode_AsDecodedUnicode() and +PyUnicode_AsEncodedUnicode().

    • +
    +
    +
    +
    +

    Python 3.6.6 final

    +

    Release date: 2018-06-27

    +

    There were no new changes in version 3.6.6.

    +
    +
    +

    Python 3.6.6 release candidate 1

    +

    Release date: 2018-06-11

    +
    +

    Core and Builtins

    +
      +
    • bpo-33786: Fix asynchronous generators to handle GeneratorExit in athrow() +correctly

    • +
    • bpo-30654: Fixed reset of the SIGINT handler to SIG_DFL on interpreter +shutdown even when there was a custom handler set previously. Patch by +Philipp Kerling.

    • +
    • bpo-33622: Fixed a leak when the garbage collector fails to add an object +with the __del__ method or referenced by it into the +gc.garbage list. PyGC_Collect() can now be called when an +exception is set and preserves it.

    • +
    • bpo-31849: Fix signed/unsigned comparison warning in pyhash.c.

    • +
    • bpo-33391: Fix a leak in set_symmetric_difference().

    • +
    • bpo-28055: Fix unaligned accesses in siphash24(). Patch by Rolf Eike Beer.

    • +
    • bpo-33231: Fix potential memory leak in normalizestring().

    • +
    • bpo-29922: Improved error messages in ‘async with’ when __aenter__() +or __aexit__() return non-awaitable object.

    • +
    • bpo-33199: Fix ma_version_tag in dict implementation is uninitialized +when copying from key-sharing dict.

    • +
    • bpo-33041: Fixed jumping when the function contains an async for loop.

    • +
    • bpo-32282: Fix an unnecessary ifdef in the include of VersionHelpers.h in +socketmodule on Windows.

    • +
    • bpo-21983: Fix a crash in ctypes.cast() in case the type argument is a +ctypes structured data type. Patch by Eryk Sun and Oren Milman.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-30167: Prevent site.main() exception if PYTHONSTARTUP is set. Patch by +Steve Weber.

    • +
    • bpo-33812: Datetime instance d with non-None tzinfo, but with +d.tzinfo.utcoffset(d) returning None is now treated as naive by the +astimezone() method.

    • +
    • bpo-30805: Avoid race condition with debug logging

    • +
    • bpo-33767: The concatenation (+) and repetition (*) sequence +operations now raise TypeError instead of SystemError when +performed on mmap.mmap objects. Patch by Zackery Spytz.

    • +
    • bpo-32684: Fix gather to propagate cancellation of itself even with +return_exceptions.

    • +
    • bpo-33674: Fix a race condition in SSLProtocol.connection_made() of +asyncio.sslproto: start immediately the handshake instead of using +call_soon(). Previously, data_received() could be called before the +handshake started, causing the handshake to hang or fail.

    • +
    • bpo-31647: Fixed bug where calling write_eof() on a +_SelectorSocketTransport after it’s already closed raises AttributeError.

    • +
    • bpo-33672: Fix Task.__repr__ crash with Cython’s bogus coroutines

    • +
    • bpo-33469: Fix RuntimeError after closing loop that used run_in_executor

    • +
    • bpo-11874: Use a better regex when breaking usage into wrappable parts. +Avoids bogus assertion errors from custom metavar strings.

    • +
    • bpo-30877: Fixed a bug in the Python implementation of the JSON decoder +that prevented the cache of parsed strings from clearing after finishing +the decoding. Based on patch by c-fos.

    • +
    • bpo-33548: tempfile._candidate_tempdir_list should consider common TEMP +locations

    • +
    • bpo-33542: Prevent uuid.get_node from using a DUID instead of a MAC on +Windows. Patch by Zvi Effron

    • +
    • bpo-26819: Fix race condition with ReadTransport.resume_reading in +Windows proactor event loop.

    • +
    • bpo-28556: Minor fixes in typing module: add annotations to +NamedTuple.__new__, pass *args and **kwds in +Generic.__new__. Original PRs by Paulius Šarka and Chad Dombrova.

    • +
    • bpo-20087: Updated alias mapping with glibc 2.27 supported locales.

    • +
    • bpo-33422: Fix trailing quotation marks getting deleted when looking up +byte/string literals on pydoc. Patch by Andrés Delfino.

    • +
    • bpo-33197: Update error message when constructing invalid +inspect.Parameters Patch by Dong-hee Na.

    • +
    • bpo-33383: Fixed crash in the get() method of the dbm.ndbm database +object when it is called with a single argument.

    • +
    • bpo-33329: Fix multiprocessing regression on newer glibcs

    • +
    • bpo-991266: Fix quoting of the Comment attribute of +http.cookies.SimpleCookie.

    • +
    • bpo-33131: Upgrade bundled version of pip to 10.0.1.

    • +
    • bpo-33308: Fixed a crash in the parser module when converting an ST +object to a tree of tuples or lists with line_info=False and +col_info=True.

    • +
    • bpo-33263: Fix FD leak in _SelectorSocketTransport Patch by Vlad +Starostin.

    • +
    • bpo-33256: Fix display of <module> call in the html produced by +cgitb.html(). Patch by Stéphane Blondon.

    • +
    • bpo-33203: random.Random.choice() now raises IndexError for empty +sequences consistently even when called from subclasses without a +getrandbits() implementation.

    • +
    • bpo-33224: Update difflib.mdiff() for PEP 479. Convert an uncaught +StopIteration in a generator into a return-statement.

    • +
    • bpo-33209: End framing at the end of C implementation of +pickle.Pickler.dump().

    • +
    • bpo-32861: The urllib.robotparser’s __str__ representation now +includes wildcard entries and the “Crawl-delay” and “Request-rate” fields. +Patch by Michael Lazar.

    • +
    • bpo-33096: Allow ttk.Treeview.insert to insert iid that has a false +boolean value. Note iid=0 and iid=False would be same. Patch by Garvit +Khatri.

    • +
    • bpo-33127: The ssl module now compiles with LibreSSL 2.7.1.

    • +
    • bpo-33021: Release the GIL during fstat() calls, avoiding hang of all +threads when calling mmap.mmap(), os.urandom(), and random.seed(). Patch +by Nir Soffer.

    • +
    • bpo-27683: Fix a regression in ipaddress that result of +hosts() is empty when the network is constructed by a tuple +containing an integer mask and only 1 bit left for addresses.

    • +
    • bpo-32844: Fix wrong redirection of a low descriptor (0 or 1) to stderr in +subprocess if another low descriptor is closed.

    • +
    • bpo-31908: Fix output of cover files for trace module command-line +tool. Previously emitted cover files only when --missing option was +used. Patch by Michael Selik.

    • +
    • bpo-31457: If nested log adapters are used, the inner process() +methods are no longer omitted.

    • +
    • bpo-16865: Support arrays >=2GiB in ctypes. Patch by Segev Finer.

    • +
    • bpo-31238: pydoc: the stop() method of the private ServerThread class now +waits until DocServer.serve_until_quit() completes and then explicitly +sets its docserver attribute to None to break a reference cycle.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-33503: Fix broken pypi link

    • +
    • bpo-33421: Add missing documentation for typing.AsyncContextManager.

    • +
    • bpo-33378: Add Korean language switcher for https://docs.python.org/3/

    • +
    • bpo-33276: Clarify that the __path__ attribute on modules cannot be +just any value.

    • +
    • bpo-33201: Modernize documentation for writing C extension types.

    • +
    • bpo-33195: Deprecate Py_UNICODE usage in c-api/arg document. +Py_UNICODE related APIs are deprecated since Python 3.3, but it is +missed in the document.

    • +
    • bpo-33126: Document PyBuffer_ToContiguous().

    • +
    • bpo-27212: Modify documentation for the islice() recipe to consume +initial values up to the start index.

    • +
    • bpo-28247: Update zipapp documentation to describe how to make +standalone applications.

    • +
    • bpo-18802: Documentation changes for ipaddress. Patch by Jon Foster and +Berker Peksag.

    • +
    • bpo-27428: Update documentation to clarify that WindowsRegistryFinder +implements MetaPathFinder. (Patch by Himanshu Lakhara)

    • +
    • bpo-8243: Add a note about curses.addch and curses.addstr exception +behavior when writing outside a window, or pad.

    • +
    • bpo-31432: Clarify meaning of CERT_NONE, CERT_OPTIONAL, and CERT_REQUIRED +flags for ssl.SSLContext.verify_mode.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-33655: Ignore test_posix_fallocate failures on BSD platforms that +might be due to running on ZFS.

    • +
    • bpo-19417: Add test_bdb.py.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-5755: Move -Wstrict-prototypes option to CFLAGS_NODIST from +OPT. This option emitted annoying warnings when building extension +modules written in C++.

    • +
    • bpo-33614: Ensures module definition files for the stable ABI on Windows +are correctly regenerated.

    • +
    • bpo-33522: Enable CI builds on Visual Studio Team Services at +https://python.visualstudio.com/cpython

    • +
    • bpo-33012: Add -Wno-cast-function-type for gcc 8 for silencing +warnings about function casts like casting to PyCFunction in method +definition lists.

    • +
    • bpo-33394: Enable the verbose build for extension modules, when GNU make +is passed macros on the command line.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-33184: Update Windows installer to OpenSSL 1.0.2o.

    • +
    +
    +
    +

    macOS

    +
      +
    • bpo-33184: Update macOS installer build to use OpenSSL 1.0.2o.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-33656: On Windows, add API call saying that tk scales for DPI. On +Windows 8.1+ or 10, with DPI compatibility properties of the Python binary +unchanged, and a monitor resolution greater than 96 DPI, this should make +text and lines sharper. It should otherwise have no effect.

    • +
    • bpo-33768: Clicking on a context line moves that line to the top of the +editor window.

    • +
    • bpo-33763: IDLE: Use read-only text widget for code context instead of +label widget.

    • +
    • bpo-33664: Scroll IDLE editor text by lines. Previously, the mouse wheel +and scrollbar slider moved text by a fixed number of pixels, resulting in +partial lines at the top of the editor box. The change also applies to +the shell and grep output windows, but not to read-only text views.

    • +
    • bpo-33679: Enable theme-specific color configuration for Code Context. Use +the Highlights tab to see the setting for built-in themes or add settings +to custom themes.

    • +
    • bpo-33642: Display up to maxlines non-blank lines for Code Context. If +there is no current context, show a single blank line.

    • +
    • bpo-33628: IDLE: Cleanup codecontext.py and its test.

    • +
    • bpo-33564: IDLE’s code context now recognizes async as a block opener.

    • +
    • bpo-29706: IDLE now colors async and await as keywords in 3.6. They become +full keywords in 3.7.

    • +
    • bpo-21474: Update word/identifier definition from ascii to unicode. In +text and entry boxes, this affects selection by double-click, movement +left/right by control-left/right, and deletion left/right by +control-BACKSPACE/DEL.

    • +
    • bpo-33204: IDLE: consistently color invalid string prefixes. A ‘u’ string +prefix cannot be paired with either ‘r’ or ‘f’. Consistently color as much +of the prefix, starting at the right, as is valid. Revise and extend +colorizer test.

    • +
    • bpo-32831: Add docstrings and tests for codecontext.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-33189: pygettext.py now recognizes only literal strings as +docstrings and translatable strings, and rejects bytes literals and +f-string expressions.

    • +
    • bpo-31920: Fixed handling directories as arguments in the pygettext +script. Based on patch by Oleg Krasnikov.

    • +
    • bpo-29673: Fix pystackv and pystack gdbinit macros.

    • +
    • bpo-32885: Add an -n flag for Tools/scripts/pathfix.py to disable +automatic backup creation (files with ~ suffix).

    • +
    • bpo-31583: Fix 2to3 for using with –add-suffix option but without +–output-dir option for relative path to files in current directory.

    • +
    +
    +
    +

    C API

    +
      +
    • bpo-32374: Document that m_traverse for multi-phase initialized modules +can be called with m_state=NULL, and add a sanity check

    • +
    +
    +
    +
    +

    Python 3.6.5 final

    +

    Release date: 2018-03-28

    +
    +

    Tests

    +
      +
    • bpo-32872: Avoid regrtest compatibility issue with namespace packages.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-33163: Upgrade pip to 9.0.3 and setuptools to v39.0.1.

    • +
    +
    +
    +
    +

    Python 3.6.5 release candidate 1

    +

    Release date: 2018-03-13

    +
    +

    Security

    +
      +
    • bpo-33001: Minimal fix to prevent buffer overrun in os.symlink on Windows

    • +
    • bpo-32981: Regexes in difflib and poplib were vulnerable to catastrophic +backtracking. These regexes formed potential DOS vectors (REDOS). They +have been refactored. This resolves CVE-2018-1060 and CVE-2018-1061. Patch +by Jamie Davis.

    • +
    +
    +
    +

    Core and Builtins

    +
      +
    • bpo-33026: Fixed jumping out of “with” block by setting f_lineno.

    • +
    • bpo-17288: Prevent jumps from ‘return’ and ‘exception’ trace events.

    • +
    • bpo-32889: Update Valgrind suppression list to account for the rename of +Py_ADDRESS_IN_RANG to address_in_range.

    • +
    • bpo-32650: Pdb and other debuggers dependent on bdb.py will correctly step +over (next command) native coroutines. Patch by Pablo Galindo.

    • +
    • bpo-32685: Improve suggestion when the Python 2 form of print statement is +either present on the same line as the header of a compound statement or +else terminated by a semi-colon instead of a newline. Patch by Nitish +Chandra.

    • +
    • bpo-32583: Fix possible crashing in builtin Unicode decoders caused by +write out-of-bound errors when using customized decode error handlers.

    • +
    • bpo-26163: Improved frozenset() hash to create more distinct hash values +when faced with datasets containing many similar values.

    • +
    • bpo-27169: The __debug__ constant is now optimized out at compile +time. This fixes also bpo-22091.

    • +
    • bpo-32329: sys.flags.hash_randomization is now properly set to 0 when +hash randomization is turned off by PYTHONHASHSEED=0.

    • +
    • bpo-30416: The optimizer is now protected from spending much time doing +complex calculations and consuming much memory for creating large +constants in constant folding.

    • +
    • bpo-18533: repr() on a dict containing its own values() or +items() no longer raises RecursionError; OrderedDict similarly. +Instead, use ..., as for other recursive structures. Patch by Ben +North.

    • +
    • bpo-32028: Leading whitespace is now correctly ignored when generating +suggestions for converting Py2 print statements to Py3 builtin print +function calls. Patch by Sanyam Khurana.

    • +
    • bpo-32137: The repr of deeply nested dict now raises a RecursionError +instead of crashing due to a stack overflow.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-33064: lib2to3 now properly supports trailing commas after *args +and **kwargs in function signatures.

    • +
    • bpo-31804: Avoid failing in multiprocessing.Process if the standard +streams are closed or None at exit.

    • +
    • bpo-33037: Skip sending/receiving data after SSL transport closing.

    • +
    • bpo-30353: Fix ctypes pass-by-value for structs on 64-bit Cygwin/MinGW.

    • +
    • bpo-33009: Fix inspect.signature() for single-parameter partialmethods.

    • +
    • bpo-32969: Expose several missing constants in zlib and fix corresponding +documentation.

    • +
    • bpo-32713: Fixed tarfile.itn handling of out-of-bounds float values. Patch +by Joffrey Fuhrer.

    • +
    • bpo-30622: The ssl module now detects missing NPN support in LibreSSL.

    • +
    • bpo-32922: dbm.open() now encodes filename with the filesystem encoding +rather than default encoding.

    • +
    • bpo-32859: In os.dup2, don’t check every call whether the dup3 +syscall exists or not.

    • +
    • bpo-21060: Rewrite confusing message from setup.py upload from “No dist +file created in earlier command” to the more helpful “Must create and +upload files in one command”.

    • +
    • bpo-32857: In tkinter, after_cancel(None) now raises a +ValueError instead of canceling the first scheduled function. +Patch by Cheryl Sabella.

    • +
    • bpo-32852: Make sure sys.argv remains as a list when running trace.

    • +
    • bpo-32841: Fixed asyncio.Condition issue which silently ignored +cancellation after notifying and cancelling a conditional lock. Patch by +Bar Harel.

    • +
    • bpo-31787: Fixed refleaks of __init__() methods in various modules. +(Contributed by Oren Milman)

    • +
    • bpo-30157: Fixed guessing quote and delimiter in csv.Sniffer.sniff() when +only the last field is quoted. Patch by Jake Davis.

    • +
    • bpo-32394: socket: Remove TCP_FASTOPEN, TCP_KEEPCNT flags on older version +Windows during run-time.

    • +
    • bpo-32777: Fix a rare but potential pre-exec child process deadlock in +subprocess on POSIX systems when marking file descriptors inheritable on +exec in the child process. This bug appears to have been introduced in +3.4.

    • +
    • bpo-32647: The ctypes module used to depend on indirect linking for +dlopen. The shared extension is now explicitly linked against libdl on +platforms with dl.

    • +
    • bpo-32734: Fixed asyncio.Lock() safety issue which allowed acquiring +and locking the same lock multiple times, without it being free. Patch by +Bar Harel.

    • +
    • bpo-32727: Do not include name field in SMTP envelope from address. Patch +by Stéphane Wirtel

    • +
    • bpo-27931: Fix email address header parsing error when the username is an +empty quoted string. Patch by Xiang Zhang.

    • +
    • bpo-32304: distutils’ upload command no longer corrupts tar files ending +with a CR byte, and no longer tries to convert CR to CRLF in any of the +upload text fields.

    • +
    • bpo-32502: uuid.uuid1 no longer raises an exception if a 64-bit hardware +address is encountered.

    • +
    • bpo-31848: Fix the error handling in Aifc_read.initfp() when the SSND +chunk is not found. Patch by Zackery Spytz.

    • +
    • bpo-32555: On FreeBSD and Solaris, os.strerror() now always decode the +byte string from the current locale encoding, rather than using +ASCII/surrogateescape in some cases.

    • +
    • bpo-32521: The nis module is now compatible with new libnsl and headers +location.

    • +
    • bpo-32473: Improve ABCMeta._dump_registry() output readability

    • +
    • bpo-32521: glibc has removed Sun RPC. Use replacement libtirpc headers and +library in nis module.

    • +
    • bpo-32228: Ensure that truncate() preserves the file position (as +reported by tell()) after writes longer than the buffer size.

    • +
    • bpo-26133: Don’t unsubscribe signals in asyncio UNIX event loop on +interpreter shutdown.

    • +
    • bpo-32185: The SSL module no longer sends IP addresses in SNI TLS +extension on platforms with OpenSSL 1.0.2+ or inet_pton.

    • +
    • bpo-32323: urllib.parse.urlsplit() does not convert zone-id +(scope) to lower case for scoped IPv6 addresses in hostnames now.

    • +
    • bpo-32302: Fix bdist_wininst of distutils for CRT v142: it binary +compatible with CRT v140.

    • +
    • bpo-32255: A single empty field is now always quoted when written into a +CSV file. This allows to distinguish an empty row from a row consisting of +a single empty field. Patch by Licht Takeuchi.

    • +
    • bpo-32277: Raise NotImplementedError instead of SystemError on +platforms where chmod(..., follow_symlinks=False) is not supported. +Patch by Anthony Sottile.

    • +
    • bpo-32199: The getnode() ip getter now uses ‘ip link’ instead of ‘ip link +list’.

    • +
    • bpo-27456: Ensure TCP_NODELAY is set on Linux. Tests by Victor Stinner.

    • +
    • bpo-31900: The locale.localeconv() function now sets temporarily the +LC_CTYPE locale to the LC_NUMERIC locale to decode +decimal_point and thousands_sep byte strings if they are non-ASCII +or longer than 1 byte, and the LC_NUMERIC locale is different than the +LC_CTYPE locale. This temporary change affects other threads.

      +

      Same change for the str.format() method when formatting a number +(int, float, float and subclasses) with the +n type (ex: '{:n}'.format(1234)).

      +
    • +
    • bpo-31802: Importing native path module (posixpath, ntpath) now +works even if the os module still is not imported.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-17232: Clarify docs for -O and -OO. Patch by Terry Reedy.

    • +
    • bpo-32800: Update link to w3c doc for xml default namespaces.

    • +
    • bpo-8722: Document __getattr__() behavior when property get() +method raises AttributeError.

    • +
    • bpo-32614: Modify RE examples in documentation to use raw strings to +prevent DeprecationWarning and add text to REGEX HOWTO to highlight +the deprecation.

    • +
    • bpo-31972: Improve docstrings for pathlib.PurePath subclasses.

    • +
    • bpo-17799: Explain real behaviour of sys.settrace and sys.setprofile and +their C-API counterparts regarding which type of events are received in +each function. Patch by Pablo Galindo Salgado.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-32517: Fix failing test_asyncio on macOS 10.12.2+ due to transport +of KqueueSelector loop was not being closed.

    • +
    • bpo-32721: Fix test_hashlib to not fail if the _md5 module is not built.

    • +
    • bpo-32252: Fix faulthandler_suppress_crash_report() used to prevent core +dump files when testing crashes. getrlimit() returns zero on success.

    • +
    • bpo-31518: Debian Unstable has disabled TLS 1.0 and 1.1 for +SSLv23_METHOD(). Change TLS/SSL protocol of some tests to PROTOCOL_TLS or +PROTOCOL_TLSv1_2 to make them pass on Debian.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-32635: Fix segfault of the crypt module when libxcrypt is provided +instead of libcrypt at the system.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-33016: Fix potential use of uninitialized memory in +nt._getfinalpathname

    • +
    • bpo-32903: Fix a memory leak in os.chdir() on Windows if the current +directory is set to a UNC path.

    • +
    • bpo-31966: Fixed WindowsConsoleIO.write() for writing empty data.

    • +
    • bpo-32409: Ensures activate.bat can handle Unicode contents.

    • +
    • bpo-32457: Improves handling of denormalized executable path when +launching Python.

    • +
    • bpo-32370: Use the correct encoding for ipconfig output in the uuid +module. Patch by Segev Finer.

    • +
    • bpo-29248: Fix os.readlink() on Windows, which was mistakenly +treating the PrintNameOffset field of the reparse data buffer as a +number of characters instead of bytes. Patch by Craig Holmquist and SSE4.

    • +
    • bpo-32588: Create standalone _distutils_findvs module.

    • +
    +
    +
    +

    macOS

    +
      +
    • bpo-32726: Provide an additional, more modern macOS installer variant that +supports macOS 10.9+ systems in 64-bit mode only. Upgrade the supplied +third-party libraries to OpenSSL 1.0.2n, XZ 5.2.3, and SQLite 3.22.0. The +10.9+ installer now links with and supplies its own copy of Tcl/Tk 8.6.8.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-32984: Set __file__ while running a startup file. Like Python, +IDLE optionally runs one startup file in the Shell window before +presenting the first interactive input prompt. For IDLE, -s runs a +file named in environmental variable IDLESTARTUP or +PYTHONSTARTUP; -r file runs file. Python sets +__file__ to the startup file name before running the file and unsets +it before the first prompt. IDLE now does the same when run normally, +without the -n option.

    • +
    • bpo-32940: Simplify and rename StringTranslatePseudoMapping in pyparse.

    • +
    • bpo-32916: Change str to code in pyparse.

    • +
    • bpo-32905: Remove unused code in pyparse module.

    • +
    • bpo-32874: Add tests for pyparse.

    • +
    • bpo-32837: Using the system and place-dependent default encoding for +open() is a bad idea for IDLE’s system and location-independent files.

    • +
    • bpo-32826: Add “encoding=utf-8” to open() in IDLE’s test_help_about. GUI +test test_file_buttons() only looks at initial ascii-only lines, but +failed on systems where open() defaults to ‘ascii’ because readline() +internally reads and decodes far enough ahead to encounter a non-ascii +character in CREDITS.txt.

    • +
    • bpo-32765: Update configdialog General tab docstring to add new widgets to +the widget list.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-24960: 2to3 and lib2to3 can now read pickled grammar files using +pkgutil.get_data() rather than probing the filesystem. This lets 2to3 and +lib2to3 work when run from a zipfile.

    • +
    • bpo-32222: Fix pygettext not extracting docstrings for functions with type +annotated arguments. Patch by Toby Harradine.

    • +
    +
    +
    +

    C API

    +
      +
    • bpo-29084: Undocumented C API for OrderedDict has been excluded from the +limited C API. It was added by mistake and actually never worked in the +limited C API.

    • +
    +
    +
    +
    +

    Python 3.6.4 final

    +

    Release date: 2017-12-18

    +

    There were no new code changes in version 3.6.4 since v3.6.4rc1.

    +
    +
    +

    Python 3.6.4 release candidate 1

    +

    Release date: 2017-12-05

    +
    +

    Core and Builtins

    +
      +
    • bpo-32176: co_flags.CO_NOFREE is now always set correctly by the code +object constructor based on freevars and cellvars, rather than needing to +be set correctly by the caller. This ensures it will be cleared +automatically when additional cell references are injected into a modified +code object and function.

    • +
    • bpo-31949: Fixed several issues in printing tracebacks +(PyTraceBack_Print()).

      +
        +
      • Setting sys.tracebacklimit to 0 or less now suppresses printing tracebacks.

      • +
      • Setting sys.tracebacklimit to None now causes using the default limit.

      • +
      • Setting sys.tracebacklimit to an integer larger than LONG_MAX now means using +the limit LONG_MAX rather than the default limit.

      • +
      • Fixed integer overflows in the case of more than 2**31 traceback items on +Windows.

      • +
      • Fixed output errors handling.

      • +
      +
    • +
    • bpo-30696: Fix the interactive interpreter looping endlessly when no +memory.

    • +
    • bpo-20047: Bytearray methods partition() and rpartition() now accept only +bytes-like objects as separator, as documented. In particular they now +raise TypeError rather of returning a bogus result when an integer is +passed as a separator.

    • +
    • bpo-31852: Fix a segmentation fault caused by a combination of the async +soft keyword and continuation lines.

    • +
    • bpo-21720: BytesWarning no longer emitted when the fromlist argument of +__import__() or the __all__ attribute of the module contain bytes +instances.

    • +
    • bpo-31825: Fixed OverflowError in the ‘unicode-escape’ codec and in +codecs.escape_decode() when decode an escaped non-ascii byte.

    • +
    • bpo-28603: Print the full context/cause chain of exceptions on interpreter +exit, even if an exception in the chain is unhashable or compares equal to +later ones. Patch by Zane Bitter.

    • +
    • bpo-31786: Fix timeout rounding in the select module to round correctly +negative timeouts between -1.0 and 0.0. The functions now block waiting +for events as expected. Previously, the call was incorrectly non-blocking. +Patch by Pablo Galindo.

    • +
    • bpo-31642: Restored blocking “from package import module” by setting +sys.modules[“package.module”] to None.

    • +
    • bpo-31626: Fixed a bug in debug memory allocator. There was a write to +freed memory after shrinking a memory block.

    • +
    • bpo-31619: Fixed a ValueError when convert a string with large number of +underscores to integer with binary base.

    • +
    • bpo-31592: Fixed an assertion failure in Python parser in case of a bad +unicodedata.normalize(). Patch by Oren Milman.

    • +
    • bpo-31588: Raise a TypeError with a helpful error message when class +creation fails due to a metaclass with a bad __prepare__() method. +Patch by Oren Milman.

    • +
    • bpo-31566: Fix an assertion failure in _warnings.warn() in case of a bad +__name__ global. Patch by Oren Milman.

    • +
    • bpo-31505: Fix an assertion failure in json, in case +_json.make_encoder() received a bad encoder() argument. Patch by Oren +Milman.

    • +
    • bpo-31492: Fix assertion failures in case of failing to import from a +module with a bad __name__ attribute, and in case of failing to access +an attribute of such a module. Patch by Oren Milman.

    • +
    • bpo-31490: Fix an assertion failure in ctypes class definition, in case +the class has an attribute whose name is specified in _anonymous_ but +not in _fields_. Patch by Oren Milman.

    • +
    • bpo-31478: Fix an assertion failure in _random.Random.seed() in case the +argument has a bad __abs__() method. Patch by Oren Milman.

    • +
    • bpo-31315: Fix an assertion failure in imp.create_dynamic(), when +spec.name is not a string. Patch by Oren Milman.

    • +
    • bpo-31311: Fix a crash in the __setstate__() method of +ctypes._CData, in case of a bad __dict__. Patch by Oren Milman.

    • +
    • bpo-31293: Fix crashes in true division and multiplication of a timedelta +object by a float with a bad as_integer_ratio() method. Patch by Oren +Milman.

    • +
    • bpo-31285: Fix an assertion failure in warnings.warn_explicit, when the +return value of the received loader’s get_source() has a bad splitlines() +method. Patch by Oren Milman.

    • +
    • bpo-30817: PyErr_PrintEx() clears now the ignored exception that may be +raised by _PySys_SetObjectId(), for example when no memory.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-28556: Two minor fixes for typing module: allow shallow copying +instances of generic classes, improve interaction of __init_subclass__ +with generics. Original PRs by Ivan Levkivskyi.

    • +
    • bpo-27240: The header folding algorithm for the new email policies has +been rewritten, which also fixes bpo-30788, bpo-31831, and bpo-32182. In +particular, RFC2231 folding is now done correctly.

    • +
    • bpo-32186: io.FileIO.readall() and io.FileIO.read() now release the GIL +when getting the file size. Fixed hang of all threads with inaccessible +NFS server. Patch by Nir Soffer.

    • +
    • bpo-12239: Make msilib.SummaryInformation.GetProperty() return +None when the value of property is VT_EMPTY. Initial patch by +Mark Mc Mahon.

    • +
    • bpo-31325: Fix wrong usage of collections.namedtuple() in the +RobotFileParser.parse() +method.

      +

      Initial patch by Robin Wellner.

      +
    • +
    • bpo-12382: msilib.OpenDatabase() now raises a better exception +message when it couldn’t open or create an MSI file. Initial patch by +William Tisäter.

    • +
    • bpo-32110: codecs.StreamReader.read(n) now returns not more than n +characters/bytes for non-negative n. This makes it compatible with +read() methods of other file-like objects.

    • +
    • bpo-32072: Fixed issues with binary plists:

      +
        +
      • Fixed saving bytearrays.

      • +
      • Identical objects will be saved only once.

      • +
      • Equal references will be load as identical objects.

      • +
      • Added support for saving and loading recursive data structures.

      • +
      +
    • +
    • bpo-32034: Make asyncio.IncompleteReadError and LimitOverrunError +pickleable.

    • +
    • bpo-32015: Fixed the looping of asyncio in the case of reconnection the +socket during waiting async read/write from/to the socket.

    • +
    • bpo-32011: Restored support of loading marshal files with the TYPE_INT64 +code. These files can be produced in Python 2.7.

    • +
    • bpo-31970: Reduce performance overhead of asyncio debug mode.

    • +
    • bpo-9678: Fixed determining the MAC address in the uuid module:

      +
        +
      • Using ifconfig on NetBSD and OpenBSD.

      • +
      • Using arp on Linux, FreeBSD, NetBSD and OpenBSD.

      • +
      +

      Based on patch by Takayuki Shimizukawa.

      +
    • +
    • bpo-30057: Fix potential missed signal in signal.signal().

    • +
    • bpo-31933: Fix Blake2 params leaf_size and node_offset on big endian +platforms. Patch by Jack O’Connor.

    • +
    • bpo-31927: Fixed compilation of the socket module on NetBSD 8. Fixed +assertion failure or reading arbitrary data when parse a AF_BLUETOOTH +address on NetBSD and DragonFly BSD.

    • +
    • bpo-27666: Fixed stack corruption in curses.box() and curses.ungetmouse() +when the size of types chtype or mmask_t is less than the size of C long. +curses.box() now accepts characters as arguments. Based on patch by Steve +Fink.

    • +
    • bpo-31897: plistlib now catches more errors when read binary plists and +raises InvalidFileException instead of unexpected exceptions.

    • +
    • bpo-25720: Fix the method for checking pad state of curses WINDOW. Patch +by Masayuki Yamamoto.

    • +
    • bpo-31893: Fixed the layout of the kqueue_event structure on OpenBSD and +NetBSD. Fixed the comparison of the kqueue_event objects.

    • +
    • bpo-31891: Fixed building the curses module on NetBSD.

    • +
    • bpo-28416: Instances of pickle.Pickler subclass with the persistent_id() +method and pickle.Unpickler subclass with the persistent_load() method no +longer create reference cycles.

    • +
    • bpo-28326: Fix multiprocessing.Process when stdout and/or stderr is closed +or None.

    • +
    • bpo-31457: If nested log adapters are used, the inner process() +methods are no longer omitted.

    • +
    • bpo-31457: The manager property on LoggerAdapter objects is now +properly settable.

    • +
    • bpo-31806: Fix timeout rounding in time.sleep(), threading.Lock.acquire() +and socket.socket.settimeout() to round correctly negative timeouts +between -1.0 and 0.0. The functions now block waiting for events as +expected. Previously, the call was incorrectly non-blocking. Patch by +Pablo Galindo.

    • +
    • bpo-28603: traceback: Fix a TypeError that occurred during printing of +exception tracebacks when either the current exception or an exception in +its context/cause chain is unhashable. Patch by Zane Bitter.

    • +
    • bpo-30058: Fixed buffer overflow in select.kqueue.control().

    • +
    • bpo-31770: Prevent a crash when calling the __init__() method of a +sqlite3.Cursor object more than once. Patch by Oren Milman.

    • +
    • bpo-31672: idpattern in string.Template matched some non-ASCII +characters. Now it uses -i regular expression local flag to avoid +non-ASCII characters.

    • +
    • bpo-31764: Prevent a crash in sqlite3.Cursor.close() in case the +Cursor object is uninitialized. Patch by Oren Milman.

    • +
    • bpo-31752: Fix possible crash in timedelta constructor called with custom +integers.

    • +
    • bpo-31701: On Windows, faulthandler.enable() now ignores MSC and COM +exceptions.

    • +
    • bpo-31728: Prevent crashes in _elementtree due to unsafe cleanup of +Element.text and Element.tail. Patch by Oren Milman.

    • +
    • bpo-31620: an empty asyncio.Queue now doesn’t leak memory when queue.get +pollers timeout

    • +
    • bpo-31632: Fix method set_protocol() of class _SSLProtocolTransport in +asyncio module. This method was previously modifying a wrong reference to +the protocol.

    • +
    • bpo-31675: Fixed memory leaks in Tkinter’s methods splitlist() and split() +when pass a string larger than 2 GiB.

    • +
    • bpo-31673: Fixed typo in the name of Tkinter’s method adderrorinfo().

    • +
    • bpo-30806: Fix the string representation of a netrc object.

    • +
    • bpo-15037: Added a workaround for getkey() in curses for ncurses 5.7 and +earlier.

    • +
    • bpo-25351: Avoid venv activate failures with undefined variables

    • +
    • bpo-25532: inspect.unwrap() will now only try to unwrap an object +sys.getrecursionlimit() times, to protect against objects which create a +new object on every attribute access.

    • +
    • bpo-30347: Stop crashes when concurrently iterate over itertools.groupby() +iterators.

    • +
    • bpo-31516: threading.current_thread() should not return a dummy thread +at shutdown.

    • +
    • bpo-31351: python -m ensurepip now exits with non-zero exit code if pip +bootstrapping has failed.

    • +
    • bpo-31482: random.seed() now works with bytes in version=1

    • +
    • bpo-31334: Fix poll.poll([timeout]) in the select module for +arbitrary negative timeouts on all OSes where it can only be a +non-negative integer or -1. Patch by Riccardo Coccioli.

    • +
    • bpo-31310: multiprocessing’s semaphore tracker should be launched again if +crashed.

    • +
    • bpo-31308: Make multiprocessing’s forkserver process immune to Ctrl-C and +other user interruptions. If it crashes, restart it when necessary.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-32105: Added asyncio.BaseEventLoop.connect_accepted_socket +versionadded marker.

    • +
    • bpo-31537: Fix incorrect usage of get_history_length in readline +documentation example code. Patch by Brad Smith.

    • +
    • bpo-30085: The operator functions without double underscores are preferred +for clarity. The one with underscores are only kept for +back-compatibility.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-31380: Skip test_httpservers test_undecodable_file on macOS: fails on +APFS.

    • +
    • bpo-31705: Skip test_socket.test_sha256() on Linux kernel older than 4.5. +The test fails with ENOKEY on kernel 3.10 (on ppc64le). A fix was merged +into the kernel 4.5.

    • +
    • bpo-31174: Fix test_tools.test_unparse: DirectoryTestCase now stores the +names sample to always test the same files. It prevents false alarms when +hunting reference leaks.

    • +
    • bpo-30695: Add the set_nomemory(start, stop) and remove_mem_hooks() +functions to the _testcapi module.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-32059: detect_modules() in setup.py now also searches the +sysroot paths when cross-compiling.

    • +
    • bpo-31957: Fixes Windows SDK version detection when building for Windows.

    • +
    • bpo-31609: Fixes quotes in PCbuild/clean.bat

    • +
    • bpo-31934: Abort the build when building out of a not clean source tree.

    • +
    • bpo-31926: Fixed Argument Clinic sometimes causing compilation errors when +there was more than one function and/or method in a .c file with the same +name.

    • +
    • bpo-28791: Update Windows builds to use SQLite 3.21.0.

    • +
    • bpo-28791: Update OS X installer to use SQLite 3.21.0.

    • +
    • bpo-22140: Prevent double substitution of prefix in python-config.sh.

    • +
    • bpo-31536: Avoid wholesale rebuild after make regen-all if nothing +changed.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-1102: Return None when View.Fetch() returns +ERROR_NO_MORE_ITEMS instead of raising MSIError.

      +

      Initial patch by Anthony Tuininga.

      +
    • +
    • bpo-31944: Fixes Modify button in Apps and Features dialog.

    • +
    +
    +
    +

    macOS

    +
      +
    • bpo-31392: Update macOS installer to use OpenSSL 1.0.2m

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-32207: Improve tk event exception tracebacks in IDLE. When tk event +handling is driven by IDLE’s run loop, a confusing and distracting +queue.EMPTY traceback context is no longer added to tk event exception +tracebacks. The traceback is now the same as when event handling is +driven by user code. Patch based on a suggestion by Serhiy Storchaka.

    • +
    • bpo-32164: Delete unused file idlelib/tabbedpages.py. Use of TabbedPageSet +in configdialog was replaced by ttk.Notebook.

    • +
    • bpo-32100: IDLE: Fix old and new bugs in pathbrowser; improve tests. Patch +mostly by Cheryl Sabella.

    • +
    • bpo-31858: IDLE – Restrict shell prompt manipulation to the shell. Editor +and output windows only see an empty last prompt line. This simplifies +the code and fixes a minor bug when newline is inserted. Sys.ps1, if +present, is read on Shell start-up, but is not set or changed.

    • +
    • bpo-31860: The font sample in the IDLE configuration dialog is now +editable. Changes persist while IDLE remains open

    • +
    • bpo-31836: Test_code_module now passes if run after test_idle, which sets +ps1.

      +

      The code module uses sys.ps1 if present or sets it to ‘>>> ‘ if not. +Test_code_module now properly tests both behaviors. Ditto for ps2.

      +
    • +
    • bpo-28603: Fix a TypeError that caused a shell restart when printing a +traceback that includes an exception that is unhashable. Patch by Zane +Bitter.

    • +
    • bpo-13802: Use non-Latin characters in the IDLE’s Font settings sample. +Even if one selects a font that defines a limited subset of the unicode +Basic Multilingual Plane, tcl/tk will use other fonts that define a +character. The expanded example give users of non-Latin characters a +better idea of what they might see in IDLE’s shell and editors. To make +room for the expanded sample, frames on the Font tab are re-arranged. The +Font/Tabs help explains a bit about the additions.

    • +
    • bpo-31460: Simplify the API of IDLE’s Module Browser.

      +

      Passing a widget instead of an flist with a root widget opens the option +of creating a browser frame that is only part of a window. Passing a full +file name instead of pieces assumed to come from a .py file opens the +possibility of browsing python files that do not end in .py.

      +
    • +
    • bpo-31649: IDLE - Make _htest, _utest parameters keyword only.

    • +
    • bpo-31559: Remove test order dependence in idle_test.test_browser.

    • +
    • bpo-31459: Rename IDLE’s module browser from Class Browser to Module +Browser. The original module-level class and method browser became a +module browser, with the addition of module-level functions, years ago. +Nested classes and functions were added yesterday. For +back-compatibility, the virtual event <<open-class-browser>>, which +appears on the Keys tab of the Settings dialog, is not changed. Patch by +Cheryl Sabella.

    • +
    • bpo-31500: Default fonts now are scaled on HiDPI displays.

    • +
    • bpo-1612262: IDLE module browser now shows nested classes and functions. +Original patches for code and tests by Guilherme Polo and Cheryl Sabella, +respectively.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-30722: Make redemo work with Python 3.6 and newer versions.

      +

      Also, remove the LOCALE option since it doesn’t work with string +patterns in Python 3.

      +

      Patch by Christoph Sarnowski.

      +
    • +
    +
    +
    +

    C API

    +
      +
    • bpo-20891: Fix PyGILState_Ensure(). When PyGILState_Ensure() is called in +a non-Python thread before PyEval_InitThreads(), only call +PyEval_InitThreads() after calling PyThreadState_New() to fix a crash.

    • +
    • bpo-31532: Fix memory corruption due to allocator mix in getpath.c between +Py_GetPath() and Py_SetPath()

    • +
    • bpo-30697: The PyExc_RecursionErrorInst singleton is removed and +PyErr_NormalizeException() does not use it anymore. This singleton is +persistent and its members being never cleared may cause a segfault during +finalization of the interpreter. See also bpo-22898.

    • +
    +
    +
    +
    +

    Python 3.6.3 final

    +

    Release date: 2017-10-03

    +
    +

    Library

    + +
    +
    +

    Build

    +
      +
    • bpo-31662: Fix typos in Windows uploadrelease.bat script. Fix Windows +Doc build issues in Doc/make.bat.

    • +
    • bpo-31423: Fix building the PDF documentation with newer versions of +Sphinx.

    • +
    +
    +
    +
    +

    Python 3.6.3 release candidate 1

    +

    Release date: 2017-09-18

    +
    +

    Security

    +
      +
    • bpo-29781: SSLObject.version() now correctly returns None when handshake +over BIO has not been performed yet.

    • +
    • bpo-30947: Upgrade libexpat embedded copy from version 2.2.1 to 2.2.3 to +get security fixes.

    • +
    +
    +
    +

    Core and Builtins

    +
      +
    • bpo-31471: Fix an assertion failure in subprocess.Popen() on Windows, in +case the env argument has a bad keys() method. Patch by Oren Milman.

    • +
    • bpo-31418: Fix an assertion failure in PyErr_WriteUnraisable() in case +of an exception with a bad __module__ attribute. Patch by Oren Milman.

    • +
    • bpo-31416: Fix assertion failures in case of a bad warnings.filters or +warnings.defaultaction. Patch by Oren Milman.

    • +
    • bpo-31411: Raise a TypeError instead of SystemError in case +warnings.onceregistry is not a dictionary. Patch by Oren Milman.

    • +
    • bpo-31373: Fix several possible instances of undefined behavior due to +floating-point demotions.

    • +
    • bpo-30465: Location information (lineno and col_offset) in +f-strings is now (mostly) correct. This fixes tools like flake8 from +showing warnings on the wrong line (typically the first line of the file).

    • +
    • bpo-31343: Include sys/sysmacros.h for major(), minor(), and makedev(). +GNU C libray plans to remove the functions from sys/types.h.

    • +
    • bpo-31291: Fix an assertion failure in zipimport.zipimporter.get_data on +Windows, when the return value of pathname.replace('/','\\') isn’t a +string. Patch by Oren Milman.

    • +
    • bpo-31271: Fix an assertion failure in the write() method of +io.TextIOWrapper, when the encoder doesn’t return a bytes object. Patch +by Oren Milman.

    • +
    • bpo-31243: Fix a crash in some methods of io.TextIOWrapper, when the +decoder’s state is invalid. Patch by Oren Milman.

    • +
    • bpo-30721: print now shows correct usage hint for using Python 2 +redirection syntax. Patch by Sanyam Khurana.

    • +
    • bpo-31070: Fix a race condition in importlib _get_module_lock().

    • +
    • bpo-31095: Fix potential crash during GC caused by tp_dealloc which +doesn’t call PyObject_GC_UnTrack().

    • +
    • bpo-31071: Avoid masking original TypeError in call with * unpacking when +other arguments are passed.

    • +
    • bpo-30978: str.format_map() now passes key lookup exceptions through. +Previously any exception was replaced with a KeyError exception.

    • +
    • bpo-30808: Use _Py_atomic API for concurrency-sensitive signal state.

    • +
    • bpo-30876: Relative import from unloaded package now reimports the package +instead of failing with SystemError. Relative import from non-package now +fails with ImportError rather than SystemError.

    • +
    • bpo-30703: Improve signal delivery.

      +

      Avoid using Py_AddPendingCall from signal handler, to avoid calling +signal-unsafe functions. The tests I’m adding here fail without the rest +of the patch, on Linux and OS X. This means our signal delivery logic had +defects (some signals could be lost).

      +
    • +
    • bpo-30765: Avoid blocking in pthread_mutex_lock() when +PyThread_acquire_lock() is asked not to block.

    • +
    • bpo-31161: Make sure the ‘Missing parentheses’ syntax error message is +only applied to SyntaxError, not to subclasses. Patch by Martijn Pieters.

    • +
    • bpo-30814: Fixed a race condition when import a submodule from a package.

    • +
    • bpo-30597: print now shows expected input in custom error message when +used as a Python 2 statement. Patch by Sanyam Khurana.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-31499: xml.etree: Fix a crash when a parser is part of a reference +cycle.

    • +
    • bpo-28556: typing.get_type_hints now finds the right globalns for classes +and modules by default (when no globalns was specified by the caller).

    • +
    • bpo-28556: Speed improvements to the typing module. Original PRs by +Ivan Levkivskyi and Mitar.

    • +
    • bpo-31544: The C accelerator module of ElementTree ignored exceptions +raised when looking up TreeBuilder target methods in XMLParser().

    • +
    • bpo-31234: socket.create_connection() now fixes manually a reference +cycle: clear the variable storing the last exception on success.

    • +
    • bpo-31457: LoggerAdapter objects can now be nested.

    • +
    • bpo-31400: Improves SSL error handling to avoid losing error numbers.

    • +
    • bpo-28958: ssl.SSLContext() now uses OpenSSL error information when a +context cannot be instantiated.

    • +
    • bpo-27340: SSLSocket.sendall() now uses memoryview to create slices of +data. This fixes support for all bytes-like object. It is also more +efficient and avoids costly copies.

    • +
    • bpo-31178: Fix string concatenation bug in rare error path in the +subprocess module

    • +
    • bpo-31350: Micro-optimize asyncio._get_running_loop() to become up +to 10% faster.

    • +
    • bpo-31170: expat: Update libexpat from 2.2.3 to 2.2.4. Fix copying of +partial characters for UTF-8 input (libexpat bug 115): +https://github.com/libexpat/libexpat/issues/115

    • +
    • bpo-29136: Add TLS 1.3 cipher suites and OP_NO_TLSv1_3.

    • +
    • bpo-29212: Fix concurrent.futures.thread.ThreadPoolExecutor threads to +have a non repr() based thread name by default when no thread_name_prefix +is supplied. They will now identify themselves as +“ThreadPoolExecutor-y_n”.

    • +
    • bpo-9146: Fix a segmentation fault in _hashopenssl when standard hash +functions such as md5 are not available in the linked OpenSSL library. As +in some special FIPS-140 build environments.

    • +
    • bpo-27144: The map() and as_completed() iterators in +concurrent.futures now avoid keeping a reference to yielded objects.

    • +
    • bpo-10746: Fix ctypes producing wrong PEP 3118 type codes for integer +types.

    • +
    • bpo-22536: The subprocess module now sets the filename when +FileNotFoundError is raised on POSIX systems due to the executable or cwd +not being found.

    • +
    • bpo-31249: concurrent.futures: WorkItem.run() used by ThreadPoolExecutor +now breaks a reference cycle between an exception object and the WorkItem +object.

    • +
    • bpo-31247: xmlrpc.server now explicitly breaks reference cycles when using +sys.exc_info() in code handling exceptions.

    • +
    • bpo-30102: The ssl and hashlib modules now call +OPENSSL_add_all_algorithms_noconf() on OpenSSL < 1.1.0. The function +detects CPU features and enables optimizations on some CPU architectures +such as POWER8. Patch is based on research from Gustavo Serra Scalet.

    • +
    • bpo-31185: Fixed miscellaneous errors in asyncio speedup module.

    • +
    • bpo-31135: ttk: fix the destroy() method of LabeledScale and OptionMenu +classes. Call the parent destroy() method even if the used attribute +doesn’t exist. The LabeledScale.destroy() method now also explicitly +clears label and scale attributes to help the garbage collector to destroy +all widgets.

    • +
    • bpo-31107: Fix copyreg._slotnames() mangled attribute calculation for +classes whose name begins with an underscore. Patch by Shane Harvey.

    • +
    • bpo-31061: Fixed a crash when using asyncio and threads.

    • +
    • bpo-30502: Fix handling of long oids in ssl. Based on patch by Christian +Heimes.

    • +
    • bpo-30119: ftplib.FTP.putline() now throws ValueError on commands that +contains CR or LF. Patch by Dong-hee Na.

    • +
    • bpo-30595: multiprocessing.Queue.get() with a timeout now polls its reader +in non-blocking mode if it succeeded to acquire the lock but the acquire +took longer than the timeout.

    • +
    • bpo-29403: Fix unittest.mock’s autospec to not fail on method-bound +builtin functions. Patch by Aaron Gallagher.

    • +
    • bpo-30961: Fix decrementing a borrowed reference in tracemalloc.

    • +
    • bpo-25684: Change ttk.OptionMenu radiobuttons to be unique across +instances of OptionMenu.

    • +
    • bpo-30886: Fix multiprocessing.Queue.join_thread(): it now waits until the +thread completes, even if the thread was started by the same process which +created the queue.

    • +
    • bpo-29854: Fix segfault in readline when using readline’s history-size +option. Patch by Nir Soffer.

    • +
    • bpo-30319: socket.close() now ignores ECONNRESET error.

    • +
    • bpo-30828: Fix out of bounds write in +asyncio.CFuture.remove_done_callback().

    • +
    • bpo-30807: signal.setitimer() may disable the timer when passed a tiny +value.

      +

      Tiny values (such as 1e-6) are valid non-zero values for setitimer(), +which is specified as taking microsecond-resolution intervals. However, on +some platform, our conversion routine could convert 1e-6 into a zero +interval, therefore disabling the timer instead of (re-)scheduling it.

      +
    • +
    • bpo-30441: Fix bug when modifying os.environ while iterating over it

    • +
    • bpo-30532: Fix email header value parser dropping folding white space in +certain cases.

    • +
    • bpo-30879: os.listdir() and os.scandir() now emit bytes names when called +with bytes-like argument.

    • +
    • bpo-30746: Prohibited the ‘=’ character in environment variable names in +os.putenv() and os.spawn*().

    • +
    • bpo-29755: Fixed the lgettext() family of functions in the gettext module. +They now always return bytes.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-31294: Fix incomplete code snippet in the ZeroMQSocketListener and +ZeroMQSocketHandler examples and adapt them to Python 3.

    • +
    • bpo-21649: Add RFC 7525 and Mozilla server side TLS links to SSL +documentation.

    • +
    • bpo-30803: Clarify doc on truth value testing. Original patch by Peter +Thomassen.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-31320: Silence traceback in test_ssl

    • +
    • bpo-25674: Remove sha256.tbs-internet.com ssl test

    • +
    • bpo-30715: Address ALPN callback changes for OpenSSL 1.1.0f. The latest +version behaves like OpenSSL 1.0.2 and no longer aborts handshake.

    • +
    • bpo-30822: regrtest: Exclude tzdata from regrtest –all. When running the +test suite using –use=all / -u all, exclude tzdata since it makes +test_datetime too slow (15-20 min on some buildbots) which then times out +on some buildbots. Fix also regrtest command line parser to allow passing +-u extralargefile to run test_zipfile64.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-30854: Fix compile error when compiling –without-threads. Patch by +Masayuki Yamamoto.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-30389: Adds detection of Visual Studio 2017 to distutils on Windows.

    • +
    • bpo-31340: Change to building with MSVC v141 (included with Visual Studio +2017)

    • +
    • bpo-30581: os.cpu_count() now returns the correct number of processors on +Windows when the number of logical processors is greater than 64.

    • +
    • bpo-30731: Add a missing xmlns to python.manifest so that it matches the +schema.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-31493: IDLE code context – fix code update and font update timers.

      +

      Canceling timers prevents a warning message when test_idle completes.

      +
    • +
    • bpo-31488: IDLE - Update non-key options in former extension classes. When +applying configdialog changes, call .reload for each feature class. Change +ParenMatch so updated options affect existing instances attached to +existing editor windows.

    • +
    • bpo-31477: IDLE - Improve rstrip entry in doc. Strip trailing whitespace +strips more than blank spaces. Multiline string literals are not skipped.

    • +
    • bpo-31480: IDLE - make tests pass with zzdummy extension disabled by +default.

    • +
    • bpo-31421: Document how IDLE runs tkinter programs. IDLE calls tcl/tk +update in the background in order to make live

      +

      interaction and experimentation with tkinter applications much easier.

      +
    • +
    • bpo-31414: IDLE – fix tk entry box tests by deleting first. Adding to an +int entry is not the same as deleting and inserting because int(‘’) will +fail.

    • +
    • bpo-31051: Rearrange IDLE configdialog GenPage into Window, Editor, and +Help sections.

    • +
    • bpo-30617: IDLE - Add docstrings and tests for outwin subclass of editor.

      +

      Move some data and functions from the class to module level. Patch by +Cheryl Sabella.

      +
    • +
    • bpo-31287: IDLE - Do not modify tkinter.message in test_configdialog.

    • +
    • bpo-27099: Convert IDLE’s built-in ‘extensions’ to regular features.

      +

      About 10 IDLE features were implemented as supposedly optional extensions. +Their different behavior could be confusing or worse for users and not +good for maintenance. Hence the conversion.

      +

      The main difference for users is that user configurable key bindings for +builtin features are now handled uniformly. Now, editing a binding in a +keyset only affects its value in the keyset. All bindings are defined +together in the system-specific default keysets in config-extensions.def. +All custom keysets are saved as a whole in config-extension.cfg. All take +effect as soon as one clicks Apply or Ok.

      +

      The affected events are ‘<<force-open-completions>>’, ‘<<expand-word>>’, +‘<<force-open-calltip>>’, ‘<<flash-paren>>’, ‘<<format-paragraph>>’, +‘<<run-module>>’, ‘<<check-module>>’, and ‘<<zoom-height>>’. Any (global) +customizations made before 3.6.3 will not affect their keyset-specific +customization after 3.6.3. and vice versa.

      +

      Inital patch by Charles Wohlganger.

      +
    • +
    • bpo-31206: IDLE: Factor HighPage(Frame) class from ConfigDialog. Patch by +Cheryl Sabella.

    • +
    • bpo-31001: Add tests for configdialog highlight tab. Patch by Cheryl +Sabella.

    • +
    • bpo-31205: IDLE: Factor KeysPage(Frame) class from ConfigDialog. The +slightly modified tests continue to pass. Patch by Cheryl Sabella.

    • +
    • bpo-31130: IDLE – stop leaks in test_configdialog. Initial patch by +Victor Stinner.

    • +
    • bpo-31002: Add tests for configdialog keys tab. Patch by Cheryl Sabella.

    • +
    • bpo-19903: IDLE: Calltips use inspect.signature instead of +inspect.getfullargspec. This improves calltips for builtins converted to +use Argument Clinic. Patch by Louie Lu.

    • +
    • bpo-31083: IDLE - Add an outline of a TabPage class in configdialog. +Update existing classes to match outline. Initial patch by Cheryl Sabella.

    • +
    • bpo-31050: Factor GenPage(Frame) class from ConfigDialog. The slightly +modified tests continue to pass. Patch by Cheryl Sabella.

    • +
    • bpo-31004: IDLE - Factor FontPage(Frame) class from ConfigDialog.

      +

      Slightly modified tests continue to pass. Fix General tests. Patch mostly +by Cheryl Sabella.

      +
    • +
    • bpo-30781: IDLE - Use ttk widgets in ConfigDialog. Patches by Terry Jan +Reedy and Cheryl Sabella.

    • +
    • bpo-31060: IDLE - Finish rearranging methods of ConfigDialog Grouping +methods pertaining to each tab and the buttons will aid writing tests and +improving the tabs and will enable splitting the groups into classes.

    • +
    • bpo-30853: IDLE – Factor a VarTrace class out of ConfigDialog.

      +

      Instance tracers manages pairs consisting of a tk variable and a callback +function. When tracing is turned on, setting the variable calls the +function. Test coverage for the new class is 100%.

      +
    • +
    • bpo-31003: IDLE: Add more tests for General tab.

    • +
    • bpo-30993: IDLE - Improve configdialog font page and tests.

      +

      In configdialog: Document causal pathways in create_font_tab docstring. +Simplify some attribute names. Move set_samples calls to var_changed_font +(idea from Cheryl Sabella). Move related functions to positions after the +create widgets function.

      +

      In test_configdialog: Fix test_font_set so not order dependent. Fix +renamed test_indent_scale so it tests the widget. Adjust tests for +movement of set_samples call. Add tests for load functions. Put all font +tests in one class and tab indent tests in another. Except for two lines, +these tests completely cover the related functions.

      +
    • +
    • bpo-30981: IDLE – Add more configdialog font page tests.

    • +
    • bpo-28523: IDLE: replace ‘colour’ with ‘color’ in configdialog.

    • +
    • bpo-30917: Add tests for idlelib.config.IdleConf. Increase coverage from +46% to 96%. Patch by Louie Lu.

    • +
    • bpo-30934: Document coverage details for idlelib tests.

      +
        +
      • Add section to idlelib/idle-test/README.txt.

      • +
      • Include check that branches are taken both ways.

      • +
      • Exclude IDLE-specific code that does not run during unit tests.

      • +
      +
    • +
    • bpo-30913: IDLE: Document ConfigDialog tk Vars, methods, and widgets in +docstrings This will facilitate improving the dialog and splitting up the +class. Original patch by Cheryl Sabella.

    • +
    • bpo-30899: IDLE: Add tests for ConfigParser subclasses in config. Patch by +Louie Lu.

    • +
    • bpo-30881: IDLE: Add docstrings to browser.py. Patch by Cheryl Sabella.

    • +
    • bpo-30851: IDLE: Remove unused variables in configdialog. One is a +duplicate, one is set but cannot be altered by users. Patch by Cheryl +Sabella.

    • +
    • bpo-30870: IDLE: In Settings dialog, select font with Up, Down keys as +well as mouse. Initial patch by Louie Lu.

    • +
    • bpo-8231: IDLE: call config.IdleConf.GetUserCfgDir only once.

    • +
    • bpo-30779: IDLE: Factor ConfigChanges class from configdialog, put in +config; test. * In config, put dump test code in a function; run it and +unittest in ‘if __name__ == ‘__main__’. * Add class config.ConfigChanges +based on changes_class_v4.py on bpo issue. * Add class +test_config.ChangesTest, partly using configdialog_tests_v1.py. * Revise +configdialog to use ConfigChanges; see tracker msg297804. * Revise +test_configdialog to match configdialog changes. * Remove configdialog +functions unused or moved to ConfigChanges. Cheryl Sabella contributed +parts of the patch.

    • +
    • bpo-30777: IDLE: configdialog - Add docstrings and fix comments. Patch by +Cheryl Sabella.

    • +
    • bpo-30495: IDLE: Improve textview with docstrings, PEP8 names, and more +tests. Patch by Cheryl Sabella.

    • +
    • bpo-30723: IDLE: Make several improvements to parenmatch. Add ‘parens’ +style to highlight both opener and closer. Make ‘default’ style, which is +not default, a synonym for ‘opener’. Make time-delay work the same with +all styles. Add help for config dialog extensions tab, including help for +parenmatch. Add new tests. Original patch by Charles Wohlganger.

    • +
    • bpo-30674: IDLE: add docstrings to grep module. Patch by Cheryl Sabella

    • +
    • bpo-21519: IDLE’s basic custom key entry dialog now detects duplicates +properly. Original patch by Saimadhav Heblikar.

    • +
    • bpo-29910: IDLE no longer deletes a character after commenting out a +region by a key shortcut. Add return 'break' for this and other +potential conflicts between IDLE and default key bindings.

    • +
    • bpo-30728: Review and change idlelib.configdialog names. Lowercase method +and attribute names. Replace ‘colour’ with ‘color’, expand overly cryptic +names, delete unneeded underscores. Replace import * with specific +imports. Patches by Cheryl Sabella.

    • +
    • bpo-6739: IDLE: Verify user-entered key sequences by trying to bind them +with tk. Add tests for all 3 validation functions. Original patch by G +Polo. Tests added by Cheryl Sabella.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-30983: gdb integration commands (py-bt, etc.) work on optimized shared +builds now, too. PEP 523 introduced _PyEval_EvalFrameDefault which +inlines PyEval_EvalFrameEx on non-debug shared builds. This broke the +ability to use py-bt, py-up, and a few other Python-specific gdb +integrations. The problem is fixed by only looking for +_PyEval_EvalFrameDefault frames in python-gdb.py. Original patch by Bruno +“Polaco” Penteado.

    • +
    +
    +
    +
    +

    Python 3.6.2 final

    +

    Release date: 2017-07-17

    +

    No changes since release candidate 2

    +
    +
    +

    Python 3.6.2 release candidate 2

    +

    Release date: 2017-07-07

    +
    +

    Security

    +
      +
    • bpo-30730: Prevent environment variables injection in subprocess on +Windows. Prevent passing other environment variables and command +arguments.

    • +
    • bpo-30694: Upgrade expat copy from 2.2.0 to 2.2.1 to get fixes of multiple +security vulnerabilities including: CVE-2017-9233 (External entity +infinite loop DoS), CVE-2016-9063 (Integer overflow, re-fix), +CVE-2016-0718 (Fix regression bugs from 2.2.0’s fix to CVE-2016-0718) and +CVE-2012-0876 (Counter hash flooding with SipHash). Note: the +CVE-2016-5300 (Use os-specific entropy sources like getrandom) doesn’t +impact Python, since Python already gets entropy from the OS to set the +expat secret using XML_SetHashSalt().

    • +
    • bpo-30500: Fix urllib.parse.splithost() to correctly parse fragments. For +example, splithost('//127.0.0.1#@evil.com/') now correctly returns the +127.0.0.1 host, instead of treating @evil.com as the host in an +authentication (login@host).

    • +
    +
    +
    +
    +

    Python 3.6.2 release candidate 1

    +

    Release date: 2017-06-17

    +
    +

    Core and Builtins

    +
      +
    • bpo-30682: Removed a too-strict assertion that failed for certain +f-strings, such as eval(“f’\n’”) and eval(“f’\r’”).

    • +
    • bpo-30604: Move co_extra_freefuncs to not be per-thread to avoid crashes

    • +
    • bpo-29104: Fixed parsing backslashes in f-strings.

    • +
    • bpo-27945: Fixed various segfaults with dict when input collections are +mutated during searching, inserting or comparing. Based on patches by +Duane Griffin and Tim Mitchell.

    • +
    • bpo-25794: Fixed type.__setattr__() and type.__delattr__() for +non-interned attribute names. Based on patch by Eryk Sun.

    • +
    • bpo-30039: If a KeyboardInterrupt happens when the interpreter is in the +middle of resuming a chain of nested ‘yield from’ or ‘await’ calls, it’s +now correctly delivered to the innermost frame.

    • +
    • bpo-12414: sys.getsizeof() on a code object now returns the sizes which +includes the code struct and sizes of objects which it references. Patch +by Dong-hee Na.

    • +
    • bpo-29949: Fix memory usage regression of set and frozenset object.

    • +
    • bpo-29935: Fixed error messages in the index() method of tuple, list and +deque when pass indices of wrong type.

    • +
    • bpo-29859: Show correct error messages when any of the pthread_* calls in +thread_pthread.h fails.

    • +
    • bpo-28876: bool(range) works even if len(range) raises +OverflowError.

    • +
    • bpo-29600: Fix wrapping coroutine return values in StopIteration.

    • +
    • bpo-28856: Fix an oversight that %b format for bytes should support +objects follow the buffer protocol.

    • +
    • bpo-29714: Fix a regression that bytes format may fail when containing +zero bytes inside.

    • +
    • bpo-29478: If max_line_length=None is specified while using the Compat32 +policy, it is no longer ignored. Patch by Mircea Cosbuc.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-30616: Functional API of enum allows to create empty enums. Patched by +Dong-hee Na

    • +
    • bpo-30038: Fix race condition between signal delivery and wakeup file +descriptor. Patch by Nathaniel Smith.

    • +
    • bpo-23894: lib2to3 now recognizes rb'...' and f'...' strings.

    • +
    • bpo-23890: unittest.TestCase.assertRaises() now manually breaks a +reference cycle to not keep objects alive longer than expected.

    • +
    • bpo-30149: inspect.signature() now supports callables with +variable-argument parameters wrapped with partialmethod. Patch by Dong-hee +Na.

    • +
    • bpo-30645: Fix path calculation in imp.load_package(), fixing it for cases +when a package is only shipped with bytecodes. Patch by Alexandru +Ardelean.

    • +
    • bpo-29931: Fixed comparison check for ipaddress.ip_interface objects. +Patch by Sanjay Sundaresan.

    • +
    • bpo-30605: re.compile() no longer raises a BytesWarning when compiling a +bytes instance with misplaced inline modifier. Patch by Roy Williams.

    • +
    +
    +
    +

    Security

    + +
    +
    +

    Library

    +
      +
    • bpo-24484: Avoid race condition in multiprocessing cleanup (#2159)

    • +
    • bpo-28994: The traceback no longer displayed for SystemExit raised in a +callback registered by atexit.

    • +
    • bpo-30508: Don’t log exceptions if Task/Future “cancel()” method was +called.

    • +
    • bpo-28556: Updates to typing module: Add generic AsyncContextManager, add +support for ContextManager on all versions. Original PRs by Jelle Zijlstra +and Ivan Levkivskyi

    • +
    • bpo-29870: Fix ssl sockets leaks when connection is aborted in asyncio/ssl +implementation. Patch by Michaël Sghaïer.

    • +
    • bpo-29743: Closing transport during handshake process leaks open socket. +Patch by Nikolay Kim

    • +
    • bpo-27585: Fix waiter cancellation in asyncio.Lock. Patch by Mathieu +Sornay.

    • +
    • bpo-30418: On Windows, subprocess.Popen.communicate() now also ignore +EINVAL on stdin.write() if the child process is still running but closed +the pipe.

    • +
    • bpo-29822: inspect.isabstract() now works during __init_subclass__. Patch +by Nate Soares.

    • +
    • bpo-29581: ABCMeta.__new__ now accepts **kwargs, allowing abstract +base classes to use keyword parameters in __init_subclass__. Patch by Nate +Soares.

    • +
    • bpo-30557: faulthandler now correctly filters and displays exception codes +on Windows

    • +
    • bpo-30378: Fix the problem that logging.handlers.SysLogHandler cannot +handle IPv6 addresses.

    • +
    • bpo-29960: Preserve generator state when _random.Random.setstate() raises +an exception. Patch by Bryan Olson.

    • +
    • bpo-30414: multiprocessing.Queue._feed background running thread do not +break from main loop on exception.

    • +
    • bpo-30003: Fix handling escape characters in HZ codec. Based on patch by +Ma Lin.

    • +
    • bpo-30301: Fix AttributeError when using SimpleQueue.empty() under spawn +and forkserver start methods.

    • +
    • bpo-30329: imaplib and poplib now catch the Windows socket WSAEINVAL error +(code 10022) on shutdown(SHUT_RDWR): An invalid operation was attempted. +This error occurs sometimes on SSL connections.

    • +
    • bpo-30375: Warnings emitted when compile a regular expression now always +point to the line in the user code. Previously they could point into +inners of the re module if emitted from inside of groups or conditionals.

    • +
    • bpo-30048: Fixed Task.cancel() can be ignored when the task is running +coroutine and the coroutine returned without any more await.

    • +
    • bpo-30266: contextlib.AbstractContextManager now supports +anti-registration by setting __enter__ = None or __exit__ = None, +following the pattern introduced in bpo-25958. Patch by Jelle Zijlstra.

    • +
    • bpo-30298: Weaken the condition of deprecation warnings for inline +modifiers. Now allowed several subsequential inline modifiers at the start +of the pattern (e.g. '(?i)(?s)...'). In verbose mode whitespaces and +comments now are allowed before and between inline modifiers (e.g. '(?x) +(?i) (?s)...').

    • +
    • bpo-29990: Fix range checking in GB18030 decoder. Original patch by Ma +Lin.

    • +
    • bpo-26293: Change resulted because of zipfile breakage. (See also: +bpo-29094)

    • +
    • bpo-30243: Removed the __init__ methods of _json’s scanner and encoder. +Misusing them could cause memory leaks or crashes. Now scanner and +encoder objects are completely initialized in the __new__ methods.

    • +
    • bpo-30185: Avoid KeyboardInterrupt tracebacks in forkserver helper process +when Ctrl-C is received.

    • +
    • bpo-28556: Various updates to typing module: add typing.NoReturn type, use +WrapperDescriptorType, minor bug-fixes. Original PRs by Jim +Fasarakis-Hilliard and Ivan Levkivskyi.

    • +
    • bpo-30205: Fix getsockname() for unbound AF_UNIX sockets on Linux.

    • +
    • bpo-30070: Fixed leaks and crashes in errors handling in the parser +module.

    • +
    • bpo-30061: Fixed crashes in IOBase methods __next__() and readlines() when +readline() or __next__() respectively return non-sizeable object. Fixed +possible other errors caused by not checking results of PyObject_Size(), +PySequence_Size(), or PyMapping_Size().

    • +
    • bpo-30017: Allowed calling the close() method of the zip entry writer +object multiple times. Writing to a closed writer now always produces a +ValueError.

    • +
    • bpo-30068: _io._IOBase.readlines will check if it’s closed first when hint +is present.

    • +
    • bpo-29694: Fixed race condition in pathlib mkdir with flags parents=True. +Patch by Armin Rigo.

    • +
    • bpo-29692: Fixed arbitrary unchaining of RuntimeError exceptions in +contextlib.contextmanager. Patch by Siddharth Velankar.

    • +
    • bpo-29998: Pickling and copying ImportError now preserves name and path +attributes.

    • +
    • bpo-29953: Fixed memory leaks in the replace() method of datetime and time +objects when pass out of bound fold argument.

    • +
    • bpo-29942: Fix a crash in itertools.chain.from_iterable when encountering +long runs of empty iterables.

    • +
    • bpo-27863: Fixed multiple crashes in ElementTree caused by race conditions +and wrong types.

    • +
    • bpo-28699: Fixed a bug in pools in multiprocessing.pool that raising an +exception at the very first of an iterable may swallow the exception or +make the program hang. Patch by Davin Potts and Xiang Zhang.

    • +
    • bpo-25803: Avoid incorrect errors raised by Path.mkdir(exist_ok=True) when +the OS gives priority to errors such as EACCES over EEXIST.

    • +
    • bpo-29861: Release references to tasks, their arguments and their results +as soon as they are finished in multiprocessing.Pool.

    • +
    • bpo-29884: faulthandler: Restore the old sigaltstack during teardown. +Patch by Christophe Zeitouny.

    • +
    • bpo-25455: Fixed crashes in repr of recursive buffered file-like objects.

    • +
    • bpo-29800: Fix crashes in partial.__repr__ if the keys of partial.keywords +are not strings. Patch by Michael Seifert.

    • +
    • bpo-29742: get_extra_info() raises exception if get called on closed ssl +transport. Patch by Nikolay Kim.

    • +
    • bpo-8256: Fixed possible failing or crashing input() if attributes +“encoding” or “errors” of sys.stdin or sys.stdout are not set or are not +strings.

    • +
    • bpo-28298: Fix a bug that prevented array ‘Q’, ‘L’ and ‘I’ from accepting +big intables (objects that have __int__) as elements. Patch by Oren +Milman.

    • +
    • bpo-28231: The zipfile module now accepts path-like objects for external +paths.

    • +
    • bpo-26915: index() and count() methods of collections.abc.Sequence now +check identity before checking equality when do comparisons.

    • +
    • bpo-29615: SimpleXMLRPCDispatcher no longer chains KeyError (or any other +exception) to exception(s) raised in the dispatched methods. Patch by Petr +Motejlek.

    • +
    • bpo-30177: path.resolve(strict=False) no longer cuts the path after the +first element not present in the filesystem. Patch by Antoine Pietri.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-15786: Fix several problems with IDLE’s autocompletion box. The +following should now work: clicking on selection box items; using the +scrollbar; selecting an item by hitting Return. Hangs on MacOSX should no +longer happen. Patch by Louie Lu.

    • +
    • bpo-25514: Add doc subsubsection about IDLE failure to start. Popup +no-connection message directs users to this section.

    • +
    • bpo-30642: Fix reference leaks in IDLE tests. Patches by Louie Lu and +Terry Jan Reedy.

    • +
    • bpo-30495: Add docstrings for textview.py and use PEP8 names. Patches by +Cheryl Sabella and Terry Jan Reedy.

    • +
    • bpo-30290: Help-about: use pep8 names and add tests. Increase coverage to +100%. Patches by Louie Lu, Cheryl Sabella, and Terry Jan Reedy.

    • +
    • bpo-30303: Add _utest option to textview; add new tests. Increase coverage +to 100%. Patches by Louie Lu and Terry Jan Reedy.

    • +
    +
    +
    +

    C API

    +
      +
    • bpo-27867: Function PySlice_GetIndicesEx() no longer replaced with a macro +if Py_LIMITED_API is not set.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-29941: Add --with-assertions configure flag to explicitly enable C +assert() checks. Defaults to off. --with-pydebug implies +--with-assertions.

    • +
    • bpo-28787: Fix out-of-tree builds of Python when configured with +--with--dtrace.

    • +
    • bpo-29243: Prevent unnecessary rebuilding of Python during make test, +make install and some other make targets when configured with +--enable-optimizations.

    • +
    • bpo-23404: Don’t regenerate generated files based on file modification +time anymore: the action is now explicit. Replace make touch with +make regen-all.

    • +
    • bpo-29643: Fix --enable-optimization didn’t work.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-30176: Add missing attribute related constants in curses +documentation.

    • +
    • bpo-30052: the link targets for bytes() and bytearray() are +now their respective type definitions, rather than the corresponding +builtin function entries. Use bytes and +bytearray to reference the latter.

      +

      In order to ensure this and future cross-reference updates are applied +automatically, the daily documentation builds now disable the default +output caching features in Sphinx.

      +
    • +
    • bpo-26985: Add missing info of code object in inspect documentation.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-29367: python-gdb.py now supports also method-wrapper +(wrapperobject) objects.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-30357: test_thread: setUp() now uses support.threading_setup() and +support.threading_cleanup() to wait until threads complete to avoid random +side effects on following tests. Initial patch written by Grzegorz +Grzywacz.

    • +
    • bpo-30197: Enhanced functions swap_attr() and swap_item() in the +test.support module. They now work when delete replaced attribute or item +inside the with statement. The old value of the attribute or item (or +None if it doesn’t exist) now will be assigned to the target of the “as” +clause, if there is one.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-30687: Locate msbuild.exe on Windows when building rather than +vcvarsall.bat

    • +
    • bpo-30450: The build process on Windows no longer depends on Subversion, +instead pulling external code from GitHub via a Python script. If Python +3.6 is not found on the system (via py -3.6), NuGet is used to +download a copy of 32-bit Python.

    • +
    +
    +
    +
    +

    Python 3.6.1 final

    +

    Release date: 2017-03-21

    +
    +

    Core and Builtins

    +
      +
    • bpo-29723: The sys.path[0] initialization change for bpo-29139 caused +a regression by revealing an inconsistency in how sys.path is initialized +when executing __main__ from a zipfile, directory, or other import +location. The interpreter now consistently avoids ever adding the import +location’s parent directory to sys.path, and ensures no other +sys.path entries are inadvertently modified when inserting the import +location named on the command line.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-27593: fix format of git information used in sys.version

    • +
    • Fix incompatible comment in python.h

    • +
    +
    +
    +
    +

    Python 3.6.1 release candidate 1

    +

    Release date: 2017-03-04

    +
    +

    Core and Builtins

    +
      +
    • bpo-28893: Set correct __cause__ for errors about invalid awaitables +returned from __aiter__ and __anext__.

    • +
    • bpo-29683: Fixes to memory allocation in _PyCode_SetExtra. Patch by Brian +Coleman.

    • +
    • bpo-29684: Fix minor regression of PyEval_CallObjectWithKeywords. It +should raise TypeError when kwargs is not a dict. But it might cause segv +when args=NULL and kwargs is not a dict.

    • +
    • bpo-28598: Support __rmod__ for subclasses of str being called before +str.__mod__. Patch by Martijn Pieters.

    • +
    • bpo-29607: Fix stack_effect computation for CALL_FUNCTION_EX. Patch by +Matthieu Dartiailh.

    • +
    • bpo-29602: Fix incorrect handling of signed zeros in complex constructor +for complex subclasses and for inputs having a __complex__ method. Patch +by Serhiy Storchaka.

    • +
    • bpo-29347: Fixed possibly dereferencing undefined pointers when creating +weakref objects.

    • +
    • bpo-29438: Fixed use-after-free problem in key sharing dict.

    • +
    • bpo-29319: Prevent RunMainFromImporter overwriting sys.path[0].

    • +
    • bpo-29337: Fixed possible BytesWarning when compare the code objects. +Warnings could be emitted at compile time.

    • +
    • bpo-29327: Fixed a crash when pass the iterable keyword argument to +sorted().

    • +
    • bpo-29034: Fix memory leak and use-after-free in os module +(path_converter).

    • +
    • bpo-29159: Fix regression in bytes(x) when x.__index__() raises Exception.

    • +
    • bpo-28932: Do not include <sys/random.h> if it does not exist.

    • +
    • bpo-25677: Correct the positioning of the syntax error caret for indented +blocks. Based on patch by Michael Layzell.

    • +
    • bpo-29000: Fixed bytes formatting of octals with zero padding in alternate +form.

    • +
    • bpo-26919: On Android, operating system data is now always encoded/decoded +to/from UTF-8, instead of the locale encoding to avoid inconsistencies +with os.fsencode() and os.fsdecode() which are already using UTF-8.

    • +
    • bpo-28991: functools.lru_cache() was susceptible to an obscure reentrancy +bug triggerable by a monkey-patched len() function.

    • +
    • bpo-28739: f-string expressions are no longer accepted as docstrings and +by ast.literal_eval() even if they do not include expressions.

    • +
    • bpo-28512: Fixed setting the offset attribute of SyntaxError by +PyErr_SyntaxLocationEx() and PyErr_SyntaxLocationObject().

    • +
    • bpo-28918: Fix the cross compilation of xxlimited when Python has been +built with Py_DEBUG defined.

    • +
    • bpo-28731: Optimize _PyDict_NewPresized() to create correct size dict. +Improve speed of dict literal with constant keys up to 30%.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-29169: Update zlib to 1.2.11.

    • +
    • bpo-29623: Allow use of path-like object as a single argument in +ConfigParser.read(). Patch by David Ellis.

    • +
    • bpo-28963: Fix out of bound iteration in +asyncio.Future.remove_done_callback implemented in C.

    • +
    • bpo-29704: asyncio.subprocess.SubprocessStreamProtocol no longer closes +before all pipes are closed.

    • +
    • bpo-29271: Fix Task.current_task and Task.all_tasks implemented in C to +accept None argument as their pure Python implementation.

    • +
    • bpo-29703: Fix asyncio to support instantiation of new event loops in +child processes.

    • +
    • bpo-29376: Fix assertion error in threading._DummyThread.is_alive().

    • +
    • bpo-28624: Add a test that checks that cwd parameter of Popen() accepts +PathLike objects. Patch by Sayan Chowdhury.

    • +
    • bpo-28518: Start a transaction implicitly before a DML statement. Patch by +Aviv Palivoda.

    • +
    • bpo-29532: Altering a kwarg dictionary passed to functools.partial() no +longer affects a partial object after creation.

    • +
    • bpo-29110: Fix file object leak in aifc.open() when file is given as a +filesystem path and is not in valid AIFF format. Patch by Anthony Zhang.

    • +
    • bpo-28556: Various updates to typing module: typing.Counter, +typing.ChainMap, improved ABC caching, etc. Original PRs by Jelle +Zijlstra, Ivan Levkivskyi, Manuel Krebber, and Łukasz Langa.

    • +
    • bpo-29100: Fix datetime.fromtimestamp() regression introduced in Python +3.6.0: check minimum and maximum years.

    • +
    • bpo-29519: Fix weakref spewing exceptions during interpreter shutdown when +used with a rare combination of multiprocessing and custom codecs.

    • +
    • bpo-29416: Prevent infinite loop in pathlib.Path.mkdir

    • +
    • bpo-29444: Fixed out-of-bounds buffer access in the group() method of the +match object. Based on patch by WGH.

    • +
    • bpo-29335: Fix subprocess.Popen.wait() when the child process has exited +to a stopped instead of terminated state (ex: when under ptrace).

    • +
    • bpo-29290: Fix a regression in argparse that help messages would wrap at +non-breaking spaces.

    • +
    • bpo-28735: Fixed the comparison of mock.MagickMock with mock.ANY.

    • +
    • bpo-29316: Restore the provisional status of typing module, add +corresponding note to documentation. Patch by Ivan L.

    • +
    • bpo-29219: Fixed infinite recursion in the repr of uninitialized +ctypes.CDLL instances.

    • +
    • bpo-29011: Fix an important omission by adding Deque to the typing module.

    • +
    • bpo-28969: Fixed race condition in C implementation of +functools.lru_cache. KeyError could be raised when cached function with +full cache was simultaneously called from differen threads with the same +uncached arguments.

    • +
    • bpo-29142: In urllib.request, suffixes in no_proxy environment variable +with leading dots could match related hostnames again (e.g. .b.c matches +a.b.c). Patch by Milan Oberkirch.

    • +
    • bpo-28961: Fix unittest.mock._Call helper: don’t ignore the name parameter +anymore. Patch written by Jiajun Huang.

    • +
    • bpo-29203: functools.lru_cache() now respects PEP 468 and preserves the +order of keyword arguments. f(a=1, b=2) is now cached separately from +f(b=2, a=1) since both calls could potentially give different results.

    • +
    • bpo-15812: inspect.getframeinfo() now correctly shows the first line of a +context. Patch by Sam Breese.

    • +
    • bpo-29094: Offsets in a ZIP file created with extern file object and modes +“w” and “x” now are relative to the start of the file.

    • +
    • bpo-29085: Allow random.Random.seed() to use high quality OS randomness +rather than the pid and time.

    • +
    • bpo-29061: Fixed bug in secrets.randbelow() which would hang when given a +negative input. Patch by Brendan Donegan.

    • +
    • bpo-29079: Prevent infinite loop in pathlib.resolve() on Windows

    • +
    • bpo-13051: Fixed recursion errors in large or resized +curses.textpad.Textbox. Based on patch by Tycho Andersen.

    • +
    • bpo-29119: Fix weakrefs in the pure python version of +collections.OrderedDict move_to_end() method. Contributed by Andra +Bogildea.

    • +
    • bpo-9770: curses.ascii predicates now work correctly with negative +integers.

    • +
    • bpo-28427: old keys should not remove new values from WeakValueDictionary +when collecting from another thread.

    • +
    • bpo-28923: Remove editor artifacts from Tix.py.

    • +
    • bpo-29055: Neaten-up empty population error on random.choice() by +suppressing the upstream exception.

    • +
    • bpo-28871: Fixed a crash when deallocate deep ElementTree.

    • +
    • bpo-19542: Fix bugs in WeakValueDictionary.setdefault() and +WeakValueDictionary.pop() when a GC collection happens in another thread.

    • +
    • bpo-20191: Fixed a crash in resource.prlimit() when passing a sequence +that doesn’t own its elements as limits.

    • +
    • bpo-28779: multiprocessing.set_forkserver_preload() would crash the +forkserver process if a preloaded module instantiated some multiprocessing +objects such as locks.

    • +
    • bpo-28847: dbm.dumb now supports reading read-only files and no longer +writes the index file when it is not changed.

    • +
    • bpo-26937: The chown() method of the tarfile.TarFile class does not fail +now when the grp module cannot be imported, as for example on Android +platforms.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-29071: IDLE colors f-string prefixes (but not invalid ur prefixes).

    • +
    • bpo-28572: Add 10% to coverage of IDLE’s test_configdialog. Update and +augment description of the configuration system.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-29579: Removes readme.txt from the installer

    • +
    • bpo-29326: Ignores blank lines in ._pth files (Patch by Alexey Izbyshev)

    • +
    • bpo-28164: Correctly handle special console filenames (patch by Eryk Sun)

    • +
    • bpo-29409: Implement PEP 529 for io.FileIO (Patch by Eryk Sun)

    • +
    • bpo-29392: Prevent crash when passing invalid arguments into msvcrt +module.

    • +
    • bpo-25778: winreg does not truncate string correctly (Patch by Eryk Sun)

    • +
    • bpo-28896: Deprecate WindowsRegistryFinder and disable it by default.

    • +
    +
    +
    +

    C API

    +
      +
    • bpo-27867: Function PySlice_GetIndicesEx() is replaced with a macro if +Py_LIMITED_API is not set or set to the value between 0x03050400 and +0x03060000 (not including) or 0x03060100 or higher.

    • +
    • bpo-29083: Fixed the declaration of some public API functions. +PyArg_VaParse() and PyArg_VaParseTupleAndKeywords() were not available in +limited API. PyArg_ValidateKeywordArguments(), PyArg_UnpackTuple() and +Py_BuildValue() were not available in limited API of version < 3.3 when +PY_SSIZE_T_CLEAN is defined.

    • +
    • bpo-29058: All stable API extensions added after Python 3.2 are now +available only when Py_LIMITED_API is set to the PY_VERSION_HEX value of +the minimum Python version supporting this API.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-28929: Link the documentation to its source file on GitHub.

    • +
    • bpo-25008: Document smtpd.py as effectively deprecated and add a pointer +to aiosmtpd, a third-party asyncio-based replacement.

    • +
    • bpo-26355: Add canonical header link on each page to corresponding major +version of the documentation. Patch by Matthias Bussonnier.

    • +
    • bpo-29349: Fix Python 2 syntax in code for building the documentation.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-28087: Skip test_asyncore and test_eintr poll failures on macOS. Skip +some tests of select.poll when running on macOS due to unresolved issues +with the underlying system poll function on some macOS versions.

    • +
    • bpo-29571: to match the behaviour of the re.LOCALE flag, +test_re.test_locale_flag now uses locale.getpreferredencoding(False) +to determine the candidate encoding for the test regex (allowing it to +correctly skip the test when the default locale encoding is a multi-byte +encoding)

    • +
    • bpo-28950: Disallow -j0 to be combined with -T/-l in regrtest command line +arguments.

    • +
    • bpo-28683: Fix the tests that bind() a unix socket and raise +PermissionError on Android for a non-root user.

    • +
    • bpo-26939: Add the support.setswitchinterval() function to fix +test_functools hanging on the Android armv7 qemu emulator.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-27593: sys.version and the platform module python_build(), +python_branch(), and python_revision() functions now use git information +rather than hg when building from a repo.

    • +
    • bpo-29572: Update Windows build and OS X installers to use OpenSSL 1.0.2k.

    • +
    • bpo-26851: Set Android compilation and link flags.

    • +
    • bpo-28768: Fix implicit declaration of function _setmode. Patch by +Masayuki Yamamoto

    • +
    • bpo-29080: Removes hard dependency on hg.exe from PCBuild/build.bat

    • +
    • bpo-23903: Added missed names to PC/python3.def.

    • +
    • bpo-28762: lockf() is available on Android API level 24, but the F_LOCK +macro is not defined in android-ndk-r13.

    • +
    • bpo-28538: Fix the compilation error that occurs because if_nameindex() is +available on Android API level 24, but the if_nameindex structure is not +defined.

    • +
    • bpo-20211: Do not add the directory for installing C header files and the +directory for installing object code libraries to the cross compilation +search paths. Original patch by Thomas Petazzoni.

    • +
    • bpo-28849: Do not define sys.implementation._multiarch on Android.

    • +
    +
    +
    +
    +

    Python 3.6.0 final

    +

    Release date: 2016-12-23

    +

    No changes since release candidate 2

    +
    +
    +

    Python 3.6.0 release candidate 2

    +

    Release date: 2016-12-16

    +
    +

    Core and Builtins

    +
      +
    • bpo-28147: Fix a memory leak in split-table dictionaries: setattr() must +not convert combined table into split table. Patch written by INADA Naoki.

    • +
    • bpo-28990: Fix asyncio SSL hanging if connection is closed before +handshake is completed. (Patch by HoHo-Ho)

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-28770: Fix python-gdb.py for fastcalls.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-28896: Deprecate WindowsRegistryFinder.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-28898: Prevent gdb build errors due to HAVE_LONG_LONG redefinition.

    • +
    +
    +
    +
    +

    Python 3.6.0 release candidate 1

    +

    Release date: 2016-12-06

    +
    +

    Core and Builtins

    +
      +
    • bpo-23722: Rather than silently producing a class that doesn’t support +zero-argument super() in methods, failing to pass the new +__classcell__ namespace entry up to type.__new__ now results in a +DeprecationWarning and a class that supports zero-argument +super().

    • +
    • bpo-28797: Modifying the class __dict__ inside the __set_name__ method of +a descriptor that is used inside that class no longer prevents calling the +__set_name__ method of other descriptors.

    • +
    • bpo-28782: Fix a bug in the implementation yield from when checking if +the next instruction is YIELD_FROM. Regression introduced by WORDCODE +(bpo-26647).

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-27030: Unknown escapes in re.sub() replacement template are allowed +again. But they still are deprecated and will be disabled in 3.7.

    • +
    • bpo-28835: Fix a regression introduced in warnings.catch_warnings(): call +warnings.showwarning() if it was overriden inside the context manager.

    • +
    • bpo-27172: To assist with upgrades from 2.7, the previously documented +deprecation of inspect.getfullargspec() has been reversed. This +decision may be revisited again after the Python 2.7 branch is no longer +officially supported.

    • +
    • bpo-26273: Add new socket.TCP_CONGESTION (Linux 2.6.13) and +socket.TCP_USER_TIMEOUT (Linux 2.6.37) constants. Patch written by +Omar Sandoval.

    • +
    • bpo-24142: Reading a corrupt config file left configparser in an invalid +state. Original patch by Florian Höch.

    • +
    • bpo-28843: Fix asyncio C Task to handle exceptions __traceback__.

    • +
    +
    +
    +

    C API

    +
      +
    • bpo-28808: PyUnicode_CompareWithASCIIString() now never raises exceptions.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-23722: The data model reference and the porting section in the What’s +New guide now cover the additional __classcell__ handling needed for +custom metaclasses to fully support PEP 487 and zero-argument super().

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-28023: Fix python-gdb.py didn’t support new dict implementation.

    • +
    +
    +
    +
    +

    Python 3.6.0 beta 4

    +

    Release date: 2016-11-21

    +
    +

    Core and Builtins

    +
      +
    • bpo-28532: Show sys.version when -V option is supplied twice.

    • +
    • bpo-27100: The with-statement now checks for __enter__ before it checks +for __exit__. This gives less confusing error messages when both methods +are missing. Patch by Jonathan Ellington.

    • +
    • bpo-28746: Fix the set_inheritable() file descriptor method on platforms +that do not have the ioctl FIOCLEX and FIONCLEX commands.

    • +
    • bpo-26920: Fix not getting the locale’s charset upon initializing the +interpreter, on platforms that do not have langinfo.

    • +
    • bpo-28648: Fixed crash in Py_DecodeLocale() in debug build on Mac OS X +when decode astral characters. Patch by Xiang Zhang.

    • +
    • bpo-19398: Extra slash no longer added to sys.path components in case of +empty compile-time PYTHONPATH components.

    • +
    • bpo-28665: Improve speed of the STORE_DEREF opcode by 40%.

    • +
    • bpo-28583: PyDict_SetDefault didn’t combine split table when needed. Patch +by Xiang Zhang.

    • +
    • bpo-27243: Change PendingDeprecationWarning -> DeprecationWarning. As it +was agreed in the issue, __aiter__ returning an awaitable should result in +PendingDeprecationWarning in 3.5 and in DeprecationWarning in 3.6.

    • +
    • bpo-26182: Fix a refleak in code that raises DeprecationWarning.

    • +
    • bpo-28721: Fix asynchronous generators aclose() and athrow() to handle +StopAsyncIteration propagation properly.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-28752: Restored the __reduce__() methods of datetime objects.

    • +
    • bpo-28727: Regular expression patterns, _sre.SRE_Pattern objects created +by re.compile(), become comparable (only x==y and x!=y operators). This +change should fix the bpo-18383: don’t duplicate warning filters when +the warnings module is reloaded (thing usually only done in unit tests).

    • +
    • bpo-20572: The subprocess.Popen.wait method’s undocumented endtime +parameter now raises a DeprecationWarning.

    • +
    • bpo-25659: In ctypes, prevent a crash calling the from_buffer() and +from_buffer_copy() methods on abstract classes like Array.

    • +
    • bpo-19717: Makes Path.resolve() succeed on paths that do not exist. Patch +by Vajrasky Kok

    • +
    • bpo-28563: Fixed possible DoS and arbitrary code execution when handle +plural form selections in the gettext module. The expression parser now +supports exact syntax supported by GNU gettext.

    • +
    • bpo-28387: Fixed possible crash in _io.TextIOWrapper deallocator when the +garbage collector is invoked in other thread. Based on patch by Sebastian +Cufre.

    • +
    • bpo-28600: Optimize loop.call_soon.

    • +
    • bpo-28613: Fix get_event_loop() return the current loop if called from +coroutines/callbacks.

    • +
    • bpo-28634: Fix asyncio.isfuture() to support unittest.Mock.

    • +
    • bpo-26081: Fix refleak in _asyncio.Future.__iter__().throw.

    • +
    • bpo-28639: Fix inspect.isawaitable to always return bool Patch by Justin +Mayfield.

    • +
    • bpo-28652: Make loop methods reject socket kinds they do not support.

    • +
    • bpo-28653: Fix a refleak in functools.lru_cache.

    • +
    • bpo-28703: Fix asyncio.iscoroutinefunction to handle Mock objects.

    • +
    • bpo-28704: Fix create_unix_server to support Path-like objects (PEP 519).

    • +
    • bpo-28720: Add collections.abc.AsyncGenerator.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-28513: Documented command-line interface of zipfile.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-28666: Now test.support.rmtree is able to remove unwritable or +unreadable directories.

    • +
    • bpo-23839: Various caches now are cleared before running every test file.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-10656: Fix out-of-tree building on AIX. Patch by Tristan Carel and +Michael Haubenwallner.

    • +
    • bpo-26359: Rename –with-optimiations to –enable-optimizations.

    • +
    • bpo-28676: Prevent missing ‘getentropy’ declaration warning on macOS. +Patch by Gareth Rees.

    • +
    +
    +
    +
    +

    Python 3.6.0 beta 3

    +

    Release date: 2016-10-31

    +
    +

    Core and Builtins

    +
      +
    • bpo-28128: Deprecation warning for invalid str and byte escape sequences +now prints better information about where the error occurs. Patch by +Serhiy Storchaka and Eric Smith.

    • +
    • bpo-28509: dict.update() no longer allocate unnecessary large memory.

    • +
    • bpo-28426: Fixed potential crash in PyUnicode_AsDecodedObject() in debug +build.

    • +
    • bpo-28517: Fixed of-by-one error in the peephole optimizer that caused +keeping unreachable code.

    • +
    • bpo-28214: Improved exception reporting for problematic __set_name__ +attributes.

    • +
    • bpo-23782: Fixed possible memory leak in _PyTraceback_Add() and exception +loss in PyTraceBack_Here().

    • +
    • bpo-28471: Fix “Python memory allocator called without holding the GIL” +crash in socket.setblocking.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-27517: LZMA compressor and decompressor no longer raise exceptions if +given empty data twice. Patch by Benjamin Fogle.

    • +
    • bpo-28549: Fixed segfault in curses’s addch() with ncurses6.

    • +
    • bpo-28449: tarfile.open() with mode “r” or “r:” now tries to open a tar +file with compression before trying to open it without compression. +Otherwise it had 50% chance failed with ignore_zeros=True.

    • +
    • bpo-23262: The webbrowser module now supports Firefox 36+ and derived +browsers. Based on patch by Oleg Broytman.

    • +
    • bpo-27939: Fixed bugs in tkinter.ttk.LabeledScale and tkinter.Scale caused +by representing the scale as float value internally in Tk. tkinter.IntVar +now works if float value is set to underlying Tk variable.

    • +
    • bpo-18844: The various ways of specifying weights for random.choices() now +produce the same result sequences.

    • +
    • bpo-28255: calendar.TextCalendar().prmonth() no longer prints a space at +the start of new line after printing a month’s calendar. Patch by Xiang +Zhang.

    • +
    • bpo-20491: The textwrap.TextWrapper class now honors non-breaking spaces. +Based on patch by Kaarle Ritvanen.

    • +
    • bpo-28353: os.fwalk() no longer fails on broken links.

    • +
    • bpo-28430: Fix iterator of C implemented asyncio.Future doesn’t accept +non-None value is passed to it.send(val).

    • +
    • bpo-27025: Generated names for Tkinter widgets now start by the “!” prefix +for readability.

    • +
    • bpo-25464: Fixed HList.header_exists() in tkinter.tix module by addin a +workaround to Tix library bug.

    • +
    • bpo-28488: shutil.make_archive() no longer adds entry “./” to ZIP archive.

    • +
    • bpo-25953: re.sub() now raises an error for invalid numerical group +reference in replacement template even if the pattern is not found in the +string. Error message for invalid group reference now includes the group +index and the position of the reference. Based on patch by SilentGhost.

    • +
    • bpo-18219: Optimize csv.DictWriter for large number of columns. Patch by +Mariatta Wijaya.

    • +
    • bpo-28448: Fix C implemented asyncio.Future didn’t work on Windows.

    • +
    • bpo-28480: Fix error building socket module when multithreading is +disabled.

    • +
    • bpo-24452: Make webbrowser support Chrome on Mac OS X.

    • +
    • bpo-20766: Fix references leaked by pdb in the handling of SIGINT +handlers.

    • +
    • bpo-28492: Fix how StopIteration exception is raised in _asyncio.Future.

    • +
    • bpo-28500: Fix asyncio to handle async gens GC from another thread.

    • +
    • bpo-26923: Fix asyncio.Gather to refuse being cancelled once all children +are done. Patch by Johannes Ebke.

    • +
    • bpo-26796: Don’t configure the number of workers for default threadpool +executor. Initial patch by Hans Lawrenz.

    • +
    • bpo-28544: Implement asyncio.Task in C.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-28522: Fixes mishandled buffer reallocation in getpathp.c

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-28444: Fix missing extensions modules when cross compiling.

    • +
    • bpo-28208: Update Windows build and OS X installers to use SQLite 3.14.2.

    • +
    • bpo-28248: Update Windows build and OS X installers to use OpenSSL 1.0.2j.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-26944: Fix test_posix for Android where ‘id -G’ is entirely wrong or +missing the effective gid.

    • +
    • bpo-28409: regrtest: fix the parser of command line arguments.

    • +
    +
    +
    +
    +

    Python 3.6.0 beta 2

    +

    Release date: 2016-10-10

    +
    +

    Core and Builtins

    +
      +
    • bpo-28183: Optimize and cleanup dict iteration.

    • +
    • bpo-26081: Added C implementation of asyncio.Future. Original patch by +Yury Selivanov.

    • +
    • bpo-28379: Added sanity checks and tests for PyUnicode_CopyCharacters(). +Patch by Xiang Zhang.

    • +
    • bpo-28376: The type of long range iterator is now registered as Iterator. +Patch by Oren Milman.

    • +
    • bpo-28376: Creating instances of range_iterator by calling range_iterator +type now is deprecated. Patch by Oren Milman.

    • +
    • bpo-28376: The constructor of range_iterator now checks that step is not +0. Patch by Oren Milman.

    • +
    • bpo-26906: Resolving special methods of uninitialized type now causes +implicit initialization of the type instead of a fail.

    • +
    • bpo-18287: PyType_Ready() now checks that tp_name is not NULL. Original +patch by Niklas Koep.

    • +
    • bpo-24098: Fixed possible crash when AST is changed in process of +compiling it.

    • +
    • bpo-28201: Dict reduces possibility of 2nd conflict in hash table when +hashes have same lower bits.

    • +
    • bpo-28350: String constants with null character no longer interned.

    • +
    • bpo-26617: Fix crash when GC runs during weakref callbacks.

    • +
    • bpo-27942: String constants now interned recursively in tuples and +frozensets.

    • +
    • bpo-21578: Fixed misleading error message when ImportError called with +invalid keyword args.

    • +
    • bpo-28203: Fix incorrect type in complex(1.0, {2:3}) error message. Patch +by Soumya Sharma.

    • +
    • bpo-28086: Single var-positional argument of tuple subtype was passed +unscathed to the C-defined function. Now it is converted to exact tuple.

    • +
    • bpo-28214: Now __set_name__ is looked up on the class instead of the +instance.

    • +
    • bpo-27955: Fallback on reading /dev/urandom device when the getrandom() +syscall fails with EPERM, for example when blocked by SECCOMP.

    • +
    • bpo-28192: Don’t import readline in isolated mode.

    • +
    • Upgrade internal unicode databases to Unicode version 9.0.0.

    • +
    • bpo-28131: Fix a regression in zipimport’s compile_source(). zipimport +should use the same optimization level as the interpreter.

    • +
    • bpo-28126: Replace Py_MEMCPY with memcpy(). Visual Studio can properly +optimize memcpy().

    • +
    • bpo-28120: Fix dict.pop() for splitted dictionary when trying to remove a +“pending key” (Not yet inserted in split-table). Patch by Xiang Zhang.

    • +
    • bpo-26182: Raise DeprecationWarning when async and await keywords are used +as variable/attribute/class/function name.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-27998: Fixed bytes path support in os.scandir() on Windows. Patch by +Eryk Sun.

    • +
    • bpo-28317: The disassembler now decodes FORMAT_VALUE argument.

    • +
    • bpo-26293: Fixed writing ZIP files that starts not from the start of the +file. Offsets in ZIP file now are relative to the start of the archive in +conforming to the specification.

    • +
    • bpo-28380: unittest.mock Mock autospec functions now properly support +assert_called, assert_not_called, and assert_called_once.

    • +
    • bpo-27181: remove statistics.geometric_mean and defer until 3.7.

    • +
    • bpo-28229: lzma module now supports pathlib.

    • +
    • bpo-28321: Fixed writing non-BMP characters with binary format in +plistlib.

    • +
    • bpo-28225: bz2 module now supports pathlib. Initial patch by Ethan +Furman.

    • +
    • bpo-28227: gzip now supports pathlib. Patch by Ethan Furman.

    • +
    • bpo-27358: Optimized merging var-keyword arguments and improved error +message when passing a non-mapping as a var-keyword argument.

    • +
    • bpo-28257: Improved error message when passing a non-iterable as a +var-positional argument. Added opcode BUILD_TUPLE_UNPACK_WITH_CALL.

    • +
    • bpo-28322: Fixed possible crashes when unpickle itertools objects from +incorrect pickle data. Based on patch by John Leitch.

    • +
    • bpo-28228: imghdr now supports pathlib.

    • +
    • bpo-28226: compileall now supports pathlib.

    • +
    • bpo-28314: Fix function declaration (C flags) for the getiterator() method +of xml.etree.ElementTree.Element.

    • +
    • bpo-28148: Stop using localtime() and gmtime() in the time module.

      +

      Introduced platform independent _PyTime_localtime API that is similar to +POSIX localtime_r, but available on all platforms. Patch by Ed Schouten.

      +
    • +
    • bpo-28253: Fixed calendar functions for extreme months: 0001-01 and +9999-12.

      +

      Methods itermonthdays() and itermonthdays2() are reimplemented so that +they don’t call itermonthdates() which can cause datetime.date +under/overflow.

      +
    • +
    • bpo-28275: Fixed possible use after free in the decompress() methods of +the LZMADecompressor and BZ2Decompressor classes. Original patch by John +Leitch.

    • +
    • bpo-27897: Fixed possible crash in sqlite3.Connection.create_collation() +if pass invalid string-like object as a name. Patch by Xiang Zhang.

    • +
    • bpo-18844: random.choices() now has k as a keyword-only argument to +improve the readability of common cases and come into line with the +signature used in other languages.

    • +
    • bpo-18893: Fix invalid exception handling in Lib/ctypes/macholib/dyld.py. +Patch by Madison May.

    • +
    • bpo-27611: Fixed support of default root window in the tkinter.tix module. +Added the master parameter in the DisplayStyle constructor.

    • +
    • bpo-27348: In the traceback module, restore the formatting of exception +messages like “Exception: None”. This fixes a regression introduced in +3.5a2.

    • +
    • bpo-25651: Allow falsy values to be used for msg parameter of subTest().

    • +
    • bpo-27778: Fix a memory leak in os.getrandom() when the getrandom() is +interrupted by a signal and a signal handler raises a Python exception.

    • +
    • bpo-28200: Fix memory leak on Windows in the os module (fix +path_converter() function).

    • +
    • bpo-25400: RobotFileParser now correctly returns default values for +crawl_delay and request_rate. Initial patch by Peter Wirtz.

    • +
    • bpo-27932: Prevent memory leak in win32_ver().

    • +
    • Fix UnboundLocalError in socket._sendfile_use_sendfile.

    • +
    • bpo-28075: Check for ERROR_ACCESS_DENIED in Windows implementation of +os.stat(). Patch by Eryk Sun.

    • +
    • bpo-22493: Warning message emitted by using inline flags in the middle of +regular expression now contains a (truncated) regex pattern. Patch by Tim +Graham.

    • +
    • bpo-25270: Prevent codecs.escape_encode() from raising SystemError when an +empty bytestring is passed.

    • +
    • bpo-28181: Get antigravity over HTTPS. Patch by Kaartic Sivaraam.

    • +
    • bpo-25895: Enable WebSocket URL schemes in urllib.parse.urljoin. Patch by +Gergely Imreh and Markus Holtermann.

    • +
    • bpo-28114: Fix a crash in parse_envlist() when env contains byte strings. +Patch by Eryk Sun.

    • +
    • bpo-27599: Fixed buffer overrun in binascii.b2a_qp() and +binascii.a2b_qp().

    • +
    • bpo-27906: Fix socket accept exhaustion during high TCP traffic. Patch by +Kevin Conway.

    • +
    • bpo-28174: Handle when SO_REUSEPORT isn’t properly supported. Patch by +Seth Michael Larson.

    • +
    • bpo-26654: Inspect functools.partial in asyncio.Handle.__repr__. Patch by +iceboy.

    • +
    • bpo-26909: Fix slow pipes IO in asyncio. Patch by INADA Naoki.

    • +
    • bpo-28176: Fix callbacks race in asyncio.SelectorLoop.sock_connect.

    • +
    • bpo-27759: Fix selectors incorrectly retain invalid file descriptors. +Patch by Mark Williams.

    • +
    • bpo-28368: Refuse monitoring processes if the child watcher has no loop +attached. Patch by Vincent Michel.

    • +
    • bpo-28369: Raise RuntimeError when transport’s FD is used with add_reader, +add_writer, etc.

    • +
    • bpo-28370: Speedup asyncio.StreamReader.readexactly. Patch by Коренберг +Марк.

    • +
    • bpo-28371: Deprecate passing asyncio.Handles to run_in_executor.

    • +
    • bpo-28372: Fix asyncio to support formatting of non-python coroutines.

    • +
    • bpo-28399: Remove UNIX socket from FS before binding. Patch by Коренберг +Марк.

    • +
    • bpo-27972: Prohibit Tasks to await on themselves.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-28402: Adds signed catalog files for stdlib on Windows.

    • +
    • bpo-28333: Enables Unicode for ps1/ps2 and input() prompts. (Patch by Eryk +Sun)

    • +
    • bpo-28251: Improvements to help manuals on Windows.

    • +
    • bpo-28110: launcher.msi has different product codes between 32-bit and +64-bit

    • +
    • bpo-28161: Opening CON for write access fails

    • +
    • bpo-28162: WindowsConsoleIO readall() fails if first line starts with +Ctrl+Z

    • +
    • bpo-28163: WindowsConsoleIO fileno() passes wrong flags to _open_osfhandle

    • +
    • bpo-28164: _PyIO_get_console_type fails for various paths

    • +
    • bpo-28137: Renames Windows path file to ._pth

    • +
    • bpo-28138: Windows ._pth file should allow import site

    • +
    +
    +
    +

    C API

    +
      +
    • bpo-28426: Deprecated undocumented functions PyUnicode_AsEncodedObject(), +PyUnicode_AsDecodedObject(), PyUnicode_AsDecodedUnicode() and +PyUnicode_AsEncodedUnicode().

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-28258: Fixed build with Estonian locale (python-config and distclean +targets in Makefile). Patch by Arfrever Frehtes Taifersar Arahesis.

    • +
    • bpo-26661: setup.py now detects system libffi with multiarch wrapper.

    • +
    • bpo-15819: Remove redundant include search directory option for building +outside the source tree.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-28217: Adds _testconsole module to test console input.

    • +
    +
    +
    +
    +

    Python 3.6.0 beta 1

    +

    Release date: 2016-09-12

    +
    +

    Core and Builtins

    +
      +
    • bpo-23722: The __class__ cell used by zero-argument super() is now +initialized from type.__new__ rather than __build_class__, so class +methods relying on that will now work correctly when called from metaclass +methods during class creation. Patch by Martin Teichmann.

    • +
    • bpo-25221: Fix corrupted result from PyLong_FromLong(0) when Python is +compiled with NSMALLPOSINTS = 0.

    • +
    • bpo-27080: Implement formatting support for PEP 515. Initial patch by +Chris Angelico.

    • +
    • bpo-27199: In tarfile, expose copyfileobj bufsize to improve throughput. +Patch by Jason Fried.

    • +
    • bpo-27948: In f-strings, only allow backslashes inside the braces (where +the expressions are). This is a breaking change from the 3.6 alpha +releases, where backslashes are allowed anywhere in an f-string. Also, +require that expressions inside f-strings be enclosed within literal +braces, and not escapes like f'\x7b"hi"\x7d'.

    • +
    • bpo-28046: Remove platform-specific directories from sys.path.

    • +
    • bpo-28071: Add early-out for differencing from an empty set.

    • +
    • bpo-25758: Prevents zipimport from unnecessarily encoding a filename +(patch by Eryk Sun)

    • +
    • bpo-25856: The __module__ attribute of extension classes and functions now +is interned. This leads to more compact pickle data with protocol 4.

    • +
    • bpo-27213: Rework CALL_FUNCTION* opcodes to produce shorter and more +efficient bytecode. Patch by Demur Rumed, design by Serhiy Storchaka, +reviewed by Serhiy Storchaka and Victor Stinner.

    • +
    • bpo-26331: Implement tokenizing support for PEP 515. Patch by Georg +Brandl.

    • +
    • bpo-27999: Make “global after use” a SyntaxError, and ditto for nonlocal. +Patch by Ivan Levkivskyi.

    • +
    • bpo-28003: Implement PEP 525 – Asynchronous Generators.

    • +
    • bpo-27985: Implement PEP 526 – Syntax for Variable Annotations. Patch by +Ivan Levkivskyi.

    • +
    • bpo-26058: Add a new private version to the builtin dict type, incremented +at each dictionary creation and at each dictionary change. Implementation +of the PEP 509.

    • +
    • bpo-27364: A backslash-character pair that is not a valid escape sequence +now generates a DeprecationWarning. Patch by Emanuel Barry.

    • +
    • bpo-27350: dict implementation is changed like PyPy. It is more compact +and preserves insertion order. (Concept developed by Raymond Hettinger and +patch by Inada Naoki.)

    • +
    • bpo-27911: Remove unnecessary error checks in +exec_builtin_or_dynamic().

    • +
    • bpo-27078: Added BUILD_STRING opcode. Optimized f-strings evaluation.

    • +
    • bpo-17884: Python now requires systems with inttypes.h and stdint.h

    • +
    • bpo-27961: Require platforms to support long long. Python hasn’t +compiled without long long for years, so this is basically a +formality.

    • +
    • bpo-27355: Removed support for Windows CE. It was never finished, and +Windows CE is no longer a relevant platform for Python.

    • +
    • Implement PEP 523.

    • +
    • bpo-27870: A left shift of zero by a large integer no longer attempts to +allocate large amounts of memory.

    • +
    • bpo-25402: In int-to-decimal-string conversion, improve the estimate of +the intermediate memory required, and remove an unnecessarily strict +overflow check. Patch by Serhiy Storchaka.

    • +
    • bpo-27214: In long_invert, be more careful about modifying object returned +by long_add, and remove an unnecessary check for small longs. Thanks Oren +Milman for analysis and patch.

    • +
    • bpo-27506: Support passing the bytes/bytearray.translate() “delete” +argument by keyword.

    • +
    • bpo-27812: Properly clear out a generator’s frame’s backreference to the +generator to prevent crashes in frame.clear().

    • +
    • bpo-27811: Fix a crash when a coroutine that has not been awaited is +finalized with warnings-as-errors enabled.

    • +
    • bpo-27587: Fix another issue found by PVS-Studio: Null pointer check after +use of ‘def’ in _PyState_AddModule(). Initial patch by Christian Heimes.

    • +
    • bpo-27792: The modulo operation applied to bool and other int +subclasses now always returns an int. Previously the return type +depended on the input values. Patch by Xiang Zhang.

    • +
    • bpo-26984: int() now always returns an instance of exact int.

    • +
    • bpo-25604: Fix a minor bug in integer true division; this bug could +potentially have caused off-by-one-ulp results on platforms with +unreliable ldexp implementations.

    • +
    • bpo-24254: Make class definition namespace ordered by default.

    • +
    • bpo-27662: Fix an overflow check in List_New: the original code was +checking against Py_SIZE_MAX instead of the correct upper bound of +Py_SSIZE_T_MAX. Patch by Xiang Zhang.

    • +
    • bpo-27782: Multi-phase extension module import now correctly allows the +m_methods field to be used to add module level functions to instances +of non-module types returned from Py_create_mod. Patch by Xiang Zhang.

    • +
    • bpo-27936: The round() function accepted a second None argument for some +types but not for others. Fixed the inconsistency by accepting None for +all numeric types.

    • +
    • bpo-27487: Warn if a submodule argument to “python -m” or +runpy.run_module() is found in sys.modules after parent packages are +imported, but before the submodule is executed.

    • +
    • bpo-27157: Make only type() itself accept the one-argument form. Patch by +Eryk Sun and Emanuel Barry.

    • +
    • bpo-27558: Fix a SystemError in the implementation of “raise” statement. +In a brand new thread, raise a RuntimeError since there is no active +exception to reraise. Patch written by Xiang Zhang.

    • +
    • bpo-28008: Implement PEP 530 – asynchronous comprehensions.

    • +
    • bpo-27942: Fix memory leak in codeobject.c

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-28732: Fix crash in os.spawnv() with no elements in args

    • +
    • bpo-28485: Always raise ValueError for negative +compileall.compile_dir(workers=…) parameter, even when multithreading is +unavailable.

    • +
    • bpo-28037: Use sqlite3_get_autocommit() instead of setting +Connection->inTransaction manually.

    • +
    • bpo-25283: Attributes tm_gmtoff and tm_zone are now available on all +platforms in the return values of time.localtime() and time.gmtime().

    • +
    • bpo-24454: Regular expression match object groups are now accessible using +__getitem__. “mo[x]” is equivalent to “mo.group(x)”.

    • +
    • bpo-10740: sqlite3 no longer implicitly commit an open transaction before +DDL statements.

    • +
    • bpo-17941: Add a module parameter to collections.namedtuple().

    • +
    • bpo-22493: Inline flags now should be used only at the start of the +regular expression. Deprecation warning is emitted if uses them in the +middle of the regular expression.

    • +
    • bpo-26885: xmlrpc now supports unmarshalling additional data types used by +Apache XML-RPC implementation for numerics and None.

    • +
    • bpo-28070: Fixed parsing inline verbose flag in regular expressions.

    • +
    • bpo-19500: Add client-side SSL session resumption to the ssl module.

    • +
    • bpo-28022: Deprecate ssl-related arguments in favor of SSLContext. The +deprecation include manual creation of SSLSocket and certfile/keyfile (or +similar) in ftplib, httplib, imaplib, smtplib, poplib and urllib.

    • +
    • bpo-28043: SSLContext has improved default settings: OP_NO_SSLv2, +OP_NO_SSLv3, OP_NO_COMPRESSION, OP_CIPHER_SERVER_PREFERENCE, +OP_SINGLE_DH_USE, OP_SINGLE_ECDH_USE and HIGH ciphers without MD5.

    • +
    • bpo-24693: Changed some RuntimeError’s in the zipfile module to more +appropriate types. Improved some error messages and debugging output.

    • +
    • bpo-17909: json.load and json.loads now support binary input +encoded as UTF-8, UTF-16 or UTF-32. Patch by Serhiy Storchaka.

    • +
    • bpo-27137: the pure Python fallback implementation of +functools.partial now matches the behaviour of its accelerated C +counterpart for subclassing, pickling and text representation purposes. +Patch by Emanuel Barry and Serhiy Storchaka.

    • +
    • Fix possible integer overflows and crashes in the mmap module with unusual +usage patterns.

    • +
    • bpo-1703178: Fix the ability to pass the –link-objects option to the +distutils build_ext command.

    • +
    • bpo-28019: itertools.count() no longer rounds non-integer step in range +between 1.0 and 2.0 to 1.

    • +
    • bpo-18401: Pdb now supports the ‘readrc’ keyword argument to control +whether .pdbrc files should be read. Patch by Martin Matusiak and Sam +Kimbrel.

    • +
    • bpo-25969: Update the lib2to3 grammar to handle the unpacking +generalizations added in 3.5.

    • +
    • bpo-14977: mailcap now respects the order of the lines in the mailcap +files (“first match”), as required by RFC 1542. Patch by Michael Lazar.

    • +
    • bpo-28082: Convert re flag constants to IntFlag.

    • +
    • bpo-28025: Convert all ssl module constants to IntEnum and IntFlags. +SSLContext properties now return flags and enums.

    • +
    • bpo-23591: Add Flag, IntFlag, and auto() to enum module.

    • +
    • bpo-433028: Added support of modifier spans in regular expressions.

    • +
    • bpo-24594: Validates persist parameter when opening MSI database

    • +
    • bpo-17582: xml.etree.ElementTree nows preserves whitespaces in attributes +(Patch by Duane Griffin. Reviewed and approved by Stefan Behnel.)

    • +
    • bpo-28047: Fixed calculation of line length used for the base64 CTE in the +new email policies.

    • +
    • bpo-27576: Fix call order in OrderedDict.__init__().

    • +
    • email.generator.DecodedGenerator now supports the policy keyword.

    • +
    • bpo-28027: Remove undocumented modules from Lib/plat-*: IN, CDROM, +DLFCN, TYPES, CDIO, and STROPTS.

    • +
    • bpo-27445: Don’t pass str(_charset) to MIMEText.set_payload(). Patch by +Claude Paroz.

    • +
    • bpo-24277: The new email API is no longer provisional, and the docs have +been reorganized and rewritten to emphasize the new API.

    • +
    • bpo-22450: urllib now includes an Accept: */* header among the default +headers. This makes the results of REST API requests more consistent and +predictable especially when proxy servers are involved.

    • +
    • lib2to3.pgen3.driver.load_grammar() now creates a stable cache file +between runs given the same Grammar.txt input regardless of the hash +randomization setting.

    • +
    • bpo-28005: Allow ImportErrors in encoding implementation to propagate.

    • +
    • bpo-26667: Support path-like objects in importlib.util.

    • +
    • bpo-27570: Avoid zero-length memcpy() etc calls with null source pointers +in the “ctypes” and “array” modules.

    • +
    • bpo-22233: Break email header lines only on the RFC specified CR and LF +characters, not on arbitrary unicode line breaks. This also fixes a bug +in HTTP header parsing.

    • +
    • bpo-27331: The email.mime classes now all accept an optional policy +keyword.

    • +
    • bpo-27988: Fix email iter_attachments incorrect mutation of payload list.

    • +
    • bpo-16113: Add SHA-3 and SHAKE support to hashlib module.

    • +
    • Eliminate a tautological-pointer-compare warning in _scproxy.c.

    • +
    • bpo-27776: The os.urandom() function does now block on Linux 3.17 +and newer until the system urandom entropy pool is initialized to increase +the security. This change is part of the PEP 524.

    • +
    • bpo-27778: Expose the Linux getrandom() syscall as a new +os.getrandom() function. This change is part of the PEP 524.

    • +
    • bpo-27691: Fix ssl module’s parsing of GEN_RID subject alternative name +fields in X.509 certs.

    • +
    • bpo-18844: Add random.choices().

    • +
    • bpo-25761: Improved error reporting about truncated pickle data in C +implementation of unpickler. UnpicklingError is now raised instead of +AttributeError and ValueError in some cases.

    • +
    • bpo-26798: Add BLAKE2 (blake2b and blake2s) to hashlib.

    • +
    • bpo-26032: Optimized globbing in pathlib by using os.scandir(); it is now +about 1.5–4 times faster.

    • +
    • bpo-25596: Optimized glob() and iglob() functions in the glob module; they +are now about 3–6 times faster.

    • +
    • bpo-27928: Add scrypt (password-based key derivation function) to hashlib +module (requires OpenSSL 1.1.0).

    • +
    • bpo-27850: Remove 3DES from ssl module’s default cipher list to counter +measure sweet32 attack (CVE-2016-2183).

    • +
    • bpo-27766: Add ChaCha20 Poly1305 to ssl module’s default cipher list. +(Required OpenSSL 1.1.0 or LibreSSL).

    • +
    • bpo-25387: Check return value of winsound.MessageBeep.

    • +
    • bpo-27866: Add SSLContext.get_ciphers() method to get a list of all +enabled ciphers.

    • +
    • bpo-27744: Add AF_ALG (Linux Kernel crypto) to socket module.

    • +
    • bpo-26470: Port ssl and hashlib module to OpenSSL 1.1.0.

    • +
    • bpo-11620: Fix support for SND_MEMORY in winsound.PlaySound. Based on a +patch by Tim Lesher.

    • +
    • bpo-11734: Add support for IEEE 754 half-precision floats to the struct +module. Based on a patch by Eli Stevens.

    • +
    • bpo-27919: Deprecated extra_path distribution option in distutils +packaging.

    • +
    • bpo-23229: Add new cmath constants: cmath.inf and cmath.nan to +match math.inf and math.nan, and also cmath.infj and +cmath.nanj to match the format used by complex repr.

    • +
    • bpo-27842: The csv.DictReader now returns rows of type OrderedDict. +(Contributed by Steve Holden.)

    • +
    • Remove support for passing a file descriptor to os.access. It never worked +but previously didn’t raise.

    • +
    • bpo-12885: Fix error when distutils encounters symlink.

    • +
    • bpo-27881: Fixed possible bugs when setting +sqlite3.Connection.isolation_level. Based on patch by Xiang Zhang.

    • +
    • bpo-27861: Fixed a crash in sqlite3.Connection.cursor() when a factory +creates not a cursor. Patch by Xiang Zhang.

    • +
    • bpo-19884: Avoid spurious output on OS X with Gnu Readline.

    • +
    • bpo-27706: Restore deterministic behavior of random.Random().seed() for +string seeds using seeding version 1. Allows sequences of calls to +random() to exactly match those obtained in Python 2. Patch by Nofar +Schnider.

    • +
    • bpo-10513: Fix a regression in Connection.commit(). Statements should not +be reset after a commit.

    • +
    • bpo-12319: Chunked transfer encoding support added to +http.client.HTTPConnection requests. The +urllib.request.AbstractHTTPHandler class does not enforce a Content-Length +header any more. If a HTTP request has a file or iterable body, but no +Content-Length header, the library now falls back to use chunked +transfer-encoding.

    • +
    • A new version of typing.py from https://github.com/python/typing: - +Collection (only for 3.6) (bpo-27598) - Add FrozenSet to __all__ +(upstream #261) - fix crash in _get_type_vars() (upstream #259) - Remove +the dict constraint in ForwardRef._eval_type (upstream #252)

    • +
    • bpo-27832: Make _normalize parameter to Fraction constuctor +keyword-only, so that Fraction(2, 3, 4) now raises TypeError.

    • +
    • bpo-27539: Fix unnormalised Fraction.__pow__ result in the case of +negative exponent and negative base.

    • +
    • bpo-21718: cursor.description is now available for queries using CTEs.

    • +
    • bpo-27819: In distutils sdists, simply produce the “gztar” (gzipped tar +format) distributions on all platforms unless “formats” is supplied.

    • +
    • bpo-2466: posixpath.ismount now correctly recognizes mount points which +the user does not have permission to access.

    • +
    • bpo-9998: On Linux, ctypes.util.find_library now looks in LD_LIBRARY_PATH +for shared libraries.

    • +
    • bpo-27573: exit message for code.interact is now configurable.

    • +
    • bpo-27930: Improved behaviour of logging.handlers.QueueListener. Thanks to +Paulo Andrade and Petr Viktorin for the analysis and patch.

    • +
    • bpo-6766: Distributed reference counting added to multiprocessing to +support nesting of shared values / proxy objects.

    • +
    • bpo-21201: Improves readability of multiprocessing error message. Thanks +to Wojciech Walczak for patch.

    • +
    • asyncio: Add set_protocol / get_protocol to Transports.

    • +
    • bpo-27456: asyncio: Set TCP_NODELAY by default.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-15308: Add ‘interrupt execution’ (^C) to Shell menu. Patch by Roger +Serwy, updated by Bayard Randel.

    • +
    • bpo-27922: Stop IDLE tests from ‘flashing’ gui widgets on the screen.

    • +
    • bpo-27891: Consistently group and sort imports within idlelib modules.

    • +
    • bpo-17642: add larger font sizes for classroom projection.

    • +
    • Add version to title of IDLE help window.

    • +
    • bpo-25564: In section on IDLE – console differences, mention that using +exec means that __builtins__ is defined for each statement.

    • +
    • bpo-27821: Fix 3.6.0a3 regression that prevented custom key sets from +being selected when no custom theme was defined.

    • +
    +
    +
    +

    C API

    +
      +
    • bpo-26900: Excluded underscored names and other private API from limited +API.

    • +
    • bpo-26027: Add support for path-like objects in PyUnicode_FSConverter() & +PyUnicode_FSDecoder().

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-27427: Additional tests for the math module. Patch by Francisco Couzo.

    • +
    • bpo-27953: Skip math and cmath tests that fail on OS X 10.4 due to a poor +libm implementation of tan.

    • +
    • bpo-26040: Improve test_math and test_cmath coverage and rigour. Patch by +Jeff Allen.

    • +
    • bpo-27787: Call gc.collect() before checking each test for “dangling +threads”, since the dangling threads are weak references.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-27566: Fix clean target in freeze makefile (patch by Lisa Roach)

    • +
    • bpo-27705: Update message in validate_ucrtbase.py

    • +
    • bpo-27976: Deprecate building _ctypes with the bundled copy of libffi on +non-OSX UNIX platforms.

    • +
    • bpo-27983: Cause lack of llvm-profdata tool when using clang as required +for PGO linking to be a configure time error rather than make time when +--with-optimizations is enabled. Also improve our ability to find the +llvm-profdata tool on MacOS and some Linuxes.

    • +
    • bpo-21590: Support for DTrace and SystemTap probes.

    • +
    • bpo-26307: The profile-opt build now applies PGO to the built-in modules.

    • +
    • bpo-26359: Add the –with-optimizations flag to turn on LTO and PGO build +support when available.

    • +
    • bpo-27917: Set platform triplets for Android builds.

    • +
    • bpo-25825: Update references to the $(LIBPL) installation path on AIX. +This path was changed in 3.2a4.

    • +
    • Update OS X installer to use SQLite 3.14.1 and XZ 5.2.2.

    • +
    • bpo-21122: Fix LTO builds on OS X.

    • +
    • bpo-17128: Build OS X installer with a private copy of OpenSSL. Also +provide a sample Install Certificates command script to install a set of +root certificates from the third-party certifi module.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-27952: Get Tools/scripts/fixcid.py working with Python 3 and the +current “re” module, avoid invalid Python backslash escapes, and fix a bug +parsing escaped C quote signs.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-28065: Update xz dependency to 5.2.2 and build it from source.

    • +
    • bpo-25144: Ensures TargetDir is set before continuing with custom install.

    • +
    • bpo-1602: Windows console doesn’t input or print Unicode (PEP 528)

    • +
    • bpo-27781: Change file system encoding on Windows to UTF-8 (PEP 529)

    • +
    • bpo-27731: Opt-out of MAX_PATH on Windows 10

    • +
    • bpo-6135: Adds encoding and errors parameters to subprocess.

    • +
    • bpo-27959: Adds oem encoding, alias ansi to mbcs, move aliasmbcs to codec +lookup.

    • +
    • bpo-27982: The functions of the winsound module now accept keyword +arguments.

    • +
    • bpo-20366: Build full text search support into SQLite on Windows.

    • +
    • bpo-27756: Adds new icons for Python files and processes on Windows. +Designs by Cherry Wang.

    • +
    • bpo-27883: Update sqlite to 3.14.1.0 on Windows.

    • +
    +
    +
    +
    +

    Python 3.6.0 alpha 4

    +

    Release date: 2016-08-15

    +
    +

    Core and Builtins

    +
      +
    • bpo-27704: Optimized creating bytes and bytearray from byte-like objects +and iterables. Speed up to 3 times for short objects. Original patch by +Naoki Inada.

    • +
    • bpo-26823: Large sections of repeated lines in tracebacks are now +abbreviated as “[Previous line repeated {count} more times]” by the +builtin traceback rendering. Patch by Emanuel Barry.

    • +
    • bpo-27574: Decreased an overhead of parsing keyword arguments in functions +implemented with using Argument Clinic.

    • +
    • bpo-22557: Now importing already imported modules is up to 2.5 times +faster.

    • +
    • bpo-17596: Include <wincrypt.h> to help with Min GW building.

    • +
    • bpo-17599: On Windows, rename the privately defined REPARSE_DATA_BUFFER +structure to avoid conflicting with the definition from Min GW.

    • +
    • bpo-27507: Add integer overflow check in bytearray.extend(). Patch by +Xiang Zhang.

    • +
    • bpo-27581: Don’t rely on wrapping for overflow check in +PySequence_Tuple(). Patch by Xiang Zhang.

    • +
    • bpo-1621: Avoid signed integer overflow in list and tuple operations. +Patch by Xiang Zhang.

    • +
    • bpo-27419: Standard __import__() no longer look up “__import__” in globals +or builtins for importing submodules or “from import”. Fixed a crash if +raise a warning about unabling to resolve package from __spec__ or +__package__.

    • +
    • bpo-27083: Respect the PYTHONCASEOK environment variable under Windows.

    • +
    • bpo-27514: Make having too many statically nested blocks a SyntaxError +instead of SystemError.

    • +
    • bpo-27366: Implemented PEP 487 (Simpler customization of class creation). +Upon subclassing, the __init_subclass__ classmethod is called on the base +class. Descriptors are initialized with __set_name__ after class creation.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-26027: Add PEP 519/__fspath__() support to the os and os.path modules. +Includes code from Jelle Zijlstra. (See also: bpo-27524)

    • +
    • bpo-27598: Add Collections to collections.abc. Patch by Ivan Levkivskyi, +docs by Neil Girdhar.

    • +
    • bpo-25958: Support “anti-registration” of special methods from various +ABCs, like __hash__, __iter__ or __len__. All these (and several more) +can be set to None in an implementation class and the behavior will be as +if the method is not defined at all. (Previously, this mechanism existed +only for __hash__, to make mutable classes unhashable.) Code contributed +by Andrew Barnert and Ivan Levkivskyi.

    • +
    • bpo-16764: Support keyword arguments to zlib.decompress(). Patch by Xiang +Zhang.

    • +
    • bpo-27736: Prevent segfault after interpreter re-initialization due to ref +count problem introduced in code for bpo-27038 in 3.6.0a3. Patch by +Xiang Zhang.

    • +
    • bpo-25628: The verbose and rename parameters for +collections.namedtuple are now keyword-only.

    • +
    • bpo-12345: Add mathematical constant tau to math and cmath. See also PEP +628.

    • +
    • bpo-26823: traceback.StackSummary.format now abbreviates large sections of +repeated lines as “[Previous line repeated {count} more times]” (this +change then further affects other traceback display operations in the +module). Patch by Emanuel Barry.

    • +
    • bpo-27664: Add to concurrent.futures.thread.ThreadPoolExecutor() the +ability to specify a thread name prefix.

    • +
    • bpo-27181: Add geometric_mean and harmonic_mean to statistics module.

    • +
    • bpo-27573: code.interact now prints an message when exiting.

    • +
    • bpo-6422: Add autorange method to timeit.Timer objects.

    • +
    • bpo-27773: Correct some memory management errors server_hostname in +_ssl.wrap_socket().

    • +
    • bpo-26750: unittest.mock.create_autospec() now works properly for +subclasses of property() and other data descriptors. Removes the never +publicly used, never documented unittest.mock.DescriptorTypes tuple.

    • +
    • bpo-26754: Undocumented support of general bytes-like objects as path in +compile() and similar functions is now deprecated.

    • +
    • bpo-26800: Undocumented support of general bytes-like objects as paths in +os functions is now deprecated.

    • +
    • bpo-26981: Add _order_ compatibility shim to enum.Enum for Python 2/3 code +bases.

    • +
    • bpo-27661: Added tzinfo keyword argument to datetime.combine.

    • +
    • In the curses module, raise an error if window.getstr() or window.instr() +is passed a negative value.

    • +
    • bpo-27783: Fix possible usage of uninitialized memory in +operator.methodcaller.

    • +
    • bpo-27774: Fix possible Py_DECREF on unowned object in _sre.

    • +
    • bpo-27760: Fix possible integer overflow in binascii.b2a_qp.

    • +
    • bpo-27758: Fix possible integer overflow in the _csv module for large +record lengths.

    • +
    • bpo-27568: Prevent HTTPoxy attack (CVE-2016-1000110). Ignore the +HTTP_PROXY variable when REQUEST_METHOD environment is set, which +indicates that the script is in CGI mode.

    • +
    • bpo-7063: Remove dead code from the “array” module’s slice handling. Patch +by Chuck.

    • +
    • bpo-27656: Do not assume sched.h defines any SCHED_* constants.

    • +
    • bpo-27130: In the “zlib” module, fix handling of large buffers (typically +4 GiB) when compressing and decompressing. Previously, inputs were +limited to 4 GiB, and compression and decompression operations did not +properly handle results of 4 GiB.

    • +
    • bpo-24773: Implemented PEP 495 (Local Time Disambiguation).

    • +
    • Expose the EPOLLEXCLUSIVE constant (when it is defined) in the select +module.

    • +
    • bpo-27567: Expose the EPOLLRDHUP and POLLRDHUP constants in the select +module.

    • +
    • bpo-1621: Avoid signed int negation overflow in the “audioop” module.

    • +
    • bpo-27533: Release GIL in nt._isdir

    • +
    • bpo-17711: Fixed unpickling by the persistent ID with protocol 0. Original +patch by Alexandre Vassalotti.

    • +
    • bpo-27522: Avoid an unintentional reference cycle in email.feedparser.

    • +
    • bpo-27512: Fix a segfault when os.fspath() called an __fspath__() method +that raised an exception. Patch by Xiang Zhang.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-27714: text_textview and test_autocomplete now pass when re-run in the +same process. This occurs when test_idle fails when run with the -w +option but without -jn. Fix warning from test_config.

    • +
    • bpo-27621: Put query response validation error messages in the query box +itself instead of in a separate messagebox. Redo tests to match. Add Mac +OSX refinements. Original patch by Mark Roseman.

    • +
    • bpo-27620: Escape key now closes Query box as cancelled.

    • +
    • bpo-27609: IDLE: tab after initial whitespace should tab, not +autocomplete. This fixes problem with writing docstrings at least twice +indented.

    • +
    • bpo-27609: Explicitly return None when there are also non-None returns. In +a few cases, reverse a condition and eliminate a return.

    • +
    • bpo-25507: IDLE no longer runs buggy code because of its tkinter imports. +Users must include the same imports required to run directly in Python.

    • +
    • bpo-27173: Add ‘IDLE Modern Unix’ to the built-in key sets. Make the +default key set depend on the platform. Add tests for the changes to the +config module.

    • +
    • bpo-27452: add line counter and crc to IDLE configHandler test dump.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-25805: Skip a test in test_pkgutil as needed that doesn’t work when +__name__ == __main__. Patch by SilentGhost.

    • +
    • bpo-27472: Add test.support.unix_shell as the path to the default shell.

    • +
    • bpo-27369: In test_pyexpat, avoid testing an error message detail that +changed in Expat 2.2.0.

    • +
    • bpo-27594: Prevent assertion error when running test_ast with coverage +enabled: ensure code object has a valid first line number. Patch suggested +by Ivan Levkivskyi.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-27647: Update bundled Tcl/Tk to 8.6.6.

    • +
    • bpo-27610: Adds PEP 514 metadata to Windows installer

    • +
    • bpo-27469: Adds a shell extension to the launcher so that drag and drop +works correctly.

    • +
    • bpo-27309: Enables proper Windows styles in python[w].exe manifest.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-27713: Suppress spurious build warnings when updating importlib’s +bootstrap files. Patch by Xiang Zhang

    • +
    • bpo-25825: Correct the references to Modules/python.exp, which is required +on AIX. The references were accidentally changed in 3.5.0a1.

    • +
    • bpo-27453: CPP invocation in configure must use CPPFLAGS. Patch by Chi +Hsuan Yen.

    • +
    • bpo-27641: The configure script now inserts comments into the makefile to +prevent the pgen and _freeze_importlib executables from being +cross-compiled.

    • +
    • bpo-26662: Set PYTHON_FOR_GEN in configure as the Python program to be +used for file generation during the build.

    • +
    • bpo-10910: Avoid C++ compilation errors on FreeBSD and OS X. Also update +FreedBSD version checks for the original ctype UTF-8 workaround.

    • +
    +
    +
    +
    +

    Python 3.6.0 alpha 3

    +

    Release date: 2016-07-11

    +
    +

    Core and Builtins

    +
      +
    • bpo-27473: Fixed possible integer overflow in bytes and bytearray +concatenations. Patch by Xiang Zhang.

    • +
    • bpo-23034: The output of a special Python build with defined COUNT_ALLOCS, +SHOW_ALLOC_COUNT or SHOW_TRACK_COUNT macros is now off by default. It +can be re-enabled using the “-X showalloccount” option. It now outputs to +stderr instead of stdout.

    • +
    • bpo-27443: __length_hint__() of bytearray iterators no longer return a +negative integer for a resized bytearray.

    • +
    • bpo-27007: The fromhex() class methods of bytes and bytearray subclasses +now return an instance of corresponding subclass.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-26844: Fix error message for imp.find_module() to refer to ‘path’ +instead of ‘name’. Patch by Lev Maximov.

    • +
    • bpo-23804: Fix SSL zero-length recv() calls to not block and not raise an +error about unclean EOF.

    • +
    • bpo-27466: Change time format returned by http.cookie.time2netscape, +confirming the netscape cookie format and making it consistent with +documentation.

    • +
    • bpo-21708: Deprecated dbm.dumb behavior that differs from common dbm +behavior: creating a database in ‘r’ and ‘w’ modes and modifying a +database in ‘r’ mode.

    • +
    • bpo-26721: Change the socketserver.StreamRequestHandler.wfile attribute to +implement BufferedIOBase. In particular, the write() method no longer does +partial writes.

    • +
    • bpo-22115: Added methods trace_add, trace_remove and trace_info in the +tkinter.Variable class. They replace old methods trace_variable, trace, +trace_vdelete and trace_vinfo that use obsolete Tcl commands and might not +work in future versions of Tcl. Fixed old tracing methods: +trace_vdelete() with wrong mode no longer break tracing, trace_vinfo() now +always returns a list of pairs of strings, tracing in the “u” mode now +works.

    • +
    • bpo-26243: Only the level argument to zlib.compress() is keyword argument +now. The first argument is positional-only.

    • +
    • bpo-27038: Expose the DirEntry type as os.DirEntry. Code patch by Jelle +Zijlstra.

    • +
    • bpo-27186: Update os.fspath()/PyOS_FSPath() to check the return value of +__fspath__() to be either str or bytes.

    • +
    • bpo-18726: All optional parameters of the dump(), dumps(), load() and +loads() functions and JSONEncoder and JSONDecoder class constructors in +the json module are now keyword-only.

    • +
    • bpo-27319: Methods selection_set(), selection_add(), selection_remove() +and selection_toggle() of ttk.TreeView now allow passing multiple items as +multiple arguments instead of passing them as a tuple. Deprecated +undocumented ability of calling the selection() method with arguments.

    • +
    • bpo-27079: Fixed curses.ascii functions isblank(), iscntrl() and +ispunct().

    • +
    • bpo-27294: Numerical state in the repr for Tkinter event objects is now +represented as a combination of known flags.

    • +
    • bpo-27177: Match objects in the re module now support index-like objects +as group indices. Based on patches by Jeroen Demeyer and Xiang Zhang.

    • +
    • bpo-26754: Some functions (compile() etc) accepted a filename argument +encoded as an iterable of integers. Now only strings and byte-like objects +are accepted.

    • +
    • bpo-26536: socket.ioctl now supports SIO_LOOPBACK_FAST_PATH. Patch by +Daniel Stokes.

    • +
    • bpo-27048: Prevents distutils failing on Windows when environment +variables contain non-ASCII characters

    • +
    • bpo-27330: Fixed possible leaks in the ctypes module.

    • +
    • bpo-27238: Got rid of bare excepts in the turtle module. Original patch +by Jelle Zijlstra.

    • +
    • bpo-27122: When an exception is raised within the context being managed by +a contextlib.ExitStack() and one of the exit stack generators catches and +raises it in a chain, do not re-raise the original exception when exiting, +let the new chained one through. This avoids the PEP 479 bug described in +issue25782.

    • +
    +
    +
    +

    Security

    +
      +
    • bpo-27278: Fix os.urandom() implementation using getrandom() on Linux. +Truncate size to INT_MAX and loop until we collected enough random bytes, +instead of casting a directly Py_ssize_t to int.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-16864: sqlite3.Cursor.lastrowid now supports REPLACE statement. +Initial patch by Alex LordThorsen.

    • +
    • bpo-26386: Fixed ttk.TreeView selection operations with item id’s +containing spaces.

    • +
    • bpo-8637: Honor a pager set by the env var MANPAGER (in preference to one +set by the env var PAGER).

    • +
    +
    +
    +

    Security

    +
      +
    • bpo-22636: Avoid shell injection problems with ctypes.util.find_library().

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-16182: Fix various functions in the “readline” module to use the +locale encoding, and fix get_begidx() and get_endidx() to return code +point indexes.

    • +
    • bpo-27392: Add loop.connect_accepted_socket(). Patch by Jim Fulton.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-27477: IDLE search dialogs now use ttk widgets.

    • +
    • bpo-27173: Add ‘IDLE Modern Unix’ to the built-in key sets. Make the +default key set depend on the platform. Add tests for the changes to the +config module.

    • +
    • bpo-27452: make command line “idle-test> python test_help.py” work. +__file__ is relative when python is started in the file’s directory.

    • +
    • bpo-27452: add line counter and crc to IDLE configHandler test dump.

    • +
    • bpo-27380: IDLE: add query.py with base Query dialog and ttk widgets. +Module had subclasses SectionName, ModuleName, and HelpSource, which are +used to get information from users by configdialog and file =>Load Module. +Each subclass has itw own validity checks. Using ModuleName allows users +to edit bad module names instead of starting over. Add tests and delete +the two files combined into the new one.

    • +
    • bpo-27372: Test_idle no longer changes the locale.

    • +
    • bpo-27365: Allow non-ascii chars in IDLE NEWS.txt, for contributor names.

    • +
    • bpo-27245: IDLE: Cleanly delete custom themes and key bindings. +Previously, when IDLE was started from a console or by import, a cascade +of warnings was emitted. Patch by Serhiy Storchaka.

    • +
    • bpo-24137: Run IDLE, test_idle, and htest with tkinter default root +disabled. Fix code and tests that fail with this restriction. Fix htests +to not create a second and redundant root and mainloop.

    • +
    • bpo-27310: Fix IDLE.app failure to launch on OS X due to vestigial import.

    • +
    +
    +
    +

    C API

    +
      +
    • bpo-26754: PyUnicode_FSDecoder() accepted a filename argument encoded as +an iterable of integers. Now only strings and byte-like objects are +accepted.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-28066: Fix the logic that searches build directories for generated +include files when building outside the source tree.

    • +
    • bpo-27442: Expose the Android API level that python was built against, in +sysconfig.get_config_vars() as ‘ANDROID_API_LEVEL’.

    • +
    • bpo-27434: The interpreter that runs the cross-build, found in PATH, must +now be of the same feature version (e.g. 3.6) as the source being built.

    • +
    • bpo-26930: Update Windows builds to use OpenSSL 1.0.2h.

    • +
    • bpo-23968: Rename the platform directory from plat-$(MACHDEP) to +plat-$(PLATFORM_TRIPLET). Rename the config directory (LIBPL) from +config-$(LDVERSION) to config-$(LDVERSION)-$(PLATFORM_TRIPLET). Install +the platform specific _sysconfigdata module into the platform directory +and rename it to include the ABIFLAGS.

    • +
    • Don’t use largefile support for GNU/Hurd.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-27332: Fixed the type of the first argument of module-level functions +generated by Argument Clinic. Patch by Petr Viktorin.

    • +
    • bpo-27418: Fixed Tools/importbench/importbench.py.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-19489: Moved the search box from the sidebar to the header and footer +of each page. Patch by Ammar Askar.

    • +
    • bpo-27285: Update documentation to reflect the deprecation of pyvenv +and normalize on the term “virtual environment”. Patch by Steve Piercy.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-27027: Added test.support.is_android that is True when this is an +Android build.

    • +
    +
    +
    +
    +

    Python 3.6.0 alpha 2

    +

    Release date: 2016-06-13

    +
    +

    Core and Builtins

    +
      +
    • bpo-27095: Simplified MAKE_FUNCTION and removed MAKE_CLOSURE opcodes. +Patch by Demur Rumed.

    • +
    • bpo-27190: Raise NotSupportedError if sqlite3 is older than 3.3.1. Patch +by Dave Sawyer.

    • +
    • bpo-27286: Fixed compiling BUILD_MAP_UNPACK_WITH_CALL opcode. Calling +function with generalized unpacking (PEP 448) and conflicting keyword +names could cause undefined behavior.

    • +
    • bpo-27140: Added BUILD_CONST_KEY_MAP opcode.

    • +
    • bpo-27186: Add support for os.PathLike objects to open() (part of PEP +519).

    • +
    • bpo-27066: Fixed SystemError if a custom opener (for open()) returns a +negative number without setting an exception.

    • +
    • bpo-26983: float() now always return an instance of exact float. The +deprecation warning is emitted if __float__ returns an instance of a +strict subclass of float. In a future versions of Python this can be an +error.

    • +
    • bpo-27097: Python interpreter is now about 7% faster due to optimized +instruction decoding. Based on patch by Demur Rumed.

    • +
    • bpo-26647: Python interpreter now uses 16-bit wordcode instead of +bytecode. Patch by Demur Rumed.

    • +
    • bpo-23275: Allow assigning to an empty target list in round brackets: () = +iterable.

    • +
    • bpo-27243: Update the __aiter__ protocol: instead of returning an +awaitable that resolves to an asynchronous iterator, the asynchronous +iterator should be returned directly. Doing the former will trigger a +PendingDeprecationWarning.

    • +
    +
    +
    +

    Library

    +
      +
    • Comment out socket (SO_REUSEPORT) and posix (O_SHLOCK, O_EXLOCK) constants +exposed on the API which are not implemented on GNU/Hurd. They would not +work at runtime anyway.

    • +
    • bpo-27025: Generated names for Tkinter widgets are now more meaningful and +recognizable.

    • +
    • bpo-25455: Fixed crashes in repr of recursive ElementTree.Element and +functools.partial objects.

    • +
    • bpo-27294: Improved repr for Tkinter event objects.

    • +
    • bpo-20508: Improve exception message of IPv{4,6}Network.__getitem__. Patch +by Gareth Rees.

    • +
    +
    +
    +

    Security

    +
      +
    • bpo-26556: Update expat to 2.1.1, fixes CVE-2015-1283.

    • +
    • Fix TLS stripping vulnerability in smtplib, CVE-2016-0772. Reported by +Team Oststrom.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-21386: Implement missing IPv4Address.is_global property. It was +documented since 07a5610bae9d. Initial patch by Roger Luethi.

    • +
    • bpo-27029: Removed deprecated support of universal newlines mode from +ZipFile.open().

    • +
    • bpo-27030: Unknown escapes consisting of '\' and an ASCII letter in +regular expressions now are errors. The re.LOCALE flag now can be used +only with bytes patterns.

    • +
    • bpo-27186: Add os.PathLike support to DirEntry (part of PEP 519). Initial +patch by Jelle Zijlstra.

    • +
    • bpo-20900: distutils register command now decodes HTTP responses +correctly. Initial patch by ingrid.

    • +
    • bpo-27186: Add os.PathLike support to pathlib, removing its provisional +status (part of PEP 519). Initial patch by Dusty Phillips.

    • +
    • bpo-27186: Add support for os.PathLike objects to os.fsencode() and +os.fsdecode() (part of PEP 519).

    • +
    • bpo-27186: Introduce os.PathLike and os.fspath() (part of PEP 519).

    • +
    • A new version of typing.py provides several new classes and features: +@overload outside stubs, Reversible, DefaultDict, Text, ContextManager, +Type[], NewType(), TYPE_CHECKING, and numerous bug fixes (note that some +of the new features are not yet implemented in mypy or other static +analyzers). Also classes for PEP 492 (Awaitable, AsyncIterable, +AsyncIterator) have been added (in fact they made it into 3.5.1 but were +never mentioned).

    • +
    • bpo-25738: Stop http.server.BaseHTTPRequestHandler.send_error() from +sending a message body for 205 Reset Content. Also, don’t send Content +header fields in responses that don’t have a body. Patch by Susumu +Koshiba.

    • +
    • bpo-21313: Fix the “platform” module to tolerate when sys.version contains +truncated build information.

    • +
    +
    +
    +

    Security

    +
      +
    • bpo-26839: On Linux, os.urandom() now calls getrandom() with +GRND_NONBLOCK to fall back on reading /dev/urandom if the urandom +entropy pool is not initialized yet. Patch written by Colm Buckley.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-23883: Added missing APIs to __all__ to match the documented APIs for +the following modules: cgi, mailbox, mimetypes, plistlib and smtpd. +Patches by Jacek Kołodziej.

    • +
    • bpo-27164: In the zlib module, allow decompressing raw Deflate streams +with a predefined zdict. Based on patch by Xiang Zhang.

    • +
    • bpo-24291: Fix wsgiref.simple_server.WSGIRequestHandler to completely +write data to the client. Previously it could do partial writes and +truncate data. Also, wsgiref.handler.ServerHandler can now handle stdout +doing partial writes, but this is deprecated.

    • +
    • bpo-21272: Use _sysconfigdata.py to initialize distutils.sysconfig.

    • +
    • bpo-19611: inspect now reports the implicit .0 parameters +generated by the compiler for comprehension and generator expression +scopes as if they were positional-only parameters called implicit0. +Patch by Jelle Zijlstra.

    • +
    • bpo-26809: Add __all__ to string. Patch by Emanuel Barry.

    • +
    • bpo-26373: subprocess.Popen.communicate now correctly ignores +BrokenPipeError when the child process dies before .communicate() is +called in more/all circumstances.

    • +
    • signal, socket, and ssl module IntEnum constant name lookups now return a +consistent name for values having multiple names. Ex: signal.Signals(6) +now refers to itself as signal.SIGALRM rather than flipping between that +and signal.SIGIOT based on the interpreter’s hash randomization seed.

    • +
    • bpo-27167: Clarify the subprocess.CalledProcessError error message text +when the child process died due to a signal.

    • +
    • bpo-25931: Don’t define socketserver.Forking* names on platforms such as +Windows that do not support os.fork().

    • +
    • bpo-21776: distutils.upload now correctly handles HTTPError. Initial patch +by Claudiu Popa.

    • +
    • bpo-26526: Replace custom parse tree validation in the parser module with +a simple DFA validator.

    • +
    • bpo-27114: Fix SSLContext._load_windows_store_certs fails with +PermissionError

    • +
    • bpo-18383: Avoid creating duplicate filters when using filterwarnings and +simplefilter. Based on patch by Alex Shkop.

    • +
    • bpo-23026: winreg.QueryValueEx() now return an integer for REG_QWORD type.

    • +
    • bpo-26741: subprocess.Popen destructor now emits a ResourceWarning warning +if the child process is still running.

    • +
    • bpo-27056: Optimize pickle.load() and pickle.loads(), up to 10% faster to +deserialize a lot of small objects.

    • +
    • bpo-21271: New keyword only parameters in reset_mock call.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-5124: Paste with text selected now replaces the selection on X11. This +matches how paste works on Windows, Mac, most modern Linux apps, and ttk +widgets. Original patch by Serhiy Storchaka.

    • +
    • bpo-24750: Switch all scrollbars in IDLE to ttk versions. Where needed, +minimal tests are added to cover changes.

    • +
    • bpo-24759: IDLE requires tk 8.5 and availability ttk widgets. Delete now +unneeded tk version tests and code for older versions. Add test for IDLE +syntax colorizer.

    • +
    • bpo-27239: idlelib.macosx.isXyzTk functions initialize as needed.

    • +
    • bpo-27262: move Aqua unbinding code, which enable context menus, to +macosx.

    • +
    • bpo-24759: Make clear in idlelib.idle_test.__init__ that the directory is +a private implementation of test.test_idle and tool for maintainers.

    • +
    • bpo-27196: Stop ‘ThemeChanged’ warnings when running IDLE tests. These +persisted after other warnings were suppressed in #20567. Apply Serhiy +Storchaka’s update_idletasks solution to four test files. Record this +additional advice in idle_test/README.txt

    • +
    • bpo-20567: Revise idle_test/README.txt with advice about avoiding tk +warning messages from tests. Apply advice to several IDLE tests.

    • +
    • bpo-24225: Update idlelib/README.txt with new file names and event +handlers.

    • +
    • bpo-27156: Remove obsolete code not used by IDLE.

    • +
    • bpo-27117: Make colorizer htest and turtledemo work with dark themes. Move +code for configuring text widget colors to a new function.

    • +
    • bpo-24225: Rename many idlelib/*.py and idle_test/test_*.py files. +Edit files to replace old names with new names when the old name referred +to the module rather than the class it contained. See the issue and IDLE +section in What’s New in 3.6 for more.

    • +
    • bpo-26673: When tk reports font size as 0, change to size 10. Such fonts +on Linux prevented the configuration dialog from opening.

    • +
    • bpo-21939: Add test for IDLE’s percolator. Original patch by Saimadhav +Heblikar.

    • +
    • bpo-21676: Add test for IDLE’s replace dialog. Original patch by Saimadhav +Heblikar.

    • +
    • bpo-18410: Add test for IDLE’s search dialog. Original patch by Westley +Martínez.

    • +
    • bpo-21703: Add test for undo delegator. Patch mostly by Saimadhav +Heblikar .

    • +
    • bpo-27044: Add ConfigDialog.remove_var_callbacks to stop memory leaks.

    • +
    • bpo-23977: Add more asserts to test_delegator.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-16484: Change the default PYTHONDOCS URL to “https:”, and fix the +resulting links to use lowercase. Patch by Sean Rodman, test by Kaushik +Nadikuditi.

    • +
    • bpo-24136: Document the new PEP 448 unpacking syntax of 3.5.

    • +
    • bpo-22558: Add remaining doc links to source code for Python-coded +modules. Patch by Yoni Lavi.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-25285: regrtest now uses subprocesses when the -j1 command line option +is used: each test file runs in a fresh child process. Before, the -j1 +option was ignored.

    • +
    • bpo-25285: Tools/buildbot/test.bat script now uses -j1 by default to run +each test file in fresh child process.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-27064: The py.exe launcher now defaults to Python 3. The Windows +launcher py.exe no longer prefers an installed Python 2 version over +Python 3 by default when used interactively.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-27229: Fix the cross-compiling pgen rule for in-tree builds. Patch by +Xavier de Gaye.

    • +
    • bpo-26930: Update OS X 10.5+ 32-bit-only installer to build and link with +OpenSSL 1.0.2h.

    • +
    +
    +
    +

    Windows

    + +
    +
    +

    C API

    +
      +
    • bpo-27186: Add the PyOS_FSPath() function (part of PEP 519).

    • +
    • bpo-26282: PyArg_ParseTupleAndKeywords() now supports positional-only +parameters.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-26282: Argument Clinic now supports positional-only and keyword +parameters in the same function.

    • +
    +
    +
    +
    +

    Python 3.6.0 alpha 1

    +

    Release date: 2016-05-16

    +
    +

    Core and Builtins

    +
      +
    • bpo-20041: Fixed TypeError when frame.f_trace is set to None. Patch by +Xavier de Gaye.

    • +
    • bpo-26168: Fixed possible refleaks in failing Py_BuildValue() with the “N” +format unit.

    • +
    • bpo-26991: Fix possible refleak when creating a function with annotations.

    • +
    • bpo-27039: Fixed bytearray.remove() for values greater than 127. Based on +patch by Joe Jevnik.

    • +
    • bpo-23640: int.from_bytes() no longer bypasses constructors for +subclasses.

    • +
    • bpo-27005: Optimized the float.fromhex() class method for exact float. It +is now 2 times faster.

    • +
    • bpo-18531: Single var-keyword argument of dict subtype was passed +unscathed to the C-defined function. Now it is converted to exact dict.

    • +
    • bpo-26811: gc.get_objects() no longer contains a broken tuple with NULL +pointer.

    • +
    • bpo-20120: Use RawConfigParser for .pypirc parsing, removing support for +interpolation unintentionally added with move to Python 3. Behavior no +longer does any interpolation in .pypirc files, matching behavior in +Python 2.7 and Setuptools 19.0.

    • +
    • bpo-26249: Memory functions of the PyMem_Malloc() domain +(PYMEM_DOMAIN_MEM) now use the pymalloc allocator rather than system malloc(). Applications calling +PyMem_Malloc() without holding the GIL can now crash: use +PYTHONMALLOC=debug environment variable to validate the usage of +memory allocators in your application.

    • +
    • bpo-26802: Optimize function calls only using unpacking like +func(*tuple) (no other positional argument, no keyword): avoid copying +the tuple. Patch written by Joe Jevnik.

    • +
    • bpo-26659: Make the builtin slice type support cycle collection.

    • +
    • bpo-26718: super.__init__ no longer leaks memory if called multiple times. +NOTE: A direct call of super.__init__ is not endorsed!

    • +
    • bpo-27138: Fix the doc comment for FileFinder.find_spec().

    • +
    • bpo-27147: Mention PEP 420 in the importlib docs.

    • +
    • bpo-25339: PYTHONIOENCODING now has priority over locale in setting the +error handler for stdin and stdout.

    • +
    • bpo-26494: Fixed crash on iterating exhausting iterators. Affected classes +are generic sequence iterators, iterators of str, bytes, bytearray, list, +tuple, set, frozenset, dict, OrderedDict, corresponding views and +os.scandir() iterator.

    • +
    • bpo-26574: Optimize bytes.replace(b'', b'.') and +bytearray.replace(b'', b'.'). Patch written by Josh Snider.

    • +
    • bpo-26581: If coding cookie is specified multiple times on a line in +Python source code file, only the first one is taken to account.

    • +
    • bpo-19711: Add tests for reloading namespace packages.

    • +
    • bpo-21099: Switch applicable importlib tests to use PEP 451 API.

    • +
    • bpo-26563: Debug hooks on Python memory allocators now raise a fatal error +if functions of the PyMem_Malloc() family are called without +holding the GIL.

    • +
    • bpo-26564: On error, the debug hooks on Python memory allocators now use +the tracemalloc module to get the traceback where a memory block +was allocated.

    • +
    • bpo-26558: The debug hooks on Python memory allocator +PyObject_Malloc() now detect when functions are called without +holding the GIL.

    • +
    • bpo-26516: Add PYTHONMALLOC environment variable to set the +Python memory allocators and/or install debug hooks.

    • +
    • bpo-26516: The PyMem_SetupDebugHooks() function can now also be +used on Python compiled in release mode.

    • +
    • bpo-26516: The PYTHONMALLOCSTATS environment variable can now +also be used on Python compiled in release mode. It now has no effect if +set to an empty string.

    • +
    • bpo-26516: In debug mode, debug hooks are now also installed on Python +memory allocators when Python is configured without pymalloc.

    • +
    • bpo-26464: Fix str.translate() when string is ASCII and first replacements +removes character, but next replacement uses a non-ASCII character or a +string longer than 1 character. Regression introduced in Python 3.5.0.

    • +
    • bpo-22836: Ensure exception reports from PyErr_Display() and +PyErr_WriteUnraisable() are sensible even when formatting them produces +secondary errors. This affects the reports produced by +sys.__excepthook__() and when __del__() raises an exception.

    • +
    • bpo-26302: Correct behavior to reject comma as a legal character for +cookie names.

    • +
    • bpo-26136: Upgrade the warning when a generator raises StopIteration from +PendingDeprecationWarning to DeprecationWarning. Patch by Anish Shah.

    • +
    • bpo-26204: The compiler now ignores all constant statements: bytes, str, +int, float, complex, name constants (None, False, True), Ellipsis and +ast.Constant; not only str and int. For example, 1.0 is now ignored in +def f(): 1.0.

    • +
    • bpo-4806: Avoid masking the original TypeError exception when using star +(*) unpacking in function calls. Based on patch by Hagen Fürstenau +and Daniel Urban.

    • +
    • bpo-26146: Add a new kind of AST node: ast.Constant. It can be used by +external AST optimizers, but the compiler does not emit directly such +node.

    • +
    • bpo-23601: Sped-up allocation of dict key objects by using Python’s small +object allocator. (Contributed by Julian Taylor.)

    • +
    • bpo-18018: Import raises ImportError instead of SystemError if a relative +import is attempted without a known parent package.

    • +
    • bpo-25843: When compiling code, don’t merge constants if they are equal +but have a different types. For example, f1, f2 = lambda: 1, lambda: +1.0 is now correctly compiled to two different functions: f1() +returns 1 (int) and f2() returns 1.0 (float), even if +1 and 1.0 are equal.

    • +
    • bpo-26107: The format of the co_lnotab attribute of code objects +changes to support negative line number delta.

    • +
    • bpo-26154: Add a new private _PyThreadState_UncheckedGet() function to get +the current Python thread state, but don’t issue a fatal error if it is +NULL. This new function must be used instead of accessing directly the +_PyThreadState_Current variable. The variable is no more exposed since +Python 3.5.1 to hide the exact implementation of atomic C types, to avoid +compiler issues.

    • +
    • bpo-25791: If __package__ != __spec__.parent or if neither __package__ or +__spec__ are defined then ImportWarning is raised.

    • +
    • bpo-22995: [UPDATE] Comment out the one of the pickleability tests in +_PyObject_GetState() due to regressions observed in Cython-based projects.

    • +
    • bpo-25961: Disallowed null characters in the type name.

    • +
    • bpo-25973: Fix segfault when an invalid nonlocal statement binds a name +starting with two underscores.

    • +
    • bpo-22995: Instances of extension types with a state that aren’t +subclasses of list or dict and haven’t implemented any pickle-related +methods (__reduce__, __reduce_ex__, __getnewargs__, __getnewargs_ex__, or +__getstate__), can no longer be pickled. Including memoryview.

    • +
    • bpo-20440: Massive replacing unsafe attribute setting code with special +macro Py_SETREF.

    • +
    • bpo-25766: Special method __bytes__() now works in str subclasses.

    • +
    • bpo-25421: __sizeof__ methods of builtin types now use dynamic basic size. +This allows sys.getsize() to work correctly with their subclasses with +__slots__ defined.

    • +
    • bpo-25709: Fixed problem with in-place string concatenation and utf-8 +cache.

    • +
    • bpo-5319: New Py_FinalizeEx() API allowing Python to set an exit status of +120 on failure to flush buffered streams.

    • +
    • bpo-25485: telnetlib.Telnet is now a context manager.

    • +
    • bpo-24097: Fixed crash in object.__reduce__() if slot name is freed inside +__getattr__.

    • +
    • bpo-24731: Fixed crash on converting objects with special methods +__bytes__, __trunc__, and __float__ returning instances of subclasses of +bytes, int, and float to subclasses of bytes, int, and float +correspondingly.

    • +
    • bpo-25630: Fix a possible segfault during argument parsing in functions +that accept filesystem paths.

    • +
    • bpo-23564: Fixed a partially broken sanity check in the _posixsubprocess +internals regarding how fds_to_pass were passed to the child. The bug had +no actual impact as subprocess.py already avoided it.

    • +
    • bpo-25388: Fixed tokenizer crash when processing undecodable source code +with a null byte.

    • +
    • bpo-25462: The hash of the key now is calculated only once in most +operations in C implementation of OrderedDict.

    • +
    • bpo-22995: Default implementation of __reduce__ and __reduce_ex__ now +rejects builtin types with not defined __new__.

    • +
    • bpo-24802: Avoid buffer overreads when int(), float(), compile(), exec() +and eval() are passed bytes-like objects. These objects are not +necessarily terminated by a null byte, but the functions assumed they +were.

    • +
    • bpo-25555: Fix parser and AST: fill lineno and col_offset of “arg” node +when compiling AST from Python objects.

    • +
    • bpo-24726: Fixed a crash and leaking NULL in repr() of OrderedDict that +was mutated by direct calls of dict methods.

    • +
    • bpo-25449: Iterating OrderedDict with keys with unstable hash now raises +KeyError in C implementations as well as in Python implementation.

    • +
    • bpo-25395: Fixed crash when highly nested OrderedDict structures were +garbage collected.

    • +
    • bpo-25401: Optimize bytes.fromhex() and bytearray.fromhex(): they are now +between 2x and 3.5x faster.

    • +
    • bpo-25399: Optimize bytearray % args using the new private _PyBytesWriter +API. Formatting is now between 2.5 and 5 times faster.

    • +
    • bpo-25274: sys.setrecursionlimit() now raises a RecursionError if the new +recursion limit is too low depending at the current recursion depth. +Modify also the “lower-water mark” formula to make it monotonic. This mark +is used to decide when the overflowed flag of the thread state is reset.

    • +
    • bpo-24402: Fix input() to prompt to the redirected stdout when +sys.stdout.fileno() fails.

    • +
    • bpo-25349: Optimize bytes % args using the new private _PyBytesWriter API. +Formatting is now up to 2 times faster.

    • +
    • bpo-24806: Prevent builtin types that are not allowed to be subclassed +from being subclassed through multiple inheritance.

    • +
    • bpo-25301: The UTF-8 decoder is now up to 15 times as fast for error +handlers: ignore, replace and surrogateescape.

    • +
    • bpo-24848: Fixed a number of bugs in UTF-7 decoding of misformed data.

    • +
    • bpo-25267: The UTF-8 encoder is now up to 75 times as fast for error +handlers: ignore, replace, surrogateescape, surrogatepass. +Patch co-written with Serhiy Storchaka.

    • +
    • bpo-25280: Import trace messages emitted in verbose (-v) mode are no +longer formatted twice.

    • +
    • bpo-25227: Optimize ASCII and latin1 encoders with the surrogateescape +error handler: the encoders are now up to 3 times as fast. Initial patch +written by Serhiy Storchaka.

    • +
    • bpo-25003: On Solaris 11.3 or newer, os.urandom() now uses the getrandom() +function instead of the getentropy() function. The getentropy() function +is blocking to generate very good quality entropy, os.urandom() doesn’t +need such high-quality entropy.

    • +
    • bpo-9232: Modify Python’s grammar to allow trailing commas in the argument +list of a function declaration. For example, “def f(*, a = 3,): pass” is +now legal. Patch from Mark Dickinson.

    • +
    • bpo-24965: Implement PEP 498 “Literal String Interpolation”. This allows +you to embed expressions inside f-strings, which are converted to normal +strings at run time. Given x=3, then f’value={x}’ == ‘value=3’. Patch by +Eric V. Smith.

    • +
    • bpo-26478: Fix semantic bugs when using binary operators with dictionary +views and tuples.

    • +
    • bpo-26171: Fix possible integer overflow and heap corruption in +zipimporter.get_data().

    • +
    • bpo-25660: Fix TAB key behaviour in REPL with readline.

    • +
    • bpo-26288: Optimize PyLong_AsDouble.

    • +
    • bpo-26289: Optimize floor and modulo division for single-digit longs. +Microbenchmarks show 2-2.5x improvement. Built-in ‘divmod’ function is +now also ~10% faster. (See also: bpo-26315)

    • +
    • bpo-25887: Raise a RuntimeError when a coroutine object is awaited more +than once.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-27057: Fix os.set_inheritable() on Android, ioctl() is blocked by +SELinux and fails with EACCESS. The function now falls back to fcntl(). +Patch written by Michał Bednarski.

    • +
    • bpo-27014: Fix infinite recursion using typing.py. Thanks to Kalle Tuure!

    • +
    • bpo-27031: Removed dummy methods in Tkinter widget classes: tk_menuBar() +and tk_bindForTraversal().

    • +
    • bpo-14132: Fix urllib.request redirect handling when the target only has a +query string. Original fix by Ján Janech.

    • +
    • bpo-17214: The “urllib.request” module now percent-encodes non-ASCII bytes +found in redirect target URLs. Some servers send Location header fields +with non-ASCII bytes, but “http.client” requires the request target to be +ASCII-encodable, otherwise a UnicodeEncodeError is raised. Based on patch +by Christian Heimes.

    • +
    • bpo-27033: The default value of the decode_data parameter for +smtpd.SMTPChannel and smtpd.SMTPServer constructors is changed to False.

    • +
    • bpo-27034: Removed deprecated class asynchat.fifo.

    • +
    • bpo-26870: Added readline.set_auto_history(), which can stop entries being +automatically added to the history list. Based on patch by Tyler +Crompton.

    • +
    • bpo-26039: zipfile.ZipFile.open() can now be used to write data into a ZIP +file, as well as for extracting data. Patch by Thomas Kluyver.

    • +
    • bpo-26892: Honor debuglevel flag in urllib.request.HTTPHandler. Patch +contributed by Chi Hsuan Yen.

    • +
    • bpo-22274: In the subprocess module, allow stderr to be redirected to +stdout even when stdout is not redirected. Patch by Akira Li.

    • +
    • bpo-26807: mock_open ‘files’ no longer error on readline at end of file. +Patch from Yolanda Robla.

    • +
    • bpo-25745: Fixed leaking a userptr in curses panel destructor.

    • +
    • bpo-26977: Removed unnecessary, and ignored, call to sum of squares helper +in statistics.pvariance.

    • +
    • bpo-26002: Use bisect in statistics.median instead of a linear search. +Patch by Upendra Kuma.

    • +
    • bpo-25974: Make use of new Decimal.as_integer_ratio() method in statistics +module. Patch by Stefan Krah.

    • +
    • bpo-26996: Add secrets module as described in PEP 506.

    • +
    • bpo-26881: The modulefinder module now supports extended opcode arguments.

    • +
    • bpo-23815: Fixed crashes related to directly created instances of types in +_tkinter and curses.panel modules.

    • +
    • bpo-17765: weakref.ref() no longer silently ignores keyword arguments. +Patch by Georg Brandl.

    • +
    • bpo-26873: xmlrpc now raises ResponseError on unsupported type tags +instead of silently return incorrect result.

    • +
    • bpo-26915: The __contains__ methods in the collections ABCs now check for +identity before checking equality. This better matches the behavior of +the concrete classes, allows sensible handling of NaNs, and makes it +easier to reason about container invariants.

    • +
    • bpo-26711: Fixed the comparison of plistlib.Data with other types.

    • +
    • bpo-24114: Fix an uninitialized variable in ctypes.util.

      +

      The bug only occurs on SunOS when the ctypes implementation searches for +the crle program. Patch by Xiang Zhang. Tested on SunOS by Kees Bos.

      +
    • +
    • bpo-26864: In urllib.request, change the proxy bypass host checking +against no_proxy to be case-insensitive, and to not match unrelated host +names that happen to have a bypassed hostname as a suffix. Patch by Xiang +Zhang.

    • +
    • bpo-24902: Print server URL on http.server startup. Initial patch by +Felix Kaiser.

    • +
    • bpo-25788: fileinput.hook_encoded() now supports an “errors” argument for +passing to open. Original patch by Joseph Hackman.

    • +
    • bpo-26634: recursive_repr() now sets __qualname__ of wrapper. Patch by +Xiang Zhang.

    • +
    • bpo-26804: urllib.request will prefer lower_case proxy environment +variables over UPPER_CASE or Mixed_Case ones. Patch contributed by +Hans-Peter Jansen.

    • +
    • bpo-26837: assertSequenceEqual() now correctly outputs non-stringified +differing items (like bytes in the -b mode). This affects +assertListEqual() and assertTupleEqual().

    • +
    • bpo-26041: Remove “will be removed in Python 3.7” from deprecation +messages of platform.dist() and platform.linux_distribution(). Patch by +Kumaripaba Miyurusara Athukorala.

    • +
    • bpo-26822: itemgetter, attrgetter and methodcaller objects no longer +silently ignore keyword arguments.

    • +
    • bpo-26733: Disassembling a class now disassembles class and static +methods. Patch by Xiang Zhang.

    • +
    • bpo-26801: Fix error handling in shutil.get_terminal_size(), catch +AttributeError instead of NameError. Patch written by +Emanuel Barry.

    • +
    • bpo-24838: tarfile’s ustar and gnu formats now correctly calculate name +and link field limits for multibyte character encodings like utf-8.

    • +
    +
    +
    +

    Security

    +
      +
    • bpo-26657: Fix directory traversal vulnerability with http.server on +Windows. This fixes a regression that was introduced in 3.3.4rc1 and +3.4.0rc1. Based on patch by Philipp Hagemeister.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-26717: Stop encoding Latin-1-ized WSGI paths with UTF-8. Patch by +Anthony Sottile.

    • +
    • bpo-26782: Add STARTUPINFO to subprocess.__all__ on Windows.

    • +
    • bpo-26404: Add context manager to socketserver. Patch by Aviv Palivoda.

    • +
    • bpo-26735: Fix os.urandom() on Solaris 11.3 and newer when reading +more than 1,024 bytes: call getrandom() multiple times with a limit of +1024 bytes per call.

    • +
    • bpo-26585: Eliminate http.server._quote_html() and use +html.escape(quote=False). Patch by Xiang Zhang.

    • +
    • bpo-26685: Raise OSError if closing a socket fails.

    • +
    • bpo-16329: Add .webm to mimetypes.types_map. Patch by Giampaolo Rodola’.

    • +
    • bpo-13952: Add .csv to mimetypes.types_map. Patch by Geoff Wilson.

    • +
    • bpo-26587: the site module now allows .pth files to specify files to be +added to sys.path (e.g. zip files).

    • +
    • bpo-25609: Introduce contextlib.AbstractContextManager and +typing.ContextManager.

    • +
    • bpo-26709: Fixed Y2038 problem in loading binary PLists.

    • +
    • bpo-23735: Handle terminal resizing with Readline 6.3+ by installing our +own SIGWINCH handler. Patch by Eric Price.

    • +
    • bpo-25951: Change SSLSocket.sendall() to return None, as explicitly +documented for plain socket objects. Patch by Aviv Palivoda.

    • +
    • bpo-26586: In http.server, respond with “413 Request header fields too +large” if there are too many header fields to parse, rather than killing +the connection and raising an unhandled exception. Patch by Xiang Zhang.

    • +
    • bpo-26676: Added missing XMLPullParser to ElementTree.__all__.

    • +
    • bpo-22854: Change BufferedReader.writable() and BufferedWriter.readable() +to always return False.

    • +
    • bpo-26492: Exhausted iterator of array.array now conforms with the +behavior of iterators of other mutable sequences: it lefts exhausted even +if iterated array is extended.

    • +
    • bpo-26641: doctest.DocFileTest and doctest.testfile() now support packages +(module splitted into multiple directories) for the package parameter.

    • +
    • bpo-25195: Fix a regression in mock.MagicMock. _Call is a subclass of +tuple (changeset 3603bae63c13 only works for classes) so we need to +implement __ne__ ourselves. Patch by Andrew Plummer.

    • +
    • bpo-26644: Raise ValueError rather than SystemError when a negative length +is passed to SSLSocket.recv() or read().

    • +
    • bpo-23804: Fix SSL recv(0) and read(0) methods to return zero bytes +instead of up to 1024.

    • +
    • bpo-26616: Fixed a bug in datetime.astimezone() method.

    • +
    • bpo-26637: The importlib module now emits an ImportError +rather than a TypeError if __import__() is tried during the +Python shutdown process but sys.path is already cleared (set to +None).

    • +
    • bpo-21925: warnings.formatwarning() now catches exceptions when +calling linecache.getline() and +tracemalloc.get_object_traceback() to be able to log +ResourceWarning emitted late during the Python shutdown process.

    • +
    • bpo-23848: On Windows, faulthandler.enable() now also installs an +exception handler to dump the traceback of all Python threads on any +Windows exception, not only on UNIX signals (SIGSEGV, SIGFPE, SIGABRT).

    • +
    • bpo-26530: Add C functions _PyTraceMalloc_Track() and +_PyTraceMalloc_Untrack() to track memory blocks using the +tracemalloc module. Add _PyTraceMalloc_GetTraceback() to +get the traceback of an object.

    • +
    • bpo-26588: The _tracemalloc now supports tracing memory allocations of +multiple address spaces (domains).

    • +
    • bpo-24266: Ctrl+C during Readline history search now cancels the search +mode when compiled with Readline 7.

    • +
    • bpo-26590: Implement a safe finalizer for the _socket.socket type. It now +releases the GIL to close the socket.

    • +
    • bpo-18787: spwd.getspnam() now raises a PermissionError if the user +doesn’t have privileges.

    • +
    • bpo-26560: Avoid potential ValueError in BaseHandler.start_response. +Initial patch by Peter Inglesby.

    • +
    • bpo-26567: Add a new function PyErr_ResourceWarning() function to +pass the destroyed object. Add a source attribute to +warnings.WarningMessage. Add warnings._showwarnmsg() which uses +tracemalloc to get the traceback where source object was allocated.

    • +
    +
    +
    +

    Security

    +
      +
    • bpo-26313: ssl.py _load_windows_store_certs fails if windows cert store is +empty. Patch by Baji.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-26569: Fix pyclbr.readmodule() and pyclbr.readmodule_ex() +to support importing packages.

    • +
    • bpo-26499: Account for remaining Content-Length in HTTPResponse.readline() +and read1(). Based on patch by Silent Ghost. Also document that +HTTPResponse now supports these methods.

    • +
    • bpo-25320: Handle sockets in directories unittest discovery is scanning. +Patch from Victor van den Elzen.

    • +
    • bpo-16181: cookiejar.http2time() now returns None if year is higher than +datetime.MAXYEAR.

    • +
    • bpo-26513: Fixes platform module detection of Windows Server

    • +
    • bpo-23718: Fixed parsing time in week 0 before Jan 1. Original patch by +Tamás Bence Gedai.

    • +
    • bpo-26323: Add Mock.assert_called() and Mock.assert_called_once() methods +to unittest.mock. Patch written by Amit Saha.

    • +
    • bpo-20589: Invoking Path.owner() and Path.group() on Windows now raise +NotImplementedError instead of ImportError.

    • +
    • bpo-26177: Fixed the keys() method for Canvas and Scrollbar widgets.

    • +
    • bpo-15068: Got rid of excessive buffering in fileinput. The bufsize +parameter is now deprecated and ignored.

    • +
    • bpo-19475: Added an optional argument timespec to the datetime isoformat() +method to choose the precision of the time component.

    • +
    • bpo-2202: Fix UnboundLocalError in +AbstractDigestAuthHandler.get_algorithm_impls. Initial patch by Mathieu +Dupuy.

    • +
    • bpo-26167: Minimized overhead in copy.copy() and copy.deepcopy(). +Optimized copying and deepcopying bytearrays, NotImplemented, slices, +short lists, tuples, dicts, sets.

    • +
    • bpo-25718: Fixed pickling and copying the accumulate() iterator with total +is None.

    • +
    • bpo-26475: Fixed debugging output for regular expressions with the (?x) +flag.

    • +
    • bpo-26482: Allowed pickling recursive dequeues.

    • +
    • bpo-26335: Make mmap.write() return the number of bytes written like other +write methods. Patch by Jakub Stasiak.

    • +
    • bpo-26457: Fixed the subnets() methods in IP network classes for the case +when resulting prefix length is equal to maximal prefix length. Based on +patch by Xiang Zhang.

    • +
    • bpo-26385: Remove the file if the internal open() call in +NamedTemporaryFile() fails. Patch by Silent Ghost.

    • +
    • bpo-26402: Fix XML-RPC client to retry when the server shuts down a +persistent connection. This was a regression related to the new +http.client.RemoteDisconnected exception in 3.5.0a4.

    • +
    • bpo-25913: Leading <~ is optional now in base64.a85decode() with +adobe=True. Patch by Swati Jaiswal.

    • +
    • bpo-26186: Remove an invalid type check in importlib.util.LazyLoader.

    • +
    • bpo-26367: importlib.__import__() raises ImportError like +builtins.__import__() when level is specified but without an +accompanying package specified.

    • +
    • bpo-26309: In the “socketserver” module, shut down the request (closing +the connected socket) when verify_request() returns false. Patch by Aviv +Palivoda.

    • +
    • bpo-23430: Change the socketserver module to only catch exceptions raised +from a request handler that are derived from Exception (instead of +BaseException). Therefore SystemExit and KeyboardInterrupt no longer +trigger the handle_error() method, and will now to stop a single-threaded +server.

    • +
    +
    +
    +

    Security

    +
      +
    • bpo-25939: On Windows open the cert store readonly in +ssl.enum_certificates.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-25995: os.walk() no longer uses FDs proportional to the tree depth.

    • +
    • bpo-25994: Added the close() method and the support of the context manager +protocol for the os.scandir() iterator.

    • +
    • bpo-23992: multiprocessing: make MapResult not fail-fast upon exception.

    • +
    • bpo-26243: Support keyword arguments to zlib.compress(). Patch by Aviv +Palivoda.

    • +
    • bpo-26117: The os.scandir() iterator now closes file descriptor not only +when the iteration is finished, but when it was failed with error.

    • +
    • bpo-25949: __dict__ for an OrderedDict instance is now created only when +needed.

    • +
    • bpo-25911: Restored support of bytes paths in os.walk() on Windows.

    • +
    • bpo-26045: Add UTF-8 suggestion to error message when posting a +non-Latin-1 string with http.client.

    • +
    • bpo-26039: Added zipfile.ZipInfo.from_file() and zipinfo.ZipInfo.is_dir(). +Patch by Thomas Kluyver.

    • +
    • bpo-12923: Reset FancyURLopener’s redirect counter even if there is an +exception. Based on patches by Brian Brazil and Daniel Rocco.

    • +
    • bpo-25945: Fixed a crash when unpickle the functools.partial object with +wrong state. Fixed a leak in failed functools.partial constructor. “args” +and “keywords” attributes of functools.partial have now always types tuple +and dict correspondingly.

    • +
    • bpo-26202: copy.deepcopy() now correctly copies range() objects with +non-atomic attributes.

    • +
    • bpo-23076: Path.glob() now raises a ValueError if it’s called with an +invalid pattern. Patch by Thomas Nyberg.

    • +
    • bpo-19883: Fixed possible integer overflows in zipimport.

    • +
    • bpo-26227: On Windows, getnameinfo(), gethostbyaddr() and +gethostbyname_ex() functions of the socket module now decode the hostname +from the ANSI code page rather than UTF-8.

    • +
    • bpo-26099: The site module now writes an error into stderr if +sitecustomize module can be imported but executing the module raise an +ImportError. Same change for usercustomize.

    • +
    • bpo-26147: xmlrpc now works with strings not encodable with used non-UTF-8 +encoding.

    • +
    • bpo-25935: Garbage collector now breaks reference loops with OrderedDict.

    • +
    • bpo-16620: Fixed AttributeError in msilib.Directory.glob().

    • +
    • bpo-26013: Added compatibility with broken protocol 2 pickles created in +old Python 3 versions (3.4.3 and lower).

    • +
    • bpo-26129: Deprecated accepting non-integers in grp.getgrgid().

    • +
    • bpo-25850: Use cross-compilation by default for 64-bit Windows.

    • +
    • bpo-25822: Add docstrings to the fields of urllib.parse results. Patch +contributed by Swati Jaiswal.

    • +
    • bpo-22642: Convert trace module option parsing mechanism to argparse. +Patch contributed by SilentGhost.

    • +
    • bpo-24705: Fix sysconfig._parse_makefile not expanding ${} vars appearing +before $() vars.

    • +
    • bpo-26069: Remove the deprecated apis in the trace module.

    • +
    • bpo-22138: Fix mock.patch behavior when patching descriptors. Restore +original values after patching. Patch contributed by Sean McCully.

    • +
    • bpo-25672: In the ssl module, enable the SSL_MODE_RELEASE_BUFFERS mode +option if it is safe to do so.

    • +
    • bpo-26012: Don’t traverse into symlinks for ** pattern in +pathlib.Path.[r]glob().

    • +
    • bpo-24120: Ignore PermissionError when traversing a tree with +pathlib.Path.[r]glob(). Patch by Ulrich Petri.

    • +
    • bpo-21815: Accept ] characters in the data portion of imap responses, in +order to handle the flags with square brackets accepted and produced by +servers such as gmail.

    • +
    • bpo-25447: fileinput now uses sys.stdin as-is if it does not have a buffer +attribute (restores backward compatibility).

    • +
    • bpo-25971: Optimized creating Fractions from floats by 2 times and from +Decimals by 3 times.

    • +
    • bpo-25802: Document as deprecated the remaining implementations of +importlib.abc.Loader.load_module().

    • +
    • bpo-25928: Add Decimal.as_integer_ratio().

    • +
    • bpo-25447: Copying the lru_cache() wrapper object now always works, +independently from the type of the wrapped object (by returning the +original object unchanged).

    • +
    • bpo-25768: Have the functions in compileall return booleans instead of +ints and add proper documentation and tests for the return values.

    • +
    • bpo-24103: Fixed possible use after free in ElementTree.XMLPullParser.

    • +
    • bpo-25860: os.fwalk() no longer skips remaining directories when error +occurs. Original patch by Samson Lee.

    • +
    • bpo-25914: Fixed and simplified OrderedDict.__sizeof__.

    • +
    • bpo-25869: Optimized deepcopying ElementTree; it is now 20 times faster.

    • +
    • bpo-25873: Optimized iterating ElementTree. Iterating elements +Element.iter() is now 40% faster, iterating text Element.itertext() is now +up to 2.5 times faster.

    • +
    • bpo-25902: Fixed various refcount issues in ElementTree iteration.

    • +
    • bpo-22227: The TarFile iterator is reimplemented using generator. This +implementation is simpler that using class.

    • +
    • bpo-25638: Optimized ElementTree.iterparse(); it is now 2x faster. +Optimized ElementTree parsing; it is now 10% faster.

    • +
    • bpo-25761: Improved detecting errors in broken pickle data.

    • +
    • bpo-25717: Restore the previous behaviour of tolerating most fstat() +errors when opening files. This was a regression in 3.5a1, and stopped +anonymous temporary files from working in special cases.

    • +
    • bpo-24903: Fix regression in number of arguments compileall accepts when +‘-d’ is specified. The check on the number of arguments has been dropped +completely as it never worked correctly anyway.

    • +
    • bpo-25764: In the subprocess module, preserve any exception caused by +fork() failure when preexec_fn is used.

    • +
    • bpo-25771: Tweak the exception message for importlib.util.resolve_name() +when ‘package’ isn’t specified but necessary.

    • +
    • bpo-6478: _strptime’s regexp cache now is reset after changing timezone +with time.tzset().

    • +
    • bpo-14285: When executing a package with the “python -m package” option, +and package initialization fails, a proper traceback is now reported. The +“runpy” module now lets exceptions from package initialization pass back +to the caller, rather than raising ImportError.

    • +
    • bpo-19771: Also in runpy and the “-m” option, omit the irrelevant message +“… is a package and cannot be directly executed” if the package could +not even be initialized (e.g. due to a bad *.pyc file).

    • +
    • bpo-25177: Fixed problem with the mean of very small and very large +numbers. As a side effect, statistics.mean and statistics.variance should +be significantly faster.

    • +
    • bpo-25718: Fixed copying object with state with boolean value is false.

    • +
    • bpo-10131: Fixed deep copying of minidom documents. Based on patch by +Marian Ganisin.

    • +
    • bpo-7990: dir() on ElementTree.Element now lists properties: “tag”, +“text”, “tail” and “attrib”. Original patch by Santoso Wijaya.

    • +
    • bpo-25725: Fixed a reference leak in pickle.loads() when unpickling +invalid data including tuple instructions.

    • +
    • bpo-25663: In the Readline completer, avoid listing duplicate global +names, and search the global namespace before searching builtins.

    • +
    • bpo-25688: Fixed file leak in ElementTree.iterparse() raising an error.

    • +
    • bpo-23914: Fixed SystemError raised by unpickler on broken pickle data.

    • +
    • bpo-25691: Fixed crash on deleting ElementTree.Element attributes.

    • +
    • bpo-25624: ZipFile now always writes a ZIP_STORED header for directory +entries. Patch by Dingyuan Wang.

    • +
    • bpo-25626: Change three zlib functions to accept sizes that fit in +Py_ssize_t, but internally cap those sizes to UINT_MAX. This resolves a +regression in 3.5 where GzipFile.read() failed to read chunks larger than +2 or 4 GiB. The change affects the zlib.Decompress.decompress() +max_length parameter, the zlib.decompress() bufsize parameter, and the +zlib.Decompress.flush() length parameter.

    • +
    • bpo-25583: Avoid incorrect errors raised by os.makedirs(exist_ok=True) +when the OS gives priority to errors such as EACCES over EEXIST.

    • +
    • bpo-25593: Change semantics of EventLoop.stop() in asyncio.

    • +
    • bpo-6973: When we know a subprocess.Popen process has died, do not allow +the send_signal(), terminate(), or kill() methods to do anything as they +could potentially signal a different process.

    • +
    • bpo-23883: Added missing APIs to __all__ to match the documented APIs for +the following modules: calendar, csv, enum, fileinput, ftplib, logging, +optparse, tarfile, threading and wave. Also added a +test.support.check__all__() helper. Patches by Jacek Kołodziej, Mauro S. +M. Rodrigues and Joel Taddei.

    • +
    • bpo-25590: In the Readline completer, only call getattr() once per +attribute. Also complete names of attributes such as properties and slots +which are listed by dir() but not yet created on an instance.

    • +
    • bpo-25498: Fix a crash when garbage-collecting ctypes objects created by +wrapping a memoryview. This was a regression made in 3.5a1. Based on +patch by Eryksun.

    • +
    • bpo-25584: Added “escape” to the __all__ list in the glob module.

    • +
    • bpo-25584: Fixed recursive glob() with patterns starting with **.

    • +
    • bpo-25446: Fix regression in smtplib’s AUTH LOGIN support.

    • +
    • bpo-18010: Fix the pydoc web server’s module search function to handle +exceptions from importing packages.

    • +
    • bpo-25554: Got rid of circular references in regular expression parsing.

    • +
    • bpo-18973: Command-line interface of the calendar module now uses argparse +instead of optparse.

    • +
    • bpo-25510: fileinput.FileInput.readline() now returns b’’ instead of ‘’ at +the end if the FileInput was opened with binary mode. Patch by Ryosuke +Ito.

    • +
    • bpo-25503: Fixed inspect.getdoc() for inherited docstrings of properties. +Original patch by John Mark Vandenberg.

    • +
    • bpo-25515: Always use os.urandom as a source of randomness in uuid.uuid4.

    • +
    • bpo-21827: Fixed textwrap.dedent() for the case when largest common +whitespace is a substring of smallest leading whitespace. Based on patch +by Robert Li.

    • +
    • bpo-25447: The lru_cache() wrapper objects now can be copied and pickled +(by returning the original object unchanged).

    • +
    • bpo-25390: typing: Don’t crash on Union[str, Pattern].

    • +
    • bpo-25441: asyncio: Raise error from drain() when socket is closed.

    • +
    • bpo-25410: Cleaned up and fixed minor bugs in C implementation of +OrderedDict.

    • +
    • bpo-25411: Improved Unicode support in SMTPHandler through better use of +the email package. Thanks to user simon04 for the patch.

    • +
    • Move the imp module from a PendingDeprecationWarning to +DeprecationWarning.

    • +
    • bpo-25407: Remove mentions of the formatter module being removed in Python +3.6.

    • +
    • bpo-25406: Fixed a bug in C implementation of OrderedDict.move_to_end() +that caused segmentation fault or hang in iterating after moving several +items to the start of ordered dict.

    • +
    • bpo-25382: pickletools.dis() now outputs implicit memo index for the +MEMOIZE opcode.

    • +
    • bpo-25357: Add an optional newline parameter to binascii.b2a_base64(). +base64.b64encode() uses it to avoid a memory copy.

    • +
    • bpo-24164: Objects that need calling __new__ with keyword arguments, +can now be pickled using pickle protocols older than protocol version 4.

    • +
    • bpo-25364: zipfile now works in threads disabled builds.

    • +
    • bpo-25328: smtpd’s SMTPChannel now correctly raises a ValueError if both +decode_data and enable_SMTPUTF8 are set to true.

    • +
    • bpo-16099: RobotFileParser now supports Crawl-delay and Request-rate +extensions. Patch by Nikolay Bogoychev.

    • +
    • bpo-25316: distutils raises OSError instead of DistutilsPlatformError when +MSVC is not installed.

    • +
    • bpo-25380: Fixed protocol for the STACK_GLOBAL opcode in +pickletools.opcodes.

    • +
    • bpo-23972: Updates asyncio datagram create method allowing reuseport and +reuseaddr socket options to be set prior to binding the socket. Mirroring +the existing asyncio create_server method the reuseaddr option for +datagram sockets defaults to True if the O/S is ‘posix’ (except if the +platform is Cygwin). Patch by Chris Laws.

    • +
    • bpo-25304: Add asyncio.run_coroutine_threadsafe(). This lets you submit a +coroutine to a loop from another thread, returning a +concurrent.futures.Future. By Vincent Michel.

    • +
    • bpo-25232: Fix CGIRequestHandler to split the query from the URL at the +first question mark (?) rather than the last. Patch from Xiang Zhang.

    • +
    • bpo-24657: Prevent CGIRequestHandler from collapsing slashes in the query +part of the URL as if it were a path. Patch from Xiang Zhang.

    • +
    • bpo-25287: Don’t add crypt.METHOD_CRYPT to crypt.methods if it’s not +supported. Check if it is supported, it may not be supported on OpenBSD +for example.

    • +
    • bpo-23600: Default implementation of tzinfo.fromutc() was returning wrong +results in some cases.

    • +
    • bpo-25203: Failed readline.set_completer_delims() no longer left the +module in inconsistent state.

    • +
    • bpo-25011: rlcompleter now omits private and special attribute names +unless the prefix starts with underscores.

    • +
    • bpo-25209: rlcompleter now can add a space or a colon after completed +keyword.

    • +
    • bpo-22241: timezone.utc name is now plain ‘UTC’, not ‘UTC-00:00’.

    • +
    • bpo-23517: fromtimestamp() and utcfromtimestamp() methods of +datetime.datetime now round microseconds to nearest with ties going to +nearest even integer (ROUND_HALF_EVEN), as round(float), instead of +rounding towards -Infinity (ROUND_FLOOR).

    • +
    • bpo-23552: Timeit now warns when there is substantial (4x) variance +between best and worst times. Patch from Serhiy Storchaka.

    • +
    • bpo-24633: site-packages/README -> README.txt.

    • +
    • bpo-24879: help() and pydoc can now list named tuple fields in the order +they were defined rather than alphabetically. The ordering is determined +by the _fields attribute if present.

    • +
    • bpo-24874: Improve speed of itertools.cycle() and make its pickle more +compact.

    • +
    • Fix crash in itertools.cycle.__setstate__() when the first argument wasn’t +a list.

    • +
    • bpo-20059: urllib.parse raises ValueError on all invalid ports. Patch by +Martin Panter.

    • +
    • bpo-24360: Improve __repr__ of argparse.Namespace() for invalid +identifiers. Patch by Matthias Bussonnier.

    • +
    • bpo-23426: run_setup was broken in distutils. Patch from Alexander +Belopolsky.

    • +
    • bpo-13938: 2to3 converts StringTypes to a tuple. Patch from Mark Hammond.

    • +
    • bpo-2091: open() accepted a ‘U’ mode string containing ‘+’, but ‘U’ can +only be used with ‘r’. Patch from Jeff Balogh and John O’Connor.

    • +
    • bpo-8585: improved tests for zipimporter2. Patch from Mark Lawrence.

    • +
    • bpo-18622: unittest.mock.mock_open().reset_mock would recurse infinitely. +Patch from Nicola Palumbo and Laurent De Buyst.

    • +
    • bpo-24426: Fast searching optimization in regular expressions now works +for patterns that starts with capturing groups. Fast searching +optimization now can’t be disabled at compile time.

    • +
    • bpo-23661: unittest.mock side_effects can now be exceptions again. This +was a regression vs Python 3.4. Patch from Ignacio Rossi

    • +
    • bpo-13248: Remove deprecated inspect.getmoduleinfo function.

    • +
    • bpo-25578: Fix (another) memory leak in SSLSocket.getpeercer().

    • +
    • bpo-25530: Disable the vulnerable SSLv3 protocol by default when creating +ssl.SSLContext.

    • +
    • bpo-25569: Fix memory leak in SSLSocket.getpeercert().

    • +
    • bpo-25471: Sockets returned from accept() shouldn’t appear to be +nonblocking.

    • +
    • bpo-25319: When threading.Event is reinitialized, the underlying condition +should use a regular lock rather than a recursive lock.

    • +
    • Skip getaddrinfo if host is already resolved. Patch by A. Jesse Jiryu +Davis.

    • +
    • bpo-26050: Add asyncio.StreamReader.readuntil() method. Patch by Марк +Коренберг.

    • +
    • bpo-25924: Avoid unnecessary serialization of getaddrinfo(3) calls on OS X +versions 10.5 or higher. Original patch by A. Jesse Jiryu Davis.

    • +
    • bpo-26406: Avoid unnecessary serialization of getaddrinfo(3) calls on +current versions of OpenBSD and NetBSD. Patch by A. Jesse Jiryu Davis.

    • +
    • bpo-26848: Fix asyncio/subprocess.communicate() to handle empty input. +Patch by Jack O’Connor.

    • +
    • bpo-27040: Add loop.get_exception_handler method

    • +
    • bpo-27041: asyncio: Add loop.create_future method

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-20640: Add tests for idlelib.configHelpSourceEdit. Patch by Saimadhav +Heblikar.

    • +
    • In the ‘IDLE-console differences’ section of the IDLE doc, clarify how +running with IDLE affects sys.modules and the standard streams.

    • +
    • bpo-25507: fix incorrect change in IOBinding that prevented printing. +Augment IOBinding htest to include all major IOBinding functions.

    • +
    • bpo-25905: Revert unwanted conversion of ‘ to ’ RIGHT SINGLE QUOTATION +MARK in README.txt and open this and NEWS.txt with ‘ascii’. Re-encode +CREDITS.txt to utf-8 and open it with ‘utf-8’.

    • +
    • bpo-15348: Stop the debugger engine (normally in a user process) before +closing the debugger window (running in the IDLE process). This prevents +the RuntimeErrors that were being caught and ignored.

    • +
    • bpo-24455: Prevent IDLE from hanging when a) closing the shell while the +debugger is active (15347); b) closing the debugger with the [X] button +(15348); and c) activating the debugger when already active (24455). The +patch by Mark Roseman does this by making two changes. 1. Suspend and +resume the gui.interaction method with the tcl vwait mechanism intended +for this purpose (instead of root.mainloop & .quit). 2. In gui.run, allow +any existing interaction to terminate first.

    • +
    • Change ‘The program’ to ‘Your program’ in an IDLE ‘kill program?’ message +to make it clearer that the program referred to is the currently running +user program, not IDLE itself.

    • +
    • bpo-24750: Improve the appearance of the IDLE editor window status bar. +Patch by Mark Roseman.

    • +
    • bpo-25313: Change the handling of new built-in text color themes to better +address the compatibility problem introduced by the addition of IDLE Dark. +Consistently use the revised idleConf.CurrentTheme everywhere in idlelib.

    • +
    • bpo-24782: Extension configuration is now a tab in the IDLE Preferences +dialog rather than a separate dialog. The former tabs are now a sorted +list. Patch by Mark Roseman.

    • +
    • bpo-22726: Re-activate the config dialog help button with some content +about the other buttons and the new IDLE Dark theme.

    • +
    • bpo-24820: IDLE now has an ‘IDLE Dark’ built-in text color theme. It is +more or less IDLE Classic inverted, with a cobalt blue background. +Strings, comments, keywords, … are still green, red, orange, … . To +use it with IDLEs released before November 2015, hit the ‘Save as New +Custom Theme’ button and enter a new name, such as ‘Custom Dark’. The +custom theme will work with any IDLE release, and can be modified.

    • +
    • bpo-25224: README.txt is now an idlelib index for IDLE developers and +curious users. The previous user content is now in the IDLE doc chapter. +‘IDLE’ now means ‘Integrated Development and Learning Environment’.

    • +
    • bpo-24820: Users can now set breakpoint colors in Settings -> Custom +Highlighting. Original patch by Mark Roseman.

    • +
    • bpo-24972: Inactive selection background now matches active selection +background, as configured by users, on all systems. Found items are now +always highlighted on Windows. Initial patch by Mark Roseman.

    • +
    • bpo-24570: Idle: make calltip and completion boxes appear on Macs affected +by a tk regression. Initial patch by Mark Roseman.

    • +
    • bpo-24988: Idle ScrolledList context menus (used in debugger) now work on +Mac Aqua. Patch by Mark Roseman.

    • +
    • bpo-24801: Make right-click for context menu work on Mac Aqua. Patch by +Mark Roseman.

    • +
    • bpo-25173: Associate tkinter messageboxes with a specific widget. For Mac +OSX, make them a ‘sheet’. Patch by Mark Roseman.

    • +
    • bpo-25198: Enhance the initial html viewer now used for Idle Help. +Properly indent fixed-pitch text (patch by Mark Roseman). Give code +snippet a very Sphinx-like light blueish-gray background. Re-use initial +width and height set by users for shell and editor. When the Table of +Contents (TOC) menu is used, put the section header at the top of the +screen.

    • +
    • bpo-25225: Condense and rewrite Idle doc section on text colors.

    • +
    • bpo-21995: Explain some differences between IDLE and console Python.

    • +
    • bpo-22820: Explain need for print when running file from Idle editor.

    • +
    • bpo-25224: Doc: augment Idle feature list and no-subprocess section.

    • +
    • bpo-25219: Update doc for Idle command line options. Some were missing and +notes were not correct.

    • +
    • bpo-24861: Most of idlelib is private and subject to change. Use +idleib.idle.* to start Idle. See idlelib.__init__.__doc__.

    • +
    • bpo-25199: Idle: add synchronization comments for future maintainers.

    • +
    • bpo-16893: Replace help.txt with help.html for Idle doc display. The new +idlelib/help.html is rstripped Doc/build/html/library/idle.html. It looks +better than help.txt and will better document Idle as released. The +tkinter html viewer that works for this file was written by Rose Roseman. +The now unused EditorWindow.HelpDialog class and helt.txt file are +deprecated.

    • +
    • bpo-24199: Deprecate unused idlelib.idlever with possible removal in 3.6.

    • +
    • bpo-24790: Remove extraneous code (which also create 2 & 3 conflicts).

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-26736: Used HTTPS for external links in the documentation if possible.

    • +
    • bpo-6953: Rework the Readline module documentation to group related +functions together, and add more details such as what underlying Readline +functions and variables are accessed.

    • +
    • bpo-23606: Adds note to ctypes documentation regarding cdll.msvcrt.

    • +
    • bpo-24952: Clarify the default size argument of stack_size() in the +“threading” and “_thread” modules. Patch from Mattip.

    • +
    • bpo-26014: Update 3.x packaging documentation: * “See also” links to the +new docs are now provided in the legacy pages * links to setuptools +documentation have been updated

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-21916: Added tests for the turtle module. Patch by ingrid, Gregory +Loyse and Jelle Zijlstra.

    • +
    • bpo-26295: When using “python3 -m test –testdir=TESTDIR”, regrtest +doesn’t add “test.” prefix to test module names.

    • +
    • bpo-26523: The multiprocessing thread pool (multiprocessing.dummy.Pool) +was untested.

    • +
    • bpo-26015: Added new tests for pickling iterators of mutable sequences.

    • +
    • bpo-26325: Added test.support.check_no_resource_warning() to check that no +ResourceWarning is emitted.

    • +
    • bpo-25940: Changed test_ssl to use its internal local server more. This +avoids relying on svn.python.org, which recently changed root certificate.

    • +
    • bpo-25616: Tests for OrderedDict are extracted from test_collections into +separate file test_ordered_dict.

    • +
    • bpo-25449: Added tests for OrderedDict subclasses.

    • +
    • bpo-25188: Add -P/–pgo to test.regrtest to suppress error output when +running the test suite for the purposes of a PGO build. Initial patch by +Alecsandru Patrascu.

    • +
    • bpo-22806: Add python -m test --list-tests command to list tests.

    • +
    • bpo-18174: python -m test --huntrleaks ... now also checks for leak of +file descriptors. Patch written by Richard Oudkerk.

    • +
    • bpo-25260: Fix python -m test --coverage on Windows. Remove the list +of ignored directories.

    • +
    • PCbuild\rt.bat now accepts an unlimited number of arguments to pass +along to regrtest.py. Previously there was a limit of 9.

    • +
    • bpo-26583: Skip test_timestamp_overflow in test_import if bytecode files +cannot be written.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-21277: Don’t try to link _ctypes with a ffi_convenience library.

    • +
    • bpo-26884: Fix linking extension modules for cross builds. Patch by Xavier +de Gaye.

    • +
    • bpo-26932: Fixed support of RTLD_* constants defined as enum values, not +via macros (in particular on Android). Patch by Chi Hsuan Yen.

    • +
    • bpo-22359: Disable the rules for running _freeze_importlib and pgen when +cross-compiling. The output of these programs is normally saved with the +source code anyway, and is still regenerated when doing a native build. +Patch by Xavier de Gaye.

    • +
    • bpo-21668: Link audioop, _datetime, _ctypes_test modules to libm, except +on Mac OS X. Patch written by Chi Hsuan Yen.

    • +
    • bpo-25702: A –with-lto configure option has been added that will enable +link time optimizations at build time during a make profile-opt. Some +compilers and toolchains are known to not produce stable code when using +LTO, be sure to test things thoroughly before relying on it. It can +provide a few % speed up over profile-opt alone.

    • +
    • bpo-26624: Adds validation of ucrtbase[d].dll version with warning for old +versions.

    • +
    • bpo-17603: Avoid error about nonexistant fileblocks.o file by using a +lower-level check for st_blocks in struct stat.

    • +
    • bpo-26079: Fixing the build output folder for tix-8.4.3.6. Patch by Bjoern +Thiel.

    • +
    • bpo-26465: Update Windows builds to use OpenSSL 1.0.2g.

    • +
    • bpo-25348: Added --pgo and --pgo-job arguments to +PCbuild\build.bat for building with Profile-Guided Optimization. The +old PCbuild\build_pgo.bat script is removed.

    • +
    • bpo-25827: Add support for building with ICC to configure, including a +new --with-icc flag.

    • +
    • bpo-25696: Fix installation of Python on UNIX with make -j9.

    • +
    • bpo-24986: It is now possible to build Python on Windows without errors +when external libraries are not available.

    • +
    • bpo-24421: Compile Modules/_math.c once, before building extensions. +Previously it could fail to compile properly if the math and cmath builds +were concurrent.

    • +
    • bpo-26465: Update OS X 10.5+ 32-bit-only installer to build and link with +OpenSSL 1.0.2g.

    • +
    • bpo-26268: Update Windows builds to use OpenSSL 1.0.2f.

    • +
    • bpo-25136: Support Apple Xcode 7’s new textual SDK stub libraries.

    • +
    • bpo-24324: Do not enable unreachable code warnings when using gcc as the +option does not work correctly in older versions of gcc and has been +silently removed as of gcc-4.5.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-27053: Updates make_zip.py to correctly generate library ZIP file.

    • +
    • bpo-26268: Update the prepare_ssl.py script to handle OpenSSL releases +that don’t include the contents of the include directory (that is, 1.0.2e +and later).

    • +
    • bpo-26071: bdist_wininst created binaries fail to start and find 32bit +Python

    • +
    • bpo-26073: Update the list of magic numbers in launcher

    • +
    • bpo-26065: Excludes venv from library when generating embeddable distro.

    • +
    • bpo-25022: Removed very outdated PC/example_nt/ directory.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-26799: Fix python-gdb.py: don’t get C types once when the Python code +is loaded, but get C types on demand. The C types can change if +python-gdb.py is loaded before the Python executable. Patch written by +Thomas Ilsche.

    • +
    • bpo-26271: Fix the Freeze tool to properly use flags passed through +configure. Patch by Daniel Shaulov.

    • +
    • bpo-26489: Add dictionary unpacking support to Tools/parser/unparse.py. +Patch by Guo Ci Teo.

    • +
    • bpo-26316: Fix variable name typo in Argument Clinic.

    • +
    • bpo-25440: Fix output of python-config –extension-suffix.

    • +
    • bpo-25154: The pyvenv script has been deprecated in favour of python3 -m +venv.

    • +
    +
    +
    +

    C API

    +
      +
    • bpo-26312: SystemError is now raised in all programming bugs with using +PyArg_ParseTupleAndKeywords(). RuntimeError did raised before in some +programming bugs.

    • +
    • bpo-26198: ValueError is now raised instead of TypeError on buffer +overflow in parsing “es#” and “et#” format units. SystemError is now +raised instead of TypeError on programmatical error in parsing format +string.

    • +
    +
    +
    +
    +

    Python 3.5.5 final

    +

    Release date: 2018-02-04

    +

    There were no new changes in version 3.5.5.

    +
    +
    +

    Python 3.5.5 release candidate 1

    +

    Release date: 2018-01-23

    +
    +

    Security

    +
      +
    • bpo-32551: The sys.path[0] initialization change for bpo-29139 caused +a regression by revealing an inconsistency in how sys.path is initialized +when executing __main__ from a zipfile, directory, or other import +location. This is considered a potential security issue, as it may lead to +privileged processes unexpectedly loading code from user controlled +directories in situations where that was not previously the case.

      +

      The interpreter now consistently avoids ever adding the import location’s +parent directory to sys.path, and ensures no other sys.path +entries are inadvertently modified when inserting the import location +named on the command line. (Originally reported as bpo-29723 against +Python 3.6rc1, but it was missed at the time that the then upcoming Python +3.5.4 release would also be affected)

      +
    • +
    • bpo-30657: Fixed possible integer overflow in PyBytes_DecodeEscape, +CVE-2017-1000158. Original patch by Jay Bosamiya; rebased to Python 3 by +Miro Hrončok.

    • +
    • bpo-30947: Upgrade libexpat embedded copy from version 2.2.1 to 2.2.3 to +get security fixes.

    • +
    +
    +
    +

    Core and Builtins

    +
      +
    • bpo-31095: Fix potential crash during GC caused by tp_dealloc which +doesn’t call PyObject_GC_UnTrack().

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-32072: Fixed issues with binary plists:

      +
        +
      • Fixed saving bytearrays.

      • +
      • Identical objects will be saved only once.

      • +
      • Equal references will be load as identical objects.

      • +
      • Added support for saving and loading recursive data structures.

      • +
      +
    • +
    • bpo-31170: expat: Update libexpat from 2.2.3 to 2.2.4. Fix copying of +partial characters for UTF-8 input (libexpat bug 115): +https://github.com/libexpat/libexpat/issues/115

    • +
    +
    +
    +
    +

    Python 3.5.4 final

    +

    Release date: 2017-08-07

    +
    +

    Library

    +
      +
    • bpo-30119: ftplib.FTP.putline() now throws ValueError on commands that +contains CR or LF. Patch by Dong-hee Na.

    • +
    +
    +
    +
    +

    Python 3.5.4 release candidate 1

    +

    Release date: 2017-07-23

    +
    +

    Security

    +
      +
    • bpo-30730: Prevent environment variables injection in subprocess on +Windows. Prevent passing other environment variables and command +arguments.

    • +
    • bpo-30694: Upgrade expat copy from 2.2.0 to 2.2.1 to get fixes of multiple +security vulnerabilities including: CVE-2017-9233 (External entity +infinite loop DoS), CVE-2016-9063 (Integer overflow, re-fix), +CVE-2016-0718 (Fix regression bugs from 2.2.0’s fix to CVE-2016-0718) and +CVE-2012-0876 (Counter hash flooding with SipHash). Note: the +CVE-2016-5300 (Use os-specific entropy sources like getrandom) doesn’t +impact Python, since Python already gets entropy from the OS to set the +expat secret using XML_SetHashSalt().

    • +
    • bpo-30500: Fix urllib.parse.splithost() to correctly parse fragments. For +example, splithost('//127.0.0.1#@evil.com/') now correctly returns the +127.0.0.1 host, instead of treating @evil.com as the host in an +authentication (login@host).

    • +
    • bpo-29591: Update expat copy from 2.1.1 to 2.2.0 to get fixes of +CVE-2016-0718 and CVE-2016-4472. See +https://sourceforge.net/p/expat/bugs/537/ for more information.

    • +
    +
    +
    +

    Core and Builtins

    +
      +
    • bpo-30876: Relative import from unloaded package now reimports the package +instead of failing with SystemError. Relative import from non-package now +fails with ImportError rather than SystemError.

    • +
    • bpo-30765: Avoid blocking in pthread_mutex_lock() when +PyThread_acquire_lock() is asked not to block.

    • +
    • bpo-27945: Fixed various segfaults with dict when input collections are +mutated during searching, inserting or comparing. Based on patches by +Duane Griffin and Tim Mitchell.

    • +
    • bpo-25794: Fixed type.__setattr__() and type.__delattr__() for +non-interned attribute names. Based on patch by Eryk Sun.

    • +
    • bpo-29935: Fixed error messages in the index() method of tuple, list and +deque when pass indices of wrong type.

    • +
    • bpo-28876: bool(range) works even if len(range) raises +OverflowError.

    • +
    • bpo-29600: Fix wrapping coroutine return values in StopIteration.

    • +
    • bpo-29537: Restore runtime compatibility with bytecode files generated by +CPython 3.5.0 to 3.5.2, and adjust the eval loop to avoid the problems +that could be caused by the malformed variant of the +BUILD_MAP_UNPACK_WITH_CALL opcode that they may contain. Patch by Petr +Viktorin, Serhiy Storchaka, and Nick Coghlan.

    • +
    • bpo-28598: Support __rmod__ for subclasses of str being called before +str.__mod__. Patch by Martijn Pieters.

    • +
    • bpo-29602: Fix incorrect handling of signed zeros in complex constructor +for complex subclasses and for inputs having a __complex__ method. Patch +by Serhiy Storchaka.

    • +
    • bpo-29347: Fixed possibly dereferencing undefined pointers when creating +weakref objects.

    • +
    • bpo-29438: Fixed use-after-free problem in key sharing dict.

    • +
    • bpo-29319: Prevent RunMainFromImporter overwriting sys.path[0].

    • +
    • bpo-29337: Fixed possible BytesWarning when compare the code objects. +Warnings could be emitted at compile time.

    • +
    • bpo-29478: If max_line_length=None is specified while using the Compat32 +policy, it is no longer ignored. Patch by Mircea Cosbuc.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-29403: Fix unittest.mock’s autospec to not fail on method-bound +builtin functions. Patch by Aaron Gallagher.

    • +
    • bpo-30961: Fix decrementing a borrowed reference in tracemalloc.

    • +
    • bpo-30886: Fix multiprocessing.Queue.join_thread(): it now waits until the +thread completes, even if the thread was started by the same process which +created the queue.

    • +
    • bpo-29854: Fix segfault in readline when using readline’s history-size +option. Patch by Nir Soffer.

    • +
    • bpo-30807: signal.setitimer() may disable the timer when passed a tiny +value.

      +

      Tiny values (such as 1e-6) are valid non-zero values for setitimer(), +which is specified as taking microsecond-resolution intervals. However, on +some platform, our conversion routine could convert 1e-6 into a zero +interval, therefore disabling the timer instead of (re-)scheduling it.

      +
    • +
    • bpo-30441: Fix bug when modifying os.environ while iterating over it

    • +
    • bpo-30532: Fix email header value parser dropping folding white space in +certain cases.

    • +
    • bpo-29169: Update zlib to 1.2.11.

    • +
    • bpo-30879: os.listdir() and os.scandir() now emit bytes names when called +with bytes-like argument.

    • +
    • bpo-30746: Prohibited the ‘=’ character in environment variable names in +os.putenv() and os.spawn*().

    • +
    • bpo-29755: Fixed the lgettext() family of functions in the gettext module. +They now always return bytes.

    • +
    • bpo-30645: Fix path calculation in imp.load_package(), fixing it for cases +when a package is only shipped with bytecodes. Patch by Alexandru +Ardelean.

    • +
    • bpo-23890: unittest.TestCase.assertRaises() now manually breaks a +reference cycle to not keep objects alive longer than expected.

    • +
    • bpo-30149: inspect.signature() now supports callables with +variable-argument parameters wrapped with partialmethod. Patch by Dong-hee +Na.

    • +
    • bpo-29931: Fixed comparison check for ipaddress.ip_interface objects. +Patch by Sanjay Sundaresan.

    • +
    • bpo-24484: Avoid race condition in multiprocessing cleanup.

    • +
    • bpo-28994: The traceback no longer displayed for SystemExit raised in a +callback registered by atexit.

    • +
    • bpo-30508: Don’t log exceptions if Task/Future “cancel()” method was +called.

    • +
    • bpo-28556: Updates to typing module: Add generic AsyncContextManager, add +support for ContextManager on all versions. Original PRs by Jelle Zijlstra +and Ivan Levkivskyi

    • +
    • bpo-29870: Fix ssl sockets leaks when connection is aborted in asyncio/ssl +implementation. Patch by Michaël Sghaïer.

    • +
    • bpo-29743: Closing transport during handshake process leaks open socket. +Patch by Nikolay Kim

    • +
    • bpo-27585: Fix waiter cancellation in asyncio.Lock. Patch by Mathieu +Sornay.

    • +
    • bpo-30418: On Windows, subprocess.Popen.communicate() now also ignore +EINVAL on stdin.write() if the child process is still running but closed +the pipe.

    • +
    • bpo-30378: Fix the problem that logging.handlers.SysLogHandler cannot +handle IPv6 addresses.

    • +
    • bpo-29960: Preserve generator state when _random.Random.setstate() raises +an exception. Patch by Bryan Olson.

    • +
    • bpo-30414: multiprocessing.Queue._feed background running thread do not +break from main loop on exception.

    • +
    • bpo-30003: Fix handling escape characters in HZ codec. Based on patch by +Ma Lin.

    • +
    • bpo-30301: Fix AttributeError when using SimpleQueue.empty() under spawn +and forkserver start methods.

    • +
    • bpo-30329: imaplib and poplib now catch the Windows socket WSAEINVAL error +(code 10022) on shutdown(SHUT_RDWR): An invalid operation was attempted. +This error occurs sometimes on SSL connections.

    • +
    • bpo-30375: Warnings emitted when compile a regular expression now always +point to the line in the user code. Previously they could point into +inners of the re module if emitted from inside of groups or conditionals.

    • +
    • bpo-30048: Fixed Task.cancel() can be ignored when the task is running +coroutine and the coroutine returned without any more await.

    • +
    • bpo-29990: Fix range checking in GB18030 decoder. Original patch by Ma +Lin.

    • +
    • bpo-26293: Change resulted because of zipfile breakage. (See also: +bpo-29094)

    • +
    • bpo-30243: Removed the __init__ methods of _json’s scanner and encoder. +Misusing them could cause memory leaks or crashes. Now scanner and +encoder objects are completely initialized in the __new__ methods.

    • +
    • bpo-30185: Avoid KeyboardInterrupt tracebacks in forkserver helper process +when Ctrl-C is received.

    • +
    • bpo-28556: Various updates to typing module: add typing.NoReturn type, use +WrapperDescriptorType, minor bug-fixes. Original PRs by Jim +Fasarakis-Hilliard and Ivan Levkivskyi.

    • +
    • bpo-30205: Fix getsockname() for unbound AF_UNIX sockets on Linux.

    • +
    • bpo-30070: Fixed leaks and crashes in errors handling in the parser +module.

    • +
    • bpo-30061: Fixed crashes in IOBase methods __next__() and readlines() when +readline() or __next__() respectively return non-sizeable object. Fixed +possible other errors caused by not checking results of PyObject_Size(), +PySequence_Size(), or PyMapping_Size().

    • +
    • bpo-30068: _io._IOBase.readlines will check if it’s closed first when hint +is present.

    • +
    • bpo-29694: Fixed race condition in pathlib mkdir with flags parents=True. +Patch by Armin Rigo.

    • +
    • bpo-29692: Fixed arbitrary unchaining of RuntimeError exceptions in +contextlib.contextmanager. Patch by Siddharth Velankar.

    • +
    • bpo-29998: Pickling and copying ImportError now preserves name and path +attributes.

    • +
    • bpo-29942: Fix a crash in itertools.chain.from_iterable when encountering +long runs of empty iterables.

    • +
    • bpo-27863: Fixed multiple crashes in ElementTree caused by race conditions +and wrong types.

    • +
    • bpo-28699: Fixed a bug in pools in multiprocessing.pool that raising an +exception at the very first of an iterable may swallow the exception or +make the program hang. Patch by Davin Potts and Xiang Zhang.

    • +
    • bpo-25803: Avoid incorrect errors raised by Path.mkdir(exist_ok=True) when +the OS gives priority to errors such as EACCES over EEXIST.

    • +
    • bpo-29861: Release references to tasks, their arguments and their results +as soon as they are finished in multiprocessing.Pool.

    • +
    • bpo-29884: faulthandler: Restore the old sigaltstack during teardown. +Patch by Christophe Zeitouny.

    • +
    • bpo-25455: Fixed crashes in repr of recursive buffered file-like objects.

    • +
    • bpo-29800: Fix crashes in partial.__repr__ if the keys of partial.keywords +are not strings. Patch by Michael Seifert.

    • +
    • bpo-29742: get_extra_info() raises exception if get called on closed ssl +transport. Patch by Nikolay Kim.

    • +
    • bpo-8256: Fixed possible failing or crashing input() if attributes +“encoding” or “errors” of sys.stdin or sys.stdout are not set or are not +strings.

    • +
    • bpo-28298: Fix a bug that prevented array ‘Q’, ‘L’ and ‘I’ from accepting +big intables (objects that have __int__) as elements. Patch by Oren +Milman.

    • +
    • bpo-29615: SimpleXMLRPCDispatcher no longer chains KeyError (or any other +exception) to exception(s) raised in the dispatched methods. Patch by Petr +Motejlek.

    • +
    • bpo-29704: asyncio.subprocess.SubprocessStreamProtocol no longer closes +before all pipes are closed.

    • +
    • bpo-29703: Fix asyncio to support instantiation of new event loops in +child processes.

    • +
    • bpo-29376: Fix assertion error in threading._DummyThread.is_alive().

    • +
    • bpo-29110: Fix file object leak in aifc.open() when file is given as a +filesystem path and is not in valid AIFF format. Patch by Anthony Zhang.

    • +
    • bpo-28961: Fix unittest.mock._Call helper: don’t ignore the name parameter +anymore. Patch written by Jiajun Huang.

    • +
    • bpo-29532: Altering a kwarg dictionary passed to functools.partial() no +longer affects a partial object after creation.

    • +
    • bpo-28556: Various updates to typing module: typing.Counter, +typing.ChainMap, improved ABC caching, etc. Original PRs by Jelle +Zijlstra, Ivan Levkivskyi, Manuel Krebber, and Łukasz Langa.

    • +
    • bpo-29100: Fix datetime.fromtimestamp() regression introduced in Python +3.6.0: check minimum and maximum years.

    • +
    • bpo-29519: Fix weakref spewing exceptions during interpreter shutdown when +used with a rare combination of multiprocessing and custom codecs.

    • +
    • bpo-29416: Prevent infinite loop in pathlib.Path.mkdir

    • +
    • bpo-29444: Fixed out-of-bounds buffer access in the group() method of the +match object. Based on patch by WGH.

    • +
    • bpo-29335: Fix subprocess.Popen.wait() when the child process has exited +to a stopped instead of terminated state (ex: when under ptrace).

    • +
    • bpo-29290: Fix a regression in argparse that help messages would wrap at +non-breaking spaces.

    • +
    • bpo-28735: Fixed the comparison of mock.MagickMock with mock.ANY.

    • +
    • bpo-29011: Fix an important omission by adding Deque to the typing module.

    • +
    • bpo-29219: Fixed infinite recursion in the repr of uninitialized +ctypes.CDLL instances.

    • +
    • bpo-28969: Fixed race condition in C implementation of +functools.lru_cache. KeyError could be raised when cached function with +full cache was simultaneously called from differen threads with the same +uncached arguments.

    • +
    • bpo-29142: In urllib.request, suffixes in no_proxy environment variable +with leading dots could match related hostnames again (e.g. .b.c matches +a.b.c). Patch by Milan Oberkirch.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-30176: Add missing attribute related constants in curses +documentation.

    • +
    • bpo-26985: Add missing info of code object in inspect documentation.

    • +
    • bpo-28929: Link the documentation to its source file on GitHub.

    • +
    • bpo-25008: Document smtpd.py as effectively deprecated and add a pointer +to aiosmtpd, a third-party asyncio-based replacement.

    • +
    • bpo-26355: Add canonical header link on each page to corresponding major +version of the documentation. Patch by Matthias Bussonnier.

    • +
    • bpo-29349: Fix Python 2 syntax in code for building the documentation.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-30822: Fix regrtest command line parser to allow passing -u +extralargefile to run test_zipfile64.

    • +
    • bpo-30383: regrtest: Enhance regrtest and backport features from the +master branch.

      +

      Add options: –coverage, –testdir, –list-tests (list test files, don’t +run them), –list-cases (list test identifiers, don’t run them, +bpo-30523), –matchfile (load a list of test filters from a text +file, bpo-30540), –slowest (alias to –slow).

      +

      Enhance output: add timestamp, test result, currently running tests, +“Tests result: xxx” summary with total duration, etc.

      +

      Fix reference leak hunting in regrtest, –huntrleaks: regrtest now warms +up caches, create explicitly all internal singletons which are created on +demand to prevent false positives when checking for reference leaks. +(bpo-30675).

      +
    • +
    • bpo-30357: test_thread: setUp() now uses support.threading_setup() and +support.threading_cleanup() to wait until threads complete to avoid random +side effects on following tests. Initial patch written by Grzegorz +Grzywacz.

    • +
    • bpo-28087: Skip test_asyncore and test_eintr poll failures on macOS. Skip +some tests of select.poll when running on macOS due to unresolved issues +with the underlying system poll function on some macOS versions.

    • +
    • bpo-30197: Enhanced functions swap_attr() and swap_item() in the +test.support module. They now work when delete replaced attribute or item +inside the with statement. The old value of the attribute or item (or +None if it doesn’t exist) now will be assigned to the target of the “as” +clause, if there is one.

    • +
    • bpo-29571: to match the behaviour of the re.LOCALE flag, +test_re.test_locale_flag now uses locale.getpreferredencoding(False) +to determine the candidate encoding for the test regex (allowing it to +correctly skip the test when the default locale encoding is a multi-byte +encoding)

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-29243: Prevent unnecessary rebuilding of Python during make test, +make install and some other make targets when configured with +--enable-optimizations.

    • +
    • bpo-23404: Don’t regenerate generated files based on file modification +time anymore: the action is now explicit. Replace make touch with +make regen-all.

    • +
    • bpo-29643: Fix --enable-optimization didn’t work.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-30687: Locate msbuild.exe on Windows when building rather than +vcvarsall.bat

    • +
    • bpo-29392: Prevent crash when passing invalid arguments into msvcrt +module.

    • +
    +
    +
    +

    C API

    +
      +
    • bpo-27867: Function PySlice_GetIndicesEx() is replaced with a macro if +Py_LIMITED_API is set to the value between 0x03050400 and 0x03060000 (not +including) or 0x03060100 or higher.

    • +
    • bpo-29083: Fixed the declaration of some public API functions. +PyArg_VaParse() and PyArg_VaParseTupleAndKeywords() were not available in +limited API. PyArg_ValidateKeywordArguments(), PyArg_UnpackTuple() and +Py_BuildValue() were not available in limited API of version < 3.3 when +PY_SSIZE_T_CLEAN is defined.

    • +
    +
    +
    +
    +

    Python 3.5.3 final

    +

    Release date: 2017-01-17

    +

    There were no code changes between 3.5.3rc1 and 3.5.3 final.

    +
    +
    +

    Python 3.5.3 release candidate 1

    +

    Release date: 2017-01-02

    +
    +

    Core and Builtins

    +
      +
    • bpo-29073: bytearray formatting no longer truncates on first null byte.

    • +
    • bpo-28932: Do not include <sys/random.h> if it does not exist.

    • +
    • bpo-28147: Fix a memory leak in split-table dictionaries: setattr() must +not convert combined table into split table.

    • +
    • bpo-25677: Correct the positioning of the syntax error caret for indented +blocks. Based on patch by Michael Layzell.

    • +
    • bpo-29000: Fixed bytes formatting of octals with zero padding in alternate +form.

    • +
    • bpo-28512: Fixed setting the offset attribute of SyntaxError by +PyErr_SyntaxLocationEx() and PyErr_SyntaxLocationObject().

    • +
    • bpo-28991: functools.lru_cache() was susceptible to an obscure reentrancy +bug caused by a monkey-patched len() function.

    • +
    • bpo-28648: Fixed crash in Py_DecodeLocale() in debug build on Mac OS X +when decode astral characters. Patch by Xiang Zhang.

    • +
    • bpo-19398: Extra slash no longer added to sys.path components in case of +empty compile-time PYTHONPATH components.

    • +
    • bpo-28426: Fixed potential crash in PyUnicode_AsDecodedObject() in debug +build.

    • +
    • bpo-23782: Fixed possible memory leak in _PyTraceback_Add() and exception +loss in PyTraceBack_Here().

    • +
    • bpo-28379: Added sanity checks and tests for PyUnicode_CopyCharacters(). +Patch by Xiang Zhang.

    • +
    • bpo-28376: The type of long range iterator is now registered as Iterator. +Patch by Oren Milman.

    • +
    • bpo-28376: The constructor of range_iterator now checks that step is not +0. Patch by Oren Milman.

    • +
    • bpo-26906: Resolving special methods of uninitialized type now causes +implicit initialization of the type instead of a fail.

    • +
    • bpo-18287: PyType_Ready() now checks that tp_name is not NULL. Original +patch by Niklas Koep.

    • +
    • bpo-24098: Fixed possible crash when AST is changed in process of +compiling it.

    • +
    • bpo-28350: String constants with null character no longer interned.

    • +
    • bpo-26617: Fix crash when GC runs during weakref callbacks.

    • +
    • bpo-27942: String constants now interned recursively in tuples and +frozensets.

    • +
    • bpo-21578: Fixed misleading error message when ImportError called with +invalid keyword args.

    • +
    • bpo-28203: Fix incorrect type in error message from complex(1.0, +{2:3}). Patch by Soumya Sharma.

    • +
    • bpo-27955: Fallback on reading /dev/urandom device when the getrandom() +syscall fails with EPERM, for example when blocked by SECCOMP.

    • +
    • bpo-28131: Fix a regression in zipimport’s compile_source(). zipimport +should use the same optimization level as the interpreter.

    • +
    • bpo-25221: Fix corrupted result from PyLong_FromLong(0) when Python is +compiled with NSMALLPOSINTS = 0.

    • +
    • bpo-25758: Prevents zipimport from unnecessarily encoding a filename +(patch by Eryk Sun)

    • +
    • bpo-28189: dictitems_contains no longer swallows compare errors. (Patch by +Xiang Zhang)

    • +
    • bpo-27812: Properly clear out a generator’s frame’s backreference to the +generator to prevent crashes in frame.clear().

    • +
    • bpo-27811: Fix a crash when a coroutine that has not been awaited is +finalized with warnings-as-errors enabled.

    • +
    • bpo-27587: Fix another issue found by PVS-Studio: Null pointer check after +use of ‘def’ in _PyState_AddModule(). Initial patch by Christian Heimes.

    • +
    • bpo-26020: set literal evaluation order did not match documented +behaviour.

    • +
    • bpo-27782: Multi-phase extension module import now correctly allows the +m_methods field to be used to add module level functions to instances +of non-module types returned from Py_create_mod. Patch by Xiang Zhang.

    • +
    • bpo-27936: The round() function accepted a second None argument for some +types but not for others. Fixed the inconsistency by accepting None for +all numeric types.

    • +
    • bpo-27487: Warn if a submodule argument to “python -m” or +runpy.run_module() is found in sys.modules after parent packages are +imported, but before the submodule is executed.

    • +
    • bpo-27558: Fix a SystemError in the implementation of “raise” statement. +In a brand new thread, raise a RuntimeError since there is no active +exception to reraise. Patch written by Xiang Zhang.

    • +
    • bpo-27419: Standard __import__() no longer look up “__import__” in globals +or builtins for importing submodules or “from import”. Fixed handling an +error of non-string package name.

    • +
    • bpo-27083: Respect the PYTHONCASEOK environment variable under Windows.

    • +
    • bpo-27514: Make having too many statically nested blocks a SyntaxError +instead of SystemError.

    • +
    • bpo-27473: Fixed possible integer overflow in bytes and bytearray +concatenations. Patch by Xiang Zhang.

    • +
    • bpo-27507: Add integer overflow check in bytearray.extend(). Patch by +Xiang Zhang.

    • +
    • bpo-27581: Don’t rely on wrapping for overflow check in +PySequence_Tuple(). Patch by Xiang Zhang.

    • +
    • bpo-27443: __length_hint__() of bytearray iterators no longer return a +negative integer for a resized bytearray.

    • +
    • bpo-27942: Fix memory leak in codeobject.c

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-15812: inspect.getframeinfo() now correctly shows the first line of a +context. Patch by Sam Breese.

    • +
    • bpo-29094: Offsets in a ZIP file created with extern file object and modes +“w” and “x” now are relative to the start of the file.

    • +
    • bpo-13051: Fixed recursion errors in large or resized +curses.textpad.Textbox. Based on patch by Tycho Andersen.

    • +
    • bpo-29119: Fix weakrefs in the pure python version of +collections.OrderedDict move_to_end() method. Contributed by Andra +Bogildea.

    • +
    • bpo-9770: curses.ascii predicates now work correctly with negative +integers.

    • +
    • bpo-28427: old keys should not remove new values from WeakValueDictionary +when collecting from another thread.

    • +
    • bpo-28923: Remove editor artifacts from Tix.py.

    • +
    • bpo-28871: Fixed a crash when deallocate deep ElementTree.

    • +
    • bpo-19542: Fix bugs in WeakValueDictionary.setdefault() and +WeakValueDictionary.pop() when a GC collection happens in another thread.

    • +
    • bpo-20191: Fixed a crash in resource.prlimit() when pass a sequence that +doesn’t own its elements as limits.

    • +
    • bpo-28779: multiprocessing.set_forkserver_preload() would crash the +forkserver process if a preloaded module instantiated some multiprocessing +objects such as locks.

    • +
    • bpo-28847: dbm.dumb now supports reading read-only files and no longer +writes the index file when it is not changed.

    • +
    • bpo-25659: In ctypes, prevent a crash calling the from_buffer() and +from_buffer_copy() methods on abstract classes like Array.

    • +
    • bpo-28732: Fix crash in os.spawnv() with no elements in args

    • +
    • bpo-28485: Always raise ValueError for negative +compileall.compile_dir(workers=…) parameter, even when multithreading is +unavailable.

    • +
    • bpo-28387: Fixed possible crash in _io.TextIOWrapper deallocator when the +garbage collector is invoked in other thread. Based on patch by Sebastian +Cufre.

    • +
    • bpo-27517: LZMA compressor and decompressor no longer raise exceptions if +given empty data twice. Patch by Benjamin Fogle.

    • +
    • bpo-28549: Fixed segfault in curses’s addch() with ncurses6.

    • +
    • bpo-28449: tarfile.open() with mode “r” or “r:” now tries to open a tar +file with compression before trying to open it without compression. +Otherwise it had 50% chance failed with ignore_zeros=True.

    • +
    • bpo-23262: The webbrowser module now supports Firefox 36+ and derived +browsers. Based on patch by Oleg Broytman.

    • +
    • bpo-27939: Fixed bugs in tkinter.ttk.LabeledScale and tkinter.Scale caused +by representing the scale as float value internally in Tk. tkinter.IntVar +now works if float value is set to underlying Tk variable.

    • +
    • bpo-28255: calendar.TextCalendar().prmonth() no longer prints a space at +the start of new line after printing a month’s calendar. Patch by Xiang +Zhang.

    • +
    • bpo-20491: The textwrap.TextWrapper class now honors non-breaking spaces. +Based on patch by Kaarle Ritvanen.

    • +
    • bpo-28353: os.fwalk() no longer fails on broken links.

    • +
    • bpo-25464: Fixed HList.header_exists() in tkinter.tix module by addin a +workaround to Tix library bug.

    • +
    • bpo-28488: shutil.make_archive() no longer add entry “./” to ZIP archive.

    • +
    • bpo-24452: Make webbrowser support Chrome on Mac OS X.

    • +
    • bpo-20766: Fix references leaked by pdb in the handling of SIGINT +handlers.

    • +
    • bpo-26293: Fixed writing ZIP files that starts not from the start of the +file. Offsets in ZIP file now are relative to the start of the archive in +conforming to the specification.

    • +
    • bpo-28321: Fixed writing non-BMP characters with binary format in +plistlib.

    • +
    • bpo-28322: Fixed possible crashes when unpickle itertools objects from +incorrect pickle data. Based on patch by John Leitch.

    • +
    • Fix possible integer overflows and crashes in the mmap module with unusual +usage patterns.

    • +
    • bpo-1703178: Fix the ability to pass the –link-objects option to the +distutils build_ext command.

    • +
    • bpo-28253: Fixed calendar functions for extreme months: 0001-01 and +9999-12.

      +

      Methods itermonthdays() and itermonthdays2() are reimplemented so that +they don’t call itermonthdates() which can cause datetime.date +under/overflow.

      +
    • +
    • bpo-28275: Fixed possible use after free in the decompress() methods of +the LZMADecompressor and BZ2Decompressor classes. Original patch by John +Leitch.

    • +
    • bpo-27897: Fixed possible crash in sqlite3.Connection.create_collation() +if pass invalid string-like object as a name. Patch by Xiang Zhang.

    • +
    • bpo-18893: Fix invalid exception handling in Lib/ctypes/macholib/dyld.py. +Patch by Madison May.

    • +
    • bpo-27611: Fixed support of default root window in the tkinter.tix module.

    • +
    • bpo-27348: In the traceback module, restore the formatting of exception +messages like “Exception: None”. This fixes a regression introduced in +3.5a2.

    • +
    • bpo-25651: Allow falsy values to be used for msg parameter of subTest().

    • +
    • bpo-27932: Prevent memory leak in win32_ver().

    • +
    • Fix UnboundLocalError in socket._sendfile_use_sendfile.

    • +
    • bpo-28075: Check for ERROR_ACCESS_DENIED in Windows implementation of +os.stat(). Patch by Eryk Sun.

    • +
    • bpo-25270: Prevent codecs.escape_encode() from raising SystemError when an +empty bytestring is passed.

    • +
    • bpo-28181: Get antigravity over HTTPS. Patch by Kaartic Sivaraam.

    • +
    • bpo-25895: Enable WebSocket URL schemes in urllib.parse.urljoin. Patch by +Gergely Imreh and Markus Holtermann.

    • +
    • bpo-27599: Fixed buffer overrun in binascii.b2a_qp() and +binascii.a2b_qp().

    • +
    • bpo-19003: m email.generator now replaces only \r and/or \n line +endings, per the RFC, instead of all unicode line endings.

    • +
    • bpo-28019: itertools.count() no longer rounds non-integer step in range +between 1.0 and 2.0 to 1.

    • +
    • bpo-25969: Update the lib2to3 grammar to handle the unpacking +generalizations added in 3.5.

    • +
    • bpo-14977: mailcap now respects the order of the lines in the mailcap +files (“first match”), as required by RFC 1542. Patch by Michael Lazar.

    • +
    • bpo-24594: Validates persist parameter when opening MSI database

    • +
    • bpo-17582: xml.etree.ElementTree nows preserves whitespaces in attributes +(Patch by Duane Griffin. Reviewed and approved by Stefan Behnel.)

    • +
    • bpo-28047: Fixed calculation of line length used for the base64 CTE in the +new email policies.

    • +
    • bpo-27445: Don’t pass str(_charset) to MIMEText.set_payload(). Patch by +Claude Paroz.

    • +
    • bpo-22450: urllib now includes an Accept: */* header among the default +headers. This makes the results of REST API requests more consistent and +predictable especially when proxy servers are involved.

    • +
    • lib2to3.pgen3.driver.load_grammar() now creates a stable cache file +between runs given the same Grammar.txt input regardless of the hash +randomization setting.

    • +
    • bpo-27570: Avoid zero-length memcpy() etc calls with null source pointers +in the “ctypes” and “array” modules.

    • +
    • bpo-22233: Break email header lines only on the RFC specified CR and LF +characters, not on arbitrary unicode line breaks. This also fixes a bug +in HTTP header parsing.

    • +
    • bpo-27988: Fix email iter_attachments incorrect mutation of payload list.

    • +
    • bpo-27691: Fix ssl module’s parsing of GEN_RID subject alternative name +fields in X.509 certs.

    • +
    • bpo-27850: Remove 3DES from ssl module’s default cipher list to counter +measure sweet32 attack (CVE-2016-2183).

    • +
    • bpo-27766: Add ChaCha20 Poly1305 to ssl module’s default cipher list. +(Required OpenSSL 1.1.0 or LibreSSL).

    • +
    • bpo-26470: Port ssl and hashlib module to OpenSSL 1.1.0.

    • +
    • Remove support for passing a file descriptor to os.access. It never worked +but previously didn’t raise.

    • +
    • bpo-12885: Fix error when distutils encounters symlink.

    • +
    • bpo-27881: Fixed possible bugs when setting +sqlite3.Connection.isolation_level. Based on patch by Xiang Zhang.

    • +
    • bpo-27861: Fixed a crash in sqlite3.Connection.cursor() when a factory +creates not a cursor. Patch by Xiang Zhang.

    • +
    • bpo-19884: Avoid spurious output on OS X with Gnu Readline.

    • +
    • bpo-27706: Restore deterministic behavior of random.Random().seed() for +string seeds using seeding version 1. Allows sequences of calls to +random() to exactly match those obtained in Python 2. Patch by Nofar +Schnider.

    • +
    • bpo-10513: Fix a regression in Connection.commit(). Statements should not +be reset after a commit.

    • +
    • A new version of typing.py from https://github.com/python/typing: +Collection (only for 3.6) (bpo-27598). Add FrozenSet to __all__ +(upstream #261). Fix crash in _get_type_vars() (upstream #259). Remove the +dict constraint in ForwardRef._eval_type (upstream #252).

    • +
    • bpo-27539: Fix unnormalised Fraction.__pow__ result in the case of +negative exponent and negative base.

    • +
    • bpo-21718: cursor.description is now available for queries using CTEs.

    • +
    • bpo-2466: posixpath.ismount now correctly recognizes mount points which +the user does not have permission to access.

    • +
    • bpo-27773: Correct some memory management errors server_hostname in +_ssl.wrap_socket().

    • +
    • bpo-26750: unittest.mock.create_autospec() now works properly for +subclasses of property() and other data descriptors.

    • +
    • In the curses module, raise an error if window.getstr() or window.instr() +is passed a negative value.

    • +
    • bpo-27783: Fix possible usage of uninitialized memory in +operator.methodcaller.

    • +
    • bpo-27774: Fix possible Py_DECREF on unowned object in _sre.

    • +
    • bpo-27760: Fix possible integer overflow in binascii.b2a_qp.

    • +
    • bpo-27758: Fix possible integer overflow in the _csv module for large +record lengths.

    • +
    • bpo-27568: Prevent HTTPoxy attack (CVE-2016-1000110). Ignore the +HTTP_PROXY variable when REQUEST_METHOD environment is set, which +indicates that the script is in CGI mode.

    • +
    • bpo-27656: Do not assume sched.h defines any SCHED_* constants.

    • +
    • bpo-27130: In the “zlib” module, fix handling of large buffers (typically +4 GiB) when compressing and decompressing. Previously, inputs were +limited to 4 GiB, and compression and decompression operations did not +properly handle results of 4 GiB.

    • +
    • bpo-27533: Release GIL in nt._isdir

    • +
    • bpo-17711: Fixed unpickling by the persistent ID with protocol 0. Original +patch by Alexandre Vassalotti.

    • +
    • bpo-27522: Avoid an unintentional reference cycle in email.feedparser.

    • +
    • bpo-26844: Fix error message for imp.find_module() to refer to ‘path’ +instead of ‘name’. Patch by Lev Maximov.

    • +
    • bpo-23804: Fix SSL zero-length recv() calls to not block and not raise an +error about unclean EOF.

    • +
    • bpo-27466: Change time format returned by http.cookie.time2netscape, +confirming the netscape cookie format and making it consistent with +documentation.

    • +
    • bpo-26664: Fix activate.fish by removing mis-use of $.

    • +
    • bpo-22115: Fixed tracing Tkinter variables: trace_vdelete() with wrong +mode no longer break tracing, trace_vinfo() now always returns a list of +pairs of strings, tracing in the “u” mode now works.

    • +
    • Fix a scoping issue in importlib.util.LazyLoader which triggered an +UnboundLocalError when lazy-loading a module that was already put into +sys.modules.

    • +
    • bpo-27079: Fixed curses.ascii functions isblank(), iscntrl() and +ispunct().

    • +
    • bpo-26754: Some functions (compile() etc) accepted a filename argument +encoded as an iterable of integers. Now only strings and byte-like objects +are accepted.

    • +
    • bpo-27048: Prevents distutils failing on Windows when environment +variables contain non-ASCII characters

    • +
    • bpo-27330: Fixed possible leaks in the ctypes module.

    • +
    • bpo-27238: Got rid of bare excepts in the turtle module. Original patch +by Jelle Zijlstra.

    • +
    • bpo-27122: When an exception is raised within the context being managed by +a contextlib.ExitStack() and one of the exit stack generators catches and +raises it in a chain, do not re-raise the original exception when exiting, +let the new chained one through. This avoids the PEP 479 bug described in +issue25782.

    • +
    +
    +
    +

    Security

    +
      +
    • bpo-27278: Fix os.urandom() implementation using getrandom() on Linux. +Truncate size to INT_MAX and loop until we collected enough random bytes, +instead of casting a directly Py_ssize_t to int.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-26386: Fixed ttk.TreeView selection operations with item id’s +containing spaces.

    • +
    +
    +
    +

    Security

    +
      +
    • bpo-22636: Avoid shell injection problems with ctypes.util.find_library().

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-16182: Fix various functions in the “readline” module to use the +locale encoding, and fix get_begidx() and get_endidx() to return code +point indexes.

    • +
    • bpo-27392: Add loop.connect_accepted_socket(). Patch by Jim Fulton.

    • +
    • bpo-27930: Improved behaviour of logging.handlers.QueueListener. Thanks to +Paulo Andrade and Petr Viktorin for the analysis and patch.

    • +
    • bpo-21201: Improves readability of multiprocessing error message. Thanks +to Wojciech Walczak for patch.

    • +
    • bpo-27456: asyncio: Set TCP_NODELAY by default.

    • +
    • bpo-27906: Fix socket accept exhaustion during high TCP traffic. Patch by +Kevin Conway.

    • +
    • bpo-28174: Handle when SO_REUSEPORT isn’t properly supported. Patch by +Seth Michael Larson.

    • +
    • bpo-26654: Inspect functools.partial in asyncio.Handle.__repr__. Patch by +iceboy.

    • +
    • bpo-26909: Fix slow pipes IO in asyncio. Patch by INADA Naoki.

    • +
    • bpo-28176: Fix callbacks race in asyncio.SelectorLoop.sock_connect.

    • +
    • bpo-27759: Fix selectors incorrectly retain invalid file descriptors. +Patch by Mark Williams.

    • +
    • bpo-28368: Refuse monitoring processes if the child watcher has no loop +attached. Patch by Vincent Michel.

    • +
    • bpo-28369: Raise RuntimeError when transport’s FD is used with add_reader, +add_writer, etc.

    • +
    • bpo-28370: Speedup asyncio.StreamReader.readexactly. Patch by Коренберг +Марк.

    • +
    • bpo-28371: Deprecate passing asyncio.Handles to run_in_executor.

    • +
    • bpo-28372: Fix asyncio to support formatting of non-python coroutines.

    • +
    • bpo-28399: Remove UNIX socket from FS before binding. Patch by Коренберг +Марк.

    • +
    • bpo-27972: Prohibit Tasks to await on themselves.

    • +
    • bpo-26923: Fix asyncio.Gather to refuse being cancelled once all children +are done. Patch by Johannes Ebke.

    • +
    • bpo-26796: Don’t configure the number of workers for default threadpool +executor. Initial patch by Hans Lawrenz.

    • +
    • bpo-28600: Optimize loop.call_soon().

    • +
    • bpo-28613: Fix get_event_loop() return the current loop if called from +coroutines/callbacks.

    • +
    • bpo-28639: Fix inspect.isawaitable to always return bool Patch by Justin +Mayfield.

    • +
    • bpo-28652: Make loop methods reject socket kinds they do not support.

    • +
    • bpo-28653: Fix a refleak in functools.lru_cache.

    • +
    • bpo-28703: Fix asyncio.iscoroutinefunction to handle Mock objects.

    • +
    • bpo-24142: Reading a corrupt config file left the parser in an invalid +state. Original patch by Florian Höch.

    • +
    • bpo-28990: Fix SSL hanging if connection is closed before handshake +completed. (Patch by HoHo-Ho)

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-15308: Add ‘interrupt execution’ (^C) to Shell menu. Patch by Roger +Serwy, updated by Bayard Randel.

    • +
    • bpo-27922: Stop IDLE tests from ‘flashing’ gui widgets on the screen.

    • +
    • Add version to title of IDLE help window.

    • +
    • bpo-25564: In section on IDLE – console differences, mention that using +exec means that __builtins__ is defined for each statement.

    • +
    • bpo-27714: text_textview and test_autocomplete now pass when re-run in the +same process. This occurs when test_idle fails when run with the -w +option but without -jn. Fix warning from test_config.

    • +
    • bpo-25507: IDLE no longer runs buggy code because of its tkinter imports. +Users must include the same imports required to run directly in Python.

    • +
    • bpo-27452: add line counter and crc to IDLE configHandler test dump.

    • +
    • bpo-27365: Allow non-ascii chars in IDLE NEWS.txt, for contributor names.

    • +
    • bpo-27245: IDLE: Cleanly delete custom themes and key bindings. +Previously, when IDLE was started from a console or by import, a cascade +of warnings was emitted. Patch by Serhiy Storchaka.

    • +
    +
    +
    +

    C API

    +
      +
    • bpo-28808: PyUnicode_CompareWithASCIIString() now never raises exceptions.

    • +
    • bpo-26754: PyUnicode_FSDecoder() accepted a filename argument encoded as +an iterable of integers. Now only strings and bytes-like objects are +accepted.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-28513: Documented command-line interface of zipfile.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-28950: Disallow -j0 to be combined with -T/-l/-M in regrtest command +line arguments.

    • +
    • bpo-28666: Now test.support.rmtree is able to remove unwritable or +unreadable directories.

    • +
    • bpo-23839: Various caches now are cleared before running every test file.

    • +
    • bpo-28409: regrtest: fix the parser of command line arguments.

    • +
    • bpo-27787: Call gc.collect() before checking each test for “dangling +threads”, since the dangling threads are weak references.

    • +
    • bpo-27369: In test_pyexpat, avoid testing an error message detail that +changed in Expat 2.2.0.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-27952: Get Tools/scripts/fixcid.py working with Python 3 and the +current “re” module, avoid invalid Python backslash escapes, and fix a bug +parsing escaped C quote signs.

    • +
    • bpo-27332: Fixed the type of the first argument of module-level functions +generated by Argument Clinic. Patch by Petr Viktorin.

    • +
    • bpo-27418: Fixed Tools/importbench/importbench.py.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-28251: Improvements to help manuals on Windows.

    • +
    • bpo-28110: launcher.msi has different product codes between 32-bit and +64-bit

    • +
    • bpo-25144: Ensures TargetDir is set before continuing with custom install.

    • +
    • bpo-27469: Adds a shell extension to the launcher so that drag and drop +works correctly.

    • +
    • bpo-27309: Enabled proper Windows styles in python[w].exe manifest.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-29080: Removes hard dependency on hg.exe from PCBuild/build.bat

    • +
    • bpo-23903: Added missed names to PC/python3.def.

    • +
    • bpo-10656: Fix out-of-tree building on AIX. Patch by Tristan Carel and +Michael Haubenwallner.

    • +
    • bpo-26359: Rename –with-optimiations to –enable-optimizations.

    • +
    • bpo-28444: Fix missing extensions modules when cross compiling.

    • +
    • bpo-28248: Update Windows build and OS X installers to use OpenSSL 1.0.2j.

    • +
    • bpo-28258: Fixed build with Estonian locale (python-config and distclean +targets in Makefile). Patch by Arfrever Frehtes Taifersar Arahesis.

    • +
    • bpo-26661: setup.py now detects system libffi with multiarch wrapper.

    • +
    • bpo-28066: Fix the logic that searches build directories for generated +include files when building outside the source tree.

    • +
    • bpo-15819: Remove redundant include search directory option for building +outside the source tree.

    • +
    • bpo-27566: Fix clean target in freeze makefile (patch by Lisa Roach)

    • +
    • bpo-27705: Update message in validate_ucrtbase.py

    • +
    • bpo-27983: Cause lack of llvm-profdata tool when using clang as required +for PGO linking to be a configure time error rather than make time when +–with-optimizations is enabled. Also improve our ability to find the +llvm-profdata tool on MacOS and some Linuxes.

    • +
    • bpo-26307: The profile-opt build now applies PGO to the built-in modules.

    • +
    • bpo-26359: Add the –with-optimizations configure flag.

    • +
    • bpo-27713: Suppress spurious build warnings when updating importlib’s +bootstrap files. Patch by Xiang Zhang

    • +
    • bpo-25825: Correct the references to Modules/python.exp and ld_so_aix, +which are required on AIX. This updates references to an installation +path that was changed in 3.2a4, and undoes changed references to the build +tree that were made in 3.5.0a1.

    • +
    • bpo-27453: CPP invocation in configure must use CPPFLAGS. Patch by Chi +Hsuan Yen.

    • +
    • bpo-27641: The configure script now inserts comments into the makefile to +prevent the pgen and _freeze_importlib executables from being +cross-compiled.

    • +
    • bpo-26662: Set PYTHON_FOR_GEN in configure as the Python program to be +used for file generation during the build.

    • +
    • bpo-10910: Avoid C++ compilation errors on FreeBSD and OS X. Also update +FreedBSD version checks for the original ctype UTF-8 workaround.

    • +
    • bpo-28676: Prevent missing ‘getentropy’ declaration warning on macOS. +Patch by Gareth Rees.

    • +
    +
    +
    +
    +

    Python 3.5.2 final

    +

    Release date: 2016-06-26

    +
    +

    Core and Builtins

    +
      +
    • bpo-26930: Update Windows builds to use OpenSSL 1.0.2h.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-26867: Ubuntu’s openssl OP_NO_SSLv3 is forced on by default; fix test.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-27365: Allow non-ascii in idlelib/NEWS.txt - minimal part for 3.5.2.

    • +
    +
    +
    +
    +

    Python 3.5.2 release candidate 1

    +

    Release date: 2016-06-12

    +
    +

    Core and Builtins

    +
      +
    • bpo-27066: Fixed SystemError if a custom opener (for open()) returns a +negative number without setting an exception.

    • +
    • bpo-20041: Fixed TypeError when frame.f_trace is set to None. Patch by +Xavier de Gaye.

    • +
    • bpo-26168: Fixed possible refleaks in failing Py_BuildValue() with the “N” +format unit.

    • +
    • bpo-26991: Fix possible refleak when creating a function with annotations.

    • +
    • bpo-27039: Fixed bytearray.remove() for values greater than 127. Patch by +Joe Jevnik.

    • +
    • bpo-23640: int.from_bytes() no longer bypasses constructors for +subclasses.

    • +
    • bpo-26811: gc.get_objects() no longer contains a broken tuple with NULL +pointer.

    • +
    • bpo-20120: Use RawConfigParser for .pypirc parsing, removing support for +interpolation unintentionally added with move to Python 3. Behavior no +longer does any interpolation in .pypirc files, matching behavior in +Python 2.7 and Setuptools 19.0.

    • +
    • bpo-26659: Make the builtin slice type support cycle collection.

    • +
    • bpo-26718: super.__init__ no longer leaks memory if called multiple times. +NOTE: A direct call of super.__init__ is not endorsed!

    • +
    • bpo-25339: PYTHONIOENCODING now has priority over locale in setting the +error handler for stdin and stdout.

    • +
    • bpo-26494: Fixed crash on iterating exhausting iterators. Affected classes +are generic sequence iterators, iterators of str, bytes, bytearray, list, +tuple, set, frozenset, dict, OrderedDict, corresponding views and +os.scandir() iterator.

    • +
    • bpo-26581: If coding cookie is specified multiple times on a line in +Python source code file, only the first one is taken to account.

    • +
    • bpo-26464: Fix str.translate() when string is ASCII and first replacements +removes character, but next replacement uses a non-ASCII character or a +string longer than 1 character. Regression introduced in Python 3.5.0.

    • +
    • bpo-22836: Ensure exception reports from PyErr_Display() and +PyErr_WriteUnraisable() are sensible even when formatting them produces +secondary errors. This affects the reports produced by +sys.__excepthook__() and when __del__() raises an exception.

    • +
    • bpo-26302: Correct behavior to reject comma as a legal character for +cookie names.

    • +
    • bpo-4806: Avoid masking the original TypeError exception when using star +(*) unpacking in function calls. Based on patch by Hagen Fürstenau +and Daniel Urban.

    • +
    • bpo-27138: Fix the doc comment for FileFinder.find_spec().

    • +
    • bpo-26154: Add a new private _PyThreadState_UncheckedGet() function to get +the current Python thread state, but don’t issue a fatal error if it is +NULL. This new function must be used instead of accessing directly the +_PyThreadState_Current variable. The variable is no more exposed since +Python 3.5.1 to hide the exact implementation of atomic C types, to avoid +compiler issues.

    • +
    • bpo-26194: Deque.insert() gave odd results for bounded deques that had +reached their maximum size. Now an IndexError will be raised when +attempting to insert into a full deque.

    • +
    • bpo-25843: When compiling code, don’t merge constants if they are equal +but have a different types. For example, f1, f2 = lambda: 1, lambda: +1.0 is now correctly compiled to two different functions: f1() +returns 1 (int) and f2() returns 1.0 (int), even if +1 and 1.0 are equal.

    • +
    • bpo-22995: [UPDATE] Comment out the one of the pickleability tests in +_PyObject_GetState() due to regressions observed in Cython-based projects.

    • +
    • bpo-25961: Disallowed null characters in the type name.

    • +
    • bpo-25973: Fix segfault when an invalid nonlocal statement binds a name +starting with two underscores.

    • +
    • bpo-22995: Instances of extension types with a state that aren’t +subclasses of list or dict and haven’t implemented any pickle-related +methods (__reduce__, __reduce_ex__, __getnewargs__, __getnewargs_ex__, or +__getstate__), can no longer be pickled. Including memoryview.

    • +
    • bpo-20440: Massive replacing unsafe attribute setting code with special +macro Py_SETREF.

    • +
    • bpo-25766: Special method __bytes__() now works in str subclasses.

    • +
    • bpo-25421: __sizeof__ methods of builtin types now use dynamic basic size. +This allows sys.getsize() to work correctly with their subclasses with +__slots__ defined.

    • +
    • bpo-25709: Fixed problem with in-place string concatenation and utf-8 +cache.

    • +
    • bpo-27147: Mention PEP 420 in the importlib docs.

    • +
    • bpo-24097: Fixed crash in object.__reduce__() if slot name is freed inside +__getattr__.

    • +
    • bpo-24731: Fixed crash on converting objects with special methods +__bytes__, __trunc__, and __float__ returning instances of subclasses of +bytes, int, and float to subclasses of bytes, int, and float +correspondingly.

    • +
    • bpo-26478: Fix semantic bugs when using binary operators with dictionary +views and tuples.

    • +
    • bpo-26171: Fix possible integer overflow and heap corruption in +zipimporter.get_data().

    • +
    • bpo-25660: Fix TAB key behaviour in REPL with readline.

    • +
    • bpo-25887: Raise a RuntimeError when a coroutine object is awaited more +than once.

    • +
    • bpo-27243: Update the __aiter__ protocol: instead of returning an +awaitable that resolves to an asynchronous iterator, the asynchronous +iterator should be returned directly. Doing the former will trigger a +PendingDeprecationWarning.

    • +
    +
    +
    +

    Security

    +
      +
    • bpo-26556: Update expat to 2.1.1, fixes CVE-2015-1283.

    • +
    • Fix TLS stripping vulnerability in smtplib, CVE-2016-0772. Reported by +Team Oststrom

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-21386: Implement missing IPv4Address.is_global property. It was +documented since 07a5610bae9d. Initial patch by Roger Luethi.

    • +
    • bpo-20900: distutils register command now decodes HTTP responses +correctly. Initial patch by ingrid.

    • +
    • A new version of typing.py provides several new classes and features: +@overload outside stubs, Reversible, DefaultDict, Text, ContextManager, +Type[], NewType(), TYPE_CHECKING, and numerous bug fixes (note that some +of the new features are not yet implemented in mypy or other static +analyzers). Also classes for PEP 492 (Awaitable, AsyncIterable, +AsyncIterator) have been added (in fact they made it into 3.5.1 but were +never mentioned).

    • +
    • bpo-25738: Stop http.server.BaseHTTPRequestHandler.send_error() from +sending a message body for 205 Reset Content. Also, don’t send Content +header fields in responses that don’t have a body. Patch by Susumu +Koshiba.

    • +
    • bpo-21313: Fix the “platform” module to tolerate when sys.version contains +truncated build information.

    • +
    +
    +
    +

    Security

    +
      +
    • bpo-26839: On Linux, os.urandom() now calls getrandom() with +GRND_NONBLOCK to fall back on reading /dev/urandom if the urandom +entropy pool is not initialized yet. Patch written by Colm Buckley.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-27164: In the zlib module, allow decompressing raw Deflate streams +with a predefined zdict. Based on patch by Xiang Zhang.

    • +
    • bpo-24291: Fix wsgiref.simple_server.WSGIRequestHandler to completely +write data to the client. Previously it could do partial writes and +truncate data. Also, wsgiref.handler.ServerHandler can now handle stdout +doing partial writes, but this is deprecated.

    • +
    • bpo-26809: Add __all__ to string. Patch by Emanuel Barry.

    • +
    • bpo-26373: subprocess.Popen.communicate now correctly ignores +BrokenPipeError when the child process dies before .communicate() is +called in more/all circumstances.

    • +
    • bpo-21776: distutils.upload now correctly handles HTTPError. Initial patch +by Claudiu Popa.

    • +
    • bpo-27114: Fix SSLContext._load_windows_store_certs fails with +PermissionError

    • +
    • bpo-18383: Avoid creating duplicate filters when using filterwarnings and +simplefilter. Based on patch by Alex Shkop.

    • +
    • bpo-27057: Fix os.set_inheritable() on Android, ioctl() is blocked by +SELinux and fails with EACCESS. The function now falls back to fcntl(). +Patch written by Michał Bednarski.

    • +
    • bpo-27014: Fix infinite recursion using typing.py. Thanks to Kalle Tuure!

    • +
    • bpo-14132: Fix urllib.request redirect handling when the target only has a +query string. Original fix by Ján Janech.

    • +
    • bpo-17214: The “urllib.request” module now percent-encodes non-ASCII bytes +found in redirect target URLs. Some servers send Location header fields +with non-ASCII bytes, but “http.client” requires the request target to be +ASCII-encodable, otherwise a UnicodeEncodeError is raised. Based on patch +by Christian Heimes.

    • +
    • bpo-26892: Honor debuglevel flag in urllib.request.HTTPHandler. Patch +contributed by Chi Hsuan Yen.

    • +
    • bpo-22274: In the subprocess module, allow stderr to be redirected to +stdout even when stdout is not redirected. Patch by Akira Li.

    • +
    • bpo-26807: mock_open ‘files’ no longer error on readline at end of file. +Patch from Yolanda Robla.

    • +
    • bpo-25745: Fixed leaking a userptr in curses panel destructor.

    • +
    • bpo-26977: Removed unnecessary, and ignored, call to sum of squares helper +in statistics.pvariance.

    • +
    • bpo-26881: The modulefinder module now supports extended opcode arguments.

    • +
    • bpo-23815: Fixed crashes related to directly created instances of types in +_tkinter and curses.panel modules.

    • +
    • bpo-17765: weakref.ref() no longer silently ignores keyword arguments. +Patch by Georg Brandl.

    • +
    • bpo-26873: xmlrpc now raises ResponseError on unsupported type tags +instead of silently return incorrect result.

    • +
    • bpo-26711: Fixed the comparison of plistlib.Data with other types.

    • +
    • bpo-24114: Fix an uninitialized variable in ctypes.util.

      +

      The bug only occurs on SunOS when the ctypes implementation searches for +the crle program. Patch by Xiang Zhang. Tested on SunOS by Kees Bos.

      +
    • +
    • bpo-26864: In urllib.request, change the proxy bypass host checking +against no_proxy to be case-insensitive, and to not match unrelated host +names that happen to have a bypassed hostname as a suffix. Patch by Xiang +Zhang.

    • +
    • bpo-26634: recursive_repr() now sets __qualname__ of wrapper. Patch by +Xiang Zhang.

    • +
    • bpo-26804: urllib.request will prefer lower_case proxy environment +variables over UPPER_CASE or Mixed_Case ones. Patch contributed by +Hans-Peter Jansen.

    • +
    • bpo-26837: assertSequenceEqual() now correctly outputs non-stringified +differing items (like bytes in the -b mode). This affects +assertListEqual() and assertTupleEqual().

    • +
    • bpo-26041: Remove “will be removed in Python 3.7” from deprecation +messages of platform.dist() and platform.linux_distribution(). Patch by +Kumaripaba Miyurusara Athukorala.

    • +
    • bpo-26822: itemgetter, attrgetter and methodcaller objects no longer +silently ignore keyword arguments.

    • +
    • bpo-26733: Disassembling a class now disassembles class and static +methods. Patch by Xiang Zhang.

    • +
    • bpo-26801: Fix error handling in shutil.get_terminal_size(), catch +AttributeError instead of NameError. Patch written by +Emanuel Barry.

    • +
    • bpo-24838: tarfile’s ustar and gnu formats now correctly calculate name +and link field limits for multibyte character encodings like utf-8.

    • +
    +
    +
    +

    Security

    +
      +
    • bpo-26657: Fix directory traversal vulnerability with http.server on +Windows. This fixes a regression that was introduced in 3.3.4rc1 and +3.4.0rc1. Based on patch by Philipp Hagemeister.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-26717: Stop encoding Latin-1-ized WSGI paths with UTF-8. Patch by +Anthony Sottile.

    • +
    • bpo-26735: Fix os.urandom() on Solaris 11.3 and newer when reading +more than 1,024 bytes: call getrandom() multiple times with a limit of +1024 bytes per call.

    • +
    • bpo-16329: Add .webm to mimetypes.types_map. Patch by Giampaolo Rodola’.

    • +
    • bpo-13952: Add .csv to mimetypes.types_map. Patch by Geoff Wilson.

    • +
    • bpo-26709: Fixed Y2038 problem in loading binary PLists.

    • +
    • bpo-23735: Handle terminal resizing with Readline 6.3+ by installing our +own SIGWINCH handler. Patch by Eric Price.

    • +
    • bpo-26586: In http.server, respond with “413 Request header fields too +large” if there are too many header fields to parse, rather than killing +the connection and raising an unhandled exception. Patch by Xiang Zhang.

    • +
    • bpo-22854: Change BufferedReader.writable() and BufferedWriter.readable() +to always return False.

    • +
    • bpo-25195: Fix a regression in mock.MagicMock. _Call is a subclass of +tuple (changeset 3603bae63c13 only works for classes) so we need to +implement __ne__ ourselves. Patch by Andrew Plummer.

    • +
    • bpo-26644: Raise ValueError rather than SystemError when a negative length +is passed to SSLSocket.recv() or read().

    • +
    • bpo-23804: Fix SSL recv(0) and read(0) methods to return zero bytes +instead of up to 1024.

    • +
    • bpo-26616: Fixed a bug in datetime.astimezone() method.

    • +
    • bpo-21925: warnings.formatwarning() now catches exceptions on +linecache.getline(...) to be able to log ResourceWarning +emitted late during the Python shutdown process.

    • +
    • bpo-24266: Ctrl+C during Readline history search now cancels the search +mode when compiled with Readline 7.

    • +
    • bpo-26560: Avoid potential ValueError in BaseHandler.start_response. +Initial patch by Peter Inglesby.

    • +
    +
    +
    +

    Security

    +
      +
    • bpo-26313: ssl.py _load_windows_store_certs fails if windows cert store is +empty. Patch by Baji.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-26569: Fix pyclbr.readmodule() and pyclbr.readmodule_ex() +to support importing packages.

    • +
    • bpo-26499: Account for remaining Content-Length in HTTPResponse.readline() +and read1(). Based on patch by Silent Ghost. Also document that +HTTPResponse now supports these methods.

    • +
    • bpo-25320: Handle sockets in directories unittest discovery is scanning. +Patch from Victor van den Elzen.

    • +
    • bpo-16181: cookiejar.http2time() now returns None if year is higher than +datetime.MAXYEAR.

    • +
    • bpo-26513: Fixes platform module detection of Windows Server

    • +
    • bpo-23718: Fixed parsing time in week 0 before Jan 1. Original patch by +Tamás Bence Gedai.

    • +
    • bpo-20589: Invoking Path.owner() and Path.group() on Windows now raise +NotImplementedError instead of ImportError.

    • +
    • bpo-26177: Fixed the keys() method for Canvas and Scrollbar widgets.

    • +
    • bpo-15068: Got rid of excessive buffering in the fileinput module. The +bufsize parameter is no longer used.

    • +
    • bpo-2202: Fix UnboundLocalError in +AbstractDigestAuthHandler.get_algorithm_impls. Initial patch by Mathieu +Dupuy.

    • +
    • bpo-25718: Fixed pickling and copying the accumulate() iterator with total +is None.

    • +
    • bpo-26475: Fixed debugging output for regular expressions with the (?x) +flag.

    • +
    • bpo-26457: Fixed the subnets() methods in IP network classes for the case +when resulting prefix length is equal to maximal prefix length. Based on +patch by Xiang Zhang.

    • +
    • bpo-26385: Remove the file if the internal open() call in +NamedTemporaryFile() fails. Patch by Silent Ghost.

    • +
    • bpo-26402: Fix XML-RPC client to retry when the server shuts down a +persistent connection. This was a regression related to the new +http.client.RemoteDisconnected exception in 3.5.0a4.

    • +
    • bpo-25913: Leading <~ is optional now in base64.a85decode() with +adobe=True. Patch by Swati Jaiswal.

    • +
    • bpo-26186: Remove an invalid type check in importlib.util.LazyLoader.

    • +
    • bpo-26367: importlib.__import__() raises SystemError like +builtins.__import__() when level is specified but without an +accompanying package specified.

    • +
    • bpo-26309: In the “socketserver” module, shut down the request (closing +the connected socket) when verify_request() returns false. Patch by Aviv +Palivoda.

    • +
    +
    +
    +

    Security

    +
      +
    • bpo-25939: On Windows open the cert store readonly in +ssl.enum_certificates.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-25995: os.walk() no longer uses FDs proportional to the tree depth.

    • +
    • bpo-26117: The os.scandir() iterator now closes file descriptor not only +when the iteration is finished, but when it was failed with error.

    • +
    • bpo-25911: Restored support of bytes paths in os.walk() on Windows.

    • +
    • bpo-26045: Add UTF-8 suggestion to error message when posting a +non-Latin-1 string with http.client.

    • +
    • bpo-12923: Reset FancyURLopener’s redirect counter even if there is an +exception. Based on patches by Brian Brazil and Daniel Rocco.

    • +
    • bpo-25945: Fixed a crash when unpickle the functools.partial object with +wrong state. Fixed a leak in failed functools.partial constructor. “args” +and “keywords” attributes of functools.partial have now always types tuple +and dict correspondingly.

    • +
    • bpo-26202: copy.deepcopy() now correctly copies range() objects with +non-atomic attributes.

    • +
    • bpo-23076: Path.glob() now raises a ValueError if it’s called with an +invalid pattern. Patch by Thomas Nyberg.

    • +
    • bpo-19883: Fixed possible integer overflows in zipimport.

    • +
    • bpo-26227: On Windows, getnameinfo(), gethostbyaddr() and +gethostbyname_ex() functions of the socket module now decode the hostname +from the ANSI code page rather than UTF-8.

    • +
    • bpo-26147: xmlrpc now works with strings not encodable with used non-UTF-8 +encoding.

    • +
    • bpo-25935: Garbage collector now breaks reference loops with OrderedDict.

    • +
    • bpo-16620: Fixed AttributeError in msilib.Directory.glob().

    • +
    • bpo-26013: Added compatibility with broken protocol 2 pickles created in +old Python 3 versions (3.4.3 and lower).

    • +
    • bpo-25850: Use cross-compilation by default for 64-bit Windows.

    • +
    • bpo-17633: Improve zipimport’s support for namespace packages.

    • +
    • bpo-24705: Fix sysconfig._parse_makefile not expanding ${} vars appearing +before $() vars.

    • +
    • bpo-22138: Fix mock.patch behavior when patching descriptors. Restore +original values after patching. Patch contributed by Sean McCully.

    • +
    • bpo-25672: In the ssl module, enable the SSL_MODE_RELEASE_BUFFERS mode +option if it is safe to do so.

    • +
    • bpo-26012: Don’t traverse into symlinks for ** pattern in +pathlib.Path.[r]glob().

    • +
    • bpo-24120: Ignore PermissionError when traversing a tree with +pathlib.Path.[r]glob(). Patch by Ulrich Petri.

    • +
    • bpo-25447: fileinput now uses sys.stdin as-is if it does not have a buffer +attribute (restores backward compatibility).

    • +
    • bpo-25447: Copying the lru_cache() wrapper object now always works, +independently from the type of the wrapped object (by returning the +original object unchanged).

    • +
    • bpo-24103: Fixed possible use after free in ElementTree.XMLPullParser.

    • +
    • bpo-25860: os.fwalk() no longer skips remaining directories when error +occurs. Original patch by Samson Lee.

    • +
    • bpo-25914: Fixed and simplified OrderedDict.__sizeof__.

    • +
    • bpo-25902: Fixed various refcount issues in ElementTree iteration.

    • +
    • bpo-25717: Restore the previous behaviour of tolerating most fstat() +errors when opening files. This was a regression in 3.5a1, and stopped +anonymous temporary files from working in special cases.

    • +
    • bpo-24903: Fix regression in number of arguments compileall accepts when +‘-d’ is specified. The check on the number of arguments has been dropped +completely as it never worked correctly anyway.

    • +
    • bpo-25764: In the subprocess module, preserve any exception caused by +fork() failure when preexec_fn is used.

    • +
    • bpo-6478: _strptime’s regexp cache now is reset after changing timezone +with time.tzset().

    • +
    • bpo-14285: When executing a package with the “python -m package” option, +and package initialization fails, a proper traceback is now reported. The +“runpy” module now lets exceptions from package initialization pass back +to the caller, rather than raising ImportError.

    • +
    • bpo-19771: Also in runpy and the “-m” option, omit the irrelevant message +“… is a package and cannot be directly executed” if the package could +not even be initialized (e.g. due to a bad *.pyc file).

    • +
    • bpo-25177: Fixed problem with the mean of very small and very large +numbers. As a side effect, statistics.mean and statistics.variance should +be significantly faster.

    • +
    • bpo-25718: Fixed copying object with state with boolean value is false.

    • +
    • bpo-10131: Fixed deep copying of minidom documents. Based on patch by +Marian Ganisin.

    • +
    • bpo-25725: Fixed a reference leak in pickle.loads() when unpickling +invalid data including tuple instructions.

    • +
    • bpo-25663: In the Readline completer, avoid listing duplicate global +names, and search the global namespace before searching builtins.

    • +
    • bpo-25688: Fixed file leak in ElementTree.iterparse() raising an error.

    • +
    • bpo-23914: Fixed SystemError raised by unpickler on broken pickle data.

    • +
    • bpo-25691: Fixed crash on deleting ElementTree.Element attributes.

    • +
    • bpo-25624: ZipFile now always writes a ZIP_STORED header for directory +entries. Patch by Dingyuan Wang.

    • +
    • Skip getaddrinfo if host is already resolved. Patch by A. Jesse Jiryu +Davis.

    • +
    • bpo-26050: Add asyncio.StreamReader.readuntil() method. Patch by Марк +Коренберг.

    • +
    • bpo-25924: Avoid unnecessary serialization of getaddrinfo(3) calls on OS X +versions 10.5 or higher. Original patch by A. Jesse Jiryu Davis.

    • +
    • bpo-26406: Avoid unnecessary serialization of getaddrinfo(3) calls on +current versions of OpenBSD and NetBSD. Patch by A. Jesse Jiryu Davis.

    • +
    • bpo-26848: Fix asyncio/subprocess.communicate() to handle empty input. +Patch by Jack O’Connor.

    • +
    • bpo-27040: Add loop.get_exception_handler method

    • +
    • bpo-27041: asyncio: Add loop.create_future method

    • +
    • bpo-27223: asyncio: Fix _read_ready and _write_ready to respect +_conn_lost. Patch by Łukasz Langa.

    • +
    • bpo-22970: asyncio: Fix inconsistency cancelling Condition.wait. Patch by +David Coles.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-5124: Paste with text selected now replaces the selection on X11. This +matches how paste works on Windows, Mac, most modern Linux apps, and ttk +widgets. Original patch by Serhiy Storchaka.

    • +
    • bpo-24759: Make clear in idlelib.idle_test.__init__ that the directory is +a private implementation of test.test_idle and tool for maintainers.

    • +
    • bpo-27196: Stop ‘ThemeChanged’ warnings when running IDLE tests. These +persisted after other warnings were suppressed in #20567. Apply Serhiy +Storchaka’s update_idletasks solution to four test files. Record this +additional advice in idle_test/README.txt

    • +
    • bpo-20567: Revise idle_test/README.txt with advice about avoiding tk +warning messages from tests. Apply advice to several IDLE tests.

    • +
    • bpo-27117: Make colorizer htest and turtledemo work with dark themes. Move +code for configuring text widget colors to a new function.

    • +
    • bpo-26673: When tk reports font size as 0, change to size 10. Such fonts +on Linux prevented the configuration dialog from opening.

    • +
    • bpo-21939: Add test for IDLE’s percolator. Original patch by Saimadhav +Heblikar.

    • +
    • bpo-21676: Add test for IDLE’s replace dialog. Original patch by Saimadhav +Heblikar.

    • +
    • bpo-18410: Add test for IDLE’s search dialog. Original patch by Westley +Martínez.

    • +
    • bpo-21703: Add test for IDLE’s undo delegator. Original patch by Saimadhav +Heblikar .

    • +
    • bpo-27044: Add ConfigDialog.remove_var_callbacks to stop memory leaks.

    • +
    • bpo-23977: Add more asserts to test_delegator.

    • +
    • bpo-20640: Add tests for idlelib.configHelpSourceEdit. Patch by Saimadhav +Heblikar.

    • +
    • In the ‘IDLE-console differences’ section of the IDLE doc, clarify how +running with IDLE affects sys.modules and the standard streams.

    • +
    • bpo-25507: fix incorrect change in IOBinding that prevented printing. +Augment IOBinding htest to include all major IOBinding functions.

    • +
    • bpo-25905: Revert unwanted conversion of ‘ to ’ RIGHT SINGLE QUOTATION +MARK in README.txt and open this and NEWS.txt with ‘ascii’. Re-encode +CREDITS.txt to utf-8 and open it with ‘utf-8’.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-19489: Moved the search box from the sidebar to the header and footer +of each page. Patch by Ammar Askar.

    • +
    • bpo-24136: Document the new PEP 448 unpacking syntax of 3.5.

    • +
    • bpo-26736: Used HTTPS for external links in the documentation if possible.

    • +
    • bpo-6953: Rework the Readline module documentation to group related +functions together, and add more details such as what underlying Readline +functions and variables are accessed.

    • +
    • bpo-23606: Adds note to ctypes documentation regarding cdll.msvcrt.

    • +
    • bpo-25500: Fix documentation to not claim that __import__ is searched for +in the global scope.

    • +
    • bpo-26014: Update 3.x packaging documentation: * “See also” links to the +new docs are now provided in the legacy pages * links to setuptools +documentation have been updated

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-21916: Added tests for the turtle module. Patch by ingrid, Gregory +Loyse and Jelle Zijlstra.

    • +
    • bpo-26523: The multiprocessing thread pool (multiprocessing.dummy.Pool) +was untested.

    • +
    • bpo-26015: Added new tests for pickling iterators of mutable sequences.

    • +
    • bpo-26325: Added test.support.check_no_resource_warning() to check that no +ResourceWarning is emitted.

    • +
    • bpo-25940: Changed test_ssl to use self-signed.pythontest.net. This +avoids relying on svn.python.org, which recently changed root certificate.

    • +
    • bpo-25616: Tests for OrderedDict are extracted from test_collections into +separate file test_ordered_dict.

    • +
    • bpo-26583: Skip test_timestamp_overflow in test_import if bytecode files +cannot be written.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-26884: Fix linking extension modules for cross builds. Patch by Xavier +de Gaye.

    • +
    • bpo-22359: Disable the rules for running _freeze_importlib and pgen when +cross-compiling. The output of these programs is normally saved with the +source code anyway, and is still regenerated when doing a native build. +Patch by Xavier de Gaye.

    • +
    • bpo-27229: Fix the cross-compiling pgen rule for in-tree builds. Patch by +Xavier de Gaye.

    • +
    • bpo-21668: Link audioop, _datetime, _ctypes_test modules to libm, except +on Mac OS X. Patch written by Xavier de Gaye.

    • +
    • bpo-25702: A –with-lto configure option has been added that will enable +link time optimizations at build time during a make profile-opt. Some +compilers and toolchains are known to not produce stable code when using +LTO, be sure to test things thoroughly before relying on it. It can +provide a few % speed up over profile-opt alone.

    • +
    • bpo-26624: Adds validation of ucrtbase[d].dll version with warning for old +versions.

    • +
    • bpo-17603: Avoid error about nonexistant fileblocks.o file by using a +lower-level check for st_blocks in struct stat.

    • +
    • bpo-26079: Fixing the build output folder for tix-8.4.3.6. Patch by Bjoern +Thiel.

    • +
    • bpo-26465: Update Windows builds to use OpenSSL 1.0.2g.

    • +
    • bpo-24421: Compile Modules/_math.c once, before building extensions. +Previously it could fail to compile properly if the math and cmath builds +were concurrent.

    • +
    • bpo-25348: Added --pgo and --pgo-job arguments to +PCbuild\build.bat for building with Profile-Guided Optimization. The +old PCbuild\build_pgo.bat script is now deprecated, and simply calls +PCbuild\build.bat --pgo %*.

    • +
    • bpo-25827: Add support for building with ICC to configure, including a +new --with-icc flag.

    • +
    • bpo-25696: Fix installation of Python on UNIX with make -j9.

    • +
    • bpo-26930: Update OS X 10.5+ 32-bit-only installer to build and link with +OpenSSL 1.0.2h.

    • +
    • bpo-26268: Update Windows builds to use OpenSSL 1.0.2f.

    • +
    • bpo-25136: Support Apple Xcode 7’s new textual SDK stub libraries.

    • +
    • bpo-24324: Do not enable unreachable code warnings when using gcc as the +option does not work correctly in older versions of gcc and has been +silently removed as of gcc-4.5.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-27053: Updates make_zip.py to correctly generate library ZIP file.

    • +
    • bpo-26268: Update the prepare_ssl.py script to handle OpenSSL releases +that don’t include the contents of the include directory (that is, 1.0.2e +and later).

    • +
    • bpo-26071: bdist_wininst created binaries fail to start and find 32bit +Python

    • +
    • bpo-26073: Update the list of magic numbers in launcher

    • +
    • bpo-26065: Excludes venv from library when generating embeddable distro.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-26799: Fix python-gdb.py: don’t get C types once when the Python code +is loaded, but get C types on demand. The C types can change if +python-gdb.py is loaded before the Python executable. Patch written by +Thomas Ilsche.

    • +
    • bpo-26271: Fix the Freeze tool to properly use flags passed through +configure. Patch by Daniel Shaulov.

    • +
    • bpo-26489: Add dictionary unpacking support to Tools/parser/unparse.py. +Patch by Guo Ci Teo.

    • +
    • bpo-26316: Fix variable name typo in Argument Clinic.

    • +
    +
    +
    +

    Windows

    + +
    +
    +
    +

    Python 3.5.1 final

    +

    Release date: 2015-12-06

    +
    +

    Core and Builtins

    +
      +
    • bpo-25709: Fixed problem with in-place string concatenation and utf-8 +cache.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-25715: Python 3.5.1 installer shows wrong upgrade path and incorrect +logic for launcher detection.

    • +
    +
    +
    +
    +

    Python 3.5.1 release candidate 1

    +

    Release date: 2015-11-22

    +
    +

    Core and Builtins

    +
      +
    • bpo-25630: Fix a possible segfault during argument parsing in functions +that accept filesystem paths.

    • +
    • bpo-23564: Fixed a partially broken sanity check in the _posixsubprocess +internals regarding how fds_to_pass were passed to the child. The bug had +no actual impact as subprocess.py already avoided it.

    • +
    • bpo-25388: Fixed tokenizer crash when processing undecodable source code +with a null byte.

    • +
    • bpo-25462: The hash of the key now is calculated only once in most +operations in C implementation of OrderedDict.

    • +
    • bpo-22995: Default implementation of __reduce__ and __reduce_ex__ now +rejects builtin types with not defined __new__.

    • +
    • bpo-25555: Fix parser and AST: fill lineno and col_offset of “arg” node +when compiling AST from Python objects.

    • +
    • bpo-24802: Avoid buffer overreads when int(), float(), compile(), exec() +and eval() are passed bytes-like objects. These objects are not +necessarily terminated by a null byte, but the functions assumed they +were.

    • +
    • bpo-24726: Fixed a crash and leaking NULL in repr() of OrderedDict that +was mutated by direct calls of dict methods.

    • +
    • bpo-25449: Iterating OrderedDict with keys with unstable hash now raises +KeyError in C implementations as well as in Python implementation.

    • +
    • bpo-25395: Fixed crash when highly nested OrderedDict structures were +garbage collected.

    • +
    • bpo-25274: sys.setrecursionlimit() now raises a RecursionError if the new +recursion limit is too low depending at the current recursion depth. +Modify also the “lower-water mark” formula to make it monotonic. This mark +is used to decide when the overflowed flag of the thread state is reset.

    • +
    • bpo-24402: Fix input() to prompt to the redirected stdout when +sys.stdout.fileno() fails.

    • +
    • bpo-24806: Prevent builtin types that are not allowed to be subclassed +from being subclassed through multiple inheritance.

    • +
    • bpo-24848: Fixed a number of bugs in UTF-7 decoding of misformed data.

    • +
    • bpo-25280: Import trace messages emitted in verbose (-v) mode are no +longer formatted twice.

    • +
    • bpo-25003: On Solaris 11.3 or newer, os.urandom() now uses the getrandom() +function instead of the getentropy() function. The getentropy() function +is blocking to generate very good quality entropy, os.urandom() doesn’t +need such high-quality entropy.

    • +
    • bpo-25182: The stdprinter (used as sys.stderr before the io module is +imported at startup) now uses the backslashreplace error handler.

    • +
    • bpo-25131: Make the line number and column offset of set/dict literals and +comprehensions correspond to the opening brace.

    • +
    • bpo-25150: Hide the private _Py_atomic_xxx symbols from the public +Python.h header to fix a compilation error with OpenMP. +PyThreadState_GET() becomes an alias to PyThreadState_Get() to avoid ABI +incompatibilities.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-25626: Change three zlib functions to accept sizes that fit in +Py_ssize_t, but internally cap those sizes to UINT_MAX. This resolves a +regression in 3.5 where GzipFile.read() failed to read chunks larger than +2 or 4 GiB. The change affects the zlib.Decompress.decompress() +max_length parameter, the zlib.decompress() bufsize parameter, and the +zlib.Decompress.flush() length parameter.

    • +
    • bpo-25583: Avoid incorrect errors raised by os.makedirs(exist_ok=True) +when the OS gives priority to errors such as EACCES over EEXIST.

    • +
    • bpo-25593: Change semantics of EventLoop.stop() in asyncio.

    • +
    • bpo-6973: When we know a subprocess.Popen process has died, do not allow +the send_signal(), terminate(), or kill() methods to do anything as they +could potentially signal a different process.

    • +
    • bpo-25590: In the Readline completer, only call getattr() once per +attribute.

    • +
    • bpo-25498: Fix a crash when garbage-collecting ctypes objects created by +wrapping a memoryview. This was a regression made in 3.5a1. Based on +patch by Eryksun.

    • +
    • bpo-25584: Added “escape” to the __all__ list in the glob module.

    • +
    • bpo-25584: Fixed recursive glob() with patterns starting with **.

    • +
    • bpo-25446: Fix regression in smtplib’s AUTH LOGIN support.

    • +
    • bpo-18010: Fix the pydoc web server’s module search function to handle +exceptions from importing packages.

    • +
    • bpo-25554: Got rid of circular references in regular expression parsing.

    • +
    • bpo-25510: fileinput.FileInput.readline() now returns b’’ instead of ‘’ at +the end if the FileInput was opened with binary mode. Patch by Ryosuke +Ito.

    • +
    • bpo-25503: Fixed inspect.getdoc() for inherited docstrings of properties. +Original patch by John Mark Vandenberg.

    • +
    • bpo-25515: Always use os.urandom as a source of randomness in uuid.uuid4.

    • +
    • bpo-21827: Fixed textwrap.dedent() for the case when largest common +whitespace is a substring of smallest leading whitespace. Based on patch +by Robert Li.

    • +
    • bpo-25447: The lru_cache() wrapper objects now can be copied and pickled +(by returning the original object unchanged).

    • +
    • bpo-25390: typing: Don’t crash on Union[str, Pattern].

    • +
    • bpo-25441: asyncio: Raise error from drain() when socket is closed.

    • +
    • bpo-25410: Cleaned up and fixed minor bugs in C implementation of +OrderedDict.

    • +
    • bpo-25411: Improved Unicode support in SMTPHandler through better use of +the email package. Thanks to user simon04 for the patch.

    • +
    • bpo-25407: Remove mentions of the formatter module being removed in Python +3.6.

    • +
    • bpo-25406: Fixed a bug in C implementation of OrderedDict.move_to_end() +that caused segmentation fault or hang in iterating after moving several +items to the start of ordered dict.

    • +
    • bpo-25364: zipfile now works in threads disabled builds.

    • +
    • bpo-25328: smtpd’s SMTPChannel now correctly raises a ValueError if both +decode_data and enable_SMTPUTF8 are set to true.

    • +
    • bpo-25316: distutils raises OSError instead of DistutilsPlatformError when +MSVC is not installed.

    • +
    • bpo-25380: Fixed protocol for the STACK_GLOBAL opcode in +pickletools.opcodes.

    • +
    • bpo-23972: Updates asyncio datagram create method allowing reuseport and +reuseaddr socket options to be set prior to binding the socket. Mirroring +the existing asyncio create_server method the reuseaddr option for +datagram sockets defaults to True if the O/S is ‘posix’ (except if the +platform is Cygwin). Patch by Chris Laws.

    • +
    • bpo-25304: Add asyncio.run_coroutine_threadsafe(). This lets you submit a +coroutine to a loop from another thread, returning a +concurrent.futures.Future. By Vincent Michel.

    • +
    • bpo-25232: Fix CGIRequestHandler to split the query from the URL at the +first question mark (?) rather than the last. Patch from Xiang Zhang.

    • +
    • bpo-24657: Prevent CGIRequestHandler from collapsing slashes in the query +part of the URL as if it were a path. Patch from Xiang Zhang.

    • +
    • bpo-24483: C implementation of functools.lru_cache() now calculates key’s +hash only once.

    • +
    • bpo-22958: Constructor and update method of weakref.WeakValueDictionary +now accept the self and the dict keyword arguments.

    • +
    • bpo-22609: Constructor of collections.UserDict now accepts the self +keyword argument.

    • +
    • bpo-25111: Fixed comparison of traceback.FrameSummary.

    • +
    • bpo-25262: Added support for BINBYTES8 opcode in Python implementation of +unpickler. Highest 32 bits of 64-bit size for BINUNICODE8 and BINBYTES8 +opcodes no longer silently ignored on 32-bit platforms in C +implementation.

    • +
    • bpo-25034: Fix string.Formatter problem with auto-numbering and nested +format_specs. Patch by Anthon van der Neut.

    • +
    • bpo-25233: Rewrite the guts of asyncio.Queue and asyncio.Semaphore to be +more understandable and correct.

    • +
    • bpo-25203: Failed readline.set_completer_delims() no longer left the +module in inconsistent state.

    • +
    • bpo-23600: Default implementation of tzinfo.fromutc() was returning wrong +results in some cases.

    • +
    • bpo-23329: Allow the ssl module to be built with older versions of +LibreSSL.

    • +
    • Prevent overflow in _Unpickler_Read.

    • +
    • bpo-25047: The XML encoding declaration written by Element Tree now +respects the letter case given by the user. This restores the ability to +write encoding names in uppercase like “UTF-8”, which worked in Python 2.

    • +
    • bpo-25135: Make deque_clear() safer by emptying the deque before clearing. +This helps avoid possible reentrancy issues.

    • +
    • bpo-19143: platform module now reads Windows version from kernel32.dll to +avoid compatibility shims.

    • +
    • bpo-25092: Fix datetime.strftime() failure when errno was already set to +EINVAL.

    • +
    • bpo-23517: Fix rounding in fromtimestamp() and utcfromtimestamp() methods +of datetime.datetime: microseconds are now rounded to nearest with ties +going to nearest even integer (ROUND_HALF_EVEN), instead of being rounding +towards minus infinity (ROUND_FLOOR). It’s important that these methods +use the same rounding mode than datetime.timedelta to keep the property: +(datetime(1970,1,1) + timedelta(seconds=t)) == +datetime.utcfromtimestamp(t). It also the rounding mode used by +round(float) for example.

    • +
    • bpo-25155: Fix datetime.datetime.now() and datetime.datetime.utcnow() on +Windows to support date after year 2038. It was a regression introduced in +Python 3.5.0.

    • +
    • bpo-25108: Omitted internal frames in traceback functions print_stack(), +format_stack(), and extract_stack() called without arguments.

    • +
    • bpo-25118: Fix a regression of Python 3.5.0 in os.waitpid() on Windows.

    • +
    • bpo-24684: socket.socket.getaddrinfo() now calls +PyUnicode_AsEncodedString() instead of calling the encode() method of the +host, to handle correctly custom string with an encode() method which +doesn’t return a byte string. The encoder of the IDNA codec is now called +directly instead of calling the encode() method of the string.

    • +
    • bpo-25060: Correctly compute stack usage of the BUILD_MAP opcode.

    • +
    • bpo-24857: Comparing call_args to a long sequence now correctly returns a +boolean result instead of raising an exception. Patch by A Kaptur.

    • +
    • bpo-23144: Make sure that HTMLParser.feed() returns all the data, even +when convert_charrefs is True.

    • +
    • bpo-24982: shutil.make_archive() with the “zip” format now adds entries +for directories (including empty directories) in ZIP file.

    • +
    • bpo-25019: Fixed a crash caused by setting non-string key of expat parser. +Based on patch by John Leitch.

    • +
    • bpo-16180: Exit pdb if file has syntax error, instead of trapping user in +an infinite loop. Patch by Xavier de Gaye.

    • +
    • bpo-24891: Fix a race condition at Python startup if the file descriptor +of stdin (0), stdout (1) or stderr (2) is closed while Python is creating +sys.stdin, sys.stdout and sys.stderr objects. These attributes are now set +to None if the creation of the object failed, instead of raising an +OSError exception. Initial patch written by Marco Paolini.

    • +
    • bpo-24992: Fix error handling and a race condition (related to garbage +collection) in collections.OrderedDict constructor.

    • +
    • bpo-24881: Fixed setting binary mode in Python implementation of FileIO on +Windows and Cygwin. Patch from Akira Li.

    • +
    • bpo-25578: Fix (another) memory leak in SSLSocket.getpeercer().

    • +
    • bpo-25530: Disable the vulnerable SSLv3 protocol by default when creating +ssl.SSLContext.

    • +
    • bpo-25569: Fix memory leak in SSLSocket.getpeercert().

    • +
    • bpo-25471: Sockets returned from accept() shouldn’t appear to be +nonblocking.

    • +
    • bpo-25319: When threading.Event is reinitialized, the underlying condition +should use a regular lock rather than a recursive lock.

    • +
    • bpo-21112: Fix regression in unittest.expectedFailure on subclasses. Patch +from Berker Peksag.

    • +
    • bpo-24764: cgi.FieldStorage.read_multi() now ignores the Content-Length +header in part headers. Patch written by Peter Landry and reviewed by +Pierre Quentel.

    • +
    • bpo-24913: Fix overrun error in deque.index(). Found by John Leitch and +Bryce Darling.

    • +
    • bpo-24774: Fix docstring in http.server.test. Patch from Chiu-Hsiang Hsu.

    • +
    • bpo-21159: Improve message in +configparser.InterpolationMissingOptionError. Patch from Łukasz Langa.

    • +
    • bpo-20362: Honour TestCase.longMessage correctly in assertRegex. Patch +from Ilia Kurenkov.

    • +
    • bpo-23572: Fixed functools.singledispatch on classes with falsy +metaclasses. Patch by Ethan Furman.

    • +
    • asyncio: ensure_future() now accepts awaitable objects.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-15348: Stop the debugger engine (normally in a user process) before +closing the debugger window (running in the IDLE process). This prevents +the RuntimeErrors that were being caught and ignored.

    • +
    • bpo-24455: Prevent IDLE from hanging when a) closing the shell while the +debugger is active (15347); b) closing the debugger with the [X] button +(15348); and c) activating the debugger when already active (24455). The +patch by Mark Roseman does this by making two changes. 1. Suspend and +resume the gui.interaction method with the tcl vwait mechanism intended +for this purpose (instead of root.mainloop & .quit). 2. In gui.run, allow +any existing interaction to terminate first.

    • +
    • Change ‘The program’ to ‘Your program’ in an IDLE ‘kill program?’ message +to make it clearer that the program referred to is the currently running +user program, not IDLE itself.

    • +
    • bpo-24750: Improve the appearance of the IDLE editor window status bar. +Patch by Mark Roseman.

    • +
    • bpo-25313: Change the handling of new built-in text color themes to better +address the compatibility problem introduced by the addition of IDLE Dark. +Consistently use the revised idleConf.CurrentTheme everywhere in idlelib.

    • +
    • bpo-24782: Extension configuration is now a tab in the IDLE Preferences +dialog rather than a separate dialog. The former tabs are now a sorted +list. Patch by Mark Roseman.

    • +
    • bpo-22726: Re-activate the config dialog help button with some content +about the other buttons and the new IDLE Dark theme.

    • +
    • bpo-24820: IDLE now has an ‘IDLE Dark’ built-in text color theme. It is +more or less IDLE Classic inverted, with a cobalt blue background. +Strings, comments, keywords, … are still green, red, orange, … . To +use it with IDLEs released before November 2015, hit the ‘Save as New +Custom Theme’ button and enter a new name, such as ‘Custom Dark’. The +custom theme will work with any IDLE release, and can be modified.

    • +
    • bpo-25224: README.txt is now an idlelib index for IDLE developers and +curious users. The previous user content is now in the IDLE doc chapter. +‘IDLE’ now means ‘Integrated Development and Learning Environment’.

    • +
    • bpo-24820: Users can now set breakpoint colors in Settings -> Custom +Highlighting. Original patch by Mark Roseman.

    • +
    • bpo-24972: Inactive selection background now matches active selection +background, as configured by users, on all systems. Found items are now +always highlighted on Windows. Initial patch by Mark Roseman.

    • +
    • bpo-24570: Idle: make calltip and completion boxes appear on Macs affected +by a tk regression. Initial patch by Mark Roseman.

    • +
    • bpo-24988: Idle ScrolledList context menus (used in debugger) now work on +Mac Aqua. Patch by Mark Roseman.

    • +
    • bpo-24801: Make right-click for context menu work on Mac Aqua. Patch by +Mark Roseman.

    • +
    • bpo-25173: Associate tkinter messageboxes with a specific widget. For Mac +OSX, make them a ‘sheet’. Patch by Mark Roseman.

    • +
    • bpo-25198: Enhance the initial html viewer now used for Idle Help. +Properly indent fixed-pitch text (patch by Mark Roseman). Give code +snippet a very Sphinx-like light blueish-gray background. Re-use initial +width and height set by users for shell and editor. When the Table of +Contents (TOC) menu is used, put the section header at the top of the +screen.

    • +
    • bpo-25225: Condense and rewrite Idle doc section on text colors.

    • +
    • bpo-21995: Explain some differences between IDLE and console Python.

    • +
    • bpo-22820: Explain need for print when running file from Idle editor.

    • +
    • bpo-25224: Doc: augment Idle feature list and no-subprocess section.

    • +
    • bpo-25219: Update doc for Idle command line options. Some were missing and +notes were not correct.

    • +
    • bpo-24861: Most of idlelib is private and subject to change. Use +idleib.idle.* to start Idle. See idlelib.__init__.__doc__.

    • +
    • bpo-25199: Idle: add synchronization comments for future maintainers.

    • +
    • bpo-16893: Replace help.txt with help.html for Idle doc display. The new +idlelib/help.html is rstripped Doc/build/html/library/idle.html. It looks +better than help.txt and will better document Idle as released. The +tkinter html viewer that works for this file was written by Mark Roseman. +The now unused EditorWindow.HelpDialog class and helt.txt file are +deprecated.

    • +
    • bpo-24199: Deprecate unused idlelib.idlever with possible removal in 3.6.

    • +
    • bpo-24790: Remove extraneous code (which also create 2 & 3 conflicts).

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-22558: Add remaining doc links to source code for Python-coded +modules. Patch by Yoni Lavi.

    • +
    • bpo-12067: Rewrite Comparisons section in the Expressions chapter of the +language reference. Some of the details of comparing mixed types were +incorrect or ambiguous. NotImplemented is only relevant at a lower level +than the Expressions chapter. Added details of comparing range() objects, +and default behaviour and consistency suggestions for user-defined +classes. Patch from Andy Maier.

    • +
    • bpo-24952: Clarify the default size argument of stack_size() in the +“threading” and “_thread” modules. Patch from Mattip.

    • +
    • bpo-23725: Overhaul tempfile docs. Note deprecated status of mktemp. Patch +from Zbigniew Jędrzejewski-Szmek.

    • +
    • bpo-24808: Update the types of some PyTypeObject fields. Patch by Joseph +Weston.

    • +
    • bpo-22812: Fix unittest discovery examples. Patch from Pam McA’Nulty.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-25449: Added tests for OrderedDict subclasses.

    • +
    • bpo-25099: Make test_compileall not fail when an entry on sys.path cannot +be written to (commonly seen in administrative installs on Windows).

    • +
    • bpo-23919: Prevents assert dialogs appearing in the test suite.

    • +
    • PCbuild\rt.bat now accepts an unlimited number of arguments to pass +along to regrtest.py. Previously there was a limit of 9.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-24915: Add LLVM support for PGO builds and use the test suite to +generate the profile data. Initial patch by Alecsandru Patrascu of Intel.

    • +
    • bpo-24910: Windows MSIs now have unique display names.

    • +
    • bpo-24986: It is now possible to build Python on Windows without errors +when external libraries are not available.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-25450: Updates shortcuts to start Python in installation directory.

    • +
    • bpo-25164: Changes default all-users install directory to match per-user +directory.

    • +
    • bpo-25143: Improves installer error messages for unsupported platforms.

    • +
    • bpo-25163: Display correct directory in installer when using non-default +settings.

    • +
    • bpo-25361: Disables use of SSE2 instructions in Windows 32-bit build

    • +
    • bpo-25089: Adds logging to installer for case where launcher is not +selected on upgrade.

    • +
    • bpo-25165: Windows uninstallation should not remove launcher if other +versions remain

    • +
    • bpo-25112: py.exe launcher is missing icons

    • +
    • bpo-25102: Windows installer does not precompile for -O or -OO.

    • +
    • bpo-25081: Makes Back button in installer go back to upgrade page when +upgrading.

    • +
    • bpo-25091: Increases font size of the installer.

    • +
    • bpo-25126: Clarifies that the non-web installer will download some +components.

    • +
    • bpo-25213: Restores requestedExecutionLevel to manifest to disable UAC +virtualization.

    • +
    • bpo-25022: Removed very outdated PC/example_nt/ directory.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-25440: Fix output of python-config –extension-suffix.

    • +
    +
    +
    +
    +

    Python 3.5.0 final

    +

    Release date: 2015-09-13

    +
    +

    Build

    +
      +
    • bpo-25071: Windows installer should not require TargetDir parameter when +installing quietly.

    • +
    +
    +
    +
    +

    Python 3.5.0 release candidate 4

    +

    Release date: 2015-09-09

    +
    +

    Library

    +
      +
    • bpo-25029: Fixes MemoryError in test_strptime.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-25027: Reverts partial-static build options and adds vcruntime140.dll +to Windows installation.

    • +
    +
    +
    +
    +

    Python 3.5.0 release candidate 3

    +

    Release date: 2015-09-07

    +
    +

    Core and Builtins

    +
      +
    • bpo-24305: Prevent import subsystem stack frames from being counted by the +warnings.warn(stacklevel=) parameter.

    • +
    • bpo-24912: Prevent __class__ assignment to immutable built-in objects.

    • +
    • bpo-24975: Fix AST compilation for PEP 448 syntax.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-24917: time_strftime() buffer over-read.

    • +
    • bpo-24748: To resolve a compatibility problem found with py2exe and +pywin32, imp.load_dynamic() once again ignores previously loaded modules +to support Python modules replacing themselves with extension modules. +Patch by Petr Viktorin.

    • +
    • bpo-24635: Fixed a bug in typing.py where isinstance([], typing.Iterable) +would return True once, then False on subsequent calls.

    • +
    • bpo-24989: Fixed buffer overread in BytesIO.readline() if a position is +set beyond size. Based on patch by John Leitch.

    • +
    • bpo-24913: Fix overrun error in deque.index(). Found by John Leitch and +Bryce Darling.

    • +
    +
    +
    +
    +

    Python 3.5.0 release candidate 2

    +

    Release date: 2015-08-25

    +
    +

    Core and Builtins

    +
      +
    • bpo-24769: Interpreter now starts properly when dynamic loading is +disabled. Patch by Petr Viktorin.

    • +
    • bpo-21167: NAN operations are now handled correctly when python is +compiled with ICC even if -fp-model strict is not specified.

    • +
    • bpo-24492: A “package” lacking a __name__ attribute when trying to perform +a from .. import ... statement will trigger an ImportError instead of +an AttributeError.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-24847: Removes vcruntime140.dll dependency from Tcl/Tk.

    • +
    • bpo-24839: platform._syscmd_ver raises DeprecationWarning

    • +
    • bpo-24867: Fix Task.get_stack() for ‘async def’ coroutines

    • +
    +
    +
    +
    +

    Python 3.5.0 release candidate 1

    +

    Release date: 2015-08-09

    +
    +

    Core and Builtins

    +
      +
    • bpo-24667: Resize odict in all cases that the underlying dict resizes.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-24824: Signatures of codecs.encode() and codecs.decode() now are +compatible with pydoc.

    • +
    • bpo-24634: Importing uuid should not try to load libc on Windows

    • +
    • bpo-24798: _msvccompiler.py doesn’t properly support manifests

    • +
    • bpo-4395: Better testing and documentation of binary operators. Patch by +Martin Panter.

    • +
    • bpo-23973: Update typing.py from GitHub repo.

    • +
    • bpo-23004: mock_open() now reads binary data correctly when the type of +read_data is bytes. Initial patch by Aaron Hill.

    • +
    • bpo-23888: Handle fractional time in cookie expiry. Patch by ssh.

    • +
    • bpo-23652: Make it possible to compile the select module against the libc +headers from the Linux Standard Base, which do not include some EPOLL +macros. Patch by Matt Frank.

    • +
    • bpo-22932: Fix timezones in email.utils.formatdate. Patch from Dmitry +Shachnev.

    • +
    • bpo-23779: imaplib raises TypeError if authenticator tries to abort. Patch +from Craig Holmquist.

    • +
    • bpo-23319: Fix ctypes.BigEndianStructure, swap correctly bytes. Patch +written by Matthieu Gautier.

    • +
    • bpo-23254: Document how to close the TCPServer listening socket. Patch +from Martin Panter.

    • +
    • bpo-19450: Update Windows and OS X installer builds to use SQLite 3.8.11.

    • +
    • bpo-17527: Add PATCH to wsgiref.validator. Patch from Luca Sbardella.

    • +
    • bpo-24791: Fix grammar regression for call syntax: ‘g(*a or b)’.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-23672: Allow Idle to edit and run files with astral chars in name. +Patch by Mohd Sanad Zaki Rizvi.

    • +
    • bpo-24745: Idle editor default font. Switch from Courier to +platform-sensitive TkFixedFont. This should not affect current customized +font selections. If there is a problem, edit +$HOME/.idlerc/config-main.cfg and remove ‘fontxxx’ entries from [Editor +Window]. Patch by Mark Roseman.

    • +
    • bpo-21192: Idle editor. When a file is run, put its name in the restart +bar. Do not print false prompts. Original patch by Adnan Umer.

    • +
    • bpo-13884: Idle menus. Remove tearoff lines. Patch by Roger Serwy.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-24129: Clarify the reference documentation for name resolution. This +includes removing the assumption that readers will be familiar with the +name resolution scheme Python used prior to the introduction of lexical +scoping for function namespaces. Patch by Ivan Levkivskyi.

    • +
    • bpo-20769: Improve reload() docs. Patch by Dorian Pula.

    • +
    • bpo-23589: Remove duplicate sentence from the FAQ. Patch by Yongzhi Pan.

    • +
    • bpo-24729: Correct IO tutorial to match implementation regarding encoding +parameter to open function.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-24751: When running regrtest with the -w command line option, a +test run is no longer marked as a failure if all tests succeed when +re-run.

    • +
    +
    +
    +
    +

    Python 3.5.0 beta 4

    +

    Release date: 2015-07-26

    +
    +

    Core and Builtins

    +
      +
    • bpo-23573: Restored optimization of bytes.rfind() and bytearray.rfind() +for single-byte argument on Linux.

    • +
    • bpo-24569: Make PEP 448 dictionary evaluation more consistent.

    • +
    • bpo-24583: Fix crash when set is mutated while being updated.

    • +
    • bpo-24407: Fix crash when dict is mutated while being updated.

    • +
    • bpo-24619: New approach for tokenizing async/await. As a consequence, it +is now possible to have one-line ‘async def foo(): await ..’ functions.

    • +
    • bpo-24687: Plug refleak on SyntaxError in function parameters annotations.

    • +
    • bpo-15944: memoryview: Allow arbitrary formats when casting to bytes. +Patch by Martin Panter.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-23441: rcompleter now prints a tab character instead of displaying +possible completions for an empty word. Initial patch by Martin Sekera.

    • +
    • bpo-24683: Fixed crashes in _json functions called with arguments of +inappropriate type.

    • +
    • bpo-21697: shutil.copytree() now correctly handles symbolic links that +point to directories. Patch by Eduardo Seabra and Thomas Kluyver.

    • +
    • bpo-14373: Fixed segmentation fault when gc.collect() is called during +constructing lru_cache (C implementation).

    • +
    • bpo-24695: Fix a regression in traceback.print_exception(). If +exc_traceback is None we shouldn’t print a traceback header like described +in the documentation.

    • +
    • bpo-24620: Random.setstate() now validates the value of state last +element.

    • +
    • bpo-22485: Fixed an issue that caused inspect.getsource to return +incorrect results on nested functions.

    • +
    • bpo-22153: Improve unittest docs. Patch from Martin Panter and evilzero.

    • +
    • bpo-24580: Symbolic group references to open group in re patterns now are +explicitly forbidden as well as numeric group references.

    • +
    • bpo-24206: Fixed __eq__ and __ne__ methods of inspect classes.

    • +
    • bpo-24631: Fixed regression in the timeit module with multiline setup.

    • +
    • bpo-18622: unittest.mock.mock_open().reset_mock would recurse infinitely. +Patch from Nicola Palumbo and Laurent De Buyst.

    • +
    • bpo-23661: unittest.mock side_effects can now be exceptions again. This +was a regression vs Python 3.4. Patch from Ignacio Rossi

    • +
    • bpo-24608: chunk.Chunk.read() now always returns bytes, not str.

    • +
    • bpo-18684: Fixed reading out of the buffer in the re module.

    • +
    • bpo-24259: tarfile now raises a ReadError if an archive is truncated +inside a data segment.

    • +
    • bpo-15014: SMTP.auth() and SMTP.login() now support RFC 4954’s optional +initial-response argument to the SMTP AUTH command.

    • +
    • bpo-24669: Fix inspect.getsource() for ‘async def’ functions. Patch by Kai +Groner.

    • +
    • bpo-24688: ast.get_docstring() for ‘async def’ functions.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-24603: Update Windows builds and OS X 10.5 installer to use OpenSSL +1.0.2d.

    • +
    +
    +
    +
    +

    Python 3.5.0 beta 3

    +

    Release date: 2015-07-05

    +
    +

    Core and Builtins

    +
      +
    • bpo-24467: Fixed possible buffer over-read in bytearray. The bytearray +object now always allocates place for trailing null byte and it’s buffer +now is always null-terminated.

    • +
    • Upgrade to Unicode 8.0.0.

    • +
    • bpo-24345: Add Py_tp_finalize slot for the stable ABI.

    • +
    • bpo-24400: Introduce a distinct type for PEP 492 coroutines; add +types.CoroutineType, inspect.getcoroutinestate, +inspect.getcoroutinelocals; coroutines no longer use CO_GENERATOR flag; +sys.set_coroutine_wrapper works only for ‘async def’ coroutines; +inspect.iscoroutine no longer uses collections.abc.Coroutine, it’s +intended to test for pure ‘async def’ coroutines only; add new opcode: +GET_YIELD_FROM_ITER; fix generators wrapper used in types.coroutine to be +instance of collections.abc.Generator; collections.abc.Awaitable and +collections.abc.Coroutine can no longer be used to detect generator-based +coroutines–use inspect.isawaitable instead.

    • +
    • bpo-24450: Add gi_yieldfrom to generators and cr_await to coroutines. +Contributed by Benno Leslie and Yury Selivanov.

    • +
    • bpo-19235: Add new RecursionError exception. Patch by Georg Brandl.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-21750: mock_open.read_data can now be read from each instance, as it +could in Python 3.3.

    • +
    • bpo-24552: Fix use after free in an error case of the _pickle module.

    • +
    • bpo-24514: tarfile now tolerates number fields consisting of only +whitespace.

    • +
    • bpo-19176: Fixed doctype() related bugs in C implementation of +ElementTree. A deprecation warning no longer issued by XMLParser subclass +with default doctype() method. Direct call of doctype() now issues a +warning. Parser’s doctype() now is not called if target’s doctype() is +called. Based on patch by Martin Panter.

    • +
    • bpo-20387: Restore semantic round-trip correctness in tokenize/untokenize +for tab-indented blocks.

    • +
    • bpo-24456: Fixed possible buffer over-read in adpcm2lin() and lin2adpcm() +functions of the audioop module.

    • +
    • bpo-24336: The contextmanager decorator now works with functions with +keyword arguments called “func” and “self”. Patch by Martin Panter.

    • +
    • bpo-24522: Fix possible integer overflow in json accelerator module.

    • +
    • bpo-24489: ensure a previously set C errno doesn’t disturb cmath.polar().

    • +
    • bpo-24408: Fixed AttributeError in measure() and metrics() methods of +tkinter.Font.

    • +
    • bpo-14373: C implementation of functools.lru_cache() now can be used with +methods.

    • +
    • bpo-24347: Set KeyError if PyDict_GetItemWithError returns NULL.

    • +
    • bpo-24348: Drop superfluous incref/decref.

    • +
    • bpo-24359: Check for changed OrderedDict size during iteration.

    • +
    • bpo-24368: Support keyword arguments in OrderedDict methods.

    • +
    • bpo-24362: Simplify the C OrderedDict fast nodes resize logic.

    • +
    • bpo-24377: Fix a ref leak in OrderedDict.__repr__.

    • +
    • bpo-24369: Defend against key-changes during iteration.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-24373: _testmultiphase and xxlimited now use tp_traverse and +tp_finalize to avoid reference leaks encountered when combining tp_dealloc +with PyType_FromSpec (see bpo-16690 for details)

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-24458: Update documentation to cover multi-phase initialization for +extension modules (PEP 489). Patch by Petr Viktorin.

    • +
    • bpo-24351: Clarify what is meant by “identifier” in the context of +string.Template instances.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-24432: Update Windows builds and OS X 10.5 installer to use OpenSSL +1.0.2c.

    • +
    +
    +
    +
    +

    Python 3.5.0 beta 2

    +

    Release date: 2015-05-31

    +
    +

    Core and Builtins

    +
      +
    • bpo-24284: The startswith and endswith methods of the str class no longer +return True when finding the empty string and the indexes are completely +out of range.

    • +
    • bpo-24115: Update uses of PyObject_IsTrue(), PyObject_Not(), +PyObject_IsInstance(), PyObject_RichCompareBool() and _PyDict_Contains() +to check for and handle errors correctly.

    • +
    • bpo-24328: Fix importing one character extension modules.

    • +
    • bpo-11205: In dictionary displays, evaluate the key before the value.

    • +
    • bpo-24285: Fixed regression that prevented importing extension modules +from inside packages. Patch by Petr Viktorin.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-23247: Fix a crash in the StreamWriter.reset() of CJK codecs.

    • +
    • bpo-24270: Add math.isclose() and cmath.isclose() functions as per PEP +485. Contributed by Chris Barker and Tal Einat.

    • +
    • bpo-5633: Fixed timeit when the statement is a string and the setup is +not.

    • +
    • bpo-24326: Fixed audioop.ratecv() with non-default weightB argument. +Original patch by David Moore.

    • +
    • bpo-16991: Add a C implementation of OrderedDict.

    • +
    • bpo-23934: Fix inspect.signature to fail correctly for builtin types +lacking signature information. Initial patch by James Powell.

    • +
    +
    +
    +
    +

    Python 3.5.0 beta 1

    +

    Release date: 2015-05-24

    +
    +

    Core and Builtins

    +
      +
    • bpo-24276: Fixed optimization of property descriptor getter.

    • +
    • bpo-24268: PEP 489: Multi-phase extension module initialization. Patch by +Petr Viktorin.

    • +
    • bpo-23955: Add pyvenv.cfg option to suppress registry/environment lookup +for generating sys.path on Windows.

    • +
    • bpo-24257: Fixed system error in the comparison of faked +types.SimpleNamespace.

    • +
    • bpo-22939: Fixed integer overflow in iterator object. Patch by Clement +Rouault.

    • +
    • bpo-23985: Fix a possible buffer overrun when deleting a slice from the +front of a bytearray and then appending some other bytes data.

    • +
    • bpo-24102: Fixed exception type checking in standard error handlers.

    • +
    • bpo-15027: The UTF-32 encoder is now 3x to 7x faster.

    • +
    • bpo-23290: Optimize set_merge() for cases where the target is empty. +(Contributed by Serhiy Storchaka.)

    • +
    • bpo-2292: PEP 448: Additional Unpacking Generalizations.

    • +
    • bpo-24096: Make warnings.warn_explicit more robust against mutation of the +warnings.filters list.

    • +
    • bpo-23996: Avoid a crash when a delegated generator raises an unnormalized +StopIteration exception. Patch by Stefan Behnel.

    • +
    • bpo-23910: Optimize property() getter calls. Patch by Joe Jevnik.

    • +
    • bpo-23911: Move path-based importlib bootstrap code to a separate frozen +module.

    • +
    • bpo-24192: Fix namespace package imports.

    • +
    • bpo-24022: Fix tokenizer crash when processing undecodable source code.

    • +
    • bpo-9951: Added a hex() method to bytes, bytearray, and memoryview.

    • +
    • bpo-22906: PEP 479: Change StopIteration handling inside generators.

    • +
    • bpo-24017: PEP 492: Coroutines with async and await syntax.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-14373: Added C implementation of functools.lru_cache(). Based on +patches by Matt Joiner and Alexey Kachayev.

    • +
    • bpo-24230: The tempfile module now accepts bytes for prefix, suffix and +dir parameters and returns bytes in such situations (matching the os +module APIs).

    • +
    • bpo-22189: collections.UserString now supports __getnewargs__(), +__rmod__(), casefold(), format_map(), isprintable(), and maketrans(). +Patch by Joe Jevnik.

    • +
    • bpo-24244: Prevents termination when an invalid format string is +encountered on Windows in strftime.

    • +
    • bpo-23973: PEP 484: Add the typing module.

    • +
    • bpo-23086: The collections.abc.Sequence() abstract base class added +start and stop parameters to the index() mixin. Patch by Devin +Jeanpierre.

    • +
    • bpo-20035: Replaced the tkinter._fix module used for setting up the +Tcl/Tk environment on Windows with a private function in the _tkinter +module that makes no permanent changes to the environment.

    • +
    • bpo-24257: Fixed segmentation fault in sqlite3.Row constructor with faked +cursor type.

    • +
    • bpo-15836: assertRaises(), assertRaisesRegex(), assertWarns() and +assertWarnsRegex() assertments now check the type of the first argument to +prevent possible user error. Based on patch by Daniel Wagner-Hall.

    • +
    • bpo-9858: Add missing method stubs to _io.RawIOBase. Patch by Laura +Rupprecht.

    • +
    • bpo-22955: attrgetter, itemgetter and methodcaller objects in the operator +module now support pickling. Added readable and evaluable repr for these +objects. Based on patch by Josh Rosenberg.

    • +
    • bpo-22107: tempfile.gettempdir() and tempfile.mkdtemp() now try again when +a directory with the chosen name already exists on Windows as well as on +Unix. tempfile.mkstemp() now fails early if parent directory is not valid +(not exists or is a file) on Windows.

    • +
    • bpo-23780: Improved error message in os.path.join() with single argument.

    • +
    • bpo-6598: Increased time precision and random number range in +email.utils.make_msgid() to strengthen the uniqueness of the message ID.

    • +
    • bpo-24091: Fixed various crashes in corner cases in C implementation of +ElementTree.

    • +
    • bpo-21931: msilib.FCICreate() now raises TypeError in the case of a bad +argument instead of a ValueError with a bogus FCI error number. Patch by +Jeffrey Armstrong.

    • +
    • bpo-13866: quote_via argument added to urllib.parse.urlencode.

    • +
    • bpo-20098: New mangle_from policy option for email, default True for +compat32, but False for all other policies.

    • +
    • bpo-24211: The email library now supports RFC 6532: it can generate +headers using utf-8 instead of encoded words.

    • +
    • bpo-16314: Added support for the LZMA compression in distutils.

    • +
    • bpo-21804: poplib now supports RFC 6856 (UTF8).

    • +
    • bpo-18682: Optimized pprint functions for builtin scalar types.

    • +
    • bpo-22027: smtplib now supports RFC 6531 (SMTPUTF8).

    • +
    • bpo-23488: Random generator objects now consume 2x less memory on 64-bit.

    • +
    • bpo-1322: platform.dist() and platform.linux_distribution() functions are +now deprecated. Initial patch by Vajrasky Kok.

    • +
    • bpo-22486: Added the math.gcd() function. The fractions.gcd() function +now is deprecated. Based on patch by Mark Dickinson.

    • +
    • bpo-24064: Property() docstrings are now writeable. (Patch by Berker +Peksag.)

    • +
    • bpo-22681: Added support for the koi8_t encoding.

    • +
    • bpo-22682: Added support for the kz1048 encoding.

    • +
    • bpo-23796: peek and read1 methods of BufferedReader now raise ValueError +if they called on a closed object. Patch by John Hergenroeder.

    • +
    • bpo-21795: smtpd now supports the 8BITMIME extension whenever the new +decode_data constructor argument is set to False.

    • +
    • bpo-24155: optimize heapq.heapify() for better cache performance when +heapifying large lists.

    • +
    • bpo-21800: imaplib now supports RFC 5161 (enable), RFC 6855 +(utf8/internationalized email) and automatically encodes non-ASCII +usernames and passwords to UTF8.

    • +
    • bpo-20274: When calling a _sqlite.Connection, it now complains if passed +any keyword arguments. Previously it silently ignored them.

    • +
    • bpo-20274: Remove ignored and erroneous “kwargs” parameters from three +METH_VARARGS methods on _sqlite.Connection.

    • +
    • bpo-24134: assertRaises(), assertRaisesRegex(), assertWarns() and +assertWarnsRegex() checks now emits a deprecation warning when callable is +None or keyword arguments except msg is passed in the context manager +mode.

    • +
    • bpo-24018: Add a collections.abc.Generator abstract base class. +Contributed by Stefan Behnel.

    • +
    • bpo-23880: Tkinter’s getint() and getdouble() now support Tcl_Obj. +Tkinter’s getdouble() now supports any numbers (in particular int).

    • +
    • bpo-22619: Added negative limit support in the traceback module. Based on +patch by Dmitry Kazakov.

    • +
    • bpo-24094: Fix possible crash in json.encode with poorly behaved dict +subclasses.

    • +
    • bpo-9246: On POSIX, os.getcwd() now supports paths longer than 1025 bytes. +Patch written by William Orr.

    • +
    • bpo-17445: add difflib.diff_bytes() to support comparison of byte strings +(fixes a regression from Python 2).

    • +
    • bpo-23917: Fall back to sequential compilation when ProcessPoolExecutor +doesn’t exist. Patch by Claudiu Popa.

    • +
    • bpo-23008: Fixed resolving attributes with boolean value is False in +pydoc.

    • +
    • Fix asyncio issue 235: LifoQueue and PriorityQueue’s put didn’t increment +unfinished tasks (this bug was introduced when JoinableQueue was merged +with Queue).

    • +
    • bpo-23908: os functions now reject paths with embedded null character on +Windows instead of silently truncating them.

    • +
    • bpo-23728: binascii.crc_hqx() could return an integer outside of the range +0-0xffff for empty data.

    • +
    • bpo-23887: urllib.error.HTTPError now has a proper repr() representation. +Patch by Berker Peksag.

    • +
    • asyncio: New event loop APIs: set_task_factory() and get_task_factory().

    • +
    • asyncio: async() function is deprecated in favour of ensure_future().

    • +
    • bpo-24178: asyncio.Lock, Condition, Semaphore, and BoundedSemaphore +support new ‘async with’ syntax. Contributed by Yury Selivanov.

    • +
    • bpo-24179: Support ‘async for’ for asyncio.StreamReader. Contributed by +Yury Selivanov.

    • +
    • bpo-24184: Add AsyncIterator and AsyncIterable ABCs to collections.abc. +Contributed by Yury Selivanov.

    • +
    • bpo-22547: Implement informative __repr__ for inspect.BoundArguments. +Contributed by Yury Selivanov.

    • +
    • bpo-24190: Implement inspect.BoundArgument.apply_defaults() method. +Contributed by Yury Selivanov.

    • +
    • bpo-20691: Add ‘follow_wrapped’ argument to +inspect.Signature.from_callable() and inspect.signature(). Contributed by +Yury Selivanov.

    • +
    • bpo-24248: Deprecate inspect.Signature.from_function() and +inspect.Signature.from_builtin().

    • +
    • bpo-23898: Fix inspect.classify_class_attrs() to support attributes with +overloaded __eq__ and __bool__. Patch by Mike Bayer.

    • +
    • bpo-24298: Fix inspect.signature() to correctly unwrap wrappers around +bound methods.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-23184: remove unused names and imports in idlelib. Initial patch by Al +Sweigart.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-21520: test_zipfile no longer fails if the word ‘bad’ appears anywhere +in the name of the current directory.

    • +
    • bpo-9517: Move script_helper into the support package. Patch by Christie +Wilson.

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-22155: Add File Handlers subsection with createfilehandler to tkinter +doc. Remove obsolete example from FAQ. Patch by Martin Panter.

    • +
    • bpo-24029: Document the name binding behavior for submodule imports.

    • +
    • bpo-24077: Fix typo in man page for -I command option: -s, not -S

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-24000: Improved Argument Clinic’s mapping of converters to legacy +“format units”. Updated the documentation to match.

    • +
    • bpo-24001: Argument Clinic converters now use accept={type} instead of +types={‘type’} to specify the types the converter accepts.

    • +
    • bpo-23330: h2py now supports arbitrary filenames in #include.

    • +
    • bpo-24031: make patchcheck now supports git checkouts, too.

    • +
    +
    +
    +
    +

    Python 3.5.0 alpha 4

    +

    Release date: 2015-04-19

    +
    +

    Core and Builtins

    +
      +
    • bpo-22980: Under Linux, GNU/KFreeBSD and the Hurd, C extensions now +include the architecture triplet in the extension name, to make it easy to +test builds for different ABIs in the same working tree. Under OS X, the +extension name now includes PEP 3149-style information.

    • +
    • bpo-22631: Added Linux-specific socket constant CAN_RAW_FD_FRAMES. Patch +courtesy of Joe Jevnik.

    • +
    • bpo-23731: Implement PEP 488: removal of .pyo files.

    • +
    • bpo-23726: Don’t enable GC for user subclasses of non-GC types that don’t +add any new fields. Patch by Eugene Toder.

    • +
    • bpo-23309: Avoid a deadlock at shutdown if a daemon thread is aborted +while it is holding a lock to a buffered I/O object, and the main thread +tries to use the same I/O object (typically stdout or stderr). A fatal +error is emitted instead.

    • +
    • bpo-22977: Fixed formatting Windows error messages on Wine. Patch by +Martin Panter.

    • +
    • bpo-23466: %c, %o, %x, and %X in bytes formatting now raise TypeError on +non-integer input.

    • +
    • bpo-24044: Fix possible null pointer dereference in list.sort in out of +memory conditions.

    • +
    • bpo-21354: PyCFunction_New function is exposed by python DLL again.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-23840: tokenize.open() now closes the temporary binary file on error +to fix a resource warning.

    • +
    • bpo-16914: new debuglevel 2 in smtplib adds timestamps to debug output.

    • +
    • bpo-7159: urllib.request now supports sending auth credentials +automatically after the first 401. This enhancement is a superset of the +enhancement from bpo-19494 and supersedes that change.

    • +
    • bpo-23703: Fix a regression in urljoin() introduced in 901e4e52b20a. Patch +by Demian Brecht.

    • +
    • bpo-4254: Adds _curses.update_lines_cols(). Patch by Arnon Yaari

    • +
    • bpo-19933: Provide default argument for ndigits in round. Patch by +Vajrasky Kok.

    • +
    • bpo-23193: Add a numeric_owner parameter to tarfile.TarFile.extract and +tarfile.TarFile.extractall. Patch by Michael Vogt and Eric Smith.

    • +
    • bpo-23342: Add a subprocess.run() function than returns a CalledProcess +instance for a more consistent API than the existing call* functions.

    • +
    • bpo-21217: inspect.getsourcelines() now tries to compute the start and end +lines from the code object, fixing an issue when a lambda function is used +as decorator argument. Patch by Thomas Ballinger and Allison Kaptur.

    • +
    • bpo-24521: Fix possible integer overflows in the pickle module.

    • +
    • bpo-22931: Allow ‘[‘ and ‘]’ in cookie values.

    • +
    • The keywords attribute of functools.partial is now always a dictionary.

    • +
    • bpo-23811: Add missing newline to the PyCompileError error message. Patch +by Alex Shkop.

    • +
    • bpo-21116: Avoid blowing memory when allocating a multiprocessing shared +array that’s larger than 50% of the available RAM. Patch by Médéric +Boquien.

    • +
    • bpo-22982: Improve BOM handling when seeking to multiple positions of a +writable text file.

    • +
    • bpo-23464: Removed deprecated asyncio JoinableQueue.

    • +
    • bpo-23529: Limit the size of decompressed data when reading from GzipFile, +BZ2File or LZMAFile. This defeats denial of service attacks using +compressed bombs (i.e. compressed payloads which decompress to a huge +size). Patch by Martin Panter and Nikolaus Rath.

    • +
    • bpo-21859: Added Python implementation of io.FileIO.

    • +
    • bpo-23865: close() methods in multiple modules now are idempotent and more +robust at shutdown. If they need to release multiple resources, all are +released even if errors occur.

    • +
    • bpo-23400: Raise same exception on both Python 2 and 3 if sem_open is not +available. Patch by Davin Potts.

    • +
    • bpo-10838: The subprocess now module includes SubprocessError and +TimeoutError in its list of exported names for the users wild enough to +use from subprocess import *.

    • +
    • bpo-23411: Added DefragResult, ParseResult, SplitResult, +DefragResultBytes, ParseResultBytes, and SplitResultBytes to +urllib.parse.__all__. Patch by Martin Panter.

    • +
    • bpo-23881: urllib.request.ftpwrapper constructor now closes the socket if +the FTP connection failed to fix a ResourceWarning.

    • +
    • bpo-23853: socket.socket.sendall() does no more reset the socket +timeout each time data is sent successfully. The socket timeout is now the +maximum total duration to send all data.

    • +
    • bpo-22721: An order of multiline pprint output of set or dict containing +orderable and non-orderable elements no longer depends on iteration order +of set or dict.

    • +
    • bpo-15133: _tkinter.tkapp.getboolean() now supports Tcl_Obj and always +returns bool. tkinter.BooleanVar now validates input values (accepted +bool, int, str, and Tcl_Obj). tkinter.BooleanVar.get() now always returns +bool.

    • +
    • bpo-10590: xml.sax.parseString() now supports string argument.

    • +
    • bpo-23338: Fixed formatting ctypes error messages on Cygwin. Patch by +Makoto Kato.

    • +
    • bpo-15582: inspect.getdoc() now follows inheritance chains.

    • +
    • bpo-2175: SAX parsers now support a character stream of InputSource +object.

    • +
    • bpo-16840: Tkinter now supports 64-bit integers added in Tcl 8.4 and +arbitrary precision integers added in Tcl 8.5.

    • +
    • bpo-23834: Fix socket.sendto(), use the C Py_ssize_t type to store the +result of sendto() instead of the C int type.

    • +
    • bpo-23618: socket.socket.connect() now waits until the connection +completes instead of raising InterruptedError if the connection is +interrupted by signals, signal handlers don’t raise an exception and the +socket is blocking or has a timeout. socket.socket.connect() still +raise InterruptedError for non-blocking sockets.

    • +
    • bpo-21526: Tkinter now supports new boolean type in Tcl 8.5.

    • +
    • bpo-23836: Fix the faulthandler module to handle reentrant calls to its +signal handlers.

    • +
    • bpo-23838: linecache now clears the cache and returns an empty result on +MemoryError.

    • +
    • bpo-10395: Added os.path.commonpath(). Implemented in posixpath and +ntpath. Based on patch by Rafik Draoui.

    • +
    • bpo-23611: Serializing more “lookupable” objects (such as unbound methods +or nested classes) now are supported with pickle protocols < 4.

    • +
    • bpo-13583: sqlite3.Row now supports slice indexing.

    • +
    • bpo-18473: Fixed 2to3 and 3to2 compatible pickle mappings. Fixed +ambiguous reverse mappings. Added many new mappings. Import mapping is +no longer applied to modules already mapped with full name mapping.

    • +
    • bpo-23485: select.select() is now retried automatically with the +recomputed timeout when interrupted by a signal, except if the signal +handler raises an exception. This change is part of the PEP 475.

    • +
    • bpo-23752: When built from an existing file descriptor, io.FileIO() now +only calls fstat() once. Before fstat() was called twice, which was not +necessary.

    • +
    • bpo-23704: collections.deque() objects now support __add__, __mul__, and +__imul__().

    • +
    • bpo-23171: csv.Writer.writerow() now supports arbitrary iterables.

    • +
    • bpo-23745: The new email header parser now handles duplicate MIME +parameter names without error, similar to how get_param behaves.

    • +
    • bpo-22117: Fix os.utime(), it now rounds the timestamp towards minus +infinity (-inf) instead of rounding towards zero.

    • +
    • bpo-23310: Fix MagicMock’s initializer to work with __methods__, just like +configure_mock(). Patch by Kasia Jachim.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-23817: FreeBSD now uses “1.0” in the SOVERSION as other operating +systems, instead of just “1”.

    • +
    • bpo-23501: Argument Clinic now generates code into separate files by +default.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-23799: Added test.support.start_threads() for running and cleaning up +multiple threads.

    • +
    • bpo-22390: test.regrtest now emits a warning if temporary files or +directories are left after running a test.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-18128: pygettext now uses standard +NNNN format in the +POT-Creation-Date header.

    • +
    • bpo-23935: Argument Clinic’s understanding of format units accepting +bytes, bytearrays, and buffers is now consistent with both the +documentation and the implementation.

    • +
    • bpo-23944: Argument Clinic now wraps long impl prototypes at column 78.

    • +
    • bpo-20586: Argument Clinic now ensures that functions without docstrings +have signatures.

    • +
    • bpo-23492: Argument Clinic now generates argument parsing code with +PyArg_Parse instead of PyArg_ParseTuple if possible.

    • +
    • bpo-23500: Argument Clinic is now smarter about generating the “#ifndef” +(empty) definition of the methoddef macro: it’s only generated once, even +if Argument Clinic processes the same symbol multiple times, and it’s +emitted at the end of all processing rather than immediately after the +first use.

    • +
    +
    +
    +

    C API

    +
      +
    • bpo-23998: PyImport_ReInitLock() now checks for lock allocation error

    • +
    +
    +
    +
    +

    Python 3.5.0 alpha 3

    +

    Release date: 2015-03-28

    +
    +

    Core and Builtins

    +
      +
    • bpo-23573: Increased performance of string search operations (str.find, +str.index, str.count, the in operator, str.split, str.partition) with +arguments of different kinds (UCS1, UCS2, UCS4).

    • +
    • bpo-23753: Python doesn’t support anymore platforms without stat() or +fstat(), these functions are always required.

    • +
    • bpo-23681: The -b option now affects comparisons of bytes with int.

    • +
    • bpo-23632: Memoryviews now allow tuple indexing (including for +multi-dimensional memoryviews).

    • +
    • bpo-23192: Fixed generator lambdas. Patch by Bruno Cauet.

    • +
    • bpo-23629: Fix the default __sizeof__ implementation for variable-sized +objects.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-14260: The groupindex attribute of regular expression pattern object +now is non-modifiable mapping.

    • +
    • bpo-23792: Ignore KeyboardInterrupt when the pydoc pager is active. This +mimics the behavior of the standard unix pagers, and prevents pipepager +from shutting down while the pager itself is still running.

    • +
    • bpo-23775: pprint() of OrderedDict now outputs the same representation as +repr().

    • +
    • bpo-23765: Removed IsBadStringPtr calls in ctypes

    • +
    • bpo-22364: Improved some re error messages using regex for hints.

    • +
    • bpo-23742: ntpath.expandvars() no longer loses unbalanced single quotes.

    • +
    • bpo-21717: The zipfile.ZipFile.open function now supports ‘x’ (exclusive +creation) mode.

    • +
    • bpo-21802: The reader in BufferedRWPair now is closed even when closing +writer failed in BufferedRWPair.close().

    • +
    • bpo-23622: Unknown escapes in regular expressions that consist of '\' +and ASCII letter now raise a deprecation warning and will be forbidden in +Python 3.6.

    • +
    • bpo-23671: string.Template now allows specifying the “self” parameter as a +keyword argument. string.Formatter now allows specifying the “self” and +the “format_string” parameters as keyword arguments.

    • +
    • bpo-23502: The pprint module now supports mapping proxies.

    • +
    • bpo-17530: pprint now wraps long bytes objects and bytearrays.

    • +
    • bpo-22687: Fixed some corner cases in breaking words in tetxtwrap. Got rid +of quadratic complexity in breaking long words.

    • +
    • bpo-4727: The copy module now uses pickle protocol 4 (PEP 3154) and +supports copying of instances of classes whose __new__ method takes +keyword-only arguments.

    • +
    • bpo-23491: Added a zipapp module to support creating executable zip file +archives of Python code. Registered “.pyz” and “.pyzw” extensions on +Windows for these archives (PEP 441).

    • +
    • bpo-23657: Avoid explicit checks for str in zipapp, adding support for +pathlib.Path objects as arguments.

    • +
    • bpo-23688: Added support of arbitrary bytes-like objects and avoided +unnecessary copying of memoryview in gzip.GzipFile.write(). Original patch +by Wolfgang Maier.

    • +
    • bpo-23252: Added support for writing ZIP files to unseekable streams.

    • +
    • bpo-23647: Increase imaplib’s MAXLINE to accommodate modern mailbox sizes.

    • +
    • bpo-23539: If body is None, http.client.HTTPConnection.request now sets +Content-Length to 0 for PUT, POST, and PATCH headers to avoid 411 errors +from some web servers.

    • +
    • bpo-22351: The nntplib.NNTP constructor no longer leaves the connection +and socket open until the garbage collector cleans them up. Patch by +Martin Panter.

    • +
    • bpo-23704: collections.deque() objects now support methods for index(), +insert(), and copy(). This allows deques to be registered as a +MutableSequence and it improves their substitutability for lists.

    • +
    • bpo-23715: signal.sigwaitinfo() and signal.sigtimedwait() are +now retried when interrupted by a signal not in the sigset parameter, if +the signal handler does not raise an exception. signal.sigtimedwait() +recomputes the timeout with a monotonic clock when it is retried.

    • +
    • bpo-23001: Few functions in modules mmap, ossaudiodev, socket, ssl, and +codecs, that accepted only read-only bytes-like object now accept writable +bytes-like object too.

    • +
    • bpo-23646: If time.sleep() is interrupted by a signal, the sleep is now +retried with the recomputed delay, except if the signal handler raises an +exception (PEP 475).

    • +
    • bpo-23136: _strptime now uniformly handles all days in week 0, including +Dec 30 of previous year. Based on patch by Jim Carroll.

    • +
    • bpo-23700: Iterator of NamedTemporaryFile now keeps a reference to +NamedTemporaryFile instance. Patch by Bohuslav Kabrda.

    • +
    • bpo-22903: The fake test case created by unittest.loader when it fails +importing a test module is now picklable.

    • +
    • bpo-22181: On Linux, os.urandom() now uses the new getrandom() syscall if +available, syscall introduced in the Linux kernel 3.17. It is more +reliable and more secure, because it avoids the need of a file descriptor +and waits until the kernel has enough entropy.

    • +
    • bpo-2211: Updated the implementation of the http.cookies.Morsel class. +Setting attributes key, value and coded_value directly now is deprecated. +update() and setdefault() now transform and check keys. Comparing for +equality now takes into account attributes key, value and coded_value. +copy() now returns a Morsel, not a dict. repr() now contains all +attributes. Optimized checking keys and quoting values. Added new tests. +Original patch by Demian Brecht.

    • +
    • bpo-18983: Allow selection of output units in timeit. Patch by Julian +Gindi.

    • +
    • bpo-23631: Fix traceback.format_list when a traceback has been mutated.

    • +
    • bpo-23568: Add rdivmod support to MagicMock() objects. Patch by Håkan +Lövdahl.

    • +
    • bpo-2052: Add charset parameter to HtmlDiff.make_file().

    • +
    • bpo-23668: Support os.truncate and os.ftruncate on Windows.

    • +
    • bpo-23138: Fixed parsing cookies with absent keys or values in cookiejar. +Patch by Demian Brecht.

    • +
    • bpo-23051: multiprocessing.Pool methods imap() and imap_unordered() now +handle exceptions raised by an iterator. Patch by Alon Diamant and Davin +Potts.

    • +
    • bpo-23581: Add matmul support to MagicMock. Patch by Håkan Lövdahl.

    • +
    • bpo-23566: enable(), register(), dump_traceback() and +dump_traceback_later() functions of faulthandler now accept file +descriptors. Patch by Wei Wu.

    • +
    • bpo-22928: Disabled HTTP header injections in http.client. Original patch +by Demian Brecht.

    • +
    • bpo-23615: Modules bz2, tarfile and tokenize now can be reloaded with +imp.reload(). Patch by Thomas Kluyver.

    • +
    • bpo-23605: os.walk() now calls os.scandir() instead of os.listdir(). The +usage of os.scandir() reduces the number of calls to os.stat(). Initial +patch written by Ben Hoyt.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-23585: make patchcheck will ensure the interpreter is built.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-23583: Added tests for standard IO streams in IDLE.

    • +
    • bpo-22289: Prevent test_urllib2net failures due to ftp connection timeout.

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-22826: The result of open() in Tools/freeze/bkfile.py is now better +compatible with regular files (in particular it now supports the context +management protocol).

    • +
    +
    +
    +
    +

    Python 3.5.0 alpha 2

    +

    Release date: 2015-03-09

    +
    +

    Core and Builtins

    +
      +
    • bpo-23571: PyObject_Call() and PyCFunction_Call() now raise a SystemError +if a function returns a result and raises an exception. The SystemError is +chained to the previous exception.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-22524: New os.scandir() function, part of the PEP 471: “os.scandir() +function – a better and faster directory iterator”. Patch written by Ben +Hoyt.

    • +
    • bpo-23103: Reduced the memory consumption of IPv4Address and IPv6Address.

    • +
    • bpo-21793: BaseHTTPRequestHandler again logs response code as numeric, not +as stringified enum. Patch by Demian Brecht.

    • +
    • bpo-23476: In the ssl module, enable OpenSSL’s X509_V_FLAG_TRUSTED_FIRST +flag on certificate stores when it is available.

    • +
    • bpo-23576: Avoid stalling in SSL reads when EOF has been reached in the +SSL layer but the underlying connection hasn’t been closed.

    • +
    • bpo-23504: Added an __all__ to the types module.

    • +
    • bpo-23563: Optimized utility functions in urllib.parse.

    • +
    • bpo-7830: Flatten nested functools.partial.

    • +
    • bpo-20204: Added the __module__ attribute to _tkinter classes.

    • +
    • bpo-19980: Improved help() for non-recognized strings. help(‘’) now shows +the help on str. help(‘help’) now shows the help on help(). Original +patch by Mark Lawrence.

    • +
    • bpo-23521: Corrected pure python implementation of timedelta division.

      +

      Eliminated OverflowError from timedelta * float for some floats; +Corrected rounding in timedelta true division.

      +
    • +
    • bpo-21619: Popen objects no longer leave a zombie after exit in the with +statement if the pipe was broken. Patch by Martin Panter.

    • +
    • bpo-22936: Make it possible to show local variables in tracebacks for both +the traceback module and unittest.

    • +
    • bpo-15955: Add an option to limit the output size in bz2.decompress(). +Patch by Nikolaus Rath.

    • +
    • bpo-6639: Module-level turtle functions no longer raise TclError after +closing the window.

    • +
    • bpo-814253: Group references and conditional group references now work in +lookbehind assertions in regular expressions. (See also: bpo-9179)

    • +
    • bpo-23215: Multibyte codecs with custom error handlers that ignores errors +consumed too much memory and raised SystemError or MemoryError. Original +patch by Aleksi Torhamo.

    • +
    • bpo-5700: io.FileIO() called flush() after closing the file. flush() was +not called in close() if closefd=False.

    • +
    • bpo-23374: Fixed pydoc failure with non-ASCII files when stdout encoding +differs from file system encoding (e.g. on Mac OS).

    • +
    • bpo-23481: Remove RC4 from the SSL module’s default cipher list.

    • +
    • bpo-21548: Fix pydoc.synopsis() and pydoc.apropos() on modules with empty +docstrings.

    • +
    • bpo-22885: Fixed arbitrary code execution vulnerability in the dbm.dumb +module. Original patch by Claudiu Popa.

    • +
    • bpo-23239: ssl.match_hostname() now supports matching of IP addresses.

    • +
    • bpo-23146: Fix mishandling of absolute Windows paths with forward slashes +in pathlib.

    • +
    • bpo-23096: Pickle representation of floats with protocol 0 now is the same +for both Python and C implementations.

    • +
    • bpo-19105: pprint now more efficiently uses free space at the right.

    • +
    • bpo-14910: Add allow_abbrev parameter to argparse.ArgumentParser. Patch by +Jonathan Paugh, Steven Bethard, paul j3 and Daniel Eriksson.

    • +
    • bpo-21717: tarfile.open() now supports ‘x’ (exclusive creation) mode.

    • +
    • bpo-23344: marshal.dumps() is now 20-25% faster on average.

    • +
    • bpo-20416: marshal.dumps() with protocols 3 and 4 is now 40-50% faster on +average.

    • +
    • bpo-23421: Fixed compression in tarfile CLI. Patch by wdv4758h.

    • +
    • bpo-23367: Fix possible overflows in the unicodedata module.

    • +
    • bpo-23361: Fix possible overflow in Windows subprocess creation code.

    • +
    • logging.handlers.QueueListener now takes a respect_handler_level keyword +argument which, if set to True, will pass messages to handlers taking +handler levels into account.

    • +
    • bpo-19705: turtledemo now has a visual sorting algorithm demo. Original +patch from Jason Yeo.

    • +
    • bpo-23801: Fix issue where cgi.FieldStorage did not always ignore the +entire preamble to a multipart body.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-23445: pydebug builds now use “gcc -Og” where possible, to make the +resulting executable faster.

    • +
    • bpo-23686: Update OS X 10.5 installer build to use OpenSSL 1.0.2a.

    • +
    +
    +
    +

    C API

    +
      +
    • bpo-20204: Deprecation warning is now raised for builtin types without the +__module__ attribute.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-23465: Implement PEP 486 - Make the Python Launcher aware of virtual +environments. Patch by Paul Moore.

    • +
    • bpo-23437: Make user scripts directory versioned on Windows. Patch by Paul +Moore.

    • +
    +
    +
    +
    +

    Python 3.5.0 alpha 1

    +

    Release date: 2015-02-08

    +
    +

    Core and Builtins

    +
      +
    • bpo-23285: PEP 475 - EINTR handling.

    • +
    • bpo-22735: Fix many edge cases (including crashes) involving custom mro() +implementations.

    • +
    • bpo-22896: Avoid using PyObject_AsCharBuffer(), PyObject_AsReadBuffer() +and PyObject_AsWriteBuffer().

    • +
    • bpo-21295: Revert some changes (bpo-16795) to AST line numbers and +column offsets that constituted a regression.

    • +
    • bpo-22986: Allow changing an object’s __class__ between a dynamic type and +static type in some cases.

    • +
    • bpo-15859: PyUnicode_EncodeFSDefault(), PyUnicode_EncodeMBCS() and +PyUnicode_EncodeCodePage() now raise an exception if the object is not a +Unicode object. For PyUnicode_EncodeFSDefault(), it was already the case +on platforms other than Windows. Patch written by Campbell Barton.

    • +
    • bpo-21408: The default __ne__() now returns NotImplemented if __eq__() +returned NotImplemented. Original patch by Martin Panter.

    • +
    • bpo-23321: Fixed a crash in str.decode() when error handler returned +replacement string longer than malformed input data.

    • +
    • bpo-22286: The “backslashreplace” error handlers now works with decoding +and translating.

    • +
    • bpo-23253: Delay-load ShellExecute[AW] in os.startfile for reduced startup +overhead on Windows.

    • +
    • bpo-22038: pyatomic.h now uses stdatomic.h or GCC built-in functions for +atomic memory access if available. Patch written by Vitor de Lima and +Gustavo Temple.

    • +
    • bpo-20284: %-interpolation (aka printf) formatting added for bytes and +bytearray.

    • +
    • bpo-23048: Fix jumping out of an infinite while loop in the pdb.

    • +
    • bpo-20335: bytes constructor now raises TypeError when encoding or errors +is specified with non-string argument. Based on patch by Renaud Blanch.

    • +
    • bpo-22834: If the current working directory ends up being set to a +non-existent directory then import will no longer raise FileNotFoundError.

    • +
    • bpo-22869: Move the interpreter startup & shutdown code to a new dedicated +pylifecycle.c module

    • +
    • bpo-22847: Improve method cache efficiency.

    • +
    • bpo-22335: Fix crash when trying to enlarge a bytearray to 0x7fffffff +bytes on a 32-bit platform.

    • +
    • bpo-22653: Fix an assertion failure in debug mode when doing a reentrant +dict insertion in debug mode.

    • +
    • bpo-22643: Fix integer overflow in Unicode case operations (upper, lower, +title, swapcase, casefold).

    • +
    • bpo-17636: Circular imports involving relative imports are now supported.

    • +
    • bpo-22604: Fix assertion error in debug mode when dividing a complex +number by (nan+0j).

    • +
    • bpo-21052: Do not raise ImportWarning when sys.path_hooks or sys.meta_path +are set to None.

    • +
    • bpo-16518: Use ‘bytes-like object required’ in error messages that +previously used the far more cryptic “‘x’ does not support the buffer +protocol.

    • +
    • bpo-22470: Fixed integer overflow issues in “backslashreplace”, +“xmlcharrefreplace”, and “surrogatepass” error handlers.

    • +
    • bpo-22540: speed up PyObject_IsInstance and PyObject_IsSubclass in the +common case that the second argument has metaclass type.

    • +
    • bpo-18711: Add a new PyErr_FormatV function, similar to PyErr_Format +but accepting a va_list argument.

    • +
    • bpo-22520: Fix overflow checking when generating the repr of a unicode +object.

    • +
    • bpo-22519: Fix overflow checking in PyBytes_Repr.

    • +
    • bpo-22518: Fix integer overflow issues in latin-1 encoding.

    • +
    • bpo-16324: _charset parameter of MIMEText now also accepts +email.charset.Charset instances. Initial patch by Claude Paroz.

    • +
    • bpo-1764286: Fix inspect.getsource() to support decorated functions. Patch +by Claudiu Popa.

    • +
    • bpo-18554: os.__all__ includes posix functions.

    • +
    • bpo-21391: Use os.path.abspath in the shutil module.

    • +
    • bpo-11471: avoid generating a JUMP_FORWARD instruction at the end of an +if-block if there is no else-clause. Original patch by Eugene Toder.

    • +
    • bpo-22215: Now ValueError is raised instead of TypeError when str or bytes +argument contains not permitted null character or byte.

    • +
    • bpo-22258: Fix the internal function set_inheritable() on Illumos. This +platform exposes the function ioctl(FIOCLEX), but calling it fails +with errno is ENOTTY: “Inappropriate ioctl for device”. set_inheritable() +now falls back to the slower fcntl() (F_GETFD and then +F_SETFD).

    • +
    • bpo-21389: Displaying the __qualname__ of the underlying function in the +repr of a bound method.

    • +
    • bpo-22206: Using pthread, PyThread_create_key() now sets errno to ENOMEM +and returns -1 (error) on integer overflow.

    • +
    • bpo-20184: Argument Clinic based signature introspection added for 30 of +the builtin functions.

    • +
    • bpo-22116: C functions and methods (of the ‘builtin_function_or_method’ +type) can now be weakref’ed. Patch by Wei Wu.

    • +
    • bpo-22077: Improve index error messages for bytearrays, bytes, lists, and +tuples by adding ‘or slices’. Added ‘, not <typename>’ for bytearrays. +Original patch by Claudiu Popa.

    • +
    • bpo-20179: Apply Argument Clinic to bytes and bytearray. Patch by Tal +Einat.

    • +
    • bpo-22082: Clear interned strings in slotdefs.

    • +
    • Upgrade Unicode database to Unicode 7.0.0.

    • +
    • bpo-21897: Fix a crash with the f_locals attribute with closure variables +when frame.clear() has been called.

    • +
    • bpo-21205: Add a new __qualname__ attribute to generator, the +qualified name, and use it in the representation of a generator +(repr(gen)). The default name of the generator (__name__ +attribute) is now get from the function instead of the code. Use +gen.gi_code.co_name to get the name of the code.

    • +
    • bpo-21669: With the aid of heuristics in SyntaxError.__init__, the parser +now attempts to generate more meaningful (or at least more search engine +friendly) error messages when “exec” and “print” are used as statements.

    • +
    • bpo-21642: In the conditional if-else expression, allow an integer written +with no space between itself and the else keyword (e.g. True if +42else False) to be valid syntax.

    • +
    • bpo-21523: Fix over-pessimistic computation of the stack effect of some +opcodes in the compiler. This also fixes a quadratic compilation time +issue noticeable when compiling code with a large number of “and” and “or” +operators.

    • +
    • bpo-21418: Fix a crash in the builtin function super() when called without +argument and without current frame (ex: embedded Python).

    • +
    • bpo-21425: Fix flushing of standard streams in the interactive +interpreter.

    • +
    • bpo-21435: In rare cases, when running finalizers on objects in cyclic +trash a bad pointer dereference could occur due to a subtle flaw in +internal iteration logic.

    • +
    • bpo-21377: PyBytes_Concat() now tries to concatenate in-place when the +first argument has a reference count of 1. Patch by Nikolaus Rath.

    • +
    • bpo-20355: -W command line options now have higher priority than the +PYTHONWARNINGS environment variable. Patch by Arfrever.

    • +
    • bpo-21274: Define PATH_MAX for GNU/Hurd in Python/pythonrun.c.

    • +
    • bpo-20904: Support setting FPU precision on m68k.

    • +
    • bpo-21209: Fix sending tuples to custom generator objects with the yield +from syntax.

    • +
    • bpo-21193: pow(a, b, c) now raises ValueError rather than TypeError when b +is negative. Patch by Josh Rosenberg.

    • +
    • bpo-21176: PEP 465: Add the ‘@’ operator for matrix multiplication.

    • +
    • bpo-21134: Fix segfault when str is called on an uninitialized +UnicodeEncodeError, UnicodeDecodeError, or UnicodeTranslateError object.

    • +
    • bpo-19537: Fix PyUnicode_DATA() alignment under m68k. Patch by Andreas +Schwab.

    • +
    • bpo-20929: Add a type cast to avoid shifting a negative number.

    • +
    • bpo-20731: Properly position in source code files even if they are opened +in text mode. Patch by Serhiy Storchaka.

    • +
    • bpo-20637: Key-sharing now also works for instance dictionaries of +subclasses. Patch by Peter Ingebretson.

    • +
    • bpo-8297: Attributes missing from modules now include the module name in +the error text. Original patch by ysj.ray.

    • +
    • bpo-19995: %c, %o, %x, and %X now raise TypeError on non-integer input.

    • +
    • bpo-19655: The ASDL parser - used by the build process to generate code +for managing the Python AST in C - was rewritten. The new parser is self +contained and does not require to carry long the spark.py parser-generator +library; spark.py was removed from the source base.

    • +
    • bpo-12546: Allow \x00 to be used as a fill character when using str, +int, float, and complex __format__ methods.

    • +
    • bpo-20480: Add ipaddress.reverse_pointer. Patch by Leon Weber.

    • +
    • bpo-13598: Modify string.Formatter to support auto-numbering of +replacement fields. It now matches the behavior of str.format() in this +regard. Patches by Phil Elson and Ramchandra Apte.

    • +
    • bpo-8931: Make alternate formatting (‘#’) for type ‘c’ raise an exception. +In versions prior to 3.5, ‘#’ with ‘c’ had no effect. Now specifying it is +an error. Patch by Torsten Landschoff.

    • +
    • bpo-23165: Perform overflow checks before allocating memory in the +_Py_char2wchar function.

    • +
    +
    +
    +

    Library

    +
      +
    • bpo-23399: pyvenv creates relative symlinks where possible.

    • +
    • bpo-20289: cgi.FieldStorage() now supports the context management +protocol.

    • +
    • bpo-13128: Print response headers for CONNECT requests when debuglevel > +0. Patch by Demian Brecht.

    • +
    • bpo-15381: Optimized io.BytesIO to make less allocations and copyings.

    • +
    • bpo-22818: Splitting on a pattern that could match an empty string now +raises a warning. Patterns that can only match empty strings are now +rejected.

    • +
    • bpo-23099: Closing io.BytesIO with exported buffer is rejected now to +prevent corrupting exported buffer.

    • +
    • bpo-23326: Removed __ne__ implementations. Since fixing default __ne__ +implementation in bpo-21408 they are redundant.

    • +
    • bpo-23363: Fix possible overflow in itertools.permutations.

    • +
    • bpo-23364: Fix possible overflow in itertools.product.

    • +
    • bpo-23366: Fixed possible integer overflow in itertools.combinations.

    • +
    • bpo-23369: Fixed possible integer overflow in +_json.encode_basestring_ascii.

    • +
    • bpo-23353: Fix the exception handling of generators in +PyEval_EvalFrameEx(). At entry, save or swap the exception state even if +PyEval_EvalFrameEx() is called with throwflag=0. At exit, the exception +state is now always restored or swapped, not only if why is WHY_YIELD or +WHY_RETURN. Patch co-written with Antoine Pitrou.

    • +
    • bpo-14099: Restored support of writing ZIP files to tellable but +non-seekable streams.

    • +
    • bpo-14099: Writing to ZipFile and reading multiple ZipExtFiles is +threadsafe now.

    • +
    • bpo-19361: JSON decoder now raises JSONDecodeError instead of ValueError.

    • +
    • bpo-18518: timeit now rejects statements which can’t be compiled outside a +function or a loop (e.g. “return” or “break”).

    • +
    • bpo-23094: Fixed readline with frames in Python implementation of pickle.

    • +
    • bpo-23268: Fixed bugs in the comparison of ipaddress classes.

    • +
    • bpo-21408: Removed incorrect implementations of __ne__() which didn’t +returned NotImplemented if __eq__() returned NotImplemented. The default +__ne__() now works correctly.

    • +
    • bpo-19996: email.feedparser.FeedParser now handles (malformed) +headers with no key rather than assuming the body has started.

    • +
    • bpo-20188: Support Application-Layer Protocol Negotiation (ALPN) in the +ssl module.

    • +
    • bpo-23133: Pickling of ipaddress objects now produces more compact and +portable representation.

    • +
    • bpo-23248: Update ssl error codes from latest OpenSSL git master.

    • +
    • bpo-23266: Much faster implementation of ipaddress.collapse_addresses() +when there are many non-consecutive addresses.

    • +
    • bpo-23098: 64-bit dev_t is now supported in the os module.

    • +
    • bpo-21817: When an exception is raised in a task submitted to a +ProcessPoolExecutor, the remote traceback is now displayed in the parent +process. Patch by Claudiu Popa.

    • +
    • bpo-15955: Add an option to limit output size when decompressing LZMA +data. Patch by Nikolaus Rath and Martin Panter.

    • +
    • bpo-23250: In the http.cookies module, capitalize “HttpOnly” and “Secure” +as they are written in the standard.

    • +
    • bpo-23063: In the distutils’ check command, fix parsing of reST with code +or code-block directives.

    • +
    • bpo-23209: selectors.BaseSelector.get_key() now raises a RuntimeError if +the selector is closed. And selectors.BaseSelector.close() now clears its +internal reference to the selector mapping to break a reference cycle. +Initial patch written by Martin Richard. (See also: bpo-23225)

    • +
    • bpo-17911: Provide a way to seed the linecache for a PEP-302 module +without actually loading the code.

    • +
    • bpo-17911: Provide a new object API for traceback, including the ability +to not lookup lines at all until the traceback is actually rendered, +without any trace of the original objects being kept alive.

    • +
    • bpo-19777: Provide a home() classmethod on Path objects. Contributed by +Victor Salgado and Mayank Tripathi.

    • +
    • bpo-23206: Make json.dumps(..., ensure_ascii=False) as fast as the +default case of ensure_ascii=True. Patch by Naoki Inada.

    • +
    • bpo-23185: Add math.inf and math.nan constants.

    • +
    • bpo-23186: Add ssl.SSLObject.shared_ciphers() and +ssl.SSLSocket.shared_ciphers() to fetch the client’s list ciphers sent at +handshake.

    • +
    • bpo-23143: Remove compatibility with OpenSSLs older than 0.9.8.

    • +
    • bpo-23132: Improve performance and introspection support of comparison +methods created by functool.total_ordering.

    • +
    • bpo-19776: Add an expanduser() method on Path objects.

    • +
    • bpo-23112: Fix SimpleHTTPServer to correctly carry the query string and +fragment when it redirects to add a trailing slash.

    • +
    • bpo-21793: Added http.HTTPStatus enums (i.e. HTTPStatus.OK, +HTTPStatus.NOT_FOUND). Patch by Demian Brecht.

    • +
    • bpo-23093: In the io, module allow more operations to work on detached +streams.

    • +
    • bpo-23111: In the ftplib, make ssl.PROTOCOL_SSLv23 the default protocol +version.

    • +
    • bpo-22585: On OpenBSD 5.6 and newer, os.urandom() now calls getentropy(), +instead of reading /dev/urandom, to get pseudo-random bytes.

    • +
    • bpo-19104: pprint now produces evaluable output for wrapped strings.

    • +
    • bpo-23071: Added missing names to codecs.__all__. Patch by Martin Panter.

    • +
    • bpo-22783: Pickling now uses the NEWOBJ opcode instead of the NEWOBJ_EX +opcode if possible.

    • +
    • bpo-15513: Added a __sizeof__ implementation for pickle classes.

    • +
    • bpo-19858: pickletools.optimize() now aware of the MEMOIZE opcode, can +produce more compact result and no longer produces invalid output if input +data contains MEMOIZE opcodes together with PUT or BINPUT opcodes.

    • +
    • bpo-22095: Fixed HTTPConnection.set_tunnel with default port. The port +value in the host header was set to “None”. Patch by Demian Brecht.

    • +
    • bpo-23016: A warning no longer produces an AttributeError when the program +is run with pythonw.exe.

    • +
    • bpo-21775: shutil.copytree(): fix crash when copying to VFAT. An exception +handler assumed that OSError objects always have a ‘winerror’ attribute. +That is not the case, so the exception handler itself raised +AttributeError when run on Linux (and, presumably, any other non-Windows +OS). Patch by Greg Ward.

    • +
    • bpo-1218234: Fix inspect.getsource() to load updated source of reloaded +module. Initial patch by Berker Peksag.

    • +
    • bpo-21740: Support wrapped callables in doctest. Patch by Claudiu Popa.

    • +
    • bpo-23009: Make sure selectors.EpollSelecrtor.select() works when no FD is +registered.

    • +
    • bpo-22959: In the constructor of http.client.HTTPSConnection, prefer the +context’s check_hostname attribute over the check_hostname parameter.

    • +
    • bpo-22696: Add function sys.is_finalizing() to know about +interpreter shutdown.

    • +
    • bpo-16043: Add a default limit for the amount of data +xmlrpclib.gzip_decode will return. This resolves CVE-2013-1753.

    • +
    • bpo-14099: ZipFile.open() no longer reopen the underlying file. Objects +returned by ZipFile.open() can now operate independently of the ZipFile +even if the ZipFile was created by passing in a file-like object as the +first argument to the constructor.

    • +
    • bpo-22966: Fix __pycache__ pyc file name clobber when pyc_compile is asked +to compile a source file containing multiple dots in the source file name.

    • +
    • bpo-21971: Update turtledemo doc and add module to the index.

    • +
    • bpo-21032: Fixed socket leak if HTTPConnection.getresponse() fails. +Original patch by Martin Panter.

    • +
    • bpo-22407: Deprecated the use of re.LOCALE flag with str patterns or +re.ASCII. It was newer worked.

    • +
    • bpo-22902: The “ip” command is now used on Linux to determine MAC address +in uuid.getnode(). Pach by Bruno Cauet.

    • +
    • bpo-22960: Add a context argument to xmlrpclib.ServerProxy constructor.

    • +
    • bpo-22389: Add contextlib.redirect_stderr().

    • +
    • bpo-21356: Make ssl.RAND_egd() optional to support LibreSSL. The +availability of the function is checked during the compilation. Patch +written by Bernard Spil.

    • +
    • bpo-22915: SAX parser now supports files opened with file descriptor or +bytes path.

    • +
    • bpo-22609: Constructors and update methods of mapping classes in the +collections module now accept the self keyword argument.

    • +
    • bpo-22940: Add readline.append_history_file.

    • +
    • bpo-19676: Added the “namereplace” error handler.

    • +
    • bpo-22788: Add context parameter to logging.handlers.HTTPHandler.

    • +
    • bpo-22921: Allow SSLContext to take the hostname parameter even if +OpenSSL doesn’t support SNI.

    • +
    • bpo-22894: TestCase.subTest() would cause the test suite to be stopped +when in failfast mode, even in the absence of failures.

    • +
    • bpo-22796: HTTP cookie parsing is now stricter, in order to protect +against potential injection attacks.

    • +
    • bpo-22370: Windows detection in pathlib is now more robust.

    • +
    • bpo-22841: Reject coroutines in asyncio add_signal_handler(). Patch by +Ludovic.Gasc.

    • +
    • bpo-19494: Added urllib.request.HTTPBasicPriorAuthHandler. Patch by Matej +Cepl.

    • +
    • bpo-22578: Added attributes to the re.error class.

    • +
    • bpo-22849: Fix possible double free in the io.TextIOWrapper constructor.

    • +
    • bpo-12728: Different Unicode characters having the same uppercase but +different lowercase are now matched in case-insensitive regular +expressions.

    • +
    • bpo-22821: Fixed fcntl() with integer argument on 64-bit big-endian +platforms.

    • +
    • bpo-21650: Add an --sort-keys option to json.tool CLI.

    • +
    • bpo-22824: Updated reprlib output format for sets to use set literals. +Patch contributed by Berker Peksag.

    • +
    • bpo-22824: Updated reprlib output format for arrays to display empty +arrays without an unnecessary empty list. Suggested by Serhiy Storchaka.

    • +
    • bpo-22406: Fixed the uu_codec codec incorrectly ported to 3.x. Based on +patch by Martin Panter.

    • +
    • bpo-17293: uuid.getnode() now determines MAC address on AIX using netstat. +Based on patch by Aivars Kalvāns.

    • +
    • bpo-22769: Fixed ttk.Treeview.tag_has() when called without arguments.

    • +
    • bpo-22417: Verify certificates by default in httplib (PEP 476).

    • +
    • bpo-22775: Fixed unpickling of http.cookies.SimpleCookie with protocol 2 +and above. Patch by Tim Graham.

    • +
    • bpo-22776: Brought excluded code into the scope of a try block in +SysLogHandler.emit().

    • +
    • bpo-22665: Add missing get_terminal_size and SameFileError to +shutil.__all__.

    • +
    • bpo-6623: Remove deprecated Netrc class in the ftplib module. Patch by +Matt Chaput.

    • +
    • bpo-17381: Fixed handling of case-insensitive ranges in regular +expressions.

    • +
    • bpo-22410: Module level functions in the re module now cache compiled +locale-dependent regular expressions taking into account the locale.

    • +
    • bpo-22759: Query methods on pathlib.Path() (exists(), is_dir(), etc.) now +return False when the underlying stat call raises NotADirectoryError.

    • +
    • bpo-8876: distutils now falls back to copying files when hard linking +doesn’t work. This allows use with special filesystems such as VirtualBox +shared folders.

    • +
    • bpo-22217: Implemented reprs of classes in the zipfile module.

    • +
    • bpo-22457: Honour load_tests in the start_dir of discovery.

    • +
    • bpo-18216: gettext now raises an error when a .mo file has an unsupported +major version number. Patch by Aaron Hill.

    • +
    • bpo-13918: Provide a locale.delocalize() function which can remove +locale-specific number formatting from a string representing a number, +without then converting it to a specific type. Patch by Cédric Krier.

    • +
    • bpo-22676: Make the pickling of global objects which don’t have a +__module__ attribute less slow.

    • +
    • bpo-18853: Fixed ResourceWarning in shlex.__nain__.

    • +
    • bpo-9351: Defaults set with set_defaults on an argparse subparser are no +longer ignored when also set on the parent parser.

    • +
    • bpo-7559: unittest test loading ImportErrors are reported as import errors +with their import exception rather than as attribute errors after the +import has already failed.

    • +
    • bpo-19746: Make it possible to examine the errors from unittest discovery +without executing the test suite. The new errors attribute on TestLoader +exposes these non-fatal errors encountered during discovery.

    • +
    • bpo-21991: Make email.headerregistry’s header ‘params’ attributes be +read-only (MappingProxyType). Previously the dictionary was modifiable +but a new one was created on each access of the attribute.

    • +
    • bpo-22638: SSLv3 is now disabled throughout the standard library. It can +still be enabled by instantiating a SSLContext manually.

    • +
    • bpo-22641: In asyncio, the default SSL context for client connections is +now created using ssl.create_default_context(), for stronger security.

    • +
    • bpo-17401: Include closefd in io.FileIO repr.

    • +
    • bpo-21338: Add silent mode for compileall. quiet parameters of +compile_{dir, file, path} functions now have a multilevel value. Also, -q +option of the CLI now have a multilevel value. Patch by Thomas Kluyver.

    • +
    • bpo-20152: Convert the array and cmath modules to Argument Clinic.

    • +
    • bpo-18643: Add socket.socketpair() on Windows.

    • +
    • bpo-22435: Fix a file descriptor leak when socketserver bind fails.

    • +
    • bpo-13096: Fixed segfault in CTypes POINTER handling of large values.

    • +
    • bpo-11694: Raise ConversionError in xdrlib as documented. Patch by Filip +Gruszczyński and Claudiu Popa.

    • +
    • bpo-19380: Optimized parsing of regular expressions.

    • +
    • bpo-1519638: Now unmatched groups are replaced with empty strings in +re.sub() and re.subn().

    • +
    • bpo-18615: sndhdr.what/whathdr now return a namedtuple.

    • +
    • bpo-22462: Fix pyexpat’s creation of a dummy frame to make it appear in +exception tracebacks.

    • +
    • bpo-21965: Add support for in-memory SSL to the ssl module. Patch by +Geert Jansen.

    • +
    • bpo-21173: Fix len() on a WeakKeyDictionary when .clear() was called with +an iterator alive.

    • +
    • bpo-11866: Eliminated race condition in the computation of names for new +threads.

    • +
    • bpo-21905: Avoid RuntimeError in pickle.whichmodule() when sys.modules is +mutated while iterating. Patch by Olivier Grisel.

    • +
    • bpo-11271: concurrent.futures.Executor.map() now takes a chunksize +argument to allow batching of tasks in child processes and improve +performance of ProcessPoolExecutor. Patch by Dan O’Reilly.

    • +
    • bpo-21883: os.path.join() and os.path.relpath() now raise a TypeError with +more helpful error message for unsupported or mismatched types of +arguments.

    • +
    • bpo-22219: The zipfile module CLI now adds entries for directories +(including empty directories) in ZIP file.

    • +
    • bpo-22449: In the ssl.SSLContext.load_default_certs, consult the +environmental variables SSL_CERT_DIR and SSL_CERT_FILE on Windows.

    • +
    • bpo-22508: The email.__version__ variable has been removed; the email code +is no longer shipped separately from the stdlib, and __version__ hasn’t +been updated in several releases.

    • +
    • bpo-20076: Added non derived UTF-8 aliases to locale aliases table.

    • +
    • bpo-20079: Added locales supported in glibc 2.18 to locale alias table.

    • +
    • bpo-20218: Added convenience methods read_text/write_text and read_bytes/ +write_bytes to pathlib.Path objects.

    • +
    • bpo-22396: On 32-bit AIX platform, don’t expose os.posix_fadvise() nor +os.posix_fallocate() because their prototypes in system headers are wrong.

    • +
    • bpo-22517: When an io.BufferedRWPair object is deallocated, clear its +weakrefs.

    • +
    • bpo-22437: Number of capturing groups in regular expression is no longer +limited by 100.

    • +
    • bpo-17442: InteractiveInterpreter now displays the full chained traceback +in its showtraceback method, to match the built in interactive +interpreter.

    • +
    • bpo-23392: Added tests for marshal C API that works with FILE*.

    • +
    • bpo-10510: distutils register and upload methods now use HTML standards +compliant CRLF line endings.

    • +
    • bpo-9850: Fixed macpath.join() for empty first component. Patch by Oleg +Oshmyan.

    • +
    • bpo-5309: distutils’ build and build_ext commands now accept a -j +option to enable parallel building of extension modules.

    • +
    • bpo-22448: Improve canceled timer handles cleanup to prevent unbound +memory usage. Patch by Joshua Moore-Oliva.

    • +
    • bpo-22427: TemporaryDirectory no longer attempts to clean up twice when +used in the with statement in generator.

    • +
    • bpo-22362: Forbidden ambiguous octal escapes out of range 0-0o377 in +regular expressions.

    • +
    • bpo-20912: Now directories added to ZIP file have correct Unix and MS-DOS +directory attributes.

    • +
    • bpo-21866: ZipFile.close() no longer writes ZIP64 central directory +records if allowZip64 is false.

    • +
    • bpo-22278: Fix urljoin problem with relative urls, a regression observed +after changes to issue22118 were submitted.

    • +
    • bpo-22415: Fixed debugging output of the GROUPREF_EXISTS opcode in the re +module. Removed trailing spaces in debugging output.

    • +
    • bpo-22423: Unhandled exception in thread no longer causes unhandled +AttributeError when sys.stderr is None.

    • +
    • bpo-21332: Ensure that bufsize=1 in subprocess.Popen() selects line +buffering, rather than block buffering. Patch by Akira Li.

    • +
    • bpo-21091: Fix API bug: email.message.EmailMessage.is_attachment is now a +method.

    • +
    • bpo-21079: Fix email.message.EmailMessage.is_attachment to return the +correct result when the header has parameters as well as a value.

    • +
    • bpo-22247: Add NNTPError to nntplib.__all__.

    • +
    • bpo-22366: urllib.request.urlopen will accept a context object +(SSLContext) as an argument which will then be used for HTTPS connection. +Patch by Alex Gaynor.

    • +
    • bpo-4180: The warnings registries are now reset when the filters are +modified.

    • +
    • bpo-22419: Limit the length of incoming HTTP request in wsgiref server to +65536 bytes and send a 414 error code for higher lengths. Patch +contributed by Devin Cook.

    • +
    • Lax cookie parsing in http.cookies could be a security issue when combined +with non-standard cookie handling in some Web browsers. Reported by +Sergey Bobrov.

    • +
    • bpo-20537: logging methods now accept an exception instance as well as a +Boolean value or exception tuple. Thanks to Yury Selivanov for the patch.

    • +
    • bpo-22384: An exception in Tkinter callback no longer crashes the program +when it is run with pythonw.exe.

    • +
    • bpo-22168: Prevent turtle AttributeError with non-default Canvas on OS X.

    • +
    • bpo-21147: sqlite3 now raises an exception if the request contains a null +character instead of truncating it. Based on patch by Victor Stinner.

    • +
    • bpo-13968: The glob module now supports recursive search in subdirectories +using the ** pattern.

    • +
    • bpo-21951: Fixed a crash in Tkinter on AIX when called Tcl command with +empty string or tuple argument.

    • +
    • bpo-21951: Tkinter now most likely raises MemoryError instead of crash if +the memory allocation fails.

    • +
    • bpo-22338: Fix a crash in the json module on memory allocation failure.

    • +
    • bpo-12410: imaplib.IMAP4 now supports the context management protocol. +Original patch by Tarek Ziadé.

    • +
    • bpo-21270: We now override tuple methods in mock.call objects so that they +can be used as normal call attributes.

    • +
    • bpo-16662: load_tests() is now unconditionally run when it is present in a +package’s __init__.py. TestLoader.loadTestsFromModule() still accepts +use_load_tests, but it is deprecated and ignored. A new keyword-only +attribute pattern is added and documented. Patch given by Robert +Collins, tweaked by Barry Warsaw.

    • +
    • bpo-22226: First letter no longer is stripped from the “status” key in the +result of Treeview.heading().

    • +
    • bpo-19524: Fixed resource leak in the HTTP connection when an invalid +response is received. Patch by Martin Panter.

    • +
    • bpo-20421: Add a .version() method to SSL sockets exposing the actual +protocol version in use.

    • +
    • bpo-19546: configparser exceptions no longer expose implementation +details. Chained KeyErrors are removed, which leads to cleaner tracebacks. +Patch by Claudiu Popa.

    • +
    • bpo-22051: turtledemo no longer reloads examples to re-run them. +Initialization of variables and gui setup should be done in main(), which +is called each time a demo is run, but not on import.

    • +
    • bpo-21933: Turtledemo users can change the code font size with a menu +selection or control(command) ‘-‘ or ‘+’ or control-mousewheel. Original +patch by Lita Cho.

    • +
    • bpo-21597: The separator between the turtledemo text pane and the drawing +canvas can now be grabbed and dragged with a mouse. The code text pane +can be widened to easily view or copy the full width of the text. The +canvas can be widened on small screens. Original patches by Jan Kanis and +Lita Cho.

    • +
    • bpo-18132: Turtledemo buttons no longer disappear when the window is +shrunk. Original patches by Jan Kanis and Lita Cho.

    • +
    • bpo-22043: time.monotonic() is now always available. +threading.Lock.acquire(), threading.RLock.acquire() and socket +operations now use a monotonic clock, instead of the system clock, when a +timeout is used.

    • +
    • bpo-21527: Add a default number of workers to ThreadPoolExecutor equal to +5 times the number of CPUs. Patch by Claudiu Popa.

    • +
    • bpo-22216: smtplib now resets its state more completely after a quit. The +most obvious consequence of the previous behavior was a STARTTLS failure +during a connect/starttls/quit/connect/starttls sequence.

    • +
    • bpo-22098: ctypes’ BigEndianStructure and LittleEndianStructure now define +an empty __slots__ so that subclasses don’t always get an instance dict. +Patch by Claudiu Popa.

    • +
    • bpo-22185: Fix an occasional RuntimeError in threading.Condition.wait() +caused by mutation of the waiters queue without holding the lock. Patch +by Doug Zongker.

    • +
    • bpo-22287: On UNIX, _PyTime_gettimeofday() now uses +clock_gettime(CLOCK_REALTIME) if available. As a side effect, Python now +depends on the librt library on Solaris and on Linux (only with glibc +older than 2.17).

    • +
    • bpo-22182: Use e.args to unpack exceptions correctly in +distutils.file_util.move_file. Patch by Claudiu Popa.

    • +
    • The webbrowser module now uses subprocess’s start_new_session=True rather +than a potentially risky preexec_fn=os.setsid call.

    • +
    • bpo-22042: signal.set_wakeup_fd(fd) now raises an exception if the file +descriptor is in blocking mode.

    • +
    • bpo-16808: inspect.stack() now returns a named tuple instead of a tuple. +Patch by Daniel Shahaf.

    • +
    • bpo-22236: Fixed Tkinter images copying operations in NoDefaultRoot mode.

    • +
    • bpo-2527: Add a globals argument to timeit functions, in order to +override the globals namespace in which the timed code is executed. Patch +by Ben Roberts.

    • +
    • bpo-22118: Switch urllib.parse to use RFC 3986 semantics for the +resolution of relative URLs, rather than RFCs 1808 and 2396. Patch by +Demian Brecht.

    • +
    • bpo-21549: Added the “members” parameter to TarFile.list().

    • +
    • bpo-19628: Allow compileall recursion depth to be specified with a -r +option.

    • +
    • bpo-15696: Add a __sizeof__ implementation for mmap objects on Windows.

    • +
    • bpo-22068: Avoided reference loops with Variables and Fonts in Tkinter.

    • +
    • bpo-22165: SimpleHTTPRequestHandler now supports undecodable file names.

    • +
    • bpo-15381: Optimized line reading in io.BytesIO.

    • +
    • bpo-8797: Raise HTTPError on failed Basic Authentication immediately. +Initial patch by Sam Bull.

    • +
    • bpo-20729: Restored the use of lazy iterkeys()/itervalues()/iteritems() in +the mailbox module.

    • +
    • bpo-21448: Changed FeedParser feed() to avoid O(N**2) behavior when +parsing long line. Original patch by Raymond Hettinger.

    • +
    • bpo-22184: The functools LRU Cache decorator factory now gives an earlier +and clearer error message when the user forgets the required parameters.

    • +
    • bpo-17923: glob() patterns ending with a slash no longer match non-dirs on +AIX. Based on patch by Delhallt.

    • +
    • bpo-21725: Added support for RFC 6531 (SMTPUTF8) in smtpd.

    • +
    • bpo-22176: Update the ctypes module’s libffi to v3.1. This release adds +support for the Linux AArch64 and POWERPC ELF ABIv2 little endian +architectures.

    • +
    • bpo-5411: Added support for the “xztar” format in the shutil module.

    • +
    • bpo-21121: Don’t force 3rd party C extensions to be built with +-Werror=declaration-after-statement.

    • +
    • bpo-21975: Fixed crash when using uninitialized sqlite3.Row (in particular +when unpickling pickled sqlite3.Row). sqlite3.Row is now initialized in +the __new__() method.

    • +
    • bpo-20170: Convert posixmodule to use Argument Clinic.

    • +
    • bpo-21539: Add an exists_ok argument to Pathlib.mkdir() to mimic +mkdir -p and os.makedirs() functionality. When true, ignore +FileExistsErrors. Patch by Berker Peksag.

    • +
    • bpo-22127: Bypass IDNA for pure-ASCII host names in the socket module (in +particular for numeric IPs).

    • +
    • bpo-21047: set the default value for the convert_charrefs argument of +HTMLParser to True. Patch by Berker Peksag.

    • +
    • Add an __all__ to html.entities.

    • +
    • bpo-15114: the strict mode and argument of HTMLParser, HTMLParser.error, +and the HTMLParserError exception have been removed.

    • +
    • bpo-22085: Dropped support of Tk 8.3 in Tkinter.

    • +
    • bpo-21580: Now Tkinter correctly handles bytes arguments passed to Tk. In +particular this allows initializing images from binary data.

    • +
    • bpo-22003: When initialized from a bytes object, io.BytesIO() now defers +making a copy until it is mutated, improving performance and memory use on +some use cases. Patch by David Wilson.

    • +
    • bpo-22018: On Windows, signal.set_wakeup_fd() now also supports sockets. A +side effect is that Python depends to the WinSock library.

    • +
    • bpo-22054: Add os.get_blocking() and os.set_blocking() functions to get +and set the blocking mode of a file descriptor (False if the O_NONBLOCK +flag is set, True otherwise). These functions are not available on +Windows.

    • +
    • bpo-17172: Make turtledemo start as active on OS X even when run with +subprocess. Patch by Lita Cho.

    • +
    • bpo-21704: Fix build error for _multiprocessing when semaphores are not +available. Patch by Arfrever Frehtes Taifersar Arahesis.

    • +
    • bpo-20173: Convert sha1, sha256, sha512 and md5 to ArgumentClinic. Patch +by Vajrasky Kok.

    • +
    • Fix repr(_socket.socket) on Windows 64-bit: don’t fail with OverflowError +on closed socket. repr(socket.socket) already works fine.

    • +
    • bpo-22033: Reprs of most Python implemented classes now contain actual +class name instead of hardcoded one.

    • +
    • bpo-21947: The dis module can now disassemble generator-iterator objects +based on their gi_code attribute. Patch by Clement Rouault.

    • +
    • bpo-16133: The asynchat.async_chat.handle_read() method now ignores +BlockingIOError exceptions.

    • +
    • bpo-22044: Fixed premature DECREF in call_tzinfo_method. Patch by Tom +Flanagan.

    • +
    • bpo-19884: readline: Disable the meta modifier key if stdout is not a +terminal to not write the ANSI sequence "\033[1034h" into stdout. This +sequence is used on some terminal (ex: TERM=xterm-256color”) to enable +support of 8 bit characters.

    • +
    • bpo-4350: Removed a number of out-of-dated and non-working for a long time +Tkinter methods.

    • +
    • bpo-6167: Scrollbar.activate() now returns the name of active element if +the argument is not specified. Scrollbar.set() now always accepts only 2 +arguments.

    • +
    • bpo-15275: Clean up and speed up the ntpath module.

    • +
    • bpo-21888: plistlib’s load() and loads() now work if the fmt parameter is +specified.

    • +
    • bpo-22032: __qualname__ instead of __name__ is now always used to format +fully qualified class names of Python implemented classes.

    • +
    • bpo-22031: Reprs now always use hexadecimal format with the “0x” prefix +when contain an id in form ” at 0x…”.

    • +
    • bpo-22018: signal.set_wakeup_fd() now raises an OSError instead of a +ValueError on fstat() failure.

    • +
    • bpo-21044: tarfile.open() now handles fileobj with an integer ‘name’ +attribute. Based on patch by Antoine Pietri.

    • +
    • bpo-21966: Respect -q command-line option when code module is ran.

    • +
    • bpo-19076: Don’t pass the redundant ‘file’ argument to self.error().

    • +
    • bpo-16382: Improve exception message of warnings.warn() for bad category. +Initial patch by Phil Elson.

    • +
    • bpo-21932: os.read() now uses a Py_ssize_t() type instead of +int for the size to support reading more than 2 GB at once. On +Windows, the size is truncated to INT_MAX. As any call to os.read(), the +OS may read less bytes than the number of requested bytes.

    • +
    • bpo-21942: Fixed source file viewing in pydoc’s server mode on Windows.

    • +
    • bpo-11259: asynchat.async_chat().set_terminator() now raises a ValueError +if the number of received bytes is negative.

    • +
    • bpo-12523: asynchat.async_chat.push() now raises a TypeError if it doesn’t +get a bytes string

    • +
    • bpo-21707: Add missing kwonlyargcount argument to +ModuleFinder.replace_paths_in_code().

    • +
    • bpo-20639: calling Path.with_suffix(‘’) allows removing the suffix again. +Patch by July Tikhonov.

    • +
    • bpo-21714: Disallow the construction of invalid paths using +Path.with_name(). Original patch by Antony Lee.

    • +
    • bpo-15014: Added ‘auth’ method to smtplib to make implementing auth +mechanisms simpler, and used it internally in the login method.

    • +
    • bpo-21151: Fixed a segfault in the winreg module when None is passed +as a REG_BINARY value to SetValueEx. Patch by John Ehresman.

    • +
    • bpo-21090: io.FileIO.readall() does not ignore I/O errors anymore. Before, +it ignored I/O errors if at least the first C call read() succeed.

    • +
    • bpo-5800: headers parameter of wsgiref.headers.Headers is now optional. +Initial patch by Pablo Torres Navarrete and SilentGhost.

    • +
    • bpo-21781: ssl.RAND_add() now supports strings longer than 2 GB.

    • +
    • bpo-21679: Prevent extraneous fstat() calls during open(). Patch by +Bohuslav Kabrda.

    • +
    • bpo-21863: cProfile now displays the module name of C extension functions, +in addition to their own name.

    • +
    • bpo-11453: asyncore: emit a ResourceWarning when an unclosed file_wrapper +object is destroyed. The destructor now closes the file if needed. The +close() method can now be called twice: the second call does nothing.

    • +
    • bpo-21858: Better handling of Python exceptions in the sqlite3 module.

    • +
    • bpo-21476: Make sure the email.parser.BytesParser TextIOWrapper is +discarded after parsing, so the input file isn’t unexpectedly closed.

    • +
    • bpo-20295: imghdr now recognizes OpenEXR format images.

    • +
    • bpo-21729: Used the “with” statement in the dbm.dumb module to ensure +files closing. Patch by Claudiu Popa.

    • +
    • bpo-21491: socketserver: Fix a race condition in child processes reaping.

    • +
    • bpo-21719: Added the st_file_attributes field to os.stat_result on +Windows.

    • +
    • bpo-21832: Require named tuple inputs to be exact strings.

    • +
    • bpo-21722: The distutils “upload” command now exits with a non-zero return +code when uploading fails. Patch by Martin Dengler.

    • +
    • bpo-21723: asyncio.Queue: support any type of number (ex: float) for the +maximum size. Patch written by Vajrasky Kok.

    • +
    • bpo-21711: support for “site-python” directories has now been removed from +the site module (it was deprecated in 3.4).

    • +
    • bpo-17552: new socket.sendfile() method allowing a file to be sent over a +socket by using high-performance os.sendfile() on UNIX. Patch by Giampaolo +Rodola’.

    • +
    • bpo-18039: dbm.dump.open() now always creates a new database when the flag +has the value ‘n’. Patch by Claudiu Popa.

    • +
    • bpo-21326: Add a new is_closed() method to asyncio.BaseEventLoop. +run_forever() and run_until_complete() methods of asyncio.BaseEventLoop +now raise an exception if the event loop was closed.

    • +
    • bpo-21766: Prevent a security hole in CGIHTTPServer by URL unquoting paths +before checking for a CGI script at that path.

    • +
    • bpo-21310: Fixed possible resource leak in failed open().

    • +
    • bpo-21256: Printout of keyword args should be in deterministic order in a +mock function call. This will help to write better doctests.

    • +
    • bpo-21677: Fixed chaining nonnormalized exceptions in io close() methods.

    • +
    • bpo-11709: Fix the pydoc.help function to not fail when sys.stdin is not a +valid file.

    • +
    • bpo-21515: tempfile.TemporaryFile now uses os.O_TMPFILE flag is available.

    • +
    • bpo-13223: Fix pydoc.writedoc so that the HTML documentation for methods +that use ‘self’ in the example code is generated correctly.

    • +
    • bpo-21463: In urllib.request, fix pruning of the FTP cache.

    • +
    • bpo-21618: The subprocess module could fail to close open fds that were +inherited by the calling process and already higher than POSIX resource +limits would otherwise allow. On systems with a functioning /proc/self/fd +or /dev/fd interface the max is now ignored and all fds are closed.

    • +
    • bpo-20383: Introduce importlib.util.module_from_spec() as the preferred +way to create a new module.

    • +
    • bpo-21552: Fixed possible integer overflow of too long string lengths in +the tkinter module on 64-bit platforms.

    • +
    • bpo-14315: The zipfile module now ignores extra fields in the central +directory that are too short to be parsed instead of letting a +struct.unpack error bubble up as this “bad data” appears in many real +world zip files in the wild and is ignored by other zip tools.

    • +
    • bpo-13742: Added “key” and “reverse” parameters to heapq.merge(). (First +draft of patch contributed by Simon Sapin.)

    • +
    • bpo-21402: tkinter.ttk now works when default root window is not set.

    • +
    • bpo-3015: _tkinter.create() now creates tkapp object with wantobject=1 by +default.

    • +
    • bpo-10203: sqlite3.Row now truly supports sequence protocol. In +particular it supports reverse() and negative indices. Original patch by +Claudiu Popa.

    • +
    • bpo-18807: If copying (no symlinks) specified for a venv, then the python +interpreter aliases (python, python3) are now created by copying rather +than symlinking.

    • +
    • bpo-20197: Added support for the WebP image type in the imghdr module. +Patch by Fabrice Aneche and Claudiu Popa.

    • +
    • bpo-21513: Speedup some properties of IP addresses (IPv4Address, +IPv6Address) such as .is_private or .is_multicast.

    • +
    • bpo-21137: Improve the repr for threading.Lock() and its variants by +showing the “locked” or “unlocked” status. Patch by Berker Peksag.

    • +
    • bpo-21538: The plistlib module now supports loading of binary plist files +when reference or offset size is not a power of two.

    • +
    • bpo-21455: Add a default backlog to socket.listen().

    • +
    • bpo-21525: Most Tkinter methods which accepted tuples now accept lists +too.

    • +
    • bpo-22166: With the assistance of a new internal _codecs._forget_codec +helping function, test_codecs now clears the encoding caches to avoid the +appearance of a reference leak

    • +
    • bpo-22236: Tkinter tests now don’t reuse default root window. New root +window is created for every test class.

    • +
    • bpo-10744: Fix PEP 3118 format strings on ctypes objects with a nontrivial +shape.

    • +
    • bpo-20826: Optimize ipaddress.collapse_addresses().

    • +
    • bpo-21487: Optimize ipaddress.summarize_address_range() and +ipaddress.{IPv4Network,IPv6Network}.subnets().

    • +
    • bpo-21486: Optimize parsing of netmasks in ipaddress.IPv4Network and +ipaddress.IPv6Network.

    • +
    • bpo-13916: Disallowed the surrogatepass error handler for non UTF-* +encodings.

    • +
    • bpo-20998: Fixed re.fullmatch() of repeated single character pattern with +ignore case. Original patch by Matthew Barnett.

    • +
    • bpo-21075: fileinput.FileInput now reads bytes from standard stream if +binary mode is specified. Patch by Sam Kimbrel.

    • +
    • bpo-19775: Add a samefile() method to pathlib Path objects. Initial patch +by Vajrasky Kok.

    • +
    • bpo-21226: Set up modules properly in PyImport_ExecCodeModuleObject (and +friends).

    • +
    • bpo-21398: Fix a unicode error in the pydoc pager when the documentation +contains characters not encodable to the stdout encoding.

    • +
    • bpo-16531: ipaddress.IPv4Network and ipaddress.IPv6Network now accept an +(address, netmask) tuple argument, so as to easily construct network +objects from existing addresses.

    • +
    • bpo-21156: importlib.abc.InspectLoader.source_to_code() is now a +staticmethod.

    • +
    • bpo-21424: Simplified and optimized heaqp.nlargest() and nmsmallest() to +make fewer tuple comparisons.

    • +
    • bpo-21396: Fix TextIOWrapper(…, write_through=True) to not force a +flush() on the underlying binary stream. Patch by akira.

    • +
    • bpo-18314: Unlink now removes junctions on Windows. Patch by Kim Gräsman

    • +
    • bpo-21088: Bugfix for curses.window.addch() regression in 3.4.0. In +porting to Argument Clinic, the first two arguments were reversed.

    • +
    • bpo-21407: _decimal: The module now supports function signatures.

    • +
    • bpo-10650: Remove the non-standard ‘watchexp’ parameter from the +Decimal.quantize() method in the Python version. It had never been +present in the C version.

    • +
    • bpo-21469: Reduced the risk of false positives in robotparser by checking +to make sure that robots.txt has been read or does not exist prior to +returning True in can_fetch().

    • +
    • bpo-19414: Have the OrderedDict mark deleted links as unusable. This gives +an early failure if the link is deleted during iteration.

    • +
    • bpo-21421: Add __slots__ to the MappingViews ABC. Patch by Josh Rosenberg.

    • +
    • bpo-21101: Eliminate double hashing in the C speed-up code for +collections.Counter().

    • +
    • bpo-21321: itertools.islice() now releases the reference to the source +iterator when the slice is exhausted. Patch by Anton Afanasyev.

    • +
    • bpo-21057: TextIOWrapper now allows the underlying binary stream’s read() +or read1() method to return an arbitrary bytes-like object (such as a +memoryview). Patch by Nikolaus Rath.

    • +
    • bpo-20951: SSLSocket.send() now raises either SSLWantReadError or +SSLWantWriteError on a non-blocking socket if the operation would block. +Previously, it would return 0. Patch by Nikolaus Rath.

    • +
    • bpo-13248: removed previously deprecated asyncore.dispatcher __getattr__ +cheap inheritance hack.

    • +
    • bpo-9815: assertRaises now tries to clear references to local variables in +the exception’s traceback.

    • +
    • bpo-19940: ssl.cert_time_to_seconds() now interprets the given time string +in the UTC timezone (as specified in RFC 5280), not the local timezone.

    • +
    • bpo-13204: Calling sys.flags.__new__ would crash the interpreter, now it +raises a TypeError.

    • +
    • bpo-19385: Make operations on a closed dbm.dumb database always raise the +same exception.

    • +
    • bpo-21207: Detect when the os.urandom cached fd has been closed or +replaced, and open it anew.

    • +
    • bpo-21291: subprocess’s Popen.wait() is now thread safe so that multiple +threads may be calling wait() or poll() on a Popen instance at the same +time without losing the Popen.returncode value.

    • +
    • bpo-21127: Path objects can now be instantiated from str subclass +instances (such as numpy.str_).

    • +
    • bpo-15002: urllib.response object to use _TemporaryFileWrapper (and +_TemporaryFileCloser) facility. Provides a better way to handle file +descriptor close. Patch contributed by Christian Theune.

    • +
    • bpo-12220: mindom now raises a custom ValueError indicating it doesn’t +support spaces in URIs instead of letting a ‘split’ ValueError bubble up.

    • +
    • bpo-21068: The ssl.PROTOCOL* constants are now enum members.

    • +
    • bpo-21276: posixmodule: Don’t define USE_XATTRS on KFreeBSD and the Hurd.

    • +
    • bpo-21262: New method assert_not_called for Mock. It raises AssertionError +if the mock has been called.

    • +
    • bpo-21238: New keyword argument unsafe to Mock. It raises +AttributeError incase of an attribute startswith assert or assret.

    • +
    • bpo-20896: ssl.get_server_certificate() now uses PROTOCOL_SSLv23, not +PROTOCOL_SSLv3, for maximum compatibility.

    • +
    • bpo-21239: patch.stopall() didn’t work deterministically when the same +name was patched more than once.

    • +
    • bpo-21203: Updated fileConfig and dictConfig to remove inconsistencies. +Thanks to Jure Koren for the patch.

    • +
    • bpo-21222: Passing name keyword argument to mock.create_autospec now +works.

    • +
    • bpo-21197: Add lib64 -> lib symlink in venvs on 64-bit non-OS X POSIX.

    • +
    • bpo-17498: Some SMTP servers disconnect after certain errors, violating +strict RFC conformance. Instead of losing the error code when we issue +the subsequent RSET, smtplib now returns the error code and defers raising +the SMTPServerDisconnected error until the next command is issued.

    • +
    • bpo-17826: setting an iterable side_effect on a mock function created by +create_autospec now works. Patch by Kushal Das.

    • +
    • bpo-7776: Fix Host: header and reconnection when using +http.client.HTTPConnection.set_tunnel(). Patch by Nikolaus Rath.

    • +
    • bpo-20968: unittest.mock.MagicMock now supports division. Patch by +Johannes Baiter.

    • +
    • bpo-21529: Fix arbitrary memory access in JSONDecoder.raw_decode with a +negative second parameter. Bug reported by Guido Vranken. (See also: +CVE-2014-4616)

    • +
    • bpo-21169: getpass now handles non-ascii characters that the input stream +encoding cannot encode by re-encoding using the replace error handler.

    • +
    • bpo-21171: Fixed undocumented filter API of the rot13 codec. Patch by +Berker Peksag.

    • +
    • bpo-20539: Improved math.factorial error message for large positive inputs +and changed exception type (OverflowError -> ValueError) for large +negative inputs.

    • +
    • bpo-21172: isinstance check relaxed from dict to collections.Mapping.

    • +
    • bpo-21155: asyncio.EventLoop.create_unix_server() now raises a ValueError +if path and sock are specified at the same time.

    • +
    • bpo-21136: Avoid unnecessary normalization of Fractions resulting from +power and other operations. Patch by Raymond Hettinger.

    • +
    • bpo-17621: Introduce importlib.util.LazyLoader.

    • +
    • bpo-21076: signal module constants were turned into enums. Patch by +Giampaolo Rodola’.

    • +
    • bpo-20636: Improved the repr of Tkinter widgets.

    • +
    • bpo-19505: The items, keys, and values views of OrderedDict now support +reverse iteration using reversed().

    • +
    • bpo-21149: Improved thread-safety in logging cleanup during interpreter +shutdown. Thanks to Devin Jeanpierre for the patch.

    • +
    • bpo-21058: Fix a leak of file descriptor in +tempfile.NamedTemporaryFile(), close the file descriptor if +io.open() fails

    • +
    • bpo-21200: Return None from pkgutil.get_loader() when __spec__ is missing.

    • +
    • bpo-21013: Enhance ssl.create_default_context() when used for server side +sockets to provide better security by default.

    • +
    • bpo-20145: assertRaisesRegex and assertWarnsRegex now raise a +TypeError if the second argument is not a string or compiled regex.

    • +
    • bpo-20633: Replace relative import by absolute import.

    • +
    • bpo-20980: Stop wrapping exception when using ThreadPool.

    • +
    • bpo-21082: In os.makedirs, do not set the process-wide umask. Note this +changes behavior of makedirs when exist_ok=True.

    • +
    • bpo-20990: Fix issues found by pyflakes for multiprocessing.

    • +
    • bpo-21015: SSL contexts will now automatically select an elliptic curve +for ECDH key exchange on OpenSSL 1.0.2 and later, and otherwise default to +“prime256v1”.

    • +
    • bpo-21000: Improve the command-line interface of json.tool.

    • +
    • bpo-20995: Enhance default ciphers used by the ssl module to enable better +security and prioritize perfect forward secrecy.

    • +
    • bpo-20884: Don’t assume that __file__ is defined on importlib.__init__.

    • +
    • bpo-21499: Ignore __builtins__ in several test_importlib.test_api tests.

    • +
    • bpo-20627: xmlrpc.client.ServerProxy is now a context manager.

    • +
    • bpo-19165: The formatter module now raises DeprecationWarning instead of +PendingDeprecationWarning.

    • +
    • bpo-13936: Remove the ability of datetime.time instances to be considered +false in boolean contexts.

    • +
    • bpo-18931: selectors module now supports /dev/poll on Solaris. Patch by +Giampaolo Rodola’.

    • +
    • bpo-19977: When the LC_TYPE locale is the POSIX locale (C locale), +sys.stdin and sys.stdout are now using the +surrogateescape error handler, instead of the strict error +handler.

    • +
    • bpo-20574: Implement incremental decoder for cp65001 code (Windows code +page 65001, Microsoft UTF-8).

    • +
    • bpo-20879: Delay the initialization of encoding and decoding tables for +base32, ascii85 and base85 codecs in the base64 module, and delay the +initialization of the unquote_to_bytes() table of the urllib.parse module, +to not waste memory if these modules are not used.

    • +
    • bpo-19157: Include the broadcast address in the usuable hosts for IPv6 in +ipaddress.

    • +
    • bpo-11599: When an external command (e.g. compiler) fails, distutils now +prints out the whole command line (instead of just the command name) if +the environment variable DISTUTILS_DEBUG is set.

    • +
    • bpo-4931: distutils should not produce unhelpful “error: None” messages +anymore. distutils.util.grok_environment_error is kept but doc-deprecated.

    • +
    • bpo-20875: Prevent possible gzip “‘read’ is not defined” NameError. Patch +by Claudiu Popa.

    • +
    • bpo-11558: email.message.Message.attach now returns a more useful +error message if attach is called on a message for which +is_multipart is False.

    • +
    • bpo-20283: RE pattern methods now accept the string keyword parameters as +documented. The pattern and source keyword parameters are left as +deprecated aliases.

    • +
    • bpo-20778: Fix modulefinder to work with bytecode-only modules.

    • +
    • bpo-20791: copy.copy() now doesn’t make a copy when the input is a bytes +object. Initial patch by Peter Otten.

    • +
    • bpo-19748: On AIX, time.mktime() now raises an OverflowError for year +outsize range [1902; 2037].

    • +
    • bpo-19573: inspect.signature: Use enum for parameter kind constants.

    • +
    • bpo-20726: inspect.signature: Make Signature and Parameter picklable.

    • +
    • bpo-17373: Add inspect.Signature.from_callable method.

    • +
    • bpo-20378: Improve repr of inspect.Signature and inspect.Parameter.

    • +
    • bpo-20816: Fix inspect.getcallargs() to raise correct TypeError for +missing keyword-only arguments. Patch by Jeremiah Lowin.

    • +
    • bpo-20817: Fix inspect.getcallargs() to fail correctly if more than 3 +arguments are missing. Patch by Jeremiah Lowin.

    • +
    • bpo-6676: Ensure a meaningful exception is raised when attempting to parse +more than one XML document per pyexpat xmlparser instance. (Original +patches by Hirokazu Yamamoto and Amaury Forgeot d’Arc, with suggested +wording by David Gutteridge)

    • +
    • bpo-21117: Fix inspect.signature to better support functools.partial. Due +to the specifics of functools.partial implementation, +positional-or-keyword arguments passed as keyword arguments become +keyword-only.

    • +
    • bpo-20334: inspect.Signature and inspect.Parameter are now hashable. +Thanks to Antony Lee for bug reports and suggestions.

    • +
    • bpo-15916: doctest.DocTestSuite returns an empty unittest.TestSuite +instead of raising ValueError if it finds no tests

    • +
    • bpo-21209: Fix asyncio.tasks.CoroWrapper to workaround a bug in yield-from +implementation in CPythons prior to 3.4.1.

    • +
    • asyncio: Add gi_{frame,running,code} properties to CoroWrapper (upstream +bpo-163).

    • +
    • bpo-21311: Avoid exception in _osx_support with non-standard compiler +configurations. Patch by John Szakmeister.

    • +
    • bpo-11571: Ensure that the turtle window becomes the topmost window when +launched on OS X.

    • +
    • bpo-21801: Validate that __signature__ is None or an instance of +Signature.

    • +
    • bpo-21923: Prevent AttributeError in +distutils.sysconfig.customize_compiler due to possible uninitialized +_config_vars.

    • +
    • bpo-21323: Fix http.server to again handle scripts in CGI subdirectories, +broken by the fix for security bpo-19435. Patch by Zach Byrne.

    • +
    • bpo-22733: Fix ffi_prep_args not zero-extending argument values correctly +on 64-bit Windows.

    • +
    • bpo-23302: Default to TCP_NODELAY=1 upon establishing an HTTPConnection. +Removed use of hard-coded MSS as it’s an optimization that’s no longer +needed with Nagle disabled.

    • +
    +
    +
    +

    IDLE

    +
      +
    • bpo-20577: Configuration of the max line length for the FormatParagraph +extension has been moved from the General tab of the Idle preferences +dialog to the FormatParagraph tab of the Config Extensions dialog. Patch +by Tal Einat.

    • +
    • bpo-16893: Update Idle doc chapter to match current Idle and add new +information.

    • +
    • bpo-3068: Add Idle extension configuration dialog to Options menu. Changes +are written to HOME/.idlerc/config-extensions.cfg. Original patch by Tal +Einat.

    • +
    • bpo-16233: A module browser (File : Class Browser, Alt+C) requires an +editor window with a filename. When Class Browser is requested otherwise, +from a shell, output window, or ‘Untitled’ editor, Idle no longer displays +an error box. It now pops up an Open Module box (Alt+M). If a valid name +is entered and a module is opened, a corresponding browser is also opened.

    • +
    • bpo-4832: Save As to type Python files automatically adds .py to the name +you enter (even if your system does not display it). Some systems +automatically add .txt when type is Text files.

    • +
    • bpo-21986: Code objects are not normally pickled by the pickle module. To +match this, they are no longer pickled when running under Idle.

    • +
    • bpo-17390: Adjust Editor window title; remove ‘Python’, move version to +end.

    • +
    • bpo-14105: Idle debugger breakpoints no longer disappear when inserting or +deleting lines.

    • +
    • bpo-17172: Turtledemo can now be run from Idle. Currently, the entry is on +the Help menu, but it may move to Run. Patch by Ramchandra Apt and Lita +Cho.

    • +
    • bpo-21765: Add support for non-ascii identifiers to HyperParser.

    • +
    • bpo-21940: Add unittest for WidgetRedirector. Initial patch by Saimadhav +Heblikar.

    • +
    • bpo-18592: Add unittest for SearchDialogBase. Patch by Phil Webster.

    • +
    • bpo-21694: Add unittest for ParenMatch. Patch by Saimadhav Heblikar.

    • +
    • bpo-21686: add unittest for HyperParser. Original patch by Saimadhav +Heblikar.

    • +
    • bpo-12387: Add missing upper(lower)case versions of default Windows key +bindings for Idle so Caps Lock does not disable them. Patch by Roger +Serwy.

    • +
    • bpo-21695: Closing a Find-in-files output window while the search is still +in progress no longer closes Idle.

    • +
    • bpo-18910: Add unittest for textView. Patch by Phil Webster.

    • +
    • bpo-18292: Add unittest for AutoExpand. Patch by Saihadhav Heblikar.

    • +
    • bpo-18409: Add unittest for AutoComplete. Patch by Phil Webster.

    • +
    • bpo-21477: htest.py - Improve framework, complete set of tests. Patches by +Saimadhav Heblikar

    • +
    • bpo-18104: Add idlelib/idle_test/htest.py with a few sample tests to begin +consolidating and improving human-validated tests of Idle. Change other +files as needed to work with htest. Running the module as __main__ runs +all tests.

    • +
    • bpo-21139: Change default paragraph width to 72, the PEP 8 recommendation.

    • +
    • bpo-21284: Paragraph reformat test passes after user changes reformat +width.

    • +
    • bpo-17654: Ensure IDLE menus are customized properly on OS X for +non-framework builds and for all variants of Tk.

    • +
    • bpo-23180: Rename IDLE “Windows” menu item to “Window”. Patch by Al +Sweigart.

    • +
    +
    +
    +

    Build

    +
      +
    • bpo-15506: Use standard PKG_PROG_PKG_CONFIG autoconf macro in the +configure script.

    • +
    • bpo-22935: Allow the ssl module to be compiled if openssl doesn’t support +SSL 3.

    • +
    • bpo-22592: Drop support of the Borland C compiler to build Python. The +distutils module still supports it to build extensions.

    • +
    • bpo-22591: Drop support of MS-DOS, especially of the DJGPP compiler +(MS-DOS port of GCC).

    • +
    • bpo-16537: Check whether self.extensions is empty in setup.py. Patch by +Jonathan Hosmer.

    • +
    • bpo-22359: Remove incorrect uses of recursive make. Patch by Jonas +Wagner.

    • +
    • bpo-21958: Define HAVE_ROUND when building with Visual Studio 2013 and +above. Patch by Zachary Turner.

    • +
    • bpo-18093: the programs that embed the CPython runtime are now in a +separate “Programs” directory, rather than being kept in the Modules +directory.

    • +
    • bpo-15759: “make suspicious”, “make linkcheck” and “make doctest” in Doc/ +now display special message when and only when there are failures.

    • +
    • bpo-21141: The Windows build process no longer attempts to find Perl, +instead relying on OpenSSL source being configured and ready to build. +The PCbuild\build_ssl.py script has been re-written and re-named to +PCbuild\prepare_ssl.py, and takes care of configuring OpenSSL source +for both 32 and 64 bit platforms. OpenSSL sources obtained from +svn.python.org will always be pre-configured and ready to build.

    • +
    • bpo-21037: Add a build option to enable AddressSanitizer support.

    • +
    • bpo-19962: The Windows build process now creates “python.bat” in the root +of the source tree, which passes all arguments through to the most +recently built interpreter.

    • +
    • bpo-21285: Refactor and fix curses configure check to always search in a +ncursesw directory.

    • +
    • bpo-15234: For BerkelyDB and Sqlite, only add the found library and +include directories if they aren’t already being searched. This avoids an +explicit runtime library dependency.

    • +
    • bpo-17861: Tools/scripts/generate_opcode_h.py automatically regenerates +Include/opcode.h from Lib/opcode.py if the latter gets any change.

    • +
    • bpo-20644: OS X installer build support for documentation build changes in +3.4.1: assume externally supplied sphinx-build is available in /usr/bin.

    • +
    • bpo-20022: Eliminate use of deprecated bundlebuilder in OS X builds.

    • +
    • bpo-15968: Incorporated Tcl, Tk, and Tix builds into the Windows build +solution.

    • +
    • bpo-17095: Fix Modules/Setup shared support.

    • +
    • bpo-21811: Anticipated fixes to support OS X versions > 10.9.

    • +
    • bpo-21166: Prevent possible segfaults and other random failures of python +–generate-posix-vars in pybuilddir.txt build target.

    • +
    • bpo-18096: Fix library order returned by python-config.

    • +
    • bpo-17219: Add library build dir for Python extension cross-builds.

    • +
    • bpo-22919: Windows build updated to support VC 14.0 (Visual Studio 2015), +which will be used for the official release.

    • +
    • bpo-21236: Build _msi.pyd with cabinet.lib instead of fci.lib

    • +
    • bpo-17128: Use private version of OpenSSL for OS X 10.5+ installer.

    • +
    +
    +
    +

    C API

    +
      +
    • bpo-14203: Remove obsolete support for view==NULL in PyBuffer_FillInfo(), +bytearray_getbuffer(), bytesiobuf_getbuffer() and array_buffer_getbuf(). +All functions now raise BufferError in that case.

    • +
    • bpo-22445: PyBuffer_IsContiguous() now implements precise contiguity +tests, compatible with NumPy’s NPY_RELAXED_STRIDES_CHECKING compilation +flag. Previously the function reported false negatives for corner cases.

    • +
    • bpo-22079: PyType_Ready() now checks that statically allocated type has no +dynamically allocated bases.

    • +
    • bpo-22453: Removed non-documented macro PyObject_REPR().

    • +
    • bpo-18395: Rename _Py_char2wchar() to Py_DecodeLocale(), +rename _Py_wchar2char() to Py_EncodeLocale(), and document +these functions.

    • +
    • bpo-21233: Add new C functions: PyMem_RawCalloc(), PyMem_Calloc(), +PyObject_Calloc(), _PyObject_GC_Calloc(). bytes(int) is now using +calloc() instead of malloc() for large objects which is faster and +use less memory.

    • +
    • bpo-20942: PyImport_ImportFrozenModuleObject() no longer sets __file__ to +match what importlib does; this affects _frozen_importlib as well as any +module loaded using imp.init_frozen().

    • +
    +
    +
    +

    Documentation

    +
      +
    • bpo-19548: Update the codecs module documentation to better cover the +distinction between text encodings and other codecs, together with other +clarifications. Patch by Martin Panter.

    • +
    • bpo-22394: Doc/Makefile now supports make venv PYTHON=../python to +create a venv for generating the documentation, e.g., make html +PYTHON=venv/bin/python3.

    • +
    • bpo-21514: The documentation of the json module now refers to new JSON RFC +7159 instead of obsoleted RFC 4627.

    • +
    • bpo-21777: The binary sequence methods on bytes and bytearray are now +documented explicitly, rather than assuming users will be able to derive +the expected behaviour from the behaviour of the corresponding str +methods.

    • +
    • bpo-6916: undocument deprecated asynchat.fifo class.

    • +
    • bpo-17386: Expanded functionality of the Doc/make.bat script to make +it much more comparable to Doc/Makefile.

    • +
    • bpo-21312: Update the thread_foobar.h template file to include newer +threading APIs. Patch by Jack McCracken.

    • +
    • bpo-21043: Remove the recommendation for specific CA organizations and to +mention the ability to load the OS certificates.

    • +
    • bpo-20765: Add missing documentation for PurePath.with_name() and +PurePath.with_suffix().

    • +
    • bpo-19407: New package installation and distribution guides based on the +Python Packaging Authority tools. Existing guides have been retained as +legacy links from the distutils docs, as they still contain some required +reference material for tool developers that isn’t recorded anywhere else.

    • +
    • bpo-19697: Document cases where __main__.__spec__ is None.

    • +
    +
    +
    +

    Tests

    +
      +
    • bpo-18982: Add tests for CLI of the calendar module.

    • +
    • bpo-19548: Added some additional checks to test_codecs to ensure that +statements in the updated documentation remain accurate. Patch by Martin +Panter.

    • +
    • bpo-22838: All test_re tests now work with unittest test discovery.

    • +
    • bpo-22173: Update lib2to3 tests to use unittest test discovery.

    • +
    • bpo-16000: Convert test_curses to use unittest.

    • +
    • bpo-21456: Skip two tests in test_urllib2net.py if _ssl module not +present. Patch by Remi Pointel.

    • +
    • bpo-20746: Fix test_pdb to run in refleak mode (-R). Patch by Xavier de +Gaye.

    • +
    • bpo-22060: test_ctypes has been somewhat cleaned up and simplified; it now +uses unittest test discovery to find its tests.

    • +
    • bpo-22104: regrtest.py no longer holds a reference to the suite of tests +loaded from test modules that don’t define test_main().

    • +
    • bpo-22111: Assorted cleanups in test_imaplib. Patch by Milan Oberkirch.

    • +
    • bpo-22002: Added load_package_tests function to test.support and used +it to implement/augment test discovery in test_asyncio, test_email, +test_importlib, test_json, and test_tools.

    • +
    • bpo-21976: Fix test_ssl to accept LibreSSL version strings. Thanks to +William Orr.

    • +
    • bpo-21918: Converted test_tools from a module to a package containing +separate test files for each tested script.

    • +
    • bpo-9554: Use modern unittest features in test_argparse. Initial patch by +Denver Coneybeare and Radu Voicilas.

    • +
    • bpo-20155: Changed HTTP method names in failing tests in test_httpservers +so that packet filtering software (specifically Windows Base Filtering +Engine) does not interfere with the transaction semantics expected by the +tests.

    • +
    • bpo-19493: Refactored the ctypes test package to skip tests explicitly +rather than silently.

    • +
    • bpo-18492: All resources are now allowed when tests are not run by +regrtest.py.

    • +
    • bpo-21634: Fix pystone micro-benchmark: use floor division instead of true +division to benchmark integers instead of floating point numbers. Set +pystone version to 1.2. Patch written by Lennart Regebro.

    • +
    • bpo-21605: Added tests for Tkinter images.

    • +
    • bpo-21493: Added test for ntpath.expanduser(). Original patch by Claudiu +Popa.

    • +
    • bpo-19925: Added tests for the spwd module. Original patch by Vajrasky +Kok.

    • +
    • bpo-21522: Added Tkinter tests for Listbox.itemconfigure(), +PanedWindow.paneconfigure(), and Menu.entryconfigure().

    • +
    • bpo-17756: Fix test_code test when run from the installed location.

    • +
    • bpo-17752: Fix distutils tests when run from the installed location.

    • +
    • bpo-18604: Consolidated checks for GUI availability. All platforms now at +least check whether Tk can be instantiated when the GUI resource is +requested.

    • +
    • bpo-21275: Fix a socket test on KFreeBSD.

    • +
    • bpo-21223: Pass test_site/test_startup_imports when some of the extensions +are built as builtins.

    • +
    • bpo-20635: Added tests for Tk geometry managers.

    • +
    • Add test case for freeze.

    • +
    • bpo-20743: Fix a reference leak in test_tcl.

    • +
    • bpo-21097: Move test_namespace_pkgs into test_importlib.

    • +
    • bpo-21503: Use test_both() consistently in test_importlib.

    • +
    • bpo-20939: Avoid various network test failures due to new redirect of +http://www.python.org/ to https://www.python.org: use +http://www.example.com instead.

    • +
    • bpo-20668: asyncio tests no longer rely on tests.txt file. (Patch by +Vajrasky Kok)

    • +
    • bpo-21093: Prevent failures of ctypes test_macholib on OS X if a copy of +libz exists in $HOME/lib or /usr/local/lib.

    • +
    • bpo-22770: Prevent some Tk segfaults on OS X when running gui tests.

    • +
    • bpo-23211: Workaround test_logging failure on some OS X 10.6 systems.

    • +
    • bpo-23345: Prevent test_ssl failures with large OpenSSL patch level values +(like 0.9.8zc).

    • +
    +
    +
    +

    Tools/Demos

    +
      +
    • bpo-22314: pydoc now works when the LINES environment variable is set.

    • +
    • bpo-22615: Argument Clinic now supports the “type” argument for the int +converter. This permits using the int converter with enums and typedefs.

    • +
    • bpo-20076: The makelocalealias.py script no longer ignores UTF-8 mapping.

    • +
    • bpo-20079: The makelocalealias.py script now can parse the SUPPORTED file +from glibc sources and supports command line options for source paths.

    • +
    • bpo-22201: Command-line interface of the zipfile module now correctly +extracts ZIP files with directory entries. Patch by Ryan Wilson.

    • +
    • bpo-22120: For functions using an unsigned integer return converter, +Argument Clinic now generates a cast to that type for the comparison to -1 +in the generated code. (This suppresses a compilation warning.)

    • +
    • bpo-18974: Tools/scripts/diff.py now uses argparse instead of optparse.

    • +
    • bpo-21906: Make Tools/scripts/md5sum.py work in Python 3. Patch by Zachary +Ware.

    • +
    • bpo-21629: Fix Argument Clinic’s “–converters” feature.

    • +
    • Add support for yield from to 2to3.

    • +
    • Add support for the PEP 465 matrix multiplication operator to 2to3.

    • +
    • bpo-16047: Fix module exception list and __file__ handling in freeze. +Patch by Meador Inge.

    • +
    • bpo-11824: Consider ABI tags in freeze. Patch by Meador Inge.

    • +
    • bpo-20535: PYTHONWARNING no longer affects the run_tests.py script. Patch +by Arfrever Frehtes Taifersar Arahesis.

    • +
    +
    +
    +

    Windows

    +
      +
    • bpo-23260: Update Windows installer

    • +
    • The bundled version of Tcl/Tk has been updated to 8.6.3. The most visible +result of this change is the addition of new native file dialogs when +running on Windows Vista or newer. See Tcl/Tk’s TIP 432 for more +information. Also, this version of Tcl/Tk includes support for Windows +10.

    • +
    • bpo-17896: The Windows build scripts now expect external library sources +to be in PCbuild\..\externals rather than PCbuild\..\...

    • +
    • bpo-17717: The Windows build scripts now use a copy of NASM pulled from +svn.python.org to build OpenSSL.

    • +
    • bpo-21907: Improved the batch scripts provided for building Python.

    • +
    • bpo-22644: The bundled version of OpenSSL has been updated to 1.0.1j.

    • +
    • bpo-10747: Use versioned labels in the Windows start menu. Patch by Olive +Kilburn.

    • +
    • bpo-22980: .pyd files with a version and platform tag (for example, +“.cp35-win32.pyd”) will now be loaded in preference to those without tags.

    • +
    +

    (For information about older versions, consult the HISTORY file.)

    +
    +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/python-3.7.4-docs-html/whatsnew/index.html b/python-3.7.4-docs-html/whatsnew/index.html new file mode 100644 index 0000000..7bdfee2 --- /dev/null +++ b/python-3.7.4-docs-html/whatsnew/index.html @@ -0,0 +1,564 @@ + + + + + + + What’s New in Python — Python 3.7.4 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    What’s New in Python

    +

    The “What’s New in Python” series of essays takes tours through the most +important changes between major Python versions. They are a “must read” for +anyone wishing to stay up-to-date after a new release.

    +
    + +
    +

    The “Changelog” is an HTML version of the file built from the contents of the +Misc/NEWS.d directory tree, which contains all nontrivial changes +to Python for the current version.

    +
    + +
    +
    + + +
    +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/stories.txt b/stories.txt new file mode 100644 index 0000000..0947df7 --- /dev/null +++ b/stories.txt @@ -0,0 +1,2 @@ + +Once upon a time, there were three pigs. One day, their mother said, "You are all grown up and must on your own." So they left to their houses. The first little pig wanted only to all day and quickly built his house out of . The second little pig wanted to and all day so he his house with . The third pig knew the wolf lived nearby and worked hard to his house out of . One day, the wolf knocked on the first pig's . "Let me in or I'll your house down!" The pig didn't, so the wolf down the . The wolf knocked on the second pig's . "Let me in or I'll blow your down!" The pig didn't, so the wolf down the house. Then the wolf knocked on the third pig's door. "Let me in or I'll blow your house down!" The little pig didn't, so the wolf and .He could not blow the house down. All the pigs went to live in the house and they all happily ever after. diff --git a/storyCount.txt b/storyCount.txt new file mode 100644 index 0000000..56a6051 --- /dev/null +++ b/storyCount.txt @@ -0,0 +1 @@ +1 \ No newline at end of file diff --git a/test.py b/test.py new file mode 100644 index 0000000..2c5afe8 --- /dev/null +++ b/test.py @@ -0,0 +1,28 @@ +# imports libraries we will use +import time +import random +# sets values we will use later +number = 0 +phrase = "The quick, brown, fox jumped over the lazy dog" + +# calculates amount of letters in phrase (including spaces) +amount = len(phrase) +print("The current phrase has", amount, "letters") +# prints phrase +print("the phrase is", phrase) +print('begin loop') +time.sleep(1) + +# prints phrase letters +for number in range(amount): + print(number, phrase[number]) + time.sleep(0.1) + +# prints phrase letters in random order +print('\n') +print("Now, in random order!") +time.sleep(1) +for number in range(amount): + exec('iteration = random.randint(0,amount - 1)') + print(number, phrase[iteration], '\n' "iteration", iteration) + time.sleep(0.1)